This server exists for others in the HTTP/2 community to test their HTTP/2 client implementations and point out flaws in our server.
-
-
The code is currently at github.com/bradfitz/http2
-but will move to the Go standard library at some point in the future
-(enabled by default, without users needing to change their code).
\n")
- cacheBust := time.Now().UnixNano()
- for y := 0; y < yt; y++ {
- for x := 0; x < xt; x++ {
- fmt.Fprintf(w, "",
- tileSize, tileSize, x, y, cacheBust, ms)
- }
- io.WriteString(w, " \n")
- }
- io.WriteString(w, "
<< Back to Go HTTP/2 demo server")
- })
-}
-
-func httpsHost() string {
- if *prod {
- return "http2.golang.org"
- }
- if v := *addr; strings.HasPrefix(v, ":") {
- return "localhost" + v
- } else {
- return v
- }
-}
-
-func httpHost() string {
- if *prod {
- return "http2.golang.org"
- }
- if v := *httpAddr; strings.HasPrefix(v, ":") {
- return "localhost" + v
- } else {
- return v
- }
-}
-
-func serveProdTLS() error {
- c, err := googlestorage.NewServiceClient()
- if err != nil {
- return err
- }
- slurp := func(key string) ([]byte, error) {
- const bucket = "http2-demo-server-tls"
- rc, _, err := c.GetObject(&googlestorage.Object{
- Bucket: bucket,
- Key: key,
- })
- if err != nil {
- return nil, fmt.Errorf("Error fetching GCS object %q in bucket %q: %v", key, bucket, err)
- }
- defer rc.Close()
- return ioutil.ReadAll(rc)
- }
- certPem, err := slurp("http2.golang.org.chained.pem")
- if err != nil {
- return err
- }
- keyPem, err := slurp("http2.golang.org.key")
- if err != nil {
- return err
- }
- cert, err := tls.X509KeyPair(certPem, keyPem)
- if err != nil {
- return err
- }
- srv := &http.Server{
- TLSConfig: &tls.Config{
- Certificates: []tls.Certificate{cert},
- },
- }
- http2.ConfigureServer(srv, &http2.Server{})
- ln, err := net.Listen("tcp", ":443")
- if err != nil {
- return err
- }
- return srv.Serve(tls.NewListener(tcpKeepAliveListener{ln.(*net.TCPListener)}, srv.TLSConfig))
-}
-
-type tcpKeepAliveListener struct {
- *net.TCPListener
-}
-
-func (ln tcpKeepAliveListener) Accept() (c net.Conn, err error) {
- tc, err := ln.AcceptTCP()
- if err != nil {
- return
- }
- tc.SetKeepAlive(true)
- tc.SetKeepAlivePeriod(3 * time.Minute)
- return tc, nil
-}
-
-func serveProd() error {
- errc := make(chan error, 2)
- go func() { errc <- http.ListenAndServe(":80", nil) }()
- go func() { errc <- serveProdTLS() }()
- return <-errc
-}
-
-func main() {
- var srv http.Server
- flag.BoolVar(&http2.VerboseLogs, "verbose", false, "Verbose HTTP/2 debugging.")
- flag.Parse()
- srv.Addr = *addr
-
- registerHandlers()
-
- if *prod {
- *httpAddr = "http2.golang.org"
- log.Fatal(serveProd())
- }
-
- url := "https://" + *addr + "/"
- log.Printf("Listening on " + url)
- http2.ConfigureServer(&srv, &http2.Server{})
-
- if *httpAddr != "" {
- go func() { log.Fatal(http.ListenAndServe(*httpAddr, nil)) }()
- }
-
- go func() {
- log.Fatal(srv.ListenAndServeTLS("server.crt", "server.key"))
- }()
- if *openFirefox && runtime.GOOS == "darwin" {
- time.Sleep(250 * time.Millisecond)
- exec.Command("open", "-b", "org.mozilla.nightly", "https://localhost:4430/").Run()
- }
- select {}
-}
diff --git a/vendor/github.com/bradfitz/http2/h2demo/launch.go b/vendor/github.com/bradfitz/http2/h2demo/launch.go
deleted file mode 100644
index 74666154..00000000
--- a/vendor/github.com/bradfitz/http2/h2demo/launch.go
+++ /dev/null
@@ -1,302 +0,0 @@
-// Copyright 2014 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-// +build ignore
-
-package main
-
-import (
- "bufio"
- "bytes"
- "encoding/json"
- "flag"
- "fmt"
- "io"
- "io/ioutil"
- "log"
- "net/http"
- "os"
- "strings"
- "time"
-
- "golang.org/x/oauth2"
- "golang.org/x/oauth2/google"
- compute "google.golang.org/api/compute/v1"
-)
-
-var (
- proj = flag.String("project", "symbolic-datum-552", "name of Project")
- zone = flag.String("zone", "us-central1-a", "GCE zone")
- mach = flag.String("machinetype", "n1-standard-1", "Machine type")
- instName = flag.String("instance_name", "http2-demo", "Name of VM instance.")
- sshPub = flag.String("ssh_public_key", "", "ssh public key file to authorize. Can modify later in Google's web UI anyway.")
- staticIP = flag.String("static_ip", "130.211.116.44", "Static IP to use. If empty, automatic.")
-
- writeObject = flag.String("write_object", "", "If non-empty, a VM isn't created and the flag value is Google Cloud Storage bucket/object to write. The contents from stdin.")
- publicObject = flag.Bool("write_object_is_public", false, "Whether the object created by --write_object should be public.")
-)
-
-func readFile(v string) string {
- slurp, err := ioutil.ReadFile(v)
- if err != nil {
- log.Fatalf("Error reading %s: %v", v, err)
- }
- return strings.TrimSpace(string(slurp))
-}
-
-var config = &oauth2.Config{
- // The client-id and secret should be for an "Installed Application" when using
- // the CLI. Later we'll use a web application with a callback.
- ClientID: readFile("client-id.dat"),
- ClientSecret: readFile("client-secret.dat"),
- Endpoint: google.Endpoint,
- Scopes: []string{
- compute.DevstorageFull_controlScope,
- compute.ComputeScope,
- "https://www.googleapis.com/auth/sqlservice",
- "https://www.googleapis.com/auth/sqlservice.admin",
- },
- RedirectURL: "urn:ietf:wg:oauth:2.0:oob",
-}
-
-const baseConfig = `#cloud-config
-coreos:
- units:
- - name: h2demo.service
- command: start
- content: |
- [Unit]
- Description=HTTP2 Demo
-
- [Service]
- ExecStartPre=/bin/bash -c 'mkdir -p /opt/bin && curl -s -o /opt/bin/h2demo http://storage.googleapis.com/http2-demo-server-tls/h2demo && chmod +x /opt/bin/h2demo'
- ExecStart=/opt/bin/h2demo --prod
- RestartSec=5s
- Restart=always
- Type=simple
-
- [Install]
- WantedBy=multi-user.target
-`
-
-func main() {
- flag.Parse()
- if *proj == "" {
- log.Fatalf("Missing --project flag")
- }
- prefix := "https://www.googleapis.com/compute/v1/projects/" + *proj
- machType := prefix + "/zones/" + *zone + "/machineTypes/" + *mach
-
- const tokenFileName = "token.dat"
- tokenFile := tokenCacheFile(tokenFileName)
- tokenSource := oauth2.ReuseTokenSource(nil, tokenFile)
- token, err := tokenSource.Token()
- if err != nil {
- if *writeObject != "" {
- log.Fatalf("Can't use --write_object without a valid token.dat file already cached.")
- }
- log.Printf("Error getting token from %s: %v", tokenFileName, err)
- log.Printf("Get auth code from %v", config.AuthCodeURL("my-state"))
- fmt.Print("\nEnter auth code: ")
- sc := bufio.NewScanner(os.Stdin)
- sc.Scan()
- authCode := strings.TrimSpace(sc.Text())
- token, err = config.Exchange(oauth2.NoContext, authCode)
- if err != nil {
- log.Fatalf("Error exchanging auth code for a token: %v", err)
- }
- if err := tokenFile.WriteToken(token); err != nil {
- log.Fatalf("Error writing to %s: %v", tokenFileName, err)
- }
- tokenSource = oauth2.ReuseTokenSource(token, nil)
- }
-
- oauthClient := oauth2.NewClient(oauth2.NoContext, tokenSource)
-
- if *writeObject != "" {
- writeCloudStorageObject(oauthClient)
- return
- }
-
- computeService, _ := compute.New(oauthClient)
-
- natIP := *staticIP
- if natIP == "" {
- // Try to find it by name.
- aggAddrList, err := computeService.Addresses.AggregatedList(*proj).Do()
- if err != nil {
- log.Fatal(err)
- }
- // http://godoc.org/code.google.com/p/google-api-go-client/compute/v1#AddressAggregatedList
- IPLoop:
- for _, asl := range aggAddrList.Items {
- for _, addr := range asl.Addresses {
- if addr.Name == *instName+"-ip" && addr.Status == "RESERVED" {
- natIP = addr.Address
- break IPLoop
- }
- }
- }
- }
-
- cloudConfig := baseConfig
- if *sshPub != "" {
- key := strings.TrimSpace(readFile(*sshPub))
- cloudConfig += fmt.Sprintf("\nssh_authorized_keys:\n - %s\n", key)
- }
- if os.Getenv("USER") == "bradfitz" {
- cloudConfig += fmt.Sprintf("\nssh_authorized_keys:\n - %s\n", "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAIEAwks9dwWKlRC+73gRbvYtVg0vdCwDSuIlyt4z6xa/YU/jTDynM4R4W10hm2tPjy8iR1k8XhDv4/qdxe6m07NjG/By1tkmGpm1mGwho4Pr5kbAAy/Qg+NLCSdAYnnE00FQEcFOC15GFVMOW2AzDGKisReohwH9eIzHPzdYQNPRWXE= bradfitz@papag.bradfitz.com")
- }
- const maxCloudConfig = 32 << 10 // per compute API docs
- if len(cloudConfig) > maxCloudConfig {
- log.Fatalf("cloud config length of %d bytes is over %d byte limit", len(cloudConfig), maxCloudConfig)
- }
-
- instance := &compute.Instance{
- Name: *instName,
- Description: "Go Builder",
- MachineType: machType,
- Disks: []*compute.AttachedDisk{instanceDisk(computeService)},
- Tags: &compute.Tags{
- Items: []string{"http-server", "https-server"},
- },
- Metadata: &compute.Metadata{
- Items: []*compute.MetadataItems{
- {
- Key: "user-data",
- Value: cloudConfig,
- },
- },
- },
- NetworkInterfaces: []*compute.NetworkInterface{
- &compute.NetworkInterface{
- AccessConfigs: []*compute.AccessConfig{
- &compute.AccessConfig{
- Type: "ONE_TO_ONE_NAT",
- Name: "External NAT",
- NatIP: natIP,
- },
- },
- Network: prefix + "/global/networks/default",
- },
- },
- ServiceAccounts: []*compute.ServiceAccount{
- {
- Email: "default",
- Scopes: []string{
- compute.DevstorageFull_controlScope,
- compute.ComputeScope,
- },
- },
- },
- }
-
- log.Printf("Creating instance...")
- op, err := computeService.Instances.Insert(*proj, *zone, instance).Do()
- if err != nil {
- log.Fatalf("Failed to create instance: %v", err)
- }
- opName := op.Name
- log.Printf("Created. Waiting on operation %v", opName)
-OpLoop:
- for {
- time.Sleep(2 * time.Second)
- op, err := computeService.ZoneOperations.Get(*proj, *zone, opName).Do()
- if err != nil {
- log.Fatalf("Failed to get op %s: %v", opName, err)
- }
- switch op.Status {
- case "PENDING", "RUNNING":
- log.Printf("Waiting on operation %v", opName)
- continue
- case "DONE":
- if op.Error != nil {
- for _, operr := range op.Error.Errors {
- log.Printf("Error: %+v", operr)
- }
- log.Fatalf("Failed to start.")
- }
- log.Printf("Success. %+v", op)
- break OpLoop
- default:
- log.Fatalf("Unknown status %q: %+v", op.Status, op)
- }
- }
-
- inst, err := computeService.Instances.Get(*proj, *zone, *instName).Do()
- if err != nil {
- log.Fatalf("Error getting instance after creation: %v", err)
- }
- ij, _ := json.MarshalIndent(inst, "", " ")
- log.Printf("Instance: %s", ij)
-}
-
-func instanceDisk(svc *compute.Service) *compute.AttachedDisk {
- const imageURL = "https://www.googleapis.com/compute/v1/projects/coreos-cloud/global/images/coreos-stable-444-5-0-v20141016"
- diskName := *instName + "-disk"
-
- return &compute.AttachedDisk{
- AutoDelete: true,
- Boot: true,
- Type: "PERSISTENT",
- InitializeParams: &compute.AttachedDiskInitializeParams{
- DiskName: diskName,
- SourceImage: imageURL,
- DiskSizeGb: 50,
- },
- }
-}
-
-func writeCloudStorageObject(httpClient *http.Client) {
- content := os.Stdin
- const maxSlurp = 1 << 20
- var buf bytes.Buffer
- n, err := io.CopyN(&buf, content, maxSlurp)
- if err != nil && err != io.EOF {
- log.Fatalf("Error reading from stdin: %v, %v", n, err)
- }
- contentType := http.DetectContentType(buf.Bytes())
-
- req, err := http.NewRequest("PUT", "https://storage.googleapis.com/"+*writeObject, io.MultiReader(&buf, content))
- if err != nil {
- log.Fatal(err)
- }
- req.Header.Set("x-goog-api-version", "2")
- if *publicObject {
- req.Header.Set("x-goog-acl", "public-read")
- }
- req.Header.Set("Content-Type", contentType)
- res, err := httpClient.Do(req)
- if err != nil {
- log.Fatal(err)
- }
- if res.StatusCode != 200 {
- res.Write(os.Stderr)
- log.Fatalf("Failed.")
- }
- log.Printf("Success.")
- os.Exit(0)
-}
-
-type tokenCacheFile string
-
-func (f tokenCacheFile) Token() (*oauth2.Token, error) {
- slurp, err := ioutil.ReadFile(string(f))
- if err != nil {
- return nil, err
- }
- t := new(oauth2.Token)
- if err := json.Unmarshal(slurp, t); err != nil {
- return nil, err
- }
- return t, nil
-}
-
-func (f tokenCacheFile) WriteToken(t *oauth2.Token) error {
- jt, err := json.Marshal(t)
- if err != nil {
- return err
- }
- return ioutil.WriteFile(string(f), jt, 0600)
-}
diff --git a/vendor/github.com/bradfitz/http2/h2demo/rootCA.key b/vendor/github.com/bradfitz/http2/h2demo/rootCA.key
deleted file mode 100644
index a15a6aba..00000000
--- a/vendor/github.com/bradfitz/http2/h2demo/rootCA.key
+++ /dev/null
@@ -1,27 +0,0 @@
------BEGIN RSA PRIVATE KEY-----
-MIIEowIBAAKCAQEAt5fAjp4fTcekWUTfzsp0kyih1OYbsGL0KX1eRbSSR8Od0+9Q
-62Hyny+GFwMTb4A/KU8mssoHvcceSAAbwfbxFK/+s51TobqUnORZrOoTZjkUygby
-XDSK99YBbcR1Pip8vwMTm4XKuLtCigeBBdjjAQdgUO28LENGlsMnmeYkJfODVGnV
-mr5Ltb9ANA8IKyTfsnHJ4iOCS/PlPbUj2q7YnoVLposUBMlgUb/CykX3mOoLb4yJ
-JQyA/iST6ZxiIEj36D4yWZ5lg7YJl+UiiBQHGCnPdGyipqV06ex0heYWcaiW8LWZ
-SUQ93jQ+WVCH8hT7DQO1dmsvUmXlq/JeAlwQ/QIDAQABAoIBAFFHV7JMAqPWnMYA
-nezY6J81v9+XN+7xABNWM2Q8uv4WdksbigGLTXR3/680Z2hXqJ7LMeC5XJACFT/e
-/Gr0vmpgOCygnCPfjGehGKpavtfksXV3edikUlnCXsOP1C//c1bFL+sMYmFCVgTx
-qYdDK8yKzXNGrKYT6q5YG7IglyRNV1rsQa8lM/5taFYiD1Ck/3tQi3YIq8Lcuser
-hrxsMABcQ6mi+EIvG6Xr4mfJug0dGJMHG4RG1UGFQn6RXrQq2+q53fC8ZbVUSi0j
-NQ918aKFzktwv+DouKU0ME4I9toks03gM860bAL7zCbKGmwR3hfgX/TqzVCWpG9E
-LDVfvekCgYEA8fk9N53jbBRmULUGEf4qWypcLGiZnNU0OeXWpbPV9aa3H0VDytA7
-8fCN2dPAVDPqlthMDdVe983NCNwp2Yo8ZimDgowyIAKhdC25s1kejuaiH9OAPj3c
-0f8KbriYX4n8zNHxFwK6Ae3pQ6EqOLJVCUsziUaZX9nyKY5aZlyX6xcCgYEAwjws
-K62PjC64U5wYddNLp+kNdJ4edx+a7qBb3mEgPvSFT2RO3/xafJyG8kQB30Mfstjd
-bRxyUV6N0vtX1zA7VQtRUAvfGCecpMo+VQZzcHXKzoRTnQ7eZg4Lmj5fQ9tOAKAo
-QCVBoSW/DI4PZL26CAMDcAba4Pa22ooLapoRIQsCgYA6pIfkkbxLNkpxpt2YwLtt
-Kr/590O7UaR9n6k8sW/aQBRDXNsILR1KDl2ifAIxpf9lnXgZJiwE7HiTfCAcW7c1
-nzwDCI0hWuHcMTS/NYsFYPnLsstyyjVZI3FY0h4DkYKV9Q9z3zJLQ2hz/nwoD3gy
-b2pHC7giFcTts1VPV4Nt8wKBgHeFn4ihHJweg76vZz3Z78w7VNRWGFklUalVdDK7
-gaQ7w2y/ROn/146mo0OhJaXFIFRlrpvdzVrU3GDf2YXJYDlM5ZRkObwbZADjksev
-WInzcgDy3KDg7WnPasRXbTfMU4t/AkW2p1QKbi3DnSVYuokDkbH2Beo45vxDxhKr
-C69RAoGBAIyo3+OJenoZmoNzNJl2WPW5MeBUzSh8T/bgyjFTdqFHF5WiYRD/lfHj
-x9Glyw2nutuT4hlOqHvKhgTYdDMsF2oQ72fe3v8Q5FU7FuKndNPEAyvKNXZaShVA
-hnlhv5DjXKb0wFWnt5PCCiQLtzG0yyHaITrrEme7FikkIcTxaX/Y
------END RSA PRIVATE KEY-----
diff --git a/vendor/github.com/bradfitz/http2/h2demo/rootCA.srl b/vendor/github.com/bradfitz/http2/h2demo/rootCA.srl
deleted file mode 100644
index 6db38918..00000000
--- a/vendor/github.com/bradfitz/http2/h2demo/rootCA.srl
+++ /dev/null
@@ -1 +0,0 @@
-E2CE26BF3285059C
diff --git a/vendor/github.com/bradfitz/http2/h2demo/server.crt b/vendor/github.com/bradfitz/http2/h2demo/server.crt
deleted file mode 100644
index c59059bd..00000000
--- a/vendor/github.com/bradfitz/http2/h2demo/server.crt
+++ /dev/null
@@ -1,20 +0,0 @@
------BEGIN CERTIFICATE-----
-MIIDPjCCAiYCCQDizia/MoUFnDANBgkqhkiG9w0BAQUFADB7MQswCQYDVQQGEwJV
-UzELMAkGA1UECBMCQ0ExFjAUBgNVBAcTDVNhbiBGcmFuY2lzY28xFDASBgNVBAoT
-C0JyYWRmaXR6aW5jMRIwEAYDVQQDEwlsb2NhbGhvc3QxHTAbBgkqhkiG9w0BCQEW
-DmJyYWRAZGFuZ2EuY29tMB4XDTE0MDcxNTIwNTAyN1oXDTE1MTEyNzIwNTAyN1ow
-RzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQswCQYDVQQHEwJTRjEeMBwGA1UE
-ChMVYnJhZGZpdHogaHR0cDIgc2VydmVyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A
-MIIBCgKCAQEAs1Y9CyLFrdL8VQWN1WaifDqaZFnoqjHhCMlc1TfG2zA+InDifx2l
-gZD3o8FeNnAcfM2sPlk3+ZleOYw9P/CklFVDlvqmpCv9ss/BEp/dDaWvy1LmJ4c2
-dbQJfmTxn7CV1H3TsVJvKdwFmdoABb41NoBp6+NNO7OtDyhbIMiCI0pL3Nefb3HL
-A7hIMo3DYbORTtJLTIH9W8YKrEWL0lwHLrYFx/UdutZnv+HjdmO6vCN4na55mjws
-/vjKQUmc7xeY7Xe20xDEG2oDKVkL2eD7FfyrYMS3rO1ExP2KSqlXYG/1S9I/fz88
-F0GK7HX55b5WjZCl2J3ERVdnv/0MQv+sYQIDAQABMA0GCSqGSIb3DQEBBQUAA4IB
-AQC0zL+n/YpRZOdulSu9tS8FxrstXqGWoxfe+vIUgqfMZ5+0MkjJ/vW0FqlLDl2R
-rn4XaR3e7FmWkwdDVbq/UB6lPmoAaFkCgh9/5oapMaclNVNnfF3fjCJfRr+qj/iD
-EmJStTIN0ZuUjAlpiACmfnpEU55PafT5Zx+i1yE4FGjw8bJpFoyD4Hnm54nGjX19
-KeCuvcYFUPnBm3lcL0FalF2AjqV02WTHYNQk7YF/oeO7NKBoEgvGvKG3x+xaOeBI
-dwvdq175ZsGul30h+QjrRlXhH/twcuaT3GSdoysDl9cCYE8f1Mk8PD6gan3uBCJU
-90p6/CbU71bGbfpM2PHot2fm
------END CERTIFICATE-----
diff --git a/vendor/github.com/bradfitz/http2/h2demo/server.key b/vendor/github.com/bradfitz/http2/h2demo/server.key
deleted file mode 100644
index f329c142..00000000
--- a/vendor/github.com/bradfitz/http2/h2demo/server.key
+++ /dev/null
@@ -1,27 +0,0 @@
------BEGIN RSA PRIVATE KEY-----
-MIIEowIBAAKCAQEAs1Y9CyLFrdL8VQWN1WaifDqaZFnoqjHhCMlc1TfG2zA+InDi
-fx2lgZD3o8FeNnAcfM2sPlk3+ZleOYw9P/CklFVDlvqmpCv9ss/BEp/dDaWvy1Lm
-J4c2dbQJfmTxn7CV1H3TsVJvKdwFmdoABb41NoBp6+NNO7OtDyhbIMiCI0pL3Nef
-b3HLA7hIMo3DYbORTtJLTIH9W8YKrEWL0lwHLrYFx/UdutZnv+HjdmO6vCN4na55
-mjws/vjKQUmc7xeY7Xe20xDEG2oDKVkL2eD7FfyrYMS3rO1ExP2KSqlXYG/1S9I/
-fz88F0GK7HX55b5WjZCl2J3ERVdnv/0MQv+sYQIDAQABAoIBADQ2spUwbY+bcz4p
-3M66ECrNQTBggP40gYl2XyHxGGOu2xhZ94f9ELf1hjRWU2DUKWco1rJcdZClV6q3
-qwmXvcM2Q/SMS8JW0ImkNVl/0/NqPxGatEnj8zY30d/L8hGFb0orzFu/XYA5gCP4
-NbN2WrXgk3ZLeqwcNxHHtSiJWGJ/fPyeDWAu/apy75u9Xf2GlzBZmV6HYD9EfK80
-LTlI60f5FO487CrJnboL7ovPJrIHn+k05xRQqwma4orpz932rTXnTjs9Lg6KtbQN
-a7PrqfAntIISgr11a66Mng3IYH1lYqJsWJJwX/xHT4WLEy0EH4/0+PfYemJekz2+
-Co62drECgYEA6O9zVJZXrLSDsIi54cfxA7nEZWm5CAtkYWeAHa4EJ+IlZ7gIf9sL
-W8oFcEfFGpvwVqWZ+AsQ70dsjXAv3zXaG0tmg9FtqWp7pzRSMPidifZcQwWkKeTO
-gJnFmnVyed8h6GfjTEu4gxo1/S5U0V+mYSha01z5NTnN6ltKx1Or3b0CgYEAxRgm
-S30nZxnyg/V7ys61AZhst1DG2tkZXEMcA7dYhabMoXPJAP/EfhlWwpWYYUs/u0gS
-Wwmf5IivX5TlYScgmkvb/NYz0u4ZmOXkLTnLPtdKKFXhjXJcHjUP67jYmOxNlJLp
-V4vLRnFxTpffAV+OszzRxsXX6fvruwZBANYJeXUCgYBVouLFsFgfWGYp2rpr9XP4
-KK25kvrBqF6JKOIDB1zjxNJ3pUMKrl8oqccCFoCyXa4oTM2kUX0yWxHfleUjrMq4
-yimwQKiOZmV7fVLSSjSw6e/VfBd0h3gb82ygcplZkN0IclkwTY5SNKqwn/3y07V5
-drqdhkrgdJXtmQ6O5YYECQKBgATERcDToQ1USlI4sKrB/wyv1AlG8dg/IebiVJ4e
-ZAyvcQmClFzq0qS+FiQUnB/WQw9TeeYrwGs1hxBHuJh16srwhLyDrbMvQP06qh8R
-48F8UXXSRec22dV9MQphaROhu2qZdv1AC0WD3tqov6L33aqmEOi+xi8JgbT/PLk5
-c/c1AoGBAI1A/02ryksW6/wc7/6SP2M2rTy4m1sD/GnrTc67EHnRcVBdKO6qH2RY
-nqC8YcveC2ZghgPTDsA3VGuzuBXpwY6wTyV99q6jxQJ6/xcrD9/NUG6Uwv/xfCxl
-IJLeBYEqQundSSny3VtaAUK8Ul1nxpTvVRNwtcyWTo8RHAAyNPWd
------END RSA PRIVATE KEY-----
diff --git a/vendor/github.com/bradfitz/http2/h2i/README.md b/vendor/github.com/bradfitz/http2/h2i/README.md
deleted file mode 100644
index 3ceecb7d..00000000
--- a/vendor/github.com/bradfitz/http2/h2i/README.md
+++ /dev/null
@@ -1,97 +0,0 @@
-# h2i
-
-**h2i** is an interactive HTTP/2 ("h2") console debugger. Miss the good ol'
-days of telnetting to your HTTP/1.n servers? We're bringing you
-back.
-
-Features:
-- send raw HTTP/2 frames
- - PING
- - SETTINGS
- - HEADERS
- - etc
-- type in HTTP/1.n and have it auto-HPACK/frame-ify it for HTTP/2
-- pretty print all received HTTP/2 frames from the peer (including HPACK decoding)
-- tab completion of commands, options
-
-Not yet features, but soon:
-- unnecessary CONTINUATION frames on short boundaries, to test peer implementations
-- request bodies (DATA frames)
-- send invalid frames for testing server implementations (supported by underlying Framer)
-
-Later:
-- act like a server
-
-## Installation
-
-```
-$ go get github.com/bradfitz/http2/h2i
-$ h2i
-```
-
-## Demo
-
-```
-$ h2i
-Usage: h2i
-
- -insecure
- Whether to skip TLS cert validation
- -nextproto string
- Comma-separated list of NPN/ALPN protocol names to negotiate. (default "h2,h2-14")
-
-$ h2i google.com
-Connecting to google.com:443 ...
-Connected to 74.125.224.41:443
-Negotiated protocol "h2-14"
-[FrameHeader SETTINGS len=18]
- [MAX_CONCURRENT_STREAMS = 100]
- [INITIAL_WINDOW_SIZE = 1048576]
- [MAX_FRAME_SIZE = 16384]
-[FrameHeader WINDOW_UPDATE len=4]
- Window-Increment = 983041
-
-h2i> PING h2iSayHI
-[FrameHeader PING flags=ACK len=8]
- Data = "h2iSayHI"
-h2i> headers
-(as HTTP/1.1)> GET / HTTP/1.1
-(as HTTP/1.1)> Host: ip.appspot.com
-(as HTTP/1.1)> User-Agent: h2i/brad-n-blake
-(as HTTP/1.1)>
-Opening Stream-ID 1:
- :authority = ip.appspot.com
- :method = GET
- :path = /
- :scheme = https
- user-agent = h2i/brad-n-blake
-[FrameHeader HEADERS flags=END_HEADERS stream=1 len=77]
- :status = "200"
- alternate-protocol = "443:quic,p=1"
- content-length = "15"
- content-type = "text/html"
- date = "Fri, 01 May 2015 23:06:56 GMT"
- server = "Google Frontend"
-[FrameHeader DATA flags=END_STREAM stream=1 len=15]
- "173.164.155.78\n"
-[FrameHeader PING len=8]
- Data = "\x00\x00\x00\x00\x00\x00\x00\x00"
-h2i> ping
-[FrameHeader PING flags=ACK len=8]
- Data = "h2i_ping"
-h2i> ping
-[FrameHeader PING flags=ACK len=8]
- Data = "h2i_ping"
-h2i> ping
-[FrameHeader GOAWAY len=22]
- Last-Stream-ID = 1; Error-Code = PROTOCOL_ERROR (1)
-
-ReadFrame: EOF
-```
-
-## Status
-
-Quick few hour hack. So much yet to do. Feel free to file issues for
-bugs or wishlist items, but [@bmizerany](https://github.com/bmizerany/)
-and I aren't yet accepting pull requests until things settle down.
-
diff --git a/vendor/github.com/bradfitz/http2/h2i/h2i.go b/vendor/github.com/bradfitz/http2/h2i/h2i.go
deleted file mode 100644
index 67b874d6..00000000
--- a/vendor/github.com/bradfitz/http2/h2i/h2i.go
+++ /dev/null
@@ -1,489 +0,0 @@
-// Copyright 2015 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-// See https://code.google.com/p/go/source/browse/CONTRIBUTORS
-// Licensed under the same terms as Go itself:
-// https://code.google.com/p/go/source/browse/LICENSE
-
-/*
-The h2i command is an interactive HTTP/2 console.
-
-Usage:
- $ h2i [flags]
-
-Interactive commands in the console: (all parts case-insensitive)
-
- ping [data]
- settings ack
- settings FOO=n BAR=z
- headers (open a new stream by typing HTTP/1.1)
-*/
-package main
-
-import (
- "bufio"
- "bytes"
- "crypto/tls"
- "errors"
- "flag"
- "fmt"
- "io"
- "log"
- "net"
- "net/http"
- "os"
- "regexp"
- "strconv"
- "strings"
-
- "github.com/bradfitz/http2"
- "github.com/bradfitz/http2/hpack"
- "golang.org/x/crypto/ssh/terminal"
-)
-
-// Flags
-var (
- flagNextProto = flag.String("nextproto", "h2,h2-14", "Comma-separated list of NPN/ALPN protocol names to negotiate.")
- flagInsecure = flag.Bool("insecure", false, "Whether to skip TLS cert validation")
-)
-
-type command struct {
- run func(*h2i, []string) error // required
-
- // complete optionally specifies tokens (case-insensitive) which are
- // valid for this subcommand.
- complete func() []string
-}
-
-var commands = map[string]command{
- "ping": command{run: (*h2i).cmdPing},
- "settings": command{
- run: (*h2i).cmdSettings,
- complete: func() []string {
- return []string{
- "ACK",
- http2.SettingHeaderTableSize.String(),
- http2.SettingEnablePush.String(),
- http2.SettingMaxConcurrentStreams.String(),
- http2.SettingInitialWindowSize.String(),
- http2.SettingMaxFrameSize.String(),
- http2.SettingMaxHeaderListSize.String(),
- }
- },
- },
- "quit": command{run: (*h2i).cmdQuit},
- "headers": command{run: (*h2i).cmdHeaders},
-}
-
-func usage() {
- fmt.Fprintf(os.Stderr, "Usage: h2i \n\n")
- flag.PrintDefaults()
- os.Exit(1)
-}
-
-// withPort adds ":443" if another port isn't already present.
-func withPort(host string) string {
- if _, _, err := net.SplitHostPort(host); err != nil {
- return net.JoinHostPort(host, "443")
- }
- return host
-}
-
-// h2i is the app's state.
-type h2i struct {
- host string
- tc *tls.Conn
- framer *http2.Framer
- term *terminal.Terminal
-
- // owned by the command loop:
- streamID uint32
- hbuf bytes.Buffer
- henc *hpack.Encoder
-
- // owned by the readFrames loop:
- peerSetting map[http2.SettingID]uint32
- hdec *hpack.Decoder
-}
-
-func main() {
- flag.Usage = usage
- flag.Parse()
- if flag.NArg() != 1 {
- usage()
- }
- log.SetFlags(0)
-
- host := flag.Arg(0)
- app := &h2i{
- host: host,
- peerSetting: make(map[http2.SettingID]uint32),
- }
- app.henc = hpack.NewEncoder(&app.hbuf)
-
- if err := app.Main(); err != nil {
- if app.term != nil {
- app.logf("%v\n", err)
- } else {
- fmt.Fprintf(os.Stderr, "%v\n", err)
- }
- os.Exit(1)
- }
- fmt.Fprintf(os.Stdout, "\n")
-}
-
-func (app *h2i) Main() error {
- cfg := &tls.Config{
- ServerName: app.host,
- NextProtos: strings.Split(*flagNextProto, ","),
- InsecureSkipVerify: *flagInsecure,
- }
-
- hostAndPort := withPort(app.host)
- log.Printf("Connecting to %s ...", hostAndPort)
- tc, err := tls.Dial("tcp", hostAndPort, cfg)
- if err != nil {
- return fmt.Errorf("Error dialing %s: %v", withPort(app.host), err)
- }
- log.Printf("Connected to %v", tc.RemoteAddr())
- defer tc.Close()
-
- if err := tc.Handshake(); err != nil {
- return fmt.Errorf("TLS handshake: %v", err)
- }
- if !*flagInsecure {
- if err := tc.VerifyHostname(app.host); err != nil {
- return fmt.Errorf("VerifyHostname: %v", err)
- }
- }
- state := tc.ConnectionState()
- log.Printf("Negotiated protocol %q", state.NegotiatedProtocol)
- if !state.NegotiatedProtocolIsMutual || state.NegotiatedProtocol == "" {
- return fmt.Errorf("Could not negotiate protocol mutually")
- }
-
- if _, err := io.WriteString(tc, http2.ClientPreface); err != nil {
- return err
- }
-
- app.framer = http2.NewFramer(tc, tc)
-
- oldState, err := terminal.MakeRaw(0)
- if err != nil {
- return err
- }
- defer terminal.Restore(0, oldState)
-
- var screen = struct {
- io.Reader
- io.Writer
- }{os.Stdin, os.Stdout}
-
- app.term = terminal.NewTerminal(screen, "h2i> ")
- lastWord := regexp.MustCompile(`.+\W(\w+)$`)
- app.term.AutoCompleteCallback = func(line string, pos int, key rune) (newLine string, newPos int, ok bool) {
- if key != '\t' {
- return
- }
- if pos != len(line) {
- // TODO: we're being lazy for now, only supporting tab completion at the end.
- return
- }
- // Auto-complete for the command itself.
- if !strings.Contains(line, " ") {
- var name string
- name, _, ok = lookupCommand(line)
- if !ok {
- return
- }
- return name, len(name), true
- }
- _, c, ok := lookupCommand(line[:strings.IndexByte(line, ' ')])
- if !ok || c.complete == nil {
- return
- }
- if strings.HasSuffix(line, " ") {
- app.logf("%s", strings.Join(c.complete(), " "))
- return line, pos, true
- }
- m := lastWord.FindStringSubmatch(line)
- if m == nil {
- return line, len(line), true
- }
- soFar := m[1]
- var match []string
- for _, cand := range c.complete() {
- if len(soFar) > len(cand) || !strings.EqualFold(cand[:len(soFar)], soFar) {
- continue
- }
- match = append(match, cand)
- }
- if len(match) == 0 {
- return
- }
- if len(match) > 1 {
- // TODO: auto-complete any common prefix
- app.logf("%s", strings.Join(match, " "))
- return line, pos, true
- }
- newLine = line[:len(line)-len(soFar)] + match[0]
- return newLine, len(newLine), true
-
- }
-
- errc := make(chan error, 2)
- go func() { errc <- app.readFrames() }()
- go func() { errc <- app.readConsole() }()
- return <-errc
-}
-
-func (app *h2i) logf(format string, args ...interface{}) {
- fmt.Fprintf(app.term, format+"\n", args...)
-}
-
-func (app *h2i) readConsole() error {
- for {
- line, err := app.term.ReadLine()
- if err == io.EOF {
- return nil
- }
- if err != nil {
- return fmt.Errorf("terminal.ReadLine: %v", err)
- }
- f := strings.Fields(line)
- if len(f) == 0 {
- continue
- }
- cmd, args := f[0], f[1:]
- if _, c, ok := lookupCommand(cmd); ok {
- err = c.run(app, args)
- } else {
- app.logf("Unknown command %q", line)
- }
- if err == errExitApp {
- return nil
- }
- if err != nil {
- return err
- }
- }
-}
-
-func lookupCommand(prefix string) (name string, c command, ok bool) {
- prefix = strings.ToLower(prefix)
- if c, ok = commands[prefix]; ok {
- return prefix, c, ok
- }
-
- for full, candidate := range commands {
- if strings.HasPrefix(full, prefix) {
- if c.run != nil {
- return "", command{}, false // ambiguous
- }
- c = candidate
- name = full
- }
- }
- return name, c, c.run != nil
-}
-
-var errExitApp = errors.New("internal sentinel error value to quit the console reading loop")
-
-func (a *h2i) cmdQuit(args []string) error {
- if len(args) > 0 {
- a.logf("the QUIT command takes no argument")
- return nil
- }
- return errExitApp
-}
-
-func (a *h2i) cmdSettings(args []string) error {
- if len(args) == 1 && strings.EqualFold(args[0], "ACK") {
- return a.framer.WriteSettingsAck()
- }
- var settings []http2.Setting
- for _, arg := range args {
- if strings.EqualFold(arg, "ACK") {
- a.logf("Error: ACK must be only argument with the SETTINGS command")
- return nil
- }
- eq := strings.Index(arg, "=")
- if eq == -1 {
- a.logf("Error: invalid argument %q (expected SETTING_NAME=nnnn)", arg)
- return nil
- }
- sid, ok := settingByName(arg[:eq])
- if !ok {
- a.logf("Error: unknown setting name %q", arg[:eq])
- return nil
- }
- val, err := strconv.ParseUint(arg[eq+1:], 10, 32)
- if err != nil {
- a.logf("Error: invalid argument %q (expected SETTING_NAME=nnnn)", arg)
- return nil
- }
- settings = append(settings, http2.Setting{
- ID: sid,
- Val: uint32(val),
- })
- }
- a.logf("Sending: %v", settings)
- return a.framer.WriteSettings(settings...)
-}
-
-func settingByName(name string) (http2.SettingID, bool) {
- for _, sid := range [...]http2.SettingID{
- http2.SettingHeaderTableSize,
- http2.SettingEnablePush,
- http2.SettingMaxConcurrentStreams,
- http2.SettingInitialWindowSize,
- http2.SettingMaxFrameSize,
- http2.SettingMaxHeaderListSize,
- } {
- if strings.EqualFold(sid.String(), name) {
- return sid, true
- }
- }
- return 0, false
-}
-
-func (app *h2i) cmdPing(args []string) error {
- if len(args) > 1 {
- app.logf("invalid PING usage: only accepts 0 or 1 args")
- return nil // nil means don't end the program
- }
- var data [8]byte
- if len(args) == 1 {
- copy(data[:], args[0])
- } else {
- copy(data[:], "h2i_ping")
- }
- return app.framer.WritePing(false, data)
-}
-
-func (app *h2i) cmdHeaders(args []string) error {
- if len(args) > 0 {
- app.logf("Error: HEADERS doesn't yet take arguments.")
- // TODO: flags for restricting window size, to force CONTINUATION
- // frames.
- return nil
- }
- var h1req bytes.Buffer
- app.term.SetPrompt("(as HTTP/1.1)> ")
- defer app.term.SetPrompt("h2i> ")
- for {
- line, err := app.term.ReadLine()
- if err != nil {
- return err
- }
- h1req.WriteString(line)
- h1req.WriteString("\r\n")
- if line == "" {
- break
- }
- }
- req, err := http.ReadRequest(bufio.NewReader(&h1req))
- if err != nil {
- app.logf("Invalid HTTP/1.1 request: %v", err)
- return nil
- }
- if app.streamID == 0 {
- app.streamID = 1
- } else {
- app.streamID += 2
- }
- app.logf("Opening Stream-ID %d:", app.streamID)
- hbf := app.encodeHeaders(req)
- if len(hbf) > 16<<10 {
- app.logf("TODO: h2i doesn't yet write CONTINUATION frames. Copy it from transport.go")
- return nil
- }
- return app.framer.WriteHeaders(http2.HeadersFrameParam{
- StreamID: app.streamID,
- BlockFragment: hbf,
- EndStream: req.Method == "GET" || req.Method == "HEAD", // good enough for now
- EndHeaders: true, // for now
- })
-}
-
-func (app *h2i) readFrames() error {
- for {
- f, err := app.framer.ReadFrame()
- if err != nil {
- return fmt.Errorf("ReadFrame: %v", err)
- }
- app.logf("%v", f)
- switch f := f.(type) {
- case *http2.PingFrame:
- app.logf(" Data = %q", f.Data)
- case *http2.SettingsFrame:
- f.ForeachSetting(func(s http2.Setting) error {
- app.logf(" %v", s)
- app.peerSetting[s.ID] = s.Val
- return nil
- })
- case *http2.WindowUpdateFrame:
- app.logf(" Window-Increment = %v\n", f.Increment)
- case *http2.GoAwayFrame:
- app.logf(" Last-Stream-ID = %d; Error-Code = %v (%d)\n", f.LastStreamID, f.ErrCode, f.ErrCode)
- case *http2.DataFrame:
- app.logf(" %q", f.Data())
- case *http2.HeadersFrame:
- if f.HasPriority() {
- app.logf(" PRIORITY = %v", f.Priority)
- }
- if app.hdec == nil {
- // TODO: if the user uses h2i to send a SETTINGS frame advertising
- // something larger, we'll need to respect SETTINGS_HEADER_TABLE_SIZE
- // and stuff here instead of using the 4k default. But for now:
- tableSize := uint32(4 << 10)
- app.hdec = hpack.NewDecoder(tableSize, app.onNewHeaderField)
- }
- app.hdec.Write(f.HeaderBlockFragment())
- }
- }
-}
-
-// called from readLoop
-func (app *h2i) onNewHeaderField(f hpack.HeaderField) {
- if f.Sensitive {
- app.logf(" %s = %q (SENSITIVE)", f.Name, f.Value)
- }
- app.logf(" %s = %q", f.Name, f.Value)
-}
-
-func (app *h2i) encodeHeaders(req *http.Request) []byte {
- app.hbuf.Reset()
-
- // TODO(bradfitz): figure out :authority-vs-Host stuff between http2 and Go
- host := req.Host
- if host == "" {
- host = req.URL.Host
- }
-
- path := req.URL.Path
- if path == "" {
- path = "/"
- }
-
- app.writeHeader(":authority", host) // probably not right for all sites
- app.writeHeader(":method", req.Method)
- app.writeHeader(":path", path)
- app.writeHeader(":scheme", "https")
-
- for k, vv := range req.Header {
- lowKey := strings.ToLower(k)
- if lowKey == "host" {
- continue
- }
- for _, v := range vv {
- app.writeHeader(lowKey, v)
- }
- }
- return app.hbuf.Bytes()
-}
-
-func (app *h2i) writeHeader(name, value string) {
- app.henc.WriteField(hpack.HeaderField{Name: name, Value: value})
- app.logf(" %s = %s", name, value)
-}
diff --git a/vendor/github.com/bradfitz/http2/hpack/encode_test.go b/vendor/github.com/bradfitz/http2/hpack/encode_test.go
deleted file mode 100644
index dce66c90..00000000
--- a/vendor/github.com/bradfitz/http2/hpack/encode_test.go
+++ /dev/null
@@ -1,331 +0,0 @@
-// Copyright 2014 The Go Authors.
-// See https://code.google.com/p/go/source/browse/CONTRIBUTORS
-// Licensed under the same terms as Go itself:
-// https://code.google.com/p/go/source/browse/LICENSE
-
-package hpack
-
-import (
- "bytes"
- "encoding/hex"
- "reflect"
- "strings"
- "testing"
-)
-
-func TestEncoderTableSizeUpdate(t *testing.T) {
- tests := []struct {
- size1, size2 uint32
- wantHex string
- }{
- // Should emit 2 table size updates (2048 and 4096)
- {2048, 4096, "3fe10f 3fe11f 82"},
-
- // Should emit 1 table size update (2048)
- {16384, 2048, "3fe10f 82"},
- }
- for _, tt := range tests {
- var buf bytes.Buffer
- e := NewEncoder(&buf)
- e.SetMaxDynamicTableSize(tt.size1)
- e.SetMaxDynamicTableSize(tt.size2)
- if err := e.WriteField(pair(":method", "GET")); err != nil {
- t.Fatal(err)
- }
- want := removeSpace(tt.wantHex)
- if got := hex.EncodeToString(buf.Bytes()); got != want {
- t.Errorf("e.SetDynamicTableSize %v, %v = %q; want %q", tt.size1, tt.size2, got, want)
- }
- }
-}
-
-func TestEncoderWriteField(t *testing.T) {
- var buf bytes.Buffer
- e := NewEncoder(&buf)
- var got []HeaderField
- d := NewDecoder(4<<10, func(f HeaderField) {
- got = append(got, f)
- })
-
- tests := []struct {
- hdrs []HeaderField
- }{
- {[]HeaderField{
- pair(":method", "GET"),
- pair(":scheme", "http"),
- pair(":path", "/"),
- pair(":authority", "www.example.com"),
- }},
- {[]HeaderField{
- pair(":method", "GET"),
- pair(":scheme", "http"),
- pair(":path", "/"),
- pair(":authority", "www.example.com"),
- pair("cache-control", "no-cache"),
- }},
- {[]HeaderField{
- pair(":method", "GET"),
- pair(":scheme", "https"),
- pair(":path", "/index.html"),
- pair(":authority", "www.example.com"),
- pair("custom-key", "custom-value"),
- }},
- }
- for i, tt := range tests {
- buf.Reset()
- got = got[:0]
- for _, hf := range tt.hdrs {
- if err := e.WriteField(hf); err != nil {
- t.Fatal(err)
- }
- }
- _, err := d.Write(buf.Bytes())
- if err != nil {
- t.Errorf("%d. Decoder Write = %v", i, err)
- }
- if !reflect.DeepEqual(got, tt.hdrs) {
- t.Errorf("%d. Decoded %+v; want %+v", i, got, tt.hdrs)
- }
- }
-}
-
-func TestEncoderSearchTable(t *testing.T) {
- e := NewEncoder(nil)
-
- e.dynTab.add(pair("foo", "bar"))
- e.dynTab.add(pair("blake", "miz"))
- e.dynTab.add(pair(":method", "GET"))
-
- tests := []struct {
- hf HeaderField
- wantI uint64
- wantMatch bool
- }{
- // Name and Value match
- {pair("foo", "bar"), uint64(len(staticTable) + 3), true},
- {pair("blake", "miz"), uint64(len(staticTable) + 2), true},
- {pair(":method", "GET"), 2, true},
-
- // Only name match because Sensitive == true
- {HeaderField{":method", "GET", true}, 2, false},
-
- // Only Name matches
- {pair("foo", "..."), uint64(len(staticTable) + 3), false},
- {pair("blake", "..."), uint64(len(staticTable) + 2), false},
- {pair(":method", "..."), 2, false},
-
- // None match
- {pair("foo-", "bar"), 0, false},
- }
- for _, tt := range tests {
- if gotI, gotMatch := e.searchTable(tt.hf); gotI != tt.wantI || gotMatch != tt.wantMatch {
- t.Errorf("d.search(%+v) = %v, %v; want %v, %v", tt.hf, gotI, gotMatch, tt.wantI, tt.wantMatch)
- }
- }
-}
-
-func TestAppendVarInt(t *testing.T) {
- tests := []struct {
- n byte
- i uint64
- want []byte
- }{
- // Fits in a byte:
- {1, 0, []byte{0}},
- {2, 2, []byte{2}},
- {3, 6, []byte{6}},
- {4, 14, []byte{14}},
- {5, 30, []byte{30}},
- {6, 62, []byte{62}},
- {7, 126, []byte{126}},
- {8, 254, []byte{254}},
-
- // Multiple bytes:
- {5, 1337, []byte{31, 154, 10}},
- }
- for _, tt := range tests {
- got := appendVarInt(nil, tt.n, tt.i)
- if !bytes.Equal(got, tt.want) {
- t.Errorf("appendVarInt(nil, %v, %v) = %v; want %v", tt.n, tt.i, got, tt.want)
- }
- }
-}
-
-func TestAppendHpackString(t *testing.T) {
- tests := []struct {
- s, wantHex string
- }{
- // Huffman encoded
- {"www.example.com", "8c f1e3 c2e5 f23a 6ba0 ab90 f4ff"},
-
- // Not Huffman encoded
- {"a", "01 61"},
-
- // zero length
- {"", "00"},
- }
- for _, tt := range tests {
- want := removeSpace(tt.wantHex)
- buf := appendHpackString(nil, tt.s)
- if got := hex.EncodeToString(buf); want != got {
- t.Errorf("appendHpackString(nil, %q) = %q; want %q", tt.s, got, want)
- }
- }
-}
-
-func TestAppendIndexed(t *testing.T) {
- tests := []struct {
- i uint64
- wantHex string
- }{
- // 1 byte
- {1, "81"},
- {126, "fe"},
-
- // 2 bytes
- {127, "ff00"},
- {128, "ff01"},
- }
- for _, tt := range tests {
- want := removeSpace(tt.wantHex)
- buf := appendIndexed(nil, tt.i)
- if got := hex.EncodeToString(buf); want != got {
- t.Errorf("appendIndex(nil, %v) = %q; want %q", tt.i, got, want)
- }
- }
-}
-
-func TestAppendNewName(t *testing.T) {
- tests := []struct {
- f HeaderField
- indexing bool
- wantHex string
- }{
- // Incremental indexing
- {HeaderField{"custom-key", "custom-value", false}, true, "40 88 25a8 49e9 5ba9 7d7f 89 25a8 49e9 5bb8 e8b4 bf"},
-
- // Without indexing
- {HeaderField{"custom-key", "custom-value", false}, false, "00 88 25a8 49e9 5ba9 7d7f 89 25a8 49e9 5bb8 e8b4 bf"},
-
- // Never indexed
- {HeaderField{"custom-key", "custom-value", true}, true, "10 88 25a8 49e9 5ba9 7d7f 89 25a8 49e9 5bb8 e8b4 bf"},
- {HeaderField{"custom-key", "custom-value", true}, false, "10 88 25a8 49e9 5ba9 7d7f 89 25a8 49e9 5bb8 e8b4 bf"},
- }
- for _, tt := range tests {
- want := removeSpace(tt.wantHex)
- buf := appendNewName(nil, tt.f, tt.indexing)
- if got := hex.EncodeToString(buf); want != got {
- t.Errorf("appendNewName(nil, %+v, %v) = %q; want %q", tt.f, tt.indexing, got, want)
- }
- }
-}
-
-func TestAppendIndexedName(t *testing.T) {
- tests := []struct {
- f HeaderField
- i uint64
- indexing bool
- wantHex string
- }{
- // Incremental indexing
- {HeaderField{":status", "302", false}, 8, true, "48 82 6402"},
-
- // Without indexing
- {HeaderField{":status", "302", false}, 8, false, "08 82 6402"},
-
- // Never indexed
- {HeaderField{":status", "302", true}, 8, true, "18 82 6402"},
- {HeaderField{":status", "302", true}, 8, false, "18 82 6402"},
- }
- for _, tt := range tests {
- want := removeSpace(tt.wantHex)
- buf := appendIndexedName(nil, tt.f, tt.i, tt.indexing)
- if got := hex.EncodeToString(buf); want != got {
- t.Errorf("appendIndexedName(nil, %+v, %v) = %q; want %q", tt.f, tt.indexing, got, want)
- }
- }
-}
-
-func TestAppendTableSize(t *testing.T) {
- tests := []struct {
- i uint32
- wantHex string
- }{
- // Fits into 1 byte
- {30, "3e"},
-
- // Extra byte
- {31, "3f00"},
- {32, "3f01"},
- }
- for _, tt := range tests {
- want := removeSpace(tt.wantHex)
- buf := appendTableSize(nil, tt.i)
- if got := hex.EncodeToString(buf); want != got {
- t.Errorf("appendTableSize(nil, %v) = %q; want %q", tt.i, got, want)
- }
- }
-}
-
-func TestEncoderSetMaxDynamicTableSize(t *testing.T) {
- var buf bytes.Buffer
- e := NewEncoder(&buf)
- tests := []struct {
- v uint32
- wantUpdate bool
- wantMinSize uint32
- wantMaxSize uint32
- }{
- // Set new table size to 2048
- {2048, true, 2048, 2048},
-
- // Set new table size to 16384, but still limited to
- // 4096
- {16384, true, 2048, 4096},
- }
- for _, tt := range tests {
- e.SetMaxDynamicTableSize(tt.v)
- if got := e.tableSizeUpdate; tt.wantUpdate != got {
- t.Errorf("e.tableSizeUpdate = %v; want %v", got, tt.wantUpdate)
- }
- if got := e.minSize; tt.wantMinSize != got {
- t.Errorf("e.minSize = %v; want %v", got, tt.wantMinSize)
- }
- if got := e.dynTab.maxSize; tt.wantMaxSize != got {
- t.Errorf("e.maxSize = %v; want %v", got, tt.wantMaxSize)
- }
- }
-}
-
-func TestEncoderSetMaxDynamicTableSizeLimit(t *testing.T) {
- e := NewEncoder(nil)
- // 4095 < initialHeaderTableSize means maxSize is truncated to
- // 4095.
- e.SetMaxDynamicTableSizeLimit(4095)
- if got, want := e.dynTab.maxSize, uint32(4095); got != want {
- t.Errorf("e.dynTab.maxSize = %v; want %v", got, want)
- }
- if got, want := e.maxSizeLimit, uint32(4095); got != want {
- t.Errorf("e.maxSizeLimit = %v; want %v", got, want)
- }
- if got, want := e.tableSizeUpdate, true; got != want {
- t.Errorf("e.tableSizeUpdate = %v; want %v", got, want)
- }
- // maxSize will be truncated to maxSizeLimit
- e.SetMaxDynamicTableSize(16384)
- if got, want := e.dynTab.maxSize, uint32(4095); got != want {
- t.Errorf("e.dynTab.maxSize = %v; want %v", got, want)
- }
- // 8192 > current maxSizeLimit, so maxSize does not change.
- e.SetMaxDynamicTableSizeLimit(8192)
- if got, want := e.dynTab.maxSize, uint32(4095); got != want {
- t.Errorf("e.dynTab.maxSize = %v; want %v", got, want)
- }
- if got, want := e.maxSizeLimit, uint32(8192); got != want {
- t.Errorf("e.maxSizeLimit = %v; want %v", got, want)
- }
-}
-
-func removeSpace(s string) string {
- return strings.Replace(s, " ", "", -1)
-}
diff --git a/vendor/github.com/bradfitz/http2/hpack/hpack_test.go b/vendor/github.com/bradfitz/http2/hpack/hpack_test.go
deleted file mode 100644
index 08bee414..00000000
--- a/vendor/github.com/bradfitz/http2/hpack/hpack_test.go
+++ /dev/null
@@ -1,648 +0,0 @@
-// Copyright 2014 The Go Authors.
-// See https://code.google.com/p/go/source/browse/CONTRIBUTORS
-// Licensed under the same terms as Go itself:
-// https://code.google.com/p/go/source/browse/LICENSE
-
-package hpack
-
-import (
- "bufio"
- "bytes"
- "encoding/hex"
- "fmt"
- "reflect"
- "regexp"
- "strconv"
- "strings"
- "testing"
-)
-
-func TestStaticTable(t *testing.T) {
- fromSpec := `
- +-------+-----------------------------+---------------+
- | 1 | :authority | |
- | 2 | :method | GET |
- | 3 | :method | POST |
- | 4 | :path | / |
- | 5 | :path | /index.html |
- | 6 | :scheme | http |
- | 7 | :scheme | https |
- | 8 | :status | 200 |
- | 9 | :status | 204 |
- | 10 | :status | 206 |
- | 11 | :status | 304 |
- | 12 | :status | 400 |
- | 13 | :status | 404 |
- | 14 | :status | 500 |
- | 15 | accept-charset | |
- | 16 | accept-encoding | gzip, deflate |
- | 17 | accept-language | |
- | 18 | accept-ranges | |
- | 19 | accept | |
- | 20 | access-control-allow-origin | |
- | 21 | age | |
- | 22 | allow | |
- | 23 | authorization | |
- | 24 | cache-control | |
- | 25 | content-disposition | |
- | 26 | content-encoding | |
- | 27 | content-language | |
- | 28 | content-length | |
- | 29 | content-location | |
- | 30 | content-range | |
- | 31 | content-type | |
- | 32 | cookie | |
- | 33 | date | |
- | 34 | etag | |
- | 35 | expect | |
- | 36 | expires | |
- | 37 | from | |
- | 38 | host | |
- | 39 | if-match | |
- | 40 | if-modified-since | |
- | 41 | if-none-match | |
- | 42 | if-range | |
- | 43 | if-unmodified-since | |
- | 44 | last-modified | |
- | 45 | link | |
- | 46 | location | |
- | 47 | max-forwards | |
- | 48 | proxy-authenticate | |
- | 49 | proxy-authorization | |
- | 50 | range | |
- | 51 | referer | |
- | 52 | refresh | |
- | 53 | retry-after | |
- | 54 | server | |
- | 55 | set-cookie | |
- | 56 | strict-transport-security | |
- | 57 | transfer-encoding | |
- | 58 | user-agent | |
- | 59 | vary | |
- | 60 | via | |
- | 61 | www-authenticate | |
- +-------+-----------------------------+---------------+
-`
- bs := bufio.NewScanner(strings.NewReader(fromSpec))
- re := regexp.MustCompile(`\| (\d+)\s+\| (\S+)\s*\| (\S(.*\S)?)?\s+\|`)
- for bs.Scan() {
- l := bs.Text()
- if !strings.Contains(l, "|") {
- continue
- }
- m := re.FindStringSubmatch(l)
- if m == nil {
- continue
- }
- i, err := strconv.Atoi(m[1])
- if err != nil {
- t.Errorf("Bogus integer on line %q", l)
- continue
- }
- if i < 1 || i > len(staticTable) {
- t.Errorf("Bogus index %d on line %q", i, l)
- continue
- }
- if got, want := staticTable[i-1].Name, m[2]; got != want {
- t.Errorf("header index %d name = %q; want %q", i, got, want)
- }
- if got, want := staticTable[i-1].Value, m[3]; got != want {
- t.Errorf("header index %d value = %q; want %q", i, got, want)
- }
- }
- if err := bs.Err(); err != nil {
- t.Error(err)
- }
-}
-
-func (d *Decoder) mustAt(idx int) HeaderField {
- if hf, ok := d.at(uint64(idx)); !ok {
- panic(fmt.Sprintf("bogus index %d", idx))
- } else {
- return hf
- }
-}
-
-func TestDynamicTableAt(t *testing.T) {
- d := NewDecoder(4096, nil)
- at := d.mustAt
- if got, want := at(2), (pair(":method", "GET")); got != want {
- t.Errorf("at(2) = %v; want %v", got, want)
- }
- d.dynTab.add(pair("foo", "bar"))
- d.dynTab.add(pair("blake", "miz"))
- if got, want := at(len(staticTable)+1), (pair("blake", "miz")); got != want {
- t.Errorf("at(dyn 1) = %v; want %v", got, want)
- }
- if got, want := at(len(staticTable)+2), (pair("foo", "bar")); got != want {
- t.Errorf("at(dyn 2) = %v; want %v", got, want)
- }
- if got, want := at(3), (pair(":method", "POST")); got != want {
- t.Errorf("at(3) = %v; want %v", got, want)
- }
-}
-
-func TestDynamicTableSearch(t *testing.T) {
- dt := dynamicTable{}
- dt.setMaxSize(4096)
-
- dt.add(pair("foo", "bar"))
- dt.add(pair("blake", "miz"))
- dt.add(pair(":method", "GET"))
-
- tests := []struct {
- hf HeaderField
- wantI uint64
- wantMatch bool
- }{
- // Name and Value match
- {pair("foo", "bar"), 3, true},
- {pair(":method", "GET"), 1, true},
-
- // Only name match because of Sensitive == true
- {HeaderField{"blake", "miz", true}, 2, false},
-
- // Only Name matches
- {pair("foo", "..."), 3, false},
- {pair("blake", "..."), 2, false},
- {pair(":method", "..."), 1, false},
-
- // None match
- {pair("foo-", "bar"), 0, false},
- }
- for _, tt := range tests {
- if gotI, gotMatch := dt.search(tt.hf); gotI != tt.wantI || gotMatch != tt.wantMatch {
- t.Errorf("d.search(%+v) = %v, %v; want %v, %v", tt.hf, gotI, gotMatch, tt.wantI, tt.wantMatch)
- }
- }
-}
-
-func TestDynamicTableSizeEvict(t *testing.T) {
- d := NewDecoder(4096, nil)
- if want := uint32(0); d.dynTab.size != want {
- t.Fatalf("size = %d; want %d", d.dynTab.size, want)
- }
- add := d.dynTab.add
- add(pair("blake", "eats pizza"))
- if want := uint32(15 + 32); d.dynTab.size != want {
- t.Fatalf("after pizza, size = %d; want %d", d.dynTab.size, want)
- }
- add(pair("foo", "bar"))
- if want := uint32(15 + 32 + 6 + 32); d.dynTab.size != want {
- t.Fatalf("after foo bar, size = %d; want %d", d.dynTab.size, want)
- }
- d.dynTab.setMaxSize(15 + 32 + 1 /* slop */)
- if want := uint32(6 + 32); d.dynTab.size != want {
- t.Fatalf("after setMaxSize, size = %d; want %d", d.dynTab.size, want)
- }
- if got, want := d.mustAt(len(staticTable)+1), (pair("foo", "bar")); got != want {
- t.Errorf("at(dyn 1) = %v; want %v", got, want)
- }
- add(pair("long", strings.Repeat("x", 500)))
- if want := uint32(0); d.dynTab.size != want {
- t.Fatalf("after big one, size = %d; want %d", d.dynTab.size, want)
- }
-}
-
-func TestDecoderDecode(t *testing.T) {
- tests := []struct {
- name string
- in []byte
- want []HeaderField
- wantDynTab []HeaderField // newest entry first
- }{
- // C.2.1 Literal Header Field with Indexing
- // http://http2.github.io/http2-spec/compression.html#rfc.section.C.2.1
- {"C.2.1", dehex("400a 6375 7374 6f6d 2d6b 6579 0d63 7573 746f 6d2d 6865 6164 6572"),
- []HeaderField{pair("custom-key", "custom-header")},
- []HeaderField{pair("custom-key", "custom-header")},
- },
-
- // C.2.2 Literal Header Field without Indexing
- // http://http2.github.io/http2-spec/compression.html#rfc.section.C.2.2
- {"C.2.2", dehex("040c 2f73 616d 706c 652f 7061 7468"),
- []HeaderField{pair(":path", "/sample/path")},
- []HeaderField{}},
-
- // C.2.3 Literal Header Field never Indexed
- // http://http2.github.io/http2-spec/compression.html#rfc.section.C.2.3
- {"C.2.3", dehex("1008 7061 7373 776f 7264 0673 6563 7265 74"),
- []HeaderField{{"password", "secret", true}},
- []HeaderField{}},
-
- // C.2.4 Indexed Header Field
- // http://http2.github.io/http2-spec/compression.html#rfc.section.C.2.4
- {"C.2.4", []byte("\x82"),
- []HeaderField{pair(":method", "GET")},
- []HeaderField{}},
- }
- for _, tt := range tests {
- d := NewDecoder(4096, nil)
- hf, err := d.DecodeFull(tt.in)
- if err != nil {
- t.Errorf("%s: %v", tt.name, err)
- continue
- }
- if !reflect.DeepEqual(hf, tt.want) {
- t.Errorf("%s: Got %v; want %v", tt.name, hf, tt.want)
- }
- gotDynTab := d.dynTab.reverseCopy()
- if !reflect.DeepEqual(gotDynTab, tt.wantDynTab) {
- t.Errorf("%s: dynamic table after = %v; want %v", tt.name, gotDynTab, tt.wantDynTab)
- }
- }
-}
-
-func (dt *dynamicTable) reverseCopy() (hf []HeaderField) {
- hf = make([]HeaderField, len(dt.ents))
- for i := range hf {
- hf[i] = dt.ents[len(dt.ents)-1-i]
- }
- return
-}
-
-type encAndWant struct {
- enc []byte
- want []HeaderField
- wantDynTab []HeaderField
- wantDynSize uint32
-}
-
-// C.3 Request Examples without Huffman Coding
-// http://http2.github.io/http2-spec/compression.html#rfc.section.C.3
-func TestDecodeC3_NoHuffman(t *testing.T) {
- testDecodeSeries(t, 4096, []encAndWant{
- {dehex("8286 8441 0f77 7777 2e65 7861 6d70 6c65 2e63 6f6d"),
- []HeaderField{
- pair(":method", "GET"),
- pair(":scheme", "http"),
- pair(":path", "/"),
- pair(":authority", "www.example.com"),
- },
- []HeaderField{
- pair(":authority", "www.example.com"),
- },
- 57,
- },
- {dehex("8286 84be 5808 6e6f 2d63 6163 6865"),
- []HeaderField{
- pair(":method", "GET"),
- pair(":scheme", "http"),
- pair(":path", "/"),
- pair(":authority", "www.example.com"),
- pair("cache-control", "no-cache"),
- },
- []HeaderField{
- pair("cache-control", "no-cache"),
- pair(":authority", "www.example.com"),
- },
- 110,
- },
- {dehex("8287 85bf 400a 6375 7374 6f6d 2d6b 6579 0c63 7573 746f 6d2d 7661 6c75 65"),
- []HeaderField{
- pair(":method", "GET"),
- pair(":scheme", "https"),
- pair(":path", "/index.html"),
- pair(":authority", "www.example.com"),
- pair("custom-key", "custom-value"),
- },
- []HeaderField{
- pair("custom-key", "custom-value"),
- pair("cache-control", "no-cache"),
- pair(":authority", "www.example.com"),
- },
- 164,
- },
- })
-}
-
-// C.4 Request Examples with Huffman Coding
-// http://http2.github.io/http2-spec/compression.html#rfc.section.C.4
-func TestDecodeC4_Huffman(t *testing.T) {
- testDecodeSeries(t, 4096, []encAndWant{
- {dehex("8286 8441 8cf1 e3c2 e5f2 3a6b a0ab 90f4 ff"),
- []HeaderField{
- pair(":method", "GET"),
- pair(":scheme", "http"),
- pair(":path", "/"),
- pair(":authority", "www.example.com"),
- },
- []HeaderField{
- pair(":authority", "www.example.com"),
- },
- 57,
- },
- {dehex("8286 84be 5886 a8eb 1064 9cbf"),
- []HeaderField{
- pair(":method", "GET"),
- pair(":scheme", "http"),
- pair(":path", "/"),
- pair(":authority", "www.example.com"),
- pair("cache-control", "no-cache"),
- },
- []HeaderField{
- pair("cache-control", "no-cache"),
- pair(":authority", "www.example.com"),
- },
- 110,
- },
- {dehex("8287 85bf 4088 25a8 49e9 5ba9 7d7f 8925 a849 e95b b8e8 b4bf"),
- []HeaderField{
- pair(":method", "GET"),
- pair(":scheme", "https"),
- pair(":path", "/index.html"),
- pair(":authority", "www.example.com"),
- pair("custom-key", "custom-value"),
- },
- []HeaderField{
- pair("custom-key", "custom-value"),
- pair("cache-control", "no-cache"),
- pair(":authority", "www.example.com"),
- },
- 164,
- },
- })
-}
-
-// http://http2.github.io/http2-spec/compression.html#rfc.section.C.5
-// "This section shows several consecutive header lists, corresponding
-// to HTTP responses, on the same connection. The HTTP/2 setting
-// parameter SETTINGS_HEADER_TABLE_SIZE is set to the value of 256
-// octets, causing some evictions to occur."
-func TestDecodeC5_ResponsesNoHuff(t *testing.T) {
- testDecodeSeries(t, 256, []encAndWant{
- {dehex(`
-4803 3330 3258 0770 7269 7661 7465 611d
-4d6f 6e2c 2032 3120 4f63 7420 3230 3133
-2032 303a 3133 3a32 3120 474d 546e 1768
-7474 7073 3a2f 2f77 7777 2e65 7861 6d70
-6c65 2e63 6f6d
-`),
- []HeaderField{
- pair(":status", "302"),
- pair("cache-control", "private"),
- pair("date", "Mon, 21 Oct 2013 20:13:21 GMT"),
- pair("location", "https://www.example.com"),
- },
- []HeaderField{
- pair("location", "https://www.example.com"),
- pair("date", "Mon, 21 Oct 2013 20:13:21 GMT"),
- pair("cache-control", "private"),
- pair(":status", "302"),
- },
- 222,
- },
- {dehex("4803 3330 37c1 c0bf"),
- []HeaderField{
- pair(":status", "307"),
- pair("cache-control", "private"),
- pair("date", "Mon, 21 Oct 2013 20:13:21 GMT"),
- pair("location", "https://www.example.com"),
- },
- []HeaderField{
- pair(":status", "307"),
- pair("location", "https://www.example.com"),
- pair("date", "Mon, 21 Oct 2013 20:13:21 GMT"),
- pair("cache-control", "private"),
- },
- 222,
- },
- {dehex(`
-88c1 611d 4d6f 6e2c 2032 3120 4f63 7420
-3230 3133 2032 303a 3133 3a32 3220 474d
-54c0 5a04 677a 6970 7738 666f 6f3d 4153
-444a 4b48 514b 425a 584f 5157 454f 5049
-5541 5851 5745 4f49 553b 206d 6178 2d61
-6765 3d33 3630 303b 2076 6572 7369 6f6e
-3d31
-`),
- []HeaderField{
- pair(":status", "200"),
- pair("cache-control", "private"),
- pair("date", "Mon, 21 Oct 2013 20:13:22 GMT"),
- pair("location", "https://www.example.com"),
- pair("content-encoding", "gzip"),
- pair("set-cookie", "foo=ASDJKHQKBZXOQWEOPIUAXQWEOIU; max-age=3600; version=1"),
- },
- []HeaderField{
- pair("set-cookie", "foo=ASDJKHQKBZXOQWEOPIUAXQWEOIU; max-age=3600; version=1"),
- pair("content-encoding", "gzip"),
- pair("date", "Mon, 21 Oct 2013 20:13:22 GMT"),
- },
- 215,
- },
- })
-}
-
-// http://http2.github.io/http2-spec/compression.html#rfc.section.C.6
-// "This section shows the same examples as the previous section, but
-// using Huffman encoding for the literal values. The HTTP/2 setting
-// parameter SETTINGS_HEADER_TABLE_SIZE is set to the value of 256
-// octets, causing some evictions to occur. The eviction mechanism
-// uses the length of the decoded literal values, so the same
-// evictions occurs as in the previous section."
-func TestDecodeC6_ResponsesHuffman(t *testing.T) {
- testDecodeSeries(t, 256, []encAndWant{
- {dehex(`
-4882 6402 5885 aec3 771a 4b61 96d0 7abe
-9410 54d4 44a8 2005 9504 0b81 66e0 82a6
-2d1b ff6e 919d 29ad 1718 63c7 8f0b 97c8
-e9ae 82ae 43d3
-`),
- []HeaderField{
- pair(":status", "302"),
- pair("cache-control", "private"),
- pair("date", "Mon, 21 Oct 2013 20:13:21 GMT"),
- pair("location", "https://www.example.com"),
- },
- []HeaderField{
- pair("location", "https://www.example.com"),
- pair("date", "Mon, 21 Oct 2013 20:13:21 GMT"),
- pair("cache-control", "private"),
- pair(":status", "302"),
- },
- 222,
- },
- {dehex("4883 640e ffc1 c0bf"),
- []HeaderField{
- pair(":status", "307"),
- pair("cache-control", "private"),
- pair("date", "Mon, 21 Oct 2013 20:13:21 GMT"),
- pair("location", "https://www.example.com"),
- },
- []HeaderField{
- pair(":status", "307"),
- pair("location", "https://www.example.com"),
- pair("date", "Mon, 21 Oct 2013 20:13:21 GMT"),
- pair("cache-control", "private"),
- },
- 222,
- },
- {dehex(`
-88c1 6196 d07a be94 1054 d444 a820 0595
-040b 8166 e084 a62d 1bff c05a 839b d9ab
-77ad 94e7 821d d7f2 e6c7 b335 dfdf cd5b
-3960 d5af 2708 7f36 72c1 ab27 0fb5 291f
-9587 3160 65c0 03ed 4ee5 b106 3d50 07
-`),
- []HeaderField{
- pair(":status", "200"),
- pair("cache-control", "private"),
- pair("date", "Mon, 21 Oct 2013 20:13:22 GMT"),
- pair("location", "https://www.example.com"),
- pair("content-encoding", "gzip"),
- pair("set-cookie", "foo=ASDJKHQKBZXOQWEOPIUAXQWEOIU; max-age=3600; version=1"),
- },
- []HeaderField{
- pair("set-cookie", "foo=ASDJKHQKBZXOQWEOPIUAXQWEOIU; max-age=3600; version=1"),
- pair("content-encoding", "gzip"),
- pair("date", "Mon, 21 Oct 2013 20:13:22 GMT"),
- },
- 215,
- },
- })
-}
-
-func testDecodeSeries(t *testing.T, size uint32, steps []encAndWant) {
- d := NewDecoder(size, nil)
- for i, step := range steps {
- hf, err := d.DecodeFull(step.enc)
- if err != nil {
- t.Fatalf("Error at step index %d: %v", i, err)
- }
- if !reflect.DeepEqual(hf, step.want) {
- t.Fatalf("At step index %d: Got headers %v; want %v", i, hf, step.want)
- }
- gotDynTab := d.dynTab.reverseCopy()
- if !reflect.DeepEqual(gotDynTab, step.wantDynTab) {
- t.Errorf("After step index %d, dynamic table = %v; want %v", i, gotDynTab, step.wantDynTab)
- }
- if d.dynTab.size != step.wantDynSize {
- t.Errorf("After step index %d, dynamic table size = %v; want %v", i, d.dynTab.size, step.wantDynSize)
- }
- }
-}
-
-func TestHuffmanDecode(t *testing.T) {
- tests := []struct {
- inHex, want string
- }{
- {"f1e3 c2e5 f23a 6ba0 ab90 f4ff", "www.example.com"},
- {"a8eb 1064 9cbf", "no-cache"},
- {"25a8 49e9 5ba9 7d7f", "custom-key"},
- {"25a8 49e9 5bb8 e8b4 bf", "custom-value"},
- {"6402", "302"},
- {"aec3 771a 4b", "private"},
- {"d07a be94 1054 d444 a820 0595 040b 8166 e082 a62d 1bff", "Mon, 21 Oct 2013 20:13:21 GMT"},
- {"9d29 ad17 1863 c78f 0b97 c8e9 ae82 ae43 d3", "https://www.example.com"},
- {"9bd9 ab", "gzip"},
- {"94e7 821d d7f2 e6c7 b335 dfdf cd5b 3960 d5af 2708 7f36 72c1 ab27 0fb5 291f 9587 3160 65c0 03ed 4ee5 b106 3d50 07",
- "foo=ASDJKHQKBZXOQWEOPIUAXQWEOIU; max-age=3600; version=1"},
- }
- for i, tt := range tests {
- var buf bytes.Buffer
- in, err := hex.DecodeString(strings.Replace(tt.inHex, " ", "", -1))
- if err != nil {
- t.Errorf("%d. hex input error: %v", i, err)
- continue
- }
- if _, err := HuffmanDecode(&buf, in); err != nil {
- t.Errorf("%d. decode error: %v", i, err)
- continue
- }
- if got := buf.String(); tt.want != got {
- t.Errorf("%d. decode = %q; want %q", i, got, tt.want)
- }
- }
-}
-
-func TestAppendHuffmanString(t *testing.T) {
- tests := []struct {
- in, want string
- }{
- {"www.example.com", "f1e3 c2e5 f23a 6ba0 ab90 f4ff"},
- {"no-cache", "a8eb 1064 9cbf"},
- {"custom-key", "25a8 49e9 5ba9 7d7f"},
- {"custom-value", "25a8 49e9 5bb8 e8b4 bf"},
- {"302", "6402"},
- {"private", "aec3 771a 4b"},
- {"Mon, 21 Oct 2013 20:13:21 GMT", "d07a be94 1054 d444 a820 0595 040b 8166 e082 a62d 1bff"},
- {"https://www.example.com", "9d29 ad17 1863 c78f 0b97 c8e9 ae82 ae43 d3"},
- {"gzip", "9bd9 ab"},
- {"foo=ASDJKHQKBZXOQWEOPIUAXQWEOIU; max-age=3600; version=1",
- "94e7 821d d7f2 e6c7 b335 dfdf cd5b 3960 d5af 2708 7f36 72c1 ab27 0fb5 291f 9587 3160 65c0 03ed 4ee5 b106 3d50 07"},
- }
- for i, tt := range tests {
- buf := []byte{}
- want := strings.Replace(tt.want, " ", "", -1)
- buf = AppendHuffmanString(buf, tt.in)
- if got := hex.EncodeToString(buf); want != got {
- t.Errorf("%d. encode = %q; want %q", i, got, want)
- }
- }
-}
-
-func TestReadVarInt(t *testing.T) {
- type res struct {
- i uint64
- consumed int
- err error
- }
- tests := []struct {
- n byte
- p []byte
- want res
- }{
- // Fits in a byte:
- {1, []byte{0}, res{0, 1, nil}},
- {2, []byte{2}, res{2, 1, nil}},
- {3, []byte{6}, res{6, 1, nil}},
- {4, []byte{14}, res{14, 1, nil}},
- {5, []byte{30}, res{30, 1, nil}},
- {6, []byte{62}, res{62, 1, nil}},
- {7, []byte{126}, res{126, 1, nil}},
- {8, []byte{254}, res{254, 1, nil}},
-
- // Doesn't fit in a byte:
- {1, []byte{1}, res{0, 0, errNeedMore}},
- {2, []byte{3}, res{0, 0, errNeedMore}},
- {3, []byte{7}, res{0, 0, errNeedMore}},
- {4, []byte{15}, res{0, 0, errNeedMore}},
- {5, []byte{31}, res{0, 0, errNeedMore}},
- {6, []byte{63}, res{0, 0, errNeedMore}},
- {7, []byte{127}, res{0, 0, errNeedMore}},
- {8, []byte{255}, res{0, 0, errNeedMore}},
-
- // Ignoring top bits:
- {5, []byte{255, 154, 10}, res{1337, 3, nil}}, // high dummy three bits: 111
- {5, []byte{159, 154, 10}, res{1337, 3, nil}}, // high dummy three bits: 100
- {5, []byte{191, 154, 10}, res{1337, 3, nil}}, // high dummy three bits: 101
-
- // Extra byte:
- {5, []byte{191, 154, 10, 2}, res{1337, 3, nil}}, // extra byte
-
- // Short a byte:
- {5, []byte{191, 154}, res{0, 0, errNeedMore}},
-
- // integer overflow:
- {1, []byte{255, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128}, res{0, 0, errVarintOverflow}},
- }
- for _, tt := range tests {
- i, remain, err := readVarInt(tt.n, tt.p)
- consumed := len(tt.p) - len(remain)
- got := res{i, consumed, err}
- if got != tt.want {
- t.Errorf("readVarInt(%d, %v ~ %x) = %+v; want %+v", tt.n, tt.p, tt.p, got, tt.want)
- }
- }
-}
-
-func dehex(s string) []byte {
- s = strings.Replace(s, " ", "", -1)
- s = strings.Replace(s, "\n", "", -1)
- b, err := hex.DecodeString(s)
- if err != nil {
- panic(err)
- }
- return b
-}
diff --git a/vendor/github.com/bradfitz/http2/http2_test.go b/vendor/github.com/bradfitz/http2/http2_test.go
deleted file mode 100644
index 6a1b7e83..00000000
--- a/vendor/github.com/bradfitz/http2/http2_test.go
+++ /dev/null
@@ -1,152 +0,0 @@
-// Copyright 2014 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-// See https://code.google.com/p/go/source/browse/CONTRIBUTORS
-// Licensed under the same terms as Go itself:
-// https://code.google.com/p/go/source/browse/LICENSE
-
-package http2
-
-import (
- "bytes"
- "errors"
- "flag"
- "fmt"
- "net/http"
- "os/exec"
- "strconv"
- "strings"
- "testing"
-
- "github.com/bradfitz/http2/hpack"
-)
-
-var knownFailing = flag.Bool("known_failing", false, "Run known-failing tests.")
-
-func condSkipFailingTest(t *testing.T) {
- if !*knownFailing {
- t.Skip("Skipping known-failing test without --known_failing")
- }
-}
-
-func init() {
- DebugGoroutines = true
- flag.BoolVar(&VerboseLogs, "verboseh2", false, "Verbose HTTP/2 debug logging")
-}
-
-func TestSettingString(t *testing.T) {
- tests := []struct {
- s Setting
- want string
- }{
- {Setting{SettingMaxFrameSize, 123}, "[MAX_FRAME_SIZE = 123]"},
- {Setting{1<<16 - 1, 123}, "[UNKNOWN_SETTING_65535 = 123]"},
- }
- for i, tt := range tests {
- got := fmt.Sprint(tt.s)
- if got != tt.want {
- t.Errorf("%d. for %#v, string = %q; want %q", i, tt.s, got, tt.want)
- }
- }
-}
-
-type twriter struct {
- t testing.TB
- st *serverTester // optional
-}
-
-func (w twriter) Write(p []byte) (n int, err error) {
- if w.st != nil {
- ps := string(p)
- for _, phrase := range w.st.logFilter {
- if strings.Contains(ps, phrase) {
- return len(p), nil // no logging
- }
- }
- }
- w.t.Logf("%s", p)
- return len(p), nil
-}
-
-// like encodeHeader, but don't add implicit psuedo headers.
-func encodeHeaderNoImplicit(t *testing.T, headers ...string) []byte {
- var buf bytes.Buffer
- enc := hpack.NewEncoder(&buf)
- for len(headers) > 0 {
- k, v := headers[0], headers[1]
- headers = headers[2:]
- if err := enc.WriteField(hpack.HeaderField{Name: k, Value: v}); err != nil {
- t.Fatalf("HPACK encoding error for %q/%q: %v", k, v, err)
- }
- }
- return buf.Bytes()
-}
-
-// Verify that curl has http2.
-func requireCurl(t *testing.T) {
- out, err := dockerLogs(curl(t, "--version"))
- if err != nil {
- t.Skipf("failed to determine curl features; skipping test")
- }
- if !strings.Contains(string(out), "HTTP2") {
- t.Skip("curl doesn't support HTTP2; skipping test")
- }
-}
-
-func curl(t *testing.T, args ...string) (container string) {
- out, err := exec.Command("docker", append([]string{"run", "-d", "--net=host", "gohttp2/curl"}, args...)...).CombinedOutput()
- if err != nil {
- t.Skipf("Failed to run curl in docker: %v, %s", err, out)
- }
- return strings.TrimSpace(string(out))
-}
-
-type puppetCommand struct {
- fn func(w http.ResponseWriter, r *http.Request)
- done chan<- bool
-}
-
-type handlerPuppet struct {
- ch chan puppetCommand
-}
-
-func newHandlerPuppet() *handlerPuppet {
- return &handlerPuppet{
- ch: make(chan puppetCommand),
- }
-}
-
-func (p *handlerPuppet) act(w http.ResponseWriter, r *http.Request) {
- for cmd := range p.ch {
- cmd.fn(w, r)
- cmd.done <- true
- }
-}
-
-func (p *handlerPuppet) done() { close(p.ch) }
-func (p *handlerPuppet) do(fn func(http.ResponseWriter, *http.Request)) {
- done := make(chan bool)
- p.ch <- puppetCommand{fn, done}
- <-done
-}
-func dockerLogs(container string) ([]byte, error) {
- out, err := exec.Command("docker", "wait", container).CombinedOutput()
- if err != nil {
- return out, err
- }
- exitStatus, err := strconv.Atoi(strings.TrimSpace(string(out)))
- if err != nil {
- return out, errors.New("unexpected exit status from docker wait")
- }
- out, err = exec.Command("docker", "logs", container).CombinedOutput()
- exec.Command("docker", "rm", container).Run()
- if err == nil && exitStatus != 0 {
- err = fmt.Errorf("exit status %d: %s", exitStatus, out)
- }
- return out, err
-}
-
-func kill(container string) {
- exec.Command("docker", "kill", container).Run()
- exec.Command("docker", "rm", container).Run()
-}
diff --git a/vendor/github.com/bradfitz/http2/pipe_test.go b/vendor/github.com/bradfitz/http2/pipe_test.go
deleted file mode 100644
index 10c4c327..00000000
--- a/vendor/github.com/bradfitz/http2/pipe_test.go
+++ /dev/null
@@ -1,24 +0,0 @@
-// Copyright 2014 The Go Authors.
-// See https://code.google.com/p/go/source/browse/CONTRIBUTORS
-// Licensed under the same terms as Go itself:
-// https://code.google.com/p/go/source/browse/LICENSE
-
-package http2
-
-import (
- "errors"
- "testing"
-)
-
-func TestPipeClose(t *testing.T) {
- var p pipe
- p.c.L = &p.m
- a := errors.New("a")
- b := errors.New("b")
- p.Close(a)
- p.Close(b)
- _, err := p.Read(make([]byte, 1))
- if err != a {
- t.Errorf("err = %v want %v", err, a)
- }
-}
diff --git a/vendor/github.com/bradfitz/http2/priority_test.go b/vendor/github.com/bradfitz/http2/priority_test.go
deleted file mode 100644
index d9648fd3..00000000
--- a/vendor/github.com/bradfitz/http2/priority_test.go
+++ /dev/null
@@ -1,121 +0,0 @@
-// Copyright 2014 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-// See https://code.google.com/p/go/source/browse/CONTRIBUTORS
-// Licensed under the same terms as Go itself:
-// https://code.google.com/p/go/source/browse/LICENSE
-
-package http2
-
-import (
- "testing"
-)
-
-func TestPriority(t *testing.T) {
- // A -> B
- // move A's parent to B
- streams := make(map[uint32]*stream)
- a := &stream{
- parent: nil,
- weight: 16,
- }
- streams[1] = a
- b := &stream{
- parent: a,
- weight: 16,
- }
- streams[2] = b
- adjustStreamPriority(streams, 1, PriorityParam{
- Weight: 20,
- StreamDep: 2,
- })
- if a.parent != b {
- t.Errorf("Expected A's parent to be B")
- }
- if a.weight != 20 {
- t.Errorf("Expected A's weight to be 20; got %d", a.weight)
- }
- if b.parent != nil {
- t.Errorf("Expected B to have no parent")
- }
- if b.weight != 16 {
- t.Errorf("Expected B's weight to be 16; got %d", b.weight)
- }
-}
-
-func TestPriorityExclusiveZero(t *testing.T) {
- // A B and C are all children of the 0 stream.
- // Exclusive reprioritization to any of the streams
- // should bring the rest of the streams under the
- // reprioritized stream
- streams := make(map[uint32]*stream)
- a := &stream{
- parent: nil,
- weight: 16,
- }
- streams[1] = a
- b := &stream{
- parent: nil,
- weight: 16,
- }
- streams[2] = b
- c := &stream{
- parent: nil,
- weight: 16,
- }
- streams[3] = c
- adjustStreamPriority(streams, 3, PriorityParam{
- Weight: 20,
- StreamDep: 0,
- Exclusive: true,
- })
- if a.parent != c {
- t.Errorf("Expected A's parent to be C")
- }
- if a.weight != 16 {
- t.Errorf("Expected A's weight to be 16; got %d", a.weight)
- }
- if b.parent != c {
- t.Errorf("Expected B's parent to be C")
- }
- if b.weight != 16 {
- t.Errorf("Expected B's weight to be 16; got %d", b.weight)
- }
- if c.parent != nil {
- t.Errorf("Expected C to have no parent")
- }
- if c.weight != 20 {
- t.Errorf("Expected C's weight to be 20; got %d", b.weight)
- }
-}
-
-func TestPriorityOwnParent(t *testing.T) {
- streams := make(map[uint32]*stream)
- a := &stream{
- parent: nil,
- weight: 16,
- }
- streams[1] = a
- b := &stream{
- parent: a,
- weight: 16,
- }
- streams[2] = b
- adjustStreamPriority(streams, 1, PriorityParam{
- Weight: 20,
- StreamDep: 1,
- })
- if a.parent != nil {
- t.Errorf("Expected A's parent to be nil")
- }
- if a.weight != 20 {
- t.Errorf("Expected A's weight to be 20; got %d", a.weight)
- }
- if b.parent != a {
- t.Errorf("Expected B's parent to be A")
- }
- if b.weight != 16 {
- t.Errorf("Expected B's weight to be 16; got %d", b.weight)
- }
-
-}
diff --git a/vendor/github.com/bradfitz/http2/server_test.go b/vendor/github.com/bradfitz/http2/server_test.go
deleted file mode 100644
index 1133223b..00000000
--- a/vendor/github.com/bradfitz/http2/server_test.go
+++ /dev/null
@@ -1,2252 +0,0 @@
-// Copyright 2014 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-// See https://code.google.com/p/go/source/browse/CONTRIBUTORS
-// Licensed under the same terms as Go itself:
-// https://code.google.com/p/go/source/browse/LICENSE
-
-package http2
-
-import (
- "bytes"
- "crypto/tls"
- "errors"
- "flag"
- "fmt"
- "io"
- "io/ioutil"
- "log"
- "net"
- "net/http"
- "net/http/httptest"
- "os"
- "reflect"
- "runtime"
- "strconv"
- "strings"
- "sync"
- "sync/atomic"
- "testing"
- "time"
-
- "github.com/bradfitz/http2/hpack"
-)
-
-var stderrVerbose = flag.Bool("stderr_verbose", false, "Mirror verbosity to stderr, unbuffered")
-
-type serverTester struct {
- cc net.Conn // client conn
- t testing.TB
- ts *httptest.Server
- fr *Framer
- logBuf *bytes.Buffer
- logFilter []string // substrings to filter out
- scMu sync.Mutex // guards sc
- sc *serverConn
-
- // writing headers:
- headerBuf bytes.Buffer
- hpackEnc *hpack.Encoder
-
- // reading frames:
- frc chan Frame
- frErrc chan error
- readTimer *time.Timer
-}
-
-func init() {
- testHookOnPanicMu = new(sync.Mutex)
-}
-
-func resetHooks() {
- testHookOnPanicMu.Lock()
- testHookOnPanic = nil
- testHookOnPanicMu.Unlock()
-}
-
-type serverTesterOpt string
-
-var optOnlyServer = serverTesterOpt("only_server")
-
-func newServerTester(t testing.TB, handler http.HandlerFunc, opts ...interface{}) *serverTester {
- resetHooks()
-
- logBuf := new(bytes.Buffer)
- ts := httptest.NewUnstartedServer(handler)
-
- tlsConfig := &tls.Config{
- InsecureSkipVerify: true,
- // The h2-14 is temporary, until curl is updated. (as used by unit tests
- // in Docker)
- NextProtos: []string{NextProtoTLS, "h2-14"},
- }
-
- onlyServer := false
- for _, opt := range opts {
- switch v := opt.(type) {
- case func(*tls.Config):
- v(tlsConfig)
- case func(*httptest.Server):
- v(ts)
- case serverTesterOpt:
- onlyServer = (v == optOnlyServer)
- default:
- t.Fatalf("unknown newServerTester option type %T", v)
- }
- }
-
- ConfigureServer(ts.Config, &Server{})
-
- st := &serverTester{
- t: t,
- ts: ts,
- logBuf: logBuf,
- frc: make(chan Frame, 1),
- frErrc: make(chan error, 1),
- }
- st.hpackEnc = hpack.NewEncoder(&st.headerBuf)
-
- var stderrv io.Writer = ioutil.Discard
- if *stderrVerbose {
- stderrv = os.Stderr
- }
-
- ts.TLS = ts.Config.TLSConfig // the httptest.Server has its own copy of this TLS config
- ts.Config.ErrorLog = log.New(io.MultiWriter(stderrv, twriter{t: t, st: st}, logBuf), "", log.LstdFlags)
- ts.StartTLS()
-
- if VerboseLogs {
- t.Logf("Running test server at: %s", ts.URL)
- }
- testHookGetServerConn = func(v *serverConn) {
- st.scMu.Lock()
- defer st.scMu.Unlock()
- st.sc = v
- st.sc.testHookCh = make(chan func())
- }
- log.SetOutput(io.MultiWriter(stderrv, twriter{t: t, st: st}))
- if !onlyServer {
- cc, err := tls.Dial("tcp", ts.Listener.Addr().String(), tlsConfig)
- if err != nil {
- t.Fatal(err)
- }
- st.cc = cc
- st.fr = NewFramer(cc, cc)
- }
-
- return st
-}
-
-func (st *serverTester) closeConn() {
- st.scMu.Lock()
- defer st.scMu.Unlock()
- st.sc.conn.Close()
-}
-
-func (st *serverTester) addLogFilter(phrase string) {
- st.logFilter = append(st.logFilter, phrase)
-}
-
-func (st *serverTester) stream(id uint32) *stream {
- ch := make(chan *stream, 1)
- st.sc.testHookCh <- func() {
- ch <- st.sc.streams[id]
- }
- return <-ch
-}
-
-func (st *serverTester) streamState(id uint32) streamState {
- ch := make(chan streamState, 1)
- st.sc.testHookCh <- func() {
- state, _ := st.sc.state(id)
- ch <- state
- }
- return <-ch
-}
-
-func (st *serverTester) Close() {
- st.ts.Close()
- if st.cc != nil {
- st.cc.Close()
- }
- log.SetOutput(os.Stderr)
-}
-
-// greet initiates the client's HTTP/2 connection into a state where
-// frames may be sent.
-func (st *serverTester) greet() {
- st.writePreface()
- st.writeInitialSettings()
- st.wantSettings()
- st.writeSettingsAck()
- st.wantSettingsAck()
-}
-
-func (st *serverTester) writePreface() {
- n, err := st.cc.Write(clientPreface)
- if err != nil {
- st.t.Fatalf("Error writing client preface: %v", err)
- }
- if n != len(clientPreface) {
- st.t.Fatalf("Writing client preface, wrote %d bytes; want %d", n, len(clientPreface))
- }
-}
-
-func (st *serverTester) writeInitialSettings() {
- if err := st.fr.WriteSettings(); err != nil {
- st.t.Fatalf("Error writing initial SETTINGS frame from client to server: %v", err)
- }
-}
-
-func (st *serverTester) writeSettingsAck() {
- if err := st.fr.WriteSettingsAck(); err != nil {
- st.t.Fatalf("Error writing ACK of server's SETTINGS: %v", err)
- }
-}
-
-func (st *serverTester) writeHeaders(p HeadersFrameParam) {
- if err := st.fr.WriteHeaders(p); err != nil {
- st.t.Fatalf("Error writing HEADERS: %v", err)
- }
-}
-
-func (st *serverTester) encodeHeaderField(k, v string) {
- err := st.hpackEnc.WriteField(hpack.HeaderField{Name: k, Value: v})
- if err != nil {
- st.t.Fatalf("HPACK encoding error for %q/%q: %v", k, v, err)
- }
-}
-
-// encodeHeader encodes headers and returns their HPACK bytes. headers
-// must contain an even number of key/value pairs. There may be
-// multiple pairs for keys (e.g. "cookie"). The :method, :path, and
-// :scheme headers default to GET, / and https.
-func (st *serverTester) encodeHeader(headers ...string) []byte {
- if len(headers)%2 == 1 {
- panic("odd number of kv args")
- }
-
- st.headerBuf.Reset()
-
- if len(headers) == 0 {
- // Fast path, mostly for benchmarks, so test code doesn't pollute
- // profiles when we're looking to improve server allocations.
- st.encodeHeaderField(":method", "GET")
- st.encodeHeaderField(":path", "/")
- st.encodeHeaderField(":scheme", "https")
- return st.headerBuf.Bytes()
- }
-
- if len(headers) == 2 && headers[0] == ":method" {
- // Another fast path for benchmarks.
- st.encodeHeaderField(":method", headers[1])
- st.encodeHeaderField(":path", "/")
- st.encodeHeaderField(":scheme", "https")
- return st.headerBuf.Bytes()
- }
-
- pseudoCount := map[string]int{}
- keys := []string{":method", ":path", ":scheme"}
- vals := map[string][]string{
- ":method": {"GET"},
- ":path": {"/"},
- ":scheme": {"https"},
- }
- for len(headers) > 0 {
- k, v := headers[0], headers[1]
- headers = headers[2:]
- if _, ok := vals[k]; !ok {
- keys = append(keys, k)
- }
- if strings.HasPrefix(k, ":") {
- pseudoCount[k]++
- if pseudoCount[k] == 1 {
- vals[k] = []string{v}
- } else {
- // Allows testing of invalid headers w/ dup pseudo fields.
- vals[k] = append(vals[k], v)
- }
- } else {
- vals[k] = append(vals[k], v)
- }
- }
- st.headerBuf.Reset()
- for _, k := range keys {
- for _, v := range vals[k] {
- st.encodeHeaderField(k, v)
- }
- }
- return st.headerBuf.Bytes()
-}
-
-// bodylessReq1 writes a HEADERS frames with StreamID 1 and EndStream and EndHeaders set.
-func (st *serverTester) bodylessReq1(headers ...string) {
- st.writeHeaders(HeadersFrameParam{
- StreamID: 1, // clients send odd numbers
- BlockFragment: st.encodeHeader(headers...),
- EndStream: true,
- EndHeaders: true,
- })
-}
-
-func (st *serverTester) writeData(streamID uint32, endStream bool, data []byte) {
- if err := st.fr.WriteData(streamID, endStream, data); err != nil {
- st.t.Fatalf("Error writing DATA: %v", err)
- }
-}
-
-func (st *serverTester) readFrame() (Frame, error) {
- go func() {
- fr, err := st.fr.ReadFrame()
- if err != nil {
- st.frErrc <- err
- } else {
- st.frc <- fr
- }
- }()
- t := st.readTimer
- if t == nil {
- t = time.NewTimer(2 * time.Second)
- st.readTimer = t
- }
- t.Reset(2 * time.Second)
- defer t.Stop()
- select {
- case f := <-st.frc:
- return f, nil
- case err := <-st.frErrc:
- return nil, err
- case <-t.C:
- return nil, errors.New("timeout waiting for frame")
- }
-}
-
-func (st *serverTester) wantHeaders() *HeadersFrame {
- f, err := st.readFrame()
- if err != nil {
- st.t.Fatalf("Error while expecting a HEADERS frame: %v", err)
- }
- hf, ok := f.(*HeadersFrame)
- if !ok {
- st.t.Fatalf("got a %T; want *HeadersFrame", f)
- }
- return hf
-}
-
-func (st *serverTester) wantContinuation() *ContinuationFrame {
- f, err := st.readFrame()
- if err != nil {
- st.t.Fatalf("Error while expecting a CONTINUATION frame: %v", err)
- }
- cf, ok := f.(*ContinuationFrame)
- if !ok {
- st.t.Fatalf("got a %T; want *ContinuationFrame", f)
- }
- return cf
-}
-
-func (st *serverTester) wantData() *DataFrame {
- f, err := st.readFrame()
- if err != nil {
- st.t.Fatalf("Error while expecting a DATA frame: %v", err)
- }
- df, ok := f.(*DataFrame)
- if !ok {
- st.t.Fatalf("got a %T; want *DataFrame", f)
- }
- return df
-}
-
-func (st *serverTester) wantSettings() *SettingsFrame {
- f, err := st.readFrame()
- if err != nil {
- st.t.Fatalf("Error while expecting a SETTINGS frame: %v", err)
- }
- sf, ok := f.(*SettingsFrame)
- if !ok {
- st.t.Fatalf("got a %T; want *SettingsFrame", f)
- }
- return sf
-}
-
-func (st *serverTester) wantPing() *PingFrame {
- f, err := st.readFrame()
- if err != nil {
- st.t.Fatalf("Error while expecting a PING frame: %v", err)
- }
- pf, ok := f.(*PingFrame)
- if !ok {
- st.t.Fatalf("got a %T; want *PingFrame", f)
- }
- return pf
-}
-
-func (st *serverTester) wantGoAway() *GoAwayFrame {
- f, err := st.readFrame()
- if err != nil {
- st.t.Fatalf("Error while expecting a GOAWAY frame: %v", err)
- }
- gf, ok := f.(*GoAwayFrame)
- if !ok {
- st.t.Fatalf("got a %T; want *GoAwayFrame", f)
- }
- return gf
-}
-
-func (st *serverTester) wantRSTStream(streamID uint32, errCode ErrCode) {
- f, err := st.readFrame()
- if err != nil {
- st.t.Fatalf("Error while expecting an RSTStream frame: %v", err)
- }
- rs, ok := f.(*RSTStreamFrame)
- if !ok {
- st.t.Fatalf("got a %T; want *RSTStreamFrame", f)
- }
- if rs.FrameHeader.StreamID != streamID {
- st.t.Fatalf("RSTStream StreamID = %d; want %d", rs.FrameHeader.StreamID, streamID)
- }
- if rs.ErrCode != errCode {
- st.t.Fatalf("RSTStream ErrCode = %d (%s); want %d (%s)", rs.ErrCode, rs.ErrCode, errCode, errCode)
- }
-}
-
-func (st *serverTester) wantWindowUpdate(streamID, incr uint32) {
- f, err := st.readFrame()
- if err != nil {
- st.t.Fatalf("Error while expecting a WINDOW_UPDATE frame: %v", err)
- }
- wu, ok := f.(*WindowUpdateFrame)
- if !ok {
- st.t.Fatalf("got a %T; want *WindowUpdateFrame", f)
- }
- if wu.FrameHeader.StreamID != streamID {
- st.t.Fatalf("WindowUpdate StreamID = %d; want %d", wu.FrameHeader.StreamID, streamID)
- }
- if wu.Increment != incr {
- st.t.Fatalf("WindowUpdate increment = %d; want %d", wu.Increment, incr)
- }
-}
-
-func (st *serverTester) wantSettingsAck() {
- f, err := st.readFrame()
- if err != nil {
- st.t.Fatal(err)
- }
- sf, ok := f.(*SettingsFrame)
- if !ok {
- st.t.Fatalf("Wanting a settings ACK, received a %T", f)
- }
- if !sf.Header().Flags.Has(FlagSettingsAck) {
- st.t.Fatal("Settings Frame didn't have ACK set")
- }
-
-}
-
-func TestServer(t *testing.T) {
- gotReq := make(chan bool, 1)
- st := newServerTester(t, func(w http.ResponseWriter, r *http.Request) {
- w.Header().Set("Foo", "Bar")
- gotReq <- true
- })
- defer st.Close()
-
- covers("3.5", `
- The server connection preface consists of a potentially empty
- SETTINGS frame ([SETTINGS]) that MUST be the first frame the
- server sends in the HTTP/2 connection.
- `)
-
- st.writePreface()
- st.writeInitialSettings()
- st.wantSettings()
- st.writeSettingsAck()
- st.wantSettingsAck()
-
- st.writeHeaders(HeadersFrameParam{
- StreamID: 1, // clients send odd numbers
- BlockFragment: st.encodeHeader(),
- EndStream: true, // no DATA frames
- EndHeaders: true,
- })
-
- select {
- case <-gotReq:
- case <-time.After(2 * time.Second):
- t.Error("timeout waiting for request")
- }
-}
-
-func TestServer_Request_Get(t *testing.T) {
- testServerRequest(t, func(st *serverTester) {
- st.writeHeaders(HeadersFrameParam{
- StreamID: 1, // clients send odd numbers
- BlockFragment: st.encodeHeader("foo-bar", "some-value"),
- EndStream: true, // no DATA frames
- EndHeaders: true,
- })
- }, func(r *http.Request) {
- if r.Method != "GET" {
- t.Errorf("Method = %q; want GET", r.Method)
- }
- if r.URL.Path != "/" {
- t.Errorf("URL.Path = %q; want /", r.URL.Path)
- }
- if r.ContentLength != 0 {
- t.Errorf("ContentLength = %v; want 0", r.ContentLength)
- }
- if r.Close {
- t.Error("Close = true; want false")
- }
- if !strings.Contains(r.RemoteAddr, ":") {
- t.Errorf("RemoteAddr = %q; want something with a colon", r.RemoteAddr)
- }
- if r.Proto != "HTTP/2.0" || r.ProtoMajor != 2 || r.ProtoMinor != 0 {
- t.Errorf("Proto = %q Major=%v,Minor=%v; want HTTP/2.0", r.Proto, r.ProtoMajor, r.ProtoMinor)
- }
- wantHeader := http.Header{
- "Foo-Bar": []string{"some-value"},
- }
- if !reflect.DeepEqual(r.Header, wantHeader) {
- t.Errorf("Header = %#v; want %#v", r.Header, wantHeader)
- }
- if n, err := r.Body.Read([]byte(" ")); err != io.EOF || n != 0 {
- t.Errorf("Read = %d, %v; want 0, EOF", n, err)
- }
- })
-}
-
-func TestServer_Request_Get_PathSlashes(t *testing.T) {
- testServerRequest(t, func(st *serverTester) {
- st.writeHeaders(HeadersFrameParam{
- StreamID: 1, // clients send odd numbers
- BlockFragment: st.encodeHeader(":path", "/%2f/"),
- EndStream: true, // no DATA frames
- EndHeaders: true,
- })
- }, func(r *http.Request) {
- if r.RequestURI != "/%2f/" {
- t.Errorf("RequestURI = %q; want /%%2f/", r.RequestURI)
- }
- if r.URL.Path != "///" {
- t.Errorf("URL.Path = %q; want ///", r.URL.Path)
- }
- })
-}
-
-// TODO: add a test with EndStream=true on the HEADERS but setting a
-// Content-Length anyway. Should we just omit it and force it to
-// zero?
-
-func TestServer_Request_Post_NoContentLength_EndStream(t *testing.T) {
- testServerRequest(t, func(st *serverTester) {
- st.writeHeaders(HeadersFrameParam{
- StreamID: 1, // clients send odd numbers
- BlockFragment: st.encodeHeader(":method", "POST"),
- EndStream: true,
- EndHeaders: true,
- })
- }, func(r *http.Request) {
- if r.Method != "POST" {
- t.Errorf("Method = %q; want POST", r.Method)
- }
- if r.ContentLength != 0 {
- t.Errorf("ContentLength = %v; want 0", r.ContentLength)
- }
- if n, err := r.Body.Read([]byte(" ")); err != io.EOF || n != 0 {
- t.Errorf("Read = %d, %v; want 0, EOF", n, err)
- }
- })
-}
-
-func TestServer_Request_Post_Body_ImmediateEOF(t *testing.T) {
- testBodyContents(t, -1, "", func(st *serverTester) {
- st.writeHeaders(HeadersFrameParam{
- StreamID: 1, // clients send odd numbers
- BlockFragment: st.encodeHeader(":method", "POST"),
- EndStream: false, // to say DATA frames are coming
- EndHeaders: true,
- })
- st.writeData(1, true, nil) // just kidding. empty body.
- })
-}
-
-func TestServer_Request_Post_Body_OneData(t *testing.T) {
- const content = "Some content"
- testBodyContents(t, -1, content, func(st *serverTester) {
- st.writeHeaders(HeadersFrameParam{
- StreamID: 1, // clients send odd numbers
- BlockFragment: st.encodeHeader(":method", "POST"),
- EndStream: false, // to say DATA frames are coming
- EndHeaders: true,
- })
- st.writeData(1, true, []byte(content))
- })
-}
-
-func TestServer_Request_Post_Body_TwoData(t *testing.T) {
- const content = "Some content"
- testBodyContents(t, -1, content, func(st *serverTester) {
- st.writeHeaders(HeadersFrameParam{
- StreamID: 1, // clients send odd numbers
- BlockFragment: st.encodeHeader(":method", "POST"),
- EndStream: false, // to say DATA frames are coming
- EndHeaders: true,
- })
- st.writeData(1, false, []byte(content[:5]))
- st.writeData(1, true, []byte(content[5:]))
- })
-}
-
-func TestServer_Request_Post_Body_ContentLength_Correct(t *testing.T) {
- const content = "Some content"
- testBodyContents(t, int64(len(content)), content, func(st *serverTester) {
- st.writeHeaders(HeadersFrameParam{
- StreamID: 1, // clients send odd numbers
- BlockFragment: st.encodeHeader(
- ":method", "POST",
- "content-length", strconv.Itoa(len(content)),
- ),
- EndStream: false, // to say DATA frames are coming
- EndHeaders: true,
- })
- st.writeData(1, true, []byte(content))
- })
-}
-
-func TestServer_Request_Post_Body_ContentLength_TooLarge(t *testing.T) {
- testBodyContentsFail(t, 3, "request declared a Content-Length of 3 but only wrote 2 bytes",
- func(st *serverTester) {
- st.writeHeaders(HeadersFrameParam{
- StreamID: 1, // clients send odd numbers
- BlockFragment: st.encodeHeader(
- ":method", "POST",
- "content-length", "3",
- ),
- EndStream: false, // to say DATA frames are coming
- EndHeaders: true,
- })
- st.writeData(1, true, []byte("12"))
- })
-}
-
-func TestServer_Request_Post_Body_ContentLength_TooSmall(t *testing.T) {
- testBodyContentsFail(t, 4, "sender tried to send more than declared Content-Length of 4 bytes",
- func(st *serverTester) {
- st.writeHeaders(HeadersFrameParam{
- StreamID: 1, // clients send odd numbers
- BlockFragment: st.encodeHeader(
- ":method", "POST",
- "content-length", "4",
- ),
- EndStream: false, // to say DATA frames are coming
- EndHeaders: true,
- })
- st.writeData(1, true, []byte("12345"))
- })
-}
-
-func testBodyContents(t *testing.T, wantContentLength int64, wantBody string, write func(st *serverTester)) {
- testServerRequest(t, write, func(r *http.Request) {
- if r.Method != "POST" {
- t.Errorf("Method = %q; want POST", r.Method)
- }
- if r.ContentLength != wantContentLength {
- t.Errorf("ContentLength = %v; want %d", r.ContentLength, wantContentLength)
- }
- all, err := ioutil.ReadAll(r.Body)
- if err != nil {
- t.Fatal(err)
- }
- if string(all) != wantBody {
- t.Errorf("Read = %q; want %q", all, wantBody)
- }
- if err := r.Body.Close(); err != nil {
- t.Fatalf("Close: %v", err)
- }
- })
-}
-
-func testBodyContentsFail(t *testing.T, wantContentLength int64, wantReadError string, write func(st *serverTester)) {
- testServerRequest(t, write, func(r *http.Request) {
- if r.Method != "POST" {
- t.Errorf("Method = %q; want POST", r.Method)
- }
- if r.ContentLength != wantContentLength {
- t.Errorf("ContentLength = %v; want %d", r.ContentLength, wantContentLength)
- }
- all, err := ioutil.ReadAll(r.Body)
- if err == nil {
- t.Fatalf("expected an error (%q) reading from the body. Successfully read %q instead.",
- wantReadError, all)
- }
- if !strings.Contains(err.Error(), wantReadError) {
- t.Fatalf("Body.Read = %v; want substring %q", err, wantReadError)
- }
- if err := r.Body.Close(); err != nil {
- t.Fatalf("Close: %v", err)
- }
- })
-}
-
-// Using a Host header, instead of :authority
-func TestServer_Request_Get_Host(t *testing.T) {
- const host = "example.com"
- testServerRequest(t, func(st *serverTester) {
- st.writeHeaders(HeadersFrameParam{
- StreamID: 1, // clients send odd numbers
- BlockFragment: st.encodeHeader("host", host),
- EndStream: true,
- EndHeaders: true,
- })
- }, func(r *http.Request) {
- if r.Host != host {
- t.Errorf("Host = %q; want %q", r.Host, host)
- }
- })
-}
-
-// Using an :authority pseudo-header, instead of Host
-func TestServer_Request_Get_Authority(t *testing.T) {
- const host = "example.com"
- testServerRequest(t, func(st *serverTester) {
- st.writeHeaders(HeadersFrameParam{
- StreamID: 1, // clients send odd numbers
- BlockFragment: st.encodeHeader(":authority", host),
- EndStream: true,
- EndHeaders: true,
- })
- }, func(r *http.Request) {
- if r.Host != host {
- t.Errorf("Host = %q; want %q", r.Host, host)
- }
- })
-}
-
-func TestServer_Request_WithContinuation(t *testing.T) {
- wantHeader := http.Header{
- "Foo-One": []string{"value-one"},
- "Foo-Two": []string{"value-two"},
- "Foo-Three": []string{"value-three"},
- }
- testServerRequest(t, func(st *serverTester) {
- fullHeaders := st.encodeHeader(
- "foo-one", "value-one",
- "foo-two", "value-two",
- "foo-three", "value-three",
- )
- remain := fullHeaders
- chunks := 0
- for len(remain) > 0 {
- const maxChunkSize = 5
- chunk := remain
- if len(chunk) > maxChunkSize {
- chunk = chunk[:maxChunkSize]
- }
- remain = remain[len(chunk):]
-
- if chunks == 0 {
- st.writeHeaders(HeadersFrameParam{
- StreamID: 1, // clients send odd numbers
- BlockFragment: chunk,
- EndStream: true, // no DATA frames
- EndHeaders: false, // we'll have continuation frames
- })
- } else {
- err := st.fr.WriteContinuation(1, len(remain) == 0, chunk)
- if err != nil {
- t.Fatal(err)
- }
- }
- chunks++
- }
- if chunks < 2 {
- t.Fatal("too few chunks")
- }
- }, func(r *http.Request) {
- if !reflect.DeepEqual(r.Header, wantHeader) {
- t.Errorf("Header = %#v; want %#v", r.Header, wantHeader)
- }
- })
-}
-
-// Concatenated cookie headers. ("8.1.2.5 Compressing the Cookie Header Field")
-func TestServer_Request_CookieConcat(t *testing.T) {
- const host = "example.com"
- testServerRequest(t, func(st *serverTester) {
- st.bodylessReq1(
- ":authority", host,
- "cookie", "a=b",
- "cookie", "c=d",
- "cookie", "e=f",
- )
- }, func(r *http.Request) {
- const want = "a=b; c=d; e=f"
- if got := r.Header.Get("Cookie"); got != want {
- t.Errorf("Cookie = %q; want %q", got, want)
- }
- })
-}
-
-func TestServer_Request_Reject_CapitalHeader(t *testing.T) {
- testRejectRequest(t, func(st *serverTester) { st.bodylessReq1("UPPER", "v") })
-}
-
-func TestServer_Request_Reject_Pseudo_Missing_method(t *testing.T) {
- testRejectRequest(t, func(st *serverTester) { st.bodylessReq1(":method", "") })
-}
-
-func TestServer_Request_Reject_Pseudo_ExactlyOne(t *testing.T) {
- // 8.1.2.3 Request Pseudo-Header Fields
- // "All HTTP/2 requests MUST include exactly one valid value" ...
- testRejectRequest(t, func(st *serverTester) {
- st.addLogFilter("duplicate pseudo-header")
- st.bodylessReq1(":method", "GET", ":method", "POST")
- })
-}
-
-func TestServer_Request_Reject_Pseudo_AfterRegular(t *testing.T) {
- // 8.1.2.3 Request Pseudo-Header Fields
- // "All pseudo-header fields MUST appear in the header block
- // before regular header fields. Any request or response that
- // contains a pseudo-header field that appears in a header
- // block after a regular header field MUST be treated as
- // malformed (Section 8.1.2.6)."
- testRejectRequest(t, func(st *serverTester) {
- st.addLogFilter("pseudo-header after regular header")
- var buf bytes.Buffer
- enc := hpack.NewEncoder(&buf)
- enc.WriteField(hpack.HeaderField{Name: ":method", Value: "GET"})
- enc.WriteField(hpack.HeaderField{Name: "regular", Value: "foobar"})
- enc.WriteField(hpack.HeaderField{Name: ":path", Value: "/"})
- enc.WriteField(hpack.HeaderField{Name: ":scheme", Value: "https"})
- st.writeHeaders(HeadersFrameParam{
- StreamID: 1, // clients send odd numbers
- BlockFragment: buf.Bytes(),
- EndStream: true,
- EndHeaders: true,
- })
- })
-}
-
-func TestServer_Request_Reject_Pseudo_Missing_path(t *testing.T) {
- testRejectRequest(t, func(st *serverTester) { st.bodylessReq1(":path", "") })
-}
-
-func TestServer_Request_Reject_Pseudo_Missing_scheme(t *testing.T) {
- testRejectRequest(t, func(st *serverTester) { st.bodylessReq1(":scheme", "") })
-}
-
-func TestServer_Request_Reject_Pseudo_scheme_invalid(t *testing.T) {
- testRejectRequest(t, func(st *serverTester) { st.bodylessReq1(":scheme", "bogus") })
-}
-
-func TestServer_Request_Reject_Pseudo_Unknown(t *testing.T) {
- testRejectRequest(t, func(st *serverTester) {
- st.addLogFilter(`invalid pseudo-header ":unknown_thing"`)
- st.bodylessReq1(":unknown_thing", "")
- })
-}
-
-func testRejectRequest(t *testing.T, send func(*serverTester)) {
- st := newServerTester(t, func(w http.ResponseWriter, r *http.Request) {
- t.Fatal("server request made it to handler; should've been rejected")
- })
- defer st.Close()
-
- st.greet()
- send(st)
- st.wantRSTStream(1, ErrCodeProtocol)
-}
-
-func TestServer_Ping(t *testing.T) {
- st := newServerTester(t, nil)
- defer st.Close()
- st.greet()
-
- // Server should ignore this one, since it has ACK set.
- ackPingData := [8]byte{1, 2, 4, 8, 16, 32, 64, 128}
- if err := st.fr.WritePing(true, ackPingData); err != nil {
- t.Fatal(err)
- }
-
- // But the server should reply to this one, since ACK is false.
- pingData := [8]byte{1, 2, 3, 4, 5, 6, 7, 8}
- if err := st.fr.WritePing(false, pingData); err != nil {
- t.Fatal(err)
- }
-
- pf := st.wantPing()
- if !pf.Flags.Has(FlagPingAck) {
- t.Error("response ping doesn't have ACK set")
- }
- if pf.Data != pingData {
- t.Errorf("response ping has data %q; want %q", pf.Data, pingData)
- }
-}
-
-func TestServer_RejectsLargeFrames(t *testing.T) {
- st := newServerTester(t, nil)
- defer st.Close()
- st.greet()
-
- // Write too large of a frame (too large by one byte)
- // We ignore the return value because it's expected that the server
- // will only read the first 9 bytes (the headre) and then disconnect.
- st.fr.WriteRawFrame(0xff, 0, 0, make([]byte, defaultMaxReadFrameSize+1))
-
- gf := st.wantGoAway()
- if gf.ErrCode != ErrCodeFrameSize {
- t.Errorf("GOAWAY err = %v; want %v", gf.ErrCode, ErrCodeFrameSize)
- }
-}
-
-func TestServer_Handler_Sends_WindowUpdate(t *testing.T) {
- puppet := newHandlerPuppet()
- st := newServerTester(t, func(w http.ResponseWriter, r *http.Request) {
- puppet.act(w, r)
- })
- defer st.Close()
- defer puppet.done()
-
- st.greet()
-
- st.writeHeaders(HeadersFrameParam{
- StreamID: 1, // clients send odd numbers
- BlockFragment: st.encodeHeader(":method", "POST"),
- EndStream: false, // data coming
- EndHeaders: true,
- })
- st.writeData(1, false, []byte("abcdef"))
- puppet.do(readBodyHandler(t, "abc"))
- st.wantWindowUpdate(0, 3)
- st.wantWindowUpdate(1, 3)
-
- puppet.do(readBodyHandler(t, "def"))
- st.wantWindowUpdate(0, 3)
- st.wantWindowUpdate(1, 3)
-
- st.writeData(1, true, []byte("ghijkl")) // END_STREAM here
- puppet.do(readBodyHandler(t, "ghi"))
- puppet.do(readBodyHandler(t, "jkl"))
- st.wantWindowUpdate(0, 3)
- st.wantWindowUpdate(0, 3) // no more stream-level, since END_STREAM
-}
-
-func TestServer_Send_GoAway_After_Bogus_WindowUpdate(t *testing.T) {
- st := newServerTester(t, nil)
- defer st.Close()
- st.greet()
- if err := st.fr.WriteWindowUpdate(0, 1<<31-1); err != nil {
- t.Fatal(err)
- }
- gf := st.wantGoAway()
- if gf.ErrCode != ErrCodeFlowControl {
- t.Errorf("GOAWAY err = %v; want %v", gf.ErrCode, ErrCodeFlowControl)
- }
- if gf.LastStreamID != 0 {
- t.Errorf("GOAWAY last stream ID = %v; want %v", gf.LastStreamID, 0)
- }
-}
-
-func TestServer_Send_RstStream_After_Bogus_WindowUpdate(t *testing.T) {
- inHandler := make(chan bool)
- blockHandler := make(chan bool)
- st := newServerTester(t, func(w http.ResponseWriter, r *http.Request) {
- inHandler <- true
- <-blockHandler
- })
- defer st.Close()
- defer close(blockHandler)
- st.greet()
- st.writeHeaders(HeadersFrameParam{
- StreamID: 1,
- BlockFragment: st.encodeHeader(":method", "POST"),
- EndStream: false, // keep it open
- EndHeaders: true,
- })
- <-inHandler
- // Send a bogus window update:
- if err := st.fr.WriteWindowUpdate(1, 1<<31-1); err != nil {
- t.Fatal(err)
- }
- st.wantRSTStream(1, ErrCodeFlowControl)
-}
-
-// testServerPostUnblock sends a hanging POST with unsent data to handler,
-// then runs fn once in the handler, and verifies that the error returned from
-// handler is acceptable. It fails if takes over 5 seconds for handler to exit.
-func testServerPostUnblock(t *testing.T,
- handler func(http.ResponseWriter, *http.Request) error,
- fn func(*serverTester),
- checkErr func(error),
- otherHeaders ...string) {
- inHandler := make(chan bool)
- errc := make(chan error, 1)
- st := newServerTester(t, func(w http.ResponseWriter, r *http.Request) {
- inHandler <- true
- errc <- handler(w, r)
- })
- st.greet()
- st.writeHeaders(HeadersFrameParam{
- StreamID: 1,
- BlockFragment: st.encodeHeader(append([]string{":method", "POST"}, otherHeaders...)...),
- EndStream: false, // keep it open
- EndHeaders: true,
- })
- <-inHandler
- fn(st)
- select {
- case err := <-errc:
- if checkErr != nil {
- checkErr(err)
- }
- case <-time.After(5 * time.Second):
- t.Fatal("timeout waiting for Handler to return")
- }
- st.Close()
-}
-
-func TestServer_RSTStream_Unblocks_Read(t *testing.T) {
- testServerPostUnblock(t,
- func(w http.ResponseWriter, r *http.Request) (err error) {
- _, err = r.Body.Read(make([]byte, 1))
- return
- },
- func(st *serverTester) {
- if err := st.fr.WriteRSTStream(1, ErrCodeCancel); err != nil {
- t.Fatal(err)
- }
- },
- func(err error) {
- if err == nil {
- t.Error("unexpected nil error from Request.Body.Read")
- }
- },
- )
-}
-
-func TestServer_DeadConn_Unblocks_Read(t *testing.T) {
- testServerPostUnblock(t,
- func(w http.ResponseWriter, r *http.Request) (err error) {
- _, err = r.Body.Read(make([]byte, 1))
- return
- },
- func(st *serverTester) { st.cc.Close() },
- func(err error) {
- if err == nil {
- t.Error("unexpected nil error from Request.Body.Read")
- }
- },
- )
-}
-
-var blockUntilClosed = func(w http.ResponseWriter, r *http.Request) error {
- <-w.(http.CloseNotifier).CloseNotify()
- return nil
-}
-
-func TestServer_CloseNotify_After_RSTStream(t *testing.T) {
- testServerPostUnblock(t, blockUntilClosed, func(st *serverTester) {
- if err := st.fr.WriteRSTStream(1, ErrCodeCancel); err != nil {
- t.Fatal(err)
- }
- }, nil)
-}
-
-func TestServer_CloseNotify_After_ConnClose(t *testing.T) {
- testServerPostUnblock(t, blockUntilClosed, func(st *serverTester) { st.cc.Close() }, nil)
-}
-
-// that CloseNotify unblocks after a stream error due to the client's
-// problem that's unrelated to them explicitly canceling it (which is
-// TestServer_CloseNotify_After_RSTStream above)
-func TestServer_CloseNotify_After_StreamError(t *testing.T) {
- testServerPostUnblock(t, blockUntilClosed, func(st *serverTester) {
- // data longer than declared Content-Length => stream error
- st.writeData(1, true, []byte("1234"))
- }, nil, "content-length", "3")
-}
-
-func TestServer_StateTransitions(t *testing.T) {
- var st *serverTester
- inHandler := make(chan bool)
- writeData := make(chan bool)
- leaveHandler := make(chan bool)
- st = newServerTester(t, func(w http.ResponseWriter, r *http.Request) {
- inHandler <- true
- if st.stream(1) == nil {
- t.Errorf("nil stream 1 in handler")
- }
- if got, want := st.streamState(1), stateOpen; got != want {
- t.Errorf("in handler, state is %v; want %v", got, want)
- }
- writeData <- true
- if n, err := r.Body.Read(make([]byte, 1)); n != 0 || err != io.EOF {
- t.Errorf("body read = %d, %v; want 0, EOF", n, err)
- }
- if got, want := st.streamState(1), stateHalfClosedRemote; got != want {
- t.Errorf("in handler, state is %v; want %v", got, want)
- }
-
- <-leaveHandler
- })
- st.greet()
- if st.stream(1) != nil {
- t.Fatal("stream 1 should be empty")
- }
- if got := st.streamState(1); got != stateIdle {
- t.Fatalf("stream 1 should be idle; got %v", got)
- }
-
- st.writeHeaders(HeadersFrameParam{
- StreamID: 1,
- BlockFragment: st.encodeHeader(":method", "POST"),
- EndStream: false, // keep it open
- EndHeaders: true,
- })
- <-inHandler
- <-writeData
- st.writeData(1, true, nil)
-
- leaveHandler <- true
- hf := st.wantHeaders()
- if !hf.StreamEnded() {
- t.Fatal("expected END_STREAM flag")
- }
-
- if got, want := st.streamState(1), stateClosed; got != want {
- t.Errorf("at end, state is %v; want %v", got, want)
- }
- if st.stream(1) != nil {
- t.Fatal("at end, stream 1 should be gone")
- }
-}
-
-// test HEADERS w/o EndHeaders + another HEADERS (should get rejected)
-func TestServer_Rejects_HeadersNoEnd_Then_Headers(t *testing.T) {
- testServerRejects(t, func(st *serverTester) {
- st.writeHeaders(HeadersFrameParam{
- StreamID: 1,
- BlockFragment: st.encodeHeader(),
- EndStream: true,
- EndHeaders: false,
- })
- st.writeHeaders(HeadersFrameParam{ // Not a continuation.
- StreamID: 3, // different stream.
- BlockFragment: st.encodeHeader(),
- EndStream: true,
- EndHeaders: true,
- })
- })
-}
-
-// test HEADERS w/o EndHeaders + PING (should get rejected)
-func TestServer_Rejects_HeadersNoEnd_Then_Ping(t *testing.T) {
- testServerRejects(t, func(st *serverTester) {
- st.writeHeaders(HeadersFrameParam{
- StreamID: 1,
- BlockFragment: st.encodeHeader(),
- EndStream: true,
- EndHeaders: false,
- })
- if err := st.fr.WritePing(false, [8]byte{}); err != nil {
- t.Fatal(err)
- }
- })
-}
-
-// test HEADERS w/ EndHeaders + a continuation HEADERS (should get rejected)
-func TestServer_Rejects_HeadersEnd_Then_Continuation(t *testing.T) {
- testServerRejects(t, func(st *serverTester) {
- st.writeHeaders(HeadersFrameParam{
- StreamID: 1,
- BlockFragment: st.encodeHeader(),
- EndStream: true,
- EndHeaders: true,
- })
- st.wantHeaders()
- if err := st.fr.WriteContinuation(1, true, encodeHeaderNoImplicit(t, "foo", "bar")); err != nil {
- t.Fatal(err)
- }
- })
-}
-
-// test HEADERS w/o EndHeaders + a continuation HEADERS on wrong stream ID
-func TestServer_Rejects_HeadersNoEnd_Then_ContinuationWrongStream(t *testing.T) {
- testServerRejects(t, func(st *serverTester) {
- st.writeHeaders(HeadersFrameParam{
- StreamID: 1,
- BlockFragment: st.encodeHeader(),
- EndStream: true,
- EndHeaders: false,
- })
- if err := st.fr.WriteContinuation(3, true, encodeHeaderNoImplicit(t, "foo", "bar")); err != nil {
- t.Fatal(err)
- }
- })
-}
-
-// No HEADERS on stream 0.
-func TestServer_Rejects_Headers0(t *testing.T) {
- testServerRejects(t, func(st *serverTester) {
- st.fr.AllowIllegalWrites = true
- st.writeHeaders(HeadersFrameParam{
- StreamID: 0,
- BlockFragment: st.encodeHeader(),
- EndStream: true,
- EndHeaders: true,
- })
- })
-}
-
-// No CONTINUATION on stream 0.
-func TestServer_Rejects_Continuation0(t *testing.T) {
- testServerRejects(t, func(st *serverTester) {
- st.fr.AllowIllegalWrites = true
- if err := st.fr.WriteContinuation(0, true, st.encodeHeader()); err != nil {
- t.Fatal(err)
- }
- })
-}
-
-func TestServer_Rejects_PushPromise(t *testing.T) {
- testServerRejects(t, func(st *serverTester) {
- pp := PushPromiseParam{
- StreamID: 1,
- PromiseID: 3,
- }
- if err := st.fr.WritePushPromise(pp); err != nil {
- t.Fatal(err)
- }
- })
-}
-
-// testServerRejects tests that the server hangs up with a GOAWAY
-// frame and a server close after the client does something
-// deserving a CONNECTION_ERROR.
-func testServerRejects(t *testing.T, writeReq func(*serverTester)) {
- st := newServerTester(t, func(w http.ResponseWriter, r *http.Request) {})
- st.addLogFilter("connection error: PROTOCOL_ERROR")
- defer st.Close()
- st.greet()
- writeReq(st)
-
- st.wantGoAway()
- errc := make(chan error, 1)
- go func() {
- fr, err := st.fr.ReadFrame()
- if err == nil {
- err = fmt.Errorf("got frame of type %T", fr)
- }
- errc <- err
- }()
- select {
- case err := <-errc:
- if err != io.EOF {
- t.Errorf("ReadFrame = %v; want io.EOF", err)
- }
- case <-time.After(2 * time.Second):
- t.Error("timeout waiting for disconnect")
- }
-}
-
-// testServerRequest sets up an idle HTTP/2 connection and lets you
-// write a single request with writeReq, and then verify that the
-// *http.Request is built correctly in checkReq.
-func testServerRequest(t *testing.T, writeReq func(*serverTester), checkReq func(*http.Request)) {
- gotReq := make(chan bool, 1)
- st := newServerTester(t, func(w http.ResponseWriter, r *http.Request) {
- if r.Body == nil {
- t.Fatal("nil Body")
- }
- checkReq(r)
- gotReq <- true
- })
- defer st.Close()
-
- st.greet()
- writeReq(st)
-
- select {
- case <-gotReq:
- case <-time.After(2 * time.Second):
- t.Error("timeout waiting for request")
- }
-}
-
-func getSlash(st *serverTester) { st.bodylessReq1() }
-
-func TestServer_Response_NoData(t *testing.T) {
- testServerResponse(t, func(w http.ResponseWriter, r *http.Request) error {
- // Nothing.
- return nil
- }, func(st *serverTester) {
- getSlash(st)
- hf := st.wantHeaders()
- if !hf.StreamEnded() {
- t.Fatal("want END_STREAM flag")
- }
- if !hf.HeadersEnded() {
- t.Fatal("want END_HEADERS flag")
- }
- })
-}
-
-func TestServer_Response_NoData_Header_FooBar(t *testing.T) {
- testServerResponse(t, func(w http.ResponseWriter, r *http.Request) error {
- w.Header().Set("Foo-Bar", "some-value")
- return nil
- }, func(st *serverTester) {
- getSlash(st)
- hf := st.wantHeaders()
- if !hf.StreamEnded() {
- t.Fatal("want END_STREAM flag")
- }
- if !hf.HeadersEnded() {
- t.Fatal("want END_HEADERS flag")
- }
- goth := decodeHeader(t, hf.HeaderBlockFragment())
- wanth := [][2]string{
- {":status", "200"},
- {"foo-bar", "some-value"},
- {"content-type", "text/plain; charset=utf-8"},
- {"content-length", "0"},
- }
- if !reflect.DeepEqual(goth, wanth) {
- t.Errorf("Got headers %v; want %v", goth, wanth)
- }
- })
-}
-
-func TestServer_Response_Data_Sniff_DoesntOverride(t *testing.T) {
- const msg = "this is HTML."
- testServerResponse(t, func(w http.ResponseWriter, r *http.Request) error {
- w.Header().Set("Content-Type", "foo/bar")
- io.WriteString(w, msg)
- return nil
- }, func(st *serverTester) {
- getSlash(st)
- hf := st.wantHeaders()
- if hf.StreamEnded() {
- t.Fatal("don't want END_STREAM, expecting data")
- }
- if !hf.HeadersEnded() {
- t.Fatal("want END_HEADERS flag")
- }
- goth := decodeHeader(t, hf.HeaderBlockFragment())
- wanth := [][2]string{
- {":status", "200"},
- {"content-type", "foo/bar"},
- {"content-length", strconv.Itoa(len(msg))},
- }
- if !reflect.DeepEqual(goth, wanth) {
- t.Errorf("Got headers %v; want %v", goth, wanth)
- }
- df := st.wantData()
- if !df.StreamEnded() {
- t.Error("expected DATA to have END_STREAM flag")
- }
- if got := string(df.Data()); got != msg {
- t.Errorf("got DATA %q; want %q", got, msg)
- }
- })
-}
-
-func TestServer_Response_TransferEncoding_chunked(t *testing.T) {
- const msg = "hi"
- testServerResponse(t, func(w http.ResponseWriter, r *http.Request) error {
- w.Header().Set("Transfer-Encoding", "chunked") // should be stripped
- io.WriteString(w, msg)
- return nil
- }, func(st *serverTester) {
- getSlash(st)
- hf := st.wantHeaders()
- goth := decodeHeader(t, hf.HeaderBlockFragment())
- wanth := [][2]string{
- {":status", "200"},
- {"content-type", "text/plain; charset=utf-8"},
- {"content-length", strconv.Itoa(len(msg))},
- }
- if !reflect.DeepEqual(goth, wanth) {
- t.Errorf("Got headers %v; want %v", goth, wanth)
- }
- })
-}
-
-// Header accessed only after the initial write.
-func TestServer_Response_Data_IgnoreHeaderAfterWrite_After(t *testing.T) {
- const msg = "this is HTML."
- testServerResponse(t, func(w http.ResponseWriter, r *http.Request) error {
- io.WriteString(w, msg)
- w.Header().Set("foo", "should be ignored")
- return nil
- }, func(st *serverTester) {
- getSlash(st)
- hf := st.wantHeaders()
- if hf.StreamEnded() {
- t.Fatal("unexpected END_STREAM")
- }
- if !hf.HeadersEnded() {
- t.Fatal("want END_HEADERS flag")
- }
- goth := decodeHeader(t, hf.HeaderBlockFragment())
- wanth := [][2]string{
- {":status", "200"},
- {"content-type", "text/html; charset=utf-8"},
- {"content-length", strconv.Itoa(len(msg))},
- }
- if !reflect.DeepEqual(goth, wanth) {
- t.Errorf("Got headers %v; want %v", goth, wanth)
- }
- })
-}
-
-// Header accessed before the initial write and later mutated.
-func TestServer_Response_Data_IgnoreHeaderAfterWrite_Overwrite(t *testing.T) {
- const msg = "this is HTML."
- testServerResponse(t, func(w http.ResponseWriter, r *http.Request) error {
- w.Header().Set("foo", "proper value")
- io.WriteString(w, msg)
- w.Header().Set("foo", "should be ignored")
- return nil
- }, func(st *serverTester) {
- getSlash(st)
- hf := st.wantHeaders()
- if hf.StreamEnded() {
- t.Fatal("unexpected END_STREAM")
- }
- if !hf.HeadersEnded() {
- t.Fatal("want END_HEADERS flag")
- }
- goth := decodeHeader(t, hf.HeaderBlockFragment())
- wanth := [][2]string{
- {":status", "200"},
- {"foo", "proper value"},
- {"content-type", "text/html; charset=utf-8"},
- {"content-length", strconv.Itoa(len(msg))},
- }
- if !reflect.DeepEqual(goth, wanth) {
- t.Errorf("Got headers %v; want %v", goth, wanth)
- }
- })
-}
-
-func TestServer_Response_Data_SniffLenType(t *testing.T) {
- const msg = "this is HTML."
- testServerResponse(t, func(w http.ResponseWriter, r *http.Request) error {
- io.WriteString(w, msg)
- return nil
- }, func(st *serverTester) {
- getSlash(st)
- hf := st.wantHeaders()
- if hf.StreamEnded() {
- t.Fatal("don't want END_STREAM, expecting data")
- }
- if !hf.HeadersEnded() {
- t.Fatal("want END_HEADERS flag")
- }
- goth := decodeHeader(t, hf.HeaderBlockFragment())
- wanth := [][2]string{
- {":status", "200"},
- {"content-type", "text/html; charset=utf-8"},
- {"content-length", strconv.Itoa(len(msg))},
- }
- if !reflect.DeepEqual(goth, wanth) {
- t.Errorf("Got headers %v; want %v", goth, wanth)
- }
- df := st.wantData()
- if !df.StreamEnded() {
- t.Error("expected DATA to have END_STREAM flag")
- }
- if got := string(df.Data()); got != msg {
- t.Errorf("got DATA %q; want %q", got, msg)
- }
- })
-}
-
-func TestServer_Response_Header_Flush_MidWrite(t *testing.T) {
- const msg = "this is HTML"
- const msg2 = ", and this is the next chunk"
- testServerResponse(t, func(w http.ResponseWriter, r *http.Request) error {
- io.WriteString(w, msg)
- w.(http.Flusher).Flush()
- io.WriteString(w, msg2)
- return nil
- }, func(st *serverTester) {
- getSlash(st)
- hf := st.wantHeaders()
- if hf.StreamEnded() {
- t.Fatal("unexpected END_STREAM flag")
- }
- if !hf.HeadersEnded() {
- t.Fatal("want END_HEADERS flag")
- }
- goth := decodeHeader(t, hf.HeaderBlockFragment())
- wanth := [][2]string{
- {":status", "200"},
- {"content-type", "text/html; charset=utf-8"}, // sniffed
- // and no content-length
- }
- if !reflect.DeepEqual(goth, wanth) {
- t.Errorf("Got headers %v; want %v", goth, wanth)
- }
- {
- df := st.wantData()
- if df.StreamEnded() {
- t.Error("unexpected END_STREAM flag")
- }
- if got := string(df.Data()); got != msg {
- t.Errorf("got DATA %q; want %q", got, msg)
- }
- }
- {
- df := st.wantData()
- if !df.StreamEnded() {
- t.Error("wanted END_STREAM flag on last data chunk")
- }
- if got := string(df.Data()); got != msg2 {
- t.Errorf("got DATA %q; want %q", got, msg2)
- }
- }
- })
-}
-
-func TestServer_Response_LargeWrite(t *testing.T) {
- const size = 1 << 20
- const maxFrameSize = 16 << 10
- testServerResponse(t, func(w http.ResponseWriter, r *http.Request) error {
- n, err := w.Write(bytes.Repeat([]byte("a"), size))
- if err != nil {
- return fmt.Errorf("Write error: %v", err)
- }
- if n != size {
- return fmt.Errorf("wrong size %d from Write", n)
- }
- return nil
- }, func(st *serverTester) {
- if err := st.fr.WriteSettings(
- Setting{SettingInitialWindowSize, 0},
- Setting{SettingMaxFrameSize, maxFrameSize},
- ); err != nil {
- t.Fatal(err)
- }
- st.wantSettingsAck()
-
- getSlash(st) // make the single request
-
- // Give the handler quota to write:
- if err := st.fr.WriteWindowUpdate(1, size); err != nil {
- t.Fatal(err)
- }
- // Give the handler quota to write to connection-level
- // window as well
- if err := st.fr.WriteWindowUpdate(0, size); err != nil {
- t.Fatal(err)
- }
- hf := st.wantHeaders()
- if hf.StreamEnded() {
- t.Fatal("unexpected END_STREAM flag")
- }
- if !hf.HeadersEnded() {
- t.Fatal("want END_HEADERS flag")
- }
- goth := decodeHeader(t, hf.HeaderBlockFragment())
- wanth := [][2]string{
- {":status", "200"},
- {"content-type", "text/plain; charset=utf-8"}, // sniffed
- // and no content-length
- }
- if !reflect.DeepEqual(goth, wanth) {
- t.Errorf("Got headers %v; want %v", goth, wanth)
- }
- var bytes, frames int
- for {
- df := st.wantData()
- bytes += len(df.Data())
- frames++
- for _, b := range df.Data() {
- if b != 'a' {
- t.Fatal("non-'a' byte seen in DATA")
- }
- }
- if df.StreamEnded() {
- break
- }
- }
- if bytes != size {
- t.Errorf("Got %d bytes; want %d", bytes, size)
- }
- if want := int(size / maxFrameSize); frames < want || frames > want*2 {
- t.Errorf("Got %d frames; want %d", frames, size)
- }
- })
-}
-
-// Test that the handler can't write more than the client allows
-func TestServer_Response_LargeWrite_FlowControlled(t *testing.T) {
- const size = 1 << 20
- const maxFrameSize = 16 << 10
- testServerResponse(t, func(w http.ResponseWriter, r *http.Request) error {
- w.(http.Flusher).Flush()
- n, err := w.Write(bytes.Repeat([]byte("a"), size))
- if err != nil {
- return fmt.Errorf("Write error: %v", err)
- }
- if n != size {
- return fmt.Errorf("wrong size %d from Write", n)
- }
- return nil
- }, func(st *serverTester) {
- // Set the window size to something explicit for this test.
- // It's also how much initial data we expect.
- const initWindowSize = 123
- if err := st.fr.WriteSettings(
- Setting{SettingInitialWindowSize, initWindowSize},
- Setting{SettingMaxFrameSize, maxFrameSize},
- ); err != nil {
- t.Fatal(err)
- }
- st.wantSettingsAck()
-
- getSlash(st) // make the single request
- defer func() { st.fr.WriteRSTStream(1, ErrCodeCancel) }()
-
- hf := st.wantHeaders()
- if hf.StreamEnded() {
- t.Fatal("unexpected END_STREAM flag")
- }
- if !hf.HeadersEnded() {
- t.Fatal("want END_HEADERS flag")
- }
-
- df := st.wantData()
- if got := len(df.Data()); got != initWindowSize {
- t.Fatalf("Initial window size = %d but got DATA with %d bytes", initWindowSize, got)
- }
-
- for _, quota := range []int{1, 13, 127} {
- if err := st.fr.WriteWindowUpdate(1, uint32(quota)); err != nil {
- t.Fatal(err)
- }
- df := st.wantData()
- if int(quota) != len(df.Data()) {
- t.Fatalf("read %d bytes after giving %d quota", len(df.Data()), quota)
- }
- }
-
- if err := st.fr.WriteRSTStream(1, ErrCodeCancel); err != nil {
- t.Fatal(err)
- }
- })
-}
-
-// Test that the handler blocked in a Write is unblocked if the server sends a RST_STREAM.
-func TestServer_Response_RST_Unblocks_LargeWrite(t *testing.T) {
- const size = 1 << 20
- const maxFrameSize = 16 << 10
- testServerResponse(t, func(w http.ResponseWriter, r *http.Request) error {
- w.(http.Flusher).Flush()
- errc := make(chan error, 1)
- go func() {
- _, err := w.Write(bytes.Repeat([]byte("a"), size))
- errc <- err
- }()
- select {
- case err := <-errc:
- if err == nil {
- return errors.New("unexpected nil error from Write in handler")
- }
- return nil
- case <-time.After(2 * time.Second):
- return errors.New("timeout waiting for Write in handler")
- }
- }, func(st *serverTester) {
- if err := st.fr.WriteSettings(
- Setting{SettingInitialWindowSize, 0},
- Setting{SettingMaxFrameSize, maxFrameSize},
- ); err != nil {
- t.Fatal(err)
- }
- st.wantSettingsAck()
-
- getSlash(st) // make the single request
-
- hf := st.wantHeaders()
- if hf.StreamEnded() {
- t.Fatal("unexpected END_STREAM flag")
- }
- if !hf.HeadersEnded() {
- t.Fatal("want END_HEADERS flag")
- }
-
- if err := st.fr.WriteRSTStream(1, ErrCodeCancel); err != nil {
- t.Fatal(err)
- }
- })
-}
-
-func TestServer_Response_Empty_Data_Not_FlowControlled(t *testing.T) {
- testServerResponse(t, func(w http.ResponseWriter, r *http.Request) error {
- w.(http.Flusher).Flush()
- // Nothing; send empty DATA
- return nil
- }, func(st *serverTester) {
- // Handler gets no data quota:
- if err := st.fr.WriteSettings(Setting{SettingInitialWindowSize, 0}); err != nil {
- t.Fatal(err)
- }
- st.wantSettingsAck()
-
- getSlash(st) // make the single request
-
- hf := st.wantHeaders()
- if hf.StreamEnded() {
- t.Fatal("unexpected END_STREAM flag")
- }
- if !hf.HeadersEnded() {
- t.Fatal("want END_HEADERS flag")
- }
-
- df := st.wantData()
- if got := len(df.Data()); got != 0 {
- t.Fatalf("unexpected %d DATA bytes; want 0", got)
- }
- if !df.StreamEnded() {
- t.Fatal("DATA didn't have END_STREAM")
- }
- })
-}
-
-func TestServer_Response_Automatic100Continue(t *testing.T) {
- const msg = "foo"
- const reply = "bar"
- testServerResponse(t, func(w http.ResponseWriter, r *http.Request) error {
- if v := r.Header.Get("Expect"); v != "" {
- t.Errorf("Expect header = %q; want empty", v)
- }
- buf := make([]byte, len(msg))
- // This read should trigger the 100-continue being sent.
- if n, err := io.ReadFull(r.Body, buf); err != nil || n != len(msg) || string(buf) != msg {
- return fmt.Errorf("ReadFull = %q, %v; want %q, nil", buf[:n], err, msg)
- }
- _, err := io.WriteString(w, reply)
- return err
- }, func(st *serverTester) {
- st.writeHeaders(HeadersFrameParam{
- StreamID: 1, // clients send odd numbers
- BlockFragment: st.encodeHeader(":method", "POST", "expect", "100-continue"),
- EndStream: false,
- EndHeaders: true,
- })
- hf := st.wantHeaders()
- if hf.StreamEnded() {
- t.Fatal("unexpected END_STREAM flag")
- }
- if !hf.HeadersEnded() {
- t.Fatal("want END_HEADERS flag")
- }
- goth := decodeHeader(t, hf.HeaderBlockFragment())
- wanth := [][2]string{
- {":status", "100"},
- }
- if !reflect.DeepEqual(goth, wanth) {
- t.Fatalf("Got headers %v; want %v", goth, wanth)
- }
-
- // Okay, they sent status 100, so we can send our
- // gigantic and/or sensitive "foo" payload now.
- st.writeData(1, true, []byte(msg))
-
- st.wantWindowUpdate(0, uint32(len(msg)))
-
- hf = st.wantHeaders()
- if hf.StreamEnded() {
- t.Fatal("expected data to follow")
- }
- if !hf.HeadersEnded() {
- t.Fatal("want END_HEADERS flag")
- }
- goth = decodeHeader(t, hf.HeaderBlockFragment())
- wanth = [][2]string{
- {":status", "200"},
- {"content-type", "text/plain; charset=utf-8"},
- {"content-length", strconv.Itoa(len(reply))},
- }
- if !reflect.DeepEqual(goth, wanth) {
- t.Errorf("Got headers %v; want %v", goth, wanth)
- }
-
- df := st.wantData()
- if string(df.Data()) != reply {
- t.Errorf("Client read %q; want %q", df.Data(), reply)
- }
- if !df.StreamEnded() {
- t.Errorf("expect data stream end")
- }
- })
-}
-
-func TestServer_HandlerWriteErrorOnDisconnect(t *testing.T) {
- errc := make(chan error, 1)
- testServerResponse(t, func(w http.ResponseWriter, r *http.Request) error {
- p := []byte("some data.\n")
- for {
- _, err := w.Write(p)
- if err != nil {
- errc <- err
- return nil
- }
- }
- }, func(st *serverTester) {
- st.writeHeaders(HeadersFrameParam{
- StreamID: 1,
- BlockFragment: st.encodeHeader(),
- EndStream: false,
- EndHeaders: true,
- })
- hf := st.wantHeaders()
- if hf.StreamEnded() {
- t.Fatal("unexpected END_STREAM flag")
- }
- if !hf.HeadersEnded() {
- t.Fatal("want END_HEADERS flag")
- }
- // Close the connection and wait for the handler to (hopefully) notice.
- st.cc.Close()
- select {
- case <-errc:
- case <-time.After(5 * time.Second):
- t.Error("timeout")
- }
- })
-}
-
-func TestServer_Rejects_Too_Many_Streams(t *testing.T) {
- const testPath = "/some/path"
-
- inHandler := make(chan uint32)
- leaveHandler := make(chan bool)
- st := newServerTester(t, func(w http.ResponseWriter, r *http.Request) {
- id := w.(*responseWriter).rws.stream.id
- inHandler <- id
- if id == 1+(defaultMaxStreams+1)*2 && r.URL.Path != testPath {
- t.Errorf("decoded final path as %q; want %q", r.URL.Path, testPath)
- }
- <-leaveHandler
- })
- defer st.Close()
- st.greet()
- nextStreamID := uint32(1)
- streamID := func() uint32 {
- defer func() { nextStreamID += 2 }()
- return nextStreamID
- }
- sendReq := func(id uint32, headers ...string) {
- st.writeHeaders(HeadersFrameParam{
- StreamID: id,
- BlockFragment: st.encodeHeader(headers...),
- EndStream: true,
- EndHeaders: true,
- })
- }
- for i := 0; i < defaultMaxStreams; i++ {
- sendReq(streamID())
- <-inHandler
- }
- defer func() {
- for i := 0; i < defaultMaxStreams; i++ {
- leaveHandler <- true
- }
- }()
-
- // And this one should cross the limit:
- // (It's also sent as a CONTINUATION, to verify we still track the decoder context,
- // even if we're rejecting it)
- rejectID := streamID()
- headerBlock := st.encodeHeader(":path", testPath)
- frag1, frag2 := headerBlock[:3], headerBlock[3:]
- st.writeHeaders(HeadersFrameParam{
- StreamID: rejectID,
- BlockFragment: frag1,
- EndStream: true,
- EndHeaders: false, // CONTINUATION coming
- })
- if err := st.fr.WriteContinuation(rejectID, true, frag2); err != nil {
- t.Fatal(err)
- }
- st.wantRSTStream(rejectID, ErrCodeProtocol)
-
- // But let a handler finish:
- leaveHandler <- true
- st.wantHeaders()
-
- // And now another stream should be able to start:
- goodID := streamID()
- sendReq(goodID, ":path", testPath)
- select {
- case got := <-inHandler:
- if got != goodID {
- t.Errorf("Got stream %d; want %d", got, goodID)
- }
- case <-time.After(3 * time.Second):
- t.Error("timeout waiting for handler")
- }
-}
-
-// So many response headers that the server needs to use CONTINUATION frames:
-func TestServer_Response_ManyHeaders_With_Continuation(t *testing.T) {
- testServerResponse(t, func(w http.ResponseWriter, r *http.Request) error {
- h := w.Header()
- for i := 0; i < 5000; i++ {
- h.Set(fmt.Sprintf("x-header-%d", i), fmt.Sprintf("x-value-%d", i))
- }
- return nil
- }, func(st *serverTester) {
- getSlash(st)
- hf := st.wantHeaders()
- if hf.HeadersEnded() {
- t.Fatal("got unwanted END_HEADERS flag")
- }
- n := 0
- for {
- n++
- cf := st.wantContinuation()
- if cf.HeadersEnded() {
- break
- }
- }
- if n < 5 {
- t.Errorf("Only got %d CONTINUATION frames; expected 5+ (currently 6)", n)
- }
- })
-}
-
-// This previously crashed (reported by Mathieu Lonjaret as observed
-// while using Camlistore) because we got a DATA frame from the client
-// after the handler exited and our logic at the time was wrong,
-// keeping a stream in the map in stateClosed, which tickled an
-// invariant check later when we tried to remove that stream (via
-// defer sc.closeAllStreamsOnConnClose) when the serverConn serve loop
-// ended.
-func TestServer_NoCrash_HandlerClose_Then_ClientClose(t *testing.T) {
- testServerResponse(t, func(w http.ResponseWriter, r *http.Request) error {
- // nothing
- return nil
- }, func(st *serverTester) {
- st.writeHeaders(HeadersFrameParam{
- StreamID: 1,
- BlockFragment: st.encodeHeader(),
- EndStream: false, // DATA is coming
- EndHeaders: true,
- })
- hf := st.wantHeaders()
- if !hf.HeadersEnded() || !hf.StreamEnded() {
- t.Fatalf("want END_HEADERS+END_STREAM, got %v", hf)
- }
-
- // Sent when the a Handler closes while a client has
- // indicated it's still sending DATA:
- st.wantRSTStream(1, ErrCodeCancel)
-
- // Now the handler has ended, so it's ended its
- // stream, but the client hasn't closed its side
- // (stateClosedLocal). So send more data and verify
- // it doesn't crash with an internal invariant panic, like
- // it did before.
- st.writeData(1, true, []byte("foo"))
-
- // Sent after a peer sends data anyway (admittedly the
- // previous RST_STREAM might've still been in-flight),
- // but they'll get the more friendly 'cancel' code
- // first.
- st.wantRSTStream(1, ErrCodeStreamClosed)
-
- // Set up a bunch of machinery to record the panic we saw
- // previously.
- var (
- panMu sync.Mutex
- panicVal interface{}
- )
-
- testHookOnPanicMu.Lock()
- testHookOnPanic = func(sc *serverConn, pv interface{}) bool {
- panMu.Lock()
- panicVal = pv
- panMu.Unlock()
- return true
- }
- testHookOnPanicMu.Unlock()
-
- // Now force the serve loop to end, via closing the connection.
- st.cc.Close()
- select {
- case <-st.sc.doneServing:
- // Loop has exited.
- panMu.Lock()
- got := panicVal
- panMu.Unlock()
- if got != nil {
- t.Errorf("Got panic: %v", got)
- }
- case <-time.After(5 * time.Second):
- t.Error("timeout")
- }
- })
-}
-
-func TestServer_Rejects_TLS10(t *testing.T) { testRejectTLS(t, tls.VersionTLS10) }
-func TestServer_Rejects_TLS11(t *testing.T) { testRejectTLS(t, tls.VersionTLS11) }
-
-func testRejectTLS(t *testing.T, max uint16) {
- st := newServerTester(t, nil, func(c *tls.Config) {
- c.MaxVersion = max
- })
- defer st.Close()
- gf := st.wantGoAway()
- if got, want := gf.ErrCode, ErrCodeInadequateSecurity; got != want {
- t.Errorf("Got error code %v; want %v", got, want)
- }
-}
-
-func TestServer_Rejects_TLSBadCipher(t *testing.T) {
- st := newServerTester(t, nil, func(c *tls.Config) {
- // Only list bad ones:
- c.CipherSuites = []uint16{
- tls.TLS_RSA_WITH_RC4_128_SHA,
- tls.TLS_RSA_WITH_3DES_EDE_CBC_SHA,
- tls.TLS_RSA_WITH_AES_128_CBC_SHA,
- tls.TLS_RSA_WITH_AES_256_CBC_SHA,
- tls.TLS_ECDHE_ECDSA_WITH_RC4_128_SHA,
- tls.TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,
- tls.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA,
- tls.TLS_ECDHE_RSA_WITH_RC4_128_SHA,
- tls.TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA,
- tls.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,
- tls.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,
- }
- })
- defer st.Close()
- gf := st.wantGoAway()
- if got, want := gf.ErrCode, ErrCodeInadequateSecurity; got != want {
- t.Errorf("Got error code %v; want %v", got, want)
- }
-}
-
-func TestServer_Advertises_Common_Cipher(t *testing.T) {
- const requiredSuite = tls.TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- st := newServerTester(t, nil, func(c *tls.Config) {
- // Have the client only support the one required by the spec.
- c.CipherSuites = []uint16{requiredSuite}
- }, func(ts *httptest.Server) {
- var srv *http.Server = ts.Config
- // Have the server configured with one specific cipher suite
- // which is banned. This tests that ConfigureServer ends up
- // adding the good one to this list.
- srv.TLSConfig = &tls.Config{
- CipherSuites: []uint16{tls.TLS_RSA_WITH_AES_128_CBC_SHA}, // just a banned one
- }
- })
- defer st.Close()
- st.greet()
-}
-
-// TODO: move this onto *serverTester, and re-use the same hpack
-// decoding context throughout. We're just getting lucky here with
-// creating a new decoder each time.
-func decodeHeader(t *testing.T, headerBlock []byte) (pairs [][2]string) {
- d := hpack.NewDecoder(initialHeaderTableSize, func(f hpack.HeaderField) {
- pairs = append(pairs, [2]string{f.Name, f.Value})
- })
- if _, err := d.Write(headerBlock); err != nil {
- t.Fatalf("hpack decoding error: %v", err)
- }
- if err := d.Close(); err != nil {
- t.Fatalf("hpack decoding error: %v", err)
- }
- return
-}
-
-// testServerResponse sets up an idle HTTP/2 connection and lets you
-// write a single request with writeReq, and then reply to it in some way with the provided handler,
-// and then verify the output with the serverTester again (assuming the handler returns nil)
-func testServerResponse(t testing.TB,
- handler func(http.ResponseWriter, *http.Request) error,
- client func(*serverTester),
-) {
- errc := make(chan error, 1)
- st := newServerTester(t, func(w http.ResponseWriter, r *http.Request) {
- if r.Body == nil {
- t.Fatal("nil Body")
- }
- errc <- handler(w, r)
- })
- defer st.Close()
-
- donec := make(chan bool)
- go func() {
- defer close(donec)
- st.greet()
- client(st)
- }()
-
- select {
- case <-donec:
- return
- case <-time.After(5 * time.Second):
- t.Fatal("timeout")
- }
-
- select {
- case err := <-errc:
- if err != nil {
- t.Fatalf("Error in handler: %v", err)
- }
- case <-time.After(2 * time.Second):
- t.Error("timeout waiting for handler to finish")
- }
-}
-
-// readBodyHandler returns an http Handler func that reads len(want)
-// bytes from r.Body and fails t if the contents read were not
-// the value of want.
-func readBodyHandler(t *testing.T, want string) func(w http.ResponseWriter, r *http.Request) {
- return func(w http.ResponseWriter, r *http.Request) {
- buf := make([]byte, len(want))
- _, err := io.ReadFull(r.Body, buf)
- if err != nil {
- t.Error(err)
- return
- }
- if string(buf) != want {
- t.Errorf("read %q; want %q", buf, want)
- }
- }
-}
-
-// TestServerWithCurl currently fails, hence the LenientCipherSuites test. See:
-// https://github.com/tatsuhiro-t/nghttp2/issues/140 &
-// http://sourceforge.net/p/curl/bugs/1472/
-func TestServerWithCurl(t *testing.T) { testServerWithCurl(t, false) }
-func TestServerWithCurl_LenientCipherSuites(t *testing.T) { testServerWithCurl(t, true) }
-
-func testServerWithCurl(t *testing.T, permitProhibitedCipherSuites bool) {
- if runtime.GOOS != "linux" {
- t.Skip("skipping Docker test when not on Linux; requires --net which won't work with boot2docker anyway")
- }
- requireCurl(t)
- const msg = "Hello from curl!\n"
- ts := httptest.NewUnstartedServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
- w.Header().Set("Foo", "Bar")
- w.Header().Set("Client-Proto", r.Proto)
- io.WriteString(w, msg)
- }))
- ConfigureServer(ts.Config, &Server{
- PermitProhibitedCipherSuites: permitProhibitedCipherSuites,
- })
- ts.TLS = ts.Config.TLSConfig // the httptest.Server has its own copy of this TLS config
- ts.StartTLS()
- defer ts.Close()
-
- var gotConn int32
- testHookOnConn = func() { atomic.StoreInt32(&gotConn, 1) }
-
- t.Logf("Running test server for curl to hit at: %s", ts.URL)
- container := curl(t, "--silent", "--http2", "--insecure", "-v", ts.URL)
- defer kill(container)
- resc := make(chan interface{}, 1)
- go func() {
- res, err := dockerLogs(container)
- if err != nil {
- resc <- err
- } else {
- resc <- res
- }
- }()
- select {
- case res := <-resc:
- if err, ok := res.(error); ok {
- t.Fatal(err)
- }
- if !strings.Contains(string(res.([]byte)), "foo: Bar") {
- t.Errorf("didn't see foo: Bar header")
- t.Logf("Got: %s", res)
- }
- if !strings.Contains(string(res.([]byte)), "client-proto: HTTP/2") {
- t.Errorf("didn't see client-proto: HTTP/2 header")
- t.Logf("Got: %s", res)
- }
- if !strings.Contains(string(res.([]byte)), msg) {
- t.Errorf("didn't see %q content", msg)
- t.Logf("Got: %s", res)
- }
- case <-time.After(3 * time.Second):
- t.Errorf("timeout waiting for curl")
- }
-
- if atomic.LoadInt32(&gotConn) == 0 {
- t.Error("never saw an http2 connection")
- }
-}
-
-func BenchmarkServerGets(b *testing.B) {
- b.ReportAllocs()
-
- const msg = "Hello, world"
- st := newServerTester(b, func(w http.ResponseWriter, r *http.Request) {
- io.WriteString(w, msg)
- })
- defer st.Close()
- st.greet()
-
- // Give the server quota to reply. (plus it has the the 64KB)
- if err := st.fr.WriteWindowUpdate(0, uint32(b.N*len(msg))); err != nil {
- b.Fatal(err)
- }
-
- for i := 0; i < b.N; i++ {
- id := 1 + uint32(i)*2
- st.writeHeaders(HeadersFrameParam{
- StreamID: id,
- BlockFragment: st.encodeHeader(),
- EndStream: true,
- EndHeaders: true,
- })
- st.wantHeaders()
- df := st.wantData()
- if !df.StreamEnded() {
- b.Fatalf("DATA didn't have END_STREAM; got %v", df)
- }
- }
-}
-
-func BenchmarkServerPosts(b *testing.B) {
- b.ReportAllocs()
-
- const msg = "Hello, world"
- st := newServerTester(b, func(w http.ResponseWriter, r *http.Request) {
- io.WriteString(w, msg)
- })
- defer st.Close()
- st.greet()
-
- // Give the server quota to reply. (plus it has the the 64KB)
- if err := st.fr.WriteWindowUpdate(0, uint32(b.N*len(msg))); err != nil {
- b.Fatal(err)
- }
-
- for i := 0; i < b.N; i++ {
- id := 1 + uint32(i)*2
- st.writeHeaders(HeadersFrameParam{
- StreamID: id,
- BlockFragment: st.encodeHeader(":method", "POST"),
- EndStream: false,
- EndHeaders: true,
- })
- st.writeData(id, true, nil)
- st.wantHeaders()
- df := st.wantData()
- if !df.StreamEnded() {
- b.Fatalf("DATA didn't have END_STREAM; got %v", df)
- }
- }
-}
diff --git a/vendor/github.com/bradfitz/http2/testdata/draft-ietf-httpbis-http2.xml b/vendor/github.com/bradfitz/http2/testdata/draft-ietf-httpbis-http2.xml
deleted file mode 100644
index 31a84bed..00000000
--- a/vendor/github.com/bradfitz/http2/testdata/draft-ietf-httpbis-http2.xml
+++ /dev/null
@@ -1,5021 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Hypertext Transfer Protocol version 2
-
-
- Twist
-
- mbelshe@chromium.org
-
-
-
-
- Google, Inc
-
- fenix@google.com
-
-
-
-
- Mozilla
-
-
- 331 E Evelyn Street
- Mountain View
- CA
- 94041
- US
-
- martin.thomson@gmail.com
-
-
-
-
- Applications
- HTTPbis
- HTTP
- SPDY
- Web
-
-
-
- This specification describes an optimized expression of the semantics of the Hypertext
- Transfer Protocol (HTTP). HTTP/2 enables a more efficient use of network resources and a
- reduced perception of latency by introducing header field compression and allowing multiple
- concurrent messages on the same connection. It also introduces unsolicited push of
- representations from servers to clients.
-
-
- This specification is an alternative to, but does not obsolete, the HTTP/1.1 message syntax.
- HTTP's existing semantics remain unchanged.
-
-
-
-
-
- Discussion of this draft takes place on the HTTPBIS working group mailing list
- (ietf-http-wg@w3.org), which is archived at .
-
-
- Working Group information can be found at ; that specific to HTTP/2 are at .
-
-
- The changes in this draft are summarized in .
-
-
-
-
-
-
-
-
-
- The Hypertext Transfer Protocol (HTTP) is a wildly successful protocol. However, the
- HTTP/1.1 message format () has
- several characteristics that have a negative overall effect on application performance
- today.
-
-
- In particular, HTTP/1.0 allowed only one request to be outstanding at a time on a given
- TCP connection. HTTP/1.1 added request pipelining, but this only partially addressed
- request concurrency and still suffers from head-of-line blocking. Therefore, HTTP/1.1
- clients that need to make many requests typically use multiple connections to a server in
- order to achieve concurrency and thereby reduce latency.
-
-
- Furthermore, HTTP header fields are often repetitive and verbose, causing unnecessary
- network traffic, as well as causing the initial TCP congestion
- window to quickly fill. This can result in excessive latency when multiple requests are
- made on a new TCP connection.
-
-
- HTTP/2 addresses these issues by defining an optimized mapping of HTTP's semantics to an
- underlying connection. Specifically, it allows interleaving of request and response
- messages on the same connection and uses an efficient coding for HTTP header fields. It
- also allows prioritization of requests, letting more important requests complete more
- quickly, further improving performance.
-
-
- The resulting protocol is more friendly to the network, because fewer TCP connections can
- be used in comparison to HTTP/1.x. This means less competition with other flows, and
- longer-lived connections, which in turn leads to better utilization of available network
- capacity.
-
-
- Finally, HTTP/2 also enables more efficient processing of messages through use of binary
- message framing.
-
-
-
-
-
- HTTP/2 provides an optimized transport for HTTP semantics. HTTP/2 supports all of the core
- features of HTTP/1.1, but aims to be more efficient in several ways.
-
-
- The basic protocol unit in HTTP/2 is a frame. Each frame
- type serves a different purpose. For example, HEADERS and
- DATA frames form the basis of HTTP requests and
- responses; other frame types like SETTINGS,
- WINDOW_UPDATE, and PUSH_PROMISE are used in support of other
- HTTP/2 features.
-
-
- Multiplexing of requests is achieved by having each HTTP request-response exchange
- associated with its own stream. Streams are largely
- independent of each other, so a blocked or stalled request or response does not prevent
- progress on other streams.
-
-
- Flow control and prioritization ensure that it is possible to efficiently use multiplexed
- streams. Flow control helps to ensure that only data that
- can be used by a receiver is transmitted. Prioritization ensures that limited resources can be directed
- to the most important streams first.
-
-
- HTTP/2 adds a new interaction mode, whereby a server can push
- responses to a client. Server push allows a server to speculatively send a client
- data that the server anticipates the client will need, trading off some network usage
- against a potential latency gain. The server does this by synthesizing a request, which it
- sends as a PUSH_PROMISE frame. The server is then able to send a response to
- the synthetic request on a separate stream.
-
-
- Frames that contain HTTP header fields are compressed.
- HTTP requests can be highly redundant, so compression can reduce the size of requests and
- responses significantly.
-
-
-
-
- The HTTP/2 specification is split into four parts:
-
-
- Starting HTTP/2 covers how an HTTP/2 connection is
- initiated.
-
-
- The framing and streams layers describe the way HTTP/2 frames are
- structured and formed into multiplexed streams.
-
-
- Frame and error
- definitions include details of the frame and error types used in HTTP/2.
-
-
- HTTP mappings and additional
- requirements describe how HTTP semantics are expressed using frames and
- streams.
-
-
-
-
- While some of the frame and stream layer concepts are isolated from HTTP, this
- specification does not define a completely generic framing layer. The framing and streams
- layers are tailored to the needs of the HTTP protocol and server push.
-
-
-
-
-
- The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD
- NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as
- described in RFC 2119.
-
-
- All numeric values are in network byte order. Values are unsigned unless otherwise
- indicated. Literal values are provided in decimal or hexadecimal as appropriate.
- Hexadecimal literals are prefixed with 0x to distinguish them
- from decimal literals.
-
-
- The following terms are used:
-
-
- The endpoint initiating the HTTP/2 connection.
-
-
- A transport-layer connection between two endpoints.
-
-
- An error that affects the entire HTTP/2 connection.
-
-
- Either the client or server of the connection.
-
-
- The smallest unit of communication within an HTTP/2 connection, consisting of a header
- and a variable-length sequence of octets structured according to the frame type.
-
-
- An endpoint. When discussing a particular endpoint, "peer" refers to the endpoint
- that is remote to the primary subject of discussion.
-
-
- An endpoint that is receiving frames.
-
-
- An endpoint that is transmitting frames.
-
-
- The endpoint which did not initiate the HTTP/2 connection.
-
-
- A bi-directional flow of frames across a virtual channel within the HTTP/2 connection.
-
-
- An error on the individual HTTP/2 stream.
-
-
-
-
- Finally, the terms "gateway", "intermediary", "proxy", and "tunnel" are defined
- in .
-
-
-
-
-
-
- An HTTP/2 connection is an application layer protocol running on top of a TCP connection
- (). The client is the TCP connection initiator.
-
-
- HTTP/2 uses the same "http" and "https" URI schemes used by HTTP/1.1. HTTP/2 shares the same
- default port numbers: 80 for "http" URIs and 443 for "https" URIs. As a result,
- implementations processing requests for target resource URIs like http://example.org/foo or https://example.com/bar are required to first discover whether the
- upstream server (the immediate peer to which the client wishes to establish a connection)
- supports HTTP/2.
-
-
-
- The means by which support for HTTP/2 is determined is different for "http" and "https"
- URIs. Discovery for "http" URIs is described in . Discovery
- for "https" URIs is described in .
-
-
-
-
- The protocol defined in this document has two identifiers.
-
-
-
- The string "h2" identifies the protocol where HTTP/2 uses TLS. This identifier is used in the TLS application layer protocol negotiation extension (ALPN)
- field and any place that HTTP/2 over TLS is identified.
-
-
- The "h2" string is serialized into an ALPN protocol identifier as the two octet
- sequence: 0x68, 0x32.
-
-
-
-
- The string "h2c" identifies the protocol where HTTP/2 is run over cleartext TCP.
- This identifier is used in the HTTP/1.1 Upgrade header field and any place that
- HTTP/2 over TCP is identified.
-
-
-
-
-
- Negotiating "h2" or "h2c" implies the use of the transport, security, framing and message
- semantics described in this document.
-
-
- RFC Editor's Note: please remove the remainder of this section prior to the
- publication of a final version of this document.
-
-
- Only implementations of the final, published RFC can identify themselves as "h2" or "h2c".
- Until such an RFC exists, implementations MUST NOT identify themselves using these
- strings.
-
-
- Examples and text throughout the rest of this document use "h2" as a matter of
- editorial convenience only. Implementations of draft versions MUST NOT identify using
- this string.
-
-
- Implementations of draft versions of the protocol MUST add the string "-" and the
- corresponding draft number to the identifier. For example, draft-ietf-httpbis-http2-11
- over TLS is identified using the string "h2-11".
-
-
- Non-compatible experiments that are based on these draft versions MUST append the string
- "-" and an experiment name to the identifier. For example, an experimental implementation
- of packet mood-based encoding based on draft-ietf-httpbis-http2-09 might identify itself
- as "h2-09-emo". Note that any label MUST conform to the "token" syntax defined in
- . Experimenters are
- encouraged to coordinate their experiments on the ietf-http-wg@w3.org mailing list.
-
-
-
-
-
- A client that makes a request for an "http" URI without prior knowledge about support for
- HTTP/2 uses the HTTP Upgrade mechanism (). The client makes an HTTP/1.1 request that includes an Upgrade
- header field identifying HTTP/2 with the "h2c" token. The HTTP/1.1 request MUST include
- exactly one HTTP2-Settings header field.
-
-
- For example:
-
-
-]]>
-
-
- Requests that contain an entity body MUST be sent in their entirety before the client can
- send HTTP/2 frames. This means that a large request entity can block the use of the
- connection until it is completely sent.
-
-
- If concurrency of an initial request with subsequent requests is important, an OPTIONS
- request can be used to perform the upgrade to HTTP/2, at the cost of an additional
- round-trip.
-
-
- A server that does not support HTTP/2 can respond to the request as though the Upgrade
- header field were absent:
-
-
-
-HTTP/1.1 200 OK
-Content-Length: 243
-Content-Type: text/html
-
-...
-
-
-
- A server MUST ignore a "h2" token in an Upgrade header field. Presence of a token with
- "h2" implies HTTP/2 over TLS, which is instead negotiated as described in .
-
-
- A server that supports HTTP/2 can accept the upgrade with a 101 (Switching Protocols)
- response. After the empty line that terminates the 101 response, the server can begin
- sending HTTP/2 frames. These frames MUST include a response to the request that initiated
- the Upgrade.
-
-
-
-
- For example:
-
-
-HTTP/1.1 101 Switching Protocols
-Connection: Upgrade
-Upgrade: h2c
-
-[ HTTP/2 connection ...
-
-
-
- The first HTTP/2 frame sent by the server is a SETTINGS frame () as the server connection preface (). Upon receiving the 101 response, the client sends a connection preface, which includes a
- SETTINGS frame.
-
-
- The HTTP/1.1 request that is sent prior to upgrade is assigned stream identifier 1 and is
- assigned default priority values. Stream 1 is
- implicitly half closed from the client toward the server, since the request is completed
- as an HTTP/1.1 request. After commencing the HTTP/2 connection, stream 1 is used for the
- response.
-
-
-
-
- A request that upgrades from HTTP/1.1 to HTTP/2 MUST include exactly one HTTP2-Settings header field. The HTTP2-Settings header field is a connection-specific header field
- that includes parameters that govern the HTTP/2 connection, provided in anticipation of
- the server accepting the request to upgrade.
-
-
-
-
-
- A server MUST NOT upgrade the connection to HTTP/2 if this header field is not present,
- or if more than one is present. A server MUST NOT send this header field.
-
-
-
- The content of the HTTP2-Settings header field is the
- payload of a SETTINGS frame (), encoded as a
- base64url string (that is, the URL- and filename-safe Base64 encoding described in , with any trailing '=' characters omitted). The
- ABNF production for token68 is
- defined in .
-
-
- Since the upgrade is only intended to apply to the immediate connection, a client
- sending HTTP2-Settings MUST also send HTTP2-Settings as a connection option in the Connection header field to prevent it from being forwarded
- downstream.
-
-
- A server decodes and interprets these values as it would any other
- SETTINGS frame. Acknowledgement of the
- SETTINGS parameters is not necessary, since a 101 response serves as implicit
- acknowledgment. Providing these values in the Upgrade request gives a client an
- opportunity to provide parameters prior to receiving any frames from the server.
-
-
-
-
-
-
- A client that makes a request to an "https" URI uses TLS
- with the application layer protocol negotiation extension.
-
-
- HTTP/2 over TLS uses the "h2" application token. The "h2c" token MUST NOT be sent by a
- client or selected by a server.
-
-
- Once TLS negotiation is complete, both the client and the server send a connection preface.
-
-
-
-
-
- A client can learn that a particular server supports HTTP/2 by other means. For example,
- describes a mechanism for advertising this capability.
-
-
- A client MAY immediately send HTTP/2 frames to a server that is known to support HTTP/2,
- after the connection preface; a server can
- identify such a connection by the presence of the connection preface. This only affects
- the establishment of HTTP/2 connections over cleartext TCP; implementations that support
- HTTP/2 over TLS MUST use protocol negotiation in TLS.
-
-
- Without additional information, prior support for HTTP/2 is not a strong signal that a
- given server will support HTTP/2 for future connections. For example, it is possible for
- server configurations to change, for configurations to differ between instances in
- clustered servers, or for network conditions to change.
-
-
-
-
-
- Upon establishment of a TCP connection and determination that HTTP/2 will be used by both
- peers, each endpoint MUST send a connection preface as a final confirmation and to
- establish the initial SETTINGS parameters for the HTTP/2 connection. The client and
- server each send a different connection preface.
-
-
- The client connection preface starts with a sequence of 24 octets, which in hex notation
- are:
-
-
-
-
-
- (the string PRI * HTTP/2.0\r\n\r\nSM\r\n\r\n). This sequence
- is followed by a SETTINGS frame (). The
- SETTINGS frame MAY be empty. The client sends the client connection
- preface immediately upon receipt of a 101 Switching Protocols response (indicating a
- successful upgrade), or as the first application data octets of a TLS connection. If
- starting an HTTP/2 connection with prior knowledge of server support for the protocol, the
- client connection preface is sent upon connection establishment.
-
-
-
-
- The client connection preface is selected so that a large proportion of HTTP/1.1 or
- HTTP/1.0 servers and intermediaries do not attempt to process further frames. Note
- that this does not address the concerns raised in .
-
-
-
-
- The server connection preface consists of a potentially empty SETTINGS
- frame () that MUST be the first frame the server sends in the
- HTTP/2 connection.
-
-
- The SETTINGS frames received from a peer as part of the connection preface
- MUST be acknowledged (see ) after sending the connection
- preface.
-
-
- To avoid unnecessary latency, clients are permitted to send additional frames to the
- server immediately after sending the client connection preface, without waiting to receive
- the server connection preface. It is important to note, however, that the server
- connection preface SETTINGS frame might include parameters that necessarily
- alter how a client is expected to communicate with the server. Upon receiving the
- SETTINGS frame, the client is expected to honor any parameters established.
- In some configurations, it is possible for the server to transmit SETTINGS
- before the client sends additional frames, providing an opportunity to avoid this issue.
-
-
- Clients and servers MUST treat an invalid connection preface as a connection error of type
- PROTOCOL_ERROR. A GOAWAY frame ()
- MAY be omitted in this case, since an invalid preface indicates that the peer is not using
- HTTP/2.
-
-
-
-
-
-
- Once the HTTP/2 connection is established, endpoints can begin exchanging frames.
-
-
-
-
- All frames begin with a fixed 9-octet header followed by a variable-length payload.
-
-
-
-
-
- The fields of the frame header are defined as:
-
-
-
- The length of the frame payload expressed as an unsigned 24-bit integer. Values
- greater than 214 (16,384) MUST NOT be sent unless the receiver has
- set a larger value for SETTINGS_MAX_FRAME_SIZE.
-
-
- The 9 octets of the frame header are not included in this value.
-
-
-
-
- The 8-bit type of the frame. The frame type determines the format and semantics of
- the frame. Implementations MUST ignore and discard any frame that has a type that
- is unknown.
-
-
-
-
- An 8-bit field reserved for frame-type specific boolean flags.
-
-
- Flags are assigned semantics specific to the indicated frame type. Flags that have
- no defined semantics for a particular frame type MUST be ignored, and MUST be left
- unset (0) when sending.
-
-
-
-
- A reserved 1-bit field. The semantics of this bit are undefined and the bit MUST
- remain unset (0) when sending and MUST be ignored when receiving.
-
-
-
-
- A 31-bit stream identifier (see ). The value 0 is
- reserved for frames that are associated with the connection as a whole as opposed to
- an individual stream.
-
-
-
-
-
- The structure and content of the frame payload is dependent entirely on the frame type.
-
-
-
-
-
- The size of a frame payload is limited by the maximum size that a receiver advertises in
- the SETTINGS_MAX_FRAME_SIZE setting. This setting can have any value
- between 214 (16,384) and 224-1 (16,777,215) octets,
- inclusive.
-
-
- All implementations MUST be capable of receiving and minimally processing frames up to
- 214 octets in length, plus the 9 octet frame
- header. The size of the frame header is not included when describing frame sizes.
-
-
- Certain frame types, such as PING, impose additional limits
- on the amount of payload data allowed.
-
-
-
-
- If a frame size exceeds any defined limit, or is too small to contain mandatory frame
- data, the endpoint MUST send a FRAME_SIZE_ERROR error. A frame size error
- in a frame that could alter the state of the entire connection MUST be treated as a connection error; this includes any frame carrying
- a header block (that is, HEADERS,
- PUSH_PROMISE, and CONTINUATION), SETTINGS,
- and any WINDOW_UPDATE frame with a stream identifier of 0.
-
-
- Endpoints are not obligated to use all available space in a frame. Responsiveness can be
- improved by using frames that are smaller than the permitted maximum size. Sending large
- frames can result in delays in sending time-sensitive frames (such
- RST_STREAM, WINDOW_UPDATE, or PRIORITY)
- which if blocked by the transmission of a large frame, could affect performance.
-
-
-
-
-
- Just as in HTTP/1, a header field in HTTP/2 is a name with one or more associated values.
- They are used within HTTP request and response messages as well as server push operations
- (see ).
-
-
- Header lists are collections of zero or more header fields. When transmitted over a
- connection, a header list is serialized into a header block using HTTP Header Compression. The serialized header block is then
- divided into one or more octet sequences, called header block fragments, and transmitted
- within the payload of HEADERS, PUSH_PROMISE or CONTINUATION frames.
-
-
- The Cookie header field is treated specially by the HTTP
- mapping (see ).
-
-
- A receiving endpoint reassembles the header block by concatenating its fragments, then
- decompresses the block to reconstruct the header list.
-
-
- A complete header block consists of either:
-
-
- a single HEADERS or PUSH_PROMISE frame,
- with the END_HEADERS flag set, or
-
-
- a HEADERS or PUSH_PROMISE frame with the END_HEADERS
- flag cleared and one or more CONTINUATION frames,
- where the last CONTINUATION frame has the END_HEADERS flag set.
-
-
-
-
- Header compression is stateful. One compression context and one decompression context is
- used for the entire connection. Each header block is processed as a discrete unit.
- Header blocks MUST be transmitted as a contiguous sequence of frames, with no interleaved
- frames of any other type or from any other stream. The last frame in a sequence of
- HEADERS or CONTINUATION frames MUST have the END_HEADERS
- flag set. The last frame in a sequence of PUSH_PROMISE or
- CONTINUATION frames MUST have the END_HEADERS flag set. This allows a
- header block to be logically equivalent to a single frame.
-
-
- Header block fragments can only be sent as the payload of HEADERS,
- PUSH_PROMISE or CONTINUATION frames, because these frames
- carry data that can modify the compression context maintained by a receiver. An endpoint
- receiving HEADERS, PUSH_PROMISE or
- CONTINUATION frames MUST reassemble header blocks and perform decompression
- even if the frames are to be discarded. A receiver MUST terminate the connection with a
- connection error of type
- COMPRESSION_ERROR if it does not decompress a header block.
-
-
-
-
-
-
- A "stream" is an independent, bi-directional sequence of frames exchanged between the client
- and server within an HTTP/2 connection. Streams have several important characteristics:
-
-
- A single HTTP/2 connection can contain multiple concurrently open streams, with either
- endpoint interleaving frames from multiple streams.
-
-
- Streams can be established and used unilaterally or shared by either the client or
- server.
-
-
- Streams can be closed by either endpoint.
-
-
- The order in which frames are sent on a stream is significant. Recipients process frames
- in the order they are received. In particular, the order of HEADERS,
- and DATA frames is semantically significant.
-
-
- Streams are identified by an integer. Stream identifiers are assigned to streams by the
- endpoint initiating the stream.
-
-
-
-
-
-
- The lifecycle of a stream is shown in .
-
-
-
-
- | |<-----------' |
- | R | closed | R |
- `-------------------->| |<--------------------'
- +--------+
-
- H: HEADERS frame (with implied CONTINUATIONs)
- PP: PUSH_PROMISE frame (with implied CONTINUATIONs)
- ES: END_STREAM flag
- R: RST_STREAM frame
-]]>
-
-
-
-
- Note that this diagram shows stream state transitions and the frames and flags that affect
- those transitions only. In this regard, CONTINUATION frames do not result
- in state transitions; they are effectively part of the HEADERS or
- PUSH_PROMISE that they follow. For this purpose, the END_STREAM flag is
- processed as a separate event to the frame that bears it; a HEADERS frame
- with the END_STREAM flag set can cause two state transitions.
-
-
- Both endpoints have a subjective view of the state of a stream that could be different
- when frames are in transit. Endpoints do not coordinate the creation of streams; they are
- created unilaterally by either endpoint. The negative consequences of a mismatch in
- states are limited to the "closed" state after sending RST_STREAM, where
- frames might be received for some time after closing.
-
-
- Streams have the following states:
-
-
-
-
-
- All streams start in the "idle" state. In this state, no frames have been
- exchanged.
-
-
- The following transitions are valid from this state:
-
-
- Sending or receiving a HEADERS frame causes the stream to become
- "open". The stream identifier is selected as described in . The same HEADERS frame can also
- cause a stream to immediately become "half closed".
-
-
- Sending a PUSH_PROMISE frame marks the associated stream for
- later use. The stream state for the reserved stream transitions to "reserved
- (local)".
-
-
- Receiving a PUSH_PROMISE frame marks the associated stream as
- reserved by the remote peer. The state of the stream becomes "reserved
- (remote)".
-
-
-
-
- Receiving any frames other than HEADERS or
- PUSH_PROMISE on a stream in this state MUST be treated as a connection error of type
- PROTOCOL_ERROR.
-
-
-
-
-
-
- A stream in the "reserved (local)" state is one that has been promised by sending a
- PUSH_PROMISE frame. A PUSH_PROMISE frame reserves an
- idle stream by associating the stream with an open stream that was initiated by the
- remote peer (see ).
-
-
- In this state, only the following transitions are possible:
-
-
- The endpoint can send a HEADERS frame. This causes the stream to
- open in a "half closed (remote)" state.
-
-
- Either endpoint can send a RST_STREAM frame to cause the stream
- to become "closed". This releases the stream reservation.
-
-
-
-
- An endpoint MUST NOT send any type of frame other than HEADERS or
- RST_STREAM in this state.
-
-
- A PRIORITY frame MAY be received in this state. Receiving any type
- of frame other than RST_STREAM or PRIORITY on a stream
- in this state MUST be treated as a connection
- error of type PROTOCOL_ERROR.
-
-
-
-
-
-
- A stream in the "reserved (remote)" state has been reserved by a remote peer.
-
-
- In this state, only the following transitions are possible:
-
-
- Receiving a HEADERS frame causes the stream to transition to
- "half closed (local)".
-
-
- Either endpoint can send a RST_STREAM frame to cause the stream
- to become "closed". This releases the stream reservation.
-
-
-
-
- An endpoint MAY send a PRIORITY frame in this state to reprioritize
- the reserved stream. An endpoint MUST NOT send any type of frame other than
- RST_STREAM, WINDOW_UPDATE, or PRIORITY
- in this state.
-
-
- Receiving any type of frame other than HEADERS or
- RST_STREAM on a stream in this state MUST be treated as a connection error of type
- PROTOCOL_ERROR.
-
-
-
-
-
-
- A stream in the "open" state may be used by both peers to send frames of any type.
- In this state, sending peers observe advertised stream
- level flow control limits.
-
-
- From this state either endpoint can send a frame with an END_STREAM flag set, which
- causes the stream to transition into one of the "half closed" states: an endpoint
- sending an END_STREAM flag causes the stream state to become "half closed (local)";
- an endpoint receiving an END_STREAM flag causes the stream state to become "half
- closed (remote)".
-
-
- Either endpoint can send a RST_STREAM frame from this state, causing
- it to transition immediately to "closed".
-
-
-
-
-
-
- A stream that is in the "half closed (local)" state cannot be used for sending
- frames. Only WINDOW_UPDATE, PRIORITY and
- RST_STREAM frames can be sent in this state.
-
-
- A stream transitions from this state to "closed" when a frame that contains an
- END_STREAM flag is received, or when either peer sends a RST_STREAM
- frame.
-
-
- A receiver can ignore WINDOW_UPDATE frames in this state, which might
- arrive for a short period after a frame bearing the END_STREAM flag is sent.
-
-
- PRIORITY frames received in this state are used to reprioritize
- streams that depend on the current stream.
-
-
-
-
-
-
- A stream that is "half closed (remote)" is no longer being used by the peer to send
- frames. In this state, an endpoint is no longer obligated to maintain a receiver
- flow control window if it performs flow control.
-
-
- If an endpoint receives additional frames for a stream that is in this state, other
- than WINDOW_UPDATE, PRIORITY or
- RST_STREAM, it MUST respond with a stream error of type
- STREAM_CLOSED.
-
-
- A stream that is "half closed (remote)" can be used by the endpoint to send frames
- of any type. In this state, the endpoint continues to observe advertised stream level flow control limits.
-
-
- A stream can transition from this state to "closed" by sending a frame that contains
- an END_STREAM flag, or when either peer sends a RST_STREAM frame.
-
-
-
-
-
-
- The "closed" state is the terminal state.
-
-
- An endpoint MUST NOT send frames other than PRIORITY on a closed
- stream. An endpoint that receives any frame other than PRIORITY
- after receiving a RST_STREAM MUST treat that as a stream error of type
- STREAM_CLOSED. Similarly, an endpoint that receives any frames after
- receiving a frame with the END_STREAM flag set MUST treat that as a connection error of type
- STREAM_CLOSED, unless the frame is permitted as described below.
-
-
- WINDOW_UPDATE or RST_STREAM frames can be received in
- this state for a short period after a DATA or HEADERS
- frame containing an END_STREAM flag is sent. Until the remote peer receives and
- processes RST_STREAM or the frame bearing the END_STREAM flag, it
- might send frames of these types. Endpoints MUST ignore
- WINDOW_UPDATE or RST_STREAM frames received in this
- state, though endpoints MAY choose to treat frames that arrive a significant time
- after sending END_STREAM as a connection
- error of type PROTOCOL_ERROR.
-
-
- PRIORITY frames can be sent on closed streams to prioritize streams
- that are dependent on the closed stream. Endpoints SHOULD process
- PRIORITY frame, though they can be ignored if the stream has been
- removed from the dependency tree (see ).
-
-
- If this state is reached as a result of sending a RST_STREAM frame,
- the peer that receives the RST_STREAM might have already sent - or
- enqueued for sending - frames on the stream that cannot be withdrawn. An endpoint
- MUST ignore frames that it receives on closed streams after it has sent a
- RST_STREAM frame. An endpoint MAY choose to limit the period over
- which it ignores frames and treat frames that arrive after this time as being in
- error.
-
-
- Flow controlled frames (i.e., DATA) received after sending
- RST_STREAM are counted toward the connection flow control window.
- Even though these frames might be ignored, because they are sent before the sender
- receives the RST_STREAM, the sender will consider the frames to count
- against the flow control window.
-
-
- An endpoint might receive a PUSH_PROMISE frame after it sends
- RST_STREAM. PUSH_PROMISE causes a stream to become
- "reserved" even if the associated stream has been reset. Therefore, a
- RST_STREAM is needed to close an unwanted promised stream.
-
-
-
-
-
- In the absence of more specific guidance elsewhere in this document, implementations
- SHOULD treat the receipt of a frame that is not expressly permitted in the description of
- a state as a connection error of type
- PROTOCOL_ERROR. Frame of unknown types are ignored.
-
-
- An example of the state transitions for an HTTP request/response exchange can be found in
- . An example of the state transitions for server push can be
- found in and .
-
-
-
-
- Streams are identified with an unsigned 31-bit integer. Streams initiated by a client
- MUST use odd-numbered stream identifiers; those initiated by the server MUST use
- even-numbered stream identifiers. A stream identifier of zero (0x0) is used for
- connection control messages; the stream identifier zero cannot be used to establish a
- new stream.
-
-
- HTTP/1.1 requests that are upgraded to HTTP/2 (see ) are
- responded to with a stream identifier of one (0x1). After the upgrade
- completes, stream 0x1 is "half closed (local)" to the client. Therefore, stream 0x1
- cannot be selected as a new stream identifier by a client that upgrades from HTTP/1.1.
-
-
- The identifier of a newly established stream MUST be numerically greater than all
- streams that the initiating endpoint has opened or reserved. This governs streams that
- are opened using a HEADERS frame and streams that are reserved using
- PUSH_PROMISE. An endpoint that receives an unexpected stream identifier
- MUST respond with a connection error of
- type PROTOCOL_ERROR.
-
-
- The first use of a new stream identifier implicitly closes all streams in the "idle"
- state that might have been initiated by that peer with a lower-valued stream identifier.
- For example, if a client sends a HEADERS frame on stream 7 without ever
- sending a frame on stream 5, then stream 5 transitions to the "closed" state when the
- first frame for stream 7 is sent or received.
-
-
- Stream identifiers cannot be reused. Long-lived connections can result in an endpoint
- exhausting the available range of stream identifiers. A client that is unable to
- establish a new stream identifier can establish a new connection for new streams. A
- server that is unable to establish a new stream identifier can send a
- GOAWAY frame so that the client is forced to open a new connection for
- new streams.
-
-
-
-
-
- A peer can limit the number of concurrently active streams using the
- SETTINGS_MAX_CONCURRENT_STREAMS parameter (see ) within a SETTINGS frame. The maximum concurrent
- streams setting is specific to each endpoint and applies only to the peer that receives
- the setting. That is, clients specify the maximum number of concurrent streams the
- server can initiate, and servers specify the maximum number of concurrent streams the
- client can initiate.
-
-
- Streams that are in the "open" state, or either of the "half closed" states count toward
- the maximum number of streams that an endpoint is permitted to open. Streams in any of
- these three states count toward the limit advertised in the
- SETTINGS_MAX_CONCURRENT_STREAMS setting. Streams in either of the
- "reserved" states do not count toward the stream limit.
-
-
- Endpoints MUST NOT exceed the limit set by their peer. An endpoint that receives a
- HEADERS frame that causes their advertised concurrent stream limit to be
- exceeded MUST treat this as a stream error. An
- endpoint that wishes to reduce the value of
- SETTINGS_MAX_CONCURRENT_STREAMS to a value that is below the current
- number of open streams can either close streams that exceed the new value or allow
- streams to complete.
-
-
-
-
-
-
- Using streams for multiplexing introduces contention over use of the TCP connection,
- resulting in blocked streams. A flow control scheme ensures that streams on the same
- connection do not destructively interfere with each other. Flow control is used for both
- individual streams and for the connection as a whole.
-
-
- HTTP/2 provides for flow control through use of the WINDOW_UPDATE frame.
-
-
-
-
- HTTP/2 stream flow control aims to allow a variety of flow control algorithms to be
- used without requiring protocol changes. Flow control in HTTP/2 has the following
- characteristics:
-
-
- Flow control is specific to a connection; i.e., it is "hop-by-hop", not
- "end-to-end".
-
-
- Flow control is based on window update frames. Receivers advertise how many octets
- they are prepared to receive on a stream and for the entire connection. This is a
- credit-based scheme.
-
-
- Flow control is directional with overall control provided by the receiver. A
- receiver MAY choose to set any window size that it desires for each stream and for
- the entire connection. A sender MUST respect flow control limits imposed by a
- receiver. Clients, servers and intermediaries all independently advertise their
- flow control window as a receiver and abide by the flow control limits set by
- their peer when sending.
-
-
- The initial value for the flow control window is 65,535 octets for both new streams
- and the overall connection.
-
-
- The frame type determines whether flow control applies to a frame. Of the frames
- specified in this document, only DATA frames are subject to flow
- control; all other frame types do not consume space in the advertised flow control
- window. This ensures that important control frames are not blocked by flow control.
-
-
- Flow control cannot be disabled.
-
-
- HTTP/2 defines only the format and semantics of the WINDOW_UPDATE
- frame (). This document does not stipulate how a
- receiver decides when to send this frame or the value that it sends, nor does it
- specify how a sender chooses to send packets. Implementations are able to select
- any algorithm that suits their needs.
-
-
-
-
- Implementations are also responsible for managing how requests and responses are sent
- based on priority; choosing how to avoid head of line blocking for requests; and
- managing the creation of new streams. Algorithm choices for these could interact with
- any flow control algorithm.
-
-
-
-
-
- Flow control is defined to protect endpoints that are operating under resource
- constraints. For example, a proxy needs to share memory between many connections, and
- also might have a slow upstream connection and a fast downstream one. Flow control
- addresses cases where the receiver is unable process data on one stream, yet wants to
- continue to process other streams in the same connection.
-
-
- Deployments that do not require this capability can advertise a flow control window of
- the maximum size, incrementing the available space when new data is received. This
- effectively disables flow control for that receiver. Conversely, a sender is always
- subject to the flow control window advertised by the receiver.
-
-
- Deployments with constrained resources (for example, memory) can employ flow control to
- limit the amount of memory a peer can consume. Note, however, that this can lead to
- suboptimal use of available network resources if flow control is enabled without
- knowledge of the bandwidth-delay product (see ).
-
-
- Even with full awareness of the current bandwidth-delay product, implementation of flow
- control can be difficult. When using flow control, the receiver MUST read from the TCP
- receive buffer in a timely fashion. Failure to do so could lead to a deadlock when
- critical frames, such as WINDOW_UPDATE, are not read and acted upon.
-
-
-
-
-
-
- A client can assign a priority for a new stream by including prioritization information in
- the HEADERS frame that opens the stream. For an existing
- stream, the PRIORITY frame can be used to change the
- priority.
-
-
- The purpose of prioritization is to allow an endpoint to express how it would prefer its
- peer allocate resources when managing concurrent streams. Most importantly, priority can
- be used to select streams for transmitting frames when there is limited capacity for
- sending.
-
-
- Streams can be prioritized by marking them as dependent on the completion of other streams
- (). Each dependency is assigned a relative weight, a number
- that is used to determine the relative proportion of available resources that are assigned
- to streams dependent on the same stream.
-
-
-
- Explicitly setting the priority for a stream is input to a prioritization process. It
- does not guarantee any particular processing or transmission order for the stream relative
- to any other stream. An endpoint cannot force a peer to process concurrent streams in a
- particular order using priority. Expressing priority is therefore only ever a suggestion.
-
-
- Providing prioritization information is optional, so default values are used if no
- explicit indicator is provided ().
-
-
-
-
- Each stream can be given an explicit dependency on another stream. Including a
- dependency expresses a preference to allocate resources to the identified stream rather
- than to the dependent stream.
-
-
- A stream that is not dependent on any other stream is given a stream dependency of 0x0.
- In other words, the non-existent stream 0 forms the root of the tree.
-
-
- A stream that depends on another stream is a dependent stream. The stream upon which a
- stream is dependent is a parent stream. A dependency on a stream that is not currently
- in the tree - such as a stream in the "idle" state - results in that stream being given
- a default priority.
-
-
- When assigning a dependency on another stream, the stream is added as a new dependency
- of the parent stream. Dependent streams that share the same parent are not ordered with
- respect to each other. For example, if streams B and C are dependent on stream A, and
- if stream D is created with a dependency on stream A, this results in a dependency order
- of A followed by B, C, and D in any order.
-
-
- /|\
- B C B D C
-]]>
-
-
- An exclusive flag allows for the insertion of a new level of dependencies. The
- exclusive flag causes the stream to become the sole dependency of its parent stream,
- causing other dependencies to become dependent on the exclusive stream. In the
- previous example, if stream D is created with an exclusive dependency on stream A, this
- results in D becoming the dependency parent of B and C.
-
-
- D
- B C / \
- B C
-]]>
-
-
- Inside the dependency tree, a dependent stream SHOULD only be allocated resources if all
- of the streams that it depends on (the chain of parent streams up to 0x0) are either
- closed, or it is not possible to make progress on them.
-
-
- A stream cannot depend on itself. An endpoint MUST treat this as a stream error of type PROTOCOL_ERROR.
-
-
-
-
-
- All dependent streams are allocated an integer weight between 1 and 256 (inclusive).
-
-
- Streams with the same parent SHOULD be allocated resources proportionally based on their
- weight. Thus, if stream B depends on stream A with weight 4, and C depends on stream A
- with weight 12, and if no progress can be made on A, stream B ideally receives one third
- of the resources allocated to stream C.
-
-
-
-
-
- Stream priorities are changed using the PRIORITY frame. Setting a
- dependency causes a stream to become dependent on the identified parent stream.
-
-
- Dependent streams move with their parent stream if the parent is reprioritized. Setting
- a dependency with the exclusive flag for a reprioritized stream moves all the
- dependencies of the new parent stream to become dependent on the reprioritized stream.
-
-
- If a stream is made dependent on one of its own dependencies, the formerly dependent
- stream is first moved to be dependent on the reprioritized stream's previous parent.
- The moved dependency retains its weight.
-
-
-
- For example, consider an original dependency tree where B and C depend on A, D and E
- depend on C, and F depends on D. If A is made dependent on D, then D takes the place
- of A. All other dependency relationships stay the same, except for F, which becomes
- dependent on A if the reprioritization is exclusive.
-
- F B C ==> F A OR A
- / \ | / \ /|\
- D E E B C B C F
- | | |
- F E E
- (intermediate) (non-exclusive) (exclusive)
-]]>
-
-
-
-
-
- When a stream is removed from the dependency tree, its dependencies can be moved to
- become dependent on the parent of the closed stream. The weights of new dependencies
- are recalculated by distributing the weight of the dependency of the closed stream
- proportionally based on the weights of its dependencies.
-
-
- Streams that are removed from the dependency tree cause some prioritization information
- to be lost. Resources are shared between streams with the same parent stream, which
- means that if a stream in that set closes or becomes blocked, any spare capacity
- allocated to a stream is distributed to the immediate neighbors of the stream. However,
- if the common dependency is removed from the tree, those streams share resources with
- streams at the next highest level.
-
-
- For example, assume streams A and B share a parent, and streams C and D both depend on
- stream A. Prior to the removal of stream A, if streams A and D are unable to proceed,
- then stream C receives all the resources dedicated to stream A. If stream A is removed
- from the tree, the weight of stream A is divided between streams C and D. If stream D
- is still unable to proceed, this results in stream C receiving a reduced proportion of
- resources. For equal starting weights, C receives one third, rather than one half, of
- available resources.
-
-
- It is possible for a stream to become closed while prioritization information that
- creates a dependency on that stream is in transit. If a stream identified in a
- dependency has no associated priority information, then the dependent stream is instead
- assigned a default priority. This potentially creates
- suboptimal prioritization, since the stream could be given a priority that is different
- to what is intended.
-
-
- To avoid these problems, an endpoint SHOULD retain stream prioritization state for a
- period after streams become closed. The longer state is retained, the lower the chance
- that streams are assigned incorrect or default priority values.
-
-
- This could create a large state burden for an endpoint, so this state MAY be limited.
- An endpoint MAY apply a fixed upper limit on the number of closed streams for which
- prioritization state is tracked to limit state exposure. The amount of additional state
- an endpoint maintains could be dependent on load; under high load, prioritization state
- can be discarded to limit resource commitments. In extreme cases, an endpoint could
- even discard prioritization state for active or reserved streams. If a fixed limit is
- applied, endpoints SHOULD maintain state for at least as many streams as allowed by
- their setting for SETTINGS_MAX_CONCURRENT_STREAMS.
-
-
- An endpoint receiving a PRIORITY frame that changes the priority of a
- closed stream SHOULD alter the dependencies of the streams that depend on it, if it has
- retained enough state to do so.
-
-
-
-
-
- Providing priority information is optional. Streams are assigned a non-exclusive
- dependency on stream 0x0 by default. Pushed streams
- initially depend on their associated stream. In both cases, streams are assigned a
- default weight of 16.
-
-
-
-
-
-
- HTTP/2 framing permits two classes of error:
-
-
- An error condition that renders the entire connection unusable is a connection error.
-
-
- An error in an individual stream is a stream error.
-
-
-
-
- A list of error codes is included in .
-
-
-
-
- A connection error is any error which prevents further processing of the framing layer,
- or which corrupts any connection state.
-
-
- An endpoint that encounters a connection error SHOULD first send a GOAWAY
- frame () with the stream identifier of the last stream that it
- successfully received from its peer. The GOAWAY frame includes an error
- code that indicates why the connection is terminating. After sending the
- GOAWAY frame, the endpoint MUST close the TCP connection.
-
-
- It is possible that the GOAWAY will not be reliably received by the
- receiving endpoint (see ). In the event of a connection error,
- GOAWAY only provides a best effort attempt to communicate with the peer
- about why the connection is being terminated.
-
-
- An endpoint can end a connection at any time. In particular, an endpoint MAY choose to
- treat a stream error as a connection error. Endpoints SHOULD send a
- GOAWAY frame when ending a connection, providing that circumstances
- permit it.
-
-
-
-
-
- A stream error is an error related to a specific stream that does not affect processing
- of other streams.
-
-
- An endpoint that detects a stream error sends a RST_STREAM frame () that contains the stream identifier of the stream where the error
- occurred. The RST_STREAM frame includes an error code that indicates the
- type of error.
-
-
- A RST_STREAM is the last frame that an endpoint can send on a stream.
- The peer that sends the RST_STREAM frame MUST be prepared to receive any
- frames that were sent or enqueued for sending by the remote peer. These frames can be
- ignored, except where they modify connection state (such as the state maintained for
- header compression, or flow control).
-
-
- Normally, an endpoint SHOULD NOT send more than one RST_STREAM frame for
- any stream. However, an endpoint MAY send additional RST_STREAM frames if
- it receives frames on a closed stream after more than a round-trip time. This behavior
- is permitted to deal with misbehaving implementations.
-
-
- An endpoint MUST NOT send a RST_STREAM in response to an
- RST_STREAM frame, to avoid looping.
-
-
-
-
-
- If the TCP connection is closed or reset while streams remain in open or half closed
- states, then the endpoint MUST assume that those streams were abnormally interrupted and
- could be incomplete.
-
-
-
-
-
-
- HTTP/2 permits extension of the protocol. Protocol extensions can be used to provide
- additional services or alter any aspect of the protocol, within the limitations described
- in this section. Extensions are effective only within the scope of a single HTTP/2
- connection.
-
-
- Extensions are permitted to use new frame types, new
- settings, or new error
- codes. Registries are established for managing these extension points: frame types, settings and
- error codes.
-
-
- Implementations MUST ignore unknown or unsupported values in all extensible protocol
- elements. Implementations MUST discard frames that have unknown or unsupported types.
- This means that any of these extension points can be safely used by extensions without
- prior arrangement or negotiation. However, extension frames that appear in the middle of
- a header block are not permitted; these MUST be treated
- as a connection error of type
- PROTOCOL_ERROR.
-
-
- However, extensions that could change the semantics of existing protocol components MUST
- be negotiated before being used. For example, an extension that changes the layout of the
- HEADERS frame cannot be used until the peer has given a positive signal
- that this is acceptable. In this case, it could also be necessary to coordinate when the
- revised layout comes into effect. Note that treating any frame other than
- DATA frames as flow controlled is such a change in semantics, and can only
- be done through negotiation.
-
-
- This document doesn't mandate a specific method for negotiating the use of an extension,
- but notes that a setting could be used for that
- purpose. If both peers set a value that indicates willingness to use the extension, then
- the extension can be used. If a setting is used for extension negotiation, the initial
- value MUST be defined so that the extension is initially disabled.
-
-
-
-
-
-
- This specification defines a number of frame types, each identified by a unique 8-bit type
- code. Each frame type serves a distinct purpose either in the establishment and management
- of the connection as a whole, or of individual streams.
-
-
- The transmission of specific frame types can alter the state of a connection. If endpoints
- fail to maintain a synchronized view of the connection state, successful communication
- within the connection will no longer be possible. Therefore, it is important that endpoints
- have a shared comprehension of how the state is affected by the use any given frame.
-
-
-
-
- DATA frames (type=0x0) convey arbitrary, variable-length sequences of octets associated
- with a stream. One or more DATA frames are used, for instance, to carry HTTP request or
- response payloads.
-
-
- DATA frames MAY also contain arbitrary padding. Padding can be added to DATA frames to
- obscure the size of messages.
-
-
-
-
-
- The DATA frame contains the following fields:
-
-
- An 8-bit field containing the length of the frame padding in units of octets. This
- field is optional and is only present if the PADDED flag is set.
-
-
- Application data. The amount of data is the remainder of the frame payload after
- subtracting the length of the other fields that are present.
-
-
- Padding octets that contain no application semantic value. Padding octets MUST be set
- to zero when sending and ignored when receiving.
-
-
-
-
-
- The DATA frame defines the following flags:
-
-
- Bit 1 being set indicates that this frame is the last that the endpoint will send for
- the identified stream. Setting this flag causes the stream to enter one of the "half closed" states or the "closed" state.
-
-
- Bit 4 being set indicates that the Pad Length field and any padding that it describes
- is present.
-
-
-
-
- DATA frames MUST be associated with a stream. If a DATA frame is received whose stream
- identifier field is 0x0, the recipient MUST respond with a connection error of type
- PROTOCOL_ERROR.
-
-
- DATA frames are subject to flow control and can only be sent when a stream is in the
- "open" or "half closed (remote)" states. The entire DATA frame payload is included in flow
- control, including Pad Length and Padding fields if present. If a DATA frame is received
- whose stream is not in "open" or "half closed (local)" state, the recipient MUST respond
- with a stream error of type
- STREAM_CLOSED.
-
-
- The total number of padding octets is determined by the value of the Pad Length field. If
- the length of the padding is greater than the length of the frame payload, the recipient
- MUST treat this as a connection error of
- type PROTOCOL_ERROR.
-
-
- A frame can be increased in size by one octet by including a Pad Length field with a
- value of zero.
-
-
-
-
- Padding is a security feature; see .
-
-
-
-
-
- The HEADERS frame (type=0x1) is used to open a stream,
- and additionally carries a header block fragment. HEADERS frames can be sent on a stream
- in the "open" or "half closed (remote)" states.
-
-
-
-
-
- The HEADERS frame payload has the following fields:
-
-
- An 8-bit field containing the length of the frame padding in units of octets. This
- field is only present if the PADDED flag is set.
-
-
- A single bit flag indicates that the stream dependency is exclusive, see . This field is only present if the PRIORITY flag is set.
-
-
- A 31-bit stream identifier for the stream that this stream depends on, see . This field is only present if the PRIORITY flag is set.
-
-
- An 8-bit weight for the stream, see . Add one to the
- value to obtain a weight between 1 and 256. This field is only present if the
- PRIORITY flag is set.
-
-
- A header block fragment.
-
-
- Padding octets that contain no application semantic value. Padding octets MUST be set
- to zero when sending and ignored when receiving.
-
-
-
-
-
- The HEADERS frame defines the following flags:
-
-
-
- Bit 1 being set indicates that the header block is
- the last that the endpoint will send for the identified stream. Setting this flag
- causes the stream to enter one of "half closed"
- states.
-
-
- A HEADERS frame carries the END_STREAM flag that signals the end of a stream.
- However, a HEADERS frame with the END_STREAM flag set can be followed by
- CONTINUATION frames on the same stream. Logically, the
- CONTINUATION frames are part of the HEADERS frame.
-
-
-
-
- Bit 3 being set indicates that this frame contains an entire header block and is not followed by any
- CONTINUATION frames.
-
-
- A HEADERS frame without the END_HEADERS flag set MUST be followed by a
- CONTINUATION frame for the same stream. A receiver MUST treat the
- receipt of any other type of frame or a frame on a different stream as a connection error of type
- PROTOCOL_ERROR.
-
-
-
-
- Bit 4 being set indicates that the Pad Length field and any padding that it
- describes is present.
-
-
-
-
- Bit 6 being set indicates that the Exclusive Flag (E), Stream Dependency, and Weight
- fields are present; see .
-
-
-
-
-
-
- The payload of a HEADERS frame contains a header block
- fragment. A header block that does not fit within a HEADERS frame is continued in
- a CONTINUATION frame.
-
-
-
- HEADERS frames MUST be associated with a stream. If a HEADERS frame is received whose
- stream identifier field is 0x0, the recipient MUST respond with a connection error of type
- PROTOCOL_ERROR.
-
-
-
- The HEADERS frame changes the connection state as described in .
-
-
-
- The HEADERS frame includes optional padding. Padding fields and flags are identical to
- those defined for DATA frames.
-
-
- Prioritization information in a HEADERS frame is logically equivalent to a separate
- PRIORITY frame, but inclusion in HEADERS avoids the potential for churn in
- stream prioritization when new streams are created. Priorization fields in HEADERS frames
- subsequent to the first on a stream reprioritize the
- stream.
-
-
-
-
-
- The PRIORITY frame (type=0x2) specifies the sender-advised
- priority of a stream. It can be sent at any time for an existing stream, including
- closed streams. This enables reprioritization of existing streams.
-
-
-
-
-
- The payload of a PRIORITY frame contains the following fields:
-
-
- A single bit flag indicates that the stream dependency is exclusive, see .
-
-
- A 31-bit stream identifier for the stream that this stream depends on, see .
-
-
- An 8-bit weight for the identified stream dependency, see . Add one to the value to obtain a weight between 1 and 256.
-
-
-
-
-
- The PRIORITY frame does not define any flags.
-
-
-
- The PRIORITY frame is associated with an existing stream. If a PRIORITY frame is received
- with a stream identifier of 0x0, the recipient MUST respond with a connection error of type
- PROTOCOL_ERROR.
-
-
- The PRIORITY frame can be sent on a stream in any of the "reserved (remote)", "open",
- "half closed (local)", "half closed (remote)", or "closed" states, though it cannot be
- sent between consecutive frames that comprise a single header
- block. Note that this frame could arrive after processing or frame sending has
- completed, which would cause it to have no effect on the current stream. For a stream
- that is in the "half closed (remote)" or "closed" - state, this frame can only affect
- processing of the current stream and not frame transmission.
-
-
- The PRIORITY frame is the only frame that can be sent for a stream in the "closed" state.
- This allows for the reprioritization of a group of dependent streams by altering the
- priority of a parent stream, which might be closed. However, a PRIORITY frame sent on a
- closed stream risks being ignored due to the peer having discarded priority state
- information for that stream.
-
-
-
-
-
- The RST_STREAM frame (type=0x3) allows for abnormal termination of a stream. When sent by
- the initiator of a stream, it indicates that they wish to cancel the stream or that an
- error condition has occurred. When sent by the receiver of a stream, it indicates that
- either the receiver is rejecting the stream, requesting that the stream be cancelled, or
- that an error condition has occurred.
-
-
-
-
-
-
- The RST_STREAM frame contains a single unsigned, 32-bit integer identifying the error code. The error code indicates why the stream is being
- terminated.
-
-
-
- The RST_STREAM frame does not define any flags.
-
-
-
- The RST_STREAM frame fully terminates the referenced stream and causes it to enter the
- closed state. After receiving a RST_STREAM on a stream, the receiver MUST NOT send
- additional frames for that stream, with the exception of PRIORITY. However,
- after sending the RST_STREAM, the sending endpoint MUST be prepared to receive and process
- additional frames sent on the stream that might have been sent by the peer prior to the
- arrival of the RST_STREAM.
-
-
-
- RST_STREAM frames MUST be associated with a stream. If a RST_STREAM frame is received
- with a stream identifier of 0x0, the recipient MUST treat this as a connection error of type
- PROTOCOL_ERROR.
-
-
-
- RST_STREAM frames MUST NOT be sent for a stream in the "idle" state. If a RST_STREAM
- frame identifying an idle stream is received, the recipient MUST treat this as a connection error of type
- PROTOCOL_ERROR.
-
-
-
-
-
-
- The SETTINGS frame (type=0x4) conveys configuration parameters that affect how endpoints
- communicate, such as preferences and constraints on peer behavior. The SETTINGS frame is
- also used to acknowledge the receipt of those parameters. Individually, a SETTINGS
- parameter can also be referred to as a "setting".
-
-
- SETTINGS parameters are not negotiated; they describe characteristics of the sending peer,
- which are used by the receiving peer. Different values for the same parameter can be
- advertised by each peer. For example, a client might set a high initial flow control
- window, whereas a server might set a lower value to conserve resources.
-
-
-
- A SETTINGS frame MUST be sent by both endpoints at the start of a connection, and MAY be
- sent at any other time by either endpoint over the lifetime of the connection.
- Implementations MUST support all of the parameters defined by this specification.
-
-
-
- Each parameter in a SETTINGS frame replaces any existing value for that parameter.
- Parameters are processed in the order in which they appear, and a receiver of a SETTINGS
- frame does not need to maintain any state other than the current value of its
- parameters. Therefore, the value of a SETTINGS parameter is the last value that is seen by
- a receiver.
-
-
- SETTINGS parameters are acknowledged by the receiving peer. To enable this, the SETTINGS
- frame defines the following flag:
-
-
- Bit 1 being set indicates that this frame acknowledges receipt and application of the
- peer's SETTINGS frame. When this bit is set, the payload of the SETTINGS frame MUST
- be empty. Receipt of a SETTINGS frame with the ACK flag set and a length field value
- other than 0 MUST be treated as a connection
- error of type FRAME_SIZE_ERROR. For more info, see Settings Synchronization.
-
-
-
-
- SETTINGS frames always apply to a connection, never a single stream. The stream
- identifier for a SETTINGS frame MUST be zero (0x0). If an endpoint receives a SETTINGS
- frame whose stream identifier field is anything other than 0x0, the endpoint MUST respond
- with a connection error of type
- PROTOCOL_ERROR.
-
-
- The SETTINGS frame affects connection state. A badly formed or incomplete SETTINGS frame
- MUST be treated as a connection error of type
- PROTOCOL_ERROR.
-
-
-
-
- The payload of a SETTINGS frame consists of zero or more parameters, each consisting of
- an unsigned 16-bit setting identifier and an unsigned 32-bit value.
-
-
-
-
-
-
-
-
-
- The following parameters are defined:
-
-
-
- Allows the sender to inform the remote endpoint of the maximum size of the header
- compression table used to decode header blocks, in octets. The encoder can select
- any size equal to or less than this value by using signaling specific to the
- header compression format inside a header block. The initial value is 4,096
- octets.
-
-
-
-
- This setting can be use to disable server
- push. An endpoint MUST NOT send a PUSH_PROMISE frame if it
- receives this parameter set to a value of 0. An endpoint that has both set this
- parameter to 0 and had it acknowledged MUST treat the receipt of a
- PUSH_PROMISE frame as a connection error of type
- PROTOCOL_ERROR.
-
-
- The initial value is 1, which indicates that server push is permitted. Any value
- other than 0 or 1 MUST be treated as a connection error of type
- PROTOCOL_ERROR.
-
-
-
-
- Indicates the maximum number of concurrent streams that the sender will allow.
- This limit is directional: it applies to the number of streams that the sender
- permits the receiver to create. Initially there is no limit to this value. It is
- recommended that this value be no smaller than 100, so as to not unnecessarily
- limit parallelism.
-
-
- A value of 0 for SETTINGS_MAX_CONCURRENT_STREAMS SHOULD NOT be treated as special
- by endpoints. A zero value does prevent the creation of new streams, however this
- can also happen for any limit that is exhausted with active streams. Servers
- SHOULD only set a zero value for short durations; if a server does not wish to
- accept requests, closing the connection could be preferable.
-
-
-
-
- Indicates the sender's initial window size (in octets) for stream level flow
- control. The initial value is 216-1 (65,535) octets.
-
-
- This setting affects the window size of all streams, including existing streams,
- see .
-
-
- Values above the maximum flow control window size of 231-1 MUST
- be treated as a connection error of
- type FLOW_CONTROL_ERROR.
-
-
-
-
- Indicates the size of the largest frame payload that the sender is willing to
- receive, in octets.
-
-
- The initial value is 214 (16,384) octets. The value advertised by
- an endpoint MUST be between this initial value and the maximum allowed frame size
- (224-1 or 16,777,215 octets), inclusive. Values outside this range
- MUST be treated as a connection error
- of type PROTOCOL_ERROR.
-
-
-
-
- This advisory setting informs a peer of the maximum size of header list that the
- sender is prepared to accept, in octets. The value is based on the uncompressed
- size of header fields, including the length of the name and value in octets plus
- an overhead of 32 octets for each header field.
-
-
- For any given request, a lower limit than what is advertised MAY be enforced. The
- initial value of this setting is unlimited.
-
-
-
-
-
- An endpoint that receives a SETTINGS frame with any unknown or unsupported identifier
- MUST ignore that setting.
-
-
-
-
-
- Most values in SETTINGS benefit from or require an understanding of when the peer has
- received and applied the changed parameter values. In order to provide
- such synchronization timepoints, the recipient of a SETTINGS frame in which the ACK flag
- is not set MUST apply the updated parameters as soon as possible upon receipt.
-
-
- The values in the SETTINGS frame MUST be processed in the order they appear, with no
- other frame processing between values. Unsupported parameters MUST be ignored. Once
- all values have been processed, the recipient MUST immediately emit a SETTINGS frame
- with the ACK flag set. Upon receiving a SETTINGS frame with the ACK flag set, the sender
- of the altered parameters can rely on the setting having been applied.
-
-
- If the sender of a SETTINGS frame does not receive an acknowledgement within a
- reasonable amount of time, it MAY issue a connection error of type
- SETTINGS_TIMEOUT.
-
-
-
-
-
-
- The PUSH_PROMISE frame (type=0x5) is used to notify the peer endpoint in advance of
- streams the sender intends to initiate. The PUSH_PROMISE frame includes the unsigned
- 31-bit identifier of the stream the endpoint plans to create along with a set of headers
- that provide additional context for the stream. contains a
- thorough description of the use of PUSH_PROMISE frames.
-
-
-
-
-
-
- The PUSH_PROMISE frame payload has the following fields:
-
-
- An 8-bit field containing the length of the frame padding in units of octets. This
- field is only present if the PADDED flag is set.
-
-
- A single reserved bit.
-
-
- An unsigned 31-bit integer that identifies the stream that is reserved by the
- PUSH_PROMISE. The promised stream identifier MUST be a valid choice for the next
- stream sent by the sender (see new stream
- identifier).
-
-
- A header block fragment containing request header
- fields.
-
-
- Padding octets.
-
-
-
-
-
- The PUSH_PROMISE frame defines the following flags:
-
-
-
- Bit 3 being set indicates that this frame contains an entire header block and is not followed by any
- CONTINUATION frames.
-
-
- A PUSH_PROMISE frame without the END_HEADERS flag set MUST be followed by a
- CONTINUATION frame for the same stream. A receiver MUST treat the receipt of any
- other type of frame or a frame on a different stream as a connection error of type
- PROTOCOL_ERROR.
-
-
-
-
- Bit 4 being set indicates that the Pad Length field and any padding that it
- describes is present.
-
-
-
-
-
-
- PUSH_PROMISE frames MUST be associated with an existing, peer-initiated stream. The stream
- identifier of a PUSH_PROMISE frame indicates the stream it is associated with. If the
- stream identifier field specifies the value 0x0, a recipient MUST respond with a connection error of type
- PROTOCOL_ERROR.
-
-
-
- Promised streams are not required to be used in the order they are promised. The
- PUSH_PROMISE only reserves stream identifiers for later use.
-
-
-
- PUSH_PROMISE MUST NOT be sent if the SETTINGS_ENABLE_PUSH setting of the
- peer endpoint is set to 0. An endpoint that has set this setting and has received
- acknowledgement MUST treat the receipt of a PUSH_PROMISE frame as a connection error of type
- PROTOCOL_ERROR.
-
-
- Recipients of PUSH_PROMISE frames can choose to reject promised streams by returning a
- RST_STREAM referencing the promised stream identifier back to the sender of
- the PUSH_PROMISE.
-
-
-
- A PUSH_PROMISE frame modifies the connection state in two ways. The inclusion of a header block potentially modifies the state maintained for
- header compression. PUSH_PROMISE also reserves a stream for later use, causing the
- promised stream to enter the "reserved" state. A sender MUST NOT send a PUSH_PROMISE on a
- stream unless that stream is either "open" or "half closed (remote)"; the sender MUST
- ensure that the promised stream is a valid choice for a new stream identifier (that is, the promised stream MUST
- be in the "idle" state).
-
-
- Since PUSH_PROMISE reserves a stream, ignoring a PUSH_PROMISE frame causes the stream
- state to become indeterminate. A receiver MUST treat the receipt of a PUSH_PROMISE on a
- stream that is neither "open" nor "half closed (local)" as a connection error of type
- PROTOCOL_ERROR. However, an endpoint that has sent
- RST_STREAM on the associated stream MUST handle PUSH_PROMISE frames that
- might have been created before the RST_STREAM frame is received and
- processed.
-
-
- A receiver MUST treat the receipt of a PUSH_PROMISE that promises an illegal stream identifier (that is, an identifier for a
- stream that is not currently in the "idle" state) as a connection error of type
- PROTOCOL_ERROR.
-
-
-
- The PUSH_PROMISE frame includes optional padding. Padding fields and flags are identical
- to those defined for DATA frames.
-
-
-
-
-
- The PING frame (type=0x6) is a mechanism for measuring a minimal round trip time from the
- sender, as well as determining whether an idle connection is still functional. PING
- frames can be sent from any endpoint.
-
-
-
-
-
-
- In addition to the frame header, PING frames MUST contain 8 octets of data in the payload.
- A sender can include any value it chooses and use those bytes in any fashion.
-
-
- Receivers of a PING frame that does not include an ACK flag MUST send a PING frame with
- the ACK flag set in response, with an identical payload. PING responses SHOULD be given
- higher priority than any other frame.
-
-
-
- The PING frame defines the following flags:
-
-
- Bit 1 being set indicates that this PING frame is a PING response. An endpoint MUST
- set this flag in PING responses. An endpoint MUST NOT respond to PING frames
- containing this flag.
-
-
-
-
- PING frames are not associated with any individual stream. If a PING frame is received
- with a stream identifier field value other than 0x0, the recipient MUST respond with a
- connection error of type
- PROTOCOL_ERROR.
-
-
- Receipt of a PING frame with a length field value other than 8 MUST be treated as a connection error of type
- FRAME_SIZE_ERROR.
-
-
-
-
-
-
- The GOAWAY frame (type=0x7) informs the remote peer to stop creating streams on this
- connection. GOAWAY can be sent by either the client or the server. Once sent, the sender
- will ignore frames sent on any new streams with identifiers higher than the included last
- stream identifier. Receivers of a GOAWAY frame MUST NOT open additional streams on the
- connection, although a new connection can be established for new streams.
-
-
- The purpose of this frame is to allow an endpoint to gracefully stop accepting new
- streams, while still finishing processing of previously established streams. This enables
- administrative actions, like server maintainance.
-
-
- There is an inherent race condition between an endpoint starting new streams and the
- remote sending a GOAWAY frame. To deal with this case, the GOAWAY contains the stream
- identifier of the last peer-initiated stream which was or might be processed on the
- sending endpoint in this connection. For instance, if the server sends a GOAWAY frame,
- the identified stream is the highest numbered stream initiated by the client.
-
-
- If the receiver of the GOAWAY has sent data on streams with a higher stream identifier
- than what is indicated in the GOAWAY frame, those streams are not or will not be
- processed. The receiver of the GOAWAY frame can treat the streams as though they had
- never been created at all, thereby allowing those streams to be retried later on a new
- connection.
-
-
- Endpoints SHOULD always send a GOAWAY frame before closing a connection so that the remote
- can know whether a stream has been partially processed or not. For example, if an HTTP
- client sends a POST at the same time that a server closes a connection, the client cannot
- know if the server started to process that POST request if the server does not send a
- GOAWAY frame to indicate what streams it might have acted on.
-
-
- An endpoint might choose to close a connection without sending GOAWAY for misbehaving
- peers.
-
-
-
-
-
-
- The GOAWAY frame does not define any flags.
-
-
- The GOAWAY frame applies to the connection, not a specific stream. An endpoint MUST treat
- a GOAWAY frame with a stream identifier other than 0x0 as a connection error of type
- PROTOCOL_ERROR.
-
-
- The last stream identifier in the GOAWAY frame contains the highest numbered stream
- identifier for which the sender of the GOAWAY frame might have taken some action on, or
- might yet take action on. All streams up to and including the identified stream might
- have been processed in some way. The last stream identifier can be set to 0 if no streams
- were processed.
-
-
- In this context, "processed" means that some data from the stream was passed to some
- higher layer of software that might have taken some action as a result.
-
-
- If a connection terminates without a GOAWAY frame, the last stream identifier is
- effectively the highest possible stream identifier.
-
-
- On streams with lower or equal numbered identifiers that were not closed completely prior
- to the connection being closed, re-attempting requests, transactions, or any protocol
- activity is not possible, with the exception of idempotent actions like HTTP GET, PUT, or
- DELETE. Any protocol activity that uses higher numbered streams can be safely retried
- using a new connection.
-
-
- Activity on streams numbered lower or equal to the last stream identifier might still
- complete successfully. The sender of a GOAWAY frame might gracefully shut down a
- connection by sending a GOAWAY frame, maintaining the connection in an open state until
- all in-progress streams complete.
-
-
- An endpoint MAY send multiple GOAWAY frames if circumstances change. For instance, an
- endpoint that sends GOAWAY with NO_ERROR during graceful shutdown could
- subsequently encounter an condition that requires immediate termination of the connection.
- The last stream identifier from the last GOAWAY frame received indicates which streams
- could have been acted upon. Endpoints MUST NOT increase the value they send in the last
- stream identifier, since the peers might already have retried unprocessed requests on
- another connection.
-
-
- A client that is unable to retry requests loses all requests that are in flight when the
- server closes the connection. This is especially true for intermediaries that might
- not be serving clients using HTTP/2. A server that is attempting to gracefully shut down
- a connection SHOULD send an initial GOAWAY frame with the last stream identifier set to
- 231-1 and a NO_ERROR code. This signals to the client that
- a shutdown is imminent and that no further requests can be initiated. After waiting at
- least one round trip time, the server can send another GOAWAY frame with an updated last
- stream identifier. This ensures that a connection can be cleanly shut down without losing
- requests.
-
-
-
- After sending a GOAWAY frame, the sender can discard frames for streams with identifiers
- higher than the identified last stream. However, any frames that alter connection state
- cannot be completely ignored. For instance, HEADERS,
- PUSH_PROMISE and CONTINUATION frames MUST be minimally
- processed to ensure the state maintained for header compression is consistent (see ); similarly DATA frames MUST be counted toward the connection flow
- control window. Failure to process these frames can cause flow control or header
- compression state to become unsynchronized.
-
-
-
- The GOAWAY frame also contains a 32-bit error code that
- contains the reason for closing the connection.
-
-
- Endpoints MAY append opaque data to the payload of any GOAWAY frame. Additional debug
- data is intended for diagnostic purposes only and carries no semantic value. Debug
- information could contain security- or privacy-sensitive data. Logged or otherwise
- persistently stored debug data MUST have adequate safeguards to prevent unauthorized
- access.
-
-
-
-
-
- The WINDOW_UPDATE frame (type=0x8) is used to implement flow control; see for an overview.
-
-
- Flow control operates at two levels: on each individual stream and on the entire
- connection.
-
-
- Both types of flow control are hop-by-hop; that is, only between the two endpoints.
- Intermediaries do not forward WINDOW_UPDATE frames between dependent connections.
- However, throttling of data transfer by any receiver can indirectly cause the propagation
- of flow control information toward the original sender.
-
-
- Flow control only applies to frames that are identified as being subject to flow control.
- Of the frame types defined in this document, this includes only DATA frames.
- Frames that are exempt from flow control MUST be accepted and processed, unless the
- receiver is unable to assign resources to handling the frame. A receiver MAY respond with
- a stream error or connection error of type
- FLOW_CONTROL_ERROR if it is unable to accept a frame.
-
-
-
-
-
- The payload of a WINDOW_UPDATE frame is one reserved bit, plus an unsigned 31-bit integer
- indicating the number of octets that the sender can transmit in addition to the existing
- flow control window. The legal range for the increment to the flow control window is 1 to
- 231-1 (0x7fffffff) octets.
-
-
- The WINDOW_UPDATE frame does not define any flags.
-
-
- The WINDOW_UPDATE frame can be specific to a stream or to the entire connection. In the
- former case, the frame's stream identifier indicates the affected stream; in the latter,
- the value "0" indicates that the entire connection is the subject of the frame.
-
-
- A receiver MUST treat the receipt of a WINDOW_UPDATE frame with an flow control window
- increment of 0 as a stream error of type
- PROTOCOL_ERROR; errors on the connection flow control window MUST be
- treated as a connection error.
-
-
- WINDOW_UPDATE can be sent by a peer that has sent a frame bearing the END_STREAM flag.
- This means that a receiver could receive a WINDOW_UPDATE frame on a "half closed (remote)"
- or "closed" stream. A receiver MUST NOT treat this as an error, see .
-
-
- A receiver that receives a flow controlled frame MUST always account for its contribution
- against the connection flow control window, unless the receiver treats this as a connection error. This is necessary even if the
- frame is in error. Since the sender counts the frame toward the flow control window, if
- the receiver does not, the flow control window at sender and receiver can become
- different.
-
-
-
-
- Flow control in HTTP/2 is implemented using a window kept by each sender on every
- stream. The flow control window is a simple integer value that indicates how many octets
- of data the sender is permitted to transmit; as such, its size is a measure of the
- buffering capacity of the receiver.
-
-
- Two flow control windows are applicable: the stream flow control window and the
- connection flow control window. The sender MUST NOT send a flow controlled frame with a
- length that exceeds the space available in either of the flow control windows advertised
- by the receiver. Frames with zero length with the END_STREAM flag set (that is, an
- empty DATA frame) MAY be sent if there is no available space in either
- flow control window.
-
-
- For flow control calculations, the 9 octet frame header is not counted.
-
-
- After sending a flow controlled frame, the sender reduces the space available in both
- windows by the length of the transmitted frame.
-
-
- The receiver of a frame sends a WINDOW_UPDATE frame as it consumes data and frees up
- space in flow control windows. Separate WINDOW_UPDATE frames are sent for the stream
- and connection level flow control windows.
-
-
- A sender that receives a WINDOW_UPDATE frame updates the corresponding window by the
- amount specified in the frame.
-
-
- A sender MUST NOT allow a flow control window to exceed 231-1 octets.
- If a sender receives a WINDOW_UPDATE that causes a flow control window to exceed this
- maximum it MUST terminate either the stream or the connection, as appropriate. For
- streams, the sender sends a RST_STREAM with the error code of
- FLOW_CONTROL_ERROR code; for the connection, a GOAWAY
- frame with a FLOW_CONTROL_ERROR code.
-
-
- Flow controlled frames from the sender and WINDOW_UPDATE frames from the receiver are
- completely asynchronous with respect to each other. This property allows a receiver to
- aggressively update the window size kept by the sender to prevent streams from stalling.
-
-
-
-
-
- When an HTTP/2 connection is first established, new streams are created with an initial
- flow control window size of 65,535 octets. The connection flow control window is 65,535
- octets. Both endpoints can adjust the initial window size for new streams by including
- a value for SETTINGS_INITIAL_WINDOW_SIZE in the SETTINGS
- frame that forms part of the connection preface. The connection flow control window can
- only be changed using WINDOW_UPDATE frames.
-
-
- Prior to receiving a SETTINGS frame that sets a value for
- SETTINGS_INITIAL_WINDOW_SIZE, an endpoint can only use the default
- initial window size when sending flow controlled frames. Similarly, the connection flow
- control window is set to the default initial window size until a WINDOW_UPDATE frame is
- received.
-
-
- A SETTINGS frame can alter the initial flow control window size for all
- current streams. When the value of SETTINGS_INITIAL_WINDOW_SIZE changes,
- a receiver MUST adjust the size of all stream flow control windows that it maintains by
- the difference between the new value and the old value.
-
-
- A change to SETTINGS_INITIAL_WINDOW_SIZE can cause the available space in
- a flow control window to become negative. A sender MUST track the negative flow control
- window, and MUST NOT send new flow controlled frames until it receives WINDOW_UPDATE
- frames that cause the flow control window to become positive.
-
-
- For example, if the client sends 60KB immediately on connection establishment, and the
- server sets the initial window size to be 16KB, the client will recalculate the
- available flow control window to be -44KB on receipt of the SETTINGS
- frame. The client retains a negative flow control window until WINDOW_UPDATE frames
- restore the window to being positive, after which the client can resume sending.
-
-
- A SETTINGS frame cannot alter the connection flow control window.
-
-
- An endpoint MUST treat a change to SETTINGS_INITIAL_WINDOW_SIZE that
- causes any flow control window to exceed the maximum size as a connection error of type
- FLOW_CONTROL_ERROR.
-
-
-
-
-
- A receiver that wishes to use a smaller flow control window than the current size can
- send a new SETTINGS frame. However, the receiver MUST be prepared to
- receive data that exceeds this window size, since the sender might send data that
- exceeds the lower limit prior to processing the SETTINGS frame.
-
-
- After sending a SETTINGS frame that reduces the initial flow control window size, a
- receiver has two options for handling streams that exceed flow control limits:
-
-
- The receiver can immediately send RST_STREAM with
- FLOW_CONTROL_ERROR error code for the affected streams.
-
-
- The receiver can accept the streams and tolerate the resulting head of line
- blocking, sending WINDOW_UPDATE frames as it consumes data.
-
-
-
-
-
-
-
-
- The CONTINUATION frame (type=0x9) is used to continue a sequence of header block fragments. Any number of CONTINUATION frames can
- be sent on an existing stream, as long as the preceding frame is on the same stream and is
- a HEADERS, PUSH_PROMISE or CONTINUATION frame without the
- END_HEADERS flag set.
-
-
-
-
-
-
- The CONTINUATION frame payload contains a header block
- fragment.
-
-
-
- The CONTINUATION frame defines the following flag:
-
-
-
- Bit 3 being set indicates that this frame ends a header
- block.
-
-
- If the END_HEADERS bit is not set, this frame MUST be followed by another
- CONTINUATION frame. A receiver MUST treat the receipt of any other type of frame or
- a frame on a different stream as a connection
- error of type PROTOCOL_ERROR.
-
-
-
-
-
-
- The CONTINUATION frame changes the connection state as defined in .
-
-
-
- CONTINUATION frames MUST be associated with a stream. If a CONTINUATION frame is received
- whose stream identifier field is 0x0, the recipient MUST respond with a connection error of type PROTOCOL_ERROR.
-
-
-
- A CONTINUATION frame MUST be preceded by a HEADERS,
- PUSH_PROMISE or CONTINUATION frame without the END_HEADERS flag set. A
- recipient that observes violation of this rule MUST respond with a connection error of type
- PROTOCOL_ERROR.
-
-
-
-
-
-
- Error codes are 32-bit fields that are used in RST_STREAM and
- GOAWAY frames to convey the reasons for the stream or connection error.
-
-
-
- Error codes share a common code space. Some error codes apply only to either streams or the
- entire connection and have no defined semantics in the other context.
-
-
-
- The following error codes are defined:
-
-
- The associated condition is not as a result of an error. For example, a
- GOAWAY might include this code to indicate graceful shutdown of a
- connection.
-
-
- The endpoint detected an unspecific protocol error. This error is for use when a more
- specific error code is not available.
-
-
- The endpoint encountered an unexpected internal error.
-
-
- The endpoint detected that its peer violated the flow control protocol.
-
-
- The endpoint sent a SETTINGS frame, but did not receive a response in a
- timely manner. See Settings Synchronization.
-
-
- The endpoint received a frame after a stream was half closed.
-
-
- The endpoint received a frame with an invalid size.
-
-
- The endpoint refuses the stream prior to performing any application processing, see
- for details.
-
-
- Used by the endpoint to indicate that the stream is no longer needed.
-
-
- The endpoint is unable to maintain the header compression context for the connection.
-
-
- The connection established in response to a CONNECT
- request was reset or abnormally closed.
-
-
- The endpoint detected that its peer is exhibiting a behavior that might be generating
- excessive load.
-
-
- The underlying transport has properties that do not meet minimum security
- requirements (see ).
-
-
-
-
- Unknown or unsupported error codes MUST NOT trigger any special behavior. These MAY be
- treated by an implementation as being equivalent to INTERNAL_ERROR.
-
-
-
-
-
- HTTP/2 is intended to be as compatible as possible with current uses of HTTP. This means
- that, from the application perspective, the features of the protocol are largely
- unchanged. To achieve this, all request and response semantics are preserved, although the
- syntax of conveying those semantics has changed.
-
-
- Thus, the specification and requirements of HTTP/1.1 Semantics and Content , Conditional Requests , Range Requests , Caching and Authentication are applicable to HTTP/2. Selected portions of HTTP/1.1 Message Syntax
- and Routing , such as the HTTP and HTTPS URI schemes, are also
- applicable in HTTP/2, but the expression of those semantics for this protocol are defined
- in the sections below.
-
-
-
-
- A client sends an HTTP request on a new stream, using a previously unused stream identifier. A server sends an HTTP response on
- the same stream as the request.
-
-
- An HTTP message (request or response) consists of:
-
-
- for a response only, zero or more HEADERS frames (each followed by zero
- or more CONTINUATION frames) containing the message headers of
- informational (1xx) HTTP responses (see and ),
- and
-
-
- one HEADERS frame (followed by zero or more CONTINUATION
- frames) containing the message headers (see ), and
-
-
- zero or more DATA frames containing the message payload (see ), and
-
-
- optionally, one HEADERS frame, followed by zero or more
- CONTINUATION frames containing the trailer-part, if present (see ).
-
-
- The last frame in the sequence bears an END_STREAM flag, noting that a
- HEADERS frame bearing the END_STREAM flag can be followed by
- CONTINUATION frames that carry any remaining portions of the header block.
-
-
- Other frames (from any stream) MUST NOT occur between either HEADERS frame
- and any CONTINUATION frames that might follow.
-
-
-
- Trailing header fields are carried in a header block that also terminates the stream.
- That is, a sequence starting with a HEADERS frame, followed by zero or more
- CONTINUATION frames, where the HEADERS frame bears an
- END_STREAM flag. Header blocks after the first that do not terminate the stream are not
- part of an HTTP request or response.
-
-
- A HEADERS frame (and associated CONTINUATION frames) can
- only appear at the start or end of a stream. An endpoint that receives a
- HEADERS frame without the END_STREAM flag set after receiving a final
- (non-informational) status code MUST treat the corresponding request or response as malformed.
-
-
-
- An HTTP request/response exchange fully consumes a single stream. A request starts with
- the HEADERS frame that puts the stream into an "open" state. The request
- ends with a frame bearing END_STREAM, which causes the stream to become "half closed
- (local)" for the client and "half closed (remote)" for the server. A response starts with
- a HEADERS frame and ends with a frame bearing END_STREAM, which places the
- stream in the "closed" state.
-
-
-
-
-
- HTTP/2 removes support for the 101 (Switching Protocols) informational status code
- ().
-
-
- The semantics of 101 (Switching Protocols) aren't applicable to a multiplexed protocol.
- Alternative protocols are able to use the same mechanisms that HTTP/2 uses to negotiate
- their use (see ).
-
-
-
-
-
- HTTP header fields carry information as a series of key-value pairs. For a listing of
- registered HTTP headers, see the Message Header Field Registry maintained at .
-
-
-
-
- While HTTP/1.x used the message start-line (see ) to convey the target URI and method of the request, and the
- status code for the response, HTTP/2 uses special pseudo-header fields beginning with
- ':' character (ASCII 0x3a) for this purpose.
-
-
- Pseudo-header fields are not HTTP header fields. Endpoints MUST NOT generate
- pseudo-header fields other than those defined in this document.
-
-
- Pseudo-header fields are only valid in the context in which they are defined.
- Pseudo-header fields defined for requests MUST NOT appear in responses; pseudo-header
- fields defined for responses MUST NOT appear in requests. Pseudo-header fields MUST
- NOT appear in trailers. Endpoints MUST treat a request or response that contains
- undefined or invalid pseudo-header fields as malformed.
-
-
- Just as in HTTP/1.x, header field names are strings of ASCII characters that are
- compared in a case-insensitive fashion. However, header field names MUST be converted
- to lowercase prior to their encoding in HTTP/2. A request or response containing
- uppercase header field names MUST be treated as malformed.
-
-
- All pseudo-header fields MUST appear in the header block before regular header fields.
- Any request or response that contains a pseudo-header field that appears in a header
- block after a regular header field MUST be treated as malformed.
-
-
-
-
-
- HTTP/2 does not use the Connection header field to
- indicate connection-specific header fields; in this protocol, connection-specific
- metadata is conveyed by other means. An endpoint MUST NOT generate a HTTP/2 message
- containing connection-specific header fields; any message containing
- connection-specific header fields MUST be treated as malformed.
-
-
- This means that an intermediary transforming an HTTP/1.x message to HTTP/2 will need
- to remove any header fields nominated by the Connection header field, along with the
- Connection header field itself. Such intermediaries SHOULD also remove other
- connection-specific header fields, such as Keep-Alive, Proxy-Connection,
- Transfer-Encoding and Upgrade, even if they are not nominated by Connection.
-
-
- One exception to this is the TE header field, which MAY be present in an HTTP/2
- request, but when it is MUST NOT contain any value other than "trailers".
-
-
-
-
- HTTP/2 purposefully does not support upgrade to another protocol. The handshake
- methods described in are believed sufficient to
- negotiate the use of alternative protocols.
-
-
-
-
-
-
-
- The following pseudo-header fields are defined for HTTP/2 requests:
-
-
-
- The :method pseudo-header field includes the HTTP
- method ().
-
-
-
-
- The :scheme pseudo-header field includes the scheme
- portion of the target URI ().
-
-
- :scheme is not restricted to http and https schemed URIs. A
- proxy or gateway can translate requests for non-HTTP schemes, enabling the use
- of HTTP to interact with non-HTTP services.
-
-
-
-
- The :authority pseudo-header field includes the
- authority portion of the target URI (). The authority MUST NOT include the deprecated userinfo subcomponent for http
- or https schemed URIs.
-
-
- To ensure that the HTTP/1.1 request line can be reproduced accurately, this
- pseudo-header field MUST be omitted when translating from an HTTP/1.1 request
- that has a request target in origin or asterisk form (see ). Clients that generate
- HTTP/2 requests directly SHOULD use the :authority pseudo-header
- field instead of the Host header field. An
- intermediary that converts an HTTP/2 request to HTTP/1.1 MUST create a Host header field if one is not present in a request by
- copying the value of the :authority pseudo-header
- field.
-
-
-
-
- The :path pseudo-header field includes the path and
- query parts of the target URI (the path-absolute
- production from and optionally a '?' character
- followed by the query production, see and ). A request in asterisk form includes the value '*' for the
- :path pseudo-header field.
-
-
- This pseudo-header field MUST NOT be empty for http
- or https URIs; http or
- https URIs that do not contain a path component
- MUST include a value of '/'. The exception to this rule is an OPTIONS request
- for an http or https
- URI that does not include a path component; these MUST include a :path pseudo-header field with a value of '*' (see ).
-
-
-
-
-
- All HTTP/2 requests MUST include exactly one valid value for the :method, :scheme, and :path pseudo-header fields, unless it is a CONNECT request. An HTTP request that omits mandatory
- pseudo-header fields is malformed.
-
-
- HTTP/2 does not define a way to carry the version identifier that is included in the
- HTTP/1.1 request line.
-
-
-
-
-
- For HTTP/2 responses, a single :status pseudo-header
- field is defined that carries the HTTP status code field (see ). This pseudo-header field MUST be included in all
- responses, otherwise the response is malformed.
-
-
- HTTP/2 does not define a way to carry the version or reason phrase that is included in
- an HTTP/1.1 status line.
-
-
-
-
-
- The Cookie header field can carry a significant amount of
- redundant data.
-
-
- The Cookie header field uses a semi-colon (";") to delimit cookie-pairs (or "crumbs").
- This header field doesn't follow the list construction rules in HTTP (see ), which prevents cookie-pairs from
- being separated into different name-value pairs. This can significantly reduce
- compression efficiency as individual cookie-pairs are updated.
-
-
- To allow for better compression efficiency, the Cookie header field MAY be split into
- separate header fields, each with one or more cookie-pairs. If there are multiple
- Cookie header fields after decompression, these MUST be concatenated into a single
- octet string using the two octet delimiter of 0x3B, 0x20 (the ASCII string "; ")
- before being passed into a non-HTTP/2 context, such as an HTTP/1.1 connection, or a
- generic HTTP server application.
-
-
-
- Therefore, the following two lists of Cookie header fields are semantically
- equivalent.
-
-
-
-
-
-
-
- A malformed request or response is one that is an otherwise valid sequence of HTTP/2
- frames, but is otherwise invalid due to the presence of extraneous frames, prohibited
- header fields, the absence of mandatory header fields, or the inclusion of uppercase
- header field names.
-
-
- A request or response that includes an entity body can include a content-length header field. A request or response is also
- malformed if the value of a content-length header field
- does not equal the sum of the DATA frame payload lengths that form the
- body. A response that is defined to have no payload, as described in , can have a non-zero
- content-length header field, even though no content is
- included in DATA frames.
-
-
- Intermediaries that process HTTP requests or responses (i.e., any intermediary not
- acting as a tunnel) MUST NOT forward a malformed request or response. Malformed
- requests or responses that are detected MUST be treated as a stream error of type PROTOCOL_ERROR.
-
-
- For malformed requests, a server MAY send an HTTP response prior to closing or
- resetting the stream. Clients MUST NOT accept a malformed response. Note that these
- requirements are intended to protect against several types of common attacks against
- HTTP; they are deliberately strict, because being permissive can expose
- implementations to these vulnerabilities.
-
-
-
-
-
-
- This section shows HTTP/1.1 requests and responses, with illustrations of equivalent
- HTTP/2 requests and responses.
-
-
- An HTTP GET request includes request header fields and no body and is therefore
- transmitted as a single HEADERS frame, followed by zero or more
- CONTINUATION frames containing the serialized block of request header
- fields. The HEADERS frame in the following has both the END_HEADERS and
- END_STREAM flags set; no CONTINUATION frames are sent:
-
-
-
- + END_STREAM
- Accept: image/jpeg + END_HEADERS
- :method = GET
- :scheme = https
- :path = /resource
- host = example.org
- accept = image/jpeg
-]]>
-
-
-
- Similarly, a response that includes only response header fields is transmitted as a
- HEADERS frame (again, followed by zero or more
- CONTINUATION frames) containing the serialized block of response header
- fields.
-
-
-
- + END_STREAM
- Expires: Thu, 23 Jan ... + END_HEADERS
- :status = 304
- etag = "xyzzy"
- expires = Thu, 23 Jan ...
-]]>
-
-
-
- An HTTP POST request that includes request header fields and payload data is transmitted
- as one HEADERS frame, followed by zero or more
- CONTINUATION frames containing the request header fields, followed by one
- or more DATA frames, with the last CONTINUATION (or
- HEADERS) frame having the END_HEADERS flag set and the final
- DATA frame having the END_STREAM flag set:
-
-
-
- - END_STREAM
- Content-Type: image/jpeg - END_HEADERS
- Content-Length: 123 :method = POST
- :path = /resource
- {binary data} :scheme = https
-
- CONTINUATION
- + END_HEADERS
- content-type = image/jpeg
- host = example.org
- content-length = 123
-
- DATA
- + END_STREAM
- {binary data}
-]]>
-
- Note that data contributing to any given header field could be spread between header
- block fragments. The allocation of header fields to frames in this example is
- illustrative only.
-
-
-
-
- A response that includes header fields and payload data is transmitted as a
- HEADERS frame, followed by zero or more CONTINUATION
- frames, followed by one or more DATA frames, with the last
- DATA frame in the sequence having the END_STREAM flag set:
-
-
-
- - END_STREAM
- Content-Length: 123 + END_HEADERS
- :status = 200
- {binary data} content-type = image/jpeg
- content-length = 123
-
- DATA
- + END_STREAM
- {binary data}
-]]>
-
-
-
- Trailing header fields are sent as a header block after both the request or response
- header block and all the DATA frames have been sent. The
- HEADERS frame starting the trailers header block has the END_STREAM flag
- set.
-
-
-
- - END_STREAM
- Transfer-Encoding: chunked + END_HEADERS
- Trailer: Foo :status = 200
- content-length = 123
- 123 content-type = image/jpeg
- {binary data} trailer = Foo
- 0
- Foo: bar DATA
- - END_STREAM
- {binary data}
-
- HEADERS
- + END_STREAM
- + END_HEADERS
- foo = bar
-]]>
-
-
-
-
-
- An informational response using a 1xx status code other than 101 is transmitted as a
- HEADERS frame, followed by zero or more CONTINUATION
- frames:
-
- - END_STREAM
- + END_HEADERS
- :status = 103
- extension-field = bar
-]]>
-
-
-
-
-
- In HTTP/1.1, an HTTP client is unable to retry a non-idempotent request when an error
- occurs, because there is no means to determine the nature of the error. It is possible
- that some server processing occurred prior to the error, which could result in
- undesirable effects if the request were reattempted.
-
-
- HTTP/2 provides two mechanisms for providing a guarantee to a client that a request has
- not been processed:
-
-
- The GOAWAY frame indicates the highest stream number that might have
- been processed. Requests on streams with higher numbers are therefore guaranteed to
- be safe to retry.
-
-
- The REFUSED_STREAM error code can be included in a
- RST_STREAM frame to indicate that the stream is being closed prior to
- any processing having occurred. Any request that was sent on the reset stream can
- be safely retried.
-
-
-
-
- Requests that have not been processed have not failed; clients MAY automatically retry
- them, even those with non-idempotent methods.
-
-
- A server MUST NOT indicate that a stream has not been processed unless it can guarantee
- that fact. If frames that are on a stream are passed to the application layer for any
- stream, then REFUSED_STREAM MUST NOT be used for that stream, and a
- GOAWAY frame MUST include a stream identifier that is greater than or
- equal to the given stream identifier.
-
-
- In addition to these mechanisms, the PING frame provides a way for a
- client to easily test a connection. Connections that remain idle can become broken as
- some middleboxes (for instance, network address translators, or load balancers) silently
- discard connection bindings. The PING frame allows a client to safely
- test whether a connection is still active without sending a request.
-
-
-
-
-
-
- HTTP/2 allows a server to pre-emptively send (or "push") responses (along with
- corresponding "promised" requests) to a client in association with a previous
- client-initiated request. This can be useful when the server knows the client will need
- to have those responses available in order to fully process the response to the original
- request.
-
-
-
- Pushing additional message exchanges in this fashion is optional, and is negotiated
- between individual endpoints. The SETTINGS_ENABLE_PUSH setting can be set
- to 0 to indicate that server push is disabled.
-
-
- Promised requests MUST be cacheable (see ), MUST be safe (see ) and MUST NOT include a request body. Clients that receive a
- promised request that is not cacheable, unsafe or that includes a request body MUST
- reset the stream with a stream error of type
- PROTOCOL_ERROR.
-
-
- Pushed responses that are cacheable (see ) can be stored by the client, if it implements a HTTP
- cache. Pushed responses are considered successfully validated on the origin server (e.g.,
- if the "no-cache" cache response directive is present) while the stream identified by the
- promised stream ID is still open.
-
-
- Pushed responses that are not cacheable MUST NOT be stored by any HTTP cache. They MAY
- be made available to the application separately.
-
-
- An intermediary can receive pushes from the server and choose not to forward them on to
- the client. In other words, how to make use of the pushed information is up to that
- intermediary. Equally, the intermediary might choose to make additional pushes to the
- client, without any action taken by the server.
-
-
- A client cannot push. Thus, servers MUST treat the receipt of a
- PUSH_PROMISE frame as a connection
- error of type PROTOCOL_ERROR. Clients MUST reject any attempt to
- change the SETTINGS_ENABLE_PUSH setting to a value other than 0 by treating
- the message as a connection error of type
- PROTOCOL_ERROR.
-
-
-
-
- Server push is semantically equivalent to a server responding to a request; however, in
- this case that request is also sent by the server, as a PUSH_PROMISE
- frame.
-
-
- The PUSH_PROMISE frame includes a header block that contains a complete
- set of request header fields that the server attributes to the request. It is not
- possible to push a response to a request that includes a request body.
-
-
-
- Pushed responses are always associated with an explicit request from the client. The
- PUSH_PROMISE frames sent by the server are sent on that explicit
- request's stream. The PUSH_PROMISE frame also includes a promised stream
- identifier, chosen from the stream identifiers available to the server (see ).
-
-
-
- The header fields in PUSH_PROMISE and any subsequent
- CONTINUATION frames MUST be a valid and complete set of request header fields. The server MUST include a method in
- the :method header field that is safe and cacheable. If a
- client receives a PUSH_PROMISE that does not include a complete and valid
- set of header fields, or the :method header field identifies
- a method that is not safe, it MUST respond with a stream error of type PROTOCOL_ERROR.
-
-
-
- The server SHOULD send PUSH_PROMISE ()
- frames prior to sending any frames that reference the promised responses. This avoids a
- race where clients issue requests prior to receiving any PUSH_PROMISE
- frames.
-
-
- For example, if the server receives a request for a document containing embedded links
- to multiple image files, and the server chooses to push those additional images to the
- client, sending push promises before the DATA frames that contain the
- image links ensures that the client is able to see the promises before discovering
- embedded links. Similarly, if the server pushes responses referenced by the header block
- (for instance, in Link header fields), sending the push promises before sending the
- header block ensures that clients do not request them.
-
-
-
- PUSH_PROMISE frames MUST NOT be sent by the client.
-
-
- PUSH_PROMISE frames can be sent by the server in response to any
- client-initiated stream, but the stream MUST be in either the "open" or "half closed
- (remote)" state with respect to the server. PUSH_PROMISE frames are
- interspersed with the frames that comprise a response, though they cannot be
- interspersed with HEADERS and CONTINUATION frames that
- comprise a single header block.
-
-
- Sending a PUSH_PROMISE frame creates a new stream and puts the stream
- into the “reserved (local)” state for the server and the “reserved (remote)” state for
- the client.
-
-
-
-
-
- After sending the PUSH_PROMISE frame, the server can begin delivering the
- pushed response as a response on a server-initiated
- stream that uses the promised stream identifier. The server uses this stream to
- transmit an HTTP response, using the same sequence of frames as defined in . This stream becomes "half closed"
- to the client after the initial HEADERS frame is sent.
-
-
-
- Once a client receives a PUSH_PROMISE frame and chooses to accept the
- pushed response, the client SHOULD NOT issue any requests for the promised response
- until after the promised stream has closed.
-
-
-
- If the client determines, for any reason, that it does not wish to receive the pushed
- response from the server, or if the server takes too long to begin sending the promised
- response, the client can send an RST_STREAM frame, using either the
- CANCEL or REFUSED_STREAM codes, and referencing the pushed
- stream's identifier.
-
-
- A client can use the SETTINGS_MAX_CONCURRENT_STREAMS setting to limit the
- number of responses that can be concurrently pushed by a server. Advertising a
- SETTINGS_MAX_CONCURRENT_STREAMS value of zero disables server push by
- preventing the server from creating the necessary streams. This does not prohibit a
- server from sending PUSH_PROMISE frames; clients need to reset any
- promised streams that are not wanted.
-
-
-
- Clients receiving a pushed response MUST validate that either the server is
- authoritative (see ), or the proxy that provided the pushed
- response is configured for the corresponding request. For example, a server that offers
- a certificate for only the example.com DNS-ID or Common Name
- is not permitted to push a response for https://www.example.org/doc.
-
-
- The response for a PUSH_PROMISE stream begins with a
- HEADERS frame, which immediately puts the stream into the “half closed
- (remote)” state for the server and “half closed (local)” state for the client, and ends
- with a frame bearing END_STREAM, which places the stream in the "closed" state.
-
-
- The client never sends a frame with the END_STREAM flag for a server push.
-
-
-
-
-
-
-
-
-
- In HTTP/1.x, the pseudo-method CONNECT () is used to convert an HTTP connection into a tunnel to a remote host.
- CONNECT is primarily used with HTTP proxies to establish a TLS session with an origin
- server for the purposes of interacting with https resources.
-
-
- In HTTP/2, the CONNECT method is used to establish a tunnel over a single HTTP/2 stream to
- a remote host, for similar purposes. The HTTP header field mapping works as defined in
- Request Header Fields, with a few
- differences. Specifically:
-
-
- The :method header field is set to CONNECT.
-
-
- The :scheme and :path header
- fields MUST be omitted.
-
-
- The :authority header field contains the host and port to
- connect to (equivalent to the authority-form of the request-target of CONNECT
- requests, see ).
-
-
-
-
- A proxy that supports CONNECT establishes a TCP connection to
- the server identified in the :authority header field. Once
- this connection is successfully established, the proxy sends a HEADERS
- frame containing a 2xx series status code to the client, as defined in .
-
-
- After the initial HEADERS frame sent by each peer, all subsequent
- DATA frames correspond to data sent on the TCP connection. The payload of
- any DATA frames sent by the client is transmitted by the proxy to the TCP
- server; data received from the TCP server is assembled into DATA frames by
- the proxy. Frame types other than DATA or stream management frames
- (RST_STREAM, WINDOW_UPDATE, and PRIORITY)
- MUST NOT be sent on a connected stream, and MUST be treated as a stream error if received.
-
-
- The TCP connection can be closed by either peer. The END_STREAM flag on a
- DATA frame is treated as being equivalent to the TCP FIN bit. A client is
- expected to send a DATA frame with the END_STREAM flag set after receiving
- a frame bearing the END_STREAM flag. A proxy that receives a DATA frame
- with the END_STREAM flag set sends the attached data with the FIN bit set on the last TCP
- segment. A proxy that receives a TCP segment with the FIN bit set sends a
- DATA frame with the END_STREAM flag set. Note that the final TCP segment
- or DATA frame could be empty.
-
-
- A TCP connection error is signaled with RST_STREAM. A proxy treats any
- error in the TCP connection, which includes receiving a TCP segment with the RST bit set,
- as a stream error of type
- CONNECT_ERROR. Correspondingly, a proxy MUST send a TCP segment with the
- RST bit set if it detects an error with the stream or the HTTP/2 connection.
-
-
-
-
-
-
- This section outlines attributes of the HTTP protocol that improve interoperability, reduce
- exposure to known security vulnerabilities, or reduce the potential for implementation
- variation.
-
-
-
-
- HTTP/2 connections are persistent. For best performance, it is expected clients will not
- close connections until it is determined that no further communication with a server is
- necessary (for example, when a user navigates away from a particular web page), or until
- the server closes the connection.
-
-
- Clients SHOULD NOT open more than one HTTP/2 connection to a given host and port pair,
- where host is derived from a URI, a selected alternative
- service, or a configured proxy.
-
-
- A client can create additional connections as replacements, either to replace connections
- that are near to exhausting the available stream
- identifier space, to refresh the keying material for a TLS connection, or to
- replace connections that have encountered errors.
-
-
- A client MAY open multiple connections to the same IP address and TCP port using different
- Server Name Indication values or to provide different TLS
- client certificates, but SHOULD avoid creating multiple connections with the same
- configuration.
-
-
- Servers are encouraged to maintain open connections for as long as possible, but are
- permitted to terminate idle connections if necessary. When either endpoint chooses to
- close the transport-layer TCP connection, the terminating endpoint SHOULD first send a
- GOAWAY () frame so that both endpoints can reliably
- determine whether previously sent frames have been processed and gracefully complete or
- terminate any necessary remaining tasks.
-
-
-
-
- Connections that are made to an origin servers, either directly or through a tunnel
- created using the CONNECT method MAY be reused for
- requests with multiple different URI authority components. A connection can be reused
- as long as the origin server is authoritative. For
- http resources, this depends on the host having resolved to
- the same IP address.
-
-
- For https resources, connection reuse additionally depends
- on having a certificate that is valid for the host in the URI. An origin server might
- offer a certificate with multiple subjectAltName attributes,
- or names with wildcards, one of which is valid for the authority in the URI. For
- example, a certificate with a subjectAltName of *.example.com might permit the use of the same connection for
- requests to URIs starting with https://a.example.com/ and
- https://b.example.com/.
-
-
- In some deployments, reusing a connection for multiple origins can result in requests
- being directed to the wrong origin server. For example, TLS termination might be
- performed by a middlebox that uses the TLS Server Name Indication
- (SNI) extension to select an origin server. This means that it is possible
- for clients to send confidential information to servers that might not be the intended
- target for the request, even though the server is otherwise authoritative.
-
-
- A server that does not wish clients to reuse connections can indicate that it is not
- authoritative for a request by sending a 421 (Misdirected Request) status code in response
- to the request (see ).
-
-
- A client that is configured to use a proxy over HTTP/2 directs requests to that proxy
- through a single connection. That is, all requests sent via a proxy reuse the
- connection to the proxy.
-
-
-
-
-
- The 421 (Misdirected Request) status code indicates that the request was directed at a
- server that is not able to produce a response. This can be sent by a server that is not
- configured to produce responses for the combination of scheme and authority that are
- included in the request URI.
-
-
- Clients receiving a 421 (Misdirected Request) response from a server MAY retry the
- request - whether the request method is idempotent or not - over a different connection.
- This is possible if a connection is reused () or if an alternative
- service is selected ().
-
-
- This status code MUST NOT be generated by proxies.
-
-
- A 421 response is cacheable by default; i.e., unless otherwise indicated by the method
- definition or explicit cache controls (see ).
-
-
-
-
-
-
- Implementations of HTTP/2 MUST support TLS 1.2 for HTTP/2 over
- TLS. The general TLS usage guidance in SHOULD be followed, with
- some additional restrictions that are specific to HTTP/2.
-
-
-
- An implementation of HTTP/2 over TLS MUST use TLS 1.2 or higher with the restrictions on
- feature set and cipher suite described in this section. Due to implementation
- limitations, it might not be possible to fail TLS negotiation. An endpoint MUST
- immediately terminate an HTTP/2 connection that does not meet these minimum requirements
- with a connection error of type
- INADEQUATE_SECURITY.
-
-
-
-
- The TLS implementation MUST support the Server Name Indication
- (SNI) extension to TLS. HTTP/2 clients MUST indicate the target domain name when
- negotiating TLS.
-
-
- The TLS implementation MUST disable compression. TLS compression can lead to the
- exposure of information that would not otherwise be revealed .
- Generic compression is unnecessary since HTTP/2 provides compression features that are
- more aware of context and therefore likely to be more appropriate for use for
- performance, security or other reasons.
-
-
- The TLS implementation MUST disable renegotiation. An endpoint MUST treat a TLS
- renegotiation as a connection error of type
- PROTOCOL_ERROR. Note that disabling renegotiation can result in
- long-lived connections becoming unusable due to limits on the number of messages the
- underlying cipher suite can encipher.
-
-
- A client MAY use renegotiation to provide confidentiality protection for client
- credentials offered in the handshake, but any renegotiation MUST occur prior to sending
- the connection preface. A server SHOULD request a client certificate if it sees a
- renegotiation request immediately after establishing a connection.
-
-
- This effectively prevents the use of renegotiation in response to a request for a
- specific protected resource. A future specification might provide a way to support this
- use case.
-
-
-
-
-
- The set of TLS cipher suites that are permitted in HTTP/2 is restricted. HTTP/2 MUST
- only be used with cipher suites that have ephemeral key exchange, such as the ephemeral Diffie-Hellman (DHE) or the elliptic curve variant (ECDHE). Ephemeral key exchange MUST
- have a minimum size of 2048 bits for DHE or security level of 128 bits for ECDHE.
- Clients MUST accept DHE sizes of up to 4096 bits. HTTP MUST NOT be used with cipher
- suites that use stream or block ciphers. Authenticated Encryption with Additional Data
- (AEAD) modes, such as the Galois Counter Model (GCM) mode for
- AES are acceptable.
-
-
- The effect of these restrictions is that TLS 1.2 implementations could have
- non-intersecting sets of available cipher suites, since these prevent the use of the
- cipher suite that TLS 1.2 makes mandatory. To avoid this problem, implementations of
- HTTP/2 that use TLS 1.2 MUST support TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 with P256 .
-
-
- Clients MAY advertise support of cipher suites that are prohibited by the above
- restrictions in order to allow for connection to servers that do not support HTTP/2.
- This enables a fallback to protocols without these constraints without the additional
- latency imposed by using a separate connection for fallback.
-
-
-
-
-
-
-
-
- HTTP/2 relies on the HTTP/1.1 definition of authority for determining whether a server is
- authoritative in providing a given response, see . This relies on local name resolution for the "http"
- URI scheme, and the authenticated server identity for the "https" scheme (see ).
-
-
-
-
-
- In a cross-protocol attack, an attacker causes a client to initiate a transaction in one
- protocol toward a server that understands a different protocol. An attacker might be able
- to cause the transaction to appear as valid transaction in the second protocol. In
- combination with the capabilities of the web context, this can be used to interact with
- poorly protected servers in private networks.
-
-
- Completing a TLS handshake with an ALPN identifier for HTTP/2 can be considered sufficient
- protection against cross protocol attacks. ALPN provides a positive indication that a
- server is willing to proceed with HTTP/2, which prevents attacks on other TLS-based
- protocols.
-
-
- The encryption in TLS makes it difficult for attackers to control the data which could be
- used in a cross-protocol attack on a cleartext protocol.
-
-
- The cleartext version of HTTP/2 has minimal protection against cross-protocol attacks.
- The connection preface contains a string that is
- designed to confuse HTTP/1.1 servers, but no special protection is offered for other
- protocols. A server that is willing to ignore parts of an HTTP/1.1 request containing an
- Upgrade header field in addition to the client connection preface could be exposed to a
- cross-protocol attack.
-
-
-
-
-
- HTTP/2 header field names and values are encoded as sequences of octets with a length
- prefix. This enables HTTP/2 to carry any string of octets as the name or value of a
- header field. An intermediary that translates HTTP/2 requests or responses into HTTP/1.1
- directly could permit the creation of corrupted HTTP/1.1 messages. An attacker might
- exploit this behavior to cause the intermediary to create HTTP/1.1 messages with illegal
- header fields, extra header fields, or even new messages that are entirely falsified.
-
-
- Header field names or values that contain characters not permitted by HTTP/1.1, including
- carriage return (ASCII 0xd) or line feed (ASCII 0xa) MUST NOT be translated verbatim by an
- intermediary, as stipulated in .
-
-
- Translation from HTTP/1.x to HTTP/2 does not produce the same opportunity to an attacker.
- Intermediaries that perform translation to HTTP/2 MUST remove any instances of the obs-fold production from header field values.
-
-
-
-
-
- Pushed responses do not have an explicit request from the client; the request
- is provided by the server in the PUSH_PROMISE frame.
-
-
- Caching responses that are pushed is possible based on the guidance provided by the origin
- server in the Cache-Control header field. However, this can cause issues if a single
- server hosts more than one tenant. For example, a server might offer multiple users each
- a small portion of its URI space.
-
-
- Where multiple tenants share space on the same server, that server MUST ensure that
- tenants are not able to push representations of resources that they do not have authority
- over. Failure to enforce this would allow a tenant to provide a representation that would
- be served out of cache, overriding the actual representation that the authoritative tenant
- provides.
-
-
- Pushed responses for which an origin server is not authoritative (see
- ) are never cached or used.
-
-
-
-
-
- An HTTP/2 connection can demand a greater commitment of resources to operate than a
- HTTP/1.1 connection. The use of header compression and flow control depend on a
- commitment of resources for storing a greater amount of state. Settings for these
- features ensure that memory commitments for these features are strictly bounded.
-
-
- The number of PUSH_PROMISE frames is not constrained in the same fashion.
- A client that accepts server push SHOULD limit the number of streams it allows to be in
- the "reserved (remote)" state. Excessive number of server push streams can be treated as
- a stream error of type
- ENHANCE_YOUR_CALM.
-
-
- Processing capacity cannot be guarded as effectively as state capacity.
-
-
- The SETTINGS frame can be abused to cause a peer to expend additional
- processing time. This might be done by pointlessly changing SETTINGS parameters, setting
- multiple undefined parameters, or changing the same setting multiple times in the same
- frame. WINDOW_UPDATE or PRIORITY frames can be abused to
- cause an unnecessary waste of resources.
-
-
- Large numbers of small or empty frames can be abused to cause a peer to expend time
- processing frame headers. Note however that some uses are entirely legitimate, such as
- the sending of an empty DATA frame to end a stream.
-
-
- Header compression also offers some opportunities to waste processing resources; see for more details on potential abuses.
-
-
- Limits in SETTINGS parameters cannot be reduced instantaneously, which
- leaves an endpoint exposed to behavior from a peer that could exceed the new limits. In
- particular, immediately after establishing a connection, limits set by a server are not
- known to clients and could be exceeded without being an obvious protocol violation.
-
-
- All these features - i.e., SETTINGS changes, small frames, header
- compression - have legitimate uses. These features become a burden only when they are
- used unnecessarily or to excess.
-
-
- An endpoint that doesn't monitor this behavior exposes itself to a risk of denial of
- service attack. Implementations SHOULD track the use of these features and set limits on
- their use. An endpoint MAY treat activity that is suspicious as a connection error of type
- ENHANCE_YOUR_CALM.
-
-
-
-
- A large header block can cause an implementation to
- commit a large amount of state. Header fields that are critical for routing can appear
- toward the end of a header block, which prevents streaming of header fields to their
- ultimate destination. For this an other reasons, such as ensuring cache correctness,
- means that an endpoint might need to buffer the entire header block. Since there is no
- hard limit to the size of a header block, some endpoints could be forced commit a large
- amount of available memory for header fields.
-
-
- An endpoint can use the SETTINGS_MAX_HEADER_LIST_SIZE to advise peers of
- limits that might apply on the size of header blocks. This setting is only advisory, so
- endpoints MAY choose to send header blocks that exceed this limit and risk having the
- request or response being treated as malformed. This setting specific to a connection,
- so any request or response could encounter a hop with a lower, unknown limit. An
- intermediary can attempt to avoid this problem by passing on values presented by
- different peers, but they are not obligated to do so.
-
-
- A server that receives a larger header block than it is willing to handle can send an
- HTTP 431 (Request Header Fields Too Large) status code . A
- client can discard responses that it cannot process. The header block MUST be processed
- to ensure a consistent connection state, unless the connection is closed.
-
-
-
-
-
-
- HTTP/2 enables greater use of compression for both header fields () and entity bodies. Compression can allow an attacker to recover
- secret data when it is compressed in the same context as data under attacker control.
-
-
- There are demonstrable attacks on compression that exploit the characteristics of the web
- (e.g., ). The attacker induces multiple requests containing
- varying plaintext, observing the length of the resulting ciphertext in each, which
- reveals a shorter length when a guess about the secret is correct.
-
-
- Implementations communicating on a secure channel MUST NOT compress content that includes
- both confidential and attacker-controlled data unless separate compression dictionaries
- are used for each source of data. Compression MUST NOT be used if the source of data
- cannot be reliably determined. Generic stream compression, such as that provided by TLS
- MUST NOT be used with HTTP/2 ().
-
-
- Further considerations regarding the compression of header fields are described in .
-
-
-
-
-
- Padding within HTTP/2 is not intended as a replacement for general purpose padding, such
- as might be provided by TLS. Redundant padding could even be
- counterproductive. Correct application can depend on having specific knowledge of the
- data that is being padded.
-
-
- To mitigate attacks that rely on compression, disabling or limiting compression might be
- preferable to padding as a countermeasure.
-
-
- Padding can be used to obscure the exact size of frame content, and is provided to
- mitigate specific attacks within HTTP. For example, attacks where compressed content
- includes both attacker-controlled plaintext and secret data (see for example, ).
-
-
- Use of padding can result in less protection than might seem immediately obvious. At
- best, padding only makes it more difficult for an attacker to infer length information by
- increasing the number of frames an attacker has to observe. Incorrectly implemented
- padding schemes can be easily defeated. In particular, randomized padding with a
- predictable distribution provides very little protection; similarly, padding payloads to a
- fixed size exposes information as payload sizes cross the fixed size boundary, which could
- be possible if an attacker can control plaintext.
-
-
- Intermediaries SHOULD retain padding for DATA frames, but MAY drop padding
- for HEADERS and PUSH_PROMISE frames. A valid reason for an
- intermediary to change the amount of padding of frames is to improve the protections that
- padding provides.
-
-
-
-
-
- Several characteristics of HTTP/2 provide an observer an opportunity to correlate actions
- of a single client or server over time. This includes the value of settings, the manner
- in which flow control windows are managed, the way priorities are allocated to streams,
- timing of reactions to stimulus, and handling of any optional features.
-
-
- As far as this creates observable differences in behavior, they could be used as a basis
- for fingerprinting a specific client, as defined in .
-
-
-
-
-
-
- A string for identifying HTTP/2 is entered into the "Application Layer Protocol Negotiation
- (ALPN) Protocol IDs" registry established in .
-
-
- This document establishes a registry for frame types, settings, and error codes. These new
- registries are entered into a new "Hypertext Transfer Protocol (HTTP) 2 Parameters" section.
-
-
- This document registers the HTTP2-Settings header field for
- use in HTTP; and the 421 (Misdirected Request) status code.
-
-
- This document registers the PRI method for use in HTTP, to avoid
- collisions with the connection preface.
-
-
-
-
- This document creates two registrations for the identification of HTTP/2 in the
- "Application Layer Protocol Negotiation (ALPN) Protocol IDs" registry established in .
-
-
- The "h2" string identifies HTTP/2 when used over TLS:
-
- HTTP/2 over TLS
- 0x68 0x32 ("h2")
- This document
-
-
-
- The "h2c" string identifies HTTP/2 when used over cleartext TCP:
-
- HTTP/2 over TCP
- 0x68 0x32 0x63 ("h2c")
- This document
-
-
-
-
-
-
- This document establishes a registry for HTTP/2 frame type codes. The "HTTP/2 Frame
- Type" registry manages an 8-bit space. The "HTTP/2 Frame Type" registry operates under
- either of the "IETF Review" or "IESG Approval" policies for
- values between 0x00 and 0xef, with values between 0xf0 and 0xff being reserved for
- experimental use.
-
-
- New entries in this registry require the following information:
-
-
- A name or label for the frame type.
-
-
- The 8-bit code assigned to the frame type.
-
-
- A reference to a specification that includes a description of the frame layout,
- it's semantics and flags that the frame type uses, including any parts of the frame
- that are conditionally present based on the value of flags.
-
-
-
-
- The entries in the following table are registered by this document.
-
-
- Frame Type
- Code
- Section
- DATA0x0
- HEADERS0x1
- PRIORITY0x2
- RST_STREAM0x3
- SETTINGS0x4
- PUSH_PROMISE0x5
- PING0x6
- GOAWAY0x7
- WINDOW_UPDATE0x8
- CONTINUATION0x9
-
-
-
-
-
- This document establishes a registry for HTTP/2 settings. The "HTTP/2 Settings" registry
- manages a 16-bit space. The "HTTP/2 Settings" registry operates under the "Expert Review" policy for values in the range from 0x0000 to
- 0xefff, with values between and 0xf000 and 0xffff being reserved for experimental use.
-
-
- New registrations are advised to provide the following information:
-
-
- A symbolic name for the setting. Specifying a setting name is optional.
-
-
- The 16-bit code assigned to the setting.
-
-
- An initial value for the setting.
-
-
- An optional reference to a specification that describes the use of the setting.
-
-
-
-
- An initial set of setting registrations can be found in .
-
-
- Name
- Code
- Initial Value
- Specification
- HEADER_TABLE_SIZE
- 0x14096
- ENABLE_PUSH
- 0x21
- MAX_CONCURRENT_STREAMS
- 0x3(infinite)
- INITIAL_WINDOW_SIZE
- 0x465535
- MAX_FRAME_SIZE
- 0x516384
- MAX_HEADER_LIST_SIZE
- 0x6(infinite)
-
-
-
-
-
-
- This document establishes a registry for HTTP/2 error codes. The "HTTP/2 Error Code"
- registry manages a 32-bit space. The "HTTP/2 Error Code" registry operates under the
- "Expert Review" policy.
-
-
- Registrations for error codes are required to include a description of the error code. An
- expert reviewer is advised to examine new registrations for possible duplication with
- existing error codes. Use of existing registrations is to be encouraged, but not
- mandated.
-
-
- New registrations are advised to provide the following information:
-
-
- A name for the error code. Specifying an error code name is optional.
-
-
- The 32-bit error code value.
-
-
- A brief description of the error code semantics, longer if no detailed specification
- is provided.
-
-
- An optional reference for a specification that defines the error code.
-
-
-
-
- The entries in the following table are registered by this document.
-
-
- Name
- Code
- Description
- Specification
- NO_ERROR0x0
- Graceful shutdown
-
- PROTOCOL_ERROR0x1
- Protocol error detected
-
- INTERNAL_ERROR0x2
- Implementation fault
-
- FLOW_CONTROL_ERROR0x3
- Flow control limits exceeded
-
- SETTINGS_TIMEOUT0x4
- Settings not acknowledged
-
- STREAM_CLOSED0x5
- Frame received for closed stream
-
- FRAME_SIZE_ERROR0x6
- Frame size incorrect
-
- REFUSED_STREAM0x7
- Stream not processed
-
- CANCEL0x8
- Stream cancelled
-
- COMPRESSION_ERROR0x9
- Compression state not updated
-
- CONNECT_ERROR0xa
- TCP connection error for CONNECT method
-
- ENHANCE_YOUR_CALM0xb
- Processing capacity exceeded
-
- INADEQUATE_SECURITY0xc
- Negotiated TLS parameters not acceptable
-
-
-
-
-
-
-
- This section registers the HTTP2-Settings header field in the
- Permanent Message Header Field Registry.
-
-
- HTTP2-Settings
-
-
- http
-
-
- standard
-
-
- IETF
-
-
- of this document
-
-
- This header field is only used by an HTTP/2 client for Upgrade-based negotiation.
-
-
-
-
-
-
-
- This section registers the PRI method in the HTTP Method
- Registry ().
-
-
- PRI
-
-
- No
-
-
- No
-
-
- of this document
-
-
- This method is never used by an actual client. This method will appear to be used
- when an HTTP/1.1 server or intermediary attempts to parse an HTTP/2 connection
- preface.
-
-
-
-
-
-
-
- This document registers the 421 (Misdirected Request) HTTP Status code in the Hypertext
- Transfer Protocol (HTTP) Status Code Registry ().
-
-
-
-
- 421
-
-
- Misdirected Request
-
-
- of this document
-
-
-
-
-
-
-
-
-
- This document includes substantial input from the following individuals:
-
-
- Adam Langley, Wan-Teh Chang, Jim Morrison, Mark Nottingham, Alyssa Wilk, Costin
- Manolache, William Chan, Vitaliy Lvin, Joe Chan, Adam Barth, Ryan Hamilton, Gavin
- Peters, Kent Alstad, Kevin Lindsay, Paul Amer, Fan Yang, Jonathan Leighton (SPDY
- contributors).
-
-
- Gabriel Montenegro and Willy Tarreau (Upgrade mechanism).
-
-
- William Chan, Salvatore Loreto, Osama Mazahir, Gabriel Montenegro, Jitu Padhye, Roberto
- Peon, Rob Trace (Flow control).
-
-
- Mike Bishop (Extensibility).
-
-
- Mark Nottingham, Julian Reschke, James Snell, Jeff Pinner, Mike Bishop, Herve Ruellan
- (Substantial editorial contributions).
-
-
- Kari Hurtta, Tatsuhiro Tsujikawa, Greg Wilkins, Poul-Henning Kamp.
-
-
- Alexey Melnikov was an editor of this document during 2013.
-
-
- A substantial proportion of Martin's contribution was supported by Microsoft during his
- employment there.
-
-
-
-
-
-
-
-
-
-
- HPACK - Header Compression for HTTP/2
-
-
-
-
-
-
-
-
-
-
-
- Transmission Control Protocol
-
-
- University of Southern California (USC)/Information Sciences
- Institute
-
-
-
-
-
-
-
-
-
-
- Key words for use in RFCs to Indicate Requirement Levels
-
-
- Harvard University
- sob@harvard.edu
-
-
-
-
-
-
-
-
-
-
- HTTP Over TLS
-
-
-
-
-
-
-
-
-
- Uniform Resource Identifier (URI): Generic
- Syntax
-
-
-
-
-
-
-
-
-
-
-
- The Base16, Base32, and Base64 Data Encodings
-
-
-
-
-
-
-
-
- Guidelines for Writing an IANA Considerations Section in RFCs
-
-
-
-
-
-
-
-
-
-
- Augmented BNF for Syntax Specifications: ABNF
-
-
-
-
-
-
-
-
-
-
- The Transport Layer Security (TLS) Protocol Version 1.2
-
-
-
-
-
-
-
-
-
-
- Transport Layer Security (TLS) Extensions: Extension Definitions
-
-
-
-
-
-
-
-
-
- Transport Layer Security (TLS) Application-Layer Protocol Negotiation Extension
-
-
-
-
-
-
-
-
-
-
-
-
- TLS Elliptic Curve Cipher Suites with SHA-256/384 and AES Galois
- Counter Mode (GCM)
-
-
-
-
-
-
-
-
-
-
- Digital Signature Standard (DSS)
-
- NIST
-
-
-
-
-
-
-
-
- Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing
-
- Adobe Systems Incorporated
- fielding@gbiv.com
-
-
- greenbytes GmbH
- julian.reschke@greenbytes.de
-
-
-
-
-
-
-
-
-
- Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content
-
- Adobe Systems Incorporated
- fielding@gbiv.com
-
-
- greenbytes GmbH
- julian.reschke@greenbytes.de
-
-
-
-
-
-
-
-
- Hypertext Transfer Protocol (HTTP/1.1): Conditional Requests
-
- Adobe Systems Incorporated
- fielding@gbiv.com
-
-
- greenbytes GmbH
- julian.reschke@greenbytes.de
-
-
-
-
-
-
-
- Hypertext Transfer Protocol (HTTP/1.1): Range Requests
-
- Adobe Systems Incorporated
- fielding@gbiv.com
-
-
- World Wide Web Consortium
- ylafon@w3.org
-
-
- greenbytes GmbH
- julian.reschke@greenbytes.de
-
-
-
-
-
-
-
- Hypertext Transfer Protocol (HTTP/1.1): Caching
-
- Adobe Systems Incorporated
- fielding@gbiv.com
-
-
- Akamai
- mnot@mnot.net
-
-
- greenbytes GmbH
- julian.reschke@greenbytes.de
-
-
-
-
-
-
-
-
- Hypertext Transfer Protocol (HTTP/1.1): Authentication
-
- Adobe Systems Incorporated
- fielding@gbiv.com
-
-
- greenbytes GmbH
- julian.reschke@greenbytes.de
-
-
-
-
-
-
-
-
-
- HTTP State Management Mechanism
-
-
-
-
-
-
-
-
-
-
-
- TCP Extensions for High Performance
-
-
-
-
-
-
-
-
-
-
-
- Transport Layer Security Protocol Compression Methods
-
-
-
-
-
-
-
-
- Additional HTTP Status Codes
-
-
-
-
-
-
-
-
-
-
- Elliptic Curve Cryptography (ECC) Cipher Suites for Transport Layer Security (TLS)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- AES Galois Counter Mode (GCM) Cipher Suites for TLS
-
-
-
-
-
-
-
-
-
-
-
- HTML5
-
-
-
-
-
-
-
-
-
-
- Latest version available at
- .
-
-
-
-
-
-
- Talking to Yourself for Fun and Profit
-
-
-
-
-
-
-
-
-
-
-
-
-
- BREACH: Reviving the CRIME Attack
-
-
-
-
-
-
-
-
-
-
- Registration Procedures for Message Header Fields
-
- Nine by Nine
- GK-IETF@ninebynine.org
-
-
- BEA Systems
- mnot@pobox.com
-
-
- HP Labs
- JeffMogul@acm.org
-
-
-
-
-
-
-
-
-
- Recommendations for Secure Use of TLS and DTLS
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- HTTP Alternative Services
-
-
- Akamai
-
-
- Mozilla
-
-
- greenbytes
-
-
-
-
-
-
-
-
-
-
- This section is to be removed by RFC Editor before publication.
-
-
-
-
- Renamed Not Authoritative status code to Misdirected Request.
-
-
-
-
-
- Pseudo-header fields are now required to appear strictly before regular ones.
-
-
- Restored 1xx series status codes, except 101.
-
-
- Changed frame length field 24-bits. Expanded frame header to 9 octets. Added a setting
- to limit the damage.
-
-
- Added a setting to advise peers of header set size limits.
-
-
- Removed segments.
-
-
- Made non-semantic-bearing HEADERS frames illegal in the HTTP mapping.
-
-
-
-
-
- Restored extensibility options.
-
-
- Restricting TLS cipher suites to AEAD only.
-
-
- Removing Content-Encoding requirements.
-
-
- Permitting the use of PRIORITY after stream close.
-
-
- Removed ALTSVC frame.
-
-
- Removed BLOCKED frame.
-
-
- Reducing the maximum padding size to 256 octets; removing padding from
- CONTINUATION frames.
-
-
- Removed per-frame GZIP compression.
-
-
-
-
-
- Added BLOCKED frame (at risk).
-
-
- Simplified priority scheme.
-
-
- Added DATA per-frame GZIP compression.
-
-
-
-
-
- Changed "connection header" to "connection preface" to avoid confusion.
-
-
- Added dependency-based stream prioritization.
-
-
- Added "h2c" identifier to distinguish between cleartext and secured HTTP/2.
-
-
- Adding missing padding to PUSH_PROMISE.
-
-
- Integrate ALTSVC frame and supporting text.
-
-
- Dropping requirement on "deflate" Content-Encoding.
-
-
- Improving security considerations around use of compression.
-
-
-
-
-
- Adding padding for data frames.
-
-
- Renumbering frame types, error codes, and settings.
-
-
- Adding INADEQUATE_SECURITY error code.
-
-
- Updating TLS usage requirements to 1.2; forbidding TLS compression.
-
-
- Removing extensibility for frames and settings.
-
-
- Changing setting identifier size.
-
-
- Removing the ability to disable flow control.
-
-
- Changing the protocol identification token to "h2".
-
-
- Changing the use of :authority to make it optional and to allow userinfo in non-HTTP
- cases.
-
-
- Allowing split on 0x0 for Cookie.
-
-
- Reserved PRI method in HTTP/1.1 to avoid possible future collisions.
-
-
-
-
-
- Added cookie crumbling for more efficient header compression.
-
-
- Added header field ordering with the value-concatenation mechanism.
-
-
-
-
-
- Marked draft for implementation.
-
-
-
-
-
- Adding definition for CONNECT method.
-
-
- Constraining the use of push to safe, cacheable methods with no request body.
-
-
- Changing from :host to :authority to remove any potential confusion.
-
-
- Adding setting for header compression table size.
-
-
- Adding settings acknowledgement.
-
-
- Removing unnecessary and potentially problematic flags from CONTINUATION.
-
-
- Added denial of service considerations.
-
-
-
-
- Marking the draft ready for implementation.
-
-
- Renumbering END_PUSH_PROMISE flag.
-
-
- Editorial clarifications and changes.
-
-
-
-
-
- Added CONTINUATION frame for HEADERS and PUSH_PROMISE.
-
-
- PUSH_PROMISE is no longer implicitly prohibited if SETTINGS_MAX_CONCURRENT_STREAMS is
- zero.
-
-
- Push expanded to allow all safe methods without a request body.
-
-
- Clarified the use of HTTP header fields in requests and responses. Prohibited HTTP/1.1
- hop-by-hop header fields.
-
-
- Requiring that intermediaries not forward requests with missing or illegal routing
- :-headers.
-
-
- Clarified requirements around handling different frames after stream close, stream reset
- and GOAWAY.
-
-
- Added more specific prohibitions for sending of different frame types in various stream
- states.
-
-
- Making the last received setting value the effective value.
-
-
- Clarified requirements on TLS version, extension and ciphers.
-
-
-
-
-
- Committed major restructuring atrocities.
-
-
- Added reference to first header compression draft.
-
-
- Added more formal description of frame lifecycle.
-
-
- Moved END_STREAM (renamed from FINAL) back to HEADERS/DATA.
-
-
- Removed HEADERS+PRIORITY, added optional priority to HEADERS frame.
-
-
- Added PRIORITY frame.
-
-
-
-
-
- Added continuations to frames carrying header blocks.
-
-
- Replaced use of "session" with "connection" to avoid confusion with other HTTP stateful
- concepts, like cookies.
-
-
- Removed "message".
-
-
- Switched to TLS ALPN from NPN.
-
-
- Editorial changes.
-
-
-
-
-
- Added IANA considerations section for frame types, error codes and settings.
-
-
- Removed data frame compression.
-
-
- Added PUSH_PROMISE.
-
-
- Added globally applicable flags to framing.
-
-
- Removed zlib-based header compression mechanism.
-
-
- Updated references.
-
-
- Clarified stream identifier reuse.
-
-
- Removed CREDENTIALS frame and associated mechanisms.
-
-
- Added advice against naive implementation of flow control.
-
-
- Added session header section.
-
-
- Restructured frame header. Removed distinction between data and control frames.
-
-
- Altered flow control properties to include session-level limits.
-
-
- Added note on cacheability of pushed resources and multiple tenant servers.
-
-
- Changed protocol label form based on discussions.
-
-
-
-
-
- Changed title throughout.
-
-
- Removed section on Incompatibilities with SPDY draft#2.
-
-
- Changed INTERNAL_ERROR on GOAWAY to have a value of 2 .
-
-
- Replaced abstract and introduction.
-
-
- Added section on starting HTTP/2.0, including upgrade mechanism.
-
-
- Removed unused references.
-
-
- Added flow control principles based on .
-
-
-
-
-
- Adopted as base for draft-ietf-httpbis-http2.
-
-
- Updated authors/editors list.
-
-
- Added status note.
-
-
-
-
-
-
-
diff --git a/vendor/github.com/bradfitz/http2/transport_test.go b/vendor/github.com/bradfitz/http2/transport_test.go
deleted file mode 100644
index d752da19..00000000
--- a/vendor/github.com/bradfitz/http2/transport_test.go
+++ /dev/null
@@ -1,168 +0,0 @@
-// Copyright 2015 The Go Authors.
-// See https://go.googlesource.com/go/+/master/CONTRIBUTORS
-// Licensed under the same terms as Go itself:
-// https://go.googlesource.com/go/+/master/LICENSE
-
-package http2
-
-import (
- "flag"
- "io"
- "io/ioutil"
- "net/http"
- "os"
- "reflect"
- "strings"
- "testing"
- "time"
-)
-
-var (
- extNet = flag.Bool("extnet", false, "do external network tests")
- transportHost = flag.String("transporthost", "http2.golang.org", "hostname to use for TestTransport")
- insecure = flag.Bool("insecure", false, "insecure TLS dials")
-)
-
-func TestTransportExternal(t *testing.T) {
- if !*extNet {
- t.Skip("skipping external network test")
- }
- req, _ := http.NewRequest("GET", "https://"+*transportHost+"/", nil)
- rt := &Transport{
- InsecureTLSDial: *insecure,
- }
- res, err := rt.RoundTrip(req)
- if err != nil {
- t.Fatalf("%v", err)
- }
- res.Write(os.Stdout)
-}
-
-func TestTransport(t *testing.T) {
- const body = "sup"
- st := newServerTester(t, func(w http.ResponseWriter, r *http.Request) {
- io.WriteString(w, body)
- })
- defer st.Close()
-
- tr := &Transport{InsecureTLSDial: true}
- defer tr.CloseIdleConnections()
-
- req, err := http.NewRequest("GET", st.ts.URL, nil)
- if err != nil {
- t.Fatal(err)
- }
- res, err := tr.RoundTrip(req)
- if err != nil {
- t.Fatal(err)
- }
- defer res.Body.Close()
-
- t.Logf("Got res: %+v", res)
- if g, w := res.StatusCode, 200; g != w {
- t.Errorf("StatusCode = %v; want %v", g, w)
- }
- if g, w := res.Status, "200 OK"; g != w {
- t.Errorf("Status = %q; want %q", g, w)
- }
- wantHeader := http.Header{
- "Content-Length": []string{"3"},
- "Content-Type": []string{"text/plain; charset=utf-8"},
- }
- if !reflect.DeepEqual(res.Header, wantHeader) {
- t.Errorf("res Header = %v; want %v", res.Header, wantHeader)
- }
- if res.Request != req {
- t.Errorf("Response.Request = %p; want %p", res.Request, req)
- }
- if res.TLS == nil {
- t.Error("Response.TLS = nil; want non-nil")
- }
- slurp, err := ioutil.ReadAll(res.Body)
- if err != nil {
- t.Errorf("Body read: %v", err)
- } else if string(slurp) != body {
- t.Errorf("Body = %q; want %q", slurp, body)
- }
-
-}
-
-func TestTransportReusesConns(t *testing.T) {
- st := newServerTester(t, func(w http.ResponseWriter, r *http.Request) {
- io.WriteString(w, r.RemoteAddr)
- }, optOnlyServer)
- defer st.Close()
- tr := &Transport{InsecureTLSDial: true}
- defer tr.CloseIdleConnections()
- get := func() string {
- req, err := http.NewRequest("GET", st.ts.URL, nil)
- if err != nil {
- t.Fatal(err)
- }
- res, err := tr.RoundTrip(req)
- if err != nil {
- t.Fatal(err)
- }
- defer res.Body.Close()
- slurp, err := ioutil.ReadAll(res.Body)
- if err != nil {
- t.Fatalf("Body read: %v", err)
- }
- addr := strings.TrimSpace(string(slurp))
- if addr == "" {
- t.Fatalf("didn't get an addr in response")
- }
- return addr
- }
- first := get()
- second := get()
- if first != second {
- t.Errorf("first and second responses were on different connections: %q vs %q", first, second)
- }
-}
-
-func TestTransportAbortClosesPipes(t *testing.T) {
- shutdown := make(chan struct{})
- st := newServerTester(t,
- func(w http.ResponseWriter, r *http.Request) {
- w.(http.Flusher).Flush()
- <-shutdown
- },
- optOnlyServer,
- )
- defer st.Close()
- defer close(shutdown) // we must shutdown before st.Close() to avoid hanging
-
- done := make(chan struct{})
- requestMade := make(chan struct{})
- go func() {
- defer close(done)
- tr := &Transport{
- InsecureTLSDial: true,
- }
- req, err := http.NewRequest("GET", st.ts.URL, nil)
- if err != nil {
- t.Fatal(err)
- }
- res, err := tr.RoundTrip(req)
- if err != nil {
- t.Fatal(err)
- }
- defer res.Body.Close()
- close(requestMade)
- _, err = ioutil.ReadAll(res.Body)
- if err == nil {
- t.Error("expected error from res.Body.Read")
- }
- }()
-
- <-requestMade
- // Now force the serve loop to end, via closing the connection.
- st.closeConn()
- // deadlock? that's a bug.
- select {
- case <-done:
- case <-time.After(3 * time.Second):
- t.Fatal("timeout")
- }
-}
diff --git a/vendor/github.com/bradfitz/http2/z_spec_test.go b/vendor/github.com/bradfitz/http2/z_spec_test.go
deleted file mode 100644
index 07b53e3a..00000000
--- a/vendor/github.com/bradfitz/http2/z_spec_test.go
+++ /dev/null
@@ -1,357 +0,0 @@
-// Copyright 2014 The Go Authors.
-// See https://code.google.com/p/go/source/browse/CONTRIBUTORS
-// Licensed under the same terms as Go itself:
-// https://code.google.com/p/go/source/browse/LICENSE
-
-package http2
-
-import (
- "bytes"
- "encoding/xml"
- "flag"
- "fmt"
- "io"
- "os"
- "reflect"
- "regexp"
- "sort"
- "strconv"
- "strings"
- "sync"
- "testing"
-)
-
-var coverSpec = flag.Bool("coverspec", false, "Run spec coverage tests")
-
-// The global map of sentence coverage for the http2 spec.
-var defaultSpecCoverage specCoverage
-
-var loadSpecOnce sync.Once
-
-func loadSpec() {
- if f, err := os.Open("testdata/draft-ietf-httpbis-http2.xml"); err != nil {
- panic(err)
- } else {
- defaultSpecCoverage = readSpecCov(f)
- f.Close()
- }
-}
-
-// covers marks all sentences for section sec in defaultSpecCoverage. Sentences not
-// "covered" will be included in report outputed by TestSpecCoverage.
-func covers(sec, sentences string) {
- loadSpecOnce.Do(loadSpec)
- defaultSpecCoverage.cover(sec, sentences)
-}
-
-type specPart struct {
- section string
- sentence string
-}
-
-func (ss specPart) Less(oo specPart) bool {
- atoi := func(s string) int {
- n, err := strconv.Atoi(s)
- if err != nil {
- panic(err)
- }
- return n
- }
- a := strings.Split(ss.section, ".")
- b := strings.Split(oo.section, ".")
- for len(a) > 0 {
- if len(b) == 0 {
- return false
- }
- x, y := atoi(a[0]), atoi(b[0])
- if x == y {
- a, b = a[1:], b[1:]
- continue
- }
- return x < y
- }
- if len(b) > 0 {
- return true
- }
- return false
-}
-
-type bySpecSection []specPart
-
-func (a bySpecSection) Len() int { return len(a) }
-func (a bySpecSection) Less(i, j int) bool { return a[i].Less(a[j]) }
-func (a bySpecSection) Swap(i, j int) { a[i], a[j] = a[j], a[i] }
-
-type specCoverage struct {
- coverage map[specPart]bool
- d *xml.Decoder
-}
-
-func joinSection(sec []int) string {
- s := fmt.Sprintf("%d", sec[0])
- for _, n := range sec[1:] {
- s = fmt.Sprintf("%s.%d", s, n)
- }
- return s
-}
-
-func (sc specCoverage) readSection(sec []int) {
- var (
- buf = new(bytes.Buffer)
- sub = 0
- )
- for {
- tk, err := sc.d.Token()
- if err != nil {
- if err == io.EOF {
- return
- }
- panic(err)
- }
- switch v := tk.(type) {
- case xml.StartElement:
- if skipElement(v) {
- if err := sc.d.Skip(); err != nil {
- panic(err)
- }
- if v.Name.Local == "section" {
- sub++
- }
- break
- }
- switch v.Name.Local {
- case "section":
- sub++
- sc.readSection(append(sec, sub))
- case "xref":
- buf.Write(sc.readXRef(v))
- }
- case xml.CharData:
- if len(sec) == 0 {
- break
- }
- buf.Write(v)
- case xml.EndElement:
- if v.Name.Local == "section" {
- sc.addSentences(joinSection(sec), buf.String())
- return
- }
- }
- }
-}
-
-func (sc specCoverage) readXRef(se xml.StartElement) []byte {
- var b []byte
- for {
- tk, err := sc.d.Token()
- if err != nil {
- panic(err)
- }
- switch v := tk.(type) {
- case xml.CharData:
- if b != nil {
- panic("unexpected CharData")
- }
- b = []byte(string(v))
- case xml.EndElement:
- if v.Name.Local != "xref" {
- panic("expected ")
- }
- if b != nil {
- return b
- }
- sig := attrSig(se)
- switch sig {
- case "target":
- return []byte(fmt.Sprintf("[%s]", attrValue(se, "target")))
- case "fmt-of,rel,target", "fmt-,,rel,target":
- return []byte(fmt.Sprintf("[%s, %s]", attrValue(se, "target"), attrValue(se, "rel")))
- case "fmt-of,sec,target", "fmt-,,sec,target":
- return []byte(fmt.Sprintf("[section %s of %s]", attrValue(se, "sec"), attrValue(se, "target")))
- case "fmt-of,rel,sec,target":
- return []byte(fmt.Sprintf("[section %s of %s, %s]", attrValue(se, "sec"), attrValue(se, "target"), attrValue(se, "rel")))
- default:
- panic(fmt.Sprintf("unknown attribute signature %q in %#v", sig, fmt.Sprintf("%#v", se)))
- }
- default:
- panic(fmt.Sprintf("unexpected tag %q", v))
- }
- }
-}
-
-var skipAnchor = map[string]bool{
- "intro": true,
- "Overview": true,
-}
-
-var skipTitle = map[string]bool{
- "Acknowledgements": true,
- "Change Log": true,
- "Document Organization": true,
- "Conventions and Terminology": true,
-}
-
-func skipElement(s xml.StartElement) bool {
- switch s.Name.Local {
- case "artwork":
- return true
- case "section":
- for _, attr := range s.Attr {
- switch attr.Name.Local {
- case "anchor":
- if skipAnchor[attr.Value] || strings.HasPrefix(attr.Value, "changes.since.") {
- return true
- }
- case "title":
- if skipTitle[attr.Value] {
- return true
- }
- }
- }
- }
- return false
-}
-
-func readSpecCov(r io.Reader) specCoverage {
- sc := specCoverage{
- coverage: map[specPart]bool{},
- d: xml.NewDecoder(r)}
- sc.readSection(nil)
- return sc
-}
-
-func (sc specCoverage) addSentences(sec string, sentence string) {
- for _, s := range parseSentences(sentence) {
- sc.coverage[specPart{sec, s}] = false
- }
-}
-
-func (sc specCoverage) cover(sec string, sentence string) {
- for _, s := range parseSentences(sentence) {
- p := specPart{sec, s}
- if _, ok := sc.coverage[p]; !ok {
- panic(fmt.Sprintf("Not found in spec: %q, %q", sec, s))
- }
- sc.coverage[specPart{sec, s}] = true
- }
-
-}
-
-var whitespaceRx = regexp.MustCompile(`\s+`)
-
-func parseSentences(sens string) []string {
- sens = strings.TrimSpace(sens)
- if sens == "" {
- return nil
- }
- ss := strings.Split(whitespaceRx.ReplaceAllString(sens, " "), ". ")
- for i, s := range ss {
- s = strings.TrimSpace(s)
- if !strings.HasSuffix(s, ".") {
- s += "."
- }
- ss[i] = s
- }
- return ss
-}
-
-func TestSpecParseSentences(t *testing.T) {
- tests := []struct {
- ss string
- want []string
- }{
- {"Sentence 1. Sentence 2.",
- []string{
- "Sentence 1.",
- "Sentence 2.",
- }},
- {"Sentence 1. \nSentence 2.\tSentence 3.",
- []string{
- "Sentence 1.",
- "Sentence 2.",
- "Sentence 3.",
- }},
- }
-
- for i, tt := range tests {
- got := parseSentences(tt.ss)
- if !reflect.DeepEqual(got, tt.want) {
- t.Errorf("%d: got = %q, want %q", i, got, tt.want)
- }
- }
-}
-
-func TestSpecCoverage(t *testing.T) {
- if !*coverSpec {
- t.Skip()
- }
-
- loadSpecOnce.Do(loadSpec)
-
- var (
- list []specPart
- cv = defaultSpecCoverage.coverage
- total = len(cv)
- complete = 0
- )
-
- for sp, touched := range defaultSpecCoverage.coverage {
- if touched {
- complete++
- } else {
- list = append(list, sp)
- }
- }
- sort.Stable(bySpecSection(list))
-
- if testing.Short() && len(list) > 5 {
- list = list[:5]
- }
-
- for _, p := range list {
- t.Errorf("\tSECTION %s: %s", p.section, p.sentence)
- }
-
- t.Logf("%d/%d (%d%%) sentances covered", complete, total, (complete/total)*100)
-}
-
-func attrSig(se xml.StartElement) string {
- var names []string
- for _, attr := range se.Attr {
- if attr.Name.Local == "fmt" {
- names = append(names, "fmt-"+attr.Value)
- } else {
- names = append(names, attr.Name.Local)
- }
- }
- sort.Strings(names)
- return strings.Join(names, ",")
-}
-
-func attrValue(se xml.StartElement, attr string) string {
- for _, a := range se.Attr {
- if a.Name.Local == attr {
- return a.Value
- }
- }
- panic("unknown attribute " + attr)
-}
-
-func TestSpecPartLess(t *testing.T) {
- tests := []struct {
- sec1, sec2 string
- want bool
- }{
- {"6.2.1", "6.2", false},
- {"6.2", "6.2.1", true},
- {"6.10", "6.10.1", true},
- {"6.10", "6.1.1", false}, // 10, not 1
- {"6.1", "6.1", false}, // equal, so not less
- }
- for _, tt := range tests {
- got := (specPart{tt.sec1, "foo"}).Less(specPart{tt.sec2, "foo"})
- if got != tt.want {
- t.Errorf("Less(%q, %q) = %v; want %v", tt.sec1, tt.sec2, got, tt.want)
- }
- }
-}
diff --git a/vendor/github.com/bugsnag/bugsnag-go/bugsnag_test.go b/vendor/github.com/bugsnag/bugsnag-go/bugsnag_test.go
deleted file mode 100644
index 9f6a52ca..00000000
--- a/vendor/github.com/bugsnag/bugsnag-go/bugsnag_test.go
+++ /dev/null
@@ -1,461 +0,0 @@
-package bugsnag
-
-import (
- "fmt"
- "io/ioutil"
- "log"
- "net"
- "net/http"
- "strings"
- "sync"
- "testing"
- "time"
-
- "github.com/bitly/go-simplejson"
-)
-
-func TestConfigure(t *testing.T) {
- Configure(Configuration{
- APIKey: testAPIKey,
- })
-
- if Config.APIKey != testAPIKey {
- t.Errorf("Setting APIKey didn't work")
- }
-
- if New().Config.APIKey != testAPIKey {
- t.Errorf("Setting APIKey didn't work for new notifiers")
- }
-}
-
-var postedJSON = make(chan []byte, 10)
-var testOnce sync.Once
-var testEndpoint string
-var testAPIKey = "166f5ad3590596f9aa8d601ea89af845"
-
-func startTestServer() {
- testOnce.Do(func() {
- mux := http.NewServeMux()
- mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
- body, err := ioutil.ReadAll(r.Body)
- if err != nil {
- panic(err)
- }
- postedJSON <- body
- })
-
- l, err := net.Listen("tcp", "127.0.0.1:0")
- if err != nil {
- panic(err)
- }
- testEndpoint = "http://" + l.Addr().String() + "/"
-
- go http.Serve(l, mux)
- })
-}
-
-type _recurse struct {
- *_recurse
-}
-
-func TestNotify(t *testing.T) {
- startTestServer()
-
- recurse := _recurse{}
- recurse._recurse = &recurse
-
- OnBeforeNotify(func(event *Event, config *Configuration) error {
- if event.Context == "testing" {
- event.GroupingHash = "lol"
- }
- return nil
- })
-
- Notify(fmt.Errorf("hello world"),
- Configuration{
- APIKey: testAPIKey,
- Endpoint: testEndpoint,
- ReleaseStage: "test",
- AppVersion: "1.2.3",
- Hostname: "web1",
- ProjectPackages: []string{"github.com/bugsnag/bugsnag-go"},
- },
- User{Id: "123", Name: "Conrad", Email: "me@cirw.in"},
- Context{"testing"},
- MetaData{"test": {
- "password": "sneaky",
- "value": "able",
- "broken": complex(1, 2),
- "recurse": recurse,
- }},
- )
-
- json, err := simplejson.NewJson(<-postedJSON)
-
- if err != nil {
- t.Fatal(err)
- }
-
- if json.Get("apiKey").MustString() != testAPIKey {
- t.Errorf("Wrong api key in payload")
- }
-
- if json.GetPath("notifier", "name").MustString() != "Bugsnag Go" {
- t.Errorf("Wrong notifier name in payload")
- }
-
- event := json.Get("events").GetIndex(0)
-
- for k, value := range map[string]string{
- "payloadVersion": "2",
- "severity": "warning",
- "context": "testing",
- "groupingHash": "lol",
- "app.releaseStage": "test",
- "app.version": "1.2.3",
- "device.hostname": "web1",
- "user.id": "123",
- "user.name": "Conrad",
- "user.email": "me@cirw.in",
- "metaData.test.password": "[REDACTED]",
- "metaData.test.value": "able",
- "metaData.test.broken": "[complex128]",
- "metaData.test.recurse._recurse": "[RECURSION]",
- } {
- key := strings.Split(k, ".")
- if event.GetPath(key...).MustString() != value {
- t.Errorf("Wrong %v: %v != %v", key, event.GetPath(key...).MustString(), value)
- }
- }
-
- exception := event.Get("exceptions").GetIndex(0)
-
- if exception.Get("message").MustString() != "hello world" {
- t.Errorf("Wrong message in payload")
- }
-
- if exception.Get("errorClass").MustString() != "*errors.errorString" {
- t.Errorf("Wrong errorClass in payload: %v", exception.Get("errorClass").MustString())
- }
-
- frame0 := exception.Get("stacktrace").GetIndex(0)
- if frame0.Get("file").MustString() != "bugsnag_test.go" ||
- frame0.Get("method").MustString() != "TestNotify" ||
- frame0.Get("inProject").MustBool() != true ||
- frame0.Get("lineNumber").MustInt() == 0 {
- t.Errorf("Wrong frame0")
- }
-
- frame1 := exception.Get("stacktrace").GetIndex(1)
-
- if frame1.Get("file").MustString() != "testing/testing.go" ||
- frame1.Get("method").MustString() != "tRunner" ||
- frame1.Get("inProject").MustBool() != false ||
- frame1.Get("lineNumber").MustInt() == 0 {
- t.Errorf("Wrong frame1")
- }
-}
-
-func crashyHandler(w http.ResponseWriter, r *http.Request) {
- c := make(chan int)
- close(c)
- c <- 1
-}
-
-func runCrashyServer(rawData ...interface{}) (net.Listener, error) {
- l, err := net.Listen("tcp", "127.0.0.1:0")
- if err != nil {
- return nil, err
- }
-
- mux := http.NewServeMux()
- mux.HandleFunc("/", crashyHandler)
- srv := http.Server{
- Addr: l.Addr().String(),
- Handler: Handler(mux, rawData...),
- ErrorLog: log.New(ioutil.Discard, log.Prefix(), 0),
- }
-
- go srv.Serve(l)
- return l, err
-}
-
-func TestHandler(t *testing.T) {
- startTestServer()
-
- l, err := runCrashyServer(Configuration{
- APIKey: testAPIKey,
- Endpoint: testEndpoint,
- ProjectPackages: []string{"github.com/bugsnag/bugsnag-go"},
- Logger: log.New(ioutil.Discard, log.Prefix(), log.Flags()),
- }, SeverityInfo)
- if err != nil {
- t.Fatal(err)
- }
- http.Get("http://" + l.Addr().String() + "/ok?foo=bar")
- l.Close()
-
- json, err := simplejson.NewJson(<-postedJSON)
- if err != nil {
- t.Fatal(err)
- }
-
- if json.Get("apiKey").MustString() != testAPIKey {
- t.Errorf("Wrong api key in payload")
- }
-
- if json.GetPath("notifier", "name").MustString() != "Bugsnag Go" {
- t.Errorf("Wrong notifier name in payload")
- }
-
- event := json.Get("events").GetIndex(0)
-
- for k, value := range map[string]string{
- "payloadVersion": "2",
- "severity": "info",
- "user.id": "127.0.0.1",
- "metaData.Request.Url": "http://" + l.Addr().String() + "/ok?foo=bar",
- "metaData.Request.Method": "GET",
- } {
- key := strings.Split(k, ".")
- if event.GetPath(key...).MustString() != value {
- t.Errorf("Wrong %v: %v != %v", key, event.GetPath(key...).MustString(), value)
- }
- }
-
- if event.GetPath("metaData", "Request", "Params", "foo").GetIndex(0).MustString() != "bar" {
- t.Errorf("missing GET params in request metadata")
- }
-
- if event.GetPath("metaData", "Headers", "Accept-Encoding").GetIndex(0).MustString() != "gzip" {
- t.Errorf("missing GET params in request metadata: %v", event.GetPath("metaData", "Headers"))
- }
-
- exception := event.Get("exceptions").GetIndex(0)
-
- if exception.Get("message").MustString() != "runtime error: send on closed channel" {
- t.Errorf("Wrong message in payload: %v", exception.Get("message").MustString())
- }
-
- if exception.Get("errorClass").MustString() != "runtime.errorCString" {
- t.Errorf("Wrong errorClass in payload: %v", exception.Get("errorClass").MustString())
- }
-
- // TODO:CI these are probably dependent on go version.
- frame0 := exception.Get("stacktrace").GetIndex(0)
- if frame0.Get("file").MustString() != "runtime/panic.c" ||
- frame0.Get("method").MustString() != "panicstring" ||
- frame0.Get("inProject").MustBool() != false ||
- frame0.Get("lineNumber").MustInt() == 0 {
- t.Errorf("Wrong frame0: %v", frame0)
- }
-
- frame3 := exception.Get("stacktrace").GetIndex(3)
-
- if frame3.Get("file").MustString() != "bugsnag_test.go" ||
- frame3.Get("method").MustString() != "crashyHandler" ||
- frame3.Get("inProject").MustBool() != true ||
- frame3.Get("lineNumber").MustInt() == 0 {
- t.Errorf("Wrong frame3: %v", frame3)
- }
-}
-
-func TestAutoNotify(t *testing.T) {
-
- var panicked interface{}
-
- func() {
- defer func() {
- panicked = recover()
- }()
- defer AutoNotify(Configuration{Endpoint: testEndpoint, APIKey: testAPIKey})
-
- panic("eggs")
- }()
-
- if panicked.(string) != "eggs" {
- t.Errorf("didn't re-panic")
- }
-
- json, err := simplejson.NewJson(<-postedJSON)
- if err != nil {
- t.Fatal(err)
- }
-
- event := json.Get("events").GetIndex(0)
-
- if event.Get("severity").MustString() != "error" {
- t.Errorf("severity should be error")
- }
- exception := event.Get("exceptions").GetIndex(0)
-
- if exception.Get("message").MustString() != "eggs" {
- t.Errorf("caught wrong panic")
- }
-}
-
-func TestRecover(t *testing.T) {
- var panicked interface{}
-
- func() {
- defer func() {
- panicked = recover()
- }()
- defer Recover(Configuration{Endpoint: testEndpoint, APIKey: testAPIKey})
-
- panic("ham")
- }()
-
- if panicked != nil {
- t.Errorf("re-panick'd")
- }
-
- json, err := simplejson.NewJson(<-postedJSON)
- if err != nil {
- t.Fatal(err)
- }
-
- event := json.Get("events").GetIndex(0)
-
- if event.Get("severity").MustString() != "warning" {
- t.Errorf("severity should be warning")
- }
- exception := event.Get("exceptions").GetIndex(0)
-
- if exception.Get("message").MustString() != "ham" {
- t.Errorf("caught wrong panic")
- }
-}
-
-func handleGet(w http.ResponseWriter, r *http.Request) {
-
-}
-
-var createAccount = handleGet
-
-type _job struct {
- Name string
- Process func()
-}
-
-func ExampleAutoNotify() interface{} {
- return func(w http.ResponseWriter, request *http.Request) {
- defer AutoNotify(request, Context{"createAccount"})
-
- createAccount(w, request)
- }
-}
-
-func ExampleRecover(job _job) {
- go func() {
- defer Recover(Context{job.Name}, SeverityWarning)
-
- job.Process()
- }()
-}
-
-func ExampleConfigure() {
- Configure(Configuration{
- APIKey: "YOUR_API_KEY_HERE",
-
- ReleaseStage: "production",
-
- // See Configuration{} for other fields
- })
-}
-
-func ExampleHandler() {
- // Set up your http handlers as usual
- http.HandleFunc("/", handleGet)
-
- // use bugsnag.Handler(nil) to wrap the default http handlers
- // so that Bugsnag is automatically notified about panics.
- http.ListenAndServe(":1234", Handler(nil))
-}
-
-func ExampleHandler_customServer() {
- // If you're using a custom server, set the handlers explicitly.
- http.HandleFunc("/", handleGet)
-
- srv := http.Server{
- Addr: ":1234",
- ReadTimeout: 10 * time.Second,
- // use bugsnag.Handler(nil) to wrap the default http handlers
- // so that Bugsnag is automatically notified about panics.
- Handler: Handler(nil),
- }
- srv.ListenAndServe()
-}
-
-func ExampleHandler_customHandlers() {
- // If you're using custom handlers, wrap the handlers explicitly.
- handler := http.NewServeMux()
- http.HandleFunc("/", handleGet)
- // use bugsnag.Handler(handler) to wrap the handlers so that Bugsnag is
- // automatically notified about panics
- http.ListenAndServe(":1234", Handler(handler))
-}
-
-func ExampleNotify() {
- _, err := net.Listen("tcp", ":80")
-
- if err != nil {
- Notify(err)
- }
-}
-
-func ExampleNotify_details(userID string) {
- _, err := net.Listen("tcp", ":80")
-
- if err != nil {
- Notify(err,
- // show as low-severity
- SeverityInfo,
- // set the context
- Context{"createlistener"},
- // pass the user id in to count users affected.
- User{Id: userID},
- // custom meta-data tab
- MetaData{
- "Listen": {
- "Protocol": "tcp",
- "Port": "80",
- },
- },
- )
- }
-
-}
-
-type Job struct {
- Retry bool
- UserId string
- UserEmail string
- Name string
- Params map[string]string
-}
-
-func ExampleOnBeforeNotify() {
- OnBeforeNotify(func(event *Event, config *Configuration) error {
-
- // Search all the RawData for any *Job pointers that we're passed in
- // to bugsnag.Notify() and friends.
- for _, datum := range event.RawData {
- if job, ok := datum.(*Job); ok {
- // don't notify bugsnag about errors in retries
- if job.Retry {
- return fmt.Errorf("bugsnag middleware: not notifying about job retry")
- }
-
- // add the job as a tab on Bugsnag.com
- event.MetaData.AddStruct("Job", job)
-
- // set the user correctly
- event.User = &User{Id: job.UserId, Email: job.UserEmail}
- }
- }
-
- // continue notifying as normal
- return nil
- })
-}
diff --git a/vendor/github.com/bugsnag/bugsnag-go/configuration_test.go b/vendor/github.com/bugsnag/bugsnag-go/configuration_test.go
deleted file mode 100644
index 2bd34889..00000000
--- a/vendor/github.com/bugsnag/bugsnag-go/configuration_test.go
+++ /dev/null
@@ -1,58 +0,0 @@
-package bugsnag
-
-import (
- "testing"
-)
-
-func TestNotifyReleaseStages(t *testing.T) {
-
- var testCases = []struct {
- stage string
- configured []string
- notify bool
- msg string
- }{
- {
- stage: "production",
- notify: true,
- msg: "Should notify in all release stages by default",
- },
- {
- stage: "production",
- configured: []string{"development", "production"},
- notify: true,
- msg: "Failed to notify in configured release stage",
- },
- {
- stage: "staging",
- configured: []string{"development", "production"},
- notify: false,
- msg: "Failed to prevent notification in excluded release stage",
- },
- }
-
- for _, testCase := range testCases {
- Configure(Configuration{ReleaseStage: testCase.stage, NotifyReleaseStages: testCase.configured})
-
- if Config.notifyInReleaseStage() != testCase.notify {
- t.Error(testCase.msg)
- }
- }
-}
-
-func TestProjectPackages(t *testing.T) {
- Configure(Configuration{ProjectPackages: []string{"main", "github.com/ConradIrwin/*"}})
- if !Config.isProjectPackage("main") {
- t.Error("literal project package doesn't work")
- }
- if !Config.isProjectPackage("github.com/ConradIrwin/foo") {
- t.Error("wildcard project package doesn't work")
- }
- if Config.isProjectPackage("runtime") {
- t.Error("wrong packges being marked in project")
- }
- if Config.isProjectPackage("github.com/ConradIrwin/foo/bar") {
- t.Error("wrong packges being marked in project")
- }
-
-}
diff --git a/vendor/github.com/bugsnag/bugsnag-go/errors/error_test.go b/vendor/github.com/bugsnag/bugsnag-go/errors/error_test.go
deleted file mode 100644
index 95232ea2..00000000
--- a/vendor/github.com/bugsnag/bugsnag-go/errors/error_test.go
+++ /dev/null
@@ -1,117 +0,0 @@
-package errors
-
-import (
- "bytes"
- "fmt"
- "io"
- "runtime/debug"
- "testing"
-)
-
-func TestStackFormatMatches(t *testing.T) {
-
- defer func() {
- err := recover()
- if err != 'a' {
- t.Fatal(err)
- }
-
- bs := [][]byte{Errorf("hi").Stack(), debug.Stack()}
-
- // Ignore the first line (as it contains the PC of the .Stack() call)
- bs[0] = bytes.SplitN(bs[0], []byte("\n"), 2)[1]
- bs[1] = bytes.SplitN(bs[1], []byte("\n"), 2)[1]
-
- if bytes.Compare(bs[0], bs[1]) != 0 {
- t.Errorf("Stack didn't match")
- t.Errorf("%s", bs[0])
- t.Errorf("%s", bs[1])
- }
- }()
-
- a()
-}
-
-func TestSkipWorks(t *testing.T) {
-
- defer func() {
- err := recover()
- if err != 'a' {
- t.Fatal(err)
- }
-
- bs := [][]byte{New("hi", 2).Stack(), debug.Stack()}
-
- // should skip four lines of debug.Stack()
- bs[1] = bytes.SplitN(bs[1], []byte("\n"), 5)[4]
-
- if bytes.Compare(bs[0], bs[1]) != 0 {
- t.Errorf("Stack didn't match")
- t.Errorf("%s", bs[0])
- t.Errorf("%s", bs[1])
- }
- }()
-
- a()
-}
-
-func TestNewError(t *testing.T) {
-
- e := func() error {
- return New("hi", 1)
- }()
-
- if e.Error() != "hi" {
- t.Errorf("Constructor with a string failed")
- }
-
- if New(fmt.Errorf("yo"), 0).Error() != "yo" {
- t.Errorf("Constructor with an error failed")
- }
-
- if New(e, 0) != e {
- t.Errorf("Constructor with an Error failed")
- }
-
- if New(nil, 0).Error() != "" {
- t.Errorf("Constructor with nil failed")
- }
-}
-
-func ExampleErrorf(x int) (int, error) {
- if x%2 == 1 {
- return 0, Errorf("can only halve even numbers, got %d", x)
- }
- return x / 2, nil
-}
-
-func ExampleNewError() (error, error) {
- // Wrap io.EOF with the current stack-trace and return it
- return nil, New(io.EOF, 0)
-}
-
-func ExampleNewError_skip() {
- defer func() {
- if err := recover(); err != nil {
- // skip 1 frame (the deferred function) and then return the wrapped err
- err = New(err, 1)
- }
- }()
-}
-
-func ExampleError_Stack(err Error) {
- fmt.Printf("Error: %s\n%s", err.Error(), err.Stack())
-}
-
-func a() error {
- b(5)
- return nil
-}
-
-func b(i int) {
- c()
-}
-
-func c() {
- panic('a')
-}
diff --git a/vendor/github.com/bugsnag/bugsnag-go/errors/parse_panic_test.go b/vendor/github.com/bugsnag/bugsnag-go/errors/parse_panic_test.go
deleted file mode 100644
index f9ed7845..00000000
--- a/vendor/github.com/bugsnag/bugsnag-go/errors/parse_panic_test.go
+++ /dev/null
@@ -1,142 +0,0 @@
-package errors
-
-import (
- "reflect"
- "testing"
-)
-
-var createdBy = `panic: hello!
-
-goroutine 54 [running]:
-runtime.panic(0x35ce40, 0xc208039db0)
- /0/c/go/src/pkg/runtime/panic.c:279 +0xf5
-github.com/loopj/bugsnag-example-apps/go/revelapp/app/controllers.func·001()
- /0/go/src/github.com/loopj/bugsnag-example-apps/go/revelapp/app/controllers/app.go:13 +0x74
-net/http.(*Server).Serve(0xc20806c780, 0x910c88, 0xc20803e168, 0x0, 0x0)
- /0/c/go/src/pkg/net/http/server.go:1698 +0x91
-created by github.com/loopj/bugsnag-example-apps/go/revelapp/app/controllers.App.Index
- /0/go/src/github.com/loopj/bugsnag-example-apps/go/revelapp/app/controllers/app.go:14 +0x3e
-
-goroutine 16 [IO wait]:
-net.runtime_pollWait(0x911c30, 0x72, 0x0)
- /0/c/go/src/pkg/runtime/netpoll.goc:146 +0x66
-net.(*pollDesc).Wait(0xc2080ba990, 0x72, 0x0, 0x0)
- /0/c/go/src/pkg/net/fd_poll_runtime.go:84 +0x46
-net.(*pollDesc).WaitRead(0xc2080ba990, 0x0, 0x0)
- /0/c/go/src/pkg/net/fd_poll_runtime.go:89 +0x42
-net.(*netFD).accept(0xc2080ba930, 0x58be30, 0x0, 0x9103f0, 0x23)
- /0/c/go/src/pkg/net/fd_unix.go:409 +0x343
-net.(*TCPListener).AcceptTCP(0xc20803e168, 0x8, 0x0, 0x0)
- /0/c/go/src/pkg/net/tcpsock_posix.go:234 +0x5d
-net.(*TCPListener).Accept(0xc20803e168, 0x0, 0x0, 0x0, 0x0)
- /0/c/go/src/pkg/net/tcpsock_posix.go:244 +0x4b
-github.com/revel/revel.Run(0xe6d9)
- /0/go/src/github.com/revel/revel/server.go:113 +0x926
-main.main()
- /0/go/src/github.com/loopj/bugsnag-example-apps/go/revelapp/app/tmp/main.go:109 +0xe1a
-`
-
-var normalSplit = `panic: hello!
-
-goroutine 54 [running]:
-runtime.panic(0x35ce40, 0xc208039db0)
- /0/c/go/src/pkg/runtime/panic.c:279 +0xf5
-github.com/loopj/bugsnag-example-apps/go/revelapp/app/controllers.func·001()
- /0/go/src/github.com/loopj/bugsnag-example-apps/go/revelapp/app/controllers/app.go:13 +0x74
-net/http.(*Server).Serve(0xc20806c780, 0x910c88, 0xc20803e168, 0x0, 0x0)
- /0/c/go/src/pkg/net/http/server.go:1698 +0x91
-
-goroutine 16 [IO wait]:
-net.runtime_pollWait(0x911c30, 0x72, 0x0)
- /0/c/go/src/pkg/runtime/netpoll.goc:146 +0x66
-net.(*pollDesc).Wait(0xc2080ba990, 0x72, 0x0, 0x0)
- /0/c/go/src/pkg/net/fd_poll_runtime.go:84 +0x46
-net.(*pollDesc).WaitRead(0xc2080ba990, 0x0, 0x0)
- /0/c/go/src/pkg/net/fd_poll_runtime.go:89 +0x42
-net.(*netFD).accept(0xc2080ba930, 0x58be30, 0x0, 0x9103f0, 0x23)
- /0/c/go/src/pkg/net/fd_unix.go:409 +0x343
-net.(*TCPListener).AcceptTCP(0xc20803e168, 0x8, 0x0, 0x0)
- /0/c/go/src/pkg/net/tcpsock_posix.go:234 +0x5d
-net.(*TCPListener).Accept(0xc20803e168, 0x0, 0x0, 0x0, 0x0)
- /0/c/go/src/pkg/net/tcpsock_posix.go:244 +0x4b
-github.com/revel/revel.Run(0xe6d9)
- /0/go/src/github.com/revel/revel/server.go:113 +0x926
-main.main()
- /0/go/src/github.com/loopj/bugsnag-example-apps/go/revelapp/app/tmp/main.go:109 +0xe1a
-`
-
-var lastGoroutine = `panic: hello!
-
-goroutine 16 [IO wait]:
-net.runtime_pollWait(0x911c30, 0x72, 0x0)
- /0/c/go/src/pkg/runtime/netpoll.goc:146 +0x66
-net.(*pollDesc).Wait(0xc2080ba990, 0x72, 0x0, 0x0)
- /0/c/go/src/pkg/net/fd_poll_runtime.go:84 +0x46
-net.(*pollDesc).WaitRead(0xc2080ba990, 0x0, 0x0)
- /0/c/go/src/pkg/net/fd_poll_runtime.go:89 +0x42
-net.(*netFD).accept(0xc2080ba930, 0x58be30, 0x0, 0x9103f0, 0x23)
- /0/c/go/src/pkg/net/fd_unix.go:409 +0x343
-net.(*TCPListener).AcceptTCP(0xc20803e168, 0x8, 0x0, 0x0)
- /0/c/go/src/pkg/net/tcpsock_posix.go:234 +0x5d
-net.(*TCPListener).Accept(0xc20803e168, 0x0, 0x0, 0x0, 0x0)
- /0/c/go/src/pkg/net/tcpsock_posix.go:244 +0x4b
-github.com/revel/revel.Run(0xe6d9)
- /0/go/src/github.com/revel/revel/server.go:113 +0x926
-main.main()
- /0/go/src/github.com/loopj/bugsnag-example-apps/go/revelapp/app/tmp/main.go:109 +0xe1a
-
-goroutine 54 [running]:
-runtime.panic(0x35ce40, 0xc208039db0)
- /0/c/go/src/pkg/runtime/panic.c:279 +0xf5
-github.com/loopj/bugsnag-example-apps/go/revelapp/app/controllers.func·001()
- /0/go/src/github.com/loopj/bugsnag-example-apps/go/revelapp/app/controllers/app.go:13 +0x74
-net/http.(*Server).Serve(0xc20806c780, 0x910c88, 0xc20803e168, 0x0, 0x0)
- /0/c/go/src/pkg/net/http/server.go:1698 +0x91
-`
-
-var result = []StackFrame{
- StackFrame{File: "/0/c/go/src/pkg/runtime/panic.c", LineNumber: 279, Name: "panic", Package: "runtime"},
- StackFrame{File: "/0/go/src/github.com/loopj/bugsnag-example-apps/go/revelapp/app/controllers/app.go", LineNumber: 13, Name: "func.001", Package: "github.com/loopj/bugsnag-example-apps/go/revelapp/app/controllers"},
- StackFrame{File: "/0/c/go/src/pkg/net/http/server.go", LineNumber: 1698, Name: "(*Server).Serve", Package: "net/http"},
-}
-
-var resultCreatedBy = append(result,
- StackFrame{File: "/0/go/src/github.com/loopj/bugsnag-example-apps/go/revelapp/app/controllers/app.go", LineNumber: 14, Name: "App.Index", Package: "github.com/loopj/bugsnag-example-apps/go/revelapp/app/controllers", ProgramCounter: 0x0})
-
-func TestParsePanic(t *testing.T) {
-
- todo := map[string]string{
- "createdBy": createdBy,
- "normalSplit": normalSplit,
- "lastGoroutine": lastGoroutine,
- }
-
- for key, val := range todo {
- Err, err := ParsePanic(val)
-
- if err != nil {
- t.Fatal(err)
- }
-
- if Err.TypeName() != "panic" {
- t.Errorf("Wrong type: %s", Err.TypeName())
- }
-
- if Err.Error() != "hello!" {
- t.Errorf("Wrong message: %s", Err.TypeName())
- }
-
- if Err.StackFrames()[0].Func() != nil {
- t.Errorf("Somehow managed to find a func...")
- }
-
- result := result
- if key == "createdBy" {
- result = resultCreatedBy
- }
-
- if !reflect.DeepEqual(Err.StackFrames(), result) {
- t.Errorf("Wrong stack for %s: %#v", key, Err.StackFrames())
- }
- }
-}
diff --git a/vendor/github.com/bugsnag/bugsnag-go/metadata_test.go b/vendor/github.com/bugsnag/bugsnag-go/metadata_test.go
deleted file mode 100644
index 37bfaee5..00000000
--- a/vendor/github.com/bugsnag/bugsnag-go/metadata_test.go
+++ /dev/null
@@ -1,182 +0,0 @@
-package bugsnag
-
-import (
- "reflect"
- "testing"
- "unsafe"
-
- "github.com/bugsnag/bugsnag-go/errors"
-)
-
-type _account struct {
- ID string
- Name string
- Plan struct {
- Premium bool
- }
- Password string
- secret string
- Email string `json:"email"`
- EmptyEmail string `json:"emptyemail,omitempty"`
- NotEmptyEmail string `json:"not_empty_email,omitempty"`
-}
-
-type _broken struct {
- Me *_broken
- Data string
-}
-
-var account = _account{}
-var notifier = New(Configuration{})
-
-func TestMetaDataAdd(t *testing.T) {
- m := MetaData{
- "one": {
- "key": "value",
- "override": false,
- }}
-
- m.Add("one", "override", true)
- m.Add("one", "new", "key")
- m.Add("new", "tab", account)
-
- m.AddStruct("lol", "not really a struct")
- m.AddStruct("account", account)
-
- if !reflect.DeepEqual(m, MetaData{
- "one": {
- "key": "value",
- "override": true,
- "new": "key",
- },
- "new": {
- "tab": account,
- },
- "Extra data": {
- "lol": "not really a struct",
- },
- "account": {
- "ID": "",
- "Name": "",
- "Plan": map[string]interface{}{
- "Premium": false,
- },
- "Password": "",
- "email": "",
- },
- }) {
- t.Errorf("metadata.Add didn't work: %#v", m)
- }
-}
-
-func TestMetaDataUpdate(t *testing.T) {
-
- m := MetaData{
- "one": {
- "key": "value",
- "override": false,
- }}
-
- m.Update(MetaData{
- "one": {
- "override": true,
- "new": "key",
- },
- "new": {
- "tab": account,
- },
- })
-
- if !reflect.DeepEqual(m, MetaData{
- "one": {
- "key": "value",
- "override": true,
- "new": "key",
- },
- "new": {
- "tab": account,
- },
- }) {
- t.Errorf("metadata.Update didn't work: %#v", m)
- }
-}
-
-func TestMetaDataSanitize(t *testing.T) {
-
- var broken = _broken{}
- broken.Me = &broken
- broken.Data = "ohai"
- account.Name = "test"
- account.ID = "test"
- account.secret = "hush"
- account.Email = "example@example.com"
- account.EmptyEmail = ""
- account.NotEmptyEmail = "not_empty_email@example.com"
-
- m := MetaData{
- "one": {
- "bool": true,
- "int": 7,
- "float": 7.1,
- "complex": complex(1, 1),
- "func": func() {},
- "unsafe": unsafe.Pointer(broken.Me),
- "string": "string",
- "password": "secret",
- "array": []hash{{
- "creditcard": "1234567812345678",
- "broken": broken,
- }},
- "broken": broken,
- "account": account,
- },
- }
-
- n := m.sanitize([]string{"password", "creditcard"})
-
- if !reflect.DeepEqual(n, map[string]interface{}{
- "one": map[string]interface{}{
- "bool": true,
- "int": 7,
- "float": 7.1,
- "complex": "[complex128]",
- "string": "string",
- "unsafe": "[unsafe.Pointer]",
- "func": "[func()]",
- "password": "[REDACTED]",
- "array": []interface{}{map[string]interface{}{
- "creditcard": "[REDACTED]",
- "broken": map[string]interface{}{
- "Me": "[RECURSION]",
- "Data": "ohai",
- },
- }},
- "broken": map[string]interface{}{
- "Me": "[RECURSION]",
- "Data": "ohai",
- },
- "account": map[string]interface{}{
- "ID": "test",
- "Name": "test",
- "Plan": map[string]interface{}{
- "Premium": false,
- },
- "Password": "[REDACTED]",
- "email": "example@example.com",
- "not_empty_email": "not_empty_email@example.com",
- },
- },
- }) {
- t.Errorf("metadata.Sanitize didn't work: %#v", n)
- }
-
-}
-
-func ExampleMetaData() {
- notifier.Notify(errors.Errorf("hi world"),
- MetaData{"Account": {
- "id": account.ID,
- "name": account.Name,
- "paying?": account.Plan.Premium,
- }})
-}
diff --git a/vendor/github.com/bugsnag/bugsnag-go/middleware_test.go b/vendor/github.com/bugsnag/bugsnag-go/middleware_test.go
deleted file mode 100644
index b1ef77a8..00000000
--- a/vendor/github.com/bugsnag/bugsnag-go/middleware_test.go
+++ /dev/null
@@ -1,88 +0,0 @@
-package bugsnag
-
-import (
- "bytes"
- "fmt"
- "log"
- "reflect"
- "testing"
-)
-
-func TestMiddlewareOrder(t *testing.T) {
-
- result := make([]int, 0, 7)
- stack := middlewareStack{}
- stack.OnBeforeNotify(func(e *Event, c *Configuration) error {
- result = append(result, 2)
- return nil
- })
- stack.OnBeforeNotify(func(e *Event, c *Configuration) error {
- result = append(result, 1)
- return nil
- })
- stack.OnBeforeNotify(func(e *Event, c *Configuration) error {
- result = append(result, 0)
- return nil
- })
-
- stack.Run(nil, nil, func() error {
- result = append(result, 3)
- return nil
- })
-
- if !reflect.DeepEqual(result, []int{0, 1, 2, 3}) {
- t.Errorf("unexpected middleware order %v", result)
- }
-}
-
-func TestBeforeNotifyReturnErr(t *testing.T) {
-
- stack := middlewareStack{}
- err := fmt.Errorf("test")
-
- stack.OnBeforeNotify(func(e *Event, c *Configuration) error {
- return err
- })
-
- called := false
-
- e := stack.Run(nil, nil, func() error {
- called = true
- return nil
- })
-
- if e != err {
- t.Errorf("Middleware didn't return the error")
- }
-
- if called == true {
- t.Errorf("Notify was called when BeforeNotify returned False")
- }
-}
-
-func TestBeforeNotifyPanic(t *testing.T) {
-
- stack := middlewareStack{}
-
- stack.OnBeforeNotify(func(e *Event, c *Configuration) error {
- panic("oops")
- })
-
- called := false
- b := &bytes.Buffer{}
-
- stack.Run(nil, &Configuration{Logger: log.New(b, log.Prefix(), 0)}, func() error {
- called = true
- return nil
- })
-
- logged := b.String()
-
- if logged != "bugsnag/middleware: unexpected panic: oops\n" {
- t.Errorf("Logged: %s", logged)
- }
-
- if called == false {
- t.Errorf("Notify was not called when BeforeNotify panicked")
- }
-}
diff --git a/vendor/github.com/bugsnag/bugsnag-go/panicwrap_test.go b/vendor/github.com/bugsnag/bugsnag-go/panicwrap_test.go
deleted file mode 100644
index 247c3f45..00000000
--- a/vendor/github.com/bugsnag/bugsnag-go/panicwrap_test.go
+++ /dev/null
@@ -1,79 +0,0 @@
-// +build !appengine
-
-package bugsnag
-
-import (
- "github.com/bitly/go-simplejson"
- "github.com/mitchellh/osext"
- "os"
- "os/exec"
- "testing"
- "time"
-)
-
-func TestPanicHandler(t *testing.T) {
- startTestServer()
-
- exePath, err := osext.Executable()
- if err != nil {
- t.Fatal(err)
- }
-
- // Use the same trick as panicwrap() to re-run ourselves.
- // In the init() block below, we will then panic.
- cmd := exec.Command(exePath, os.Args[1:]...)
- cmd.Env = append(os.Environ(), "BUGSNAG_API_KEY="+testAPIKey, "BUGSNAG_ENDPOINT="+testEndpoint, "please_panic=please_panic")
-
- if err = cmd.Start(); err != nil {
- t.Fatal(err)
- }
-
- if err = cmd.Wait(); err.Error() != "exit status 2" {
- t.Fatal(err)
- }
-
- json, err := simplejson.NewJson(<-postedJSON)
- if err != nil {
- t.Fatal(err)
- }
-
- event := json.Get("events").GetIndex(0)
-
- if event.Get("severity").MustString() != "error" {
- t.Errorf("severity should be error")
- }
- exception := event.Get("exceptions").GetIndex(0)
-
- if exception.Get("message").MustString() != "ruh roh" {
- t.Errorf("caught wrong panic")
- }
-
- if exception.Get("errorClass").MustString() != "panic" {
- t.Errorf("caught wrong panic")
- }
-
- frame := exception.Get("stacktrace").GetIndex(1)
-
- // Yeah, we just caught a panic from the init() function below and sent it to the server running above (mindblown)
- if frame.Get("inProject").MustBool() != true ||
- frame.Get("file").MustString() != "panicwrap_test.go" ||
- frame.Get("method").MustString() != "panick" ||
- frame.Get("lineNumber").MustInt() == 0 {
- t.Errorf("stack trace seemed wrong")
- }
-}
-
-func init() {
- if os.Getenv("please_panic") != "" {
- Configure(Configuration{APIKey: os.Getenv("BUGSNAG_API_KEY"), Endpoint: os.Getenv("BUGSNAG_ENDPOINT"), ProjectPackages: []string{"github.com/bugsnag/bugsnag-go"}})
- go func() {
- panick()
- }()
- // Plenty of time to crash, it shouldn't need any of it.
- time.Sleep(1 * time.Second)
- }
-}
-
-func panick() {
- panic("ruh roh")
-}
diff --git a/vendor/github.com/bugsnag/bugsnag-go/revel/bugsnagrevel.go b/vendor/github.com/bugsnag/bugsnag-go/revel/bugsnagrevel.go
deleted file mode 100644
index 149b010c..00000000
--- a/vendor/github.com/bugsnag/bugsnag-go/revel/bugsnagrevel.go
+++ /dev/null
@@ -1,60 +0,0 @@
-// Package bugsnagrevel adds Bugsnag to revel.
-// It lets you pass *revel.Controller into bugsnag.Notify(),
-// and provides a Filter to catch errors.
-package bugsnagrevel
-
-import (
- "strings"
- "sync"
-
- "github.com/bugsnag/bugsnag-go"
- "github.com/revel/revel"
-)
-
-var once sync.Once
-
-// Filter should be added to the filter chain just after the PanicFilter.
-// It sends errors to Bugsnag automatically. Configuration is read out of
-// conf/app.conf, you should set bugsnag.apikey, and can also set
-// bugsnag.endpoint, bugsnag.releasestage, bugsnag.appversion,
-// bugsnag.projectroot, bugsnag.projectpackages if needed.
-func Filter(c *revel.Controller, fc []revel.Filter) {
- defer bugsnag.AutoNotify(c)
- fc[0](c, fc[1:])
-}
-
-// Add support to bugsnag for reading data out of *revel.Controllers
-func middleware(event *bugsnag.Event, config *bugsnag.Configuration) error {
- for _, datum := range event.RawData {
- if controller, ok := datum.(*revel.Controller); ok {
- // make the request visible to the builtin HttpMIddleware
- event.RawData = append(event.RawData, controller.Request.Request)
- event.Context = controller.Action
- event.MetaData.AddStruct("Session", controller.Session)
- }
- }
-
- return nil
-}
-
-func init() {
- revel.OnAppStart(func() {
- bugsnag.OnBeforeNotify(middleware)
-
- var projectPackages []string
- if packages, ok := revel.Config.String("bugsnag.projectpackages"); ok {
- projectPackages = strings.Split(packages, ",")
- } else {
- projectPackages = []string{revel.ImportPath + "/app/*", revel.ImportPath + "/app"}
- }
-
- bugsnag.Configure(bugsnag.Configuration{
- APIKey: revel.Config.StringDefault("bugsnag.apikey", ""),
- Endpoint: revel.Config.StringDefault("bugsnag.endpoint", ""),
- AppVersion: revel.Config.StringDefault("bugsnag.appversion", ""),
- ReleaseStage: revel.Config.StringDefault("bugsnag.releasestage", revel.RunMode),
- ProjectPackages: projectPackages,
- Logger: revel.ERROR,
- })
- })
-}
diff --git a/vendor/github.com/bugsnag/osext/osext_test.go b/vendor/github.com/bugsnag/osext/osext_test.go
deleted file mode 100644
index dc661dbc..00000000
--- a/vendor/github.com/bugsnag/osext/osext_test.go
+++ /dev/null
@@ -1,79 +0,0 @@
-// Copyright 2012 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-// +build darwin linux freebsd netbsd windows
-
-package osext
-
-import (
- "fmt"
- "os"
- oexec "os/exec"
- "path/filepath"
- "runtime"
- "testing"
-)
-
-const execPath_EnvVar = "OSTEST_OUTPUT_EXECPATH"
-
-func TestExecPath(t *testing.T) {
- ep, err := Executable()
- if err != nil {
- t.Fatalf("ExecPath failed: %v", err)
- }
- // we want fn to be of the form "dir/prog"
- dir := filepath.Dir(filepath.Dir(ep))
- fn, err := filepath.Rel(dir, ep)
- if err != nil {
- t.Fatalf("filepath.Rel: %v", err)
- }
- cmd := &oexec.Cmd{}
- // make child start with a relative program path
- cmd.Dir = dir
- cmd.Path = fn
- // forge argv[0] for child, so that we can verify we could correctly
- // get real path of the executable without influenced by argv[0].
- cmd.Args = []string{"-", "-test.run=XXXX"}
- cmd.Env = []string{fmt.Sprintf("%s=1", execPath_EnvVar)}
- out, err := cmd.CombinedOutput()
- if err != nil {
- t.Fatalf("exec(self) failed: %v", err)
- }
- outs := string(out)
- if !filepath.IsAbs(outs) {
- t.Fatalf("Child returned %q, want an absolute path", out)
- }
- if !sameFile(outs, ep) {
- t.Fatalf("Child returned %q, not the same file as %q", out, ep)
- }
-}
-
-func sameFile(fn1, fn2 string) bool {
- fi1, err := os.Stat(fn1)
- if err != nil {
- return false
- }
- fi2, err := os.Stat(fn2)
- if err != nil {
- return false
- }
- return os.SameFile(fi1, fi2)
-}
-
-func init() {
- if e := os.Getenv(execPath_EnvVar); e != "" {
- // first chdir to another path
- dir := "/"
- if runtime.GOOS == "windows" {
- dir = filepath.VolumeName(".")
- }
- os.Chdir(dir)
- if ep, err := Executable(); err != nil {
- fmt.Fprint(os.Stderr, "ERROR: ", err)
- } else {
- fmt.Fprint(os.Stderr, ep)
- }
- os.Exit(0)
- }
-}
diff --git a/vendor/github.com/docker/goamz/aws/sign.go b/vendor/github.com/docker/goamz/aws/sign.go
index d1640d44..8b53e8e8 100644
--- a/vendor/github.com/docker/goamz/aws/sign.go
+++ b/vendor/github.com/docker/goamz/aws/sign.go
@@ -23,7 +23,7 @@ func EncodeSorted(values url.Values) string {
// preallocate the arrays for perfomance
keys := make([]string, 0, len(values))
sarray := make([]string, 0, len(values))
- for k, _ := range values {
+ for k := range values {
keys = append(keys, k)
}
sort.Strings(keys)
@@ -65,7 +65,7 @@ func (s *V2Signer) Sign(method, path string, params map[string]string) {
// from the natural order of the encoded value of key=value.
// Percent and gocheck.Equals affect the sorting order.
var keys, sarray []string
- for k, _ := range params {
+ for k := range params {
keys = append(keys, k)
}
sort.Strings(keys)
@@ -372,7 +372,7 @@ func (s *V4Signer) canonicalHeaders(h http.Header) string {
func (s *V4Signer) signedHeaders(h http.Header) string {
i, a := 0, make([]string, len(h))
- for k, _ := range h {
+ for k := range h {
a[i] = strings.ToLower(k)
i++
}
diff --git a/vendor/github.com/docker/goamz/s3/s3test/server.go b/vendor/github.com/docker/goamz/s3/s3test/server.go
deleted file mode 100644
index ed3eb988..00000000
--- a/vendor/github.com/docker/goamz/s3/s3test/server.go
+++ /dev/null
@@ -1,1023 +0,0 @@
-package s3test
-
-import (
- "bytes"
- "crypto/md5"
- "encoding/base64"
- "encoding/hex"
- "encoding/xml"
- "fmt"
- "github.com/docker/goamz/s3"
- "io"
- "io/ioutil"
- "log"
- "math/rand"
- "net"
- "net/http"
- "net/url"
- "regexp"
- "sort"
- "strconv"
- "strings"
- "sync"
- "time"
-)
-
-const debug = false
-
-var rangePattern = regexp.MustCompile(`^bytes=([\d]*)-([\d]*)$`)
-
-type s3Error struct {
- statusCode int
- XMLName struct{} `xml:"Error"`
- Code string
- Message string
- BucketName string
- RequestId string
- HostId string
-}
-
-type action struct {
- srv *Server
- w http.ResponseWriter
- req *http.Request
- reqId string
-}
-
-// A Clock reports the current time.
-type Clock interface {
- Now() time.Time
-}
-
-type realClock struct{}
-
-func (c *realClock) Now() time.Time {
- return time.Now()
-}
-
-// Config controls the internal behaviour of the Server. A nil config is the default
-// and behaves as if all configurations assume their default behaviour. Once passed
-// to NewServer, the configuration must not be modified.
-type Config struct {
- // Send409Conflict controls how the Server will respond to calls to PUT on a
- // previously existing bucket. The default is false, and corresponds to the
- // us-east-1 s3 enpoint. Setting this value to true emulates the behaviour of
- // all other regions.
- // http://docs.amazonwebservices.com/AmazonS3/latest/API/ErrorResponses.html
- Send409Conflict bool
-
- // Address on which to listen. By default, a random port is assigned by the
- // operating system and the server listens on localhost.
- ListenAddress string
-
- // Clock used to set mtime when updating an object. If nil,
- // use the real clock.
- Clock Clock
-}
-
-func (c *Config) send409Conflict() bool {
- if c != nil {
- return c.Send409Conflict
- }
- return false
-}
-
-// Server is a fake S3 server for testing purposes.
-// All of the data for the server is kept in memory.
-type Server struct {
- url string
- reqId int
- listener net.Listener
- mu sync.Mutex
- buckets map[string]*bucket
- config *Config
- closed bool
-}
-
-type bucket struct {
- name string
- acl s3.ACL
- ctime time.Time
- objects map[string]*object
- multipartUploads map[string][]*multipartUploadPart
- multipartMeta map[string]http.Header
-}
-
-type object struct {
- name string
- mtime time.Time
- meta http.Header // metadata to return with requests.
- checksum []byte // also held as Content-MD5 in meta.
- data []byte
-}
-
-type multipartUploadPart struct {
- index uint
- data []byte
- etag string
- lastModified time.Time
-}
-
-type multipartUploadPartByIndex []*multipartUploadPart
-
-func (x multipartUploadPartByIndex) Len() int {
- return len(x)
-}
-
-func (x multipartUploadPartByIndex) Swap(i, j int) {
- x[i], x[j] = x[j], x[i]
-}
-
-func (x multipartUploadPartByIndex) Less(i, j int) bool {
- return x[i].index < x[j].index
-}
-
-// A resource encapsulates the subject of an HTTP request.
-// The resource referred to may or may not exist
-// when the request is made.
-type resource interface {
- put(a *action) interface{}
- get(a *action) interface{}
- post(a *action) interface{}
- delete(a *action) interface{}
-}
-
-func NewServer(config *Config) (*Server, error) {
- listenAddress := "localhost:0"
-
- if config == nil {
- config = &Config{}
- }
-
- if config.ListenAddress != "" {
- listenAddress = config.ListenAddress
- }
-
- if config.Clock == nil {
- config.Clock = &realClock{}
- }
-
- l, err := net.Listen("tcp", listenAddress)
- if err != nil {
- return nil, fmt.Errorf("cannot listen on localhost: %v", err)
- }
- srv := &Server{
- listener: l,
- url: "http://" + l.Addr().String(),
- buckets: make(map[string]*bucket),
- config: config,
- }
- go http.Serve(l, http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
- srv.serveHTTP(w, req)
- }))
- return srv, nil
-}
-
-// Quit closes down the server.
-func (srv *Server) Quit() {
- srv.mu.Lock()
- srv.closed = true
- srv.mu.Unlock()
-
- srv.listener.Close()
-}
-
-// URL returns a URL for the server.
-func (srv *Server) URL() string {
- return srv.url
-}
-
-func fatalf(code int, codeStr string, errf string, a ...interface{}) {
- panic(&s3Error{
- statusCode: code,
- Code: codeStr,
- Message: fmt.Sprintf(errf, a...),
- })
-}
-
-// serveHTTP serves the S3 protocol.
-func (srv *Server) serveHTTP(w http.ResponseWriter, req *http.Request) {
- // ignore error from ParseForm as it's usually spurious.
- req.ParseForm()
-
- srv.mu.Lock()
- defer srv.mu.Unlock()
-
- if srv.closed {
- hj := w.(http.Hijacker)
- conn, _, _ := hj.Hijack()
- conn.Close()
- return
- }
-
- if debug {
- log.Printf("s3test %q %q", req.Method, req.URL)
- }
- a := &action{
- srv: srv,
- w: w,
- req: req,
- reqId: fmt.Sprintf("%09X", srv.reqId),
- }
- srv.reqId++
-
- var r resource
- defer func() {
- switch err := recover().(type) {
- case *s3Error:
- switch r := r.(type) {
- case objectResource:
- err.BucketName = r.bucket.name
- case bucketResource:
- err.BucketName = r.name
- }
- err.RequestId = a.reqId
- // TODO HostId
- w.Header().Set("Content-Type", `xml version="1.0" encoding="UTF-8"`)
- w.WriteHeader(err.statusCode)
- xmlMarshal(w, err)
- case nil:
- default:
- panic(err)
- }
- }()
-
- r = srv.resourceForURL(req.URL)
-
- var resp interface{}
- switch req.Method {
- case "PUT":
- resp = r.put(a)
- case "GET", "HEAD":
- resp = r.get(a)
- case "DELETE":
- resp = r.delete(a)
- case "POST":
- resp = r.post(a)
- default:
- fatalf(400, "MethodNotAllowed", "unknown http request method %q", req.Method)
- }
- if resp != nil && req.Method != "HEAD" {
- xmlMarshal(w, resp)
- }
-}
-
-// xmlMarshal is the same as xml.Marshal except that
-// it panics on error. The marshalling should not fail,
-// but we want to know if it does.
-func xmlMarshal(w io.Writer, x interface{}) {
- if err := xml.NewEncoder(w).Encode(x); err != nil {
- panic(fmt.Errorf("error marshalling %#v: %v", x, err))
- }
-}
-
-// In a fully implemented test server, each of these would have
-// its own resource type.
-var unimplementedBucketResourceNames = map[string]bool{
- "acl": true,
- "lifecycle": true,
- "policy": true,
- "location": true,
- "logging": true,
- "notification": true,
- "versions": true,
- "requestPayment": true,
- "versioning": true,
- "website": true,
- "uploads": true,
-}
-
-var unimplementedObjectResourceNames = map[string]bool{
- "acl": true,
- "torrent": true,
-}
-
-var pathRegexp = regexp.MustCompile("/(([^/]+)(/(.*))?)?")
-
-// resourceForURL returns a resource object for the given URL.
-func (srv *Server) resourceForURL(u *url.URL) (r resource) {
- m := pathRegexp.FindStringSubmatch(u.Path)
- if m == nil {
- fatalf(404, "InvalidURI", "Couldn't parse the specified URI")
- }
- bucketName := m[2]
- objectName := m[4]
- if bucketName == "" {
- return nullResource{} // root
- }
- b := bucketResource{
- name: bucketName,
- bucket: srv.buckets[bucketName],
- }
- q := u.Query()
- if objectName == "" {
- for name := range q {
- if unimplementedBucketResourceNames[name] {
- return nullResource{}
- }
- }
- return b
-
- }
- if b.bucket == nil {
- fatalf(404, "NoSuchBucket", "The specified bucket does not exist")
- }
- objr := objectResource{
- name: objectName,
- version: q.Get("versionId"),
- bucket: b.bucket,
- }
- for name := range q {
- if unimplementedObjectResourceNames[name] {
- return nullResource{}
- }
- }
- if obj := objr.bucket.objects[objr.name]; obj != nil {
- objr.object = obj
- }
- return objr
-}
-
-// nullResource has error stubs for all resource methods.
-type nullResource struct{}
-
-func notAllowed() interface{} {
- fatalf(400, "MethodNotAllowed", "The specified method is not allowed against this resource")
- return nil
-}
-
-func (nullResource) put(a *action) interface{} { return notAllowed() }
-func (nullResource) get(a *action) interface{} { return notAllowed() }
-func (nullResource) post(a *action) interface{} { return notAllowed() }
-func (nullResource) delete(a *action) interface{} { return notAllowed() }
-
-const timeFormat = "2006-01-02T15:04:05.000Z"
-const lastModifiedTimeFormat = "Mon, 2 Jan 2006 15:04:05 GMT"
-
-type bucketResource struct {
- name string
- bucket *bucket // non-nil if the bucket already exists.
-}
-
-// GET on a bucket lists the objects in the bucket.
-// http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGET.html
-func (r bucketResource) get(a *action) interface{} {
- if r.bucket == nil {
- fatalf(404, "NoSuchBucket", "The specified bucket does not exist")
- }
- delimiter := a.req.Form.Get("delimiter")
- marker := a.req.Form.Get("marker")
- maxKeys := -1
- if s := a.req.Form.Get("max-keys"); s != "" {
- i, err := strconv.Atoi(s)
- if err != nil || i < 0 {
- fatalf(400, "invalid value for max-keys: %q", s)
- }
- maxKeys = i
- }
- prefix := a.req.Form.Get("prefix")
- a.w.Header().Set("Content-Type", "application/xml")
-
- if a.req.Method == "HEAD" {
- return nil
- }
-
- var objs orderedObjects
-
- // first get all matching objects and arrange them in alphabetical order.
- for name, obj := range r.bucket.objects {
- if strings.HasPrefix(name, prefix) {
- objs = append(objs, obj)
- }
- }
- sort.Sort(objs)
-
- if maxKeys <= 0 {
- maxKeys = 1000
- }
-
- type commonPrefix struct {
- Prefix string
- }
-
- type serverListResponse struct {
- s3.ListResp
- CommonPrefixes []commonPrefix
- }
-
- resp := &serverListResponse{
- ListResp: s3.ListResp{
- Name: r.bucket.name,
- Prefix: prefix,
- Delimiter: delimiter,
- Marker: marker,
- MaxKeys: maxKeys,
- },
- }
-
- var prefixes []commonPrefix
- var lastName string
- for _, obj := range objs {
- if !strings.HasPrefix(obj.name, prefix) {
- continue
- }
- name := obj.name
- isPrefix := false
- if delimiter != "" {
- if i := strings.Index(obj.name[len(prefix):], delimiter); i >= 0 {
- name = obj.name[:len(prefix)+i+len(delimiter)]
- if prefixes != nil && prefixes[len(prefixes)-1].Prefix == name {
- continue
- }
- isPrefix = true
- }
- }
- if name <= marker {
- continue
- }
- if len(resp.Contents)+len(prefixes) >= maxKeys {
- resp.IsTruncated = true
- resp.NextMarker = lastName
- break
- }
- if isPrefix {
- prefixes = append(prefixes, commonPrefix{Prefix: name})
- } else {
- // Contents contains only keys not found in CommonPrefixes
- resp.Contents = append(resp.Contents, obj.s3Key())
- }
- lastName = name
- }
- resp.CommonPrefixes = prefixes
- return resp
-}
-
-// orderedObjects holds a slice of objects that can be sorted
-// by name.
-type orderedObjects []*object
-
-func (s orderedObjects) Len() int {
- return len(s)
-}
-func (s orderedObjects) Swap(i, j int) {
- s[i], s[j] = s[j], s[i]
-}
-func (s orderedObjects) Less(i, j int) bool {
- return s[i].name < s[j].name
-}
-
-func (obj *object) s3Key() s3.Key {
- return s3.Key{
- Key: obj.name,
- LastModified: obj.mtime.UTC().Format(timeFormat),
- Size: int64(len(obj.data)),
- ETag: fmt.Sprintf(`"%x"`, obj.checksum),
- // TODO StorageClass
- // TODO Owner
- }
-}
-
-// DELETE on a bucket deletes the bucket if it's not empty.
-func (r bucketResource) delete(a *action) interface{} {
- b := r.bucket
- if b == nil {
- fatalf(404, "NoSuchBucket", "The specified bucket does not exist")
- }
- if len(b.objects) > 0 {
- fatalf(400, "BucketNotEmpty", "The bucket you tried to delete is not empty")
- }
- delete(a.srv.buckets, b.name)
- return nil
-}
-
-// PUT on a bucket creates the bucket.
-// http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUT.html
-func (r bucketResource) put(a *action) interface{} {
- var created bool
- if r.bucket == nil {
- if !validBucketName(r.name) {
- fatalf(400, "InvalidBucketName", "The specified bucket is not valid")
- }
- if loc := locationConstraint(a); loc == "" {
- fatalf(400, "InvalidRequets", "The unspecified location constraint is incompatible for the region specific endpoint this request was sent to.")
- }
- // TODO validate acl
- r.bucket = &bucket{
- name: r.name,
- // TODO default acl
- objects: make(map[string]*object),
- multipartUploads: make(map[string][]*multipartUploadPart),
- multipartMeta: make(map[string]http.Header),
- }
- a.srv.buckets[r.name] = r.bucket
- created = true
- }
- if !created && a.srv.config.send409Conflict() {
- fatalf(409, "BucketAlreadyOwnedByYou", "Your previous request to create the named bucket succeeded and you already own it.")
- }
- r.bucket.acl = s3.ACL(a.req.Header.Get("x-amz-acl"))
- return nil
-}
-
-func (r bucketResource) post(a *action) interface{} {
- if _, multiDel := a.req.URL.Query()["delete"]; multiDel {
- return r.multiDel(a)
- }
-
- fatalf(400, "Method", "bucket operation not supported")
- return nil
-}
-
-func (b bucketResource) multiDel(a *action) interface{} {
- type multiDelRequestObject struct {
- Key string
- VersionId string
- }
-
- type multiDelRequest struct {
- Quiet bool
- Object []*multiDelRequestObject
- }
-
- type multiDelDelete struct {
- XMLName struct{} `xml:"Deleted"`
- Key string
- }
-
- type multiDelError struct {
- XMLName struct{} `xml:"Error"`
- Key string
- Code string
- Message string
- }
-
- type multiDelResult struct {
- XMLName struct{} `xml:"DeleteResult"`
- Deleted []*multiDelDelete
- Error []*multiDelError
- }
-
- req := &multiDelRequest{}
-
- if err := xml.NewDecoder(a.req.Body).Decode(req); err != nil {
- fatalf(400, "InvalidRequest", err.Error())
- }
-
- res := &multiDelResult{
- Deleted: []*multiDelDelete{},
- Error: []*multiDelError{},
- }
-
- for _, o := range req.Object {
- if _, exists := b.bucket.objects[o.Key]; exists {
- delete(b.bucket.objects, o.Key)
-
- res.Deleted = append(res.Deleted, &multiDelDelete{
- Key: o.Key,
- })
- } else {
- res.Error = append(res.Error, &multiDelError{
- Key: o.Key,
- Code: "AccessDenied",
- Message: "Access Denied",
- })
- }
- }
-
- return res
-}
-
-// validBucketName returns whether name is a valid bucket name.
-// Here are the rules, from:
-// http://docs.amazonwebservices.com/AmazonS3/2006-03-01/dev/BucketRestrictions.html
-//
-// Can contain lowercase letters, numbers, periods (.), underscores (_),
-// and dashes (-). You can use uppercase letters for buckets only in the
-// US Standard region.
-//
-// Must start with a number or letter
-//
-// Must be between 3 and 255 characters long
-//
-// There's one extra rule (Must not be formatted as an IP address (e.g., 192.168.5.4)
-// but the real S3 server does not seem to check that rule, so we will not
-// check it either.
-//
-func validBucketName(name string) bool {
- if len(name) < 3 || len(name) > 255 {
- return false
- }
- r := name[0]
- if !(r >= '0' && r <= '9' || r >= 'a' && r <= 'z') {
- return false
- }
- for _, r := range name {
- switch {
- case r >= '0' && r <= '9':
- case r >= 'a' && r <= 'z':
- case r == '_' || r == '-':
- case r == '.':
- default:
- return false
- }
- }
- return true
-}
-
-var responseParams = map[string]bool{
- "content-type": true,
- "content-language": true,
- "expires": true,
- "cache-control": true,
- "content-disposition": true,
- "content-encoding": true,
-}
-
-type objectResource struct {
- name string
- version string
- bucket *bucket // always non-nil.
- object *object // may be nil.
-}
-
-// GET on an object gets the contents of the object.
-// http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGET.html
-func (objr objectResource) get(a *action) interface{} {
- obj := objr.object
- if obj == nil {
- fatalf(404, "NoSuchKey", "The specified key does not exist.")
- }
- h := a.w.Header()
- // add metadata
- for name, d := range obj.meta {
- h[name] = d
- }
- // override header values in response to request parameters.
- for name, vals := range a.req.Form {
- if strings.HasPrefix(name, "response-") {
- name = name[len("response-"):]
- if !responseParams[name] {
- continue
- }
- h.Set(name, vals[0])
- }
- }
-
- data := obj.data
- status := http.StatusOK
- if r := a.req.Header.Get("Range"); r != "" {
- // s3 ignores invalid ranges
- if matches := rangePattern.FindStringSubmatch(r); len(matches) == 3 {
- var err error
- start := 0
- end := len(obj.data) - 1
- if matches[1] != "" {
- start, err = strconv.Atoi(matches[1])
- }
- if err == nil && matches[2] != "" {
- end, err = strconv.Atoi(matches[2])
- }
- if err == nil && start >= 0 && end >= start {
- if start >= len(obj.data) {
- fatalf(416, "InvalidRequest", "The requested range is not satisfiable")
- }
- if end > len(obj.data)-1 {
- end = len(obj.data) - 1
- }
- data = obj.data[start : end+1]
- status = http.StatusPartialContent
- h.Set("Content-Range", fmt.Sprintf("bytes %d-%d/%d", start, end, len(obj.data)))
- }
- }
- }
- // TODO Last-Modified-Since
- // TODO If-Modified-Since
- // TODO If-Unmodified-Since
- // TODO If-Match
- // TODO If-None-Match
- // TODO Connection: close ??
- // TODO x-amz-request-id
- h.Set("Content-Length", fmt.Sprint(len(data)))
- h.Set("ETag", "\""+hex.EncodeToString(obj.checksum)+"\"")
- h.Set("Last-Modified", obj.mtime.UTC().Format(lastModifiedTimeFormat))
-
- if status != http.StatusOK {
- a.w.WriteHeader(status)
- }
-
- if a.req.Method == "HEAD" {
- return nil
- }
- // TODO avoid holding the lock when writing data.
- _, err := a.w.Write(data)
- if err != nil {
- // we can't do much except just log the fact.
- log.Printf("error writing data: %v", err)
- }
- return nil
-}
-
-var metaHeaders = map[string]bool{
- "Content-MD5": true,
- "x-amz-acl": true,
- "Content-Type": true,
- "Content-Encoding": true,
- "Content-Disposition": true,
-}
-
-// PUT on an object creates the object.
-func (objr objectResource) put(a *action) interface{} {
- // TODO Cache-Control header
- // TODO Expires header
- // TODO x-amz-server-side-encryption
- // TODO x-amz-storage-class
-
- var res interface{}
-
- uploadId := a.req.URL.Query().Get("uploadId")
- var partNumber uint
-
- // Check that the upload ID is valid if this is a multipart upload
- if uploadId != "" {
- if _, ok := objr.bucket.multipartUploads[uploadId]; !ok {
- fatalf(404, "NoSuchUpload", "The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.")
- }
-
- partNumberStr := a.req.URL.Query().Get("partNumber")
-
- if partNumberStr == "" {
- fatalf(400, "InvalidRequest", "Missing partNumber parameter")
- }
-
- number, err := strconv.ParseUint(partNumberStr, 10, 32)
-
- if err != nil {
- fatalf(400, "InvalidRequest", "partNumber is not a number")
- }
-
- partNumber = uint(number)
- }
-
- var expectHash []byte
- if c := a.req.Header.Get("Content-MD5"); c != "" {
- var err error
- expectHash, err = base64.StdEncoding.DecodeString(c)
- if err != nil || len(expectHash) != md5.Size {
- fatalf(400, "InvalidDigest", "The Content-MD5 you specified was invalid")
- }
- }
- sum := md5.New()
- // TODO avoid holding lock while reading data.
- data, err := ioutil.ReadAll(io.TeeReader(a.req.Body, sum))
- if err != nil {
- fatalf(400, "TODO", "read error")
- }
- gotHash := sum.Sum(nil)
- if expectHash != nil && bytes.Compare(gotHash, expectHash) != 0 {
- fatalf(400, "BadDigest", "The Content-MD5 you specified did not match what we received")
- }
- if a.req.ContentLength >= 0 && int64(len(data)) != a.req.ContentLength {
- fatalf(400, "IncompleteBody", "You did not provide the number of bytes specified by the Content-Length HTTP header")
- }
-
- etag := fmt.Sprintf("\"%x\"", gotHash)
-
- a.w.Header().Add("ETag", etag)
-
- if uploadId == "" {
- // For traditional uploads
-
- // TODO is this correct, or should we erase all previous metadata?
- obj := objr.object
- if obj == nil {
- obj = &object{
- name: objr.name,
- meta: make(http.Header),
- }
- }
-
- // PUT request has been successful - save data and metadata
- for key, values := range a.req.Header {
- key = http.CanonicalHeaderKey(key)
- if metaHeaders[key] || strings.HasPrefix(key, "X-Amz-Meta-") {
- obj.meta[key] = values
- }
- }
- obj.mtime = a.srv.config.Clock.Now()
-
- if copySource := a.req.Header.Get("X-Amz-Copy-Source"); copySource != "" {
- idx := strings.IndexByte(copySource, '/')
-
- if idx == -1 {
- fatalf(400, "InvalidRequest", "Wrongly formatted X-Amz-Copy-Source")
- }
-
- sourceBucketName := copySource[0:idx]
- sourceKey := copySource[1+idx:]
-
- sourceBucket := a.srv.buckets[sourceBucketName]
-
- if sourceBucket == nil {
- fatalf(404, "NoSuchBucket", "The specified source bucket does not exist")
- }
-
- sourceObject := sourceBucket.objects[sourceKey]
-
- if sourceObject == nil {
- fatalf(404, "NoSuchKey", "The specified source key does not exist")
- }
-
- obj.data = make([]byte, len(sourceObject.data))
- copy(obj.data, sourceObject.data)
-
- obj.checksum = make([]byte, len(sourceObject.checksum))
- copy(obj.checksum, sourceObject.checksum)
-
- obj.meta = make(http.Header, len(sourceObject.meta))
-
- for k, v := range sourceObject.meta {
- obj.meta[k] = make([]string, len(v))
- copy(obj.meta[k], v)
- }
-
- res = &s3.CopyObjectResult{
- ETag: etag,
- LastModified: obj.mtime.UTC().Format(time.RFC3339),
- }
- } else {
- obj.data = data
- obj.checksum = gotHash
- }
- objr.bucket.objects[objr.name] = obj
- } else {
- // For multipart commit
-
- parts := objr.bucket.multipartUploads[uploadId]
- part := &multipartUploadPart{
- index: partNumber,
- data: data,
- etag: etag,
- lastModified: a.srv.config.Clock.Now(),
- }
-
- objr.bucket.multipartUploads[uploadId] = append(parts, part)
- }
-
- return res
-}
-
-func (objr objectResource) delete(a *action) interface{} {
- uploadId := a.req.URL.Query().Get("uploadId")
-
- if uploadId == "" {
- // Traditional object delete
- delete(objr.bucket.objects, objr.name)
- } else {
- // Multipart commit abort
- _, ok := objr.bucket.multipartUploads[uploadId]
-
- if !ok {
- fatalf(404, "NoSuchUpload", "The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.")
- }
-
- delete(objr.bucket.multipartUploads, uploadId)
- }
- return nil
-}
-
-func (objr objectResource) post(a *action) interface{} {
- // Check if we're initializing a multipart upload
- if _, ok := a.req.URL.Query()["uploads"]; ok {
- type multipartInitResponse struct {
- XMLName struct{} `xml:"InitiateMultipartUploadResult"`
- Bucket string
- Key string
- UploadId string
- }
-
- uploadId := strconv.FormatInt(rand.Int63(), 16)
-
- objr.bucket.multipartUploads[uploadId] = []*multipartUploadPart{}
- objr.bucket.multipartMeta[uploadId] = make(http.Header)
- for key, values := range a.req.Header {
- key = http.CanonicalHeaderKey(key)
- if metaHeaders[key] || strings.HasPrefix(key, "X-Amz-Meta-") {
- objr.bucket.multipartMeta[uploadId][key] = values
- }
- }
-
- return &multipartInitResponse{
- Bucket: objr.bucket.name,
- Key: objr.name,
- UploadId: uploadId,
- }
- }
-
- // Check if we're completing a multipart upload
- if uploadId := a.req.URL.Query().Get("uploadId"); uploadId != "" {
- type multipartCompleteRequestPart struct {
- XMLName struct{} `xml:"Part"`
- PartNumber uint
- ETag string
- }
-
- type multipartCompleteRequest struct {
- XMLName struct{} `xml:"CompleteMultipartUpload"`
- Part []multipartCompleteRequestPart
- }
-
- type multipartCompleteResponse struct {
- XMLName struct{} `xml:"CompleteMultipartUploadResult"`
- Location string
- Bucket string
- Key string
- ETag string
- }
-
- parts, ok := objr.bucket.multipartUploads[uploadId]
-
- if !ok {
- fatalf(404, "NoSuchUpload", "The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.")
- }
-
- req := &multipartCompleteRequest{}
-
- if err := xml.NewDecoder(a.req.Body).Decode(req); err != nil {
- fatalf(400, "InvalidRequest", err.Error())
- }
-
- if len(req.Part) != len(parts) {
- fatalf(400, "InvalidRequest", fmt.Sprintf("Number of parts does not match: expected %d, received %d", len(parts), len(req.Part)))
- }
-
- sum := md5.New()
- data := &bytes.Buffer{}
- w := io.MultiWriter(sum, data)
-
- sort.Sort(multipartUploadPartByIndex(parts))
-
- for i, p := range parts {
- reqPart := req.Part[i]
-
- if reqPart.PartNumber != p.index {
- fatalf(400, "InvalidRequest", "Bad part number")
- }
-
- if reqPart.ETag != p.etag {
- fatalf(400, "InvalidRequest", fmt.Sprintf("Invalid etag for part %d", reqPart.PartNumber))
- }
-
- w.Write(p.data)
- }
-
- delete(objr.bucket.multipartUploads, uploadId)
-
- obj := objr.object
-
- if obj == nil {
- obj = &object{
- name: objr.name,
- meta: make(http.Header),
- }
- }
-
- obj.data = data.Bytes()
- obj.checksum = sum.Sum(nil)
- obj.mtime = time.Now()
- objr.bucket.objects[objr.name] = obj
- obj.meta = objr.bucket.multipartMeta[uploadId]
-
- objectLocation := fmt.Sprintf("http://%s/%s/%s", a.srv.listener.Addr().String(), objr.bucket.name, objr.name)
-
- return &multipartCompleteResponse{
- Location: objectLocation,
- Bucket: objr.bucket.name,
- Key: objr.name,
- ETag: uploadId,
- }
- }
-
- fatalf(400, "MethodNotAllowed", "The specified method is not allowed against this resource")
- return nil
-}
-
-type CreateBucketConfiguration struct {
- LocationConstraint string
-}
-
-// locationConstraint parses the request body (if present).
-// If there is no body, an empty string will be returned.
-func locationConstraint(a *action) string {
- var body bytes.Buffer
- if _, err := io.Copy(&body, a.req.Body); err != nil {
- fatalf(400, "InvalidRequest", err.Error())
- }
- if body.Len() == 0 {
- return ""
- }
- var loc CreateBucketConfiguration
- if err := xml.NewDecoder(&body).Decode(&loc); err != nil {
- fatalf(400, "InvalidRequest", err.Error())
- }
- return loc.LocationConstraint
-}
diff --git a/vendor/github.com/docker/libtrust/certificates_test.go b/vendor/github.com/docker/libtrust/certificates_test.go
deleted file mode 100644
index c111f353..00000000
--- a/vendor/github.com/docker/libtrust/certificates_test.go
+++ /dev/null
@@ -1,111 +0,0 @@
-package libtrust
-
-import (
- "encoding/pem"
- "io/ioutil"
- "net"
- "os"
- "path"
- "testing"
-)
-
-func TestGenerateCertificates(t *testing.T) {
- key, err := GenerateECP256PrivateKey()
- if err != nil {
- t.Fatal(err)
- }
-
- _, err = GenerateSelfSignedServerCert(key, []string{"localhost"}, []net.IP{net.ParseIP("127.0.0.1")})
- if err != nil {
- t.Fatal(err)
- }
-
- _, err = GenerateSelfSignedClientCert(key)
- if err != nil {
- t.Fatal(err)
- }
-}
-
-func TestGenerateCACertPool(t *testing.T) {
- key, err := GenerateECP256PrivateKey()
- if err != nil {
- t.Fatal(err)
- }
-
- caKey1, err := GenerateECP256PrivateKey()
- if err != nil {
- t.Fatal(err)
- }
-
- caKey2, err := GenerateECP256PrivateKey()
- if err != nil {
- t.Fatal(err)
- }
-
- _, err = GenerateCACertPool(key, []PublicKey{caKey1.PublicKey(), caKey2.PublicKey()})
- if err != nil {
- t.Fatal(err)
- }
-}
-
-func TestLoadCertificates(t *testing.T) {
- key, err := GenerateECP256PrivateKey()
- if err != nil {
- t.Fatal(err)
- }
-
- caKey1, err := GenerateECP256PrivateKey()
- if err != nil {
- t.Fatal(err)
- }
- caKey2, err := GenerateECP256PrivateKey()
- if err != nil {
- t.Fatal(err)
- }
-
- cert1, err := GenerateCACert(caKey1, key)
- if err != nil {
- t.Fatal(err)
- }
- cert2, err := GenerateCACert(caKey2, key)
- if err != nil {
- t.Fatal(err)
- }
-
- d, err := ioutil.TempDir("/tmp", "cert-test")
- if err != nil {
- t.Fatal(err)
- }
- caFile := path.Join(d, "ca.pem")
- f, err := os.OpenFile(caFile, os.O_CREATE|os.O_WRONLY, 0644)
- if err != nil {
- t.Fatal(err)
- }
-
- err = pem.Encode(f, &pem.Block{Type: "CERTIFICATE", Bytes: cert1.Raw})
- if err != nil {
- t.Fatal(err)
- }
- err = pem.Encode(f, &pem.Block{Type: "CERTIFICATE", Bytes: cert2.Raw})
- if err != nil {
- t.Fatal(err)
- }
- f.Close()
-
- certs, err := LoadCertificateBundle(caFile)
- if err != nil {
- t.Fatal(err)
- }
- if len(certs) != 2 {
- t.Fatalf("Wrong number of certs received, expected: %d, received %d", 2, len(certs))
- }
-
- pool, err := LoadCertificatePool(caFile)
- if err != nil {
- t.Fatal(err)
- }
-
- if len(pool.Subjects()) != 2 {
- t.Fatalf("Invalid certificate pool")
- }
-}
diff --git a/vendor/github.com/docker/libtrust/ec_key_test.go b/vendor/github.com/docker/libtrust/ec_key_test.go
deleted file mode 100644
index 26ac3814..00000000
--- a/vendor/github.com/docker/libtrust/ec_key_test.go
+++ /dev/null
@@ -1,157 +0,0 @@
-package libtrust
-
-import (
- "bytes"
- "encoding/json"
- "testing"
-)
-
-func generateECTestKeys(t *testing.T) []PrivateKey {
- p256Key, err := GenerateECP256PrivateKey()
- if err != nil {
- t.Fatal(err)
- }
-
- p384Key, err := GenerateECP384PrivateKey()
- if err != nil {
- t.Fatal(err)
- }
-
- p521Key, err := GenerateECP521PrivateKey()
- if err != nil {
- t.Fatal(err)
- }
-
- return []PrivateKey{p256Key, p384Key, p521Key}
-}
-
-func TestECKeys(t *testing.T) {
- ecKeys := generateECTestKeys(t)
-
- for _, ecKey := range ecKeys {
- if ecKey.KeyType() != "EC" {
- t.Fatalf("key type must be %q, instead got %q", "EC", ecKey.KeyType())
- }
- }
-}
-
-func TestECSignVerify(t *testing.T) {
- ecKeys := generateECTestKeys(t)
-
- message := "Hello, World!"
- data := bytes.NewReader([]byte(message))
-
- sigAlgs := []*signatureAlgorithm{es256, es384, es512}
-
- for i, ecKey := range ecKeys {
- sigAlg := sigAlgs[i]
-
- t.Logf("%s signature of %q with kid: %s\n", sigAlg.HeaderParam(), message, ecKey.KeyID())
-
- data.Seek(0, 0) // Reset the byte reader
-
- // Sign
- sig, alg, err := ecKey.Sign(data, sigAlg.HashID())
- if err != nil {
- t.Fatal(err)
- }
-
- data.Seek(0, 0) // Reset the byte reader
-
- // Verify
- err = ecKey.Verify(data, alg, sig)
- if err != nil {
- t.Fatal(err)
- }
- }
-}
-
-func TestMarshalUnmarshalECKeys(t *testing.T) {
- ecKeys := generateECTestKeys(t)
- data := bytes.NewReader([]byte("This is a test. I repeat: this is only a test."))
- sigAlgs := []*signatureAlgorithm{es256, es384, es512}
-
- for i, ecKey := range ecKeys {
- sigAlg := sigAlgs[i]
- privateJWKJSON, err := json.MarshalIndent(ecKey, "", " ")
- if err != nil {
- t.Fatal(err)
- }
-
- publicJWKJSON, err := json.MarshalIndent(ecKey.PublicKey(), "", " ")
- if err != nil {
- t.Fatal(err)
- }
-
- t.Logf("JWK Private Key: %s", string(privateJWKJSON))
- t.Logf("JWK Public Key: %s", string(publicJWKJSON))
-
- privKey2, err := UnmarshalPrivateKeyJWK(privateJWKJSON)
- if err != nil {
- t.Fatal(err)
- }
-
- pubKey2, err := UnmarshalPublicKeyJWK(publicJWKJSON)
- if err != nil {
- t.Fatal(err)
- }
-
- // Ensure we can sign/verify a message with the unmarshalled keys.
- data.Seek(0, 0) // Reset the byte reader
- signature, alg, err := privKey2.Sign(data, sigAlg.HashID())
- if err != nil {
- t.Fatal(err)
- }
-
- data.Seek(0, 0) // Reset the byte reader
- err = pubKey2.Verify(data, alg, signature)
- if err != nil {
- t.Fatal(err)
- }
- }
-}
-
-func TestFromCryptoECKeys(t *testing.T) {
- ecKeys := generateECTestKeys(t)
-
- for _, ecKey := range ecKeys {
- cryptoPrivateKey := ecKey.CryptoPrivateKey()
- cryptoPublicKey := ecKey.CryptoPublicKey()
-
- pubKey, err := FromCryptoPublicKey(cryptoPublicKey)
- if err != nil {
- t.Fatal(err)
- }
-
- if pubKey.KeyID() != ecKey.KeyID() {
- t.Fatal("public key key ID mismatch")
- }
-
- privKey, err := FromCryptoPrivateKey(cryptoPrivateKey)
- if err != nil {
- t.Fatal(err)
- }
-
- if privKey.KeyID() != ecKey.KeyID() {
- t.Fatal("public key key ID mismatch")
- }
- }
-}
-
-func TestExtendedFields(t *testing.T) {
- key, err := GenerateECP256PrivateKey()
- if err != nil {
- t.Fatal(err)
- }
-
- key.AddExtendedField("test", "foobar")
- val := key.GetExtendedField("test")
-
- gotVal, ok := val.(string)
- if !ok {
- t.Fatalf("value is not a string")
- } else if gotVal != val {
- t.Fatalf("value %q is not equal to %q", gotVal, val)
- }
-
-}
diff --git a/vendor/github.com/docker/libtrust/filter_test.go b/vendor/github.com/docker/libtrust/filter_test.go
deleted file mode 100644
index 997e554c..00000000
--- a/vendor/github.com/docker/libtrust/filter_test.go
+++ /dev/null
@@ -1,81 +0,0 @@
-package libtrust
-
-import (
- "testing"
-)
-
-func compareKeySlices(t *testing.T, sliceA, sliceB []PublicKey) {
- if len(sliceA) != len(sliceB) {
- t.Fatalf("slice size %d, expected %d", len(sliceA), len(sliceB))
- }
-
- for i, itemA := range sliceA {
- itemB := sliceB[i]
- if itemA != itemB {
- t.Fatalf("slice index %d not equal: %#v != %#v", i, itemA, itemB)
- }
- }
-}
-
-func TestFilter(t *testing.T) {
- keys := make([]PublicKey, 0, 8)
-
- // Create 8 keys and add host entries.
- for i := 0; i < cap(keys); i++ {
- key, err := GenerateECP256PrivateKey()
- if err != nil {
- t.Fatal(err)
- }
-
- // we use both []interface{} and []string here because jwt uses
- // []interface{} format, while PEM uses []string
- switch {
- case i == 0:
- // Don't add entries for this key, key 0.
- break
- case i%2 == 0:
- // Should catch keys 2, 4, and 6.
- key.AddExtendedField("hosts", []interface{}{"*.even.example.com"})
- case i == 7:
- // Should catch only the last key, and make it match any hostname.
- key.AddExtendedField("hosts", []string{"*"})
- default:
- // should catch keys 1, 3, 5.
- key.AddExtendedField("hosts", []string{"*.example.com"})
- }
-
- keys = append(keys, key)
- }
-
- // Should match 2 keys, the empty one, and the one that matches all hosts.
- matchedKeys, err := FilterByHosts(keys, "foo.bar.com", true)
- if err != nil {
- t.Fatal(err)
- }
- expectedMatch := []PublicKey{keys[0], keys[7]}
- compareKeySlices(t, expectedMatch, matchedKeys)
-
- // Should match 1 key, the one that matches any host.
- matchedKeys, err = FilterByHosts(keys, "foo.bar.com", false)
- if err != nil {
- t.Fatal(err)
- }
- expectedMatch = []PublicKey{keys[7]}
- compareKeySlices(t, expectedMatch, matchedKeys)
-
- // Should match keys that end in "example.com", and the key that matches anything.
- matchedKeys, err = FilterByHosts(keys, "foo.example.com", false)
- if err != nil {
- t.Fatal(err)
- }
- expectedMatch = []PublicKey{keys[1], keys[3], keys[5], keys[7]}
- compareKeySlices(t, expectedMatch, matchedKeys)
-
- // Should match all of the keys except the empty key.
- matchedKeys, err = FilterByHosts(keys, "foo.even.example.com", false)
- if err != nil {
- t.Fatal(err)
- }
- expectedMatch = keys[1:]
- compareKeySlices(t, expectedMatch, matchedKeys)
-}
diff --git a/vendor/github.com/docker/libtrust/jsonsign_test.go b/vendor/github.com/docker/libtrust/jsonsign_test.go
deleted file mode 100644
index b4f26979..00000000
--- a/vendor/github.com/docker/libtrust/jsonsign_test.go
+++ /dev/null
@@ -1,380 +0,0 @@
-package libtrust
-
-import (
- "bytes"
- "crypto/rand"
- "crypto/x509"
- "encoding/json"
- "fmt"
- "io"
- "testing"
-
- "github.com/docker/libtrust/testutil"
-)
-
-func createTestJSON(sigKey string, indent string) (map[string]interface{}, []byte) {
- testMap := map[string]interface{}{
- "name": "dmcgowan/mycontainer",
- "config": map[string]interface{}{
- "ports": []int{9101, 9102},
- "run": "/bin/echo \"Hello\"",
- },
- "layers": []string{
- "2893c080-27f5-11e4-8c21-0800200c9a66",
- "c54bc25b-fbb2-497b-a899-a8bc1b5b9d55",
- "4d5d7e03-f908-49f3-a7f6-9ba28dfe0fb4",
- "0b6da891-7f7f-4abf-9c97-7887549e696c",
- "1d960389-ae4f-4011-85fd-18d0f96a67ad",
- },
- }
- formattedSection := `{"config":{"ports":[9101,9102],"run":"/bin/echo \"Hello\""},"layers":["2893c080-27f5-11e4-8c21-0800200c9a66","c54bc25b-fbb2-497b-a899-a8bc1b5b9d55","4d5d7e03-f908-49f3-a7f6-9ba28dfe0fb4","0b6da891-7f7f-4abf-9c97-7887549e696c","1d960389-ae4f-4011-85fd-18d0f96a67ad"],"name":"dmcgowan/mycontainer","%s":[{"header":{`
- formattedSection = fmt.Sprintf(formattedSection, sigKey)
- if indent != "" {
- buf := bytes.NewBuffer(nil)
- json.Indent(buf, []byte(formattedSection), "", indent)
- return testMap, buf.Bytes()
- }
- return testMap, []byte(formattedSection)
-
-}
-
-func TestSignJSON(t *testing.T) {
- key, err := GenerateECP256PrivateKey()
- if err != nil {
- t.Fatalf("Error generating EC key: %s", err)
- }
-
- testMap, _ := createTestJSON("buildSignatures", " ")
- indented, err := json.MarshalIndent(testMap, "", " ")
- if err != nil {
- t.Fatalf("Marshall error: %s", err)
- }
-
- js, err := NewJSONSignature(indented)
- if err != nil {
- t.Fatalf("Error creating JSON signature: %s", err)
- }
- err = js.Sign(key)
- if err != nil {
- t.Fatalf("Error signing content: %s", err)
- }
-
- keys, err := js.Verify()
- if err != nil {
- t.Fatalf("Error verifying signature: %s", err)
- }
- if len(keys) != 1 {
- t.Fatalf("Error wrong number of keys returned")
- }
- if keys[0].KeyID() != key.KeyID() {
- t.Fatalf("Unexpected public key returned")
- }
-
-}
-
-func TestSignMap(t *testing.T) {
- key, err := GenerateECP256PrivateKey()
- if err != nil {
- t.Fatalf("Error generating EC key: %s", err)
- }
-
- testMap, _ := createTestJSON("buildSignatures", " ")
- js, err := NewJSONSignatureFromMap(testMap)
- if err != nil {
- t.Fatalf("Error creating JSON signature: %s", err)
- }
- err = js.Sign(key)
- if err != nil {
- t.Fatalf("Error signing JSON signature: %s", err)
- }
-
- keys, err := js.Verify()
- if err != nil {
- t.Fatalf("Error verifying signature: %s", err)
- }
- if len(keys) != 1 {
- t.Fatalf("Error wrong number of keys returned")
- }
- if keys[0].KeyID() != key.KeyID() {
- t.Fatalf("Unexpected public key returned")
- }
-}
-
-func TestFormattedJson(t *testing.T) {
- key, err := GenerateECP256PrivateKey()
- if err != nil {
- t.Fatalf("Error generating EC key: %s", err)
- }
-
- testMap, firstSection := createTestJSON("buildSignatures", " ")
- indented, err := json.MarshalIndent(testMap, "", " ")
- if err != nil {
- t.Fatalf("Marshall error: %s", err)
- }
-
- js, err := NewJSONSignature(indented)
- if err != nil {
- t.Fatalf("Error creating JSON signature: %s", err)
- }
- err = js.Sign(key)
- if err != nil {
- t.Fatalf("Error signing content: %s", err)
- }
-
- b, err := js.PrettySignature("buildSignatures")
- if err != nil {
- t.Fatalf("Error signing map: %s", err)
- }
-
- if bytes.Compare(b[:len(firstSection)], firstSection) != 0 {
- t.Fatalf("Wrong signed value\nExpected:\n%s\nActual:\n%s", firstSection, b[:len(firstSection)])
- }
-
- parsed, err := ParsePrettySignature(b, "buildSignatures")
- if err != nil {
- t.Fatalf("Error parsing formatted signature: %s", err)
- }
-
- keys, err := parsed.Verify()
- if err != nil {
- t.Fatalf("Error verifying signature: %s", err)
- }
- if len(keys) != 1 {
- t.Fatalf("Error wrong number of keys returned")
- }
- if keys[0].KeyID() != key.KeyID() {
- t.Fatalf("Unexpected public key returned")
- }
-
- var unmarshalled map[string]interface{}
- err = json.Unmarshal(b, &unmarshalled)
- if err != nil {
- t.Fatalf("Could not unmarshall after parse: %s", err)
- }
-
-}
-
-func TestFormattedFlatJson(t *testing.T) {
- key, err := GenerateECP256PrivateKey()
- if err != nil {
- t.Fatalf("Error generating EC key: %s", err)
- }
-
- testMap, firstSection := createTestJSON("buildSignatures", "")
- unindented, err := json.Marshal(testMap)
- if err != nil {
- t.Fatalf("Marshall error: %s", err)
- }
-
- js, err := NewJSONSignature(unindented)
- if err != nil {
- t.Fatalf("Error creating JSON signature: %s", err)
- }
- err = js.Sign(key)
- if err != nil {
- t.Fatalf("Error signing JSON signature: %s", err)
- }
-
- b, err := js.PrettySignature("buildSignatures")
- if err != nil {
- t.Fatalf("Error signing map: %s", err)
- }
-
- if bytes.Compare(b[:len(firstSection)], firstSection) != 0 {
- t.Fatalf("Wrong signed value\nExpected:\n%s\nActual:\n%s", firstSection, b[:len(firstSection)])
- }
-
- parsed, err := ParsePrettySignature(b, "buildSignatures")
- if err != nil {
- t.Fatalf("Error parsing formatted signature: %s", err)
- }
-
- keys, err := parsed.Verify()
- if err != nil {
- t.Fatalf("Error verifying signature: %s", err)
- }
- if len(keys) != 1 {
- t.Fatalf("Error wrong number of keys returned")
- }
- if keys[0].KeyID() != key.KeyID() {
- t.Fatalf("Unexpected public key returned")
- }
-}
-
-func generateTrustChain(t *testing.T, key PrivateKey, ca *x509.Certificate) (PrivateKey, []*x509.Certificate) {
- parent := ca
- parentKey := key
- chain := make([]*x509.Certificate, 6)
- for i := 5; i > 0; i-- {
- intermediatekey, err := GenerateECP256PrivateKey()
- if err != nil {
- t.Fatalf("Error generate key: %s", err)
- }
- chain[i], err = testutil.GenerateIntermediate(intermediatekey.CryptoPublicKey(), parentKey.CryptoPrivateKey(), parent)
- if err != nil {
- t.Fatalf("Error generating intermdiate certificate: %s", err)
- }
- parent = chain[i]
- parentKey = intermediatekey
- }
- trustKey, err := GenerateECP256PrivateKey()
- if err != nil {
- t.Fatalf("Error generate key: %s", err)
- }
- chain[0], err = testutil.GenerateTrustCert(trustKey.CryptoPublicKey(), parentKey.CryptoPrivateKey(), parent)
- if err != nil {
- t.Fatalf("Error generate trust cert: %s", err)
- }
-
- return trustKey, chain
-}
-
-func TestChainVerify(t *testing.T) {
- caKey, err := GenerateECP256PrivateKey()
- if err != nil {
- t.Fatalf("Error generating key: %s", err)
- }
- ca, err := testutil.GenerateTrustCA(caKey.CryptoPublicKey(), caKey.CryptoPrivateKey())
- if err != nil {
- t.Fatalf("Error generating ca: %s", err)
- }
- trustKey, chain := generateTrustChain(t, caKey, ca)
-
- testMap, _ := createTestJSON("verifySignatures", " ")
- js, err := NewJSONSignatureFromMap(testMap)
- if err != nil {
- t.Fatalf("Error creating JSONSignature from map: %s", err)
- }
-
- err = js.SignWithChain(trustKey, chain)
- if err != nil {
- t.Fatalf("Error signing with chain: %s", err)
- }
-
- pool := x509.NewCertPool()
- pool.AddCert(ca)
- chains, err := js.VerifyChains(pool)
- if err != nil {
- t.Fatalf("Error verifying content: %s", err)
- }
- if len(chains) != 1 {
- t.Fatalf("Unexpected chains length: %d", len(chains))
- }
- if len(chains[0]) != 7 {
- t.Fatalf("Unexpected chain length: %d", len(chains[0]))
- }
-}
-
-func TestInvalidChain(t *testing.T) {
- caKey, err := GenerateECP256PrivateKey()
- if err != nil {
- t.Fatalf("Error generating key: %s", err)
- }
- ca, err := testutil.GenerateTrustCA(caKey.CryptoPublicKey(), caKey.CryptoPrivateKey())
- if err != nil {
- t.Fatalf("Error generating ca: %s", err)
- }
- trustKey, chain := generateTrustChain(t, caKey, ca)
-
- testMap, _ := createTestJSON("verifySignatures", " ")
- js, err := NewJSONSignatureFromMap(testMap)
- if err != nil {
- t.Fatalf("Error creating JSONSignature from map: %s", err)
- }
-
- err = js.SignWithChain(trustKey, chain[:5])
- if err != nil {
- t.Fatalf("Error signing with chain: %s", err)
- }
-
- pool := x509.NewCertPool()
- pool.AddCert(ca)
- chains, err := js.VerifyChains(pool)
- if err == nil {
- t.Fatalf("Expected error verifying with bad chain")
- }
- if len(chains) != 0 {
- t.Fatalf("Unexpected chains returned from invalid verify")
- }
-}
-
-func TestMergeSignatures(t *testing.T) {
- pk1, err := GenerateECP256PrivateKey()
- if err != nil {
- t.Fatalf("unexpected error generating private key 1: %v", err)
- }
-
- pk2, err := GenerateECP256PrivateKey()
- if err != nil {
- t.Fatalf("unexpected error generating private key 2: %v", err)
- }
-
- payload := make([]byte, 1<<10)
- if _, err = io.ReadFull(rand.Reader, payload); err != nil {
- t.Fatalf("error generating payload: %v", err)
- }
-
- payload, _ = json.Marshal(map[string]interface{}{"data": payload})
-
- sig1, err := NewJSONSignature(payload)
- if err != nil {
- t.Fatalf("unexpected error creating signature 1: %v", err)
- }
-
- if err := sig1.Sign(pk1); err != nil {
- t.Fatalf("unexpected error signing with pk1: %v", err)
- }
-
- sig2, err := NewJSONSignature(payload)
- if err != nil {
- t.Fatalf("unexpected error creating signature 2: %v", err)
- }
-
- if err := sig2.Sign(pk2); err != nil {
- t.Fatalf("unexpected error signing with pk2: %v", err)
- }
-
- // Now, we actually merge into sig1
- if err := sig1.Merge(sig2); err != nil {
- t.Fatalf("unexpected error merging: %v", err)
- }
-
- // Verify the new signature package
- pubkeys, err := sig1.Verify()
- if err != nil {
- t.Fatalf("unexpected error during verify: %v", err)
- }
-
- // Make sure the pubkeys match the two private keys from before
- privkeys := map[string]PrivateKey{
- pk1.KeyID(): pk1,
- pk2.KeyID(): pk2,
- }
-
- found := map[string]struct{}{}
-
- for _, pubkey := range pubkeys {
- if _, ok := privkeys[pubkey.KeyID()]; !ok {
- t.Fatalf("unexpected public key found during verification: %v", pubkey)
- }
-
- found[pubkey.KeyID()] = struct{}{}
- }
-
- // Make sure we've found all the private keys from verification
- for keyid, _ := range privkeys {
- if _, ok := found[keyid]; !ok {
- t.Fatalf("public key %v not found during verification", keyid)
- }
- }
-
- // Create another signature, with a different payload, and ensure we get an error.
- sig3, err := NewJSONSignature([]byte("{}"))
- if err != nil {
- t.Fatalf("unexpected error making signature for sig3: %v", err)
- }
-
- if err := sig1.Merge(sig3); err == nil {
- t.Fatalf("error expected during invalid merge with different payload")
- }
-}
diff --git a/vendor/github.com/docker/libtrust/key_files_test.go b/vendor/github.com/docker/libtrust/key_files_test.go
deleted file mode 100644
index 57e691f2..00000000
--- a/vendor/github.com/docker/libtrust/key_files_test.go
+++ /dev/null
@@ -1,220 +0,0 @@
-package libtrust
-
-import (
- "errors"
- "io/ioutil"
- "os"
- "testing"
-)
-
-func makeTempFile(t *testing.T, prefix string) (filename string) {
- file, err := ioutil.TempFile("", prefix)
- if err != nil {
- t.Fatal(err)
- }
-
- filename = file.Name()
- file.Close()
-
- return
-}
-
-func TestKeyFiles(t *testing.T) {
- key, err := GenerateECP256PrivateKey()
- if err != nil {
- t.Fatal(err)
- }
-
- testKeyFiles(t, key)
-
- key, err = GenerateRSA2048PrivateKey()
- if err != nil {
- t.Fatal(err)
- }
-
- testKeyFiles(t, key)
-}
-
-func testKeyFiles(t *testing.T, key PrivateKey) {
- var err error
-
- privateKeyFilename := makeTempFile(t, "private_key")
- privateKeyFilenamePEM := privateKeyFilename + ".pem"
- privateKeyFilenameJWK := privateKeyFilename + ".jwk"
-
- publicKeyFilename := makeTempFile(t, "public_key")
- publicKeyFilenamePEM := publicKeyFilename + ".pem"
- publicKeyFilenameJWK := publicKeyFilename + ".jwk"
-
- if err = SaveKey(privateKeyFilenamePEM, key); err != nil {
- t.Fatal(err)
- }
-
- if err = SaveKey(privateKeyFilenameJWK, key); err != nil {
- t.Fatal(err)
- }
-
- if err = SavePublicKey(publicKeyFilenamePEM, key.PublicKey()); err != nil {
- t.Fatal(err)
- }
-
- if err = SavePublicKey(publicKeyFilenameJWK, key.PublicKey()); err != nil {
- t.Fatal(err)
- }
-
- loadedPEMKey, err := LoadKeyFile(privateKeyFilenamePEM)
- if err != nil {
- t.Fatal(err)
- }
-
- loadedJWKKey, err := LoadKeyFile(privateKeyFilenameJWK)
- if err != nil {
- t.Fatal(err)
- }
-
- loadedPEMPublicKey, err := LoadPublicKeyFile(publicKeyFilenamePEM)
- if err != nil {
- t.Fatal(err)
- }
-
- loadedJWKPublicKey, err := LoadPublicKeyFile(publicKeyFilenameJWK)
- if err != nil {
- t.Fatal(err)
- }
-
- if key.KeyID() != loadedPEMKey.KeyID() {
- t.Fatal(errors.New("key IDs do not match"))
- }
-
- if key.KeyID() != loadedJWKKey.KeyID() {
- t.Fatal(errors.New("key IDs do not match"))
- }
-
- if key.KeyID() != loadedPEMPublicKey.KeyID() {
- t.Fatal(errors.New("key IDs do not match"))
- }
-
- if key.KeyID() != loadedJWKPublicKey.KeyID() {
- t.Fatal(errors.New("key IDs do not match"))
- }
-
- os.Remove(privateKeyFilename)
- os.Remove(privateKeyFilenamePEM)
- os.Remove(privateKeyFilenameJWK)
- os.Remove(publicKeyFilename)
- os.Remove(publicKeyFilenamePEM)
- os.Remove(publicKeyFilenameJWK)
-}
-
-func TestTrustedHostKeysFile(t *testing.T) {
- trustedHostKeysFilename := makeTempFile(t, "trusted_host_keys")
- trustedHostKeysFilenamePEM := trustedHostKeysFilename + ".pem"
- trustedHostKeysFilenameJWK := trustedHostKeysFilename + ".json"
-
- testTrustedHostKeysFile(t, trustedHostKeysFilenamePEM)
- testTrustedHostKeysFile(t, trustedHostKeysFilenameJWK)
-
- os.Remove(trustedHostKeysFilename)
- os.Remove(trustedHostKeysFilenamePEM)
- os.Remove(trustedHostKeysFilenameJWK)
-}
-
-func testTrustedHostKeysFile(t *testing.T, trustedHostKeysFilename string) {
- hostAddress1 := "docker.example.com:2376"
- hostKey1, err := GenerateECP256PrivateKey()
- if err != nil {
- t.Fatal(err)
- }
-
- hostKey1.AddExtendedField("hosts", []string{hostAddress1})
- err = AddKeySetFile(trustedHostKeysFilename, hostKey1.PublicKey())
- if err != nil {
- t.Fatal(err)
- }
-
- trustedHostKeysMapping, err := LoadKeySetFile(trustedHostKeysFilename)
- if err != nil {
- t.Fatal(err)
- }
-
- for addr, hostKey := range trustedHostKeysMapping {
- t.Logf("Host Address: %d\n", addr)
- t.Logf("Host Key: %s\n\n", hostKey)
- }
-
- hostAddress2 := "192.168.59.103:2376"
- hostKey2, err := GenerateRSA2048PrivateKey()
- if err != nil {
- t.Fatal(err)
- }
-
- hostKey2.AddExtendedField("hosts", hostAddress2)
- err = AddKeySetFile(trustedHostKeysFilename, hostKey2.PublicKey())
- if err != nil {
- t.Fatal(err)
- }
-
- trustedHostKeysMapping, err = LoadKeySetFile(trustedHostKeysFilename)
- if err != nil {
- t.Fatal(err)
- }
-
- for addr, hostKey := range trustedHostKeysMapping {
- t.Logf("Host Address: %d\n", addr)
- t.Logf("Host Key: %s\n\n", hostKey)
- }
-
-}
-
-func TestTrustedClientKeysFile(t *testing.T) {
- trustedClientKeysFilename := makeTempFile(t, "trusted_client_keys")
- trustedClientKeysFilenamePEM := trustedClientKeysFilename + ".pem"
- trustedClientKeysFilenameJWK := trustedClientKeysFilename + ".json"
-
- testTrustedClientKeysFile(t, trustedClientKeysFilenamePEM)
- testTrustedClientKeysFile(t, trustedClientKeysFilenameJWK)
-
- os.Remove(trustedClientKeysFilename)
- os.Remove(trustedClientKeysFilenamePEM)
- os.Remove(trustedClientKeysFilenameJWK)
-}
-
-func testTrustedClientKeysFile(t *testing.T, trustedClientKeysFilename string) {
- clientKey1, err := GenerateECP256PrivateKey()
- if err != nil {
- t.Fatal(err)
- }
-
- err = AddKeySetFile(trustedClientKeysFilename, clientKey1.PublicKey())
- if err != nil {
- t.Fatal(err)
- }
-
- trustedClientKeys, err := LoadKeySetFile(trustedClientKeysFilename)
- if err != nil {
- t.Fatal(err)
- }
-
- for _, clientKey := range trustedClientKeys {
- t.Logf("Client Key: %s\n", clientKey)
- }
-
- clientKey2, err := GenerateRSA2048PrivateKey()
- if err != nil {
- t.Fatal(err)
- }
-
- err = AddKeySetFile(trustedClientKeysFilename, clientKey2.PublicKey())
- if err != nil {
- t.Fatal(err)
- }
-
- trustedClientKeys, err = LoadKeySetFile(trustedClientKeysFilename)
- if err != nil {
- t.Fatal(err)
- }
-
- for _, clientKey := range trustedClientKeys {
- t.Logf("Client Key: %s\n", clientKey)
- }
-}
diff --git a/vendor/github.com/docker/libtrust/key_test.go b/vendor/github.com/docker/libtrust/key_test.go
deleted file mode 100644
index f6c59cc4..00000000
--- a/vendor/github.com/docker/libtrust/key_test.go
+++ /dev/null
@@ -1,80 +0,0 @@
-package libtrust
-
-import (
- "testing"
-)
-
-type generateFunc func() (PrivateKey, error)
-
-func runGenerateBench(b *testing.B, f generateFunc, name string) {
- for i := 0; i < b.N; i++ {
- _, err := f()
- if err != nil {
- b.Fatalf("Error generating %s: %s", name, err)
- }
- }
-}
-
-func runFingerprintBench(b *testing.B, f generateFunc, name string) {
- b.StopTimer()
- // Don't count this relatively slow generation call.
- key, err := f()
- if err != nil {
- b.Fatalf("Error generating %s: %s", name, err)
- }
- b.StartTimer()
-
- for i := 0; i < b.N; i++ {
- if key.KeyID() == "" {
- b.Fatalf("Error generating key ID for %s", name)
- }
- }
-}
-
-func BenchmarkECP256Generate(b *testing.B) {
- runGenerateBench(b, GenerateECP256PrivateKey, "P256")
-}
-
-func BenchmarkECP384Generate(b *testing.B) {
- runGenerateBench(b, GenerateECP384PrivateKey, "P384")
-}
-
-func BenchmarkECP521Generate(b *testing.B) {
- runGenerateBench(b, GenerateECP521PrivateKey, "P521")
-}
-
-func BenchmarkRSA2048Generate(b *testing.B) {
- runGenerateBench(b, GenerateRSA2048PrivateKey, "RSA2048")
-}
-
-func BenchmarkRSA3072Generate(b *testing.B) {
- runGenerateBench(b, GenerateRSA3072PrivateKey, "RSA3072")
-}
-
-func BenchmarkRSA4096Generate(b *testing.B) {
- runGenerateBench(b, GenerateRSA4096PrivateKey, "RSA4096")
-}
-
-func BenchmarkECP256Fingerprint(b *testing.B) {
- runFingerprintBench(b, GenerateECP256PrivateKey, "P256")
-}
-
-func BenchmarkECP384Fingerprint(b *testing.B) {
- runFingerprintBench(b, GenerateECP384PrivateKey, "P384")
-}
-
-func BenchmarkECP521Fingerprint(b *testing.B) {
- runFingerprintBench(b, GenerateECP521PrivateKey, "P521")
-}
-
-func BenchmarkRSA2048Fingerprint(b *testing.B) {
- runFingerprintBench(b, GenerateRSA2048PrivateKey, "RSA2048")
-}
-
-func BenchmarkRSA3072Fingerprint(b *testing.B) {
- runFingerprintBench(b, GenerateRSA3072PrivateKey, "RSA3072")
-}
-
-func BenchmarkRSA4096Fingerprint(b *testing.B) {
- runFingerprintBench(b, GenerateRSA4096PrivateKey, "RSA4096")
-}
diff --git a/vendor/github.com/docker/libtrust/rsa_key_test.go b/vendor/github.com/docker/libtrust/rsa_key_test.go
deleted file mode 100644
index 5ec7707a..00000000
--- a/vendor/github.com/docker/libtrust/rsa_key_test.go
+++ /dev/null
@@ -1,157 +0,0 @@
-package libtrust
-
-import (
- "bytes"
- "encoding/json"
- "log"
- "testing"
-)
-
-var rsaKeys []PrivateKey
-
-func init() {
- var err error
- rsaKeys, err = generateRSATestKeys()
- if err != nil {
- log.Fatal(err)
- }
-}
-
-func generateRSATestKeys() (keys []PrivateKey, err error) {
- log.Println("Generating RSA 2048-bit Test Key")
- rsa2048Key, err := GenerateRSA2048PrivateKey()
- if err != nil {
- return
- }
-
- log.Println("Generating RSA 3072-bit Test Key")
- rsa3072Key, err := GenerateRSA3072PrivateKey()
- if err != nil {
- return
- }
-
- log.Println("Generating RSA 4096-bit Test Key")
- rsa4096Key, err := GenerateRSA4096PrivateKey()
- if err != nil {
- return
- }
-
- log.Println("Done generating RSA Test Keys!")
- keys = []PrivateKey{rsa2048Key, rsa3072Key, rsa4096Key}
-
- return
-}
-
-func TestRSAKeys(t *testing.T) {
- for _, rsaKey := range rsaKeys {
- if rsaKey.KeyType() != "RSA" {
- t.Fatalf("key type must be %q, instead got %q", "RSA", rsaKey.KeyType())
- }
- }
-}
-
-func TestRSASignVerify(t *testing.T) {
- message := "Hello, World!"
- data := bytes.NewReader([]byte(message))
-
- sigAlgs := []*signatureAlgorithm{rs256, rs384, rs512}
-
- for i, rsaKey := range rsaKeys {
- sigAlg := sigAlgs[i]
-
- t.Logf("%s signature of %q with kid: %s\n", sigAlg.HeaderParam(), message, rsaKey.KeyID())
-
- data.Seek(0, 0) // Reset the byte reader
-
- // Sign
- sig, alg, err := rsaKey.Sign(data, sigAlg.HashID())
- if err != nil {
- t.Fatal(err)
- }
-
- data.Seek(0, 0) // Reset the byte reader
-
- // Verify
- err = rsaKey.Verify(data, alg, sig)
- if err != nil {
- t.Fatal(err)
- }
- }
-}
-
-func TestMarshalUnmarshalRSAKeys(t *testing.T) {
- data := bytes.NewReader([]byte("This is a test. I repeat: this is only a test."))
- sigAlgs := []*signatureAlgorithm{rs256, rs384, rs512}
-
- for i, rsaKey := range rsaKeys {
- sigAlg := sigAlgs[i]
- privateJWKJSON, err := json.MarshalIndent(rsaKey, "", " ")
- if err != nil {
- t.Fatal(err)
- }
-
- publicJWKJSON, err := json.MarshalIndent(rsaKey.PublicKey(), "", " ")
- if err != nil {
- t.Fatal(err)
- }
-
- t.Logf("JWK Private Key: %s", string(privateJWKJSON))
- t.Logf("JWK Public Key: %s", string(publicJWKJSON))
-
- privKey2, err := UnmarshalPrivateKeyJWK(privateJWKJSON)
- if err != nil {
- t.Fatal(err)
- }
-
- pubKey2, err := UnmarshalPublicKeyJWK(publicJWKJSON)
- if err != nil {
- t.Fatal(err)
- }
-
- // Ensure we can sign/verify a message with the unmarshalled keys.
- data.Seek(0, 0) // Reset the byte reader
- signature, alg, err := privKey2.Sign(data, sigAlg.HashID())
- if err != nil {
- t.Fatal(err)
- }
-
- data.Seek(0, 0) // Reset the byte reader
- err = pubKey2.Verify(data, alg, signature)
- if err != nil {
- t.Fatal(err)
- }
-
- // It's a good idea to validate the Private Key to make sure our
- // (un)marshal process didn't corrupt the extra parameters.
- k := privKey2.(*rsaPrivateKey)
- err = k.PrivateKey.Validate()
- if err != nil {
- t.Fatal(err)
- }
- }
-}
-
-func TestFromCryptoRSAKeys(t *testing.T) {
- for _, rsaKey := range rsaKeys {
- cryptoPrivateKey := rsaKey.CryptoPrivateKey()
- cryptoPublicKey := rsaKey.CryptoPublicKey()
-
- pubKey, err := FromCryptoPublicKey(cryptoPublicKey)
- if err != nil {
- t.Fatal(err)
- }
-
- if pubKey.KeyID() != rsaKey.KeyID() {
- t.Fatal("public key key ID mismatch")
- }
-
- privKey, err := FromCryptoPrivateKey(cryptoPrivateKey)
- if err != nil {
- t.Fatal(err)
- }
-
- if privKey.KeyID() != rsaKey.KeyID() {
- t.Fatal("public key key ID mismatch")
- }
- }
-}
diff --git a/vendor/github.com/docker/libtrust/testutil/certificates.go b/vendor/github.com/docker/libtrust/testutil/certificates.go
deleted file mode 100644
index 89debf6b..00000000
--- a/vendor/github.com/docker/libtrust/testutil/certificates.go
+++ /dev/null
@@ -1,94 +0,0 @@
-package testutil
-
-import (
- "crypto"
- "crypto/rand"
- "crypto/x509"
- "crypto/x509/pkix"
- "math/big"
- "time"
-)
-
-// GenerateTrustCA generates a new certificate authority for testing.
-func GenerateTrustCA(pub crypto.PublicKey, priv crypto.PrivateKey) (*x509.Certificate, error) {
- cert := &x509.Certificate{
- SerialNumber: big.NewInt(0),
- Subject: pkix.Name{
- CommonName: "CA Root",
- },
- NotBefore: time.Now().Add(-time.Second),
- NotAfter: time.Now().Add(time.Hour),
- IsCA: true,
- KeyUsage: x509.KeyUsageCertSign | x509.KeyUsageCRLSign,
- BasicConstraintsValid: true,
- }
-
- certDER, err := x509.CreateCertificate(rand.Reader, cert, cert, pub, priv)
- if err != nil {
- return nil, err
- }
-
- cert, err = x509.ParseCertificate(certDER)
- if err != nil {
- return nil, err
- }
-
- return cert, nil
-}
-
-// GenerateIntermediate generates an intermediate certificate for testing using
-// the parent certificate (likely a CA) and the provided keys.
-func GenerateIntermediate(key crypto.PublicKey, parentKey crypto.PrivateKey, parent *x509.Certificate) (*x509.Certificate, error) {
- cert := &x509.Certificate{
- SerialNumber: big.NewInt(0),
- Subject: pkix.Name{
- CommonName: "Intermediate",
- },
- NotBefore: time.Now().Add(-time.Second),
- NotAfter: time.Now().Add(time.Hour),
- IsCA: true,
- KeyUsage: x509.KeyUsageCertSign | x509.KeyUsageCRLSign,
- BasicConstraintsValid: true,
- }
-
- certDER, err := x509.CreateCertificate(rand.Reader, cert, parent, key, parentKey)
- if err != nil {
- return nil, err
- }
-
- cert, err = x509.ParseCertificate(certDER)
- if err != nil {
- return nil, err
- }
-
- return cert, nil
-}
-
-// GenerateTrustCert generates a new trust certificate for testing. Unlike the
-// intermediate certificates, this certificate should be used for signature
-// only, not creating certificates.
-func GenerateTrustCert(key crypto.PublicKey, parentKey crypto.PrivateKey, parent *x509.Certificate) (*x509.Certificate, error) {
- cert := &x509.Certificate{
- SerialNumber: big.NewInt(0),
- Subject: pkix.Name{
- CommonName: "Trust Cert",
- },
- NotBefore: time.Now().Add(-time.Second),
- NotAfter: time.Now().Add(time.Hour),
- IsCA: true,
- KeyUsage: x509.KeyUsageDigitalSignature,
- BasicConstraintsValid: true,
- }
-
- certDER, err := x509.CreateCertificate(rand.Reader, cert, parent, key, parentKey)
- if err != nil {
- return nil, err
- }
-
- cert, err = x509.ParseCertificate(certDER)
- if err != nil {
- return nil, err
- }
-
- return cert, nil
-}
diff --git a/vendor/github.com/docker/libtrust/tlsdemo/README.md b/vendor/github.com/docker/libtrust/tlsdemo/README.md
deleted file mode 100644
index 24124db2..00000000
--- a/vendor/github.com/docker/libtrust/tlsdemo/README.md
+++ /dev/null
@@ -1,50 +0,0 @@
-## Libtrust TLS Config Demo
-
-This program generates key pairs and trust files for a TLS client and server.
-
-To generate the keys, run:
-
-```
-$ go run genkeys.go
-```
-
-The generated files are:
-
-```
-$ ls -l client_data/ server_data/
-client_data/:
-total 24
--rw------- 1 jlhawn staff 281 Aug 8 16:21 private_key.json
--rw-r--r-- 1 jlhawn staff 225 Aug 8 16:21 public_key.json
--rw-r--r-- 1 jlhawn staff 275 Aug 8 16:21 trusted_hosts.json
-
-server_data/:
-total 24
--rw-r--r-- 1 jlhawn staff 348 Aug 8 16:21 trusted_clients.json
--rw------- 1 jlhawn staff 281 Aug 8 16:21 private_key.json
--rw-r--r-- 1 jlhawn staff 225 Aug 8 16:21 public_key.json
-```
-
-The private key and public key for the client and server are stored in `private_key.json` and `public_key.json`, respectively, and in their respective directories. They are represented as JSON Web Keys: JSON objects which represent either an ECDSA or RSA private key. The host keys trusted by the client are stored in `trusted_hosts.json` and contain a mapping of an internet address, `:`, to a JSON Web Key which is a JSON object representing either an ECDSA or RSA public key of the trusted server. The client keys trusted by the server are stored in `trusted_clients.json` and contain an array of JSON objects which contain a comment field which can be used describe the key and a JSON Web Key which is a JSON object representing either an ECDSA or RSA public key of the trusted client.
-
-To start the server, run:
-
-```
-$ go run server.go
-```
-
-This starts an HTTPS server which listens on `localhost:8888`. The server configures itself with a certificate which is valid for both `localhost` and `127.0.0.1` and uses the key from `server_data/private_key.json`. It accepts connections from clients which present a certificate for a key that it is configured to trust from the `trusted_clients.json` file and returns a simple 'hello' message.
-
-To make a request using the client, run:
-
-```
-$ go run client.go
-```
-
-This command creates an HTTPS client which makes a GET request to `https://localhost:8888`. The client configures itself with a certificate using the key from `client_data/private_key.json`. It only connects to a server which presents a certificate signed by the key specified for the `localhost:8888` address from `client_data/trusted_hosts.json` and made to be used for the `localhost` hostname. If the connection succeeds, it prints the response from the server.
-
-The file `gencert.go` can be used to generate PEM encoded version of the client key and certificate. If you save them to `key.pem` and `cert.pem` respectively, you can use them with `curl` to test out the server (if it is still running).
-
-```
-curl --cert cert.pem --key key.pem -k https://localhost:8888
-```
diff --git a/vendor/github.com/docker/libtrust/tlsdemo/client.go b/vendor/github.com/docker/libtrust/tlsdemo/client.go
deleted file mode 100644
index 0a699a0e..00000000
--- a/vendor/github.com/docker/libtrust/tlsdemo/client.go
+++ /dev/null
@@ -1,89 +0,0 @@
-package main
-
-import (
- "crypto/tls"
- "fmt"
- "io/ioutil"
- "log"
- "net"
- "net/http"
-
- "github.com/docker/libtrust"
-)
-
-var (
- serverAddress = "localhost:8888"
- privateKeyFilename = "client_data/private_key.pem"
- trustedHostsFilename = "client_data/trusted_hosts.pem"
-)
-
-func main() {
- // Load Client Key.
- clientKey, err := libtrust.LoadKeyFile(privateKeyFilename)
- if err != nil {
- log.Fatal(err)
- }
-
- // Generate Client Certificate.
- selfSignedClientCert, err := libtrust.GenerateSelfSignedClientCert(clientKey)
- if err != nil {
- log.Fatal(err)
- }
-
- // Load trusted host keys.
- hostKeys, err := libtrust.LoadKeySetFile(trustedHostsFilename)
- if err != nil {
- log.Fatal(err)
- }
-
- // Ensure the host we want to connect to is trusted!
- host, _, err := net.SplitHostPort(serverAddress)
- if err != nil {
- log.Fatal(err)
- }
- serverKeys, err := libtrust.FilterByHosts(hostKeys, host, false)
- if err != nil {
- log.Fatalf("%q is not a known and trusted host", host)
- }
-
- // Generate a CA pool with the trusted host's key.
- caPool, err := libtrust.GenerateCACertPool(clientKey, serverKeys)
- if err != nil {
- log.Fatal(err)
- }
-
- // Create HTTP Client.
- client := &http.Client{
- Transport: &http.Transport{
- TLSClientConfig: &tls.Config{
- Certificates: []tls.Certificate{
- tls.Certificate{
- Certificate: [][]byte{selfSignedClientCert.Raw},
- PrivateKey: clientKey.CryptoPrivateKey(),
- Leaf: selfSignedClientCert,
- },
- },
- RootCAs: caPool,
- },
- },
- }
-
- var makeRequest = func(url string) {
- resp, err := client.Get(url)
- if err != nil {
- log.Fatal(err)
- }
- defer resp.Body.Close()
-
- body, err := ioutil.ReadAll(resp.Body)
- if err != nil {
- log.Fatal(err)
- }
-
- log.Println(resp.Status)
- log.Println(string(body))
- }
-
- // Make the request to the trusted server!
- makeRequest(fmt.Sprintf("https://%s", serverAddress))
-}
diff --git a/vendor/github.com/docker/libtrust/tlsdemo/gencert.go b/vendor/github.com/docker/libtrust/tlsdemo/gencert.go
deleted file mode 100644
index c65f3b6b..00000000
--- a/vendor/github.com/docker/libtrust/tlsdemo/gencert.go
+++ /dev/null
@@ -1,62 +0,0 @@
-package main
-
-import (
- "encoding/pem"
- "fmt"
- "log"
- "net"
-
- "github.com/docker/libtrust"
-)
-
-var (
- serverAddress = "localhost:8888"
- clientPrivateKeyFilename = "client_data/private_key.pem"
- trustedHostsFilename = "client_data/trusted_hosts.pem"
-)
-
-func main() {
- key, err := libtrust.LoadKeyFile(clientPrivateKeyFilename)
- if err != nil {
- log.Fatal(err)
- }
-
- keyPEMBlock, err := key.PEMBlock()
- if err != nil {
- log.Fatal(err)
- }
-
- encodedPrivKey := pem.EncodeToMemory(keyPEMBlock)
- fmt.Printf("Client Key:\n\n%s\n", string(encodedPrivKey))
-
- cert, err := libtrust.GenerateSelfSignedClientCert(key)
- if err != nil {
- log.Fatal(err)
- }
-
- encodedCert := pem.EncodeToMemory(&pem.Block{Type: "CERTIFICATE", Bytes: cert.Raw})
- fmt.Printf("Client Cert:\n\n%s\n", string(encodedCert))
-
- trustedServerKeys, err := libtrust.LoadKeySetFile(trustedHostsFilename)
- if err != nil {
- log.Fatal(err)
- }
-
- hostname, _, err := net.SplitHostPort(serverAddress)
- if err != nil {
- log.Fatal(err)
- }
-
- trustedServerKeys, err = libtrust.FilterByHosts(trustedServerKeys, hostname, false)
- if err != nil {
- log.Fatal(err)
- }
-
- caCert, err := libtrust.GenerateCACert(key, trustedServerKeys[0])
- if err != nil {
- log.Fatal(err)
- }
-
- encodedCert = pem.EncodeToMemory(&pem.Block{Type: "CERTIFICATE", Bytes: caCert.Raw})
- fmt.Printf("CA Cert:\n\n%s\n", string(encodedCert))
-}
diff --git a/vendor/github.com/docker/libtrust/tlsdemo/genkeys.go b/vendor/github.com/docker/libtrust/tlsdemo/genkeys.go
deleted file mode 100644
index 9dc8842a..00000000
--- a/vendor/github.com/docker/libtrust/tlsdemo/genkeys.go
+++ /dev/null
@@ -1,61 +0,0 @@
-package main
-
-import (
- "log"
-
- "github.com/docker/libtrust"
-)
-
-func main() {
- // Generate client key.
- clientKey, err := libtrust.GenerateECP256PrivateKey()
- if err != nil {
- log.Fatal(err)
- }
-
- // Add a comment for the client key.
- clientKey.AddExtendedField("comment", "TLS Demo Client")
-
- // Save the client key, public and private versions.
- err = libtrust.SaveKey("client_data/private_key.pem", clientKey)
- if err != nil {
- log.Fatal(err)
- }
-
- err = libtrust.SavePublicKey("client_data/public_key.pem", clientKey.PublicKey())
- if err != nil {
- log.Fatal(err)
- }
-
- // Generate server key.
- serverKey, err := libtrust.GenerateECP256PrivateKey()
- if err != nil {
- log.Fatal(err)
- }
-
- // Set the list of addresses to use for the server.
- serverKey.AddExtendedField("hosts", []string{"localhost", "docker.example.com"})
-
- // Save the server key, public and private versions.
- err = libtrust.SaveKey("server_data/private_key.pem", serverKey)
- if err != nil {
- log.Fatal(err)
- }
-
- err = libtrust.SavePublicKey("server_data/public_key.pem", serverKey.PublicKey())
- if err != nil {
- log.Fatal(err)
- }
-
- // Generate Authorized Keys file for server.
- err = libtrust.AddKeySetFile("server_data/trusted_clients.pem", clientKey.PublicKey())
- if err != nil {
- log.Fatal(err)
- }
-
- // Generate Known Host Keys file for client.
- err = libtrust.AddKeySetFile("client_data/trusted_hosts.pem", serverKey.PublicKey())
- if err != nil {
- log.Fatal(err)
- }
-}
diff --git a/vendor/github.com/docker/libtrust/tlsdemo/server.go b/vendor/github.com/docker/libtrust/tlsdemo/server.go
deleted file mode 100644
index d3cb2ea9..00000000
--- a/vendor/github.com/docker/libtrust/tlsdemo/server.go
+++ /dev/null
@@ -1,80 +0,0 @@
-package main
-
-import (
- "crypto/tls"
- "fmt"
- "html"
- "log"
- "net"
- "net/http"
-
- "github.com/docker/libtrust"
-)
-
-var (
- serverAddress = "localhost:8888"
- privateKeyFilename = "server_data/private_key.pem"
- authorizedClientsFilename = "server_data/trusted_clients.pem"
-)
-
-func requestHandler(w http.ResponseWriter, r *http.Request) {
- clientCert := r.TLS.PeerCertificates[0]
- keyID := clientCert.Subject.CommonName
- log.Printf("Request from keyID: %s\n", keyID)
- fmt.Fprintf(w, "Hello, client! I'm a server! And you are %T: %s.\n", clientCert.PublicKey, html.EscapeString(keyID))
-}
-
-func main() {
- // Load server key.
- serverKey, err := libtrust.LoadKeyFile(privateKeyFilename)
- if err != nil {
- log.Fatal(err)
- }
-
- // Generate server certificate.
- selfSignedServerCert, err := libtrust.GenerateSelfSignedServerCert(
- serverKey, []string{"localhost"}, []net.IP{net.ParseIP("127.0.0.1")},
- )
- if err != nil {
- log.Fatal(err)
- }
-
- // Load authorized client keys.
- authorizedClients, err := libtrust.LoadKeySetFile(authorizedClientsFilename)
- if err != nil {
- log.Fatal(err)
- }
-
- // Create CA pool using trusted client keys.
- caPool, err := libtrust.GenerateCACertPool(serverKey, authorizedClients)
- if err != nil {
- log.Fatal(err)
- }
-
- // Create TLS config, requiring client certificates.
- tlsConfig := &tls.Config{
- Certificates: []tls.Certificate{
- tls.Certificate{
- Certificate: [][]byte{selfSignedServerCert.Raw},
- PrivateKey: serverKey.CryptoPrivateKey(),
- Leaf: selfSignedServerCert,
- },
- },
- ClientAuth: tls.RequireAndVerifyClientCert,
- ClientCAs: caPool,
- }
-
- // Create HTTP server with simple request handler.
- server := &http.Server{
- Addr: serverAddress,
- Handler: http.HandlerFunc(requestHandler),
- }
-
- // Listen and server HTTPS using the libtrust TLS config.
- listener, err := net.Listen("tcp", server.Addr)
- if err != nil {
- log.Fatal(err)
- }
- tlsListener := tls.NewListener(listener, tlsConfig)
- server.Serve(tlsListener)
-}
diff --git a/vendor/github.com/docker/libtrust/trustgraph/graph.go b/vendor/github.com/docker/libtrust/trustgraph/graph.go
deleted file mode 100644
index 72b0fc36..00000000
--- a/vendor/github.com/docker/libtrust/trustgraph/graph.go
+++ /dev/null
@@ -1,50 +0,0 @@
-package trustgraph
-
-import "github.com/docker/libtrust"
-
-// TrustGraph represents a graph of authorization mapping
-// public keys to nodes and grants between nodes.
-type TrustGraph interface {
- // Verifies that the given public key is allowed to perform
- // the given action on the given node according to the trust
- // graph.
- Verify(libtrust.PublicKey, string, uint16) (bool, error)
-
- // GetGrants returns an array of all grant chains which are used to
- // allow the requested permission.
- GetGrants(libtrust.PublicKey, string, uint16) ([][]*Grant, error)
-}
-
-// Grant represents a transfer of permission from one part of the
-// trust graph to another. This is the only way to delegate
-// permission between two different sub trees in the graph.
-type Grant struct {
- // Subject is the namespace being granted
- Subject string
-
- // Permissions is a bit map of permissions
- Permission uint16
-
- // Grantee represents the node being granted
- // a permission scope. The grantee can be
- // either a namespace item or a key id where namespace
- // items will always start with a '/'.
- Grantee string
-
- // statement represents the statement used to create
- // this object.
- statement *Statement
-}
-
-// Permissions
-// Read node 0x01 (can read node, no sub nodes)
-// Write node 0x02 (can write to node object, cannot create subnodes)
-// Read subtree 0x04 (delegates read to each sub node)
-// Write subtree 0x08 (delegates write to each sub node, included create on the subject)
-//
-// Permission shortcuts
-// ReadItem = 0x01
-// WriteItem = 0x03
-// ReadAccess = 0x07
-// WriteAccess = 0x0F
-// Delegate = 0x0F
diff --git a/vendor/github.com/docker/libtrust/trustgraph/memory_graph.go b/vendor/github.com/docker/libtrust/trustgraph/memory_graph.go
deleted file mode 100644
index 247bfa7a..00000000
--- a/vendor/github.com/docker/libtrust/trustgraph/memory_graph.go
+++ /dev/null
@@ -1,133 +0,0 @@
-package trustgraph
-
-import (
- "strings"
-
- "github.com/docker/libtrust"
-)
-
-type grantNode struct {
- grants []*Grant
- children map[string]*grantNode
-}
-
-type memoryGraph struct {
- roots map[string]*grantNode
-}
-
-func newGrantNode() *grantNode {
- return &grantNode{
- grants: []*Grant{},
- children: map[string]*grantNode{},
- }
-}
-
-// NewMemoryGraph returns a new in memory trust graph created from
-// a static list of grants. This graph is immutable after creation
-// and any alterations should create a new instance.
-func NewMemoryGraph(grants []*Grant) TrustGraph {
- roots := map[string]*grantNode{}
- for _, grant := range grants {
- parts := strings.Split(grant.Grantee, "/")
- nodes := roots
- var node *grantNode
- var nodeOk bool
- for _, part := range parts {
- node, nodeOk = nodes[part]
- if !nodeOk {
- node = newGrantNode()
- nodes[part] = node
- }
- if part != "" {
- node.grants = append(node.grants, grant)
- }
- nodes = node.children
- }
- }
- return &memoryGraph{roots}
-}
-
-func (g *memoryGraph) getGrants(name string) []*Grant {
- nameParts := strings.Split(name, "/")
- nodes := g.roots
- var node *grantNode
- var nodeOk bool
- for _, part := range nameParts {
- node, nodeOk = nodes[part]
- if !nodeOk {
- return nil
- }
- nodes = node.children
- }
- return node.grants
-}
-
-func isSubName(name, sub string) bool {
- if strings.HasPrefix(name, sub) {
- if len(name) == len(sub) || name[len(sub)] == '/' {
- return true
- }
- }
- return false
-}
-
-type walkFunc func(*Grant, []*Grant) bool
-
-func foundWalkFunc(*Grant, []*Grant) bool {
- return true
-}
-
-func (g *memoryGraph) walkGrants(start, target string, permission uint16, f walkFunc, chain []*Grant, visited map[*Grant]bool, collect bool) bool {
- if visited == nil {
- visited = map[*Grant]bool{}
- }
- grants := g.getGrants(start)
- subGrants := make([]*Grant, 0, len(grants))
- for _, grant := range grants {
- if visited[grant] {
- continue
- }
- visited[grant] = true
- if grant.Permission&permission == permission {
- if isSubName(target, grant.Subject) {
- if f(grant, chain) {
- return true
- }
- } else {
- subGrants = append(subGrants, grant)
- }
- }
- }
- for _, grant := range subGrants {
- var chainCopy []*Grant
- if collect {
- chainCopy = make([]*Grant, len(chain)+1)
- copy(chainCopy, chain)
- chainCopy[len(chainCopy)-1] = grant
- } else {
- chainCopy = nil
- }
-
- if g.walkGrants(grant.Subject, target, permission, f, chainCopy, visited, collect) {
- return true
- }
- }
- return false
-}
-
-func (g *memoryGraph) Verify(key libtrust.PublicKey, node string, permission uint16) (bool, error) {
- return g.walkGrants(key.KeyID(), node, permission, foundWalkFunc, nil, nil, false), nil
-}
-
-func (g *memoryGraph) GetGrants(key libtrust.PublicKey, node string, permission uint16) ([][]*Grant, error) {
- grants := [][]*Grant{}
- collect := func(grant *Grant, chain []*Grant) bool {
- grantChain := make([]*Grant, len(chain)+1)
- copy(grantChain, chain)
- grantChain[len(grantChain)-1] = grant
- grants = append(grants, grantChain)
- return false
- }
- g.walkGrants(key.KeyID(), node, permission, collect, nil, nil, true)
- return grants, nil
-}
diff --git a/vendor/github.com/docker/libtrust/trustgraph/memory_graph_test.go b/vendor/github.com/docker/libtrust/trustgraph/memory_graph_test.go
deleted file mode 100644
index 49fd0f3b..00000000
--- a/vendor/github.com/docker/libtrust/trustgraph/memory_graph_test.go
+++ /dev/null
@@ -1,174 +0,0 @@
-package trustgraph
-
-import (
- "fmt"
- "testing"
-
- "github.com/docker/libtrust"
-)
-
-func createTestKeysAndGrants(count int) ([]*Grant, []libtrust.PrivateKey) {
- grants := make([]*Grant, count)
- keys := make([]libtrust.PrivateKey, count)
- for i := 0; i < count; i++ {
- pk, err := libtrust.GenerateECP256PrivateKey()
- if err != nil {
- panic(err)
- }
- grant := &Grant{
- Subject: fmt.Sprintf("/user-%d", i+1),
- Permission: 0x0f,
- Grantee: pk.KeyID(),
- }
- keys[i] = pk
- grants[i] = grant
- }
- return grants, keys
-}
-
-func testVerified(t *testing.T, g TrustGraph, k libtrust.PublicKey, keyName, target string, permission uint16) {
- if ok, err := g.Verify(k, target, permission); err != nil {
- t.Fatalf("Unexpected error during verification: %s", err)
- } else if !ok {
- t.Errorf("key failed verification\n\tKey: %s(%s)\n\tNamespace: %s", keyName, k.KeyID(), target)
- }
-}
-
-func testNotVerified(t *testing.T, g TrustGraph, k libtrust.PublicKey, keyName, target string, permission uint16) {
- if ok, err := g.Verify(k, target, permission); err != nil {
- t.Fatalf("Unexpected error during verification: %s", err)
- } else if ok {
- t.Errorf("key should have failed verification\n\tKey: %s(%s)\n\tNamespace: %s", keyName, k.KeyID(), target)
- }
-}
-
-func TestVerify(t *testing.T) {
- grants, keys := createTestKeysAndGrants(4)
- extraGrants := make([]*Grant, 3)
- extraGrants[0] = &Grant{
- Subject: "/user-3",
- Permission: 0x0f,
- Grantee: "/user-2",
- }
- extraGrants[1] = &Grant{
- Subject: "/user-3/sub-project",
- Permission: 0x0f,
- Grantee: "/user-4",
- }
- extraGrants[2] = &Grant{
- Subject: "/user-4",
- Permission: 0x07,
- Grantee: "/user-1",
- }
- grants = append(grants, extraGrants...)
-
- g := NewMemoryGraph(grants)
-
- testVerified(t, g, keys[0].PublicKey(), "user-key-1", "/user-1", 0x0f)
- testVerified(t, g, keys[0].PublicKey(), "user-key-1", "/user-1/some-project/sub-value", 0x0f)
- testVerified(t, g, keys[0].PublicKey(), "user-key-1", "/user-4", 0x07)
- testVerified(t, g, keys[1].PublicKey(), "user-key-2", "/user-2/", 0x0f)
- testVerified(t, g, keys[2].PublicKey(), "user-key-3", "/user-3/sub-value", 0x0f)
- testVerified(t, g, keys[1].PublicKey(), "user-key-2", "/user-3/sub-value", 0x0f)
- testVerified(t, g, keys[1].PublicKey(), "user-key-2", "/user-3", 0x0f)
- testVerified(t, g, keys[1].PublicKey(), "user-key-2", "/user-3/", 0x0f)
- testVerified(t, g, keys[3].PublicKey(), "user-key-4", "/user-3/sub-project", 0x0f)
- testVerified(t, g, keys[3].PublicKey(), "user-key-4", "/user-3/sub-project/app", 0x0f)
- testVerified(t, g, keys[3].PublicKey(), "user-key-4", "/user-4", 0x0f)
-
- testNotVerified(t, g, keys[0].PublicKey(), "user-key-1", "/user-2", 0x0f)
- testNotVerified(t, g, keys[0].PublicKey(), "user-key-1", "/user-3/sub-value", 0x0f)
- testNotVerified(t, g, keys[0].PublicKey(), "user-key-1", "/user-4", 0x0f)
- testNotVerified(t, g, keys[1].PublicKey(), "user-key-2", "/user-1/", 0x0f)
- testNotVerified(t, g, keys[2].PublicKey(), "user-key-3", "/user-2", 0x0f)
- testNotVerified(t, g, keys[1].PublicKey(), "user-key-2", "/user-4", 0x0f)
- testNotVerified(t, g, keys[3].PublicKey(), "user-key-4", "/user-3", 0x0f)
-}
-
-func TestCircularWalk(t *testing.T) {
- grants, keys := createTestKeysAndGrants(3)
- user1Grant := &Grant{
- Subject: "/user-2",
- Permission: 0x0f,
- Grantee: "/user-1",
- }
- user2Grant := &Grant{
- Subject: "/user-1",
- Permission: 0x0f,
- Grantee: "/user-2",
- }
- grants = append(grants, user1Grant, user2Grant)
-
- g := NewMemoryGraph(grants)
-
- testVerified(t, g, keys[0].PublicKey(), "user-key-1", "/user-1", 0x0f)
- testVerified(t, g, keys[0].PublicKey(), "user-key-1", "/user-2", 0x0f)
- testVerified(t, g, keys[1].PublicKey(), "user-key-2", "/user-2", 0x0f)
- testVerified(t, g, keys[1].PublicKey(), "user-key-2", "/user-1", 0x0f)
- testVerified(t, g, keys[2].PublicKey(), "user-key-3", "/user-3", 0x0f)
-
- testNotVerified(t, g, keys[0].PublicKey(), "user-key-1", "/user-3", 0x0f)
- testNotVerified(t, g, keys[1].PublicKey(), "user-key-2", "/user-3", 0x0f)
-}
-
-func assertGrantSame(t *testing.T, actual, expected *Grant) {
- if actual != expected {
- t.Fatalf("Unexpected grant retrieved\n\tExpected: %v\n\tActual: %v", expected, actual)
- }
-}
-
-func TestGetGrants(t *testing.T) {
- grants, keys := createTestKeysAndGrants(5)
- extraGrants := make([]*Grant, 4)
- extraGrants[0] = &Grant{
- Subject: "/user-3/friend-project",
- Permission: 0x0f,
- Grantee: "/user-2/friends",
- }
- extraGrants[1] = &Grant{
- Subject: "/user-3/sub-project",
- Permission: 0x0f,
- Grantee: "/user-4",
- }
- extraGrants[2] = &Grant{
- Subject: "/user-2/friends",
- Permission: 0x0f,
- Grantee: "/user-5/fun-project",
- }
- extraGrants[3] = &Grant{
- Subject: "/user-5/fun-project",
- Permission: 0x0f,
- Grantee: "/user-1",
- }
- grants = append(grants, extraGrants...)
-
- g := NewMemoryGraph(grants)
-
- grantChains, err := g.GetGrants(keys[3], "/user-3/sub-project/specific-app", 0x0f)
- if err != nil {
- t.Fatalf("Error getting grants: %s", err)
- }
- if len(grantChains) != 1 {
- t.Fatalf("Expected number of grant chains returned, expected %d, received %d", 1, len(grantChains))
- }
- if len(grantChains[0]) != 2 {
- t.Fatalf("Unexpected number of grants retrieved\n\tExpected: %d\n\tActual: %d", 2, len(grantChains[0]))
- }
- assertGrantSame(t, grantChains[0][0], grants[3])
- assertGrantSame(t, grantChains[0][1], extraGrants[1])
-
- grantChains, err = g.GetGrants(keys[0], "/user-3/friend-project/fun-app", 0x0f)
- if err != nil {
- t.Fatalf("Error getting grants: %s", err)
- }
- if len(grantChains) != 1 {
- t.Fatalf("Expected number of grant chains returned, expected %d, received %d", 1, len(grantChains))
- }
- if len(grantChains[0]) != 4 {
- t.Fatalf("Unexpected number of grants retrieved\n\tExpected: %d\n\tActual: %d", 2, len(grantChains[0]))
- }
- assertGrantSame(t, grantChains[0][0], grants[0])
- assertGrantSame(t, grantChains[0][1], extraGrants[3])
- assertGrantSame(t, grantChains[0][2], extraGrants[2])
- assertGrantSame(t, grantChains[0][3], extraGrants[0])
-}
diff --git a/vendor/github.com/docker/libtrust/trustgraph/statement.go b/vendor/github.com/docker/libtrust/trustgraph/statement.go
deleted file mode 100644
index 7a74b553..00000000
--- a/vendor/github.com/docker/libtrust/trustgraph/statement.go
+++ /dev/null
@@ -1,227 +0,0 @@
-package trustgraph
-
-import (
- "crypto/x509"
- "encoding/json"
- "io"
- "io/ioutil"
- "sort"
- "strings"
- "time"
-
- "github.com/docker/libtrust"
-)
-
-type jsonGrant struct {
- Subject string `json:"subject"`
- Permission uint16 `json:"permission"`
- Grantee string `json:"grantee"`
-}
-
-type jsonRevocation struct {
- Subject string `json:"subject"`
- Revocation uint16 `json:"revocation"`
- Grantee string `json:"grantee"`
-}
-
-type jsonStatement struct {
- Revocations []*jsonRevocation `json:"revocations"`
- Grants []*jsonGrant `json:"grants"`
- Expiration time.Time `json:"expiration"`
- IssuedAt time.Time `json:"issuedAt"`
-}
-
-func (g *jsonGrant) Grant(statement *Statement) *Grant {
- return &Grant{
- Subject: g.Subject,
- Permission: g.Permission,
- Grantee: g.Grantee,
- statement: statement,
- }
-}
-
-// Statement represents a set of grants made from a verifiable
-// authority. A statement has an expiration associated with it
-// set by the authority.
-type Statement struct {
- jsonStatement
-
- signature *libtrust.JSONSignature
-}
-
-// IsExpired returns whether the statement has expired
-func (s *Statement) IsExpired() bool {
- return s.Expiration.Before(time.Now().Add(-10 * time.Second))
-}
-
-// Bytes returns an indented json representation of the statement
-// in a byte array. This value can be written to a file or stream
-// without alteration.
-func (s *Statement) Bytes() ([]byte, error) {
- return s.signature.PrettySignature("signatures")
-}
-
-// LoadStatement loads and verifies a statement from an input stream.
-func LoadStatement(r io.Reader, authority *x509.CertPool) (*Statement, error) {
- b, err := ioutil.ReadAll(r)
- if err != nil {
- return nil, err
- }
- js, err := libtrust.ParsePrettySignature(b, "signatures")
- if err != nil {
- return nil, err
- }
- payload, err := js.Payload()
- if err != nil {
- return nil, err
- }
- var statement Statement
- err = json.Unmarshal(payload, &statement.jsonStatement)
- if err != nil {
- return nil, err
- }
-
- if authority == nil {
- _, err = js.Verify()
- if err != nil {
- return nil, err
- }
- } else {
- _, err = js.VerifyChains(authority)
- if err != nil {
- return nil, err
- }
- }
- statement.signature = js
-
- return &statement, nil
-}
-
-// CreateStatements creates and signs a statement from a stream of grants
-// and revocations in a JSON array.
-func CreateStatement(grants, revocations io.Reader, expiration time.Duration, key libtrust.PrivateKey, chain []*x509.Certificate) (*Statement, error) {
- var statement Statement
- err := json.NewDecoder(grants).Decode(&statement.jsonStatement.Grants)
- if err != nil {
- return nil, err
- }
- err = json.NewDecoder(revocations).Decode(&statement.jsonStatement.Revocations)
- if err != nil {
- return nil, err
- }
- statement.jsonStatement.Expiration = time.Now().UTC().Add(expiration)
- statement.jsonStatement.IssuedAt = time.Now().UTC()
-
- b, err := json.MarshalIndent(&statement.jsonStatement, "", " ")
- if err != nil {
- return nil, err
- }
-
- statement.signature, err = libtrust.NewJSONSignature(b)
- if err != nil {
- return nil, err
- }
- err = statement.signature.SignWithChain(key, chain)
- if err != nil {
- return nil, err
- }
-
- return &statement, nil
-}
-
-type statementList []*Statement
-
-func (s statementList) Len() int {
- return len(s)
-}
-
-func (s statementList) Less(i, j int) bool {
- return s[i].IssuedAt.Before(s[j].IssuedAt)
-}
-
-func (s statementList) Swap(i, j int) {
- s[i], s[j] = s[j], s[i]
-}
-
-// CollapseStatements returns a single list of the valid statements as well as the
-// time when the next grant will expire.
-func CollapseStatements(statements []*Statement, useExpired bool) ([]*Grant, time.Time, error) {
- sorted := make(statementList, 0, len(statements))
- for _, statement := range statements {
- if useExpired || !statement.IsExpired() {
- sorted = append(sorted, statement)
- }
- }
- sort.Sort(sorted)
-
- var minExpired time.Time
- var grantCount int
- roots := map[string]*grantNode{}
- for i, statement := range sorted {
- if statement.Expiration.Before(minExpired) || i == 0 {
- minExpired = statement.Expiration
- }
- for _, grant := range statement.Grants {
- parts := strings.Split(grant.Grantee, "/")
- nodes := roots
- g := grant.Grant(statement)
- grantCount = grantCount + 1
-
- for _, part := range parts {
- node, nodeOk := nodes[part]
- if !nodeOk {
- node = newGrantNode()
- nodes[part] = node
- }
- node.grants = append(node.grants, g)
- nodes = node.children
- }
- }
-
- for _, revocation := range statement.Revocations {
- parts := strings.Split(revocation.Grantee, "/")
- nodes := roots
-
- var node *grantNode
- var nodeOk bool
- for _, part := range parts {
- node, nodeOk = nodes[part]
- if !nodeOk {
- break
- }
- nodes = node.children
- }
- if node != nil {
- for _, grant := range node.grants {
- if isSubName(grant.Subject, revocation.Subject) {
- grant.Permission = grant.Permission &^ revocation.Revocation
- }
- }
- }
- }
- }
-
- retGrants := make([]*Grant, 0, grantCount)
- for _, rootNodes := range roots {
- retGrants = append(retGrants, rootNodes.grants...)
- }
-
- return retGrants, minExpired, nil
-}
-
-// FilterStatements filters the statements to statements including the given grants.
-func FilterStatements(grants []*Grant) ([]*Statement, error) {
- statements := map[*Statement]bool{}
- for _, grant := range grants {
- if grant.statement != nil {
- statements[grant.statement] = true
- }
- }
- retStatements := make([]*Statement, len(statements))
- var i int
- for statement := range statements {
- retStatements[i] = statement
- i++
- }
- return retStatements, nil
-}
diff --git a/vendor/github.com/docker/libtrust/trustgraph/statement_test.go b/vendor/github.com/docker/libtrust/trustgraph/statement_test.go
deleted file mode 100644
index e5094686..00000000
--- a/vendor/github.com/docker/libtrust/trustgraph/statement_test.go
+++ /dev/null
@@ -1,417 +0,0 @@
-package trustgraph
-
-import (
- "bytes"
- "crypto/x509"
- "encoding/json"
- "testing"
- "time"
-
- "github.com/docker/libtrust"
- "github.com/docker/libtrust/testutil"
-)
-
-const testStatementExpiration = time.Hour * 5
-
-func generateStatement(grants []*Grant, key libtrust.PrivateKey, chain []*x509.Certificate) (*Statement, error) {
- var statement Statement
-
- statement.Grants = make([]*jsonGrant, len(grants))
- for i, grant := range grants {
- statement.Grants[i] = &jsonGrant{
- Subject: grant.Subject,
- Permission: grant.Permission,
- Grantee: grant.Grantee,
- }
- }
- statement.IssuedAt = time.Now()
- statement.Expiration = time.Now().Add(testStatementExpiration)
- statement.Revocations = make([]*jsonRevocation, 0)
-
- marshalled, err := json.MarshalIndent(statement.jsonStatement, "", " ")
- if err != nil {
- return nil, err
- }
-
- sig, err := libtrust.NewJSONSignature(marshalled)
- if err != nil {
- return nil, err
- }
- err = sig.SignWithChain(key, chain)
- if err != nil {
- return nil, err
- }
- statement.signature = sig
-
- return &statement, nil
-}
-
-func generateTrustChain(t *testing.T, chainLen int) (libtrust.PrivateKey, *x509.CertPool, []*x509.Certificate) {
- caKey, err := libtrust.GenerateECP256PrivateKey()
- if err != nil {
- t.Fatalf("Error generating key: %s", err)
- }
- ca, err := testutil.GenerateTrustCA(caKey.CryptoPublicKey(), caKey.CryptoPrivateKey())
- if err != nil {
- t.Fatalf("Error generating ca: %s", err)
- }
-
- parent := ca
- parentKey := caKey
- chain := make([]*x509.Certificate, chainLen)
- for i := chainLen - 1; i > 0; i-- {
- intermediatekey, err := libtrust.GenerateECP256PrivateKey()
- if err != nil {
- t.Fatalf("Error generate key: %s", err)
- }
- chain[i], err = testutil.GenerateIntermediate(intermediatekey.CryptoPublicKey(), parentKey.CryptoPrivateKey(), parent)
- if err != nil {
- t.Fatalf("Error generating intermdiate certificate: %s", err)
- }
- parent = chain[i]
- parentKey = intermediatekey
- }
- trustKey, err := libtrust.GenerateECP256PrivateKey()
- if err != nil {
- t.Fatalf("Error generate key: %s", err)
- }
- chain[0], err = testutil.GenerateTrustCert(trustKey.CryptoPublicKey(), parentKey.CryptoPrivateKey(), parent)
- if err != nil {
- t.Fatalf("Error generate trust cert: %s", err)
- }
-
- caPool := x509.NewCertPool()
- caPool.AddCert(ca)
-
- return trustKey, caPool, chain
-}
-
-func TestLoadStatement(t *testing.T) {
- grantCount := 4
- grants, _ := createTestKeysAndGrants(grantCount)
-
- trustKey, caPool, chain := generateTrustChain(t, 6)
-
- statement, err := generateStatement(grants, trustKey, chain)
- if err != nil {
- t.Fatalf("Error generating statement: %s", err)
- }
-
- statementBytes, err := statement.Bytes()
- if err != nil {
- t.Fatalf("Error getting statement bytes: %s", err)
- }
-
- s2, err := LoadStatement(bytes.NewReader(statementBytes), caPool)
- if err != nil {
- t.Fatalf("Error loading statement: %s", err)
- }
- if len(s2.Grants) != grantCount {
- t.Fatalf("Unexpected grant length\n\tExpected: %d\n\tActual: %d", grantCount, len(s2.Grants))
- }
-
- pool := x509.NewCertPool()
- _, err = LoadStatement(bytes.NewReader(statementBytes), pool)
- if err == nil {
- t.Fatalf("No error thrown verifying without an authority")
- } else if _, ok := err.(x509.UnknownAuthorityError); !ok {
- t.Fatalf("Unexpected error verifying without authority: %s", err)
- }
-
- s2, err = LoadStatement(bytes.NewReader(statementBytes), nil)
- if err != nil {
- t.Fatalf("Error loading statement: %s", err)
- }
- if len(s2.Grants) != grantCount {
- t.Fatalf("Unexpected grant length\n\tExpected: %d\n\tActual: %d", grantCount, len(s2.Grants))
- }
-
- badData := make([]byte, len(statementBytes))
- copy(badData, statementBytes)
- badData[0] = '['
- _, err = LoadStatement(bytes.NewReader(badData), nil)
- if err == nil {
- t.Fatalf("No error thrown parsing bad json")
- }
-
- alteredData := make([]byte, len(statementBytes))
- copy(alteredData, statementBytes)
- alteredData[30] = '0'
- _, err = LoadStatement(bytes.NewReader(alteredData), nil)
- if err == nil {
- t.Fatalf("No error thrown from bad data")
- }
-}
-
-func TestCollapseGrants(t *testing.T) {
- grantCount := 8
- grants, keys := createTestKeysAndGrants(grantCount)
- linkGrants := make([]*Grant, 4)
- linkGrants[0] = &Grant{
- Subject: "/user-3",
- Permission: 0x0f,
- Grantee: "/user-2",
- }
- linkGrants[1] = &Grant{
- Subject: "/user-3/sub-project",
- Permission: 0x0f,
- Grantee: "/user-4",
- }
- linkGrants[2] = &Grant{
- Subject: "/user-6",
- Permission: 0x0f,
- Grantee: "/user-7",
- }
- linkGrants[3] = &Grant{
- Subject: "/user-6/sub-project/specific-app",
- Permission: 0x0f,
- Grantee: "/user-5",
- }
- trustKey, pool, chain := generateTrustChain(t, 3)
-
- statements := make([]*Statement, 3)
- var err error
- statements[0], err = generateStatement(grants[0:4], trustKey, chain)
- if err != nil {
- t.Fatalf("Error generating statement: %s", err)
- }
- statements[1], err = generateStatement(grants[4:], trustKey, chain)
- if err != nil {
- t.Fatalf("Error generating statement: %s", err)
- }
- statements[2], err = generateStatement(linkGrants, trustKey, chain)
- if err != nil {
- t.Fatalf("Error generating statement: %s", err)
- }
-
- statementsCopy := make([]*Statement, len(statements))
- for i, statement := range statements {
- b, err := statement.Bytes()
- if err != nil {
- t.Fatalf("Error getting statement bytes: %s", err)
- }
- verifiedStatement, err := LoadStatement(bytes.NewReader(b), pool)
- if err != nil {
- t.Fatalf("Error loading statement: %s", err)
- }
- // Force sort by reversing order
- statementsCopy[len(statementsCopy)-i-1] = verifiedStatement
- }
- statements = statementsCopy
-
- collapsedGrants, expiration, err := CollapseStatements(statements, false)
- if len(collapsedGrants) != 12 {
- t.Fatalf("Unexpected number of grants\n\tExpected: %d\n\tActual: %d", 12, len(collapsedGrants))
- }
- if expiration.After(time.Now().Add(time.Hour*5)) || expiration.Before(time.Now()) {
- t.Fatalf("Unexpected expiration time: %s", expiration.String())
- }
- g := NewMemoryGraph(collapsedGrants)
-
- testVerified(t, g, keys[0].PublicKey(), "user-key-1", "/user-1", 0x0f)
- testVerified(t, g, keys[1].PublicKey(), "user-key-2", "/user-2", 0x0f)
- testVerified(t, g, keys[2].PublicKey(), "user-key-3", "/user-3", 0x0f)
- testVerified(t, g, keys[3].PublicKey(), "user-key-4", "/user-4", 0x0f)
- testVerified(t, g, keys[4].PublicKey(), "user-key-5", "/user-5", 0x0f)
- testVerified(t, g, keys[5].PublicKey(), "user-key-6", "/user-6", 0x0f)
- testVerified(t, g, keys[6].PublicKey(), "user-key-7", "/user-7", 0x0f)
- testVerified(t, g, keys[7].PublicKey(), "user-key-8", "/user-8", 0x0f)
- testVerified(t, g, keys[1].PublicKey(), "user-key-2", "/user-3", 0x0f)
- testVerified(t, g, keys[1].PublicKey(), "user-key-2", "/user-3/sub-project/specific-app", 0x0f)
- testVerified(t, g, keys[3].PublicKey(), "user-key-4", "/user-3/sub-project", 0x0f)
- testVerified(t, g, keys[6].PublicKey(), "user-key-7", "/user-6", 0x0f)
- testVerified(t, g, keys[6].PublicKey(), "user-key-7", "/user-6/sub-project/specific-app", 0x0f)
- testVerified(t, g, keys[4].PublicKey(), "user-key-5", "/user-6/sub-project/specific-app", 0x0f)
-
- testNotVerified(t, g, keys[3].PublicKey(), "user-key-4", "/user-3", 0x0f)
- testNotVerified(t, g, keys[3].PublicKey(), "user-key-4", "/user-6/sub-project", 0x0f)
- testNotVerified(t, g, keys[4].PublicKey(), "user-key-5", "/user-6/sub-project", 0x0f)
-
- // Add revocation grant
- statements = append(statements, &Statement{
- jsonStatement{
- IssuedAt: time.Now(),
- Expiration: time.Now().Add(testStatementExpiration),
- Grants: []*jsonGrant{},
- Revocations: []*jsonRevocation{
- &jsonRevocation{
- Subject: "/user-1",
- Revocation: 0x0f,
- Grantee: keys[0].KeyID(),
- },
- &jsonRevocation{
- Subject: "/user-2",
- Revocation: 0x08,
- Grantee: keys[1].KeyID(),
- },
- &jsonRevocation{
- Subject: "/user-6",
- Revocation: 0x0f,
- Grantee: "/user-7",
- },
- &jsonRevocation{
- Subject: "/user-9",
- Revocation: 0x0f,
- Grantee: "/user-10",
- },
- },
- },
- nil,
- })
-
- collapsedGrants, expiration, err = CollapseStatements(statements, false)
- if len(collapsedGrants) != 12 {
- t.Fatalf("Unexpected number of grants\n\tExpected: %d\n\tActual: %d", 12, len(collapsedGrants))
- }
- if expiration.After(time.Now().Add(time.Hour*5)) || expiration.Before(time.Now()) {
- t.Fatalf("Unexpected expiration time: %s", expiration.String())
- }
- g = NewMemoryGraph(collapsedGrants)
-
- testNotVerified(t, g, keys[0].PublicKey(), "user-key-1", "/user-1", 0x0f)
- testNotVerified(t, g, keys[1].PublicKey(), "user-key-2", "/user-2", 0x0f)
- testNotVerified(t, g, keys[6].PublicKey(), "user-key-7", "/user-6/sub-project/specific-app", 0x0f)
-
- testVerified(t, g, keys[1].PublicKey(), "user-key-2", "/user-2", 0x07)
-}
-
-func TestFilterStatements(t *testing.T) {
- grantCount := 8
- grants, keys := createTestKeysAndGrants(grantCount)
- linkGrants := make([]*Grant, 3)
- linkGrants[0] = &Grant{
- Subject: "/user-3",
- Permission: 0x0f,
- Grantee: "/user-2",
- }
- linkGrants[1] = &Grant{
- Subject: "/user-5",
- Permission: 0x0f,
- Grantee: "/user-4",
- }
- linkGrants[2] = &Grant{
- Subject: "/user-7",
- Permission: 0x0f,
- Grantee: "/user-6",
- }
-
- trustKey, _, chain := generateTrustChain(t, 3)
-
- statements := make([]*Statement, 5)
- var err error
- statements[0], err = generateStatement(grants[0:2], trustKey, chain)
- if err != nil {
- t.Fatalf("Error generating statement: %s", err)
- }
- statements[1], err = generateStatement(grants[2:4], trustKey, chain)
- if err != nil {
- t.Fatalf("Error generating statement: %s", err)
- }
- statements[2], err = generateStatement(grants[4:6], trustKey, chain)
- if err != nil {
- t.Fatalf("Error generating statement: %s", err)
- }
- statements[3], err = generateStatement(grants[6:], trustKey, chain)
- if err != nil {
- t.Fatalf("Error generating statement: %s", err)
- }
- statements[4], err = generateStatement(linkGrants, trustKey, chain)
- if err != nil {
- t.Fatalf("Error generating statement: %s", err)
- }
- collapsed, _, err := CollapseStatements(statements, false)
- if err != nil {
- t.Fatalf("Error collapsing grants: %s", err)
- }
-
- // Filter 1, all 5 statements
- filter1, err := FilterStatements(collapsed)
- if err != nil {
- t.Fatalf("Error filtering statements: %s", err)
- }
- if len(filter1) != 5 {
- t.Fatalf("Wrong number of statements, expected %d, received %d", 5, len(filter1))
- }
-
- // Filter 2, one statement
- filter2, err := FilterStatements([]*Grant{collapsed[0]})
- if err != nil {
- t.Fatalf("Error filtering statements: %s", err)
- }
- if len(filter2) != 1 {
- t.Fatalf("Wrong number of statements, expected %d, received %d", 1, len(filter2))
- }
-
- // Filter 3, 2 statements, from graph lookup
- g := NewMemoryGraph(collapsed)
- lookupGrants, err := g.GetGrants(keys[1], "/user-3", 0x0f)
- if err != nil {
- t.Fatalf("Error looking up grants: %s", err)
- }
- if len(lookupGrants) != 1 {
- t.Fatalf("Wrong numberof grant chains returned from lookup, expected %d, received %d", 1, len(lookupGrants))
- }
- if len(lookupGrants[0]) != 2 {
- t.Fatalf("Wrong number of grants looked up, expected %d, received %d", 2, len(lookupGrants))
- }
- filter3, err := FilterStatements(lookupGrants[0])
- if err != nil {
- t.Fatalf("Error filtering statements: %s", err)
- }
- if len(filter3) != 2 {
- t.Fatalf("Wrong number of statements, expected %d, received %d", 2, len(filter3))
- }
-
-}
-
-func TestCreateStatement(t *testing.T) {
- grantJSON := bytes.NewReader([]byte(`[
- {
- "subject": "/user-2",
- "permission": 15,
- "grantee": "/user-1"
- },
- {
- "subject": "/user-7",
- "permission": 1,
- "grantee": "/user-9"
- },
- {
- "subject": "/user-3",
- "permission": 15,
- "grantee": "/user-2"
- }
-]`))
- revocationJSON := bytes.NewReader([]byte(`[
- {
- "subject": "user-8",
- "revocation": 12,
- "grantee": "user-9"
- }
-]`))
-
- trustKey, pool, chain := generateTrustChain(t, 3)
-
- statement, err := CreateStatement(grantJSON, revocationJSON, testStatementExpiration, trustKey, chain)
- if err != nil {
- t.Fatalf("Error creating statement: %s", err)
- }
-
- b, err := statement.Bytes()
- if err != nil {
- t.Fatalf("Error retrieving bytes: %s", err)
- }
-
- verified, err := LoadStatement(bytes.NewReader(b), pool)
- if err != nil {
- t.Fatalf("Error loading statement: %s", err)
- }
-
- if len(verified.Grants) != 3 {
- t.Errorf("Unexpected number of grants, expected %d, received %d", 3, len(verified.Grants))
- }
-
- if len(verified.Revocations) != 1 {
- t.Errorf("Unexpected number of revocations, expected %d, received %d", 1, len(verified.Revocations))
- }
-}
diff --git a/vendor/github.com/docker/libtrust/util_test.go b/vendor/github.com/docker/libtrust/util_test.go
deleted file mode 100644
index ee54f5b8..00000000
--- a/vendor/github.com/docker/libtrust/util_test.go
+++ /dev/null
@@ -1,23 +0,0 @@
-package libtrust
-
-import (
- "encoding/pem"
- "reflect"
- "testing"
-)
-
-func TestAddPEMHeadersToKey(t *testing.T) {
- pk := &rsaPublicKey{nil, map[string]interface{}{}}
- blk := &pem.Block{Headers: map[string]string{"hosts": "localhost,127.0.0.1"}}
- addPEMHeadersToKey(blk, pk)
-
- val := pk.GetExtendedField("hosts")
- hosts, ok := val.([]string)
- if !ok {
- t.Fatalf("hosts type(%v), expected []string", reflect.TypeOf(val))
- }
- expected := []string{"localhost", "127.0.0.1"}
- if !reflect.DeepEqual(hosts, expected) {
- t.Errorf("hosts(%v), expected %v", hosts, expected)
- }
-}
diff --git a/vendor/github.com/garyburd/redigo/internal/redistest/testdb.go b/vendor/github.com/garyburd/redigo/internal/redistest/testdb.go
deleted file mode 100644
index 5f955c42..00000000
--- a/vendor/github.com/garyburd/redigo/internal/redistest/testdb.go
+++ /dev/null
@@ -1,65 +0,0 @@
-// Copyright 2014 Gary Burd
-//
-// Licensed under the Apache License, Version 2.0 (the "License"): you may
-// not use this file except in compliance with the License. You may obtain
-// a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-// License for the specific language governing permissions and limitations
-// under the License.
-
-// Package redistest contains utilities for writing Redigo tests.
-package redistest
-
-import (
- "errors"
- "time"
-
- "github.com/garyburd/redigo/redis"
-)
-
-type testConn struct {
- redis.Conn
-}
-
-func (t testConn) Close() error {
- _, err := t.Conn.Do("SELECT", "9")
- if err != nil {
- return nil
- }
- _, err = t.Conn.Do("FLUSHDB")
- if err != nil {
- return err
- }
- return t.Conn.Close()
-}
-
-// Dial dials the local Redis server and selects database 9. To prevent
-// stomping on real data, DialTestDB fails if database 9 contains data. The
-// returned connection flushes database 9 on close.
-func Dial() (redis.Conn, error) {
- c, err := redis.DialTimeout("tcp", ":6379", 0, 1*time.Second, 1*time.Second)
- if err != nil {
- return nil, err
- }
-
- _, err = c.Do("SELECT", "9")
- if err != nil {
- return nil, err
- }
-
- n, err := redis.Int(c.Do("DBSIZE"))
- if err != nil {
- return nil, err
- }
-
- if n != 0 {
- return nil, errors.New("database #9 is not empty, test can not continue")
- }
-
- return testConn{c}, nil
-}
diff --git a/vendor/github.com/garyburd/redigo/redis/conn_test.go b/vendor/github.com/garyburd/redigo/redis/conn_test.go
deleted file mode 100644
index 80037013..00000000
--- a/vendor/github.com/garyburd/redigo/redis/conn_test.go
+++ /dev/null
@@ -1,542 +0,0 @@
-// Copyright 2012 Gary Burd
-//
-// Licensed under the Apache License, Version 2.0 (the "License"): you may
-// not use this file except in compliance with the License. You may obtain
-// a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-// License for the specific language governing permissions and limitations
-// under the License.
-
-package redis_test
-
-import (
- "bufio"
- "bytes"
- "math"
- "net"
- "reflect"
- "strings"
- "testing"
- "time"
-
- "github.com/garyburd/redigo/internal/redistest"
- "github.com/garyburd/redigo/redis"
-)
-
-var writeTests = []struct {
- args []interface{}
- expected string
-}{
- {
- []interface{}{"SET", "key", "value"},
- "*3\r\n$3\r\nSET\r\n$3\r\nkey\r\n$5\r\nvalue\r\n",
- },
- {
- []interface{}{"SET", "key", "value"},
- "*3\r\n$3\r\nSET\r\n$3\r\nkey\r\n$5\r\nvalue\r\n",
- },
- {
- []interface{}{"SET", "key", byte(100)},
- "*3\r\n$3\r\nSET\r\n$3\r\nkey\r\n$3\r\n100\r\n",
- },
- {
- []interface{}{"SET", "key", 100},
- "*3\r\n$3\r\nSET\r\n$3\r\nkey\r\n$3\r\n100\r\n",
- },
- {
- []interface{}{"SET", "key", int64(math.MinInt64)},
- "*3\r\n$3\r\nSET\r\n$3\r\nkey\r\n$20\r\n-9223372036854775808\r\n",
- },
- {
- []interface{}{"SET", "key", float64(1349673917.939762)},
- "*3\r\n$3\r\nSET\r\n$3\r\nkey\r\n$21\r\n1.349673917939762e+09\r\n",
- },
- {
- []interface{}{"SET", "key", ""},
- "*3\r\n$3\r\nSET\r\n$3\r\nkey\r\n$0\r\n\r\n",
- },
- {
- []interface{}{"SET", "key", nil},
- "*3\r\n$3\r\nSET\r\n$3\r\nkey\r\n$0\r\n\r\n",
- },
- {
- []interface{}{"ECHO", true, false},
- "*3\r\n$4\r\nECHO\r\n$1\r\n1\r\n$1\r\n0\r\n",
- },
-}
-
-func TestWrite(t *testing.T) {
- for _, tt := range writeTests {
- var buf bytes.Buffer
- rw := bufio.ReadWriter{Writer: bufio.NewWriter(&buf)}
- c := redis.NewConnBufio(rw)
- err := c.Send(tt.args[0].(string), tt.args[1:]...)
- if err != nil {
- t.Errorf("Send(%v) returned error %v", tt.args, err)
- continue
- }
- rw.Flush()
- actual := buf.String()
- if actual != tt.expected {
- t.Errorf("Send(%v) = %q, want %q", tt.args, actual, tt.expected)
- }
- }
-}
-
-var errorSentinel = &struct{}{}
-
-var readTests = []struct {
- reply string
- expected interface{}
-}{
- {
- "+OK\r\n",
- "OK",
- },
- {
- "+PONG\r\n",
- "PONG",
- },
- {
- "@OK\r\n",
- errorSentinel,
- },
- {
- "$6\r\nfoobar\r\n",
- []byte("foobar"),
- },
- {
- "$-1\r\n",
- nil,
- },
- {
- ":1\r\n",
- int64(1),
- },
- {
- ":-2\r\n",
- int64(-2),
- },
- {
- "*0\r\n",
- []interface{}{},
- },
- {
- "*-1\r\n",
- nil,
- },
- {
- "*4\r\n$3\r\nfoo\r\n$3\r\nbar\r\n$5\r\nHello\r\n$5\r\nWorld\r\n",
- []interface{}{[]byte("foo"), []byte("bar"), []byte("Hello"), []byte("World")},
- },
- {
- "*3\r\n$3\r\nfoo\r\n$-1\r\n$3\r\nbar\r\n",
- []interface{}{[]byte("foo"), nil, []byte("bar")},
- },
-
- {
- // "x" is not a valid length
- "$x\r\nfoobar\r\n",
- errorSentinel,
- },
- {
- // -2 is not a valid length
- "$-2\r\n",
- errorSentinel,
- },
- {
- // "x" is not a valid integer
- ":x\r\n",
- errorSentinel,
- },
- {
- // missing \r\n following value
- "$6\r\nfoobar",
- errorSentinel,
- },
- {
- // short value
- "$6\r\nxx",
- errorSentinel,
- },
- {
- // long value
- "$6\r\nfoobarx\r\n",
- errorSentinel,
- },
-}
-
-func TestRead(t *testing.T) {
- for _, tt := range readTests {
- rw := bufio.ReadWriter{
- Reader: bufio.NewReader(strings.NewReader(tt.reply)),
- Writer: bufio.NewWriter(nil), // writer need to support Flush
- }
- c := redis.NewConnBufio(rw)
- actual, err := c.Receive()
- if tt.expected == errorSentinel {
- if err == nil {
- t.Errorf("Receive(%q) did not return expected error", tt.reply)
- }
- } else {
- if err != nil {
- t.Errorf("Receive(%q) returned error %v", tt.reply, err)
- continue
- }
- if !reflect.DeepEqual(actual, tt.expected) {
- t.Errorf("Receive(%q) = %v, want %v", tt.reply, actual, tt.expected)
- }
- }
- }
-}
-
-var testCommands = []struct {
- args []interface{}
- expected interface{}
-}{
- {
- []interface{}{"PING"},
- "PONG",
- },
- {
- []interface{}{"SET", "foo", "bar"},
- "OK",
- },
- {
- []interface{}{"GET", "foo"},
- []byte("bar"),
- },
- {
- []interface{}{"GET", "nokey"},
- nil,
- },
- {
- []interface{}{"MGET", "nokey", "foo"},
- []interface{}{nil, []byte("bar")},
- },
- {
- []interface{}{"INCR", "mycounter"},
- int64(1),
- },
- {
- []interface{}{"LPUSH", "mylist", "foo"},
- int64(1),
- },
- {
- []interface{}{"LPUSH", "mylist", "bar"},
- int64(2),
- },
- {
- []interface{}{"LRANGE", "mylist", 0, -1},
- []interface{}{[]byte("bar"), []byte("foo")},
- },
- {
- []interface{}{"MULTI"},
- "OK",
- },
- {
- []interface{}{"LRANGE", "mylist", 0, -1},
- "QUEUED",
- },
- {
- []interface{}{"PING"},
- "QUEUED",
- },
- {
- []interface{}{"EXEC"},
- []interface{}{
- []interface{}{[]byte("bar"), []byte("foo")},
- "PONG",
- },
- },
-}
-
-func TestDoCommands(t *testing.T) {
- c, err := redistest.Dial()
- if err != nil {
- t.Fatalf("error connection to database, %v", err)
- }
- defer c.Close()
-
- for _, cmd := range testCommands {
- actual, err := c.Do(cmd.args[0].(string), cmd.args[1:]...)
- if err != nil {
- t.Errorf("Do(%v) returned error %v", cmd.args, err)
- continue
- }
- if !reflect.DeepEqual(actual, cmd.expected) {
- t.Errorf("Do(%v) = %v, want %v", cmd.args, actual, cmd.expected)
- }
- }
-}
-
-func TestPipelineCommands(t *testing.T) {
- c, err := redistest.Dial()
- if err != nil {
- t.Fatalf("error connection to database, %v", err)
- }
- defer c.Close()
-
- for _, cmd := range testCommands {
- if err := c.Send(cmd.args[0].(string), cmd.args[1:]...); err != nil {
- t.Fatalf("Send(%v) returned error %v", cmd.args, err)
- }
- }
- if err := c.Flush(); err != nil {
- t.Errorf("Flush() returned error %v", err)
- }
- for _, cmd := range testCommands {
- actual, err := c.Receive()
- if err != nil {
- t.Fatalf("Receive(%v) returned error %v", cmd.args, err)
- }
- if !reflect.DeepEqual(actual, cmd.expected) {
- t.Errorf("Receive(%v) = %v, want %v", cmd.args, actual, cmd.expected)
- }
- }
-}
-
-func TestBlankCommmand(t *testing.T) {
- c, err := redistest.Dial()
- if err != nil {
- t.Fatalf("error connection to database, %v", err)
- }
- defer c.Close()
-
- for _, cmd := range testCommands {
- if err := c.Send(cmd.args[0].(string), cmd.args[1:]...); err != nil {
- t.Fatalf("Send(%v) returned error %v", cmd.args, err)
- }
- }
- reply, err := redis.Values(c.Do(""))
- if err != nil {
- t.Fatalf("Do() returned error %v", err)
- }
- if len(reply) != len(testCommands) {
- t.Fatalf("len(reply)=%d, want %d", len(reply), len(testCommands))
- }
- for i, cmd := range testCommands {
- actual := reply[i]
- if !reflect.DeepEqual(actual, cmd.expected) {
- t.Errorf("Receive(%v) = %v, want %v", cmd.args, actual, cmd.expected)
- }
- }
-}
-
-func TestRecvBeforeSend(t *testing.T) {
- c, err := redistest.Dial()
- if err != nil {
- t.Fatalf("error connection to database, %v", err)
- }
- defer c.Close()
- done := make(chan struct{})
- go func() {
- c.Receive()
- close(done)
- }()
- time.Sleep(time.Millisecond)
- c.Send("PING")
- c.Flush()
- <-done
- _, err = c.Do("")
- if err != nil {
- t.Fatalf("error=%v", err)
- }
-}
-
-func TestError(t *testing.T) {
- c, err := redistest.Dial()
- if err != nil {
- t.Fatalf("error connection to database, %v", err)
- }
- defer c.Close()
-
- c.Do("SET", "key", "val")
- _, err = c.Do("HSET", "key", "fld", "val")
- if err == nil {
- t.Errorf("Expected err for HSET on string key.")
- }
- if c.Err() != nil {
- t.Errorf("Conn has Err()=%v, expect nil", c.Err())
- }
- _, err = c.Do("SET", "key", "val")
- if err != nil {
- t.Errorf("Do(SET, key, val) returned error %v, expected nil.", err)
- }
-}
-
-func TestReadDeadline(t *testing.T) {
- l, err := net.Listen("tcp", "127.0.0.1:0")
- if err != nil {
- t.Fatalf("net.Listen returned %v", err)
- }
- defer l.Close()
-
- go func() {
- for {
- c, err := l.Accept()
- if err != nil {
- return
- }
- go func() {
- time.Sleep(time.Second)
- c.Write([]byte("+OK\r\n"))
- c.Close()
- }()
- }
- }()
-
- c1, err := redis.DialTimeout(l.Addr().Network(), l.Addr().String(), 0, time.Millisecond, 0)
- if err != nil {
- t.Fatalf("redis.Dial returned %v", err)
- }
- defer c1.Close()
-
- _, err = c1.Do("PING")
- if err == nil {
- t.Fatalf("c1.Do() returned nil, expect error")
- }
- if c1.Err() == nil {
- t.Fatalf("c1.Err() = nil, expect error")
- }
-
- c2, err := redis.DialTimeout(l.Addr().Network(), l.Addr().String(), 0, time.Millisecond, 0)
- if err != nil {
- t.Fatalf("redis.Dial returned %v", err)
- }
- defer c2.Close()
-
- c2.Send("PING")
- c2.Flush()
- _, err = c2.Receive()
- if err == nil {
- t.Fatalf("c2.Receive() returned nil, expect error")
- }
- if c2.Err() == nil {
- t.Fatalf("c2.Err() = nil, expect error")
- }
-}
-
-// Connect to local instance of Redis running on the default port.
-func ExampleDial(x int) {
- c, err := redis.Dial("tcp", ":6379")
- if err != nil {
- // handle error
- }
- defer c.Close()
-}
-
-// TextExecError tests handling of errors in a transaction. See
-// http://redis.io/topics/transactions for information on how Redis handles
-// errors in a transaction.
-func TestExecError(t *testing.T) {
- c, err := redistest.Dial()
- if err != nil {
- t.Fatalf("error connection to database, %v", err)
- }
- defer c.Close()
-
- // Execute commands that fail before EXEC is called.
-
- c.Do("ZADD", "k0", 0, 0)
- c.Send("MULTI")
- c.Send("NOTACOMMAND", "k0", 0, 0)
- c.Send("ZINCRBY", "k0", 0, 0)
- v, err := c.Do("EXEC")
- if err == nil {
- t.Fatalf("EXEC returned values %v, expected error", v)
- }
-
- // Execute commands that fail after EXEC is called. The first command
- // returns an error.
-
- c.Do("ZADD", "k1", 0, 0)
- c.Send("MULTI")
- c.Send("HSET", "k1", 0, 0)
- c.Send("ZINCRBY", "k1", 0, 0)
- v, err = c.Do("EXEC")
- if err != nil {
- t.Fatalf("EXEC returned error %v", err)
- }
-
- vs, err := redis.Values(v, nil)
- if err != nil {
- t.Fatalf("Values(v) returned error %v", err)
- }
-
- if len(vs) != 2 {
- t.Fatalf("len(vs) == %d, want 2", len(vs))
- }
-
- if _, ok := vs[0].(error); !ok {
- t.Fatalf("first result is type %T, expected error", vs[0])
- }
-
- if _, ok := vs[1].([]byte); !ok {
- t.Fatalf("second result is type %T, expected []byte", vs[2])
- }
-
- // Execute commands that fail after EXEC is called. The second command
- // returns an error.
-
- c.Do("ZADD", "k2", 0, 0)
- c.Send("MULTI")
- c.Send("ZINCRBY", "k2", 0, 0)
- c.Send("HSET", "k2", 0, 0)
- v, err = c.Do("EXEC")
- if err != nil {
- t.Fatalf("EXEC returned error %v", err)
- }
-
- vs, err = redis.Values(v, nil)
- if err != nil {
- t.Fatalf("Values(v) returned error %v", err)
- }
-
- if len(vs) != 2 {
- t.Fatalf("len(vs) == %d, want 2", len(vs))
- }
-
- if _, ok := vs[0].([]byte); !ok {
- t.Fatalf("first result is type %T, expected []byte", vs[0])
- }
-
- if _, ok := vs[1].(error); !ok {
- t.Fatalf("second result is type %T, expected error", vs[2])
- }
-}
-
-func BenchmarkDoEmpty(b *testing.B) {
- b.StopTimer()
- c, err := redistest.Dial()
- if err != nil {
- b.Fatal(err)
- }
- defer c.Close()
- b.StartTimer()
- for i := 0; i < b.N; i++ {
- if _, err := c.Do(""); err != nil {
- b.Fatal(err)
- }
- }
-}
-
-func BenchmarkDoPing(b *testing.B) {
- b.StopTimer()
- c, err := redistest.Dial()
- if err != nil {
- b.Fatal(err)
- }
- defer c.Close()
- b.StartTimer()
- for i := 0; i < b.N; i++ {
- if _, err := c.Do("PING"); err != nil {
- b.Fatal(err)
- }
- }
-}
diff --git a/vendor/github.com/garyburd/redigo/redis/pool_test.go b/vendor/github.com/garyburd/redigo/redis/pool_test.go
deleted file mode 100644
index 1fe305f1..00000000
--- a/vendor/github.com/garyburd/redigo/redis/pool_test.go
+++ /dev/null
@@ -1,674 +0,0 @@
-// Copyright 2011 Gary Burd
-//
-// Licensed under the Apache License, Version 2.0 (the "License"): you may
-// not use this file except in compliance with the License. You may obtain
-// a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-// License for the specific language governing permissions and limitations
-// under the License.
-
-package redis_test
-
-import (
- "errors"
- "io"
- "reflect"
- "sync"
- "testing"
- "time"
-
- "github.com/garyburd/redigo/internal/redistest"
- "github.com/garyburd/redigo/redis"
-)
-
-type poolTestConn struct {
- d *poolDialer
- err error
- redis.Conn
-}
-
-func (c *poolTestConn) Close() error { c.d.open -= 1; return nil }
-func (c *poolTestConn) Err() error { return c.err }
-
-func (c *poolTestConn) Do(commandName string, args ...interface{}) (reply interface{}, err error) {
- if commandName == "ERR" {
- c.err = args[0].(error)
- commandName = "PING"
- }
- if commandName != "" {
- c.d.commands = append(c.d.commands, commandName)
- }
- return c.Conn.Do(commandName, args...)
-}
-
-func (c *poolTestConn) Send(commandName string, args ...interface{}) error {
- c.d.commands = append(c.d.commands, commandName)
- return c.Conn.Send(commandName, args...)
-}
-
-type poolDialer struct {
- t *testing.T
- dialed int
- open int
- commands []string
- dialErr error
-}
-
-func (d *poolDialer) dial() (redis.Conn, error) {
- d.dialed += 1
- if d.dialErr != nil {
- return nil, d.dialErr
- }
- c, err := redistest.Dial()
- if err != nil {
- return nil, err
- }
- d.open += 1
- return &poolTestConn{d: d, Conn: c}, nil
-}
-
-func (d *poolDialer) check(message string, p *redis.Pool, dialed, open int) {
- if d.dialed != dialed {
- d.t.Errorf("%s: dialed=%d, want %d", message, d.dialed, dialed)
- }
- if d.open != open {
- d.t.Errorf("%s: open=%d, want %d", message, d.open, open)
- }
- if active := p.ActiveCount(); active != open {
- d.t.Errorf("%s: active=%d, want %d", message, active, open)
- }
-}
-
-func TestPoolReuse(t *testing.T) {
- d := poolDialer{t: t}
- p := &redis.Pool{
- MaxIdle: 2,
- Dial: d.dial,
- }
-
- for i := 0; i < 10; i++ {
- c1 := p.Get()
- c1.Do("PING")
- c2 := p.Get()
- c2.Do("PING")
- c1.Close()
- c2.Close()
- }
-
- d.check("before close", p, 2, 2)
- p.Close()
- d.check("after close", p, 2, 0)
-}
-
-func TestPoolMaxIdle(t *testing.T) {
- d := poolDialer{t: t}
- p := &redis.Pool{
- MaxIdle: 2,
- Dial: d.dial,
- }
- for i := 0; i < 10; i++ {
- c1 := p.Get()
- c1.Do("PING")
- c2 := p.Get()
- c2.Do("PING")
- c3 := p.Get()
- c3.Do("PING")
- c1.Close()
- c2.Close()
- c3.Close()
- }
- d.check("before close", p, 12, 2)
- p.Close()
- d.check("after close", p, 12, 0)
-}
-
-func TestPoolError(t *testing.T) {
- d := poolDialer{t: t}
- p := &redis.Pool{
- MaxIdle: 2,
- Dial: d.dial,
- }
-
- c := p.Get()
- c.Do("ERR", io.EOF)
- if c.Err() == nil {
- t.Errorf("expected c.Err() != nil")
- }
- c.Close()
-
- c = p.Get()
- c.Do("ERR", io.EOF)
- c.Close()
-
- d.check(".", p, 2, 0)
-}
-
-func TestPoolClose(t *testing.T) {
- d := poolDialer{t: t}
- p := &redis.Pool{
- MaxIdle: 2,
- Dial: d.dial,
- }
-
- c1 := p.Get()
- c1.Do("PING")
- c2 := p.Get()
- c2.Do("PING")
- c3 := p.Get()
- c3.Do("PING")
-
- c1.Close()
- if _, err := c1.Do("PING"); err == nil {
- t.Errorf("expected error after connection closed")
- }
-
- c2.Close()
- c2.Close()
-
- p.Close()
-
- d.check("after pool close", p, 3, 1)
-
- if _, err := c1.Do("PING"); err == nil {
- t.Errorf("expected error after connection and pool closed")
- }
-
- c3.Close()
-
- d.check("after conn close", p, 3, 0)
-
- c1 = p.Get()
- if _, err := c1.Do("PING"); err == nil {
- t.Errorf("expected error after pool closed")
- }
-}
-
-func TestPoolTimeout(t *testing.T) {
- d := poolDialer{t: t}
- p := &redis.Pool{
- MaxIdle: 2,
- IdleTimeout: 300 * time.Second,
- Dial: d.dial,
- }
-
- now := time.Now()
- redis.SetNowFunc(func() time.Time { return now })
- defer redis.SetNowFunc(time.Now)
-
- c := p.Get()
- c.Do("PING")
- c.Close()
-
- d.check("1", p, 1, 1)
-
- now = now.Add(p.IdleTimeout)
-
- c = p.Get()
- c.Do("PING")
- c.Close()
-
- d.check("2", p, 2, 1)
-
- p.Close()
-}
-
-func TestPoolConcurrenSendReceive(t *testing.T) {
- p := &redis.Pool{
- Dial: redistest.Dial,
- }
- c := p.Get()
- done := make(chan error, 1)
- go func() {
- _, err := c.Receive()
- done <- err
- }()
- c.Send("PING")
- c.Flush()
- err := <-done
- if err != nil {
- t.Fatalf("Receive() returned error %v", err)
- }
- _, err = c.Do("")
- if err != nil {
- t.Fatalf("Do() returned error %v", err)
- }
- c.Close()
- p.Close()
-}
-
-func TestPoolBorrowCheck(t *testing.T) {
- d := poolDialer{t: t}
- p := &redis.Pool{
- MaxIdle: 2,
- Dial: d.dial,
- TestOnBorrow: func(redis.Conn, time.Time) error { return redis.Error("BLAH") },
- }
-
- for i := 0; i < 10; i++ {
- c := p.Get()
- c.Do("PING")
- c.Close()
- }
- d.check("1", p, 10, 1)
- p.Close()
-}
-
-func TestPoolMaxActive(t *testing.T) {
- d := poolDialer{t: t}
- p := &redis.Pool{
- MaxIdle: 2,
- MaxActive: 2,
- Dial: d.dial,
- }
- c1 := p.Get()
- c1.Do("PING")
- c2 := p.Get()
- c2.Do("PING")
-
- d.check("1", p, 2, 2)
-
- c3 := p.Get()
- if _, err := c3.Do("PING"); err != redis.ErrPoolExhausted {
- t.Errorf("expected pool exhausted")
- }
-
- c3.Close()
- d.check("2", p, 2, 2)
- c2.Close()
- d.check("3", p, 2, 2)
-
- c3 = p.Get()
- if _, err := c3.Do("PING"); err != nil {
- t.Errorf("expected good channel, err=%v", err)
- }
- c3.Close()
-
- d.check("4", p, 2, 2)
- p.Close()
-}
-
-func TestPoolMonitorCleanup(t *testing.T) {
- d := poolDialer{t: t}
- p := &redis.Pool{
- MaxIdle: 2,
- MaxActive: 2,
- Dial: d.dial,
- }
- c := p.Get()
- c.Send("MONITOR")
- c.Close()
-
- d.check("", p, 1, 0)
- p.Close()
-}
-
-func TestPoolPubSubCleanup(t *testing.T) {
- d := poolDialer{t: t}
- p := &redis.Pool{
- MaxIdle: 2,
- MaxActive: 2,
- Dial: d.dial,
- }
-
- c := p.Get()
- c.Send("SUBSCRIBE", "x")
- c.Close()
-
- want := []string{"SUBSCRIBE", "UNSUBSCRIBE", "PUNSUBSCRIBE", "ECHO"}
- if !reflect.DeepEqual(d.commands, want) {
- t.Errorf("got commands %v, want %v", d.commands, want)
- }
- d.commands = nil
-
- c = p.Get()
- c.Send("PSUBSCRIBE", "x*")
- c.Close()
-
- want = []string{"PSUBSCRIBE", "UNSUBSCRIBE", "PUNSUBSCRIBE", "ECHO"}
- if !reflect.DeepEqual(d.commands, want) {
- t.Errorf("got commands %v, want %v", d.commands, want)
- }
- d.commands = nil
-
- p.Close()
-}
-
-func TestPoolTransactionCleanup(t *testing.T) {
- d := poolDialer{t: t}
- p := &redis.Pool{
- MaxIdle: 2,
- MaxActive: 2,
- Dial: d.dial,
- }
-
- c := p.Get()
- c.Do("WATCH", "key")
- c.Do("PING")
- c.Close()
-
- want := []string{"WATCH", "PING", "UNWATCH"}
- if !reflect.DeepEqual(d.commands, want) {
- t.Errorf("got commands %v, want %v", d.commands, want)
- }
- d.commands = nil
-
- c = p.Get()
- c.Do("WATCH", "key")
- c.Do("UNWATCH")
- c.Do("PING")
- c.Close()
-
- want = []string{"WATCH", "UNWATCH", "PING"}
- if !reflect.DeepEqual(d.commands, want) {
- t.Errorf("got commands %v, want %v", d.commands, want)
- }
- d.commands = nil
-
- c = p.Get()
- c.Do("WATCH", "key")
- c.Do("MULTI")
- c.Do("PING")
- c.Close()
-
- want = []string{"WATCH", "MULTI", "PING", "DISCARD"}
- if !reflect.DeepEqual(d.commands, want) {
- t.Errorf("got commands %v, want %v", d.commands, want)
- }
- d.commands = nil
-
- c = p.Get()
- c.Do("WATCH", "key")
- c.Do("MULTI")
- c.Do("DISCARD")
- c.Do("PING")
- c.Close()
-
- want = []string{"WATCH", "MULTI", "DISCARD", "PING"}
- if !reflect.DeepEqual(d.commands, want) {
- t.Errorf("got commands %v, want %v", d.commands, want)
- }
- d.commands = nil
-
- c = p.Get()
- c.Do("WATCH", "key")
- c.Do("MULTI")
- c.Do("EXEC")
- c.Do("PING")
- c.Close()
-
- want = []string{"WATCH", "MULTI", "EXEC", "PING"}
- if !reflect.DeepEqual(d.commands, want) {
- t.Errorf("got commands %v, want %v", d.commands, want)
- }
- d.commands = nil
-
- p.Close()
-}
-
-func startGoroutines(p *redis.Pool, cmd string, args ...interface{}) chan error {
- errs := make(chan error, 10)
- for i := 0; i < cap(errs); i++ {
- go func() {
- c := p.Get()
- _, err := c.Do(cmd, args...)
- errs <- err
- c.Close()
- }()
- }
-
- // Wait for goroutines to block.
- time.Sleep(time.Second / 4)
-
- return errs
-}
-
-func TestWaitPool(t *testing.T) {
- d := poolDialer{t: t}
- p := &redis.Pool{
- MaxIdle: 1,
- MaxActive: 1,
- Dial: d.dial,
- Wait: true,
- }
- defer p.Close()
- c := p.Get()
- errs := startGoroutines(p, "PING")
- d.check("before close", p, 1, 1)
- c.Close()
- timeout := time.After(2 * time.Second)
- for i := 0; i < cap(errs); i++ {
- select {
- case err := <-errs:
- if err != nil {
- t.Fatal(err)
- }
- case <-timeout:
- t.Fatalf("timeout waiting for blocked goroutine %d", i)
- }
- }
- d.check("done", p, 1, 1)
-}
-
-func TestWaitPoolClose(t *testing.T) {
- d := poolDialer{t: t}
- p := &redis.Pool{
- MaxIdle: 1,
- MaxActive: 1,
- Dial: d.dial,
- Wait: true,
- }
- c := p.Get()
- if _, err := c.Do("PING"); err != nil {
- t.Fatal(err)
- }
- errs := startGoroutines(p, "PING")
- d.check("before close", p, 1, 1)
- p.Close()
- timeout := time.After(2 * time.Second)
- for i := 0; i < cap(errs); i++ {
- select {
- case err := <-errs:
- switch err {
- case nil:
- t.Fatal("blocked goroutine did not get error")
- case redis.ErrPoolExhausted:
- t.Fatal("blocked goroutine got pool exhausted error")
- }
- case <-timeout:
- t.Fatal("timeout waiting for blocked goroutine")
- }
- }
- c.Close()
- d.check("done", p, 1, 0)
-}
-
-func TestWaitPoolCommandError(t *testing.T) {
- testErr := errors.New("test")
- d := poolDialer{t: t}
- p := &redis.Pool{
- MaxIdle: 1,
- MaxActive: 1,
- Dial: d.dial,
- Wait: true,
- }
- defer p.Close()
- c := p.Get()
- errs := startGoroutines(p, "ERR", testErr)
- d.check("before close", p, 1, 1)
- c.Close()
- timeout := time.After(2 * time.Second)
- for i := 0; i < cap(errs); i++ {
- select {
- case err := <-errs:
- if err != nil {
- t.Fatal(err)
- }
- case <-timeout:
- t.Fatalf("timeout waiting for blocked goroutine %d", i)
- }
- }
- d.check("done", p, cap(errs), 0)
-}
-
-func TestWaitPoolDialError(t *testing.T) {
- testErr := errors.New("test")
- d := poolDialer{t: t}
- p := &redis.Pool{
- MaxIdle: 1,
- MaxActive: 1,
- Dial: d.dial,
- Wait: true,
- }
- defer p.Close()
- c := p.Get()
- errs := startGoroutines(p, "ERR", testErr)
- d.check("before close", p, 1, 1)
-
- d.dialErr = errors.New("dial")
- c.Close()
-
- nilCount := 0
- errCount := 0
- timeout := time.After(2 * time.Second)
- for i := 0; i < cap(errs); i++ {
- select {
- case err := <-errs:
- switch err {
- case nil:
- nilCount++
- case d.dialErr:
- errCount++
- default:
- t.Fatalf("expected dial error or nil, got %v", err)
- }
- case <-timeout:
- t.Fatalf("timeout waiting for blocked goroutine %d", i)
- }
- }
- if nilCount != 1 {
- t.Errorf("expected one nil error, got %d", nilCount)
- }
- if errCount != cap(errs)-1 {
- t.Errorf("expected %d dial erors, got %d", cap(errs)-1, errCount)
- }
- d.check("done", p, cap(errs), 0)
-}
-
-// Borrowing requires us to iterate over the idle connections, unlock the pool,
-// and perform a blocking operation to check the connection still works. If
-// TestOnBorrow fails, we must reacquire the lock and continue iteration. This
-// test ensures that iteration will work correctly if multiple threads are
-// iterating simultaneously.
-func TestLocking_TestOnBorrowFails_PoolDoesntCrash(t *testing.T) {
- count := 100
-
- // First we'll Create a pool where the pilfering of idle connections fails.
- d := poolDialer{t: t}
- p := &redis.Pool{
- MaxIdle: count,
- MaxActive: count,
- Dial: d.dial,
- TestOnBorrow: func(c redis.Conn, t time.Time) error {
- return errors.New("No way back into the real world.")
- },
- }
- defer p.Close()
-
- // Fill the pool with idle connections.
- b1 := sync.WaitGroup{}
- b1.Add(count)
- b2 := sync.WaitGroup{}
- b2.Add(count)
- for i := 0; i < count; i++ {
- go func() {
- c := p.Get()
- if c.Err() != nil {
- t.Errorf("pool get failed: %v", c.Err())
- }
- b1.Done()
- b1.Wait()
- c.Close()
- b2.Done()
- }()
- }
- b2.Wait()
- if d.dialed != count {
- t.Errorf("Expected %d dials, got %d", count, d.dialed)
- }
-
- // Spawn a bunch of goroutines to thrash the pool.
- b2.Add(count)
- for i := 0; i < count; i++ {
- go func() {
- c := p.Get()
- if c.Err() != nil {
- t.Errorf("pool get failed: %v", c.Err())
- }
- c.Close()
- b2.Done()
- }()
- }
- b2.Wait()
- if d.dialed != count*2 {
- t.Errorf("Expected %d dials, got %d", count*2, d.dialed)
- }
-}
-
-func BenchmarkPoolGet(b *testing.B) {
- b.StopTimer()
- p := redis.Pool{Dial: redistest.Dial, MaxIdle: 2}
- c := p.Get()
- if err := c.Err(); err != nil {
- b.Fatal(err)
- }
- c.Close()
- defer p.Close()
- b.StartTimer()
- for i := 0; i < b.N; i++ {
- c = p.Get()
- c.Close()
- }
-}
-
-func BenchmarkPoolGetErr(b *testing.B) {
- b.StopTimer()
- p := redis.Pool{Dial: redistest.Dial, MaxIdle: 2}
- c := p.Get()
- if err := c.Err(); err != nil {
- b.Fatal(err)
- }
- c.Close()
- defer p.Close()
- b.StartTimer()
- for i := 0; i < b.N; i++ {
- c = p.Get()
- if err := c.Err(); err != nil {
- b.Fatal(err)
- }
- c.Close()
- }
-}
-
-func BenchmarkPoolGetPing(b *testing.B) {
- b.StopTimer()
- p := redis.Pool{Dial: redistest.Dial, MaxIdle: 2}
- c := p.Get()
- if err := c.Err(); err != nil {
- b.Fatal(err)
- }
- c.Close()
- defer p.Close()
- b.StartTimer()
- for i := 0; i < b.N; i++ {
- c = p.Get()
- if _, err := c.Do("PING"); err != nil {
- b.Fatal(err)
- }
- c.Close()
- }
-}
diff --git a/vendor/github.com/garyburd/redigo/redis/pubsub_test.go b/vendor/github.com/garyburd/redigo/redis/pubsub_test.go
deleted file mode 100644
index 707f5a47..00000000
--- a/vendor/github.com/garyburd/redigo/redis/pubsub_test.go
+++ /dev/null
@@ -1,143 +0,0 @@
-// Copyright 2012 Gary Burd
-//
-// Licensed under the Apache License, Version 2.0 (the "License"): you may
-// not use this file except in compliance with the License. You may obtain
-// a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-// License for the specific language governing permissions and limitations
-// under the License.
-
-package redis_test
-
-import (
- "fmt"
- "net"
- "reflect"
- "sync"
- "testing"
- "time"
-
- "github.com/garyburd/redigo/internal/redistest"
- "github.com/garyburd/redigo/redis"
-)
-
-func publish(channel, value interface{}) {
- c, err := dial()
- if err != nil {
- panic(err)
- }
- defer c.Close()
- c.Do("PUBLISH", channel, value)
-}
-
-// Applications can receive pushed messages from one goroutine and manage subscriptions from another goroutine.
-func ExamplePubSubConn() {
- c, err := dial()
- if err != nil {
- panic(err)
- }
- defer c.Close()
- var wg sync.WaitGroup
- wg.Add(2)
-
- psc := redis.PubSubConn{Conn: c}
-
- // This goroutine receives and prints pushed notifications from the server.
- // The goroutine exits when the connection is unsubscribed from all
- // channels or there is an error.
- go func() {
- defer wg.Done()
- for {
- switch n := psc.Receive().(type) {
- case redis.Message:
- fmt.Printf("Message: %s %s\n", n.Channel, n.Data)
- case redis.PMessage:
- fmt.Printf("PMessage: %s %s %s\n", n.Pattern, n.Channel, n.Data)
- case redis.Subscription:
- fmt.Printf("Subscription: %s %s %d\n", n.Kind, n.Channel, n.Count)
- if n.Count == 0 {
- return
- }
- case error:
- fmt.Printf("error: %v\n", n)
- return
- }
- }
- }()
-
- // This goroutine manages subscriptions for the connection.
- go func() {
- defer wg.Done()
-
- psc.Subscribe("example")
- psc.PSubscribe("p*")
-
- // The following function calls publish a message using another
- // connection to the Redis server.
- publish("example", "hello")
- publish("example", "world")
- publish("pexample", "foo")
- publish("pexample", "bar")
-
- // Unsubscribe from all connections. This will cause the receiving
- // goroutine to exit.
- psc.Unsubscribe()
- psc.PUnsubscribe()
- }()
-
- wg.Wait()
-
- // Output:
- // Subscription: subscribe example 1
- // Subscription: psubscribe p* 2
- // Message: example hello
- // Message: example world
- // PMessage: p* pexample foo
- // PMessage: p* pexample bar
- // Subscription: unsubscribe example 1
- // Subscription: punsubscribe p* 0
-}
-
-func expectPushed(t *testing.T, c redis.PubSubConn, message string, expected interface{}) {
- actual := c.Receive()
- if !reflect.DeepEqual(actual, expected) {
- t.Errorf("%s = %v, want %v", message, actual, expected)
- }
-}
-
-func TestPushed(t *testing.T) {
- pc, err := redistest.Dial()
- if err != nil {
- t.Fatalf("error connection to database, %v", err)
- }
- defer pc.Close()
-
- nc, err := net.Dial("tcp", ":6379")
- if err != nil {
- t.Fatal(err)
- }
- defer nc.Close()
- nc.SetReadDeadline(time.Now().Add(4 * time.Second))
-
- c := redis.PubSubConn{Conn: redis.NewConn(nc, 0, 0)}
-
- c.Subscribe("c1")
- expectPushed(t, c, "Subscribe(c1)", redis.Subscription{Kind: "subscribe", Channel: "c1", Count: 1})
- c.Subscribe("c2")
- expectPushed(t, c, "Subscribe(c2)", redis.Subscription{Kind: "subscribe", Channel: "c2", Count: 2})
- c.PSubscribe("p1")
- expectPushed(t, c, "PSubscribe(p1)", redis.Subscription{Kind: "psubscribe", Channel: "p1", Count: 3})
- c.PSubscribe("p2")
- expectPushed(t, c, "PSubscribe(p2)", redis.Subscription{Kind: "psubscribe", Channel: "p2", Count: 4})
- c.PUnsubscribe()
- expectPushed(t, c, "Punsubscribe(p1)", redis.Subscription{Kind: "punsubscribe", Channel: "p1", Count: 3})
- expectPushed(t, c, "Punsubscribe()", redis.Subscription{Kind: "punsubscribe", Channel: "p2", Count: 2})
-
- pc.Do("PUBLISH", "c1", "hello")
- expectPushed(t, c, "PUBLISH c1 hello", redis.Message{Channel: "c1", Data: []byte("hello")})
-}
diff --git a/vendor/github.com/garyburd/redigo/redis/reply_test.go b/vendor/github.com/garyburd/redigo/redis/reply_test.go
deleted file mode 100644
index 92744c59..00000000
--- a/vendor/github.com/garyburd/redigo/redis/reply_test.go
+++ /dev/null
@@ -1,166 +0,0 @@
-// Copyright 2012 Gary Burd
-//
-// Licensed under the Apache License, Version 2.0 (the "License"): you may
-// not use this file except in compliance with the License. You may obtain
-// a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-// License for the specific language governing permissions and limitations
-// under the License.
-
-package redis_test
-
-import (
- "fmt"
- "reflect"
- "testing"
-
- "github.com/garyburd/redigo/internal/redistest"
- "github.com/garyburd/redigo/redis"
-)
-
-type valueError struct {
- v interface{}
- err error
-}
-
-func ve(v interface{}, err error) valueError {
- return valueError{v, err}
-}
-
-var replyTests = []struct {
- name interface{}
- actual valueError
- expected valueError
-}{
- {
- "ints([v1, v2])",
- ve(redis.Ints([]interface{}{[]byte("4"), []byte("5")}, nil)),
- ve([]int{4, 5}, nil),
- },
- {
- "ints(nil)",
- ve(redis.Ints(nil, nil)),
- ve([]int(nil), redis.ErrNil),
- },
- {
- "strings([v1, v2])",
- ve(redis.Strings([]interface{}{[]byte("v1"), []byte("v2")}, nil)),
- ve([]string{"v1", "v2"}, nil),
- },
- {
- "strings(nil)",
- ve(redis.Strings(nil, nil)),
- ve([]string(nil), redis.ErrNil),
- },
- {
- "values([v1, v2])",
- ve(redis.Values([]interface{}{[]byte("v1"), []byte("v2")}, nil)),
- ve([]interface{}{[]byte("v1"), []byte("v2")}, nil),
- },
- {
- "values(nil)",
- ve(redis.Values(nil, nil)),
- ve([]interface{}(nil), redis.ErrNil),
- },
- {
- "float64(1.0)",
- ve(redis.Float64([]byte("1.0"), nil)),
- ve(float64(1.0), nil),
- },
- {
- "float64(nil)",
- ve(redis.Float64(nil, nil)),
- ve(float64(0.0), redis.ErrNil),
- },
- {
- "uint64(1)",
- ve(redis.Uint64(int64(1), nil)),
- ve(uint64(1), nil),
- },
- {
- "uint64(-1)",
- ve(redis.Uint64(int64(-1), nil)),
- ve(uint64(0), redis.ErrNegativeInt),
- },
-}
-
-func TestReply(t *testing.T) {
- for _, rt := range replyTests {
- if rt.actual.err != rt.expected.err {
- t.Errorf("%s returned err %v, want %v", rt.name, rt.actual.err, rt.expected.err)
- continue
- }
- if !reflect.DeepEqual(rt.actual.v, rt.expected.v) {
- t.Errorf("%s=%+v, want %+v", rt.name, rt.actual.v, rt.expected.v)
- }
- }
-}
-
-// dial wraps DialTestDB() with a more suitable function name for examples.
-func dial() (redis.Conn, error) {
- return redistest.Dial()
-}
-
-func ExampleBool() {
- c, err := dial()
- if err != nil {
- panic(err)
- }
- defer c.Close()
-
- c.Do("SET", "foo", 1)
- exists, _ := redis.Bool(c.Do("EXISTS", "foo"))
- fmt.Printf("%#v\n", exists)
- // Output:
- // true
-}
-
-func ExampleInt() {
- c, err := dial()
- if err != nil {
- panic(err)
- }
- defer c.Close()
-
- c.Do("SET", "k1", 1)
- n, _ := redis.Int(c.Do("GET", "k1"))
- fmt.Printf("%#v\n", n)
- n, _ = redis.Int(c.Do("INCR", "k1"))
- fmt.Printf("%#v\n", n)
- // Output:
- // 1
- // 2
-}
-
-func ExampleInts() {
- c, err := dial()
- if err != nil {
- panic(err)
- }
- defer c.Close()
-
- c.Do("SADD", "set_with_integers", 4, 5, 6)
- ints, _ := redis.Ints(c.Do("SMEMBERS", "set_with_integers"))
- fmt.Printf("%#v\n", ints)
- // Output:
- // []int{4, 5, 6}
-}
-
-func ExampleString() {
- c, err := dial()
- if err != nil {
- panic(err)
- }
- defer c.Close()
-
- c.Do("SET", "hello", "world")
- s, err := redis.String(c.Do("GET", "hello"))
- fmt.Printf("%#v\n", s)
- // Output:
- // "world"
-}
diff --git a/vendor/github.com/garyburd/redigo/redis/scan_test.go b/vendor/github.com/garyburd/redigo/redis/scan_test.go
deleted file mode 100644
index b57dd896..00000000
--- a/vendor/github.com/garyburd/redigo/redis/scan_test.go
+++ /dev/null
@@ -1,412 +0,0 @@
-// Copyright 2012 Gary Burd
-//
-// Licensed under the Apache License, Version 2.0 (the "License"): you may
-// not use this file except in compliance with the License. You may obtain
-// a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-// License for the specific language governing permissions and limitations
-// under the License.
-
-package redis_test
-
-import (
- "fmt"
- "github.com/garyburd/redigo/redis"
- "math"
- "reflect"
- "testing"
-)
-
-var scanConversionTests = []struct {
- src interface{}
- dest interface{}
-}{
- {[]byte("-inf"), math.Inf(-1)},
- {[]byte("+inf"), math.Inf(1)},
- {[]byte("0"), float64(0)},
- {[]byte("3.14159"), float64(3.14159)},
- {[]byte("3.14"), float32(3.14)},
- {[]byte("-100"), int(-100)},
- {[]byte("101"), int(101)},
- {int64(102), int(102)},
- {[]byte("103"), uint(103)},
- {int64(104), uint(104)},
- {[]byte("105"), int8(105)},
- {int64(106), int8(106)},
- {[]byte("107"), uint8(107)},
- {int64(108), uint8(108)},
- {[]byte("0"), false},
- {int64(0), false},
- {[]byte("f"), false},
- {[]byte("1"), true},
- {int64(1), true},
- {[]byte("t"), true},
- {[]byte("hello"), "hello"},
- {[]byte("world"), []byte("world")},
- {[]interface{}{[]byte("foo")}, []interface{}{[]byte("foo")}},
- {[]interface{}{[]byte("foo")}, []string{"foo"}},
- {[]interface{}{[]byte("hello"), []byte("world")}, []string{"hello", "world"}},
- {[]interface{}{[]byte("bar")}, [][]byte{[]byte("bar")}},
- {[]interface{}{[]byte("1")}, []int{1}},
- {[]interface{}{[]byte("1"), []byte("2")}, []int{1, 2}},
- {[]interface{}{[]byte("1"), []byte("2")}, []float64{1, 2}},
- {[]interface{}{[]byte("1")}, []byte{1}},
- {[]interface{}{[]byte("1")}, []bool{true}},
-}
-
-func TestScanConversion(t *testing.T) {
- for _, tt := range scanConversionTests {
- values := []interface{}{tt.src}
- dest := reflect.New(reflect.TypeOf(tt.dest))
- values, err := redis.Scan(values, dest.Interface())
- if err != nil {
- t.Errorf("Scan(%v) returned error %v", tt, err)
- continue
- }
- if !reflect.DeepEqual(tt.dest, dest.Elem().Interface()) {
- t.Errorf("Scan(%v) returned %v, want %v", tt, dest.Elem().Interface(), tt.dest)
- }
- }
-}
-
-var scanConversionErrorTests = []struct {
- src interface{}
- dest interface{}
-}{
- {[]byte("1234"), byte(0)},
- {int64(1234), byte(0)},
- {[]byte("-1"), byte(0)},
- {int64(-1), byte(0)},
- {[]byte("junk"), false},
- {redis.Error("blah"), false},
-}
-
-func TestScanConversionError(t *testing.T) {
- for _, tt := range scanConversionErrorTests {
- values := []interface{}{tt.src}
- dest := reflect.New(reflect.TypeOf(tt.dest))
- values, err := redis.Scan(values, dest.Interface())
- if err == nil {
- t.Errorf("Scan(%v) did not return error", tt)
- }
- }
-}
-
-func ExampleScan() {
- c, err := dial()
- if err != nil {
- panic(err)
- }
- defer c.Close()
-
- c.Send("HMSET", "album:1", "title", "Red", "rating", 5)
- c.Send("HMSET", "album:2", "title", "Earthbound", "rating", 1)
- c.Send("HMSET", "album:3", "title", "Beat")
- c.Send("LPUSH", "albums", "1")
- c.Send("LPUSH", "albums", "2")
- c.Send("LPUSH", "albums", "3")
- values, err := redis.Values(c.Do("SORT", "albums",
- "BY", "album:*->rating",
- "GET", "album:*->title",
- "GET", "album:*->rating"))
- if err != nil {
- panic(err)
- }
-
- for len(values) > 0 {
- var title string
- rating := -1 // initialize to illegal value to detect nil.
- values, err = redis.Scan(values, &title, &rating)
- if err != nil {
- panic(err)
- }
- if rating == -1 {
- fmt.Println(title, "not-rated")
- } else {
- fmt.Println(title, rating)
- }
- }
- // Output:
- // Beat not-rated
- // Earthbound 1
- // Red 5
-}
-
-type s0 struct {
- X int
- Y int `redis:"y"`
- Bt bool
-}
-
-type s1 struct {
- X int `redis:"-"`
- I int `redis:"i"`
- U uint `redis:"u"`
- S string `redis:"s"`
- P []byte `redis:"p"`
- B bool `redis:"b"`
- Bt bool
- Bf bool
- s0
-}
-
-var scanStructTests = []struct {
- title string
- reply []string
- value interface{}
-}{
- {"basic",
- []string{"i", "-1234", "u", "5678", "s", "hello", "p", "world", "b", "t", "Bt", "1", "Bf", "0", "X", "123", "y", "456"},
- &s1{I: -1234, U: 5678, S: "hello", P: []byte("world"), B: true, Bt: true, Bf: false, s0: s0{X: 123, Y: 456}},
- },
-}
-
-func TestScanStruct(t *testing.T) {
- for _, tt := range scanStructTests {
-
- var reply []interface{}
- for _, v := range tt.reply {
- reply = append(reply, []byte(v))
- }
-
- value := reflect.New(reflect.ValueOf(tt.value).Type().Elem())
-
- if err := redis.ScanStruct(reply, value.Interface()); err != nil {
- t.Fatalf("ScanStruct(%s) returned error %v", tt.title, err)
- }
-
- if !reflect.DeepEqual(value.Interface(), tt.value) {
- t.Fatalf("ScanStruct(%s) returned %v, want %v", tt.title, value.Interface(), tt.value)
- }
- }
-}
-
-func TestBadScanStructArgs(t *testing.T) {
- x := []interface{}{"A", "b"}
- test := func(v interface{}) {
- if err := redis.ScanStruct(x, v); err == nil {
- t.Errorf("Expect error for ScanStruct(%T, %T)", x, v)
- }
- }
-
- test(nil)
-
- var v0 *struct{}
- test(v0)
-
- var v1 int
- test(&v1)
-
- x = x[:1]
- v2 := struct{ A string }{}
- test(&v2)
-}
-
-var scanSliceTests = []struct {
- src []interface{}
- fieldNames []string
- ok bool
- dest interface{}
-}{
- {
- []interface{}{[]byte("1"), nil, []byte("-1")},
- nil,
- true,
- []int{1, 0, -1},
- },
- {
- []interface{}{[]byte("1"), nil, []byte("2")},
- nil,
- true,
- []uint{1, 0, 2},
- },
- {
- []interface{}{[]byte("-1")},
- nil,
- false,
- []uint{1},
- },
- {
- []interface{}{[]byte("hello"), nil, []byte("world")},
- nil,
- true,
- [][]byte{[]byte("hello"), nil, []byte("world")},
- },
- {
- []interface{}{[]byte("hello"), nil, []byte("world")},
- nil,
- true,
- []string{"hello", "", "world"},
- },
- {
- []interface{}{[]byte("a1"), []byte("b1"), []byte("a2"), []byte("b2")},
- nil,
- true,
- []struct{ A, B string }{{"a1", "b1"}, {"a2", "b2"}},
- },
- {
- []interface{}{[]byte("a1"), []byte("b1")},
- nil,
- false,
- []struct{ A, B, C string }{{"a1", "b1", ""}},
- },
- {
- []interface{}{[]byte("a1"), []byte("b1"), []byte("a2"), []byte("b2")},
- nil,
- true,
- []*struct{ A, B string }{{"a1", "b1"}, {"a2", "b2"}},
- },
- {
- []interface{}{[]byte("a1"), []byte("b1"), []byte("a2"), []byte("b2")},
- []string{"A", "B"},
- true,
- []struct{ A, C, B string }{{"a1", "", "b1"}, {"a2", "", "b2"}},
- },
- {
- []interface{}{[]byte("a1"), []byte("b1"), []byte("a2"), []byte("b2")},
- nil,
- false,
- []struct{}{},
- },
-}
-
-func TestScanSlice(t *testing.T) {
- for _, tt := range scanSliceTests {
-
- typ := reflect.ValueOf(tt.dest).Type()
- dest := reflect.New(typ)
-
- err := redis.ScanSlice(tt.src, dest.Interface(), tt.fieldNames...)
- if tt.ok != (err == nil) {
- t.Errorf("ScanSlice(%v, []%s, %v) returned error %v", tt.src, typ, tt.fieldNames, err)
- continue
- }
- if tt.ok && !reflect.DeepEqual(dest.Elem().Interface(), tt.dest) {
- t.Errorf("ScanSlice(src, []%s) returned %#v, want %#v", typ, dest.Elem().Interface(), tt.dest)
- }
- }
-}
-
-func ExampleScanSlice() {
- c, err := dial()
- if err != nil {
- panic(err)
- }
- defer c.Close()
-
- c.Send("HMSET", "album:1", "title", "Red", "rating", 5)
- c.Send("HMSET", "album:2", "title", "Earthbound", "rating", 1)
- c.Send("HMSET", "album:3", "title", "Beat", "rating", 4)
- c.Send("LPUSH", "albums", "1")
- c.Send("LPUSH", "albums", "2")
- c.Send("LPUSH", "albums", "3")
- values, err := redis.Values(c.Do("SORT", "albums",
- "BY", "album:*->rating",
- "GET", "album:*->title",
- "GET", "album:*->rating"))
- if err != nil {
- panic(err)
- }
-
- var albums []struct {
- Title string
- Rating int
- }
- if err := redis.ScanSlice(values, &albums); err != nil {
- panic(err)
- }
- fmt.Printf("%v\n", albums)
- // Output:
- // [{Earthbound 1} {Beat 4} {Red 5}]
-}
-
-var argsTests = []struct {
- title string
- actual redis.Args
- expected redis.Args
-}{
- {"struct ptr",
- redis.Args{}.AddFlat(&struct {
- I int `redis:"i"`
- U uint `redis:"u"`
- S string `redis:"s"`
- P []byte `redis:"p"`
- Bt bool
- Bf bool
- }{
- -1234, 5678, "hello", []byte("world"), true, false,
- }),
- redis.Args{"i", int(-1234), "u", uint(5678), "s", "hello", "p", []byte("world"), "Bt", true, "Bf", false},
- },
- {"struct",
- redis.Args{}.AddFlat(struct{ I int }{123}),
- redis.Args{"I", 123},
- },
- {"slice",
- redis.Args{}.Add(1).AddFlat([]string{"a", "b", "c"}).Add(2),
- redis.Args{1, "a", "b", "c", 2},
- },
-}
-
-func TestArgs(t *testing.T) {
- for _, tt := range argsTests {
- if !reflect.DeepEqual(tt.actual, tt.expected) {
- t.Fatalf("%s is %v, want %v", tt.title, tt.actual, tt.expected)
- }
- }
-}
-
-func ExampleArgs() {
- c, err := dial()
- if err != nil {
- panic(err)
- }
- defer c.Close()
-
- var p1, p2 struct {
- Title string `redis:"title"`
- Author string `redis:"author"`
- Body string `redis:"body"`
- }
-
- p1.Title = "Example"
- p1.Author = "Gary"
- p1.Body = "Hello"
-
- if _, err := c.Do("HMSET", redis.Args{}.Add("id1").AddFlat(&p1)...); err != nil {
- panic(err)
- }
-
- m := map[string]string{
- "title": "Example2",
- "author": "Steve",
- "body": "Map",
- }
-
- if _, err := c.Do("HMSET", redis.Args{}.Add("id2").AddFlat(m)...); err != nil {
- panic(err)
- }
-
- for _, id := range []string{"id1", "id2"} {
-
- v, err := redis.Values(c.Do("HGETALL", id))
- if err != nil {
- panic(err)
- }
-
- if err := redis.ScanStruct(v, &p2); err != nil {
- panic(err)
- }
-
- fmt.Printf("%+v\n", p2)
- }
-
- // Output:
- // {Title:Example Author:Gary Body:Hello}
- // {Title:Example2 Author:Steve Body:Map}
-}
diff --git a/vendor/github.com/garyburd/redigo/redis/script_test.go b/vendor/github.com/garyburd/redigo/redis/script_test.go
deleted file mode 100644
index c9635bf0..00000000
--- a/vendor/github.com/garyburd/redigo/redis/script_test.go
+++ /dev/null
@@ -1,93 +0,0 @@
-// Copyright 2012 Gary Burd
-//
-// Licensed under the Apache License, Version 2.0 (the "License"): you may
-// not use this file except in compliance with the License. You may obtain
-// a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-// License for the specific language governing permissions and limitations
-// under the License.
-
-package redis_test
-
-import (
- "fmt"
- "reflect"
- "testing"
- "time"
-
- "github.com/garyburd/redigo/internal/redistest"
- "github.com/garyburd/redigo/redis"
-)
-
-func ExampleScript(c redis.Conn, reply interface{}, err error) {
- // Initialize a package-level variable with a script.
- var getScript = redis.NewScript(1, `return redis.call('get', KEYS[1])`)
-
- // In a function, use the script Do method to evaluate the script. The Do
- // method optimistically uses the EVALSHA command. If the script is not
- // loaded, then the Do method falls back to the EVAL command.
- reply, err = getScript.Do(c, "foo")
-}
-
-func TestScript(t *testing.T) {
- c, err := redistest.Dial()
- if err != nil {
- t.Fatalf("error connection to database, %v", err)
- }
- defer c.Close()
-
- // To test fall back in Do, we make script unique by adding comment with current time.
- script := fmt.Sprintf("--%d\nreturn {KEYS[1],KEYS[2],ARGV[1],ARGV[2]}", time.Now().UnixNano())
- s := redis.NewScript(2, script)
- reply := []interface{}{[]byte("key1"), []byte("key2"), []byte("arg1"), []byte("arg2")}
-
- v, err := s.Do(c, "key1", "key2", "arg1", "arg2")
- if err != nil {
- t.Errorf("s.Do(c, ...) returned %v", err)
- }
-
- if !reflect.DeepEqual(v, reply) {
- t.Errorf("s.Do(c, ..); = %v, want %v", v, reply)
- }
-
- err = s.Load(c)
- if err != nil {
- t.Errorf("s.Load(c) returned %v", err)
- }
-
- err = s.SendHash(c, "key1", "key2", "arg1", "arg2")
- if err != nil {
- t.Errorf("s.SendHash(c, ...) returned %v", err)
- }
-
- err = c.Flush()
- if err != nil {
- t.Errorf("c.Flush() returned %v", err)
- }
-
- v, err = c.Receive()
- if !reflect.DeepEqual(v, reply) {
- t.Errorf("s.SendHash(c, ..); c.Receive() = %v, want %v", v, reply)
- }
-
- err = s.Send(c, "key1", "key2", "arg1", "arg2")
- if err != nil {
- t.Errorf("s.Send(c, ...) returned %v", err)
- }
-
- err = c.Flush()
- if err != nil {
- t.Errorf("c.Flush() returned %v", err)
- }
-
- v, err = c.Receive()
- if !reflect.DeepEqual(v, reply) {
- t.Errorf("s.Send(c, ..); c.Receive() = %v, want %v", v, reply)
- }
-
-}
diff --git a/vendor/github.com/garyburd/redigo/redis/test_test.go b/vendor/github.com/garyburd/redigo/redis/test_test.go
deleted file mode 100644
index b959a11f..00000000
--- a/vendor/github.com/garyburd/redigo/redis/test_test.go
+++ /dev/null
@@ -1,38 +0,0 @@
-// Copyright 2012 Gary Burd
-//
-// Licensed under the Apache License, Version 2.0 (the "License"): you may
-// not use this file except in compliance with the License. You may obtain
-// a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-// License for the specific language governing permissions and limitations
-// under the License.
-
-package redis
-
-import (
- "bufio"
- "net"
- "time"
-)
-
-func SetNowFunc(f func() time.Time) {
- nowFunc = f
-}
-
-type nopCloser struct{ net.Conn }
-
-func (nopCloser) Close() error { return nil }
-
-// NewConnBufio is a hook for tests.
-func NewConnBufio(rw bufio.ReadWriter) Conn {
- return &conn{br: rw.Reader, bw: rw.Writer, conn: nopCloser{}}
-}
-
-var (
- ErrNegativeInt = errNegativeInt
-)
diff --git a/vendor/github.com/garyburd/redigo/redis/zpop_example_test.go b/vendor/github.com/garyburd/redigo/redis/zpop_example_test.go
deleted file mode 100644
index 1d86ee6c..00000000
--- a/vendor/github.com/garyburd/redigo/redis/zpop_example_test.go
+++ /dev/null
@@ -1,113 +0,0 @@
-// Copyright 2013 Gary Burd
-//
-// Licensed under the Apache License, Version 2.0 (the "License"): you may
-// not use this file except in compliance with the License. You may obtain
-// a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-// License for the specific language governing permissions and limitations
-// under the License.
-
-package redis_test
-
-import (
- "fmt"
- "github.com/garyburd/redigo/redis"
-)
-
-// zpop pops a value from the ZSET key using WATCH/MULTI/EXEC commands.
-func zpop(c redis.Conn, key string) (result string, err error) {
-
- defer func() {
- // Return connection to normal state on error.
- if err != nil {
- c.Do("DISCARD")
- }
- }()
-
- // Loop until transaction is successful.
- for {
- if _, err := c.Do("WATCH", key); err != nil {
- return "", err
- }
-
- members, err := redis.Strings(c.Do("ZRANGE", key, 0, 0))
- if err != nil {
- return "", err
- }
- if len(members) != 1 {
- return "", redis.ErrNil
- }
-
- c.Send("MULTI")
- c.Send("ZREM", key, members[0])
- queued, err := c.Do("EXEC")
- if err != nil {
- return "", err
- }
-
- if queued != nil {
- result = members[0]
- break
- }
- }
-
- return result, nil
-}
-
-// zpopScript pops a value from a ZSET.
-var zpopScript = redis.NewScript(1, `
- local r = redis.call('ZRANGE', KEYS[1], 0, 0)
- if r ~= nil then
- r = r[1]
- redis.call('ZREM', KEYS[1], r)
- end
- return r
-`)
-
-// This example implements ZPOP as described at
-// http://redis.io/topics/transactions using WATCH/MULTI/EXEC and scripting.
-func Example_zpop() {
- c, err := dial()
- if err != nil {
- fmt.Println(err)
- return
- }
- defer c.Close()
-
- // Add test data using a pipeline.
-
- for i, member := range []string{"red", "blue", "green"} {
- c.Send("ZADD", "zset", i, member)
- }
- if _, err := c.Do(""); err != nil {
- fmt.Println(err)
- return
- }
-
- // Pop using WATCH/MULTI/EXEC
-
- v, err := zpop(c, "zset")
- if err != nil {
- fmt.Println(err)
- return
- }
- fmt.Println(v)
-
- // Pop using a script.
-
- v, err = redis.String(zpopScript.Do(c, "zset"))
- if err != nil {
- fmt.Println(err)
- return
- }
- fmt.Println(v)
-
- // Output:
- // red
- // blue
-}
diff --git a/vendor/github.com/golang/protobuf/.gitignore b/vendor/github.com/golang/protobuf/.gitignore
deleted file mode 100644
index 0bf694c9..00000000
--- a/vendor/github.com/golang/protobuf/.gitignore
+++ /dev/null
@@ -1,17 +0,0 @@
-.DS_Store
-*.[568ao]
-*.pb.go
-*.ao
-*.so
-*.pyc
-._*
-.nfs.*
-[568a].out
-*~
-*.orig
-core
-_obj
-_test
-_testmain.go
-compiler/protoc-gen-go
-compiler/testdata/extension_test
diff --git a/vendor/github.com/golang/protobuf/AUTHORS b/vendor/github.com/golang/protobuf/AUTHORS
deleted file mode 100644
index 15167cd7..00000000
--- a/vendor/github.com/golang/protobuf/AUTHORS
+++ /dev/null
@@ -1,3 +0,0 @@
-# This source code refers to The Go Authors for copyright purposes.
-# The master list of authors is in the main Go distribution,
-# visible at http://tip.golang.org/AUTHORS.
diff --git a/vendor/github.com/golang/protobuf/CONTRIBUTORS b/vendor/github.com/golang/protobuf/CONTRIBUTORS
deleted file mode 100644
index 1c4577e9..00000000
--- a/vendor/github.com/golang/protobuf/CONTRIBUTORS
+++ /dev/null
@@ -1,3 +0,0 @@
-# This source code was written by the Go contributors.
-# The master list of contributors is in the main Go distribution,
-# visible at http://tip.golang.org/CONTRIBUTORS.
diff --git a/vendor/github.com/golang/protobuf/Make.protobuf b/vendor/github.com/golang/protobuf/Make.protobuf
deleted file mode 100644
index 15071de1..00000000
--- a/vendor/github.com/golang/protobuf/Make.protobuf
+++ /dev/null
@@ -1,40 +0,0 @@
-# Go support for Protocol Buffers - Google's data interchange format
-#
-# Copyright 2010 The Go Authors. All rights reserved.
-# https://github.com/golang/protobuf
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are
-# met:
-#
-# * Redistributions of source code must retain the above copyright
-# notice, this list of conditions and the following disclaimer.
-# * Redistributions in binary form must reproduce the above
-# copyright notice, this list of conditions and the following disclaimer
-# in the documentation and/or other materials provided with the
-# distribution.
-# * Neither the name of Google Inc. nor the names of its
-# contributors may be used to endorse or promote products derived from
-# this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-# Includable Makefile to add a rule for generating .pb.go files from .proto files
-# (Google protocol buffer descriptions).
-# Typical use if myproto.proto is a file in package mypackage in this directory:
-#
-# include $(GOROOT)/src/pkg/github.com/golang/protobuf/Make.protobuf
-
-%.pb.go: %.proto
- protoc --go_out=. $<
-
diff --git a/vendor/github.com/golang/protobuf/Makefile b/vendor/github.com/golang/protobuf/Makefile
deleted file mode 100644
index 43b94999..00000000
--- a/vendor/github.com/golang/protobuf/Makefile
+++ /dev/null
@@ -1,55 +0,0 @@
-# Go support for Protocol Buffers - Google's data interchange format
-#
-# Copyright 2010 The Go Authors. All rights reserved.
-# https://github.com/golang/protobuf
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are
-# met:
-#
-# * Redistributions of source code must retain the above copyright
-# notice, this list of conditions and the following disclaimer.
-# * Redistributions in binary form must reproduce the above
-# copyright notice, this list of conditions and the following disclaimer
-# in the documentation and/or other materials provided with the
-# distribution.
-# * Neither the name of Google Inc. nor the names of its
-# contributors may be used to endorse or promote products derived from
-# this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-
-all: install
-
-install:
- go install ./proto
- go install ./jsonpb
- go install ./protoc-gen-go
-
-test:
- go test ./proto
- go test ./jsonpb
- make -C protoc-gen-go/testdata test
-
-clean:
- go clean ./...
-
-nuke:
- go clean -i ./...
-
-regenerate:
- make -C protoc-gen-go/descriptor regenerate
- make -C protoc-gen-go/plugin regenerate
- make -C proto/testdata regenerate
- make -C jsonpb/jsonpb_test_proto regenerate
diff --git a/vendor/github.com/golang/protobuf/README b/vendor/github.com/golang/protobuf/README
deleted file mode 100644
index 6579bd08..00000000
--- a/vendor/github.com/golang/protobuf/README
+++ /dev/null
@@ -1,158 +0,0 @@
-Go support for Protocol Buffers - Google's data interchange format
-Copyright 2010 The Go Authors.
-https://github.com/golang/protobuf
-
-This package and the code it generates requires at least Go 1.2.
-
-This software implements Go bindings for protocol buffers. For
-information about protocol buffers themselves, see
- https://developers.google.com/protocol-buffers/
-To use this software, you must first install the standard C++
-implementation of protocol buffers from
- https://developers.google.com/protocol-buffers/
-And of course you must also install the Go compiler and tools from
- https://golang.org/
-See
- https://golang.org/doc/install
-for details or, if you are using gccgo, follow the instructions at
- https://golang.org/doc/install/gccgo
-
-This software has two parts: a 'protocol compiler plugin' that
-generates Go source files that, once compiled, can access and manage
-protocol buffers; and a library that implements run-time support for
-encoding (marshaling), decoding (unmarshaling), and accessing protocol
-buffers.
-
-There is support for gRPC in Go using protocol buffers.
-See the note at the bottom of this file for details.
-
-There are no insertion points in the plugin.
-
-To install this code:
-
-The simplest way is to run go get.
-
- # Grab the code from the repository and install the proto package.
- go get -u github.com/golang/protobuf/{proto,protoc-gen-go}
-
-The compiler plugin, protoc-gen-go, will be installed in $GOBIN,
-defaulting to $GOPATH/bin. It must be in your $PATH for the protocol
-compiler, protoc, to find it.
-
-Once the software is installed, there are two steps to using it.
-First you must compile the protocol buffer definitions and then import
-them, with the support library, into your program.
-
-To compile the protocol buffer definition, run protoc with the --go_out
-parameter set to the directory you want to output the Go code to.
-
- protoc --go_out=. *.proto
-
-The generated files will be suffixed .pb.go. See the Test code below
-for an example using such a file.
-
-
-The package comment for the proto library contains text describing
-the interface provided in Go for protocol buffers. Here is an edited
-version.
-
-==========
-
-The proto package converts data structures to and from the
-wire format of protocol buffers. It works in concert with the
-Go source code generated for .proto files by the protocol compiler.
-
-A summary of the properties of the protocol buffer interface
-for a protocol buffer variable v:
-
- - Names are turned from camel_case to CamelCase for export.
- - There are no methods on v to set fields; just treat
- them as structure fields.
- - There are getters that return a field's value if set,
- and return the field's default value if unset.
- The getters work even if the receiver is a nil message.
- - The zero value for a struct is its correct initialization state.
- All desired fields must be set before marshaling.
- - A Reset() method will restore a protobuf struct to its zero state.
- - Non-repeated fields are pointers to the values; nil means unset.
- That is, optional or required field int32 f becomes F *int32.
- - Repeated fields are slices.
- - Helper functions are available to aid the setting of fields.
- Helpers for getting values are superseded by the
- GetFoo methods and their use is deprecated.
- msg.Foo = proto.String("hello") // set field
- - Constants are defined to hold the default values of all fields that
- have them. They have the form Default_StructName_FieldName.
- Because the getter methods handle defaulted values,
- direct use of these constants should be rare.
- - Enums are given type names and maps from names to values.
- Enum values are prefixed with the enum's type name. Enum types have
- a String method, and a Enum method to assist in message construction.
- - Nested groups and enums have type names prefixed with the name of
- the surrounding message type.
- - Extensions are given descriptor names that start with E_,
- followed by an underscore-delimited list of the nested messages
- that contain it (if any) followed by the CamelCased name of the
- extension field itself. HasExtension, ClearExtension, GetExtension
- and SetExtension are functions for manipulating extensions.
- - Marshal and Unmarshal are functions to encode and decode the wire format.
-
-Consider file test.proto, containing
-
- package example;
-
- enum FOO { X = 17; };
-
- message Test {
- required string label = 1;
- optional int32 type = 2 [default=77];
- repeated int64 reps = 3;
- optional group OptionalGroup = 4 {
- required string RequiredField = 5;
- }
- }
-
-To create and play with a Test object from the example package,
-
- package main
-
- import (
- "log"
-
- "github.com/golang/protobuf/proto"
- "path/to/example"
- )
-
- func main() {
- test := &example.Test {
- Label: proto.String("hello"),
- Type: proto.Int32(17),
- Optionalgroup: &example.Test_OptionalGroup {
- RequiredField: proto.String("good bye"),
- },
- }
- data, err := proto.Marshal(test)
- if err != nil {
- log.Fatal("marshaling error: ", err)
- }
- newTest := &example.Test{}
- err = proto.Unmarshal(data, newTest)
- if err != nil {
- log.Fatal("unmarshaling error: ", err)
- }
- // Now test and newTest contain the same data.
- if test.GetLabel() != newTest.GetLabel() {
- log.Fatalf("data mismatch %q != %q", test.GetLabel(), newTest.GetLabel())
- }
- // etc.
- }
-
-
-gRPC Support
-============
-If a proto file specifies RPC services, protoc-gen-go can be instructed to
-generate code compatible with gRPC (http://www.grpc.io/). To do this, pass
-the `plugins` parameter to protoc-gen-go; the usual way is to insert it into
-the --go_out argument to protoc:
-
- protoc --go_out=plugins=grpc:. *.proto
diff --git a/vendor/github.com/golang/protobuf/jsonpb/jsonpb.go b/vendor/github.com/golang/protobuf/jsonpb/jsonpb.go
deleted file mode 100644
index f3e53d4a..00000000
--- a/vendor/github.com/golang/protobuf/jsonpb/jsonpb.go
+++ /dev/null
@@ -1,429 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2015 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-/*
-Package jsonpb provides marshalling/unmarshalling functionality between
-protocol buffer and JSON objects.
-
-Compared to encoding/json, this library:
- - encodes int64, uint64 as strings
- - optionally encodes enums as strings
-*/
-package jsonpb
-
-import (
- "bytes"
- "encoding/json"
- "fmt"
- "io"
- "reflect"
- "sort"
- "strconv"
- "strings"
-
- "github.com/golang/protobuf/proto"
-)
-
-var (
- byteArrayType = reflect.TypeOf([]byte{})
-)
-
-// Marshaller is a configurable object for converting between
-// protocol buffer objects and a JSON representation for them
-type Marshaller struct {
- // Use string values for enums (as opposed to integer values)
- EnumsAsString bool
-
- // A string to indent each level by. The presence of this field will
- // also cause a space to appear between the field separator and
- // value, and for newlines to be appear between fields and array
- // elements.
- Indent string
-}
-
-// Marshal marshals a protocol buffer into JSON.
-func (m *Marshaller) Marshal(out io.Writer, pb proto.Message) error {
- writer := &errWriter{writer: out}
- return m.marshalObject(writer, pb, "")
-}
-
-// MarshalToString converts a protocol buffer object to JSON string.
-func (m *Marshaller) MarshalToString(pb proto.Message) (string, error) {
- var buf bytes.Buffer
- if err := m.Marshal(&buf, pb); err != nil {
- return "", err
- }
- return buf.String(), nil
-}
-
-// marshalObject writes a struct to the Writer.
-func (m *Marshaller) marshalObject(out *errWriter, v proto.Message, indent string) error {
- out.write("{")
- if m.Indent != "" {
- out.write("\n")
- }
-
- s := reflect.ValueOf(v).Elem()
- writeBeforeField := ""
- for i := 0; i < s.NumField(); i++ {
- value := s.Field(i)
- valueField := s.Type().Field(i)
- fieldName, omitFieldIfNil := parseFieldOptions(valueField)
-
- // Fields which should not be serialized will specify a json tag with '-'
- // TODO: proto3 objects should have default values omitted.
- if fieldName == "-" {
- continue
- } else if omitFieldIfNil {
- // IsNil will panic on most value kinds.
- skip := false
- switch value.Kind() {
- case reflect.Chan, reflect.Func, reflect.Interface, reflect.Map, reflect.Ptr, reflect.Slice:
- skip = value.IsNil()
- }
- if skip {
- continue
- }
- }
-
- out.write(writeBeforeField)
- if m.Indent != "" {
- out.write(indent)
- out.write(m.Indent)
- }
- out.write(`"`)
- out.write(fieldName)
- out.write(`":`)
- if m.Indent != "" {
- out.write(" ")
- }
-
- if err := m.marshalValue(out, value, valueField, indent); err != nil {
- return err
- }
-
- if m.Indent != "" {
- writeBeforeField = ",\n"
- } else {
- writeBeforeField = ","
- }
- }
-
- if m.Indent != "" {
- out.write("\n")
- out.write(indent)
- }
- out.write("}")
- return out.err
-}
-
-// marshalValue writes the value to the Writer.
-func (m *Marshaller) marshalValue(out *errWriter, v reflect.Value,
- structField reflect.StructField, indent string) error {
-
- var err error
- v = reflect.Indirect(v)
-
- // Handle repeated elements.
- if v.Type() != byteArrayType && v.Kind() == reflect.Slice {
- out.write("[")
- comma := ""
- for i := 0; i < v.Len(); i++ {
- sliceVal := v.Index(i)
- out.write(comma)
- if m.Indent != "" {
- out.write("\n")
- out.write(indent)
- out.write(m.Indent)
- out.write(m.Indent)
- }
- m.marshalValue(out, sliceVal, structField, indent+m.Indent)
- comma = ","
- }
- if m.Indent != "" {
- out.write("\n")
- out.write(indent)
- out.write(m.Indent)
- }
- out.write("]")
- return out.err
- }
-
- // Handle enumerations.
- protoInfo := structField.Tag.Get("protobuf")
- if m.EnumsAsString && strings.Contains(protoInfo, ",enum=") {
- // Unknown enum values will are stringified by the proto library as their
- // value. Such values should _not_ be quoted or they will be intrepreted
- // as an enum string instead of their value.
- enumStr := v.Interface().(fmt.Stringer).String()
- var valStr string
- if v.Kind() == reflect.Ptr {
- valStr = strconv.Itoa(int(v.Elem().Int()))
- } else {
- valStr = strconv.Itoa(int(v.Int()))
- }
- isKnownEnum := enumStr != valStr
- if isKnownEnum {
- out.write(`"`)
- }
- out.write(enumStr)
- if isKnownEnum {
- out.write(`"`)
- }
- return out.err
- }
-
- // Handle nested messages.
- if v.Kind() == reflect.Struct {
- return m.marshalObject(out, v.Addr().Interface().(proto.Message), indent+m.Indent)
- }
-
- // Handle maps.
- // NOTE: Since Go randomizes map iteration, we sort keys for stable output.
- if v.Kind() == reflect.Map {
- out.write(`{`)
- keys := v.MapKeys()
- sort.Sort(mapKeys(keys))
- for i, k := range keys {
- if i > 0 {
- out.write(`,`)
- }
- if m.Indent != "" {
- out.write("\n")
- out.write(indent)
- out.write(m.Indent)
- out.write(m.Indent)
- }
-
- b, err := json.Marshal(k.Interface())
- if err != nil {
- return err
- }
- s := string(b)
-
- // If the JSON is not a string value, encode it again to make it one.
- if !strings.HasPrefix(s, `"`) {
- b, err := json.Marshal(s)
- if err != nil {
- return err
- }
- s = string(b)
- }
-
- out.write(s)
- out.write(`:`)
- if m.Indent != "" {
- out.write(` `)
- }
-
- if err := m.marshalValue(out, v.MapIndex(k), structField, indent+m.Indent); err != nil {
- return err
- }
- }
- if m.Indent != "" {
- out.write("\n")
- out.write(indent)
- out.write(m.Indent)
- }
- out.write(`}`)
- return out.err
- }
-
- // Default handling defers to the encoding/json library.
- b, err := json.Marshal(v.Interface())
- if err != nil {
- return err
- }
- needToQuote := string(b[0]) != `"` && (v.Kind() == reflect.Int64 || v.Kind() == reflect.Uint64)
- if needToQuote {
- out.write(`"`)
- }
- out.write(string(b))
- if needToQuote {
- out.write(`"`)
- }
- return out.err
-}
-
-// Unmarshal unmarshals a JSON object stream into a protocol
-// buffer. This function is lenient and will decode any options
-// permutations of the related Marshaller.
-func Unmarshal(r io.Reader, pb proto.Message) error {
- inputValue := json.RawMessage{}
- if err := json.NewDecoder(r).Decode(&inputValue); err != nil {
- return err
- }
- return unmarshalValue(reflect.ValueOf(pb).Elem(), inputValue)
-}
-
-// UnmarshalString will populate the fields of a protocol buffer based
-// on a JSON string. This function is lenient and will decode any options
-// permutations of the related Marshaller.
-func UnmarshalString(str string, pb proto.Message) error {
- return Unmarshal(bytes.NewReader([]byte(str)), pb)
-}
-
-// unmarshalValue converts/copies a value into the target.
-func unmarshalValue(target reflect.Value, inputValue json.RawMessage) error {
- targetType := target.Type()
-
- // Allocate memory for pointer fields.
- if targetType.Kind() == reflect.Ptr {
- target.Set(reflect.New(targetType.Elem()))
- return unmarshalValue(target.Elem(), inputValue)
- }
-
- // Handle nested messages.
- if targetType.Kind() == reflect.Struct {
- var jsonFields map[string]json.RawMessage
- if err := json.Unmarshal(inputValue, &jsonFields); err != nil {
- return err
- }
-
- for i := 0; i < target.NumField(); i++ {
- fieldName, _ := parseFieldOptions(target.Type().Field(i))
-
- // Fields which should not be serialized will specify a json tag with '-'
- if fieldName == "-" {
- continue
- }
-
- if valueForField, ok := jsonFields[fieldName]; ok {
- if err := unmarshalValue(target.Field(i), valueForField); err != nil {
- return err
- }
- }
- }
- return nil
- }
-
- // Handle arrays (which aren't encoded bytes)
- if targetType != byteArrayType && targetType.Kind() == reflect.Slice {
- var slc []json.RawMessage
- if err := json.Unmarshal(inputValue, &slc); err != nil {
- return err
- }
- len := len(slc)
- target.Set(reflect.MakeSlice(targetType, len, len))
- for i := 0; i < len; i++ {
- if err := unmarshalValue(target.Index(i), slc[i]); err != nil {
- return err
- }
- }
- return nil
- }
-
- // Handle maps (whose keys are always strings)
- if targetType.Kind() == reflect.Map {
- var mp map[string]json.RawMessage
- if err := json.Unmarshal(inputValue, &mp); err != nil {
- return err
- }
- target.Set(reflect.MakeMap(targetType))
- for ks, raw := range mp {
- // Unmarshal map key. The core json library already decoded the key into a
- // string, so we handle that specially. Other types were quoted post-serialization.
- var k reflect.Value
- if targetType.Key().Kind() == reflect.String {
- k = reflect.ValueOf(ks)
- } else {
- k = reflect.New(targetType.Key()).Elem()
- if err := unmarshalValue(k, json.RawMessage(ks)); err != nil {
- return err
- }
- }
-
- // Unmarshal map value.
- v := reflect.New(targetType.Elem()).Elem()
- if err := unmarshalValue(v, raw); err != nil {
- return err
- }
- target.SetMapIndex(k, v)
- }
- return nil
- }
-
- // 64-bit integers can be encoded as strings. In this case we drop
- // the quotes and proceed as normal.
- isNum := targetType.Kind() == reflect.Int64 || targetType.Kind() == reflect.Uint64
- if isNum && strings.HasPrefix(string(inputValue), `"`) {
- inputValue = inputValue[1 : len(inputValue)-1]
- }
-
- // Use the encoding/json for parsing other value types.
- return json.Unmarshal(inputValue, target.Addr().Interface())
-}
-
-// hasUnmarshalJSON is a interface implemented by protocol buffer enums.
-type hasUnmarshalJSON interface {
- UnmarshalJSON(data []byte) error
-}
-
-// parseFieldOptions returns the field name and if it should be omited.
-func parseFieldOptions(f reflect.StructField) (string, bool) {
- name := f.Name
- omitEmpty := false
- tag := f.Tag.Get("json")
- tagParts := strings.Split(tag, ",")
- for i := range tagParts {
- if tagParts[i] == "omitempty" || tagParts[i] == "" {
- omitEmpty = true
- } else {
- name = tagParts[i]
- }
- }
- return name, omitEmpty
-}
-
-// Writer wrapper inspired by https://blog.golang.org/errors-are-values
-type errWriter struct {
- writer io.Writer
- err error
-}
-
-func (w *errWriter) write(str string) {
- if w.err != nil {
- return
- }
- _, w.err = w.writer.Write([]byte(str))
-}
-
-// Map fields may have key types of non-float scalars, strings and enums.
-// The easiest way to sort them in some deterministic order is to use fmt.
-// If this turns out to be inefficient we can always consider other options,
-// such as doing a Schwartzian transform.
-type mapKeys []reflect.Value
-
-func (s mapKeys) Len() int { return len(s) }
-func (s mapKeys) Swap(i, j int) { s[i], s[j] = s[j], s[i] }
-func (s mapKeys) Less(i, j int) bool {
- return fmt.Sprint(s[i].Interface()) < fmt.Sprint(s[j].Interface())
-}
diff --git a/vendor/github.com/golang/protobuf/jsonpb/jsonpb_test.go b/vendor/github.com/golang/protobuf/jsonpb/jsonpb_test.go
deleted file mode 100644
index fe8cd3f6..00000000
--- a/vendor/github.com/golang/protobuf/jsonpb/jsonpb_test.go
+++ /dev/null
@@ -1,367 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2015 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-package jsonpb
-
-import (
- "testing"
-
- pb "github.com/golang/protobuf/jsonpb/jsonpb_test_proto"
- "github.com/golang/protobuf/proto"
-)
-
-var (
- marshaller = Marshaller{}
-
- marshallerAllOptions = Marshaller{
- EnumsAsString: true,
- Indent: " ",
- }
-
- simpleObject = &pb.Simple{
- OInt32: proto.Int32(-32),
- OInt64: proto.Int64(-6400000000),
- OUint32: proto.Uint32(32),
- OUint64: proto.Uint64(6400000000),
- OSint32: proto.Int32(-13),
- OSint64: proto.Int64(-2600000000),
- OFloat: proto.Float32(3.14),
- ODouble: proto.Float64(6.02214179e23),
- OBool: proto.Bool(true),
- OString: proto.String("hello \"there\""),
- OBytes: []byte("beep boop"),
- }
-
- simpleObjectJSON = `{` +
- `"o_bool":true,` +
- `"o_int32":-32,` +
- `"o_int64":"-6400000000",` +
- `"o_uint32":32,` +
- `"o_uint64":"6400000000",` +
- `"o_sint32":-13,` +
- `"o_sint64":"-2600000000",` +
- `"o_float":3.14,` +
- `"o_double":6.02214179e+23,` +
- `"o_string":"hello \"there\"",` +
- `"o_bytes":"YmVlcCBib29w"` +
- `}`
-
- simpleObjectPrettyJSON = `{
- "o_bool": true,
- "o_int32": -32,
- "o_int64": "-6400000000",
- "o_uint32": 32,
- "o_uint64": "6400000000",
- "o_sint32": -13,
- "o_sint64": "-2600000000",
- "o_float": 3.14,
- "o_double": 6.02214179e+23,
- "o_string": "hello \"there\"",
- "o_bytes": "YmVlcCBib29w"
-}`
-
- repeatsObject = &pb.Repeats{
- RBool: []bool{true, false, true},
- RInt32: []int32{-3, -4, -5},
- RInt64: []int64{-123456789, -987654321},
- RUint32: []uint32{1, 2, 3},
- RUint64: []uint64{6789012345, 3456789012},
- RSint32: []int32{-1, -2, -3},
- RSint64: []int64{-6789012345, -3456789012},
- RFloat: []float32{3.14, 6.28},
- RDouble: []float64{299792458, 6.62606957e-34},
- RString: []string{"happy", "days"},
- RBytes: [][]byte{[]byte("skittles"), []byte("m&m's")},
- }
-
- repeatsObjectJSON = `{` +
- `"r_bool":[true,false,true],` +
- `"r_int32":[-3,-4,-5],` +
- `"r_int64":["-123456789","-987654321"],` +
- `"r_uint32":[1,2,3],` +
- `"r_uint64":["6789012345","3456789012"],` +
- `"r_sint32":[-1,-2,-3],` +
- `"r_sint64":["-6789012345","-3456789012"],` +
- `"r_float":[3.14,6.28],` +
- `"r_double":[2.99792458e+08,6.62606957e-34],` +
- `"r_string":["happy","days"],` +
- `"r_bytes":["c2tpdHRsZXM=","bSZtJ3M="]` +
- `}`
-
- repeatsObjectPrettyJSON = `{
- "r_bool": [
- true,
- false,
- true
- ],
- "r_int32": [
- -3,
- -4,
- -5
- ],
- "r_int64": [
- "-123456789",
- "-987654321"
- ],
- "r_uint32": [
- 1,
- 2,
- 3
- ],
- "r_uint64": [
- "6789012345",
- "3456789012"
- ],
- "r_sint32": [
- -1,
- -2,
- -3
- ],
- "r_sint64": [
- "-6789012345",
- "-3456789012"
- ],
- "r_float": [
- 3.14,
- 6.28
- ],
- "r_double": [
- 2.99792458e+08,
- 6.62606957e-34
- ],
- "r_string": [
- "happy",
- "days"
- ],
- "r_bytes": [
- "c2tpdHRsZXM=",
- "bSZtJ3M="
- ]
-}`
-
- innerSimple = &pb.Simple{OInt32: proto.Int32(-32)}
- innerSimple2 = &pb.Simple{OInt64: proto.Int64(25)}
- innerRepeats = &pb.Repeats{RString: []string{"roses", "red"}}
- innerRepeats2 = &pb.Repeats{RString: []string{"violets", "blue"}}
- complexObject = &pb.Widget{
- Color: pb.Widget_GREEN.Enum(),
- RColor: []pb.Widget_Color{pb.Widget_RED, pb.Widget_GREEN, pb.Widget_BLUE},
- Simple: innerSimple,
- RSimple: []*pb.Simple{innerSimple, innerSimple2},
- Repeats: innerRepeats,
- RRepeats: []*pb.Repeats{innerRepeats, innerRepeats2},
- }
-
- complexObjectJSON = `{"color":1,` +
- `"r_color":[0,1,2],` +
- `"simple":{"o_int32":-32},` +
- `"r_simple":[{"o_int32":-32},{"o_int64":"25"}],` +
- `"repeats":{"r_string":["roses","red"]},` +
- `"r_repeats":[{"r_string":["roses","red"]},{"r_string":["violets","blue"]}]` +
- `}`
-
- complexObjectPrettyJSON = `{
- "color": "GREEN",
- "r_color": [
- "RED",
- "GREEN",
- "BLUE"
- ],
- "simple": {
- "o_int32": -32
- },
- "r_simple": [
- {
- "o_int32": -32
- },
- {
- "o_int64": "25"
- }
- ],
- "repeats": {
- "r_string": [
- "roses",
- "red"
- ]
- },
- "r_repeats": [
- {
- "r_string": [
- "roses",
- "red"
- ]
- },
- {
- "r_string": [
- "violets",
- "blue"
- ]
- }
- ]
-}`
-
- colorPrettyJSON = `{
- "color": 2
-}`
-
- colorListPrettyJSON = `{
- "color": 1000,
- "r_color": [
- "RED"
- ]
-}`
-
- nummyPrettyJSON = `{
- "nummy": {
- "1": 2,
- "3": 4
- }
-}`
-
- objjyPrettyJSON = `{
- "objjy": {
- "1": {
- "dub": 1
- }
- }
-}`
-)
-
-var marshallingTests = []struct {
- desc string
- marshaller Marshaller
- pb proto.Message
- json string
-}{
- {"simple flat object", marshaller, simpleObject, simpleObjectJSON},
- {"simple pretty object", marshallerAllOptions, simpleObject, simpleObjectPrettyJSON},
- {"repeated fields flat object", marshaller, repeatsObject, repeatsObjectJSON},
- {"repeated fields pretty object", marshallerAllOptions, repeatsObject, repeatsObjectPrettyJSON},
- {"nested message/enum flat object", marshaller, complexObject, complexObjectJSON},
- {"nested message/enum pretty object", marshallerAllOptions, complexObject, complexObjectPrettyJSON},
- {"enum-string flat object", Marshaller{EnumsAsString: true},
- &pb.Widget{Color: pb.Widget_BLUE.Enum()}, `{"color":"BLUE"}`},
- {"enum-value pretty object", Marshaller{Indent: " "},
- &pb.Widget{Color: pb.Widget_BLUE.Enum()}, colorPrettyJSON},
- {"unknown enum value object", marshallerAllOptions,
- &pb.Widget{Color: pb.Widget_Color(1000).Enum(), RColor: []pb.Widget_Color{pb.Widget_RED}}, colorListPrettyJSON},
- {"proto3 object with empty value", marshaller, &pb.Simple3{}, `{"dub":0}`},
- {"map", marshaller, &pb.Mappy{Nummy: map[int64]int32{1: 2, 3: 4}}, `{"nummy":{"1":2,"3":4}}`},
- {"map", marshallerAllOptions, &pb.Mappy{Nummy: map[int64]int32{1: 2, 3: 4}}, nummyPrettyJSON},
- {"map", marshaller,
- &pb.Mappy{Strry: map[string]string{`"one"`: "two", "three": "four"}},
- `{"strry":{"\"one\"":"two","three":"four"}}`},
- {"map", marshaller,
- &pb.Mappy{Objjy: map[int32]*pb.Simple3{1: &pb.Simple3{Dub: 1}}}, `{"objjy":{"1":{"dub":1}}}`},
- {"map", marshallerAllOptions,
- &pb.Mappy{Objjy: map[int32]*pb.Simple3{1: &pb.Simple3{Dub: 1}}}, objjyPrettyJSON},
- {"map", marshaller, &pb.Mappy{Buggy: map[int64]string{1234: "yup"}},
- `{"buggy":{"1234":"yup"}}`},
- {"map", marshaller, &pb.Mappy{Booly: map[bool]bool{false: true}}, `{"booly":{"false":true}}`},
- {"proto2 map", marshaller, &pb.Maps{MInt64Str: map[int64]string{213: "cat"}},
- `{"m_int64_str":{"213":"cat"}}`},
- {"proto2 map", marshaller,
- &pb.Maps{MBoolSimple: map[bool]*pb.Simple{true: &pb.Simple{OInt32: proto.Int32(1)}}},
- `{"m_bool_simple":{"true":{"o_int32":1}}}`},
-}
-
-func TestMarshalling(t *testing.T) {
- for _, tt := range marshallingTests {
- json, err := tt.marshaller.MarshalToString(tt.pb)
- if err != nil {
- t.Errorf("%s: marshalling error: %v", tt.desc, err)
- } else if tt.json != json {
- t.Errorf("%s: got [%v] want [%v]", tt.desc, json, tt.json)
- }
- }
-}
-
-var unmarshallingTests = []struct {
- desc string
- json string
- pb proto.Message
-}{
- {"simple flat object", simpleObjectJSON, simpleObject},
- {"simple pretty object", simpleObjectPrettyJSON, simpleObject},
- {"repeated fields flat object", repeatsObjectJSON, repeatsObject},
- {"repeated fields pretty object", repeatsObjectPrettyJSON, repeatsObject},
- {"nested message/enum flat object", complexObjectJSON, complexObject},
- {"nested message/enum pretty object", complexObjectPrettyJSON, complexObject},
- {"enum-string object", `{"color":"BLUE"}`, &pb.Widget{Color: pb.Widget_BLUE.Enum()}},
- {"enum-value object", "{\n \"color\": 2\n}", &pb.Widget{Color: pb.Widget_BLUE.Enum()}},
- {"unknown enum value object",
- "{\n \"color\": 1000,\n \"r_color\": [\n \"RED\"\n ]\n}",
- &pb.Widget{Color: pb.Widget_Color(1000).Enum(), RColor: []pb.Widget_Color{pb.Widget_RED}}},
- {"unquoted int64 object", `{"o_int64":-314}`, &pb.Simple{OInt64: proto.Int64(-314)}},
- {"unquoted uint64 object", `{"o_uint64":123}`, &pb.Simple{OUint64: proto.Uint64(123)}},
- {"map", `{"nummy":{"1":2,"3":4}}`, &pb.Mappy{Nummy: map[int64]int32{1: 2, 3: 4}}},
- {"map", `{"strry":{"\"one\"":"two","three":"four"}}`, &pb.Mappy{Strry: map[string]string{`"one"`: "two", "three": "four"}}},
- {"map", `{"objjy":{"1":{"dub":1}}}`, &pb.Mappy{Objjy: map[int32]*pb.Simple3{1: &pb.Simple3{Dub: 1}}}},
-}
-
-func TestUnmarshalling(t *testing.T) {
- for _, tt := range unmarshallingTests {
- // Make a new instance of the type of our expected object.
- p := proto.Clone(tt.pb)
- p.Reset()
-
- err := UnmarshalString(tt.json, p)
- if err != nil {
- t.Error(err)
- continue
- }
-
- // For easier diffs, compare text strings of the protos.
- exp := proto.MarshalTextString(tt.pb)
- act := proto.MarshalTextString(p)
- if string(exp) != string(act) {
- t.Errorf("%s: got [%s] want [%s]", tt.desc, act, exp)
- }
- }
-}
-
-var unmarshallingShouldError = []struct {
- desc string
- in string
-}{
- {"a value", "666"},
- {"gibberish", "{adskja123;l23=-="},
-}
-
-func TestUnmarshallingBadInput(t *testing.T) {
- for _, tt := range unmarshallingShouldError {
- obj := &pb.Simple{}
- err := UnmarshalString(tt.in, obj)
- if err == nil {
- t.Errorf("an error was expected when parsing %q instead of an object", tt.desc)
- }
- }
-}
diff --git a/vendor/github.com/golang/protobuf/jsonpb/jsonpb_test_proto/Makefile b/vendor/github.com/golang/protobuf/jsonpb/jsonpb_test_proto/Makefile
deleted file mode 100644
index e53e6a69..00000000
--- a/vendor/github.com/golang/protobuf/jsonpb/jsonpb_test_proto/Makefile
+++ /dev/null
@@ -1,33 +0,0 @@
-# Go support for Protocol Buffers - Google's data interchange format
-#
-# Copyright 2015 The Go Authors. All rights reserved.
-# https://github.com/golang/protobuf
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are
-# met:
-#
-# * Redistributions of source code must retain the above copyright
-# notice, this list of conditions and the following disclaimer.
-# * Redistributions in binary form must reproduce the above
-# copyright notice, this list of conditions and the following disclaimer
-# in the documentation and/or other materials provided with the
-# distribution.
-# * Neither the name of Google Inc. nor the names of its
-# contributors may be used to endorse or promote products derived from
-# this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-regenerate:
- protoc --go_out=. *.proto
diff --git a/vendor/github.com/golang/protobuf/jsonpb/jsonpb_test_proto/more_test_objects.proto b/vendor/github.com/golang/protobuf/jsonpb/jsonpb_test_proto/more_test_objects.proto
deleted file mode 100644
index 65357916..00000000
--- a/vendor/github.com/golang/protobuf/jsonpb/jsonpb_test_proto/more_test_objects.proto
+++ /dev/null
@@ -1,46 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2015 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-syntax = "proto3";
-
-package jsonpb;
-
-message Simple3 {
- double dub = 1;
-}
-
-message Mappy {
- map nummy = 1;
- map strry = 2;
- map objjy = 3;
- map buggy = 4;
- map booly = 5;
-}
diff --git a/vendor/github.com/golang/protobuf/jsonpb/jsonpb_test_proto/test_objects.proto b/vendor/github.com/golang/protobuf/jsonpb/jsonpb_test_proto/test_objects.proto
deleted file mode 100644
index e48a3e88..00000000
--- a/vendor/github.com/golang/protobuf/jsonpb/jsonpb_test_proto/test_objects.proto
+++ /dev/null
@@ -1,86 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2015 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-syntax = "proto2";
-
-package jsonpb;
-
-// Test message for holding primitive types.
-message Simple {
- optional bool o_bool = 1;
- optional int32 o_int32 = 2;
- optional int64 o_int64 = 3;
- optional uint32 o_uint32 = 4;
- optional uint64 o_uint64 = 5;
- optional sint32 o_sint32 = 6;
- optional sint64 o_sint64 = 7;
- optional float o_float = 8;
- optional double o_double = 9;
- optional string o_string = 10;
- optional bytes o_bytes = 11;
-}
-
-// Test message for holding repeated primitives.
-message Repeats {
- repeated bool r_bool = 1;
- repeated int32 r_int32 = 2;
- repeated int64 r_int64 = 3;
- repeated uint32 r_uint32 = 4;
- repeated uint64 r_uint64 = 5;
- repeated sint32 r_sint32 = 6;
- repeated sint64 r_sint64 = 7;
- repeated float r_float = 8;
- repeated double r_double = 9;
- repeated string r_string = 10;
- repeated bytes r_bytes = 11;
-}
-
-// Test message for holding enums and nested messages.
-message Widget {
- enum Color {
- RED = 0;
- GREEN = 1;
- BLUE = 2;
- };
- optional Color color = 1;
- repeated Color r_color = 2;
-
- optional Simple simple = 10;
- repeated Simple r_simple = 11;
-
- optional Repeats repeats = 20;
- repeated Repeats r_repeats = 21;
-}
-
-message Maps {
- map m_int64_str = 1;
- map m_bool_simple = 2;
-}
diff --git a/vendor/github.com/golang/protobuf/proto/all_test.go b/vendor/github.com/golang/protobuf/proto/all_test.go
deleted file mode 100644
index 5a9b6a47..00000000
--- a/vendor/github.com/golang/protobuf/proto/all_test.go
+++ /dev/null
@@ -1,2083 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2010 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-package proto_test
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "math"
- "math/rand"
- "reflect"
- "runtime/debug"
- "strings"
- "testing"
- "time"
-
- . "github.com/golang/protobuf/proto"
- . "github.com/golang/protobuf/proto/testdata"
-)
-
-var globalO *Buffer
-
-func old() *Buffer {
- if globalO == nil {
- globalO = NewBuffer(nil)
- }
- globalO.Reset()
- return globalO
-}
-
-func equalbytes(b1, b2 []byte, t *testing.T) {
- if len(b1) != len(b2) {
- t.Errorf("wrong lengths: 2*%d != %d", len(b1), len(b2))
- return
- }
- for i := 0; i < len(b1); i++ {
- if b1[i] != b2[i] {
- t.Errorf("bad byte[%d]:%x %x: %s %s", i, b1[i], b2[i], b1, b2)
- }
- }
-}
-
-func initGoTestField() *GoTestField {
- f := new(GoTestField)
- f.Label = String("label")
- f.Type = String("type")
- return f
-}
-
-// These are all structurally equivalent but the tag numbers differ.
-// (It's remarkable that required, optional, and repeated all have
-// 8 letters.)
-func initGoTest_RequiredGroup() *GoTest_RequiredGroup {
- return &GoTest_RequiredGroup{
- RequiredField: String("required"),
- }
-}
-
-func initGoTest_OptionalGroup() *GoTest_OptionalGroup {
- return &GoTest_OptionalGroup{
- RequiredField: String("optional"),
- }
-}
-
-func initGoTest_RepeatedGroup() *GoTest_RepeatedGroup {
- return &GoTest_RepeatedGroup{
- RequiredField: String("repeated"),
- }
-}
-
-func initGoTest(setdefaults bool) *GoTest {
- pb := new(GoTest)
- if setdefaults {
- pb.F_BoolDefaulted = Bool(Default_GoTest_F_BoolDefaulted)
- pb.F_Int32Defaulted = Int32(Default_GoTest_F_Int32Defaulted)
- pb.F_Int64Defaulted = Int64(Default_GoTest_F_Int64Defaulted)
- pb.F_Fixed32Defaulted = Uint32(Default_GoTest_F_Fixed32Defaulted)
- pb.F_Fixed64Defaulted = Uint64(Default_GoTest_F_Fixed64Defaulted)
- pb.F_Uint32Defaulted = Uint32(Default_GoTest_F_Uint32Defaulted)
- pb.F_Uint64Defaulted = Uint64(Default_GoTest_F_Uint64Defaulted)
- pb.F_FloatDefaulted = Float32(Default_GoTest_F_FloatDefaulted)
- pb.F_DoubleDefaulted = Float64(Default_GoTest_F_DoubleDefaulted)
- pb.F_StringDefaulted = String(Default_GoTest_F_StringDefaulted)
- pb.F_BytesDefaulted = Default_GoTest_F_BytesDefaulted
- pb.F_Sint32Defaulted = Int32(Default_GoTest_F_Sint32Defaulted)
- pb.F_Sint64Defaulted = Int64(Default_GoTest_F_Sint64Defaulted)
- }
-
- pb.Kind = GoTest_TIME.Enum()
- pb.RequiredField = initGoTestField()
- pb.F_BoolRequired = Bool(true)
- pb.F_Int32Required = Int32(3)
- pb.F_Int64Required = Int64(6)
- pb.F_Fixed32Required = Uint32(32)
- pb.F_Fixed64Required = Uint64(64)
- pb.F_Uint32Required = Uint32(3232)
- pb.F_Uint64Required = Uint64(6464)
- pb.F_FloatRequired = Float32(3232)
- pb.F_DoubleRequired = Float64(6464)
- pb.F_StringRequired = String("string")
- pb.F_BytesRequired = []byte("bytes")
- pb.F_Sint32Required = Int32(-32)
- pb.F_Sint64Required = Int64(-64)
- pb.Requiredgroup = initGoTest_RequiredGroup()
-
- return pb
-}
-
-func fail(msg string, b *bytes.Buffer, s string, t *testing.T) {
- data := b.Bytes()
- ld := len(data)
- ls := len(s) / 2
-
- fmt.Printf("fail %s ld=%d ls=%d\n", msg, ld, ls)
-
- // find the interesting spot - n
- n := ls
- if ld < ls {
- n = ld
- }
- j := 0
- for i := 0; i < n; i++ {
- bs := hex(s[j])*16 + hex(s[j+1])
- j += 2
- if data[i] == bs {
- continue
- }
- n = i
- break
- }
- l := n - 10
- if l < 0 {
- l = 0
- }
- h := n + 10
-
- // find the interesting spot - n
- fmt.Printf("is[%d]:", l)
- for i := l; i < h; i++ {
- if i >= ld {
- fmt.Printf(" --")
- continue
- }
- fmt.Printf(" %.2x", data[i])
- }
- fmt.Printf("\n")
-
- fmt.Printf("sb[%d]:", l)
- for i := l; i < h; i++ {
- if i >= ls {
- fmt.Printf(" --")
- continue
- }
- bs := hex(s[j])*16 + hex(s[j+1])
- j += 2
- fmt.Printf(" %.2x", bs)
- }
- fmt.Printf("\n")
-
- t.Fail()
-
- // t.Errorf("%s: \ngood: %s\nbad: %x", msg, s, b.Bytes())
- // Print the output in a partially-decoded format; can
- // be helpful when updating the test. It produces the output
- // that is pasted, with minor edits, into the argument to verify().
- // data := b.Bytes()
- // nesting := 0
- // for b.Len() > 0 {
- // start := len(data) - b.Len()
- // var u uint64
- // u, err := DecodeVarint(b)
- // if err != nil {
- // fmt.Printf("decode error on varint:", err)
- // return
- // }
- // wire := u & 0x7
- // tag := u >> 3
- // switch wire {
- // case WireVarint:
- // v, err := DecodeVarint(b)
- // if err != nil {
- // fmt.Printf("decode error on varint:", err)
- // return
- // }
- // fmt.Printf("\t\t\"%x\" // field %d, encoding %d, value %d\n",
- // data[start:len(data)-b.Len()], tag, wire, v)
- // case WireFixed32:
- // v, err := DecodeFixed32(b)
- // if err != nil {
- // fmt.Printf("decode error on fixed32:", err)
- // return
- // }
- // fmt.Printf("\t\t\"%x\" // field %d, encoding %d, value %d\n",
- // data[start:len(data)-b.Len()], tag, wire, v)
- // case WireFixed64:
- // v, err := DecodeFixed64(b)
- // if err != nil {
- // fmt.Printf("decode error on fixed64:", err)
- // return
- // }
- // fmt.Printf("\t\t\"%x\" // field %d, encoding %d, value %d\n",
- // data[start:len(data)-b.Len()], tag, wire, v)
- // case WireBytes:
- // nb, err := DecodeVarint(b)
- // if err != nil {
- // fmt.Printf("decode error on bytes:", err)
- // return
- // }
- // after_tag := len(data) - b.Len()
- // str := make([]byte, nb)
- // _, err = b.Read(str)
- // if err != nil {
- // fmt.Printf("decode error on bytes:", err)
- // return
- // }
- // fmt.Printf("\t\t\"%x\" \"%x\" // field %d, encoding %d (FIELD)\n",
- // data[start:after_tag], str, tag, wire)
- // case WireStartGroup:
- // nesting++
- // fmt.Printf("\t\t\"%x\"\t\t// start group field %d level %d\n",
- // data[start:len(data)-b.Len()], tag, nesting)
- // case WireEndGroup:
- // fmt.Printf("\t\t\"%x\"\t\t// end group field %d level %d\n",
- // data[start:len(data)-b.Len()], tag, nesting)
- // nesting--
- // default:
- // fmt.Printf("unrecognized wire type %d\n", wire)
- // return
- // }
- // }
-}
-
-func hex(c uint8) uint8 {
- if '0' <= c && c <= '9' {
- return c - '0'
- }
- if 'a' <= c && c <= 'f' {
- return 10 + c - 'a'
- }
- if 'A' <= c && c <= 'F' {
- return 10 + c - 'A'
- }
- return 0
-}
-
-func equal(b []byte, s string, t *testing.T) bool {
- if 2*len(b) != len(s) {
- // fail(fmt.Sprintf("wrong lengths: 2*%d != %d", len(b), len(s)), b, s, t)
- fmt.Printf("wrong lengths: 2*%d != %d\n", len(b), len(s))
- return false
- }
- for i, j := 0, 0; i < len(b); i, j = i+1, j+2 {
- x := hex(s[j])*16 + hex(s[j+1])
- if b[i] != x {
- // fail(fmt.Sprintf("bad byte[%d]:%x %x", i, b[i], x), b, s, t)
- fmt.Printf("bad byte[%d]:%x %x", i, b[i], x)
- return false
- }
- }
- return true
-}
-
-func overify(t *testing.T, pb *GoTest, expected string) {
- o := old()
- err := o.Marshal(pb)
- if err != nil {
- fmt.Printf("overify marshal-1 err = %v", err)
- o.DebugPrint("", o.Bytes())
- t.Fatalf("expected = %s", expected)
- }
- if !equal(o.Bytes(), expected, t) {
- o.DebugPrint("overify neq 1", o.Bytes())
- t.Fatalf("expected = %s", expected)
- }
-
- // Now test Unmarshal by recreating the original buffer.
- pbd := new(GoTest)
- err = o.Unmarshal(pbd)
- if err != nil {
- t.Fatalf("overify unmarshal err = %v", err)
- o.DebugPrint("", o.Bytes())
- t.Fatalf("string = %s", expected)
- }
- o.Reset()
- err = o.Marshal(pbd)
- if err != nil {
- t.Errorf("overify marshal-2 err = %v", err)
- o.DebugPrint("", o.Bytes())
- t.Fatalf("string = %s", expected)
- }
- if !equal(o.Bytes(), expected, t) {
- o.DebugPrint("overify neq 2", o.Bytes())
- t.Fatalf("string = %s", expected)
- }
-}
-
-// Simple tests for numeric encode/decode primitives (varint, etc.)
-func TestNumericPrimitives(t *testing.T) {
- for i := uint64(0); i < 1e6; i += 111 {
- o := old()
- if o.EncodeVarint(i) != nil {
- t.Error("EncodeVarint")
- break
- }
- x, e := o.DecodeVarint()
- if e != nil {
- t.Fatal("DecodeVarint")
- }
- if x != i {
- t.Fatal("varint decode fail:", i, x)
- }
-
- o = old()
- if o.EncodeFixed32(i) != nil {
- t.Fatal("encFixed32")
- }
- x, e = o.DecodeFixed32()
- if e != nil {
- t.Fatal("decFixed32")
- }
- if x != i {
- t.Fatal("fixed32 decode fail:", i, x)
- }
-
- o = old()
- if o.EncodeFixed64(i*1234567) != nil {
- t.Error("encFixed64")
- break
- }
- x, e = o.DecodeFixed64()
- if e != nil {
- t.Error("decFixed64")
- break
- }
- if x != i*1234567 {
- t.Error("fixed64 decode fail:", i*1234567, x)
- break
- }
-
- o = old()
- i32 := int32(i - 12345)
- if o.EncodeZigzag32(uint64(i32)) != nil {
- t.Fatal("EncodeZigzag32")
- }
- x, e = o.DecodeZigzag32()
- if e != nil {
- t.Fatal("DecodeZigzag32")
- }
- if x != uint64(uint32(i32)) {
- t.Fatal("zigzag32 decode fail:", i32, x)
- }
-
- o = old()
- i64 := int64(i - 12345)
- if o.EncodeZigzag64(uint64(i64)) != nil {
- t.Fatal("EncodeZigzag64")
- }
- x, e = o.DecodeZigzag64()
- if e != nil {
- t.Fatal("DecodeZigzag64")
- }
- if x != uint64(i64) {
- t.Fatal("zigzag64 decode fail:", i64, x)
- }
- }
-}
-
-// fakeMarshaler is a simple struct implementing Marshaler and Message interfaces.
-type fakeMarshaler struct {
- b []byte
- err error
-}
-
-func (f fakeMarshaler) Marshal() ([]byte, error) {
- return f.b, f.err
-}
-
-func (f fakeMarshaler) String() string {
- return fmt.Sprintf("Bytes: %v Error: %v", f.b, f.err)
-}
-
-func (f fakeMarshaler) ProtoMessage() {}
-
-func (f fakeMarshaler) Reset() {}
-
-// Simple tests for proto messages that implement the Marshaler interface.
-func TestMarshalerEncoding(t *testing.T) {
- tests := []struct {
- name string
- m Message
- want []byte
- wantErr error
- }{
- {
- name: "Marshaler that fails",
- m: fakeMarshaler{
- err: errors.New("some marshal err"),
- b: []byte{5, 6, 7},
- },
- // Since there's an error, nothing should be written to buffer.
- want: nil,
- wantErr: errors.New("some marshal err"),
- },
- {
- name: "Marshaler that succeeds",
- m: fakeMarshaler{
- b: []byte{0, 1, 2, 3, 4, 127, 255},
- },
- want: []byte{0, 1, 2, 3, 4, 127, 255},
- wantErr: nil,
- },
- }
- for _, test := range tests {
- b := NewBuffer(nil)
- err := b.Marshal(test.m)
- if !reflect.DeepEqual(test.wantErr, err) {
- t.Errorf("%s: got err %v wanted %v", test.name, err, test.wantErr)
- }
- if !reflect.DeepEqual(test.want, b.Bytes()) {
- t.Errorf("%s: got bytes %v wanted %v", test.name, b.Bytes(), test.want)
- }
- }
-}
-
-// Simple tests for bytes
-func TestBytesPrimitives(t *testing.T) {
- o := old()
- bytes := []byte{'n', 'o', 'w', ' ', 'i', 's', ' ', 't', 'h', 'e', ' ', 't', 'i', 'm', 'e'}
- if o.EncodeRawBytes(bytes) != nil {
- t.Error("EncodeRawBytes")
- }
- decb, e := o.DecodeRawBytes(false)
- if e != nil {
- t.Error("DecodeRawBytes")
- }
- equalbytes(bytes, decb, t)
-}
-
-// Simple tests for strings
-func TestStringPrimitives(t *testing.T) {
- o := old()
- s := "now is the time"
- if o.EncodeStringBytes(s) != nil {
- t.Error("enc_string")
- }
- decs, e := o.DecodeStringBytes()
- if e != nil {
- t.Error("dec_string")
- }
- if s != decs {
- t.Error("string encode/decode fail:", s, decs)
- }
-}
-
-// Do we catch the "required bit not set" case?
-func TestRequiredBit(t *testing.T) {
- o := old()
- pb := new(GoTest)
- err := o.Marshal(pb)
- if err == nil {
- t.Error("did not catch missing required fields")
- } else if strings.Index(err.Error(), "Kind") < 0 {
- t.Error("wrong error type:", err)
- }
-}
-
-// Check that all fields are nil.
-// Clearly silly, and a residue from a more interesting test with an earlier,
-// different initialization property, but it once caught a compiler bug so
-// it lives.
-func checkInitialized(pb *GoTest, t *testing.T) {
- if pb.F_BoolDefaulted != nil {
- t.Error("New or Reset did not set boolean:", *pb.F_BoolDefaulted)
- }
- if pb.F_Int32Defaulted != nil {
- t.Error("New or Reset did not set int32:", *pb.F_Int32Defaulted)
- }
- if pb.F_Int64Defaulted != nil {
- t.Error("New or Reset did not set int64:", *pb.F_Int64Defaulted)
- }
- if pb.F_Fixed32Defaulted != nil {
- t.Error("New or Reset did not set fixed32:", *pb.F_Fixed32Defaulted)
- }
- if pb.F_Fixed64Defaulted != nil {
- t.Error("New or Reset did not set fixed64:", *pb.F_Fixed64Defaulted)
- }
- if pb.F_Uint32Defaulted != nil {
- t.Error("New or Reset did not set uint32:", *pb.F_Uint32Defaulted)
- }
- if pb.F_Uint64Defaulted != nil {
- t.Error("New or Reset did not set uint64:", *pb.F_Uint64Defaulted)
- }
- if pb.F_FloatDefaulted != nil {
- t.Error("New or Reset did not set float:", *pb.F_FloatDefaulted)
- }
- if pb.F_DoubleDefaulted != nil {
- t.Error("New or Reset did not set double:", *pb.F_DoubleDefaulted)
- }
- if pb.F_StringDefaulted != nil {
- t.Error("New or Reset did not set string:", *pb.F_StringDefaulted)
- }
- if pb.F_BytesDefaulted != nil {
- t.Error("New or Reset did not set bytes:", string(pb.F_BytesDefaulted))
- }
- if pb.F_Sint32Defaulted != nil {
- t.Error("New or Reset did not set int32:", *pb.F_Sint32Defaulted)
- }
- if pb.F_Sint64Defaulted != nil {
- t.Error("New or Reset did not set int64:", *pb.F_Sint64Defaulted)
- }
-}
-
-// Does Reset() reset?
-func TestReset(t *testing.T) {
- pb := initGoTest(true)
- // muck with some values
- pb.F_BoolDefaulted = Bool(false)
- pb.F_Int32Defaulted = Int32(237)
- pb.F_Int64Defaulted = Int64(12346)
- pb.F_Fixed32Defaulted = Uint32(32000)
- pb.F_Fixed64Defaulted = Uint64(666)
- pb.F_Uint32Defaulted = Uint32(323232)
- pb.F_Uint64Defaulted = nil
- pb.F_FloatDefaulted = nil
- pb.F_DoubleDefaulted = Float64(0)
- pb.F_StringDefaulted = String("gotcha")
- pb.F_BytesDefaulted = []byte("asdfasdf")
- pb.F_Sint32Defaulted = Int32(123)
- pb.F_Sint64Defaulted = Int64(789)
- pb.Reset()
- checkInitialized(pb, t)
-}
-
-// All required fields set, no defaults provided.
-func TestEncodeDecode1(t *testing.T) {
- pb := initGoTest(false)
- overify(t, pb,
- "0807"+ // field 1, encoding 0, value 7
- "220d"+"0a056c6162656c120474797065"+ // field 4, encoding 2 (GoTestField)
- "5001"+ // field 10, encoding 0, value 1
- "5803"+ // field 11, encoding 0, value 3
- "6006"+ // field 12, encoding 0, value 6
- "6d20000000"+ // field 13, encoding 5, value 0x20
- "714000000000000000"+ // field 14, encoding 1, value 0x40
- "78a019"+ // field 15, encoding 0, value 0xca0 = 3232
- "8001c032"+ // field 16, encoding 0, value 0x1940 = 6464
- "8d0100004a45"+ // field 17, encoding 5, value 3232.0
- "9101000000000040b940"+ // field 18, encoding 1, value 6464.0
- "9a0106"+"737472696e67"+ // field 19, encoding 2, string "string"
- "b304"+ // field 70, encoding 3, start group
- "ba0408"+"7265717569726564"+ // field 71, encoding 2, string "required"
- "b404"+ // field 70, encoding 4, end group
- "aa0605"+"6279746573"+ // field 101, encoding 2, string "bytes"
- "b0063f"+ // field 102, encoding 0, 0x3f zigzag32
- "b8067f") // field 103, encoding 0, 0x7f zigzag64
-}
-
-// All required fields set, defaults provided.
-func TestEncodeDecode2(t *testing.T) {
- pb := initGoTest(true)
- overify(t, pb,
- "0807"+ // field 1, encoding 0, value 7
- "220d"+"0a056c6162656c120474797065"+ // field 4, encoding 2 (GoTestField)
- "5001"+ // field 10, encoding 0, value 1
- "5803"+ // field 11, encoding 0, value 3
- "6006"+ // field 12, encoding 0, value 6
- "6d20000000"+ // field 13, encoding 5, value 32
- "714000000000000000"+ // field 14, encoding 1, value 64
- "78a019"+ // field 15, encoding 0, value 3232
- "8001c032"+ // field 16, encoding 0, value 6464
- "8d0100004a45"+ // field 17, encoding 5, value 3232.0
- "9101000000000040b940"+ // field 18, encoding 1, value 6464.0
- "9a0106"+"737472696e67"+ // field 19, encoding 2 string "string"
- "c00201"+ // field 40, encoding 0, value 1
- "c80220"+ // field 41, encoding 0, value 32
- "d00240"+ // field 42, encoding 0, value 64
- "dd0240010000"+ // field 43, encoding 5, value 320
- "e1028002000000000000"+ // field 44, encoding 1, value 640
- "e8028019"+ // field 45, encoding 0, value 3200
- "f0028032"+ // field 46, encoding 0, value 6400
- "fd02e0659948"+ // field 47, encoding 5, value 314159.0
- "81030000000050971041"+ // field 48, encoding 1, value 271828.0
- "8a0310"+"68656c6c6f2c2022776f726c6421220a"+ // field 49, encoding 2 string "hello, \"world!\"\n"
- "b304"+ // start group field 70 level 1
- "ba0408"+"7265717569726564"+ // field 71, encoding 2, string "required"
- "b404"+ // end group field 70 level 1
- "aa0605"+"6279746573"+ // field 101, encoding 2 string "bytes"
- "b0063f"+ // field 102, encoding 0, 0x3f zigzag32
- "b8067f"+ // field 103, encoding 0, 0x7f zigzag64
- "8a1907"+"4269676e6f7365"+ // field 401, encoding 2, string "Bignose"
- "90193f"+ // field 402, encoding 0, value 63
- "98197f") // field 403, encoding 0, value 127
-
-}
-
-// All default fields set to their default value by hand
-func TestEncodeDecode3(t *testing.T) {
- pb := initGoTest(false)
- pb.F_BoolDefaulted = Bool(true)
- pb.F_Int32Defaulted = Int32(32)
- pb.F_Int64Defaulted = Int64(64)
- pb.F_Fixed32Defaulted = Uint32(320)
- pb.F_Fixed64Defaulted = Uint64(640)
- pb.F_Uint32Defaulted = Uint32(3200)
- pb.F_Uint64Defaulted = Uint64(6400)
- pb.F_FloatDefaulted = Float32(314159)
- pb.F_DoubleDefaulted = Float64(271828)
- pb.F_StringDefaulted = String("hello, \"world!\"\n")
- pb.F_BytesDefaulted = []byte("Bignose")
- pb.F_Sint32Defaulted = Int32(-32)
- pb.F_Sint64Defaulted = Int64(-64)
-
- overify(t, pb,
- "0807"+ // field 1, encoding 0, value 7
- "220d"+"0a056c6162656c120474797065"+ // field 4, encoding 2 (GoTestField)
- "5001"+ // field 10, encoding 0, value 1
- "5803"+ // field 11, encoding 0, value 3
- "6006"+ // field 12, encoding 0, value 6
- "6d20000000"+ // field 13, encoding 5, value 32
- "714000000000000000"+ // field 14, encoding 1, value 64
- "78a019"+ // field 15, encoding 0, value 3232
- "8001c032"+ // field 16, encoding 0, value 6464
- "8d0100004a45"+ // field 17, encoding 5, value 3232.0
- "9101000000000040b940"+ // field 18, encoding 1, value 6464.0
- "9a0106"+"737472696e67"+ // field 19, encoding 2 string "string"
- "c00201"+ // field 40, encoding 0, value 1
- "c80220"+ // field 41, encoding 0, value 32
- "d00240"+ // field 42, encoding 0, value 64
- "dd0240010000"+ // field 43, encoding 5, value 320
- "e1028002000000000000"+ // field 44, encoding 1, value 640
- "e8028019"+ // field 45, encoding 0, value 3200
- "f0028032"+ // field 46, encoding 0, value 6400
- "fd02e0659948"+ // field 47, encoding 5, value 314159.0
- "81030000000050971041"+ // field 48, encoding 1, value 271828.0
- "8a0310"+"68656c6c6f2c2022776f726c6421220a"+ // field 49, encoding 2 string "hello, \"world!\"\n"
- "b304"+ // start group field 70 level 1
- "ba0408"+"7265717569726564"+ // field 71, encoding 2, string "required"
- "b404"+ // end group field 70 level 1
- "aa0605"+"6279746573"+ // field 101, encoding 2 string "bytes"
- "b0063f"+ // field 102, encoding 0, 0x3f zigzag32
- "b8067f"+ // field 103, encoding 0, 0x7f zigzag64
- "8a1907"+"4269676e6f7365"+ // field 401, encoding 2, string "Bignose"
- "90193f"+ // field 402, encoding 0, value 63
- "98197f") // field 403, encoding 0, value 127
-
-}
-
-// All required fields set, defaults provided, all non-defaulted optional fields have values.
-func TestEncodeDecode4(t *testing.T) {
- pb := initGoTest(true)
- pb.Table = String("hello")
- pb.Param = Int32(7)
- pb.OptionalField = initGoTestField()
- pb.F_BoolOptional = Bool(true)
- pb.F_Int32Optional = Int32(32)
- pb.F_Int64Optional = Int64(64)
- pb.F_Fixed32Optional = Uint32(3232)
- pb.F_Fixed64Optional = Uint64(6464)
- pb.F_Uint32Optional = Uint32(323232)
- pb.F_Uint64Optional = Uint64(646464)
- pb.F_FloatOptional = Float32(32.)
- pb.F_DoubleOptional = Float64(64.)
- pb.F_StringOptional = String("hello")
- pb.F_BytesOptional = []byte("Bignose")
- pb.F_Sint32Optional = Int32(-32)
- pb.F_Sint64Optional = Int64(-64)
- pb.Optionalgroup = initGoTest_OptionalGroup()
-
- overify(t, pb,
- "0807"+ // field 1, encoding 0, value 7
- "1205"+"68656c6c6f"+ // field 2, encoding 2, string "hello"
- "1807"+ // field 3, encoding 0, value 7
- "220d"+"0a056c6162656c120474797065"+ // field 4, encoding 2 (GoTestField)
- "320d"+"0a056c6162656c120474797065"+ // field 6, encoding 2 (GoTestField)
- "5001"+ // field 10, encoding 0, value 1
- "5803"+ // field 11, encoding 0, value 3
- "6006"+ // field 12, encoding 0, value 6
- "6d20000000"+ // field 13, encoding 5, value 32
- "714000000000000000"+ // field 14, encoding 1, value 64
- "78a019"+ // field 15, encoding 0, value 3232
- "8001c032"+ // field 16, encoding 0, value 6464
- "8d0100004a45"+ // field 17, encoding 5, value 3232.0
- "9101000000000040b940"+ // field 18, encoding 1, value 6464.0
- "9a0106"+"737472696e67"+ // field 19, encoding 2 string "string"
- "f00101"+ // field 30, encoding 0, value 1
- "f80120"+ // field 31, encoding 0, value 32
- "800240"+ // field 32, encoding 0, value 64
- "8d02a00c0000"+ // field 33, encoding 5, value 3232
- "91024019000000000000"+ // field 34, encoding 1, value 6464
- "9802a0dd13"+ // field 35, encoding 0, value 323232
- "a002c0ba27"+ // field 36, encoding 0, value 646464
- "ad0200000042"+ // field 37, encoding 5, value 32.0
- "b1020000000000005040"+ // field 38, encoding 1, value 64.0
- "ba0205"+"68656c6c6f"+ // field 39, encoding 2, string "hello"
- "c00201"+ // field 40, encoding 0, value 1
- "c80220"+ // field 41, encoding 0, value 32
- "d00240"+ // field 42, encoding 0, value 64
- "dd0240010000"+ // field 43, encoding 5, value 320
- "e1028002000000000000"+ // field 44, encoding 1, value 640
- "e8028019"+ // field 45, encoding 0, value 3200
- "f0028032"+ // field 46, encoding 0, value 6400
- "fd02e0659948"+ // field 47, encoding 5, value 314159.0
- "81030000000050971041"+ // field 48, encoding 1, value 271828.0
- "8a0310"+"68656c6c6f2c2022776f726c6421220a"+ // field 49, encoding 2 string "hello, \"world!\"\n"
- "b304"+ // start group field 70 level 1
- "ba0408"+"7265717569726564"+ // field 71, encoding 2, string "required"
- "b404"+ // end group field 70 level 1
- "d305"+ // start group field 90 level 1
- "da0508"+"6f7074696f6e616c"+ // field 91, encoding 2, string "optional"
- "d405"+ // end group field 90 level 1
- "aa0605"+"6279746573"+ // field 101, encoding 2 string "bytes"
- "b0063f"+ // field 102, encoding 0, 0x3f zigzag32
- "b8067f"+ // field 103, encoding 0, 0x7f zigzag64
- "ea1207"+"4269676e6f7365"+ // field 301, encoding 2, string "Bignose"
- "f0123f"+ // field 302, encoding 0, value 63
- "f8127f"+ // field 303, encoding 0, value 127
- "8a1907"+"4269676e6f7365"+ // field 401, encoding 2, string "Bignose"
- "90193f"+ // field 402, encoding 0, value 63
- "98197f") // field 403, encoding 0, value 127
-
-}
-
-// All required fields set, defaults provided, all repeated fields given two values.
-func TestEncodeDecode5(t *testing.T) {
- pb := initGoTest(true)
- pb.RepeatedField = []*GoTestField{initGoTestField(), initGoTestField()}
- pb.F_BoolRepeated = []bool{false, true}
- pb.F_Int32Repeated = []int32{32, 33}
- pb.F_Int64Repeated = []int64{64, 65}
- pb.F_Fixed32Repeated = []uint32{3232, 3333}
- pb.F_Fixed64Repeated = []uint64{6464, 6565}
- pb.F_Uint32Repeated = []uint32{323232, 333333}
- pb.F_Uint64Repeated = []uint64{646464, 656565}
- pb.F_FloatRepeated = []float32{32., 33.}
- pb.F_DoubleRepeated = []float64{64., 65.}
- pb.F_StringRepeated = []string{"hello", "sailor"}
- pb.F_BytesRepeated = [][]byte{[]byte("big"), []byte("nose")}
- pb.F_Sint32Repeated = []int32{32, -32}
- pb.F_Sint64Repeated = []int64{64, -64}
- pb.Repeatedgroup = []*GoTest_RepeatedGroup{initGoTest_RepeatedGroup(), initGoTest_RepeatedGroup()}
-
- overify(t, pb,
- "0807"+ // field 1, encoding 0, value 7
- "220d"+"0a056c6162656c120474797065"+ // field 4, encoding 2 (GoTestField)
- "2a0d"+"0a056c6162656c120474797065"+ // field 5, encoding 2 (GoTestField)
- "2a0d"+"0a056c6162656c120474797065"+ // field 5, encoding 2 (GoTestField)
- "5001"+ // field 10, encoding 0, value 1
- "5803"+ // field 11, encoding 0, value 3
- "6006"+ // field 12, encoding 0, value 6
- "6d20000000"+ // field 13, encoding 5, value 32
- "714000000000000000"+ // field 14, encoding 1, value 64
- "78a019"+ // field 15, encoding 0, value 3232
- "8001c032"+ // field 16, encoding 0, value 6464
- "8d0100004a45"+ // field 17, encoding 5, value 3232.0
- "9101000000000040b940"+ // field 18, encoding 1, value 6464.0
- "9a0106"+"737472696e67"+ // field 19, encoding 2 string "string"
- "a00100"+ // field 20, encoding 0, value 0
- "a00101"+ // field 20, encoding 0, value 1
- "a80120"+ // field 21, encoding 0, value 32
- "a80121"+ // field 21, encoding 0, value 33
- "b00140"+ // field 22, encoding 0, value 64
- "b00141"+ // field 22, encoding 0, value 65
- "bd01a00c0000"+ // field 23, encoding 5, value 3232
- "bd01050d0000"+ // field 23, encoding 5, value 3333
- "c1014019000000000000"+ // field 24, encoding 1, value 6464
- "c101a519000000000000"+ // field 24, encoding 1, value 6565
- "c801a0dd13"+ // field 25, encoding 0, value 323232
- "c80195ac14"+ // field 25, encoding 0, value 333333
- "d001c0ba27"+ // field 26, encoding 0, value 646464
- "d001b58928"+ // field 26, encoding 0, value 656565
- "dd0100000042"+ // field 27, encoding 5, value 32.0
- "dd0100000442"+ // field 27, encoding 5, value 33.0
- "e1010000000000005040"+ // field 28, encoding 1, value 64.0
- "e1010000000000405040"+ // field 28, encoding 1, value 65.0
- "ea0105"+"68656c6c6f"+ // field 29, encoding 2, string "hello"
- "ea0106"+"7361696c6f72"+ // field 29, encoding 2, string "sailor"
- "c00201"+ // field 40, encoding 0, value 1
- "c80220"+ // field 41, encoding 0, value 32
- "d00240"+ // field 42, encoding 0, value 64
- "dd0240010000"+ // field 43, encoding 5, value 320
- "e1028002000000000000"+ // field 44, encoding 1, value 640
- "e8028019"+ // field 45, encoding 0, value 3200
- "f0028032"+ // field 46, encoding 0, value 6400
- "fd02e0659948"+ // field 47, encoding 5, value 314159.0
- "81030000000050971041"+ // field 48, encoding 1, value 271828.0
- "8a0310"+"68656c6c6f2c2022776f726c6421220a"+ // field 49, encoding 2 string "hello, \"world!\"\n"
- "b304"+ // start group field 70 level 1
- "ba0408"+"7265717569726564"+ // field 71, encoding 2, string "required"
- "b404"+ // end group field 70 level 1
- "8305"+ // start group field 80 level 1
- "8a0508"+"7265706561746564"+ // field 81, encoding 2, string "repeated"
- "8405"+ // end group field 80 level 1
- "8305"+ // start group field 80 level 1
- "8a0508"+"7265706561746564"+ // field 81, encoding 2, string "repeated"
- "8405"+ // end group field 80 level 1
- "aa0605"+"6279746573"+ // field 101, encoding 2 string "bytes"
- "b0063f"+ // field 102, encoding 0, 0x3f zigzag32
- "b8067f"+ // field 103, encoding 0, 0x7f zigzag64
- "ca0c03"+"626967"+ // field 201, encoding 2, string "big"
- "ca0c04"+"6e6f7365"+ // field 201, encoding 2, string "nose"
- "d00c40"+ // field 202, encoding 0, value 32
- "d00c3f"+ // field 202, encoding 0, value -32
- "d80c8001"+ // field 203, encoding 0, value 64
- "d80c7f"+ // field 203, encoding 0, value -64
- "8a1907"+"4269676e6f7365"+ // field 401, encoding 2, string "Bignose"
- "90193f"+ // field 402, encoding 0, value 63
- "98197f") // field 403, encoding 0, value 127
-
-}
-
-// All required fields set, all packed repeated fields given two values.
-func TestEncodeDecode6(t *testing.T) {
- pb := initGoTest(false)
- pb.F_BoolRepeatedPacked = []bool{false, true}
- pb.F_Int32RepeatedPacked = []int32{32, 33}
- pb.F_Int64RepeatedPacked = []int64{64, 65}
- pb.F_Fixed32RepeatedPacked = []uint32{3232, 3333}
- pb.F_Fixed64RepeatedPacked = []uint64{6464, 6565}
- pb.F_Uint32RepeatedPacked = []uint32{323232, 333333}
- pb.F_Uint64RepeatedPacked = []uint64{646464, 656565}
- pb.F_FloatRepeatedPacked = []float32{32., 33.}
- pb.F_DoubleRepeatedPacked = []float64{64., 65.}
- pb.F_Sint32RepeatedPacked = []int32{32, -32}
- pb.F_Sint64RepeatedPacked = []int64{64, -64}
-
- overify(t, pb,
- "0807"+ // field 1, encoding 0, value 7
- "220d"+"0a056c6162656c120474797065"+ // field 4, encoding 2 (GoTestField)
- "5001"+ // field 10, encoding 0, value 1
- "5803"+ // field 11, encoding 0, value 3
- "6006"+ // field 12, encoding 0, value 6
- "6d20000000"+ // field 13, encoding 5, value 32
- "714000000000000000"+ // field 14, encoding 1, value 64
- "78a019"+ // field 15, encoding 0, value 3232
- "8001c032"+ // field 16, encoding 0, value 6464
- "8d0100004a45"+ // field 17, encoding 5, value 3232.0
- "9101000000000040b940"+ // field 18, encoding 1, value 6464.0
- "9a0106"+"737472696e67"+ // field 19, encoding 2 string "string"
- "9203020001"+ // field 50, encoding 2, 2 bytes, value 0, value 1
- "9a03022021"+ // field 51, encoding 2, 2 bytes, value 32, value 33
- "a203024041"+ // field 52, encoding 2, 2 bytes, value 64, value 65
- "aa0308"+ // field 53, encoding 2, 8 bytes
- "a00c0000050d0000"+ // value 3232, value 3333
- "b20310"+ // field 54, encoding 2, 16 bytes
- "4019000000000000a519000000000000"+ // value 6464, value 6565
- "ba0306"+ // field 55, encoding 2, 6 bytes
- "a0dd1395ac14"+ // value 323232, value 333333
- "c20306"+ // field 56, encoding 2, 6 bytes
- "c0ba27b58928"+ // value 646464, value 656565
- "ca0308"+ // field 57, encoding 2, 8 bytes
- "0000004200000442"+ // value 32.0, value 33.0
- "d20310"+ // field 58, encoding 2, 16 bytes
- "00000000000050400000000000405040"+ // value 64.0, value 65.0
- "b304"+ // start group field 70 level 1
- "ba0408"+"7265717569726564"+ // field 71, encoding 2, string "required"
- "b404"+ // end group field 70 level 1
- "aa0605"+"6279746573"+ // field 101, encoding 2 string "bytes"
- "b0063f"+ // field 102, encoding 0, 0x3f zigzag32
- "b8067f"+ // field 103, encoding 0, 0x7f zigzag64
- "b21f02"+ // field 502, encoding 2, 2 bytes
- "403f"+ // value 32, value -32
- "ba1f03"+ // field 503, encoding 2, 3 bytes
- "80017f") // value 64, value -64
-}
-
-// Test that we can encode empty bytes fields.
-func TestEncodeDecodeBytes1(t *testing.T) {
- pb := initGoTest(false)
-
- // Create our bytes
- pb.F_BytesRequired = []byte{}
- pb.F_BytesRepeated = [][]byte{{}}
- pb.F_BytesOptional = []byte{}
-
- d, err := Marshal(pb)
- if err != nil {
- t.Error(err)
- }
-
- pbd := new(GoTest)
- if err := Unmarshal(d, pbd); err != nil {
- t.Error(err)
- }
-
- if pbd.F_BytesRequired == nil || len(pbd.F_BytesRequired) != 0 {
- t.Error("required empty bytes field is incorrect")
- }
- if pbd.F_BytesRepeated == nil || len(pbd.F_BytesRepeated) == 1 && pbd.F_BytesRepeated[0] == nil {
- t.Error("repeated empty bytes field is incorrect")
- }
- if pbd.F_BytesOptional == nil || len(pbd.F_BytesOptional) != 0 {
- t.Error("optional empty bytes field is incorrect")
- }
-}
-
-// Test that we encode nil-valued fields of a repeated bytes field correctly.
-// Since entries in a repeated field cannot be nil, nil must mean empty value.
-func TestEncodeDecodeBytes2(t *testing.T) {
- pb := initGoTest(false)
-
- // Create our bytes
- pb.F_BytesRepeated = [][]byte{nil}
-
- d, err := Marshal(pb)
- if err != nil {
- t.Error(err)
- }
-
- pbd := new(GoTest)
- if err := Unmarshal(d, pbd); err != nil {
- t.Error(err)
- }
-
- if len(pbd.F_BytesRepeated) != 1 || pbd.F_BytesRepeated[0] == nil {
- t.Error("Unexpected value for repeated bytes field")
- }
-}
-
-// All required fields set, defaults provided, all repeated fields given two values.
-func TestSkippingUnrecognizedFields(t *testing.T) {
- o := old()
- pb := initGoTestField()
-
- // Marshal it normally.
- o.Marshal(pb)
-
- // Now new a GoSkipTest record.
- skip := &GoSkipTest{
- SkipInt32: Int32(32),
- SkipFixed32: Uint32(3232),
- SkipFixed64: Uint64(6464),
- SkipString: String("skipper"),
- Skipgroup: &GoSkipTest_SkipGroup{
- GroupInt32: Int32(75),
- GroupString: String("wxyz"),
- },
- }
-
- // Marshal it into same buffer.
- o.Marshal(skip)
-
- pbd := new(GoTestField)
- o.Unmarshal(pbd)
-
- // The __unrecognized field should be a marshaling of GoSkipTest
- skipd := new(GoSkipTest)
-
- o.SetBuf(pbd.XXX_unrecognized)
- o.Unmarshal(skipd)
-
- if *skipd.SkipInt32 != *skip.SkipInt32 {
- t.Error("skip int32", skipd.SkipInt32)
- }
- if *skipd.SkipFixed32 != *skip.SkipFixed32 {
- t.Error("skip fixed32", skipd.SkipFixed32)
- }
- if *skipd.SkipFixed64 != *skip.SkipFixed64 {
- t.Error("skip fixed64", skipd.SkipFixed64)
- }
- if *skipd.SkipString != *skip.SkipString {
- t.Error("skip string", *skipd.SkipString)
- }
- if *skipd.Skipgroup.GroupInt32 != *skip.Skipgroup.GroupInt32 {
- t.Error("skip group int32", skipd.Skipgroup.GroupInt32)
- }
- if *skipd.Skipgroup.GroupString != *skip.Skipgroup.GroupString {
- t.Error("skip group string", *skipd.Skipgroup.GroupString)
- }
-}
-
-// Check that unrecognized fields of a submessage are preserved.
-func TestSubmessageUnrecognizedFields(t *testing.T) {
- nm := &NewMessage{
- Nested: &NewMessage_Nested{
- Name: String("Nigel"),
- FoodGroup: String("carbs"),
- },
- }
- b, err := Marshal(nm)
- if err != nil {
- t.Fatalf("Marshal of NewMessage: %v", err)
- }
-
- // Unmarshal into an OldMessage.
- om := new(OldMessage)
- if err := Unmarshal(b, om); err != nil {
- t.Fatalf("Unmarshal to OldMessage: %v", err)
- }
- exp := &OldMessage{
- Nested: &OldMessage_Nested{
- Name: String("Nigel"),
- // normal protocol buffer users should not do this
- XXX_unrecognized: []byte("\x12\x05carbs"),
- },
- }
- if !Equal(om, exp) {
- t.Errorf("om = %v, want %v", om, exp)
- }
-
- // Clone the OldMessage.
- om = Clone(om).(*OldMessage)
- if !Equal(om, exp) {
- t.Errorf("Clone(om) = %v, want %v", om, exp)
- }
-
- // Marshal the OldMessage, then unmarshal it into an empty NewMessage.
- if b, err = Marshal(om); err != nil {
- t.Fatalf("Marshal of OldMessage: %v", err)
- }
- t.Logf("Marshal(%v) -> %q", om, b)
- nm2 := new(NewMessage)
- if err := Unmarshal(b, nm2); err != nil {
- t.Fatalf("Unmarshal to NewMessage: %v", err)
- }
- if !Equal(nm, nm2) {
- t.Errorf("NewMessage round-trip: %v => %v", nm, nm2)
- }
-}
-
-// Check that an int32 field can be upgraded to an int64 field.
-func TestNegativeInt32(t *testing.T) {
- om := &OldMessage{
- Num: Int32(-1),
- }
- b, err := Marshal(om)
- if err != nil {
- t.Fatalf("Marshal of OldMessage: %v", err)
- }
-
- // Check the size. It should be 11 bytes;
- // 1 for the field/wire type, and 10 for the negative number.
- if len(b) != 11 {
- t.Errorf("%v marshaled as %q, wanted 11 bytes", om, b)
- }
-
- // Unmarshal into a NewMessage.
- nm := new(NewMessage)
- if err := Unmarshal(b, nm); err != nil {
- t.Fatalf("Unmarshal to NewMessage: %v", err)
- }
- want := &NewMessage{
- Num: Int64(-1),
- }
- if !Equal(nm, want) {
- t.Errorf("nm = %v, want %v", nm, want)
- }
-}
-
-// Check that we can grow an array (repeated field) to have many elements.
-// This test doesn't depend only on our encoding; for variety, it makes sure
-// we create, encode, and decode the correct contents explicitly. It's therefore
-// a bit messier.
-// This test also uses (and hence tests) the Marshal/Unmarshal functions
-// instead of the methods.
-func TestBigRepeated(t *testing.T) {
- pb := initGoTest(true)
-
- // Create the arrays
- const N = 50 // Internally the library starts much smaller.
- pb.Repeatedgroup = make([]*GoTest_RepeatedGroup, N)
- pb.F_Sint64Repeated = make([]int64, N)
- pb.F_Sint32Repeated = make([]int32, N)
- pb.F_BytesRepeated = make([][]byte, N)
- pb.F_StringRepeated = make([]string, N)
- pb.F_DoubleRepeated = make([]float64, N)
- pb.F_FloatRepeated = make([]float32, N)
- pb.F_Uint64Repeated = make([]uint64, N)
- pb.F_Uint32Repeated = make([]uint32, N)
- pb.F_Fixed64Repeated = make([]uint64, N)
- pb.F_Fixed32Repeated = make([]uint32, N)
- pb.F_Int64Repeated = make([]int64, N)
- pb.F_Int32Repeated = make([]int32, N)
- pb.F_BoolRepeated = make([]bool, N)
- pb.RepeatedField = make([]*GoTestField, N)
-
- // Fill in the arrays with checkable values.
- igtf := initGoTestField()
- igtrg := initGoTest_RepeatedGroup()
- for i := 0; i < N; i++ {
- pb.Repeatedgroup[i] = igtrg
- pb.F_Sint64Repeated[i] = int64(i)
- pb.F_Sint32Repeated[i] = int32(i)
- s := fmt.Sprint(i)
- pb.F_BytesRepeated[i] = []byte(s)
- pb.F_StringRepeated[i] = s
- pb.F_DoubleRepeated[i] = float64(i)
- pb.F_FloatRepeated[i] = float32(i)
- pb.F_Uint64Repeated[i] = uint64(i)
- pb.F_Uint32Repeated[i] = uint32(i)
- pb.F_Fixed64Repeated[i] = uint64(i)
- pb.F_Fixed32Repeated[i] = uint32(i)
- pb.F_Int64Repeated[i] = int64(i)
- pb.F_Int32Repeated[i] = int32(i)
- pb.F_BoolRepeated[i] = i%2 == 0
- pb.RepeatedField[i] = igtf
- }
-
- // Marshal.
- buf, _ := Marshal(pb)
-
- // Now test Unmarshal by recreating the original buffer.
- pbd := new(GoTest)
- Unmarshal(buf, pbd)
-
- // Check the checkable values
- for i := uint64(0); i < N; i++ {
- if pbd.Repeatedgroup[i] == nil { // TODO: more checking?
- t.Error("pbd.Repeatedgroup bad")
- }
- var x uint64
- x = uint64(pbd.F_Sint64Repeated[i])
- if x != i {
- t.Error("pbd.F_Sint64Repeated bad", x, i)
- }
- x = uint64(pbd.F_Sint32Repeated[i])
- if x != i {
- t.Error("pbd.F_Sint32Repeated bad", x, i)
- }
- s := fmt.Sprint(i)
- equalbytes(pbd.F_BytesRepeated[i], []byte(s), t)
- if pbd.F_StringRepeated[i] != s {
- t.Error("pbd.F_Sint32Repeated bad", pbd.F_StringRepeated[i], i)
- }
- x = uint64(pbd.F_DoubleRepeated[i])
- if x != i {
- t.Error("pbd.F_DoubleRepeated bad", x, i)
- }
- x = uint64(pbd.F_FloatRepeated[i])
- if x != i {
- t.Error("pbd.F_FloatRepeated bad", x, i)
- }
- x = pbd.F_Uint64Repeated[i]
- if x != i {
- t.Error("pbd.F_Uint64Repeated bad", x, i)
- }
- x = uint64(pbd.F_Uint32Repeated[i])
- if x != i {
- t.Error("pbd.F_Uint32Repeated bad", x, i)
- }
- x = pbd.F_Fixed64Repeated[i]
- if x != i {
- t.Error("pbd.F_Fixed64Repeated bad", x, i)
- }
- x = uint64(pbd.F_Fixed32Repeated[i])
- if x != i {
- t.Error("pbd.F_Fixed32Repeated bad", x, i)
- }
- x = uint64(pbd.F_Int64Repeated[i])
- if x != i {
- t.Error("pbd.F_Int64Repeated bad", x, i)
- }
- x = uint64(pbd.F_Int32Repeated[i])
- if x != i {
- t.Error("pbd.F_Int32Repeated bad", x, i)
- }
- if pbd.F_BoolRepeated[i] != (i%2 == 0) {
- t.Error("pbd.F_BoolRepeated bad", x, i)
- }
- if pbd.RepeatedField[i] == nil { // TODO: more checking?
- t.Error("pbd.RepeatedField bad")
- }
- }
-}
-
-// Verify we give a useful message when decoding to the wrong structure type.
-func TestTypeMismatch(t *testing.T) {
- pb1 := initGoTest(true)
-
- // Marshal
- o := old()
- o.Marshal(pb1)
-
- // Now Unmarshal it to the wrong type.
- pb2 := initGoTestField()
- err := o.Unmarshal(pb2)
- if err == nil {
- t.Error("expected error, got no error")
- } else if !strings.Contains(err.Error(), "bad wiretype") {
- t.Error("expected bad wiretype error, got", err)
- }
-}
-
-func encodeDecode(t *testing.T, in, out Message, msg string) {
- buf, err := Marshal(in)
- if err != nil {
- t.Fatalf("failed marshaling %v: %v", msg, err)
- }
- if err := Unmarshal(buf, out); err != nil {
- t.Fatalf("failed unmarshaling %v: %v", msg, err)
- }
-}
-
-func TestPackedNonPackedDecoderSwitching(t *testing.T) {
- np, p := new(NonPackedTest), new(PackedTest)
-
- // non-packed -> packed
- np.A = []int32{0, 1, 1, 2, 3, 5}
- encodeDecode(t, np, p, "non-packed -> packed")
- if !reflect.DeepEqual(np.A, p.B) {
- t.Errorf("failed non-packed -> packed; np.A=%+v, p.B=%+v", np.A, p.B)
- }
-
- // packed -> non-packed
- np.Reset()
- p.B = []int32{3, 1, 4, 1, 5, 9}
- encodeDecode(t, p, np, "packed -> non-packed")
- if !reflect.DeepEqual(p.B, np.A) {
- t.Errorf("failed packed -> non-packed; p.B=%+v, np.A=%+v", p.B, np.A)
- }
-}
-
-func TestProto1RepeatedGroup(t *testing.T) {
- pb := &MessageList{
- Message: []*MessageList_Message{
- {
- Name: String("blah"),
- Count: Int32(7),
- },
- // NOTE: pb.Message[1] is a nil
- nil,
- },
- }
-
- o := old()
- err := o.Marshal(pb)
- if err == nil || !strings.Contains(err.Error(), "repeated field Message has nil") {
- t.Fatalf("unexpected or no error when marshaling: %v", err)
- }
-}
-
-// Test that enums work. Checks for a bug introduced by making enums
-// named types instead of int32: newInt32FromUint64 would crash with
-// a type mismatch in reflect.PointTo.
-func TestEnum(t *testing.T) {
- pb := new(GoEnum)
- pb.Foo = FOO_FOO1.Enum()
- o := old()
- if err := o.Marshal(pb); err != nil {
- t.Fatal("error encoding enum:", err)
- }
- pb1 := new(GoEnum)
- if err := o.Unmarshal(pb1); err != nil {
- t.Fatal("error decoding enum:", err)
- }
- if *pb1.Foo != FOO_FOO1 {
- t.Error("expected 7 but got ", *pb1.Foo)
- }
-}
-
-// Enum types have String methods. Check that enum fields can be printed.
-// We don't care what the value actually is, just as long as it doesn't crash.
-func TestPrintingNilEnumFields(t *testing.T) {
- pb := new(GoEnum)
- fmt.Sprintf("%+v", pb)
-}
-
-// Verify that absent required fields cause Marshal/Unmarshal to return errors.
-func TestRequiredFieldEnforcement(t *testing.T) {
- pb := new(GoTestField)
- _, err := Marshal(pb)
- if err == nil {
- t.Error("marshal: expected error, got nil")
- } else if strings.Index(err.Error(), "Label") < 0 {
- t.Errorf("marshal: bad error type: %v", err)
- }
-
- // A slightly sneaky, yet valid, proto. It encodes the same required field twice,
- // so simply counting the required fields is insufficient.
- // field 1, encoding 2, value "hi"
- buf := []byte("\x0A\x02hi\x0A\x02hi")
- err = Unmarshal(buf, pb)
- if err == nil {
- t.Error("unmarshal: expected error, got nil")
- } else if strings.Index(err.Error(), "{Unknown}") < 0 {
- t.Errorf("unmarshal: bad error type: %v", err)
- }
-}
-
-func TestTypedNilMarshal(t *testing.T) {
- // A typed nil should return ErrNil and not crash.
- _, err := Marshal((*GoEnum)(nil))
- if err != ErrNil {
- t.Errorf("Marshal: got err %v, want ErrNil", err)
- }
-}
-
-// A type that implements the Marshaler interface, but is not nillable.
-type nonNillableInt uint64
-
-func (nni nonNillableInt) Marshal() ([]byte, error) {
- return EncodeVarint(uint64(nni)), nil
-}
-
-type NNIMessage struct {
- nni nonNillableInt
-}
-
-func (*NNIMessage) Reset() {}
-func (*NNIMessage) String() string { return "" }
-func (*NNIMessage) ProtoMessage() {}
-
-// A type that implements the Marshaler interface and is nillable.
-type nillableMessage struct {
- x uint64
-}
-
-func (nm *nillableMessage) Marshal() ([]byte, error) {
- return EncodeVarint(nm.x), nil
-}
-
-type NMMessage struct {
- nm *nillableMessage
-}
-
-func (*NMMessage) Reset() {}
-func (*NMMessage) String() string { return "" }
-func (*NMMessage) ProtoMessage() {}
-
-// Verify a type that uses the Marshaler interface, but has a nil pointer.
-func TestNilMarshaler(t *testing.T) {
- // Try a struct with a Marshaler field that is nil.
- // It should be directly marshable.
- nmm := new(NMMessage)
- if _, err := Marshal(nmm); err != nil {
- t.Error("unexpected error marshaling nmm: ", err)
- }
-
- // Try a struct with a Marshaler field that is not nillable.
- nnim := new(NNIMessage)
- nnim.nni = 7
- var _ Marshaler = nnim.nni // verify it is truly a Marshaler
- if _, err := Marshal(nnim); err != nil {
- t.Error("unexpected error marshaling nnim: ", err)
- }
-}
-
-func TestAllSetDefaults(t *testing.T) {
- // Exercise SetDefaults with all scalar field types.
- m := &Defaults{
- // NaN != NaN, so override that here.
- F_Nan: Float32(1.7),
- }
- expected := &Defaults{
- F_Bool: Bool(true),
- F_Int32: Int32(32),
- F_Int64: Int64(64),
- F_Fixed32: Uint32(320),
- F_Fixed64: Uint64(640),
- F_Uint32: Uint32(3200),
- F_Uint64: Uint64(6400),
- F_Float: Float32(314159),
- F_Double: Float64(271828),
- F_String: String(`hello, "world!"` + "\n"),
- F_Bytes: []byte("Bignose"),
- F_Sint32: Int32(-32),
- F_Sint64: Int64(-64),
- F_Enum: Defaults_GREEN.Enum(),
- F_Pinf: Float32(float32(math.Inf(1))),
- F_Ninf: Float32(float32(math.Inf(-1))),
- F_Nan: Float32(1.7),
- StrZero: String(""),
- }
- SetDefaults(m)
- if !Equal(m, expected) {
- t.Errorf("SetDefaults failed\n got %v\nwant %v", m, expected)
- }
-}
-
-func TestSetDefaultsWithSetField(t *testing.T) {
- // Check that a set value is not overridden.
- m := &Defaults{
- F_Int32: Int32(12),
- }
- SetDefaults(m)
- if v := m.GetF_Int32(); v != 12 {
- t.Errorf("m.FInt32 = %v, want 12", v)
- }
-}
-
-func TestSetDefaultsWithSubMessage(t *testing.T) {
- m := &OtherMessage{
- Key: Int64(123),
- Inner: &InnerMessage{
- Host: String("gopher"),
- },
- }
- expected := &OtherMessage{
- Key: Int64(123),
- Inner: &InnerMessage{
- Host: String("gopher"),
- Port: Int32(4000),
- },
- }
- SetDefaults(m)
- if !Equal(m, expected) {
- t.Errorf("\n got %v\nwant %v", m, expected)
- }
-}
-
-func TestSetDefaultsWithRepeatedSubMessage(t *testing.T) {
- m := &MyMessage{
- RepInner: []*InnerMessage{{}},
- }
- expected := &MyMessage{
- RepInner: []*InnerMessage{{
- Port: Int32(4000),
- }},
- }
- SetDefaults(m)
- if !Equal(m, expected) {
- t.Errorf("\n got %v\nwant %v", m, expected)
- }
-}
-
-func TestSetDefaultWithRepeatedNonMessage(t *testing.T) {
- m := &MyMessage{
- Pet: []string{"turtle", "wombat"},
- }
- expected := Clone(m)
- SetDefaults(m)
- if !Equal(m, expected) {
- t.Errorf("\n got %v\nwant %v", m, expected)
- }
-}
-
-func TestMaximumTagNumber(t *testing.T) {
- m := &MaxTag{
- LastField: String("natural goat essence"),
- }
- buf, err := Marshal(m)
- if err != nil {
- t.Fatalf("proto.Marshal failed: %v", err)
- }
- m2 := new(MaxTag)
- if err := Unmarshal(buf, m2); err != nil {
- t.Fatalf("proto.Unmarshal failed: %v", err)
- }
- if got, want := m2.GetLastField(), *m.LastField; got != want {
- t.Errorf("got %q, want %q", got, want)
- }
-}
-
-func TestJSON(t *testing.T) {
- m := &MyMessage{
- Count: Int32(4),
- Pet: []string{"bunny", "kitty"},
- Inner: &InnerMessage{
- Host: String("cauchy"),
- },
- Bikeshed: MyMessage_GREEN.Enum(),
- }
- const expected = `{"count":4,"pet":["bunny","kitty"],"inner":{"host":"cauchy"},"bikeshed":1}`
-
- b, err := json.Marshal(m)
- if err != nil {
- t.Fatalf("json.Marshal failed: %v", err)
- }
- s := string(b)
- if s != expected {
- t.Errorf("got %s\nwant %s", s, expected)
- }
-
- received := new(MyMessage)
- if err := json.Unmarshal(b, received); err != nil {
- t.Fatalf("json.Unmarshal failed: %v", err)
- }
- if !Equal(received, m) {
- t.Fatalf("got %s, want %s", received, m)
- }
-
- // Test unmarshalling of JSON with symbolic enum name.
- const old = `{"count":4,"pet":["bunny","kitty"],"inner":{"host":"cauchy"},"bikeshed":"GREEN"}`
- received.Reset()
- if err := json.Unmarshal([]byte(old), received); err != nil {
- t.Fatalf("json.Unmarshal failed: %v", err)
- }
- if !Equal(received, m) {
- t.Fatalf("got %s, want %s", received, m)
- }
-}
-
-func TestBadWireType(t *testing.T) {
- b := []byte{7<<3 | 6} // field 7, wire type 6
- pb := new(OtherMessage)
- if err := Unmarshal(b, pb); err == nil {
- t.Errorf("Unmarshal did not fail")
- } else if !strings.Contains(err.Error(), "unknown wire type") {
- t.Errorf("wrong error: %v", err)
- }
-}
-
-func TestBytesWithInvalidLength(t *testing.T) {
- // If a byte sequence has an invalid (negative) length, Unmarshal should not panic.
- b := []byte{2<<3 | WireBytes, 0xff, 0xff, 0xff, 0xff, 0xff, 0}
- Unmarshal(b, new(MyMessage))
-}
-
-func TestLengthOverflow(t *testing.T) {
- // Overflowing a length should not panic.
- b := []byte{2<<3 | WireBytes, 1, 1, 3<<3 | WireBytes, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x7f, 0x01}
- Unmarshal(b, new(MyMessage))
-}
-
-func TestVarintOverflow(t *testing.T) {
- // Overflowing a 64-bit length should not be allowed.
- b := []byte{1<<3 | WireVarint, 0x01, 3<<3 | WireBytes, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x01}
- if err := Unmarshal(b, new(MyMessage)); err == nil {
- t.Fatalf("Overflowed uint64 length without error")
- }
-}
-
-func TestUnmarshalFuzz(t *testing.T) {
- const N = 1000
- seed := time.Now().UnixNano()
- t.Logf("RNG seed is %d", seed)
- rng := rand.New(rand.NewSource(seed))
- buf := make([]byte, 20)
- for i := 0; i < N; i++ {
- for j := range buf {
- buf[j] = byte(rng.Intn(256))
- }
- fuzzUnmarshal(t, buf)
- }
-}
-
-func TestMergeMessages(t *testing.T) {
- pb := &MessageList{Message: []*MessageList_Message{{Name: String("x"), Count: Int32(1)}}}
- data, err := Marshal(pb)
- if err != nil {
- t.Fatalf("Marshal: %v", err)
- }
-
- pb1 := new(MessageList)
- if err := Unmarshal(data, pb1); err != nil {
- t.Fatalf("first Unmarshal: %v", err)
- }
- if err := Unmarshal(data, pb1); err != nil {
- t.Fatalf("second Unmarshal: %v", err)
- }
- if len(pb1.Message) != 1 {
- t.Errorf("two Unmarshals produced %d Messages, want 1", len(pb1.Message))
- }
-
- pb2 := new(MessageList)
- if err := UnmarshalMerge(data, pb2); err != nil {
- t.Fatalf("first UnmarshalMerge: %v", err)
- }
- if err := UnmarshalMerge(data, pb2); err != nil {
- t.Fatalf("second UnmarshalMerge: %v", err)
- }
- if len(pb2.Message) != 2 {
- t.Errorf("two UnmarshalMerges produced %d Messages, want 2", len(pb2.Message))
- }
-}
-
-func TestExtensionMarshalOrder(t *testing.T) {
- m := &MyMessage{Count: Int(123)}
- if err := SetExtension(m, E_Ext_More, &Ext{Data: String("alpha")}); err != nil {
- t.Fatalf("SetExtension: %v", err)
- }
- if err := SetExtension(m, E_Ext_Text, String("aleph")); err != nil {
- t.Fatalf("SetExtension: %v", err)
- }
- if err := SetExtension(m, E_Ext_Number, Int32(1)); err != nil {
- t.Fatalf("SetExtension: %v", err)
- }
-
- // Serialize m several times, and check we get the same bytes each time.
- var orig []byte
- for i := 0; i < 100; i++ {
- b, err := Marshal(m)
- if err != nil {
- t.Fatalf("Marshal: %v", err)
- }
- if i == 0 {
- orig = b
- continue
- }
- if !bytes.Equal(b, orig) {
- t.Errorf("Bytes differ on attempt #%d", i)
- }
- }
-}
-
-// Many extensions, because small maps might not iterate differently on each iteration.
-var exts = []*ExtensionDesc{
- E_X201,
- E_X202,
- E_X203,
- E_X204,
- E_X205,
- E_X206,
- E_X207,
- E_X208,
- E_X209,
- E_X210,
- E_X211,
- E_X212,
- E_X213,
- E_X214,
- E_X215,
- E_X216,
- E_X217,
- E_X218,
- E_X219,
- E_X220,
- E_X221,
- E_X222,
- E_X223,
- E_X224,
- E_X225,
- E_X226,
- E_X227,
- E_X228,
- E_X229,
- E_X230,
- E_X231,
- E_X232,
- E_X233,
- E_X234,
- E_X235,
- E_X236,
- E_X237,
- E_X238,
- E_X239,
- E_X240,
- E_X241,
- E_X242,
- E_X243,
- E_X244,
- E_X245,
- E_X246,
- E_X247,
- E_X248,
- E_X249,
- E_X250,
-}
-
-func TestMessageSetMarshalOrder(t *testing.T) {
- m := &MyMessageSet{}
- for _, x := range exts {
- if err := SetExtension(m, x, &Empty{}); err != nil {
- t.Fatalf("SetExtension: %v", err)
- }
- }
-
- buf, err := Marshal(m)
- if err != nil {
- t.Fatalf("Marshal: %v", err)
- }
-
- // Serialize m several times, and check we get the same bytes each time.
- for i := 0; i < 10; i++ {
- b1, err := Marshal(m)
- if err != nil {
- t.Fatalf("Marshal: %v", err)
- }
- if !bytes.Equal(b1, buf) {
- t.Errorf("Bytes differ on re-Marshal #%d", i)
- }
-
- m2 := &MyMessageSet{}
- if err := Unmarshal(buf, m2); err != nil {
- t.Errorf("Unmarshal: %v", err)
- }
- b2, err := Marshal(m2)
- if err != nil {
- t.Errorf("re-Marshal: %v", err)
- }
- if !bytes.Equal(b2, buf) {
- t.Errorf("Bytes differ on round-trip #%d", i)
- }
- }
-}
-
-func TestUnmarshalMergesMessages(t *testing.T) {
- // If a nested message occurs twice in the input,
- // the fields should be merged when decoding.
- a := &OtherMessage{
- Key: Int64(123),
- Inner: &InnerMessage{
- Host: String("polhode"),
- Port: Int32(1234),
- },
- }
- aData, err := Marshal(a)
- if err != nil {
- t.Fatalf("Marshal(a): %v", err)
- }
- b := &OtherMessage{
- Weight: Float32(1.2),
- Inner: &InnerMessage{
- Host: String("herpolhode"),
- Connected: Bool(true),
- },
- }
- bData, err := Marshal(b)
- if err != nil {
- t.Fatalf("Marshal(b): %v", err)
- }
- want := &OtherMessage{
- Key: Int64(123),
- Weight: Float32(1.2),
- Inner: &InnerMessage{
- Host: String("herpolhode"),
- Port: Int32(1234),
- Connected: Bool(true),
- },
- }
- got := new(OtherMessage)
- if err := Unmarshal(append(aData, bData...), got); err != nil {
- t.Fatalf("Unmarshal: %v", err)
- }
- if !Equal(got, want) {
- t.Errorf("\n got %v\nwant %v", got, want)
- }
-}
-
-func TestEncodingSizes(t *testing.T) {
- tests := []struct {
- m Message
- n int
- }{
- {&Defaults{F_Int32: Int32(math.MaxInt32)}, 6},
- {&Defaults{F_Int32: Int32(math.MinInt32)}, 11},
- {&Defaults{F_Uint32: Uint32(uint32(math.MaxInt32) + 1)}, 6},
- {&Defaults{F_Uint32: Uint32(math.MaxUint32)}, 6},
- }
- for _, test := range tests {
- b, err := Marshal(test.m)
- if err != nil {
- t.Errorf("Marshal(%v): %v", test.m, err)
- continue
- }
- if len(b) != test.n {
- t.Errorf("Marshal(%v) yielded %d bytes, want %d bytes", test.m, len(b), test.n)
- }
- }
-}
-
-func TestRequiredNotSetError(t *testing.T) {
- pb := initGoTest(false)
- pb.RequiredField.Label = nil
- pb.F_Int32Required = nil
- pb.F_Int64Required = nil
-
- expected := "0807" + // field 1, encoding 0, value 7
- "2206" + "120474797065" + // field 4, encoding 2 (GoTestField)
- "5001" + // field 10, encoding 0, value 1
- "6d20000000" + // field 13, encoding 5, value 0x20
- "714000000000000000" + // field 14, encoding 1, value 0x40
- "78a019" + // field 15, encoding 0, value 0xca0 = 3232
- "8001c032" + // field 16, encoding 0, value 0x1940 = 6464
- "8d0100004a45" + // field 17, encoding 5, value 3232.0
- "9101000000000040b940" + // field 18, encoding 1, value 6464.0
- "9a0106" + "737472696e67" + // field 19, encoding 2, string "string"
- "b304" + // field 70, encoding 3, start group
- "ba0408" + "7265717569726564" + // field 71, encoding 2, string "required"
- "b404" + // field 70, encoding 4, end group
- "aa0605" + "6279746573" + // field 101, encoding 2, string "bytes"
- "b0063f" + // field 102, encoding 0, 0x3f zigzag32
- "b8067f" // field 103, encoding 0, 0x7f zigzag64
-
- o := old()
- bytes, err := Marshal(pb)
- if _, ok := err.(*RequiredNotSetError); !ok {
- fmt.Printf("marshal-1 err = %v, want *RequiredNotSetError", err)
- o.DebugPrint("", bytes)
- t.Fatalf("expected = %s", expected)
- }
- if strings.Index(err.Error(), "RequiredField.Label") < 0 {
- t.Errorf("marshal-1 wrong err msg: %v", err)
- }
- if !equal(bytes, expected, t) {
- o.DebugPrint("neq 1", bytes)
- t.Fatalf("expected = %s", expected)
- }
-
- // Now test Unmarshal by recreating the original buffer.
- pbd := new(GoTest)
- err = Unmarshal(bytes, pbd)
- if _, ok := err.(*RequiredNotSetError); !ok {
- t.Fatalf("unmarshal err = %v, want *RequiredNotSetError", err)
- o.DebugPrint("", bytes)
- t.Fatalf("string = %s", expected)
- }
- if strings.Index(err.Error(), "RequiredField.{Unknown}") < 0 {
- t.Errorf("unmarshal wrong err msg: %v", err)
- }
- bytes, err = Marshal(pbd)
- if _, ok := err.(*RequiredNotSetError); !ok {
- t.Errorf("marshal-2 err = %v, want *RequiredNotSetError", err)
- o.DebugPrint("", bytes)
- t.Fatalf("string = %s", expected)
- }
- if strings.Index(err.Error(), "RequiredField.Label") < 0 {
- t.Errorf("marshal-2 wrong err msg: %v", err)
- }
- if !equal(bytes, expected, t) {
- o.DebugPrint("neq 2", bytes)
- t.Fatalf("string = %s", expected)
- }
-}
-
-func fuzzUnmarshal(t *testing.T, data []byte) {
- defer func() {
- if e := recover(); e != nil {
- t.Errorf("These bytes caused a panic: %+v", data)
- t.Logf("Stack:\n%s", debug.Stack())
- t.FailNow()
- }
- }()
-
- pb := new(MyMessage)
- Unmarshal(data, pb)
-}
-
-func TestMapFieldMarshal(t *testing.T) {
- m := &MessageWithMap{
- NameMapping: map[int32]string{
- 1: "Rob",
- 4: "Ian",
- 8: "Dave",
- },
- }
- b, err := Marshal(m)
- if err != nil {
- t.Fatalf("Marshal: %v", err)
- }
-
- // b should be the concatenation of these three byte sequences in some order.
- parts := []string{
- "\n\a\b\x01\x12\x03Rob",
- "\n\a\b\x04\x12\x03Ian",
- "\n\b\b\x08\x12\x04Dave",
- }
- ok := false
- for i := range parts {
- for j := range parts {
- if j == i {
- continue
- }
- for k := range parts {
- if k == i || k == j {
- continue
- }
- try := parts[i] + parts[j] + parts[k]
- if bytes.Equal(b, []byte(try)) {
- ok = true
- break
- }
- }
- }
- }
- if !ok {
- t.Fatalf("Incorrect Marshal output.\n got %q\nwant %q (or a permutation of that)", b, parts[0]+parts[1]+parts[2])
- }
- t.Logf("FYI b: %q", b)
-
- (new(Buffer)).DebugPrint("Dump of b", b)
-}
-
-func TestMapFieldRoundTrips(t *testing.T) {
- m := &MessageWithMap{
- NameMapping: map[int32]string{
- 1: "Rob",
- 4: "Ian",
- 8: "Dave",
- },
- MsgMapping: map[int64]*FloatingPoint{
- 0x7001: &FloatingPoint{F: Float64(2.0)},
- },
- ByteMapping: map[bool][]byte{
- false: []byte("that's not right!"),
- true: []byte("aye, 'tis true!"),
- },
- }
- b, err := Marshal(m)
- if err != nil {
- t.Fatalf("Marshal: %v", err)
- }
- t.Logf("FYI b: %q", b)
- m2 := new(MessageWithMap)
- if err := Unmarshal(b, m2); err != nil {
- t.Fatalf("Unmarshal: %v", err)
- }
- for _, pair := range [][2]interface{}{
- {m.NameMapping, m2.NameMapping},
- {m.MsgMapping, m2.MsgMapping},
- {m.ByteMapping, m2.ByteMapping},
- } {
- if !reflect.DeepEqual(pair[0], pair[1]) {
- t.Errorf("Map did not survive a round trip.\ninitial: %v\n final: %v", pair[0], pair[1])
- }
- }
-}
-
-func TestMapFieldWithNil(t *testing.T) {
- m := &MessageWithMap{
- MsgMapping: map[int64]*FloatingPoint{
- 1: nil,
- },
- }
- b, err := Marshal(m)
- if err == nil {
- t.Fatalf("Marshal of bad map should have failed, got these bytes: %v", b)
- }
-}
-
-// Benchmarks
-
-func testMsg() *GoTest {
- pb := initGoTest(true)
- const N = 1000 // Internally the library starts much smaller.
- pb.F_Int32Repeated = make([]int32, N)
- pb.F_DoubleRepeated = make([]float64, N)
- for i := 0; i < N; i++ {
- pb.F_Int32Repeated[i] = int32(i)
- pb.F_DoubleRepeated[i] = float64(i)
- }
- return pb
-}
-
-func bytesMsg() *GoTest {
- pb := initGoTest(true)
- buf := make([]byte, 4000)
- for i := range buf {
- buf[i] = byte(i)
- }
- pb.F_BytesDefaulted = buf
- return pb
-}
-
-func benchmarkMarshal(b *testing.B, pb Message, marshal func(Message) ([]byte, error)) {
- d, _ := marshal(pb)
- b.SetBytes(int64(len(d)))
- b.ResetTimer()
- for i := 0; i < b.N; i++ {
- marshal(pb)
- }
-}
-
-func benchmarkBufferMarshal(b *testing.B, pb Message) {
- p := NewBuffer(nil)
- benchmarkMarshal(b, pb, func(pb0 Message) ([]byte, error) {
- p.Reset()
- err := p.Marshal(pb0)
- return p.Bytes(), err
- })
-}
-
-func benchmarkSize(b *testing.B, pb Message) {
- benchmarkMarshal(b, pb, func(pb0 Message) ([]byte, error) {
- Size(pb)
- return nil, nil
- })
-}
-
-func newOf(pb Message) Message {
- in := reflect.ValueOf(pb)
- if in.IsNil() {
- return pb
- }
- return reflect.New(in.Type().Elem()).Interface().(Message)
-}
-
-func benchmarkUnmarshal(b *testing.B, pb Message, unmarshal func([]byte, Message) error) {
- d, _ := Marshal(pb)
- b.SetBytes(int64(len(d)))
- pbd := newOf(pb)
-
- b.ResetTimer()
- for i := 0; i < b.N; i++ {
- unmarshal(d, pbd)
- }
-}
-
-func benchmarkBufferUnmarshal(b *testing.B, pb Message) {
- p := NewBuffer(nil)
- benchmarkUnmarshal(b, pb, func(d []byte, pb0 Message) error {
- p.SetBuf(d)
- return p.Unmarshal(pb0)
- })
-}
-
-// Benchmark{Marshal,BufferMarshal,Size,Unmarshal,BufferUnmarshal}{,Bytes}
-
-func BenchmarkMarshal(b *testing.B) {
- benchmarkMarshal(b, testMsg(), Marshal)
-}
-
-func BenchmarkBufferMarshal(b *testing.B) {
- benchmarkBufferMarshal(b, testMsg())
-}
-
-func BenchmarkSize(b *testing.B) {
- benchmarkSize(b, testMsg())
-}
-
-func BenchmarkUnmarshal(b *testing.B) {
- benchmarkUnmarshal(b, testMsg(), Unmarshal)
-}
-
-func BenchmarkBufferUnmarshal(b *testing.B) {
- benchmarkBufferUnmarshal(b, testMsg())
-}
-
-func BenchmarkMarshalBytes(b *testing.B) {
- benchmarkMarshal(b, bytesMsg(), Marshal)
-}
-
-func BenchmarkBufferMarshalBytes(b *testing.B) {
- benchmarkBufferMarshal(b, bytesMsg())
-}
-
-func BenchmarkSizeBytes(b *testing.B) {
- benchmarkSize(b, bytesMsg())
-}
-
-func BenchmarkUnmarshalBytes(b *testing.B) {
- benchmarkUnmarshal(b, bytesMsg(), Unmarshal)
-}
-
-func BenchmarkBufferUnmarshalBytes(b *testing.B) {
- benchmarkBufferUnmarshal(b, bytesMsg())
-}
-
-func BenchmarkUnmarshalUnrecognizedFields(b *testing.B) {
- b.StopTimer()
- pb := initGoTestField()
- skip := &GoSkipTest{
- SkipInt32: Int32(32),
- SkipFixed32: Uint32(3232),
- SkipFixed64: Uint64(6464),
- SkipString: String("skipper"),
- Skipgroup: &GoSkipTest_SkipGroup{
- GroupInt32: Int32(75),
- GroupString: String("wxyz"),
- },
- }
-
- pbd := new(GoTestField)
- p := NewBuffer(nil)
- p.Marshal(pb)
- p.Marshal(skip)
- p2 := NewBuffer(nil)
-
- b.StartTimer()
- for i := 0; i < b.N; i++ {
- p2.SetBuf(p.Bytes())
- p2.Unmarshal(pbd)
- }
-}
diff --git a/vendor/github.com/golang/protobuf/proto/clone_test.go b/vendor/github.com/golang/protobuf/proto/clone_test.go
deleted file mode 100644
index a1c697bc..00000000
--- a/vendor/github.com/golang/protobuf/proto/clone_test.go
+++ /dev/null
@@ -1,245 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2011 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-package proto_test
-
-import (
- "testing"
-
- "github.com/golang/protobuf/proto"
-
- proto3pb "github.com/golang/protobuf/proto/proto3_proto"
- pb "github.com/golang/protobuf/proto/testdata"
-)
-
-var cloneTestMessage = &pb.MyMessage{
- Count: proto.Int32(42),
- Name: proto.String("Dave"),
- Pet: []string{"bunny", "kitty", "horsey"},
- Inner: &pb.InnerMessage{
- Host: proto.String("niles"),
- Port: proto.Int32(9099),
- Connected: proto.Bool(true),
- },
- Others: []*pb.OtherMessage{
- {
- Value: []byte("some bytes"),
- },
- },
- Somegroup: &pb.MyMessage_SomeGroup{
- GroupField: proto.Int32(6),
- },
- RepBytes: [][]byte{[]byte("sham"), []byte("wow")},
-}
-
-func init() {
- ext := &pb.Ext{
- Data: proto.String("extension"),
- }
- if err := proto.SetExtension(cloneTestMessage, pb.E_Ext_More, ext); err != nil {
- panic("SetExtension: " + err.Error())
- }
-}
-
-func TestClone(t *testing.T) {
- m := proto.Clone(cloneTestMessage).(*pb.MyMessage)
- if !proto.Equal(m, cloneTestMessage) {
- t.Errorf("Clone(%v) = %v", cloneTestMessage, m)
- }
-
- // Verify it was a deep copy.
- *m.Inner.Port++
- if proto.Equal(m, cloneTestMessage) {
- t.Error("Mutating clone changed the original")
- }
- // Byte fields and repeated fields should be copied.
- if &m.Pet[0] == &cloneTestMessage.Pet[0] {
- t.Error("Pet: repeated field not copied")
- }
- if &m.Others[0] == &cloneTestMessage.Others[0] {
- t.Error("Others: repeated field not copied")
- }
- if &m.Others[0].Value[0] == &cloneTestMessage.Others[0].Value[0] {
- t.Error("Others[0].Value: bytes field not copied")
- }
- if &m.RepBytes[0] == &cloneTestMessage.RepBytes[0] {
- t.Error("RepBytes: repeated field not copied")
- }
- if &m.RepBytes[0][0] == &cloneTestMessage.RepBytes[0][0] {
- t.Error("RepBytes[0]: bytes field not copied")
- }
-}
-
-func TestCloneNil(t *testing.T) {
- var m *pb.MyMessage
- if c := proto.Clone(m); !proto.Equal(m, c) {
- t.Errorf("Clone(%v) = %v", m, c)
- }
-}
-
-var mergeTests = []struct {
- src, dst, want proto.Message
-}{
- {
- src: &pb.MyMessage{
- Count: proto.Int32(42),
- },
- dst: &pb.MyMessage{
- Name: proto.String("Dave"),
- },
- want: &pb.MyMessage{
- Count: proto.Int32(42),
- Name: proto.String("Dave"),
- },
- },
- {
- src: &pb.MyMessage{
- Inner: &pb.InnerMessage{
- Host: proto.String("hey"),
- Connected: proto.Bool(true),
- },
- Pet: []string{"horsey"},
- Others: []*pb.OtherMessage{
- {
- Value: []byte("some bytes"),
- },
- },
- },
- dst: &pb.MyMessage{
- Inner: &pb.InnerMessage{
- Host: proto.String("niles"),
- Port: proto.Int32(9099),
- },
- Pet: []string{"bunny", "kitty"},
- Others: []*pb.OtherMessage{
- {
- Key: proto.Int64(31415926535),
- },
- {
- // Explicitly test a src=nil field
- Inner: nil,
- },
- },
- },
- want: &pb.MyMessage{
- Inner: &pb.InnerMessage{
- Host: proto.String("hey"),
- Connected: proto.Bool(true),
- Port: proto.Int32(9099),
- },
- Pet: []string{"bunny", "kitty", "horsey"},
- Others: []*pb.OtherMessage{
- {
- Key: proto.Int64(31415926535),
- },
- {},
- {
- Value: []byte("some bytes"),
- },
- },
- },
- },
- {
- src: &pb.MyMessage{
- RepBytes: [][]byte{[]byte("wow")},
- },
- dst: &pb.MyMessage{
- Somegroup: &pb.MyMessage_SomeGroup{
- GroupField: proto.Int32(6),
- },
- RepBytes: [][]byte{[]byte("sham")},
- },
- want: &pb.MyMessage{
- Somegroup: &pb.MyMessage_SomeGroup{
- GroupField: proto.Int32(6),
- },
- RepBytes: [][]byte{[]byte("sham"), []byte("wow")},
- },
- },
- // Check that a scalar bytes field replaces rather than appends.
- {
- src: &pb.OtherMessage{Value: []byte("foo")},
- dst: &pb.OtherMessage{Value: []byte("bar")},
- want: &pb.OtherMessage{Value: []byte("foo")},
- },
- {
- src: &pb.MessageWithMap{
- NameMapping: map[int32]string{6: "Nigel"},
- MsgMapping: map[int64]*pb.FloatingPoint{
- 0x4001: &pb.FloatingPoint{F: proto.Float64(2.0)},
- },
- ByteMapping: map[bool][]byte{true: []byte("wowsa")},
- },
- dst: &pb.MessageWithMap{
- NameMapping: map[int32]string{
- 6: "Bruce", // should be overwritten
- 7: "Andrew",
- },
- },
- want: &pb.MessageWithMap{
- NameMapping: map[int32]string{
- 6: "Nigel",
- 7: "Andrew",
- },
- MsgMapping: map[int64]*pb.FloatingPoint{
- 0x4001: &pb.FloatingPoint{F: proto.Float64(2.0)},
- },
- ByteMapping: map[bool][]byte{true: []byte("wowsa")},
- },
- },
- // proto3 shouldn't merge zero values,
- // in the same way that proto2 shouldn't merge nils.
- {
- src: &proto3pb.Message{
- Name: "Aaron",
- Data: []byte(""), // zero value, but not nil
- },
- dst: &proto3pb.Message{
- HeightInCm: 176,
- Data: []byte("texas!"),
- },
- want: &proto3pb.Message{
- Name: "Aaron",
- HeightInCm: 176,
- Data: []byte("texas!"),
- },
- },
-}
-
-func TestMerge(t *testing.T) {
- for _, m := range mergeTests {
- got := proto.Clone(m.dst)
- proto.Merge(got, m.src)
- if !proto.Equal(got, m.want) {
- t.Errorf("Merge(%v, %v)\n got %v\nwant %v\n", m.dst, m.src, got, m.want)
- }
- }
-}
diff --git a/vendor/github.com/golang/protobuf/proto/equal_test.go b/vendor/github.com/golang/protobuf/proto/equal_test.go
deleted file mode 100644
index b322f65a..00000000
--- a/vendor/github.com/golang/protobuf/proto/equal_test.go
+++ /dev/null
@@ -1,191 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2011 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-package proto_test
-
-import (
- "testing"
-
- . "github.com/golang/protobuf/proto"
- pb "github.com/golang/protobuf/proto/testdata"
-)
-
-// Four identical base messages.
-// The init function adds extensions to some of them.
-var messageWithoutExtension = &pb.MyMessage{Count: Int32(7)}
-var messageWithExtension1a = &pb.MyMessage{Count: Int32(7)}
-var messageWithExtension1b = &pb.MyMessage{Count: Int32(7)}
-var messageWithExtension2 = &pb.MyMessage{Count: Int32(7)}
-
-// Two messages with non-message extensions.
-var messageWithInt32Extension1 = &pb.MyMessage{Count: Int32(8)}
-var messageWithInt32Extension2 = &pb.MyMessage{Count: Int32(8)}
-
-func init() {
- ext1 := &pb.Ext{Data: String("Kirk")}
- ext2 := &pb.Ext{Data: String("Picard")}
-
- // messageWithExtension1a has ext1, but never marshals it.
- if err := SetExtension(messageWithExtension1a, pb.E_Ext_More, ext1); err != nil {
- panic("SetExtension on 1a failed: " + err.Error())
- }
-
- // messageWithExtension1b is the unmarshaled form of messageWithExtension1a.
- if err := SetExtension(messageWithExtension1b, pb.E_Ext_More, ext1); err != nil {
- panic("SetExtension on 1b failed: " + err.Error())
- }
- buf, err := Marshal(messageWithExtension1b)
- if err != nil {
- panic("Marshal of 1b failed: " + err.Error())
- }
- messageWithExtension1b.Reset()
- if err := Unmarshal(buf, messageWithExtension1b); err != nil {
- panic("Unmarshal of 1b failed: " + err.Error())
- }
-
- // messageWithExtension2 has ext2.
- if err := SetExtension(messageWithExtension2, pb.E_Ext_More, ext2); err != nil {
- panic("SetExtension on 2 failed: " + err.Error())
- }
-
- if err := SetExtension(messageWithInt32Extension1, pb.E_Ext_Number, Int32(23)); err != nil {
- panic("SetExtension on Int32-1 failed: " + err.Error())
- }
- if err := SetExtension(messageWithInt32Extension1, pb.E_Ext_Number, Int32(24)); err != nil {
- panic("SetExtension on Int32-2 failed: " + err.Error())
- }
-}
-
-var EqualTests = []struct {
- desc string
- a, b Message
- exp bool
-}{
- {"different types", &pb.GoEnum{}, &pb.GoTestField{}, false},
- {"equal empty", &pb.GoEnum{}, &pb.GoEnum{}, true},
- {"nil vs nil", nil, nil, true},
- {"typed nil vs typed nil", (*pb.GoEnum)(nil), (*pb.GoEnum)(nil), true},
- {"typed nil vs empty", (*pb.GoEnum)(nil), &pb.GoEnum{}, false},
- {"different typed nil", (*pb.GoEnum)(nil), (*pb.GoTestField)(nil), false},
-
- {"one set field, one unset field", &pb.GoTestField{Label: String("foo")}, &pb.GoTestField{}, false},
- {"one set field zero, one unset field", &pb.GoTest{Param: Int32(0)}, &pb.GoTest{}, false},
- {"different set fields", &pb.GoTestField{Label: String("foo")}, &pb.GoTestField{Label: String("bar")}, false},
- {"equal set", &pb.GoTestField{Label: String("foo")}, &pb.GoTestField{Label: String("foo")}, true},
-
- {"repeated, one set", &pb.GoTest{F_Int32Repeated: []int32{2, 3}}, &pb.GoTest{}, false},
- {"repeated, different length", &pb.GoTest{F_Int32Repeated: []int32{2, 3}}, &pb.GoTest{F_Int32Repeated: []int32{2}}, false},
- {"repeated, different value", &pb.GoTest{F_Int32Repeated: []int32{2}}, &pb.GoTest{F_Int32Repeated: []int32{3}}, false},
- {"repeated, equal", &pb.GoTest{F_Int32Repeated: []int32{2, 4}}, &pb.GoTest{F_Int32Repeated: []int32{2, 4}}, true},
- {"repeated, nil equal nil", &pb.GoTest{F_Int32Repeated: nil}, &pb.GoTest{F_Int32Repeated: nil}, true},
- {"repeated, nil equal empty", &pb.GoTest{F_Int32Repeated: nil}, &pb.GoTest{F_Int32Repeated: []int32{}}, true},
- {"repeated, empty equal nil", &pb.GoTest{F_Int32Repeated: []int32{}}, &pb.GoTest{F_Int32Repeated: nil}, true},
-
- {
- "nested, different",
- &pb.GoTest{RequiredField: &pb.GoTestField{Label: String("foo")}},
- &pb.GoTest{RequiredField: &pb.GoTestField{Label: String("bar")}},
- false,
- },
- {
- "nested, equal",
- &pb.GoTest{RequiredField: &pb.GoTestField{Label: String("wow")}},
- &pb.GoTest{RequiredField: &pb.GoTestField{Label: String("wow")}},
- true,
- },
-
- {"bytes", &pb.OtherMessage{Value: []byte("foo")}, &pb.OtherMessage{Value: []byte("foo")}, true},
- {"bytes, empty", &pb.OtherMessage{Value: []byte{}}, &pb.OtherMessage{Value: []byte{}}, true},
- {"bytes, empty vs nil", &pb.OtherMessage{Value: []byte{}}, &pb.OtherMessage{Value: nil}, false},
- {
- "repeated bytes",
- &pb.MyMessage{RepBytes: [][]byte{[]byte("sham"), []byte("wow")}},
- &pb.MyMessage{RepBytes: [][]byte{[]byte("sham"), []byte("wow")}},
- true,
- },
-
- {"extension vs. no extension", messageWithoutExtension, messageWithExtension1a, false},
- {"extension vs. same extension", messageWithExtension1a, messageWithExtension1b, true},
- {"extension vs. different extension", messageWithExtension1a, messageWithExtension2, false},
-
- {"int32 extension vs. itself", messageWithInt32Extension1, messageWithInt32Extension1, true},
- {"int32 extension vs. a different int32", messageWithInt32Extension1, messageWithInt32Extension2, false},
-
- {
- "message with group",
- &pb.MyMessage{
- Count: Int32(1),
- Somegroup: &pb.MyMessage_SomeGroup{
- GroupField: Int32(5),
- },
- },
- &pb.MyMessage{
- Count: Int32(1),
- Somegroup: &pb.MyMessage_SomeGroup{
- GroupField: Int32(5),
- },
- },
- true,
- },
-
- {
- "map same",
- &pb.MessageWithMap{NameMapping: map[int32]string{1: "Ken"}},
- &pb.MessageWithMap{NameMapping: map[int32]string{1: "Ken"}},
- true,
- },
- {
- "map different entry",
- &pb.MessageWithMap{NameMapping: map[int32]string{1: "Ken"}},
- &pb.MessageWithMap{NameMapping: map[int32]string{2: "Rob"}},
- false,
- },
- {
- "map different key only",
- &pb.MessageWithMap{NameMapping: map[int32]string{1: "Ken"}},
- &pb.MessageWithMap{NameMapping: map[int32]string{2: "Ken"}},
- false,
- },
- {
- "map different value only",
- &pb.MessageWithMap{NameMapping: map[int32]string{1: "Ken"}},
- &pb.MessageWithMap{NameMapping: map[int32]string{1: "Rob"}},
- false,
- },
-}
-
-func TestEqual(t *testing.T) {
- for _, tc := range EqualTests {
- if res := Equal(tc.a, tc.b); res != tc.exp {
- t.Errorf("%v: Equal(%v, %v) = %v, want %v", tc.desc, tc.a, tc.b, res, tc.exp)
- }
- }
-}
diff --git a/vendor/github.com/golang/protobuf/proto/extensions_test.go b/vendor/github.com/golang/protobuf/proto/extensions_test.go
deleted file mode 100644
index 72552767..00000000
--- a/vendor/github.com/golang/protobuf/proto/extensions_test.go
+++ /dev/null
@@ -1,292 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2014 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-package proto_test
-
-import (
- "fmt"
- "reflect"
- "testing"
-
- "github.com/golang/protobuf/proto"
- pb "github.com/golang/protobuf/proto/testdata"
-)
-
-func TestGetExtensionsWithMissingExtensions(t *testing.T) {
- msg := &pb.MyMessage{}
- ext1 := &pb.Ext{}
- if err := proto.SetExtension(msg, pb.E_Ext_More, ext1); err != nil {
- t.Fatalf("Could not set ext1: %s", ext1)
- }
- exts, err := proto.GetExtensions(msg, []*proto.ExtensionDesc{
- pb.E_Ext_More,
- pb.E_Ext_Text,
- })
- if err != nil {
- t.Fatalf("GetExtensions() failed: %s", err)
- }
- if exts[0] != ext1 {
- t.Errorf("ext1 not in returned extensions: %T %v", exts[0], exts[0])
- }
- if exts[1] != nil {
- t.Errorf("ext2 in returned extensions: %T %v", exts[1], exts[1])
- }
-}
-
-func TestGetExtensionStability(t *testing.T) {
- check := func(m *pb.MyMessage) bool {
- ext1, err := proto.GetExtension(m, pb.E_Ext_More)
- if err != nil {
- t.Fatalf("GetExtension() failed: %s", err)
- }
- ext2, err := proto.GetExtension(m, pb.E_Ext_More)
- if err != nil {
- t.Fatalf("GetExtension() failed: %s", err)
- }
- return ext1 == ext2
- }
- msg := &pb.MyMessage{Count: proto.Int32(4)}
- ext0 := &pb.Ext{}
- if err := proto.SetExtension(msg, pb.E_Ext_More, ext0); err != nil {
- t.Fatalf("Could not set ext1: %s", ext0)
- }
- if !check(msg) {
- t.Errorf("GetExtension() not stable before marshaling")
- }
- bb, err := proto.Marshal(msg)
- if err != nil {
- t.Fatalf("Marshal() failed: %s", err)
- }
- msg1 := &pb.MyMessage{}
- err = proto.Unmarshal(bb, msg1)
- if err != nil {
- t.Fatalf("Unmarshal() failed: %s", err)
- }
- if !check(msg1) {
- t.Errorf("GetExtension() not stable after unmarshaling")
- }
-}
-
-func TestGetExtensionDefaults(t *testing.T) {
- var setFloat64 float64 = 1
- var setFloat32 float32 = 2
- var setInt32 int32 = 3
- var setInt64 int64 = 4
- var setUint32 uint32 = 5
- var setUint64 uint64 = 6
- var setBool = true
- var setBool2 = false
- var setString = "Goodnight string"
- var setBytes = []byte("Goodnight bytes")
- var setEnum = pb.DefaultsMessage_TWO
-
- type testcase struct {
- ext *proto.ExtensionDesc // Extension we are testing.
- want interface{} // Expected value of extension, or nil (meaning that GetExtension will fail).
- def interface{} // Expected value of extension after ClearExtension().
- }
- tests := []testcase{
- {pb.E_NoDefaultDouble, setFloat64, nil},
- {pb.E_NoDefaultFloat, setFloat32, nil},
- {pb.E_NoDefaultInt32, setInt32, nil},
- {pb.E_NoDefaultInt64, setInt64, nil},
- {pb.E_NoDefaultUint32, setUint32, nil},
- {pb.E_NoDefaultUint64, setUint64, nil},
- {pb.E_NoDefaultSint32, setInt32, nil},
- {pb.E_NoDefaultSint64, setInt64, nil},
- {pb.E_NoDefaultFixed32, setUint32, nil},
- {pb.E_NoDefaultFixed64, setUint64, nil},
- {pb.E_NoDefaultSfixed32, setInt32, nil},
- {pb.E_NoDefaultSfixed64, setInt64, nil},
- {pb.E_NoDefaultBool, setBool, nil},
- {pb.E_NoDefaultBool, setBool2, nil},
- {pb.E_NoDefaultString, setString, nil},
- {pb.E_NoDefaultBytes, setBytes, nil},
- {pb.E_NoDefaultEnum, setEnum, nil},
- {pb.E_DefaultDouble, setFloat64, float64(3.1415)},
- {pb.E_DefaultFloat, setFloat32, float32(3.14)},
- {pb.E_DefaultInt32, setInt32, int32(42)},
- {pb.E_DefaultInt64, setInt64, int64(43)},
- {pb.E_DefaultUint32, setUint32, uint32(44)},
- {pb.E_DefaultUint64, setUint64, uint64(45)},
- {pb.E_DefaultSint32, setInt32, int32(46)},
- {pb.E_DefaultSint64, setInt64, int64(47)},
- {pb.E_DefaultFixed32, setUint32, uint32(48)},
- {pb.E_DefaultFixed64, setUint64, uint64(49)},
- {pb.E_DefaultSfixed32, setInt32, int32(50)},
- {pb.E_DefaultSfixed64, setInt64, int64(51)},
- {pb.E_DefaultBool, setBool, true},
- {pb.E_DefaultBool, setBool2, true},
- {pb.E_DefaultString, setString, "Hello, string"},
- {pb.E_DefaultBytes, setBytes, []byte("Hello, bytes")},
- {pb.E_DefaultEnum, setEnum, pb.DefaultsMessage_ONE},
- }
-
- checkVal := func(test testcase, msg *pb.DefaultsMessage, valWant interface{}) error {
- val, err := proto.GetExtension(msg, test.ext)
- if err != nil {
- if valWant != nil {
- return fmt.Errorf("GetExtension(): %s", err)
- }
- if want := proto.ErrMissingExtension; err != want {
- return fmt.Errorf("Unexpected error: got %v, want %v", err, want)
- }
- return nil
- }
-
- // All proto2 extension values are either a pointer to a value or a slice of values.
- ty := reflect.TypeOf(val)
- tyWant := reflect.TypeOf(test.ext.ExtensionType)
- if got, want := ty, tyWant; got != want {
- return fmt.Errorf("unexpected reflect.TypeOf(): got %v want %v", got, want)
- }
- tye := ty.Elem()
- tyeWant := tyWant.Elem()
- if got, want := tye, tyeWant; got != want {
- return fmt.Errorf("unexpected reflect.TypeOf().Elem(): got %v want %v", got, want)
- }
-
- // Check the name of the type of the value.
- // If it is an enum it will be type int32 with the name of the enum.
- if got, want := tye.Name(), tye.Name(); got != want {
- return fmt.Errorf("unexpected reflect.TypeOf().Elem().Name(): got %v want %v", got, want)
- }
-
- // Check that value is what we expect.
- // If we have a pointer in val, get the value it points to.
- valExp := val
- if ty.Kind() == reflect.Ptr {
- valExp = reflect.ValueOf(val).Elem().Interface()
- }
- if got, want := valExp, valWant; !reflect.DeepEqual(got, want) {
- return fmt.Errorf("unexpected reflect.DeepEqual(): got %v want %v", got, want)
- }
-
- return nil
- }
-
- setTo := func(test testcase) interface{} {
- setTo := reflect.ValueOf(test.want)
- if typ := reflect.TypeOf(test.ext.ExtensionType); typ.Kind() == reflect.Ptr {
- setTo = reflect.New(typ).Elem()
- setTo.Set(reflect.New(setTo.Type().Elem()))
- setTo.Elem().Set(reflect.ValueOf(test.want))
- }
- return setTo.Interface()
- }
-
- for _, test := range tests {
- msg := &pb.DefaultsMessage{}
- name := test.ext.Name
-
- // Check the initial value.
- if err := checkVal(test, msg, test.def); err != nil {
- t.Errorf("%s: %v", name, err)
- }
-
- // Set the per-type value and check value.
- name = fmt.Sprintf("%s (set to %T %v)", name, test.want, test.want)
- if err := proto.SetExtension(msg, test.ext, setTo(test)); err != nil {
- t.Errorf("%s: SetExtension(): %v", name, err)
- continue
- }
- if err := checkVal(test, msg, test.want); err != nil {
- t.Errorf("%s: %v", name, err)
- continue
- }
-
- // Set and check the value.
- name += " (cleared)"
- proto.ClearExtension(msg, test.ext)
- if err := checkVal(test, msg, test.def); err != nil {
- t.Errorf("%s: %v", name, err)
- }
- }
-}
-
-func TestExtensionsRoundTrip(t *testing.T) {
- msg := &pb.MyMessage{}
- ext1 := &pb.Ext{
- Data: proto.String("hi"),
- }
- ext2 := &pb.Ext{
- Data: proto.String("there"),
- }
- exists := proto.HasExtension(msg, pb.E_Ext_More)
- if exists {
- t.Error("Extension More present unexpectedly")
- }
- if err := proto.SetExtension(msg, pb.E_Ext_More, ext1); err != nil {
- t.Error(err)
- }
- if err := proto.SetExtension(msg, pb.E_Ext_More, ext2); err != nil {
- t.Error(err)
- }
- e, err := proto.GetExtension(msg, pb.E_Ext_More)
- if err != nil {
- t.Error(err)
- }
- x, ok := e.(*pb.Ext)
- if !ok {
- t.Errorf("e has type %T, expected testdata.Ext", e)
- } else if *x.Data != "there" {
- t.Errorf("SetExtension failed to overwrite, got %+v, not 'there'", x)
- }
- proto.ClearExtension(msg, pb.E_Ext_More)
- if _, err = proto.GetExtension(msg, pb.E_Ext_More); err != proto.ErrMissingExtension {
- t.Errorf("got %v, expected ErrMissingExtension", e)
- }
- if _, err := proto.GetExtension(msg, pb.E_X215); err == nil {
- t.Error("expected bad extension error, got nil")
- }
- if err := proto.SetExtension(msg, pb.E_X215, 12); err == nil {
- t.Error("expected extension err")
- }
- if err := proto.SetExtension(msg, pb.E_Ext_More, 12); err == nil {
- t.Error("expected some sort of type mismatch error, got nil")
- }
-}
-
-func TestNilExtension(t *testing.T) {
- msg := &pb.MyMessage{
- Count: proto.Int32(1),
- }
- if err := proto.SetExtension(msg, pb.E_Ext_Text, proto.String("hello")); err != nil {
- t.Fatal(err)
- }
- if err := proto.SetExtension(msg, pb.E_Ext_More, (*pb.Ext)(nil)); err == nil {
- t.Error("expected SetExtension to fail due to a nil extension")
- } else if want := "proto: SetExtension called with nil value of type *testdata.Ext"; err.Error() != want {
- t.Errorf("expected error %v, got %v", want, err)
- }
- // Note: if the behavior of Marshal is ever changed to ignore nil extensions, update
- // this test to verify that E_Ext_Text is properly propagated through marshal->unmarshal.
-}
diff --git a/vendor/github.com/golang/protobuf/proto/message_set_test.go b/vendor/github.com/golang/protobuf/proto/message_set_test.go
deleted file mode 100644
index 7c29bccf..00000000
--- a/vendor/github.com/golang/protobuf/proto/message_set_test.go
+++ /dev/null
@@ -1,66 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2014 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-package proto
-
-import (
- "bytes"
- "testing"
-)
-
-func TestUnmarshalMessageSetWithDuplicate(t *testing.T) {
- // Check that a repeated message set entry will be concatenated.
- in := &MessageSet{
- Item: []*_MessageSet_Item{
- {TypeId: Int32(12345), Message: []byte("hoo")},
- {TypeId: Int32(12345), Message: []byte("hah")},
- },
- }
- b, err := Marshal(in)
- if err != nil {
- t.Fatalf("Marshal: %v", err)
- }
- t.Logf("Marshaled bytes: %q", b)
-
- m := make(map[int32]Extension)
- if err := UnmarshalMessageSet(b, m); err != nil {
- t.Fatalf("UnmarshalMessageSet: %v", err)
- }
- ext, ok := m[12345]
- if !ok {
- t.Fatalf("Didn't retrieve extension 12345; map is %v", m)
- }
- // Skip wire type/field number and length varints.
- got := skipVarint(skipVarint(ext.enc))
- if want := []byte("hoohah"); !bytes.Equal(got, want) {
- t.Errorf("Combined extension is %q, want %q", got, want)
- }
-}
diff --git a/vendor/github.com/golang/protobuf/proto/proto3_proto/proto3.proto b/vendor/github.com/golang/protobuf/proto/proto3_proto/proto3.proto
deleted file mode 100644
index e2311d92..00000000
--- a/vendor/github.com/golang/protobuf/proto/proto3_proto/proto3.proto
+++ /dev/null
@@ -1,68 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2014 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-syntax = "proto3";
-
-import "testdata/test.proto";
-
-package proto3_proto;
-
-message Message {
- enum Humour {
- UNKNOWN = 0;
- PUNS = 1;
- SLAPSTICK = 2;
- BILL_BAILEY = 3;
- }
-
- string name = 1;
- Humour hilarity = 2;
- uint32 height_in_cm = 3;
- bytes data = 4;
- int64 result_count = 7;
- bool true_scotsman = 8;
- float score = 9;
-
- repeated uint64 key = 5;
- Nested nested = 6;
-
- map terrain = 10;
- testdata.SubDefaults proto2_field = 11;
- map proto2_value = 13;
-}
-
-message Nested {
- string bunny = 1;
-}
-
-message MessageWithMap {
- map byte_mapping = 1;
-}
diff --git a/vendor/github.com/golang/protobuf/proto/proto3_test.go b/vendor/github.com/golang/protobuf/proto/proto3_test.go
deleted file mode 100644
index 462f8055..00000000
--- a/vendor/github.com/golang/protobuf/proto/proto3_test.go
+++ /dev/null
@@ -1,125 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2014 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-package proto_test
-
-import (
- "testing"
-
- "github.com/golang/protobuf/proto"
- pb "github.com/golang/protobuf/proto/proto3_proto"
- tpb "github.com/golang/protobuf/proto/testdata"
-)
-
-func TestProto3ZeroValues(t *testing.T) {
- tests := []struct {
- desc string
- m proto.Message
- }{
- {"zero message", &pb.Message{}},
- {"empty bytes field", &pb.Message{Data: []byte{}}},
- }
- for _, test := range tests {
- b, err := proto.Marshal(test.m)
- if err != nil {
- t.Errorf("%s: proto.Marshal: %v", test.desc, err)
- continue
- }
- if len(b) > 0 {
- t.Errorf("%s: Encoding is non-empty: %q", test.desc, b)
- }
- }
-}
-
-func TestRoundTripProto3(t *testing.T) {
- m := &pb.Message{
- Name: "David", // (2 | 1<<3): 0x0a 0x05 "David"
- Hilarity: pb.Message_PUNS, // (0 | 2<<3): 0x10 0x01
- HeightInCm: 178, // (0 | 3<<3): 0x18 0xb2 0x01
- Data: []byte("roboto"), // (2 | 4<<3): 0x20 0x06 "roboto"
- ResultCount: 47, // (0 | 7<<3): 0x38 0x2f
- TrueScotsman: true, // (0 | 8<<3): 0x40 0x01
- Score: 8.1, // (5 | 9<<3): 0x4d <8.1>
-
- Key: []uint64{1, 0xdeadbeef},
- Nested: &pb.Nested{
- Bunny: "Monty",
- },
- }
- t.Logf(" m: %v", m)
-
- b, err := proto.Marshal(m)
- if err != nil {
- t.Fatalf("proto.Marshal: %v", err)
- }
- t.Logf(" b: %q", b)
-
- m2 := new(pb.Message)
- if err := proto.Unmarshal(b, m2); err != nil {
- t.Fatalf("proto.Unmarshal: %v", err)
- }
- t.Logf("m2: %v", m2)
-
- if !proto.Equal(m, m2) {
- t.Errorf("proto.Equal returned false:\n m: %v\nm2: %v", m, m2)
- }
-}
-
-func TestProto3SetDefaults(t *testing.T) {
- in := &pb.Message{
- Terrain: map[string]*pb.Nested{
- "meadow": new(pb.Nested),
- },
- Proto2Field: new(tpb.SubDefaults),
- Proto2Value: map[string]*tpb.SubDefaults{
- "badlands": new(tpb.SubDefaults),
- },
- }
-
- got := proto.Clone(in).(*pb.Message)
- proto.SetDefaults(got)
-
- // There are no defaults in proto3. Everything should be the zero value, but
- // we need to remember to set defaults for nested proto2 messages.
- want := &pb.Message{
- Terrain: map[string]*pb.Nested{
- "meadow": new(pb.Nested),
- },
- Proto2Field: &tpb.SubDefaults{N: proto.Int64(7)},
- Proto2Value: map[string]*tpb.SubDefaults{
- "badlands": &tpb.SubDefaults{N: proto.Int64(7)},
- },
- }
-
- if !proto.Equal(got, want) {
- t.Errorf("with in = %v\nproto.SetDefaults(in) =>\ngot %v\nwant %v", in, got, want)
- }
-}
diff --git a/vendor/github.com/golang/protobuf/proto/size2_test.go b/vendor/github.com/golang/protobuf/proto/size2_test.go
deleted file mode 100644
index a2729c39..00000000
--- a/vendor/github.com/golang/protobuf/proto/size2_test.go
+++ /dev/null
@@ -1,63 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2012 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-package proto
-
-import (
- "testing"
-)
-
-// This is a separate file and package from size_test.go because that one uses
-// generated messages and thus may not be in package proto without having a circular
-// dependency, whereas this file tests unexported details of size.go.
-
-func TestVarintSize(t *testing.T) {
- // Check the edge cases carefully.
- testCases := []struct {
- n uint64
- size int
- }{
- {0, 1},
- {1, 1},
- {127, 1},
- {128, 2},
- {16383, 2},
- {16384, 3},
- {1<<63 - 1, 9},
- {1 << 63, 10},
- }
- for _, tc := range testCases {
- size := sizeVarint(tc.n)
- if size != tc.size {
- t.Errorf("sizeVarint(%d) = %d, want %d", tc.n, size, tc.size)
- }
- }
-}
diff --git a/vendor/github.com/golang/protobuf/proto/size_test.go b/vendor/github.com/golang/protobuf/proto/size_test.go
deleted file mode 100644
index db5614fd..00000000
--- a/vendor/github.com/golang/protobuf/proto/size_test.go
+++ /dev/null
@@ -1,142 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2012 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-package proto_test
-
-import (
- "log"
- "strings"
- "testing"
-
- . "github.com/golang/protobuf/proto"
- proto3pb "github.com/golang/protobuf/proto/proto3_proto"
- pb "github.com/golang/protobuf/proto/testdata"
-)
-
-var messageWithExtension1 = &pb.MyMessage{Count: Int32(7)}
-
-// messageWithExtension2 is in equal_test.go.
-var messageWithExtension3 = &pb.MyMessage{Count: Int32(8)}
-
-func init() {
- if err := SetExtension(messageWithExtension1, pb.E_Ext_More, &pb.Ext{Data: String("Abbott")}); err != nil {
- log.Panicf("SetExtension: %v", err)
- }
- if err := SetExtension(messageWithExtension3, pb.E_Ext_More, &pb.Ext{Data: String("Costello")}); err != nil {
- log.Panicf("SetExtension: %v", err)
- }
-
- // Force messageWithExtension3 to have the extension encoded.
- Marshal(messageWithExtension3)
-
-}
-
-var SizeTests = []struct {
- desc string
- pb Message
-}{
- {"empty", &pb.OtherMessage{}},
- // Basic types.
- {"bool", &pb.Defaults{F_Bool: Bool(true)}},
- {"int32", &pb.Defaults{F_Int32: Int32(12)}},
- {"negative int32", &pb.Defaults{F_Int32: Int32(-1)}},
- {"small int64", &pb.Defaults{F_Int64: Int64(1)}},
- {"big int64", &pb.Defaults{F_Int64: Int64(1 << 20)}},
- {"negative int64", &pb.Defaults{F_Int64: Int64(-1)}},
- {"fixed32", &pb.Defaults{F_Fixed32: Uint32(71)}},
- {"fixed64", &pb.Defaults{F_Fixed64: Uint64(72)}},
- {"uint32", &pb.Defaults{F_Uint32: Uint32(123)}},
- {"uint64", &pb.Defaults{F_Uint64: Uint64(124)}},
- {"float", &pb.Defaults{F_Float: Float32(12.6)}},
- {"double", &pb.Defaults{F_Double: Float64(13.9)}},
- {"string", &pb.Defaults{F_String: String("niles")}},
- {"bytes", &pb.Defaults{F_Bytes: []byte("wowsa")}},
- {"bytes, empty", &pb.Defaults{F_Bytes: []byte{}}},
- {"sint32", &pb.Defaults{F_Sint32: Int32(65)}},
- {"sint64", &pb.Defaults{F_Sint64: Int64(67)}},
- {"enum", &pb.Defaults{F_Enum: pb.Defaults_BLUE.Enum()}},
- // Repeated.
- {"empty repeated bool", &pb.MoreRepeated{Bools: []bool{}}},
- {"repeated bool", &pb.MoreRepeated{Bools: []bool{false, true, true, false}}},
- {"packed repeated bool", &pb.MoreRepeated{BoolsPacked: []bool{false, true, true, false, true, true, true}}},
- {"repeated int32", &pb.MoreRepeated{Ints: []int32{1, 12203, 1729, -1}}},
- {"repeated int32 packed", &pb.MoreRepeated{IntsPacked: []int32{1, 12203, 1729}}},
- {"repeated int64 packed", &pb.MoreRepeated{Int64SPacked: []int64{
- // Need enough large numbers to verify that the header is counting the number of bytes
- // for the field, not the number of elements.
- 1 << 62, 1 << 62, 1 << 62, 1 << 62, 1 << 62, 1 << 62, 1 << 62, 1 << 62, 1 << 62, 1 << 62,
- 1 << 62, 1 << 62, 1 << 62, 1 << 62, 1 << 62, 1 << 62, 1 << 62, 1 << 62, 1 << 62, 1 << 62,
- }}},
- {"repeated string", &pb.MoreRepeated{Strings: []string{"r", "ken", "gri"}}},
- {"repeated fixed", &pb.MoreRepeated{Fixeds: []uint32{1, 2, 3, 4}}},
- // Nested.
- {"nested", &pb.OldMessage{Nested: &pb.OldMessage_Nested{Name: String("whatever")}}},
- {"group", &pb.GroupOld{G: &pb.GroupOld_G{X: Int32(12345)}}},
- // Other things.
- {"unrecognized", &pb.MoreRepeated{XXX_unrecognized: []byte{13<<3 | 0, 4}}},
- {"extension (unencoded)", messageWithExtension1},
- {"extension (encoded)", messageWithExtension3},
- // proto3 message
- {"proto3 empty", &proto3pb.Message{}},
- {"proto3 bool", &proto3pb.Message{TrueScotsman: true}},
- {"proto3 int64", &proto3pb.Message{ResultCount: 1}},
- {"proto3 uint32", &proto3pb.Message{HeightInCm: 123}},
- {"proto3 float", &proto3pb.Message{Score: 12.6}},
- {"proto3 string", &proto3pb.Message{Name: "Snezana"}},
- {"proto3 bytes", &proto3pb.Message{Data: []byte("wowsa")}},
- {"proto3 bytes, empty", &proto3pb.Message{Data: []byte{}}},
- {"proto3 enum", &proto3pb.Message{Hilarity: proto3pb.Message_PUNS}},
- {"proto3 map field with empty bytes", &proto3pb.MessageWithMap{ByteMapping: map[bool][]byte{false: []byte{}}}},
-
- {"map field", &pb.MessageWithMap{NameMapping: map[int32]string{1: "Rob", 7: "Andrew"}}},
- {"map field with message", &pb.MessageWithMap{MsgMapping: map[int64]*pb.FloatingPoint{0x7001: &pb.FloatingPoint{F: Float64(2.0)}}}},
- {"map field with bytes", &pb.MessageWithMap{ByteMapping: map[bool][]byte{true: []byte("this time for sure")}}},
- {"map field with empty bytes", &pb.MessageWithMap{ByteMapping: map[bool][]byte{true: []byte{}}}},
-
- {"map field with big entry", &pb.MessageWithMap{NameMapping: map[int32]string{8: strings.Repeat("x", 125)}}},
- {"map field with big key and val", &pb.MessageWithMap{StrToStr: map[string]string{strings.Repeat("x", 70): strings.Repeat("y", 70)}}},
- {"map field with big numeric key", &pb.MessageWithMap{NameMapping: map[int32]string{0xf00d: "om nom nom"}}},
-}
-
-func TestSize(t *testing.T) {
- for _, tc := range SizeTests {
- size := Size(tc.pb)
- b, err := Marshal(tc.pb)
- if err != nil {
- t.Errorf("%v: Marshal failed: %v", tc.desc, err)
- continue
- }
- if size != len(b) {
- t.Errorf("%v: Size(%v) = %d, want %d", tc.desc, tc.pb, size, len(b))
- t.Logf("%v: bytes: %#v", tc.desc, b)
- }
- }
-}
diff --git a/vendor/github.com/golang/protobuf/proto/testdata/Makefile b/vendor/github.com/golang/protobuf/proto/testdata/Makefile
deleted file mode 100644
index fc288628..00000000
--- a/vendor/github.com/golang/protobuf/proto/testdata/Makefile
+++ /dev/null
@@ -1,50 +0,0 @@
-# Go support for Protocol Buffers - Google's data interchange format
-#
-# Copyright 2010 The Go Authors. All rights reserved.
-# https://github.com/golang/protobuf
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are
-# met:
-#
-# * Redistributions of source code must retain the above copyright
-# notice, this list of conditions and the following disclaimer.
-# * Redistributions in binary form must reproduce the above
-# copyright notice, this list of conditions and the following disclaimer
-# in the documentation and/or other materials provided with the
-# distribution.
-# * Neither the name of Google Inc. nor the names of its
-# contributors may be used to endorse or promote products derived from
-# this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-
-include ../../Make.protobuf
-
-all: regenerate
-
-regenerate:
- rm -f test.pb.go
- make test.pb.go
-
-# The following rules are just aids to development. Not needed for typical testing.
-
-diff: regenerate
- git diff test.pb.go
-
-restore:
- cp test.pb.go.golden test.pb.go
-
-preserve:
- cp test.pb.go test.pb.go.golden
diff --git a/vendor/github.com/golang/protobuf/proto/testdata/golden_test.go b/vendor/github.com/golang/protobuf/proto/testdata/golden_test.go
deleted file mode 100644
index 7172d0e9..00000000
--- a/vendor/github.com/golang/protobuf/proto/testdata/golden_test.go
+++ /dev/null
@@ -1,86 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2012 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-// Verify that the compiler output for test.proto is unchanged.
-
-package testdata
-
-import (
- "crypto/sha1"
- "fmt"
- "io/ioutil"
- "os"
- "os/exec"
- "path/filepath"
- "testing"
-)
-
-// sum returns in string form (for easy comparison) the SHA-1 hash of the named file.
-func sum(t *testing.T, name string) string {
- data, err := ioutil.ReadFile(name)
- if err != nil {
- t.Fatal(err)
- }
- t.Logf("sum(%q): length is %d", name, len(data))
- hash := sha1.New()
- _, err = hash.Write(data)
- if err != nil {
- t.Fatal(err)
- }
- return fmt.Sprintf("% x", hash.Sum(nil))
-}
-
-func run(t *testing.T, name string, args ...string) {
- cmd := exec.Command(name, args...)
- cmd.Stdin = os.Stdin
- cmd.Stdout = os.Stdout
- cmd.Stderr = os.Stderr
- err := cmd.Run()
- if err != nil {
- t.Fatal(err)
- }
-}
-
-func TestGolden(t *testing.T) {
- // Compute the original checksum.
- goldenSum := sum(t, "test.pb.go")
- // Run the proto compiler.
- run(t, "protoc", "--go_out="+os.TempDir(), "test.proto")
- newFile := filepath.Join(os.TempDir(), "test.pb.go")
- defer os.Remove(newFile)
- // Compute the new checksum.
- newSum := sum(t, newFile)
- // Verify
- if newSum != goldenSum {
- run(t, "diff", "-u", "test.pb.go", newFile)
- t.Fatal("Code generated by protoc-gen-go has changed; update test.pb.go")
- }
-}
diff --git a/vendor/github.com/golang/protobuf/proto/testdata/test.proto b/vendor/github.com/golang/protobuf/proto/testdata/test.proto
deleted file mode 100644
index 440dba38..00000000
--- a/vendor/github.com/golang/protobuf/proto/testdata/test.proto
+++ /dev/null
@@ -1,480 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2010 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-// A feature-rich test file for the protocol compiler and libraries.
-
-syntax = "proto2";
-
-package testdata;
-
-enum FOO { FOO1 = 1; };
-
-message GoEnum {
- required FOO foo = 1;
-}
-
-message GoTestField {
- required string Label = 1;
- required string Type = 2;
-}
-
-message GoTest {
- // An enum, for completeness.
- enum KIND {
- VOID = 0;
-
- // Basic types
- BOOL = 1;
- BYTES = 2;
- FINGERPRINT = 3;
- FLOAT = 4;
- INT = 5;
- STRING = 6;
- TIME = 7;
-
- // Groupings
- TUPLE = 8;
- ARRAY = 9;
- MAP = 10;
-
- // Table types
- TABLE = 11;
-
- // Functions
- FUNCTION = 12; // last tag
- };
-
- // Some typical parameters
- required KIND Kind = 1;
- optional string Table = 2;
- optional int32 Param = 3;
-
- // Required, repeated and optional foreign fields.
- required GoTestField RequiredField = 4;
- repeated GoTestField RepeatedField = 5;
- optional GoTestField OptionalField = 6;
-
- // Required fields of all basic types
- required bool F_Bool_required = 10;
- required int32 F_Int32_required = 11;
- required int64 F_Int64_required = 12;
- required fixed32 F_Fixed32_required = 13;
- required fixed64 F_Fixed64_required = 14;
- required uint32 F_Uint32_required = 15;
- required uint64 F_Uint64_required = 16;
- required float F_Float_required = 17;
- required double F_Double_required = 18;
- required string F_String_required = 19;
- required bytes F_Bytes_required = 101;
- required sint32 F_Sint32_required = 102;
- required sint64 F_Sint64_required = 103;
-
- // Repeated fields of all basic types
- repeated bool F_Bool_repeated = 20;
- repeated int32 F_Int32_repeated = 21;
- repeated int64 F_Int64_repeated = 22;
- repeated fixed32 F_Fixed32_repeated = 23;
- repeated fixed64 F_Fixed64_repeated = 24;
- repeated uint32 F_Uint32_repeated = 25;
- repeated uint64 F_Uint64_repeated = 26;
- repeated float F_Float_repeated = 27;
- repeated double F_Double_repeated = 28;
- repeated string F_String_repeated = 29;
- repeated bytes F_Bytes_repeated = 201;
- repeated sint32 F_Sint32_repeated = 202;
- repeated sint64 F_Sint64_repeated = 203;
-
- // Optional fields of all basic types
- optional bool F_Bool_optional = 30;
- optional int32 F_Int32_optional = 31;
- optional int64 F_Int64_optional = 32;
- optional fixed32 F_Fixed32_optional = 33;
- optional fixed64 F_Fixed64_optional = 34;
- optional uint32 F_Uint32_optional = 35;
- optional uint64 F_Uint64_optional = 36;
- optional float F_Float_optional = 37;
- optional double F_Double_optional = 38;
- optional string F_String_optional = 39;
- optional bytes F_Bytes_optional = 301;
- optional sint32 F_Sint32_optional = 302;
- optional sint64 F_Sint64_optional = 303;
-
- // Default-valued fields of all basic types
- optional bool F_Bool_defaulted = 40 [default=true];
- optional int32 F_Int32_defaulted = 41 [default=32];
- optional int64 F_Int64_defaulted = 42 [default=64];
- optional fixed32 F_Fixed32_defaulted = 43 [default=320];
- optional fixed64 F_Fixed64_defaulted = 44 [default=640];
- optional uint32 F_Uint32_defaulted = 45 [default=3200];
- optional uint64 F_Uint64_defaulted = 46 [default=6400];
- optional float F_Float_defaulted = 47 [default=314159.];
- optional double F_Double_defaulted = 48 [default=271828.];
- optional string F_String_defaulted = 49 [default="hello, \"world!\"\n"];
- optional bytes F_Bytes_defaulted = 401 [default="Bignose"];
- optional sint32 F_Sint32_defaulted = 402 [default = -32];
- optional sint64 F_Sint64_defaulted = 403 [default = -64];
-
- // Packed repeated fields (no string or bytes).
- repeated bool F_Bool_repeated_packed = 50 [packed=true];
- repeated int32 F_Int32_repeated_packed = 51 [packed=true];
- repeated int64 F_Int64_repeated_packed = 52 [packed=true];
- repeated fixed32 F_Fixed32_repeated_packed = 53 [packed=true];
- repeated fixed64 F_Fixed64_repeated_packed = 54 [packed=true];
- repeated uint32 F_Uint32_repeated_packed = 55 [packed=true];
- repeated uint64 F_Uint64_repeated_packed = 56 [packed=true];
- repeated float F_Float_repeated_packed = 57 [packed=true];
- repeated double F_Double_repeated_packed = 58 [packed=true];
- repeated sint32 F_Sint32_repeated_packed = 502 [packed=true];
- repeated sint64 F_Sint64_repeated_packed = 503 [packed=true];
-
- // Required, repeated, and optional groups.
- required group RequiredGroup = 70 {
- required string RequiredField = 71;
- };
-
- repeated group RepeatedGroup = 80 {
- required string RequiredField = 81;
- };
-
- optional group OptionalGroup = 90 {
- required string RequiredField = 91;
- };
-}
-
-// For testing skipping of unrecognized fields.
-// Numbers are all big, larger than tag numbers in GoTestField,
-// the message used in the corresponding test.
-message GoSkipTest {
- required int32 skip_int32 = 11;
- required fixed32 skip_fixed32 = 12;
- required fixed64 skip_fixed64 = 13;
- required string skip_string = 14;
- required group SkipGroup = 15 {
- required int32 group_int32 = 16;
- required string group_string = 17;
- }
-}
-
-// For testing packed/non-packed decoder switching.
-// A serialized instance of one should be deserializable as the other.
-message NonPackedTest {
- repeated int32 a = 1;
-}
-
-message PackedTest {
- repeated int32 b = 1 [packed=true];
-}
-
-message MaxTag {
- // Maximum possible tag number.
- optional string last_field = 536870911;
-}
-
-message OldMessage {
- message Nested {
- optional string name = 1;
- }
- optional Nested nested = 1;
-
- optional int32 num = 2;
-}
-
-// NewMessage is wire compatible with OldMessage;
-// imagine it as a future version.
-message NewMessage {
- message Nested {
- optional string name = 1;
- optional string food_group = 2;
- }
- optional Nested nested = 1;
-
- // This is an int32 in OldMessage.
- optional int64 num = 2;
-}
-
-// Smaller tests for ASCII formatting.
-
-message InnerMessage {
- required string host = 1;
- optional int32 port = 2 [default=4000];
- optional bool connected = 3;
-}
-
-message OtherMessage {
- optional int64 key = 1;
- optional bytes value = 2;
- optional float weight = 3;
- optional InnerMessage inner = 4;
-}
-
-message MyMessage {
- required int32 count = 1;
- optional string name = 2;
- optional string quote = 3;
- repeated string pet = 4;
- optional InnerMessage inner = 5;
- repeated OtherMessage others = 6;
- repeated InnerMessage rep_inner = 12;
-
- enum Color {
- RED = 0;
- GREEN = 1;
- BLUE = 2;
- };
- optional Color bikeshed = 7;
-
- optional group SomeGroup = 8 {
- optional int32 group_field = 9;
- }
-
- // This field becomes [][]byte in the generated code.
- repeated bytes rep_bytes = 10;
-
- optional double bigfloat = 11;
-
- extensions 100 to max;
-}
-
-message Ext {
- extend MyMessage {
- optional Ext more = 103;
- optional string text = 104;
- optional int32 number = 105;
- }
-
- optional string data = 1;
-}
-
-extend MyMessage {
- repeated string greeting = 106;
-}
-
-message DefaultsMessage {
- enum DefaultsEnum {
- ZERO = 0;
- ONE = 1;
- TWO = 2;
- };
- extensions 100 to max;
-}
-
-extend DefaultsMessage {
- optional double no_default_double = 101;
- optional float no_default_float = 102;
- optional int32 no_default_int32 = 103;
- optional int64 no_default_int64 = 104;
- optional uint32 no_default_uint32 = 105;
- optional uint64 no_default_uint64 = 106;
- optional sint32 no_default_sint32 = 107;
- optional sint64 no_default_sint64 = 108;
- optional fixed32 no_default_fixed32 = 109;
- optional fixed64 no_default_fixed64 = 110;
- optional sfixed32 no_default_sfixed32 = 111;
- optional sfixed64 no_default_sfixed64 = 112;
- optional bool no_default_bool = 113;
- optional string no_default_string = 114;
- optional bytes no_default_bytes = 115;
- optional DefaultsMessage.DefaultsEnum no_default_enum = 116;
-
- optional double default_double = 201 [default = 3.1415];
- optional float default_float = 202 [default = 3.14];
- optional int32 default_int32 = 203 [default = 42];
- optional int64 default_int64 = 204 [default = 43];
- optional uint32 default_uint32 = 205 [default = 44];
- optional uint64 default_uint64 = 206 [default = 45];
- optional sint32 default_sint32 = 207 [default = 46];
- optional sint64 default_sint64 = 208 [default = 47];
- optional fixed32 default_fixed32 = 209 [default = 48];
- optional fixed64 default_fixed64 = 210 [default = 49];
- optional sfixed32 default_sfixed32 = 211 [default = 50];
- optional sfixed64 default_sfixed64 = 212 [default = 51];
- optional bool default_bool = 213 [default = true];
- optional string default_string = 214 [default = "Hello, string"];
- optional bytes default_bytes = 215 [default = "Hello, bytes"];
- optional DefaultsMessage.DefaultsEnum default_enum = 216 [default = ONE];
-}
-
-message MyMessageSet {
- option message_set_wire_format = true;
- extensions 100 to max;
-}
-
-message Empty {
-}
-
-extend MyMessageSet {
- optional Empty x201 = 201;
- optional Empty x202 = 202;
- optional Empty x203 = 203;
- optional Empty x204 = 204;
- optional Empty x205 = 205;
- optional Empty x206 = 206;
- optional Empty x207 = 207;
- optional Empty x208 = 208;
- optional Empty x209 = 209;
- optional Empty x210 = 210;
- optional Empty x211 = 211;
- optional Empty x212 = 212;
- optional Empty x213 = 213;
- optional Empty x214 = 214;
- optional Empty x215 = 215;
- optional Empty x216 = 216;
- optional Empty x217 = 217;
- optional Empty x218 = 218;
- optional Empty x219 = 219;
- optional Empty x220 = 220;
- optional Empty x221 = 221;
- optional Empty x222 = 222;
- optional Empty x223 = 223;
- optional Empty x224 = 224;
- optional Empty x225 = 225;
- optional Empty x226 = 226;
- optional Empty x227 = 227;
- optional Empty x228 = 228;
- optional Empty x229 = 229;
- optional Empty x230 = 230;
- optional Empty x231 = 231;
- optional Empty x232 = 232;
- optional Empty x233 = 233;
- optional Empty x234 = 234;
- optional Empty x235 = 235;
- optional Empty x236 = 236;
- optional Empty x237 = 237;
- optional Empty x238 = 238;
- optional Empty x239 = 239;
- optional Empty x240 = 240;
- optional Empty x241 = 241;
- optional Empty x242 = 242;
- optional Empty x243 = 243;
- optional Empty x244 = 244;
- optional Empty x245 = 245;
- optional Empty x246 = 246;
- optional Empty x247 = 247;
- optional Empty x248 = 248;
- optional Empty x249 = 249;
- optional Empty x250 = 250;
-}
-
-message MessageList {
- repeated group Message = 1 {
- required string name = 2;
- required int32 count = 3;
- }
-}
-
-message Strings {
- optional string string_field = 1;
- optional bytes bytes_field = 2;
-}
-
-message Defaults {
- enum Color {
- RED = 0;
- GREEN = 1;
- BLUE = 2;
- }
-
- // Default-valued fields of all basic types.
- // Same as GoTest, but copied here to make testing easier.
- optional bool F_Bool = 1 [default=true];
- optional int32 F_Int32 = 2 [default=32];
- optional int64 F_Int64 = 3 [default=64];
- optional fixed32 F_Fixed32 = 4 [default=320];
- optional fixed64 F_Fixed64 = 5 [default=640];
- optional uint32 F_Uint32 = 6 [default=3200];
- optional uint64 F_Uint64 = 7 [default=6400];
- optional float F_Float = 8 [default=314159.];
- optional double F_Double = 9 [default=271828.];
- optional string F_String = 10 [default="hello, \"world!\"\n"];
- optional bytes F_Bytes = 11 [default="Bignose"];
- optional sint32 F_Sint32 = 12 [default=-32];
- optional sint64 F_Sint64 = 13 [default=-64];
- optional Color F_Enum = 14 [default=GREEN];
-
- // More fields with crazy defaults.
- optional float F_Pinf = 15 [default=inf];
- optional float F_Ninf = 16 [default=-inf];
- optional float F_Nan = 17 [default=nan];
-
- // Sub-message.
- optional SubDefaults sub = 18;
-
- // Redundant but explicit defaults.
- optional string str_zero = 19 [default=""];
-}
-
-message SubDefaults {
- optional int64 n = 1 [default=7];
-}
-
-message RepeatedEnum {
- enum Color {
- RED = 1;
- }
- repeated Color color = 1;
-}
-
-message MoreRepeated {
- repeated bool bools = 1;
- repeated bool bools_packed = 2 [packed=true];
- repeated int32 ints = 3;
- repeated int32 ints_packed = 4 [packed=true];
- repeated int64 int64s_packed = 7 [packed=true];
- repeated string strings = 5;
- repeated fixed32 fixeds = 6;
-}
-
-// GroupOld and GroupNew have the same wire format.
-// GroupNew has a new field inside a group.
-
-message GroupOld {
- optional group G = 101 {
- optional int32 x = 2;
- }
-}
-
-message GroupNew {
- optional group G = 101 {
- optional int32 x = 2;
- optional int32 y = 3;
- }
-}
-
-message FloatingPoint {
- required double f = 1;
-}
-
-message MessageWithMap {
- map name_mapping = 1;
- map msg_mapping = 2;
- map byte_mapping = 3;
- map str_to_str = 4;
-}
diff --git a/vendor/github.com/golang/protobuf/proto/text_parser_test.go b/vendor/github.com/golang/protobuf/proto/text_parser_test.go
deleted file mode 100644
index 0754b262..00000000
--- a/vendor/github.com/golang/protobuf/proto/text_parser_test.go
+++ /dev/null
@@ -1,511 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2010 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-package proto_test
-
-import (
- "math"
- "reflect"
- "testing"
-
- . "github.com/golang/protobuf/proto"
- proto3pb "github.com/golang/protobuf/proto/proto3_proto"
- . "github.com/golang/protobuf/proto/testdata"
-)
-
-type UnmarshalTextTest struct {
- in string
- err string // if "", no error expected
- out *MyMessage
-}
-
-func buildExtStructTest(text string) UnmarshalTextTest {
- msg := &MyMessage{
- Count: Int32(42),
- }
- SetExtension(msg, E_Ext_More, &Ext{
- Data: String("Hello, world!"),
- })
- return UnmarshalTextTest{in: text, out: msg}
-}
-
-func buildExtDataTest(text string) UnmarshalTextTest {
- msg := &MyMessage{
- Count: Int32(42),
- }
- SetExtension(msg, E_Ext_Text, String("Hello, world!"))
- SetExtension(msg, E_Ext_Number, Int32(1729))
- return UnmarshalTextTest{in: text, out: msg}
-}
-
-func buildExtRepStringTest(text string) UnmarshalTextTest {
- msg := &MyMessage{
- Count: Int32(42),
- }
- if err := SetExtension(msg, E_Greeting, []string{"bula", "hola"}); err != nil {
- panic(err)
- }
- return UnmarshalTextTest{in: text, out: msg}
-}
-
-var unMarshalTextTests = []UnmarshalTextTest{
- // Basic
- {
- in: " count:42\n name:\"Dave\" ",
- out: &MyMessage{
- Count: Int32(42),
- Name: String("Dave"),
- },
- },
-
- // Empty quoted string
- {
- in: `count:42 name:""`,
- out: &MyMessage{
- Count: Int32(42),
- Name: String(""),
- },
- },
-
- // Quoted string concatenation
- {
- in: `count:42 name: "My name is "` + "\n" + `"elsewhere"`,
- out: &MyMessage{
- Count: Int32(42),
- Name: String("My name is elsewhere"),
- },
- },
-
- // Quoted string with escaped apostrophe
- {
- in: `count:42 name: "HOLIDAY - New Year\'s Day"`,
- out: &MyMessage{
- Count: Int32(42),
- Name: String("HOLIDAY - New Year's Day"),
- },
- },
-
- // Quoted string with single quote
- {
- in: `count:42 name: 'Roger "The Ramster" Ramjet'`,
- out: &MyMessage{
- Count: Int32(42),
- Name: String(`Roger "The Ramster" Ramjet`),
- },
- },
-
- // Quoted string with all the accepted special characters from the C++ test
- {
- in: `count:42 name: ` + "\"\\\"A string with \\' characters \\n and \\r newlines and \\t tabs and \\001 slashes \\\\ and multiple spaces\"",
- out: &MyMessage{
- Count: Int32(42),
- Name: String("\"A string with ' characters \n and \r newlines and \t tabs and \001 slashes \\ and multiple spaces"),
- },
- },
-
- // Quoted string with quoted backslash
- {
- in: `count:42 name: "\\'xyz"`,
- out: &MyMessage{
- Count: Int32(42),
- Name: String(`\'xyz`),
- },
- },
-
- // Quoted string with UTF-8 bytes.
- {
- in: "count:42 name: '\303\277\302\201\xAB'",
- out: &MyMessage{
- Count: Int32(42),
- Name: String("\303\277\302\201\xAB"),
- },
- },
-
- // Bad quoted string
- {
- in: `inner: < host: "\0" >` + "\n",
- err: `line 1.15: invalid quoted string "\0": \0 requires 2 following digits`,
- },
-
- // Number too large for int64
- {
- in: "count: 1 others { key: 123456789012345678901 }",
- err: "line 1.23: invalid int64: 123456789012345678901",
- },
-
- // Number too large for int32
- {
- in: "count: 1234567890123",
- err: "line 1.7: invalid int32: 1234567890123",
- },
-
- // Number in hexadecimal
- {
- in: "count: 0x2beef",
- out: &MyMessage{
- Count: Int32(0x2beef),
- },
- },
-
- // Number in octal
- {
- in: "count: 024601",
- out: &MyMessage{
- Count: Int32(024601),
- },
- },
-
- // Floating point number with "f" suffix
- {
- in: "count: 4 others:< weight: 17.0f >",
- out: &MyMessage{
- Count: Int32(4),
- Others: []*OtherMessage{
- {
- Weight: Float32(17),
- },
- },
- },
- },
-
- // Floating point positive infinity
- {
- in: "count: 4 bigfloat: inf",
- out: &MyMessage{
- Count: Int32(4),
- Bigfloat: Float64(math.Inf(1)),
- },
- },
-
- // Floating point negative infinity
- {
- in: "count: 4 bigfloat: -inf",
- out: &MyMessage{
- Count: Int32(4),
- Bigfloat: Float64(math.Inf(-1)),
- },
- },
-
- // Number too large for float32
- {
- in: "others:< weight: 12345678901234567890123456789012345678901234567890 >",
- err: "line 1.17: invalid float32: 12345678901234567890123456789012345678901234567890",
- },
-
- // Number posing as a quoted string
- {
- in: `inner: < host: 12 >` + "\n",
- err: `line 1.15: invalid string: 12`,
- },
-
- // Quoted string posing as int32
- {
- in: `count: "12"`,
- err: `line 1.7: invalid int32: "12"`,
- },
-
- // Quoted string posing a float32
- {
- in: `others:< weight: "17.4" >`,
- err: `line 1.17: invalid float32: "17.4"`,
- },
-
- // Enum
- {
- in: `count:42 bikeshed: BLUE`,
- out: &MyMessage{
- Count: Int32(42),
- Bikeshed: MyMessage_BLUE.Enum(),
- },
- },
-
- // Repeated field
- {
- in: `count:42 pet: "horsey" pet:"bunny"`,
- out: &MyMessage{
- Count: Int32(42),
- Pet: []string{"horsey", "bunny"},
- },
- },
-
- // Repeated message with/without colon and <>/{}
- {
- in: `count:42 others:{} others{} others:<> others:{}`,
- out: &MyMessage{
- Count: Int32(42),
- Others: []*OtherMessage{
- {},
- {},
- {},
- {},
- },
- },
- },
-
- // Missing colon for inner message
- {
- in: `count:42 inner < host: "cauchy.syd" >`,
- out: &MyMessage{
- Count: Int32(42),
- Inner: &InnerMessage{
- Host: String("cauchy.syd"),
- },
- },
- },
-
- // Missing colon for string field
- {
- in: `name "Dave"`,
- err: `line 1.5: expected ':', found "\"Dave\""`,
- },
-
- // Missing colon for int32 field
- {
- in: `count 42`,
- err: `line 1.6: expected ':', found "42"`,
- },
-
- // Missing required field
- {
- in: `name: "Pawel"`,
- err: `proto: required field "testdata.MyMessage.count" not set`,
- out: &MyMessage{
- Name: String("Pawel"),
- },
- },
-
- // Repeated non-repeated field
- {
- in: `name: "Rob" name: "Russ"`,
- err: `line 1.12: non-repeated field "name" was repeated`,
- },
-
- // Group
- {
- in: `count: 17 SomeGroup { group_field: 12 }`,
- out: &MyMessage{
- Count: Int32(17),
- Somegroup: &MyMessage_SomeGroup{
- GroupField: Int32(12),
- },
- },
- },
-
- // Semicolon between fields
- {
- in: `count:3;name:"Calvin"`,
- out: &MyMessage{
- Count: Int32(3),
- Name: String("Calvin"),
- },
- },
- // Comma between fields
- {
- in: `count:4,name:"Ezekiel"`,
- out: &MyMessage{
- Count: Int32(4),
- Name: String("Ezekiel"),
- },
- },
-
- // Extension
- buildExtStructTest(`count: 42 [testdata.Ext.more]:`),
- buildExtStructTest(`count: 42 [testdata.Ext.more] {data:"Hello, world!"}`),
- buildExtDataTest(`count: 42 [testdata.Ext.text]:"Hello, world!" [testdata.Ext.number]:1729`),
- buildExtRepStringTest(`count: 42 [testdata.greeting]:"bula" [testdata.greeting]:"hola"`),
-
- // Big all-in-one
- {
- in: "count:42 # Meaning\n" +
- `name:"Dave" ` +
- `quote:"\"I didn't want to go.\"" ` +
- `pet:"bunny" ` +
- `pet:"kitty" ` +
- `pet:"horsey" ` +
- `inner:<` +
- ` host:"footrest.syd" ` +
- ` port:7001 ` +
- ` connected:true ` +
- `> ` +
- `others:<` +
- ` key:3735928559 ` +
- ` value:"\x01A\a\f" ` +
- `> ` +
- `others:<` +
- " weight:58.9 # Atomic weight of Co\n" +
- ` inner:<` +
- ` host:"lesha.mtv" ` +
- ` port:8002 ` +
- ` >` +
- `>`,
- out: &MyMessage{
- Count: Int32(42),
- Name: String("Dave"),
- Quote: String(`"I didn't want to go."`),
- Pet: []string{"bunny", "kitty", "horsey"},
- Inner: &InnerMessage{
- Host: String("footrest.syd"),
- Port: Int32(7001),
- Connected: Bool(true),
- },
- Others: []*OtherMessage{
- {
- Key: Int64(3735928559),
- Value: []byte{0x1, 'A', '\a', '\f'},
- },
- {
- Weight: Float32(58.9),
- Inner: &InnerMessage{
- Host: String("lesha.mtv"),
- Port: Int32(8002),
- },
- },
- },
- },
- },
-}
-
-func TestUnmarshalText(t *testing.T) {
- for i, test := range unMarshalTextTests {
- pb := new(MyMessage)
- err := UnmarshalText(test.in, pb)
- if test.err == "" {
- // We don't expect failure.
- if err != nil {
- t.Errorf("Test %d: Unexpected error: %v", i, err)
- } else if !reflect.DeepEqual(pb, test.out) {
- t.Errorf("Test %d: Incorrect populated \nHave: %v\nWant: %v",
- i, pb, test.out)
- }
- } else {
- // We do expect failure.
- if err == nil {
- t.Errorf("Test %d: Didn't get expected error: %v", i, test.err)
- } else if err.Error() != test.err {
- t.Errorf("Test %d: Incorrect error.\nHave: %v\nWant: %v",
- i, err.Error(), test.err)
- } else if _, ok := err.(*RequiredNotSetError); ok && test.out != nil && !reflect.DeepEqual(pb, test.out) {
- t.Errorf("Test %d: Incorrect populated \nHave: %v\nWant: %v",
- i, pb, test.out)
- }
- }
- }
-}
-
-func TestUnmarshalTextCustomMessage(t *testing.T) {
- msg := &textMessage{}
- if err := UnmarshalText("custom", msg); err != nil {
- t.Errorf("Unexpected error from custom unmarshal: %v", err)
- }
- if UnmarshalText("not custom", msg) == nil {
- t.Errorf("Didn't get expected error from custom unmarshal")
- }
-}
-
-// Regression test; this caused a panic.
-func TestRepeatedEnum(t *testing.T) {
- pb := new(RepeatedEnum)
- if err := UnmarshalText("color: RED", pb); err != nil {
- t.Fatal(err)
- }
- exp := &RepeatedEnum{
- Color: []RepeatedEnum_Color{RepeatedEnum_RED},
- }
- if !Equal(pb, exp) {
- t.Errorf("Incorrect populated \nHave: %v\nWant: %v", pb, exp)
- }
-}
-
-func TestProto3TextParsing(t *testing.T) {
- m := new(proto3pb.Message)
- const in = `name: "Wallace" true_scotsman: true`
- want := &proto3pb.Message{
- Name: "Wallace",
- TrueScotsman: true,
- }
- if err := UnmarshalText(in, m); err != nil {
- t.Fatal(err)
- }
- if !Equal(m, want) {
- t.Errorf("\n got %v\nwant %v", m, want)
- }
-}
-
-func TestMapParsing(t *testing.T) {
- m := new(MessageWithMap)
- const in = `name_mapping: name_mapping:` +
- `msg_mapping:,>` + // separating commas are okay
- `msg_mapping>` + // no colon after "value"
- `byte_mapping:`
- want := &MessageWithMap{
- NameMapping: map[int32]string{
- 1: "Beatles",
- 1234: "Feist",
- },
- MsgMapping: map[int64]*FloatingPoint{
- -4: {F: Float64(2.0)},
- -2: {F: Float64(4.0)},
- },
- ByteMapping: map[bool][]byte{
- true: []byte("so be it"),
- },
- }
- if err := UnmarshalText(in, m); err != nil {
- t.Fatal(err)
- }
- if !Equal(m, want) {
- t.Errorf("\n got %v\nwant %v", m, want)
- }
-}
-
-var benchInput string
-
-func init() {
- benchInput = "count: 4\n"
- for i := 0; i < 1000; i++ {
- benchInput += "pet: \"fido\"\n"
- }
-
- // Check it is valid input.
- pb := new(MyMessage)
- err := UnmarshalText(benchInput, pb)
- if err != nil {
- panic("Bad benchmark input: " + err.Error())
- }
-}
-
-func BenchmarkUnmarshalText(b *testing.B) {
- pb := new(MyMessage)
- for i := 0; i < b.N; i++ {
- UnmarshalText(benchInput, pb)
- }
- b.SetBytes(int64(len(benchInput)))
-}
diff --git a/vendor/github.com/golang/protobuf/proto/text_test.go b/vendor/github.com/golang/protobuf/proto/text_test.go
deleted file mode 100644
index 39861d1c..00000000
--- a/vendor/github.com/golang/protobuf/proto/text_test.go
+++ /dev/null
@@ -1,441 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2010 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-package proto_test
-
-import (
- "bytes"
- "errors"
- "io/ioutil"
- "math"
- "strings"
- "testing"
-
- "github.com/golang/protobuf/proto"
-
- proto3pb "github.com/golang/protobuf/proto/proto3_proto"
- pb "github.com/golang/protobuf/proto/testdata"
-)
-
-// textMessage implements the methods that allow it to marshal and unmarshal
-// itself as text.
-type textMessage struct {
-}
-
-func (*textMessage) MarshalText() ([]byte, error) {
- return []byte("custom"), nil
-}
-
-func (*textMessage) UnmarshalText(bytes []byte) error {
- if string(bytes) != "custom" {
- return errors.New("expected 'custom'")
- }
- return nil
-}
-
-func (*textMessage) Reset() {}
-func (*textMessage) String() string { return "" }
-func (*textMessage) ProtoMessage() {}
-
-func newTestMessage() *pb.MyMessage {
- msg := &pb.MyMessage{
- Count: proto.Int32(42),
- Name: proto.String("Dave"),
- Quote: proto.String(`"I didn't want to go."`),
- Pet: []string{"bunny", "kitty", "horsey"},
- Inner: &pb.InnerMessage{
- Host: proto.String("footrest.syd"),
- Port: proto.Int32(7001),
- Connected: proto.Bool(true),
- },
- Others: []*pb.OtherMessage{
- {
- Key: proto.Int64(0xdeadbeef),
- Value: []byte{1, 65, 7, 12},
- },
- {
- Weight: proto.Float32(6.022),
- Inner: &pb.InnerMessage{
- Host: proto.String("lesha.mtv"),
- Port: proto.Int32(8002),
- },
- },
- },
- Bikeshed: pb.MyMessage_BLUE.Enum(),
- Somegroup: &pb.MyMessage_SomeGroup{
- GroupField: proto.Int32(8),
- },
- // One normally wouldn't do this.
- // This is an undeclared tag 13, as a varint (wire type 0) with value 4.
- XXX_unrecognized: []byte{13<<3 | 0, 4},
- }
- ext := &pb.Ext{
- Data: proto.String("Big gobs for big rats"),
- }
- if err := proto.SetExtension(msg, pb.E_Ext_More, ext); err != nil {
- panic(err)
- }
- greetings := []string{"adg", "easy", "cow"}
- if err := proto.SetExtension(msg, pb.E_Greeting, greetings); err != nil {
- panic(err)
- }
-
- // Add an unknown extension. We marshal a pb.Ext, and fake the ID.
- b, err := proto.Marshal(&pb.Ext{Data: proto.String("3G skiing")})
- if err != nil {
- panic(err)
- }
- b = append(proto.EncodeVarint(201<<3|proto.WireBytes), b...)
- proto.SetRawExtension(msg, 201, b)
-
- // Extensions can be plain fields, too, so let's test that.
- b = append(proto.EncodeVarint(202<<3|proto.WireVarint), 19)
- proto.SetRawExtension(msg, 202, b)
-
- return msg
-}
-
-const text = `count: 42
-name: "Dave"
-quote: "\"I didn't want to go.\""
-pet: "bunny"
-pet: "kitty"
-pet: "horsey"
-inner: <
- host: "footrest.syd"
- port: 7001
- connected: true
->
-others: <
- key: 3735928559
- value: "\001A\007\014"
->
-others: <
- weight: 6.022
- inner: <
- host: "lesha.mtv"
- port: 8002
- >
->
-bikeshed: BLUE
-SomeGroup {
- group_field: 8
-}
-/* 2 unknown bytes */
-13: 4
-[testdata.Ext.more]: <
- data: "Big gobs for big rats"
->
-[testdata.greeting]: "adg"
-[testdata.greeting]: "easy"
-[testdata.greeting]: "cow"
-/* 13 unknown bytes */
-201: "\t3G skiing"
-/* 3 unknown bytes */
-202: 19
-`
-
-func TestMarshalText(t *testing.T) {
- buf := new(bytes.Buffer)
- if err := proto.MarshalText(buf, newTestMessage()); err != nil {
- t.Fatalf("proto.MarshalText: %v", err)
- }
- s := buf.String()
- if s != text {
- t.Errorf("Got:\n===\n%v===\nExpected:\n===\n%v===\n", s, text)
- }
-}
-
-func TestMarshalTextCustomMessage(t *testing.T) {
- buf := new(bytes.Buffer)
- if err := proto.MarshalText(buf, &textMessage{}); err != nil {
- t.Fatalf("proto.MarshalText: %v", err)
- }
- s := buf.String()
- if s != "custom" {
- t.Errorf("Got %q, expected %q", s, "custom")
- }
-}
-func TestMarshalTextNil(t *testing.T) {
- want := ""
- tests := []proto.Message{nil, (*pb.MyMessage)(nil)}
- for i, test := range tests {
- buf := new(bytes.Buffer)
- if err := proto.MarshalText(buf, test); err != nil {
- t.Fatal(err)
- }
- if got := buf.String(); got != want {
- t.Errorf("%d: got %q want %q", i, got, want)
- }
- }
-}
-
-func TestMarshalTextUnknownEnum(t *testing.T) {
- // The Color enum only specifies values 0-2.
- m := &pb.MyMessage{Bikeshed: pb.MyMessage_Color(3).Enum()}
- got := m.String()
- const want = `bikeshed:3 `
- if got != want {
- t.Errorf("\n got %q\nwant %q", got, want)
- }
-}
-
-func BenchmarkMarshalTextBuffered(b *testing.B) {
- buf := new(bytes.Buffer)
- m := newTestMessage()
- for i := 0; i < b.N; i++ {
- buf.Reset()
- proto.MarshalText(buf, m)
- }
-}
-
-func BenchmarkMarshalTextUnbuffered(b *testing.B) {
- w := ioutil.Discard
- m := newTestMessage()
- for i := 0; i < b.N; i++ {
- proto.MarshalText(w, m)
- }
-}
-
-func compact(src string) string {
- // s/[ \n]+/ /g; s/ $//;
- dst := make([]byte, len(src))
- space, comment := false, false
- j := 0
- for i := 0; i < len(src); i++ {
- if strings.HasPrefix(src[i:], "/*") {
- comment = true
- i++
- continue
- }
- if comment && strings.HasPrefix(src[i:], "*/") {
- comment = false
- i++
- continue
- }
- if comment {
- continue
- }
- c := src[i]
- if c == ' ' || c == '\n' {
- space = true
- continue
- }
- if j > 0 && (dst[j-1] == ':' || dst[j-1] == '<' || dst[j-1] == '{') {
- space = false
- }
- if c == '{' {
- space = false
- }
- if space {
- dst[j] = ' '
- j++
- space = false
- }
- dst[j] = c
- j++
- }
- if space {
- dst[j] = ' '
- j++
- }
- return string(dst[0:j])
-}
-
-var compactText = compact(text)
-
-func TestCompactText(t *testing.T) {
- s := proto.CompactTextString(newTestMessage())
- if s != compactText {
- t.Errorf("Got:\n===\n%v===\nExpected:\n===\n%v\n===\n", s, compactText)
- }
-}
-
-func TestStringEscaping(t *testing.T) {
- testCases := []struct {
- in *pb.Strings
- out string
- }{
- {
- // Test data from C++ test (TextFormatTest.StringEscape).
- // Single divergence: we don't escape apostrophes.
- &pb.Strings{StringField: proto.String("\"A string with ' characters \n and \r newlines and \t tabs and \001 slashes \\ and multiple spaces")},
- "string_field: \"\\\"A string with ' characters \\n and \\r newlines and \\t tabs and \\001 slashes \\\\ and multiple spaces\"\n",
- },
- {
- // Test data from the same C++ test.
- &pb.Strings{StringField: proto.String("\350\260\267\346\255\214")},
- "string_field: \"\\350\\260\\267\\346\\255\\214\"\n",
- },
- {
- // Some UTF-8.
- &pb.Strings{StringField: proto.String("\x00\x01\xff\x81")},
- `string_field: "\000\001\377\201"` + "\n",
- },
- }
-
- for i, tc := range testCases {
- var buf bytes.Buffer
- if err := proto.MarshalText(&buf, tc.in); err != nil {
- t.Errorf("proto.MarsalText: %v", err)
- continue
- }
- s := buf.String()
- if s != tc.out {
- t.Errorf("#%d: Got:\n%s\nExpected:\n%s\n", i, s, tc.out)
- continue
- }
-
- // Check round-trip.
- pb := new(pb.Strings)
- if err := proto.UnmarshalText(s, pb); err != nil {
- t.Errorf("#%d: UnmarshalText: %v", i, err)
- continue
- }
- if !proto.Equal(pb, tc.in) {
- t.Errorf("#%d: Round-trip failed:\nstart: %v\n end: %v", i, tc.in, pb)
- }
- }
-}
-
-// A limitedWriter accepts some output before it fails.
-// This is a proxy for something like a nearly-full or imminently-failing disk,
-// or a network connection that is about to die.
-type limitedWriter struct {
- b bytes.Buffer
- limit int
-}
-
-var outOfSpace = errors.New("proto: insufficient space")
-
-func (w *limitedWriter) Write(p []byte) (n int, err error) {
- var avail = w.limit - w.b.Len()
- if avail <= 0 {
- return 0, outOfSpace
- }
- if len(p) <= avail {
- return w.b.Write(p)
- }
- n, _ = w.b.Write(p[:avail])
- return n, outOfSpace
-}
-
-func TestMarshalTextFailing(t *testing.T) {
- // Try lots of different sizes to exercise more error code-paths.
- for lim := 0; lim < len(text); lim++ {
- buf := new(limitedWriter)
- buf.limit = lim
- err := proto.MarshalText(buf, newTestMessage())
- // We expect a certain error, but also some partial results in the buffer.
- if err != outOfSpace {
- t.Errorf("Got:\n===\n%v===\nExpected:\n===\n%v===\n", err, outOfSpace)
- }
- s := buf.b.String()
- x := text[:buf.limit]
- if s != x {
- t.Errorf("Got:\n===\n%v===\nExpected:\n===\n%v===\n", s, x)
- }
- }
-}
-
-func TestFloats(t *testing.T) {
- tests := []struct {
- f float64
- want string
- }{
- {0, "0"},
- {4.7, "4.7"},
- {math.Inf(1), "inf"},
- {math.Inf(-1), "-inf"},
- {math.NaN(), "nan"},
- }
- for _, test := range tests {
- msg := &pb.FloatingPoint{F: &test.f}
- got := strings.TrimSpace(msg.String())
- want := `f:` + test.want
- if got != want {
- t.Errorf("f=%f: got %q, want %q", test.f, got, want)
- }
- }
-}
-
-func TestRepeatedNilText(t *testing.T) {
- m := &pb.MessageList{
- Message: []*pb.MessageList_Message{
- nil,
- &pb.MessageList_Message{
- Name: proto.String("Horse"),
- },
- nil,
- },
- }
- want := `Message
-Message {
- name: "Horse"
-}
-Message
-`
- if s := proto.MarshalTextString(m); s != want {
- t.Errorf(" got: %s\nwant: %s", s, want)
- }
-}
-
-func TestProto3Text(t *testing.T) {
- tests := []struct {
- m proto.Message
- want string
- }{
- // zero message
- {&proto3pb.Message{}, ``},
- // zero message except for an empty byte slice
- {&proto3pb.Message{Data: []byte{}}, ``},
- // trivial case
- {&proto3pb.Message{Name: "Rob", HeightInCm: 175}, `name:"Rob" height_in_cm:175`},
- // empty map
- {&pb.MessageWithMap{}, ``},
- // non-empty map; current map format is the same as a repeated struct
- {
- &pb.MessageWithMap{NameMapping: map[int32]string{1234: "Feist"}},
- `name_mapping:`,
- },
- // map with nil value; not well-defined, but we shouldn't crash
- {
- &pb.MessageWithMap{MsgMapping: map[int64]*pb.FloatingPoint{7: nil}},
- `msg_mapping:`,
- },
- }
- for _, test := range tests {
- got := strings.TrimSpace(test.m.String())
- if got != test.want {
- t.Errorf("\n got %s\nwant %s", got, test.want)
- }
- }
-}
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/Makefile b/vendor/github.com/golang/protobuf/protoc-gen-go/Makefile
deleted file mode 100644
index a42cc371..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/Makefile
+++ /dev/null
@@ -1,33 +0,0 @@
-# Go support for Protocol Buffers - Google's data interchange format
-#
-# Copyright 2010 The Go Authors. All rights reserved.
-# https://github.com/golang/protobuf
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are
-# met:
-#
-# * Redistributions of source code must retain the above copyright
-# notice, this list of conditions and the following disclaimer.
-# * Redistributions in binary form must reproduce the above
-# copyright notice, this list of conditions and the following disclaimer
-# in the documentation and/or other materials provided with the
-# distribution.
-# * Neither the name of Google Inc. nor the names of its
-# contributors may be used to endorse or promote products derived from
-# this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-test:
- cd testdata && make test
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/descriptor/Makefile b/vendor/github.com/golang/protobuf/protoc-gen-go/descriptor/Makefile
deleted file mode 100644
index 9faf8086..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/descriptor/Makefile
+++ /dev/null
@@ -1,45 +0,0 @@
-# Go support for Protocol Buffers - Google's data interchange format
-#
-# Copyright 2010 The Go Authors. All rights reserved.
-# https://github.com/golang/protobuf
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are
-# met:
-#
-# * Redistributions of source code must retain the above copyright
-# notice, this list of conditions and the following disclaimer.
-# * Redistributions in binary form must reproduce the above
-# copyright notice, this list of conditions and the following disclaimer
-# in the documentation and/or other materials provided with the
-# distribution.
-# * Neither the name of Google Inc. nor the names of its
-# contributors may be used to endorse or promote products derived from
-# this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-# Not stored here, but descriptor.proto is in https://github.com/google/protobuf/
-# at src/google/protobuf/descriptor.proto
-regenerate:
- echo WARNING! THIS RULE IS PROBABLY NOT RIGHT FOR YOUR INSTALLATION
- cd $(HOME)/src/protobuf/src && \
- protoc --go_out=. ./google/protobuf/descriptor.proto && \
- sed -i 's,^package google_protobuf,package descriptor,' google/protobuf/descriptor.pb.go && \
- cp ./google/protobuf/descriptor.pb.go $(GOPATH)/src/github.com/golang/protobuf/protoc-gen-go/descriptor/descriptor.pb.go
-
-restore:
- cp descriptor.pb.golden descriptor.pb.go
-
-preserve:
- cp descriptor.pb.go descriptor.pb.golden
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/descriptor/descriptor.pb.golden b/vendor/github.com/golang/protobuf/protoc-gen-go/descriptor/descriptor.pb.golden
deleted file mode 100644
index 302c5686..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/descriptor/descriptor.pb.golden
+++ /dev/null
@@ -1,1024 +0,0 @@
-// Code generated by protoc-gen-go.
-// source: google/protobuf/descriptor.proto
-// DO NOT EDIT!
-
-package google_protobuf
-
-import proto "github.com/golang/protobuf/proto"
-import "math"
-
-// Reference proto and math imports to suppress error if they are not otherwise used.
-var _ = proto.GetString
-var _ = math.Inf
-
-type FieldDescriptorProto_Type int32
-
-const (
- FieldDescriptorProto_TYPE_DOUBLE FieldDescriptorProto_Type = 1
- FieldDescriptorProto_TYPE_FLOAT FieldDescriptorProto_Type = 2
- FieldDescriptorProto_TYPE_INT64 FieldDescriptorProto_Type = 3
- FieldDescriptorProto_TYPE_UINT64 FieldDescriptorProto_Type = 4
- FieldDescriptorProto_TYPE_INT32 FieldDescriptorProto_Type = 5
- FieldDescriptorProto_TYPE_FIXED64 FieldDescriptorProto_Type = 6
- FieldDescriptorProto_TYPE_FIXED32 FieldDescriptorProto_Type = 7
- FieldDescriptorProto_TYPE_BOOL FieldDescriptorProto_Type = 8
- FieldDescriptorProto_TYPE_STRING FieldDescriptorProto_Type = 9
- FieldDescriptorProto_TYPE_GROUP FieldDescriptorProto_Type = 10
- FieldDescriptorProto_TYPE_MESSAGE FieldDescriptorProto_Type = 11
- FieldDescriptorProto_TYPE_BYTES FieldDescriptorProto_Type = 12
- FieldDescriptorProto_TYPE_UINT32 FieldDescriptorProto_Type = 13
- FieldDescriptorProto_TYPE_ENUM FieldDescriptorProto_Type = 14
- FieldDescriptorProto_TYPE_SFIXED32 FieldDescriptorProto_Type = 15
- FieldDescriptorProto_TYPE_SFIXED64 FieldDescriptorProto_Type = 16
- FieldDescriptorProto_TYPE_SINT32 FieldDescriptorProto_Type = 17
- FieldDescriptorProto_TYPE_SINT64 FieldDescriptorProto_Type = 18
-)
-
-var FieldDescriptorProto_Type_name = map[int32]string{
- 1: "TYPE_DOUBLE",
- 2: "TYPE_FLOAT",
- 3: "TYPE_INT64",
- 4: "TYPE_UINT64",
- 5: "TYPE_INT32",
- 6: "TYPE_FIXED64",
- 7: "TYPE_FIXED32",
- 8: "TYPE_BOOL",
- 9: "TYPE_STRING",
- 10: "TYPE_GROUP",
- 11: "TYPE_MESSAGE",
- 12: "TYPE_BYTES",
- 13: "TYPE_UINT32",
- 14: "TYPE_ENUM",
- 15: "TYPE_SFIXED32",
- 16: "TYPE_SFIXED64",
- 17: "TYPE_SINT32",
- 18: "TYPE_SINT64",
-}
-var FieldDescriptorProto_Type_value = map[string]int32{
- "TYPE_DOUBLE": 1,
- "TYPE_FLOAT": 2,
- "TYPE_INT64": 3,
- "TYPE_UINT64": 4,
- "TYPE_INT32": 5,
- "TYPE_FIXED64": 6,
- "TYPE_FIXED32": 7,
- "TYPE_BOOL": 8,
- "TYPE_STRING": 9,
- "TYPE_GROUP": 10,
- "TYPE_MESSAGE": 11,
- "TYPE_BYTES": 12,
- "TYPE_UINT32": 13,
- "TYPE_ENUM": 14,
- "TYPE_SFIXED32": 15,
- "TYPE_SFIXED64": 16,
- "TYPE_SINT32": 17,
- "TYPE_SINT64": 18,
-}
-
-// NewFieldDescriptorProto_Type is deprecated. Use x.Enum() instead.
-func NewFieldDescriptorProto_Type(x FieldDescriptorProto_Type) *FieldDescriptorProto_Type {
- e := FieldDescriptorProto_Type(x)
- return &e
-}
-func (x FieldDescriptorProto_Type) Enum() *FieldDescriptorProto_Type {
- p := new(FieldDescriptorProto_Type)
- *p = x
- return p
-}
-func (x FieldDescriptorProto_Type) String() string {
- return proto.EnumName(FieldDescriptorProto_Type_name, int32(x))
-}
-
-type FieldDescriptorProto_Label int32
-
-const (
- FieldDescriptorProto_LABEL_OPTIONAL FieldDescriptorProto_Label = 1
- FieldDescriptorProto_LABEL_REQUIRED FieldDescriptorProto_Label = 2
- FieldDescriptorProto_LABEL_REPEATED FieldDescriptorProto_Label = 3
-)
-
-var FieldDescriptorProto_Label_name = map[int32]string{
- 1: "LABEL_OPTIONAL",
- 2: "LABEL_REQUIRED",
- 3: "LABEL_REPEATED",
-}
-var FieldDescriptorProto_Label_value = map[string]int32{
- "LABEL_OPTIONAL": 1,
- "LABEL_REQUIRED": 2,
- "LABEL_REPEATED": 3,
-}
-
-// NewFieldDescriptorProto_Label is deprecated. Use x.Enum() instead.
-func NewFieldDescriptorProto_Label(x FieldDescriptorProto_Label) *FieldDescriptorProto_Label {
- e := FieldDescriptorProto_Label(x)
- return &e
-}
-func (x FieldDescriptorProto_Label) Enum() *FieldDescriptorProto_Label {
- p := new(FieldDescriptorProto_Label)
- *p = x
- return p
-}
-func (x FieldDescriptorProto_Label) String() string {
- return proto.EnumName(FieldDescriptorProto_Label_name, int32(x))
-}
-
-type FileOptions_OptimizeMode int32
-
-const (
- FileOptions_SPEED FileOptions_OptimizeMode = 1
- FileOptions_CODE_SIZE FileOptions_OptimizeMode = 2
- FileOptions_LITE_RUNTIME FileOptions_OptimizeMode = 3
-)
-
-var FileOptions_OptimizeMode_name = map[int32]string{
- 1: "SPEED",
- 2: "CODE_SIZE",
- 3: "LITE_RUNTIME",
-}
-var FileOptions_OptimizeMode_value = map[string]int32{
- "SPEED": 1,
- "CODE_SIZE": 2,
- "LITE_RUNTIME": 3,
-}
-
-// NewFileOptions_OptimizeMode is deprecated. Use x.Enum() instead.
-func NewFileOptions_OptimizeMode(x FileOptions_OptimizeMode) *FileOptions_OptimizeMode {
- e := FileOptions_OptimizeMode(x)
- return &e
-}
-func (x FileOptions_OptimizeMode) Enum() *FileOptions_OptimizeMode {
- p := new(FileOptions_OptimizeMode)
- *p = x
- return p
-}
-func (x FileOptions_OptimizeMode) String() string {
- return proto.EnumName(FileOptions_OptimizeMode_name, int32(x))
-}
-
-type FieldOptions_CType int32
-
-const (
- FieldOptions_STRING FieldOptions_CType = 0
- FieldOptions_CORD FieldOptions_CType = 1
- FieldOptions_STRING_PIECE FieldOptions_CType = 2
-)
-
-var FieldOptions_CType_name = map[int32]string{
- 0: "STRING",
- 1: "CORD",
- 2: "STRING_PIECE",
-}
-var FieldOptions_CType_value = map[string]int32{
- "STRING": 0,
- "CORD": 1,
- "STRING_PIECE": 2,
-}
-
-// NewFieldOptions_CType is deprecated. Use x.Enum() instead.
-func NewFieldOptions_CType(x FieldOptions_CType) *FieldOptions_CType {
- e := FieldOptions_CType(x)
- return &e
-}
-func (x FieldOptions_CType) Enum() *FieldOptions_CType {
- p := new(FieldOptions_CType)
- *p = x
- return p
-}
-func (x FieldOptions_CType) String() string {
- return proto.EnumName(FieldOptions_CType_name, int32(x))
-}
-
-type StreamOptions_TokenUnit int32
-
-const (
- StreamOptions_MESSAGE StreamOptions_TokenUnit = 0
- StreamOptions_BYTE StreamOptions_TokenUnit = 1
-)
-
-var StreamOptions_TokenUnit_name = map[int32]string{
- 0: "MESSAGE",
- 1: "BYTE",
-}
-var StreamOptions_TokenUnit_value = map[string]int32{
- "MESSAGE": 0,
- "BYTE": 1,
-}
-
-// NewStreamOptions_TokenUnit is deprecated. Use x.Enum() instead.
-func NewStreamOptions_TokenUnit(x StreamOptions_TokenUnit) *StreamOptions_TokenUnit {
- e := StreamOptions_TokenUnit(x)
- return &e
-}
-func (x StreamOptions_TokenUnit) Enum() *StreamOptions_TokenUnit {
- p := new(StreamOptions_TokenUnit)
- *p = x
- return p
-}
-func (x StreamOptions_TokenUnit) String() string {
- return proto.EnumName(StreamOptions_TokenUnit_name, int32(x))
-}
-
-type FileDescriptorSet struct {
- File []*FileDescriptorProto `protobuf:"bytes,1,rep,name=file" json:"file,omitempty"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (this *FileDescriptorSet) Reset() { *this = FileDescriptorSet{} }
-func (this *FileDescriptorSet) String() string { return proto.CompactTextString(this) }
-func (*FileDescriptorSet) ProtoMessage() {}
-
-type FileDescriptorProto struct {
- Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
- Package *string `protobuf:"bytes,2,opt,name=package" json:"package,omitempty"`
- Dependency []string `protobuf:"bytes,3,rep,name=dependency" json:"dependency,omitempty"`
- PublicDependency []int32 `protobuf:"varint,10,rep,name=public_dependency" json:"public_dependency,omitempty"`
- WeakDependency []int32 `protobuf:"varint,11,rep,name=weak_dependency" json:"weak_dependency,omitempty"`
- MessageType []*DescriptorProto `protobuf:"bytes,4,rep,name=message_type" json:"message_type,omitempty"`
- EnumType []*EnumDescriptorProto `protobuf:"bytes,5,rep,name=enum_type" json:"enum_type,omitempty"`
- Service []*ServiceDescriptorProto `protobuf:"bytes,6,rep,name=service" json:"service,omitempty"`
- Extension []*FieldDescriptorProto `protobuf:"bytes,7,rep,name=extension" json:"extension,omitempty"`
- Options *FileOptions `protobuf:"bytes,8,opt,name=options" json:"options,omitempty"`
- SourceCodeInfo *SourceCodeInfo `protobuf:"bytes,9,opt,name=source_code_info" json:"source_code_info,omitempty"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (this *FileDescriptorProto) Reset() { *this = FileDescriptorProto{} }
-func (this *FileDescriptorProto) String() string { return proto.CompactTextString(this) }
-func (*FileDescriptorProto) ProtoMessage() {}
-
-func (this *FileDescriptorProto) GetName() string {
- if this != nil && this.Name != nil {
- return *this.Name
- }
- return ""
-}
-
-func (this *FileDescriptorProto) GetPackage() string {
- if this != nil && this.Package != nil {
- return *this.Package
- }
- return ""
-}
-
-func (this *FileDescriptorProto) GetOptions() *FileOptions {
- if this != nil {
- return this.Options
- }
- return nil
-}
-
-func (this *FileDescriptorProto) GetSourceCodeInfo() *SourceCodeInfo {
- if this != nil {
- return this.SourceCodeInfo
- }
- return nil
-}
-
-type DescriptorProto struct {
- Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
- Field []*FieldDescriptorProto `protobuf:"bytes,2,rep,name=field" json:"field,omitempty"`
- Extension []*FieldDescriptorProto `protobuf:"bytes,6,rep,name=extension" json:"extension,omitempty"`
- NestedType []*DescriptorProto `protobuf:"bytes,3,rep,name=nested_type" json:"nested_type,omitempty"`
- EnumType []*EnumDescriptorProto `protobuf:"bytes,4,rep,name=enum_type" json:"enum_type,omitempty"`
- ExtensionRange []*DescriptorProto_ExtensionRange `protobuf:"bytes,5,rep,name=extension_range" json:"extension_range,omitempty"`
- Options *MessageOptions `protobuf:"bytes,7,opt,name=options" json:"options,omitempty"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (this *DescriptorProto) Reset() { *this = DescriptorProto{} }
-func (this *DescriptorProto) String() string { return proto.CompactTextString(this) }
-func (*DescriptorProto) ProtoMessage() {}
-
-func (this *DescriptorProto) GetName() string {
- if this != nil && this.Name != nil {
- return *this.Name
- }
- return ""
-}
-
-func (this *DescriptorProto) GetOptions() *MessageOptions {
- if this != nil {
- return this.Options
- }
- return nil
-}
-
-type DescriptorProto_ExtensionRange struct {
- Start *int32 `protobuf:"varint,1,opt,name=start" json:"start,omitempty"`
- End *int32 `protobuf:"varint,2,opt,name=end" json:"end,omitempty"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (this *DescriptorProto_ExtensionRange) Reset() { *this = DescriptorProto_ExtensionRange{} }
-func (this *DescriptorProto_ExtensionRange) String() string { return proto.CompactTextString(this) }
-func (*DescriptorProto_ExtensionRange) ProtoMessage() {}
-
-func (this *DescriptorProto_ExtensionRange) GetStart() int32 {
- if this != nil && this.Start != nil {
- return *this.Start
- }
- return 0
-}
-
-func (this *DescriptorProto_ExtensionRange) GetEnd() int32 {
- if this != nil && this.End != nil {
- return *this.End
- }
- return 0
-}
-
-type FieldDescriptorProto struct {
- Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
- Number *int32 `protobuf:"varint,3,opt,name=number" json:"number,omitempty"`
- Label *FieldDescriptorProto_Label `protobuf:"varint,4,opt,name=label,enum=proto2.FieldDescriptorProto_Label" json:"label,omitempty"`
- Type *FieldDescriptorProto_Type `protobuf:"varint,5,opt,name=type,enum=proto2.FieldDescriptorProto_Type" json:"type,omitempty"`
- TypeName *string `protobuf:"bytes,6,opt,name=type_name" json:"type_name,omitempty"`
- Extendee *string `protobuf:"bytes,2,opt,name=extendee" json:"extendee,omitempty"`
- DefaultValue *string `protobuf:"bytes,7,opt,name=default_value" json:"default_value,omitempty"`
- Options *FieldOptions `protobuf:"bytes,8,opt,name=options" json:"options,omitempty"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (this *FieldDescriptorProto) Reset() { *this = FieldDescriptorProto{} }
-func (this *FieldDescriptorProto) String() string { return proto.CompactTextString(this) }
-func (*FieldDescriptorProto) ProtoMessage() {}
-
-func (this *FieldDescriptorProto) GetName() string {
- if this != nil && this.Name != nil {
- return *this.Name
- }
- return ""
-}
-
-func (this *FieldDescriptorProto) GetNumber() int32 {
- if this != nil && this.Number != nil {
- return *this.Number
- }
- return 0
-}
-
-func (this *FieldDescriptorProto) GetLabel() FieldDescriptorProto_Label {
- if this != nil && this.Label != nil {
- return *this.Label
- }
- return 0
-}
-
-func (this *FieldDescriptorProto) GetType() FieldDescriptorProto_Type {
- if this != nil && this.Type != nil {
- return *this.Type
- }
- return 0
-}
-
-func (this *FieldDescriptorProto) GetTypeName() string {
- if this != nil && this.TypeName != nil {
- return *this.TypeName
- }
- return ""
-}
-
-func (this *FieldDescriptorProto) GetExtendee() string {
- if this != nil && this.Extendee != nil {
- return *this.Extendee
- }
- return ""
-}
-
-func (this *FieldDescriptorProto) GetDefaultValue() string {
- if this != nil && this.DefaultValue != nil {
- return *this.DefaultValue
- }
- return ""
-}
-
-func (this *FieldDescriptorProto) GetOptions() *FieldOptions {
- if this != nil {
- return this.Options
- }
- return nil
-}
-
-type EnumDescriptorProto struct {
- Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
- Value []*EnumValueDescriptorProto `protobuf:"bytes,2,rep,name=value" json:"value,omitempty"`
- Options *EnumOptions `protobuf:"bytes,3,opt,name=options" json:"options,omitempty"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (this *EnumDescriptorProto) Reset() { *this = EnumDescriptorProto{} }
-func (this *EnumDescriptorProto) String() string { return proto.CompactTextString(this) }
-func (*EnumDescriptorProto) ProtoMessage() {}
-
-func (this *EnumDescriptorProto) GetName() string {
- if this != nil && this.Name != nil {
- return *this.Name
- }
- return ""
-}
-
-func (this *EnumDescriptorProto) GetOptions() *EnumOptions {
- if this != nil {
- return this.Options
- }
- return nil
-}
-
-type EnumValueDescriptorProto struct {
- Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
- Number *int32 `protobuf:"varint,2,opt,name=number" json:"number,omitempty"`
- Options *EnumValueOptions `protobuf:"bytes,3,opt,name=options" json:"options,omitempty"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (this *EnumValueDescriptorProto) Reset() { *this = EnumValueDescriptorProto{} }
-func (this *EnumValueDescriptorProto) String() string { return proto.CompactTextString(this) }
-func (*EnumValueDescriptorProto) ProtoMessage() {}
-
-func (this *EnumValueDescriptorProto) GetName() string {
- if this != nil && this.Name != nil {
- return *this.Name
- }
- return ""
-}
-
-func (this *EnumValueDescriptorProto) GetNumber() int32 {
- if this != nil && this.Number != nil {
- return *this.Number
- }
- return 0
-}
-
-func (this *EnumValueDescriptorProto) GetOptions() *EnumValueOptions {
- if this != nil {
- return this.Options
- }
- return nil
-}
-
-type ServiceDescriptorProto struct {
- Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
- Method []*MethodDescriptorProto `protobuf:"bytes,2,rep,name=method" json:"method,omitempty"`
- Stream []*StreamDescriptorProto `protobuf:"bytes,4,rep,name=stream" json:"stream,omitempty"`
- Options *ServiceOptions `protobuf:"bytes,3,opt,name=options" json:"options,omitempty"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (this *ServiceDescriptorProto) Reset() { *this = ServiceDescriptorProto{} }
-func (this *ServiceDescriptorProto) String() string { return proto.CompactTextString(this) }
-func (*ServiceDescriptorProto) ProtoMessage() {}
-
-func (this *ServiceDescriptorProto) GetName() string {
- if this != nil && this.Name != nil {
- return *this.Name
- }
- return ""
-}
-
-func (this *ServiceDescriptorProto) GetOptions() *ServiceOptions {
- if this != nil {
- return this.Options
- }
- return nil
-}
-
-type MethodDescriptorProto struct {
- Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
- InputType *string `protobuf:"bytes,2,opt,name=input_type" json:"input_type,omitempty"`
- OutputType *string `protobuf:"bytes,3,opt,name=output_type" json:"output_type,omitempty"`
- Options *MethodOptions `protobuf:"bytes,4,opt,name=options" json:"options,omitempty"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (this *MethodDescriptorProto) Reset() { *this = MethodDescriptorProto{} }
-func (this *MethodDescriptorProto) String() string { return proto.CompactTextString(this) }
-func (*MethodDescriptorProto) ProtoMessage() {}
-
-func (this *MethodDescriptorProto) GetName() string {
- if this != nil && this.Name != nil {
- return *this.Name
- }
- return ""
-}
-
-func (this *MethodDescriptorProto) GetInputType() string {
- if this != nil && this.InputType != nil {
- return *this.InputType
- }
- return ""
-}
-
-func (this *MethodDescriptorProto) GetOutputType() string {
- if this != nil && this.OutputType != nil {
- return *this.OutputType
- }
- return ""
-}
-
-func (this *MethodDescriptorProto) GetOptions() *MethodOptions {
- if this != nil {
- return this.Options
- }
- return nil
-}
-
-type StreamDescriptorProto struct {
- Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
- ClientMessageType *string `protobuf:"bytes,2,opt,name=client_message_type" json:"client_message_type,omitempty"`
- ServerMessageType *string `protobuf:"bytes,3,opt,name=server_message_type" json:"server_message_type,omitempty"`
- Options *StreamOptions `protobuf:"bytes,4,opt,name=options" json:"options,omitempty"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (this *StreamDescriptorProto) Reset() { *this = StreamDescriptorProto{} }
-func (this *StreamDescriptorProto) String() string { return proto.CompactTextString(this) }
-func (*StreamDescriptorProto) ProtoMessage() {}
-
-func (this *StreamDescriptorProto) GetName() string {
- if this != nil && this.Name != nil {
- return *this.Name
- }
- return ""
-}
-
-func (this *StreamDescriptorProto) GetClientMessageType() string {
- if this != nil && this.ClientMessageType != nil {
- return *this.ClientMessageType
- }
- return ""
-}
-
-func (this *StreamDescriptorProto) GetServerMessageType() string {
- if this != nil && this.ServerMessageType != nil {
- return *this.ServerMessageType
- }
- return ""
-}
-
-func (this *StreamDescriptorProto) GetOptions() *StreamOptions {
- if this != nil {
- return this.Options
- }
- return nil
-}
-
-type FileOptions struct {
- JavaPackage *string `protobuf:"bytes,1,opt,name=java_package" json:"java_package,omitempty"`
- JavaOuterClassname *string `protobuf:"bytes,8,opt,name=java_outer_classname" json:"java_outer_classname,omitempty"`
- JavaMultipleFiles *bool `protobuf:"varint,10,opt,name=java_multiple_files,def=0" json:"java_multiple_files,omitempty"`
- JavaGenerateEqualsAndHash *bool `protobuf:"varint,20,opt,name=java_generate_equals_and_hash,def=0" json:"java_generate_equals_and_hash,omitempty"`
- OptimizeFor *FileOptions_OptimizeMode `protobuf:"varint,9,opt,name=optimize_for,enum=proto2.FileOptions_OptimizeMode,def=1" json:"optimize_for,omitempty"`
- GoPackage *string `protobuf:"bytes,11,opt,name=go_package" json:"go_package,omitempty"`
- CcGenericServices *bool `protobuf:"varint,16,opt,name=cc_generic_services,def=0" json:"cc_generic_services,omitempty"`
- JavaGenericServices *bool `protobuf:"varint,17,opt,name=java_generic_services,def=0" json:"java_generic_services,omitempty"`
- PyGenericServices *bool `protobuf:"varint,18,opt,name=py_generic_services,def=0" json:"py_generic_services,omitempty"`
- UninterpretedOption []*UninterpretedOption `protobuf:"bytes,999,rep,name=uninterpreted_option" json:"uninterpreted_option,omitempty"`
- XXX_extensions map[int32]proto.Extension `json:"-"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (this *FileOptions) Reset() { *this = FileOptions{} }
-func (this *FileOptions) String() string { return proto.CompactTextString(this) }
-func (*FileOptions) ProtoMessage() {}
-
-var extRange_FileOptions = []proto.ExtensionRange{
- {1000, 536870911},
-}
-
-func (*FileOptions) ExtensionRangeArray() []proto.ExtensionRange {
- return extRange_FileOptions
-}
-func (this *FileOptions) ExtensionMap() map[int32]proto.Extension {
- if this.XXX_extensions == nil {
- this.XXX_extensions = make(map[int32]proto.Extension)
- }
- return this.XXX_extensions
-}
-
-const Default_FileOptions_JavaMultipleFiles bool = false
-const Default_FileOptions_JavaGenerateEqualsAndHash bool = false
-const Default_FileOptions_OptimizeFor FileOptions_OptimizeMode = FileOptions_SPEED
-const Default_FileOptions_CcGenericServices bool = false
-const Default_FileOptions_JavaGenericServices bool = false
-const Default_FileOptions_PyGenericServices bool = false
-
-func (this *FileOptions) GetJavaPackage() string {
- if this != nil && this.JavaPackage != nil {
- return *this.JavaPackage
- }
- return ""
-}
-
-func (this *FileOptions) GetJavaOuterClassname() string {
- if this != nil && this.JavaOuterClassname != nil {
- return *this.JavaOuterClassname
- }
- return ""
-}
-
-func (this *FileOptions) GetJavaMultipleFiles() bool {
- if this != nil && this.JavaMultipleFiles != nil {
- return *this.JavaMultipleFiles
- }
- return Default_FileOptions_JavaMultipleFiles
-}
-
-func (this *FileOptions) GetJavaGenerateEqualsAndHash() bool {
- if this != nil && this.JavaGenerateEqualsAndHash != nil {
- return *this.JavaGenerateEqualsAndHash
- }
- return Default_FileOptions_JavaGenerateEqualsAndHash
-}
-
-func (this *FileOptions) GetOptimizeFor() FileOptions_OptimizeMode {
- if this != nil && this.OptimizeFor != nil {
- return *this.OptimizeFor
- }
- return Default_FileOptions_OptimizeFor
-}
-
-func (this *FileOptions) GetGoPackage() string {
- if this != nil && this.GoPackage != nil {
- return *this.GoPackage
- }
- return ""
-}
-
-func (this *FileOptions) GetCcGenericServices() bool {
- if this != nil && this.CcGenericServices != nil {
- return *this.CcGenericServices
- }
- return Default_FileOptions_CcGenericServices
-}
-
-func (this *FileOptions) GetJavaGenericServices() bool {
- if this != nil && this.JavaGenericServices != nil {
- return *this.JavaGenericServices
- }
- return Default_FileOptions_JavaGenericServices
-}
-
-func (this *FileOptions) GetPyGenericServices() bool {
- if this != nil && this.PyGenericServices != nil {
- return *this.PyGenericServices
- }
- return Default_FileOptions_PyGenericServices
-}
-
-type MessageOptions struct {
- MessageSetWireFormat *bool `protobuf:"varint,1,opt,name=message_set_wire_format,def=0" json:"message_set_wire_format,omitempty"`
- NoStandardDescriptorAccessor *bool `protobuf:"varint,2,opt,name=no_standard_descriptor_accessor,def=0" json:"no_standard_descriptor_accessor,omitempty"`
- UninterpretedOption []*UninterpretedOption `protobuf:"bytes,999,rep,name=uninterpreted_option" json:"uninterpreted_option,omitempty"`
- XXX_extensions map[int32]proto.Extension `json:"-"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (this *MessageOptions) Reset() { *this = MessageOptions{} }
-func (this *MessageOptions) String() string { return proto.CompactTextString(this) }
-func (*MessageOptions) ProtoMessage() {}
-
-var extRange_MessageOptions = []proto.ExtensionRange{
- {1000, 536870911},
-}
-
-func (*MessageOptions) ExtensionRangeArray() []proto.ExtensionRange {
- return extRange_MessageOptions
-}
-func (this *MessageOptions) ExtensionMap() map[int32]proto.Extension {
- if this.XXX_extensions == nil {
- this.XXX_extensions = make(map[int32]proto.Extension)
- }
- return this.XXX_extensions
-}
-
-const Default_MessageOptions_MessageSetWireFormat bool = false
-const Default_MessageOptions_NoStandardDescriptorAccessor bool = false
-
-func (this *MessageOptions) GetMessageSetWireFormat() bool {
- if this != nil && this.MessageSetWireFormat != nil {
- return *this.MessageSetWireFormat
- }
- return Default_MessageOptions_MessageSetWireFormat
-}
-
-func (this *MessageOptions) GetNoStandardDescriptorAccessor() bool {
- if this != nil && this.NoStandardDescriptorAccessor != nil {
- return *this.NoStandardDescriptorAccessor
- }
- return Default_MessageOptions_NoStandardDescriptorAccessor
-}
-
-type FieldOptions struct {
- Ctype *FieldOptions_CType `protobuf:"varint,1,opt,name=ctype,enum=proto2.FieldOptions_CType,def=0" json:"ctype,omitempty"`
- Packed *bool `protobuf:"varint,2,opt,name=packed" json:"packed,omitempty"`
- Lazy *bool `protobuf:"varint,5,opt,name=lazy,def=0" json:"lazy,omitempty"`
- Deprecated *bool `protobuf:"varint,3,opt,name=deprecated,def=0" json:"deprecated,omitempty"`
- ExperimentalMapKey *string `protobuf:"bytes,9,opt,name=experimental_map_key" json:"experimental_map_key,omitempty"`
- Weak *bool `protobuf:"varint,10,opt,name=weak,def=0" json:"weak,omitempty"`
- UninterpretedOption []*UninterpretedOption `protobuf:"bytes,999,rep,name=uninterpreted_option" json:"uninterpreted_option,omitempty"`
- XXX_extensions map[int32]proto.Extension `json:"-"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (this *FieldOptions) Reset() { *this = FieldOptions{} }
-func (this *FieldOptions) String() string { return proto.CompactTextString(this) }
-func (*FieldOptions) ProtoMessage() {}
-
-var extRange_FieldOptions = []proto.ExtensionRange{
- {1000, 536870911},
-}
-
-func (*FieldOptions) ExtensionRangeArray() []proto.ExtensionRange {
- return extRange_FieldOptions
-}
-func (this *FieldOptions) ExtensionMap() map[int32]proto.Extension {
- if this.XXX_extensions == nil {
- this.XXX_extensions = make(map[int32]proto.Extension)
- }
- return this.XXX_extensions
-}
-
-const Default_FieldOptions_Ctype FieldOptions_CType = FieldOptions_STRING
-const Default_FieldOptions_Lazy bool = false
-const Default_FieldOptions_Deprecated bool = false
-const Default_FieldOptions_Weak bool = false
-
-func (this *FieldOptions) GetCtype() FieldOptions_CType {
- if this != nil && this.Ctype != nil {
- return *this.Ctype
- }
- return Default_FieldOptions_Ctype
-}
-
-func (this *FieldOptions) GetPacked() bool {
- if this != nil && this.Packed != nil {
- return *this.Packed
- }
- return false
-}
-
-func (this *FieldOptions) GetLazy() bool {
- if this != nil && this.Lazy != nil {
- return *this.Lazy
- }
- return Default_FieldOptions_Lazy
-}
-
-func (this *FieldOptions) GetDeprecated() bool {
- if this != nil && this.Deprecated != nil {
- return *this.Deprecated
- }
- return Default_FieldOptions_Deprecated
-}
-
-func (this *FieldOptions) GetExperimentalMapKey() string {
- if this != nil && this.ExperimentalMapKey != nil {
- return *this.ExperimentalMapKey
- }
- return ""
-}
-
-func (this *FieldOptions) GetWeak() bool {
- if this != nil && this.Weak != nil {
- return *this.Weak
- }
- return Default_FieldOptions_Weak
-}
-
-type EnumOptions struct {
- AllowAlias *bool `protobuf:"varint,2,opt,name=allow_alias,def=1" json:"allow_alias,omitempty"`
- UninterpretedOption []*UninterpretedOption `protobuf:"bytes,999,rep,name=uninterpreted_option" json:"uninterpreted_option,omitempty"`
- XXX_extensions map[int32]proto.Extension `json:"-"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (this *EnumOptions) Reset() { *this = EnumOptions{} }
-func (this *EnumOptions) String() string { return proto.CompactTextString(this) }
-func (*EnumOptions) ProtoMessage() {}
-
-var extRange_EnumOptions = []proto.ExtensionRange{
- {1000, 536870911},
-}
-
-func (*EnumOptions) ExtensionRangeArray() []proto.ExtensionRange {
- return extRange_EnumOptions
-}
-func (this *EnumOptions) ExtensionMap() map[int32]proto.Extension {
- if this.XXX_extensions == nil {
- this.XXX_extensions = make(map[int32]proto.Extension)
- }
- return this.XXX_extensions
-}
-
-const Default_EnumOptions_AllowAlias bool = true
-
-func (this *EnumOptions) GetAllowAlias() bool {
- if this != nil && this.AllowAlias != nil {
- return *this.AllowAlias
- }
- return Default_EnumOptions_AllowAlias
-}
-
-type EnumValueOptions struct {
- UninterpretedOption []*UninterpretedOption `protobuf:"bytes,999,rep,name=uninterpreted_option" json:"uninterpreted_option,omitempty"`
- XXX_extensions map[int32]proto.Extension `json:"-"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (this *EnumValueOptions) Reset() { *this = EnumValueOptions{} }
-func (this *EnumValueOptions) String() string { return proto.CompactTextString(this) }
-func (*EnumValueOptions) ProtoMessage() {}
-
-var extRange_EnumValueOptions = []proto.ExtensionRange{
- {1000, 536870911},
-}
-
-func (*EnumValueOptions) ExtensionRangeArray() []proto.ExtensionRange {
- return extRange_EnumValueOptions
-}
-func (this *EnumValueOptions) ExtensionMap() map[int32]proto.Extension {
- if this.XXX_extensions == nil {
- this.XXX_extensions = make(map[int32]proto.Extension)
- }
- return this.XXX_extensions
-}
-
-type ServiceOptions struct {
- UninterpretedOption []*UninterpretedOption `protobuf:"bytes,999,rep,name=uninterpreted_option" json:"uninterpreted_option,omitempty"`
- XXX_extensions map[int32]proto.Extension `json:"-"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (this *ServiceOptions) Reset() { *this = ServiceOptions{} }
-func (this *ServiceOptions) String() string { return proto.CompactTextString(this) }
-func (*ServiceOptions) ProtoMessage() {}
-
-var extRange_ServiceOptions = []proto.ExtensionRange{
- {1000, 536870911},
-}
-
-func (*ServiceOptions) ExtensionRangeArray() []proto.ExtensionRange {
- return extRange_ServiceOptions
-}
-func (this *ServiceOptions) ExtensionMap() map[int32]proto.Extension {
- if this.XXX_extensions == nil {
- this.XXX_extensions = make(map[int32]proto.Extension)
- }
- return this.XXX_extensions
-}
-
-type MethodOptions struct {
- UninterpretedOption []*UninterpretedOption `protobuf:"bytes,999,rep,name=uninterpreted_option" json:"uninterpreted_option,omitempty"`
- XXX_extensions map[int32]proto.Extension `json:"-"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (this *MethodOptions) Reset() { *this = MethodOptions{} }
-func (this *MethodOptions) String() string { return proto.CompactTextString(this) }
-func (*MethodOptions) ProtoMessage() {}
-
-var extRange_MethodOptions = []proto.ExtensionRange{
- {1000, 536870911},
-}
-
-func (*MethodOptions) ExtensionRangeArray() []proto.ExtensionRange {
- return extRange_MethodOptions
-}
-func (this *MethodOptions) ExtensionMap() map[int32]proto.Extension {
- if this.XXX_extensions == nil {
- this.XXX_extensions = make(map[int32]proto.Extension)
- }
- return this.XXX_extensions
-}
-
-type StreamOptions struct {
- UninterpretedOption []*UninterpretedOption `protobuf:"bytes,999,rep,name=uninterpreted_option" json:"uninterpreted_option,omitempty"`
- XXX_extensions map[int32]proto.Extension `json:"-"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (this *StreamOptions) Reset() { *this = StreamOptions{} }
-func (this *StreamOptions) String() string { return proto.CompactTextString(this) }
-func (*StreamOptions) ProtoMessage() {}
-
-var extRange_StreamOptions = []proto.ExtensionRange{
- {1000, 536870911},
-}
-
-func (*StreamOptions) ExtensionRangeArray() []proto.ExtensionRange {
- return extRange_StreamOptions
-}
-func (this *StreamOptions) ExtensionMap() map[int32]proto.Extension {
- if this.XXX_extensions == nil {
- this.XXX_extensions = make(map[int32]proto.Extension)
- }
- return this.XXX_extensions
-}
-
-type UninterpretedOption struct {
- Name []*UninterpretedOption_NamePart `protobuf:"bytes,2,rep,name=name" json:"name,omitempty"`
- IdentifierValue *string `protobuf:"bytes,3,opt,name=identifier_value" json:"identifier_value,omitempty"`
- PositiveIntValue *uint64 `protobuf:"varint,4,opt,name=positive_int_value" json:"positive_int_value,omitempty"`
- NegativeIntValue *int64 `protobuf:"varint,5,opt,name=negative_int_value" json:"negative_int_value,omitempty"`
- DoubleValue *float64 `protobuf:"fixed64,6,opt,name=double_value" json:"double_value,omitempty"`
- StringValue []byte `protobuf:"bytes,7,opt,name=string_value" json:"string_value,omitempty"`
- AggregateValue *string `protobuf:"bytes,8,opt,name=aggregate_value" json:"aggregate_value,omitempty"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (this *UninterpretedOption) Reset() { *this = UninterpretedOption{} }
-func (this *UninterpretedOption) String() string { return proto.CompactTextString(this) }
-func (*UninterpretedOption) ProtoMessage() {}
-
-func (this *UninterpretedOption) GetIdentifierValue() string {
- if this != nil && this.IdentifierValue != nil {
- return *this.IdentifierValue
- }
- return ""
-}
-
-func (this *UninterpretedOption) GetPositiveIntValue() uint64 {
- if this != nil && this.PositiveIntValue != nil {
- return *this.PositiveIntValue
- }
- return 0
-}
-
-func (this *UninterpretedOption) GetNegativeIntValue() int64 {
- if this != nil && this.NegativeIntValue != nil {
- return *this.NegativeIntValue
- }
- return 0
-}
-
-func (this *UninterpretedOption) GetDoubleValue() float64 {
- if this != nil && this.DoubleValue != nil {
- return *this.DoubleValue
- }
- return 0
-}
-
-func (this *UninterpretedOption) GetStringValue() []byte {
- if this != nil {
- return this.StringValue
- }
- return nil
-}
-
-func (this *UninterpretedOption) GetAggregateValue() string {
- if this != nil && this.AggregateValue != nil {
- return *this.AggregateValue
- }
- return ""
-}
-
-type UninterpretedOption_NamePart struct {
- NamePart *string `protobuf:"bytes,1,req,name=name_part" json:"name_part,omitempty"`
- IsExtension *bool `protobuf:"varint,2,req,name=is_extension" json:"is_extension,omitempty"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (this *UninterpretedOption_NamePart) Reset() { *this = UninterpretedOption_NamePart{} }
-func (this *UninterpretedOption_NamePart) String() string { return proto.CompactTextString(this) }
-func (*UninterpretedOption_NamePart) ProtoMessage() {}
-
-func (this *UninterpretedOption_NamePart) GetNamePart() string {
- if this != nil && this.NamePart != nil {
- return *this.NamePart
- }
- return ""
-}
-
-func (this *UninterpretedOption_NamePart) GetIsExtension() bool {
- if this != nil && this.IsExtension != nil {
- return *this.IsExtension
- }
- return false
-}
-
-type SourceCodeInfo struct {
- Location []*SourceCodeInfo_Location `protobuf:"bytes,1,rep,name=location" json:"location,omitempty"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (this *SourceCodeInfo) Reset() { *this = SourceCodeInfo{} }
-func (this *SourceCodeInfo) String() string { return proto.CompactTextString(this) }
-func (*SourceCodeInfo) ProtoMessage() {}
-
-type SourceCodeInfo_Location struct {
- Path []int32 `protobuf:"varint,1,rep,packed,name=path" json:"path,omitempty"`
- Span []int32 `protobuf:"varint,2,rep,packed,name=span" json:"span,omitempty"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (this *SourceCodeInfo_Location) Reset() { *this = SourceCodeInfo_Location{} }
-func (this *SourceCodeInfo_Location) String() string { return proto.CompactTextString(this) }
-func (*SourceCodeInfo_Location) ProtoMessage() {}
-
-func init() {
- proto.RegisterEnum("google_protobuf.FieldDescriptorProto_Type", FieldDescriptorProto_Type_name, FieldDescriptorProto_Type_value)
- proto.RegisterEnum("google_protobuf.FieldDescriptorProto_Label", FieldDescriptorProto_Label_name, FieldDescriptorProto_Label_value)
- proto.RegisterEnum("google_protobuf.FileOptions_OptimizeMode", FileOptions_OptimizeMode_name, FileOptions_OptimizeMode_value)
- proto.RegisterEnum("google_protobuf.FieldOptions_CType", FieldOptions_CType_name, FieldOptions_CType_value)
- proto.RegisterEnum("google_protobuf.StreamOptions_TokenUnit", StreamOptions_TokenUnit_name, StreamOptions_TokenUnit_value)
-}
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/doc.go b/vendor/github.com/golang/protobuf/protoc-gen-go/doc.go
deleted file mode 100644
index 0d6055d6..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/doc.go
+++ /dev/null
@@ -1,51 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2010 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-/*
- A plugin for the Google protocol buffer compiler to generate Go code.
- Run it by building this program and putting it in your path with the name
- protoc-gen-go
- That word 'go' at the end becomes part of the option string set for the
- protocol compiler, so once the protocol compiler (protoc) is installed
- you can run
- protoc --go_out=output_directory input_directory/file.proto
- to generate Go bindings for the protocol defined by file.proto.
- With that input, the output will be written to
- output_directory/file.pb.go
-
- The generated code is documented in the package comment for
- the library.
-
- See the README and documentation for protocol buffers to learn more:
- https://developers.google.com/protocol-buffers/
-
-*/
-package documentation
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/generator/Makefile b/vendor/github.com/golang/protobuf/protoc-gen-go/generator/Makefile
deleted file mode 100644
index b5715c35..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/generator/Makefile
+++ /dev/null
@@ -1,40 +0,0 @@
-# Go support for Protocol Buffers - Google's data interchange format
-#
-# Copyright 2010 The Go Authors. All rights reserved.
-# https://github.com/golang/protobuf
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are
-# met:
-#
-# * Redistributions of source code must retain the above copyright
-# notice, this list of conditions and the following disclaimer.
-# * Redistributions in binary form must reproduce the above
-# copyright notice, this list of conditions and the following disclaimer
-# in the documentation and/or other materials provided with the
-# distribution.
-# * Neither the name of Google Inc. nor the names of its
-# contributors may be used to endorse or promote products derived from
-# this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-include $(GOROOT)/src/Make.inc
-
-TARG=github.com/golang/protobuf/compiler/generator
-GOFILES=\
- generator.go\
-
-DEPS=../descriptor ../plugin ../../proto
-
-include $(GOROOT)/src/Make.pkg
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/generator/generator.go b/vendor/github.com/golang/protobuf/protoc-gen-go/generator/generator.go
deleted file mode 100644
index 11542166..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/generator/generator.go
+++ /dev/null
@@ -1,2089 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2010 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-/*
- The code generator for the plugin for the Google protocol buffer compiler.
- It generates Go code from the protocol buffer description files read by the
- main routine.
-*/
-package generator
-
-import (
- "bytes"
- "fmt"
- "go/parser"
- "go/printer"
- "go/token"
- "log"
- "os"
- "path"
- "strconv"
- "strings"
- "unicode"
- "unicode/utf8"
-
- "github.com/golang/protobuf/proto"
-
- "github.com/golang/protobuf/protoc-gen-go/descriptor"
- plugin "github.com/golang/protobuf/protoc-gen-go/plugin"
-)
-
-// A Plugin provides functionality to add to the output during Go code generation,
-// such as to produce RPC stubs.
-type Plugin interface {
- // Name identifies the plugin.
- Name() string
- // Init is called once after data structures are built but before
- // code generation begins.
- Init(g *Generator)
- // Generate produces the code generated by the plugin for this file,
- // except for the imports, by calling the generator's methods P, In, and Out.
- Generate(file *FileDescriptor)
- // GenerateImports produces the import declarations for this file.
- // It is called after Generate.
- GenerateImports(file *FileDescriptor)
-}
-
-var plugins []Plugin
-
-// RegisterPlugin installs a (second-order) plugin to be run when the Go output is generated.
-// It is typically called during initialization.
-func RegisterPlugin(p Plugin) {
- plugins = append(plugins, p)
-}
-
-// Each type we import as a protocol buffer (other than FileDescriptorProto) needs
-// a pointer to the FileDescriptorProto that represents it. These types achieve that
-// wrapping by placing each Proto inside a struct with the pointer to its File. The
-// structs have the same names as their contents, with "Proto" removed.
-// FileDescriptor is used to store the things that it points to.
-
-// The file and package name method are common to messages and enums.
-type common struct {
- file *descriptor.FileDescriptorProto // File this object comes from.
-}
-
-// PackageName is name in the package clause in the generated file.
-func (c *common) PackageName() string { return uniquePackageOf(c.file) }
-
-func (c *common) File() *descriptor.FileDescriptorProto { return c.file }
-
-func fileIsProto3(file *descriptor.FileDescriptorProto) bool {
- return file.GetSyntax() == "proto3"
-}
-
-func (c *common) proto3() bool { return fileIsProto3(c.file) }
-
-// Descriptor represents a protocol buffer message.
-type Descriptor struct {
- common
- *descriptor.DescriptorProto
- parent *Descriptor // The containing message, if any.
- nested []*Descriptor // Inner messages, if any.
- ext []*ExtensionDescriptor // Extensions, if any.
- typename []string // Cached typename vector.
- index int // The index into the container, whether the file or another message.
- path string // The SourceCodeInfo path as comma-separated integers.
- group bool
-}
-
-// TypeName returns the elements of the dotted type name.
-// The package name is not part of this name.
-func (d *Descriptor) TypeName() []string {
- if d.typename != nil {
- return d.typename
- }
- n := 0
- for parent := d; parent != nil; parent = parent.parent {
- n++
- }
- s := make([]string, n, n)
- for parent := d; parent != nil; parent = parent.parent {
- n--
- s[n] = parent.GetName()
- }
- d.typename = s
- return s
-}
-
-// EnumDescriptor describes an enum. If it's at top level, its parent will be nil.
-// Otherwise it will be the descriptor of the message in which it is defined.
-type EnumDescriptor struct {
- common
- *descriptor.EnumDescriptorProto
- parent *Descriptor // The containing message, if any.
- typename []string // Cached typename vector.
- index int // The index into the container, whether the file or a message.
- path string // The SourceCodeInfo path as comma-separated integers.
-}
-
-// TypeName returns the elements of the dotted type name.
-// The package name is not part of this name.
-func (e *EnumDescriptor) TypeName() (s []string) {
- if e.typename != nil {
- return e.typename
- }
- name := e.GetName()
- if e.parent == nil {
- s = make([]string, 1)
- } else {
- pname := e.parent.TypeName()
- s = make([]string, len(pname)+1)
- copy(s, pname)
- }
- s[len(s)-1] = name
- e.typename = s
- return s
-}
-
-// Everything but the last element of the full type name, CamelCased.
-// The values of type Foo.Bar are call Foo_value1... not Foo_Bar_value1... .
-func (e *EnumDescriptor) prefix() string {
- if e.parent == nil {
- // If the enum is not part of a message, the prefix is just the type name.
- return CamelCase(*e.Name) + "_"
- }
- typeName := e.TypeName()
- return CamelCaseSlice(typeName[0:len(typeName)-1]) + "_"
-}
-
-// The integer value of the named constant in this enumerated type.
-func (e *EnumDescriptor) integerValueAsString(name string) string {
- for _, c := range e.Value {
- if c.GetName() == name {
- return fmt.Sprint(c.GetNumber())
- }
- }
- log.Fatal("cannot find value for enum constant")
- return ""
-}
-
-// ExtensionDescriptor describes an extension. If it's at top level, its parent will be nil.
-// Otherwise it will be the descriptor of the message in which it is defined.
-type ExtensionDescriptor struct {
- common
- *descriptor.FieldDescriptorProto
- parent *Descriptor // The containing message, if any.
-}
-
-// TypeName returns the elements of the dotted type name.
-// The package name is not part of this name.
-func (e *ExtensionDescriptor) TypeName() (s []string) {
- name := e.GetName()
- if e.parent == nil {
- // top-level extension
- s = make([]string, 1)
- } else {
- pname := e.parent.TypeName()
- s = make([]string, len(pname)+1)
- copy(s, pname)
- }
- s[len(s)-1] = name
- return s
-}
-
-// DescName returns the variable name used for the generated descriptor.
-func (e *ExtensionDescriptor) DescName() string {
- // The full type name.
- typeName := e.TypeName()
- // Each scope of the extension is individually CamelCased, and all are joined with "_" with an "E_" prefix.
- for i, s := range typeName {
- typeName[i] = CamelCase(s)
- }
- return "E_" + strings.Join(typeName, "_")
-}
-
-// ImportedDescriptor describes a type that has been publicly imported from another file.
-type ImportedDescriptor struct {
- common
- o Object
-}
-
-func (id *ImportedDescriptor) TypeName() []string { return id.o.TypeName() }
-
-// FileDescriptor describes an protocol buffer descriptor file (.proto).
-// It includes slices of all the messages and enums defined within it.
-// Those slices are constructed by WrapTypes.
-type FileDescriptor struct {
- *descriptor.FileDescriptorProto
- desc []*Descriptor // All the messages defined in this file.
- enum []*EnumDescriptor // All the enums defined in this file.
- ext []*ExtensionDescriptor // All the top-level extensions defined in this file.
- imp []*ImportedDescriptor // All types defined in files publicly imported by this file.
-
- // Comments, stored as a map of path (comma-separated integers) to the comment.
- comments map[string]*descriptor.SourceCodeInfo_Location
-
- // The full list of symbols that are exported,
- // as a map from the exported object to its symbols.
- // This is used for supporting public imports.
- exported map[Object][]symbol
-
- index int // The index of this file in the list of files to generate code for
-
- proto3 bool // whether to generate proto3 code for this file
-}
-
-// PackageName is the package name we'll use in the generated code to refer to this file.
-func (d *FileDescriptor) PackageName() string { return uniquePackageOf(d.FileDescriptorProto) }
-
-// goPackageName returns the Go package name to use in the
-// generated Go file. The result explicit reports whether the name
-// came from an option go_package statement. If explicit is false,
-// the name was derived from the protocol buffer's package statement
-// or the input file name.
-func (d *FileDescriptor) goPackageName() (name string, explicit bool) {
- // Does the file have a "go_package" option?
- if opts := d.Options; opts != nil {
- if pkg := opts.GetGoPackage(); pkg != "" {
- return pkg, true
- }
- }
-
- // Does the file have a package clause?
- if pkg := d.GetPackage(); pkg != "" {
- return pkg, false
- }
- // Use the file base name.
- return baseName(d.GetName()), false
-}
-
-func (d *FileDescriptor) addExport(obj Object, sym symbol) {
- d.exported[obj] = append(d.exported[obj], sym)
-}
-
-// symbol is an interface representing an exported Go symbol.
-type symbol interface {
- // GenerateAlias should generate an appropriate alias
- // for the symbol from the named package.
- GenerateAlias(g *Generator, pkg string)
-}
-
-type messageSymbol struct {
- sym string
- hasExtensions, isMessageSet bool
- getters []getterSymbol
-}
-
-type getterSymbol struct {
- name string
- typ string
- typeName string // canonical name in proto world; empty for proto.Message and similar
- genType bool // whether typ is a generated type (message/group/enum)
-}
-
-func (ms *messageSymbol) GenerateAlias(g *Generator, pkg string) {
- remoteSym := pkg + "." + ms.sym
-
- g.P("type ", ms.sym, " ", remoteSym)
- g.P("func (m *", ms.sym, ") Reset() { (*", remoteSym, ")(m).Reset() }")
- g.P("func (m *", ms.sym, ") String() string { return (*", remoteSym, ")(m).String() }")
- g.P("func (*", ms.sym, ") ProtoMessage() {}")
- if ms.hasExtensions {
- g.P("func (*", ms.sym, ") ExtensionRangeArray() []", g.Pkg["proto"], ".ExtensionRange ",
- "{ return (*", remoteSym, ")(nil).ExtensionRangeArray() }")
- g.P("func (m *", ms.sym, ") ExtensionMap() map[int32]", g.Pkg["proto"], ".Extension ",
- "{ return (*", remoteSym, ")(m).ExtensionMap() }")
- if ms.isMessageSet {
- g.P("func (m *", ms.sym, ") Marshal() ([]byte, error) ",
- "{ return (*", remoteSym, ")(m).Marshal() }")
- g.P("func (m *", ms.sym, ") Unmarshal(buf []byte) error ",
- "{ return (*", remoteSym, ")(m).Unmarshal(buf) }")
- }
- }
- for _, get := range ms.getters {
-
- if get.typeName != "" {
- g.RecordTypeUse(get.typeName)
- }
- typ := get.typ
- val := "(*" + remoteSym + ")(m)." + get.name + "()"
- if get.genType {
- // typ will be "*pkg.T" (message/group) or "pkg.T" (enum).
- // Either of those might have a "[]" prefix if it is repeated.
- // Drop the package qualifier since we have hoisted the type into this package.
- rep := strings.HasPrefix(typ, "[]")
- if rep {
- typ = typ[2:]
- }
- star := typ[0] == '*'
- typ = typ[strings.Index(typ, ".")+1:]
- if star {
- typ = "*" + typ
- }
- if rep {
- // Go does not permit conversion between slice types where both
- // element types are named. That means we need to generate a bit
- // of code in this situation.
- // typ is the element type.
- // val is the expression to get the slice from the imported type.
-
- ctyp := typ // conversion type expression; "Foo" or "(*Foo)"
- if star {
- ctyp = "(" + typ + ")"
- }
-
- g.P("func (m *", ms.sym, ") ", get.name, "() []", typ, " {")
- g.In()
- g.P("o := ", val)
- g.P("if o == nil {")
- g.In()
- g.P("return nil")
- g.Out()
- g.P("}")
- g.P("s := make([]", typ, ", len(o))")
- g.P("for i, x := range o {")
- g.In()
- g.P("s[i] = ", ctyp, "(x)")
- g.Out()
- g.P("}")
- g.P("return s")
- g.Out()
- g.P("}")
- continue
- }
- // Convert imported type into the forwarding type.
- val = "(" + typ + ")(" + val + ")"
- }
-
- g.P("func (m *", ms.sym, ") ", get.name, "() ", typ, " { return ", val, " }")
- }
-
-}
-
-type enumSymbol struct {
- name string
- proto3 bool // Whether this came from a proto3 file.
-}
-
-func (es enumSymbol) GenerateAlias(g *Generator, pkg string) {
- s := es.name
- g.P("type ", s, " ", pkg, ".", s)
- g.P("var ", s, "_name = ", pkg, ".", s, "_name")
- g.P("var ", s, "_value = ", pkg, ".", s, "_value")
- g.P("func (x ", s, ") String() string { return (", pkg, ".", s, ")(x).String() }")
- if !es.proto3 {
- g.P("func (x ", s, ") Enum() *", s, "{ return (*", s, ")((", pkg, ".", s, ")(x).Enum()) }")
- g.P("func (x *", s, ") UnmarshalJSON(data []byte) error { return (*", pkg, ".", s, ")(x).UnmarshalJSON(data) }")
- }
-}
-
-type constOrVarSymbol struct {
- sym string
- typ string // either "const" or "var"
- cast string // if non-empty, a type cast is required (used for enums)
-}
-
-func (cs constOrVarSymbol) GenerateAlias(g *Generator, pkg string) {
- v := pkg + "." + cs.sym
- if cs.cast != "" {
- v = cs.cast + "(" + v + ")"
- }
- g.P(cs.typ, " ", cs.sym, " = ", v)
-}
-
-// Object is an interface abstracting the abilities shared by enums, messages, extensions and imported objects.
-type Object interface {
- PackageName() string // The name we use in our output (a_b_c), possibly renamed for uniqueness.
- TypeName() []string
- File() *descriptor.FileDescriptorProto
-}
-
-// Each package name we generate must be unique. The package we're generating
-// gets its own name but every other package must have a unique name that does
-// not conflict in the code we generate. These names are chosen globally (although
-// they don't have to be, it simplifies things to do them globally).
-func uniquePackageOf(fd *descriptor.FileDescriptorProto) string {
- s, ok := uniquePackageName[fd]
- if !ok {
- log.Fatal("internal error: no package name defined for " + fd.GetName())
- }
- return s
-}
-
-// Generator is the type whose methods generate the output, stored in the associated response structure.
-type Generator struct {
- *bytes.Buffer
-
- Request *plugin.CodeGeneratorRequest // The input.
- Response *plugin.CodeGeneratorResponse // The output.
-
- Param map[string]string // Command-line parameters.
- PackageImportPath string // Go import path of the package we're generating code for
- ImportPrefix string // String to prefix to imported package file names.
- ImportMap map[string]string // Mapping from import name to generated name
-
- Pkg map[string]string // The names under which we import support packages
-
- packageName string // What we're calling ourselves.
- allFiles []*FileDescriptor // All files in the tree
- genFiles []*FileDescriptor // Those files we will generate output for.
- file *FileDescriptor // The file we are compiling now.
- usedPackages map[string]bool // Names of packages used in current file.
- typeNameToObject map[string]Object // Key is a fully-qualified name in input syntax.
- init []string // Lines to emit in the init function.
- indent string
-}
-
-// New creates a new generator and allocates the request and response protobufs.
-func New() *Generator {
- g := new(Generator)
- g.Buffer = new(bytes.Buffer)
- g.Request = new(plugin.CodeGeneratorRequest)
- g.Response = new(plugin.CodeGeneratorResponse)
- return g
-}
-
-// Error reports a problem, including an error, and exits the program.
-func (g *Generator) Error(err error, msgs ...string) {
- s := strings.Join(msgs, " ") + ":" + err.Error()
- log.Print("protoc-gen-go: error:", s)
- os.Exit(1)
-}
-
-// Fail reports a problem and exits the program.
-func (g *Generator) Fail(msgs ...string) {
- s := strings.Join(msgs, " ")
- log.Print("protoc-gen-go: error:", s)
- os.Exit(1)
-}
-
-// CommandLineParameters breaks the comma-separated list of key=value pairs
-// in the parameter (a member of the request protobuf) into a key/value map.
-// It then sets file name mappings defined by those entries.
-func (g *Generator) CommandLineParameters(parameter string) {
- g.Param = make(map[string]string)
- for _, p := range strings.Split(parameter, ",") {
- if i := strings.Index(p, "="); i < 0 {
- g.Param[p] = ""
- } else {
- g.Param[p[0:i]] = p[i+1:]
- }
- }
-
- g.ImportMap = make(map[string]string)
- pluginList := "none" // Default list of plugin names to enable (empty means all).
- for k, v := range g.Param {
- switch k {
- case "import_prefix":
- g.ImportPrefix = v
- case "import_path":
- g.PackageImportPath = v
- case "plugins":
- pluginList = v
- default:
- if len(k) > 0 && k[0] == 'M' {
- g.ImportMap[k[1:]] = v
- }
- }
- }
-
- if pluginList != "" {
- // Amend the set of plugins.
- enabled := make(map[string]bool)
- for _, name := range strings.Split(pluginList, "+") {
- enabled[name] = true
- }
- var nplugins []Plugin
- for _, p := range plugins {
- if enabled[p.Name()] {
- nplugins = append(nplugins, p)
- }
- }
- plugins = nplugins
- }
-}
-
-// DefaultPackageName returns the package name printed for the object.
-// If its file is in a different package, it returns the package name we're using for this file, plus ".".
-// Otherwise it returns the empty string.
-func (g *Generator) DefaultPackageName(obj Object) string {
- pkg := obj.PackageName()
- if pkg == g.packageName {
- return ""
- }
- return pkg + "."
-}
-
-// For each input file, the unique package name to use, underscored.
-var uniquePackageName = make(map[*descriptor.FileDescriptorProto]string)
-
-// Package names already registered. Key is the name from the .proto file;
-// value is the name that appears in the generated code.
-var pkgNamesInUse = make(map[string]bool)
-
-// Create and remember a guaranteed unique package name for this file descriptor.
-// Pkg is the candidate name. If f is nil, it's a builtin package like "proto" and
-// has no file descriptor.
-func RegisterUniquePackageName(pkg string, f *FileDescriptor) string {
- // Convert dots to underscores before finding a unique alias.
- pkg = strings.Map(badToUnderscore, pkg)
-
- for i, orig := 1, pkg; pkgNamesInUse[pkg]; i++ {
- // It's a duplicate; must rename.
- pkg = orig + strconv.Itoa(i)
- }
- // Install it.
- pkgNamesInUse[pkg] = true
- if f != nil {
- uniquePackageName[f.FileDescriptorProto] = pkg
- }
- return pkg
-}
-
-var isGoKeyword = map[string]bool{
- "break": true,
- "case": true,
- "chan": true,
- "const": true,
- "continue": true,
- "default": true,
- "else": true,
- "defer": true,
- "fallthrough": true,
- "for": true,
- "func": true,
- "go": true,
- "goto": true,
- "if": true,
- "import": true,
- "interface": true,
- "map": true,
- "package": true,
- "range": true,
- "return": true,
- "select": true,
- "struct": true,
- "switch": true,
- "type": true,
- "var": true,
-}
-
-// defaultGoPackage returns the package name to use,
-// derived from the import path of the package we're building code for.
-func (g *Generator) defaultGoPackage() string {
- p := g.PackageImportPath
- if i := strings.LastIndex(p, "/"); i >= 0 {
- p = p[i+1:]
- }
- if p == "" {
- return ""
- }
-
- p = strings.Map(badToUnderscore, p)
- // Identifier must not be keyword: insert _.
- if isGoKeyword[p] {
- p = "_" + p
- }
- // Identifier must not begin with digit: insert _.
- if r, _ := utf8.DecodeRuneInString(p); unicode.IsDigit(r) {
- p = "_" + p
- }
- return p
-}
-
-// SetPackageNames sets the package name for this run.
-// The package name must agree across all files being generated.
-// It also defines unique package names for all imported files.
-func (g *Generator) SetPackageNames() {
- // Register the name for this package. It will be the first name
- // registered so is guaranteed to be unmodified.
- pkg, explicit := g.genFiles[0].goPackageName()
-
- // Check all files for an explicit go_package option.
- for _, f := range g.genFiles {
- thisPkg, thisExplicit := f.goPackageName()
- if thisExplicit {
- if !explicit {
- // Let this file's go_package option serve for all input files.
- pkg, explicit = thisPkg, true
- } else if thisPkg != pkg {
- g.Fail("inconsistent package names:", thisPkg, pkg)
- }
- }
- }
-
- // If we don't have an explicit go_package option but we have an
- // import path, use that.
- if !explicit {
- p := g.defaultGoPackage()
- if p != "" {
- pkg, explicit = p, true
- }
- }
-
- // If there was no go_package and no import path to use,
- // double-check that all the inputs have the same implicit
- // Go package name.
- if !explicit {
- for _, f := range g.genFiles {
- thisPkg, _ := f.goPackageName()
- if thisPkg != pkg {
- g.Fail("inconsistent package names:", thisPkg, pkg)
- }
- }
- }
-
- g.packageName = RegisterUniquePackageName(pkg, g.genFiles[0])
-
- // Register the support package names. They might collide with the
- // name of a package we import.
- g.Pkg = map[string]string{
- "math": RegisterUniquePackageName("math", nil),
- "proto": RegisterUniquePackageName("proto", nil),
- }
-
-AllFiles:
- for _, f := range g.allFiles {
- for _, genf := range g.genFiles {
- if f == genf {
- // In this package already.
- uniquePackageName[f.FileDescriptorProto] = g.packageName
- continue AllFiles
- }
- }
- // The file is a dependency, so we want to ignore its go_package option
- // because that is only relevant for its specific generated output.
- pkg := f.GetPackage()
- if pkg == "" {
- pkg = baseName(*f.Name)
- }
- RegisterUniquePackageName(pkg, f)
- }
-}
-
-// WrapTypes walks the incoming data, wrapping DescriptorProtos, EnumDescriptorProtos
-// and FileDescriptorProtos into file-referenced objects within the Generator.
-// It also creates the list of files to generate and so should be called before GenerateAllFiles.
-func (g *Generator) WrapTypes() {
- g.allFiles = make([]*FileDescriptor, len(g.Request.ProtoFile))
- for i, f := range g.Request.ProtoFile {
- // We must wrap the descriptors before we wrap the enums
- descs := wrapDescriptors(f)
- g.buildNestedDescriptors(descs)
- enums := wrapEnumDescriptors(f, descs)
- exts := wrapExtensions(f)
- imps := wrapImported(f, g)
- fd := &FileDescriptor{
- FileDescriptorProto: f,
- desc: descs,
- enum: enums,
- ext: exts,
- imp: imps,
- exported: make(map[Object][]symbol),
- proto3: fileIsProto3(f),
- }
- extractComments(fd)
- g.allFiles[i] = fd
- }
-
- g.genFiles = make([]*FileDescriptor, len(g.Request.FileToGenerate))
-FindFiles:
- for i, fileName := range g.Request.FileToGenerate {
- // Search the list. This algorithm is n^2 but n is tiny.
- for _, file := range g.allFiles {
- if fileName == file.GetName() {
- g.genFiles[i] = file
- file.index = i
- continue FindFiles
- }
- }
- g.Fail("could not find file named", fileName)
- }
- g.Response.File = make([]*plugin.CodeGeneratorResponse_File, len(g.genFiles))
-}
-
-// Scan the descriptors in this file. For each one, build the slice of nested descriptors
-func (g *Generator) buildNestedDescriptors(descs []*Descriptor) {
- for _, desc := range descs {
- if len(desc.NestedType) != 0 {
- desc.nested = make([]*Descriptor, len(desc.NestedType))
- n := 0
- for _, nest := range descs {
- if nest.parent == desc {
- desc.nested[n] = nest
- n++
- }
- }
- if n != len(desc.NestedType) {
- g.Fail("internal error: nesting failure for", desc.GetName())
- }
- }
- }
-}
-
-// Construct the Descriptor
-func newDescriptor(desc *descriptor.DescriptorProto, parent *Descriptor, file *descriptor.FileDescriptorProto, index int) *Descriptor {
- d := &Descriptor{
- common: common{file},
- DescriptorProto: desc,
- parent: parent,
- index: index,
- }
- if parent == nil {
- d.path = fmt.Sprintf("%d,%d", messagePath, index)
- } else {
- d.path = fmt.Sprintf("%s,%d,%d", parent.path, messageMessagePath, index)
- }
-
- // The only way to distinguish a group from a message is whether
- // the containing message has a TYPE_GROUP field that matches.
- if parent != nil {
- parts := d.TypeName()
- if file.Package != nil {
- parts = append([]string{*file.Package}, parts...)
- }
- exp := "." + strings.Join(parts, ".")
- for _, field := range parent.Field {
- if field.GetType() == descriptor.FieldDescriptorProto_TYPE_GROUP && field.GetTypeName() == exp {
- d.group = true
- break
- }
- }
- }
-
- d.ext = make([]*ExtensionDescriptor, len(desc.Extension))
- for i, field := range desc.Extension {
- d.ext[i] = &ExtensionDescriptor{common{file}, field, d}
- }
-
- return d
-}
-
-// Return a slice of all the Descriptors defined within this file
-func wrapDescriptors(file *descriptor.FileDescriptorProto) []*Descriptor {
- sl := make([]*Descriptor, 0, len(file.MessageType)+10)
- for i, desc := range file.MessageType {
- sl = wrapThisDescriptor(sl, desc, nil, file, i)
- }
- return sl
-}
-
-// Wrap this Descriptor, recursively
-func wrapThisDescriptor(sl []*Descriptor, desc *descriptor.DescriptorProto, parent *Descriptor, file *descriptor.FileDescriptorProto, index int) []*Descriptor {
- sl = append(sl, newDescriptor(desc, parent, file, index))
- me := sl[len(sl)-1]
- for i, nested := range desc.NestedType {
- sl = wrapThisDescriptor(sl, nested, me, file, i)
- }
- return sl
-}
-
-// Construct the EnumDescriptor
-func newEnumDescriptor(desc *descriptor.EnumDescriptorProto, parent *Descriptor, file *descriptor.FileDescriptorProto, index int) *EnumDescriptor {
- ed := &EnumDescriptor{
- common: common{file},
- EnumDescriptorProto: desc,
- parent: parent,
- index: index,
- }
- if parent == nil {
- ed.path = fmt.Sprintf("%d,%d", enumPath, index)
- } else {
- ed.path = fmt.Sprintf("%s,%d,%d", parent.path, messageEnumPath, index)
- }
- return ed
-}
-
-// Return a slice of all the EnumDescriptors defined within this file
-func wrapEnumDescriptors(file *descriptor.FileDescriptorProto, descs []*Descriptor) []*EnumDescriptor {
- sl := make([]*EnumDescriptor, 0, len(file.EnumType)+10)
- // Top-level enums.
- for i, enum := range file.EnumType {
- sl = append(sl, newEnumDescriptor(enum, nil, file, i))
- }
- // Enums within messages. Enums within embedded messages appear in the outer-most message.
- for _, nested := range descs {
- for i, enum := range nested.EnumType {
- sl = append(sl, newEnumDescriptor(enum, nested, file, i))
- }
- }
- return sl
-}
-
-// Return a slice of all the top-level ExtensionDescriptors defined within this file.
-func wrapExtensions(file *descriptor.FileDescriptorProto) []*ExtensionDescriptor {
- sl := make([]*ExtensionDescriptor, len(file.Extension))
- for i, field := range file.Extension {
- sl[i] = &ExtensionDescriptor{common{file}, field, nil}
- }
- return sl
-}
-
-// Return a slice of all the types that are publicly imported into this file.
-func wrapImported(file *descriptor.FileDescriptorProto, g *Generator) (sl []*ImportedDescriptor) {
- for _, index := range file.PublicDependency {
- df := g.fileByName(file.Dependency[index])
- for _, d := range df.desc {
- sl = append(sl, &ImportedDescriptor{common{file}, d})
- }
- for _, e := range df.enum {
- sl = append(sl, &ImportedDescriptor{common{file}, e})
- }
- for _, ext := range df.ext {
- sl = append(sl, &ImportedDescriptor{common{file}, ext})
- }
- }
- return
-}
-
-func extractComments(file *FileDescriptor) {
- file.comments = make(map[string]*descriptor.SourceCodeInfo_Location)
- for _, loc := range file.GetSourceCodeInfo().GetLocation() {
- if loc.LeadingComments == nil {
- continue
- }
- var p []string
- for _, n := range loc.Path {
- p = append(p, strconv.Itoa(int(n)))
- }
- file.comments[strings.Join(p, ",")] = loc
- }
-}
-
-// BuildTypeNameMap builds the map from fully qualified type names to objects.
-// The key names for the map come from the input data, which puts a period at the beginning.
-// It should be called after SetPackageNames and before GenerateAllFiles.
-func (g *Generator) BuildTypeNameMap() {
- g.typeNameToObject = make(map[string]Object)
- for _, f := range g.allFiles {
- // The names in this loop are defined by the proto world, not us, so the
- // package name may be empty. If so, the dotted package name of X will
- // be ".X"; otherwise it will be ".pkg.X".
- dottedPkg := "." + f.GetPackage()
- if dottedPkg != "." {
- dottedPkg += "."
- }
- for _, enum := range f.enum {
- name := dottedPkg + dottedSlice(enum.TypeName())
- g.typeNameToObject[name] = enum
- }
- for _, desc := range f.desc {
- name := dottedPkg + dottedSlice(desc.TypeName())
- g.typeNameToObject[name] = desc
- }
- }
-}
-
-// ObjectNamed, given a fully-qualified input type name as it appears in the input data,
-// returns the descriptor for the message or enum with that name.
-func (g *Generator) ObjectNamed(typeName string) Object {
- o, ok := g.typeNameToObject[typeName]
- if !ok {
- g.Fail("can't find object with type", typeName)
- }
-
- // If the file of this object isn't a direct dependency of the current file,
- // or in the current file, then this object has been publicly imported into
- // a dependency of the current file.
- // We should return the ImportedDescriptor object for it instead.
- direct := *o.File().Name == *g.file.Name
- if !direct {
- for _, dep := range g.file.Dependency {
- if *g.fileByName(dep).Name == *o.File().Name {
- direct = true
- break
- }
- }
- }
- if !direct {
- found := false
- Loop:
- for _, dep := range g.file.Dependency {
- df := g.fileByName(*g.fileByName(dep).Name)
- for _, td := range df.imp {
- if td.o == o {
- // Found it!
- o = td
- found = true
- break Loop
- }
- }
- }
- if !found {
- log.Printf("protoc-gen-go: WARNING: failed finding publicly imported dependency for %v, used in %v", typeName, *g.file.Name)
- }
- }
-
- return o
-}
-
-// P prints the arguments to the generated output. It handles strings and int32s, plus
-// handling indirections because they may be *string, etc.
-func (g *Generator) P(str ...interface{}) {
- g.WriteString(g.indent)
- for _, v := range str {
- switch s := v.(type) {
- case string:
- g.WriteString(s)
- case *string:
- g.WriteString(*s)
- case bool:
- g.WriteString(fmt.Sprintf("%t", s))
- case *bool:
- g.WriteString(fmt.Sprintf("%t", *s))
- case int:
- g.WriteString(fmt.Sprintf("%d", s))
- case *int32:
- g.WriteString(fmt.Sprintf("%d", *s))
- case *int64:
- g.WriteString(fmt.Sprintf("%d", *s))
- case float64:
- g.WriteString(fmt.Sprintf("%g", s))
- case *float64:
- g.WriteString(fmt.Sprintf("%g", *s))
- default:
- g.Fail(fmt.Sprintf("unknown type in printer: %T", v))
- }
- }
- g.WriteByte('\n')
-}
-
-// addInitf stores the given statement to be printed inside the file's init function.
-// The statement is given as a format specifier and arguments.
-func (g *Generator) addInitf(stmt string, a ...interface{}) {
- g.init = append(g.init, fmt.Sprintf(stmt, a...))
-}
-
-// In Indents the output one tab stop.
-func (g *Generator) In() { g.indent += "\t" }
-
-// Out unindents the output one tab stop.
-func (g *Generator) Out() {
- if len(g.indent) > 0 {
- g.indent = g.indent[1:]
- }
-}
-
-// GenerateAllFiles generates the output for all the files we're outputting.
-func (g *Generator) GenerateAllFiles() {
- // Initialize the plugins
- for _, p := range plugins {
- p.Init(g)
- }
- // Generate the output. The generator runs for every file, even the files
- // that we don't generate output for, so that we can collate the full list
- // of exported symbols to support public imports.
- genFileMap := make(map[*FileDescriptor]bool, len(g.genFiles))
- for _, file := range g.genFiles {
- genFileMap[file] = true
- }
- i := 0
- for _, file := range g.allFiles {
- g.Reset()
- g.generate(file)
- if _, ok := genFileMap[file]; !ok {
- continue
- }
- g.Response.File[i] = new(plugin.CodeGeneratorResponse_File)
- g.Response.File[i].Name = proto.String(goFileName(*file.Name))
- g.Response.File[i].Content = proto.String(g.String())
- i++
- }
-}
-
-// Run all the plugins associated with the file.
-func (g *Generator) runPlugins(file *FileDescriptor) {
- for _, p := range plugins {
- p.Generate(file)
- }
-}
-
-// FileOf return the FileDescriptor for this FileDescriptorProto.
-func (g *Generator) FileOf(fd *descriptor.FileDescriptorProto) *FileDescriptor {
- for _, file := range g.allFiles {
- if file.FileDescriptorProto == fd {
- return file
- }
- }
- g.Fail("could not find file in table:", fd.GetName())
- return nil
-}
-
-// Fill the response protocol buffer with the generated output for all the files we're
-// supposed to generate.
-func (g *Generator) generate(file *FileDescriptor) {
- g.file = g.FileOf(file.FileDescriptorProto)
- g.usedPackages = make(map[string]bool)
-
- for _, td := range g.file.imp {
- g.generateImported(td)
- }
- for _, enum := range g.file.enum {
- g.generateEnum(enum)
- }
- for _, desc := range g.file.desc {
- // Don't generate virtual messages for maps.
- if desc.GetOptions().GetMapEntry() {
- continue
- }
- g.generateMessage(desc)
- }
- for _, ext := range g.file.ext {
- g.generateExtension(ext)
- }
- g.generateInitFunction()
-
- // Run the plugins before the imports so we know which imports are necessary.
- g.runPlugins(file)
-
- // Generate header and imports last, though they appear first in the output.
- rem := g.Buffer
- g.Buffer = new(bytes.Buffer)
- g.generateHeader()
- g.generateImports()
- g.Write(rem.Bytes())
-
- // Reformat generated code.
- fset := token.NewFileSet()
- ast, err := parser.ParseFile(fset, "", g, parser.ParseComments)
- if err != nil {
- g.Fail("bad Go source code was generated:", err.Error())
- return
- }
- g.Reset()
- err = (&printer.Config{Mode: printer.TabIndent | printer.UseSpaces, Tabwidth: 8}).Fprint(g, fset, ast)
- if err != nil {
- g.Fail("generated Go source code could not be reformatted:", err.Error())
- }
-}
-
-// Generate the header, including package definition
-func (g *Generator) generateHeader() {
- g.P("// Code generated by protoc-gen-go.")
- g.P("// source: ", g.file.Name)
- g.P("// DO NOT EDIT!")
- g.P()
-
- name := g.file.PackageName()
-
- if g.file.index == 0 {
- // Generate package docs for the first file in the package.
- g.P("/*")
- g.P("Package ", name, " is a generated protocol buffer package.")
- g.P()
- if loc, ok := g.file.comments[strconv.Itoa(packagePath)]; ok {
- // not using g.PrintComments because this is a /* */ comment block.
- text := strings.TrimSuffix(loc.GetLeadingComments(), "\n")
- for _, line := range strings.Split(text, "\n") {
- line = strings.TrimPrefix(line, " ")
- // ensure we don't escape from the block comment
- line = strings.Replace(line, "*/", "* /", -1)
- g.P(line)
- }
- g.P()
- }
- g.P("It is generated from these files:")
- for _, f := range g.genFiles {
- g.P("\t", f.Name)
- }
- g.P()
- g.P("It has these top-level messages:")
- for _, msg := range g.file.desc {
- if msg.parent != nil {
- continue
- }
- g.P("\t", CamelCaseSlice(msg.TypeName()))
- }
- g.P("*/")
- }
-
- g.P("package ", name)
- g.P()
-}
-
-// PrintComments prints any comments from the source .proto file.
-// The path is a comma-separated list of integers.
-// See descriptor.proto for its format.
-func (g *Generator) PrintComments(path string) {
- if loc, ok := g.file.comments[path]; ok {
- text := strings.TrimSuffix(loc.GetLeadingComments(), "\n")
- for _, line := range strings.Split(text, "\n") {
- g.P("// ", strings.TrimPrefix(line, " "))
- }
- }
-}
-
-func (g *Generator) fileByName(filename string) *FileDescriptor {
- for _, fd := range g.allFiles {
- if fd.GetName() == filename {
- return fd
- }
- }
- return nil
-}
-
-// weak returns whether the ith import of the current file is a weak import.
-func (g *Generator) weak(i int32) bool {
- for _, j := range g.file.WeakDependency {
- if j == i {
- return true
- }
- }
- return false
-}
-
-// Generate the imports
-func (g *Generator) generateImports() {
- // We almost always need a proto import. Rather than computing when we
- // do, which is tricky when there's a plugin, just import it and
- // reference it later. The same argument applies to the math package,
- // for handling bit patterns for floating-point numbers.
- g.P("import " + g.Pkg["proto"] + " " + strconv.Quote(g.ImportPrefix+"github.com/golang/protobuf/proto"))
- if !g.file.proto3 {
- g.P("import " + g.Pkg["math"] + ` "math"`)
- }
- for i, s := range g.file.Dependency {
- fd := g.fileByName(s)
- // Do not import our own package.
- if fd.PackageName() == g.packageName {
- continue
- }
- filename := goFileName(s)
- // By default, import path is the dirname of the Go filename.
- importPath := path.Dir(filename)
- if substitution, ok := g.ImportMap[s]; ok {
- importPath = substitution
- }
- importPath = g.ImportPrefix + importPath
- // Skip weak imports.
- if g.weak(int32(i)) {
- g.P("// skipping weak import ", fd.PackageName(), " ", strconv.Quote(importPath))
- continue
- }
- if _, ok := g.usedPackages[fd.PackageName()]; ok {
- g.P("import ", fd.PackageName(), " ", strconv.Quote(importPath))
- } else {
- // TODO: Re-enable this when we are more feature-complete.
- // For instance, some protos use foreign field extensions, which we don't support.
- // Until then, this is just annoying spam.
- //log.Printf("protoc-gen-go: discarding unused import from %v: %v", *g.file.Name, s)
- g.P("// discarding unused import ", fd.PackageName(), " ", strconv.Quote(importPath))
- }
- }
- g.P()
- // TODO: may need to worry about uniqueness across plugins
- for _, p := range plugins {
- p.GenerateImports(g.file)
- g.P()
- }
- g.P("// Reference imports to suppress errors if they are not otherwise used.")
- g.P("var _ = ", g.Pkg["proto"], ".Marshal")
- if !g.file.proto3 {
- g.P("var _ = ", g.Pkg["math"], ".Inf")
- }
- g.P()
-}
-
-func (g *Generator) generateImported(id *ImportedDescriptor) {
- // Don't generate public import symbols for files that we are generating
- // code for, since those symbols will already be in this package.
- // We can't simply avoid creating the ImportedDescriptor objects,
- // because g.genFiles isn't populated at that stage.
- tn := id.TypeName()
- sn := tn[len(tn)-1]
- df := g.FileOf(id.o.File())
- filename := *df.Name
- for _, fd := range g.genFiles {
- if *fd.Name == filename {
- g.P("// Ignoring public import of ", sn, " from ", filename)
- g.P()
- return
- }
- }
- g.P("// ", sn, " from public import ", filename)
- g.usedPackages[df.PackageName()] = true
-
- for _, sym := range df.exported[id.o] {
- sym.GenerateAlias(g, df.PackageName())
- }
-
- g.P()
-}
-
-// Generate the enum definitions for this EnumDescriptor.
-func (g *Generator) generateEnum(enum *EnumDescriptor) {
- // The full type name
- typeName := enum.TypeName()
- // The full type name, CamelCased.
- ccTypeName := CamelCaseSlice(typeName)
- ccPrefix := enum.prefix()
-
- g.PrintComments(enum.path)
- g.P("type ", ccTypeName, " int32")
- g.file.addExport(enum, enumSymbol{ccTypeName, enum.proto3()})
- g.P("const (")
- g.In()
- for i, e := range enum.Value {
- g.PrintComments(fmt.Sprintf("%s,%d,%d", enum.path, enumValuePath, i))
-
- name := ccPrefix + *e.Name
- g.P(name, " ", ccTypeName, " = ", e.Number)
- g.file.addExport(enum, constOrVarSymbol{name, "const", ccTypeName})
- }
- g.Out()
- g.P(")")
- g.P("var ", ccTypeName, "_name = map[int32]string{")
- g.In()
- generated := make(map[int32]bool) // avoid duplicate values
- for _, e := range enum.Value {
- duplicate := ""
- if _, present := generated[*e.Number]; present {
- duplicate = "// Duplicate value: "
- }
- g.P(duplicate, e.Number, ": ", strconv.Quote(*e.Name), ",")
- generated[*e.Number] = true
- }
- g.Out()
- g.P("}")
- g.P("var ", ccTypeName, "_value = map[string]int32{")
- g.In()
- for _, e := range enum.Value {
- g.P(strconv.Quote(*e.Name), ": ", e.Number, ",")
- }
- g.Out()
- g.P("}")
-
- if !enum.proto3() {
- g.P("func (x ", ccTypeName, ") Enum() *", ccTypeName, " {")
- g.In()
- g.P("p := new(", ccTypeName, ")")
- g.P("*p = x")
- g.P("return p")
- g.Out()
- g.P("}")
- }
-
- g.P("func (x ", ccTypeName, ") String() string {")
- g.In()
- g.P("return ", g.Pkg["proto"], ".EnumName(", ccTypeName, "_name, int32(x))")
- g.Out()
- g.P("}")
-
- if !enum.proto3() {
- g.P("func (x *", ccTypeName, ") UnmarshalJSON(data []byte) error {")
- g.In()
- g.P("value, err := ", g.Pkg["proto"], ".UnmarshalJSONEnum(", ccTypeName, `_value, data, "`, ccTypeName, `")`)
- g.P("if err != nil {")
- g.In()
- g.P("return err")
- g.Out()
- g.P("}")
- g.P("*x = ", ccTypeName, "(value)")
- g.P("return nil")
- g.Out()
- g.P("}")
- }
-
- g.P()
-}
-
-// The tag is a string like "varint,2,opt,name=fieldname,def=7" that
-// identifies details of the field for the protocol buffer marshaling and unmarshaling
-// code. The fields are:
-// wire encoding
-// protocol tag number
-// opt,req,rep for optional, required, or repeated
-// packed whether the encoding is "packed" (optional; repeated primitives only)
-// name= the original declared name
-// enum= the name of the enum type if it is an enum-typed field.
-// proto3 if this field is in a proto3 message
-// def= string representation of the default value, if any.
-// The default value must be in a representation that can be used at run-time
-// to generate the default value. Thus bools become 0 and 1, for instance.
-func (g *Generator) goTag(message *Descriptor, field *descriptor.FieldDescriptorProto, wiretype string) string {
- optrepreq := ""
- switch {
- case isOptional(field):
- optrepreq = "opt"
- case isRequired(field):
- optrepreq = "req"
- case isRepeated(field):
- optrepreq = "rep"
- }
- var defaultValue string
- if dv := field.DefaultValue; dv != nil { // set means an explicit default
- defaultValue = *dv
- // Some types need tweaking.
- switch *field.Type {
- case descriptor.FieldDescriptorProto_TYPE_BOOL:
- if defaultValue == "true" {
- defaultValue = "1"
- } else {
- defaultValue = "0"
- }
- case descriptor.FieldDescriptorProto_TYPE_STRING,
- descriptor.FieldDescriptorProto_TYPE_BYTES:
- // Nothing to do. Quoting is done for the whole tag.
- case descriptor.FieldDescriptorProto_TYPE_ENUM:
- // For enums we need to provide the integer constant.
- obj := g.ObjectNamed(field.GetTypeName())
- if id, ok := obj.(*ImportedDescriptor); ok {
- // It is an enum that was publicly imported.
- // We need the underlying type.
- obj = id.o
- }
- enum, ok := obj.(*EnumDescriptor)
- if !ok {
- log.Printf("obj is a %T", obj)
- if id, ok := obj.(*ImportedDescriptor); ok {
- log.Printf("id.o is a %T", id.o)
- }
- g.Fail("unknown enum type", CamelCaseSlice(obj.TypeName()))
- }
- defaultValue = enum.integerValueAsString(defaultValue)
- }
- defaultValue = ",def=" + defaultValue
- }
- enum := ""
- if *field.Type == descriptor.FieldDescriptorProto_TYPE_ENUM {
- // We avoid using obj.PackageName(), because we want to use the
- // original (proto-world) package name.
- obj := g.ObjectNamed(field.GetTypeName())
- if id, ok := obj.(*ImportedDescriptor); ok {
- obj = id.o
- }
- enum = ",enum="
- if pkg := obj.File().GetPackage(); pkg != "" {
- enum += pkg + "."
- }
- enum += CamelCaseSlice(obj.TypeName())
- }
- packed := ""
- if field.Options != nil && field.Options.GetPacked() {
- packed = ",packed"
- }
- fieldName := field.GetName()
- name := fieldName
- if *field.Type == descriptor.FieldDescriptorProto_TYPE_GROUP {
- // We must use the type name for groups instead of
- // the field name to preserve capitalization.
- // type_name in FieldDescriptorProto is fully-qualified,
- // but we only want the local part.
- name = *field.TypeName
- if i := strings.LastIndex(name, "."); i >= 0 {
- name = name[i+1:]
- }
- }
- if name == CamelCase(fieldName) {
- name = ""
- } else {
- name = ",name=" + name
- }
- if message.proto3() {
- // We only need the extra tag for []byte fields;
- // no need to add noise for the others.
- if *field.Type == descriptor.FieldDescriptorProto_TYPE_BYTES {
- name += ",proto3"
- }
- }
- return strconv.Quote(fmt.Sprintf("%s,%d,%s%s%s%s%s",
- wiretype,
- field.GetNumber(),
- optrepreq,
- packed,
- name,
- enum,
- defaultValue))
-}
-
-func needsStar(typ descriptor.FieldDescriptorProto_Type) bool {
- switch typ {
- case descriptor.FieldDescriptorProto_TYPE_GROUP:
- return false
- case descriptor.FieldDescriptorProto_TYPE_MESSAGE:
- return false
- case descriptor.FieldDescriptorProto_TYPE_BYTES:
- return false
- }
- return true
-}
-
-// TypeName is the printed name appropriate for an item. If the object is in the current file,
-// TypeName drops the package name and underscores the rest.
-// Otherwise the object is from another package; and the result is the underscored
-// package name followed by the item name.
-// The result always has an initial capital.
-func (g *Generator) TypeName(obj Object) string {
- return g.DefaultPackageName(obj) + CamelCaseSlice(obj.TypeName())
-}
-
-// TypeNameWithPackage is like TypeName, but always includes the package
-// name even if the object is in our own package.
-func (g *Generator) TypeNameWithPackage(obj Object) string {
- return obj.PackageName() + CamelCaseSlice(obj.TypeName())
-}
-
-// GoType returns a string representing the type name, and the wire type
-func (g *Generator) GoType(message *Descriptor, field *descriptor.FieldDescriptorProto) (typ string, wire string) {
- // TODO: Options.
- switch *field.Type {
- case descriptor.FieldDescriptorProto_TYPE_DOUBLE:
- typ, wire = "float64", "fixed64"
- case descriptor.FieldDescriptorProto_TYPE_FLOAT:
- typ, wire = "float32", "fixed32"
- case descriptor.FieldDescriptorProto_TYPE_INT64:
- typ, wire = "int64", "varint"
- case descriptor.FieldDescriptorProto_TYPE_UINT64:
- typ, wire = "uint64", "varint"
- case descriptor.FieldDescriptorProto_TYPE_INT32:
- typ, wire = "int32", "varint"
- case descriptor.FieldDescriptorProto_TYPE_UINT32:
- typ, wire = "uint32", "varint"
- case descriptor.FieldDescriptorProto_TYPE_FIXED64:
- typ, wire = "uint64", "fixed64"
- case descriptor.FieldDescriptorProto_TYPE_FIXED32:
- typ, wire = "uint32", "fixed32"
- case descriptor.FieldDescriptorProto_TYPE_BOOL:
- typ, wire = "bool", "varint"
- case descriptor.FieldDescriptorProto_TYPE_STRING:
- typ, wire = "string", "bytes"
- case descriptor.FieldDescriptorProto_TYPE_GROUP:
- desc := g.ObjectNamed(field.GetTypeName())
- typ, wire = "*"+g.TypeName(desc), "group"
- case descriptor.FieldDescriptorProto_TYPE_MESSAGE:
- desc := g.ObjectNamed(field.GetTypeName())
- typ, wire = "*"+g.TypeName(desc), "bytes"
- case descriptor.FieldDescriptorProto_TYPE_BYTES:
- typ, wire = "[]byte", "bytes"
- case descriptor.FieldDescriptorProto_TYPE_ENUM:
- desc := g.ObjectNamed(field.GetTypeName())
- typ, wire = g.TypeName(desc), "varint"
- case descriptor.FieldDescriptorProto_TYPE_SFIXED32:
- typ, wire = "int32", "fixed32"
- case descriptor.FieldDescriptorProto_TYPE_SFIXED64:
- typ, wire = "int64", "fixed64"
- case descriptor.FieldDescriptorProto_TYPE_SINT32:
- typ, wire = "int32", "zigzag32"
- case descriptor.FieldDescriptorProto_TYPE_SINT64:
- typ, wire = "int64", "zigzag64"
- default:
- g.Fail("unknown type for", field.GetName())
- }
- if isRepeated(field) {
- typ = "[]" + typ
- } else if message != nil && message.proto3() {
- return
- } else if needsStar(*field.Type) {
- typ = "*" + typ
- }
- return
-}
-
-func (g *Generator) RecordTypeUse(t string) {
- if obj, ok := g.typeNameToObject[t]; ok {
- // Call ObjectNamed to get the true object to record the use.
- obj = g.ObjectNamed(t)
- g.usedPackages[obj.PackageName()] = true
- }
-}
-
-// Method names that may be generated. Fields with these names get an
-// underscore appended.
-var methodNames = [...]string{
- "Reset",
- "String",
- "ProtoMessage",
- "Marshal",
- "Unmarshal",
- "ExtensionRangeArray",
- "ExtensionMap",
- "Descriptor",
-}
-
-// Generate the type and default constant definitions for this Descriptor.
-func (g *Generator) generateMessage(message *Descriptor) {
- // The full type name
- typeName := message.TypeName()
- // The full type name, CamelCased.
- ccTypeName := CamelCaseSlice(typeName)
-
- usedNames := make(map[string]bool)
- for _, n := range methodNames {
- usedNames[n] = true
- }
- fieldNames := make(map[*descriptor.FieldDescriptorProto]string)
- fieldGetterNames := make(map[*descriptor.FieldDescriptorProto]string)
- mapFieldTypes := make(map[*descriptor.FieldDescriptorProto]string)
-
- g.PrintComments(message.path)
- g.P("type ", ccTypeName, " struct {")
- g.In()
-
- for i, field := range message.Field {
- g.PrintComments(fmt.Sprintf("%s,%d,%d", message.path, messageFieldPath, i))
-
- fieldName := CamelCase(*field.Name)
- for usedNames[fieldName] {
- fieldName += "_"
- }
- fieldGetterName := fieldName
- usedNames[fieldName] = true
- typename, wiretype := g.GoType(message, field)
- jsonName := *field.Name
- tag := fmt.Sprintf("protobuf:%s json:%q", g.goTag(message, field, wiretype), jsonName+",omitempty")
-
- if *field.Type == descriptor.FieldDescriptorProto_TYPE_MESSAGE {
- desc := g.ObjectNamed(field.GetTypeName())
- if d, ok := desc.(*Descriptor); ok && d.GetOptions().GetMapEntry() {
- // Figure out the Go types and tags for the key and value types.
- keyField, valField := d.Field[0], d.Field[1]
- keyType, keyWire := g.GoType(d, keyField)
- valType, valWire := g.GoType(d, valField)
- keyTag, valTag := g.goTag(d, keyField, keyWire), g.goTag(d, valField, valWire)
-
- // We don't use stars, except for message-typed values.
- // Message and enum types are the only two possibly foreign types used in maps,
- // so record their use. They are not permitted as map keys.
- keyType = strings.TrimPrefix(keyType, "*")
- switch *valField.Type {
- case descriptor.FieldDescriptorProto_TYPE_ENUM:
- valType = strings.TrimPrefix(valType, "*")
- g.RecordTypeUse(valField.GetTypeName())
- case descriptor.FieldDescriptorProto_TYPE_MESSAGE:
- g.RecordTypeUse(valField.GetTypeName())
- default:
- valType = strings.TrimPrefix(valType, "*")
- }
-
- typename = fmt.Sprintf("map[%s]%s", keyType, valType)
- mapFieldTypes[field] = typename // record for the getter generation
-
- tag += fmt.Sprintf(" protobuf_key:%s protobuf_val:%s", keyTag, valTag)
- }
- }
-
- fieldNames[field] = fieldName
- fieldGetterNames[field] = fieldGetterName
- g.P(fieldName, "\t", typename, "\t`", tag, "`")
- g.RecordTypeUse(field.GetTypeName())
- }
- if len(message.ExtensionRange) > 0 {
- g.P("XXX_extensions\t\tmap[int32]", g.Pkg["proto"], ".Extension `json:\"-\"`")
- }
- if !message.proto3() {
- g.P("XXX_unrecognized\t[]byte `json:\"-\"`")
- }
- g.Out()
- g.P("}")
-
- // Reset, String and ProtoMessage methods.
- g.P("func (m *", ccTypeName, ") Reset() { *m = ", ccTypeName, "{} }")
- g.P("func (m *", ccTypeName, ") String() string { return ", g.Pkg["proto"], ".CompactTextString(m) }")
- g.P("func (*", ccTypeName, ") ProtoMessage() {}")
-
- // Extension support methods
- var hasExtensions, isMessageSet bool
- if len(message.ExtensionRange) > 0 {
- hasExtensions = true
- // message_set_wire_format only makes sense when extensions are defined.
- if opts := message.Options; opts != nil && opts.GetMessageSetWireFormat() {
- isMessageSet = true
- g.P()
- g.P("func (m *", ccTypeName, ") Marshal() ([]byte, error) {")
- g.In()
- g.P("return ", g.Pkg["proto"], ".MarshalMessageSet(m.ExtensionMap())")
- g.Out()
- g.P("}")
- g.P("func (m *", ccTypeName, ") Unmarshal(buf []byte) error {")
- g.In()
- g.P("return ", g.Pkg["proto"], ".UnmarshalMessageSet(buf, m.ExtensionMap())")
- g.Out()
- g.P("}")
- g.P("func (m *", ccTypeName, ") MarshalJSON() ([]byte, error) {")
- g.In()
- g.P("return ", g.Pkg["proto"], ".MarshalMessageSetJSON(m.XXX_extensions)")
- g.Out()
- g.P("}")
- g.P("func (m *", ccTypeName, ") UnmarshalJSON(buf []byte) error {")
- g.In()
- g.P("return ", g.Pkg["proto"], ".UnmarshalMessageSetJSON(buf, m.XXX_extensions)")
- g.Out()
- g.P("}")
- g.P("// ensure ", ccTypeName, " satisfies proto.Marshaler and proto.Unmarshaler")
- g.P("var _ ", g.Pkg["proto"], ".Marshaler = (*", ccTypeName, ")(nil)")
- g.P("var _ ", g.Pkg["proto"], ".Unmarshaler = (*", ccTypeName, ")(nil)")
- }
-
- g.P()
- g.P("var extRange_", ccTypeName, " = []", g.Pkg["proto"], ".ExtensionRange{")
- g.In()
- for _, r := range message.ExtensionRange {
- end := fmt.Sprint(*r.End - 1) // make range inclusive on both ends
- g.P("{", r.Start, ", ", end, "},")
- }
- g.Out()
- g.P("}")
- g.P("func (*", ccTypeName, ") ExtensionRangeArray() []", g.Pkg["proto"], ".ExtensionRange {")
- g.In()
- g.P("return extRange_", ccTypeName)
- g.Out()
- g.P("}")
- g.P("func (m *", ccTypeName, ") ExtensionMap() map[int32]", g.Pkg["proto"], ".Extension {")
- g.In()
- g.P("if m.XXX_extensions == nil {")
- g.In()
- g.P("m.XXX_extensions = make(map[int32]", g.Pkg["proto"], ".Extension)")
- g.Out()
- g.P("}")
- g.P("return m.XXX_extensions")
- g.Out()
- g.P("}")
- }
-
- // Default constants
- defNames := make(map[*descriptor.FieldDescriptorProto]string)
- for _, field := range message.Field {
- def := field.GetDefaultValue()
- if def == "" {
- continue
- }
- fieldname := "Default_" + ccTypeName + "_" + CamelCase(*field.Name)
- defNames[field] = fieldname
- typename, _ := g.GoType(message, field)
- if typename[0] == '*' {
- typename = typename[1:]
- }
- kind := "const "
- switch {
- case typename == "bool":
- case typename == "string":
- def = strconv.Quote(def)
- case typename == "[]byte":
- def = "[]byte(" + strconv.Quote(def) + ")"
- kind = "var "
- case def == "inf", def == "-inf", def == "nan":
- // These names are known to, and defined by, the protocol language.
- switch def {
- case "inf":
- def = "math.Inf(1)"
- case "-inf":
- def = "math.Inf(-1)"
- case "nan":
- def = "math.NaN()"
- }
- if *field.Type == descriptor.FieldDescriptorProto_TYPE_FLOAT {
- def = "float32(" + def + ")"
- }
- kind = "var "
- case *field.Type == descriptor.FieldDescriptorProto_TYPE_ENUM:
- // Must be an enum. Need to construct the prefixed name.
- obj := g.ObjectNamed(field.GetTypeName())
- var enum *EnumDescriptor
- if id, ok := obj.(*ImportedDescriptor); ok {
- // The enum type has been publicly imported.
- enum, _ = id.o.(*EnumDescriptor)
- } else {
- enum, _ = obj.(*EnumDescriptor)
- }
- if enum == nil {
- log.Printf("don't know how to generate constant for %s", fieldname)
- continue
- }
- def = g.DefaultPackageName(obj) + enum.prefix() + def
- }
- g.P(kind, fieldname, " ", typename, " = ", def)
- g.file.addExport(message, constOrVarSymbol{fieldname, kind, ""})
- }
- g.P()
-
- // Field getters
- var getters []getterSymbol
- for _, field := range message.Field {
- fname := fieldNames[field]
- typename, _ := g.GoType(message, field)
- if t, ok := mapFieldTypes[field]; ok {
- typename = t
- }
- mname := "Get" + fieldGetterNames[field]
- star := ""
- if needsStar(*field.Type) && typename[0] == '*' {
- typename = typename[1:]
- star = "*"
- }
-
- // In proto3, only generate getters for message fields.
- if message.proto3() && *field.Type != descriptor.FieldDescriptorProto_TYPE_MESSAGE {
- continue
- }
-
- // Only export getter symbols for basic types,
- // and for messages and enums in the same package.
- // Groups are not exported.
- // Foreign types can't be hoisted through a public import because
- // the importer may not already be importing the defining .proto.
- // As an example, imagine we have an import tree like this:
- // A.proto -> B.proto -> C.proto
- // If A publicly imports B, we need to generate the getters from B in A's output,
- // but if one such getter returns something from C then we cannot do that
- // because A is not importing C already.
- var getter, genType bool
- switch *field.Type {
- case descriptor.FieldDescriptorProto_TYPE_GROUP:
- getter = false
- case descriptor.FieldDescriptorProto_TYPE_MESSAGE, descriptor.FieldDescriptorProto_TYPE_ENUM:
- // Only export getter if its return type is in this package.
- getter = g.ObjectNamed(field.GetTypeName()).PackageName() == message.PackageName()
- genType = true
- default:
- getter = true
- }
- if getter {
- getters = append(getters, getterSymbol{
- name: mname,
- typ: typename,
- typeName: field.GetTypeName(),
- genType: genType,
- })
- }
-
- g.P("func (m *", ccTypeName, ") "+mname+"() "+typename+" {")
- g.In()
- def, hasDef := defNames[field]
- typeDefaultIsNil := false // whether this field type's default value is a literal nil unless specified
- switch *field.Type {
- case descriptor.FieldDescriptorProto_TYPE_BYTES:
- typeDefaultIsNil = !hasDef
- case descriptor.FieldDescriptorProto_TYPE_GROUP, descriptor.FieldDescriptorProto_TYPE_MESSAGE:
- typeDefaultIsNil = true
- }
- if isRepeated(field) {
- typeDefaultIsNil = true
- }
- if typeDefaultIsNil {
- // A bytes field with no explicit default needs less generated code,
- // as does a message or group field, or a repeated field.
- g.P("if m != nil {")
- g.In()
- g.P("return m." + fname)
- g.Out()
- g.P("}")
- g.P("return nil")
- g.Out()
- g.P("}")
- g.P()
- continue
- }
- g.P("if m != nil && m." + fname + " != nil {")
- g.In()
- g.P("return " + star + "m." + fname)
- g.Out()
- g.P("}")
- if hasDef {
- if *field.Type != descriptor.FieldDescriptorProto_TYPE_BYTES {
- g.P("return " + def)
- } else {
- // The default is a []byte var.
- // Make a copy when returning it to be safe.
- g.P("return append([]byte(nil), ", def, "...)")
- }
- } else {
- switch *field.Type {
- case descriptor.FieldDescriptorProto_TYPE_BOOL:
- g.P("return false")
- case descriptor.FieldDescriptorProto_TYPE_STRING:
- g.P(`return ""`)
- case descriptor.FieldDescriptorProto_TYPE_ENUM:
- // The default default for an enum is the first value in the enum,
- // not zero.
- obj := g.ObjectNamed(field.GetTypeName())
- var enum *EnumDescriptor
- if id, ok := obj.(*ImportedDescriptor); ok {
- // The enum type has been publicly imported.
- enum, _ = id.o.(*EnumDescriptor)
- } else {
- enum, _ = obj.(*EnumDescriptor)
- }
- if enum == nil {
- log.Printf("don't know how to generate getter for %s", field.GetName())
- continue
- }
- if len(enum.Value) == 0 {
- g.P("return 0 // empty enum")
- } else {
- first := enum.Value[0].GetName()
- g.P("return ", g.DefaultPackageName(obj)+enum.prefix()+first)
- }
- default:
- g.P("return 0")
- }
- }
- g.Out()
- g.P("}")
- g.P()
- }
-
- if !message.group {
- ms := &messageSymbol{sym: ccTypeName, hasExtensions: hasExtensions, isMessageSet: isMessageSet, getters: getters}
- g.file.addExport(message, ms)
- }
-
- for _, ext := range message.ext {
- g.generateExtension(ext)
- }
-
-}
-
-func (g *Generator) generateExtension(ext *ExtensionDescriptor) {
- ccTypeName := ext.DescName()
-
- extObj := g.ObjectNamed(*ext.Extendee)
- var extDesc *Descriptor
- if id, ok := extObj.(*ImportedDescriptor); ok {
- // This is extending a publicly imported message.
- // We need the underlying type for goTag.
- extDesc = id.o.(*Descriptor)
- } else {
- extDesc = extObj.(*Descriptor)
- }
- extendedType := "*" + g.TypeName(extObj) // always use the original
- field := ext.FieldDescriptorProto
- fieldType, wireType := g.GoType(ext.parent, field)
- tag := g.goTag(extDesc, field, wireType)
- g.RecordTypeUse(*ext.Extendee)
- if n := ext.FieldDescriptorProto.TypeName; n != nil {
- // foreign extension type
- g.RecordTypeUse(*n)
- }
-
- typeName := ext.TypeName()
-
- // Special case for proto2 message sets: If this extension is extending
- // proto2_bridge.MessageSet, and its final name component is "message_set_extension",
- // then drop that last component.
- mset := false
- if extendedType == "*proto2_bridge.MessageSet" && typeName[len(typeName)-1] == "message_set_extension" {
- typeName = typeName[:len(typeName)-1]
- mset = true
- }
-
- // For text formatting, the package must be exactly what the .proto file declares,
- // ignoring overrides such as the go_package option, and with no dot/underscore mapping.
- extName := strings.Join(typeName, ".")
- if g.file.Package != nil {
- extName = *g.file.Package + "." + extName
- }
-
- g.P("var ", ccTypeName, " = &", g.Pkg["proto"], ".ExtensionDesc{")
- g.In()
- g.P("ExtendedType: (", extendedType, ")(nil),")
- g.P("ExtensionType: (", fieldType, ")(nil),")
- g.P("Field: ", field.Number, ",")
- g.P(`Name: "`, extName, `",`)
- g.P("Tag: ", tag, ",")
-
- g.Out()
- g.P("}")
- g.P()
-
- if mset {
- // Generate a bit more code to register with message_set.go.
- g.addInitf("%s.RegisterMessageSetType((%s)(nil), %d, %q)", g.Pkg["proto"], fieldType, *field.Number, extName)
- }
-
- g.file.addExport(ext, constOrVarSymbol{ccTypeName, "var", ""})
-}
-
-func (g *Generator) generateInitFunction() {
- for _, enum := range g.file.enum {
- g.generateEnumRegistration(enum)
- }
- for _, d := range g.file.desc {
- for _, ext := range d.ext {
- g.generateExtensionRegistration(ext)
- }
- }
- for _, ext := range g.file.ext {
- g.generateExtensionRegistration(ext)
- }
- if len(g.init) == 0 {
- return
- }
- g.P("func init() {")
- g.In()
- for _, l := range g.init {
- g.P(l)
- }
- g.Out()
- g.P("}")
- g.init = nil
-}
-
-func (g *Generator) generateEnumRegistration(enum *EnumDescriptor) {
- // // We always print the full (proto-world) package name here.
- pkg := enum.File().GetPackage()
- if pkg != "" {
- pkg += "."
- }
- // The full type name
- typeName := enum.TypeName()
- // The full type name, CamelCased.
- ccTypeName := CamelCaseSlice(typeName)
- g.addInitf("%s.RegisterEnum(%q, %[3]s_name, %[3]s_value)", g.Pkg["proto"], pkg+ccTypeName, ccTypeName)
-}
-
-func (g *Generator) generateExtensionRegistration(ext *ExtensionDescriptor) {
- g.addInitf("%s.RegisterExtension(%s)", g.Pkg["proto"], ext.DescName())
-}
-
-// And now lots of helper functions.
-
-// Is c an ASCII lower-case letter?
-func isASCIILower(c byte) bool {
- return 'a' <= c && c <= 'z'
-}
-
-// Is c an ASCII digit?
-func isASCIIDigit(c byte) bool {
- return '0' <= c && c <= '9'
-}
-
-// CamelCase returns the CamelCased name.
-// If there is an interior underscore followed by a lower case letter,
-// drop the underscore and convert the letter to upper case.
-// There is a remote possibility of this rewrite causing a name collision,
-// but it's so remote we're prepared to pretend it's nonexistent - since the
-// C++ generator lowercases names, it's extremely unlikely to have two fields
-// with different capitalizations.
-// In short, _my_field_name_2 becomes XMyFieldName_2.
-func CamelCase(s string) string {
- if s == "" {
- return ""
- }
- t := make([]byte, 0, 32)
- i := 0
- if s[0] == '_' {
- // Need a capital letter; drop the '_'.
- t = append(t, 'X')
- i++
- }
- // Invariant: if the next letter is lower case, it must be converted
- // to upper case.
- // That is, we process a word at a time, where words are marked by _ or
- // upper case letter. Digits are treated as words.
- for ; i < len(s); i++ {
- c := s[i]
- if c == '_' && i+1 < len(s) && isASCIILower(s[i+1]) {
- continue // Skip the underscore in s.
- }
- if isASCIIDigit(c) {
- t = append(t, c)
- continue
- }
- // Assume we have a letter now - if not, it's a bogus identifier.
- // The next word is a sequence of characters that must start upper case.
- if isASCIILower(c) {
- c ^= ' ' // Make it a capital letter.
- }
- t = append(t, c) // Guaranteed not lower case.
- // Accept lower case sequence that follows.
- for i+1 < len(s) && isASCIILower(s[i+1]) {
- i++
- t = append(t, s[i])
- }
- }
- return string(t)
-}
-
-// CamelCaseSlice is like CamelCase, but the argument is a slice of strings to
-// be joined with "_".
-func CamelCaseSlice(elem []string) string { return CamelCase(strings.Join(elem, "_")) }
-
-// dottedSlice turns a sliced name into a dotted name.
-func dottedSlice(elem []string) string { return strings.Join(elem, ".") }
-
-// Given a .proto file name, return the output name for the generated Go program.
-func goFileName(name string) string {
- ext := path.Ext(name)
- if ext == ".proto" || ext == ".protodevel" {
- name = name[0 : len(name)-len(ext)]
- }
- return name + ".pb.go"
-}
-
-// Is this field optional?
-func isOptional(field *descriptor.FieldDescriptorProto) bool {
- return field.Label != nil && *field.Label == descriptor.FieldDescriptorProto_LABEL_OPTIONAL
-}
-
-// Is this field required?
-func isRequired(field *descriptor.FieldDescriptorProto) bool {
- return field.Label != nil && *field.Label == descriptor.FieldDescriptorProto_LABEL_REQUIRED
-}
-
-// Is this field repeated?
-func isRepeated(field *descriptor.FieldDescriptorProto) bool {
- return field.Label != nil && *field.Label == descriptor.FieldDescriptorProto_LABEL_REPEATED
-}
-
-// badToUnderscore is the mapping function used to generate Go names from package names,
-// which can be dotted in the input .proto file. It replaces non-identifier characters such as
-// dot or dash with underscore.
-func badToUnderscore(r rune) rune {
- if unicode.IsLetter(r) || unicode.IsDigit(r) || r == '_' {
- return r
- }
- return '_'
-}
-
-// baseName returns the last path element of the name, with the last dotted suffix removed.
-func baseName(name string) string {
- // First, find the last element
- if i := strings.LastIndex(name, "/"); i >= 0 {
- name = name[i+1:]
- }
- // Now drop the suffix
- if i := strings.LastIndex(name, "."); i >= 0 {
- name = name[0:i]
- }
- return name
-}
-
-// The SourceCodeInfo message describes the location of elements of a parsed
-// .proto file by way of a "path", which is a sequence of integers that
-// describe the route from a FileDescriptorProto to the relevant submessage.
-// The path alternates between a field number of a repeated field, and an index
-// into that repeated field. The constants below define the field numbers that
-// are used.
-//
-// See descriptor.proto for more information about this.
-const (
- // tag numbers in FileDescriptorProto
- packagePath = 2 // package
- messagePath = 4 // message_type
- enumPath = 5 // enum_type
- // tag numbers in DescriptorProto
- messageFieldPath = 2 // field
- messageMessagePath = 3 // nested_type
- messageEnumPath = 4 // enum_type
- // tag numbers in EnumDescriptorProto
- enumValuePath = 2 // value
-)
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/generator/name_test.go b/vendor/github.com/golang/protobuf/protoc-gen-go/generator/name_test.go
deleted file mode 100644
index f926918e..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/generator/name_test.go
+++ /dev/null
@@ -1,56 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2013 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-package generator
-
-import (
- "testing"
-)
-
-func TestCamelCase(t *testing.T) {
- tests := []struct {
- in, want string
- }{
- {"one", "One"},
- {"one_two", "OneTwo"},
- {"_my_field_name_2", "XMyFieldName_2"},
- {"Something_Capped", "Something_Capped"},
- {"my_Name", "My_Name"},
- {"OneTwo", "OneTwo"},
- {"_", "X"},
- {"_a_", "XA_"},
- }
- for _, tc := range tests {
- if got := CamelCase(tc.in); got != tc.want {
- t.Errorf("CamelCase(%q) = %q, want %q", tc.in, got, tc.want)
- }
- }
-}
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/internal/grpc/grpc.go b/vendor/github.com/golang/protobuf/protoc-gen-go/internal/grpc/grpc.go
deleted file mode 100644
index 3029bb39..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/internal/grpc/grpc.go
+++ /dev/null
@@ -1,436 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2015 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-// Package grpc outputs gRPC service descriptions in Go code.
-// It runs as a plugin for the Go protocol buffer compiler plugin.
-// It is linked in to protoc-gen-go.
-package grpc
-
-import (
- "fmt"
- "path"
- "strconv"
- "strings"
-
- pb "github.com/golang/protobuf/protoc-gen-go/descriptor"
- "github.com/golang/protobuf/protoc-gen-go/generator"
-)
-
-// Paths for packages used by code generated in this file,
-// relative to the import_prefix of the generator.Generator.
-const (
- contextPkgPath = "golang.org/x/net/context"
- grpcPkgPath = "google.golang.org/grpc"
-)
-
-func init() {
- generator.RegisterPlugin(new(grpc))
-}
-
-// grpc is an implementation of the Go protocol buffer compiler's
-// plugin architecture. It generates bindings for gRPC support.
-type grpc struct {
- gen *generator.Generator
-}
-
-// Name returns the name of this plugin, "grpc".
-func (g *grpc) Name() string {
- return "grpc"
-}
-
-// The names for packages imported in the generated code.
-// They may vary from the final path component of the import path
-// if the name is used by other packages.
-var (
- contextPkg string
- grpcPkg string
-)
-
-// Init initializes the plugin.
-func (g *grpc) Init(gen *generator.Generator) {
- g.gen = gen
- contextPkg = generator.RegisterUniquePackageName("context", nil)
- grpcPkg = generator.RegisterUniquePackageName("grpc", nil)
-}
-
-// Given a type name defined in a .proto, return its object.
-// Also record that we're using it, to guarantee the associated import.
-func (g *grpc) objectNamed(name string) generator.Object {
- g.gen.RecordTypeUse(name)
- return g.gen.ObjectNamed(name)
-}
-
-// Given a type name defined in a .proto, return its name as we will print it.
-func (g *grpc) typeName(str string) string {
- return g.gen.TypeName(g.objectNamed(str))
-}
-
-// P forwards to g.gen.P.
-func (g *grpc) P(args ...interface{}) { g.gen.P(args...) }
-
-// Generate generates code for the services in the given file.
-func (g *grpc) Generate(file *generator.FileDescriptor) {
- for i, service := range file.FileDescriptorProto.Service {
- g.generateService(file, service, i)
- }
-}
-
-// GenerateImports generates the import declaration for this file.
-func (g *grpc) GenerateImports(file *generator.FileDescriptor) {
- if len(file.FileDescriptorProto.Service) == 0 {
- return
- }
- g.P("import (")
- g.P(contextPkg, " ", strconv.Quote(path.Join(g.gen.ImportPrefix, contextPkgPath)))
- g.P(grpcPkg, " ", strconv.Quote(path.Join(g.gen.ImportPrefix, grpcPkgPath)))
- g.P(")")
- g.P()
- g.P("// Reference imports to suppress errors if they are not otherwise used.")
- g.P("var _ ", contextPkg, ".Context")
- g.P("var _ ", grpcPkg, ".ClientConn")
- g.P()
-}
-
-// reservedClientName records whether a client name is reserved on the client side.
-var reservedClientName = map[string]bool{
-// TODO: do we need any in gRPC?
-}
-
-func unexport(s string) string { return strings.ToLower(s[:1]) + s[1:] }
-
-// generateService generates all the code for the named service.
-func (g *grpc) generateService(file *generator.FileDescriptor, service *pb.ServiceDescriptorProto, index int) {
- path := fmt.Sprintf("6,%d", index) // 6 means service.
-
- origServName := service.GetName()
- fullServName := file.GetPackage() + "." + origServName
- servName := generator.CamelCase(origServName)
-
- g.P()
- g.P("// Client API for ", servName, " service")
- g.P()
-
- // Client interface.
- g.P("type ", servName, "Client interface {")
- for i, method := range service.Method {
- g.gen.PrintComments(fmt.Sprintf("%s,2,%d", path, i)) // 2 means method in a service.
- g.P(g.generateClientSignature(servName, method))
- }
- g.P("}")
- g.P()
-
- // Client structure.
- g.P("type ", unexport(servName), "Client struct {")
- g.P("cc *", grpcPkg, ".ClientConn")
- g.P("}")
- g.P()
-
- // NewClient factory.
- g.P("func New", servName, "Client (cc *", grpcPkg, ".ClientConn) ", servName, "Client {")
- g.P("return &", unexport(servName), "Client{cc}")
- g.P("}")
- g.P()
-
- var methodIndex, streamIndex int
- serviceDescVar := "_" + servName + "_serviceDesc"
- // Client method implementations.
- for _, method := range service.Method {
- var descExpr string
- if !method.GetServerStreaming() && !method.GetClientStreaming() {
- // Unary RPC method
- descExpr = fmt.Sprintf("&%s.Methods[%d]", serviceDescVar, methodIndex)
- methodIndex++
- } else {
- // Streaming RPC method
- descExpr = fmt.Sprintf("&%s.Streams[%d]", serviceDescVar, streamIndex)
- streamIndex++
- }
- g.generateClientMethod(servName, fullServName, serviceDescVar, method, descExpr)
- }
-
- g.P("// Server API for ", servName, " service")
- g.P()
-
- // Server interface.
- serverType := servName + "Server"
- g.P("type ", serverType, " interface {")
- for i, method := range service.Method {
- g.gen.PrintComments(fmt.Sprintf("%s,2,%d", path, i)) // 2 means method in a service.
- g.P(g.generateServerSignature(servName, method))
- }
- g.P("}")
- g.P()
-
- // Server registration.
- g.P("func Register", servName, "Server(s *", grpcPkg, ".Server, srv ", serverType, ") {")
- g.P("s.RegisterService(&", serviceDescVar, `, srv)`)
- g.P("}")
- g.P()
-
- // Server handler implementations.
- var handlerNames []string
- for _, method := range service.Method {
- hname := g.generateServerMethod(servName, method)
- handlerNames = append(handlerNames, hname)
- }
-
- // Service descriptor.
- g.P("var ", serviceDescVar, " = ", grpcPkg, ".ServiceDesc {")
- g.P("ServiceName: ", strconv.Quote(fullServName), ",")
- g.P("HandlerType: (*", serverType, ")(nil),")
- g.P("Methods: []", grpcPkg, ".MethodDesc{")
- for i, method := range service.Method {
- if method.GetServerStreaming() || method.GetClientStreaming() {
- continue
- }
- g.P("{")
- g.P("MethodName: ", strconv.Quote(method.GetName()), ",")
- g.P("Handler: ", handlerNames[i], ",")
- g.P("},")
- }
- g.P("},")
- g.P("Streams: []", grpcPkg, ".StreamDesc{")
- for i, method := range service.Method {
- if !method.GetServerStreaming() && !method.GetClientStreaming() {
- continue
- }
- g.P("{")
- g.P("StreamName: ", strconv.Quote(method.GetName()), ",")
- g.P("Handler: ", handlerNames[i], ",")
- if method.GetServerStreaming() {
- g.P("ServerStreams: true,")
- }
- if method.GetClientStreaming() {
- g.P("ClientStreams: true,")
- }
- g.P("},")
- }
- g.P("},")
- g.P("}")
- g.P()
-}
-
-// generateClientSignature returns the client-side signature for a method.
-func (g *grpc) generateClientSignature(servName string, method *pb.MethodDescriptorProto) string {
- origMethName := method.GetName()
- methName := generator.CamelCase(origMethName)
- if reservedClientName[methName] {
- methName += "_"
- }
- reqArg := ", in *" + g.typeName(method.GetInputType())
- if method.GetClientStreaming() {
- reqArg = ""
- }
- respName := "*" + g.typeName(method.GetOutputType())
- if method.GetServerStreaming() || method.GetClientStreaming() {
- respName = servName + "_" + generator.CamelCase(origMethName) + "Client"
- }
- return fmt.Sprintf("%s(ctx %s.Context%s, opts ...%s.CallOption) (%s, error)", methName, contextPkg, reqArg, grpcPkg, respName)
-}
-
-func (g *grpc) generateClientMethod(servName, fullServName, serviceDescVar string, method *pb.MethodDescriptorProto, descExpr string) {
- sname := fmt.Sprintf("/%s/%s", fullServName, method.GetName())
- methName := generator.CamelCase(method.GetName())
- inType := g.typeName(method.GetInputType())
- outType := g.typeName(method.GetOutputType())
-
- g.P("func (c *", unexport(servName), "Client) ", g.generateClientSignature(servName, method), "{")
- if !method.GetServerStreaming() && !method.GetClientStreaming() {
- g.P("out := new(", outType, ")")
- // TODO: Pass descExpr to Invoke.
- g.P("err := ", grpcPkg, `.Invoke(ctx, "`, sname, `", in, out, c.cc, opts...)`)
- g.P("if err != nil { return nil, err }")
- g.P("return out, nil")
- g.P("}")
- g.P()
- return
- }
- streamType := unexport(servName) + methName + "Client"
- g.P("stream, err := ", grpcPkg, ".NewClientStream(ctx, ", descExpr, `, c.cc, "`, sname, `", opts...)`)
- g.P("if err != nil { return nil, err }")
- g.P("x := &", streamType, "{stream}")
- if !method.GetClientStreaming() {
- g.P("if err := x.ClientStream.SendMsg(in); err != nil { return nil, err }")
- g.P("if err := x.ClientStream.CloseSend(); err != nil { return nil, err }")
- }
- g.P("return x, nil")
- g.P("}")
- g.P()
-
- genSend := method.GetClientStreaming()
- genRecv := method.GetServerStreaming()
- genCloseAndRecv := !method.GetServerStreaming()
-
- // Stream auxiliary types and methods.
- g.P("type ", servName, "_", methName, "Client interface {")
- if genSend {
- g.P("Send(*", inType, ") error")
- }
- if genRecv {
- g.P("Recv() (*", outType, ", error)")
- }
- if genCloseAndRecv {
- g.P("CloseAndRecv() (*", outType, ", error)")
- }
- g.P(grpcPkg, ".ClientStream")
- g.P("}")
- g.P()
-
- g.P("type ", streamType, " struct {")
- g.P(grpcPkg, ".ClientStream")
- g.P("}")
- g.P()
-
- if genSend {
- g.P("func (x *", streamType, ") Send(m *", inType, ") error {")
- g.P("return x.ClientStream.SendMsg(m)")
- g.P("}")
- g.P()
- }
- if genRecv {
- g.P("func (x *", streamType, ") Recv() (*", outType, ", error) {")
- g.P("m := new(", outType, ")")
- g.P("if err := x.ClientStream.RecvMsg(m); err != nil { return nil, err }")
- g.P("return m, nil")
- g.P("}")
- g.P()
- }
- if genCloseAndRecv {
- g.P("func (x *", streamType, ") CloseAndRecv() (*", outType, ", error) {")
- g.P("if err := x.ClientStream.CloseSend(); err != nil { return nil, err }")
- g.P("m := new(", outType, ")")
- g.P("if err := x.ClientStream.RecvMsg(m); err != nil { return nil, err }")
- g.P("return m, nil")
- g.P("}")
- g.P()
- }
-}
-
-// generateServerSignature returns the server-side signature for a method.
-func (g *grpc) generateServerSignature(servName string, method *pb.MethodDescriptorProto) string {
- origMethName := method.GetName()
- methName := generator.CamelCase(origMethName)
- if reservedClientName[methName] {
- methName += "_"
- }
-
- var reqArgs []string
- ret := "error"
- if !method.GetServerStreaming() && !method.GetClientStreaming() {
- reqArgs = append(reqArgs, contextPkg+".Context")
- ret = "(*" + g.typeName(method.GetOutputType()) + ", error)"
- }
- if !method.GetClientStreaming() {
- reqArgs = append(reqArgs, "*"+g.typeName(method.GetInputType()))
- }
- if method.GetServerStreaming() || method.GetClientStreaming() {
- reqArgs = append(reqArgs, servName+"_"+generator.CamelCase(origMethName)+"Server")
- }
-
- return methName + "(" + strings.Join(reqArgs, ", ") + ") " + ret
-}
-
-func (g *grpc) generateServerMethod(servName string, method *pb.MethodDescriptorProto) string {
- methName := generator.CamelCase(method.GetName())
- hname := fmt.Sprintf("_%s_%s_Handler", servName, methName)
- inType := g.typeName(method.GetInputType())
- outType := g.typeName(method.GetOutputType())
-
- if !method.GetServerStreaming() && !method.GetClientStreaming() {
- g.P("func ", hname, "(srv interface{}, ctx ", contextPkg, ".Context, codec ", grpcPkg, ".Codec, buf []byte) (interface{}, error) {")
- g.P("in := new(", inType, ")")
- g.P("if err := codec.Unmarshal(buf, in); err != nil { return nil, err }")
- g.P("out, err := srv.(", servName, "Server).", methName, "(ctx, in)")
- g.P("if err != nil { return nil, err }")
- g.P("return out, nil")
- g.P("}")
- g.P()
- return hname
- }
- streamType := unexport(servName) + methName + "Server"
- g.P("func ", hname, "(srv interface{}, stream ", grpcPkg, ".ServerStream) error {")
- if !method.GetClientStreaming() {
- g.P("m := new(", inType, ")")
- g.P("if err := stream.RecvMsg(m); err != nil { return err }")
- g.P("return srv.(", servName, "Server).", methName, "(m, &", streamType, "{stream})")
- } else {
- g.P("return srv.(", servName, "Server).", methName, "(&", streamType, "{stream})")
- }
- g.P("}")
- g.P()
-
- genSend := method.GetServerStreaming()
- genSendAndClose := !method.GetServerStreaming()
- genRecv := method.GetClientStreaming()
-
- // Stream auxiliary types and methods.
- g.P("type ", servName, "_", methName, "Server interface {")
- if genSend {
- g.P("Send(*", outType, ") error")
- }
- if genSendAndClose {
- g.P("SendAndClose(*", outType, ") error")
- }
- if genRecv {
- g.P("Recv() (*", inType, ", error)")
- }
- g.P(grpcPkg, ".ServerStream")
- g.P("}")
- g.P()
-
- g.P("type ", streamType, " struct {")
- g.P(grpcPkg, ".ServerStream")
- g.P("}")
- g.P()
-
- if genSend {
- g.P("func (x *", streamType, ") Send(m *", outType, ") error {")
- g.P("return x.ServerStream.SendMsg(m)")
- g.P("}")
- g.P()
- }
- if genSendAndClose {
- g.P("func (x *", streamType, ") SendAndClose(m *", outType, ") error {")
- g.P("return x.ServerStream.SendMsg(m)")
- g.P("}")
- g.P()
- }
- if genRecv {
- g.P("func (x *", streamType, ") Recv() (*", inType, ", error) {")
- g.P("m := new(", inType, ")")
- g.P("if err := x.ServerStream.RecvMsg(m); err != nil { return nil, err }")
- g.P("return m, nil")
- g.P("}")
- g.P()
- }
-
- return hname
-}
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/link_grpc.go b/vendor/github.com/golang/protobuf/protoc-gen-go/link_grpc.go
deleted file mode 100644
index 24e490ec..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/link_grpc.go
+++ /dev/null
@@ -1,34 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2015 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-package main
-
-import _ "github.com/golang/protobuf/protoc-gen-go/internal/grpc"
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/main.go b/vendor/github.com/golang/protobuf/protoc-gen-go/main.go
deleted file mode 100644
index 8e2486de..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/main.go
+++ /dev/null
@@ -1,98 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2010 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-// protoc-gen-go is a plugin for the Google protocol buffer compiler to generate
-// Go code. Run it by building this program and putting it in your path with
-// the name
-// protoc-gen-go
-// That word 'go' at the end becomes part of the option string set for the
-// protocol compiler, so once the protocol compiler (protoc) is installed
-// you can run
-// protoc --go_out=output_directory input_directory/file.proto
-// to generate Go bindings for the protocol defined by file.proto.
-// With that input, the output will be written to
-// output_directory/file.pb.go
-//
-// The generated code is documented in the package comment for
-// the library.
-//
-// See the README and documentation for protocol buffers to learn more:
-// https://developers.google.com/protocol-buffers/
-package main
-
-import (
- "io/ioutil"
- "os"
-
- "github.com/golang/protobuf/proto"
- "github.com/golang/protobuf/protoc-gen-go/generator"
-)
-
-func main() {
- // Begin by allocating a generator. The request and response structures are stored there
- // so we can do error handling easily - the response structure contains the field to
- // report failure.
- g := generator.New()
-
- data, err := ioutil.ReadAll(os.Stdin)
- if err != nil {
- g.Error(err, "reading input")
- }
-
- if err := proto.Unmarshal(data, g.Request); err != nil {
- g.Error(err, "parsing input proto")
- }
-
- if len(g.Request.FileToGenerate) == 0 {
- g.Fail("no files to generate")
- }
-
- g.CommandLineParameters(g.Request.GetParameter())
-
- // Create a wrapped version of the Descriptors and EnumDescriptors that
- // point to the file that defines them.
- g.WrapTypes()
-
- g.SetPackageNames()
- g.BuildTypeNameMap()
-
- g.GenerateAllFiles()
-
- // Send back the results.
- data, err = proto.Marshal(g.Response)
- if err != nil {
- g.Error(err, "failed to marshal output proto")
- }
- _, err = os.Stdout.Write(data)
- if err != nil {
- g.Error(err, "failed to write output proto")
- }
-}
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/plugin/Makefile b/vendor/github.com/golang/protobuf/protoc-gen-go/plugin/Makefile
deleted file mode 100644
index 8a49a29d..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/plugin/Makefile
+++ /dev/null
@@ -1,46 +0,0 @@
-# Go support for Protocol Buffers - Google's data interchange format
-#
-# Copyright 2010 The Go Authors. All rights reserved.
-# https://github.com/golang/protobuf
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are
-# met:
-#
-# * Redistributions of source code must retain the above copyright
-# notice, this list of conditions and the following disclaimer.
-# * Redistributions in binary form must reproduce the above
-# copyright notice, this list of conditions and the following disclaimer
-# in the documentation and/or other materials provided with the
-# distribution.
-# * Neither the name of Google Inc. nor the names of its
-# contributors may be used to endorse or promote products derived from
-# this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-# Not stored here, but plugin.proto is in https://github.com/google/protobuf/
-# at src/google/protobuf/compiler/plugin.proto
-# Also we need to fix an import.
-regenerate:
- echo WARNING! THIS RULE IS PROBABLY NOT RIGHT FOR YOUR INSTALLATION
- cd $(HOME)/src/protobuf/src && \
- protoc --go_out=Mgoogle/protobuf/descriptor.proto=github.com/golang/protobuf/protoc-gen-go/descriptor:. \
- ./google/protobuf/compiler/plugin.proto && \
- cat ./google/protobuf/compiler/plugin.pb.go > $(GOPATH)/src/github.com/golang/protobuf/protoc-gen-go/plugin/plugin.pb.go
-
-restore:
- cp plugin.pb.golden plugin.pb.go
-
-preserve:
- cp plugin.pb.go plugin.pb.golden
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/plugin/plugin.pb.golden b/vendor/github.com/golang/protobuf/protoc-gen-go/plugin/plugin.pb.golden
deleted file mode 100644
index 8953d0ff..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/plugin/plugin.pb.golden
+++ /dev/null
@@ -1,83 +0,0 @@
-// Code generated by protoc-gen-go.
-// source: google/protobuf/compiler/plugin.proto
-// DO NOT EDIT!
-
-package google_protobuf_compiler
-
-import proto "github.com/golang/protobuf/proto"
-import "math"
-import google_protobuf "github.com/golang/protobuf/protoc-gen-go/descriptor"
-
-// Reference proto and math imports to suppress error if they are not otherwise used.
-var _ = proto.GetString
-var _ = math.Inf
-
-type CodeGeneratorRequest struct {
- FileToGenerate []string `protobuf:"bytes,1,rep,name=file_to_generate" json:"file_to_generate,omitempty"`
- Parameter *string `protobuf:"bytes,2,opt,name=parameter" json:"parameter,omitempty"`
- ProtoFile []*google_protobuf.FileDescriptorProto `protobuf:"bytes,15,rep,name=proto_file" json:"proto_file,omitempty"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (this *CodeGeneratorRequest) Reset() { *this = CodeGeneratorRequest{} }
-func (this *CodeGeneratorRequest) String() string { return proto.CompactTextString(this) }
-func (*CodeGeneratorRequest) ProtoMessage() {}
-
-func (this *CodeGeneratorRequest) GetParameter() string {
- if this != nil && this.Parameter != nil {
- return *this.Parameter
- }
- return ""
-}
-
-type CodeGeneratorResponse struct {
- Error *string `protobuf:"bytes,1,opt,name=error" json:"error,omitempty"`
- File []*CodeGeneratorResponse_File `protobuf:"bytes,15,rep,name=file" json:"file,omitempty"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (this *CodeGeneratorResponse) Reset() { *this = CodeGeneratorResponse{} }
-func (this *CodeGeneratorResponse) String() string { return proto.CompactTextString(this) }
-func (*CodeGeneratorResponse) ProtoMessage() {}
-
-func (this *CodeGeneratorResponse) GetError() string {
- if this != nil && this.Error != nil {
- return *this.Error
- }
- return ""
-}
-
-type CodeGeneratorResponse_File struct {
- Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
- InsertionPoint *string `protobuf:"bytes,2,opt,name=insertion_point" json:"insertion_point,omitempty"`
- Content *string `protobuf:"bytes,15,opt,name=content" json:"content,omitempty"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (this *CodeGeneratorResponse_File) Reset() { *this = CodeGeneratorResponse_File{} }
-func (this *CodeGeneratorResponse_File) String() string { return proto.CompactTextString(this) }
-func (*CodeGeneratorResponse_File) ProtoMessage() {}
-
-func (this *CodeGeneratorResponse_File) GetName() string {
- if this != nil && this.Name != nil {
- return *this.Name
- }
- return ""
-}
-
-func (this *CodeGeneratorResponse_File) GetInsertionPoint() string {
- if this != nil && this.InsertionPoint != nil {
- return *this.InsertionPoint
- }
- return ""
-}
-
-func (this *CodeGeneratorResponse_File) GetContent() string {
- if this != nil && this.Content != nil {
- return *this.Content
- }
- return ""
-}
-
-func init() {
-}
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/Makefile b/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/Makefile
deleted file mode 100644
index 3d084482..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/Makefile
+++ /dev/null
@@ -1,66 +0,0 @@
-# Go support for Protocol Buffers - Google's data interchange format
-#
-# Copyright 2010 The Go Authors. All rights reserved.
-# https://github.com/golang/protobuf
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are
-# met:
-#
-# * Redistributions of source code must retain the above copyright
-# notice, this list of conditions and the following disclaimer.
-# * Redistributions in binary form must reproduce the above
-# copyright notice, this list of conditions and the following disclaimer
-# in the documentation and/or other materials provided with the
-# distribution.
-# * Neither the name of Google Inc. nor the names of its
-# contributors may be used to endorse or promote products derived from
-# this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-all:
- @echo run make test
-
-include ../../Make.protobuf
-
-test: golden testbuild
-
-#test: golden testbuild extension_test
-# ./extension_test
-# @echo PASS
-
-golden:
- make -B my_test/test.pb.go
- diff -w my_test/test.pb.go my_test/test.pb.go.golden
-
-nuke: clean
-
-testbuild: buildprotos
- go test
-
-buildprotos:
- # Invoke protoc once to generate three independent .pb.go files in the same package.
- protoc --go_out=. multi/multi{1,2,3}.proto
-
-#extension_test: extension_test.$O
-# $(LD) -L. -o $@ $<
-
-#multi.a: multi3.pb.$O multi2.pb.$O multi1.pb.$O
-# rm -f multi.a
-# $(QUOTED_GOBIN)/gopack grc $@ $<
-
-#test.pb.go: imp.pb.go
-#multi1.pb.go: multi2.pb.go multi3.pb.go
-#main.$O: imp.pb.$O test.pb.$O multi.a
-#extension_test.$O: extension_base.pb.$O extension_extra.pb.$O extension_user.pb.$O
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/extension_base.proto b/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/extension_base.proto
deleted file mode 100644
index 94acfc1b..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/extension_base.proto
+++ /dev/null
@@ -1,46 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2010 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-syntax = "proto2";
-
-package extension_base;
-
-message BaseMessage {
- optional int32 height = 1;
- extensions 4 to 9;
- extensions 16 to max;
-}
-
-// Another message that may be extended, using message_set_wire_format.
-message OldStyleMessage {
- option message_set_wire_format = true;
- extensions 100 to max;
-}
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/extension_extra.proto b/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/extension_extra.proto
deleted file mode 100644
index fca7f600..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/extension_extra.proto
+++ /dev/null
@@ -1,38 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2011 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-syntax = "proto2";
-
-package extension_extra;
-
-message ExtraMessage {
- optional int32 width = 1;
-}
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/extension_test.go b/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/extension_test.go
deleted file mode 100644
index 86e9c118..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/extension_test.go
+++ /dev/null
@@ -1,210 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2010 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-// Test that we can use protocol buffers that use extensions.
-
-package testdata
-
-/*
-
-import (
- "bytes"
- "regexp"
- "testing"
-
- "github.com/golang/protobuf/proto"
- base "extension_base.pb"
- user "extension_user.pb"
-)
-
-func TestSingleFieldExtension(t *testing.T) {
- bm := &base.BaseMessage{
- Height: proto.Int32(178),
- }
-
- // Use extension within scope of another type.
- vol := proto.Uint32(11)
- err := proto.SetExtension(bm, user.E_LoudMessage_Volume, vol)
- if err != nil {
- t.Fatal("Failed setting extension:", err)
- }
- buf, err := proto.Marshal(bm)
- if err != nil {
- t.Fatal("Failed encoding message with extension:", err)
- }
- bm_new := new(base.BaseMessage)
- if err := proto.Unmarshal(buf, bm_new); err != nil {
- t.Fatal("Failed decoding message with extension:", err)
- }
- if !proto.HasExtension(bm_new, user.E_LoudMessage_Volume) {
- t.Fatal("Decoded message didn't contain extension.")
- }
- vol_out, err := proto.GetExtension(bm_new, user.E_LoudMessage_Volume)
- if err != nil {
- t.Fatal("Failed getting extension:", err)
- }
- if v := vol_out.(*uint32); *v != *vol {
- t.Errorf("vol_out = %v, expected %v", *v, *vol)
- }
- proto.ClearExtension(bm_new, user.E_LoudMessage_Volume)
- if proto.HasExtension(bm_new, user.E_LoudMessage_Volume) {
- t.Fatal("Failed clearing extension.")
- }
-}
-
-func TestMessageExtension(t *testing.T) {
- bm := &base.BaseMessage{
- Height: proto.Int32(179),
- }
-
- // Use extension that is itself a message.
- um := &user.UserMessage{
- Name: proto.String("Dave"),
- Rank: proto.String("Major"),
- }
- err := proto.SetExtension(bm, user.E_LoginMessage_UserMessage, um)
- if err != nil {
- t.Fatal("Failed setting extension:", err)
- }
- buf, err := proto.Marshal(bm)
- if err != nil {
- t.Fatal("Failed encoding message with extension:", err)
- }
- bm_new := new(base.BaseMessage)
- if err := proto.Unmarshal(buf, bm_new); err != nil {
- t.Fatal("Failed decoding message with extension:", err)
- }
- if !proto.HasExtension(bm_new, user.E_LoginMessage_UserMessage) {
- t.Fatal("Decoded message didn't contain extension.")
- }
- um_out, err := proto.GetExtension(bm_new, user.E_LoginMessage_UserMessage)
- if err != nil {
- t.Fatal("Failed getting extension:", err)
- }
- if n := um_out.(*user.UserMessage).Name; *n != *um.Name {
- t.Errorf("um_out.Name = %q, expected %q", *n, *um.Name)
- }
- if r := um_out.(*user.UserMessage).Rank; *r != *um.Rank {
- t.Errorf("um_out.Rank = %q, expected %q", *r, *um.Rank)
- }
- proto.ClearExtension(bm_new, user.E_LoginMessage_UserMessage)
- if proto.HasExtension(bm_new, user.E_LoginMessage_UserMessage) {
- t.Fatal("Failed clearing extension.")
- }
-}
-
-func TestTopLevelExtension(t *testing.T) {
- bm := &base.BaseMessage{
- Height: proto.Int32(179),
- }
-
- width := proto.Int32(17)
- err := proto.SetExtension(bm, user.E_Width, width)
- if err != nil {
- t.Fatal("Failed setting extension:", err)
- }
- buf, err := proto.Marshal(bm)
- if err != nil {
- t.Fatal("Failed encoding message with extension:", err)
- }
- bm_new := new(base.BaseMessage)
- if err := proto.Unmarshal(buf, bm_new); err != nil {
- t.Fatal("Failed decoding message with extension:", err)
- }
- if !proto.HasExtension(bm_new, user.E_Width) {
- t.Fatal("Decoded message didn't contain extension.")
- }
- width_out, err := proto.GetExtension(bm_new, user.E_Width)
- if err != nil {
- t.Fatal("Failed getting extension:", err)
- }
- if w := width_out.(*int32); *w != *width {
- t.Errorf("width_out = %v, expected %v", *w, *width)
- }
- proto.ClearExtension(bm_new, user.E_Width)
- if proto.HasExtension(bm_new, user.E_Width) {
- t.Fatal("Failed clearing extension.")
- }
-}
-
-func TestMessageSetWireFormat(t *testing.T) {
- osm := new(base.OldStyleMessage)
- osp := &user.OldStyleParcel{
- Name: proto.String("Dave"),
- Height: proto.Int32(178),
- }
-
- err := proto.SetExtension(osm, user.E_OldStyleParcel_MessageSetExtension, osp)
- if err != nil {
- t.Fatal("Failed setting extension:", err)
- }
-
- buf, err := proto.Marshal(osm)
- if err != nil {
- t.Fatal("Failed encoding message:", err)
- }
-
- // Data generated from Python implementation.
- expected := []byte{
- 11, 16, 209, 15, 26, 9, 10, 4, 68, 97, 118, 101, 16, 178, 1, 12,
- }
-
- if !bytes.Equal(expected, buf) {
- t.Errorf("Encoding mismatch.\nwant %+v\n got %+v", expected, buf)
- }
-
- // Check that it is restored correctly.
- osm = new(base.OldStyleMessage)
- if err := proto.Unmarshal(buf, osm); err != nil {
- t.Fatal("Failed decoding message:", err)
- }
- osp_out, err := proto.GetExtension(osm, user.E_OldStyleParcel_MessageSetExtension)
- if err != nil {
- t.Fatal("Failed getting extension:", err)
- }
- osp = osp_out.(*user.OldStyleParcel)
- if *osp.Name != "Dave" || *osp.Height != 178 {
- t.Errorf("Retrieved extension from decoded message is not correct: %+v", osp)
- }
-}
-
-func main() {
- // simpler than rigging up gotest
- testing.Main(regexp.MatchString, []testing.InternalTest{
- {"TestSingleFieldExtension", TestSingleFieldExtension},
- {"TestMessageExtension", TestMessageExtension},
- {"TestTopLevelExtension", TestTopLevelExtension},
- },
- []testing.InternalBenchmark{},
- []testing.InternalExample{})
-}
-
-*/
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/extension_user.proto b/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/extension_user.proto
deleted file mode 100644
index ff65873d..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/extension_user.proto
+++ /dev/null
@@ -1,100 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2010 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-syntax = "proto2";
-
-import "extension_base.proto";
-import "extension_extra.proto";
-
-package extension_user;
-
-message UserMessage {
- optional string name = 1;
- optional string rank = 2;
-}
-
-// Extend with a message
-extend extension_base.BaseMessage {
- optional UserMessage user_message = 5;
-}
-
-// Extend with a foreign message
-extend extension_base.BaseMessage {
- optional extension_extra.ExtraMessage extra_message = 9;
-}
-
-// Extend with some primitive types
-extend extension_base.BaseMessage {
- optional int32 width = 6;
- optional int64 area = 7;
-}
-
-// Extend inside the scope of another type
-message LoudMessage {
- extend extension_base.BaseMessage {
- optional uint32 volume = 8;
- }
- extensions 100 to max;
-}
-
-// Extend inside the scope of another type, using a message.
-message LoginMessage {
- extend extension_base.BaseMessage {
- optional UserMessage user_message = 16;
- }
-}
-
-// Extend with a repeated field
-extend extension_base.BaseMessage {
- repeated Detail detail = 17;
-}
-
-message Detail {
- optional string color = 1;
-}
-
-// An extension of an extension
-message Announcement {
- optional string words = 1;
- extend LoudMessage {
- optional Announcement loud_ext = 100;
- }
-}
-
-// Something that can be put in a message set.
-message OldStyleParcel {
- extend extension_base.OldStyleMessage {
- optional OldStyleParcel message_set_extension = 2001;
- }
-
- required string name = 1;
- optional int32 height = 2;
-}
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/golden_test.go b/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/golden_test.go
deleted file mode 100644
index 95548d4e..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/golden_test.go
+++ /dev/null
@@ -1,86 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2012 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-// Verify that the compiler output for test.proto is unchanged.
-
-package testdata
-
-import (
- "crypto/sha1"
- "fmt"
- "io/ioutil"
- "os"
- "os/exec"
- "path/filepath"
- "testing"
-)
-
-// sum returns in string form (for easy comparison) the SHA-1 hash of the named file.
-func sum(t *testing.T, name string) string {
- data, err := ioutil.ReadFile(name)
- if err != nil {
- t.Fatal(err)
- }
- t.Logf("sum(%q): length is %d", name, len(data))
- hash := sha1.New()
- _, err = hash.Write(data)
- if err != nil {
- t.Fatal(err)
- }
- return fmt.Sprintf("% x", hash.Sum(nil))
-}
-
-func run(t *testing.T, name string, args ...string) {
- cmd := exec.Command(name, args...)
- cmd.Stdin = os.Stdin
- cmd.Stdout = os.Stdout
- cmd.Stderr = os.Stderr
- err := cmd.Run()
- if err != nil {
- t.Fatal(err)
- }
-}
-
-func TestGolden(t *testing.T) {
- // Compute the original checksum.
- goldenSum := sum(t, "my_test/test.pb.go")
- // Run the proto compiler.
- run(t, "protoc", "--go_out="+os.TempDir(), "my_test/test.proto")
- newFile := filepath.Join(os.TempDir(), "my_test/test.pb.go")
- defer os.Remove(newFile)
- // Compute the new checksum.
- newSum := sum(t, newFile)
- // Verify
- if newSum != goldenSum {
- run(t, "diff", "-u", "my_test/test.pb.go", newFile)
- t.Fatal("Code generated by protoc-gen-go has changed; update test.pb.go")
- }
-}
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/grpc.proto b/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/grpc.proto
deleted file mode 100644
index b8bc41ac..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/grpc.proto
+++ /dev/null
@@ -1,59 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2015 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-syntax = "proto3";
-
-package grpc.testing;
-
-message SimpleRequest {
-}
-
-message SimpleResponse {
-}
-
-message StreamMsg {
-}
-
-message StreamMsg2 {
-}
-
-service Test {
- rpc UnaryCall(SimpleRequest) returns (SimpleResponse);
-
- // This RPC streams from the server only.
- rpc Downstream(SimpleRequest) returns (stream StreamMsg);
-
- // This RPC streams from the client.
- rpc Upstream(stream StreamMsg) returns (SimpleResponse);
-
- // This one streams in both directions.
- rpc Bidi(stream StreamMsg) returns (stream StreamMsg2);
-}
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/imp.pb.go.golden b/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/imp.pb.go.golden
deleted file mode 100644
index 784a4f86..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/imp.pb.go.golden
+++ /dev/null
@@ -1,113 +0,0 @@
-// Code generated by protoc-gen-go.
-// source: imp.proto
-// DO NOT EDIT!
-
-package imp
-
-import proto "github.com/golang/protobuf/proto"
-import "math"
-import "os"
-import imp1 "imp2.pb"
-
-// Reference proto & math imports to suppress error if they are not otherwise used.
-var _ = proto.GetString
-var _ = math.Inf
-
-// Types from public import imp2.proto
-type PubliclyImportedMessage imp1.PubliclyImportedMessage
-
-func (this *PubliclyImportedMessage) Reset() { (*imp1.PubliclyImportedMessage)(this).Reset() }
-func (this *PubliclyImportedMessage) String() string {
- return (*imp1.PubliclyImportedMessage)(this).String()
-}
-
-// PubliclyImportedMessage from public import imp.proto
-
-type ImportedMessage_Owner int32
-
-const (
- ImportedMessage_DAVE ImportedMessage_Owner = 1
- ImportedMessage_MIKE ImportedMessage_Owner = 2
-)
-
-var ImportedMessage_Owner_name = map[int32]string{
- 1: "DAVE",
- 2: "MIKE",
-}
-var ImportedMessage_Owner_value = map[string]int32{
- "DAVE": 1,
- "MIKE": 2,
-}
-
-// NewImportedMessage_Owner is deprecated. Use x.Enum() instead.
-func NewImportedMessage_Owner(x ImportedMessage_Owner) *ImportedMessage_Owner {
- e := ImportedMessage_Owner(x)
- return &e
-}
-func (x ImportedMessage_Owner) Enum() *ImportedMessage_Owner {
- p := new(ImportedMessage_Owner)
- *p = x
- return p
-}
-func (x ImportedMessage_Owner) String() string {
- return proto.EnumName(ImportedMessage_Owner_name, int32(x))
-}
-
-type ImportedMessage struct {
- Field *int64 `protobuf:"varint,1,req,name=field" json:"field,omitempty"`
- XXX_extensions map[int32][]byte `json:",omitempty"`
- XXX_unrecognized []byte `json:",omitempty"`
-}
-
-func (this *ImportedMessage) Reset() { *this = ImportedMessage{} }
-func (this *ImportedMessage) String() string { return proto.CompactTextString(this) }
-
-var extRange_ImportedMessage = []proto.ExtensionRange{
- proto.ExtensionRange{90, 100},
-}
-
-func (*ImportedMessage) ExtensionRangeArray() []proto.ExtensionRange {
- return extRange_ImportedMessage
-}
-func (this *ImportedMessage) ExtensionMap() map[int32][]byte {
- if this.XXX_extensions == nil {
- this.XXX_extensions = make(map[int32][]byte)
- }
- return this.XXX_extensions
-}
-
-type ImportedExtendable struct {
- XXX_extensions map[int32][]byte `json:",omitempty"`
- XXX_unrecognized []byte `json:",omitempty"`
-}
-
-func (this *ImportedExtendable) Reset() { *this = ImportedExtendable{} }
-func (this *ImportedExtendable) String() string { return proto.CompactTextString(this) }
-
-func (this *ImportedExtendable) Marshal() ([]byte, error) {
- return proto.MarshalMessageSet(this.ExtensionMap())
-}
-func (this *ImportedExtendable) Unmarshal(buf []byte) error {
- return proto.UnmarshalMessageSet(buf, this.ExtensionMap())
-}
-// ensure ImportedExtendable satisfies proto.Marshaler and proto.Unmarshaler
-var _ proto.Marshaler = (*ImportedExtendable)(nil)
-var _ proto.Unmarshaler = (*ImportedExtendable)(nil)
-
-var extRange_ImportedExtendable = []proto.ExtensionRange{
- proto.ExtensionRange{100, 536870911},
-}
-
-func (*ImportedExtendable) ExtensionRangeArray() []proto.ExtensionRange {
- return extRange_ImportedExtendable
-}
-func (this *ImportedExtendable) ExtensionMap() map[int32][]byte {
- if this.XXX_extensions == nil {
- this.XXX_extensions = make(map[int32][]byte)
- }
- return this.XXX_extensions
-}
-
-func init() {
- proto.RegisterEnum("imp.ImportedMessage_Owner", ImportedMessage_Owner_name, ImportedMessage_Owner_value)
-}
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/imp.proto b/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/imp.proto
deleted file mode 100644
index 42f144e4..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/imp.proto
+++ /dev/null
@@ -1,65 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2010 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-syntax = "proto2";
-
-package imp;
-
-import "imp2.proto";
-import "imp3.proto";
-
-message ImportedMessage {
- required int64 field = 1;
-
- // The forwarded getters for these fields are fiddly to get right.
- optional ImportedMessage2 local_msg = 2;
- optional ForeignImportedMessage foreign_msg = 3; // in imp3.proto
- optional Owner enum_field = 4;
-
- repeated string name = 5;
- repeated Owner boss = 6;
- repeated ImportedMessage2 memo = 7;
-
- enum Owner {
- DAVE = 1;
- MIKE = 2;
- }
-
- extensions 90 to 100;
-}
-
-message ImportedMessage2 {
-}
-
-message ImportedExtendable {
- option message_set_wire_format = true;
- extensions 100 to max;
-}
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/imp2.proto b/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/imp2.proto
deleted file mode 100644
index 3bb0632b..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/imp2.proto
+++ /dev/null
@@ -1,43 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2011 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-syntax = "proto2";
-
-package imp;
-
-message PubliclyImportedMessage {
- optional int64 field = 1;
-}
-
-enum PubliclyImportedEnum {
- GLASSES = 1;
- HAIR = 2;
-}
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/imp3.proto b/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/imp3.proto
deleted file mode 100644
index 58fc7598..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/imp3.proto
+++ /dev/null
@@ -1,38 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2012 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-syntax = "proto2";
-
-package imp;
-
-message ForeignImportedMessage {
- optional string tuber = 1;
-}
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/main_test.go b/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/main_test.go
deleted file mode 100644
index 2f1711c5..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/main_test.go
+++ /dev/null
@@ -1,46 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2010 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-// A simple binary to link together the protocol buffers in this test.
-
-package testdata
-
-import (
- "testing"
-
- multipb "./multi"
- mytestpb "./my_test"
-)
-
-func TestLink(t *testing.T) {
- _ = &multipb.Multi1{}
- _ = &mytestpb.Request{}
-}
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/multi/multi1.proto b/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/multi/multi1.proto
deleted file mode 100644
index 0da6e0af..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/multi/multi1.proto
+++ /dev/null
@@ -1,44 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2010 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-syntax = "proto2";
-
-import "multi/multi2.proto";
-import "multi/multi3.proto";
-
-package multitest;
-
-message Multi1 {
- required Multi2 multi2 = 1;
- optional Multi2.Color color = 2;
- optional Multi3.HatType hat_type = 3;
-}
-
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/multi/multi2.proto b/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/multi/multi2.proto
deleted file mode 100644
index e6bfc71b..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/multi/multi2.proto
+++ /dev/null
@@ -1,46 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2010 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-syntax = "proto2";
-
-package multitest;
-
-message Multi2 {
- required int32 required_value = 1;
-
- enum Color {
- BLUE = 1;
- GREEN = 2;
- RED = 3;
- };
- optional Color color = 2;
-}
-
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/multi/multi3.proto b/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/multi/multi3.proto
deleted file mode 100644
index 146c255b..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/multi/multi3.proto
+++ /dev/null
@@ -1,43 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2010 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-syntax = "proto2";
-
-package multitest;
-
-message Multi3 {
- enum HatType {
- FEDORA = 1;
- FEZ = 2;
- };
- optional HatType hat_type = 1;
-}
-
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/my_test/test.pb.go.golden b/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/my_test/test.pb.go.golden
deleted file mode 100644
index 45004149..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/my_test/test.pb.go.golden
+++ /dev/null
@@ -1,487 +0,0 @@
-// Code generated by protoc-gen-go.
-// source: my_test/test.proto
-// DO NOT EDIT!
-
-/*
-Package my_test is a generated protocol buffer package.
-
-This package holds interesting messages.
-
-It is generated from these files:
- my_test/test.proto
-
-It has these top-level messages:
- Request
- Reply
- OtherBase
- ReplyExtensions
- OtherReplyExtensions
- OldReply
-*/
-package my_test
-
-import proto "github.com/golang/protobuf/proto"
-import math "math"
-
-// discarding unused import multitest2 "multi"
-
-// Reference imports to suppress errors if they are not otherwise used.
-var _ = proto.Marshal
-var _ = math.Inf
-
-type HatType int32
-
-const (
- // deliberately skipping 0
- HatType_FEDORA HatType = 1
- HatType_FEZ HatType = 2
-)
-
-var HatType_name = map[int32]string{
- 1: "FEDORA",
- 2: "FEZ",
-}
-var HatType_value = map[string]int32{
- "FEDORA": 1,
- "FEZ": 2,
-}
-
-func (x HatType) Enum() *HatType {
- p := new(HatType)
- *p = x
- return p
-}
-func (x HatType) String() string {
- return proto.EnumName(HatType_name, int32(x))
-}
-func (x *HatType) UnmarshalJSON(data []byte) error {
- value, err := proto.UnmarshalJSONEnum(HatType_value, data, "HatType")
- if err != nil {
- return err
- }
- *x = HatType(value)
- return nil
-}
-
-// This enum represents days of the week.
-type Days int32
-
-const (
- Days_MONDAY Days = 1
- Days_TUESDAY Days = 2
- Days_LUNDI Days = 1
-)
-
-var Days_name = map[int32]string{
- 1: "MONDAY",
- 2: "TUESDAY",
- // Duplicate value: 1: "LUNDI",
-}
-var Days_value = map[string]int32{
- "MONDAY": 1,
- "TUESDAY": 2,
- "LUNDI": 1,
-}
-
-func (x Days) Enum() *Days {
- p := new(Days)
- *p = x
- return p
-}
-func (x Days) String() string {
- return proto.EnumName(Days_name, int32(x))
-}
-func (x *Days) UnmarshalJSON(data []byte) error {
- value, err := proto.UnmarshalJSONEnum(Days_value, data, "Days")
- if err != nil {
- return err
- }
- *x = Days(value)
- return nil
-}
-
-type Request_Color int32
-
-const (
- Request_RED Request_Color = 0
- Request_GREEN Request_Color = 1
- Request_BLUE Request_Color = 2
-)
-
-var Request_Color_name = map[int32]string{
- 0: "RED",
- 1: "GREEN",
- 2: "BLUE",
-}
-var Request_Color_value = map[string]int32{
- "RED": 0,
- "GREEN": 1,
- "BLUE": 2,
-}
-
-func (x Request_Color) Enum() *Request_Color {
- p := new(Request_Color)
- *p = x
- return p
-}
-func (x Request_Color) String() string {
- return proto.EnumName(Request_Color_name, int32(x))
-}
-func (x *Request_Color) UnmarshalJSON(data []byte) error {
- value, err := proto.UnmarshalJSONEnum(Request_Color_value, data, "Request_Color")
- if err != nil {
- return err
- }
- *x = Request_Color(value)
- return nil
-}
-
-type Reply_Entry_Game int32
-
-const (
- Reply_Entry_FOOTBALL Reply_Entry_Game = 1
- Reply_Entry_TENNIS Reply_Entry_Game = 2
-)
-
-var Reply_Entry_Game_name = map[int32]string{
- 1: "FOOTBALL",
- 2: "TENNIS",
-}
-var Reply_Entry_Game_value = map[string]int32{
- "FOOTBALL": 1,
- "TENNIS": 2,
-}
-
-func (x Reply_Entry_Game) Enum() *Reply_Entry_Game {
- p := new(Reply_Entry_Game)
- *p = x
- return p
-}
-func (x Reply_Entry_Game) String() string {
- return proto.EnumName(Reply_Entry_Game_name, int32(x))
-}
-func (x *Reply_Entry_Game) UnmarshalJSON(data []byte) error {
- value, err := proto.UnmarshalJSONEnum(Reply_Entry_Game_value, data, "Reply_Entry_Game")
- if err != nil {
- return err
- }
- *x = Reply_Entry_Game(value)
- return nil
-}
-
-// This is a message that might be sent somewhere.
-type Request struct {
- Key []int64 `protobuf:"varint,1,rep,name=key" json:"key,omitempty"`
- // optional imp.ImportedMessage imported_message = 2;
- Hue *Request_Color `protobuf:"varint,3,opt,name=hue,enum=my.test.Request_Color" json:"hue,omitempty"`
- Hat *HatType `protobuf:"varint,4,opt,name=hat,enum=my.test.HatType,def=1" json:"hat,omitempty"`
- // optional imp.ImportedMessage.Owner owner = 6;
- Deadline *float32 `protobuf:"fixed32,7,opt,name=deadline,def=inf" json:"deadline,omitempty"`
- Somegroup *Request_SomeGroup `protobuf:"group,8,opt,name=SomeGroup" json:"somegroup,omitempty"`
- // This is a map field. It will generate map[int32]string.
- NameMapping map[int32]string `protobuf:"bytes,14,rep,name=name_mapping" json:"name_mapping,omitempty" protobuf_key:"varint,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
- // This is a map field whose value type is a message.
- MsgMapping map[int64]*Reply `protobuf:"bytes,15,rep,name=msg_mapping" json:"msg_mapping,omitempty" protobuf_key:"zigzag64,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
- Reset_ *int32 `protobuf:"varint,12,opt,name=reset" json:"reset,omitempty"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (m *Request) Reset() { *m = Request{} }
-func (m *Request) String() string { return proto.CompactTextString(m) }
-func (*Request) ProtoMessage() {}
-
-const Default_Request_Hat HatType = HatType_FEDORA
-
-var Default_Request_Deadline float32 = float32(math.Inf(1))
-
-func (m *Request) GetKey() []int64 {
- if m != nil {
- return m.Key
- }
- return nil
-}
-
-func (m *Request) GetHue() Request_Color {
- if m != nil && m.Hue != nil {
- return *m.Hue
- }
- return Request_RED
-}
-
-func (m *Request) GetHat() HatType {
- if m != nil && m.Hat != nil {
- return *m.Hat
- }
- return Default_Request_Hat
-}
-
-func (m *Request) GetDeadline() float32 {
- if m != nil && m.Deadline != nil {
- return *m.Deadline
- }
- return Default_Request_Deadline
-}
-
-func (m *Request) GetSomegroup() *Request_SomeGroup {
- if m != nil {
- return m.Somegroup
- }
- return nil
-}
-
-func (m *Request) GetNameMapping() map[int32]string {
- if m != nil {
- return m.NameMapping
- }
- return nil
-}
-
-func (m *Request) GetMsgMapping() map[int64]*Reply {
- if m != nil {
- return m.MsgMapping
- }
- return nil
-}
-
-func (m *Request) GetReset_() int32 {
- if m != nil && m.Reset_ != nil {
- return *m.Reset_
- }
- return 0
-}
-
-type Request_SomeGroup struct {
- GroupField *int32 `protobuf:"varint,9,opt,name=group_field" json:"group_field,omitempty"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (m *Request_SomeGroup) Reset() { *m = Request_SomeGroup{} }
-func (m *Request_SomeGroup) String() string { return proto.CompactTextString(m) }
-func (*Request_SomeGroup) ProtoMessage() {}
-
-func (m *Request_SomeGroup) GetGroupField() int32 {
- if m != nil && m.GroupField != nil {
- return *m.GroupField
- }
- return 0
-}
-
-type Reply struct {
- Found []*Reply_Entry `protobuf:"bytes,1,rep,name=found" json:"found,omitempty"`
- CompactKeys []int32 `protobuf:"varint,2,rep,packed,name=compact_keys" json:"compact_keys,omitempty"`
- XXX_extensions map[int32]proto.Extension `json:"-"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (m *Reply) Reset() { *m = Reply{} }
-func (m *Reply) String() string { return proto.CompactTextString(m) }
-func (*Reply) ProtoMessage() {}
-
-var extRange_Reply = []proto.ExtensionRange{
- {100, 536870911},
-}
-
-func (*Reply) ExtensionRangeArray() []proto.ExtensionRange {
- return extRange_Reply
-}
-func (m *Reply) ExtensionMap() map[int32]proto.Extension {
- if m.XXX_extensions == nil {
- m.XXX_extensions = make(map[int32]proto.Extension)
- }
- return m.XXX_extensions
-}
-
-func (m *Reply) GetFound() []*Reply_Entry {
- if m != nil {
- return m.Found
- }
- return nil
-}
-
-func (m *Reply) GetCompactKeys() []int32 {
- if m != nil {
- return m.CompactKeys
- }
- return nil
-}
-
-type Reply_Entry struct {
- KeyThatNeeds_1234Camel_CasIng *int64 `protobuf:"varint,1,req,name=key_that_needs_1234camel_CasIng" json:"key_that_needs_1234camel_CasIng,omitempty"`
- Value *int64 `protobuf:"varint,2,opt,name=value,def=7" json:"value,omitempty"`
- XMyFieldName_2 *int64 `protobuf:"varint,3,opt,name=_my_field_name_2" json:"_my_field_name_2,omitempty"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (m *Reply_Entry) Reset() { *m = Reply_Entry{} }
-func (m *Reply_Entry) String() string { return proto.CompactTextString(m) }
-func (*Reply_Entry) ProtoMessage() {}
-
-const Default_Reply_Entry_Value int64 = 7
-
-func (m *Reply_Entry) GetKeyThatNeeds_1234Camel_CasIng() int64 {
- if m != nil && m.KeyThatNeeds_1234Camel_CasIng != nil {
- return *m.KeyThatNeeds_1234Camel_CasIng
- }
- return 0
-}
-
-func (m *Reply_Entry) GetValue() int64 {
- if m != nil && m.Value != nil {
- return *m.Value
- }
- return Default_Reply_Entry_Value
-}
-
-func (m *Reply_Entry) GetXMyFieldName_2() int64 {
- if m != nil && m.XMyFieldName_2 != nil {
- return *m.XMyFieldName_2
- }
- return 0
-}
-
-type OtherBase struct {
- Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
- XXX_extensions map[int32]proto.Extension `json:"-"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (m *OtherBase) Reset() { *m = OtherBase{} }
-func (m *OtherBase) String() string { return proto.CompactTextString(m) }
-func (*OtherBase) ProtoMessage() {}
-
-var extRange_OtherBase = []proto.ExtensionRange{
- {100, 536870911},
-}
-
-func (*OtherBase) ExtensionRangeArray() []proto.ExtensionRange {
- return extRange_OtherBase
-}
-func (m *OtherBase) ExtensionMap() map[int32]proto.Extension {
- if m.XXX_extensions == nil {
- m.XXX_extensions = make(map[int32]proto.Extension)
- }
- return m.XXX_extensions
-}
-
-func (m *OtherBase) GetName() string {
- if m != nil && m.Name != nil {
- return *m.Name
- }
- return ""
-}
-
-type ReplyExtensions struct {
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (m *ReplyExtensions) Reset() { *m = ReplyExtensions{} }
-func (m *ReplyExtensions) String() string { return proto.CompactTextString(m) }
-func (*ReplyExtensions) ProtoMessage() {}
-
-var E_ReplyExtensions_Time = &proto.ExtensionDesc{
- ExtendedType: (*Reply)(nil),
- ExtensionType: (*float64)(nil),
- Field: 101,
- Name: "my.test.ReplyExtensions.time",
- Tag: "fixed64,101,opt,name=time",
-}
-
-var E_ReplyExtensions_Carrot = &proto.ExtensionDesc{
- ExtendedType: (*Reply)(nil),
- ExtensionType: (*ReplyExtensions)(nil),
- Field: 105,
- Name: "my.test.ReplyExtensions.carrot",
- Tag: "bytes,105,opt,name=carrot",
-}
-
-var E_ReplyExtensions_Donut = &proto.ExtensionDesc{
- ExtendedType: (*OtherBase)(nil),
- ExtensionType: (*ReplyExtensions)(nil),
- Field: 101,
- Name: "my.test.ReplyExtensions.donut",
- Tag: "bytes,101,opt,name=donut",
-}
-
-type OtherReplyExtensions struct {
- Key *int32 `protobuf:"varint,1,opt,name=key" json:"key,omitempty"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (m *OtherReplyExtensions) Reset() { *m = OtherReplyExtensions{} }
-func (m *OtherReplyExtensions) String() string { return proto.CompactTextString(m) }
-func (*OtherReplyExtensions) ProtoMessage() {}
-
-func (m *OtherReplyExtensions) GetKey() int32 {
- if m != nil && m.Key != nil {
- return *m.Key
- }
- return 0
-}
-
-type OldReply struct {
- XXX_extensions map[int32]proto.Extension `json:"-"`
- XXX_unrecognized []byte `json:"-"`
-}
-
-func (m *OldReply) Reset() { *m = OldReply{} }
-func (m *OldReply) String() string { return proto.CompactTextString(m) }
-func (*OldReply) ProtoMessage() {}
-
-func (m *OldReply) Marshal() ([]byte, error) {
- return proto.MarshalMessageSet(m.ExtensionMap())
-}
-func (m *OldReply) Unmarshal(buf []byte) error {
- return proto.UnmarshalMessageSet(buf, m.ExtensionMap())
-}
-func (m *OldReply) MarshalJSON() ([]byte, error) {
- return proto.MarshalMessageSetJSON(m.XXX_extensions)
-}
-func (m *OldReply) UnmarshalJSON(buf []byte) error {
- return proto.UnmarshalMessageSetJSON(buf, m.XXX_extensions)
-}
-
-// ensure OldReply satisfies proto.Marshaler and proto.Unmarshaler
-var _ proto.Marshaler = (*OldReply)(nil)
-var _ proto.Unmarshaler = (*OldReply)(nil)
-
-var extRange_OldReply = []proto.ExtensionRange{
- {100, 2147483646},
-}
-
-func (*OldReply) ExtensionRangeArray() []proto.ExtensionRange {
- return extRange_OldReply
-}
-func (m *OldReply) ExtensionMap() map[int32]proto.Extension {
- if m.XXX_extensions == nil {
- m.XXX_extensions = make(map[int32]proto.Extension)
- }
- return m.XXX_extensions
-}
-
-var E_Tag = &proto.ExtensionDesc{
- ExtendedType: (*Reply)(nil),
- ExtensionType: (*string)(nil),
- Field: 103,
- Name: "my.test.tag",
- Tag: "bytes,103,opt,name=tag",
-}
-
-var E_Donut = &proto.ExtensionDesc{
- ExtendedType: (*Reply)(nil),
- ExtensionType: (*OtherReplyExtensions)(nil),
- Field: 106,
- Name: "my.test.donut",
- Tag: "bytes,106,opt,name=donut",
-}
-
-func init() {
- proto.RegisterEnum("my.test.HatType", HatType_name, HatType_value)
- proto.RegisterEnum("my.test.Days", Days_name, Days_value)
- proto.RegisterEnum("my.test.Request_Color", Request_Color_name, Request_Color_value)
- proto.RegisterEnum("my.test.Reply_Entry_Game", Reply_Entry_Game_name, Reply_Entry_Game_value)
- proto.RegisterExtension(E_ReplyExtensions_Time)
- proto.RegisterExtension(E_ReplyExtensions_Carrot)
- proto.RegisterExtension(E_ReplyExtensions_Donut)
- proto.RegisterExtension(E_Tag)
- proto.RegisterExtension(E_Donut)
-}
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/my_test/test.proto b/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/my_test/test.proto
deleted file mode 100644
index 975520f2..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/my_test/test.proto
+++ /dev/null
@@ -1,132 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2010 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-syntax = "proto2";
-
-// This package holds interesting messages.
-package my.test; // dotted package name
-
-//import "imp.proto";
-import "multi/multi1.proto"; // unused import
-
-enum HatType {
- // deliberately skipping 0
- FEDORA = 1;
- FEZ = 2;
-}
-
-// This enum represents days of the week.
-enum Days {
- option allow_alias = true;
-
- MONDAY = 1;
- TUESDAY = 2;
- LUNDI = 1; // same value as MONDAY
-}
-
-// This is a message that might be sent somewhere.
-message Request {
- enum Color {
- RED = 0;
- GREEN = 1;
- BLUE = 2;
- }
- repeated int64 key = 1;
-// optional imp.ImportedMessage imported_message = 2;
- optional Color hue = 3; // no default
- optional HatType hat = 4 [default=FEDORA];
-// optional imp.ImportedMessage.Owner owner = 6;
- optional float deadline = 7 [default=inf];
- optional group SomeGroup = 8 {
- optional int32 group_field = 9;
- }
-
- // These foreign types are in imp2.proto,
- // which is publicly imported by imp.proto.
-// optional imp.PubliclyImportedMessage pub = 10;
-// optional imp.PubliclyImportedEnum pub_enum = 13 [default=HAIR];
-
-
- // This is a map field. It will generate map[int32]string.
- map name_mapping = 14;
- // This is a map field whose value type is a message.
- map msg_mapping = 15;
-
- optional int32 reset = 12;
-}
-
-message Reply {
- message Entry {
- required int64 key_that_needs_1234camel_CasIng = 1;
- optional int64 value = 2 [default=7];
- optional int64 _my_field_name_2 = 3;
- enum Game {
- FOOTBALL = 1;
- TENNIS = 2;
- }
- }
- repeated Entry found = 1;
- repeated int32 compact_keys = 2 [packed=true];
- extensions 100 to max;
-}
-
-message OtherBase {
- optional string name = 1;
- extensions 100 to max;
-}
-
-message ReplyExtensions {
- extend Reply {
- optional double time = 101;
- optional ReplyExtensions carrot = 105;
- }
- extend OtherBase {
- optional ReplyExtensions donut = 101;
- }
-}
-
-message OtherReplyExtensions {
- optional int32 key = 1;
-}
-
-// top-level extension
-extend Reply {
- optional string tag = 103;
- optional OtherReplyExtensions donut = 106;
-// optional imp.ImportedMessage elephant = 107; // extend with message from another file.
-}
-
-message OldReply {
- // Extensions will be encoded in MessageSet wire format.
- option message_set_wire_format = true;
- extensions 100 to max;
-}
-
diff --git a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/proto3.proto b/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/proto3.proto
deleted file mode 100644
index c994914e..00000000
--- a/vendor/github.com/golang/protobuf/protoc-gen-go/testdata/proto3.proto
+++ /dev/null
@@ -1,52 +0,0 @@
-// Go support for Protocol Buffers - Google's data interchange format
-//
-// Copyright 2014 The Go Authors. All rights reserved.
-// https://github.com/golang/protobuf
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-syntax = "proto3";
-
-package proto3;
-
-message Request {
- enum Flavour {
- SWEET = 0;
- SOUR = 1;
- UMAMI = 2;
- GOPHERLICIOUS = 3;
- }
- string name = 1;
- repeated int64 key = 2;
- Flavour taste = 3;
- Book book = 4;
-}
-
-message Book {
- string title = 1;
- bytes raw_data = 2;
-}
diff --git a/vendor/github.com/gorilla/context/context_test.go b/vendor/github.com/gorilla/context/context_test.go
deleted file mode 100644
index 6ada8ec3..00000000
--- a/vendor/github.com/gorilla/context/context_test.go
+++ /dev/null
@@ -1,161 +0,0 @@
-// Copyright 2012 The Gorilla Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package context
-
-import (
- "net/http"
- "testing"
-)
-
-type keyType int
-
-const (
- key1 keyType = iota
- key2
-)
-
-func TestContext(t *testing.T) {
- assertEqual := func(val interface{}, exp interface{}) {
- if val != exp {
- t.Errorf("Expected %v, got %v.", exp, val)
- }
- }
-
- r, _ := http.NewRequest("GET", "http://localhost:8080/", nil)
- emptyR, _ := http.NewRequest("GET", "http://localhost:8080/", nil)
-
- // Get()
- assertEqual(Get(r, key1), nil)
-
- // Set()
- Set(r, key1, "1")
- assertEqual(Get(r, key1), "1")
- assertEqual(len(data[r]), 1)
-
- Set(r, key2, "2")
- assertEqual(Get(r, key2), "2")
- assertEqual(len(data[r]), 2)
-
- //GetOk
- value, ok := GetOk(r, key1)
- assertEqual(value, "1")
- assertEqual(ok, true)
-
- value, ok = GetOk(r, "not exists")
- assertEqual(value, nil)
- assertEqual(ok, false)
-
- Set(r, "nil value", nil)
- value, ok = GetOk(r, "nil value")
- assertEqual(value, nil)
- assertEqual(ok, true)
-
- // GetAll()
- values := GetAll(r)
- assertEqual(len(values), 3)
-
- // GetAll() for empty request
- values = GetAll(emptyR)
- if values != nil {
- t.Error("GetAll didn't return nil value for invalid request")
- }
-
- // GetAllOk()
- values, ok = GetAllOk(r)
- assertEqual(len(values), 3)
- assertEqual(ok, true)
-
- // GetAllOk() for empty request
- values, ok = GetAllOk(emptyR)
- assertEqual(value, nil)
- assertEqual(ok, false)
-
- // Delete()
- Delete(r, key1)
- assertEqual(Get(r, key1), nil)
- assertEqual(len(data[r]), 2)
-
- Delete(r, key2)
- assertEqual(Get(r, key2), nil)
- assertEqual(len(data[r]), 1)
-
- // Clear()
- Clear(r)
- assertEqual(len(data), 0)
-}
-
-func parallelReader(r *http.Request, key string, iterations int, wait, done chan struct{}) {
- <-wait
- for i := 0; i < iterations; i++ {
- Get(r, key)
- }
- done <- struct{}{}
-
-}
-
-func parallelWriter(r *http.Request, key, value string, iterations int, wait, done chan struct{}) {
- <-wait
- for i := 0; i < iterations; i++ {
- Get(r, key)
- }
- done <- struct{}{}
-
-}
-
-func benchmarkMutex(b *testing.B, numReaders, numWriters, iterations int) {
-
- b.StopTimer()
- r, _ := http.NewRequest("GET", "http://localhost:8080/", nil)
- done := make(chan struct{})
- b.StartTimer()
-
- for i := 0; i < b.N; i++ {
- wait := make(chan struct{})
-
- for i := 0; i < numReaders; i++ {
- go parallelReader(r, "test", iterations, wait, done)
- }
-
- for i := 0; i < numWriters; i++ {
- go parallelWriter(r, "test", "123", iterations, wait, done)
- }
-
- close(wait)
-
- for i := 0; i < numReaders+numWriters; i++ {
- <-done
- }
-
- }
-
-}
-
-func BenchmarkMutexSameReadWrite1(b *testing.B) {
- benchmarkMutex(b, 1, 1, 32)
-}
-func BenchmarkMutexSameReadWrite2(b *testing.B) {
- benchmarkMutex(b, 2, 2, 32)
-}
-func BenchmarkMutexSameReadWrite4(b *testing.B) {
- benchmarkMutex(b, 4, 4, 32)
-}
-func BenchmarkMutex1(b *testing.B) {
- benchmarkMutex(b, 2, 8, 32)
-}
-func BenchmarkMutex2(b *testing.B) {
- benchmarkMutex(b, 16, 4, 64)
-}
-func BenchmarkMutex3(b *testing.B) {
- benchmarkMutex(b, 1, 2, 128)
-}
-func BenchmarkMutex4(b *testing.B) {
- benchmarkMutex(b, 128, 32, 256)
-}
-func BenchmarkMutex5(b *testing.B) {
- benchmarkMutex(b, 1024, 2048, 64)
-}
-func BenchmarkMutex6(b *testing.B) {
- benchmarkMutex(b, 2048, 1024, 512)
-}
diff --git a/vendor/github.com/gorilla/handlers/compress_test.go b/vendor/github.com/gorilla/handlers/compress_test.go
deleted file mode 100644
index 2661b399..00000000
--- a/vendor/github.com/gorilla/handlers/compress_test.go
+++ /dev/null
@@ -1,65 +0,0 @@
-// Copyright 2013 The Gorilla Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package handlers
-
-import (
- "io"
- "net/http"
- "net/http/httptest"
- "testing"
-)
-
-func compressedRequest(w *httptest.ResponseRecorder, compression string) {
- CompressHandler(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
- for i := 0; i < 1024; i++ {
- io.WriteString(w, "Gorilla!\n")
- }
- })).ServeHTTP(w, &http.Request{
- Method: "GET",
- Header: http.Header{
- "Accept-Encoding": []string{compression},
- },
- })
-
-}
-
-func TestCompressHandlerGzip(t *testing.T) {
- w := httptest.NewRecorder()
- compressedRequest(w, "gzip")
- if w.HeaderMap.Get("Content-Encoding") != "gzip" {
- t.Fatalf("wrong content encoding, got %d want %d", w.HeaderMap.Get("Content-Encoding"), "gzip")
- }
- if w.HeaderMap.Get("Content-Type") != "text/plain; charset=utf-8" {
- t.Fatalf("wrong content type, got %s want %s", w.HeaderMap.Get("Content-Type"), "text/plain; charset=utf-8")
- }
- if w.Body.Len() != 72 {
- t.Fatalf("wrong len, got %d want %d", w.Body.Len(), 72)
- }
-}
-
-func TestCompressHandlerDeflate(t *testing.T) {
- w := httptest.NewRecorder()
- compressedRequest(w, "deflate")
- if w.HeaderMap.Get("Content-Encoding") != "deflate" {
- t.Fatalf("wrong content encoding, got %d want %d", w.HeaderMap.Get("Content-Encoding"), "deflate")
- }
- if w.HeaderMap.Get("Content-Type") != "text/plain; charset=utf-8" {
- t.Fatalf("wrong content type, got %s want %s", w.HeaderMap.Get("Content-Type"), "text/plain; charset=utf-8")
- }
- if w.Body.Len() != 54 {
- t.Fatalf("wrong len, got %d want %d", w.Body.Len(), 54)
- }
-}
-
-func TestCompressHandlerGzipDeflate(t *testing.T) {
- w := httptest.NewRecorder()
- compressedRequest(w, "gzip, deflate ")
- if w.HeaderMap.Get("Content-Encoding") != "gzip" {
- t.Fatalf("wrong content encoding, got %s want %s", w.HeaderMap.Get("Content-Encoding"), "gzip")
- }
- if w.HeaderMap.Get("Content-Type") != "text/plain; charset=utf-8" {
- t.Fatalf("wrong content type, got %s want %s", w.HeaderMap.Get("Content-Type"), "text/plain; charset=utf-8")
- }
-}
diff --git a/vendor/github.com/gorilla/handlers/handlers_test.go b/vendor/github.com/gorilla/handlers/handlers_test.go
deleted file mode 100644
index 94eeb035..00000000
--- a/vendor/github.com/gorilla/handlers/handlers_test.go
+++ /dev/null
@@ -1,305 +0,0 @@
-// Copyright 2013 The Gorilla Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package handlers
-
-import (
- "bytes"
- "net"
- "net/http"
- "net/http/httptest"
- "net/url"
- "strings"
- "testing"
- "time"
-)
-
-const (
- ok = "ok\n"
- notAllowed = "Method not allowed\n"
-)
-
-var okHandler = http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
- w.Write([]byte(ok))
-})
-
-func newRequest(method, url string) *http.Request {
- req, err := http.NewRequest(method, url, nil)
- if err != nil {
- panic(err)
- }
- return req
-}
-
-func TestMethodHandler(t *testing.T) {
- tests := []struct {
- req *http.Request
- handler http.Handler
- code int
- allow string // Contents of the Allow header
- body string
- }{
- // No handlers
- {newRequest("GET", "/foo"), MethodHandler{}, http.StatusMethodNotAllowed, "", notAllowed},
- {newRequest("OPTIONS", "/foo"), MethodHandler{}, http.StatusOK, "", ""},
-
- // A single handler
- {newRequest("GET", "/foo"), MethodHandler{"GET": okHandler}, http.StatusOK, "", ok},
- {newRequest("POST", "/foo"), MethodHandler{"GET": okHandler}, http.StatusMethodNotAllowed, "GET", notAllowed},
-
- // Multiple handlers
- {newRequest("GET", "/foo"), MethodHandler{"GET": okHandler, "POST": okHandler}, http.StatusOK, "", ok},
- {newRequest("POST", "/foo"), MethodHandler{"GET": okHandler, "POST": okHandler}, http.StatusOK, "", ok},
- {newRequest("DELETE", "/foo"), MethodHandler{"GET": okHandler, "POST": okHandler}, http.StatusMethodNotAllowed, "GET, POST", notAllowed},
- {newRequest("OPTIONS", "/foo"), MethodHandler{"GET": okHandler, "POST": okHandler}, http.StatusOK, "GET, POST", ""},
-
- // Override OPTIONS
- {newRequest("OPTIONS", "/foo"), MethodHandler{"OPTIONS": okHandler}, http.StatusOK, "", ok},
- }
-
- for i, test := range tests {
- rec := httptest.NewRecorder()
- test.handler.ServeHTTP(rec, test.req)
- if rec.Code != test.code {
- t.Fatalf("%d: wrong code, got %d want %d", i, rec.Code, test.code)
- }
- if allow := rec.HeaderMap.Get("Allow"); allow != test.allow {
- t.Fatalf("%d: wrong Allow, got %s want %s", i, allow, test.allow)
- }
- if body := rec.Body.String(); body != test.body {
- t.Fatalf("%d: wrong body, got %q want %q", i, body, test.body)
- }
- }
-}
-
-func TestWriteLog(t *testing.T) {
- loc, err := time.LoadLocation("Europe/Warsaw")
- if err != nil {
- panic(err)
- }
- ts := time.Date(1983, 05, 26, 3, 30, 45, 0, loc)
-
- // A typical request with an OK response
- req := newRequest("GET", "http://example.com")
- req.RemoteAddr = "192.168.100.5"
-
- buf := new(bytes.Buffer)
- writeLog(buf, req, *req.URL, ts, http.StatusOK, 100)
- log := buf.String()
-
- expected := "192.168.100.5 - - [26/May/1983:03:30:45 +0200] \"GET / HTTP/1.1\" 200 100\n"
- if log != expected {
- t.Fatalf("wrong log, got %q want %q", log, expected)
- }
-
- // Request with an unauthorized user
- req = newRequest("GET", "http://example.com")
- req.RemoteAddr = "192.168.100.5"
- req.URL.User = url.User("kamil")
-
- buf.Reset()
- writeLog(buf, req, *req.URL, ts, http.StatusUnauthorized, 500)
- log = buf.String()
-
- expected = "192.168.100.5 - kamil [26/May/1983:03:30:45 +0200] \"GET / HTTP/1.1\" 401 500\n"
- if log != expected {
- t.Fatalf("wrong log, got %q want %q", log, expected)
- }
-
- // Request with url encoded parameters
- req = newRequest("GET", "http://example.com/test?abc=hello%20world&a=b%3F")
- req.RemoteAddr = "192.168.100.5"
-
- buf.Reset()
- writeLog(buf, req, *req.URL, ts, http.StatusOK, 100)
- log = buf.String()
-
- expected = "192.168.100.5 - - [26/May/1983:03:30:45 +0200] \"GET /test?abc=hello%20world&a=b%3F HTTP/1.1\" 200 100\n"
- if log != expected {
- t.Fatalf("wrong log, got %q want %q", log, expected)
- }
-}
-
-func TestWriteCombinedLog(t *testing.T) {
- loc, err := time.LoadLocation("Europe/Warsaw")
- if err != nil {
- panic(err)
- }
- ts := time.Date(1983, 05, 26, 3, 30, 45, 0, loc)
-
- // A typical request with an OK response
- req := newRequest("GET", "http://example.com")
- req.RemoteAddr = "192.168.100.5"
- req.Header.Set("Referer", "http://example.com")
- req.Header.Set(
- "User-Agent",
- "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_2) AppleWebKit/537.33 "+
- "(KHTML, like Gecko) Chrome/27.0.1430.0 Safari/537.33",
- )
-
- buf := new(bytes.Buffer)
- writeCombinedLog(buf, req, *req.URL, ts, http.StatusOK, 100)
- log := buf.String()
-
- expected := "192.168.100.5 - - [26/May/1983:03:30:45 +0200] \"GET / HTTP/1.1\" 200 100 \"http://example.com\" " +
- "\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_2) " +
- "AppleWebKit/537.33 (KHTML, like Gecko) Chrome/27.0.1430.0 Safari/537.33\"\n"
- if log != expected {
- t.Fatalf("wrong log, got %q want %q", log, expected)
- }
-
- // Request with an unauthorized user
- req.URL.User = url.User("kamil")
-
- buf.Reset()
- writeCombinedLog(buf, req, *req.URL, ts, http.StatusUnauthorized, 500)
- log = buf.String()
-
- expected = "192.168.100.5 - kamil [26/May/1983:03:30:45 +0200] \"GET / HTTP/1.1\" 401 500 \"http://example.com\" " +
- "\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_2) " +
- "AppleWebKit/537.33 (KHTML, like Gecko) Chrome/27.0.1430.0 Safari/537.33\"\n"
- if log != expected {
- t.Fatalf("wrong log, got %q want %q", log, expected)
- }
-
- // Test with remote ipv6 address
- req.RemoteAddr = "::1"
-
- buf.Reset()
- writeCombinedLog(buf, req, *req.URL, ts, http.StatusOK, 100)
- log = buf.String()
-
- expected = "::1 - kamil [26/May/1983:03:30:45 +0200] \"GET / HTTP/1.1\" 200 100 \"http://example.com\" " +
- "\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_2) " +
- "AppleWebKit/537.33 (KHTML, like Gecko) Chrome/27.0.1430.0 Safari/537.33\"\n"
- if log != expected {
- t.Fatalf("wrong log, got %q want %q", log, expected)
- }
-
- // Test remote ipv6 addr, with port
- req.RemoteAddr = net.JoinHostPort("::1", "65000")
-
- buf.Reset()
- writeCombinedLog(buf, req, *req.URL, ts, http.StatusOK, 100)
- log = buf.String()
-
- expected = "::1 - kamil [26/May/1983:03:30:45 +0200] \"GET / HTTP/1.1\" 200 100 \"http://example.com\" " +
- "\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_2) " +
- "AppleWebKit/537.33 (KHTML, like Gecko) Chrome/27.0.1430.0 Safari/537.33\"\n"
- if log != expected {
- t.Fatalf("wrong log, got %q want %q", log, expected)
- }
-}
-
-func TestLogPathRewrites(t *testing.T) {
- var buf bytes.Buffer
-
- handler := http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
- req.URL.Path = "/" // simulate http.StripPrefix and friends
- w.WriteHeader(200)
- })
- logger := LoggingHandler(&buf, handler)
-
- logger.ServeHTTP(httptest.NewRecorder(), newRequest("GET", "/subdir/asdf"))
-
- if !strings.Contains(buf.String(), "GET /subdir/asdf HTTP") {
- t.Fatalf("Got log %#v, wanted substring %#v", buf.String(), "GET /subdir/asdf HTTP")
- }
-}
-
-func BenchmarkWriteLog(b *testing.B) {
- loc, err := time.LoadLocation("Europe/Warsaw")
- if err != nil {
- b.Fatalf(err.Error())
- }
- ts := time.Date(1983, 05, 26, 3, 30, 45, 0, loc)
-
- req := newRequest("GET", "http://example.com")
- req.RemoteAddr = "192.168.100.5"
-
- b.ResetTimer()
-
- buf := &bytes.Buffer{}
- for i := 0; i < b.N; i++ {
- buf.Reset()
- writeLog(buf, req, *req.URL, ts, http.StatusUnauthorized, 500)
- }
-}
-
-func TestContentTypeHandler(t *testing.T) {
- tests := []struct {
- Method string
- AllowContentTypes []string
- ContentType string
- Code int
- }{
- {"POST", []string{"application/json"}, "application/json", http.StatusOK},
- {"POST", []string{"application/json", "application/xml"}, "application/json", http.StatusOK},
- {"POST", []string{"application/json"}, "application/json; charset=utf-8", http.StatusOK},
- {"POST", []string{"application/json"}, "application/json+xxx", http.StatusUnsupportedMediaType},
- {"POST", []string{"application/json"}, "text/plain", http.StatusUnsupportedMediaType},
- {"GET", []string{"application/json"}, "", http.StatusOK},
- {"GET", []string{}, "", http.StatusOK},
- }
- for _, test := range tests {
- r, err := http.NewRequest(test.Method, "/", nil)
- if err != nil {
- t.Error(err)
- continue
- }
-
- h := ContentTypeHandler(okHandler, test.AllowContentTypes...)
- r.Header.Set("Content-Type", test.ContentType)
- w := httptest.NewRecorder()
- h.ServeHTTP(w, r)
- if w.Code != test.Code {
- t.Errorf("expected %d, got %d", test.Code, w.Code)
- }
- }
-}
-
-func TestHTTPMethodOverride(t *testing.T) {
- var tests = []struct {
- Method string
- OverrideMethod string
- ExpectedMethod string
- }{
- {"POST", "PUT", "PUT"},
- {"POST", "PATCH", "PATCH"},
- {"POST", "DELETE", "DELETE"},
- {"PUT", "DELETE", "PUT"},
- {"GET", "GET", "GET"},
- {"HEAD", "HEAD", "HEAD"},
- {"GET", "PUT", "GET"},
- {"HEAD", "DELETE", "HEAD"},
- }
-
- for _, test := range tests {
- h := HTTPMethodOverrideHandler(okHandler)
- reqs := make([]*http.Request, 0, 2)
-
- rHeader, err := http.NewRequest(test.Method, "/", nil)
- if err != nil {
- t.Error(err)
- }
- rHeader.Header.Set(HTTPMethodOverrideHeader, test.OverrideMethod)
- reqs = append(reqs, rHeader)
-
- f := url.Values{HTTPMethodOverrideFormKey: []string{test.OverrideMethod}}
- rForm, err := http.NewRequest(test.Method, "/", strings.NewReader(f.Encode()))
- if err != nil {
- t.Error(err)
- }
- rForm.Header.Set("Content-Type", "application/x-www-form-urlencoded")
- reqs = append(reqs, rForm)
-
- for _, r := range reqs {
- w := httptest.NewRecorder()
- h.ServeHTTP(w, r)
- if r.Method != test.ExpectedMethod {
- t.Errorf("Expected %s, got %s", test.ExpectedMethod, r.Method)
- }
- }
- }
-}
diff --git a/vendor/github.com/gorilla/mux/bench_test.go b/vendor/github.com/gorilla/mux/bench_test.go
deleted file mode 100644
index c5f97b2b..00000000
--- a/vendor/github.com/gorilla/mux/bench_test.go
+++ /dev/null
@@ -1,21 +0,0 @@
-// Copyright 2012 The Gorilla Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package mux
-
-import (
- "net/http"
- "testing"
-)
-
-func BenchmarkMux(b *testing.B) {
- router := new(Router)
- handler := func(w http.ResponseWriter, r *http.Request) {}
- router.HandleFunc("/v1/{v1}", handler)
-
- request, _ := http.NewRequest("GET", "/v1/anything", nil)
- for i := 0; i < b.N; i++ {
- router.ServeHTTP(nil, request)
- }
-}
diff --git a/vendor/github.com/gorilla/mux/mux_test.go b/vendor/github.com/gorilla/mux/mux_test.go
deleted file mode 100644
index e455bce8..00000000
--- a/vendor/github.com/gorilla/mux/mux_test.go
+++ /dev/null
@@ -1,943 +0,0 @@
-// Copyright 2012 The Gorilla Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package mux
-
-import (
- "fmt"
- "net/http"
- "testing"
-
- "github.com/gorilla/context"
-)
-
-type routeTest struct {
- title string // title of the test
- route *Route // the route being tested
- request *http.Request // a request to test the route
- vars map[string]string // the expected vars of the match
- host string // the expected host of the match
- path string // the expected path of the match
- shouldMatch bool // whether the request is expected to match the route at all
- shouldRedirect bool // whether the request should result in a redirect
-}
-
-func TestHost(t *testing.T) {
- // newRequestHost a new request with a method, url, and host header
- newRequestHost := func(method, url, host string) *http.Request {
- req, err := http.NewRequest(method, url, nil)
- if err != nil {
- panic(err)
- }
- req.Host = host
- return req
- }
-
- tests := []routeTest{
- {
- title: "Host route match",
- route: new(Route).Host("aaa.bbb.ccc"),
- request: newRequest("GET", "http://aaa.bbb.ccc/111/222/333"),
- vars: map[string]string{},
- host: "aaa.bbb.ccc",
- path: "",
- shouldMatch: true,
- },
- {
- title: "Host route, wrong host in request URL",
- route: new(Route).Host("aaa.bbb.ccc"),
- request: newRequest("GET", "http://aaa.222.ccc/111/222/333"),
- vars: map[string]string{},
- host: "aaa.bbb.ccc",
- path: "",
- shouldMatch: false,
- },
- {
- title: "Host route with port, match",
- route: new(Route).Host("aaa.bbb.ccc:1234"),
- request: newRequest("GET", "http://aaa.bbb.ccc:1234/111/222/333"),
- vars: map[string]string{},
- host: "aaa.bbb.ccc:1234",
- path: "",
- shouldMatch: true,
- },
- {
- title: "Host route with port, wrong port in request URL",
- route: new(Route).Host("aaa.bbb.ccc:1234"),
- request: newRequest("GET", "http://aaa.bbb.ccc:9999/111/222/333"),
- vars: map[string]string{},
- host: "aaa.bbb.ccc:1234",
- path: "",
- shouldMatch: false,
- },
- {
- title: "Host route, match with host in request header",
- route: new(Route).Host("aaa.bbb.ccc"),
- request: newRequestHost("GET", "/111/222/333", "aaa.bbb.ccc"),
- vars: map[string]string{},
- host: "aaa.bbb.ccc",
- path: "",
- shouldMatch: true,
- },
- {
- title: "Host route, wrong host in request header",
- route: new(Route).Host("aaa.bbb.ccc"),
- request: newRequestHost("GET", "/111/222/333", "aaa.222.ccc"),
- vars: map[string]string{},
- host: "aaa.bbb.ccc",
- path: "",
- shouldMatch: false,
- },
- // BUG {new(Route).Host("aaa.bbb.ccc:1234"), newRequestHost("GET", "/111/222/333", "aaa.bbb.ccc:1234"), map[string]string{}, "aaa.bbb.ccc:1234", "", true},
- {
- title: "Host route with port, wrong host in request header",
- route: new(Route).Host("aaa.bbb.ccc:1234"),
- request: newRequestHost("GET", "/111/222/333", "aaa.bbb.ccc:9999"),
- vars: map[string]string{},
- host: "aaa.bbb.ccc:1234",
- path: "",
- shouldMatch: false,
- },
- {
- title: "Host route with pattern, match",
- route: new(Route).Host("aaa.{v1:[a-z]{3}}.ccc"),
- request: newRequest("GET", "http://aaa.bbb.ccc/111/222/333"),
- vars: map[string]string{"v1": "bbb"},
- host: "aaa.bbb.ccc",
- path: "",
- shouldMatch: true,
- },
- {
- title: "Host route with pattern, wrong host in request URL",
- route: new(Route).Host("aaa.{v1:[a-z]{3}}.ccc"),
- request: newRequest("GET", "http://aaa.222.ccc/111/222/333"),
- vars: map[string]string{"v1": "bbb"},
- host: "aaa.bbb.ccc",
- path: "",
- shouldMatch: false,
- },
- {
- title: "Host route with multiple patterns, match",
- route: new(Route).Host("{v1:[a-z]{3}}.{v2:[a-z]{3}}.{v3:[a-z]{3}}"),
- request: newRequest("GET", "http://aaa.bbb.ccc/111/222/333"),
- vars: map[string]string{"v1": "aaa", "v2": "bbb", "v3": "ccc"},
- host: "aaa.bbb.ccc",
- path: "",
- shouldMatch: true,
- },
- {
- title: "Host route with multiple patterns, wrong host in request URL",
- route: new(Route).Host("{v1:[a-z]{3}}.{v2:[a-z]{3}}.{v3:[a-z]{3}}"),
- request: newRequest("GET", "http://aaa.222.ccc/111/222/333"),
- vars: map[string]string{"v1": "aaa", "v2": "bbb", "v3": "ccc"},
- host: "aaa.bbb.ccc",
- path: "",
- shouldMatch: false,
- },
- }
- for _, test := range tests {
- testRoute(t, test)
- }
-}
-
-func TestPath(t *testing.T) {
- tests := []routeTest{
- {
- title: "Path route, match",
- route: new(Route).Path("/111/222/333"),
- request: newRequest("GET", "http://localhost/111/222/333"),
- vars: map[string]string{},
- host: "",
- path: "/111/222/333",
- shouldMatch: true,
- },
- {
- title: "Path route, match with trailing slash in request and path",
- route: new(Route).Path("/111/"),
- request: newRequest("GET", "http://localhost/111/"),
- vars: map[string]string{},
- host: "",
- path: "/111/",
- shouldMatch: true,
- },
- {
- title: "Path route, do not match with trailing slash in path",
- route: new(Route).Path("/111/"),
- request: newRequest("GET", "http://localhost/111"),
- vars: map[string]string{},
- host: "",
- path: "/111",
- shouldMatch: false,
- },
- {
- title: "Path route, do not match with trailing slash in request",
- route: new(Route).Path("/111"),
- request: newRequest("GET", "http://localhost/111/"),
- vars: map[string]string{},
- host: "",
- path: "/111/",
- shouldMatch: false,
- },
- {
- title: "Path route, wrong path in request in request URL",
- route: new(Route).Path("/111/222/333"),
- request: newRequest("GET", "http://localhost/1/2/3"),
- vars: map[string]string{},
- host: "",
- path: "/111/222/333",
- shouldMatch: false,
- },
- {
- title: "Path route with pattern, match",
- route: new(Route).Path("/111/{v1:[0-9]{3}}/333"),
- request: newRequest("GET", "http://localhost/111/222/333"),
- vars: map[string]string{"v1": "222"},
- host: "",
- path: "/111/222/333",
- shouldMatch: true,
- },
- {
- title: "Path route with pattern, URL in request does not match",
- route: new(Route).Path("/111/{v1:[0-9]{3}}/333"),
- request: newRequest("GET", "http://localhost/111/aaa/333"),
- vars: map[string]string{"v1": "222"},
- host: "",
- path: "/111/222/333",
- shouldMatch: false,
- },
- {
- title: "Path route with multiple patterns, match",
- route: new(Route).Path("/{v1:[0-9]{3}}/{v2:[0-9]{3}}/{v3:[0-9]{3}}"),
- request: newRequest("GET", "http://localhost/111/222/333"),
- vars: map[string]string{"v1": "111", "v2": "222", "v3": "333"},
- host: "",
- path: "/111/222/333",
- shouldMatch: true,
- },
- {
- title: "Path route with multiple patterns, URL in request does not match",
- route: new(Route).Path("/{v1:[0-9]{3}}/{v2:[0-9]{3}}/{v3:[0-9]{3}}"),
- request: newRequest("GET", "http://localhost/111/aaa/333"),
- vars: map[string]string{"v1": "111", "v2": "222", "v3": "333"},
- host: "",
- path: "/111/222/333",
- shouldMatch: false,
- },
- }
-
- for _, test := range tests {
- testRoute(t, test)
- }
-}
-
-func TestPathPrefix(t *testing.T) {
- tests := []routeTest{
- {
- title: "PathPrefix route, match",
- route: new(Route).PathPrefix("/111"),
- request: newRequest("GET", "http://localhost/111/222/333"),
- vars: map[string]string{},
- host: "",
- path: "/111",
- shouldMatch: true,
- },
- {
- title: "PathPrefix route, match substring",
- route: new(Route).PathPrefix("/1"),
- request: newRequest("GET", "http://localhost/111/222/333"),
- vars: map[string]string{},
- host: "",
- path: "/1",
- shouldMatch: true,
- },
- {
- title: "PathPrefix route, URL prefix in request does not match",
- route: new(Route).PathPrefix("/111"),
- request: newRequest("GET", "http://localhost/1/2/3"),
- vars: map[string]string{},
- host: "",
- path: "/111",
- shouldMatch: false,
- },
- {
- title: "PathPrefix route with pattern, match",
- route: new(Route).PathPrefix("/111/{v1:[0-9]{3}}"),
- request: newRequest("GET", "http://localhost/111/222/333"),
- vars: map[string]string{"v1": "222"},
- host: "",
- path: "/111/222",
- shouldMatch: true,
- },
- {
- title: "PathPrefix route with pattern, URL prefix in request does not match",
- route: new(Route).PathPrefix("/111/{v1:[0-9]{3}}"),
- request: newRequest("GET", "http://localhost/111/aaa/333"),
- vars: map[string]string{"v1": "222"},
- host: "",
- path: "/111/222",
- shouldMatch: false,
- },
- {
- title: "PathPrefix route with multiple patterns, match",
- route: new(Route).PathPrefix("/{v1:[0-9]{3}}/{v2:[0-9]{3}}"),
- request: newRequest("GET", "http://localhost/111/222/333"),
- vars: map[string]string{"v1": "111", "v2": "222"},
- host: "",
- path: "/111/222",
- shouldMatch: true,
- },
- {
- title: "PathPrefix route with multiple patterns, URL prefix in request does not match",
- route: new(Route).PathPrefix("/{v1:[0-9]{3}}/{v2:[0-9]{3}}"),
- request: newRequest("GET", "http://localhost/111/aaa/333"),
- vars: map[string]string{"v1": "111", "v2": "222"},
- host: "",
- path: "/111/222",
- shouldMatch: false,
- },
- }
-
- for _, test := range tests {
- testRoute(t, test)
- }
-}
-
-func TestHostPath(t *testing.T) {
- tests := []routeTest{
- {
- title: "Host and Path route, match",
- route: new(Route).Host("aaa.bbb.ccc").Path("/111/222/333"),
- request: newRequest("GET", "http://aaa.bbb.ccc/111/222/333"),
- vars: map[string]string{},
- host: "",
- path: "",
- shouldMatch: true,
- },
- {
- title: "Host and Path route, wrong host in request URL",
- route: new(Route).Host("aaa.bbb.ccc").Path("/111/222/333"),
- request: newRequest("GET", "http://aaa.222.ccc/111/222/333"),
- vars: map[string]string{},
- host: "",
- path: "",
- shouldMatch: false,
- },
- {
- title: "Host and Path route with pattern, match",
- route: new(Route).Host("aaa.{v1:[a-z]{3}}.ccc").Path("/111/{v2:[0-9]{3}}/333"),
- request: newRequest("GET", "http://aaa.bbb.ccc/111/222/333"),
- vars: map[string]string{"v1": "bbb", "v2": "222"},
- host: "aaa.bbb.ccc",
- path: "/111/222/333",
- shouldMatch: true,
- },
- {
- title: "Host and Path route with pattern, URL in request does not match",
- route: new(Route).Host("aaa.{v1:[a-z]{3}}.ccc").Path("/111/{v2:[0-9]{3}}/333"),
- request: newRequest("GET", "http://aaa.222.ccc/111/222/333"),
- vars: map[string]string{"v1": "bbb", "v2": "222"},
- host: "aaa.bbb.ccc",
- path: "/111/222/333",
- shouldMatch: false,
- },
- {
- title: "Host and Path route with multiple patterns, match",
- route: new(Route).Host("{v1:[a-z]{3}}.{v2:[a-z]{3}}.{v3:[a-z]{3}}").Path("/{v4:[0-9]{3}}/{v5:[0-9]{3}}/{v6:[0-9]{3}}"),
- request: newRequest("GET", "http://aaa.bbb.ccc/111/222/333"),
- vars: map[string]string{"v1": "aaa", "v2": "bbb", "v3": "ccc", "v4": "111", "v5": "222", "v6": "333"},
- host: "aaa.bbb.ccc",
- path: "/111/222/333",
- shouldMatch: true,
- },
- {
- title: "Host and Path route with multiple patterns, URL in request does not match",
- route: new(Route).Host("{v1:[a-z]{3}}.{v2:[a-z]{3}}.{v3:[a-z]{3}}").Path("/{v4:[0-9]{3}}/{v5:[0-9]{3}}/{v6:[0-9]{3}}"),
- request: newRequest("GET", "http://aaa.222.ccc/111/222/333"),
- vars: map[string]string{"v1": "aaa", "v2": "bbb", "v3": "ccc", "v4": "111", "v5": "222", "v6": "333"},
- host: "aaa.bbb.ccc",
- path: "/111/222/333",
- shouldMatch: false,
- },
- }
-
- for _, test := range tests {
- testRoute(t, test)
- }
-}
-
-func TestHeaders(t *testing.T) {
- // newRequestHeaders creates a new request with a method, url, and headers
- newRequestHeaders := func(method, url string, headers map[string]string) *http.Request {
- req, err := http.NewRequest(method, url, nil)
- if err != nil {
- panic(err)
- }
- for k, v := range headers {
- req.Header.Add(k, v)
- }
- return req
- }
-
- tests := []routeTest{
- {
- title: "Headers route, match",
- route: new(Route).Headers("foo", "bar", "baz", "ding"),
- request: newRequestHeaders("GET", "http://localhost", map[string]string{"foo": "bar", "baz": "ding"}),
- vars: map[string]string{},
- host: "",
- path: "",
- shouldMatch: true,
- },
- {
- title: "Headers route, bad header values",
- route: new(Route).Headers("foo", "bar", "baz", "ding"),
- request: newRequestHeaders("GET", "http://localhost", map[string]string{"foo": "bar", "baz": "dong"}),
- vars: map[string]string{},
- host: "",
- path: "",
- shouldMatch: false,
- },
- }
-
- for _, test := range tests {
- testRoute(t, test)
- }
-
-}
-
-func TestMethods(t *testing.T) {
- tests := []routeTest{
- {
- title: "Methods route, match GET",
- route: new(Route).Methods("GET", "POST"),
- request: newRequest("GET", "http://localhost"),
- vars: map[string]string{},
- host: "",
- path: "",
- shouldMatch: true,
- },
- {
- title: "Methods route, match POST",
- route: new(Route).Methods("GET", "POST"),
- request: newRequest("POST", "http://localhost"),
- vars: map[string]string{},
- host: "",
- path: "",
- shouldMatch: true,
- },
- {
- title: "Methods route, bad method",
- route: new(Route).Methods("GET", "POST"),
- request: newRequest("PUT", "http://localhost"),
- vars: map[string]string{},
- host: "",
- path: "",
- shouldMatch: false,
- },
- }
-
- for _, test := range tests {
- testRoute(t, test)
- }
-}
-
-func TestQueries(t *testing.T) {
- tests := []routeTest{
- {
- title: "Queries route, match",
- route: new(Route).Queries("foo", "bar", "baz", "ding"),
- request: newRequest("GET", "http://localhost?foo=bar&baz=ding"),
- vars: map[string]string{},
- host: "",
- path: "",
- shouldMatch: true,
- },
- {
- title: "Queries route, match with a query string",
- route: new(Route).Host("www.example.com").Path("/api").Queries("foo", "bar", "baz", "ding"),
- request: newRequest("GET", "http://www.example.com/api?foo=bar&baz=ding"),
- vars: map[string]string{},
- host: "",
- path: "",
- shouldMatch: true,
- },
- {
- title: "Queries route, match with a query string out of order",
- route: new(Route).Host("www.example.com").Path("/api").Queries("foo", "bar", "baz", "ding"),
- request: newRequest("GET", "http://www.example.com/api?baz=ding&foo=bar"),
- vars: map[string]string{},
- host: "",
- path: "",
- shouldMatch: true,
- },
- {
- title: "Queries route, bad query",
- route: new(Route).Queries("foo", "bar", "baz", "ding"),
- request: newRequest("GET", "http://localhost?foo=bar&baz=dong"),
- vars: map[string]string{},
- host: "",
- path: "",
- shouldMatch: false,
- },
- {
- title: "Queries route with pattern, match",
- route: new(Route).Queries("foo", "{v1}"),
- request: newRequest("GET", "http://localhost?foo=bar"),
- vars: map[string]string{"v1": "bar"},
- host: "",
- path: "",
- shouldMatch: true,
- },
- {
- title: "Queries route with multiple patterns, match",
- route: new(Route).Queries("foo", "{v1}", "baz", "{v2}"),
- request: newRequest("GET", "http://localhost?foo=bar&baz=ding"),
- vars: map[string]string{"v1": "bar", "v2": "ding"},
- host: "",
- path: "",
- shouldMatch: true,
- },
- {
- title: "Queries route with regexp pattern, match",
- route: new(Route).Queries("foo", "{v1:[0-9]+}"),
- request: newRequest("GET", "http://localhost?foo=10"),
- vars: map[string]string{"v1": "10"},
- host: "",
- path: "",
- shouldMatch: true,
- },
- {
- title: "Queries route with regexp pattern, regexp does not match",
- route: new(Route).Queries("foo", "{v1:[0-9]+}"),
- request: newRequest("GET", "http://localhost?foo=a"),
- vars: map[string]string{},
- host: "",
- path: "",
- shouldMatch: false,
- },
- }
-
- for _, test := range tests {
- testRoute(t, test)
- }
-}
-
-func TestSchemes(t *testing.T) {
- tests := []routeTest{
- // Schemes
- {
- title: "Schemes route, match https",
- route: new(Route).Schemes("https", "ftp"),
- request: newRequest("GET", "https://localhost"),
- vars: map[string]string{},
- host: "",
- path: "",
- shouldMatch: true,
- },
- {
- title: "Schemes route, match ftp",
- route: new(Route).Schemes("https", "ftp"),
- request: newRequest("GET", "ftp://localhost"),
- vars: map[string]string{},
- host: "",
- path: "",
- shouldMatch: true,
- },
- {
- title: "Schemes route, bad scheme",
- route: new(Route).Schemes("https", "ftp"),
- request: newRequest("GET", "http://localhost"),
- vars: map[string]string{},
- host: "",
- path: "",
- shouldMatch: false,
- },
- }
- for _, test := range tests {
- testRoute(t, test)
- }
-}
-
-func TestMatcherFunc(t *testing.T) {
- m := func(r *http.Request, m *RouteMatch) bool {
- if r.URL.Host == "aaa.bbb.ccc" {
- return true
- }
- return false
- }
-
- tests := []routeTest{
- {
- title: "MatchFunc route, match",
- route: new(Route).MatcherFunc(m),
- request: newRequest("GET", "http://aaa.bbb.ccc"),
- vars: map[string]string{},
- host: "",
- path: "",
- shouldMatch: true,
- },
- {
- title: "MatchFunc route, non-match",
- route: new(Route).MatcherFunc(m),
- request: newRequest("GET", "http://aaa.222.ccc"),
- vars: map[string]string{},
- host: "",
- path: "",
- shouldMatch: false,
- },
- }
-
- for _, test := range tests {
- testRoute(t, test)
- }
-}
-
-func TestSubRouter(t *testing.T) {
- subrouter1 := new(Route).Host("{v1:[a-z]+}.google.com").Subrouter()
- subrouter2 := new(Route).PathPrefix("/foo/{v1}").Subrouter()
-
- tests := []routeTest{
- {
- route: subrouter1.Path("/{v2:[a-z]+}"),
- request: newRequest("GET", "http://aaa.google.com/bbb"),
- vars: map[string]string{"v1": "aaa", "v2": "bbb"},
- host: "aaa.google.com",
- path: "/bbb",
- shouldMatch: true,
- },
- {
- route: subrouter1.Path("/{v2:[a-z]+}"),
- request: newRequest("GET", "http://111.google.com/111"),
- vars: map[string]string{"v1": "aaa", "v2": "bbb"},
- host: "aaa.google.com",
- path: "/bbb",
- shouldMatch: false,
- },
- {
- route: subrouter2.Path("/baz/{v2}"),
- request: newRequest("GET", "http://localhost/foo/bar/baz/ding"),
- vars: map[string]string{"v1": "bar", "v2": "ding"},
- host: "",
- path: "/foo/bar/baz/ding",
- shouldMatch: true,
- },
- {
- route: subrouter2.Path("/baz/{v2}"),
- request: newRequest("GET", "http://localhost/foo/bar"),
- vars: map[string]string{"v1": "bar", "v2": "ding"},
- host: "",
- path: "/foo/bar/baz/ding",
- shouldMatch: false,
- },
- }
-
- for _, test := range tests {
- testRoute(t, test)
- }
-}
-
-func TestNamedRoutes(t *testing.T) {
- r1 := NewRouter()
- r1.NewRoute().Name("a")
- r1.NewRoute().Name("b")
- r1.NewRoute().Name("c")
-
- r2 := r1.NewRoute().Subrouter()
- r2.NewRoute().Name("d")
- r2.NewRoute().Name("e")
- r2.NewRoute().Name("f")
-
- r3 := r2.NewRoute().Subrouter()
- r3.NewRoute().Name("g")
- r3.NewRoute().Name("h")
- r3.NewRoute().Name("i")
-
- if r1.namedRoutes == nil || len(r1.namedRoutes) != 9 {
- t.Errorf("Expected 9 named routes, got %v", r1.namedRoutes)
- } else if r1.Get("i") == nil {
- t.Errorf("Subroute name not registered")
- }
-}
-
-func TestStrictSlash(t *testing.T) {
- r := NewRouter()
- r.StrictSlash(true)
-
- tests := []routeTest{
- {
- title: "Redirect path without slash",
- route: r.NewRoute().Path("/111/"),
- request: newRequest("GET", "http://localhost/111"),
- vars: map[string]string{},
- host: "",
- path: "/111/",
- shouldMatch: true,
- shouldRedirect: true,
- },
- {
- title: "Do not redirect path with slash",
- route: r.NewRoute().Path("/111/"),
- request: newRequest("GET", "http://localhost/111/"),
- vars: map[string]string{},
- host: "",
- path: "/111/",
- shouldMatch: true,
- shouldRedirect: false,
- },
- {
- title: "Redirect path with slash",
- route: r.NewRoute().Path("/111"),
- request: newRequest("GET", "http://localhost/111/"),
- vars: map[string]string{},
- host: "",
- path: "/111",
- shouldMatch: true,
- shouldRedirect: true,
- },
- {
- title: "Do not redirect path without slash",
- route: r.NewRoute().Path("/111"),
- request: newRequest("GET", "http://localhost/111"),
- vars: map[string]string{},
- host: "",
- path: "/111",
- shouldMatch: true,
- shouldRedirect: false,
- },
- {
- title: "Propagate StrictSlash to subrouters",
- route: r.NewRoute().PathPrefix("/static/").Subrouter().Path("/images/"),
- request: newRequest("GET", "http://localhost/static/images"),
- vars: map[string]string{},
- host: "",
- path: "/static/images/",
- shouldMatch: true,
- shouldRedirect: true,
- },
- {
- title: "Ignore StrictSlash for path prefix",
- route: r.NewRoute().PathPrefix("/static/"),
- request: newRequest("GET", "http://localhost/static/logo.png"),
- vars: map[string]string{},
- host: "",
- path: "/static/",
- shouldMatch: true,
- shouldRedirect: false,
- },
- }
-
- for _, test := range tests {
- testRoute(t, test)
- }
-}
-
-// ----------------------------------------------------------------------------
-// Helpers
-// ----------------------------------------------------------------------------
-
-func getRouteTemplate(route *Route) string {
- host, path := "none", "none"
- if route.regexp != nil {
- if route.regexp.host != nil {
- host = route.regexp.host.template
- }
- if route.regexp.path != nil {
- path = route.regexp.path.template
- }
- }
- return fmt.Sprintf("Host: %v, Path: %v", host, path)
-}
-
-func testRoute(t *testing.T, test routeTest) {
- request := test.request
- route := test.route
- vars := test.vars
- shouldMatch := test.shouldMatch
- host := test.host
- path := test.path
- url := test.host + test.path
- shouldRedirect := test.shouldRedirect
-
- var match RouteMatch
- ok := route.Match(request, &match)
- if ok != shouldMatch {
- msg := "Should match"
- if !shouldMatch {
- msg = "Should not match"
- }
- t.Errorf("(%v) %v:\nRoute: %#v\nRequest: %#v\nVars: %v\n", test.title, msg, route, request, vars)
- return
- }
- if shouldMatch {
- if test.vars != nil && !stringMapEqual(test.vars, match.Vars) {
- t.Errorf("(%v) Vars not equal: expected %v, got %v", test.title, vars, match.Vars)
- return
- }
- if host != "" {
- u, _ := test.route.URLHost(mapToPairs(match.Vars)...)
- if host != u.Host {
- t.Errorf("(%v) URLHost not equal: expected %v, got %v -- %v", test.title, host, u.Host, getRouteTemplate(route))
- return
- }
- }
- if path != "" {
- u, _ := route.URLPath(mapToPairs(match.Vars)...)
- if path != u.Path {
- t.Errorf("(%v) URLPath not equal: expected %v, got %v -- %v", test.title, path, u.Path, getRouteTemplate(route))
- return
- }
- }
- if url != "" {
- u, _ := route.URL(mapToPairs(match.Vars)...)
- if url != u.Host+u.Path {
- t.Errorf("(%v) URL not equal: expected %v, got %v -- %v", test.title, url, u.Host+u.Path, getRouteTemplate(route))
- return
- }
- }
- if shouldRedirect && match.Handler == nil {
- t.Errorf("(%v) Did not redirect", test.title)
- return
- }
- if !shouldRedirect && match.Handler != nil {
- t.Errorf("(%v) Unexpected redirect", test.title)
- return
- }
- }
-}
-
-// Tests that the context is cleared or not cleared properly depending on
-// the configuration of the router
-func TestKeepContext(t *testing.T) {
- func1 := func(w http.ResponseWriter, r *http.Request) {}
-
- r := NewRouter()
- r.HandleFunc("/", func1).Name("func1")
-
- req, _ := http.NewRequest("GET", "http://localhost/", nil)
- context.Set(req, "t", 1)
-
- res := new(http.ResponseWriter)
- r.ServeHTTP(*res, req)
-
- if _, ok := context.GetOk(req, "t"); ok {
- t.Error("Context should have been cleared at end of request")
- }
-
- r.KeepContext = true
-
- req, _ = http.NewRequest("GET", "http://localhost/", nil)
- context.Set(req, "t", 1)
-
- r.ServeHTTP(*res, req)
- if _, ok := context.GetOk(req, "t"); !ok {
- t.Error("Context should NOT have been cleared at end of request")
- }
-
-}
-
-type TestA301ResponseWriter struct {
- hh http.Header
- status int
-}
-
-func (ho TestA301ResponseWriter) Header() http.Header {
- return http.Header(ho.hh)
-}
-
-func (ho TestA301ResponseWriter) Write(b []byte) (int, error) {
- return 0, nil
-}
-
-func (ho TestA301ResponseWriter) WriteHeader(code int) {
- ho.status = code
-}
-
-func Test301Redirect(t *testing.T) {
- m := make(http.Header)
-
- func1 := func(w http.ResponseWriter, r *http.Request) {}
- func2 := func(w http.ResponseWriter, r *http.Request) {}
-
- r := NewRouter()
- r.HandleFunc("/api/", func2).Name("func2")
- r.HandleFunc("/", func1).Name("func1")
-
- req, _ := http.NewRequest("GET", "http://localhost//api/?abc=def", nil)
-
- res := TestA301ResponseWriter{
- hh: m,
- status: 0,
- }
- r.ServeHTTP(&res, req)
-
- if "http://localhost/api/?abc=def" != res.hh["Location"][0] {
- t.Errorf("Should have complete URL with query string")
- }
-}
-
-// https://plus.google.com/101022900381697718949/posts/eWy6DjFJ6uW
-func TestSubrouterHeader(t *testing.T) {
- expected := "func1 response"
- func1 := func(w http.ResponseWriter, r *http.Request) {
- fmt.Fprint(w, expected)
- }
- func2 := func(http.ResponseWriter, *http.Request) {}
-
- r := NewRouter()
- s := r.Headers("SomeSpecialHeader", "").Subrouter()
- s.HandleFunc("/", func1).Name("func1")
- r.HandleFunc("/", func2).Name("func2")
-
- req, _ := http.NewRequest("GET", "http://localhost/", nil)
- req.Header.Add("SomeSpecialHeader", "foo")
- match := new(RouteMatch)
- matched := r.Match(req, match)
- if !matched {
- t.Errorf("Should match request")
- }
- if match.Route.GetName() != "func1" {
- t.Errorf("Expecting func1 handler, got %s", match.Route.GetName())
- }
- resp := NewRecorder()
- match.Handler.ServeHTTP(resp, req)
- if resp.Body.String() != expected {
- t.Errorf("Expecting %q", expected)
- }
-}
-
-// mapToPairs converts a string map to a slice of string pairs
-func mapToPairs(m map[string]string) []string {
- var i int
- p := make([]string, len(m)*2)
- for k, v := range m {
- p[i] = k
- p[i+1] = v
- i += 2
- }
- return p
-}
-
-// stringMapEqual checks the equality of two string maps
-func stringMapEqual(m1, m2 map[string]string) bool {
- nil1 := m1 == nil
- nil2 := m2 == nil
- if nil1 != nil2 || len(m1) != len(m2) {
- return false
- }
- for k, v := range m1 {
- if v != m2[k] {
- return false
- }
- }
- return true
-}
-
-// newRequest is a helper function to create a new request with a method and url
-func newRequest(method, url string) *http.Request {
- req, err := http.NewRequest(method, url, nil)
- if err != nil {
- panic(err)
- }
- return req
-}
diff --git a/vendor/github.com/gorilla/mux/old_test.go b/vendor/github.com/gorilla/mux/old_test.go
deleted file mode 100644
index 1f7c190c..00000000
--- a/vendor/github.com/gorilla/mux/old_test.go
+++ /dev/null
@@ -1,714 +0,0 @@
-// Old tests ported to Go1. This is a mess. Want to drop it one day.
-
-// Copyright 2011 Gorilla Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package mux
-
-import (
- "bytes"
- "net/http"
- "testing"
-)
-
-// ----------------------------------------------------------------------------
-// ResponseRecorder
-// ----------------------------------------------------------------------------
-// Copyright 2009 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-// ResponseRecorder is an implementation of http.ResponseWriter that
-// records its mutations for later inspection in tests.
-type ResponseRecorder struct {
- Code int // the HTTP response code from WriteHeader
- HeaderMap http.Header // the HTTP response headers
- Body *bytes.Buffer // if non-nil, the bytes.Buffer to append written data to
- Flushed bool
-}
-
-// NewRecorder returns an initialized ResponseRecorder.
-func NewRecorder() *ResponseRecorder {
- return &ResponseRecorder{
- HeaderMap: make(http.Header),
- Body: new(bytes.Buffer),
- }
-}
-
-// DefaultRemoteAddr is the default remote address to return in RemoteAddr if
-// an explicit DefaultRemoteAddr isn't set on ResponseRecorder.
-const DefaultRemoteAddr = "1.2.3.4"
-
-// Header returns the response headers.
-func (rw *ResponseRecorder) Header() http.Header {
- return rw.HeaderMap
-}
-
-// Write always succeeds and writes to rw.Body, if not nil.
-func (rw *ResponseRecorder) Write(buf []byte) (int, error) {
- if rw.Body != nil {
- rw.Body.Write(buf)
- }
- if rw.Code == 0 {
- rw.Code = http.StatusOK
- }
- return len(buf), nil
-}
-
-// WriteHeader sets rw.Code.
-func (rw *ResponseRecorder) WriteHeader(code int) {
- rw.Code = code
-}
-
-// Flush sets rw.Flushed to true.
-func (rw *ResponseRecorder) Flush() {
- rw.Flushed = true
-}
-
-// ----------------------------------------------------------------------------
-
-func TestRouteMatchers(t *testing.T) {
- var scheme, host, path, query, method string
- var headers map[string]string
- var resultVars map[bool]map[string]string
-
- router := NewRouter()
- router.NewRoute().Host("{var1}.google.com").
- Path("/{var2:[a-z]+}/{var3:[0-9]+}").
- Queries("foo", "bar").
- Methods("GET").
- Schemes("https").
- Headers("x-requested-with", "XMLHttpRequest")
- router.NewRoute().Host("www.{var4}.com").
- PathPrefix("/foo/{var5:[a-z]+}/{var6:[0-9]+}").
- Queries("baz", "ding").
- Methods("POST").
- Schemes("http").
- Headers("Content-Type", "application/json")
-
- reset := func() {
- // Everything match.
- scheme = "https"
- host = "www.google.com"
- path = "/product/42"
- query = "?foo=bar"
- method = "GET"
- headers = map[string]string{"X-Requested-With": "XMLHttpRequest"}
- resultVars = map[bool]map[string]string{
- true: {"var1": "www", "var2": "product", "var3": "42"},
- false: {},
- }
- }
-
- reset2 := func() {
- // Everything match.
- scheme = "http"
- host = "www.google.com"
- path = "/foo/product/42/path/that/is/ignored"
- query = "?baz=ding"
- method = "POST"
- headers = map[string]string{"Content-Type": "application/json"}
- resultVars = map[bool]map[string]string{
- true: {"var4": "google", "var5": "product", "var6": "42"},
- false: {},
- }
- }
-
- match := func(shouldMatch bool) {
- url := scheme + "://" + host + path + query
- request, _ := http.NewRequest(method, url, nil)
- for key, value := range headers {
- request.Header.Add(key, value)
- }
-
- var routeMatch RouteMatch
- matched := router.Match(request, &routeMatch)
- if matched != shouldMatch {
- // Need better messages. :)
- if matched {
- t.Errorf("Should match.")
- } else {
- t.Errorf("Should not match.")
- }
- }
-
- if matched {
- currentRoute := routeMatch.Route
- if currentRoute == nil {
- t.Errorf("Expected a current route.")
- }
- vars := routeMatch.Vars
- expectedVars := resultVars[shouldMatch]
- if len(vars) != len(expectedVars) {
- t.Errorf("Expected vars: %v Got: %v.", expectedVars, vars)
- }
- for name, value := range vars {
- if expectedVars[name] != value {
- t.Errorf("Expected vars: %v Got: %v.", expectedVars, vars)
- }
- }
- }
- }
-
- // 1st route --------------------------------------------------------------
-
- // Everything match.
- reset()
- match(true)
-
- // Scheme doesn't match.
- reset()
- scheme = "http"
- match(false)
-
- // Host doesn't match.
- reset()
- host = "www.mygoogle.com"
- match(false)
-
- // Path doesn't match.
- reset()
- path = "/product/notdigits"
- match(false)
-
- // Query doesn't match.
- reset()
- query = "?foo=baz"
- match(false)
-
- // Method doesn't match.
- reset()
- method = "POST"
- match(false)
-
- // Header doesn't match.
- reset()
- headers = map[string]string{}
- match(false)
-
- // Everything match, again.
- reset()
- match(true)
-
- // 2nd route --------------------------------------------------------------
-
- // Everything match.
- reset2()
- match(true)
-
- // Scheme doesn't match.
- reset2()
- scheme = "https"
- match(false)
-
- // Host doesn't match.
- reset2()
- host = "sub.google.com"
- match(false)
-
- // Path doesn't match.
- reset2()
- path = "/bar/product/42"
- match(false)
-
- // Query doesn't match.
- reset2()
- query = "?foo=baz"
- match(false)
-
- // Method doesn't match.
- reset2()
- method = "GET"
- match(false)
-
- // Header doesn't match.
- reset2()
- headers = map[string]string{}
- match(false)
-
- // Everything match, again.
- reset2()
- match(true)
-}
-
-type headerMatcherTest struct {
- matcher headerMatcher
- headers map[string]string
- result bool
-}
-
-var headerMatcherTests = []headerMatcherTest{
- {
- matcher: headerMatcher(map[string]string{"x-requested-with": "XMLHttpRequest"}),
- headers: map[string]string{"X-Requested-With": "XMLHttpRequest"},
- result: true,
- },
- {
- matcher: headerMatcher(map[string]string{"x-requested-with": ""}),
- headers: map[string]string{"X-Requested-With": "anything"},
- result: true,
- },
- {
- matcher: headerMatcher(map[string]string{"x-requested-with": "XMLHttpRequest"}),
- headers: map[string]string{},
- result: false,
- },
-}
-
-type hostMatcherTest struct {
- matcher *Route
- url string
- vars map[string]string
- result bool
-}
-
-var hostMatcherTests = []hostMatcherTest{
- {
- matcher: NewRouter().NewRoute().Host("{foo:[a-z][a-z][a-z]}.{bar:[a-z][a-z][a-z]}.{baz:[a-z][a-z][a-z]}"),
- url: "http://abc.def.ghi/",
- vars: map[string]string{"foo": "abc", "bar": "def", "baz": "ghi"},
- result: true,
- },
- {
- matcher: NewRouter().NewRoute().Host("{foo:[a-z][a-z][a-z]}.{bar:[a-z][a-z][a-z]}.{baz:[a-z][a-z][a-z]}"),
- url: "http://a.b.c/",
- vars: map[string]string{"foo": "abc", "bar": "def", "baz": "ghi"},
- result: false,
- },
-}
-
-type methodMatcherTest struct {
- matcher methodMatcher
- method string
- result bool
-}
-
-var methodMatcherTests = []methodMatcherTest{
- {
- matcher: methodMatcher([]string{"GET", "POST", "PUT"}),
- method: "GET",
- result: true,
- },
- {
- matcher: methodMatcher([]string{"GET", "POST", "PUT"}),
- method: "POST",
- result: true,
- },
- {
- matcher: methodMatcher([]string{"GET", "POST", "PUT"}),
- method: "PUT",
- result: true,
- },
- {
- matcher: methodMatcher([]string{"GET", "POST", "PUT"}),
- method: "DELETE",
- result: false,
- },
-}
-
-type pathMatcherTest struct {
- matcher *Route
- url string
- vars map[string]string
- result bool
-}
-
-var pathMatcherTests = []pathMatcherTest{
- {
- matcher: NewRouter().NewRoute().Path("/{foo:[0-9][0-9][0-9]}/{bar:[0-9][0-9][0-9]}/{baz:[0-9][0-9][0-9]}"),
- url: "http://localhost:8080/123/456/789",
- vars: map[string]string{"foo": "123", "bar": "456", "baz": "789"},
- result: true,
- },
- {
- matcher: NewRouter().NewRoute().Path("/{foo:[0-9][0-9][0-9]}/{bar:[0-9][0-9][0-9]}/{baz:[0-9][0-9][0-9]}"),
- url: "http://localhost:8080/1/2/3",
- vars: map[string]string{"foo": "123", "bar": "456", "baz": "789"},
- result: false,
- },
-}
-
-type schemeMatcherTest struct {
- matcher schemeMatcher
- url string
- result bool
-}
-
-var schemeMatcherTests = []schemeMatcherTest{
- {
- matcher: schemeMatcher([]string{"http", "https"}),
- url: "http://localhost:8080/",
- result: true,
- },
- {
- matcher: schemeMatcher([]string{"http", "https"}),
- url: "https://localhost:8080/",
- result: true,
- },
- {
- matcher: schemeMatcher([]string{"https"}),
- url: "http://localhost:8080/",
- result: false,
- },
- {
- matcher: schemeMatcher([]string{"http"}),
- url: "https://localhost:8080/",
- result: false,
- },
-}
-
-type urlBuildingTest struct {
- route *Route
- vars []string
- url string
-}
-
-var urlBuildingTests = []urlBuildingTest{
- {
- route: new(Route).Host("foo.domain.com"),
- vars: []string{},
- url: "http://foo.domain.com",
- },
- {
- route: new(Route).Host("{subdomain}.domain.com"),
- vars: []string{"subdomain", "bar"},
- url: "http://bar.domain.com",
- },
- {
- route: new(Route).Host("foo.domain.com").Path("/articles"),
- vars: []string{},
- url: "http://foo.domain.com/articles",
- },
- {
- route: new(Route).Path("/articles"),
- vars: []string{},
- url: "/articles",
- },
- {
- route: new(Route).Path("/articles/{category}/{id:[0-9]+}"),
- vars: []string{"category", "technology", "id", "42"},
- url: "/articles/technology/42",
- },
- {
- route: new(Route).Host("{subdomain}.domain.com").Path("/articles/{category}/{id:[0-9]+}"),
- vars: []string{"subdomain", "foo", "category", "technology", "id", "42"},
- url: "http://foo.domain.com/articles/technology/42",
- },
-}
-
-func TestHeaderMatcher(t *testing.T) {
- for _, v := range headerMatcherTests {
- request, _ := http.NewRequest("GET", "http://localhost:8080/", nil)
- for key, value := range v.headers {
- request.Header.Add(key, value)
- }
- var routeMatch RouteMatch
- result := v.matcher.Match(request, &routeMatch)
- if result != v.result {
- if v.result {
- t.Errorf("%#v: should match %v.", v.matcher, request.Header)
- } else {
- t.Errorf("%#v: should not match %v.", v.matcher, request.Header)
- }
- }
- }
-}
-
-func TestHostMatcher(t *testing.T) {
- for _, v := range hostMatcherTests {
- request, _ := http.NewRequest("GET", v.url, nil)
- var routeMatch RouteMatch
- result := v.matcher.Match(request, &routeMatch)
- vars := routeMatch.Vars
- if result != v.result {
- if v.result {
- t.Errorf("%#v: should match %v.", v.matcher, v.url)
- } else {
- t.Errorf("%#v: should not match %v.", v.matcher, v.url)
- }
- }
- if result {
- if len(vars) != len(v.vars) {
- t.Errorf("%#v: vars length should be %v, got %v.", v.matcher, len(v.vars), len(vars))
- }
- for name, value := range vars {
- if v.vars[name] != value {
- t.Errorf("%#v: expected value %v for key %v, got %v.", v.matcher, v.vars[name], name, value)
- }
- }
- } else {
- if len(vars) != 0 {
- t.Errorf("%#v: vars length should be 0, got %v.", v.matcher, len(vars))
- }
- }
- }
-}
-
-func TestMethodMatcher(t *testing.T) {
- for _, v := range methodMatcherTests {
- request, _ := http.NewRequest(v.method, "http://localhost:8080/", nil)
- var routeMatch RouteMatch
- result := v.matcher.Match(request, &routeMatch)
- if result != v.result {
- if v.result {
- t.Errorf("%#v: should match %v.", v.matcher, v.method)
- } else {
- t.Errorf("%#v: should not match %v.", v.matcher, v.method)
- }
- }
- }
-}
-
-func TestPathMatcher(t *testing.T) {
- for _, v := range pathMatcherTests {
- request, _ := http.NewRequest("GET", v.url, nil)
- var routeMatch RouteMatch
- result := v.matcher.Match(request, &routeMatch)
- vars := routeMatch.Vars
- if result != v.result {
- if v.result {
- t.Errorf("%#v: should match %v.", v.matcher, v.url)
- } else {
- t.Errorf("%#v: should not match %v.", v.matcher, v.url)
- }
- }
- if result {
- if len(vars) != len(v.vars) {
- t.Errorf("%#v: vars length should be %v, got %v.", v.matcher, len(v.vars), len(vars))
- }
- for name, value := range vars {
- if v.vars[name] != value {
- t.Errorf("%#v: expected value %v for key %v, got %v.", v.matcher, v.vars[name], name, value)
- }
- }
- } else {
- if len(vars) != 0 {
- t.Errorf("%#v: vars length should be 0, got %v.", v.matcher, len(vars))
- }
- }
- }
-}
-
-func TestSchemeMatcher(t *testing.T) {
- for _, v := range schemeMatcherTests {
- request, _ := http.NewRequest("GET", v.url, nil)
- var routeMatch RouteMatch
- result := v.matcher.Match(request, &routeMatch)
- if result != v.result {
- if v.result {
- t.Errorf("%#v: should match %v.", v.matcher, v.url)
- } else {
- t.Errorf("%#v: should not match %v.", v.matcher, v.url)
- }
- }
- }
-}
-
-func TestUrlBuilding(t *testing.T) {
-
- for _, v := range urlBuildingTests {
- u, _ := v.route.URL(v.vars...)
- url := u.String()
- if url != v.url {
- t.Errorf("expected %v, got %v", v.url, url)
- /*
- reversePath := ""
- reverseHost := ""
- if v.route.pathTemplate != nil {
- reversePath = v.route.pathTemplate.Reverse
- }
- if v.route.hostTemplate != nil {
- reverseHost = v.route.hostTemplate.Reverse
- }
-
- t.Errorf("%#v:\nexpected: %q\ngot: %q\nreverse path: %q\nreverse host: %q", v.route, v.url, url, reversePath, reverseHost)
- */
- }
- }
-
- ArticleHandler := func(w http.ResponseWriter, r *http.Request) {
- }
-
- router := NewRouter()
- router.HandleFunc("/articles/{category}/{id:[0-9]+}", ArticleHandler).Name("article")
-
- url, _ := router.Get("article").URL("category", "technology", "id", "42")
- expected := "/articles/technology/42"
- if url.String() != expected {
- t.Errorf("Expected %v, got %v", expected, url.String())
- }
-}
-
-func TestMatchedRouteName(t *testing.T) {
- routeName := "stock"
- router := NewRouter()
- route := router.NewRoute().Path("/products/").Name(routeName)
-
- url := "http://www.domain.com/products/"
- request, _ := http.NewRequest("GET", url, nil)
- var rv RouteMatch
- ok := router.Match(request, &rv)
-
- if !ok || rv.Route != route {
- t.Errorf("Expected same route, got %+v.", rv.Route)
- }
-
- retName := rv.Route.GetName()
- if retName != routeName {
- t.Errorf("Expected %q, got %q.", routeName, retName)
- }
-}
-
-func TestSubRouting(t *testing.T) {
- // Example from docs.
- router := NewRouter()
- subrouter := router.NewRoute().Host("www.domain.com").Subrouter()
- route := subrouter.NewRoute().Path("/products/").Name("products")
-
- url := "http://www.domain.com/products/"
- request, _ := http.NewRequest("GET", url, nil)
- var rv RouteMatch
- ok := router.Match(request, &rv)
-
- if !ok || rv.Route != route {
- t.Errorf("Expected same route, got %+v.", rv.Route)
- }
-
- u, _ := router.Get("products").URL()
- builtUrl := u.String()
- // Yay, subroute aware of the domain when building!
- if builtUrl != url {
- t.Errorf("Expected %q, got %q.", url, builtUrl)
- }
-}
-
-func TestVariableNames(t *testing.T) {
- route := new(Route).Host("{arg1}.domain.com").Path("/{arg1}/{arg2:[0-9]+}")
- if route.err == nil {
- t.Errorf("Expected error for duplicated variable names")
- }
-}
-
-func TestRedirectSlash(t *testing.T) {
- var route *Route
- var routeMatch RouteMatch
- r := NewRouter()
-
- r.StrictSlash(false)
- route = r.NewRoute()
- if route.strictSlash != false {
- t.Errorf("Expected false redirectSlash.")
- }
-
- r.StrictSlash(true)
- route = r.NewRoute()
- if route.strictSlash != true {
- t.Errorf("Expected true redirectSlash.")
- }
-
- route = new(Route)
- route.strictSlash = true
- route.Path("/{arg1}/{arg2:[0-9]+}/")
- request, _ := http.NewRequest("GET", "http://localhost/foo/123", nil)
- routeMatch = RouteMatch{}
- _ = route.Match(request, &routeMatch)
- vars := routeMatch.Vars
- if vars["arg1"] != "foo" {
- t.Errorf("Expected foo.")
- }
- if vars["arg2"] != "123" {
- t.Errorf("Expected 123.")
- }
- rsp := NewRecorder()
- routeMatch.Handler.ServeHTTP(rsp, request)
- if rsp.HeaderMap.Get("Location") != "http://localhost/foo/123/" {
- t.Errorf("Expected redirect header.")
- }
-
- route = new(Route)
- route.strictSlash = true
- route.Path("/{arg1}/{arg2:[0-9]+}")
- request, _ = http.NewRequest("GET", "http://localhost/foo/123/", nil)
- routeMatch = RouteMatch{}
- _ = route.Match(request, &routeMatch)
- vars = routeMatch.Vars
- if vars["arg1"] != "foo" {
- t.Errorf("Expected foo.")
- }
- if vars["arg2"] != "123" {
- t.Errorf("Expected 123.")
- }
- rsp = NewRecorder()
- routeMatch.Handler.ServeHTTP(rsp, request)
- if rsp.HeaderMap.Get("Location") != "http://localhost/foo/123" {
- t.Errorf("Expected redirect header.")
- }
-}
-
-// Test for the new regexp library, still not available in stable Go.
-func TestNewRegexp(t *testing.T) {
- var p *routeRegexp
- var matches []string
-
- tests := map[string]map[string][]string{
- "/{foo:a{2}}": {
- "/a": nil,
- "/aa": {"aa"},
- "/aaa": nil,
- "/aaaa": nil,
- },
- "/{foo:a{2,}}": {
- "/a": nil,
- "/aa": {"aa"},
- "/aaa": {"aaa"},
- "/aaaa": {"aaaa"},
- },
- "/{foo:a{2,3}}": {
- "/a": nil,
- "/aa": {"aa"},
- "/aaa": {"aaa"},
- "/aaaa": nil,
- },
- "/{foo:[a-z]{3}}/{bar:[a-z]{2}}": {
- "/a": nil,
- "/ab": nil,
- "/abc": nil,
- "/abcd": nil,
- "/abc/ab": {"abc", "ab"},
- "/abc/abc": nil,
- "/abcd/ab": nil,
- },
- `/{foo:\w{3,}}/{bar:\d{2,}}`: {
- "/a": nil,
- "/ab": nil,
- "/abc": nil,
- "/abc/1": nil,
- "/abc/12": {"abc", "12"},
- "/abcd/12": {"abcd", "12"},
- "/abcd/123": {"abcd", "123"},
- },
- }
-
- for pattern, paths := range tests {
- p, _ = newRouteRegexp(pattern, false, false, false, false)
- for path, result := range paths {
- matches = p.regexp.FindStringSubmatch(path)
- if result == nil {
- if matches != nil {
- t.Errorf("%v should not match %v.", pattern, path)
- }
- } else {
- if len(matches) != len(result)+1 {
- t.Errorf("Expected %v matches, got %v.", len(result)+1, len(matches))
- } else {
- for k, v := range result {
- if matches[k+1] != v {
- t.Errorf("Expected %v, got %v.", v, matches[k+1])
- }
- }
- }
- }
- }
- }
-}
diff --git a/vendor/github.com/jmespath/go-jmespath/compliance/basic.json b/vendor/github.com/jmespath/go-jmespath/compliance/basic.json
deleted file mode 100644
index d550e969..00000000
--- a/vendor/github.com/jmespath/go-jmespath/compliance/basic.json
+++ /dev/null
@@ -1,96 +0,0 @@
-[{
- "given":
- {"foo": {"bar": {"baz": "correct"}}},
- "cases": [
- {
- "expression": "foo",
- "result": {"bar": {"baz": "correct"}}
- },
- {
- "expression": "foo.bar",
- "result": {"baz": "correct"}
- },
- {
- "expression": "foo.bar.baz",
- "result": "correct"
- },
- {
- "expression": "foo\n.\nbar\n.baz",
- "result": "correct"
- },
- {
- "expression": "foo.bar.baz.bad",
- "result": null
- },
- {
- "expression": "foo.bar.bad",
- "result": null
- },
- {
- "expression": "foo.bad",
- "result": null
- },
- {
- "expression": "bad",
- "result": null
- },
- {
- "expression": "bad.morebad.morebad",
- "result": null
- }
- ]
-},
-{
- "given":
- {"foo": {"bar": ["one", "two", "three"]}},
- "cases": [
- {
- "expression": "foo",
- "result": {"bar": ["one", "two", "three"]}
- },
- {
- "expression": "foo.bar",
- "result": ["one", "two", "three"]
- }
- ]
-},
-{
- "given": ["one", "two", "three"],
- "cases": [
- {
- "expression": "one",
- "result": null
- },
- {
- "expression": "two",
- "result": null
- },
- {
- "expression": "three",
- "result": null
- },
- {
- "expression": "one.two",
- "result": null
- }
- ]
-},
-{
- "given":
- {"foo": {"1": ["one", "two", "three"], "-1": "bar"}},
- "cases": [
- {
- "expression": "foo.\"1\"",
- "result": ["one", "two", "three"]
- },
- {
- "expression": "foo.\"1\"[0]",
- "result": "one"
- },
- {
- "expression": "foo.\"-1\"",
- "result": "bar"
- }
- ]
-}
-]
diff --git a/vendor/github.com/jmespath/go-jmespath/compliance/boolean.json b/vendor/github.com/jmespath/go-jmespath/compliance/boolean.json
deleted file mode 100644
index e3fa196b..00000000
--- a/vendor/github.com/jmespath/go-jmespath/compliance/boolean.json
+++ /dev/null
@@ -1,257 +0,0 @@
-[
- {
- "given": {
- "outer": {
- "foo": "foo",
- "bar": "bar",
- "baz": "baz"
- }
- },
- "cases": [
- {
- "expression": "outer.foo || outer.bar",
- "result": "foo"
- },
- {
- "expression": "outer.foo||outer.bar",
- "result": "foo"
- },
- {
- "expression": "outer.bar || outer.baz",
- "result": "bar"
- },
- {
- "expression": "outer.bar||outer.baz",
- "result": "bar"
- },
- {
- "expression": "outer.bad || outer.foo",
- "result": "foo"
- },
- {
- "expression": "outer.bad||outer.foo",
- "result": "foo"
- },
- {
- "expression": "outer.foo || outer.bad",
- "result": "foo"
- },
- {
- "expression": "outer.foo||outer.bad",
- "result": "foo"
- },
- {
- "expression": "outer.bad || outer.alsobad",
- "result": null
- },
- {
- "expression": "outer.bad||outer.alsobad",
- "result": null
- }
- ]
- },
- {
- "given": {
- "outer": {
- "foo": "foo",
- "bool": false,
- "empty_list": [],
- "empty_string": ""
- }
- },
- "cases": [
- {
- "expression": "outer.empty_string || outer.foo",
- "result": "foo"
- },
- {
- "expression": "outer.nokey || outer.bool || outer.empty_list || outer.empty_string || outer.foo",
- "result": "foo"
- }
- ]
- },
- {
- "given": {
- "True": true,
- "False": false,
- "Number": 5,
- "EmptyList": [],
- "Zero": 0
- },
- "cases": [
- {
- "expression": "True && False",
- "result": false
- },
- {
- "expression": "False && True",
- "result": false
- },
- {
- "expression": "True && True",
- "result": true
- },
- {
- "expression": "False && False",
- "result": false
- },
- {
- "expression": "True && Number",
- "result": 5
- },
- {
- "expression": "Number && True",
- "result": true
- },
- {
- "expression": "Number && False",
- "result": false
- },
- {
- "expression": "Number && EmptyList",
- "result": []
- },
- {
- "expression": "Number && True",
- "result": true
- },
- {
- "expression": "EmptyList && True",
- "result": []
- },
- {
- "expression": "EmptyList && False",
- "result": []
- },
- {
- "expression": "True || False",
- "result": true
- },
- {
- "expression": "True || True",
- "result": true
- },
- {
- "expression": "False || True",
- "result": true
- },
- {
- "expression": "False || False",
- "result": false
- },
- {
- "expression": "Number || EmptyList",
- "result": 5
- },
- {
- "expression": "Number || True",
- "result": 5
- },
- {
- "expression": "Number || True && False",
- "result": 5
- },
- {
- "expression": "(Number || True) && False",
- "result": false
- },
- {
- "expression": "Number || (True && False)",
- "result": 5
- },
- {
- "expression": "!True",
- "result": false
- },
- {
- "expression": "!False",
- "result": true
- },
- {
- "expression": "!Number",
- "result": false
- },
- {
- "expression": "!EmptyList",
- "result": true
- },
- {
- "expression": "True && !False",
- "result": true
- },
- {
- "expression": "True && !EmptyList",
- "result": true
- },
- {
- "expression": "!False && !EmptyList",
- "result": true
- },
- {
- "expression": "!(True && False)",
- "result": true
- },
- {
- "expression": "!Zero",
- "result": false
- },
- {
- "expression": "!!Zero",
- "result": true
- }
- ]
- },
- {
- "given": {
- "one": 1,
- "two": 2,
- "three": 3
- },
- "cases": [
- {
- "expression": "one < two",
- "result": true
- },
- {
- "expression": "one <= two",
- "result": true
- },
- {
- "expression": "one == one",
- "result": true
- },
- {
- "expression": "one == two",
- "result": false
- },
- {
- "expression": "one > two",
- "result": false
- },
- {
- "expression": "one >= two",
- "result": false
- },
- {
- "expression": "one != two",
- "result": true
- },
- {
- "expression": "one < two && three > one",
- "result": true
- },
- {
- "expression": "one < two || three > one",
- "result": true
- },
- {
- "expression": "one < two || three < one",
- "result": true
- },
- {
- "expression": "two < one || three < one",
- "result": false
- }
- ]
- }
-]
diff --git a/vendor/github.com/jmespath/go-jmespath/compliance/current.json b/vendor/github.com/jmespath/go-jmespath/compliance/current.json
deleted file mode 100644
index 0c26248d..00000000
--- a/vendor/github.com/jmespath/go-jmespath/compliance/current.json
+++ /dev/null
@@ -1,25 +0,0 @@
-[
- {
- "given": {
- "foo": [{"name": "a"}, {"name": "b"}],
- "bar": {"baz": "qux"}
- },
- "cases": [
- {
- "expression": "@",
- "result": {
- "foo": [{"name": "a"}, {"name": "b"}],
- "bar": {"baz": "qux"}
- }
- },
- {
- "expression": "@.bar",
- "result": {"baz": "qux"}
- },
- {
- "expression": "@.foo[0]",
- "result": {"name": "a"}
- }
- ]
- }
-]
diff --git a/vendor/github.com/jmespath/go-jmespath/compliance/escape.json b/vendor/github.com/jmespath/go-jmespath/compliance/escape.json
deleted file mode 100644
index 4a62d951..00000000
--- a/vendor/github.com/jmespath/go-jmespath/compliance/escape.json
+++ /dev/null
@@ -1,46 +0,0 @@
-[{
- "given": {
- "foo.bar": "dot",
- "foo bar": "space",
- "foo\nbar": "newline",
- "foo\"bar": "doublequote",
- "c:\\\\windows\\path": "windows",
- "/unix/path": "unix",
- "\"\"\"": "threequotes",
- "bar": {"baz": "qux"}
- },
- "cases": [
- {
- "expression": "\"foo.bar\"",
- "result": "dot"
- },
- {
- "expression": "\"foo bar\"",
- "result": "space"
- },
- {
- "expression": "\"foo\\nbar\"",
- "result": "newline"
- },
- {
- "expression": "\"foo\\\"bar\"",
- "result": "doublequote"
- },
- {
- "expression": "\"c:\\\\\\\\windows\\\\path\"",
- "result": "windows"
- },
- {
- "expression": "\"/unix/path\"",
- "result": "unix"
- },
- {
- "expression": "\"\\\"\\\"\\\"\"",
- "result": "threequotes"
- },
- {
- "expression": "\"bar\".\"baz\"",
- "result": "qux"
- }
- ]
-}]
diff --git a/vendor/github.com/jmespath/go-jmespath/compliance/filters.json b/vendor/github.com/jmespath/go-jmespath/compliance/filters.json
deleted file mode 100644
index 5b9f52b1..00000000
--- a/vendor/github.com/jmespath/go-jmespath/compliance/filters.json
+++ /dev/null
@@ -1,468 +0,0 @@
-[
- {
- "given": {"foo": [{"name": "a"}, {"name": "b"}]},
- "cases": [
- {
- "comment": "Matching a literal",
- "expression": "foo[?name == 'a']",
- "result": [{"name": "a"}]
- }
- ]
- },
- {
- "given": {"foo": [0, 1], "bar": [2, 3]},
- "cases": [
- {
- "comment": "Matching a literal",
- "expression": "*[?[0] == `0`]",
- "result": [[], []]
- }
- ]
- },
- {
- "given": {"foo": [{"first": "foo", "last": "bar"},
- {"first": "foo", "last": "foo"},
- {"first": "foo", "last": "baz"}]},
- "cases": [
- {
- "comment": "Matching an expression",
- "expression": "foo[?first == last]",
- "result": [{"first": "foo", "last": "foo"}]
- },
- {
- "comment": "Verify projection created from filter",
- "expression": "foo[?first == last].first",
- "result": ["foo"]
- }
- ]
- },
- {
- "given": {"foo": [{"age": 20},
- {"age": 25},
- {"age": 30}]},
- "cases": [
- {
- "comment": "Greater than with a number",
- "expression": "foo[?age > `25`]",
- "result": [{"age": 30}]
- },
- {
- "expression": "foo[?age >= `25`]",
- "result": [{"age": 25}, {"age": 30}]
- },
- {
- "comment": "Greater than with a number",
- "expression": "foo[?age > `30`]",
- "result": []
- },
- {
- "comment": "Greater than with a number",
- "expression": "foo[?age < `25`]",
- "result": [{"age": 20}]
- },
- {
- "comment": "Greater than with a number",
- "expression": "foo[?age <= `25`]",
- "result": [{"age": 20}, {"age": 25}]
- },
- {
- "comment": "Greater than with a number",
- "expression": "foo[?age < `20`]",
- "result": []
- },
- {
- "expression": "foo[?age == `20`]",
- "result": [{"age": 20}]
- },
- {
- "expression": "foo[?age != `20`]",
- "result": [{"age": 25}, {"age": 30}]
- }
- ]
- },
- {
- "given": {"foo": [{"top": {"name": "a"}},
- {"top": {"name": "b"}}]},
- "cases": [
- {
- "comment": "Filter with subexpression",
- "expression": "foo[?top.name == 'a']",
- "result": [{"top": {"name": "a"}}]
- }
- ]
- },
- {
- "given": {"foo": [{"top": {"first": "foo", "last": "bar"}},
- {"top": {"first": "foo", "last": "foo"}},
- {"top": {"first": "foo", "last": "baz"}}]},
- "cases": [
- {
- "comment": "Matching an expression",
- "expression": "foo[?top.first == top.last]",
- "result": [{"top": {"first": "foo", "last": "foo"}}]
- },
- {
- "comment": "Matching a JSON array",
- "expression": "foo[?top == `{\"first\": \"foo\", \"last\": \"bar\"}`]",
- "result": [{"top": {"first": "foo", "last": "bar"}}]
- }
- ]
- },
- {
- "given": {"foo": [
- {"key": true},
- {"key": false},
- {"key": 0},
- {"key": 1},
- {"key": [0]},
- {"key": {"bar": [0]}},
- {"key": null},
- {"key": [1]},
- {"key": {"a":2}}
- ]},
- "cases": [
- {
- "expression": "foo[?key == `true`]",
- "result": [{"key": true}]
- },
- {
- "expression": "foo[?key == `false`]",
- "result": [{"key": false}]
- },
- {
- "expression": "foo[?key == `0`]",
- "result": [{"key": 0}]
- },
- {
- "expression": "foo[?key == `1`]",
- "result": [{"key": 1}]
- },
- {
- "expression": "foo[?key == `[0]`]",
- "result": [{"key": [0]}]
- },
- {
- "expression": "foo[?key == `{\"bar\": [0]}`]",
- "result": [{"key": {"bar": [0]}}]
- },
- {
- "expression": "foo[?key == `null`]",
- "result": [{"key": null}]
- },
- {
- "expression": "foo[?key == `[1]`]",
- "result": [{"key": [1]}]
- },
- {
- "expression": "foo[?key == `{\"a\":2}`]",
- "result": [{"key": {"a":2}}]
- },
- {
- "expression": "foo[?`true` == key]",
- "result": [{"key": true}]
- },
- {
- "expression": "foo[?`false` == key]",
- "result": [{"key": false}]
- },
- {
- "expression": "foo[?`0` == key]",
- "result": [{"key": 0}]
- },
- {
- "expression": "foo[?`1` == key]",
- "result": [{"key": 1}]
- },
- {
- "expression": "foo[?`[0]` == key]",
- "result": [{"key": [0]}]
- },
- {
- "expression": "foo[?`{\"bar\": [0]}` == key]",
- "result": [{"key": {"bar": [0]}}]
- },
- {
- "expression": "foo[?`null` == key]",
- "result": [{"key": null}]
- },
- {
- "expression": "foo[?`[1]` == key]",
- "result": [{"key": [1]}]
- },
- {
- "expression": "foo[?`{\"a\":2}` == key]",
- "result": [{"key": {"a":2}}]
- },
- {
- "expression": "foo[?key != `true`]",
- "result": [{"key": false}, {"key": 0}, {"key": 1}, {"key": [0]},
- {"key": {"bar": [0]}}, {"key": null}, {"key": [1]}, {"key": {"a":2}}]
- },
- {
- "expression": "foo[?key != `false`]",
- "result": [{"key": true}, {"key": 0}, {"key": 1}, {"key": [0]},
- {"key": {"bar": [0]}}, {"key": null}, {"key": [1]}, {"key": {"a":2}}]
- },
- {
- "expression": "foo[?key != `0`]",
- "result": [{"key": true}, {"key": false}, {"key": 1}, {"key": [0]},
- {"key": {"bar": [0]}}, {"key": null}, {"key": [1]}, {"key": {"a":2}}]
- },
- {
- "expression": "foo[?key != `1`]",
- "result": [{"key": true}, {"key": false}, {"key": 0}, {"key": [0]},
- {"key": {"bar": [0]}}, {"key": null}, {"key": [1]}, {"key": {"a":2}}]
- },
- {
- "expression": "foo[?key != `null`]",
- "result": [{"key": true}, {"key": false}, {"key": 0}, {"key": 1}, {"key": [0]},
- {"key": {"bar": [0]}}, {"key": [1]}, {"key": {"a":2}}]
- },
- {
- "expression": "foo[?key != `[1]`]",
- "result": [{"key": true}, {"key": false}, {"key": 0}, {"key": 1}, {"key": [0]},
- {"key": {"bar": [0]}}, {"key": null}, {"key": {"a":2}}]
- },
- {
- "expression": "foo[?key != `{\"a\":2}`]",
- "result": [{"key": true}, {"key": false}, {"key": 0}, {"key": 1}, {"key": [0]},
- {"key": {"bar": [0]}}, {"key": null}, {"key": [1]}]
- },
- {
- "expression": "foo[?`true` != key]",
- "result": [{"key": false}, {"key": 0}, {"key": 1}, {"key": [0]},
- {"key": {"bar": [0]}}, {"key": null}, {"key": [1]}, {"key": {"a":2}}]
- },
- {
- "expression": "foo[?`false` != key]",
- "result": [{"key": true}, {"key": 0}, {"key": 1}, {"key": [0]},
- {"key": {"bar": [0]}}, {"key": null}, {"key": [1]}, {"key": {"a":2}}]
- },
- {
- "expression": "foo[?`0` != key]",
- "result": [{"key": true}, {"key": false}, {"key": 1}, {"key": [0]},
- {"key": {"bar": [0]}}, {"key": null}, {"key": [1]}, {"key": {"a":2}}]
- },
- {
- "expression": "foo[?`1` != key]",
- "result": [{"key": true}, {"key": false}, {"key": 0}, {"key": [0]},
- {"key": {"bar": [0]}}, {"key": null}, {"key": [1]}, {"key": {"a":2}}]
- },
- {
- "expression": "foo[?`null` != key]",
- "result": [{"key": true}, {"key": false}, {"key": 0}, {"key": 1}, {"key": [0]},
- {"key": {"bar": [0]}}, {"key": [1]}, {"key": {"a":2}}]
- },
- {
- "expression": "foo[?`[1]` != key]",
- "result": [{"key": true}, {"key": false}, {"key": 0}, {"key": 1}, {"key": [0]},
- {"key": {"bar": [0]}}, {"key": null}, {"key": {"a":2}}]
- },
- {
- "expression": "foo[?`{\"a\":2}` != key]",
- "result": [{"key": true}, {"key": false}, {"key": 0}, {"key": 1}, {"key": [0]},
- {"key": {"bar": [0]}}, {"key": null}, {"key": [1]}]
- }
- ]
- },
- {
- "given": {"reservations": [
- {"instances": [
- {"foo": 1, "bar": 2}, {"foo": 1, "bar": 3},
- {"foo": 1, "bar": 2}, {"foo": 2, "bar": 1}]}]},
- "cases": [
- {
- "expression": "reservations[].instances[?bar==`1`]",
- "result": [[{"foo": 2, "bar": 1}]]
- },
- {
- "expression": "reservations[*].instances[?bar==`1`]",
- "result": [[{"foo": 2, "bar": 1}]]
- },
- {
- "expression": "reservations[].instances[?bar==`1`][]",
- "result": [{"foo": 2, "bar": 1}]
- }
- ]
- },
- {
- "given": {
- "baz": "other",
- "foo": [
- {"bar": 1}, {"bar": 2}, {"bar": 3}, {"bar": 4}, {"bar": 1, "baz": 2}
- ]
- },
- "cases": [
- {
- "expression": "foo[?bar==`1`].bar[0]",
- "result": []
- }
- ]
- },
- {
- "given": {
- "foo": [
- {"a": 1, "b": {"c": "x"}},
- {"a": 1, "b": {"c": "y"}},
- {"a": 1, "b": {"c": "z"}},
- {"a": 2, "b": {"c": "z"}},
- {"a": 1, "baz": 2}
- ]
- },
- "cases": [
- {
- "expression": "foo[?a==`1`].b.c",
- "result": ["x", "y", "z"]
- }
- ]
- },
- {
- "given": {"foo": [{"name": "a"}, {"name": "b"}, {"name": "c"}]},
- "cases": [
- {
- "comment": "Filter with or expression",
- "expression": "foo[?name == 'a' || name == 'b']",
- "result": [{"name": "a"}, {"name": "b"}]
- },
- {
- "expression": "foo[?name == 'a' || name == 'e']",
- "result": [{"name": "a"}]
- },
- {
- "expression": "foo[?name == 'a' || name == 'b' || name == 'c']",
- "result": [{"name": "a"}, {"name": "b"}, {"name": "c"}]
- }
- ]
- },
- {
- "given": {"foo": [{"a": 1, "b": 2}, {"a": 1, "b": 3}]},
- "cases": [
- {
- "comment": "Filter with and expression",
- "expression": "foo[?a == `1` && b == `2`]",
- "result": [{"a": 1, "b": 2}]
- },
- {
- "expression": "foo[?a == `1` && b == `4`]",
- "result": []
- }
- ]
- },
- {
- "given": {"foo": [{"a": 1, "b": 2, "c": 3}, {"a": 3, "b": 4}]},
- "cases": [
- {
- "comment": "Filter with Or and And expressions",
- "expression": "foo[?c == `3` || a == `1` && b == `4`]",
- "result": [{"a": 1, "b": 2, "c": 3}]
- },
- {
- "expression": "foo[?b == `2` || a == `3` && b == `4`]",
- "result": [{"a": 1, "b": 2, "c": 3}, {"a": 3, "b": 4}]
- },
- {
- "expression": "foo[?a == `3` && b == `4` || b == `2`]",
- "result": [{"a": 1, "b": 2, "c": 3}, {"a": 3, "b": 4}]
- },
- {
- "expression": "foo[?(a == `3` && b == `4`) || b == `2`]",
- "result": [{"a": 1, "b": 2, "c": 3}, {"a": 3, "b": 4}]
- },
- {
- "expression": "foo[?((a == `3` && b == `4`)) || b == `2`]",
- "result": [{"a": 1, "b": 2, "c": 3}, {"a": 3, "b": 4}]
- },
- {
- "expression": "foo[?a == `3` && (b == `4` || b == `2`)]",
- "result": [{"a": 3, "b": 4}]
- },
- {
- "expression": "foo[?a == `3` && ((b == `4` || b == `2`))]",
- "result": [{"a": 3, "b": 4}]
- }
- ]
- },
- {
- "given": {"foo": [{"a": 1, "b": 2, "c": 3}, {"a": 3, "b": 4}]},
- "cases": [
- {
- "comment": "Verify precedence of or/and expressions",
- "expression": "foo[?a == `1` || b ==`2` && c == `5`]",
- "result": [{"a": 1, "b": 2, "c": 3}]
- },
- {
- "comment": "Parentheses can alter precedence",
- "expression": "foo[?(a == `1` || b ==`2`) && c == `5`]",
- "result": []
- },
- {
- "comment": "Not expressions combined with and/or",
- "expression": "foo[?!(a == `1` || b ==`2`)]",
- "result": [{"a": 3, "b": 4}]
- }
- ]
- },
- {
- "given": {
- "foo": [
- {"key": true},
- {"key": false},
- {"key": []},
- {"key": {}},
- {"key": [0]},
- {"key": {"a": "b"}},
- {"key": 0},
- {"key": 1},
- {"key": null},
- {"notkey": true}
- ]
- },
- "cases": [
- {
- "comment": "Unary filter expression",
- "expression": "foo[?key]",
- "result": [
- {"key": true}, {"key": [0]}, {"key": {"a": "b"}},
- {"key": 0}, {"key": 1}
- ]
- },
- {
- "comment": "Unary not filter expression",
- "expression": "foo[?!key]",
- "result": [
- {"key": false}, {"key": []}, {"key": {}},
- {"key": null}, {"notkey": true}
- ]
- },
- {
- "comment": "Equality with null RHS",
- "expression": "foo[?key == `null`]",
- "result": [
- {"key": null}, {"notkey": true}
- ]
- }
- ]
- },
- {
- "given": {
- "foo": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
- },
- "cases": [
- {
- "comment": "Using @ in a filter expression",
- "expression": "foo[?@ < `5`]",
- "result": [0, 1, 2, 3, 4]
- },
- {
- "comment": "Using @ in a filter expression",
- "expression": "foo[?`5` > @]",
- "result": [0, 1, 2, 3, 4]
- },
- {
- "comment": "Using @ in a filter expression",
- "expression": "foo[?@ == @]",
- "result": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
- }
- ]
- }
-]
diff --git a/vendor/github.com/jmespath/go-jmespath/compliance/functions.json b/vendor/github.com/jmespath/go-jmespath/compliance/functions.json
deleted file mode 100644
index 8b8db363..00000000
--- a/vendor/github.com/jmespath/go-jmespath/compliance/functions.json
+++ /dev/null
@@ -1,825 +0,0 @@
-[{
- "given":
- {
- "foo": -1,
- "zero": 0,
- "numbers": [-1, 3, 4, 5],
- "array": [-1, 3, 4, 5, "a", "100"],
- "strings": ["a", "b", "c"],
- "decimals": [1.01, 1.2, -1.5],
- "str": "Str",
- "false": false,
- "empty_list": [],
- "empty_hash": {},
- "objects": {"foo": "bar", "bar": "baz"},
- "null_key": null
- },
- "cases": [
- {
- "expression": "abs(foo)",
- "result": 1
- },
- {
- "expression": "abs(foo)",
- "result": 1
- },
- {
- "expression": "abs(str)",
- "error": "invalid-type"
- },
- {
- "expression": "abs(array[1])",
- "result": 3
- },
- {
- "expression": "abs(array[1])",
- "result": 3
- },
- {
- "expression": "abs(`false`)",
- "error": "invalid-type"
- },
- {
- "expression": "abs(`-24`)",
- "result": 24
- },
- {
- "expression": "abs(`-24`)",
- "result": 24
- },
- {
- "expression": "abs(`1`, `2`)",
- "error": "invalid-arity"
- },
- {
- "expression": "abs()",
- "error": "invalid-arity"
- },
- {
- "expression": "unknown_function(`1`, `2`)",
- "error": "unknown-function"
- },
- {
- "expression": "avg(numbers)",
- "result": 2.75
- },
- {
- "expression": "avg(array)",
- "error": "invalid-type"
- },
- {
- "expression": "avg('abc')",
- "error": "invalid-type"
- },
- {
- "expression": "avg(foo)",
- "error": "invalid-type"
- },
- {
- "expression": "avg(@)",
- "error": "invalid-type"
- },
- {
- "expression": "avg(strings)",
- "error": "invalid-type"
- },
- {
- "expression": "ceil(`1.2`)",
- "result": 2
- },
- {
- "expression": "ceil(decimals[0])",
- "result": 2
- },
- {
- "expression": "ceil(decimals[1])",
- "result": 2
- },
- {
- "expression": "ceil(decimals[2])",
- "result": -1
- },
- {
- "expression": "ceil('string')",
- "error": "invalid-type"
- },
- {
- "expression": "contains('abc', 'a')",
- "result": true
- },
- {
- "expression": "contains('abc', 'd')",
- "result": false
- },
- {
- "expression": "contains(`false`, 'd')",
- "error": "invalid-type"
- },
- {
- "expression": "contains(strings, 'a')",
- "result": true
- },
- {
- "expression": "contains(decimals, `1.2`)",
- "result": true
- },
- {
- "expression": "contains(decimals, `false`)",
- "result": false
- },
- {
- "expression": "ends_with(str, 'r')",
- "result": true
- },
- {
- "expression": "ends_with(str, 'tr')",
- "result": true
- },
- {
- "expression": "ends_with(str, 'Str')",
- "result": true
- },
- {
- "expression": "ends_with(str, 'SStr')",
- "result": false
- },
- {
- "expression": "ends_with(str, 'foo')",
- "result": false
- },
- {
- "expression": "ends_with(str, `0`)",
- "error": "invalid-type"
- },
- {
- "expression": "floor(`1.2`)",
- "result": 1
- },
- {
- "expression": "floor('string')",
- "error": "invalid-type"
- },
- {
- "expression": "floor(decimals[0])",
- "result": 1
- },
- {
- "expression": "floor(foo)",
- "result": -1
- },
- {
- "expression": "floor(str)",
- "error": "invalid-type"
- },
- {
- "expression": "length('abc')",
- "result": 3
- },
- {
- "expression": "length('✓foo')",
- "result": 4
- },
- {
- "expression": "length('')",
- "result": 0
- },
- {
- "expression": "length(@)",
- "result": 12
- },
- {
- "expression": "length(strings[0])",
- "result": 1
- },
- {
- "expression": "length(str)",
- "result": 3
- },
- {
- "expression": "length(array)",
- "result": 6
- },
- {
- "expression": "length(objects)",
- "result": 2
- },
- {
- "expression": "length(`false`)",
- "error": "invalid-type"
- },
- {
- "expression": "length(foo)",
- "error": "invalid-type"
- },
- {
- "expression": "length(strings[0])",
- "result": 1
- },
- {
- "expression": "max(numbers)",
- "result": 5
- },
- {
- "expression": "max(decimals)",
- "result": 1.2
- },
- {
- "expression": "max(strings)",
- "result": "c"
- },
- {
- "expression": "max(abc)",
- "error": "invalid-type"
- },
- {
- "expression": "max(array)",
- "error": "invalid-type"
- },
- {
- "expression": "max(decimals)",
- "result": 1.2
- },
- {
- "expression": "max(empty_list)",
- "result": null
- },
- {
- "expression": "merge(`{}`)",
- "result": {}
- },
- {
- "expression": "merge(`{}`, `{}`)",
- "result": {}
- },
- {
- "expression": "merge(`{\"a\": 1}`, `{\"b\": 2}`)",
- "result": {"a": 1, "b": 2}
- },
- {
- "expression": "merge(`{\"a\": 1}`, `{\"a\": 2}`)",
- "result": {"a": 2}
- },
- {
- "expression": "merge(`{\"a\": 1, \"b\": 2}`, `{\"a\": 2, \"c\": 3}`, `{\"d\": 4}`)",
- "result": {"a": 2, "b": 2, "c": 3, "d": 4}
- },
- {
- "expression": "min(numbers)",
- "result": -1
- },
- {
- "expression": "min(decimals)",
- "result": -1.5
- },
- {
- "expression": "min(abc)",
- "error": "invalid-type"
- },
- {
- "expression": "min(array)",
- "error": "invalid-type"
- },
- {
- "expression": "min(empty_list)",
- "result": null
- },
- {
- "expression": "min(decimals)",
- "result": -1.5
- },
- {
- "expression": "min(strings)",
- "result": "a"
- },
- {
- "expression": "type('abc')",
- "result": "string"
- },
- {
- "expression": "type(`1.0`)",
- "result": "number"
- },
- {
- "expression": "type(`2`)",
- "result": "number"
- },
- {
- "expression": "type(`true`)",
- "result": "boolean"
- },
- {
- "expression": "type(`false`)",
- "result": "boolean"
- },
- {
- "expression": "type(`null`)",
- "result": "null"
- },
- {
- "expression": "type(`[0]`)",
- "result": "array"
- },
- {
- "expression": "type(`{\"a\": \"b\"}`)",
- "result": "object"
- },
- {
- "expression": "type(@)",
- "result": "object"
- },
- {
- "expression": "sort(keys(objects))",
- "result": ["bar", "foo"]
- },
- {
- "expression": "keys(foo)",
- "error": "invalid-type"
- },
- {
- "expression": "keys(strings)",
- "error": "invalid-type"
- },
- {
- "expression": "keys(`false`)",
- "error": "invalid-type"
- },
- {
- "expression": "sort(values(objects))",
- "result": ["bar", "baz"]
- },
- {
- "expression": "keys(empty_hash)",
- "result": []
- },
- {
- "expression": "values(foo)",
- "error": "invalid-type"
- },
- {
- "expression": "join(', ', strings)",
- "result": "a, b, c"
- },
- {
- "expression": "join(', ', strings)",
- "result": "a, b, c"
- },
- {
- "expression": "join(',', `[\"a\", \"b\"]`)",
- "result": "a,b"
- },
- {
- "expression": "join(',', `[\"a\", 0]`)",
- "error": "invalid-type"
- },
- {
- "expression": "join(', ', str)",
- "error": "invalid-type"
- },
- {
- "expression": "join('|', strings)",
- "result": "a|b|c"
- },
- {
- "expression": "join(`2`, strings)",
- "error": "invalid-type"
- },
- {
- "expression": "join('|', decimals)",
- "error": "invalid-type"
- },
- {
- "expression": "join('|', decimals[].to_string(@))",
- "result": "1.01|1.2|-1.5"
- },
- {
- "expression": "join('|', empty_list)",
- "result": ""
- },
- {
- "expression": "reverse(numbers)",
- "result": [5, 4, 3, -1]
- },
- {
- "expression": "reverse(array)",
- "result": ["100", "a", 5, 4, 3, -1]
- },
- {
- "expression": "reverse(`[]`)",
- "result": []
- },
- {
- "expression": "reverse('')",
- "result": ""
- },
- {
- "expression": "reverse('hello world')",
- "result": "dlrow olleh"
- },
- {
- "expression": "starts_with(str, 'S')",
- "result": true
- },
- {
- "expression": "starts_with(str, 'St')",
- "result": true
- },
- {
- "expression": "starts_with(str, 'Str')",
- "result": true
- },
- {
- "expression": "starts_with(str, 'String')",
- "result": false
- },
- {
- "expression": "starts_with(str, `0`)",
- "error": "invalid-type"
- },
- {
- "expression": "sum(numbers)",
- "result": 11
- },
- {
- "expression": "sum(decimals)",
- "result": 0.71
- },
- {
- "expression": "sum(array)",
- "error": "invalid-type"
- },
- {
- "expression": "sum(array[].to_number(@))",
- "result": 111
- },
- {
- "expression": "sum(`[]`)",
- "result": 0
- },
- {
- "expression": "to_array('foo')",
- "result": ["foo"]
- },
- {
- "expression": "to_array(`0`)",
- "result": [0]
- },
- {
- "expression": "to_array(objects)",
- "result": [{"foo": "bar", "bar": "baz"}]
- },
- {
- "expression": "to_array(`[1, 2, 3]`)",
- "result": [1, 2, 3]
- },
- {
- "expression": "to_array(false)",
- "result": [false]
- },
- {
- "expression": "to_string('foo')",
- "result": "foo"
- },
- {
- "expression": "to_string(`1.2`)",
- "result": "1.2"
- },
- {
- "expression": "to_string(`[0, 1]`)",
- "result": "[0,1]"
- },
- {
- "expression": "to_number('1.0')",
- "result": 1.0
- },
- {
- "expression": "to_number('1.1')",
- "result": 1.1
- },
- {
- "expression": "to_number('4')",
- "result": 4
- },
- {
- "expression": "to_number('notanumber')",
- "result": null
- },
- {
- "expression": "to_number(`false`)",
- "result": null
- },
- {
- "expression": "to_number(`null`)",
- "result": null
- },
- {
- "expression": "to_number(`[0]`)",
- "result": null
- },
- {
- "expression": "to_number(`{\"foo\": 0}`)",
- "result": null
- },
- {
- "expression": "\"to_string\"(`1.0`)",
- "error": "syntax"
- },
- {
- "expression": "sort(numbers)",
- "result": [-1, 3, 4, 5]
- },
- {
- "expression": "sort(strings)",
- "result": ["a", "b", "c"]
- },
- {
- "expression": "sort(decimals)",
- "result": [-1.5, 1.01, 1.2]
- },
- {
- "expression": "sort(array)",
- "error": "invalid-type"
- },
- {
- "expression": "sort(abc)",
- "error": "invalid-type"
- },
- {
- "expression": "sort(empty_list)",
- "result": []
- },
- {
- "expression": "sort(@)",
- "error": "invalid-type"
- },
- {
- "expression": "not_null(unknown_key, str)",
- "result": "Str"
- },
- {
- "expression": "not_null(unknown_key, foo.bar, empty_list, str)",
- "result": []
- },
- {
- "expression": "not_null(unknown_key, null_key, empty_list, str)",
- "result": []
- },
- {
- "expression": "not_null(all, expressions, are_null)",
- "result": null
- },
- {
- "expression": "not_null()",
- "error": "invalid-arity"
- },
- {
- "description": "function projection on single arg function",
- "expression": "numbers[].to_string(@)",
- "result": ["-1", "3", "4", "5"]
- },
- {
- "description": "function projection on single arg function",
- "expression": "array[].to_number(@)",
- "result": [-1, 3, 4, 5, 100]
- }
- ]
-}, {
- "given":
- {
- "foo": [
- {"b": "b", "a": "a"},
- {"c": "c", "b": "b"},
- {"d": "d", "c": "c"},
- {"e": "e", "d": "d"},
- {"f": "f", "e": "e"}
- ]
- },
- "cases": [
- {
- "description": "function projection on variadic function",
- "expression": "foo[].not_null(f, e, d, c, b, a)",
- "result": ["b", "c", "d", "e", "f"]
- }
- ]
-}, {
- "given":
- {
- "people": [
- {"age": 20, "age_str": "20", "bool": true, "name": "a", "extra": "foo"},
- {"age": 40, "age_str": "40", "bool": false, "name": "b", "extra": "bar"},
- {"age": 30, "age_str": "30", "bool": true, "name": "c"},
- {"age": 50, "age_str": "50", "bool": false, "name": "d"},
- {"age": 10, "age_str": "10", "bool": true, "name": 3}
- ]
- },
- "cases": [
- {
- "description": "sort by field expression",
- "expression": "sort_by(people, &age)",
- "result": [
- {"age": 10, "age_str": "10", "bool": true, "name": 3},
- {"age": 20, "age_str": "20", "bool": true, "name": "a", "extra": "foo"},
- {"age": 30, "age_str": "30", "bool": true, "name": "c"},
- {"age": 40, "age_str": "40", "bool": false, "name": "b", "extra": "bar"},
- {"age": 50, "age_str": "50", "bool": false, "name": "d"}
- ]
- },
- {
- "expression": "sort_by(people, &age_str)",
- "result": [
- {"age": 10, "age_str": "10", "bool": true, "name": 3},
- {"age": 20, "age_str": "20", "bool": true, "name": "a", "extra": "foo"},
- {"age": 30, "age_str": "30", "bool": true, "name": "c"},
- {"age": 40, "age_str": "40", "bool": false, "name": "b", "extra": "bar"},
- {"age": 50, "age_str": "50", "bool": false, "name": "d"}
- ]
- },
- {
- "description": "sort by function expression",
- "expression": "sort_by(people, &to_number(age_str))",
- "result": [
- {"age": 10, "age_str": "10", "bool": true, "name": 3},
- {"age": 20, "age_str": "20", "bool": true, "name": "a", "extra": "foo"},
- {"age": 30, "age_str": "30", "bool": true, "name": "c"},
- {"age": 40, "age_str": "40", "bool": false, "name": "b", "extra": "bar"},
- {"age": 50, "age_str": "50", "bool": false, "name": "d"}
- ]
- },
- {
- "description": "function projection on sort_by function",
- "expression": "sort_by(people, &age)[].name",
- "result": [3, "a", "c", "b", "d"]
- },
- {
- "expression": "sort_by(people, &extra)",
- "error": "invalid-type"
- },
- {
- "expression": "sort_by(people, &bool)",
- "error": "invalid-type"
- },
- {
- "expression": "sort_by(people, &name)",
- "error": "invalid-type"
- },
- {
- "expression": "sort_by(people, name)",
- "error": "invalid-type"
- },
- {
- "expression": "sort_by(people, &age)[].extra",
- "result": ["foo", "bar"]
- },
- {
- "expression": "sort_by(`[]`, &age)",
- "result": []
- },
- {
- "expression": "max_by(people, &age)",
- "result": {"age": 50, "age_str": "50", "bool": false, "name": "d"}
- },
- {
- "expression": "max_by(people, &age_str)",
- "result": {"age": 50, "age_str": "50", "bool": false, "name": "d"}
- },
- {
- "expression": "max_by(people, &bool)",
- "error": "invalid-type"
- },
- {
- "expression": "max_by(people, &extra)",
- "error": "invalid-type"
- },
- {
- "expression": "max_by(people, &to_number(age_str))",
- "result": {"age": 50, "age_str": "50", "bool": false, "name": "d"}
- },
- {
- "expression": "min_by(people, &age)",
- "result": {"age": 10, "age_str": "10", "bool": true, "name": 3}
- },
- {
- "expression": "min_by(people, &age_str)",
- "result": {"age": 10, "age_str": "10", "bool": true, "name": 3}
- },
- {
- "expression": "min_by(people, &bool)",
- "error": "invalid-type"
- },
- {
- "expression": "min_by(people, &extra)",
- "error": "invalid-type"
- },
- {
- "expression": "min_by(people, &to_number(age_str))",
- "result": {"age": 10, "age_str": "10", "bool": true, "name": 3}
- }
- ]
-}, {
- "given":
- {
- "people": [
- {"age": 10, "order": "1"},
- {"age": 10, "order": "2"},
- {"age": 10, "order": "3"},
- {"age": 10, "order": "4"},
- {"age": 10, "order": "5"},
- {"age": 10, "order": "6"},
- {"age": 10, "order": "7"},
- {"age": 10, "order": "8"},
- {"age": 10, "order": "9"},
- {"age": 10, "order": "10"},
- {"age": 10, "order": "11"}
- ]
- },
- "cases": [
- {
- "description": "stable sort order",
- "expression": "sort_by(people, &age)",
- "result": [
- {"age": 10, "order": "1"},
- {"age": 10, "order": "2"},
- {"age": 10, "order": "3"},
- {"age": 10, "order": "4"},
- {"age": 10, "order": "5"},
- {"age": 10, "order": "6"},
- {"age": 10, "order": "7"},
- {"age": 10, "order": "8"},
- {"age": 10, "order": "9"},
- {"age": 10, "order": "10"},
- {"age": 10, "order": "11"}
- ]
- }
- ]
-}, {
- "given":
- {
- "people": [
- {"a": 10, "b": 1, "c": "z"},
- {"a": 10, "b": 2, "c": null},
- {"a": 10, "b": 3},
- {"a": 10, "b": 4, "c": "z"},
- {"a": 10, "b": 5, "c": null},
- {"a": 10, "b": 6},
- {"a": 10, "b": 7, "c": "z"},
- {"a": 10, "b": 8, "c": null},
- {"a": 10, "b": 9}
- ],
- "empty": []
- },
- "cases": [
- {
- "expression": "map(&a, people)",
- "result": [10, 10, 10, 10, 10, 10, 10, 10, 10]
- },
- {
- "expression": "map(&c, people)",
- "result": ["z", null, null, "z", null, null, "z", null, null]
- },
- {
- "expression": "map(&a, badkey)",
- "error": "invalid-type"
- },
- {
- "expression": "map(&foo, empty)",
- "result": []
- }
- ]
-}, {
- "given": {
- "array": [
- {
- "foo": {"bar": "yes1"}
- },
- {
- "foo": {"bar": "yes2"}
- },
- {
- "foo1": {"bar": "no"}
- }
- ]},
- "cases": [
- {
- "expression": "map(&foo.bar, array)",
- "result": ["yes1", "yes2", null]
- },
- {
- "expression": "map(&foo1.bar, array)",
- "result": [null, null, "no"]
- },
- {
- "expression": "map(&foo.bar.baz, array)",
- "result": [null, null, null]
- }
- ]
-}, {
- "given": {
- "array": [[1, 2, 3, [4]], [5, 6, 7, [8, 9]]]
- },
- "cases": [
- {
- "expression": "map(&[], array)",
- "result": [[1, 2, 3, 4], [5, 6, 7, 8, 9]]
- }
- ]
-}
-]
diff --git a/vendor/github.com/jmespath/go-jmespath/compliance/identifiers.json b/vendor/github.com/jmespath/go-jmespath/compliance/identifiers.json
deleted file mode 100644
index 7998a41a..00000000
--- a/vendor/github.com/jmespath/go-jmespath/compliance/identifiers.json
+++ /dev/null
@@ -1,1377 +0,0 @@
-[
- {
- "given": {
- "__L": true
- },
- "cases": [
- {
- "expression": "__L",
- "result": true
- }
- ]
- },
- {
- "given": {
- "!\r": true
- },
- "cases": [
- {
- "expression": "\"!\\r\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "Y_1623": true
- },
- "cases": [
- {
- "expression": "Y_1623",
- "result": true
- }
- ]
- },
- {
- "given": {
- "x": true
- },
- "cases": [
- {
- "expression": "x",
- "result": true
- }
- ]
- },
- {
- "given": {
- "\tF\uCebb": true
- },
- "cases": [
- {
- "expression": "\"\\tF\\uCebb\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- " \t": true
- },
- "cases": [
- {
- "expression": "\" \\t\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- " ": true
- },
- "cases": [
- {
- "expression": "\" \"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "v2": true
- },
- "cases": [
- {
- "expression": "v2",
- "result": true
- }
- ]
- },
- {
- "given": {
- "\t": true
- },
- "cases": [
- {
- "expression": "\"\\t\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "_X": true
- },
- "cases": [
- {
- "expression": "_X",
- "result": true
- }
- ]
- },
- {
- "given": {
- "\t4\ud9da\udd15": true
- },
- "cases": [
- {
- "expression": "\"\\t4\\ud9da\\udd15\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "v24_W": true
- },
- "cases": [
- {
- "expression": "v24_W",
- "result": true
- }
- ]
- },
- {
- "given": {
- "H": true
- },
- "cases": [
- {
- "expression": "\"H\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "\f": true
- },
- "cases": [
- {
- "expression": "\"\\f\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "E4": true
- },
- "cases": [
- {
- "expression": "\"E4\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "!": true
- },
- "cases": [
- {
- "expression": "\"!\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "tM": true
- },
- "cases": [
- {
- "expression": "tM",
- "result": true
- }
- ]
- },
- {
- "given": {
- " [": true
- },
- "cases": [
- {
- "expression": "\" [\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "R!": true
- },
- "cases": [
- {
- "expression": "\"R!\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "_6W": true
- },
- "cases": [
- {
- "expression": "_6W",
- "result": true
- }
- ]
- },
- {
- "given": {
- "\uaBA1\r": true
- },
- "cases": [
- {
- "expression": "\"\\uaBA1\\r\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "tL7": true
- },
- "cases": [
- {
- "expression": "tL7",
- "result": true
- }
- ]
- },
- {
- "given": {
- "<": true
- },
- "cases": [
- {
- "expression": "\">\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "hvu": true
- },
- "cases": [
- {
- "expression": "hvu",
- "result": true
- }
- ]
- },
- {
- "given": {
- "; !": true
- },
- "cases": [
- {
- "expression": "\"; !\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "hU": true
- },
- "cases": [
- {
- "expression": "hU",
- "result": true
- }
- ]
- },
- {
- "given": {
- "!I\n\/": true
- },
- "cases": [
- {
- "expression": "\"!I\\n\\/\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "\uEEbF": true
- },
- "cases": [
- {
- "expression": "\"\\uEEbF\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "U)\t": true
- },
- "cases": [
- {
- "expression": "\"U)\\t\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "fa0_9": true
- },
- "cases": [
- {
- "expression": "fa0_9",
- "result": true
- }
- ]
- },
- {
- "given": {
- "/": true
- },
- "cases": [
- {
- "expression": "\"/\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "Gy": true
- },
- "cases": [
- {
- "expression": "Gy",
- "result": true
- }
- ]
- },
- {
- "given": {
- "\b": true
- },
- "cases": [
- {
- "expression": "\"\\b\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "<": true
- },
- "cases": [
- {
- "expression": "\"<\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "\t": true
- },
- "cases": [
- {
- "expression": "\"\\t\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "\t&\\\r": true
- },
- "cases": [
- {
- "expression": "\"\\t&\\\\\\r\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "#": true
- },
- "cases": [
- {
- "expression": "\"#\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "B__": true
- },
- "cases": [
- {
- "expression": "B__",
- "result": true
- }
- ]
- },
- {
- "given": {
- "\nS \n": true
- },
- "cases": [
- {
- "expression": "\"\\nS \\n\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "Bp": true
- },
- "cases": [
- {
- "expression": "Bp",
- "result": true
- }
- ]
- },
- {
- "given": {
- ",\t;": true
- },
- "cases": [
- {
- "expression": "\",\\t;\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "B_q": true
- },
- "cases": [
- {
- "expression": "B_q",
- "result": true
- }
- ]
- },
- {
- "given": {
- "\/+\t\n\b!Z": true
- },
- "cases": [
- {
- "expression": "\"\\/+\\t\\n\\b!Z\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "\udadd\udfc7\\ueFAc": true
- },
- "cases": [
- {
- "expression": "\"\udadd\udfc7\\\\ueFAc\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- ":\f": true
- },
- "cases": [
- {
- "expression": "\":\\f\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "\/": true
- },
- "cases": [
- {
- "expression": "\"\\/\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "_BW_6Hg_Gl": true
- },
- "cases": [
- {
- "expression": "_BW_6Hg_Gl",
- "result": true
- }
- ]
- },
- {
- "given": {
- "\udbcf\udc02": true
- },
- "cases": [
- {
- "expression": "\"\udbcf\udc02\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "zs1DC": true
- },
- "cases": [
- {
- "expression": "zs1DC",
- "result": true
- }
- ]
- },
- {
- "given": {
- "__434": true
- },
- "cases": [
- {
- "expression": "__434",
- "result": true
- }
- ]
- },
- {
- "given": {
- "\udb94\udd41": true
- },
- "cases": [
- {
- "expression": "\"\udb94\udd41\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "Z_5": true
- },
- "cases": [
- {
- "expression": "Z_5",
- "result": true
- }
- ]
- },
- {
- "given": {
- "z_M_": true
- },
- "cases": [
- {
- "expression": "z_M_",
- "result": true
- }
- ]
- },
- {
- "given": {
- "YU_2": true
- },
- "cases": [
- {
- "expression": "YU_2",
- "result": true
- }
- ]
- },
- {
- "given": {
- "_0": true
- },
- "cases": [
- {
- "expression": "_0",
- "result": true
- }
- ]
- },
- {
- "given": {
- "\b+": true
- },
- "cases": [
- {
- "expression": "\"\\b+\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "\"": true
- },
- "cases": [
- {
- "expression": "\"\\\"\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "D7": true
- },
- "cases": [
- {
- "expression": "D7",
- "result": true
- }
- ]
- },
- {
- "given": {
- "_62L": true
- },
- "cases": [
- {
- "expression": "_62L",
- "result": true
- }
- ]
- },
- {
- "given": {
- "\tK\t": true
- },
- "cases": [
- {
- "expression": "\"\\tK\\t\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "\n\\\f": true
- },
- "cases": [
- {
- "expression": "\"\\n\\\\\\f\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "I_": true
- },
- "cases": [
- {
- "expression": "I_",
- "result": true
- }
- ]
- },
- {
- "given": {
- "W_a0_": true
- },
- "cases": [
- {
- "expression": "W_a0_",
- "result": true
- }
- ]
- },
- {
- "given": {
- "BQ": true
- },
- "cases": [
- {
- "expression": "BQ",
- "result": true
- }
- ]
- },
- {
- "given": {
- "\tX$\uABBb": true
- },
- "cases": [
- {
- "expression": "\"\\tX$\\uABBb\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "Z9": true
- },
- "cases": [
- {
- "expression": "Z9",
- "result": true
- }
- ]
- },
- {
- "given": {
- "\b%\"\uda38\udd0f": true
- },
- "cases": [
- {
- "expression": "\"\\b%\\\"\uda38\udd0f\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "_F": true
- },
- "cases": [
- {
- "expression": "_F",
- "result": true
- }
- ]
- },
- {
- "given": {
- "!,": true
- },
- "cases": [
- {
- "expression": "\"!,\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "\"!": true
- },
- "cases": [
- {
- "expression": "\"\\\"!\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "Hh": true
- },
- "cases": [
- {
- "expression": "Hh",
- "result": true
- }
- ]
- },
- {
- "given": {
- "&": true
- },
- "cases": [
- {
- "expression": "\"&\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "9\r\\R": true
- },
- "cases": [
- {
- "expression": "\"9\\r\\\\R\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "M_k": true
- },
- "cases": [
- {
- "expression": "M_k",
- "result": true
- }
- ]
- },
- {
- "given": {
- "!\b\n\udb06\ude52\"\"": true
- },
- "cases": [
- {
- "expression": "\"!\\b\\n\udb06\ude52\\\"\\\"\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "6": true
- },
- "cases": [
- {
- "expression": "\"6\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "_7": true
- },
- "cases": [
- {
- "expression": "_7",
- "result": true
- }
- ]
- },
- {
- "given": {
- "0": true
- },
- "cases": [
- {
- "expression": "\"0\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "\\8\\": true
- },
- "cases": [
- {
- "expression": "\"\\\\8\\\\\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "b7eo": true
- },
- "cases": [
- {
- "expression": "b7eo",
- "result": true
- }
- ]
- },
- {
- "given": {
- "xIUo9": true
- },
- "cases": [
- {
- "expression": "xIUo9",
- "result": true
- }
- ]
- },
- {
- "given": {
- "5": true
- },
- "cases": [
- {
- "expression": "\"5\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "?": true
- },
- "cases": [
- {
- "expression": "\"?\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "sU": true
- },
- "cases": [
- {
- "expression": "sU",
- "result": true
- }
- ]
- },
- {
- "given": {
- "VH2&H\\\/": true
- },
- "cases": [
- {
- "expression": "\"VH2&H\\\\\\/\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "_C": true
- },
- "cases": [
- {
- "expression": "_C",
- "result": true
- }
- ]
- },
- {
- "given": {
- "_": true
- },
- "cases": [
- {
- "expression": "_",
- "result": true
- }
- ]
- },
- {
- "given": {
- "<\t": true
- },
- "cases": [
- {
- "expression": "\"<\\t\"",
- "result": true
- }
- ]
- },
- {
- "given": {
- "\uD834\uDD1E": true
- },
- "cases": [
- {
- "expression": "\"\\uD834\\uDD1E\"",
- "result": true
- }
- ]
- }
-]
diff --git a/vendor/github.com/jmespath/go-jmespath/compliance/indices.json b/vendor/github.com/jmespath/go-jmespath/compliance/indices.json
deleted file mode 100644
index aa03b35d..00000000
--- a/vendor/github.com/jmespath/go-jmespath/compliance/indices.json
+++ /dev/null
@@ -1,346 +0,0 @@
-[{
- "given":
- {"foo": {"bar": ["zero", "one", "two"]}},
- "cases": [
- {
- "expression": "foo.bar[0]",
- "result": "zero"
- },
- {
- "expression": "foo.bar[1]",
- "result": "one"
- },
- {
- "expression": "foo.bar[2]",
- "result": "two"
- },
- {
- "expression": "foo.bar[3]",
- "result": null
- },
- {
- "expression": "foo.bar[-1]",
- "result": "two"
- },
- {
- "expression": "foo.bar[-2]",
- "result": "one"
- },
- {
- "expression": "foo.bar[-3]",
- "result": "zero"
- },
- {
- "expression": "foo.bar[-4]",
- "result": null
- }
- ]
-},
-{
- "given":
- {"foo": [{"bar": "one"}, {"bar": "two"}, {"bar": "three"}, {"notbar": "four"}]},
- "cases": [
- {
- "expression": "foo.bar",
- "result": null
- },
- {
- "expression": "foo[0].bar",
- "result": "one"
- },
- {
- "expression": "foo[1].bar",
- "result": "two"
- },
- {
- "expression": "foo[2].bar",
- "result": "three"
- },
- {
- "expression": "foo[3].notbar",
- "result": "four"
- },
- {
- "expression": "foo[3].bar",
- "result": null
- },
- {
- "expression": "foo[0]",
- "result": {"bar": "one"}
- },
- {
- "expression": "foo[1]",
- "result": {"bar": "two"}
- },
- {
- "expression": "foo[2]",
- "result": {"bar": "three"}
- },
- {
- "expression": "foo[3]",
- "result": {"notbar": "four"}
- },
- {
- "expression": "foo[4]",
- "result": null
- }
- ]
-},
-{
- "given": [
- "one", "two", "three"
- ],
- "cases": [
- {
- "expression": "[0]",
- "result": "one"
- },
- {
- "expression": "[1]",
- "result": "two"
- },
- {
- "expression": "[2]",
- "result": "three"
- },
- {
- "expression": "[-1]",
- "result": "three"
- },
- {
- "expression": "[-2]",
- "result": "two"
- },
- {
- "expression": "[-3]",
- "result": "one"
- }
- ]
-},
-{
- "given": {"reservations": [
- {"instances": [{"foo": 1}, {"foo": 2}]}
- ]},
- "cases": [
- {
- "expression": "reservations[].instances[].foo",
- "result": [1, 2]
- },
- {
- "expression": "reservations[].instances[].bar",
- "result": []
- },
- {
- "expression": "reservations[].notinstances[].foo",
- "result": []
- },
- {
- "expression": "reservations[].notinstances[].foo",
- "result": []
- }
- ]
-},
-{
- "given": {"reservations": [{
- "instances": [
- {"foo": [{"bar": 1}, {"bar": 2}, {"notbar": 3}, {"bar": 4}]},
- {"foo": [{"bar": 5}, {"bar": 6}, {"notbar": [7]}, {"bar": 8}]},
- {"foo": "bar"},
- {"notfoo": [{"bar": 20}, {"bar": 21}, {"notbar": [7]}, {"bar": 22}]},
- {"bar": [{"baz": [1]}, {"baz": [2]}, {"baz": [3]}, {"baz": [4]}]},
- {"baz": [{"baz": [1, 2]}, {"baz": []}, {"baz": []}, {"baz": [3, 4]}]},
- {"qux": [{"baz": []}, {"baz": [1, 2, 3]}, {"baz": [4]}, {"baz": []}]}
- ],
- "otherkey": {"foo": [{"bar": 1}, {"bar": 2}, {"notbar": 3}, {"bar": 4}]}
- }, {
- "instances": [
- {"a": [{"bar": 1}, {"bar": 2}, {"notbar": 3}, {"bar": 4}]},
- {"b": [{"bar": 5}, {"bar": 6}, {"notbar": [7]}, {"bar": 8}]},
- {"c": "bar"},
- {"notfoo": [{"bar": 23}, {"bar": 24}, {"notbar": [7]}, {"bar": 25}]},
- {"qux": [{"baz": []}, {"baz": [1, 2, 3]}, {"baz": [4]}, {"baz": []}]}
- ],
- "otherkey": {"foo": [{"bar": 1}, {"bar": 2}, {"notbar": 3}, {"bar": 4}]}
- }
- ]},
- "cases": [
- {
- "expression": "reservations[].instances[].foo[].bar",
- "result": [1, 2, 4, 5, 6, 8]
- },
- {
- "expression": "reservations[].instances[].foo[].baz",
- "result": []
- },
- {
- "expression": "reservations[].instances[].notfoo[].bar",
- "result": [20, 21, 22, 23, 24, 25]
- },
- {
- "expression": "reservations[].instances[].notfoo[].notbar",
- "result": [[7], [7]]
- },
- {
- "expression": "reservations[].notinstances[].foo",
- "result": []
- },
- {
- "expression": "reservations[].instances[].foo[].notbar",
- "result": [3, [7]]
- },
- {
- "expression": "reservations[].instances[].bar[].baz",
- "result": [[1], [2], [3], [4]]
- },
- {
- "expression": "reservations[].instances[].baz[].baz",
- "result": [[1, 2], [], [], [3, 4]]
- },
- {
- "expression": "reservations[].instances[].qux[].baz",
- "result": [[], [1, 2, 3], [4], [], [], [1, 2, 3], [4], []]
- },
- {
- "expression": "reservations[].instances[].qux[].baz[]",
- "result": [1, 2, 3, 4, 1, 2, 3, 4]
- }
- ]
-},
-{
- "given": {
- "foo": [
- [["one", "two"], ["three", "four"]],
- [["five", "six"], ["seven", "eight"]],
- [["nine"], ["ten"]]
- ]
- },
- "cases": [
- {
- "expression": "foo[]",
- "result": [["one", "two"], ["three", "four"], ["five", "six"],
- ["seven", "eight"], ["nine"], ["ten"]]
- },
- {
- "expression": "foo[][0]",
- "result": ["one", "three", "five", "seven", "nine", "ten"]
- },
- {
- "expression": "foo[][1]",
- "result": ["two", "four", "six", "eight"]
- },
- {
- "expression": "foo[][0][0]",
- "result": []
- },
- {
- "expression": "foo[][2][2]",
- "result": []
- },
- {
- "expression": "foo[][0][0][100]",
- "result": []
- }
- ]
-},
-{
- "given": {
- "foo": [{
- "bar": [
- {
- "qux": 2,
- "baz": 1
- },
- {
- "qux": 4,
- "baz": 3
- }
- ]
- },
- {
- "bar": [
- {
- "qux": 6,
- "baz": 5
- },
- {
- "qux": 8,
- "baz": 7
- }
- ]
- }
- ]
- },
- "cases": [
- {
- "expression": "foo",
- "result": [{"bar": [{"qux": 2, "baz": 1}, {"qux": 4, "baz": 3}]},
- {"bar": [{"qux": 6, "baz": 5}, {"qux": 8, "baz": 7}]}]
- },
- {
- "expression": "foo[]",
- "result": [{"bar": [{"qux": 2, "baz": 1}, {"qux": 4, "baz": 3}]},
- {"bar": [{"qux": 6, "baz": 5}, {"qux": 8, "baz": 7}]}]
- },
- {
- "expression": "foo[].bar",
- "result": [[{"qux": 2, "baz": 1}, {"qux": 4, "baz": 3}],
- [{"qux": 6, "baz": 5}, {"qux": 8, "baz": 7}]]
- },
- {
- "expression": "foo[].bar[]",
- "result": [{"qux": 2, "baz": 1}, {"qux": 4, "baz": 3},
- {"qux": 6, "baz": 5}, {"qux": 8, "baz": 7}]
- },
- {
- "expression": "foo[].bar[].baz",
- "result": [1, 3, 5, 7]
- }
- ]
-},
-{
- "given": {
- "string": "string",
- "hash": {"foo": "bar", "bar": "baz"},
- "number": 23,
- "nullvalue": null
- },
- "cases": [
- {
- "expression": "string[]",
- "result": null
- },
- {
- "expression": "hash[]",
- "result": null
- },
- {
- "expression": "number[]",
- "result": null
- },
- {
- "expression": "nullvalue[]",
- "result": null
- },
- {
- "expression": "string[].foo",
- "result": null
- },
- {
- "expression": "hash[].foo",
- "result": null
- },
- {
- "expression": "number[].foo",
- "result": null
- },
- {
- "expression": "nullvalue[].foo",
- "result": null
- },
- {
- "expression": "nullvalue[].foo[].bar",
- "result": null
- }
- ]
-}
-]
diff --git a/vendor/github.com/jmespath/go-jmespath/compliance/literal.json b/vendor/github.com/jmespath/go-jmespath/compliance/literal.json
deleted file mode 100644
index c6706b97..00000000
--- a/vendor/github.com/jmespath/go-jmespath/compliance/literal.json
+++ /dev/null
@@ -1,185 +0,0 @@
-[
- {
- "given": {
- "foo": [{"name": "a"}, {"name": "b"}],
- "bar": {"baz": "qux"}
- },
- "cases": [
- {
- "expression": "`\"foo\"`",
- "result": "foo"
- },
- {
- "comment": "Interpret escaped unicode.",
- "expression": "`\"\\u03a6\"`",
- "result": "Φ"
- },
- {
- "expression": "`\"✓\"`",
- "result": "✓"
- },
- {
- "expression": "`[1, 2, 3]`",
- "result": [1, 2, 3]
- },
- {
- "expression": "`{\"a\": \"b\"}`",
- "result": {"a": "b"}
- },
- {
- "expression": "`true`",
- "result": true
- },
- {
- "expression": "`false`",
- "result": false
- },
- {
- "expression": "`null`",
- "result": null
- },
- {
- "expression": "`0`",
- "result": 0
- },
- {
- "expression": "`1`",
- "result": 1
- },
- {
- "expression": "`2`",
- "result": 2
- },
- {
- "expression": "`3`",
- "result": 3
- },
- {
- "expression": "`4`",
- "result": 4
- },
- {
- "expression": "`5`",
- "result": 5
- },
- {
- "expression": "`6`",
- "result": 6
- },
- {
- "expression": "`7`",
- "result": 7
- },
- {
- "expression": "`8`",
- "result": 8
- },
- {
- "expression": "`9`",
- "result": 9
- },
- {
- "comment": "Escaping a backtick in quotes",
- "expression": "`\"foo\\`bar\"`",
- "result": "foo`bar"
- },
- {
- "comment": "Double quote in literal",
- "expression": "`\"foo\\\"bar\"`",
- "result": "foo\"bar"
- },
- {
- "expression": "`\"1\\`\"`",
- "result": "1`"
- },
- {
- "comment": "Multiple literal expressions with escapes",
- "expression": "`\"\\\\\"`.{a:`\"b\"`}",
- "result": {"a": "b"}
- },
- {
- "comment": "literal . identifier",
- "expression": "`{\"a\": \"b\"}`.a",
- "result": "b"
- },
- {
- "comment": "literal . identifier . identifier",
- "expression": "`{\"a\": {\"b\": \"c\"}}`.a.b",
- "result": "c"
- },
- {
- "comment": "literal . identifier bracket-expr",
- "expression": "`[0, 1, 2]`[1]",
- "result": 1
- }
- ]
- },
- {
- "comment": "Literals",
- "given": {"type": "object"},
- "cases": [
- {
- "comment": "Literal with leading whitespace",
- "expression": "` {\"foo\": true}`",
- "result": {"foo": true}
- },
- {
- "comment": "Literal with trailing whitespace",
- "expression": "`{\"foo\": true} `",
- "result": {"foo": true}
- },
- {
- "comment": "Literal on RHS of subexpr not allowed",
- "expression": "foo.`\"bar\"`",
- "error": "syntax"
- }
- ]
- },
- {
- "comment": "Raw String Literals",
- "given": {},
- "cases": [
- {
- "expression": "'foo'",
- "result": "foo"
- },
- {
- "expression": "' foo '",
- "result": " foo "
- },
- {
- "expression": "'0'",
- "result": "0"
- },
- {
- "expression": "'newline\n'",
- "result": "newline\n"
- },
- {
- "expression": "'\n'",
- "result": "\n"
- },
- {
- "expression": "'✓'",
- "result": "✓"
- },
- {
- "expression": "'𝄞'",
- "result": "𝄞"
- },
- {
- "expression": "' [foo] '",
- "result": " [foo] "
- },
- {
- "expression": "'[foo]'",
- "result": "[foo]"
- },
- {
- "comment": "Do not interpret escaped unicode.",
- "expression": "'\\u03a6'",
- "result": "\\u03a6"
- }
- ]
- }
-]
diff --git a/vendor/github.com/jmespath/go-jmespath/compliance/multiselect.json b/vendor/github.com/jmespath/go-jmespath/compliance/multiselect.json
deleted file mode 100644
index 8f2a481e..00000000
--- a/vendor/github.com/jmespath/go-jmespath/compliance/multiselect.json
+++ /dev/null
@@ -1,393 +0,0 @@
-[{
- "given": {
- "foo": {
- "bar": "bar",
- "baz": "baz",
- "qux": "qux",
- "nested": {
- "one": {
- "a": "first",
- "b": "second",
- "c": "third"
- },
- "two": {
- "a": "first",
- "b": "second",
- "c": "third"
- },
- "three": {
- "a": "first",
- "b": "second",
- "c": {"inner": "third"}
- }
- }
- },
- "bar": 1,
- "baz": 2,
- "qux\"": 3
- },
- "cases": [
- {
- "expression": "foo.{bar: bar}",
- "result": {"bar": "bar"}
- },
- {
- "expression": "foo.{\"bar\": bar}",
- "result": {"bar": "bar"}
- },
- {
- "expression": "foo.{\"foo.bar\": bar}",
- "result": {"foo.bar": "bar"}
- },
- {
- "expression": "foo.{bar: bar, baz: baz}",
- "result": {"bar": "bar", "baz": "baz"}
- },
- {
- "expression": "foo.{\"bar\": bar, \"baz\": baz}",
- "result": {"bar": "bar", "baz": "baz"}
- },
- {
- "expression": "{\"baz\": baz, \"qux\\\"\": \"qux\\\"\"}",
- "result": {"baz": 2, "qux\"": 3}
- },
- {
- "expression": "foo.{bar:bar,baz:baz}",
- "result": {"bar": "bar", "baz": "baz"}
- },
- {
- "expression": "foo.{bar: bar,qux: qux}",
- "result": {"bar": "bar", "qux": "qux"}
- },
- {
- "expression": "foo.{bar: bar, noexist: noexist}",
- "result": {"bar": "bar", "noexist": null}
- },
- {
- "expression": "foo.{noexist: noexist, alsonoexist: alsonoexist}",
- "result": {"noexist": null, "alsonoexist": null}
- },
- {
- "expression": "foo.badkey.{nokey: nokey, alsonokey: alsonokey}",
- "result": null
- },
- {
- "expression": "foo.nested.*.{a: a,b: b}",
- "result": [{"a": "first", "b": "second"},
- {"a": "first", "b": "second"},
- {"a": "first", "b": "second"}]
- },
- {
- "expression": "foo.nested.three.{a: a, cinner: c.inner}",
- "result": {"a": "first", "cinner": "third"}
- },
- {
- "expression": "foo.nested.three.{a: a, c: c.inner.bad.key}",
- "result": {"a": "first", "c": null}
- },
- {
- "expression": "foo.{a: nested.one.a, b: nested.two.b}",
- "result": {"a": "first", "b": "second"}
- },
- {
- "expression": "{bar: bar, baz: baz}",
- "result": {"bar": 1, "baz": 2}
- },
- {
- "expression": "{bar: bar}",
- "result": {"bar": 1}
- },
- {
- "expression": "{otherkey: bar}",
- "result": {"otherkey": 1}
- },
- {
- "expression": "{no: no, exist: exist}",
- "result": {"no": null, "exist": null}
- },
- {
- "expression": "foo.[bar]",
- "result": ["bar"]
- },
- {
- "expression": "foo.[bar,baz]",
- "result": ["bar", "baz"]
- },
- {
- "expression": "foo.[bar,qux]",
- "result": ["bar", "qux"]
- },
- {
- "expression": "foo.[bar,noexist]",
- "result": ["bar", null]
- },
- {
- "expression": "foo.[noexist,alsonoexist]",
- "result": [null, null]
- }
- ]
-}, {
- "given": {
- "foo": {"bar": 1, "baz": [2, 3, 4]}
- },
- "cases": [
- {
- "expression": "foo.{bar:bar,baz:baz}",
- "result": {"bar": 1, "baz": [2, 3, 4]}
- },
- {
- "expression": "foo.[bar,baz[0]]",
- "result": [1, 2]
- },
- {
- "expression": "foo.[bar,baz[1]]",
- "result": [1, 3]
- },
- {
- "expression": "foo.[bar,baz[2]]",
- "result": [1, 4]
- },
- {
- "expression": "foo.[bar,baz[3]]",
- "result": [1, null]
- },
- {
- "expression": "foo.[bar[0],baz[3]]",
- "result": [null, null]
- }
- ]
-}, {
- "given": {
- "foo": {"bar": 1, "baz": 2}
- },
- "cases": [
- {
- "expression": "foo.{bar: bar, baz: baz}",
- "result": {"bar": 1, "baz": 2}
- },
- {
- "expression": "foo.[bar,baz]",
- "result": [1, 2]
- }
- ]
-}, {
- "given": {
- "foo": {
- "bar": {"baz": [{"common": "first", "one": 1},
- {"common": "second", "two": 2}]},
- "ignoreme": 1,
- "includeme": true
- }
- },
- "cases": [
- {
- "expression": "foo.{bar: bar.baz[1],includeme: includeme}",
- "result": {"bar": {"common": "second", "two": 2}, "includeme": true}
- },
- {
- "expression": "foo.{\"bar.baz.two\": bar.baz[1].two, includeme: includeme}",
- "result": {"bar.baz.two": 2, "includeme": true}
- },
- {
- "expression": "foo.[includeme, bar.baz[*].common]",
- "result": [true, ["first", "second"]]
- },
- {
- "expression": "foo.[includeme, bar.baz[*].none]",
- "result": [true, []]
- },
- {
- "expression": "foo.[includeme, bar.baz[].common]",
- "result": [true, ["first", "second"]]
- }
- ]
-}, {
- "given": {
- "reservations": [{
- "instances": [
- {"id": "id1",
- "name": "first"},
- {"id": "id2",
- "name": "second"}
- ]}, {
- "instances": [
- {"id": "id3",
- "name": "third"},
- {"id": "id4",
- "name": "fourth"}
- ]}
- ]},
- "cases": [
- {
- "expression": "reservations[*].instances[*].{id: id, name: name}",
- "result": [[{"id": "id1", "name": "first"}, {"id": "id2", "name": "second"}],
- [{"id": "id3", "name": "third"}, {"id": "id4", "name": "fourth"}]]
- },
- {
- "expression": "reservations[].instances[].{id: id, name: name}",
- "result": [{"id": "id1", "name": "first"},
- {"id": "id2", "name": "second"},
- {"id": "id3", "name": "third"},
- {"id": "id4", "name": "fourth"}]
- },
- {
- "expression": "reservations[].instances[].[id, name]",
- "result": [["id1", "first"],
- ["id2", "second"],
- ["id3", "third"],
- ["id4", "fourth"]]
- }
- ]
-},
-{
- "given": {
- "foo": [{
- "bar": [
- {
- "qux": 2,
- "baz": 1
- },
- {
- "qux": 4,
- "baz": 3
- }
- ]
- },
- {
- "bar": [
- {
- "qux": 6,
- "baz": 5
- },
- {
- "qux": 8,
- "baz": 7
- }
- ]
- }
- ]
- },
- "cases": [
- {
- "expression": "foo",
- "result": [{"bar": [{"qux": 2, "baz": 1}, {"qux": 4, "baz": 3}]},
- {"bar": [{"qux": 6, "baz": 5}, {"qux": 8, "baz": 7}]}]
- },
- {
- "expression": "foo[]",
- "result": [{"bar": [{"qux": 2, "baz": 1}, {"qux": 4, "baz": 3}]},
- {"bar": [{"qux": 6, "baz": 5}, {"qux": 8, "baz": 7}]}]
- },
- {
- "expression": "foo[].bar",
- "result": [[{"qux": 2, "baz": 1}, {"qux": 4, "baz": 3}],
- [{"qux": 6, "baz": 5}, {"qux": 8, "baz": 7}]]
- },
- {
- "expression": "foo[].bar[]",
- "result": [{"qux": 2, "baz": 1}, {"qux": 4, "baz": 3},
- {"qux": 6, "baz": 5}, {"qux": 8, "baz": 7}]
- },
- {
- "expression": "foo[].bar[].[baz, qux]",
- "result": [[1, 2], [3, 4], [5, 6], [7, 8]]
- },
- {
- "expression": "foo[].bar[].[baz]",
- "result": [[1], [3], [5], [7]]
- },
- {
- "expression": "foo[].bar[].[baz, qux][]",
- "result": [1, 2, 3, 4, 5, 6, 7, 8]
- }
- ]
-},
-{
- "given": {
- "foo": {
- "baz": [
- {
- "bar": "abc"
- }, {
- "bar": "def"
- }
- ],
- "qux": ["zero"]
- }
- },
- "cases": [
- {
- "expression": "foo.[baz[*].bar, qux[0]]",
- "result": [["abc", "def"], "zero"]
- }
- ]
-},
-{
- "given": {
- "foo": {
- "baz": [
- {
- "bar": "a",
- "bam": "b",
- "boo": "c"
- }, {
- "bar": "d",
- "bam": "e",
- "boo": "f"
- }
- ],
- "qux": ["zero"]
- }
- },
- "cases": [
- {
- "expression": "foo.[baz[*].[bar, boo], qux[0]]",
- "result": [[["a", "c" ], ["d", "f" ]], "zero"]
- }
- ]
-},
-{
- "given": {
- "foo": {
- "baz": [
- {
- "bar": "a",
- "bam": "b",
- "boo": "c"
- }, {
- "bar": "d",
- "bam": "e",
- "boo": "f"
- }
- ],
- "qux": ["zero"]
- }
- },
- "cases": [
- {
- "expression": "foo.[baz[*].not_there || baz[*].bar, qux[0]]",
- "result": [["a", "d"], "zero"]
- }
- ]
-},
-{
- "given": {"type": "object"},
- "cases": [
- {
- "comment": "Nested multiselect",
- "expression": "[[*],*]",
- "result": [null, ["object"]]
- }
- ]
-},
-{
- "given": [],
- "cases": [
- {
- "comment": "Nested multiselect",
- "expression": "[[*]]",
- "result": [[]]
- }
- ]
-}
-]
diff --git a/vendor/github.com/jmespath/go-jmespath/compliance/ormatch.json b/vendor/github.com/jmespath/go-jmespath/compliance/ormatch.json
deleted file mode 100644
index 2127cf44..00000000
--- a/vendor/github.com/jmespath/go-jmespath/compliance/ormatch.json
+++ /dev/null
@@ -1,59 +0,0 @@
-[{
- "given":
- {"outer": {"foo": "foo", "bar": "bar", "baz": "baz"}},
- "cases": [
- {
- "expression": "outer.foo || outer.bar",
- "result": "foo"
- },
- {
- "expression": "outer.foo||outer.bar",
- "result": "foo"
- },
- {
- "expression": "outer.bar || outer.baz",
- "result": "bar"
- },
- {
- "expression": "outer.bar||outer.baz",
- "result": "bar"
- },
- {
- "expression": "outer.bad || outer.foo",
- "result": "foo"
- },
- {
- "expression": "outer.bad||outer.foo",
- "result": "foo"
- },
- {
- "expression": "outer.foo || outer.bad",
- "result": "foo"
- },
- {
- "expression": "outer.foo||outer.bad",
- "result": "foo"
- },
- {
- "expression": "outer.bad || outer.alsobad",
- "result": null
- },
- {
- "expression": "outer.bad||outer.alsobad",
- "result": null
- }
- ]
-}, {
- "given":
- {"outer": {"foo": "foo", "bool": false, "empty_list": [], "empty_string": ""}},
- "cases": [
- {
- "expression": "outer.empty_string || outer.foo",
- "result": "foo"
- },
- {
- "expression": "outer.nokey || outer.bool || outer.empty_list || outer.empty_string || outer.foo",
- "result": "foo"
- }
- ]
-}]
diff --git a/vendor/github.com/jmespath/go-jmespath/compliance/pipe.json b/vendor/github.com/jmespath/go-jmespath/compliance/pipe.json
deleted file mode 100644
index b10c0a49..00000000
--- a/vendor/github.com/jmespath/go-jmespath/compliance/pipe.json
+++ /dev/null
@@ -1,131 +0,0 @@
-[{
- "given": {
- "foo": {
- "bar": {
- "baz": "subkey"
- },
- "other": {
- "baz": "subkey"
- },
- "other2": {
- "baz": "subkey"
- },
- "other3": {
- "notbaz": ["a", "b", "c"]
- },
- "other4": {
- "notbaz": ["a", "b", "c"]
- }
- }
- },
- "cases": [
- {
- "expression": "foo.*.baz | [0]",
- "result": "subkey"
- },
- {
- "expression": "foo.*.baz | [1]",
- "result": "subkey"
- },
- {
- "expression": "foo.*.baz | [2]",
- "result": "subkey"
- },
- {
- "expression": "foo.bar.* | [0]",
- "result": "subkey"
- },
- {
- "expression": "foo.*.notbaz | [*]",
- "result": [["a", "b", "c"], ["a", "b", "c"]]
- },
- {
- "expression": "{\"a\": foo.bar, \"b\": foo.other} | *.baz",
- "result": ["subkey", "subkey"]
- }
- ]
-}, {
- "given": {
- "foo": {
- "bar": {
- "baz": "one"
- },
- "other": {
- "baz": "two"
- },
- "other2": {
- "baz": "three"
- },
- "other3": {
- "notbaz": ["a", "b", "c"]
- },
- "other4": {
- "notbaz": ["d", "e", "f"]
- }
- }
- },
- "cases": [
- {
- "expression": "foo | bar",
- "result": {"baz": "one"}
- },
- {
- "expression": "foo | bar | baz",
- "result": "one"
- },
- {
- "expression": "foo|bar| baz",
- "result": "one"
- },
- {
- "expression": "not_there | [0]",
- "result": null
- },
- {
- "expression": "not_there | [0]",
- "result": null
- },
- {
- "expression": "[foo.bar, foo.other] | [0]",
- "result": {"baz": "one"}
- },
- {
- "expression": "{\"a\": foo.bar, \"b\": foo.other} | a",
- "result": {"baz": "one"}
- },
- {
- "expression": "{\"a\": foo.bar, \"b\": foo.other} | b",
- "result": {"baz": "two"}
- },
- {
- "expression": "foo.bam || foo.bar | baz",
- "result": "one"
- },
- {
- "expression": "foo | not_there || bar",
- "result": {"baz": "one"}
- }
- ]
-}, {
- "given": {
- "foo": [{
- "bar": [{
- "baz": "one"
- }, {
- "baz": "two"
- }]
- }, {
- "bar": [{
- "baz": "three"
- }, {
- "baz": "four"
- }]
- }]
- },
- "cases": [
- {
- "expression": "foo[*].bar[*] | [0][0]",
- "result": {"baz": "one"}
- }
- ]
-}]
diff --git a/vendor/github.com/jmespath/go-jmespath/compliance/slice.json b/vendor/github.com/jmespath/go-jmespath/compliance/slice.json
deleted file mode 100644
index 35947727..00000000
--- a/vendor/github.com/jmespath/go-jmespath/compliance/slice.json
+++ /dev/null
@@ -1,187 +0,0 @@
-[{
- "given": {
- "foo": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9],
- "bar": {
- "baz": 1
- }
- },
- "cases": [
- {
- "expression": "bar[0:10]",
- "result": null
- },
- {
- "expression": "foo[0:10:1]",
- "result": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
- },
- {
- "expression": "foo[0:10]",
- "result": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
- },
- {
- "expression": "foo[0:10:]",
- "result": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
- },
- {
- "expression": "foo[0::1]",
- "result": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
- },
- {
- "expression": "foo[0::]",
- "result": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
- },
- {
- "expression": "foo[0:]",
- "result": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
- },
- {
- "expression": "foo[:10:1]",
- "result": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
- },
- {
- "expression": "foo[::1]",
- "result": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
- },
- {
- "expression": "foo[:10:]",
- "result": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
- },
- {
- "expression": "foo[::]",
- "result": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
- },
- {
- "expression": "foo[:]",
- "result": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
- },
- {
- "expression": "foo[1:9]",
- "result": [1, 2, 3, 4, 5, 6, 7, 8]
- },
- {
- "expression": "foo[0:10:2]",
- "result": [0, 2, 4, 6, 8]
- },
- {
- "expression": "foo[5:]",
- "result": [5, 6, 7, 8, 9]
- },
- {
- "expression": "foo[5::2]",
- "result": [5, 7, 9]
- },
- {
- "expression": "foo[::2]",
- "result": [0, 2, 4, 6, 8]
- },
- {
- "expression": "foo[::-1]",
- "result": [9, 8, 7, 6, 5, 4, 3, 2, 1, 0]
- },
- {
- "expression": "foo[1::2]",
- "result": [1, 3, 5, 7, 9]
- },
- {
- "expression": "foo[10:0:-1]",
- "result": [9, 8, 7, 6, 5, 4, 3, 2, 1]
- },
- {
- "expression": "foo[10:5:-1]",
- "result": [9, 8, 7, 6]
- },
- {
- "expression": "foo[8:2:-2]",
- "result": [8, 6, 4]
- },
- {
- "expression": "foo[0:20]",
- "result": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
- },
- {
- "expression": "foo[10:-20:-1]",
- "result": [9, 8, 7, 6, 5, 4, 3, 2, 1, 0]
- },
- {
- "expression": "foo[10:-20]",
- "result": []
- },
- {
- "expression": "foo[-4:-1]",
- "result": [6, 7, 8]
- },
- {
- "expression": "foo[:-5:-1]",
- "result": [9, 8, 7, 6]
- },
- {
- "expression": "foo[8:2:0]",
- "error": "invalid-value"
- },
- {
- "expression": "foo[8:2:0:1]",
- "error": "syntax"
- },
- {
- "expression": "foo[8:2&]",
- "error": "syntax"
- },
- {
- "expression": "foo[2:a:3]",
- "error": "syntax"
- }
- ]
-}, {
- "given": {
- "foo": [{"a": 1}, {"a": 2}, {"a": 3}],
- "bar": [{"a": {"b": 1}}, {"a": {"b": 2}},
- {"a": {"b": 3}}],
- "baz": 50
- },
- "cases": [
- {
- "expression": "foo[:2].a",
- "result": [1, 2]
- },
- {
- "expression": "foo[:2].b",
- "result": []
- },
- {
- "expression": "foo[:2].a.b",
- "result": []
- },
- {
- "expression": "bar[::-1].a.b",
- "result": [3, 2, 1]
- },
- {
- "expression": "bar[:2].a.b",
- "result": [1, 2]
- },
- {
- "expression": "baz[:2].a",
- "result": null
- }
- ]
-}, {
- "given": [{"a": 1}, {"a": 2}, {"a": 3}],
- "cases": [
- {
- "expression": "[:]",
- "result": [{"a": 1}, {"a": 2}, {"a": 3}]
- },
- {
- "expression": "[:2].a",
- "result": [1, 2]
- },
- {
- "expression": "[::-1].a",
- "result": [3, 2, 1]
- },
- {
- "expression": "[:2].b",
- "result": []
- }
- ]
-}]
diff --git a/vendor/github.com/jmespath/go-jmespath/compliance/syntax.json b/vendor/github.com/jmespath/go-jmespath/compliance/syntax.json
deleted file mode 100644
index 003c2945..00000000
--- a/vendor/github.com/jmespath/go-jmespath/compliance/syntax.json
+++ /dev/null
@@ -1,616 +0,0 @@
-[{
- "comment": "Dot syntax",
- "given": {"type": "object"},
- "cases": [
- {
- "expression": "foo.bar",
- "result": null
- },
- {
- "expression": "foo.1",
- "error": "syntax"
- },
- {
- "expression": "foo.-11",
- "error": "syntax"
- },
- {
- "expression": "foo",
- "result": null
- },
- {
- "expression": "foo.",
- "error": "syntax"
- },
- {
- "expression": "foo.",
- "error": "syntax"
- },
- {
- "expression": ".foo",
- "error": "syntax"
- },
- {
- "expression": "foo..bar",
- "error": "syntax"
- },
- {
- "expression": "foo.bar.",
- "error": "syntax"
- },
- {
- "expression": "foo[.]",
- "error": "syntax"
- }
- ]
-},
- {
- "comment": "Simple token errors",
- "given": {"type": "object"},
- "cases": [
- {
- "expression": ".",
- "error": "syntax"
- },
- {
- "expression": ":",
- "error": "syntax"
- },
- {
- "expression": ",",
- "error": "syntax"
- },
- {
- "expression": "]",
- "error": "syntax"
- },
- {
- "expression": "[",
- "error": "syntax"
- },
- {
- "expression": "}",
- "error": "syntax"
- },
- {
- "expression": "{",
- "error": "syntax"
- },
- {
- "expression": ")",
- "error": "syntax"
- },
- {
- "expression": "(",
- "error": "syntax"
- },
- {
- "expression": "((&",
- "error": "syntax"
- },
- {
- "expression": "a[",
- "error": "syntax"
- },
- {
- "expression": "a]",
- "error": "syntax"
- },
- {
- "expression": "a][",
- "error": "syntax"
- },
- {
- "expression": "!",
- "error": "syntax"
- }
- ]
- },
- {
- "comment": "Boolean syntax errors",
- "given": {"type": "object"},
- "cases": [
- {
- "expression": "![!(!",
- "error": "syntax"
- }
- ]
- },
- {
- "comment": "Wildcard syntax",
- "given": {"type": "object"},
- "cases": [
- {
- "expression": "*",
- "result": ["object"]
- },
- {
- "expression": "*.*",
- "result": []
- },
- {
- "expression": "*.foo",
- "result": []
- },
- {
- "expression": "*[0]",
- "result": []
- },
- {
- "expression": ".*",
- "error": "syntax"
- },
- {
- "expression": "*foo",
- "error": "syntax"
- },
- {
- "expression": "*0",
- "error": "syntax"
- },
- {
- "expression": "foo[*]bar",
- "error": "syntax"
- },
- {
- "expression": "foo[*]*",
- "error": "syntax"
- }
- ]
- },
- {
- "comment": "Flatten syntax",
- "given": {"type": "object"},
- "cases": [
- {
- "expression": "[]",
- "result": null
- }
- ]
- },
- {
- "comment": "Simple bracket syntax",
- "given": {"type": "object"},
- "cases": [
- {
- "expression": "[0]",
- "result": null
- },
- {
- "expression": "[*]",
- "result": null
- },
- {
- "expression": "*.[0]",
- "error": "syntax"
- },
- {
- "expression": "*.[\"0\"]",
- "result": [[null]]
- },
- {
- "expression": "[*].bar",
- "result": null
- },
- {
- "expression": "[*][0]",
- "result": null
- },
- {
- "expression": "foo[#]",
- "error": "syntax"
- }
- ]
- },
- {
- "comment": "Multi-select list syntax",
- "given": {"type": "object"},
- "cases": [
- {
- "expression": "foo[0]",
- "result": null
- },
- {
- "comment": "Valid multi-select of a list",
- "expression": "foo[0, 1]",
- "error": "syntax"
- },
- {
- "expression": "foo.[0]",
- "error": "syntax"
- },
- {
- "expression": "foo.[*]",
- "result": null
- },
- {
- "comment": "Multi-select of a list with trailing comma",
- "expression": "foo[0, ]",
- "error": "syntax"
- },
- {
- "comment": "Multi-select of a list with trailing comma and no close",
- "expression": "foo[0,",
- "error": "syntax"
- },
- {
- "comment": "Multi-select of a list with trailing comma and no close",
- "expression": "foo.[a",
- "error": "syntax"
- },
- {
- "comment": "Multi-select of a list with extra comma",
- "expression": "foo[0,, 1]",
- "error": "syntax"
- },
- {
- "comment": "Multi-select of a list using an identifier index",
- "expression": "foo[abc]",
- "error": "syntax"
- },
- {
- "comment": "Multi-select of a list using identifier indices",
- "expression": "foo[abc, def]",
- "error": "syntax"
- },
- {
- "comment": "Multi-select of a list using an identifier index",
- "expression": "foo[abc, 1]",
- "error": "syntax"
- },
- {
- "comment": "Multi-select of a list using an identifier index with trailing comma",
- "expression": "foo[abc, ]",
- "error": "syntax"
- },
- {
- "comment": "Valid multi-select of a hash using an identifier index",
- "expression": "foo.[abc]",
- "result": null
- },
- {
- "comment": "Valid multi-select of a hash",
- "expression": "foo.[abc, def]",
- "result": null
- },
- {
- "comment": "Multi-select of a hash using a numeric index",
- "expression": "foo.[abc, 1]",
- "error": "syntax"
- },
- {
- "comment": "Multi-select of a hash with a trailing comma",
- "expression": "foo.[abc, ]",
- "error": "syntax"
- },
- {
- "comment": "Multi-select of a hash with extra commas",
- "expression": "foo.[abc,, def]",
- "error": "syntax"
- },
- {
- "comment": "Multi-select of a hash using number indices",
- "expression": "foo.[0, 1]",
- "error": "syntax"
- }
- ]
- },
- {
- "comment": "Multi-select hash syntax",
- "given": {"type": "object"},
- "cases": [
- {
- "comment": "No key or value",
- "expression": "a{}",
- "error": "syntax"
- },
- {
- "comment": "No closing token",
- "expression": "a{",
- "error": "syntax"
- },
- {
- "comment": "Not a key value pair",
- "expression": "a{foo}",
- "error": "syntax"
- },
- {
- "comment": "Missing value and closing character",
- "expression": "a{foo:",
- "error": "syntax"
- },
- {
- "comment": "Missing closing character",
- "expression": "a{foo: 0",
- "error": "syntax"
- },
- {
- "comment": "Missing value",
- "expression": "a{foo:}",
- "error": "syntax"
- },
- {
- "comment": "Trailing comma and no closing character",
- "expression": "a{foo: 0, ",
- "error": "syntax"
- },
- {
- "comment": "Missing value with trailing comma",
- "expression": "a{foo: ,}",
- "error": "syntax"
- },
- {
- "comment": "Accessing Array using an identifier",
- "expression": "a{foo: bar}",
- "error": "syntax"
- },
- {
- "expression": "a{foo: 0}",
- "error": "syntax"
- },
- {
- "comment": "Missing key-value pair",
- "expression": "a.{}",
- "error": "syntax"
- },
- {
- "comment": "Not a key-value pair",
- "expression": "a.{foo}",
- "error": "syntax"
- },
- {
- "comment": "Missing value",
- "expression": "a.{foo:}",
- "error": "syntax"
- },
- {
- "comment": "Missing value with trailing comma",
- "expression": "a.{foo: ,}",
- "error": "syntax"
- },
- {
- "comment": "Valid multi-select hash extraction",
- "expression": "a.{foo: bar}",
- "result": null
- },
- {
- "comment": "Valid multi-select hash extraction",
- "expression": "a.{foo: bar, baz: bam}",
- "result": null
- },
- {
- "comment": "Trailing comma",
- "expression": "a.{foo: bar, }",
- "error": "syntax"
- },
- {
- "comment": "Missing key in second key-value pair",
- "expression": "a.{foo: bar, baz}",
- "error": "syntax"
- },
- {
- "comment": "Missing value in second key-value pair",
- "expression": "a.{foo: bar, baz:}",
- "error": "syntax"
- },
- {
- "comment": "Trailing comma",
- "expression": "a.{foo: bar, baz: bam, }",
- "error": "syntax"
- },
- {
- "comment": "Nested multi select",
- "expression": "{\"\\\\\":{\" \":*}}",
- "result": {"\\": {" ": ["object"]}}
- }
- ]
- },
- {
- "comment": "Or expressions",
- "given": {"type": "object"},
- "cases": [
- {
- "expression": "foo || bar",
- "result": null
- },
- {
- "expression": "foo ||",
- "error": "syntax"
- },
- {
- "expression": "foo.|| bar",
- "error": "syntax"
- },
- {
- "expression": " || foo",
- "error": "syntax"
- },
- {
- "expression": "foo || || foo",
- "error": "syntax"
- },
- {
- "expression": "foo.[a || b]",
- "result": null
- },
- {
- "expression": "foo.[a ||]",
- "error": "syntax"
- },
- {
- "expression": "\"foo",
- "error": "syntax"
- }
- ]
- },
- {
- "comment": "Filter expressions",
- "given": {"type": "object"},
- "cases": [
- {
- "expression": "foo[?bar==`\"baz\"`]",
- "result": null
- },
- {
- "expression": "foo[? bar == `\"baz\"` ]",
- "result": null
- },
- {
- "expression": "foo[ ?bar==`\"baz\"`]",
- "error": "syntax"
- },
- {
- "expression": "foo[?bar==]",
- "error": "syntax"
- },
- {
- "expression": "foo[?==]",
- "error": "syntax"
- },
- {
- "expression": "foo[?==bar]",
- "error": "syntax"
- },
- {
- "expression": "foo[?bar==baz?]",
- "error": "syntax"
- },
- {
- "expression": "foo[?a.b.c==d.e.f]",
- "result": null
- },
- {
- "expression": "foo[?bar==`[0, 1, 2]`]",
- "result": null
- },
- {
- "expression": "foo[?bar==`[\"a\", \"b\", \"c\"]`]",
- "result": null
- },
- {
- "comment": "Literal char not escaped",
- "expression": "foo[?bar==`[\"foo`bar\"]`]",
- "error": "syntax"
- },
- {
- "comment": "Literal char escaped",
- "expression": "foo[?bar==`[\"foo\\`bar\"]`]",
- "result": null
- },
- {
- "comment": "Unknown comparator",
- "expression": "foo[?bar<>baz]",
- "error": "syntax"
- },
- {
- "comment": "Unknown comparator",
- "expression": "foo[?bar^baz]",
- "error": "syntax"
- },
- {
- "expression": "foo[bar==baz]",
- "error": "syntax"
- },
- {
- "comment": "Quoted identifier in filter expression no spaces",
- "expression": "[?\"\\\\\">`\"foo\"`]",
- "result": null
- },
- {
- "comment": "Quoted identifier in filter expression with spaces",
- "expression": "[?\"\\\\\" > `\"foo\"`]",
- "result": null
- }
- ]
- },
- {
- "comment": "Filter expression errors",
- "given": {"type": "object"},
- "cases": [
- {
- "expression": "bar.`\"anything\"`",
- "error": "syntax"
- },
- {
- "expression": "bar.baz.noexists.`\"literal\"`",
- "error": "syntax"
- },
- {
- "comment": "Literal wildcard projection",
- "expression": "foo[*].`\"literal\"`",
- "error": "syntax"
- },
- {
- "expression": "foo[*].name.`\"literal\"`",
- "error": "syntax"
- },
- {
- "expression": "foo[].name.`\"literal\"`",
- "error": "syntax"
- },
- {
- "expression": "foo[].name.`\"literal\"`.`\"subliteral\"`",
- "error": "syntax"
- },
- {
- "comment": "Projecting a literal onto an empty list",
- "expression": "foo[*].name.noexist.`\"literal\"`",
- "error": "syntax"
- },
- {
- "expression": "foo[].name.noexist.`\"literal\"`",
- "error": "syntax"
- },
- {
- "expression": "twolen[*].`\"foo\"`",
- "error": "syntax"
- },
- {
- "comment": "Two level projection of a literal",
- "expression": "twolen[*].threelen[*].`\"bar\"`",
- "error": "syntax"
- },
- {
- "comment": "Two level flattened projection of a literal",
- "expression": "twolen[].threelen[].`\"bar\"`",
- "error": "syntax"
- }
- ]
- },
- {
- "comment": "Identifiers",
- "given": {"type": "object"},
- "cases": [
- {
- "expression": "foo",
- "result": null
- },
- {
- "expression": "\"foo\"",
- "result": null
- },
- {
- "expression": "\"\\\\\"",
- "result": null
- }
- ]
- },
- {
- "comment": "Combined syntax",
- "given": [],
- "cases": [
- {
- "expression": "*||*|*|*",
- "result": null
- },
- {
- "expression": "*[]||[*]",
- "result": []
- },
- {
- "expression": "[*.*]",
- "result": [null]
- }
- ]
- }
-]
diff --git a/vendor/github.com/jmespath/go-jmespath/compliance/unicode.json b/vendor/github.com/jmespath/go-jmespath/compliance/unicode.json
deleted file mode 100644
index 6b07b0b6..00000000
--- a/vendor/github.com/jmespath/go-jmespath/compliance/unicode.json
+++ /dev/null
@@ -1,38 +0,0 @@
-[
- {
- "given": {"foo": [{"✓": "✓"}, {"✓": "✗"}]},
- "cases": [
- {
- "expression": "foo[].\"✓\"",
- "result": ["✓", "✗"]
- }
- ]
- },
- {
- "given": {"☯": true},
- "cases": [
- {
- "expression": "\"☯\"",
- "result": true
- }
- ]
- },
- {
- "given": {"♪♫•*¨*•.¸¸❤¸¸.•*¨*•♫♪": true},
- "cases": [
- {
- "expression": "\"♪♫•*¨*•.¸¸❤¸¸.•*¨*•♫♪\"",
- "result": true
- }
- ]
- },
- {
- "given": {"☃": true},
- "cases": [
- {
- "expression": "\"☃\"",
- "result": true
- }
- ]
- }
-]
diff --git a/vendor/github.com/jmespath/go-jmespath/compliance/wildcard.json b/vendor/github.com/jmespath/go-jmespath/compliance/wildcard.json
deleted file mode 100644
index 3bcec302..00000000
--- a/vendor/github.com/jmespath/go-jmespath/compliance/wildcard.json
+++ /dev/null
@@ -1,460 +0,0 @@
-[{
- "given": {
- "foo": {
- "bar": {
- "baz": "val"
- },
- "other": {
- "baz": "val"
- },
- "other2": {
- "baz": "val"
- },
- "other3": {
- "notbaz": ["a", "b", "c"]
- },
- "other4": {
- "notbaz": ["a", "b", "c"]
- },
- "other5": {
- "other": {
- "a": 1,
- "b": 1,
- "c": 1
- }
- }
- }
- },
- "cases": [
- {
- "expression": "foo.*.baz",
- "result": ["val", "val", "val"]
- },
- {
- "expression": "foo.bar.*",
- "result": ["val"]
- },
- {
- "expression": "foo.*.notbaz",
- "result": [["a", "b", "c"], ["a", "b", "c"]]
- },
- {
- "expression": "foo.*.notbaz[0]",
- "result": ["a", "a"]
- },
- {
- "expression": "foo.*.notbaz[-1]",
- "result": ["c", "c"]
- }
- ]
-}, {
- "given": {
- "foo": {
- "first-1": {
- "second-1": "val"
- },
- "first-2": {
- "second-1": "val"
- },
- "first-3": {
- "second-1": "val"
- }
- }
- },
- "cases": [
- {
- "expression": "foo.*",
- "result": [{"second-1": "val"}, {"second-1": "val"},
- {"second-1": "val"}]
- },
- {
- "expression": "foo.*.*",
- "result": [["val"], ["val"], ["val"]]
- },
- {
- "expression": "foo.*.*.*",
- "result": [[], [], []]
- },
- {
- "expression": "foo.*.*.*.*",
- "result": [[], [], []]
- }
- ]
-}, {
- "given": {
- "foo": {
- "bar": "one"
- },
- "other": {
- "bar": "one"
- },
- "nomatch": {
- "notbar": "three"
- }
- },
- "cases": [
- {
- "expression": "*.bar",
- "result": ["one", "one"]
- }
- ]
-}, {
- "given": {
- "top1": {
- "sub1": {"foo": "one"}
- },
- "top2": {
- "sub1": {"foo": "one"}
- }
- },
- "cases": [
- {
- "expression": "*",
- "result": [{"sub1": {"foo": "one"}},
- {"sub1": {"foo": "one"}}]
- },
- {
- "expression": "*.sub1",
- "result": [{"foo": "one"},
- {"foo": "one"}]
- },
- {
- "expression": "*.*",
- "result": [[{"foo": "one"}],
- [{"foo": "one"}]]
- },
- {
- "expression": "*.*.foo[]",
- "result": ["one", "one"]
- },
- {
- "expression": "*.sub1.foo",
- "result": ["one", "one"]
- }
- ]
-},
-{
- "given":
- {"foo": [{"bar": "one"}, {"bar": "two"}, {"bar": "three"}, {"notbar": "four"}]},
- "cases": [
- {
- "expression": "foo[*].bar",
- "result": ["one", "two", "three"]
- },
- {
- "expression": "foo[*].notbar",
- "result": ["four"]
- }
- ]
-},
-{
- "given":
- [{"bar": "one"}, {"bar": "two"}, {"bar": "three"}, {"notbar": "four"}],
- "cases": [
- {
- "expression": "[*]",
- "result": [{"bar": "one"}, {"bar": "two"}, {"bar": "three"}, {"notbar": "four"}]
- },
- {
- "expression": "[*].bar",
- "result": ["one", "two", "three"]
- },
- {
- "expression": "[*].notbar",
- "result": ["four"]
- }
- ]
-},
-{
- "given": {
- "foo": {
- "bar": [
- {"baz": ["one", "two", "three"]},
- {"baz": ["four", "five", "six"]},
- {"baz": ["seven", "eight", "nine"]}
- ]
- }
- },
- "cases": [
- {
- "expression": "foo.bar[*].baz",
- "result": [["one", "two", "three"], ["four", "five", "six"], ["seven", "eight", "nine"]]
- },
- {
- "expression": "foo.bar[*].baz[0]",
- "result": ["one", "four", "seven"]
- },
- {
- "expression": "foo.bar[*].baz[1]",
- "result": ["two", "five", "eight"]
- },
- {
- "expression": "foo.bar[*].baz[2]",
- "result": ["three", "six", "nine"]
- },
- {
- "expression": "foo.bar[*].baz[3]",
- "result": []
- }
- ]
-},
-{
- "given": {
- "foo": {
- "bar": [["one", "two"], ["three", "four"]]
- }
- },
- "cases": [
- {
- "expression": "foo.bar[*]",
- "result": [["one", "two"], ["three", "four"]]
- },
- {
- "expression": "foo.bar[0]",
- "result": ["one", "two"]
- },
- {
- "expression": "foo.bar[0][0]",
- "result": "one"
- },
- {
- "expression": "foo.bar[0][0][0]",
- "result": null
- },
- {
- "expression": "foo.bar[0][0][0][0]",
- "result": null
- },
- {
- "expression": "foo[0][0]",
- "result": null
- }
- ]
-},
-{
- "given": {
- "foo": [
- {"bar": [{"kind": "basic"}, {"kind": "intermediate"}]},
- {"bar": [{"kind": "advanced"}, {"kind": "expert"}]},
- {"bar": "string"}
- ]
-
- },
- "cases": [
- {
- "expression": "foo[*].bar[*].kind",
- "result": [["basic", "intermediate"], ["advanced", "expert"]]
- },
- {
- "expression": "foo[*].bar[0].kind",
- "result": ["basic", "advanced"]
- }
- ]
-},
-{
- "given": {
- "foo": [
- {"bar": {"kind": "basic"}},
- {"bar": {"kind": "intermediate"}},
- {"bar": {"kind": "advanced"}},
- {"bar": {"kind": "expert"}},
- {"bar": "string"}
- ]
- },
- "cases": [
- {
- "expression": "foo[*].bar.kind",
- "result": ["basic", "intermediate", "advanced", "expert"]
- }
- ]
-},
-{
- "given": {
- "foo": [{"bar": ["one", "two"]}, {"bar": ["three", "four"]}, {"bar": ["five"]}]
- },
- "cases": [
- {
- "expression": "foo[*].bar[0]",
- "result": ["one", "three", "five"]
- },
- {
- "expression": "foo[*].bar[1]",
- "result": ["two", "four"]
- },
- {
- "expression": "foo[*].bar[2]",
- "result": []
- }
- ]
-},
-{
- "given": {
- "foo": [{"bar": []}, {"bar": []}, {"bar": []}]
- },
- "cases": [
- {
- "expression": "foo[*].bar[0]",
- "result": []
- }
- ]
-},
-{
- "given": {
- "foo": [["one", "two"], ["three", "four"], ["five"]]
- },
- "cases": [
- {
- "expression": "foo[*][0]",
- "result": ["one", "three", "five"]
- },
- {
- "expression": "foo[*][1]",
- "result": ["two", "four"]
- }
- ]
-},
-{
- "given": {
- "foo": [
- [
- ["one", "two"], ["three", "four"]
- ], [
- ["five", "six"], ["seven", "eight"]
- ], [
- ["nine"], ["ten"]
- ]
- ]
- },
- "cases": [
- {
- "expression": "foo[*][0]",
- "result": [["one", "two"], ["five", "six"], ["nine"]]
- },
- {
- "expression": "foo[*][1]",
- "result": [["three", "four"], ["seven", "eight"], ["ten"]]
- },
- {
- "expression": "foo[*][0][0]",
- "result": ["one", "five", "nine"]
- },
- {
- "expression": "foo[*][1][0]",
- "result": ["three", "seven", "ten"]
- },
- {
- "expression": "foo[*][0][1]",
- "result": ["two", "six"]
- },
- {
- "expression": "foo[*][1][1]",
- "result": ["four", "eight"]
- },
- {
- "expression": "foo[*][2]",
- "result": []
- },
- {
- "expression": "foo[*][2][2]",
- "result": []
- },
- {
- "expression": "bar[*]",
- "result": null
- },
- {
- "expression": "bar[*].baz[*]",
- "result": null
- }
- ]
-},
-{
- "given": {
- "string": "string",
- "hash": {"foo": "bar", "bar": "baz"},
- "number": 23,
- "nullvalue": null
- },
- "cases": [
- {
- "expression": "string[*]",
- "result": null
- },
- {
- "expression": "hash[*]",
- "result": null
- },
- {
- "expression": "number[*]",
- "result": null
- },
- {
- "expression": "nullvalue[*]",
- "result": null
- },
- {
- "expression": "string[*].foo",
- "result": null
- },
- {
- "expression": "hash[*].foo",
- "result": null
- },
- {
- "expression": "number[*].foo",
- "result": null
- },
- {
- "expression": "nullvalue[*].foo",
- "result": null
- },
- {
- "expression": "nullvalue[*].foo[*].bar",
- "result": null
- }
- ]
-},
-{
- "given": {
- "string": "string",
- "hash": {"foo": "val", "bar": "val"},
- "number": 23,
- "array": [1, 2, 3],
- "nullvalue": null
- },
- "cases": [
- {
- "expression": "string.*",
- "result": null
- },
- {
- "expression": "hash.*",
- "result": ["val", "val"]
- },
- {
- "expression": "number.*",
- "result": null
- },
- {
- "expression": "array.*",
- "result": null
- },
- {
- "expression": "nullvalue.*",
- "result": null
- }
- ]
-},
-{
- "given": {
- "a": [0, 1, 2],
- "b": [0, 1, 2]
- },
- "cases": [
- {
- "expression": "*[0]",
- "result": [0, 0]
- }
- ]
-}
-]
diff --git a/vendor/github.com/jmespath/go-jmespath/fuzz/jmespath.go b/vendor/github.com/jmespath/go-jmespath/fuzz/jmespath.go
deleted file mode 100644
index c7df0878..00000000
--- a/vendor/github.com/jmespath/go-jmespath/fuzz/jmespath.go
+++ /dev/null
@@ -1,13 +0,0 @@
-package jmespath
-
-import "github.com/jmespath/go-jmespath"
-
-// Fuzz will fuzz test the JMESPath parser.
-func Fuzz(data []byte) int {
- p := jmespath.NewParser()
- _, err := p.Parse(string(data))
- if err != nil {
- return 1
- }
- return 0
-}
diff --git a/vendor/github.com/mitchellh/mapstructure/decode_hooks_test.go b/vendor/github.com/mitchellh/mapstructure/decode_hooks_test.go
deleted file mode 100644
index 53289afc..00000000
--- a/vendor/github.com/mitchellh/mapstructure/decode_hooks_test.go
+++ /dev/null
@@ -1,229 +0,0 @@
-package mapstructure
-
-import (
- "errors"
- "reflect"
- "testing"
- "time"
-)
-
-func TestComposeDecodeHookFunc(t *testing.T) {
- f1 := func(
- f reflect.Kind,
- t reflect.Kind,
- data interface{}) (interface{}, error) {
- return data.(string) + "foo", nil
- }
-
- f2 := func(
- f reflect.Kind,
- t reflect.Kind,
- data interface{}) (interface{}, error) {
- return data.(string) + "bar", nil
- }
-
- f := ComposeDecodeHookFunc(f1, f2)
-
- result, err := DecodeHookExec(
- f, reflect.TypeOf(""), reflect.TypeOf([]byte("")), "")
- if err != nil {
- t.Fatalf("bad: %s", err)
- }
- if result.(string) != "foobar" {
- t.Fatalf("bad: %#v", result)
- }
-}
-
-func TestComposeDecodeHookFunc_err(t *testing.T) {
- f1 := func(reflect.Kind, reflect.Kind, interface{}) (interface{}, error) {
- return nil, errors.New("foo")
- }
-
- f2 := func(reflect.Kind, reflect.Kind, interface{}) (interface{}, error) {
- panic("NOPE")
- }
-
- f := ComposeDecodeHookFunc(f1, f2)
-
- _, err := DecodeHookExec(
- f, reflect.TypeOf(""), reflect.TypeOf([]byte("")), 42)
- if err.Error() != "foo" {
- t.Fatalf("bad: %s", err)
- }
-}
-
-func TestComposeDecodeHookFunc_kinds(t *testing.T) {
- var f2From reflect.Kind
-
- f1 := func(
- f reflect.Kind,
- t reflect.Kind,
- data interface{}) (interface{}, error) {
- return int(42), nil
- }
-
- f2 := func(
- f reflect.Kind,
- t reflect.Kind,
- data interface{}) (interface{}, error) {
- f2From = f
- return data, nil
- }
-
- f := ComposeDecodeHookFunc(f1, f2)
-
- _, err := DecodeHookExec(
- f, reflect.TypeOf(""), reflect.TypeOf([]byte("")), "")
- if err != nil {
- t.Fatalf("bad: %s", err)
- }
- if f2From != reflect.Int {
- t.Fatalf("bad: %#v", f2From)
- }
-}
-
-func TestStringToSliceHookFunc(t *testing.T) {
- f := StringToSliceHookFunc(",")
-
- strType := reflect.TypeOf("")
- sliceType := reflect.TypeOf([]byte(""))
- cases := []struct {
- f, t reflect.Type
- data interface{}
- result interface{}
- err bool
- }{
- {sliceType, sliceType, 42, 42, false},
- {strType, strType, 42, 42, false},
- {
- strType,
- sliceType,
- "foo,bar,baz",
- []string{"foo", "bar", "baz"},
- false,
- },
- {
- strType,
- sliceType,
- "",
- []string{},
- false,
- },
- }
-
- for i, tc := range cases {
- actual, err := DecodeHookExec(f, tc.f, tc.t, tc.data)
- if tc.err != (err != nil) {
- t.Fatalf("case %d: expected err %#v", i, tc.err)
- }
- if !reflect.DeepEqual(actual, tc.result) {
- t.Fatalf(
- "case %d: expected %#v, got %#v",
- i, tc.result, actual)
- }
- }
-}
-
-func TestStringToTimeDurationHookFunc(t *testing.T) {
- f := StringToTimeDurationHookFunc()
-
- strType := reflect.TypeOf("")
- timeType := reflect.TypeOf(time.Duration(5))
- cases := []struct {
- f, t reflect.Type
- data interface{}
- result interface{}
- err bool
- }{
- {strType, timeType, "5s", 5 * time.Second, false},
- {strType, timeType, "5", time.Duration(0), true},
- {strType, strType, "5", "5", false},
- }
-
- for i, tc := range cases {
- actual, err := DecodeHookExec(f, tc.f, tc.t, tc.data)
- if tc.err != (err != nil) {
- t.Fatalf("case %d: expected err %#v", i, tc.err)
- }
- if !reflect.DeepEqual(actual, tc.result) {
- t.Fatalf(
- "case %d: expected %#v, got %#v",
- i, tc.result, actual)
- }
- }
-}
-
-func TestWeaklyTypedHook(t *testing.T) {
- var f DecodeHookFunc = WeaklyTypedHook
-
- boolType := reflect.TypeOf(true)
- strType := reflect.TypeOf("")
- sliceType := reflect.TypeOf([]byte(""))
- cases := []struct {
- f, t reflect.Type
- data interface{}
- result interface{}
- err bool
- }{
- // TO STRING
- {
- boolType,
- strType,
- false,
- "0",
- false,
- },
-
- {
- boolType,
- strType,
- true,
- "1",
- false,
- },
-
- {
- reflect.TypeOf(float32(1)),
- strType,
- float32(7),
- "7",
- false,
- },
-
- {
- reflect.TypeOf(int(1)),
- strType,
- int(7),
- "7",
- false,
- },
-
- {
- sliceType,
- strType,
- []uint8("foo"),
- "foo",
- false,
- },
-
- {
- reflect.TypeOf(uint(1)),
- strType,
- uint(7),
- "7",
- false,
- },
- }
-
- for i, tc := range cases {
- actual, err := DecodeHookExec(f, tc.f, tc.t, tc.data)
- if tc.err != (err != nil) {
- t.Fatalf("case %d: expected err %#v", i, tc.err)
- }
- if !reflect.DeepEqual(actual, tc.result) {
- t.Fatalf(
- "case %d: expected %#v, got %#v",
- i, tc.result, actual)
- }
- }
-}
diff --git a/vendor/github.com/mitchellh/mapstructure/mapstructure_benchmark_test.go b/vendor/github.com/mitchellh/mapstructure/mapstructure_benchmark_test.go
deleted file mode 100644
index b50ac36e..00000000
--- a/vendor/github.com/mitchellh/mapstructure/mapstructure_benchmark_test.go
+++ /dev/null
@@ -1,243 +0,0 @@
-package mapstructure
-
-import (
- "testing"
-)
-
-func Benchmark_Decode(b *testing.B) {
- type Person struct {
- Name string
- Age int
- Emails []string
- Extra map[string]string
- }
-
- input := map[string]interface{}{
- "name": "Mitchell",
- "age": 91,
- "emails": []string{"one", "two", "three"},
- "extra": map[string]string{
- "twitter": "mitchellh",
- },
- }
-
- var result Person
- for i := 0; i < b.N; i++ {
- Decode(input, &result)
- }
-}
-
-func Benchmark_DecodeBasic(b *testing.B) {
- input := map[string]interface{}{
- "vstring": "foo",
- "vint": 42,
- "Vuint": 42,
- "vbool": true,
- "Vfloat": 42.42,
- "vsilent": true,
- "vdata": 42,
- }
-
- var result Basic
- for i := 0; i < b.N; i++ {
- Decode(input, &result)
- }
-}
-
-func Benchmark_DecodeEmbedded(b *testing.B) {
- input := map[string]interface{}{
- "vstring": "foo",
- "Basic": map[string]interface{}{
- "vstring": "innerfoo",
- },
- "vunique": "bar",
- }
-
- var result Embedded
- for i := 0; i < b.N; i++ {
- Decode(input, &result)
- }
-}
-
-func Benchmark_DecodeTypeConversion(b *testing.B) {
- input := map[string]interface{}{
- "IntToFloat": 42,
- "IntToUint": 42,
- "IntToBool": 1,
- "IntToString": 42,
- "UintToInt": 42,
- "UintToFloat": 42,
- "UintToBool": 42,
- "UintToString": 42,
- "BoolToInt": true,
- "BoolToUint": true,
- "BoolToFloat": true,
- "BoolToString": true,
- "FloatToInt": 42.42,
- "FloatToUint": 42.42,
- "FloatToBool": 42.42,
- "FloatToString": 42.42,
- "StringToInt": "42",
- "StringToUint": "42",
- "StringToBool": "1",
- "StringToFloat": "42.42",
- "SliceToMap": []interface{}{},
- "MapToSlice": map[string]interface{}{},
- }
-
- var resultStrict TypeConversionResult
- for i := 0; i < b.N; i++ {
- Decode(input, &resultStrict)
- }
-}
-
-func Benchmark_DecodeMap(b *testing.B) {
- input := map[string]interface{}{
- "vfoo": "foo",
- "vother": map[interface{}]interface{}{
- "foo": "foo",
- "bar": "bar",
- },
- }
-
- var result Map
- for i := 0; i < b.N; i++ {
- Decode(input, &result)
- }
-}
-
-func Benchmark_DecodeMapOfStruct(b *testing.B) {
- input := map[string]interface{}{
- "value": map[string]interface{}{
- "foo": map[string]string{"vstring": "one"},
- "bar": map[string]string{"vstring": "two"},
- },
- }
-
- var result MapOfStruct
- for i := 0; i < b.N; i++ {
- Decode(input, &result)
- }
-}
-
-func Benchmark_DecodeSlice(b *testing.B) {
- input := map[string]interface{}{
- "vfoo": "foo",
- "vbar": []string{"foo", "bar", "baz"},
- }
-
- var result Slice
- for i := 0; i < b.N; i++ {
- Decode(input, &result)
- }
-}
-
-func Benchmark_DecodeSliceOfStruct(b *testing.B) {
- input := map[string]interface{}{
- "value": []map[string]interface{}{
- {"vstring": "one"},
- {"vstring": "two"},
- },
- }
-
- var result SliceOfStruct
- for i := 0; i < b.N; i++ {
- Decode(input, &result)
- }
-}
-
-func Benchmark_DecodeWeaklyTypedInput(b *testing.B) {
- type Person struct {
- Name string
- Age int
- Emails []string
- }
-
- // This input can come from anywhere, but typically comes from
- // something like decoding JSON, generated by a weakly typed language
- // such as PHP.
- input := map[string]interface{}{
- "name": 123, // number => string
- "age": "42", // string => number
- "emails": map[string]interface{}{}, // empty map => empty array
- }
-
- var result Person
- config := &DecoderConfig{
- WeaklyTypedInput: true,
- Result: &result,
- }
-
- decoder, err := NewDecoder(config)
- if err != nil {
- panic(err)
- }
-
- for i := 0; i < b.N; i++ {
- decoder.Decode(input)
- }
-}
-
-func Benchmark_DecodeMetadata(b *testing.B) {
- type Person struct {
- Name string
- Age int
- }
-
- input := map[string]interface{}{
- "name": "Mitchell",
- "age": 91,
- "email": "foo@bar.com",
- }
-
- var md Metadata
- var result Person
- config := &DecoderConfig{
- Metadata: &md,
- Result: &result,
- }
-
- decoder, err := NewDecoder(config)
- if err != nil {
- panic(err)
- }
-
- for i := 0; i < b.N; i++ {
- decoder.Decode(input)
- }
-}
-
-func Benchmark_DecodeMetadataEmbedded(b *testing.B) {
- input := map[string]interface{}{
- "vstring": "foo",
- "vunique": "bar",
- }
-
- var md Metadata
- var result EmbeddedSquash
- config := &DecoderConfig{
- Metadata: &md,
- Result: &result,
- }
-
- decoder, err := NewDecoder(config)
- if err != nil {
- b.Fatalf("err: %s", err)
- }
-
- for i := 0; i < b.N; i++ {
- decoder.Decode(input)
- }
-}
-
-func Benchmark_DecodeTagged(b *testing.B) {
- input := map[string]interface{}{
- "foo": "bar",
- "bar": "value",
- }
-
- var result Tagged
- for i := 0; i < b.N; i++ {
- Decode(input, &result)
- }
-}
diff --git a/vendor/github.com/mitchellh/mapstructure/mapstructure_bugs_test.go b/vendor/github.com/mitchellh/mapstructure/mapstructure_bugs_test.go
deleted file mode 100644
index 7054f1ac..00000000
--- a/vendor/github.com/mitchellh/mapstructure/mapstructure_bugs_test.go
+++ /dev/null
@@ -1,47 +0,0 @@
-package mapstructure
-
-import "testing"
-
-// GH-1
-func TestDecode_NilValue(t *testing.T) {
- input := map[string]interface{}{
- "vfoo": nil,
- "vother": nil,
- }
-
- var result Map
- err := Decode(input, &result)
- if err != nil {
- t.Fatalf("should not error: %s", err)
- }
-
- if result.Vfoo != "" {
- t.Fatalf("value should be default: %s", result.Vfoo)
- }
-
- if result.Vother != nil {
- t.Fatalf("Vother should be nil: %s", result.Vother)
- }
-}
-
-// GH-10
-func TestDecode_mapInterfaceInterface(t *testing.T) {
- input := map[interface{}]interface{}{
- "vfoo": nil,
- "vother": nil,
- }
-
- var result Map
- err := Decode(input, &result)
- if err != nil {
- t.Fatalf("should not error: %s", err)
- }
-
- if result.Vfoo != "" {
- t.Fatalf("value should be default: %s", result.Vfoo)
- }
-
- if result.Vother != nil {
- t.Fatalf("Vother should be nil: %s", result.Vother)
- }
-}
diff --git a/vendor/github.com/mitchellh/mapstructure/mapstructure_examples_test.go b/vendor/github.com/mitchellh/mapstructure/mapstructure_examples_test.go
deleted file mode 100644
index f17c214a..00000000
--- a/vendor/github.com/mitchellh/mapstructure/mapstructure_examples_test.go
+++ /dev/null
@@ -1,203 +0,0 @@
-package mapstructure
-
-import (
- "fmt"
-)
-
-func ExampleDecode() {
- type Person struct {
- Name string
- Age int
- Emails []string
- Extra map[string]string
- }
-
- // This input can come from anywhere, but typically comes from
- // something like decoding JSON where we're not quite sure of the
- // struct initially.
- input := map[string]interface{}{
- "name": "Mitchell",
- "age": 91,
- "emails": []string{"one", "two", "three"},
- "extra": map[string]string{
- "twitter": "mitchellh",
- },
- }
-
- var result Person
- err := Decode(input, &result)
- if err != nil {
- panic(err)
- }
-
- fmt.Printf("%#v", result)
- // Output:
- // mapstructure.Person{Name:"Mitchell", Age:91, Emails:[]string{"one", "two", "three"}, Extra:map[string]string{"twitter":"mitchellh"}}
-}
-
-func ExampleDecode_errors() {
- type Person struct {
- Name string
- Age int
- Emails []string
- Extra map[string]string
- }
-
- // This input can come from anywhere, but typically comes from
- // something like decoding JSON where we're not quite sure of the
- // struct initially.
- input := map[string]interface{}{
- "name": 123,
- "age": "bad value",
- "emails": []int{1, 2, 3},
- }
-
- var result Person
- err := Decode(input, &result)
- if err == nil {
- panic("should have an error")
- }
-
- fmt.Println(err.Error())
- // Output:
- // 5 error(s) decoding:
- //
- // * 'Age' expected type 'int', got unconvertible type 'string'
- // * 'Emails[0]' expected type 'string', got unconvertible type 'int'
- // * 'Emails[1]' expected type 'string', got unconvertible type 'int'
- // * 'Emails[2]' expected type 'string', got unconvertible type 'int'
- // * 'Name' expected type 'string', got unconvertible type 'int'
-}
-
-func ExampleDecode_metadata() {
- type Person struct {
- Name string
- Age int
- }
-
- // This input can come from anywhere, but typically comes from
- // something like decoding JSON where we're not quite sure of the
- // struct initially.
- input := map[string]interface{}{
- "name": "Mitchell",
- "age": 91,
- "email": "foo@bar.com",
- }
-
- // For metadata, we make a more advanced DecoderConfig so we can
- // more finely configure the decoder that is used. In this case, we
- // just tell the decoder we want to track metadata.
- var md Metadata
- var result Person
- config := &DecoderConfig{
- Metadata: &md,
- Result: &result,
- }
-
- decoder, err := NewDecoder(config)
- if err != nil {
- panic(err)
- }
-
- if err := decoder.Decode(input); err != nil {
- panic(err)
- }
-
- fmt.Printf("Unused keys: %#v", md.Unused)
- // Output:
- // Unused keys: []string{"email"}
-}
-
-func ExampleDecode_weaklyTypedInput() {
- type Person struct {
- Name string
- Age int
- Emails []string
- }
-
- // This input can come from anywhere, but typically comes from
- // something like decoding JSON, generated by a weakly typed language
- // such as PHP.
- input := map[string]interface{}{
- "name": 123, // number => string
- "age": "42", // string => number
- "emails": map[string]interface{}{}, // empty map => empty array
- }
-
- var result Person
- config := &DecoderConfig{
- WeaklyTypedInput: true,
- Result: &result,
- }
-
- decoder, err := NewDecoder(config)
- if err != nil {
- panic(err)
- }
-
- err = decoder.Decode(input)
- if err != nil {
- panic(err)
- }
-
- fmt.Printf("%#v", result)
- // Output: mapstructure.Person{Name:"123", Age:42, Emails:[]string{}}
-}
-
-func ExampleDecode_tags() {
- // Note that the mapstructure tags defined in the struct type
- // can indicate which fields the values are mapped to.
- type Person struct {
- Name string `mapstructure:"person_name"`
- Age int `mapstructure:"person_age"`
- }
-
- input := map[string]interface{}{
- "person_name": "Mitchell",
- "person_age": 91,
- }
-
- var result Person
- err := Decode(input, &result)
- if err != nil {
- panic(err)
- }
-
- fmt.Printf("%#v", result)
- // Output:
- // mapstructure.Person{Name:"Mitchell", Age:91}
-}
-
-func ExampleDecode_embeddedStruct() {
- // Squashing multiple embedded structs is allowed using the squash tag.
- // This is demonstrated by creating a composite struct of multiple types
- // and decoding into it. In this case, a person can carry with it both
- // a Family and a Location, as well as their own FirstName.
- type Family struct {
- LastName string
- }
- type Location struct {
- City string
- }
- type Person struct {
- Family `mapstructure:",squash"`
- Location `mapstructure:",squash"`
- FirstName string
- }
-
- input := map[string]interface{}{
- "FirstName": "Mitchell",
- "LastName": "Hashimoto",
- "City": "San Francisco",
- }
-
- var result Person
- err := Decode(input, &result)
- if err != nil {
- panic(err)
- }
-
- fmt.Printf("%s %s, %s", result.FirstName, result.LastName, result.City)
- // Output:
- // Mitchell Hashimoto, San Francisco
-}
diff --git a/vendor/github.com/mitchellh/mapstructure/mapstructure_test.go b/vendor/github.com/mitchellh/mapstructure/mapstructure_test.go
deleted file mode 100644
index e05dcc66..00000000
--- a/vendor/github.com/mitchellh/mapstructure/mapstructure_test.go
+++ /dev/null
@@ -1,954 +0,0 @@
-package mapstructure
-
-import (
- "reflect"
- "sort"
- "testing"
-)
-
-type Basic struct {
- Vstring string
- Vint int
- Vuint uint
- Vbool bool
- Vfloat float64
- Vextra string
- vsilent bool
- Vdata interface{}
-}
-
-type Embedded struct {
- Basic
- Vunique string
-}
-
-type EmbeddedPointer struct {
- *Basic
- Vunique string
-}
-
-type EmbeddedSquash struct {
- Basic `mapstructure:",squash"`
- Vunique string
-}
-
-type Map struct {
- Vfoo string
- Vother map[string]string
-}
-
-type MapOfStruct struct {
- Value map[string]Basic
-}
-
-type Nested struct {
- Vfoo string
- Vbar Basic
-}
-
-type NestedPointer struct {
- Vfoo string
- Vbar *Basic
-}
-
-type Slice struct {
- Vfoo string
- Vbar []string
-}
-
-type SliceOfStruct struct {
- Value []Basic
-}
-
-type Tagged struct {
- Extra string `mapstructure:"bar,what,what"`
- Value string `mapstructure:"foo"`
-}
-
-type TypeConversionResult struct {
- IntToFloat float32
- IntToUint uint
- IntToBool bool
- IntToString string
- UintToInt int
- UintToFloat float32
- UintToBool bool
- UintToString string
- BoolToInt int
- BoolToUint uint
- BoolToFloat float32
- BoolToString string
- FloatToInt int
- FloatToUint uint
- FloatToBool bool
- FloatToString string
- SliceUint8ToString string
- StringToInt int
- StringToUint uint
- StringToBool bool
- StringToFloat float32
- SliceToMap map[string]interface{}
- MapToSlice []interface{}
-}
-
-func TestBasicTypes(t *testing.T) {
- t.Parallel()
-
- input := map[string]interface{}{
- "vstring": "foo",
- "vint": 42,
- "Vuint": 42,
- "vbool": true,
- "Vfloat": 42.42,
- "vsilent": true,
- "vdata": 42,
- }
-
- var result Basic
- err := Decode(input, &result)
- if err != nil {
- t.Errorf("got an err: %s", err.Error())
- t.FailNow()
- }
-
- if result.Vstring != "foo" {
- t.Errorf("vstring value should be 'foo': %#v", result.Vstring)
- }
-
- if result.Vint != 42 {
- t.Errorf("vint value should be 42: %#v", result.Vint)
- }
-
- if result.Vuint != 42 {
- t.Errorf("vuint value should be 42: %#v", result.Vuint)
- }
-
- if result.Vbool != true {
- t.Errorf("vbool value should be true: %#v", result.Vbool)
- }
-
- if result.Vfloat != 42.42 {
- t.Errorf("vfloat value should be 42.42: %#v", result.Vfloat)
- }
-
- if result.Vextra != "" {
- t.Errorf("vextra value should be empty: %#v", result.Vextra)
- }
-
- if result.vsilent != false {
- t.Error("vsilent should not be set, it is unexported")
- }
-
- if result.Vdata != 42 {
- t.Error("vdata should be valid")
- }
-}
-
-func TestBasic_IntWithFloat(t *testing.T) {
- t.Parallel()
-
- input := map[string]interface{}{
- "vint": float64(42),
- }
-
- var result Basic
- err := Decode(input, &result)
- if err != nil {
- t.Fatalf("got an err: %s", err)
- }
-}
-
-func TestDecode_Embedded(t *testing.T) {
- t.Parallel()
-
- input := map[string]interface{}{
- "vstring": "foo",
- "Basic": map[string]interface{}{
- "vstring": "innerfoo",
- },
- "vunique": "bar",
- }
-
- var result Embedded
- err := Decode(input, &result)
- if err != nil {
- t.Fatalf("got an err: %s", err.Error())
- }
-
- if result.Vstring != "innerfoo" {
- t.Errorf("vstring value should be 'innerfoo': %#v", result.Vstring)
- }
-
- if result.Vunique != "bar" {
- t.Errorf("vunique value should be 'bar': %#v", result.Vunique)
- }
-}
-
-func TestDecode_EmbeddedPointer(t *testing.T) {
- t.Parallel()
-
- input := map[string]interface{}{
- "vstring": "foo",
- "Basic": map[string]interface{}{
- "vstring": "innerfoo",
- },
- "vunique": "bar",
- }
-
- var result EmbeddedPointer
- err := Decode(input, &result)
- if err == nil {
- t.Fatal("should get error")
- }
-}
-
-func TestDecode_EmbeddedSquash(t *testing.T) {
- t.Parallel()
-
- input := map[string]interface{}{
- "vstring": "foo",
- "vunique": "bar",
- }
-
- var result EmbeddedSquash
- err := Decode(input, &result)
- if err != nil {
- t.Fatalf("got an err: %s", err.Error())
- }
-
- if result.Vstring != "foo" {
- t.Errorf("vstring value should be 'foo': %#v", result.Vstring)
- }
-
- if result.Vunique != "bar" {
- t.Errorf("vunique value should be 'bar': %#v", result.Vunique)
- }
-}
-
-func TestDecode_DecodeHook(t *testing.T) {
- t.Parallel()
-
- input := map[string]interface{}{
- "vint": "WHAT",
- }
-
- decodeHook := func(from reflect.Kind, to reflect.Kind, v interface{}) (interface{}, error) {
- if from == reflect.String && to != reflect.String {
- return 5, nil
- }
-
- return v, nil
- }
-
- var result Basic
- config := &DecoderConfig{
- DecodeHook: decodeHook,
- Result: &result,
- }
-
- decoder, err := NewDecoder(config)
- if err != nil {
- t.Fatalf("err: %s", err)
- }
-
- err = decoder.Decode(input)
- if err != nil {
- t.Fatalf("got an err: %s", err)
- }
-
- if result.Vint != 5 {
- t.Errorf("vint should be 5: %#v", result.Vint)
- }
-}
-
-func TestDecode_DecodeHookType(t *testing.T) {
- t.Parallel()
-
- input := map[string]interface{}{
- "vint": "WHAT",
- }
-
- decodeHook := func(from reflect.Type, to reflect.Type, v interface{}) (interface{}, error) {
- if from.Kind() == reflect.String &&
- to.Kind() != reflect.String {
- return 5, nil
- }
-
- return v, nil
- }
-
- var result Basic
- config := &DecoderConfig{
- DecodeHook: decodeHook,
- Result: &result,
- }
-
- decoder, err := NewDecoder(config)
- if err != nil {
- t.Fatalf("err: %s", err)
- }
-
- err = decoder.Decode(input)
- if err != nil {
- t.Fatalf("got an err: %s", err)
- }
-
- if result.Vint != 5 {
- t.Errorf("vint should be 5: %#v", result.Vint)
- }
-}
-
-func TestDecode_Nil(t *testing.T) {
- t.Parallel()
-
- var input interface{} = nil
- result := Basic{
- Vstring: "foo",
- }
-
- err := Decode(input, &result)
- if err != nil {
- t.Fatalf("err: %s", err)
- }
-
- if result.Vstring != "foo" {
- t.Fatalf("bad: %#v", result.Vstring)
- }
-}
-
-func TestDecode_NonStruct(t *testing.T) {
- t.Parallel()
-
- input := map[string]interface{}{
- "foo": "bar",
- "bar": "baz",
- }
-
- var result map[string]string
- err := Decode(input, &result)
- if err != nil {
- t.Fatalf("err: %s", err)
- }
-
- if result["foo"] != "bar" {
- t.Fatal("foo is not bar")
- }
-}
-
-func TestDecode_StructMatch(t *testing.T) {
- t.Parallel()
-
- input := map[string]interface{}{
- "vbar": Basic{
- Vstring: "foo",
- },
- }
-
- var result Nested
- err := Decode(input, &result)
- if err != nil {
- t.Fatalf("got an err: %s", err.Error())
- }
-
- if result.Vbar.Vstring != "foo" {
- t.Errorf("bad: %#v", result)
- }
-}
-
-func TestDecode_TypeConversion(t *testing.T) {
- input := map[string]interface{}{
- "IntToFloat": 42,
- "IntToUint": 42,
- "IntToBool": 1,
- "IntToString": 42,
- "UintToInt": 42,
- "UintToFloat": 42,
- "UintToBool": 42,
- "UintToString": 42,
- "BoolToInt": true,
- "BoolToUint": true,
- "BoolToFloat": true,
- "BoolToString": true,
- "FloatToInt": 42.42,
- "FloatToUint": 42.42,
- "FloatToBool": 42.42,
- "FloatToString": 42.42,
- "SliceUint8ToString": []uint8("foo"),
- "StringToInt": "42",
- "StringToUint": "42",
- "StringToBool": "1",
- "StringToFloat": "42.42",
- "SliceToMap": []interface{}{},
- "MapToSlice": map[string]interface{}{},
- }
-
- expectedResultStrict := TypeConversionResult{
- IntToFloat: 42.0,
- IntToUint: 42,
- UintToInt: 42,
- UintToFloat: 42,
- BoolToInt: 0,
- BoolToUint: 0,
- BoolToFloat: 0,
- FloatToInt: 42,
- FloatToUint: 42,
- }
-
- expectedResultWeak := TypeConversionResult{
- IntToFloat: 42.0,
- IntToUint: 42,
- IntToBool: true,
- IntToString: "42",
- UintToInt: 42,
- UintToFloat: 42,
- UintToBool: true,
- UintToString: "42",
- BoolToInt: 1,
- BoolToUint: 1,
- BoolToFloat: 1,
- BoolToString: "1",
- FloatToInt: 42,
- FloatToUint: 42,
- FloatToBool: true,
- FloatToString: "42.42",
- SliceUint8ToString: "foo",
- StringToInt: 42,
- StringToUint: 42,
- StringToBool: true,
- StringToFloat: 42.42,
- SliceToMap: map[string]interface{}{},
- MapToSlice: []interface{}{},
- }
-
- // Test strict type conversion
- var resultStrict TypeConversionResult
- err := Decode(input, &resultStrict)
- if err == nil {
- t.Errorf("should return an error")
- }
- if !reflect.DeepEqual(resultStrict, expectedResultStrict) {
- t.Errorf("expected %v, got: %v", expectedResultStrict, resultStrict)
- }
-
- // Test weak type conversion
- var decoder *Decoder
- var resultWeak TypeConversionResult
-
- config := &DecoderConfig{
- WeaklyTypedInput: true,
- Result: &resultWeak,
- }
-
- decoder, err = NewDecoder(config)
- if err != nil {
- t.Fatalf("err: %s", err)
- }
-
- err = decoder.Decode(input)
- if err != nil {
- t.Fatalf("got an err: %s", err)
- }
-
- if !reflect.DeepEqual(resultWeak, expectedResultWeak) {
- t.Errorf("expected \n%#v, got: \n%#v", expectedResultWeak, resultWeak)
- }
-}
-
-func TestDecoder_ErrorUnused(t *testing.T) {
- t.Parallel()
-
- input := map[string]interface{}{
- "vstring": "hello",
- "foo": "bar",
- }
-
- var result Basic
- config := &DecoderConfig{
- ErrorUnused: true,
- Result: &result,
- }
-
- decoder, err := NewDecoder(config)
- if err != nil {
- t.Fatalf("err: %s", err)
- }
-
- err = decoder.Decode(input)
- if err == nil {
- t.Fatal("expected error")
- }
-}
-
-func TestMap(t *testing.T) {
- t.Parallel()
-
- input := map[string]interface{}{
- "vfoo": "foo",
- "vother": map[interface{}]interface{}{
- "foo": "foo",
- "bar": "bar",
- },
- }
-
- var result Map
- err := Decode(input, &result)
- if err != nil {
- t.Fatalf("got an error: %s", err)
- }
-
- if result.Vfoo != "foo" {
- t.Errorf("vfoo value should be 'foo': %#v", result.Vfoo)
- }
-
- if result.Vother == nil {
- t.Fatal("vother should not be nil")
- }
-
- if len(result.Vother) != 2 {
- t.Error("vother should have two items")
- }
-
- if result.Vother["foo"] != "foo" {
- t.Errorf("'foo' key should be foo, got: %#v", result.Vother["foo"])
- }
-
- if result.Vother["bar"] != "bar" {
- t.Errorf("'bar' key should be bar, got: %#v", result.Vother["bar"])
- }
-}
-
-func TestMapMerge(t *testing.T) {
- t.Parallel()
-
- input := map[string]interface{}{
- "vfoo": "foo",
- "vother": map[interface{}]interface{}{
- "foo": "foo",
- "bar": "bar",
- },
- }
-
- var result Map
- result.Vother = map[string]string{"hello": "world"}
- err := Decode(input, &result)
- if err != nil {
- t.Fatalf("got an error: %s", err)
- }
-
- if result.Vfoo != "foo" {
- t.Errorf("vfoo value should be 'foo': %#v", result.Vfoo)
- }
-
- expected := map[string]string{
- "foo": "foo",
- "bar": "bar",
- "hello": "world",
- }
- if !reflect.DeepEqual(result.Vother, expected) {
- t.Errorf("bad: %#v", result.Vother)
- }
-}
-
-func TestMapOfStruct(t *testing.T) {
- t.Parallel()
-
- input := map[string]interface{}{
- "value": map[string]interface{}{
- "foo": map[string]string{"vstring": "one"},
- "bar": map[string]string{"vstring": "two"},
- },
- }
-
- var result MapOfStruct
- err := Decode(input, &result)
- if err != nil {
- t.Fatalf("got an err: %s", err)
- }
-
- if result.Value == nil {
- t.Fatal("value should not be nil")
- }
-
- if len(result.Value) != 2 {
- t.Error("value should have two items")
- }
-
- if result.Value["foo"].Vstring != "one" {
- t.Errorf("foo value should be 'one', got: %s", result.Value["foo"].Vstring)
- }
-
- if result.Value["bar"].Vstring != "two" {
- t.Errorf("bar value should be 'two', got: %s", result.Value["bar"].Vstring)
- }
-}
-
-func TestNestedType(t *testing.T) {
- t.Parallel()
-
- input := map[string]interface{}{
- "vfoo": "foo",
- "vbar": map[string]interface{}{
- "vstring": "foo",
- "vint": 42,
- "vbool": true,
- },
- }
-
- var result Nested
- err := Decode(input, &result)
- if err != nil {
- t.Fatalf("got an err: %s", err.Error())
- }
-
- if result.Vfoo != "foo" {
- t.Errorf("vfoo value should be 'foo': %#v", result.Vfoo)
- }
-
- if result.Vbar.Vstring != "foo" {
- t.Errorf("vstring value should be 'foo': %#v", result.Vbar.Vstring)
- }
-
- if result.Vbar.Vint != 42 {
- t.Errorf("vint value should be 42: %#v", result.Vbar.Vint)
- }
-
- if result.Vbar.Vbool != true {
- t.Errorf("vbool value should be true: %#v", result.Vbar.Vbool)
- }
-
- if result.Vbar.Vextra != "" {
- t.Errorf("vextra value should be empty: %#v", result.Vbar.Vextra)
- }
-}
-
-func TestNestedTypePointer(t *testing.T) {
- t.Parallel()
-
- input := map[string]interface{}{
- "vfoo": "foo",
- "vbar": &map[string]interface{}{
- "vstring": "foo",
- "vint": 42,
- "vbool": true,
- },
- }
-
- var result NestedPointer
- err := Decode(input, &result)
- if err != nil {
- t.Fatalf("got an err: %s", err.Error())
- }
-
- if result.Vfoo != "foo" {
- t.Errorf("vfoo value should be 'foo': %#v", result.Vfoo)
- }
-
- if result.Vbar.Vstring != "foo" {
- t.Errorf("vstring value should be 'foo': %#v", result.Vbar.Vstring)
- }
-
- if result.Vbar.Vint != 42 {
- t.Errorf("vint value should be 42: %#v", result.Vbar.Vint)
- }
-
- if result.Vbar.Vbool != true {
- t.Errorf("vbool value should be true: %#v", result.Vbar.Vbool)
- }
-
- if result.Vbar.Vextra != "" {
- t.Errorf("vextra value should be empty: %#v", result.Vbar.Vextra)
- }
-}
-
-func TestSlice(t *testing.T) {
- t.Parallel()
-
- inputStringSlice := map[string]interface{}{
- "vfoo": "foo",
- "vbar": []string{"foo", "bar", "baz"},
- }
-
- inputStringSlicePointer := map[string]interface{}{
- "vfoo": "foo",
- "vbar": &[]string{"foo", "bar", "baz"},
- }
-
- outputStringSlice := &Slice{
- "foo",
- []string{"foo", "bar", "baz"},
- }
-
- testSliceInput(t, inputStringSlice, outputStringSlice)
- testSliceInput(t, inputStringSlicePointer, outputStringSlice)
-}
-
-func TestInvalidSlice(t *testing.T) {
- t.Parallel()
-
- input := map[string]interface{}{
- "vfoo": "foo",
- "vbar": 42,
- }
-
- result := Slice{}
- err := Decode(input, &result)
- if err == nil {
- t.Errorf("expected failure")
- }
-}
-
-func TestSliceOfStruct(t *testing.T) {
- t.Parallel()
-
- input := map[string]interface{}{
- "value": []map[string]interface{}{
- {"vstring": "one"},
- {"vstring": "two"},
- },
- }
-
- var result SliceOfStruct
- err := Decode(input, &result)
- if err != nil {
- t.Fatalf("got unexpected error: %s", err)
- }
-
- if len(result.Value) != 2 {
- t.Fatalf("expected two values, got %d", len(result.Value))
- }
-
- if result.Value[0].Vstring != "one" {
- t.Errorf("first value should be 'one', got: %s", result.Value[0].Vstring)
- }
-
- if result.Value[1].Vstring != "two" {
- t.Errorf("second value should be 'two', got: %s", result.Value[1].Vstring)
- }
-}
-
-func TestInvalidType(t *testing.T) {
- t.Parallel()
-
- input := map[string]interface{}{
- "vstring": 42,
- }
-
- var result Basic
- err := Decode(input, &result)
- if err == nil {
- t.Fatal("error should exist")
- }
-
- derr, ok := err.(*Error)
- if !ok {
- t.Fatalf("error should be kind of Error, instead: %#v", err)
- }
-
- if derr.Errors[0] != "'Vstring' expected type 'string', got unconvertible type 'int'" {
- t.Errorf("got unexpected error: %s", err)
- }
-
- inputNegIntUint := map[string]interface{}{
- "vuint": -42,
- }
-
- err = Decode(inputNegIntUint, &result)
- if err == nil {
- t.Fatal("error should exist")
- }
-
- derr, ok = err.(*Error)
- if !ok {
- t.Fatalf("error should be kind of Error, instead: %#v", err)
- }
-
- if derr.Errors[0] != "cannot parse 'Vuint', -42 overflows uint" {
- t.Errorf("got unexpected error: %s", err)
- }
-
- inputNegFloatUint := map[string]interface{}{
- "vuint": -42.0,
- }
-
- err = Decode(inputNegFloatUint, &result)
- if err == nil {
- t.Fatal("error should exist")
- }
-
- derr, ok = err.(*Error)
- if !ok {
- t.Fatalf("error should be kind of Error, instead: %#v", err)
- }
-
- if derr.Errors[0] != "cannot parse 'Vuint', -42.000000 overflows uint" {
- t.Errorf("got unexpected error: %s", err)
- }
-}
-
-func TestMetadata(t *testing.T) {
- t.Parallel()
-
- input := map[string]interface{}{
- "vfoo": "foo",
- "vbar": map[string]interface{}{
- "vstring": "foo",
- "Vuint": 42,
- "foo": "bar",
- },
- "bar": "nil",
- }
-
- var md Metadata
- var result Nested
- config := &DecoderConfig{
- Metadata: &md,
- Result: &result,
- }
-
- decoder, err := NewDecoder(config)
- if err != nil {
- t.Fatalf("err: %s", err)
- }
-
- err = decoder.Decode(input)
- if err != nil {
- t.Fatalf("err: %s", err.Error())
- }
-
- expectedKeys := []string{"Vbar", "Vbar.Vstring", "Vbar.Vuint", "Vfoo"}
- sort.Strings(md.Keys)
- if !reflect.DeepEqual(md.Keys, expectedKeys) {
- t.Fatalf("bad keys: %#v", md.Keys)
- }
-
- expectedUnused := []string{"Vbar.foo", "bar"}
- if !reflect.DeepEqual(md.Unused, expectedUnused) {
- t.Fatalf("bad unused: %#v", md.Unused)
- }
-}
-
-func TestMetadata_Embedded(t *testing.T) {
- t.Parallel()
-
- input := map[string]interface{}{
- "vstring": "foo",
- "vunique": "bar",
- }
-
- var md Metadata
- var result EmbeddedSquash
- config := &DecoderConfig{
- Metadata: &md,
- Result: &result,
- }
-
- decoder, err := NewDecoder(config)
- if err != nil {
- t.Fatalf("err: %s", err)
- }
-
- err = decoder.Decode(input)
- if err != nil {
- t.Fatalf("err: %s", err.Error())
- }
-
- expectedKeys := []string{"Vstring", "Vunique"}
-
- sort.Strings(md.Keys)
- if !reflect.DeepEqual(md.Keys, expectedKeys) {
- t.Fatalf("bad keys: %#v", md.Keys)
- }
-
- expectedUnused := []string{}
- if !reflect.DeepEqual(md.Unused, expectedUnused) {
- t.Fatalf("bad unused: %#v", md.Unused)
- }
-}
-
-func TestNonPtrValue(t *testing.T) {
- t.Parallel()
-
- err := Decode(map[string]interface{}{}, Basic{})
- if err == nil {
- t.Fatal("error should exist")
- }
-
- if err.Error() != "result must be a pointer" {
- t.Errorf("got unexpected error: %s", err)
- }
-}
-
-func TestTagged(t *testing.T) {
- t.Parallel()
-
- input := map[string]interface{}{
- "foo": "bar",
- "bar": "value",
- }
-
- var result Tagged
- err := Decode(input, &result)
- if err != nil {
- t.Fatalf("unexpected error: %s", err)
- }
-
- if result.Value != "bar" {
- t.Errorf("value should be 'bar', got: %#v", result.Value)
- }
-
- if result.Extra != "value" {
- t.Errorf("extra should be 'value', got: %#v", result.Extra)
- }
-}
-
-func TestWeakDecode(t *testing.T) {
- t.Parallel()
-
- input := map[string]interface{}{
- "foo": "4",
- "bar": "value",
- }
-
- var result struct {
- Foo int
- Bar string
- }
-
- if err := WeakDecode(input, &result); err != nil {
- t.Fatalf("err: %s", err)
- }
- if result.Foo != 4 {
- t.Fatalf("bad: %#v", result)
- }
- if result.Bar != "value" {
- t.Fatalf("bad: %#v", result)
- }
-}
-
-func testSliceInput(t *testing.T, input map[string]interface{}, expected *Slice) {
- var result Slice
- err := Decode(input, &result)
- if err != nil {
- t.Fatalf("got error: %s", err)
- }
-
- if result.Vfoo != expected.Vfoo {
- t.Errorf("Vfoo expected '%s', got '%s'", expected.Vfoo, result.Vfoo)
- }
-
- if result.Vbar == nil {
- t.Fatalf("Vbar a slice, got '%#v'", result.Vbar)
- }
-
- if len(result.Vbar) != len(expected.Vbar) {
- t.Errorf("Vbar length should be %d, got %d", len(expected.Vbar), len(result.Vbar))
- }
-
- for i, v := range result.Vbar {
- if v != expected.Vbar[i] {
- t.Errorf(
- "Vbar[%d] should be '%#v', got '%#v'",
- i, expected.Vbar[i], v)
- }
- }
-}
diff --git a/vendor/github.com/ncw/swift/example_test.go b/vendor/github.com/ncw/swift/example_test.go
deleted file mode 100644
index 30cb9834..00000000
--- a/vendor/github.com/ncw/swift/example_test.go
+++ /dev/null
@@ -1,97 +0,0 @@
-// Copyright...
-
-// This example demonstrates opening a Connection and doing some basic operations.
-package swift_test
-
-import (
- "fmt"
-
- "github.com/ncw/swift"
-)
-
-func ExampleConnection() {
- // Create a v1 auth connection
- c := swift.Connection{
- // This should be your username
- UserName: "user",
- // This should be your api key
- ApiKey: "key",
- // This should be a v1 auth url, eg
- // Rackspace US https://auth.api.rackspacecloud.com/v1.0
- // Rackspace UK https://lon.auth.api.rackspacecloud.com/v1.0
- // Memset Memstore UK https://auth.storage.memset.com/v1.0
- AuthUrl: "auth_url",
- }
-
- // Authenticate
- err := c.Authenticate()
- if err != nil {
- panic(err)
- }
- // List all the containers
- containers, err := c.ContainerNames(nil)
- fmt.Println(containers)
- // etc...
-
- // ------ or alternatively create a v2 connection ------
-
- // Create a v2 auth connection
- c = swift.Connection{
- // This is the sub user for the storage - eg "admin"
- UserName: "user",
- // This should be your api key
- ApiKey: "key",
- // This should be a version2 auth url, eg
- // Rackspace v2 https://identity.api.rackspacecloud.com/v2.0
- // Memset Memstore v2 https://auth.storage.memset.com/v2.0
- AuthUrl: "v2_auth_url",
- // Region to use - default is use first region if unset
- Region: "LON",
- // Name of the tenant - this is likely your username
- Tenant: "jim",
- }
-
- // as above...
-}
-
-var container string
-
-func ExampleConnection_ObjectsWalk() {
- objects := make([]string, 0)
- err := c.ObjectsWalk(container, nil, func(opts *swift.ObjectsOpts) (interface{}, error) {
- newObjects, err := c.ObjectNames(container, opts)
- if err == nil {
- objects = append(objects, newObjects...)
- }
- return newObjects, err
- })
- fmt.Println("Found all the objects", objects, err)
-}
-
-func ExampleConnection_VersionContainerCreate() {
- // Use the helper method to create the current and versions container.
- if err := c.VersionContainerCreate("cds", "cd-versions"); err != nil {
- fmt.Print(err.Error())
- }
-}
-
-func ExampleConnection_VersionEnable() {
- // Build the containers manually and enable them.
- if err := c.ContainerCreate("movie-versions", nil); err != nil {
- fmt.Print(err.Error())
- }
- if err := c.ContainerCreate("movies", nil); err != nil {
- fmt.Print(err.Error())
- }
- if err := c.VersionEnable("movies", "movie-versions"); err != nil {
- fmt.Print(err.Error())
- }
-
- // Access the primary container as usual with ObjectCreate(), ObjectPut(), etc.
- // etc...
-}
-
-func ExampleConnection_VersionDisable() {
- // Disable versioning on a container. Note that this does not delete the versioning container.
- c.VersionDisable("movies")
-}
diff --git a/vendor/github.com/ncw/swift/meta_test.go b/vendor/github.com/ncw/swift/meta_test.go
deleted file mode 100644
index 47560d57..00000000
--- a/vendor/github.com/ncw/swift/meta_test.go
+++ /dev/null
@@ -1,213 +0,0 @@
-// Tests for swift metadata
-package swift
-
-import (
- "testing"
- "time"
-)
-
-func TestHeadersToMetadata(t *testing.T) {
-}
-
-func TestHeadersToAccountMetadata(t *testing.T) {
-}
-
-func TestHeadersToContainerMetadata(t *testing.T) {
-}
-
-func TestHeadersToObjectMetadata(t *testing.T) {
-}
-
-func TestMetadataToHeaders(t *testing.T) {
-}
-
-func TestMetadataToAccountHeaders(t *testing.T) {
-}
-
-func TestMetadataToContainerHeaders(t *testing.T) {
-}
-
-func TestMetadataToObjectHeaders(t *testing.T) {
-}
-
-func TestNsToFloatString(t *testing.T) {
- for _, d := range []struct {
- ns int64
- fs string
- }{
- {0, "0"},
- {1, "0.000000001"},
- {1000, "0.000001"},
- {1000000, "0.001"},
- {100000000, "0.1"},
- {1000000000, "1"},
- {10000000000, "10"},
- {12345678912, "12.345678912"},
- {12345678910, "12.34567891"},
- {12345678900, "12.3456789"},
- {12345678000, "12.345678"},
- {12345670000, "12.34567"},
- {12345600000, "12.3456"},
- {12345000000, "12.345"},
- {12340000000, "12.34"},
- {12300000000, "12.3"},
- {12000000000, "12"},
- {10000000000, "10"},
- {1347717491123123123, "1347717491.123123123"},
- } {
- if nsToFloatString(d.ns) != d.fs {
- t.Error("Failed", d.ns, "!=", d.fs)
- }
- if d.ns > 0 && nsToFloatString(-d.ns) != "-"+d.fs {
- t.Error("Failed on negative", d.ns, "!=", d.fs)
- }
- }
-}
-
-func TestFloatStringToNs(t *testing.T) {
- for _, d := range []struct {
- ns int64
- fs string
- }{
- {0, "0"},
- {0, "0."},
- {0, ".0"},
- {0, "0.0"},
- {0, "0.0000000001"},
- {1, "0.000000001"},
- {1000, "0.000001"},
- {1000000, "0.001"},
- {100000000, "0.1"},
- {100000000, "0.10"},
- {100000000, "0.1000000001"},
- {1000000000, "1"},
- {1000000000, "1."},
- {1000000000, "1.0"},
- {10000000000, "10"},
- {12345678912, "12.345678912"},
- {12345678912, "12.3456789129"},
- {12345678912, "12.34567891299"},
- {12345678910, "12.34567891"},
- {12345678900, "12.3456789"},
- {12345678000, "12.345678"},
- {12345670000, "12.34567"},
- {12345600000, "12.3456"},
- {12345000000, "12.345"},
- {12340000000, "12.34"},
- {12300000000, "12.3"},
- {12000000000, "12"},
- {10000000000, "10"},
- // This is a typical value which has more bits in than a float64
- {1347717491123123123, "1347717491.123123123"},
- } {
- ns, err := floatStringToNs(d.fs)
- if err != nil {
- t.Error("Failed conversion", err)
- }
- if ns != d.ns {
- t.Error("Failed", d.fs, "!=", d.ns, "was", ns)
- }
- if d.ns > 0 {
- ns, err := floatStringToNs("-" + d.fs)
- if err != nil {
- t.Error("Failed conversion", err)
- }
- if ns != -d.ns {
- t.Error("Failed on negative", -d.ns, "!=", "-"+d.fs)
- }
- }
- }
-
- // These are expected to produce errors
- for _, fs := range []string{
- "",
- " 1",
- "- 1",
- "- 1",
- "1.-1",
- "1.0.0",
- "1x0",
- } {
- ns, err := floatStringToNs(fs)
- if err == nil {
- t.Error("Didn't produce expected error", fs, ns)
- }
- }
-
-}
-
-func TestGetModTime(t *testing.T) {
- for _, d := range []struct {
- ns string
- t string
- }{
- {"1354040105", "2012-11-27T18:15:05Z"},
- {"1354040105.", "2012-11-27T18:15:05Z"},
- {"1354040105.0", "2012-11-27T18:15:05Z"},
- {"1354040105.000000000000", "2012-11-27T18:15:05Z"},
- {"1354040105.123", "2012-11-27T18:15:05.123Z"},
- {"1354040105.123456", "2012-11-27T18:15:05.123456Z"},
- {"1354040105.123456789", "2012-11-27T18:15:05.123456789Z"},
- {"1354040105.123456789123", "2012-11-27T18:15:05.123456789Z"},
- {"0", "1970-01-01T00:00:00.000000000Z"},
- } {
- expected, err := time.Parse(time.RFC3339, d.t)
- if err != nil {
- t.Error("Bad test", err)
- }
- m := Metadata{"mtime": d.ns}
- actual, err := m.GetModTime()
- if err != nil {
- t.Error("Parse error", err)
- }
- if !actual.Equal(expected) {
- t.Error("Expecting", expected, expected.UnixNano(), "got", actual, actual.UnixNano())
- }
- }
- for _, ns := range []string{
- "EMPTY",
- "",
- " 1",
- "- 1",
- "- 1",
- "1.-1",
- "1.0.0",
- "1x0",
- } {
- m := Metadata{}
- if ns != "EMPTY" {
- m["mtime"] = ns
- }
- actual, err := m.GetModTime()
- if err == nil {
- t.Error("Expected error not produced")
- }
- if !actual.IsZero() {
- t.Error("Expected output to be zero")
- }
- }
-}
-
-func TestSetModTime(t *testing.T) {
- for _, d := range []struct {
- ns string
- t string
- }{
- {"1354040105", "2012-11-27T18:15:05Z"},
- {"1354040105", "2012-11-27T18:15:05.000000Z"},
- {"1354040105.123", "2012-11-27T18:15:05.123Z"},
- {"1354040105.123456", "2012-11-27T18:15:05.123456Z"},
- {"1354040105.123456789", "2012-11-27T18:15:05.123456789Z"},
- {"0", "1970-01-01T00:00:00.000000000Z"},
- } {
- time, err := time.Parse(time.RFC3339, d.t)
- if err != nil {
- t.Error("Bad test", err)
- }
- m := Metadata{}
- m.SetModTime(time)
- if m["mtime"] != d.ns {
- t.Error("mtime wrong", m, "should be", d.ns)
- }
- }
-}
diff --git a/vendor/github.com/ncw/swift/rs/rs.go b/vendor/github.com/ncw/swift/rs/rs.go
deleted file mode 100644
index 34ee15a0..00000000
--- a/vendor/github.com/ncw/swift/rs/rs.go
+++ /dev/null
@@ -1,83 +0,0 @@
-package rs
-
-import (
- "errors"
- "net/http"
- "strconv"
-
- "github.com/ncw/swift"
-)
-
-// RsConnection is a RackSpace specific wrapper to the core swift library which
-// exposes the RackSpace CDN commands via the CDN Management URL interface.
-type RsConnection struct {
- swift.Connection
- cdnUrl string
-}
-
-// manage is similar to the swift storage method, but uses the CDN Management URL for CDN specific calls.
-func (c *RsConnection) manage(p swift.RequestOpts) (resp *http.Response, headers swift.Headers, err error) {
- p.OnReAuth = func() (string, error) {
- if c.cdnUrl == "" {
- c.cdnUrl = c.Auth.CdnUrl()
- }
- if c.cdnUrl == "" {
- return "", errors.New("The X-CDN-Management-Url does not exist on the authenticated platform")
- }
- return c.cdnUrl, nil
- }
- if c.Authenticated() {
- _, err = p.OnReAuth()
- if err != nil {
- return nil, nil, err
- }
- }
- return c.Connection.Call(c.cdnUrl, p)
-}
-
-// ContainerCDNEnable enables a container for public CDN usage.
-//
-// Change the default TTL of 259200 seconds (72 hours) by passing in an integer value.
-//
-// This method can be called again to change the TTL.
-func (c *RsConnection) ContainerCDNEnable(container string, ttl int) (swift.Headers, error) {
- h := swift.Headers{"X-CDN-Enabled": "true"}
- if ttl > 0 {
- h["X-TTL"] = strconv.Itoa(ttl)
- }
-
- _, headers, err := c.manage(swift.RequestOpts{
- Container: container,
- Operation: "PUT",
- ErrorMap: swift.ContainerErrorMap,
- NoResponse: true,
- Headers: h,
- })
- return headers, err
-}
-
-// ContainerCDNDisable disables CDN access to a container.
-func (c *RsConnection) ContainerCDNDisable(container string) error {
- h := swift.Headers{"X-CDN-Enabled": "false"}
-
- _, _, err := c.manage(swift.RequestOpts{
- Container: container,
- Operation: "PUT",
- ErrorMap: swift.ContainerErrorMap,
- NoResponse: true,
- Headers: h,
- })
- return err
-}
-
-// ContainerCDNMeta returns the CDN metadata for a container.
-func (c *RsConnection) ContainerCDNMeta(container string) (swift.Headers, error) {
- _, headers, err := c.manage(swift.RequestOpts{
- Container: container,
- Operation: "HEAD",
- ErrorMap: swift.ContainerErrorMap,
- NoResponse: true,
- Headers: swift.Headers{},
- })
- return headers, err
-}
diff --git a/vendor/github.com/ncw/swift/rs/rs_test.go b/vendor/github.com/ncw/swift/rs/rs_test.go
deleted file mode 100644
index 74205154..00000000
--- a/vendor/github.com/ncw/swift/rs/rs_test.go
+++ /dev/null
@@ -1,96 +0,0 @@
-// See swift_test.go for requirements to run this test.
-package rs_test
-
-import (
- "os"
- "testing"
-
- "github.com/ncw/swift/rs"
-)
-
-var (
- c rs.RsConnection
-)
-
-const (
- CONTAINER = "GoSwiftUnitTest"
- OBJECT = "test_object"
- CONTENTS = "12345"
- CONTENT_SIZE = int64(len(CONTENTS))
- CONTENT_MD5 = "827ccb0eea8a706c4c34a16891f84e7b"
-)
-
-// Test functions are run in order - this one must be first!
-func TestAuthenticate(t *testing.T) {
- UserName := os.Getenv("SWIFT_API_USER")
- ApiKey := os.Getenv("SWIFT_API_KEY")
- AuthUrl := os.Getenv("SWIFT_AUTH_URL")
- if UserName == "" || ApiKey == "" || AuthUrl == "" {
- t.Fatal("SWIFT_API_USER, SWIFT_API_KEY and SWIFT_AUTH_URL not all set")
- }
- c = rs.RsConnection{}
- c.UserName = UserName
- c.ApiKey = ApiKey
- c.AuthUrl = AuthUrl
- err := c.Authenticate()
- if err != nil {
- t.Fatal("Auth failed", err)
- }
- if !c.Authenticated() {
- t.Fatal("Not authenticated")
- }
-}
-
-// Setup
-func TestContainerCreate(t *testing.T) {
- err := c.ContainerCreate(CONTAINER, nil)
- if err != nil {
- t.Fatal(err)
- }
-}
-
-func TestCDNEnable(t *testing.T) {
- headers, err := c.ContainerCDNEnable(CONTAINER, 0)
- if err != nil {
- t.Error(err)
- }
- if _, ok := headers["X-Cdn-Uri"]; !ok {
- t.Error("Failed to enable CDN for container")
- }
-}
-
-func TestOnReAuth(t *testing.T) {
- c2 := rs.RsConnection{}
- c2.UserName = c.UserName
- c2.ApiKey = c.ApiKey
- c2.AuthUrl = c.AuthUrl
- _, err := c2.ContainerCDNEnable(CONTAINER, 0)
- if err != nil {
- t.Fatalf("Failed to reauthenticate: %v", err)
- }
-}
-
-func TestCDNMeta(t *testing.T) {
- headers, err := c.ContainerCDNMeta(CONTAINER)
- if err != nil {
- t.Error(err)
- }
- if _, ok := headers["X-Cdn-Uri"]; !ok {
- t.Error("CDN is not enabled")
- }
-}
-
-func TestCDNDisable(t *testing.T) {
- err := c.ContainerCDNDisable(CONTAINER) // files stick in CDN until TTL expires
- if err != nil {
- t.Error(err)
- }
-}
-
-// Teardown
-func TestContainerDelete(t *testing.T) {
- err := c.ContainerDelete(CONTAINER)
- if err != nil {
- t.Fatal(err)
- }
-}
diff --git a/vendor/github.com/ncw/swift/swift_internal_test.go b/vendor/github.com/ncw/swift/swift_internal_test.go
deleted file mode 100644
index e8b1f437..00000000
--- a/vendor/github.com/ncw/swift/swift_internal_test.go
+++ /dev/null
@@ -1,409 +0,0 @@
-// This tests the swift package internals
-//
-// It does not require access to a swift server
-//
-// FIXME need to add more tests and to check URLs and parameters
-package swift
-
-import (
- "fmt"
- "io"
- "net"
- "net/http"
- "testing"
-
- // "net/http/httputil"
- // "os"
-)
-
-const (
- TEST_ADDRESS = "localhost:5324"
- AUTH_URL = "http://" + TEST_ADDRESS + "/v1.0"
- PROXY_URL = "http://" + TEST_ADDRESS + "/proxy"
- USERNAME = "test"
- APIKEY = "apikey"
- AUTH_TOKEN = "token"
-)
-
-// Globals
-var (
- server *SwiftServer
- c *Connection
-)
-
-// SwiftServer implements a test swift server
-type SwiftServer struct {
- t *testing.T
- checks []*Check
-}
-
-// Used to check and reply to http transactions
-type Check struct {
- in Headers
- out Headers
- rx *string
- tx *string
- err *Error
- url *string
-}
-
-// Add a in check
-func (check *Check) In(in Headers) *Check {
- check.in = in
- return check
-}
-
-// Add an out check
-func (check *Check) Out(out Headers) *Check {
- check.out = out
- return check
-}
-
-// Add an Error check
-func (check *Check) Error(StatusCode int, Text string) *Check {
- check.err = newError(StatusCode, Text)
- return check
-}
-
-// Add a rx check
-func (check *Check) Rx(rx string) *Check {
- check.rx = &rx
- return check
-}
-
-// Add an tx check
-func (check *Check) Tx(tx string) *Check {
- check.tx = &tx
- return check
-}
-
-// Add an URL check
-func (check *Check) Url(url string) *Check {
- check.url = &url
- return check
-}
-
-// Add a check
-func (s *SwiftServer) AddCheck(t *testing.T) *Check {
- server.t = t
- check := &Check{
- in: Headers{},
- out: Headers{},
- err: nil,
- }
- s.checks = append(s.checks, check)
- return check
-}
-
-// Responds to a request
-func (s *SwiftServer) Respond(w http.ResponseWriter, r *http.Request) {
- if len(s.checks) < 1 {
- s.t.Fatal("Unexpected http transaction")
- }
- check := s.checks[0]
- s.checks = s.checks[1:]
-
- // Check URL
- if check.url != nil && *check.url != r.URL.String() {
- s.t.Errorf("Expecting URL %q but got %q", *check.url, r.URL)
- }
-
- // Check headers
- for k, v := range check.in {
- actual := r.Header.Get(k)
- if actual != v {
- s.t.Errorf("Expecting header %q=%q but got %q", k, v, actual)
- }
- }
- // Write output headers
- h := w.Header()
- for k, v := range check.out {
- h.Set(k, v)
- }
- // Return an error if required
- if check.err != nil {
- http.Error(w, check.err.Text, check.err.StatusCode)
- } else {
- if check.tx != nil {
- _, err := w.Write([]byte(*check.tx))
- if err != nil {
- s.t.Error("Write failed", err)
- }
- }
- }
-}
-
-// Checks to see all responses are used up
-func (s *SwiftServer) Finished() {
- if len(s.checks) > 0 {
- s.t.Error("Unused checks", s.checks)
- }
-}
-
-func handle(w http.ResponseWriter, r *http.Request) {
- // out, _ := httputil.DumpRequest(r, true)
- // os.Stdout.Write(out)
- server.Respond(w, r)
-}
-
-func NewSwiftServer() *SwiftServer {
- server := &SwiftServer{}
- http.HandleFunc("/", handle)
- go http.ListenAndServe(TEST_ADDRESS, nil)
- fmt.Print("Waiting for server to start ")
- for {
- fmt.Print(".")
- conn, err := net.Dial("tcp", TEST_ADDRESS)
- if err == nil {
- conn.Close()
- fmt.Println(" Started")
- break
- }
- }
- return server
-}
-
-func init() {
- server = NewSwiftServer()
- c = &Connection{
- UserName: USERNAME,
- ApiKey: APIKEY,
- AuthUrl: AUTH_URL,
- }
-}
-
-// Check the error is a swift error
-func checkError(t *testing.T, err error, StatusCode int, Text string) {
- if err == nil {
- t.Fatal("No error returned")
- }
- err2, ok := err.(*Error)
- if !ok {
- t.Fatal("Bad error type")
- }
- if err2.StatusCode != StatusCode {
- t.Fatalf("Bad status code, expecting %d got %d", StatusCode, err2.StatusCode)
- }
- if err2.Text != Text {
- t.Fatalf("Bad error string, expecting %q got %q", Text, err2.Text)
- }
-}
-
-// FIXME copied from swift_test.go
-func compareMaps(t *testing.T, a, b map[string]string) {
- if len(a) != len(b) {
- t.Error("Maps different sizes", a, b)
- }
- for ka, va := range a {
- if vb, ok := b[ka]; !ok || va != vb {
- t.Error("Difference in key", ka, va, b[ka])
- }
- }
- for kb, vb := range b {
- if va, ok := a[kb]; !ok || vb != va {
- t.Error("Difference in key", kb, vb, a[kb])
- }
- }
-}
-
-func TestInternalError(t *testing.T) {
- e := newError(404, "Not Found!")
- if e.StatusCode != 404 || e.Text != "Not Found!" {
- t.Fatal("Bad error")
- }
- if e.Error() != "Not Found!" {
- t.Fatal("Bad error")
- }
-
-}
-
-func testCheckClose(c io.Closer, e error) (err error) {
- err = e
- defer checkClose(c, &err)
- return
-}
-
-// Make a closer which returns the error of our choice
-type myCloser struct {
- err error
-}
-
-func (c *myCloser) Close() error {
- return c.err
-}
-
-func TestInternalCheckClose(t *testing.T) {
- if testCheckClose(&myCloser{nil}, nil) != nil {
- t.Fatal("bad 1")
- }
- if testCheckClose(&myCloser{nil}, ObjectCorrupted) != ObjectCorrupted {
- t.Fatal("bad 2")
- }
- if testCheckClose(&myCloser{ObjectNotFound}, nil) != ObjectNotFound {
- t.Fatal("bad 3")
- }
- if testCheckClose(&myCloser{ObjectNotFound}, ObjectCorrupted) != ObjectCorrupted {
- t.Fatal("bad 4")
- }
-}
-
-func TestInternalParseHeaders(t *testing.T) {
- resp := &http.Response{StatusCode: 200}
- if c.parseHeaders(resp, nil) != nil {
- t.Error("Bad 1")
- }
- if c.parseHeaders(resp, authErrorMap) != nil {
- t.Error("Bad 1")
- }
-
- resp = &http.Response{StatusCode: 299}
- if c.parseHeaders(resp, nil) != nil {
- t.Error("Bad 1")
- }
-
- resp = &http.Response{StatusCode: 199, Status: "BOOM"}
- checkError(t, c.parseHeaders(resp, nil), 199, "HTTP Error: 199: BOOM")
-
- resp = &http.Response{StatusCode: 300, Status: "BOOM"}
- checkError(t, c.parseHeaders(resp, nil), 300, "HTTP Error: 300: BOOM")
-
- resp = &http.Response{StatusCode: 404, Status: "BOOM"}
- checkError(t, c.parseHeaders(resp, nil), 404, "HTTP Error: 404: BOOM")
- if c.parseHeaders(resp, ContainerErrorMap) != ContainerNotFound {
- t.Error("Bad 1")
- }
- if c.parseHeaders(resp, objectErrorMap) != ObjectNotFound {
- t.Error("Bad 1")
- }
-}
-
-func TestInternalReadHeaders(t *testing.T) {
- resp := &http.Response{Header: http.Header{}}
- compareMaps(t, readHeaders(resp), Headers{})
-
- resp = &http.Response{Header: http.Header{
- "one": []string{"1"},
- "two": []string{"2"},
- }}
- compareMaps(t, readHeaders(resp), Headers{"one": "1", "two": "2"})
-
- // FIXME this outputs a log which we should test and check
- resp = &http.Response{Header: http.Header{
- "one": []string{"1", "11", "111"},
- "two": []string{"2"},
- }}
- compareMaps(t, readHeaders(resp), Headers{"one": "1", "two": "2"})
-}
-
-func TestInternalStorage(t *testing.T) {
- // FIXME
-}
-
-// ------------------------------------------------------------
-
-func TestInternalAuthenticate(t *testing.T) {
- server.AddCheck(t).In(Headers{
- "User-Agent": DefaultUserAgent,
- "X-Auth-Key": APIKEY,
- "X-Auth-User": USERNAME,
- }).Out(Headers{
- "X-Storage-Url": PROXY_URL,
- "X-Auth-Token": AUTH_TOKEN,
- }).Url("/v1.0")
- defer server.Finished()
-
- err := c.Authenticate()
- if err != nil {
- t.Fatal(err)
- }
- if c.StorageUrl != PROXY_URL {
- t.Error("Bad storage url")
- }
- if c.AuthToken != AUTH_TOKEN {
- t.Error("Bad auth token")
- }
- if !c.Authenticated() {
- t.Error("Didn't authenticate")
- }
-}
-
-func TestInternalAuthenticateDenied(t *testing.T) {
- server.AddCheck(t).Error(400, "Bad request")
- server.AddCheck(t).Error(401, "DENIED")
- defer server.Finished()
- c.UnAuthenticate()
- err := c.Authenticate()
- if err != AuthorizationFailed {
- t.Fatal("Expecting AuthorizationFailed", err)
- }
- // FIXME
- // if c.Authenticated() {
- // t.Fatal("Expecting not authenticated")
- // }
-}
-
-func TestInternalAuthenticateBad(t *testing.T) {
- server.AddCheck(t).Out(Headers{
- "X-Storage-Url": PROXY_URL,
- })
- defer server.Finished()
- err := c.Authenticate()
- checkError(t, err, 0, "Response didn't have storage url and auth token")
- if c.Authenticated() {
- t.Fatal("Expecting not authenticated")
- }
-
- server.AddCheck(t).Out(Headers{
- "X-Auth-Token": AUTH_TOKEN,
- })
- err = c.Authenticate()
- checkError(t, err, 0, "Response didn't have storage url and auth token")
- if c.Authenticated() {
- t.Fatal("Expecting not authenticated")
- }
-
- server.AddCheck(t)
- err = c.Authenticate()
- checkError(t, err, 0, "Response didn't have storage url and auth token")
- if c.Authenticated() {
- t.Fatal("Expecting not authenticated")
- }
-
- server.AddCheck(t).Out(Headers{
- "X-Storage-Url": PROXY_URL,
- "X-Auth-Token": AUTH_TOKEN,
- })
- err = c.Authenticate()
- if err != nil {
- t.Fatal(err)
- }
- if !c.Authenticated() {
- t.Fatal("Expecting authenticated")
- }
-}
-
-func testContainerNames(t *testing.T, rx string, expected []string) {
- server.AddCheck(t).In(Headers{
- "User-Agent": DefaultUserAgent,
- "X-Auth-Token": AUTH_TOKEN,
- }).Tx(rx).Url("/proxy")
- containers, err := c.ContainerNames(nil)
- if err != nil {
- t.Fatal(err)
- }
- if len(containers) != len(expected) {
- t.Fatal("Wrong number of containers", len(containers), rx, len(expected), expected)
- }
- for i := range containers {
- if containers[i] != expected[i] {
- t.Error("Bad container", containers[i], expected[i])
- }
- }
-}
-func TestInternalContainerNames(t *testing.T) {
- defer server.Finished()
- testContainerNames(t, "", []string{})
- testContainerNames(t, "one", []string{"one"})
- testContainerNames(t, "one\n", []string{"one"})
- testContainerNames(t, "one\ntwo\nthree\n", []string{"one", "two", "three"})
-}
diff --git a/vendor/github.com/ncw/swift/swift_test.go b/vendor/github.com/ncw/swift/swift_test.go
deleted file mode 100644
index 196dcd9b..00000000
--- a/vendor/github.com/ncw/swift/swift_test.go
+++ /dev/null
@@ -1,1593 +0,0 @@
-// This tests the swift packagae
-//
-// It can be used with a real swift server which should be set up in
-// the environment variables SWIFT_API_USER, SWIFT_API_KEY and
-// SWIFT_AUTH_URL
-// In case those variables are not defined, a fake Swift server
-// is used instead - see Testing in README.md for more info
-//
-// The functions are designed to run in order and create things the
-// next function tests. This means that if it goes wrong it is likely
-// errors will propagate. You may need to tidy up the CONTAINER to
-// get it to run cleanly.
-package swift_test
-
-import (
- "archive/tar"
- "bytes"
- "crypto/md5"
- "crypto/tls"
- "encoding/json"
- "encoding/xml"
- "fmt"
- "io"
- "io/ioutil"
- "net/http"
- "os"
- "strconv"
- "strings"
- "sync"
- "testing"
- "time"
-
- "github.com/ncw/swift"
- "github.com/ncw/swift/swifttest"
-)
-
-var (
- c *swift.Connection
- srv *swifttest.SwiftServer
- m1 = swift.Metadata{"Hello": "1", "potato-Salad": "2"}
- m2 = swift.Metadata{"hello": "", "potato-salad": ""}
- skipVersionTests = false
-)
-
-const (
- CONTAINER = "GoSwiftUnitTest"
- VERSIONS_CONTAINER = "GoSwiftUnitTestVersions"
- CURRENT_CONTAINER = "GoSwiftUnitTestCurrent"
- OBJECT = "test_object"
- OBJECT2 = "test_object2"
- EMPTYOBJECT = "empty_test_object"
- CONTENTS = "12345"
- CONTENTS2 = "54321"
- CONTENT_SIZE = int64(len(CONTENTS))
- CONTENT_MD5 = "827ccb0eea8a706c4c34a16891f84e7b"
- EMPTY_MD5 = "d41d8cd98f00b204e9800998ecf8427e"
- SECRET_KEY = "b3968d0207b54ece87cccc06515a89d4"
-)
-
-type someTransport struct{ http.Transport }
-
-func makeConnection() (*swift.Connection, error) {
- var err error
-
- UserName := os.Getenv("SWIFT_API_USER")
- ApiKey := os.Getenv("SWIFT_API_KEY")
- AuthUrl := os.Getenv("SWIFT_AUTH_URL")
- Region := os.Getenv("SWIFT_REGION_NAME")
-
- Insecure := os.Getenv("SWIFT_AUTH_INSECURE")
- ConnectionChannelTimeout := os.Getenv("SWIFT_CONNECTION_CHANNEL_TIMEOUT")
- DataChannelTimeout := os.Getenv("SWIFT_DATA_CHANNEL_TIMEOUT")
-
- if UserName == "" || ApiKey == "" || AuthUrl == "" {
- if srv != nil {
- srv.Close()
- }
- srv, err = swifttest.NewSwiftServer("localhost")
- if err != nil {
- return nil, err
- }
-
- UserName = "swifttest"
- ApiKey = "swifttest"
- AuthUrl = srv.AuthURL
- }
-
- transport := &http.Transport{
- Proxy: http.ProxyFromEnvironment,
- MaxIdleConnsPerHost: 2048,
- }
- if Insecure == "1" {
- transport.TLSClientConfig = &tls.Config{InsecureSkipVerify: true}
- }
-
- c := swift.Connection{
- UserName: UserName,
- ApiKey: ApiKey,
- AuthUrl: AuthUrl,
- Region: Region,
- Transport: transport,
- ConnectTimeout: 60 * time.Second,
- Timeout: 60 * time.Second,
- }
-
- var timeout int64
- if ConnectionChannelTimeout != "" {
- timeout, err = strconv.ParseInt(ConnectionChannelTimeout, 10, 32)
- if err == nil {
- c.ConnectTimeout = time.Duration(timeout) * time.Second
- }
- }
-
- if DataChannelTimeout != "" {
- timeout, err = strconv.ParseInt(DataChannelTimeout, 10, 32)
- if err == nil {
- c.Timeout = time.Duration(timeout) * time.Second
- }
- }
-
- return &c, nil
-}
-
-func isV3Api() bool {
- AuthUrl := os.Getenv("SWIFT_AUTH_URL")
- return strings.Contains(AuthUrl, "v3")
-}
-
-func TestTransport(t *testing.T) {
- var err error
-
- c, err = makeConnection()
- if err != nil {
- t.Fatal("Failed to create server", err)
- }
-
- tr := &someTransport{
- Transport: http.Transport{
- MaxIdleConnsPerHost: 2048,
- },
- }
-
- Insecure := os.Getenv("SWIFT_AUTH_INSECURE")
-
- if Insecure == "1" {
- tr.TLSClientConfig = &tls.Config{InsecureSkipVerify: true}
- }
-
- c.Transport = tr
-
- if isV3Api() {
- c.Tenant = os.Getenv("SWIFT_TENANT")
- c.Domain = os.Getenv("SWIFT_API_DOMAIN")
- } else {
- c.Tenant = os.Getenv("SWIFT_TENANT")
- c.TenantId = os.Getenv("SWIFT_TENANT_ID")
- }
-
- err = c.Authenticate()
- if err != nil {
- t.Fatal("Auth failed", err)
- }
- if !c.Authenticated() {
- t.Fatal("Not authenticated")
- }
- if srv != nil {
- srv.Close()
- }
-}
-
-// The following Test functions are run in order - this one must come before the others!
-func TestV1V2Authenticate(t *testing.T) {
- var err error
-
- if isV3Api() {
- return
- }
-
- c, err = makeConnection()
- if err != nil {
- t.Fatal("Failed to create server", err)
- }
-
- c.Tenant = os.Getenv("SWIFT_TENANT")
- c.TenantId = os.Getenv("SWIFT_TENANT_ID")
-
- err = c.Authenticate()
- if err != nil {
- t.Fatal("Auth failed", err)
- }
- if !c.Authenticated() {
- t.Fatal("Not authenticated")
- }
-}
-
-func TestV3AuthenticateWithDomainNameAndTenantId(t *testing.T) {
- var err error
- if !isV3Api() {
- return
- }
-
- c, err = makeConnection()
- if err != nil {
- t.Fatal("Failed to create server", err)
- }
-
- c.TenantId = os.Getenv("SWIFT_TENANT_ID")
- c.Domain = os.Getenv("SWIFT_API_DOMAIN")
-
- err = c.Authenticate()
- if err != nil {
- t.Fatal("Auth failed", err)
- }
- if !c.Authenticated() {
- t.Fatal("Not authenticated")
- }
-}
-
-func TestV3TrustWithTrustId(t *testing.T) {
- var err error
- if !isV3Api() {
- return
- }
-
- c, err = makeConnection()
- if err != nil {
- t.Fatal("Failed to create server", err)
- }
-
- c.TrustId = os.Getenv("SWIFT_TRUST_ID")
-
- err = c.Authenticate()
- if err != nil {
- t.Fatal("Auth failed", err)
- }
- if !c.Authenticated() {
- t.Fatal("Not authenticated")
- }
-}
-
-func TestV3AuthenticateWithDomainIdAndTenantId(t *testing.T) {
- var err error
-
- if !isV3Api() {
- return
- }
-
- c, err = makeConnection()
- if err != nil {
- t.Fatal("Failed to create server", err)
- }
-
- c.TenantId = os.Getenv("SWIFT_TENANT_ID")
- c.DomainId = os.Getenv("SWIFT_API_DOMAIN_ID")
-
- err = c.Authenticate()
- if err != nil {
- t.Fatal("Auth failed", err)
- }
- if !c.Authenticated() {
- t.Fatal("Not authenticated")
- }
-}
-
-func TestV3AuthenticateWithDomainNameAndTenantName(t *testing.T) {
- var err error
-
- if !isV3Api() {
- return
- }
-
- c, err = makeConnection()
- if err != nil {
- t.Fatal("Failed to create server", err)
- }
-
- c.Tenant = os.Getenv("SWIFT_TENANT")
- c.Domain = os.Getenv("SWIFT_API_DOMAIN")
-
- err = c.Authenticate()
- if err != nil {
- t.Fatal("Auth failed", err)
- }
- if !c.Authenticated() {
- t.Fatal("Not authenticated")
- }
-}
-
-func TestV3AuthenticateWithDomainIdAndTenantName(t *testing.T) {
- var err error
-
- if !isV3Api() {
- return
- }
-
- c, err = makeConnection()
- if err != nil {
- t.Fatal("Failed to create server", err)
- }
-
- c.Tenant = os.Getenv("SWIFT_TENANT")
- c.DomainId = os.Getenv("SWIFT_API_DOMAIN_ID")
-
- err = c.Authenticate()
- if err != nil {
- t.Fatal("Auth failed", err)
- }
- if !c.Authenticated() {
- t.Fatal("Not authenticated")
- }
-}
-
-// Attempt to trigger a race in authenticate
-//
-// Run with -race to test
-func TestAuthenticateRace(t *testing.T) {
- var wg sync.WaitGroup
- for i := 0; i < 10; i++ {
- wg.Add(1)
- go func() {
- defer wg.Done()
- err := c.Authenticate()
- if err != nil {
- t.Fatal("Auth failed", err)
- }
- if !c.Authenticated() {
- t.Fatal("Not authenticated")
- }
- }()
- }
- wg.Wait()
-}
-
-// Test a connection can be serialized and unserialized with JSON
-func TestSerializeConnectionJson(t *testing.T) {
- serializedConnection, err := json.Marshal(c)
- if err != nil {
- t.Fatalf("Failed to serialize connection: %v", err)
- }
- c2 := new(swift.Connection)
- err = json.Unmarshal(serializedConnection, &c2)
- if err != nil {
- t.Fatalf("Failed to unserialize connection: %v", err)
- }
- if !c2.Authenticated() {
- t.Fatal("Should be authenticated")
- }
- _, _, err = c2.Account()
- if err != nil {
- t.Fatalf("Failed to use unserialized connection: %v", err)
- }
-}
-
-// Test a connection can be serialized and unserialized with XML
-func TestSerializeConnectionXml(t *testing.T) {
- serializedConnection, err := xml.Marshal(c)
- if err != nil {
- t.Fatalf("Failed to serialize connection: %v", err)
- }
- c2 := new(swift.Connection)
- err = xml.Unmarshal(serializedConnection, &c2)
- if err != nil {
- t.Fatalf("Failed to unserialize connection: %v", err)
- }
- if !c2.Authenticated() {
- t.Fatal("Should be authenticated")
- }
- _, _, err = c2.Account()
- if err != nil {
- t.Fatalf("Failed to use unserialized connection: %v", err)
- }
-}
-
-// Test the reauthentication logic
-func TestOnReAuth(t *testing.T) {
- c2 := c
- c2.UnAuthenticate()
- _, _, err := c2.Account()
- if err != nil {
- t.Fatalf("Failed to reauthenticate: %v", err)
- }
-}
-func TestAccount(t *testing.T) {
- info, headers, err := c.Account()
- if err != nil {
- t.Fatal(err)
- }
- if headers["X-Account-Container-Count"] != fmt.Sprintf("%d", info.Containers) {
- t.Error("Bad container count")
- }
- if headers["X-Account-Bytes-Used"] != fmt.Sprintf("%d", info.BytesUsed) {
- t.Error("Bad bytes count")
- }
- if headers["X-Account-Object-Count"] != fmt.Sprintf("%d", info.Objects) {
- t.Error("Bad objects count")
- }
- //fmt.Println(info)
- //fmt.Println(headers)
-}
-
-func compareMaps(t *testing.T, a, b map[string]string) {
- if len(a) != len(b) {
- t.Error("Maps different sizes", a, b)
- }
- for ka, va := range a {
- if vb, ok := b[ka]; !ok || va != vb {
- t.Error("Difference in key", ka, va, b[ka])
- }
- }
- for kb, vb := range b {
- if va, ok := a[kb]; !ok || vb != va {
- t.Error("Difference in key", kb, vb, a[kb])
- }
- }
-}
-
-func TestAccountUpdate(t *testing.T) {
- err := c.AccountUpdate(m1.AccountHeaders())
- if err != nil {
- t.Fatal(err)
- }
-
- _, headers, err := c.Account()
- if err != nil {
- t.Fatal(err)
- }
- m := headers.AccountMetadata()
- delete(m, "temp-url-key") // remove X-Account-Meta-Temp-URL-Key if set
- compareMaps(t, m, map[string]string{"hello": "1", "potato-salad": "2"})
-
- err = c.AccountUpdate(m2.AccountHeaders())
- if err != nil {
- t.Fatal(err)
- }
-
- _, headers, err = c.Account()
- if err != nil {
- t.Fatal(err)
- }
- m = headers.AccountMetadata()
- delete(m, "temp-url-key") // remove X-Account-Meta-Temp-URL-Key if set
- compareMaps(t, m, map[string]string{})
-
- //fmt.Println(c.Account())
- //fmt.Println(headers)
- //fmt.Println(headers.AccountMetadata())
- //fmt.Println(c.AccountUpdate(m2.AccountHeaders()))
- //fmt.Println(c.Account())
-}
-
-func TestContainerCreate(t *testing.T) {
- err := c.ContainerCreate(CONTAINER, m1.ContainerHeaders())
- if err != nil {
- t.Fatal(err)
- }
-}
-
-func TestContainer(t *testing.T) {
- info, headers, err := c.Container(CONTAINER)
- if err != nil {
- t.Fatal(err)
- }
- compareMaps(t, headers.ContainerMetadata(), map[string]string{"hello": "1", "potato-salad": "2"})
- if CONTAINER != info.Name {
- t.Error("Bad container count")
- }
- if headers["X-Container-Bytes-Used"] != fmt.Sprintf("%d", info.Bytes) {
- t.Error("Bad bytes count")
- }
- if headers["X-Container-Object-Count"] != fmt.Sprintf("%d", info.Count) {
- t.Error("Bad objects count")
- }
- //fmt.Println(info)
- //fmt.Println(headers)
-}
-
-func TestContainersAll(t *testing.T) {
- containers1, err := c.ContainersAll(nil)
- if err != nil {
- t.Fatal(err)
- }
- containers2, err := c.Containers(nil)
- if err != nil {
- t.Fatal(err)
- }
- if len(containers1) != len(containers2) {
- t.Fatal("Wrong length")
- }
- for i := range containers1 {
- if containers1[i] != containers2[i] {
- t.Fatal("Not the same")
- }
- }
-}
-
-func TestContainersAllWithLimit(t *testing.T) {
- containers1, err := c.ContainersAll(&swift.ContainersOpts{Limit: 1})
- if err != nil {
- t.Fatal(err)
- }
- containers2, err := c.Containers(nil)
- if err != nil {
- t.Fatal(err)
- }
- if len(containers1) != len(containers2) {
- t.Fatal("Wrong length")
- }
- for i := range containers1 {
- if containers1[i] != containers2[i] {
- t.Fatal("Not the same")
- }
- }
-}
-
-func TestContainerUpdate(t *testing.T) {
- err := c.ContainerUpdate(CONTAINER, m2.ContainerHeaders())
- if err != nil {
- t.Fatal(err)
- }
- _, headers, err := c.Container(CONTAINER)
- if err != nil {
- t.Fatal(err)
- }
- compareMaps(t, headers.ContainerMetadata(), map[string]string{})
- //fmt.Println(headers)
-}
-
-func TestContainerNames(t *testing.T) {
- containers, err := c.ContainerNames(nil)
- if err != nil {
- t.Fatal(err)
- }
- // fmt.Printf("container %q\n", CONTAINER)
- ok := false
- for _, container := range containers {
- if container == CONTAINER {
- ok = true
- break
- }
- }
- if !ok {
- t.Errorf("Didn't find container %q in listing %q", CONTAINER, containers)
- }
- // fmt.Println(containers)
-}
-
-func TestContainerNamesAll(t *testing.T) {
- containers1, err := c.ContainerNamesAll(nil)
- if err != nil {
- t.Fatal(err)
- }
- containers2, err := c.ContainerNames(nil)
- if err != nil {
- t.Fatal(err)
- }
- if len(containers1) != len(containers2) {
- t.Fatal("Wrong length")
- }
- for i := range containers1 {
- if containers1[i] != containers2[i] {
- t.Fatal("Not the same")
- }
- }
-}
-
-func TestContainerNamesAllWithLimit(t *testing.T) {
- containers1, err := c.ContainerNamesAll(&swift.ContainersOpts{Limit: 1})
- if err != nil {
- t.Fatal(err)
- }
- containers2, err := c.ContainerNames(nil)
- if err != nil {
- t.Fatal(err)
- }
- if len(containers1) != len(containers2) {
- t.Fatal("Wrong length")
- }
- for i := range containers1 {
- if containers1[i] != containers2[i] {
- t.Fatal("Not the same")
- }
- }
-}
-
-func TestObjectPutString(t *testing.T) {
- err := c.ObjectPutString(CONTAINER, OBJECT, CONTENTS, "")
- if err != nil {
- t.Fatal(err)
- }
-
- info, _, err := c.Object(CONTAINER, OBJECT)
- if err != nil {
- t.Error(err)
- }
- if info.ContentType != "application/octet-stream" {
- t.Error("Bad content type", info.ContentType)
- }
- if info.Bytes != CONTENT_SIZE {
- t.Error("Bad length")
- }
- if info.Hash != CONTENT_MD5 {
- t.Error("Bad length")
- }
-}
-
-func TestObjectPut(t *testing.T) {
- headers := swift.Headers{}
-
- // Set content size incorrectly - should produce an error
- headers["Content-Length"] = strconv.FormatInt(CONTENT_SIZE-1, 10)
- contents := bytes.NewBufferString(CONTENTS)
- h, err := c.ObjectPut(CONTAINER, OBJECT, contents, true, CONTENT_MD5, "text/plain", headers)
- if err == nil {
- t.Fatal("Expecting error but didn't get one")
- }
-
- // Now set content size correctly
- contents = bytes.NewBufferString(CONTENTS)
- headers["Content-Length"] = strconv.FormatInt(CONTENT_SIZE, 10)
- h, err = c.ObjectPut(CONTAINER, OBJECT, contents, true, CONTENT_MD5, "text/plain", headers)
- if err != nil {
- t.Fatal(err)
- }
-
- if h["Etag"] != CONTENT_MD5 {
- t.Errorf("Bad Etag want %q got %q", CONTENT_MD5, h["Etag"])
- }
-
- // Fetch object info and compare
- info, _, err := c.Object(CONTAINER, OBJECT)
- if err != nil {
- t.Error(err)
- }
- if info.ContentType != "text/plain" {
- t.Error("Bad content type", info.ContentType)
- }
- if info.Bytes != CONTENT_SIZE {
- t.Error("Bad length")
- }
- if info.Hash != CONTENT_MD5 {
- t.Error("Bad length")
- }
-}
-
-func TestObjectEmpty(t *testing.T) {
- err := c.ObjectPutString(CONTAINER, EMPTYOBJECT, "", "")
- if err != nil {
- t.Fatal(err)
- }
-
- info, _, err := c.Object(CONTAINER, EMPTYOBJECT)
- if err != nil {
- t.Error(err)
- }
- if info.ContentType != "application/octet-stream" {
- t.Error("Bad content type", info.ContentType)
- }
- if info.Bytes != 0 {
- t.Errorf("Bad length want 0 got %v", info.Bytes)
- }
- if info.Hash != EMPTY_MD5 {
- t.Errorf("Bad MD5 want %v got %v", EMPTY_MD5, info.Hash)
- }
-
- // Tidy up
- err = c.ObjectDelete(CONTAINER, EMPTYOBJECT)
- if err != nil {
- t.Error(err)
- }
-}
-
-func TestObjectPutBytes(t *testing.T) {
- err := c.ObjectPutBytes(CONTAINER, OBJECT, []byte(CONTENTS), "")
- if err != nil {
- t.Fatal(err)
- }
-
- info, _, err := c.Object(CONTAINER, OBJECT)
- if err != nil {
- t.Error(err)
- }
- if info.ContentType != "application/octet-stream" {
- t.Error("Bad content type", info.ContentType)
- }
- if info.Bytes != CONTENT_SIZE {
- t.Error("Bad length")
- }
- if info.Hash != CONTENT_MD5 {
- t.Error("Bad length")
- }
-}
-
-func TestObjectPutMimeType(t *testing.T) {
- err := c.ObjectPutString(CONTAINER, "test.jpg", CONTENTS, "")
- if err != nil {
- t.Fatal(err)
- }
-
- info, _, err := c.Object(CONTAINER, "test.jpg")
- if err != nil {
- t.Error(err)
- }
- if info.ContentType != "image/jpeg" {
- t.Error("Bad content type", info.ContentType)
- }
-
- // Tidy up
- err = c.ObjectDelete(CONTAINER, "test.jpg")
- if err != nil {
- t.Error(err)
- }
-}
-
-func TestObjectCreate(t *testing.T) {
- out, err := c.ObjectCreate(CONTAINER, OBJECT2, true, "", "", nil)
- if err != nil {
- t.Fatal(err)
- }
- buf := &bytes.Buffer{}
- hash := md5.New()
- out2 := io.MultiWriter(out, buf, hash)
- for i := 0; i < 100; i++ {
- fmt.Fprintf(out2, "%d %s\n", i, CONTENTS)
- }
- err = out.Close()
- if err != nil {
- t.Error(err)
- }
- expected := buf.String()
- contents, err := c.ObjectGetString(CONTAINER, OBJECT2)
- if err != nil {
- t.Error(err)
- }
- if contents != expected {
- t.Error("Contents wrong")
- }
-
- // Test writing on closed file
- n, err := out.Write([]byte{0})
- if err == nil || n != 0 {
- t.Error("Expecting error and n == 0 writing on closed file", err, n)
- }
-
- // Now with hash instead
- out, err = c.ObjectCreate(CONTAINER, OBJECT2, false, fmt.Sprintf("%x", hash.Sum(nil)), "", nil)
- if err != nil {
- t.Fatal(err)
- }
- _, err = out.Write(buf.Bytes())
- if err != nil {
- t.Error(err)
- }
- err = out.Close()
- if err != nil {
- t.Error(err)
- }
- contents, err = c.ObjectGetString(CONTAINER, OBJECT2)
- if err != nil {
- t.Error(err)
- }
- if contents != expected {
- t.Error("Contents wrong")
- }
-
- // Now with bad hash
- out, err = c.ObjectCreate(CONTAINER, OBJECT2, false, CONTENT_MD5, "", nil)
- if err != nil {
- t.Fatal(err)
- }
- // FIXME: work around bug which produces 503 not 422 for empty corrupted files
- fmt.Fprintf(out, "Sausage")
- err = out.Close()
- if err != swift.ObjectCorrupted {
- t.Error("Expecting object corrupted not", err)
- }
-
- // Tidy up
- err = c.ObjectDelete(CONTAINER, OBJECT2)
- if err != nil {
- t.Error(err)
- }
-}
-
-func TestObjectGetString(t *testing.T) {
- contents, err := c.ObjectGetString(CONTAINER, OBJECT)
- if err != nil {
- t.Fatal(err)
- }
- if contents != CONTENTS {
- t.Error("Contents wrong")
- }
- //fmt.Println(contents)
-}
-
-func TestObjectGetBytes(t *testing.T) {
- contents, err := c.ObjectGetBytes(CONTAINER, OBJECT)
- if err != nil {
- t.Fatal(err)
- }
- if string(contents) != CONTENTS {
- t.Error("Contents wrong")
- }
- //fmt.Println(contents)
-}
-
-func TestObjectOpen(t *testing.T) {
- file, _, err := c.ObjectOpen(CONTAINER, OBJECT, true, nil)
- if err != nil {
- t.Fatal(err)
- }
- var buf bytes.Buffer
- n, err := io.Copy(&buf, file)
- if err != nil {
- t.Fatal(err)
- }
- if n != CONTENT_SIZE {
- t.Fatal("Wrong length", n, CONTENT_SIZE)
- }
- if buf.String() != CONTENTS {
- t.Error("Contents wrong")
- }
- err = file.Close()
- if err != nil {
- t.Fatal(err)
- }
-}
-
-func TestObjectOpenPartial(t *testing.T) {
- file, _, err := c.ObjectOpen(CONTAINER, OBJECT, true, nil)
- if err != nil {
- t.Fatal(err)
- }
- var buf bytes.Buffer
- n, err := io.CopyN(&buf, file, 1)
- if err != nil {
- t.Fatal(err)
- }
- if n != 1 {
- t.Fatal("Wrong length", n, CONTENT_SIZE)
- }
- if buf.String() != CONTENTS[:1] {
- t.Error("Contents wrong")
- }
- err = file.Close()
- if err != nil {
- t.Fatal(err)
- }
-}
-
-func TestObjectOpenLength(t *testing.T) {
- file, _, err := c.ObjectOpen(CONTAINER, OBJECT, true, nil)
- if err != nil {
- t.Fatal(err)
- }
- // FIXME ideally this would check both branches of the Length() code
- n, err := file.Length()
- if err != nil {
- t.Fatal(err)
- }
- if n != CONTENT_SIZE {
- t.Fatal("Wrong length", n, CONTENT_SIZE)
- }
- err = file.Close()
- if err != nil {
- t.Fatal(err)
- }
-}
-
-func TestObjectOpenSeek(t *testing.T) {
-
- plan := []struct {
- whence int
- offset int64
- result int64
- }{
- {-1, 0, 0},
- {-1, 0, 1},
- {-1, 0, 2},
- {0, 0, 0},
- {0, 0, 0},
- {0, 1, 1},
- {0, 2, 2},
- {1, 0, 3},
- {1, -2, 2},
- {1, 1, 4},
- {2, -1, 4},
- {2, -3, 2},
- {2, -2, 3},
- {2, -5, 0},
- {2, -4, 1},
- }
-
- file, _, err := c.ObjectOpen(CONTAINER, OBJECT, true, nil)
- if err != nil {
- t.Fatal(err)
- }
-
- for _, p := range plan {
- if p.whence >= 0 {
- result, err := file.Seek(p.offset, p.whence)
- if err != nil {
- t.Fatal(err, p)
- }
- if result != p.result {
- t.Fatal("Seek result was", result, "expecting", p.result, p)
- }
-
- }
- var buf bytes.Buffer
- n, err := io.CopyN(&buf, file, 1)
- if err != nil {
- t.Fatal(err, p)
- }
- if n != 1 {
- t.Fatal("Wrong length", n, p)
- }
- actual := buf.String()
- expected := CONTENTS[p.result : p.result+1]
- if actual != expected {
- t.Error("Contents wrong, expecting", expected, "got", actual, p)
- }
- }
-
- err = file.Close()
- if err != nil {
- t.Fatal(err)
- }
-}
-
-func TestObjectUpdate(t *testing.T) {
- err := c.ObjectUpdate(CONTAINER, OBJECT, m1.ObjectHeaders())
- if err != nil {
- t.Fatal(err)
- }
-}
-
-func checkTime(t *testing.T, when time.Time, low, high int) {
- dt := time.Now().Sub(when)
- if dt < time.Duration(low)*time.Second || dt > time.Duration(high)*time.Second {
- t.Errorf("Time is wrong: dt=%q, when=%q", dt, when)
- }
-}
-
-func TestObject(t *testing.T) {
- object, headers, err := c.Object(CONTAINER, OBJECT)
- if err != nil {
- t.Fatal(err)
- }
- compareMaps(t, headers.ObjectMetadata(), map[string]string{"hello": "1", "potato-salad": "2"})
- if object.Name != OBJECT || object.Bytes != CONTENT_SIZE || object.ContentType != "application/octet-stream" || object.Hash != CONTENT_MD5 || object.PseudoDirectory != false || object.SubDir != "" {
- t.Error("Bad object info", object)
- }
- checkTime(t, object.LastModified, -10, 10)
-}
-
-func TestObjectUpdate2(t *testing.T) {
- err := c.ObjectUpdate(CONTAINER, OBJECT, m2.ObjectHeaders())
- if err != nil {
- t.Fatal(err)
- }
- _, headers, err := c.Object(CONTAINER, OBJECT)
- if err != nil {
- t.Fatal(err)
- }
- //fmt.Println(headers, headers.ObjectMetadata())
- compareMaps(t, headers.ObjectMetadata(), map[string]string{"hello": "", "potato-salad": ""})
-}
-
-func TestContainers(t *testing.T) {
- containers, err := c.Containers(nil)
- if err != nil {
- t.Fatal(err)
- }
- ok := false
- for _, container := range containers {
- if container.Name == CONTAINER {
- ok = true
- // Container may or may not have the file contents in it
- // Swift updates may be behind
- if container.Count == 0 && container.Bytes == 0 {
- break
- }
- if container.Count == 1 && container.Bytes == CONTENT_SIZE {
- break
- }
- t.Errorf("Bad size of Container %q: %q", CONTAINER, container)
- break
- }
- }
- if !ok {
- t.Errorf("Didn't find container %q in listing %q", CONTAINER, containers)
- }
- //fmt.Println(containers)
-}
-
-func TestObjectNames(t *testing.T) {
- objects, err := c.ObjectNames(CONTAINER, nil)
- if err != nil {
- t.Fatal(err)
- }
- if len(objects) != 1 || objects[0] != OBJECT {
- t.Error("Incorrect listing", objects)
- }
- //fmt.Println(objects)
-}
-
-func TestObjectNamesAll(t *testing.T) {
- objects, err := c.ObjectNamesAll(CONTAINER, nil)
- if err != nil {
- t.Fatal(err)
- }
- if len(objects) != 1 || objects[0] != OBJECT {
- t.Error("Incorrect listing", objects)
- }
- //fmt.Println(objects)
-}
-
-func TestObjectNamesAllWithLimit(t *testing.T) {
- objects, err := c.ObjectNamesAll(CONTAINER, &swift.ObjectsOpts{Limit: 1})
- if err != nil {
- t.Fatal(err)
- }
- if len(objects) != 1 || objects[0] != OBJECT {
- t.Error("Incorrect listing", objects)
- }
- //fmt.Println(objects)
-}
-
-func TestObjectsWalk(t *testing.T) {
- objects := make([]string, 0)
- err := c.ObjectsWalk(container, nil, func(opts *swift.ObjectsOpts) (interface{}, error) {
- newObjects, err := c.ObjectNames(CONTAINER, opts)
- if err == nil {
- objects = append(objects, newObjects...)
- }
- return newObjects, err
- })
- if err != nil {
- t.Fatal(err)
- }
- if len(objects) != 1 || objects[0] != OBJECT {
- t.Error("Incorrect listing", objects)
- }
- //fmt.Println(objects)
-}
-
-func TestObjects(t *testing.T) {
- objects, err := c.Objects(CONTAINER, &swift.ObjectsOpts{Delimiter: '/'})
- if err != nil {
- t.Fatal(err)
- }
- if len(objects) != 1 {
- t.Fatal("Should only be 1 object")
- }
- object := objects[0]
- if object.Name != OBJECT || object.Bytes != CONTENT_SIZE || object.ContentType != "application/octet-stream" || object.Hash != CONTENT_MD5 || object.PseudoDirectory != false || object.SubDir != "" {
- t.Error("Bad object info", object)
- }
- checkTime(t, object.LastModified, -10, 10)
- // fmt.Println(objects)
-}
-
-func TestObjectsDirectory(t *testing.T) {
- err := c.ObjectPutString(CONTAINER, "directory", "", "application/directory")
- if err != nil {
- t.Fatal(err)
- }
- defer c.ObjectDelete(CONTAINER, "directory")
-
- // Look for the directory object and check we aren't confusing
- // it with a pseudo directory object
- objects, err := c.Objects(CONTAINER, &swift.ObjectsOpts{Delimiter: '/'})
- if err != nil {
- t.Fatal(err)
- }
- if len(objects) != 2 {
- t.Fatal("Should only be 2 objects")
- }
- found := false
- for i := range objects {
- object := objects[i]
- if object.Name == "directory" {
- found = true
- if object.Bytes != 0 || object.ContentType != "application/directory" || object.Hash != "d41d8cd98f00b204e9800998ecf8427e" || object.PseudoDirectory != false || object.SubDir != "" {
- t.Error("Bad object info", object)
- }
- checkTime(t, object.LastModified, -10, 10)
- }
- }
- if !found {
- t.Error("Didn't find directory object")
- }
- // fmt.Println(objects)
-}
-
-func TestObjectsPseudoDirectory(t *testing.T) {
- err := c.ObjectPutString(CONTAINER, "directory/puppy.jpg", "cute puppy", "")
- if err != nil {
- t.Fatal(err)
- }
- defer c.ObjectDelete(CONTAINER, "directory/puppy.jpg")
-
- // Look for the pseudo directory
- objects, err := c.Objects(CONTAINER, &swift.ObjectsOpts{Delimiter: '/'})
- if err != nil {
- t.Fatal(err)
- }
- if len(objects) != 2 {
- t.Fatal("Should only be 2 objects", objects)
- }
- found := false
- for i := range objects {
- object := objects[i]
- if object.Name == "directory/" {
- found = true
- if object.Bytes != 0 || object.ContentType != "application/directory" || object.Hash != "" || object.PseudoDirectory != true || object.SubDir != "directory/" && object.LastModified.IsZero() {
- t.Error("Bad object info", object)
- }
- }
- }
- if !found {
- t.Error("Didn't find directory object", objects)
- }
-
- // Look in the pseudo directory now
- objects, err = c.Objects(CONTAINER, &swift.ObjectsOpts{Delimiter: '/', Path: "directory/"})
- if err != nil {
- t.Fatal(err)
- }
- if len(objects) != 1 {
- t.Fatal("Should only be 1 object", objects)
- }
- object := objects[0]
- if object.Name != "directory/puppy.jpg" || object.Bytes != 10 || object.ContentType != "image/jpeg" || object.Hash != "87a12ea22fca7f54f0cefef1da535489" || object.PseudoDirectory != false || object.SubDir != "" {
- t.Error("Bad object info", object)
- }
- checkTime(t, object.LastModified, -10, 10)
- // fmt.Println(objects)
-}
-
-func TestObjectsAll(t *testing.T) {
- objects, err := c.ObjectsAll(CONTAINER, nil)
- if err != nil {
- t.Fatal(err)
- }
- if len(objects) != 1 || objects[0].Name != OBJECT {
- t.Error("Incorrect listing", objects)
- }
- //fmt.Println(objects)
-}
-
-func TestObjectsAllWithLimit(t *testing.T) {
- objects, err := c.ObjectsAll(CONTAINER, &swift.ObjectsOpts{Limit: 1})
- if err != nil {
- t.Fatal(err)
- }
- if len(objects) != 1 || objects[0].Name != OBJECT {
- t.Error("Incorrect listing", objects)
- }
- //fmt.Println(objects)
-}
-
-func TestObjectNamesWithPath(t *testing.T) {
- objects, err := c.ObjectNames(CONTAINER, &swift.ObjectsOpts{Delimiter: '/', Path: ""})
- if err != nil {
- t.Fatal(err)
- }
- if len(objects) != 1 || objects[0] != OBJECT {
- t.Error("Bad listing with path", objects)
- }
- // fmt.Println(objects)
- objects, err = c.ObjectNames(CONTAINER, &swift.ObjectsOpts{Delimiter: '/', Path: "Downloads/"})
- if err != nil {
- t.Fatal(err)
- }
- if len(objects) != 0 {
- t.Error("Bad listing with path", objects)
- }
- // fmt.Println(objects)
-}
-
-func TestObjectCopy(t *testing.T) {
- _, err := c.ObjectCopy(CONTAINER, OBJECT, CONTAINER, OBJECT2, nil)
- if err != nil {
- t.Fatal(err)
- }
- err = c.ObjectDelete(CONTAINER, OBJECT2)
- if err != nil {
- t.Fatal(err)
- }
-}
-
-func TestObjectCopyWithMetadata(t *testing.T) {
- m := swift.Metadata{}
- m["copy-special-metadata"] = "hello"
- m["hello"] = "3"
- h := m.ObjectHeaders()
- h["Content-Type"] = "image/jpeg"
- _, err := c.ObjectCopy(CONTAINER, OBJECT, CONTAINER, OBJECT2, h)
- if err != nil {
- t.Fatal(err)
- }
- // Re-read the metadata to see if it is correct
- _, headers, err := c.Object(CONTAINER, OBJECT2)
- if err != nil {
- t.Fatal(err)
- }
- if headers["Content-Type"] != "image/jpeg" {
- t.Error("Didn't change content type")
- }
- compareMaps(t, headers.ObjectMetadata(), map[string]string{"hello": "3", "potato-salad": "", "copy-special-metadata": "hello"})
- err = c.ObjectDelete(CONTAINER, OBJECT2)
- if err != nil {
- t.Fatal(err)
- }
-}
-
-func TestObjectMove(t *testing.T) {
- err := c.ObjectMove(CONTAINER, OBJECT, CONTAINER, OBJECT2)
- if err != nil {
- t.Fatal(err)
- }
- testExistenceAfterDelete(t, CONTAINER, OBJECT)
- _, _, err = c.Object(CONTAINER, OBJECT2)
- if err != nil {
- t.Fatal(err)
- }
-
- err = c.ObjectMove(CONTAINER, OBJECT2, CONTAINER, OBJECT)
- if err != nil {
- t.Fatal(err)
- }
- testExistenceAfterDelete(t, CONTAINER, OBJECT2)
- _, headers, err := c.Object(CONTAINER, OBJECT)
- if err != nil {
- t.Fatal(err)
- }
- compareMaps(t, headers.ObjectMetadata(), map[string]string{"hello": "", "potato-salad": ""})
-}
-
-func TestObjectUpdateContentType(t *testing.T) {
- err := c.ObjectUpdateContentType(CONTAINER, OBJECT, "text/potato")
- if err != nil {
- t.Fatal(err)
- }
- // Re-read the metadata to see if it is correct
- _, headers, err := c.Object(CONTAINER, OBJECT)
- if err != nil {
- t.Fatal(err)
- }
- if headers["Content-Type"] != "text/potato" {
- t.Error("Didn't change content type")
- }
- compareMaps(t, headers.ObjectMetadata(), map[string]string{"hello": "", "potato-salad": ""})
-}
-
-func TestVersionContainerCreate(t *testing.T) {
- if err := c.VersionContainerCreate(CURRENT_CONTAINER, VERSIONS_CONTAINER); err != nil {
- if err == swift.Forbidden {
- t.Log("Server doesn't support Versions - skipping test")
- skipVersionTests = true
- return
- }
- t.Fatal(err)
- }
-}
-
-func TestVersionObjectAdd(t *testing.T) {
- if skipVersionTests {
- t.Log("Server doesn't support Versions - skipping test")
- return
- }
- // Version 1
- if err := c.ObjectPutString(CURRENT_CONTAINER, OBJECT, CONTENTS, ""); err != nil {
- t.Fatal(err)
- }
- if contents, err := c.ObjectGetString(CURRENT_CONTAINER, OBJECT); err != nil {
- t.Fatal(err)
- } else if contents != CONTENTS {
- t.Error("Contents wrong")
- }
-
- // Version 2
- if err := c.ObjectPutString(CURRENT_CONTAINER, OBJECT, CONTENTS2, ""); err != nil {
- t.Fatal(err)
- }
- if contents, err := c.ObjectGetString(CURRENT_CONTAINER, OBJECT); err != nil {
- t.Fatal(err)
- } else if contents != CONTENTS2 {
- t.Error("Contents wrong")
- }
-
- // Version 3
- if err := c.ObjectPutString(CURRENT_CONTAINER, OBJECT, CONTENTS2, ""); err != nil {
- t.Fatal(err)
- }
-}
-
-func TestVersionObjectList(t *testing.T) {
- if skipVersionTests {
- t.Log("Server doesn't support Versions - skipping test")
- return
- }
- list, err := c.VersionObjectList(VERSIONS_CONTAINER, OBJECT)
- if err != nil {
- t.Fatal(err)
- }
-
- if len(list) != 2 {
- t.Error("Version list should return 2 objects")
- }
-
- //fmt.Print(list)
-}
-
-func TestVersionObjectDelete(t *testing.T) {
- if skipVersionTests {
- t.Log("Server doesn't support Versions - skipping test")
- return
- }
- // Delete Version 3
- if err := c.ObjectDelete(CURRENT_CONTAINER, OBJECT); err != nil {
- t.Fatal(err)
- }
-
- // Delete Version 2
- if err := c.ObjectDelete(CURRENT_CONTAINER, OBJECT); err != nil {
- t.Fatal(err)
- }
-
- // Contents should be reverted to Version 1
- if contents, err := c.ObjectGetString(CURRENT_CONTAINER, OBJECT); err != nil {
- t.Fatal(err)
- } else if contents != CONTENTS {
- t.Error("Contents wrong")
- }
-}
-
-// cleanUpContainer deletes everything in the container and then the
-// container. It expects the container to be empty and if it wasn't
-// it logs an error.
-func cleanUpContainer(t *testing.T, container string) {
- objects, err := c.Objects(container, nil)
- if err != nil {
- t.Error(err, container)
- } else {
- if len(objects) != 0 {
- t.Error("Container not empty", container)
- }
- for _, object := range objects {
- t.Log("Deleting spurious", object.Name)
- err = c.ObjectDelete(container, object.Name)
- if err != nil {
- t.Error(err, container)
- }
- }
- }
-
- if err := c.ContainerDelete(container); err != nil {
- t.Error(err, container)
- }
-}
-
-func TestVersionDeleteContent(t *testing.T) {
- if skipVersionTests {
- t.Log("Server doesn't support Versions - skipping test")
- } else {
- // Delete Version 1
- if err := c.ObjectDelete(CURRENT_CONTAINER, OBJECT); err != nil {
- t.Fatal(err)
- }
- }
- cleanUpContainer(t, VERSIONS_CONTAINER)
- cleanUpContainer(t, CURRENT_CONTAINER)
-}
-
-// Check for non existence after delete
-// May have to do it a few times to wait for swift to be consistent.
-func testExistenceAfterDelete(t *testing.T, container, object string) {
- for i := 10; i <= 0; i-- {
- _, _, err := c.Object(container, object)
- if err == swift.ObjectNotFound {
- break
- }
- if i == 0 {
- t.Fatalf("Expecting object %q/%q not found not: err=%v", container, object, err)
- }
- time.Sleep(1 * time.Second)
- }
-}
-
-func TestObjectDelete(t *testing.T) {
- err := c.ObjectDelete(CONTAINER, OBJECT)
- if err != nil {
- t.Fatal(err)
- }
- testExistenceAfterDelete(t, CONTAINER, OBJECT)
- err = c.ObjectDelete(CONTAINER, OBJECT)
- if err != swift.ObjectNotFound {
- t.Fatal("Expecting Object not found", err)
- }
-}
-
-func TestBulkDelete(t *testing.T) {
- result, err := c.BulkDelete(CONTAINER, []string{OBJECT})
- if err == swift.Forbidden {
- t.Log("Server doesn't support BulkDelete - skipping test")
- return
- }
- if err != nil {
- t.Fatal(err)
- }
- if result.NumberNotFound != 1 {
- t.Error("Expected 1, actual:", result.NumberNotFound)
- }
- if result.NumberDeleted != 0 {
- t.Error("Expected 0, actual:", result.NumberDeleted)
- }
- err = c.ObjectPutString(CONTAINER, OBJECT, CONTENTS, "")
- if err != nil {
- t.Fatal(err)
- }
- result, err = c.BulkDelete(CONTAINER, []string{OBJECT2, OBJECT})
- if err != nil {
- t.Fatal(err)
- }
- if result.NumberNotFound != 1 {
- t.Error("Expected 1, actual:", result.NumberNotFound)
- }
- if result.NumberDeleted != 1 {
- t.Error("Expected 1, actual:", result.NumberDeleted)
- }
- t.Log("Errors:", result.Errors)
-}
-
-func TestBulkUpload(t *testing.T) {
- buffer := new(bytes.Buffer)
- ds := tar.NewWriter(buffer)
- var files = []struct{ Name, Body string }{
- {OBJECT, CONTENTS},
- {OBJECT2, CONTENTS2},
- }
- for _, file := range files {
- hdr := &tar.Header{
- Name: file.Name,
- Size: int64(len(file.Body)),
- }
- if err := ds.WriteHeader(hdr); err != nil {
- t.Fatal(err)
- }
- if _, err := ds.Write([]byte(file.Body)); err != nil {
- t.Fatal(err)
- }
- }
- if err := ds.Close(); err != nil {
- t.Fatal(err)
- }
-
- result, err := c.BulkUpload(CONTAINER, buffer, swift.UploadTar, nil)
- if err == swift.Forbidden {
- t.Log("Server doesn't support BulkUpload - skipping test")
- return
- }
- if err != nil {
- t.Fatal(err)
- }
- if result.NumberCreated != 2 {
- t.Error("Expected 2, actual:", result.NumberCreated)
- }
- t.Log("Errors:", result.Errors)
-
- _, _, err = c.Object(CONTAINER, OBJECT)
- if err != nil {
- t.Error("Expecting object to be found")
- }
- _, _, err = c.Object(CONTAINER, OBJECT2)
- if err != nil {
- t.Error("Expecting object to be found")
- }
- c.ObjectDelete(CONTAINER, OBJECT)
- c.ObjectDelete(CONTAINER, OBJECT2)
-}
-
-func TestObjectDifficultName(t *testing.T) {
- const name = `hello? sausage/êé/Hello, 世界/ " ' @ < > & ?/`
- err := c.ObjectPutString(CONTAINER, name, CONTENTS, "")
- if err != nil {
- t.Fatal(err)
- }
- objects, err := c.ObjectNamesAll(CONTAINER, nil)
- if err != nil {
- t.Error(err)
- }
- found := false
- for _, object := range objects {
- if object == name {
- found = true
- break
- }
- }
- if !found {
- t.Errorf("Couldn't find %q in listing %q", name, objects)
- }
- err = c.ObjectDelete(CONTAINER, name)
- if err != nil {
- t.Fatal(err)
- }
-}
-
-func TestTempUrl(t *testing.T) {
- err := c.ObjectPutBytes(CONTAINER, OBJECT, []byte(CONTENTS), "")
- if err != nil {
- t.Fatal(err)
- }
-
- m := swift.Metadata{}
- m["temp-url-key"] = SECRET_KEY
- err = c.AccountUpdate(m.AccountHeaders())
- if err != nil {
- t.Fatal(err)
- }
-
- expiresTime := time.Now().Add(20 * time.Minute)
- tempUrl := c.ObjectTempUrl(CONTAINER, OBJECT, SECRET_KEY, "GET", expiresTime)
- resp, err := http.Get(tempUrl)
- if err != nil {
- t.Fatal("Failed to retrieve file from temporary url")
- }
- if resp.StatusCode == 401 {
- t.Log("Server doesn't support tempurl")
- } else if resp.StatusCode != 200 {
- t.Fatal("HTTP Error retrieving file from temporary url", resp.StatusCode)
- } else {
- if content, err := ioutil.ReadAll(resp.Body); err != nil || string(content) != CONTENTS {
- t.Error("Bad content", err)
- }
-
- resp, err := http.Post(tempUrl, "image/jpeg", bytes.NewReader([]byte(CONTENTS)))
- if err != nil {
- t.Fatal("Failed to retrieve file from temporary url")
- }
- if resp.StatusCode != 401 {
- t.Fatal("Expecting server to forbid access to object")
- }
- }
-
- resp.Body.Close()
- err = c.ObjectDelete(CONTAINER, OBJECT)
- if err != nil {
- t.Fatal(err)
- }
-}
-
-func TestQueryInfo(t *testing.T) {
- infos, err := c.QueryInfo()
- if err != nil {
- t.Log("Server doesn't support querying info")
- return
- }
- if _, ok := infos["swift"]; !ok {
- t.Fatal("No 'swift' section found in configuration")
- }
-}
-
-func TestContainerDelete(t *testing.T) {
- err := c.ContainerDelete(CONTAINER)
- if err != nil {
- t.Fatal(err)
- }
- err = c.ContainerDelete(CONTAINER)
- if err != swift.ContainerNotFound {
- t.Fatal("Expecting container not found", err)
- }
- _, _, err = c.Container(CONTAINER)
- if err != swift.ContainerNotFound {
- t.Fatal("Expecting container not found", err)
- }
-}
-
-func TestUnAuthenticate(t *testing.T) {
- c.UnAuthenticate()
- if c.Authenticated() {
- t.Fatal("Shouldn't be authenticated")
- }
- // Test re-authenticate
- err := c.Authenticate()
- if err != nil {
- t.Fatal("ReAuth failed", err)
- }
- if !c.Authenticated() {
- t.Fatal("Not authenticated")
- }
-}
diff --git a/vendor/github.com/ncw/swift/timeout_reader_test.go b/vendor/github.com/ncw/swift/timeout_reader_test.go
deleted file mode 100644
index 2348617b..00000000
--- a/vendor/github.com/ncw/swift/timeout_reader_test.go
+++ /dev/null
@@ -1,107 +0,0 @@
-// This tests TimeoutReader
-
-package swift
-
-import (
- "io"
- "io/ioutil"
- "sync"
- "testing"
- "time"
-)
-
-// An io.ReadCloser for testing
-type testReader struct {
- sync.Mutex
- n int
- delay time.Duration
- closed bool
-}
-
-// Returns n bytes with at time.Duration delay
-func newTestReader(n int, delay time.Duration) *testReader {
- return &testReader{
- n: n,
- delay: delay,
- }
-}
-
-// Returns 1 byte at a time after delay
-func (t *testReader) Read(p []byte) (n int, err error) {
- if t.n <= 0 {
- return 0, io.EOF
- }
- time.Sleep(t.delay)
- p[0] = 'A'
- t.Lock()
- t.n--
- t.Unlock()
- return 1, nil
-}
-
-// Close the channel
-func (t *testReader) Close() error {
- t.Lock()
- t.closed = true
- t.Unlock()
- return nil
-}
-
-func TestTimeoutReaderNoTimeout(t *testing.T) {
- test := newTestReader(3, 10*time.Millisecond)
- cancelled := false
- cancel := func() {
- cancelled = true
- }
- tr := newTimeoutReader(test, 100*time.Millisecond, cancel)
- b, err := ioutil.ReadAll(tr)
- if err != nil || string(b) != "AAA" {
- t.Fatalf("Bad read %s %s", err, b)
- }
- if cancelled {
- t.Fatal("Cancelled when shouldn't have been")
- }
- if test.n != 0 {
- t.Fatal("Didn't read all")
- }
- if test.closed {
- t.Fatal("Shouldn't be closed")
- }
- tr.Close()
- if !test.closed {
- t.Fatal("Should be closed")
- }
-}
-
-func TestTimeoutReaderTimeout(t *testing.T) {
- // Return those bytes slowly so we get an idle timeout
- test := newTestReader(3, 100*time.Millisecond)
- cancelled := false
- cancel := func() {
- cancelled = true
- }
- tr := newTimeoutReader(test, 10*time.Millisecond, cancel)
- _, err := ioutil.ReadAll(tr)
- if err != TimeoutError {
- t.Fatal("Expecting TimeoutError, got", err)
- }
- if !cancelled {
- t.Fatal("Not cancelled when should have been")
- }
- test.Lock()
- n := test.n
- test.Unlock()
- if n == 0 {
- t.Fatal("Read all")
- }
- if n != 3 {
- t.Fatal("Didn't read any")
- }
- if test.closed {
- t.Fatal("Shouldn't be closed")
- }
- tr.Close()
- if !test.closed {
- t.Fatal("Should be closed")
- }
-}
diff --git a/vendor/github.com/ncw/swift/watchdog_reader_test.go b/vendor/github.com/ncw/swift/watchdog_reader_test.go
deleted file mode 100644
index 8b879d44..00000000
--- a/vendor/github.com/ncw/swift/watchdog_reader_test.go
+++ /dev/null
@@ -1,61 +0,0 @@
-// This tests WatchdogReader
-
-package swift
-
-import (
- "io/ioutil"
- "testing"
- "time"
-)
-
-// Uses testReader from timeout_reader_test.go
-
-func testWatchdogReaderTimeout(t *testing.T, initialTimeout, watchdogTimeout time.Duration, expectedTimeout bool) {
- test := newTestReader(3, 10*time.Millisecond)
- timer := time.NewTimer(initialTimeout)
- firedChan := make(chan bool)
- started := make(chan bool)
- go func() {
- started <- true
- select {
- case <-timer.C:
- firedChan <- true
- }
- }()
- <-started
- wr := newWatchdogReader(test, watchdogTimeout, timer)
- b, err := ioutil.ReadAll(wr)
- if err != nil || string(b) != "AAA" {
- t.Fatalf("Bad read %s %s", err, b)
- }
- fired := false
- select {
- case fired = <-firedChan:
- default:
- }
- if expectedTimeout {
- if !fired {
- t.Fatal("Timer should have fired")
- }
- } else {
- if fired {
- t.Fatal("Timer should not have fired")
- }
- }
-}
-
-func TestWatchdogReaderNoTimeout(t *testing.T) {
- testWatchdogReaderTimeout(t, 100*time.Millisecond, 100*time.Millisecond, false)
-}
-
-func TestWatchdogReaderTimeout(t *testing.T) {
- testWatchdogReaderTimeout(t, 5*time.Millisecond, 5*time.Millisecond, true)
-}
-
-func TestWatchdogReaderNoTimeoutShortInitial(t *testing.T) {
- testWatchdogReaderTimeout(t, 5*time.Millisecond, 100*time.Millisecond, false)
-}
-
-func TestWatchdogReaderTimeoutLongInitial(t *testing.T) {
- testWatchdogReaderTimeout(t, 100*time.Millisecond, 5*time.Millisecond, true)
-}
diff --git a/vendor/github.com/spf13/cobra/bash_completions_test.go b/vendor/github.com/spf13/cobra/bash_completions_test.go
deleted file mode 100644
index ee632cf4..00000000
--- a/vendor/github.com/spf13/cobra/bash_completions_test.go
+++ /dev/null
@@ -1,82 +0,0 @@
-package cobra
-
-import (
- "bytes"
- "fmt"
- "os"
- "strings"
- "testing"
-)
-
-var _ = fmt.Println
-var _ = os.Stderr
-
-func checkOmit(t *testing.T, found, unexpected string) {
- if strings.Contains(found, unexpected) {
- t.Errorf("Unexpected response.\nGot: %q\nBut should not have!\n", unexpected)
- }
-}
-
-func check(t *testing.T, found, expected string) {
- if !strings.Contains(found, expected) {
- t.Errorf("Unexpected response.\nExpecting to contain: \n %q\nGot:\n %q\n", expected, found)
- }
-}
-
-// World worst custom function, just keep telling you to enter hello!
-const (
- bash_completion_func = `__custom_func() {
-COMPREPLY=( "hello" )
-}
-`
-)
-
-func TestBashCompletions(t *testing.T) {
- c := initializeWithRootCmd()
- cmdEcho.AddCommand(cmdTimes)
- c.AddCommand(cmdEcho, cmdPrint, cmdDeprecated)
-
- // custom completion function
- c.BashCompletionFunction = bash_completion_func
-
- // required flag
- c.MarkFlagRequired("introot")
-
- // valid nounds
- validArgs := []string{"pods", "nodes", "services", "replicationControllers"}
- c.ValidArgs = validArgs
-
- // filename extentions
- annotations := make([]string, 3)
- annotations[0] = "json"
- annotations[1] = "yaml"
- annotations[2] = "yml"
-
- annotation := make(map[string][]string)
- annotation[BashCompFilenameExt] = annotations
-
- var flagval string
- c.Flags().StringVar(&flagval, "filename", "", "Enter a filename")
- flag := c.Flags().Lookup("filename")
- flag.Annotations = annotation
-
- out := new(bytes.Buffer)
- c.GenBashCompletion(out)
- str := out.String()
-
- check(t, str, "_cobra-test")
- check(t, str, "_cobra-test_echo")
- check(t, str, "_cobra-test_echo_times")
- check(t, str, "_cobra-test_print")
-
- // check for required flags
- check(t, str, `must_have_one_flag+=("--introot=")`)
- // check for custom completion function
- check(t, str, `COMPREPLY=( "hello" )`)
- // check for required nouns
- check(t, str, `must_have_one_noun+=("pods")`)
- // check for filename extention flags
- check(t, str, `flags_completion+=("__handle_filename_extension_flag json|yaml|yml")`)
-
- checkOmit(t, str, cmdDeprecated.Name())
-}
diff --git a/vendor/github.com/spf13/cobra/cobra_test.go b/vendor/github.com/spf13/cobra/cobra_test.go
deleted file mode 100644
index 9848d211..00000000
--- a/vendor/github.com/spf13/cobra/cobra_test.go
+++ /dev/null
@@ -1,942 +0,0 @@
-package cobra
-
-import (
- "bytes"
- "fmt"
- "os"
- "reflect"
- "runtime"
- "strings"
- "testing"
-
- "github.com/spf13/pflag"
-)
-
-var _ = fmt.Println
-var _ = os.Stderr
-
-var tp, te, tt, t1, tr []string
-var rootPersPre, echoPre, echoPersPre, timesPersPre []string
-var flagb1, flagb2, flagb3, flagbr, flagbp bool
-var flags1, flags2a, flags2b, flags3 string
-var flagi1, flagi2, flagi3, flagir int
-var globalFlag1 bool
-var flagEcho, rootcalled bool
-var versionUsed int
-
-const strtwoParentHelp = "help message for parent flag strtwo"
-const strtwoChildHelp = "help message for child flag strtwo"
-
-var cmdPrint = &Command{
- Use: "print [string to print]",
- Short: "Print anything to the screen",
- Long: `an absolutely utterly useless command for testing.`,
- Run: func(cmd *Command, args []string) {
- tp = args
- },
-}
-
-var cmdEcho = &Command{
- Use: "echo [string to echo]",
- Aliases: []string{"say"},
- Short: "Echo anything to the screen",
- Long: `an utterly useless command for testing.`,
- Example: "Just run cobra-test echo",
- PersistentPreRun: func(cmd *Command, args []string) {
- echoPersPre = args
- },
- PreRun: func(cmd *Command, args []string) {
- echoPre = args
- },
- Run: func(cmd *Command, args []string) {
- te = args
- },
-}
-
-var cmdEchoSub = &Command{
- Use: "echosub [string to print]",
- Short: "second sub command for echo",
- Long: `an absolutely utterly useless command for testing gendocs!.`,
- Run: func(cmd *Command, args []string) {
- },
-}
-
-var cmdDeprecated = &Command{
- Use: "deprecated [can't do anything here]",
- Short: "A command which is deprecated",
- Long: `an absolutely utterly useless command for testing deprecation!.`,
- Deprecated: "Please use echo instead",
- Run: func(cmd *Command, args []string) {
- },
-}
-
-var cmdTimes = &Command{
- Use: "times [# times] [string to echo]",
- Short: "Echo anything to the screen more times",
- Long: `a slightly useless command for testing.`,
- PersistentPreRun: func(cmd *Command, args []string) {
- timesPersPre = args
- },
- Run: func(cmd *Command, args []string) {
- tt = args
- },
-}
-
-var cmdRootNoRun = &Command{
- Use: "cobra-test",
- Short: "The root can run it's own function",
- Long: "The root description for help",
- PersistentPreRun: func(cmd *Command, args []string) {
- rootPersPre = args
- },
-}
-
-var cmdRootSameName = &Command{
- Use: "print",
- Short: "Root with the same name as a subcommand",
- Long: "The root description for help",
-}
-
-var cmdRootWithRun = &Command{
- Use: "cobra-test",
- Short: "The root can run it's own function",
- Long: "The root description for help",
- Run: func(cmd *Command, args []string) {
- tr = args
- rootcalled = true
- },
-}
-
-var cmdSubNoRun = &Command{
- Use: "subnorun",
- Short: "A subcommand without a Run function",
- Long: "A long output about a subcommand without a Run function",
-}
-
-var cmdVersion1 = &Command{
- Use: "version",
- Short: "Print the version number",
- Long: `First version of the version command`,
- Run: func(cmd *Command, args []string) {
- versionUsed = 1
- },
-}
-
-var cmdVersion2 = &Command{
- Use: "version",
- Short: "Print the version number",
- Long: `Second version of the version command`,
- Run: func(cmd *Command, args []string) {
- versionUsed = 2
- },
-}
-
-func flagInit() {
- cmdEcho.ResetFlags()
- cmdPrint.ResetFlags()
- cmdTimes.ResetFlags()
- cmdRootNoRun.ResetFlags()
- cmdRootSameName.ResetFlags()
- cmdRootWithRun.ResetFlags()
- cmdSubNoRun.ResetFlags()
- cmdRootNoRun.PersistentFlags().StringVarP(&flags2a, "strtwo", "t", "two", strtwoParentHelp)
- cmdEcho.Flags().IntVarP(&flagi1, "intone", "i", 123, "help message for flag intone")
- cmdTimes.Flags().IntVarP(&flagi2, "inttwo", "j", 234, "help message for flag inttwo")
- cmdPrint.Flags().IntVarP(&flagi3, "intthree", "i", 345, "help message for flag intthree")
- cmdEcho.PersistentFlags().StringVarP(&flags1, "strone", "s", "one", "help message for flag strone")
- cmdEcho.PersistentFlags().BoolVarP(&flagbp, "persistentbool", "p", false, "help message for flag persistentbool")
- cmdTimes.PersistentFlags().StringVarP(&flags2b, "strtwo", "t", "2", strtwoChildHelp)
- cmdPrint.PersistentFlags().StringVarP(&flags3, "strthree", "s", "three", "help message for flag strthree")
- cmdEcho.Flags().BoolVarP(&flagb1, "boolone", "b", true, "help message for flag boolone")
- cmdTimes.Flags().BoolVarP(&flagb2, "booltwo", "c", false, "help message for flag booltwo")
- cmdPrint.Flags().BoolVarP(&flagb3, "boolthree", "b", true, "help message for flag boolthree")
- cmdVersion1.ResetFlags()
- cmdVersion2.ResetFlags()
-}
-
-func commandInit() {
- cmdEcho.ResetCommands()
- cmdPrint.ResetCommands()
- cmdTimes.ResetCommands()
- cmdRootNoRun.ResetCommands()
- cmdRootSameName.ResetCommands()
- cmdRootWithRun.ResetCommands()
- cmdSubNoRun.ResetCommands()
-}
-
-func initialize() *Command {
- tt, tp, te = nil, nil, nil
- rootPersPre, echoPre, echoPersPre, timesPersPre = nil, nil, nil, nil
-
- var c = cmdRootNoRun
- flagInit()
- commandInit()
- return c
-}
-
-func initializeWithSameName() *Command {
- tt, tp, te = nil, nil, nil
- rootPersPre, echoPre, echoPersPre, timesPersPre = nil, nil, nil, nil
- var c = cmdRootSameName
- flagInit()
- commandInit()
- return c
-}
-
-func initializeWithRootCmd() *Command {
- cmdRootWithRun.ResetCommands()
- tt, tp, te, tr, rootcalled = nil, nil, nil, nil, false
- flagInit()
- cmdRootWithRun.Flags().BoolVarP(&flagbr, "boolroot", "b", false, "help message for flag boolroot")
- cmdRootWithRun.Flags().IntVarP(&flagir, "introot", "i", 321, "help message for flag introot")
- commandInit()
- return cmdRootWithRun
-}
-
-type resulter struct {
- Error error
- Output string
- Command *Command
-}
-
-func fullSetupTest(input string) resulter {
- c := initializeWithRootCmd()
-
- return fullTester(c, input)
-}
-
-func noRRSetupTest(input string) resulter {
- c := initialize()
-
- return fullTester(c, input)
-}
-
-func rootOnlySetupTest(input string) resulter {
- c := initializeWithRootCmd()
-
- return simpleTester(c, input)
-}
-
-func simpleTester(c *Command, input string) resulter {
- buf := new(bytes.Buffer)
- // Testing flag with invalid input
- c.SetOutput(buf)
- c.SetArgs(strings.Split(input, " "))
-
- err := c.Execute()
- output := buf.String()
-
- return resulter{err, output, c}
-}
-
-func fullTester(c *Command, input string) resulter {
- buf := new(bytes.Buffer)
- // Testing flag with invalid input
- c.SetOutput(buf)
- cmdEcho.AddCommand(cmdTimes)
- c.AddCommand(cmdPrint, cmdEcho, cmdSubNoRun, cmdDeprecated)
- c.SetArgs(strings.Split(input, " "))
-
- err := c.Execute()
- output := buf.String()
-
- return resulter{err, output, c}
-}
-
-func logErr(t *testing.T, found, expected string) {
- out := new(bytes.Buffer)
-
- _, _, line, ok := runtime.Caller(2)
- if ok {
- fmt.Fprintf(out, "Line: %d ", line)
- }
- fmt.Fprintf(out, "Unexpected response.\nExpecting to contain: \n %q\nGot:\n %q\n", expected, found)
- t.Errorf(out.String())
-}
-
-func checkResultContains(t *testing.T, x resulter, check string) {
- if !strings.Contains(x.Output, check) {
- logErr(t, x.Output, check)
- }
-}
-
-func checkResultOmits(t *testing.T, x resulter, check string) {
- if strings.Contains(x.Output, check) {
- logErr(t, x.Output, check)
- }
-}
-
-func checkOutputContains(t *testing.T, c *Command, check string) {
- buf := new(bytes.Buffer)
- c.SetOutput(buf)
- c.Execute()
-
- if !strings.Contains(buf.String(), check) {
- logErr(t, buf.String(), check)
- }
-}
-
-func TestSingleCommand(t *testing.T) {
- noRRSetupTest("print one two")
-
- if te != nil || tt != nil {
- t.Error("Wrong command called")
- }
- if tp == nil {
- t.Error("Wrong command called")
- }
- if strings.Join(tp, " ") != "one two" {
- t.Error("Command didn't parse correctly")
- }
-}
-
-func TestChildCommand(t *testing.T) {
- noRRSetupTest("echo times one two")
-
- if te != nil || tp != nil {
- t.Error("Wrong command called")
- }
- if tt == nil {
- t.Error("Wrong command called")
- }
- if strings.Join(tt, " ") != "one two" {
- t.Error("Command didn't parse correctly")
- }
-}
-
-func TestCommandAlias(t *testing.T) {
- noRRSetupTest("say times one two")
-
- if te != nil || tp != nil {
- t.Error("Wrong command called")
- }
- if tt == nil {
- t.Error("Wrong command called")
- }
- if strings.Join(tt, " ") != "one two" {
- t.Error("Command didn't parse correctly")
- }
-}
-
-func TestPrefixMatching(t *testing.T) {
- EnablePrefixMatching = true
- noRRSetupTest("ech times one two")
-
- if te != nil || tp != nil {
- t.Error("Wrong command called")
- }
- if tt == nil {
- t.Error("Wrong command called")
- }
- if strings.Join(tt, " ") != "one two" {
- t.Error("Command didn't parse correctly")
- }
-
- EnablePrefixMatching = false
-}
-
-func TestNoPrefixMatching(t *testing.T) {
- EnablePrefixMatching = false
-
- noRRSetupTest("ech times one two")
-
- if !(tt == nil && te == nil && tp == nil) {
- t.Error("Wrong command called")
- }
-}
-
-func TestAliasPrefixMatching(t *testing.T) {
- EnablePrefixMatching = true
- noRRSetupTest("sa times one two")
-
- if te != nil || tp != nil {
- t.Error("Wrong command called")
- }
- if tt == nil {
- t.Error("Wrong command called")
- }
- if strings.Join(tt, " ") != "one two" {
- t.Error("Command didn't parse correctly")
- }
- EnablePrefixMatching = false
-}
-
-func TestChildSameName(t *testing.T) {
- c := initializeWithSameName()
- c.AddCommand(cmdPrint, cmdEcho)
- c.SetArgs(strings.Split("print one two", " "))
- c.Execute()
-
- if te != nil || tt != nil {
- t.Error("Wrong command called")
- }
- if tp == nil {
- t.Error("Wrong command called")
- }
- if strings.Join(tp, " ") != "one two" {
- t.Error("Command didn't parse correctly")
- }
-}
-
-func TestFlagLong(t *testing.T) {
- noRRSetupTest("echo --intone=13 something here")
-
- if strings.Join(te, " ") != "something here" {
- t.Errorf("flags didn't leave proper args remaining..%s given", te)
- }
- if flagi1 != 13 {
- t.Errorf("int flag didn't get correct value, had %d", flagi1)
- }
- if flagi2 != 234 {
- t.Errorf("default flag value changed, 234 expected, %d given", flagi2)
- }
-}
-
-func TestFlagShort(t *testing.T) {
- noRRSetupTest("echo -i13 something here")
-
- if strings.Join(te, " ") != "something here" {
- t.Errorf("flags didn't leave proper args remaining..%s given", te)
- }
- if flagi1 != 13 {
- t.Errorf("int flag didn't get correct value, had %d", flagi1)
- }
- if flagi2 != 234 {
- t.Errorf("default flag value changed, 234 expected, %d given", flagi2)
- }
-
- noRRSetupTest("echo -i 13 something here")
-
- if strings.Join(te, " ") != "something here" {
- t.Errorf("flags didn't leave proper args remaining..%s given", te)
- }
- if flagi1 != 13 {
- t.Errorf("int flag didn't get correct value, had %d", flagi1)
- }
- if flagi2 != 234 {
- t.Errorf("default flag value changed, 234 expected, %d given", flagi2)
- }
-
- noRRSetupTest("print -i99 one two")
-
- if strings.Join(tp, " ") != "one two" {
- t.Errorf("flags didn't leave proper args remaining..%s given", tp)
- }
- if flagi3 != 99 {
- t.Errorf("int flag didn't get correct value, had %d", flagi3)
- }
- if flagi1 != 123 {
- t.Errorf("default flag value changed on different command with same shortname, 234 expected, %d given", flagi2)
- }
-}
-
-func TestChildCommandFlags(t *testing.T) {
- noRRSetupTest("echo times -j 99 one two")
-
- if strings.Join(tt, " ") != "one two" {
- t.Errorf("flags didn't leave proper args remaining..%s given", tt)
- }
-
- // Testing with flag that shouldn't be persistent
- r := noRRSetupTest("echo times -j 99 -i77 one two")
-
- if r.Error == nil {
- t.Errorf("invalid flag should generate error")
- }
-
- if !strings.Contains(r.Output, "unknown shorthand") {
- t.Errorf("Wrong error message displayed, \n %s", r.Output)
- }
-
- if flagi2 != 99 {
- t.Errorf("flag value should be 99, %d given", flagi2)
- }
-
- if flagi1 != 123 {
- t.Errorf("unset flag should have default value, expecting 123, given %d", flagi1)
- }
-
- // Testing with flag only existing on child
- r = noRRSetupTest("echo -j 99 -i77 one two")
-
- if r.Error == nil {
- t.Errorf("invalid flag should generate error")
- }
-
- if !strings.Contains(r.Output, "unknown shorthand flag") {
- t.Errorf("Wrong error message displayed, \n %s", r.Output)
- }
-
- // Testing with persistent flag overwritten by child
- noRRSetupTest("echo times --strtwo=child one two")
-
- if flags2b != "child" {
- t.Errorf("flag value should be child, %s given", flags2b)
- }
-
- if flags2a != "two" {
- t.Errorf("unset flag should have default value, expecting two, given %s", flags2a)
- }
-
- // Testing flag with invalid input
- r = noRRSetupTest("echo -i10E")
-
- if r.Error == nil {
- t.Errorf("invalid input should generate error")
- }
-
- if !strings.Contains(r.Output, "invalid argument \"10E\" for i10E") {
- t.Errorf("Wrong error message displayed, \n %s", r.Output)
- }
-}
-
-func TestTrailingCommandFlags(t *testing.T) {
- x := fullSetupTest("echo two -x")
-
- if x.Error == nil {
- t.Errorf("invalid flag should generate error")
- }
-}
-
-func TestInvalidSubcommandFlags(t *testing.T) {
- cmd := initializeWithRootCmd()
- cmd.AddCommand(cmdTimes)
-
- result := simpleTester(cmd, "times --inttwo=2 --badflag=bar")
-
- checkResultContains(t, result, "unknown flag: --badflag")
-
- if strings.Contains(result.Output, "unknown flag: --inttwo") {
- t.Errorf("invalid --badflag flag shouldn't fail on 'unknown' --inttwo flag")
- }
-
-}
-
-func TestSubcommandArgEvaluation(t *testing.T) {
- cmd := initializeWithRootCmd()
-
- first := &Command{
- Use: "first",
- Run: func(cmd *Command, args []string) {
- },
- }
- cmd.AddCommand(first)
-
- second := &Command{
- Use: "second",
- Run: func(cmd *Command, args []string) {
- fmt.Fprintf(cmd.Out(), "%v", args)
- },
- }
- first.AddCommand(second)
-
- result := simpleTester(cmd, "first second first third")
-
- expectedOutput := fmt.Sprintf("%v", []string{"first third"})
- if result.Output != expectedOutput {
- t.Errorf("exptected %v, got %v", expectedOutput, result.Output)
- }
-}
-
-func TestPersistentFlags(t *testing.T) {
- fullSetupTest("echo -s something -p more here")
-
- // persistentFlag should act like normal flag on it's own command
- if strings.Join(te, " ") != "more here" {
- t.Errorf("flags didn't leave proper args remaining..%s given", te)
- }
- if flags1 != "something" {
- t.Errorf("string flag didn't get correct value, had %v", flags1)
- }
- if !flagbp {
- t.Errorf("persistent bool flag not parsed correctly. Expected true, had %v", flagbp)
- }
-
- // persistentFlag should act like normal flag on it's own command
- fullSetupTest("echo times -s again -c -p test here")
-
- if strings.Join(tt, " ") != "test here" {
- t.Errorf("flags didn't leave proper args remaining..%s given", tt)
- }
-
- if flags1 != "again" {
- t.Errorf("string flag didn't get correct value, had %v", flags1)
- }
-
- if !flagb2 {
- t.Errorf("local flag not parsed correctly. Expected true, had %v", flagb2)
- }
- if !flagbp {
- t.Errorf("persistent bool flag not parsed correctly. Expected true, had %v", flagbp)
- }
-}
-
-func TestHelpCommand(t *testing.T) {
- x := fullSetupTest("help")
- checkResultContains(t, x, cmdRootWithRun.Long)
-
- x = fullSetupTest("help echo")
- checkResultContains(t, x, cmdEcho.Long)
-
- x = fullSetupTest("help echo times")
- checkResultContains(t, x, cmdTimes.Long)
-}
-
-func TestChildCommandHelp(t *testing.T) {
- c := noRRSetupTest("print --help")
- checkResultContains(t, c, strtwoParentHelp)
- r := noRRSetupTest("echo times --help")
- checkResultContains(t, r, strtwoChildHelp)
-}
-
-func TestNonRunChildHelp(t *testing.T) {
- x := noRRSetupTest("subnorun")
- checkResultContains(t, x, cmdSubNoRun.Long)
-}
-
-func TestRunnableRootCommand(t *testing.T) {
- fullSetupTest("")
-
- if rootcalled != true {
- t.Errorf("Root Function was not called")
- }
-}
-
-func TestRunnableRootCommandNilInput(t *testing.T) {
- empty_arg := make([]string, 0)
- c := initializeWithRootCmd()
-
- buf := new(bytes.Buffer)
- // Testing flag with invalid input
- c.SetOutput(buf)
- cmdEcho.AddCommand(cmdTimes)
- c.AddCommand(cmdPrint, cmdEcho)
- c.SetArgs(empty_arg)
-
- c.Execute()
-
- if rootcalled != true {
- t.Errorf("Root Function was not called")
- }
-}
-
-func TestRunnableRootCommandEmptyInput(t *testing.T) {
- args := make([]string, 3)
- args[0] = ""
- args[1] = "--introot=12"
- args[2] = ""
- c := initializeWithRootCmd()
-
- buf := new(bytes.Buffer)
- // Testing flag with invalid input
- c.SetOutput(buf)
- cmdEcho.AddCommand(cmdTimes)
- c.AddCommand(cmdPrint, cmdEcho)
- c.SetArgs(args)
-
- c.Execute()
-
- if rootcalled != true {
- t.Errorf("Root Function was not called.\n\nOutput was:\n\n%s\n", buf)
- }
-}
-
-func TestInvalidSubcommandWhenArgsAllowed(t *testing.T) {
- fullSetupTest("echo invalid-sub")
-
- if te[0] != "invalid-sub" {
- t.Errorf("Subcommand didn't work...")
- }
-}
-
-func TestRootFlags(t *testing.T) {
- fullSetupTest("-i 17 -b")
-
- if flagbr != true {
- t.Errorf("flag value should be true, %v given", flagbr)
- }
-
- if flagir != 17 {
- t.Errorf("flag value should be 17, %d given", flagir)
- }
-}
-
-func TestRootHelp(t *testing.T) {
- x := fullSetupTest("--help")
-
- checkResultContains(t, x, "Available Commands:")
- checkResultContains(t, x, "for more information about a command")
-
- if strings.Contains(x.Output, "unknown flag: --help") {
- t.Errorf("--help shouldn't trigger an error, Got: \n %s", x.Output)
- }
-
- if strings.Contains(x.Output, cmdEcho.Use) {
- t.Errorf("--help shouldn't display subcommand's usage, Got: \n %s", x.Output)
- }
-
- x = fullSetupTest("echo --help")
-
- if strings.Contains(x.Output, cmdTimes.Use) {
- t.Errorf("--help shouldn't display subsubcommand's usage, Got: \n %s", x.Output)
- }
-
- checkResultContains(t, x, "Available Commands:")
- checkResultContains(t, x, "for more information about a command")
-
- if strings.Contains(x.Output, "unknown flag: --help") {
- t.Errorf("--help shouldn't trigger an error, Got: \n %s", x.Output)
- }
-
-}
-
-func TestFlagAccess(t *testing.T) {
- initialize()
-
- local := cmdTimes.LocalFlags()
- inherited := cmdTimes.InheritedFlags()
-
- for _, f := range []string{"inttwo", "strtwo", "booltwo"} {
- if local.Lookup(f) == nil {
- t.Errorf("LocalFlags expected to contain %s, Got: nil", f)
- }
- }
- if inherited.Lookup("strone") == nil {
- t.Errorf("InheritedFlags expected to contain strone, Got: nil")
- }
- if inherited.Lookup("strtwo") != nil {
- t.Errorf("InheritedFlags shouldn not contain overwritten flag strtwo")
-
- }
-}
-
-func TestNoNRunnableRootCommandNilInput(t *testing.T) {
- args := make([]string, 0)
- c := initialize()
-
- buf := new(bytes.Buffer)
- // Testing flag with invalid input
- c.SetOutput(buf)
- cmdEcho.AddCommand(cmdTimes)
- c.AddCommand(cmdPrint, cmdEcho)
- c.SetArgs(args)
-
- c.Execute()
-
- if !strings.Contains(buf.String(), cmdRootNoRun.Long) {
- t.Errorf("Expected to get help output, Got: \n %s", buf)
- }
-}
-
-func TestRootNoCommandHelp(t *testing.T) {
- x := rootOnlySetupTest("--help")
-
- checkResultOmits(t, x, "Available Commands:")
- checkResultOmits(t, x, "for more information about a command")
-
- if strings.Contains(x.Output, "unknown flag: --help") {
- t.Errorf("--help shouldn't trigger an error, Got: \n %s", x.Output)
- }
-
- x = rootOnlySetupTest("echo --help")
-
- checkResultOmits(t, x, "Available Commands:")
- checkResultOmits(t, x, "for more information about a command")
-
- if strings.Contains(x.Output, "unknown flag: --help") {
- t.Errorf("--help shouldn't trigger an error, Got: \n %s", x.Output)
- }
-}
-
-func TestRootUnknownCommand(t *testing.T) {
- r := noRRSetupTest("bogus")
- s := "Error: unknown command \"bogus\"\nRun 'cobra-test help' for usage.\n"
-
- if r.Output != s {
- t.Errorf("Unexpected response.\nExpecting to be:\n %q\nGot:\n %q\n", s, r.Output)
- }
-}
-
-func TestFlagsBeforeCommand(t *testing.T) {
- // short without space
- x := fullSetupTest("-i10 echo")
- if x.Error != nil {
- t.Errorf("Valid Input shouldn't have errors, got:\n %q", x.Error)
- }
-
- // short (int) with equals
- // It appears that pflags doesn't support this...
- // Commenting out until support can be added
-
- //x = noRRSetupTest("echo -i=10")
- //if x.Error != nil {
- //t.Errorf("Valid Input shouldn't have errors, got:\n %s", x.Error)
- //}
-
- // long with equals
- x = noRRSetupTest("--intone=123 echo one two")
- if x.Error != nil {
- t.Errorf("Valid Input shouldn't have errors, got:\n %s", x.Error)
- }
-
- // With parsing error properly reported
- x = fullSetupTest("-i10E echo")
- if !strings.Contains(x.Output, "invalid argument \"10E\" for i10E") {
- t.Errorf("Wrong error message displayed, \n %s", x.Output)
- }
-
- //With quotes
- x = fullSetupTest("-s=\"walking\" echo")
- if x.Error != nil {
- t.Errorf("Valid Input shouldn't have errors, got:\n %q", x.Error)
- }
-
- //With quotes and space
- x = fullSetupTest("-s=\"walking fast\" echo")
- if x.Error != nil {
- t.Errorf("Valid Input shouldn't have errors, got:\n %q", x.Error)
- }
-
- //With inner quote
- x = fullSetupTest("-s=\"walking \\\"Inner Quote\\\" fast\" echo")
- if x.Error != nil {
- t.Errorf("Valid Input shouldn't have errors, got:\n %q", x.Error)
- }
-
- //With quotes and space
- x = fullSetupTest("-s=\"walking \\\"Inner Quote\\\" fast\" echo")
- if x.Error != nil {
- t.Errorf("Valid Input shouldn't have errors, got:\n %q", x.Error)
- }
-
-}
-
-func TestRemoveCommand(t *testing.T) {
- versionUsed = 0
- c := initializeWithRootCmd()
- c.AddCommand(cmdVersion1)
- c.RemoveCommand(cmdVersion1)
- x := fullTester(c, "version")
- if x.Error == nil {
- t.Errorf("Removed command should not have been called\n")
- return
- }
-}
-
-func TestCommandWithoutSubcommands(t *testing.T) {
- c := initializeWithRootCmd()
-
- x := simpleTester(c, "")
- if x.Error != nil {
- t.Errorf("Calling command without subcommands should not have error: %v", x.Error)
- return
- }
-}
-
-func TestCommandWithoutSubcommandsWithArg(t *testing.T) {
- c := initializeWithRootCmd()
- expectedArgs := []string{"arg"}
-
- x := simpleTester(c, "arg")
- if x.Error != nil {
- t.Errorf("Calling command without subcommands but with arg should not have error: %v", x.Error)
- return
- }
- if !reflect.DeepEqual(expectedArgs, tr) {
- t.Errorf("Calling command without subcommands but with arg has wrong args: expected: %v, actual: %v", expectedArgs, tr)
- return
- }
-}
-
-func TestReplaceCommandWithRemove(t *testing.T) {
- versionUsed = 0
- c := initializeWithRootCmd()
- c.AddCommand(cmdVersion1)
- c.RemoveCommand(cmdVersion1)
- c.AddCommand(cmdVersion2)
- x := fullTester(c, "version")
- if x.Error != nil {
- t.Errorf("Valid Input shouldn't have errors, got:\n %q", x.Error)
- return
- }
- if versionUsed == 1 {
- t.Errorf("Removed command shouldn't be called\n")
- }
- if versionUsed != 2 {
- t.Errorf("Replacing command should have been called but didn't\n")
- }
-}
-
-func TestDeprecatedSub(t *testing.T) {
- c := fullSetupTest("deprecated")
-
- checkResultContains(t, c, cmdDeprecated.Deprecated)
-}
-
-func TestPreRun(t *testing.T) {
- noRRSetupTest("echo one two")
- if echoPre == nil || echoPersPre == nil {
- t.Error("PreRun or PersistentPreRun not called")
- }
- if rootPersPre != nil || timesPersPre != nil {
- t.Error("Wrong *Pre functions called!")
- }
-
- noRRSetupTest("echo times one two")
- if timesPersPre == nil {
- t.Error("PreRun or PersistentPreRun not called")
- }
- if echoPre != nil || echoPersPre != nil || rootPersPre != nil {
- t.Error("Wrong *Pre functions called!")
- }
-
- noRRSetupTest("print one two")
- if rootPersPre == nil {
- t.Error("Parent PersistentPreRun not called but should not have been")
- }
- if echoPre != nil || echoPersPre != nil || timesPersPre != nil {
- t.Error("Wrong *Pre functions called!")
- }
-}
-
-// Check if cmdEchoSub gets PersistentPreRun from rootCmd even if is added last
-func TestPeristentPreRunPropagation(t *testing.T) {
- rootCmd := initialize()
-
- // First add the cmdEchoSub to cmdPrint
- cmdPrint.AddCommand(cmdEchoSub)
- // Now add cmdPrint to rootCmd
- rootCmd.AddCommand(cmdPrint)
-
- rootCmd.SetArgs(strings.Split("print echosub lala", " "))
- rootCmd.Execute()
-
- if rootPersPre == nil || len(rootPersPre) == 0 || rootPersPre[0] != "lala" {
- t.Error("RootCmd PersistentPreRun not called but should have been")
- }
-}
-
-func TestGlobalNormFuncPropagation(t *testing.T) {
- normFunc := func(f *pflag.FlagSet, name string) pflag.NormalizedName {
- return pflag.NormalizedName(name)
- }
-
- rootCmd := initialize()
- rootCmd.SetGlobalNormalizationFunc(normFunc)
- if reflect.ValueOf(normFunc) != reflect.ValueOf(rootCmd.GlobalNormalizationFunc()) {
- t.Error("rootCmd seems to have a wrong normalization function")
- }
-
- // First add the cmdEchoSub to cmdPrint
- cmdPrint.AddCommand(cmdEchoSub)
- if cmdPrint.GlobalNormalizationFunc() != nil && cmdEchoSub.GlobalNormalizationFunc() != nil {
- t.Error("cmdPrint and cmdEchoSub should had no normalization functions")
- }
-
- // Now add cmdPrint to rootCmd
- rootCmd.AddCommand(cmdPrint)
- if reflect.ValueOf(cmdPrint.GlobalNormalizationFunc()).Pointer() != reflect.ValueOf(rootCmd.GlobalNormalizationFunc()).Pointer() ||
- reflect.ValueOf(cmdEchoSub.GlobalNormalizationFunc()).Pointer() != reflect.ValueOf(rootCmd.GlobalNormalizationFunc()).Pointer() {
- t.Error("cmdPrint and cmdEchoSub should had the normalization function of rootCmd")
- }
-}
diff --git a/vendor/github.com/spf13/cobra/command_test.go b/vendor/github.com/spf13/cobra/command_test.go
deleted file mode 100644
index 477d84e7..00000000
--- a/vendor/github.com/spf13/cobra/command_test.go
+++ /dev/null
@@ -1,90 +0,0 @@
-package cobra
-
-import (
- "reflect"
- "testing"
-)
-
-func TestStripFlags(t *testing.T) {
- tests := []struct {
- input []string
- output []string
- }{
- {
- []string{"foo", "bar"},
- []string{"foo", "bar"},
- },
- {
- []string{"foo", "--bar", "-b"},
- []string{"foo"},
- },
- {
- []string{"-b", "foo", "--bar", "bar"},
- []string{},
- },
- {
- []string{"-i10", "echo"},
- []string{"echo"},
- },
- {
- []string{"-i=10", "echo"},
- []string{"echo"},
- },
- {
- []string{"--int=100", "echo"},
- []string{"echo"},
- },
- {
- []string{"-ib", "echo", "-bfoo", "baz"},
- []string{"echo", "baz"},
- },
- {
- []string{"-i=baz", "bar", "-i", "foo", "blah"},
- []string{"bar", "blah"},
- },
- {
- []string{"--int=baz", "-bbar", "-i", "foo", "blah"},
- []string{"blah"},
- },
- {
- []string{"--cat", "bar", "-i", "foo", "blah"},
- []string{"bar", "blah"},
- },
- {
- []string{"-c", "bar", "-i", "foo", "blah"},
- []string{"bar", "blah"},
- },
- {
- []string{"--persist", "bar"},
- []string{"bar"},
- },
- {
- []string{"-p", "bar"},
- []string{"bar"},
- },
- }
-
- cmdPrint := &Command{
- Use: "print [string to print]",
- Short: "Print anything to the screen",
- Long: `an utterly useless command for testing.`,
- Run: func(cmd *Command, args []string) {
- tp = args
- },
- }
-
- var flagi int
- var flagstr string
- var flagbool bool
- cmdPrint.PersistentFlags().BoolVarP(&flagbool, "persist", "p", false, "help for persistent one")
- cmdPrint.Flags().IntVarP(&flagi, "int", "i", 345, "help message for flag int")
- cmdPrint.Flags().StringVarP(&flagstr, "bar", "b", "bar", "help message for flag string")
- cmdPrint.Flags().BoolVarP(&flagbool, "cat", "c", false, "help message for flag bool")
-
- for _, test := range tests {
- output := stripFlags(test.input, cmdPrint)
- if !reflect.DeepEqual(test.output, output) {
- t.Errorf("expected: %v, got: %v", test.output, output)
- }
- }
-}
diff --git a/vendor/github.com/spf13/cobra/md_docs_test.go b/vendor/github.com/spf13/cobra/md_docs_test.go
deleted file mode 100644
index defc9411..00000000
--- a/vendor/github.com/spf13/cobra/md_docs_test.go
+++ /dev/null
@@ -1,67 +0,0 @@
-package cobra
-
-import (
- "bytes"
- "fmt"
- "os"
- "strings"
- "testing"
-)
-
-var _ = fmt.Println
-var _ = os.Stderr
-
-func TestGenMdDoc(t *testing.T) {
- c := initializeWithRootCmd()
- // Need two commands to run the command alphabetical sort
- cmdEcho.AddCommand(cmdTimes, cmdEchoSub, cmdDeprecated)
- c.AddCommand(cmdPrint, cmdEcho)
- cmdRootWithRun.PersistentFlags().StringVarP(&flags2a, "rootflag", "r", "two", strtwoParentHelp)
-
- out := new(bytes.Buffer)
-
- // We generate on s subcommand so we have both subcommands and parents
- GenMarkdown(cmdEcho, out)
- found := out.String()
-
- // Our description
- expected := cmdEcho.Long
- if !strings.Contains(found, expected) {
- t.Errorf("Unexpected response.\nExpecting to contain: \n %q\nGot:\n %q\n", expected, found)
- }
-
- // Better have our example
- expected = cmdEcho.Example
- if !strings.Contains(found, expected) {
- t.Errorf("Unexpected response.\nExpecting to contain: \n %q\nGot:\n %q\n", expected, found)
- }
-
- // A local flag
- expected = "boolone"
- if !strings.Contains(found, expected) {
- t.Errorf("Unexpected response.\nExpecting to contain: \n %q\nGot:\n %q\n", expected, found)
- }
-
- // persistent flag on parent
- expected = "rootflag"
- if !strings.Contains(found, expected) {
- t.Errorf("Unexpected response.\nExpecting to contain: \n %q\nGot:\n %q\n", expected, found)
- }
-
- // We better output info about our parent
- expected = cmdRootWithRun.Short
- if !strings.Contains(found, expected) {
- t.Errorf("Unexpected response.\nExpecting to contain: \n %q\nGot:\n %q\n", expected, found)
- }
-
- // And about subcommands
- expected = cmdEchoSub.Short
- if !strings.Contains(found, expected) {
- t.Errorf("Unexpected response.\nExpecting to contain: \n %q\nGot:\n %q\n", expected, found)
- }
-
- unexpected := cmdDeprecated.Short
- if strings.Contains(found, unexpected) {
- t.Errorf("Unexpected response.\nFound: %v\nBut should not have!!\n", unexpected)
- }
-}
diff --git a/vendor/github.com/spf13/pflag/bool_test.go b/vendor/github.com/spf13/pflag/bool_test.go
deleted file mode 100644
index a2e1c5dc..00000000
--- a/vendor/github.com/spf13/pflag/bool_test.go
+++ /dev/null
@@ -1,164 +0,0 @@
-// Copyright 2009 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package pflag
-
-import (
- "bytes"
- "fmt"
- "strconv"
- "testing"
-)
-
-// This value can be a boolean ("true", "false") or "maybe"
-type triStateValue int
-
-const (
- triStateFalse triStateValue = 0
- triStateTrue triStateValue = 1
- triStateMaybe triStateValue = 2
-)
-
-const strTriStateMaybe = "maybe"
-
-func (v *triStateValue) IsBoolFlag() bool {
- return true
-}
-
-func (v *triStateValue) Get() interface{} {
- return triStateValue(*v)
-}
-
-func (v *triStateValue) Set(s string) error {
- if s == strTriStateMaybe {
- *v = triStateMaybe
- return nil
- }
- boolVal, err := strconv.ParseBool(s)
- if boolVal {
- *v = triStateTrue
- } else {
- *v = triStateFalse
- }
- return err
-}
-
-func (v *triStateValue) String() string {
- if *v == triStateMaybe {
- return strTriStateMaybe
- }
- return fmt.Sprintf("%v", bool(*v == triStateTrue))
-}
-
-// The type of the flag as requred by the pflag.Value interface
-func (v *triStateValue) Type() string {
- return "version"
-}
-
-func setUpFlagSet(tristate *triStateValue) *FlagSet {
- f := NewFlagSet("test", ContinueOnError)
- *tristate = triStateFalse
- f.VarP(tristate, "tristate", "t", "tristate value (true, maybe or false)")
- return f
-}
-
-func TestExplicitTrue(t *testing.T) {
- var tristate triStateValue
- f := setUpFlagSet(&tristate)
- err := f.Parse([]string{"--tristate=true"})
- if err != nil {
- t.Fatal("expected no error; got", err)
- }
- if tristate != triStateTrue {
- t.Fatal("expected", triStateTrue, "(triStateTrue) but got", tristate, "instead")
- }
-}
-
-func TestImplicitTrue(t *testing.T) {
- var tristate triStateValue
- f := setUpFlagSet(&tristate)
- err := f.Parse([]string{"--tristate"})
- if err != nil {
- t.Fatal("expected no error; got", err)
- }
- if tristate != triStateTrue {
- t.Fatal("expected", triStateTrue, "(triStateTrue) but got", tristate, "instead")
- }
-}
-
-func TestShortFlag(t *testing.T) {
- var tristate triStateValue
- f := setUpFlagSet(&tristate)
- err := f.Parse([]string{"-t"})
- if err != nil {
- t.Fatal("expected no error; got", err)
- }
- if tristate != triStateTrue {
- t.Fatal("expected", triStateTrue, "(triStateTrue) but got", tristate, "instead")
- }
-}
-
-func TestShortFlagExtraArgument(t *testing.T) {
- var tristate triStateValue
- f := setUpFlagSet(&tristate)
- // The"maybe"turns into an arg, since short boolean options will only do true/false
- err := f.Parse([]string{"-t", "maybe"})
- if err != nil {
- t.Fatal("expected no error; got", err)
- }
- if tristate != triStateTrue {
- t.Fatal("expected", triStateTrue, "(triStateTrue) but got", tristate, "instead")
- }
- args := f.Args()
- if len(args) != 1 || args[0] != "maybe" {
- t.Fatal("expected an extra 'maybe' argument to stick around")
- }
-}
-
-func TestExplicitMaybe(t *testing.T) {
- var tristate triStateValue
- f := setUpFlagSet(&tristate)
- err := f.Parse([]string{"--tristate=maybe"})
- if err != nil {
- t.Fatal("expected no error; got", err)
- }
- if tristate != triStateMaybe {
- t.Fatal("expected", triStateMaybe, "(triStateMaybe) but got", tristate, "instead")
- }
-}
-
-func TestExplicitFalse(t *testing.T) {
- var tristate triStateValue
- f := setUpFlagSet(&tristate)
- err := f.Parse([]string{"--tristate=false"})
- if err != nil {
- t.Fatal("expected no error; got", err)
- }
- if tristate != triStateFalse {
- t.Fatal("expected", triStateFalse, "(triStateFalse) but got", tristate, "instead")
- }
-}
-
-func TestImplicitFalse(t *testing.T) {
- var tristate triStateValue
- f := setUpFlagSet(&tristate)
- err := f.Parse([]string{})
- if err != nil {
- t.Fatal("expected no error; got", err)
- }
- if tristate != triStateFalse {
- t.Fatal("expected", triStateFalse, "(triStateFalse) but got", tristate, "instead")
- }
-}
-
-func TestInvalidValue(t *testing.T) {
- var tristate triStateValue
- f := setUpFlagSet(&tristate)
- var buf bytes.Buffer
- f.SetOutput(&buf)
- err := f.Parse([]string{"--tristate=invalid"})
- if err == nil {
- t.Fatal("expected an error but did not get any, tristate has value", tristate)
- }
-}
diff --git a/vendor/github.com/spf13/pflag/example_test.go b/vendor/github.com/spf13/pflag/example_test.go
deleted file mode 100644
index 9be7a49f..00000000
--- a/vendor/github.com/spf13/pflag/example_test.go
+++ /dev/null
@@ -1,77 +0,0 @@
-// Copyright 2012 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-// These examples demonstrate more intricate uses of the flag package.
-package pflag_test
-
-import (
- "errors"
- "fmt"
- "strings"
- "time"
-
- flag "github.com/spf13/pflag"
-)
-
-// Example 1: A single string flag called "species" with default value "gopher".
-var species = flag.String("species", "gopher", "the species we are studying")
-
-// Example 2: A flag with a shorthand letter.
-var gopherType = flag.StringP("gopher_type", "g", "pocket", "the variety of gopher")
-
-// Example 3: A user-defined flag type, a slice of durations.
-type interval []time.Duration
-
-// String is the method to format the flag's value, part of the flag.Value interface.
-// The String method's output will be used in diagnostics.
-func (i *interval) String() string {
- return fmt.Sprint(*i)
-}
-
-func (i *interval) Type() string {
- return "interval"
-}
-
-// Set is the method to set the flag value, part of the flag.Value interface.
-// Set's argument is a string to be parsed to set the flag.
-// It's a comma-separated list, so we split it.
-func (i *interval) Set(value string) error {
- // If we wanted to allow the flag to be set multiple times,
- // accumulating values, we would delete this if statement.
- // That would permit usages such as
- // -deltaT 10s -deltaT 15s
- // and other combinations.
- if len(*i) > 0 {
- return errors.New("interval flag already set")
- }
- for _, dt := range strings.Split(value, ",") {
- duration, err := time.ParseDuration(dt)
- if err != nil {
- return err
- }
- *i = append(*i, duration)
- }
- return nil
-}
-
-// Define a flag to accumulate durations. Because it has a special type,
-// we need to use the Var function and therefore create the flag during
-// init.
-
-var intervalFlag interval
-
-func init() {
- // Tie the command-line flag to the intervalFlag variable and
- // set a usage message.
- flag.Var(&intervalFlag, "deltaT", "comma-separated list of intervals to use between events")
-}
-
-func Example() {
- // All the interesting pieces are with the variables declared above, but
- // to enable the flag package to see the flags defined there, one must
- // execute, typically at the start of main (not init!):
- // flag.Parse()
- // We don't run it here because this is not a main function and
- // the testing suite has already parsed the flags.
-}
diff --git a/vendor/github.com/spf13/pflag/export_test.go b/vendor/github.com/spf13/pflag/export_test.go
deleted file mode 100644
index 9318fee0..00000000
--- a/vendor/github.com/spf13/pflag/export_test.go
+++ /dev/null
@@ -1,29 +0,0 @@
-// Copyright 2010 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package pflag
-
-import (
- "io/ioutil"
- "os"
-)
-
-// Additional routines compiled into the package only during testing.
-
-// ResetForTesting clears all flag state and sets the usage function as directed.
-// After calling ResetForTesting, parse errors in flag handling will not
-// exit the program.
-func ResetForTesting(usage func()) {
- CommandLine = &FlagSet{
- name: os.Args[0],
- errorHandling: ContinueOnError,
- output: ioutil.Discard,
- }
- Usage = usage
-}
-
-// GetCommandLine returns the default FlagSet.
-func GetCommandLine() *FlagSet {
- return CommandLine
-}
diff --git a/vendor/github.com/spf13/pflag/flag_test.go b/vendor/github.com/spf13/pflag/flag_test.go
deleted file mode 100644
index d3c1714b..00000000
--- a/vendor/github.com/spf13/pflag/flag_test.go
+++ /dev/null
@@ -1,658 +0,0 @@
-// Copyright 2009 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package pflag
-
-import (
- "bytes"
- "fmt"
- "io"
- "io/ioutil"
- "net"
- "os"
- "sort"
- "strings"
- "testing"
- "time"
-)
-
-var (
- test_bool = Bool("test_bool", false, "bool value")
- test_int = Int("test_int", 0, "int value")
- test_int64 = Int64("test_int64", 0, "int64 value")
- test_uint = Uint("test_uint", 0, "uint value")
- test_uint64 = Uint64("test_uint64", 0, "uint64 value")
- test_string = String("test_string", "0", "string value")
- test_float64 = Float64("test_float64", 0, "float64 value")
- test_duration = Duration("test_duration", 0, "time.Duration value")
- normalizeFlagNameInvocations = 0
-)
-
-func boolString(s string) string {
- if s == "0" {
- return "false"
- }
- return "true"
-}
-
-func TestEverything(t *testing.T) {
- m := make(map[string]*Flag)
- desired := "0"
- visitor := func(f *Flag) {
- if len(f.Name) > 5 && f.Name[0:5] == "test_" {
- m[f.Name] = f
- ok := false
- switch {
- case f.Value.String() == desired:
- ok = true
- case f.Name == "test_bool" && f.Value.String() == boolString(desired):
- ok = true
- case f.Name == "test_duration" && f.Value.String() == desired+"s":
- ok = true
- }
- if !ok {
- t.Error("Visit: bad value", f.Value.String(), "for", f.Name)
- }
- }
- }
- VisitAll(visitor)
- if len(m) != 8 {
- t.Error("VisitAll misses some flags")
- for k, v := range m {
- t.Log(k, *v)
- }
- }
- m = make(map[string]*Flag)
- Visit(visitor)
- if len(m) != 0 {
- t.Errorf("Visit sees unset flags")
- for k, v := range m {
- t.Log(k, *v)
- }
- }
- // Now set all flags
- Set("test_bool", "true")
- Set("test_int", "1")
- Set("test_int64", "1")
- Set("test_uint", "1")
- Set("test_uint64", "1")
- Set("test_string", "1")
- Set("test_float64", "1")
- Set("test_duration", "1s")
- desired = "1"
- Visit(visitor)
- if len(m) != 8 {
- t.Error("Visit fails after set")
- for k, v := range m {
- t.Log(k, *v)
- }
- }
- // Now test they're visited in sort order.
- var flagNames []string
- Visit(func(f *Flag) { flagNames = append(flagNames, f.Name) })
- if !sort.StringsAreSorted(flagNames) {
- t.Errorf("flag names not sorted: %v", flagNames)
- }
-}
-
-func TestUsage(t *testing.T) {
- called := false
- ResetForTesting(func() { called = true })
- if GetCommandLine().Parse([]string{"--x"}) == nil {
- t.Error("parse did not fail for unknown flag")
- }
- if !called {
- t.Error("did not call Usage for unknown flag")
- }
-}
-
-func testParse(f *FlagSet, t *testing.T) {
- if f.Parsed() {
- t.Error("f.Parse() = true before Parse")
- }
- boolFlag := f.Bool("bool", false, "bool value")
- bool2Flag := f.Bool("bool2", false, "bool2 value")
- bool3Flag := f.Bool("bool3", false, "bool3 value")
- intFlag := f.Int("int", 0, "int value")
- int8Flag := f.Int8("int8", 0, "int value")
- int32Flag := f.Int32("int32", 0, "int value")
- int64Flag := f.Int64("int64", 0, "int64 value")
- uintFlag := f.Uint("uint", 0, "uint value")
- uint8Flag := f.Uint8("uint8", 0, "uint value")
- uint16Flag := f.Uint16("uint16", 0, "uint value")
- uint32Flag := f.Uint32("uint32", 0, "uint value")
- uint64Flag := f.Uint64("uint64", 0, "uint64 value")
- stringFlag := f.String("string", "0", "string value")
- float32Flag := f.Float32("float32", 0, "float32 value")
- float64Flag := f.Float64("float64", 0, "float64 value")
- ipFlag := f.IP("ip", net.ParseIP("127.0.0.1"), "ip value")
- maskFlag := f.IPMask("mask", ParseIPv4Mask("0.0.0.0"), "mask value")
- durationFlag := f.Duration("duration", 5*time.Second, "time.Duration value")
- extra := "one-extra-argument"
- args := []string{
- "--bool",
- "--bool2=true",
- "--bool3=false",
- "--int=22",
- "--int8=-8",
- "--int32=-32",
- "--int64=0x23",
- "--uint=24",
- "--uint8=8",
- "--uint16=16",
- "--uint32=32",
- "--uint64=25",
- "--string=hello",
- "--float32=-172e12",
- "--float64=2718e28",
- "--ip=10.11.12.13",
- "--mask=255.255.255.0",
- "--duration=2m",
- extra,
- }
- if err := f.Parse(args); err != nil {
- t.Fatal(err)
- }
- if !f.Parsed() {
- t.Error("f.Parse() = false after Parse")
- }
- if *boolFlag != true {
- t.Error("bool flag should be true, is ", *boolFlag)
- }
- if *bool2Flag != true {
- t.Error("bool2 flag should be true, is ", *bool2Flag)
- }
- if *bool3Flag != false {
- t.Error("bool3 flag should be false, is ", *bool2Flag)
- }
- if *intFlag != 22 {
- t.Error("int flag should be 22, is ", *intFlag)
- }
- if *int8Flag != -8 {
- t.Error("int8 flag should be 0x23, is ", *int8Flag)
- }
- if *int32Flag != -32 {
- t.Error("int32 flag should be 0x23, is ", *int32Flag)
- }
- if *int64Flag != 0x23 {
- t.Error("int64 flag should be 0x23, is ", *int64Flag)
- }
- if *uintFlag != 24 {
- t.Error("uint flag should be 24, is ", *uintFlag)
- }
- if *uint8Flag != 8 {
- t.Error("uint8 flag should be 8, is ", *uint8Flag)
- }
- if *uint16Flag != 16 {
- t.Error("uint16 flag should be 16, is ", *uint16Flag)
- }
- if *uint32Flag != 32 {
- t.Error("uint32 flag should be 32, is ", *uint32Flag)
- }
- if *uint64Flag != 25 {
- t.Error("uint64 flag should be 25, is ", *uint64Flag)
- }
- if *stringFlag != "hello" {
- t.Error("string flag should be `hello`, is ", *stringFlag)
- }
- if *float32Flag != -172e12 {
- t.Error("float64 flag should be -172e12, is ", *float64Flag)
- }
- if *float64Flag != 2718e28 {
- t.Error("float64 flag should be 2718e28, is ", *float64Flag)
- }
- if (*maskFlag).String() != ParseIPv4Mask("255.255.255.0").String() {
- t.Error("mask flag should be 255.255.255.0, is ", (*maskFlag).String())
- }
- if !(*ipFlag).Equal(net.ParseIP("10.11.12.13")) {
- t.Error("ip flag should be 10.11.12.13, is ", *ipFlag)
- }
- if *durationFlag != 2*time.Minute {
- t.Error("duration flag should be 2m, is ", *durationFlag)
- }
- if len(f.Args()) != 1 {
- t.Error("expected one argument, got", len(f.Args()))
- } else if f.Args()[0] != extra {
- t.Errorf("expected argument %q got %q", extra, f.Args()[0])
- }
-}
-
-func TestShorthand(t *testing.T) {
- f := NewFlagSet("shorthand", ContinueOnError)
- if f.Parsed() {
- t.Error("f.Parse() = true before Parse")
- }
- boolaFlag := f.BoolP("boola", "a", false, "bool value")
- boolbFlag := f.BoolP("boolb", "b", false, "bool2 value")
- boolcFlag := f.BoolP("boolc", "c", false, "bool3 value")
- booldFlag := f.BoolP("boold", "d", false, "bool4 value")
- stringaFlag := f.StringP("stringa", "s", "0", "string value")
- stringzFlag := f.StringP("stringz", "z", "0", "string value")
- extra := "interspersed-argument"
- notaflag := "--i-look-like-a-flag"
- args := []string{
- "-ab",
- extra,
- "-cs",
- "hello",
- "-z=something",
- "-d=true",
- "--",
- notaflag,
- }
- f.SetOutput(ioutil.Discard)
- if err := f.Parse(args); err != nil {
- t.Error("expected no error, got ", err)
- }
- if !f.Parsed() {
- t.Error("f.Parse() = false after Parse")
- }
- if *boolaFlag != true {
- t.Error("boola flag should be true, is ", *boolaFlag)
- }
- if *boolbFlag != true {
- t.Error("boolb flag should be true, is ", *boolbFlag)
- }
- if *boolcFlag != true {
- t.Error("boolc flag should be true, is ", *boolcFlag)
- }
- if *booldFlag != true {
- t.Error("boold flag should be true, is ", *booldFlag)
- }
- if *stringaFlag != "hello" {
- t.Error("stringa flag should be `hello`, is ", *stringaFlag)
- }
- if *stringzFlag != "something" {
- t.Error("stringz flag should be `something`, is ", *stringzFlag)
- }
- if len(f.Args()) != 2 {
- t.Error("expected one argument, got", len(f.Args()))
- } else if f.Args()[0] != extra {
- t.Errorf("expected argument %q got %q", extra, f.Args()[0])
- } else if f.Args()[1] != notaflag {
- t.Errorf("expected argument %q got %q", notaflag, f.Args()[1])
- }
-}
-
-func TestParse(t *testing.T) {
- ResetForTesting(func() { t.Error("bad parse") })
- testParse(GetCommandLine(), t)
-}
-
-func TestFlagSetParse(t *testing.T) {
- testParse(NewFlagSet("test", ContinueOnError), t)
-}
-
-func replaceSeparators(name string, from []string, to string) string {
- result := name
- for _, sep := range from {
- result = strings.Replace(result, sep, to, -1)
- }
- // Type convert to indicate normalization has been done.
- return result
-}
-
-func wordSepNormalizeFunc(f *FlagSet, name string) NormalizedName {
- seps := []string{"-", "_"}
- name = replaceSeparators(name, seps, ".")
- normalizeFlagNameInvocations++
-
- return NormalizedName(name)
-}
-
-func testWordSepNormalizedNames(args []string, t *testing.T) {
- f := NewFlagSet("normalized", ContinueOnError)
- if f.Parsed() {
- t.Error("f.Parse() = true before Parse")
- }
- withDashFlag := f.Bool("with-dash-flag", false, "bool value")
- // Set this after some flags have been added and before others.
- f.SetNormalizeFunc(wordSepNormalizeFunc)
- withUnderFlag := f.Bool("with_under_flag", false, "bool value")
- withBothFlag := f.Bool("with-both_flag", false, "bool value")
- if err := f.Parse(args); err != nil {
- t.Fatal(err)
- }
- if !f.Parsed() {
- t.Error("f.Parse() = false after Parse")
- }
- if *withDashFlag != true {
- t.Error("withDashFlag flag should be true, is ", *withDashFlag)
- }
- if *withUnderFlag != true {
- t.Error("withUnderFlag flag should be true, is ", *withUnderFlag)
- }
- if *withBothFlag != true {
- t.Error("withBothFlag flag should be true, is ", *withBothFlag)
- }
-}
-
-func TestWordSepNormalizedNames(t *testing.T) {
- args := []string{
- "--with-dash-flag",
- "--with-under-flag",
- "--with-both-flag",
- }
- testWordSepNormalizedNames(args, t)
-
- args = []string{
- "--with_dash_flag",
- "--with_under_flag",
- "--with_both_flag",
- }
- testWordSepNormalizedNames(args, t)
-
- args = []string{
- "--with-dash_flag",
- "--with-under_flag",
- "--with-both_flag",
- }
- testWordSepNormalizedNames(args, t)
-}
-
-func aliasAndWordSepFlagNames(f *FlagSet, name string) NormalizedName {
- seps := []string{"-", "_"}
-
- oldName := replaceSeparators("old-valid_flag", seps, ".")
- newName := replaceSeparators("valid-flag", seps, ".")
-
- name = replaceSeparators(name, seps, ".")
- switch name {
- case oldName:
- name = newName
- break
- }
-
- return NormalizedName(name)
-}
-
-func TestCustomNormalizedNames(t *testing.T) {
- f := NewFlagSet("normalized", ContinueOnError)
- if f.Parsed() {
- t.Error("f.Parse() = true before Parse")
- }
-
- validFlag := f.Bool("valid-flag", false, "bool value")
- f.SetNormalizeFunc(aliasAndWordSepFlagNames)
- someOtherFlag := f.Bool("some-other-flag", false, "bool value")
-
- args := []string{"--old_valid_flag", "--some-other_flag"}
- if err := f.Parse(args); err != nil {
- t.Fatal(err)
- }
-
- if *validFlag != true {
- t.Errorf("validFlag is %v even though we set the alias --old_valid_falg", *validFlag)
- }
- if *someOtherFlag != true {
- t.Error("someOtherFlag should be true, is ", *someOtherFlag)
- }
-}
-
-// Every flag we add, the name (displayed also in usage) should normalized
-func TestNormalizationFuncShouldChangeFlagName(t *testing.T) {
- // Test normalization after addition
- f := NewFlagSet("normalized", ContinueOnError)
-
- f.Bool("valid_flag", false, "bool value")
- if f.Lookup("valid_flag").Name != "valid_flag" {
- t.Error("The new flag should have the name 'valid_flag' instead of ", f.Lookup("valid_flag").Name)
- }
-
- f.SetNormalizeFunc(wordSepNormalizeFunc)
- if f.Lookup("valid_flag").Name != "valid.flag" {
- t.Error("The new flag should have the name 'valid.flag' instead of ", f.Lookup("valid_flag").Name)
- }
-
- // Test normalization before addition
- f = NewFlagSet("normalized", ContinueOnError)
- f.SetNormalizeFunc(wordSepNormalizeFunc)
-
- f.Bool("valid_flag", false, "bool value")
- if f.Lookup("valid_flag").Name != "valid.flag" {
- t.Error("The new flag should have the name 'valid.flag' instead of ", f.Lookup("valid_flag").Name)
- }
-}
-
-// Declare a user-defined flag type.
-type flagVar []string
-
-func (f *flagVar) String() string {
- return fmt.Sprint([]string(*f))
-}
-
-func (f *flagVar) Set(value string) error {
- *f = append(*f, value)
- return nil
-}
-
-func (f *flagVar) Type() string {
- return "flagVar"
-}
-
-func TestUserDefined(t *testing.T) {
- var flags FlagSet
- flags.Init("test", ContinueOnError)
- var v flagVar
- flags.VarP(&v, "v", "v", "usage")
- if err := flags.Parse([]string{"--v=1", "-v2", "-v", "3"}); err != nil {
- t.Error(err)
- }
- if len(v) != 3 {
- t.Fatal("expected 3 args; got ", len(v))
- }
- expect := "[1 2 3]"
- if v.String() != expect {
- t.Errorf("expected value %q got %q", expect, v.String())
- }
-}
-
-func TestSetOutput(t *testing.T) {
- var flags FlagSet
- var buf bytes.Buffer
- flags.SetOutput(&buf)
- flags.Init("test", ContinueOnError)
- flags.Parse([]string{"--unknown"})
- if out := buf.String(); !strings.Contains(out, "--unknown") {
- t.Logf("expected output mentioning unknown; got %q", out)
- }
-}
-
-// This tests that one can reset the flags. This still works but not well, and is
-// superseded by FlagSet.
-func TestChangingArgs(t *testing.T) {
- ResetForTesting(func() { t.Fatal("bad parse") })
- oldArgs := os.Args
- defer func() { os.Args = oldArgs }()
- os.Args = []string{"cmd", "--before", "subcmd"}
- before := Bool("before", false, "")
- if err := GetCommandLine().Parse(os.Args[1:]); err != nil {
- t.Fatal(err)
- }
- cmd := Arg(0)
- os.Args = []string{"subcmd", "--after", "args"}
- after := Bool("after", false, "")
- Parse()
- args := Args()
-
- if !*before || cmd != "subcmd" || !*after || len(args) != 1 || args[0] != "args" {
- t.Fatalf("expected true subcmd true [args] got %v %v %v %v", *before, cmd, *after, args)
- }
-}
-
-// Test that -help invokes the usage message and returns ErrHelp.
-func TestHelp(t *testing.T) {
- var helpCalled = false
- fs := NewFlagSet("help test", ContinueOnError)
- fs.Usage = func() { helpCalled = true }
- var flag bool
- fs.BoolVar(&flag, "flag", false, "regular flag")
- // Regular flag invocation should work
- err := fs.Parse([]string{"--flag=true"})
- if err != nil {
- t.Fatal("expected no error; got ", err)
- }
- if !flag {
- t.Error("flag was not set by --flag")
- }
- if helpCalled {
- t.Error("help called for regular flag")
- helpCalled = false // reset for next test
- }
- // Help flag should work as expected.
- err = fs.Parse([]string{"--help"})
- if err == nil {
- t.Fatal("error expected")
- }
- if err != ErrHelp {
- t.Fatal("expected ErrHelp; got ", err)
- }
- if !helpCalled {
- t.Fatal("help was not called")
- }
- // If we define a help flag, that should override.
- var help bool
- fs.BoolVar(&help, "help", false, "help flag")
- helpCalled = false
- err = fs.Parse([]string{"--help"})
- if err != nil {
- t.Fatal("expected no error for defined --help; got ", err)
- }
- if helpCalled {
- t.Fatal("help was called; should not have been for defined help flag")
- }
-}
-
-func TestNoInterspersed(t *testing.T) {
- f := NewFlagSet("test", ContinueOnError)
- f.SetInterspersed(false)
- f.Bool("true", true, "always true")
- f.Bool("false", false, "always false")
- err := f.Parse([]string{"--true", "break", "--false"})
- if err != nil {
- t.Fatal("expected no error; got ", err)
- }
- args := f.Args()
- if len(args) != 2 || args[0] != "break" || args[1] != "--false" {
- t.Fatal("expected interspersed options/non-options to fail")
- }
-}
-
-func TestTermination(t *testing.T) {
- f := NewFlagSet("termination", ContinueOnError)
- boolFlag := f.BoolP("bool", "l", false, "bool value")
- if f.Parsed() {
- t.Error("f.Parse() = true before Parse")
- }
- arg1 := "ls"
- arg2 := "-l"
- args := []string{
- "--",
- arg1,
- arg2,
- }
- f.SetOutput(ioutil.Discard)
- if err := f.Parse(args); err != nil {
- t.Fatal("expected no error; got ", err)
- }
- if !f.Parsed() {
- t.Error("f.Parse() = false after Parse")
- }
- if *boolFlag {
- t.Error("expected boolFlag=false, got true")
- }
- if len(f.Args()) != 2 {
- t.Errorf("expected 2 arguments, got %d: %v", len(f.Args()), f.Args())
- }
- if f.Args()[0] != arg1 {
- t.Errorf("expected argument %q got %q", arg1, f.Args()[0])
- }
- if f.Args()[1] != arg2 {
- t.Errorf("expected argument %q got %q", arg2, f.Args()[1])
- }
-}
-
-func TestDeprecatedFlagInDocs(t *testing.T) {
- f := NewFlagSet("bob", ContinueOnError)
- f.Bool("badflag", true, "always true")
- f.MarkDeprecated("badflag", "use --good-flag instead")
-
- out := new(bytes.Buffer)
- f.SetOutput(out)
- f.PrintDefaults()
-
- if strings.Contains(out.String(), "badflag") {
- t.Errorf("found deprecated flag in usage!")
- }
-}
-
-func parseReturnStderr(t *testing.T, f *FlagSet, args []string) (string, error) {
- oldStderr := os.Stderr
- r, w, _ := os.Pipe()
- os.Stderr = w
-
- err := f.Parse(args)
-
- outC := make(chan string)
- // copy the output in a separate goroutine so printing can't block indefinitely
- go func() {
- var buf bytes.Buffer
- io.Copy(&buf, r)
- outC <- buf.String()
- }()
-
- w.Close()
- os.Stderr = oldStderr
- out := <-outC
-
- return out, err
-}
-
-func TestDeprecatedFlagUsage(t *testing.T) {
- f := NewFlagSet("bob", ContinueOnError)
- f.Bool("badflag", true, "always true")
- usageMsg := "use --good-flag instead"
- f.MarkDeprecated("badflag", usageMsg)
-
- args := []string{"--badflag"}
- out, err := parseReturnStderr(t, f, args)
- if err != nil {
- t.Fatal("expected no error; got ", err)
- }
-
- if !strings.Contains(out, usageMsg) {
- t.Errorf("usageMsg not printed when using a deprecated flag!")
- }
-}
-
-func TestDeprecatedFlagUsageNormalized(t *testing.T) {
- f := NewFlagSet("bob", ContinueOnError)
- f.Bool("bad-double_flag", true, "always true")
- f.SetNormalizeFunc(wordSepNormalizeFunc)
- usageMsg := "use --good-flag instead"
- f.MarkDeprecated("bad_double-flag", usageMsg)
-
- args := []string{"--bad_double_flag"}
- out, err := parseReturnStderr(t, f, args)
- if err != nil {
- t.Fatal("expected no error; got ", err)
- }
-
- if !strings.Contains(out, usageMsg) {
- t.Errorf("usageMsg not printed when using a deprecated flag!")
- }
-}
-
-// Name normalization function should be called only once on flag addition
-func TestMultipleNormalizeFlagNameInvocations(t *testing.T) {
- normalizeFlagNameInvocations = 0
-
- f := NewFlagSet("normalized", ContinueOnError)
- f.SetNormalizeFunc(wordSepNormalizeFunc)
- f.Bool("with_under_flag", false, "bool value")
-
- if normalizeFlagNameInvocations != 1 {
- t.Fatal("Expected normalizeFlagNameInvocations to be 1; got ", normalizeFlagNameInvocations)
- }
-}
diff --git a/vendor/github.com/stevvooe/resumable/sha256/sha256_test.go b/vendor/github.com/stevvooe/resumable/sha256/sha256_test.go
deleted file mode 100644
index 1d883d39..00000000
--- a/vendor/github.com/stevvooe/resumable/sha256/sha256_test.go
+++ /dev/null
@@ -1,176 +0,0 @@
-// Copyright 2009 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-// SHA256 hash algorithm. See FIPS 180-2.
-
-package sha256
-
-import (
- "fmt"
- "io"
- "testing"
-)
-
-type sha256Test struct {
- out string
- in string
-}
-
-var golden = []sha256Test{
- {"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", ""},
- {"ca978112ca1bbdcafac231b39a23dc4da786eff8147c4e72b9807785afee48bb", "a"},
- {"fb8e20fc2e4c3f248c60c39bd652f3c1347298bb977b8b4d5903b85055620603", "ab"},
- {"ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad", "abc"},
- {"88d4266fd4e6338d13b845fcf289579d209c897823b9217da3e161936f031589", "abcd"},
- {"36bbe50ed96841d10443bcb670d6554f0a34b761be67ec9c4a8ad2c0c44ca42c", "abcde"},
- {"bef57ec7f53a6d40beb640a780a639c83bc29ac8a9816f1fc6c5c6dcd93c4721", "abcdef"},
- {"7d1a54127b222502f5b79b5fb0803061152a44f92b37e23c6527baf665d4da9a", "abcdefg"},
- {"9c56cc51b374c3ba189210d5b6d4bf57790d351c96c47c02190ecf1e430635ab", "abcdefgh"},
- {"19cc02f26df43cc571bc9ed7b0c4d29224a3ec229529221725ef76d021c8326f", "abcdefghi"},
- {"72399361da6a7754fec986dca5b7cbaf1c810a28ded4abaf56b2106d06cb78b0", "abcdefghij"},
- {"a144061c271f152da4d151034508fed1c138b8c976339de229c3bb6d4bbb4fce", "Discard medicine more than two years old."},
- {"6dae5caa713a10ad04b46028bf6dad68837c581616a1589a265a11288d4bb5c4", "He who has a shady past knows that nice guys finish last."},
- {"ae7a702a9509039ddbf29f0765e70d0001177914b86459284dab8b348c2dce3f", "I wouldn't marry him with a ten foot pole."},
- {"6748450b01c568586715291dfa3ee018da07d36bb7ea6f180c1af6270215c64f", "Free! Free!/A trip/to Mars/for 900/empty jars/Burma Shave"},
- {"14b82014ad2b11f661b5ae6a99b75105c2ffac278cd071cd6c05832793635774", "The days of the digital watch are numbered. -Tom Stoppard"},
- {"7102cfd76e2e324889eece5d6c41921b1e142a4ac5a2692be78803097f6a48d8", "Nepal premier won't resign."},
- {"23b1018cd81db1d67983c5f7417c44da9deb582459e378d7a068552ea649dc9f", "For every action there is an equal and opposite government program."},
- {"8001f190dfb527261c4cfcab70c98e8097a7a1922129bc4096950e57c7999a5a", "His money is twice tainted: 'taint yours and 'taint mine."},
- {"8c87deb65505c3993eb24b7a150c4155e82eee6960cf0c3a8114ff736d69cad5", "There is no reason for any individual to have a computer in their home. -Ken Olsen, 1977"},
- {"bfb0a67a19cdec3646498b2e0f751bddc41bba4b7f30081b0b932aad214d16d7", "It's a tiny change to the code and not completely disgusting. - Bob Manchek"},
- {"7f9a0b9bf56332e19f5a0ec1ad9c1425a153da1c624868fda44561d6b74daf36", "size: a.out: bad magic"},
- {"b13f81b8aad9e3666879af19886140904f7f429ef083286195982a7588858cfc", "The major problem is with sendmail. -Mark Horton"},
- {"b26c38d61519e894480c70c8374ea35aa0ad05b2ae3d6674eec5f52a69305ed4", "Give me a rock, paper and scissors and I will move the world. CCFestoon"},
- {"049d5e26d4f10222cd841a119e38bd8d2e0d1129728688449575d4ff42b842c1", "If the enemy is within range, then so are you."},
- {"0e116838e3cc1c1a14cd045397e29b4d087aa11b0853fc69ec82e90330d60949", "It's well we cannot hear the screams/That we create in others' dreams."},
- {"4f7d8eb5bcf11de2a56b971021a444aa4eafd6ecd0f307b5109e4e776cd0fe46", "You remind me of a TV show, but that's all right: I watch it anyway."},
- {"61c0cc4c4bd8406d5120b3fb4ebc31ce87667c162f29468b3c779675a85aebce", "C is as portable as Stonehedge!!"},
- {"1fb2eb3688093c4a3f80cd87a5547e2ce940a4f923243a79a2a1e242220693ac", "Even if I could be Shakespeare, I think I should still choose to be Faraday. - A. Huxley"},
- {"395585ce30617b62c80b93e8208ce866d4edc811a177fdb4b82d3911d8696423", "The fugacity of a constituent in a mixture of gases at a given temperature is proportional to its mole fraction. Lewis-Randall Rule"},
- {"4f9b189a13d030838269dce846b16a1ce9ce81fe63e65de2f636863336a98fe6", "How can you write a big system without C++? -Paul Glick"},
-}
-
-var golden224 = []sha256Test{
- {"d14a028c2a3a2bc9476102bb288234c415a2b01f828ea62ac5b3e42f", ""},
- {"abd37534c7d9a2efb9465de931cd7055ffdb8879563ae98078d6d6d5", "a"},
- {"db3cda86d4429a1d39c148989566b38f7bda0156296bd364ba2f878b", "ab"},
- {"23097d223405d8228642a477bda255b32aadbce4bda0b3f7e36c9da7", "abc"},
- {"a76654d8e3550e9a2d67a0eeb6c67b220e5885eddd3fde135806e601", "abcd"},
- {"bdd03d560993e675516ba5a50638b6531ac2ac3d5847c61916cfced6", "abcde"},
- {"7043631cb415556a275a4ebecb802c74ee9f6153908e1792a90b6a98", "abcdef"},
- {"d1884e711701ad81abe0c77a3b0ea12e19ba9af64077286c72fc602d", "abcdefg"},
- {"17eb7d40f0356f8598e89eafad5f6c759b1f822975d9c9b737c8a517", "abcdefgh"},
- {"aeb35915346c584db820d2de7af3929ffafef9222a9bcb26516c7334", "abcdefghi"},
- {"d35e1e5af29ddb0d7e154357df4ad9842afee527c689ee547f753188", "abcdefghij"},
- {"19297f1cef7ddc8a7e947f5c5a341e10f7245045e425db67043988d7", "Discard medicine more than two years old."},
- {"0f10c2eb436251f777fbbd125e260d36aecf180411726c7c885f599a", "He who has a shady past knows that nice guys finish last."},
- {"4d1842104919f314cad8a3cd20b3cba7e8ed3e7abed62b57441358f6", "I wouldn't marry him with a ten foot pole."},
- {"a8ba85c6fe0c48fbffc72bbb2f03fcdbc87ae2dc7a56804d1590fb3b", "Free! Free!/A trip/to Mars/for 900/empty jars/Burma Shave"},
- {"5543fbab26e67e8885b1a852d567d1cb8b9bfe42e0899584c50449a9", "The days of the digital watch are numbered. -Tom Stoppard"},
- {"65ca107390f5da9efa05d28e57b221657edc7e43a9a18fb15b053ddb", "Nepal premier won't resign."},
- {"84953962be366305a9cc9b5cd16ed019edc37ac96c0deb3e12cca116", "For every action there is an equal and opposite government program."},
- {"35a189ce987151dfd00b3577583cc6a74b9869eecf894459cb52038d", "His money is twice tainted: 'taint yours and 'taint mine."},
- {"2fc333713983edfd4ef2c0da6fb6d6415afb94987c91e4069eb063e6", "There is no reason for any individual to have a computer in their home. -Ken Olsen, 1977"},
- {"cbe32d38d577a1b355960a4bc3c659c2dc4670859a19777a875842c4", "It's a tiny change to the code and not completely disgusting. - Bob Manchek"},
- {"a2dc118ce959e027576413a7b440c875cdc8d40df9141d6ef78a57e1", "size: a.out: bad magic"},
- {"d10787e24052bcff26dc484787a54ed819e4e4511c54890ee977bf81", "The major problem is with sendmail. -Mark Horton"},
- {"62efcf16ab8a893acdf2f348aaf06b63039ff1bf55508c830532c9fb", "Give me a rock, paper and scissors and I will move the world. CCFestoon"},
- {"3e9b7e4613c59f58665104c5fa86c272db5d3a2ff30df5bb194a5c99", "If the enemy is within range, then so are you."},
- {"5999c208b8bdf6d471bb7c359ac5b829e73a8211dff686143a4e7f18", "It's well we cannot hear the screams/That we create in others' dreams."},
- {"3b2d67ff54eabc4ef737b14edf87c64280ef582bcdf2a6d56908b405", "You remind me of a TV show, but that's all right: I watch it anyway."},
- {"d0733595d20e4d3d6b5c565a445814d1bbb2fd08b9a3b8ffb97930c6", "C is as portable as Stonehedge!!"},
- {"43fb8aeed8a833175c9295c1165415f98c866ef08a4922959d673507", "Even if I could be Shakespeare, I think I should still choose to be Faraday. - A. Huxley"},
- {"ec18e66e93afc4fb1604bc2baedbfd20b44c43d76e65c0996d7851c6", "The fugacity of a constituent in a mixture of gases at a given temperature is proportional to its mole fraction. Lewis-Randall Rule"},
- {"86ed2eaa9c75ba98396e5c9fb2f679ecf0ea2ed1e0ee9ceecb4a9332", "How can you write a big system without C++? -Paul Glick"},
-}
-
-func TestGolden(t *testing.T) {
- for i := 0; i < len(golden); i++ {
- g := golden[i]
- s := fmt.Sprintf("%x", Sum256([]byte(g.in)))
- if s != g.out {
- t.Fatalf("Sum256 function: sha256(%s) = %s want %s", g.in, s, g.out)
- }
- c := New()
- for j := 0; j < 3; j++ {
- if j < 2 {
- io.WriteString(c, g.in)
- } else {
- io.WriteString(c, g.in[0:len(g.in)/2])
- c.Sum(nil)
- io.WriteString(c, g.in[len(g.in)/2:])
- }
- s := fmt.Sprintf("%x", c.Sum(nil))
- if s != g.out {
- t.Fatalf("sha256[%d](%s) = %s want %s", j, g.in, s, g.out)
- }
- c.Reset()
- }
- }
- for i := 0; i < len(golden224); i++ {
- g := golden224[i]
- s := fmt.Sprintf("%x", Sum224([]byte(g.in)))
- if s != g.out {
- t.Fatalf("Sum224 function: sha224(%s) = %s want %s", g.in, s, g.out)
- }
- c := New224()
- for j := 0; j < 3; j++ {
- if j < 2 {
- io.WriteString(c, g.in)
- } else {
- io.WriteString(c, g.in[0:len(g.in)/2])
- c.Sum(nil)
- io.WriteString(c, g.in[len(g.in)/2:])
- }
- s := fmt.Sprintf("%x", c.Sum(nil))
- if s != g.out {
- t.Fatalf("sha224[%d](%s) = %s want %s", j, g.in, s, g.out)
- }
- c.Reset()
- }
- }
-}
-
-func TestSize(t *testing.T) {
- c := New()
- if got := c.Size(); got != Size {
- t.Errorf("Size = %d; want %d", got, Size)
- }
- c = New224()
- if got := c.Size(); got != Size224 {
- t.Errorf("New224.Size = %d; want %d", got, Size224)
- }
-}
-
-func TestBlockSize(t *testing.T) {
- c := New()
- if got := c.BlockSize(); got != BlockSize {
- t.Errorf("BlockSize = %d want %d", got, BlockSize)
- }
-}
-
-var bench = New()
-var buf = make([]byte, 8192)
-
-func benchmarkSize(b *testing.B, size int) {
- b.SetBytes(int64(size))
- sum := make([]byte, bench.Size())
- for i := 0; i < b.N; i++ {
- bench.Reset()
- bench.Write(buf[:size])
- bench.Sum(sum[:0])
- }
-}
-
-func BenchmarkHash8Bytes(b *testing.B) {
- benchmarkSize(b, 8)
-}
-
-func BenchmarkHash1K(b *testing.B) {
- benchmarkSize(b, 1024)
-}
-
-func BenchmarkHash8K(b *testing.B) {
- benchmarkSize(b, 8192)
-}
diff --git a/vendor/github.com/stevvooe/resumable/sha256/sha256resume_test.go b/vendor/github.com/stevvooe/resumable/sha256/sha256resume_test.go
deleted file mode 100644
index 2ddbda43..00000000
--- a/vendor/github.com/stevvooe/resumable/sha256/sha256resume_test.go
+++ /dev/null
@@ -1,74 +0,0 @@
-package sha256
-
-import (
- "bytes"
- "crypto"
- "crypto/rand"
- "crypto/sha256" // To register the stdlib sha224 and sha256 algs.
- "hash"
- "io"
- "testing"
-
- "github.com/stevvooe/resumable"
-)
-
-func compareResumableHash(t *testing.T, newResumable func() hash.Hash, newStdlib func() hash.Hash) {
- // Read 3 Kilobytes of random data into a buffer.
- buf := make([]byte, 3*1024)
- if _, err := io.ReadFull(rand.Reader, buf); err != nil {
- t.Fatalf("unable to load random data: %s", err)
- }
-
- // Use two Hash objects to consume prefixes of the data. One will be
- // snapshotted and resumed with each additional byte, then both will write
- // that byte. The digests should be equal after each byte is digested.
- resumableHasher := newResumable().(resumable.Hash)
- stdlibHasher := newStdlib()
-
- // First, assert that the initial distest is the same.
- if !bytes.Equal(resumableHasher.Sum(nil), stdlibHasher.Sum(nil)) {
- t.Fatalf("initial digests do not match: got %x, expected %x", resumableHasher.Sum(nil), stdlibHasher.Sum(nil))
- }
-
- multiWriter := io.MultiWriter(resumableHasher, stdlibHasher)
-
- for i := 1; i <= len(buf); i++ {
-
- // Write the next byte.
- multiWriter.Write(buf[i-1 : i])
-
- if !bytes.Equal(resumableHasher.Sum(nil), stdlibHasher.Sum(nil)) {
- t.Fatalf("digests do not match: got %x, expected %x", resumableHasher.Sum(nil), stdlibHasher.Sum(nil))
- }
-
- // Snapshot, reset, and restore the chunk hasher.
- hashState, err := resumableHasher.State()
- if err != nil {
- t.Fatalf("unable to get state of hash function: %s", err)
- }
- resumableHasher.Reset()
- if err := resumableHasher.Restore(hashState); err != nil {
- t.Fatalf("unable to restorte state of hash function: %s", err)
- }
- }
-}
-
-func TestResumable(t *testing.T) {
- compareResumableHash(t, New224, sha256.New224)
- compareResumableHash(t, New, sha256.New)
-}
-
-func TestResumableRegistered(t *testing.T) {
-
- for _, hf := range []crypto.Hash{crypto.SHA224, crypto.SHA256} {
- // make sure that the hash gets the resumable version from the global
- // registry in crypto library.
- h := hf.New()
-
- if rh, ok := h.(resumable.Hash); !ok {
- t.Fatalf("non-resumable hash function registered: %#v %#v", rh, crypto.SHA256)
- }
-
- }
-
-}
diff --git a/vendor/github.com/stevvooe/resumable/sha512/sha512_test.go b/vendor/github.com/stevvooe/resumable/sha512/sha512_test.go
deleted file mode 100644
index 541860f7..00000000
--- a/vendor/github.com/stevvooe/resumable/sha512/sha512_test.go
+++ /dev/null
@@ -1,176 +0,0 @@
-// Copyright 2009 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-// SHA512 hash algorithm. See FIPS 180-2.
-
-package sha512
-
-import (
- "fmt"
- "io"
- "testing"
-)
-
-type sha512Test struct {
- out string
- in string
-}
-
-var golden = []sha512Test{
- {"cf83e1357eefb8bdf1542850d66d8007d620e4050b5715dc83f4a921d36ce9ce47d0d13c5d85f2b0ff8318d2877eec2f63b931bd47417a81a538327af927da3e", ""},
- {"1f40fc92da241694750979ee6cf582f2d5d7d28e18335de05abc54d0560e0f5302860c652bf08d560252aa5e74210546f369fbbbce8c12cfc7957b2652fe9a75", "a"},
- {"2d408a0717ec188158278a796c689044361dc6fdde28d6f04973b80896e1823975cdbf12eb63f9e0591328ee235d80e9b5bf1aa6a44f4617ff3caf6400eb172d", "ab"},
- {"ddaf35a193617abacc417349ae20413112e6fa4e89a97ea20a9eeee64b55d39a2192992a274fc1a836ba3c23a3feebbd454d4423643ce80e2a9ac94fa54ca49f", "abc"},
- {"d8022f2060ad6efd297ab73dcc5355c9b214054b0d1776a136a669d26a7d3b14f73aa0d0ebff19ee333368f0164b6419a96da49e3e481753e7e96b716bdccb6f", "abcd"},
- {"878ae65a92e86cac011a570d4c30a7eaec442b85ce8eca0c2952b5e3cc0628c2e79d889ad4d5c7c626986d452dd86374b6ffaa7cd8b67665bef2289a5c70b0a1", "abcde"},
- {"e32ef19623e8ed9d267f657a81944b3d07adbb768518068e88435745564e8d4150a0a703be2a7d88b61e3d390c2bb97e2d4c311fdc69d6b1267f05f59aa920e7", "abcdef"},
- {"d716a4188569b68ab1b6dfac178e570114cdf0ea3a1cc0e31486c3e41241bc6a76424e8c37ab26f096fc85ef9886c8cb634187f4fddff645fb099f1ff54c6b8c", "abcdefg"},
- {"a3a8c81bc97c2560010d7389bc88aac974a104e0e2381220c6e084c4dccd1d2d17d4f86db31c2a851dc80e6681d74733c55dcd03dd96f6062cdda12a291ae6ce", "abcdefgh"},
- {"f22d51d25292ca1d0f68f69aedc7897019308cc9db46efb75a03dd494fc7f126c010e8ade6a00a0c1a5f1b75d81e0ed5a93ce98dc9b833db7839247b1d9c24fe", "abcdefghi"},
- {"ef6b97321f34b1fea2169a7db9e1960b471aa13302a988087357c520be957ca119c3ba68e6b4982c019ec89de3865ccf6a3cda1fe11e59f98d99f1502c8b9745", "abcdefghij"},
- {"2210d99af9c8bdecda1b4beff822136753d8342505ddce37f1314e2cdbb488c6016bdaa9bd2ffa513dd5de2e4b50f031393d8ab61f773b0e0130d7381e0f8a1d", "Discard medicine more than two years old."},
- {"a687a8985b4d8d0a24f115fe272255c6afaf3909225838546159c1ed685c211a203796ae8ecc4c81a5b6315919b3a64f10713da07e341fcdbb08541bf03066ce", "He who has a shady past knows that nice guys finish last."},
- {"8ddb0392e818b7d585ab22769a50df660d9f6d559cca3afc5691b8ca91b8451374e42bcdabd64589ed7c91d85f626596228a5c8572677eb98bc6b624befb7af8", "I wouldn't marry him with a ten foot pole."},
- {"26ed8f6ca7f8d44b6a8a54ae39640fa8ad5c673f70ee9ce074ba4ef0d483eea00bab2f61d8695d6b34df9c6c48ae36246362200ed820448bdc03a720366a87c6", "Free! Free!/A trip/to Mars/for 900/empty jars/Burma Shave"},
- {"e5a14bf044be69615aade89afcf1ab0389d5fc302a884d403579d1386a2400c089b0dbb387ed0f463f9ee342f8244d5a38cfbc0e819da9529fbff78368c9a982", "The days of the digital watch are numbered. -Tom Stoppard"},
- {"420a1faa48919e14651bed45725abe0f7a58e0f099424c4e5a49194946e38b46c1f8034b18ef169b2e31050d1648e0b982386595f7df47da4b6fd18e55333015", "Nepal premier won't resign."},
- {"d926a863beadb20134db07683535c72007b0e695045876254f341ddcccde132a908c5af57baa6a6a9c63e6649bba0c213dc05fadcf9abccea09f23dcfb637fbe", "For every action there is an equal and opposite government program."},
- {"9a98dd9bb67d0da7bf83da5313dff4fd60a4bac0094f1b05633690ffa7f6d61de9a1d4f8617937d560833a9aaa9ccafe3fd24db418d0e728833545cadd3ad92d", "His money is twice tainted: 'taint yours and 'taint mine."},
- {"d7fde2d2351efade52f4211d3746a0780a26eec3df9b2ed575368a8a1c09ec452402293a8ea4eceb5a4f60064ea29b13cdd86918cd7a4faf366160b009804107", "There is no reason for any individual to have a computer in their home. -Ken Olsen, 1977"},
- {"b0f35ffa2697359c33a56f5c0cf715c7aeed96da9905ca2698acadb08fbc9e669bf566b6bd5d61a3e86dc22999bcc9f2224e33d1d4f32a228cf9d0349e2db518", "It's a tiny change to the code and not completely disgusting. - Bob Manchek"},
- {"3d2e5f91778c9e66f7e061293aaa8a8fc742dd3b2e4f483772464b1144189b49273e610e5cccd7a81a19ca1fa70f16b10f1a100a4d8c1372336be8484c64b311", "size: a.out: bad magic"},
- {"b2f68ff58ac015efb1c94c908b0d8c2bf06f491e4de8e6302c49016f7f8a33eac3e959856c7fddbc464de618701338a4b46f76dbfaf9a1e5262b5f40639771c7", "The major problem is with sendmail. -Mark Horton"},
- {"d8c92db5fdf52cf8215e4df3b4909d29203ff4d00e9ad0b64a6a4e04dec5e74f62e7c35c7fb881bd5de95442123df8f57a489b0ae616bd326f84d10021121c57", "Give me a rock, paper and scissors and I will move the world. CCFestoon"},
- {"19a9f8dc0a233e464e8566ad3ca9b91e459a7b8c4780985b015776e1bf239a19bc233d0556343e2b0a9bc220900b4ebf4f8bdf89ff8efeaf79602d6849e6f72e", "If the enemy is within range, then so are you."},
- {"00b4c41f307bde87301cdc5b5ab1ae9a592e8ecbb2021dd7bc4b34e2ace60741cc362560bec566ba35178595a91932b8d5357e2c9cec92d393b0fa7831852476", "It's well we cannot hear the screams/That we create in others' dreams."},
- {"91eccc3d5375fd026e4d6787874b1dce201cecd8a27dbded5065728cb2d09c58a3d467bb1faf353bf7ba567e005245d5321b55bc344f7c07b91cb6f26c959be7", "You remind me of a TV show, but that's all right: I watch it anyway."},
- {"fabbbe22180f1f137cfdc9556d2570e775d1ae02a597ded43a72a40f9b485d500043b7be128fb9fcd982b83159a0d99aa855a9e7cc4240c00dc01a9bdf8218d7", "C is as portable as Stonehedge!!"},
- {"2ecdec235c1fa4fc2a154d8fba1dddb8a72a1ad73838b51d792331d143f8b96a9f6fcb0f34d7caa351fe6d88771c4f105040e0392f06e0621689d33b2f3ba92e", "Even if I could be Shakespeare, I think I should still choose to be Faraday. - A. Huxley"},
- {"7ad681f6f96f82f7abfa7ecc0334e8fa16d3dc1cdc45b60b7af43fe4075d2357c0c1d60e98350f1afb1f2fe7a4d7cd2ad55b88e458e06b73c40b437331f5dab4", "The fugacity of a constituent in a mixture of gases at a given temperature is proportional to its mole fraction. Lewis-Randall Rule"},
- {"833f9248ab4a3b9e5131f745fda1ffd2dd435b30e965957e78291c7ab73605fd1912b0794e5c233ab0a12d205a39778d19b83515d6a47003f19cdee51d98c7e0", "How can you write a big system without C++? -Paul Glick"},
-}
-
-var golden384 = []sha512Test{
- {"38b060a751ac96384cd9327eb1b1e36a21fdb71114be07434c0cc7bf63f6e1da274edebfe76f65fbd51ad2f14898b95b", ""},
- {"54a59b9f22b0b80880d8427e548b7c23abd873486e1f035dce9cd697e85175033caa88e6d57bc35efae0b5afd3145f31", "a"},
- {"c7be03ba5bcaa384727076db0018e99248e1a6e8bd1b9ef58a9ec9dd4eeebb3f48b836201221175befa74ddc3d35afdd", "ab"},
- {"cb00753f45a35e8bb5a03d699ac65007272c32ab0eded1631a8b605a43ff5bed8086072ba1e7cc2358baeca134c825a7", "abc"},
- {"1165b3406ff0b52a3d24721f785462ca2276c9f454a116c2b2ba20171a7905ea5a026682eb659c4d5f115c363aa3c79b", "abcd"},
- {"4c525cbeac729eaf4b4665815bc5db0c84fe6300068a727cf74e2813521565abc0ec57a37ee4d8be89d097c0d2ad52f0", "abcde"},
- {"c6a4c65b227e7387b9c3e839d44869c4cfca3ef583dea64117859b808c1e3d8ae689e1e314eeef52a6ffe22681aa11f5", "abcdef"},
- {"9f11fc131123f844c1226f429b6a0a6af0525d9f40f056c7fc16cdf1b06bda08e302554417a59fa7dcf6247421959d22", "abcdefg"},
- {"9000cd7cada59d1d2eb82912f7f24e5e69cc5517f68283b005fa27c285b61e05edf1ad1a8a9bded6fd29eb87d75ad806", "abcdefgh"},
- {"ef54915b60cf062b8dd0c29ae3cad69abe6310de63ac081f46ef019c5c90897caefd79b796cfa81139788a260ded52df", "abcdefghi"},
- {"a12070030a02d86b0ddacd0d3a5b598344513d0a051e7355053e556a0055489c1555399b03342845c4adde2dc44ff66c", "abcdefghij"},
- {"86f58ec2d74d1b7f8eb0c2ff0967316699639e8d4eb129de54bdf34c96cdbabe200d052149f2dd787f43571ba74670d4", "Discard medicine more than two years old."},
- {"ae4a2b639ca9bfa04b1855d5a05fe7f230994f790891c6979103e2605f660c4c1262a48142dcbeb57a1914ba5f7c3fa7", "He who has a shady past knows that nice guys finish last."},
- {"40ae213df6436eca952aa6841886fcdb82908ef1576a99c8f49bb9dd5023169f7c53035abdda0b54c302f4974e2105e7", "I wouldn't marry him with a ten foot pole."},
- {"e7cf8b873c9bc950f06259aa54309f349cefa72c00d597aebf903e6519a50011dfe355afff064a10701c705693848df9", "Free! Free!/A trip/to Mars/for 900/empty jars/Burma Shave"},
- {"c3d4f0f4047181c7d39d34703365f7bf70207183caf2c2f6145f04da895ef69124d9cdeb635da636c3a474e61024e29b", "The days of the digital watch are numbered. -Tom Stoppard"},
- {"a097aab567e167d5cf93676ed73252a69f9687cb3179bb2d27c9878119e94bf7b7c4b58dc90582edfaf66e11388ed714", "Nepal premier won't resign."},
- {"5026ca45c41fc64712eb65065da92f6467541c78f8966d3fe2c8e3fb769a3ec14215f819654b47bd64f7f0eac17184f3", "For every action there is an equal and opposite government program."},
- {"ac1cc0f5ac8d5f5514a7b738ac322b7fb52a161b449c3672e9b6a6ad1a5e4b26b001cf3bad24c56598676ca17d4b445a", "His money is twice tainted: 'taint yours and 'taint mine."},
- {"722d10c5de371ec0c8c4b5247ac8a5f1d240d68c73f8da13d8b25f0166d6f309bf9561979a111a0049405771d201941a", "There is no reason for any individual to have a computer in their home. -Ken Olsen, 1977"},
- {"dc2d3ea18bfa10549c63bf2b75b39b5167a80c12aff0e05443168ea87ff149fb0eda5e0bd234eb5d48c7d02ffc5807f1", "It's a tiny change to the code and not completely disgusting. - Bob Manchek"},
- {"1d67c969e2a945ae5346d2139760261504d4ba164c522443afe19ef3e29b152a4c52445489cfc9d7215e5a450e8e1e4e", "size: a.out: bad magic"},
- {"5ff8e075e465646e7b73ef36d812c6e9f7d60fa6ea0e533e5569b4f73cde53cdd2cc787f33540af57cca3fe467d32fe0", "The major problem is with sendmail. -Mark Horton"},
- {"5bd0a997a67c9ae1979a894eb0cde403dde003c9b6f2c03cf21925c42ff4e1176e6df1ca005381612ef18457b9b7ec3b", "Give me a rock, paper and scissors and I will move the world. CCFestoon"},
- {"1eee6da33e7e54fc5be52ae23b94b16ba4d2a947ae4505c6a3edfc7401151ea5205ac01b669b56f27d8ef7f175ed7762", "If the enemy is within range, then so are you."},
- {"76b06e9dea66bfbb1a96029426dc0dfd7830bd297eb447ff5358d94a87cd00c88b59df2493fef56ecbb5231073892ea9", "It's well we cannot hear the screams/That we create in others' dreams."},
- {"12acaf21452cff586143e3f5db0bfdf7802c057e1adf2a619031c4e1b0ccc4208cf6cef8fe722bbaa2fb46a30d9135d8", "You remind me of a TV show, but that's all right: I watch it anyway."},
- {"0fc23d7f4183efd186f0bc4fc5db867e026e2146b06cb3d52f4bdbd57d1740122caa853b41868b197b2ac759db39df88", "C is as portable as Stonehedge!!"},
- {"bc805578a7f85d34a86a32976e1c34fe65cf815186fbef76f46ef99cda10723f971f3f1464d488243f5e29db7488598d", "Even if I could be Shakespeare, I think I should still choose to be Faraday. - A. Huxley"},
- {"b23918399a12ebf4431559eec3813eaf7412e875fd7464f16d581e473330842d2e96c6be49a7ce3f9bb0b8bc0fcbe0fe", "The fugacity of a constituent in a mixture of gases at a given temperature is proportional to its mole fraction. Lewis-Randall Rule"},
- {"1764b700eb1ead52a2fc33cc28975c2180f1b8faa5038d94cffa8d78154aab16e91dd787e7b0303948ebed62561542c8", "How can you write a big system without C++? -Paul Glick"},
-}
-
-func TestGolden(t *testing.T) {
- for i := 0; i < len(golden); i++ {
- g := golden[i]
- s := fmt.Sprintf("%x", Sum512([]byte(g.in)))
- if s != g.out {
- t.Fatalf("Sum512 function: sha512(%s) = %s want %s", g.in, s, g.out)
- }
- c := New()
- for j := 0; j < 3; j++ {
- if j < 2 {
- io.WriteString(c, g.in)
- } else {
- io.WriteString(c, g.in[0:len(g.in)/2])
- c.Sum(nil)
- io.WriteString(c, g.in[len(g.in)/2:])
- }
- s := fmt.Sprintf("%x", c.Sum(nil))
- if s != g.out {
- t.Fatalf("sha512[%d](%s) = %s want %s", j, g.in, s, g.out)
- }
- c.Reset()
- }
- }
- for i := 0; i < len(golden384); i++ {
- g := golden384[i]
- s := fmt.Sprintf("%x", Sum384([]byte(g.in)))
- if s != g.out {
- t.Fatalf("Sum384 function: sha384(%s) = %s want %s", g.in, s, g.out)
- }
- c := New384()
- for j := 0; j < 3; j++ {
- if j < 2 {
- io.WriteString(c, g.in)
- } else {
- io.WriteString(c, g.in[0:len(g.in)/2])
- c.Sum(nil)
- io.WriteString(c, g.in[len(g.in)/2:])
- }
- s := fmt.Sprintf("%x", c.Sum(nil))
- if s != g.out {
- t.Fatalf("sha384[%d](%s) = %s want %s", j, g.in, s, g.out)
- }
- c.Reset()
- }
- }
-}
-
-func TestSize(t *testing.T) {
- c := New()
- if got := c.Size(); got != Size {
- t.Errorf("Size = %d; want %d", got, Size)
- }
- c = New384()
- if got := c.Size(); got != Size384 {
- t.Errorf("New384.Size = %d; want %d", got, Size384)
- }
-}
-
-func TestBlockSize(t *testing.T) {
- c := New()
- if got := c.BlockSize(); got != BlockSize {
- t.Errorf("BlockSize = %d; want %d", got, BlockSize)
- }
-}
-
-var bench = New()
-var buf = make([]byte, 8192)
-
-func benchmarkSize(b *testing.B, size int) {
- b.SetBytes(int64(size))
- sum := make([]byte, bench.Size())
- for i := 0; i < b.N; i++ {
- bench.Reset()
- bench.Write(buf[:size])
- bench.Sum(sum[:0])
- }
-}
-
-func BenchmarkHash8Bytes(b *testing.B) {
- benchmarkSize(b, 8)
-}
-
-func BenchmarkHash1K(b *testing.B) {
- benchmarkSize(b, 1024)
-}
-
-func BenchmarkHash8K(b *testing.B) {
- benchmarkSize(b, 8192)
-}
diff --git a/vendor/github.com/stevvooe/resumable/sha512/sha512resume_test.go b/vendor/github.com/stevvooe/resumable/sha512/sha512resume_test.go
deleted file mode 100644
index 3066c2ae..00000000
--- a/vendor/github.com/stevvooe/resumable/sha512/sha512resume_test.go
+++ /dev/null
@@ -1,74 +0,0 @@
-package sha512
-
-import (
- "bytes"
- "crypto"
- "crypto/rand" // To register the stdlib sha224 and sha256 algs.
- "crypto/sha512"
- "hash"
- "io"
- "testing"
-
- "github.com/stevvooe/resumable"
-)
-
-func compareResumableHash(t *testing.T, newResumable func() hash.Hash, newStdlib func() hash.Hash) {
- // Read 3 Kilobytes of random data into a buffer.
- buf := make([]byte, 3*1024)
- if _, err := io.ReadFull(rand.Reader, buf); err != nil {
- t.Fatalf("unable to load random data: %s", err)
- }
-
- // Use two Hash objects to consume prefixes of the data. One will be
- // snapshotted and resumed with each additional byte, then both will write
- // that byte. The digests should be equal after each byte is digested.
- resumableHasher := newResumable().(resumable.Hash)
- stdlibHasher := newStdlib()
-
- // First, assert that the initial distest is the same.
- if !bytes.Equal(resumableHasher.Sum(nil), stdlibHasher.Sum(nil)) {
- t.Fatalf("initial digests do not match: got %x, expected %x", resumableHasher.Sum(nil), stdlibHasher.Sum(nil))
- }
-
- multiWriter := io.MultiWriter(resumableHasher, stdlibHasher)
-
- for i := 1; i <= len(buf); i++ {
-
- // Write the next byte.
- multiWriter.Write(buf[i-1 : i])
-
- if !bytes.Equal(resumableHasher.Sum(nil), stdlibHasher.Sum(nil)) {
- t.Fatalf("digests do not match: got %x, expected %x", resumableHasher.Sum(nil), stdlibHasher.Sum(nil))
- }
-
- // Snapshot, reset, and restore the chunk hasher.
- hashState, err := resumableHasher.State()
- if err != nil {
- t.Fatalf("unable to get state of hash function: %s", err)
- }
- resumableHasher.Reset()
- if err := resumableHasher.Restore(hashState); err != nil {
- t.Fatalf("unable to restorte state of hash function: %s", err)
- }
- }
-}
-
-func TestResumable(t *testing.T) {
- compareResumableHash(t, New384, sha512.New384)
- compareResumableHash(t, New, sha512.New)
-}
-
-func TestResumableRegistered(t *testing.T) {
-
- for _, hf := range []crypto.Hash{crypto.SHA384, crypto.SHA512} {
- // make sure that the hash gets the resumable version from the global
- // registry in crypto library.
- h := hf.New()
-
- if rh, ok := h.(resumable.Hash); !ok {
- t.Fatalf("non-resumable hash function registered: %#v %#v", rh, crypto.SHA256)
- }
-
- }
-
-}
diff --git a/vendor/github.com/yvasiyarov/go-metrics/cmd/metrics-bench/metrics-bench.go b/vendor/github.com/yvasiyarov/go-metrics/cmd/metrics-bench/metrics-bench.go
deleted file mode 100644
index dddaf4b1..00000000
--- a/vendor/github.com/yvasiyarov/go-metrics/cmd/metrics-bench/metrics-bench.go
+++ /dev/null
@@ -1,20 +0,0 @@
-package main
-
-import (
- "fmt"
- "github.com/rcrowley/go-metrics"
- "time"
-)
-
-func main() {
- r := metrics.NewRegistry()
- for i := 0; i < 10000; i++ {
- r.Register(fmt.Sprintf("counter-%d", i), metrics.NewCounter())
- r.Register(fmt.Sprintf("gauge-%d", i), metrics.NewGauge())
- r.Register(fmt.Sprintf("gaugefloat64-%d", i), metrics.NewGaugeFloat64())
- r.Register(fmt.Sprintf("histogram-uniform-%d", i), metrics.NewHistogram(metrics.NewUniformSample(1028)))
- r.Register(fmt.Sprintf("histogram-exp-%d", i), metrics.NewHistogram(metrics.NewExpDecaySample(1028, 0.015)))
- r.Register(fmt.Sprintf("meter-%d", i), metrics.NewMeter())
- }
- time.Sleep(600e9)
-}
diff --git a/vendor/github.com/yvasiyarov/go-metrics/cmd/metrics-example/metrics-example.go b/vendor/github.com/yvasiyarov/go-metrics/cmd/metrics-example/metrics-example.go
deleted file mode 100644
index 66f42c04..00000000
--- a/vendor/github.com/yvasiyarov/go-metrics/cmd/metrics-example/metrics-example.go
+++ /dev/null
@@ -1,154 +0,0 @@
-package main
-
-import (
- "errors"
- "github.com/rcrowley/go-metrics"
- // "github.com/rcrowley/go-metrics/stathat"
- "log"
- "math/rand"
- "os"
- // "syslog"
- "time"
-)
-
-const fanout = 10
-
-func main() {
-
- r := metrics.NewRegistry()
-
- c := metrics.NewCounter()
- r.Register("foo", c)
- for i := 0; i < fanout; i++ {
- go func() {
- for {
- c.Dec(19)
- time.Sleep(300e6)
- }
- }()
- go func() {
- for {
- c.Inc(47)
- time.Sleep(400e6)
- }
- }()
- }
-
- g := metrics.NewGauge()
- r.Register("bar", g)
- for i := 0; i < fanout; i++ {
- go func() {
- for {
- g.Update(19)
- time.Sleep(300e6)
- }
- }()
- go func() {
- for {
- g.Update(47)
- time.Sleep(400e6)
- }
- }()
- }
-
- gf := metrics.NewGaugeFloat64()
- r.Register("barfloat64", gf)
- for i := 0; i < fanout; i++ {
- go func() {
- for {
- g.Update(19.0)
- time.Sleep(300e6)
- }
- }()
- go func() {
- for {
- g.Update(47.0)
- time.Sleep(400e6)
- }
- }()
- }
-
- hc := metrics.NewHealthcheck(func(h metrics.Healthcheck) {
- if 0 < rand.Intn(2) {
- h.Healthy()
- } else {
- h.Unhealthy(errors.New("baz"))
- }
- })
- r.Register("baz", hc)
-
- s := metrics.NewExpDecaySample(1028, 0.015)
- //s := metrics.NewUniformSample(1028)
- h := metrics.NewHistogram(s)
- r.Register("bang", h)
- for i := 0; i < fanout; i++ {
- go func() {
- for {
- h.Update(19)
- time.Sleep(300e6)
- }
- }()
- go func() {
- for {
- h.Update(47)
- time.Sleep(400e6)
- }
- }()
- }
-
- m := metrics.NewMeter()
- r.Register("quux", m)
- for i := 0; i < fanout; i++ {
- go func() {
- for {
- m.Mark(19)
- time.Sleep(300e6)
- }
- }()
- go func() {
- for {
- m.Mark(47)
- time.Sleep(400e6)
- }
- }()
- }
-
- t := metrics.NewTimer()
- r.Register("hooah", t)
- for i := 0; i < fanout; i++ {
- go func() {
- for {
- t.Time(func() { time.Sleep(300e6) })
- }
- }()
- go func() {
- for {
- t.Time(func() { time.Sleep(400e6) })
- }
- }()
- }
-
- metrics.RegisterDebugGCStats(r)
- go metrics.CaptureDebugGCStats(r, 5e9)
-
- metrics.RegisterRuntimeMemStats(r)
- go metrics.CaptureRuntimeMemStats(r, 5e9)
-
- metrics.Log(r, 60e9, log.New(os.Stderr, "metrics: ", log.Lmicroseconds))
-
- /*
- w, err := syslog.Dial("unixgram", "/dev/log", syslog.LOG_INFO, "metrics")
- if nil != err { log.Fatalln(err) }
- metrics.Syslog(r, 60e9, w)
- */
-
- /*
- addr, _ := net.ResolveTCPAddr("tcp", "127.0.0.1:2003")
- metrics.Graphite(r, 10e9, "metrics", addr)
- */
-
- /*
- stathat.Stathat(r, 10e9, "example@example.com")
- */
-
-}
diff --git a/vendor/github.com/yvasiyarov/go-metrics/cmd/never-read/never-read.go b/vendor/github.com/yvasiyarov/go-metrics/cmd/never-read/never-read.go
deleted file mode 100644
index dc175b77..00000000
--- a/vendor/github.com/yvasiyarov/go-metrics/cmd/never-read/never-read.go
+++ /dev/null
@@ -1,22 +0,0 @@
-package main
-
-import (
- "log"
- "net"
-)
-
-func main() {
- addr, _ := net.ResolveTCPAddr("tcp", "127.0.0.1:2003")
- l, err := net.ListenTCP("tcp", addr)
- if nil != err {
- log.Fatalln(err)
- }
- log.Println("listening", l.Addr())
- for {
- c, err := l.AcceptTCP()
- if nil != err {
- log.Fatalln(err)
- }
- log.Println("accepted", c.RemoteAddr())
- }
-}
diff --git a/vendor/github.com/yvasiyarov/go-metrics/counter_test.go b/vendor/github.com/yvasiyarov/go-metrics/counter_test.go
deleted file mode 100644
index dfb03b4e..00000000
--- a/vendor/github.com/yvasiyarov/go-metrics/counter_test.go
+++ /dev/null
@@ -1,77 +0,0 @@
-package metrics
-
-import "testing"
-
-func BenchmarkCounter(b *testing.B) {
- c := NewCounter()
- b.ResetTimer()
- for i := 0; i < b.N; i++ {
- c.Inc(1)
- }
-}
-
-func TestCounterClear(t *testing.T) {
- c := NewCounter()
- c.Inc(1)
- c.Clear()
- if count := c.Count(); 0 != count {
- t.Errorf("c.Count(): 0 != %v\n", count)
- }
-}
-
-func TestCounterDec1(t *testing.T) {
- c := NewCounter()
- c.Dec(1)
- if count := c.Count(); -1 != count {
- t.Errorf("c.Count(): -1 != %v\n", count)
- }
-}
-
-func TestCounterDec2(t *testing.T) {
- c := NewCounter()
- c.Dec(2)
- if count := c.Count(); -2 != count {
- t.Errorf("c.Count(): -2 != %v\n", count)
- }
-}
-
-func TestCounterInc1(t *testing.T) {
- c := NewCounter()
- c.Inc(1)
- if count := c.Count(); 1 != count {
- t.Errorf("c.Count(): 1 != %v\n", count)
- }
-}
-
-func TestCounterInc2(t *testing.T) {
- c := NewCounter()
- c.Inc(2)
- if count := c.Count(); 2 != count {
- t.Errorf("c.Count(): 2 != %v\n", count)
- }
-}
-
-func TestCounterSnapshot(t *testing.T) {
- c := NewCounter()
- c.Inc(1)
- snapshot := c.Snapshot()
- c.Inc(1)
- if count := snapshot.Count(); 1 != count {
- t.Errorf("c.Count(): 1 != %v\n", count)
- }
-}
-
-func TestCounterZero(t *testing.T) {
- c := NewCounter()
- if count := c.Count(); 0 != count {
- t.Errorf("c.Count(): 0 != %v\n", count)
- }
-}
-
-func TestGetOrRegisterCounter(t *testing.T) {
- r := NewRegistry()
- NewRegisteredCounter("foo", r).Inc(47)
- if c := GetOrRegisterCounter("foo", r); 47 != c.Count() {
- t.Fatal(c)
- }
-}
diff --git a/vendor/github.com/yvasiyarov/go-metrics/debug_test.go b/vendor/github.com/yvasiyarov/go-metrics/debug_test.go
deleted file mode 100644
index 07eb8678..00000000
--- a/vendor/github.com/yvasiyarov/go-metrics/debug_test.go
+++ /dev/null
@@ -1,48 +0,0 @@
-package metrics
-
-import (
- "runtime"
- "runtime/debug"
- "testing"
- "time"
-)
-
-func BenchmarkDebugGCStats(b *testing.B) {
- r := NewRegistry()
- RegisterDebugGCStats(r)
- b.ResetTimer()
- for i := 0; i < b.N; i++ {
- CaptureDebugGCStatsOnce(r)
- }
-}
-
-func TestDebugGCStatsBlocking(t *testing.T) {
- if g := runtime.GOMAXPROCS(0); g < 2 {
- t.Skipf("skipping TestDebugGCMemStatsBlocking with GOMAXPROCS=%d\n", g)
- return
- }
- ch := make(chan int)
- go testDebugGCStatsBlocking(ch)
- var gcStats debug.GCStats
- t0 := time.Now()
- debug.ReadGCStats(&gcStats)
- t1 := time.Now()
- t.Log("i++ during debug.ReadGCStats:", <-ch)
- go testDebugGCStatsBlocking(ch)
- d := t1.Sub(t0)
- t.Log(d)
- time.Sleep(d)
- t.Log("i++ during time.Sleep:", <-ch)
-}
-
-func testDebugGCStatsBlocking(ch chan int) {
- i := 0
- for {
- select {
- case ch <- i:
- return
- default:
- i++
- }
- }
-}
diff --git a/vendor/github.com/yvasiyarov/go-metrics/ewma_test.go b/vendor/github.com/yvasiyarov/go-metrics/ewma_test.go
deleted file mode 100644
index 0430fbd2..00000000
--- a/vendor/github.com/yvasiyarov/go-metrics/ewma_test.go
+++ /dev/null
@@ -1,225 +0,0 @@
-package metrics
-
-import "testing"
-
-func BenchmarkEWMA(b *testing.B) {
- a := NewEWMA1()
- b.ResetTimer()
- for i := 0; i < b.N; i++ {
- a.Update(1)
- a.Tick()
- }
-}
-
-func TestEWMA1(t *testing.T) {
- a := NewEWMA1()
- a.Update(3)
- a.Tick()
- if rate := a.Rate(); 0.6 != rate {
- t.Errorf("initial a.Rate(): 0.6 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.22072766470286553 != rate {
- t.Errorf("1 minute a.Rate(): 0.22072766470286553 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.08120116994196772 != rate {
- t.Errorf("2 minute a.Rate(): 0.08120116994196772 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.029872241020718428 != rate {
- t.Errorf("3 minute a.Rate(): 0.029872241020718428 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.01098938333324054 != rate {
- t.Errorf("4 minute a.Rate(): 0.01098938333324054 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.004042768199451294 != rate {
- t.Errorf("5 minute a.Rate(): 0.004042768199451294 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.0014872513059998212 != rate {
- t.Errorf("6 minute a.Rate(): 0.0014872513059998212 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.0005471291793327122 != rate {
- t.Errorf("7 minute a.Rate(): 0.0005471291793327122 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.00020127757674150815 != rate {
- t.Errorf("8 minute a.Rate(): 0.00020127757674150815 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 7.404588245200814e-05 != rate {
- t.Errorf("9 minute a.Rate(): 7.404588245200814e-05 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 2.7239957857491083e-05 != rate {
- t.Errorf("10 minute a.Rate(): 2.7239957857491083e-05 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 1.0021020474147462e-05 != rate {
- t.Errorf("11 minute a.Rate(): 1.0021020474147462e-05 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 3.6865274119969525e-06 != rate {
- t.Errorf("12 minute a.Rate(): 3.6865274119969525e-06 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 1.3561976441886433e-06 != rate {
- t.Errorf("13 minute a.Rate(): 1.3561976441886433e-06 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 4.989172314621449e-07 != rate {
- t.Errorf("14 minute a.Rate(): 4.989172314621449e-07 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 1.8354139230109722e-07 != rate {
- t.Errorf("15 minute a.Rate(): 1.8354139230109722e-07 != %v\n", rate)
- }
-}
-
-func TestEWMA5(t *testing.T) {
- a := NewEWMA5()
- a.Update(3)
- a.Tick()
- if rate := a.Rate(); 0.6 != rate {
- t.Errorf("initial a.Rate(): 0.6 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.49123845184678905 != rate {
- t.Errorf("1 minute a.Rate(): 0.49123845184678905 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.4021920276213837 != rate {
- t.Errorf("2 minute a.Rate(): 0.4021920276213837 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.32928698165641596 != rate {
- t.Errorf("3 minute a.Rate(): 0.32928698165641596 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.269597378470333 != rate {
- t.Errorf("4 minute a.Rate(): 0.269597378470333 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.2207276647028654 != rate {
- t.Errorf("5 minute a.Rate(): 0.2207276647028654 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.18071652714732128 != rate {
- t.Errorf("6 minute a.Rate(): 0.18071652714732128 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.14795817836496392 != rate {
- t.Errorf("7 minute a.Rate(): 0.14795817836496392 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.12113791079679326 != rate {
- t.Errorf("8 minute a.Rate(): 0.12113791079679326 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.09917933293295193 != rate {
- t.Errorf("9 minute a.Rate(): 0.09917933293295193 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.08120116994196763 != rate {
- t.Errorf("10 minute a.Rate(): 0.08120116994196763 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.06648189501740036 != rate {
- t.Errorf("11 minute a.Rate(): 0.06648189501740036 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.05443077197364752 != rate {
- t.Errorf("12 minute a.Rate(): 0.05443077197364752 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.04456414692860035 != rate {
- t.Errorf("13 minute a.Rate(): 0.04456414692860035 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.03648603757513079 != rate {
- t.Errorf("14 minute a.Rate(): 0.03648603757513079 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.0298722410207183831020718428 != rate {
- t.Errorf("15 minute a.Rate(): 0.0298722410207183831020718428 != %v\n", rate)
- }
-}
-
-func TestEWMA15(t *testing.T) {
- a := NewEWMA15()
- a.Update(3)
- a.Tick()
- if rate := a.Rate(); 0.6 != rate {
- t.Errorf("initial a.Rate(): 0.6 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.5613041910189706 != rate {
- t.Errorf("1 minute a.Rate(): 0.5613041910189706 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.5251039914257684 != rate {
- t.Errorf("2 minute a.Rate(): 0.5251039914257684 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.4912384518467888184678905 != rate {
- t.Errorf("3 minute a.Rate(): 0.4912384518467888184678905 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.459557003018789 != rate {
- t.Errorf("4 minute a.Rate(): 0.459557003018789 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.4299187863442732 != rate {
- t.Errorf("5 minute a.Rate(): 0.4299187863442732 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.4021920276213831 != rate {
- t.Errorf("6 minute a.Rate(): 0.4021920276213831 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.37625345116383313 != rate {
- t.Errorf("7 minute a.Rate(): 0.37625345116383313 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.3519877317060185 != rate {
- t.Errorf("8 minute a.Rate(): 0.3519877317060185 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.3292869816564153165641596 != rate {
- t.Errorf("9 minute a.Rate(): 0.3292869816564153165641596 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.3080502714195546 != rate {
- t.Errorf("10 minute a.Rate(): 0.3080502714195546 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.2881831806538789 != rate {
- t.Errorf("11 minute a.Rate(): 0.2881831806538789 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.26959737847033216 != rate {
- t.Errorf("12 minute a.Rate(): 0.26959737847033216 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.2522102307052083 != rate {
- t.Errorf("13 minute a.Rate(): 0.2522102307052083 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.23594443252115815 != rate {
- t.Errorf("14 minute a.Rate(): 0.23594443252115815 != %v\n", rate)
- }
- elapseMinute(a)
- if rate := a.Rate(); 0.2207276647028646247028654470286553 != rate {
- t.Errorf("15 minute a.Rate(): 0.2207276647028646247028654470286553 != %v\n", rate)
- }
-}
-
-func elapseMinute(a EWMA) {
- for i := 0; i < 12; i++ {
- a.Tick()
- }
-}
diff --git a/vendor/github.com/yvasiyarov/go-metrics/gauge_float64_test.go b/vendor/github.com/yvasiyarov/go-metrics/gauge_float64_test.go
deleted file mode 100644
index 5d0aae27..00000000
--- a/vendor/github.com/yvasiyarov/go-metrics/gauge_float64_test.go
+++ /dev/null
@@ -1,38 +0,0 @@
-package metrics
-
-import "testing"
-
-func BenchmarkGuageFloat64(b *testing.B) {
- g := NewGaugeFloat64()
- b.ResetTimer()
- for i := 0; i < b.N; i++ {
- g.Update(float64(i))
- }
-}
-
-func TestGaugeFloat64(t *testing.T) {
- g := NewGaugeFloat64()
- g.Update(float64(47.0))
- if v := g.Value(); float64(47.0) != v {
- t.Errorf("g.Value(): 47.0 != %v\n", v)
- }
-}
-
-func TestGaugeFloat64Snapshot(t *testing.T) {
- g := NewGaugeFloat64()
- g.Update(float64(47.0))
- snapshot := g.Snapshot()
- g.Update(float64(0))
- if v := snapshot.Value(); float64(47.0) != v {
- t.Errorf("g.Value(): 47.0 != %v\n", v)
- }
-}
-
-func TestGetOrRegisterGaugeFloat64(t *testing.T) {
- r := NewRegistry()
- NewRegisteredGaugeFloat64("foo", r).Update(float64(47.0))
- t.Logf("registry: %v", r)
- if g := GetOrRegisterGaugeFloat64("foo", r); float64(47.0) != g.Value() {
- t.Fatal(g)
- }
-}
diff --git a/vendor/github.com/yvasiyarov/go-metrics/gauge_test.go b/vendor/github.com/yvasiyarov/go-metrics/gauge_test.go
deleted file mode 100644
index 50849629..00000000
--- a/vendor/github.com/yvasiyarov/go-metrics/gauge_test.go
+++ /dev/null
@@ -1,37 +0,0 @@
-package metrics
-
-import "testing"
-
-func BenchmarkGuage(b *testing.B) {
- g := NewGauge()
- b.ResetTimer()
- for i := 0; i < b.N; i++ {
- g.Update(int64(i))
- }
-}
-
-func TestGauge(t *testing.T) {
- g := NewGauge()
- g.Update(int64(47))
- if v := g.Value(); 47 != v {
- t.Errorf("g.Value(): 47 != %v\n", v)
- }
-}
-
-func TestGaugeSnapshot(t *testing.T) {
- g := NewGauge()
- g.Update(int64(47))
- snapshot := g.Snapshot()
- g.Update(int64(0))
- if v := snapshot.Value(); 47 != v {
- t.Errorf("g.Value(): 47 != %v\n", v)
- }
-}
-
-func TestGetOrRegisterGauge(t *testing.T) {
- r := NewRegistry()
- NewRegisteredGauge("foo", r).Update(47)
- if g := GetOrRegisterGauge("foo", r); 47 != g.Value() {
- t.Fatal(g)
- }
-}
diff --git a/vendor/github.com/yvasiyarov/go-metrics/graphite_test.go b/vendor/github.com/yvasiyarov/go-metrics/graphite_test.go
deleted file mode 100644
index b49dc4bb..00000000
--- a/vendor/github.com/yvasiyarov/go-metrics/graphite_test.go
+++ /dev/null
@@ -1,22 +0,0 @@
-package metrics
-
-import (
- "net"
- "time"
-)
-
-func ExampleGraphite() {
- addr, _ := net.ResolveTCPAddr("net", ":2003")
- go Graphite(DefaultRegistry, 1*time.Second, "some.prefix", addr)
-}
-
-func ExampleGraphiteWithConfig() {
- addr, _ := net.ResolveTCPAddr("net", ":2003")
- go GraphiteWithConfig(GraphiteConfig{
- Addr: addr,
- Registry: DefaultRegistry,
- FlushInterval: 1 * time.Second,
- DurationUnit: time.Millisecond,
- Percentiles: []float64{ 0.5, 0.75, 0.99, 0.999 },
- })
-}
diff --git a/vendor/github.com/yvasiyarov/go-metrics/histogram_test.go b/vendor/github.com/yvasiyarov/go-metrics/histogram_test.go
deleted file mode 100644
index d7f4f017..00000000
--- a/vendor/github.com/yvasiyarov/go-metrics/histogram_test.go
+++ /dev/null
@@ -1,95 +0,0 @@
-package metrics
-
-import "testing"
-
-func BenchmarkHistogram(b *testing.B) {
- h := NewHistogram(NewUniformSample(100))
- b.ResetTimer()
- for i := 0; i < b.N; i++ {
- h.Update(int64(i))
- }
-}
-
-func TestGetOrRegisterHistogram(t *testing.T) {
- r := NewRegistry()
- s := NewUniformSample(100)
- NewRegisteredHistogram("foo", r, s).Update(47)
- if h := GetOrRegisterHistogram("foo", r, s); 1 != h.Count() {
- t.Fatal(h)
- }
-}
-
-func TestHistogram10000(t *testing.T) {
- h := NewHistogram(NewUniformSample(100000))
- for i := 1; i <= 10000; i++ {
- h.Update(int64(i))
- }
- testHistogram10000(t, h)
-}
-
-func TestHistogramEmpty(t *testing.T) {
- h := NewHistogram(NewUniformSample(100))
- if count := h.Count(); 0 != count {
- t.Errorf("h.Count(): 0 != %v\n", count)
- }
- if min := h.Min(); 0 != min {
- t.Errorf("h.Min(): 0 != %v\n", min)
- }
- if max := h.Max(); 0 != max {
- t.Errorf("h.Max(): 0 != %v\n", max)
- }
- if mean := h.Mean(); 0.0 != mean {
- t.Errorf("h.Mean(): 0.0 != %v\n", mean)
- }
- if stdDev := h.StdDev(); 0.0 != stdDev {
- t.Errorf("h.StdDev(): 0.0 != %v\n", stdDev)
- }
- ps := h.Percentiles([]float64{0.5, 0.75, 0.99})
- if 0.0 != ps[0] {
- t.Errorf("median: 0.0 != %v\n", ps[0])
- }
- if 0.0 != ps[1] {
- t.Errorf("75th percentile: 0.0 != %v\n", ps[1])
- }
- if 0.0 != ps[2] {
- t.Errorf("99th percentile: 0.0 != %v\n", ps[2])
- }
-}
-
-func TestHistogramSnapshot(t *testing.T) {
- h := NewHistogram(NewUniformSample(100000))
- for i := 1; i <= 10000; i++ {
- h.Update(int64(i))
- }
- snapshot := h.Snapshot()
- h.Update(0)
- testHistogram10000(t, snapshot)
-}
-
-func testHistogram10000(t *testing.T, h Histogram) {
- if count := h.Count(); 10000 != count {
- t.Errorf("h.Count(): 10000 != %v\n", count)
- }
- if min := h.Min(); 1 != min {
- t.Errorf("h.Min(): 1 != %v\n", min)
- }
- if max := h.Max(); 10000 != max {
- t.Errorf("h.Max(): 10000 != %v\n", max)
- }
- if mean := h.Mean(); 5000.5 != mean {
- t.Errorf("h.Mean(): 5000.5 != %v\n", mean)
- }
- if stdDev := h.StdDev(); 2886.751331514372 != stdDev {
- t.Errorf("h.StdDev(): 2886.751331514372 != %v\n", stdDev)
- }
- ps := h.Percentiles([]float64{0.5, 0.75, 0.99})
- if 5000.5 != ps[0] {
- t.Errorf("median: 5000.5 != %v\n", ps[0])
- }
- if 7500.75 != ps[1] {
- t.Errorf("75th percentile: 7500.75 != %v\n", ps[1])
- }
- if 9900.99 != ps[2] {
- t.Errorf("99th percentile: 9900.99 != %v\n", ps[2])
- }
-}
diff --git a/vendor/github.com/yvasiyarov/go-metrics/influxdb/influxdb.go b/vendor/github.com/yvasiyarov/go-metrics/influxdb/influxdb.go
deleted file mode 100644
index 0163c9b4..00000000
--- a/vendor/github.com/yvasiyarov/go-metrics/influxdb/influxdb.go
+++ /dev/null
@@ -1,114 +0,0 @@
-package influxdb
-
-import (
- "fmt"
- influxClient "github.com/influxdb/influxdb/client"
- "github.com/rcrowley/go-metrics"
- "log"
- "time"
-)
-
-type Config struct {
- Host string
- Database string
- Username string
- Password string
-}
-
-func Influxdb(r metrics.Registry, d time.Duration, config *Config) {
- client, err := influxClient.NewClient(&influxClient.ClientConfig{
- Host: config.Host,
- Database: config.Database,
- Username: config.Username,
- Password: config.Password,
- })
- if err != nil {
- log.Println(err)
- return
- }
-
- for _ = range time.Tick(d) {
- if err := send(r, client); err != nil {
- log.Println(err)
- }
- }
-}
-
-func send(r metrics.Registry, client *influxClient.Client) error {
- series := []*influxClient.Series{}
-
- r.Each(func(name string, i interface{}) {
- now := getCurrentTime()
- switch metric := i.(type) {
- case metrics.Counter:
- series = append(series, &influxClient.Series{
- Name: fmt.Sprintf("%s.count", name),
- Columns: []string{"time", "count"},
- Points: [][]interface{}{
- {now, metric.Count()},
- },
- })
- case metrics.Gauge:
- series = append(series, &influxClient.Series{
- Name: fmt.Sprintf("%s.value", name),
- Columns: []string{"time", "value"},
- Points: [][]interface{}{
- {now, metric.Value()},
- },
- })
- case metrics.GaugeFloat64:
- series = append(series, &influxClient.Series{
- Name: fmt.Sprintf("%s.value", name),
- Columns: []string{"time", "value"},
- Points: [][]interface{}{
- {now, metric.Value()},
- },
- })
- case metrics.Histogram:
- h := metric.Snapshot()
- ps := h.Percentiles([]float64{0.5, 0.75, 0.95, 0.99, 0.999})
- series = append(series, &influxClient.Series{
- Name: fmt.Sprintf("%s.histogram", name),
- Columns: []string{"time", "count", "min", "max", "mean", "std-dev",
- "50-percentile", "75-percentile", "95-percentile",
- "99-percentile", "999-percentile"},
- Points: [][]interface{}{
- {now, h.Count(), h.Min(), h.Max(), h.Mean(), h.StdDev(),
- ps[0], ps[1], ps[2], ps[3], ps[4]},
- },
- })
- case metrics.Meter:
- m := metric.Snapshot()
- series = append(series, &influxClient.Series{
- Name: fmt.Sprintf("%s.meter", name),
- Columns: []string{"count", "one-minute",
- "five-minute", "fifteen-minute", "mean"},
- Points: [][]interface{}{
- {m.Count(), m.Rate1(), m.Rate5(), m.Rate15(), m.RateMean()},
- },
- })
- case metrics.Timer:
- h := metric.Snapshot()
- ps := h.Percentiles([]float64{0.5, 0.75, 0.95, 0.99, 0.999})
- series = append(series, &influxClient.Series{
- Name: fmt.Sprintf("%s.timer", name),
- Columns: []string{"count", "min", "max", "mean", "std-dev",
- "50-percentile", "75-percentile", "95-percentile",
- "99-percentile", "999-percentile", "one-minute", "five-minute", "fifteen-minute", "mean-rate"},
- Points: [][]interface{}{
- {h.Count(), h.Min(), h.Max(), h.Mean(), h.StdDev(),
- ps[0], ps[1], ps[2], ps[3], ps[4],
- h.Rate1(), h.Rate5(), h.Rate15(), h.RateMean()},
- },
- })
- }
- })
- if err := client.WriteSeries(series); err != nil {
- log.Println(err)
- }
- return nil
-}
-
-func getCurrentTime() int64 {
- return time.Now().UnixNano() / 1000000
-}
diff --git a/vendor/github.com/yvasiyarov/go-metrics/json_test.go b/vendor/github.com/yvasiyarov/go-metrics/json_test.go
deleted file mode 100644
index cf70051f..00000000
--- a/vendor/github.com/yvasiyarov/go-metrics/json_test.go
+++ /dev/null
@@ -1,28 +0,0 @@
-package metrics
-
-import (
- "bytes"
- "encoding/json"
- "testing"
-)
-
-func TestRegistryMarshallJSON(t *testing.T) {
- b := &bytes.Buffer{}
- enc := json.NewEncoder(b)
- r := NewRegistry()
- r.Register("counter", NewCounter())
- enc.Encode(r)
- if s := b.String(); "{\"counter\":{\"count\":0}}\n" != s {
- t.Fatalf(s)
- }
-}
-
-func TestRegistryWriteJSONOnce(t *testing.T) {
- r := NewRegistry()
- r.Register("counter", NewCounter())
- b := &bytes.Buffer{}
- WriteJSONOnce(r, b)
- if s := b.String(); s != "{\"counter\":{\"count\":0}}\n" {
- t.Fail()
- }
-}
diff --git a/vendor/github.com/yvasiyarov/go-metrics/librato/client.go b/vendor/github.com/yvasiyarov/go-metrics/librato/client.go
deleted file mode 100644
index 8c0c850e..00000000
--- a/vendor/github.com/yvasiyarov/go-metrics/librato/client.go
+++ /dev/null
@@ -1,102 +0,0 @@
-package librato
-
-import (
- "bytes"
- "encoding/json"
- "fmt"
- "io/ioutil"
- "net/http"
-)
-
-const Operations = "operations"
-const OperationsShort = "ops"
-
-type LibratoClient struct {
- Email, Token string
-}
-
-// property strings
-const (
- // display attributes
- Color = "color"
- DisplayMax = "display_max"
- DisplayMin = "display_min"
- DisplayUnitsLong = "display_units_long"
- DisplayUnitsShort = "display_units_short"
- DisplayStacked = "display_stacked"
- DisplayTransform = "display_transform"
- // special gauge display attributes
- SummarizeFunction = "summarize_function"
- Aggregate = "aggregate"
-
- // metric keys
- Name = "name"
- Period = "period"
- Description = "description"
- DisplayName = "display_name"
- Attributes = "attributes"
-
- // measurement keys
- MeasureTime = "measure_time"
- Source = "source"
- Value = "value"
-
- // special gauge keys
- Count = "count"
- Sum = "sum"
- Max = "max"
- Min = "min"
- SumSquares = "sum_squares"
-
- // batch keys
- Counters = "counters"
- Gauges = "gauges"
-
- MetricsPostUrl = "https://metrics-api.librato.com/v1/metrics"
-)
-
-type Measurement map[string]interface{}
-type Metric map[string]interface{}
-
-type Batch struct {
- Gauges []Measurement `json:"gauges,omitempty"`
- Counters []Measurement `json:"counters,omitempty"`
- MeasureTime int64 `json:"measure_time"`
- Source string `json:"source"`
-}
-
-func (self *LibratoClient) PostMetrics(batch Batch) (err error) {
- var (
- js []byte
- req *http.Request
- resp *http.Response
- )
-
- if len(batch.Counters) == 0 && len(batch.Gauges) == 0 {
- return nil
- }
-
- if js, err = json.Marshal(batch); err != nil {
- return
- }
-
- if req, err = http.NewRequest("POST", MetricsPostUrl, bytes.NewBuffer(js)); err != nil {
- return
- }
-
- req.Header.Set("Content-Type", "application/json")
- req.SetBasicAuth(self.Email, self.Token)
-
- if resp, err = http.DefaultClient.Do(req); err != nil {
- return
- }
-
- if resp.StatusCode != http.StatusOK {
- var body []byte
- if body, err = ioutil.ReadAll(resp.Body); err != nil {
- body = []byte(fmt.Sprintf("(could not fetch response body for error: %s)", err))
- }
- err = fmt.Errorf("Unable to post to Librato: %d %s %s", resp.StatusCode, resp.Status, string(body))
- }
- return
-}
diff --git a/vendor/github.com/yvasiyarov/go-metrics/librato/librato.go b/vendor/github.com/yvasiyarov/go-metrics/librato/librato.go
deleted file mode 100644
index 8cc35453..00000000
--- a/vendor/github.com/yvasiyarov/go-metrics/librato/librato.go
+++ /dev/null
@@ -1,244 +0,0 @@
-package librato
-
-import (
- "fmt"
- "github.com/yvasiyarov/go-metrics"
- "log"
- "math"
- "regexp"
- "time"
-
- //"github.com/rcrowley/go-metrics"
-)
-
-// a regexp for extracting the unit from time.Duration.String
-var unitRegexp = regexp.MustCompile("[^\\d]+$")
-
-// a helper that turns a time.Duration into librato display attributes for timer metrics
-func translateTimerAttributes(d time.Duration) (attrs map[string]interface{}) {
- attrs = make(map[string]interface{})
- attrs[DisplayTransform] = fmt.Sprintf("x/%d", int64(d))
- attrs[DisplayUnitsShort] = string(unitRegexp.Find([]byte(d.String())))
- return
-}
-
-type Reporter struct {
- Email, Token string
- Source string
- Interval time.Duration
- Registry metrics.Registry
- Percentiles []float64 // percentiles to report on histogram metrics
- TimerAttributes map[string]interface{} // units in which timers will be displayed
- MetricPrefix string
-}
-
-func NewReporter(r metrics.Registry, d time.Duration, e string, t string, s string, p []float64, u time.Duration) *Reporter {
- return &Reporter{
- Email: e,
- Token: t,
- Source: s,
- Interval: d,
- Registry: r,
- Percentiles: p,
- TimerAttributes: translateTimerAttributes(u),
- }
-}
-
-func Librato(r metrics.Registry, d time.Duration, e string, t string, s string, p []float64, u time.Duration) {
- NewReporter(r, d, e, t, s, p, u).Run()
-}
-
-func (self *Reporter) Run() {
- ticker := time.Tick(self.Interval)
- metricsApi := &LibratoClient{self.Email, self.Token}
- for now := range ticker {
-
- var metrics Batch
- var err error
- if metrics, err = self.BuildRequest(now, self.Registry); err != nil {
- log.Printf("ERROR constructing librato request body %s", err)
- }
-
- if err := metricsApi.PostMetrics(metrics); err != nil {
- log.Printf("ERROR sending metrics to librato %s", err)
- }
- }
-}
-
-// calculate sum of squares from data provided by metrics.Histogram
-// see http://en.wikipedia.org/wiki/Standard_deviation#Rapid_calculation_methods
-func sumSquares(s metrics.Sample) float64 {
- count := float64(s.Count())
- sumSquared := math.Pow(count*s.Mean(), 2)
- sumSquares := math.Pow(count*s.StdDev(), 2) + sumSquared/count
- if math.IsNaN(sumSquares) {
- return 0.0
- }
- return sumSquares
-}
-func sumSquaresTimer(t metrics.Timer) float64 {
- count := float64(t.Count())
- sumSquared := math.Pow(count*t.Mean(), 2)
- sumSquares := math.Pow(count*t.StdDev(), 2) + sumSquared/count
- if math.IsNaN(sumSquares) {
- return 0.0
- }
- return sumSquares
-}
-
-func (self *Reporter) BuildRequest(now time.Time, r metrics.Registry) (snapshot Batch, err error) {
- snapshot = Batch{
- MeasureTime: now.Unix(),
- Source: self.Source,
- }
- snapshot.MeasureTime = now.Unix()
- snapshot.Gauges = make([]Measurement, 0)
- snapshot.Counters = make([]Measurement, 0)
- histogramGaugeCount := 1 + len(self.Percentiles)
- r.Each(func(name string, metric interface{}) {
-
- if self.MetricPrefix != "" {
- name = self.MetricPrefix + name
- }
- measurement := Measurement{}
- measurement[Period] = self.Interval.Seconds()
-
- switch m := metric.(type) {
- case metrics.Counter:
- if m.Count() > 0 {
- measurement[Name] = fmt.Sprintf("%s.%s", name, "count")
- measurement[Value] = float64(m.Count())
- measurement[Attributes] = map[string]interface{}{
- DisplayUnitsLong: Operations,
- DisplayUnitsShort: OperationsShort,
- DisplayMin: "0",
- }
- snapshot.Counters = append(snapshot.Counters, measurement)
- }
- case metrics.Gauge:
- measurement[Name] = name
- measurement[Value] = float64(m.Value())
- snapshot.Gauges = append(snapshot.Gauges, measurement)
- case metrics.GaugeFloat64:
- measurement[Name] = name
- measurement[Value] = float64(m.Value())
- snapshot.Gauges = append(snapshot.Gauges, measurement)
- case metrics.Histogram:
- if m.Count() > 0 {
- gauges := make([]Measurement, histogramGaugeCount, histogramGaugeCount)
- s := m.Sample()
- measurement[Name] = fmt.Sprintf("%s.%s", name, "hist")
- measurement[Count] = uint64(s.Count())
- measurement[Sum] = s.Sum()
- measurement[Max] = float64(s.Max())
- measurement[Min] = float64(s.Min())
- measurement[SumSquares] = sumSquares(s)
- gauges[0] = measurement
- for i, p := range self.Percentiles {
- gauges[i+1] = Measurement{
- Name: fmt.Sprintf("%s.%.2f", measurement[Name], p),
- Value: s.Percentile(p),
- Period: measurement[Period],
- }
- }
- snapshot.Gauges = append(snapshot.Gauges, gauges...)
- }
- case metrics.Meter:
- measurement[Name] = name
- measurement[Value] = float64(m.Count())
- snapshot.Counters = append(snapshot.Counters, measurement)
- snapshot.Gauges = append(snapshot.Gauges,
- Measurement{
- Name: fmt.Sprintf("%s.%s", name, "1min"),
- Value: m.Rate1(),
- Period: int64(self.Interval.Seconds()),
- Attributes: map[string]interface{}{
- DisplayUnitsLong: Operations,
- DisplayUnitsShort: OperationsShort,
- DisplayMin: "0",
- },
- },
- Measurement{
- Name: fmt.Sprintf("%s.%s", name, "5min"),
- Value: m.Rate5(),
- Period: int64(self.Interval.Seconds()),
- Attributes: map[string]interface{}{
- DisplayUnitsLong: Operations,
- DisplayUnitsShort: OperationsShort,
- DisplayMin: "0",
- },
- },
- Measurement{
- Name: fmt.Sprintf("%s.%s", name, "15min"),
- Value: m.Rate15(),
- Period: int64(self.Interval.Seconds()),
- Attributes: map[string]interface{}{
- DisplayUnitsLong: Operations,
- DisplayUnitsShort: OperationsShort,
- DisplayMin: "0",
- },
- },
- )
- case metrics.Timer:
- measurement[Name] = name
- measurement[Value] = float64(m.Count())
- snapshot.Counters = append(snapshot.Counters, measurement)
- if m.Count() > 0 {
- libratoName := fmt.Sprintf("%s.%s", name, "timer.mean")
- gauges := make([]Measurement, histogramGaugeCount, histogramGaugeCount)
- gauges[0] = Measurement{
- Name: libratoName,
- Count: uint64(m.Count()),
- Sum: m.Mean() * float64(m.Count()),
- Max: float64(m.Max()),
- Min: float64(m.Min()),
- SumSquares: sumSquaresTimer(m),
- Period: int64(self.Interval.Seconds()),
- Attributes: self.TimerAttributes,
- }
- for i, p := range self.Percentiles {
- gauges[i+1] = Measurement{
- Name: fmt.Sprintf("%s.timer.%2.0f", name, p*100),
- Value: m.Percentile(p),
- Period: int64(self.Interval.Seconds()),
- Attributes: self.TimerAttributes,
- }
- }
- snapshot.Gauges = append(snapshot.Gauges, gauges...)
- snapshot.Gauges = append(snapshot.Gauges,
- Measurement{
- Name: fmt.Sprintf("%s.%s", name, "rate.1min"),
- Value: m.Rate1(),
- Period: int64(self.Interval.Seconds()),
- Attributes: map[string]interface{}{
- DisplayUnitsLong: Operations,
- DisplayUnitsShort: OperationsShort,
- DisplayMin: "0",
- },
- },
- Measurement{
- Name: fmt.Sprintf("%s.%s", name, "rate.5min"),
- Value: m.Rate5(),
- Period: int64(self.Interval.Seconds()),
- Attributes: map[string]interface{}{
- DisplayUnitsLong: Operations,
- DisplayUnitsShort: OperationsShort,
- DisplayMin: "0",
- },
- },
- Measurement{
- Name: fmt.Sprintf("%s.%s", name, "rate.15min"),
- Value: m.Rate15(),
- Period: int64(self.Interval.Seconds()),
- Attributes: map[string]interface{}{
- DisplayUnitsLong: Operations,
- DisplayUnitsShort: OperationsShort,
- DisplayMin: "0",
- },
- },
- )
- }
- }
- })
- return
-}
diff --git a/vendor/github.com/yvasiyarov/go-metrics/meter_test.go b/vendor/github.com/yvasiyarov/go-metrics/meter_test.go
deleted file mode 100644
index 26ce1398..00000000
--- a/vendor/github.com/yvasiyarov/go-metrics/meter_test.go
+++ /dev/null
@@ -1,60 +0,0 @@
-package metrics
-
-import (
- "testing"
- "time"
-)
-
-func BenchmarkMeter(b *testing.B) {
- m := NewMeter()
- b.ResetTimer()
- for i := 0; i < b.N; i++ {
- m.Mark(1)
- }
-}
-
-func TestGetOrRegisterMeter(t *testing.T) {
- r := NewRegistry()
- NewRegisteredMeter("foo", r).Mark(47)
- if m := GetOrRegisterMeter("foo", r); 47 != m.Count() {
- t.Fatal(m)
- }
-}
-
-func TestMeterDecay(t *testing.T) {
- ma := meterArbiter{
- ticker: time.NewTicker(1),
- }
- m := newStandardMeter()
- ma.meters = append(ma.meters, m)
- go ma.tick()
- m.Mark(1)
- rateMean := m.RateMean()
- time.Sleep(1)
- if m.RateMean() >= rateMean {
- t.Error("m.RateMean() didn't decrease")
- }
-}
-
-func TestMeterNonzero(t *testing.T) {
- m := NewMeter()
- m.Mark(3)
- if count := m.Count(); 3 != count {
- t.Errorf("m.Count(): 3 != %v\n", count)
- }
-}
-
-func TestMeterSnapshot(t *testing.T) {
- m := NewMeter()
- m.Mark(1)
- if snapshot := m.Snapshot(); m.RateMean() != snapshot.RateMean() {
- t.Fatal(snapshot)
- }
-}
-
-func TestMeterZero(t *testing.T) {
- m := NewMeter()
- if count := m.Count(); 0 != count {
- t.Errorf("m.Count(): 0 != %v\n", count)
- }
-}
diff --git a/vendor/github.com/yvasiyarov/go-metrics/metrics_test.go b/vendor/github.com/yvasiyarov/go-metrics/metrics_test.go
deleted file mode 100644
index 083f9676..00000000
--- a/vendor/github.com/yvasiyarov/go-metrics/metrics_test.go
+++ /dev/null
@@ -1,107 +0,0 @@
-package metrics
-
-import (
- "io/ioutil"
- "log"
- "sync"
- "testing"
-)
-
-const FANOUT = 128
-
-// Stop the compiler from complaining during debugging.
-var (
- _ = ioutil.Discard
- _ = log.LstdFlags
-)
-
-func BenchmarkMetrics(b *testing.B) {
- r := NewRegistry()
- c := NewRegisteredCounter("counter", r)
- g := NewRegisteredGauge("gauge", r)
- gf := NewRegisteredGaugeFloat64("gaugefloat64", r)
- h := NewRegisteredHistogram("histogram", r, NewUniformSample(100))
- m := NewRegisteredMeter("meter", r)
- t := NewRegisteredTimer("timer", r)
- RegisterDebugGCStats(r)
- RegisterRuntimeMemStats(r)
- b.ResetTimer()
- ch := make(chan bool)
-
- wgD := &sync.WaitGroup{}
- /*
- wgD.Add(1)
- go func() {
- defer wgD.Done()
- //log.Println("go CaptureDebugGCStats")
- for {
- select {
- case <-ch:
- //log.Println("done CaptureDebugGCStats")
- return
- default:
- CaptureDebugGCStatsOnce(r)
- }
- }
- }()
- //*/
-
- wgR := &sync.WaitGroup{}
- //*
- wgR.Add(1)
- go func() {
- defer wgR.Done()
- //log.Println("go CaptureRuntimeMemStats")
- for {
- select {
- case <-ch:
- //log.Println("done CaptureRuntimeMemStats")
- return
- default:
- CaptureRuntimeMemStatsOnce(r)
- }
- }
- }()
- //*/
-
- wgW := &sync.WaitGroup{}
- /*
- wgW.Add(1)
- go func() {
- defer wgW.Done()
- //log.Println("go Write")
- for {
- select {
- case <-ch:
- //log.Println("done Write")
- return
- default:
- WriteOnce(r, ioutil.Discard)
- }
- }
- }()
- //*/
-
- wg := &sync.WaitGroup{}
- wg.Add(FANOUT)
- for i := 0; i < FANOUT; i++ {
- go func(i int) {
- defer wg.Done()
- //log.Println("go", i)
- for i := 0; i < b.N; i++ {
- c.Inc(1)
- g.Update(int64(i))
- gf.Update(float64(i))
- h.Update(int64(i))
- m.Mark(1)
- t.Update(1)
- }
- //log.Println("done", i)
- }(i)
- }
- wg.Wait()
- close(ch)
- wgD.Wait()
- wgR.Wait()
- wgW.Wait()
-}
diff --git a/vendor/github.com/yvasiyarov/go-metrics/opentsdb_test.go b/vendor/github.com/yvasiyarov/go-metrics/opentsdb_test.go
deleted file mode 100644
index 6173d61a..00000000
--- a/vendor/github.com/yvasiyarov/go-metrics/opentsdb_test.go
+++ /dev/null
@@ -1,22 +0,0 @@
-package metrics
-
-import (
- "net"
- "time"
-)
-
-func ExampleOpenTSDB() {
- addr, _ := net.ResolveTCPAddr("net", ":2003")
- go OpenTSDB(DefaultRegistry, 1*time.Second, "some.prefix", addr)
-}
-
-func ExampleOpenTSDBWithConfig() {
- addr, _ := net.ResolveTCPAddr("net", ":2003")
- go OpenTSDBWithConfig(OpenTSDBConfig{
- Addr: addr,
- Registry: DefaultRegistry,
- FlushInterval: 1 * time.Second,
- DurationUnit: time.Millisecond,
- })
-}
-
diff --git a/vendor/github.com/yvasiyarov/go-metrics/registry_test.go b/vendor/github.com/yvasiyarov/go-metrics/registry_test.go
deleted file mode 100644
index 9ba0a020..00000000
--- a/vendor/github.com/yvasiyarov/go-metrics/registry_test.go
+++ /dev/null
@@ -1,118 +0,0 @@
-package metrics
-
-import "testing"
-
-func BenchmarkRegistry(b *testing.B) {
- r := NewRegistry()
- r.Register("foo", NewCounter())
- b.ResetTimer()
- for i := 0; i < b.N; i++ {
- r.Each(func(string, interface{}) {})
- }
-}
-
-func TestRegistry(t *testing.T) {
- r := NewRegistry()
- r.Register("foo", NewCounter())
- i := 0
- r.Each(func(name string, iface interface{}) {
- i++
- if "foo" != name {
- t.Fatal(name)
- }
- if _, ok := iface.(Counter); !ok {
- t.Fatal(iface)
- }
- })
- if 1 != i {
- t.Fatal(i)
- }
- r.Unregister("foo")
- i = 0
- r.Each(func(string, interface{}) { i++ })
- if 0 != i {
- t.Fatal(i)
- }
-}
-
-func TestRegistryDuplicate(t *testing.T) {
- r := NewRegistry()
- if err := r.Register("foo", NewCounter()); nil != err {
- t.Fatal(err)
- }
- if err := r.Register("foo", NewGauge()); nil == err {
- t.Fatal(err)
- }
- i := 0
- r.Each(func(name string, iface interface{}) {
- i++
- if _, ok := iface.(Counter); !ok {
- t.Fatal(iface)
- }
- })
- if 1 != i {
- t.Fatal(i)
- }
-}
-
-func TestRegistryGet(t *testing.T) {
- r := NewRegistry()
- r.Register("foo", NewCounter())
- if count := r.Get("foo").(Counter).Count(); 0 != count {
- t.Fatal(count)
- }
- r.Get("foo").(Counter).Inc(1)
- if count := r.Get("foo").(Counter).Count(); 1 != count {
- t.Fatal(count)
- }
-}
-
-func TestRegistryGetOrRegister(t *testing.T) {
- r := NewRegistry()
-
- // First metric wins with GetOrRegister
- _ = r.GetOrRegister("foo", NewCounter())
- m := r.GetOrRegister("foo", NewGauge())
- if _, ok := m.(Counter); !ok {
- t.Fatal(m)
- }
-
- i := 0
- r.Each(func(name string, iface interface{}) {
- i++
- if name != "foo" {
- t.Fatal(name)
- }
- if _, ok := iface.(Counter); !ok {
- t.Fatal(iface)
- }
- })
- if i != 1 {
- t.Fatal(i)
- }
-}
-
-func TestRegistryGetOrRegisterWithLazyInstantiation(t *testing.T) {
- r := NewRegistry()
-
- // First metric wins with GetOrRegister
- _ = r.GetOrRegister("foo", NewCounter)
- m := r.GetOrRegister("foo", NewGauge)
- if _, ok := m.(Counter); !ok {
- t.Fatal(m)
- }
-
- i := 0
- r.Each(func(name string, iface interface{}) {
- i++
- if name != "foo" {
- t.Fatal(name)
- }
- if _, ok := iface.(Counter); !ok {
- t.Fatal(iface)
- }
- })
- if i != 1 {
- t.Fatal(i)
- }
-}
diff --git a/vendor/github.com/yvasiyarov/go-metrics/runtime_test.go b/vendor/github.com/yvasiyarov/go-metrics/runtime_test.go
deleted file mode 100644
index a0ca8947..00000000
--- a/vendor/github.com/yvasiyarov/go-metrics/runtime_test.go
+++ /dev/null
@@ -1,78 +0,0 @@
-package metrics
-
-import (
- "runtime"
- "testing"
- "time"
-)
-
-func BenchmarkRuntimeMemStats(b *testing.B) {
- r := NewRegistry()
- RegisterRuntimeMemStats(r)
- b.ResetTimer()
- for i := 0; i < b.N; i++ {
- CaptureRuntimeMemStatsOnce(r)
- }
-}
-
-func TestRuntimeMemStats(t *testing.T) {
- r := NewRegistry()
- RegisterRuntimeMemStats(r)
- CaptureRuntimeMemStatsOnce(r)
- zero := runtimeMetrics.MemStats.PauseNs.Count() // Get a "zero" since GC may have run before these tests.
- runtime.GC()
- CaptureRuntimeMemStatsOnce(r)
- if count := runtimeMetrics.MemStats.PauseNs.Count(); 1 != count-zero {
- t.Fatal(count - zero)
- }
- runtime.GC()
- runtime.GC()
- CaptureRuntimeMemStatsOnce(r)
- if count := runtimeMetrics.MemStats.PauseNs.Count(); 3 != count-zero {
- t.Fatal(count - zero)
- }
- for i := 0; i < 256; i++ {
- runtime.GC()
- }
- CaptureRuntimeMemStatsOnce(r)
- if count := runtimeMetrics.MemStats.PauseNs.Count(); 259 != count-zero {
- t.Fatal(count - zero)
- }
- for i := 0; i < 257; i++ {
- runtime.GC()
- }
- CaptureRuntimeMemStatsOnce(r)
- if count := runtimeMetrics.MemStats.PauseNs.Count(); 515 != count-zero { // We lost one because there were too many GCs between captures.
- t.Fatal(count - zero)
- }
-}
-
-func TestRuntimeMemStatsBlocking(t *testing.T) {
- if g := runtime.GOMAXPROCS(0); g < 2 {
- t.Skipf("skipping TestRuntimeMemStatsBlocking with GOMAXPROCS=%d\n", g)
- }
- ch := make(chan int)
- go testRuntimeMemStatsBlocking(ch)
- var memStats runtime.MemStats
- t0 := time.Now()
- runtime.ReadMemStats(&memStats)
- t1 := time.Now()
- t.Log("i++ during runtime.ReadMemStats:", <-ch)
- go testRuntimeMemStatsBlocking(ch)
- d := t1.Sub(t0)
- t.Log(d)
- time.Sleep(d)
- t.Log("i++ during time.Sleep:", <-ch)
-}
-
-func testRuntimeMemStatsBlocking(ch chan int) {
- i := 0
- for {
- select {
- case ch <- i:
- return
- default:
- i++
- }
- }
-}
diff --git a/vendor/github.com/yvasiyarov/go-metrics/sample_test.go b/vendor/github.com/yvasiyarov/go-metrics/sample_test.go
deleted file mode 100644
index 3cff3c09..00000000
--- a/vendor/github.com/yvasiyarov/go-metrics/sample_test.go
+++ /dev/null
@@ -1,352 +0,0 @@
-package metrics
-
-import (
- "math/rand"
- "runtime"
- "testing"
- "time"
-)
-
-// Benchmark{Compute,Copy}{1000,1000000} demonstrate that, even for relatively
-// expensive computations like Variance, the cost of copying the Sample, as
-// approximated by a make and copy, is much greater than the cost of the
-// computation for small samples and only slightly less for large samples.
-func BenchmarkCompute1000(b *testing.B) {
- s := make([]int64, 1000)
- for i := 0; i < len(s); i++ {
- s[i] = int64(i)
- }
- b.ResetTimer()
- for i := 0; i < b.N; i++ {
- SampleVariance(s)
- }
-}
-func BenchmarkCompute1000000(b *testing.B) {
- s := make([]int64, 1000000)
- for i := 0; i < len(s); i++ {
- s[i] = int64(i)
- }
- b.ResetTimer()
- for i := 0; i < b.N; i++ {
- SampleVariance(s)
- }
-}
-func BenchmarkCopy1000(b *testing.B) {
- s := make([]int64, 1000)
- for i := 0; i < len(s); i++ {
- s[i] = int64(i)
- }
- b.ResetTimer()
- for i := 0; i < b.N; i++ {
- sCopy := make([]int64, len(s))
- copy(sCopy, s)
- }
-}
-func BenchmarkCopy1000000(b *testing.B) {
- s := make([]int64, 1000000)
- for i := 0; i < len(s); i++ {
- s[i] = int64(i)
- }
- b.ResetTimer()
- for i := 0; i < b.N; i++ {
- sCopy := make([]int64, len(s))
- copy(sCopy, s)
- }
-}
-
-func BenchmarkExpDecaySample257(b *testing.B) {
- benchmarkSample(b, NewExpDecaySample(257, 0.015))
-}
-
-func BenchmarkExpDecaySample514(b *testing.B) {
- benchmarkSample(b, NewExpDecaySample(514, 0.015))
-}
-
-func BenchmarkExpDecaySample1028(b *testing.B) {
- benchmarkSample(b, NewExpDecaySample(1028, 0.015))
-}
-
-func BenchmarkUniformSample257(b *testing.B) {
- benchmarkSample(b, NewUniformSample(257))
-}
-
-func BenchmarkUniformSample514(b *testing.B) {
- benchmarkSample(b, NewUniformSample(514))
-}
-
-func BenchmarkUniformSample1028(b *testing.B) {
- benchmarkSample(b, NewUniformSample(1028))
-}
-
-func TestExpDecaySample10(t *testing.T) {
- rand.Seed(1)
- s := NewExpDecaySample(100, 0.99)
- for i := 0; i < 10; i++ {
- s.Update(int64(i))
- }
- if size := s.Count(); 10 != size {
- t.Errorf("s.Count(): 10 != %v\n", size)
- }
- if size := s.Size(); 10 != size {
- t.Errorf("s.Size(): 10 != %v\n", size)
- }
- if l := len(s.Values()); 10 != l {
- t.Errorf("len(s.Values()): 10 != %v\n", l)
- }
- for _, v := range s.Values() {
- if v > 10 || v < 0 {
- t.Errorf("out of range [0, 10): %v\n", v)
- }
- }
-}
-
-func TestExpDecaySample100(t *testing.T) {
- rand.Seed(1)
- s := NewExpDecaySample(1000, 0.01)
- for i := 0; i < 100; i++ {
- s.Update(int64(i))
- }
- if size := s.Count(); 100 != size {
- t.Errorf("s.Count(): 100 != %v\n", size)
- }
- if size := s.Size(); 100 != size {
- t.Errorf("s.Size(): 100 != %v\n", size)
- }
- if l := len(s.Values()); 100 != l {
- t.Errorf("len(s.Values()): 100 != %v\n", l)
- }
- for _, v := range s.Values() {
- if v > 100 || v < 0 {
- t.Errorf("out of range [0, 100): %v\n", v)
- }
- }
-}
-
-func TestExpDecaySample1000(t *testing.T) {
- rand.Seed(1)
- s := NewExpDecaySample(100, 0.99)
- for i := 0; i < 1000; i++ {
- s.Update(int64(i))
- }
- if size := s.Count(); 1000 != size {
- t.Errorf("s.Count(): 1000 != %v\n", size)
- }
- if size := s.Size(); 100 != size {
- t.Errorf("s.Size(): 100 != %v\n", size)
- }
- if l := len(s.Values()); 100 != l {
- t.Errorf("len(s.Values()): 100 != %v\n", l)
- }
- for _, v := range s.Values() {
- if v > 1000 || v < 0 {
- t.Errorf("out of range [0, 1000): %v\n", v)
- }
- }
-}
-
-// This test makes sure that the sample's priority is not amplified by using
-// nanosecond duration since start rather than second duration since start.
-// The priority becomes +Inf quickly after starting if this is done,
-// effectively freezing the set of samples until a rescale step happens.
-func TestExpDecaySampleNanosecondRegression(t *testing.T) {
- rand.Seed(1)
- s := NewExpDecaySample(100, 0.99)
- for i := 0; i < 100; i++ {
- s.Update(10)
- }
- time.Sleep(1 * time.Millisecond)
- for i := 0; i < 100; i++ {
- s.Update(20)
- }
- v := s.Values()
- avg := float64(0)
- for i := 0; i < len(v); i++ {
- avg += float64(v[i])
- }
- avg /= float64(len(v))
- if avg > 16 || avg < 14 {
- t.Errorf("out of range [14, 16]: %v\n", avg)
- }
-}
-
-func TestExpDecaySampleSnapshot(t *testing.T) {
- now := time.Now()
- rand.Seed(1)
- s := NewExpDecaySample(100, 0.99)
- for i := 1; i <= 10000; i++ {
- s.(*ExpDecaySample).update(now.Add(time.Duration(i)), int64(i))
- }
- snapshot := s.Snapshot()
- s.Update(1)
- testExpDecaySampleStatistics(t, snapshot)
-}
-
-func TestExpDecaySampleStatistics(t *testing.T) {
- now := time.Now()
- rand.Seed(1)
- s := NewExpDecaySample(100, 0.99)
- for i := 1; i <= 10000; i++ {
- s.(*ExpDecaySample).update(now.Add(time.Duration(i)), int64(i))
- }
- testExpDecaySampleStatistics(t, s)
-}
-
-func TestUniformSample(t *testing.T) {
- rand.Seed(1)
- s := NewUniformSample(100)
- for i := 0; i < 1000; i++ {
- s.Update(int64(i))
- }
- if size := s.Count(); 1000 != size {
- t.Errorf("s.Count(): 1000 != %v\n", size)
- }
- if size := s.Size(); 100 != size {
- t.Errorf("s.Size(): 100 != %v\n", size)
- }
- if l := len(s.Values()); 100 != l {
- t.Errorf("len(s.Values()): 100 != %v\n", l)
- }
- for _, v := range s.Values() {
- if v > 1000 || v < 0 {
- t.Errorf("out of range [0, 100): %v\n", v)
- }
- }
-}
-
-func TestUniformSampleIncludesTail(t *testing.T) {
- rand.Seed(1)
- s := NewUniformSample(100)
- max := 100
- for i := 0; i < max; i++ {
- s.Update(int64(i))
- }
- v := s.Values()
- sum := 0
- exp := (max - 1) * max / 2
- for i := 0; i < len(v); i++ {
- sum += int(v[i])
- }
- if exp != sum {
- t.Errorf("sum: %v != %v\n", exp, sum)
- }
-}
-
-func TestUniformSampleSnapshot(t *testing.T) {
- s := NewUniformSample(100)
- for i := 1; i <= 10000; i++ {
- s.Update(int64(i))
- }
- snapshot := s.Snapshot()
- s.Update(1)
- testUniformSampleStatistics(t, snapshot)
-}
-
-func TestUniformSampleStatistics(t *testing.T) {
- rand.Seed(1)
- s := NewUniformSample(100)
- for i := 1; i <= 10000; i++ {
- s.Update(int64(i))
- }
- testUniformSampleStatistics(t, s)
-}
-
-func benchmarkSample(b *testing.B, s Sample) {
- var memStats runtime.MemStats
- runtime.ReadMemStats(&memStats)
- pauseTotalNs := memStats.PauseTotalNs
- b.ResetTimer()
- for i := 0; i < b.N; i++ {
- s.Update(1)
- }
- b.StopTimer()
- runtime.GC()
- runtime.ReadMemStats(&memStats)
- b.Logf("GC cost: %d ns/op", int(memStats.PauseTotalNs-pauseTotalNs)/b.N)
-}
-
-func testExpDecaySampleStatistics(t *testing.T, s Sample) {
- if count := s.Count(); 10000 != count {
- t.Errorf("s.Count(): 10000 != %v\n", count)
- }
- if min := s.Min(); 107 != min {
- t.Errorf("s.Min(): 107 != %v\n", min)
- }
- if max := s.Max(); 10000 != max {
- t.Errorf("s.Max(): 10000 != %v\n", max)
- }
- if mean := s.Mean(); 4965.98 != mean {
- t.Errorf("s.Mean(): 4965.98 != %v\n", mean)
- }
- if stdDev := s.StdDev(); 2959.825156930727 != stdDev {
- t.Errorf("s.StdDev(): 2959.825156930727 != %v\n", stdDev)
- }
- ps := s.Percentiles([]float64{0.5, 0.75, 0.99})
- if 4615 != ps[0] {
- t.Errorf("median: 4615 != %v\n", ps[0])
- }
- if 7672 != ps[1] {
- t.Errorf("75th percentile: 7672 != %v\n", ps[1])
- }
- if 9998.99 != ps[2] {
- t.Errorf("99th percentile: 9998.99 != %v\n", ps[2])
- }
-}
-
-func testUniformSampleStatistics(t *testing.T, s Sample) {
- if count := s.Count(); 10000 != count {
- t.Errorf("s.Count(): 10000 != %v\n", count)
- }
- if min := s.Min(); 9412 != min {
- t.Errorf("s.Min(): 9412 != %v\n", min)
- }
- if max := s.Max(); 10000 != max {
- t.Errorf("s.Max(): 10000 != %v\n", max)
- }
- if mean := s.Mean(); 9902.26 != mean {
- t.Errorf("s.Mean(): 9902.26 != %v\n", mean)
- }
- if stdDev := s.StdDev(); 101.8667384380201 != stdDev {
- t.Errorf("s.StdDev(): 101.8667384380201 != %v\n", stdDev)
- }
- ps := s.Percentiles([]float64{0.5, 0.75, 0.99})
- if 9930.5 != ps[0] {
- t.Errorf("median: 9930.5 != %v\n", ps[0])
- }
- if 9973.75 != ps[1] {
- t.Errorf("75th percentile: 9973.75 != %v\n", ps[1])
- }
- if 9999.99 != ps[2] {
- t.Errorf("99th percentile: 9999.99 != %v\n", ps[2])
- }
-}
-
-// TestUniformSampleConcurrentUpdateCount would expose data race problems with
-// concurrent Update and Count calls on Sample when test is called with -race
-// argument
-func TestUniformSampleConcurrentUpdateCount(t *testing.T) {
- if testing.Short() {
- t.Skip("skipping in short mode")
- }
- s := NewUniformSample(100)
- for i := 0; i < 100; i++ {
- s.Update(int64(i))
- }
- quit := make(chan struct{})
- go func() {
- t := time.NewTicker(10 * time.Millisecond)
- for {
- select {
- case <-t.C:
- s.Update(rand.Int63())
- case <-quit:
- t.Stop()
- return
- }
- }
- }()
- for i := 0; i < 1000; i++ {
- s.Count()
- time.Sleep(5 * time.Millisecond)
- }
- quit <- struct{}{}
-}
diff --git a/vendor/github.com/yvasiyarov/go-metrics/stathat/stathat.go b/vendor/github.com/yvasiyarov/go-metrics/stathat/stathat.go
deleted file mode 100644
index 0afcb484..00000000
--- a/vendor/github.com/yvasiyarov/go-metrics/stathat/stathat.go
+++ /dev/null
@@ -1,69 +0,0 @@
-// Metrics output to StatHat.
-package stathat
-
-import (
- "github.com/rcrowley/go-metrics"
- "github.com/stathat/go"
- "log"
- "time"
-)
-
-func Stathat(r metrics.Registry, d time.Duration, userkey string) {
- for {
- if err := sh(r, userkey); nil != err {
- log.Println(err)
- }
- time.Sleep(d)
- }
-}
-
-func sh(r metrics.Registry, userkey string) error {
- r.Each(func(name string, i interface{}) {
- switch metric := i.(type) {
- case metrics.Counter:
- stathat.PostEZCount(name, userkey, int(metric.Count()))
- case metrics.Gauge:
- stathat.PostEZValue(name, userkey, float64(metric.Value()))
- case metrics.GaugeFloat64:
- stathat.PostEZValue(name, userkey, float64(metric.Value()))
- case metrics.Histogram:
- h := metric.Snapshot()
- ps := h.Percentiles([]float64{0.5, 0.75, 0.95, 0.99, 0.999})
- stathat.PostEZCount(name+".count", userkey, int(h.Count()))
- stathat.PostEZValue(name+".min", userkey, float64(h.Min()))
- stathat.PostEZValue(name+".max", userkey, float64(h.Max()))
- stathat.PostEZValue(name+".mean", userkey, float64(h.Mean()))
- stathat.PostEZValue(name+".std-dev", userkey, float64(h.StdDev()))
- stathat.PostEZValue(name+".50-percentile", userkey, float64(ps[0]))
- stathat.PostEZValue(name+".75-percentile", userkey, float64(ps[1]))
- stathat.PostEZValue(name+".95-percentile", userkey, float64(ps[2]))
- stathat.PostEZValue(name+".99-percentile", userkey, float64(ps[3]))
- stathat.PostEZValue(name+".999-percentile", userkey, float64(ps[4]))
- case metrics.Meter:
- m := metric.Snapshot()
- stathat.PostEZCount(name+".count", userkey, int(m.Count()))
- stathat.PostEZValue(name+".one-minute", userkey, float64(m.Rate1()))
- stathat.PostEZValue(name+".five-minute", userkey, float64(m.Rate5()))
- stathat.PostEZValue(name+".fifteen-minute", userkey, float64(m.Rate15()))
- stathat.PostEZValue(name+".mean", userkey, float64(m.RateMean()))
- case metrics.Timer:
- t := metric.Snapshot()
- ps := t.Percentiles([]float64{0.5, 0.75, 0.95, 0.99, 0.999})
- stathat.PostEZCount(name+".count", userkey, int(t.Count()))
- stathat.PostEZValue(name+".min", userkey, float64(t.Min()))
- stathat.PostEZValue(name+".max", userkey, float64(t.Max()))
- stathat.PostEZValue(name+".mean", userkey, float64(t.Mean()))
- stathat.PostEZValue(name+".std-dev", userkey, float64(t.StdDev()))
- stathat.PostEZValue(name+".50-percentile", userkey, float64(ps[0]))
- stathat.PostEZValue(name+".75-percentile", userkey, float64(ps[1]))
- stathat.PostEZValue(name+".95-percentile", userkey, float64(ps[2]))
- stathat.PostEZValue(name+".99-percentile", userkey, float64(ps[3]))
- stathat.PostEZValue(name+".999-percentile", userkey, float64(ps[4]))
- stathat.PostEZValue(name+".one-minute", userkey, float64(t.Rate1()))
- stathat.PostEZValue(name+".five-minute", userkey, float64(t.Rate5()))
- stathat.PostEZValue(name+".fifteen-minute", userkey, float64(t.Rate15()))
- stathat.PostEZValue(name+".mean-rate", userkey, float64(t.RateMean()))
- }
- })
- return nil
-}
diff --git a/vendor/github.com/yvasiyarov/go-metrics/timer_test.go b/vendor/github.com/yvasiyarov/go-metrics/timer_test.go
deleted file mode 100644
index 2fa415d4..00000000
--- a/vendor/github.com/yvasiyarov/go-metrics/timer_test.go
+++ /dev/null
@@ -1,81 +0,0 @@
-package metrics
-
-import (
- "math"
- "testing"
- "time"
-)
-
-func BenchmarkTimer(b *testing.B) {
- tm := NewTimer()
- b.ResetTimer()
- for i := 0; i < b.N; i++ {
- tm.Update(1)
- }
-}
-
-func TestGetOrRegisterTimer(t *testing.T) {
- r := NewRegistry()
- NewRegisteredTimer("foo", r).Update(47)
- if tm := GetOrRegisterTimer("foo", r); 1 != tm.Count() {
- t.Fatal(tm)
- }
-}
-
-func TestTimerExtremes(t *testing.T) {
- tm := NewTimer()
- tm.Update(math.MaxInt64)
- tm.Update(0)
- if stdDev := tm.StdDev(); 4.611686018427388e+18 != stdDev {
- t.Errorf("tm.StdDev(): 4.611686018427388e+18 != %v\n", stdDev)
- }
-}
-
-func TestTimerFunc(t *testing.T) {
- tm := NewTimer()
- tm.Time(func() { time.Sleep(50e6) })
- if max := tm.Max(); 45e6 > max || max > 55e6 {
- t.Errorf("tm.Max(): 45e6 > %v || %v > 55e6\n", max, max)
- }
-}
-
-func TestTimerZero(t *testing.T) {
- tm := NewTimer()
- if count := tm.Count(); 0 != count {
- t.Errorf("tm.Count(): 0 != %v\n", count)
- }
- if min := tm.Min(); 0 != min {
- t.Errorf("tm.Min(): 0 != %v\n", min)
- }
- if max := tm.Max(); 0 != max {
- t.Errorf("tm.Max(): 0 != %v\n", max)
- }
- if mean := tm.Mean(); 0.0 != mean {
- t.Errorf("tm.Mean(): 0.0 != %v\n", mean)
- }
- if stdDev := tm.StdDev(); 0.0 != stdDev {
- t.Errorf("tm.StdDev(): 0.0 != %v\n", stdDev)
- }
- ps := tm.Percentiles([]float64{0.5, 0.75, 0.99})
- if 0.0 != ps[0] {
- t.Errorf("median: 0.0 != %v\n", ps[0])
- }
- if 0.0 != ps[1] {
- t.Errorf("75th percentile: 0.0 != %v\n", ps[1])
- }
- if 0.0 != ps[2] {
- t.Errorf("99th percentile: 0.0 != %v\n", ps[2])
- }
- if rate1 := tm.Rate1(); 0.0 != rate1 {
- t.Errorf("tm.Rate1(): 0.0 != %v\n", rate1)
- }
- if rate5 := tm.Rate5(); 0.0 != rate5 {
- t.Errorf("tm.Rate5(): 0.0 != %v\n", rate5)
- }
- if rate15 := tm.Rate15(); 0.0 != rate15 {
- t.Errorf("tm.Rate15(): 0.0 != %v\n", rate15)
- }
- if rateMean := tm.RateMean(); 0.0 != rateMean {
- t.Errorf("tm.RateMean(): 0.0 != %v\n", rateMean)
- }
-}
diff --git a/vendor/github.com/yvasiyarov/go-metrics/writer_test.go b/vendor/github.com/yvasiyarov/go-metrics/writer_test.go
deleted file mode 100644
index 1aacc287..00000000
--- a/vendor/github.com/yvasiyarov/go-metrics/writer_test.go
+++ /dev/null
@@ -1,22 +0,0 @@
-package metrics
-
-import (
- "sort"
- "testing"
-)
-
-func TestMetricsSorting(t *testing.T) {
- var namedMetrics = namedMetricSlice{
- {name: "zzz"},
- {name: "bbb"},
- {name: "fff"},
- {name: "ggg"},
- }
-
- sort.Sort(namedMetrics)
- for i, name := range []string{"bbb", "fff", "ggg", "zzz"} {
- if namedMetrics[i].name != name {
- t.Fail()
- }
- }
-}
diff --git a/vendor/github.com/yvasiyarov/gorelic/examples/example1.go b/vendor/github.com/yvasiyarov/gorelic/examples/example1.go
deleted file mode 100644
index dc6c0e34..00000000
--- a/vendor/github.com/yvasiyarov/gorelic/examples/example1.go
+++ /dev/null
@@ -1,52 +0,0 @@
-package main
-
-import (
- "flag"
- "github.com/yvasiyarov/gorelic"
- "log"
- "math/rand"
- "runtime"
- "time"
-)
-
-var newrelicLicense = flag.String("newrelic-license", "", "Newrelic license")
-
-func allocateAndSum(arraySize int) int {
- arr := make([]int, arraySize, arraySize)
- for i := range arr {
- arr[i] = rand.Int()
- }
- time.Sleep(time.Duration(rand.Intn(3000)) * time.Millisecond)
-
- result := 0
- for _, v := range arr {
- result += v
- }
- //log.Printf("Array size is: %d, sum is: %d\n", arraySize, result)
- return result
-}
-
-func doSomeJob(numRoutines int) {
- for {
- for i := 0; i < numRoutines; i++ {
- go allocateAndSum(rand.Intn(1024) * 1024)
- }
- log.Printf("All %d routines started\n", numRoutines)
- time.Sleep(1000 * time.Millisecond)
- runtime.GC()
- }
-}
-
-func main() {
-
- flag.Parse()
- if *newrelicLicense == "" {
- log.Fatalf("Please, pass a valid newrelic license key.\n Use --help to get more information about available options\n")
- }
- agent := gorelic.NewAgent()
- agent.Verbose = true
- agent.NewrelicLicense = *newrelicLicense
- agent.Run()
-
- doSomeJob(100)
-}
diff --git a/vendor/github.com/yvasiyarov/gorelic/examples/example_web.go b/vendor/github.com/yvasiyarov/gorelic/examples/example_web.go
deleted file mode 100644
index aae0ef7e..00000000
--- a/vendor/github.com/yvasiyarov/gorelic/examples/example_web.go
+++ /dev/null
@@ -1,63 +0,0 @@
-package main
-
-import (
- "expvar"
- "flag"
- "github.com/yvasiyarov/gorelic"
- "io"
- "log"
- "math/rand"
- "net/http"
- "runtime"
- "time"
-)
-
-var newrelicLicense = flag.String("newrelic-license", "", "Newrelic license")
-
-var numCalls = expvar.NewInt("num_calls")
-
-func allocateAndSum(arraySize int) int {
- arr := make([]int, arraySize, arraySize)
- for i := range arr {
- arr[i] = rand.Int()
- }
- time.Sleep(time.Duration(rand.Intn(3000)) * time.Millisecond)
-
- result := 0
- for _, v := range arr {
- result += v
- }
- //log.Printf("Array size is: %d, sum is: %d\n", arraySize, result)
- return result
-}
-
-func doSomeJob(numRoutines int) {
- for i := 0; i < numRoutines; i++ {
- go allocateAndSum(rand.Intn(1024) * 1024)
- }
- log.Printf("All %d routines started\n", numRoutines)
- time.Sleep(1000 * time.Millisecond)
- runtime.GC()
-}
-
-func helloServer(w http.ResponseWriter, req *http.Request) {
-
- doSomeJob(5)
- io.WriteString(w, "Did some work")
-}
-
-func main() {
- flag.Parse()
- if *newrelicLicense == "" {
- log.Fatalf("Please, pass a valid newrelic license key.\n Use --help to get more information about available options\n")
- }
- agent := gorelic.NewAgent()
- agent.Verbose = true
- agent.CollectHTTPStat = true
- agent.NewrelicLicense = *newrelicLicense
- agent.Run()
-
- http.HandleFunc("/", agent.WrapHTTPHandlerFunc(helloServer))
- http.ListenAndServe(":8080", nil)
-
-}
diff --git a/vendor/github.com/yvasiyarov/newrelic_platform_go/examples/wave_plugin.go b/vendor/github.com/yvasiyarov/newrelic_platform_go/examples/wave_plugin.go
deleted file mode 100644
index 57f3cf87..00000000
--- a/vendor/github.com/yvasiyarov/newrelic_platform_go/examples/wave_plugin.go
+++ /dev/null
@@ -1,72 +0,0 @@
-package main
-
-import (
- "github.com/yvasiyarov/newrelic_platform_go"
-)
-
-type WaveMetrica struct {
- sawtoothMax int
- sawtoothCounter int
-}
-
-func (metrica *WaveMetrica) GetName() string {
- return "Wave_Metrica"
-}
-func (metrica *WaveMetrica) GetUnits() string {
- return "Queries/Second"
-}
-func (metrica *WaveMetrica) GetValue() (float64, error) {
- metrica.sawtoothCounter++
- if metrica.sawtoothCounter > metrica.sawtoothMax {
- metrica.sawtoothCounter = 0
- }
- return float64(metrica.sawtoothCounter), nil
-}
-
-type SquareWaveMetrica struct {
- squarewaveMax int
- squarewaveCounter int
-}
-
-func (metrica *SquareWaveMetrica) GetName() string {
- return "SquareWave_Metrica"
-}
-func (metrica *SquareWaveMetrica) GetUnits() string {
- return "Queries/Second"
-}
-func (metrica *SquareWaveMetrica) GetValue() (float64, error) {
- returnValue := 0
- metrica.squarewaveCounter++
-
- if metrica.squarewaveCounter < (metrica.squarewaveMax / 2) {
- returnValue = 0
- } else {
- returnValue = metrica.squarewaveMax
- }
-
- if metrica.squarewaveCounter > metrica.squarewaveMax {
- metrica.squarewaveCounter = 0
- }
- return float64(returnValue), nil
-}
-
-func main() {
- plugin := newrelic_platform_go.NewNewrelicPlugin("0.0.1", "7bceac019c7dcafae1ef95be3e3a3ff8866de246", 60)
- component := newrelic_platform_go.NewPluginComponent("Wave component", "com.exmaple.plugin.gowave")
- plugin.AddComponent(component)
-
- m := &WaveMetrica{
- sawtoothMax: 10,
- sawtoothCounter: 5,
- }
- component.AddMetrica(m)
-
- m1 := &SquareWaveMetrica{
- squarewaveMax: 4,
- squarewaveCounter: 1,
- }
- component.AddMetrica(m1)
-
- plugin.Verbose = true
- plugin.Run()
-}
diff --git a/vendor/golang.org/x/crypto/bcrypt/bcrypt_test.go b/vendor/golang.org/x/crypto/bcrypt/bcrypt_test.go
deleted file mode 100644
index f08a6f5b..00000000
--- a/vendor/golang.org/x/crypto/bcrypt/bcrypt_test.go
+++ /dev/null
@@ -1,226 +0,0 @@
-// Copyright 2011 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package bcrypt
-
-import (
- "bytes"
- "fmt"
- "testing"
-)
-
-func TestBcryptingIsEasy(t *testing.T) {
- pass := []byte("mypassword")
- hp, err := GenerateFromPassword(pass, 0)
- if err != nil {
- t.Fatalf("GenerateFromPassword error: %s", err)
- }
-
- if CompareHashAndPassword(hp, pass) != nil {
- t.Errorf("%v should hash %s correctly", hp, pass)
- }
-
- notPass := "notthepass"
- err = CompareHashAndPassword(hp, []byte(notPass))
- if err != ErrMismatchedHashAndPassword {
- t.Errorf("%v and %s should be mismatched", hp, notPass)
- }
-}
-
-func TestBcryptingIsCorrect(t *testing.T) {
- pass := []byte("allmine")
- salt := []byte("XajjQvNhvvRt5GSeFk1xFe")
- expectedHash := []byte("$2a$10$XajjQvNhvvRt5GSeFk1xFeyqRrsxkhBkUiQeg0dt.wU1qD4aFDcga")
-
- hash, err := bcrypt(pass, 10, salt)
- if err != nil {
- t.Fatalf("bcrypt blew up: %v", err)
- }
- if !bytes.HasSuffix(expectedHash, hash) {
- t.Errorf("%v should be the suffix of %v", hash, expectedHash)
- }
-
- h, err := newFromHash(expectedHash)
- if err != nil {
- t.Errorf("Unable to parse %s: %v", string(expectedHash), err)
- }
-
- // This is not the safe way to compare these hashes. We do this only for
- // testing clarity. Use bcrypt.CompareHashAndPassword()
- if err == nil && !bytes.Equal(expectedHash, h.Hash()) {
- t.Errorf("Parsed hash %v should equal %v", h.Hash(), expectedHash)
- }
-}
-
-func TestVeryShortPasswords(t *testing.T) {
- key := []byte("k")
- salt := []byte("XajjQvNhvvRt5GSeFk1xFe")
- _, err := bcrypt(key, 10, salt)
- if err != nil {
- t.Errorf("One byte key resulted in error: %s", err)
- }
-}
-
-func TestTooLongPasswordsWork(t *testing.T) {
- salt := []byte("XajjQvNhvvRt5GSeFk1xFe")
- // One byte over the usual 56 byte limit that blowfish has
- tooLongPass := []byte("012345678901234567890123456789012345678901234567890123456")
- tooLongExpected := []byte("$2a$10$XajjQvNhvvRt5GSeFk1xFe5l47dONXg781AmZtd869sO8zfsHuw7C")
- hash, err := bcrypt(tooLongPass, 10, salt)
- if err != nil {
- t.Fatalf("bcrypt blew up on long password: %v", err)
- }
- if !bytes.HasSuffix(tooLongExpected, hash) {
- t.Errorf("%v should be the suffix of %v", hash, tooLongExpected)
- }
-}
-
-type InvalidHashTest struct {
- err error
- hash []byte
-}
-
-var invalidTests = []InvalidHashTest{
- {ErrHashTooShort, []byte("$2a$10$fooo")},
- {ErrHashTooShort, []byte("$2a")},
- {HashVersionTooNewError('3'), []byte("$3a$10$sssssssssssssssssssssshhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh")},
- {InvalidHashPrefixError('%'), []byte("%2a$10$sssssssssssssssssssssshhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh")},
- {InvalidCostError(32), []byte("$2a$32$sssssssssssssssssssssshhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh")},
-}
-
-func TestInvalidHashErrors(t *testing.T) {
- check := func(name string, expected, err error) {
- if err == nil {
- t.Errorf("%s: Should have returned an error", name)
- }
- if err != nil && err != expected {
- t.Errorf("%s gave err %v but should have given %v", name, err, expected)
- }
- }
- for _, iht := range invalidTests {
- _, err := newFromHash(iht.hash)
- check("newFromHash", iht.err, err)
- err = CompareHashAndPassword(iht.hash, []byte("anything"))
- check("CompareHashAndPassword", iht.err, err)
- }
-}
-
-func TestUnpaddedBase64Encoding(t *testing.T) {
- original := []byte{101, 201, 101, 75, 19, 227, 199, 20, 239, 236, 133, 32, 30, 109, 243, 30}
- encodedOriginal := []byte("XajjQvNhvvRt5GSeFk1xFe")
-
- encoded := base64Encode(original)
-
- if !bytes.Equal(encodedOriginal, encoded) {
- t.Errorf("Encoded %v should have equaled %v", encoded, encodedOriginal)
- }
-
- decoded, err := base64Decode(encodedOriginal)
- if err != nil {
- t.Fatalf("base64Decode blew up: %s", err)
- }
-
- if !bytes.Equal(decoded, original) {
- t.Errorf("Decoded %v should have equaled %v", decoded, original)
- }
-}
-
-func TestCost(t *testing.T) {
- suffix := "XajjQvNhvvRt5GSeFk1xFe5l47dONXg781AmZtd869sO8zfsHuw7C"
- for _, vers := range []string{"2a", "2"} {
- for _, cost := range []int{4, 10} {
- s := fmt.Sprintf("$%s$%02d$%s", vers, cost, suffix)
- h := []byte(s)
- actual, err := Cost(h)
- if err != nil {
- t.Errorf("Cost, error: %s", err)
- continue
- }
- if actual != cost {
- t.Errorf("Cost, expected: %d, actual: %d", cost, actual)
- }
- }
- }
- _, err := Cost([]byte("$a$a$" + suffix))
- if err == nil {
- t.Errorf("Cost, malformed but no error returned")
- }
-}
-
-func TestCostValidationInHash(t *testing.T) {
- if testing.Short() {
- return
- }
-
- pass := []byte("mypassword")
-
- for c := 0; c < MinCost; c++ {
- p, _ := newFromPassword(pass, c)
- if p.cost != DefaultCost {
- t.Errorf("newFromPassword should default costs below %d to %d, but was %d", MinCost, DefaultCost, p.cost)
- }
- }
-
- p, _ := newFromPassword(pass, 14)
- if p.cost != 14 {
- t.Errorf("newFromPassword should default cost to 14, but was %d", p.cost)
- }
-
- hp, _ := newFromHash(p.Hash())
- if p.cost != hp.cost {
- t.Errorf("newFromHash should maintain the cost at %d, but was %d", p.cost, hp.cost)
- }
-
- _, err := newFromPassword(pass, 32)
- if err == nil {
- t.Fatalf("newFromPassword: should return a cost error")
- }
- if err != InvalidCostError(32) {
- t.Errorf("newFromPassword: should return cost error, got %#v", err)
- }
-}
-
-func TestCostReturnsWithLeadingZeroes(t *testing.T) {
- hp, _ := newFromPassword([]byte("abcdefgh"), 7)
- cost := hp.Hash()[4:7]
- expected := []byte("07$")
-
- if !bytes.Equal(expected, cost) {
- t.Errorf("single digit costs in hash should have leading zeros: was %v instead of %v", cost, expected)
- }
-}
-
-func TestMinorNotRequired(t *testing.T) {
- noMinorHash := []byte("$2$10$XajjQvNhvvRt5GSeFk1xFeyqRrsxkhBkUiQeg0dt.wU1qD4aFDcga")
- h, err := newFromHash(noMinorHash)
- if err != nil {
- t.Fatalf("No minor hash blew up: %s", err)
- }
- if h.minor != 0 {
- t.Errorf("Should leave minor version at 0, but was %d", h.minor)
- }
-
- if !bytes.Equal(noMinorHash, h.Hash()) {
- t.Errorf("Should generate hash %v, but created %v", noMinorHash, h.Hash())
- }
-}
-
-func BenchmarkEqual(b *testing.B) {
- b.StopTimer()
- passwd := []byte("somepasswordyoulike")
- hash, _ := GenerateFromPassword(passwd, 10)
- b.StartTimer()
- for i := 0; i < b.N; i++ {
- CompareHashAndPassword(hash, passwd)
- }
-}
-
-func BenchmarkGeneration(b *testing.B) {
- b.StopTimer()
- passwd := []byte("mylongpassword1234")
- b.StartTimer()
- for i := 0; i < b.N; i++ {
- GenerateFromPassword(passwd, 10)
- }
-}
diff --git a/vendor/golang.org/x/crypto/blowfish/blowfish_test.go b/vendor/golang.org/x/crypto/blowfish/blowfish_test.go
deleted file mode 100644
index 7afa1fdf..00000000
--- a/vendor/golang.org/x/crypto/blowfish/blowfish_test.go
+++ /dev/null
@@ -1,274 +0,0 @@
-// Copyright 2010 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package blowfish
-
-import "testing"
-
-type CryptTest struct {
- key []byte
- in []byte
- out []byte
-}
-
-// Test vector values are from http://www.schneier.com/code/vectors.txt.
-var encryptTests = []CryptTest{
- {
- []byte{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00},
- []byte{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00},
- []byte{0x4E, 0xF9, 0x97, 0x45, 0x61, 0x98, 0xDD, 0x78}},
- {
- []byte{0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
- []byte{0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
- []byte{0x51, 0x86, 0x6F, 0xD5, 0xB8, 0x5E, 0xCB, 0x8A}},
- {
- []byte{0x30, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00},
- []byte{0x10, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01},
- []byte{0x7D, 0x85, 0x6F, 0x9A, 0x61, 0x30, 0x63, 0xF2}},
- {
- []byte{0x11, 0x11, 0x11, 0x11, 0x11, 0x11, 0x11, 0x11},
- []byte{0x11, 0x11, 0x11, 0x11, 0x11, 0x11, 0x11, 0x11},
- []byte{0x24, 0x66, 0xDD, 0x87, 0x8B, 0x96, 0x3C, 0x9D}},
-
- {
- []byte{0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF},
- []byte{0x11, 0x11, 0x11, 0x11, 0x11, 0x11, 0x11, 0x11},
- []byte{0x61, 0xF9, 0xC3, 0x80, 0x22, 0x81, 0xB0, 0x96}},
- {
- []byte{0x11, 0x11, 0x11, 0x11, 0x11, 0x11, 0x11, 0x11},
- []byte{0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF},
- []byte{0x7D, 0x0C, 0xC6, 0x30, 0xAF, 0xDA, 0x1E, 0xC7}},
- {
- []byte{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00},
- []byte{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00},
- []byte{0x4E, 0xF9, 0x97, 0x45, 0x61, 0x98, 0xDD, 0x78}},
- {
- []byte{0xFE, 0xDC, 0xBA, 0x98, 0x76, 0x54, 0x32, 0x10},
- []byte{0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF},
- []byte{0x0A, 0xCE, 0xAB, 0x0F, 0xC6, 0xA0, 0xA2, 0x8D}},
- {
- []byte{0x7C, 0xA1, 0x10, 0x45, 0x4A, 0x1A, 0x6E, 0x57},
- []byte{0x01, 0xA1, 0xD6, 0xD0, 0x39, 0x77, 0x67, 0x42},
- []byte{0x59, 0xC6, 0x82, 0x45, 0xEB, 0x05, 0x28, 0x2B}},
- {
- []byte{0x01, 0x31, 0xD9, 0x61, 0x9D, 0xC1, 0x37, 0x6E},
- []byte{0x5C, 0xD5, 0x4C, 0xA8, 0x3D, 0xEF, 0x57, 0xDA},
- []byte{0xB1, 0xB8, 0xCC, 0x0B, 0x25, 0x0F, 0x09, 0xA0}},
- {
- []byte{0x07, 0xA1, 0x13, 0x3E, 0x4A, 0x0B, 0x26, 0x86},
- []byte{0x02, 0x48, 0xD4, 0x38, 0x06, 0xF6, 0x71, 0x72},
- []byte{0x17, 0x30, 0xE5, 0x77, 0x8B, 0xEA, 0x1D, 0xA4}},
- {
- []byte{0x38, 0x49, 0x67, 0x4C, 0x26, 0x02, 0x31, 0x9E},
- []byte{0x51, 0x45, 0x4B, 0x58, 0x2D, 0xDF, 0x44, 0x0A},
- []byte{0xA2, 0x5E, 0x78, 0x56, 0xCF, 0x26, 0x51, 0xEB}},
- {
- []byte{0x04, 0xB9, 0x15, 0xBA, 0x43, 0xFE, 0xB5, 0xB6},
- []byte{0x42, 0xFD, 0x44, 0x30, 0x59, 0x57, 0x7F, 0xA2},
- []byte{0x35, 0x38, 0x82, 0xB1, 0x09, 0xCE, 0x8F, 0x1A}},
- {
- []byte{0x01, 0x13, 0xB9, 0x70, 0xFD, 0x34, 0xF2, 0xCE},
- []byte{0x05, 0x9B, 0x5E, 0x08, 0x51, 0xCF, 0x14, 0x3A},
- []byte{0x48, 0xF4, 0xD0, 0x88, 0x4C, 0x37, 0x99, 0x18}},
- {
- []byte{0x01, 0x70, 0xF1, 0x75, 0x46, 0x8F, 0xB5, 0xE6},
- []byte{0x07, 0x56, 0xD8, 0xE0, 0x77, 0x47, 0x61, 0xD2},
- []byte{0x43, 0x21, 0x93, 0xB7, 0x89, 0x51, 0xFC, 0x98}},
- {
- []byte{0x43, 0x29, 0x7F, 0xAD, 0x38, 0xE3, 0x73, 0xFE},
- []byte{0x76, 0x25, 0x14, 0xB8, 0x29, 0xBF, 0x48, 0x6A},
- []byte{0x13, 0xF0, 0x41, 0x54, 0xD6, 0x9D, 0x1A, 0xE5}},
- {
- []byte{0x07, 0xA7, 0x13, 0x70, 0x45, 0xDA, 0x2A, 0x16},
- []byte{0x3B, 0xDD, 0x11, 0x90, 0x49, 0x37, 0x28, 0x02},
- []byte{0x2E, 0xED, 0xDA, 0x93, 0xFF, 0xD3, 0x9C, 0x79}},
- {
- []byte{0x04, 0x68, 0x91, 0x04, 0xC2, 0xFD, 0x3B, 0x2F},
- []byte{0x26, 0x95, 0x5F, 0x68, 0x35, 0xAF, 0x60, 0x9A},
- []byte{0xD8, 0x87, 0xE0, 0x39, 0x3C, 0x2D, 0xA6, 0xE3}},
- {
- []byte{0x37, 0xD0, 0x6B, 0xB5, 0x16, 0xCB, 0x75, 0x46},
- []byte{0x16, 0x4D, 0x5E, 0x40, 0x4F, 0x27, 0x52, 0x32},
- []byte{0x5F, 0x99, 0xD0, 0x4F, 0x5B, 0x16, 0x39, 0x69}},
- {
- []byte{0x1F, 0x08, 0x26, 0x0D, 0x1A, 0xC2, 0x46, 0x5E},
- []byte{0x6B, 0x05, 0x6E, 0x18, 0x75, 0x9F, 0x5C, 0xCA},
- []byte{0x4A, 0x05, 0x7A, 0x3B, 0x24, 0xD3, 0x97, 0x7B}},
- {
- []byte{0x58, 0x40, 0x23, 0x64, 0x1A, 0xBA, 0x61, 0x76},
- []byte{0x00, 0x4B, 0xD6, 0xEF, 0x09, 0x17, 0x60, 0x62},
- []byte{0x45, 0x20, 0x31, 0xC1, 0xE4, 0xFA, 0xDA, 0x8E}},
- {
- []byte{0x02, 0x58, 0x16, 0x16, 0x46, 0x29, 0xB0, 0x07},
- []byte{0x48, 0x0D, 0x39, 0x00, 0x6E, 0xE7, 0x62, 0xF2},
- []byte{0x75, 0x55, 0xAE, 0x39, 0xF5, 0x9B, 0x87, 0xBD}},
- {
- []byte{0x49, 0x79, 0x3E, 0xBC, 0x79, 0xB3, 0x25, 0x8F},
- []byte{0x43, 0x75, 0x40, 0xC8, 0x69, 0x8F, 0x3C, 0xFA},
- []byte{0x53, 0xC5, 0x5F, 0x9C, 0xB4, 0x9F, 0xC0, 0x19}},
- {
- []byte{0x4F, 0xB0, 0x5E, 0x15, 0x15, 0xAB, 0x73, 0xA7},
- []byte{0x07, 0x2D, 0x43, 0xA0, 0x77, 0x07, 0x52, 0x92},
- []byte{0x7A, 0x8E, 0x7B, 0xFA, 0x93, 0x7E, 0x89, 0xA3}},
- {
- []byte{0x49, 0xE9, 0x5D, 0x6D, 0x4C, 0xA2, 0x29, 0xBF},
- []byte{0x02, 0xFE, 0x55, 0x77, 0x81, 0x17, 0xF1, 0x2A},
- []byte{0xCF, 0x9C, 0x5D, 0x7A, 0x49, 0x86, 0xAD, 0xB5}},
- {
- []byte{0x01, 0x83, 0x10, 0xDC, 0x40, 0x9B, 0x26, 0xD6},
- []byte{0x1D, 0x9D, 0x5C, 0x50, 0x18, 0xF7, 0x28, 0xC2},
- []byte{0xD1, 0xAB, 0xB2, 0x90, 0x65, 0x8B, 0xC7, 0x78}},
- {
- []byte{0x1C, 0x58, 0x7F, 0x1C, 0x13, 0x92, 0x4F, 0xEF},
- []byte{0x30, 0x55, 0x32, 0x28, 0x6D, 0x6F, 0x29, 0x5A},
- []byte{0x55, 0xCB, 0x37, 0x74, 0xD1, 0x3E, 0xF2, 0x01}},
- {
- []byte{0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01},
- []byte{0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF},
- []byte{0xFA, 0x34, 0xEC, 0x48, 0x47, 0xB2, 0x68, 0xB2}},
- {
- []byte{0x1F, 0x1F, 0x1F, 0x1F, 0x0E, 0x0E, 0x0E, 0x0E},
- []byte{0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF},
- []byte{0xA7, 0x90, 0x79, 0x51, 0x08, 0xEA, 0x3C, 0xAE}},
- {
- []byte{0xE0, 0xFE, 0xE0, 0xFE, 0xF1, 0xFE, 0xF1, 0xFE},
- []byte{0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF},
- []byte{0xC3, 0x9E, 0x07, 0x2D, 0x9F, 0xAC, 0x63, 0x1D}},
- {
- []byte{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00},
- []byte{0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
- []byte{0x01, 0x49, 0x33, 0xE0, 0xCD, 0xAF, 0xF6, 0xE4}},
- {
- []byte{0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
- []byte{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00},
- []byte{0xF2, 0x1E, 0x9A, 0x77, 0xB7, 0x1C, 0x49, 0xBC}},
- {
- []byte{0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF},
- []byte{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00},
- []byte{0x24, 0x59, 0x46, 0x88, 0x57, 0x54, 0x36, 0x9A}},
- {
- []byte{0xFE, 0xDC, 0xBA, 0x98, 0x76, 0x54, 0x32, 0x10},
- []byte{0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
- []byte{0x6B, 0x5C, 0x5A, 0x9C, 0x5D, 0x9E, 0x0A, 0x5A}},
-}
-
-func TestCipherEncrypt(t *testing.T) {
- for i, tt := range encryptTests {
- c, err := NewCipher(tt.key)
- if err != nil {
- t.Errorf("NewCipher(%d bytes) = %s", len(tt.key), err)
- continue
- }
- ct := make([]byte, len(tt.out))
- c.Encrypt(ct, tt.in)
- for j, v := range ct {
- if v != tt.out[j] {
- t.Errorf("Cipher.Encrypt, test vector #%d: cipher-text[%d] = %#x, expected %#x", i, j, v, tt.out[j])
- break
- }
- }
- }
-}
-
-func TestCipherDecrypt(t *testing.T) {
- for i, tt := range encryptTests {
- c, err := NewCipher(tt.key)
- if err != nil {
- t.Errorf("NewCipher(%d bytes) = %s", len(tt.key), err)
- continue
- }
- pt := make([]byte, len(tt.in))
- c.Decrypt(pt, tt.out)
- for j, v := range pt {
- if v != tt.in[j] {
- t.Errorf("Cipher.Decrypt, test vector #%d: plain-text[%d] = %#x, expected %#x", i, j, v, tt.in[j])
- break
- }
- }
- }
-}
-
-func TestSaltedCipherKeyLength(t *testing.T) {
- if _, err := NewSaltedCipher(nil, []byte{'a'}); err != KeySizeError(0) {
- t.Errorf("NewSaltedCipher with short key, gave error %#v, expected %#v", err, KeySizeError(0))
- }
-
- // A 57-byte key. One over the typical blowfish restriction.
- key := []byte("012345678901234567890123456789012345678901234567890123456")
- if _, err := NewSaltedCipher(key, []byte{'a'}); err != nil {
- t.Errorf("NewSaltedCipher with long key, gave error %#v", err)
- }
-}
-
-// Test vectors generated with Blowfish from OpenSSH.
-var saltedVectors = [][8]byte{
- {0x0c, 0x82, 0x3b, 0x7b, 0x8d, 0x01, 0x4b, 0x7e},
- {0xd1, 0xe1, 0x93, 0xf0, 0x70, 0xa6, 0xdb, 0x12},
- {0xfc, 0x5e, 0xba, 0xde, 0xcb, 0xf8, 0x59, 0xad},
- {0x8a, 0x0c, 0x76, 0xe7, 0xdd, 0x2c, 0xd3, 0xa8},
- {0x2c, 0xcb, 0x7b, 0xee, 0xac, 0x7b, 0x7f, 0xf8},
- {0xbb, 0xf6, 0x30, 0x6f, 0xe1, 0x5d, 0x62, 0xbf},
- {0x97, 0x1e, 0xc1, 0x3d, 0x3d, 0xe0, 0x11, 0xe9},
- {0x06, 0xd7, 0x4d, 0xb1, 0x80, 0xa3, 0xb1, 0x38},
- {0x67, 0xa1, 0xa9, 0x75, 0x0e, 0x5b, 0xc6, 0xb4},
- {0x51, 0x0f, 0x33, 0x0e, 0x4f, 0x67, 0xd2, 0x0c},
- {0xf1, 0x73, 0x7e, 0xd8, 0x44, 0xea, 0xdb, 0xe5},
- {0x14, 0x0e, 0x16, 0xce, 0x7f, 0x4a, 0x9c, 0x7b},
- {0x4b, 0xfe, 0x43, 0xfd, 0xbf, 0x36, 0x04, 0x47},
- {0xb1, 0xeb, 0x3e, 0x15, 0x36, 0xa7, 0xbb, 0xe2},
- {0x6d, 0x0b, 0x41, 0xdd, 0x00, 0x98, 0x0b, 0x19},
- {0xd3, 0xce, 0x45, 0xce, 0x1d, 0x56, 0xb7, 0xfc},
- {0xd9, 0xf0, 0xfd, 0xda, 0xc0, 0x23, 0xb7, 0x93},
- {0x4c, 0x6f, 0xa1, 0xe4, 0x0c, 0xa8, 0xca, 0x57},
- {0xe6, 0x2f, 0x28, 0xa7, 0x0c, 0x94, 0x0d, 0x08},
- {0x8f, 0xe3, 0xf0, 0xb6, 0x29, 0xe3, 0x44, 0x03},
- {0xff, 0x98, 0xdd, 0x04, 0x45, 0xb4, 0x6d, 0x1f},
- {0x9e, 0x45, 0x4d, 0x18, 0x40, 0x53, 0xdb, 0xef},
- {0xb7, 0x3b, 0xef, 0x29, 0xbe, 0xa8, 0x13, 0x71},
- {0x02, 0x54, 0x55, 0x41, 0x8e, 0x04, 0xfc, 0xad},
- {0x6a, 0x0a, 0xee, 0x7c, 0x10, 0xd9, 0x19, 0xfe},
- {0x0a, 0x22, 0xd9, 0x41, 0xcc, 0x23, 0x87, 0x13},
- {0x6e, 0xff, 0x1f, 0xff, 0x36, 0x17, 0x9c, 0xbe},
- {0x79, 0xad, 0xb7, 0x40, 0xf4, 0x9f, 0x51, 0xa6},
- {0x97, 0x81, 0x99, 0xa4, 0xde, 0x9e, 0x9f, 0xb6},
- {0x12, 0x19, 0x7a, 0x28, 0xd0, 0xdc, 0xcc, 0x92},
- {0x81, 0xda, 0x60, 0x1e, 0x0e, 0xdd, 0x65, 0x56},
- {0x7d, 0x76, 0x20, 0xb2, 0x73, 0xc9, 0x9e, 0xee},
-}
-
-func TestSaltedCipher(t *testing.T) {
- var key, salt [32]byte
- for i := range key {
- key[i] = byte(i)
- salt[i] = byte(i + 32)
- }
- for i, v := range saltedVectors {
- c, err := NewSaltedCipher(key[:], salt[:i])
- if err != nil {
- t.Fatal(err)
- }
- var buf [8]byte
- c.Encrypt(buf[:], buf[:])
- if v != buf {
- t.Errorf("%d: expected %x, got %x", i, v, buf)
- }
- }
-}
-
-func BenchmarkExpandKeyWithSalt(b *testing.B) {
- key := make([]byte, 32)
- salt := make([]byte, 16)
- c, _ := NewCipher(key)
- for i := 0; i < b.N; i++ {
- expandKeyWithSalt(key, salt, c)
- }
-}
-
-func BenchmarkExpandKey(b *testing.B) {
- key := make([]byte, 32)
- c, _ := NewCipher(key)
- for i := 0; i < b.N; i++ {
- ExpandKey(key, c)
- }
-}
diff --git a/vendor/golang.org/x/net/context/context.go b/vendor/golang.org/x/net/context/context.go
index e7ee376c..ef2f3e86 100644
--- a/vendor/golang.org/x/net/context/context.go
+++ b/vendor/golang.org/x/net/context/context.go
@@ -34,7 +34,7 @@
//
// See http://blog.golang.org/context for example code for a server that uses
// Contexts.
-package context // import "golang.org/x/net/context"
+package context
import (
"errors"
diff --git a/vendor/golang.org/x/net/context/context_test.go b/vendor/golang.org/x/net/context/context_test.go
deleted file mode 100644
index 05345fc5..00000000
--- a/vendor/golang.org/x/net/context/context_test.go
+++ /dev/null
@@ -1,575 +0,0 @@
-// Copyright 2014 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package context
-
-import (
- "fmt"
- "math/rand"
- "runtime"
- "strings"
- "sync"
- "testing"
- "time"
-)
-
-// otherContext is a Context that's not one of the types defined in context.go.
-// This lets us test code paths that differ based on the underlying type of the
-// Context.
-type otherContext struct {
- Context
-}
-
-func TestBackground(t *testing.T) {
- c := Background()
- if c == nil {
- t.Fatalf("Background returned nil")
- }
- select {
- case x := <-c.Done():
- t.Errorf("<-c.Done() == %v want nothing (it should block)", x)
- default:
- }
- if got, want := fmt.Sprint(c), "context.Background"; got != want {
- t.Errorf("Background().String() = %q want %q", got, want)
- }
-}
-
-func TestTODO(t *testing.T) {
- c := TODO()
- if c == nil {
- t.Fatalf("TODO returned nil")
- }
- select {
- case x := <-c.Done():
- t.Errorf("<-c.Done() == %v want nothing (it should block)", x)
- default:
- }
- if got, want := fmt.Sprint(c), "context.TODO"; got != want {
- t.Errorf("TODO().String() = %q want %q", got, want)
- }
-}
-
-func TestWithCancel(t *testing.T) {
- c1, cancel := WithCancel(Background())
-
- if got, want := fmt.Sprint(c1), "context.Background.WithCancel"; got != want {
- t.Errorf("c1.String() = %q want %q", got, want)
- }
-
- o := otherContext{c1}
- c2, _ := WithCancel(o)
- contexts := []Context{c1, o, c2}
-
- for i, c := range contexts {
- if d := c.Done(); d == nil {
- t.Errorf("c[%d].Done() == %v want non-nil", i, d)
- }
- if e := c.Err(); e != nil {
- t.Errorf("c[%d].Err() == %v want nil", i, e)
- }
-
- select {
- case x := <-c.Done():
- t.Errorf("<-c.Done() == %v want nothing (it should block)", x)
- default:
- }
- }
-
- cancel()
- time.Sleep(100 * time.Millisecond) // let cancelation propagate
-
- for i, c := range contexts {
- select {
- case <-c.Done():
- default:
- t.Errorf("<-c[%d].Done() blocked, but shouldn't have", i)
- }
- if e := c.Err(); e != Canceled {
- t.Errorf("c[%d].Err() == %v want %v", i, e, Canceled)
- }
- }
-}
-
-func TestParentFinishesChild(t *testing.T) {
- // Context tree:
- // parent -> cancelChild
- // parent -> valueChild -> timerChild
- parent, cancel := WithCancel(Background())
- cancelChild, stop := WithCancel(parent)
- defer stop()
- valueChild := WithValue(parent, "key", "value")
- timerChild, stop := WithTimeout(valueChild, 10000*time.Hour)
- defer stop()
-
- select {
- case x := <-parent.Done():
- t.Errorf("<-parent.Done() == %v want nothing (it should block)", x)
- case x := <-cancelChild.Done():
- t.Errorf("<-cancelChild.Done() == %v want nothing (it should block)", x)
- case x := <-timerChild.Done():
- t.Errorf("<-timerChild.Done() == %v want nothing (it should block)", x)
- case x := <-valueChild.Done():
- t.Errorf("<-valueChild.Done() == %v want nothing (it should block)", x)
- default:
- }
-
- // The parent's children should contain the two cancelable children.
- pc := parent.(*cancelCtx)
- cc := cancelChild.(*cancelCtx)
- tc := timerChild.(*timerCtx)
- pc.mu.Lock()
- if len(pc.children) != 2 || !pc.children[cc] || !pc.children[tc] {
- t.Errorf("bad linkage: pc.children = %v, want %v and %v",
- pc.children, cc, tc)
- }
- pc.mu.Unlock()
-
- if p, ok := parentCancelCtx(cc.Context); !ok || p != pc {
- t.Errorf("bad linkage: parentCancelCtx(cancelChild.Context) = %v, %v want %v, true", p, ok, pc)
- }
- if p, ok := parentCancelCtx(tc.Context); !ok || p != pc {
- t.Errorf("bad linkage: parentCancelCtx(timerChild.Context) = %v, %v want %v, true", p, ok, pc)
- }
-
- cancel()
-
- pc.mu.Lock()
- if len(pc.children) != 0 {
- t.Errorf("pc.cancel didn't clear pc.children = %v", pc.children)
- }
- pc.mu.Unlock()
-
- // parent and children should all be finished.
- check := func(ctx Context, name string) {
- select {
- case <-ctx.Done():
- default:
- t.Errorf("<-%s.Done() blocked, but shouldn't have", name)
- }
- if e := ctx.Err(); e != Canceled {
- t.Errorf("%s.Err() == %v want %v", name, e, Canceled)
- }
- }
- check(parent, "parent")
- check(cancelChild, "cancelChild")
- check(valueChild, "valueChild")
- check(timerChild, "timerChild")
-
- // WithCancel should return a canceled context on a canceled parent.
- precanceledChild := WithValue(parent, "key", "value")
- select {
- case <-precanceledChild.Done():
- default:
- t.Errorf("<-precanceledChild.Done() blocked, but shouldn't have")
- }
- if e := precanceledChild.Err(); e != Canceled {
- t.Errorf("precanceledChild.Err() == %v want %v", e, Canceled)
- }
-}
-
-func TestChildFinishesFirst(t *testing.T) {
- cancelable, stop := WithCancel(Background())
- defer stop()
- for _, parent := range []Context{Background(), cancelable} {
- child, cancel := WithCancel(parent)
-
- select {
- case x := <-parent.Done():
- t.Errorf("<-parent.Done() == %v want nothing (it should block)", x)
- case x := <-child.Done():
- t.Errorf("<-child.Done() == %v want nothing (it should block)", x)
- default:
- }
-
- cc := child.(*cancelCtx)
- pc, pcok := parent.(*cancelCtx) // pcok == false when parent == Background()
- if p, ok := parentCancelCtx(cc.Context); ok != pcok || (ok && pc != p) {
- t.Errorf("bad linkage: parentCancelCtx(cc.Context) = %v, %v want %v, %v", p, ok, pc, pcok)
- }
-
- if pcok {
- pc.mu.Lock()
- if len(pc.children) != 1 || !pc.children[cc] {
- t.Errorf("bad linkage: pc.children = %v, cc = %v", pc.children, cc)
- }
- pc.mu.Unlock()
- }
-
- cancel()
-
- if pcok {
- pc.mu.Lock()
- if len(pc.children) != 0 {
- t.Errorf("child's cancel didn't remove self from pc.children = %v", pc.children)
- }
- pc.mu.Unlock()
- }
-
- // child should be finished.
- select {
- case <-child.Done():
- default:
- t.Errorf("<-child.Done() blocked, but shouldn't have")
- }
- if e := child.Err(); e != Canceled {
- t.Errorf("child.Err() == %v want %v", e, Canceled)
- }
-
- // parent should not be finished.
- select {
- case x := <-parent.Done():
- t.Errorf("<-parent.Done() == %v want nothing (it should block)", x)
- default:
- }
- if e := parent.Err(); e != nil {
- t.Errorf("parent.Err() == %v want nil", e)
- }
- }
-}
-
-func testDeadline(c Context, wait time.Duration, t *testing.T) {
- select {
- case <-time.After(wait):
- t.Fatalf("context should have timed out")
- case <-c.Done():
- }
- if e := c.Err(); e != DeadlineExceeded {
- t.Errorf("c.Err() == %v want %v", e, DeadlineExceeded)
- }
-}
-
-func TestDeadline(t *testing.T) {
- c, _ := WithDeadline(Background(), time.Now().Add(100*time.Millisecond))
- if got, prefix := fmt.Sprint(c), "context.Background.WithDeadline("; !strings.HasPrefix(got, prefix) {
- t.Errorf("c.String() = %q want prefix %q", got, prefix)
- }
- testDeadline(c, 200*time.Millisecond, t)
-
- c, _ = WithDeadline(Background(), time.Now().Add(100*time.Millisecond))
- o := otherContext{c}
- testDeadline(o, 200*time.Millisecond, t)
-
- c, _ = WithDeadline(Background(), time.Now().Add(100*time.Millisecond))
- o = otherContext{c}
- c, _ = WithDeadline(o, time.Now().Add(300*time.Millisecond))
- testDeadline(c, 200*time.Millisecond, t)
-}
-
-func TestTimeout(t *testing.T) {
- c, _ := WithTimeout(Background(), 100*time.Millisecond)
- if got, prefix := fmt.Sprint(c), "context.Background.WithDeadline("; !strings.HasPrefix(got, prefix) {
- t.Errorf("c.String() = %q want prefix %q", got, prefix)
- }
- testDeadline(c, 200*time.Millisecond, t)
-
- c, _ = WithTimeout(Background(), 100*time.Millisecond)
- o := otherContext{c}
- testDeadline(o, 200*time.Millisecond, t)
-
- c, _ = WithTimeout(Background(), 100*time.Millisecond)
- o = otherContext{c}
- c, _ = WithTimeout(o, 300*time.Millisecond)
- testDeadline(c, 200*time.Millisecond, t)
-}
-
-func TestCanceledTimeout(t *testing.T) {
- c, _ := WithTimeout(Background(), 200*time.Millisecond)
- o := otherContext{c}
- c, cancel := WithTimeout(o, 400*time.Millisecond)
- cancel()
- time.Sleep(100 * time.Millisecond) // let cancelation propagate
- select {
- case <-c.Done():
- default:
- t.Errorf("<-c.Done() blocked, but shouldn't have")
- }
- if e := c.Err(); e != Canceled {
- t.Errorf("c.Err() == %v want %v", e, Canceled)
- }
-}
-
-type key1 int
-type key2 int
-
-var k1 = key1(1)
-var k2 = key2(1) // same int as k1, different type
-var k3 = key2(3) // same type as k2, different int
-
-func TestValues(t *testing.T) {
- check := func(c Context, nm, v1, v2, v3 string) {
- if v, ok := c.Value(k1).(string); ok == (len(v1) == 0) || v != v1 {
- t.Errorf(`%s.Value(k1).(string) = %q, %t want %q, %t`, nm, v, ok, v1, len(v1) != 0)
- }
- if v, ok := c.Value(k2).(string); ok == (len(v2) == 0) || v != v2 {
- t.Errorf(`%s.Value(k2).(string) = %q, %t want %q, %t`, nm, v, ok, v2, len(v2) != 0)
- }
- if v, ok := c.Value(k3).(string); ok == (len(v3) == 0) || v != v3 {
- t.Errorf(`%s.Value(k3).(string) = %q, %t want %q, %t`, nm, v, ok, v3, len(v3) != 0)
- }
- }
-
- c0 := Background()
- check(c0, "c0", "", "", "")
-
- c1 := WithValue(Background(), k1, "c1k1")
- check(c1, "c1", "c1k1", "", "")
-
- if got, want := fmt.Sprint(c1), `context.Background.WithValue(1, "c1k1")`; got != want {
- t.Errorf("c.String() = %q want %q", got, want)
- }
-
- c2 := WithValue(c1, k2, "c2k2")
- check(c2, "c2", "c1k1", "c2k2", "")
-
- c3 := WithValue(c2, k3, "c3k3")
- check(c3, "c2", "c1k1", "c2k2", "c3k3")
-
- c4 := WithValue(c3, k1, nil)
- check(c4, "c4", "", "c2k2", "c3k3")
-
- o0 := otherContext{Background()}
- check(o0, "o0", "", "", "")
-
- o1 := otherContext{WithValue(Background(), k1, "c1k1")}
- check(o1, "o1", "c1k1", "", "")
-
- o2 := WithValue(o1, k2, "o2k2")
- check(o2, "o2", "c1k1", "o2k2", "")
-
- o3 := otherContext{c4}
- check(o3, "o3", "", "c2k2", "c3k3")
-
- o4 := WithValue(o3, k3, nil)
- check(o4, "o4", "", "c2k2", "")
-}
-
-func TestAllocs(t *testing.T) {
- bg := Background()
- for _, test := range []struct {
- desc string
- f func()
- limit float64
- gccgoLimit float64
- }{
- {
- desc: "Background()",
- f: func() { Background() },
- limit: 0,
- gccgoLimit: 0,
- },
- {
- desc: fmt.Sprintf("WithValue(bg, %v, nil)", k1),
- f: func() {
- c := WithValue(bg, k1, nil)
- c.Value(k1)
- },
- limit: 3,
- gccgoLimit: 3,
- },
- {
- desc: "WithTimeout(bg, 15*time.Millisecond)",
- f: func() {
- c, _ := WithTimeout(bg, 15*time.Millisecond)
- <-c.Done()
- },
- limit: 8,
- gccgoLimit: 15,
- },
- {
- desc: "WithCancel(bg)",
- f: func() {
- c, cancel := WithCancel(bg)
- cancel()
- <-c.Done()
- },
- limit: 5,
- gccgoLimit: 8,
- },
- {
- desc: "WithTimeout(bg, 100*time.Millisecond)",
- f: func() {
- c, cancel := WithTimeout(bg, 100*time.Millisecond)
- cancel()
- <-c.Done()
- },
- limit: 8,
- gccgoLimit: 25,
- },
- } {
- limit := test.limit
- if runtime.Compiler == "gccgo" {
- // gccgo does not yet do escape analysis.
- // TOOD(iant): Remove this when gccgo does do escape analysis.
- limit = test.gccgoLimit
- }
- if n := testing.AllocsPerRun(100, test.f); n > limit {
- t.Errorf("%s allocs = %f want %d", test.desc, n, int(limit))
- }
- }
-}
-
-func TestSimultaneousCancels(t *testing.T) {
- root, cancel := WithCancel(Background())
- m := map[Context]CancelFunc{root: cancel}
- q := []Context{root}
- // Create a tree of contexts.
- for len(q) != 0 && len(m) < 100 {
- parent := q[0]
- q = q[1:]
- for i := 0; i < 4; i++ {
- ctx, cancel := WithCancel(parent)
- m[ctx] = cancel
- q = append(q, ctx)
- }
- }
- // Start all the cancels in a random order.
- var wg sync.WaitGroup
- wg.Add(len(m))
- for _, cancel := range m {
- go func(cancel CancelFunc) {
- cancel()
- wg.Done()
- }(cancel)
- }
- // Wait on all the contexts in a random order.
- for ctx := range m {
- select {
- case <-ctx.Done():
- case <-time.After(1 * time.Second):
- buf := make([]byte, 10<<10)
- n := runtime.Stack(buf, true)
- t.Fatalf("timed out waiting for <-ctx.Done(); stacks:\n%s", buf[:n])
- }
- }
- // Wait for all the cancel functions to return.
- done := make(chan struct{})
- go func() {
- wg.Wait()
- close(done)
- }()
- select {
- case <-done:
- case <-time.After(1 * time.Second):
- buf := make([]byte, 10<<10)
- n := runtime.Stack(buf, true)
- t.Fatalf("timed out waiting for cancel functions; stacks:\n%s", buf[:n])
- }
-}
-
-func TestInterlockedCancels(t *testing.T) {
- parent, cancelParent := WithCancel(Background())
- child, cancelChild := WithCancel(parent)
- go func() {
- parent.Done()
- cancelChild()
- }()
- cancelParent()
- select {
- case <-child.Done():
- case <-time.After(1 * time.Second):
- buf := make([]byte, 10<<10)
- n := runtime.Stack(buf, true)
- t.Fatalf("timed out waiting for child.Done(); stacks:\n%s", buf[:n])
- }
-}
-
-func TestLayersCancel(t *testing.T) {
- testLayers(t, time.Now().UnixNano(), false)
-}
-
-func TestLayersTimeout(t *testing.T) {
- testLayers(t, time.Now().UnixNano(), true)
-}
-
-func testLayers(t *testing.T, seed int64, testTimeout bool) {
- rand.Seed(seed)
- errorf := func(format string, a ...interface{}) {
- t.Errorf(fmt.Sprintf("seed=%d: %s", seed, format), a...)
- }
- const (
- timeout = 200 * time.Millisecond
- minLayers = 30
- )
- type value int
- var (
- vals []*value
- cancels []CancelFunc
- numTimers int
- ctx = Background()
- )
- for i := 0; i < minLayers || numTimers == 0 || len(cancels) == 0 || len(vals) == 0; i++ {
- switch rand.Intn(3) {
- case 0:
- v := new(value)
- ctx = WithValue(ctx, v, v)
- vals = append(vals, v)
- case 1:
- var cancel CancelFunc
- ctx, cancel = WithCancel(ctx)
- cancels = append(cancels, cancel)
- case 2:
- var cancel CancelFunc
- ctx, cancel = WithTimeout(ctx, timeout)
- cancels = append(cancels, cancel)
- numTimers++
- }
- }
- checkValues := func(when string) {
- for _, key := range vals {
- if val := ctx.Value(key).(*value); key != val {
- errorf("%s: ctx.Value(%p) = %p want %p", when, key, val, key)
- }
- }
- }
- select {
- case <-ctx.Done():
- errorf("ctx should not be canceled yet")
- default:
- }
- if s, prefix := fmt.Sprint(ctx), "context.Background."; !strings.HasPrefix(s, prefix) {
- t.Errorf("ctx.String() = %q want prefix %q", s, prefix)
- }
- t.Log(ctx)
- checkValues("before cancel")
- if testTimeout {
- select {
- case <-ctx.Done():
- case <-time.After(timeout + 100*time.Millisecond):
- errorf("ctx should have timed out")
- }
- checkValues("after timeout")
- } else {
- cancel := cancels[rand.Intn(len(cancels))]
- cancel()
- select {
- case <-ctx.Done():
- default:
- errorf("ctx should be canceled")
- }
- checkValues("after cancel")
- }
-}
-
-func TestCancelRemoves(t *testing.T) {
- checkChildren := func(when string, ctx Context, want int) {
- if got := len(ctx.(*cancelCtx).children); got != want {
- t.Errorf("%s: context has %d children, want %d", when, got, want)
- }
- }
-
- ctx, _ := WithCancel(Background())
- checkChildren("after creation", ctx, 0)
- _, cancel := WithCancel(ctx)
- checkChildren("with WithCancel child ", ctx, 1)
- cancel()
- checkChildren("after cancelling WithCancel child", ctx, 0)
-
- ctx, _ = WithCancel(Background())
- checkChildren("after creation", ctx, 0)
- _, cancel = WithTimeout(ctx, 60*time.Minute)
- checkChildren("with WithTimeout child ", ctx, 1)
- cancel()
- checkChildren("after cancelling WithTimeout child", ctx, 0)
-}
diff --git a/vendor/golang.org/x/net/context/ctxhttp/cancelreq.go b/vendor/golang.org/x/net/context/ctxhttp/cancelreq.go
deleted file mode 100644
index 48610e36..00000000
--- a/vendor/golang.org/x/net/context/ctxhttp/cancelreq.go
+++ /dev/null
@@ -1,18 +0,0 @@
-// Copyright 2015 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-// +build go1.5
-
-package ctxhttp
-
-import "net/http"
-
-func canceler(client *http.Client, req *http.Request) func() {
- ch := make(chan struct{})
- req.Cancel = ch
-
- return func() {
- close(ch)
- }
-}
diff --git a/vendor/golang.org/x/net/context/ctxhttp/cancelreq_go14.go b/vendor/golang.org/x/net/context/ctxhttp/cancelreq_go14.go
deleted file mode 100644
index 56bcbadb..00000000
--- a/vendor/golang.org/x/net/context/ctxhttp/cancelreq_go14.go
+++ /dev/null
@@ -1,23 +0,0 @@
-// Copyright 2015 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-// +build !go1.5
-
-package ctxhttp
-
-import "net/http"
-
-type requestCanceler interface {
- CancelRequest(*http.Request)
-}
-
-func canceler(client *http.Client, req *http.Request) func() {
- rc, ok := client.Transport.(requestCanceler)
- if !ok {
- return func() {}
- }
- return func() {
- rc.CancelRequest(req)
- }
-}
diff --git a/vendor/golang.org/x/net/context/ctxhttp/ctxhttp.go b/vendor/golang.org/x/net/context/ctxhttp/ctxhttp.go
deleted file mode 100644
index 504dd63e..00000000
--- a/vendor/golang.org/x/net/context/ctxhttp/ctxhttp.go
+++ /dev/null
@@ -1,79 +0,0 @@
-// Copyright 2015 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-// Package ctxhttp provides helper functions for performing context-aware HTTP requests.
-package ctxhttp // import "golang.org/x/net/context/ctxhttp"
-
-import (
- "io"
- "net/http"
- "net/url"
- "strings"
-
- "golang.org/x/net/context"
-)
-
-// Do sends an HTTP request with the provided http.Client and returns an HTTP response.
-// If the client is nil, http.DefaultClient is used.
-// If the context is canceled or times out, ctx.Err() will be returned.
-func Do(ctx context.Context, client *http.Client, req *http.Request) (*http.Response, error) {
- if client == nil {
- client = http.DefaultClient
- }
-
- // Request cancelation changed in Go 1.5, see cancelreq.go and cancelreq_go14.go.
- cancel := canceler(client, req)
-
- type responseAndError struct {
- resp *http.Response
- err error
- }
- result := make(chan responseAndError, 1)
-
- go func() {
- resp, err := client.Do(req)
- result <- responseAndError{resp, err}
- }()
-
- select {
- case <-ctx.Done():
- cancel()
- return nil, ctx.Err()
- case r := <-result:
- return r.resp, r.err
- }
-}
-
-// Get issues a GET request via the Do function.
-func Get(ctx context.Context, client *http.Client, url string) (*http.Response, error) {
- req, err := http.NewRequest("GET", url, nil)
- if err != nil {
- return nil, err
- }
- return Do(ctx, client, req)
-}
-
-// Head issues a HEAD request via the Do function.
-func Head(ctx context.Context, client *http.Client, url string) (*http.Response, error) {
- req, err := http.NewRequest("HEAD", url, nil)
- if err != nil {
- return nil, err
- }
- return Do(ctx, client, req)
-}
-
-// Post issues a POST request via the Do function.
-func Post(ctx context.Context, client *http.Client, url string, bodyType string, body io.Reader) (*http.Response, error) {
- req, err := http.NewRequest("POST", url, body)
- if err != nil {
- return nil, err
- }
- req.Header.Set("Content-Type", bodyType)
- return Do(ctx, client, req)
-}
-
-// PostForm issues a POST request via the Do function.
-func PostForm(ctx context.Context, client *http.Client, url string, data url.Values) (*http.Response, error) {
- return Post(ctx, client, url, "application/x-www-form-urlencoded", strings.NewReader(data.Encode()))
-}
diff --git a/vendor/golang.org/x/net/context/ctxhttp/ctxhttp_test.go b/vendor/golang.org/x/net/context/ctxhttp/ctxhttp_test.go
deleted file mode 100644
index 47b53d7f..00000000
--- a/vendor/golang.org/x/net/context/ctxhttp/ctxhttp_test.go
+++ /dev/null
@@ -1,72 +0,0 @@
-// Copyright 2015 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package ctxhttp
-
-import (
- "io/ioutil"
- "net/http"
- "net/http/httptest"
- "testing"
- "time"
-
- "golang.org/x/net/context"
-)
-
-const (
- requestDuration = 100 * time.Millisecond
- requestBody = "ok"
-)
-
-func TestNoTimeout(t *testing.T) {
- ctx := context.Background()
- resp, err := doRequest(ctx)
-
- if resp == nil || err != nil {
- t.Fatalf("error received from client: %v %v", err, resp)
- }
-}
-func TestCancel(t *testing.T) {
- ctx, cancel := context.WithCancel(context.Background())
- go func() {
- time.Sleep(requestDuration / 2)
- cancel()
- }()
-
- resp, err := doRequest(ctx)
-
- if resp != nil || err == nil {
- t.Fatalf("expected error, didn't get one. resp: %v", resp)
- }
- if err != ctx.Err() {
- t.Fatalf("expected error from context but got: %v", err)
- }
-}
-
-func TestCancelAfterRequest(t *testing.T) {
- ctx, cancel := context.WithCancel(context.Background())
-
- resp, err := doRequest(ctx)
-
- // Cancel before reading the body.
- // Request.Body should still be readable after the context is canceled.
- cancel()
-
- b, err := ioutil.ReadAll(resp.Body)
- if err != nil || string(b) != requestBody {
- t.Fatalf("could not read body: %q %v", b, err)
- }
-}
-
-func doRequest(ctx context.Context) (*http.Response, error) {
- var okHandler = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
- time.Sleep(requestDuration)
- w.Write([]byte(requestBody))
- })
-
- serv := httptest.NewServer(okHandler)
- defer serv.Close()
-
- return Get(ctx, nil, serv.URL)
-}
diff --git a/vendor/golang.org/x/net/context/withtimeout_test.go b/vendor/golang.org/x/net/context/withtimeout_test.go
deleted file mode 100644
index a6754dc3..00000000
--- a/vendor/golang.org/x/net/context/withtimeout_test.go
+++ /dev/null
@@ -1,26 +0,0 @@
-// Copyright 2014 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package context_test
-
-import (
- "fmt"
- "time"
-
- "golang.org/x/net/context"
-)
-
-func ExampleWithTimeout() {
- // Pass a context with a timeout to tell a blocking function that it
- // should abandon its work after the timeout elapses.
- ctx, _ := context.WithTimeout(context.Background(), 100*time.Millisecond)
- select {
- case <-time.After(200 * time.Millisecond):
- fmt.Println("overslept")
- case <-ctx.Done():
- fmt.Println(ctx.Err()) // prints "context deadline exceeded"
- }
- // Output:
- // context deadline exceeded
-}
diff --git a/vendor/golang.org/x/net/internal/iana/const.go b/vendor/golang.org/x/net/internal/iana/const.go
deleted file mode 100644
index 7fe88225..00000000
--- a/vendor/golang.org/x/net/internal/iana/const.go
+++ /dev/null
@@ -1,181 +0,0 @@
-// go generate gen.go
-// GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
-
-// Package iana provides protocol number resources managed by the Internet Assigned Numbers Authority (IANA).
-package iana // import "golang.org/x/net/internal/iana"
-
-// Differentiated Services Field Codepoints (DSCP), Updated: 2013-06-25
-const (
- DiffServCS0 = 0x0 // CS0
- DiffServCS1 = 0x20 // CS1
- DiffServCS2 = 0x40 // CS2
- DiffServCS3 = 0x60 // CS3
- DiffServCS4 = 0x80 // CS4
- DiffServCS5 = 0xa0 // CS5
- DiffServCS6 = 0xc0 // CS6
- DiffServCS7 = 0xe0 // CS7
- DiffServAF11 = 0x28 // AF11
- DiffServAF12 = 0x30 // AF12
- DiffServAF13 = 0x38 // AF13
- DiffServAF21 = 0x48 // AF21
- DiffServAF22 = 0x50 // AF22
- DiffServAF23 = 0x58 // AF23
- DiffServAF31 = 0x68 // AF31
- DiffServAF32 = 0x70 // AF32
- DiffServAF33 = 0x78 // AF33
- DiffServAF41 = 0x88 // AF41
- DiffServAF42 = 0x90 // AF42
- DiffServAF43 = 0x98 // AF43
- DiffServEFPHB = 0xb8 // EF PHB
- DiffServVOICEADMIT = 0xb0 // VOICE-ADMIT
-)
-
-// IPv4 TOS Byte and IPv6 Traffic Class Octet, Updated: 2001-09-06
-const (
- NotECNTransport = 0x0 // Not-ECT (Not ECN-Capable Transport)
- ECNTransport1 = 0x1 // ECT(1) (ECN-Capable Transport(1))
- ECNTransport0 = 0x2 // ECT(0) (ECN-Capable Transport(0))
- CongestionExperienced = 0x3 // CE (Congestion Experienced)
-)
-
-// Protocol Numbers, Updated: 2015-06-23
-const (
- ProtocolIP = 0 // IPv4 encapsulation, pseudo protocol number
- ProtocolHOPOPT = 0 // IPv6 Hop-by-Hop Option
- ProtocolICMP = 1 // Internet Control Message
- ProtocolIGMP = 2 // Internet Group Management
- ProtocolGGP = 3 // Gateway-to-Gateway
- ProtocolIPv4 = 4 // IPv4 encapsulation
- ProtocolST = 5 // Stream
- ProtocolTCP = 6 // Transmission Control
- ProtocolCBT = 7 // CBT
- ProtocolEGP = 8 // Exterior Gateway Protocol
- ProtocolIGP = 9 // any private interior gateway (used by Cisco for their IGRP)
- ProtocolBBNRCCMON = 10 // BBN RCC Monitoring
- ProtocolNVPII = 11 // Network Voice Protocol
- ProtocolPUP = 12 // PUP
- ProtocolARGUS = 13 // ARGUS
- ProtocolEMCON = 14 // EMCON
- ProtocolXNET = 15 // Cross Net Debugger
- ProtocolCHAOS = 16 // Chaos
- ProtocolUDP = 17 // User Datagram
- ProtocolMUX = 18 // Multiplexing
- ProtocolDCNMEAS = 19 // DCN Measurement Subsystems
- ProtocolHMP = 20 // Host Monitoring
- ProtocolPRM = 21 // Packet Radio Measurement
- ProtocolXNSIDP = 22 // XEROX NS IDP
- ProtocolTRUNK1 = 23 // Trunk-1
- ProtocolTRUNK2 = 24 // Trunk-2
- ProtocolLEAF1 = 25 // Leaf-1
- ProtocolLEAF2 = 26 // Leaf-2
- ProtocolRDP = 27 // Reliable Data Protocol
- ProtocolIRTP = 28 // Internet Reliable Transaction
- ProtocolISOTP4 = 29 // ISO Transport Protocol Class 4
- ProtocolNETBLT = 30 // Bulk Data Transfer Protocol
- ProtocolMFENSP = 31 // MFE Network Services Protocol
- ProtocolMERITINP = 32 // MERIT Internodal Protocol
- ProtocolDCCP = 33 // Datagram Congestion Control Protocol
- Protocol3PC = 34 // Third Party Connect Protocol
- ProtocolIDPR = 35 // Inter-Domain Policy Routing Protocol
- ProtocolXTP = 36 // XTP
- ProtocolDDP = 37 // Datagram Delivery Protocol
- ProtocolIDPRCMTP = 38 // IDPR Control Message Transport Proto
- ProtocolTPPP = 39 // TP++ Transport Protocol
- ProtocolIL = 40 // IL Transport Protocol
- ProtocolIPv6 = 41 // IPv6 encapsulation
- ProtocolSDRP = 42 // Source Demand Routing Protocol
- ProtocolIPv6Route = 43 // Routing Header for IPv6
- ProtocolIPv6Frag = 44 // Fragment Header for IPv6
- ProtocolIDRP = 45 // Inter-Domain Routing Protocol
- ProtocolRSVP = 46 // Reservation Protocol
- ProtocolGRE = 47 // Generic Routing Encapsulation
- ProtocolDSR = 48 // Dynamic Source Routing Protocol
- ProtocolBNA = 49 // BNA
- ProtocolESP = 50 // Encap Security Payload
- ProtocolAH = 51 // Authentication Header
- ProtocolINLSP = 52 // Integrated Net Layer Security TUBA
- ProtocolNARP = 54 // NBMA Address Resolution Protocol
- ProtocolMOBILE = 55 // IP Mobility
- ProtocolTLSP = 56 // Transport Layer Security Protocol using Kryptonet key management
- ProtocolSKIP = 57 // SKIP
- ProtocolIPv6ICMP = 58 // ICMP for IPv6
- ProtocolIPv6NoNxt = 59 // No Next Header for IPv6
- ProtocolIPv6Opts = 60 // Destination Options for IPv6
- ProtocolCFTP = 62 // CFTP
- ProtocolSATEXPAK = 64 // SATNET and Backroom EXPAK
- ProtocolKRYPTOLAN = 65 // Kryptolan
- ProtocolRVD = 66 // MIT Remote Virtual Disk Protocol
- ProtocolIPPC = 67 // Internet Pluribus Packet Core
- ProtocolSATMON = 69 // SATNET Monitoring
- ProtocolVISA = 70 // VISA Protocol
- ProtocolIPCV = 71 // Internet Packet Core Utility
- ProtocolCPNX = 72 // Computer Protocol Network Executive
- ProtocolCPHB = 73 // Computer Protocol Heart Beat
- ProtocolWSN = 74 // Wang Span Network
- ProtocolPVP = 75 // Packet Video Protocol
- ProtocolBRSATMON = 76 // Backroom SATNET Monitoring
- ProtocolSUNND = 77 // SUN ND PROTOCOL-Temporary
- ProtocolWBMON = 78 // WIDEBAND Monitoring
- ProtocolWBEXPAK = 79 // WIDEBAND EXPAK
- ProtocolISOIP = 80 // ISO Internet Protocol
- ProtocolVMTP = 81 // VMTP
- ProtocolSECUREVMTP = 82 // SECURE-VMTP
- ProtocolVINES = 83 // VINES
- ProtocolTTP = 84 // Transaction Transport Protocol
- ProtocolIPTM = 84 // Internet Protocol Traffic Manager
- ProtocolNSFNETIGP = 85 // NSFNET-IGP
- ProtocolDGP = 86 // Dissimilar Gateway Protocol
- ProtocolTCF = 87 // TCF
- ProtocolEIGRP = 88 // EIGRP
- ProtocolOSPFIGP = 89 // OSPFIGP
- ProtocolSpriteRPC = 90 // Sprite RPC Protocol
- ProtocolLARP = 91 // Locus Address Resolution Protocol
- ProtocolMTP = 92 // Multicast Transport Protocol
- ProtocolAX25 = 93 // AX.25 Frames
- ProtocolIPIP = 94 // IP-within-IP Encapsulation Protocol
- ProtocolSCCSP = 96 // Semaphore Communications Sec. Pro.
- ProtocolETHERIP = 97 // Ethernet-within-IP Encapsulation
- ProtocolENCAP = 98 // Encapsulation Header
- ProtocolGMTP = 100 // GMTP
- ProtocolIFMP = 101 // Ipsilon Flow Management Protocol
- ProtocolPNNI = 102 // PNNI over IP
- ProtocolPIM = 103 // Protocol Independent Multicast
- ProtocolARIS = 104 // ARIS
- ProtocolSCPS = 105 // SCPS
- ProtocolQNX = 106 // QNX
- ProtocolAN = 107 // Active Networks
- ProtocolIPComp = 108 // IP Payload Compression Protocol
- ProtocolSNP = 109 // Sitara Networks Protocol
- ProtocolCompaqPeer = 110 // Compaq Peer Protocol
- ProtocolIPXinIP = 111 // IPX in IP
- ProtocolVRRP = 112 // Virtual Router Redundancy Protocol
- ProtocolPGM = 113 // PGM Reliable Transport Protocol
- ProtocolL2TP = 115 // Layer Two Tunneling Protocol
- ProtocolDDX = 116 // D-II Data Exchange (DDX)
- ProtocolIATP = 117 // Interactive Agent Transfer Protocol
- ProtocolSTP = 118 // Schedule Transfer Protocol
- ProtocolSRP = 119 // SpectraLink Radio Protocol
- ProtocolUTI = 120 // UTI
- ProtocolSMP = 121 // Simple Message Protocol
- ProtocolPTP = 123 // Performance Transparency Protocol
- ProtocolISIS = 124 // ISIS over IPv4
- ProtocolFIRE = 125 // FIRE
- ProtocolCRTP = 126 // Combat Radio Transport Protocol
- ProtocolCRUDP = 127 // Combat Radio User Datagram
- ProtocolSSCOPMCE = 128 // SSCOPMCE
- ProtocolIPLT = 129 // IPLT
- ProtocolSPS = 130 // Secure Packet Shield
- ProtocolPIPE = 131 // Private IP Encapsulation within IP
- ProtocolSCTP = 132 // Stream Control Transmission Protocol
- ProtocolFC = 133 // Fibre Channel
- ProtocolRSVPE2EIGNORE = 134 // RSVP-E2E-IGNORE
- ProtocolMobilityHeader = 135 // Mobility Header
- ProtocolUDPLite = 136 // UDPLite
- ProtocolMPLSinIP = 137 // MPLS-in-IP
- ProtocolMANET = 138 // MANET Protocols
- ProtocolHIP = 139 // Host Identity Protocol
- ProtocolShim6 = 140 // Shim6 Protocol
- ProtocolWESP = 141 // Wrapped Encapsulating Security Payload
- ProtocolROHC = 142 // Robust Header Compression
- ProtocolReserved = 255 // Reserved
-)
diff --git a/vendor/golang.org/x/net/internal/iana/gen.go b/vendor/golang.org/x/net/internal/iana/gen.go
deleted file mode 100644
index 2d8c07ca..00000000
--- a/vendor/golang.org/x/net/internal/iana/gen.go
+++ /dev/null
@@ -1,293 +0,0 @@
-// Copyright 2013 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-// +build ignore
-
-//go:generate go run gen.go
-
-// This program generates internet protocol constants and tables by
-// reading IANA protocol registries.
-package main
-
-import (
- "bytes"
- "encoding/xml"
- "fmt"
- "go/format"
- "io"
- "io/ioutil"
- "net/http"
- "os"
- "strconv"
- "strings"
-)
-
-var registries = []struct {
- url string
- parse func(io.Writer, io.Reader) error
-}{
- {
- "http://www.iana.org/assignments/dscp-registry/dscp-registry.xml",
- parseDSCPRegistry,
- },
- {
- "http://www.iana.org/assignments/ipv4-tos-byte/ipv4-tos-byte.xml",
- parseTOSTCByte,
- },
- {
- "http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xml",
- parseProtocolNumbers,
- },
-}
-
-func main() {
- var bb bytes.Buffer
- fmt.Fprintf(&bb, "// go generate gen.go\n")
- fmt.Fprintf(&bb, "// GENERATED BY THE COMMAND ABOVE; DO NOT EDIT\n\n")
- fmt.Fprintf(&bb, "// Package iana provides protocol number resources managed by the Internet Assigned Numbers Authority (IANA).\n")
- fmt.Fprintf(&bb, `package iana // import "golang.org/x/net/internal/iana"`+"\n\n")
- for _, r := range registries {
- resp, err := http.Get(r.url)
- if err != nil {
- fmt.Fprintln(os.Stderr, err)
- os.Exit(1)
- }
- defer resp.Body.Close()
- if resp.StatusCode != http.StatusOK {
- fmt.Fprintf(os.Stderr, "got HTTP status code %v for %v\n", resp.StatusCode, r.url)
- os.Exit(1)
- }
- if err := r.parse(&bb, resp.Body); err != nil {
- fmt.Fprintln(os.Stderr, err)
- os.Exit(1)
- }
- fmt.Fprintf(&bb, "\n")
- }
- b, err := format.Source(bb.Bytes())
- if err != nil {
- fmt.Fprintln(os.Stderr, err)
- os.Exit(1)
- }
- if err := ioutil.WriteFile("const.go", b, 0644); err != nil {
- fmt.Fprintln(os.Stderr, err)
- os.Exit(1)
- }
-}
-
-func parseDSCPRegistry(w io.Writer, r io.Reader) error {
- dec := xml.NewDecoder(r)
- var dr dscpRegistry
- if err := dec.Decode(&dr); err != nil {
- return err
- }
- drs := dr.escape()
- fmt.Fprintf(w, "// %s, Updated: %s\n", dr.Title, dr.Updated)
- fmt.Fprintf(w, "const (\n")
- for _, dr := range drs {
- fmt.Fprintf(w, "DiffServ%s = %#x", dr.Name, dr.Value)
- fmt.Fprintf(w, "// %s\n", dr.OrigName)
- }
- fmt.Fprintf(w, ")\n")
- return nil
-}
-
-type dscpRegistry struct {
- XMLName xml.Name `xml:"registry"`
- Title string `xml:"title"`
- Updated string `xml:"updated"`
- Note string `xml:"note"`
- RegTitle string `xml:"registry>title"`
- PoolRecords []struct {
- Name string `xml:"name"`
- Space string `xml:"space"`
- } `xml:"registry>record"`
- Records []struct {
- Name string `xml:"name"`
- Space string `xml:"space"`
- } `xml:"registry>registry>record"`
-}
-
-type canonDSCPRecord struct {
- OrigName string
- Name string
- Value int
-}
-
-func (drr *dscpRegistry) escape() []canonDSCPRecord {
- drs := make([]canonDSCPRecord, len(drr.Records))
- sr := strings.NewReplacer(
- "+", "",
- "-", "",
- "/", "",
- ".", "",
- " ", "",
- )
- for i, dr := range drr.Records {
- s := strings.TrimSpace(dr.Name)
- drs[i].OrigName = s
- drs[i].Name = sr.Replace(s)
- n, err := strconv.ParseUint(dr.Space, 2, 8)
- if err != nil {
- continue
- }
- drs[i].Value = int(n) << 2
- }
- return drs
-}
-
-func parseTOSTCByte(w io.Writer, r io.Reader) error {
- dec := xml.NewDecoder(r)
- var ttb tosTCByte
- if err := dec.Decode(&ttb); err != nil {
- return err
- }
- trs := ttb.escape()
- fmt.Fprintf(w, "// %s, Updated: %s\n", ttb.Title, ttb.Updated)
- fmt.Fprintf(w, "const (\n")
- for _, tr := range trs {
- fmt.Fprintf(w, "%s = %#x", tr.Keyword, tr.Value)
- fmt.Fprintf(w, "// %s\n", tr.OrigKeyword)
- }
- fmt.Fprintf(w, ")\n")
- return nil
-}
-
-type tosTCByte struct {
- XMLName xml.Name `xml:"registry"`
- Title string `xml:"title"`
- Updated string `xml:"updated"`
- Note string `xml:"note"`
- RegTitle string `xml:"registry>title"`
- Records []struct {
- Binary string `xml:"binary"`
- Keyword string `xml:"keyword"`
- } `xml:"registry>record"`
-}
-
-type canonTOSTCByteRecord struct {
- OrigKeyword string
- Keyword string
- Value int
-}
-
-func (ttb *tosTCByte) escape() []canonTOSTCByteRecord {
- trs := make([]canonTOSTCByteRecord, len(ttb.Records))
- sr := strings.NewReplacer(
- "Capable", "",
- "(", "",
- ")", "",
- "+", "",
- "-", "",
- "/", "",
- ".", "",
- " ", "",
- )
- for i, tr := range ttb.Records {
- s := strings.TrimSpace(tr.Keyword)
- trs[i].OrigKeyword = s
- ss := strings.Split(s, " ")
- if len(ss) > 1 {
- trs[i].Keyword = strings.Join(ss[1:], " ")
- } else {
- trs[i].Keyword = ss[0]
- }
- trs[i].Keyword = sr.Replace(trs[i].Keyword)
- n, err := strconv.ParseUint(tr.Binary, 2, 8)
- if err != nil {
- continue
- }
- trs[i].Value = int(n)
- }
- return trs
-}
-
-func parseProtocolNumbers(w io.Writer, r io.Reader) error {
- dec := xml.NewDecoder(r)
- var pn protocolNumbers
- if err := dec.Decode(&pn); err != nil {
- return err
- }
- prs := pn.escape()
- prs = append([]canonProtocolRecord{{
- Name: "IP",
- Descr: "IPv4 encapsulation, pseudo protocol number",
- Value: 0,
- }}, prs...)
- fmt.Fprintf(w, "// %s, Updated: %s\n", pn.Title, pn.Updated)
- fmt.Fprintf(w, "const (\n")
- for _, pr := range prs {
- if pr.Name == "" {
- continue
- }
- fmt.Fprintf(w, "Protocol%s = %d", pr.Name, pr.Value)
- s := pr.Descr
- if s == "" {
- s = pr.OrigName
- }
- fmt.Fprintf(w, "// %s\n", s)
- }
- fmt.Fprintf(w, ")\n")
- return nil
-}
-
-type protocolNumbers struct {
- XMLName xml.Name `xml:"registry"`
- Title string `xml:"title"`
- Updated string `xml:"updated"`
- RegTitle string `xml:"registry>title"`
- Note string `xml:"registry>note"`
- Records []struct {
- Value string `xml:"value"`
- Name string `xml:"name"`
- Descr string `xml:"description"`
- } `xml:"registry>record"`
-}
-
-type canonProtocolRecord struct {
- OrigName string
- Name string
- Descr string
- Value int
-}
-
-func (pn *protocolNumbers) escape() []canonProtocolRecord {
- prs := make([]canonProtocolRecord, len(pn.Records))
- sr := strings.NewReplacer(
- "-in-", "in",
- "-within-", "within",
- "-over-", "over",
- "+", "P",
- "-", "",
- "/", "",
- ".", "",
- " ", "",
- )
- for i, pr := range pn.Records {
- if strings.Contains(pr.Name, "Deprecated") ||
- strings.Contains(pr.Name, "deprecated") {
- continue
- }
- prs[i].OrigName = pr.Name
- s := strings.TrimSpace(pr.Name)
- switch pr.Name {
- case "ISIS over IPv4":
- prs[i].Name = "ISIS"
- case "manet":
- prs[i].Name = "MANET"
- default:
- prs[i].Name = sr.Replace(s)
- }
- ss := strings.Split(pr.Descr, "\n")
- for i := range ss {
- ss[i] = strings.TrimSpace(ss[i])
- }
- if len(ss) > 1 {
- prs[i].Descr = strings.Join(ss, " ")
- } else {
- prs[i].Descr = ss[0]
- }
- prs[i].Value, _ = strconv.Atoi(pr.Value)
- }
- return prs
-}
diff --git a/vendor/golang.org/x/net/internal/nettest/error_posix.go b/vendor/golang.org/x/net/internal/nettest/error_posix.go
deleted file mode 100644
index 963ed996..00000000
--- a/vendor/golang.org/x/net/internal/nettest/error_posix.go
+++ /dev/null
@@ -1,31 +0,0 @@
-// Copyright 2014 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-// +build darwin dragonfly freebsd linux netbsd openbsd solaris windows
-
-package nettest
-
-import (
- "os"
- "syscall"
-)
-
-func protocolNotSupported(err error) bool {
- switch err := err.(type) {
- case syscall.Errno:
- switch err {
- case syscall.EPROTONOSUPPORT, syscall.ENOPROTOOPT:
- return true
- }
- case *os.SyscallError:
- switch err := err.Err.(type) {
- case syscall.Errno:
- switch err {
- case syscall.EPROTONOSUPPORT, syscall.ENOPROTOOPT:
- return true
- }
- }
- }
- return false
-}
diff --git a/vendor/golang.org/x/net/internal/nettest/error_stub.go b/vendor/golang.org/x/net/internal/nettest/error_stub.go
deleted file mode 100644
index 3c74d812..00000000
--- a/vendor/golang.org/x/net/internal/nettest/error_stub.go
+++ /dev/null
@@ -1,11 +0,0 @@
-// Copyright 2014 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-// +build nacl plan9
-
-package nettest
-
-func protocolNotSupported(err error) bool {
- return false
-}
diff --git a/vendor/golang.org/x/net/internal/nettest/interface.go b/vendor/golang.org/x/net/internal/nettest/interface.go
deleted file mode 100644
index 53ae13a9..00000000
--- a/vendor/golang.org/x/net/internal/nettest/interface.go
+++ /dev/null
@@ -1,94 +0,0 @@
-// Copyright 2012 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package nettest
-
-import "net"
-
-// IsMulticastCapable reports whether ifi is an IP multicast-capable
-// network interface. Network must be "ip", "ip4" or "ip6".
-func IsMulticastCapable(network string, ifi *net.Interface) (net.IP, bool) {
- switch network {
- case "ip", "ip4", "ip6":
- default:
- return nil, false
- }
- if ifi == nil || ifi.Flags&net.FlagUp == 0 || ifi.Flags&net.FlagMulticast == 0 {
- return nil, false
- }
- return hasRoutableIP(network, ifi)
-}
-
-// RoutedInterface returns a network interface that can route IP
-// traffic and satisfies flags. It returns nil when an appropriate
-// network interface is not found. Network must be "ip", "ip4" or
-// "ip6".
-func RoutedInterface(network string, flags net.Flags) *net.Interface {
- switch network {
- case "ip", "ip4", "ip6":
- default:
- return nil
- }
- ift, err := net.Interfaces()
- if err != nil {
- return nil
- }
- for _, ifi := range ift {
- if ifi.Flags&flags != flags {
- continue
- }
- if _, ok := hasRoutableIP(network, &ifi); !ok {
- continue
- }
- return &ifi
- }
- return nil
-}
-
-func hasRoutableIP(network string, ifi *net.Interface) (net.IP, bool) {
- ifat, err := ifi.Addrs()
- if err != nil {
- return nil, false
- }
- for _, ifa := range ifat {
- switch ifa := ifa.(type) {
- case *net.IPAddr:
- if ip := routableIP(network, ifa.IP); ip != nil {
- return ip, true
- }
- case *net.IPNet:
- if ip := routableIP(network, ifa.IP); ip != nil {
- return ip, true
- }
- }
- }
- return nil, false
-}
-
-func routableIP(network string, ip net.IP) net.IP {
- if !ip.IsLoopback() && !ip.IsLinkLocalUnicast() && !ip.IsGlobalUnicast() {
- return nil
- }
- switch network {
- case "ip4":
- if ip := ip.To4(); ip != nil {
- return ip
- }
- case "ip6":
- if ip.IsLoopback() { // addressing scope of the loopback address depends on each implementation
- return nil
- }
- if ip := ip.To16(); ip != nil && ip.To4() == nil {
- return ip
- }
- default:
- if ip := ip.To4(); ip != nil {
- return ip
- }
- if ip := ip.To16(); ip != nil {
- return ip
- }
- }
- return nil
-}
diff --git a/vendor/golang.org/x/net/internal/nettest/rlimit.go b/vendor/golang.org/x/net/internal/nettest/rlimit.go
deleted file mode 100644
index bb34aec0..00000000
--- a/vendor/golang.org/x/net/internal/nettest/rlimit.go
+++ /dev/null
@@ -1,11 +0,0 @@
-// Copyright 2015 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package nettest
-
-const defaultMaxOpenFiles = 256
-
-// MaxOpenFiles returns the maximum number of open files for the
-// caller's process.
-func MaxOpenFiles() int { return maxOpenFiles() }
diff --git a/vendor/golang.org/x/net/internal/nettest/rlimit_stub.go b/vendor/golang.org/x/net/internal/nettest/rlimit_stub.go
deleted file mode 100644
index 102bef93..00000000
--- a/vendor/golang.org/x/net/internal/nettest/rlimit_stub.go
+++ /dev/null
@@ -1,9 +0,0 @@
-// Copyright 2015 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-// +build nacl plan9
-
-package nettest
-
-func maxOpenFiles() int { return defaultMaxOpenFiles }
diff --git a/vendor/golang.org/x/net/internal/nettest/rlimit_unix.go b/vendor/golang.org/x/net/internal/nettest/rlimit_unix.go
deleted file mode 100644
index eb4312ce..00000000
--- a/vendor/golang.org/x/net/internal/nettest/rlimit_unix.go
+++ /dev/null
@@ -1,17 +0,0 @@
-// Copyright 2015 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-// +build darwin dragonfly freebsd linux netbsd openbsd solaris
-
-package nettest
-
-import "syscall"
-
-func maxOpenFiles() int {
- var rlim syscall.Rlimit
- if err := syscall.Getrlimit(syscall.RLIMIT_NOFILE, &rlim); err != nil {
- return defaultMaxOpenFiles
- }
- return int(rlim.Cur)
-}
diff --git a/vendor/golang.org/x/net/internal/nettest/rlimit_windows.go b/vendor/golang.org/x/net/internal/nettest/rlimit_windows.go
deleted file mode 100644
index de927b56..00000000
--- a/vendor/golang.org/x/net/internal/nettest/rlimit_windows.go
+++ /dev/null
@@ -1,7 +0,0 @@
-// Copyright 2015 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package nettest
-
-func maxOpenFiles() int { return 4 * defaultMaxOpenFiles /* actually it's 16581375 */ }
diff --git a/vendor/golang.org/x/net/internal/nettest/stack.go b/vendor/golang.org/x/net/internal/nettest/stack.go
deleted file mode 100644
index e07c015f..00000000
--- a/vendor/golang.org/x/net/internal/nettest/stack.go
+++ /dev/null
@@ -1,36 +0,0 @@
-// Copyright 2014 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-// Package nettest provides utilities for IP testing.
-package nettest // import "golang.org/x/net/internal/nettest"
-
-import "net"
-
-// SupportsIPv4 reports whether the platform supports IPv4 networking
-// functionality.
-func SupportsIPv4() bool {
- ln, err := net.Listen("tcp4", "127.0.0.1:0")
- if err != nil {
- return false
- }
- ln.Close()
- return true
-}
-
-// SupportsIPv6 reports whether the platform supports IPv6 networking
-// functionality.
-func SupportsIPv6() bool {
- ln, err := net.Listen("tcp6", "[::1]:0")
- if err != nil {
- return false
- }
- ln.Close()
- return true
-}
-
-// ProtocolNotSupported reports whether err is a protocol not
-// supported error.
-func ProtocolNotSupported(err error) bool {
- return protocolNotSupported(err)
-}
diff --git a/vendor/golang.org/x/net/internal/nettest/stack_stub.go b/vendor/golang.org/x/net/internal/nettest/stack_stub.go
deleted file mode 100644
index 1b5fde1a..00000000
--- a/vendor/golang.org/x/net/internal/nettest/stack_stub.go
+++ /dev/null
@@ -1,18 +0,0 @@
-// Copyright 2015 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-// +build nacl plan9
-
-package nettest
-
-import (
- "fmt"
- "runtime"
-)
-
-// SupportsRawIPSocket reports whether the platform supports raw IP
-// sockets.
-func SupportsRawIPSocket() (string, bool) {
- return fmt.Sprintf("not supported on %s", runtime.GOOS), false
-}
diff --git a/vendor/golang.org/x/net/internal/nettest/stack_unix.go b/vendor/golang.org/x/net/internal/nettest/stack_unix.go
deleted file mode 100644
index af89229f..00000000
--- a/vendor/golang.org/x/net/internal/nettest/stack_unix.go
+++ /dev/null
@@ -1,22 +0,0 @@
-// Copyright 2015 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-// +build darwin dragonfly freebsd linux netbsd openbsd solaris
-
-package nettest
-
-import (
- "fmt"
- "os"
- "runtime"
-)
-
-// SupportsRawIPSocket reports whether the platform supports raw IP
-// sockets.
-func SupportsRawIPSocket() (string, bool) {
- if os.Getuid() != 0 {
- return fmt.Sprintf("must be root on %s", runtime.GOOS), false
- }
- return "", true
-}
diff --git a/vendor/golang.org/x/net/internal/nettest/stack_windows.go b/vendor/golang.org/x/net/internal/nettest/stack_windows.go
deleted file mode 100644
index a21f4993..00000000
--- a/vendor/golang.org/x/net/internal/nettest/stack_windows.go
+++ /dev/null
@@ -1,32 +0,0 @@
-// Copyright 2015 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package nettest
-
-import (
- "fmt"
- "runtime"
- "syscall"
-)
-
-// SupportsRawIPSocket reports whether the platform supports raw IP
-// sockets.
-func SupportsRawIPSocket() (string, bool) {
- // From http://msdn.microsoft.com/en-us/library/windows/desktop/ms740548.aspx:
- // Note: To use a socket of type SOCK_RAW requires administrative privileges.
- // Users running Winsock applications that use raw sockets must be a member of
- // the Administrators group on the local computer, otherwise raw socket calls
- // will fail with an error code of WSAEACCES. On Windows Vista and later, access
- // for raw sockets is enforced at socket creation. In earlier versions of Windows,
- // access for raw sockets is enforced during other socket operations.
- s, err := syscall.Socket(syscall.AF_INET, syscall.SOCK_RAW, 0)
- if err == syscall.WSAEACCES {
- return fmt.Sprintf("no access to raw socket allowed on %s", runtime.GOOS), false
- }
- if err != nil {
- return err.Error(), false
- }
- syscall.Closesocket(s)
- return "", true
-}
diff --git a/vendor/golang.org/x/net/internal/timeseries/timeseries.go b/vendor/golang.org/x/net/internal/timeseries/timeseries.go
index 1119f344..3f90b730 100644
--- a/vendor/golang.org/x/net/internal/timeseries/timeseries.go
+++ b/vendor/golang.org/x/net/internal/timeseries/timeseries.go
@@ -3,7 +3,7 @@
// license that can be found in the LICENSE file.
// Package timeseries implements a time series structure for stats collection.
-package timeseries // import "golang.org/x/net/internal/timeseries"
+package timeseries
import (
"fmt"
diff --git a/vendor/golang.org/x/net/internal/timeseries/timeseries_test.go b/vendor/golang.org/x/net/internal/timeseries/timeseries_test.go
deleted file mode 100644
index 66325a91..00000000
--- a/vendor/golang.org/x/net/internal/timeseries/timeseries_test.go
+++ /dev/null
@@ -1,170 +0,0 @@
-// Copyright 2015 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package timeseries
-
-import (
- "math"
- "testing"
- "time"
-)
-
-func isNear(x *Float, y float64, tolerance float64) bool {
- return math.Abs(x.Value()-y) < tolerance
-}
-
-func isApproximate(x *Float, y float64) bool {
- return isNear(x, y, 1e-2)
-}
-
-func checkApproximate(t *testing.T, o Observable, y float64) {
- x := o.(*Float)
- if !isApproximate(x, y) {
- t.Errorf("Wanted %g, got %g", y, x.Value())
- }
-}
-
-func checkNear(t *testing.T, o Observable, y, tolerance float64) {
- x := o.(*Float)
- if !isNear(x, y, tolerance) {
- t.Errorf("Wanted %g +- %g, got %g", y, tolerance, x.Value())
- }
-}
-
-var baseTime = time.Date(2013, 1, 1, 0, 0, 0, 0, time.UTC)
-
-func tu(s int64) time.Time {
- return baseTime.Add(time.Duration(s) * time.Second)
-}
-
-func tu2(s int64, ns int64) time.Time {
- return baseTime.Add(time.Duration(s)*time.Second + time.Duration(ns)*time.Nanosecond)
-}
-
-func TestBasicTimeSeries(t *testing.T) {
- ts := NewTimeSeries(NewFloat)
- fo := new(Float)
- *fo = Float(10)
- ts.AddWithTime(fo, tu(1))
- ts.AddWithTime(fo, tu(1))
- ts.AddWithTime(fo, tu(1))
- ts.AddWithTime(fo, tu(1))
- checkApproximate(t, ts.Range(tu(0), tu(1)), 40)
- checkApproximate(t, ts.Total(), 40)
- ts.AddWithTime(fo, tu(3))
- ts.AddWithTime(fo, tu(3))
- ts.AddWithTime(fo, tu(3))
- checkApproximate(t, ts.Range(tu(0), tu(2)), 40)
- checkApproximate(t, ts.Range(tu(2), tu(4)), 30)
- checkApproximate(t, ts.Total(), 70)
- ts.AddWithTime(fo, tu(1))
- ts.AddWithTime(fo, tu(1))
- checkApproximate(t, ts.Range(tu(0), tu(2)), 60)
- checkApproximate(t, ts.Range(tu(2), tu(4)), 30)
- checkApproximate(t, ts.Total(), 90)
- *fo = Float(100)
- ts.AddWithTime(fo, tu(100))
- checkApproximate(t, ts.Range(tu(99), tu(100)), 100)
- checkApproximate(t, ts.Range(tu(0), tu(4)), 36)
- checkApproximate(t, ts.Total(), 190)
- *fo = Float(10)
- ts.AddWithTime(fo, tu(1))
- ts.AddWithTime(fo, tu(1))
- checkApproximate(t, ts.Range(tu(0), tu(4)), 44)
- checkApproximate(t, ts.Range(tu(37), tu2(100, 100e6)), 100)
- checkApproximate(t, ts.Range(tu(50), tu2(100, 100e6)), 100)
- checkApproximate(t, ts.Range(tu(99), tu2(100, 100e6)), 100)
- checkApproximate(t, ts.Total(), 210)
-
- for i, l := range ts.ComputeRange(tu(36), tu(100), 64) {
- if i == 63 {
- checkApproximate(t, l, 100)
- } else {
- checkApproximate(t, l, 0)
- }
- }
-
- checkApproximate(t, ts.Range(tu(0), tu(100)), 210)
- checkApproximate(t, ts.Range(tu(10), tu(100)), 100)
-
- for i, l := range ts.ComputeRange(tu(0), tu(100), 100) {
- if i < 10 {
- checkApproximate(t, l, 11)
- } else if i >= 90 {
- checkApproximate(t, l, 10)
- } else {
- checkApproximate(t, l, 0)
- }
- }
-}
-
-func TestFloat(t *testing.T) {
- f := Float(1)
- if g, w := f.String(), "1"; g != w {
- t.Errorf("Float(1).String = %q; want %q", g, w)
- }
- f2 := Float(2)
- var o Observable = &f2
- f.Add(o)
- if g, w := f.Value(), 3.0; g != w {
- t.Errorf("Float post-add = %v; want %v", g, w)
- }
- f.Multiply(2)
- if g, w := f.Value(), 6.0; g != w {
- t.Errorf("Float post-multiply = %v; want %v", g, w)
- }
- f.Clear()
- if g, w := f.Value(), 0.0; g != w {
- t.Errorf("Float post-clear = %v; want %v", g, w)
- }
- f.CopyFrom(&f2)
- if g, w := f.Value(), 2.0; g != w {
- t.Errorf("Float post-CopyFrom = %v; want %v", g, w)
- }
-}
-
-type mockClock struct {
- time time.Time
-}
-
-func (m *mockClock) Time() time.Time { return m.time }
-func (m *mockClock) Set(t time.Time) { m.time = t }
-
-const buckets = 6
-
-var testResolutions = []time.Duration{
- 10 * time.Second, // level holds one minute of observations
- 100 * time.Second, // level holds ten minutes of observations
- 10 * time.Minute, // level holds one hour of observations
-}
-
-// TestTimeSeries uses a small number of buckets to force a higher
-// error rate on approximations from the timeseries.
-type TestTimeSeries struct {
- timeSeries
-}
-
-func TestExpectedErrorRate(t *testing.T) {
- ts := new(TestTimeSeries)
- fake := new(mockClock)
- fake.Set(time.Now())
- ts.timeSeries.init(testResolutions, NewFloat, buckets, fake)
- for i := 1; i <= 61*61; i++ {
- fake.Set(fake.Time().Add(1 * time.Second))
- ob := Float(1)
- ts.AddWithTime(&ob, fake.Time())
-
- // The results should be accurate within one missing bucket (1/6) of the observations recorded.
- checkNear(t, ts.Latest(0, buckets), min(float64(i), 60), 10)
- checkNear(t, ts.Latest(1, buckets), min(float64(i), 600), 100)
- checkNear(t, ts.Latest(2, buckets), min(float64(i), 3600), 600)
- }
-}
-
-func min(a, b float64) float64 {
- if a < b {
- return a
- }
- return b
-}
diff --git a/vendor/golang.org/x/net/trace/histogram_test.go b/vendor/golang.org/x/net/trace/histogram_test.go
deleted file mode 100644
index d384b933..00000000
--- a/vendor/golang.org/x/net/trace/histogram_test.go
+++ /dev/null
@@ -1,325 +0,0 @@
-// Copyright 2015 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package trace
-
-import (
- "math"
- "testing"
-)
-
-type sumTest struct {
- value int64
- sum int64
- sumOfSquares float64
- total int64
-}
-
-var sumTests = []sumTest{
- {100, 100, 10000, 1},
- {50, 150, 12500, 2},
- {50, 200, 15000, 3},
- {50, 250, 17500, 4},
-}
-
-type bucketingTest struct {
- in int64
- log int
- bucket int
-}
-
-var bucketingTests = []bucketingTest{
- {0, 0, 0},
- {1, 1, 0},
- {2, 2, 1},
- {3, 2, 1},
- {4, 3, 2},
- {1000, 10, 9},
- {1023, 10, 9},
- {1024, 11, 10},
- {1000000, 20, 19},
-}
-
-type multiplyTest struct {
- in int64
- ratio float64
- expectedSum int64
- expectedTotal int64
- expectedSumOfSquares float64
-}
-
-var multiplyTests = []multiplyTest{
- {15, 2.5, 37, 2, 562.5},
- {128, 4.6, 758, 13, 77953.9},
-}
-
-type percentileTest struct {
- fraction float64
- expected int64
-}
-
-var percentileTests = []percentileTest{
- {0.25, 48},
- {0.5, 96},
- {0.6, 109},
- {0.75, 128},
- {0.90, 205},
- {0.95, 230},
- {0.99, 256},
-}
-
-func TestSum(t *testing.T) {
- var h histogram
-
- for _, test := range sumTests {
- h.addMeasurement(test.value)
- sum := h.sum
- if sum != test.sum {
- t.Errorf("h.Sum = %v WANT: %v", sum, test.sum)
- }
-
- sumOfSquares := h.sumOfSquares
- if sumOfSquares != test.sumOfSquares {
- t.Errorf("h.SumOfSquares = %v WANT: %v", sumOfSquares, test.sumOfSquares)
- }
-
- total := h.total()
- if total != test.total {
- t.Errorf("h.Total = %v WANT: %v", total, test.total)
- }
- }
-}
-
-func TestMultiply(t *testing.T) {
- var h histogram
- for i, test := range multiplyTests {
- h.addMeasurement(test.in)
- h.Multiply(test.ratio)
- if h.sum != test.expectedSum {
- t.Errorf("#%v: h.sum = %v WANT: %v", i, h.sum, test.expectedSum)
- }
- if h.total() != test.expectedTotal {
- t.Errorf("#%v: h.total = %v WANT: %v", i, h.total(), test.expectedTotal)
- }
- if h.sumOfSquares != test.expectedSumOfSquares {
- t.Errorf("#%v: h.SumOfSquares = %v WANT: %v", i, test.expectedSumOfSquares, h.sumOfSquares)
- }
- }
-}
-
-func TestBucketingFunctions(t *testing.T) {
- for _, test := range bucketingTests {
- log := log2(test.in)
- if log != test.log {
- t.Errorf("log2 = %v WANT: %v", log, test.log)
- }
-
- bucket := getBucket(test.in)
- if bucket != test.bucket {
- t.Errorf("getBucket = %v WANT: %v", bucket, test.bucket)
- }
- }
-}
-
-func TestAverage(t *testing.T) {
- a := new(histogram)
- average := a.average()
- if average != 0 {
- t.Errorf("Average of empty histogram was %v WANT: 0", average)
- }
-
- a.addMeasurement(1)
- a.addMeasurement(1)
- a.addMeasurement(3)
- const expected = float64(5) / float64(3)
- average = a.average()
-
- if !isApproximate(average, expected) {
- t.Errorf("Average = %g WANT: %v", average, expected)
- }
-}
-
-func TestStandardDeviation(t *testing.T) {
- a := new(histogram)
- add(a, 10, 1<<4)
- add(a, 10, 1<<5)
- add(a, 10, 1<<6)
- stdDev := a.standardDeviation()
- const expected = 19.95
-
- if !isApproximate(stdDev, expected) {
- t.Errorf("StandardDeviation = %v WANT: %v", stdDev, expected)
- }
-
- // No values
- a = new(histogram)
- stdDev = a.standardDeviation()
-
- if !isApproximate(stdDev, 0) {
- t.Errorf("StandardDeviation = %v WANT: 0", stdDev)
- }
-
- add(a, 1, 1<<4)
- if !isApproximate(stdDev, 0) {
- t.Errorf("StandardDeviation = %v WANT: 0", stdDev)
- }
-
- add(a, 10, 1<<4)
- if !isApproximate(stdDev, 0) {
- t.Errorf("StandardDeviation = %v WANT: 0", stdDev)
- }
-}
-
-func TestPercentileBoundary(t *testing.T) {
- a := new(histogram)
- add(a, 5, 1<<4)
- add(a, 10, 1<<6)
- add(a, 5, 1<<7)
-
- for _, test := range percentileTests {
- percentile := a.percentileBoundary(test.fraction)
- if percentile != test.expected {
- t.Errorf("h.PercentileBoundary (fraction=%v) = %v WANT: %v", test.fraction, percentile, test.expected)
- }
- }
-}
-
-func TestCopyFrom(t *testing.T) {
- a := histogram{5, 25, []int64{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}, 4, -1}
- b := histogram{6, 36, []int64{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}, 5, -1}
-
- a.CopyFrom(&b)
-
- if a.String() != b.String() {
- t.Errorf("a.String = %s WANT: %s", a.String(), b.String())
- }
-}
-
-func TestClear(t *testing.T) {
- a := histogram{5, 25, []int64{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}, 4, -1}
-
- a.Clear()
-
- expected := "0, 0.000000, 0, 0, []"
- if a.String() != expected {
- t.Errorf("a.String = %s WANT %s", a.String(), expected)
- }
-}
-
-func TestNew(t *testing.T) {
- a := histogram{5, 25, []int64{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}, 4, -1}
- b := a.New()
-
- expected := "0, 0.000000, 0, 0, []"
- if b.(*histogram).String() != expected {
- t.Errorf("b.(*histogram).String = %s WANT: %s", b.(*histogram).String(), expected)
- }
-}
-
-func TestAdd(t *testing.T) {
- // The tests here depend on the associativity of addMeasurement and Add.
- // Add empty observation
- a := histogram{5, 25, []int64{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}, 4, -1}
- b := a.New()
-
- expected := a.String()
- a.Add(b)
- if a.String() != expected {
- t.Errorf("a.String = %s WANT: %s", a.String(), expected)
- }
-
- // Add same bucketed value, no new buckets
- c := new(histogram)
- d := new(histogram)
- e := new(histogram)
- c.addMeasurement(12)
- d.addMeasurement(11)
- e.addMeasurement(12)
- e.addMeasurement(11)
- c.Add(d)
- if c.String() != e.String() {
- t.Errorf("c.String = %s WANT: %s", c.String(), e.String())
- }
-
- // Add bucketed values
- f := new(histogram)
- g := new(histogram)
- h := new(histogram)
- f.addMeasurement(4)
- f.addMeasurement(12)
- f.addMeasurement(100)
- g.addMeasurement(18)
- g.addMeasurement(36)
- g.addMeasurement(255)
- h.addMeasurement(4)
- h.addMeasurement(12)
- h.addMeasurement(100)
- h.addMeasurement(18)
- h.addMeasurement(36)
- h.addMeasurement(255)
- f.Add(g)
- if f.String() != h.String() {
- t.Errorf("f.String = %q WANT: %q", f.String(), h.String())
- }
-
- // add buckets to no buckets
- i := new(histogram)
- j := new(histogram)
- k := new(histogram)
- j.addMeasurement(18)
- j.addMeasurement(36)
- j.addMeasurement(255)
- k.addMeasurement(18)
- k.addMeasurement(36)
- k.addMeasurement(255)
- i.Add(j)
- if i.String() != k.String() {
- t.Errorf("i.String = %q WANT: %q", i.String(), k.String())
- }
-
- // add buckets to single value (no overlap)
- l := new(histogram)
- m := new(histogram)
- n := new(histogram)
- l.addMeasurement(0)
- m.addMeasurement(18)
- m.addMeasurement(36)
- m.addMeasurement(255)
- n.addMeasurement(0)
- n.addMeasurement(18)
- n.addMeasurement(36)
- n.addMeasurement(255)
- l.Add(m)
- if l.String() != n.String() {
- t.Errorf("l.String = %q WANT: %q", l.String(), n.String())
- }
-
- // mixed order
- o := new(histogram)
- p := new(histogram)
- o.addMeasurement(0)
- o.addMeasurement(2)
- o.addMeasurement(0)
- p.addMeasurement(0)
- p.addMeasurement(0)
- p.addMeasurement(2)
- if o.String() != p.String() {
- t.Errorf("o.String = %q WANT: %q", o.String(), p.String())
- }
-}
-
-func add(h *histogram, times int, val int64) {
- for i := 0; i < times; i++ {
- h.addMeasurement(val)
- }
-}
-
-func isApproximate(x, y float64) bool {
- return math.Abs(x-y) < 1e-2
-}
diff --git a/vendor/golang.org/x/net/trace/trace.go b/vendor/golang.org/x/net/trace/trace.go
index c44cb7ec..c87290b7 100644
--- a/vendor/golang.org/x/net/trace/trace.go
+++ b/vendor/golang.org/x/net/trace/trace.go
@@ -60,7 +60,7 @@ The /debug/events HTTP endpoint organizes the event logs by family and
by time since the last error. The expanded view displays recent log
entries and the log's call stack.
*/
-package trace // import "golang.org/x/net/trace"
+package trace
import (
"bytes"
diff --git a/vendor/golang.org/x/net/trace/trace_test.go b/vendor/golang.org/x/net/trace/trace_test.go
deleted file mode 100644
index c2f5fcba..00000000
--- a/vendor/golang.org/x/net/trace/trace_test.go
+++ /dev/null
@@ -1,46 +0,0 @@
-// Copyright 2015 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package trace
-
-import (
- "reflect"
- "testing"
-)
-
-type s struct{}
-
-func (s) String() string { return "lazy string" }
-
-// TestReset checks whether all the fields are zeroed after reset.
-func TestReset(t *testing.T) {
- tr := New("foo", "bar")
- tr.LazyLog(s{}, false)
- tr.LazyPrintf("%d", 1)
- tr.SetRecycler(func(_ interface{}) {})
- tr.SetTraceInfo(3, 4)
- tr.SetMaxEvents(100)
- tr.SetError()
- tr.Finish()
-
- tr.(*trace).reset()
-
- if !reflect.DeepEqual(tr, new(trace)) {
- t.Errorf("reset didn't clear all fields: %+v", tr)
- }
-}
-
-// TestResetLog checks whether all the fields are zeroed after reset.
-func TestResetLog(t *testing.T) {
- el := NewEventLog("foo", "bar")
- el.Printf("message")
- el.Errorf("error")
- el.Finish()
-
- el.(*eventLog).reset()
-
- if !reflect.DeepEqual(el, new(eventLog)) {
- t.Errorf("reset didn't clear all fields: %+v", el)
- }
-}
diff --git a/vendor/golang.org/x/oauth2/clientcredentials/clientcredentials.go b/vendor/golang.org/x/oauth2/clientcredentials/clientcredentials.go
deleted file mode 100644
index baebced2..00000000
--- a/vendor/golang.org/x/oauth2/clientcredentials/clientcredentials.go
+++ /dev/null
@@ -1,112 +0,0 @@
-// Copyright 2014 The oauth2 Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-// Package clientcredentials implements the OAuth2.0 "client credentials" token flow,
-// also known as the "two-legged OAuth 2.0".
-//
-// This should be used when the client is acting on its own behalf or when the client
-// is the resource owner. It may also be used when requesting access to protected
-// resources based on an authorization previously arranged with the authorization
-// server.
-//
-// See http://tools.ietf.org/html/draft-ietf-oauth-v2-31#section-4.4
-package clientcredentials // import "golang.org/x/oauth2/clientcredentials"
-
-import (
- "net/http"
- "net/url"
- "strings"
-
- "golang.org/x/net/context"
- "golang.org/x/oauth2"
- "golang.org/x/oauth2/internal"
-)
-
-// tokenFromInternal maps an *internal.Token struct into
-// an *oauth2.Token struct.
-func tokenFromInternal(t *internal.Token) *oauth2.Token {
- if t == nil {
- return nil
- }
- tk := &oauth2.Token{
- AccessToken: t.AccessToken,
- TokenType: t.TokenType,
- RefreshToken: t.RefreshToken,
- Expiry: t.Expiry,
- }
- return tk.WithExtra(t.Raw)
-}
-
-// retrieveToken takes a *Config and uses that to retrieve an *internal.Token.
-// This token is then mapped from *internal.Token into an *oauth2.Token which is
-// returned along with an error.
-func retrieveToken(ctx context.Context, c *Config, v url.Values) (*oauth2.Token, error) {
- tk, err := internal.RetrieveToken(ctx, c.ClientID, c.ClientSecret, c.TokenURL, v)
- if err != nil {
- return nil, err
- }
- return tokenFromInternal(tk), nil
-}
-
-// Client Credentials Config describes a 2-legged OAuth2 flow, with both the
-// client application information and the server's endpoint URLs.
-type Config struct {
- // ClientID is the application's ID.
- ClientID string
-
- // ClientSecret is the application's secret.
- ClientSecret string
-
- // TokenURL is the resource server's token endpoint
- // URL. This is a constant specific to each server.
- TokenURL string
-
- // Scope specifies optional requested permissions.
- Scopes []string
-}
-
-// Token uses client credentials to retreive a token.
-// The HTTP client to use is derived from the context.
-// If nil, http.DefaultClient is used.
-func (c *Config) Token(ctx context.Context) (*oauth2.Token, error) {
- return retrieveToken(ctx, c, url.Values{
- "grant_type": {"client_credentials"},
- "scope": internal.CondVal(strings.Join(c.Scopes, " ")),
- })
-}
-
-// Client returns an HTTP client using the provided token.
-// The token will auto-refresh as necessary. The underlying
-// HTTP transport will be obtained using the provided context.
-// The returned client and its Transport should not be modified.
-func (c *Config) Client(ctx context.Context) *http.Client {
- return oauth2.NewClient(ctx, c.TokenSource(ctx))
-}
-
-// TokenSource returns a TokenSource that returns t until t expires,
-// automatically refreshing it as necessary using the provided context and the
-// client ID and client secret.
-//
-// Most users will use Config.Client instead.
-func (c *Config) TokenSource(ctx context.Context) oauth2.TokenSource {
- source := &tokenSource{
- ctx: ctx,
- conf: c,
- }
- return oauth2.ReuseTokenSource(nil, source)
-}
-
-type tokenSource struct {
- ctx context.Context
- conf *Config
-}
-
-// Token refreshes the token by using a new client credentials request.
-// tokens received this way do not include a refresh token
-func (c *tokenSource) Token() (*oauth2.Token, error) {
- return retrieveToken(c.ctx, c.conf, url.Values{
- "grant_type": {"client_credentials"},
- "scope": internal.CondVal(strings.Join(c.conf.Scopes, " ")),
- })
-}
diff --git a/vendor/golang.org/x/oauth2/clientcredentials/clientcredentials_test.go b/vendor/golang.org/x/oauth2/clientcredentials/clientcredentials_test.go
deleted file mode 100644
index ab319e08..00000000
--- a/vendor/golang.org/x/oauth2/clientcredentials/clientcredentials_test.go
+++ /dev/null
@@ -1,96 +0,0 @@
-// Copyright 2014 The oauth2 Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package clientcredentials
-
-import (
- "io/ioutil"
- "net/http"
- "net/http/httptest"
- "testing"
-
- "golang.org/x/oauth2"
-)
-
-func newConf(url string) *Config {
- return &Config{
- ClientID: "CLIENT_ID",
- ClientSecret: "CLIENT_SECRET",
- Scopes: []string{"scope1", "scope2"},
- TokenURL: url + "/token",
- }
-}
-
-type mockTransport struct {
- rt func(req *http.Request) (resp *http.Response, err error)
-}
-
-func (t *mockTransport) RoundTrip(req *http.Request) (resp *http.Response, err error) {
- return t.rt(req)
-}
-
-func TestTokenRequest(t *testing.T) {
- ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
- if r.URL.String() != "/token" {
- t.Errorf("authenticate client request URL = %q; want %q", r.URL, "/token")
- }
- headerAuth := r.Header.Get("Authorization")
- if headerAuth != "Basic Q0xJRU5UX0lEOkNMSUVOVF9TRUNSRVQ=" {
- t.Errorf("Unexpected authorization header, %v is found.", headerAuth)
- }
- if got, want := r.Header.Get("Content-Type"), "application/x-www-form-urlencoded"; got != want {
- t.Errorf("Content-Type header = %q; want %q", got, want)
- }
- body, err := ioutil.ReadAll(r.Body)
- if err != nil {
- r.Body.Close()
- }
- if err != nil {
- t.Errorf("failed reading request body: %s.", err)
- }
- if string(body) != "client_id=CLIENT_ID&grant_type=client_credentials&scope=scope1+scope2" {
- t.Errorf("payload = %q; want %q", string(body), "client_id=CLIENT_ID&grant_type=client_credentials&scope=scope1+scope2")
- }
- w.Header().Set("Content-Type", "application/x-www-form-urlencoded")
- w.Write([]byte("access_token=90d64460d14870c08c81352a05dedd3465940a7c&token_type=bearer"))
- }))
- defer ts.Close()
- conf := newConf(ts.URL)
- tok, err := conf.Token(oauth2.NoContext)
- if err != nil {
- t.Error(err)
- }
- if !tok.Valid() {
- t.Fatalf("token invalid. got: %#v", tok)
- }
- if tok.AccessToken != "90d64460d14870c08c81352a05dedd3465940a7c" {
- t.Errorf("Access token = %q; want %q", tok.AccessToken, "90d64460d14870c08c81352a05dedd3465940a7c")
- }
- if tok.TokenType != "bearer" {
- t.Errorf("token type = %q; want %q", tok.TokenType, "bearer")
- }
-}
-
-func TestTokenRefreshRequest(t *testing.T) {
- ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
- if r.URL.String() == "/somethingelse" {
- return
- }
- if r.URL.String() != "/token" {
- t.Errorf("Unexpected token refresh request URL, %v is found.", r.URL)
- }
- headerContentType := r.Header.Get("Content-Type")
- if headerContentType != "application/x-www-form-urlencoded" {
- t.Errorf("Unexpected Content-Type header, %v is found.", headerContentType)
- }
- body, _ := ioutil.ReadAll(r.Body)
- if string(body) != "client_id=CLIENT_ID&grant_type=client_credentials&scope=scope1+scope2" {
- t.Errorf("Unexpected refresh token payload, %v is found.", string(body))
- }
- }))
- defer ts.Close()
- conf := newConf(ts.URL)
- c := conf.Client(oauth2.NoContext)
- c.Get(ts.URL + "/somethingelse")
-}
diff --git a/vendor/golang.org/x/oauth2/example_test.go b/vendor/golang.org/x/oauth2/example_test.go
deleted file mode 100644
index 8be27885..00000000
--- a/vendor/golang.org/x/oauth2/example_test.go
+++ /dev/null
@@ -1,45 +0,0 @@
-// Copyright 2014 The oauth2 Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package oauth2_test
-
-import (
- "fmt"
- "log"
-
- "golang.org/x/oauth2"
-)
-
-func ExampleConfig() {
- conf := &oauth2.Config{
- ClientID: "YOUR_CLIENT_ID",
- ClientSecret: "YOUR_CLIENT_SECRET",
- Scopes: []string{"SCOPE1", "SCOPE2"},
- Endpoint: oauth2.Endpoint{
- AuthURL: "https://provider.com/o/oauth2/auth",
- TokenURL: "https://provider.com/o/oauth2/token",
- },
- }
-
- // Redirect user to consent page to ask for permission
- // for the scopes specified above.
- url := conf.AuthCodeURL("state", oauth2.AccessTypeOffline)
- fmt.Printf("Visit the URL for the auth dialog: %v", url)
-
- // Use the authorization code that is pushed to the redirect URL.
- // NewTransportWithCode will do the handshake to retrieve
- // an access token and initiate a Transport that is
- // authorized and authenticated by the retrieved token.
- var code string
- if _, err := fmt.Scan(&code); err != nil {
- log.Fatal(err)
- }
- tok, err := conf.Exchange(oauth2.NoContext, code)
- if err != nil {
- log.Fatal(err)
- }
-
- client := conf.Client(oauth2.NoContext, tok)
- client.Get("...")
-}
diff --git a/vendor/golang.org/x/oauth2/facebook/facebook.go b/vendor/golang.org/x/oauth2/facebook/facebook.go
deleted file mode 100644
index 962e86b0..00000000
--- a/vendor/golang.org/x/oauth2/facebook/facebook.go
+++ /dev/null
@@ -1,16 +0,0 @@
-// Copyright 2015 The oauth2 Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-// Package facebook provides constants for using OAuth2 to access Facebook.
-package facebook // import "golang.org/x/oauth2/facebook"
-
-import (
- "golang.org/x/oauth2"
-)
-
-// Endpoint is Facebook's OAuth 2.0 endpoint.
-var Endpoint = oauth2.Endpoint{
- AuthURL: "https://www.facebook.com/dialog/oauth",
- TokenURL: "https://graph.facebook.com/oauth/access_token",
-}
diff --git a/vendor/golang.org/x/oauth2/github/github.go b/vendor/golang.org/x/oauth2/github/github.go
deleted file mode 100644
index 1648cb58..00000000
--- a/vendor/golang.org/x/oauth2/github/github.go
+++ /dev/null
@@ -1,16 +0,0 @@
-// Copyright 2014 The oauth2 Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-// Package github provides constants for using OAuth2 to access Github.
-package github // import "golang.org/x/oauth2/github"
-
-import (
- "golang.org/x/oauth2"
-)
-
-// Endpoint is Github's OAuth 2.0 endpoint.
-var Endpoint = oauth2.Endpoint{
- AuthURL: "https://github.com/login/oauth/authorize",
- TokenURL: "https://github.com/login/oauth/access_token",
-}
diff --git a/vendor/golang.org/x/oauth2/google/example_test.go b/vendor/golang.org/x/oauth2/google/example_test.go
deleted file mode 100644
index 17262802..00000000
--- a/vendor/golang.org/x/oauth2/google/example_test.go
+++ /dev/null
@@ -1,150 +0,0 @@
-// Copyright 2014 The oauth2 Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-// +build appenginevm !appengine
-
-package google_test
-
-import (
- "fmt"
- "io/ioutil"
- "log"
- "net/http"
-
- "golang.org/x/oauth2"
- "golang.org/x/oauth2/google"
- "golang.org/x/oauth2/jwt"
- "google.golang.org/appengine"
- "google.golang.org/appengine/urlfetch"
-)
-
-func ExampleDefaultClient() {
- client, err := google.DefaultClient(oauth2.NoContext,
- "https://www.googleapis.com/auth/devstorage.full_control")
- if err != nil {
- log.Fatal(err)
- }
- client.Get("...")
-}
-
-func Example_webServer() {
- // Your credentials should be obtained from the Google
- // Developer Console (https://console.developers.google.com).
- conf := &oauth2.Config{
- ClientID: "YOUR_CLIENT_ID",
- ClientSecret: "YOUR_CLIENT_SECRET",
- RedirectURL: "YOUR_REDIRECT_URL",
- Scopes: []string{
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/blogger",
- },
- Endpoint: google.Endpoint,
- }
- // Redirect user to Google's consent page to ask for permission
- // for the scopes specified above.
- url := conf.AuthCodeURL("state")
- fmt.Printf("Visit the URL for the auth dialog: %v", url)
-
- // Handle the exchange code to initiate a transport.
- tok, err := conf.Exchange(oauth2.NoContext, "authorization-code")
- if err != nil {
- log.Fatal(err)
- }
- client := conf.Client(oauth2.NoContext, tok)
- client.Get("...")
-}
-
-func ExampleJWTConfigFromJSON() {
- // Your credentials should be obtained from the Google
- // Developer Console (https://console.developers.google.com).
- // Navigate to your project, then see the "Credentials" page
- // under "APIs & Auth".
- // To create a service account client, click "Create new Client ID",
- // select "Service Account", and click "Create Client ID". A JSON
- // key file will then be downloaded to your computer.
- data, err := ioutil.ReadFile("/path/to/your-project-key.json")
- if err != nil {
- log.Fatal(err)
- }
- conf, err := google.JWTConfigFromJSON(data, "https://www.googleapis.com/auth/bigquery")
- if err != nil {
- log.Fatal(err)
- }
- // Initiate an http.Client. The following GET request will be
- // authorized and authenticated on the behalf of
- // your service account.
- client := conf.Client(oauth2.NoContext)
- client.Get("...")
-}
-
-func ExampleSDKConfig() {
- // The credentials will be obtained from the first account that
- // has been authorized with `gcloud auth login`.
- conf, err := google.NewSDKConfig("")
- if err != nil {
- log.Fatal(err)
- }
- // Initiate an http.Client. The following GET request will be
- // authorized and authenticated on the behalf of the SDK user.
- client := conf.Client(oauth2.NoContext)
- client.Get("...")
-}
-
-func Example_serviceAccount() {
- // Your credentials should be obtained from the Google
- // Developer Console (https://console.developers.google.com).
- conf := &jwt.Config{
- Email: "xxx@developer.gserviceaccount.com",
- // The contents of your RSA private key or your PEM file
- // that contains a private key.
- // If you have a p12 file instead, you
- // can use `openssl` to export the private key into a pem file.
- //
- // $ openssl pkcs12 -in key.p12 -passin pass:notasecret -out key.pem -nodes
- //
- // The field only supports PEM containers with no passphrase.
- // The openssl command will convert p12 keys to passphrase-less PEM containers.
- PrivateKey: []byte("-----BEGIN RSA PRIVATE KEY-----..."),
- Scopes: []string{
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/blogger",
- },
- TokenURL: google.JWTTokenURL,
- // If you would like to impersonate a user, you can
- // create a transport with a subject. The following GET
- // request will be made on the behalf of user@example.com.
- // Optional.
- Subject: "user@example.com",
- }
- // Initiate an http.Client, the following GET request will be
- // authorized and authenticated on the behalf of user@example.com.
- client := conf.Client(oauth2.NoContext)
- client.Get("...")
-}
-
-func ExampleAppEngineTokenSource() {
- var req *http.Request // from the ServeHTTP handler
- ctx := appengine.NewContext(req)
- client := &http.Client{
- Transport: &oauth2.Transport{
- Source: google.AppEngineTokenSource(ctx, "https://www.googleapis.com/auth/bigquery"),
- Base: &urlfetch.Transport{
- Context: ctx,
- },
- },
- }
- client.Get("...")
-}
-
-func ExampleComputeTokenSource() {
- client := &http.Client{
- Transport: &oauth2.Transport{
- // Fetch from Google Compute Engine's metadata server to retrieve
- // an access token for the provided account.
- // If no account is specified, "default" is used.
- Source: google.ComputeTokenSource(""),
- },
- }
- client.Get("...")
-}
diff --git a/vendor/golang.org/x/oauth2/google/google.go b/vendor/golang.org/x/oauth2/google/google.go
index 74aa7d91..2077d986 100644
--- a/vendor/golang.org/x/oauth2/google/google.go
+++ b/vendor/golang.org/x/oauth2/google/google.go
@@ -12,7 +12,7 @@
// https://developers.google.com/accounts/docs/OAuth2
// and
// https://developers.google.com/accounts/docs/application-default-credentials.
-package google // import "golang.org/x/oauth2/google"
+package google
import (
"encoding/json"
diff --git a/vendor/golang.org/x/oauth2/google/google_test.go b/vendor/golang.org/x/oauth2/google/google_test.go
deleted file mode 100644
index 4cc01884..00000000
--- a/vendor/golang.org/x/oauth2/google/google_test.go
+++ /dev/null
@@ -1,67 +0,0 @@
-// Copyright 2015 The oauth2 Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package google
-
-import (
- "strings"
- "testing"
-)
-
-var webJSONKey = []byte(`
-{
- "web": {
- "auth_uri": "https://google.com/o/oauth2/auth",
- "client_secret": "3Oknc4jS_wA2r9i",
- "token_uri": "https://google.com/o/oauth2/token",
- "client_email": "222-nprqovg5k43uum874cs9osjt2koe97g8@developer.gserviceaccount.com",
- "redirect_uris": ["https://www.example.com/oauth2callback"],
- "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/222-nprqovg5k43uum874cs9osjt2koe97g8@developer.gserviceaccount.com",
- "client_id": "222-nprqovg5k43uum874cs9osjt2koe97g8.apps.googleusercontent.com",
- "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
- "javascript_origins": ["https://www.example.com"]
- }
-}`)
-
-var installedJSONKey = []byte(`{
- "installed": {
- "client_id": "222-installed.apps.googleusercontent.com",
- "redirect_uris": ["https://www.example.com/oauth2callback"]
- }
-}`)
-
-func TestConfigFromJSON(t *testing.T) {
- conf, err := ConfigFromJSON(webJSONKey, "scope1", "scope2")
- if err != nil {
- t.Error(err)
- }
- if got, want := conf.ClientID, "222-nprqovg5k43uum874cs9osjt2koe97g8.apps.googleusercontent.com"; got != want {
- t.Errorf("ClientID = %q; want %q", got, want)
- }
- if got, want := conf.ClientSecret, "3Oknc4jS_wA2r9i"; got != want {
- t.Errorf("ClientSecret = %q; want %q", got, want)
- }
- if got, want := conf.RedirectURL, "https://www.example.com/oauth2callback"; got != want {
- t.Errorf("RedictURL = %q; want %q", got, want)
- }
- if got, want := strings.Join(conf.Scopes, ","), "scope1,scope2"; got != want {
- t.Errorf("Scopes = %q; want %q", got, want)
- }
- if got, want := conf.Endpoint.AuthURL, "https://google.com/o/oauth2/auth"; got != want {
- t.Errorf("AuthURL = %q; want %q", got, want)
- }
- if got, want := conf.Endpoint.TokenURL, "https://google.com/o/oauth2/token"; got != want {
- t.Errorf("TokenURL = %q; want %q", got, want)
- }
-}
-
-func TestConfigFromJSON_Installed(t *testing.T) {
- conf, err := ConfigFromJSON(installedJSONKey)
- if err != nil {
- t.Error(err)
- }
- if got, want := conf.ClientID, "222-installed.apps.googleusercontent.com"; got != want {
- t.Errorf("ClientID = %q; want %q", got, want)
- }
-}
diff --git a/vendor/golang.org/x/oauth2/google/sdk_test.go b/vendor/golang.org/x/oauth2/google/sdk_test.go
deleted file mode 100644
index 79df8896..00000000
--- a/vendor/golang.org/x/oauth2/google/sdk_test.go
+++ /dev/null
@@ -1,46 +0,0 @@
-// Copyright 2015 The oauth2 Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package google
-
-import "testing"
-
-func TestSDKConfig(t *testing.T) {
- sdkConfigPath = func() (string, error) {
- return "testdata/gcloud", nil
- }
-
- tests := []struct {
- account string
- accessToken string
- err bool
- }{
- {"", "bar_access_token", false},
- {"foo@example.com", "foo_access_token", false},
- {"bar@example.com", "bar_access_token", false},
- {"baz@serviceaccount.example.com", "", true},
- }
- for _, tt := range tests {
- c, err := NewSDKConfig(tt.account)
- if got, want := err != nil, tt.err; got != want {
- if !tt.err {
- t.Errorf("expected no error, got error: %v", tt.err, err)
- } else {
- t.Errorf("expected error, got none")
- }
- continue
- }
- if err != nil {
- continue
- }
- tok := c.initialToken
- if tok == nil {
- t.Errorf("expected token %q, got: nil", tt.accessToken)
- continue
- }
- if tok.AccessToken != tt.accessToken {
- t.Errorf("expected token %q, got: %q", tt.accessToken, tok.AccessToken)
- }
- }
-}
diff --git a/vendor/golang.org/x/oauth2/google/testdata/gcloud/credentials b/vendor/golang.org/x/oauth2/google/testdata/gcloud/credentials
deleted file mode 100644
index ff5eefbd..00000000
--- a/vendor/golang.org/x/oauth2/google/testdata/gcloud/credentials
+++ /dev/null
@@ -1,122 +0,0 @@
-{
- "data": [
- {
- "credential": {
- "_class": "OAuth2Credentials",
- "_module": "oauth2client.client",
- "access_token": "foo_access_token",
- "client_id": "foo_client_id",
- "client_secret": "foo_client_secret",
- "id_token": {
- "at_hash": "foo_at_hash",
- "aud": "foo_aud",
- "azp": "foo_azp",
- "cid": "foo_cid",
- "email": "foo@example.com",
- "email_verified": true,
- "exp": 1420573614,
- "iat": 1420569714,
- "id": "1337",
- "iss": "accounts.google.com",
- "sub": "1337",
- "token_hash": "foo_token_hash",
- "verified_email": true
- },
- "invalid": false,
- "refresh_token": "foo_refresh_token",
- "revoke_uri": "https://accounts.google.com/o/oauth2/revoke",
- "token_expiry": "2015-01-09T00:51:51Z",
- "token_response": {
- "access_token": "foo_access_token",
- "expires_in": 3600,
- "id_token": "foo_id_token",
- "token_type": "Bearer"
- },
- "token_uri": "https://accounts.google.com/o/oauth2/token",
- "user_agent": "Cloud SDK Command Line Tool"
- },
- "key": {
- "account": "foo@example.com",
- "clientId": "foo_client_id",
- "scope": "https://www.googleapis.com/auth/appengine.admin https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/compute https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/ndev.cloudman https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin https://www.googleapis.com/auth/prediction https://www.googleapis.com/auth/projecthosting",
- "type": "google-cloud-sdk"
- }
- },
- {
- "credential": {
- "_class": "OAuth2Credentials",
- "_module": "oauth2client.client",
- "access_token": "bar_access_token",
- "client_id": "bar_client_id",
- "client_secret": "bar_client_secret",
- "id_token": {
- "at_hash": "bar_at_hash",
- "aud": "bar_aud",
- "azp": "bar_azp",
- "cid": "bar_cid",
- "email": "bar@example.com",
- "email_verified": true,
- "exp": 1420573614,
- "iat": 1420569714,
- "id": "1337",
- "iss": "accounts.google.com",
- "sub": "1337",
- "token_hash": "bar_token_hash",
- "verified_email": true
- },
- "invalid": false,
- "refresh_token": "bar_refresh_token",
- "revoke_uri": "https://accounts.google.com/o/oauth2/revoke",
- "token_expiry": "2015-01-09T00:51:51Z",
- "token_response": {
- "access_token": "bar_access_token",
- "expires_in": 3600,
- "id_token": "bar_id_token",
- "token_type": "Bearer"
- },
- "token_uri": "https://accounts.google.com/o/oauth2/token",
- "user_agent": "Cloud SDK Command Line Tool"
- },
- "key": {
- "account": "bar@example.com",
- "clientId": "bar_client_id",
- "scope": "https://www.googleapis.com/auth/appengine.admin https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/compute https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/ndev.cloudman https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin https://www.googleapis.com/auth/prediction https://www.googleapis.com/auth/projecthosting",
- "type": "google-cloud-sdk"
- }
- },
- {
- "credential": {
- "_class": "ServiceAccountCredentials",
- "_kwargs": {},
- "_module": "oauth2client.client",
- "_private_key_id": "00000000000000000000000000000000",
- "_private_key_pkcs8_text": "-----BEGIN RSA PRIVATE KEY-----\nMIICWwIBAAKBgQCt3fpiynPSaUhWSIKMGV331zudwJ6GkGmvQtwsoK2S2LbvnSwU\nNxgj4fp08kIDR5p26wF4+t/HrKydMwzftXBfZ9UmLVJgRdSswmS5SmChCrfDS5OE\nvFFcN5+6w1w8/Nu657PF/dse8T0bV95YrqyoR0Osy8WHrUOMSIIbC3hRuwIDAQAB\nAoGAJrGE/KFjn0sQ7yrZ6sXmdLawrM3mObo/2uI9T60+k7SpGbBX0/Pi6nFrJMWZ\nTVONG7P3Mu5aCPzzuVRYJB0j8aldSfzABTY3HKoWCczqw1OztJiEseXGiYz4QOyr\nYU3qDyEpdhS6q6wcoLKGH+hqRmz6pcSEsc8XzOOu7s4xW8kCQQDkc75HjhbarCnd\nJJGMe3U76+6UGmdK67ltZj6k6xoB5WbTNChY9TAyI2JC+ppYV89zv3ssj4L+02u3\nHIHFGxsHAkEAwtU1qYb1tScpchPobnYUFiVKJ7KA8EZaHVaJJODW/cghTCV7BxcJ\nbgVvlmk4lFKn3lPKAgWw7PdQsBTVBUcCrQJATPwoIirizrv3u5soJUQxZIkENAqV\nxmybZx9uetrzP7JTrVbFRf0SScMcyN90hdLJiQL8+i4+gaszgFht7sNMnwJAAbfj\nq0UXcauQwALQ7/h2oONfTg5S+MuGC/AxcXPSMZbMRGGoPh3D5YaCv27aIuS/ukQ+\n6dmm/9AGlCb64fsIWQJAPaokbjIifo+LwC5gyK73Mc4t8nAOSZDenzd/2f6TCq76\nS1dcnKiPxaED7W/y6LJiuBT2rbZiQ2L93NJpFZD/UA==\n-----END RSA PRIVATE KEY-----\n",
- "_revoke_uri": "https://accounts.google.com/o/oauth2/revoke",
- "_scopes": "https://www.googleapis.com/auth/appengine.admin https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/compute https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/ndev.cloudman https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin https://www.googleapis.com/auth/prediction https://www.googleapis.com/auth/projecthosting",
- "_service_account_email": "baz@serviceaccount.example.com",
- "_service_account_id": "baz.serviceaccount.example.com",
- "_token_uri": "https://accounts.google.com/o/oauth2/token",
- "_user_agent": "Cloud SDK Command Line Tool",
- "access_token": null,
- "assertion_type": null,
- "client_id": null,
- "client_secret": null,
- "id_token": null,
- "invalid": false,
- "refresh_token": null,
- "revoke_uri": "https://accounts.google.com/o/oauth2/revoke",
- "service_account_name": "baz@serviceaccount.example.com",
- "token_expiry": null,
- "token_response": null,
- "user_agent": "Cloud SDK Command Line Tool"
- },
- "key": {
- "account": "baz@serviceaccount.example.com",
- "clientId": "baz_client_id",
- "scope": "https://www.googleapis.com/auth/appengine.admin https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/compute https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/ndev.cloudman https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin https://www.googleapis.com/auth/prediction https://www.googleapis.com/auth/projecthosting",
- "type": "google-cloud-sdk"
- }
- }
- ],
- "file_version": 1
-}
diff --git a/vendor/golang.org/x/oauth2/google/testdata/gcloud/properties b/vendor/golang.org/x/oauth2/google/testdata/gcloud/properties
deleted file mode 100644
index 025de886..00000000
--- a/vendor/golang.org/x/oauth2/google/testdata/gcloud/properties
+++ /dev/null
@@ -1,2 +0,0 @@
-[core]
-account = bar@example.com
\ No newline at end of file
diff --git a/vendor/golang.org/x/oauth2/internal/oauth2_test.go b/vendor/golang.org/x/oauth2/internal/oauth2_test.go
deleted file mode 100644
index 014a351e..00000000
--- a/vendor/golang.org/x/oauth2/internal/oauth2_test.go
+++ /dev/null
@@ -1,62 +0,0 @@
-// Copyright 2014 The oauth2 Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-// Package internal contains support packages for oauth2 package.
-package internal
-
-import (
- "reflect"
- "strings"
- "testing"
-)
-
-func TestParseINI(t *testing.T) {
- tests := []struct {
- ini string
- want map[string]map[string]string
- }{
- {
- `root = toor
-[foo]
-bar = hop
-ini = nin
-`,
- map[string]map[string]string{
- "": map[string]string{"root": "toor"},
- "foo": map[string]string{"bar": "hop", "ini": "nin"},
- },
- },
- {
- `[empty]
-[section]
-empty=
-`,
- map[string]map[string]string{
- "": map[string]string{},
- "empty": map[string]string{},
- "section": map[string]string{"empty": ""},
- },
- },
- {
- `ignore
-[invalid
-=stuff
-;comment=true
-`,
- map[string]map[string]string{
- "": map[string]string{},
- },
- },
- }
- for _, tt := range tests {
- result, err := ParseINI(strings.NewReader(tt.ini))
- if err != nil {
- t.Errorf("ParseINI(%q) error %v, want: no error", tt.ini, err)
- continue
- }
- if !reflect.DeepEqual(result, tt.want) {
- t.Errorf("ParseINI(%q) = %#v, want: %#v", tt.ini, result, tt.want)
- }
- }
-}
diff --git a/vendor/golang.org/x/oauth2/internal/token_test.go b/vendor/golang.org/x/oauth2/internal/token_test.go
deleted file mode 100644
index 864f6fa0..00000000
--- a/vendor/golang.org/x/oauth2/internal/token_test.go
+++ /dev/null
@@ -1,28 +0,0 @@
-// Copyright 2014 The oauth2 Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-// Package internal contains support packages for oauth2 package.
-package internal
-
-import (
- "fmt"
- "testing"
-)
-
-func Test_providerAuthHeaderWorks(t *testing.T) {
- for _, p := range brokenAuthHeaderProviders {
- if providerAuthHeaderWorks(p) {
- t.Errorf("URL: %s not found in list", p)
- }
- p := fmt.Sprintf("%ssomesuffix", p)
- if providerAuthHeaderWorks(p) {
- t.Errorf("URL: %s not found in list", p)
- }
- }
- p := "https://api.not-in-the-list-example.com/"
- if !providerAuthHeaderWorks(p) {
- t.Errorf("URL: %s found in list", p)
- }
-
-}
diff --git a/vendor/golang.org/x/oauth2/jws/jws.go b/vendor/golang.org/x/oauth2/jws/jws.go
index 362323c4..396b3fac 100644
--- a/vendor/golang.org/x/oauth2/jws/jws.go
+++ b/vendor/golang.org/x/oauth2/jws/jws.go
@@ -4,7 +4,7 @@
// Package jws provides encoding and decoding utilities for
// signed JWS messages.
-package jws // import "golang.org/x/oauth2/jws"
+package jws
import (
"bytes"
diff --git a/vendor/golang.org/x/oauth2/jwt/example_test.go b/vendor/golang.org/x/oauth2/jwt/example_test.go
deleted file mode 100644
index 6d618836..00000000
--- a/vendor/golang.org/x/oauth2/jwt/example_test.go
+++ /dev/null
@@ -1,31 +0,0 @@
-// Copyright 2014 The oauth2 Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package jwt_test
-
-import (
- "golang.org/x/oauth2"
- "golang.org/x/oauth2/jwt"
-)
-
-func ExampleJWTConfig() {
- conf := &jwt.Config{
- Email: "xxx@developer.com",
- // The contents of your RSA private key or your PEM file
- // that contains a private key.
- // If you have a p12 file instead, you
- // can use `openssl` to export the private key into a pem file.
- //
- // $ openssl pkcs12 -in key.p12 -out key.pem -nodes
- //
- // It only supports PEM containers with no passphrase.
- PrivateKey: []byte("-----BEGIN RSA PRIVATE KEY-----..."),
- Subject: "user@example.com",
- TokenURL: "https://provider.com/o/oauth2/token",
- }
- // Initiate an http.Client, the following GET request will be
- // authorized and authenticated on the behalf of user@example.com.
- client := conf.Client(oauth2.NoContext)
- client.Get("...")
-}
diff --git a/vendor/golang.org/x/oauth2/jwt/jwt_test.go b/vendor/golang.org/x/oauth2/jwt/jwt_test.go
deleted file mode 100644
index da922c3d..00000000
--- a/vendor/golang.org/x/oauth2/jwt/jwt_test.go
+++ /dev/null
@@ -1,134 +0,0 @@
-// Copyright 2014 The oauth2 Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package jwt
-
-import (
- "net/http"
- "net/http/httptest"
- "testing"
-
- "golang.org/x/oauth2"
-)
-
-var dummyPrivateKey = []byte(`-----BEGIN RSA PRIVATE KEY-----
-MIIEpAIBAAKCAQEAx4fm7dngEmOULNmAs1IGZ9Apfzh+BkaQ1dzkmbUgpcoghucE
-DZRnAGd2aPyB6skGMXUytWQvNYav0WTR00wFtX1ohWTfv68HGXJ8QXCpyoSKSSFY
-fuP9X36wBSkSX9J5DVgiuzD5VBdzUISSmapjKm+DcbRALjz6OUIPEWi1Tjl6p5RK
-1w41qdbmt7E5/kGhKLDuT7+M83g4VWhgIvaAXtnhklDAggilPPa8ZJ1IFe31lNlr
-k4DRk38nc6sEutdf3RL7QoH7FBusI7uXV03DC6dwN1kP4GE7bjJhcRb/7jYt7CQ9
-/E9Exz3c0yAp0yrTg0Fwh+qxfH9dKwN52S7SBwIDAQABAoIBAQCaCs26K07WY5Jt
-3a2Cw3y2gPrIgTCqX6hJs7O5ByEhXZ8nBwsWANBUe4vrGaajQHdLj5OKfsIDrOvn
-2NI1MqflqeAbu/kR32q3tq8/Rl+PPiwUsW3E6Pcf1orGMSNCXxeducF2iySySzh3
-nSIhCG5uwJDWI7a4+9KiieFgK1pt/Iv30q1SQS8IEntTfXYwANQrfKUVMmVF9aIK
-6/WZE2yd5+q3wVVIJ6jsmTzoDCX6QQkkJICIYwCkglmVy5AeTckOVwcXL0jqw5Kf
-5/soZJQwLEyBoQq7Kbpa26QHq+CJONetPP8Ssy8MJJXBT+u/bSseMb3Zsr5cr43e
-DJOhwsThAoGBAPY6rPKl2NT/K7XfRCGm1sbWjUQyDShscwuWJ5+kD0yudnT/ZEJ1
-M3+KS/iOOAoHDdEDi9crRvMl0UfNa8MAcDKHflzxg2jg/QI+fTBjPP5GOX0lkZ9g
-z6VePoVoQw2gpPFVNPPTxKfk27tEzbaffvOLGBEih0Kb7HTINkW8rIlzAoGBAM9y
-1yr+jvfS1cGFtNU+Gotoihw2eMKtIqR03Yn3n0PK1nVCDKqwdUqCypz4+ml6cxRK
-J8+Pfdh7D+ZJd4LEG6Y4QRDLuv5OA700tUoSHxMSNn3q9As4+T3MUyYxWKvTeu3U
-f2NWP9ePU0lV8ttk7YlpVRaPQmc1qwooBA/z/8AdAoGAW9x0HWqmRICWTBnpjyxx
-QGlW9rQ9mHEtUotIaRSJ6K/F3cxSGUEkX1a3FRnp6kPLcckC6NlqdNgNBd6rb2rA
-cPl/uSkZP42Als+9YMoFPU/xrrDPbUhu72EDrj3Bllnyb168jKLa4VBOccUvggxr
-Dm08I1hgYgdN5huzs7y6GeUCgYEAj+AZJSOJ6o1aXS6rfV3mMRve9bQ9yt8jcKXw
-5HhOCEmMtaSKfnOF1Ziih34Sxsb7O2428DiX0mV/YHtBnPsAJidL0SdLWIapBzeg
-KHArByIRkwE6IvJvwpGMdaex1PIGhx5i/3VZL9qiq/ElT05PhIb+UXgoWMabCp84
-OgxDK20CgYAeaFo8BdQ7FmVX2+EEejF+8xSge6WVLtkaon8bqcn6P0O8lLypoOhd
-mJAYH8WU+UAy9pecUnDZj14LAGNVmYcse8HFX71MoshnvCTFEPVo4rZxIAGwMpeJ
-5jgQ3slYLpqrGlcbLgUXBUgzEO684Wk/UV9DFPlHALVqCfXQ9dpJPg==
------END RSA PRIVATE KEY-----`)
-
-func TestJWTFetch_JSONResponse(t *testing.T) {
- ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
- w.Header().Set("Content-Type", "application/json")
- w.Write([]byte(`{
- "access_token": "90d64460d14870c08c81352a05dedd3465940a7c",
- "scope": "user",
- "token_type": "bearer",
- "expires_in": 3600
- }`))
- }))
- defer ts.Close()
-
- conf := &Config{
- Email: "aaa@xxx.com",
- PrivateKey: dummyPrivateKey,
- TokenURL: ts.URL,
- }
- tok, err := conf.TokenSource(oauth2.NoContext).Token()
- if err != nil {
- t.Fatal(err)
- }
- if !tok.Valid() {
- t.Errorf("Token invalid")
- }
- if tok.AccessToken != "90d64460d14870c08c81352a05dedd3465940a7c" {
- t.Errorf("Unexpected access token, %#v", tok.AccessToken)
- }
- if tok.TokenType != "bearer" {
- t.Errorf("Unexpected token type, %#v", tok.TokenType)
- }
- if tok.Expiry.IsZero() {
- t.Errorf("Unexpected token expiry, %#v", tok.Expiry)
- }
- scope := tok.Extra("scope")
- if scope != "user" {
- t.Errorf("Unexpected value for scope: %v", scope)
- }
-}
-
-func TestJWTFetch_BadResponse(t *testing.T) {
- ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
- w.Header().Set("Content-Type", "application/json")
- w.Write([]byte(`{"scope": "user", "token_type": "bearer"}`))
- }))
- defer ts.Close()
-
- conf := &Config{
- Email: "aaa@xxx.com",
- PrivateKey: dummyPrivateKey,
- TokenURL: ts.URL,
- }
- tok, err := conf.TokenSource(oauth2.NoContext).Token()
- if err != nil {
- t.Fatal(err)
- }
- if tok == nil {
- t.Fatalf("token is nil")
- }
- if tok.Valid() {
- t.Errorf("token is valid. want invalid.")
- }
- if tok.AccessToken != "" {
- t.Errorf("Unexpected non-empty access token %q.", tok.AccessToken)
- }
- if want := "bearer"; tok.TokenType != want {
- t.Errorf("TokenType = %q; want %q", tok.TokenType, want)
- }
- scope := tok.Extra("scope")
- if want := "user"; scope != want {
- t.Errorf("token scope = %q; want %q", scope, want)
- }
-}
-
-func TestJWTFetch_BadResponseType(t *testing.T) {
- ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
- w.Header().Set("Content-Type", "application/json")
- w.Write([]byte(`{"access_token":123, "scope": "user", "token_type": "bearer"}`))
- }))
- defer ts.Close()
- conf := &Config{
- Email: "aaa@xxx.com",
- PrivateKey: dummyPrivateKey,
- TokenURL: ts.URL,
- }
- tok, err := conf.TokenSource(oauth2.NoContext).Token()
- if err == nil {
- t.Error("got a token; expected error")
- if tok.AccessToken != "" {
- t.Errorf("Unexpected access token, %#v.", tok.AccessToken)
- }
- }
-}
diff --git a/vendor/golang.org/x/oauth2/linkedin/linkedin.go b/vendor/golang.org/x/oauth2/linkedin/linkedin.go
deleted file mode 100644
index de91d5b9..00000000
--- a/vendor/golang.org/x/oauth2/linkedin/linkedin.go
+++ /dev/null
@@ -1,16 +0,0 @@
-// Copyright 2015 The oauth2 Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-// Package linkedin provides constants for using OAuth2 to access LinkedIn.
-package linkedin // import "golang.org/x/oauth2/linkedin"
-
-import (
- "golang.org/x/oauth2"
-)
-
-// Endpoint is LinkedIn's OAuth 2.0 endpoint.
-var Endpoint = oauth2.Endpoint{
- AuthURL: "https://www.linkedin.com/uas/oauth2/authorization",
- TokenURL: "https://www.linkedin.com/uas/oauth2/accessToken",
-}
diff --git a/vendor/golang.org/x/oauth2/oauth2.go b/vendor/golang.org/x/oauth2/oauth2.go
index cca8b180..dfcf238d 100644
--- a/vendor/golang.org/x/oauth2/oauth2.go
+++ b/vendor/golang.org/x/oauth2/oauth2.go
@@ -5,7 +5,7 @@
// Package oauth2 provides support for making
// OAuth2 authorized and authenticated HTTP requests.
// It can additionally grant authorization with Bearer JWT.
-package oauth2 // import "golang.org/x/oauth2"
+package oauth2
import (
"bytes"
diff --git a/vendor/golang.org/x/oauth2/oauth2_test.go b/vendor/golang.org/x/oauth2/oauth2_test.go
deleted file mode 100644
index 2f7d731c..00000000
--- a/vendor/golang.org/x/oauth2/oauth2_test.go
+++ /dev/null
@@ -1,422 +0,0 @@
-// Copyright 2014 The oauth2 Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package oauth2
-
-import (
- "encoding/json"
- "errors"
- "fmt"
- "io/ioutil"
- "net/http"
- "net/http/httptest"
- "reflect"
- "strconv"
- "testing"
- "time"
-
- "golang.org/x/net/context"
-)
-
-type mockTransport struct {
- rt func(req *http.Request) (resp *http.Response, err error)
-}
-
-func (t *mockTransport) RoundTrip(req *http.Request) (resp *http.Response, err error) {
- return t.rt(req)
-}
-
-type mockCache struct {
- token *Token
- readErr error
-}
-
-func (c *mockCache) ReadToken() (*Token, error) {
- return c.token, c.readErr
-}
-
-func (c *mockCache) WriteToken(*Token) {
- // do nothing
-}
-
-func newConf(url string) *Config {
- return &Config{
- ClientID: "CLIENT_ID",
- ClientSecret: "CLIENT_SECRET",
- RedirectURL: "REDIRECT_URL",
- Scopes: []string{"scope1", "scope2"},
- Endpoint: Endpoint{
- AuthURL: url + "/auth",
- TokenURL: url + "/token",
- },
- }
-}
-
-func TestAuthCodeURL(t *testing.T) {
- conf := newConf("server")
- url := conf.AuthCodeURL("foo", AccessTypeOffline, ApprovalForce)
- if url != "server/auth?access_type=offline&approval_prompt=force&client_id=CLIENT_ID&redirect_uri=REDIRECT_URL&response_type=code&scope=scope1+scope2&state=foo" {
- t.Errorf("Auth code URL doesn't match the expected, found: %v", url)
- }
-}
-
-func TestAuthCodeURL_CustomParam(t *testing.T) {
- conf := newConf("server")
- param := SetAuthURLParam("foo", "bar")
- url := conf.AuthCodeURL("baz", param)
- if url != "server/auth?client_id=CLIENT_ID&foo=bar&redirect_uri=REDIRECT_URL&response_type=code&scope=scope1+scope2&state=baz" {
- t.Errorf("Auth code URL doesn't match the expected, found: %v", url)
- }
-}
-
-func TestAuthCodeURL_Optional(t *testing.T) {
- conf := &Config{
- ClientID: "CLIENT_ID",
- Endpoint: Endpoint{
- AuthURL: "/auth-url",
- TokenURL: "/token-url",
- },
- }
- url := conf.AuthCodeURL("")
- if url != "/auth-url?client_id=CLIENT_ID&response_type=code" {
- t.Fatalf("Auth code URL doesn't match the expected, found: %v", url)
- }
-}
-
-func TestExchangeRequest(t *testing.T) {
- ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
- if r.URL.String() != "/token" {
- t.Errorf("Unexpected exchange request URL, %v is found.", r.URL)
- }
- headerAuth := r.Header.Get("Authorization")
- if headerAuth != "Basic Q0xJRU5UX0lEOkNMSUVOVF9TRUNSRVQ=" {
- t.Errorf("Unexpected authorization header, %v is found.", headerAuth)
- }
- headerContentType := r.Header.Get("Content-Type")
- if headerContentType != "application/x-www-form-urlencoded" {
- t.Errorf("Unexpected Content-Type header, %v is found.", headerContentType)
- }
- body, err := ioutil.ReadAll(r.Body)
- if err != nil {
- t.Errorf("Failed reading request body: %s.", err)
- }
- if string(body) != "client_id=CLIENT_ID&code=exchange-code&grant_type=authorization_code&redirect_uri=REDIRECT_URL&scope=scope1+scope2" {
- t.Errorf("Unexpected exchange payload, %v is found.", string(body))
- }
- w.Header().Set("Content-Type", "application/x-www-form-urlencoded")
- w.Write([]byte("access_token=90d64460d14870c08c81352a05dedd3465940a7c&scope=user&token_type=bearer"))
- }))
- defer ts.Close()
- conf := newConf(ts.URL)
- tok, err := conf.Exchange(NoContext, "exchange-code")
- if err != nil {
- t.Error(err)
- }
- if !tok.Valid() {
- t.Fatalf("Token invalid. Got: %#v", tok)
- }
- if tok.AccessToken != "90d64460d14870c08c81352a05dedd3465940a7c" {
- t.Errorf("Unexpected access token, %#v.", tok.AccessToken)
- }
- if tok.TokenType != "bearer" {
- t.Errorf("Unexpected token type, %#v.", tok.TokenType)
- }
- scope := tok.Extra("scope")
- if scope != "user" {
- t.Errorf("Unexpected value for scope: %v", scope)
- }
-}
-
-func TestExchangeRequest_JSONResponse(t *testing.T) {
- ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
- if r.URL.String() != "/token" {
- t.Errorf("Unexpected exchange request URL, %v is found.", r.URL)
- }
- headerAuth := r.Header.Get("Authorization")
- if headerAuth != "Basic Q0xJRU5UX0lEOkNMSUVOVF9TRUNSRVQ=" {
- t.Errorf("Unexpected authorization header, %v is found.", headerAuth)
- }
- headerContentType := r.Header.Get("Content-Type")
- if headerContentType != "application/x-www-form-urlencoded" {
- t.Errorf("Unexpected Content-Type header, %v is found.", headerContentType)
- }
- body, err := ioutil.ReadAll(r.Body)
- if err != nil {
- t.Errorf("Failed reading request body: %s.", err)
- }
- if string(body) != "client_id=CLIENT_ID&code=exchange-code&grant_type=authorization_code&redirect_uri=REDIRECT_URL&scope=scope1+scope2" {
- t.Errorf("Unexpected exchange payload, %v is found.", string(body))
- }
- w.Header().Set("Content-Type", "application/json")
- w.Write([]byte(`{"access_token": "90d64460d14870c08c81352a05dedd3465940a7c", "scope": "user", "token_type": "bearer", "expires_in": 86400}`))
- }))
- defer ts.Close()
- conf := newConf(ts.URL)
- tok, err := conf.Exchange(NoContext, "exchange-code")
- if err != nil {
- t.Error(err)
- }
- if !tok.Valid() {
- t.Fatalf("Token invalid. Got: %#v", tok)
- }
- if tok.AccessToken != "90d64460d14870c08c81352a05dedd3465940a7c" {
- t.Errorf("Unexpected access token, %#v.", tok.AccessToken)
- }
- if tok.TokenType != "bearer" {
- t.Errorf("Unexpected token type, %#v.", tok.TokenType)
- }
- scope := tok.Extra("scope")
- if scope != "user" {
- t.Errorf("Unexpected value for scope: %v", scope)
- }
-}
-
-const day = 24 * time.Hour
-
-func TestExchangeRequest_JSONResponse_Expiry(t *testing.T) {
- seconds := int32(day.Seconds())
- jsonNumberType := reflect.TypeOf(json.Number("0"))
- for _, c := range []struct {
- expires string
- expect error
- }{
- {fmt.Sprintf(`"expires_in": %d`, seconds), nil},
- {fmt.Sprintf(`"expires_in": "%d"`, seconds), nil}, // PayPal case
- {fmt.Sprintf(`"expires": %d`, seconds), nil}, // Facebook case
- {`"expires": false`, &json.UnmarshalTypeError{Value: "bool", Type: jsonNumberType}}, // wrong type
- {`"expires": {}`, &json.UnmarshalTypeError{Value: "object", Type: jsonNumberType}}, // wrong type
- {`"expires": "zzz"`, &strconv.NumError{Func: "ParseInt", Num: "zzz", Err: strconv.ErrSyntax}}, // wrong value
- } {
- testExchangeRequest_JSONResponse_expiry(t, c.expires, c.expect)
- }
-}
-
-func testExchangeRequest_JSONResponse_expiry(t *testing.T, exp string, expect error) {
- ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
- w.Header().Set("Content-Type", "application/json")
- w.Write([]byte(fmt.Sprintf(`{"access_token": "90d", "scope": "user", "token_type": "bearer", %s}`, exp)))
- }))
- defer ts.Close()
- conf := newConf(ts.URL)
- t1 := time.Now().Add(day)
- tok, err := conf.Exchange(NoContext, "exchange-code")
- t2 := time.Now().Add(day)
- // Do a fmt.Sprint comparison so either side can be
- // nil. fmt.Sprint just stringifies them to "", and no
- // non-nil expected error ever stringifies as "", so this
- // isn't terribly disgusting. We do this because Go 1.4 and
- // Go 1.5 return a different deep value for
- // json.UnmarshalTypeError. In Go 1.5, the
- // json.UnmarshalTypeError contains a new field with a new
- // non-zero value. Rather than ignore it here with reflect or
- // add new files and +build tags, just look at the strings.
- if fmt.Sprint(err) != fmt.Sprint(expect) {
- t.Errorf("Error = %v; want %v", err, expect)
- }
- if err != nil {
- return
- }
- if !tok.Valid() {
- t.Fatalf("Token invalid. Got: %#v", tok)
- }
- expiry := tok.Expiry
- if expiry.Before(t1) || expiry.After(t2) {
- t.Errorf("Unexpected value for Expiry: %v (shold be between %v and %v)", expiry, t1, t2)
- }
-}
-
-func TestExchangeRequest_BadResponse(t *testing.T) {
- ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
- w.Header().Set("Content-Type", "application/json")
- w.Write([]byte(`{"scope": "user", "token_type": "bearer"}`))
- }))
- defer ts.Close()
- conf := newConf(ts.URL)
- tok, err := conf.Exchange(NoContext, "code")
- if err != nil {
- t.Fatal(err)
- }
- if tok.AccessToken != "" {
- t.Errorf("Unexpected access token, %#v.", tok.AccessToken)
- }
-}
-
-func TestExchangeRequest_BadResponseType(t *testing.T) {
- ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
- w.Header().Set("Content-Type", "application/json")
- w.Write([]byte(`{"access_token":123, "scope": "user", "token_type": "bearer"}`))
- }))
- defer ts.Close()
- conf := newConf(ts.URL)
- _, err := conf.Exchange(NoContext, "exchange-code")
- if err == nil {
- t.Error("expected error from invalid access_token type")
- }
-}
-
-func TestExchangeRequest_NonBasicAuth(t *testing.T) {
- tr := &mockTransport{
- rt: func(r *http.Request) (w *http.Response, err error) {
- headerAuth := r.Header.Get("Authorization")
- if headerAuth != "" {
- t.Errorf("Unexpected authorization header, %v is found.", headerAuth)
- }
- return nil, errors.New("no response")
- },
- }
- c := &http.Client{Transport: tr}
- conf := &Config{
- ClientID: "CLIENT_ID",
- Endpoint: Endpoint{
- AuthURL: "https://accounts.google.com/auth",
- TokenURL: "https://accounts.google.com/token",
- },
- }
-
- ctx := context.WithValue(context.Background(), HTTPClient, c)
- conf.Exchange(ctx, "code")
-}
-
-func TestPasswordCredentialsTokenRequest(t *testing.T) {
- ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
- defer r.Body.Close()
- expected := "/token"
- if r.URL.String() != expected {
- t.Errorf("URL = %q; want %q", r.URL, expected)
- }
- headerAuth := r.Header.Get("Authorization")
- expected = "Basic Q0xJRU5UX0lEOkNMSUVOVF9TRUNSRVQ="
- if headerAuth != expected {
- t.Errorf("Authorization header = %q; want %q", headerAuth, expected)
- }
- headerContentType := r.Header.Get("Content-Type")
- expected = "application/x-www-form-urlencoded"
- if headerContentType != expected {
- t.Errorf("Content-Type header = %q; want %q", headerContentType, expected)
- }
- body, err := ioutil.ReadAll(r.Body)
- if err != nil {
- t.Errorf("Failed reading request body: %s.", err)
- }
- expected = "client_id=CLIENT_ID&grant_type=password&password=password1&scope=scope1+scope2&username=user1"
- if string(body) != expected {
- t.Errorf("res.Body = %q; want %q", string(body), expected)
- }
- w.Header().Set("Content-Type", "application/x-www-form-urlencoded")
- w.Write([]byte("access_token=90d64460d14870c08c81352a05dedd3465940a7c&scope=user&token_type=bearer"))
- }))
- defer ts.Close()
- conf := newConf(ts.URL)
- tok, err := conf.PasswordCredentialsToken(NoContext, "user1", "password1")
- if err != nil {
- t.Error(err)
- }
- if !tok.Valid() {
- t.Fatalf("Token invalid. Got: %#v", tok)
- }
- expected := "90d64460d14870c08c81352a05dedd3465940a7c"
- if tok.AccessToken != expected {
- t.Errorf("AccessToken = %q; want %q", tok.AccessToken, expected)
- }
- expected = "bearer"
- if tok.TokenType != expected {
- t.Errorf("TokenType = %q; want %q", tok.TokenType, expected)
- }
-}
-
-func TestTokenRefreshRequest(t *testing.T) {
- ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
- if r.URL.String() == "/somethingelse" {
- return
- }
- if r.URL.String() != "/token" {
- t.Errorf("Unexpected token refresh request URL, %v is found.", r.URL)
- }
- headerContentType := r.Header.Get("Content-Type")
- if headerContentType != "application/x-www-form-urlencoded" {
- t.Errorf("Unexpected Content-Type header, %v is found.", headerContentType)
- }
- body, _ := ioutil.ReadAll(r.Body)
- if string(body) != "client_id=CLIENT_ID&grant_type=refresh_token&refresh_token=REFRESH_TOKEN" {
- t.Errorf("Unexpected refresh token payload, %v is found.", string(body))
- }
- }))
- defer ts.Close()
- conf := newConf(ts.URL)
- c := conf.Client(NoContext, &Token{RefreshToken: "REFRESH_TOKEN"})
- c.Get(ts.URL + "/somethingelse")
-}
-
-func TestFetchWithNoRefreshToken(t *testing.T) {
- ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
- if r.URL.String() == "/somethingelse" {
- return
- }
- if r.URL.String() != "/token" {
- t.Errorf("Unexpected token refresh request URL, %v is found.", r.URL)
- }
- headerContentType := r.Header.Get("Content-Type")
- if headerContentType != "application/x-www-form-urlencoded" {
- t.Errorf("Unexpected Content-Type header, %v is found.", headerContentType)
- }
- body, _ := ioutil.ReadAll(r.Body)
- if string(body) != "client_id=CLIENT_ID&grant_type=refresh_token&refresh_token=REFRESH_TOKEN" {
- t.Errorf("Unexpected refresh token payload, %v is found.", string(body))
- }
- }))
- defer ts.Close()
- conf := newConf(ts.URL)
- c := conf.Client(NoContext, nil)
- _, err := c.Get(ts.URL + "/somethingelse")
- if err == nil {
- t.Errorf("Fetch should return an error if no refresh token is set")
- }
-}
-
-func TestRefreshToken_RefreshTokenReplacement(t *testing.T) {
- ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
- w.Header().Set("Content-Type", "application/json")
- w.Write([]byte(`{"access_token":"ACCESS TOKEN", "scope": "user", "token_type": "bearer", "refresh_token": "NEW REFRESH TOKEN"}`))
- return
- }))
- defer ts.Close()
- conf := newConf(ts.URL)
- tkr := tokenRefresher{
- conf: conf,
- ctx: NoContext,
- refreshToken: "OLD REFRESH TOKEN",
- }
- tk, err := tkr.Token()
- if err != nil {
- t.Errorf("Unexpected refreshToken error returned: %v", err)
- return
- }
- if tk.RefreshToken != tkr.refreshToken {
- t.Errorf("tokenRefresher.refresh_token = %s; want %s", tkr.refreshToken, tk.RefreshToken)
- }
-}
-
-func TestConfigClientWithToken(t *testing.T) {
- tok := &Token{
- AccessToken: "abc123",
- }
- ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
- if got, want := r.Header.Get("Authorization"), fmt.Sprintf("Bearer %s", tok.AccessToken); got != want {
- t.Errorf("Authorization header = %q; want %q", got, want)
- }
- return
- }))
- defer ts.Close()
- conf := newConf(ts.URL)
-
- c := conf.Client(NoContext, tok)
- req, err := http.NewRequest("GET", ts.URL, nil)
- if err != nil {
- t.Error(err)
- }
- _, err = c.Do(req)
- if err != nil {
- t.Error(err)
- }
-}
diff --git a/vendor/golang.org/x/oauth2/odnoklassniki/odnoklassniki.go b/vendor/golang.org/x/oauth2/odnoklassniki/odnoklassniki.go
deleted file mode 100644
index 2f7a9621..00000000
--- a/vendor/golang.org/x/oauth2/odnoklassniki/odnoklassniki.go
+++ /dev/null
@@ -1,16 +0,0 @@
-// Copyright 2015 The oauth2 Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-// Package odnoklassniki provides constants for using OAuth2 to access Odnoklassniki.
-package odnoklassniki // import "golang.org/x/oauth2/odnoklassniki"
-
-import (
- "golang.org/x/oauth2"
-)
-
-// Endpoint is Odnoklassniki's OAuth 2.0 endpoint.
-var Endpoint = oauth2.Endpoint{
- AuthURL: "https://www.odnoklassniki.ru/oauth/authorize",
- TokenURL: "https://api.odnoklassniki.ru/oauth/token.do",
-}
diff --git a/vendor/golang.org/x/oauth2/paypal/paypal.go b/vendor/golang.org/x/oauth2/paypal/paypal.go
deleted file mode 100644
index baeaa237..00000000
--- a/vendor/golang.org/x/oauth2/paypal/paypal.go
+++ /dev/null
@@ -1,22 +0,0 @@
-// Copyright 2015 The oauth2 Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-// Package paypal provides constants for using OAuth2 to access PayPal.
-package paypal // import "golang.org/x/oauth2/paypal"
-
-import (
- "golang.org/x/oauth2"
-)
-
-// Endpoint is PayPal's OAuth 2.0 endpoint in live (production) environment.
-var Endpoint = oauth2.Endpoint{
- AuthURL: "https://www.paypal.com/webapps/auth/protocol/openidconnect/v1/authorize",
- TokenURL: "https://api.paypal.com/v1/identity/openidconnect/tokenservice",
-}
-
-// SandboxEndpoint is PayPal's OAuth 2.0 endpoint in sandbox (testing) environment.
-var SandboxEndpoint = oauth2.Endpoint{
- AuthURL: "https://www.sandbox.paypal.com/webapps/auth/protocol/openidconnect/v1/authorize",
- TokenURL: "https://api.sandbox.paypal.com/v1/identity/openidconnect/tokenservice",
-}
diff --git a/vendor/golang.org/x/oauth2/token_test.go b/vendor/golang.org/x/oauth2/token_test.go
deleted file mode 100644
index 739eeb2a..00000000
--- a/vendor/golang.org/x/oauth2/token_test.go
+++ /dev/null
@@ -1,50 +0,0 @@
-// Copyright 2014 The oauth2 Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-package oauth2
-
-import (
- "testing"
- "time"
-)
-
-func TestTokenExtra(t *testing.T) {
- type testCase struct {
- key string
- val interface{}
- want interface{}
- }
- const key = "extra-key"
- cases := []testCase{
- {key: key, val: "abc", want: "abc"},
- {key: key, val: 123, want: 123},
- {key: key, val: "", want: ""},
- {key: "other-key", val: "def", want: nil},
- }
- for _, tc := range cases {
- extra := make(map[string]interface{})
- extra[tc.key] = tc.val
- tok := &Token{raw: extra}
- if got, want := tok.Extra(key), tc.want; got != want {
- t.Errorf("Extra(%q) = %q; want %q", key, got, want)
- }
- }
-}
-
-func TestTokenExpiry(t *testing.T) {
- now := time.Now()
- cases := []struct {
- name string
- tok *Token
- want bool
- }{
- {name: "12 seconds", tok: &Token{Expiry: now.Add(12 * time.Second)}, want: false},
- {name: "10 seconds", tok: &Token{Expiry: now.Add(expiryDelta)}, want: true},
- }
- for _, tc := range cases {
- if got, want := tc.tok.expired(), tc.want; got != want {
- t.Errorf("expired (%q) = %v; want %v", tc.name, got, want)
- }
- }
-}
diff --git a/vendor/golang.org/x/oauth2/transport_test.go b/vendor/golang.org/x/oauth2/transport_test.go
deleted file mode 100644
index 35cb25ed..00000000
--- a/vendor/golang.org/x/oauth2/transport_test.go
+++ /dev/null
@@ -1,86 +0,0 @@
-package oauth2
-
-import (
- "net/http"
- "net/http/httptest"
- "testing"
- "time"
-)
-
-type tokenSource struct{ token *Token }
-
-func (t *tokenSource) Token() (*Token, error) {
- return t.token, nil
-}
-
-func TestTransportTokenSource(t *testing.T) {
- ts := &tokenSource{
- token: &Token{
- AccessToken: "abc",
- },
- }
- tr := &Transport{
- Source: ts,
- }
- server := newMockServer(func(w http.ResponseWriter, r *http.Request) {
- if r.Header.Get("Authorization") != "Bearer abc" {
- t.Errorf("Transport doesn't set the Authorization header from the fetched token")
- }
- })
- defer server.Close()
- client := http.Client{Transport: tr}
- client.Get(server.URL)
-}
-
-// Test for case-sensitive token types, per https://github.com/golang/oauth2/issues/113
-func TestTransportTokenSourceTypes(t *testing.T) {
- const val = "abc"
- tests := []struct {
- key string
- val string
- want string
- }{
- {key: "bearer", val: val, want: "Bearer abc"},
- {key: "mac", val: val, want: "MAC abc"},
- {key: "basic", val: val, want: "Basic abc"},
- }
- for _, tc := range tests {
- ts := &tokenSource{
- token: &Token{
- AccessToken: tc.val,
- TokenType: tc.key,
- },
- }
- tr := &Transport{
- Source: ts,
- }
- server := newMockServer(func(w http.ResponseWriter, r *http.Request) {
- if got, want := r.Header.Get("Authorization"), tc.want; got != want {
- t.Errorf("Authorization header (%q) = %q; want %q", val, got, want)
- }
- })
- defer server.Close()
- client := http.Client{Transport: tr}
- client.Get(server.URL)
- }
-}
-
-func TestTokenValidNoAccessToken(t *testing.T) {
- token := &Token{}
- if token.Valid() {
- t.Errorf("Token should not be valid with no access token")
- }
-}
-
-func TestExpiredWithExpiry(t *testing.T) {
- token := &Token{
- Expiry: time.Now().Add(-5 * time.Hour),
- }
- if token.Valid() {
- t.Errorf("Token should not be valid if it expired in the past")
- }
-}
-
-func newMockServer(handler func(w http.ResponseWriter, r *http.Request)) *httptest.Server {
- return httptest.NewServer(http.HandlerFunc(handler))
-}
diff --git a/vendor/golang.org/x/oauth2/vk/vk.go b/vendor/golang.org/x/oauth2/vk/vk.go
deleted file mode 100644
index 5acdeb18..00000000
--- a/vendor/golang.org/x/oauth2/vk/vk.go
+++ /dev/null
@@ -1,16 +0,0 @@
-// Copyright 2015 The oauth2 Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-// Package vk provides constants for using OAuth2 to access VK.com.
-package vk // import "golang.org/x/oauth2/vk"
-
-import (
- "golang.org/x/oauth2"
-)
-
-// Endpoint is VK's OAuth 2.0 endpoint.
-var Endpoint = oauth2.Endpoint{
- AuthURL: "https://oauth.vk.com/authorize",
- TokenURL: "https://oauth.vk.com/access_token",
-}
diff --git a/vendor/google.golang.org/api/.hgignore b/vendor/google.golang.org/api/.hgignore
deleted file mode 100644
index d31fc45f..00000000
--- a/vendor/google.golang.org/api/.hgignore
+++ /dev/null
@@ -1,11 +0,0 @@
-_obj
-_testmain.go
-clientid.dat
-clientsecret.dat
-google-api-go-generator/google-api-go-gen
-
-syntax:glob
-*.6
-*.8
-*~
-*.out
diff --git a/vendor/google.golang.org/api/.hgtags b/vendor/google.golang.org/api/.hgtags
deleted file mode 100644
index f1a73578..00000000
--- a/vendor/google.golang.org/api/.hgtags
+++ /dev/null
@@ -1 +0,0 @@
-b571b553f8c057cb6952ce817dfb09b6e34a8c0b release
diff --git a/vendor/google.golang.org/api/.travis.yml b/vendor/google.golang.org/api/.travis.yml
deleted file mode 100644
index 59cb6735..00000000
--- a/vendor/google.golang.org/api/.travis.yml
+++ /dev/null
@@ -1,13 +0,0 @@
-sudo: false
-
-language: go
-
-go:
- - 1.4
- - tip
-
-install:
- - go get -v google.golang.org/api/...
-
-script:
- - go test -v google.golang.org/api/...
diff --git a/vendor/google.golang.org/api/AUTHORS b/vendor/google.golang.org/api/AUTHORS
deleted file mode 100644
index f73b7257..00000000
--- a/vendor/google.golang.org/api/AUTHORS
+++ /dev/null
@@ -1,10 +0,0 @@
-# This is the official list of authors for copyright purposes.
-# This file is distinct from the CONTRIBUTORS files.
-# See the latter for an explanation.
-
-# Names should be added to this file as
-# Name or Organization
-# The email address is not required for organizations.
-
-# Please keep the list sorted.
-Google Inc.
diff --git a/vendor/google.golang.org/api/CONTRIBUTING.md b/vendor/google.golang.org/api/CONTRIBUTING.md
deleted file mode 100644
index e4d36da3..00000000
--- a/vendor/google.golang.org/api/CONTRIBUTING.md
+++ /dev/null
@@ -1,484 +0,0 @@
-# Contributing to the Google API Go Client
-
-## Master git repo
-
-Our master git repo is https://code.googlesource.com/google-api-go-client
-
-## Pull Requests
-
-We do **NOT** use Github pull requests. We use Gerrit instead
-with the same workflow as Go. See below.
-
-## The source tree
-
-Most of this project is auto-generated.
-
-The notable directories which are not auto-generated:
-
-```
- google-api-go-generator/ -- the generator itself
- googleapi/ -- shared common code, used by auto-generated code
- examples/ -- sample code
-```
-
-# Contribution Guidelines
-
-## Introduction
-
-This document explains how to contribute changes to the google-api-go-client project.
-
-## Testing redux
-
-You've written and tested your code, but
-before sending code out for review, run all the tests for the whole
-tree to make sure the changes don't break other packages or programs:
-
-```
-$ make cached
-$ go test ./...
-...
-ok google.golang.org/api/google-api-go-generator 0.226s
-ok google.golang.org/api/googleapi 0.015s
-...
-```
-
-Ideally, you will add unit tests to one of the above directories to
-demonstrate the changes you are making and include the tests with your
-code review.
-
-## Code review
-
-Changes to google-api-go-client must be reviewed before they are submitted,
-no matter who makes the change.
-A custom git command called `git-codereview`,
-discussed below, helps manage the code review process through a Google-hosted
-[instance](https://code-review.googlesource.com/) of the code review
-system called [Gerrit](https://code.google.com/p/gerrit/).
-
-### Set up authentication for code review
-
-The Git code hosting server and Gerrit code review server both use a Google
-Account to authenticate. You therefore need a Google Account to proceed.
-(If you can use the account to
-[sign in at google.com](https://www.google.com/accounts/Login),
-you can use it to sign in to the code review server.)
-The email address you use with the code review system
-needs to be added to the [`CONTRIBUTORS`](/CONTRIBUTORS) file
-with your first code review.
-You can [create a Google Account](https://www.google.com/accounts/NewAccount)
-associated with any address where you receive email.
-
-Visit the site [code.googlesource.com](https://code.googlesource.com)
-and log in using your Google Account.
-Click on the "Generate Password" link that appears at the top of the page.
-
-Click the radio button that says "Only `code.googlesource.com`"
-to use this authentication token only for the google-api-go-client project.
-
-Further down the page is a box containing commands to install
-the authentication cookie in file called `.gitcookies` in your home
-directory.
-Copy the text for the commands into a Unix shell window to execute it.
-That will install the authentication token.
-
-(If you are on a Windows computer, you should instead follow the instructions
-in the yellow box to run the command.)
-
-### Register with Gerrit
-
-Now that you have a Google account and the authentication token,
-you need to register your account with Gerrit, the code review system.
-To do this, visit [golang.org/cl](https://golang.org/cl)
-and log in using the same Google Account you used above.
-That is all that is required.
-
-### Install the git-codereview command
-
-Now install the `git-codereview` command by running,
-
-```
-go get -u golang.org/x/review/git-codereview
-```
-
-Make sure `git-codereview` is installed in your shell path, so that the
-`git` command can find it. Check that
-
-```
-$ git codereview help
-```
-
-prints help text, not an error.
-
-Note to Git aficionados: The `git-codereview` command is not required to
-upload and manage Gerrit code reviews. For those who prefer plain Git, the text
-below gives the Git equivalent of each git-codereview command. If you do use plain
-Git, note that you still need the commit hooks that the git-codereview command
-configures; those hooks add a Gerrit `Change-Id` line to the commit
-message and check that all Go source files have been formatted with gofmt. Even
-if you intend to use plain Git for daily work, install the hooks in a new Git
-checkout by running `git-codereview hooks`.
-
-### Set up git aliases
-
-The `git-codereview` command can be run directly from the shell
-by typing, for instance,
-
-```
-$ git codereview sync
-```
-
-but it is more convenient to set up aliases for `git-codereview`'s own
-subcommands, so that the above becomes,
-
-```
-$ git sync
-```
-
-The `git-codereview` subcommands have been chosen to be distinct from
-Git's own, so it's safe to do so.
-
-The aliases are optional, but in the rest of this document we will assume
-they are installed.
-To install them, copy this text into your Git configuration file
-(usually `.gitconfig` in your home directory):
-
-```
-[alias]
- change = codereview change
- gofmt = codereview gofmt
- mail = codereview mail
- pending = codereview pending
- submit = codereview submit
- sync = codereview sync
-```
-
-### Understanding the git-codereview command
-
-After installing the `git-codereview` command, you can run
-
-```
-$ git codereview help
-```
-
-to learn more about its commands.
-You can also read the [command documentation](https://godoc.org/golang.org/x/review/git-codereview).
-
-### Switch to the master branch
-
-New changes should
-only be made based on the master branch.
-Before making a change, make sure you start on the master branch:
-
-```
-$ git checkout master
-$ git sync
-````
-
-(In Git terms, `git sync` runs
-`git pull -r`.)
-
-### Make a change
-
-The entire checked-out tree is writable.
-Once you have edited files, you must tell Git that they have been modified.
-You must also tell Git about any files that are added, removed, or renamed files.
-These operations are done with the usual Git commands,
-`git add`,
-`git rm`,
-and
-`git mv`.
-
-If you wish to checkpoint your work, or are ready to send the code out for review, run
-
-```
-$ git change
-```
-
-from any directory in your google-api-go-client repository to commit the changes so far.
-The name `` is an arbitrary one you choose to identify the
-local branch containing your changes.
-
-(In Git terms, `git change `
-runs `git checkout -b branch`,
-then `git branch --set-upstream-to origin/master`,
-then `git commit`.)
-
-Git will open a change description file in your editor.
-(It uses the editor named by the `$EDITOR` environment variable,
-`vi` by default.)
-The file will look like:
-
-```
-# Please enter the commit message for your changes. Lines starting
-# with '#' will be ignored, and an empty message aborts the commit.
-# On branch foo
-# Changes not staged for commit:
-# modified: editedfile.go
-#
-```
-
-At the beginning of this file is a blank line; replace it
-with a thorough description of your change.
-The first line of the change description is conventionally a one-line
-summary of the change, prefixed by `google-api-go-client:`,
-and is used as the subject for code review mail.
-The rest of the
-description elaborates and should provide context for the
-change and explain what it does.
-If there is a helpful reference, mention it here.
-
-After editing, the template might now read:
-
-```
-math: improved Sin, Cos and Tan precision for very large arguments
-
-The existing implementation has poor numerical properties for
-large arguments, so use the McGillicutty algorithm to improve
-accuracy above 1e10.
-
-The algorithm is described at http://wikipedia.org/wiki/McGillicutty_Algorithm
-
-Fixes #54
-
-# Please enter the commit message for your changes. Lines starting
-# with '#' will be ignored, and an empty message aborts the commit.
-# On branch foo
-# Changes not staged for commit:
-# modified: editedfile.go
-#
-```
-
-The commented section of the file lists all the modified files in your client.
-It is best to keep unrelated changes in different change lists,
-so if you see a file listed that should not be included, abort
-the command and move that file to a different branch.
-
-The special notation "Fixes #54" associates the change with issue 54 in the
-[google-api-go-client issue tracker](https://github.com/google/google-api-go-client/issues/54).
-When this change is eventually submitted, the issue
-tracker will automatically mark the issue as fixed.
-(There are several such conventions, described in detail in the
-[GitHub Issue Tracker documentation](https://help.github.com/articles/closing-issues-via-commit-messages/).)
-
-Once you have finished writing the commit message,
-save the file and exit the editor.
-
-If you wish to do more editing, re-stage your changes using
-`git add`, and then run
-
-```
-$ git change
-```
-
-to update the change description and incorporate the staged changes. The
-change description contains a `Change-Id` line near the bottom,
-added by a Git commit hook during the initial
-`git change`.
-That line is used by Gerrit to match successive uploads of the same change.
-Do not edit or delete it.
-
-(In Git terms, `git change` with no branch name
-runs `git commit --amend`.)
-
-### Mail the change for review
-
-Once the change is ready, mail it out for review:
-
-```
-$ git mail
-```
-
-You can specify a reviewer or CC interested parties
-using the `-r` or `-cc` options.
-Both accept a comma-separated list of email addresses:
-
-```
-$ git mail -r joe@golang.org -cc mabel@example.com,math-nuts@swtch.com
-```
-
-Unless explicitly told otherwise, such as in the discussion leading
-up to sending in the change list, please specify
-`bradfitz@golang.org`, `gmlewis@google.com`, or
-`mcgreevy@golang.org` as a reviewer.
-
-(In Git terms, `git mail` pushes the local committed
-changes to Gerrit using `git push origin HEAD:refs/for/master`.)
-
-If your change relates to an open issue, please add a comment to the issue
-announcing your proposed fix, including a link to your CL.
-
-The code review server assigns your change an issue number and URL,
-which `git mail` will print, something like:
-
-```
-remote: New Changes:
-remote: https://code-review.googlesource.com/99999 math: improved Sin, Cos and Tan precision for very large arguments
-```
-
-### Reviewing code
-
-Running `git mail` will send an email to you and the
-reviewers asking them to visit the issue's URL and make comments on the change.
-When done, the reviewer adds comments through the Gerrit user interface
-and clicks "Reply" to send comments back.
-You will receive a mail notification when this happens.
-You must reply through the web interface.
-
-### Revise and upload
-
-You must respond to review comments through the web interface.
-
-When you have revised the code and are ready for another round of review,
-stage those changes and use `git change` to update the
-commit.
-To send the update change list for another round of review,
-run `git mail` again.
-
-The reviewer can comment on the new copy, and the process repeats.
-The reviewer approves the change by giving it a positive score
-(+1 or +2) and replying `LGTM`: looks good to me.
-
-You can see a list of your pending changes by running
-`git pending`, and switch between change branches with
-`git change `.
-
-### Synchronize your client
-
-While you were working, others might have submitted changes to the repository.
-To update your local branch, run
-
-```
-$ git sync
-```
-
-(In git terms, `git sync` runs
-`git pull -r`.)
-
-If files you were editing have changed, Git does its best to merge the
-remote changes into your local changes.
-It may leave some files to merge by hand.
-
-For example, suppose you have edited `sin.go` but
-someone else has committed an independent change.
-When you run `git sync`,
-you will get the (scary-looking) output:
-
-```
-$ git sync
-Failed to merge in the changes.
-Patch failed at 0023 math: improved Sin, Cos and Tan precision for very large arguments
-The copy of the patch that failed is found in:
- /home/you/repo/.git/rebase-apply/patch
-
-When you have resolved this problem, run "git rebase --continue".
-If you prefer to skip this patch, run "git rebase --skip" instead.
-To check out the original branch and stop rebasing, run "git rebase --abort".
-```
-
-
-If this happens, run
-
-```
-$ git status
-```
-
-to see which files failed to merge.
-The output will look something like this:
-
-```
-rebase in progress; onto a24c3eb
-You are currently rebasing branch 'mcgillicutty' on 'a24c3eb'.
- (fix conflicts and then run "git rebase --continue")
- (use "git rebase --skip" to skip this patch)
- (use "git rebase --abort" to check out the original branch)
-
-Unmerged paths:
- (use "git reset HEAD ..." to unstage)
- (use "git add ..." to mark resolution)
-
- _both modified: sin.go_
-```
-
-
-The only important part in that transcript is the italicized "both modified"
-line: Git failed to merge your changes with the conflicting change.
-When this happens, Git leaves both sets of edits in the file,
-with conflicts marked by `<<<<<<<` and
-`>>>>>>>`.
-It is now your job to edit the file to combine them.
-Continuing the example, searching for those strings in `sin.go`
-might turn up:
-
-```
- arg = scale(arg)
-<<<<<<< HEAD
- if arg > 1e9 {
-=======
- if arg > 1e10 {
->>>>>>> mcgillicutty
- largeReduce(arg)
-```
-
-Git doesn't show it, but suppose the original text that both edits
-started with was 1e8; you changed it to 1e10 and the other change to 1e9,
-so the correct answer might now be 1e10. First, edit the section
-to remove the markers and leave the correct code:
-
-```
- arg = scale(arg)
- if arg > 1e10 {
- largeReduce(arg)
-```
-
-Then tell Git that the conflict is resolved by running
-
-```
-$ git add sin.go
-```
-
-If you had been editing the file, say for debugging, but do not
-care to preserve your changes, you can run
-`git reset HEAD sin.go`
-to abandon your changes.
-Then run `git rebase --continue` to
-restore the change commit.
-
-### Reviewing code by others
-
-You can import a change proposed by someone else into your local Git repository.
-On the Gerrit review page, click the "Download ▼" link in the upper right
-corner, copy the "Checkout" command and run it from your local Git repo.
-It should look something like this:
-
-```
-$ git fetch https://code.googlesource.com/review refs/changes/21/1221/1 && git checkout FETCH_HEAD
-```
-
-To revert, change back to the branch you were working in.
-
-### Submit the change after the review
-
-After the code has been `LGTM`'ed, an approver may
-submit it to the master branch using the Gerrit UI.
-There is a "Submit" button on the web page for the change
-that appears once the change is approved (marked +2).
-
-This checks the change into the repository.
-The change description will include a link to the code review,
-and the code review will be updated with a link to the change
-in the repository.
-Since the method used to integrate the changes is "Cherry Pick",
-the commit hashes in the repository will be changed by
-the submit operation.
-
-### More information
-
-In addition to the information here, the Go community maintains a [CodeReview](https://golang.org/wiki/CodeReview) wiki page.
-Feel free to contribute to this page as you learn the review process.
-
-## Contributors
-
-Files in the google-api-go-client repository don't list author names,
-both to avoid clutter and to avoid having to keep the lists up to date.
-Instead, please add your name to the [`CONTRIBUTORS`](/CONTRIBUTORS)
-file as your first code review, keeping the names in sorted order.
diff --git a/vendor/google.golang.org/api/CONTRIBUTORS b/vendor/google.golang.org/api/CONTRIBUTORS
deleted file mode 100644
index d712ce1e..00000000
--- a/vendor/google.golang.org/api/CONTRIBUTORS
+++ /dev/null
@@ -1,51 +0,0 @@
-# This is the official list of people who can contribute
-# (and typically have contributed) code to the repository.
-# The AUTHORS file lists the copyright holders; this file
-# lists people. For example, Google employees are listed here
-# but not in AUTHORS, because Google holds the copyright.
-#
-# The submission process automatically checks to make sure
-# that people submitting code are listed in this file (by email address).
-#
-# Names should be added to this file only after verifying that
-# the individual or the individual's organization has agreed to
-# the appropriate Contributor License Agreement, found here:
-#
-# https://cla.developers.google.com/about/google-individual
-# https://cla.developers.google.com/about/google-corporate
-#
-# The CLA can be filled out on the web:
-#
-# https://cla.developers.google.com/
-#
-# When adding J Random Contributor's name to this file,
-# either J's name or J's organization's name should be
-# added to the AUTHORS file, depending on whether the
-# individual or corporate CLA was used.
-
-# Names should be added to this file like so:
-# Name
-#
-# An entry with two email addresses specifies that the
-# first address should be used in the submit logs and
-# that the second address should be recognized as the
-# same person when interacting with Rietveld.
-
-# Please keep the list sorted.
-
-Alain Vongsouvanhalainv
-Andrew Gerrand
-Brad Fitzpatrick
-Dragoslav Mitrinovic
-Eric Koleda
-Francesc Campoy
-Garrick Evans
-Glenn Lewis
-Ivan Krasin
-Jason Hall
-Johan Euphrosine
-Kostik Shtoyk
-Michael McGreevy
-Nick Craig-Wood
-Scott Van Woudenberg
-Takashi Matsuo
diff --git a/vendor/google.golang.org/api/GettingStarted.md b/vendor/google.golang.org/api/GettingStarted.md
deleted file mode 100644
index 37f13aba..00000000
--- a/vendor/google.golang.org/api/GettingStarted.md
+++ /dev/null
@@ -1,122 +0,0 @@
-# Getting Started with the Google APIs for Go
-
-## Getting Started
-
-This is a quick walk-through of how to get started with the Google APIs for Go.
-
-## Background
-
-The first thing to understand is that the Google API libraries are auto-generated for
-each language, including Go, so they may not feel like 100% natural for any language.
-The Go versions are pretty natural, but please forgive any small non-idiomatic things.
-(Suggestions welcome, though!)
-
-## Installing
-
-Pick an API and a version of that API to install.
-You can find the complete list by looking at the
-[directories here](https://github.com/google/google-api-go-client/tree/master/).
-
-For example, let's install the
-[urlshortener's version 1 API](https://godoc.org/google.golang.org/api/urlshortener/v1):
-
-```
-$ go get google.golang.org/api/urlshortener/v1
-```
-
-Now it's ready for use in your code.
-
-## Using
-
-Once you've installed a library, you import it like this:
-
-```go
-package main
-
-import (
- "golang.org/x/net/context"
- "golang.org/x/oauth2"
- "golang.org/x/oauth2/google"
- "google.golang.org/api/urlshortener/v1"
-)
-```
-
-The package name, if you don't override it on your import line, is the name of the
-API without the version number. In the case above, just `urlshortener`.
-
-## Instantiating
-
-Each API has a `New` function taking an `*http.Client` and returning an API-specific `*Service`.
-
-You create the service like:
-
-```go
- svc, err := urlshortener.New(httpClient)
-```
-
-## OAuth HTTP Client
-
-The HTTP client you pass in to the service must be one that automatically adds
-Google-supported Authorization information to the requests.
-
-The best option is to use "golang.org/x/oauth2", an OAuth2 library for Go.
-You can see how to set up and use oauth2 with these APIs by checking out the
-[example code](https://github.com/google/google-api-go-client/tree/master/examples).
-
-In summary, you need to create an OAuth config:
-
-```go
- var config = &oauth2.Config{
- ClientID: "", // from https://console.developers.google.com/project//apiui/credential
- ClientSecret: "", // from https://console.developers.google.com/project//apiui/credential
- Endpoint: google.Endpoint,
- Scopes: []string{urlshortener.UrlshortenerScope},
- }
-```
-
-Then you need to get an OAuth Token from the user. This involves sending the user
-to a URL (at Google) to grant access to your application (either a web application
-or a desktop application), and then the browser redirects to the website or local
-application's webserver with the per-user token in the URL.
-
-Once you have that token,
-
-```go
- httpClient := newOAuthClient(context.Background(), config)
-```
-
-Then you're good to pass that client to the API's `New` function.
-
-## Using API Keys
-
-Some APIs require passing API keys from your application.
-To do this, you can use
-[transport.APIKey](http://godoc.org/google.golang.org/api/googleapi/transport#APIKey):
-
-```go
- ctx = context.WithValue(context.Background(), oauth2.HTTPClient, &http.Client{
- Transport: &transport.APIKey{Key: developerKey},
- })
- httpClient := newOAuthClient(ctx, config)
-```
-
-## Using the Service
-
-Each service contains zero or more methods and zero or more sub-services.
-The sub-services related to a specific type of "Resource".
-
-Those sub-services then contain their own methods.
-
-For instance, the urlshortener API has just the "Url" sub-service:
-
-```go
- url, err := svc.Url.Get(shortURL).Do()
- if err != nil {
- ...
- }
- fmt.Printf("The URL %s goes to %s\n", shortURL, url.LongUrl)
-```
-
-For a more complete example, see
-[urlshortener.go](https://github.com/google/google-api-go-client/tree/master/examples/urlshortener.go)
-in the [examples directory](https://github.com/google/google-api-go-client/tree/master/examples/).
diff --git a/vendor/google.golang.org/api/Makefile b/vendor/google.golang.org/api/Makefile
deleted file mode 100644
index 67ed10e2..00000000
--- a/vendor/google.golang.org/api/Makefile
+++ /dev/null
@@ -1,27 +0,0 @@
-API_JSON = $(wildcard */*/*-api.json)
-
-# Download all API specifications and rebuild Go bindings.
-# All downloaded files are cached in $TMPDIR for reuse with 'cached' below.
-all: generator
- $(GOPATH)/bin/google-api-go-generator -cache=false -install -api=*
-
-# Reuse cached API specifications in $TMPDIR and rebuild Go bindings.
-cached: generator
- $(GOPATH)/bin/google-api-go-generator -cache=true -install -api=*
-
-# Only rebuild Go bindings, do not modify API specifications.
-# For every existing */*/*-api.json file, */*/*-gen.go will be built.
-local: $(API_JSON:-api.json=-gen.go)
-
-# Pattern rule for the 'local' target.
-# Translates otherwise unnamed targets with a -gen.go suffix into the
-# matching input file with a -api.json suffix. $< is the input file.
-%-gen.go: %-api.json generator
- $(GOPATH)/bin/google-api-go-generator -api_json_file=$<
-
-# Rebuild and install $(GOPATH)/bin/google-api-go-generator
-generator:
- go install google.golang.org/api/googleapi
- go install google.golang.org/api/google-api-go-generator
-
-.PHONY: all cached local generator
diff --git a/vendor/google.golang.org/api/NOTES b/vendor/google.golang.org/api/NOTES
deleted file mode 100644
index 571f6ec7..00000000
--- a/vendor/google.golang.org/api/NOTES
+++ /dev/null
@@ -1,13 +0,0 @@
-Discovery Service:
-https://developers.google.com/discovery/
-https://developers.google.com/discovery/v1/reference/
-
-The "type" key:
-http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1
-
-The "format" key:
-http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23
-https://developers.google.com/discovery/v1/type-format
-
-Google JSON format docs:
-http://google-styleguide.googlecode.com/svn/trunk/jsoncstyleguide.xml
diff --git a/vendor/google.golang.org/api/README.md b/vendor/google.golang.org/api/README.md
deleted file mode 100644
index b562c2f4..00000000
--- a/vendor/google.golang.org/api/README.md
+++ /dev/null
@@ -1,92 +0,0 @@
-# Google APIs Client Library for Go
-
-## Status
-[](https://travis-ci.org/google/google-api-go-client)
-
-These are auto-generated Go libraries from the Google Discovery Service's JSON description files of the available "new style" Google APIs.
-
-Due to the auto-generated nature of this collection of libraries, complete APIs or specific versions can appear or go away without notice.
-As a result, you should always locally vendor any API(s) that your code relies upon.
-
-Announcement email:
-
-* http://groups.google.com/group/golang-nuts/browse_thread/thread/6c7281450be9a21e
-
-Getting started documentation:
-
-* https://github.com/google/google-api-go-client/blob/master/GettingStarted.md
-
-In summary:
-
-```
-$ go get google.golang.org/api/storage/v1
-$ go get google.golang.org/api/tasks/v1
-$ go get google.golang.org/api/moderator/v1
-... etc ...
-```
-
-For docs, see e.g.:
-
-* https://godoc.org/google.golang.org/api/storage/v1
-
-The package of a given import is the second-to-last component, before the version number.
-
-For examples, see:
-
-* https://github.com/google/google-api-go-client/tree/master/examples
-
-For support, use the golang-nuts@ mailing list:
-
-* https://groups.google.com/group/golang-nuts
-
-## Application Default Credentials Example
-
-Application Default Credentials provide a simplified way to obtain credentials
-for authenticating with Google APIs.
-
-The Application Default Credentials authenticate as the application itself,
-which make them great for working with Google Cloud APIs like Storage or
-Datastore. They are the recommended form of authentication when building
-applications that run on Google Compute Engine or Google App Engine.
-
-Default credentials are provided by the `golang.org/x/oauth2/google` package. To use them, add the following import:
-
-```
-import "golang.org/x/oauth2/google"
-```
-
-Some credentials types require you to specify scopes, and service entry points may not inject them. If you encounter this situation you may need to specify scopes as follows:
-
-```
-import (
- "golang.org/x/net/context"
- "golang.org/x/oauth2/google"
- "google.golang.org/api/compute/v1"
-)
-
-func main() {
- // Use oauth2.NoContext if there isn't a good context to pass in.
- ctx := context.Background()
-
- client, err := google.DefaultClient(ctx, compute.ComputeScope)
- if err != nil {
- //...
- }
- computeService, err := compute.New(client)
- if err != nil {
- //...
- }
-}
-```
-
-If you need a `oauth2.TokenSource`, use the `DefaultTokenSource` function:
-
-```
-ts, err := google.DefaultTokenSource(ctx, scope1, scope2, ...)
-if err != nil {
- //...
-}
-client := oauth2.NewClient(ctx, ts)
-```
-
-See also: [golang.org/x/oauth2/google](https://godoc.org/golang.org/x/oauth2/google) package documentation.
diff --git a/vendor/google.golang.org/api/TODO b/vendor/google.golang.org/api/TODO
deleted file mode 100644
index de2467c3..00000000
--- a/vendor/google.golang.org/api/TODO
+++ /dev/null
@@ -1,2 +0,0 @@
-Moved to:
-https://github.com/google/google-api-go-client/issues
diff --git a/vendor/google.golang.org/api/adexchangebuyer/v1.2/adexchangebuyer-api.json b/vendor/google.golang.org/api/adexchangebuyer/v1.2/adexchangebuyer-api.json
deleted file mode 100644
index bbb72b26..00000000
--- a/vendor/google.golang.org/api/adexchangebuyer/v1.2/adexchangebuyer-api.json
+++ /dev/null
@@ -1,596 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/NUnz0H_oWow0qcTRC55iG-5RpbM\"",
- "discoveryVersion": "v1",
- "id": "adexchangebuyer:v1.2",
- "name": "adexchangebuyer",
- "canonicalName": "Ad Exchange Buyer",
- "version": "v1.2",
- "revision": "20150909",
- "title": "Ad Exchange Buyer API",
- "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/adexchangebuyer/v1.2/",
- "basePath": "/adexchangebuyer/v1.2/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "adexchangebuyer/v1.2/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/adexchange.buyer": {
- "description": "Manage your Ad Exchange buyer account configuration"
- }
- }
- }
- },
- "schemas": {
- "Account": {
- "id": "Account",
- "type": "object",
- "description": "Configuration data for an Ad Exchange buyer account.",
- "properties": {
- "bidderLocation": {
- "type": "array",
- "description": "Your bidder locations that have distinct URLs.",
- "items": {
- "type": "object",
- "properties": {
- "maximumQps": {
- "type": "integer",
- "description": "The maximum queries per second the Ad Exchange will send.",
- "format": "int32"
- },
- "region": {
- "type": "string",
- "description": "The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values: \n- ASIA \n- EUROPE \n- US_EAST \n- US_WEST"
- },
- "url": {
- "type": "string",
- "description": "The URL to which the Ad Exchange will send bid requests."
- }
- }
- }
- },
- "cookieMatchingNid": {
- "type": "string",
- "description": "The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this."
- },
- "cookieMatchingUrl": {
- "type": "string",
- "description": "The base URL used in cookie match requests."
- },
- "id": {
- "type": "integer",
- "description": "Account id.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#account"
- },
- "maximumActiveCreatives": {
- "type": "integer",
- "description": "The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. Please contact your technical account manager if you need to change this.",
- "format": "int32"
- },
- "maximumTotalQps": {
- "type": "integer",
- "description": "The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.",
- "format": "int32"
- },
- "numberActiveCreatives": {
- "type": "integer",
- "description": "The number of creatives that this account inserted or bid with in the last 30 days.",
- "format": "int32"
- }
- }
- },
- "AccountsList": {
- "id": "AccountsList",
- "type": "object",
- "description": "An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of accounts.",
- "items": {
- "$ref": "Account"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#accountsList"
- }
- }
- },
- "Creative": {
- "id": "Creative",
- "type": "object",
- "description": "A creative and its classification data.",
- "properties": {
- "HTMLSnippet": {
- "type": "string",
- "description": "The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set."
- },
- "accountId": {
- "type": "integer",
- "description": "Account id.",
- "format": "int32",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "advertiserId": {
- "type": "array",
- "description": "Detected advertiser id, if any. Read-only. This field should not be set in requests.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "advertiserName": {
- "type": "string",
- "description": "The name of the company being advertised in the creative.",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "agencyId": {
- "type": "string",
- "description": "The agency id for this creative.",
- "format": "int64"
- },
- "api_upload_timestamp": {
- "type": "string",
- "description": "The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).",
- "format": "date-time"
- },
- "attribute": {
- "type": "array",
- "description": "All attributes for the ads that may be shown from this snippet.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "buyerCreativeId": {
- "type": "string",
- "description": "A buyer-specific id identifying the creative in this ad.",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "clickThroughUrl": {
- "type": "array",
- "description": "The set of destination urls for the snippet.",
- "items": {
- "type": "string"
- },
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "corrections": {
- "type": "array",
- "description": "Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.",
- "items": {
- "type": "object",
- "properties": {
- "details": {
- "type": "array",
- "description": "Additional details about the correction.",
- "items": {
- "type": "string"
- }
- },
- "reason": {
- "type": "string",
- "description": "The type of correction that was applied to the creative."
- }
- }
- }
- },
- "disapprovalReasons": {
- "type": "array",
- "description": "The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.",
- "items": {
- "type": "object",
- "properties": {
- "details": {
- "type": "array",
- "description": "Additional details about the reason for disapproval.",
- "items": {
- "type": "string"
- }
- },
- "reason": {
- "type": "string",
- "description": "The categorized reason for disapproval."
- }
- }
- }
- },
- "filteringReasons": {
- "type": "object",
- "description": "The filtering reasons for the creative. Read-only. This field should not be set in requests.",
- "properties": {
- "date": {
- "type": "string",
- "description": "The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST."
- },
- "reasons": {
- "type": "array",
- "description": "The filtering reasons.",
- "items": {
- "type": "object",
- "properties": {
- "filteringCount": {
- "type": "string",
- "description": "The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.",
- "format": "int64"
- },
- "filteringStatus": {
- "type": "integer",
- "description": "The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.",
- "format": "int32"
- }
- }
- }
- }
- }
- },
- "height": {
- "type": "integer",
- "description": "Ad height.",
- "format": "int32",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "impressionTrackingUrl": {
- "type": "array",
- "description": "The set of urls to be called to record an impression.",
- "items": {
- "type": "string"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#creative"
- },
- "productCategories": {
- "type": "array",
- "description": "Detected product categories, if any. Read-only. This field should not be set in requests.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "restrictedCategories": {
- "type": "array",
- "description": "All restricted categories for the ads that may be shown from this snippet.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "sensitiveCategories": {
- "type": "array",
- "description": "Detected sensitive categories, if any. Read-only. This field should not be set in requests.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "status": {
- "type": "string",
- "description": "Creative serving status. Read-only. This field should not be set in requests."
- },
- "vendorType": {
- "type": "array",
- "description": "All vendor types for the ads that may be shown from this snippet.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "version": {
- "type": "integer",
- "description": "The version for this creative. Read-only. This field should not be set in requests.",
- "format": "int32"
- },
- "videoURL": {
- "type": "string",
- "description": "The url to fetch a video ad. If set, HTMLSnippet should not be set."
- },
- "width": {
- "type": "integer",
- "description": "Ad width.",
- "format": "int32",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- }
- }
- },
- "CreativesList": {
- "id": "CreativesList",
- "type": "object",
- "description": "The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of creatives.",
- "items": {
- "$ref": "Creative"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#creativesList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through creatives. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- }
- },
- "resources": {
- "accounts": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.accounts.get",
- "path": "accounts/{id}",
- "httpMethod": "GET",
- "description": "Gets one account by ID.",
- "parameters": {
- "id": {
- "type": "integer",
- "description": "The account id",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.accounts.list",
- "path": "accounts",
- "httpMethod": "GET",
- "description": "Retrieves the authenticated user's list of accounts.",
- "response": {
- "$ref": "AccountsList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "patch": {
- "id": "adexchangebuyer.accounts.patch",
- "path": "accounts/{id}",
- "httpMethod": "PATCH",
- "description": "Updates an existing account. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "integer",
- "description": "The account id",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "update": {
- "id": "adexchangebuyer.accounts.update",
- "path": "accounts/{id}",
- "httpMethod": "PUT",
- "description": "Updates an existing account.",
- "parameters": {
- "id": {
- "type": "integer",
- "description": "The account id",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "creatives": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.creatives.get",
- "path": "creatives/{accountId}/{buyerCreativeId}",
- "httpMethod": "GET",
- "description": "Gets the status for a single creative. A creative will be available 30-40 minutes after submission.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "The id for the account that will serve this creative.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "buyerCreativeId": {
- "type": "string",
- "description": "The buyer-specific id for this creative.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "buyerCreativeId"
- ],
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "insert": {
- "id": "adexchangebuyer.creatives.insert",
- "path": "creatives",
- "httpMethod": "POST",
- "description": "Submit a new creative.",
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.creatives.list",
- "path": "creatives",
- "httpMethod": "GET",
- "description": "Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
- "format": "uint32",
- "minimum": "1",
- "maximum": "1000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response. Optional.",
- "location": "query"
- },
- "statusFilter": {
- "type": "string",
- "description": "When specified, only creatives having the given status are returned.",
- "enum": [
- "approved",
- "disapproved",
- "not_checked"
- ],
- "enumDescriptions": [
- "Creatives which have been approved.",
- "Creatives which have been disapproved.",
- "Creatives whose status is not yet checked."
- ],
- "location": "query"
- }
- },
- "response": {
- "$ref": "CreativesList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/adexchangebuyer/v1.2/adexchangebuyer-gen.go b/vendor/google.golang.org/api/adexchangebuyer/v1.2/adexchangebuyer-gen.go
deleted file mode 100644
index c4f977cd..00000000
--- a/vendor/google.golang.org/api/adexchangebuyer/v1.2/adexchangebuyer-gen.go
+++ /dev/null
@@ -1,1367 +0,0 @@
-// Package adexchangebuyer provides access to the Ad Exchange Buyer API.
-//
-// See https://developers.google.com/ad-exchange/buyer-rest
-//
-// Usage example:
-//
-// import "google.golang.org/api/adexchangebuyer/v1.2"
-// ...
-// adexchangebuyerService, err := adexchangebuyer.New(oauthHttpClient)
-package adexchangebuyer // import "google.golang.org/api/adexchangebuyer/v1.2"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "adexchangebuyer:v1.2"
-const apiName = "adexchangebuyer"
-const apiVersion = "v1.2"
-const basePath = "https://www.googleapis.com/adexchangebuyer/v1.2/"
-
-// OAuth2 scopes used by this API.
-const (
- // Manage your Ad Exchange buyer account configuration
- AdexchangeBuyerScope = "https://www.googleapis.com/auth/adexchange.buyer"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Accounts = NewAccountsService(s)
- s.Creatives = NewCreativesService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Accounts *AccountsService
-
- Creatives *CreativesService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewAccountsService(s *Service) *AccountsService {
- rs := &AccountsService{s: s}
- return rs
-}
-
-type AccountsService struct {
- s *Service
-}
-
-func NewCreativesService(s *Service) *CreativesService {
- rs := &CreativesService{s: s}
- return rs
-}
-
-type CreativesService struct {
- s *Service
-}
-
-// Account: Configuration data for an Ad Exchange buyer account.
-type Account struct {
- // BidderLocation: Your bidder locations that have distinct URLs.
- BidderLocation []*AccountBidderLocation `json:"bidderLocation,omitempty"`
-
- // CookieMatchingNid: The nid parameter value used in cookie match
- // requests. Please contact your technical account manager if you need
- // to change this.
- CookieMatchingNid string `json:"cookieMatchingNid,omitempty"`
-
- // CookieMatchingUrl: The base URL used in cookie match requests.
- CookieMatchingUrl string `json:"cookieMatchingUrl,omitempty"`
-
- // Id: Account id.
- Id int64 `json:"id,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // MaximumActiveCreatives: The maximum number of active creatives that
- // an account can have, where a creative is active if it was inserted or
- // bid with in the last 30 days. Please contact your technical account
- // manager if you need to change this.
- MaximumActiveCreatives int64 `json:"maximumActiveCreatives,omitempty"`
-
- // MaximumTotalQps: The sum of all bidderLocation.maximumQps values
- // cannot exceed this. Please contact your technical account manager if
- // you need to change this.
- MaximumTotalQps int64 `json:"maximumTotalQps,omitempty"`
-
- // NumberActiveCreatives: The number of creatives that this account
- // inserted or bid with in the last 30 days.
- NumberActiveCreatives int64 `json:"numberActiveCreatives,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "BidderLocation") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Account) MarshalJSON() ([]byte, error) {
- type noMethod Account
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AccountBidderLocation struct {
- // MaximumQps: The maximum queries per second the Ad Exchange will send.
- MaximumQps int64 `json:"maximumQps,omitempty"`
-
- // Region: The geographical region the Ad Exchange should send requests
- // from. Only used by some quota systems, but always setting the value
- // is recommended. Allowed values:
- // - ASIA
- // - EUROPE
- // - US_EAST
- // - US_WEST
- Region string `json:"region,omitempty"`
-
- // Url: The URL to which the Ad Exchange will send bid requests.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "MaximumQps") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountBidderLocation) MarshalJSON() ([]byte, error) {
- type noMethod AccountBidderLocation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountsList: An account feed lists Ad Exchange buyer accounts that
-// the user has access to. Each entry in the feed corresponds to a
-// single buyer account.
-type AccountsList struct {
- // Items: A list of accounts.
- Items []*Account `json:"items,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountsList) MarshalJSON() ([]byte, error) {
- type noMethod AccountsList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Creative: A creative and its classification data.
-type Creative struct {
- // HTMLSnippet: The HTML snippet that displays the ad when inserted in
- // the web page. If set, videoURL should not be set.
- HTMLSnippet string `json:"HTMLSnippet,omitempty"`
-
- // AccountId: Account id.
- AccountId int64 `json:"accountId,omitempty"`
-
- // AdvertiserId: Detected advertiser id, if any. Read-only. This field
- // should not be set in requests.
- AdvertiserId googleapi.Int64s `json:"advertiserId,omitempty"`
-
- // AdvertiserName: The name of the company being advertised in the
- // creative.
- AdvertiserName string `json:"advertiserName,omitempty"`
-
- // AgencyId: The agency id for this creative.
- AgencyId int64 `json:"agencyId,omitempty,string"`
-
- // ApiUploadTimestamp: The last upload timestamp of this creative if it
- // was uploaded via API. Read-only. The value of this field is
- // generated, and will be ignored for uploads. (formatted RFC 3339
- // timestamp).
- ApiUploadTimestamp string `json:"api_upload_timestamp,omitempty"`
-
- // Attribute: All attributes for the ads that may be shown from this
- // snippet.
- Attribute []int64 `json:"attribute,omitempty"`
-
- // BuyerCreativeId: A buyer-specific id identifying the creative in this
- // ad.
- BuyerCreativeId string `json:"buyerCreativeId,omitempty"`
-
- // ClickThroughUrl: The set of destination urls for the snippet.
- ClickThroughUrl []string `json:"clickThroughUrl,omitempty"`
-
- // Corrections: Shows any corrections that were applied to this
- // creative. Read-only. This field should not be set in requests.
- Corrections []*CreativeCorrections `json:"corrections,omitempty"`
-
- // DisapprovalReasons: The reasons for disapproval, if any. Note that
- // not all disapproval reasons may be categorized, so it is possible for
- // the creative to have a status of DISAPPROVED with an empty list for
- // disapproval_reasons. In this case, please reach out to your TAM to
- // help debug the issue. Read-only. This field should not be set in
- // requests.
- DisapprovalReasons []*CreativeDisapprovalReasons `json:"disapprovalReasons,omitempty"`
-
- // FilteringReasons: The filtering reasons for the creative. Read-only.
- // This field should not be set in requests.
- FilteringReasons *CreativeFilteringReasons `json:"filteringReasons,omitempty"`
-
- // Height: Ad height.
- Height int64 `json:"height,omitempty"`
-
- // ImpressionTrackingUrl: The set of urls to be called to record an
- // impression.
- ImpressionTrackingUrl []string `json:"impressionTrackingUrl,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // ProductCategories: Detected product categories, if any. Read-only.
- // This field should not be set in requests.
- ProductCategories []int64 `json:"productCategories,omitempty"`
-
- // RestrictedCategories: All restricted categories for the ads that may
- // be shown from this snippet.
- RestrictedCategories []int64 `json:"restrictedCategories,omitempty"`
-
- // SensitiveCategories: Detected sensitive categories, if any.
- // Read-only. This field should not be set in requests.
- SensitiveCategories []int64 `json:"sensitiveCategories,omitempty"`
-
- // Status: Creative serving status. Read-only. This field should not be
- // set in requests.
- Status string `json:"status,omitempty"`
-
- // VendorType: All vendor types for the ads that may be shown from this
- // snippet.
- VendorType []int64 `json:"vendorType,omitempty"`
-
- // Version: The version for this creative. Read-only. This field should
- // not be set in requests.
- Version int64 `json:"version,omitempty"`
-
- // VideoURL: The url to fetch a video ad. If set, HTMLSnippet should not
- // be set.
- VideoURL string `json:"videoURL,omitempty"`
-
- // Width: Ad width.
- Width int64 `json:"width,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "HTMLSnippet") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Creative) MarshalJSON() ([]byte, error) {
- type noMethod Creative
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CreativeCorrections struct {
- // Details: Additional details about the correction.
- Details []string `json:"details,omitempty"`
-
- // Reason: The type of correction that was applied to the creative.
- Reason string `json:"reason,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Details") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeCorrections) MarshalJSON() ([]byte, error) {
- type noMethod CreativeCorrections
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CreativeDisapprovalReasons struct {
- // Details: Additional details about the reason for disapproval.
- Details []string `json:"details,omitempty"`
-
- // Reason: The categorized reason for disapproval.
- Reason string `json:"reason,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Details") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeDisapprovalReasons) MarshalJSON() ([]byte, error) {
- type noMethod CreativeDisapprovalReasons
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeFilteringReasons: The filtering reasons for the creative.
-// Read-only. This field should not be set in requests.
-type CreativeFilteringReasons struct {
- // Date: The date in ISO 8601 format for the data. The data is collected
- // from 00:00:00 to 23:59:59 in PST.
- Date string `json:"date,omitempty"`
-
- // Reasons: The filtering reasons.
- Reasons []*CreativeFilteringReasonsReasons `json:"reasons,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Date") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeFilteringReasons) MarshalJSON() ([]byte, error) {
- type noMethod CreativeFilteringReasons
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CreativeFilteringReasonsReasons struct {
- // FilteringCount: The number of times the creative was filtered for the
- // status. The count is aggregated across all publishers on the
- // exchange.
- FilteringCount int64 `json:"filteringCount,omitempty,string"`
-
- // FilteringStatus: The filtering status code. Please refer to the
- // creative-status-codes.txt file for different statuses.
- FilteringStatus int64 `json:"filteringStatus,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "FilteringCount") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeFilteringReasonsReasons) MarshalJSON() ([]byte, error) {
- type noMethod CreativeFilteringReasonsReasons
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativesList: The creatives feed lists the active creatives for the
-// Ad Exchange buyer accounts that the user has access to. Each entry in
-// the feed corresponds to a single creative.
-type CreativesList struct {
- // Items: A list of creatives.
- Items []*Creative `json:"items,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through creatives. To
- // retrieve the next page of results, set the next request's "pageToken"
- // value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativesList) MarshalJSON() ([]byte, error) {
- type noMethod CreativesList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "adexchangebuyer.accounts.get":
-
-type AccountsGetCall struct {
- s *Service
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one account by ID.
-func (r *AccountsService) Get(id int64) *AccountsGetCall {
- c := &AccountsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsGetCall) Fields(s ...googleapi.Field) *AccountsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsGetCall) IfNoneMatch(entityTag string) *AccountsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsGetCall) Context(ctx context.Context) *AccountsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.accounts.get" call.
-// Exactly one of *Account or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Account.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsGetCall) Do() (*Account, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Account{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one account by ID.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.accounts.get",
- // "parameterOrder": [
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "The account id",
- // "format": "int32",
- // "location": "path",
- // "required": true,
- // "type": "integer"
- // }
- // },
- // "path": "accounts/{id}",
- // "response": {
- // "$ref": "Account"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.accounts.list":
-
-type AccountsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the authenticated user's list of accounts.
-func (r *AccountsService) List() *AccountsListCall {
- c := &AccountsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsListCall) Fields(s ...googleapi.Field) *AccountsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsListCall) IfNoneMatch(entityTag string) *AccountsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsListCall) Context(ctx context.Context) *AccountsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.accounts.list" call.
-// Exactly one of *AccountsList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AccountsList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccountsListCall) Do() (*AccountsList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountsList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the authenticated user's list of accounts.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.accounts.list",
- // "path": "accounts",
- // "response": {
- // "$ref": "AccountsList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.accounts.patch":
-
-type AccountsPatchCall struct {
- s *Service
- id int64
- account *Account
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing account. This method supports patch
-// semantics.
-func (r *AccountsService) Patch(id int64, account *Account) *AccountsPatchCall {
- c := &AccountsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.id = id
- c.account = account
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsPatchCall) Fields(s ...googleapi.Field) *AccountsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsPatchCall) Context(ctx context.Context) *AccountsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.account)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.accounts.patch" call.
-// Exactly one of *Account or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Account.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsPatchCall) Do() (*Account, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Account{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing account. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "adexchangebuyer.accounts.patch",
- // "parameterOrder": [
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "The account id",
- // "format": "int32",
- // "location": "path",
- // "required": true,
- // "type": "integer"
- // }
- // },
- // "path": "accounts/{id}",
- // "request": {
- // "$ref": "Account"
- // },
- // "response": {
- // "$ref": "Account"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.accounts.update":
-
-type AccountsUpdateCall struct {
- s *Service
- id int64
- account *Account
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing account.
-func (r *AccountsService) Update(id int64, account *Account) *AccountsUpdateCall {
- c := &AccountsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.id = id
- c.account = account
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsUpdateCall) Fields(s ...googleapi.Field) *AccountsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsUpdateCall) Context(ctx context.Context) *AccountsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.account)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.accounts.update" call.
-// Exactly one of *Account or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Account.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsUpdateCall) Do() (*Account, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Account{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing account.",
- // "httpMethod": "PUT",
- // "id": "adexchangebuyer.accounts.update",
- // "parameterOrder": [
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "The account id",
- // "format": "int32",
- // "location": "path",
- // "required": true,
- // "type": "integer"
- // }
- // },
- // "path": "accounts/{id}",
- // "request": {
- // "$ref": "Account"
- // },
- // "response": {
- // "$ref": "Account"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.creatives.get":
-
-type CreativesGetCall struct {
- s *Service
- accountId int64
- buyerCreativeId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets the status for a single creative. A creative will be
-// available 30-40 minutes after submission.
-func (r *CreativesService) Get(accountId int64, buyerCreativeId string) *CreativesGetCall {
- c := &CreativesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.buyerCreativeId = buyerCreativeId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativesGetCall) Fields(s ...googleapi.Field) *CreativesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CreativesGetCall) IfNoneMatch(entityTag string) *CreativesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativesGetCall) Context(ctx context.Context) *CreativesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "creatives/{accountId}/{buyerCreativeId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": strconv.FormatInt(c.accountId, 10),
- "buyerCreativeId": c.buyerCreativeId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.creatives.get" call.
-// Exactly one of *Creative or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Creative.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CreativesGetCall) Do() (*Creative, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Creative{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the status for a single creative. A creative will be available 30-40 minutes after submission.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.creatives.get",
- // "parameterOrder": [
- // "accountId",
- // "buyerCreativeId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The id for the account that will serve this creative.",
- // "format": "int32",
- // "location": "path",
- // "required": true,
- // "type": "integer"
- // },
- // "buyerCreativeId": {
- // "description": "The buyer-specific id for this creative.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "creatives/{accountId}/{buyerCreativeId}",
- // "response": {
- // "$ref": "Creative"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.creatives.insert":
-
-type CreativesInsertCall struct {
- s *Service
- creative *Creative
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Submit a new creative.
-func (r *CreativesService) Insert(creative *Creative) *CreativesInsertCall {
- c := &CreativesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.creative = creative
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativesInsertCall) Fields(s ...googleapi.Field) *CreativesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativesInsertCall) Context(ctx context.Context) *CreativesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creative)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "creatives")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.creatives.insert" call.
-// Exactly one of *Creative or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Creative.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CreativesInsertCall) Do() (*Creative, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Creative{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Submit a new creative.",
- // "httpMethod": "POST",
- // "id": "adexchangebuyer.creatives.insert",
- // "path": "creatives",
- // "request": {
- // "$ref": "Creative"
- // },
- // "response": {
- // "$ref": "Creative"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.creatives.list":
-
-type CreativesListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of the authenticated user's active creatives.
-// A creative will be available 30-40 minutes after submission.
-func (r *CreativesService) List() *CreativesListCall {
- c := &CreativesListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of entries returned on one result page. If not set, the default is
-// 100.
-func (c *CreativesListCall) MaxResults(maxResults int64) *CreativesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad clients. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *CreativesListCall) PageToken(pageToken string) *CreativesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// StatusFilter sets the optional parameter "statusFilter": When
-// specified, only creatives having the given status are returned.
-//
-// Possible values:
-// "approved" - Creatives which have been approved.
-// "disapproved" - Creatives which have been disapproved.
-// "not_checked" - Creatives whose status is not yet checked.
-func (c *CreativesListCall) StatusFilter(statusFilter string) *CreativesListCall {
- c.opt_["statusFilter"] = statusFilter
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativesListCall) Fields(s ...googleapi.Field) *CreativesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CreativesListCall) IfNoneMatch(entityTag string) *CreativesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativesListCall) Context(ctx context.Context) *CreativesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["statusFilter"]; ok {
- params.Set("statusFilter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "creatives")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.creatives.list" call.
-// Exactly one of *CreativesList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CreativesList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativesListCall) Do() (*CreativesList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativesList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.creatives.list",
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "1000",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response. Optional.",
- // "location": "query",
- // "type": "string"
- // },
- // "statusFilter": {
- // "description": "When specified, only creatives having the given status are returned.",
- // "enum": [
- // "approved",
- // "disapproved",
- // "not_checked"
- // ],
- // "enumDescriptions": [
- // "Creatives which have been approved.",
- // "Creatives which have been disapproved.",
- // "Creatives whose status is not yet checked."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "creatives",
- // "response": {
- // "$ref": "CreativesList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/adexchangebuyer/v1.3/adexchangebuyer-api.json b/vendor/google.golang.org/api/adexchangebuyer/v1.3/adexchangebuyer-api.json
deleted file mode 100644
index 068e18ce..00000000
--- a/vendor/google.golang.org/api/adexchangebuyer/v1.3/adexchangebuyer-api.json
+++ /dev/null
@@ -1,1655 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/s43VGxh95gMJhn2XULgCPUEFl2w\"",
- "discoveryVersion": "v1",
- "id": "adexchangebuyer:v1.3",
- "name": "adexchangebuyer",
- "canonicalName": "Ad Exchange Buyer",
- "version": "v1.3",
- "revision": "20150909",
- "title": "Ad Exchange Buyer API",
- "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/adexchangebuyer/v1.3/",
- "basePath": "/adexchangebuyer/v1.3/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "adexchangebuyer/v1.3/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/adexchange.buyer": {
- "description": "Manage your Ad Exchange buyer account configuration"
- }
- }
- }
- },
- "schemas": {
- "Account": {
- "id": "Account",
- "type": "object",
- "description": "Configuration data for an Ad Exchange buyer account.",
- "properties": {
- "bidderLocation": {
- "type": "array",
- "description": "Your bidder locations that have distinct URLs.",
- "items": {
- "type": "object",
- "properties": {
- "maximumQps": {
- "type": "integer",
- "description": "The maximum queries per second the Ad Exchange will send.",
- "format": "int32"
- },
- "region": {
- "type": "string",
- "description": "The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values: \n- ASIA \n- EUROPE \n- US_EAST \n- US_WEST"
- },
- "url": {
- "type": "string",
- "description": "The URL to which the Ad Exchange will send bid requests."
- }
- }
- }
- },
- "cookieMatchingNid": {
- "type": "string",
- "description": "The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this."
- },
- "cookieMatchingUrl": {
- "type": "string",
- "description": "The base URL used in cookie match requests."
- },
- "id": {
- "type": "integer",
- "description": "Account id.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#account"
- },
- "maximumActiveCreatives": {
- "type": "integer",
- "description": "The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. Please contact your technical account manager if you need to change this.",
- "format": "int32"
- },
- "maximumTotalQps": {
- "type": "integer",
- "description": "The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.",
- "format": "int32"
- },
- "numberActiveCreatives": {
- "type": "integer",
- "description": "The number of creatives that this account inserted or bid with in the last 30 days.",
- "format": "int32"
- }
- }
- },
- "AccountsList": {
- "id": "AccountsList",
- "type": "object",
- "description": "An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of accounts.",
- "items": {
- "$ref": "Account"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#accountsList"
- }
- }
- },
- "BillingInfo": {
- "id": "BillingInfo",
- "type": "object",
- "description": "The configuration data for an Ad Exchange billing info.",
- "properties": {
- "accountId": {
- "type": "integer",
- "description": "Account id.",
- "format": "int32"
- },
- "accountName": {
- "type": "string",
- "description": "Account name."
- },
- "billingId": {
- "type": "array",
- "description": "A list of adgroup IDs associated with this particular account. These IDs may show up as part of a realtime bidding BidRequest, which indicates a bid request for this account.",
- "items": {
- "type": "string"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#billingInfo"
- }
- }
- },
- "BillingInfoList": {
- "id": "BillingInfoList",
- "type": "object",
- "description": "A billing info feed lists Billing Info the Ad Exchange buyer account has access to. Each entry in the feed corresponds to a single billing info.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of billing info relevant for your account.",
- "items": {
- "$ref": "BillingInfo"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#billingInfoList"
- }
- }
- },
- "Budget": {
- "id": "Budget",
- "type": "object",
- "description": "The configuration data for Ad Exchange RTB - Budget API.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The id of the account. This is required for get and update requests.",
- "format": "int64"
- },
- "billingId": {
- "type": "string",
- "description": "The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.",
- "format": "int64"
- },
- "budgetAmount": {
- "type": "string",
- "description": "The budget amount to apply for the billingId provided. This is required for update requests.",
- "format": "int64"
- },
- "currencyCode": {
- "type": "string",
- "description": "The currency code for the buyer. This cannot be altered here."
- },
- "id": {
- "type": "string",
- "description": "The unique id that describes this item."
- },
- "kind": {
- "type": "string",
- "description": "The kind of the resource, i.e. \"adexchangebuyer#budget\".",
- "default": "adexchangebuyer#budget"
- }
- }
- },
- "Creative": {
- "id": "Creative",
- "type": "object",
- "description": "A creative and its classification data.",
- "properties": {
- "HTMLSnippet": {
- "type": "string",
- "description": "The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set."
- },
- "accountId": {
- "type": "integer",
- "description": "Account id.",
- "format": "int32",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "advertiserId": {
- "type": "array",
- "description": "Detected advertiser id, if any. Read-only. This field should not be set in requests.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "advertiserName": {
- "type": "string",
- "description": "The name of the company being advertised in the creative.",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "agencyId": {
- "type": "string",
- "description": "The agency id for this creative.",
- "format": "int64"
- },
- "api_upload_timestamp": {
- "type": "string",
- "description": "The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).",
- "format": "date-time"
- },
- "attribute": {
- "type": "array",
- "description": "All attributes for the ads that may be shown from this snippet.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "buyerCreativeId": {
- "type": "string",
- "description": "A buyer-specific id identifying the creative in this ad.",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "clickThroughUrl": {
- "type": "array",
- "description": "The set of destination urls for the snippet.",
- "items": {
- "type": "string"
- },
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "corrections": {
- "type": "array",
- "description": "Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.",
- "items": {
- "type": "object",
- "properties": {
- "details": {
- "type": "array",
- "description": "Additional details about the correction.",
- "items": {
- "type": "string"
- }
- },
- "reason": {
- "type": "string",
- "description": "The type of correction that was applied to the creative."
- }
- }
- }
- },
- "disapprovalReasons": {
- "type": "array",
- "description": "The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.",
- "items": {
- "type": "object",
- "properties": {
- "details": {
- "type": "array",
- "description": "Additional details about the reason for disapproval.",
- "items": {
- "type": "string"
- }
- },
- "reason": {
- "type": "string",
- "description": "The categorized reason for disapproval."
- }
- }
- }
- },
- "filteringReasons": {
- "type": "object",
- "description": "The filtering reasons for the creative. Read-only. This field should not be set in requests.",
- "properties": {
- "date": {
- "type": "string",
- "description": "The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST."
- },
- "reasons": {
- "type": "array",
- "description": "The filtering reasons.",
- "items": {
- "type": "object",
- "properties": {
- "filteringCount": {
- "type": "string",
- "description": "The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.",
- "format": "int64"
- },
- "filteringStatus": {
- "type": "integer",
- "description": "The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.",
- "format": "int32"
- }
- }
- }
- }
- }
- },
- "height": {
- "type": "integer",
- "description": "Ad height.",
- "format": "int32",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "impressionTrackingUrl": {
- "type": "array",
- "description": "The set of urls to be called to record an impression.",
- "items": {
- "type": "string"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#creative"
- },
- "nativeAd": {
- "type": "object",
- "description": "If nativeAd is set, HTMLSnippet and videoURL should not be set.",
- "properties": {
- "advertiser": {
- "type": "string"
- },
- "appIcon": {
- "type": "object",
- "description": "The app icon, for app download ads.",
- "properties": {
- "height": {
- "type": "integer",
- "format": "int32"
- },
- "url": {
- "type": "string"
- },
- "width": {
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "body": {
- "type": "string",
- "description": "A long description of the ad."
- },
- "callToAction": {
- "type": "string",
- "description": "A label for the button that the user is supposed to click."
- },
- "clickTrackingUrl": {
- "type": "string",
- "description": "The URL to use for click tracking."
- },
- "headline": {
- "type": "string",
- "description": "A short title for the ad."
- },
- "image": {
- "type": "object",
- "description": "A large image.",
- "properties": {
- "height": {
- "type": "integer",
- "format": "int32"
- },
- "url": {
- "type": "string"
- },
- "width": {
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "impressionTrackingUrl": {
- "type": "array",
- "description": "The URLs are called when the impression is rendered.",
- "items": {
- "type": "string"
- }
- },
- "logo": {
- "type": "object",
- "description": "A smaller image, for the advertiser logo.",
- "properties": {
- "height": {
- "type": "integer",
- "format": "int32"
- },
- "url": {
- "type": "string"
- },
- "width": {
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "price": {
- "type": "string",
- "description": "The price of the promoted app including the currency info."
- },
- "starRating": {
- "type": "number",
- "description": "The app rating in the app store. Must be in the range [0-5].",
- "format": "double"
- },
- "store": {
- "type": "string",
- "description": "The URL to the app store to purchase/download the promoted app."
- }
- }
- },
- "productCategories": {
- "type": "array",
- "description": "Detected product categories, if any. Read-only. This field should not be set in requests.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "restrictedCategories": {
- "type": "array",
- "description": "All restricted categories for the ads that may be shown from this snippet.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "sensitiveCategories": {
- "type": "array",
- "description": "Detected sensitive categories, if any. Read-only. This field should not be set in requests.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "status": {
- "type": "string",
- "description": "Creative serving status. Read-only. This field should not be set in requests."
- },
- "vendorType": {
- "type": "array",
- "description": "All vendor types for the ads that may be shown from this snippet.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "version": {
- "type": "integer",
- "description": "The version for this creative. Read-only. This field should not be set in requests.",
- "format": "int32"
- },
- "videoURL": {
- "type": "string",
- "description": "The url to fetch a video ad. If set, HTMLSnippet should not be set."
- },
- "width": {
- "type": "integer",
- "description": "Ad width.",
- "format": "int32",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- }
- }
- },
- "CreativesList": {
- "id": "CreativesList",
- "type": "object",
- "description": "The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of creatives.",
- "items": {
- "$ref": "Creative"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#creativesList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through creatives. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "DirectDeal": {
- "id": "DirectDeal",
- "type": "object",
- "description": "The configuration data for an Ad Exchange direct deal.",
- "properties": {
- "accountId": {
- "type": "integer",
- "description": "The account id of the buyer this deal is for.",
- "format": "int32"
- },
- "advertiser": {
- "type": "string",
- "description": "The name of the advertiser this deal is for."
- },
- "currencyCode": {
- "type": "string",
- "description": "The currency code that applies to the fixed_cpm value. If not set then assumed to be USD."
- },
- "endTime": {
- "type": "string",
- "description": "End time for when this deal stops being active. If not set then this deal is valid until manually disabled by the publisher. In seconds since the epoch.",
- "format": "int64"
- },
- "fixedCpm": {
- "type": "string",
- "description": "The fixed price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the fixed price tier of buying (highest priority, pay exactly the configured fixed price).",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "Deal id.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#directDeal"
- },
- "name": {
- "type": "string",
- "description": "Deal name."
- },
- "privateExchangeMinCpm": {
- "type": "string",
- "description": "The minimum price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the private exchange tier of buying (below fixed price priority, run as a second price auction).",
- "format": "int64"
- },
- "publisherBlocksOverriden": {
- "type": "boolean",
- "description": "If true, the publisher has opted to have their blocks ignored when a creative is bid with for this deal."
- },
- "sellerNetwork": {
- "type": "string",
- "description": "The name of the publisher offering this direct deal."
- },
- "startTime": {
- "type": "string",
- "description": "Start time for when this deal becomes active. If not set then this deal is active immediately upon creation. In seconds since the epoch.",
- "format": "int64"
- }
- }
- },
- "DirectDealsList": {
- "id": "DirectDealsList",
- "type": "object",
- "description": "A direct deals feed lists Direct Deals the Ad Exchange buyer account has access to. This includes direct deals set up for the buyer account as well as its merged stream seats.",
- "properties": {
- "directDeals": {
- "type": "array",
- "description": "A list of direct deals relevant for your account.",
- "items": {
- "$ref": "DirectDeal"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#directDealsList"
- }
- }
- },
- "PerformanceReport": {
- "id": "PerformanceReport",
- "type": "object",
- "description": "The configuration data for an Ad Exchange performance report list.",
- "properties": {
- "bidRate": {
- "type": "number",
- "description": "The number of bid responses with an ad.",
- "format": "double"
- },
- "bidRequestRate": {
- "type": "number",
- "description": "The number of bid requests sent to your bidder.",
- "format": "double"
- },
- "calloutStatusRate": {
- "type": "array",
- "description": "Rate of various prefiltering statuses per match. Please refer to the callout-status-codes.txt file for different statuses.",
- "items": {
- "type": "any"
- }
- },
- "cookieMatcherStatusRate": {
- "type": "array",
- "description": "Average QPS for cookie matcher operations.",
- "items": {
- "type": "any"
- }
- },
- "creativeStatusRate": {
- "type": "array",
- "description": "Rate of ads with a given status. Please refer to the creative-status-codes.txt file for different statuses.",
- "items": {
- "type": "any"
- }
- },
- "filteredBidRate": {
- "type": "number",
- "description": "The number of bid responses that were filtered due to a policy violation or other errors.",
- "format": "double"
- },
- "hostedMatchStatusRate": {
- "type": "array",
- "description": "Average QPS for hosted match operations.",
- "items": {
- "type": "any"
- }
- },
- "inventoryMatchRate": {
- "type": "number",
- "description": "The number of potential queries based on your pretargeting settings.",
- "format": "double"
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#performanceReport"
- },
- "latency50thPercentile": {
- "type": "number",
- "description": "The 50th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
- "format": "double"
- },
- "latency85thPercentile": {
- "type": "number",
- "description": "The 85th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
- "format": "double"
- },
- "latency95thPercentile": {
- "type": "number",
- "description": "The 95th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
- "format": "double"
- },
- "noQuotaInRegion": {
- "type": "number",
- "description": "Rate of various quota account statuses per quota check.",
- "format": "double"
- },
- "outOfQuota": {
- "type": "number",
- "description": "Rate of various quota account statuses per quota check.",
- "format": "double"
- },
- "pixelMatchRequests": {
- "type": "number",
- "description": "Average QPS for pixel match requests from clients.",
- "format": "double"
- },
- "pixelMatchResponses": {
- "type": "number",
- "description": "Average QPS for pixel match responses from clients.",
- "format": "double"
- },
- "quotaConfiguredLimit": {
- "type": "number",
- "description": "The configured quota limits for this account.",
- "format": "double"
- },
- "quotaThrottledLimit": {
- "type": "number",
- "description": "The throttled quota limits for this account.",
- "format": "double"
- },
- "region": {
- "type": "string",
- "description": "The trading location of this data."
- },
- "successfulRequestRate": {
- "type": "number",
- "description": "The number of properly formed bid responses received by our servers within the deadline.",
- "format": "double"
- },
- "timestamp": {
- "type": "string",
- "description": "The unix timestamp of the starting time of this performance data.",
- "format": "int64"
- },
- "unsuccessfulRequestRate": {
- "type": "number",
- "description": "The number of bid responses that were unsuccessful due to timeouts, incorrect formatting, etc.",
- "format": "double"
- }
- }
- },
- "PerformanceReportList": {
- "id": "PerformanceReportList",
- "type": "object",
- "description": "The configuration data for an Ad Exchange performance report list. https://sites.google.com/a/google.com/adx-integration/Home/engineering/binary-releases/rtb-api-release https://cs.corp.google.com/#piper///depot/google3/contentads/adx/tools/rtb_api/adxrtb.py",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#performanceReportList"
- },
- "performanceReport": {
- "type": "array",
- "description": "A list of performance reports relevant for the account.",
- "items": {
- "$ref": "PerformanceReport"
- }
- }
- }
- },
- "PretargetingConfig": {
- "id": "PretargetingConfig",
- "type": "object",
- "properties": {
- "billingId": {
- "type": "string",
- "description": "The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.",
- "format": "int64"
- },
- "configId": {
- "type": "string",
- "description": "The config id; generated automatically. Leave this field blank for insert requests.",
- "format": "int64"
- },
- "configName": {
- "type": "string",
- "description": "The name of the config. Must be unique. Required for all requests."
- },
- "creativeType": {
- "type": "array",
- "description": "List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.",
- "items": {
- "type": "string"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.",
- "items": {
- "type": "object",
- "properties": {
- "height": {
- "type": "string",
- "description": "Height in pixels.",
- "format": "int64"
- },
- "width": {
- "type": "string",
- "description": "Width in pixels.",
- "format": "int64"
- }
- }
- }
- },
- "excludedContentLabels": {
- "type": "array",
- "description": "Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "excludedGeoCriteriaIds": {
- "type": "array",
- "description": "Requests containing any of these geo criteria ids will not match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "excludedPlacements": {
- "type": "array",
- "description": "Requests containing any of these placements will not match.",
- "items": {
- "type": "object",
- "properties": {
- "token": {
- "type": "string",
- "description": "The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement."
- },
- "type": {
- "type": "string",
- "description": "The type of the placement."
- }
- }
- }
- },
- "excludedUserLists": {
- "type": "array",
- "description": "Requests containing any of these users list ids will not match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "excludedVerticals": {
- "type": "array",
- "description": "Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "geoCriteriaIds": {
- "type": "array",
- "description": "Requests containing any of these geo criteria ids will match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "isActive": {
- "type": "boolean",
- "description": "Whether this config is active. Required for all requests."
- },
- "kind": {
- "type": "string",
- "description": "The kind of the resource, i.e. \"adexchangebuyer#pretargetingConfig\".",
- "default": "adexchangebuyer#pretargetingConfig"
- },
- "languages": {
- "type": "array",
- "description": "Request containing any of these language codes will match.",
- "items": {
- "type": "string"
- }
- },
- "mobileCarriers": {
- "type": "array",
- "description": "Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "mobileDevices": {
- "type": "array",
- "description": "Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "mobileOperatingSystemVersions": {
- "type": "array",
- "description": "Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "placements": {
- "type": "array",
- "description": "Requests containing any of these placements will match.",
- "items": {
- "type": "object",
- "properties": {
- "token": {
- "type": "string",
- "description": "The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement."
- },
- "type": {
- "type": "string",
- "description": "The type of the placement."
- }
- }
- }
- },
- "platforms": {
- "type": "array",
- "description": "Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.",
- "items": {
- "type": "string"
- }
- },
- "supportedCreativeAttributes": {
- "type": "array",
- "description": "Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "userLists": {
- "type": "array",
- "description": "Requests containing any of these user list ids will match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "vendorTypes": {
- "type": "array",
- "description": "Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "verticals": {
- "type": "array",
- "description": "Requests containing any of these vertical ids will match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- }
- }
- },
- "PretargetingConfigList": {
- "id": "PretargetingConfigList",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of pretargeting configs",
- "items": {
- "$ref": "PretargetingConfig"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#pretargetingConfigList"
- }
- }
- }
- },
- "resources": {
- "accounts": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.accounts.get",
- "path": "accounts/{id}",
- "httpMethod": "GET",
- "description": "Gets one account by ID.",
- "parameters": {
- "id": {
- "type": "integer",
- "description": "The account id",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.accounts.list",
- "path": "accounts",
- "httpMethod": "GET",
- "description": "Retrieves the authenticated user's list of accounts.",
- "response": {
- "$ref": "AccountsList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "patch": {
- "id": "adexchangebuyer.accounts.patch",
- "path": "accounts/{id}",
- "httpMethod": "PATCH",
- "description": "Updates an existing account. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "integer",
- "description": "The account id",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "update": {
- "id": "adexchangebuyer.accounts.update",
- "path": "accounts/{id}",
- "httpMethod": "PUT",
- "description": "Updates an existing account.",
- "parameters": {
- "id": {
- "type": "integer",
- "description": "The account id",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "billingInfo": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.billingInfo.get",
- "path": "billinginfo/{accountId}",
- "httpMethod": "GET",
- "description": "Returns the billing information for one account specified by account ID.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "The account id.",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "BillingInfo"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.billingInfo.list",
- "path": "billinginfo",
- "httpMethod": "GET",
- "description": "Retrieves a list of billing information for all accounts of the authenticated user.",
- "response": {
- "$ref": "BillingInfoList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "budget": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.budget.get",
- "path": "billinginfo/{accountId}/{billingId}",
- "httpMethod": "GET",
- "description": "Returns the budget information for the adgroup specified by the accountId and billingId.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to get the budget information for.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "billingId": {
- "type": "string",
- "description": "The billing id to get the budget information for.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "billingId"
- ],
- "response": {
- "$ref": "Budget"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "patch": {
- "id": "adexchangebuyer.budget.patch",
- "path": "billinginfo/{accountId}/{billingId}",
- "httpMethod": "PATCH",
- "description": "Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id associated with the budget being updated.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "billingId": {
- "type": "string",
- "description": "The billing id associated with the budget being updated.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "billingId"
- ],
- "request": {
- "$ref": "Budget"
- },
- "response": {
- "$ref": "Budget"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "update": {
- "id": "adexchangebuyer.budget.update",
- "path": "billinginfo/{accountId}/{billingId}",
- "httpMethod": "PUT",
- "description": "Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id associated with the budget being updated.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "billingId": {
- "type": "string",
- "description": "The billing id associated with the budget being updated.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "billingId"
- ],
- "request": {
- "$ref": "Budget"
- },
- "response": {
- "$ref": "Budget"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "creatives": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.creatives.get",
- "path": "creatives/{accountId}/{buyerCreativeId}",
- "httpMethod": "GET",
- "description": "Gets the status for a single creative. A creative will be available 30-40 minutes after submission.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "The id for the account that will serve this creative.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "buyerCreativeId": {
- "type": "string",
- "description": "The buyer-specific id for this creative.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "buyerCreativeId"
- ],
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "insert": {
- "id": "adexchangebuyer.creatives.insert",
- "path": "creatives",
- "httpMethod": "POST",
- "description": "Submit a new creative.",
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.creatives.list",
- "path": "creatives",
- "httpMethod": "GET",
- "description": "Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "When specified, only creatives for the given account ids are returned.",
- "format": "int32",
- "repeated": true,
- "location": "query"
- },
- "buyerCreativeId": {
- "type": "string",
- "description": "When specified, only creatives for the given buyer creative ids are returned.",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
- "format": "uint32",
- "minimum": "1",
- "maximum": "1000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response. Optional.",
- "location": "query"
- },
- "statusFilter": {
- "type": "string",
- "description": "When specified, only creatives having the given status are returned.",
- "enum": [
- "approved",
- "disapproved",
- "not_checked"
- ],
- "enumDescriptions": [
- "Creatives which have been approved.",
- "Creatives which have been disapproved.",
- "Creatives whose status is not yet checked."
- ],
- "location": "query"
- }
- },
- "response": {
- "$ref": "CreativesList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "directDeals": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.directDeals.get",
- "path": "directdeals/{id}",
- "httpMethod": "GET",
- "description": "Gets one direct deal by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "The direct deal id",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "response": {
- "$ref": "DirectDeal"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.directDeals.list",
- "path": "directdeals",
- "httpMethod": "GET",
- "description": "Retrieves the authenticated user's list of direct deals.",
- "response": {
- "$ref": "DirectDealsList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "performanceReport": {
- "methods": {
- "list": {
- "id": "adexchangebuyer.performanceReport.list",
- "path": "performancereport",
- "httpMethod": "GET",
- "description": "Retrieves the authenticated user's list of performance metrics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to get the reports.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "endDateTime": {
- "type": "string",
- "description": "The end time of the report in ISO 8601 timestamp format using UTC.",
- "required": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
- "format": "uint32",
- "minimum": "1",
- "maximum": "1000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through performance reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response. Optional.",
- "location": "query"
- },
- "startDateTime": {
- "type": "string",
- "description": "The start time of the report in ISO 8601 timestamp format using UTC.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "endDateTime",
- "startDateTime"
- ],
- "response": {
- "$ref": "PerformanceReportList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "pretargetingConfig": {
- "methods": {
- "delete": {
- "id": "adexchangebuyer.pretargetingConfig.delete",
- "path": "pretargetingconfigs/{accountId}/{configId}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing pretargeting config.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to delete the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "configId": {
- "type": "string",
- "description": "The specific id of the configuration to delete.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "configId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "get": {
- "id": "adexchangebuyer.pretargetingConfig.get",
- "path": "pretargetingconfigs/{accountId}/{configId}",
- "httpMethod": "GET",
- "description": "Gets a specific pretargeting configuration",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to get the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "configId": {
- "type": "string",
- "description": "The specific id of the configuration to retrieve.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "configId"
- ],
- "response": {
- "$ref": "PretargetingConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "insert": {
- "id": "adexchangebuyer.pretargetingConfig.insert",
- "path": "pretargetingconfigs/{accountId}",
- "httpMethod": "POST",
- "description": "Inserts a new pretargeting configuration.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to insert the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "request": {
- "$ref": "PretargetingConfig"
- },
- "response": {
- "$ref": "PretargetingConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.pretargetingConfig.list",
- "path": "pretargetingconfigs/{accountId}",
- "httpMethod": "GET",
- "description": "Retrieves a list of the authenticated user's pretargeting configurations.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to get the pretargeting configs for.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "PretargetingConfigList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "patch": {
- "id": "adexchangebuyer.pretargetingConfig.patch",
- "path": "pretargetingconfigs/{accountId}/{configId}",
- "httpMethod": "PATCH",
- "description": "Updates an existing pretargeting config. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to update the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "configId": {
- "type": "string",
- "description": "The specific id of the configuration to update.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "configId"
- ],
- "request": {
- "$ref": "PretargetingConfig"
- },
- "response": {
- "$ref": "PretargetingConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "update": {
- "id": "adexchangebuyer.pretargetingConfig.update",
- "path": "pretargetingconfigs/{accountId}/{configId}",
- "httpMethod": "PUT",
- "description": "Updates an existing pretargeting config.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to update the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "configId": {
- "type": "string",
- "description": "The specific id of the configuration to update.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "configId"
- ],
- "request": {
- "$ref": "PretargetingConfig"
- },
- "response": {
- "$ref": "PretargetingConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/adexchangebuyer/v1.3/adexchangebuyer-gen.go b/vendor/google.golang.org/api/adexchangebuyer/v1.3/adexchangebuyer-gen.go
deleted file mode 100644
index 41dd7589..00000000
--- a/vendor/google.golang.org/api/adexchangebuyer/v1.3/adexchangebuyer-gen.go
+++ /dev/null
@@ -1,3978 +0,0 @@
-// Package adexchangebuyer provides access to the Ad Exchange Buyer API.
-//
-// See https://developers.google.com/ad-exchange/buyer-rest
-//
-// Usage example:
-//
-// import "google.golang.org/api/adexchangebuyer/v1.3"
-// ...
-// adexchangebuyerService, err := adexchangebuyer.New(oauthHttpClient)
-package adexchangebuyer // import "google.golang.org/api/adexchangebuyer/v1.3"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "adexchangebuyer:v1.3"
-const apiName = "adexchangebuyer"
-const apiVersion = "v1.3"
-const basePath = "https://www.googleapis.com/adexchangebuyer/v1.3/"
-
-// OAuth2 scopes used by this API.
-const (
- // Manage your Ad Exchange buyer account configuration
- AdexchangeBuyerScope = "https://www.googleapis.com/auth/adexchange.buyer"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Accounts = NewAccountsService(s)
- s.BillingInfo = NewBillingInfoService(s)
- s.Budget = NewBudgetService(s)
- s.Creatives = NewCreativesService(s)
- s.DirectDeals = NewDirectDealsService(s)
- s.PerformanceReport = NewPerformanceReportService(s)
- s.PretargetingConfig = NewPretargetingConfigService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Accounts *AccountsService
-
- BillingInfo *BillingInfoService
-
- Budget *BudgetService
-
- Creatives *CreativesService
-
- DirectDeals *DirectDealsService
-
- PerformanceReport *PerformanceReportService
-
- PretargetingConfig *PretargetingConfigService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewAccountsService(s *Service) *AccountsService {
- rs := &AccountsService{s: s}
- return rs
-}
-
-type AccountsService struct {
- s *Service
-}
-
-func NewBillingInfoService(s *Service) *BillingInfoService {
- rs := &BillingInfoService{s: s}
- return rs
-}
-
-type BillingInfoService struct {
- s *Service
-}
-
-func NewBudgetService(s *Service) *BudgetService {
- rs := &BudgetService{s: s}
- return rs
-}
-
-type BudgetService struct {
- s *Service
-}
-
-func NewCreativesService(s *Service) *CreativesService {
- rs := &CreativesService{s: s}
- return rs
-}
-
-type CreativesService struct {
- s *Service
-}
-
-func NewDirectDealsService(s *Service) *DirectDealsService {
- rs := &DirectDealsService{s: s}
- return rs
-}
-
-type DirectDealsService struct {
- s *Service
-}
-
-func NewPerformanceReportService(s *Service) *PerformanceReportService {
- rs := &PerformanceReportService{s: s}
- return rs
-}
-
-type PerformanceReportService struct {
- s *Service
-}
-
-func NewPretargetingConfigService(s *Service) *PretargetingConfigService {
- rs := &PretargetingConfigService{s: s}
- return rs
-}
-
-type PretargetingConfigService struct {
- s *Service
-}
-
-// Account: Configuration data for an Ad Exchange buyer account.
-type Account struct {
- // BidderLocation: Your bidder locations that have distinct URLs.
- BidderLocation []*AccountBidderLocation `json:"bidderLocation,omitempty"`
-
- // CookieMatchingNid: The nid parameter value used in cookie match
- // requests. Please contact your technical account manager if you need
- // to change this.
- CookieMatchingNid string `json:"cookieMatchingNid,omitempty"`
-
- // CookieMatchingUrl: The base URL used in cookie match requests.
- CookieMatchingUrl string `json:"cookieMatchingUrl,omitempty"`
-
- // Id: Account id.
- Id int64 `json:"id,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // MaximumActiveCreatives: The maximum number of active creatives that
- // an account can have, where a creative is active if it was inserted or
- // bid with in the last 30 days. Please contact your technical account
- // manager if you need to change this.
- MaximumActiveCreatives int64 `json:"maximumActiveCreatives,omitempty"`
-
- // MaximumTotalQps: The sum of all bidderLocation.maximumQps values
- // cannot exceed this. Please contact your technical account manager if
- // you need to change this.
- MaximumTotalQps int64 `json:"maximumTotalQps,omitempty"`
-
- // NumberActiveCreatives: The number of creatives that this account
- // inserted or bid with in the last 30 days.
- NumberActiveCreatives int64 `json:"numberActiveCreatives,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "BidderLocation") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Account) MarshalJSON() ([]byte, error) {
- type noMethod Account
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AccountBidderLocation struct {
- // MaximumQps: The maximum queries per second the Ad Exchange will send.
- MaximumQps int64 `json:"maximumQps,omitempty"`
-
- // Region: The geographical region the Ad Exchange should send requests
- // from. Only used by some quota systems, but always setting the value
- // is recommended. Allowed values:
- // - ASIA
- // - EUROPE
- // - US_EAST
- // - US_WEST
- Region string `json:"region,omitempty"`
-
- // Url: The URL to which the Ad Exchange will send bid requests.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "MaximumQps") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountBidderLocation) MarshalJSON() ([]byte, error) {
- type noMethod AccountBidderLocation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountsList: An account feed lists Ad Exchange buyer accounts that
-// the user has access to. Each entry in the feed corresponds to a
-// single buyer account.
-type AccountsList struct {
- // Items: A list of accounts.
- Items []*Account `json:"items,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountsList) MarshalJSON() ([]byte, error) {
- type noMethod AccountsList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// BillingInfo: The configuration data for an Ad Exchange billing info.
-type BillingInfo struct {
- // AccountId: Account id.
- AccountId int64 `json:"accountId,omitempty"`
-
- // AccountName: Account name.
- AccountName string `json:"accountName,omitempty"`
-
- // BillingId: A list of adgroup IDs associated with this particular
- // account. These IDs may show up as part of a realtime bidding
- // BidRequest, which indicates a bid request for this account.
- BillingId []string `json:"billingId,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BillingInfo) MarshalJSON() ([]byte, error) {
- type noMethod BillingInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// BillingInfoList: A billing info feed lists Billing Info the Ad
-// Exchange buyer account has access to. Each entry in the feed
-// corresponds to a single billing info.
-type BillingInfoList struct {
- // Items: A list of billing info relevant for your account.
- Items []*BillingInfo `json:"items,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BillingInfoList) MarshalJSON() ([]byte, error) {
- type noMethod BillingInfoList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Budget: The configuration data for Ad Exchange RTB - Budget API.
-type Budget struct {
- // AccountId: The id of the account. This is required for get and update
- // requests.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // BillingId: The billing id to determine which adgroup to provide
- // budget information for. This is required for get and update requests.
- BillingId int64 `json:"billingId,omitempty,string"`
-
- // BudgetAmount: The budget amount to apply for the billingId provided.
- // This is required for update requests.
- BudgetAmount int64 `json:"budgetAmount,omitempty,string"`
-
- // CurrencyCode: The currency code for the buyer. This cannot be altered
- // here.
- CurrencyCode string `json:"currencyCode,omitempty"`
-
- // Id: The unique id that describes this item.
- Id string `json:"id,omitempty"`
-
- // Kind: The kind of the resource, i.e. "adexchangebuyer#budget".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Budget) MarshalJSON() ([]byte, error) {
- type noMethod Budget
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Creative: A creative and its classification data.
-type Creative struct {
- // HTMLSnippet: The HTML snippet that displays the ad when inserted in
- // the web page. If set, videoURL should not be set.
- HTMLSnippet string `json:"HTMLSnippet,omitempty"`
-
- // AccountId: Account id.
- AccountId int64 `json:"accountId,omitempty"`
-
- // AdvertiserId: Detected advertiser id, if any. Read-only. This field
- // should not be set in requests.
- AdvertiserId googleapi.Int64s `json:"advertiserId,omitempty"`
-
- // AdvertiserName: The name of the company being advertised in the
- // creative.
- AdvertiserName string `json:"advertiserName,omitempty"`
-
- // AgencyId: The agency id for this creative.
- AgencyId int64 `json:"agencyId,omitempty,string"`
-
- // ApiUploadTimestamp: The last upload timestamp of this creative if it
- // was uploaded via API. Read-only. The value of this field is
- // generated, and will be ignored for uploads. (formatted RFC 3339
- // timestamp).
- ApiUploadTimestamp string `json:"api_upload_timestamp,omitempty"`
-
- // Attribute: All attributes for the ads that may be shown from this
- // snippet.
- Attribute []int64 `json:"attribute,omitempty"`
-
- // BuyerCreativeId: A buyer-specific id identifying the creative in this
- // ad.
- BuyerCreativeId string `json:"buyerCreativeId,omitempty"`
-
- // ClickThroughUrl: The set of destination urls for the snippet.
- ClickThroughUrl []string `json:"clickThroughUrl,omitempty"`
-
- // Corrections: Shows any corrections that were applied to this
- // creative. Read-only. This field should not be set in requests.
- Corrections []*CreativeCorrections `json:"corrections,omitempty"`
-
- // DisapprovalReasons: The reasons for disapproval, if any. Note that
- // not all disapproval reasons may be categorized, so it is possible for
- // the creative to have a status of DISAPPROVED with an empty list for
- // disapproval_reasons. In this case, please reach out to your TAM to
- // help debug the issue. Read-only. This field should not be set in
- // requests.
- DisapprovalReasons []*CreativeDisapprovalReasons `json:"disapprovalReasons,omitempty"`
-
- // FilteringReasons: The filtering reasons for the creative. Read-only.
- // This field should not be set in requests.
- FilteringReasons *CreativeFilteringReasons `json:"filteringReasons,omitempty"`
-
- // Height: Ad height.
- Height int64 `json:"height,omitempty"`
-
- // ImpressionTrackingUrl: The set of urls to be called to record an
- // impression.
- ImpressionTrackingUrl []string `json:"impressionTrackingUrl,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // NativeAd: If nativeAd is set, HTMLSnippet and videoURL should not be
- // set.
- NativeAd *CreativeNativeAd `json:"nativeAd,omitempty"`
-
- // ProductCategories: Detected product categories, if any. Read-only.
- // This field should not be set in requests.
- ProductCategories []int64 `json:"productCategories,omitempty"`
-
- // RestrictedCategories: All restricted categories for the ads that may
- // be shown from this snippet.
- RestrictedCategories []int64 `json:"restrictedCategories,omitempty"`
-
- // SensitiveCategories: Detected sensitive categories, if any.
- // Read-only. This field should not be set in requests.
- SensitiveCategories []int64 `json:"sensitiveCategories,omitempty"`
-
- // Status: Creative serving status. Read-only. This field should not be
- // set in requests.
- Status string `json:"status,omitempty"`
-
- // VendorType: All vendor types for the ads that may be shown from this
- // snippet.
- VendorType []int64 `json:"vendorType,omitempty"`
-
- // Version: The version for this creative. Read-only. This field should
- // not be set in requests.
- Version int64 `json:"version,omitempty"`
-
- // VideoURL: The url to fetch a video ad. If set, HTMLSnippet should not
- // be set.
- VideoURL string `json:"videoURL,omitempty"`
-
- // Width: Ad width.
- Width int64 `json:"width,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "HTMLSnippet") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Creative) MarshalJSON() ([]byte, error) {
- type noMethod Creative
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CreativeCorrections struct {
- // Details: Additional details about the correction.
- Details []string `json:"details,omitempty"`
-
- // Reason: The type of correction that was applied to the creative.
- Reason string `json:"reason,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Details") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeCorrections) MarshalJSON() ([]byte, error) {
- type noMethod CreativeCorrections
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CreativeDisapprovalReasons struct {
- // Details: Additional details about the reason for disapproval.
- Details []string `json:"details,omitempty"`
-
- // Reason: The categorized reason for disapproval.
- Reason string `json:"reason,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Details") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeDisapprovalReasons) MarshalJSON() ([]byte, error) {
- type noMethod CreativeDisapprovalReasons
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeFilteringReasons: The filtering reasons for the creative.
-// Read-only. This field should not be set in requests.
-type CreativeFilteringReasons struct {
- // Date: The date in ISO 8601 format for the data. The data is collected
- // from 00:00:00 to 23:59:59 in PST.
- Date string `json:"date,omitempty"`
-
- // Reasons: The filtering reasons.
- Reasons []*CreativeFilteringReasonsReasons `json:"reasons,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Date") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeFilteringReasons) MarshalJSON() ([]byte, error) {
- type noMethod CreativeFilteringReasons
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CreativeFilteringReasonsReasons struct {
- // FilteringCount: The number of times the creative was filtered for the
- // status. The count is aggregated across all publishers on the
- // exchange.
- FilteringCount int64 `json:"filteringCount,omitempty,string"`
-
- // FilteringStatus: The filtering status code. Please refer to the
- // creative-status-codes.txt file for different statuses.
- FilteringStatus int64 `json:"filteringStatus,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "FilteringCount") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeFilteringReasonsReasons) MarshalJSON() ([]byte, error) {
- type noMethod CreativeFilteringReasonsReasons
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeNativeAd: If nativeAd is set, HTMLSnippet and videoURL should
-// not be set.
-type CreativeNativeAd struct {
- Advertiser string `json:"advertiser,omitempty"`
-
- // AppIcon: The app icon, for app download ads.
- AppIcon *CreativeNativeAdAppIcon `json:"appIcon,omitempty"`
-
- // Body: A long description of the ad.
- Body string `json:"body,omitempty"`
-
- // CallToAction: A label for the button that the user is supposed to
- // click.
- CallToAction string `json:"callToAction,omitempty"`
-
- // ClickTrackingUrl: The URL to use for click tracking.
- ClickTrackingUrl string `json:"clickTrackingUrl,omitempty"`
-
- // Headline: A short title for the ad.
- Headline string `json:"headline,omitempty"`
-
- // Image: A large image.
- Image *CreativeNativeAdImage `json:"image,omitempty"`
-
- // ImpressionTrackingUrl: The URLs are called when the impression is
- // rendered.
- ImpressionTrackingUrl []string `json:"impressionTrackingUrl,omitempty"`
-
- // Logo: A smaller image, for the advertiser logo.
- Logo *CreativeNativeAdLogo `json:"logo,omitempty"`
-
- // Price: The price of the promoted app including the currency info.
- Price string `json:"price,omitempty"`
-
- // StarRating: The app rating in the app store. Must be in the range
- // [0-5].
- StarRating float64 `json:"starRating,omitempty"`
-
- // Store: The URL to the app store to purchase/download the promoted
- // app.
- Store string `json:"store,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Advertiser") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeNativeAd) MarshalJSON() ([]byte, error) {
- type noMethod CreativeNativeAd
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeNativeAdAppIcon: The app icon, for app download ads.
-type CreativeNativeAdAppIcon struct {
- Height int64 `json:"height,omitempty"`
-
- Url string `json:"url,omitempty"`
-
- Width int64 `json:"width,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Height") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeNativeAdAppIcon) MarshalJSON() ([]byte, error) {
- type noMethod CreativeNativeAdAppIcon
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeNativeAdImage: A large image.
-type CreativeNativeAdImage struct {
- Height int64 `json:"height,omitempty"`
-
- Url string `json:"url,omitempty"`
-
- Width int64 `json:"width,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Height") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeNativeAdImage) MarshalJSON() ([]byte, error) {
- type noMethod CreativeNativeAdImage
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeNativeAdLogo: A smaller image, for the advertiser logo.
-type CreativeNativeAdLogo struct {
- Height int64 `json:"height,omitempty"`
-
- Url string `json:"url,omitempty"`
-
- Width int64 `json:"width,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Height") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeNativeAdLogo) MarshalJSON() ([]byte, error) {
- type noMethod CreativeNativeAdLogo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativesList: The creatives feed lists the active creatives for the
-// Ad Exchange buyer accounts that the user has access to. Each entry in
-// the feed corresponds to a single creative.
-type CreativesList struct {
- // Items: A list of creatives.
- Items []*Creative `json:"items,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through creatives. To
- // retrieve the next page of results, set the next request's "pageToken"
- // value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativesList) MarshalJSON() ([]byte, error) {
- type noMethod CreativesList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DirectDeal: The configuration data for an Ad Exchange direct deal.
-type DirectDeal struct {
- // AccountId: The account id of the buyer this deal is for.
- AccountId int64 `json:"accountId,omitempty"`
-
- // Advertiser: The name of the advertiser this deal is for.
- Advertiser string `json:"advertiser,omitempty"`
-
- // CurrencyCode: The currency code that applies to the fixed_cpm value.
- // If not set then assumed to be USD.
- CurrencyCode string `json:"currencyCode,omitempty"`
-
- // EndTime: End time for when this deal stops being active. If not set
- // then this deal is valid until manually disabled by the publisher. In
- // seconds since the epoch.
- EndTime int64 `json:"endTime,omitempty,string"`
-
- // FixedCpm: The fixed price for this direct deal. In cpm micros of
- // currency according to currency_code. If set, then this deal is
- // eligible for the fixed price tier of buying (highest priority, pay
- // exactly the configured fixed price).
- FixedCpm int64 `json:"fixedCpm,omitempty,string"`
-
- // Id: Deal id.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // Name: Deal name.
- Name string `json:"name,omitempty"`
-
- // PrivateExchangeMinCpm: The minimum price for this direct deal. In cpm
- // micros of currency according to currency_code. If set, then this deal
- // is eligible for the private exchange tier of buying (below fixed
- // price priority, run as a second price auction).
- PrivateExchangeMinCpm int64 `json:"privateExchangeMinCpm,omitempty,string"`
-
- // PublisherBlocksOverriden: If true, the publisher has opted to have
- // their blocks ignored when a creative is bid with for this deal.
- PublisherBlocksOverriden bool `json:"publisherBlocksOverriden,omitempty"`
-
- // SellerNetwork: The name of the publisher offering this direct deal.
- SellerNetwork string `json:"sellerNetwork,omitempty"`
-
- // StartTime: Start time for when this deal becomes active. If not set
- // then this deal is active immediately upon creation. In seconds since
- // the epoch.
- StartTime int64 `json:"startTime,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DirectDeal) MarshalJSON() ([]byte, error) {
- type noMethod DirectDeal
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DirectDealsList: A direct deals feed lists Direct Deals the Ad
-// Exchange buyer account has access to. This includes direct deals set
-// up for the buyer account as well as its merged stream seats.
-type DirectDealsList struct {
- // DirectDeals: A list of direct deals relevant for your account.
- DirectDeals []*DirectDeal `json:"directDeals,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "DirectDeals") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DirectDealsList) MarshalJSON() ([]byte, error) {
- type noMethod DirectDealsList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PerformanceReport: The configuration data for an Ad Exchange
-// performance report list.
-type PerformanceReport struct {
- // BidRate: The number of bid responses with an ad.
- BidRate float64 `json:"bidRate,omitempty"`
-
- // BidRequestRate: The number of bid requests sent to your bidder.
- BidRequestRate float64 `json:"bidRequestRate,omitempty"`
-
- // CalloutStatusRate: Rate of various prefiltering statuses per match.
- // Please refer to the callout-status-codes.txt file for different
- // statuses.
- CalloutStatusRate []interface{} `json:"calloutStatusRate,omitempty"`
-
- // CookieMatcherStatusRate: Average QPS for cookie matcher operations.
- CookieMatcherStatusRate []interface{} `json:"cookieMatcherStatusRate,omitempty"`
-
- // CreativeStatusRate: Rate of ads with a given status. Please refer to
- // the creative-status-codes.txt file for different statuses.
- CreativeStatusRate []interface{} `json:"creativeStatusRate,omitempty"`
-
- // FilteredBidRate: The number of bid responses that were filtered due
- // to a policy violation or other errors.
- FilteredBidRate float64 `json:"filteredBidRate,omitempty"`
-
- // HostedMatchStatusRate: Average QPS for hosted match operations.
- HostedMatchStatusRate []interface{} `json:"hostedMatchStatusRate,omitempty"`
-
- // InventoryMatchRate: The number of potential queries based on your
- // pretargeting settings.
- InventoryMatchRate float64 `json:"inventoryMatchRate,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // Latency50thPercentile: The 50th percentile round trip latency(ms) as
- // perceived from Google servers for the duration period covered by the
- // report.
- Latency50thPercentile float64 `json:"latency50thPercentile,omitempty"`
-
- // Latency85thPercentile: The 85th percentile round trip latency(ms) as
- // perceived from Google servers for the duration period covered by the
- // report.
- Latency85thPercentile float64 `json:"latency85thPercentile,omitempty"`
-
- // Latency95thPercentile: The 95th percentile round trip latency(ms) as
- // perceived from Google servers for the duration period covered by the
- // report.
- Latency95thPercentile float64 `json:"latency95thPercentile,omitempty"`
-
- // NoQuotaInRegion: Rate of various quota account statuses per quota
- // check.
- NoQuotaInRegion float64 `json:"noQuotaInRegion,omitempty"`
-
- // OutOfQuota: Rate of various quota account statuses per quota check.
- OutOfQuota float64 `json:"outOfQuota,omitempty"`
-
- // PixelMatchRequests: Average QPS for pixel match requests from
- // clients.
- PixelMatchRequests float64 `json:"pixelMatchRequests,omitempty"`
-
- // PixelMatchResponses: Average QPS for pixel match responses from
- // clients.
- PixelMatchResponses float64 `json:"pixelMatchResponses,omitempty"`
-
- // QuotaConfiguredLimit: The configured quota limits for this account.
- QuotaConfiguredLimit float64 `json:"quotaConfiguredLimit,omitempty"`
-
- // QuotaThrottledLimit: The throttled quota limits for this account.
- QuotaThrottledLimit float64 `json:"quotaThrottledLimit,omitempty"`
-
- // Region: The trading location of this data.
- Region string `json:"region,omitempty"`
-
- // SuccessfulRequestRate: The number of properly formed bid responses
- // received by our servers within the deadline.
- SuccessfulRequestRate float64 `json:"successfulRequestRate,omitempty"`
-
- // Timestamp: The unix timestamp of the starting time of this
- // performance data.
- Timestamp int64 `json:"timestamp,omitempty,string"`
-
- // UnsuccessfulRequestRate: The number of bid responses that were
- // unsuccessful due to timeouts, incorrect formatting, etc.
- UnsuccessfulRequestRate float64 `json:"unsuccessfulRequestRate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BidRate") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PerformanceReport) MarshalJSON() ([]byte, error) {
- type noMethod PerformanceReport
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PerformanceReportList: The configuration data for an Ad Exchange
-// performance report list.
-// https://sites.google.com/a/google.com/adx-integration/Home/engineering/binary-releases/rtb-api-release
-// https://cs.corp.google.com/#piper///depot/google3/contentads/adx/tools/rtb_api/adxrtb.py
-type PerformanceReportList struct {
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // PerformanceReport: A list of performance reports relevant for the
- // account.
- PerformanceReport []*PerformanceReport `json:"performanceReport,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PerformanceReportList) MarshalJSON() ([]byte, error) {
- type noMethod PerformanceReportList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type PretargetingConfig struct {
- // BillingId: The id for billing purposes, provided for reference. Leave
- // this field blank for insert requests; the id will be generated
- // automatically.
- BillingId int64 `json:"billingId,omitempty,string"`
-
- // ConfigId: The config id; generated automatically. Leave this field
- // blank for insert requests.
- ConfigId int64 `json:"configId,omitempty,string"`
-
- // ConfigName: The name of the config. Must be unique. Required for all
- // requests.
- ConfigName string `json:"configName,omitempty"`
-
- // CreativeType: List must contain exactly one of
- // PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
- CreativeType []string `json:"creativeType,omitempty"`
-
- // Dimensions: Requests which allow one of these (width, height) pairs
- // will match. All pairs must be supported ad dimensions.
- Dimensions []*PretargetingConfigDimensions `json:"dimensions,omitempty"`
-
- // ExcludedContentLabels: Requests with any of these content labels will
- // not match. Values are from content-labels.txt in the downloadable
- // files section.
- ExcludedContentLabels googleapi.Int64s `json:"excludedContentLabels,omitempty"`
-
- // ExcludedGeoCriteriaIds: Requests containing any of these geo criteria
- // ids will not match.
- ExcludedGeoCriteriaIds googleapi.Int64s `json:"excludedGeoCriteriaIds,omitempty"`
-
- // ExcludedPlacements: Requests containing any of these placements will
- // not match.
- ExcludedPlacements []*PretargetingConfigExcludedPlacements `json:"excludedPlacements,omitempty"`
-
- // ExcludedUserLists: Requests containing any of these users list ids
- // will not match.
- ExcludedUserLists googleapi.Int64s `json:"excludedUserLists,omitempty"`
-
- // ExcludedVerticals: Requests containing any of these vertical ids will
- // not match. Values are from the publisher-verticals.txt file in the
- // downloadable files section.
- ExcludedVerticals googleapi.Int64s `json:"excludedVerticals,omitempty"`
-
- // GeoCriteriaIds: Requests containing any of these geo criteria ids
- // will match.
- GeoCriteriaIds googleapi.Int64s `json:"geoCriteriaIds,omitempty"`
-
- // IsActive: Whether this config is active. Required for all requests.
- IsActive bool `json:"isActive,omitempty"`
-
- // Kind: The kind of the resource, i.e.
- // "adexchangebuyer#pretargetingConfig".
- Kind string `json:"kind,omitempty"`
-
- // Languages: Request containing any of these language codes will match.
- Languages []string `json:"languages,omitempty"`
-
- // MobileCarriers: Requests containing any of these mobile carrier ids
- // will match. Values are from mobile-carriers.csv in the downloadable
- // files section.
- MobileCarriers googleapi.Int64s `json:"mobileCarriers,omitempty"`
-
- // MobileDevices: Requests containing any of these mobile device ids
- // will match. Values are from mobile-devices.csv in the downloadable
- // files section.
- MobileDevices googleapi.Int64s `json:"mobileDevices,omitempty"`
-
- // MobileOperatingSystemVersions: Requests containing any of these
- // mobile operating system version ids will match. Values are from
- // mobile-os.csv in the downloadable files section.
- MobileOperatingSystemVersions googleapi.Int64s `json:"mobileOperatingSystemVersions,omitempty"`
-
- // Placements: Requests containing any of these placements will match.
- Placements []*PretargetingConfigPlacements `json:"placements,omitempty"`
-
- // Platforms: Requests matching any of these platforms will match.
- // Possible values are PRETARGETING_PLATFORM_MOBILE,
- // PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
- Platforms []string `json:"platforms,omitempty"`
-
- // SupportedCreativeAttributes: Creative attributes should be declared
- // here if all creatives corresponding to this pretargeting
- // configuration have that creative attribute. Values are from
- // pretargetable-creative-attributes.txt in the downloadable files
- // section.
- SupportedCreativeAttributes googleapi.Int64s `json:"supportedCreativeAttributes,omitempty"`
-
- // UserLists: Requests containing any of these user list ids will match.
- UserLists googleapi.Int64s `json:"userLists,omitempty"`
-
- // VendorTypes: Requests that allow any of these vendor ids will match.
- // Values are from vendors.txt in the downloadable files section.
- VendorTypes googleapi.Int64s `json:"vendorTypes,omitempty"`
-
- // Verticals: Requests containing any of these vertical ids will match.
- Verticals googleapi.Int64s `json:"verticals,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "BillingId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PretargetingConfig) MarshalJSON() ([]byte, error) {
- type noMethod PretargetingConfig
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type PretargetingConfigDimensions struct {
- // Height: Height in pixels.
- Height int64 `json:"height,omitempty,string"`
-
- // Width: Width in pixels.
- Width int64 `json:"width,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "Height") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PretargetingConfigDimensions) MarshalJSON() ([]byte, error) {
- type noMethod PretargetingConfigDimensions
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type PretargetingConfigExcludedPlacements struct {
- // Token: The value of the placement. Interpretation depends on the
- // placement type, e.g. URL for a site placement, channel name for a
- // channel placement, app id for a mobile app placement.
- Token string `json:"token,omitempty"`
-
- // Type: The type of the placement.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Token") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PretargetingConfigExcludedPlacements) MarshalJSON() ([]byte, error) {
- type noMethod PretargetingConfigExcludedPlacements
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type PretargetingConfigPlacements struct {
- // Token: The value of the placement. Interpretation depends on the
- // placement type, e.g. URL for a site placement, channel name for a
- // channel placement, app id for a mobile app placement.
- Token string `json:"token,omitempty"`
-
- // Type: The type of the placement.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Token") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PretargetingConfigPlacements) MarshalJSON() ([]byte, error) {
- type noMethod PretargetingConfigPlacements
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type PretargetingConfigList struct {
- // Items: A list of pretargeting configs
- Items []*PretargetingConfig `json:"items,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PretargetingConfigList) MarshalJSON() ([]byte, error) {
- type noMethod PretargetingConfigList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "adexchangebuyer.accounts.get":
-
-type AccountsGetCall struct {
- s *Service
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one account by ID.
-func (r *AccountsService) Get(id int64) *AccountsGetCall {
- c := &AccountsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsGetCall) Fields(s ...googleapi.Field) *AccountsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsGetCall) IfNoneMatch(entityTag string) *AccountsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsGetCall) Context(ctx context.Context) *AccountsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.accounts.get" call.
-// Exactly one of *Account or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Account.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsGetCall) Do() (*Account, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Account{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one account by ID.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.accounts.get",
- // "parameterOrder": [
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "The account id",
- // "format": "int32",
- // "location": "path",
- // "required": true,
- // "type": "integer"
- // }
- // },
- // "path": "accounts/{id}",
- // "response": {
- // "$ref": "Account"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.accounts.list":
-
-type AccountsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the authenticated user's list of accounts.
-func (r *AccountsService) List() *AccountsListCall {
- c := &AccountsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsListCall) Fields(s ...googleapi.Field) *AccountsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsListCall) IfNoneMatch(entityTag string) *AccountsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsListCall) Context(ctx context.Context) *AccountsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.accounts.list" call.
-// Exactly one of *AccountsList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AccountsList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccountsListCall) Do() (*AccountsList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountsList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the authenticated user's list of accounts.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.accounts.list",
- // "path": "accounts",
- // "response": {
- // "$ref": "AccountsList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.accounts.patch":
-
-type AccountsPatchCall struct {
- s *Service
- id int64
- account *Account
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing account. This method supports patch
-// semantics.
-func (r *AccountsService) Patch(id int64, account *Account) *AccountsPatchCall {
- c := &AccountsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.id = id
- c.account = account
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsPatchCall) Fields(s ...googleapi.Field) *AccountsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsPatchCall) Context(ctx context.Context) *AccountsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.account)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.accounts.patch" call.
-// Exactly one of *Account or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Account.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsPatchCall) Do() (*Account, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Account{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing account. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "adexchangebuyer.accounts.patch",
- // "parameterOrder": [
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "The account id",
- // "format": "int32",
- // "location": "path",
- // "required": true,
- // "type": "integer"
- // }
- // },
- // "path": "accounts/{id}",
- // "request": {
- // "$ref": "Account"
- // },
- // "response": {
- // "$ref": "Account"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.accounts.update":
-
-type AccountsUpdateCall struct {
- s *Service
- id int64
- account *Account
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing account.
-func (r *AccountsService) Update(id int64, account *Account) *AccountsUpdateCall {
- c := &AccountsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.id = id
- c.account = account
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsUpdateCall) Fields(s ...googleapi.Field) *AccountsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsUpdateCall) Context(ctx context.Context) *AccountsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.account)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.accounts.update" call.
-// Exactly one of *Account or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Account.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsUpdateCall) Do() (*Account, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Account{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing account.",
- // "httpMethod": "PUT",
- // "id": "adexchangebuyer.accounts.update",
- // "parameterOrder": [
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "The account id",
- // "format": "int32",
- // "location": "path",
- // "required": true,
- // "type": "integer"
- // }
- // },
- // "path": "accounts/{id}",
- // "request": {
- // "$ref": "Account"
- // },
- // "response": {
- // "$ref": "Account"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.billingInfo.get":
-
-type BillingInfoGetCall struct {
- s *Service
- accountId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the billing information for one account specified by
-// account ID.
-func (r *BillingInfoService) Get(accountId int64) *BillingInfoGetCall {
- c := &BillingInfoGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BillingInfoGetCall) Fields(s ...googleapi.Field) *BillingInfoGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *BillingInfoGetCall) IfNoneMatch(entityTag string) *BillingInfoGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BillingInfoGetCall) Context(ctx context.Context) *BillingInfoGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BillingInfoGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "billinginfo/{accountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": strconv.FormatInt(c.accountId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.billingInfo.get" call.
-// Exactly one of *BillingInfo or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *BillingInfo.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *BillingInfoGetCall) Do() (*BillingInfo, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &BillingInfo{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the billing information for one account specified by account ID.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.billingInfo.get",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The account id.",
- // "format": "int32",
- // "location": "path",
- // "required": true,
- // "type": "integer"
- // }
- // },
- // "path": "billinginfo/{accountId}",
- // "response": {
- // "$ref": "BillingInfo"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.billingInfo.list":
-
-type BillingInfoListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of billing information for all accounts of the
-// authenticated user.
-func (r *BillingInfoService) List() *BillingInfoListCall {
- c := &BillingInfoListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BillingInfoListCall) Fields(s ...googleapi.Field) *BillingInfoListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *BillingInfoListCall) IfNoneMatch(entityTag string) *BillingInfoListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BillingInfoListCall) Context(ctx context.Context) *BillingInfoListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BillingInfoListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "billinginfo")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.billingInfo.list" call.
-// Exactly one of *BillingInfoList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *BillingInfoList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *BillingInfoListCall) Do() (*BillingInfoList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &BillingInfoList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of billing information for all accounts of the authenticated user.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.billingInfo.list",
- // "path": "billinginfo",
- // "response": {
- // "$ref": "BillingInfoList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.budget.get":
-
-type BudgetGetCall struct {
- s *Service
- accountId int64
- billingId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the budget information for the adgroup specified by the
-// accountId and billingId.
-func (r *BudgetService) Get(accountId int64, billingId int64) *BudgetGetCall {
- c := &BudgetGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.billingId = billingId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BudgetGetCall) Fields(s ...googleapi.Field) *BudgetGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *BudgetGetCall) IfNoneMatch(entityTag string) *BudgetGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BudgetGetCall) Context(ctx context.Context) *BudgetGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BudgetGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "billinginfo/{accountId}/{billingId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": strconv.FormatInt(c.accountId, 10),
- "billingId": strconv.FormatInt(c.billingId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.budget.get" call.
-// Exactly one of *Budget or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Budget.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *BudgetGetCall) Do() (*Budget, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Budget{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the budget information for the adgroup specified by the accountId and billingId.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.budget.get",
- // "parameterOrder": [
- // "accountId",
- // "billingId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The account id to get the budget information for.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "billingId": {
- // "description": "The billing id to get the budget information for.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "billinginfo/{accountId}/{billingId}",
- // "response": {
- // "$ref": "Budget"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.budget.patch":
-
-type BudgetPatchCall struct {
- s *Service
- accountId int64
- billingId int64
- budget *Budget
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates the budget amount for the budget of the adgroup
-// specified by the accountId and billingId, with the budget amount in
-// the request. This method supports patch semantics.
-func (r *BudgetService) Patch(accountId int64, billingId int64, budget *Budget) *BudgetPatchCall {
- c := &BudgetPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.billingId = billingId
- c.budget = budget
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BudgetPatchCall) Fields(s ...googleapi.Field) *BudgetPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BudgetPatchCall) Context(ctx context.Context) *BudgetPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BudgetPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.budget)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "billinginfo/{accountId}/{billingId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": strconv.FormatInt(c.accountId, 10),
- "billingId": strconv.FormatInt(c.billingId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.budget.patch" call.
-// Exactly one of *Budget or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Budget.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *BudgetPatchCall) Do() (*Budget, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Budget{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "adexchangebuyer.budget.patch",
- // "parameterOrder": [
- // "accountId",
- // "billingId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The account id associated with the budget being updated.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "billingId": {
- // "description": "The billing id associated with the budget being updated.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "billinginfo/{accountId}/{billingId}",
- // "request": {
- // "$ref": "Budget"
- // },
- // "response": {
- // "$ref": "Budget"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.budget.update":
-
-type BudgetUpdateCall struct {
- s *Service
- accountId int64
- billingId int64
- budget *Budget
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates the budget amount for the budget of the adgroup
-// specified by the accountId and billingId, with the budget amount in
-// the request.
-func (r *BudgetService) Update(accountId int64, billingId int64, budget *Budget) *BudgetUpdateCall {
- c := &BudgetUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.billingId = billingId
- c.budget = budget
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BudgetUpdateCall) Fields(s ...googleapi.Field) *BudgetUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BudgetUpdateCall) Context(ctx context.Context) *BudgetUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BudgetUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.budget)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "billinginfo/{accountId}/{billingId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": strconv.FormatInt(c.accountId, 10),
- "billingId": strconv.FormatInt(c.billingId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.budget.update" call.
-// Exactly one of *Budget or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Budget.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *BudgetUpdateCall) Do() (*Budget, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Budget{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.",
- // "httpMethod": "PUT",
- // "id": "adexchangebuyer.budget.update",
- // "parameterOrder": [
- // "accountId",
- // "billingId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The account id associated with the budget being updated.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "billingId": {
- // "description": "The billing id associated with the budget being updated.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "billinginfo/{accountId}/{billingId}",
- // "request": {
- // "$ref": "Budget"
- // },
- // "response": {
- // "$ref": "Budget"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.creatives.get":
-
-type CreativesGetCall struct {
- s *Service
- accountId int64
- buyerCreativeId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets the status for a single creative. A creative will be
-// available 30-40 minutes after submission.
-func (r *CreativesService) Get(accountId int64, buyerCreativeId string) *CreativesGetCall {
- c := &CreativesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.buyerCreativeId = buyerCreativeId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativesGetCall) Fields(s ...googleapi.Field) *CreativesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CreativesGetCall) IfNoneMatch(entityTag string) *CreativesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativesGetCall) Context(ctx context.Context) *CreativesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "creatives/{accountId}/{buyerCreativeId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": strconv.FormatInt(c.accountId, 10),
- "buyerCreativeId": c.buyerCreativeId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.creatives.get" call.
-// Exactly one of *Creative or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Creative.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CreativesGetCall) Do() (*Creative, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Creative{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the status for a single creative. A creative will be available 30-40 minutes after submission.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.creatives.get",
- // "parameterOrder": [
- // "accountId",
- // "buyerCreativeId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The id for the account that will serve this creative.",
- // "format": "int32",
- // "location": "path",
- // "required": true,
- // "type": "integer"
- // },
- // "buyerCreativeId": {
- // "description": "The buyer-specific id for this creative.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "creatives/{accountId}/{buyerCreativeId}",
- // "response": {
- // "$ref": "Creative"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.creatives.insert":
-
-type CreativesInsertCall struct {
- s *Service
- creative *Creative
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Submit a new creative.
-func (r *CreativesService) Insert(creative *Creative) *CreativesInsertCall {
- c := &CreativesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.creative = creative
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativesInsertCall) Fields(s ...googleapi.Field) *CreativesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativesInsertCall) Context(ctx context.Context) *CreativesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creative)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "creatives")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.creatives.insert" call.
-// Exactly one of *Creative or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Creative.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CreativesInsertCall) Do() (*Creative, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Creative{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Submit a new creative.",
- // "httpMethod": "POST",
- // "id": "adexchangebuyer.creatives.insert",
- // "path": "creatives",
- // "request": {
- // "$ref": "Creative"
- // },
- // "response": {
- // "$ref": "Creative"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.creatives.list":
-
-type CreativesListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of the authenticated user's active creatives.
-// A creative will be available 30-40 minutes after submission.
-func (r *CreativesService) List() *CreativesListCall {
- c := &CreativesListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// AccountId sets the optional parameter "accountId": When specified,
-// only creatives for the given account ids are returned.
-func (c *CreativesListCall) AccountId(accountId int64) *CreativesListCall {
- c.opt_["accountId"] = accountId
- return c
-}
-
-// BuyerCreativeId sets the optional parameter "buyerCreativeId": When
-// specified, only creatives for the given buyer creative ids are
-// returned.
-func (c *CreativesListCall) BuyerCreativeId(buyerCreativeId string) *CreativesListCall {
- c.opt_["buyerCreativeId"] = buyerCreativeId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of entries returned on one result page. If not set, the default is
-// 100.
-func (c *CreativesListCall) MaxResults(maxResults int64) *CreativesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad clients. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *CreativesListCall) PageToken(pageToken string) *CreativesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// StatusFilter sets the optional parameter "statusFilter": When
-// specified, only creatives having the given status are returned.
-//
-// Possible values:
-// "approved" - Creatives which have been approved.
-// "disapproved" - Creatives which have been disapproved.
-// "not_checked" - Creatives whose status is not yet checked.
-func (c *CreativesListCall) StatusFilter(statusFilter string) *CreativesListCall {
- c.opt_["statusFilter"] = statusFilter
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativesListCall) Fields(s ...googleapi.Field) *CreativesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CreativesListCall) IfNoneMatch(entityTag string) *CreativesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativesListCall) Context(ctx context.Context) *CreativesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["accountId"]; ok {
- params.Set("accountId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["buyerCreativeId"]; ok {
- params.Set("buyerCreativeId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["statusFilter"]; ok {
- params.Set("statusFilter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "creatives")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.creatives.list" call.
-// Exactly one of *CreativesList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CreativesList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativesListCall) Do() (*CreativesList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativesList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.creatives.list",
- // "parameters": {
- // "accountId": {
- // "description": "When specified, only creatives for the given account ids are returned.",
- // "format": "int32",
- // "location": "query",
- // "repeated": true,
- // "type": "integer"
- // },
- // "buyerCreativeId": {
- // "description": "When specified, only creatives for the given buyer creative ids are returned.",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "1000",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response. Optional.",
- // "location": "query",
- // "type": "string"
- // },
- // "statusFilter": {
- // "description": "When specified, only creatives having the given status are returned.",
- // "enum": [
- // "approved",
- // "disapproved",
- // "not_checked"
- // ],
- // "enumDescriptions": [
- // "Creatives which have been approved.",
- // "Creatives which have been disapproved.",
- // "Creatives whose status is not yet checked."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "creatives",
- // "response": {
- // "$ref": "CreativesList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.directDeals.get":
-
-type DirectDealsGetCall struct {
- s *Service
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one direct deal by ID.
-func (r *DirectDealsService) Get(id int64) *DirectDealsGetCall {
- c := &DirectDealsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DirectDealsGetCall) Fields(s ...googleapi.Field) *DirectDealsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DirectDealsGetCall) IfNoneMatch(entityTag string) *DirectDealsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DirectDealsGetCall) Context(ctx context.Context) *DirectDealsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DirectDealsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "directdeals/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.directDeals.get" call.
-// Exactly one of *DirectDeal or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *DirectDeal.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DirectDealsGetCall) Do() (*DirectDeal, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DirectDeal{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one direct deal by ID.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.directDeals.get",
- // "parameterOrder": [
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "The direct deal id",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "directdeals/{id}",
- // "response": {
- // "$ref": "DirectDeal"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.directDeals.list":
-
-type DirectDealsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the authenticated user's list of direct deals.
-func (r *DirectDealsService) List() *DirectDealsListCall {
- c := &DirectDealsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DirectDealsListCall) Fields(s ...googleapi.Field) *DirectDealsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DirectDealsListCall) IfNoneMatch(entityTag string) *DirectDealsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DirectDealsListCall) Context(ctx context.Context) *DirectDealsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DirectDealsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "directdeals")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.directDeals.list" call.
-// Exactly one of *DirectDealsList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *DirectDealsList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DirectDealsListCall) Do() (*DirectDealsList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DirectDealsList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the authenticated user's list of direct deals.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.directDeals.list",
- // "path": "directdeals",
- // "response": {
- // "$ref": "DirectDealsList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.performanceReport.list":
-
-type PerformanceReportListCall struct {
- s *Service
- accountId int64
- endDateTime string
- startDateTime string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the authenticated user's list of performance metrics.
-func (r *PerformanceReportService) List(accountId int64, endDateTime string, startDateTime string) *PerformanceReportListCall {
- c := &PerformanceReportListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.endDateTime = endDateTime
- c.startDateTime = startDateTime
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of entries returned on one result page. If not set, the default is
-// 100.
-func (c *PerformanceReportListCall) MaxResults(maxResults int64) *PerformanceReportListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through performance reports. To retrieve the next
-// page, set this parameter to the value of "nextPageToken" from the
-// previous response.
-func (c *PerformanceReportListCall) PageToken(pageToken string) *PerformanceReportListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PerformanceReportListCall) Fields(s ...googleapi.Field) *PerformanceReportListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PerformanceReportListCall) IfNoneMatch(entityTag string) *PerformanceReportListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PerformanceReportListCall) Context(ctx context.Context) *PerformanceReportListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PerformanceReportListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("accountId", fmt.Sprintf("%v", c.accountId))
- params.Set("endDateTime", fmt.Sprintf("%v", c.endDateTime))
- params.Set("startDateTime", fmt.Sprintf("%v", c.startDateTime))
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "performancereport")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.performanceReport.list" call.
-// Exactly one of *PerformanceReportList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *PerformanceReportList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PerformanceReportListCall) Do() (*PerformanceReportList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PerformanceReportList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the authenticated user's list of performance metrics.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.performanceReport.list",
- // "parameterOrder": [
- // "accountId",
- // "endDateTime",
- // "startDateTime"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The account id to get the reports.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "endDateTime": {
- // "description": "The end time of the report in ISO 8601 timestamp format using UTC.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "1000",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through performance reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response. Optional.",
- // "location": "query",
- // "type": "string"
- // },
- // "startDateTime": {
- // "description": "The start time of the report in ISO 8601 timestamp format using UTC.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "performancereport",
- // "response": {
- // "$ref": "PerformanceReportList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.pretargetingConfig.delete":
-
-type PretargetingConfigDeleteCall struct {
- s *Service
- accountId int64
- configId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an existing pretargeting config.
-func (r *PretargetingConfigService) Delete(accountId int64, configId int64) *PretargetingConfigDeleteCall {
- c := &PretargetingConfigDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.configId = configId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PretargetingConfigDeleteCall) Fields(s ...googleapi.Field) *PretargetingConfigDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PretargetingConfigDeleteCall) Context(ctx context.Context) *PretargetingConfigDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PretargetingConfigDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "pretargetingconfigs/{accountId}/{configId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": strconv.FormatInt(c.accountId, 10),
- "configId": strconv.FormatInt(c.configId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.pretargetingConfig.delete" call.
-func (c *PretargetingConfigDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes an existing pretargeting config.",
- // "httpMethod": "DELETE",
- // "id": "adexchangebuyer.pretargetingConfig.delete",
- // "parameterOrder": [
- // "accountId",
- // "configId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The account id to delete the pretargeting config for.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "configId": {
- // "description": "The specific id of the configuration to delete.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "pretargetingconfigs/{accountId}/{configId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.pretargetingConfig.get":
-
-type PretargetingConfigGetCall struct {
- s *Service
- accountId int64
- configId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets a specific pretargeting configuration
-func (r *PretargetingConfigService) Get(accountId int64, configId int64) *PretargetingConfigGetCall {
- c := &PretargetingConfigGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.configId = configId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PretargetingConfigGetCall) Fields(s ...googleapi.Field) *PretargetingConfigGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PretargetingConfigGetCall) IfNoneMatch(entityTag string) *PretargetingConfigGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PretargetingConfigGetCall) Context(ctx context.Context) *PretargetingConfigGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PretargetingConfigGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "pretargetingconfigs/{accountId}/{configId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": strconv.FormatInt(c.accountId, 10),
- "configId": strconv.FormatInt(c.configId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.pretargetingConfig.get" call.
-// Exactly one of *PretargetingConfig or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *PretargetingConfig.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PretargetingConfigGetCall) Do() (*PretargetingConfig, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PretargetingConfig{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets a specific pretargeting configuration",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.pretargetingConfig.get",
- // "parameterOrder": [
- // "accountId",
- // "configId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The account id to get the pretargeting config for.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "configId": {
- // "description": "The specific id of the configuration to retrieve.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "pretargetingconfigs/{accountId}/{configId}",
- // "response": {
- // "$ref": "PretargetingConfig"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.pretargetingConfig.insert":
-
-type PretargetingConfigInsertCall struct {
- s *Service
- accountId int64
- pretargetingconfig *PretargetingConfig
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new pretargeting configuration.
-func (r *PretargetingConfigService) Insert(accountId int64, pretargetingconfig *PretargetingConfig) *PretargetingConfigInsertCall {
- c := &PretargetingConfigInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.pretargetingconfig = pretargetingconfig
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PretargetingConfigInsertCall) Fields(s ...googleapi.Field) *PretargetingConfigInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PretargetingConfigInsertCall) Context(ctx context.Context) *PretargetingConfigInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PretargetingConfigInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.pretargetingconfig)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "pretargetingconfigs/{accountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": strconv.FormatInt(c.accountId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.pretargetingConfig.insert" call.
-// Exactly one of *PretargetingConfig or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *PretargetingConfig.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PretargetingConfigInsertCall) Do() (*PretargetingConfig, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PretargetingConfig{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new pretargeting configuration.",
- // "httpMethod": "POST",
- // "id": "adexchangebuyer.pretargetingConfig.insert",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The account id to insert the pretargeting config for.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "pretargetingconfigs/{accountId}",
- // "request": {
- // "$ref": "PretargetingConfig"
- // },
- // "response": {
- // "$ref": "PretargetingConfig"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.pretargetingConfig.list":
-
-type PretargetingConfigListCall struct {
- s *Service
- accountId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of the authenticated user's pretargeting
-// configurations.
-func (r *PretargetingConfigService) List(accountId int64) *PretargetingConfigListCall {
- c := &PretargetingConfigListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PretargetingConfigListCall) Fields(s ...googleapi.Field) *PretargetingConfigListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PretargetingConfigListCall) IfNoneMatch(entityTag string) *PretargetingConfigListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PretargetingConfigListCall) Context(ctx context.Context) *PretargetingConfigListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PretargetingConfigListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "pretargetingconfigs/{accountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": strconv.FormatInt(c.accountId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.pretargetingConfig.list" call.
-// Exactly one of *PretargetingConfigList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *PretargetingConfigList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PretargetingConfigListCall) Do() (*PretargetingConfigList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PretargetingConfigList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of the authenticated user's pretargeting configurations.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.pretargetingConfig.list",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The account id to get the pretargeting configs for.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "pretargetingconfigs/{accountId}",
- // "response": {
- // "$ref": "PretargetingConfigList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.pretargetingConfig.patch":
-
-type PretargetingConfigPatchCall struct {
- s *Service
- accountId int64
- configId int64
- pretargetingconfig *PretargetingConfig
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing pretargeting config. This method supports
-// patch semantics.
-func (r *PretargetingConfigService) Patch(accountId int64, configId int64, pretargetingconfig *PretargetingConfig) *PretargetingConfigPatchCall {
- c := &PretargetingConfigPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.configId = configId
- c.pretargetingconfig = pretargetingconfig
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PretargetingConfigPatchCall) Fields(s ...googleapi.Field) *PretargetingConfigPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PretargetingConfigPatchCall) Context(ctx context.Context) *PretargetingConfigPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PretargetingConfigPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.pretargetingconfig)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "pretargetingconfigs/{accountId}/{configId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": strconv.FormatInt(c.accountId, 10),
- "configId": strconv.FormatInt(c.configId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.pretargetingConfig.patch" call.
-// Exactly one of *PretargetingConfig or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *PretargetingConfig.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PretargetingConfigPatchCall) Do() (*PretargetingConfig, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PretargetingConfig{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing pretargeting config. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "adexchangebuyer.pretargetingConfig.patch",
- // "parameterOrder": [
- // "accountId",
- // "configId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The account id to update the pretargeting config for.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "configId": {
- // "description": "The specific id of the configuration to update.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "pretargetingconfigs/{accountId}/{configId}",
- // "request": {
- // "$ref": "PretargetingConfig"
- // },
- // "response": {
- // "$ref": "PretargetingConfig"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.pretargetingConfig.update":
-
-type PretargetingConfigUpdateCall struct {
- s *Service
- accountId int64
- configId int64
- pretargetingconfig *PretargetingConfig
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing pretargeting config.
-func (r *PretargetingConfigService) Update(accountId int64, configId int64, pretargetingconfig *PretargetingConfig) *PretargetingConfigUpdateCall {
- c := &PretargetingConfigUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.configId = configId
- c.pretargetingconfig = pretargetingconfig
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PretargetingConfigUpdateCall) Fields(s ...googleapi.Field) *PretargetingConfigUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PretargetingConfigUpdateCall) Context(ctx context.Context) *PretargetingConfigUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PretargetingConfigUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.pretargetingconfig)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "pretargetingconfigs/{accountId}/{configId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": strconv.FormatInt(c.accountId, 10),
- "configId": strconv.FormatInt(c.configId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.pretargetingConfig.update" call.
-// Exactly one of *PretargetingConfig or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *PretargetingConfig.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PretargetingConfigUpdateCall) Do() (*PretargetingConfig, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PretargetingConfig{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing pretargeting config.",
- // "httpMethod": "PUT",
- // "id": "adexchangebuyer.pretargetingConfig.update",
- // "parameterOrder": [
- // "accountId",
- // "configId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The account id to update the pretargeting config for.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "configId": {
- // "description": "The specific id of the configuration to update.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "pretargetingconfigs/{accountId}/{configId}",
- // "request": {
- // "$ref": "PretargetingConfig"
- // },
- // "response": {
- // "$ref": "PretargetingConfig"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/adexchangebuyer/v1.4/adexchangebuyer-api.json b/vendor/google.golang.org/api/adexchangebuyer/v1.4/adexchangebuyer-api.json
deleted file mode 100644
index cf0f14b6..00000000
--- a/vendor/google.golang.org/api/adexchangebuyer/v1.4/adexchangebuyer-api.json
+++ /dev/null
@@ -1,4193 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/e2ZwVjK29RxJqz1-z8CpRPnLiKo\"",
- "discoveryVersion": "v1",
- "id": "adexchangebuyer:v1.4",
- "name": "adexchangebuyer",
- "canonicalName": "Ad Exchange Buyer",
- "version": "v1.4",
- "revision": "20150909",
- "title": "Ad Exchange Buyer API",
- "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/adexchangebuyer/v1.4/",
- "basePath": "/adexchangebuyer/v1.4/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "adexchangebuyer/v1.4/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/adexchange.buyer": {
- "description": "Manage your Ad Exchange buyer account configuration"
- }
- }
- }
- },
- "schemas": {
- "Account": {
- "id": "Account",
- "type": "object",
- "description": "Configuration data for an Ad Exchange buyer account.",
- "properties": {
- "bidderLocation": {
- "type": "array",
- "description": "Your bidder locations that have distinct URLs.",
- "items": {
- "type": "object",
- "properties": {
- "maximumQps": {
- "type": "integer",
- "description": "The maximum queries per second the Ad Exchange will send.",
- "format": "int32"
- },
- "region": {
- "type": "string",
- "description": "The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values: \n- ASIA \n- EUROPE \n- US_EAST \n- US_WEST"
- },
- "url": {
- "type": "string",
- "description": "The URL to which the Ad Exchange will send bid requests."
- }
- }
- }
- },
- "cookieMatchingNid": {
- "type": "string",
- "description": "The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this."
- },
- "cookieMatchingUrl": {
- "type": "string",
- "description": "The base URL used in cookie match requests."
- },
- "id": {
- "type": "integer",
- "description": "Account id.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#account"
- },
- "maximumActiveCreatives": {
- "type": "integer",
- "description": "The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. Please contact your technical account manager if you need to change this.",
- "format": "int32"
- },
- "maximumTotalQps": {
- "type": "integer",
- "description": "The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.",
- "format": "int32"
- },
- "numberActiveCreatives": {
- "type": "integer",
- "description": "The number of creatives that this account inserted or bid with in the last 30 days.",
- "format": "int32"
- }
- }
- },
- "AccountsList": {
- "id": "AccountsList",
- "type": "object",
- "description": "An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of accounts.",
- "items": {
- "$ref": "Account"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#accountsList"
- }
- }
- },
- "AdSize": {
- "id": "AdSize",
- "type": "object",
- "properties": {
- "height": {
- "type": "integer",
- "format": "int32"
- },
- "width": {
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "AdSlotDto": {
- "id": "AdSlotDto",
- "type": "object",
- "properties": {
- "channelCode": {
- "type": "string"
- },
- "channelId": {
- "type": "integer",
- "format": "int32"
- },
- "description": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "size": {
- "type": "string"
- },
- "webPropertyId": {
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "AddOrderDealsRequest": {
- "id": "AddOrderDealsRequest",
- "type": "object",
- "properties": {
- "deals": {
- "type": "array",
- "description": "The list of deals to add",
- "items": {
- "$ref": "MarketplaceDeal"
- }
- },
- "orderRevisionNumber": {
- "type": "string",
- "description": "The last known order revision number.",
- "format": "int64"
- },
- "updateAction": {
- "type": "string",
- "description": "Indicates an optional action to take on the order"
- }
- }
- },
- "AddOrderDealsResponse": {
- "id": "AddOrderDealsResponse",
- "type": "object",
- "properties": {
- "deals": {
- "type": "array",
- "description": "List of deals added (in the same order as passed in the request)",
- "items": {
- "$ref": "MarketplaceDeal"
- }
- },
- "orderRevisionNumber": {
- "type": "string",
- "description": "The updated revision number for the order.",
- "format": "int64"
- }
- }
- },
- "AddOrderNotesRequest": {
- "id": "AddOrderNotesRequest",
- "type": "object",
- "properties": {
- "notes": {
- "type": "array",
- "description": "The list of notes to add.",
- "items": {
- "$ref": "MarketplaceNote"
- }
- }
- }
- },
- "AddOrderNotesResponse": {
- "id": "AddOrderNotesResponse",
- "type": "object",
- "properties": {
- "notes": {
- "type": "array",
- "items": {
- "$ref": "MarketplaceNote"
- }
- }
- }
- },
- "AdvertiserDto": {
- "id": "AdvertiserDto",
- "type": "object",
- "properties": {
- "brands": {
- "type": "array",
- "items": {
- "$ref": "BrandDto"
- }
- },
- "id": {
- "type": "string",
- "format": "int64"
- },
- "name": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- }
- },
- "AudienceSegment": {
- "id": "AudienceSegment",
- "type": "object",
- "properties": {
- "description": {
- "type": "string"
- },
- "id": {
- "type": "string",
- "format": "int64"
- },
- "name": {
- "type": "string"
- },
- "numCookies": {
- "type": "string",
- "format": "int64"
- }
- }
- },
- "BillingInfo": {
- "id": "BillingInfo",
- "type": "object",
- "description": "The configuration data for an Ad Exchange billing info.",
- "properties": {
- "accountId": {
- "type": "integer",
- "description": "Account id.",
- "format": "int32"
- },
- "accountName": {
- "type": "string",
- "description": "Account name."
- },
- "billingId": {
- "type": "array",
- "description": "A list of adgroup IDs associated with this particular account. These IDs may show up as part of a realtime bidding BidRequest, which indicates a bid request for this account.",
- "items": {
- "type": "string"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#billingInfo"
- }
- }
- },
- "BillingInfoList": {
- "id": "BillingInfoList",
- "type": "object",
- "description": "A billing info feed lists Billing Info the Ad Exchange buyer account has access to. Each entry in the feed corresponds to a single billing info.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of billing info relevant for your account.",
- "items": {
- "$ref": "BillingInfo"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#billingInfoList"
- }
- }
- },
- "BrandDto": {
- "id": "BrandDto",
- "type": "object",
- "properties": {
- "advertiserId": {
- "type": "string",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "format": "int64"
- },
- "name": {
- "type": "string"
- }
- }
- },
- "Budget": {
- "id": "Budget",
- "type": "object",
- "description": "The configuration data for Ad Exchange RTB - Budget API.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The id of the account. This is required for get and update requests.",
- "format": "int64"
- },
- "billingId": {
- "type": "string",
- "description": "The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.",
- "format": "int64"
- },
- "budgetAmount": {
- "type": "string",
- "description": "The budget amount to apply for the billingId provided. This is required for update requests.",
- "format": "int64"
- },
- "currencyCode": {
- "type": "string",
- "description": "The currency code for the buyer. This cannot be altered here."
- },
- "id": {
- "type": "string",
- "description": "The unique id that describes this item."
- },
- "kind": {
- "type": "string",
- "description": "The kind of the resource, i.e. \"adexchangebuyer#budget\".",
- "default": "adexchangebuyer#budget"
- }
- }
- },
- "Buyer": {
- "id": "Buyer",
- "type": "object",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Adx account id of the buyer."
- }
- }
- },
- "BuyerDto": {
- "id": "BuyerDto",
- "type": "object",
- "properties": {
- "accountId": {
- "type": "integer",
- "format": "int32"
- },
- "customerId": {
- "type": "integer",
- "format": "int32"
- },
- "displayName": {
- "type": "string"
- },
- "enabledForInterestTargetingDeals": {
- "type": "boolean"
- },
- "enabledForPreferredDeals": {
- "type": "boolean"
- },
- "id": {
- "type": "integer",
- "format": "int32"
- },
- "sponsorAccountId": {
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "ClientAccessCapabilities": {
- "id": "ClientAccessCapabilities",
- "type": "object",
- "properties": {
- "capabilities": {
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "clientAccountId": {
- "type": "string",
- "format": "int64"
- }
- }
- },
- "ContactInformation": {
- "id": "ContactInformation",
- "type": "object",
- "properties": {
- "email": {
- "type": "string",
- "description": "Email address of the contact."
- },
- "name": {
- "type": "string",
- "description": "The name of the contact."
- }
- }
- },
- "CreateOrdersRequest": {
- "id": "CreateOrdersRequest",
- "type": "object",
- "properties": {
- "orders": {
- "type": "array",
- "description": "The list of orders to create.",
- "items": {
- "$ref": "MarketplaceOrder"
- }
- },
- "webPropertyCode": {
- "type": "string"
- }
- }
- },
- "CreateOrdersResponse": {
- "id": "CreateOrdersResponse",
- "type": "object",
- "properties": {
- "orders": {
- "type": "array",
- "description": "The list of orders successfully created.",
- "items": {
- "$ref": "MarketplaceOrder"
- }
- }
- }
- },
- "Creative": {
- "id": "Creative",
- "type": "object",
- "description": "A creative and its classification data.",
- "properties": {
- "HTMLSnippet": {
- "type": "string",
- "description": "The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set."
- },
- "accountId": {
- "type": "integer",
- "description": "Account id.",
- "format": "int32",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "advertiserId": {
- "type": "array",
- "description": "Detected advertiser id, if any. Read-only. This field should not be set in requests.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "advertiserName": {
- "type": "string",
- "description": "The name of the company being advertised in the creative.",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "agencyId": {
- "type": "string",
- "description": "The agency id for this creative.",
- "format": "int64"
- },
- "api_upload_timestamp": {
- "type": "string",
- "description": "The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).",
- "format": "date-time"
- },
- "attribute": {
- "type": "array",
- "description": "All attributes for the ads that may be shown from this snippet.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "buyerCreativeId": {
- "type": "string",
- "description": "A buyer-specific id identifying the creative in this ad.",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "clickThroughUrl": {
- "type": "array",
- "description": "The set of destination urls for the snippet.",
- "items": {
- "type": "string"
- },
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "corrections": {
- "type": "array",
- "description": "Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.",
- "items": {
- "type": "object",
- "properties": {
- "details": {
- "type": "array",
- "description": "Additional details about the correction.",
- "items": {
- "type": "string"
- }
- },
- "reason": {
- "type": "string",
- "description": "The type of correction that was applied to the creative."
- }
- }
- }
- },
- "dealsStatus": {
- "type": "string",
- "description": "Top-level deals status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=DIRECT_DEALS (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from servingRestrictions directly."
- },
- "filteringReasons": {
- "type": "object",
- "description": "The filtering reasons for the creative. Read-only. This field should not be set in requests.",
- "properties": {
- "date": {
- "type": "string",
- "description": "The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST."
- },
- "reasons": {
- "type": "array",
- "description": "The filtering reasons.",
- "items": {
- "type": "object",
- "properties": {
- "filteringCount": {
- "type": "string",
- "description": "The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.",
- "format": "int64"
- },
- "filteringStatus": {
- "type": "integer",
- "description": "The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.",
- "format": "int32"
- }
- }
- }
- }
- }
- },
- "height": {
- "type": "integer",
- "description": "Ad height.",
- "format": "int32",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- },
- "impressionTrackingUrl": {
- "type": "array",
- "description": "The set of urls to be called to record an impression.",
- "items": {
- "type": "string"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#creative"
- },
- "nativeAd": {
- "type": "object",
- "description": "If nativeAd is set, HTMLSnippet and videoURL should not be set.",
- "properties": {
- "advertiser": {
- "type": "string"
- },
- "appIcon": {
- "type": "object",
- "description": "The app icon, for app download ads.",
- "properties": {
- "height": {
- "type": "integer",
- "format": "int32"
- },
- "url": {
- "type": "string"
- },
- "width": {
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "body": {
- "type": "string",
- "description": "A long description of the ad."
- },
- "callToAction": {
- "type": "string",
- "description": "A label for the button that the user is supposed to click."
- },
- "clickTrackingUrl": {
- "type": "string",
- "description": "The URL to use for click tracking."
- },
- "headline": {
- "type": "string",
- "description": "A short title for the ad."
- },
- "image": {
- "type": "object",
- "description": "A large image.",
- "properties": {
- "height": {
- "type": "integer",
- "format": "int32"
- },
- "url": {
- "type": "string"
- },
- "width": {
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "impressionTrackingUrl": {
- "type": "array",
- "description": "The URLs are called when the impression is rendered.",
- "items": {
- "type": "string"
- }
- },
- "logo": {
- "type": "object",
- "description": "A smaller image, for the advertiser logo.",
- "properties": {
- "height": {
- "type": "integer",
- "format": "int32"
- },
- "url": {
- "type": "string"
- },
- "width": {
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "price": {
- "type": "string",
- "description": "The price of the promoted app including the currency info."
- },
- "starRating": {
- "type": "number",
- "description": "The app rating in the app store. Must be in the range [0-5].",
- "format": "double"
- },
- "store": {
- "type": "string",
- "description": "The URL to the app store to purchase/download the promoted app."
- }
- }
- },
- "openAuctionStatus": {
- "type": "string",
- "description": "Top-level open auction status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=OPEN_AUCTION (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from ServingRestrictions directly."
- },
- "productCategories": {
- "type": "array",
- "description": "Detected product categories, if any. Read-only. This field should not be set in requests.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "restrictedCategories": {
- "type": "array",
- "description": "All restricted categories for the ads that may be shown from this snippet.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "sensitiveCategories": {
- "type": "array",
- "description": "Detected sensitive categories, if any. Read-only. This field should not be set in requests.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "servingRestrictions": {
- "type": "array",
- "description": "The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). Read-only. This field should not be set in requests.",
- "items": {
- "type": "object",
- "properties": {
- "contexts": {
- "type": "array",
- "description": "All known contexts/restrictions.",
- "items": {
- "type": "object",
- "properties": {
- "auctionType": {
- "type": "array",
- "description": "Only set when contextType=AUCTION_TYPE. Represents the auction types this restriction applies to.",
- "items": {
- "type": "string"
- }
- },
- "contextType": {
- "type": "string",
- "description": "The type of context (e.g., location, platform, auction type, SSL-ness)."
- },
- "geoCriteriaId": {
- "type": "array",
- "description": "Only set when contextType=LOCATION. Represents the geo criterias this restriction applies to.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "platform": {
- "type": "array",
- "description": "Only set when contextType=PLATFORM. Represents the platforms this restriction applies to.",
- "items": {
- "type": "string"
- }
- }
- }
- }
- },
- "disapprovalReasons": {
- "type": "array",
- "description": "The reasons for disapproval within this restriction, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED or CONDITIONALLY_APPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue.",
- "items": {
- "type": "object",
- "properties": {
- "details": {
- "type": "array",
- "description": "Additional details about the reason for disapproval.",
- "items": {
- "type": "string"
- }
- },
- "reason": {
- "type": "string",
- "description": "The categorized reason for disapproval."
- }
- }
- }
- },
- "reason": {
- "type": "string",
- "description": "Why the creative is ineligible to serve in this context (e.g., it has been explicitly disapproved or is pending review)."
- }
- }
- }
- },
- "vendorType": {
- "type": "array",
- "description": "All vendor types for the ads that may be shown from this snippet.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "version": {
- "type": "integer",
- "description": "The version for this creative. Read-only. This field should not be set in requests.",
- "format": "int32"
- },
- "videoURL": {
- "type": "string",
- "description": "The url to fetch a video ad. If set, HTMLSnippet should not be set."
- },
- "width": {
- "type": "integer",
- "description": "Ad width.",
- "format": "int32",
- "annotations": {
- "required": [
- "adexchangebuyer.creatives.insert"
- ]
- }
- }
- }
- },
- "CreativesList": {
- "id": "CreativesList",
- "type": "object",
- "description": "The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of creatives.",
- "items": {
- "$ref": "Creative"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#creativesList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through creatives. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "DateTime": {
- "id": "DateTime",
- "type": "object",
- "properties": {
- "day": {
- "type": "integer",
- "format": "int32"
- },
- "hour": {
- "type": "integer",
- "format": "int32"
- },
- "minute": {
- "type": "integer",
- "format": "int32"
- },
- "month": {
- "type": "integer",
- "format": "int32"
- },
- "second": {
- "type": "integer",
- "format": "int32"
- },
- "timeZoneId": {
- "type": "string"
- },
- "year": {
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "DealPartyDto": {
- "id": "DealPartyDto",
- "type": "object",
- "properties": {
- "buyer": {
- "$ref": "BuyerDto"
- },
- "buyerSellerRole": {
- "type": "string"
- },
- "customerId": {
- "type": "integer",
- "format": "int32"
- },
- "name": {
- "type": "string"
- },
- "webProperty": {
- "$ref": "WebPropertyDto"
- }
- }
- },
- "DealTerms": {
- "id": "DealTerms",
- "type": "object",
- "properties": {
- "description": {
- "type": "string",
- "description": "Description for the proposed terms of the deal."
- },
- "guaranteedFixedPriceTerms": {
- "$ref": "DealTermsGuaranteedFixedPriceTerms",
- "description": "The terms for guaranteed fixed price deals."
- },
- "nonGuaranteedAuctionTerms": {
- "$ref": "DealTermsNonGuaranteedAuctionTerms",
- "description": "The terms for non-guaranteed auction deals."
- },
- "nonGuaranteedFixedPriceTerms": {
- "$ref": "DealTermsNonGuaranteedFixedPriceTerms",
- "description": "The terms for non-guaranteed fixed price deals."
- }
- }
- },
- "DealTermsGuaranteedFixedPriceTerms": {
- "id": "DealTermsGuaranteedFixedPriceTerms",
- "type": "object",
- "properties": {
- "fixedPrices": {
- "type": "array",
- "description": "Fixed price for the specified buyer.",
- "items": {
- "$ref": "PricePerBuyer"
- }
- },
- "guaranteedImpressions": {
- "type": "string",
- "description": "Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.",
- "format": "int64"
- },
- "guaranteedLooks": {
- "type": "string",
- "description": "Count of guaranteed looks. Required for deal, optional for offer.",
- "format": "int64"
- }
- }
- },
- "DealTermsNonGuaranteedAuctionTerms": {
- "id": "DealTermsNonGuaranteedAuctionTerms",
- "type": "object",
- "properties": {
- "privateAuctionId": {
- "type": "string",
- "description": "Id of the corresponding private auction."
- },
- "reservePricePerBuyers": {
- "type": "array",
- "description": "Reserve price for the specified buyer.",
- "items": {
- "$ref": "PricePerBuyer"
- }
- }
- }
- },
- "DealTermsNonGuaranteedFixedPriceTerms": {
- "id": "DealTermsNonGuaranteedFixedPriceTerms",
- "type": "object",
- "properties": {
- "fixedPrices": {
- "type": "array",
- "description": "Fixed price for the specified buyer.",
- "items": {
- "$ref": "PricePerBuyer"
- }
- }
- }
- },
- "DeleteOrderDealsRequest": {
- "id": "DeleteOrderDealsRequest",
- "type": "object",
- "properties": {
- "dealIds": {
- "type": "array",
- "description": "List of deals to delete for a given order",
- "items": {
- "type": "string"
- }
- },
- "orderRevisionNumber": {
- "type": "string",
- "description": "The last known order revision number.",
- "format": "int64"
- },
- "updateAction": {
- "type": "string"
- }
- }
- },
- "DeleteOrderDealsResponse": {
- "id": "DeleteOrderDealsResponse",
- "type": "object",
- "properties": {
- "deals": {
- "type": "array",
- "description": "List of deals deleted (in the same order as passed in the request)",
- "items": {
- "$ref": "MarketplaceDeal"
- }
- },
- "orderRevisionNumber": {
- "type": "string",
- "description": "The updated revision number for the order.",
- "format": "int64"
- }
- }
- },
- "DeliveryControl": {
- "id": "DeliveryControl",
- "type": "object",
- "properties": {
- "deliveryRateType": {
- "type": "string"
- },
- "frequencyCaps": {
- "type": "array",
- "items": {
- "$ref": "DeliveryControlFrequencyCap"
- }
- }
- }
- },
- "DeliveryControlFrequencyCap": {
- "id": "DeliveryControlFrequencyCap",
- "type": "object",
- "properties": {
- "maxImpressions": {
- "type": "integer",
- "format": "int32"
- },
- "numTimeUnits": {
- "type": "integer",
- "format": "int32"
- },
- "timeUnitType": {
- "type": "string"
- }
- }
- },
- "EditAllOrderDealsRequest": {
- "id": "EditAllOrderDealsRequest",
- "type": "object",
- "properties": {
- "deals": {
- "type": "array",
- "description": "List of deals to edit. Service may perform 3 different operations based on comparison of deals in this list vs deals already persisted in database: 1. Add new deal to order If a deal in this list does not exist in the order, the service will create a new deal and add it to the order. Validation will follow AddOrderDealsRequest. 2. Update existing deal in the order If a deal in this list already exist in the order, the service will update that existing deal to this new deal in the request. Validation will follow UpdateOrderDealsRequest. 3. Delete deals from the order (just need the id) If a existing deal in the order is not present in this list, the service will delete that deal from the order. Validation will follow DeleteOrderDealsRequest.",
- "items": {
- "$ref": "MarketplaceDeal"
- }
- },
- "order": {
- "$ref": "MarketplaceOrder",
- "description": "If specified, also updates the order in the batch transaction. This is useful when the order and the deals need to be updated in one transaction."
- },
- "orderRevisionNumber": {
- "type": "string",
- "description": "The last known revision number for the order.",
- "format": "int64"
- },
- "updateAction": {
- "type": "string",
- "description": "Indicates an optional action to take on the order"
- }
- }
- },
- "EditAllOrderDealsResponse": {
- "id": "EditAllOrderDealsResponse",
- "type": "object",
- "properties": {
- "deals": {
- "type": "array",
- "description": "List of all deals in the order after edit.",
- "items": {
- "$ref": "MarketplaceDeal"
- }
- }
- }
- },
- "EditHistoryDto": {
- "id": "EditHistoryDto",
- "type": "object",
- "properties": {
- "createdByLoginName": {
- "type": "string"
- },
- "createdTimeStamp": {
- "type": "string",
- "format": "int64"
- },
- "lastUpdateTimeStamp": {
- "type": "string",
- "format": "int64"
- },
- "lastUpdatedByLoginName": {
- "type": "string"
- }
- }
- },
- "GetFinalizedNegotiationByExternalDealIdRequest": {
- "id": "GetFinalizedNegotiationByExternalDealIdRequest",
- "type": "object",
- "properties": {
- "includePrivateAuctions": {
- "type": "boolean"
- }
- }
- },
- "GetNegotiationByIdRequest": {
- "id": "GetNegotiationByIdRequest",
- "type": "object",
- "properties": {
- "includePrivateAuctions": {
- "type": "boolean"
- }
- }
- },
- "GetNegotiationsRequest": {
- "id": "GetNegotiationsRequest",
- "type": "object",
- "properties": {
- "finalized": {
- "type": "boolean"
- },
- "includePrivateAuctions": {
- "type": "boolean"
- },
- "sinceTimestampMillis": {
- "type": "string",
- "format": "int64"
- }
- }
- },
- "GetNegotiationsResponse": {
- "id": "GetNegotiationsResponse",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "default": "adexchangebuyer#negotiationsList"
- },
- "negotiations": {
- "type": "array",
- "items": {
- "$ref": "NegotiationDto"
- }
- }
- }
- },
- "GetOffersResponse": {
- "id": "GetOffersResponse",
- "type": "object",
- "properties": {
- "offers": {
- "type": "array",
- "description": "The returned list of offers.",
- "items": {
- "$ref": "MarketplaceOffer"
- }
- }
- }
- },
- "GetOrderDealsResponse": {
- "id": "GetOrderDealsResponse",
- "type": "object",
- "properties": {
- "deals": {
- "type": "array",
- "description": "List of deals for the order",
- "items": {
- "$ref": "MarketplaceDeal"
- }
- }
- }
- },
- "GetOrderNotesResponse": {
- "id": "GetOrderNotesResponse",
- "type": "object",
- "properties": {
- "notes": {
- "type": "array",
- "description": "The list of matching notes.",
- "items": {
- "$ref": "MarketplaceNote"
- }
- }
- }
- },
- "GetOrdersResponse": {
- "id": "GetOrdersResponse",
- "type": "object",
- "properties": {
- "orders": {
- "type": "array",
- "description": "The list of matching orders.",
- "items": {
- "$ref": "MarketplaceOrder"
- }
- }
- }
- },
- "InventorySegmentTargeting": {
- "id": "InventorySegmentTargeting",
- "type": "object",
- "properties": {
- "negativeAdSizes": {
- "type": "array",
- "items": {
- "$ref": "AdSize"
- }
- },
- "negativeAdTypeSegments": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "negativeAudienceSegments": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "negativeDeviceCategories": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "negativeIcmBrands": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "negativeIcmInterests": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "negativeInventorySlots": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "negativeKeyValues": {
- "type": "array",
- "items": {
- "$ref": "RuleKeyValuePair"
- }
- },
- "negativeLocations": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "negativeMobileApps": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "negativeOperatingSystemVersions": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "negativeOperatingSystems": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "negativeSiteUrls": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "negativeSizes": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "negativeVideoAdPositionSegments": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "negativeVideoDurationSegments": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "negativeXfpAdSlots": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "negativeXfpPlacements": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "positiveAdSizes": {
- "type": "array",
- "items": {
- "$ref": "AdSize"
- }
- },
- "positiveAdTypeSegments": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "positiveAudienceSegments": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "positiveDeviceCategories": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "positiveIcmBrands": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "positiveIcmInterests": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "positiveInventorySlots": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "positiveKeyValues": {
- "type": "array",
- "items": {
- "$ref": "RuleKeyValuePair"
- }
- },
- "positiveLocations": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "positiveMobileApps": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "positiveOperatingSystemVersions": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "positiveOperatingSystems": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "positiveSiteUrls": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "positiveSizes": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "positiveVideoAdPositionSegments": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "positiveVideoDurationSegments": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "positiveXfpAdSlots": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "positiveXfpPlacements": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "int64"
- }
- }
- }
- },
- "ListClientAccessCapabilitiesRequest": {
- "id": "ListClientAccessCapabilitiesRequest",
- "type": "object",
- "properties": {
- "sponsorAccountId": {
- "type": "string",
- "format": "int64"
- }
- }
- },
- "ListClientAccessCapabilitiesResponse": {
- "id": "ListClientAccessCapabilitiesResponse",
- "type": "object",
- "properties": {
- "clientAccessPermissions": {
- "type": "array",
- "items": {
- "$ref": "ClientAccessCapabilities"
- }
- }
- }
- },
- "ListOffersRequest": {
- "id": "ListOffersRequest",
- "type": "object",
- "properties": {
- "sinceTimestampMillis": {
- "type": "string",
- "format": "int64"
- }
- }
- },
- "ListOffersResponse": {
- "id": "ListOffersResponse",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "default": "adexchangebuyer#offersList"
- },
- "offers": {
- "type": "array",
- "items": {
- "$ref": "OfferDto"
- }
- }
- }
- },
- "MarketplaceDeal": {
- "id": "MarketplaceDeal",
- "type": "object",
- "description": "An order can contain multiple deals. A deal contains the terms and targeting information that is used for serving.",
- "properties": {
- "buyerPrivateData": {
- "$ref": "PrivateData",
- "description": "Buyer private data (hidden from seller)."
- },
- "creationTimeMs": {
- "type": "string",
- "description": "The time (ms since epoch) of the deal creation. (readonly)",
- "format": "int64"
- },
- "dealId": {
- "type": "string",
- "description": "A unique deal=id for the deal (readonly)."
- },
- "deliveryControl": {
- "$ref": "DeliveryControl",
- "description": "The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension."
- },
- "externalDealId": {
- "type": "string",
- "description": "The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)"
- },
- "flightEndTimeMs": {
- "type": "string",
- "description": "Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)",
- "format": "int64"
- },
- "flightStartTimeMs": {
- "type": "string",
- "description": "Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)",
- "format": "int64"
- },
- "inventoryDescription": {
- "type": "string",
- "description": "Description for the deal terms. (updatable)"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#marketplaceDeal\".",
- "default": "adexchangebuyer#marketplaceDeal"
- },
- "lastUpdateTimeMs": {
- "type": "string",
- "description": "The time (ms since epoch) when the deal was last updated. (readonly)",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "The name of the deal. (updatable)"
- },
- "offerId": {
- "type": "string",
- "description": "The offer-id from which this deal was created. (readonly, except on create)"
- },
- "offerRevisionNumber": {
- "type": "string",
- "description": "The revision number of the offer that the deal was created from (readonly, except on create)",
- "format": "int64"
- },
- "orderId": {
- "type": "string"
- },
- "sellerContacts": {
- "type": "array",
- "description": "Optional Seller contact information for the deal (buyer-readonly)",
- "items": {
- "$ref": "ContactInformation"
- }
- },
- "sharedTargetings": {
- "type": "array",
- "description": "The shared targeting visible to buyers and sellers. (updatable)",
- "items": {
- "$ref": "SharedTargeting"
- }
- },
- "syndicationProduct": {
- "type": "string",
- "description": "The syndication product associated with the deal. (readonly, except on create)"
- },
- "terms": {
- "$ref": "DealTerms",
- "description": "The negotiable terms of the deal. (updatable)"
- },
- "webPropertyCode": {
- "type": "string"
- }
- }
- },
- "MarketplaceDealParty": {
- "id": "MarketplaceDealParty",
- "type": "object",
- "properties": {
- "buyer": {
- "$ref": "Buyer",
- "description": "The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party."
- },
- "seller": {
- "$ref": "Seller",
- "description": "The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party."
- }
- }
- },
- "MarketplaceLabel": {
- "id": "MarketplaceLabel",
- "type": "object",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The accountId of the party that created the label."
- },
- "createTimeMs": {
- "type": "string",
- "description": "The creation time (in ms since epoch) for the label.",
- "format": "int64"
- },
- "deprecatedMarketplaceDealParty": {
- "$ref": "MarketplaceDealParty",
- "description": "Information about the party that created the label."
- },
- "label": {
- "type": "string",
- "description": "The label to use."
- }
- }
- },
- "MarketplaceNote": {
- "id": "MarketplaceNote",
- "type": "object",
- "description": "An order is associated with a bunch of notes which may optionally be associated with a deal and/or revision number.",
- "properties": {
- "creatorRole": {
- "type": "string",
- "description": "The role of the person (buyer/seller) creating the note. (readonly)"
- },
- "dealId": {
- "type": "string",
- "description": "Notes can optionally be associated with a deal. (readonly, except on create)"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#marketplaceNote\".",
- "default": "adexchangebuyer#marketplaceNote"
- },
- "note": {
- "type": "string",
- "description": "The actual note to attach. (readonly, except on create)"
- },
- "noteId": {
- "type": "string",
- "description": "The unique id for the note. (readonly)"
- },
- "orderId": {
- "type": "string",
- "description": "The order_id that a note is attached to. (readonly)"
- },
- "orderRevisionNumber": {
- "type": "string",
- "description": "If the note is associated with an order revision number, then store that here. (readonly, except on create)",
- "format": "int64"
- },
- "timestampMs": {
- "type": "string",
- "description": "The timestamp (ms since epoch) that this note was created. (readonly)",
- "format": "int64"
- }
- }
- },
- "MarketplaceOffer": {
- "id": "MarketplaceOffer",
- "type": "object",
- "description": "An offer is segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps buyer know more about the inventory. Each field in an order can have one of the following setting:\n\n(readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.",
- "properties": {
- "creationTimeMs": {
- "type": "string",
- "description": "Creation time in ms. since epoch (readonly)",
- "format": "int64"
- },
- "creatorContacts": {
- "type": "array",
- "description": "Optional contact information for the creator of this offer. (buyer-readonly)",
- "items": {
- "$ref": "ContactInformation"
- }
- },
- "flightEndTimeMs": {
- "type": "string",
- "description": "The proposed end time for the deal (ms since epoch) (buyer-readonly)",
- "format": "int64"
- },
- "flightStartTimeMs": {
- "type": "string",
- "description": "Inventory availability dates. (times are in ms since epoch) The granularity is generally in the order of seconds. (buyer-readonly)",
- "format": "int64"
- },
- "hasCreatorSignedOff": {
- "type": "boolean",
- "description": "If the creator has already signed off on the offer, then the buyer can finalize the deal by accepting the offer as is. When copying to an order, if any of the terms are changed, then auto_finalize is automatically set to false."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#marketplaceOffer\".",
- "default": "adexchangebuyer#marketplaceOffer"
- },
- "labels": {
- "type": "array",
- "description": "Optional List of labels for the offer (optional, buyer-readonly).",
- "items": {
- "$ref": "MarketplaceLabel"
- }
- },
- "lastUpdateTimeMs": {
- "type": "string",
- "description": "Time of last update in ms. since epoch (readonly)",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "The name for this offer as set by the seller. (buyer-readonly)"
- },
- "offerId": {
- "type": "string",
- "description": "The unique id for the offer (readonly)"
- },
- "revisionNumber": {
- "type": "string",
- "description": "The revision number of the offer. (readonly)",
- "format": "int64"
- },
- "seller": {
- "$ref": "Seller",
- "description": "Information about the seller that created this offer (readonly, except on create)"
- },
- "sharedTargetings": {
- "type": "array",
- "description": "Targeting that is shared between the buyer and the seller. Each targeting criteria has a specified key and for each key there is a list of inclusion value or exclusion values. (buyer-readonly)",
- "items": {
- "$ref": "SharedTargeting"
- }
- },
- "state": {
- "type": "string",
- "description": "The state of the offer. (buyer-readonly)"
- },
- "syndicationProduct": {
- "type": "string",
- "description": "The syndication product associated with the deal. (readonly, except on create)"
- },
- "terms": {
- "$ref": "DealTerms",
- "description": "The negotiable terms of the deal (buyer-readonly)"
- },
- "webPropertyCode": {
- "type": "string"
- }
- }
- },
- "MarketplaceOrder": {
- "id": "MarketplaceOrder",
- "type": "object",
- "description": "Represents an order in the marketplace. An order is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in an order can have one of the following setting:\n\n(readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.",
- "properties": {
- "billedBuyer": {
- "$ref": "Buyer",
- "description": "Reference to the buyer that will get billed for this order. (readonly)"
- },
- "buyer": {
- "$ref": "Buyer",
- "description": "Reference to the buyer on the order. (readonly, except on create)"
- },
- "buyerContacts": {
- "type": "array",
- "description": "Optional contact information fort the buyer. (seller-readonly)",
- "items": {
- "$ref": "ContactInformation"
- }
- },
- "buyerPrivateData": {
- "$ref": "PrivateData",
- "description": "Private data for buyer. (hidden from seller)."
- },
- "hasBuyerSignedOff": {
- "type": "boolean",
- "description": "When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (seller-readonly)"
- },
- "hasSellerSignedOff": {
- "type": "boolean",
- "description": "When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (buyer-readonly)"
- },
- "isRenegotiating": {
- "type": "boolean",
- "description": "True if the order is being renegotiated (readonly)."
- },
- "isSetupComplete": {
- "type": "boolean",
- "description": "True, if the buyside inventory setup is complete for this order. (readonly)"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#marketplaceOrder\".",
- "default": "adexchangebuyer#marketplaceOrder"
- },
- "labels": {
- "type": "array",
- "description": "List of labels associated with the order. (readonly)",
- "items": {
- "$ref": "MarketplaceLabel"
- }
- },
- "lastUpdaterOrCommentorRole": {
- "type": "string",
- "description": "The role of the last user that either updated the order or left a comment. (readonly)"
- },
- "lastUpdaterRole": {
- "type": "string"
- },
- "name": {
- "type": "string",
- "description": "The name for the order (updatable)"
- },
- "orderId": {
- "type": "string",
- "description": "The unique id of the order. (readonly)."
- },
- "orderState": {
- "type": "string",
- "description": "The current state of the order. (readonly)"
- },
- "originatorRole": {
- "type": "string",
- "description": "Indicates whether the buyer/seller created the offer.(readonly)"
- },
- "revisionNumber": {
- "type": "string",
- "description": "The revision number for the order (readonly).",
- "format": "int64"
- },
- "revisionTimeMs": {
- "type": "string",
- "description": "The time (ms since epoch) when the order was last revised (readonly).",
- "format": "int64"
- },
- "seller": {
- "$ref": "Seller",
- "description": "Reference to the seller on the order. (readonly, except on create)"
- },
- "sellerContacts": {
- "type": "array",
- "description": "Optional contact information for the seller (buyer-readonly).",
- "items": {
- "$ref": "ContactInformation"
- }
- }
- }
- },
- "MoneyDto": {
- "id": "MoneyDto",
- "type": "object",
- "properties": {
- "currencyCode": {
- "type": "string"
- },
- "micros": {
- "type": "string",
- "format": "int64"
- }
- }
- },
- "NegotiationDto": {
- "id": "NegotiationDto",
- "type": "object",
- "properties": {
- "billedBuyer": {
- "$ref": "DealPartyDto",
- "description": "The billed buyer; Specified by a buyer buying through an intermediary."
- },
- "buyer": {
- "$ref": "DealPartyDto",
- "description": "Details of the buyer party in this negotiation."
- },
- "buyerEmailContacts": {
- "type": "array",
- "description": "The buyer party's contact email.",
- "items": {
- "type": "string"
- }
- },
- "dealType": {
- "type": "string",
- "description": "The type of this deal."
- },
- "externalDealId": {
- "type": "string",
- "description": "For finalized negotiations, the ID of the finalized deal.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "default": "adexchangebuyer#negotiation"
- },
- "labelNames": {
- "type": "array",
- "description": "A list of label names applicable to this negotiation.",
- "items": {
- "type": "string"
- }
- },
- "negotiationId": {
- "type": "string",
- "description": "The unique ID of this negotiation.",
- "format": "int64"
- },
- "negotiationRounds": {
- "type": "array",
- "description": "The series of negotiation rounds for this negotiation.",
- "items": {
- "$ref": "NegotiationRoundDto"
- }
- },
- "negotiationState": {
- "type": "string",
- "description": "The state of this negotiation."
- },
- "offerId": {
- "type": "string",
- "description": "The ID of this negotiation's original offer.",
- "format": "int64"
- },
- "seller": {
- "$ref": "DealPartyDto",
- "description": "Details of the seller party in this negotiation."
- },
- "sellerEmailContacts": {
- "type": "array",
- "description": "The seller party's contact email.",
- "items": {
- "type": "string"
- }
- },
- "stats": {
- "$ref": "StatsDto",
- "description": "The stats for this negotiation."
- },
- "status": {
- "type": "string",
- "description": "The status of this negotiation."
- }
- }
- },
- "NegotiationRoundDto": {
- "id": "NegotiationRoundDto",
- "type": "object",
- "properties": {
- "action": {
- "type": "string",
- "description": "The action performed by this negotiation round."
- },
- "dbmPartnerId": {
- "type": "string",
- "description": "Stores DBM partner ID for use by DBM",
- "format": "int64"
- },
- "editHistory": {
- "$ref": "EditHistoryDto",
- "description": "The edit history of this negotiation round."
- },
- "kind": {
- "type": "string",
- "default": "adexchangebuyer#negotiationRound"
- },
- "negotiationId": {
- "type": "string",
- "description": "The ID of the negotiation to which this negotiation round applies.",
- "format": "int64"
- },
- "notes": {
- "type": "string",
- "description": "Notes regarding this negotiation round."
- },
- "originatorRole": {
- "type": "string",
- "description": "The role, either buyer or seller, initiating this negotiation round."
- },
- "roundNumber": {
- "type": "string",
- "description": "The number of this negotiation round, in sequence.",
- "format": "int64"
- },
- "terms": {
- "$ref": "TermsDto",
- "description": "The detailed terms proposed in this negotiation round."
- }
- }
- },
- "OfferDto": {
- "id": "OfferDto",
- "type": "object",
- "properties": {
- "anonymous": {
- "type": "boolean",
- "description": "Whether this offer is anonymous."
- },
- "billedBuyer": {
- "$ref": "DealPartyDto",
- "description": "The billed buyer; For buyer initiated offers, buying through an intermediary."
- },
- "closedToDealParties": {
- "type": "array",
- "description": "The list of buyer or seller parties this offer is closed to.",
- "items": {
- "$ref": "DealPartyDto"
- }
- },
- "creator": {
- "$ref": "DealPartyDto",
- "description": "The creator of this offer."
- },
- "emailContacts": {
- "type": "array",
- "description": "The list of email contacts for this offer.",
- "items": {
- "type": "string"
- }
- },
- "isOpen": {
- "type": "boolean",
- "description": "Whether this offer is open."
- },
- "kind": {
- "type": "string",
- "default": "adexchangebuyer#offer"
- },
- "labelNames": {
- "type": "array",
- "description": "The list of label names applicable to this offer.",
- "items": {
- "type": "string"
- }
- },
- "offerId": {
- "type": "string",
- "description": "The unique ID of this offer.",
- "format": "int64"
- },
- "offerState": {
- "type": "string",
- "description": "The state of this offer."
- },
- "openToDealParties": {
- "type": "array",
- "description": "The list of buyer or seller parties this offer is open to.",
- "items": {
- "$ref": "DealPartyDto"
- }
- },
- "pointOfContact": {
- "type": "string",
- "description": "The point of contact for this offer."
- },
- "status": {
- "type": "string",
- "description": "The status of this offer."
- },
- "terms": {
- "$ref": "TermsDto",
- "description": "The terms of this offer."
- }
- }
- },
- "PerformanceReport": {
- "id": "PerformanceReport",
- "type": "object",
- "description": "The configuration data for an Ad Exchange performance report list.",
- "properties": {
- "bidRate": {
- "type": "number",
- "description": "The number of bid responses with an ad.",
- "format": "double"
- },
- "bidRequestRate": {
- "type": "number",
- "description": "The number of bid requests sent to your bidder.",
- "format": "double"
- },
- "calloutStatusRate": {
- "type": "array",
- "description": "Rate of various prefiltering statuses per match. Please refer to the callout-status-codes.txt file for different statuses.",
- "items": {
- "type": "any"
- }
- },
- "cookieMatcherStatusRate": {
- "type": "array",
- "description": "Average QPS for cookie matcher operations.",
- "items": {
- "type": "any"
- }
- },
- "creativeStatusRate": {
- "type": "array",
- "description": "Rate of ads with a given status. Please refer to the creative-status-codes.txt file for different statuses.",
- "items": {
- "type": "any"
- }
- },
- "filteredBidRate": {
- "type": "number",
- "description": "The number of bid responses that were filtered due to a policy violation or other errors.",
- "format": "double"
- },
- "hostedMatchStatusRate": {
- "type": "array",
- "description": "Average QPS for hosted match operations.",
- "items": {
- "type": "any"
- }
- },
- "inventoryMatchRate": {
- "type": "number",
- "description": "The number of potential queries based on your pretargeting settings.",
- "format": "double"
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#performanceReport"
- },
- "latency50thPercentile": {
- "type": "number",
- "description": "The 50th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
- "format": "double"
- },
- "latency85thPercentile": {
- "type": "number",
- "description": "The 85th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
- "format": "double"
- },
- "latency95thPercentile": {
- "type": "number",
- "description": "The 95th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
- "format": "double"
- },
- "noQuotaInRegion": {
- "type": "number",
- "description": "Rate of various quota account statuses per quota check.",
- "format": "double"
- },
- "outOfQuota": {
- "type": "number",
- "description": "Rate of various quota account statuses per quota check.",
- "format": "double"
- },
- "pixelMatchRequests": {
- "type": "number",
- "description": "Average QPS for pixel match requests from clients.",
- "format": "double"
- },
- "pixelMatchResponses": {
- "type": "number",
- "description": "Average QPS for pixel match responses from clients.",
- "format": "double"
- },
- "quotaConfiguredLimit": {
- "type": "number",
- "description": "The configured quota limits for this account.",
- "format": "double"
- },
- "quotaThrottledLimit": {
- "type": "number",
- "description": "The throttled quota limits for this account.",
- "format": "double"
- },
- "region": {
- "type": "string",
- "description": "The trading location of this data."
- },
- "successfulRequestRate": {
- "type": "number",
- "description": "The number of properly formed bid responses received by our servers within the deadline.",
- "format": "double"
- },
- "timestamp": {
- "type": "string",
- "description": "The unix timestamp of the starting time of this performance data.",
- "format": "int64"
- },
- "unsuccessfulRequestRate": {
- "type": "number",
- "description": "The number of bid responses that were unsuccessful due to timeouts, incorrect formatting, etc.",
- "format": "double"
- }
- }
- },
- "PerformanceReportList": {
- "id": "PerformanceReportList",
- "type": "object",
- "description": "The configuration data for an Ad Exchange performance report list. https://sites.google.com/a/google.com/adx-integration/Home/engineering/binary-releases/rtb-api-release https://cs.corp.google.com/#piper///depot/google3/contentads/adx/tools/rtb_api/adxrtb.py",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#performanceReportList"
- },
- "performanceReport": {
- "type": "array",
- "description": "A list of performance reports relevant for the account.",
- "items": {
- "$ref": "PerformanceReport"
- }
- }
- }
- },
- "PretargetingConfig": {
- "id": "PretargetingConfig",
- "type": "object",
- "properties": {
- "billingId": {
- "type": "string",
- "description": "The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.",
- "format": "int64"
- },
- "configId": {
- "type": "string",
- "description": "The config id; generated automatically. Leave this field blank for insert requests.",
- "format": "int64"
- },
- "configName": {
- "type": "string",
- "description": "The name of the config. Must be unique. Required for all requests."
- },
- "creativeType": {
- "type": "array",
- "description": "List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.",
- "items": {
- "type": "string"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.",
- "items": {
- "type": "object",
- "properties": {
- "height": {
- "type": "string",
- "description": "Height in pixels.",
- "format": "int64"
- },
- "width": {
- "type": "string",
- "description": "Width in pixels.",
- "format": "int64"
- }
- }
- }
- },
- "excludedContentLabels": {
- "type": "array",
- "description": "Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "excludedGeoCriteriaIds": {
- "type": "array",
- "description": "Requests containing any of these geo criteria ids will not match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "excludedPlacements": {
- "type": "array",
- "description": "Requests containing any of these placements will not match.",
- "items": {
- "type": "object",
- "properties": {
- "token": {
- "type": "string",
- "description": "The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement."
- },
- "type": {
- "type": "string",
- "description": "The type of the placement."
- }
- }
- }
- },
- "excludedUserLists": {
- "type": "array",
- "description": "Requests containing any of these users list ids will not match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "excludedVerticals": {
- "type": "array",
- "description": "Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "geoCriteriaIds": {
- "type": "array",
- "description": "Requests containing any of these geo criteria ids will match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "isActive": {
- "type": "boolean",
- "description": "Whether this config is active. Required for all requests."
- },
- "kind": {
- "type": "string",
- "description": "The kind of the resource, i.e. \"adexchangebuyer#pretargetingConfig\".",
- "default": "adexchangebuyer#pretargetingConfig"
- },
- "languages": {
- "type": "array",
- "description": "Request containing any of these language codes will match.",
- "items": {
- "type": "string"
- }
- },
- "mobileCarriers": {
- "type": "array",
- "description": "Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "mobileDevices": {
- "type": "array",
- "description": "Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "mobileOperatingSystemVersions": {
- "type": "array",
- "description": "Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "placements": {
- "type": "array",
- "description": "Requests containing any of these placements will match.",
- "items": {
- "type": "object",
- "properties": {
- "token": {
- "type": "string",
- "description": "The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement."
- },
- "type": {
- "type": "string",
- "description": "The type of the placement."
- }
- }
- }
- },
- "platforms": {
- "type": "array",
- "description": "Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.",
- "items": {
- "type": "string"
- }
- },
- "supportedCreativeAttributes": {
- "type": "array",
- "description": "Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "userLists": {
- "type": "array",
- "description": "Requests containing any of these user list ids will match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "vendorTypes": {
- "type": "array",
- "description": "Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "verticals": {
- "type": "array",
- "description": "Requests containing any of these vertical ids will match.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- }
- }
- },
- "PretargetingConfigList": {
- "id": "PretargetingConfigList",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of pretargeting configs",
- "items": {
- "$ref": "PretargetingConfig"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "adexchangebuyer#pretargetingConfigList"
- }
- }
- },
- "Price": {
- "id": "Price",
- "type": "object",
- "properties": {
- "amountMicros": {
- "type": "number",
- "description": "The CPM value in micros.",
- "format": "double"
- },
- "currencyCode": {
- "type": "string",
- "description": "The currency code for the price."
- }
- }
- },
- "PricePerBuyer": {
- "id": "PricePerBuyer",
- "type": "object",
- "description": "Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.",
- "properties": {
- "buyer": {
- "$ref": "Buyer",
- "description": "The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer)."
- },
- "price": {
- "$ref": "Price",
- "description": "The specified price"
- }
- }
- },
- "PrivateData": {
- "id": "PrivateData",
- "type": "object",
- "properties": {
- "referenceId": {
- "type": "string"
- },
- "referencePayload": {
- "type": "string",
- "format": "byte"
- }
- }
- },
- "RuleKeyValuePair": {
- "id": "RuleKeyValuePair",
- "type": "object",
- "properties": {
- "keyName": {
- "type": "string"
- },
- "value": {
- "type": "string"
- }
- }
- },
- "Seller": {
- "id": "Seller",
- "type": "object",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer."
- },
- "subAccountId": {
- "type": "string",
- "description": "Optional sub-account id for the seller."
- }
- }
- },
- "SharedTargeting": {
- "id": "SharedTargeting",
- "type": "object",
- "properties": {
- "exclusions": {
- "type": "array",
- "description": "The list of values to exclude from targeting.",
- "items": {
- "$ref": "TargetingValue"
- }
- },
- "inclusions": {
- "type": "array",
- "description": "The list of value to include as part of the targeting.",
- "items": {
- "$ref": "TargetingValue"
- }
- },
- "key": {
- "type": "string",
- "description": "The key representing the shared targeting criterion."
- }
- }
- },
- "StatsDto": {
- "id": "StatsDto",
- "type": "object",
- "properties": {
- "bids": {
- "type": "string",
- "format": "int64"
- },
- "goodBids": {
- "type": "string",
- "format": "int64"
- },
- "impressions": {
- "type": "string",
- "format": "int64"
- },
- "requests": {
- "type": "string",
- "format": "int64"
- },
- "revenue": {
- "$ref": "MoneyDto"
- },
- "spend": {
- "$ref": "MoneyDto"
- }
- }
- },
- "TargetingValue": {
- "id": "TargetingValue",
- "type": "object",
- "properties": {
- "creativeSizeValue": {
- "$ref": "TargetingValueCreativeSize",
- "description": "The creative size value to exclude/include."
- },
- "dayPartTargetingValue": {
- "$ref": "TargetingValueDayPartTargeting",
- "description": "The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING."
- },
- "longValue": {
- "type": "string",
- "description": "The long value to exclude/include.",
- "format": "int64"
- },
- "stringValue": {
- "type": "string",
- "description": "The string value to exclude/include."
- }
- }
- },
- "TargetingValueCreativeSize": {
- "id": "TargetingValueCreativeSize",
- "type": "object",
- "properties": {
- "companionSizes": {
- "type": "array",
- "description": "For video size type, the list of companion sizes.",
- "items": {
- "$ref": "TargetingValueSize"
- }
- },
- "creativeSizeType": {
- "type": "string",
- "description": "The Creative size type."
- },
- "size": {
- "$ref": "TargetingValueSize",
- "description": "For regular creative size type, specifies the size of the creative."
- }
- }
- },
- "TargetingValueDayPartTargeting": {
- "id": "TargetingValueDayPartTargeting",
- "type": "object",
- "properties": {
- "dayParts": {
- "type": "array",
- "items": {
- "$ref": "TargetingValueDayPartTargetingDayPart"
- }
- },
- "timeZoneType": {
- "type": "string"
- }
- }
- },
- "TargetingValueDayPartTargetingDayPart": {
- "id": "TargetingValueDayPartTargetingDayPart",
- "type": "object",
- "properties": {
- "dayOfWeek": {
- "type": "string"
- },
- "endHour": {
- "type": "integer",
- "format": "int32"
- },
- "endMinute": {
- "type": "integer",
- "format": "int32"
- },
- "startHour": {
- "type": "integer",
- "format": "int32"
- },
- "startMinute": {
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "TargetingValueSize": {
- "id": "TargetingValueSize",
- "type": "object",
- "properties": {
- "height": {
- "type": "integer",
- "description": "The height of the creative.",
- "format": "int32"
- },
- "width": {
- "type": "integer",
- "description": "The width of the creative.",
- "format": "int32"
- }
- }
- },
- "TermsDto": {
- "id": "TermsDto",
- "type": "object",
- "properties": {
- "adSlots": {
- "type": "array",
- "description": "The particular ad slots targeted by the offer.",
- "items": {
- "$ref": "AdSlotDto"
- }
- },
- "advertisers": {
- "type": "array",
- "description": "A list of advertisers for this offer.",
- "items": {
- "$ref": "AdvertiserDto"
- }
- },
- "audienceSegment": {
- "$ref": "AudienceSegment",
- "description": "The audience segment for the offer."
- },
- "audienceSegmentDescription": {
- "type": "string",
- "description": "A description of the audience segment for the offer."
- },
- "billingTerms": {
- "type": "string",
- "description": "The billing terms."
- },
- "buyerBillingType": {
- "type": "string",
- "description": "The buyer billing type."
- },
- "cpm": {
- "$ref": "MoneyDto",
- "description": "The cpm terms."
- },
- "creativeBlockingLevel": {
- "type": "string",
- "description": "Whether to use or ignore publisher blocking rules."
- },
- "creativeReviewPolicy": {
- "type": "string",
- "description": "Whether to use publisher review policy or AdX review policy."
- },
- "dealPremium": {
- "$ref": "MoneyDto",
- "description": "The premium terms."
- },
- "description": {
- "type": "string",
- "description": "A description for these terms."
- },
- "descriptiveName": {
- "type": "string",
- "description": "A descriptive name for these terms."
- },
- "endDate": {
- "$ref": "DateTime",
- "description": "The end date for the offer."
- },
- "estimatedImpressionsPerDay": {
- "type": "string",
- "description": "The estimated daily impressions for the offer.",
- "format": "int64"
- },
- "estimatedSpend": {
- "$ref": "MoneyDto",
- "description": "The estimated spend for the offer."
- },
- "finalizeAutomatically": {
- "type": "boolean",
- "description": "If true, the offer will finalize automatically when accepted."
- },
- "inventorySegmentTargeting": {
- "$ref": "InventorySegmentTargeting",
- "description": "The inventory segment targeting for the offer."
- },
- "isReservation": {
- "type": "boolean",
- "description": "Whether the offer is a reservation."
- },
- "minimumSpendMicros": {
- "type": "string",
- "description": "The minimum spend for the offer.",
- "format": "int64"
- },
- "minimumTrueLooks": {
- "type": "string",
- "description": "The minimum true looks for the offer.",
- "format": "int64"
- },
- "monetizerType": {
- "type": "string",
- "description": "The monetizer type."
- },
- "semiTransparent": {
- "type": "boolean",
- "description": "Whether this offer is semi-transparent."
- },
- "startDate": {
- "$ref": "DateTime",
- "description": "The start date for the offer."
- },
- "targetByDealId": {
- "type": "boolean",
- "description": "Whether to target by deal id."
- },
- "targetingAllAdSlots": {
- "type": "boolean",
- "description": "If true, the offer targets all ad slots."
- },
- "termsAttributes": {
- "type": "array",
- "description": "A list of terms attributes.",
- "items": {
- "type": "string"
- }
- },
- "urls": {
- "type": "array",
- "description": "The urls applicable to the offer.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "WebPropertyDto": {
- "id": "WebPropertyDto",
- "type": "object",
- "properties": {
- "allowInterestTargetedAds": {
- "type": "boolean"
- },
- "enabledForPreferredDeals": {
- "type": "boolean"
- },
- "id": {
- "type": "integer",
- "format": "int32"
- },
- "name": {
- "type": "string"
- },
- "propertyCode": {
- "type": "string"
- },
- "siteUrls": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "syndicationProduct": {
- "type": "string"
- }
- }
- }
- },
- "resources": {
- "accounts": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.accounts.get",
- "path": "accounts/{id}",
- "httpMethod": "GET",
- "description": "Gets one account by ID.",
- "parameters": {
- "id": {
- "type": "integer",
- "description": "The account id",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.accounts.list",
- "path": "accounts",
- "httpMethod": "GET",
- "description": "Retrieves the authenticated user's list of accounts.",
- "response": {
- "$ref": "AccountsList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "patch": {
- "id": "adexchangebuyer.accounts.patch",
- "path": "accounts/{id}",
- "httpMethod": "PATCH",
- "description": "Updates an existing account. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "integer",
- "description": "The account id",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "update": {
- "id": "adexchangebuyer.accounts.update",
- "path": "accounts/{id}",
- "httpMethod": "PUT",
- "description": "Updates an existing account.",
- "parameters": {
- "id": {
- "type": "integer",
- "description": "The account id",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "billingInfo": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.billingInfo.get",
- "path": "billinginfo/{accountId}",
- "httpMethod": "GET",
- "description": "Returns the billing information for one account specified by account ID.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "The account id.",
- "required": true,
- "format": "int32",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "BillingInfo"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.billingInfo.list",
- "path": "billinginfo",
- "httpMethod": "GET",
- "description": "Retrieves a list of billing information for all accounts of the authenticated user.",
- "response": {
- "$ref": "BillingInfoList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "budget": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.budget.get",
- "path": "billinginfo/{accountId}/{billingId}",
- "httpMethod": "GET",
- "description": "Returns the budget information for the adgroup specified by the accountId and billingId.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to get the budget information for.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "billingId": {
- "type": "string",
- "description": "The billing id to get the budget information for.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "billingId"
- ],
- "response": {
- "$ref": "Budget"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "patch": {
- "id": "adexchangebuyer.budget.patch",
- "path": "billinginfo/{accountId}/{billingId}",
- "httpMethod": "PATCH",
- "description": "Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id associated with the budget being updated.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "billingId": {
- "type": "string",
- "description": "The billing id associated with the budget being updated.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "billingId"
- ],
- "request": {
- "$ref": "Budget"
- },
- "response": {
- "$ref": "Budget"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "update": {
- "id": "adexchangebuyer.budget.update",
- "path": "billinginfo/{accountId}/{billingId}",
- "httpMethod": "PUT",
- "description": "Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id associated with the budget being updated.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "billingId": {
- "type": "string",
- "description": "The billing id associated with the budget being updated.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "billingId"
- ],
- "request": {
- "$ref": "Budget"
- },
- "response": {
- "$ref": "Budget"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "clientaccess": {
- "methods": {
- "delete": {
- "id": "adexchangebuyer.clientaccess.delete",
- "path": "clientAccess/{clientAccountId}",
- "httpMethod": "DELETE",
- "parameters": {
- "clientAccountId": {
- "type": "string",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "sponsorAccountId": {
- "type": "integer",
- "required": true,
- "format": "int32",
- "location": "query"
- }
- },
- "parameterOrder": [
- "clientAccountId",
- "sponsorAccountId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "get": {
- "id": "adexchangebuyer.clientaccess.get",
- "path": "clientAccess/{clientAccountId}",
- "httpMethod": "GET",
- "parameters": {
- "clientAccountId": {
- "type": "string",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "sponsorAccountId": {
- "type": "integer",
- "required": true,
- "format": "int32",
- "location": "query"
- }
- },
- "parameterOrder": [
- "clientAccountId",
- "sponsorAccountId"
- ],
- "response": {
- "$ref": "ClientAccessCapabilities"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "insert": {
- "id": "adexchangebuyer.clientaccess.insert",
- "path": "clientAccess",
- "httpMethod": "POST",
- "parameters": {
- "clientAccountId": {
- "type": "string",
- "format": "int64",
- "location": "query"
- },
- "sponsorAccountId": {
- "type": "integer",
- "format": "int32",
- "location": "query"
- }
- },
- "request": {
- "$ref": "ClientAccessCapabilities"
- },
- "response": {
- "$ref": "ClientAccessCapabilities"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.clientaccess.list",
- "path": "clientAccess",
- "httpMethod": "GET",
- "request": {
- "$ref": "ListClientAccessCapabilitiesRequest"
- },
- "response": {
- "$ref": "ListClientAccessCapabilitiesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "patch": {
- "id": "adexchangebuyer.clientaccess.patch",
- "path": "clientAccess/{clientAccountId}",
- "httpMethod": "PATCH",
- "parameters": {
- "clientAccountId": {
- "type": "string",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "sponsorAccountId": {
- "type": "integer",
- "required": true,
- "format": "int32",
- "location": "query"
- }
- },
- "parameterOrder": [
- "clientAccountId",
- "sponsorAccountId"
- ],
- "request": {
- "$ref": "ClientAccessCapabilities"
- },
- "response": {
- "$ref": "ClientAccessCapabilities"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "update": {
- "id": "adexchangebuyer.clientaccess.update",
- "path": "clientAccess/{clientAccountId}",
- "httpMethod": "PUT",
- "parameters": {
- "clientAccountId": {
- "type": "string",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "sponsorAccountId": {
- "type": "integer",
- "required": true,
- "format": "int32",
- "location": "query"
- }
- },
- "parameterOrder": [
- "clientAccountId",
- "sponsorAccountId"
- ],
- "request": {
- "$ref": "ClientAccessCapabilities"
- },
- "response": {
- "$ref": "ClientAccessCapabilities"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "creatives": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.creatives.get",
- "path": "creatives/{accountId}/{buyerCreativeId}",
- "httpMethod": "GET",
- "description": "Gets the status for a single creative. A creative will be available 30-40 minutes after submission.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "The id for the account that will serve this creative.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "buyerCreativeId": {
- "type": "string",
- "description": "The buyer-specific id for this creative.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "buyerCreativeId"
- ],
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "insert": {
- "id": "adexchangebuyer.creatives.insert",
- "path": "creatives",
- "httpMethod": "POST",
- "description": "Submit a new creative.",
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.creatives.list",
- "path": "creatives",
- "httpMethod": "GET",
- "description": "Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.",
- "parameters": {
- "accountId": {
- "type": "integer",
- "description": "When specified, only creatives for the given account ids are returned.",
- "format": "int32",
- "repeated": true,
- "location": "query"
- },
- "buyerCreativeId": {
- "type": "string",
- "description": "When specified, only creatives for the given buyer creative ids are returned.",
- "repeated": true,
- "location": "query"
- },
- "dealsStatusFilter": {
- "type": "string",
- "description": "When specified, only creatives having the given direct deals status are returned.",
- "enum": [
- "approved",
- "conditionally_approved",
- "disapproved",
- "not_checked"
- ],
- "enumDescriptions": [
- "Creatives which have been approved for serving on direct deals.",
- "Creatives which have been conditionally approved for serving on direct deals.",
- "Creatives which have been disapproved for serving on direct deals.",
- "Creatives whose direct deals status is not yet checked."
- ],
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
- "format": "uint32",
- "minimum": "1",
- "maximum": "1000",
- "location": "query"
- },
- "openAuctionStatusFilter": {
- "type": "string",
- "description": "When specified, only creatives having the given open auction status are returned.",
- "enum": [
- "approved",
- "conditionally_approved",
- "disapproved",
- "not_checked"
- ],
- "enumDescriptions": [
- "Creatives which have been approved for serving on the open auction.",
- "Creatives which have been conditionally approved for serving on the open auction.",
- "Creatives which have been disapproved for serving on the open auction.",
- "Creatives whose open auction status is not yet checked."
- ],
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response. Optional.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "CreativesList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "deals": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.deals.get",
- "path": "deals/{dealId}",
- "httpMethod": "GET",
- "description": "Gets the requested deal.",
- "parameters": {
- "dealId": {
- "type": "string",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "dealId"
- ],
- "request": {
- "$ref": "GetFinalizedNegotiationByExternalDealIdRequest"
- },
- "response": {
- "$ref": "NegotiationDto"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "marketplacedeals": {
- "methods": {
- "delete": {
- "id": "adexchangebuyer.marketplacedeals.delete",
- "path": "marketplaceOrders/{orderId}/deals/delete",
- "httpMethod": "POST",
- "description": "Delete the specified deals from the order",
- "parameters": {
- "orderId": {
- "type": "string",
- "description": "The orderId to delete deals from.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "orderId"
- ],
- "request": {
- "$ref": "DeleteOrderDealsRequest"
- },
- "response": {
- "$ref": "DeleteOrderDealsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "insert": {
- "id": "adexchangebuyer.marketplacedeals.insert",
- "path": "marketplaceOrders/{orderId}/deals/insert",
- "httpMethod": "POST",
- "description": "Add new deals for the specified order",
- "parameters": {
- "orderId": {
- "type": "string",
- "description": "OrderId for which deals need to be added.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "orderId"
- ],
- "request": {
- "$ref": "AddOrderDealsRequest"
- },
- "response": {
- "$ref": "AddOrderDealsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.marketplacedeals.list",
- "path": "marketplaceOrders/{orderId}/deals",
- "httpMethod": "GET",
- "description": "List all the deals for a given order",
- "parameters": {
- "orderId": {
- "type": "string",
- "description": "The orderId to get deals for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "orderId"
- ],
- "response": {
- "$ref": "GetOrderDealsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "update": {
- "id": "adexchangebuyer.marketplacedeals.update",
- "path": "marketplaceOrders/{orderId}/deals/update",
- "httpMethod": "POST",
- "description": "Replaces all the deals in the order with the passed in deals",
- "parameters": {
- "orderId": {
- "type": "string",
- "description": "The orderId to edit deals on.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "orderId"
- ],
- "request": {
- "$ref": "EditAllOrderDealsRequest"
- },
- "response": {
- "$ref": "EditAllOrderDealsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "marketplacenotes": {
- "methods": {
- "insert": {
- "id": "adexchangebuyer.marketplacenotes.insert",
- "path": "marketplaceOrders/{orderId}/notes/insert",
- "httpMethod": "POST",
- "description": "Add notes to the order",
- "parameters": {
- "orderId": {
- "type": "string",
- "description": "The orderId to add notes for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "orderId"
- ],
- "request": {
- "$ref": "AddOrderNotesRequest"
- },
- "response": {
- "$ref": "AddOrderNotesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.marketplacenotes.list",
- "path": "marketplaceOrders/{orderId}/notes",
- "httpMethod": "GET",
- "description": "Get all the notes associated with an order",
- "parameters": {
- "orderId": {
- "type": "string",
- "description": "The orderId to get notes for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "orderId"
- ],
- "response": {
- "$ref": "GetOrderNotesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "marketplaceoffers": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.marketplaceoffers.get",
- "path": "marketplaceOffers/{offerId}",
- "httpMethod": "GET",
- "description": "Gets the requested negotiation.",
- "parameters": {
- "offerId": {
- "type": "string",
- "description": "The offerId for the offer to get the head revision for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "offerId"
- ],
- "response": {
- "$ref": "MarketplaceOffer"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "search": {
- "id": "adexchangebuyer.marketplaceoffers.search",
- "path": "marketplaceOffers/search",
- "httpMethod": "GET",
- "description": "Gets the requested negotiation.",
- "parameters": {
- "pqlQuery": {
- "type": "string",
- "description": "The pql query used to query for offers.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "GetOffersResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "marketplaceorders": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.marketplaceorders.get",
- "path": "marketplaceOrders/{orderId}",
- "httpMethod": "GET",
- "description": "Get an order given its id",
- "parameters": {
- "orderId": {
- "type": "string",
- "description": "Id of the order to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "orderId"
- ],
- "response": {
- "$ref": "MarketplaceOrder"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "insert": {
- "id": "adexchangebuyer.marketplaceorders.insert",
- "path": "marketplaceOrders/insert",
- "httpMethod": "POST",
- "description": "Create the given list of orders",
- "request": {
- "$ref": "CreateOrdersRequest"
- },
- "response": {
- "$ref": "CreateOrdersResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "patch": {
- "id": "adexchangebuyer.marketplaceorders.patch",
- "path": "marketplaceOrders/{orderId}/{revisionNumber}/{updateAction}",
- "httpMethod": "PATCH",
- "description": "Update the given order. This method supports patch semantics.",
- "parameters": {
- "orderId": {
- "type": "string",
- "description": "The order id to update.",
- "required": true,
- "location": "path"
- },
- "revisionNumber": {
- "type": "string",
- "description": "The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the lastest order at head revision and retry the update at that revision.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "updateAction": {
- "type": "string",
- "description": "The proposed action to take on the order.",
- "required": true,
- "enum": [
- "accept",
- "cancel",
- "propose",
- "unknownAction",
- "updateFinalized"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "path"
- }
- },
- "parameterOrder": [
- "orderId",
- "revisionNumber",
- "updateAction"
- ],
- "request": {
- "$ref": "MarketplaceOrder"
- },
- "response": {
- "$ref": "MarketplaceOrder"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "search": {
- "id": "adexchangebuyer.marketplaceorders.search",
- "path": "marketplaceOrders/search",
- "httpMethod": "GET",
- "description": "Search for orders using pql query",
- "parameters": {
- "pqlQuery": {
- "type": "string",
- "description": "Query string to retrieve specific orders.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "GetOrdersResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "update": {
- "id": "adexchangebuyer.marketplaceorders.update",
- "path": "marketplaceOrders/{orderId}/{revisionNumber}/{updateAction}",
- "httpMethod": "PUT",
- "description": "Update the given order",
- "parameters": {
- "orderId": {
- "type": "string",
- "description": "The order id to update.",
- "required": true,
- "location": "path"
- },
- "revisionNumber": {
- "type": "string",
- "description": "The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the lastest order at head revision and retry the update at that revision.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "updateAction": {
- "type": "string",
- "description": "The proposed action to take on the order.",
- "required": true,
- "enum": [
- "accept",
- "cancel",
- "propose",
- "unknownAction",
- "updateFinalized"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "path"
- }
- },
- "parameterOrder": [
- "orderId",
- "revisionNumber",
- "updateAction"
- ],
- "request": {
- "$ref": "MarketplaceOrder"
- },
- "response": {
- "$ref": "MarketplaceOrder"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "negotiationrounds": {
- "methods": {
- "insert": {
- "id": "adexchangebuyer.negotiationrounds.insert",
- "path": "negotiations/{negotiationId}/negotiationrounds",
- "httpMethod": "POST",
- "description": "Adds the requested negotiationRound to the requested negotiation.",
- "parameters": {
- "negotiationId": {
- "type": "string",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "negotiationId"
- ],
- "request": {
- "$ref": "NegotiationRoundDto"
- },
- "response": {
- "$ref": "NegotiationRoundDto"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "negotiations": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.negotiations.get",
- "path": "negotiations/{negotiationId}",
- "httpMethod": "GET",
- "description": "Gets the requested negotiation.",
- "parameters": {
- "negotiationId": {
- "type": "string",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "negotiationId"
- ],
- "request": {
- "$ref": "GetNegotiationByIdRequest"
- },
- "response": {
- "$ref": "NegotiationDto"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "insert": {
- "id": "adexchangebuyer.negotiations.insert",
- "path": "negotiations",
- "httpMethod": "POST",
- "description": "Creates or updates the requested negotiation.",
- "request": {
- "$ref": "NegotiationDto"
- },
- "response": {
- "$ref": "NegotiationDto"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.negotiations.list",
- "path": "negotiations",
- "httpMethod": "GET",
- "description": "Lists all negotiations the authenticated user has access to.",
- "request": {
- "$ref": "GetNegotiationsRequest"
- },
- "response": {
- "$ref": "GetNegotiationsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "offers": {
- "methods": {
- "get": {
- "id": "adexchangebuyer.offers.get",
- "path": "offers/{offerId}",
- "httpMethod": "GET",
- "description": "Gets the requested offer.",
- "parameters": {
- "offerId": {
- "type": "string",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "offerId"
- ],
- "response": {
- "$ref": "OfferDto"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "insert": {
- "id": "adexchangebuyer.offers.insert",
- "path": "offers",
- "httpMethod": "POST",
- "description": "Creates or updates the requested offer.",
- "request": {
- "$ref": "OfferDto"
- },
- "response": {
- "$ref": "OfferDto"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.offers.list",
- "path": "offers",
- "httpMethod": "GET",
- "description": "Lists all offers the authenticated user has access to.",
- "request": {
- "$ref": "ListOffersRequest"
- },
- "response": {
- "$ref": "ListOffersResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "performanceReport": {
- "methods": {
- "list": {
- "id": "adexchangebuyer.performanceReport.list",
- "path": "performancereport",
- "httpMethod": "GET",
- "description": "Retrieves the authenticated user's list of performance metrics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to get the reports.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "endDateTime": {
- "type": "string",
- "description": "The end time of the report in ISO 8601 timestamp format using UTC.",
- "required": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
- "format": "uint32",
- "minimum": "1",
- "maximum": "1000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through performance reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response. Optional.",
- "location": "query"
- },
- "startDateTime": {
- "type": "string",
- "description": "The start time of the report in ISO 8601 timestamp format using UTC.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "endDateTime",
- "startDateTime"
- ],
- "response": {
- "$ref": "PerformanceReportList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "pretargetingConfig": {
- "methods": {
- "delete": {
- "id": "adexchangebuyer.pretargetingConfig.delete",
- "path": "pretargetingconfigs/{accountId}/{configId}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing pretargeting config.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to delete the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "configId": {
- "type": "string",
- "description": "The specific id of the configuration to delete.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "configId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "get": {
- "id": "adexchangebuyer.pretargetingConfig.get",
- "path": "pretargetingconfigs/{accountId}/{configId}",
- "httpMethod": "GET",
- "description": "Gets a specific pretargeting configuration",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to get the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "configId": {
- "type": "string",
- "description": "The specific id of the configuration to retrieve.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "configId"
- ],
- "response": {
- "$ref": "PretargetingConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "insert": {
- "id": "adexchangebuyer.pretargetingConfig.insert",
- "path": "pretargetingconfigs/{accountId}",
- "httpMethod": "POST",
- "description": "Inserts a new pretargeting configuration.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to insert the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "request": {
- "$ref": "PretargetingConfig"
- },
- "response": {
- "$ref": "PretargetingConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "id": "adexchangebuyer.pretargetingConfig.list",
- "path": "pretargetingconfigs/{accountId}",
- "httpMethod": "GET",
- "description": "Retrieves a list of the authenticated user's pretargeting configurations.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to get the pretargeting configs for.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "PretargetingConfigList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "patch": {
- "id": "adexchangebuyer.pretargetingConfig.patch",
- "path": "pretargetingconfigs/{accountId}/{configId}",
- "httpMethod": "PATCH",
- "description": "Updates an existing pretargeting config. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to update the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "configId": {
- "type": "string",
- "description": "The specific id of the configuration to update.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "configId"
- ],
- "request": {
- "$ref": "PretargetingConfig"
- },
- "response": {
- "$ref": "PretargetingConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "update": {
- "id": "adexchangebuyer.pretargetingConfig.update",
- "path": "pretargetingconfigs/{accountId}/{configId}",
- "httpMethod": "PUT",
- "description": "Updates an existing pretargeting config.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The account id to update the pretargeting config for.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "configId": {
- "type": "string",
- "description": "The specific id of the configuration to update.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "configId"
- ],
- "request": {
- "$ref": "PretargetingConfig"
- },
- "response": {
- "$ref": "PretargetingConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/adexchangebuyer/v1.4/adexchangebuyer-gen.go b/vendor/google.golang.org/api/adexchangebuyer/v1.4/adexchangebuyer-gen.go
deleted file mode 100644
index ab9f9034..00000000
--- a/vendor/google.golang.org/api/adexchangebuyer/v1.4/adexchangebuyer-gen.go
+++ /dev/null
@@ -1,9299 +0,0 @@
-// Package adexchangebuyer provides access to the Ad Exchange Buyer API.
-//
-// See https://developers.google.com/ad-exchange/buyer-rest
-//
-// Usage example:
-//
-// import "google.golang.org/api/adexchangebuyer/v1.4"
-// ...
-// adexchangebuyerService, err := adexchangebuyer.New(oauthHttpClient)
-package adexchangebuyer // import "google.golang.org/api/adexchangebuyer/v1.4"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "adexchangebuyer:v1.4"
-const apiName = "adexchangebuyer"
-const apiVersion = "v1.4"
-const basePath = "https://www.googleapis.com/adexchangebuyer/v1.4/"
-
-// OAuth2 scopes used by this API.
-const (
- // Manage your Ad Exchange buyer account configuration
- AdexchangeBuyerScope = "https://www.googleapis.com/auth/adexchange.buyer"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Accounts = NewAccountsService(s)
- s.BillingInfo = NewBillingInfoService(s)
- s.Budget = NewBudgetService(s)
- s.Clientaccess = NewClientaccessService(s)
- s.Creatives = NewCreativesService(s)
- s.Deals = NewDealsService(s)
- s.Marketplacedeals = NewMarketplacedealsService(s)
- s.Marketplacenotes = NewMarketplacenotesService(s)
- s.Marketplaceoffers = NewMarketplaceoffersService(s)
- s.Marketplaceorders = NewMarketplaceordersService(s)
- s.Negotiationrounds = NewNegotiationroundsService(s)
- s.Negotiations = NewNegotiationsService(s)
- s.Offers = NewOffersService(s)
- s.PerformanceReport = NewPerformanceReportService(s)
- s.PretargetingConfig = NewPretargetingConfigService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Accounts *AccountsService
-
- BillingInfo *BillingInfoService
-
- Budget *BudgetService
-
- Clientaccess *ClientaccessService
-
- Creatives *CreativesService
-
- Deals *DealsService
-
- Marketplacedeals *MarketplacedealsService
-
- Marketplacenotes *MarketplacenotesService
-
- Marketplaceoffers *MarketplaceoffersService
-
- Marketplaceorders *MarketplaceordersService
-
- Negotiationrounds *NegotiationroundsService
-
- Negotiations *NegotiationsService
-
- Offers *OffersService
-
- PerformanceReport *PerformanceReportService
-
- PretargetingConfig *PretargetingConfigService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewAccountsService(s *Service) *AccountsService {
- rs := &AccountsService{s: s}
- return rs
-}
-
-type AccountsService struct {
- s *Service
-}
-
-func NewBillingInfoService(s *Service) *BillingInfoService {
- rs := &BillingInfoService{s: s}
- return rs
-}
-
-type BillingInfoService struct {
- s *Service
-}
-
-func NewBudgetService(s *Service) *BudgetService {
- rs := &BudgetService{s: s}
- return rs
-}
-
-type BudgetService struct {
- s *Service
-}
-
-func NewClientaccessService(s *Service) *ClientaccessService {
- rs := &ClientaccessService{s: s}
- return rs
-}
-
-type ClientaccessService struct {
- s *Service
-}
-
-func NewCreativesService(s *Service) *CreativesService {
- rs := &CreativesService{s: s}
- return rs
-}
-
-type CreativesService struct {
- s *Service
-}
-
-func NewDealsService(s *Service) *DealsService {
- rs := &DealsService{s: s}
- return rs
-}
-
-type DealsService struct {
- s *Service
-}
-
-func NewMarketplacedealsService(s *Service) *MarketplacedealsService {
- rs := &MarketplacedealsService{s: s}
- return rs
-}
-
-type MarketplacedealsService struct {
- s *Service
-}
-
-func NewMarketplacenotesService(s *Service) *MarketplacenotesService {
- rs := &MarketplacenotesService{s: s}
- return rs
-}
-
-type MarketplacenotesService struct {
- s *Service
-}
-
-func NewMarketplaceoffersService(s *Service) *MarketplaceoffersService {
- rs := &MarketplaceoffersService{s: s}
- return rs
-}
-
-type MarketplaceoffersService struct {
- s *Service
-}
-
-func NewMarketplaceordersService(s *Service) *MarketplaceordersService {
- rs := &MarketplaceordersService{s: s}
- return rs
-}
-
-type MarketplaceordersService struct {
- s *Service
-}
-
-func NewNegotiationroundsService(s *Service) *NegotiationroundsService {
- rs := &NegotiationroundsService{s: s}
- return rs
-}
-
-type NegotiationroundsService struct {
- s *Service
-}
-
-func NewNegotiationsService(s *Service) *NegotiationsService {
- rs := &NegotiationsService{s: s}
- return rs
-}
-
-type NegotiationsService struct {
- s *Service
-}
-
-func NewOffersService(s *Service) *OffersService {
- rs := &OffersService{s: s}
- return rs
-}
-
-type OffersService struct {
- s *Service
-}
-
-func NewPerformanceReportService(s *Service) *PerformanceReportService {
- rs := &PerformanceReportService{s: s}
- return rs
-}
-
-type PerformanceReportService struct {
- s *Service
-}
-
-func NewPretargetingConfigService(s *Service) *PretargetingConfigService {
- rs := &PretargetingConfigService{s: s}
- return rs
-}
-
-type PretargetingConfigService struct {
- s *Service
-}
-
-// Account: Configuration data for an Ad Exchange buyer account.
-type Account struct {
- // BidderLocation: Your bidder locations that have distinct URLs.
- BidderLocation []*AccountBidderLocation `json:"bidderLocation,omitempty"`
-
- // CookieMatchingNid: The nid parameter value used in cookie match
- // requests. Please contact your technical account manager if you need
- // to change this.
- CookieMatchingNid string `json:"cookieMatchingNid,omitempty"`
-
- // CookieMatchingUrl: The base URL used in cookie match requests.
- CookieMatchingUrl string `json:"cookieMatchingUrl,omitempty"`
-
- // Id: Account id.
- Id int64 `json:"id,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // MaximumActiveCreatives: The maximum number of active creatives that
- // an account can have, where a creative is active if it was inserted or
- // bid with in the last 30 days. Please contact your technical account
- // manager if you need to change this.
- MaximumActiveCreatives int64 `json:"maximumActiveCreatives,omitempty"`
-
- // MaximumTotalQps: The sum of all bidderLocation.maximumQps values
- // cannot exceed this. Please contact your technical account manager if
- // you need to change this.
- MaximumTotalQps int64 `json:"maximumTotalQps,omitempty"`
-
- // NumberActiveCreatives: The number of creatives that this account
- // inserted or bid with in the last 30 days.
- NumberActiveCreatives int64 `json:"numberActiveCreatives,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "BidderLocation") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Account) MarshalJSON() ([]byte, error) {
- type noMethod Account
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AccountBidderLocation struct {
- // MaximumQps: The maximum queries per second the Ad Exchange will send.
- MaximumQps int64 `json:"maximumQps,omitempty"`
-
- // Region: The geographical region the Ad Exchange should send requests
- // from. Only used by some quota systems, but always setting the value
- // is recommended. Allowed values:
- // - ASIA
- // - EUROPE
- // - US_EAST
- // - US_WEST
- Region string `json:"region,omitempty"`
-
- // Url: The URL to which the Ad Exchange will send bid requests.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "MaximumQps") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountBidderLocation) MarshalJSON() ([]byte, error) {
- type noMethod AccountBidderLocation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountsList: An account feed lists Ad Exchange buyer accounts that
-// the user has access to. Each entry in the feed corresponds to a
-// single buyer account.
-type AccountsList struct {
- // Items: A list of accounts.
- Items []*Account `json:"items,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountsList) MarshalJSON() ([]byte, error) {
- type noMethod AccountsList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdSize struct {
- Height int64 `json:"height,omitempty"`
-
- Width int64 `json:"width,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Height") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdSize) MarshalJSON() ([]byte, error) {
- type noMethod AdSize
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdSlotDto struct {
- ChannelCode string `json:"channelCode,omitempty"`
-
- ChannelId int64 `json:"channelId,omitempty"`
-
- Description string `json:"description,omitempty"`
-
- Name string `json:"name,omitempty"`
-
- Size string `json:"size,omitempty"`
-
- WebPropertyId int64 `json:"webPropertyId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ChannelCode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdSlotDto) MarshalJSON() ([]byte, error) {
- type noMethod AdSlotDto
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AddOrderDealsRequest struct {
- // Deals: The list of deals to add
- Deals []*MarketplaceDeal `json:"deals,omitempty"`
-
- // OrderRevisionNumber: The last known order revision number.
- OrderRevisionNumber int64 `json:"orderRevisionNumber,omitempty,string"`
-
- // UpdateAction: Indicates an optional action to take on the order
- UpdateAction string `json:"updateAction,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Deals") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AddOrderDealsRequest) MarshalJSON() ([]byte, error) {
- type noMethod AddOrderDealsRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AddOrderDealsResponse struct {
- // Deals: List of deals added (in the same order as passed in the
- // request)
- Deals []*MarketplaceDeal `json:"deals,omitempty"`
-
- // OrderRevisionNumber: The updated revision number for the order.
- OrderRevisionNumber int64 `json:"orderRevisionNumber,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Deals") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AddOrderDealsResponse) MarshalJSON() ([]byte, error) {
- type noMethod AddOrderDealsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AddOrderNotesRequest struct {
- // Notes: The list of notes to add.
- Notes []*MarketplaceNote `json:"notes,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Notes") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AddOrderNotesRequest) MarshalJSON() ([]byte, error) {
- type noMethod AddOrderNotesRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AddOrderNotesResponse struct {
- Notes []*MarketplaceNote `json:"notes,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Notes") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AddOrderNotesResponse) MarshalJSON() ([]byte, error) {
- type noMethod AddOrderNotesResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdvertiserDto struct {
- Brands []*BrandDto `json:"brands,omitempty"`
-
- Id int64 `json:"id,omitempty,string"`
-
- Name string `json:"name,omitempty"`
-
- Status string `json:"status,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Brands") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdvertiserDto) MarshalJSON() ([]byte, error) {
- type noMethod AdvertiserDto
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AudienceSegment struct {
- Description string `json:"description,omitempty"`
-
- Id int64 `json:"id,omitempty,string"`
-
- Name string `json:"name,omitempty"`
-
- NumCookies int64 `json:"numCookies,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "Description") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AudienceSegment) MarshalJSON() ([]byte, error) {
- type noMethod AudienceSegment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// BillingInfo: The configuration data for an Ad Exchange billing info.
-type BillingInfo struct {
- // AccountId: Account id.
- AccountId int64 `json:"accountId,omitempty"`
-
- // AccountName: Account name.
- AccountName string `json:"accountName,omitempty"`
-
- // BillingId: A list of adgroup IDs associated with this particular
- // account. These IDs may show up as part of a realtime bidding
- // BidRequest, which indicates a bid request for this account.
- BillingId []string `json:"billingId,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BillingInfo) MarshalJSON() ([]byte, error) {
- type noMethod BillingInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// BillingInfoList: A billing info feed lists Billing Info the Ad
-// Exchange buyer account has access to. Each entry in the feed
-// corresponds to a single billing info.
-type BillingInfoList struct {
- // Items: A list of billing info relevant for your account.
- Items []*BillingInfo `json:"items,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BillingInfoList) MarshalJSON() ([]byte, error) {
- type noMethod BillingInfoList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type BrandDto struct {
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- Id int64 `json:"id,omitempty,string"`
-
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AdvertiserId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BrandDto) MarshalJSON() ([]byte, error) {
- type noMethod BrandDto
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Budget: The configuration data for Ad Exchange RTB - Budget API.
-type Budget struct {
- // AccountId: The id of the account. This is required for get and update
- // requests.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // BillingId: The billing id to determine which adgroup to provide
- // budget information for. This is required for get and update requests.
- BillingId int64 `json:"billingId,omitempty,string"`
-
- // BudgetAmount: The budget amount to apply for the billingId provided.
- // This is required for update requests.
- BudgetAmount int64 `json:"budgetAmount,omitempty,string"`
-
- // CurrencyCode: The currency code for the buyer. This cannot be altered
- // here.
- CurrencyCode string `json:"currencyCode,omitempty"`
-
- // Id: The unique id that describes this item.
- Id string `json:"id,omitempty"`
-
- // Kind: The kind of the resource, i.e. "adexchangebuyer#budget".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Budget) MarshalJSON() ([]byte, error) {
- type noMethod Budget
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Buyer struct {
- // AccountId: Adx account id of the buyer.
- AccountId string `json:"accountId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Buyer) MarshalJSON() ([]byte, error) {
- type noMethod Buyer
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type BuyerDto struct {
- AccountId int64 `json:"accountId,omitempty"`
-
- CustomerId int64 `json:"customerId,omitempty"`
-
- DisplayName string `json:"displayName,omitempty"`
-
- EnabledForInterestTargetingDeals bool `json:"enabledForInterestTargetingDeals,omitempty"`
-
- EnabledForPreferredDeals bool `json:"enabledForPreferredDeals,omitempty"`
-
- Id int64 `json:"id,omitempty"`
-
- SponsorAccountId int64 `json:"sponsorAccountId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BuyerDto) MarshalJSON() ([]byte, error) {
- type noMethod BuyerDto
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ClientAccessCapabilities struct {
- Capabilities []int64 `json:"capabilities,omitempty"`
-
- ClientAccountId int64 `json:"clientAccountId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Capabilities") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ClientAccessCapabilities) MarshalJSON() ([]byte, error) {
- type noMethod ClientAccessCapabilities
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ContactInformation struct {
- // Email: Email address of the contact.
- Email string `json:"email,omitempty"`
-
- // Name: The name of the contact.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Email") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ContactInformation) MarshalJSON() ([]byte, error) {
- type noMethod ContactInformation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CreateOrdersRequest struct {
- // Orders: The list of orders to create.
- Orders []*MarketplaceOrder `json:"orders,omitempty"`
-
- WebPropertyCode string `json:"webPropertyCode,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Orders") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreateOrdersRequest) MarshalJSON() ([]byte, error) {
- type noMethod CreateOrdersRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CreateOrdersResponse struct {
- // Orders: The list of orders successfully created.
- Orders []*MarketplaceOrder `json:"orders,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Orders") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreateOrdersResponse) MarshalJSON() ([]byte, error) {
- type noMethod CreateOrdersResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Creative: A creative and its classification data.
-type Creative struct {
- // HTMLSnippet: The HTML snippet that displays the ad when inserted in
- // the web page. If set, videoURL should not be set.
- HTMLSnippet string `json:"HTMLSnippet,omitempty"`
-
- // AccountId: Account id.
- AccountId int64 `json:"accountId,omitempty"`
-
- // AdvertiserId: Detected advertiser id, if any. Read-only. This field
- // should not be set in requests.
- AdvertiserId googleapi.Int64s `json:"advertiserId,omitempty"`
-
- // AdvertiserName: The name of the company being advertised in the
- // creative.
- AdvertiserName string `json:"advertiserName,omitempty"`
-
- // AgencyId: The agency id for this creative.
- AgencyId int64 `json:"agencyId,omitempty,string"`
-
- // ApiUploadTimestamp: The last upload timestamp of this creative if it
- // was uploaded via API. Read-only. The value of this field is
- // generated, and will be ignored for uploads. (formatted RFC 3339
- // timestamp).
- ApiUploadTimestamp string `json:"api_upload_timestamp,omitempty"`
-
- // Attribute: All attributes for the ads that may be shown from this
- // snippet.
- Attribute []int64 `json:"attribute,omitempty"`
-
- // BuyerCreativeId: A buyer-specific id identifying the creative in this
- // ad.
- BuyerCreativeId string `json:"buyerCreativeId,omitempty"`
-
- // ClickThroughUrl: The set of destination urls for the snippet.
- ClickThroughUrl []string `json:"clickThroughUrl,omitempty"`
-
- // Corrections: Shows any corrections that were applied to this
- // creative. Read-only. This field should not be set in requests.
- Corrections []*CreativeCorrections `json:"corrections,omitempty"`
-
- // DealsStatus: Top-level deals status. Read-only. This field should not
- // be set in requests. If disapproved, an entry for
- // auctionType=DIRECT_DEALS (or ALL) in servingRestrictions will also
- // exist. Note that this may be nuanced with other contextual
- // restrictions, in which case it may be preferable to read from
- // servingRestrictions directly.
- DealsStatus string `json:"dealsStatus,omitempty"`
-
- // FilteringReasons: The filtering reasons for the creative. Read-only.
- // This field should not be set in requests.
- FilteringReasons *CreativeFilteringReasons `json:"filteringReasons,omitempty"`
-
- // Height: Ad height.
- Height int64 `json:"height,omitempty"`
-
- // ImpressionTrackingUrl: The set of urls to be called to record an
- // impression.
- ImpressionTrackingUrl []string `json:"impressionTrackingUrl,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // NativeAd: If nativeAd is set, HTMLSnippet and videoURL should not be
- // set.
- NativeAd *CreativeNativeAd `json:"nativeAd,omitempty"`
-
- // OpenAuctionStatus: Top-level open auction status. Read-only. This
- // field should not be set in requests. If disapproved, an entry for
- // auctionType=OPEN_AUCTION (or ALL) in servingRestrictions will also
- // exist. Note that this may be nuanced with other contextual
- // restrictions, in which case it may be preferable to read from
- // ServingRestrictions directly.
- OpenAuctionStatus string `json:"openAuctionStatus,omitempty"`
-
- // ProductCategories: Detected product categories, if any. Read-only.
- // This field should not be set in requests.
- ProductCategories []int64 `json:"productCategories,omitempty"`
-
- // RestrictedCategories: All restricted categories for the ads that may
- // be shown from this snippet.
- RestrictedCategories []int64 `json:"restrictedCategories,omitempty"`
-
- // SensitiveCategories: Detected sensitive categories, if any.
- // Read-only. This field should not be set in requests.
- SensitiveCategories []int64 `json:"sensitiveCategories,omitempty"`
-
- // ServingRestrictions: The granular status of this ad in specific
- // contexts. A context here relates to where something ultimately serves
- // (for example, a physical location, a platform, an HTTPS vs HTTP
- // request, or the type of auction). Read-only. This field should not be
- // set in requests.
- ServingRestrictions []*CreativeServingRestrictions `json:"servingRestrictions,omitempty"`
-
- // VendorType: All vendor types for the ads that may be shown from this
- // snippet.
- VendorType []int64 `json:"vendorType,omitempty"`
-
- // Version: The version for this creative. Read-only. This field should
- // not be set in requests.
- Version int64 `json:"version,omitempty"`
-
- // VideoURL: The url to fetch a video ad. If set, HTMLSnippet should not
- // be set.
- VideoURL string `json:"videoURL,omitempty"`
-
- // Width: Ad width.
- Width int64 `json:"width,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "HTMLSnippet") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Creative) MarshalJSON() ([]byte, error) {
- type noMethod Creative
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CreativeCorrections struct {
- // Details: Additional details about the correction.
- Details []string `json:"details,omitempty"`
-
- // Reason: The type of correction that was applied to the creative.
- Reason string `json:"reason,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Details") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeCorrections) MarshalJSON() ([]byte, error) {
- type noMethod CreativeCorrections
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeFilteringReasons: The filtering reasons for the creative.
-// Read-only. This field should not be set in requests.
-type CreativeFilteringReasons struct {
- // Date: The date in ISO 8601 format for the data. The data is collected
- // from 00:00:00 to 23:59:59 in PST.
- Date string `json:"date,omitempty"`
-
- // Reasons: The filtering reasons.
- Reasons []*CreativeFilteringReasonsReasons `json:"reasons,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Date") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeFilteringReasons) MarshalJSON() ([]byte, error) {
- type noMethod CreativeFilteringReasons
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CreativeFilteringReasonsReasons struct {
- // FilteringCount: The number of times the creative was filtered for the
- // status. The count is aggregated across all publishers on the
- // exchange.
- FilteringCount int64 `json:"filteringCount,omitempty,string"`
-
- // FilteringStatus: The filtering status code. Please refer to the
- // creative-status-codes.txt file for different statuses.
- FilteringStatus int64 `json:"filteringStatus,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "FilteringCount") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeFilteringReasonsReasons) MarshalJSON() ([]byte, error) {
- type noMethod CreativeFilteringReasonsReasons
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeNativeAd: If nativeAd is set, HTMLSnippet and videoURL should
-// not be set.
-type CreativeNativeAd struct {
- Advertiser string `json:"advertiser,omitempty"`
-
- // AppIcon: The app icon, for app download ads.
- AppIcon *CreativeNativeAdAppIcon `json:"appIcon,omitempty"`
-
- // Body: A long description of the ad.
- Body string `json:"body,omitempty"`
-
- // CallToAction: A label for the button that the user is supposed to
- // click.
- CallToAction string `json:"callToAction,omitempty"`
-
- // ClickTrackingUrl: The URL to use for click tracking.
- ClickTrackingUrl string `json:"clickTrackingUrl,omitempty"`
-
- // Headline: A short title for the ad.
- Headline string `json:"headline,omitempty"`
-
- // Image: A large image.
- Image *CreativeNativeAdImage `json:"image,omitempty"`
-
- // ImpressionTrackingUrl: The URLs are called when the impression is
- // rendered.
- ImpressionTrackingUrl []string `json:"impressionTrackingUrl,omitempty"`
-
- // Logo: A smaller image, for the advertiser logo.
- Logo *CreativeNativeAdLogo `json:"logo,omitempty"`
-
- // Price: The price of the promoted app including the currency info.
- Price string `json:"price,omitempty"`
-
- // StarRating: The app rating in the app store. Must be in the range
- // [0-5].
- StarRating float64 `json:"starRating,omitempty"`
-
- // Store: The URL to the app store to purchase/download the promoted
- // app.
- Store string `json:"store,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Advertiser") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeNativeAd) MarshalJSON() ([]byte, error) {
- type noMethod CreativeNativeAd
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeNativeAdAppIcon: The app icon, for app download ads.
-type CreativeNativeAdAppIcon struct {
- Height int64 `json:"height,omitempty"`
-
- Url string `json:"url,omitempty"`
-
- Width int64 `json:"width,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Height") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeNativeAdAppIcon) MarshalJSON() ([]byte, error) {
- type noMethod CreativeNativeAdAppIcon
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeNativeAdImage: A large image.
-type CreativeNativeAdImage struct {
- Height int64 `json:"height,omitempty"`
-
- Url string `json:"url,omitempty"`
-
- Width int64 `json:"width,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Height") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeNativeAdImage) MarshalJSON() ([]byte, error) {
- type noMethod CreativeNativeAdImage
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeNativeAdLogo: A smaller image, for the advertiser logo.
-type CreativeNativeAdLogo struct {
- Height int64 `json:"height,omitempty"`
-
- Url string `json:"url,omitempty"`
-
- Width int64 `json:"width,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Height") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeNativeAdLogo) MarshalJSON() ([]byte, error) {
- type noMethod CreativeNativeAdLogo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CreativeServingRestrictions struct {
- // Contexts: All known contexts/restrictions.
- Contexts []*CreativeServingRestrictionsContexts `json:"contexts,omitempty"`
-
- // DisapprovalReasons: The reasons for disapproval within this
- // restriction, if any. Note that not all disapproval reasons may be
- // categorized, so it is possible for the creative to have a status of
- // DISAPPROVED or CONDITIONALLY_APPROVED with an empty list for
- // disapproval_reasons. In this case, please reach out to your TAM to
- // help debug the issue.
- DisapprovalReasons []*CreativeServingRestrictionsDisapprovalReasons `json:"disapprovalReasons,omitempty"`
-
- // Reason: Why the creative is ineligible to serve in this context
- // (e.g., it has been explicitly disapproved or is pending review).
- Reason string `json:"reason,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Contexts") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeServingRestrictions) MarshalJSON() ([]byte, error) {
- type noMethod CreativeServingRestrictions
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CreativeServingRestrictionsContexts struct {
- // AuctionType: Only set when contextType=AUCTION_TYPE. Represents the
- // auction types this restriction applies to.
- AuctionType []string `json:"auctionType,omitempty"`
-
- // ContextType: The type of context (e.g., location, platform, auction
- // type, SSL-ness).
- ContextType string `json:"contextType,omitempty"`
-
- // GeoCriteriaId: Only set when contextType=LOCATION. Represents the geo
- // criterias this restriction applies to.
- GeoCriteriaId []int64 `json:"geoCriteriaId,omitempty"`
-
- // Platform: Only set when contextType=PLATFORM. Represents the
- // platforms this restriction applies to.
- Platform []string `json:"platform,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AuctionType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeServingRestrictionsContexts) MarshalJSON() ([]byte, error) {
- type noMethod CreativeServingRestrictionsContexts
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CreativeServingRestrictionsDisapprovalReasons struct {
- // Details: Additional details about the reason for disapproval.
- Details []string `json:"details,omitempty"`
-
- // Reason: The categorized reason for disapproval.
- Reason string `json:"reason,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Details") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeServingRestrictionsDisapprovalReasons) MarshalJSON() ([]byte, error) {
- type noMethod CreativeServingRestrictionsDisapprovalReasons
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativesList: The creatives feed lists the active creatives for the
-// Ad Exchange buyer accounts that the user has access to. Each entry in
-// the feed corresponds to a single creative.
-type CreativesList struct {
- // Items: A list of creatives.
- Items []*Creative `json:"items,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through creatives. To
- // retrieve the next page of results, set the next request's "pageToken"
- // value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativesList) MarshalJSON() ([]byte, error) {
- type noMethod CreativesList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DateTime struct {
- Day int64 `json:"day,omitempty"`
-
- Hour int64 `json:"hour,omitempty"`
-
- Minute int64 `json:"minute,omitempty"`
-
- Month int64 `json:"month,omitempty"`
-
- Second int64 `json:"second,omitempty"`
-
- TimeZoneId string `json:"timeZoneId,omitempty"`
-
- Year int64 `json:"year,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Day") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DateTime) MarshalJSON() ([]byte, error) {
- type noMethod DateTime
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DealPartyDto struct {
- Buyer *BuyerDto `json:"buyer,omitempty"`
-
- BuyerSellerRole string `json:"buyerSellerRole,omitempty"`
-
- CustomerId int64 `json:"customerId,omitempty"`
-
- Name string `json:"name,omitempty"`
-
- WebProperty *WebPropertyDto `json:"webProperty,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Buyer") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DealPartyDto) MarshalJSON() ([]byte, error) {
- type noMethod DealPartyDto
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DealTerms struct {
- // Description: Description for the proposed terms of the deal.
- Description string `json:"description,omitempty"`
-
- // GuaranteedFixedPriceTerms: The terms for guaranteed fixed price
- // deals.
- GuaranteedFixedPriceTerms *DealTermsGuaranteedFixedPriceTerms `json:"guaranteedFixedPriceTerms,omitempty"`
-
- // NonGuaranteedAuctionTerms: The terms for non-guaranteed auction
- // deals.
- NonGuaranteedAuctionTerms *DealTermsNonGuaranteedAuctionTerms `json:"nonGuaranteedAuctionTerms,omitempty"`
-
- // NonGuaranteedFixedPriceTerms: The terms for non-guaranteed fixed
- // price deals.
- NonGuaranteedFixedPriceTerms *DealTermsNonGuaranteedFixedPriceTerms `json:"nonGuaranteedFixedPriceTerms,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Description") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DealTerms) MarshalJSON() ([]byte, error) {
- type noMethod DealTerms
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DealTermsGuaranteedFixedPriceTerms struct {
- // FixedPrices: Fixed price for the specified buyer.
- FixedPrices []*PricePerBuyer `json:"fixedPrices,omitempty"`
-
- // GuaranteedImpressions: Guaranteed impressions as a percentage. This
- // is the percentage of guaranteed looks that the buyer is guaranteeing
- // to buy.
- GuaranteedImpressions int64 `json:"guaranteedImpressions,omitempty,string"`
-
- // GuaranteedLooks: Count of guaranteed looks. Required for deal,
- // optional for offer.
- GuaranteedLooks int64 `json:"guaranteedLooks,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "FixedPrices") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DealTermsGuaranteedFixedPriceTerms) MarshalJSON() ([]byte, error) {
- type noMethod DealTermsGuaranteedFixedPriceTerms
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DealTermsNonGuaranteedAuctionTerms struct {
- // PrivateAuctionId: Id of the corresponding private auction.
- PrivateAuctionId string `json:"privateAuctionId,omitempty"`
-
- // ReservePricePerBuyers: Reserve price for the specified buyer.
- ReservePricePerBuyers []*PricePerBuyer `json:"reservePricePerBuyers,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "PrivateAuctionId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DealTermsNonGuaranteedAuctionTerms) MarshalJSON() ([]byte, error) {
- type noMethod DealTermsNonGuaranteedAuctionTerms
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DealTermsNonGuaranteedFixedPriceTerms struct {
- // FixedPrices: Fixed price for the specified buyer.
- FixedPrices []*PricePerBuyer `json:"fixedPrices,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "FixedPrices") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DealTermsNonGuaranteedFixedPriceTerms) MarshalJSON() ([]byte, error) {
- type noMethod DealTermsNonGuaranteedFixedPriceTerms
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DeleteOrderDealsRequest struct {
- // DealIds: List of deals to delete for a given order
- DealIds []string `json:"dealIds,omitempty"`
-
- // OrderRevisionNumber: The last known order revision number.
- OrderRevisionNumber int64 `json:"orderRevisionNumber,omitempty,string"`
-
- UpdateAction string `json:"updateAction,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DealIds") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DeleteOrderDealsRequest) MarshalJSON() ([]byte, error) {
- type noMethod DeleteOrderDealsRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DeleteOrderDealsResponse struct {
- // Deals: List of deals deleted (in the same order as passed in the
- // request)
- Deals []*MarketplaceDeal `json:"deals,omitempty"`
-
- // OrderRevisionNumber: The updated revision number for the order.
- OrderRevisionNumber int64 `json:"orderRevisionNumber,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Deals") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DeleteOrderDealsResponse) MarshalJSON() ([]byte, error) {
- type noMethod DeleteOrderDealsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DeliveryControl struct {
- DeliveryRateType string `json:"deliveryRateType,omitempty"`
-
- FrequencyCaps []*DeliveryControlFrequencyCap `json:"frequencyCaps,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DeliveryRateType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DeliveryControl) MarshalJSON() ([]byte, error) {
- type noMethod DeliveryControl
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DeliveryControlFrequencyCap struct {
- MaxImpressions int64 `json:"maxImpressions,omitempty"`
-
- NumTimeUnits int64 `json:"numTimeUnits,omitempty"`
-
- TimeUnitType string `json:"timeUnitType,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "MaxImpressions") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DeliveryControlFrequencyCap) MarshalJSON() ([]byte, error) {
- type noMethod DeliveryControlFrequencyCap
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type EditAllOrderDealsRequest struct {
- // Deals: List of deals to edit. Service may perform 3 different
- // operations based on comparison of deals in this list vs deals already
- // persisted in database: 1. Add new deal to order If a deal in this
- // list does not exist in the order, the service will create a new deal
- // and add it to the order. Validation will follow AddOrderDealsRequest.
- // 2. Update existing deal in the order If a deal in this list already
- // exist in the order, the service will update that existing deal to
- // this new deal in the request. Validation will follow
- // UpdateOrderDealsRequest. 3. Delete deals from the order (just need
- // the id) If a existing deal in the order is not present in this list,
- // the service will delete that deal from the order. Validation will
- // follow DeleteOrderDealsRequest.
- Deals []*MarketplaceDeal `json:"deals,omitempty"`
-
- // Order: If specified, also updates the order in the batch transaction.
- // This is useful when the order and the deals need to be updated in one
- // transaction.
- Order *MarketplaceOrder `json:"order,omitempty"`
-
- // OrderRevisionNumber: The last known revision number for the order.
- OrderRevisionNumber int64 `json:"orderRevisionNumber,omitempty,string"`
-
- // UpdateAction: Indicates an optional action to take on the order
- UpdateAction string `json:"updateAction,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Deals") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EditAllOrderDealsRequest) MarshalJSON() ([]byte, error) {
- type noMethod EditAllOrderDealsRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type EditAllOrderDealsResponse struct {
- // Deals: List of all deals in the order after edit.
- Deals []*MarketplaceDeal `json:"deals,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Deals") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EditAllOrderDealsResponse) MarshalJSON() ([]byte, error) {
- type noMethod EditAllOrderDealsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type EditHistoryDto struct {
- CreatedByLoginName string `json:"createdByLoginName,omitempty"`
-
- CreatedTimeStamp int64 `json:"createdTimeStamp,omitempty,string"`
-
- LastUpdateTimeStamp int64 `json:"lastUpdateTimeStamp,omitempty,string"`
-
- LastUpdatedByLoginName string `json:"lastUpdatedByLoginName,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CreatedByLoginName")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EditHistoryDto) MarshalJSON() ([]byte, error) {
- type noMethod EditHistoryDto
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GetFinalizedNegotiationByExternalDealIdRequest struct {
- IncludePrivateAuctions bool `json:"includePrivateAuctions,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "IncludePrivateAuctions") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GetFinalizedNegotiationByExternalDealIdRequest) MarshalJSON() ([]byte, error) {
- type noMethod GetFinalizedNegotiationByExternalDealIdRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GetNegotiationByIdRequest struct {
- IncludePrivateAuctions bool `json:"includePrivateAuctions,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "IncludePrivateAuctions") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GetNegotiationByIdRequest) MarshalJSON() ([]byte, error) {
- type noMethod GetNegotiationByIdRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GetNegotiationsRequest struct {
- Finalized bool `json:"finalized,omitempty"`
-
- IncludePrivateAuctions bool `json:"includePrivateAuctions,omitempty"`
-
- SinceTimestampMillis int64 `json:"sinceTimestampMillis,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "Finalized") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GetNegotiationsRequest) MarshalJSON() ([]byte, error) {
- type noMethod GetNegotiationsRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GetNegotiationsResponse struct {
- Kind string `json:"kind,omitempty"`
-
- Negotiations []*NegotiationDto `json:"negotiations,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GetNegotiationsResponse) MarshalJSON() ([]byte, error) {
- type noMethod GetNegotiationsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GetOffersResponse struct {
- // Offers: The returned list of offers.
- Offers []*MarketplaceOffer `json:"offers,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Offers") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GetOffersResponse) MarshalJSON() ([]byte, error) {
- type noMethod GetOffersResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GetOrderDealsResponse struct {
- // Deals: List of deals for the order
- Deals []*MarketplaceDeal `json:"deals,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Deals") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GetOrderDealsResponse) MarshalJSON() ([]byte, error) {
- type noMethod GetOrderDealsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GetOrderNotesResponse struct {
- // Notes: The list of matching notes.
- Notes []*MarketplaceNote `json:"notes,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Notes") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GetOrderNotesResponse) MarshalJSON() ([]byte, error) {
- type noMethod GetOrderNotesResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GetOrdersResponse struct {
- // Orders: The list of matching orders.
- Orders []*MarketplaceOrder `json:"orders,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Orders") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GetOrdersResponse) MarshalJSON() ([]byte, error) {
- type noMethod GetOrdersResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InventorySegmentTargeting struct {
- NegativeAdSizes []*AdSize `json:"negativeAdSizes,omitempty"`
-
- NegativeAdTypeSegments []string `json:"negativeAdTypeSegments,omitempty"`
-
- NegativeAudienceSegments googleapi.Int64s `json:"negativeAudienceSegments,omitempty"`
-
- NegativeDeviceCategories googleapi.Int64s `json:"negativeDeviceCategories,omitempty"`
-
- NegativeIcmBrands googleapi.Int64s `json:"negativeIcmBrands,omitempty"`
-
- NegativeIcmInterests googleapi.Int64s `json:"negativeIcmInterests,omitempty"`
-
- NegativeInventorySlots []string `json:"negativeInventorySlots,omitempty"`
-
- NegativeKeyValues []*RuleKeyValuePair `json:"negativeKeyValues,omitempty"`
-
- NegativeLocations googleapi.Int64s `json:"negativeLocations,omitempty"`
-
- NegativeMobileApps []string `json:"negativeMobileApps,omitempty"`
-
- NegativeOperatingSystemVersions googleapi.Int64s `json:"negativeOperatingSystemVersions,omitempty"`
-
- NegativeOperatingSystems googleapi.Int64s `json:"negativeOperatingSystems,omitempty"`
-
- NegativeSiteUrls []string `json:"negativeSiteUrls,omitempty"`
-
- NegativeSizes googleapi.Int64s `json:"negativeSizes,omitempty"`
-
- NegativeVideoAdPositionSegments []string `json:"negativeVideoAdPositionSegments,omitempty"`
-
- NegativeVideoDurationSegments googleapi.Int64s `json:"negativeVideoDurationSegments,omitempty"`
-
- NegativeXfpAdSlots googleapi.Int64s `json:"negativeXfpAdSlots,omitempty"`
-
- NegativeXfpPlacements googleapi.Int64s `json:"negativeXfpPlacements,omitempty"`
-
- PositiveAdSizes []*AdSize `json:"positiveAdSizes,omitempty"`
-
- PositiveAdTypeSegments []string `json:"positiveAdTypeSegments,omitempty"`
-
- PositiveAudienceSegments googleapi.Int64s `json:"positiveAudienceSegments,omitempty"`
-
- PositiveDeviceCategories googleapi.Int64s `json:"positiveDeviceCategories,omitempty"`
-
- PositiveIcmBrands googleapi.Int64s `json:"positiveIcmBrands,omitempty"`
-
- PositiveIcmInterests googleapi.Int64s `json:"positiveIcmInterests,omitempty"`
-
- PositiveInventorySlots []string `json:"positiveInventorySlots,omitempty"`
-
- PositiveKeyValues []*RuleKeyValuePair `json:"positiveKeyValues,omitempty"`
-
- PositiveLocations googleapi.Int64s `json:"positiveLocations,omitempty"`
-
- PositiveMobileApps []string `json:"positiveMobileApps,omitempty"`
-
- PositiveOperatingSystemVersions googleapi.Int64s `json:"positiveOperatingSystemVersions,omitempty"`
-
- PositiveOperatingSystems googleapi.Int64s `json:"positiveOperatingSystems,omitempty"`
-
- PositiveSiteUrls []string `json:"positiveSiteUrls,omitempty"`
-
- PositiveSizes googleapi.Int64s `json:"positiveSizes,omitempty"`
-
- PositiveVideoAdPositionSegments []string `json:"positiveVideoAdPositionSegments,omitempty"`
-
- PositiveVideoDurationSegments googleapi.Int64s `json:"positiveVideoDurationSegments,omitempty"`
-
- PositiveXfpAdSlots googleapi.Int64s `json:"positiveXfpAdSlots,omitempty"`
-
- PositiveXfpPlacements googleapi.Int64s `json:"positiveXfpPlacements,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "NegativeAdSizes") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InventorySegmentTargeting) MarshalJSON() ([]byte, error) {
- type noMethod InventorySegmentTargeting
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ListClientAccessCapabilitiesRequest struct {
- SponsorAccountId int64 `json:"sponsorAccountId,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "SponsorAccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListClientAccessCapabilitiesRequest) MarshalJSON() ([]byte, error) {
- type noMethod ListClientAccessCapabilitiesRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ListClientAccessCapabilitiesResponse struct {
- ClientAccessPermissions []*ClientAccessCapabilities `json:"clientAccessPermissions,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "ClientAccessPermissions") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListClientAccessCapabilitiesResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListClientAccessCapabilitiesResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ListOffersRequest struct {
- SinceTimestampMillis int64 `json:"sinceTimestampMillis,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g.
- // "SinceTimestampMillis") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListOffersRequest) MarshalJSON() ([]byte, error) {
- type noMethod ListOffersRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ListOffersResponse struct {
- Kind string `json:"kind,omitempty"`
-
- Offers []*OfferDto `json:"offers,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListOffersResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListOffersResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MarketplaceDeal: An order can contain multiple deals. A deal contains
-// the terms and targeting information that is used for serving.
-type MarketplaceDeal struct {
- // BuyerPrivateData: Buyer private data (hidden from seller).
- BuyerPrivateData *PrivateData `json:"buyerPrivateData,omitempty"`
-
- // CreationTimeMs: The time (ms since epoch) of the deal creation.
- // (readonly)
- CreationTimeMs int64 `json:"creationTimeMs,omitempty,string"`
-
- // DealId: A unique deal=id for the deal (readonly).
- DealId string `json:"dealId,omitempty"`
-
- // DeliveryControl: The set of fields around delivery control that are
- // interesting for a buyer to see but are non-negotiable. These are set
- // by the publisher. This message is assigned an id of 100 since some
- // day we would want to model this as a protobuf extension.
- DeliveryControl *DeliveryControl `json:"deliveryControl,omitempty"`
-
- // ExternalDealId: The external deal id assigned to this deal once the
- // deal is finalized. This is the deal-id that shows up in
- // serving/reporting etc. (readonly)
- ExternalDealId string `json:"externalDealId,omitempty"`
-
- // FlightEndTimeMs: Proposed flight end time of the deal (ms since
- // epoch) This will generally be stored in a granularity of a second.
- // (updatable)
- FlightEndTimeMs int64 `json:"flightEndTimeMs,omitempty,string"`
-
- // FlightStartTimeMs: Proposed flight start time of the deal (ms since
- // epoch) This will generally be stored in a granularity of a second.
- // (updatable)
- FlightStartTimeMs int64 `json:"flightStartTimeMs,omitempty,string"`
-
- // InventoryDescription: Description for the deal terms. (updatable)
- InventoryDescription string `json:"inventoryDescription,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "adexchangebuyer#marketplaceDeal".
- Kind string `json:"kind,omitempty"`
-
- // LastUpdateTimeMs: The time (ms since epoch) when the deal was last
- // updated. (readonly)
- LastUpdateTimeMs int64 `json:"lastUpdateTimeMs,omitempty,string"`
-
- // Name: The name of the deal. (updatable)
- Name string `json:"name,omitempty"`
-
- // OfferId: The offer-id from which this deal was created. (readonly,
- // except on create)
- OfferId string `json:"offerId,omitempty"`
-
- // OfferRevisionNumber: The revision number of the offer that the deal
- // was created from (readonly, except on create)
- OfferRevisionNumber int64 `json:"offerRevisionNumber,omitempty,string"`
-
- OrderId string `json:"orderId,omitempty"`
-
- // SellerContacts: Optional Seller contact information for the deal
- // (buyer-readonly)
- SellerContacts []*ContactInformation `json:"sellerContacts,omitempty"`
-
- // SharedTargetings: The shared targeting visible to buyers and sellers.
- // (updatable)
- SharedTargetings []*SharedTargeting `json:"sharedTargetings,omitempty"`
-
- // SyndicationProduct: The syndication product associated with the deal.
- // (readonly, except on create)
- SyndicationProduct string `json:"syndicationProduct,omitempty"`
-
- // Terms: The negotiable terms of the deal. (updatable)
- Terms *DealTerms `json:"terms,omitempty"`
-
- WebPropertyCode string `json:"webPropertyCode,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BuyerPrivateData") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MarketplaceDeal) MarshalJSON() ([]byte, error) {
- type noMethod MarketplaceDeal
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type MarketplaceDealParty struct {
- // Buyer: The buyer/seller associated with the deal. One of buyer/seller
- // is specified for a deal-party.
- Buyer *Buyer `json:"buyer,omitempty"`
-
- // Seller: The buyer/seller associated with the deal. One of
- // buyer/seller is specified for a deal party.
- Seller *Seller `json:"seller,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Buyer") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MarketplaceDealParty) MarshalJSON() ([]byte, error) {
- type noMethod MarketplaceDealParty
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type MarketplaceLabel struct {
- // AccountId: The accountId of the party that created the label.
- AccountId string `json:"accountId,omitempty"`
-
- // CreateTimeMs: The creation time (in ms since epoch) for the label.
- CreateTimeMs int64 `json:"createTimeMs,omitempty,string"`
-
- // DeprecatedMarketplaceDealParty: Information about the party that
- // created the label.
- DeprecatedMarketplaceDealParty *MarketplaceDealParty `json:"deprecatedMarketplaceDealParty,omitempty"`
-
- // Label: The label to use.
- Label string `json:"label,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MarketplaceLabel) MarshalJSON() ([]byte, error) {
- type noMethod MarketplaceLabel
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MarketplaceNote: An order is associated with a bunch of notes which
-// may optionally be associated with a deal and/or revision number.
-type MarketplaceNote struct {
- // CreatorRole: The role of the person (buyer/seller) creating the note.
- // (readonly)
- CreatorRole string `json:"creatorRole,omitempty"`
-
- // DealId: Notes can optionally be associated with a deal. (readonly,
- // except on create)
- DealId string `json:"dealId,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "adexchangebuyer#marketplaceNote".
- Kind string `json:"kind,omitempty"`
-
- // Note: The actual note to attach. (readonly, except on create)
- Note string `json:"note,omitempty"`
-
- // NoteId: The unique id for the note. (readonly)
- NoteId string `json:"noteId,omitempty"`
-
- // OrderId: The order_id that a note is attached to. (readonly)
- OrderId string `json:"orderId,omitempty"`
-
- // OrderRevisionNumber: If the note is associated with an order revision
- // number, then store that here. (readonly, except on create)
- OrderRevisionNumber int64 `json:"orderRevisionNumber,omitempty,string"`
-
- // TimestampMs: The timestamp (ms since epoch) that this note was
- // created. (readonly)
- TimestampMs int64 `json:"timestampMs,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "CreatorRole") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MarketplaceNote) MarshalJSON() ([]byte, error) {
- type noMethod MarketplaceNote
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MarketplaceOffer: An offer is segment of inventory that a seller
-// wishes to sell. It is associated with certain terms and targeting
-// information which helps buyer know more about the inventory. Each
-// field in an order can have one of the following setting:
-//
-// (readonly) - It is an error to try and set this field.
-// (buyer-readonly) - Only the seller can set this field.
-// (seller-readonly) - Only the buyer can set this field. (updatable) -
-// The field is updatable at all times by either buyer or the seller.
-type MarketplaceOffer struct {
- // CreationTimeMs: Creation time in ms. since epoch (readonly)
- CreationTimeMs int64 `json:"creationTimeMs,omitempty,string"`
-
- // CreatorContacts: Optional contact information for the creator of this
- // offer. (buyer-readonly)
- CreatorContacts []*ContactInformation `json:"creatorContacts,omitempty"`
-
- // FlightEndTimeMs: The proposed end time for the deal (ms since epoch)
- // (buyer-readonly)
- FlightEndTimeMs int64 `json:"flightEndTimeMs,omitempty,string"`
-
- // FlightStartTimeMs: Inventory availability dates. (times are in ms
- // since epoch) The granularity is generally in the order of seconds.
- // (buyer-readonly)
- FlightStartTimeMs int64 `json:"flightStartTimeMs,omitempty,string"`
-
- // HasCreatorSignedOff: If the creator has already signed off on the
- // offer, then the buyer can finalize the deal by accepting the offer as
- // is. When copying to an order, if any of the terms are changed, then
- // auto_finalize is automatically set to false.
- HasCreatorSignedOff bool `json:"hasCreatorSignedOff,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "adexchangebuyer#marketplaceOffer".
- Kind string `json:"kind,omitempty"`
-
- // Labels: Optional List of labels for the offer (optional,
- // buyer-readonly).
- Labels []*MarketplaceLabel `json:"labels,omitempty"`
-
- // LastUpdateTimeMs: Time of last update in ms. since epoch (readonly)
- LastUpdateTimeMs int64 `json:"lastUpdateTimeMs,omitempty,string"`
-
- // Name: The name for this offer as set by the seller. (buyer-readonly)
- Name string `json:"name,omitempty"`
-
- // OfferId: The unique id for the offer (readonly)
- OfferId string `json:"offerId,omitempty"`
-
- // RevisionNumber: The revision number of the offer. (readonly)
- RevisionNumber int64 `json:"revisionNumber,omitempty,string"`
-
- // Seller: Information about the seller that created this offer
- // (readonly, except on create)
- Seller *Seller `json:"seller,omitempty"`
-
- // SharedTargetings: Targeting that is shared between the buyer and the
- // seller. Each targeting criteria has a specified key and for each key
- // there is a list of inclusion value or exclusion values.
- // (buyer-readonly)
- SharedTargetings []*SharedTargeting `json:"sharedTargetings,omitempty"`
-
- // State: The state of the offer. (buyer-readonly)
- State string `json:"state,omitempty"`
-
- // SyndicationProduct: The syndication product associated with the deal.
- // (readonly, except on create)
- SyndicationProduct string `json:"syndicationProduct,omitempty"`
-
- // Terms: The negotiable terms of the deal (buyer-readonly)
- Terms *DealTerms `json:"terms,omitempty"`
-
- WebPropertyCode string `json:"webPropertyCode,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimeMs") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MarketplaceOffer) MarshalJSON() ([]byte, error) {
- type noMethod MarketplaceOffer
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MarketplaceOrder: Represents an order in the marketplace. An order is
-// the unit of negotiation between a seller and a buyer and contains
-// deals which are served. Each field in an order can have one of the
-// following setting:
-//
-// (readonly) - It is an error to try and set this field.
-// (buyer-readonly) - Only the seller can set this field.
-// (seller-readonly) - Only the buyer can set this field. (updatable) -
-// The field is updatable at all times by either buyer or the seller.
-type MarketplaceOrder struct {
- // BilledBuyer: Reference to the buyer that will get billed for this
- // order. (readonly)
- BilledBuyer *Buyer `json:"billedBuyer,omitempty"`
-
- // Buyer: Reference to the buyer on the order. (readonly, except on
- // create)
- Buyer *Buyer `json:"buyer,omitempty"`
-
- // BuyerContacts: Optional contact information fort the buyer.
- // (seller-readonly)
- BuyerContacts []*ContactInformation `json:"buyerContacts,omitempty"`
-
- // BuyerPrivateData: Private data for buyer. (hidden from seller).
- BuyerPrivateData *PrivateData `json:"buyerPrivateData,omitempty"`
-
- // HasBuyerSignedOff: When an order is in an accepted state, indicates
- // whether the buyer has signed off Once both sides have signed off on a
- // deal, the order can be finalized by the seller. (seller-readonly)
- HasBuyerSignedOff bool `json:"hasBuyerSignedOff,omitempty"`
-
- // HasSellerSignedOff: When an order is in an accepted state, indicates
- // whether the buyer has signed off Once both sides have signed off on a
- // deal, the order can be finalized by the seller. (buyer-readonly)
- HasSellerSignedOff bool `json:"hasSellerSignedOff,omitempty"`
-
- // IsRenegotiating: True if the order is being renegotiated (readonly).
- IsRenegotiating bool `json:"isRenegotiating,omitempty"`
-
- // IsSetupComplete: True, if the buyside inventory setup is complete for
- // this order. (readonly)
- IsSetupComplete bool `json:"isSetupComplete,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "adexchangebuyer#marketplaceOrder".
- Kind string `json:"kind,omitempty"`
-
- // Labels: List of labels associated with the order. (readonly)
- Labels []*MarketplaceLabel `json:"labels,omitempty"`
-
- // LastUpdaterOrCommentorRole: The role of the last user that either
- // updated the order or left a comment. (readonly)
- LastUpdaterOrCommentorRole string `json:"lastUpdaterOrCommentorRole,omitempty"`
-
- LastUpdaterRole string `json:"lastUpdaterRole,omitempty"`
-
- // Name: The name for the order (updatable)
- Name string `json:"name,omitempty"`
-
- // OrderId: The unique id of the order. (readonly).
- OrderId string `json:"orderId,omitempty"`
-
- // OrderState: The current state of the order. (readonly)
- OrderState string `json:"orderState,omitempty"`
-
- // OriginatorRole: Indicates whether the buyer/seller created the
- // offer.(readonly)
- OriginatorRole string `json:"originatorRole,omitempty"`
-
- // RevisionNumber: The revision number for the order (readonly).
- RevisionNumber int64 `json:"revisionNumber,omitempty,string"`
-
- // RevisionTimeMs: The time (ms since epoch) when the order was last
- // revised (readonly).
- RevisionTimeMs int64 `json:"revisionTimeMs,omitempty,string"`
-
- // Seller: Reference to the seller on the order. (readonly, except on
- // create)
- Seller *Seller `json:"seller,omitempty"`
-
- // SellerContacts: Optional contact information for the seller
- // (buyer-readonly).
- SellerContacts []*ContactInformation `json:"sellerContacts,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "BilledBuyer") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MarketplaceOrder) MarshalJSON() ([]byte, error) {
- type noMethod MarketplaceOrder
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type MoneyDto struct {
- CurrencyCode string `json:"currencyCode,omitempty"`
-
- Micros int64 `json:"micros,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "CurrencyCode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MoneyDto) MarshalJSON() ([]byte, error) {
- type noMethod MoneyDto
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type NegotiationDto struct {
- // BilledBuyer: The billed buyer; Specified by a buyer buying through an
- // intermediary.
- BilledBuyer *DealPartyDto `json:"billedBuyer,omitempty"`
-
- // Buyer: Details of the buyer party in this negotiation.
- Buyer *DealPartyDto `json:"buyer,omitempty"`
-
- // BuyerEmailContacts: The buyer party's contact email.
- BuyerEmailContacts []string `json:"buyerEmailContacts,omitempty"`
-
- // DealType: The type of this deal.
- DealType string `json:"dealType,omitempty"`
-
- // ExternalDealId: For finalized negotiations, the ID of the finalized
- // deal.
- ExternalDealId int64 `json:"externalDealId,omitempty,string"`
-
- Kind string `json:"kind,omitempty"`
-
- // LabelNames: A list of label names applicable to this negotiation.
- LabelNames []string `json:"labelNames,omitempty"`
-
- // NegotiationId: The unique ID of this negotiation.
- NegotiationId int64 `json:"negotiationId,omitempty,string"`
-
- // NegotiationRounds: The series of negotiation rounds for this
- // negotiation.
- NegotiationRounds []*NegotiationRoundDto `json:"negotiationRounds,omitempty"`
-
- // NegotiationState: The state of this negotiation.
- NegotiationState string `json:"negotiationState,omitempty"`
-
- // OfferId: The ID of this negotiation's original offer.
- OfferId int64 `json:"offerId,omitempty,string"`
-
- // Seller: Details of the seller party in this negotiation.
- Seller *DealPartyDto `json:"seller,omitempty"`
-
- // SellerEmailContacts: The seller party's contact email.
- SellerEmailContacts []string `json:"sellerEmailContacts,omitempty"`
-
- // Stats: The stats for this negotiation.
- Stats *StatsDto `json:"stats,omitempty"`
-
- // Status: The status of this negotiation.
- Status string `json:"status,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "BilledBuyer") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *NegotiationDto) MarshalJSON() ([]byte, error) {
- type noMethod NegotiationDto
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type NegotiationRoundDto struct {
- // Action: The action performed by this negotiation round.
- Action string `json:"action,omitempty"`
-
- // DbmPartnerId: Stores DBM partner ID for use by DBM
- DbmPartnerId int64 `json:"dbmPartnerId,omitempty,string"`
-
- // EditHistory: The edit history of this negotiation round.
- EditHistory *EditHistoryDto `json:"editHistory,omitempty"`
-
- Kind string `json:"kind,omitempty"`
-
- // NegotiationId: The ID of the negotiation to which this negotiation
- // round applies.
- NegotiationId int64 `json:"negotiationId,omitempty,string"`
-
- // Notes: Notes regarding this negotiation round.
- Notes string `json:"notes,omitempty"`
-
- // OriginatorRole: The role, either buyer or seller, initiating this
- // negotiation round.
- OriginatorRole string `json:"originatorRole,omitempty"`
-
- // RoundNumber: The number of this negotiation round, in sequence.
- RoundNumber int64 `json:"roundNumber,omitempty,string"`
-
- // Terms: The detailed terms proposed in this negotiation round.
- Terms *TermsDto `json:"terms,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Action") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *NegotiationRoundDto) MarshalJSON() ([]byte, error) {
- type noMethod NegotiationRoundDto
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OfferDto struct {
- // Anonymous: Whether this offer is anonymous.
- Anonymous bool `json:"anonymous,omitempty"`
-
- // BilledBuyer: The billed buyer; For buyer initiated offers, buying
- // through an intermediary.
- BilledBuyer *DealPartyDto `json:"billedBuyer,omitempty"`
-
- // ClosedToDealParties: The list of buyer or seller parties this offer
- // is closed to.
- ClosedToDealParties []*DealPartyDto `json:"closedToDealParties,omitempty"`
-
- // Creator: The creator of this offer.
- Creator *DealPartyDto `json:"creator,omitempty"`
-
- // EmailContacts: The list of email contacts for this offer.
- EmailContacts []string `json:"emailContacts,omitempty"`
-
- // IsOpen: Whether this offer is open.
- IsOpen bool `json:"isOpen,omitempty"`
-
- Kind string `json:"kind,omitempty"`
-
- // LabelNames: The list of label names applicable to this offer.
- LabelNames []string `json:"labelNames,omitempty"`
-
- // OfferId: The unique ID of this offer.
- OfferId int64 `json:"offerId,omitempty,string"`
-
- // OfferState: The state of this offer.
- OfferState string `json:"offerState,omitempty"`
-
- // OpenToDealParties: The list of buyer or seller parties this offer is
- // open to.
- OpenToDealParties []*DealPartyDto `json:"openToDealParties,omitempty"`
-
- // PointOfContact: The point of contact for this offer.
- PointOfContact string `json:"pointOfContact,omitempty"`
-
- // Status: The status of this offer.
- Status string `json:"status,omitempty"`
-
- // Terms: The terms of this offer.
- Terms *TermsDto `json:"terms,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Anonymous") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OfferDto) MarshalJSON() ([]byte, error) {
- type noMethod OfferDto
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PerformanceReport: The configuration data for an Ad Exchange
-// performance report list.
-type PerformanceReport struct {
- // BidRate: The number of bid responses with an ad.
- BidRate float64 `json:"bidRate,omitempty"`
-
- // BidRequestRate: The number of bid requests sent to your bidder.
- BidRequestRate float64 `json:"bidRequestRate,omitempty"`
-
- // CalloutStatusRate: Rate of various prefiltering statuses per match.
- // Please refer to the callout-status-codes.txt file for different
- // statuses.
- CalloutStatusRate []interface{} `json:"calloutStatusRate,omitempty"`
-
- // CookieMatcherStatusRate: Average QPS for cookie matcher operations.
- CookieMatcherStatusRate []interface{} `json:"cookieMatcherStatusRate,omitempty"`
-
- // CreativeStatusRate: Rate of ads with a given status. Please refer to
- // the creative-status-codes.txt file for different statuses.
- CreativeStatusRate []interface{} `json:"creativeStatusRate,omitempty"`
-
- // FilteredBidRate: The number of bid responses that were filtered due
- // to a policy violation or other errors.
- FilteredBidRate float64 `json:"filteredBidRate,omitempty"`
-
- // HostedMatchStatusRate: Average QPS for hosted match operations.
- HostedMatchStatusRate []interface{} `json:"hostedMatchStatusRate,omitempty"`
-
- // InventoryMatchRate: The number of potential queries based on your
- // pretargeting settings.
- InventoryMatchRate float64 `json:"inventoryMatchRate,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // Latency50thPercentile: The 50th percentile round trip latency(ms) as
- // perceived from Google servers for the duration period covered by the
- // report.
- Latency50thPercentile float64 `json:"latency50thPercentile,omitempty"`
-
- // Latency85thPercentile: The 85th percentile round trip latency(ms) as
- // perceived from Google servers for the duration period covered by the
- // report.
- Latency85thPercentile float64 `json:"latency85thPercentile,omitempty"`
-
- // Latency95thPercentile: The 95th percentile round trip latency(ms) as
- // perceived from Google servers for the duration period covered by the
- // report.
- Latency95thPercentile float64 `json:"latency95thPercentile,omitempty"`
-
- // NoQuotaInRegion: Rate of various quota account statuses per quota
- // check.
- NoQuotaInRegion float64 `json:"noQuotaInRegion,omitempty"`
-
- // OutOfQuota: Rate of various quota account statuses per quota check.
- OutOfQuota float64 `json:"outOfQuota,omitempty"`
-
- // PixelMatchRequests: Average QPS for pixel match requests from
- // clients.
- PixelMatchRequests float64 `json:"pixelMatchRequests,omitempty"`
-
- // PixelMatchResponses: Average QPS for pixel match responses from
- // clients.
- PixelMatchResponses float64 `json:"pixelMatchResponses,omitempty"`
-
- // QuotaConfiguredLimit: The configured quota limits for this account.
- QuotaConfiguredLimit float64 `json:"quotaConfiguredLimit,omitempty"`
-
- // QuotaThrottledLimit: The throttled quota limits for this account.
- QuotaThrottledLimit float64 `json:"quotaThrottledLimit,omitempty"`
-
- // Region: The trading location of this data.
- Region string `json:"region,omitempty"`
-
- // SuccessfulRequestRate: The number of properly formed bid responses
- // received by our servers within the deadline.
- SuccessfulRequestRate float64 `json:"successfulRequestRate,omitempty"`
-
- // Timestamp: The unix timestamp of the starting time of this
- // performance data.
- Timestamp int64 `json:"timestamp,omitempty,string"`
-
- // UnsuccessfulRequestRate: The number of bid responses that were
- // unsuccessful due to timeouts, incorrect formatting, etc.
- UnsuccessfulRequestRate float64 `json:"unsuccessfulRequestRate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BidRate") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PerformanceReport) MarshalJSON() ([]byte, error) {
- type noMethod PerformanceReport
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PerformanceReportList: The configuration data for an Ad Exchange
-// performance report list.
-// https://sites.google.com/a/google.com/adx-integration/Home/engineering/binary-releases/rtb-api-release
-// https://cs.corp.google.com/#piper///depot/google3/contentads/adx/tools/rtb_api/adxrtb.py
-type PerformanceReportList struct {
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // PerformanceReport: A list of performance reports relevant for the
- // account.
- PerformanceReport []*PerformanceReport `json:"performanceReport,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PerformanceReportList) MarshalJSON() ([]byte, error) {
- type noMethod PerformanceReportList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type PretargetingConfig struct {
- // BillingId: The id for billing purposes, provided for reference. Leave
- // this field blank for insert requests; the id will be generated
- // automatically.
- BillingId int64 `json:"billingId,omitempty,string"`
-
- // ConfigId: The config id; generated automatically. Leave this field
- // blank for insert requests.
- ConfigId int64 `json:"configId,omitempty,string"`
-
- // ConfigName: The name of the config. Must be unique. Required for all
- // requests.
- ConfigName string `json:"configName,omitempty"`
-
- // CreativeType: List must contain exactly one of
- // PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
- CreativeType []string `json:"creativeType,omitempty"`
-
- // Dimensions: Requests which allow one of these (width, height) pairs
- // will match. All pairs must be supported ad dimensions.
- Dimensions []*PretargetingConfigDimensions `json:"dimensions,omitempty"`
-
- // ExcludedContentLabels: Requests with any of these content labels will
- // not match. Values are from content-labels.txt in the downloadable
- // files section.
- ExcludedContentLabels googleapi.Int64s `json:"excludedContentLabels,omitempty"`
-
- // ExcludedGeoCriteriaIds: Requests containing any of these geo criteria
- // ids will not match.
- ExcludedGeoCriteriaIds googleapi.Int64s `json:"excludedGeoCriteriaIds,omitempty"`
-
- // ExcludedPlacements: Requests containing any of these placements will
- // not match.
- ExcludedPlacements []*PretargetingConfigExcludedPlacements `json:"excludedPlacements,omitempty"`
-
- // ExcludedUserLists: Requests containing any of these users list ids
- // will not match.
- ExcludedUserLists googleapi.Int64s `json:"excludedUserLists,omitempty"`
-
- // ExcludedVerticals: Requests containing any of these vertical ids will
- // not match. Values are from the publisher-verticals.txt file in the
- // downloadable files section.
- ExcludedVerticals googleapi.Int64s `json:"excludedVerticals,omitempty"`
-
- // GeoCriteriaIds: Requests containing any of these geo criteria ids
- // will match.
- GeoCriteriaIds googleapi.Int64s `json:"geoCriteriaIds,omitempty"`
-
- // IsActive: Whether this config is active. Required for all requests.
- IsActive bool `json:"isActive,omitempty"`
-
- // Kind: The kind of the resource, i.e.
- // "adexchangebuyer#pretargetingConfig".
- Kind string `json:"kind,omitempty"`
-
- // Languages: Request containing any of these language codes will match.
- Languages []string `json:"languages,omitempty"`
-
- // MobileCarriers: Requests containing any of these mobile carrier ids
- // will match. Values are from mobile-carriers.csv in the downloadable
- // files section.
- MobileCarriers googleapi.Int64s `json:"mobileCarriers,omitempty"`
-
- // MobileDevices: Requests containing any of these mobile device ids
- // will match. Values are from mobile-devices.csv in the downloadable
- // files section.
- MobileDevices googleapi.Int64s `json:"mobileDevices,omitempty"`
-
- // MobileOperatingSystemVersions: Requests containing any of these
- // mobile operating system version ids will match. Values are from
- // mobile-os.csv in the downloadable files section.
- MobileOperatingSystemVersions googleapi.Int64s `json:"mobileOperatingSystemVersions,omitempty"`
-
- // Placements: Requests containing any of these placements will match.
- Placements []*PretargetingConfigPlacements `json:"placements,omitempty"`
-
- // Platforms: Requests matching any of these platforms will match.
- // Possible values are PRETARGETING_PLATFORM_MOBILE,
- // PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
- Platforms []string `json:"platforms,omitempty"`
-
- // SupportedCreativeAttributes: Creative attributes should be declared
- // here if all creatives corresponding to this pretargeting
- // configuration have that creative attribute. Values are from
- // pretargetable-creative-attributes.txt in the downloadable files
- // section.
- SupportedCreativeAttributes googleapi.Int64s `json:"supportedCreativeAttributes,omitempty"`
-
- // UserLists: Requests containing any of these user list ids will match.
- UserLists googleapi.Int64s `json:"userLists,omitempty"`
-
- // VendorTypes: Requests that allow any of these vendor ids will match.
- // Values are from vendors.txt in the downloadable files section.
- VendorTypes googleapi.Int64s `json:"vendorTypes,omitempty"`
-
- // Verticals: Requests containing any of these vertical ids will match.
- Verticals googleapi.Int64s `json:"verticals,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "BillingId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PretargetingConfig) MarshalJSON() ([]byte, error) {
- type noMethod PretargetingConfig
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type PretargetingConfigDimensions struct {
- // Height: Height in pixels.
- Height int64 `json:"height,omitempty,string"`
-
- // Width: Width in pixels.
- Width int64 `json:"width,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "Height") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PretargetingConfigDimensions) MarshalJSON() ([]byte, error) {
- type noMethod PretargetingConfigDimensions
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type PretargetingConfigExcludedPlacements struct {
- // Token: The value of the placement. Interpretation depends on the
- // placement type, e.g. URL for a site placement, channel name for a
- // channel placement, app id for a mobile app placement.
- Token string `json:"token,omitempty"`
-
- // Type: The type of the placement.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Token") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PretargetingConfigExcludedPlacements) MarshalJSON() ([]byte, error) {
- type noMethod PretargetingConfigExcludedPlacements
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type PretargetingConfigPlacements struct {
- // Token: The value of the placement. Interpretation depends on the
- // placement type, e.g. URL for a site placement, channel name for a
- // channel placement, app id for a mobile app placement.
- Token string `json:"token,omitempty"`
-
- // Type: The type of the placement.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Token") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PretargetingConfigPlacements) MarshalJSON() ([]byte, error) {
- type noMethod PretargetingConfigPlacements
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type PretargetingConfigList struct {
- // Items: A list of pretargeting configs
- Items []*PretargetingConfig `json:"items,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PretargetingConfigList) MarshalJSON() ([]byte, error) {
- type noMethod PretargetingConfigList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Price struct {
- // AmountMicros: The CPM value in micros.
- AmountMicros float64 `json:"amountMicros,omitempty"`
-
- // CurrencyCode: The currency code for the price.
- CurrencyCode string `json:"currencyCode,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AmountMicros") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Price) MarshalJSON() ([]byte, error) {
- type noMethod Price
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PricePerBuyer: Used to specify pricing rules for buyers/advertisers.
-// Each PricePerBuyer in an offer can become [0,1] deals. To check if
-// there is a PricePerBuyer for a particular buyer or buyer/advertiser
-// pair, we look for the most specific matching rule - we first look for
-// a rule matching the buyer and advertiser, next a rule with the buyer
-// but an empty advertiser list, and otherwise look for a matching rule
-// where no buyer is set.
-type PricePerBuyer struct {
- // Buyer: The buyer who will pay this price. If unset, all buyers can
- // pay this price (if the advertisers match, and there's no more
- // specific rule matching the buyer).
- Buyer *Buyer `json:"buyer,omitempty"`
-
- // Price: The specified price
- Price *Price `json:"price,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Buyer") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PricePerBuyer) MarshalJSON() ([]byte, error) {
- type noMethod PricePerBuyer
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type PrivateData struct {
- ReferenceId string `json:"referenceId,omitempty"`
-
- ReferencePayload string `json:"referencePayload,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ReferenceId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PrivateData) MarshalJSON() ([]byte, error) {
- type noMethod PrivateData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type RuleKeyValuePair struct {
- KeyName string `json:"keyName,omitempty"`
-
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "KeyName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RuleKeyValuePair) MarshalJSON() ([]byte, error) {
- type noMethod RuleKeyValuePair
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Seller struct {
- // AccountId: The unique id for the seller. The seller fills in this
- // field. The seller account id is then available to buyer in the offer.
- AccountId string `json:"accountId,omitempty"`
-
- // SubAccountId: Optional sub-account id for the seller.
- SubAccountId string `json:"subAccountId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Seller) MarshalJSON() ([]byte, error) {
- type noMethod Seller
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type SharedTargeting struct {
- // Exclusions: The list of values to exclude from targeting.
- Exclusions []*TargetingValue `json:"exclusions,omitempty"`
-
- // Inclusions: The list of value to include as part of the targeting.
- Inclusions []*TargetingValue `json:"inclusions,omitempty"`
-
- // Key: The key representing the shared targeting criterion.
- Key string `json:"key,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Exclusions") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SharedTargeting) MarshalJSON() ([]byte, error) {
- type noMethod SharedTargeting
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type StatsDto struct {
- Bids int64 `json:"bids,omitempty,string"`
-
- GoodBids int64 `json:"goodBids,omitempty,string"`
-
- Impressions int64 `json:"impressions,omitempty,string"`
-
- Requests int64 `json:"requests,omitempty,string"`
-
- Revenue *MoneyDto `json:"revenue,omitempty"`
-
- Spend *MoneyDto `json:"spend,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Bids") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *StatsDto) MarshalJSON() ([]byte, error) {
- type noMethod StatsDto
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetingValue struct {
- // CreativeSizeValue: The creative size value to exclude/include.
- CreativeSizeValue *TargetingValueCreativeSize `json:"creativeSizeValue,omitempty"`
-
- // DayPartTargetingValue: The daypart targeting to include / exclude.
- // Filled in when the key is GOOG_DAYPART_TARGETING.
- DayPartTargetingValue *TargetingValueDayPartTargeting `json:"dayPartTargetingValue,omitempty"`
-
- // LongValue: The long value to exclude/include.
- LongValue int64 `json:"longValue,omitempty,string"`
-
- // StringValue: The string value to exclude/include.
- StringValue string `json:"stringValue,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CreativeSizeValue")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetingValue) MarshalJSON() ([]byte, error) {
- type noMethod TargetingValue
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetingValueCreativeSize struct {
- // CompanionSizes: For video size type, the list of companion sizes.
- CompanionSizes []*TargetingValueSize `json:"companionSizes,omitempty"`
-
- // CreativeSizeType: The Creative size type.
- CreativeSizeType string `json:"creativeSizeType,omitempty"`
-
- // Size: For regular creative size type, specifies the size of the
- // creative.
- Size *TargetingValueSize `json:"size,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CompanionSizes") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetingValueCreativeSize) MarshalJSON() ([]byte, error) {
- type noMethod TargetingValueCreativeSize
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetingValueDayPartTargeting struct {
- DayParts []*TargetingValueDayPartTargetingDayPart `json:"dayParts,omitempty"`
-
- TimeZoneType string `json:"timeZoneType,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DayParts") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetingValueDayPartTargeting) MarshalJSON() ([]byte, error) {
- type noMethod TargetingValueDayPartTargeting
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetingValueDayPartTargetingDayPart struct {
- DayOfWeek string `json:"dayOfWeek,omitempty"`
-
- EndHour int64 `json:"endHour,omitempty"`
-
- EndMinute int64 `json:"endMinute,omitempty"`
-
- StartHour int64 `json:"startHour,omitempty"`
-
- StartMinute int64 `json:"startMinute,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DayOfWeek") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetingValueDayPartTargetingDayPart) MarshalJSON() ([]byte, error) {
- type noMethod TargetingValueDayPartTargetingDayPart
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetingValueSize struct {
- // Height: The height of the creative.
- Height int64 `json:"height,omitempty"`
-
- // Width: The width of the creative.
- Width int64 `json:"width,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Height") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetingValueSize) MarshalJSON() ([]byte, error) {
- type noMethod TargetingValueSize
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TermsDto struct {
- // AdSlots: The particular ad slots targeted by the offer.
- AdSlots []*AdSlotDto `json:"adSlots,omitempty"`
-
- // Advertisers: A list of advertisers for this offer.
- Advertisers []*AdvertiserDto `json:"advertisers,omitempty"`
-
- // AudienceSegment: The audience segment for the offer.
- AudienceSegment *AudienceSegment `json:"audienceSegment,omitempty"`
-
- // AudienceSegmentDescription: A description of the audience segment for
- // the offer.
- AudienceSegmentDescription string `json:"audienceSegmentDescription,omitempty"`
-
- // BillingTerms: The billing terms.
- BillingTerms string `json:"billingTerms,omitempty"`
-
- // BuyerBillingType: The buyer billing type.
- BuyerBillingType string `json:"buyerBillingType,omitempty"`
-
- // Cpm: The cpm terms.
- Cpm *MoneyDto `json:"cpm,omitempty"`
-
- // CreativeBlockingLevel: Whether to use or ignore publisher blocking
- // rules.
- CreativeBlockingLevel string `json:"creativeBlockingLevel,omitempty"`
-
- // CreativeReviewPolicy: Whether to use publisher review policy or AdX
- // review policy.
- CreativeReviewPolicy string `json:"creativeReviewPolicy,omitempty"`
-
- // DealPremium: The premium terms.
- DealPremium *MoneyDto `json:"dealPremium,omitempty"`
-
- // Description: A description for these terms.
- Description string `json:"description,omitempty"`
-
- // DescriptiveName: A descriptive name for these terms.
- DescriptiveName string `json:"descriptiveName,omitempty"`
-
- // EndDate: The end date for the offer.
- EndDate *DateTime `json:"endDate,omitempty"`
-
- // EstimatedImpressionsPerDay: The estimated daily impressions for the
- // offer.
- EstimatedImpressionsPerDay int64 `json:"estimatedImpressionsPerDay,omitempty,string"`
-
- // EstimatedSpend: The estimated spend for the offer.
- EstimatedSpend *MoneyDto `json:"estimatedSpend,omitempty"`
-
- // FinalizeAutomatically: If true, the offer will finalize automatically
- // when accepted.
- FinalizeAutomatically bool `json:"finalizeAutomatically,omitempty"`
-
- // InventorySegmentTargeting: The inventory segment targeting for the
- // offer.
- InventorySegmentTargeting *InventorySegmentTargeting `json:"inventorySegmentTargeting,omitempty"`
-
- // IsReservation: Whether the offer is a reservation.
- IsReservation bool `json:"isReservation,omitempty"`
-
- // MinimumSpendMicros: The minimum spend for the offer.
- MinimumSpendMicros int64 `json:"minimumSpendMicros,omitempty,string"`
-
- // MinimumTrueLooks: The minimum true looks for the offer.
- MinimumTrueLooks int64 `json:"minimumTrueLooks,omitempty,string"`
-
- // MonetizerType: The monetizer type.
- MonetizerType string `json:"monetizerType,omitempty"`
-
- // SemiTransparent: Whether this offer is semi-transparent.
- SemiTransparent bool `json:"semiTransparent,omitempty"`
-
- // StartDate: The start date for the offer.
- StartDate *DateTime `json:"startDate,omitempty"`
-
- // TargetByDealId: Whether to target by deal id.
- TargetByDealId bool `json:"targetByDealId,omitempty"`
-
- // TargetingAllAdSlots: If true, the offer targets all ad slots.
- TargetingAllAdSlots bool `json:"targetingAllAdSlots,omitempty"`
-
- // TermsAttributes: A list of terms attributes.
- TermsAttributes []string `json:"termsAttributes,omitempty"`
-
- // Urls: The urls applicable to the offer.
- Urls []string `json:"urls,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AdSlots") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TermsDto) MarshalJSON() ([]byte, error) {
- type noMethod TermsDto
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type WebPropertyDto struct {
- AllowInterestTargetedAds bool `json:"allowInterestTargetedAds,omitempty"`
-
- EnabledForPreferredDeals bool `json:"enabledForPreferredDeals,omitempty"`
-
- Id int64 `json:"id,omitempty"`
-
- Name string `json:"name,omitempty"`
-
- PropertyCode string `json:"propertyCode,omitempty"`
-
- SiteUrls []string `json:"siteUrls,omitempty"`
-
- SyndicationProduct string `json:"syndicationProduct,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "AllowInterestTargetedAds") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *WebPropertyDto) MarshalJSON() ([]byte, error) {
- type noMethod WebPropertyDto
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "adexchangebuyer.accounts.get":
-
-type AccountsGetCall struct {
- s *Service
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one account by ID.
-func (r *AccountsService) Get(id int64) *AccountsGetCall {
- c := &AccountsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsGetCall) Fields(s ...googleapi.Field) *AccountsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsGetCall) IfNoneMatch(entityTag string) *AccountsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsGetCall) Context(ctx context.Context) *AccountsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.accounts.get" call.
-// Exactly one of *Account or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Account.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsGetCall) Do() (*Account, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Account{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one account by ID.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.accounts.get",
- // "parameterOrder": [
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "The account id",
- // "format": "int32",
- // "location": "path",
- // "required": true,
- // "type": "integer"
- // }
- // },
- // "path": "accounts/{id}",
- // "response": {
- // "$ref": "Account"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.accounts.list":
-
-type AccountsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the authenticated user's list of accounts.
-func (r *AccountsService) List() *AccountsListCall {
- c := &AccountsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsListCall) Fields(s ...googleapi.Field) *AccountsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsListCall) IfNoneMatch(entityTag string) *AccountsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsListCall) Context(ctx context.Context) *AccountsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.accounts.list" call.
-// Exactly one of *AccountsList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AccountsList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccountsListCall) Do() (*AccountsList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountsList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the authenticated user's list of accounts.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.accounts.list",
- // "path": "accounts",
- // "response": {
- // "$ref": "AccountsList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.accounts.patch":
-
-type AccountsPatchCall struct {
- s *Service
- id int64
- account *Account
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing account. This method supports patch
-// semantics.
-func (r *AccountsService) Patch(id int64, account *Account) *AccountsPatchCall {
- c := &AccountsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.id = id
- c.account = account
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsPatchCall) Fields(s ...googleapi.Field) *AccountsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsPatchCall) Context(ctx context.Context) *AccountsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.account)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.accounts.patch" call.
-// Exactly one of *Account or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Account.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsPatchCall) Do() (*Account, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Account{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing account. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "adexchangebuyer.accounts.patch",
- // "parameterOrder": [
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "The account id",
- // "format": "int32",
- // "location": "path",
- // "required": true,
- // "type": "integer"
- // }
- // },
- // "path": "accounts/{id}",
- // "request": {
- // "$ref": "Account"
- // },
- // "response": {
- // "$ref": "Account"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.accounts.update":
-
-type AccountsUpdateCall struct {
- s *Service
- id int64
- account *Account
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing account.
-func (r *AccountsService) Update(id int64, account *Account) *AccountsUpdateCall {
- c := &AccountsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.id = id
- c.account = account
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsUpdateCall) Fields(s ...googleapi.Field) *AccountsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsUpdateCall) Context(ctx context.Context) *AccountsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.account)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.accounts.update" call.
-// Exactly one of *Account or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Account.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsUpdateCall) Do() (*Account, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Account{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing account.",
- // "httpMethod": "PUT",
- // "id": "adexchangebuyer.accounts.update",
- // "parameterOrder": [
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "The account id",
- // "format": "int32",
- // "location": "path",
- // "required": true,
- // "type": "integer"
- // }
- // },
- // "path": "accounts/{id}",
- // "request": {
- // "$ref": "Account"
- // },
- // "response": {
- // "$ref": "Account"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.billingInfo.get":
-
-type BillingInfoGetCall struct {
- s *Service
- accountId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the billing information for one account specified by
-// account ID.
-func (r *BillingInfoService) Get(accountId int64) *BillingInfoGetCall {
- c := &BillingInfoGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BillingInfoGetCall) Fields(s ...googleapi.Field) *BillingInfoGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *BillingInfoGetCall) IfNoneMatch(entityTag string) *BillingInfoGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BillingInfoGetCall) Context(ctx context.Context) *BillingInfoGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BillingInfoGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "billinginfo/{accountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": strconv.FormatInt(c.accountId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.billingInfo.get" call.
-// Exactly one of *BillingInfo or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *BillingInfo.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *BillingInfoGetCall) Do() (*BillingInfo, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &BillingInfo{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the billing information for one account specified by account ID.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.billingInfo.get",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The account id.",
- // "format": "int32",
- // "location": "path",
- // "required": true,
- // "type": "integer"
- // }
- // },
- // "path": "billinginfo/{accountId}",
- // "response": {
- // "$ref": "BillingInfo"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.billingInfo.list":
-
-type BillingInfoListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of billing information for all accounts of the
-// authenticated user.
-func (r *BillingInfoService) List() *BillingInfoListCall {
- c := &BillingInfoListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BillingInfoListCall) Fields(s ...googleapi.Field) *BillingInfoListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *BillingInfoListCall) IfNoneMatch(entityTag string) *BillingInfoListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BillingInfoListCall) Context(ctx context.Context) *BillingInfoListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BillingInfoListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "billinginfo")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.billingInfo.list" call.
-// Exactly one of *BillingInfoList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *BillingInfoList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *BillingInfoListCall) Do() (*BillingInfoList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &BillingInfoList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of billing information for all accounts of the authenticated user.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.billingInfo.list",
- // "path": "billinginfo",
- // "response": {
- // "$ref": "BillingInfoList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.budget.get":
-
-type BudgetGetCall struct {
- s *Service
- accountId int64
- billingId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the budget information for the adgroup specified by the
-// accountId and billingId.
-func (r *BudgetService) Get(accountId int64, billingId int64) *BudgetGetCall {
- c := &BudgetGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.billingId = billingId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BudgetGetCall) Fields(s ...googleapi.Field) *BudgetGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *BudgetGetCall) IfNoneMatch(entityTag string) *BudgetGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BudgetGetCall) Context(ctx context.Context) *BudgetGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BudgetGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "billinginfo/{accountId}/{billingId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": strconv.FormatInt(c.accountId, 10),
- "billingId": strconv.FormatInt(c.billingId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.budget.get" call.
-// Exactly one of *Budget or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Budget.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *BudgetGetCall) Do() (*Budget, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Budget{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the budget information for the adgroup specified by the accountId and billingId.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.budget.get",
- // "parameterOrder": [
- // "accountId",
- // "billingId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The account id to get the budget information for.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "billingId": {
- // "description": "The billing id to get the budget information for.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "billinginfo/{accountId}/{billingId}",
- // "response": {
- // "$ref": "Budget"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.budget.patch":
-
-type BudgetPatchCall struct {
- s *Service
- accountId int64
- billingId int64
- budget *Budget
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates the budget amount for the budget of the adgroup
-// specified by the accountId and billingId, with the budget amount in
-// the request. This method supports patch semantics.
-func (r *BudgetService) Patch(accountId int64, billingId int64, budget *Budget) *BudgetPatchCall {
- c := &BudgetPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.billingId = billingId
- c.budget = budget
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BudgetPatchCall) Fields(s ...googleapi.Field) *BudgetPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BudgetPatchCall) Context(ctx context.Context) *BudgetPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BudgetPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.budget)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "billinginfo/{accountId}/{billingId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": strconv.FormatInt(c.accountId, 10),
- "billingId": strconv.FormatInt(c.billingId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.budget.patch" call.
-// Exactly one of *Budget or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Budget.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *BudgetPatchCall) Do() (*Budget, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Budget{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "adexchangebuyer.budget.patch",
- // "parameterOrder": [
- // "accountId",
- // "billingId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The account id associated with the budget being updated.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "billingId": {
- // "description": "The billing id associated with the budget being updated.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "billinginfo/{accountId}/{billingId}",
- // "request": {
- // "$ref": "Budget"
- // },
- // "response": {
- // "$ref": "Budget"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.budget.update":
-
-type BudgetUpdateCall struct {
- s *Service
- accountId int64
- billingId int64
- budget *Budget
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates the budget amount for the budget of the adgroup
-// specified by the accountId and billingId, with the budget amount in
-// the request.
-func (r *BudgetService) Update(accountId int64, billingId int64, budget *Budget) *BudgetUpdateCall {
- c := &BudgetUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.billingId = billingId
- c.budget = budget
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BudgetUpdateCall) Fields(s ...googleapi.Field) *BudgetUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BudgetUpdateCall) Context(ctx context.Context) *BudgetUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BudgetUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.budget)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "billinginfo/{accountId}/{billingId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": strconv.FormatInt(c.accountId, 10),
- "billingId": strconv.FormatInt(c.billingId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.budget.update" call.
-// Exactly one of *Budget or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Budget.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *BudgetUpdateCall) Do() (*Budget, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Budget{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.",
- // "httpMethod": "PUT",
- // "id": "adexchangebuyer.budget.update",
- // "parameterOrder": [
- // "accountId",
- // "billingId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The account id associated with the budget being updated.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "billingId": {
- // "description": "The billing id associated with the budget being updated.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "billinginfo/{accountId}/{billingId}",
- // "request": {
- // "$ref": "Budget"
- // },
- // "response": {
- // "$ref": "Budget"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.clientaccess.delete":
-
-type ClientaccessDeleteCall struct {
- s *Service
- clientAccountId int64
- sponsorAccountId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete:
-func (r *ClientaccessService) Delete(clientAccountId int64, sponsorAccountId int64) *ClientaccessDeleteCall {
- c := &ClientaccessDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.clientAccountId = clientAccountId
- c.sponsorAccountId = sponsorAccountId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ClientaccessDeleteCall) Fields(s ...googleapi.Field) *ClientaccessDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ClientaccessDeleteCall) Context(ctx context.Context) *ClientaccessDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ClientaccessDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("sponsorAccountId", fmt.Sprintf("%v", c.sponsorAccountId))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "clientAccess/{clientAccountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "clientAccountId": strconv.FormatInt(c.clientAccountId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.clientaccess.delete" call.
-func (c *ClientaccessDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "httpMethod": "DELETE",
- // "id": "adexchangebuyer.clientaccess.delete",
- // "parameterOrder": [
- // "clientAccountId",
- // "sponsorAccountId"
- // ],
- // "parameters": {
- // "clientAccountId": {
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "sponsorAccountId": {
- // "format": "int32",
- // "location": "query",
- // "required": true,
- // "type": "integer"
- // }
- // },
- // "path": "clientAccess/{clientAccountId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.clientaccess.get":
-
-type ClientaccessGetCall struct {
- s *Service
- clientAccountId int64
- sponsorAccountId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get:
-func (r *ClientaccessService) Get(clientAccountId int64, sponsorAccountId int64) *ClientaccessGetCall {
- c := &ClientaccessGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.clientAccountId = clientAccountId
- c.sponsorAccountId = sponsorAccountId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ClientaccessGetCall) Fields(s ...googleapi.Field) *ClientaccessGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ClientaccessGetCall) IfNoneMatch(entityTag string) *ClientaccessGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ClientaccessGetCall) Context(ctx context.Context) *ClientaccessGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ClientaccessGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("sponsorAccountId", fmt.Sprintf("%v", c.sponsorAccountId))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "clientAccess/{clientAccountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "clientAccountId": strconv.FormatInt(c.clientAccountId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.clientaccess.get" call.
-// Exactly one of *ClientAccessCapabilities or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *ClientAccessCapabilities.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ClientaccessGetCall) Do() (*ClientAccessCapabilities, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ClientAccessCapabilities{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.clientaccess.get",
- // "parameterOrder": [
- // "clientAccountId",
- // "sponsorAccountId"
- // ],
- // "parameters": {
- // "clientAccountId": {
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "sponsorAccountId": {
- // "format": "int32",
- // "location": "query",
- // "required": true,
- // "type": "integer"
- // }
- // },
- // "path": "clientAccess/{clientAccountId}",
- // "response": {
- // "$ref": "ClientAccessCapabilities"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.clientaccess.insert":
-
-type ClientaccessInsertCall struct {
- s *Service
- clientaccesscapabilities *ClientAccessCapabilities
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert:
-func (r *ClientaccessService) Insert(clientaccesscapabilities *ClientAccessCapabilities) *ClientaccessInsertCall {
- c := &ClientaccessInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.clientaccesscapabilities = clientaccesscapabilities
- return c
-}
-
-// ClientAccountId sets the optional parameter "clientAccountId":
-func (c *ClientaccessInsertCall) ClientAccountId(clientAccountId int64) *ClientaccessInsertCall {
- c.opt_["clientAccountId"] = clientAccountId
- return c
-}
-
-// SponsorAccountId sets the optional parameter "sponsorAccountId":
-func (c *ClientaccessInsertCall) SponsorAccountId(sponsorAccountId int64) *ClientaccessInsertCall {
- c.opt_["sponsorAccountId"] = sponsorAccountId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ClientaccessInsertCall) Fields(s ...googleapi.Field) *ClientaccessInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ClientaccessInsertCall) Context(ctx context.Context) *ClientaccessInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ClientaccessInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.clientaccesscapabilities)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["clientAccountId"]; ok {
- params.Set("clientAccountId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sponsorAccountId"]; ok {
- params.Set("sponsorAccountId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "clientAccess")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.clientaccess.insert" call.
-// Exactly one of *ClientAccessCapabilities or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *ClientAccessCapabilities.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ClientaccessInsertCall) Do() (*ClientAccessCapabilities, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ClientAccessCapabilities{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "httpMethod": "POST",
- // "id": "adexchangebuyer.clientaccess.insert",
- // "parameters": {
- // "clientAccountId": {
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "sponsorAccountId": {
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // }
- // },
- // "path": "clientAccess",
- // "request": {
- // "$ref": "ClientAccessCapabilities"
- // },
- // "response": {
- // "$ref": "ClientAccessCapabilities"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.clientaccess.list":
-
-type ClientaccessListCall struct {
- s *Service
- listclientaccesscapabilitiesrequest *ListClientAccessCapabilitiesRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List:
-func (r *ClientaccessService) List(listclientaccesscapabilitiesrequest *ListClientAccessCapabilitiesRequest) *ClientaccessListCall {
- c := &ClientaccessListCall{s: r.s, opt_: make(map[string]interface{})}
- c.listclientaccesscapabilitiesrequest = listclientaccesscapabilitiesrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ClientaccessListCall) Fields(s ...googleapi.Field) *ClientaccessListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ClientaccessListCall) IfNoneMatch(entityTag string) *ClientaccessListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ClientaccessListCall) Context(ctx context.Context) *ClientaccessListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ClientaccessListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "clientAccess")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.clientaccess.list" call.
-// Exactly one of *ListClientAccessCapabilitiesResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *ListClientAccessCapabilitiesResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *ClientaccessListCall) Do() (*ListClientAccessCapabilitiesResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ListClientAccessCapabilitiesResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.clientaccess.list",
- // "path": "clientAccess",
- // "request": {
- // "$ref": "ListClientAccessCapabilitiesRequest"
- // },
- // "response": {
- // "$ref": "ListClientAccessCapabilitiesResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.clientaccess.patch":
-
-type ClientaccessPatchCall struct {
- s *Service
- clientAccountId int64
- sponsorAccountId int64
- clientaccesscapabilities *ClientAccessCapabilities
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch:
-func (r *ClientaccessService) Patch(clientAccountId int64, sponsorAccountId int64, clientaccesscapabilities *ClientAccessCapabilities) *ClientaccessPatchCall {
- c := &ClientaccessPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.clientAccountId = clientAccountId
- c.sponsorAccountId = sponsorAccountId
- c.clientaccesscapabilities = clientaccesscapabilities
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ClientaccessPatchCall) Fields(s ...googleapi.Field) *ClientaccessPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ClientaccessPatchCall) Context(ctx context.Context) *ClientaccessPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ClientaccessPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.clientaccesscapabilities)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("sponsorAccountId", fmt.Sprintf("%v", c.sponsorAccountId))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "clientAccess/{clientAccountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "clientAccountId": strconv.FormatInt(c.clientAccountId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.clientaccess.patch" call.
-// Exactly one of *ClientAccessCapabilities or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *ClientAccessCapabilities.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ClientaccessPatchCall) Do() (*ClientAccessCapabilities, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ClientAccessCapabilities{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "httpMethod": "PATCH",
- // "id": "adexchangebuyer.clientaccess.patch",
- // "parameterOrder": [
- // "clientAccountId",
- // "sponsorAccountId"
- // ],
- // "parameters": {
- // "clientAccountId": {
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "sponsorAccountId": {
- // "format": "int32",
- // "location": "query",
- // "required": true,
- // "type": "integer"
- // }
- // },
- // "path": "clientAccess/{clientAccountId}",
- // "request": {
- // "$ref": "ClientAccessCapabilities"
- // },
- // "response": {
- // "$ref": "ClientAccessCapabilities"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.clientaccess.update":
-
-type ClientaccessUpdateCall struct {
- s *Service
- clientAccountId int64
- sponsorAccountId int64
- clientaccesscapabilities *ClientAccessCapabilities
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update:
-func (r *ClientaccessService) Update(clientAccountId int64, sponsorAccountId int64, clientaccesscapabilities *ClientAccessCapabilities) *ClientaccessUpdateCall {
- c := &ClientaccessUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.clientAccountId = clientAccountId
- c.sponsorAccountId = sponsorAccountId
- c.clientaccesscapabilities = clientaccesscapabilities
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ClientaccessUpdateCall) Fields(s ...googleapi.Field) *ClientaccessUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ClientaccessUpdateCall) Context(ctx context.Context) *ClientaccessUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ClientaccessUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.clientaccesscapabilities)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("sponsorAccountId", fmt.Sprintf("%v", c.sponsorAccountId))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "clientAccess/{clientAccountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "clientAccountId": strconv.FormatInt(c.clientAccountId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.clientaccess.update" call.
-// Exactly one of *ClientAccessCapabilities or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *ClientAccessCapabilities.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ClientaccessUpdateCall) Do() (*ClientAccessCapabilities, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ClientAccessCapabilities{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "httpMethod": "PUT",
- // "id": "adexchangebuyer.clientaccess.update",
- // "parameterOrder": [
- // "clientAccountId",
- // "sponsorAccountId"
- // ],
- // "parameters": {
- // "clientAccountId": {
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "sponsorAccountId": {
- // "format": "int32",
- // "location": "query",
- // "required": true,
- // "type": "integer"
- // }
- // },
- // "path": "clientAccess/{clientAccountId}",
- // "request": {
- // "$ref": "ClientAccessCapabilities"
- // },
- // "response": {
- // "$ref": "ClientAccessCapabilities"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.creatives.get":
-
-type CreativesGetCall struct {
- s *Service
- accountId int64
- buyerCreativeId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets the status for a single creative. A creative will be
-// available 30-40 minutes after submission.
-func (r *CreativesService) Get(accountId int64, buyerCreativeId string) *CreativesGetCall {
- c := &CreativesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.buyerCreativeId = buyerCreativeId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativesGetCall) Fields(s ...googleapi.Field) *CreativesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CreativesGetCall) IfNoneMatch(entityTag string) *CreativesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativesGetCall) Context(ctx context.Context) *CreativesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "creatives/{accountId}/{buyerCreativeId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": strconv.FormatInt(c.accountId, 10),
- "buyerCreativeId": c.buyerCreativeId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.creatives.get" call.
-// Exactly one of *Creative or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Creative.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CreativesGetCall) Do() (*Creative, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Creative{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the status for a single creative. A creative will be available 30-40 minutes after submission.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.creatives.get",
- // "parameterOrder": [
- // "accountId",
- // "buyerCreativeId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The id for the account that will serve this creative.",
- // "format": "int32",
- // "location": "path",
- // "required": true,
- // "type": "integer"
- // },
- // "buyerCreativeId": {
- // "description": "The buyer-specific id for this creative.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "creatives/{accountId}/{buyerCreativeId}",
- // "response": {
- // "$ref": "Creative"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.creatives.insert":
-
-type CreativesInsertCall struct {
- s *Service
- creative *Creative
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Submit a new creative.
-func (r *CreativesService) Insert(creative *Creative) *CreativesInsertCall {
- c := &CreativesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.creative = creative
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativesInsertCall) Fields(s ...googleapi.Field) *CreativesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativesInsertCall) Context(ctx context.Context) *CreativesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creative)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "creatives")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.creatives.insert" call.
-// Exactly one of *Creative or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Creative.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CreativesInsertCall) Do() (*Creative, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Creative{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Submit a new creative.",
- // "httpMethod": "POST",
- // "id": "adexchangebuyer.creatives.insert",
- // "path": "creatives",
- // "request": {
- // "$ref": "Creative"
- // },
- // "response": {
- // "$ref": "Creative"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.creatives.list":
-
-type CreativesListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of the authenticated user's active creatives.
-// A creative will be available 30-40 minutes after submission.
-func (r *CreativesService) List() *CreativesListCall {
- c := &CreativesListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// AccountId sets the optional parameter "accountId": When specified,
-// only creatives for the given account ids are returned.
-func (c *CreativesListCall) AccountId(accountId int64) *CreativesListCall {
- c.opt_["accountId"] = accountId
- return c
-}
-
-// BuyerCreativeId sets the optional parameter "buyerCreativeId": When
-// specified, only creatives for the given buyer creative ids are
-// returned.
-func (c *CreativesListCall) BuyerCreativeId(buyerCreativeId string) *CreativesListCall {
- c.opt_["buyerCreativeId"] = buyerCreativeId
- return c
-}
-
-// DealsStatusFilter sets the optional parameter "dealsStatusFilter":
-// When specified, only creatives having the given direct deals status
-// are returned.
-//
-// Possible values:
-// "approved" - Creatives which have been approved for serving on
-// direct deals.
-// "conditionally_approved" - Creatives which have been conditionally
-// approved for serving on direct deals.
-// "disapproved" - Creatives which have been disapproved for serving
-// on direct deals.
-// "not_checked" - Creatives whose direct deals status is not yet
-// checked.
-func (c *CreativesListCall) DealsStatusFilter(dealsStatusFilter string) *CreativesListCall {
- c.opt_["dealsStatusFilter"] = dealsStatusFilter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of entries returned on one result page. If not set, the default is
-// 100.
-func (c *CreativesListCall) MaxResults(maxResults int64) *CreativesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OpenAuctionStatusFilter sets the optional parameter
-// "openAuctionStatusFilter": When specified, only creatives having the
-// given open auction status are returned.
-//
-// Possible values:
-// "approved" - Creatives which have been approved for serving on the
-// open auction.
-// "conditionally_approved" - Creatives which have been conditionally
-// approved for serving on the open auction.
-// "disapproved" - Creatives which have been disapproved for serving
-// on the open auction.
-// "not_checked" - Creatives whose open auction status is not yet
-// checked.
-func (c *CreativesListCall) OpenAuctionStatusFilter(openAuctionStatusFilter string) *CreativesListCall {
- c.opt_["openAuctionStatusFilter"] = openAuctionStatusFilter
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad clients. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *CreativesListCall) PageToken(pageToken string) *CreativesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativesListCall) Fields(s ...googleapi.Field) *CreativesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CreativesListCall) IfNoneMatch(entityTag string) *CreativesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativesListCall) Context(ctx context.Context) *CreativesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["accountId"]; ok {
- params.Set("accountId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["buyerCreativeId"]; ok {
- params.Set("buyerCreativeId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["dealsStatusFilter"]; ok {
- params.Set("dealsStatusFilter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["openAuctionStatusFilter"]; ok {
- params.Set("openAuctionStatusFilter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "creatives")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.creatives.list" call.
-// Exactly one of *CreativesList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CreativesList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativesListCall) Do() (*CreativesList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativesList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.creatives.list",
- // "parameters": {
- // "accountId": {
- // "description": "When specified, only creatives for the given account ids are returned.",
- // "format": "int32",
- // "location": "query",
- // "repeated": true,
- // "type": "integer"
- // },
- // "buyerCreativeId": {
- // "description": "When specified, only creatives for the given buyer creative ids are returned.",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "dealsStatusFilter": {
- // "description": "When specified, only creatives having the given direct deals status are returned.",
- // "enum": [
- // "approved",
- // "conditionally_approved",
- // "disapproved",
- // "not_checked"
- // ],
- // "enumDescriptions": [
- // "Creatives which have been approved for serving on direct deals.",
- // "Creatives which have been conditionally approved for serving on direct deals.",
- // "Creatives which have been disapproved for serving on direct deals.",
- // "Creatives whose direct deals status is not yet checked."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "1000",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "openAuctionStatusFilter": {
- // "description": "When specified, only creatives having the given open auction status are returned.",
- // "enum": [
- // "approved",
- // "conditionally_approved",
- // "disapproved",
- // "not_checked"
- // ],
- // "enumDescriptions": [
- // "Creatives which have been approved for serving on the open auction.",
- // "Creatives which have been conditionally approved for serving on the open auction.",
- // "Creatives which have been disapproved for serving on the open auction.",
- // "Creatives whose open auction status is not yet checked."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response. Optional.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "creatives",
- // "response": {
- // "$ref": "CreativesList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.deals.get":
-
-type DealsGetCall struct {
- s *Service
- dealId int64
- getfinalizednegotiationbyexternaldealidrequest *GetFinalizedNegotiationByExternalDealIdRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets the requested deal.
-func (r *DealsService) Get(dealId int64, getfinalizednegotiationbyexternaldealidrequest *GetFinalizedNegotiationByExternalDealIdRequest) *DealsGetCall {
- c := &DealsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.dealId = dealId
- c.getfinalizednegotiationbyexternaldealidrequest = getfinalizednegotiationbyexternaldealidrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DealsGetCall) Fields(s ...googleapi.Field) *DealsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DealsGetCall) IfNoneMatch(entityTag string) *DealsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DealsGetCall) Context(ctx context.Context) *DealsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DealsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "deals/{dealId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "dealId": strconv.FormatInt(c.dealId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.deals.get" call.
-// Exactly one of *NegotiationDto or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *NegotiationDto.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DealsGetCall) Do() (*NegotiationDto, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &NegotiationDto{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the requested deal.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.deals.get",
- // "parameterOrder": [
- // "dealId"
- // ],
- // "parameters": {
- // "dealId": {
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "deals/{dealId}",
- // "request": {
- // "$ref": "GetFinalizedNegotiationByExternalDealIdRequest"
- // },
- // "response": {
- // "$ref": "NegotiationDto"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.marketplacedeals.delete":
-
-type MarketplacedealsDeleteCall struct {
- s *Service
- orderId string
- deleteorderdealsrequest *DeleteOrderDealsRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Delete the specified deals from the order
-func (r *MarketplacedealsService) Delete(orderId string, deleteorderdealsrequest *DeleteOrderDealsRequest) *MarketplacedealsDeleteCall {
- c := &MarketplacedealsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.orderId = orderId
- c.deleteorderdealsrequest = deleteorderdealsrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MarketplacedealsDeleteCall) Fields(s ...googleapi.Field) *MarketplacedealsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MarketplacedealsDeleteCall) Context(ctx context.Context) *MarketplacedealsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MarketplacedealsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.deleteorderdealsrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "marketplaceOrders/{orderId}/deals/delete")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "orderId": c.orderId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.marketplacedeals.delete" call.
-// Exactly one of *DeleteOrderDealsResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *DeleteOrderDealsResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MarketplacedealsDeleteCall) Do() (*DeleteOrderDealsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DeleteOrderDealsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Delete the specified deals from the order",
- // "httpMethod": "POST",
- // "id": "adexchangebuyer.marketplacedeals.delete",
- // "parameterOrder": [
- // "orderId"
- // ],
- // "parameters": {
- // "orderId": {
- // "description": "The orderId to delete deals from.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "marketplaceOrders/{orderId}/deals/delete",
- // "request": {
- // "$ref": "DeleteOrderDealsRequest"
- // },
- // "response": {
- // "$ref": "DeleteOrderDealsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.marketplacedeals.insert":
-
-type MarketplacedealsInsertCall struct {
- s *Service
- orderId string
- addorderdealsrequest *AddOrderDealsRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Add new deals for the specified order
-func (r *MarketplacedealsService) Insert(orderId string, addorderdealsrequest *AddOrderDealsRequest) *MarketplacedealsInsertCall {
- c := &MarketplacedealsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.orderId = orderId
- c.addorderdealsrequest = addorderdealsrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MarketplacedealsInsertCall) Fields(s ...googleapi.Field) *MarketplacedealsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MarketplacedealsInsertCall) Context(ctx context.Context) *MarketplacedealsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MarketplacedealsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.addorderdealsrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "marketplaceOrders/{orderId}/deals/insert")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "orderId": c.orderId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.marketplacedeals.insert" call.
-// Exactly one of *AddOrderDealsResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AddOrderDealsResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MarketplacedealsInsertCall) Do() (*AddOrderDealsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AddOrderDealsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Add new deals for the specified order",
- // "httpMethod": "POST",
- // "id": "adexchangebuyer.marketplacedeals.insert",
- // "parameterOrder": [
- // "orderId"
- // ],
- // "parameters": {
- // "orderId": {
- // "description": "OrderId for which deals need to be added.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "marketplaceOrders/{orderId}/deals/insert",
- // "request": {
- // "$ref": "AddOrderDealsRequest"
- // },
- // "response": {
- // "$ref": "AddOrderDealsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.marketplacedeals.list":
-
-type MarketplacedealsListCall struct {
- s *Service
- orderId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all the deals for a given order
-func (r *MarketplacedealsService) List(orderId string) *MarketplacedealsListCall {
- c := &MarketplacedealsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.orderId = orderId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MarketplacedealsListCall) Fields(s ...googleapi.Field) *MarketplacedealsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MarketplacedealsListCall) IfNoneMatch(entityTag string) *MarketplacedealsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MarketplacedealsListCall) Context(ctx context.Context) *MarketplacedealsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MarketplacedealsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "marketplaceOrders/{orderId}/deals")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "orderId": c.orderId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.marketplacedeals.list" call.
-// Exactly one of *GetOrderDealsResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *GetOrderDealsResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MarketplacedealsListCall) Do() (*GetOrderDealsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &GetOrderDealsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all the deals for a given order",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.marketplacedeals.list",
- // "parameterOrder": [
- // "orderId"
- // ],
- // "parameters": {
- // "orderId": {
- // "description": "The orderId to get deals for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "marketplaceOrders/{orderId}/deals",
- // "response": {
- // "$ref": "GetOrderDealsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.marketplacedeals.update":
-
-type MarketplacedealsUpdateCall struct {
- s *Service
- orderId string
- editallorderdealsrequest *EditAllOrderDealsRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Replaces all the deals in the order with the passed in deals
-func (r *MarketplacedealsService) Update(orderId string, editallorderdealsrequest *EditAllOrderDealsRequest) *MarketplacedealsUpdateCall {
- c := &MarketplacedealsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.orderId = orderId
- c.editallorderdealsrequest = editallorderdealsrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MarketplacedealsUpdateCall) Fields(s ...googleapi.Field) *MarketplacedealsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MarketplacedealsUpdateCall) Context(ctx context.Context) *MarketplacedealsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MarketplacedealsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.editallorderdealsrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "marketplaceOrders/{orderId}/deals/update")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "orderId": c.orderId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.marketplacedeals.update" call.
-// Exactly one of *EditAllOrderDealsResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *EditAllOrderDealsResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MarketplacedealsUpdateCall) Do() (*EditAllOrderDealsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EditAllOrderDealsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Replaces all the deals in the order with the passed in deals",
- // "httpMethod": "POST",
- // "id": "adexchangebuyer.marketplacedeals.update",
- // "parameterOrder": [
- // "orderId"
- // ],
- // "parameters": {
- // "orderId": {
- // "description": "The orderId to edit deals on.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "marketplaceOrders/{orderId}/deals/update",
- // "request": {
- // "$ref": "EditAllOrderDealsRequest"
- // },
- // "response": {
- // "$ref": "EditAllOrderDealsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.marketplacenotes.insert":
-
-type MarketplacenotesInsertCall struct {
- s *Service
- orderId string
- addordernotesrequest *AddOrderNotesRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Add notes to the order
-func (r *MarketplacenotesService) Insert(orderId string, addordernotesrequest *AddOrderNotesRequest) *MarketplacenotesInsertCall {
- c := &MarketplacenotesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.orderId = orderId
- c.addordernotesrequest = addordernotesrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MarketplacenotesInsertCall) Fields(s ...googleapi.Field) *MarketplacenotesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MarketplacenotesInsertCall) Context(ctx context.Context) *MarketplacenotesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MarketplacenotesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.addordernotesrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "marketplaceOrders/{orderId}/notes/insert")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "orderId": c.orderId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.marketplacenotes.insert" call.
-// Exactly one of *AddOrderNotesResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AddOrderNotesResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MarketplacenotesInsertCall) Do() (*AddOrderNotesResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AddOrderNotesResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Add notes to the order",
- // "httpMethod": "POST",
- // "id": "adexchangebuyer.marketplacenotes.insert",
- // "parameterOrder": [
- // "orderId"
- // ],
- // "parameters": {
- // "orderId": {
- // "description": "The orderId to add notes for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "marketplaceOrders/{orderId}/notes/insert",
- // "request": {
- // "$ref": "AddOrderNotesRequest"
- // },
- // "response": {
- // "$ref": "AddOrderNotesResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.marketplacenotes.list":
-
-type MarketplacenotesListCall struct {
- s *Service
- orderId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Get all the notes associated with an order
-func (r *MarketplacenotesService) List(orderId string) *MarketplacenotesListCall {
- c := &MarketplacenotesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.orderId = orderId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MarketplacenotesListCall) Fields(s ...googleapi.Field) *MarketplacenotesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MarketplacenotesListCall) IfNoneMatch(entityTag string) *MarketplacenotesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MarketplacenotesListCall) Context(ctx context.Context) *MarketplacenotesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MarketplacenotesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "marketplaceOrders/{orderId}/notes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "orderId": c.orderId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.marketplacenotes.list" call.
-// Exactly one of *GetOrderNotesResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *GetOrderNotesResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MarketplacenotesListCall) Do() (*GetOrderNotesResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &GetOrderNotesResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get all the notes associated with an order",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.marketplacenotes.list",
- // "parameterOrder": [
- // "orderId"
- // ],
- // "parameters": {
- // "orderId": {
- // "description": "The orderId to get notes for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "marketplaceOrders/{orderId}/notes",
- // "response": {
- // "$ref": "GetOrderNotesResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.marketplaceoffers.get":
-
-type MarketplaceoffersGetCall struct {
- s *Service
- offerId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets the requested negotiation.
-func (r *MarketplaceoffersService) Get(offerId string) *MarketplaceoffersGetCall {
- c := &MarketplaceoffersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.offerId = offerId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MarketplaceoffersGetCall) Fields(s ...googleapi.Field) *MarketplaceoffersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MarketplaceoffersGetCall) IfNoneMatch(entityTag string) *MarketplaceoffersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MarketplaceoffersGetCall) Context(ctx context.Context) *MarketplaceoffersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MarketplaceoffersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "marketplaceOffers/{offerId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "offerId": c.offerId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.marketplaceoffers.get" call.
-// Exactly one of *MarketplaceOffer or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *MarketplaceOffer.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MarketplaceoffersGetCall) Do() (*MarketplaceOffer, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &MarketplaceOffer{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the requested negotiation.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.marketplaceoffers.get",
- // "parameterOrder": [
- // "offerId"
- // ],
- // "parameters": {
- // "offerId": {
- // "description": "The offerId for the offer to get the head revision for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "marketplaceOffers/{offerId}",
- // "response": {
- // "$ref": "MarketplaceOffer"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.marketplaceoffers.search":
-
-type MarketplaceoffersSearchCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Search: Gets the requested negotiation.
-func (r *MarketplaceoffersService) Search() *MarketplaceoffersSearchCall {
- c := &MarketplaceoffersSearchCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// PqlQuery sets the optional parameter "pqlQuery": The pql query used
-// to query for offers.
-func (c *MarketplaceoffersSearchCall) PqlQuery(pqlQuery string) *MarketplaceoffersSearchCall {
- c.opt_["pqlQuery"] = pqlQuery
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MarketplaceoffersSearchCall) Fields(s ...googleapi.Field) *MarketplaceoffersSearchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MarketplaceoffersSearchCall) IfNoneMatch(entityTag string) *MarketplaceoffersSearchCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MarketplaceoffersSearchCall) Context(ctx context.Context) *MarketplaceoffersSearchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MarketplaceoffersSearchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["pqlQuery"]; ok {
- params.Set("pqlQuery", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "marketplaceOffers/search")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.marketplaceoffers.search" call.
-// Exactly one of *GetOffersResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *GetOffersResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MarketplaceoffersSearchCall) Do() (*GetOffersResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &GetOffersResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the requested negotiation.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.marketplaceoffers.search",
- // "parameters": {
- // "pqlQuery": {
- // "description": "The pql query used to query for offers.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "marketplaceOffers/search",
- // "response": {
- // "$ref": "GetOffersResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.marketplaceorders.get":
-
-type MarketplaceordersGetCall struct {
- s *Service
- orderId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get an order given its id
-func (r *MarketplaceordersService) Get(orderId string) *MarketplaceordersGetCall {
- c := &MarketplaceordersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.orderId = orderId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MarketplaceordersGetCall) Fields(s ...googleapi.Field) *MarketplaceordersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MarketplaceordersGetCall) IfNoneMatch(entityTag string) *MarketplaceordersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MarketplaceordersGetCall) Context(ctx context.Context) *MarketplaceordersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MarketplaceordersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "marketplaceOrders/{orderId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "orderId": c.orderId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.marketplaceorders.get" call.
-// Exactly one of *MarketplaceOrder or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *MarketplaceOrder.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MarketplaceordersGetCall) Do() (*MarketplaceOrder, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &MarketplaceOrder{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get an order given its id",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.marketplaceorders.get",
- // "parameterOrder": [
- // "orderId"
- // ],
- // "parameters": {
- // "orderId": {
- // "description": "Id of the order to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "marketplaceOrders/{orderId}",
- // "response": {
- // "$ref": "MarketplaceOrder"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.marketplaceorders.insert":
-
-type MarketplaceordersInsertCall struct {
- s *Service
- createordersrequest *CreateOrdersRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Create the given list of orders
-func (r *MarketplaceordersService) Insert(createordersrequest *CreateOrdersRequest) *MarketplaceordersInsertCall {
- c := &MarketplaceordersInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.createordersrequest = createordersrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MarketplaceordersInsertCall) Fields(s ...googleapi.Field) *MarketplaceordersInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MarketplaceordersInsertCall) Context(ctx context.Context) *MarketplaceordersInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MarketplaceordersInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.createordersrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "marketplaceOrders/insert")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.marketplaceorders.insert" call.
-// Exactly one of *CreateOrdersResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CreateOrdersResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MarketplaceordersInsertCall) Do() (*CreateOrdersResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreateOrdersResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Create the given list of orders",
- // "httpMethod": "POST",
- // "id": "adexchangebuyer.marketplaceorders.insert",
- // "path": "marketplaceOrders/insert",
- // "request": {
- // "$ref": "CreateOrdersRequest"
- // },
- // "response": {
- // "$ref": "CreateOrdersResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.marketplaceorders.patch":
-
-type MarketplaceordersPatchCall struct {
- s *Service
- orderId string
- revisionNumber int64
- updateAction string
- marketplaceorder *MarketplaceOrder
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Update the given order. This method supports patch semantics.
-func (r *MarketplaceordersService) Patch(orderId string, revisionNumber int64, updateAction string, marketplaceorder *MarketplaceOrder) *MarketplaceordersPatchCall {
- c := &MarketplaceordersPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.orderId = orderId
- c.revisionNumber = revisionNumber
- c.updateAction = updateAction
- c.marketplaceorder = marketplaceorder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MarketplaceordersPatchCall) Fields(s ...googleapi.Field) *MarketplaceordersPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MarketplaceordersPatchCall) Context(ctx context.Context) *MarketplaceordersPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MarketplaceordersPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.marketplaceorder)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "marketplaceOrders/{orderId}/{revisionNumber}/{updateAction}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "orderId": c.orderId,
- "revisionNumber": strconv.FormatInt(c.revisionNumber, 10),
- "updateAction": c.updateAction,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.marketplaceorders.patch" call.
-// Exactly one of *MarketplaceOrder or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *MarketplaceOrder.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MarketplaceordersPatchCall) Do() (*MarketplaceOrder, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &MarketplaceOrder{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update the given order. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "adexchangebuyer.marketplaceorders.patch",
- // "parameterOrder": [
- // "orderId",
- // "revisionNumber",
- // "updateAction"
- // ],
- // "parameters": {
- // "orderId": {
- // "description": "The order id to update.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "revisionNumber": {
- // "description": "The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the lastest order at head revision and retry the update at that revision.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "updateAction": {
- // "description": "The proposed action to take on the order.",
- // "enum": [
- // "accept",
- // "cancel",
- // "propose",
- // "unknownAction",
- // "updateFinalized"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "marketplaceOrders/{orderId}/{revisionNumber}/{updateAction}",
- // "request": {
- // "$ref": "MarketplaceOrder"
- // },
- // "response": {
- // "$ref": "MarketplaceOrder"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.marketplaceorders.search":
-
-type MarketplaceordersSearchCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Search: Search for orders using pql query
-func (r *MarketplaceordersService) Search() *MarketplaceordersSearchCall {
- c := &MarketplaceordersSearchCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// PqlQuery sets the optional parameter "pqlQuery": Query string to
-// retrieve specific orders.
-func (c *MarketplaceordersSearchCall) PqlQuery(pqlQuery string) *MarketplaceordersSearchCall {
- c.opt_["pqlQuery"] = pqlQuery
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MarketplaceordersSearchCall) Fields(s ...googleapi.Field) *MarketplaceordersSearchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MarketplaceordersSearchCall) IfNoneMatch(entityTag string) *MarketplaceordersSearchCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MarketplaceordersSearchCall) Context(ctx context.Context) *MarketplaceordersSearchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MarketplaceordersSearchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["pqlQuery"]; ok {
- params.Set("pqlQuery", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "marketplaceOrders/search")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.marketplaceorders.search" call.
-// Exactly one of *GetOrdersResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *GetOrdersResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MarketplaceordersSearchCall) Do() (*GetOrdersResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &GetOrdersResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Search for orders using pql query",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.marketplaceorders.search",
- // "parameters": {
- // "pqlQuery": {
- // "description": "Query string to retrieve specific orders.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "marketplaceOrders/search",
- // "response": {
- // "$ref": "GetOrdersResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.marketplaceorders.update":
-
-type MarketplaceordersUpdateCall struct {
- s *Service
- orderId string
- revisionNumber int64
- updateAction string
- marketplaceorder *MarketplaceOrder
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Update the given order
-func (r *MarketplaceordersService) Update(orderId string, revisionNumber int64, updateAction string, marketplaceorder *MarketplaceOrder) *MarketplaceordersUpdateCall {
- c := &MarketplaceordersUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.orderId = orderId
- c.revisionNumber = revisionNumber
- c.updateAction = updateAction
- c.marketplaceorder = marketplaceorder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MarketplaceordersUpdateCall) Fields(s ...googleapi.Field) *MarketplaceordersUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MarketplaceordersUpdateCall) Context(ctx context.Context) *MarketplaceordersUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MarketplaceordersUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.marketplaceorder)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "marketplaceOrders/{orderId}/{revisionNumber}/{updateAction}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "orderId": c.orderId,
- "revisionNumber": strconv.FormatInt(c.revisionNumber, 10),
- "updateAction": c.updateAction,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.marketplaceorders.update" call.
-// Exactly one of *MarketplaceOrder or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *MarketplaceOrder.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MarketplaceordersUpdateCall) Do() (*MarketplaceOrder, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &MarketplaceOrder{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update the given order",
- // "httpMethod": "PUT",
- // "id": "adexchangebuyer.marketplaceorders.update",
- // "parameterOrder": [
- // "orderId",
- // "revisionNumber",
- // "updateAction"
- // ],
- // "parameters": {
- // "orderId": {
- // "description": "The order id to update.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "revisionNumber": {
- // "description": "The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the lastest order at head revision and retry the update at that revision.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "updateAction": {
- // "description": "The proposed action to take on the order.",
- // "enum": [
- // "accept",
- // "cancel",
- // "propose",
- // "unknownAction",
- // "updateFinalized"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "marketplaceOrders/{orderId}/{revisionNumber}/{updateAction}",
- // "request": {
- // "$ref": "MarketplaceOrder"
- // },
- // "response": {
- // "$ref": "MarketplaceOrder"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.negotiationrounds.insert":
-
-type NegotiationroundsInsertCall struct {
- s *Service
- negotiationId int64
- negotiationrounddto *NegotiationRoundDto
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Adds the requested negotiationRound to the requested
-// negotiation.
-func (r *NegotiationroundsService) Insert(negotiationId int64, negotiationrounddto *NegotiationRoundDto) *NegotiationroundsInsertCall {
- c := &NegotiationroundsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.negotiationId = negotiationId
- c.negotiationrounddto = negotiationrounddto
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *NegotiationroundsInsertCall) Fields(s ...googleapi.Field) *NegotiationroundsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *NegotiationroundsInsertCall) Context(ctx context.Context) *NegotiationroundsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *NegotiationroundsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.negotiationrounddto)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "negotiations/{negotiationId}/negotiationrounds")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "negotiationId": strconv.FormatInt(c.negotiationId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.negotiationrounds.insert" call.
-// Exactly one of *NegotiationRoundDto or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *NegotiationRoundDto.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *NegotiationroundsInsertCall) Do() (*NegotiationRoundDto, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &NegotiationRoundDto{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Adds the requested negotiationRound to the requested negotiation.",
- // "httpMethod": "POST",
- // "id": "adexchangebuyer.negotiationrounds.insert",
- // "parameterOrder": [
- // "negotiationId"
- // ],
- // "parameters": {
- // "negotiationId": {
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "negotiations/{negotiationId}/negotiationrounds",
- // "request": {
- // "$ref": "NegotiationRoundDto"
- // },
- // "response": {
- // "$ref": "NegotiationRoundDto"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.negotiations.get":
-
-type NegotiationsGetCall struct {
- s *Service
- negotiationId int64
- getnegotiationbyidrequest *GetNegotiationByIdRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets the requested negotiation.
-func (r *NegotiationsService) Get(negotiationId int64, getnegotiationbyidrequest *GetNegotiationByIdRequest) *NegotiationsGetCall {
- c := &NegotiationsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.negotiationId = negotiationId
- c.getnegotiationbyidrequest = getnegotiationbyidrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *NegotiationsGetCall) Fields(s ...googleapi.Field) *NegotiationsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *NegotiationsGetCall) IfNoneMatch(entityTag string) *NegotiationsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *NegotiationsGetCall) Context(ctx context.Context) *NegotiationsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *NegotiationsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "negotiations/{negotiationId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "negotiationId": strconv.FormatInt(c.negotiationId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.negotiations.get" call.
-// Exactly one of *NegotiationDto or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *NegotiationDto.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *NegotiationsGetCall) Do() (*NegotiationDto, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &NegotiationDto{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the requested negotiation.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.negotiations.get",
- // "parameterOrder": [
- // "negotiationId"
- // ],
- // "parameters": {
- // "negotiationId": {
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "negotiations/{negotiationId}",
- // "request": {
- // "$ref": "GetNegotiationByIdRequest"
- // },
- // "response": {
- // "$ref": "NegotiationDto"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.negotiations.insert":
-
-type NegotiationsInsertCall struct {
- s *Service
- negotiationdto *NegotiationDto
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates or updates the requested negotiation.
-func (r *NegotiationsService) Insert(negotiationdto *NegotiationDto) *NegotiationsInsertCall {
- c := &NegotiationsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.negotiationdto = negotiationdto
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *NegotiationsInsertCall) Fields(s ...googleapi.Field) *NegotiationsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *NegotiationsInsertCall) Context(ctx context.Context) *NegotiationsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *NegotiationsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.negotiationdto)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "negotiations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.negotiations.insert" call.
-// Exactly one of *NegotiationDto or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *NegotiationDto.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *NegotiationsInsertCall) Do() (*NegotiationDto, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &NegotiationDto{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates or updates the requested negotiation.",
- // "httpMethod": "POST",
- // "id": "adexchangebuyer.negotiations.insert",
- // "path": "negotiations",
- // "request": {
- // "$ref": "NegotiationDto"
- // },
- // "response": {
- // "$ref": "NegotiationDto"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.negotiations.list":
-
-type NegotiationsListCall struct {
- s *Service
- getnegotiationsrequest *GetNegotiationsRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all negotiations the authenticated user has access to.
-func (r *NegotiationsService) List(getnegotiationsrequest *GetNegotiationsRequest) *NegotiationsListCall {
- c := &NegotiationsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.getnegotiationsrequest = getnegotiationsrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *NegotiationsListCall) Fields(s ...googleapi.Field) *NegotiationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *NegotiationsListCall) IfNoneMatch(entityTag string) *NegotiationsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *NegotiationsListCall) Context(ctx context.Context) *NegotiationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *NegotiationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "negotiations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.negotiations.list" call.
-// Exactly one of *GetNegotiationsResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *GetNegotiationsResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *NegotiationsListCall) Do() (*GetNegotiationsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &GetNegotiationsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all negotiations the authenticated user has access to.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.negotiations.list",
- // "path": "negotiations",
- // "request": {
- // "$ref": "GetNegotiationsRequest"
- // },
- // "response": {
- // "$ref": "GetNegotiationsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.offers.get":
-
-type OffersGetCall struct {
- s *Service
- offerId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets the requested offer.
-func (r *OffersService) Get(offerId int64) *OffersGetCall {
- c := &OffersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.offerId = offerId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OffersGetCall) Fields(s ...googleapi.Field) *OffersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OffersGetCall) IfNoneMatch(entityTag string) *OffersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OffersGetCall) Context(ctx context.Context) *OffersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OffersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "offers/{offerId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "offerId": strconv.FormatInt(c.offerId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.offers.get" call.
-// Exactly one of *OfferDto or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *OfferDto.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *OffersGetCall) Do() (*OfferDto, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OfferDto{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the requested offer.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.offers.get",
- // "parameterOrder": [
- // "offerId"
- // ],
- // "parameters": {
- // "offerId": {
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "offers/{offerId}",
- // "response": {
- // "$ref": "OfferDto"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.offers.insert":
-
-type OffersInsertCall struct {
- s *Service
- offerdto *OfferDto
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates or updates the requested offer.
-func (r *OffersService) Insert(offerdto *OfferDto) *OffersInsertCall {
- c := &OffersInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.offerdto = offerdto
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OffersInsertCall) Fields(s ...googleapi.Field) *OffersInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OffersInsertCall) Context(ctx context.Context) *OffersInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OffersInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.offerdto)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "offers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.offers.insert" call.
-// Exactly one of *OfferDto or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *OfferDto.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *OffersInsertCall) Do() (*OfferDto, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OfferDto{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates or updates the requested offer.",
- // "httpMethod": "POST",
- // "id": "adexchangebuyer.offers.insert",
- // "path": "offers",
- // "request": {
- // "$ref": "OfferDto"
- // },
- // "response": {
- // "$ref": "OfferDto"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.offers.list":
-
-type OffersListCall struct {
- s *Service
- listoffersrequest *ListOffersRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all offers the authenticated user has access to.
-func (r *OffersService) List(listoffersrequest *ListOffersRequest) *OffersListCall {
- c := &OffersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.listoffersrequest = listoffersrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OffersListCall) Fields(s ...googleapi.Field) *OffersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OffersListCall) IfNoneMatch(entityTag string) *OffersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OffersListCall) Context(ctx context.Context) *OffersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OffersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "offers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.offers.list" call.
-// Exactly one of *ListOffersResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ListOffersResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OffersListCall) Do() (*ListOffersResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ListOffersResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all offers the authenticated user has access to.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.offers.list",
- // "path": "offers",
- // "request": {
- // "$ref": "ListOffersRequest"
- // },
- // "response": {
- // "$ref": "ListOffersResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.performanceReport.list":
-
-type PerformanceReportListCall struct {
- s *Service
- accountId int64
- endDateTime string
- startDateTime string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the authenticated user's list of performance metrics.
-func (r *PerformanceReportService) List(accountId int64, endDateTime string, startDateTime string) *PerformanceReportListCall {
- c := &PerformanceReportListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.endDateTime = endDateTime
- c.startDateTime = startDateTime
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of entries returned on one result page. If not set, the default is
-// 100.
-func (c *PerformanceReportListCall) MaxResults(maxResults int64) *PerformanceReportListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through performance reports. To retrieve the next
-// page, set this parameter to the value of "nextPageToken" from the
-// previous response.
-func (c *PerformanceReportListCall) PageToken(pageToken string) *PerformanceReportListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PerformanceReportListCall) Fields(s ...googleapi.Field) *PerformanceReportListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PerformanceReportListCall) IfNoneMatch(entityTag string) *PerformanceReportListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PerformanceReportListCall) Context(ctx context.Context) *PerformanceReportListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PerformanceReportListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("accountId", fmt.Sprintf("%v", c.accountId))
- params.Set("endDateTime", fmt.Sprintf("%v", c.endDateTime))
- params.Set("startDateTime", fmt.Sprintf("%v", c.startDateTime))
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "performancereport")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.performanceReport.list" call.
-// Exactly one of *PerformanceReportList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *PerformanceReportList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PerformanceReportListCall) Do() (*PerformanceReportList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PerformanceReportList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the authenticated user's list of performance metrics.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.performanceReport.list",
- // "parameterOrder": [
- // "accountId",
- // "endDateTime",
- // "startDateTime"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The account id to get the reports.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "endDateTime": {
- // "description": "The end time of the report in ISO 8601 timestamp format using UTC.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "1000",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through performance reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response. Optional.",
- // "location": "query",
- // "type": "string"
- // },
- // "startDateTime": {
- // "description": "The start time of the report in ISO 8601 timestamp format using UTC.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "performancereport",
- // "response": {
- // "$ref": "PerformanceReportList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.pretargetingConfig.delete":
-
-type PretargetingConfigDeleteCall struct {
- s *Service
- accountId int64
- configId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an existing pretargeting config.
-func (r *PretargetingConfigService) Delete(accountId int64, configId int64) *PretargetingConfigDeleteCall {
- c := &PretargetingConfigDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.configId = configId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PretargetingConfigDeleteCall) Fields(s ...googleapi.Field) *PretargetingConfigDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PretargetingConfigDeleteCall) Context(ctx context.Context) *PretargetingConfigDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PretargetingConfigDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "pretargetingconfigs/{accountId}/{configId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": strconv.FormatInt(c.accountId, 10),
- "configId": strconv.FormatInt(c.configId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.pretargetingConfig.delete" call.
-func (c *PretargetingConfigDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes an existing pretargeting config.",
- // "httpMethod": "DELETE",
- // "id": "adexchangebuyer.pretargetingConfig.delete",
- // "parameterOrder": [
- // "accountId",
- // "configId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The account id to delete the pretargeting config for.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "configId": {
- // "description": "The specific id of the configuration to delete.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "pretargetingconfigs/{accountId}/{configId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.pretargetingConfig.get":
-
-type PretargetingConfigGetCall struct {
- s *Service
- accountId int64
- configId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets a specific pretargeting configuration
-func (r *PretargetingConfigService) Get(accountId int64, configId int64) *PretargetingConfigGetCall {
- c := &PretargetingConfigGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.configId = configId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PretargetingConfigGetCall) Fields(s ...googleapi.Field) *PretargetingConfigGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PretargetingConfigGetCall) IfNoneMatch(entityTag string) *PretargetingConfigGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PretargetingConfigGetCall) Context(ctx context.Context) *PretargetingConfigGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PretargetingConfigGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "pretargetingconfigs/{accountId}/{configId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": strconv.FormatInt(c.accountId, 10),
- "configId": strconv.FormatInt(c.configId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.pretargetingConfig.get" call.
-// Exactly one of *PretargetingConfig or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *PretargetingConfig.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PretargetingConfigGetCall) Do() (*PretargetingConfig, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PretargetingConfig{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets a specific pretargeting configuration",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.pretargetingConfig.get",
- // "parameterOrder": [
- // "accountId",
- // "configId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The account id to get the pretargeting config for.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "configId": {
- // "description": "The specific id of the configuration to retrieve.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "pretargetingconfigs/{accountId}/{configId}",
- // "response": {
- // "$ref": "PretargetingConfig"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.pretargetingConfig.insert":
-
-type PretargetingConfigInsertCall struct {
- s *Service
- accountId int64
- pretargetingconfig *PretargetingConfig
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new pretargeting configuration.
-func (r *PretargetingConfigService) Insert(accountId int64, pretargetingconfig *PretargetingConfig) *PretargetingConfigInsertCall {
- c := &PretargetingConfigInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.pretargetingconfig = pretargetingconfig
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PretargetingConfigInsertCall) Fields(s ...googleapi.Field) *PretargetingConfigInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PretargetingConfigInsertCall) Context(ctx context.Context) *PretargetingConfigInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PretargetingConfigInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.pretargetingconfig)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "pretargetingconfigs/{accountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": strconv.FormatInt(c.accountId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.pretargetingConfig.insert" call.
-// Exactly one of *PretargetingConfig or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *PretargetingConfig.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PretargetingConfigInsertCall) Do() (*PretargetingConfig, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PretargetingConfig{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new pretargeting configuration.",
- // "httpMethod": "POST",
- // "id": "adexchangebuyer.pretargetingConfig.insert",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The account id to insert the pretargeting config for.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "pretargetingconfigs/{accountId}",
- // "request": {
- // "$ref": "PretargetingConfig"
- // },
- // "response": {
- // "$ref": "PretargetingConfig"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.pretargetingConfig.list":
-
-type PretargetingConfigListCall struct {
- s *Service
- accountId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of the authenticated user's pretargeting
-// configurations.
-func (r *PretargetingConfigService) List(accountId int64) *PretargetingConfigListCall {
- c := &PretargetingConfigListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PretargetingConfigListCall) Fields(s ...googleapi.Field) *PretargetingConfigListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PretargetingConfigListCall) IfNoneMatch(entityTag string) *PretargetingConfigListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PretargetingConfigListCall) Context(ctx context.Context) *PretargetingConfigListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PretargetingConfigListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "pretargetingconfigs/{accountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": strconv.FormatInt(c.accountId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.pretargetingConfig.list" call.
-// Exactly one of *PretargetingConfigList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *PretargetingConfigList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PretargetingConfigListCall) Do() (*PretargetingConfigList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PretargetingConfigList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of the authenticated user's pretargeting configurations.",
- // "httpMethod": "GET",
- // "id": "adexchangebuyer.pretargetingConfig.list",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The account id to get the pretargeting configs for.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "pretargetingconfigs/{accountId}",
- // "response": {
- // "$ref": "PretargetingConfigList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.pretargetingConfig.patch":
-
-type PretargetingConfigPatchCall struct {
- s *Service
- accountId int64
- configId int64
- pretargetingconfig *PretargetingConfig
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing pretargeting config. This method supports
-// patch semantics.
-func (r *PretargetingConfigService) Patch(accountId int64, configId int64, pretargetingconfig *PretargetingConfig) *PretargetingConfigPatchCall {
- c := &PretargetingConfigPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.configId = configId
- c.pretargetingconfig = pretargetingconfig
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PretargetingConfigPatchCall) Fields(s ...googleapi.Field) *PretargetingConfigPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PretargetingConfigPatchCall) Context(ctx context.Context) *PretargetingConfigPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PretargetingConfigPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.pretargetingconfig)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "pretargetingconfigs/{accountId}/{configId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": strconv.FormatInt(c.accountId, 10),
- "configId": strconv.FormatInt(c.configId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.pretargetingConfig.patch" call.
-// Exactly one of *PretargetingConfig or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *PretargetingConfig.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PretargetingConfigPatchCall) Do() (*PretargetingConfig, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PretargetingConfig{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing pretargeting config. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "adexchangebuyer.pretargetingConfig.patch",
- // "parameterOrder": [
- // "accountId",
- // "configId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The account id to update the pretargeting config for.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "configId": {
- // "description": "The specific id of the configuration to update.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "pretargetingconfigs/{accountId}/{configId}",
- // "request": {
- // "$ref": "PretargetingConfig"
- // },
- // "response": {
- // "$ref": "PretargetingConfig"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
-
-// method id "adexchangebuyer.pretargetingConfig.update":
-
-type PretargetingConfigUpdateCall struct {
- s *Service
- accountId int64
- configId int64
- pretargetingconfig *PretargetingConfig
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing pretargeting config.
-func (r *PretargetingConfigService) Update(accountId int64, configId int64, pretargetingconfig *PretargetingConfig) *PretargetingConfigUpdateCall {
- c := &PretargetingConfigUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.configId = configId
- c.pretargetingconfig = pretargetingconfig
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PretargetingConfigUpdateCall) Fields(s ...googleapi.Field) *PretargetingConfigUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PretargetingConfigUpdateCall) Context(ctx context.Context) *PretargetingConfigUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PretargetingConfigUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.pretargetingconfig)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "pretargetingconfigs/{accountId}/{configId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": strconv.FormatInt(c.accountId, 10),
- "configId": strconv.FormatInt(c.configId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangebuyer.pretargetingConfig.update" call.
-// Exactly one of *PretargetingConfig or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *PretargetingConfig.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PretargetingConfigUpdateCall) Do() (*PretargetingConfig, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PretargetingConfig{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing pretargeting config.",
- // "httpMethod": "PUT",
- // "id": "adexchangebuyer.pretargetingConfig.update",
- // "parameterOrder": [
- // "accountId",
- // "configId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The account id to update the pretargeting config for.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "configId": {
- // "description": "The specific id of the configuration to update.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "pretargetingconfigs/{accountId}/{configId}",
- // "request": {
- // "$ref": "PretargetingConfig"
- // },
- // "response": {
- // "$ref": "PretargetingConfig"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.buyer"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/adexchangeseller/v1.1/adexchangeseller-api.json b/vendor/google.golang.org/api/adexchangeseller/v1.1/adexchangeseller-api.json
deleted file mode 100644
index a0fe9388..00000000
--- a/vendor/google.golang.org/api/adexchangeseller/v1.1/adexchangeseller-api.json
+++ /dev/null
@@ -1,1241 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/Ob-vIbU0CMw39spLQLZEQavYp3Q\"",
- "discoveryVersion": "v1",
- "id": "adexchangeseller:v1.1",
- "name": "adexchangeseller",
- "canonicalName": "Ad Exchange Seller",
- "version": "v1.1",
- "revision": "20141112",
- "title": "Ad Exchange Seller API",
- "description": "Gives Ad Exchange seller users access to their inventory and the ability to generate reports",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/ad-exchange/seller-rest/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/adexchangeseller/v1.1/",
- "basePath": "/adexchangeseller/v1.1/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "adexchangeseller/v1.1/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "csv",
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of text/csv",
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/adexchange.seller": {
- "description": "View and manage your Ad Exchange data"
- },
- "https://www.googleapis.com/auth/adexchange.seller.readonly": {
- "description": "View your Ad Exchange data"
- }
- }
- }
- },
- "schemas": {
- "Account": {
- "id": "Account",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this account."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#account.",
- "default": "adexchangeseller#account"
- },
- "name": {
- "type": "string",
- "description": "Name of this account."
- }
- }
- },
- "AdClient": {
- "id": "AdClient",
- "type": "object",
- "properties": {
- "arcOptIn": {
- "type": "boolean",
- "description": "Whether this ad client is opted in to ARC."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this ad client."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#adClient.",
- "default": "adexchangeseller#adClient"
- },
- "productCode": {
- "type": "string",
- "description": "This ad client's product code, which corresponds to the PRODUCT_CODE report dimension."
- },
- "supportsReporting": {
- "type": "boolean",
- "description": "Whether this ad client supports being reported on."
- }
- }
- },
- "AdClients": {
- "id": "AdClients",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The ad clients returned in this list response.",
- "items": {
- "$ref": "AdClient"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#adClients.",
- "default": "adexchangeseller#adClients"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "AdUnit": {
- "id": "AdUnit",
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "Identity code of this ad unit, not necessarily unique across ad clients."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#adUnit.",
- "default": "adexchangeseller#adUnit"
- },
- "name": {
- "type": "string",
- "description": "Name of this ad unit."
- },
- "status": {
- "type": "string",
- "description": "Status of this ad unit. Possible values are:\nNEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.\n\nACTIVE: Indicates that there has been activity on this ad unit in the last seven days.\n\nINACTIVE: Indicates that there has been no activity on this ad unit in the last seven days."
- }
- }
- },
- "AdUnits": {
- "id": "AdUnits",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The ad units returned in this list response.",
- "items": {
- "$ref": "AdUnit"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#adUnits.",
- "default": "adexchangeseller#adUnits"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through ad units. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "Alert": {
- "id": "Alert",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this alert. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#alert.",
- "default": "adexchangeseller#alert"
- },
- "message": {
- "type": "string",
- "description": "The localized alert message."
- },
- "severity": {
- "type": "string",
- "description": "Severity of this alert. Possible values: INFO, WARNING, SEVERE."
- },
- "type": {
- "type": "string",
- "description": "Type of this alert. Possible values: SELF_HOLD, MIGRATED_TO_BILLING3, ADDRESS_PIN_VERIFICATION, PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, GRAYLISTED_PUBLISHER, API_HOLD."
- }
- }
- },
- "Alerts": {
- "id": "Alerts",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "The alerts returned in this list response.",
- "items": {
- "$ref": "Alert"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#alerts.",
- "default": "adexchangeseller#alerts"
- }
- }
- },
- "CustomChannel": {
- "id": "CustomChannel",
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "Code of this custom channel, not necessarily unique across ad clients."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#customChannel.",
- "default": "adexchangeseller#customChannel"
- },
- "name": {
- "type": "string",
- "description": "Name of this custom channel."
- },
- "targetingInfo": {
- "type": "object",
- "description": "The targeting information of this custom channel, if activated.",
- "properties": {
- "adsAppearOn": {
- "type": "string",
- "description": "The name used to describe this channel externally."
- },
- "description": {
- "type": "string",
- "description": "The external description of the channel."
- },
- "location": {
- "type": "string",
- "description": "The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS."
- },
- "siteLanguage": {
- "type": "string",
- "description": "The language of the sites ads will be displayed on."
- }
- }
- }
- }
- },
- "CustomChannels": {
- "id": "CustomChannels",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The custom channels returned in this list response.",
- "items": {
- "$ref": "CustomChannel"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#customChannels.",
- "default": "adexchangeseller#customChannels"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "Metadata": {
- "id": "Metadata",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "items": {
- "$ref": "ReportingMetadataEntry"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#metadata.",
- "default": "adexchangeseller#metadata"
- }
- }
- },
- "PreferredDeal": {
- "id": "PreferredDeal",
- "type": "object",
- "properties": {
- "advertiserName": {
- "type": "string",
- "description": "The name of the advertiser this deal is for."
- },
- "buyerNetworkName": {
- "type": "string",
- "description": "The name of the buyer network this deal is for."
- },
- "currencyCode": {
- "type": "string",
- "description": "The currency code that applies to the fixed_cpm value. If not set then assumed to be USD."
- },
- "endTime": {
- "type": "string",
- "description": "Time when this deal stops being active in seconds since the epoch (GMT). If not set then this deal is valid until manually disabled by the publisher.",
- "format": "uint64"
- },
- "fixedCpm": {
- "type": "string",
- "description": "The fixed price for this preferred deal. In cpm micros of currency according to currencyCode. If set, then this preferred deal is eligible for the fixed price tier of buying (highest priority, pay exactly the configured fixed price).",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this preferred deal.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#preferredDeal.",
- "default": "adexchangeseller#preferredDeal"
- },
- "startTime": {
- "type": "string",
- "description": "Time when this deal becomes active in seconds since the epoch (GMT). If not set then this deal is active immediately upon creation.",
- "format": "uint64"
- }
- }
- },
- "PreferredDeals": {
- "id": "PreferredDeals",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "The preferred deals returned in this list response.",
- "items": {
- "$ref": "PreferredDeal"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#preferredDeals.",
- "default": "adexchangeseller#preferredDeals"
- }
- }
- },
- "Report": {
- "id": "Report",
- "type": "object",
- "properties": {
- "averages": {
- "type": "array",
- "description": "The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
- "items": {
- "type": "string"
- }
- },
- "headers": {
- "type": "array",
- "description": "The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.",
- "items": {
- "type": "object",
- "properties": {
- "currency": {
- "type": "string",
- "description": "The currency of this column. Only present if the header type is METRIC_CURRENCY."
- },
- "name": {
- "type": "string",
- "description": "The name of the header."
- },
- "type": {
- "type": "string",
- "description": "The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY."
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind this is, in this case adexchangeseller#report.",
- "default": "adexchangeseller#report"
- },
- "rows": {
- "type": "array",
- "description": "The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.",
- "items": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "totalMatchedRows": {
- "type": "string",
- "description": "The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.",
- "format": "int64"
- },
- "totals": {
- "type": "array",
- "description": "The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
- "items": {
- "type": "string"
- }
- },
- "warnings": {
- "type": "array",
- "description": "Any warnings associated with generation of the report.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "ReportingMetadataEntry": {
- "id": "ReportingMetadataEntry",
- "type": "object",
- "properties": {
- "compatibleDimensions": {
- "type": "array",
- "description": "For metrics this is a list of dimension IDs which the metric is compatible with, for dimensions it is a list of compatibility groups the dimension belongs to.",
- "items": {
- "type": "string"
- }
- },
- "compatibleMetrics": {
- "type": "array",
- "description": "The names of the metrics the dimension or metric this reporting metadata entry describes is compatible with.",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this reporting metadata entry, corresponding to the name of the appropriate dimension or metric."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#reportingMetadataEntry.",
- "default": "adexchangeseller#reportingMetadataEntry"
- },
- "requiredDimensions": {
- "type": "array",
- "description": "The names of the dimensions which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.",
- "items": {
- "type": "string"
- }
- },
- "requiredMetrics": {
- "type": "array",
- "description": "The names of the metrics which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.",
- "items": {
- "type": "string"
- }
- },
- "supportedProducts": {
- "type": "array",
- "description": "The codes of the projects supported by the dimension or metric this reporting metadata entry describes.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "SavedReport": {
- "id": "SavedReport",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this saved report."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#savedReport.",
- "default": "adexchangeseller#savedReport"
- },
- "name": {
- "type": "string",
- "description": "This saved report's name."
- }
- }
- },
- "SavedReports": {
- "id": "SavedReports",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The saved reports returned in this list response.",
- "items": {
- "$ref": "SavedReport"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#savedReports.",
- "default": "adexchangeseller#savedReports"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "UrlChannel": {
- "id": "UrlChannel",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#urlChannel.",
- "default": "adexchangeseller#urlChannel"
- },
- "urlPattern": {
- "type": "string",
- "description": "URL Pattern of this URL channel. Does not include \"http://\" or \"https://\". Example: www.example.com/home"
- }
- }
- },
- "UrlChannels": {
- "id": "UrlChannels",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The URL channels returned in this list response.",
- "items": {
- "$ref": "UrlChannel"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#urlChannels.",
- "default": "adexchangeseller#urlChannels"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- }
- },
- "resources": {
- "accounts": {
- "methods": {
- "get": {
- "id": "adexchangeseller.accounts.get",
- "path": "accounts/{accountId}",
- "httpMethod": "GET",
- "description": "Get information about the selected Ad Exchange account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to get information about. Tip: 'myaccount' is a valid ID.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- },
- "adclients": {
- "methods": {
- "list": {
- "id": "adexchangeseller.adclients.list",
- "path": "adclients",
- "httpMethod": "GET",
- "description": "List all ad clients in this Ad Exchange account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad clients to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "AdClients"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- },
- "adunits": {
- "methods": {
- "get": {
- "id": "adexchangeseller.adunits.get",
- "path": "adclients/{adClientId}/adunits/{adUnitId}",
- "httpMethod": "GET",
- "description": "Gets the specified ad unit in the specified ad client.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to get the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "AdUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- },
- "list": {
- "id": "adexchangeseller.adunits.list",
- "path": "adclients/{adClientId}/adunits",
- "httpMethod": "GET",
- "description": "List all ad units in the specified ad client for this Ad Exchange account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list ad units.",
- "required": true,
- "location": "path"
- },
- "includeInactive": {
- "type": "boolean",
- "description": "Whether to include inactive ad units. Default: true.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad units to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "AdUnits"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- },
- "resources": {
- "customchannels": {
- "methods": {
- "list": {
- "id": "adexchangeseller.adunits.customchannels.list",
- "path": "adclients/{adClientId}/adunits/{adUnitId}/customchannels",
- "httpMethod": "GET",
- "description": "List all custom channels which the specified ad unit belongs to.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit for which to list custom channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- }
- }
- },
- "alerts": {
- "methods": {
- "list": {
- "id": "adexchangeseller.alerts.list",
- "path": "alerts",
- "httpMethod": "GET",
- "description": "List the alerts for this Ad Exchange account.",
- "parameters": {
- "locale": {
- "type": "string",
- "description": "The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Alerts"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- },
- "customchannels": {
- "methods": {
- "get": {
- "id": "adexchangeseller.customchannels.get",
- "path": "adclients/{adClientId}/customchannels/{customChannelId}",
- "httpMethod": "GET",
- "description": "Get the specified custom channel from the specified ad client.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the custom channel.",
- "required": true,
- "location": "path"
- },
- "customChannelId": {
- "type": "string",
- "description": "Custom channel to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "CustomChannel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- },
- "list": {
- "id": "adexchangeseller.customchannels.list",
- "path": "adclients/{adClientId}/customchannels",
- "httpMethod": "GET",
- "description": "List all custom channels in the specified ad client for this Ad Exchange account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list custom channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- },
- "resources": {
- "adunits": {
- "methods": {
- "list": {
- "id": "adexchangeseller.customchannels.adunits.list",
- "path": "adclients/{adClientId}/customchannels/{customChannelId}/adunits",
- "httpMethod": "GET",
- "description": "List all ad units in the specified custom channel.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the custom channel.",
- "required": true,
- "location": "path"
- },
- "customChannelId": {
- "type": "string",
- "description": "Custom channel for which to list ad units.",
- "required": true,
- "location": "path"
- },
- "includeInactive": {
- "type": "boolean",
- "description": "Whether to include inactive ad units. Default: true.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad units to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "AdUnits"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- }
- }
- },
- "metadata": {
- "resources": {
- "dimensions": {
- "methods": {
- "list": {
- "id": "adexchangeseller.metadata.dimensions.list",
- "path": "metadata/dimensions",
- "httpMethod": "GET",
- "description": "List the metadata for the dimensions available to this AdExchange account.",
- "response": {
- "$ref": "Metadata"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- },
- "metrics": {
- "methods": {
- "list": {
- "id": "adexchangeseller.metadata.metrics.list",
- "path": "metadata/metrics",
- "httpMethod": "GET",
- "description": "List the metadata for the metrics available to this AdExchange account.",
- "response": {
- "$ref": "Metadata"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- }
- }
- },
- "preferreddeals": {
- "methods": {
- "get": {
- "id": "adexchangeseller.preferreddeals.get",
- "path": "preferreddeals/{dealId}",
- "httpMethod": "GET",
- "description": "Get information about the selected Ad Exchange Preferred Deal.",
- "parameters": {
- "dealId": {
- "type": "string",
- "description": "Preferred deal to get information about.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "dealId"
- ],
- "response": {
- "$ref": "PreferredDeal"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- },
- "list": {
- "id": "adexchangeseller.preferreddeals.list",
- "path": "preferreddeals",
- "httpMethod": "GET",
- "description": "List the preferred deals for this Ad Exchange account.",
- "response": {
- "$ref": "PreferredDeals"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- },
- "reports": {
- "methods": {
- "generate": {
- "id": "adexchangeseller.reports.generate",
- "path": "reports",
- "httpMethod": "GET",
- "description": "Generate an Ad Exchange report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
- "parameters": {
- "dimension": {
- "type": "string",
- "description": "Dimensions to base the report on.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "endDate": {
- "type": "string",
- "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "Filters to be run on the report.",
- "pattern": "[a-zA-Z_]+(==|=@).+",
- "repeated": true,
- "location": "query"
- },
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "metric": {
- "type": "string",
- "description": "Numeric columns to include in the report.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "sort": {
- "type": "string",
- "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
- "pattern": "(\\+|-)?[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "startDate": {
- "type": "string",
- "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
- }
- },
- "parameterOrder": [
- "startDate",
- "endDate"
- ],
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ],
- "supportsMediaDownload": true
- }
- },
- "resources": {
- "saved": {
- "methods": {
- "generate": {
- "id": "adexchangeseller.reports.saved.generate",
- "path": "reports/{savedReportId}",
- "httpMethod": "GET",
- "description": "Generate an Ad Exchange report based on the saved report ID sent in the query parameters.",
- "parameters": {
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "savedReportId": {
- "type": "string",
- "description": "The saved report to retrieve.",
- "required": true,
- "location": "path"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
- }
- },
- "parameterOrder": [
- "savedReportId"
- ],
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- },
- "list": {
- "id": "adexchangeseller.reports.saved.list",
- "path": "reports/saved",
- "httpMethod": "GET",
- "description": "List all saved reports in this Ad Exchange account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of saved reports to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "SavedReports"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- }
- }
- },
- "urlchannels": {
- "methods": {
- "list": {
- "id": "adexchangeseller.urlchannels.list",
- "path": "adclients/{adClientId}/urlchannels",
- "httpMethod": "GET",
- "description": "List all URL channels in the specified ad client for this Ad Exchange account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list URL channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of URL channels to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "UrlChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/adexchangeseller/v1.1/adexchangeseller-gen.go b/vendor/google.golang.org/api/adexchangeseller/v1.1/adexchangeseller-gen.go
deleted file mode 100644
index 4d183b43..00000000
--- a/vendor/google.golang.org/api/adexchangeseller/v1.1/adexchangeseller-gen.go
+++ /dev/null
@@ -1,3576 +0,0 @@
-// Package adexchangeseller provides access to the Ad Exchange Seller API.
-//
-// See https://developers.google.com/ad-exchange/seller-rest/
-//
-// Usage example:
-//
-// import "google.golang.org/api/adexchangeseller/v1.1"
-// ...
-// adexchangesellerService, err := adexchangeseller.New(oauthHttpClient)
-package adexchangeseller // import "google.golang.org/api/adexchangeseller/v1.1"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "adexchangeseller:v1.1"
-const apiName = "adexchangeseller"
-const apiVersion = "v1.1"
-const basePath = "https://www.googleapis.com/adexchangeseller/v1.1/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your Ad Exchange data
- AdexchangeSellerScope = "https://www.googleapis.com/auth/adexchange.seller"
-
- // View your Ad Exchange data
- AdexchangeSellerReadonlyScope = "https://www.googleapis.com/auth/adexchange.seller.readonly"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Accounts = NewAccountsService(s)
- s.Adclients = NewAdclientsService(s)
- s.Adunits = NewAdunitsService(s)
- s.Alerts = NewAlertsService(s)
- s.Customchannels = NewCustomchannelsService(s)
- s.Metadata = NewMetadataService(s)
- s.Preferreddeals = NewPreferreddealsService(s)
- s.Reports = NewReportsService(s)
- s.Urlchannels = NewUrlchannelsService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Accounts *AccountsService
-
- Adclients *AdclientsService
-
- Adunits *AdunitsService
-
- Alerts *AlertsService
-
- Customchannels *CustomchannelsService
-
- Metadata *MetadataService
-
- Preferreddeals *PreferreddealsService
-
- Reports *ReportsService
-
- Urlchannels *UrlchannelsService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewAccountsService(s *Service) *AccountsService {
- rs := &AccountsService{s: s}
- return rs
-}
-
-type AccountsService struct {
- s *Service
-}
-
-func NewAdclientsService(s *Service) *AdclientsService {
- rs := &AdclientsService{s: s}
- return rs
-}
-
-type AdclientsService struct {
- s *Service
-}
-
-func NewAdunitsService(s *Service) *AdunitsService {
- rs := &AdunitsService{s: s}
- rs.Customchannels = NewAdunitsCustomchannelsService(s)
- return rs
-}
-
-type AdunitsService struct {
- s *Service
-
- Customchannels *AdunitsCustomchannelsService
-}
-
-func NewAdunitsCustomchannelsService(s *Service) *AdunitsCustomchannelsService {
- rs := &AdunitsCustomchannelsService{s: s}
- return rs
-}
-
-type AdunitsCustomchannelsService struct {
- s *Service
-}
-
-func NewAlertsService(s *Service) *AlertsService {
- rs := &AlertsService{s: s}
- return rs
-}
-
-type AlertsService struct {
- s *Service
-}
-
-func NewCustomchannelsService(s *Service) *CustomchannelsService {
- rs := &CustomchannelsService{s: s}
- rs.Adunits = NewCustomchannelsAdunitsService(s)
- return rs
-}
-
-type CustomchannelsService struct {
- s *Service
-
- Adunits *CustomchannelsAdunitsService
-}
-
-func NewCustomchannelsAdunitsService(s *Service) *CustomchannelsAdunitsService {
- rs := &CustomchannelsAdunitsService{s: s}
- return rs
-}
-
-type CustomchannelsAdunitsService struct {
- s *Service
-}
-
-func NewMetadataService(s *Service) *MetadataService {
- rs := &MetadataService{s: s}
- rs.Dimensions = NewMetadataDimensionsService(s)
- rs.Metrics = NewMetadataMetricsService(s)
- return rs
-}
-
-type MetadataService struct {
- s *Service
-
- Dimensions *MetadataDimensionsService
-
- Metrics *MetadataMetricsService
-}
-
-func NewMetadataDimensionsService(s *Service) *MetadataDimensionsService {
- rs := &MetadataDimensionsService{s: s}
- return rs
-}
-
-type MetadataDimensionsService struct {
- s *Service
-}
-
-func NewMetadataMetricsService(s *Service) *MetadataMetricsService {
- rs := &MetadataMetricsService{s: s}
- return rs
-}
-
-type MetadataMetricsService struct {
- s *Service
-}
-
-func NewPreferreddealsService(s *Service) *PreferreddealsService {
- rs := &PreferreddealsService{s: s}
- return rs
-}
-
-type PreferreddealsService struct {
- s *Service
-}
-
-func NewReportsService(s *Service) *ReportsService {
- rs := &ReportsService{s: s}
- rs.Saved = NewReportsSavedService(s)
- return rs
-}
-
-type ReportsService struct {
- s *Service
-
- Saved *ReportsSavedService
-}
-
-func NewReportsSavedService(s *Service) *ReportsSavedService {
- rs := &ReportsSavedService{s: s}
- return rs
-}
-
-type ReportsSavedService struct {
- s *Service
-}
-
-func NewUrlchannelsService(s *Service) *UrlchannelsService {
- rs := &UrlchannelsService{s: s}
- return rs
-}
-
-type UrlchannelsService struct {
- s *Service
-}
-
-type Account struct {
- // Id: Unique identifier of this account.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case
- // adexchangeseller#account.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this account.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Account) MarshalJSON() ([]byte, error) {
- type noMethod Account
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdClient struct {
- // ArcOptIn: Whether this ad client is opted in to ARC.
- ArcOptIn bool `json:"arcOptIn,omitempty"`
-
- // Id: Unique identifier of this ad client.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case
- // adexchangeseller#adClient.
- Kind string `json:"kind,omitempty"`
-
- // ProductCode: This ad client's product code, which corresponds to the
- // PRODUCT_CODE report dimension.
- ProductCode string `json:"productCode,omitempty"`
-
- // SupportsReporting: Whether this ad client supports being reported on.
- SupportsReporting bool `json:"supportsReporting,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ArcOptIn") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdClient) MarshalJSON() ([]byte, error) {
- type noMethod AdClient
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdClients struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The ad clients returned in this list response.
- Items []*AdClient `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adexchangeseller#adClients.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through ad clients. To
- // retrieve the next page of results, set the next request's "pageToken"
- // value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdClients) MarshalJSON() ([]byte, error) {
- type noMethod AdClients
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdUnit struct {
- // Code: Identity code of this ad unit, not necessarily unique across ad
- // clients.
- Code string `json:"code,omitempty"`
-
- // Id: Unique identifier of this ad unit. This should be considered an
- // opaque identifier; it is not safe to rely on it being in any
- // particular format.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adexchangeseller#adUnit.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this ad unit.
- Name string `json:"name,omitempty"`
-
- // Status: Status of this ad unit. Possible values are:
- // NEW: Indicates that the ad unit was created within the last seven
- // days and does not yet have any activity associated with it.
- //
- // ACTIVE: Indicates that there has been activity on this ad unit in the
- // last seven days.
- //
- // INACTIVE: Indicates that there has been no activity on this ad unit
- // in the last seven days.
- Status string `json:"status,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdUnit) MarshalJSON() ([]byte, error) {
- type noMethod AdUnit
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdUnits struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The ad units returned in this list response.
- Items []*AdUnit `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adexchangeseller#adUnits.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through ad units. To
- // retrieve the next page of results, set the next request's "pageToken"
- // value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdUnits) MarshalJSON() ([]byte, error) {
- type noMethod AdUnits
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Alert struct {
- // Id: Unique identifier of this alert. This should be considered an
- // opaque identifier; it is not safe to rely on it being in any
- // particular format.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adexchangeseller#alert.
- Kind string `json:"kind,omitempty"`
-
- // Message: The localized alert message.
- Message string `json:"message,omitempty"`
-
- // Severity: Severity of this alert. Possible values: INFO, WARNING,
- // SEVERE.
- Severity string `json:"severity,omitempty"`
-
- // Type: Type of this alert. Possible values: SELF_HOLD,
- // MIGRATED_TO_BILLING3, ADDRESS_PIN_VERIFICATION,
- // PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, GRAYLISTED_PUBLISHER,
- // API_HOLD.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Alert) MarshalJSON() ([]byte, error) {
- type noMethod Alert
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Alerts struct {
- // Items: The alerts returned in this list response.
- Items []*Alert `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adexchangeseller#alerts.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Alerts) MarshalJSON() ([]byte, error) {
- type noMethod Alerts
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CustomChannel struct {
- // Code: Code of this custom channel, not necessarily unique across ad
- // clients.
- Code string `json:"code,omitempty"`
-
- // Id: Unique identifier of this custom channel. This should be
- // considered an opaque identifier; it is not safe to rely on it being
- // in any particular format.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case
- // adexchangeseller#customChannel.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this custom channel.
- Name string `json:"name,omitempty"`
-
- // TargetingInfo: The targeting information of this custom channel, if
- // activated.
- TargetingInfo *CustomChannelTargetingInfo `json:"targetingInfo,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomChannel) MarshalJSON() ([]byte, error) {
- type noMethod CustomChannel
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CustomChannelTargetingInfo: The targeting information of this custom
-// channel, if activated.
-type CustomChannelTargetingInfo struct {
- // AdsAppearOn: The name used to describe this channel externally.
- AdsAppearOn string `json:"adsAppearOn,omitempty"`
-
- // Description: The external description of the channel.
- Description string `json:"description,omitempty"`
-
- // Location: The locations in which ads appear. (Only valid for content
- // and mobile content ads). Acceptable values for content ads are:
- // TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER,
- // MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT,
- // MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are:
- // TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
- Location string `json:"location,omitempty"`
-
- // SiteLanguage: The language of the sites ads will be displayed on.
- SiteLanguage string `json:"siteLanguage,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AdsAppearOn") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomChannelTargetingInfo) MarshalJSON() ([]byte, error) {
- type noMethod CustomChannelTargetingInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CustomChannels struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The custom channels returned in this list response.
- Items []*CustomChannel `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case
- // adexchangeseller#customChannels.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through custom
- // channels. To retrieve the next page of results, set the next
- // request's "pageToken" value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomChannels) MarshalJSON() ([]byte, error) {
- type noMethod CustomChannels
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Metadata struct {
- Items []*ReportingMetadataEntry `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adexchangeseller#metadata.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Metadata) MarshalJSON() ([]byte, error) {
- type noMethod Metadata
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type PreferredDeal struct {
- // AdvertiserName: The name of the advertiser this deal is for.
- AdvertiserName string `json:"advertiserName,omitempty"`
-
- // BuyerNetworkName: The name of the buyer network this deal is for.
- BuyerNetworkName string `json:"buyerNetworkName,omitempty"`
-
- // CurrencyCode: The currency code that applies to the fixed_cpm value.
- // If not set then assumed to be USD.
- CurrencyCode string `json:"currencyCode,omitempty"`
-
- // EndTime: Time when this deal stops being active in seconds since the
- // epoch (GMT). If not set then this deal is valid until manually
- // disabled by the publisher.
- EndTime uint64 `json:"endTime,omitempty,string"`
-
- // FixedCpm: The fixed price for this preferred deal. In cpm micros of
- // currency according to currencyCode. If set, then this preferred deal
- // is eligible for the fixed price tier of buying (highest priority, pay
- // exactly the configured fixed price).
- FixedCpm int64 `json:"fixedCpm,omitempty,string"`
-
- // Id: Unique identifier of this preferred deal.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Kind of resource this is, in this case
- // adexchangeseller#preferredDeal.
- Kind string `json:"kind,omitempty"`
-
- // StartTime: Time when this deal becomes active in seconds since the
- // epoch (GMT). If not set then this deal is active immediately upon
- // creation.
- StartTime uint64 `json:"startTime,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AdvertiserName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PreferredDeal) MarshalJSON() ([]byte, error) {
- type noMethod PreferredDeal
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type PreferredDeals struct {
- // Items: The preferred deals returned in this list response.
- Items []*PreferredDeal `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case
- // adexchangeseller#preferredDeals.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PreferredDeals) MarshalJSON() ([]byte, error) {
- type noMethod PreferredDeals
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Report struct {
- // Averages: The averages of the report. This is the same length as any
- // other row in the report; cells corresponding to dimension columns are
- // empty.
- Averages []string `json:"averages,omitempty"`
-
- // Headers: The header information of the columns requested in the
- // report. This is a list of headers; one for each dimension in the
- // request, followed by one for each metric in the request.
- Headers []*ReportHeaders `json:"headers,omitempty"`
-
- // Kind: Kind this is, in this case adexchangeseller#report.
- Kind string `json:"kind,omitempty"`
-
- // Rows: The output rows of the report. Each row is a list of cells; one
- // for each dimension in the request, followed by one for each metric in
- // the request. The dimension cells contain strings, and the metric
- // cells contain numbers.
- Rows [][]string `json:"rows,omitempty"`
-
- // TotalMatchedRows: The total number of rows matched by the report
- // request. Fewer rows may be returned in the response due to being
- // limited by the row count requested or the report row limit.
- TotalMatchedRows int64 `json:"totalMatchedRows,omitempty,string"`
-
- // Totals: The totals of the report. This is the same length as any
- // other row in the report; cells corresponding to dimension columns are
- // empty.
- Totals []string `json:"totals,omitempty"`
-
- // Warnings: Any warnings associated with generation of the report.
- Warnings []string `json:"warnings,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Averages") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Report) MarshalJSON() ([]byte, error) {
- type noMethod Report
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ReportHeaders struct {
- // Currency: The currency of this column. Only present if the header
- // type is METRIC_CURRENCY.
- Currency string `json:"currency,omitempty"`
-
- // Name: The name of the header.
- Name string `json:"name,omitempty"`
-
- // Type: The type of the header; one of DIMENSION, METRIC_TALLY,
- // METRIC_RATIO, or METRIC_CURRENCY.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Currency") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportHeaders) MarshalJSON() ([]byte, error) {
- type noMethod ReportHeaders
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ReportingMetadataEntry struct {
- // CompatibleDimensions: For metrics this is a list of dimension IDs
- // which the metric is compatible with, for dimensions it is a list of
- // compatibility groups the dimension belongs to.
- CompatibleDimensions []string `json:"compatibleDimensions,omitempty"`
-
- // CompatibleMetrics: The names of the metrics the dimension or metric
- // this reporting metadata entry describes is compatible with.
- CompatibleMetrics []string `json:"compatibleMetrics,omitempty"`
-
- // Id: Unique identifier of this reporting metadata entry, corresponding
- // to the name of the appropriate dimension or metric.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case
- // adexchangeseller#reportingMetadataEntry.
- Kind string `json:"kind,omitempty"`
-
- // RequiredDimensions: The names of the dimensions which the dimension
- // or metric this reporting metadata entry describes requires to also be
- // present in order for the report to be valid. Omitting these will not
- // cause an error or warning, but may result in data which cannot be
- // correctly interpreted.
- RequiredDimensions []string `json:"requiredDimensions,omitempty"`
-
- // RequiredMetrics: The names of the metrics which the dimension or
- // metric this reporting metadata entry describes requires to also be
- // present in order for the report to be valid. Omitting these will not
- // cause an error or warning, but may result in data which cannot be
- // correctly interpreted.
- RequiredMetrics []string `json:"requiredMetrics,omitempty"`
-
- // SupportedProducts: The codes of the projects supported by the
- // dimension or metric this reporting metadata entry describes.
- SupportedProducts []string `json:"supportedProducts,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "CompatibleDimensions") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportingMetadataEntry) MarshalJSON() ([]byte, error) {
- type noMethod ReportingMetadataEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type SavedReport struct {
- // Id: Unique identifier of this saved report.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case
- // adexchangeseller#savedReport.
- Kind string `json:"kind,omitempty"`
-
- // Name: This saved report's name.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SavedReport) MarshalJSON() ([]byte, error) {
- type noMethod SavedReport
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type SavedReports struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The saved reports returned in this list response.
- Items []*SavedReport `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case
- // adexchangeseller#savedReports.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through saved reports.
- // To retrieve the next page of results, set the next request's
- // "pageToken" value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SavedReports) MarshalJSON() ([]byte, error) {
- type noMethod SavedReports
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UrlChannel struct {
- // Id: Unique identifier of this URL channel. This should be considered
- // an opaque identifier; it is not safe to rely on it being in any
- // particular format.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case
- // adexchangeseller#urlChannel.
- Kind string `json:"kind,omitempty"`
-
- // UrlPattern: URL Pattern of this URL channel. Does not include
- // "http://" or "https://". Example: www.example.com/home
- UrlPattern string `json:"urlPattern,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlChannel) MarshalJSON() ([]byte, error) {
- type noMethod UrlChannel
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UrlChannels struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The URL channels returned in this list response.
- Items []*UrlChannel `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case
- // adexchangeseller#urlChannels.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through URL channels.
- // To retrieve the next page of results, set the next request's
- // "pageToken" value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlChannels) MarshalJSON() ([]byte, error) {
- type noMethod UrlChannels
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "adexchangeseller.accounts.get":
-
-type AccountsGetCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get information about the selected Ad Exchange account.
-func (r *AccountsService) Get(accountId string) *AccountsGetCall {
- c := &AccountsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsGetCall) Fields(s ...googleapi.Field) *AccountsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsGetCall) IfNoneMatch(entityTag string) *AccountsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsGetCall) Context(ctx context.Context) *AccountsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.accounts.get" call.
-// Exactly one of *Account or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Account.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsGetCall) Do() (*Account, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Account{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get information about the selected Ad Exchange account.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.accounts.get",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to get information about. Tip: 'myaccount' is a valid ID.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}",
- // "response": {
- // "$ref": "Account"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.adclients.list":
-
-type AdclientsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all ad clients in this Ad Exchange account.
-func (r *AdclientsService) List() *AdclientsListCall {
- c := &AdclientsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of ad clients to include in the response, used for paging.
-func (c *AdclientsListCall) MaxResults(maxResults int64) *AdclientsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad clients. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AdclientsListCall) PageToken(pageToken string) *AdclientsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdclientsListCall) Fields(s ...googleapi.Field) *AdclientsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdclientsListCall) IfNoneMatch(entityTag string) *AdclientsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdclientsListCall) Context(ctx context.Context) *AdclientsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdclientsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.adclients.list" call.
-// Exactly one of *AdClients or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AdClients.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AdclientsListCall) Do() (*AdClients, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdClients{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all ad clients in this Ad Exchange account.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.adclients.list",
- // "parameters": {
- // "maxResults": {
- // "description": "The maximum number of ad clients to include in the response, used for paging.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients",
- // "response": {
- // "$ref": "AdClients"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.adunits.get":
-
-type AdunitsGetCall struct {
- s *Service
- adClientId string
- adUnitId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets the specified ad unit in the specified ad client.
-func (r *AdunitsService) Get(adClientId string, adUnitId string) *AdunitsGetCall {
- c := &AdunitsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.adUnitId = adUnitId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdunitsGetCall) Fields(s ...googleapi.Field) *AdunitsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdunitsGetCall) IfNoneMatch(entityTag string) *AdunitsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdunitsGetCall) Context(ctx context.Context) *AdunitsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdunitsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/adunits/{adUnitId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- "adUnitId": c.adUnitId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.adunits.get" call.
-// Exactly one of *AdUnit or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnit.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AdunitsGetCall) Do() (*AdUnit, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnit{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the specified ad unit in the specified ad client.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.adunits.get",
- // "parameterOrder": [
- // "adClientId",
- // "adUnitId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client for which to get the ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adUnitId": {
- // "description": "Ad unit to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/adunits/{adUnitId}",
- // "response": {
- // "$ref": "AdUnit"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.adunits.list":
-
-type AdunitsListCall struct {
- s *Service
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all ad units in the specified ad client for this Ad
-// Exchange account.
-func (r *AdunitsService) List(adClientId string) *AdunitsListCall {
- c := &AdunitsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- return c
-}
-
-// IncludeInactive sets the optional parameter "includeInactive":
-// Whether to include inactive ad units. Default: true.
-func (c *AdunitsListCall) IncludeInactive(includeInactive bool) *AdunitsListCall {
- c.opt_["includeInactive"] = includeInactive
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of ad units to include in the response, used for paging.
-func (c *AdunitsListCall) MaxResults(maxResults int64) *AdunitsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad units. To retrieve the next page, set
-// this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AdunitsListCall) PageToken(pageToken string) *AdunitsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdunitsListCall) Fields(s ...googleapi.Field) *AdunitsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdunitsListCall) IfNoneMatch(entityTag string) *AdunitsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdunitsListCall) Context(ctx context.Context) *AdunitsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdunitsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["includeInactive"]; ok {
- params.Set("includeInactive", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/adunits")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.adunits.list" call.
-// Exactly one of *AdUnits or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnits.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AdunitsListCall) Do() (*AdUnits, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnits{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all ad units in the specified ad client for this Ad Exchange account.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.adunits.list",
- // "parameterOrder": [
- // "adClientId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client for which to list ad units.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "includeInactive": {
- // "description": "Whether to include inactive ad units. Default: true.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "The maximum number of ad units to include in the response, used for paging.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/adunits",
- // "response": {
- // "$ref": "AdUnits"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.adunits.customchannels.list":
-
-type AdunitsCustomchannelsListCall struct {
- s *Service
- adClientId string
- adUnitId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all custom channels which the specified ad unit belongs
-// to.
-func (r *AdunitsCustomchannelsService) List(adClientId string, adUnitId string) *AdunitsCustomchannelsListCall {
- c := &AdunitsCustomchannelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.adUnitId = adUnitId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of custom channels to include in the response, used for
-// paging.
-func (c *AdunitsCustomchannelsListCall) MaxResults(maxResults int64) *AdunitsCustomchannelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through custom channels. To retrieve the next
-// page, set this parameter to the value of "nextPageToken" from the
-// previous response.
-func (c *AdunitsCustomchannelsListCall) PageToken(pageToken string) *AdunitsCustomchannelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdunitsCustomchannelsListCall) Fields(s ...googleapi.Field) *AdunitsCustomchannelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdunitsCustomchannelsListCall) IfNoneMatch(entityTag string) *AdunitsCustomchannelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdunitsCustomchannelsListCall) Context(ctx context.Context) *AdunitsCustomchannelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdunitsCustomchannelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/adunits/{adUnitId}/customchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- "adUnitId": c.adUnitId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.adunits.customchannels.list" call.
-// Exactly one of *CustomChannels or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannels.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AdunitsCustomchannelsListCall) Do() (*CustomChannels, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannels{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all custom channels which the specified ad unit belongs to.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.adunits.customchannels.list",
- // "parameterOrder": [
- // "adClientId",
- // "adUnitId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client which contains the ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adUnitId": {
- // "description": "Ad unit for which to list custom channels.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of custom channels to include in the response, used for paging.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/adunits/{adUnitId}/customchannels",
- // "response": {
- // "$ref": "CustomChannels"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.alerts.list":
-
-type AlertsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List the alerts for this Ad Exchange account.
-func (r *AlertsService) List() *AlertsListCall {
- c := &AlertsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Locale sets the optional parameter "locale": The locale to use for
-// translating alert messages. The account locale will be used if this
-// is not supplied. The AdSense default (English) will be used if the
-// supplied locale is invalid or unsupported.
-func (c *AlertsListCall) Locale(locale string) *AlertsListCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AlertsListCall) Fields(s ...googleapi.Field) *AlertsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AlertsListCall) IfNoneMatch(entityTag string) *AlertsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AlertsListCall) Context(ctx context.Context) *AlertsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AlertsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "alerts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.alerts.list" call.
-// Exactly one of *Alerts or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Alerts.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AlertsListCall) Do() (*Alerts, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Alerts{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List the alerts for this Ad Exchange account.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.alerts.list",
- // "parameters": {
- // "locale": {
- // "description": "The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "alerts",
- // "response": {
- // "$ref": "Alerts"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.customchannels.get":
-
-type CustomchannelsGetCall struct {
- s *Service
- adClientId string
- customChannelId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get the specified custom channel from the specified ad client.
-func (r *CustomchannelsService) Get(adClientId string, customChannelId string) *CustomchannelsGetCall {
- c := &CustomchannelsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.customChannelId = customChannelId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CustomchannelsGetCall) Fields(s ...googleapi.Field) *CustomchannelsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CustomchannelsGetCall) IfNoneMatch(entityTag string) *CustomchannelsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CustomchannelsGetCall) Context(ctx context.Context) *CustomchannelsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CustomchannelsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/customchannels/{customChannelId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- "customChannelId": c.customChannelId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.customchannels.get" call.
-// Exactly one of *CustomChannel or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannel.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CustomchannelsGetCall) Do() (*CustomChannel, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannel{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get the specified custom channel from the specified ad client.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.customchannels.get",
- // "parameterOrder": [
- // "adClientId",
- // "customChannelId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client which contains the custom channel.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "customChannelId": {
- // "description": "Custom channel to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/customchannels/{customChannelId}",
- // "response": {
- // "$ref": "CustomChannel"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.customchannels.list":
-
-type CustomchannelsListCall struct {
- s *Service
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all custom channels in the specified ad client for this Ad
-// Exchange account.
-func (r *CustomchannelsService) List(adClientId string) *CustomchannelsListCall {
- c := &CustomchannelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of custom channels to include in the response, used for
-// paging.
-func (c *CustomchannelsListCall) MaxResults(maxResults int64) *CustomchannelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through custom channels. To retrieve the next
-// page, set this parameter to the value of "nextPageToken" from the
-// previous response.
-func (c *CustomchannelsListCall) PageToken(pageToken string) *CustomchannelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CustomchannelsListCall) Fields(s ...googleapi.Field) *CustomchannelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CustomchannelsListCall) IfNoneMatch(entityTag string) *CustomchannelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CustomchannelsListCall) Context(ctx context.Context) *CustomchannelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CustomchannelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/customchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.customchannels.list" call.
-// Exactly one of *CustomChannels or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannels.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CustomchannelsListCall) Do() (*CustomChannels, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannels{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all custom channels in the specified ad client for this Ad Exchange account.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.customchannels.list",
- // "parameterOrder": [
- // "adClientId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client for which to list custom channels.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of custom channels to include in the response, used for paging.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/customchannels",
- // "response": {
- // "$ref": "CustomChannels"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.customchannels.adunits.list":
-
-type CustomchannelsAdunitsListCall struct {
- s *Service
- adClientId string
- customChannelId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all ad units in the specified custom channel.
-func (r *CustomchannelsAdunitsService) List(adClientId string, customChannelId string) *CustomchannelsAdunitsListCall {
- c := &CustomchannelsAdunitsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.customChannelId = customChannelId
- return c
-}
-
-// IncludeInactive sets the optional parameter "includeInactive":
-// Whether to include inactive ad units. Default: true.
-func (c *CustomchannelsAdunitsListCall) IncludeInactive(includeInactive bool) *CustomchannelsAdunitsListCall {
- c.opt_["includeInactive"] = includeInactive
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of ad units to include in the response, used for paging.
-func (c *CustomchannelsAdunitsListCall) MaxResults(maxResults int64) *CustomchannelsAdunitsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad units. To retrieve the next page, set
-// this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *CustomchannelsAdunitsListCall) PageToken(pageToken string) *CustomchannelsAdunitsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CustomchannelsAdunitsListCall) Fields(s ...googleapi.Field) *CustomchannelsAdunitsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CustomchannelsAdunitsListCall) IfNoneMatch(entityTag string) *CustomchannelsAdunitsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CustomchannelsAdunitsListCall) Context(ctx context.Context) *CustomchannelsAdunitsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CustomchannelsAdunitsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["includeInactive"]; ok {
- params.Set("includeInactive", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/customchannels/{customChannelId}/adunits")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- "customChannelId": c.customChannelId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.customchannels.adunits.list" call.
-// Exactly one of *AdUnits or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnits.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *CustomchannelsAdunitsListCall) Do() (*AdUnits, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnits{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all ad units in the specified custom channel.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.customchannels.adunits.list",
- // "parameterOrder": [
- // "adClientId",
- // "customChannelId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client which contains the custom channel.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "customChannelId": {
- // "description": "Custom channel for which to list ad units.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "includeInactive": {
- // "description": "Whether to include inactive ad units. Default: true.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "The maximum number of ad units to include in the response, used for paging.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/customchannels/{customChannelId}/adunits",
- // "response": {
- // "$ref": "AdUnits"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.metadata.dimensions.list":
-
-type MetadataDimensionsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List the metadata for the dimensions available to this
-// AdExchange account.
-func (r *MetadataDimensionsService) List() *MetadataDimensionsListCall {
- c := &MetadataDimensionsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MetadataDimensionsListCall) Fields(s ...googleapi.Field) *MetadataDimensionsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MetadataDimensionsListCall) IfNoneMatch(entityTag string) *MetadataDimensionsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MetadataDimensionsListCall) Context(ctx context.Context) *MetadataDimensionsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MetadataDimensionsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "metadata/dimensions")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.metadata.dimensions.list" call.
-// Exactly one of *Metadata or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Metadata.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *MetadataDimensionsListCall) Do() (*Metadata, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Metadata{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List the metadata for the dimensions available to this AdExchange account.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.metadata.dimensions.list",
- // "path": "metadata/dimensions",
- // "response": {
- // "$ref": "Metadata"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.metadata.metrics.list":
-
-type MetadataMetricsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List the metadata for the metrics available to this AdExchange
-// account.
-func (r *MetadataMetricsService) List() *MetadataMetricsListCall {
- c := &MetadataMetricsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MetadataMetricsListCall) Fields(s ...googleapi.Field) *MetadataMetricsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MetadataMetricsListCall) IfNoneMatch(entityTag string) *MetadataMetricsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MetadataMetricsListCall) Context(ctx context.Context) *MetadataMetricsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MetadataMetricsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "metadata/metrics")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.metadata.metrics.list" call.
-// Exactly one of *Metadata or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Metadata.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *MetadataMetricsListCall) Do() (*Metadata, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Metadata{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List the metadata for the metrics available to this AdExchange account.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.metadata.metrics.list",
- // "path": "metadata/metrics",
- // "response": {
- // "$ref": "Metadata"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.preferreddeals.get":
-
-type PreferreddealsGetCall struct {
- s *Service
- dealId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get information about the selected Ad Exchange Preferred Deal.
-func (r *PreferreddealsService) Get(dealId string) *PreferreddealsGetCall {
- c := &PreferreddealsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.dealId = dealId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PreferreddealsGetCall) Fields(s ...googleapi.Field) *PreferreddealsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PreferreddealsGetCall) IfNoneMatch(entityTag string) *PreferreddealsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PreferreddealsGetCall) Context(ctx context.Context) *PreferreddealsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PreferreddealsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "preferreddeals/{dealId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "dealId": c.dealId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.preferreddeals.get" call.
-// Exactly one of *PreferredDeal or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *PreferredDeal.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PreferreddealsGetCall) Do() (*PreferredDeal, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PreferredDeal{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get information about the selected Ad Exchange Preferred Deal.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.preferreddeals.get",
- // "parameterOrder": [
- // "dealId"
- // ],
- // "parameters": {
- // "dealId": {
- // "description": "Preferred deal to get information about.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "preferreddeals/{dealId}",
- // "response": {
- // "$ref": "PreferredDeal"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.preferreddeals.list":
-
-type PreferreddealsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List the preferred deals for this Ad Exchange account.
-func (r *PreferreddealsService) List() *PreferreddealsListCall {
- c := &PreferreddealsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PreferreddealsListCall) Fields(s ...googleapi.Field) *PreferreddealsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PreferreddealsListCall) IfNoneMatch(entityTag string) *PreferreddealsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PreferreddealsListCall) Context(ctx context.Context) *PreferreddealsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PreferreddealsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "preferreddeals")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.preferreddeals.list" call.
-// Exactly one of *PreferredDeals or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *PreferredDeals.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PreferreddealsListCall) Do() (*PreferredDeals, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PreferredDeals{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List the preferred deals for this Ad Exchange account.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.preferreddeals.list",
- // "path": "preferreddeals",
- // "response": {
- // "$ref": "PreferredDeals"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.reports.generate":
-
-type ReportsGenerateCall struct {
- s *Service
- startDate string
- endDate string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Generate: Generate an Ad Exchange report based on the report request
-// sent in the query parameters. Returns the result as JSON; to retrieve
-// output in CSV format specify "alt=csv" as a query parameter.
-func (r *ReportsService) Generate(startDate string, endDate string) *ReportsGenerateCall {
- c := &ReportsGenerateCall{s: r.s, opt_: make(map[string]interface{})}
- c.startDate = startDate
- c.endDate = endDate
- return c
-}
-
-// Dimension sets the optional parameter "dimension": Dimensions to base
-// the report on.
-func (c *ReportsGenerateCall) Dimension(dimension string) *ReportsGenerateCall {
- c.opt_["dimension"] = dimension
- return c
-}
-
-// Filter sets the optional parameter "filter": Filters to be run on the
-// report.
-func (c *ReportsGenerateCall) Filter(filter string) *ReportsGenerateCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// Locale sets the optional parameter "locale": Optional locale to use
-// for translating report output to a local language. Defaults to
-// "en_US" if not specified.
-func (c *ReportsGenerateCall) Locale(locale string) *ReportsGenerateCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of rows of report data to return.
-func (c *ReportsGenerateCall) MaxResults(maxResults int64) *ReportsGenerateCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// Metric sets the optional parameter "metric": Numeric columns to
-// include in the report.
-func (c *ReportsGenerateCall) Metric(metric string) *ReportsGenerateCall {
- c.opt_["metric"] = metric
- return c
-}
-
-// Sort sets the optional parameter "sort": The name of a dimension or
-// metric to sort the resulting report on, optionally prefixed with "+"
-// to sort ascending or "-" to sort descending. If no prefix is
-// specified, the column is sorted ascending.
-func (c *ReportsGenerateCall) Sort(sort string) *ReportsGenerateCall {
- c.opt_["sort"] = sort
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex": Index of the
-// first row of report data to return.
-func (c *ReportsGenerateCall) StartIndex(startIndex int64) *ReportsGenerateCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsGenerateCall) Fields(s ...googleapi.Field) *ReportsGenerateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsGenerateCall) IfNoneMatch(entityTag string) *ReportsGenerateCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do and Download methods.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsGenerateCall) Context(ctx context.Context) *ReportsGenerateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsGenerateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("endDate", fmt.Sprintf("%v", c.endDate))
- params.Set("startDate", fmt.Sprintf("%v", c.startDate))
- if v, ok := c.opt_["dimension"]; ok {
- params.Set("dimension", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["metric"]; ok {
- params.Set("metric", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sort"]; ok {
- params.Set("sort", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "reports")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Download fetches the API endpoint's "media" value, instead of the normal
-// API response value. If the returned error is nil, the Response is guaranteed to
-// have a 2xx status code. Callers must close the Response.Body as usual.
-func (c *ReportsGenerateCall) Download() (*http.Response, error) {
- res, err := c.doRequest("media")
- if err != nil {
- return nil, err
- }
- if err := googleapi.CheckMediaResponse(res); err != nil {
- res.Body.Close()
- return nil, err
- }
- return res, nil
-}
-
-// Do executes the "adexchangeseller.reports.generate" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsGenerateCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Generate an Ad Exchange report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.reports.generate",
- // "parameterOrder": [
- // "startDate",
- // "endDate"
- // ],
- // "parameters": {
- // "dimension": {
- // "description": "Dimensions to base the report on.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "endDate": {
- // "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- // "location": "query",
- // "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- // "required": true,
- // "type": "string"
- // },
- // "filter": {
- // "description": "Filters to be run on the report.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+(==|=@).+",
- // "repeated": true,
- // "type": "string"
- // },
- // "locale": {
- // "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of rows of report data to return.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "50000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "metric": {
- // "description": "Numeric columns to include in the report.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "sort": {
- // "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
- // "location": "query",
- // "pattern": "(\\+|-)?[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "startDate": {
- // "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- // "location": "query",
- // "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- // "required": true,
- // "type": "string"
- // },
- // "startIndex": {
- // "description": "Index of the first row of report data to return.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "5000",
- // "minimum": "0",
- // "type": "integer"
- // }
- // },
- // "path": "reports",
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ],
- // "supportsMediaDownload": true
- // }
-
-}
-
-// method id "adexchangeseller.reports.saved.generate":
-
-type ReportsSavedGenerateCall struct {
- s *Service
- savedReportId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Generate: Generate an Ad Exchange report based on the saved report ID
-// sent in the query parameters.
-func (r *ReportsSavedService) Generate(savedReportId string) *ReportsSavedGenerateCall {
- c := &ReportsSavedGenerateCall{s: r.s, opt_: make(map[string]interface{})}
- c.savedReportId = savedReportId
- return c
-}
-
-// Locale sets the optional parameter "locale": Optional locale to use
-// for translating report output to a local language. Defaults to
-// "en_US" if not specified.
-func (c *ReportsSavedGenerateCall) Locale(locale string) *ReportsSavedGenerateCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of rows of report data to return.
-func (c *ReportsSavedGenerateCall) MaxResults(maxResults int64) *ReportsSavedGenerateCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex": Index of the
-// first row of report data to return.
-func (c *ReportsSavedGenerateCall) StartIndex(startIndex int64) *ReportsSavedGenerateCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsSavedGenerateCall) Fields(s ...googleapi.Field) *ReportsSavedGenerateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsSavedGenerateCall) IfNoneMatch(entityTag string) *ReportsSavedGenerateCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsSavedGenerateCall) Context(ctx context.Context) *ReportsSavedGenerateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsSavedGenerateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "reports/{savedReportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "savedReportId": c.savedReportId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.reports.saved.generate" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsSavedGenerateCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Generate an Ad Exchange report based on the saved report ID sent in the query parameters.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.reports.saved.generate",
- // "parameterOrder": [
- // "savedReportId"
- // ],
- // "parameters": {
- // "locale": {
- // "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of rows of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "50000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "savedReportId": {
- // "description": "The saved report to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "startIndex": {
- // "description": "Index of the first row of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "5000",
- // "minimum": "0",
- // "type": "integer"
- // }
- // },
- // "path": "reports/{savedReportId}",
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.reports.saved.list":
-
-type ReportsSavedListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all saved reports in this Ad Exchange account.
-func (r *ReportsSavedService) List() *ReportsSavedListCall {
- c := &ReportsSavedListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of saved reports to include in the response, used for paging.
-func (c *ReportsSavedListCall) MaxResults(maxResults int64) *ReportsSavedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through saved reports. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *ReportsSavedListCall) PageToken(pageToken string) *ReportsSavedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsSavedListCall) Fields(s ...googleapi.Field) *ReportsSavedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsSavedListCall) IfNoneMatch(entityTag string) *ReportsSavedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsSavedListCall) Context(ctx context.Context) *ReportsSavedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsSavedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "reports/saved")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.reports.saved.list" call.
-// Exactly one of *SavedReports or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *SavedReports.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ReportsSavedListCall) Do() (*SavedReports, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SavedReports{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all saved reports in this Ad Exchange account.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.reports.saved.list",
- // "parameters": {
- // "maxResults": {
- // "description": "The maximum number of saved reports to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "100",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "reports/saved",
- // "response": {
- // "$ref": "SavedReports"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.urlchannels.list":
-
-type UrlchannelsListCall struct {
- s *Service
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all URL channels in the specified ad client for this Ad
-// Exchange account.
-func (r *UrlchannelsService) List(adClientId string) *UrlchannelsListCall {
- c := &UrlchannelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of URL channels to include in the response, used for paging.
-func (c *UrlchannelsListCall) MaxResults(maxResults int64) *UrlchannelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through URL channels. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *UrlchannelsListCall) PageToken(pageToken string) *UrlchannelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UrlchannelsListCall) Fields(s ...googleapi.Field) *UrlchannelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UrlchannelsListCall) IfNoneMatch(entityTag string) *UrlchannelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UrlchannelsListCall) Context(ctx context.Context) *UrlchannelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UrlchannelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/urlchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.urlchannels.list" call.
-// Exactly one of *UrlChannels or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UrlChannels.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UrlchannelsListCall) Do() (*UrlChannels, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UrlChannels{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all URL channels in the specified ad client for this Ad Exchange account.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.urlchannels.list",
- // "parameterOrder": [
- // "adClientId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client for which to list URL channels.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of URL channels to include in the response, used for paging.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/urlchannels",
- // "response": {
- // "$ref": "UrlChannels"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/adexchangeseller/v1/adexchangeseller-api.json b/vendor/google.golang.org/api/adexchangeseller/v1/adexchangeseller-api.json
deleted file mode 100644
index a6770b25..00000000
--- a/vendor/google.golang.org/api/adexchangeseller/v1/adexchangeseller-api.json
+++ /dev/null
@@ -1,918 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/kgKc4O1bceVftsMmf3p1OXF57gg\"",
- "discoveryVersion": "v1",
- "id": "adexchangeseller:v1",
- "name": "adexchangeseller",
- "canonicalName": "Ad Exchange Seller",
- "version": "v1",
- "revision": "20141112",
- "title": "Ad Exchange Seller API",
- "description": "Gives Ad Exchange seller users access to their inventory and the ability to generate reports",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/ad-exchange/seller-rest/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/adexchangeseller/v1/",
- "basePath": "/adexchangeseller/v1/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "adexchangeseller/v1/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "csv",
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of text/csv",
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/adexchange.seller": {
- "description": "View and manage your Ad Exchange data"
- },
- "https://www.googleapis.com/auth/adexchange.seller.readonly": {
- "description": "View your Ad Exchange data"
- }
- }
- }
- },
- "schemas": {
- "AdClient": {
- "id": "AdClient",
- "type": "object",
- "properties": {
- "arcOptIn": {
- "type": "boolean",
- "description": "Whether this ad client is opted in to ARC."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this ad client."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#adClient.",
- "default": "adexchangeseller#adClient"
- },
- "productCode": {
- "type": "string",
- "description": "This ad client's product code, which corresponds to the PRODUCT_CODE report dimension."
- },
- "supportsReporting": {
- "type": "boolean",
- "description": "Whether this ad client supports being reported on."
- }
- }
- },
- "AdClients": {
- "id": "AdClients",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The ad clients returned in this list response.",
- "items": {
- "$ref": "AdClient"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#adClients.",
- "default": "adexchangeseller#adClients"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "AdUnit": {
- "id": "AdUnit",
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "Identity code of this ad unit, not necessarily unique across ad clients."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#adUnit.",
- "default": "adexchangeseller#adUnit"
- },
- "name": {
- "type": "string",
- "description": "Name of this ad unit."
- },
- "status": {
- "type": "string",
- "description": "Status of this ad unit. Possible values are:\nNEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.\n\nACTIVE: Indicates that there has been activity on this ad unit in the last seven days.\n\nINACTIVE: Indicates that there has been no activity on this ad unit in the last seven days."
- }
- }
- },
- "AdUnits": {
- "id": "AdUnits",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The ad units returned in this list response.",
- "items": {
- "$ref": "AdUnit"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#adUnits.",
- "default": "adexchangeseller#adUnits"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through ad units. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "CustomChannel": {
- "id": "CustomChannel",
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "Code of this custom channel, not necessarily unique across ad clients."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#customChannel.",
- "default": "adexchangeseller#customChannel"
- },
- "name": {
- "type": "string",
- "description": "Name of this custom channel."
- },
- "targetingInfo": {
- "type": "object",
- "description": "The targeting information of this custom channel, if activated.",
- "properties": {
- "adsAppearOn": {
- "type": "string",
- "description": "The name used to describe this channel externally."
- },
- "description": {
- "type": "string",
- "description": "The external description of the channel."
- },
- "location": {
- "type": "string",
- "description": "The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS."
- },
- "siteLanguage": {
- "type": "string",
- "description": "The language of the sites ads will be displayed on."
- }
- }
- }
- }
- },
- "CustomChannels": {
- "id": "CustomChannels",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The custom channels returned in this list response.",
- "items": {
- "$ref": "CustomChannel"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#customChannels.",
- "default": "adexchangeseller#customChannels"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "Report": {
- "id": "Report",
- "type": "object",
- "properties": {
- "averages": {
- "type": "array",
- "description": "The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
- "items": {
- "type": "string"
- }
- },
- "headers": {
- "type": "array",
- "description": "The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.",
- "items": {
- "type": "object",
- "properties": {
- "currency": {
- "type": "string",
- "description": "The currency of this column. Only present if the header type is METRIC_CURRENCY."
- },
- "name": {
- "type": "string",
- "description": "The name of the header."
- },
- "type": {
- "type": "string",
- "description": "The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY."
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind this is, in this case adexchangeseller#report.",
- "default": "adexchangeseller#report"
- },
- "rows": {
- "type": "array",
- "description": "The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.",
- "items": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "totalMatchedRows": {
- "type": "string",
- "description": "The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.",
- "format": "int64"
- },
- "totals": {
- "type": "array",
- "description": "The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
- "items": {
- "type": "string"
- }
- },
- "warnings": {
- "type": "array",
- "description": "Any warnings associated with generation of the report.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "SavedReport": {
- "id": "SavedReport",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this saved report."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#savedReport.",
- "default": "adexchangeseller#savedReport"
- },
- "name": {
- "type": "string",
- "description": "This saved report's name."
- }
- }
- },
- "SavedReports": {
- "id": "SavedReports",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The saved reports returned in this list response.",
- "items": {
- "$ref": "SavedReport"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#savedReports.",
- "default": "adexchangeseller#savedReports"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "UrlChannel": {
- "id": "UrlChannel",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#urlChannel.",
- "default": "adexchangeseller#urlChannel"
- },
- "urlPattern": {
- "type": "string",
- "description": "URL Pattern of this URL channel. Does not include \"http://\" or \"https://\". Example: www.example.com/home"
- }
- }
- },
- "UrlChannels": {
- "id": "UrlChannels",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The URL channels returned in this list response.",
- "items": {
- "$ref": "UrlChannel"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#urlChannels.",
- "default": "adexchangeseller#urlChannels"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- }
- },
- "resources": {
- "adclients": {
- "methods": {
- "list": {
- "id": "adexchangeseller.adclients.list",
- "path": "adclients",
- "httpMethod": "GET",
- "description": "List all ad clients in this Ad Exchange account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad clients to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "AdClients"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- },
- "adunits": {
- "methods": {
- "get": {
- "id": "adexchangeseller.adunits.get",
- "path": "adclients/{adClientId}/adunits/{adUnitId}",
- "httpMethod": "GET",
- "description": "Gets the specified ad unit in the specified ad client.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to get the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "AdUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- },
- "list": {
- "id": "adexchangeseller.adunits.list",
- "path": "adclients/{adClientId}/adunits",
- "httpMethod": "GET",
- "description": "List all ad units in the specified ad client for this Ad Exchange account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list ad units.",
- "required": true,
- "location": "path"
- },
- "includeInactive": {
- "type": "boolean",
- "description": "Whether to include inactive ad units. Default: true.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad units to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "AdUnits"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- },
- "resources": {
- "customchannels": {
- "methods": {
- "list": {
- "id": "adexchangeseller.adunits.customchannels.list",
- "path": "adclients/{adClientId}/adunits/{adUnitId}/customchannels",
- "httpMethod": "GET",
- "description": "List all custom channels which the specified ad unit belongs to.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit for which to list custom channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- }
- }
- },
- "customchannels": {
- "methods": {
- "get": {
- "id": "adexchangeseller.customchannels.get",
- "path": "adclients/{adClientId}/customchannels/{customChannelId}",
- "httpMethod": "GET",
- "description": "Get the specified custom channel from the specified ad client.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the custom channel.",
- "required": true,
- "location": "path"
- },
- "customChannelId": {
- "type": "string",
- "description": "Custom channel to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "CustomChannel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- },
- "list": {
- "id": "adexchangeseller.customchannels.list",
- "path": "adclients/{adClientId}/customchannels",
- "httpMethod": "GET",
- "description": "List all custom channels in the specified ad client for this Ad Exchange account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list custom channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- },
- "resources": {
- "adunits": {
- "methods": {
- "list": {
- "id": "adexchangeseller.customchannels.adunits.list",
- "path": "adclients/{adClientId}/customchannels/{customChannelId}/adunits",
- "httpMethod": "GET",
- "description": "List all ad units in the specified custom channel.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the custom channel.",
- "required": true,
- "location": "path"
- },
- "customChannelId": {
- "type": "string",
- "description": "Custom channel for which to list ad units.",
- "required": true,
- "location": "path"
- },
- "includeInactive": {
- "type": "boolean",
- "description": "Whether to include inactive ad units. Default: true.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad units to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "AdUnits"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- }
- }
- },
- "reports": {
- "methods": {
- "generate": {
- "id": "adexchangeseller.reports.generate",
- "path": "reports",
- "httpMethod": "GET",
- "description": "Generate an Ad Exchange report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
- "parameters": {
- "dimension": {
- "type": "string",
- "description": "Dimensions to base the report on.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "endDate": {
- "type": "string",
- "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "Filters to be run on the report.",
- "pattern": "[a-zA-Z_]+(==|=@).+",
- "repeated": true,
- "location": "query"
- },
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "metric": {
- "type": "string",
- "description": "Numeric columns to include in the report.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "sort": {
- "type": "string",
- "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
- "pattern": "(\\+|-)?[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "startDate": {
- "type": "string",
- "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
- }
- },
- "parameterOrder": [
- "startDate",
- "endDate"
- ],
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ],
- "supportsMediaDownload": true
- }
- },
- "resources": {
- "saved": {
- "methods": {
- "generate": {
- "id": "adexchangeseller.reports.saved.generate",
- "path": "reports/{savedReportId}",
- "httpMethod": "GET",
- "description": "Generate an Ad Exchange report based on the saved report ID sent in the query parameters.",
- "parameters": {
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "savedReportId": {
- "type": "string",
- "description": "The saved report to retrieve.",
- "required": true,
- "location": "path"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
- }
- },
- "parameterOrder": [
- "savedReportId"
- ],
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- },
- "list": {
- "id": "adexchangeseller.reports.saved.list",
- "path": "reports/saved",
- "httpMethod": "GET",
- "description": "List all saved reports in this Ad Exchange account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of saved reports to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "SavedReports"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- }
- }
- },
- "urlchannels": {
- "methods": {
- "list": {
- "id": "adexchangeseller.urlchannels.list",
- "path": "adclients/{adClientId}/urlchannels",
- "httpMethod": "GET",
- "description": "List all URL channels in the specified ad client for this Ad Exchange account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list URL channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of URL channels to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "UrlChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/adexchangeseller/v1/adexchangeseller-gen.go b/vendor/google.golang.org/api/adexchangeseller/v1/adexchangeseller-gen.go
deleted file mode 100644
index cc2e32e2..00000000
--- a/vendor/google.golang.org/api/adexchangeseller/v1/adexchangeseller-gen.go
+++ /dev/null
@@ -1,2531 +0,0 @@
-// Package adexchangeseller provides access to the Ad Exchange Seller API.
-//
-// See https://developers.google.com/ad-exchange/seller-rest/
-//
-// Usage example:
-//
-// import "google.golang.org/api/adexchangeseller/v1"
-// ...
-// adexchangesellerService, err := adexchangeseller.New(oauthHttpClient)
-package adexchangeseller // import "google.golang.org/api/adexchangeseller/v1"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "adexchangeseller:v1"
-const apiName = "adexchangeseller"
-const apiVersion = "v1"
-const basePath = "https://www.googleapis.com/adexchangeseller/v1/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your Ad Exchange data
- AdexchangeSellerScope = "https://www.googleapis.com/auth/adexchange.seller"
-
- // View your Ad Exchange data
- AdexchangeSellerReadonlyScope = "https://www.googleapis.com/auth/adexchange.seller.readonly"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Adclients = NewAdclientsService(s)
- s.Adunits = NewAdunitsService(s)
- s.Customchannels = NewCustomchannelsService(s)
- s.Reports = NewReportsService(s)
- s.Urlchannels = NewUrlchannelsService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Adclients *AdclientsService
-
- Adunits *AdunitsService
-
- Customchannels *CustomchannelsService
-
- Reports *ReportsService
-
- Urlchannels *UrlchannelsService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewAdclientsService(s *Service) *AdclientsService {
- rs := &AdclientsService{s: s}
- return rs
-}
-
-type AdclientsService struct {
- s *Service
-}
-
-func NewAdunitsService(s *Service) *AdunitsService {
- rs := &AdunitsService{s: s}
- rs.Customchannels = NewAdunitsCustomchannelsService(s)
- return rs
-}
-
-type AdunitsService struct {
- s *Service
-
- Customchannels *AdunitsCustomchannelsService
-}
-
-func NewAdunitsCustomchannelsService(s *Service) *AdunitsCustomchannelsService {
- rs := &AdunitsCustomchannelsService{s: s}
- return rs
-}
-
-type AdunitsCustomchannelsService struct {
- s *Service
-}
-
-func NewCustomchannelsService(s *Service) *CustomchannelsService {
- rs := &CustomchannelsService{s: s}
- rs.Adunits = NewCustomchannelsAdunitsService(s)
- return rs
-}
-
-type CustomchannelsService struct {
- s *Service
-
- Adunits *CustomchannelsAdunitsService
-}
-
-func NewCustomchannelsAdunitsService(s *Service) *CustomchannelsAdunitsService {
- rs := &CustomchannelsAdunitsService{s: s}
- return rs
-}
-
-type CustomchannelsAdunitsService struct {
- s *Service
-}
-
-func NewReportsService(s *Service) *ReportsService {
- rs := &ReportsService{s: s}
- rs.Saved = NewReportsSavedService(s)
- return rs
-}
-
-type ReportsService struct {
- s *Service
-
- Saved *ReportsSavedService
-}
-
-func NewReportsSavedService(s *Service) *ReportsSavedService {
- rs := &ReportsSavedService{s: s}
- return rs
-}
-
-type ReportsSavedService struct {
- s *Service
-}
-
-func NewUrlchannelsService(s *Service) *UrlchannelsService {
- rs := &UrlchannelsService{s: s}
- return rs
-}
-
-type UrlchannelsService struct {
- s *Service
-}
-
-type AdClient struct {
- // ArcOptIn: Whether this ad client is opted in to ARC.
- ArcOptIn bool `json:"arcOptIn,omitempty"`
-
- // Id: Unique identifier of this ad client.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case
- // adexchangeseller#adClient.
- Kind string `json:"kind,omitempty"`
-
- // ProductCode: This ad client's product code, which corresponds to the
- // PRODUCT_CODE report dimension.
- ProductCode string `json:"productCode,omitempty"`
-
- // SupportsReporting: Whether this ad client supports being reported on.
- SupportsReporting bool `json:"supportsReporting,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ArcOptIn") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdClient) MarshalJSON() ([]byte, error) {
- type noMethod AdClient
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdClients struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The ad clients returned in this list response.
- Items []*AdClient `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adexchangeseller#adClients.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through ad clients. To
- // retrieve the next page of results, set the next request's "pageToken"
- // value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdClients) MarshalJSON() ([]byte, error) {
- type noMethod AdClients
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdUnit struct {
- // Code: Identity code of this ad unit, not necessarily unique across ad
- // clients.
- Code string `json:"code,omitempty"`
-
- // Id: Unique identifier of this ad unit. This should be considered an
- // opaque identifier; it is not safe to rely on it being in any
- // particular format.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adexchangeseller#adUnit.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this ad unit.
- Name string `json:"name,omitempty"`
-
- // Status: Status of this ad unit. Possible values are:
- // NEW: Indicates that the ad unit was created within the last seven
- // days and does not yet have any activity associated with it.
- //
- // ACTIVE: Indicates that there has been activity on this ad unit in the
- // last seven days.
- //
- // INACTIVE: Indicates that there has been no activity on this ad unit
- // in the last seven days.
- Status string `json:"status,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdUnit) MarshalJSON() ([]byte, error) {
- type noMethod AdUnit
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdUnits struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The ad units returned in this list response.
- Items []*AdUnit `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adexchangeseller#adUnits.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through ad units. To
- // retrieve the next page of results, set the next request's "pageToken"
- // value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdUnits) MarshalJSON() ([]byte, error) {
- type noMethod AdUnits
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CustomChannel struct {
- // Code: Code of this custom channel, not necessarily unique across ad
- // clients.
- Code string `json:"code,omitempty"`
-
- // Id: Unique identifier of this custom channel. This should be
- // considered an opaque identifier; it is not safe to rely on it being
- // in any particular format.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case
- // adexchangeseller#customChannel.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this custom channel.
- Name string `json:"name,omitempty"`
-
- // TargetingInfo: The targeting information of this custom channel, if
- // activated.
- TargetingInfo *CustomChannelTargetingInfo `json:"targetingInfo,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomChannel) MarshalJSON() ([]byte, error) {
- type noMethod CustomChannel
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CustomChannelTargetingInfo: The targeting information of this custom
-// channel, if activated.
-type CustomChannelTargetingInfo struct {
- // AdsAppearOn: The name used to describe this channel externally.
- AdsAppearOn string `json:"adsAppearOn,omitempty"`
-
- // Description: The external description of the channel.
- Description string `json:"description,omitempty"`
-
- // Location: The locations in which ads appear. (Only valid for content
- // and mobile content ads). Acceptable values for content ads are:
- // TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER,
- // MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT,
- // MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are:
- // TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
- Location string `json:"location,omitempty"`
-
- // SiteLanguage: The language of the sites ads will be displayed on.
- SiteLanguage string `json:"siteLanguage,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AdsAppearOn") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomChannelTargetingInfo) MarshalJSON() ([]byte, error) {
- type noMethod CustomChannelTargetingInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CustomChannels struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The custom channels returned in this list response.
- Items []*CustomChannel `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case
- // adexchangeseller#customChannels.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through custom
- // channels. To retrieve the next page of results, set the next
- // request's "pageToken" value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomChannels) MarshalJSON() ([]byte, error) {
- type noMethod CustomChannels
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Report struct {
- // Averages: The averages of the report. This is the same length as any
- // other row in the report; cells corresponding to dimension columns are
- // empty.
- Averages []string `json:"averages,omitempty"`
-
- // Headers: The header information of the columns requested in the
- // report. This is a list of headers; one for each dimension in the
- // request, followed by one for each metric in the request.
- Headers []*ReportHeaders `json:"headers,omitempty"`
-
- // Kind: Kind this is, in this case adexchangeseller#report.
- Kind string `json:"kind,omitempty"`
-
- // Rows: The output rows of the report. Each row is a list of cells; one
- // for each dimension in the request, followed by one for each metric in
- // the request. The dimension cells contain strings, and the metric
- // cells contain numbers.
- Rows [][]string `json:"rows,omitempty"`
-
- // TotalMatchedRows: The total number of rows matched by the report
- // request. Fewer rows may be returned in the response due to being
- // limited by the row count requested or the report row limit.
- TotalMatchedRows int64 `json:"totalMatchedRows,omitempty,string"`
-
- // Totals: The totals of the report. This is the same length as any
- // other row in the report; cells corresponding to dimension columns are
- // empty.
- Totals []string `json:"totals,omitempty"`
-
- // Warnings: Any warnings associated with generation of the report.
- Warnings []string `json:"warnings,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Averages") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Report) MarshalJSON() ([]byte, error) {
- type noMethod Report
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ReportHeaders struct {
- // Currency: The currency of this column. Only present if the header
- // type is METRIC_CURRENCY.
- Currency string `json:"currency,omitempty"`
-
- // Name: The name of the header.
- Name string `json:"name,omitempty"`
-
- // Type: The type of the header; one of DIMENSION, METRIC_TALLY,
- // METRIC_RATIO, or METRIC_CURRENCY.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Currency") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportHeaders) MarshalJSON() ([]byte, error) {
- type noMethod ReportHeaders
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type SavedReport struct {
- // Id: Unique identifier of this saved report.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case
- // adexchangeseller#savedReport.
- Kind string `json:"kind,omitempty"`
-
- // Name: This saved report's name.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SavedReport) MarshalJSON() ([]byte, error) {
- type noMethod SavedReport
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type SavedReports struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The saved reports returned in this list response.
- Items []*SavedReport `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case
- // adexchangeseller#savedReports.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through saved reports.
- // To retrieve the next page of results, set the next request's
- // "pageToken" value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SavedReports) MarshalJSON() ([]byte, error) {
- type noMethod SavedReports
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UrlChannel struct {
- // Id: Unique identifier of this URL channel. This should be considered
- // an opaque identifier; it is not safe to rely on it being in any
- // particular format.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case
- // adexchangeseller#urlChannel.
- Kind string `json:"kind,omitempty"`
-
- // UrlPattern: URL Pattern of this URL channel. Does not include
- // "http://" or "https://". Example: www.example.com/home
- UrlPattern string `json:"urlPattern,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlChannel) MarshalJSON() ([]byte, error) {
- type noMethod UrlChannel
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UrlChannels struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The URL channels returned in this list response.
- Items []*UrlChannel `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case
- // adexchangeseller#urlChannels.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through URL channels.
- // To retrieve the next page of results, set the next request's
- // "pageToken" value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlChannels) MarshalJSON() ([]byte, error) {
- type noMethod UrlChannels
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "adexchangeseller.adclients.list":
-
-type AdclientsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all ad clients in this Ad Exchange account.
-func (r *AdclientsService) List() *AdclientsListCall {
- c := &AdclientsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of ad clients to include in the response, used for paging.
-func (c *AdclientsListCall) MaxResults(maxResults int64) *AdclientsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad clients. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AdclientsListCall) PageToken(pageToken string) *AdclientsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdclientsListCall) Fields(s ...googleapi.Field) *AdclientsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdclientsListCall) IfNoneMatch(entityTag string) *AdclientsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdclientsListCall) Context(ctx context.Context) *AdclientsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdclientsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.adclients.list" call.
-// Exactly one of *AdClients or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AdClients.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AdclientsListCall) Do() (*AdClients, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdClients{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all ad clients in this Ad Exchange account.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.adclients.list",
- // "parameters": {
- // "maxResults": {
- // "description": "The maximum number of ad clients to include in the response, used for paging.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients",
- // "response": {
- // "$ref": "AdClients"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.adunits.get":
-
-type AdunitsGetCall struct {
- s *Service
- adClientId string
- adUnitId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets the specified ad unit in the specified ad client.
-func (r *AdunitsService) Get(adClientId string, adUnitId string) *AdunitsGetCall {
- c := &AdunitsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.adUnitId = adUnitId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdunitsGetCall) Fields(s ...googleapi.Field) *AdunitsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdunitsGetCall) IfNoneMatch(entityTag string) *AdunitsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdunitsGetCall) Context(ctx context.Context) *AdunitsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdunitsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/adunits/{adUnitId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- "adUnitId": c.adUnitId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.adunits.get" call.
-// Exactly one of *AdUnit or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnit.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AdunitsGetCall) Do() (*AdUnit, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnit{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the specified ad unit in the specified ad client.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.adunits.get",
- // "parameterOrder": [
- // "adClientId",
- // "adUnitId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client for which to get the ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adUnitId": {
- // "description": "Ad unit to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/adunits/{adUnitId}",
- // "response": {
- // "$ref": "AdUnit"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.adunits.list":
-
-type AdunitsListCall struct {
- s *Service
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all ad units in the specified ad client for this Ad
-// Exchange account.
-func (r *AdunitsService) List(adClientId string) *AdunitsListCall {
- c := &AdunitsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- return c
-}
-
-// IncludeInactive sets the optional parameter "includeInactive":
-// Whether to include inactive ad units. Default: true.
-func (c *AdunitsListCall) IncludeInactive(includeInactive bool) *AdunitsListCall {
- c.opt_["includeInactive"] = includeInactive
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of ad units to include in the response, used for paging.
-func (c *AdunitsListCall) MaxResults(maxResults int64) *AdunitsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad units. To retrieve the next page, set
-// this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AdunitsListCall) PageToken(pageToken string) *AdunitsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdunitsListCall) Fields(s ...googleapi.Field) *AdunitsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdunitsListCall) IfNoneMatch(entityTag string) *AdunitsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdunitsListCall) Context(ctx context.Context) *AdunitsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdunitsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["includeInactive"]; ok {
- params.Set("includeInactive", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/adunits")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.adunits.list" call.
-// Exactly one of *AdUnits or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnits.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AdunitsListCall) Do() (*AdUnits, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnits{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all ad units in the specified ad client for this Ad Exchange account.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.adunits.list",
- // "parameterOrder": [
- // "adClientId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client for which to list ad units.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "includeInactive": {
- // "description": "Whether to include inactive ad units. Default: true.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "The maximum number of ad units to include in the response, used for paging.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/adunits",
- // "response": {
- // "$ref": "AdUnits"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.adunits.customchannels.list":
-
-type AdunitsCustomchannelsListCall struct {
- s *Service
- adClientId string
- adUnitId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all custom channels which the specified ad unit belongs
-// to.
-func (r *AdunitsCustomchannelsService) List(adClientId string, adUnitId string) *AdunitsCustomchannelsListCall {
- c := &AdunitsCustomchannelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.adUnitId = adUnitId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of custom channels to include in the response, used for
-// paging.
-func (c *AdunitsCustomchannelsListCall) MaxResults(maxResults int64) *AdunitsCustomchannelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through custom channels. To retrieve the next
-// page, set this parameter to the value of "nextPageToken" from the
-// previous response.
-func (c *AdunitsCustomchannelsListCall) PageToken(pageToken string) *AdunitsCustomchannelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdunitsCustomchannelsListCall) Fields(s ...googleapi.Field) *AdunitsCustomchannelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdunitsCustomchannelsListCall) IfNoneMatch(entityTag string) *AdunitsCustomchannelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdunitsCustomchannelsListCall) Context(ctx context.Context) *AdunitsCustomchannelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdunitsCustomchannelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/adunits/{adUnitId}/customchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- "adUnitId": c.adUnitId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.adunits.customchannels.list" call.
-// Exactly one of *CustomChannels or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannels.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AdunitsCustomchannelsListCall) Do() (*CustomChannels, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannels{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all custom channels which the specified ad unit belongs to.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.adunits.customchannels.list",
- // "parameterOrder": [
- // "adClientId",
- // "adUnitId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client which contains the ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adUnitId": {
- // "description": "Ad unit for which to list custom channels.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of custom channels to include in the response, used for paging.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/adunits/{adUnitId}/customchannels",
- // "response": {
- // "$ref": "CustomChannels"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.customchannels.get":
-
-type CustomchannelsGetCall struct {
- s *Service
- adClientId string
- customChannelId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get the specified custom channel from the specified ad client.
-func (r *CustomchannelsService) Get(adClientId string, customChannelId string) *CustomchannelsGetCall {
- c := &CustomchannelsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.customChannelId = customChannelId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CustomchannelsGetCall) Fields(s ...googleapi.Field) *CustomchannelsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CustomchannelsGetCall) IfNoneMatch(entityTag string) *CustomchannelsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CustomchannelsGetCall) Context(ctx context.Context) *CustomchannelsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CustomchannelsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/customchannels/{customChannelId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- "customChannelId": c.customChannelId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.customchannels.get" call.
-// Exactly one of *CustomChannel or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannel.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CustomchannelsGetCall) Do() (*CustomChannel, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannel{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get the specified custom channel from the specified ad client.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.customchannels.get",
- // "parameterOrder": [
- // "adClientId",
- // "customChannelId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client which contains the custom channel.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "customChannelId": {
- // "description": "Custom channel to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/customchannels/{customChannelId}",
- // "response": {
- // "$ref": "CustomChannel"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.customchannels.list":
-
-type CustomchannelsListCall struct {
- s *Service
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all custom channels in the specified ad client for this Ad
-// Exchange account.
-func (r *CustomchannelsService) List(adClientId string) *CustomchannelsListCall {
- c := &CustomchannelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of custom channels to include in the response, used for
-// paging.
-func (c *CustomchannelsListCall) MaxResults(maxResults int64) *CustomchannelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through custom channels. To retrieve the next
-// page, set this parameter to the value of "nextPageToken" from the
-// previous response.
-func (c *CustomchannelsListCall) PageToken(pageToken string) *CustomchannelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CustomchannelsListCall) Fields(s ...googleapi.Field) *CustomchannelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CustomchannelsListCall) IfNoneMatch(entityTag string) *CustomchannelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CustomchannelsListCall) Context(ctx context.Context) *CustomchannelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CustomchannelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/customchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.customchannels.list" call.
-// Exactly one of *CustomChannels or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannels.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CustomchannelsListCall) Do() (*CustomChannels, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannels{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all custom channels in the specified ad client for this Ad Exchange account.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.customchannels.list",
- // "parameterOrder": [
- // "adClientId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client for which to list custom channels.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of custom channels to include in the response, used for paging.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/customchannels",
- // "response": {
- // "$ref": "CustomChannels"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.customchannels.adunits.list":
-
-type CustomchannelsAdunitsListCall struct {
- s *Service
- adClientId string
- customChannelId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all ad units in the specified custom channel.
-func (r *CustomchannelsAdunitsService) List(adClientId string, customChannelId string) *CustomchannelsAdunitsListCall {
- c := &CustomchannelsAdunitsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.customChannelId = customChannelId
- return c
-}
-
-// IncludeInactive sets the optional parameter "includeInactive":
-// Whether to include inactive ad units. Default: true.
-func (c *CustomchannelsAdunitsListCall) IncludeInactive(includeInactive bool) *CustomchannelsAdunitsListCall {
- c.opt_["includeInactive"] = includeInactive
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of ad units to include in the response, used for paging.
-func (c *CustomchannelsAdunitsListCall) MaxResults(maxResults int64) *CustomchannelsAdunitsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad units. To retrieve the next page, set
-// this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *CustomchannelsAdunitsListCall) PageToken(pageToken string) *CustomchannelsAdunitsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CustomchannelsAdunitsListCall) Fields(s ...googleapi.Field) *CustomchannelsAdunitsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CustomchannelsAdunitsListCall) IfNoneMatch(entityTag string) *CustomchannelsAdunitsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CustomchannelsAdunitsListCall) Context(ctx context.Context) *CustomchannelsAdunitsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CustomchannelsAdunitsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["includeInactive"]; ok {
- params.Set("includeInactive", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/customchannels/{customChannelId}/adunits")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- "customChannelId": c.customChannelId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.customchannels.adunits.list" call.
-// Exactly one of *AdUnits or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnits.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *CustomchannelsAdunitsListCall) Do() (*AdUnits, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnits{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all ad units in the specified custom channel.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.customchannels.adunits.list",
- // "parameterOrder": [
- // "adClientId",
- // "customChannelId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client which contains the custom channel.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "customChannelId": {
- // "description": "Custom channel for which to list ad units.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "includeInactive": {
- // "description": "Whether to include inactive ad units. Default: true.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "The maximum number of ad units to include in the response, used for paging.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/customchannels/{customChannelId}/adunits",
- // "response": {
- // "$ref": "AdUnits"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.reports.generate":
-
-type ReportsGenerateCall struct {
- s *Service
- startDate string
- endDate string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Generate: Generate an Ad Exchange report based on the report request
-// sent in the query parameters. Returns the result as JSON; to retrieve
-// output in CSV format specify "alt=csv" as a query parameter.
-func (r *ReportsService) Generate(startDate string, endDate string) *ReportsGenerateCall {
- c := &ReportsGenerateCall{s: r.s, opt_: make(map[string]interface{})}
- c.startDate = startDate
- c.endDate = endDate
- return c
-}
-
-// Dimension sets the optional parameter "dimension": Dimensions to base
-// the report on.
-func (c *ReportsGenerateCall) Dimension(dimension string) *ReportsGenerateCall {
- c.opt_["dimension"] = dimension
- return c
-}
-
-// Filter sets the optional parameter "filter": Filters to be run on the
-// report.
-func (c *ReportsGenerateCall) Filter(filter string) *ReportsGenerateCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// Locale sets the optional parameter "locale": Optional locale to use
-// for translating report output to a local language. Defaults to
-// "en_US" if not specified.
-func (c *ReportsGenerateCall) Locale(locale string) *ReportsGenerateCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of rows of report data to return.
-func (c *ReportsGenerateCall) MaxResults(maxResults int64) *ReportsGenerateCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// Metric sets the optional parameter "metric": Numeric columns to
-// include in the report.
-func (c *ReportsGenerateCall) Metric(metric string) *ReportsGenerateCall {
- c.opt_["metric"] = metric
- return c
-}
-
-// Sort sets the optional parameter "sort": The name of a dimension or
-// metric to sort the resulting report on, optionally prefixed with "+"
-// to sort ascending or "-" to sort descending. If no prefix is
-// specified, the column is sorted ascending.
-func (c *ReportsGenerateCall) Sort(sort string) *ReportsGenerateCall {
- c.opt_["sort"] = sort
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex": Index of the
-// first row of report data to return.
-func (c *ReportsGenerateCall) StartIndex(startIndex int64) *ReportsGenerateCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsGenerateCall) Fields(s ...googleapi.Field) *ReportsGenerateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsGenerateCall) IfNoneMatch(entityTag string) *ReportsGenerateCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do and Download methods.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsGenerateCall) Context(ctx context.Context) *ReportsGenerateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsGenerateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("endDate", fmt.Sprintf("%v", c.endDate))
- params.Set("startDate", fmt.Sprintf("%v", c.startDate))
- if v, ok := c.opt_["dimension"]; ok {
- params.Set("dimension", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["metric"]; ok {
- params.Set("metric", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sort"]; ok {
- params.Set("sort", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "reports")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Download fetches the API endpoint's "media" value, instead of the normal
-// API response value. If the returned error is nil, the Response is guaranteed to
-// have a 2xx status code. Callers must close the Response.Body as usual.
-func (c *ReportsGenerateCall) Download() (*http.Response, error) {
- res, err := c.doRequest("media")
- if err != nil {
- return nil, err
- }
- if err := googleapi.CheckMediaResponse(res); err != nil {
- res.Body.Close()
- return nil, err
- }
- return res, nil
-}
-
-// Do executes the "adexchangeseller.reports.generate" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsGenerateCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Generate an Ad Exchange report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.reports.generate",
- // "parameterOrder": [
- // "startDate",
- // "endDate"
- // ],
- // "parameters": {
- // "dimension": {
- // "description": "Dimensions to base the report on.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "endDate": {
- // "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- // "location": "query",
- // "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- // "required": true,
- // "type": "string"
- // },
- // "filter": {
- // "description": "Filters to be run on the report.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+(==|=@).+",
- // "repeated": true,
- // "type": "string"
- // },
- // "locale": {
- // "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of rows of report data to return.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "50000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "metric": {
- // "description": "Numeric columns to include in the report.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "sort": {
- // "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
- // "location": "query",
- // "pattern": "(\\+|-)?[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "startDate": {
- // "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- // "location": "query",
- // "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- // "required": true,
- // "type": "string"
- // },
- // "startIndex": {
- // "description": "Index of the first row of report data to return.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "5000",
- // "minimum": "0",
- // "type": "integer"
- // }
- // },
- // "path": "reports",
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ],
- // "supportsMediaDownload": true
- // }
-
-}
-
-// method id "adexchangeseller.reports.saved.generate":
-
-type ReportsSavedGenerateCall struct {
- s *Service
- savedReportId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Generate: Generate an Ad Exchange report based on the saved report ID
-// sent in the query parameters.
-func (r *ReportsSavedService) Generate(savedReportId string) *ReportsSavedGenerateCall {
- c := &ReportsSavedGenerateCall{s: r.s, opt_: make(map[string]interface{})}
- c.savedReportId = savedReportId
- return c
-}
-
-// Locale sets the optional parameter "locale": Optional locale to use
-// for translating report output to a local language. Defaults to
-// "en_US" if not specified.
-func (c *ReportsSavedGenerateCall) Locale(locale string) *ReportsSavedGenerateCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of rows of report data to return.
-func (c *ReportsSavedGenerateCall) MaxResults(maxResults int64) *ReportsSavedGenerateCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex": Index of the
-// first row of report data to return.
-func (c *ReportsSavedGenerateCall) StartIndex(startIndex int64) *ReportsSavedGenerateCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsSavedGenerateCall) Fields(s ...googleapi.Field) *ReportsSavedGenerateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsSavedGenerateCall) IfNoneMatch(entityTag string) *ReportsSavedGenerateCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsSavedGenerateCall) Context(ctx context.Context) *ReportsSavedGenerateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsSavedGenerateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "reports/{savedReportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "savedReportId": c.savedReportId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.reports.saved.generate" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsSavedGenerateCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Generate an Ad Exchange report based on the saved report ID sent in the query parameters.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.reports.saved.generate",
- // "parameterOrder": [
- // "savedReportId"
- // ],
- // "parameters": {
- // "locale": {
- // "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of rows of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "50000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "savedReportId": {
- // "description": "The saved report to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "startIndex": {
- // "description": "Index of the first row of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "5000",
- // "minimum": "0",
- // "type": "integer"
- // }
- // },
- // "path": "reports/{savedReportId}",
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.reports.saved.list":
-
-type ReportsSavedListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all saved reports in this Ad Exchange account.
-func (r *ReportsSavedService) List() *ReportsSavedListCall {
- c := &ReportsSavedListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of saved reports to include in the response, used for paging.
-func (c *ReportsSavedListCall) MaxResults(maxResults int64) *ReportsSavedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through saved reports. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *ReportsSavedListCall) PageToken(pageToken string) *ReportsSavedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsSavedListCall) Fields(s ...googleapi.Field) *ReportsSavedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsSavedListCall) IfNoneMatch(entityTag string) *ReportsSavedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsSavedListCall) Context(ctx context.Context) *ReportsSavedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsSavedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "reports/saved")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.reports.saved.list" call.
-// Exactly one of *SavedReports or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *SavedReports.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ReportsSavedListCall) Do() (*SavedReports, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SavedReports{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all saved reports in this Ad Exchange account.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.reports.saved.list",
- // "parameters": {
- // "maxResults": {
- // "description": "The maximum number of saved reports to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "100",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "reports/saved",
- // "response": {
- // "$ref": "SavedReports"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.urlchannels.list":
-
-type UrlchannelsListCall struct {
- s *Service
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all URL channels in the specified ad client for this Ad
-// Exchange account.
-func (r *UrlchannelsService) List(adClientId string) *UrlchannelsListCall {
- c := &UrlchannelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of URL channels to include in the response, used for paging.
-func (c *UrlchannelsListCall) MaxResults(maxResults int64) *UrlchannelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through URL channels. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *UrlchannelsListCall) PageToken(pageToken string) *UrlchannelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UrlchannelsListCall) Fields(s ...googleapi.Field) *UrlchannelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UrlchannelsListCall) IfNoneMatch(entityTag string) *UrlchannelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UrlchannelsListCall) Context(ctx context.Context) *UrlchannelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UrlchannelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/urlchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.urlchannels.list" call.
-// Exactly one of *UrlChannels or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UrlChannels.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UrlchannelsListCall) Do() (*UrlChannels, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UrlChannels{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all URL channels in the specified ad client for this Ad Exchange account.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.urlchannels.list",
- // "parameterOrder": [
- // "adClientId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client for which to list URL channels.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of URL channels to include in the response, used for paging.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/urlchannels",
- // "response": {
- // "$ref": "UrlChannels"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/adexchangeseller/v2.0/adexchangeseller-api.json b/vendor/google.golang.org/api/adexchangeseller/v2.0/adexchangeseller-api.json
deleted file mode 100644
index df5225c1..00000000
--- a/vendor/google.golang.org/api/adexchangeseller/v2.0/adexchangeseller-api.json
+++ /dev/null
@@ -1,1164 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/6aC1_omptpkys969gj83ZtJAvZ8\"",
- "discoveryVersion": "v1",
- "id": "adexchangeseller:v2.0",
- "name": "adexchangeseller",
- "canonicalName": "Ad Exchange Seller",
- "version": "v2.0",
- "revision": "20141112",
- "title": "Ad Exchange Seller API",
- "description": "Gives Ad Exchange seller users access to their inventory and the ability to generate reports",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/ad-exchange/seller-rest/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/adexchangeseller/v2.0/",
- "basePath": "/adexchangeseller/v2.0/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "adexchangeseller/v2.0/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "csv",
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of text/csv",
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/adexchange.seller": {
- "description": "View and manage your Ad Exchange data"
- },
- "https://www.googleapis.com/auth/adexchange.seller.readonly": {
- "description": "View your Ad Exchange data"
- }
- }
- }
- },
- "schemas": {
- "Account": {
- "id": "Account",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this account."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#account.",
- "default": "adexchangeseller#account"
- },
- "name": {
- "type": "string",
- "description": "Name of this account."
- }
- }
- },
- "Accounts": {
- "id": "Accounts",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The accounts returned in this list response.",
- "items": {
- "$ref": "Account"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#accounts.",
- "default": "adexchangeseller#accounts"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through accounts. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "AdClient": {
- "id": "AdClient",
- "type": "object",
- "properties": {
- "arcOptIn": {
- "type": "boolean",
- "description": "Whether this ad client is opted in to ARC."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this ad client."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#adClient.",
- "default": "adexchangeseller#adClient"
- },
- "productCode": {
- "type": "string",
- "description": "This ad client's product code, which corresponds to the PRODUCT_CODE report dimension."
- },
- "supportsReporting": {
- "type": "boolean",
- "description": "Whether this ad client supports being reported on."
- }
- }
- },
- "AdClients": {
- "id": "AdClients",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The ad clients returned in this list response.",
- "items": {
- "$ref": "AdClient"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#adClients.",
- "default": "adexchangeseller#adClients"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "Alert": {
- "id": "Alert",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this alert. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#alert.",
- "default": "adexchangeseller#alert"
- },
- "message": {
- "type": "string",
- "description": "The localized alert message."
- },
- "severity": {
- "type": "string",
- "description": "Severity of this alert. Possible values: INFO, WARNING, SEVERE."
- },
- "type": {
- "type": "string",
- "description": "Type of this alert. Possible values: SELF_HOLD, MIGRATED_TO_BILLING3, ADDRESS_PIN_VERIFICATION, PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, GRAYLISTED_PUBLISHER, API_HOLD."
- }
- }
- },
- "Alerts": {
- "id": "Alerts",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "The alerts returned in this list response.",
- "items": {
- "$ref": "Alert"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#alerts.",
- "default": "adexchangeseller#alerts"
- }
- }
- },
- "CustomChannel": {
- "id": "CustomChannel",
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "Code of this custom channel, not necessarily unique across ad clients."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#customChannel.",
- "default": "adexchangeseller#customChannel"
- },
- "name": {
- "type": "string",
- "description": "Name of this custom channel."
- },
- "targetingInfo": {
- "type": "object",
- "description": "The targeting information of this custom channel, if activated.",
- "properties": {
- "adsAppearOn": {
- "type": "string",
- "description": "The name used to describe this channel externally."
- },
- "description": {
- "type": "string",
- "description": "The external description of the channel."
- },
- "location": {
- "type": "string",
- "description": "The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS."
- },
- "siteLanguage": {
- "type": "string",
- "description": "The language of the sites ads will be displayed on."
- }
- }
- }
- }
- },
- "CustomChannels": {
- "id": "CustomChannels",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The custom channels returned in this list response.",
- "items": {
- "$ref": "CustomChannel"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#customChannels.",
- "default": "adexchangeseller#customChannels"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "Metadata": {
- "id": "Metadata",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "items": {
- "$ref": "ReportingMetadataEntry"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#metadata.",
- "default": "adexchangeseller#metadata"
- }
- }
- },
- "PreferredDeal": {
- "id": "PreferredDeal",
- "type": "object",
- "properties": {
- "advertiserName": {
- "type": "string",
- "description": "The name of the advertiser this deal is for."
- },
- "buyerNetworkName": {
- "type": "string",
- "description": "The name of the buyer network this deal is for."
- },
- "currencyCode": {
- "type": "string",
- "description": "The currency code that applies to the fixed_cpm value. If not set then assumed to be USD."
- },
- "endTime": {
- "type": "string",
- "description": "Time when this deal stops being active in seconds since the epoch (GMT). If not set then this deal is valid until manually disabled by the publisher.",
- "format": "uint64"
- },
- "fixedCpm": {
- "type": "string",
- "description": "The fixed price for this preferred deal. In cpm micros of currency according to currencyCode. If set, then this preferred deal is eligible for the fixed price tier of buying (highest priority, pay exactly the configured fixed price).",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this preferred deal.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#preferredDeal.",
- "default": "adexchangeseller#preferredDeal"
- },
- "startTime": {
- "type": "string",
- "description": "Time when this deal becomes active in seconds since the epoch (GMT). If not set then this deal is active immediately upon creation.",
- "format": "uint64"
- }
- }
- },
- "PreferredDeals": {
- "id": "PreferredDeals",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "The preferred deals returned in this list response.",
- "items": {
- "$ref": "PreferredDeal"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#preferredDeals.",
- "default": "adexchangeseller#preferredDeals"
- }
- }
- },
- "Report": {
- "id": "Report",
- "type": "object",
- "properties": {
- "averages": {
- "type": "array",
- "description": "The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
- "items": {
- "type": "string"
- }
- },
- "headers": {
- "type": "array",
- "description": "The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.",
- "items": {
- "type": "object",
- "properties": {
- "currency": {
- "type": "string",
- "description": "The currency of this column. Only present if the header type is METRIC_CURRENCY."
- },
- "name": {
- "type": "string",
- "description": "The name of the header."
- },
- "type": {
- "type": "string",
- "description": "The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY."
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind this is, in this case adexchangeseller#report.",
- "default": "adexchangeseller#report"
- },
- "rows": {
- "type": "array",
- "description": "The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.",
- "items": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "totalMatchedRows": {
- "type": "string",
- "description": "The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.",
- "format": "int64"
- },
- "totals": {
- "type": "array",
- "description": "The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
- "items": {
- "type": "string"
- }
- },
- "warnings": {
- "type": "array",
- "description": "Any warnings associated with generation of the report.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "ReportingMetadataEntry": {
- "id": "ReportingMetadataEntry",
- "type": "object",
- "properties": {
- "compatibleDimensions": {
- "type": "array",
- "description": "For metrics this is a list of dimension IDs which the metric is compatible with, for dimensions it is a list of compatibility groups the dimension belongs to.",
- "items": {
- "type": "string"
- }
- },
- "compatibleMetrics": {
- "type": "array",
- "description": "The names of the metrics the dimension or metric this reporting metadata entry describes is compatible with.",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this reporting metadata entry, corresponding to the name of the appropriate dimension or metric."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#reportingMetadataEntry.",
- "default": "adexchangeseller#reportingMetadataEntry"
- },
- "requiredDimensions": {
- "type": "array",
- "description": "The names of the dimensions which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.",
- "items": {
- "type": "string"
- }
- },
- "requiredMetrics": {
- "type": "array",
- "description": "The names of the metrics which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.",
- "items": {
- "type": "string"
- }
- },
- "supportedProducts": {
- "type": "array",
- "description": "The codes of the projects supported by the dimension or metric this reporting metadata entry describes.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "SavedReport": {
- "id": "SavedReport",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this saved report."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#savedReport.",
- "default": "adexchangeseller#savedReport"
- },
- "name": {
- "type": "string",
- "description": "This saved report's name."
- }
- }
- },
- "SavedReports": {
- "id": "SavedReports",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The saved reports returned in this list response.",
- "items": {
- "$ref": "SavedReport"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#savedReports.",
- "default": "adexchangeseller#savedReports"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "UrlChannel": {
- "id": "UrlChannel",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adexchangeseller#urlChannel.",
- "default": "adexchangeseller#urlChannel"
- },
- "urlPattern": {
- "type": "string",
- "description": "URL Pattern of this URL channel. Does not include \"http://\" or \"https://\". Example: www.example.com/home"
- }
- }
- },
- "UrlChannels": {
- "id": "UrlChannels",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The URL channels returned in this list response.",
- "items": {
- "$ref": "UrlChannel"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adexchangeseller#urlChannels.",
- "default": "adexchangeseller#urlChannels"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- }
- },
- "resources": {
- "accounts": {
- "methods": {
- "get": {
- "id": "adexchangeseller.accounts.get",
- "path": "accounts/{accountId}",
- "httpMethod": "GET",
- "description": "Get information about the selected Ad Exchange account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to get information about. Tip: 'myaccount' is a valid ID.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- },
- "list": {
- "id": "adexchangeseller.accounts.list",
- "path": "accounts",
- "httpMethod": "GET",
- "description": "List all accounts available to this Ad Exchange account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of accounts to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through accounts. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Accounts"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- },
- "resources": {
- "adclients": {
- "methods": {
- "list": {
- "id": "adexchangeseller.accounts.adclients.list",
- "path": "accounts/{accountId}/adclients",
- "httpMethod": "GET",
- "description": "List all ad clients in this Ad Exchange account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad clients to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "AdClients"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- },
- "alerts": {
- "methods": {
- "list": {
- "id": "adexchangeseller.accounts.alerts.list",
- "path": "accounts/{accountId}/alerts",
- "httpMethod": "GET",
- "description": "List the alerts for this Ad Exchange account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account owning the alerts.",
- "required": true,
- "location": "path"
- },
- "locale": {
- "type": "string",
- "description": "The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "Alerts"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- },
- "customchannels": {
- "methods": {
- "get": {
- "id": "adexchangeseller.accounts.customchannels.get",
- "path": "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}",
- "httpMethod": "GET",
- "description": "Get the specified custom channel from the specified ad client.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the custom channel.",
- "required": true,
- "location": "path"
- },
- "customChannelId": {
- "type": "string",
- "description": "Custom channel to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "CustomChannel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- },
- "list": {
- "id": "adexchangeseller.accounts.customchannels.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/customchannels",
- "httpMethod": "GET",
- "description": "List all custom channels in the specified ad client for this Ad Exchange account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list custom channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId"
- ],
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- },
- "metadata": {
- "resources": {
- "dimensions": {
- "methods": {
- "list": {
- "id": "adexchangeseller.accounts.metadata.dimensions.list",
- "path": "accounts/{accountId}/metadata/dimensions",
- "httpMethod": "GET",
- "description": "List the metadata for the dimensions available to this AdExchange account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account with visibility to the dimensions.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "Metadata"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- },
- "metrics": {
- "methods": {
- "list": {
- "id": "adexchangeseller.accounts.metadata.metrics.list",
- "path": "accounts/{accountId}/metadata/metrics",
- "httpMethod": "GET",
- "description": "List the metadata for the metrics available to this AdExchange account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account with visibility to the metrics.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "Metadata"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- }
- }
- },
- "preferreddeals": {
- "methods": {
- "get": {
- "id": "adexchangeseller.accounts.preferreddeals.get",
- "path": "accounts/{accountId}/preferreddeals/{dealId}",
- "httpMethod": "GET",
- "description": "Get information about the selected Ad Exchange Preferred Deal.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account owning the deal.",
- "required": true,
- "location": "path"
- },
- "dealId": {
- "type": "string",
- "description": "Preferred deal to get information about.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "dealId"
- ],
- "response": {
- "$ref": "PreferredDeal"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- },
- "list": {
- "id": "adexchangeseller.accounts.preferreddeals.list",
- "path": "accounts/{accountId}/preferreddeals",
- "httpMethod": "GET",
- "description": "List the preferred deals for this Ad Exchange account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account owning the deals.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "PreferredDeals"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- },
- "reports": {
- "methods": {
- "generate": {
- "id": "adexchangeseller.accounts.reports.generate",
- "path": "accounts/{accountId}/reports",
- "httpMethod": "GET",
- "description": "Generate an Ad Exchange report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account which owns the generated report.",
- "required": true,
- "location": "path"
- },
- "dimension": {
- "type": "string",
- "description": "Dimensions to base the report on.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "endDate": {
- "type": "string",
- "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "Filters to be run on the report.",
- "pattern": "[a-zA-Z_]+(==|=@).+",
- "repeated": true,
- "location": "query"
- },
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "metric": {
- "type": "string",
- "description": "Numeric columns to include in the report.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "sort": {
- "type": "string",
- "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
- "pattern": "(\\+|-)?[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "startDate": {
- "type": "string",
- "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "startDate",
- "endDate"
- ],
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ],
- "supportsMediaDownload": true
- }
- },
- "resources": {
- "saved": {
- "methods": {
- "generate": {
- "id": "adexchangeseller.accounts.reports.saved.generate",
- "path": "accounts/{accountId}/reports/{savedReportId}",
- "httpMethod": "GET",
- "description": "Generate an Ad Exchange report based on the saved report ID sent in the query parameters.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account owning the saved report.",
- "required": true,
- "location": "path"
- },
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "savedReportId": {
- "type": "string",
- "description": "The saved report to retrieve.",
- "required": true,
- "location": "path"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "savedReportId"
- ],
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- },
- "list": {
- "id": "adexchangeseller.accounts.reports.saved.list",
- "path": "accounts/{accountId}/reports/saved",
- "httpMethod": "GET",
- "description": "List all saved reports in this Ad Exchange account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account owning the saved reports.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of saved reports to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "SavedReports"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- }
- }
- },
- "urlchannels": {
- "methods": {
- "list": {
- "id": "adexchangeseller.accounts.urlchannels.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/urlchannels",
- "httpMethod": "GET",
- "description": "List all URL channels in the specified ad client for this Ad Exchange account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list URL channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of URL channels to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId"
- ],
- "response": {
- "$ref": "UrlChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.seller",
- "https://www.googleapis.com/auth/adexchange.seller.readonly"
- ]
- }
- }
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/adexchangeseller/v2.0/adexchangeseller-gen.go b/vendor/google.golang.org/api/adexchangeseller/v2.0/adexchangeseller-gen.go
deleted file mode 100644
index 8c4dd6c3..00000000
--- a/vendor/google.golang.org/api/adexchangeseller/v2.0/adexchangeseller-gen.go
+++ /dev/null
@@ -1,3112 +0,0 @@
-// Package adexchangeseller provides access to the Ad Exchange Seller API.
-//
-// See https://developers.google.com/ad-exchange/seller-rest/
-//
-// Usage example:
-//
-// import "google.golang.org/api/adexchangeseller/v2.0"
-// ...
-// adexchangesellerService, err := adexchangeseller.New(oauthHttpClient)
-package adexchangeseller // import "google.golang.org/api/adexchangeseller/v2.0"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "adexchangeseller:v2.0"
-const apiName = "adexchangeseller"
-const apiVersion = "v2.0"
-const basePath = "https://www.googleapis.com/adexchangeseller/v2.0/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your Ad Exchange data
- AdexchangeSellerScope = "https://www.googleapis.com/auth/adexchange.seller"
-
- // View your Ad Exchange data
- AdexchangeSellerReadonlyScope = "https://www.googleapis.com/auth/adexchange.seller.readonly"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Accounts = NewAccountsService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Accounts *AccountsService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewAccountsService(s *Service) *AccountsService {
- rs := &AccountsService{s: s}
- rs.Adclients = NewAccountsAdclientsService(s)
- rs.Alerts = NewAccountsAlertsService(s)
- rs.Customchannels = NewAccountsCustomchannelsService(s)
- rs.Metadata = NewAccountsMetadataService(s)
- rs.Preferreddeals = NewAccountsPreferreddealsService(s)
- rs.Reports = NewAccountsReportsService(s)
- rs.Urlchannels = NewAccountsUrlchannelsService(s)
- return rs
-}
-
-type AccountsService struct {
- s *Service
-
- Adclients *AccountsAdclientsService
-
- Alerts *AccountsAlertsService
-
- Customchannels *AccountsCustomchannelsService
-
- Metadata *AccountsMetadataService
-
- Preferreddeals *AccountsPreferreddealsService
-
- Reports *AccountsReportsService
-
- Urlchannels *AccountsUrlchannelsService
-}
-
-func NewAccountsAdclientsService(s *Service) *AccountsAdclientsService {
- rs := &AccountsAdclientsService{s: s}
- return rs
-}
-
-type AccountsAdclientsService struct {
- s *Service
-}
-
-func NewAccountsAlertsService(s *Service) *AccountsAlertsService {
- rs := &AccountsAlertsService{s: s}
- return rs
-}
-
-type AccountsAlertsService struct {
- s *Service
-}
-
-func NewAccountsCustomchannelsService(s *Service) *AccountsCustomchannelsService {
- rs := &AccountsCustomchannelsService{s: s}
- return rs
-}
-
-type AccountsCustomchannelsService struct {
- s *Service
-}
-
-func NewAccountsMetadataService(s *Service) *AccountsMetadataService {
- rs := &AccountsMetadataService{s: s}
- rs.Dimensions = NewAccountsMetadataDimensionsService(s)
- rs.Metrics = NewAccountsMetadataMetricsService(s)
- return rs
-}
-
-type AccountsMetadataService struct {
- s *Service
-
- Dimensions *AccountsMetadataDimensionsService
-
- Metrics *AccountsMetadataMetricsService
-}
-
-func NewAccountsMetadataDimensionsService(s *Service) *AccountsMetadataDimensionsService {
- rs := &AccountsMetadataDimensionsService{s: s}
- return rs
-}
-
-type AccountsMetadataDimensionsService struct {
- s *Service
-}
-
-func NewAccountsMetadataMetricsService(s *Service) *AccountsMetadataMetricsService {
- rs := &AccountsMetadataMetricsService{s: s}
- return rs
-}
-
-type AccountsMetadataMetricsService struct {
- s *Service
-}
-
-func NewAccountsPreferreddealsService(s *Service) *AccountsPreferreddealsService {
- rs := &AccountsPreferreddealsService{s: s}
- return rs
-}
-
-type AccountsPreferreddealsService struct {
- s *Service
-}
-
-func NewAccountsReportsService(s *Service) *AccountsReportsService {
- rs := &AccountsReportsService{s: s}
- rs.Saved = NewAccountsReportsSavedService(s)
- return rs
-}
-
-type AccountsReportsService struct {
- s *Service
-
- Saved *AccountsReportsSavedService
-}
-
-func NewAccountsReportsSavedService(s *Service) *AccountsReportsSavedService {
- rs := &AccountsReportsSavedService{s: s}
- return rs
-}
-
-type AccountsReportsSavedService struct {
- s *Service
-}
-
-func NewAccountsUrlchannelsService(s *Service) *AccountsUrlchannelsService {
- rs := &AccountsUrlchannelsService{s: s}
- return rs
-}
-
-type AccountsUrlchannelsService struct {
- s *Service
-}
-
-type Account struct {
- // Id: Unique identifier of this account.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case
- // adexchangeseller#account.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this account.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Account) MarshalJSON() ([]byte, error) {
- type noMethod Account
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Accounts struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The accounts returned in this list response.
- Items []*Account `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adexchangeseller#accounts.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through accounts. To
- // retrieve the next page of results, set the next request's "pageToken"
- // value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Accounts) MarshalJSON() ([]byte, error) {
- type noMethod Accounts
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdClient struct {
- // ArcOptIn: Whether this ad client is opted in to ARC.
- ArcOptIn bool `json:"arcOptIn,omitempty"`
-
- // Id: Unique identifier of this ad client.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case
- // adexchangeseller#adClient.
- Kind string `json:"kind,omitempty"`
-
- // ProductCode: This ad client's product code, which corresponds to the
- // PRODUCT_CODE report dimension.
- ProductCode string `json:"productCode,omitempty"`
-
- // SupportsReporting: Whether this ad client supports being reported on.
- SupportsReporting bool `json:"supportsReporting,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ArcOptIn") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdClient) MarshalJSON() ([]byte, error) {
- type noMethod AdClient
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdClients struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The ad clients returned in this list response.
- Items []*AdClient `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adexchangeseller#adClients.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through ad clients. To
- // retrieve the next page of results, set the next request's "pageToken"
- // value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdClients) MarshalJSON() ([]byte, error) {
- type noMethod AdClients
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Alert struct {
- // Id: Unique identifier of this alert. This should be considered an
- // opaque identifier; it is not safe to rely on it being in any
- // particular format.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adexchangeseller#alert.
- Kind string `json:"kind,omitempty"`
-
- // Message: The localized alert message.
- Message string `json:"message,omitempty"`
-
- // Severity: Severity of this alert. Possible values: INFO, WARNING,
- // SEVERE.
- Severity string `json:"severity,omitempty"`
-
- // Type: Type of this alert. Possible values: SELF_HOLD,
- // MIGRATED_TO_BILLING3, ADDRESS_PIN_VERIFICATION,
- // PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, GRAYLISTED_PUBLISHER,
- // API_HOLD.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Alert) MarshalJSON() ([]byte, error) {
- type noMethod Alert
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Alerts struct {
- // Items: The alerts returned in this list response.
- Items []*Alert `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adexchangeseller#alerts.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Alerts) MarshalJSON() ([]byte, error) {
- type noMethod Alerts
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CustomChannel struct {
- // Code: Code of this custom channel, not necessarily unique across ad
- // clients.
- Code string `json:"code,omitempty"`
-
- // Id: Unique identifier of this custom channel. This should be
- // considered an opaque identifier; it is not safe to rely on it being
- // in any particular format.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case
- // adexchangeseller#customChannel.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this custom channel.
- Name string `json:"name,omitempty"`
-
- // TargetingInfo: The targeting information of this custom channel, if
- // activated.
- TargetingInfo *CustomChannelTargetingInfo `json:"targetingInfo,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomChannel) MarshalJSON() ([]byte, error) {
- type noMethod CustomChannel
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CustomChannelTargetingInfo: The targeting information of this custom
-// channel, if activated.
-type CustomChannelTargetingInfo struct {
- // AdsAppearOn: The name used to describe this channel externally.
- AdsAppearOn string `json:"adsAppearOn,omitempty"`
-
- // Description: The external description of the channel.
- Description string `json:"description,omitempty"`
-
- // Location: The locations in which ads appear. (Only valid for content
- // and mobile content ads). Acceptable values for content ads are:
- // TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER,
- // MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT,
- // MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are:
- // TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
- Location string `json:"location,omitempty"`
-
- // SiteLanguage: The language of the sites ads will be displayed on.
- SiteLanguage string `json:"siteLanguage,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AdsAppearOn") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomChannelTargetingInfo) MarshalJSON() ([]byte, error) {
- type noMethod CustomChannelTargetingInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CustomChannels struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The custom channels returned in this list response.
- Items []*CustomChannel `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case
- // adexchangeseller#customChannels.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through custom
- // channels. To retrieve the next page of results, set the next
- // request's "pageToken" value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomChannels) MarshalJSON() ([]byte, error) {
- type noMethod CustomChannels
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Metadata struct {
- Items []*ReportingMetadataEntry `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adexchangeseller#metadata.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Metadata) MarshalJSON() ([]byte, error) {
- type noMethod Metadata
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type PreferredDeal struct {
- // AdvertiserName: The name of the advertiser this deal is for.
- AdvertiserName string `json:"advertiserName,omitempty"`
-
- // BuyerNetworkName: The name of the buyer network this deal is for.
- BuyerNetworkName string `json:"buyerNetworkName,omitempty"`
-
- // CurrencyCode: The currency code that applies to the fixed_cpm value.
- // If not set then assumed to be USD.
- CurrencyCode string `json:"currencyCode,omitempty"`
-
- // EndTime: Time when this deal stops being active in seconds since the
- // epoch (GMT). If not set then this deal is valid until manually
- // disabled by the publisher.
- EndTime uint64 `json:"endTime,omitempty,string"`
-
- // FixedCpm: The fixed price for this preferred deal. In cpm micros of
- // currency according to currencyCode. If set, then this preferred deal
- // is eligible for the fixed price tier of buying (highest priority, pay
- // exactly the configured fixed price).
- FixedCpm int64 `json:"fixedCpm,omitempty,string"`
-
- // Id: Unique identifier of this preferred deal.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Kind of resource this is, in this case
- // adexchangeseller#preferredDeal.
- Kind string `json:"kind,omitempty"`
-
- // StartTime: Time when this deal becomes active in seconds since the
- // epoch (GMT). If not set then this deal is active immediately upon
- // creation.
- StartTime uint64 `json:"startTime,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AdvertiserName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PreferredDeal) MarshalJSON() ([]byte, error) {
- type noMethod PreferredDeal
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type PreferredDeals struct {
- // Items: The preferred deals returned in this list response.
- Items []*PreferredDeal `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case
- // adexchangeseller#preferredDeals.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PreferredDeals) MarshalJSON() ([]byte, error) {
- type noMethod PreferredDeals
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Report struct {
- // Averages: The averages of the report. This is the same length as any
- // other row in the report; cells corresponding to dimension columns are
- // empty.
- Averages []string `json:"averages,omitempty"`
-
- // Headers: The header information of the columns requested in the
- // report. This is a list of headers; one for each dimension in the
- // request, followed by one for each metric in the request.
- Headers []*ReportHeaders `json:"headers,omitempty"`
-
- // Kind: Kind this is, in this case adexchangeseller#report.
- Kind string `json:"kind,omitempty"`
-
- // Rows: The output rows of the report. Each row is a list of cells; one
- // for each dimension in the request, followed by one for each metric in
- // the request. The dimension cells contain strings, and the metric
- // cells contain numbers.
- Rows [][]string `json:"rows,omitempty"`
-
- // TotalMatchedRows: The total number of rows matched by the report
- // request. Fewer rows may be returned in the response due to being
- // limited by the row count requested or the report row limit.
- TotalMatchedRows int64 `json:"totalMatchedRows,omitempty,string"`
-
- // Totals: The totals of the report. This is the same length as any
- // other row in the report; cells corresponding to dimension columns are
- // empty.
- Totals []string `json:"totals,omitempty"`
-
- // Warnings: Any warnings associated with generation of the report.
- Warnings []string `json:"warnings,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Averages") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Report) MarshalJSON() ([]byte, error) {
- type noMethod Report
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ReportHeaders struct {
- // Currency: The currency of this column. Only present if the header
- // type is METRIC_CURRENCY.
- Currency string `json:"currency,omitempty"`
-
- // Name: The name of the header.
- Name string `json:"name,omitempty"`
-
- // Type: The type of the header; one of DIMENSION, METRIC_TALLY,
- // METRIC_RATIO, or METRIC_CURRENCY.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Currency") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportHeaders) MarshalJSON() ([]byte, error) {
- type noMethod ReportHeaders
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ReportingMetadataEntry struct {
- // CompatibleDimensions: For metrics this is a list of dimension IDs
- // which the metric is compatible with, for dimensions it is a list of
- // compatibility groups the dimension belongs to.
- CompatibleDimensions []string `json:"compatibleDimensions,omitempty"`
-
- // CompatibleMetrics: The names of the metrics the dimension or metric
- // this reporting metadata entry describes is compatible with.
- CompatibleMetrics []string `json:"compatibleMetrics,omitempty"`
-
- // Id: Unique identifier of this reporting metadata entry, corresponding
- // to the name of the appropriate dimension or metric.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case
- // adexchangeseller#reportingMetadataEntry.
- Kind string `json:"kind,omitempty"`
-
- // RequiredDimensions: The names of the dimensions which the dimension
- // or metric this reporting metadata entry describes requires to also be
- // present in order for the report to be valid. Omitting these will not
- // cause an error or warning, but may result in data which cannot be
- // correctly interpreted.
- RequiredDimensions []string `json:"requiredDimensions,omitempty"`
-
- // RequiredMetrics: The names of the metrics which the dimension or
- // metric this reporting metadata entry describes requires to also be
- // present in order for the report to be valid. Omitting these will not
- // cause an error or warning, but may result in data which cannot be
- // correctly interpreted.
- RequiredMetrics []string `json:"requiredMetrics,omitempty"`
-
- // SupportedProducts: The codes of the projects supported by the
- // dimension or metric this reporting metadata entry describes.
- SupportedProducts []string `json:"supportedProducts,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "CompatibleDimensions") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportingMetadataEntry) MarshalJSON() ([]byte, error) {
- type noMethod ReportingMetadataEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type SavedReport struct {
- // Id: Unique identifier of this saved report.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case
- // adexchangeseller#savedReport.
- Kind string `json:"kind,omitempty"`
-
- // Name: This saved report's name.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SavedReport) MarshalJSON() ([]byte, error) {
- type noMethod SavedReport
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type SavedReports struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The saved reports returned in this list response.
- Items []*SavedReport `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case
- // adexchangeseller#savedReports.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through saved reports.
- // To retrieve the next page of results, set the next request's
- // "pageToken" value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SavedReports) MarshalJSON() ([]byte, error) {
- type noMethod SavedReports
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UrlChannel struct {
- // Id: Unique identifier of this URL channel. This should be considered
- // an opaque identifier; it is not safe to rely on it being in any
- // particular format.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case
- // adexchangeseller#urlChannel.
- Kind string `json:"kind,omitempty"`
-
- // UrlPattern: URL Pattern of this URL channel. Does not include
- // "http://" or "https://". Example: www.example.com/home
- UrlPattern string `json:"urlPattern,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlChannel) MarshalJSON() ([]byte, error) {
- type noMethod UrlChannel
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UrlChannels struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The URL channels returned in this list response.
- Items []*UrlChannel `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case
- // adexchangeseller#urlChannels.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through URL channels.
- // To retrieve the next page of results, set the next request's
- // "pageToken" value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlChannels) MarshalJSON() ([]byte, error) {
- type noMethod UrlChannels
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "adexchangeseller.accounts.get":
-
-type AccountsGetCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get information about the selected Ad Exchange account.
-func (r *AccountsService) Get(accountId string) *AccountsGetCall {
- c := &AccountsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsGetCall) Fields(s ...googleapi.Field) *AccountsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsGetCall) IfNoneMatch(entityTag string) *AccountsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsGetCall) Context(ctx context.Context) *AccountsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.accounts.get" call.
-// Exactly one of *Account or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Account.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsGetCall) Do() (*Account, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Account{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get information about the selected Ad Exchange account.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.accounts.get",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to get information about. Tip: 'myaccount' is a valid ID.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}",
- // "response": {
- // "$ref": "Account"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.accounts.list":
-
-type AccountsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all accounts available to this Ad Exchange account.
-func (r *AccountsService) List() *AccountsListCall {
- c := &AccountsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of accounts to include in the response, used for paging.
-func (c *AccountsListCall) MaxResults(maxResults int64) *AccountsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through accounts. To retrieve the next page, set
-// this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AccountsListCall) PageToken(pageToken string) *AccountsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsListCall) Fields(s ...googleapi.Field) *AccountsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsListCall) IfNoneMatch(entityTag string) *AccountsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsListCall) Context(ctx context.Context) *AccountsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.accounts.list" call.
-// Exactly one of *Accounts or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Accounts.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccountsListCall) Do() (*Accounts, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Accounts{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all accounts available to this Ad Exchange account.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.accounts.list",
- // "parameters": {
- // "maxResults": {
- // "description": "The maximum number of accounts to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through accounts. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts",
- // "response": {
- // "$ref": "Accounts"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.accounts.adclients.list":
-
-type AccountsAdclientsListCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all ad clients in this Ad Exchange account.
-func (r *AccountsAdclientsService) List(accountId string) *AccountsAdclientsListCall {
- c := &AccountsAdclientsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of ad clients to include in the response, used for paging.
-func (c *AccountsAdclientsListCall) MaxResults(maxResults int64) *AccountsAdclientsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad clients. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AccountsAdclientsListCall) PageToken(pageToken string) *AccountsAdclientsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAdclientsListCall) Fields(s ...googleapi.Field) *AccountsAdclientsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsAdclientsListCall) IfNoneMatch(entityTag string) *AccountsAdclientsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAdclientsListCall) Context(ctx context.Context) *AccountsAdclientsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAdclientsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.accounts.adclients.list" call.
-// Exactly one of *AdClients or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AdClients.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccountsAdclientsListCall) Do() (*AdClients, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdClients{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all ad clients in this Ad Exchange account.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.accounts.adclients.list",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the ad client belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of ad clients to include in the response, used for paging.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients",
- // "response": {
- // "$ref": "AdClients"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.accounts.alerts.list":
-
-type AccountsAlertsListCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List the alerts for this Ad Exchange account.
-func (r *AccountsAlertsService) List(accountId string) *AccountsAlertsListCall {
- c := &AccountsAlertsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// Locale sets the optional parameter "locale": The locale to use for
-// translating alert messages. The account locale will be used if this
-// is not supplied. The AdSense default (English) will be used if the
-// supplied locale is invalid or unsupported.
-func (c *AccountsAlertsListCall) Locale(locale string) *AccountsAlertsListCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAlertsListCall) Fields(s ...googleapi.Field) *AccountsAlertsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsAlertsListCall) IfNoneMatch(entityTag string) *AccountsAlertsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAlertsListCall) Context(ctx context.Context) *AccountsAlertsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAlertsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/alerts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.accounts.alerts.list" call.
-// Exactly one of *Alerts or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Alerts.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsAlertsListCall) Do() (*Alerts, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Alerts{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List the alerts for this Ad Exchange account.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.accounts.alerts.list",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account owning the alerts.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "locale": {
- // "description": "The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/alerts",
- // "response": {
- // "$ref": "Alerts"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.accounts.customchannels.get":
-
-type AccountsCustomchannelsGetCall struct {
- s *Service
- accountId string
- adClientId string
- customChannelId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get the specified custom channel from the specified ad client.
-func (r *AccountsCustomchannelsService) Get(accountId string, adClientId string, customChannelId string) *AccountsCustomchannelsGetCall {
- c := &AccountsCustomchannelsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- c.customChannelId = customChannelId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsCustomchannelsGetCall) Fields(s ...googleapi.Field) *AccountsCustomchannelsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsCustomchannelsGetCall) IfNoneMatch(entityTag string) *AccountsCustomchannelsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsCustomchannelsGetCall) Context(ctx context.Context) *AccountsCustomchannelsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsCustomchannelsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- "customChannelId": c.customChannelId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.accounts.customchannels.get" call.
-// Exactly one of *CustomChannel or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannel.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountsCustomchannelsGetCall) Do() (*CustomChannel, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannel{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get the specified custom channel from the specified ad client.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.accounts.customchannels.get",
- // "parameterOrder": [
- // "accountId",
- // "adClientId",
- // "customChannelId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the ad client belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client which contains the custom channel.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "customChannelId": {
- // "description": "Custom channel to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}",
- // "response": {
- // "$ref": "CustomChannel"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.accounts.customchannels.list":
-
-type AccountsCustomchannelsListCall struct {
- s *Service
- accountId string
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all custom channels in the specified ad client for this Ad
-// Exchange account.
-func (r *AccountsCustomchannelsService) List(accountId string, adClientId string) *AccountsCustomchannelsListCall {
- c := &AccountsCustomchannelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of custom channels to include in the response, used for
-// paging.
-func (c *AccountsCustomchannelsListCall) MaxResults(maxResults int64) *AccountsCustomchannelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through custom channels. To retrieve the next
-// page, set this parameter to the value of "nextPageToken" from the
-// previous response.
-func (c *AccountsCustomchannelsListCall) PageToken(pageToken string) *AccountsCustomchannelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsCustomchannelsListCall) Fields(s ...googleapi.Field) *AccountsCustomchannelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsCustomchannelsListCall) IfNoneMatch(entityTag string) *AccountsCustomchannelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsCustomchannelsListCall) Context(ctx context.Context) *AccountsCustomchannelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsCustomchannelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/customchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.accounts.customchannels.list" call.
-// Exactly one of *CustomChannels or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannels.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountsCustomchannelsListCall) Do() (*CustomChannels, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannels{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all custom channels in the specified ad client for this Ad Exchange account.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.accounts.customchannels.list",
- // "parameterOrder": [
- // "accountId",
- // "adClientId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the ad client belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client for which to list custom channels.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of custom channels to include in the response, used for paging.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/customchannels",
- // "response": {
- // "$ref": "CustomChannels"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.accounts.metadata.dimensions.list":
-
-type AccountsMetadataDimensionsListCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List the metadata for the dimensions available to this
-// AdExchange account.
-func (r *AccountsMetadataDimensionsService) List(accountId string) *AccountsMetadataDimensionsListCall {
- c := &AccountsMetadataDimensionsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsMetadataDimensionsListCall) Fields(s ...googleapi.Field) *AccountsMetadataDimensionsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsMetadataDimensionsListCall) IfNoneMatch(entityTag string) *AccountsMetadataDimensionsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsMetadataDimensionsListCall) Context(ctx context.Context) *AccountsMetadataDimensionsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsMetadataDimensionsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/metadata/dimensions")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.accounts.metadata.dimensions.list" call.
-// Exactly one of *Metadata or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Metadata.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccountsMetadataDimensionsListCall) Do() (*Metadata, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Metadata{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List the metadata for the dimensions available to this AdExchange account.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.accounts.metadata.dimensions.list",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account with visibility to the dimensions.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/metadata/dimensions",
- // "response": {
- // "$ref": "Metadata"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.accounts.metadata.metrics.list":
-
-type AccountsMetadataMetricsListCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List the metadata for the metrics available to this AdExchange
-// account.
-func (r *AccountsMetadataMetricsService) List(accountId string) *AccountsMetadataMetricsListCall {
- c := &AccountsMetadataMetricsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsMetadataMetricsListCall) Fields(s ...googleapi.Field) *AccountsMetadataMetricsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsMetadataMetricsListCall) IfNoneMatch(entityTag string) *AccountsMetadataMetricsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsMetadataMetricsListCall) Context(ctx context.Context) *AccountsMetadataMetricsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsMetadataMetricsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/metadata/metrics")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.accounts.metadata.metrics.list" call.
-// Exactly one of *Metadata or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Metadata.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccountsMetadataMetricsListCall) Do() (*Metadata, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Metadata{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List the metadata for the metrics available to this AdExchange account.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.accounts.metadata.metrics.list",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account with visibility to the metrics.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/metadata/metrics",
- // "response": {
- // "$ref": "Metadata"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.accounts.preferreddeals.get":
-
-type AccountsPreferreddealsGetCall struct {
- s *Service
- accountId string
- dealId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get information about the selected Ad Exchange Preferred Deal.
-func (r *AccountsPreferreddealsService) Get(accountId string, dealId string) *AccountsPreferreddealsGetCall {
- c := &AccountsPreferreddealsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.dealId = dealId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsPreferreddealsGetCall) Fields(s ...googleapi.Field) *AccountsPreferreddealsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsPreferreddealsGetCall) IfNoneMatch(entityTag string) *AccountsPreferreddealsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsPreferreddealsGetCall) Context(ctx context.Context) *AccountsPreferreddealsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsPreferreddealsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/preferreddeals/{dealId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "dealId": c.dealId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.accounts.preferreddeals.get" call.
-// Exactly one of *PreferredDeal or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *PreferredDeal.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountsPreferreddealsGetCall) Do() (*PreferredDeal, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PreferredDeal{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get information about the selected Ad Exchange Preferred Deal.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.accounts.preferreddeals.get",
- // "parameterOrder": [
- // "accountId",
- // "dealId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account owning the deal.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "dealId": {
- // "description": "Preferred deal to get information about.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/preferreddeals/{dealId}",
- // "response": {
- // "$ref": "PreferredDeal"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.accounts.preferreddeals.list":
-
-type AccountsPreferreddealsListCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List the preferred deals for this Ad Exchange account.
-func (r *AccountsPreferreddealsService) List(accountId string) *AccountsPreferreddealsListCall {
- c := &AccountsPreferreddealsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsPreferreddealsListCall) Fields(s ...googleapi.Field) *AccountsPreferreddealsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsPreferreddealsListCall) IfNoneMatch(entityTag string) *AccountsPreferreddealsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsPreferreddealsListCall) Context(ctx context.Context) *AccountsPreferreddealsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsPreferreddealsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/preferreddeals")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.accounts.preferreddeals.list" call.
-// Exactly one of *PreferredDeals or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *PreferredDeals.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountsPreferreddealsListCall) Do() (*PreferredDeals, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PreferredDeals{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List the preferred deals for this Ad Exchange account.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.accounts.preferreddeals.list",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account owning the deals.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/preferreddeals",
- // "response": {
- // "$ref": "PreferredDeals"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.accounts.reports.generate":
-
-type AccountsReportsGenerateCall struct {
- s *Service
- accountId string
- startDate string
- endDate string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Generate: Generate an Ad Exchange report based on the report request
-// sent in the query parameters. Returns the result as JSON; to retrieve
-// output in CSV format specify "alt=csv" as a query parameter.
-func (r *AccountsReportsService) Generate(accountId string, startDate string, endDate string) *AccountsReportsGenerateCall {
- c := &AccountsReportsGenerateCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.startDate = startDate
- c.endDate = endDate
- return c
-}
-
-// Dimension sets the optional parameter "dimension": Dimensions to base
-// the report on.
-func (c *AccountsReportsGenerateCall) Dimension(dimension string) *AccountsReportsGenerateCall {
- c.opt_["dimension"] = dimension
- return c
-}
-
-// Filter sets the optional parameter "filter": Filters to be run on the
-// report.
-func (c *AccountsReportsGenerateCall) Filter(filter string) *AccountsReportsGenerateCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// Locale sets the optional parameter "locale": Optional locale to use
-// for translating report output to a local language. Defaults to
-// "en_US" if not specified.
-func (c *AccountsReportsGenerateCall) Locale(locale string) *AccountsReportsGenerateCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of rows of report data to return.
-func (c *AccountsReportsGenerateCall) MaxResults(maxResults int64) *AccountsReportsGenerateCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// Metric sets the optional parameter "metric": Numeric columns to
-// include in the report.
-func (c *AccountsReportsGenerateCall) Metric(metric string) *AccountsReportsGenerateCall {
- c.opt_["metric"] = metric
- return c
-}
-
-// Sort sets the optional parameter "sort": The name of a dimension or
-// metric to sort the resulting report on, optionally prefixed with "+"
-// to sort ascending or "-" to sort descending. If no prefix is
-// specified, the column is sorted ascending.
-func (c *AccountsReportsGenerateCall) Sort(sort string) *AccountsReportsGenerateCall {
- c.opt_["sort"] = sort
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex": Index of the
-// first row of report data to return.
-func (c *AccountsReportsGenerateCall) StartIndex(startIndex int64) *AccountsReportsGenerateCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsReportsGenerateCall) Fields(s ...googleapi.Field) *AccountsReportsGenerateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsReportsGenerateCall) IfNoneMatch(entityTag string) *AccountsReportsGenerateCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do and Download methods.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsReportsGenerateCall) Context(ctx context.Context) *AccountsReportsGenerateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsReportsGenerateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("endDate", fmt.Sprintf("%v", c.endDate))
- params.Set("startDate", fmt.Sprintf("%v", c.startDate))
- if v, ok := c.opt_["dimension"]; ok {
- params.Set("dimension", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["metric"]; ok {
- params.Set("metric", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sort"]; ok {
- params.Set("sort", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/reports")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Download fetches the API endpoint's "media" value, instead of the normal
-// API response value. If the returned error is nil, the Response is guaranteed to
-// have a 2xx status code. Callers must close the Response.Body as usual.
-func (c *AccountsReportsGenerateCall) Download() (*http.Response, error) {
- res, err := c.doRequest("media")
- if err != nil {
- return nil, err
- }
- if err := googleapi.CheckMediaResponse(res); err != nil {
- res.Body.Close()
- return nil, err
- }
- return res, nil
-}
-
-// Do executes the "adexchangeseller.accounts.reports.generate" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsReportsGenerateCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Generate an Ad Exchange report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.accounts.reports.generate",
- // "parameterOrder": [
- // "accountId",
- // "startDate",
- // "endDate"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account which owns the generated report.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "dimension": {
- // "description": "Dimensions to base the report on.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "endDate": {
- // "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- // "location": "query",
- // "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- // "required": true,
- // "type": "string"
- // },
- // "filter": {
- // "description": "Filters to be run on the report.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+(==|=@).+",
- // "repeated": true,
- // "type": "string"
- // },
- // "locale": {
- // "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of rows of report data to return.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "50000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "metric": {
- // "description": "Numeric columns to include in the report.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "sort": {
- // "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
- // "location": "query",
- // "pattern": "(\\+|-)?[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "startDate": {
- // "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- // "location": "query",
- // "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- // "required": true,
- // "type": "string"
- // },
- // "startIndex": {
- // "description": "Index of the first row of report data to return.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "5000",
- // "minimum": "0",
- // "type": "integer"
- // }
- // },
- // "path": "accounts/{accountId}/reports",
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ],
- // "supportsMediaDownload": true
- // }
-
-}
-
-// method id "adexchangeseller.accounts.reports.saved.generate":
-
-type AccountsReportsSavedGenerateCall struct {
- s *Service
- accountId string
- savedReportId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Generate: Generate an Ad Exchange report based on the saved report ID
-// sent in the query parameters.
-func (r *AccountsReportsSavedService) Generate(accountId string, savedReportId string) *AccountsReportsSavedGenerateCall {
- c := &AccountsReportsSavedGenerateCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.savedReportId = savedReportId
- return c
-}
-
-// Locale sets the optional parameter "locale": Optional locale to use
-// for translating report output to a local language. Defaults to
-// "en_US" if not specified.
-func (c *AccountsReportsSavedGenerateCall) Locale(locale string) *AccountsReportsSavedGenerateCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of rows of report data to return.
-func (c *AccountsReportsSavedGenerateCall) MaxResults(maxResults int64) *AccountsReportsSavedGenerateCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex": Index of the
-// first row of report data to return.
-func (c *AccountsReportsSavedGenerateCall) StartIndex(startIndex int64) *AccountsReportsSavedGenerateCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsReportsSavedGenerateCall) Fields(s ...googleapi.Field) *AccountsReportsSavedGenerateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsReportsSavedGenerateCall) IfNoneMatch(entityTag string) *AccountsReportsSavedGenerateCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsReportsSavedGenerateCall) Context(ctx context.Context) *AccountsReportsSavedGenerateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsReportsSavedGenerateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/reports/{savedReportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "savedReportId": c.savedReportId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.accounts.reports.saved.generate" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsReportsSavedGenerateCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Generate an Ad Exchange report based on the saved report ID sent in the query parameters.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.accounts.reports.saved.generate",
- // "parameterOrder": [
- // "accountId",
- // "savedReportId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account owning the saved report.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "locale": {
- // "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of rows of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "50000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "savedReportId": {
- // "description": "The saved report to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "startIndex": {
- // "description": "Index of the first row of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "5000",
- // "minimum": "0",
- // "type": "integer"
- // }
- // },
- // "path": "accounts/{accountId}/reports/{savedReportId}",
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.accounts.reports.saved.list":
-
-type AccountsReportsSavedListCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all saved reports in this Ad Exchange account.
-func (r *AccountsReportsSavedService) List(accountId string) *AccountsReportsSavedListCall {
- c := &AccountsReportsSavedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of saved reports to include in the response, used for paging.
-func (c *AccountsReportsSavedListCall) MaxResults(maxResults int64) *AccountsReportsSavedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through saved reports. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AccountsReportsSavedListCall) PageToken(pageToken string) *AccountsReportsSavedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsReportsSavedListCall) Fields(s ...googleapi.Field) *AccountsReportsSavedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsReportsSavedListCall) IfNoneMatch(entityTag string) *AccountsReportsSavedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsReportsSavedListCall) Context(ctx context.Context) *AccountsReportsSavedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsReportsSavedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/reports/saved")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.accounts.reports.saved.list" call.
-// Exactly one of *SavedReports or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *SavedReports.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccountsReportsSavedListCall) Do() (*SavedReports, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SavedReports{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all saved reports in this Ad Exchange account.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.accounts.reports.saved.list",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account owning the saved reports.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of saved reports to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "100",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/reports/saved",
- // "response": {
- // "$ref": "SavedReports"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
-
-// method id "adexchangeseller.accounts.urlchannels.list":
-
-type AccountsUrlchannelsListCall struct {
- s *Service
- accountId string
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all URL channels in the specified ad client for this Ad
-// Exchange account.
-func (r *AccountsUrlchannelsService) List(accountId string, adClientId string) *AccountsUrlchannelsListCall {
- c := &AccountsUrlchannelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of URL channels to include in the response, used for paging.
-func (c *AccountsUrlchannelsListCall) MaxResults(maxResults int64) *AccountsUrlchannelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through URL channels. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AccountsUrlchannelsListCall) PageToken(pageToken string) *AccountsUrlchannelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsUrlchannelsListCall) Fields(s ...googleapi.Field) *AccountsUrlchannelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsUrlchannelsListCall) IfNoneMatch(entityTag string) *AccountsUrlchannelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsUrlchannelsListCall) Context(ctx context.Context) *AccountsUrlchannelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsUrlchannelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/urlchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adexchangeseller.accounts.urlchannels.list" call.
-// Exactly one of *UrlChannels or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UrlChannels.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccountsUrlchannelsListCall) Do() (*UrlChannels, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UrlChannels{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all URL channels in the specified ad client for this Ad Exchange account.",
- // "httpMethod": "GET",
- // "id": "adexchangeseller.accounts.urlchannels.list",
- // "parameterOrder": [
- // "accountId",
- // "adClientId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the ad client belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client for which to list URL channels.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of URL channels to include in the response, used for paging.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/urlchannels",
- // "response": {
- // "$ref": "UrlChannels"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adexchange.seller",
- // "https://www.googleapis.com/auth/adexchange.seller.readonly"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/admin/datatransfer/v1/admin-api.json b/vendor/google.golang.org/api/admin/datatransfer/v1/admin-api.json
deleted file mode 100644
index 68b8fdca..00000000
--- a/vendor/google.golang.org/api/admin/datatransfer/v1/admin-api.json
+++ /dev/null
@@ -1,411 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/fIZK26KtD09fXt5m9JygrSOR194\"",
- "discoveryVersion": "v1",
- "id": "admin:datatransfer_v1",
- "name": "admin",
- "canonicalName": "DataTransfer",
- "version": "datatransfer_v1",
- "revision": "20150917",
- "title": "Admin Data Transfer API",
- "description": "Admin Data Transfer API lets you transfer user data from one user to another.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "packagePath": "admin",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/admin-sdk/data-transfer/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/admin/datatransfer/v1/",
- "basePath": "/admin/datatransfer/v1/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "admin/datatransfer/v1/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/admin.datatransfer": {
- "description": "View and manage data transfers between users in your organization"
- },
- "https://www.googleapis.com/auth/admin.datatransfer.readonly": {
- "description": "View data transfers between users in your organization"
- }
- }
- }
- },
- "schemas": {
- "Application": {
- "id": "Application",
- "type": "object",
- "description": "The JSON template for an Application resource.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "Etag of the resource."
- },
- "id": {
- "type": "string",
- "description": "The application's ID.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies the resource as a DataTransfer Application Resource.",
- "default": "admin#datatransfer#ApplicationResource"
- },
- "name": {
- "type": "string",
- "description": "The application's name."
- },
- "transferParams": {
- "type": "array",
- "description": "The list of all possible transfer parameters for this application. These parameters can be used to select the data of the user in this application to be transfered.",
- "items": {
- "$ref": "ApplicationTransferParam"
- }
- }
- }
- },
- "ApplicationDataTransfer": {
- "id": "ApplicationDataTransfer",
- "type": "object",
- "description": "Template to map fields of ApplicationDataTransfer resource.",
- "properties": {
- "applicationId": {
- "type": "string",
- "description": "The application's ID.",
- "format": "int64"
- },
- "applicationTransferParams": {
- "type": "array",
- "description": "The transfer parameters for the application. These parameters are used to select the data which will get transfered in context of this application.",
- "items": {
- "$ref": "ApplicationTransferParam"
- }
- },
- "applicationTransferStatus": {
- "type": "string",
- "description": "Current status of transfer for this application. (Read-only)"
- }
- }
- },
- "ApplicationTransferParam": {
- "id": "ApplicationTransferParam",
- "type": "object",
- "description": "Template for application transfer parameters.",
- "properties": {
- "key": {
- "type": "string",
- "description": "The type of the transfer parameter. eg: 'PRIVACY_LEVEL'"
- },
- "value": {
- "type": "array",
- "description": "The value of the coressponding transfer parameter. eg: 'PRIVATE' or 'SHARED'",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "ApplicationsListResponse": {
- "id": "ApplicationsListResponse",
- "type": "object",
- "description": "Template for a collection of Applications.",
- "properties": {
- "applications": {
- "type": "array",
- "description": "List of applications that support data transfer and are also installed for the customer.",
- "items": {
- "$ref": "Application"
- }
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Identifies the resource as a collection of Applications.",
- "default": "admin#datatransfer#applicationsList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token which will be used to specify next page in list API."
- }
- }
- },
- "DataTransfer": {
- "id": "DataTransfer",
- "type": "object",
- "description": "The JSON template for a DataTransfer resource.",
- "properties": {
- "applicationDataTransfers": {
- "type": "array",
- "description": "List of per application data transfer resources. It contains data transfer details of the applications associated with this transfer resource. Note that this list is also used to specify the applications for which data transfer has to be done at the time of the transfer resource creation.",
- "items": {
- "$ref": "ApplicationDataTransfer"
- }
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "id": {
- "type": "string",
- "description": "The transfer's ID (Read-only)."
- },
- "kind": {
- "type": "string",
- "description": "Identifies the resource as a DataTransfer request.",
- "default": "admin#datatransfer#DataTransfer"
- },
- "newOwnerUserId": {
- "type": "string",
- "description": "ID of the user to whom the data is being transfered."
- },
- "oldOwnerUserId": {
- "type": "string",
- "description": "ID of the user whose data is being transfered."
- },
- "overallTransferStatusCode": {
- "type": "string",
- "description": "Overall transfer status (Read-only)."
- },
- "requestTime": {
- "type": "string",
- "description": "The time at which the data transfer was requested (Read-only).",
- "format": "date-time"
- }
- }
- },
- "DataTransfersListResponse": {
- "id": "DataTransfersListResponse",
- "type": "object",
- "description": "Template for a collection of DataTransfer resources.",
- "properties": {
- "dataTransfers": {
- "type": "array",
- "description": "List of data transfer requests.",
- "items": {
- "$ref": "DataTransfer"
- }
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Identifies the resource as a collection of data transfer requests.",
- "default": "admin#datatransfer#dataTransfersList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token which will be used to specify next page in list API."
- }
- }
- }
- },
- "resources": {
- "applications": {
- "methods": {
- "get": {
- "id": "datatransfer.applications.get",
- "path": "applications/{applicationId}",
- "httpMethod": "GET",
- "description": "Retrieves information about an application for the given application ID.",
- "parameters": {
- "applicationId": {
- "type": "string",
- "description": "ID of the application resource to be retrieved.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "applicationId"
- ],
- "response": {
- "$ref": "Application"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.datatransfer",
- "https://www.googleapis.com/auth/admin.datatransfer.readonly"
- ]
- },
- "list": {
- "id": "datatransfer.applications.list",
- "path": "applications",
- "httpMethod": "GET",
- "description": "Lists the applications available for data transfer for a customer.",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable ID of the Google Apps account.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return. Default is 100.",
- "format": "uint32",
- "minimum": "1",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify next page in the list.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "ApplicationsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.datatransfer",
- "https://www.googleapis.com/auth/admin.datatransfer.readonly"
- ]
- }
- }
- },
- "transfers": {
- "methods": {
- "get": {
- "id": "datatransfer.transfers.get",
- "path": "transfers/{dataTransferId}",
- "httpMethod": "GET",
- "description": "Retrieves a data transfer request by its resource ID.",
- "parameters": {
- "dataTransferId": {
- "type": "string",
- "description": "ID of the resource to be retrieved. This is returned in the response from the insert method.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "dataTransferId"
- ],
- "response": {
- "$ref": "DataTransfer"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.datatransfer",
- "https://www.googleapis.com/auth/admin.datatransfer.readonly"
- ]
- },
- "insert": {
- "id": "datatransfer.transfers.insert",
- "path": "transfers",
- "httpMethod": "POST",
- "description": "Inserts a data transfer request.",
- "request": {
- "$ref": "DataTransfer"
- },
- "response": {
- "$ref": "DataTransfer"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.datatransfer"
- ]
- },
- "list": {
- "id": "datatransfer.transfers.list",
- "path": "transfers",
- "httpMethod": "GET",
- "description": "Lists the transfers for a customer by source user, destination user, or status.",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable ID of the Google Apps account.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return. Default is 100.",
- "format": "int32",
- "minimum": "1",
- "maximum": "500",
- "location": "query"
- },
- "newOwnerUserId": {
- "type": "string",
- "description": "Destination user's profile ID.",
- "location": "query"
- },
- "oldOwnerUserId": {
- "type": "string",
- "description": "Source user's profile ID.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify the next page in the list.",
- "location": "query"
- },
- "status": {
- "type": "string",
- "description": "Status of the transfer.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "DataTransfersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.datatransfer",
- "https://www.googleapis.com/auth/admin.datatransfer.readonly"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/admin/datatransfer/v1/admin-gen.go b/vendor/google.golang.org/api/admin/datatransfer/v1/admin-gen.go
deleted file mode 100644
index 1ba6e1f0..00000000
--- a/vendor/google.golang.org/api/admin/datatransfer/v1/admin-gen.go
+++ /dev/null
@@ -1,1050 +0,0 @@
-// Package admin provides access to the Admin Data Transfer API.
-//
-// See https://developers.google.com/admin-sdk/data-transfer/
-//
-// Usage example:
-//
-// import "google.golang.org/api/admin/datatransfer/v1"
-// ...
-// adminService, err := admin.New(oauthHttpClient)
-package admin // import "google.golang.org/api/admin/datatransfer/v1"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "admin:datatransfer_v1"
-const apiName = "admin"
-const apiVersion = "datatransfer_v1"
-const basePath = "https://www.googleapis.com/admin/datatransfer/v1/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage data transfers between users in your organization
- AdminDatatransferScope = "https://www.googleapis.com/auth/admin.datatransfer"
-
- // View data transfers between users in your organization
- AdminDatatransferReadonlyScope = "https://www.googleapis.com/auth/admin.datatransfer.readonly"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Applications = NewApplicationsService(s)
- s.Transfers = NewTransfersService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Applications *ApplicationsService
-
- Transfers *TransfersService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewApplicationsService(s *Service) *ApplicationsService {
- rs := &ApplicationsService{s: s}
- return rs
-}
-
-type ApplicationsService struct {
- s *Service
-}
-
-func NewTransfersService(s *Service) *TransfersService {
- rs := &TransfersService{s: s}
- return rs
-}
-
-type TransfersService struct {
- s *Service
-}
-
-// Application: The JSON template for an Application resource.
-type Application struct {
- // Etag: Etag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Id: The application's ID.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies the resource as a DataTransfer Application Resource.
- Kind string `json:"kind,omitempty"`
-
- // Name: The application's name.
- Name string `json:"name,omitempty"`
-
- // TransferParams: The list of all possible transfer parameters for this
- // application. These parameters can be used to select the data of the
- // user in this application to be transfered.
- TransferParams []*ApplicationTransferParam `json:"transferParams,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Application) MarshalJSON() ([]byte, error) {
- type noMethod Application
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ApplicationDataTransfer: Template to map fields of
-// ApplicationDataTransfer resource.
-type ApplicationDataTransfer struct {
- // ApplicationId: The application's ID.
- ApplicationId int64 `json:"applicationId,omitempty,string"`
-
- // ApplicationTransferParams: The transfer parameters for the
- // application. These parameters are used to select the data which will
- // get transfered in context of this application.
- ApplicationTransferParams []*ApplicationTransferParam `json:"applicationTransferParams,omitempty"`
-
- // ApplicationTransferStatus: Current status of transfer for this
- // application. (Read-only)
- ApplicationTransferStatus string `json:"applicationTransferStatus,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ApplicationId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ApplicationDataTransfer) MarshalJSON() ([]byte, error) {
- type noMethod ApplicationDataTransfer
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ApplicationTransferParam: Template for application transfer
-// parameters.
-type ApplicationTransferParam struct {
- // Key: The type of the transfer parameter. eg: 'PRIVACY_LEVEL'
- Key string `json:"key,omitempty"`
-
- // Value: The value of the coressponding transfer parameter. eg:
- // 'PRIVATE' or 'SHARED'
- Value []string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ApplicationTransferParam) MarshalJSON() ([]byte, error) {
- type noMethod ApplicationTransferParam
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ApplicationsListResponse: Template for a collection of Applications.
-type ApplicationsListResponse struct {
- // Applications: List of applications that support data transfer and are
- // also installed for the customer.
- Applications []*Application `json:"applications,omitempty"`
-
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Kind: Identifies the resource as a collection of Applications.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token which will be used to specify next
- // page in list API.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Applications") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ApplicationsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod ApplicationsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DataTransfer: The JSON template for a DataTransfer resource.
-type DataTransfer struct {
- // ApplicationDataTransfers: List of per application data transfer
- // resources. It contains data transfer details of the applications
- // associated with this transfer resource. Note that this list is also
- // used to specify the applications for which data transfer has to be
- // done at the time of the transfer resource creation.
- ApplicationDataTransfers []*ApplicationDataTransfer `json:"applicationDataTransfers,omitempty"`
-
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Id: The transfer's ID (Read-only).
- Id string `json:"id,omitempty"`
-
- // Kind: Identifies the resource as a DataTransfer request.
- Kind string `json:"kind,omitempty"`
-
- // NewOwnerUserId: ID of the user to whom the data is being transfered.
- NewOwnerUserId string `json:"newOwnerUserId,omitempty"`
-
- // OldOwnerUserId: ID of the user whose data is being transfered.
- OldOwnerUserId string `json:"oldOwnerUserId,omitempty"`
-
- // OverallTransferStatusCode: Overall transfer status (Read-only).
- OverallTransferStatusCode string `json:"overallTransferStatusCode,omitempty"`
-
- // RequestTime: The time at which the data transfer was requested
- // (Read-only).
- RequestTime string `json:"requestTime,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "ApplicationDataTransfers") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DataTransfer) MarshalJSON() ([]byte, error) {
- type noMethod DataTransfer
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DataTransfersListResponse: Template for a collection of DataTransfer
-// resources.
-type DataTransfersListResponse struct {
- // DataTransfers: List of data transfer requests.
- DataTransfers []*DataTransfer `json:"dataTransfers,omitempty"`
-
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Kind: Identifies the resource as a collection of data transfer
- // requests.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token which will be used to specify next
- // page in list API.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "DataTransfers") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DataTransfersListResponse) MarshalJSON() ([]byte, error) {
- type noMethod DataTransfersListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "datatransfer.applications.get":
-
-type ApplicationsGetCall struct {
- s *Service
- applicationId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves information about an application for the given
-// application ID.
-func (r *ApplicationsService) Get(applicationId int64) *ApplicationsGetCall {
- c := &ApplicationsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.applicationId = applicationId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ApplicationsGetCall) Fields(s ...googleapi.Field) *ApplicationsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ApplicationsGetCall) IfNoneMatch(entityTag string) *ApplicationsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ApplicationsGetCall) Context(ctx context.Context) *ApplicationsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ApplicationsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "applications/{applicationId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "applicationId": strconv.FormatInt(c.applicationId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "datatransfer.applications.get" call.
-// Exactly one of *Application or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Application.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ApplicationsGetCall) Do() (*Application, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Application{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves information about an application for the given application ID.",
- // "httpMethod": "GET",
- // "id": "datatransfer.applications.get",
- // "parameterOrder": [
- // "applicationId"
- // ],
- // "parameters": {
- // "applicationId": {
- // "description": "ID of the application resource to be retrieved.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "applications/{applicationId}",
- // "response": {
- // "$ref": "Application"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.datatransfer",
- // "https://www.googleapis.com/auth/admin.datatransfer.readonly"
- // ]
- // }
-
-}
-
-// method id "datatransfer.applications.list":
-
-type ApplicationsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists the applications available for data transfer for a
-// customer.
-func (r *ApplicationsService) List() *ApplicationsListCall {
- c := &ApplicationsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// CustomerId sets the optional parameter "customerId": Immutable ID of
-// the Google Apps account.
-func (c *ApplicationsListCall) CustomerId(customerId string) *ApplicationsListCall {
- c.opt_["customerId"] = customerId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return. Default is 100.
-func (c *ApplicationsListCall) MaxResults(maxResults int64) *ApplicationsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Token to specify
-// next page in the list.
-func (c *ApplicationsListCall) PageToken(pageToken string) *ApplicationsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ApplicationsListCall) Fields(s ...googleapi.Field) *ApplicationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ApplicationsListCall) IfNoneMatch(entityTag string) *ApplicationsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ApplicationsListCall) Context(ctx context.Context) *ApplicationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ApplicationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["customerId"]; ok {
- params.Set("customerId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "applications")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "datatransfer.applications.list" call.
-// Exactly one of *ApplicationsListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *ApplicationsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ApplicationsListCall) Do() (*ApplicationsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ApplicationsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists the applications available for data transfer for a customer.",
- // "httpMethod": "GET",
- // "id": "datatransfer.applications.list",
- // "parameters": {
- // "customerId": {
- // "description": "Immutable ID of the Google Apps account.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return. Default is 100.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Token to specify next page in the list.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "applications",
- // "response": {
- // "$ref": "ApplicationsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.datatransfer",
- // "https://www.googleapis.com/auth/admin.datatransfer.readonly"
- // ]
- // }
-
-}
-
-// method id "datatransfer.transfers.get":
-
-type TransfersGetCall struct {
- s *Service
- dataTransferId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves a data transfer request by its resource ID.
-func (r *TransfersService) Get(dataTransferId string) *TransfersGetCall {
- c := &TransfersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.dataTransferId = dataTransferId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TransfersGetCall) Fields(s ...googleapi.Field) *TransfersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TransfersGetCall) IfNoneMatch(entityTag string) *TransfersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TransfersGetCall) Context(ctx context.Context) *TransfersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TransfersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "transfers/{dataTransferId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "dataTransferId": c.dataTransferId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "datatransfer.transfers.get" call.
-// Exactly one of *DataTransfer or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *DataTransfer.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TransfersGetCall) Do() (*DataTransfer, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DataTransfer{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a data transfer request by its resource ID.",
- // "httpMethod": "GET",
- // "id": "datatransfer.transfers.get",
- // "parameterOrder": [
- // "dataTransferId"
- // ],
- // "parameters": {
- // "dataTransferId": {
- // "description": "ID of the resource to be retrieved. This is returned in the response from the insert method.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "transfers/{dataTransferId}",
- // "response": {
- // "$ref": "DataTransfer"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.datatransfer",
- // "https://www.googleapis.com/auth/admin.datatransfer.readonly"
- // ]
- // }
-
-}
-
-// method id "datatransfer.transfers.insert":
-
-type TransfersInsertCall struct {
- s *Service
- datatransfer *DataTransfer
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a data transfer request.
-func (r *TransfersService) Insert(datatransfer *DataTransfer) *TransfersInsertCall {
- c := &TransfersInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.datatransfer = datatransfer
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TransfersInsertCall) Fields(s ...googleapi.Field) *TransfersInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TransfersInsertCall) Context(ctx context.Context) *TransfersInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TransfersInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.datatransfer)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "transfers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "datatransfer.transfers.insert" call.
-// Exactly one of *DataTransfer or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *DataTransfer.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TransfersInsertCall) Do() (*DataTransfer, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DataTransfer{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a data transfer request.",
- // "httpMethod": "POST",
- // "id": "datatransfer.transfers.insert",
- // "path": "transfers",
- // "request": {
- // "$ref": "DataTransfer"
- // },
- // "response": {
- // "$ref": "DataTransfer"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.datatransfer"
- // ]
- // }
-
-}
-
-// method id "datatransfer.transfers.list":
-
-type TransfersListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists the transfers for a customer by source user, destination
-// user, or status.
-func (r *TransfersService) List() *TransfersListCall {
- c := &TransfersListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// CustomerId sets the optional parameter "customerId": Immutable ID of
-// the Google Apps account.
-func (c *TransfersListCall) CustomerId(customerId string) *TransfersListCall {
- c.opt_["customerId"] = customerId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return. Default is 100.
-func (c *TransfersListCall) MaxResults(maxResults int64) *TransfersListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// NewOwnerUserId sets the optional parameter "newOwnerUserId":
-// Destination user's profile ID.
-func (c *TransfersListCall) NewOwnerUserId(newOwnerUserId string) *TransfersListCall {
- c.opt_["newOwnerUserId"] = newOwnerUserId
- return c
-}
-
-// OldOwnerUserId sets the optional parameter "oldOwnerUserId": Source
-// user's profile ID.
-func (c *TransfersListCall) OldOwnerUserId(oldOwnerUserId string) *TransfersListCall {
- c.opt_["oldOwnerUserId"] = oldOwnerUserId
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Token to specify
-// the next page in the list.
-func (c *TransfersListCall) PageToken(pageToken string) *TransfersListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Status sets the optional parameter "status": Status of the transfer.
-func (c *TransfersListCall) Status(status string) *TransfersListCall {
- c.opt_["status"] = status
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TransfersListCall) Fields(s ...googleapi.Field) *TransfersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TransfersListCall) IfNoneMatch(entityTag string) *TransfersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TransfersListCall) Context(ctx context.Context) *TransfersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TransfersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["customerId"]; ok {
- params.Set("customerId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["newOwnerUserId"]; ok {
- params.Set("newOwnerUserId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["oldOwnerUserId"]; ok {
- params.Set("oldOwnerUserId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["status"]; ok {
- params.Set("status", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "transfers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "datatransfer.transfers.list" call.
-// Exactly one of *DataTransfersListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *DataTransfersListResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TransfersListCall) Do() (*DataTransfersListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DataTransfersListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists the transfers for a customer by source user, destination user, or status.",
- // "httpMethod": "GET",
- // "id": "datatransfer.transfers.list",
- // "parameters": {
- // "customerId": {
- // "description": "Immutable ID of the Google Apps account.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return. Default is 100.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "newOwnerUserId": {
- // "description": "Destination user's profile ID.",
- // "location": "query",
- // "type": "string"
- // },
- // "oldOwnerUserId": {
- // "description": "Source user's profile ID.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Token to specify the next page in the list.",
- // "location": "query",
- // "type": "string"
- // },
- // "status": {
- // "description": "Status of the transfer.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "transfers",
- // "response": {
- // "$ref": "DataTransfersListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.datatransfer",
- // "https://www.googleapis.com/auth/admin.datatransfer.readonly"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/admin/directory/v1/admin-api.json b/vendor/google.golang.org/api/admin/directory/v1/admin-api.json
deleted file mode 100644
index 3362b228..00000000
--- a/vendor/google.golang.org/api/admin/directory/v1/admin-api.json
+++ /dev/null
@@ -1,5311 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/pRlNMQbyfGTi-02uw0zCmogMSuU\"",
- "discoveryVersion": "v1",
- "id": "admin:directory_v1",
- "name": "admin",
- "canonicalName": "directory",
- "version": "directory_v1",
- "revision": "20151005",
- "title": "Admin Directory API",
- "description": "The Admin SDK Directory API lets you view and manage enterprise resources such as users and groups, administrative notifications, security features, and more.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "packagePath": "admin",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/admin-sdk/directory/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/admin/directory/v1/",
- "basePath": "/admin/directory/v1/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "admin/directory/v1/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/admin.directory.customer": {
- "description": "View and manage customer related information"
- },
- "https://www.googleapis.com/auth/admin.directory.customer.readonly": {
- "description": "View customer related information"
- },
- "https://www.googleapis.com/auth/admin.directory.device.chromeos": {
- "description": "View and manage your Chrome OS devices' metadata"
- },
- "https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly": {
- "description": "View your Chrome OS devices' metadata"
- },
- "https://www.googleapis.com/auth/admin.directory.device.mobile": {
- "description": "View and manage your mobile devices' metadata"
- },
- "https://www.googleapis.com/auth/admin.directory.device.mobile.action": {
- "description": "Manage your mobile devices by performing administrative tasks"
- },
- "https://www.googleapis.com/auth/admin.directory.device.mobile.readonly": {
- "description": "View your mobile devices' metadata"
- },
- "https://www.googleapis.com/auth/admin.directory.domain": {
- "description": "View and manage the provisioning of domains for your customers"
- },
- "https://www.googleapis.com/auth/admin.directory.domain.readonly": {
- "description": "View domains related to your customers"
- },
- "https://www.googleapis.com/auth/admin.directory.group": {
- "description": "View and manage the provisioning of groups on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.group.member": {
- "description": "View and manage group subscriptions on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.group.member.readonly": {
- "description": "View group subscriptions on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.group.readonly": {
- "description": "View groups on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.notifications": {
- "description": "View and manage notifications received on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.orgunit": {
- "description": "View and manage organization units on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.orgunit.readonly": {
- "description": "View organization units on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.rolemanagement": {
- "description": "Manage delegated admin roles for your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly": {
- "description": "View delegated admin roles for your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.user": {
- "description": "View and manage the provisioning of users on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.user.alias": {
- "description": "View and manage user aliases on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.user.alias.readonly": {
- "description": "View user aliases on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.user.readonly": {
- "description": "View users on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.user.security": {
- "description": "Manage data access permissions for users on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.userschema": {
- "description": "View and manage the provisioning of user schemas on your domain"
- },
- "https://www.googleapis.com/auth/admin.directory.userschema.readonly": {
- "description": "View user schemas on your domain"
- }
- }
- }
- },
- "schemas": {
- "Alias": {
- "id": "Alias",
- "type": "object",
- "description": "JSON template for Alias object in Directory API.",
- "properties": {
- "alias": {
- "type": "string",
- "description": "A alias email"
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "id": {
- "type": "string",
- "description": "Unique id of the group (Read-only) Unique id of the user (Read-only)"
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#alias"
- },
- "primaryEmail": {
- "type": "string",
- "description": "Group's primary email (Read-only) User's primary email (Read-only)"
- }
- }
- },
- "Aliases": {
- "id": "Aliases",
- "type": "object",
- "description": "JSON response template to list aliases in Directory API.",
- "properties": {
- "aliases": {
- "type": "array",
- "description": "List of alias objects.",
- "items": {
- "$ref": "Alias"
- }
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#aliases"
- }
- }
- },
- "Asp": {
- "id": "Asp",
- "type": "object",
- "description": "The template that returns individual ASP (Access Code) data.",
- "properties": {
- "codeId": {
- "type": "integer",
- "description": "The unique ID of the ASP.",
- "format": "int32"
- },
- "creationTime": {
- "type": "string",
- "description": "The time when the ASP was created. Expressed in Unix time format.",
- "format": "int64"
- },
- "etag": {
- "type": "string",
- "description": "ETag of the ASP."
- },
- "kind": {
- "type": "string",
- "description": "The type of the API resource. This is always admin#directory#asp.",
- "default": "admin#directory#asp"
- },
- "lastTimeUsed": {
- "type": "string",
- "description": "The time when the ASP was last used. Expressed in Unix time format.",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "The name of the application that the user, represented by their userId, entered when the ASP was created."
- },
- "userKey": {
- "type": "string",
- "description": "The unique ID of the user who issued the ASP."
- }
- }
- },
- "Asps": {
- "id": "Asps",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "items": {
- "type": "array",
- "description": "A list of ASP resources.",
- "items": {
- "$ref": "Asp"
- }
- },
- "kind": {
- "type": "string",
- "description": "The type of the API resource. This is always admin#directory#aspList.",
- "default": "admin#directory#aspList"
- }
- }
- },
- "Channel": {
- "id": "Channel",
- "type": "object",
- "description": "An notification channel used to watch for resource changes.",
- "properties": {
- "address": {
- "type": "string",
- "description": "The address where notifications are delivered for this channel."
- },
- "expiration": {
- "type": "string",
- "description": "Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "A UUID or similar unique string that identifies this channel."
- },
- "kind": {
- "type": "string",
- "description": "Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string \"api#channel\".",
- "default": "api#channel"
- },
- "params": {
- "type": "object",
- "description": "Additional parameters controlling delivery channel behavior. Optional.",
- "additionalProperties": {
- "type": "string",
- "description": "Declares a new parameter by name."
- }
- },
- "payload": {
- "type": "boolean",
- "description": "A Boolean value to indicate whether payload is wanted. Optional."
- },
- "resourceId": {
- "type": "string",
- "description": "An opaque ID that identifies the resource being watched on this channel. Stable across different API versions."
- },
- "resourceUri": {
- "type": "string",
- "description": "A version-specific identifier for the watched resource."
- },
- "token": {
- "type": "string",
- "description": "An arbitrary string delivered to the target address with each notification delivered over this channel. Optional."
- },
- "type": {
- "type": "string",
- "description": "The type of delivery mechanism used for this channel."
- }
- }
- },
- "ChromeOsDevice": {
- "id": "ChromeOsDevice",
- "type": "object",
- "description": "JSON template for Chrome Os Device resource in Directory API.",
- "properties": {
- "activeTimeRanges": {
- "type": "array",
- "description": "List of active time ranges (Read-only)",
- "items": {
- "type": "object",
- "properties": {
- "activeTime": {
- "type": "integer",
- "description": "Duration in milliseconds",
- "format": "int32"
- },
- "date": {
- "type": "string",
- "description": "Date of usage",
- "format": "date"
- }
- }
- }
- },
- "annotatedAssetId": {
- "type": "string",
- "description": "AssetId specified during enrollment or through later annotation"
- },
- "annotatedLocation": {
- "type": "string",
- "description": "Address or location of the device as noted by the administrator"
- },
- "annotatedUser": {
- "type": "string",
- "description": "User of the device"
- },
- "bootMode": {
- "type": "string",
- "description": "Chromebook boot mode (Read-only)"
- },
- "deviceId": {
- "type": "string",
- "description": "Unique identifier of Chrome OS Device (Read-only)"
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "ethernetMacAddress": {
- "type": "string",
- "description": "Chromebook Mac Address on ethernet network interface (Read-only)"
- },
- "firmwareVersion": {
- "type": "string",
- "description": "Chromebook firmware version (Read-only)"
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#chromeosdevice"
- },
- "lastEnrollmentTime": {
- "type": "string",
- "description": "Date and time the device was last enrolled (Read-only)",
- "format": "date-time"
- },
- "lastSync": {
- "type": "string",
- "description": "Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)",
- "format": "date-time"
- },
- "macAddress": {
- "type": "string",
- "description": "Chromebook Mac Address on wifi network interface (Read-only)"
- },
- "meid": {
- "type": "string",
- "description": "Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)"
- },
- "model": {
- "type": "string",
- "description": "Chromebook Model (Read-only)"
- },
- "notes": {
- "type": "string",
- "description": "Notes added by the administrator"
- },
- "orderNumber": {
- "type": "string",
- "description": "Chromebook order number (Read-only)"
- },
- "orgUnitPath": {
- "type": "string",
- "description": "OrgUnit of the device"
- },
- "osVersion": {
- "type": "string",
- "description": "Chromebook Os Version (Read-only)"
- },
- "platformVersion": {
- "type": "string",
- "description": "Chromebook platform version (Read-only)"
- },
- "recentUsers": {
- "type": "array",
- "description": "List of recent device users, in descending order by last login time (Read-only)",
- "items": {
- "type": "object",
- "properties": {
- "email": {
- "type": "string",
- "description": "Email address of the user. Present only if the user type is managed"
- },
- "type": {
- "type": "string",
- "description": "The type of the user"
- }
- }
- }
- },
- "serialNumber": {
- "type": "string",
- "description": "Chromebook serial number (Read-only)"
- },
- "status": {
- "type": "string",
- "description": "status of the device (Read-only)"
- },
- "supportEndDate": {
- "type": "string",
- "description": "Final date the device will be supported (Read-only)",
- "format": "date-time"
- },
- "willAutoRenew": {
- "type": "boolean",
- "description": "Will Chromebook auto renew after support end date (Read-only)"
- }
- }
- },
- "ChromeOsDevices": {
- "id": "ChromeOsDevices",
- "type": "object",
- "description": "JSON response template for List Chrome OS Devices operation in Directory API.",
- "properties": {
- "chromeosdevices": {
- "type": "array",
- "description": "List of Chrome OS Device objects.",
- "items": {
- "$ref": "ChromeOsDevice"
- }
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#chromeosdevices"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token used to access next page of this result."
- }
- }
- },
- "Customer": {
- "id": "Customer",
- "type": "object",
- "description": "JSON template for Customer Resource object in Directory API.",
- "properties": {
- "alternateEmail": {
- "type": "string",
- "description": "The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain"
- },
- "customerCreationTime": {
- "type": "string",
- "description": "The customer's creation time (Readonly)",
- "format": "date-time"
- },
- "customerDomain": {
- "type": "string",
- "description": "The customer's primary domain name string. Do not include the www prefix when creating a new customer."
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "id": {
- "type": "string",
- "description": "The unique ID for the customer's Google account. (Readonly)"
- },
- "kind": {
- "type": "string",
- "description": "Identifies the resource as a customer. Value: admin#directory#customer",
- "default": "admin#directory#customer"
- },
- "language": {
- "type": "string",
- "description": "The customer's ISO 639-2 language code. The default value is en-US"
- },
- "phoneNumber": {
- "type": "string",
- "description": "The customer's contact phone number in E.164 format."
- },
- "postalAddress": {
- "$ref": "CustomerPostalAddress",
- "description": "The customer's postal address information."
- }
- }
- },
- "CustomerPostalAddress": {
- "id": "CustomerPostalAddress",
- "type": "object",
- "description": "JSON template for postal address of a customer.",
- "properties": {
- "addressLine1": {
- "type": "string",
- "description": "A customer's physical address. The address can be composed of one to three lines."
- },
- "addressLine2": {
- "type": "string",
- "description": "Address line 2 of the address."
- },
- "addressLine3": {
- "type": "string",
- "description": "Address line 3 of the address."
- },
- "contactName": {
- "type": "string",
- "description": "The customer contact's name."
- },
- "countryCode": {
- "type": "string",
- "description": "This is a required property. For countryCode information see the ISO 3166 country code elements."
- },
- "locality": {
- "type": "string",
- "description": "Name of the locality. An example of a locality value is the city of San Francisco."
- },
- "organizationName": {
- "type": "string",
- "description": "The company or company division name."
- },
- "postalCode": {
- "type": "string",
- "description": "The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element."
- },
- "region": {
- "type": "string",
- "description": "Name of the region. An example of a region value is NY for the state of New York."
- }
- }
- },
- "DomainAlias": {
- "id": "DomainAlias",
- "type": "object",
- "description": "JSON template for Domain Alias object in Directory API.",
- "properties": {
- "creationTime": {
- "type": "string",
- "description": "The creation time of the domain alias. (Read-only).",
- "format": "int64"
- },
- "domainAliasName": {
- "type": "string",
- "description": "The domain alias name."
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#domainAlias"
- },
- "parentDomainName": {
- "type": "string",
- "description": "The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.",
- "annotations": {
- "required": [
- "directory.domains.insert"
- ]
- }
- },
- "verified": {
- "type": "boolean",
- "description": "Indicates the verification state of a domain alias. (Read-only)"
- }
- }
- },
- "DomainAliases": {
- "id": "DomainAliases",
- "type": "object",
- "description": "JSON response template to list domain aliases in Directory API.",
- "properties": {
- "domainAliases": {
- "type": "array",
- "description": "List of domain alias objects.",
- "items": {
- "$ref": "DomainAlias"
- }
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#domainAliases"
- }
- }
- },
- "Domains": {
- "id": "Domains",
- "type": "object",
- "description": "JSON template for Domain object in Directory API.",
- "properties": {
- "creationTime": {
- "type": "string",
- "description": "Creation time of the domain. (Read-only).",
- "format": "int64"
- },
- "domainAliases": {
- "type": "array",
- "description": "List of domain alias objects. (Read-only)",
- "items": {
- "$ref": "DomainAlias"
- }
- },
- "domainName": {
- "type": "string",
- "description": "The domain name of the customer.",
- "annotations": {
- "required": [
- "directory.domains.insert"
- ]
- }
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "isPrimary": {
- "type": "boolean",
- "description": "Indicates if the domain is a primary domain (Read-only)."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#domain"
- },
- "verified": {
- "type": "boolean",
- "description": "Indicates the verification state of a domain. (Read-only)."
- }
- }
- },
- "Domains2": {
- "id": "Domains2",
- "type": "object",
- "description": "JSON response template to list Domains in Directory API.",
- "properties": {
- "domains": {
- "type": "array",
- "description": "List of domain objects.",
- "items": {
- "$ref": "Domains"
- }
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#domains"
- }
- }
- },
- "Group": {
- "id": "Group",
- "type": "object",
- "description": "JSON template for Group resource in Directory API.",
- "properties": {
- "adminCreated": {
- "type": "boolean",
- "description": "Is the group created by admin (Read-only) *"
- },
- "aliases": {
- "type": "array",
- "description": "List of aliases (Read-only)",
- "items": {
- "type": "string"
- }
- },
- "description": {
- "type": "string",
- "description": "Description of the group"
- },
- "directMembersCount": {
- "type": "string",
- "description": "Group direct members count",
- "format": "int64"
- },
- "email": {
- "type": "string",
- "description": "Email of Group",
- "annotations": {
- "required": [
- "directory.groups.insert"
- ]
- }
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of Group (Read-only)"
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#group"
- },
- "name": {
- "type": "string",
- "description": "Group name"
- },
- "nonEditableAliases": {
- "type": "array",
- "description": "List of non editable aliases (Read-only)",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "Groups": {
- "id": "Groups",
- "type": "object",
- "description": "JSON response template for List Groups operation in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "groups": {
- "type": "array",
- "description": "List of group objects.",
- "items": {
- "$ref": "Group"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#groups"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token used to access next page of this result."
- }
- }
- },
- "Member": {
- "id": "Member",
- "type": "object",
- "description": "JSON template for Member resource in Directory API.",
- "properties": {
- "email": {
- "type": "string",
- "description": "Email of member (Read-only)"
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)"
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#member"
- },
- "role": {
- "type": "string",
- "description": "Role of member"
- },
- "type": {
- "type": "string",
- "description": "Type of member (Immutable)"
- }
- }
- },
- "Members": {
- "id": "Members",
- "type": "object",
- "description": "JSON response template for List Members operation in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#members"
- },
- "members": {
- "type": "array",
- "description": "List of member objects.",
- "items": {
- "$ref": "Member"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token used to access next page of this result."
- }
- }
- },
- "MobileDevice": {
- "id": "MobileDevice",
- "type": "object",
- "description": "JSON template for Mobile Device resource in Directory API.",
- "properties": {
- "adbStatus": {
- "type": "boolean",
- "description": "Adb (USB debugging) enabled or disabled on device (Read-only)"
- },
- "applications": {
- "type": "array",
- "description": "List of applications installed on Mobile Device",
- "items": {
- "type": "object",
- "properties": {
- "displayName": {
- "type": "string",
- "description": "Display name of application"
- },
- "packageName": {
- "type": "string",
- "description": "Package name of application"
- },
- "permission": {
- "type": "array",
- "description": "List of Permissions for application",
- "items": {
- "type": "string"
- }
- },
- "versionCode": {
- "type": "integer",
- "description": "Version code of application",
- "format": "int32"
- },
- "versionName": {
- "type": "string",
- "description": "Version name of application"
- }
- }
- }
- },
- "basebandVersion": {
- "type": "string",
- "description": "Mobile Device Baseband version (Read-only)"
- },
- "buildNumber": {
- "type": "string",
- "description": "Mobile Device Build number (Read-only)"
- },
- "defaultLanguage": {
- "type": "string",
- "description": "The default locale used on the Mobile Device (Read-only)"
- },
- "developerOptionsStatus": {
- "type": "boolean",
- "description": "Developer options enabled or disabled on device (Read-only)"
- },
- "deviceCompromisedStatus": {
- "type": "string",
- "description": "Mobile Device compromised status (Read-only)"
- },
- "deviceId": {
- "type": "string",
- "description": "Mobile Device serial number (Read-only)"
- },
- "email": {
- "type": "array",
- "description": "List of owner user's email addresses (Read-only)",
- "items": {
- "type": "string"
- }
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "firstSync": {
- "type": "string",
- "description": "Date and time the device was first synchronized with the policy settings in the Google Apps administrator control panel (Read-only)",
- "format": "date-time"
- },
- "hardwareId": {
- "type": "string",
- "description": "Mobile Device Hardware Id (Read-only)"
- },
- "imei": {
- "type": "string",
- "description": "Mobile Device IMEI number (Read-only)"
- },
- "kernelVersion": {
- "type": "string",
- "description": "Mobile Device Kernel version (Read-only)"
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#mobiledevice"
- },
- "lastSync": {
- "type": "string",
- "description": "Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)",
- "format": "date-time"
- },
- "managedAccountIsOnOwnerProfile": {
- "type": "boolean",
- "description": "Boolean indicating if this account is on owner/primary profile or not (Read-only)"
- },
- "meid": {
- "type": "string",
- "description": "Mobile Device MEID number (Read-only)"
- },
- "model": {
- "type": "string",
- "description": "Name of the model of the device"
- },
- "name": {
- "type": "array",
- "description": "List of owner user's names (Read-only)",
- "items": {
- "type": "string"
- }
- },
- "networkOperator": {
- "type": "string",
- "description": "Mobile Device mobile or network operator (if available) (Read-only)"
- },
- "os": {
- "type": "string",
- "description": "Name of the mobile operating system"
- },
- "otherAccountsInfo": {
- "type": "array",
- "description": "List of accounts added on device (Read-only)",
- "items": {
- "type": "string"
- }
- },
- "resourceId": {
- "type": "string",
- "description": "Unique identifier of Mobile Device (Read-only)"
- },
- "serialNumber": {
- "type": "string",
- "description": "Mobile Device SSN or Serial Number (Read-only)"
- },
- "status": {
- "type": "string",
- "description": "Status of the device (Read-only)"
- },
- "supportsWorkProfile": {
- "type": "boolean",
- "description": "Work profile supported on device (Read-only)"
- },
- "type": {
- "type": "string",
- "description": "The type of device (Read-only)"
- },
- "unknownSourcesStatus": {
- "type": "boolean",
- "description": "Unknown sources enabled or disabled on device (Read-only)"
- },
- "userAgent": {
- "type": "string",
- "description": "Mobile Device user agent"
- },
- "wifiMacAddress": {
- "type": "string",
- "description": "Mobile Device WiFi MAC address (Read-only)"
- }
- }
- },
- "MobileDeviceAction": {
- "id": "MobileDeviceAction",
- "type": "object",
- "description": "JSON request template for firing commands on Mobile Device in Directory Devices API.",
- "properties": {
- "action": {
- "type": "string",
- "description": "Action to be taken on the Mobile Device",
- "annotations": {
- "required": [
- "directory.mobiledevices.action"
- ]
- }
- }
- }
- },
- "MobileDevices": {
- "id": "MobileDevices",
- "type": "object",
- "description": "JSON response template for List Mobile Devices operation in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#mobiledevices"
- },
- "mobiledevices": {
- "type": "array",
- "description": "List of Mobile Device objects.",
- "items": {
- "$ref": "MobileDevice"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token used to access next page of this result."
- }
- }
- },
- "Notification": {
- "id": "Notification",
- "type": "object",
- "description": "Template for a notification resource.",
- "properties": {
- "body": {
- "type": "string",
- "description": "Body of the notification (Read-only)"
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "fromAddress": {
- "type": "string",
- "description": "Address from which the notification is received (Read-only)"
- },
- "isUnread": {
- "type": "boolean",
- "description": "Boolean indicating whether the notification is unread or not.",
- "annotations": {
- "required": [
- "directory.notifications.patch",
- "directory.notifications.update"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "The type of the resource.",
- "default": "admin#directory#notification"
- },
- "notificationId": {
- "type": "string"
- },
- "sendTime": {
- "type": "string",
- "description": "Time at which notification was sent (Read-only)",
- "format": "date-time"
- },
- "subject": {
- "type": "string",
- "description": "Subject of the notification (Read-only)"
- }
- }
- },
- "Notifications": {
- "id": "Notifications",
- "type": "object",
- "description": "Template for notifications list response.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "items": {
- "type": "array",
- "description": "List of notifications in this page.",
- "items": {
- "$ref": "Notification"
- }
- },
- "kind": {
- "type": "string",
- "description": "The type of the resource.",
- "default": "admin#directory#notifications"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token for fetching the next page of notifications."
- },
- "unreadNotificationsCount": {
- "type": "integer",
- "description": "Number of unread notification for the domain.",
- "format": "int32"
- }
- }
- },
- "OrgUnit": {
- "id": "OrgUnit",
- "type": "object",
- "description": "JSON template for Org Unit resource in Directory API.",
- "properties": {
- "blockInheritance": {
- "type": "boolean",
- "description": "Should block inheritance"
- },
- "description": {
- "type": "string",
- "description": "Description of OrgUnit"
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#orgUnit"
- },
- "name": {
- "type": "string",
- "description": "Name of OrgUnit",
- "annotations": {
- "required": [
- "directory.orgunits.insert"
- ]
- }
- },
- "orgUnitId": {
- "type": "string",
- "description": "Id of OrgUnit"
- },
- "orgUnitPath": {
- "type": "string",
- "description": "Path of OrgUnit"
- },
- "parentOrgUnitId": {
- "type": "string",
- "description": "Id of parent OrgUnit"
- },
- "parentOrgUnitPath": {
- "type": "string",
- "description": "Path of parent OrgUnit"
- }
- }
- },
- "OrgUnits": {
- "id": "OrgUnits",
- "type": "object",
- "description": "JSON response template for List Organization Units operation in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#orgUnits"
- },
- "organizationUnits": {
- "type": "array",
- "description": "List of user objects.",
- "items": {
- "$ref": "OrgUnit"
- }
- }
- }
- },
- "Privilege": {
- "id": "Privilege",
- "type": "object",
- "description": "JSON template for privilege resource in Directory API.",
- "properties": {
- "childPrivileges": {
- "type": "array",
- "description": "A list of child privileges. Privileges for a service form a tree. Each privilege can have a list of child privileges; this list is empty for a leaf privilege.",
- "items": {
- "$ref": "Privilege"
- }
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "isOuScopable": {
- "type": "boolean",
- "description": "If the privilege can be restricted to an organization unit."
- },
- "kind": {
- "type": "string",
- "description": "The type of the API resource. This is always admin#directory#privilege.",
- "default": "admin#directory#privilege"
- },
- "privilegeName": {
- "type": "string",
- "description": "The name of the privilege."
- },
- "serviceId": {
- "type": "string",
- "description": "The obfuscated ID of the service this privilege is for."
- },
- "serviceName": {
- "type": "string",
- "description": "The name of the service this privilege is for."
- }
- }
- },
- "Privileges": {
- "id": "Privileges",
- "type": "object",
- "description": "JSON response template for List privileges operation in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "items": {
- "type": "array",
- "description": "A list of Privilege resources.",
- "items": {
- "$ref": "Privilege"
- }
- },
- "kind": {
- "type": "string",
- "description": "The type of the API resource. This is always admin#directory#privileges.",
- "default": "admin#directory#privileges"
- }
- }
- },
- "Role": {
- "id": "Role",
- "type": "object",
- "description": "JSON template for role resource in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "isSuperAdminRole": {
- "type": "boolean",
- "description": "Returns true if the role is a super admin role."
- },
- "isSystemRole": {
- "type": "boolean",
- "description": "Returns true if this is a pre-defined system role."
- },
- "kind": {
- "type": "string",
- "description": "The type of the API resource. This is always admin#directory#role.",
- "default": "admin#directory#role"
- },
- "roleDescription": {
- "type": "string",
- "description": "A short description of the role."
- },
- "roleId": {
- "type": "string",
- "description": "ID of the role.",
- "format": "int64"
- },
- "roleName": {
- "type": "string",
- "description": "Name of the role.",
- "annotations": {
- "required": [
- "directory.roles.insert"
- ]
- }
- },
- "rolePrivileges": {
- "type": "array",
- "description": "The set of privileges that are granted to this role.",
- "items": {
- "type": "object",
- "properties": {
- "privilegeName": {
- "type": "string",
- "description": "The name of the privilege."
- },
- "serviceId": {
- "type": "string",
- "description": "The obfuscated ID of the service this privilege is for."
- }
- }
- },
- "annotations": {
- "required": [
- "directory.roles.insert"
- ]
- }
- }
- }
- },
- "RoleAssignment": {
- "id": "RoleAssignment",
- "type": "object",
- "description": "JSON template for roleAssignment resource in Directory API.",
- "properties": {
- "assignedTo": {
- "type": "string",
- "description": "The unique ID of the user this role is assigned to."
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "The type of the API resource. This is always admin#directory#roleAssignment.",
- "default": "admin#directory#roleAssignment"
- },
- "orgUnitId": {
- "type": "string",
- "description": "If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to."
- },
- "roleAssignmentId": {
- "type": "string",
- "description": "ID of this roleAssignment.",
- "format": "int64"
- },
- "roleId": {
- "type": "string",
- "description": "The ID of the role that is assigned.",
- "format": "int64"
- },
- "scopeType": {
- "type": "string",
- "description": "The scope in which this role is assigned. Possible values are: \n- CUSTOMER\n- ORG_UNIT"
- }
- }
- },
- "RoleAssignments": {
- "id": "RoleAssignments",
- "type": "object",
- "description": "JSON response template for List roleAssignments operation in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "items": {
- "type": "array",
- "description": "A list of RoleAssignment resources.",
- "items": {
- "$ref": "RoleAssignment"
- }
- },
- "kind": {
- "type": "string",
- "description": "The type of the API resource. This is always admin#directory#roleAssignments.",
- "default": "admin#directory#roleAssignments"
- },
- "nextPageToken": {
- "type": "string"
- }
- }
- },
- "Roles": {
- "id": "Roles",
- "type": "object",
- "description": "JSON response template for List roles operation in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "items": {
- "type": "array",
- "description": "A list of Role resources.",
- "items": {
- "$ref": "Role"
- }
- },
- "kind": {
- "type": "string",
- "description": "The type of the API resource. This is always admin#directory#roles.",
- "default": "admin#directory#roles"
- },
- "nextPageToken": {
- "type": "string"
- }
- }
- },
- "Schema": {
- "id": "Schema",
- "type": "object",
- "description": "JSON template for Schema resource in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "fields": {
- "type": "array",
- "description": "Fields of Schema",
- "items": {
- "$ref": "SchemaFieldSpec"
- },
- "annotations": {
- "required": [
- "directory.schemas.insert",
- "directory.schemas.update"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#schema"
- },
- "schemaId": {
- "type": "string",
- "description": "Unique identifier of Schema (Read-only)"
- },
- "schemaName": {
- "type": "string",
- "description": "Schema name",
- "annotations": {
- "required": [
- "directory.schemas.insert"
- ]
- }
- }
- }
- },
- "SchemaFieldSpec": {
- "id": "SchemaFieldSpec",
- "type": "object",
- "description": "JSON template for FieldSpec resource for Schemas in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "fieldId": {
- "type": "string",
- "description": "Unique identifier of Field (Read-only)"
- },
- "fieldName": {
- "type": "string",
- "description": "Name of the field.",
- "annotations": {
- "required": [
- "directory.schemas.insert",
- "directory.schemas.update"
- ]
- }
- },
- "fieldType": {
- "type": "string",
- "description": "Type of the field.",
- "annotations": {
- "required": [
- "directory.schemas.insert",
- "directory.schemas.update"
- ]
- }
- },
- "indexed": {
- "type": "boolean",
- "description": "Boolean specifying whether the field is indexed or not.",
- "default": "true"
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#schema#fieldspec"
- },
- "multiValued": {
- "type": "boolean",
- "description": "Boolean specifying whether this is a multi-valued field or not."
- },
- "numericIndexingSpec": {
- "type": "object",
- "description": "Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.",
- "properties": {
- "maxValue": {
- "type": "number",
- "description": "Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.",
- "format": "double"
- },
- "minValue": {
- "type": "number",
- "description": "Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.",
- "format": "double"
- }
- }
- },
- "readAccessType": {
- "type": "string",
- "description": "Read ACLs on the field specifying who can view values of this field. Valid values are \"ALL_DOMAIN_USERS\" and \"ADMINS_AND_SELF\".",
- "default": "ALL_DOMAIN_USERS"
- }
- }
- },
- "Schemas": {
- "id": "Schemas",
- "type": "object",
- "description": "JSON response template for List Schema operation in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#schemas"
- },
- "schemas": {
- "type": "array",
- "description": "List of UserSchema objects.",
- "items": {
- "$ref": "Schema"
- }
- }
- }
- },
- "Token": {
- "id": "Token",
- "type": "object",
- "description": "JSON template for token resource in Directory API.",
- "properties": {
- "anonymous": {
- "type": "boolean",
- "description": "Whether the application is registered with Google. The value is true if the application has an anonymous Client ID."
- },
- "clientId": {
- "type": "string",
- "description": "The Client ID of the application the token is issued to."
- },
- "displayText": {
- "type": "string",
- "description": "The displayable name of the application the token is issued to."
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "The type of the API resource. This is always admin#directory#token.",
- "default": "admin#directory#token"
- },
- "nativeApp": {
- "type": "boolean",
- "description": "Whether the token is issued to an installed application. The value is true if the application is installed to a desktop or mobile device."
- },
- "scopes": {
- "type": "array",
- "description": "A list of authorization scopes the application is granted.",
- "items": {
- "type": "string"
- }
- },
- "userKey": {
- "type": "string",
- "description": "The unique ID of the user that issued the token."
- }
- }
- },
- "Tokens": {
- "id": "Tokens",
- "type": "object",
- "description": "JSON response template for List tokens operation in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "items": {
- "type": "array",
- "description": "A list of Token resources.",
- "items": {
- "$ref": "Token"
- }
- },
- "kind": {
- "type": "string",
- "description": "The type of the API resource. This is always admin#directory#tokenList.",
- "default": "admin#directory#tokenList"
- }
- }
- },
- "User": {
- "id": "User",
- "type": "object",
- "description": "JSON template for User object in Directory API.",
- "properties": {
- "addresses": {
- "type": "any"
- },
- "agreedToTerms": {
- "type": "boolean",
- "description": "Indicates if user has agreed to terms (Read-only)",
- "readOnly": true
- },
- "aliases": {
- "type": "array",
- "description": "List of aliases (Read-only)",
- "readOnly": true,
- "items": {
- "type": "string"
- }
- },
- "changePasswordAtNextLogin": {
- "type": "boolean",
- "description": "Boolean indicating if the user should change password in next login"
- },
- "creationTime": {
- "type": "string",
- "description": "User's Google account creation time. (Read-only)",
- "format": "date-time",
- "readOnly": true
- },
- "customSchemas": {
- "type": "object",
- "description": "Custom fields of the user.",
- "additionalProperties": {
- "$ref": "UserCustomProperties"
- }
- },
- "customerId": {
- "type": "string",
- "description": "CustomerId of User (Read-only)",
- "readOnly": true
- },
- "deletionTime": {
- "type": "string",
- "format": "date-time",
- "readOnly": true
- },
- "emails": {
- "type": "any"
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource.",
- "readOnly": true
- },
- "externalIds": {
- "type": "any"
- },
- "hashFunction": {
- "type": "string",
- "description": "Hash function name for password. Supported are MD5, SHA-1 and crypt"
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of User (Read-only)"
- },
- "ims": {
- "type": "any"
- },
- "includeInGlobalAddressList": {
- "type": "boolean",
- "description": "Boolean indicating if user is included in Global Address List"
- },
- "ipWhitelisted": {
- "type": "boolean",
- "description": "Boolean indicating if ip is whitelisted"
- },
- "isAdmin": {
- "type": "boolean",
- "description": "Boolean indicating if the user is admin (Read-only)",
- "readOnly": true
- },
- "isDelegatedAdmin": {
- "type": "boolean",
- "description": "Boolean indicating if the user is delegated admin (Read-only)",
- "readOnly": true
- },
- "isMailboxSetup": {
- "type": "boolean",
- "description": "Is mailbox setup (Read-only)",
- "readOnly": true
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#user",
- "readOnly": true
- },
- "lastLoginTime": {
- "type": "string",
- "description": "User's last login time. (Read-only)",
- "format": "date-time",
- "readOnly": true
- },
- "name": {
- "$ref": "UserName",
- "description": "User's name",
- "annotations": {
- "required": [
- "directory.users.insert"
- ]
- }
- },
- "nonEditableAliases": {
- "type": "array",
- "description": "List of non editable aliases (Read-only)",
- "readOnly": true,
- "items": {
- "type": "string"
- }
- },
- "notes": {
- "type": "any"
- },
- "orgUnitPath": {
- "type": "string",
- "description": "OrgUnit of User"
- },
- "organizations": {
- "type": "any"
- },
- "password": {
- "type": "string",
- "description": "User's password",
- "annotations": {
- "required": [
- "directory.users.insert"
- ]
- }
- },
- "phones": {
- "type": "any"
- },
- "primaryEmail": {
- "type": "string",
- "description": "username of User",
- "annotations": {
- "required": [
- "directory.users.insert"
- ]
- }
- },
- "relations": {
- "type": "any"
- },
- "suspended": {
- "type": "boolean",
- "description": "Indicates if user is suspended"
- },
- "suspensionReason": {
- "type": "string",
- "description": "Suspension reason if user is suspended (Read-only)",
- "readOnly": true
- },
- "thumbnailPhotoEtag": {
- "type": "string",
- "description": "ETag of the user's photo (Read-only)",
- "readOnly": true
- },
- "thumbnailPhotoUrl": {
- "type": "string",
- "description": "Photo Url of the user (Read-only)",
- "readOnly": true
- },
- "websites": {
- "type": "any"
- }
- }
- },
- "UserAbout": {
- "id": "UserAbout",
- "type": "object",
- "description": "JSON template for About (notes) of a user in Directory API.",
- "properties": {
- "contentType": {
- "type": "string",
- "description": "About entry can have a type which indicates the content type. It can either be plain or html. By default, notes contents are assumed to contain plain text."
- },
- "value": {
- "type": "string",
- "description": "Actual value of notes."
- }
- }
- },
- "UserAddress": {
- "id": "UserAddress",
- "type": "object",
- "description": "JSON template for address.",
- "properties": {
- "country": {
- "type": "string",
- "description": "Country."
- },
- "countryCode": {
- "type": "string",
- "description": "Country code."
- },
- "customType": {
- "type": "string",
- "description": "Custom type."
- },
- "extendedAddress": {
- "type": "string",
- "description": "Extended Address."
- },
- "formatted": {
- "type": "string",
- "description": "Formatted address."
- },
- "locality": {
- "type": "string",
- "description": "Locality."
- },
- "poBox": {
- "type": "string",
- "description": "Other parts of address."
- },
- "postalCode": {
- "type": "string",
- "description": "Postal code."
- },
- "primary": {
- "type": "boolean",
- "description": "If this is user's primary address. Only one entry could be marked as primary."
- },
- "region": {
- "type": "string",
- "description": "Region."
- },
- "sourceIsStructured": {
- "type": "boolean",
- "description": "User supplied address was structured. Structured addresses are NOT supported at this time. You might be able to write structured addresses, but any values will eventually be clobbered."
- },
- "streetAddress": {
- "type": "string",
- "description": "Street."
- },
- "type": {
- "type": "string",
- "description": "Each entry can have a type which indicates standard values of that entry. For example address could be of home, work etc. In addition to the standard type, an entry can have a custom type and can take any value. Such type should have the CUSTOM value as type and also have a customType value."
- }
- }
- },
- "UserCustomProperties": {
- "id": "UserCustomProperties",
- "type": "object",
- "description": "JSON template for a set of custom properties (i.e. all fields in a particular schema)",
- "additionalProperties": {
- "type": "any"
- }
- },
- "UserEmail": {
- "id": "UserEmail",
- "type": "object",
- "description": "JSON template for an email.",
- "properties": {
- "address": {
- "type": "string",
- "description": "Email id of the user."
- },
- "customType": {
- "type": "string",
- "description": "Custom Type."
- },
- "primary": {
- "type": "boolean",
- "description": "If this is user's primary email. Only one entry could be marked as primary."
- },
- "type": {
- "type": "string",
- "description": "Each entry can have a type which indicates standard types of that entry. For example email could be of home, work etc. In addition to the standard type, an entry can have a custom type and can take any value Such types should have the CUSTOM value as type and also have a customType value."
- }
- }
- },
- "UserExternalId": {
- "id": "UserExternalId",
- "type": "object",
- "description": "JSON template for an externalId entry.",
- "properties": {
- "customType": {
- "type": "string",
- "description": "Custom type."
- },
- "type": {
- "type": "string",
- "description": "The type of the Id."
- },
- "value": {
- "type": "string",
- "description": "The value of the id."
- }
- }
- },
- "UserIm": {
- "id": "UserIm",
- "type": "object",
- "description": "JSON template for instant messenger of an user.",
- "properties": {
- "customProtocol": {
- "type": "string",
- "description": "Custom protocol."
- },
- "customType": {
- "type": "string",
- "description": "Custom type."
- },
- "im": {
- "type": "string",
- "description": "Instant messenger id."
- },
- "primary": {
- "type": "boolean",
- "description": "If this is user's primary im. Only one entry could be marked as primary."
- },
- "protocol": {
- "type": "string",
- "description": "Protocol used in the instant messenger. It should be one of the values from ImProtocolTypes map. Similar to type, it can take a CUSTOM value and specify the custom name in customProtocol field."
- },
- "type": {
- "type": "string",
- "description": "Each entry can have a type which indicates standard types of that entry. For example instant messengers could be of home, work etc. In addition to the standard type, an entry can have a custom type and can take any value. Such types should have the CUSTOM value as type and also have a customType value."
- }
- }
- },
- "UserMakeAdmin": {
- "id": "UserMakeAdmin",
- "type": "object",
- "description": "JSON request template for setting/revoking admin status of a user in Directory API.",
- "properties": {
- "status": {
- "type": "boolean",
- "description": "Boolean indicating new admin status of the user",
- "annotations": {
- "required": [
- "directory.users.makeAdmin"
- ]
- }
- }
- }
- },
- "UserName": {
- "id": "UserName",
- "type": "object",
- "description": "JSON template for name of a user in Directory API.",
- "properties": {
- "familyName": {
- "type": "string",
- "description": "Last Name",
- "annotations": {
- "required": [
- "directory.users.insert"
- ]
- }
- },
- "fullName": {
- "type": "string",
- "description": "Full Name"
- },
- "givenName": {
- "type": "string",
- "description": "First Name",
- "annotations": {
- "required": [
- "directory.users.insert"
- ]
- }
- }
- }
- },
- "UserOrganization": {
- "id": "UserOrganization",
- "type": "object",
- "description": "JSON template for an organization entry.",
- "properties": {
- "costCenter": {
- "type": "string",
- "description": "The cost center of the users department."
- },
- "customType": {
- "type": "string",
- "description": "Custom type."
- },
- "department": {
- "type": "string",
- "description": "Department within the organization."
- },
- "description": {
- "type": "string",
- "description": "Description of the organization."
- },
- "domain": {
- "type": "string",
- "description": "The domain to which the organization belongs to."
- },
- "location": {
- "type": "string",
- "description": "Location of the organization. This need not be fully qualified address."
- },
- "name": {
- "type": "string",
- "description": "Name of the organization"
- },
- "primary": {
- "type": "boolean",
- "description": "If it user's primary organization."
- },
- "symbol": {
- "type": "string",
- "description": "Symbol of the organization."
- },
- "title": {
- "type": "string",
- "description": "Title (designation) of the user in the organization."
- },
- "type": {
- "type": "string",
- "description": "Each entry can have a type which indicates standard types of that entry. For example organization could be of school, work etc. In addition to the standard type, an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a CustomType value."
- }
- }
- },
- "UserPhone": {
- "id": "UserPhone",
- "type": "object",
- "description": "JSON template for a phone entry.",
- "properties": {
- "customType": {
- "type": "string",
- "description": "Custom Type."
- },
- "primary": {
- "type": "boolean",
- "description": "If this is user's primary phone or not."
- },
- "type": {
- "type": "string",
- "description": "Each entry can have a type which indicates standard types of that entry. For example phone could be of home_fax, work, mobile etc. In addition to the standard type, an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value."
- },
- "value": {
- "type": "string",
- "description": "Phone number."
- }
- }
- },
- "UserPhoto": {
- "id": "UserPhoto",
- "type": "object",
- "description": "JSON template for Photo object in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "height": {
- "type": "integer",
- "description": "Height in pixels of the photo",
- "format": "int32"
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of User (Read-only)"
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#user#photo"
- },
- "mimeType": {
- "type": "string",
- "description": "Mime Type of the photo"
- },
- "photoData": {
- "type": "string",
- "description": "Base64 encoded photo data",
- "format": "byte",
- "annotations": {
- "required": [
- "directory.users.photos.update"
- ]
- }
- },
- "primaryEmail": {
- "type": "string",
- "description": "Primary email of User (Read-only)"
- },
- "width": {
- "type": "integer",
- "description": "Width in pixels of the photo",
- "format": "int32"
- }
- }
- },
- "UserRelation": {
- "id": "UserRelation",
- "type": "object",
- "description": "JSON template for a relation entry.",
- "properties": {
- "customType": {
- "type": "string",
- "description": "Custom Type."
- },
- "type": {
- "type": "string",
- "description": "The relation of the user. Some of the possible values are mother, father, sister, brother, manager, assistant, partner."
- },
- "value": {
- "type": "string",
- "description": "The name of the relation."
- }
- }
- },
- "UserUndelete": {
- "id": "UserUndelete",
- "type": "object",
- "description": "JSON request template to undelete a user in Directory API.",
- "properties": {
- "orgUnitPath": {
- "type": "string",
- "description": "OrgUnit of User"
- }
- }
- },
- "UserWebsite": {
- "id": "UserWebsite",
- "type": "object",
- "description": "JSON template for a website entry.",
- "properties": {
- "customType": {
- "type": "string",
- "description": "Custom Type."
- },
- "primary": {
- "type": "boolean",
- "description": "If this is user's primary website or not."
- },
- "type": {
- "type": "string",
- "description": "Each entry can have a type which indicates standard types of that entry. For example website could be of home, work, blog etc. In addition to the standard type, an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value."
- },
- "value": {
- "type": "string",
- "description": "Website."
- }
- }
- },
- "Users": {
- "id": "Users",
- "type": "object",
- "description": "JSON response template for List Users operation in Apps Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#directory#users"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token used to access next page of this result."
- },
- "trigger_event": {
- "type": "string",
- "description": "Event that triggered this response (only used in case of Push Response)"
- },
- "users": {
- "type": "array",
- "description": "List of user objects.",
- "items": {
- "$ref": "User"
- }
- }
- }
- },
- "VerificationCode": {
- "id": "VerificationCode",
- "type": "object",
- "description": "JSON template for verification codes in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "The type of the resource. This is always admin#directory#verificationCode.",
- "default": "admin#directory#verificationCode"
- },
- "userId": {
- "type": "string",
- "description": "The obfuscated unique ID of the user."
- },
- "verificationCode": {
- "type": "string",
- "description": "A current verification code for the user. Invalidated or used verification codes are not returned as part of the result."
- }
- }
- },
- "VerificationCodes": {
- "id": "VerificationCodes",
- "type": "object",
- "description": "JSON response template for List verification codes operation in Directory API.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "items": {
- "type": "array",
- "description": "A list of verification code resources.",
- "items": {
- "$ref": "VerificationCode"
- }
- },
- "kind": {
- "type": "string",
- "description": "The type of the resource. This is always admin#directory#verificationCodesList.",
- "default": "admin#directory#verificationCodesList"
- }
- }
- }
- },
- "resources": {
- "asps": {
- "methods": {
- "delete": {
- "id": "directory.asps.delete",
- "path": "users/{userKey}/asps/{codeId}",
- "httpMethod": "DELETE",
- "description": "Delete an ASP issued by a user.",
- "parameters": {
- "codeId": {
- "type": "integer",
- "description": "The unique ID of the ASP to be deleted.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "userKey": {
- "type": "string",
- "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey",
- "codeId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user.security"
- ]
- },
- "get": {
- "id": "directory.asps.get",
- "path": "users/{userKey}/asps/{codeId}",
- "httpMethod": "GET",
- "description": "Get information about an ASP issued by a user.",
- "parameters": {
- "codeId": {
- "type": "integer",
- "description": "The unique ID of the ASP.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "userKey": {
- "type": "string",
- "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey",
- "codeId"
- ],
- "response": {
- "$ref": "Asp"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user.security"
- ]
- },
- "list": {
- "id": "directory.asps.list",
- "path": "users/{userKey}/asps",
- "httpMethod": "GET",
- "description": "List the ASPs issued by a user.",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "response": {
- "$ref": "Asps"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user.security"
- ]
- }
- }
- },
- "channels": {
- "methods": {
- "stop": {
- "id": "admin.channels.stop",
- "path": "/admin/directory_v1/channels/stop",
- "httpMethod": "POST",
- "description": "Stop watching resources through this channel",
- "request": {
- "$ref": "Channel",
- "parameterName": "resource"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user",
- "https://www.googleapis.com/auth/admin.directory.user.alias",
- "https://www.googleapis.com/auth/admin.directory.user.alias.readonly",
- "https://www.googleapis.com/auth/admin.directory.user.readonly"
- ]
- }
- }
- },
- "chromeosdevices": {
- "methods": {
- "get": {
- "id": "directory.chromeosdevices.get",
- "path": "customer/{customerId}/devices/chromeos/{deviceId}",
- "httpMethod": "GET",
- "description": "Retrieve Chrome OS Device",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable id of the Google Apps account",
- "required": true,
- "location": "path"
- },
- "deviceId": {
- "type": "string",
- "description": "Immutable id of Chrome OS Device",
- "required": true,
- "location": "path"
- },
- "projection": {
- "type": "string",
- "description": "Restrict information returned to a set of selected fields.",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "enumDescriptions": [
- "Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)",
- "Includes all metadata fields"
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "customerId",
- "deviceId"
- ],
- "response": {
- "$ref": "ChromeOsDevice"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.device.chromeos",
- "https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly"
- ]
- },
- "list": {
- "id": "directory.chromeosdevices.list",
- "path": "customer/{customerId}/devices/chromeos",
- "httpMethod": "GET",
- "description": "Retrieve all Chrome OS Devices of a customer (paginated)",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable id of the Google Apps account",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return. Default is 100",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Column to use for sorting results",
- "enum": [
- "annotatedLocation",
- "annotatedUser",
- "lastSync",
- "notes",
- "serialNumber",
- "status",
- "supportEndDate"
- ],
- "enumDescriptions": [
- "Chromebook location as annotated by the administrator.",
- "Chromebook user as annotated by administrator.",
- "Chromebook last sync.",
- "Chromebook notes as annotated by the administrator.",
- "Chromebook Serial Number.",
- "Chromebook status.",
- "Chromebook support end date."
- ],
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify next page in the list",
- "location": "query"
- },
- "projection": {
- "type": "string",
- "description": "Restrict information returned to a set of selected fields.",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "enumDescriptions": [
- "Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)",
- "Includes all metadata fields"
- ],
- "location": "query"
- },
- "query": {
- "type": "string",
- "description": "Search string in the format given at http://support.google.com/chromeos/a/bin/answer.py?hl=en&answer=1698333",
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Whether to return results in ascending or descending order. Only of use when orderBy is also used",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "customerId"
- ],
- "response": {
- "$ref": "ChromeOsDevices"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.device.chromeos",
- "https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly"
- ]
- },
- "patch": {
- "id": "directory.chromeosdevices.patch",
- "path": "customer/{customerId}/devices/chromeos/{deviceId}",
- "httpMethod": "PATCH",
- "description": "Update Chrome OS Device. This method supports patch semantics.",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable id of the Google Apps account",
- "required": true,
- "location": "path"
- },
- "deviceId": {
- "type": "string",
- "description": "Immutable id of Chrome OS Device",
- "required": true,
- "location": "path"
- },
- "projection": {
- "type": "string",
- "description": "Restrict information returned to a set of selected fields.",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "enumDescriptions": [
- "Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)",
- "Includes all metadata fields"
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "customerId",
- "deviceId"
- ],
- "request": {
- "$ref": "ChromeOsDevice"
- },
- "response": {
- "$ref": "ChromeOsDevice"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.device.chromeos"
- ]
- },
- "update": {
- "id": "directory.chromeosdevices.update",
- "path": "customer/{customerId}/devices/chromeos/{deviceId}",
- "httpMethod": "PUT",
- "description": "Update Chrome OS Device",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable id of the Google Apps account",
- "required": true,
- "location": "path"
- },
- "deviceId": {
- "type": "string",
- "description": "Immutable id of Chrome OS Device",
- "required": true,
- "location": "path"
- },
- "projection": {
- "type": "string",
- "description": "Restrict information returned to a set of selected fields.",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "enumDescriptions": [
- "Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)",
- "Includes all metadata fields"
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "customerId",
- "deviceId"
- ],
- "request": {
- "$ref": "ChromeOsDevice"
- },
- "response": {
- "$ref": "ChromeOsDevice"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.device.chromeos"
- ]
- }
- }
- },
- "customers": {
- "methods": {
- "get": {
- "id": "directory.customers.get",
- "path": "customers/{customerKey}",
- "httpMethod": "GET",
- "description": "Retrives a customer.",
- "parameters": {
- "customerKey": {
- "type": "string",
- "description": "Id of the customer to be retrieved",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerKey"
- ],
- "response": {
- "$ref": "Customer"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.customer",
- "https://www.googleapis.com/auth/admin.directory.customer.readonly"
- ]
- },
- "patch": {
- "id": "directory.customers.patch",
- "path": "customers/{customerKey}",
- "httpMethod": "PATCH",
- "description": "Updates a customer. This method supports patch semantics.",
- "parameters": {
- "customerKey": {
- "type": "string",
- "description": "Id of the customer to be updated",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerKey"
- ],
- "request": {
- "$ref": "Customer"
- },
- "response": {
- "$ref": "Customer"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.customer"
- ]
- },
- "update": {
- "id": "directory.customers.update",
- "path": "customers/{customerKey}",
- "httpMethod": "PUT",
- "description": "Updates a customer.",
- "parameters": {
- "customerKey": {
- "type": "string",
- "description": "Id of the customer to be updated",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerKey"
- ],
- "request": {
- "$ref": "Customer"
- },
- "response": {
- "$ref": "Customer"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.customer"
- ]
- }
- }
- },
- "domainAliases": {
- "methods": {
- "delete": {
- "id": "directory.domainAliases.delete",
- "path": "customer/{customer}/domainaliases/{domainAliasName}",
- "httpMethod": "DELETE",
- "description": "Deletes a Domain Alias of the customer.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable id of the Google Apps account.",
- "required": true,
- "location": "path"
- },
- "domainAliasName": {
- "type": "string",
- "description": "Name of domain alias to be retrieved.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "domainAliasName"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.domain"
- ]
- },
- "get": {
- "id": "directory.domainAliases.get",
- "path": "customer/{customer}/domainaliases/{domainAliasName}",
- "httpMethod": "GET",
- "description": "Retrieves a domain alias of the customer.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable id of the Google Apps account.",
- "required": true,
- "location": "path"
- },
- "domainAliasName": {
- "type": "string",
- "description": "Name of domain alias to be retrieved.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "domainAliasName"
- ],
- "response": {
- "$ref": "DomainAlias"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.domain",
- "https://www.googleapis.com/auth/admin.directory.domain.readonly"
- ]
- },
- "insert": {
- "id": "directory.domainAliases.insert",
- "path": "customer/{customer}/domainaliases",
- "httpMethod": "POST",
- "description": "Inserts a Domain alias of the customer.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable id of the Google Apps account.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer"
- ],
- "request": {
- "$ref": "DomainAlias"
- },
- "response": {
- "$ref": "DomainAlias"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.domain"
- ]
- },
- "list": {
- "id": "directory.domainAliases.list",
- "path": "customer/{customer}/domainaliases",
- "httpMethod": "GET",
- "description": "Lists the domain aliases of the customer.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable id of the Google Apps account.",
- "required": true,
- "location": "path"
- },
- "parentDomainName": {
- "type": "string",
- "description": "Name of the parent domain for which domain aliases are to be fetched.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "customer"
- ],
- "response": {
- "$ref": "DomainAliases"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.domain",
- "https://www.googleapis.com/auth/admin.directory.domain.readonly"
- ]
- }
- }
- },
- "domains": {
- "methods": {
- "delete": {
- "id": "directory.domains.delete",
- "path": "customer/{customer}/domains/{domainName}",
- "httpMethod": "DELETE",
- "description": "Deletes a domain of the customer.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable id of the Google Apps account.",
- "required": true,
- "location": "path"
- },
- "domainName": {
- "type": "string",
- "description": "Name of domain to be deleted",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "domainName"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.domain"
- ]
- },
- "get": {
- "id": "directory.domains.get",
- "path": "customer/{customer}/domains/{domainName}",
- "httpMethod": "GET",
- "description": "Retrives a domain of the customer.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable id of the Google Apps account.",
- "required": true,
- "location": "path"
- },
- "domainName": {
- "type": "string",
- "description": "Name of domain to be retrieved",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "domainName"
- ],
- "response": {
- "$ref": "Domains"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.domain",
- "https://www.googleapis.com/auth/admin.directory.domain.readonly"
- ]
- },
- "insert": {
- "id": "directory.domains.insert",
- "path": "customer/{customer}/domains",
- "httpMethod": "POST",
- "description": "Inserts a domain of the customer.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable id of the Google Apps account.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer"
- ],
- "request": {
- "$ref": "Domains"
- },
- "response": {
- "$ref": "Domains"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.domain"
- ]
- },
- "list": {
- "id": "directory.domains.list",
- "path": "customer/{customer}/domains",
- "httpMethod": "GET",
- "description": "Lists the domains of the customer.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable id of the Google Apps account.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer"
- ],
- "response": {
- "$ref": "Domains2"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.domain",
- "https://www.googleapis.com/auth/admin.directory.domain.readonly"
- ]
- }
- }
- },
- "groups": {
- "methods": {
- "delete": {
- "id": "directory.groups.delete",
- "path": "groups/{groupKey}",
- "httpMethod": "DELETE",
- "description": "Delete Group",
- "parameters": {
- "groupKey": {
- "type": "string",
- "description": "Email or immutable Id of the group",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "groupKey"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group"
- ]
- },
- "get": {
- "id": "directory.groups.get",
- "path": "groups/{groupKey}",
- "httpMethod": "GET",
- "description": "Retrieve Group",
- "parameters": {
- "groupKey": {
- "type": "string",
- "description": "Email or immutable Id of the group",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "groupKey"
- ],
- "response": {
- "$ref": "Group"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group",
- "https://www.googleapis.com/auth/admin.directory.group.readonly"
- ]
- },
- "insert": {
- "id": "directory.groups.insert",
- "path": "groups",
- "httpMethod": "POST",
- "description": "Create Group",
- "request": {
- "$ref": "Group"
- },
- "response": {
- "$ref": "Group"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group"
- ]
- },
- "list": {
- "id": "directory.groups.list",
- "path": "groups",
- "httpMethod": "GET",
- "description": "Retrieve all groups in a domain (paginated)",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable id of the Google Apps account. In case of multi-domain, to fetch all groups for a customer, fill this field instead of domain.",
- "location": "query"
- },
- "domain": {
- "type": "string",
- "description": "Name of the domain. Fill this field to get groups from only this domain. To return all groups in a multi-domain fill customer field instead.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return. Default is 200",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify next page in the list",
- "location": "query"
- },
- "userKey": {
- "type": "string",
- "description": "Email or immutable Id of the user if only those groups are to be listed, the given user is a member of. If Id, it should match with id of user object",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Groups"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group",
- "https://www.googleapis.com/auth/admin.directory.group.readonly"
- ]
- },
- "patch": {
- "id": "directory.groups.patch",
- "path": "groups/{groupKey}",
- "httpMethod": "PATCH",
- "description": "Update Group. This method supports patch semantics.",
- "parameters": {
- "groupKey": {
- "type": "string",
- "description": "Email or immutable Id of the group. If Id, it should match with id of group object",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "groupKey"
- ],
- "request": {
- "$ref": "Group"
- },
- "response": {
- "$ref": "Group"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group"
- ]
- },
- "update": {
- "id": "directory.groups.update",
- "path": "groups/{groupKey}",
- "httpMethod": "PUT",
- "description": "Update Group",
- "parameters": {
- "groupKey": {
- "type": "string",
- "description": "Email or immutable Id of the group. If Id, it should match with id of group object",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "groupKey"
- ],
- "request": {
- "$ref": "Group"
- },
- "response": {
- "$ref": "Group"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group"
- ]
- }
- },
- "resources": {
- "aliases": {
- "methods": {
- "delete": {
- "id": "directory.groups.aliases.delete",
- "path": "groups/{groupKey}/aliases/{alias}",
- "httpMethod": "DELETE",
- "description": "Remove a alias for the group",
- "parameters": {
- "alias": {
- "type": "string",
- "description": "The alias to be removed",
- "required": true,
- "location": "path"
- },
- "groupKey": {
- "type": "string",
- "description": "Email or immutable Id of the group",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "groupKey",
- "alias"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group"
- ]
- },
- "insert": {
- "id": "directory.groups.aliases.insert",
- "path": "groups/{groupKey}/aliases",
- "httpMethod": "POST",
- "description": "Add a alias for the group",
- "parameters": {
- "groupKey": {
- "type": "string",
- "description": "Email or immutable Id of the group",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "groupKey"
- ],
- "request": {
- "$ref": "Alias"
- },
- "response": {
- "$ref": "Alias"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group"
- ]
- },
- "list": {
- "id": "directory.groups.aliases.list",
- "path": "groups/{groupKey}/aliases",
- "httpMethod": "GET",
- "description": "List all aliases for a group",
- "parameters": {
- "groupKey": {
- "type": "string",
- "description": "Email or immutable Id of the group",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "groupKey"
- ],
- "response": {
- "$ref": "Aliases"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group",
- "https://www.googleapis.com/auth/admin.directory.group.readonly"
- ],
- "supportsSubscription": true
- }
- }
- }
- }
- },
- "members": {
- "methods": {
- "delete": {
- "id": "directory.members.delete",
- "path": "groups/{groupKey}/members/{memberKey}",
- "httpMethod": "DELETE",
- "description": "Remove membership.",
- "parameters": {
- "groupKey": {
- "type": "string",
- "description": "Email or immutable Id of the group",
- "required": true,
- "location": "path"
- },
- "memberKey": {
- "type": "string",
- "description": "Email or immutable Id of the member",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "groupKey",
- "memberKey"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group",
- "https://www.googleapis.com/auth/admin.directory.group.member"
- ]
- },
- "get": {
- "id": "directory.members.get",
- "path": "groups/{groupKey}/members/{memberKey}",
- "httpMethod": "GET",
- "description": "Retrieve Group Member",
- "parameters": {
- "groupKey": {
- "type": "string",
- "description": "Email or immutable Id of the group",
- "required": true,
- "location": "path"
- },
- "memberKey": {
- "type": "string",
- "description": "Email or immutable Id of the member",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "groupKey",
- "memberKey"
- ],
- "response": {
- "$ref": "Member"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group",
- "https://www.googleapis.com/auth/admin.directory.group.member",
- "https://www.googleapis.com/auth/admin.directory.group.member.readonly",
- "https://www.googleapis.com/auth/admin.directory.group.readonly"
- ]
- },
- "insert": {
- "id": "directory.members.insert",
- "path": "groups/{groupKey}/members",
- "httpMethod": "POST",
- "description": "Add user to the specified group.",
- "parameters": {
- "groupKey": {
- "type": "string",
- "description": "Email or immutable Id of the group",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "groupKey"
- ],
- "request": {
- "$ref": "Member"
- },
- "response": {
- "$ref": "Member"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group",
- "https://www.googleapis.com/auth/admin.directory.group.member"
- ]
- },
- "list": {
- "id": "directory.members.list",
- "path": "groups/{groupKey}/members",
- "httpMethod": "GET",
- "description": "Retrieve all members in a group (paginated)",
- "parameters": {
- "groupKey": {
- "type": "string",
- "description": "Email or immutable Id of the group",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return. Default is 200",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify next page in the list",
- "location": "query"
- },
- "roles": {
- "type": "string",
- "description": "Comma separated role values to filter list results on.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "groupKey"
- ],
- "response": {
- "$ref": "Members"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group",
- "https://www.googleapis.com/auth/admin.directory.group.member",
- "https://www.googleapis.com/auth/admin.directory.group.member.readonly",
- "https://www.googleapis.com/auth/admin.directory.group.readonly"
- ]
- },
- "patch": {
- "id": "directory.members.patch",
- "path": "groups/{groupKey}/members/{memberKey}",
- "httpMethod": "PATCH",
- "description": "Update membership of a user in the specified group. This method supports patch semantics.",
- "parameters": {
- "groupKey": {
- "type": "string",
- "description": "Email or immutable Id of the group. If Id, it should match with id of group object",
- "required": true,
- "location": "path"
- },
- "memberKey": {
- "type": "string",
- "description": "Email or immutable Id of the user. If Id, it should match with id of member object",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "groupKey",
- "memberKey"
- ],
- "request": {
- "$ref": "Member"
- },
- "response": {
- "$ref": "Member"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group",
- "https://www.googleapis.com/auth/admin.directory.group.member"
- ]
- },
- "update": {
- "id": "directory.members.update",
- "path": "groups/{groupKey}/members/{memberKey}",
- "httpMethod": "PUT",
- "description": "Update membership of a user in the specified group.",
- "parameters": {
- "groupKey": {
- "type": "string",
- "description": "Email or immutable Id of the group. If Id, it should match with id of group object",
- "required": true,
- "location": "path"
- },
- "memberKey": {
- "type": "string",
- "description": "Email or immutable Id of the user. If Id, it should match with id of member object",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "groupKey",
- "memberKey"
- ],
- "request": {
- "$ref": "Member"
- },
- "response": {
- "$ref": "Member"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.group",
- "https://www.googleapis.com/auth/admin.directory.group.member"
- ]
- }
- }
- },
- "mobiledevices": {
- "methods": {
- "action": {
- "id": "directory.mobiledevices.action",
- "path": "customer/{customerId}/devices/mobile/{resourceId}/action",
- "httpMethod": "POST",
- "description": "Take action on Mobile Device",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable id of the Google Apps account",
- "required": true,
- "location": "path"
- },
- "resourceId": {
- "type": "string",
- "description": "Immutable id of Mobile Device",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId",
- "resourceId"
- ],
- "request": {
- "$ref": "MobileDeviceAction"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.device.mobile",
- "https://www.googleapis.com/auth/admin.directory.device.mobile.action"
- ]
- },
- "delete": {
- "id": "directory.mobiledevices.delete",
- "path": "customer/{customerId}/devices/mobile/{resourceId}",
- "httpMethod": "DELETE",
- "description": "Delete Mobile Device",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable id of the Google Apps account",
- "required": true,
- "location": "path"
- },
- "resourceId": {
- "type": "string",
- "description": "Immutable id of Mobile Device",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId",
- "resourceId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.device.mobile"
- ]
- },
- "get": {
- "id": "directory.mobiledevices.get",
- "path": "customer/{customerId}/devices/mobile/{resourceId}",
- "httpMethod": "GET",
- "description": "Retrieve Mobile Device",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable id of the Google Apps account",
- "required": true,
- "location": "path"
- },
- "projection": {
- "type": "string",
- "description": "Restrict information returned to a set of selected fields.",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "enumDescriptions": [
- "Includes only the basic metadata fields (e.g., deviceId, model, status, type, and status)",
- "Includes all metadata fields"
- ],
- "location": "query"
- },
- "resourceId": {
- "type": "string",
- "description": "Immutable id of Mobile Device",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId",
- "resourceId"
- ],
- "response": {
- "$ref": "MobileDevice"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.device.mobile",
- "https://www.googleapis.com/auth/admin.directory.device.mobile.action",
- "https://www.googleapis.com/auth/admin.directory.device.mobile.readonly"
- ]
- },
- "list": {
- "id": "directory.mobiledevices.list",
- "path": "customer/{customerId}/devices/mobile",
- "httpMethod": "GET",
- "description": "Retrieve all Mobile Devices of a customer (paginated)",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable id of the Google Apps account",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return. Default is 100",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Column to use for sorting results",
- "enum": [
- "deviceId",
- "email",
- "lastSync",
- "model",
- "name",
- "os",
- "status",
- "type"
- ],
- "enumDescriptions": [
- "Mobile Device serial number.",
- "Owner user email.",
- "Last policy settings sync date time of the device.",
- "Mobile Device model.",
- "Owner user name.",
- "Mobile operating system.",
- "Status of the device.",
- "Type of the device."
- ],
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify next page in the list",
- "location": "query"
- },
- "projection": {
- "type": "string",
- "description": "Restrict information returned to a set of selected fields.",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "enumDescriptions": [
- "Includes only the basic metadata fields (e.g., deviceId, model, status, type, and status)",
- "Includes all metadata fields"
- ],
- "location": "query"
- },
- "query": {
- "type": "string",
- "description": "Search string in the format given at http://support.google.com/a/bin/answer.py?hl=en&answer=1408863#search",
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Whether to return results in ascending or descending order. Only of use when orderBy is also used",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "customerId"
- ],
- "response": {
- "$ref": "MobileDevices"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.device.mobile",
- "https://www.googleapis.com/auth/admin.directory.device.mobile.action",
- "https://www.googleapis.com/auth/admin.directory.device.mobile.readonly"
- ]
- }
- }
- },
- "notifications": {
- "methods": {
- "delete": {
- "id": "directory.notifications.delete",
- "path": "customer/{customer}/notifications/{notificationId}",
- "httpMethod": "DELETE",
- "description": "Deletes a notification",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "The unique ID for the customer's Google account. The customerId is also returned as part of the Users resource.",
- "required": true,
- "location": "path"
- },
- "notificationId": {
- "type": "string",
- "description": "The unique ID of the notification.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "notificationId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.notifications"
- ]
- },
- "get": {
- "id": "directory.notifications.get",
- "path": "customer/{customer}/notifications/{notificationId}",
- "httpMethod": "GET",
- "description": "Retrieves a notification.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "The unique ID for the customer's Google account. The customerId is also returned as part of the Users resource.",
- "required": true,
- "location": "path"
- },
- "notificationId": {
- "type": "string",
- "description": "The unique ID of the notification.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "notificationId"
- ],
- "response": {
- "$ref": "Notification"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.notifications"
- ]
- },
- "list": {
- "id": "directory.notifications.list",
- "path": "customer/{customer}/notifications",
- "httpMethod": "GET",
- "description": "Retrieves a list of notifications.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "The unique ID for the customer's Google account.",
- "required": true,
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "The ISO 639-1 code of the language notifications are returned in. The default is English (en).",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of notifications to return per page. The default is 100.",
- "format": "uint32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The token to specify the page of results to retrieve.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "customer"
- ],
- "response": {
- "$ref": "Notifications"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.notifications"
- ]
- },
- "patch": {
- "id": "directory.notifications.patch",
- "path": "customer/{customer}/notifications/{notificationId}",
- "httpMethod": "PATCH",
- "description": "Updates a notification. This method supports patch semantics.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "The unique ID for the customer's Google account.",
- "required": true,
- "location": "path"
- },
- "notificationId": {
- "type": "string",
- "description": "The unique ID of the notification.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "notificationId"
- ],
- "request": {
- "$ref": "Notification"
- },
- "response": {
- "$ref": "Notification"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.notifications"
- ]
- },
- "update": {
- "id": "directory.notifications.update",
- "path": "customer/{customer}/notifications/{notificationId}",
- "httpMethod": "PUT",
- "description": "Updates a notification.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "The unique ID for the customer's Google account.",
- "required": true,
- "location": "path"
- },
- "notificationId": {
- "type": "string",
- "description": "The unique ID of the notification.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "notificationId"
- ],
- "request": {
- "$ref": "Notification"
- },
- "response": {
- "$ref": "Notification"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.notifications"
- ]
- }
- }
- },
- "orgunits": {
- "methods": {
- "delete": {
- "id": "directory.orgunits.delete",
- "path": "customer/{customerId}/orgunits{/orgUnitPath*}",
- "httpMethod": "DELETE",
- "description": "Remove Organization Unit",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable id of the Google Apps account",
- "required": true,
- "location": "path"
- },
- "orgUnitPath": {
- "type": "string",
- "description": "Full path of the organization unit or its Id",
- "required": true,
- "repeated": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId",
- "orgUnitPath"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.orgunit"
- ]
- },
- "get": {
- "id": "directory.orgunits.get",
- "path": "customer/{customerId}/orgunits{/orgUnitPath*}",
- "httpMethod": "GET",
- "description": "Retrieve Organization Unit",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable id of the Google Apps account",
- "required": true,
- "location": "path"
- },
- "orgUnitPath": {
- "type": "string",
- "description": "Full path of the organization unit or its Id",
- "required": true,
- "repeated": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId",
- "orgUnitPath"
- ],
- "response": {
- "$ref": "OrgUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.orgunit",
- "https://www.googleapis.com/auth/admin.directory.orgunit.readonly"
- ]
- },
- "insert": {
- "id": "directory.orgunits.insert",
- "path": "customer/{customerId}/orgunits",
- "httpMethod": "POST",
- "description": "Add Organization Unit",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable id of the Google Apps account",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId"
- ],
- "request": {
- "$ref": "OrgUnit"
- },
- "response": {
- "$ref": "OrgUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.orgunit"
- ]
- },
- "list": {
- "id": "directory.orgunits.list",
- "path": "customer/{customerId}/orgunits",
- "httpMethod": "GET",
- "description": "Retrieve all Organization Units",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable id of the Google Apps account",
- "required": true,
- "location": "path"
- },
- "orgUnitPath": {
- "type": "string",
- "description": "the URL-encoded organization unit's path or its Id",
- "default": "",
- "location": "query"
- },
- "type": {
- "type": "string",
- "description": "Whether to return all sub-organizations or just immediate children",
- "enum": [
- "all",
- "children"
- ],
- "enumDescriptions": [
- "All sub-organization units.",
- "Immediate children only (default)."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "customerId"
- ],
- "response": {
- "$ref": "OrgUnits"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.orgunit",
- "https://www.googleapis.com/auth/admin.directory.orgunit.readonly"
- ]
- },
- "patch": {
- "id": "directory.orgunits.patch",
- "path": "customer/{customerId}/orgunits{/orgUnitPath*}",
- "httpMethod": "PATCH",
- "description": "Update Organization Unit. This method supports patch semantics.",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable id of the Google Apps account",
- "required": true,
- "location": "path"
- },
- "orgUnitPath": {
- "type": "string",
- "description": "Full path of the organization unit or its Id",
- "required": true,
- "repeated": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId",
- "orgUnitPath"
- ],
- "request": {
- "$ref": "OrgUnit"
- },
- "response": {
- "$ref": "OrgUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.orgunit"
- ]
- },
- "update": {
- "id": "directory.orgunits.update",
- "path": "customer/{customerId}/orgunits{/orgUnitPath*}",
- "httpMethod": "PUT",
- "description": "Update Organization Unit",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable id of the Google Apps account",
- "required": true,
- "location": "path"
- },
- "orgUnitPath": {
- "type": "string",
- "description": "Full path of the organization unit or its Id",
- "required": true,
- "repeated": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId",
- "orgUnitPath"
- ],
- "request": {
- "$ref": "OrgUnit"
- },
- "response": {
- "$ref": "OrgUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.orgunit"
- ]
- }
- }
- },
- "privileges": {
- "methods": {
- "list": {
- "id": "directory.privileges.list",
- "path": "customer/{customer}/roles/ALL/privileges",
- "httpMethod": "GET",
- "description": "Retrieves a paginated list of all privileges for a customer.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the Google Apps account.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer"
- ],
- "response": {
- "$ref": "Privileges"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.rolemanagement",
- "https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly"
- ]
- }
- }
- },
- "roleAssignments": {
- "methods": {
- "delete": {
- "id": "directory.roleAssignments.delete",
- "path": "customer/{customer}/roleassignments/{roleAssignmentId}",
- "httpMethod": "DELETE",
- "description": "Deletes a role assignment.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the Google Apps account.",
- "required": true,
- "location": "path"
- },
- "roleAssignmentId": {
- "type": "string",
- "description": "Immutable ID of the role assignment.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "roleAssignmentId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.rolemanagement"
- ]
- },
- "get": {
- "id": "directory.roleAssignments.get",
- "path": "customer/{customer}/roleassignments/{roleAssignmentId}",
- "httpMethod": "GET",
- "description": "Retrieve a role assignment.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the Google Apps account.",
- "required": true,
- "location": "path"
- },
- "roleAssignmentId": {
- "type": "string",
- "description": "Immutable ID of the role assignment.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "roleAssignmentId"
- ],
- "response": {
- "$ref": "RoleAssignment"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.rolemanagement",
- "https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly"
- ]
- },
- "insert": {
- "id": "directory.roleAssignments.insert",
- "path": "customer/{customer}/roleassignments",
- "httpMethod": "POST",
- "description": "Creates a role assignment.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the Google Apps account.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer"
- ],
- "request": {
- "$ref": "RoleAssignment"
- },
- "response": {
- "$ref": "RoleAssignment"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.rolemanagement"
- ]
- },
- "list": {
- "id": "directory.roleAssignments.list",
- "path": "customer/{customer}/roleassignments",
- "httpMethod": "GET",
- "description": "Retrieves a paginated list of all roleAssignments.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the Google Apps account.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "1",
- "maximum": "200",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify the next page in the list.",
- "location": "query"
- },
- "roleId": {
- "type": "string",
- "description": "Immutable ID of a role. If included in the request, returns only role assignments containing this role ID.",
- "location": "query"
- },
- "userKey": {
- "type": "string",
- "description": "The user's primary email address, alias email address, or unique user ID. If included in the request, returns role assignments only for this user.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "customer"
- ],
- "response": {
- "$ref": "RoleAssignments"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.rolemanagement",
- "https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly"
- ]
- }
- }
- },
- "roles": {
- "methods": {
- "delete": {
- "id": "directory.roles.delete",
- "path": "customer/{customer}/roles/{roleId}",
- "httpMethod": "DELETE",
- "description": "Deletes a role.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the Google Apps account.",
- "required": true,
- "location": "path"
- },
- "roleId": {
- "type": "string",
- "description": "Immutable ID of the role.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "roleId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.rolemanagement"
- ]
- },
- "get": {
- "id": "directory.roles.get",
- "path": "customer/{customer}/roles/{roleId}",
- "httpMethod": "GET",
- "description": "Retrieves a role.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the Google Apps account.",
- "required": true,
- "location": "path"
- },
- "roleId": {
- "type": "string",
- "description": "Immutable ID of the role.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "roleId"
- ],
- "response": {
- "$ref": "Role"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.rolemanagement",
- "https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly"
- ]
- },
- "insert": {
- "id": "directory.roles.insert",
- "path": "customer/{customer}/roles",
- "httpMethod": "POST",
- "description": "Creates a role.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the Google Apps account.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer"
- ],
- "request": {
- "$ref": "Role"
- },
- "response": {
- "$ref": "Role"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.rolemanagement"
- ]
- },
- "list": {
- "id": "directory.roles.list",
- "path": "customer/{customer}/roles",
- "httpMethod": "GET",
- "description": "Retrieves a paginated list of all the roles in a domain.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable id of the Google Apps account.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "1",
- "maximum": "100",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify the next page in the list.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "customer"
- ],
- "response": {
- "$ref": "Roles"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.rolemanagement",
- "https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly"
- ]
- },
- "patch": {
- "id": "directory.roles.patch",
- "path": "customer/{customer}/roles/{roleId}",
- "httpMethod": "PATCH",
- "description": "Updates a role. This method supports patch semantics.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the Google Apps account.",
- "required": true,
- "location": "path"
- },
- "roleId": {
- "type": "string",
- "description": "Immutable ID of the role.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "roleId"
- ],
- "request": {
- "$ref": "Role"
- },
- "response": {
- "$ref": "Role"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.rolemanagement"
- ]
- },
- "update": {
- "id": "directory.roles.update",
- "path": "customer/{customer}/roles/{roleId}",
- "httpMethod": "PUT",
- "description": "Updates a role.",
- "parameters": {
- "customer": {
- "type": "string",
- "description": "Immutable ID of the Google Apps account.",
- "required": true,
- "location": "path"
- },
- "roleId": {
- "type": "string",
- "description": "Immutable ID of the role.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customer",
- "roleId"
- ],
- "request": {
- "$ref": "Role"
- },
- "response": {
- "$ref": "Role"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.rolemanagement"
- ]
- }
- }
- },
- "schemas": {
- "methods": {
- "delete": {
- "id": "directory.schemas.delete",
- "path": "customer/{customerId}/schemas/{schemaKey}",
- "httpMethod": "DELETE",
- "description": "Delete schema",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable id of the Google Apps account",
- "required": true,
- "location": "path"
- },
- "schemaKey": {
- "type": "string",
- "description": "Name or immutable Id of the schema",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId",
- "schemaKey"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.userschema"
- ]
- },
- "get": {
- "id": "directory.schemas.get",
- "path": "customer/{customerId}/schemas/{schemaKey}",
- "httpMethod": "GET",
- "description": "Retrieve schema",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable id of the Google Apps account",
- "required": true,
- "location": "path"
- },
- "schemaKey": {
- "type": "string",
- "description": "Name or immutable Id of the schema",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId",
- "schemaKey"
- ],
- "response": {
- "$ref": "Schema"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.userschema",
- "https://www.googleapis.com/auth/admin.directory.userschema.readonly"
- ]
- },
- "insert": {
- "id": "directory.schemas.insert",
- "path": "customer/{customerId}/schemas",
- "httpMethod": "POST",
- "description": "Create schema.",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable id of the Google Apps account",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId"
- ],
- "request": {
- "$ref": "Schema"
- },
- "response": {
- "$ref": "Schema"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.userschema"
- ]
- },
- "list": {
- "id": "directory.schemas.list",
- "path": "customer/{customerId}/schemas",
- "httpMethod": "GET",
- "description": "Retrieve all schemas for a customer",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable id of the Google Apps account",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId"
- ],
- "response": {
- "$ref": "Schemas"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.userschema",
- "https://www.googleapis.com/auth/admin.directory.userschema.readonly"
- ]
- },
- "patch": {
- "id": "directory.schemas.patch",
- "path": "customer/{customerId}/schemas/{schemaKey}",
- "httpMethod": "PATCH",
- "description": "Update schema. This method supports patch semantics.",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable id of the Google Apps account",
- "required": true,
- "location": "path"
- },
- "schemaKey": {
- "type": "string",
- "description": "Name or immutable Id of the schema.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId",
- "schemaKey"
- ],
- "request": {
- "$ref": "Schema"
- },
- "response": {
- "$ref": "Schema"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.userschema"
- ]
- },
- "update": {
- "id": "directory.schemas.update",
- "path": "customer/{customerId}/schemas/{schemaKey}",
- "httpMethod": "PUT",
- "description": "Update schema",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Immutable id of the Google Apps account",
- "required": true,
- "location": "path"
- },
- "schemaKey": {
- "type": "string",
- "description": "Name or immutable Id of the schema.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "customerId",
- "schemaKey"
- ],
- "request": {
- "$ref": "Schema"
- },
- "response": {
- "$ref": "Schema"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.userschema"
- ]
- }
- }
- },
- "tokens": {
- "methods": {
- "delete": {
- "id": "directory.tokens.delete",
- "path": "users/{userKey}/tokens/{clientId}",
- "httpMethod": "DELETE",
- "description": "Delete all access tokens issued by a user for an application.",
- "parameters": {
- "clientId": {
- "type": "string",
- "description": "The Client ID of the application the token is issued to.",
- "required": true,
- "location": "path"
- },
- "userKey": {
- "type": "string",
- "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey",
- "clientId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user.security"
- ]
- },
- "get": {
- "id": "directory.tokens.get",
- "path": "users/{userKey}/tokens/{clientId}",
- "httpMethod": "GET",
- "description": "Get information about an access token issued by a user.",
- "parameters": {
- "clientId": {
- "type": "string",
- "description": "The Client ID of the application the token is issued to.",
- "required": true,
- "location": "path"
- },
- "userKey": {
- "type": "string",
- "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey",
- "clientId"
- ],
- "response": {
- "$ref": "Token"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user.security"
- ]
- },
- "list": {
- "id": "directory.tokens.list",
- "path": "users/{userKey}/tokens",
- "httpMethod": "GET",
- "description": "Returns the set of tokens specified user has issued to 3rd party applications.",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "response": {
- "$ref": "Tokens"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user.security"
- ]
- }
- }
- },
- "users": {
- "methods": {
- "delete": {
- "id": "directory.users.delete",
- "path": "users/{userKey}",
- "httpMethod": "DELETE",
- "description": "Delete user",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "Email or immutable Id of the user",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user"
- ]
- },
- "get": {
- "id": "directory.users.get",
- "path": "users/{userKey}",
- "httpMethod": "GET",
- "description": "retrieve user",
- "parameters": {
- "customFieldMask": {
- "type": "string",
- "description": "Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.",
- "location": "query"
- },
- "projection": {
- "type": "string",
- "description": "What subset of fields to fetch for this user.",
- "default": "basic",
- "enum": [
- "basic",
- "custom",
- "full"
- ],
- "enumDescriptions": [
- "Do not include any custom fields for the user.",
- "Include custom fields from schemas mentioned in customFieldMask.",
- "Include all fields associated with this user."
- ],
- "location": "query"
- },
- "userKey": {
- "type": "string",
- "description": "Email or immutable Id of the user",
- "required": true,
- "location": "path"
- },
- "viewType": {
- "type": "string",
- "description": "Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.",
- "default": "admin_view",
- "enum": [
- "admin_view",
- "domain_public"
- ],
- "enumDescriptions": [
- "Fetches the ADMIN_VIEW of the user.",
- "Fetches the DOMAIN_PUBLIC view of the user."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "response": {
- "$ref": "User"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user",
- "https://www.googleapis.com/auth/admin.directory.user.readonly"
- ]
- },
- "insert": {
- "id": "directory.users.insert",
- "path": "users",
- "httpMethod": "POST",
- "description": "create user.",
- "request": {
- "$ref": "User"
- },
- "response": {
- "$ref": "User"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user"
- ]
- },
- "list": {
- "id": "directory.users.list",
- "path": "users",
- "httpMethod": "GET",
- "description": "Retrieve either deleted users or all users in a domain (paginated)",
- "parameters": {
- "customFieldMask": {
- "type": "string",
- "description": "Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.",
- "location": "query"
- },
- "customer": {
- "type": "string",
- "description": "Immutable id of the Google Apps account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.",
- "location": "query"
- },
- "domain": {
- "type": "string",
- "description": "Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.",
- "location": "query"
- },
- "event": {
- "type": "string",
- "description": "Event on which subscription is intended (if subscribing)",
- "enum": [
- "add",
- "delete",
- "makeAdmin",
- "undelete",
- "update"
- ],
- "enumDescriptions": [
- "User Created Event",
- "User Deleted Event",
- "User Admin Status Change Event",
- "User Undeleted Event",
- "User Updated Event"
- ],
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return. Default is 100. Max allowed is 500",
- "format": "int32",
- "minimum": "1",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Column to use for sorting results",
- "enum": [
- "email",
- "familyName",
- "givenName"
- ],
- "enumDescriptions": [
- "Primary email of the user.",
- "User's family name.",
- "User's given name."
- ],
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify next page in the list",
- "location": "query"
- },
- "projection": {
- "type": "string",
- "description": "What subset of fields to fetch for this user.",
- "default": "basic",
- "enum": [
- "basic",
- "custom",
- "full"
- ],
- "enumDescriptions": [
- "Do not include any custom fields for the user.",
- "Include custom fields from schemas mentioned in customFieldMask.",
- "Include all fields associated with this user."
- ],
- "location": "query"
- },
- "query": {
- "type": "string",
- "description": "Query string search. Should be of the form \"\". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users",
- "location": "query"
- },
- "showDeleted": {
- "type": "string",
- "description": "If set to true retrieves the list of deleted users. Default is false",
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Whether to return results in ascending or descending order.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- },
- "viewType": {
- "type": "string",
- "description": "Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.",
- "default": "admin_view",
- "enum": [
- "admin_view",
- "domain_public"
- ],
- "enumDescriptions": [
- "Fetches the ADMIN_VIEW of the user.",
- "Fetches the DOMAIN_PUBLIC view of the user."
- ],
- "location": "query"
- }
- },
- "response": {
- "$ref": "Users"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user",
- "https://www.googleapis.com/auth/admin.directory.user.readonly"
- ],
- "supportsSubscription": true
- },
- "makeAdmin": {
- "id": "directory.users.makeAdmin",
- "path": "users/{userKey}/makeAdmin",
- "httpMethod": "POST",
- "description": "change admin status of a user",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "Email or immutable Id of the user as admin",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "request": {
- "$ref": "UserMakeAdmin"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user"
- ]
- },
- "patch": {
- "id": "directory.users.patch",
- "path": "users/{userKey}",
- "httpMethod": "PATCH",
- "description": "update user. This method supports patch semantics.",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "Email or immutable Id of the user. If Id, it should match with id of user object",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "request": {
- "$ref": "User"
- },
- "response": {
- "$ref": "User"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user"
- ]
- },
- "undelete": {
- "id": "directory.users.undelete",
- "path": "users/{userKey}/undelete",
- "httpMethod": "POST",
- "description": "Undelete a deleted user",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "The immutable id of the user",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "request": {
- "$ref": "UserUndelete"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user"
- ]
- },
- "update": {
- "id": "directory.users.update",
- "path": "users/{userKey}",
- "httpMethod": "PUT",
- "description": "update user",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "Email or immutable Id of the user. If Id, it should match with id of user object",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "request": {
- "$ref": "User"
- },
- "response": {
- "$ref": "User"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user"
- ]
- },
- "watch": {
- "id": "directory.users.watch",
- "path": "users/watch",
- "httpMethod": "POST",
- "description": "Watch for changes in users list",
- "parameters": {
- "customFieldMask": {
- "type": "string",
- "description": "Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.",
- "location": "query"
- },
- "customer": {
- "type": "string",
- "description": "Immutable id of the Google Apps account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.",
- "location": "query"
- },
- "domain": {
- "type": "string",
- "description": "Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.",
- "location": "query"
- },
- "event": {
- "type": "string",
- "description": "Event on which subscription is intended (if subscribing)",
- "enum": [
- "add",
- "delete",
- "makeAdmin",
- "undelete",
- "update"
- ],
- "enumDescriptions": [
- "User Created Event",
- "User Deleted Event",
- "User Admin Status Change Event",
- "User Undeleted Event",
- "User Updated Event"
- ],
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return. Default is 100. Max allowed is 500",
- "format": "int32",
- "minimum": "1",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Column to use for sorting results",
- "enum": [
- "email",
- "familyName",
- "givenName"
- ],
- "enumDescriptions": [
- "Primary email of the user.",
- "User's family name.",
- "User's given name."
- ],
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify next page in the list",
- "location": "query"
- },
- "projection": {
- "type": "string",
- "description": "What subset of fields to fetch for this user.",
- "default": "basic",
- "enum": [
- "basic",
- "custom",
- "full"
- ],
- "enumDescriptions": [
- "Do not include any custom fields for the user.",
- "Include custom fields from schemas mentioned in customFieldMask.",
- "Include all fields associated with this user."
- ],
- "location": "query"
- },
- "query": {
- "type": "string",
- "description": "Query string search. Should be of the form \"\". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users",
- "location": "query"
- },
- "showDeleted": {
- "type": "string",
- "description": "If set to true retrieves the list of deleted users. Default is false",
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Whether to return results in ascending or descending order.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- },
- "viewType": {
- "type": "string",
- "description": "Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.",
- "default": "admin_view",
- "enum": [
- "admin_view",
- "domain_public"
- ],
- "enumDescriptions": [
- "Fetches the ADMIN_VIEW of the user.",
- "Fetches the DOMAIN_PUBLIC view of the user."
- ],
- "location": "query"
- }
- },
- "request": {
- "$ref": "Channel",
- "parameterName": "resource"
- },
- "response": {
- "$ref": "Channel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user",
- "https://www.googleapis.com/auth/admin.directory.user.readonly"
- ],
- "supportsSubscription": true
- }
- },
- "resources": {
- "aliases": {
- "methods": {
- "delete": {
- "id": "directory.users.aliases.delete",
- "path": "users/{userKey}/aliases/{alias}",
- "httpMethod": "DELETE",
- "description": "Remove a alias for the user",
- "parameters": {
- "alias": {
- "type": "string",
- "description": "The alias to be removed",
- "required": true,
- "location": "path"
- },
- "userKey": {
- "type": "string",
- "description": "Email or immutable Id of the user",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey",
- "alias"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user",
- "https://www.googleapis.com/auth/admin.directory.user.alias"
- ]
- },
- "insert": {
- "id": "directory.users.aliases.insert",
- "path": "users/{userKey}/aliases",
- "httpMethod": "POST",
- "description": "Add a alias for the user",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "Email or immutable Id of the user",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "request": {
- "$ref": "Alias"
- },
- "response": {
- "$ref": "Alias"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user",
- "https://www.googleapis.com/auth/admin.directory.user.alias"
- ]
- },
- "list": {
- "id": "directory.users.aliases.list",
- "path": "users/{userKey}/aliases",
- "httpMethod": "GET",
- "description": "List all aliases for a user",
- "parameters": {
- "event": {
- "type": "string",
- "description": "Event on which subscription is intended (if subscribing)",
- "enum": [
- "add",
- "delete"
- ],
- "enumDescriptions": [
- "Alias Created Event",
- "Alias Deleted Event"
- ],
- "location": "query"
- },
- "userKey": {
- "type": "string",
- "description": "Email or immutable Id of the user",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "response": {
- "$ref": "Aliases"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user",
- "https://www.googleapis.com/auth/admin.directory.user.alias",
- "https://www.googleapis.com/auth/admin.directory.user.alias.readonly",
- "https://www.googleapis.com/auth/admin.directory.user.readonly"
- ],
- "supportsSubscription": true
- },
- "watch": {
- "id": "directory.users.aliases.watch",
- "path": "users/{userKey}/aliases/watch",
- "httpMethod": "POST",
- "description": "Watch for changes in user aliases list",
- "parameters": {
- "event": {
- "type": "string",
- "description": "Event on which subscription is intended (if subscribing)",
- "enum": [
- "add",
- "delete"
- ],
- "enumDescriptions": [
- "Alias Created Event",
- "Alias Deleted Event"
- ],
- "location": "query"
- },
- "userKey": {
- "type": "string",
- "description": "Email or immutable Id of the user",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "request": {
- "$ref": "Channel",
- "parameterName": "resource"
- },
- "response": {
- "$ref": "Channel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user",
- "https://www.googleapis.com/auth/admin.directory.user.alias",
- "https://www.googleapis.com/auth/admin.directory.user.alias.readonly",
- "https://www.googleapis.com/auth/admin.directory.user.readonly"
- ],
- "supportsSubscription": true
- }
- }
- },
- "photos": {
- "methods": {
- "delete": {
- "id": "directory.users.photos.delete",
- "path": "users/{userKey}/photos/thumbnail",
- "httpMethod": "DELETE",
- "description": "Remove photos for the user",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "Email or immutable Id of the user",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user"
- ]
- },
- "get": {
- "id": "directory.users.photos.get",
- "path": "users/{userKey}/photos/thumbnail",
- "httpMethod": "GET",
- "description": "Retrieve photo of a user",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "Email or immutable Id of the user",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "response": {
- "$ref": "UserPhoto"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user",
- "https://www.googleapis.com/auth/admin.directory.user.readonly"
- ]
- },
- "patch": {
- "id": "directory.users.photos.patch",
- "path": "users/{userKey}/photos/thumbnail",
- "httpMethod": "PATCH",
- "description": "Add a photo for the user. This method supports patch semantics.",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "Email or immutable Id of the user",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "request": {
- "$ref": "UserPhoto"
- },
- "response": {
- "$ref": "UserPhoto"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user"
- ]
- },
- "update": {
- "id": "directory.users.photos.update",
- "path": "users/{userKey}/photos/thumbnail",
- "httpMethod": "PUT",
- "description": "Add a photo for the user",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "Email or immutable Id of the user",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "request": {
- "$ref": "UserPhoto"
- },
- "response": {
- "$ref": "UserPhoto"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user"
- ]
- }
- }
- }
- }
- },
- "verificationCodes": {
- "methods": {
- "generate": {
- "id": "directory.verificationCodes.generate",
- "path": "users/{userKey}/verificationCodes/generate",
- "httpMethod": "POST",
- "description": "Generate new backup verification codes for the user.",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "Email or immutable Id of the user",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user.security"
- ]
- },
- "invalidate": {
- "id": "directory.verificationCodes.invalidate",
- "path": "users/{userKey}/verificationCodes/invalidate",
- "httpMethod": "POST",
- "description": "Invalidate the current backup verification codes for the user.",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "Email or immutable Id of the user",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user.security"
- ]
- },
- "list": {
- "id": "directory.verificationCodes.list",
- "path": "users/{userKey}/verificationCodes",
- "httpMethod": "GET",
- "description": "Returns the current set of valid backup verification codes for the specified user.",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "response": {
- "$ref": "VerificationCodes"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.directory.user.security"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/admin/directory/v1/admin-gen.go b/vendor/google.golang.org/api/admin/directory/v1/admin-gen.go
deleted file mode 100644
index fb70345b..00000000
--- a/vendor/google.golang.org/api/admin/directory/v1/admin-gen.go
+++ /dev/null
@@ -1,14810 +0,0 @@
-// Package admin provides access to the Admin Directory API.
-//
-// See https://developers.google.com/admin-sdk/directory/
-//
-// Usage example:
-//
-// import "google.golang.org/api/admin/directory/v1"
-// ...
-// adminService, err := admin.New(oauthHttpClient)
-package admin // import "google.golang.org/api/admin/directory/v1"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "admin:directory_v1"
-const apiName = "admin"
-const apiVersion = "directory_v1"
-const basePath = "https://www.googleapis.com/admin/directory/v1/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage customer related information
- AdminDirectoryCustomerScope = "https://www.googleapis.com/auth/admin.directory.customer"
-
- // View customer related information
- AdminDirectoryCustomerReadonlyScope = "https://www.googleapis.com/auth/admin.directory.customer.readonly"
-
- // View and manage your Chrome OS devices' metadata
- AdminDirectoryDeviceChromeosScope = "https://www.googleapis.com/auth/admin.directory.device.chromeos"
-
- // View your Chrome OS devices' metadata
- AdminDirectoryDeviceChromeosReadonlyScope = "https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly"
-
- // View and manage your mobile devices' metadata
- AdminDirectoryDeviceMobileScope = "https://www.googleapis.com/auth/admin.directory.device.mobile"
-
- // Manage your mobile devices by performing administrative tasks
- AdminDirectoryDeviceMobileActionScope = "https://www.googleapis.com/auth/admin.directory.device.mobile.action"
-
- // View your mobile devices' metadata
- AdminDirectoryDeviceMobileReadonlyScope = "https://www.googleapis.com/auth/admin.directory.device.mobile.readonly"
-
- // View and manage the provisioning of domains for your customers
- AdminDirectoryDomainScope = "https://www.googleapis.com/auth/admin.directory.domain"
-
- // View domains related to your customers
- AdminDirectoryDomainReadonlyScope = "https://www.googleapis.com/auth/admin.directory.domain.readonly"
-
- // View and manage the provisioning of groups on your domain
- AdminDirectoryGroupScope = "https://www.googleapis.com/auth/admin.directory.group"
-
- // View and manage group subscriptions on your domain
- AdminDirectoryGroupMemberScope = "https://www.googleapis.com/auth/admin.directory.group.member"
-
- // View group subscriptions on your domain
- AdminDirectoryGroupMemberReadonlyScope = "https://www.googleapis.com/auth/admin.directory.group.member.readonly"
-
- // View groups on your domain
- AdminDirectoryGroupReadonlyScope = "https://www.googleapis.com/auth/admin.directory.group.readonly"
-
- // View and manage notifications received on your domain
- AdminDirectoryNotificationsScope = "https://www.googleapis.com/auth/admin.directory.notifications"
-
- // View and manage organization units on your domain
- AdminDirectoryOrgunitScope = "https://www.googleapis.com/auth/admin.directory.orgunit"
-
- // View organization units on your domain
- AdminDirectoryOrgunitReadonlyScope = "https://www.googleapis.com/auth/admin.directory.orgunit.readonly"
-
- // Manage delegated admin roles for your domain
- AdminDirectoryRolemanagementScope = "https://www.googleapis.com/auth/admin.directory.rolemanagement"
-
- // View delegated admin roles for your domain
- AdminDirectoryRolemanagementReadonlyScope = "https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly"
-
- // View and manage the provisioning of users on your domain
- AdminDirectoryUserScope = "https://www.googleapis.com/auth/admin.directory.user"
-
- // View and manage user aliases on your domain
- AdminDirectoryUserAliasScope = "https://www.googleapis.com/auth/admin.directory.user.alias"
-
- // View user aliases on your domain
- AdminDirectoryUserAliasReadonlyScope = "https://www.googleapis.com/auth/admin.directory.user.alias.readonly"
-
- // View users on your domain
- AdminDirectoryUserReadonlyScope = "https://www.googleapis.com/auth/admin.directory.user.readonly"
-
- // Manage data access permissions for users on your domain
- AdminDirectoryUserSecurityScope = "https://www.googleapis.com/auth/admin.directory.user.security"
-
- // View and manage the provisioning of user schemas on your domain
- AdminDirectoryUserschemaScope = "https://www.googleapis.com/auth/admin.directory.userschema"
-
- // View user schemas on your domain
- AdminDirectoryUserschemaReadonlyScope = "https://www.googleapis.com/auth/admin.directory.userschema.readonly"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Asps = NewAspsService(s)
- s.Channels = NewChannelsService(s)
- s.Chromeosdevices = NewChromeosdevicesService(s)
- s.Customers = NewCustomersService(s)
- s.DomainAliases = NewDomainAliasesService(s)
- s.Domains = NewDomainsService(s)
- s.Groups = NewGroupsService(s)
- s.Members = NewMembersService(s)
- s.Mobiledevices = NewMobiledevicesService(s)
- s.Notifications = NewNotificationsService(s)
- s.Orgunits = NewOrgunitsService(s)
- s.Privileges = NewPrivilegesService(s)
- s.RoleAssignments = NewRoleAssignmentsService(s)
- s.Roles = NewRolesService(s)
- s.Schemas = NewSchemasService(s)
- s.Tokens = NewTokensService(s)
- s.Users = NewUsersService(s)
- s.VerificationCodes = NewVerificationCodesService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Asps *AspsService
-
- Channels *ChannelsService
-
- Chromeosdevices *ChromeosdevicesService
-
- Customers *CustomersService
-
- DomainAliases *DomainAliasesService
-
- Domains *DomainsService
-
- Groups *GroupsService
-
- Members *MembersService
-
- Mobiledevices *MobiledevicesService
-
- Notifications *NotificationsService
-
- Orgunits *OrgunitsService
-
- Privileges *PrivilegesService
-
- RoleAssignments *RoleAssignmentsService
-
- Roles *RolesService
-
- Schemas *SchemasService
-
- Tokens *TokensService
-
- Users *UsersService
-
- VerificationCodes *VerificationCodesService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewAspsService(s *Service) *AspsService {
- rs := &AspsService{s: s}
- return rs
-}
-
-type AspsService struct {
- s *Service
-}
-
-func NewChannelsService(s *Service) *ChannelsService {
- rs := &ChannelsService{s: s}
- return rs
-}
-
-type ChannelsService struct {
- s *Service
-}
-
-func NewChromeosdevicesService(s *Service) *ChromeosdevicesService {
- rs := &ChromeosdevicesService{s: s}
- return rs
-}
-
-type ChromeosdevicesService struct {
- s *Service
-}
-
-func NewCustomersService(s *Service) *CustomersService {
- rs := &CustomersService{s: s}
- return rs
-}
-
-type CustomersService struct {
- s *Service
-}
-
-func NewDomainAliasesService(s *Service) *DomainAliasesService {
- rs := &DomainAliasesService{s: s}
- return rs
-}
-
-type DomainAliasesService struct {
- s *Service
-}
-
-func NewDomainsService(s *Service) *DomainsService {
- rs := &DomainsService{s: s}
- return rs
-}
-
-type DomainsService struct {
- s *Service
-}
-
-func NewGroupsService(s *Service) *GroupsService {
- rs := &GroupsService{s: s}
- rs.Aliases = NewGroupsAliasesService(s)
- return rs
-}
-
-type GroupsService struct {
- s *Service
-
- Aliases *GroupsAliasesService
-}
-
-func NewGroupsAliasesService(s *Service) *GroupsAliasesService {
- rs := &GroupsAliasesService{s: s}
- return rs
-}
-
-type GroupsAliasesService struct {
- s *Service
-}
-
-func NewMembersService(s *Service) *MembersService {
- rs := &MembersService{s: s}
- return rs
-}
-
-type MembersService struct {
- s *Service
-}
-
-func NewMobiledevicesService(s *Service) *MobiledevicesService {
- rs := &MobiledevicesService{s: s}
- return rs
-}
-
-type MobiledevicesService struct {
- s *Service
-}
-
-func NewNotificationsService(s *Service) *NotificationsService {
- rs := &NotificationsService{s: s}
- return rs
-}
-
-type NotificationsService struct {
- s *Service
-}
-
-func NewOrgunitsService(s *Service) *OrgunitsService {
- rs := &OrgunitsService{s: s}
- return rs
-}
-
-type OrgunitsService struct {
- s *Service
-}
-
-func NewPrivilegesService(s *Service) *PrivilegesService {
- rs := &PrivilegesService{s: s}
- return rs
-}
-
-type PrivilegesService struct {
- s *Service
-}
-
-func NewRoleAssignmentsService(s *Service) *RoleAssignmentsService {
- rs := &RoleAssignmentsService{s: s}
- return rs
-}
-
-type RoleAssignmentsService struct {
- s *Service
-}
-
-func NewRolesService(s *Service) *RolesService {
- rs := &RolesService{s: s}
- return rs
-}
-
-type RolesService struct {
- s *Service
-}
-
-func NewSchemasService(s *Service) *SchemasService {
- rs := &SchemasService{s: s}
- return rs
-}
-
-type SchemasService struct {
- s *Service
-}
-
-func NewTokensService(s *Service) *TokensService {
- rs := &TokensService{s: s}
- return rs
-}
-
-type TokensService struct {
- s *Service
-}
-
-func NewUsersService(s *Service) *UsersService {
- rs := &UsersService{s: s}
- rs.Aliases = NewUsersAliasesService(s)
- rs.Photos = NewUsersPhotosService(s)
- return rs
-}
-
-type UsersService struct {
- s *Service
-
- Aliases *UsersAliasesService
-
- Photos *UsersPhotosService
-}
-
-func NewUsersAliasesService(s *Service) *UsersAliasesService {
- rs := &UsersAliasesService{s: s}
- return rs
-}
-
-type UsersAliasesService struct {
- s *Service
-}
-
-func NewUsersPhotosService(s *Service) *UsersPhotosService {
- rs := &UsersPhotosService{s: s}
- return rs
-}
-
-type UsersPhotosService struct {
- s *Service
-}
-
-func NewVerificationCodesService(s *Service) *VerificationCodesService {
- rs := &VerificationCodesService{s: s}
- return rs
-}
-
-type VerificationCodesService struct {
- s *Service
-}
-
-// Alias: JSON template for Alias object in Directory API.
-type Alias struct {
- // Alias: A alias email
- Alias string `json:"alias,omitempty"`
-
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Id: Unique id of the group (Read-only) Unique id of the user
- // (Read-only)
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is.
- Kind string `json:"kind,omitempty"`
-
- // PrimaryEmail: Group's primary email (Read-only) User's primary email
- // (Read-only)
- PrimaryEmail string `json:"primaryEmail,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Alias") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Alias) MarshalJSON() ([]byte, error) {
- type noMethod Alias
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Aliases: JSON response template to list aliases in Directory API.
-type Aliases struct {
- // Aliases: List of alias objects.
- Aliases []*Alias `json:"aliases,omitempty"`
-
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Kind: Kind of resource this is.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Aliases") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Aliases) MarshalJSON() ([]byte, error) {
- type noMethod Aliases
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Asp: The template that returns individual ASP (Access Code) data.
-type Asp struct {
- // CodeId: The unique ID of the ASP.
- CodeId int64 `json:"codeId,omitempty"`
-
- // CreationTime: The time when the ASP was created. Expressed in Unix
- // time format.
- CreationTime int64 `json:"creationTime,omitempty,string"`
-
- // Etag: ETag of the ASP.
- Etag string `json:"etag,omitempty"`
-
- // Kind: The type of the API resource. This is always
- // admin#directory#asp.
- Kind string `json:"kind,omitempty"`
-
- // LastTimeUsed: The time when the ASP was last used. Expressed in Unix
- // time format.
- LastTimeUsed int64 `json:"lastTimeUsed,omitempty,string"`
-
- // Name: The name of the application that the user, represented by their
- // userId, entered when the ASP was created.
- Name string `json:"name,omitempty"`
-
- // UserKey: The unique ID of the user who issued the ASP.
- UserKey string `json:"userKey,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CodeId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Asp) MarshalJSON() ([]byte, error) {
- type noMethod Asp
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Asps struct {
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Items: A list of ASP resources.
- Items []*Asp `json:"items,omitempty"`
-
- // Kind: The type of the API resource. This is always
- // admin#directory#aspList.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Asps) MarshalJSON() ([]byte, error) {
- type noMethod Asps
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Channel: An notification channel used to watch for resource changes.
-type Channel struct {
- // Address: The address where notifications are delivered for this
- // channel.
- Address string `json:"address,omitempty"`
-
- // Expiration: Date and time of notification channel expiration,
- // expressed as a Unix timestamp, in milliseconds. Optional.
- Expiration int64 `json:"expiration,omitempty,string"`
-
- // Id: A UUID or similar unique string that identifies this channel.
- Id string `json:"id,omitempty"`
-
- // Kind: Identifies this as a notification channel used to watch for
- // changes to a resource. Value: the fixed string "api#channel".
- Kind string `json:"kind,omitempty"`
-
- // Params: Additional parameters controlling delivery channel behavior.
- // Optional.
- Params map[string]string `json:"params,omitempty"`
-
- // Payload: A Boolean value to indicate whether payload is wanted.
- // Optional.
- Payload bool `json:"payload,omitempty"`
-
- // ResourceId: An opaque ID that identifies the resource being watched
- // on this channel. Stable across different API versions.
- ResourceId string `json:"resourceId,omitempty"`
-
- // ResourceUri: A version-specific identifier for the watched resource.
- ResourceUri string `json:"resourceUri,omitempty"`
-
- // Token: An arbitrary string delivered to the target address with each
- // notification delivered over this channel. Optional.
- Token string `json:"token,omitempty"`
-
- // Type: The type of delivery mechanism used for this channel.
- Type string `json:"type,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Address") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Channel) MarshalJSON() ([]byte, error) {
- type noMethod Channel
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ChromeOsDevice: JSON template for Chrome Os Device resource in
-// Directory API.
-type ChromeOsDevice struct {
- // ActiveTimeRanges: List of active time ranges (Read-only)
- ActiveTimeRanges []*ChromeOsDeviceActiveTimeRanges `json:"activeTimeRanges,omitempty"`
-
- // AnnotatedAssetId: AssetId specified during enrollment or through
- // later annotation
- AnnotatedAssetId string `json:"annotatedAssetId,omitempty"`
-
- // AnnotatedLocation: Address or location of the device as noted by the
- // administrator
- AnnotatedLocation string `json:"annotatedLocation,omitempty"`
-
- // AnnotatedUser: User of the device
- AnnotatedUser string `json:"annotatedUser,omitempty"`
-
- // BootMode: Chromebook boot mode (Read-only)
- BootMode string `json:"bootMode,omitempty"`
-
- // DeviceId: Unique identifier of Chrome OS Device (Read-only)
- DeviceId string `json:"deviceId,omitempty"`
-
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // EthernetMacAddress: Chromebook Mac Address on ethernet network
- // interface (Read-only)
- EthernetMacAddress string `json:"ethernetMacAddress,omitempty"`
-
- // FirmwareVersion: Chromebook firmware version (Read-only)
- FirmwareVersion string `json:"firmwareVersion,omitempty"`
-
- // Kind: Kind of resource this is.
- Kind string `json:"kind,omitempty"`
-
- // LastEnrollmentTime: Date and time the device was last enrolled
- // (Read-only)
- LastEnrollmentTime string `json:"lastEnrollmentTime,omitempty"`
-
- // LastSync: Date and time the device was last synchronized with the
- // policy settings in the Google Apps administrator control panel
- // (Read-only)
- LastSync string `json:"lastSync,omitempty"`
-
- // MacAddress: Chromebook Mac Address on wifi network interface
- // (Read-only)
- MacAddress string `json:"macAddress,omitempty"`
-
- // Meid: Mobile Equipment identifier for the 3G mobile card in the
- // Chromebook (Read-only)
- Meid string `json:"meid,omitempty"`
-
- // Model: Chromebook Model (Read-only)
- Model string `json:"model,omitempty"`
-
- // Notes: Notes added by the administrator
- Notes string `json:"notes,omitempty"`
-
- // OrderNumber: Chromebook order number (Read-only)
- OrderNumber string `json:"orderNumber,omitempty"`
-
- // OrgUnitPath: OrgUnit of the device
- OrgUnitPath string `json:"orgUnitPath,omitempty"`
-
- // OsVersion: Chromebook Os Version (Read-only)
- OsVersion string `json:"osVersion,omitempty"`
-
- // PlatformVersion: Chromebook platform version (Read-only)
- PlatformVersion string `json:"platformVersion,omitempty"`
-
- // RecentUsers: List of recent device users, in descending order by last
- // login time (Read-only)
- RecentUsers []*ChromeOsDeviceRecentUsers `json:"recentUsers,omitempty"`
-
- // SerialNumber: Chromebook serial number (Read-only)
- SerialNumber string `json:"serialNumber,omitempty"`
-
- // Status: status of the device (Read-only)
- Status string `json:"status,omitempty"`
-
- // SupportEndDate: Final date the device will be supported (Read-only)
- SupportEndDate string `json:"supportEndDate,omitempty"`
-
- // WillAutoRenew: Will Chromebook auto renew after support end date
- // (Read-only)
- WillAutoRenew bool `json:"willAutoRenew,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ActiveTimeRanges") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ChromeOsDevice) MarshalJSON() ([]byte, error) {
- type noMethod ChromeOsDevice
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ChromeOsDeviceActiveTimeRanges struct {
- // ActiveTime: Duration in milliseconds
- ActiveTime int64 `json:"activeTime,omitempty"`
-
- // Date: Date of usage
- Date string `json:"date,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ActiveTime") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ChromeOsDeviceActiveTimeRanges) MarshalJSON() ([]byte, error) {
- type noMethod ChromeOsDeviceActiveTimeRanges
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ChromeOsDeviceRecentUsers struct {
- // Email: Email address of the user. Present only if the user type is
- // managed
- Email string `json:"email,omitempty"`
-
- // Type: The type of the user
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Email") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ChromeOsDeviceRecentUsers) MarshalJSON() ([]byte, error) {
- type noMethod ChromeOsDeviceRecentUsers
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ChromeOsDevices: JSON response template for List Chrome OS Devices
-// operation in Directory API.
-type ChromeOsDevices struct {
- // Chromeosdevices: List of Chrome OS Device objects.
- Chromeosdevices []*ChromeOsDevice `json:"chromeosdevices,omitempty"`
-
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Kind: Kind of resource this is.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Token used to access next page of this result.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Chromeosdevices") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ChromeOsDevices) MarshalJSON() ([]byte, error) {
- type noMethod ChromeOsDevices
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Customer: JSON template for Customer Resource object in Directory
-// API.
-type Customer struct {
- // AlternateEmail: The customer's secondary contact email address. This
- // email address cannot be on the same domain as the customerDomain
- AlternateEmail string `json:"alternateEmail,omitempty"`
-
- // CustomerCreationTime: The customer's creation time (Readonly)
- CustomerCreationTime string `json:"customerCreationTime,omitempty"`
-
- // CustomerDomain: The customer's primary domain name string. Do not
- // include the www prefix when creating a new customer.
- CustomerDomain string `json:"customerDomain,omitempty"`
-
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Id: The unique ID for the customer's Google account. (Readonly)
- Id string `json:"id,omitempty"`
-
- // Kind: Identifies the resource as a customer. Value:
- // admin#directory#customer
- Kind string `json:"kind,omitempty"`
-
- // Language: The customer's ISO 639-2 language code. The default value
- // is en-US
- Language string `json:"language,omitempty"`
-
- // PhoneNumber: The customer's contact phone number in E.164 format.
- PhoneNumber string `json:"phoneNumber,omitempty"`
-
- // PostalAddress: The customer's postal address information.
- PostalAddress *CustomerPostalAddress `json:"postalAddress,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AlternateEmail") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Customer) MarshalJSON() ([]byte, error) {
- type noMethod Customer
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CustomerPostalAddress: JSON template for postal address of a
-// customer.
-type CustomerPostalAddress struct {
- // AddressLine1: A customer's physical address. The address can be
- // composed of one to three lines.
- AddressLine1 string `json:"addressLine1,omitempty"`
-
- // AddressLine2: Address line 2 of the address.
- AddressLine2 string `json:"addressLine2,omitempty"`
-
- // AddressLine3: Address line 3 of the address.
- AddressLine3 string `json:"addressLine3,omitempty"`
-
- // ContactName: The customer contact's name.
- ContactName string `json:"contactName,omitempty"`
-
- // CountryCode: This is a required property. For countryCode information
- // see the ISO 3166 country code elements.
- CountryCode string `json:"countryCode,omitempty"`
-
- // Locality: Name of the locality. An example of a locality value is the
- // city of San Francisco.
- Locality string `json:"locality,omitempty"`
-
- // OrganizationName: The company or company division name.
- OrganizationName string `json:"organizationName,omitempty"`
-
- // PostalCode: The postal code. A postalCode example is a postal zip
- // code such as 10009. This is in accordance with -
- // http://portablecontacts.net/draft-spec.html#address_element.
- PostalCode string `json:"postalCode,omitempty"`
-
- // Region: Name of the region. An example of a region value is NY for
- // the state of New York.
- Region string `json:"region,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AddressLine1") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomerPostalAddress) MarshalJSON() ([]byte, error) {
- type noMethod CustomerPostalAddress
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DomainAlias: JSON template for Domain Alias object in Directory API.
-type DomainAlias struct {
- // CreationTime: The creation time of the domain alias. (Read-only).
- CreationTime int64 `json:"creationTime,omitempty,string"`
-
- // DomainAliasName: The domain alias name.
- DomainAliasName string `json:"domainAliasName,omitempty"`
-
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Kind: Kind of resource this is.
- Kind string `json:"kind,omitempty"`
-
- // ParentDomainName: The parent domain name that the domain alias is
- // associated with. This can either be a primary or secondary domain
- // name within a customer.
- ParentDomainName string `json:"parentDomainName,omitempty"`
-
- // Verified: Indicates the verification state of a domain alias.
- // (Read-only)
- Verified bool `json:"verified,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTime") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DomainAlias) MarshalJSON() ([]byte, error) {
- type noMethod DomainAlias
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DomainAliases: JSON response template to list domain aliases in
-// Directory API.
-type DomainAliases struct {
- // DomainAliases: List of domain alias objects.
- DomainAliases []*DomainAlias `json:"domainAliases,omitempty"`
-
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Kind: Kind of resource this is.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "DomainAliases") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DomainAliases) MarshalJSON() ([]byte, error) {
- type noMethod DomainAliases
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Domains: JSON template for Domain object in Directory API.
-type Domains struct {
- // CreationTime: Creation time of the domain. (Read-only).
- CreationTime int64 `json:"creationTime,omitempty,string"`
-
- // DomainAliases: List of domain alias objects. (Read-only)
- DomainAliases []*DomainAlias `json:"domainAliases,omitempty"`
-
- // DomainName: The domain name of the customer.
- DomainName string `json:"domainName,omitempty"`
-
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // IsPrimary: Indicates if the domain is a primary domain (Read-only).
- IsPrimary bool `json:"isPrimary,omitempty"`
-
- // Kind: Kind of resource this is.
- Kind string `json:"kind,omitempty"`
-
- // Verified: Indicates the verification state of a domain. (Read-only).
- Verified bool `json:"verified,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTime") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Domains) MarshalJSON() ([]byte, error) {
- type noMethod Domains
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Domains2: JSON response template to list Domains in Directory API.
-type Domains2 struct {
- // Domains: List of domain objects.
- Domains []*Domains `json:"domains,omitempty"`
-
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Kind: Kind of resource this is.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Domains") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Domains2) MarshalJSON() ([]byte, error) {
- type noMethod Domains2
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Group: JSON template for Group resource in Directory API.
-type Group struct {
- // AdminCreated: Is the group created by admin (Read-only) *
- AdminCreated bool `json:"adminCreated,omitempty"`
-
- // Aliases: List of aliases (Read-only)
- Aliases []string `json:"aliases,omitempty"`
-
- // Description: Description of the group
- Description string `json:"description,omitempty"`
-
- // DirectMembersCount: Group direct members count
- DirectMembersCount int64 `json:"directMembersCount,omitempty,string"`
-
- // Email: Email of Group
- Email string `json:"email,omitempty"`
-
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Id: Unique identifier of Group (Read-only)
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is.
- Kind string `json:"kind,omitempty"`
-
- // Name: Group name
- Name string `json:"name,omitempty"`
-
- // NonEditableAliases: List of non editable aliases (Read-only)
- NonEditableAliases []string `json:"nonEditableAliases,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AdminCreated") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Group) MarshalJSON() ([]byte, error) {
- type noMethod Group
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Groups: JSON response template for List Groups operation in Directory
-// API.
-type Groups struct {
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Groups: List of group objects.
- Groups []*Group `json:"groups,omitempty"`
-
- // Kind: Kind of resource this is.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Token used to access next page of this result.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Groups) MarshalJSON() ([]byte, error) {
- type noMethod Groups
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Member: JSON template for Member resource in Directory API.
-type Member struct {
- // Email: Email of member (Read-only)
- Email string `json:"email,omitempty"`
-
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Id: Unique identifier of customer member (Read-only) Unique
- // identifier of group (Read-only) Unique identifier of member
- // (Read-only)
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is.
- Kind string `json:"kind,omitempty"`
-
- // Role: Role of member
- Role string `json:"role,omitempty"`
-
- // Type: Type of member (Immutable)
- Type string `json:"type,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Email") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Member) MarshalJSON() ([]byte, error) {
- type noMethod Member
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Members: JSON response template for List Members operation in
-// Directory API.
-type Members struct {
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Kind: Kind of resource this is.
- Kind string `json:"kind,omitempty"`
-
- // Members: List of member objects.
- Members []*Member `json:"members,omitempty"`
-
- // NextPageToken: Token used to access next page of this result.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Members) MarshalJSON() ([]byte, error) {
- type noMethod Members
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MobileDevice: JSON template for Mobile Device resource in Directory
-// API.
-type MobileDevice struct {
- // AdbStatus: Adb (USB debugging) enabled or disabled on device
- // (Read-only)
- AdbStatus bool `json:"adbStatus,omitempty"`
-
- // Applications: List of applications installed on Mobile Device
- Applications []*MobileDeviceApplications `json:"applications,omitempty"`
-
- // BasebandVersion: Mobile Device Baseband version (Read-only)
- BasebandVersion string `json:"basebandVersion,omitempty"`
-
- // BuildNumber: Mobile Device Build number (Read-only)
- BuildNumber string `json:"buildNumber,omitempty"`
-
- // DefaultLanguage: The default locale used on the Mobile Device
- // (Read-only)
- DefaultLanguage string `json:"defaultLanguage,omitempty"`
-
- // DeveloperOptionsStatus: Developer options enabled or disabled on
- // device (Read-only)
- DeveloperOptionsStatus bool `json:"developerOptionsStatus,omitempty"`
-
- // DeviceCompromisedStatus: Mobile Device compromised status (Read-only)
- DeviceCompromisedStatus string `json:"deviceCompromisedStatus,omitempty"`
-
- // DeviceId: Mobile Device serial number (Read-only)
- DeviceId string `json:"deviceId,omitempty"`
-
- // Email: List of owner user's email addresses (Read-only)
- Email []string `json:"email,omitempty"`
-
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // FirstSync: Date and time the device was first synchronized with the
- // policy settings in the Google Apps administrator control panel
- // (Read-only)
- FirstSync string `json:"firstSync,omitempty"`
-
- // HardwareId: Mobile Device Hardware Id (Read-only)
- HardwareId string `json:"hardwareId,omitempty"`
-
- // Imei: Mobile Device IMEI number (Read-only)
- Imei string `json:"imei,omitempty"`
-
- // KernelVersion: Mobile Device Kernel version (Read-only)
- KernelVersion string `json:"kernelVersion,omitempty"`
-
- // Kind: Kind of resource this is.
- Kind string `json:"kind,omitempty"`
-
- // LastSync: Date and time the device was last synchronized with the
- // policy settings in the Google Apps administrator control panel
- // (Read-only)
- LastSync string `json:"lastSync,omitempty"`
-
- // ManagedAccountIsOnOwnerProfile: Boolean indicating if this account is
- // on owner/primary profile or not (Read-only)
- ManagedAccountIsOnOwnerProfile bool `json:"managedAccountIsOnOwnerProfile,omitempty"`
-
- // Meid: Mobile Device MEID number (Read-only)
- Meid string `json:"meid,omitempty"`
-
- // Model: Name of the model of the device
- Model string `json:"model,omitempty"`
-
- // Name: List of owner user's names (Read-only)
- Name []string `json:"name,omitempty"`
-
- // NetworkOperator: Mobile Device mobile or network operator (if
- // available) (Read-only)
- NetworkOperator string `json:"networkOperator,omitempty"`
-
- // Os: Name of the mobile operating system
- Os string `json:"os,omitempty"`
-
- // OtherAccountsInfo: List of accounts added on device (Read-only)
- OtherAccountsInfo []string `json:"otherAccountsInfo,omitempty"`
-
- // ResourceId: Unique identifier of Mobile Device (Read-only)
- ResourceId string `json:"resourceId,omitempty"`
-
- // SerialNumber: Mobile Device SSN or Serial Number (Read-only)
- SerialNumber string `json:"serialNumber,omitempty"`
-
- // Status: Status of the device (Read-only)
- Status string `json:"status,omitempty"`
-
- // SupportsWorkProfile: Work profile supported on device (Read-only)
- SupportsWorkProfile bool `json:"supportsWorkProfile,omitempty"`
-
- // Type: The type of device (Read-only)
- Type string `json:"type,omitempty"`
-
- // UnknownSourcesStatus: Unknown sources enabled or disabled on device
- // (Read-only)
- UnknownSourcesStatus bool `json:"unknownSourcesStatus,omitempty"`
-
- // UserAgent: Mobile Device user agent
- UserAgent string `json:"userAgent,omitempty"`
-
- // WifiMacAddress: Mobile Device WiFi MAC address (Read-only)
- WifiMacAddress string `json:"wifiMacAddress,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AdbStatus") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MobileDevice) MarshalJSON() ([]byte, error) {
- type noMethod MobileDevice
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type MobileDeviceApplications struct {
- // DisplayName: Display name of application
- DisplayName string `json:"displayName,omitempty"`
-
- // PackageName: Package name of application
- PackageName string `json:"packageName,omitempty"`
-
- // Permission: List of Permissions for application
- Permission []string `json:"permission,omitempty"`
-
- // VersionCode: Version code of application
- VersionCode int64 `json:"versionCode,omitempty"`
-
- // VersionName: Version name of application
- VersionName string `json:"versionName,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DisplayName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MobileDeviceApplications) MarshalJSON() ([]byte, error) {
- type noMethod MobileDeviceApplications
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MobileDeviceAction: JSON request template for firing commands on
-// Mobile Device in Directory Devices API.
-type MobileDeviceAction struct {
- // Action: Action to be taken on the Mobile Device
- Action string `json:"action,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Action") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MobileDeviceAction) MarshalJSON() ([]byte, error) {
- type noMethod MobileDeviceAction
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MobileDevices: JSON response template for List Mobile Devices
-// operation in Directory API.
-type MobileDevices struct {
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Kind: Kind of resource this is.
- Kind string `json:"kind,omitempty"`
-
- // Mobiledevices: List of Mobile Device objects.
- Mobiledevices []*MobileDevice `json:"mobiledevices,omitempty"`
-
- // NextPageToken: Token used to access next page of this result.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MobileDevices) MarshalJSON() ([]byte, error) {
- type noMethod MobileDevices
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Notification: Template for a notification resource.
-type Notification struct {
- // Body: Body of the notification (Read-only)
- Body string `json:"body,omitempty"`
-
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // FromAddress: Address from which the notification is received
- // (Read-only)
- FromAddress string `json:"fromAddress,omitempty"`
-
- // IsUnread: Boolean indicating whether the notification is unread or
- // not.
- IsUnread bool `json:"isUnread,omitempty"`
-
- // Kind: The type of the resource.
- Kind string `json:"kind,omitempty"`
-
- NotificationId string `json:"notificationId,omitempty"`
-
- // SendTime: Time at which notification was sent (Read-only)
- SendTime string `json:"sendTime,omitempty"`
-
- // Subject: Subject of the notification (Read-only)
- Subject string `json:"subject,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Body") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Notification) MarshalJSON() ([]byte, error) {
- type noMethod Notification
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Notifications: Template for notifications list response.
-type Notifications struct {
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Items: List of notifications in this page.
- Items []*Notification `json:"items,omitempty"`
-
- // Kind: The type of the resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Token for fetching the next page of notifications.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // UnreadNotificationsCount: Number of unread notification for the
- // domain.
- UnreadNotificationsCount int64 `json:"unreadNotificationsCount,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Notifications) MarshalJSON() ([]byte, error) {
- type noMethod Notifications
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OrgUnit: JSON template for Org Unit resource in Directory API.
-type OrgUnit struct {
- // BlockInheritance: Should block inheritance
- BlockInheritance bool `json:"blockInheritance,omitempty"`
-
- // Description: Description of OrgUnit
- Description string `json:"description,omitempty"`
-
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Kind: Kind of resource this is.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of OrgUnit
- Name string `json:"name,omitempty"`
-
- // OrgUnitId: Id of OrgUnit
- OrgUnitId string `json:"orgUnitId,omitempty"`
-
- // OrgUnitPath: Path of OrgUnit
- OrgUnitPath string `json:"orgUnitPath,omitempty"`
-
- // ParentOrgUnitId: Id of parent OrgUnit
- ParentOrgUnitId string `json:"parentOrgUnitId,omitempty"`
-
- // ParentOrgUnitPath: Path of parent OrgUnit
- ParentOrgUnitPath string `json:"parentOrgUnitPath,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "BlockInheritance") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrgUnit) MarshalJSON() ([]byte, error) {
- type noMethod OrgUnit
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OrgUnits: JSON response template for List Organization Units
-// operation in Directory API.
-type OrgUnits struct {
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Kind: Kind of resource this is.
- Kind string `json:"kind,omitempty"`
-
- // OrganizationUnits: List of user objects.
- OrganizationUnits []*OrgUnit `json:"organizationUnits,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrgUnits) MarshalJSON() ([]byte, error) {
- type noMethod OrgUnits
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Privilege: JSON template for privilege resource in Directory API.
-type Privilege struct {
- // ChildPrivileges: A list of child privileges. Privileges for a service
- // form a tree. Each privilege can have a list of child privileges; this
- // list is empty for a leaf privilege.
- ChildPrivileges []*Privilege `json:"childPrivileges,omitempty"`
-
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // IsOuScopable: If the privilege can be restricted to an organization
- // unit.
- IsOuScopable bool `json:"isOuScopable,omitempty"`
-
- // Kind: The type of the API resource. This is always
- // admin#directory#privilege.
- Kind string `json:"kind,omitempty"`
-
- // PrivilegeName: The name of the privilege.
- PrivilegeName string `json:"privilegeName,omitempty"`
-
- // ServiceId: The obfuscated ID of the service this privilege is for.
- ServiceId string `json:"serviceId,omitempty"`
-
- // ServiceName: The name of the service this privilege is for.
- ServiceName string `json:"serviceName,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ChildPrivileges") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Privilege) MarshalJSON() ([]byte, error) {
- type noMethod Privilege
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Privileges: JSON response template for List privileges operation in
-// Directory API.
-type Privileges struct {
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Items: A list of Privilege resources.
- Items []*Privilege `json:"items,omitempty"`
-
- // Kind: The type of the API resource. This is always
- // admin#directory#privileges.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Privileges) MarshalJSON() ([]byte, error) {
- type noMethod Privileges
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Role: JSON template for role resource in Directory API.
-type Role struct {
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // IsSuperAdminRole: Returns true if the role is a super admin role.
- IsSuperAdminRole bool `json:"isSuperAdminRole,omitempty"`
-
- // IsSystemRole: Returns true if this is a pre-defined system role.
- IsSystemRole bool `json:"isSystemRole,omitempty"`
-
- // Kind: The type of the API resource. This is always
- // admin#directory#role.
- Kind string `json:"kind,omitempty"`
-
- // RoleDescription: A short description of the role.
- RoleDescription string `json:"roleDescription,omitempty"`
-
- // RoleId: ID of the role.
- RoleId int64 `json:"roleId,omitempty,string"`
-
- // RoleName: Name of the role.
- RoleName string `json:"roleName,omitempty"`
-
- // RolePrivileges: The set of privileges that are granted to this role.
- RolePrivileges []*RoleRolePrivileges `json:"rolePrivileges,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Role) MarshalJSON() ([]byte, error) {
- type noMethod Role
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type RoleRolePrivileges struct {
- // PrivilegeName: The name of the privilege.
- PrivilegeName string `json:"privilegeName,omitempty"`
-
- // ServiceId: The obfuscated ID of the service this privilege is for.
- ServiceId string `json:"serviceId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "PrivilegeName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RoleRolePrivileges) MarshalJSON() ([]byte, error) {
- type noMethod RoleRolePrivileges
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// RoleAssignment: JSON template for roleAssignment resource in
-// Directory API.
-type RoleAssignment struct {
- // AssignedTo: The unique ID of the user this role is assigned to.
- AssignedTo string `json:"assignedTo,omitempty"`
-
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Kind: The type of the API resource. This is always
- // admin#directory#roleAssignment.
- Kind string `json:"kind,omitempty"`
-
- // OrgUnitId: If the role is restricted to an organization unit, this
- // contains the ID for the organization unit the exercise of this role
- // is restricted to.
- OrgUnitId string `json:"orgUnitId,omitempty"`
-
- // RoleAssignmentId: ID of this roleAssignment.
- RoleAssignmentId int64 `json:"roleAssignmentId,omitempty,string"`
-
- // RoleId: The ID of the role that is assigned.
- RoleId int64 `json:"roleId,omitempty,string"`
-
- // ScopeType: The scope in which this role is assigned. Possible values
- // are:
- // - CUSTOMER
- // - ORG_UNIT
- ScopeType string `json:"scopeType,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AssignedTo") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RoleAssignment) MarshalJSON() ([]byte, error) {
- type noMethod RoleAssignment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// RoleAssignments: JSON response template for List roleAssignments
-// operation in Directory API.
-type RoleAssignments struct {
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Items: A list of RoleAssignment resources.
- Items []*RoleAssignment `json:"items,omitempty"`
-
- // Kind: The type of the API resource. This is always
- // admin#directory#roleAssignments.
- Kind string `json:"kind,omitempty"`
-
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RoleAssignments) MarshalJSON() ([]byte, error) {
- type noMethod RoleAssignments
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Roles: JSON response template for List roles operation in Directory
-// API.
-type Roles struct {
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Items: A list of Role resources.
- Items []*Role `json:"items,omitempty"`
-
- // Kind: The type of the API resource. This is always
- // admin#directory#roles.
- Kind string `json:"kind,omitempty"`
-
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Roles) MarshalJSON() ([]byte, error) {
- type noMethod Roles
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Schema: JSON template for Schema resource in Directory API.
-type Schema struct {
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Fields: Fields of Schema
- Fields []*SchemaFieldSpec `json:"fields,omitempty"`
-
- // Kind: Kind of resource this is.
- Kind string `json:"kind,omitempty"`
-
- // SchemaId: Unique identifier of Schema (Read-only)
- SchemaId string `json:"schemaId,omitempty"`
-
- // SchemaName: Schema name
- SchemaName string `json:"schemaName,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Schema) MarshalJSON() ([]byte, error) {
- type noMethod Schema
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SchemaFieldSpec: JSON template for FieldSpec resource for Schemas in
-// Directory API.
-type SchemaFieldSpec struct {
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // FieldId: Unique identifier of Field (Read-only)
- FieldId string `json:"fieldId,omitempty"`
-
- // FieldName: Name of the field.
- FieldName string `json:"fieldName,omitempty"`
-
- // FieldType: Type of the field.
- FieldType string `json:"fieldType,omitempty"`
-
- // Indexed: Boolean specifying whether the field is indexed or not.
- //
- // Default: true
- Indexed *bool `json:"indexed,omitempty"`
-
- // Kind: Kind of resource this is.
- Kind string `json:"kind,omitempty"`
-
- // MultiValued: Boolean specifying whether this is a multi-valued field
- // or not.
- MultiValued bool `json:"multiValued,omitempty"`
-
- // NumericIndexingSpec: Indexing spec for a numeric field. By default,
- // only exact match queries will be supported for numeric fields.
- // Setting the numericIndexingSpec allows range queries to be supported.
- NumericIndexingSpec *SchemaFieldSpecNumericIndexingSpec `json:"numericIndexingSpec,omitempty"`
-
- // ReadAccessType: Read ACLs on the field specifying who can view values
- // of this field. Valid values are "ALL_DOMAIN_USERS" and
- // "ADMINS_AND_SELF".
- ReadAccessType string `json:"readAccessType,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SchemaFieldSpec) MarshalJSON() ([]byte, error) {
- type noMethod SchemaFieldSpec
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SchemaFieldSpecNumericIndexingSpec: Indexing spec for a numeric
-// field. By default, only exact match queries will be supported for
-// numeric fields. Setting the numericIndexingSpec allows range queries
-// to be supported.
-type SchemaFieldSpecNumericIndexingSpec struct {
- // MaxValue: Maximum value of this field. This is meant to be indicative
- // rather than enforced. Values outside this range will still be
- // indexed, but search may not be as performant.
- MaxValue float64 `json:"maxValue,omitempty"`
-
- // MinValue: Minimum value of this field. This is meant to be indicative
- // rather than enforced. Values outside this range will still be
- // indexed, but search may not be as performant.
- MinValue float64 `json:"minValue,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "MaxValue") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SchemaFieldSpecNumericIndexingSpec) MarshalJSON() ([]byte, error) {
- type noMethod SchemaFieldSpecNumericIndexingSpec
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Schemas: JSON response template for List Schema operation in
-// Directory API.
-type Schemas struct {
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Kind: Kind of resource this is.
- Kind string `json:"kind,omitempty"`
-
- // Schemas: List of UserSchema objects.
- Schemas []*Schema `json:"schemas,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Schemas) MarshalJSON() ([]byte, error) {
- type noMethod Schemas
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Token: JSON template for token resource in Directory API.
-type Token struct {
- // Anonymous: Whether the application is registered with Google. The
- // value is true if the application has an anonymous Client ID.
- Anonymous bool `json:"anonymous,omitempty"`
-
- // ClientId: The Client ID of the application the token is issued to.
- ClientId string `json:"clientId,omitempty"`
-
- // DisplayText: The displayable name of the application the token is
- // issued to.
- DisplayText string `json:"displayText,omitempty"`
-
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Kind: The type of the API resource. This is always
- // admin#directory#token.
- Kind string `json:"kind,omitempty"`
-
- // NativeApp: Whether the token is issued to an installed application.
- // The value is true if the application is installed to a desktop or
- // mobile device.
- NativeApp bool `json:"nativeApp,omitempty"`
-
- // Scopes: A list of authorization scopes the application is granted.
- Scopes []string `json:"scopes,omitempty"`
-
- // UserKey: The unique ID of the user that issued the token.
- UserKey string `json:"userKey,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Anonymous") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Token) MarshalJSON() ([]byte, error) {
- type noMethod Token
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Tokens: JSON response template for List tokens operation in Directory
-// API.
-type Tokens struct {
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Items: A list of Token resources.
- Items []*Token `json:"items,omitempty"`
-
- // Kind: The type of the API resource. This is always
- // admin#directory#tokenList.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Tokens) MarshalJSON() ([]byte, error) {
- type noMethod Tokens
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// User: JSON template for User object in Directory API.
-type User struct {
- Addresses interface{} `json:"addresses,omitempty"`
-
- // AgreedToTerms: Indicates if user has agreed to terms (Read-only)
- AgreedToTerms bool `json:"agreedToTerms,omitempty"`
-
- // Aliases: List of aliases (Read-only)
- Aliases []string `json:"aliases,omitempty"`
-
- // ChangePasswordAtNextLogin: Boolean indicating if the user should
- // change password in next login
- ChangePasswordAtNextLogin bool `json:"changePasswordAtNextLogin,omitempty"`
-
- // CreationTime: User's Google account creation time. (Read-only)
- CreationTime string `json:"creationTime,omitempty"`
-
- // CustomSchemas: Custom fields of the user.
- CustomSchemas map[string]UserCustomProperties `json:"customSchemas,omitempty"`
-
- // CustomerId: CustomerId of User (Read-only)
- CustomerId string `json:"customerId,omitempty"`
-
- DeletionTime string `json:"deletionTime,omitempty"`
-
- Emails interface{} `json:"emails,omitempty"`
-
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- ExternalIds interface{} `json:"externalIds,omitempty"`
-
- // HashFunction: Hash function name for password. Supported are MD5,
- // SHA-1 and crypt
- HashFunction string `json:"hashFunction,omitempty"`
-
- // Id: Unique identifier of User (Read-only)
- Id string `json:"id,omitempty"`
-
- Ims interface{} `json:"ims,omitempty"`
-
- // IncludeInGlobalAddressList: Boolean indicating if user is included in
- // Global Address List
- IncludeInGlobalAddressList bool `json:"includeInGlobalAddressList,omitempty"`
-
- // IpWhitelisted: Boolean indicating if ip is whitelisted
- IpWhitelisted bool `json:"ipWhitelisted,omitempty"`
-
- // IsAdmin: Boolean indicating if the user is admin (Read-only)
- IsAdmin bool `json:"isAdmin,omitempty"`
-
- // IsDelegatedAdmin: Boolean indicating if the user is delegated admin
- // (Read-only)
- IsDelegatedAdmin bool `json:"isDelegatedAdmin,omitempty"`
-
- // IsMailboxSetup: Is mailbox setup (Read-only)
- IsMailboxSetup bool `json:"isMailboxSetup,omitempty"`
-
- // Kind: Kind of resource this is.
- Kind string `json:"kind,omitempty"`
-
- // LastLoginTime: User's last login time. (Read-only)
- LastLoginTime string `json:"lastLoginTime,omitempty"`
-
- // Name: User's name
- Name *UserName `json:"name,omitempty"`
-
- // NonEditableAliases: List of non editable aliases (Read-only)
- NonEditableAliases []string `json:"nonEditableAliases,omitempty"`
-
- Notes interface{} `json:"notes,omitempty"`
-
- // OrgUnitPath: OrgUnit of User
- OrgUnitPath string `json:"orgUnitPath,omitempty"`
-
- Organizations interface{} `json:"organizations,omitempty"`
-
- // Password: User's password
- Password string `json:"password,omitempty"`
-
- Phones interface{} `json:"phones,omitempty"`
-
- // PrimaryEmail: username of User
- PrimaryEmail string `json:"primaryEmail,omitempty"`
-
- Relations interface{} `json:"relations,omitempty"`
-
- // Suspended: Indicates if user is suspended
- Suspended bool `json:"suspended,omitempty"`
-
- // SuspensionReason: Suspension reason if user is suspended (Read-only)
- SuspensionReason string `json:"suspensionReason,omitempty"`
-
- // ThumbnailPhotoEtag: ETag of the user's photo (Read-only)
- ThumbnailPhotoEtag string `json:"thumbnailPhotoEtag,omitempty"`
-
- // ThumbnailPhotoUrl: Photo Url of the user (Read-only)
- ThumbnailPhotoUrl string `json:"thumbnailPhotoUrl,omitempty"`
-
- Websites interface{} `json:"websites,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Addresses") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *User) MarshalJSON() ([]byte, error) {
- type noMethod User
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserAbout: JSON template for About (notes) of a user in Directory
-// API.
-type UserAbout struct {
- // ContentType: About entry can have a type which indicates the content
- // type. It can either be plain or html. By default, notes contents are
- // assumed to contain plain text.
- ContentType string `json:"contentType,omitempty"`
-
- // Value: Actual value of notes.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ContentType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserAbout) MarshalJSON() ([]byte, error) {
- type noMethod UserAbout
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserAddress: JSON template for address.
-type UserAddress struct {
- // Country: Country.
- Country string `json:"country,omitempty"`
-
- // CountryCode: Country code.
- CountryCode string `json:"countryCode,omitempty"`
-
- // CustomType: Custom type.
- CustomType string `json:"customType,omitempty"`
-
- // ExtendedAddress: Extended Address.
- ExtendedAddress string `json:"extendedAddress,omitempty"`
-
- // Formatted: Formatted address.
- Formatted string `json:"formatted,omitempty"`
-
- // Locality: Locality.
- Locality string `json:"locality,omitempty"`
-
- // PoBox: Other parts of address.
- PoBox string `json:"poBox,omitempty"`
-
- // PostalCode: Postal code.
- PostalCode string `json:"postalCode,omitempty"`
-
- // Primary: If this is user's primary address. Only one entry could be
- // marked as primary.
- Primary bool `json:"primary,omitempty"`
-
- // Region: Region.
- Region string `json:"region,omitempty"`
-
- // SourceIsStructured: User supplied address was structured. Structured
- // addresses are NOT supported at this time. You might be able to write
- // structured addresses, but any values will eventually be clobbered.
- SourceIsStructured bool `json:"sourceIsStructured,omitempty"`
-
- // StreetAddress: Street.
- StreetAddress string `json:"streetAddress,omitempty"`
-
- // Type: Each entry can have a type which indicates standard values of
- // that entry. For example address could be of home, work etc. In
- // addition to the standard type, an entry can have a custom type and
- // can take any value. Such type should have the CUSTOM value as type
- // and also have a customType value.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Country") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserAddress) MarshalJSON() ([]byte, error) {
- type noMethod UserAddress
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UserCustomProperties interface{}
-
-// UserEmail: JSON template for an email.
-type UserEmail struct {
- // Address: Email id of the user.
- Address string `json:"address,omitempty"`
-
- // CustomType: Custom Type.
- CustomType string `json:"customType,omitempty"`
-
- // Primary: If this is user's primary email. Only one entry could be
- // marked as primary.
- Primary bool `json:"primary,omitempty"`
-
- // Type: Each entry can have a type which indicates standard types of
- // that entry. For example email could be of home, work etc. In addition
- // to the standard type, an entry can have a custom type and can take
- // any value Such types should have the CUSTOM value as type and also
- // have a customType value.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Address") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserEmail) MarshalJSON() ([]byte, error) {
- type noMethod UserEmail
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserExternalId: JSON template for an externalId entry.
-type UserExternalId struct {
- // CustomType: Custom type.
- CustomType string `json:"customType,omitempty"`
-
- // Type: The type of the Id.
- Type string `json:"type,omitempty"`
-
- // Value: The value of the id.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CustomType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserExternalId) MarshalJSON() ([]byte, error) {
- type noMethod UserExternalId
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserIm: JSON template for instant messenger of an user.
-type UserIm struct {
- // CustomProtocol: Custom protocol.
- CustomProtocol string `json:"customProtocol,omitempty"`
-
- // CustomType: Custom type.
- CustomType string `json:"customType,omitempty"`
-
- // Im: Instant messenger id.
- Im string `json:"im,omitempty"`
-
- // Primary: If this is user's primary im. Only one entry could be marked
- // as primary.
- Primary bool `json:"primary,omitempty"`
-
- // Protocol: Protocol used in the instant messenger. It should be one of
- // the values from ImProtocolTypes map. Similar to type, it can take a
- // CUSTOM value and specify the custom name in customProtocol field.
- Protocol string `json:"protocol,omitempty"`
-
- // Type: Each entry can have a type which indicates standard types of
- // that entry. For example instant messengers could be of home, work
- // etc. In addition to the standard type, an entry can have a custom
- // type and can take any value. Such types should have the CUSTOM value
- // as type and also have a customType value.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CustomProtocol") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserIm) MarshalJSON() ([]byte, error) {
- type noMethod UserIm
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserMakeAdmin: JSON request template for setting/revoking admin
-// status of a user in Directory API.
-type UserMakeAdmin struct {
- // Status: Boolean indicating new admin status of the user
- Status bool `json:"status,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Status") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserMakeAdmin) MarshalJSON() ([]byte, error) {
- type noMethod UserMakeAdmin
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserName: JSON template for name of a user in Directory API.
-type UserName struct {
- // FamilyName: Last Name
- FamilyName string `json:"familyName,omitempty"`
-
- // FullName: Full Name
- FullName string `json:"fullName,omitempty"`
-
- // GivenName: First Name
- GivenName string `json:"givenName,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "FamilyName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserName) MarshalJSON() ([]byte, error) {
- type noMethod UserName
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserOrganization: JSON template for an organization entry.
-type UserOrganization struct {
- // CostCenter: The cost center of the users department.
- CostCenter string `json:"costCenter,omitempty"`
-
- // CustomType: Custom type.
- CustomType string `json:"customType,omitempty"`
-
- // Department: Department within the organization.
- Department string `json:"department,omitempty"`
-
- // Description: Description of the organization.
- Description string `json:"description,omitempty"`
-
- // Domain: The domain to which the organization belongs to.
- Domain string `json:"domain,omitempty"`
-
- // Location: Location of the organization. This need not be fully
- // qualified address.
- Location string `json:"location,omitempty"`
-
- // Name: Name of the organization
- Name string `json:"name,omitempty"`
-
- // Primary: If it user's primary organization.
- Primary bool `json:"primary,omitempty"`
-
- // Symbol: Symbol of the organization.
- Symbol string `json:"symbol,omitempty"`
-
- // Title: Title (designation) of the user in the organization.
- Title string `json:"title,omitempty"`
-
- // Type: Each entry can have a type which indicates standard types of
- // that entry. For example organization could be of school, work etc. In
- // addition to the standard type, an entry can have a custom type and
- // can give it any name. Such types should have the CUSTOM value as type
- // and also have a CustomType value.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CostCenter") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserOrganization) MarshalJSON() ([]byte, error) {
- type noMethod UserOrganization
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserPhone: JSON template for a phone entry.
-type UserPhone struct {
- // CustomType: Custom Type.
- CustomType string `json:"customType,omitempty"`
-
- // Primary: If this is user's primary phone or not.
- Primary bool `json:"primary,omitempty"`
-
- // Type: Each entry can have a type which indicates standard types of
- // that entry. For example phone could be of home_fax, work, mobile etc.
- // In addition to the standard type, an entry can have a custom type and
- // can give it any name. Such types should have the CUSTOM value as type
- // and also have a customType value.
- Type string `json:"type,omitempty"`
-
- // Value: Phone number.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CustomType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserPhone) MarshalJSON() ([]byte, error) {
- type noMethod UserPhone
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserPhoto: JSON template for Photo object in Directory API.
-type UserPhoto struct {
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Height: Height in pixels of the photo
- Height int64 `json:"height,omitempty"`
-
- // Id: Unique identifier of User (Read-only)
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is.
- Kind string `json:"kind,omitempty"`
-
- // MimeType: Mime Type of the photo
- MimeType string `json:"mimeType,omitempty"`
-
- // PhotoData: Base64 encoded photo data
- PhotoData string `json:"photoData,omitempty"`
-
- // PrimaryEmail: Primary email of User (Read-only)
- PrimaryEmail string `json:"primaryEmail,omitempty"`
-
- // Width: Width in pixels of the photo
- Width int64 `json:"width,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserPhoto) MarshalJSON() ([]byte, error) {
- type noMethod UserPhoto
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserRelation: JSON template for a relation entry.
-type UserRelation struct {
- // CustomType: Custom Type.
- CustomType string `json:"customType,omitempty"`
-
- // Type: The relation of the user. Some of the possible values are
- // mother, father, sister, brother, manager, assistant, partner.
- Type string `json:"type,omitempty"`
-
- // Value: The name of the relation.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CustomType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserRelation) MarshalJSON() ([]byte, error) {
- type noMethod UserRelation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserUndelete: JSON request template to undelete a user in Directory
-// API.
-type UserUndelete struct {
- // OrgUnitPath: OrgUnit of User
- OrgUnitPath string `json:"orgUnitPath,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "OrgUnitPath") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserUndelete) MarshalJSON() ([]byte, error) {
- type noMethod UserUndelete
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserWebsite: JSON template for a website entry.
-type UserWebsite struct {
- // CustomType: Custom Type.
- CustomType string `json:"customType,omitempty"`
-
- // Primary: If this is user's primary website or not.
- Primary bool `json:"primary,omitempty"`
-
- // Type: Each entry can have a type which indicates standard types of
- // that entry. For example website could be of home, work, blog etc. In
- // addition to the standard type, an entry can have a custom type and
- // can give it any name. Such types should have the CUSTOM value as type
- // and also have a customType value.
- Type string `json:"type,omitempty"`
-
- // Value: Website.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CustomType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserWebsite) MarshalJSON() ([]byte, error) {
- type noMethod UserWebsite
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Users: JSON response template for List Users operation in Apps
-// Directory API.
-type Users struct {
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Kind: Kind of resource this is.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Token used to access next page of this result.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // TriggerEvent: Event that triggered this response (only used in case
- // of Push Response)
- TriggerEvent string `json:"trigger_event,omitempty"`
-
- // Users: List of user objects.
- Users []*User `json:"users,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Users) MarshalJSON() ([]byte, error) {
- type noMethod Users
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// VerificationCode: JSON template for verification codes in Directory
-// API.
-type VerificationCode struct {
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Kind: The type of the resource. This is always
- // admin#directory#verificationCode.
- Kind string `json:"kind,omitempty"`
-
- // UserId: The obfuscated unique ID of the user.
- UserId string `json:"userId,omitempty"`
-
- // VerificationCode: A current verification code for the user.
- // Invalidated or used verification codes are not returned as part of
- // the result.
- VerificationCode string `json:"verificationCode,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VerificationCode) MarshalJSON() ([]byte, error) {
- type noMethod VerificationCode
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// VerificationCodes: JSON response template for List verification codes
-// operation in Directory API.
-type VerificationCodes struct {
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Items: A list of verification code resources.
- Items []*VerificationCode `json:"items,omitempty"`
-
- // Kind: The type of the resource. This is always
- // admin#directory#verificationCodesList.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VerificationCodes) MarshalJSON() ([]byte, error) {
- type noMethod VerificationCodes
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "directory.asps.delete":
-
-type AspsDeleteCall struct {
- s *Service
- userKey string
- codeId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Delete an ASP issued by a user.
-func (r *AspsService) Delete(userKey string, codeId int64) *AspsDeleteCall {
- c := &AspsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.userKey = userKey
- c.codeId = codeId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AspsDeleteCall) Fields(s ...googleapi.Field) *AspsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AspsDeleteCall) Context(ctx context.Context) *AspsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AspsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userKey}/asps/{codeId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userKey": c.userKey,
- "codeId": strconv.FormatInt(c.codeId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.asps.delete" call.
-func (c *AspsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Delete an ASP issued by a user.",
- // "httpMethod": "DELETE",
- // "id": "directory.asps.delete",
- // "parameterOrder": [
- // "userKey",
- // "codeId"
- // ],
- // "parameters": {
- // "codeId": {
- // "description": "The unique ID of the ASP to be deleted.",
- // "format": "int32",
- // "location": "path",
- // "required": true,
- // "type": "integer"
- // },
- // "userKey": {
- // "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userKey}/asps/{codeId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.user.security"
- // ]
- // }
-
-}
-
-// method id "directory.asps.get":
-
-type AspsGetCall struct {
- s *Service
- userKey string
- codeId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get information about an ASP issued by a user.
-func (r *AspsService) Get(userKey string, codeId int64) *AspsGetCall {
- c := &AspsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.userKey = userKey
- c.codeId = codeId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AspsGetCall) Fields(s ...googleapi.Field) *AspsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AspsGetCall) IfNoneMatch(entityTag string) *AspsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AspsGetCall) Context(ctx context.Context) *AspsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AspsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userKey}/asps/{codeId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userKey": c.userKey,
- "codeId": strconv.FormatInt(c.codeId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.asps.get" call.
-// Exactly one of *Asp or error will be non-nil. Any non-2xx status code
-// is an error. Response headers are in either
-// *Asp.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *AspsGetCall) Do() (*Asp, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Asp{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get information about an ASP issued by a user.",
- // "httpMethod": "GET",
- // "id": "directory.asps.get",
- // "parameterOrder": [
- // "userKey",
- // "codeId"
- // ],
- // "parameters": {
- // "codeId": {
- // "description": "The unique ID of the ASP.",
- // "format": "int32",
- // "location": "path",
- // "required": true,
- // "type": "integer"
- // },
- // "userKey": {
- // "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userKey}/asps/{codeId}",
- // "response": {
- // "$ref": "Asp"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.user.security"
- // ]
- // }
-
-}
-
-// method id "directory.asps.list":
-
-type AspsListCall struct {
- s *Service
- userKey string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List the ASPs issued by a user.
-func (r *AspsService) List(userKey string) *AspsListCall {
- c := &AspsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.userKey = userKey
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AspsListCall) Fields(s ...googleapi.Field) *AspsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AspsListCall) IfNoneMatch(entityTag string) *AspsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AspsListCall) Context(ctx context.Context) *AspsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AspsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userKey}/asps")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userKey": c.userKey,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.asps.list" call.
-// Exactly one of *Asps or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Asps.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *AspsListCall) Do() (*Asps, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Asps{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List the ASPs issued by a user.",
- // "httpMethod": "GET",
- // "id": "directory.asps.list",
- // "parameterOrder": [
- // "userKey"
- // ],
- // "parameters": {
- // "userKey": {
- // "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userKey}/asps",
- // "response": {
- // "$ref": "Asps"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.user.security"
- // ]
- // }
-
-}
-
-// method id "admin.channels.stop":
-
-type ChannelsStopCall struct {
- s *Service
- channel *Channel
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Stop: Stop watching resources through this channel
-func (r *ChannelsService) Stop(channel *Channel) *ChannelsStopCall {
- c := &ChannelsStopCall{s: r.s, opt_: make(map[string]interface{})}
- c.channel = channel
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ChannelsStopCall) Fields(s ...googleapi.Field) *ChannelsStopCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ChannelsStopCall) Context(ctx context.Context) *ChannelsStopCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ChannelsStopCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.channel)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "/admin/directory_v1/channels/stop")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "admin.channels.stop" call.
-func (c *ChannelsStopCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Stop watching resources through this channel",
- // "httpMethod": "POST",
- // "id": "admin.channels.stop",
- // "path": "/admin/directory_v1/channels/stop",
- // "request": {
- // "$ref": "Channel",
- // "parameterName": "resource"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.user",
- // "https://www.googleapis.com/auth/admin.directory.user.alias",
- // "https://www.googleapis.com/auth/admin.directory.user.alias.readonly",
- // "https://www.googleapis.com/auth/admin.directory.user.readonly"
- // ]
- // }
-
-}
-
-// method id "directory.chromeosdevices.get":
-
-type ChromeosdevicesGetCall struct {
- s *Service
- customerId string
- deviceId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieve Chrome OS Device
-func (r *ChromeosdevicesService) Get(customerId string, deviceId string) *ChromeosdevicesGetCall {
- c := &ChromeosdevicesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.customerId = customerId
- c.deviceId = deviceId
- return c
-}
-
-// Projection sets the optional parameter "projection": Restrict
-// information returned to a set of selected fields.
-//
-// Possible values:
-// "BASIC" - Includes only the basic metadata fields (e.g., deviceId,
-// serialNumber, status, and user)
-// "FULL" - Includes all metadata fields
-func (c *ChromeosdevicesGetCall) Projection(projection string) *ChromeosdevicesGetCall {
- c.opt_["projection"] = projection
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ChromeosdevicesGetCall) Fields(s ...googleapi.Field) *ChromeosdevicesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ChromeosdevicesGetCall) IfNoneMatch(entityTag string) *ChromeosdevicesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ChromeosdevicesGetCall) Context(ctx context.Context) *ChromeosdevicesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ChromeosdevicesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["projection"]; ok {
- params.Set("projection", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customerId}/devices/chromeos/{deviceId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customerId": c.customerId,
- "deviceId": c.deviceId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.chromeosdevices.get" call.
-// Exactly one of *ChromeOsDevice or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ChromeOsDevice.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ChromeosdevicesGetCall) Do() (*ChromeOsDevice, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ChromeOsDevice{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieve Chrome OS Device",
- // "httpMethod": "GET",
- // "id": "directory.chromeosdevices.get",
- // "parameterOrder": [
- // "customerId",
- // "deviceId"
- // ],
- // "parameters": {
- // "customerId": {
- // "description": "Immutable id of the Google Apps account",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "deviceId": {
- // "description": "Immutable id of Chrome OS Device",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projection": {
- // "description": "Restrict information returned to a set of selected fields.",
- // "enum": [
- // "BASIC",
- // "FULL"
- // ],
- // "enumDescriptions": [
- // "Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)",
- // "Includes all metadata fields"
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "customer/{customerId}/devices/chromeos/{deviceId}",
- // "response": {
- // "$ref": "ChromeOsDevice"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.device.chromeos",
- // "https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly"
- // ]
- // }
-
-}
-
-// method id "directory.chromeosdevices.list":
-
-type ChromeosdevicesListCall struct {
- s *Service
- customerId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieve all Chrome OS Devices of a customer (paginated)
-func (r *ChromeosdevicesService) List(customerId string) *ChromeosdevicesListCall {
- c := &ChromeosdevicesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.customerId = customerId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return. Default is 100
-func (c *ChromeosdevicesListCall) MaxResults(maxResults int64) *ChromeosdevicesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Column to use for
-// sorting results
-//
-// Possible values:
-// "annotatedLocation" - Chromebook location as annotated by the
-// administrator.
-// "annotatedUser" - Chromebook user as annotated by administrator.
-// "lastSync" - Chromebook last sync.
-// "notes" - Chromebook notes as annotated by the administrator.
-// "serialNumber" - Chromebook Serial Number.
-// "status" - Chromebook status.
-// "supportEndDate" - Chromebook support end date.
-func (c *ChromeosdevicesListCall) OrderBy(orderBy string) *ChromeosdevicesListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Token to specify
-// next page in the list
-func (c *ChromeosdevicesListCall) PageToken(pageToken string) *ChromeosdevicesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Projection sets the optional parameter "projection": Restrict
-// information returned to a set of selected fields.
-//
-// Possible values:
-// "BASIC" - Includes only the basic metadata fields (e.g., deviceId,
-// serialNumber, status, and user)
-// "FULL" - Includes all metadata fields
-func (c *ChromeosdevicesListCall) Projection(projection string) *ChromeosdevicesListCall {
- c.opt_["projection"] = projection
- return c
-}
-
-// Query sets the optional parameter "query": Search string in the
-// format given at
-// http://support.google.com/chromeos/a/bin/answer.py?hl=en&answer=1698333
-func (c *ChromeosdevicesListCall) Query(query string) *ChromeosdevicesListCall {
- c.opt_["query"] = query
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Whether to return
-// results in ascending or descending order. Only of use when orderBy is
-// also used
-//
-// Possible values:
-// "ASCENDING" - Ascending order.
-// "DESCENDING" - Descending order.
-func (c *ChromeosdevicesListCall) SortOrder(sortOrder string) *ChromeosdevicesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ChromeosdevicesListCall) Fields(s ...googleapi.Field) *ChromeosdevicesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ChromeosdevicesListCall) IfNoneMatch(entityTag string) *ChromeosdevicesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ChromeosdevicesListCall) Context(ctx context.Context) *ChromeosdevicesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ChromeosdevicesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["projection"]; ok {
- params.Set("projection", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["query"]; ok {
- params.Set("query", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customerId}/devices/chromeos")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customerId": c.customerId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.chromeosdevices.list" call.
-// Exactly one of *ChromeOsDevices or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ChromeOsDevices.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ChromeosdevicesListCall) Do() (*ChromeOsDevices, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ChromeOsDevices{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieve all Chrome OS Devices of a customer (paginated)",
- // "httpMethod": "GET",
- // "id": "directory.chromeosdevices.list",
- // "parameterOrder": [
- // "customerId"
- // ],
- // "parameters": {
- // "customerId": {
- // "description": "Immutable id of the Google Apps account",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return. Default is 100",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Column to use for sorting results",
- // "enum": [
- // "annotatedLocation",
- // "annotatedUser",
- // "lastSync",
- // "notes",
- // "serialNumber",
- // "status",
- // "supportEndDate"
- // ],
- // "enumDescriptions": [
- // "Chromebook location as annotated by the administrator.",
- // "Chromebook user as annotated by administrator.",
- // "Chromebook last sync.",
- // "Chromebook notes as annotated by the administrator.",
- // "Chromebook Serial Number.",
- // "Chromebook status.",
- // "Chromebook support end date."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Token to specify next page in the list",
- // "location": "query",
- // "type": "string"
- // },
- // "projection": {
- // "description": "Restrict information returned to a set of selected fields.",
- // "enum": [
- // "BASIC",
- // "FULL"
- // ],
- // "enumDescriptions": [
- // "Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)",
- // "Includes all metadata fields"
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "query": {
- // "description": "Search string in the format given at http://support.google.com/chromeos/a/bin/answer.py?hl=en\u0026answer=1698333",
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Whether to return results in ascending or descending order. Only of use when orderBy is also used",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "Ascending order.",
- // "Descending order."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "customer/{customerId}/devices/chromeos",
- // "response": {
- // "$ref": "ChromeOsDevices"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.device.chromeos",
- // "https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly"
- // ]
- // }
-
-}
-
-// method id "directory.chromeosdevices.patch":
-
-type ChromeosdevicesPatchCall struct {
- s *Service
- customerId string
- deviceId string
- chromeosdevice *ChromeOsDevice
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Update Chrome OS Device. This method supports patch semantics.
-func (r *ChromeosdevicesService) Patch(customerId string, deviceId string, chromeosdevice *ChromeOsDevice) *ChromeosdevicesPatchCall {
- c := &ChromeosdevicesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.customerId = customerId
- c.deviceId = deviceId
- c.chromeosdevice = chromeosdevice
- return c
-}
-
-// Projection sets the optional parameter "projection": Restrict
-// information returned to a set of selected fields.
-//
-// Possible values:
-// "BASIC" - Includes only the basic metadata fields (e.g., deviceId,
-// serialNumber, status, and user)
-// "FULL" - Includes all metadata fields
-func (c *ChromeosdevicesPatchCall) Projection(projection string) *ChromeosdevicesPatchCall {
- c.opt_["projection"] = projection
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ChromeosdevicesPatchCall) Fields(s ...googleapi.Field) *ChromeosdevicesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ChromeosdevicesPatchCall) Context(ctx context.Context) *ChromeosdevicesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ChromeosdevicesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.chromeosdevice)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["projection"]; ok {
- params.Set("projection", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customerId}/devices/chromeos/{deviceId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customerId": c.customerId,
- "deviceId": c.deviceId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.chromeosdevices.patch" call.
-// Exactly one of *ChromeOsDevice or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ChromeOsDevice.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ChromeosdevicesPatchCall) Do() (*ChromeOsDevice, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ChromeOsDevice{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update Chrome OS Device. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "directory.chromeosdevices.patch",
- // "parameterOrder": [
- // "customerId",
- // "deviceId"
- // ],
- // "parameters": {
- // "customerId": {
- // "description": "Immutable id of the Google Apps account",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "deviceId": {
- // "description": "Immutable id of Chrome OS Device",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projection": {
- // "description": "Restrict information returned to a set of selected fields.",
- // "enum": [
- // "BASIC",
- // "FULL"
- // ],
- // "enumDescriptions": [
- // "Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)",
- // "Includes all metadata fields"
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "customer/{customerId}/devices/chromeos/{deviceId}",
- // "request": {
- // "$ref": "ChromeOsDevice"
- // },
- // "response": {
- // "$ref": "ChromeOsDevice"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.device.chromeos"
- // ]
- // }
-
-}
-
-// method id "directory.chromeosdevices.update":
-
-type ChromeosdevicesUpdateCall struct {
- s *Service
- customerId string
- deviceId string
- chromeosdevice *ChromeOsDevice
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Update Chrome OS Device
-func (r *ChromeosdevicesService) Update(customerId string, deviceId string, chromeosdevice *ChromeOsDevice) *ChromeosdevicesUpdateCall {
- c := &ChromeosdevicesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.customerId = customerId
- c.deviceId = deviceId
- c.chromeosdevice = chromeosdevice
- return c
-}
-
-// Projection sets the optional parameter "projection": Restrict
-// information returned to a set of selected fields.
-//
-// Possible values:
-// "BASIC" - Includes only the basic metadata fields (e.g., deviceId,
-// serialNumber, status, and user)
-// "FULL" - Includes all metadata fields
-func (c *ChromeosdevicesUpdateCall) Projection(projection string) *ChromeosdevicesUpdateCall {
- c.opt_["projection"] = projection
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ChromeosdevicesUpdateCall) Fields(s ...googleapi.Field) *ChromeosdevicesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ChromeosdevicesUpdateCall) Context(ctx context.Context) *ChromeosdevicesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ChromeosdevicesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.chromeosdevice)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["projection"]; ok {
- params.Set("projection", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customerId}/devices/chromeos/{deviceId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customerId": c.customerId,
- "deviceId": c.deviceId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.chromeosdevices.update" call.
-// Exactly one of *ChromeOsDevice or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ChromeOsDevice.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ChromeosdevicesUpdateCall) Do() (*ChromeOsDevice, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ChromeOsDevice{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update Chrome OS Device",
- // "httpMethod": "PUT",
- // "id": "directory.chromeosdevices.update",
- // "parameterOrder": [
- // "customerId",
- // "deviceId"
- // ],
- // "parameters": {
- // "customerId": {
- // "description": "Immutable id of the Google Apps account",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "deviceId": {
- // "description": "Immutable id of Chrome OS Device",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projection": {
- // "description": "Restrict information returned to a set of selected fields.",
- // "enum": [
- // "BASIC",
- // "FULL"
- // ],
- // "enumDescriptions": [
- // "Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)",
- // "Includes all metadata fields"
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "customer/{customerId}/devices/chromeos/{deviceId}",
- // "request": {
- // "$ref": "ChromeOsDevice"
- // },
- // "response": {
- // "$ref": "ChromeOsDevice"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.device.chromeos"
- // ]
- // }
-
-}
-
-// method id "directory.customers.get":
-
-type CustomersGetCall struct {
- s *Service
- customerKey string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrives a customer.
-func (r *CustomersService) Get(customerKey string) *CustomersGetCall {
- c := &CustomersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.customerKey = customerKey
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CustomersGetCall) Fields(s ...googleapi.Field) *CustomersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CustomersGetCall) IfNoneMatch(entityTag string) *CustomersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CustomersGetCall) Context(ctx context.Context) *CustomersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CustomersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customers/{customerKey}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customerKey": c.customerKey,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.customers.get" call.
-// Exactly one of *Customer or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Customer.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CustomersGetCall) Do() (*Customer, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Customer{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrives a customer.",
- // "httpMethod": "GET",
- // "id": "directory.customers.get",
- // "parameterOrder": [
- // "customerKey"
- // ],
- // "parameters": {
- // "customerKey": {
- // "description": "Id of the customer to be retrieved",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customers/{customerKey}",
- // "response": {
- // "$ref": "Customer"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.customer",
- // "https://www.googleapis.com/auth/admin.directory.customer.readonly"
- // ]
- // }
-
-}
-
-// method id "directory.customers.patch":
-
-type CustomersPatchCall struct {
- s *Service
- customerKey string
- customer *Customer
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates a customer. This method supports patch semantics.
-func (r *CustomersService) Patch(customerKey string, customer *Customer) *CustomersPatchCall {
- c := &CustomersPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.customerKey = customerKey
- c.customer = customer
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CustomersPatchCall) Fields(s ...googleapi.Field) *CustomersPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CustomersPatchCall) Context(ctx context.Context) *CustomersPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CustomersPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.customer)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customers/{customerKey}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customerKey": c.customerKey,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.customers.patch" call.
-// Exactly one of *Customer or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Customer.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CustomersPatchCall) Do() (*Customer, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Customer{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a customer. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "directory.customers.patch",
- // "parameterOrder": [
- // "customerKey"
- // ],
- // "parameters": {
- // "customerKey": {
- // "description": "Id of the customer to be updated",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customers/{customerKey}",
- // "request": {
- // "$ref": "Customer"
- // },
- // "response": {
- // "$ref": "Customer"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.customer"
- // ]
- // }
-
-}
-
-// method id "directory.customers.update":
-
-type CustomersUpdateCall struct {
- s *Service
- customerKey string
- customer *Customer
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates a customer.
-func (r *CustomersService) Update(customerKey string, customer *Customer) *CustomersUpdateCall {
- c := &CustomersUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.customerKey = customerKey
- c.customer = customer
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CustomersUpdateCall) Fields(s ...googleapi.Field) *CustomersUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CustomersUpdateCall) Context(ctx context.Context) *CustomersUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CustomersUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.customer)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customers/{customerKey}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customerKey": c.customerKey,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.customers.update" call.
-// Exactly one of *Customer or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Customer.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CustomersUpdateCall) Do() (*Customer, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Customer{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a customer.",
- // "httpMethod": "PUT",
- // "id": "directory.customers.update",
- // "parameterOrder": [
- // "customerKey"
- // ],
- // "parameters": {
- // "customerKey": {
- // "description": "Id of the customer to be updated",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customers/{customerKey}",
- // "request": {
- // "$ref": "Customer"
- // },
- // "response": {
- // "$ref": "Customer"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.customer"
- // ]
- // }
-
-}
-
-// method id "directory.domainAliases.delete":
-
-type DomainAliasesDeleteCall struct {
- s *Service
- customer string
- domainAliasName string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes a Domain Alias of the customer.
-func (r *DomainAliasesService) Delete(customer string, domainAliasName string) *DomainAliasesDeleteCall {
- c := &DomainAliasesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.customer = customer
- c.domainAliasName = domainAliasName
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DomainAliasesDeleteCall) Fields(s ...googleapi.Field) *DomainAliasesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DomainAliasesDeleteCall) Context(ctx context.Context) *DomainAliasesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DomainAliasesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customer}/domainaliases/{domainAliasName}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customer": c.customer,
- "domainAliasName": c.domainAliasName,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.domainAliases.delete" call.
-func (c *DomainAliasesDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes a Domain Alias of the customer.",
- // "httpMethod": "DELETE",
- // "id": "directory.domainAliases.delete",
- // "parameterOrder": [
- // "customer",
- // "domainAliasName"
- // ],
- // "parameters": {
- // "customer": {
- // "description": "Immutable id of the Google Apps account.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "domainAliasName": {
- // "description": "Name of domain alias to be retrieved.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customer}/domainaliases/{domainAliasName}",
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.domain"
- // ]
- // }
-
-}
-
-// method id "directory.domainAliases.get":
-
-type DomainAliasesGetCall struct {
- s *Service
- customer string
- domainAliasName string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves a domain alias of the customer.
-func (r *DomainAliasesService) Get(customer string, domainAliasName string) *DomainAliasesGetCall {
- c := &DomainAliasesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.customer = customer
- c.domainAliasName = domainAliasName
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DomainAliasesGetCall) Fields(s ...googleapi.Field) *DomainAliasesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DomainAliasesGetCall) IfNoneMatch(entityTag string) *DomainAliasesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DomainAliasesGetCall) Context(ctx context.Context) *DomainAliasesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DomainAliasesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customer}/domainaliases/{domainAliasName}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customer": c.customer,
- "domainAliasName": c.domainAliasName,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.domainAliases.get" call.
-// Exactly one of *DomainAlias or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *DomainAlias.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DomainAliasesGetCall) Do() (*DomainAlias, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DomainAlias{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a domain alias of the customer.",
- // "httpMethod": "GET",
- // "id": "directory.domainAliases.get",
- // "parameterOrder": [
- // "customer",
- // "domainAliasName"
- // ],
- // "parameters": {
- // "customer": {
- // "description": "Immutable id of the Google Apps account.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "domainAliasName": {
- // "description": "Name of domain alias to be retrieved.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customer}/domainaliases/{domainAliasName}",
- // "response": {
- // "$ref": "DomainAlias"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.domain",
- // "https://www.googleapis.com/auth/admin.directory.domain.readonly"
- // ]
- // }
-
-}
-
-// method id "directory.domainAliases.insert":
-
-type DomainAliasesInsertCall struct {
- s *Service
- customer string
- domainalias *DomainAlias
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a Domain alias of the customer.
-func (r *DomainAliasesService) Insert(customer string, domainalias *DomainAlias) *DomainAliasesInsertCall {
- c := &DomainAliasesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.customer = customer
- c.domainalias = domainalias
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DomainAliasesInsertCall) Fields(s ...googleapi.Field) *DomainAliasesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DomainAliasesInsertCall) Context(ctx context.Context) *DomainAliasesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DomainAliasesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.domainalias)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customer}/domainaliases")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customer": c.customer,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.domainAliases.insert" call.
-// Exactly one of *DomainAlias or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *DomainAlias.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DomainAliasesInsertCall) Do() (*DomainAlias, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DomainAlias{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a Domain alias of the customer.",
- // "httpMethod": "POST",
- // "id": "directory.domainAliases.insert",
- // "parameterOrder": [
- // "customer"
- // ],
- // "parameters": {
- // "customer": {
- // "description": "Immutable id of the Google Apps account.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customer}/domainaliases",
- // "request": {
- // "$ref": "DomainAlias"
- // },
- // "response": {
- // "$ref": "DomainAlias"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.domain"
- // ]
- // }
-
-}
-
-// method id "directory.domainAliases.list":
-
-type DomainAliasesListCall struct {
- s *Service
- customer string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists the domain aliases of the customer.
-func (r *DomainAliasesService) List(customer string) *DomainAliasesListCall {
- c := &DomainAliasesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.customer = customer
- return c
-}
-
-// ParentDomainName sets the optional parameter "parentDomainName": Name
-// of the parent domain for which domain aliases are to be fetched.
-func (c *DomainAliasesListCall) ParentDomainName(parentDomainName string) *DomainAliasesListCall {
- c.opt_["parentDomainName"] = parentDomainName
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DomainAliasesListCall) Fields(s ...googleapi.Field) *DomainAliasesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DomainAliasesListCall) IfNoneMatch(entityTag string) *DomainAliasesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DomainAliasesListCall) Context(ctx context.Context) *DomainAliasesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DomainAliasesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["parentDomainName"]; ok {
- params.Set("parentDomainName", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customer}/domainaliases")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customer": c.customer,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.domainAliases.list" call.
-// Exactly one of *DomainAliases or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *DomainAliases.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DomainAliasesListCall) Do() (*DomainAliases, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DomainAliases{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists the domain aliases of the customer.",
- // "httpMethod": "GET",
- // "id": "directory.domainAliases.list",
- // "parameterOrder": [
- // "customer"
- // ],
- // "parameters": {
- // "customer": {
- // "description": "Immutable id of the Google Apps account.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "parentDomainName": {
- // "description": "Name of the parent domain for which domain aliases are to be fetched.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "customer/{customer}/domainaliases",
- // "response": {
- // "$ref": "DomainAliases"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.domain",
- // "https://www.googleapis.com/auth/admin.directory.domain.readonly"
- // ]
- // }
-
-}
-
-// method id "directory.domains.delete":
-
-type DomainsDeleteCall struct {
- s *Service
- customer string
- domainName string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes a domain of the customer.
-func (r *DomainsService) Delete(customer string, domainName string) *DomainsDeleteCall {
- c := &DomainsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.customer = customer
- c.domainName = domainName
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DomainsDeleteCall) Fields(s ...googleapi.Field) *DomainsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DomainsDeleteCall) Context(ctx context.Context) *DomainsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DomainsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customer}/domains/{domainName}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customer": c.customer,
- "domainName": c.domainName,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.domains.delete" call.
-func (c *DomainsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes a domain of the customer.",
- // "httpMethod": "DELETE",
- // "id": "directory.domains.delete",
- // "parameterOrder": [
- // "customer",
- // "domainName"
- // ],
- // "parameters": {
- // "customer": {
- // "description": "Immutable id of the Google Apps account.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "domainName": {
- // "description": "Name of domain to be deleted",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customer}/domains/{domainName}",
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.domain"
- // ]
- // }
-
-}
-
-// method id "directory.domains.get":
-
-type DomainsGetCall struct {
- s *Service
- customer string
- domainName string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrives a domain of the customer.
-func (r *DomainsService) Get(customer string, domainName string) *DomainsGetCall {
- c := &DomainsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.customer = customer
- c.domainName = domainName
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DomainsGetCall) Fields(s ...googleapi.Field) *DomainsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DomainsGetCall) IfNoneMatch(entityTag string) *DomainsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DomainsGetCall) Context(ctx context.Context) *DomainsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DomainsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customer}/domains/{domainName}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customer": c.customer,
- "domainName": c.domainName,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.domains.get" call.
-// Exactly one of *Domains or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Domains.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *DomainsGetCall) Do() (*Domains, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Domains{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrives a domain of the customer.",
- // "httpMethod": "GET",
- // "id": "directory.domains.get",
- // "parameterOrder": [
- // "customer",
- // "domainName"
- // ],
- // "parameters": {
- // "customer": {
- // "description": "Immutable id of the Google Apps account.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "domainName": {
- // "description": "Name of domain to be retrieved",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customer}/domains/{domainName}",
- // "response": {
- // "$ref": "Domains"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.domain",
- // "https://www.googleapis.com/auth/admin.directory.domain.readonly"
- // ]
- // }
-
-}
-
-// method id "directory.domains.insert":
-
-type DomainsInsertCall struct {
- s *Service
- customer string
- domains *Domains
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a domain of the customer.
-func (r *DomainsService) Insert(customer string, domains *Domains) *DomainsInsertCall {
- c := &DomainsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.customer = customer
- c.domains = domains
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DomainsInsertCall) Fields(s ...googleapi.Field) *DomainsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DomainsInsertCall) Context(ctx context.Context) *DomainsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DomainsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.domains)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customer}/domains")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customer": c.customer,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.domains.insert" call.
-// Exactly one of *Domains or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Domains.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *DomainsInsertCall) Do() (*Domains, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Domains{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a domain of the customer.",
- // "httpMethod": "POST",
- // "id": "directory.domains.insert",
- // "parameterOrder": [
- // "customer"
- // ],
- // "parameters": {
- // "customer": {
- // "description": "Immutable id of the Google Apps account.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customer}/domains",
- // "request": {
- // "$ref": "Domains"
- // },
- // "response": {
- // "$ref": "Domains"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.domain"
- // ]
- // }
-
-}
-
-// method id "directory.domains.list":
-
-type DomainsListCall struct {
- s *Service
- customer string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists the domains of the customer.
-func (r *DomainsService) List(customer string) *DomainsListCall {
- c := &DomainsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.customer = customer
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DomainsListCall) Fields(s ...googleapi.Field) *DomainsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DomainsListCall) IfNoneMatch(entityTag string) *DomainsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DomainsListCall) Context(ctx context.Context) *DomainsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DomainsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customer}/domains")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customer": c.customer,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.domains.list" call.
-// Exactly one of *Domains2 or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Domains2.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DomainsListCall) Do() (*Domains2, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Domains2{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists the domains of the customer.",
- // "httpMethod": "GET",
- // "id": "directory.domains.list",
- // "parameterOrder": [
- // "customer"
- // ],
- // "parameters": {
- // "customer": {
- // "description": "Immutable id of the Google Apps account.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customer}/domains",
- // "response": {
- // "$ref": "Domains2"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.domain",
- // "https://www.googleapis.com/auth/admin.directory.domain.readonly"
- // ]
- // }
-
-}
-
-// method id "directory.groups.delete":
-
-type GroupsDeleteCall struct {
- s *Service
- groupKey string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Delete Group
-func (r *GroupsService) Delete(groupKey string) *GroupsDeleteCall {
- c := &GroupsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.groupKey = groupKey
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsDeleteCall) Fields(s ...googleapi.Field) *GroupsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsDeleteCall) Context(ctx context.Context) *GroupsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "groups/{groupKey}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "groupKey": c.groupKey,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.groups.delete" call.
-func (c *GroupsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Delete Group",
- // "httpMethod": "DELETE",
- // "id": "directory.groups.delete",
- // "parameterOrder": [
- // "groupKey"
- // ],
- // "parameters": {
- // "groupKey": {
- // "description": "Email or immutable Id of the group",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "groups/{groupKey}",
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.group"
- // ]
- // }
-
-}
-
-// method id "directory.groups.get":
-
-type GroupsGetCall struct {
- s *Service
- groupKey string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieve Group
-func (r *GroupsService) Get(groupKey string) *GroupsGetCall {
- c := &GroupsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.groupKey = groupKey
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsGetCall) Fields(s ...googleapi.Field) *GroupsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GroupsGetCall) IfNoneMatch(entityTag string) *GroupsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsGetCall) Context(ctx context.Context) *GroupsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "groups/{groupKey}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "groupKey": c.groupKey,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.groups.get" call.
-// Exactly one of *Group or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Group.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *GroupsGetCall) Do() (*Group, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Group{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieve Group",
- // "httpMethod": "GET",
- // "id": "directory.groups.get",
- // "parameterOrder": [
- // "groupKey"
- // ],
- // "parameters": {
- // "groupKey": {
- // "description": "Email or immutable Id of the group",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "groups/{groupKey}",
- // "response": {
- // "$ref": "Group"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.group",
- // "https://www.googleapis.com/auth/admin.directory.group.readonly"
- // ]
- // }
-
-}
-
-// method id "directory.groups.insert":
-
-type GroupsInsertCall struct {
- s *Service
- group *Group
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Create Group
-func (r *GroupsService) Insert(group *Group) *GroupsInsertCall {
- c := &GroupsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.group = group
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsInsertCall) Fields(s ...googleapi.Field) *GroupsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsInsertCall) Context(ctx context.Context) *GroupsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.group)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "groups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.groups.insert" call.
-// Exactly one of *Group or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Group.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *GroupsInsertCall) Do() (*Group, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Group{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Create Group",
- // "httpMethod": "POST",
- // "id": "directory.groups.insert",
- // "path": "groups",
- // "request": {
- // "$ref": "Group"
- // },
- // "response": {
- // "$ref": "Group"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.group"
- // ]
- // }
-
-}
-
-// method id "directory.groups.list":
-
-type GroupsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieve all groups in a domain (paginated)
-func (r *GroupsService) List() *GroupsListCall {
- c := &GroupsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Customer sets the optional parameter "customer": Immutable id of the
-// Google Apps account. In case of multi-domain, to fetch all groups for
-// a customer, fill this field instead of domain.
-func (c *GroupsListCall) Customer(customer string) *GroupsListCall {
- c.opt_["customer"] = customer
- return c
-}
-
-// Domain sets the optional parameter "domain": Name of the domain. Fill
-// this field to get groups from only this domain. To return all groups
-// in a multi-domain fill customer field instead.
-func (c *GroupsListCall) Domain(domain string) *GroupsListCall {
- c.opt_["domain"] = domain
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return. Default is 200
-func (c *GroupsListCall) MaxResults(maxResults int64) *GroupsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Token to specify
-// next page in the list
-func (c *GroupsListCall) PageToken(pageToken string) *GroupsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// UserKey sets the optional parameter "userKey": Email or immutable Id
-// of the user if only those groups are to be listed, the given user is
-// a member of. If Id, it should match with id of user object
-func (c *GroupsListCall) UserKey(userKey string) *GroupsListCall {
- c.opt_["userKey"] = userKey
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsListCall) Fields(s ...googleapi.Field) *GroupsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GroupsListCall) IfNoneMatch(entityTag string) *GroupsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsListCall) Context(ctx context.Context) *GroupsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["customer"]; ok {
- params.Set("customer", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["domain"]; ok {
- params.Set("domain", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["userKey"]; ok {
- params.Set("userKey", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "groups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.groups.list" call.
-// Exactly one of *Groups or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Groups.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *GroupsListCall) Do() (*Groups, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Groups{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieve all groups in a domain (paginated)",
- // "httpMethod": "GET",
- // "id": "directory.groups.list",
- // "parameters": {
- // "customer": {
- // "description": "Immutable id of the Google Apps account. In case of multi-domain, to fetch all groups for a customer, fill this field instead of domain.",
- // "location": "query",
- // "type": "string"
- // },
- // "domain": {
- // "description": "Name of the domain. Fill this field to get groups from only this domain. To return all groups in a multi-domain fill customer field instead.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return. Default is 200",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Token to specify next page in the list",
- // "location": "query",
- // "type": "string"
- // },
- // "userKey": {
- // "description": "Email or immutable Id of the user if only those groups are to be listed, the given user is a member of. If Id, it should match with id of user object",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "groups",
- // "response": {
- // "$ref": "Groups"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.group",
- // "https://www.googleapis.com/auth/admin.directory.group.readonly"
- // ]
- // }
-
-}
-
-// method id "directory.groups.patch":
-
-type GroupsPatchCall struct {
- s *Service
- groupKey string
- group *Group
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Update Group. This method supports patch semantics.
-func (r *GroupsService) Patch(groupKey string, group *Group) *GroupsPatchCall {
- c := &GroupsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.groupKey = groupKey
- c.group = group
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsPatchCall) Fields(s ...googleapi.Field) *GroupsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsPatchCall) Context(ctx context.Context) *GroupsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.group)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "groups/{groupKey}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "groupKey": c.groupKey,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.groups.patch" call.
-// Exactly one of *Group or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Group.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *GroupsPatchCall) Do() (*Group, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Group{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update Group. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "directory.groups.patch",
- // "parameterOrder": [
- // "groupKey"
- // ],
- // "parameters": {
- // "groupKey": {
- // "description": "Email or immutable Id of the group. If Id, it should match with id of group object",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "groups/{groupKey}",
- // "request": {
- // "$ref": "Group"
- // },
- // "response": {
- // "$ref": "Group"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.group"
- // ]
- // }
-
-}
-
-// method id "directory.groups.update":
-
-type GroupsUpdateCall struct {
- s *Service
- groupKey string
- group *Group
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Update Group
-func (r *GroupsService) Update(groupKey string, group *Group) *GroupsUpdateCall {
- c := &GroupsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.groupKey = groupKey
- c.group = group
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsUpdateCall) Fields(s ...googleapi.Field) *GroupsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsUpdateCall) Context(ctx context.Context) *GroupsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.group)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "groups/{groupKey}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "groupKey": c.groupKey,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.groups.update" call.
-// Exactly one of *Group or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Group.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *GroupsUpdateCall) Do() (*Group, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Group{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update Group",
- // "httpMethod": "PUT",
- // "id": "directory.groups.update",
- // "parameterOrder": [
- // "groupKey"
- // ],
- // "parameters": {
- // "groupKey": {
- // "description": "Email or immutable Id of the group. If Id, it should match with id of group object",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "groups/{groupKey}",
- // "request": {
- // "$ref": "Group"
- // },
- // "response": {
- // "$ref": "Group"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.group"
- // ]
- // }
-
-}
-
-// method id "directory.groups.aliases.delete":
-
-type GroupsAliasesDeleteCall struct {
- s *Service
- groupKey string
- alias string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Remove a alias for the group
-func (r *GroupsAliasesService) Delete(groupKey string, alias string) *GroupsAliasesDeleteCall {
- c := &GroupsAliasesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.groupKey = groupKey
- c.alias = alias
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsAliasesDeleteCall) Fields(s ...googleapi.Field) *GroupsAliasesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsAliasesDeleteCall) Context(ctx context.Context) *GroupsAliasesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsAliasesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "groups/{groupKey}/aliases/{alias}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "groupKey": c.groupKey,
- "alias": c.alias,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.groups.aliases.delete" call.
-func (c *GroupsAliasesDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Remove a alias for the group",
- // "httpMethod": "DELETE",
- // "id": "directory.groups.aliases.delete",
- // "parameterOrder": [
- // "groupKey",
- // "alias"
- // ],
- // "parameters": {
- // "alias": {
- // "description": "The alias to be removed",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "groupKey": {
- // "description": "Email or immutable Id of the group",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "groups/{groupKey}/aliases/{alias}",
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.group"
- // ]
- // }
-
-}
-
-// method id "directory.groups.aliases.insert":
-
-type GroupsAliasesInsertCall struct {
- s *Service
- groupKey string
- alias *Alias
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Add a alias for the group
-func (r *GroupsAliasesService) Insert(groupKey string, alias *Alias) *GroupsAliasesInsertCall {
- c := &GroupsAliasesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.groupKey = groupKey
- c.alias = alias
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsAliasesInsertCall) Fields(s ...googleapi.Field) *GroupsAliasesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsAliasesInsertCall) Context(ctx context.Context) *GroupsAliasesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsAliasesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.alias)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "groups/{groupKey}/aliases")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "groupKey": c.groupKey,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.groups.aliases.insert" call.
-// Exactly one of *Alias or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Alias.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *GroupsAliasesInsertCall) Do() (*Alias, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Alias{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Add a alias for the group",
- // "httpMethod": "POST",
- // "id": "directory.groups.aliases.insert",
- // "parameterOrder": [
- // "groupKey"
- // ],
- // "parameters": {
- // "groupKey": {
- // "description": "Email or immutable Id of the group",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "groups/{groupKey}/aliases",
- // "request": {
- // "$ref": "Alias"
- // },
- // "response": {
- // "$ref": "Alias"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.group"
- // ]
- // }
-
-}
-
-// method id "directory.groups.aliases.list":
-
-type GroupsAliasesListCall struct {
- s *Service
- groupKey string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all aliases for a group
-func (r *GroupsAliasesService) List(groupKey string) *GroupsAliasesListCall {
- c := &GroupsAliasesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.groupKey = groupKey
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsAliasesListCall) Fields(s ...googleapi.Field) *GroupsAliasesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GroupsAliasesListCall) IfNoneMatch(entityTag string) *GroupsAliasesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsAliasesListCall) Context(ctx context.Context) *GroupsAliasesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsAliasesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "groups/{groupKey}/aliases")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "groupKey": c.groupKey,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.groups.aliases.list" call.
-// Exactly one of *Aliases or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Aliases.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *GroupsAliasesListCall) Do() (*Aliases, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Aliases{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all aliases for a group",
- // "httpMethod": "GET",
- // "id": "directory.groups.aliases.list",
- // "parameterOrder": [
- // "groupKey"
- // ],
- // "parameters": {
- // "groupKey": {
- // "description": "Email or immutable Id of the group",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "groups/{groupKey}/aliases",
- // "response": {
- // "$ref": "Aliases"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.group",
- // "https://www.googleapis.com/auth/admin.directory.group.readonly"
- // ],
- // "supportsSubscription": true
- // }
-
-}
-
-// method id "directory.members.delete":
-
-type MembersDeleteCall struct {
- s *Service
- groupKey string
- memberKey string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Remove membership.
-func (r *MembersService) Delete(groupKey string, memberKey string) *MembersDeleteCall {
- c := &MembersDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.groupKey = groupKey
- c.memberKey = memberKey
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MembersDeleteCall) Fields(s ...googleapi.Field) *MembersDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MembersDeleteCall) Context(ctx context.Context) *MembersDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MembersDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "groups/{groupKey}/members/{memberKey}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "groupKey": c.groupKey,
- "memberKey": c.memberKey,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.members.delete" call.
-func (c *MembersDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Remove membership.",
- // "httpMethod": "DELETE",
- // "id": "directory.members.delete",
- // "parameterOrder": [
- // "groupKey",
- // "memberKey"
- // ],
- // "parameters": {
- // "groupKey": {
- // "description": "Email or immutable Id of the group",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "memberKey": {
- // "description": "Email or immutable Id of the member",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "groups/{groupKey}/members/{memberKey}",
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.group",
- // "https://www.googleapis.com/auth/admin.directory.group.member"
- // ]
- // }
-
-}
-
-// method id "directory.members.get":
-
-type MembersGetCall struct {
- s *Service
- groupKey string
- memberKey string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieve Group Member
-func (r *MembersService) Get(groupKey string, memberKey string) *MembersGetCall {
- c := &MembersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.groupKey = groupKey
- c.memberKey = memberKey
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MembersGetCall) Fields(s ...googleapi.Field) *MembersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MembersGetCall) IfNoneMatch(entityTag string) *MembersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MembersGetCall) Context(ctx context.Context) *MembersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MembersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "groups/{groupKey}/members/{memberKey}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "groupKey": c.groupKey,
- "memberKey": c.memberKey,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.members.get" call.
-// Exactly one of *Member or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Member.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *MembersGetCall) Do() (*Member, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Member{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieve Group Member",
- // "httpMethod": "GET",
- // "id": "directory.members.get",
- // "parameterOrder": [
- // "groupKey",
- // "memberKey"
- // ],
- // "parameters": {
- // "groupKey": {
- // "description": "Email or immutable Id of the group",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "memberKey": {
- // "description": "Email or immutable Id of the member",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "groups/{groupKey}/members/{memberKey}",
- // "response": {
- // "$ref": "Member"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.group",
- // "https://www.googleapis.com/auth/admin.directory.group.member",
- // "https://www.googleapis.com/auth/admin.directory.group.member.readonly",
- // "https://www.googleapis.com/auth/admin.directory.group.readonly"
- // ]
- // }
-
-}
-
-// method id "directory.members.insert":
-
-type MembersInsertCall struct {
- s *Service
- groupKey string
- member *Member
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Add user to the specified group.
-func (r *MembersService) Insert(groupKey string, member *Member) *MembersInsertCall {
- c := &MembersInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.groupKey = groupKey
- c.member = member
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MembersInsertCall) Fields(s ...googleapi.Field) *MembersInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MembersInsertCall) Context(ctx context.Context) *MembersInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MembersInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.member)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "groups/{groupKey}/members")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "groupKey": c.groupKey,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.members.insert" call.
-// Exactly one of *Member or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Member.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *MembersInsertCall) Do() (*Member, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Member{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Add user to the specified group.",
- // "httpMethod": "POST",
- // "id": "directory.members.insert",
- // "parameterOrder": [
- // "groupKey"
- // ],
- // "parameters": {
- // "groupKey": {
- // "description": "Email or immutable Id of the group",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "groups/{groupKey}/members",
- // "request": {
- // "$ref": "Member"
- // },
- // "response": {
- // "$ref": "Member"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.group",
- // "https://www.googleapis.com/auth/admin.directory.group.member"
- // ]
- // }
-
-}
-
-// method id "directory.members.list":
-
-type MembersListCall struct {
- s *Service
- groupKey string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieve all members in a group (paginated)
-func (r *MembersService) List(groupKey string) *MembersListCall {
- c := &MembersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.groupKey = groupKey
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return. Default is 200
-func (c *MembersListCall) MaxResults(maxResults int64) *MembersListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Token to specify
-// next page in the list
-func (c *MembersListCall) PageToken(pageToken string) *MembersListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Roles sets the optional parameter "roles": Comma separated role
-// values to filter list results on.
-func (c *MembersListCall) Roles(roles string) *MembersListCall {
- c.opt_["roles"] = roles
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MembersListCall) Fields(s ...googleapi.Field) *MembersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MembersListCall) IfNoneMatch(entityTag string) *MembersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MembersListCall) Context(ctx context.Context) *MembersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MembersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["roles"]; ok {
- params.Set("roles", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "groups/{groupKey}/members")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "groupKey": c.groupKey,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.members.list" call.
-// Exactly one of *Members or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Members.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *MembersListCall) Do() (*Members, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Members{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieve all members in a group (paginated)",
- // "httpMethod": "GET",
- // "id": "directory.members.list",
- // "parameterOrder": [
- // "groupKey"
- // ],
- // "parameters": {
- // "groupKey": {
- // "description": "Email or immutable Id of the group",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return. Default is 200",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Token to specify next page in the list",
- // "location": "query",
- // "type": "string"
- // },
- // "roles": {
- // "description": "Comma separated role values to filter list results on.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "groups/{groupKey}/members",
- // "response": {
- // "$ref": "Members"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.group",
- // "https://www.googleapis.com/auth/admin.directory.group.member",
- // "https://www.googleapis.com/auth/admin.directory.group.member.readonly",
- // "https://www.googleapis.com/auth/admin.directory.group.readonly"
- // ]
- // }
-
-}
-
-// method id "directory.members.patch":
-
-type MembersPatchCall struct {
- s *Service
- groupKey string
- memberKey string
- member *Member
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Update membership of a user in the specified group. This
-// method supports patch semantics.
-func (r *MembersService) Patch(groupKey string, memberKey string, member *Member) *MembersPatchCall {
- c := &MembersPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.groupKey = groupKey
- c.memberKey = memberKey
- c.member = member
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MembersPatchCall) Fields(s ...googleapi.Field) *MembersPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MembersPatchCall) Context(ctx context.Context) *MembersPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MembersPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.member)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "groups/{groupKey}/members/{memberKey}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "groupKey": c.groupKey,
- "memberKey": c.memberKey,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.members.patch" call.
-// Exactly one of *Member or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Member.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *MembersPatchCall) Do() (*Member, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Member{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update membership of a user in the specified group. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "directory.members.patch",
- // "parameterOrder": [
- // "groupKey",
- // "memberKey"
- // ],
- // "parameters": {
- // "groupKey": {
- // "description": "Email or immutable Id of the group. If Id, it should match with id of group object",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "memberKey": {
- // "description": "Email or immutable Id of the user. If Id, it should match with id of member object",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "groups/{groupKey}/members/{memberKey}",
- // "request": {
- // "$ref": "Member"
- // },
- // "response": {
- // "$ref": "Member"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.group",
- // "https://www.googleapis.com/auth/admin.directory.group.member"
- // ]
- // }
-
-}
-
-// method id "directory.members.update":
-
-type MembersUpdateCall struct {
- s *Service
- groupKey string
- memberKey string
- member *Member
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Update membership of a user in the specified group.
-func (r *MembersService) Update(groupKey string, memberKey string, member *Member) *MembersUpdateCall {
- c := &MembersUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.groupKey = groupKey
- c.memberKey = memberKey
- c.member = member
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MembersUpdateCall) Fields(s ...googleapi.Field) *MembersUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MembersUpdateCall) Context(ctx context.Context) *MembersUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MembersUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.member)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "groups/{groupKey}/members/{memberKey}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "groupKey": c.groupKey,
- "memberKey": c.memberKey,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.members.update" call.
-// Exactly one of *Member or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Member.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *MembersUpdateCall) Do() (*Member, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Member{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update membership of a user in the specified group.",
- // "httpMethod": "PUT",
- // "id": "directory.members.update",
- // "parameterOrder": [
- // "groupKey",
- // "memberKey"
- // ],
- // "parameters": {
- // "groupKey": {
- // "description": "Email or immutable Id of the group. If Id, it should match with id of group object",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "memberKey": {
- // "description": "Email or immutable Id of the user. If Id, it should match with id of member object",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "groups/{groupKey}/members/{memberKey}",
- // "request": {
- // "$ref": "Member"
- // },
- // "response": {
- // "$ref": "Member"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.group",
- // "https://www.googleapis.com/auth/admin.directory.group.member"
- // ]
- // }
-
-}
-
-// method id "directory.mobiledevices.action":
-
-type MobiledevicesActionCall struct {
- s *Service
- customerId string
- resourceId string
- mobiledeviceaction *MobileDeviceAction
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Action: Take action on Mobile Device
-func (r *MobiledevicesService) Action(customerId string, resourceId string, mobiledeviceaction *MobileDeviceAction) *MobiledevicesActionCall {
- c := &MobiledevicesActionCall{s: r.s, opt_: make(map[string]interface{})}
- c.customerId = customerId
- c.resourceId = resourceId
- c.mobiledeviceaction = mobiledeviceaction
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MobiledevicesActionCall) Fields(s ...googleapi.Field) *MobiledevicesActionCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MobiledevicesActionCall) Context(ctx context.Context) *MobiledevicesActionCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MobiledevicesActionCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.mobiledeviceaction)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customerId}/devices/mobile/{resourceId}/action")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customerId": c.customerId,
- "resourceId": c.resourceId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.mobiledevices.action" call.
-func (c *MobiledevicesActionCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Take action on Mobile Device",
- // "httpMethod": "POST",
- // "id": "directory.mobiledevices.action",
- // "parameterOrder": [
- // "customerId",
- // "resourceId"
- // ],
- // "parameters": {
- // "customerId": {
- // "description": "Immutable id of the Google Apps account",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "resourceId": {
- // "description": "Immutable id of Mobile Device",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customerId}/devices/mobile/{resourceId}/action",
- // "request": {
- // "$ref": "MobileDeviceAction"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.device.mobile",
- // "https://www.googleapis.com/auth/admin.directory.device.mobile.action"
- // ]
- // }
-
-}
-
-// method id "directory.mobiledevices.delete":
-
-type MobiledevicesDeleteCall struct {
- s *Service
- customerId string
- resourceId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Delete Mobile Device
-func (r *MobiledevicesService) Delete(customerId string, resourceId string) *MobiledevicesDeleteCall {
- c := &MobiledevicesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.customerId = customerId
- c.resourceId = resourceId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MobiledevicesDeleteCall) Fields(s ...googleapi.Field) *MobiledevicesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MobiledevicesDeleteCall) Context(ctx context.Context) *MobiledevicesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MobiledevicesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customerId}/devices/mobile/{resourceId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customerId": c.customerId,
- "resourceId": c.resourceId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.mobiledevices.delete" call.
-func (c *MobiledevicesDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Delete Mobile Device",
- // "httpMethod": "DELETE",
- // "id": "directory.mobiledevices.delete",
- // "parameterOrder": [
- // "customerId",
- // "resourceId"
- // ],
- // "parameters": {
- // "customerId": {
- // "description": "Immutable id of the Google Apps account",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "resourceId": {
- // "description": "Immutable id of Mobile Device",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customerId}/devices/mobile/{resourceId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.device.mobile"
- // ]
- // }
-
-}
-
-// method id "directory.mobiledevices.get":
-
-type MobiledevicesGetCall struct {
- s *Service
- customerId string
- resourceId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieve Mobile Device
-func (r *MobiledevicesService) Get(customerId string, resourceId string) *MobiledevicesGetCall {
- c := &MobiledevicesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.customerId = customerId
- c.resourceId = resourceId
- return c
-}
-
-// Projection sets the optional parameter "projection": Restrict
-// information returned to a set of selected fields.
-//
-// Possible values:
-// "BASIC" - Includes only the basic metadata fields (e.g., deviceId,
-// model, status, type, and status)
-// "FULL" - Includes all metadata fields
-func (c *MobiledevicesGetCall) Projection(projection string) *MobiledevicesGetCall {
- c.opt_["projection"] = projection
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MobiledevicesGetCall) Fields(s ...googleapi.Field) *MobiledevicesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MobiledevicesGetCall) IfNoneMatch(entityTag string) *MobiledevicesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MobiledevicesGetCall) Context(ctx context.Context) *MobiledevicesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MobiledevicesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["projection"]; ok {
- params.Set("projection", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customerId}/devices/mobile/{resourceId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customerId": c.customerId,
- "resourceId": c.resourceId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.mobiledevices.get" call.
-// Exactly one of *MobileDevice or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *MobileDevice.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *MobiledevicesGetCall) Do() (*MobileDevice, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &MobileDevice{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieve Mobile Device",
- // "httpMethod": "GET",
- // "id": "directory.mobiledevices.get",
- // "parameterOrder": [
- // "customerId",
- // "resourceId"
- // ],
- // "parameters": {
- // "customerId": {
- // "description": "Immutable id of the Google Apps account",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projection": {
- // "description": "Restrict information returned to a set of selected fields.",
- // "enum": [
- // "BASIC",
- // "FULL"
- // ],
- // "enumDescriptions": [
- // "Includes only the basic metadata fields (e.g., deviceId, model, status, type, and status)",
- // "Includes all metadata fields"
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "resourceId": {
- // "description": "Immutable id of Mobile Device",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customerId}/devices/mobile/{resourceId}",
- // "response": {
- // "$ref": "MobileDevice"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.device.mobile",
- // "https://www.googleapis.com/auth/admin.directory.device.mobile.action",
- // "https://www.googleapis.com/auth/admin.directory.device.mobile.readonly"
- // ]
- // }
-
-}
-
-// method id "directory.mobiledevices.list":
-
-type MobiledevicesListCall struct {
- s *Service
- customerId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieve all Mobile Devices of a customer (paginated)
-func (r *MobiledevicesService) List(customerId string) *MobiledevicesListCall {
- c := &MobiledevicesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.customerId = customerId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return. Default is 100
-func (c *MobiledevicesListCall) MaxResults(maxResults int64) *MobiledevicesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Column to use for
-// sorting results
-//
-// Possible values:
-// "deviceId" - Mobile Device serial number.
-// "email" - Owner user email.
-// "lastSync" - Last policy settings sync date time of the device.
-// "model" - Mobile Device model.
-// "name" - Owner user name.
-// "os" - Mobile operating system.
-// "status" - Status of the device.
-// "type" - Type of the device.
-func (c *MobiledevicesListCall) OrderBy(orderBy string) *MobiledevicesListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Token to specify
-// next page in the list
-func (c *MobiledevicesListCall) PageToken(pageToken string) *MobiledevicesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Projection sets the optional parameter "projection": Restrict
-// information returned to a set of selected fields.
-//
-// Possible values:
-// "BASIC" - Includes only the basic metadata fields (e.g., deviceId,
-// model, status, type, and status)
-// "FULL" - Includes all metadata fields
-func (c *MobiledevicesListCall) Projection(projection string) *MobiledevicesListCall {
- c.opt_["projection"] = projection
- return c
-}
-
-// Query sets the optional parameter "query": Search string in the
-// format given at
-// http://support.google.com/a/bin/answer.py?hl=en&answer=1408863#search
-func (c *MobiledevicesListCall) Query(query string) *MobiledevicesListCall {
- c.opt_["query"] = query
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Whether to return
-// results in ascending or descending order. Only of use when orderBy is
-// also used
-//
-// Possible values:
-// "ASCENDING" - Ascending order.
-// "DESCENDING" - Descending order.
-func (c *MobiledevicesListCall) SortOrder(sortOrder string) *MobiledevicesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MobiledevicesListCall) Fields(s ...googleapi.Field) *MobiledevicesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MobiledevicesListCall) IfNoneMatch(entityTag string) *MobiledevicesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MobiledevicesListCall) Context(ctx context.Context) *MobiledevicesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MobiledevicesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["projection"]; ok {
- params.Set("projection", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["query"]; ok {
- params.Set("query", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customerId}/devices/mobile")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customerId": c.customerId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.mobiledevices.list" call.
-// Exactly one of *MobileDevices or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *MobileDevices.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MobiledevicesListCall) Do() (*MobileDevices, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &MobileDevices{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieve all Mobile Devices of a customer (paginated)",
- // "httpMethod": "GET",
- // "id": "directory.mobiledevices.list",
- // "parameterOrder": [
- // "customerId"
- // ],
- // "parameters": {
- // "customerId": {
- // "description": "Immutable id of the Google Apps account",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return. Default is 100",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Column to use for sorting results",
- // "enum": [
- // "deviceId",
- // "email",
- // "lastSync",
- // "model",
- // "name",
- // "os",
- // "status",
- // "type"
- // ],
- // "enumDescriptions": [
- // "Mobile Device serial number.",
- // "Owner user email.",
- // "Last policy settings sync date time of the device.",
- // "Mobile Device model.",
- // "Owner user name.",
- // "Mobile operating system.",
- // "Status of the device.",
- // "Type of the device."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Token to specify next page in the list",
- // "location": "query",
- // "type": "string"
- // },
- // "projection": {
- // "description": "Restrict information returned to a set of selected fields.",
- // "enum": [
- // "BASIC",
- // "FULL"
- // ],
- // "enumDescriptions": [
- // "Includes only the basic metadata fields (e.g., deviceId, model, status, type, and status)",
- // "Includes all metadata fields"
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "query": {
- // "description": "Search string in the format given at http://support.google.com/a/bin/answer.py?hl=en\u0026answer=1408863#search",
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Whether to return results in ascending or descending order. Only of use when orderBy is also used",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "Ascending order.",
- // "Descending order."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "customer/{customerId}/devices/mobile",
- // "response": {
- // "$ref": "MobileDevices"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.device.mobile",
- // "https://www.googleapis.com/auth/admin.directory.device.mobile.action",
- // "https://www.googleapis.com/auth/admin.directory.device.mobile.readonly"
- // ]
- // }
-
-}
-
-// method id "directory.notifications.delete":
-
-type NotificationsDeleteCall struct {
- s *Service
- customer string
- notificationId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes a notification
-func (r *NotificationsService) Delete(customer string, notificationId string) *NotificationsDeleteCall {
- c := &NotificationsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.customer = customer
- c.notificationId = notificationId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *NotificationsDeleteCall) Fields(s ...googleapi.Field) *NotificationsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *NotificationsDeleteCall) Context(ctx context.Context) *NotificationsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *NotificationsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customer}/notifications/{notificationId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customer": c.customer,
- "notificationId": c.notificationId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.notifications.delete" call.
-func (c *NotificationsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes a notification",
- // "httpMethod": "DELETE",
- // "id": "directory.notifications.delete",
- // "parameterOrder": [
- // "customer",
- // "notificationId"
- // ],
- // "parameters": {
- // "customer": {
- // "description": "The unique ID for the customer's Google account. The customerId is also returned as part of the Users resource.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "notificationId": {
- // "description": "The unique ID of the notification.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customer}/notifications/{notificationId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.notifications"
- // ]
- // }
-
-}
-
-// method id "directory.notifications.get":
-
-type NotificationsGetCall struct {
- s *Service
- customer string
- notificationId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves a notification.
-func (r *NotificationsService) Get(customer string, notificationId string) *NotificationsGetCall {
- c := &NotificationsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.customer = customer
- c.notificationId = notificationId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *NotificationsGetCall) Fields(s ...googleapi.Field) *NotificationsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *NotificationsGetCall) IfNoneMatch(entityTag string) *NotificationsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *NotificationsGetCall) Context(ctx context.Context) *NotificationsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *NotificationsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customer}/notifications/{notificationId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customer": c.customer,
- "notificationId": c.notificationId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.notifications.get" call.
-// Exactly one of *Notification or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Notification.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *NotificationsGetCall) Do() (*Notification, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Notification{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a notification.",
- // "httpMethod": "GET",
- // "id": "directory.notifications.get",
- // "parameterOrder": [
- // "customer",
- // "notificationId"
- // ],
- // "parameters": {
- // "customer": {
- // "description": "The unique ID for the customer's Google account. The customerId is also returned as part of the Users resource.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "notificationId": {
- // "description": "The unique ID of the notification.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customer}/notifications/{notificationId}",
- // "response": {
- // "$ref": "Notification"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.notifications"
- // ]
- // }
-
-}
-
-// method id "directory.notifications.list":
-
-type NotificationsListCall struct {
- s *Service
- customer string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of notifications.
-func (r *NotificationsService) List(customer string) *NotificationsListCall {
- c := &NotificationsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.customer = customer
- return c
-}
-
-// Language sets the optional parameter "language": The ISO 639-1 code
-// of the language notifications are returned in. The default is English
-// (en).
-func (c *NotificationsListCall) Language(language string) *NotificationsListCall {
- c.opt_["language"] = language
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of notifications to return per page. The default is 100.
-func (c *NotificationsListCall) MaxResults(maxResults int64) *NotificationsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The token to
-// specify the page of results to retrieve.
-func (c *NotificationsListCall) PageToken(pageToken string) *NotificationsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *NotificationsListCall) Fields(s ...googleapi.Field) *NotificationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *NotificationsListCall) IfNoneMatch(entityTag string) *NotificationsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *NotificationsListCall) Context(ctx context.Context) *NotificationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *NotificationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["language"]; ok {
- params.Set("language", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customer}/notifications")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customer": c.customer,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.notifications.list" call.
-// Exactly one of *Notifications or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Notifications.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *NotificationsListCall) Do() (*Notifications, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Notifications{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of notifications.",
- // "httpMethod": "GET",
- // "id": "directory.notifications.list",
- // "parameterOrder": [
- // "customer"
- // ],
- // "parameters": {
- // "customer": {
- // "description": "The unique ID for the customer's Google account.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "language": {
- // "description": "The ISO 639-1 code of the language notifications are returned in. The default is English (en).",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of notifications to return per page. The default is 100.",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The token to specify the page of results to retrieve.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "customer/{customer}/notifications",
- // "response": {
- // "$ref": "Notifications"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.notifications"
- // ]
- // }
-
-}
-
-// method id "directory.notifications.patch":
-
-type NotificationsPatchCall struct {
- s *Service
- customer string
- notificationId string
- notification *Notification
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates a notification. This method supports patch semantics.
-func (r *NotificationsService) Patch(customer string, notificationId string, notification *Notification) *NotificationsPatchCall {
- c := &NotificationsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.customer = customer
- c.notificationId = notificationId
- c.notification = notification
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *NotificationsPatchCall) Fields(s ...googleapi.Field) *NotificationsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *NotificationsPatchCall) Context(ctx context.Context) *NotificationsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *NotificationsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.notification)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customer}/notifications/{notificationId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customer": c.customer,
- "notificationId": c.notificationId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.notifications.patch" call.
-// Exactly one of *Notification or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Notification.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *NotificationsPatchCall) Do() (*Notification, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Notification{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a notification. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "directory.notifications.patch",
- // "parameterOrder": [
- // "customer",
- // "notificationId"
- // ],
- // "parameters": {
- // "customer": {
- // "description": "The unique ID for the customer's Google account.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "notificationId": {
- // "description": "The unique ID of the notification.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customer}/notifications/{notificationId}",
- // "request": {
- // "$ref": "Notification"
- // },
- // "response": {
- // "$ref": "Notification"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.notifications"
- // ]
- // }
-
-}
-
-// method id "directory.notifications.update":
-
-type NotificationsUpdateCall struct {
- s *Service
- customer string
- notificationId string
- notification *Notification
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates a notification.
-func (r *NotificationsService) Update(customer string, notificationId string, notification *Notification) *NotificationsUpdateCall {
- c := &NotificationsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.customer = customer
- c.notificationId = notificationId
- c.notification = notification
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *NotificationsUpdateCall) Fields(s ...googleapi.Field) *NotificationsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *NotificationsUpdateCall) Context(ctx context.Context) *NotificationsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *NotificationsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.notification)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customer}/notifications/{notificationId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customer": c.customer,
- "notificationId": c.notificationId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.notifications.update" call.
-// Exactly one of *Notification or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Notification.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *NotificationsUpdateCall) Do() (*Notification, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Notification{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a notification.",
- // "httpMethod": "PUT",
- // "id": "directory.notifications.update",
- // "parameterOrder": [
- // "customer",
- // "notificationId"
- // ],
- // "parameters": {
- // "customer": {
- // "description": "The unique ID for the customer's Google account.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "notificationId": {
- // "description": "The unique ID of the notification.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customer}/notifications/{notificationId}",
- // "request": {
- // "$ref": "Notification"
- // },
- // "response": {
- // "$ref": "Notification"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.notifications"
- // ]
- // }
-
-}
-
-// method id "directory.orgunits.delete":
-
-type OrgunitsDeleteCall struct {
- s *Service
- customerId string
- orgUnitPath []string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Remove Organization Unit
-func (r *OrgunitsService) Delete(customerId string, orgUnitPath []string) *OrgunitsDeleteCall {
- c := &OrgunitsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.customerId = customerId
- c.orgUnitPath = orgUnitPath
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrgunitsDeleteCall) Fields(s ...googleapi.Field) *OrgunitsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrgunitsDeleteCall) Context(ctx context.Context) *OrgunitsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrgunitsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customerId}/orgunits{/orgUnitPath*}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customerId": c.customerId,
- "orgUnitPath": c.orgUnitPath[0],
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.orgunits.delete" call.
-func (c *OrgunitsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Remove Organization Unit",
- // "httpMethod": "DELETE",
- // "id": "directory.orgunits.delete",
- // "parameterOrder": [
- // "customerId",
- // "orgUnitPath"
- // ],
- // "parameters": {
- // "customerId": {
- // "description": "Immutable id of the Google Apps account",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "orgUnitPath": {
- // "description": "Full path of the organization unit or its Id",
- // "location": "path",
- // "repeated": true,
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customerId}/orgunits{/orgUnitPath*}",
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.orgunit"
- // ]
- // }
-
-}
-
-// method id "directory.orgunits.get":
-
-type OrgunitsGetCall struct {
- s *Service
- customerId string
- orgUnitPath []string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieve Organization Unit
-func (r *OrgunitsService) Get(customerId string, orgUnitPath []string) *OrgunitsGetCall {
- c := &OrgunitsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.customerId = customerId
- c.orgUnitPath = orgUnitPath
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrgunitsGetCall) Fields(s ...googleapi.Field) *OrgunitsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OrgunitsGetCall) IfNoneMatch(entityTag string) *OrgunitsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrgunitsGetCall) Context(ctx context.Context) *OrgunitsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrgunitsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customerId}/orgunits{/orgUnitPath*}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customerId": c.customerId,
- "orgUnitPath": c.orgUnitPath[0],
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.orgunits.get" call.
-// Exactly one of *OrgUnit or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *OrgUnit.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *OrgunitsGetCall) Do() (*OrgUnit, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrgUnit{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieve Organization Unit",
- // "httpMethod": "GET",
- // "id": "directory.orgunits.get",
- // "parameterOrder": [
- // "customerId",
- // "orgUnitPath"
- // ],
- // "parameters": {
- // "customerId": {
- // "description": "Immutable id of the Google Apps account",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "orgUnitPath": {
- // "description": "Full path of the organization unit or its Id",
- // "location": "path",
- // "repeated": true,
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customerId}/orgunits{/orgUnitPath*}",
- // "response": {
- // "$ref": "OrgUnit"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.orgunit",
- // "https://www.googleapis.com/auth/admin.directory.orgunit.readonly"
- // ]
- // }
-
-}
-
-// method id "directory.orgunits.insert":
-
-type OrgunitsInsertCall struct {
- s *Service
- customerId string
- orgunit *OrgUnit
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Add Organization Unit
-func (r *OrgunitsService) Insert(customerId string, orgunit *OrgUnit) *OrgunitsInsertCall {
- c := &OrgunitsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.customerId = customerId
- c.orgunit = orgunit
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrgunitsInsertCall) Fields(s ...googleapi.Field) *OrgunitsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrgunitsInsertCall) Context(ctx context.Context) *OrgunitsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrgunitsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.orgunit)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customerId}/orgunits")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customerId": c.customerId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.orgunits.insert" call.
-// Exactly one of *OrgUnit or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *OrgUnit.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *OrgunitsInsertCall) Do() (*OrgUnit, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrgUnit{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Add Organization Unit",
- // "httpMethod": "POST",
- // "id": "directory.orgunits.insert",
- // "parameterOrder": [
- // "customerId"
- // ],
- // "parameters": {
- // "customerId": {
- // "description": "Immutable id of the Google Apps account",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customerId}/orgunits",
- // "request": {
- // "$ref": "OrgUnit"
- // },
- // "response": {
- // "$ref": "OrgUnit"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.orgunit"
- // ]
- // }
-
-}
-
-// method id "directory.orgunits.list":
-
-type OrgunitsListCall struct {
- s *Service
- customerId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieve all Organization Units
-func (r *OrgunitsService) List(customerId string) *OrgunitsListCall {
- c := &OrgunitsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.customerId = customerId
- return c
-}
-
-// OrgUnitPath sets the optional parameter "orgUnitPath": the
-// URL-encoded organization unit's path or its Id
-func (c *OrgunitsListCall) OrgUnitPath(orgUnitPath string) *OrgunitsListCall {
- c.opt_["orgUnitPath"] = orgUnitPath
- return c
-}
-
-// Type sets the optional parameter "type": Whether to return all
-// sub-organizations or just immediate children
-//
-// Possible values:
-// "all" - All sub-organization units.
-// "children" - Immediate children only (default).
-func (c *OrgunitsListCall) Type(type_ string) *OrgunitsListCall {
- c.opt_["type"] = type_
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrgunitsListCall) Fields(s ...googleapi.Field) *OrgunitsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OrgunitsListCall) IfNoneMatch(entityTag string) *OrgunitsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrgunitsListCall) Context(ctx context.Context) *OrgunitsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrgunitsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["orgUnitPath"]; ok {
- params.Set("orgUnitPath", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["type"]; ok {
- params.Set("type", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customerId}/orgunits")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customerId": c.customerId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.orgunits.list" call.
-// Exactly one of *OrgUnits or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *OrgUnits.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *OrgunitsListCall) Do() (*OrgUnits, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrgUnits{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieve all Organization Units",
- // "httpMethod": "GET",
- // "id": "directory.orgunits.list",
- // "parameterOrder": [
- // "customerId"
- // ],
- // "parameters": {
- // "customerId": {
- // "description": "Immutable id of the Google Apps account",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "orgUnitPath": {
- // "default": "",
- // "description": "the URL-encoded organization unit's path or its Id",
- // "location": "query",
- // "type": "string"
- // },
- // "type": {
- // "description": "Whether to return all sub-organizations or just immediate children",
- // "enum": [
- // "all",
- // "children"
- // ],
- // "enumDescriptions": [
- // "All sub-organization units.",
- // "Immediate children only (default)."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "customer/{customerId}/orgunits",
- // "response": {
- // "$ref": "OrgUnits"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.orgunit",
- // "https://www.googleapis.com/auth/admin.directory.orgunit.readonly"
- // ]
- // }
-
-}
-
-// method id "directory.orgunits.patch":
-
-type OrgunitsPatchCall struct {
- s *Service
- customerId string
- orgUnitPath []string
- orgunit *OrgUnit
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Update Organization Unit. This method supports patch
-// semantics.
-func (r *OrgunitsService) Patch(customerId string, orgUnitPath []string, orgunit *OrgUnit) *OrgunitsPatchCall {
- c := &OrgunitsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.customerId = customerId
- c.orgUnitPath = orgUnitPath
- c.orgunit = orgunit
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrgunitsPatchCall) Fields(s ...googleapi.Field) *OrgunitsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrgunitsPatchCall) Context(ctx context.Context) *OrgunitsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrgunitsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.orgunit)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customerId}/orgunits{/orgUnitPath*}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customerId": c.customerId,
- "orgUnitPath": c.orgUnitPath[0],
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.orgunits.patch" call.
-// Exactly one of *OrgUnit or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *OrgUnit.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *OrgunitsPatchCall) Do() (*OrgUnit, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrgUnit{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update Organization Unit. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "directory.orgunits.patch",
- // "parameterOrder": [
- // "customerId",
- // "orgUnitPath"
- // ],
- // "parameters": {
- // "customerId": {
- // "description": "Immutable id of the Google Apps account",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "orgUnitPath": {
- // "description": "Full path of the organization unit or its Id",
- // "location": "path",
- // "repeated": true,
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customerId}/orgunits{/orgUnitPath*}",
- // "request": {
- // "$ref": "OrgUnit"
- // },
- // "response": {
- // "$ref": "OrgUnit"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.orgunit"
- // ]
- // }
-
-}
-
-// method id "directory.orgunits.update":
-
-type OrgunitsUpdateCall struct {
- s *Service
- customerId string
- orgUnitPath []string
- orgunit *OrgUnit
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Update Organization Unit
-func (r *OrgunitsService) Update(customerId string, orgUnitPath []string, orgunit *OrgUnit) *OrgunitsUpdateCall {
- c := &OrgunitsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.customerId = customerId
- c.orgUnitPath = orgUnitPath
- c.orgunit = orgunit
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrgunitsUpdateCall) Fields(s ...googleapi.Field) *OrgunitsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrgunitsUpdateCall) Context(ctx context.Context) *OrgunitsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrgunitsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.orgunit)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customerId}/orgunits{/orgUnitPath*}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customerId": c.customerId,
- "orgUnitPath": c.orgUnitPath[0],
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.orgunits.update" call.
-// Exactly one of *OrgUnit or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *OrgUnit.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *OrgunitsUpdateCall) Do() (*OrgUnit, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrgUnit{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update Organization Unit",
- // "httpMethod": "PUT",
- // "id": "directory.orgunits.update",
- // "parameterOrder": [
- // "customerId",
- // "orgUnitPath"
- // ],
- // "parameters": {
- // "customerId": {
- // "description": "Immutable id of the Google Apps account",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "orgUnitPath": {
- // "description": "Full path of the organization unit or its Id",
- // "location": "path",
- // "repeated": true,
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customerId}/orgunits{/orgUnitPath*}",
- // "request": {
- // "$ref": "OrgUnit"
- // },
- // "response": {
- // "$ref": "OrgUnit"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.orgunit"
- // ]
- // }
-
-}
-
-// method id "directory.privileges.list":
-
-type PrivilegesListCall struct {
- s *Service
- customer string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a paginated list of all privileges for a customer.
-func (r *PrivilegesService) List(customer string) *PrivilegesListCall {
- c := &PrivilegesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.customer = customer
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PrivilegesListCall) Fields(s ...googleapi.Field) *PrivilegesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PrivilegesListCall) IfNoneMatch(entityTag string) *PrivilegesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PrivilegesListCall) Context(ctx context.Context) *PrivilegesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PrivilegesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customer}/roles/ALL/privileges")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customer": c.customer,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.privileges.list" call.
-// Exactly one of *Privileges or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Privileges.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *PrivilegesListCall) Do() (*Privileges, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Privileges{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a paginated list of all privileges for a customer.",
- // "httpMethod": "GET",
- // "id": "directory.privileges.list",
- // "parameterOrder": [
- // "customer"
- // ],
- // "parameters": {
- // "customer": {
- // "description": "Immutable ID of the Google Apps account.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customer}/roles/ALL/privileges",
- // "response": {
- // "$ref": "Privileges"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.rolemanagement",
- // "https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly"
- // ]
- // }
-
-}
-
-// method id "directory.roleAssignments.delete":
-
-type RoleAssignmentsDeleteCall struct {
- s *Service
- customer string
- roleAssignmentId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes a role assignment.
-func (r *RoleAssignmentsService) Delete(customer string, roleAssignmentId string) *RoleAssignmentsDeleteCall {
- c := &RoleAssignmentsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.customer = customer
- c.roleAssignmentId = roleAssignmentId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RoleAssignmentsDeleteCall) Fields(s ...googleapi.Field) *RoleAssignmentsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RoleAssignmentsDeleteCall) Context(ctx context.Context) *RoleAssignmentsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RoleAssignmentsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customer}/roleassignments/{roleAssignmentId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customer": c.customer,
- "roleAssignmentId": c.roleAssignmentId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.roleAssignments.delete" call.
-func (c *RoleAssignmentsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes a role assignment.",
- // "httpMethod": "DELETE",
- // "id": "directory.roleAssignments.delete",
- // "parameterOrder": [
- // "customer",
- // "roleAssignmentId"
- // ],
- // "parameters": {
- // "customer": {
- // "description": "Immutable ID of the Google Apps account.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "roleAssignmentId": {
- // "description": "Immutable ID of the role assignment.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customer}/roleassignments/{roleAssignmentId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.rolemanagement"
- // ]
- // }
-
-}
-
-// method id "directory.roleAssignments.get":
-
-type RoleAssignmentsGetCall struct {
- s *Service
- customer string
- roleAssignmentId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieve a role assignment.
-func (r *RoleAssignmentsService) Get(customer string, roleAssignmentId string) *RoleAssignmentsGetCall {
- c := &RoleAssignmentsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.customer = customer
- c.roleAssignmentId = roleAssignmentId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RoleAssignmentsGetCall) Fields(s ...googleapi.Field) *RoleAssignmentsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *RoleAssignmentsGetCall) IfNoneMatch(entityTag string) *RoleAssignmentsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RoleAssignmentsGetCall) Context(ctx context.Context) *RoleAssignmentsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RoleAssignmentsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customer}/roleassignments/{roleAssignmentId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customer": c.customer,
- "roleAssignmentId": c.roleAssignmentId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.roleAssignments.get" call.
-// Exactly one of *RoleAssignment or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *RoleAssignment.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *RoleAssignmentsGetCall) Do() (*RoleAssignment, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &RoleAssignment{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieve a role assignment.",
- // "httpMethod": "GET",
- // "id": "directory.roleAssignments.get",
- // "parameterOrder": [
- // "customer",
- // "roleAssignmentId"
- // ],
- // "parameters": {
- // "customer": {
- // "description": "Immutable ID of the Google Apps account.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "roleAssignmentId": {
- // "description": "Immutable ID of the role assignment.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customer}/roleassignments/{roleAssignmentId}",
- // "response": {
- // "$ref": "RoleAssignment"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.rolemanagement",
- // "https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly"
- // ]
- // }
-
-}
-
-// method id "directory.roleAssignments.insert":
-
-type RoleAssignmentsInsertCall struct {
- s *Service
- customer string
- roleassignment *RoleAssignment
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a role assignment.
-func (r *RoleAssignmentsService) Insert(customer string, roleassignment *RoleAssignment) *RoleAssignmentsInsertCall {
- c := &RoleAssignmentsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.customer = customer
- c.roleassignment = roleassignment
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RoleAssignmentsInsertCall) Fields(s ...googleapi.Field) *RoleAssignmentsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RoleAssignmentsInsertCall) Context(ctx context.Context) *RoleAssignmentsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RoleAssignmentsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.roleassignment)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customer}/roleassignments")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customer": c.customer,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.roleAssignments.insert" call.
-// Exactly one of *RoleAssignment or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *RoleAssignment.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *RoleAssignmentsInsertCall) Do() (*RoleAssignment, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &RoleAssignment{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a role assignment.",
- // "httpMethod": "POST",
- // "id": "directory.roleAssignments.insert",
- // "parameterOrder": [
- // "customer"
- // ],
- // "parameters": {
- // "customer": {
- // "description": "Immutable ID of the Google Apps account.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customer}/roleassignments",
- // "request": {
- // "$ref": "RoleAssignment"
- // },
- // "response": {
- // "$ref": "RoleAssignment"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.rolemanagement"
- // ]
- // }
-
-}
-
-// method id "directory.roleAssignments.list":
-
-type RoleAssignmentsListCall struct {
- s *Service
- customer string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a paginated list of all roleAssignments.
-func (r *RoleAssignmentsService) List(customer string) *RoleAssignmentsListCall {
- c := &RoleAssignmentsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.customer = customer
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *RoleAssignmentsListCall) MaxResults(maxResults int64) *RoleAssignmentsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Token to specify
-// the next page in the list.
-func (c *RoleAssignmentsListCall) PageToken(pageToken string) *RoleAssignmentsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// RoleId sets the optional parameter "roleId": Immutable ID of a role.
-// If included in the request, returns only role assignments containing
-// this role ID.
-func (c *RoleAssignmentsListCall) RoleId(roleId string) *RoleAssignmentsListCall {
- c.opt_["roleId"] = roleId
- return c
-}
-
-// UserKey sets the optional parameter "userKey": The user's primary
-// email address, alias email address, or unique user ID. If included in
-// the request, returns role assignments only for this user.
-func (c *RoleAssignmentsListCall) UserKey(userKey string) *RoleAssignmentsListCall {
- c.opt_["userKey"] = userKey
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RoleAssignmentsListCall) Fields(s ...googleapi.Field) *RoleAssignmentsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *RoleAssignmentsListCall) IfNoneMatch(entityTag string) *RoleAssignmentsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RoleAssignmentsListCall) Context(ctx context.Context) *RoleAssignmentsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RoleAssignmentsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["roleId"]; ok {
- params.Set("roleId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["userKey"]; ok {
- params.Set("userKey", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customer}/roleassignments")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customer": c.customer,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.roleAssignments.list" call.
-// Exactly one of *RoleAssignments or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *RoleAssignments.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *RoleAssignmentsListCall) Do() (*RoleAssignments, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &RoleAssignments{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a paginated list of all roleAssignments.",
- // "httpMethod": "GET",
- // "id": "directory.roleAssignments.list",
- // "parameterOrder": [
- // "customer"
- // ],
- // "parameters": {
- // "customer": {
- // "description": "Immutable ID of the Google Apps account.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "200",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Token to specify the next page in the list.",
- // "location": "query",
- // "type": "string"
- // },
- // "roleId": {
- // "description": "Immutable ID of a role. If included in the request, returns only role assignments containing this role ID.",
- // "location": "query",
- // "type": "string"
- // },
- // "userKey": {
- // "description": "The user's primary email address, alias email address, or unique user ID. If included in the request, returns role assignments only for this user.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "customer/{customer}/roleassignments",
- // "response": {
- // "$ref": "RoleAssignments"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.rolemanagement",
- // "https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly"
- // ]
- // }
-
-}
-
-// method id "directory.roles.delete":
-
-type RolesDeleteCall struct {
- s *Service
- customer string
- roleId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes a role.
-func (r *RolesService) Delete(customer string, roleId string) *RolesDeleteCall {
- c := &RolesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.customer = customer
- c.roleId = roleId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RolesDeleteCall) Fields(s ...googleapi.Field) *RolesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RolesDeleteCall) Context(ctx context.Context) *RolesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RolesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customer}/roles/{roleId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customer": c.customer,
- "roleId": c.roleId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.roles.delete" call.
-func (c *RolesDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes a role.",
- // "httpMethod": "DELETE",
- // "id": "directory.roles.delete",
- // "parameterOrder": [
- // "customer",
- // "roleId"
- // ],
- // "parameters": {
- // "customer": {
- // "description": "Immutable ID of the Google Apps account.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "roleId": {
- // "description": "Immutable ID of the role.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customer}/roles/{roleId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.rolemanagement"
- // ]
- // }
-
-}
-
-// method id "directory.roles.get":
-
-type RolesGetCall struct {
- s *Service
- customer string
- roleId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves a role.
-func (r *RolesService) Get(customer string, roleId string) *RolesGetCall {
- c := &RolesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.customer = customer
- c.roleId = roleId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RolesGetCall) Fields(s ...googleapi.Field) *RolesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *RolesGetCall) IfNoneMatch(entityTag string) *RolesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RolesGetCall) Context(ctx context.Context) *RolesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RolesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customer}/roles/{roleId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customer": c.customer,
- "roleId": c.roleId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.roles.get" call.
-// Exactly one of *Role or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Role.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *RolesGetCall) Do() (*Role, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Role{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a role.",
- // "httpMethod": "GET",
- // "id": "directory.roles.get",
- // "parameterOrder": [
- // "customer",
- // "roleId"
- // ],
- // "parameters": {
- // "customer": {
- // "description": "Immutable ID of the Google Apps account.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "roleId": {
- // "description": "Immutable ID of the role.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customer}/roles/{roleId}",
- // "response": {
- // "$ref": "Role"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.rolemanagement",
- // "https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly"
- // ]
- // }
-
-}
-
-// method id "directory.roles.insert":
-
-type RolesInsertCall struct {
- s *Service
- customer string
- role *Role
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a role.
-func (r *RolesService) Insert(customer string, role *Role) *RolesInsertCall {
- c := &RolesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.customer = customer
- c.role = role
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RolesInsertCall) Fields(s ...googleapi.Field) *RolesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RolesInsertCall) Context(ctx context.Context) *RolesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RolesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.role)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customer}/roles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customer": c.customer,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.roles.insert" call.
-// Exactly one of *Role or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Role.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *RolesInsertCall) Do() (*Role, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Role{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a role.",
- // "httpMethod": "POST",
- // "id": "directory.roles.insert",
- // "parameterOrder": [
- // "customer"
- // ],
- // "parameters": {
- // "customer": {
- // "description": "Immutable ID of the Google Apps account.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customer}/roles",
- // "request": {
- // "$ref": "Role"
- // },
- // "response": {
- // "$ref": "Role"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.rolemanagement"
- // ]
- // }
-
-}
-
-// method id "directory.roles.list":
-
-type RolesListCall struct {
- s *Service
- customer string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a paginated list of all the roles in a domain.
-func (r *RolesService) List(customer string) *RolesListCall {
- c := &RolesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.customer = customer
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *RolesListCall) MaxResults(maxResults int64) *RolesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Token to specify
-// the next page in the list.
-func (c *RolesListCall) PageToken(pageToken string) *RolesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RolesListCall) Fields(s ...googleapi.Field) *RolesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *RolesListCall) IfNoneMatch(entityTag string) *RolesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RolesListCall) Context(ctx context.Context) *RolesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RolesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customer}/roles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customer": c.customer,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.roles.list" call.
-// Exactly one of *Roles or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Roles.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *RolesListCall) Do() (*Roles, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Roles{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a paginated list of all the roles in a domain.",
- // "httpMethod": "GET",
- // "id": "directory.roles.list",
- // "parameterOrder": [
- // "customer"
- // ],
- // "parameters": {
- // "customer": {
- // "description": "Immutable id of the Google Apps account.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "100",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Token to specify the next page in the list.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "customer/{customer}/roles",
- // "response": {
- // "$ref": "Roles"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.rolemanagement",
- // "https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly"
- // ]
- // }
-
-}
-
-// method id "directory.roles.patch":
-
-type RolesPatchCall struct {
- s *Service
- customer string
- roleId string
- role *Role
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates a role. This method supports patch semantics.
-func (r *RolesService) Patch(customer string, roleId string, role *Role) *RolesPatchCall {
- c := &RolesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.customer = customer
- c.roleId = roleId
- c.role = role
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RolesPatchCall) Fields(s ...googleapi.Field) *RolesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RolesPatchCall) Context(ctx context.Context) *RolesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RolesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.role)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customer}/roles/{roleId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customer": c.customer,
- "roleId": c.roleId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.roles.patch" call.
-// Exactly one of *Role or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Role.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *RolesPatchCall) Do() (*Role, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Role{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a role. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "directory.roles.patch",
- // "parameterOrder": [
- // "customer",
- // "roleId"
- // ],
- // "parameters": {
- // "customer": {
- // "description": "Immutable ID of the Google Apps account.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "roleId": {
- // "description": "Immutable ID of the role.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customer}/roles/{roleId}",
- // "request": {
- // "$ref": "Role"
- // },
- // "response": {
- // "$ref": "Role"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.rolemanagement"
- // ]
- // }
-
-}
-
-// method id "directory.roles.update":
-
-type RolesUpdateCall struct {
- s *Service
- customer string
- roleId string
- role *Role
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates a role.
-func (r *RolesService) Update(customer string, roleId string, role *Role) *RolesUpdateCall {
- c := &RolesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.customer = customer
- c.roleId = roleId
- c.role = role
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RolesUpdateCall) Fields(s ...googleapi.Field) *RolesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RolesUpdateCall) Context(ctx context.Context) *RolesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RolesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.role)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customer}/roles/{roleId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customer": c.customer,
- "roleId": c.roleId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.roles.update" call.
-// Exactly one of *Role or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Role.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *RolesUpdateCall) Do() (*Role, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Role{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a role.",
- // "httpMethod": "PUT",
- // "id": "directory.roles.update",
- // "parameterOrder": [
- // "customer",
- // "roleId"
- // ],
- // "parameters": {
- // "customer": {
- // "description": "Immutable ID of the Google Apps account.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "roleId": {
- // "description": "Immutable ID of the role.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customer}/roles/{roleId}",
- // "request": {
- // "$ref": "Role"
- // },
- // "response": {
- // "$ref": "Role"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.rolemanagement"
- // ]
- // }
-
-}
-
-// method id "directory.schemas.delete":
-
-type SchemasDeleteCall struct {
- s *Service
- customerId string
- schemaKey string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Delete schema
-func (r *SchemasService) Delete(customerId string, schemaKey string) *SchemasDeleteCall {
- c := &SchemasDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.customerId = customerId
- c.schemaKey = schemaKey
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SchemasDeleteCall) Fields(s ...googleapi.Field) *SchemasDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SchemasDeleteCall) Context(ctx context.Context) *SchemasDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SchemasDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customerId}/schemas/{schemaKey}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customerId": c.customerId,
- "schemaKey": c.schemaKey,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.schemas.delete" call.
-func (c *SchemasDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Delete schema",
- // "httpMethod": "DELETE",
- // "id": "directory.schemas.delete",
- // "parameterOrder": [
- // "customerId",
- // "schemaKey"
- // ],
- // "parameters": {
- // "customerId": {
- // "description": "Immutable id of the Google Apps account",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "schemaKey": {
- // "description": "Name or immutable Id of the schema",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customerId}/schemas/{schemaKey}",
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.userschema"
- // ]
- // }
-
-}
-
-// method id "directory.schemas.get":
-
-type SchemasGetCall struct {
- s *Service
- customerId string
- schemaKey string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieve schema
-func (r *SchemasService) Get(customerId string, schemaKey string) *SchemasGetCall {
- c := &SchemasGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.customerId = customerId
- c.schemaKey = schemaKey
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SchemasGetCall) Fields(s ...googleapi.Field) *SchemasGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SchemasGetCall) IfNoneMatch(entityTag string) *SchemasGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SchemasGetCall) Context(ctx context.Context) *SchemasGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SchemasGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customerId}/schemas/{schemaKey}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customerId": c.customerId,
- "schemaKey": c.schemaKey,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.schemas.get" call.
-// Exactly one of *Schema or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Schema.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *SchemasGetCall) Do() (*Schema, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Schema{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieve schema",
- // "httpMethod": "GET",
- // "id": "directory.schemas.get",
- // "parameterOrder": [
- // "customerId",
- // "schemaKey"
- // ],
- // "parameters": {
- // "customerId": {
- // "description": "Immutable id of the Google Apps account",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "schemaKey": {
- // "description": "Name or immutable Id of the schema",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customerId}/schemas/{schemaKey}",
- // "response": {
- // "$ref": "Schema"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.userschema",
- // "https://www.googleapis.com/auth/admin.directory.userschema.readonly"
- // ]
- // }
-
-}
-
-// method id "directory.schemas.insert":
-
-type SchemasInsertCall struct {
- s *Service
- customerId string
- schema *Schema
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Create schema.
-func (r *SchemasService) Insert(customerId string, schema *Schema) *SchemasInsertCall {
- c := &SchemasInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.customerId = customerId
- c.schema = schema
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SchemasInsertCall) Fields(s ...googleapi.Field) *SchemasInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SchemasInsertCall) Context(ctx context.Context) *SchemasInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SchemasInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.schema)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customerId}/schemas")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customerId": c.customerId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.schemas.insert" call.
-// Exactly one of *Schema or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Schema.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *SchemasInsertCall) Do() (*Schema, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Schema{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Create schema.",
- // "httpMethod": "POST",
- // "id": "directory.schemas.insert",
- // "parameterOrder": [
- // "customerId"
- // ],
- // "parameters": {
- // "customerId": {
- // "description": "Immutable id of the Google Apps account",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customerId}/schemas",
- // "request": {
- // "$ref": "Schema"
- // },
- // "response": {
- // "$ref": "Schema"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.userschema"
- // ]
- // }
-
-}
-
-// method id "directory.schemas.list":
-
-type SchemasListCall struct {
- s *Service
- customerId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieve all schemas for a customer
-func (r *SchemasService) List(customerId string) *SchemasListCall {
- c := &SchemasListCall{s: r.s, opt_: make(map[string]interface{})}
- c.customerId = customerId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SchemasListCall) Fields(s ...googleapi.Field) *SchemasListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SchemasListCall) IfNoneMatch(entityTag string) *SchemasListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SchemasListCall) Context(ctx context.Context) *SchemasListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SchemasListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customerId}/schemas")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customerId": c.customerId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.schemas.list" call.
-// Exactly one of *Schemas or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Schemas.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *SchemasListCall) Do() (*Schemas, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Schemas{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieve all schemas for a customer",
- // "httpMethod": "GET",
- // "id": "directory.schemas.list",
- // "parameterOrder": [
- // "customerId"
- // ],
- // "parameters": {
- // "customerId": {
- // "description": "Immutable id of the Google Apps account",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customerId}/schemas",
- // "response": {
- // "$ref": "Schemas"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.userschema",
- // "https://www.googleapis.com/auth/admin.directory.userschema.readonly"
- // ]
- // }
-
-}
-
-// method id "directory.schemas.patch":
-
-type SchemasPatchCall struct {
- s *Service
- customerId string
- schemaKey string
- schema *Schema
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Update schema. This method supports patch semantics.
-func (r *SchemasService) Patch(customerId string, schemaKey string, schema *Schema) *SchemasPatchCall {
- c := &SchemasPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.customerId = customerId
- c.schemaKey = schemaKey
- c.schema = schema
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SchemasPatchCall) Fields(s ...googleapi.Field) *SchemasPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SchemasPatchCall) Context(ctx context.Context) *SchemasPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SchemasPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.schema)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customerId}/schemas/{schemaKey}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customerId": c.customerId,
- "schemaKey": c.schemaKey,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.schemas.patch" call.
-// Exactly one of *Schema or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Schema.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *SchemasPatchCall) Do() (*Schema, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Schema{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update schema. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "directory.schemas.patch",
- // "parameterOrder": [
- // "customerId",
- // "schemaKey"
- // ],
- // "parameters": {
- // "customerId": {
- // "description": "Immutable id of the Google Apps account",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "schemaKey": {
- // "description": "Name or immutable Id of the schema.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customerId}/schemas/{schemaKey}",
- // "request": {
- // "$ref": "Schema"
- // },
- // "response": {
- // "$ref": "Schema"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.userschema"
- // ]
- // }
-
-}
-
-// method id "directory.schemas.update":
-
-type SchemasUpdateCall struct {
- s *Service
- customerId string
- schemaKey string
- schema *Schema
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Update schema
-func (r *SchemasService) Update(customerId string, schemaKey string, schema *Schema) *SchemasUpdateCall {
- c := &SchemasUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.customerId = customerId
- c.schemaKey = schemaKey
- c.schema = schema
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SchemasUpdateCall) Fields(s ...googleapi.Field) *SchemasUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SchemasUpdateCall) Context(ctx context.Context) *SchemasUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SchemasUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.schema)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "customer/{customerId}/schemas/{schemaKey}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "customerId": c.customerId,
- "schemaKey": c.schemaKey,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.schemas.update" call.
-// Exactly one of *Schema or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Schema.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *SchemasUpdateCall) Do() (*Schema, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Schema{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update schema",
- // "httpMethod": "PUT",
- // "id": "directory.schemas.update",
- // "parameterOrder": [
- // "customerId",
- // "schemaKey"
- // ],
- // "parameters": {
- // "customerId": {
- // "description": "Immutable id of the Google Apps account",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "schemaKey": {
- // "description": "Name or immutable Id of the schema.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "customer/{customerId}/schemas/{schemaKey}",
- // "request": {
- // "$ref": "Schema"
- // },
- // "response": {
- // "$ref": "Schema"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.userschema"
- // ]
- // }
-
-}
-
-// method id "directory.tokens.delete":
-
-type TokensDeleteCall struct {
- s *Service
- userKey string
- clientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Delete all access tokens issued by a user for an application.
-func (r *TokensService) Delete(userKey string, clientId string) *TokensDeleteCall {
- c := &TokensDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.userKey = userKey
- c.clientId = clientId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TokensDeleteCall) Fields(s ...googleapi.Field) *TokensDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TokensDeleteCall) Context(ctx context.Context) *TokensDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TokensDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userKey}/tokens/{clientId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userKey": c.userKey,
- "clientId": c.clientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.tokens.delete" call.
-func (c *TokensDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Delete all access tokens issued by a user for an application.",
- // "httpMethod": "DELETE",
- // "id": "directory.tokens.delete",
- // "parameterOrder": [
- // "userKey",
- // "clientId"
- // ],
- // "parameters": {
- // "clientId": {
- // "description": "The Client ID of the application the token is issued to.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userKey": {
- // "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userKey}/tokens/{clientId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.user.security"
- // ]
- // }
-
-}
-
-// method id "directory.tokens.get":
-
-type TokensGetCall struct {
- s *Service
- userKey string
- clientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get information about an access token issued by a user.
-func (r *TokensService) Get(userKey string, clientId string) *TokensGetCall {
- c := &TokensGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.userKey = userKey
- c.clientId = clientId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TokensGetCall) Fields(s ...googleapi.Field) *TokensGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TokensGetCall) IfNoneMatch(entityTag string) *TokensGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TokensGetCall) Context(ctx context.Context) *TokensGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TokensGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userKey}/tokens/{clientId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userKey": c.userKey,
- "clientId": c.clientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.tokens.get" call.
-// Exactly one of *Token or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Token.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *TokensGetCall) Do() (*Token, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Token{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get information about an access token issued by a user.",
- // "httpMethod": "GET",
- // "id": "directory.tokens.get",
- // "parameterOrder": [
- // "userKey",
- // "clientId"
- // ],
- // "parameters": {
- // "clientId": {
- // "description": "The Client ID of the application the token is issued to.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userKey": {
- // "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userKey}/tokens/{clientId}",
- // "response": {
- // "$ref": "Token"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.user.security"
- // ]
- // }
-
-}
-
-// method id "directory.tokens.list":
-
-type TokensListCall struct {
- s *Service
- userKey string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Returns the set of tokens specified user has issued to 3rd
-// party applications.
-func (r *TokensService) List(userKey string) *TokensListCall {
- c := &TokensListCall{s: r.s, opt_: make(map[string]interface{})}
- c.userKey = userKey
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TokensListCall) Fields(s ...googleapi.Field) *TokensListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TokensListCall) IfNoneMatch(entityTag string) *TokensListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TokensListCall) Context(ctx context.Context) *TokensListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TokensListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userKey}/tokens")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userKey": c.userKey,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.tokens.list" call.
-// Exactly one of *Tokens or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Tokens.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *TokensListCall) Do() (*Tokens, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Tokens{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the set of tokens specified user has issued to 3rd party applications.",
- // "httpMethod": "GET",
- // "id": "directory.tokens.list",
- // "parameterOrder": [
- // "userKey"
- // ],
- // "parameters": {
- // "userKey": {
- // "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userKey}/tokens",
- // "response": {
- // "$ref": "Tokens"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.user.security"
- // ]
- // }
-
-}
-
-// method id "directory.users.delete":
-
-type UsersDeleteCall struct {
- s *Service
- userKey string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Delete user
-func (r *UsersService) Delete(userKey string) *UsersDeleteCall {
- c := &UsersDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.userKey = userKey
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersDeleteCall) Fields(s ...googleapi.Field) *UsersDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersDeleteCall) Context(ctx context.Context) *UsersDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userKey}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userKey": c.userKey,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.users.delete" call.
-func (c *UsersDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Delete user",
- // "httpMethod": "DELETE",
- // "id": "directory.users.delete",
- // "parameterOrder": [
- // "userKey"
- // ],
- // "parameters": {
- // "userKey": {
- // "description": "Email or immutable Id of the user",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userKey}",
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.user"
- // ]
- // }
-
-}
-
-// method id "directory.users.get":
-
-type UsersGetCall struct {
- s *Service
- userKey string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: retrieve user
-func (r *UsersService) Get(userKey string) *UsersGetCall {
- c := &UsersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.userKey = userKey
- return c
-}
-
-// CustomFieldMask sets the optional parameter "customFieldMask":
-// Comma-separated list of schema names. All fields from these schemas
-// are fetched. This should only be set when projection=custom.
-func (c *UsersGetCall) CustomFieldMask(customFieldMask string) *UsersGetCall {
- c.opt_["customFieldMask"] = customFieldMask
- return c
-}
-
-// Projection sets the optional parameter "projection": What subset of
-// fields to fetch for this user.
-//
-// Possible values:
-// "basic" (default) - Do not include any custom fields for the user.
-// "custom" - Include custom fields from schemas mentioned in
-// customFieldMask.
-// "full" - Include all fields associated with this user.
-func (c *UsersGetCall) Projection(projection string) *UsersGetCall {
- c.opt_["projection"] = projection
- return c
-}
-
-// ViewType sets the optional parameter "viewType": Whether to fetch the
-// ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
-//
-// Possible values:
-// "admin_view" (default) - Fetches the ADMIN_VIEW of the user.
-// "domain_public" - Fetches the DOMAIN_PUBLIC view of the user.
-func (c *UsersGetCall) ViewType(viewType string) *UsersGetCall {
- c.opt_["viewType"] = viewType
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersGetCall) Fields(s ...googleapi.Field) *UsersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UsersGetCall) IfNoneMatch(entityTag string) *UsersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersGetCall) Context(ctx context.Context) *UsersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["customFieldMask"]; ok {
- params.Set("customFieldMask", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["projection"]; ok {
- params.Set("projection", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["viewType"]; ok {
- params.Set("viewType", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userKey}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userKey": c.userKey,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.users.get" call.
-// Exactly one of *User or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *User.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *UsersGetCall) Do() (*User, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &User{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "retrieve user",
- // "httpMethod": "GET",
- // "id": "directory.users.get",
- // "parameterOrder": [
- // "userKey"
- // ],
- // "parameters": {
- // "customFieldMask": {
- // "description": "Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.",
- // "location": "query",
- // "type": "string"
- // },
- // "projection": {
- // "default": "basic",
- // "description": "What subset of fields to fetch for this user.",
- // "enum": [
- // "basic",
- // "custom",
- // "full"
- // ],
- // "enumDescriptions": [
- // "Do not include any custom fields for the user.",
- // "Include custom fields from schemas mentioned in customFieldMask.",
- // "Include all fields associated with this user."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "userKey": {
- // "description": "Email or immutable Id of the user",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "viewType": {
- // "default": "admin_view",
- // "description": "Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.",
- // "enum": [
- // "admin_view",
- // "domain_public"
- // ],
- // "enumDescriptions": [
- // "Fetches the ADMIN_VIEW of the user.",
- // "Fetches the DOMAIN_PUBLIC view of the user."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "users/{userKey}",
- // "response": {
- // "$ref": "User"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.user",
- // "https://www.googleapis.com/auth/admin.directory.user.readonly"
- // ]
- // }
-
-}
-
-// method id "directory.users.insert":
-
-type UsersInsertCall struct {
- s *Service
- user *User
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: create user.
-func (r *UsersService) Insert(user *User) *UsersInsertCall {
- c := &UsersInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.user = user
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersInsertCall) Fields(s ...googleapi.Field) *UsersInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersInsertCall) Context(ctx context.Context) *UsersInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.user)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.users.insert" call.
-// Exactly one of *User or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *User.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *UsersInsertCall) Do() (*User, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &User{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "create user.",
- // "httpMethod": "POST",
- // "id": "directory.users.insert",
- // "path": "users",
- // "request": {
- // "$ref": "User"
- // },
- // "response": {
- // "$ref": "User"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.user"
- // ]
- // }
-
-}
-
-// method id "directory.users.list":
-
-type UsersListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieve either deleted users or all users in a domain
-// (paginated)
-func (r *UsersService) List() *UsersListCall {
- c := &UsersListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// CustomFieldMask sets the optional parameter "customFieldMask":
-// Comma-separated list of schema names. All fields from these schemas
-// are fetched. This should only be set when projection=custom.
-func (c *UsersListCall) CustomFieldMask(customFieldMask string) *UsersListCall {
- c.opt_["customFieldMask"] = customFieldMask
- return c
-}
-
-// Customer sets the optional parameter "customer": Immutable id of the
-// Google Apps account. In case of multi-domain, to fetch all users for
-// a customer, fill this field instead of domain.
-func (c *UsersListCall) Customer(customer string) *UsersListCall {
- c.opt_["customer"] = customer
- return c
-}
-
-// Domain sets the optional parameter "domain": Name of the domain. Fill
-// this field to get users from only this domain. To return all users in
-// a multi-domain fill customer field instead.
-func (c *UsersListCall) Domain(domain string) *UsersListCall {
- c.opt_["domain"] = domain
- return c
-}
-
-// Event sets the optional parameter "event": Event on which
-// subscription is intended (if subscribing)
-//
-// Possible values:
-// "add" - User Created Event
-// "delete" - User Deleted Event
-// "makeAdmin" - User Admin Status Change Event
-// "undelete" - User Undeleted Event
-// "update" - User Updated Event
-func (c *UsersListCall) Event(event string) *UsersListCall {
- c.opt_["event"] = event
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return. Default is 100. Max allowed is 500
-func (c *UsersListCall) MaxResults(maxResults int64) *UsersListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Column to use for
-// sorting results
-//
-// Possible values:
-// "email" - Primary email of the user.
-// "familyName" - User's family name.
-// "givenName" - User's given name.
-func (c *UsersListCall) OrderBy(orderBy string) *UsersListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Token to specify
-// next page in the list
-func (c *UsersListCall) PageToken(pageToken string) *UsersListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Projection sets the optional parameter "projection": What subset of
-// fields to fetch for this user.
-//
-// Possible values:
-// "basic" (default) - Do not include any custom fields for the user.
-// "custom" - Include custom fields from schemas mentioned in
-// customFieldMask.
-// "full" - Include all fields associated with this user.
-func (c *UsersListCall) Projection(projection string) *UsersListCall {
- c.opt_["projection"] = projection
- return c
-}
-
-// Query sets the optional parameter "query": Query string search.
-// Should be of the form "". Complete documentation is at
-// https://developers.google.com/admin-sdk/directory/v1/guides/search-users
-func (c *UsersListCall) Query(query string) *UsersListCall {
- c.opt_["query"] = query
- return c
-}
-
-// ShowDeleted sets the optional parameter "showDeleted": If set to true
-// retrieves the list of deleted users. Default is false
-func (c *UsersListCall) ShowDeleted(showDeleted string) *UsersListCall {
- c.opt_["showDeleted"] = showDeleted
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Whether to return
-// results in ascending or descending order.
-//
-// Possible values:
-// "ASCENDING" - Ascending order.
-// "DESCENDING" - Descending order.
-func (c *UsersListCall) SortOrder(sortOrder string) *UsersListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// ViewType sets the optional parameter "viewType": Whether to fetch the
-// ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
-//
-// Possible values:
-// "admin_view" (default) - Fetches the ADMIN_VIEW of the user.
-// "domain_public" - Fetches the DOMAIN_PUBLIC view of the user.
-func (c *UsersListCall) ViewType(viewType string) *UsersListCall {
- c.opt_["viewType"] = viewType
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersListCall) Fields(s ...googleapi.Field) *UsersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UsersListCall) IfNoneMatch(entityTag string) *UsersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersListCall) Context(ctx context.Context) *UsersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["customFieldMask"]; ok {
- params.Set("customFieldMask", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["customer"]; ok {
- params.Set("customer", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["domain"]; ok {
- params.Set("domain", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["event"]; ok {
- params.Set("event", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["projection"]; ok {
- params.Set("projection", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["query"]; ok {
- params.Set("query", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["showDeleted"]; ok {
- params.Set("showDeleted", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["viewType"]; ok {
- params.Set("viewType", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.users.list" call.
-// Exactly one of *Users or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Users.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *UsersListCall) Do() (*Users, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Users{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieve either deleted users or all users in a domain (paginated)",
- // "httpMethod": "GET",
- // "id": "directory.users.list",
- // "parameters": {
- // "customFieldMask": {
- // "description": "Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.",
- // "location": "query",
- // "type": "string"
- // },
- // "customer": {
- // "description": "Immutable id of the Google Apps account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.",
- // "location": "query",
- // "type": "string"
- // },
- // "domain": {
- // "description": "Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.",
- // "location": "query",
- // "type": "string"
- // },
- // "event": {
- // "description": "Event on which subscription is intended (if subscribing)",
- // "enum": [
- // "add",
- // "delete",
- // "makeAdmin",
- // "undelete",
- // "update"
- // ],
- // "enumDescriptions": [
- // "User Created Event",
- // "User Deleted Event",
- // "User Admin Status Change Event",
- // "User Undeleted Event",
- // "User Updated Event"
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return. Default is 100. Max allowed is 500",
- // "format": "int32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Column to use for sorting results",
- // "enum": [
- // "email",
- // "familyName",
- // "givenName"
- // ],
- // "enumDescriptions": [
- // "Primary email of the user.",
- // "User's family name.",
- // "User's given name."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Token to specify next page in the list",
- // "location": "query",
- // "type": "string"
- // },
- // "projection": {
- // "default": "basic",
- // "description": "What subset of fields to fetch for this user.",
- // "enum": [
- // "basic",
- // "custom",
- // "full"
- // ],
- // "enumDescriptions": [
- // "Do not include any custom fields for the user.",
- // "Include custom fields from schemas mentioned in customFieldMask.",
- // "Include all fields associated with this user."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "query": {
- // "description": "Query string search. Should be of the form \"\". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users",
- // "location": "query",
- // "type": "string"
- // },
- // "showDeleted": {
- // "description": "If set to true retrieves the list of deleted users. Default is false",
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Whether to return results in ascending or descending order.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "Ascending order.",
- // "Descending order."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "viewType": {
- // "default": "admin_view",
- // "description": "Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.",
- // "enum": [
- // "admin_view",
- // "domain_public"
- // ],
- // "enumDescriptions": [
- // "Fetches the ADMIN_VIEW of the user.",
- // "Fetches the DOMAIN_PUBLIC view of the user."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "users",
- // "response": {
- // "$ref": "Users"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.user",
- // "https://www.googleapis.com/auth/admin.directory.user.readonly"
- // ],
- // "supportsSubscription": true
- // }
-
-}
-
-// method id "directory.users.makeAdmin":
-
-type UsersMakeAdminCall struct {
- s *Service
- userKey string
- usermakeadmin *UserMakeAdmin
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// MakeAdmin: change admin status of a user
-func (r *UsersService) MakeAdmin(userKey string, usermakeadmin *UserMakeAdmin) *UsersMakeAdminCall {
- c := &UsersMakeAdminCall{s: r.s, opt_: make(map[string]interface{})}
- c.userKey = userKey
- c.usermakeadmin = usermakeadmin
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersMakeAdminCall) Fields(s ...googleapi.Field) *UsersMakeAdminCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersMakeAdminCall) Context(ctx context.Context) *UsersMakeAdminCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersMakeAdminCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.usermakeadmin)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userKey}/makeAdmin")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userKey": c.userKey,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.users.makeAdmin" call.
-func (c *UsersMakeAdminCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "change admin status of a user",
- // "httpMethod": "POST",
- // "id": "directory.users.makeAdmin",
- // "parameterOrder": [
- // "userKey"
- // ],
- // "parameters": {
- // "userKey": {
- // "description": "Email or immutable Id of the user as admin",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userKey}/makeAdmin",
- // "request": {
- // "$ref": "UserMakeAdmin"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.user"
- // ]
- // }
-
-}
-
-// method id "directory.users.patch":
-
-type UsersPatchCall struct {
- s *Service
- userKey string
- user *User
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: update user. This method supports patch semantics.
-func (r *UsersService) Patch(userKey string, user *User) *UsersPatchCall {
- c := &UsersPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.userKey = userKey
- c.user = user
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersPatchCall) Fields(s ...googleapi.Field) *UsersPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersPatchCall) Context(ctx context.Context) *UsersPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.user)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userKey}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userKey": c.userKey,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.users.patch" call.
-// Exactly one of *User or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *User.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *UsersPatchCall) Do() (*User, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &User{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "update user. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "directory.users.patch",
- // "parameterOrder": [
- // "userKey"
- // ],
- // "parameters": {
- // "userKey": {
- // "description": "Email or immutable Id of the user. If Id, it should match with id of user object",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userKey}",
- // "request": {
- // "$ref": "User"
- // },
- // "response": {
- // "$ref": "User"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.user"
- // ]
- // }
-
-}
-
-// method id "directory.users.undelete":
-
-type UsersUndeleteCall struct {
- s *Service
- userKey string
- userundelete *UserUndelete
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Undelete: Undelete a deleted user
-func (r *UsersService) Undelete(userKey string, userundelete *UserUndelete) *UsersUndeleteCall {
- c := &UsersUndeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.userKey = userKey
- c.userundelete = userundelete
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersUndeleteCall) Fields(s ...googleapi.Field) *UsersUndeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersUndeleteCall) Context(ctx context.Context) *UsersUndeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersUndeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.userundelete)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userKey}/undelete")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userKey": c.userKey,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.users.undelete" call.
-func (c *UsersUndeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Undelete a deleted user",
- // "httpMethod": "POST",
- // "id": "directory.users.undelete",
- // "parameterOrder": [
- // "userKey"
- // ],
- // "parameters": {
- // "userKey": {
- // "description": "The immutable id of the user",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userKey}/undelete",
- // "request": {
- // "$ref": "UserUndelete"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.user"
- // ]
- // }
-
-}
-
-// method id "directory.users.update":
-
-type UsersUpdateCall struct {
- s *Service
- userKey string
- user *User
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: update user
-func (r *UsersService) Update(userKey string, user *User) *UsersUpdateCall {
- c := &UsersUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.userKey = userKey
- c.user = user
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersUpdateCall) Fields(s ...googleapi.Field) *UsersUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersUpdateCall) Context(ctx context.Context) *UsersUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.user)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userKey}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userKey": c.userKey,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.users.update" call.
-// Exactly one of *User or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *User.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *UsersUpdateCall) Do() (*User, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &User{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "update user",
- // "httpMethod": "PUT",
- // "id": "directory.users.update",
- // "parameterOrder": [
- // "userKey"
- // ],
- // "parameters": {
- // "userKey": {
- // "description": "Email or immutable Id of the user. If Id, it should match with id of user object",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userKey}",
- // "request": {
- // "$ref": "User"
- // },
- // "response": {
- // "$ref": "User"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.user"
- // ]
- // }
-
-}
-
-// method id "directory.users.watch":
-
-type UsersWatchCall struct {
- s *Service
- channel *Channel
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Watch: Watch for changes in users list
-func (r *UsersService) Watch(channel *Channel) *UsersWatchCall {
- c := &UsersWatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.channel = channel
- return c
-}
-
-// CustomFieldMask sets the optional parameter "customFieldMask":
-// Comma-separated list of schema names. All fields from these schemas
-// are fetched. This should only be set when projection=custom.
-func (c *UsersWatchCall) CustomFieldMask(customFieldMask string) *UsersWatchCall {
- c.opt_["customFieldMask"] = customFieldMask
- return c
-}
-
-// Customer sets the optional parameter "customer": Immutable id of the
-// Google Apps account. In case of multi-domain, to fetch all users for
-// a customer, fill this field instead of domain.
-func (c *UsersWatchCall) Customer(customer string) *UsersWatchCall {
- c.opt_["customer"] = customer
- return c
-}
-
-// Domain sets the optional parameter "domain": Name of the domain. Fill
-// this field to get users from only this domain. To return all users in
-// a multi-domain fill customer field instead.
-func (c *UsersWatchCall) Domain(domain string) *UsersWatchCall {
- c.opt_["domain"] = domain
- return c
-}
-
-// Event sets the optional parameter "event": Event on which
-// subscription is intended (if subscribing)
-//
-// Possible values:
-// "add" - User Created Event
-// "delete" - User Deleted Event
-// "makeAdmin" - User Admin Status Change Event
-// "undelete" - User Undeleted Event
-// "update" - User Updated Event
-func (c *UsersWatchCall) Event(event string) *UsersWatchCall {
- c.opt_["event"] = event
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return. Default is 100. Max allowed is 500
-func (c *UsersWatchCall) MaxResults(maxResults int64) *UsersWatchCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Column to use for
-// sorting results
-//
-// Possible values:
-// "email" - Primary email of the user.
-// "familyName" - User's family name.
-// "givenName" - User's given name.
-func (c *UsersWatchCall) OrderBy(orderBy string) *UsersWatchCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Token to specify
-// next page in the list
-func (c *UsersWatchCall) PageToken(pageToken string) *UsersWatchCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Projection sets the optional parameter "projection": What subset of
-// fields to fetch for this user.
-//
-// Possible values:
-// "basic" (default) - Do not include any custom fields for the user.
-// "custom" - Include custom fields from schemas mentioned in
-// customFieldMask.
-// "full" - Include all fields associated with this user.
-func (c *UsersWatchCall) Projection(projection string) *UsersWatchCall {
- c.opt_["projection"] = projection
- return c
-}
-
-// Query sets the optional parameter "query": Query string search.
-// Should be of the form "". Complete documentation is at
-// https://developers.google.com/admin-sdk/directory/v1/guides/search-users
-func (c *UsersWatchCall) Query(query string) *UsersWatchCall {
- c.opt_["query"] = query
- return c
-}
-
-// ShowDeleted sets the optional parameter "showDeleted": If set to true
-// retrieves the list of deleted users. Default is false
-func (c *UsersWatchCall) ShowDeleted(showDeleted string) *UsersWatchCall {
- c.opt_["showDeleted"] = showDeleted
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Whether to return
-// results in ascending or descending order.
-//
-// Possible values:
-// "ASCENDING" - Ascending order.
-// "DESCENDING" - Descending order.
-func (c *UsersWatchCall) SortOrder(sortOrder string) *UsersWatchCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// ViewType sets the optional parameter "viewType": Whether to fetch the
-// ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
-//
-// Possible values:
-// "admin_view" (default) - Fetches the ADMIN_VIEW of the user.
-// "domain_public" - Fetches the DOMAIN_PUBLIC view of the user.
-func (c *UsersWatchCall) ViewType(viewType string) *UsersWatchCall {
- c.opt_["viewType"] = viewType
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersWatchCall) Fields(s ...googleapi.Field) *UsersWatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersWatchCall) Context(ctx context.Context) *UsersWatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersWatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.channel)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["customFieldMask"]; ok {
- params.Set("customFieldMask", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["customer"]; ok {
- params.Set("customer", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["domain"]; ok {
- params.Set("domain", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["event"]; ok {
- params.Set("event", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["projection"]; ok {
- params.Set("projection", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["query"]; ok {
- params.Set("query", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["showDeleted"]; ok {
- params.Set("showDeleted", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["viewType"]; ok {
- params.Set("viewType", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/watch")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.users.watch" call.
-// Exactly one of *Channel or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Channel.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *UsersWatchCall) Do() (*Channel, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Channel{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Watch for changes in users list",
- // "httpMethod": "POST",
- // "id": "directory.users.watch",
- // "parameters": {
- // "customFieldMask": {
- // "description": "Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.",
- // "location": "query",
- // "type": "string"
- // },
- // "customer": {
- // "description": "Immutable id of the Google Apps account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.",
- // "location": "query",
- // "type": "string"
- // },
- // "domain": {
- // "description": "Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.",
- // "location": "query",
- // "type": "string"
- // },
- // "event": {
- // "description": "Event on which subscription is intended (if subscribing)",
- // "enum": [
- // "add",
- // "delete",
- // "makeAdmin",
- // "undelete",
- // "update"
- // ],
- // "enumDescriptions": [
- // "User Created Event",
- // "User Deleted Event",
- // "User Admin Status Change Event",
- // "User Undeleted Event",
- // "User Updated Event"
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return. Default is 100. Max allowed is 500",
- // "format": "int32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Column to use for sorting results",
- // "enum": [
- // "email",
- // "familyName",
- // "givenName"
- // ],
- // "enumDescriptions": [
- // "Primary email of the user.",
- // "User's family name.",
- // "User's given name."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Token to specify next page in the list",
- // "location": "query",
- // "type": "string"
- // },
- // "projection": {
- // "default": "basic",
- // "description": "What subset of fields to fetch for this user.",
- // "enum": [
- // "basic",
- // "custom",
- // "full"
- // ],
- // "enumDescriptions": [
- // "Do not include any custom fields for the user.",
- // "Include custom fields from schemas mentioned in customFieldMask.",
- // "Include all fields associated with this user."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "query": {
- // "description": "Query string search. Should be of the form \"\". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users",
- // "location": "query",
- // "type": "string"
- // },
- // "showDeleted": {
- // "description": "If set to true retrieves the list of deleted users. Default is false",
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Whether to return results in ascending or descending order.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "Ascending order.",
- // "Descending order."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "viewType": {
- // "default": "admin_view",
- // "description": "Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.",
- // "enum": [
- // "admin_view",
- // "domain_public"
- // ],
- // "enumDescriptions": [
- // "Fetches the ADMIN_VIEW of the user.",
- // "Fetches the DOMAIN_PUBLIC view of the user."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "users/watch",
- // "request": {
- // "$ref": "Channel",
- // "parameterName": "resource"
- // },
- // "response": {
- // "$ref": "Channel"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.user",
- // "https://www.googleapis.com/auth/admin.directory.user.readonly"
- // ],
- // "supportsSubscription": true
- // }
-
-}
-
-// method id "directory.users.aliases.delete":
-
-type UsersAliasesDeleteCall struct {
- s *Service
- userKey string
- alias string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Remove a alias for the user
-func (r *UsersAliasesService) Delete(userKey string, alias string) *UsersAliasesDeleteCall {
- c := &UsersAliasesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.userKey = userKey
- c.alias = alias
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersAliasesDeleteCall) Fields(s ...googleapi.Field) *UsersAliasesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersAliasesDeleteCall) Context(ctx context.Context) *UsersAliasesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersAliasesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userKey}/aliases/{alias}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userKey": c.userKey,
- "alias": c.alias,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.users.aliases.delete" call.
-func (c *UsersAliasesDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Remove a alias for the user",
- // "httpMethod": "DELETE",
- // "id": "directory.users.aliases.delete",
- // "parameterOrder": [
- // "userKey",
- // "alias"
- // ],
- // "parameters": {
- // "alias": {
- // "description": "The alias to be removed",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userKey": {
- // "description": "Email or immutable Id of the user",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userKey}/aliases/{alias}",
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.user",
- // "https://www.googleapis.com/auth/admin.directory.user.alias"
- // ]
- // }
-
-}
-
-// method id "directory.users.aliases.insert":
-
-type UsersAliasesInsertCall struct {
- s *Service
- userKey string
- alias *Alias
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Add a alias for the user
-func (r *UsersAliasesService) Insert(userKey string, alias *Alias) *UsersAliasesInsertCall {
- c := &UsersAliasesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.userKey = userKey
- c.alias = alias
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersAliasesInsertCall) Fields(s ...googleapi.Field) *UsersAliasesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersAliasesInsertCall) Context(ctx context.Context) *UsersAliasesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersAliasesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.alias)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userKey}/aliases")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userKey": c.userKey,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.users.aliases.insert" call.
-// Exactly one of *Alias or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Alias.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *UsersAliasesInsertCall) Do() (*Alias, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Alias{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Add a alias for the user",
- // "httpMethod": "POST",
- // "id": "directory.users.aliases.insert",
- // "parameterOrder": [
- // "userKey"
- // ],
- // "parameters": {
- // "userKey": {
- // "description": "Email or immutable Id of the user",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userKey}/aliases",
- // "request": {
- // "$ref": "Alias"
- // },
- // "response": {
- // "$ref": "Alias"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.user",
- // "https://www.googleapis.com/auth/admin.directory.user.alias"
- // ]
- // }
-
-}
-
-// method id "directory.users.aliases.list":
-
-type UsersAliasesListCall struct {
- s *Service
- userKey string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all aliases for a user
-func (r *UsersAliasesService) List(userKey string) *UsersAliasesListCall {
- c := &UsersAliasesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.userKey = userKey
- return c
-}
-
-// Event sets the optional parameter "event": Event on which
-// subscription is intended (if subscribing)
-//
-// Possible values:
-// "add" - Alias Created Event
-// "delete" - Alias Deleted Event
-func (c *UsersAliasesListCall) Event(event string) *UsersAliasesListCall {
- c.opt_["event"] = event
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersAliasesListCall) Fields(s ...googleapi.Field) *UsersAliasesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UsersAliasesListCall) IfNoneMatch(entityTag string) *UsersAliasesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersAliasesListCall) Context(ctx context.Context) *UsersAliasesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersAliasesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["event"]; ok {
- params.Set("event", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userKey}/aliases")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userKey": c.userKey,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.users.aliases.list" call.
-// Exactly one of *Aliases or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Aliases.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *UsersAliasesListCall) Do() (*Aliases, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Aliases{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all aliases for a user",
- // "httpMethod": "GET",
- // "id": "directory.users.aliases.list",
- // "parameterOrder": [
- // "userKey"
- // ],
- // "parameters": {
- // "event": {
- // "description": "Event on which subscription is intended (if subscribing)",
- // "enum": [
- // "add",
- // "delete"
- // ],
- // "enumDescriptions": [
- // "Alias Created Event",
- // "Alias Deleted Event"
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "userKey": {
- // "description": "Email or immutable Id of the user",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userKey}/aliases",
- // "response": {
- // "$ref": "Aliases"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.user",
- // "https://www.googleapis.com/auth/admin.directory.user.alias",
- // "https://www.googleapis.com/auth/admin.directory.user.alias.readonly",
- // "https://www.googleapis.com/auth/admin.directory.user.readonly"
- // ],
- // "supportsSubscription": true
- // }
-
-}
-
-// method id "directory.users.aliases.watch":
-
-type UsersAliasesWatchCall struct {
- s *Service
- userKey string
- channel *Channel
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Watch: Watch for changes in user aliases list
-func (r *UsersAliasesService) Watch(userKey string, channel *Channel) *UsersAliasesWatchCall {
- c := &UsersAliasesWatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.userKey = userKey
- c.channel = channel
- return c
-}
-
-// Event sets the optional parameter "event": Event on which
-// subscription is intended (if subscribing)
-//
-// Possible values:
-// "add" - Alias Created Event
-// "delete" - Alias Deleted Event
-func (c *UsersAliasesWatchCall) Event(event string) *UsersAliasesWatchCall {
- c.opt_["event"] = event
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersAliasesWatchCall) Fields(s ...googleapi.Field) *UsersAliasesWatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersAliasesWatchCall) Context(ctx context.Context) *UsersAliasesWatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersAliasesWatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.channel)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["event"]; ok {
- params.Set("event", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userKey}/aliases/watch")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userKey": c.userKey,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.users.aliases.watch" call.
-// Exactly one of *Channel or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Channel.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *UsersAliasesWatchCall) Do() (*Channel, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Channel{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Watch for changes in user aliases list",
- // "httpMethod": "POST",
- // "id": "directory.users.aliases.watch",
- // "parameterOrder": [
- // "userKey"
- // ],
- // "parameters": {
- // "event": {
- // "description": "Event on which subscription is intended (if subscribing)",
- // "enum": [
- // "add",
- // "delete"
- // ],
- // "enumDescriptions": [
- // "Alias Created Event",
- // "Alias Deleted Event"
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "userKey": {
- // "description": "Email or immutable Id of the user",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userKey}/aliases/watch",
- // "request": {
- // "$ref": "Channel",
- // "parameterName": "resource"
- // },
- // "response": {
- // "$ref": "Channel"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.user",
- // "https://www.googleapis.com/auth/admin.directory.user.alias",
- // "https://www.googleapis.com/auth/admin.directory.user.alias.readonly",
- // "https://www.googleapis.com/auth/admin.directory.user.readonly"
- // ],
- // "supportsSubscription": true
- // }
-
-}
-
-// method id "directory.users.photos.delete":
-
-type UsersPhotosDeleteCall struct {
- s *Service
- userKey string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Remove photos for the user
-func (r *UsersPhotosService) Delete(userKey string) *UsersPhotosDeleteCall {
- c := &UsersPhotosDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.userKey = userKey
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersPhotosDeleteCall) Fields(s ...googleapi.Field) *UsersPhotosDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersPhotosDeleteCall) Context(ctx context.Context) *UsersPhotosDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersPhotosDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userKey}/photos/thumbnail")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userKey": c.userKey,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.users.photos.delete" call.
-func (c *UsersPhotosDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Remove photos for the user",
- // "httpMethod": "DELETE",
- // "id": "directory.users.photos.delete",
- // "parameterOrder": [
- // "userKey"
- // ],
- // "parameters": {
- // "userKey": {
- // "description": "Email or immutable Id of the user",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userKey}/photos/thumbnail",
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.user"
- // ]
- // }
-
-}
-
-// method id "directory.users.photos.get":
-
-type UsersPhotosGetCall struct {
- s *Service
- userKey string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieve photo of a user
-func (r *UsersPhotosService) Get(userKey string) *UsersPhotosGetCall {
- c := &UsersPhotosGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.userKey = userKey
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersPhotosGetCall) Fields(s ...googleapi.Field) *UsersPhotosGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UsersPhotosGetCall) IfNoneMatch(entityTag string) *UsersPhotosGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersPhotosGetCall) Context(ctx context.Context) *UsersPhotosGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersPhotosGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userKey}/photos/thumbnail")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userKey": c.userKey,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.users.photos.get" call.
-// Exactly one of *UserPhoto or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UserPhoto.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UsersPhotosGetCall) Do() (*UserPhoto, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserPhoto{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieve photo of a user",
- // "httpMethod": "GET",
- // "id": "directory.users.photos.get",
- // "parameterOrder": [
- // "userKey"
- // ],
- // "parameters": {
- // "userKey": {
- // "description": "Email or immutable Id of the user",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userKey}/photos/thumbnail",
- // "response": {
- // "$ref": "UserPhoto"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.user",
- // "https://www.googleapis.com/auth/admin.directory.user.readonly"
- // ]
- // }
-
-}
-
-// method id "directory.users.photos.patch":
-
-type UsersPhotosPatchCall struct {
- s *Service
- userKey string
- userphoto *UserPhoto
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Add a photo for the user. This method supports patch
-// semantics.
-func (r *UsersPhotosService) Patch(userKey string, userphoto *UserPhoto) *UsersPhotosPatchCall {
- c := &UsersPhotosPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.userKey = userKey
- c.userphoto = userphoto
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersPhotosPatchCall) Fields(s ...googleapi.Field) *UsersPhotosPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersPhotosPatchCall) Context(ctx context.Context) *UsersPhotosPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersPhotosPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.userphoto)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userKey}/photos/thumbnail")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userKey": c.userKey,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.users.photos.patch" call.
-// Exactly one of *UserPhoto or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UserPhoto.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UsersPhotosPatchCall) Do() (*UserPhoto, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserPhoto{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Add a photo for the user. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "directory.users.photos.patch",
- // "parameterOrder": [
- // "userKey"
- // ],
- // "parameters": {
- // "userKey": {
- // "description": "Email or immutable Id of the user",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userKey}/photos/thumbnail",
- // "request": {
- // "$ref": "UserPhoto"
- // },
- // "response": {
- // "$ref": "UserPhoto"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.user"
- // ]
- // }
-
-}
-
-// method id "directory.users.photos.update":
-
-type UsersPhotosUpdateCall struct {
- s *Service
- userKey string
- userphoto *UserPhoto
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Add a photo for the user
-func (r *UsersPhotosService) Update(userKey string, userphoto *UserPhoto) *UsersPhotosUpdateCall {
- c := &UsersPhotosUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.userKey = userKey
- c.userphoto = userphoto
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersPhotosUpdateCall) Fields(s ...googleapi.Field) *UsersPhotosUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersPhotosUpdateCall) Context(ctx context.Context) *UsersPhotosUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersPhotosUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.userphoto)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userKey}/photos/thumbnail")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userKey": c.userKey,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.users.photos.update" call.
-// Exactly one of *UserPhoto or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UserPhoto.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UsersPhotosUpdateCall) Do() (*UserPhoto, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserPhoto{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Add a photo for the user",
- // "httpMethod": "PUT",
- // "id": "directory.users.photos.update",
- // "parameterOrder": [
- // "userKey"
- // ],
- // "parameters": {
- // "userKey": {
- // "description": "Email or immutable Id of the user",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userKey}/photos/thumbnail",
- // "request": {
- // "$ref": "UserPhoto"
- // },
- // "response": {
- // "$ref": "UserPhoto"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.user"
- // ]
- // }
-
-}
-
-// method id "directory.verificationCodes.generate":
-
-type VerificationCodesGenerateCall struct {
- s *Service
- userKey string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Generate: Generate new backup verification codes for the user.
-func (r *VerificationCodesService) Generate(userKey string) *VerificationCodesGenerateCall {
- c := &VerificationCodesGenerateCall{s: r.s, opt_: make(map[string]interface{})}
- c.userKey = userKey
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *VerificationCodesGenerateCall) Fields(s ...googleapi.Field) *VerificationCodesGenerateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *VerificationCodesGenerateCall) Context(ctx context.Context) *VerificationCodesGenerateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *VerificationCodesGenerateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userKey}/verificationCodes/generate")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userKey": c.userKey,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.verificationCodes.generate" call.
-func (c *VerificationCodesGenerateCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Generate new backup verification codes for the user.",
- // "httpMethod": "POST",
- // "id": "directory.verificationCodes.generate",
- // "parameterOrder": [
- // "userKey"
- // ],
- // "parameters": {
- // "userKey": {
- // "description": "Email or immutable Id of the user",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userKey}/verificationCodes/generate",
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.user.security"
- // ]
- // }
-
-}
-
-// method id "directory.verificationCodes.invalidate":
-
-type VerificationCodesInvalidateCall struct {
- s *Service
- userKey string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Invalidate: Invalidate the current backup verification codes for the
-// user.
-func (r *VerificationCodesService) Invalidate(userKey string) *VerificationCodesInvalidateCall {
- c := &VerificationCodesInvalidateCall{s: r.s, opt_: make(map[string]interface{})}
- c.userKey = userKey
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *VerificationCodesInvalidateCall) Fields(s ...googleapi.Field) *VerificationCodesInvalidateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *VerificationCodesInvalidateCall) Context(ctx context.Context) *VerificationCodesInvalidateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *VerificationCodesInvalidateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userKey}/verificationCodes/invalidate")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userKey": c.userKey,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.verificationCodes.invalidate" call.
-func (c *VerificationCodesInvalidateCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Invalidate the current backup verification codes for the user.",
- // "httpMethod": "POST",
- // "id": "directory.verificationCodes.invalidate",
- // "parameterOrder": [
- // "userKey"
- // ],
- // "parameters": {
- // "userKey": {
- // "description": "Email or immutable Id of the user",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userKey}/verificationCodes/invalidate",
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.user.security"
- // ]
- // }
-
-}
-
-// method id "directory.verificationCodes.list":
-
-type VerificationCodesListCall struct {
- s *Service
- userKey string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Returns the current set of valid backup verification codes for
-// the specified user.
-func (r *VerificationCodesService) List(userKey string) *VerificationCodesListCall {
- c := &VerificationCodesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.userKey = userKey
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *VerificationCodesListCall) Fields(s ...googleapi.Field) *VerificationCodesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *VerificationCodesListCall) IfNoneMatch(entityTag string) *VerificationCodesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *VerificationCodesListCall) Context(ctx context.Context) *VerificationCodesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *VerificationCodesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userKey}/verificationCodes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userKey": c.userKey,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "directory.verificationCodes.list" call.
-// Exactly one of *VerificationCodes or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *VerificationCodes.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *VerificationCodesListCall) Do() (*VerificationCodes, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &VerificationCodes{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the current set of valid backup verification codes for the specified user.",
- // "httpMethod": "GET",
- // "id": "directory.verificationCodes.list",
- // "parameterOrder": [
- // "userKey"
- // ],
- // "parameters": {
- // "userKey": {
- // "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userKey}/verificationCodes",
- // "response": {
- // "$ref": "VerificationCodes"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.directory.user.security"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/admin/email_migration/v2/admin-api.json b/vendor/google.golang.org/api/admin/email_migration/v2/admin-api.json
deleted file mode 100644
index a52012ca..00000000
--- a/vendor/google.golang.org/api/admin/email_migration/v2/admin-api.json
+++ /dev/null
@@ -1,173 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/_VRzIG5q4_x1FzCCxocLHIuiUhw\"",
- "discoveryVersion": "v1",
- "id": "admin:email_migration_v2",
- "name": "admin",
- "version": "email_migration_v2",
- "revision": "20150303",
- "title": "Email Migration API v2",
- "description": "Email Migration API lets you migrate emails of users to Google backends.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/googlemail-16.png",
- "x32": "https://www.google.com/images/icons/product/googlemail-32.png"
- },
- "documentationLink": "https://developers.google.com/admin-sdk/email-migration/v2/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/email/v2/users/",
- "basePath": "/email/v2/users/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "email/v2/users/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/email.migration": {
- "description": "Manage email messages of users on your domain"
- }
- }
- }
- },
- "schemas": {
- "MailItem": {
- "id": "MailItem",
- "type": "object",
- "description": "JSON template for MailItem object in Email Migration API.",
- "properties": {
- "isDeleted": {
- "type": "boolean",
- "description": "Boolean indicating if the mail is deleted (used in Vault)"
- },
- "isDraft": {
- "type": "boolean",
- "description": "Boolean indicating if the mail is draft"
- },
- "isInbox": {
- "type": "boolean",
- "description": "Boolean indicating if the mail is in inbox"
- },
- "isSent": {
- "type": "boolean",
- "description": "Boolean indicating if the mail is in 'sent mails'"
- },
- "isStarred": {
- "type": "boolean",
- "description": "Boolean indicating if the mail is starred"
- },
- "isTrash": {
- "type": "boolean",
- "description": "Boolean indicating if the mail is in trash"
- },
- "isUnread": {
- "type": "boolean",
- "description": "Boolean indicating if the mail is unread"
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "mailItem"
- },
- "labels": {
- "type": "array",
- "description": "List of labels (strings)",
- "items": {
- "type": "string"
- }
- }
- }
- }
- },
- "resources": {
- "mail": {
- "methods": {
- "insert": {
- "id": "emailMigration.mail.insert",
- "path": "{userKey}/mail",
- "httpMethod": "POST",
- "description": "Insert Mail into Google's Gmail backends",
- "parameters": {
- "userKey": {
- "type": "string",
- "description": "The email or immutable id of the user",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey"
- ],
- "request": {
- "$ref": "MailItem"
- },
- "scopes": [
- "https://www.googleapis.com/auth/email.migration"
- ],
- "supportsMediaUpload": true,
- "mediaUpload": {
- "accept": [
- "message/rfc822"
- ],
- "maxSize": "35MB",
- "protocols": {
- "simple": {
- "multipart": true,
- "path": "/upload/email/v2/users/{userKey}/mail"
- },
- "resumable": {
- "multipart": true,
- "path": "/resumable/upload/email/v2/users/{userKey}/mail"
- }
- }
- }
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/admin/email_migration/v2/admin-gen.go b/vendor/google.golang.org/api/admin/email_migration/v2/admin-gen.go
deleted file mode 100644
index 00df426b..00000000
--- a/vendor/google.golang.org/api/admin/email_migration/v2/admin-gen.go
+++ /dev/null
@@ -1,321 +0,0 @@
-// Package admin provides access to the Email Migration API v2.
-//
-// See https://developers.google.com/admin-sdk/email-migration/v2/
-//
-// Usage example:
-//
-// import "google.golang.org/api/admin/email_migration/v2"
-// ...
-// adminService, err := admin.New(oauthHttpClient)
-package admin // import "google.golang.org/api/admin/email_migration/v2"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "admin:email_migration_v2"
-const apiName = "admin"
-const apiVersion = "email_migration_v2"
-const basePath = "https://www.googleapis.com/email/v2/users/"
-
-// OAuth2 scopes used by this API.
-const (
- // Manage email messages of users on your domain
- EmailMigrationScope = "https://www.googleapis.com/auth/email.migration"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Mail = NewMailService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Mail *MailService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewMailService(s *Service) *MailService {
- rs := &MailService{s: s}
- return rs
-}
-
-type MailService struct {
- s *Service
-}
-
-// MailItem: JSON template for MailItem object in Email Migration API.
-type MailItem struct {
- // IsDeleted: Boolean indicating if the mail is deleted (used in Vault)
- IsDeleted bool `json:"isDeleted,omitempty"`
-
- // IsDraft: Boolean indicating if the mail is draft
- IsDraft bool `json:"isDraft,omitempty"`
-
- // IsInbox: Boolean indicating if the mail is in inbox
- IsInbox bool `json:"isInbox,omitempty"`
-
- // IsSent: Boolean indicating if the mail is in 'sent mails'
- IsSent bool `json:"isSent,omitempty"`
-
- // IsStarred: Boolean indicating if the mail is starred
- IsStarred bool `json:"isStarred,omitempty"`
-
- // IsTrash: Boolean indicating if the mail is in trash
- IsTrash bool `json:"isTrash,omitempty"`
-
- // IsUnread: Boolean indicating if the mail is unread
- IsUnread bool `json:"isUnread,omitempty"`
-
- // Kind: Kind of resource this is.
- Kind string `json:"kind,omitempty"`
-
- // Labels: List of labels (strings)
- Labels []string `json:"labels,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "IsDeleted") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MailItem) MarshalJSON() ([]byte, error) {
- type noMethod MailItem
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "emailMigration.mail.insert":
-
-type MailInsertCall struct {
- s *Service
- userKey string
- mailitem *MailItem
- opt_ map[string]interface{}
- media_ io.Reader
- resumable_ googleapi.SizeReaderAt
- mediaType_ string
- protocol_ string
- ctx_ context.Context
-}
-
-// Insert: Insert Mail into Google's Gmail backends
-func (r *MailService) Insert(userKey string, mailitem *MailItem) *MailInsertCall {
- c := &MailInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.userKey = userKey
- c.mailitem = mailitem
- return c
-}
-
-// Media specifies the media to upload in a single chunk.
-// At most one of Media and ResumableMedia may be set.
-func (c *MailInsertCall) Media(r io.Reader) *MailInsertCall {
- c.media_ = r
- c.protocol_ = "multipart"
- return c
-}
-
-// ResumableMedia specifies the media to upload in chunks and can be canceled with ctx.
-// At most one of Media and ResumableMedia may be set.
-// mediaType identifies the MIME media type of the upload, such as "image/png".
-// If mediaType is "", it will be auto-detected.
-// The provided ctx will supersede any context previously provided to
-// the Context method.
-func (c *MailInsertCall) ResumableMedia(ctx context.Context, r io.ReaderAt, size int64, mediaType string) *MailInsertCall {
- c.ctx_ = ctx
- c.resumable_ = io.NewSectionReader(r, 0, size)
- c.mediaType_ = mediaType
- c.protocol_ = "resumable"
- return c
-}
-
-// ProgressUpdater provides a callback function that will be called after every chunk.
-// It should be a low-latency function in order to not slow down the upload operation.
-// This should only be called when using ResumableMedia (as opposed to Media).
-func (c *MailInsertCall) ProgressUpdater(pu googleapi.ProgressUpdater) *MailInsertCall {
- c.opt_["progressUpdater"] = pu
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MailInsertCall) Fields(s ...googleapi.Field) *MailInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-// This context will supersede any context previously provided to
-// the ResumableMedia method.
-func (c *MailInsertCall) Context(ctx context.Context) *MailInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MailInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.mailitem)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{userKey}/mail")
- if c.media_ != nil || c.resumable_ != nil {
- urls = strings.Replace(urls, "https://www.googleapis.com/", "https://www.googleapis.com/upload/", 1)
- params.Set("uploadType", c.protocol_)
- }
- urls += "?" + params.Encode()
- if c.protocol_ != "resumable" {
- var cancel func()
- cancel, _ = googleapi.ConditionallyIncludeMedia(c.media_, &body, &ctype)
- if cancel != nil {
- defer cancel()
- }
- }
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userKey": c.userKey,
- })
- if c.protocol_ == "resumable" {
- if c.mediaType_ == "" {
- c.mediaType_ = googleapi.DetectMediaType(c.resumable_)
- }
- req.Header.Set("X-Upload-Content-Type", c.mediaType_)
- req.Header.Set("Content-Type", "application/json; charset=utf-8")
- } else {
- req.Header.Set("Content-Type", ctype)
- }
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "emailMigration.mail.insert" call.
-func (c *MailInsertCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- var progressUpdater_ googleapi.ProgressUpdater
- if v, ok := c.opt_["progressUpdater"]; ok {
- if pu, ok := v.(googleapi.ProgressUpdater); ok {
- progressUpdater_ = pu
- }
- }
- if c.protocol_ == "resumable" {
- loc := res.Header.Get("Location")
- rx := &googleapi.ResumableUpload{
- Client: c.s.client,
- UserAgent: c.s.userAgent(),
- URI: loc,
- Media: c.resumable_,
- MediaType: c.mediaType_,
- ContentLength: c.resumable_.Size(),
- Callback: progressUpdater_,
- }
- res, err = rx.Upload(c.ctx_)
- if err != nil {
- return err
- }
- defer res.Body.Close()
- }
- return nil
- // {
- // "description": "Insert Mail into Google's Gmail backends",
- // "httpMethod": "POST",
- // "id": "emailMigration.mail.insert",
- // "mediaUpload": {
- // "accept": [
- // "message/rfc822"
- // ],
- // "maxSize": "35MB",
- // "protocols": {
- // "resumable": {
- // "multipart": true,
- // "path": "/resumable/upload/email/v2/users/{userKey}/mail"
- // },
- // "simple": {
- // "multipart": true,
- // "path": "/upload/email/v2/users/{userKey}/mail"
- // }
- // }
- // },
- // "parameterOrder": [
- // "userKey"
- // ],
- // "parameters": {
- // "userKey": {
- // "description": "The email or immutable id of the user",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{userKey}/mail",
- // "request": {
- // "$ref": "MailItem"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/email.migration"
- // ],
- // "supportsMediaUpload": true
- // }
-
-}
diff --git a/vendor/google.golang.org/api/admin/reports/v1/admin-api.json b/vendor/google.golang.org/api/admin/reports/v1/admin-api.json
deleted file mode 100644
index a0358be8..00000000
--- a/vendor/google.golang.org/api/admin/reports/v1/admin-api.json
+++ /dev/null
@@ -1,744 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/lycAHH8x-Ct6oDsJmcDO1AWwIZ4\"",
- "discoveryVersion": "v1",
- "id": "admin:reports_v1",
- "name": "admin",
- "canonicalName": "reports",
- "version": "reports_v1",
- "revision": "20150907",
- "title": "Admin Reports API",
- "description": "Allows the administrators of Google Apps customers to fetch reports about the usage, collaboration, security and risk for their users.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "packagePath": "admin",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/admin-sdk/reports/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/admin/reports/v1/",
- "basePath": "/admin/reports/v1/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "admin/reports/v1/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/admin.reports.audit.readonly": {
- "description": "View audit reports of Google Apps for your domain"
- },
- "https://www.googleapis.com/auth/admin.reports.usage.readonly": {
- "description": "View usage reports of Google Apps for your domain"
- }
- }
- }
- },
- "schemas": {
- "Activities": {
- "id": "Activities",
- "type": "object",
- "description": "JSON template for a collection of activites.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "items": {
- "type": "array",
- "description": "Each record in read response.",
- "items": {
- "$ref": "Activity"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list response this is.",
- "default": "admin#reports#activities"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token for retrieving the next page"
- }
- }
- },
- "Activity": {
- "id": "Activity",
- "type": "object",
- "description": "JSON template for the activity resource.",
- "properties": {
- "actor": {
- "type": "object",
- "description": "User doing the action.",
- "properties": {
- "callerType": {
- "type": "string",
- "description": "User or OAuth 2LO request."
- },
- "email": {
- "type": "string",
- "description": "Email address of the user."
- },
- "key": {
- "type": "string",
- "description": "For OAuth 2LO API requests, consumer_key of the requestor."
- },
- "profileId": {
- "type": "string",
- "description": "Obfuscated user id of the user."
- }
- }
- },
- "etag": {
- "type": "string",
- "description": "ETag of the entry."
- },
- "events": {
- "type": "array",
- "description": "Activity events.",
- "items": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "Name of event."
- },
- "parameters": {
- "type": "array",
- "description": "Parameter value pairs for various applications.",
- "items": {
- "type": "object",
- "properties": {
- "boolValue": {
- "type": "boolean",
- "description": "Boolean value of the parameter."
- },
- "intValue": {
- "type": "string",
- "description": "Integral value of the parameter.",
- "format": "int64"
- },
- "multiIntValue": {
- "type": "array",
- "description": "Multi-int value of the parameter.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "multiValue": {
- "type": "array",
- "description": "Multi-string value of the parameter.",
- "items": {
- "type": "string"
- }
- },
- "name": {
- "type": "string",
- "description": "The name of the parameter."
- },
- "value": {
- "type": "string",
- "description": "String value of the parameter."
- }
- }
- }
- },
- "type": {
- "type": "string",
- "description": "Type of event."
- }
- }
- }
- },
- "id": {
- "type": "object",
- "description": "Unique identifier for each activity record.",
- "properties": {
- "applicationName": {
- "type": "string",
- "description": "Application name to which the event belongs."
- },
- "customerId": {
- "type": "string",
- "description": "Obfuscated customer ID of the source customer."
- },
- "time": {
- "type": "string",
- "description": "Time of occurrence of the activity.",
- "format": "date-time"
- },
- "uniqueQualifier": {
- "type": "string",
- "description": "Unique qualifier if multiple events have the same time.",
- "format": "int64"
- }
- }
- },
- "ipAddress": {
- "type": "string",
- "description": "IP Address of the user doing the action."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is.",
- "default": "admin#reports#activity"
- },
- "ownerDomain": {
- "type": "string",
- "description": "Domain of source customer."
- }
- }
- },
- "Channel": {
- "id": "Channel",
- "type": "object",
- "description": "An notification channel used to watch for resource changes.",
- "properties": {
- "address": {
- "type": "string",
- "description": "The address where notifications are delivered for this channel."
- },
- "expiration": {
- "type": "string",
- "description": "Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "A UUID or similar unique string that identifies this channel."
- },
- "kind": {
- "type": "string",
- "description": "Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string \"api#channel\".",
- "default": "api#channel"
- },
- "params": {
- "type": "object",
- "description": "Additional parameters controlling delivery channel behavior. Optional.",
- "additionalProperties": {
- "type": "string",
- "description": "Declares a new parameter by name."
- }
- },
- "payload": {
- "type": "boolean",
- "description": "A Boolean value to indicate whether payload is wanted. Optional."
- },
- "resourceId": {
- "type": "string",
- "description": "An opaque ID that identifies the resource being watched on this channel. Stable across different API versions."
- },
- "resourceUri": {
- "type": "string",
- "description": "A version-specific identifier for the watched resource."
- },
- "token": {
- "type": "string",
- "description": "An arbitrary string delivered to the target address with each notification delivered over this channel. Optional."
- },
- "type": {
- "type": "string",
- "description": "The type of delivery mechanism used for this channel."
- }
- }
- },
- "UsageReport": {
- "id": "UsageReport",
- "type": "object",
- "description": "JSON template for a usage report.",
- "properties": {
- "date": {
- "type": "string",
- "description": "The date to which the record belongs.",
- "readOnly": true
- },
- "entity": {
- "type": "object",
- "description": "Information about the type of the item.",
- "readOnly": true,
- "properties": {
- "customerId": {
- "type": "string",
- "description": "Obfuscated customer id for the record.",
- "readOnly": true
- },
- "profileId": {
- "type": "string",
- "description": "Obfuscated user id for the record.",
- "readOnly": true
- },
- "type": {
- "type": "string",
- "description": "The type of item, can be a customer or user.",
- "readOnly": true
- },
- "userEmail": {
- "type": "string",
- "description": "user's email.",
- "readOnly": true
- }
- }
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "The kind of object.",
- "default": "admin#reports#usageReport"
- },
- "parameters": {
- "type": "array",
- "description": "Parameter value pairs for various applications.",
- "readOnly": true,
- "items": {
- "type": "object",
- "properties": {
- "boolValue": {
- "type": "boolean",
- "description": "Boolean value of the parameter.",
- "readOnly": true
- },
- "datetimeValue": {
- "type": "string",
- "description": "RFC 3339 formatted value of the parameter.",
- "format": "date-time",
- "readOnly": true
- },
- "intValue": {
- "type": "string",
- "description": "Integral value of the parameter.",
- "format": "int64",
- "readOnly": true
- },
- "msgValue": {
- "type": "array",
- "description": "Nested message value of the parameter.",
- "readOnly": true,
- "items": {
- "type": "object",
- "additionalProperties": {
- "type": "any"
- }
- }
- },
- "name": {
- "type": "string",
- "description": "The name of the parameter."
- },
- "stringValue": {
- "type": "string",
- "description": "String value of the parameter.",
- "readOnly": true
- }
- }
- }
- }
- }
- },
- "UsageReports": {
- "id": "UsageReports",
- "type": "object",
- "description": "JSON template for a collection of usage reports.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "kind": {
- "type": "string",
- "description": "The kind of object.",
- "default": "admin#reports#usageReports"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token for retrieving the next page"
- },
- "usageReports": {
- "type": "array",
- "description": "Various application parameter records.",
- "items": {
- "$ref": "UsageReport"
- }
- },
- "warnings": {
- "type": "array",
- "description": "Warnings if any.",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "Machine readable code / warning type."
- },
- "data": {
- "type": "array",
- "description": "Key-Value pairs to give detailed information on the warning.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "Key associated with a key-value pair to give detailed information on the warning."
- },
- "value": {
- "type": "string",
- "description": "Value associated with a key-value pair to give detailed information on the warning."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "Human readable message for the warning."
- }
- }
- }
- }
- }
- }
- },
- "resources": {
- "activities": {
- "methods": {
- "list": {
- "id": "reports.activities.list",
- "path": "activity/users/{userKey}/applications/{applicationName}",
- "httpMethod": "GET",
- "description": "Retrieves a list of activities for a specific customer and application.",
- "parameters": {
- "actorIpAddress": {
- "type": "string",
- "description": "IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.",
- "location": "query"
- },
- "applicationName": {
- "type": "string",
- "description": "Application name for which the events are to be retrieved.",
- "required": true,
- "pattern": "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)",
- "location": "path"
- },
- "customerId": {
- "type": "string",
- "description": "Represents the customer for which the data is to be fetched.",
- "pattern": "C.+",
- "location": "query"
- },
- "endTime": {
- "type": "string",
- "description": "Return events which occured at or before this time.",
- "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
- "location": "query"
- },
- "eventName": {
- "type": "string",
- "description": "Name of the event being queried.",
- "location": "query"
- },
- "filters": {
- "type": "string",
- "description": "Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...",
- "pattern": "(.+[\u003c,\u003c=,==,\u003e=,\u003e,\u003c\u003e].+,)*(.+[\u003c,\u003c=,==,\u003e=,\u003e,\u003c\u003e].+)",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Number of activity records to be shown in each page.",
- "format": "int32",
- "minimum": "1",
- "maximum": "1000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify next page.",
- "location": "query"
- },
- "startTime": {
- "type": "string",
- "description": "Return events which occured at or after this time.",
- "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
- "location": "query"
- },
- "userKey": {
- "type": "string",
- "description": "Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey",
- "applicationName"
- ],
- "response": {
- "$ref": "Activities"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.reports.audit.readonly"
- ],
- "supportsSubscription": true
- },
- "watch": {
- "id": "reports.activities.watch",
- "path": "activity/users/{userKey}/applications/{applicationName}/watch",
- "httpMethod": "POST",
- "description": "Push changes to activities",
- "parameters": {
- "actorIpAddress": {
- "type": "string",
- "description": "IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.",
- "location": "query"
- },
- "applicationName": {
- "type": "string",
- "description": "Application name for which the events are to be retrieved.",
- "required": true,
- "pattern": "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)",
- "location": "path"
- },
- "customerId": {
- "type": "string",
- "description": "Represents the customer for which the data is to be fetched.",
- "pattern": "C.+",
- "location": "query"
- },
- "endTime": {
- "type": "string",
- "description": "Return events which occured at or before this time.",
- "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
- "location": "query"
- },
- "eventName": {
- "type": "string",
- "description": "Name of the event being queried.",
- "location": "query"
- },
- "filters": {
- "type": "string",
- "description": "Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...",
- "pattern": "(.+[\u003c,\u003c=,==,\u003e=,\u003e,\u003c\u003e].+,)*(.+[\u003c,\u003c=,==,\u003e=,\u003e,\u003c\u003e].+)",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Number of activity records to be shown in each page.",
- "format": "int32",
- "minimum": "1",
- "maximum": "1000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify next page.",
- "location": "query"
- },
- "startTime": {
- "type": "string",
- "description": "Return events which occured at or after this time.",
- "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
- "location": "query"
- },
- "userKey": {
- "type": "string",
- "description": "Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey",
- "applicationName"
- ],
- "request": {
- "$ref": "Channel",
- "parameterName": "resource"
- },
- "response": {
- "$ref": "Channel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.reports.audit.readonly"
- ],
- "supportsSubscription": true
- }
- }
- },
- "channels": {
- "methods": {
- "stop": {
- "id": "admin.channels.stop",
- "path": "/admin/reports_v1/channels/stop",
- "httpMethod": "POST",
- "description": "Stop watching resources through this channel",
- "request": {
- "$ref": "Channel",
- "parameterName": "resource"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.reports.audit.readonly"
- ]
- }
- }
- },
- "customerUsageReports": {
- "methods": {
- "get": {
- "id": "reports.customerUsageReports.get",
- "path": "usage/dates/{date}",
- "httpMethod": "GET",
- "description": "Retrieves a report which is a collection of properties / statistics for a specific customer.",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Represents the customer for which the data is to be fetched.",
- "pattern": "C.+",
- "location": "query"
- },
- "date": {
- "type": "string",
- "description": "Represents the date in yyyy-mm-dd format for which the data is to be fetched.",
- "required": true,
- "pattern": "(\\d){4}-(\\d){2}-(\\d){2}",
- "location": "path"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify next page.",
- "location": "query"
- },
- "parameters": {
- "type": "string",
- "description": "Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.",
- "pattern": "(((accounts)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)):.+,)*(((accounts)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)):.+)",
- "location": "query"
- }
- },
- "parameterOrder": [
- "date"
- ],
- "response": {
- "$ref": "UsageReports"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.reports.usage.readonly"
- ]
- }
- }
- },
- "userUsageReport": {
- "methods": {
- "get": {
- "id": "reports.userUsageReport.get",
- "path": "usage/users/{userKey}/dates/{date}",
- "httpMethod": "GET",
- "description": "Retrieves a report which is a collection of properties / statistics for a set of users.",
- "parameters": {
- "customerId": {
- "type": "string",
- "description": "Represents the customer for which the data is to be fetched.",
- "pattern": "C.+",
- "location": "query"
- },
- "date": {
- "type": "string",
- "description": "Represents the date in yyyy-mm-dd format for which the data is to be fetched.",
- "required": true,
- "pattern": "(\\d){4}-(\\d){2}-(\\d){2}",
- "location": "path"
- },
- "filters": {
- "type": "string",
- "description": "Represents the set of filters including parameter operator value.",
- "pattern": "(((accounts)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)):.+[\u003c,\u003c=,==,\u003e=,\u003e,!=].+,)*(((accounts)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)):.+[\u003c,\u003c=,==,\u003e=,\u003e,!=].+)",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return. Maximum allowed is 1000",
- "format": "uint32",
- "maximum": "1000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token to specify next page.",
- "location": "query"
- },
- "parameters": {
- "type": "string",
- "description": "Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.",
- "pattern": "(((accounts)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)):.+,)*(((accounts)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)):.+)",
- "location": "query"
- },
- "userKey": {
- "type": "string",
- "description": "Represents the profile id or the user email for which the data should be filtered.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userKey",
- "date"
- ],
- "response": {
- "$ref": "UsageReports"
- },
- "scopes": [
- "https://www.googleapis.com/auth/admin.reports.usage.readonly"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/admin/reports/v1/admin-gen.go b/vendor/google.golang.org/api/admin/reports/v1/admin-gen.go
deleted file mode 100644
index 3ed847b1..00000000
--- a/vendor/google.golang.org/api/admin/reports/v1/admin-gen.go
+++ /dev/null
@@ -1,1565 +0,0 @@
-// Package admin provides access to the Admin Reports API.
-//
-// See https://developers.google.com/admin-sdk/reports/
-//
-// Usage example:
-//
-// import "google.golang.org/api/admin/reports/v1"
-// ...
-// adminService, err := admin.New(oauthHttpClient)
-package admin // import "google.golang.org/api/admin/reports/v1"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "admin:reports_v1"
-const apiName = "admin"
-const apiVersion = "reports_v1"
-const basePath = "https://www.googleapis.com/admin/reports/v1/"
-
-// OAuth2 scopes used by this API.
-const (
- // View audit reports of Google Apps for your domain
- AdminReportsAuditReadonlyScope = "https://www.googleapis.com/auth/admin.reports.audit.readonly"
-
- // View usage reports of Google Apps for your domain
- AdminReportsUsageReadonlyScope = "https://www.googleapis.com/auth/admin.reports.usage.readonly"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Activities = NewActivitiesService(s)
- s.Channels = NewChannelsService(s)
- s.CustomerUsageReports = NewCustomerUsageReportsService(s)
- s.UserUsageReport = NewUserUsageReportService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Activities *ActivitiesService
-
- Channels *ChannelsService
-
- CustomerUsageReports *CustomerUsageReportsService
-
- UserUsageReport *UserUsageReportService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewActivitiesService(s *Service) *ActivitiesService {
- rs := &ActivitiesService{s: s}
- return rs
-}
-
-type ActivitiesService struct {
- s *Service
-}
-
-func NewChannelsService(s *Service) *ChannelsService {
- rs := &ChannelsService{s: s}
- return rs
-}
-
-type ChannelsService struct {
- s *Service
-}
-
-func NewCustomerUsageReportsService(s *Service) *CustomerUsageReportsService {
- rs := &CustomerUsageReportsService{s: s}
- return rs
-}
-
-type CustomerUsageReportsService struct {
- s *Service
-}
-
-func NewUserUsageReportService(s *Service) *UserUsageReportService {
- rs := &UserUsageReportService{s: s}
- return rs
-}
-
-type UserUsageReportService struct {
- s *Service
-}
-
-// Activities: JSON template for a collection of activites.
-type Activities struct {
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Items: Each record in read response.
- Items []*Activity `json:"items,omitempty"`
-
- // Kind: Kind of list response this is.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Token for retrieving the next page
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Activities) MarshalJSON() ([]byte, error) {
- type noMethod Activities
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Activity: JSON template for the activity resource.
-type Activity struct {
- // Actor: User doing the action.
- Actor *ActivityActor `json:"actor,omitempty"`
-
- // Etag: ETag of the entry.
- Etag string `json:"etag,omitempty"`
-
- // Events: Activity events.
- Events []*ActivityEvents `json:"events,omitempty"`
-
- // Id: Unique identifier for each activity record.
- Id *ActivityId `json:"id,omitempty"`
-
- // IpAddress: IP Address of the user doing the action.
- IpAddress string `json:"ipAddress,omitempty"`
-
- // Kind: Kind of resource this is.
- Kind string `json:"kind,omitempty"`
-
- // OwnerDomain: Domain of source customer.
- OwnerDomain string `json:"ownerDomain,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Actor") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Activity) MarshalJSON() ([]byte, error) {
- type noMethod Activity
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ActivityActor: User doing the action.
-type ActivityActor struct {
- // CallerType: User or OAuth 2LO request.
- CallerType string `json:"callerType,omitempty"`
-
- // Email: Email address of the user.
- Email string `json:"email,omitempty"`
-
- // Key: For OAuth 2LO API requests, consumer_key of the requestor.
- Key string `json:"key,omitempty"`
-
- // ProfileId: Obfuscated user id of the user.
- ProfileId string `json:"profileId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CallerType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ActivityActor) MarshalJSON() ([]byte, error) {
- type noMethod ActivityActor
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ActivityEvents struct {
- // Name: Name of event.
- Name string `json:"name,omitempty"`
-
- // Parameters: Parameter value pairs for various applications.
- Parameters []*ActivityEventsParameters `json:"parameters,omitempty"`
-
- // Type: Type of event.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Name") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ActivityEvents) MarshalJSON() ([]byte, error) {
- type noMethod ActivityEvents
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ActivityEventsParameters struct {
- // BoolValue: Boolean value of the parameter.
- BoolValue bool `json:"boolValue,omitempty"`
-
- // IntValue: Integral value of the parameter.
- IntValue int64 `json:"intValue,omitempty,string"`
-
- // MultiIntValue: Multi-int value of the parameter.
- MultiIntValue googleapi.Int64s `json:"multiIntValue,omitempty"`
-
- // MultiValue: Multi-string value of the parameter.
- MultiValue []string `json:"multiValue,omitempty"`
-
- // Name: The name of the parameter.
- Name string `json:"name,omitempty"`
-
- // Value: String value of the parameter.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BoolValue") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ActivityEventsParameters) MarshalJSON() ([]byte, error) {
- type noMethod ActivityEventsParameters
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ActivityId: Unique identifier for each activity record.
-type ActivityId struct {
- // ApplicationName: Application name to which the event belongs.
- ApplicationName string `json:"applicationName,omitempty"`
-
- // CustomerId: Obfuscated customer ID of the source customer.
- CustomerId string `json:"customerId,omitempty"`
-
- // Time: Time of occurrence of the activity.
- Time string `json:"time,omitempty"`
-
- // UniqueQualifier: Unique qualifier if multiple events have the same
- // time.
- UniqueQualifier int64 `json:"uniqueQualifier,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "ApplicationName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ActivityId) MarshalJSON() ([]byte, error) {
- type noMethod ActivityId
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Channel: An notification channel used to watch for resource changes.
-type Channel struct {
- // Address: The address where notifications are delivered for this
- // channel.
- Address string `json:"address,omitempty"`
-
- // Expiration: Date and time of notification channel expiration,
- // expressed as a Unix timestamp, in milliseconds. Optional.
- Expiration int64 `json:"expiration,omitempty,string"`
-
- // Id: A UUID or similar unique string that identifies this channel.
- Id string `json:"id,omitempty"`
-
- // Kind: Identifies this as a notification channel used to watch for
- // changes to a resource. Value: the fixed string "api#channel".
- Kind string `json:"kind,omitempty"`
-
- // Params: Additional parameters controlling delivery channel behavior.
- // Optional.
- Params map[string]string `json:"params,omitempty"`
-
- // Payload: A Boolean value to indicate whether payload is wanted.
- // Optional.
- Payload bool `json:"payload,omitempty"`
-
- // ResourceId: An opaque ID that identifies the resource being watched
- // on this channel. Stable across different API versions.
- ResourceId string `json:"resourceId,omitempty"`
-
- // ResourceUri: A version-specific identifier for the watched resource.
- ResourceUri string `json:"resourceUri,omitempty"`
-
- // Token: An arbitrary string delivered to the target address with each
- // notification delivered over this channel. Optional.
- Token string `json:"token,omitempty"`
-
- // Type: The type of delivery mechanism used for this channel.
- Type string `json:"type,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Address") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Channel) MarshalJSON() ([]byte, error) {
- type noMethod Channel
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UsageReport: JSON template for a usage report.
-type UsageReport struct {
- // Date: The date to which the record belongs.
- Date string `json:"date,omitempty"`
-
- // Entity: Information about the type of the item.
- Entity *UsageReportEntity `json:"entity,omitempty"`
-
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Kind: The kind of object.
- Kind string `json:"kind,omitempty"`
-
- // Parameters: Parameter value pairs for various applications.
- Parameters []*UsageReportParameters `json:"parameters,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Date") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UsageReport) MarshalJSON() ([]byte, error) {
- type noMethod UsageReport
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UsageReportEntity: Information about the type of the item.
-type UsageReportEntity struct {
- // CustomerId: Obfuscated customer id for the record.
- CustomerId string `json:"customerId,omitempty"`
-
- // ProfileId: Obfuscated user id for the record.
- ProfileId string `json:"profileId,omitempty"`
-
- // Type: The type of item, can be a customer or user.
- Type string `json:"type,omitempty"`
-
- // UserEmail: user's email.
- UserEmail string `json:"userEmail,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CustomerId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UsageReportEntity) MarshalJSON() ([]byte, error) {
- type noMethod UsageReportEntity
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UsageReportParameters struct {
- // BoolValue: Boolean value of the parameter.
- BoolValue bool `json:"boolValue,omitempty"`
-
- // DatetimeValue: RFC 3339 formatted value of the parameter.
- DatetimeValue string `json:"datetimeValue,omitempty"`
-
- // IntValue: Integral value of the parameter.
- IntValue int64 `json:"intValue,omitempty,string"`
-
- // MsgValue: Nested message value of the parameter.
- MsgValue []UsageReportParametersMsgValue `json:"msgValue,omitempty"`
-
- // Name: The name of the parameter.
- Name string `json:"name,omitempty"`
-
- // StringValue: String value of the parameter.
- StringValue string `json:"stringValue,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BoolValue") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UsageReportParameters) MarshalJSON() ([]byte, error) {
- type noMethod UsageReportParameters
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UsageReportParametersMsgValue interface{}
-
-// UsageReports: JSON template for a collection of usage reports.
-type UsageReports struct {
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Kind: The kind of object.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Token for retrieving the next page
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // UsageReports: Various application parameter records.
- UsageReports []*UsageReport `json:"usageReports,omitempty"`
-
- // Warnings: Warnings if any.
- Warnings []*UsageReportsWarnings `json:"warnings,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UsageReports) MarshalJSON() ([]byte, error) {
- type noMethod UsageReports
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UsageReportsWarnings struct {
- // Code: Machine readable code / warning type.
- Code string `json:"code,omitempty"`
-
- // Data: Key-Value pairs to give detailed information on the warning.
- Data []*UsageReportsWarningsData `json:"data,omitempty"`
-
- // Message: Human readable message for the warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UsageReportsWarnings) MarshalJSON() ([]byte, error) {
- type noMethod UsageReportsWarnings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UsageReportsWarningsData struct {
- // Key: Key associated with a key-value pair to give detailed
- // information on the warning.
- Key string `json:"key,omitempty"`
-
- // Value: Value associated with a key-value pair to give detailed
- // information on the warning.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UsageReportsWarningsData) MarshalJSON() ([]byte, error) {
- type noMethod UsageReportsWarningsData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "reports.activities.list":
-
-type ActivitiesListCall struct {
- s *Service
- userKey string
- applicationName string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of activities for a specific customer and
-// application.
-func (r *ActivitiesService) List(userKey string, applicationName string) *ActivitiesListCall {
- c := &ActivitiesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.userKey = userKey
- c.applicationName = applicationName
- return c
-}
-
-// ActorIpAddress sets the optional parameter "actorIpAddress": IP
-// Address of host where the event was performed. Supports both IPv4 and
-// IPv6 addresses.
-func (c *ActivitiesListCall) ActorIpAddress(actorIpAddress string) *ActivitiesListCall {
- c.opt_["actorIpAddress"] = actorIpAddress
- return c
-}
-
-// CustomerId sets the optional parameter "customerId": Represents the
-// customer for which the data is to be fetched.
-func (c *ActivitiesListCall) CustomerId(customerId string) *ActivitiesListCall {
- c.opt_["customerId"] = customerId
- return c
-}
-
-// EndTime sets the optional parameter "endTime": Return events which
-// occured at or before this time.
-func (c *ActivitiesListCall) EndTime(endTime string) *ActivitiesListCall {
- c.opt_["endTime"] = endTime
- return c
-}
-
-// EventName sets the optional parameter "eventName": Name of the event
-// being queried.
-func (c *ActivitiesListCall) EventName(eventName string) *ActivitiesListCall {
- c.opt_["eventName"] = eventName
- return c
-}
-
-// Filters sets the optional parameter "filters": Event parameters in
-// the form [parameter1 name][operator][parameter1 value],[parameter2
-// name][operator][parameter2 value],...
-func (c *ActivitiesListCall) Filters(filters string) *ActivitiesListCall {
- c.opt_["filters"] = filters
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Number of
-// activity records to be shown in each page.
-func (c *ActivitiesListCall) MaxResults(maxResults int64) *ActivitiesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Token to specify
-// next page.
-func (c *ActivitiesListCall) PageToken(pageToken string) *ActivitiesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// StartTime sets the optional parameter "startTime": Return events
-// which occured at or after this time.
-func (c *ActivitiesListCall) StartTime(startTime string) *ActivitiesListCall {
- c.opt_["startTime"] = startTime
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ActivitiesListCall) Fields(s ...googleapi.Field) *ActivitiesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ActivitiesListCall) IfNoneMatch(entityTag string) *ActivitiesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ActivitiesListCall) Context(ctx context.Context) *ActivitiesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ActivitiesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["actorIpAddress"]; ok {
- params.Set("actorIpAddress", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["customerId"]; ok {
- params.Set("customerId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["endTime"]; ok {
- params.Set("endTime", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["eventName"]; ok {
- params.Set("eventName", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["filters"]; ok {
- params.Set("filters", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startTime"]; ok {
- params.Set("startTime", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "activity/users/{userKey}/applications/{applicationName}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userKey": c.userKey,
- "applicationName": c.applicationName,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "reports.activities.list" call.
-// Exactly one of *Activities or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Activities.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ActivitiesListCall) Do() (*Activities, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Activities{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of activities for a specific customer and application.",
- // "httpMethod": "GET",
- // "id": "reports.activities.list",
- // "parameterOrder": [
- // "userKey",
- // "applicationName"
- // ],
- // "parameters": {
- // "actorIpAddress": {
- // "description": "IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.",
- // "location": "query",
- // "type": "string"
- // },
- // "applicationName": {
- // "description": "Application name for which the events are to be retrieved.",
- // "location": "path",
- // "pattern": "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)",
- // "required": true,
- // "type": "string"
- // },
- // "customerId": {
- // "description": "Represents the customer for which the data is to be fetched.",
- // "location": "query",
- // "pattern": "C.+",
- // "type": "string"
- // },
- // "endTime": {
- // "description": "Return events which occured at or before this time.",
- // "location": "query",
- // "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
- // "type": "string"
- // },
- // "eventName": {
- // "description": "Name of the event being queried.",
- // "location": "query",
- // "type": "string"
- // },
- // "filters": {
- // "description": "Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...",
- // "location": "query",
- // "pattern": "(.+[\u003c,\u003c=,==,\u003e=,\u003e,\u003c\u003e].+,)*(.+[\u003c,\u003c=,==,\u003e=,\u003e,\u003c\u003e].+)",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Number of activity records to be shown in each page.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "1000",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Token to specify next page.",
- // "location": "query",
- // "type": "string"
- // },
- // "startTime": {
- // "description": "Return events which occured at or after this time.",
- // "location": "query",
- // "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
- // "type": "string"
- // },
- // "userKey": {
- // "description": "Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "activity/users/{userKey}/applications/{applicationName}",
- // "response": {
- // "$ref": "Activities"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.reports.audit.readonly"
- // ],
- // "supportsSubscription": true
- // }
-
-}
-
-// method id "reports.activities.watch":
-
-type ActivitiesWatchCall struct {
- s *Service
- userKey string
- applicationName string
- channel *Channel
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Watch: Push changes to activities
-func (r *ActivitiesService) Watch(userKey string, applicationName string, channel *Channel) *ActivitiesWatchCall {
- c := &ActivitiesWatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.userKey = userKey
- c.applicationName = applicationName
- c.channel = channel
- return c
-}
-
-// ActorIpAddress sets the optional parameter "actorIpAddress": IP
-// Address of host where the event was performed. Supports both IPv4 and
-// IPv6 addresses.
-func (c *ActivitiesWatchCall) ActorIpAddress(actorIpAddress string) *ActivitiesWatchCall {
- c.opt_["actorIpAddress"] = actorIpAddress
- return c
-}
-
-// CustomerId sets the optional parameter "customerId": Represents the
-// customer for which the data is to be fetched.
-func (c *ActivitiesWatchCall) CustomerId(customerId string) *ActivitiesWatchCall {
- c.opt_["customerId"] = customerId
- return c
-}
-
-// EndTime sets the optional parameter "endTime": Return events which
-// occured at or before this time.
-func (c *ActivitiesWatchCall) EndTime(endTime string) *ActivitiesWatchCall {
- c.opt_["endTime"] = endTime
- return c
-}
-
-// EventName sets the optional parameter "eventName": Name of the event
-// being queried.
-func (c *ActivitiesWatchCall) EventName(eventName string) *ActivitiesWatchCall {
- c.opt_["eventName"] = eventName
- return c
-}
-
-// Filters sets the optional parameter "filters": Event parameters in
-// the form [parameter1 name][operator][parameter1 value],[parameter2
-// name][operator][parameter2 value],...
-func (c *ActivitiesWatchCall) Filters(filters string) *ActivitiesWatchCall {
- c.opt_["filters"] = filters
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Number of
-// activity records to be shown in each page.
-func (c *ActivitiesWatchCall) MaxResults(maxResults int64) *ActivitiesWatchCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Token to specify
-// next page.
-func (c *ActivitiesWatchCall) PageToken(pageToken string) *ActivitiesWatchCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// StartTime sets the optional parameter "startTime": Return events
-// which occured at or after this time.
-func (c *ActivitiesWatchCall) StartTime(startTime string) *ActivitiesWatchCall {
- c.opt_["startTime"] = startTime
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ActivitiesWatchCall) Fields(s ...googleapi.Field) *ActivitiesWatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ActivitiesWatchCall) Context(ctx context.Context) *ActivitiesWatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ActivitiesWatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.channel)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["actorIpAddress"]; ok {
- params.Set("actorIpAddress", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["customerId"]; ok {
- params.Set("customerId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["endTime"]; ok {
- params.Set("endTime", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["eventName"]; ok {
- params.Set("eventName", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["filters"]; ok {
- params.Set("filters", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startTime"]; ok {
- params.Set("startTime", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "activity/users/{userKey}/applications/{applicationName}/watch")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userKey": c.userKey,
- "applicationName": c.applicationName,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "reports.activities.watch" call.
-// Exactly one of *Channel or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Channel.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ActivitiesWatchCall) Do() (*Channel, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Channel{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Push changes to activities",
- // "httpMethod": "POST",
- // "id": "reports.activities.watch",
- // "parameterOrder": [
- // "userKey",
- // "applicationName"
- // ],
- // "parameters": {
- // "actorIpAddress": {
- // "description": "IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.",
- // "location": "query",
- // "type": "string"
- // },
- // "applicationName": {
- // "description": "Application name for which the events are to be retrieved.",
- // "location": "path",
- // "pattern": "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)",
- // "required": true,
- // "type": "string"
- // },
- // "customerId": {
- // "description": "Represents the customer for which the data is to be fetched.",
- // "location": "query",
- // "pattern": "C.+",
- // "type": "string"
- // },
- // "endTime": {
- // "description": "Return events which occured at or before this time.",
- // "location": "query",
- // "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
- // "type": "string"
- // },
- // "eventName": {
- // "description": "Name of the event being queried.",
- // "location": "query",
- // "type": "string"
- // },
- // "filters": {
- // "description": "Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...",
- // "location": "query",
- // "pattern": "(.+[\u003c,\u003c=,==,\u003e=,\u003e,\u003c\u003e].+,)*(.+[\u003c,\u003c=,==,\u003e=,\u003e,\u003c\u003e].+)",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Number of activity records to be shown in each page.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "1000",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Token to specify next page.",
- // "location": "query",
- // "type": "string"
- // },
- // "startTime": {
- // "description": "Return events which occured at or after this time.",
- // "location": "query",
- // "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
- // "type": "string"
- // },
- // "userKey": {
- // "description": "Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "activity/users/{userKey}/applications/{applicationName}/watch",
- // "request": {
- // "$ref": "Channel",
- // "parameterName": "resource"
- // },
- // "response": {
- // "$ref": "Channel"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.reports.audit.readonly"
- // ],
- // "supportsSubscription": true
- // }
-
-}
-
-// method id "admin.channels.stop":
-
-type ChannelsStopCall struct {
- s *Service
- channel *Channel
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Stop: Stop watching resources through this channel
-func (r *ChannelsService) Stop(channel *Channel) *ChannelsStopCall {
- c := &ChannelsStopCall{s: r.s, opt_: make(map[string]interface{})}
- c.channel = channel
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ChannelsStopCall) Fields(s ...googleapi.Field) *ChannelsStopCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ChannelsStopCall) Context(ctx context.Context) *ChannelsStopCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ChannelsStopCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.channel)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "/admin/reports_v1/channels/stop")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "admin.channels.stop" call.
-func (c *ChannelsStopCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Stop watching resources through this channel",
- // "httpMethod": "POST",
- // "id": "admin.channels.stop",
- // "path": "/admin/reports_v1/channels/stop",
- // "request": {
- // "$ref": "Channel",
- // "parameterName": "resource"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.reports.audit.readonly"
- // ]
- // }
-
-}
-
-// method id "reports.customerUsageReports.get":
-
-type CustomerUsageReportsGetCall struct {
- s *Service
- date string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves a report which is a collection of properties /
-// statistics for a specific customer.
-func (r *CustomerUsageReportsService) Get(date string) *CustomerUsageReportsGetCall {
- c := &CustomerUsageReportsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.date = date
- return c
-}
-
-// CustomerId sets the optional parameter "customerId": Represents the
-// customer for which the data is to be fetched.
-func (c *CustomerUsageReportsGetCall) CustomerId(customerId string) *CustomerUsageReportsGetCall {
- c.opt_["customerId"] = customerId
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Token to specify
-// next page.
-func (c *CustomerUsageReportsGetCall) PageToken(pageToken string) *CustomerUsageReportsGetCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Parameters sets the optional parameter "parameters": Represents the
-// application name, parameter name pairs to fetch in csv as
-// app_name1:param_name1, app_name2:param_name2.
-func (c *CustomerUsageReportsGetCall) Parameters(parameters string) *CustomerUsageReportsGetCall {
- c.opt_["parameters"] = parameters
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CustomerUsageReportsGetCall) Fields(s ...googleapi.Field) *CustomerUsageReportsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CustomerUsageReportsGetCall) IfNoneMatch(entityTag string) *CustomerUsageReportsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CustomerUsageReportsGetCall) Context(ctx context.Context) *CustomerUsageReportsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CustomerUsageReportsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["customerId"]; ok {
- params.Set("customerId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["parameters"]; ok {
- params.Set("parameters", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "usage/dates/{date}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "date": c.date,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "reports.customerUsageReports.get" call.
-// Exactly one of *UsageReports or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UsageReports.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CustomerUsageReportsGetCall) Do() (*UsageReports, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UsageReports{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a report which is a collection of properties / statistics for a specific customer.",
- // "httpMethod": "GET",
- // "id": "reports.customerUsageReports.get",
- // "parameterOrder": [
- // "date"
- // ],
- // "parameters": {
- // "customerId": {
- // "description": "Represents the customer for which the data is to be fetched.",
- // "location": "query",
- // "pattern": "C.+",
- // "type": "string"
- // },
- // "date": {
- // "description": "Represents the date in yyyy-mm-dd format for which the data is to be fetched.",
- // "location": "path",
- // "pattern": "(\\d){4}-(\\d){2}-(\\d){2}",
- // "required": true,
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Token to specify next page.",
- // "location": "query",
- // "type": "string"
- // },
- // "parameters": {
- // "description": "Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.",
- // "location": "query",
- // "pattern": "(((accounts)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)):.+,)*(((accounts)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)):.+)",
- // "type": "string"
- // }
- // },
- // "path": "usage/dates/{date}",
- // "response": {
- // "$ref": "UsageReports"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.reports.usage.readonly"
- // ]
- // }
-
-}
-
-// method id "reports.userUsageReport.get":
-
-type UserUsageReportGetCall struct {
- s *Service
- userKey string
- date string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves a report which is a collection of properties /
-// statistics for a set of users.
-func (r *UserUsageReportService) Get(userKey string, date string) *UserUsageReportGetCall {
- c := &UserUsageReportGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.userKey = userKey
- c.date = date
- return c
-}
-
-// CustomerId sets the optional parameter "customerId": Represents the
-// customer for which the data is to be fetched.
-func (c *UserUsageReportGetCall) CustomerId(customerId string) *UserUsageReportGetCall {
- c.opt_["customerId"] = customerId
- return c
-}
-
-// Filters sets the optional parameter "filters": Represents the set of
-// filters including parameter operator value.
-func (c *UserUsageReportGetCall) Filters(filters string) *UserUsageReportGetCall {
- c.opt_["filters"] = filters
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return. Maximum allowed is 1000
-func (c *UserUsageReportGetCall) MaxResults(maxResults int64) *UserUsageReportGetCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Token to specify
-// next page.
-func (c *UserUsageReportGetCall) PageToken(pageToken string) *UserUsageReportGetCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Parameters sets the optional parameter "parameters": Represents the
-// application name, parameter name pairs to fetch in csv as
-// app_name1:param_name1, app_name2:param_name2.
-func (c *UserUsageReportGetCall) Parameters(parameters string) *UserUsageReportGetCall {
- c.opt_["parameters"] = parameters
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserUsageReportGetCall) Fields(s ...googleapi.Field) *UserUsageReportGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UserUsageReportGetCall) IfNoneMatch(entityTag string) *UserUsageReportGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserUsageReportGetCall) Context(ctx context.Context) *UserUsageReportGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserUsageReportGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["customerId"]; ok {
- params.Set("customerId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["filters"]; ok {
- params.Set("filters", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["parameters"]; ok {
- params.Set("parameters", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "usage/users/{userKey}/dates/{date}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userKey": c.userKey,
- "date": c.date,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "reports.userUsageReport.get" call.
-// Exactly one of *UsageReports or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UsageReports.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UserUsageReportGetCall) Do() (*UsageReports, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UsageReports{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a report which is a collection of properties / statistics for a set of users.",
- // "httpMethod": "GET",
- // "id": "reports.userUsageReport.get",
- // "parameterOrder": [
- // "userKey",
- // "date"
- // ],
- // "parameters": {
- // "customerId": {
- // "description": "Represents the customer for which the data is to be fetched.",
- // "location": "query",
- // "pattern": "C.+",
- // "type": "string"
- // },
- // "date": {
- // "description": "Represents the date in yyyy-mm-dd format for which the data is to be fetched.",
- // "location": "path",
- // "pattern": "(\\d){4}-(\\d){2}-(\\d){2}",
- // "required": true,
- // "type": "string"
- // },
- // "filters": {
- // "description": "Represents the set of filters including parameter operator value.",
- // "location": "query",
- // "pattern": "(((accounts)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)):.+[\u003c,\u003c=,==,\u003e=,\u003e,!=].+,)*(((accounts)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)):.+[\u003c,\u003c=,==,\u003e=,\u003e,!=].+)",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return. Maximum allowed is 1000",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "1000",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Token to specify next page.",
- // "location": "query",
- // "type": "string"
- // },
- // "parameters": {
- // "description": "Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.",
- // "location": "query",
- // "pattern": "(((accounts)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)):.+,)*(((accounts)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)):.+)",
- // "type": "string"
- // },
- // "userKey": {
- // "description": "Represents the profile id or the user email for which the data should be filtered.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "usage/users/{userKey}/dates/{date}",
- // "response": {
- // "$ref": "UsageReports"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/admin.reports.usage.readonly"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/adsense/v1.2/adsense-api.json b/vendor/google.golang.org/api/adsense/v1.2/adsense-api.json
deleted file mode 100644
index 5e8ef7c8..00000000
--- a/vendor/google.golang.org/api/adsense/v1.2/adsense-api.json
+++ /dev/null
@@ -1,1949 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/4sbh2CScTU4USzSvCohsjZ1YVxQ\"",
- "discoveryVersion": "v1",
- "id": "adsense:v1.2",
- "name": "adsense",
- "canonicalName": "AdSense",
- "version": "v1.2",
- "revision": "20141218",
- "title": "AdSense Management API",
- "description": "Gives AdSense publishers access to their inventory and the ability to generate reports",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/adsense-16.png",
- "x32": "https://www.google.com/images/icons/product/adsense-32.png"
- },
- "documentationLink": "https://developers.google.com/adsense/management/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/adsense/v1.2/",
- "basePath": "/adsense/v1.2/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "adsense/v1.2/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "csv",
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of text/csv",
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/adsense": {
- "description": "View and manage your AdSense data"
- },
- "https://www.googleapis.com/auth/adsense.readonly": {
- "description": "View your AdSense data"
- }
- }
- }
- },
- "schemas": {
- "Account": {
- "id": "Account",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this account."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#account.",
- "default": "adsense#account"
- },
- "name": {
- "type": "string",
- "description": "Name of this account."
- },
- "premium": {
- "type": "boolean",
- "description": "Whether this account is premium."
- },
- "subAccounts": {
- "type": "array",
- "description": "Sub accounts of the this account.",
- "items": {
- "$ref": "Account"
- }
- }
- }
- },
- "Accounts": {
- "id": "Accounts",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The accounts returned in this list response.",
- "items": {
- "$ref": "Account"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#accounts.",
- "default": "adsense#accounts"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through accounts. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "AdClient": {
- "id": "AdClient",
- "type": "object",
- "properties": {
- "arcOptIn": {
- "type": "boolean",
- "description": "Whether this ad client is opted in to ARC."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this ad client."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#adClient.",
- "default": "adsense#adClient"
- },
- "productCode": {
- "type": "string",
- "description": "This ad client's product code, which corresponds to the PRODUCT_CODE report dimension."
- },
- "supportsReporting": {
- "type": "boolean",
- "description": "Whether this ad client supports being reported on."
- }
- }
- },
- "AdClients": {
- "id": "AdClients",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The ad clients returned in this list response.",
- "items": {
- "$ref": "AdClient"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#adClients.",
- "default": "adsense#adClients"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "AdStyle": {
- "id": "AdStyle",
- "type": "object",
- "properties": {
- "colors": {
- "type": "object",
- "description": "The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.",
- "properties": {
- "background": {
- "type": "string",
- "description": "The color of the ad background."
- },
- "border": {
- "type": "string",
- "description": "The color of the ad border."
- },
- "text": {
- "type": "string",
- "description": "The color of the ad text."
- },
- "title": {
- "type": "string",
- "description": "The color of the ad title."
- },
- "url": {
- "type": "string",
- "description": "The color of the ad url."
- }
- }
- },
- "corners": {
- "type": "string",
- "description": "The style of the corners in the ad."
- },
- "font": {
- "type": "object",
- "description": "The font which is included in the style.",
- "properties": {
- "family": {
- "type": "string",
- "description": "The family of the font."
- },
- "size": {
- "type": "string",
- "description": "The size of the font."
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind this is, in this case adsense#adStyle.",
- "default": "adsense#adStyle"
- }
- }
- },
- "AdUnit": {
- "id": "AdUnit",
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "Identity code of this ad unit, not necessarily unique across ad clients."
- },
- "contentAdsSettings": {
- "type": "object",
- "description": "Settings specific to content ads (AFC) and highend mobile content ads (AFMC).",
- "properties": {
- "backupOption": {
- "type": "object",
- "description": "The backup option to be used in instances where no ad is available.",
- "properties": {
- "color": {
- "type": "string",
- "description": "Color to use when type is set to COLOR."
- },
- "type": {
- "type": "string",
- "description": "Type of the backup option. Possible values are BLANK, COLOR and URL."
- },
- "url": {
- "type": "string",
- "description": "URL to use when type is set to URL."
- }
- }
- },
- "size": {
- "type": "string",
- "description": "Size of this ad unit."
- },
- "type": {
- "type": "string",
- "description": "Type of this ad unit."
- }
- }
- },
- "customStyle": {
- "$ref": "AdStyle",
- "description": "Custom style information specific to this ad unit."
- },
- "feedAdsSettings": {
- "type": "object",
- "description": "Settings specific to feed ads (AFF).",
- "properties": {
- "adPosition": {
- "type": "string",
- "description": "The position of the ads relative to the feed entries."
- },
- "frequency": {
- "type": "integer",
- "description": "The frequency at which ads should appear in the feed (i.e. every N entries).",
- "format": "int32"
- },
- "minimumWordCount": {
- "type": "integer",
- "description": "The minimum length an entry should be in order to have attached ads.",
- "format": "int32"
- },
- "type": {
- "type": "string",
- "description": "The type of ads which should appear."
- }
- }
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#adUnit.",
- "default": "adsense#adUnit"
- },
- "mobileContentAdsSettings": {
- "type": "object",
- "description": "Settings specific to WAP mobile content ads (AFMC).",
- "properties": {
- "markupLanguage": {
- "type": "string",
- "description": "The markup language to use for this ad unit."
- },
- "scriptingLanguage": {
- "type": "string",
- "description": "The scripting language to use for this ad unit."
- },
- "size": {
- "type": "string",
- "description": "Size of this ad unit."
- },
- "type": {
- "type": "string",
- "description": "Type of this ad unit."
- }
- }
- },
- "name": {
- "type": "string",
- "description": "Name of this ad unit."
- },
- "savedStyleId": {
- "type": "string",
- "description": "ID of the saved ad style which holds this ad unit's style information."
- },
- "status": {
- "type": "string",
- "description": "Status of this ad unit. Possible values are:\nNEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.\n\nACTIVE: Indicates that there has been activity on this ad unit in the last seven days.\n\nINACTIVE: Indicates that there has been no activity on this ad unit in the last seven days."
- }
- }
- },
- "AdUnits": {
- "id": "AdUnits",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The ad units returned in this list response.",
- "items": {
- "$ref": "AdUnit"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#adUnits.",
- "default": "adsense#adUnits"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through ad units. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "AdsenseReportsGenerateResponse": {
- "id": "AdsenseReportsGenerateResponse",
- "type": "object",
- "properties": {
- "averages": {
- "type": "array",
- "description": "The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
- "items": {
- "type": "string"
- }
- },
- "headers": {
- "type": "array",
- "description": "The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.",
- "items": {
- "type": "object",
- "properties": {
- "currency": {
- "type": "string",
- "description": "The currency of this column. Only present if the header type is METRIC_CURRENCY."
- },
- "name": {
- "type": "string",
- "description": "The name of the header."
- },
- "type": {
- "type": "string",
- "description": "The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY."
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind this is, in this case adsense#report.",
- "default": "adsense#report"
- },
- "rows": {
- "type": "array",
- "description": "The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.",
- "items": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "totalMatchedRows": {
- "type": "string",
- "description": "The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.",
- "format": "int64"
- },
- "totals": {
- "type": "array",
- "description": "The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
- "items": {
- "type": "string"
- }
- },
- "warnings": {
- "type": "array",
- "description": "Any warnings associated with generation of the report.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "CustomChannel": {
- "id": "CustomChannel",
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "Code of this custom channel, not necessarily unique across ad clients."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#customChannel.",
- "default": "adsense#customChannel"
- },
- "name": {
- "type": "string",
- "description": "Name of this custom channel."
- },
- "targetingInfo": {
- "type": "object",
- "description": "The targeting information of this custom channel, if activated.",
- "properties": {
- "adsAppearOn": {
- "type": "string",
- "description": "The name used to describe this channel externally."
- },
- "description": {
- "type": "string",
- "description": "The external description of the channel."
- },
- "location": {
- "type": "string",
- "description": "The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS."
- },
- "siteLanguage": {
- "type": "string",
- "description": "The language of the sites ads will be displayed on."
- }
- }
- }
- }
- },
- "CustomChannels": {
- "id": "CustomChannels",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The custom channels returned in this list response.",
- "items": {
- "$ref": "CustomChannel"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#customChannels.",
- "default": "adsense#customChannels"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "SavedAdStyle": {
- "id": "SavedAdStyle",
- "type": "object",
- "properties": {
- "adStyle": {
- "$ref": "AdStyle",
- "description": "The AdStyle itself."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#savedAdStyle.",
- "default": "adsense#savedAdStyle"
- },
- "name": {
- "type": "string",
- "description": "The user selected name of this SavedAdStyle."
- }
- }
- },
- "SavedAdStyles": {
- "id": "SavedAdStyles",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The saved ad styles returned in this list response.",
- "items": {
- "$ref": "SavedAdStyle"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#savedAdStyles.",
- "default": "adsense#savedAdStyles"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through ad units. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "SavedReport": {
- "id": "SavedReport",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this saved report."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#savedReport.",
- "default": "adsense#savedReport"
- },
- "name": {
- "type": "string",
- "description": "This saved report's name."
- }
- }
- },
- "SavedReports": {
- "id": "SavedReports",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The saved reports returned in this list response.",
- "items": {
- "$ref": "SavedReport"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#savedReports.",
- "default": "adsense#savedReports"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "UrlChannel": {
- "id": "UrlChannel",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#urlChannel.",
- "default": "adsense#urlChannel"
- },
- "urlPattern": {
- "type": "string",
- "description": "URL Pattern of this URL channel. Does not include \"http://\" or \"https://\". Example: www.example.com/home"
- }
- }
- },
- "UrlChannels": {
- "id": "UrlChannels",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The URL channels returned in this list response.",
- "items": {
- "$ref": "UrlChannel"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#urlChannels.",
- "default": "adsense#urlChannels"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- }
- },
- "resources": {
- "accounts": {
- "methods": {
- "get": {
- "id": "adsense.accounts.get",
- "path": "accounts/{accountId}",
- "httpMethod": "GET",
- "description": "Get information about the selected AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to get information about.",
- "required": true,
- "location": "path"
- },
- "tree": {
- "type": "boolean",
- "description": "Whether the tree of sub accounts should be returned.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.accounts.list",
- "path": "accounts",
- "httpMethod": "GET",
- "description": "List all accounts available to this AdSense account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of accounts to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through accounts. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Accounts"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- },
- "resources": {
- "adclients": {
- "methods": {
- "list": {
- "id": "adsense.accounts.adclients.list",
- "path": "accounts/{accountId}/adclients",
- "httpMethod": "GET",
- "description": "List all ad clients in the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account for which to list ad clients.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad clients to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "AdClients"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- },
- "adunits": {
- "methods": {
- "get": {
- "id": "adsense.accounts.adunits.get",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}",
- "httpMethod": "GET",
- "description": "Gets the specified ad unit in the specified ad client for the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to get the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "AdUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.accounts.adunits.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
- "httpMethod": "GET",
- "description": "List all ad units in the specified ad client for the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list ad units.",
- "required": true,
- "location": "path"
- },
- "includeInactive": {
- "type": "boolean",
- "description": "Whether to include inactive ad units. Default: true.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad units to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId"
- ],
- "response": {
- "$ref": "AdUnits"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- },
- "resources": {
- "customchannels": {
- "methods": {
- "list": {
- "id": "adsense.accounts.adunits.customchannels.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/customchannels",
- "httpMethod": "GET",
- "description": "List all custom channels which the specified ad unit belongs to.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit for which to list custom channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
- },
- "customchannels": {
- "methods": {
- "get": {
- "id": "adsense.accounts.customchannels.get",
- "path": "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}",
- "httpMethod": "GET",
- "description": "Get the specified custom channel from the specified ad client for the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the custom channel.",
- "required": true,
- "location": "path"
- },
- "customChannelId": {
- "type": "string",
- "description": "Custom channel to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "CustomChannel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.accounts.customchannels.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/customchannels",
- "httpMethod": "GET",
- "description": "List all custom channels in the specified ad client for the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list custom channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId"
- ],
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- },
- "resources": {
- "adunits": {
- "methods": {
- "list": {
- "id": "adsense.accounts.customchannels.adunits.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}/adunits",
- "httpMethod": "GET",
- "description": "List all ad units in the specified custom channel.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the custom channel.",
- "required": true,
- "location": "path"
- },
- "customChannelId": {
- "type": "string",
- "description": "Custom channel for which to list ad units.",
- "required": true,
- "location": "path"
- },
- "includeInactive": {
- "type": "boolean",
- "description": "Whether to include inactive ad units. Default: true.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad units to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "AdUnits"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
- },
- "reports": {
- "methods": {
- "generate": {
- "id": "adsense.accounts.reports.generate",
- "path": "accounts/{accountId}/reports",
- "httpMethod": "GET",
- "description": "Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account upon which to report.",
- "required": true,
- "location": "path"
- },
- "currency": {
- "type": "string",
- "description": "Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.",
- "pattern": "[a-zA-Z]+",
- "location": "query"
- },
- "dimension": {
- "type": "string",
- "description": "Dimensions to base the report on.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "endDate": {
- "type": "string",
- "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "Filters to be run on the report.",
- "pattern": "[a-zA-Z_]+(==|=@).+",
- "repeated": true,
- "location": "query"
- },
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "metric": {
- "type": "string",
- "description": "Numeric columns to include in the report.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "sort": {
- "type": "string",
- "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
- "pattern": "(\\+|-)?[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "startDate": {
- "type": "string",
- "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "startDate",
- "endDate"
- ],
- "response": {
- "$ref": "AdsenseReportsGenerateResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ],
- "supportsMediaDownload": true
- }
- },
- "resources": {
- "saved": {
- "methods": {
- "generate": {
- "id": "adsense.accounts.reports.saved.generate",
- "path": "accounts/{accountId}/reports/{savedReportId}",
- "httpMethod": "GET",
- "description": "Generate an AdSense report based on the saved report ID sent in the query parameters.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the saved reports belong.",
- "required": true,
- "location": "path"
- },
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "savedReportId": {
- "type": "string",
- "description": "The saved report to retrieve.",
- "required": true,
- "location": "path"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "savedReportId"
- ],
- "response": {
- "$ref": "AdsenseReportsGenerateResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.accounts.reports.saved.list",
- "path": "accounts/{accountId}/reports/saved",
- "httpMethod": "GET",
- "description": "List all saved reports in the specified AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the saved reports belong.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of saved reports to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "SavedReports"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
- },
- "savedadstyles": {
- "methods": {
- "get": {
- "id": "adsense.accounts.savedadstyles.get",
- "path": "accounts/{accountId}/savedadstyles/{savedAdStyleId}",
- "httpMethod": "GET",
- "description": "List a specific saved ad style for the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account for which to get the saved ad style.",
- "required": true,
- "location": "path"
- },
- "savedAdStyleId": {
- "type": "string",
- "description": "Saved ad style to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "savedAdStyleId"
- ],
- "response": {
- "$ref": "SavedAdStyle"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.accounts.savedadstyles.list",
- "path": "accounts/{accountId}/savedadstyles",
- "httpMethod": "GET",
- "description": "List all saved ad styles in the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account for which to list saved ad styles.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of saved ad styles to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "SavedAdStyles"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- },
- "urlchannels": {
- "methods": {
- "list": {
- "id": "adsense.accounts.urlchannels.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/urlchannels",
- "httpMethod": "GET",
- "description": "List all URL channels in the specified ad client for the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list URL channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of URL channels to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId"
- ],
- "response": {
- "$ref": "UrlChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
- },
- "adclients": {
- "methods": {
- "list": {
- "id": "adsense.adclients.list",
- "path": "adclients",
- "httpMethod": "GET",
- "description": "List all ad clients in this AdSense account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad clients to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "AdClients"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- },
- "adunits": {
- "methods": {
- "get": {
- "id": "adsense.adunits.get",
- "path": "adclients/{adClientId}/adunits/{adUnitId}",
- "httpMethod": "GET",
- "description": "Gets the specified ad unit in the specified ad client.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to get the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "AdUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.adunits.list",
- "path": "adclients/{adClientId}/adunits",
- "httpMethod": "GET",
- "description": "List all ad units in the specified ad client for this AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list ad units.",
- "required": true,
- "location": "path"
- },
- "includeInactive": {
- "type": "boolean",
- "description": "Whether to include inactive ad units. Default: true.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad units to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "AdUnits"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- },
- "resources": {
- "customchannels": {
- "methods": {
- "list": {
- "id": "adsense.adunits.customchannels.list",
- "path": "adclients/{adClientId}/adunits/{adUnitId}/customchannels",
- "httpMethod": "GET",
- "description": "List all custom channels which the specified ad unit belongs to.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit for which to list custom channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
- },
- "customchannels": {
- "methods": {
- "get": {
- "id": "adsense.customchannels.get",
- "path": "adclients/{adClientId}/customchannels/{customChannelId}",
- "httpMethod": "GET",
- "description": "Get the specified custom channel from the specified ad client.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the custom channel.",
- "required": true,
- "location": "path"
- },
- "customChannelId": {
- "type": "string",
- "description": "Custom channel to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "CustomChannel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.customchannels.list",
- "path": "adclients/{adClientId}/customchannels",
- "httpMethod": "GET",
- "description": "List all custom channels in the specified ad client for this AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list custom channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- },
- "resources": {
- "adunits": {
- "methods": {
- "list": {
- "id": "adsense.customchannels.adunits.list",
- "path": "adclients/{adClientId}/customchannels/{customChannelId}/adunits",
- "httpMethod": "GET",
- "description": "List all ad units in the specified custom channel.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the custom channel.",
- "required": true,
- "location": "path"
- },
- "customChannelId": {
- "type": "string",
- "description": "Custom channel for which to list ad units.",
- "required": true,
- "location": "path"
- },
- "includeInactive": {
- "type": "boolean",
- "description": "Whether to include inactive ad units. Default: true.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad units to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "AdUnits"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
- },
- "reports": {
- "methods": {
- "generate": {
- "id": "adsense.reports.generate",
- "path": "reports",
- "httpMethod": "GET",
- "description": "Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Accounts upon which to report.",
- "repeated": true,
- "location": "query"
- },
- "currency": {
- "type": "string",
- "description": "Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.",
- "pattern": "[a-zA-Z]+",
- "location": "query"
- },
- "dimension": {
- "type": "string",
- "description": "Dimensions to base the report on.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "endDate": {
- "type": "string",
- "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "Filters to be run on the report.",
- "pattern": "[a-zA-Z_]+(==|=@).+",
- "repeated": true,
- "location": "query"
- },
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "metric": {
- "type": "string",
- "description": "Numeric columns to include in the report.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "sort": {
- "type": "string",
- "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
- "pattern": "(\\+|-)?[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "startDate": {
- "type": "string",
- "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
- }
- },
- "parameterOrder": [
- "startDate",
- "endDate"
- ],
- "response": {
- "$ref": "AdsenseReportsGenerateResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ],
- "supportsMediaDownload": true
- }
- },
- "resources": {
- "saved": {
- "methods": {
- "generate": {
- "id": "adsense.reports.saved.generate",
- "path": "reports/{savedReportId}",
- "httpMethod": "GET",
- "description": "Generate an AdSense report based on the saved report ID sent in the query parameters.",
- "parameters": {
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "savedReportId": {
- "type": "string",
- "description": "The saved report to retrieve.",
- "required": true,
- "location": "path"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
- }
- },
- "parameterOrder": [
- "savedReportId"
- ],
- "response": {
- "$ref": "AdsenseReportsGenerateResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.reports.saved.list",
- "path": "reports/saved",
- "httpMethod": "GET",
- "description": "List all saved reports in this AdSense account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of saved reports to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "SavedReports"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
- },
- "savedadstyles": {
- "methods": {
- "get": {
- "id": "adsense.savedadstyles.get",
- "path": "savedadstyles/{savedAdStyleId}",
- "httpMethod": "GET",
- "description": "Get a specific saved ad style from the user's account.",
- "parameters": {
- "savedAdStyleId": {
- "type": "string",
- "description": "Saved ad style to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "savedAdStyleId"
- ],
- "response": {
- "$ref": "SavedAdStyle"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.savedadstyles.list",
- "path": "savedadstyles",
- "httpMethod": "GET",
- "description": "List all saved ad styles in the user's account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of saved ad styles to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "SavedAdStyles"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- },
- "urlchannels": {
- "methods": {
- "list": {
- "id": "adsense.urlchannels.list",
- "path": "adclients/{adClientId}/urlchannels",
- "httpMethod": "GET",
- "description": "List all URL channels in the specified ad client for this AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list URL channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of URL channels to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "UrlChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/adsense/v1.2/adsense-gen.go b/vendor/google.golang.org/api/adsense/v1.2/adsense-gen.go
deleted file mode 100644
index 7fe175b9..00000000
--- a/vendor/google.golang.org/api/adsense/v1.2/adsense-gen.go
+++ /dev/null
@@ -1,5950 +0,0 @@
-// Package adsense provides access to the AdSense Management API.
-//
-// See https://developers.google.com/adsense/management/
-//
-// Usage example:
-//
-// import "google.golang.org/api/adsense/v1.2"
-// ...
-// adsenseService, err := adsense.New(oauthHttpClient)
-package adsense // import "google.golang.org/api/adsense/v1.2"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "adsense:v1.2"
-const apiName = "adsense"
-const apiVersion = "v1.2"
-const basePath = "https://www.googleapis.com/adsense/v1.2/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your AdSense data
- AdsenseScope = "https://www.googleapis.com/auth/adsense"
-
- // View your AdSense data
- AdsenseReadonlyScope = "https://www.googleapis.com/auth/adsense.readonly"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Accounts = NewAccountsService(s)
- s.Adclients = NewAdclientsService(s)
- s.Adunits = NewAdunitsService(s)
- s.Customchannels = NewCustomchannelsService(s)
- s.Reports = NewReportsService(s)
- s.Savedadstyles = NewSavedadstylesService(s)
- s.Urlchannels = NewUrlchannelsService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Accounts *AccountsService
-
- Adclients *AdclientsService
-
- Adunits *AdunitsService
-
- Customchannels *CustomchannelsService
-
- Reports *ReportsService
-
- Savedadstyles *SavedadstylesService
-
- Urlchannels *UrlchannelsService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewAccountsService(s *Service) *AccountsService {
- rs := &AccountsService{s: s}
- rs.Adclients = NewAccountsAdclientsService(s)
- rs.Adunits = NewAccountsAdunitsService(s)
- rs.Customchannels = NewAccountsCustomchannelsService(s)
- rs.Reports = NewAccountsReportsService(s)
- rs.Savedadstyles = NewAccountsSavedadstylesService(s)
- rs.Urlchannels = NewAccountsUrlchannelsService(s)
- return rs
-}
-
-type AccountsService struct {
- s *Service
-
- Adclients *AccountsAdclientsService
-
- Adunits *AccountsAdunitsService
-
- Customchannels *AccountsCustomchannelsService
-
- Reports *AccountsReportsService
-
- Savedadstyles *AccountsSavedadstylesService
-
- Urlchannels *AccountsUrlchannelsService
-}
-
-func NewAccountsAdclientsService(s *Service) *AccountsAdclientsService {
- rs := &AccountsAdclientsService{s: s}
- return rs
-}
-
-type AccountsAdclientsService struct {
- s *Service
-}
-
-func NewAccountsAdunitsService(s *Service) *AccountsAdunitsService {
- rs := &AccountsAdunitsService{s: s}
- rs.Customchannels = NewAccountsAdunitsCustomchannelsService(s)
- return rs
-}
-
-type AccountsAdunitsService struct {
- s *Service
-
- Customchannels *AccountsAdunitsCustomchannelsService
-}
-
-func NewAccountsAdunitsCustomchannelsService(s *Service) *AccountsAdunitsCustomchannelsService {
- rs := &AccountsAdunitsCustomchannelsService{s: s}
- return rs
-}
-
-type AccountsAdunitsCustomchannelsService struct {
- s *Service
-}
-
-func NewAccountsCustomchannelsService(s *Service) *AccountsCustomchannelsService {
- rs := &AccountsCustomchannelsService{s: s}
- rs.Adunits = NewAccountsCustomchannelsAdunitsService(s)
- return rs
-}
-
-type AccountsCustomchannelsService struct {
- s *Service
-
- Adunits *AccountsCustomchannelsAdunitsService
-}
-
-func NewAccountsCustomchannelsAdunitsService(s *Service) *AccountsCustomchannelsAdunitsService {
- rs := &AccountsCustomchannelsAdunitsService{s: s}
- return rs
-}
-
-type AccountsCustomchannelsAdunitsService struct {
- s *Service
-}
-
-func NewAccountsReportsService(s *Service) *AccountsReportsService {
- rs := &AccountsReportsService{s: s}
- rs.Saved = NewAccountsReportsSavedService(s)
- return rs
-}
-
-type AccountsReportsService struct {
- s *Service
-
- Saved *AccountsReportsSavedService
-}
-
-func NewAccountsReportsSavedService(s *Service) *AccountsReportsSavedService {
- rs := &AccountsReportsSavedService{s: s}
- return rs
-}
-
-type AccountsReportsSavedService struct {
- s *Service
-}
-
-func NewAccountsSavedadstylesService(s *Service) *AccountsSavedadstylesService {
- rs := &AccountsSavedadstylesService{s: s}
- return rs
-}
-
-type AccountsSavedadstylesService struct {
- s *Service
-}
-
-func NewAccountsUrlchannelsService(s *Service) *AccountsUrlchannelsService {
- rs := &AccountsUrlchannelsService{s: s}
- return rs
-}
-
-type AccountsUrlchannelsService struct {
- s *Service
-}
-
-func NewAdclientsService(s *Service) *AdclientsService {
- rs := &AdclientsService{s: s}
- return rs
-}
-
-type AdclientsService struct {
- s *Service
-}
-
-func NewAdunitsService(s *Service) *AdunitsService {
- rs := &AdunitsService{s: s}
- rs.Customchannels = NewAdunitsCustomchannelsService(s)
- return rs
-}
-
-type AdunitsService struct {
- s *Service
-
- Customchannels *AdunitsCustomchannelsService
-}
-
-func NewAdunitsCustomchannelsService(s *Service) *AdunitsCustomchannelsService {
- rs := &AdunitsCustomchannelsService{s: s}
- return rs
-}
-
-type AdunitsCustomchannelsService struct {
- s *Service
-}
-
-func NewCustomchannelsService(s *Service) *CustomchannelsService {
- rs := &CustomchannelsService{s: s}
- rs.Adunits = NewCustomchannelsAdunitsService(s)
- return rs
-}
-
-type CustomchannelsService struct {
- s *Service
-
- Adunits *CustomchannelsAdunitsService
-}
-
-func NewCustomchannelsAdunitsService(s *Service) *CustomchannelsAdunitsService {
- rs := &CustomchannelsAdunitsService{s: s}
- return rs
-}
-
-type CustomchannelsAdunitsService struct {
- s *Service
-}
-
-func NewReportsService(s *Service) *ReportsService {
- rs := &ReportsService{s: s}
- rs.Saved = NewReportsSavedService(s)
- return rs
-}
-
-type ReportsService struct {
- s *Service
-
- Saved *ReportsSavedService
-}
-
-func NewReportsSavedService(s *Service) *ReportsSavedService {
- rs := &ReportsSavedService{s: s}
- return rs
-}
-
-type ReportsSavedService struct {
- s *Service
-}
-
-func NewSavedadstylesService(s *Service) *SavedadstylesService {
- rs := &SavedadstylesService{s: s}
- return rs
-}
-
-type SavedadstylesService struct {
- s *Service
-}
-
-func NewUrlchannelsService(s *Service) *UrlchannelsService {
- rs := &UrlchannelsService{s: s}
- return rs
-}
-
-type UrlchannelsService struct {
- s *Service
-}
-
-type Account struct {
- // Id: Unique identifier of this account.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adsense#account.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this account.
- Name string `json:"name,omitempty"`
-
- // Premium: Whether this account is premium.
- Premium bool `json:"premium,omitempty"`
-
- // SubAccounts: Sub accounts of the this account.
- SubAccounts []*Account `json:"subAccounts,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Account) MarshalJSON() ([]byte, error) {
- type noMethod Account
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Accounts struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The accounts returned in this list response.
- Items []*Account `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsense#accounts.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through accounts. To
- // retrieve the next page of results, set the next request's "pageToken"
- // value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Accounts) MarshalJSON() ([]byte, error) {
- type noMethod Accounts
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdClient struct {
- // ArcOptIn: Whether this ad client is opted in to ARC.
- ArcOptIn bool `json:"arcOptIn,omitempty"`
-
- // Id: Unique identifier of this ad client.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adsense#adClient.
- Kind string `json:"kind,omitempty"`
-
- // ProductCode: This ad client's product code, which corresponds to the
- // PRODUCT_CODE report dimension.
- ProductCode string `json:"productCode,omitempty"`
-
- // SupportsReporting: Whether this ad client supports being reported on.
- SupportsReporting bool `json:"supportsReporting,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ArcOptIn") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdClient) MarshalJSON() ([]byte, error) {
- type noMethod AdClient
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdClients struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The ad clients returned in this list response.
- Items []*AdClient `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsense#adClients.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through ad clients. To
- // retrieve the next page of results, set the next request's "pageToken"
- // value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdClients) MarshalJSON() ([]byte, error) {
- type noMethod AdClients
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdStyle struct {
- // Colors: The colors which are included in the style. These are
- // represented as six hexadecimal characters, similar to HTML color
- // codes, but without the leading hash.
- Colors *AdStyleColors `json:"colors,omitempty"`
-
- // Corners: The style of the corners in the ad.
- Corners string `json:"corners,omitempty"`
-
- // Font: The font which is included in the style.
- Font *AdStyleFont `json:"font,omitempty"`
-
- // Kind: Kind this is, in this case adsense#adStyle.
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Colors") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdStyle) MarshalJSON() ([]byte, error) {
- type noMethod AdStyle
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdStyleColors: The colors which are included in the style. These are
-// represented as six hexadecimal characters, similar to HTML color
-// codes, but without the leading hash.
-type AdStyleColors struct {
- // Background: The color of the ad background.
- Background string `json:"background,omitempty"`
-
- // Border: The color of the ad border.
- Border string `json:"border,omitempty"`
-
- // Text: The color of the ad text.
- Text string `json:"text,omitempty"`
-
- // Title: The color of the ad title.
- Title string `json:"title,omitempty"`
-
- // Url: The color of the ad url.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Background") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdStyleColors) MarshalJSON() ([]byte, error) {
- type noMethod AdStyleColors
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdStyleFont: The font which is included in the style.
-type AdStyleFont struct {
- // Family: The family of the font.
- Family string `json:"family,omitempty"`
-
- // Size: The size of the font.
- Size string `json:"size,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Family") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdStyleFont) MarshalJSON() ([]byte, error) {
- type noMethod AdStyleFont
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdUnit struct {
- // Code: Identity code of this ad unit, not necessarily unique across ad
- // clients.
- Code string `json:"code,omitempty"`
-
- // ContentAdsSettings: Settings specific to content ads (AFC) and
- // highend mobile content ads (AFMC).
- ContentAdsSettings *AdUnitContentAdsSettings `json:"contentAdsSettings,omitempty"`
-
- // CustomStyle: Custom style information specific to this ad unit.
- CustomStyle *AdStyle `json:"customStyle,omitempty"`
-
- // FeedAdsSettings: Settings specific to feed ads (AFF).
- FeedAdsSettings *AdUnitFeedAdsSettings `json:"feedAdsSettings,omitempty"`
-
- // Id: Unique identifier of this ad unit. This should be considered an
- // opaque identifier; it is not safe to rely on it being in any
- // particular format.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adsense#adUnit.
- Kind string `json:"kind,omitempty"`
-
- // MobileContentAdsSettings: Settings specific to WAP mobile content ads
- // (AFMC).
- MobileContentAdsSettings *AdUnitMobileContentAdsSettings `json:"mobileContentAdsSettings,omitempty"`
-
- // Name: Name of this ad unit.
- Name string `json:"name,omitempty"`
-
- // SavedStyleId: ID of the saved ad style which holds this ad unit's
- // style information.
- SavedStyleId string `json:"savedStyleId,omitempty"`
-
- // Status: Status of this ad unit. Possible values are:
- // NEW: Indicates that the ad unit was created within the last seven
- // days and does not yet have any activity associated with it.
- //
- // ACTIVE: Indicates that there has been activity on this ad unit in the
- // last seven days.
- //
- // INACTIVE: Indicates that there has been no activity on this ad unit
- // in the last seven days.
- Status string `json:"status,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdUnit) MarshalJSON() ([]byte, error) {
- type noMethod AdUnit
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdUnitContentAdsSettings: Settings specific to content ads (AFC) and
-// highend mobile content ads (AFMC).
-type AdUnitContentAdsSettings struct {
- // BackupOption: The backup option to be used in instances where no ad
- // is available.
- BackupOption *AdUnitContentAdsSettingsBackupOption `json:"backupOption,omitempty"`
-
- // Size: Size of this ad unit.
- Size string `json:"size,omitempty"`
-
- // Type: Type of this ad unit.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BackupOption") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdUnitContentAdsSettings) MarshalJSON() ([]byte, error) {
- type noMethod AdUnitContentAdsSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdUnitContentAdsSettingsBackupOption: The backup option to be used in
-// instances where no ad is available.
-type AdUnitContentAdsSettingsBackupOption struct {
- // Color: Color to use when type is set to COLOR.
- Color string `json:"color,omitempty"`
-
- // Type: Type of the backup option. Possible values are BLANK, COLOR and
- // URL.
- Type string `json:"type,omitempty"`
-
- // Url: URL to use when type is set to URL.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Color") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdUnitContentAdsSettingsBackupOption) MarshalJSON() ([]byte, error) {
- type noMethod AdUnitContentAdsSettingsBackupOption
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdUnitFeedAdsSettings: Settings specific to feed ads (AFF).
-type AdUnitFeedAdsSettings struct {
- // AdPosition: The position of the ads relative to the feed entries.
- AdPosition string `json:"adPosition,omitempty"`
-
- // Frequency: The frequency at which ads should appear in the feed (i.e.
- // every N entries).
- Frequency int64 `json:"frequency,omitempty"`
-
- // MinimumWordCount: The minimum length an entry should be in order to
- // have attached ads.
- MinimumWordCount int64 `json:"minimumWordCount,omitempty"`
-
- // Type: The type of ads which should appear.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AdPosition") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdUnitFeedAdsSettings) MarshalJSON() ([]byte, error) {
- type noMethod AdUnitFeedAdsSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdUnitMobileContentAdsSettings: Settings specific to WAP mobile
-// content ads (AFMC).
-type AdUnitMobileContentAdsSettings struct {
- // MarkupLanguage: The markup language to use for this ad unit.
- MarkupLanguage string `json:"markupLanguage,omitempty"`
-
- // ScriptingLanguage: The scripting language to use for this ad unit.
- ScriptingLanguage string `json:"scriptingLanguage,omitempty"`
-
- // Size: Size of this ad unit.
- Size string `json:"size,omitempty"`
-
- // Type: Type of this ad unit.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "MarkupLanguage") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdUnitMobileContentAdsSettings) MarshalJSON() ([]byte, error) {
- type noMethod AdUnitMobileContentAdsSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdUnits struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The ad units returned in this list response.
- Items []*AdUnit `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsense#adUnits.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through ad units. To
- // retrieve the next page of results, set the next request's "pageToken"
- // value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdUnits) MarshalJSON() ([]byte, error) {
- type noMethod AdUnits
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdsenseReportsGenerateResponse struct {
- // Averages: The averages of the report. This is the same length as any
- // other row in the report; cells corresponding to dimension columns are
- // empty.
- Averages []string `json:"averages,omitempty"`
-
- // Headers: The header information of the columns requested in the
- // report. This is a list of headers; one for each dimension in the
- // request, followed by one for each metric in the request.
- Headers []*AdsenseReportsGenerateResponseHeaders `json:"headers,omitempty"`
-
- // Kind: Kind this is, in this case adsense#report.
- Kind string `json:"kind,omitempty"`
-
- // Rows: The output rows of the report. Each row is a list of cells; one
- // for each dimension in the request, followed by one for each metric in
- // the request. The dimension cells contain strings, and the metric
- // cells contain numbers.
- Rows [][]string `json:"rows,omitempty"`
-
- // TotalMatchedRows: The total number of rows matched by the report
- // request. Fewer rows may be returned in the response due to being
- // limited by the row count requested or the report row limit.
- TotalMatchedRows int64 `json:"totalMatchedRows,omitempty,string"`
-
- // Totals: The totals of the report. This is the same length as any
- // other row in the report; cells corresponding to dimension columns are
- // empty.
- Totals []string `json:"totals,omitempty"`
-
- // Warnings: Any warnings associated with generation of the report.
- Warnings []string `json:"warnings,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Averages") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdsenseReportsGenerateResponse) MarshalJSON() ([]byte, error) {
- type noMethod AdsenseReportsGenerateResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdsenseReportsGenerateResponseHeaders struct {
- // Currency: The currency of this column. Only present if the header
- // type is METRIC_CURRENCY.
- Currency string `json:"currency,omitempty"`
-
- // Name: The name of the header.
- Name string `json:"name,omitempty"`
-
- // Type: The type of the header; one of DIMENSION, METRIC_TALLY,
- // METRIC_RATIO, or METRIC_CURRENCY.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Currency") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdsenseReportsGenerateResponseHeaders) MarshalJSON() ([]byte, error) {
- type noMethod AdsenseReportsGenerateResponseHeaders
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CustomChannel struct {
- // Code: Code of this custom channel, not necessarily unique across ad
- // clients.
- Code string `json:"code,omitempty"`
-
- // Id: Unique identifier of this custom channel. This should be
- // considered an opaque identifier; it is not safe to rely on it being
- // in any particular format.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adsense#customChannel.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this custom channel.
- Name string `json:"name,omitempty"`
-
- // TargetingInfo: The targeting information of this custom channel, if
- // activated.
- TargetingInfo *CustomChannelTargetingInfo `json:"targetingInfo,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomChannel) MarshalJSON() ([]byte, error) {
- type noMethod CustomChannel
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CustomChannelTargetingInfo: The targeting information of this custom
-// channel, if activated.
-type CustomChannelTargetingInfo struct {
- // AdsAppearOn: The name used to describe this channel externally.
- AdsAppearOn string `json:"adsAppearOn,omitempty"`
-
- // Description: The external description of the channel.
- Description string `json:"description,omitempty"`
-
- // Location: The locations in which ads appear. (Only valid for content
- // and mobile content ads). Acceptable values for content ads are:
- // TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER,
- // MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT,
- // MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are:
- // TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
- Location string `json:"location,omitempty"`
-
- // SiteLanguage: The language of the sites ads will be displayed on.
- SiteLanguage string `json:"siteLanguage,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AdsAppearOn") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomChannelTargetingInfo) MarshalJSON() ([]byte, error) {
- type noMethod CustomChannelTargetingInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CustomChannels struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The custom channels returned in this list response.
- Items []*CustomChannel `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsense#customChannels.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through custom
- // channels. To retrieve the next page of results, set the next
- // request's "pageToken" value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomChannels) MarshalJSON() ([]byte, error) {
- type noMethod CustomChannels
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type SavedAdStyle struct {
- // AdStyle: The AdStyle itself.
- AdStyle *AdStyle `json:"adStyle,omitempty"`
-
- // Id: Unique identifier of this saved ad style. This should be
- // considered an opaque identifier; it is not safe to rely on it being
- // in any particular format.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adsense#savedAdStyle.
- Kind string `json:"kind,omitempty"`
-
- // Name: The user selected name of this SavedAdStyle.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AdStyle") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SavedAdStyle) MarshalJSON() ([]byte, error) {
- type noMethod SavedAdStyle
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type SavedAdStyles struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The saved ad styles returned in this list response.
- Items []*SavedAdStyle `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsense#savedAdStyles.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through ad units. To
- // retrieve the next page of results, set the next request's "pageToken"
- // value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SavedAdStyles) MarshalJSON() ([]byte, error) {
- type noMethod SavedAdStyles
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type SavedReport struct {
- // Id: Unique identifier of this saved report.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adsense#savedReport.
- Kind string `json:"kind,omitempty"`
-
- // Name: This saved report's name.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SavedReport) MarshalJSON() ([]byte, error) {
- type noMethod SavedReport
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type SavedReports struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The saved reports returned in this list response.
- Items []*SavedReport `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsense#savedReports.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through saved reports.
- // To retrieve the next page of results, set the next request's
- // "pageToken" value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SavedReports) MarshalJSON() ([]byte, error) {
- type noMethod SavedReports
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UrlChannel struct {
- // Id: Unique identifier of this URL channel. This should be considered
- // an opaque identifier; it is not safe to rely on it being in any
- // particular format.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adsense#urlChannel.
- Kind string `json:"kind,omitempty"`
-
- // UrlPattern: URL Pattern of this URL channel. Does not include
- // "http://" or "https://". Example: www.example.com/home
- UrlPattern string `json:"urlPattern,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlChannel) MarshalJSON() ([]byte, error) {
- type noMethod UrlChannel
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UrlChannels struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The URL channels returned in this list response.
- Items []*UrlChannel `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsense#urlChannels.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through URL channels.
- // To retrieve the next page of results, set the next request's
- // "pageToken" value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlChannels) MarshalJSON() ([]byte, error) {
- type noMethod UrlChannels
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "adsense.accounts.get":
-
-type AccountsGetCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get information about the selected AdSense account.
-func (r *AccountsService) Get(accountId string) *AccountsGetCall {
- c := &AccountsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// Tree sets the optional parameter "tree": Whether the tree of sub
-// accounts should be returned.
-func (c *AccountsGetCall) Tree(tree bool) *AccountsGetCall {
- c.opt_["tree"] = tree
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsGetCall) Fields(s ...googleapi.Field) *AccountsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsGetCall) IfNoneMatch(entityTag string) *AccountsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsGetCall) Context(ctx context.Context) *AccountsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["tree"]; ok {
- params.Set("tree", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.get" call.
-// Exactly one of *Account or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Account.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsGetCall) Do() (*Account, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Account{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get information about the selected AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.get",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to get information about.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "tree": {
- // "description": "Whether the tree of sub accounts should be returned.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "accounts/{accountId}",
- // "response": {
- // "$ref": "Account"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.list":
-
-type AccountsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all accounts available to this AdSense account.
-func (r *AccountsService) List() *AccountsListCall {
- c := &AccountsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of accounts to include in the response, used for paging.
-func (c *AccountsListCall) MaxResults(maxResults int64) *AccountsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through accounts. To retrieve the next page, set
-// this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AccountsListCall) PageToken(pageToken string) *AccountsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsListCall) Fields(s ...googleapi.Field) *AccountsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsListCall) IfNoneMatch(entityTag string) *AccountsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsListCall) Context(ctx context.Context) *AccountsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.list" call.
-// Exactly one of *Accounts or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Accounts.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccountsListCall) Do() (*Accounts, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Accounts{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all accounts available to this AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.list",
- // "parameters": {
- // "maxResults": {
- // "description": "The maximum number of accounts to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through accounts. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts",
- // "response": {
- // "$ref": "Accounts"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.adclients.list":
-
-type AccountsAdclientsListCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all ad clients in the specified account.
-func (r *AccountsAdclientsService) List(accountId string) *AccountsAdclientsListCall {
- c := &AccountsAdclientsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of ad clients to include in the response, used for paging.
-func (c *AccountsAdclientsListCall) MaxResults(maxResults int64) *AccountsAdclientsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad clients. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AccountsAdclientsListCall) PageToken(pageToken string) *AccountsAdclientsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAdclientsListCall) Fields(s ...googleapi.Field) *AccountsAdclientsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsAdclientsListCall) IfNoneMatch(entityTag string) *AccountsAdclientsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAdclientsListCall) Context(ctx context.Context) *AccountsAdclientsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAdclientsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.adclients.list" call.
-// Exactly one of *AdClients or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AdClients.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccountsAdclientsListCall) Do() (*AdClients, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdClients{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all ad clients in the specified account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.adclients.list",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account for which to list ad clients.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of ad clients to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients",
- // "response": {
- // "$ref": "AdClients"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.adunits.get":
-
-type AccountsAdunitsGetCall struct {
- s *Service
- accountId string
- adClientId string
- adUnitId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets the specified ad unit in the specified ad client for the
-// specified account.
-func (r *AccountsAdunitsService) Get(accountId string, adClientId string, adUnitId string) *AccountsAdunitsGetCall {
- c := &AccountsAdunitsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- c.adUnitId = adUnitId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAdunitsGetCall) Fields(s ...googleapi.Field) *AccountsAdunitsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsAdunitsGetCall) IfNoneMatch(entityTag string) *AccountsAdunitsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAdunitsGetCall) Context(ctx context.Context) *AccountsAdunitsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAdunitsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- "adUnitId": c.adUnitId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.adunits.get" call.
-// Exactly one of *AdUnit or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnit.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsAdunitsGetCall) Do() (*AdUnit, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnit{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the specified ad unit in the specified ad client for the specified account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.adunits.get",
- // "parameterOrder": [
- // "accountId",
- // "adClientId",
- // "adUnitId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the ad client belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client for which to get the ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adUnitId": {
- // "description": "Ad unit to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}",
- // "response": {
- // "$ref": "AdUnit"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.adunits.list":
-
-type AccountsAdunitsListCall struct {
- s *Service
- accountId string
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all ad units in the specified ad client for the specified
-// account.
-func (r *AccountsAdunitsService) List(accountId string, adClientId string) *AccountsAdunitsListCall {
- c := &AccountsAdunitsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- return c
-}
-
-// IncludeInactive sets the optional parameter "includeInactive":
-// Whether to include inactive ad units. Default: true.
-func (c *AccountsAdunitsListCall) IncludeInactive(includeInactive bool) *AccountsAdunitsListCall {
- c.opt_["includeInactive"] = includeInactive
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of ad units to include in the response, used for paging.
-func (c *AccountsAdunitsListCall) MaxResults(maxResults int64) *AccountsAdunitsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad units. To retrieve the next page, set
-// this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AccountsAdunitsListCall) PageToken(pageToken string) *AccountsAdunitsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAdunitsListCall) Fields(s ...googleapi.Field) *AccountsAdunitsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsAdunitsListCall) IfNoneMatch(entityTag string) *AccountsAdunitsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAdunitsListCall) Context(ctx context.Context) *AccountsAdunitsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAdunitsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["includeInactive"]; ok {
- params.Set("includeInactive", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/adunits")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.adunits.list" call.
-// Exactly one of *AdUnits or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnits.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsAdunitsListCall) Do() (*AdUnits, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnits{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all ad units in the specified ad client for the specified account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.adunits.list",
- // "parameterOrder": [
- // "accountId",
- // "adClientId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the ad client belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client for which to list ad units.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "includeInactive": {
- // "description": "Whether to include inactive ad units. Default: true.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "The maximum number of ad units to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
- // "response": {
- // "$ref": "AdUnits"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.adunits.customchannels.list":
-
-type AccountsAdunitsCustomchannelsListCall struct {
- s *Service
- accountId string
- adClientId string
- adUnitId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all custom channels which the specified ad unit belongs
-// to.
-func (r *AccountsAdunitsCustomchannelsService) List(accountId string, adClientId string, adUnitId string) *AccountsAdunitsCustomchannelsListCall {
- c := &AccountsAdunitsCustomchannelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- c.adUnitId = adUnitId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of custom channels to include in the response, used for
-// paging.
-func (c *AccountsAdunitsCustomchannelsListCall) MaxResults(maxResults int64) *AccountsAdunitsCustomchannelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through custom channels. To retrieve the next
-// page, set this parameter to the value of "nextPageToken" from the
-// previous response.
-func (c *AccountsAdunitsCustomchannelsListCall) PageToken(pageToken string) *AccountsAdunitsCustomchannelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAdunitsCustomchannelsListCall) Fields(s ...googleapi.Field) *AccountsAdunitsCustomchannelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsAdunitsCustomchannelsListCall) IfNoneMatch(entityTag string) *AccountsAdunitsCustomchannelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAdunitsCustomchannelsListCall) Context(ctx context.Context) *AccountsAdunitsCustomchannelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAdunitsCustomchannelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/customchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- "adUnitId": c.adUnitId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.adunits.customchannels.list" call.
-// Exactly one of *CustomChannels or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannels.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountsAdunitsCustomchannelsListCall) Do() (*CustomChannels, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannels{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all custom channels which the specified ad unit belongs to.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.adunits.customchannels.list",
- // "parameterOrder": [
- // "accountId",
- // "adClientId",
- // "adUnitId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the ad client belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client which contains the ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adUnitId": {
- // "description": "Ad unit for which to list custom channels.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of custom channels to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/customchannels",
- // "response": {
- // "$ref": "CustomChannels"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.customchannels.get":
-
-type AccountsCustomchannelsGetCall struct {
- s *Service
- accountId string
- adClientId string
- customChannelId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get the specified custom channel from the specified ad client
-// for the specified account.
-func (r *AccountsCustomchannelsService) Get(accountId string, adClientId string, customChannelId string) *AccountsCustomchannelsGetCall {
- c := &AccountsCustomchannelsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- c.customChannelId = customChannelId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsCustomchannelsGetCall) Fields(s ...googleapi.Field) *AccountsCustomchannelsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsCustomchannelsGetCall) IfNoneMatch(entityTag string) *AccountsCustomchannelsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsCustomchannelsGetCall) Context(ctx context.Context) *AccountsCustomchannelsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsCustomchannelsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- "customChannelId": c.customChannelId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.customchannels.get" call.
-// Exactly one of *CustomChannel or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannel.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountsCustomchannelsGetCall) Do() (*CustomChannel, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannel{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get the specified custom channel from the specified ad client for the specified account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.customchannels.get",
- // "parameterOrder": [
- // "accountId",
- // "adClientId",
- // "customChannelId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the ad client belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client which contains the custom channel.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "customChannelId": {
- // "description": "Custom channel to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}",
- // "response": {
- // "$ref": "CustomChannel"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.customchannels.list":
-
-type AccountsCustomchannelsListCall struct {
- s *Service
- accountId string
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all custom channels in the specified ad client for the
-// specified account.
-func (r *AccountsCustomchannelsService) List(accountId string, adClientId string) *AccountsCustomchannelsListCall {
- c := &AccountsCustomchannelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of custom channels to include in the response, used for
-// paging.
-func (c *AccountsCustomchannelsListCall) MaxResults(maxResults int64) *AccountsCustomchannelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through custom channels. To retrieve the next
-// page, set this parameter to the value of "nextPageToken" from the
-// previous response.
-func (c *AccountsCustomchannelsListCall) PageToken(pageToken string) *AccountsCustomchannelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsCustomchannelsListCall) Fields(s ...googleapi.Field) *AccountsCustomchannelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsCustomchannelsListCall) IfNoneMatch(entityTag string) *AccountsCustomchannelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsCustomchannelsListCall) Context(ctx context.Context) *AccountsCustomchannelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsCustomchannelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/customchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.customchannels.list" call.
-// Exactly one of *CustomChannels or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannels.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountsCustomchannelsListCall) Do() (*CustomChannels, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannels{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all custom channels in the specified ad client for the specified account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.customchannels.list",
- // "parameterOrder": [
- // "accountId",
- // "adClientId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the ad client belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client for which to list custom channels.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of custom channels to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/customchannels",
- // "response": {
- // "$ref": "CustomChannels"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.customchannels.adunits.list":
-
-type AccountsCustomchannelsAdunitsListCall struct {
- s *Service
- accountId string
- adClientId string
- customChannelId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all ad units in the specified custom channel.
-func (r *AccountsCustomchannelsAdunitsService) List(accountId string, adClientId string, customChannelId string) *AccountsCustomchannelsAdunitsListCall {
- c := &AccountsCustomchannelsAdunitsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- c.customChannelId = customChannelId
- return c
-}
-
-// IncludeInactive sets the optional parameter "includeInactive":
-// Whether to include inactive ad units. Default: true.
-func (c *AccountsCustomchannelsAdunitsListCall) IncludeInactive(includeInactive bool) *AccountsCustomchannelsAdunitsListCall {
- c.opt_["includeInactive"] = includeInactive
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of ad units to include in the response, used for paging.
-func (c *AccountsCustomchannelsAdunitsListCall) MaxResults(maxResults int64) *AccountsCustomchannelsAdunitsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad units. To retrieve the next page, set
-// this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AccountsCustomchannelsAdunitsListCall) PageToken(pageToken string) *AccountsCustomchannelsAdunitsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsCustomchannelsAdunitsListCall) Fields(s ...googleapi.Field) *AccountsCustomchannelsAdunitsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsCustomchannelsAdunitsListCall) IfNoneMatch(entityTag string) *AccountsCustomchannelsAdunitsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsCustomchannelsAdunitsListCall) Context(ctx context.Context) *AccountsCustomchannelsAdunitsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsCustomchannelsAdunitsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["includeInactive"]; ok {
- params.Set("includeInactive", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}/adunits")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- "customChannelId": c.customChannelId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.customchannels.adunits.list" call.
-// Exactly one of *AdUnits or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnits.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsCustomchannelsAdunitsListCall) Do() (*AdUnits, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnits{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all ad units in the specified custom channel.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.customchannels.adunits.list",
- // "parameterOrder": [
- // "accountId",
- // "adClientId",
- // "customChannelId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the ad client belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client which contains the custom channel.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "customChannelId": {
- // "description": "Custom channel for which to list ad units.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "includeInactive": {
- // "description": "Whether to include inactive ad units. Default: true.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "The maximum number of ad units to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}/adunits",
- // "response": {
- // "$ref": "AdUnits"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.reports.generate":
-
-type AccountsReportsGenerateCall struct {
- s *Service
- accountId string
- startDate string
- endDate string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Generate: Generate an AdSense report based on the report request sent
-// in the query parameters. Returns the result as JSON; to retrieve
-// output in CSV format specify "alt=csv" as a query parameter.
-func (r *AccountsReportsService) Generate(accountId string, startDate string, endDate string) *AccountsReportsGenerateCall {
- c := &AccountsReportsGenerateCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.startDate = startDate
- c.endDate = endDate
- return c
-}
-
-// Currency sets the optional parameter "currency": Optional currency to
-// use when reporting on monetary metrics. Defaults to the account's
-// currency if not set.
-func (c *AccountsReportsGenerateCall) Currency(currency string) *AccountsReportsGenerateCall {
- c.opt_["currency"] = currency
- return c
-}
-
-// Dimension sets the optional parameter "dimension": Dimensions to base
-// the report on.
-func (c *AccountsReportsGenerateCall) Dimension(dimension string) *AccountsReportsGenerateCall {
- c.opt_["dimension"] = dimension
- return c
-}
-
-// Filter sets the optional parameter "filter": Filters to be run on the
-// report.
-func (c *AccountsReportsGenerateCall) Filter(filter string) *AccountsReportsGenerateCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// Locale sets the optional parameter "locale": Optional locale to use
-// for translating report output to a local language. Defaults to
-// "en_US" if not specified.
-func (c *AccountsReportsGenerateCall) Locale(locale string) *AccountsReportsGenerateCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of rows of report data to return.
-func (c *AccountsReportsGenerateCall) MaxResults(maxResults int64) *AccountsReportsGenerateCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// Metric sets the optional parameter "metric": Numeric columns to
-// include in the report.
-func (c *AccountsReportsGenerateCall) Metric(metric string) *AccountsReportsGenerateCall {
- c.opt_["metric"] = metric
- return c
-}
-
-// Sort sets the optional parameter "sort": The name of a dimension or
-// metric to sort the resulting report on, optionally prefixed with "+"
-// to sort ascending or "-" to sort descending. If no prefix is
-// specified, the column is sorted ascending.
-func (c *AccountsReportsGenerateCall) Sort(sort string) *AccountsReportsGenerateCall {
- c.opt_["sort"] = sort
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex": Index of the
-// first row of report data to return.
-func (c *AccountsReportsGenerateCall) StartIndex(startIndex int64) *AccountsReportsGenerateCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsReportsGenerateCall) Fields(s ...googleapi.Field) *AccountsReportsGenerateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsReportsGenerateCall) IfNoneMatch(entityTag string) *AccountsReportsGenerateCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do and Download methods.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsReportsGenerateCall) Context(ctx context.Context) *AccountsReportsGenerateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsReportsGenerateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("endDate", fmt.Sprintf("%v", c.endDate))
- params.Set("startDate", fmt.Sprintf("%v", c.startDate))
- if v, ok := c.opt_["currency"]; ok {
- params.Set("currency", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["dimension"]; ok {
- params.Set("dimension", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["metric"]; ok {
- params.Set("metric", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sort"]; ok {
- params.Set("sort", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/reports")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Download fetches the API endpoint's "media" value, instead of the normal
-// API response value. If the returned error is nil, the Response is guaranteed to
-// have a 2xx status code. Callers must close the Response.Body as usual.
-func (c *AccountsReportsGenerateCall) Download() (*http.Response, error) {
- res, err := c.doRequest("media")
- if err != nil {
- return nil, err
- }
- if err := googleapi.CheckMediaResponse(res); err != nil {
- res.Body.Close()
- return nil, err
- }
- return res, nil
-}
-
-// Do executes the "adsense.accounts.reports.generate" call.
-// Exactly one of *AdsenseReportsGenerateResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *AdsenseReportsGenerateResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountsReportsGenerateCall) Do() (*AdsenseReportsGenerateResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdsenseReportsGenerateResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.reports.generate",
- // "parameterOrder": [
- // "accountId",
- // "startDate",
- // "endDate"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account upon which to report.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "currency": {
- // "description": "Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.",
- // "location": "query",
- // "pattern": "[a-zA-Z]+",
- // "type": "string"
- // },
- // "dimension": {
- // "description": "Dimensions to base the report on.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "endDate": {
- // "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- // "location": "query",
- // "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- // "required": true,
- // "type": "string"
- // },
- // "filter": {
- // "description": "Filters to be run on the report.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+(==|=@).+",
- // "repeated": true,
- // "type": "string"
- // },
- // "locale": {
- // "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of rows of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "50000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "metric": {
- // "description": "Numeric columns to include in the report.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "sort": {
- // "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
- // "location": "query",
- // "pattern": "(\\+|-)?[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "startDate": {
- // "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- // "location": "query",
- // "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- // "required": true,
- // "type": "string"
- // },
- // "startIndex": {
- // "description": "Index of the first row of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "5000",
- // "minimum": "0",
- // "type": "integer"
- // }
- // },
- // "path": "accounts/{accountId}/reports",
- // "response": {
- // "$ref": "AdsenseReportsGenerateResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ],
- // "supportsMediaDownload": true
- // }
-
-}
-
-// method id "adsense.accounts.reports.saved.generate":
-
-type AccountsReportsSavedGenerateCall struct {
- s *Service
- accountId string
- savedReportId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Generate: Generate an AdSense report based on the saved report ID
-// sent in the query parameters.
-func (r *AccountsReportsSavedService) Generate(accountId string, savedReportId string) *AccountsReportsSavedGenerateCall {
- c := &AccountsReportsSavedGenerateCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.savedReportId = savedReportId
- return c
-}
-
-// Locale sets the optional parameter "locale": Optional locale to use
-// for translating report output to a local language. Defaults to
-// "en_US" if not specified.
-func (c *AccountsReportsSavedGenerateCall) Locale(locale string) *AccountsReportsSavedGenerateCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of rows of report data to return.
-func (c *AccountsReportsSavedGenerateCall) MaxResults(maxResults int64) *AccountsReportsSavedGenerateCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex": Index of the
-// first row of report data to return.
-func (c *AccountsReportsSavedGenerateCall) StartIndex(startIndex int64) *AccountsReportsSavedGenerateCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsReportsSavedGenerateCall) Fields(s ...googleapi.Field) *AccountsReportsSavedGenerateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsReportsSavedGenerateCall) IfNoneMatch(entityTag string) *AccountsReportsSavedGenerateCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsReportsSavedGenerateCall) Context(ctx context.Context) *AccountsReportsSavedGenerateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsReportsSavedGenerateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/reports/{savedReportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "savedReportId": c.savedReportId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.reports.saved.generate" call.
-// Exactly one of *AdsenseReportsGenerateResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *AdsenseReportsGenerateResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountsReportsSavedGenerateCall) Do() (*AdsenseReportsGenerateResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdsenseReportsGenerateResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Generate an AdSense report based on the saved report ID sent in the query parameters.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.reports.saved.generate",
- // "parameterOrder": [
- // "accountId",
- // "savedReportId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the saved reports belong.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "locale": {
- // "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of rows of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "50000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "savedReportId": {
- // "description": "The saved report to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "startIndex": {
- // "description": "Index of the first row of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "5000",
- // "minimum": "0",
- // "type": "integer"
- // }
- // },
- // "path": "accounts/{accountId}/reports/{savedReportId}",
- // "response": {
- // "$ref": "AdsenseReportsGenerateResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.reports.saved.list":
-
-type AccountsReportsSavedListCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all saved reports in the specified AdSense account.
-func (r *AccountsReportsSavedService) List(accountId string) *AccountsReportsSavedListCall {
- c := &AccountsReportsSavedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of saved reports to include in the response, used for paging.
-func (c *AccountsReportsSavedListCall) MaxResults(maxResults int64) *AccountsReportsSavedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through saved reports. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AccountsReportsSavedListCall) PageToken(pageToken string) *AccountsReportsSavedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsReportsSavedListCall) Fields(s ...googleapi.Field) *AccountsReportsSavedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsReportsSavedListCall) IfNoneMatch(entityTag string) *AccountsReportsSavedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsReportsSavedListCall) Context(ctx context.Context) *AccountsReportsSavedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsReportsSavedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/reports/saved")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.reports.saved.list" call.
-// Exactly one of *SavedReports or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *SavedReports.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccountsReportsSavedListCall) Do() (*SavedReports, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SavedReports{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all saved reports in the specified AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.reports.saved.list",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the saved reports belong.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of saved reports to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "100",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/reports/saved",
- // "response": {
- // "$ref": "SavedReports"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.savedadstyles.get":
-
-type AccountsSavedadstylesGetCall struct {
- s *Service
- accountId string
- savedAdStyleId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: List a specific saved ad style for the specified account.
-func (r *AccountsSavedadstylesService) Get(accountId string, savedAdStyleId string) *AccountsSavedadstylesGetCall {
- c := &AccountsSavedadstylesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.savedAdStyleId = savedAdStyleId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsSavedadstylesGetCall) Fields(s ...googleapi.Field) *AccountsSavedadstylesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsSavedadstylesGetCall) IfNoneMatch(entityTag string) *AccountsSavedadstylesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsSavedadstylesGetCall) Context(ctx context.Context) *AccountsSavedadstylesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsSavedadstylesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/savedadstyles/{savedAdStyleId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "savedAdStyleId": c.savedAdStyleId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.savedadstyles.get" call.
-// Exactly one of *SavedAdStyle or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *SavedAdStyle.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccountsSavedadstylesGetCall) Do() (*SavedAdStyle, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SavedAdStyle{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List a specific saved ad style for the specified account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.savedadstyles.get",
- // "parameterOrder": [
- // "accountId",
- // "savedAdStyleId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account for which to get the saved ad style.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "savedAdStyleId": {
- // "description": "Saved ad style to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/savedadstyles/{savedAdStyleId}",
- // "response": {
- // "$ref": "SavedAdStyle"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.savedadstyles.list":
-
-type AccountsSavedadstylesListCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all saved ad styles in the specified account.
-func (r *AccountsSavedadstylesService) List(accountId string) *AccountsSavedadstylesListCall {
- c := &AccountsSavedadstylesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of saved ad styles to include in the response, used for
-// paging.
-func (c *AccountsSavedadstylesListCall) MaxResults(maxResults int64) *AccountsSavedadstylesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through saved ad styles. To retrieve the next
-// page, set this parameter to the value of "nextPageToken" from the
-// previous response.
-func (c *AccountsSavedadstylesListCall) PageToken(pageToken string) *AccountsSavedadstylesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsSavedadstylesListCall) Fields(s ...googleapi.Field) *AccountsSavedadstylesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsSavedadstylesListCall) IfNoneMatch(entityTag string) *AccountsSavedadstylesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsSavedadstylesListCall) Context(ctx context.Context) *AccountsSavedadstylesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsSavedadstylesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/savedadstyles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.savedadstyles.list" call.
-// Exactly one of *SavedAdStyles or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *SavedAdStyles.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountsSavedadstylesListCall) Do() (*SavedAdStyles, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SavedAdStyles{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all saved ad styles in the specified account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.savedadstyles.list",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account for which to list saved ad styles.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of saved ad styles to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/savedadstyles",
- // "response": {
- // "$ref": "SavedAdStyles"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.urlchannels.list":
-
-type AccountsUrlchannelsListCall struct {
- s *Service
- accountId string
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all URL channels in the specified ad client for the
-// specified account.
-func (r *AccountsUrlchannelsService) List(accountId string, adClientId string) *AccountsUrlchannelsListCall {
- c := &AccountsUrlchannelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of URL channels to include in the response, used for paging.
-func (c *AccountsUrlchannelsListCall) MaxResults(maxResults int64) *AccountsUrlchannelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through URL channels. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AccountsUrlchannelsListCall) PageToken(pageToken string) *AccountsUrlchannelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsUrlchannelsListCall) Fields(s ...googleapi.Field) *AccountsUrlchannelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsUrlchannelsListCall) IfNoneMatch(entityTag string) *AccountsUrlchannelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsUrlchannelsListCall) Context(ctx context.Context) *AccountsUrlchannelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsUrlchannelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/urlchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.urlchannels.list" call.
-// Exactly one of *UrlChannels or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UrlChannels.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccountsUrlchannelsListCall) Do() (*UrlChannels, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UrlChannels{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all URL channels in the specified ad client for the specified account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.urlchannels.list",
- // "parameterOrder": [
- // "accountId",
- // "adClientId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the ad client belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client for which to list URL channels.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of URL channels to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/urlchannels",
- // "response": {
- // "$ref": "UrlChannels"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.adclients.list":
-
-type AdclientsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all ad clients in this AdSense account.
-func (r *AdclientsService) List() *AdclientsListCall {
- c := &AdclientsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of ad clients to include in the response, used for paging.
-func (c *AdclientsListCall) MaxResults(maxResults int64) *AdclientsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad clients. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AdclientsListCall) PageToken(pageToken string) *AdclientsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdclientsListCall) Fields(s ...googleapi.Field) *AdclientsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdclientsListCall) IfNoneMatch(entityTag string) *AdclientsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdclientsListCall) Context(ctx context.Context) *AdclientsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdclientsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.adclients.list" call.
-// Exactly one of *AdClients or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AdClients.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AdclientsListCall) Do() (*AdClients, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdClients{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all ad clients in this AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.adclients.list",
- // "parameters": {
- // "maxResults": {
- // "description": "The maximum number of ad clients to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients",
- // "response": {
- // "$ref": "AdClients"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.adunits.get":
-
-type AdunitsGetCall struct {
- s *Service
- adClientId string
- adUnitId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets the specified ad unit in the specified ad client.
-func (r *AdunitsService) Get(adClientId string, adUnitId string) *AdunitsGetCall {
- c := &AdunitsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.adUnitId = adUnitId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdunitsGetCall) Fields(s ...googleapi.Field) *AdunitsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdunitsGetCall) IfNoneMatch(entityTag string) *AdunitsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdunitsGetCall) Context(ctx context.Context) *AdunitsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdunitsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/adunits/{adUnitId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- "adUnitId": c.adUnitId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.adunits.get" call.
-// Exactly one of *AdUnit or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnit.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AdunitsGetCall) Do() (*AdUnit, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnit{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the specified ad unit in the specified ad client.",
- // "httpMethod": "GET",
- // "id": "adsense.adunits.get",
- // "parameterOrder": [
- // "adClientId",
- // "adUnitId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client for which to get the ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adUnitId": {
- // "description": "Ad unit to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/adunits/{adUnitId}",
- // "response": {
- // "$ref": "AdUnit"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.adunits.list":
-
-type AdunitsListCall struct {
- s *Service
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all ad units in the specified ad client for this AdSense
-// account.
-func (r *AdunitsService) List(adClientId string) *AdunitsListCall {
- c := &AdunitsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- return c
-}
-
-// IncludeInactive sets the optional parameter "includeInactive":
-// Whether to include inactive ad units. Default: true.
-func (c *AdunitsListCall) IncludeInactive(includeInactive bool) *AdunitsListCall {
- c.opt_["includeInactive"] = includeInactive
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of ad units to include in the response, used for paging.
-func (c *AdunitsListCall) MaxResults(maxResults int64) *AdunitsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad units. To retrieve the next page, set
-// this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AdunitsListCall) PageToken(pageToken string) *AdunitsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdunitsListCall) Fields(s ...googleapi.Field) *AdunitsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdunitsListCall) IfNoneMatch(entityTag string) *AdunitsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdunitsListCall) Context(ctx context.Context) *AdunitsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdunitsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["includeInactive"]; ok {
- params.Set("includeInactive", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/adunits")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.adunits.list" call.
-// Exactly one of *AdUnits or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnits.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AdunitsListCall) Do() (*AdUnits, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnits{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all ad units in the specified ad client for this AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.adunits.list",
- // "parameterOrder": [
- // "adClientId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client for which to list ad units.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "includeInactive": {
- // "description": "Whether to include inactive ad units. Default: true.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "The maximum number of ad units to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/adunits",
- // "response": {
- // "$ref": "AdUnits"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.adunits.customchannels.list":
-
-type AdunitsCustomchannelsListCall struct {
- s *Service
- adClientId string
- adUnitId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all custom channels which the specified ad unit belongs
-// to.
-func (r *AdunitsCustomchannelsService) List(adClientId string, adUnitId string) *AdunitsCustomchannelsListCall {
- c := &AdunitsCustomchannelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.adUnitId = adUnitId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of custom channels to include in the response, used for
-// paging.
-func (c *AdunitsCustomchannelsListCall) MaxResults(maxResults int64) *AdunitsCustomchannelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through custom channels. To retrieve the next
-// page, set this parameter to the value of "nextPageToken" from the
-// previous response.
-func (c *AdunitsCustomchannelsListCall) PageToken(pageToken string) *AdunitsCustomchannelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdunitsCustomchannelsListCall) Fields(s ...googleapi.Field) *AdunitsCustomchannelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdunitsCustomchannelsListCall) IfNoneMatch(entityTag string) *AdunitsCustomchannelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdunitsCustomchannelsListCall) Context(ctx context.Context) *AdunitsCustomchannelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdunitsCustomchannelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/adunits/{adUnitId}/customchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- "adUnitId": c.adUnitId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.adunits.customchannels.list" call.
-// Exactly one of *CustomChannels or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannels.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AdunitsCustomchannelsListCall) Do() (*CustomChannels, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannels{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all custom channels which the specified ad unit belongs to.",
- // "httpMethod": "GET",
- // "id": "adsense.adunits.customchannels.list",
- // "parameterOrder": [
- // "adClientId",
- // "adUnitId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client which contains the ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adUnitId": {
- // "description": "Ad unit for which to list custom channels.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of custom channels to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/adunits/{adUnitId}/customchannels",
- // "response": {
- // "$ref": "CustomChannels"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.customchannels.get":
-
-type CustomchannelsGetCall struct {
- s *Service
- adClientId string
- customChannelId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get the specified custom channel from the specified ad client.
-func (r *CustomchannelsService) Get(adClientId string, customChannelId string) *CustomchannelsGetCall {
- c := &CustomchannelsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.customChannelId = customChannelId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CustomchannelsGetCall) Fields(s ...googleapi.Field) *CustomchannelsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CustomchannelsGetCall) IfNoneMatch(entityTag string) *CustomchannelsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CustomchannelsGetCall) Context(ctx context.Context) *CustomchannelsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CustomchannelsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/customchannels/{customChannelId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- "customChannelId": c.customChannelId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.customchannels.get" call.
-// Exactly one of *CustomChannel or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannel.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CustomchannelsGetCall) Do() (*CustomChannel, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannel{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get the specified custom channel from the specified ad client.",
- // "httpMethod": "GET",
- // "id": "adsense.customchannels.get",
- // "parameterOrder": [
- // "adClientId",
- // "customChannelId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client which contains the custom channel.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "customChannelId": {
- // "description": "Custom channel to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/customchannels/{customChannelId}",
- // "response": {
- // "$ref": "CustomChannel"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.customchannels.list":
-
-type CustomchannelsListCall struct {
- s *Service
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all custom channels in the specified ad client for this
-// AdSense account.
-func (r *CustomchannelsService) List(adClientId string) *CustomchannelsListCall {
- c := &CustomchannelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of custom channels to include in the response, used for
-// paging.
-func (c *CustomchannelsListCall) MaxResults(maxResults int64) *CustomchannelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through custom channels. To retrieve the next
-// page, set this parameter to the value of "nextPageToken" from the
-// previous response.
-func (c *CustomchannelsListCall) PageToken(pageToken string) *CustomchannelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CustomchannelsListCall) Fields(s ...googleapi.Field) *CustomchannelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CustomchannelsListCall) IfNoneMatch(entityTag string) *CustomchannelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CustomchannelsListCall) Context(ctx context.Context) *CustomchannelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CustomchannelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/customchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.customchannels.list" call.
-// Exactly one of *CustomChannels or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannels.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CustomchannelsListCall) Do() (*CustomChannels, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannels{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all custom channels in the specified ad client for this AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.customchannels.list",
- // "parameterOrder": [
- // "adClientId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client for which to list custom channels.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of custom channels to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/customchannels",
- // "response": {
- // "$ref": "CustomChannels"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.customchannels.adunits.list":
-
-type CustomchannelsAdunitsListCall struct {
- s *Service
- adClientId string
- customChannelId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all ad units in the specified custom channel.
-func (r *CustomchannelsAdunitsService) List(adClientId string, customChannelId string) *CustomchannelsAdunitsListCall {
- c := &CustomchannelsAdunitsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.customChannelId = customChannelId
- return c
-}
-
-// IncludeInactive sets the optional parameter "includeInactive":
-// Whether to include inactive ad units. Default: true.
-func (c *CustomchannelsAdunitsListCall) IncludeInactive(includeInactive bool) *CustomchannelsAdunitsListCall {
- c.opt_["includeInactive"] = includeInactive
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of ad units to include in the response, used for paging.
-func (c *CustomchannelsAdunitsListCall) MaxResults(maxResults int64) *CustomchannelsAdunitsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad units. To retrieve the next page, set
-// this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *CustomchannelsAdunitsListCall) PageToken(pageToken string) *CustomchannelsAdunitsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CustomchannelsAdunitsListCall) Fields(s ...googleapi.Field) *CustomchannelsAdunitsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CustomchannelsAdunitsListCall) IfNoneMatch(entityTag string) *CustomchannelsAdunitsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CustomchannelsAdunitsListCall) Context(ctx context.Context) *CustomchannelsAdunitsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CustomchannelsAdunitsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["includeInactive"]; ok {
- params.Set("includeInactive", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/customchannels/{customChannelId}/adunits")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- "customChannelId": c.customChannelId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.customchannels.adunits.list" call.
-// Exactly one of *AdUnits or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnits.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *CustomchannelsAdunitsListCall) Do() (*AdUnits, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnits{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all ad units in the specified custom channel.",
- // "httpMethod": "GET",
- // "id": "adsense.customchannels.adunits.list",
- // "parameterOrder": [
- // "adClientId",
- // "customChannelId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client which contains the custom channel.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "customChannelId": {
- // "description": "Custom channel for which to list ad units.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "includeInactive": {
- // "description": "Whether to include inactive ad units. Default: true.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "The maximum number of ad units to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/customchannels/{customChannelId}/adunits",
- // "response": {
- // "$ref": "AdUnits"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.reports.generate":
-
-type ReportsGenerateCall struct {
- s *Service
- startDate string
- endDate string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Generate: Generate an AdSense report based on the report request sent
-// in the query parameters. Returns the result as JSON; to retrieve
-// output in CSV format specify "alt=csv" as a query parameter.
-func (r *ReportsService) Generate(startDate string, endDate string) *ReportsGenerateCall {
- c := &ReportsGenerateCall{s: r.s, opt_: make(map[string]interface{})}
- c.startDate = startDate
- c.endDate = endDate
- return c
-}
-
-// AccountId sets the optional parameter "accountId": Accounts upon
-// which to report.
-func (c *ReportsGenerateCall) AccountId(accountId string) *ReportsGenerateCall {
- c.opt_["accountId"] = accountId
- return c
-}
-
-// Currency sets the optional parameter "currency": Optional currency to
-// use when reporting on monetary metrics. Defaults to the account's
-// currency if not set.
-func (c *ReportsGenerateCall) Currency(currency string) *ReportsGenerateCall {
- c.opt_["currency"] = currency
- return c
-}
-
-// Dimension sets the optional parameter "dimension": Dimensions to base
-// the report on.
-func (c *ReportsGenerateCall) Dimension(dimension string) *ReportsGenerateCall {
- c.opt_["dimension"] = dimension
- return c
-}
-
-// Filter sets the optional parameter "filter": Filters to be run on the
-// report.
-func (c *ReportsGenerateCall) Filter(filter string) *ReportsGenerateCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// Locale sets the optional parameter "locale": Optional locale to use
-// for translating report output to a local language. Defaults to
-// "en_US" if not specified.
-func (c *ReportsGenerateCall) Locale(locale string) *ReportsGenerateCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of rows of report data to return.
-func (c *ReportsGenerateCall) MaxResults(maxResults int64) *ReportsGenerateCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// Metric sets the optional parameter "metric": Numeric columns to
-// include in the report.
-func (c *ReportsGenerateCall) Metric(metric string) *ReportsGenerateCall {
- c.opt_["metric"] = metric
- return c
-}
-
-// Sort sets the optional parameter "sort": The name of a dimension or
-// metric to sort the resulting report on, optionally prefixed with "+"
-// to sort ascending or "-" to sort descending. If no prefix is
-// specified, the column is sorted ascending.
-func (c *ReportsGenerateCall) Sort(sort string) *ReportsGenerateCall {
- c.opt_["sort"] = sort
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex": Index of the
-// first row of report data to return.
-func (c *ReportsGenerateCall) StartIndex(startIndex int64) *ReportsGenerateCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsGenerateCall) Fields(s ...googleapi.Field) *ReportsGenerateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsGenerateCall) IfNoneMatch(entityTag string) *ReportsGenerateCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do and Download methods.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsGenerateCall) Context(ctx context.Context) *ReportsGenerateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsGenerateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("endDate", fmt.Sprintf("%v", c.endDate))
- params.Set("startDate", fmt.Sprintf("%v", c.startDate))
- if v, ok := c.opt_["accountId"]; ok {
- params.Set("accountId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["currency"]; ok {
- params.Set("currency", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["dimension"]; ok {
- params.Set("dimension", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["metric"]; ok {
- params.Set("metric", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sort"]; ok {
- params.Set("sort", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "reports")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Download fetches the API endpoint's "media" value, instead of the normal
-// API response value. If the returned error is nil, the Response is guaranteed to
-// have a 2xx status code. Callers must close the Response.Body as usual.
-func (c *ReportsGenerateCall) Download() (*http.Response, error) {
- res, err := c.doRequest("media")
- if err != nil {
- return nil, err
- }
- if err := googleapi.CheckMediaResponse(res); err != nil {
- res.Body.Close()
- return nil, err
- }
- return res, nil
-}
-
-// Do executes the "adsense.reports.generate" call.
-// Exactly one of *AdsenseReportsGenerateResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *AdsenseReportsGenerateResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ReportsGenerateCall) Do() (*AdsenseReportsGenerateResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdsenseReportsGenerateResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
- // "httpMethod": "GET",
- // "id": "adsense.reports.generate",
- // "parameterOrder": [
- // "startDate",
- // "endDate"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Accounts upon which to report.",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "currency": {
- // "description": "Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.",
- // "location": "query",
- // "pattern": "[a-zA-Z]+",
- // "type": "string"
- // },
- // "dimension": {
- // "description": "Dimensions to base the report on.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "endDate": {
- // "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- // "location": "query",
- // "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- // "required": true,
- // "type": "string"
- // },
- // "filter": {
- // "description": "Filters to be run on the report.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+(==|=@).+",
- // "repeated": true,
- // "type": "string"
- // },
- // "locale": {
- // "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of rows of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "50000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "metric": {
- // "description": "Numeric columns to include in the report.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "sort": {
- // "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
- // "location": "query",
- // "pattern": "(\\+|-)?[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "startDate": {
- // "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- // "location": "query",
- // "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- // "required": true,
- // "type": "string"
- // },
- // "startIndex": {
- // "description": "Index of the first row of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "5000",
- // "minimum": "0",
- // "type": "integer"
- // }
- // },
- // "path": "reports",
- // "response": {
- // "$ref": "AdsenseReportsGenerateResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ],
- // "supportsMediaDownload": true
- // }
-
-}
-
-// method id "adsense.reports.saved.generate":
-
-type ReportsSavedGenerateCall struct {
- s *Service
- savedReportId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Generate: Generate an AdSense report based on the saved report ID
-// sent in the query parameters.
-func (r *ReportsSavedService) Generate(savedReportId string) *ReportsSavedGenerateCall {
- c := &ReportsSavedGenerateCall{s: r.s, opt_: make(map[string]interface{})}
- c.savedReportId = savedReportId
- return c
-}
-
-// Locale sets the optional parameter "locale": Optional locale to use
-// for translating report output to a local language. Defaults to
-// "en_US" if not specified.
-func (c *ReportsSavedGenerateCall) Locale(locale string) *ReportsSavedGenerateCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of rows of report data to return.
-func (c *ReportsSavedGenerateCall) MaxResults(maxResults int64) *ReportsSavedGenerateCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex": Index of the
-// first row of report data to return.
-func (c *ReportsSavedGenerateCall) StartIndex(startIndex int64) *ReportsSavedGenerateCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsSavedGenerateCall) Fields(s ...googleapi.Field) *ReportsSavedGenerateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsSavedGenerateCall) IfNoneMatch(entityTag string) *ReportsSavedGenerateCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsSavedGenerateCall) Context(ctx context.Context) *ReportsSavedGenerateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsSavedGenerateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "reports/{savedReportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "savedReportId": c.savedReportId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.reports.saved.generate" call.
-// Exactly one of *AdsenseReportsGenerateResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *AdsenseReportsGenerateResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ReportsSavedGenerateCall) Do() (*AdsenseReportsGenerateResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdsenseReportsGenerateResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Generate an AdSense report based on the saved report ID sent in the query parameters.",
- // "httpMethod": "GET",
- // "id": "adsense.reports.saved.generate",
- // "parameterOrder": [
- // "savedReportId"
- // ],
- // "parameters": {
- // "locale": {
- // "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of rows of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "50000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "savedReportId": {
- // "description": "The saved report to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "startIndex": {
- // "description": "Index of the first row of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "5000",
- // "minimum": "0",
- // "type": "integer"
- // }
- // },
- // "path": "reports/{savedReportId}",
- // "response": {
- // "$ref": "AdsenseReportsGenerateResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.reports.saved.list":
-
-type ReportsSavedListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all saved reports in this AdSense account.
-func (r *ReportsSavedService) List() *ReportsSavedListCall {
- c := &ReportsSavedListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of saved reports to include in the response, used for paging.
-func (c *ReportsSavedListCall) MaxResults(maxResults int64) *ReportsSavedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through saved reports. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *ReportsSavedListCall) PageToken(pageToken string) *ReportsSavedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsSavedListCall) Fields(s ...googleapi.Field) *ReportsSavedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsSavedListCall) IfNoneMatch(entityTag string) *ReportsSavedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsSavedListCall) Context(ctx context.Context) *ReportsSavedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsSavedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "reports/saved")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.reports.saved.list" call.
-// Exactly one of *SavedReports or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *SavedReports.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ReportsSavedListCall) Do() (*SavedReports, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SavedReports{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all saved reports in this AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.reports.saved.list",
- // "parameters": {
- // "maxResults": {
- // "description": "The maximum number of saved reports to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "100",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "reports/saved",
- // "response": {
- // "$ref": "SavedReports"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.savedadstyles.get":
-
-type SavedadstylesGetCall struct {
- s *Service
- savedAdStyleId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get a specific saved ad style from the user's account.
-func (r *SavedadstylesService) Get(savedAdStyleId string) *SavedadstylesGetCall {
- c := &SavedadstylesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.savedAdStyleId = savedAdStyleId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SavedadstylesGetCall) Fields(s ...googleapi.Field) *SavedadstylesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SavedadstylesGetCall) IfNoneMatch(entityTag string) *SavedadstylesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SavedadstylesGetCall) Context(ctx context.Context) *SavedadstylesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SavedadstylesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "savedadstyles/{savedAdStyleId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "savedAdStyleId": c.savedAdStyleId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.savedadstyles.get" call.
-// Exactly one of *SavedAdStyle or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *SavedAdStyle.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *SavedadstylesGetCall) Do() (*SavedAdStyle, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SavedAdStyle{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get a specific saved ad style from the user's account.",
- // "httpMethod": "GET",
- // "id": "adsense.savedadstyles.get",
- // "parameterOrder": [
- // "savedAdStyleId"
- // ],
- // "parameters": {
- // "savedAdStyleId": {
- // "description": "Saved ad style to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "savedadstyles/{savedAdStyleId}",
- // "response": {
- // "$ref": "SavedAdStyle"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.savedadstyles.list":
-
-type SavedadstylesListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all saved ad styles in the user's account.
-func (r *SavedadstylesService) List() *SavedadstylesListCall {
- c := &SavedadstylesListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of saved ad styles to include in the response, used for
-// paging.
-func (c *SavedadstylesListCall) MaxResults(maxResults int64) *SavedadstylesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through saved ad styles. To retrieve the next
-// page, set this parameter to the value of "nextPageToken" from the
-// previous response.
-func (c *SavedadstylesListCall) PageToken(pageToken string) *SavedadstylesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SavedadstylesListCall) Fields(s ...googleapi.Field) *SavedadstylesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SavedadstylesListCall) IfNoneMatch(entityTag string) *SavedadstylesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SavedadstylesListCall) Context(ctx context.Context) *SavedadstylesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SavedadstylesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "savedadstyles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.savedadstyles.list" call.
-// Exactly one of *SavedAdStyles or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *SavedAdStyles.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *SavedadstylesListCall) Do() (*SavedAdStyles, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SavedAdStyles{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all saved ad styles in the user's account.",
- // "httpMethod": "GET",
- // "id": "adsense.savedadstyles.list",
- // "parameters": {
- // "maxResults": {
- // "description": "The maximum number of saved ad styles to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "savedadstyles",
- // "response": {
- // "$ref": "SavedAdStyles"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.urlchannels.list":
-
-type UrlchannelsListCall struct {
- s *Service
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all URL channels in the specified ad client for this
-// AdSense account.
-func (r *UrlchannelsService) List(adClientId string) *UrlchannelsListCall {
- c := &UrlchannelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of URL channels to include in the response, used for paging.
-func (c *UrlchannelsListCall) MaxResults(maxResults int64) *UrlchannelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through URL channels. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *UrlchannelsListCall) PageToken(pageToken string) *UrlchannelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UrlchannelsListCall) Fields(s ...googleapi.Field) *UrlchannelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UrlchannelsListCall) IfNoneMatch(entityTag string) *UrlchannelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UrlchannelsListCall) Context(ctx context.Context) *UrlchannelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UrlchannelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/urlchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.urlchannels.list" call.
-// Exactly one of *UrlChannels or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UrlChannels.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UrlchannelsListCall) Do() (*UrlChannels, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UrlChannels{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all URL channels in the specified ad client for this AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.urlchannels.list",
- // "parameterOrder": [
- // "adClientId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client for which to list URL channels.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of URL channels to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/urlchannels",
- // "response": {
- // "$ref": "UrlChannels"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/adsense/v1.3/adsense-api.json b/vendor/google.golang.org/api/adsense/v1.3/adsense-api.json
deleted file mode 100644
index 1bcbaef8..00000000
--- a/vendor/google.golang.org/api/adsense/v1.3/adsense-api.json
+++ /dev/null
@@ -1,2250 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/gTf3J_Tcqy5jzBteF-x9VlOxF-c\"",
- "discoveryVersion": "v1",
- "id": "adsense:v1.3",
- "name": "adsense",
- "canonicalName": "AdSense",
- "version": "v1.3",
- "revision": "20141218",
- "title": "AdSense Management API",
- "description": "Gives AdSense publishers access to their inventory and the ability to generate reports",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/adsense-16.png",
- "x32": "https://www.google.com/images/icons/product/adsense-32.png"
- },
- "documentationLink": "https://developers.google.com/adsense/management/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/adsense/v1.3/",
- "basePath": "/adsense/v1.3/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "adsense/v1.3/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "csv",
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of text/csv",
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/adsense": {
- "description": "View and manage your AdSense data"
- },
- "https://www.googleapis.com/auth/adsense.readonly": {
- "description": "View your AdSense data"
- }
- }
- }
- },
- "schemas": {
- "Account": {
- "id": "Account",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this account."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#account.",
- "default": "adsense#account"
- },
- "name": {
- "type": "string",
- "description": "Name of this account."
- },
- "premium": {
- "type": "boolean",
- "description": "Whether this account is premium."
- },
- "subAccounts": {
- "type": "array",
- "description": "Sub accounts of the this account.",
- "items": {
- "$ref": "Account"
- }
- }
- }
- },
- "Accounts": {
- "id": "Accounts",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The accounts returned in this list response.",
- "items": {
- "$ref": "Account"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#accounts.",
- "default": "adsense#accounts"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through accounts. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "AdClient": {
- "id": "AdClient",
- "type": "object",
- "properties": {
- "arcOptIn": {
- "type": "boolean",
- "description": "Whether this ad client is opted in to ARC."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this ad client."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#adClient.",
- "default": "adsense#adClient"
- },
- "productCode": {
- "type": "string",
- "description": "This ad client's product code, which corresponds to the PRODUCT_CODE report dimension."
- },
- "supportsReporting": {
- "type": "boolean",
- "description": "Whether this ad client supports being reported on."
- }
- }
- },
- "AdClients": {
- "id": "AdClients",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The ad clients returned in this list response.",
- "items": {
- "$ref": "AdClient"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#adClients.",
- "default": "adsense#adClients"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "AdCode": {
- "id": "AdCode",
- "type": "object",
- "properties": {
- "adCode": {
- "type": "string",
- "description": "The ad code snippet."
- },
- "kind": {
- "type": "string",
- "description": "Kind this is, in this case adsense#adCode.",
- "default": "adsense#adCode"
- }
- }
- },
- "AdStyle": {
- "id": "AdStyle",
- "type": "object",
- "properties": {
- "colors": {
- "type": "object",
- "description": "The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.",
- "properties": {
- "background": {
- "type": "string",
- "description": "The color of the ad background."
- },
- "border": {
- "type": "string",
- "description": "The color of the ad border."
- },
- "text": {
- "type": "string",
- "description": "The color of the ad text."
- },
- "title": {
- "type": "string",
- "description": "The color of the ad title."
- },
- "url": {
- "type": "string",
- "description": "The color of the ad url."
- }
- }
- },
- "corners": {
- "type": "string",
- "description": "The style of the corners in the ad."
- },
- "font": {
- "type": "object",
- "description": "The font which is included in the style.",
- "properties": {
- "family": {
- "type": "string",
- "description": "The family of the font."
- },
- "size": {
- "type": "string",
- "description": "The size of the font."
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind this is, in this case adsense#adStyle.",
- "default": "adsense#adStyle"
- }
- }
- },
- "AdUnit": {
- "id": "AdUnit",
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "Identity code of this ad unit, not necessarily unique across ad clients."
- },
- "contentAdsSettings": {
- "type": "object",
- "description": "Settings specific to content ads (AFC) and highend mobile content ads (AFMC).",
- "properties": {
- "backupOption": {
- "type": "object",
- "description": "The backup option to be used in instances where no ad is available.",
- "properties": {
- "color": {
- "type": "string",
- "description": "Color to use when type is set to COLOR."
- },
- "type": {
- "type": "string",
- "description": "Type of the backup option. Possible values are BLANK, COLOR and URL."
- },
- "url": {
- "type": "string",
- "description": "URL to use when type is set to URL."
- }
- }
- },
- "size": {
- "type": "string",
- "description": "Size of this ad unit."
- },
- "type": {
- "type": "string",
- "description": "Type of this ad unit."
- }
- }
- },
- "customStyle": {
- "$ref": "AdStyle",
- "description": "Custom style information specific to this ad unit."
- },
- "feedAdsSettings": {
- "type": "object",
- "description": "Settings specific to feed ads (AFF).",
- "properties": {
- "adPosition": {
- "type": "string",
- "description": "The position of the ads relative to the feed entries."
- },
- "frequency": {
- "type": "integer",
- "description": "The frequency at which ads should appear in the feed (i.e. every N entries).",
- "format": "int32"
- },
- "minimumWordCount": {
- "type": "integer",
- "description": "The minimum length an entry should be in order to have attached ads.",
- "format": "int32"
- },
- "type": {
- "type": "string",
- "description": "The type of ads which should appear."
- }
- }
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#adUnit.",
- "default": "adsense#adUnit"
- },
- "mobileContentAdsSettings": {
- "type": "object",
- "description": "Settings specific to WAP mobile content ads (AFMC).",
- "properties": {
- "markupLanguage": {
- "type": "string",
- "description": "The markup language to use for this ad unit."
- },
- "scriptingLanguage": {
- "type": "string",
- "description": "The scripting language to use for this ad unit."
- },
- "size": {
- "type": "string",
- "description": "Size of this ad unit."
- },
- "type": {
- "type": "string",
- "description": "Type of this ad unit."
- }
- }
- },
- "name": {
- "type": "string",
- "description": "Name of this ad unit."
- },
- "savedStyleId": {
- "type": "string",
- "description": "ID of the saved ad style which holds this ad unit's style information."
- },
- "status": {
- "type": "string",
- "description": "Status of this ad unit. Possible values are:\nNEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.\n\nACTIVE: Indicates that there has been activity on this ad unit in the last seven days.\n\nINACTIVE: Indicates that there has been no activity on this ad unit in the last seven days."
- }
- }
- },
- "AdUnits": {
- "id": "AdUnits",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The ad units returned in this list response.",
- "items": {
- "$ref": "AdUnit"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#adUnits.",
- "default": "adsense#adUnits"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through ad units. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "AdsenseReportsGenerateResponse": {
- "id": "AdsenseReportsGenerateResponse",
- "type": "object",
- "properties": {
- "averages": {
- "type": "array",
- "description": "The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
- "items": {
- "type": "string"
- }
- },
- "headers": {
- "type": "array",
- "description": "The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.",
- "items": {
- "type": "object",
- "properties": {
- "currency": {
- "type": "string",
- "description": "The currency of this column. Only present if the header type is METRIC_CURRENCY."
- },
- "name": {
- "type": "string",
- "description": "The name of the header."
- },
- "type": {
- "type": "string",
- "description": "The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY."
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind this is, in this case adsense#report.",
- "default": "adsense#report"
- },
- "rows": {
- "type": "array",
- "description": "The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.",
- "items": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "totalMatchedRows": {
- "type": "string",
- "description": "The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.",
- "format": "int64"
- },
- "totals": {
- "type": "array",
- "description": "The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
- "items": {
- "type": "string"
- }
- },
- "warnings": {
- "type": "array",
- "description": "Any warnings associated with generation of the report.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "Alert": {
- "id": "Alert",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this alert. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#alert.",
- "default": "adsense#alert"
- },
- "message": {
- "type": "string",
- "description": "The localized alert message."
- },
- "severity": {
- "type": "string",
- "description": "Severity of this alert. Possible values: INFO, WARNING, SEVERE."
- },
- "type": {
- "type": "string",
- "description": "Type of this alert. Possible values: SELF_HOLD, MIGRATED_TO_BILLING3, ADDRESS_PIN_VERIFICATION, PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, GRAYLISTED_PUBLISHER, API_HOLD."
- }
- }
- },
- "Alerts": {
- "id": "Alerts",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "The alerts returned in this list response.",
- "items": {
- "$ref": "Alert"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#alerts.",
- "default": "adsense#alerts"
- }
- }
- },
- "CustomChannel": {
- "id": "CustomChannel",
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "Code of this custom channel, not necessarily unique across ad clients."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#customChannel.",
- "default": "adsense#customChannel"
- },
- "name": {
- "type": "string",
- "description": "Name of this custom channel."
- },
- "targetingInfo": {
- "type": "object",
- "description": "The targeting information of this custom channel, if activated.",
- "properties": {
- "adsAppearOn": {
- "type": "string",
- "description": "The name used to describe this channel externally."
- },
- "description": {
- "type": "string",
- "description": "The external description of the channel."
- },
- "location": {
- "type": "string",
- "description": "The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS."
- },
- "siteLanguage": {
- "type": "string",
- "description": "The language of the sites ads will be displayed on."
- }
- }
- }
- }
- },
- "CustomChannels": {
- "id": "CustomChannels",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The custom channels returned in this list response.",
- "items": {
- "$ref": "CustomChannel"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#customChannels.",
- "default": "adsense#customChannels"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "Metadata": {
- "id": "Metadata",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "items": {
- "$ref": "ReportingMetadataEntry"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#metadata.",
- "default": "adsense#metadata"
- }
- }
- },
- "ReportingMetadataEntry": {
- "id": "ReportingMetadataEntry",
- "type": "object",
- "properties": {
- "compatibleDimensions": {
- "type": "array",
- "description": "For metrics this is a list of dimension IDs which the metric is compatible with, for dimensions it is a list of compatibility groups the dimension belongs to.",
- "items": {
- "type": "string"
- }
- },
- "compatibleMetrics": {
- "type": "array",
- "description": "The names of the metrics the dimension or metric this reporting metadata entry describes is compatible with.",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this reporting metadata entry, corresponding to the name of the appropriate dimension or metric."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#reportingMetadataEntry.",
- "default": "adsense#reportingMetadataEntry"
- },
- "requiredDimensions": {
- "type": "array",
- "description": "The names of the dimensions which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.",
- "items": {
- "type": "string"
- }
- },
- "requiredMetrics": {
- "type": "array",
- "description": "The names of the metrics which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.",
- "items": {
- "type": "string"
- }
- },
- "supportedProducts": {
- "type": "array",
- "description": "The codes of the projects supported by the dimension or metric this reporting metadata entry describes.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "SavedAdStyle": {
- "id": "SavedAdStyle",
- "type": "object",
- "properties": {
- "adStyle": {
- "$ref": "AdStyle",
- "description": "The AdStyle itself."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#savedAdStyle.",
- "default": "adsense#savedAdStyle"
- },
- "name": {
- "type": "string",
- "description": "The user selected name of this SavedAdStyle."
- }
- }
- },
- "SavedAdStyles": {
- "id": "SavedAdStyles",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The saved ad styles returned in this list response.",
- "items": {
- "$ref": "SavedAdStyle"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#savedAdStyles.",
- "default": "adsense#savedAdStyles"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through ad units. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "SavedReport": {
- "id": "SavedReport",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this saved report."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#savedReport.",
- "default": "adsense#savedReport"
- },
- "name": {
- "type": "string",
- "description": "This saved report's name."
- }
- }
- },
- "SavedReports": {
- "id": "SavedReports",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The saved reports returned in this list response.",
- "items": {
- "$ref": "SavedReport"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#savedReports.",
- "default": "adsense#savedReports"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "UrlChannel": {
- "id": "UrlChannel",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#urlChannel.",
- "default": "adsense#urlChannel"
- },
- "urlPattern": {
- "type": "string",
- "description": "URL Pattern of this URL channel. Does not include \"http://\" or \"https://\". Example: www.example.com/home"
- }
- }
- },
- "UrlChannels": {
- "id": "UrlChannels",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The URL channels returned in this list response.",
- "items": {
- "$ref": "UrlChannel"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#urlChannels.",
- "default": "adsense#urlChannels"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- }
- },
- "resources": {
- "accounts": {
- "methods": {
- "get": {
- "id": "adsense.accounts.get",
- "path": "accounts/{accountId}",
- "httpMethod": "GET",
- "description": "Get information about the selected AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to get information about.",
- "required": true,
- "location": "path"
- },
- "tree": {
- "type": "boolean",
- "description": "Whether the tree of sub accounts should be returned.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.accounts.list",
- "path": "accounts",
- "httpMethod": "GET",
- "description": "List all accounts available to this AdSense account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of accounts to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through accounts. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Accounts"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- },
- "resources": {
- "adclients": {
- "methods": {
- "list": {
- "id": "adsense.accounts.adclients.list",
- "path": "accounts/{accountId}/adclients",
- "httpMethod": "GET",
- "description": "List all ad clients in the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account for which to list ad clients.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad clients to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "AdClients"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- },
- "adunits": {
- "methods": {
- "get": {
- "id": "adsense.accounts.adunits.get",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}",
- "httpMethod": "GET",
- "description": "Gets the specified ad unit in the specified ad client for the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to get the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "AdUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "getAdCode": {
- "id": "adsense.accounts.adunits.getAdCode",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/adcode",
- "httpMethod": "GET",
- "description": "Get ad code for the specified ad unit.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account which contains the ad client.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client with contains the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit to get the code for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "AdCode"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.accounts.adunits.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
- "httpMethod": "GET",
- "description": "List all ad units in the specified ad client for the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list ad units.",
- "required": true,
- "location": "path"
- },
- "includeInactive": {
- "type": "boolean",
- "description": "Whether to include inactive ad units. Default: true.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad units to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId"
- ],
- "response": {
- "$ref": "AdUnits"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- },
- "resources": {
- "customchannels": {
- "methods": {
- "list": {
- "id": "adsense.accounts.adunits.customchannels.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/customchannels",
- "httpMethod": "GET",
- "description": "List all custom channels which the specified ad unit belongs to.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit for which to list custom channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
- },
- "alerts": {
- "methods": {
- "list": {
- "id": "adsense.accounts.alerts.list",
- "path": "accounts/{accountId}/alerts",
- "httpMethod": "GET",
- "description": "List the alerts for the specified AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account for which to retrieve the alerts.",
- "required": true,
- "location": "path"
- },
- "locale": {
- "type": "string",
- "description": "The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "Alerts"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- },
- "customchannels": {
- "methods": {
- "get": {
- "id": "adsense.accounts.customchannels.get",
- "path": "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}",
- "httpMethod": "GET",
- "description": "Get the specified custom channel from the specified ad client for the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the custom channel.",
- "required": true,
- "location": "path"
- },
- "customChannelId": {
- "type": "string",
- "description": "Custom channel to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "CustomChannel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.accounts.customchannels.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/customchannels",
- "httpMethod": "GET",
- "description": "List all custom channels in the specified ad client for the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list custom channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId"
- ],
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- },
- "resources": {
- "adunits": {
- "methods": {
- "list": {
- "id": "adsense.accounts.customchannels.adunits.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}/adunits",
- "httpMethod": "GET",
- "description": "List all ad units in the specified custom channel.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the custom channel.",
- "required": true,
- "location": "path"
- },
- "customChannelId": {
- "type": "string",
- "description": "Custom channel for which to list ad units.",
- "required": true,
- "location": "path"
- },
- "includeInactive": {
- "type": "boolean",
- "description": "Whether to include inactive ad units. Default: true.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad units to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "AdUnits"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
- },
- "reports": {
- "methods": {
- "generate": {
- "id": "adsense.accounts.reports.generate",
- "path": "accounts/{accountId}/reports",
- "httpMethod": "GET",
- "description": "Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account upon which to report.",
- "required": true,
- "location": "path"
- },
- "currency": {
- "type": "string",
- "description": "Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.",
- "pattern": "[a-zA-Z]+",
- "location": "query"
- },
- "dimension": {
- "type": "string",
- "description": "Dimensions to base the report on.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "endDate": {
- "type": "string",
- "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "Filters to be run on the report.",
- "pattern": "[a-zA-Z_]+(==|=@).+",
- "repeated": true,
- "location": "query"
- },
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "metric": {
- "type": "string",
- "description": "Numeric columns to include in the report.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "sort": {
- "type": "string",
- "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
- "pattern": "(\\+|-)?[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "startDate": {
- "type": "string",
- "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
- },
- "useTimezoneReporting": {
- "type": "boolean",
- "description": "Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "startDate",
- "endDate"
- ],
- "response": {
- "$ref": "AdsenseReportsGenerateResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ],
- "supportsMediaDownload": true
- }
- },
- "resources": {
- "saved": {
- "methods": {
- "generate": {
- "id": "adsense.accounts.reports.saved.generate",
- "path": "accounts/{accountId}/reports/{savedReportId}",
- "httpMethod": "GET",
- "description": "Generate an AdSense report based on the saved report ID sent in the query parameters.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the saved reports belong.",
- "required": true,
- "location": "path"
- },
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "savedReportId": {
- "type": "string",
- "description": "The saved report to retrieve.",
- "required": true,
- "location": "path"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "savedReportId"
- ],
- "response": {
- "$ref": "AdsenseReportsGenerateResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.accounts.reports.saved.list",
- "path": "accounts/{accountId}/reports/saved",
- "httpMethod": "GET",
- "description": "List all saved reports in the specified AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the saved reports belong.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of saved reports to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "SavedReports"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
- },
- "savedadstyles": {
- "methods": {
- "get": {
- "id": "adsense.accounts.savedadstyles.get",
- "path": "accounts/{accountId}/savedadstyles/{savedAdStyleId}",
- "httpMethod": "GET",
- "description": "List a specific saved ad style for the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account for which to get the saved ad style.",
- "required": true,
- "location": "path"
- },
- "savedAdStyleId": {
- "type": "string",
- "description": "Saved ad style to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "savedAdStyleId"
- ],
- "response": {
- "$ref": "SavedAdStyle"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.accounts.savedadstyles.list",
- "path": "accounts/{accountId}/savedadstyles",
- "httpMethod": "GET",
- "description": "List all saved ad styles in the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account for which to list saved ad styles.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of saved ad styles to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "SavedAdStyles"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- },
- "urlchannels": {
- "methods": {
- "list": {
- "id": "adsense.accounts.urlchannels.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/urlchannels",
- "httpMethod": "GET",
- "description": "List all URL channels in the specified ad client for the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list URL channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of URL channels to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId"
- ],
- "response": {
- "$ref": "UrlChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
- },
- "adclients": {
- "methods": {
- "list": {
- "id": "adsense.adclients.list",
- "path": "adclients",
- "httpMethod": "GET",
- "description": "List all ad clients in this AdSense account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad clients to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "AdClients"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- },
- "adunits": {
- "methods": {
- "get": {
- "id": "adsense.adunits.get",
- "path": "adclients/{adClientId}/adunits/{adUnitId}",
- "httpMethod": "GET",
- "description": "Gets the specified ad unit in the specified ad client.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to get the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "AdUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "getAdCode": {
- "id": "adsense.adunits.getAdCode",
- "path": "adclients/{adClientId}/adunits/{adUnitId}/adcode",
- "httpMethod": "GET",
- "description": "Get ad code for the specified ad unit.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client with contains the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit to get the code for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "AdCode"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.adunits.list",
- "path": "adclients/{adClientId}/adunits",
- "httpMethod": "GET",
- "description": "List all ad units in the specified ad client for this AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list ad units.",
- "required": true,
- "location": "path"
- },
- "includeInactive": {
- "type": "boolean",
- "description": "Whether to include inactive ad units. Default: true.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad units to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "AdUnits"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- },
- "resources": {
- "customchannels": {
- "methods": {
- "list": {
- "id": "adsense.adunits.customchannels.list",
- "path": "adclients/{adClientId}/adunits/{adUnitId}/customchannels",
- "httpMethod": "GET",
- "description": "List all custom channels which the specified ad unit belongs to.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit for which to list custom channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
- },
- "alerts": {
- "methods": {
- "list": {
- "id": "adsense.alerts.list",
- "path": "alerts",
- "httpMethod": "GET",
- "description": "List the alerts for this AdSense account.",
- "parameters": {
- "locale": {
- "type": "string",
- "description": "The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Alerts"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- },
- "customchannels": {
- "methods": {
- "get": {
- "id": "adsense.customchannels.get",
- "path": "adclients/{adClientId}/customchannels/{customChannelId}",
- "httpMethod": "GET",
- "description": "Get the specified custom channel from the specified ad client.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the custom channel.",
- "required": true,
- "location": "path"
- },
- "customChannelId": {
- "type": "string",
- "description": "Custom channel to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "CustomChannel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.customchannels.list",
- "path": "adclients/{adClientId}/customchannels",
- "httpMethod": "GET",
- "description": "List all custom channels in the specified ad client for this AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list custom channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- },
- "resources": {
- "adunits": {
- "methods": {
- "list": {
- "id": "adsense.customchannels.adunits.list",
- "path": "adclients/{adClientId}/customchannels/{customChannelId}/adunits",
- "httpMethod": "GET",
- "description": "List all ad units in the specified custom channel.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the custom channel.",
- "required": true,
- "location": "path"
- },
- "customChannelId": {
- "type": "string",
- "description": "Custom channel for which to list ad units.",
- "required": true,
- "location": "path"
- },
- "includeInactive": {
- "type": "boolean",
- "description": "Whether to include inactive ad units. Default: true.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad units to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "AdUnits"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
- },
- "metadata": {
- "resources": {
- "dimensions": {
- "methods": {
- "list": {
- "id": "adsense.metadata.dimensions.list",
- "path": "metadata/dimensions",
- "httpMethod": "GET",
- "description": "List the metadata for the dimensions available to this AdSense account.",
- "response": {
- "$ref": "Metadata"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- },
- "metrics": {
- "methods": {
- "list": {
- "id": "adsense.metadata.metrics.list",
- "path": "metadata/metrics",
- "httpMethod": "GET",
- "description": "List the metadata for the metrics available to this AdSense account.",
- "response": {
- "$ref": "Metadata"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
- },
- "reports": {
- "methods": {
- "generate": {
- "id": "adsense.reports.generate",
- "path": "reports",
- "httpMethod": "GET",
- "description": "Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Accounts upon which to report.",
- "repeated": true,
- "location": "query"
- },
- "currency": {
- "type": "string",
- "description": "Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.",
- "pattern": "[a-zA-Z]+",
- "location": "query"
- },
- "dimension": {
- "type": "string",
- "description": "Dimensions to base the report on.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "endDate": {
- "type": "string",
- "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "Filters to be run on the report.",
- "pattern": "[a-zA-Z_]+(==|=@).+",
- "repeated": true,
- "location": "query"
- },
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "metric": {
- "type": "string",
- "description": "Numeric columns to include in the report.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "sort": {
- "type": "string",
- "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
- "pattern": "(\\+|-)?[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "startDate": {
- "type": "string",
- "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
- },
- "useTimezoneReporting": {
- "type": "boolean",
- "description": "Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "startDate",
- "endDate"
- ],
- "response": {
- "$ref": "AdsenseReportsGenerateResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ],
- "supportsMediaDownload": true
- }
- },
- "resources": {
- "saved": {
- "methods": {
- "generate": {
- "id": "adsense.reports.saved.generate",
- "path": "reports/{savedReportId}",
- "httpMethod": "GET",
- "description": "Generate an AdSense report based on the saved report ID sent in the query parameters.",
- "parameters": {
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "savedReportId": {
- "type": "string",
- "description": "The saved report to retrieve.",
- "required": true,
- "location": "path"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
- }
- },
- "parameterOrder": [
- "savedReportId"
- ],
- "response": {
- "$ref": "AdsenseReportsGenerateResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.reports.saved.list",
- "path": "reports/saved",
- "httpMethod": "GET",
- "description": "List all saved reports in this AdSense account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of saved reports to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "SavedReports"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
- },
- "savedadstyles": {
- "methods": {
- "get": {
- "id": "adsense.savedadstyles.get",
- "path": "savedadstyles/{savedAdStyleId}",
- "httpMethod": "GET",
- "description": "Get a specific saved ad style from the user's account.",
- "parameters": {
- "savedAdStyleId": {
- "type": "string",
- "description": "Saved ad style to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "savedAdStyleId"
- ],
- "response": {
- "$ref": "SavedAdStyle"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.savedadstyles.list",
- "path": "savedadstyles",
- "httpMethod": "GET",
- "description": "List all saved ad styles in the user's account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of saved ad styles to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "SavedAdStyles"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- },
- "urlchannels": {
- "methods": {
- "list": {
- "id": "adsense.urlchannels.list",
- "path": "adclients/{adClientId}/urlchannels",
- "httpMethod": "GET",
- "description": "List all URL channels in the specified ad client for this AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list URL channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of URL channels to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "UrlChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/adsense/v1.3/adsense-gen.go b/vendor/google.golang.org/api/adsense/v1.3/adsense-gen.go
deleted file mode 100644
index a6c05b9d..00000000
--- a/vendor/google.golang.org/api/adsense/v1.3/adsense-gen.go
+++ /dev/null
@@ -1,6995 +0,0 @@
-// Package adsense provides access to the AdSense Management API.
-//
-// See https://developers.google.com/adsense/management/
-//
-// Usage example:
-//
-// import "google.golang.org/api/adsense/v1.3"
-// ...
-// adsenseService, err := adsense.New(oauthHttpClient)
-package adsense // import "google.golang.org/api/adsense/v1.3"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "adsense:v1.3"
-const apiName = "adsense"
-const apiVersion = "v1.3"
-const basePath = "https://www.googleapis.com/adsense/v1.3/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your AdSense data
- AdsenseScope = "https://www.googleapis.com/auth/adsense"
-
- // View your AdSense data
- AdsenseReadonlyScope = "https://www.googleapis.com/auth/adsense.readonly"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Accounts = NewAccountsService(s)
- s.Adclients = NewAdclientsService(s)
- s.Adunits = NewAdunitsService(s)
- s.Alerts = NewAlertsService(s)
- s.Customchannels = NewCustomchannelsService(s)
- s.Metadata = NewMetadataService(s)
- s.Reports = NewReportsService(s)
- s.Savedadstyles = NewSavedadstylesService(s)
- s.Urlchannels = NewUrlchannelsService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Accounts *AccountsService
-
- Adclients *AdclientsService
-
- Adunits *AdunitsService
-
- Alerts *AlertsService
-
- Customchannels *CustomchannelsService
-
- Metadata *MetadataService
-
- Reports *ReportsService
-
- Savedadstyles *SavedadstylesService
-
- Urlchannels *UrlchannelsService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewAccountsService(s *Service) *AccountsService {
- rs := &AccountsService{s: s}
- rs.Adclients = NewAccountsAdclientsService(s)
- rs.Adunits = NewAccountsAdunitsService(s)
- rs.Alerts = NewAccountsAlertsService(s)
- rs.Customchannels = NewAccountsCustomchannelsService(s)
- rs.Reports = NewAccountsReportsService(s)
- rs.Savedadstyles = NewAccountsSavedadstylesService(s)
- rs.Urlchannels = NewAccountsUrlchannelsService(s)
- return rs
-}
-
-type AccountsService struct {
- s *Service
-
- Adclients *AccountsAdclientsService
-
- Adunits *AccountsAdunitsService
-
- Alerts *AccountsAlertsService
-
- Customchannels *AccountsCustomchannelsService
-
- Reports *AccountsReportsService
-
- Savedadstyles *AccountsSavedadstylesService
-
- Urlchannels *AccountsUrlchannelsService
-}
-
-func NewAccountsAdclientsService(s *Service) *AccountsAdclientsService {
- rs := &AccountsAdclientsService{s: s}
- return rs
-}
-
-type AccountsAdclientsService struct {
- s *Service
-}
-
-func NewAccountsAdunitsService(s *Service) *AccountsAdunitsService {
- rs := &AccountsAdunitsService{s: s}
- rs.Customchannels = NewAccountsAdunitsCustomchannelsService(s)
- return rs
-}
-
-type AccountsAdunitsService struct {
- s *Service
-
- Customchannels *AccountsAdunitsCustomchannelsService
-}
-
-func NewAccountsAdunitsCustomchannelsService(s *Service) *AccountsAdunitsCustomchannelsService {
- rs := &AccountsAdunitsCustomchannelsService{s: s}
- return rs
-}
-
-type AccountsAdunitsCustomchannelsService struct {
- s *Service
-}
-
-func NewAccountsAlertsService(s *Service) *AccountsAlertsService {
- rs := &AccountsAlertsService{s: s}
- return rs
-}
-
-type AccountsAlertsService struct {
- s *Service
-}
-
-func NewAccountsCustomchannelsService(s *Service) *AccountsCustomchannelsService {
- rs := &AccountsCustomchannelsService{s: s}
- rs.Adunits = NewAccountsCustomchannelsAdunitsService(s)
- return rs
-}
-
-type AccountsCustomchannelsService struct {
- s *Service
-
- Adunits *AccountsCustomchannelsAdunitsService
-}
-
-func NewAccountsCustomchannelsAdunitsService(s *Service) *AccountsCustomchannelsAdunitsService {
- rs := &AccountsCustomchannelsAdunitsService{s: s}
- return rs
-}
-
-type AccountsCustomchannelsAdunitsService struct {
- s *Service
-}
-
-func NewAccountsReportsService(s *Service) *AccountsReportsService {
- rs := &AccountsReportsService{s: s}
- rs.Saved = NewAccountsReportsSavedService(s)
- return rs
-}
-
-type AccountsReportsService struct {
- s *Service
-
- Saved *AccountsReportsSavedService
-}
-
-func NewAccountsReportsSavedService(s *Service) *AccountsReportsSavedService {
- rs := &AccountsReportsSavedService{s: s}
- return rs
-}
-
-type AccountsReportsSavedService struct {
- s *Service
-}
-
-func NewAccountsSavedadstylesService(s *Service) *AccountsSavedadstylesService {
- rs := &AccountsSavedadstylesService{s: s}
- return rs
-}
-
-type AccountsSavedadstylesService struct {
- s *Service
-}
-
-func NewAccountsUrlchannelsService(s *Service) *AccountsUrlchannelsService {
- rs := &AccountsUrlchannelsService{s: s}
- return rs
-}
-
-type AccountsUrlchannelsService struct {
- s *Service
-}
-
-func NewAdclientsService(s *Service) *AdclientsService {
- rs := &AdclientsService{s: s}
- return rs
-}
-
-type AdclientsService struct {
- s *Service
-}
-
-func NewAdunitsService(s *Service) *AdunitsService {
- rs := &AdunitsService{s: s}
- rs.Customchannels = NewAdunitsCustomchannelsService(s)
- return rs
-}
-
-type AdunitsService struct {
- s *Service
-
- Customchannels *AdunitsCustomchannelsService
-}
-
-func NewAdunitsCustomchannelsService(s *Service) *AdunitsCustomchannelsService {
- rs := &AdunitsCustomchannelsService{s: s}
- return rs
-}
-
-type AdunitsCustomchannelsService struct {
- s *Service
-}
-
-func NewAlertsService(s *Service) *AlertsService {
- rs := &AlertsService{s: s}
- return rs
-}
-
-type AlertsService struct {
- s *Service
-}
-
-func NewCustomchannelsService(s *Service) *CustomchannelsService {
- rs := &CustomchannelsService{s: s}
- rs.Adunits = NewCustomchannelsAdunitsService(s)
- return rs
-}
-
-type CustomchannelsService struct {
- s *Service
-
- Adunits *CustomchannelsAdunitsService
-}
-
-func NewCustomchannelsAdunitsService(s *Service) *CustomchannelsAdunitsService {
- rs := &CustomchannelsAdunitsService{s: s}
- return rs
-}
-
-type CustomchannelsAdunitsService struct {
- s *Service
-}
-
-func NewMetadataService(s *Service) *MetadataService {
- rs := &MetadataService{s: s}
- rs.Dimensions = NewMetadataDimensionsService(s)
- rs.Metrics = NewMetadataMetricsService(s)
- return rs
-}
-
-type MetadataService struct {
- s *Service
-
- Dimensions *MetadataDimensionsService
-
- Metrics *MetadataMetricsService
-}
-
-func NewMetadataDimensionsService(s *Service) *MetadataDimensionsService {
- rs := &MetadataDimensionsService{s: s}
- return rs
-}
-
-type MetadataDimensionsService struct {
- s *Service
-}
-
-func NewMetadataMetricsService(s *Service) *MetadataMetricsService {
- rs := &MetadataMetricsService{s: s}
- return rs
-}
-
-type MetadataMetricsService struct {
- s *Service
-}
-
-func NewReportsService(s *Service) *ReportsService {
- rs := &ReportsService{s: s}
- rs.Saved = NewReportsSavedService(s)
- return rs
-}
-
-type ReportsService struct {
- s *Service
-
- Saved *ReportsSavedService
-}
-
-func NewReportsSavedService(s *Service) *ReportsSavedService {
- rs := &ReportsSavedService{s: s}
- return rs
-}
-
-type ReportsSavedService struct {
- s *Service
-}
-
-func NewSavedadstylesService(s *Service) *SavedadstylesService {
- rs := &SavedadstylesService{s: s}
- return rs
-}
-
-type SavedadstylesService struct {
- s *Service
-}
-
-func NewUrlchannelsService(s *Service) *UrlchannelsService {
- rs := &UrlchannelsService{s: s}
- return rs
-}
-
-type UrlchannelsService struct {
- s *Service
-}
-
-type Account struct {
- // Id: Unique identifier of this account.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adsense#account.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this account.
- Name string `json:"name,omitempty"`
-
- // Premium: Whether this account is premium.
- Premium bool `json:"premium,omitempty"`
-
- // SubAccounts: Sub accounts of the this account.
- SubAccounts []*Account `json:"subAccounts,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Account) MarshalJSON() ([]byte, error) {
- type noMethod Account
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Accounts struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The accounts returned in this list response.
- Items []*Account `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsense#accounts.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through accounts. To
- // retrieve the next page of results, set the next request's "pageToken"
- // value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Accounts) MarshalJSON() ([]byte, error) {
- type noMethod Accounts
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdClient struct {
- // ArcOptIn: Whether this ad client is opted in to ARC.
- ArcOptIn bool `json:"arcOptIn,omitempty"`
-
- // Id: Unique identifier of this ad client.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adsense#adClient.
- Kind string `json:"kind,omitempty"`
-
- // ProductCode: This ad client's product code, which corresponds to the
- // PRODUCT_CODE report dimension.
- ProductCode string `json:"productCode,omitempty"`
-
- // SupportsReporting: Whether this ad client supports being reported on.
- SupportsReporting bool `json:"supportsReporting,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ArcOptIn") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdClient) MarshalJSON() ([]byte, error) {
- type noMethod AdClient
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdClients struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The ad clients returned in this list response.
- Items []*AdClient `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsense#adClients.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through ad clients. To
- // retrieve the next page of results, set the next request's "pageToken"
- // value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdClients) MarshalJSON() ([]byte, error) {
- type noMethod AdClients
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdCode struct {
- // AdCode: The ad code snippet.
- AdCode string `json:"adCode,omitempty"`
-
- // Kind: Kind this is, in this case adsense#adCode.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AdCode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdCode) MarshalJSON() ([]byte, error) {
- type noMethod AdCode
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdStyle struct {
- // Colors: The colors which are included in the style. These are
- // represented as six hexadecimal characters, similar to HTML color
- // codes, but without the leading hash.
- Colors *AdStyleColors `json:"colors,omitempty"`
-
- // Corners: The style of the corners in the ad.
- Corners string `json:"corners,omitempty"`
-
- // Font: The font which is included in the style.
- Font *AdStyleFont `json:"font,omitempty"`
-
- // Kind: Kind this is, in this case adsense#adStyle.
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Colors") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdStyle) MarshalJSON() ([]byte, error) {
- type noMethod AdStyle
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdStyleColors: The colors which are included in the style. These are
-// represented as six hexadecimal characters, similar to HTML color
-// codes, but without the leading hash.
-type AdStyleColors struct {
- // Background: The color of the ad background.
- Background string `json:"background,omitempty"`
-
- // Border: The color of the ad border.
- Border string `json:"border,omitempty"`
-
- // Text: The color of the ad text.
- Text string `json:"text,omitempty"`
-
- // Title: The color of the ad title.
- Title string `json:"title,omitempty"`
-
- // Url: The color of the ad url.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Background") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdStyleColors) MarshalJSON() ([]byte, error) {
- type noMethod AdStyleColors
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdStyleFont: The font which is included in the style.
-type AdStyleFont struct {
- // Family: The family of the font.
- Family string `json:"family,omitempty"`
-
- // Size: The size of the font.
- Size string `json:"size,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Family") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdStyleFont) MarshalJSON() ([]byte, error) {
- type noMethod AdStyleFont
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdUnit struct {
- // Code: Identity code of this ad unit, not necessarily unique across ad
- // clients.
- Code string `json:"code,omitempty"`
-
- // ContentAdsSettings: Settings specific to content ads (AFC) and
- // highend mobile content ads (AFMC).
- ContentAdsSettings *AdUnitContentAdsSettings `json:"contentAdsSettings,omitempty"`
-
- // CustomStyle: Custom style information specific to this ad unit.
- CustomStyle *AdStyle `json:"customStyle,omitempty"`
-
- // FeedAdsSettings: Settings specific to feed ads (AFF).
- FeedAdsSettings *AdUnitFeedAdsSettings `json:"feedAdsSettings,omitempty"`
-
- // Id: Unique identifier of this ad unit. This should be considered an
- // opaque identifier; it is not safe to rely on it being in any
- // particular format.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adsense#adUnit.
- Kind string `json:"kind,omitempty"`
-
- // MobileContentAdsSettings: Settings specific to WAP mobile content ads
- // (AFMC).
- MobileContentAdsSettings *AdUnitMobileContentAdsSettings `json:"mobileContentAdsSettings,omitempty"`
-
- // Name: Name of this ad unit.
- Name string `json:"name,omitempty"`
-
- // SavedStyleId: ID of the saved ad style which holds this ad unit's
- // style information.
- SavedStyleId string `json:"savedStyleId,omitempty"`
-
- // Status: Status of this ad unit. Possible values are:
- // NEW: Indicates that the ad unit was created within the last seven
- // days and does not yet have any activity associated with it.
- //
- // ACTIVE: Indicates that there has been activity on this ad unit in the
- // last seven days.
- //
- // INACTIVE: Indicates that there has been no activity on this ad unit
- // in the last seven days.
- Status string `json:"status,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdUnit) MarshalJSON() ([]byte, error) {
- type noMethod AdUnit
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdUnitContentAdsSettings: Settings specific to content ads (AFC) and
-// highend mobile content ads (AFMC).
-type AdUnitContentAdsSettings struct {
- // BackupOption: The backup option to be used in instances where no ad
- // is available.
- BackupOption *AdUnitContentAdsSettingsBackupOption `json:"backupOption,omitempty"`
-
- // Size: Size of this ad unit.
- Size string `json:"size,omitempty"`
-
- // Type: Type of this ad unit.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BackupOption") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdUnitContentAdsSettings) MarshalJSON() ([]byte, error) {
- type noMethod AdUnitContentAdsSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdUnitContentAdsSettingsBackupOption: The backup option to be used in
-// instances where no ad is available.
-type AdUnitContentAdsSettingsBackupOption struct {
- // Color: Color to use when type is set to COLOR.
- Color string `json:"color,omitempty"`
-
- // Type: Type of the backup option. Possible values are BLANK, COLOR and
- // URL.
- Type string `json:"type,omitempty"`
-
- // Url: URL to use when type is set to URL.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Color") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdUnitContentAdsSettingsBackupOption) MarshalJSON() ([]byte, error) {
- type noMethod AdUnitContentAdsSettingsBackupOption
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdUnitFeedAdsSettings: Settings specific to feed ads (AFF).
-type AdUnitFeedAdsSettings struct {
- // AdPosition: The position of the ads relative to the feed entries.
- AdPosition string `json:"adPosition,omitempty"`
-
- // Frequency: The frequency at which ads should appear in the feed (i.e.
- // every N entries).
- Frequency int64 `json:"frequency,omitempty"`
-
- // MinimumWordCount: The minimum length an entry should be in order to
- // have attached ads.
- MinimumWordCount int64 `json:"minimumWordCount,omitempty"`
-
- // Type: The type of ads which should appear.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AdPosition") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdUnitFeedAdsSettings) MarshalJSON() ([]byte, error) {
- type noMethod AdUnitFeedAdsSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdUnitMobileContentAdsSettings: Settings specific to WAP mobile
-// content ads (AFMC).
-type AdUnitMobileContentAdsSettings struct {
- // MarkupLanguage: The markup language to use for this ad unit.
- MarkupLanguage string `json:"markupLanguage,omitempty"`
-
- // ScriptingLanguage: The scripting language to use for this ad unit.
- ScriptingLanguage string `json:"scriptingLanguage,omitempty"`
-
- // Size: Size of this ad unit.
- Size string `json:"size,omitempty"`
-
- // Type: Type of this ad unit.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "MarkupLanguage") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdUnitMobileContentAdsSettings) MarshalJSON() ([]byte, error) {
- type noMethod AdUnitMobileContentAdsSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdUnits struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The ad units returned in this list response.
- Items []*AdUnit `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsense#adUnits.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through ad units. To
- // retrieve the next page of results, set the next request's "pageToken"
- // value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdUnits) MarshalJSON() ([]byte, error) {
- type noMethod AdUnits
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdsenseReportsGenerateResponse struct {
- // Averages: The averages of the report. This is the same length as any
- // other row in the report; cells corresponding to dimension columns are
- // empty.
- Averages []string `json:"averages,omitempty"`
-
- // Headers: The header information of the columns requested in the
- // report. This is a list of headers; one for each dimension in the
- // request, followed by one for each metric in the request.
- Headers []*AdsenseReportsGenerateResponseHeaders `json:"headers,omitempty"`
-
- // Kind: Kind this is, in this case adsense#report.
- Kind string `json:"kind,omitempty"`
-
- // Rows: The output rows of the report. Each row is a list of cells; one
- // for each dimension in the request, followed by one for each metric in
- // the request. The dimension cells contain strings, and the metric
- // cells contain numbers.
- Rows [][]string `json:"rows,omitempty"`
-
- // TotalMatchedRows: The total number of rows matched by the report
- // request. Fewer rows may be returned in the response due to being
- // limited by the row count requested or the report row limit.
- TotalMatchedRows int64 `json:"totalMatchedRows,omitempty,string"`
-
- // Totals: The totals of the report. This is the same length as any
- // other row in the report; cells corresponding to dimension columns are
- // empty.
- Totals []string `json:"totals,omitempty"`
-
- // Warnings: Any warnings associated with generation of the report.
- Warnings []string `json:"warnings,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Averages") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdsenseReportsGenerateResponse) MarshalJSON() ([]byte, error) {
- type noMethod AdsenseReportsGenerateResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdsenseReportsGenerateResponseHeaders struct {
- // Currency: The currency of this column. Only present if the header
- // type is METRIC_CURRENCY.
- Currency string `json:"currency,omitempty"`
-
- // Name: The name of the header.
- Name string `json:"name,omitempty"`
-
- // Type: The type of the header; one of DIMENSION, METRIC_TALLY,
- // METRIC_RATIO, or METRIC_CURRENCY.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Currency") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdsenseReportsGenerateResponseHeaders) MarshalJSON() ([]byte, error) {
- type noMethod AdsenseReportsGenerateResponseHeaders
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Alert struct {
- // Id: Unique identifier of this alert. This should be considered an
- // opaque identifier; it is not safe to rely on it being in any
- // particular format.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adsense#alert.
- Kind string `json:"kind,omitempty"`
-
- // Message: The localized alert message.
- Message string `json:"message,omitempty"`
-
- // Severity: Severity of this alert. Possible values: INFO, WARNING,
- // SEVERE.
- Severity string `json:"severity,omitempty"`
-
- // Type: Type of this alert. Possible values: SELF_HOLD,
- // MIGRATED_TO_BILLING3, ADDRESS_PIN_VERIFICATION,
- // PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, GRAYLISTED_PUBLISHER,
- // API_HOLD.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Alert) MarshalJSON() ([]byte, error) {
- type noMethod Alert
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Alerts struct {
- // Items: The alerts returned in this list response.
- Items []*Alert `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsense#alerts.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Alerts) MarshalJSON() ([]byte, error) {
- type noMethod Alerts
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CustomChannel struct {
- // Code: Code of this custom channel, not necessarily unique across ad
- // clients.
- Code string `json:"code,omitempty"`
-
- // Id: Unique identifier of this custom channel. This should be
- // considered an opaque identifier; it is not safe to rely on it being
- // in any particular format.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adsense#customChannel.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this custom channel.
- Name string `json:"name,omitempty"`
-
- // TargetingInfo: The targeting information of this custom channel, if
- // activated.
- TargetingInfo *CustomChannelTargetingInfo `json:"targetingInfo,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomChannel) MarshalJSON() ([]byte, error) {
- type noMethod CustomChannel
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CustomChannelTargetingInfo: The targeting information of this custom
-// channel, if activated.
-type CustomChannelTargetingInfo struct {
- // AdsAppearOn: The name used to describe this channel externally.
- AdsAppearOn string `json:"adsAppearOn,omitempty"`
-
- // Description: The external description of the channel.
- Description string `json:"description,omitempty"`
-
- // Location: The locations in which ads appear. (Only valid for content
- // and mobile content ads). Acceptable values for content ads are:
- // TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER,
- // MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT,
- // MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are:
- // TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
- Location string `json:"location,omitempty"`
-
- // SiteLanguage: The language of the sites ads will be displayed on.
- SiteLanguage string `json:"siteLanguage,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AdsAppearOn") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomChannelTargetingInfo) MarshalJSON() ([]byte, error) {
- type noMethod CustomChannelTargetingInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CustomChannels struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The custom channels returned in this list response.
- Items []*CustomChannel `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsense#customChannels.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through custom
- // channels. To retrieve the next page of results, set the next
- // request's "pageToken" value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomChannels) MarshalJSON() ([]byte, error) {
- type noMethod CustomChannels
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Metadata struct {
- Items []*ReportingMetadataEntry `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsense#metadata.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Metadata) MarshalJSON() ([]byte, error) {
- type noMethod Metadata
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ReportingMetadataEntry struct {
- // CompatibleDimensions: For metrics this is a list of dimension IDs
- // which the metric is compatible with, for dimensions it is a list of
- // compatibility groups the dimension belongs to.
- CompatibleDimensions []string `json:"compatibleDimensions,omitempty"`
-
- // CompatibleMetrics: The names of the metrics the dimension or metric
- // this reporting metadata entry describes is compatible with.
- CompatibleMetrics []string `json:"compatibleMetrics,omitempty"`
-
- // Id: Unique identifier of this reporting metadata entry, corresponding
- // to the name of the appropriate dimension or metric.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case
- // adsense#reportingMetadataEntry.
- Kind string `json:"kind,omitempty"`
-
- // RequiredDimensions: The names of the dimensions which the dimension
- // or metric this reporting metadata entry describes requires to also be
- // present in order for the report to be valid. Omitting these will not
- // cause an error or warning, but may result in data which cannot be
- // correctly interpreted.
- RequiredDimensions []string `json:"requiredDimensions,omitempty"`
-
- // RequiredMetrics: The names of the metrics which the dimension or
- // metric this reporting metadata entry describes requires to also be
- // present in order for the report to be valid. Omitting these will not
- // cause an error or warning, but may result in data which cannot be
- // correctly interpreted.
- RequiredMetrics []string `json:"requiredMetrics,omitempty"`
-
- // SupportedProducts: The codes of the projects supported by the
- // dimension or metric this reporting metadata entry describes.
- SupportedProducts []string `json:"supportedProducts,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "CompatibleDimensions") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportingMetadataEntry) MarshalJSON() ([]byte, error) {
- type noMethod ReportingMetadataEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type SavedAdStyle struct {
- // AdStyle: The AdStyle itself.
- AdStyle *AdStyle `json:"adStyle,omitempty"`
-
- // Id: Unique identifier of this saved ad style. This should be
- // considered an opaque identifier; it is not safe to rely on it being
- // in any particular format.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adsense#savedAdStyle.
- Kind string `json:"kind,omitempty"`
-
- // Name: The user selected name of this SavedAdStyle.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AdStyle") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SavedAdStyle) MarshalJSON() ([]byte, error) {
- type noMethod SavedAdStyle
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type SavedAdStyles struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The saved ad styles returned in this list response.
- Items []*SavedAdStyle `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsense#savedAdStyles.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through ad units. To
- // retrieve the next page of results, set the next request's "pageToken"
- // value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SavedAdStyles) MarshalJSON() ([]byte, error) {
- type noMethod SavedAdStyles
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type SavedReport struct {
- // Id: Unique identifier of this saved report.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adsense#savedReport.
- Kind string `json:"kind,omitempty"`
-
- // Name: This saved report's name.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SavedReport) MarshalJSON() ([]byte, error) {
- type noMethod SavedReport
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type SavedReports struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The saved reports returned in this list response.
- Items []*SavedReport `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsense#savedReports.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through saved reports.
- // To retrieve the next page of results, set the next request's
- // "pageToken" value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SavedReports) MarshalJSON() ([]byte, error) {
- type noMethod SavedReports
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UrlChannel struct {
- // Id: Unique identifier of this URL channel. This should be considered
- // an opaque identifier; it is not safe to rely on it being in any
- // particular format.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adsense#urlChannel.
- Kind string `json:"kind,omitempty"`
-
- // UrlPattern: URL Pattern of this URL channel. Does not include
- // "http://" or "https://". Example: www.example.com/home
- UrlPattern string `json:"urlPattern,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlChannel) MarshalJSON() ([]byte, error) {
- type noMethod UrlChannel
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UrlChannels struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The URL channels returned in this list response.
- Items []*UrlChannel `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsense#urlChannels.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through URL channels.
- // To retrieve the next page of results, set the next request's
- // "pageToken" value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlChannels) MarshalJSON() ([]byte, error) {
- type noMethod UrlChannels
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "adsense.accounts.get":
-
-type AccountsGetCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get information about the selected AdSense account.
-func (r *AccountsService) Get(accountId string) *AccountsGetCall {
- c := &AccountsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// Tree sets the optional parameter "tree": Whether the tree of sub
-// accounts should be returned.
-func (c *AccountsGetCall) Tree(tree bool) *AccountsGetCall {
- c.opt_["tree"] = tree
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsGetCall) Fields(s ...googleapi.Field) *AccountsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsGetCall) IfNoneMatch(entityTag string) *AccountsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsGetCall) Context(ctx context.Context) *AccountsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["tree"]; ok {
- params.Set("tree", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.get" call.
-// Exactly one of *Account or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Account.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsGetCall) Do() (*Account, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Account{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get information about the selected AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.get",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to get information about.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "tree": {
- // "description": "Whether the tree of sub accounts should be returned.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "accounts/{accountId}",
- // "response": {
- // "$ref": "Account"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.list":
-
-type AccountsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all accounts available to this AdSense account.
-func (r *AccountsService) List() *AccountsListCall {
- c := &AccountsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of accounts to include in the response, used for paging.
-func (c *AccountsListCall) MaxResults(maxResults int64) *AccountsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through accounts. To retrieve the next page, set
-// this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AccountsListCall) PageToken(pageToken string) *AccountsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsListCall) Fields(s ...googleapi.Field) *AccountsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsListCall) IfNoneMatch(entityTag string) *AccountsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsListCall) Context(ctx context.Context) *AccountsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.list" call.
-// Exactly one of *Accounts or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Accounts.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccountsListCall) Do() (*Accounts, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Accounts{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all accounts available to this AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.list",
- // "parameters": {
- // "maxResults": {
- // "description": "The maximum number of accounts to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through accounts. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts",
- // "response": {
- // "$ref": "Accounts"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.adclients.list":
-
-type AccountsAdclientsListCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all ad clients in the specified account.
-func (r *AccountsAdclientsService) List(accountId string) *AccountsAdclientsListCall {
- c := &AccountsAdclientsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of ad clients to include in the response, used for paging.
-func (c *AccountsAdclientsListCall) MaxResults(maxResults int64) *AccountsAdclientsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad clients. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AccountsAdclientsListCall) PageToken(pageToken string) *AccountsAdclientsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAdclientsListCall) Fields(s ...googleapi.Field) *AccountsAdclientsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsAdclientsListCall) IfNoneMatch(entityTag string) *AccountsAdclientsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAdclientsListCall) Context(ctx context.Context) *AccountsAdclientsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAdclientsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.adclients.list" call.
-// Exactly one of *AdClients or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AdClients.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccountsAdclientsListCall) Do() (*AdClients, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdClients{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all ad clients in the specified account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.adclients.list",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account for which to list ad clients.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of ad clients to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients",
- // "response": {
- // "$ref": "AdClients"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.adunits.get":
-
-type AccountsAdunitsGetCall struct {
- s *Service
- accountId string
- adClientId string
- adUnitId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets the specified ad unit in the specified ad client for the
-// specified account.
-func (r *AccountsAdunitsService) Get(accountId string, adClientId string, adUnitId string) *AccountsAdunitsGetCall {
- c := &AccountsAdunitsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- c.adUnitId = adUnitId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAdunitsGetCall) Fields(s ...googleapi.Field) *AccountsAdunitsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsAdunitsGetCall) IfNoneMatch(entityTag string) *AccountsAdunitsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAdunitsGetCall) Context(ctx context.Context) *AccountsAdunitsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAdunitsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- "adUnitId": c.adUnitId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.adunits.get" call.
-// Exactly one of *AdUnit or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnit.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsAdunitsGetCall) Do() (*AdUnit, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnit{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the specified ad unit in the specified ad client for the specified account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.adunits.get",
- // "parameterOrder": [
- // "accountId",
- // "adClientId",
- // "adUnitId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the ad client belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client for which to get the ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adUnitId": {
- // "description": "Ad unit to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}",
- // "response": {
- // "$ref": "AdUnit"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.adunits.getAdCode":
-
-type AccountsAdunitsGetAdCodeCall struct {
- s *Service
- accountId string
- adClientId string
- adUnitId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetAdCode: Get ad code for the specified ad unit.
-func (r *AccountsAdunitsService) GetAdCode(accountId string, adClientId string, adUnitId string) *AccountsAdunitsGetAdCodeCall {
- c := &AccountsAdunitsGetAdCodeCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- c.adUnitId = adUnitId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAdunitsGetAdCodeCall) Fields(s ...googleapi.Field) *AccountsAdunitsGetAdCodeCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsAdunitsGetAdCodeCall) IfNoneMatch(entityTag string) *AccountsAdunitsGetAdCodeCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAdunitsGetAdCodeCall) Context(ctx context.Context) *AccountsAdunitsGetAdCodeCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAdunitsGetAdCodeCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/adcode")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- "adUnitId": c.adUnitId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.adunits.getAdCode" call.
-// Exactly one of *AdCode or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdCode.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsAdunitsGetAdCodeCall) Do() (*AdCode, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdCode{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get ad code for the specified ad unit.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.adunits.getAdCode",
- // "parameterOrder": [
- // "accountId",
- // "adClientId",
- // "adUnitId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account which contains the ad client.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client with contains the ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adUnitId": {
- // "description": "Ad unit to get the code for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/adcode",
- // "response": {
- // "$ref": "AdCode"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.adunits.list":
-
-type AccountsAdunitsListCall struct {
- s *Service
- accountId string
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all ad units in the specified ad client for the specified
-// account.
-func (r *AccountsAdunitsService) List(accountId string, adClientId string) *AccountsAdunitsListCall {
- c := &AccountsAdunitsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- return c
-}
-
-// IncludeInactive sets the optional parameter "includeInactive":
-// Whether to include inactive ad units. Default: true.
-func (c *AccountsAdunitsListCall) IncludeInactive(includeInactive bool) *AccountsAdunitsListCall {
- c.opt_["includeInactive"] = includeInactive
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of ad units to include in the response, used for paging.
-func (c *AccountsAdunitsListCall) MaxResults(maxResults int64) *AccountsAdunitsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad units. To retrieve the next page, set
-// this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AccountsAdunitsListCall) PageToken(pageToken string) *AccountsAdunitsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAdunitsListCall) Fields(s ...googleapi.Field) *AccountsAdunitsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsAdunitsListCall) IfNoneMatch(entityTag string) *AccountsAdunitsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAdunitsListCall) Context(ctx context.Context) *AccountsAdunitsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAdunitsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["includeInactive"]; ok {
- params.Set("includeInactive", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/adunits")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.adunits.list" call.
-// Exactly one of *AdUnits or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnits.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsAdunitsListCall) Do() (*AdUnits, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnits{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all ad units in the specified ad client for the specified account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.adunits.list",
- // "parameterOrder": [
- // "accountId",
- // "adClientId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the ad client belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client for which to list ad units.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "includeInactive": {
- // "description": "Whether to include inactive ad units. Default: true.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "The maximum number of ad units to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
- // "response": {
- // "$ref": "AdUnits"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.adunits.customchannels.list":
-
-type AccountsAdunitsCustomchannelsListCall struct {
- s *Service
- accountId string
- adClientId string
- adUnitId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all custom channels which the specified ad unit belongs
-// to.
-func (r *AccountsAdunitsCustomchannelsService) List(accountId string, adClientId string, adUnitId string) *AccountsAdunitsCustomchannelsListCall {
- c := &AccountsAdunitsCustomchannelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- c.adUnitId = adUnitId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of custom channels to include in the response, used for
-// paging.
-func (c *AccountsAdunitsCustomchannelsListCall) MaxResults(maxResults int64) *AccountsAdunitsCustomchannelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through custom channels. To retrieve the next
-// page, set this parameter to the value of "nextPageToken" from the
-// previous response.
-func (c *AccountsAdunitsCustomchannelsListCall) PageToken(pageToken string) *AccountsAdunitsCustomchannelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAdunitsCustomchannelsListCall) Fields(s ...googleapi.Field) *AccountsAdunitsCustomchannelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsAdunitsCustomchannelsListCall) IfNoneMatch(entityTag string) *AccountsAdunitsCustomchannelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAdunitsCustomchannelsListCall) Context(ctx context.Context) *AccountsAdunitsCustomchannelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAdunitsCustomchannelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/customchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- "adUnitId": c.adUnitId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.adunits.customchannels.list" call.
-// Exactly one of *CustomChannels or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannels.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountsAdunitsCustomchannelsListCall) Do() (*CustomChannels, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannels{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all custom channels which the specified ad unit belongs to.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.adunits.customchannels.list",
- // "parameterOrder": [
- // "accountId",
- // "adClientId",
- // "adUnitId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the ad client belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client which contains the ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adUnitId": {
- // "description": "Ad unit for which to list custom channels.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of custom channels to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/customchannels",
- // "response": {
- // "$ref": "CustomChannels"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.alerts.list":
-
-type AccountsAlertsListCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List the alerts for the specified AdSense account.
-func (r *AccountsAlertsService) List(accountId string) *AccountsAlertsListCall {
- c := &AccountsAlertsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// Locale sets the optional parameter "locale": The locale to use for
-// translating alert messages. The account locale will be used if this
-// is not supplied. The AdSense default (English) will be used if the
-// supplied locale is invalid or unsupported.
-func (c *AccountsAlertsListCall) Locale(locale string) *AccountsAlertsListCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAlertsListCall) Fields(s ...googleapi.Field) *AccountsAlertsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsAlertsListCall) IfNoneMatch(entityTag string) *AccountsAlertsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAlertsListCall) Context(ctx context.Context) *AccountsAlertsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAlertsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/alerts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.alerts.list" call.
-// Exactly one of *Alerts or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Alerts.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsAlertsListCall) Do() (*Alerts, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Alerts{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List the alerts for the specified AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.alerts.list",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account for which to retrieve the alerts.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "locale": {
- // "description": "The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/alerts",
- // "response": {
- // "$ref": "Alerts"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.customchannels.get":
-
-type AccountsCustomchannelsGetCall struct {
- s *Service
- accountId string
- adClientId string
- customChannelId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get the specified custom channel from the specified ad client
-// for the specified account.
-func (r *AccountsCustomchannelsService) Get(accountId string, adClientId string, customChannelId string) *AccountsCustomchannelsGetCall {
- c := &AccountsCustomchannelsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- c.customChannelId = customChannelId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsCustomchannelsGetCall) Fields(s ...googleapi.Field) *AccountsCustomchannelsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsCustomchannelsGetCall) IfNoneMatch(entityTag string) *AccountsCustomchannelsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsCustomchannelsGetCall) Context(ctx context.Context) *AccountsCustomchannelsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsCustomchannelsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- "customChannelId": c.customChannelId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.customchannels.get" call.
-// Exactly one of *CustomChannel or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannel.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountsCustomchannelsGetCall) Do() (*CustomChannel, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannel{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get the specified custom channel from the specified ad client for the specified account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.customchannels.get",
- // "parameterOrder": [
- // "accountId",
- // "adClientId",
- // "customChannelId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the ad client belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client which contains the custom channel.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "customChannelId": {
- // "description": "Custom channel to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}",
- // "response": {
- // "$ref": "CustomChannel"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.customchannels.list":
-
-type AccountsCustomchannelsListCall struct {
- s *Service
- accountId string
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all custom channels in the specified ad client for the
-// specified account.
-func (r *AccountsCustomchannelsService) List(accountId string, adClientId string) *AccountsCustomchannelsListCall {
- c := &AccountsCustomchannelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of custom channels to include in the response, used for
-// paging.
-func (c *AccountsCustomchannelsListCall) MaxResults(maxResults int64) *AccountsCustomchannelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through custom channels. To retrieve the next
-// page, set this parameter to the value of "nextPageToken" from the
-// previous response.
-func (c *AccountsCustomchannelsListCall) PageToken(pageToken string) *AccountsCustomchannelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsCustomchannelsListCall) Fields(s ...googleapi.Field) *AccountsCustomchannelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsCustomchannelsListCall) IfNoneMatch(entityTag string) *AccountsCustomchannelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsCustomchannelsListCall) Context(ctx context.Context) *AccountsCustomchannelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsCustomchannelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/customchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.customchannels.list" call.
-// Exactly one of *CustomChannels or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannels.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountsCustomchannelsListCall) Do() (*CustomChannels, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannels{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all custom channels in the specified ad client for the specified account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.customchannels.list",
- // "parameterOrder": [
- // "accountId",
- // "adClientId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the ad client belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client for which to list custom channels.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of custom channels to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/customchannels",
- // "response": {
- // "$ref": "CustomChannels"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.customchannels.adunits.list":
-
-type AccountsCustomchannelsAdunitsListCall struct {
- s *Service
- accountId string
- adClientId string
- customChannelId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all ad units in the specified custom channel.
-func (r *AccountsCustomchannelsAdunitsService) List(accountId string, adClientId string, customChannelId string) *AccountsCustomchannelsAdunitsListCall {
- c := &AccountsCustomchannelsAdunitsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- c.customChannelId = customChannelId
- return c
-}
-
-// IncludeInactive sets the optional parameter "includeInactive":
-// Whether to include inactive ad units. Default: true.
-func (c *AccountsCustomchannelsAdunitsListCall) IncludeInactive(includeInactive bool) *AccountsCustomchannelsAdunitsListCall {
- c.opt_["includeInactive"] = includeInactive
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of ad units to include in the response, used for paging.
-func (c *AccountsCustomchannelsAdunitsListCall) MaxResults(maxResults int64) *AccountsCustomchannelsAdunitsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad units. To retrieve the next page, set
-// this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AccountsCustomchannelsAdunitsListCall) PageToken(pageToken string) *AccountsCustomchannelsAdunitsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsCustomchannelsAdunitsListCall) Fields(s ...googleapi.Field) *AccountsCustomchannelsAdunitsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsCustomchannelsAdunitsListCall) IfNoneMatch(entityTag string) *AccountsCustomchannelsAdunitsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsCustomchannelsAdunitsListCall) Context(ctx context.Context) *AccountsCustomchannelsAdunitsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsCustomchannelsAdunitsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["includeInactive"]; ok {
- params.Set("includeInactive", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}/adunits")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- "customChannelId": c.customChannelId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.customchannels.adunits.list" call.
-// Exactly one of *AdUnits or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnits.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsCustomchannelsAdunitsListCall) Do() (*AdUnits, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnits{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all ad units in the specified custom channel.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.customchannels.adunits.list",
- // "parameterOrder": [
- // "accountId",
- // "adClientId",
- // "customChannelId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the ad client belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client which contains the custom channel.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "customChannelId": {
- // "description": "Custom channel for which to list ad units.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "includeInactive": {
- // "description": "Whether to include inactive ad units. Default: true.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "The maximum number of ad units to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}/adunits",
- // "response": {
- // "$ref": "AdUnits"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.reports.generate":
-
-type AccountsReportsGenerateCall struct {
- s *Service
- accountId string
- startDate string
- endDate string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Generate: Generate an AdSense report based on the report request sent
-// in the query parameters. Returns the result as JSON; to retrieve
-// output in CSV format specify "alt=csv" as a query parameter.
-func (r *AccountsReportsService) Generate(accountId string, startDate string, endDate string) *AccountsReportsGenerateCall {
- c := &AccountsReportsGenerateCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.startDate = startDate
- c.endDate = endDate
- return c
-}
-
-// Currency sets the optional parameter "currency": Optional currency to
-// use when reporting on monetary metrics. Defaults to the account's
-// currency if not set.
-func (c *AccountsReportsGenerateCall) Currency(currency string) *AccountsReportsGenerateCall {
- c.opt_["currency"] = currency
- return c
-}
-
-// Dimension sets the optional parameter "dimension": Dimensions to base
-// the report on.
-func (c *AccountsReportsGenerateCall) Dimension(dimension string) *AccountsReportsGenerateCall {
- c.opt_["dimension"] = dimension
- return c
-}
-
-// Filter sets the optional parameter "filter": Filters to be run on the
-// report.
-func (c *AccountsReportsGenerateCall) Filter(filter string) *AccountsReportsGenerateCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// Locale sets the optional parameter "locale": Optional locale to use
-// for translating report output to a local language. Defaults to
-// "en_US" if not specified.
-func (c *AccountsReportsGenerateCall) Locale(locale string) *AccountsReportsGenerateCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of rows of report data to return.
-func (c *AccountsReportsGenerateCall) MaxResults(maxResults int64) *AccountsReportsGenerateCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// Metric sets the optional parameter "metric": Numeric columns to
-// include in the report.
-func (c *AccountsReportsGenerateCall) Metric(metric string) *AccountsReportsGenerateCall {
- c.opt_["metric"] = metric
- return c
-}
-
-// Sort sets the optional parameter "sort": The name of a dimension or
-// metric to sort the resulting report on, optionally prefixed with "+"
-// to sort ascending or "-" to sort descending. If no prefix is
-// specified, the column is sorted ascending.
-func (c *AccountsReportsGenerateCall) Sort(sort string) *AccountsReportsGenerateCall {
- c.opt_["sort"] = sort
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex": Index of the
-// first row of report data to return.
-func (c *AccountsReportsGenerateCall) StartIndex(startIndex int64) *AccountsReportsGenerateCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// UseTimezoneReporting sets the optional parameter
-// "useTimezoneReporting": Whether the report should be generated in the
-// AdSense account's local timezone. If false default PST/PDT timezone
-// will be used.
-func (c *AccountsReportsGenerateCall) UseTimezoneReporting(useTimezoneReporting bool) *AccountsReportsGenerateCall {
- c.opt_["useTimezoneReporting"] = useTimezoneReporting
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsReportsGenerateCall) Fields(s ...googleapi.Field) *AccountsReportsGenerateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsReportsGenerateCall) IfNoneMatch(entityTag string) *AccountsReportsGenerateCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do and Download methods.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsReportsGenerateCall) Context(ctx context.Context) *AccountsReportsGenerateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsReportsGenerateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("endDate", fmt.Sprintf("%v", c.endDate))
- params.Set("startDate", fmt.Sprintf("%v", c.startDate))
- if v, ok := c.opt_["currency"]; ok {
- params.Set("currency", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["dimension"]; ok {
- params.Set("dimension", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["metric"]; ok {
- params.Set("metric", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sort"]; ok {
- params.Set("sort", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["useTimezoneReporting"]; ok {
- params.Set("useTimezoneReporting", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/reports")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Download fetches the API endpoint's "media" value, instead of the normal
-// API response value. If the returned error is nil, the Response is guaranteed to
-// have a 2xx status code. Callers must close the Response.Body as usual.
-func (c *AccountsReportsGenerateCall) Download() (*http.Response, error) {
- res, err := c.doRequest("media")
- if err != nil {
- return nil, err
- }
- if err := googleapi.CheckMediaResponse(res); err != nil {
- res.Body.Close()
- return nil, err
- }
- return res, nil
-}
-
-// Do executes the "adsense.accounts.reports.generate" call.
-// Exactly one of *AdsenseReportsGenerateResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *AdsenseReportsGenerateResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountsReportsGenerateCall) Do() (*AdsenseReportsGenerateResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdsenseReportsGenerateResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.reports.generate",
- // "parameterOrder": [
- // "accountId",
- // "startDate",
- // "endDate"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account upon which to report.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "currency": {
- // "description": "Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.",
- // "location": "query",
- // "pattern": "[a-zA-Z]+",
- // "type": "string"
- // },
- // "dimension": {
- // "description": "Dimensions to base the report on.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "endDate": {
- // "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- // "location": "query",
- // "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- // "required": true,
- // "type": "string"
- // },
- // "filter": {
- // "description": "Filters to be run on the report.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+(==|=@).+",
- // "repeated": true,
- // "type": "string"
- // },
- // "locale": {
- // "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of rows of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "50000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "metric": {
- // "description": "Numeric columns to include in the report.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "sort": {
- // "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
- // "location": "query",
- // "pattern": "(\\+|-)?[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "startDate": {
- // "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- // "location": "query",
- // "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- // "required": true,
- // "type": "string"
- // },
- // "startIndex": {
- // "description": "Index of the first row of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "5000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "useTimezoneReporting": {
- // "description": "Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "accounts/{accountId}/reports",
- // "response": {
- // "$ref": "AdsenseReportsGenerateResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ],
- // "supportsMediaDownload": true
- // }
-
-}
-
-// method id "adsense.accounts.reports.saved.generate":
-
-type AccountsReportsSavedGenerateCall struct {
- s *Service
- accountId string
- savedReportId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Generate: Generate an AdSense report based on the saved report ID
-// sent in the query parameters.
-func (r *AccountsReportsSavedService) Generate(accountId string, savedReportId string) *AccountsReportsSavedGenerateCall {
- c := &AccountsReportsSavedGenerateCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.savedReportId = savedReportId
- return c
-}
-
-// Locale sets the optional parameter "locale": Optional locale to use
-// for translating report output to a local language. Defaults to
-// "en_US" if not specified.
-func (c *AccountsReportsSavedGenerateCall) Locale(locale string) *AccountsReportsSavedGenerateCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of rows of report data to return.
-func (c *AccountsReportsSavedGenerateCall) MaxResults(maxResults int64) *AccountsReportsSavedGenerateCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex": Index of the
-// first row of report data to return.
-func (c *AccountsReportsSavedGenerateCall) StartIndex(startIndex int64) *AccountsReportsSavedGenerateCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsReportsSavedGenerateCall) Fields(s ...googleapi.Field) *AccountsReportsSavedGenerateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsReportsSavedGenerateCall) IfNoneMatch(entityTag string) *AccountsReportsSavedGenerateCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsReportsSavedGenerateCall) Context(ctx context.Context) *AccountsReportsSavedGenerateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsReportsSavedGenerateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/reports/{savedReportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "savedReportId": c.savedReportId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.reports.saved.generate" call.
-// Exactly one of *AdsenseReportsGenerateResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *AdsenseReportsGenerateResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountsReportsSavedGenerateCall) Do() (*AdsenseReportsGenerateResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdsenseReportsGenerateResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Generate an AdSense report based on the saved report ID sent in the query parameters.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.reports.saved.generate",
- // "parameterOrder": [
- // "accountId",
- // "savedReportId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the saved reports belong.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "locale": {
- // "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of rows of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "50000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "savedReportId": {
- // "description": "The saved report to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "startIndex": {
- // "description": "Index of the first row of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "5000",
- // "minimum": "0",
- // "type": "integer"
- // }
- // },
- // "path": "accounts/{accountId}/reports/{savedReportId}",
- // "response": {
- // "$ref": "AdsenseReportsGenerateResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.reports.saved.list":
-
-type AccountsReportsSavedListCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all saved reports in the specified AdSense account.
-func (r *AccountsReportsSavedService) List(accountId string) *AccountsReportsSavedListCall {
- c := &AccountsReportsSavedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of saved reports to include in the response, used for paging.
-func (c *AccountsReportsSavedListCall) MaxResults(maxResults int64) *AccountsReportsSavedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through saved reports. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AccountsReportsSavedListCall) PageToken(pageToken string) *AccountsReportsSavedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsReportsSavedListCall) Fields(s ...googleapi.Field) *AccountsReportsSavedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsReportsSavedListCall) IfNoneMatch(entityTag string) *AccountsReportsSavedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsReportsSavedListCall) Context(ctx context.Context) *AccountsReportsSavedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsReportsSavedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/reports/saved")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.reports.saved.list" call.
-// Exactly one of *SavedReports or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *SavedReports.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccountsReportsSavedListCall) Do() (*SavedReports, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SavedReports{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all saved reports in the specified AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.reports.saved.list",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the saved reports belong.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of saved reports to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "100",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/reports/saved",
- // "response": {
- // "$ref": "SavedReports"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.savedadstyles.get":
-
-type AccountsSavedadstylesGetCall struct {
- s *Service
- accountId string
- savedAdStyleId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: List a specific saved ad style for the specified account.
-func (r *AccountsSavedadstylesService) Get(accountId string, savedAdStyleId string) *AccountsSavedadstylesGetCall {
- c := &AccountsSavedadstylesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.savedAdStyleId = savedAdStyleId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsSavedadstylesGetCall) Fields(s ...googleapi.Field) *AccountsSavedadstylesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsSavedadstylesGetCall) IfNoneMatch(entityTag string) *AccountsSavedadstylesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsSavedadstylesGetCall) Context(ctx context.Context) *AccountsSavedadstylesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsSavedadstylesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/savedadstyles/{savedAdStyleId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "savedAdStyleId": c.savedAdStyleId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.savedadstyles.get" call.
-// Exactly one of *SavedAdStyle or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *SavedAdStyle.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccountsSavedadstylesGetCall) Do() (*SavedAdStyle, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SavedAdStyle{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List a specific saved ad style for the specified account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.savedadstyles.get",
- // "parameterOrder": [
- // "accountId",
- // "savedAdStyleId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account for which to get the saved ad style.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "savedAdStyleId": {
- // "description": "Saved ad style to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/savedadstyles/{savedAdStyleId}",
- // "response": {
- // "$ref": "SavedAdStyle"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.savedadstyles.list":
-
-type AccountsSavedadstylesListCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all saved ad styles in the specified account.
-func (r *AccountsSavedadstylesService) List(accountId string) *AccountsSavedadstylesListCall {
- c := &AccountsSavedadstylesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of saved ad styles to include in the response, used for
-// paging.
-func (c *AccountsSavedadstylesListCall) MaxResults(maxResults int64) *AccountsSavedadstylesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through saved ad styles. To retrieve the next
-// page, set this parameter to the value of "nextPageToken" from the
-// previous response.
-func (c *AccountsSavedadstylesListCall) PageToken(pageToken string) *AccountsSavedadstylesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsSavedadstylesListCall) Fields(s ...googleapi.Field) *AccountsSavedadstylesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsSavedadstylesListCall) IfNoneMatch(entityTag string) *AccountsSavedadstylesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsSavedadstylesListCall) Context(ctx context.Context) *AccountsSavedadstylesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsSavedadstylesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/savedadstyles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.savedadstyles.list" call.
-// Exactly one of *SavedAdStyles or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *SavedAdStyles.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountsSavedadstylesListCall) Do() (*SavedAdStyles, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SavedAdStyles{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all saved ad styles in the specified account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.savedadstyles.list",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account for which to list saved ad styles.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of saved ad styles to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/savedadstyles",
- // "response": {
- // "$ref": "SavedAdStyles"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.urlchannels.list":
-
-type AccountsUrlchannelsListCall struct {
- s *Service
- accountId string
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all URL channels in the specified ad client for the
-// specified account.
-func (r *AccountsUrlchannelsService) List(accountId string, adClientId string) *AccountsUrlchannelsListCall {
- c := &AccountsUrlchannelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of URL channels to include in the response, used for paging.
-func (c *AccountsUrlchannelsListCall) MaxResults(maxResults int64) *AccountsUrlchannelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through URL channels. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AccountsUrlchannelsListCall) PageToken(pageToken string) *AccountsUrlchannelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsUrlchannelsListCall) Fields(s ...googleapi.Field) *AccountsUrlchannelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsUrlchannelsListCall) IfNoneMatch(entityTag string) *AccountsUrlchannelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsUrlchannelsListCall) Context(ctx context.Context) *AccountsUrlchannelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsUrlchannelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/urlchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.urlchannels.list" call.
-// Exactly one of *UrlChannels or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UrlChannels.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccountsUrlchannelsListCall) Do() (*UrlChannels, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UrlChannels{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all URL channels in the specified ad client for the specified account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.urlchannels.list",
- // "parameterOrder": [
- // "accountId",
- // "adClientId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the ad client belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client for which to list URL channels.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of URL channels to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/urlchannels",
- // "response": {
- // "$ref": "UrlChannels"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.adclients.list":
-
-type AdclientsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all ad clients in this AdSense account.
-func (r *AdclientsService) List() *AdclientsListCall {
- c := &AdclientsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of ad clients to include in the response, used for paging.
-func (c *AdclientsListCall) MaxResults(maxResults int64) *AdclientsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad clients. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AdclientsListCall) PageToken(pageToken string) *AdclientsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdclientsListCall) Fields(s ...googleapi.Field) *AdclientsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdclientsListCall) IfNoneMatch(entityTag string) *AdclientsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdclientsListCall) Context(ctx context.Context) *AdclientsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdclientsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.adclients.list" call.
-// Exactly one of *AdClients or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AdClients.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AdclientsListCall) Do() (*AdClients, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdClients{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all ad clients in this AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.adclients.list",
- // "parameters": {
- // "maxResults": {
- // "description": "The maximum number of ad clients to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients",
- // "response": {
- // "$ref": "AdClients"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.adunits.get":
-
-type AdunitsGetCall struct {
- s *Service
- adClientId string
- adUnitId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets the specified ad unit in the specified ad client.
-func (r *AdunitsService) Get(adClientId string, adUnitId string) *AdunitsGetCall {
- c := &AdunitsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.adUnitId = adUnitId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdunitsGetCall) Fields(s ...googleapi.Field) *AdunitsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdunitsGetCall) IfNoneMatch(entityTag string) *AdunitsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdunitsGetCall) Context(ctx context.Context) *AdunitsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdunitsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/adunits/{adUnitId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- "adUnitId": c.adUnitId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.adunits.get" call.
-// Exactly one of *AdUnit or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnit.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AdunitsGetCall) Do() (*AdUnit, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnit{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the specified ad unit in the specified ad client.",
- // "httpMethod": "GET",
- // "id": "adsense.adunits.get",
- // "parameterOrder": [
- // "adClientId",
- // "adUnitId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client for which to get the ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adUnitId": {
- // "description": "Ad unit to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/adunits/{adUnitId}",
- // "response": {
- // "$ref": "AdUnit"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.adunits.getAdCode":
-
-type AdunitsGetAdCodeCall struct {
- s *Service
- adClientId string
- adUnitId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetAdCode: Get ad code for the specified ad unit.
-func (r *AdunitsService) GetAdCode(adClientId string, adUnitId string) *AdunitsGetAdCodeCall {
- c := &AdunitsGetAdCodeCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.adUnitId = adUnitId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdunitsGetAdCodeCall) Fields(s ...googleapi.Field) *AdunitsGetAdCodeCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdunitsGetAdCodeCall) IfNoneMatch(entityTag string) *AdunitsGetAdCodeCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdunitsGetAdCodeCall) Context(ctx context.Context) *AdunitsGetAdCodeCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdunitsGetAdCodeCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/adunits/{adUnitId}/adcode")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- "adUnitId": c.adUnitId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.adunits.getAdCode" call.
-// Exactly one of *AdCode or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdCode.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AdunitsGetAdCodeCall) Do() (*AdCode, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdCode{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get ad code for the specified ad unit.",
- // "httpMethod": "GET",
- // "id": "adsense.adunits.getAdCode",
- // "parameterOrder": [
- // "adClientId",
- // "adUnitId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client with contains the ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adUnitId": {
- // "description": "Ad unit to get the code for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/adunits/{adUnitId}/adcode",
- // "response": {
- // "$ref": "AdCode"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.adunits.list":
-
-type AdunitsListCall struct {
- s *Service
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all ad units in the specified ad client for this AdSense
-// account.
-func (r *AdunitsService) List(adClientId string) *AdunitsListCall {
- c := &AdunitsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- return c
-}
-
-// IncludeInactive sets the optional parameter "includeInactive":
-// Whether to include inactive ad units. Default: true.
-func (c *AdunitsListCall) IncludeInactive(includeInactive bool) *AdunitsListCall {
- c.opt_["includeInactive"] = includeInactive
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of ad units to include in the response, used for paging.
-func (c *AdunitsListCall) MaxResults(maxResults int64) *AdunitsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad units. To retrieve the next page, set
-// this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AdunitsListCall) PageToken(pageToken string) *AdunitsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdunitsListCall) Fields(s ...googleapi.Field) *AdunitsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdunitsListCall) IfNoneMatch(entityTag string) *AdunitsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdunitsListCall) Context(ctx context.Context) *AdunitsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdunitsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["includeInactive"]; ok {
- params.Set("includeInactive", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/adunits")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.adunits.list" call.
-// Exactly one of *AdUnits or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnits.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AdunitsListCall) Do() (*AdUnits, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnits{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all ad units in the specified ad client for this AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.adunits.list",
- // "parameterOrder": [
- // "adClientId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client for which to list ad units.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "includeInactive": {
- // "description": "Whether to include inactive ad units. Default: true.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "The maximum number of ad units to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/adunits",
- // "response": {
- // "$ref": "AdUnits"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.adunits.customchannels.list":
-
-type AdunitsCustomchannelsListCall struct {
- s *Service
- adClientId string
- adUnitId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all custom channels which the specified ad unit belongs
-// to.
-func (r *AdunitsCustomchannelsService) List(adClientId string, adUnitId string) *AdunitsCustomchannelsListCall {
- c := &AdunitsCustomchannelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.adUnitId = adUnitId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of custom channels to include in the response, used for
-// paging.
-func (c *AdunitsCustomchannelsListCall) MaxResults(maxResults int64) *AdunitsCustomchannelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through custom channels. To retrieve the next
-// page, set this parameter to the value of "nextPageToken" from the
-// previous response.
-func (c *AdunitsCustomchannelsListCall) PageToken(pageToken string) *AdunitsCustomchannelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdunitsCustomchannelsListCall) Fields(s ...googleapi.Field) *AdunitsCustomchannelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdunitsCustomchannelsListCall) IfNoneMatch(entityTag string) *AdunitsCustomchannelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdunitsCustomchannelsListCall) Context(ctx context.Context) *AdunitsCustomchannelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdunitsCustomchannelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/adunits/{adUnitId}/customchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- "adUnitId": c.adUnitId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.adunits.customchannels.list" call.
-// Exactly one of *CustomChannels or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannels.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AdunitsCustomchannelsListCall) Do() (*CustomChannels, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannels{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all custom channels which the specified ad unit belongs to.",
- // "httpMethod": "GET",
- // "id": "adsense.adunits.customchannels.list",
- // "parameterOrder": [
- // "adClientId",
- // "adUnitId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client which contains the ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adUnitId": {
- // "description": "Ad unit for which to list custom channels.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of custom channels to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/adunits/{adUnitId}/customchannels",
- // "response": {
- // "$ref": "CustomChannels"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.alerts.list":
-
-type AlertsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List the alerts for this AdSense account.
-func (r *AlertsService) List() *AlertsListCall {
- c := &AlertsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Locale sets the optional parameter "locale": The locale to use for
-// translating alert messages. The account locale will be used if this
-// is not supplied. The AdSense default (English) will be used if the
-// supplied locale is invalid or unsupported.
-func (c *AlertsListCall) Locale(locale string) *AlertsListCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AlertsListCall) Fields(s ...googleapi.Field) *AlertsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AlertsListCall) IfNoneMatch(entityTag string) *AlertsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AlertsListCall) Context(ctx context.Context) *AlertsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AlertsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "alerts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.alerts.list" call.
-// Exactly one of *Alerts or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Alerts.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AlertsListCall) Do() (*Alerts, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Alerts{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List the alerts for this AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.alerts.list",
- // "parameters": {
- // "locale": {
- // "description": "The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "alerts",
- // "response": {
- // "$ref": "Alerts"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.customchannels.get":
-
-type CustomchannelsGetCall struct {
- s *Service
- adClientId string
- customChannelId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get the specified custom channel from the specified ad client.
-func (r *CustomchannelsService) Get(adClientId string, customChannelId string) *CustomchannelsGetCall {
- c := &CustomchannelsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.customChannelId = customChannelId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CustomchannelsGetCall) Fields(s ...googleapi.Field) *CustomchannelsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CustomchannelsGetCall) IfNoneMatch(entityTag string) *CustomchannelsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CustomchannelsGetCall) Context(ctx context.Context) *CustomchannelsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CustomchannelsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/customchannels/{customChannelId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- "customChannelId": c.customChannelId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.customchannels.get" call.
-// Exactly one of *CustomChannel or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannel.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CustomchannelsGetCall) Do() (*CustomChannel, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannel{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get the specified custom channel from the specified ad client.",
- // "httpMethod": "GET",
- // "id": "adsense.customchannels.get",
- // "parameterOrder": [
- // "adClientId",
- // "customChannelId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client which contains the custom channel.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "customChannelId": {
- // "description": "Custom channel to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/customchannels/{customChannelId}",
- // "response": {
- // "$ref": "CustomChannel"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.customchannels.list":
-
-type CustomchannelsListCall struct {
- s *Service
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all custom channels in the specified ad client for this
-// AdSense account.
-func (r *CustomchannelsService) List(adClientId string) *CustomchannelsListCall {
- c := &CustomchannelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of custom channels to include in the response, used for
-// paging.
-func (c *CustomchannelsListCall) MaxResults(maxResults int64) *CustomchannelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through custom channels. To retrieve the next
-// page, set this parameter to the value of "nextPageToken" from the
-// previous response.
-func (c *CustomchannelsListCall) PageToken(pageToken string) *CustomchannelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CustomchannelsListCall) Fields(s ...googleapi.Field) *CustomchannelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CustomchannelsListCall) IfNoneMatch(entityTag string) *CustomchannelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CustomchannelsListCall) Context(ctx context.Context) *CustomchannelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CustomchannelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/customchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.customchannels.list" call.
-// Exactly one of *CustomChannels or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannels.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CustomchannelsListCall) Do() (*CustomChannels, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannels{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all custom channels in the specified ad client for this AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.customchannels.list",
- // "parameterOrder": [
- // "adClientId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client for which to list custom channels.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of custom channels to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/customchannels",
- // "response": {
- // "$ref": "CustomChannels"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.customchannels.adunits.list":
-
-type CustomchannelsAdunitsListCall struct {
- s *Service
- adClientId string
- customChannelId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all ad units in the specified custom channel.
-func (r *CustomchannelsAdunitsService) List(adClientId string, customChannelId string) *CustomchannelsAdunitsListCall {
- c := &CustomchannelsAdunitsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.customChannelId = customChannelId
- return c
-}
-
-// IncludeInactive sets the optional parameter "includeInactive":
-// Whether to include inactive ad units. Default: true.
-func (c *CustomchannelsAdunitsListCall) IncludeInactive(includeInactive bool) *CustomchannelsAdunitsListCall {
- c.opt_["includeInactive"] = includeInactive
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of ad units to include in the response, used for paging.
-func (c *CustomchannelsAdunitsListCall) MaxResults(maxResults int64) *CustomchannelsAdunitsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad units. To retrieve the next page, set
-// this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *CustomchannelsAdunitsListCall) PageToken(pageToken string) *CustomchannelsAdunitsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CustomchannelsAdunitsListCall) Fields(s ...googleapi.Field) *CustomchannelsAdunitsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CustomchannelsAdunitsListCall) IfNoneMatch(entityTag string) *CustomchannelsAdunitsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CustomchannelsAdunitsListCall) Context(ctx context.Context) *CustomchannelsAdunitsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CustomchannelsAdunitsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["includeInactive"]; ok {
- params.Set("includeInactive", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/customchannels/{customChannelId}/adunits")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- "customChannelId": c.customChannelId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.customchannels.adunits.list" call.
-// Exactly one of *AdUnits or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnits.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *CustomchannelsAdunitsListCall) Do() (*AdUnits, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnits{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all ad units in the specified custom channel.",
- // "httpMethod": "GET",
- // "id": "adsense.customchannels.adunits.list",
- // "parameterOrder": [
- // "adClientId",
- // "customChannelId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client which contains the custom channel.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "customChannelId": {
- // "description": "Custom channel for which to list ad units.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "includeInactive": {
- // "description": "Whether to include inactive ad units. Default: true.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "The maximum number of ad units to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/customchannels/{customChannelId}/adunits",
- // "response": {
- // "$ref": "AdUnits"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.metadata.dimensions.list":
-
-type MetadataDimensionsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List the metadata for the dimensions available to this AdSense
-// account.
-func (r *MetadataDimensionsService) List() *MetadataDimensionsListCall {
- c := &MetadataDimensionsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MetadataDimensionsListCall) Fields(s ...googleapi.Field) *MetadataDimensionsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MetadataDimensionsListCall) IfNoneMatch(entityTag string) *MetadataDimensionsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MetadataDimensionsListCall) Context(ctx context.Context) *MetadataDimensionsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MetadataDimensionsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "metadata/dimensions")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.metadata.dimensions.list" call.
-// Exactly one of *Metadata or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Metadata.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *MetadataDimensionsListCall) Do() (*Metadata, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Metadata{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List the metadata for the dimensions available to this AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.metadata.dimensions.list",
- // "path": "metadata/dimensions",
- // "response": {
- // "$ref": "Metadata"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.metadata.metrics.list":
-
-type MetadataMetricsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List the metadata for the metrics available to this AdSense
-// account.
-func (r *MetadataMetricsService) List() *MetadataMetricsListCall {
- c := &MetadataMetricsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MetadataMetricsListCall) Fields(s ...googleapi.Field) *MetadataMetricsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MetadataMetricsListCall) IfNoneMatch(entityTag string) *MetadataMetricsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MetadataMetricsListCall) Context(ctx context.Context) *MetadataMetricsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MetadataMetricsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "metadata/metrics")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.metadata.metrics.list" call.
-// Exactly one of *Metadata or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Metadata.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *MetadataMetricsListCall) Do() (*Metadata, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Metadata{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List the metadata for the metrics available to this AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.metadata.metrics.list",
- // "path": "metadata/metrics",
- // "response": {
- // "$ref": "Metadata"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.reports.generate":
-
-type ReportsGenerateCall struct {
- s *Service
- startDate string
- endDate string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Generate: Generate an AdSense report based on the report request sent
-// in the query parameters. Returns the result as JSON; to retrieve
-// output in CSV format specify "alt=csv" as a query parameter.
-func (r *ReportsService) Generate(startDate string, endDate string) *ReportsGenerateCall {
- c := &ReportsGenerateCall{s: r.s, opt_: make(map[string]interface{})}
- c.startDate = startDate
- c.endDate = endDate
- return c
-}
-
-// AccountId sets the optional parameter "accountId": Accounts upon
-// which to report.
-func (c *ReportsGenerateCall) AccountId(accountId string) *ReportsGenerateCall {
- c.opt_["accountId"] = accountId
- return c
-}
-
-// Currency sets the optional parameter "currency": Optional currency to
-// use when reporting on monetary metrics. Defaults to the account's
-// currency if not set.
-func (c *ReportsGenerateCall) Currency(currency string) *ReportsGenerateCall {
- c.opt_["currency"] = currency
- return c
-}
-
-// Dimension sets the optional parameter "dimension": Dimensions to base
-// the report on.
-func (c *ReportsGenerateCall) Dimension(dimension string) *ReportsGenerateCall {
- c.opt_["dimension"] = dimension
- return c
-}
-
-// Filter sets the optional parameter "filter": Filters to be run on the
-// report.
-func (c *ReportsGenerateCall) Filter(filter string) *ReportsGenerateCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// Locale sets the optional parameter "locale": Optional locale to use
-// for translating report output to a local language. Defaults to
-// "en_US" if not specified.
-func (c *ReportsGenerateCall) Locale(locale string) *ReportsGenerateCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of rows of report data to return.
-func (c *ReportsGenerateCall) MaxResults(maxResults int64) *ReportsGenerateCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// Metric sets the optional parameter "metric": Numeric columns to
-// include in the report.
-func (c *ReportsGenerateCall) Metric(metric string) *ReportsGenerateCall {
- c.opt_["metric"] = metric
- return c
-}
-
-// Sort sets the optional parameter "sort": The name of a dimension or
-// metric to sort the resulting report on, optionally prefixed with "+"
-// to sort ascending or "-" to sort descending. If no prefix is
-// specified, the column is sorted ascending.
-func (c *ReportsGenerateCall) Sort(sort string) *ReportsGenerateCall {
- c.opt_["sort"] = sort
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex": Index of the
-// first row of report data to return.
-func (c *ReportsGenerateCall) StartIndex(startIndex int64) *ReportsGenerateCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// UseTimezoneReporting sets the optional parameter
-// "useTimezoneReporting": Whether the report should be generated in the
-// AdSense account's local timezone. If false default PST/PDT timezone
-// will be used.
-func (c *ReportsGenerateCall) UseTimezoneReporting(useTimezoneReporting bool) *ReportsGenerateCall {
- c.opt_["useTimezoneReporting"] = useTimezoneReporting
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsGenerateCall) Fields(s ...googleapi.Field) *ReportsGenerateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsGenerateCall) IfNoneMatch(entityTag string) *ReportsGenerateCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do and Download methods.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsGenerateCall) Context(ctx context.Context) *ReportsGenerateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsGenerateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("endDate", fmt.Sprintf("%v", c.endDate))
- params.Set("startDate", fmt.Sprintf("%v", c.startDate))
- if v, ok := c.opt_["accountId"]; ok {
- params.Set("accountId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["currency"]; ok {
- params.Set("currency", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["dimension"]; ok {
- params.Set("dimension", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["metric"]; ok {
- params.Set("metric", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sort"]; ok {
- params.Set("sort", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["useTimezoneReporting"]; ok {
- params.Set("useTimezoneReporting", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "reports")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Download fetches the API endpoint's "media" value, instead of the normal
-// API response value. If the returned error is nil, the Response is guaranteed to
-// have a 2xx status code. Callers must close the Response.Body as usual.
-func (c *ReportsGenerateCall) Download() (*http.Response, error) {
- res, err := c.doRequest("media")
- if err != nil {
- return nil, err
- }
- if err := googleapi.CheckMediaResponse(res); err != nil {
- res.Body.Close()
- return nil, err
- }
- return res, nil
-}
-
-// Do executes the "adsense.reports.generate" call.
-// Exactly one of *AdsenseReportsGenerateResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *AdsenseReportsGenerateResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ReportsGenerateCall) Do() (*AdsenseReportsGenerateResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdsenseReportsGenerateResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
- // "httpMethod": "GET",
- // "id": "adsense.reports.generate",
- // "parameterOrder": [
- // "startDate",
- // "endDate"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Accounts upon which to report.",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "currency": {
- // "description": "Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.",
- // "location": "query",
- // "pattern": "[a-zA-Z]+",
- // "type": "string"
- // },
- // "dimension": {
- // "description": "Dimensions to base the report on.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "endDate": {
- // "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- // "location": "query",
- // "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- // "required": true,
- // "type": "string"
- // },
- // "filter": {
- // "description": "Filters to be run on the report.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+(==|=@).+",
- // "repeated": true,
- // "type": "string"
- // },
- // "locale": {
- // "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of rows of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "50000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "metric": {
- // "description": "Numeric columns to include in the report.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "sort": {
- // "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
- // "location": "query",
- // "pattern": "(\\+|-)?[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "startDate": {
- // "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- // "location": "query",
- // "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- // "required": true,
- // "type": "string"
- // },
- // "startIndex": {
- // "description": "Index of the first row of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "5000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "useTimezoneReporting": {
- // "description": "Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "reports",
- // "response": {
- // "$ref": "AdsenseReportsGenerateResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ],
- // "supportsMediaDownload": true
- // }
-
-}
-
-// method id "adsense.reports.saved.generate":
-
-type ReportsSavedGenerateCall struct {
- s *Service
- savedReportId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Generate: Generate an AdSense report based on the saved report ID
-// sent in the query parameters.
-func (r *ReportsSavedService) Generate(savedReportId string) *ReportsSavedGenerateCall {
- c := &ReportsSavedGenerateCall{s: r.s, opt_: make(map[string]interface{})}
- c.savedReportId = savedReportId
- return c
-}
-
-// Locale sets the optional parameter "locale": Optional locale to use
-// for translating report output to a local language. Defaults to
-// "en_US" if not specified.
-func (c *ReportsSavedGenerateCall) Locale(locale string) *ReportsSavedGenerateCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of rows of report data to return.
-func (c *ReportsSavedGenerateCall) MaxResults(maxResults int64) *ReportsSavedGenerateCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex": Index of the
-// first row of report data to return.
-func (c *ReportsSavedGenerateCall) StartIndex(startIndex int64) *ReportsSavedGenerateCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsSavedGenerateCall) Fields(s ...googleapi.Field) *ReportsSavedGenerateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsSavedGenerateCall) IfNoneMatch(entityTag string) *ReportsSavedGenerateCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsSavedGenerateCall) Context(ctx context.Context) *ReportsSavedGenerateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsSavedGenerateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "reports/{savedReportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "savedReportId": c.savedReportId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.reports.saved.generate" call.
-// Exactly one of *AdsenseReportsGenerateResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *AdsenseReportsGenerateResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ReportsSavedGenerateCall) Do() (*AdsenseReportsGenerateResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdsenseReportsGenerateResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Generate an AdSense report based on the saved report ID sent in the query parameters.",
- // "httpMethod": "GET",
- // "id": "adsense.reports.saved.generate",
- // "parameterOrder": [
- // "savedReportId"
- // ],
- // "parameters": {
- // "locale": {
- // "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of rows of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "50000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "savedReportId": {
- // "description": "The saved report to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "startIndex": {
- // "description": "Index of the first row of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "5000",
- // "minimum": "0",
- // "type": "integer"
- // }
- // },
- // "path": "reports/{savedReportId}",
- // "response": {
- // "$ref": "AdsenseReportsGenerateResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.reports.saved.list":
-
-type ReportsSavedListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all saved reports in this AdSense account.
-func (r *ReportsSavedService) List() *ReportsSavedListCall {
- c := &ReportsSavedListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of saved reports to include in the response, used for paging.
-func (c *ReportsSavedListCall) MaxResults(maxResults int64) *ReportsSavedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through saved reports. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *ReportsSavedListCall) PageToken(pageToken string) *ReportsSavedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsSavedListCall) Fields(s ...googleapi.Field) *ReportsSavedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsSavedListCall) IfNoneMatch(entityTag string) *ReportsSavedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsSavedListCall) Context(ctx context.Context) *ReportsSavedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsSavedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "reports/saved")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.reports.saved.list" call.
-// Exactly one of *SavedReports or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *SavedReports.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ReportsSavedListCall) Do() (*SavedReports, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SavedReports{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all saved reports in this AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.reports.saved.list",
- // "parameters": {
- // "maxResults": {
- // "description": "The maximum number of saved reports to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "100",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "reports/saved",
- // "response": {
- // "$ref": "SavedReports"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.savedadstyles.get":
-
-type SavedadstylesGetCall struct {
- s *Service
- savedAdStyleId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get a specific saved ad style from the user's account.
-func (r *SavedadstylesService) Get(savedAdStyleId string) *SavedadstylesGetCall {
- c := &SavedadstylesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.savedAdStyleId = savedAdStyleId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SavedadstylesGetCall) Fields(s ...googleapi.Field) *SavedadstylesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SavedadstylesGetCall) IfNoneMatch(entityTag string) *SavedadstylesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SavedadstylesGetCall) Context(ctx context.Context) *SavedadstylesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SavedadstylesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "savedadstyles/{savedAdStyleId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "savedAdStyleId": c.savedAdStyleId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.savedadstyles.get" call.
-// Exactly one of *SavedAdStyle or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *SavedAdStyle.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *SavedadstylesGetCall) Do() (*SavedAdStyle, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SavedAdStyle{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get a specific saved ad style from the user's account.",
- // "httpMethod": "GET",
- // "id": "adsense.savedadstyles.get",
- // "parameterOrder": [
- // "savedAdStyleId"
- // ],
- // "parameters": {
- // "savedAdStyleId": {
- // "description": "Saved ad style to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "savedadstyles/{savedAdStyleId}",
- // "response": {
- // "$ref": "SavedAdStyle"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.savedadstyles.list":
-
-type SavedadstylesListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all saved ad styles in the user's account.
-func (r *SavedadstylesService) List() *SavedadstylesListCall {
- c := &SavedadstylesListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of saved ad styles to include in the response, used for
-// paging.
-func (c *SavedadstylesListCall) MaxResults(maxResults int64) *SavedadstylesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through saved ad styles. To retrieve the next
-// page, set this parameter to the value of "nextPageToken" from the
-// previous response.
-func (c *SavedadstylesListCall) PageToken(pageToken string) *SavedadstylesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SavedadstylesListCall) Fields(s ...googleapi.Field) *SavedadstylesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SavedadstylesListCall) IfNoneMatch(entityTag string) *SavedadstylesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SavedadstylesListCall) Context(ctx context.Context) *SavedadstylesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SavedadstylesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "savedadstyles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.savedadstyles.list" call.
-// Exactly one of *SavedAdStyles or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *SavedAdStyles.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *SavedadstylesListCall) Do() (*SavedAdStyles, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SavedAdStyles{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all saved ad styles in the user's account.",
- // "httpMethod": "GET",
- // "id": "adsense.savedadstyles.list",
- // "parameters": {
- // "maxResults": {
- // "description": "The maximum number of saved ad styles to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "savedadstyles",
- // "response": {
- // "$ref": "SavedAdStyles"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.urlchannels.list":
-
-type UrlchannelsListCall struct {
- s *Service
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all URL channels in the specified ad client for this
-// AdSense account.
-func (r *UrlchannelsService) List(adClientId string) *UrlchannelsListCall {
- c := &UrlchannelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of URL channels to include in the response, used for paging.
-func (c *UrlchannelsListCall) MaxResults(maxResults int64) *UrlchannelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through URL channels. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *UrlchannelsListCall) PageToken(pageToken string) *UrlchannelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UrlchannelsListCall) Fields(s ...googleapi.Field) *UrlchannelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UrlchannelsListCall) IfNoneMatch(entityTag string) *UrlchannelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UrlchannelsListCall) Context(ctx context.Context) *UrlchannelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UrlchannelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/urlchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.urlchannels.list" call.
-// Exactly one of *UrlChannels or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UrlChannels.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UrlchannelsListCall) Do() (*UrlChannels, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UrlChannels{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all URL channels in the specified ad client for this AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.urlchannels.list",
- // "parameterOrder": [
- // "adClientId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client for which to list URL channels.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of URL channels to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/urlchannels",
- // "response": {
- // "$ref": "UrlChannels"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/adsense/v1.4/adsense-api.json b/vendor/google.golang.org/api/adsense/v1.4/adsense-api.json
deleted file mode 100644
index f67a90c2..00000000
--- a/vendor/google.golang.org/api/adsense/v1.4/adsense-api.json
+++ /dev/null
@@ -1,2411 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/0LJdy3bhVfuPDmaGtJK4_nceDoU\"",
- "discoveryVersion": "v1",
- "id": "adsense:v1.4",
- "name": "adsense",
- "canonicalName": "AdSense",
- "version": "v1.4",
- "revision": "20151013",
- "title": "AdSense Management API",
- "description": "Gives AdSense publishers access to their inventory and the ability to generate reports",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/adsense-16.png",
- "x32": "https://www.google.com/images/icons/product/adsense-32.png"
- },
- "documentationLink": "https://developers.google.com/adsense/management/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/adsense/v1.4/",
- "basePath": "/adsense/v1.4/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "adsense/v1.4/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "csv",
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of text/csv",
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/adsense": {
- "description": "View and manage your AdSense data"
- },
- "https://www.googleapis.com/auth/adsense.readonly": {
- "description": "View your AdSense data"
- }
- }
- }
- },
- "schemas": {
- "Account": {
- "id": "Account",
- "type": "object",
- "properties": {
- "creation_time": {
- "type": "string",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this account."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#account.",
- "default": "adsense#account"
- },
- "name": {
- "type": "string",
- "description": "Name of this account."
- },
- "premium": {
- "type": "boolean",
- "description": "Whether this account is premium."
- },
- "subAccounts": {
- "type": "array",
- "description": "Sub accounts of the this account.",
- "items": {
- "$ref": "Account"
- }
- },
- "timezone": {
- "type": "string",
- "description": "AdSense timezone of this account."
- }
- }
- },
- "Accounts": {
- "id": "Accounts",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The accounts returned in this list response.",
- "items": {
- "$ref": "Account"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#accounts.",
- "default": "adsense#accounts"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through accounts. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "AdClient": {
- "id": "AdClient",
- "type": "object",
- "properties": {
- "arcOptIn": {
- "type": "boolean",
- "description": "Whether this ad client is opted in to ARC."
- },
- "arcReviewMode": {
- "type": "string",
- "description": "ARC review mode this ad client is in. Empty if the client is not opted in to ARC. Possible values: POST_REVIEW, AUTOMATIC_PRE_REVIEW."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this ad client."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#adClient.",
- "default": "adsense#adClient"
- },
- "productCode": {
- "type": "string",
- "description": "This ad client's product code, which corresponds to the PRODUCT_CODE report dimension."
- },
- "supportsReporting": {
- "type": "boolean",
- "description": "Whether this ad client supports being reported on."
- }
- }
- },
- "AdClients": {
- "id": "AdClients",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The ad clients returned in this list response.",
- "items": {
- "$ref": "AdClient"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#adClients.",
- "default": "adsense#adClients"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "AdCode": {
- "id": "AdCode",
- "type": "object",
- "properties": {
- "adCode": {
- "type": "string",
- "description": "The ad code snippet."
- },
- "kind": {
- "type": "string",
- "description": "Kind this is, in this case adsense#adCode.",
- "default": "adsense#adCode"
- }
- }
- },
- "AdStyle": {
- "id": "AdStyle",
- "type": "object",
- "properties": {
- "colors": {
- "type": "object",
- "description": "The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.",
- "properties": {
- "background": {
- "type": "string",
- "description": "The color of the ad background."
- },
- "border": {
- "type": "string",
- "description": "The color of the ad border."
- },
- "text": {
- "type": "string",
- "description": "The color of the ad text."
- },
- "title": {
- "type": "string",
- "description": "The color of the ad title."
- },
- "url": {
- "type": "string",
- "description": "The color of the ad url."
- }
- }
- },
- "corners": {
- "type": "string",
- "description": "The style of the corners in the ad."
- },
- "font": {
- "type": "object",
- "description": "The font which is included in the style.",
- "properties": {
- "family": {
- "type": "string",
- "description": "The family of the font."
- },
- "size": {
- "type": "string",
- "description": "The size of the font."
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind this is, in this case adsense#adStyle.",
- "default": "adsense#adStyle"
- }
- }
- },
- "AdUnit": {
- "id": "AdUnit",
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "Identity code of this ad unit, not necessarily unique across ad clients."
- },
- "contentAdsSettings": {
- "type": "object",
- "description": "Settings specific to content ads (AFC) and highend mobile content ads (AFMC).",
- "properties": {
- "backupOption": {
- "type": "object",
- "description": "The backup option to be used in instances where no ad is available.",
- "properties": {
- "color": {
- "type": "string",
- "description": "Color to use when type is set to COLOR."
- },
- "type": {
- "type": "string",
- "description": "Type of the backup option. Possible values are BLANK, COLOR and URL."
- },
- "url": {
- "type": "string",
- "description": "URL to use when type is set to URL."
- }
- }
- },
- "size": {
- "type": "string",
- "description": "Size of this ad unit."
- },
- "type": {
- "type": "string",
- "description": "Type of this ad unit."
- }
- }
- },
- "customStyle": {
- "$ref": "AdStyle",
- "description": "Custom style information specific to this ad unit."
- },
- "feedAdsSettings": {
- "type": "object",
- "description": "Settings specific to feed ads (AFF).",
- "properties": {
- "adPosition": {
- "type": "string",
- "description": "The position of the ads relative to the feed entries."
- },
- "frequency": {
- "type": "integer",
- "description": "The frequency at which ads should appear in the feed (i.e. every N entries).",
- "format": "int32"
- },
- "minimumWordCount": {
- "type": "integer",
- "description": "The minimum length an entry should be in order to have attached ads.",
- "format": "int32"
- },
- "type": {
- "type": "string",
- "description": "The type of ads which should appear."
- }
- }
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#adUnit.",
- "default": "adsense#adUnit"
- },
- "mobileContentAdsSettings": {
- "type": "object",
- "description": "Settings specific to WAP mobile content ads (AFMC).",
- "properties": {
- "markupLanguage": {
- "type": "string",
- "description": "The markup language to use for this ad unit."
- },
- "scriptingLanguage": {
- "type": "string",
- "description": "The scripting language to use for this ad unit."
- },
- "size": {
- "type": "string",
- "description": "Size of this ad unit."
- },
- "type": {
- "type": "string",
- "description": "Type of this ad unit."
- }
- }
- },
- "name": {
- "type": "string",
- "description": "Name of this ad unit."
- },
- "savedStyleId": {
- "type": "string",
- "description": "ID of the saved ad style which holds this ad unit's style information."
- },
- "status": {
- "type": "string",
- "description": "Status of this ad unit. Possible values are:\nNEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.\n\nACTIVE: Indicates that there has been activity on this ad unit in the last seven days.\n\nINACTIVE: Indicates that there has been no activity on this ad unit in the last seven days."
- }
- }
- },
- "AdUnits": {
- "id": "AdUnits",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The ad units returned in this list response.",
- "items": {
- "$ref": "AdUnit"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#adUnits.",
- "default": "adsense#adUnits"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through ad units. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "AdsenseReportsGenerateResponse": {
- "id": "AdsenseReportsGenerateResponse",
- "type": "object",
- "properties": {
- "averages": {
- "type": "array",
- "description": "The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
- "items": {
- "type": "string"
- }
- },
- "endDate": {
- "type": "string",
- "description": "The requested end date in yyyy-mm-dd format."
- },
- "headers": {
- "type": "array",
- "description": "The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.",
- "items": {
- "type": "object",
- "properties": {
- "currency": {
- "type": "string",
- "description": "The currency of this column. Only present if the header type is METRIC_CURRENCY."
- },
- "name": {
- "type": "string",
- "description": "The name of the header."
- },
- "type": {
- "type": "string",
- "description": "The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY."
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind this is, in this case adsense#report.",
- "default": "adsense#report"
- },
- "rows": {
- "type": "array",
- "description": "The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.",
- "items": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "startDate": {
- "type": "string",
- "description": "The requested start date in yyyy-mm-dd format."
- },
- "totalMatchedRows": {
- "type": "string",
- "description": "The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.",
- "format": "int64"
- },
- "totals": {
- "type": "array",
- "description": "The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
- "items": {
- "type": "string"
- }
- },
- "warnings": {
- "type": "array",
- "description": "Any warnings associated with generation of the report.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "Alert": {
- "id": "Alert",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this alert. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "isDismissible": {
- "type": "boolean",
- "description": "Whether this alert can be dismissed."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#alert.",
- "default": "adsense#alert"
- },
- "message": {
- "type": "string",
- "description": "The localized alert message."
- },
- "severity": {
- "type": "string",
- "description": "Severity of this alert. Possible values: INFO, WARNING, SEVERE."
- },
- "type": {
- "type": "string",
- "description": "Type of this alert. Possible values: SELF_HOLD, MIGRATED_TO_BILLING3, ADDRESS_PIN_VERIFICATION, PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, GRAYLISTED_PUBLISHER, API_HOLD."
- }
- }
- },
- "Alerts": {
- "id": "Alerts",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "The alerts returned in this list response.",
- "items": {
- "$ref": "Alert"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#alerts.",
- "default": "adsense#alerts"
- }
- }
- },
- "CustomChannel": {
- "id": "CustomChannel",
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "Code of this custom channel, not necessarily unique across ad clients."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#customChannel.",
- "default": "adsense#customChannel"
- },
- "name": {
- "type": "string",
- "description": "Name of this custom channel."
- },
- "targetingInfo": {
- "type": "object",
- "description": "The targeting information of this custom channel, if activated.",
- "properties": {
- "adsAppearOn": {
- "type": "string",
- "description": "The name used to describe this channel externally."
- },
- "description": {
- "type": "string",
- "description": "The external description of the channel."
- },
- "location": {
- "type": "string",
- "description": "The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS."
- },
- "siteLanguage": {
- "type": "string",
- "description": "The language of the sites ads will be displayed on."
- }
- }
- }
- }
- },
- "CustomChannels": {
- "id": "CustomChannels",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The custom channels returned in this list response.",
- "items": {
- "$ref": "CustomChannel"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#customChannels.",
- "default": "adsense#customChannels"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "Metadata": {
- "id": "Metadata",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "items": {
- "$ref": "ReportingMetadataEntry"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#metadata.",
- "default": "adsense#metadata"
- }
- }
- },
- "Payment": {
- "id": "Payment",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this Payment."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#payment.",
- "default": "adsense#payment"
- },
- "paymentAmount": {
- "type": "string",
- "description": "The amount to be paid."
- },
- "paymentAmountCurrencyCode": {
- "type": "string",
- "description": "The currency code for the amount to be paid."
- },
- "paymentDate": {
- "type": "string",
- "description": "The date this payment was/will be credited to the user, or none if the payment threshold has not been met."
- }
- }
- },
- "Payments": {
- "id": "Payments",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "The list of Payments for the account. One or both of a) the account's most recent payment; and b) the account's upcoming payment.",
- "items": {
- "$ref": "Payment"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#payments.",
- "default": "adsense#payments"
- }
- }
- },
- "ReportingMetadataEntry": {
- "id": "ReportingMetadataEntry",
- "type": "object",
- "properties": {
- "compatibleDimensions": {
- "type": "array",
- "description": "For metrics this is a list of dimension IDs which the metric is compatible with, for dimensions it is a list of compatibility groups the dimension belongs to.",
- "items": {
- "type": "string"
- }
- },
- "compatibleMetrics": {
- "type": "array",
- "description": "The names of the metrics the dimension or metric this reporting metadata entry describes is compatible with.",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this reporting metadata entry, corresponding to the name of the appropriate dimension or metric."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#reportingMetadataEntry.",
- "default": "adsense#reportingMetadataEntry"
- },
- "requiredDimensions": {
- "type": "array",
- "description": "The names of the dimensions which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.",
- "items": {
- "type": "string"
- }
- },
- "requiredMetrics": {
- "type": "array",
- "description": "The names of the metrics which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.",
- "items": {
- "type": "string"
- }
- },
- "supportedProducts": {
- "type": "array",
- "description": "The codes of the projects supported by the dimension or metric this reporting metadata entry describes.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "SavedAdStyle": {
- "id": "SavedAdStyle",
- "type": "object",
- "properties": {
- "adStyle": {
- "$ref": "AdStyle",
- "description": "The AdStyle itself."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#savedAdStyle.",
- "default": "adsense#savedAdStyle"
- },
- "name": {
- "type": "string",
- "description": "The user selected name of this SavedAdStyle."
- }
- }
- },
- "SavedAdStyles": {
- "id": "SavedAdStyles",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The saved ad styles returned in this list response.",
- "items": {
- "$ref": "SavedAdStyle"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#savedAdStyles.",
- "default": "adsense#savedAdStyles"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through ad units. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "SavedReport": {
- "id": "SavedReport",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this saved report."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#savedReport.",
- "default": "adsense#savedReport"
- },
- "name": {
- "type": "string",
- "description": "This saved report's name."
- }
- }
- },
- "SavedReports": {
- "id": "SavedReports",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The saved reports returned in this list response.",
- "items": {
- "$ref": "SavedReport"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#savedReports.",
- "default": "adsense#savedReports"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "UrlChannel": {
- "id": "UrlChannel",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsense#urlChannel.",
- "default": "adsense#urlChannel"
- },
- "urlPattern": {
- "type": "string",
- "description": "URL Pattern of this URL channel. Does not include \"http://\" or \"https://\". Example: www.example.com/home"
- }
- }
- },
- "UrlChannels": {
- "id": "UrlChannels",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The URL channels returned in this list response.",
- "items": {
- "$ref": "UrlChannel"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsense#urlChannels.",
- "default": "adsense#urlChannels"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- }
- },
- "resources": {
- "accounts": {
- "methods": {
- "get": {
- "id": "adsense.accounts.get",
- "path": "accounts/{accountId}",
- "httpMethod": "GET",
- "description": "Get information about the selected AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to get information about.",
- "required": true,
- "location": "path"
- },
- "tree": {
- "type": "boolean",
- "description": "Whether the tree of sub accounts should be returned.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.accounts.list",
- "path": "accounts",
- "httpMethod": "GET",
- "description": "List all accounts available to this AdSense account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of accounts to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through accounts. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Accounts"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- },
- "resources": {
- "adclients": {
- "methods": {
- "list": {
- "id": "adsense.accounts.adclients.list",
- "path": "accounts/{accountId}/adclients",
- "httpMethod": "GET",
- "description": "List all ad clients in the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account for which to list ad clients.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad clients to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "AdClients"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- },
- "adunits": {
- "methods": {
- "get": {
- "id": "adsense.accounts.adunits.get",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}",
- "httpMethod": "GET",
- "description": "Gets the specified ad unit in the specified ad client for the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to get the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "AdUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "getAdCode": {
- "id": "adsense.accounts.adunits.getAdCode",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/adcode",
- "httpMethod": "GET",
- "description": "Get ad code for the specified ad unit.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account which contains the ad client.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client with contains the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit to get the code for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "AdCode"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.accounts.adunits.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
- "httpMethod": "GET",
- "description": "List all ad units in the specified ad client for the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list ad units.",
- "required": true,
- "location": "path"
- },
- "includeInactive": {
- "type": "boolean",
- "description": "Whether to include inactive ad units. Default: true.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad units to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId"
- ],
- "response": {
- "$ref": "AdUnits"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- },
- "resources": {
- "customchannels": {
- "methods": {
- "list": {
- "id": "adsense.accounts.adunits.customchannels.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/customchannels",
- "httpMethod": "GET",
- "description": "List all custom channels which the specified ad unit belongs to.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit for which to list custom channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
- },
- "alerts": {
- "methods": {
- "delete": {
- "id": "adsense.accounts.alerts.delete",
- "path": "accounts/{accountId}/alerts/{alertId}",
- "httpMethod": "DELETE",
- "description": "Dismiss (delete) the specified alert from the specified publisher AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account which contains the ad unit.",
- "required": true,
- "location": "path"
- },
- "alertId": {
- "type": "string",
- "description": "Alert to delete.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "alertId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/adsense"
- ]
- },
- "list": {
- "id": "adsense.accounts.alerts.list",
- "path": "accounts/{accountId}/alerts",
- "httpMethod": "GET",
- "description": "List the alerts for the specified AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account for which to retrieve the alerts.",
- "required": true,
- "location": "path"
- },
- "locale": {
- "type": "string",
- "description": "The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "Alerts"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- },
- "customchannels": {
- "methods": {
- "get": {
- "id": "adsense.accounts.customchannels.get",
- "path": "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}",
- "httpMethod": "GET",
- "description": "Get the specified custom channel from the specified ad client for the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the custom channel.",
- "required": true,
- "location": "path"
- },
- "customChannelId": {
- "type": "string",
- "description": "Custom channel to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "CustomChannel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.accounts.customchannels.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/customchannels",
- "httpMethod": "GET",
- "description": "List all custom channels in the specified ad client for the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list custom channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId"
- ],
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- },
- "resources": {
- "adunits": {
- "methods": {
- "list": {
- "id": "adsense.accounts.customchannels.adunits.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}/adunits",
- "httpMethod": "GET",
- "description": "List all ad units in the specified custom channel.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the custom channel.",
- "required": true,
- "location": "path"
- },
- "customChannelId": {
- "type": "string",
- "description": "Custom channel for which to list ad units.",
- "required": true,
- "location": "path"
- },
- "includeInactive": {
- "type": "boolean",
- "description": "Whether to include inactive ad units. Default: true.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad units to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "AdUnits"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
- },
- "payments": {
- "methods": {
- "list": {
- "id": "adsense.accounts.payments.list",
- "path": "accounts/{accountId}/payments",
- "httpMethod": "GET",
- "description": "List the payments for the specified AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account for which to retrieve the payments.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "Payments"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- },
- "reports": {
- "methods": {
- "generate": {
- "id": "adsense.accounts.reports.generate",
- "path": "accounts/{accountId}/reports",
- "httpMethod": "GET",
- "description": "Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account upon which to report.",
- "required": true,
- "location": "path"
- },
- "currency": {
- "type": "string",
- "description": "Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.",
- "pattern": "[a-zA-Z]+",
- "location": "query"
- },
- "dimension": {
- "type": "string",
- "description": "Dimensions to base the report on.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "endDate": {
- "type": "string",
- "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)|(latest-(\\d{2})-(\\d{2})(-\\d+y)?)|(latest-latest-(\\d{2})(-\\d+m)?)",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "Filters to be run on the report.",
- "pattern": "[a-zA-Z_]+(==|=@).+",
- "repeated": true,
- "location": "query"
- },
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "metric": {
- "type": "string",
- "description": "Numeric columns to include in the report.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "sort": {
- "type": "string",
- "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
- "pattern": "(\\+|-)?[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "startDate": {
- "type": "string",
- "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)|(latest-(\\d{2})-(\\d{2})(-\\d+y)?)|(latest-latest-(\\d{2})(-\\d+m)?)",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
- },
- "useTimezoneReporting": {
- "type": "boolean",
- "description": "Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "startDate",
- "endDate"
- ],
- "response": {
- "$ref": "AdsenseReportsGenerateResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ],
- "supportsMediaDownload": true
- }
- },
- "resources": {
- "saved": {
- "methods": {
- "generate": {
- "id": "adsense.accounts.reports.saved.generate",
- "path": "accounts/{accountId}/reports/{savedReportId}",
- "httpMethod": "GET",
- "description": "Generate an AdSense report based on the saved report ID sent in the query parameters.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the saved reports belong.",
- "required": true,
- "location": "path"
- },
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "savedReportId": {
- "type": "string",
- "description": "The saved report to retrieve.",
- "required": true,
- "location": "path"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "savedReportId"
- ],
- "response": {
- "$ref": "AdsenseReportsGenerateResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.accounts.reports.saved.list",
- "path": "accounts/{accountId}/reports/saved",
- "httpMethod": "GET",
- "description": "List all saved reports in the specified AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the saved reports belong.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of saved reports to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "SavedReports"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
- },
- "savedadstyles": {
- "methods": {
- "get": {
- "id": "adsense.accounts.savedadstyles.get",
- "path": "accounts/{accountId}/savedadstyles/{savedAdStyleId}",
- "httpMethod": "GET",
- "description": "List a specific saved ad style for the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account for which to get the saved ad style.",
- "required": true,
- "location": "path"
- },
- "savedAdStyleId": {
- "type": "string",
- "description": "Saved ad style to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "savedAdStyleId"
- ],
- "response": {
- "$ref": "SavedAdStyle"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.accounts.savedadstyles.list",
- "path": "accounts/{accountId}/savedadstyles",
- "httpMethod": "GET",
- "description": "List all saved ad styles in the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account for which to list saved ad styles.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of saved ad styles to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "SavedAdStyles"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- },
- "urlchannels": {
- "methods": {
- "list": {
- "id": "adsense.accounts.urlchannels.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/urlchannels",
- "httpMethod": "GET",
- "description": "List all URL channels in the specified ad client for the specified account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to which the ad client belongs.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list URL channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of URL channels to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId"
- ],
- "response": {
- "$ref": "UrlChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
- },
- "adclients": {
- "methods": {
- "list": {
- "id": "adsense.adclients.list",
- "path": "adclients",
- "httpMethod": "GET",
- "description": "List all ad clients in this AdSense account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad clients to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "AdClients"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- },
- "adunits": {
- "methods": {
- "get": {
- "id": "adsense.adunits.get",
- "path": "adclients/{adClientId}/adunits/{adUnitId}",
- "httpMethod": "GET",
- "description": "Gets the specified ad unit in the specified ad client.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to get the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "AdUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "getAdCode": {
- "id": "adsense.adunits.getAdCode",
- "path": "adclients/{adClientId}/adunits/{adUnitId}/adcode",
- "httpMethod": "GET",
- "description": "Get ad code for the specified ad unit.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client with contains the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit to get the code for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "AdCode"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.adunits.list",
- "path": "adclients/{adClientId}/adunits",
- "httpMethod": "GET",
- "description": "List all ad units in the specified ad client for this AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list ad units.",
- "required": true,
- "location": "path"
- },
- "includeInactive": {
- "type": "boolean",
- "description": "Whether to include inactive ad units. Default: true.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad units to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "AdUnits"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- },
- "resources": {
- "customchannels": {
- "methods": {
- "list": {
- "id": "adsense.adunits.customchannels.list",
- "path": "adclients/{adClientId}/adunits/{adUnitId}/customchannels",
- "httpMethod": "GET",
- "description": "List all custom channels which the specified ad unit belongs to.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit for which to list custom channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
- },
- "alerts": {
- "methods": {
- "delete": {
- "id": "adsense.alerts.delete",
- "path": "alerts/{alertId}",
- "httpMethod": "DELETE",
- "description": "Dismiss (delete) the specified alert from the publisher's AdSense account.",
- "parameters": {
- "alertId": {
- "type": "string",
- "description": "Alert to delete.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "alertId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/adsense"
- ]
- },
- "list": {
- "id": "adsense.alerts.list",
- "path": "alerts",
- "httpMethod": "GET",
- "description": "List the alerts for this AdSense account.",
- "parameters": {
- "locale": {
- "type": "string",
- "description": "The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Alerts"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- },
- "customchannels": {
- "methods": {
- "get": {
- "id": "adsense.customchannels.get",
- "path": "adclients/{adClientId}/customchannels/{customChannelId}",
- "httpMethod": "GET",
- "description": "Get the specified custom channel from the specified ad client.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the custom channel.",
- "required": true,
- "location": "path"
- },
- "customChannelId": {
- "type": "string",
- "description": "Custom channel to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "CustomChannel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.customchannels.list",
- "path": "adclients/{adClientId}/customchannels",
- "httpMethod": "GET",
- "description": "List all custom channels in the specified ad client for this AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list custom channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- },
- "resources": {
- "adunits": {
- "methods": {
- "list": {
- "id": "adsense.customchannels.adunits.list",
- "path": "adclients/{adClientId}/customchannels/{customChannelId}/adunits",
- "httpMethod": "GET",
- "description": "List all ad units in the specified custom channel.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the custom channel.",
- "required": true,
- "location": "path"
- },
- "customChannelId": {
- "type": "string",
- "description": "Custom channel for which to list ad units.",
- "required": true,
- "location": "path"
- },
- "includeInactive": {
- "type": "boolean",
- "description": "Whether to include inactive ad units. Default: true.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad units to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "AdUnits"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
- },
- "metadata": {
- "resources": {
- "dimensions": {
- "methods": {
- "list": {
- "id": "adsense.metadata.dimensions.list",
- "path": "metadata/dimensions",
- "httpMethod": "GET",
- "description": "List the metadata for the dimensions available to this AdSense account.",
- "response": {
- "$ref": "Metadata"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- },
- "metrics": {
- "methods": {
- "list": {
- "id": "adsense.metadata.metrics.list",
- "path": "metadata/metrics",
- "httpMethod": "GET",
- "description": "List the metadata for the metrics available to this AdSense account.",
- "response": {
- "$ref": "Metadata"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
- },
- "payments": {
- "methods": {
- "list": {
- "id": "adsense.payments.list",
- "path": "payments",
- "httpMethod": "GET",
- "description": "List the payments for this AdSense account.",
- "response": {
- "$ref": "Payments"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- },
- "reports": {
- "methods": {
- "generate": {
- "id": "adsense.reports.generate",
- "path": "reports",
- "httpMethod": "GET",
- "description": "Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Accounts upon which to report.",
- "repeated": true,
- "location": "query"
- },
- "currency": {
- "type": "string",
- "description": "Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.",
- "pattern": "[a-zA-Z]+",
- "location": "query"
- },
- "dimension": {
- "type": "string",
- "description": "Dimensions to base the report on.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "endDate": {
- "type": "string",
- "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)|(latest-(\\d{2})-(\\d{2})(-\\d+y)?)|(latest-latest-(\\d{2})(-\\d+m)?)",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "Filters to be run on the report.",
- "pattern": "[a-zA-Z_]+(==|=@).+",
- "repeated": true,
- "location": "query"
- },
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "metric": {
- "type": "string",
- "description": "Numeric columns to include in the report.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "sort": {
- "type": "string",
- "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
- "pattern": "(\\+|-)?[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "startDate": {
- "type": "string",
- "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)|(latest-(\\d{2})-(\\d{2})(-\\d+y)?)|(latest-latest-(\\d{2})(-\\d+m)?)",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
- },
- "useTimezoneReporting": {
- "type": "boolean",
- "description": "Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "startDate",
- "endDate"
- ],
- "response": {
- "$ref": "AdsenseReportsGenerateResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ],
- "supportsMediaDownload": true
- }
- },
- "resources": {
- "saved": {
- "methods": {
- "generate": {
- "id": "adsense.reports.saved.generate",
- "path": "reports/{savedReportId}",
- "httpMethod": "GET",
- "description": "Generate an AdSense report based on the saved report ID sent in the query parameters.",
- "parameters": {
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "savedReportId": {
- "type": "string",
- "description": "The saved report to retrieve.",
- "required": true,
- "location": "path"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
- }
- },
- "parameterOrder": [
- "savedReportId"
- ],
- "response": {
- "$ref": "AdsenseReportsGenerateResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.reports.saved.list",
- "path": "reports/saved",
- "httpMethod": "GET",
- "description": "List all saved reports in this AdSense account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of saved reports to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "SavedReports"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
- },
- "savedadstyles": {
- "methods": {
- "get": {
- "id": "adsense.savedadstyles.get",
- "path": "savedadstyles/{savedAdStyleId}",
- "httpMethod": "GET",
- "description": "Get a specific saved ad style from the user's account.",
- "parameters": {
- "savedAdStyleId": {
- "type": "string",
- "description": "Saved ad style to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "savedAdStyleId"
- ],
- "response": {
- "$ref": "SavedAdStyle"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- },
- "list": {
- "id": "adsense.savedadstyles.list",
- "path": "savedadstyles",
- "httpMethod": "GET",
- "description": "List all saved ad styles in the user's account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of saved ad styles to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "SavedAdStyles"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- },
- "urlchannels": {
- "methods": {
- "list": {
- "id": "adsense.urlchannels.list",
- "path": "adclients/{adClientId}/urlchannels",
- "httpMethod": "GET",
- "description": "List all URL channels in the specified ad client for this AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list URL channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of URL channels to include in the response, used for paging.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "UrlChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsense",
- "https://www.googleapis.com/auth/adsense.readonly"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/adsense/v1.4/adsense-gen.go b/vendor/google.golang.org/api/adsense/v1.4/adsense-gen.go
deleted file mode 100644
index 638c8f9d..00000000
--- a/vendor/google.golang.org/api/adsense/v1.4/adsense-gen.go
+++ /dev/null
@@ -1,7521 +0,0 @@
-// Package adsense provides access to the AdSense Management API.
-//
-// See https://developers.google.com/adsense/management/
-//
-// Usage example:
-//
-// import "google.golang.org/api/adsense/v1.4"
-// ...
-// adsenseService, err := adsense.New(oauthHttpClient)
-package adsense // import "google.golang.org/api/adsense/v1.4"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "adsense:v1.4"
-const apiName = "adsense"
-const apiVersion = "v1.4"
-const basePath = "https://www.googleapis.com/adsense/v1.4/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your AdSense data
- AdsenseScope = "https://www.googleapis.com/auth/adsense"
-
- // View your AdSense data
- AdsenseReadonlyScope = "https://www.googleapis.com/auth/adsense.readonly"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Accounts = NewAccountsService(s)
- s.Adclients = NewAdclientsService(s)
- s.Adunits = NewAdunitsService(s)
- s.Alerts = NewAlertsService(s)
- s.Customchannels = NewCustomchannelsService(s)
- s.Metadata = NewMetadataService(s)
- s.Payments = NewPaymentsService(s)
- s.Reports = NewReportsService(s)
- s.Savedadstyles = NewSavedadstylesService(s)
- s.Urlchannels = NewUrlchannelsService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Accounts *AccountsService
-
- Adclients *AdclientsService
-
- Adunits *AdunitsService
-
- Alerts *AlertsService
-
- Customchannels *CustomchannelsService
-
- Metadata *MetadataService
-
- Payments *PaymentsService
-
- Reports *ReportsService
-
- Savedadstyles *SavedadstylesService
-
- Urlchannels *UrlchannelsService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewAccountsService(s *Service) *AccountsService {
- rs := &AccountsService{s: s}
- rs.Adclients = NewAccountsAdclientsService(s)
- rs.Adunits = NewAccountsAdunitsService(s)
- rs.Alerts = NewAccountsAlertsService(s)
- rs.Customchannels = NewAccountsCustomchannelsService(s)
- rs.Payments = NewAccountsPaymentsService(s)
- rs.Reports = NewAccountsReportsService(s)
- rs.Savedadstyles = NewAccountsSavedadstylesService(s)
- rs.Urlchannels = NewAccountsUrlchannelsService(s)
- return rs
-}
-
-type AccountsService struct {
- s *Service
-
- Adclients *AccountsAdclientsService
-
- Adunits *AccountsAdunitsService
-
- Alerts *AccountsAlertsService
-
- Customchannels *AccountsCustomchannelsService
-
- Payments *AccountsPaymentsService
-
- Reports *AccountsReportsService
-
- Savedadstyles *AccountsSavedadstylesService
-
- Urlchannels *AccountsUrlchannelsService
-}
-
-func NewAccountsAdclientsService(s *Service) *AccountsAdclientsService {
- rs := &AccountsAdclientsService{s: s}
- return rs
-}
-
-type AccountsAdclientsService struct {
- s *Service
-}
-
-func NewAccountsAdunitsService(s *Service) *AccountsAdunitsService {
- rs := &AccountsAdunitsService{s: s}
- rs.Customchannels = NewAccountsAdunitsCustomchannelsService(s)
- return rs
-}
-
-type AccountsAdunitsService struct {
- s *Service
-
- Customchannels *AccountsAdunitsCustomchannelsService
-}
-
-func NewAccountsAdunitsCustomchannelsService(s *Service) *AccountsAdunitsCustomchannelsService {
- rs := &AccountsAdunitsCustomchannelsService{s: s}
- return rs
-}
-
-type AccountsAdunitsCustomchannelsService struct {
- s *Service
-}
-
-func NewAccountsAlertsService(s *Service) *AccountsAlertsService {
- rs := &AccountsAlertsService{s: s}
- return rs
-}
-
-type AccountsAlertsService struct {
- s *Service
-}
-
-func NewAccountsCustomchannelsService(s *Service) *AccountsCustomchannelsService {
- rs := &AccountsCustomchannelsService{s: s}
- rs.Adunits = NewAccountsCustomchannelsAdunitsService(s)
- return rs
-}
-
-type AccountsCustomchannelsService struct {
- s *Service
-
- Adunits *AccountsCustomchannelsAdunitsService
-}
-
-func NewAccountsCustomchannelsAdunitsService(s *Service) *AccountsCustomchannelsAdunitsService {
- rs := &AccountsCustomchannelsAdunitsService{s: s}
- return rs
-}
-
-type AccountsCustomchannelsAdunitsService struct {
- s *Service
-}
-
-func NewAccountsPaymentsService(s *Service) *AccountsPaymentsService {
- rs := &AccountsPaymentsService{s: s}
- return rs
-}
-
-type AccountsPaymentsService struct {
- s *Service
-}
-
-func NewAccountsReportsService(s *Service) *AccountsReportsService {
- rs := &AccountsReportsService{s: s}
- rs.Saved = NewAccountsReportsSavedService(s)
- return rs
-}
-
-type AccountsReportsService struct {
- s *Service
-
- Saved *AccountsReportsSavedService
-}
-
-func NewAccountsReportsSavedService(s *Service) *AccountsReportsSavedService {
- rs := &AccountsReportsSavedService{s: s}
- return rs
-}
-
-type AccountsReportsSavedService struct {
- s *Service
-}
-
-func NewAccountsSavedadstylesService(s *Service) *AccountsSavedadstylesService {
- rs := &AccountsSavedadstylesService{s: s}
- return rs
-}
-
-type AccountsSavedadstylesService struct {
- s *Service
-}
-
-func NewAccountsUrlchannelsService(s *Service) *AccountsUrlchannelsService {
- rs := &AccountsUrlchannelsService{s: s}
- return rs
-}
-
-type AccountsUrlchannelsService struct {
- s *Service
-}
-
-func NewAdclientsService(s *Service) *AdclientsService {
- rs := &AdclientsService{s: s}
- return rs
-}
-
-type AdclientsService struct {
- s *Service
-}
-
-func NewAdunitsService(s *Service) *AdunitsService {
- rs := &AdunitsService{s: s}
- rs.Customchannels = NewAdunitsCustomchannelsService(s)
- return rs
-}
-
-type AdunitsService struct {
- s *Service
-
- Customchannels *AdunitsCustomchannelsService
-}
-
-func NewAdunitsCustomchannelsService(s *Service) *AdunitsCustomchannelsService {
- rs := &AdunitsCustomchannelsService{s: s}
- return rs
-}
-
-type AdunitsCustomchannelsService struct {
- s *Service
-}
-
-func NewAlertsService(s *Service) *AlertsService {
- rs := &AlertsService{s: s}
- return rs
-}
-
-type AlertsService struct {
- s *Service
-}
-
-func NewCustomchannelsService(s *Service) *CustomchannelsService {
- rs := &CustomchannelsService{s: s}
- rs.Adunits = NewCustomchannelsAdunitsService(s)
- return rs
-}
-
-type CustomchannelsService struct {
- s *Service
-
- Adunits *CustomchannelsAdunitsService
-}
-
-func NewCustomchannelsAdunitsService(s *Service) *CustomchannelsAdunitsService {
- rs := &CustomchannelsAdunitsService{s: s}
- return rs
-}
-
-type CustomchannelsAdunitsService struct {
- s *Service
-}
-
-func NewMetadataService(s *Service) *MetadataService {
- rs := &MetadataService{s: s}
- rs.Dimensions = NewMetadataDimensionsService(s)
- rs.Metrics = NewMetadataMetricsService(s)
- return rs
-}
-
-type MetadataService struct {
- s *Service
-
- Dimensions *MetadataDimensionsService
-
- Metrics *MetadataMetricsService
-}
-
-func NewMetadataDimensionsService(s *Service) *MetadataDimensionsService {
- rs := &MetadataDimensionsService{s: s}
- return rs
-}
-
-type MetadataDimensionsService struct {
- s *Service
-}
-
-func NewMetadataMetricsService(s *Service) *MetadataMetricsService {
- rs := &MetadataMetricsService{s: s}
- return rs
-}
-
-type MetadataMetricsService struct {
- s *Service
-}
-
-func NewPaymentsService(s *Service) *PaymentsService {
- rs := &PaymentsService{s: s}
- return rs
-}
-
-type PaymentsService struct {
- s *Service
-}
-
-func NewReportsService(s *Service) *ReportsService {
- rs := &ReportsService{s: s}
- rs.Saved = NewReportsSavedService(s)
- return rs
-}
-
-type ReportsService struct {
- s *Service
-
- Saved *ReportsSavedService
-}
-
-func NewReportsSavedService(s *Service) *ReportsSavedService {
- rs := &ReportsSavedService{s: s}
- return rs
-}
-
-type ReportsSavedService struct {
- s *Service
-}
-
-func NewSavedadstylesService(s *Service) *SavedadstylesService {
- rs := &SavedadstylesService{s: s}
- return rs
-}
-
-type SavedadstylesService struct {
- s *Service
-}
-
-func NewUrlchannelsService(s *Service) *UrlchannelsService {
- rs := &UrlchannelsService{s: s}
- return rs
-}
-
-type UrlchannelsService struct {
- s *Service
-}
-
-type Account struct {
- CreationTime int64 `json:"creation_time,omitempty,string"`
-
- // Id: Unique identifier of this account.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adsense#account.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this account.
- Name string `json:"name,omitempty"`
-
- // Premium: Whether this account is premium.
- Premium bool `json:"premium,omitempty"`
-
- // SubAccounts: Sub accounts of the this account.
- SubAccounts []*Account `json:"subAccounts,omitempty"`
-
- // Timezone: AdSense timezone of this account.
- Timezone string `json:"timezone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTime") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Account) MarshalJSON() ([]byte, error) {
- type noMethod Account
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Accounts struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The accounts returned in this list response.
- Items []*Account `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsense#accounts.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through accounts. To
- // retrieve the next page of results, set the next request's "pageToken"
- // value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Accounts) MarshalJSON() ([]byte, error) {
- type noMethod Accounts
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdClient struct {
- // ArcOptIn: Whether this ad client is opted in to ARC.
- ArcOptIn bool `json:"arcOptIn,omitempty"`
-
- // ArcReviewMode: ARC review mode this ad client is in. Empty if the
- // client is not opted in to ARC. Possible values: POST_REVIEW,
- // AUTOMATIC_PRE_REVIEW.
- ArcReviewMode string `json:"arcReviewMode,omitempty"`
-
- // Id: Unique identifier of this ad client.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adsense#adClient.
- Kind string `json:"kind,omitempty"`
-
- // ProductCode: This ad client's product code, which corresponds to the
- // PRODUCT_CODE report dimension.
- ProductCode string `json:"productCode,omitempty"`
-
- // SupportsReporting: Whether this ad client supports being reported on.
- SupportsReporting bool `json:"supportsReporting,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ArcOptIn") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdClient) MarshalJSON() ([]byte, error) {
- type noMethod AdClient
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdClients struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The ad clients returned in this list response.
- Items []*AdClient `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsense#adClients.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through ad clients. To
- // retrieve the next page of results, set the next request's "pageToken"
- // value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdClients) MarshalJSON() ([]byte, error) {
- type noMethod AdClients
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdCode struct {
- // AdCode: The ad code snippet.
- AdCode string `json:"adCode,omitempty"`
-
- // Kind: Kind this is, in this case adsense#adCode.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AdCode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdCode) MarshalJSON() ([]byte, error) {
- type noMethod AdCode
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdStyle struct {
- // Colors: The colors which are included in the style. These are
- // represented as six hexadecimal characters, similar to HTML color
- // codes, but without the leading hash.
- Colors *AdStyleColors `json:"colors,omitempty"`
-
- // Corners: The style of the corners in the ad.
- Corners string `json:"corners,omitempty"`
-
- // Font: The font which is included in the style.
- Font *AdStyleFont `json:"font,omitempty"`
-
- // Kind: Kind this is, in this case adsense#adStyle.
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Colors") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdStyle) MarshalJSON() ([]byte, error) {
- type noMethod AdStyle
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdStyleColors: The colors which are included in the style. These are
-// represented as six hexadecimal characters, similar to HTML color
-// codes, but without the leading hash.
-type AdStyleColors struct {
- // Background: The color of the ad background.
- Background string `json:"background,omitempty"`
-
- // Border: The color of the ad border.
- Border string `json:"border,omitempty"`
-
- // Text: The color of the ad text.
- Text string `json:"text,omitempty"`
-
- // Title: The color of the ad title.
- Title string `json:"title,omitempty"`
-
- // Url: The color of the ad url.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Background") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdStyleColors) MarshalJSON() ([]byte, error) {
- type noMethod AdStyleColors
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdStyleFont: The font which is included in the style.
-type AdStyleFont struct {
- // Family: The family of the font.
- Family string `json:"family,omitempty"`
-
- // Size: The size of the font.
- Size string `json:"size,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Family") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdStyleFont) MarshalJSON() ([]byte, error) {
- type noMethod AdStyleFont
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdUnit struct {
- // Code: Identity code of this ad unit, not necessarily unique across ad
- // clients.
- Code string `json:"code,omitempty"`
-
- // ContentAdsSettings: Settings specific to content ads (AFC) and
- // highend mobile content ads (AFMC).
- ContentAdsSettings *AdUnitContentAdsSettings `json:"contentAdsSettings,omitempty"`
-
- // CustomStyle: Custom style information specific to this ad unit.
- CustomStyle *AdStyle `json:"customStyle,omitempty"`
-
- // FeedAdsSettings: Settings specific to feed ads (AFF).
- FeedAdsSettings *AdUnitFeedAdsSettings `json:"feedAdsSettings,omitempty"`
-
- // Id: Unique identifier of this ad unit. This should be considered an
- // opaque identifier; it is not safe to rely on it being in any
- // particular format.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adsense#adUnit.
- Kind string `json:"kind,omitempty"`
-
- // MobileContentAdsSettings: Settings specific to WAP mobile content ads
- // (AFMC).
- MobileContentAdsSettings *AdUnitMobileContentAdsSettings `json:"mobileContentAdsSettings,omitempty"`
-
- // Name: Name of this ad unit.
- Name string `json:"name,omitempty"`
-
- // SavedStyleId: ID of the saved ad style which holds this ad unit's
- // style information.
- SavedStyleId string `json:"savedStyleId,omitempty"`
-
- // Status: Status of this ad unit. Possible values are:
- // NEW: Indicates that the ad unit was created within the last seven
- // days and does not yet have any activity associated with it.
- //
- // ACTIVE: Indicates that there has been activity on this ad unit in the
- // last seven days.
- //
- // INACTIVE: Indicates that there has been no activity on this ad unit
- // in the last seven days.
- Status string `json:"status,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdUnit) MarshalJSON() ([]byte, error) {
- type noMethod AdUnit
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdUnitContentAdsSettings: Settings specific to content ads (AFC) and
-// highend mobile content ads (AFMC).
-type AdUnitContentAdsSettings struct {
- // BackupOption: The backup option to be used in instances where no ad
- // is available.
- BackupOption *AdUnitContentAdsSettingsBackupOption `json:"backupOption,omitempty"`
-
- // Size: Size of this ad unit.
- Size string `json:"size,omitempty"`
-
- // Type: Type of this ad unit.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BackupOption") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdUnitContentAdsSettings) MarshalJSON() ([]byte, error) {
- type noMethod AdUnitContentAdsSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdUnitContentAdsSettingsBackupOption: The backup option to be used in
-// instances where no ad is available.
-type AdUnitContentAdsSettingsBackupOption struct {
- // Color: Color to use when type is set to COLOR.
- Color string `json:"color,omitempty"`
-
- // Type: Type of the backup option. Possible values are BLANK, COLOR and
- // URL.
- Type string `json:"type,omitempty"`
-
- // Url: URL to use when type is set to URL.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Color") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdUnitContentAdsSettingsBackupOption) MarshalJSON() ([]byte, error) {
- type noMethod AdUnitContentAdsSettingsBackupOption
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdUnitFeedAdsSettings: Settings specific to feed ads (AFF).
-type AdUnitFeedAdsSettings struct {
- // AdPosition: The position of the ads relative to the feed entries.
- AdPosition string `json:"adPosition,omitempty"`
-
- // Frequency: The frequency at which ads should appear in the feed (i.e.
- // every N entries).
- Frequency int64 `json:"frequency,omitempty"`
-
- // MinimumWordCount: The minimum length an entry should be in order to
- // have attached ads.
- MinimumWordCount int64 `json:"minimumWordCount,omitempty"`
-
- // Type: The type of ads which should appear.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AdPosition") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdUnitFeedAdsSettings) MarshalJSON() ([]byte, error) {
- type noMethod AdUnitFeedAdsSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdUnitMobileContentAdsSettings: Settings specific to WAP mobile
-// content ads (AFMC).
-type AdUnitMobileContentAdsSettings struct {
- // MarkupLanguage: The markup language to use for this ad unit.
- MarkupLanguage string `json:"markupLanguage,omitempty"`
-
- // ScriptingLanguage: The scripting language to use for this ad unit.
- ScriptingLanguage string `json:"scriptingLanguage,omitempty"`
-
- // Size: Size of this ad unit.
- Size string `json:"size,omitempty"`
-
- // Type: Type of this ad unit.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "MarkupLanguage") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdUnitMobileContentAdsSettings) MarshalJSON() ([]byte, error) {
- type noMethod AdUnitMobileContentAdsSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdUnits struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The ad units returned in this list response.
- Items []*AdUnit `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsense#adUnits.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through ad units. To
- // retrieve the next page of results, set the next request's "pageToken"
- // value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdUnits) MarshalJSON() ([]byte, error) {
- type noMethod AdUnits
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdsenseReportsGenerateResponse struct {
- // Averages: The averages of the report. This is the same length as any
- // other row in the report; cells corresponding to dimension columns are
- // empty.
- Averages []string `json:"averages,omitempty"`
-
- // EndDate: The requested end date in yyyy-mm-dd format.
- EndDate string `json:"endDate,omitempty"`
-
- // Headers: The header information of the columns requested in the
- // report. This is a list of headers; one for each dimension in the
- // request, followed by one for each metric in the request.
- Headers []*AdsenseReportsGenerateResponseHeaders `json:"headers,omitempty"`
-
- // Kind: Kind this is, in this case adsense#report.
- Kind string `json:"kind,omitempty"`
-
- // Rows: The output rows of the report. Each row is a list of cells; one
- // for each dimension in the request, followed by one for each metric in
- // the request. The dimension cells contain strings, and the metric
- // cells contain numbers.
- Rows [][]string `json:"rows,omitempty"`
-
- // StartDate: The requested start date in yyyy-mm-dd format.
- StartDate string `json:"startDate,omitempty"`
-
- // TotalMatchedRows: The total number of rows matched by the report
- // request. Fewer rows may be returned in the response due to being
- // limited by the row count requested or the report row limit.
- TotalMatchedRows int64 `json:"totalMatchedRows,omitempty,string"`
-
- // Totals: The totals of the report. This is the same length as any
- // other row in the report; cells corresponding to dimension columns are
- // empty.
- Totals []string `json:"totals,omitempty"`
-
- // Warnings: Any warnings associated with generation of the report.
- Warnings []string `json:"warnings,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Averages") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdsenseReportsGenerateResponse) MarshalJSON() ([]byte, error) {
- type noMethod AdsenseReportsGenerateResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdsenseReportsGenerateResponseHeaders struct {
- // Currency: The currency of this column. Only present if the header
- // type is METRIC_CURRENCY.
- Currency string `json:"currency,omitempty"`
-
- // Name: The name of the header.
- Name string `json:"name,omitempty"`
-
- // Type: The type of the header; one of DIMENSION, METRIC_TALLY,
- // METRIC_RATIO, or METRIC_CURRENCY.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Currency") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdsenseReportsGenerateResponseHeaders) MarshalJSON() ([]byte, error) {
- type noMethod AdsenseReportsGenerateResponseHeaders
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Alert struct {
- // Id: Unique identifier of this alert. This should be considered an
- // opaque identifier; it is not safe to rely on it being in any
- // particular format.
- Id string `json:"id,omitempty"`
-
- // IsDismissible: Whether this alert can be dismissed.
- IsDismissible bool `json:"isDismissible,omitempty"`
-
- // Kind: Kind of resource this is, in this case adsense#alert.
- Kind string `json:"kind,omitempty"`
-
- // Message: The localized alert message.
- Message string `json:"message,omitempty"`
-
- // Severity: Severity of this alert. Possible values: INFO, WARNING,
- // SEVERE.
- Severity string `json:"severity,omitempty"`
-
- // Type: Type of this alert. Possible values: SELF_HOLD,
- // MIGRATED_TO_BILLING3, ADDRESS_PIN_VERIFICATION,
- // PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, GRAYLISTED_PUBLISHER,
- // API_HOLD.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Alert) MarshalJSON() ([]byte, error) {
- type noMethod Alert
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Alerts struct {
- // Items: The alerts returned in this list response.
- Items []*Alert `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsense#alerts.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Alerts) MarshalJSON() ([]byte, error) {
- type noMethod Alerts
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CustomChannel struct {
- // Code: Code of this custom channel, not necessarily unique across ad
- // clients.
- Code string `json:"code,omitempty"`
-
- // Id: Unique identifier of this custom channel. This should be
- // considered an opaque identifier; it is not safe to rely on it being
- // in any particular format.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adsense#customChannel.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this custom channel.
- Name string `json:"name,omitempty"`
-
- // TargetingInfo: The targeting information of this custom channel, if
- // activated.
- TargetingInfo *CustomChannelTargetingInfo `json:"targetingInfo,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomChannel) MarshalJSON() ([]byte, error) {
- type noMethod CustomChannel
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CustomChannelTargetingInfo: The targeting information of this custom
-// channel, if activated.
-type CustomChannelTargetingInfo struct {
- // AdsAppearOn: The name used to describe this channel externally.
- AdsAppearOn string `json:"adsAppearOn,omitempty"`
-
- // Description: The external description of the channel.
- Description string `json:"description,omitempty"`
-
- // Location: The locations in which ads appear. (Only valid for content
- // and mobile content ads). Acceptable values for content ads are:
- // TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER,
- // MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT,
- // MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are:
- // TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
- Location string `json:"location,omitempty"`
-
- // SiteLanguage: The language of the sites ads will be displayed on.
- SiteLanguage string `json:"siteLanguage,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AdsAppearOn") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomChannelTargetingInfo) MarshalJSON() ([]byte, error) {
- type noMethod CustomChannelTargetingInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CustomChannels struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The custom channels returned in this list response.
- Items []*CustomChannel `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsense#customChannels.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through custom
- // channels. To retrieve the next page of results, set the next
- // request's "pageToken" value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomChannels) MarshalJSON() ([]byte, error) {
- type noMethod CustomChannels
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Metadata struct {
- Items []*ReportingMetadataEntry `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsense#metadata.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Metadata) MarshalJSON() ([]byte, error) {
- type noMethod Metadata
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Payment struct {
- // Id: Unique identifier of this Payment.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adsense#payment.
- Kind string `json:"kind,omitempty"`
-
- // PaymentAmount: The amount to be paid.
- PaymentAmount string `json:"paymentAmount,omitempty"`
-
- // PaymentAmountCurrencyCode: The currency code for the amount to be
- // paid.
- PaymentAmountCurrencyCode string `json:"paymentAmountCurrencyCode,omitempty"`
-
- // PaymentDate: The date this payment was/will be credited to the user,
- // or none if the payment threshold has not been met.
- PaymentDate string `json:"paymentDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Payment) MarshalJSON() ([]byte, error) {
- type noMethod Payment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Payments struct {
- // Items: The list of Payments for the account. One or both of a) the
- // account's most recent payment; and b) the account's upcoming payment.
- Items []*Payment `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsense#payments.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Payments) MarshalJSON() ([]byte, error) {
- type noMethod Payments
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ReportingMetadataEntry struct {
- // CompatibleDimensions: For metrics this is a list of dimension IDs
- // which the metric is compatible with, for dimensions it is a list of
- // compatibility groups the dimension belongs to.
- CompatibleDimensions []string `json:"compatibleDimensions,omitempty"`
-
- // CompatibleMetrics: The names of the metrics the dimension or metric
- // this reporting metadata entry describes is compatible with.
- CompatibleMetrics []string `json:"compatibleMetrics,omitempty"`
-
- // Id: Unique identifier of this reporting metadata entry, corresponding
- // to the name of the appropriate dimension or metric.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case
- // adsense#reportingMetadataEntry.
- Kind string `json:"kind,omitempty"`
-
- // RequiredDimensions: The names of the dimensions which the dimension
- // or metric this reporting metadata entry describes requires to also be
- // present in order for the report to be valid. Omitting these will not
- // cause an error or warning, but may result in data which cannot be
- // correctly interpreted.
- RequiredDimensions []string `json:"requiredDimensions,omitempty"`
-
- // RequiredMetrics: The names of the metrics which the dimension or
- // metric this reporting metadata entry describes requires to also be
- // present in order for the report to be valid. Omitting these will not
- // cause an error or warning, but may result in data which cannot be
- // correctly interpreted.
- RequiredMetrics []string `json:"requiredMetrics,omitempty"`
-
- // SupportedProducts: The codes of the projects supported by the
- // dimension or metric this reporting metadata entry describes.
- SupportedProducts []string `json:"supportedProducts,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "CompatibleDimensions") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportingMetadataEntry) MarshalJSON() ([]byte, error) {
- type noMethod ReportingMetadataEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type SavedAdStyle struct {
- // AdStyle: The AdStyle itself.
- AdStyle *AdStyle `json:"adStyle,omitempty"`
-
- // Id: Unique identifier of this saved ad style. This should be
- // considered an opaque identifier; it is not safe to rely on it being
- // in any particular format.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adsense#savedAdStyle.
- Kind string `json:"kind,omitempty"`
-
- // Name: The user selected name of this SavedAdStyle.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AdStyle") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SavedAdStyle) MarshalJSON() ([]byte, error) {
- type noMethod SavedAdStyle
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type SavedAdStyles struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The saved ad styles returned in this list response.
- Items []*SavedAdStyle `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsense#savedAdStyles.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through ad units. To
- // retrieve the next page of results, set the next request's "pageToken"
- // value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SavedAdStyles) MarshalJSON() ([]byte, error) {
- type noMethod SavedAdStyles
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type SavedReport struct {
- // Id: Unique identifier of this saved report.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adsense#savedReport.
- Kind string `json:"kind,omitempty"`
-
- // Name: This saved report's name.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SavedReport) MarshalJSON() ([]byte, error) {
- type noMethod SavedReport
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type SavedReports struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The saved reports returned in this list response.
- Items []*SavedReport `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsense#savedReports.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through saved reports.
- // To retrieve the next page of results, set the next request's
- // "pageToken" value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SavedReports) MarshalJSON() ([]byte, error) {
- type noMethod SavedReports
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UrlChannel struct {
- // Id: Unique identifier of this URL channel. This should be considered
- // an opaque identifier; it is not safe to rely on it being in any
- // particular format.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adsense#urlChannel.
- Kind string `json:"kind,omitempty"`
-
- // UrlPattern: URL Pattern of this URL channel. Does not include
- // "http://" or "https://". Example: www.example.com/home
- UrlPattern string `json:"urlPattern,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlChannel) MarshalJSON() ([]byte, error) {
- type noMethod UrlChannel
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UrlChannels struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The URL channels returned in this list response.
- Items []*UrlChannel `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsense#urlChannels.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through URL channels.
- // To retrieve the next page of results, set the next request's
- // "pageToken" value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlChannels) MarshalJSON() ([]byte, error) {
- type noMethod UrlChannels
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "adsense.accounts.get":
-
-type AccountsGetCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get information about the selected AdSense account.
-func (r *AccountsService) Get(accountId string) *AccountsGetCall {
- c := &AccountsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// Tree sets the optional parameter "tree": Whether the tree of sub
-// accounts should be returned.
-func (c *AccountsGetCall) Tree(tree bool) *AccountsGetCall {
- c.opt_["tree"] = tree
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsGetCall) Fields(s ...googleapi.Field) *AccountsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsGetCall) IfNoneMatch(entityTag string) *AccountsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsGetCall) Context(ctx context.Context) *AccountsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["tree"]; ok {
- params.Set("tree", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.get" call.
-// Exactly one of *Account or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Account.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsGetCall) Do() (*Account, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Account{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get information about the selected AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.get",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to get information about.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "tree": {
- // "description": "Whether the tree of sub accounts should be returned.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "accounts/{accountId}",
- // "response": {
- // "$ref": "Account"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.list":
-
-type AccountsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all accounts available to this AdSense account.
-func (r *AccountsService) List() *AccountsListCall {
- c := &AccountsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of accounts to include in the response, used for paging.
-func (c *AccountsListCall) MaxResults(maxResults int64) *AccountsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through accounts. To retrieve the next page, set
-// this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AccountsListCall) PageToken(pageToken string) *AccountsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsListCall) Fields(s ...googleapi.Field) *AccountsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsListCall) IfNoneMatch(entityTag string) *AccountsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsListCall) Context(ctx context.Context) *AccountsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.list" call.
-// Exactly one of *Accounts or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Accounts.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccountsListCall) Do() (*Accounts, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Accounts{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all accounts available to this AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.list",
- // "parameters": {
- // "maxResults": {
- // "description": "The maximum number of accounts to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through accounts. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts",
- // "response": {
- // "$ref": "Accounts"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.adclients.list":
-
-type AccountsAdclientsListCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all ad clients in the specified account.
-func (r *AccountsAdclientsService) List(accountId string) *AccountsAdclientsListCall {
- c := &AccountsAdclientsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of ad clients to include in the response, used for paging.
-func (c *AccountsAdclientsListCall) MaxResults(maxResults int64) *AccountsAdclientsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad clients. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AccountsAdclientsListCall) PageToken(pageToken string) *AccountsAdclientsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAdclientsListCall) Fields(s ...googleapi.Field) *AccountsAdclientsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsAdclientsListCall) IfNoneMatch(entityTag string) *AccountsAdclientsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAdclientsListCall) Context(ctx context.Context) *AccountsAdclientsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAdclientsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.adclients.list" call.
-// Exactly one of *AdClients or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AdClients.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccountsAdclientsListCall) Do() (*AdClients, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdClients{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all ad clients in the specified account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.adclients.list",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account for which to list ad clients.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of ad clients to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients",
- // "response": {
- // "$ref": "AdClients"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.adunits.get":
-
-type AccountsAdunitsGetCall struct {
- s *Service
- accountId string
- adClientId string
- adUnitId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets the specified ad unit in the specified ad client for the
-// specified account.
-func (r *AccountsAdunitsService) Get(accountId string, adClientId string, adUnitId string) *AccountsAdunitsGetCall {
- c := &AccountsAdunitsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- c.adUnitId = adUnitId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAdunitsGetCall) Fields(s ...googleapi.Field) *AccountsAdunitsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsAdunitsGetCall) IfNoneMatch(entityTag string) *AccountsAdunitsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAdunitsGetCall) Context(ctx context.Context) *AccountsAdunitsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAdunitsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- "adUnitId": c.adUnitId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.adunits.get" call.
-// Exactly one of *AdUnit or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnit.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsAdunitsGetCall) Do() (*AdUnit, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnit{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the specified ad unit in the specified ad client for the specified account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.adunits.get",
- // "parameterOrder": [
- // "accountId",
- // "adClientId",
- // "adUnitId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the ad client belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client for which to get the ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adUnitId": {
- // "description": "Ad unit to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}",
- // "response": {
- // "$ref": "AdUnit"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.adunits.getAdCode":
-
-type AccountsAdunitsGetAdCodeCall struct {
- s *Service
- accountId string
- adClientId string
- adUnitId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetAdCode: Get ad code for the specified ad unit.
-func (r *AccountsAdunitsService) GetAdCode(accountId string, adClientId string, adUnitId string) *AccountsAdunitsGetAdCodeCall {
- c := &AccountsAdunitsGetAdCodeCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- c.adUnitId = adUnitId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAdunitsGetAdCodeCall) Fields(s ...googleapi.Field) *AccountsAdunitsGetAdCodeCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsAdunitsGetAdCodeCall) IfNoneMatch(entityTag string) *AccountsAdunitsGetAdCodeCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAdunitsGetAdCodeCall) Context(ctx context.Context) *AccountsAdunitsGetAdCodeCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAdunitsGetAdCodeCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/adcode")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- "adUnitId": c.adUnitId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.adunits.getAdCode" call.
-// Exactly one of *AdCode or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdCode.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsAdunitsGetAdCodeCall) Do() (*AdCode, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdCode{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get ad code for the specified ad unit.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.adunits.getAdCode",
- // "parameterOrder": [
- // "accountId",
- // "adClientId",
- // "adUnitId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account which contains the ad client.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client with contains the ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adUnitId": {
- // "description": "Ad unit to get the code for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/adcode",
- // "response": {
- // "$ref": "AdCode"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.adunits.list":
-
-type AccountsAdunitsListCall struct {
- s *Service
- accountId string
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all ad units in the specified ad client for the specified
-// account.
-func (r *AccountsAdunitsService) List(accountId string, adClientId string) *AccountsAdunitsListCall {
- c := &AccountsAdunitsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- return c
-}
-
-// IncludeInactive sets the optional parameter "includeInactive":
-// Whether to include inactive ad units. Default: true.
-func (c *AccountsAdunitsListCall) IncludeInactive(includeInactive bool) *AccountsAdunitsListCall {
- c.opt_["includeInactive"] = includeInactive
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of ad units to include in the response, used for paging.
-func (c *AccountsAdunitsListCall) MaxResults(maxResults int64) *AccountsAdunitsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad units. To retrieve the next page, set
-// this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AccountsAdunitsListCall) PageToken(pageToken string) *AccountsAdunitsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAdunitsListCall) Fields(s ...googleapi.Field) *AccountsAdunitsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsAdunitsListCall) IfNoneMatch(entityTag string) *AccountsAdunitsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAdunitsListCall) Context(ctx context.Context) *AccountsAdunitsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAdunitsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["includeInactive"]; ok {
- params.Set("includeInactive", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/adunits")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.adunits.list" call.
-// Exactly one of *AdUnits or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnits.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsAdunitsListCall) Do() (*AdUnits, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnits{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all ad units in the specified ad client for the specified account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.adunits.list",
- // "parameterOrder": [
- // "accountId",
- // "adClientId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the ad client belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client for which to list ad units.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "includeInactive": {
- // "description": "Whether to include inactive ad units. Default: true.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "The maximum number of ad units to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
- // "response": {
- // "$ref": "AdUnits"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.adunits.customchannels.list":
-
-type AccountsAdunitsCustomchannelsListCall struct {
- s *Service
- accountId string
- adClientId string
- adUnitId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all custom channels which the specified ad unit belongs
-// to.
-func (r *AccountsAdunitsCustomchannelsService) List(accountId string, adClientId string, adUnitId string) *AccountsAdunitsCustomchannelsListCall {
- c := &AccountsAdunitsCustomchannelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- c.adUnitId = adUnitId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of custom channels to include in the response, used for
-// paging.
-func (c *AccountsAdunitsCustomchannelsListCall) MaxResults(maxResults int64) *AccountsAdunitsCustomchannelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through custom channels. To retrieve the next
-// page, set this parameter to the value of "nextPageToken" from the
-// previous response.
-func (c *AccountsAdunitsCustomchannelsListCall) PageToken(pageToken string) *AccountsAdunitsCustomchannelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAdunitsCustomchannelsListCall) Fields(s ...googleapi.Field) *AccountsAdunitsCustomchannelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsAdunitsCustomchannelsListCall) IfNoneMatch(entityTag string) *AccountsAdunitsCustomchannelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAdunitsCustomchannelsListCall) Context(ctx context.Context) *AccountsAdunitsCustomchannelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAdunitsCustomchannelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/customchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- "adUnitId": c.adUnitId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.adunits.customchannels.list" call.
-// Exactly one of *CustomChannels or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannels.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountsAdunitsCustomchannelsListCall) Do() (*CustomChannels, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannels{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all custom channels which the specified ad unit belongs to.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.adunits.customchannels.list",
- // "parameterOrder": [
- // "accountId",
- // "adClientId",
- // "adUnitId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the ad client belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client which contains the ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adUnitId": {
- // "description": "Ad unit for which to list custom channels.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of custom channels to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/customchannels",
- // "response": {
- // "$ref": "CustomChannels"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.alerts.delete":
-
-type AccountsAlertsDeleteCall struct {
- s *Service
- accountId string
- alertId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Dismiss (delete) the specified alert from the specified
-// publisher AdSense account.
-func (r *AccountsAlertsService) Delete(accountId string, alertId string) *AccountsAlertsDeleteCall {
- c := &AccountsAlertsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.alertId = alertId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAlertsDeleteCall) Fields(s ...googleapi.Field) *AccountsAlertsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAlertsDeleteCall) Context(ctx context.Context) *AccountsAlertsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAlertsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/alerts/{alertId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "alertId": c.alertId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.alerts.delete" call.
-func (c *AccountsAlertsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Dismiss (delete) the specified alert from the specified publisher AdSense account.",
- // "httpMethod": "DELETE",
- // "id": "adsense.accounts.alerts.delete",
- // "parameterOrder": [
- // "accountId",
- // "alertId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account which contains the ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "alertId": {
- // "description": "Alert to delete.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/alerts/{alertId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.alerts.list":
-
-type AccountsAlertsListCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List the alerts for the specified AdSense account.
-func (r *AccountsAlertsService) List(accountId string) *AccountsAlertsListCall {
- c := &AccountsAlertsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// Locale sets the optional parameter "locale": The locale to use for
-// translating alert messages. The account locale will be used if this
-// is not supplied. The AdSense default (English) will be used if the
-// supplied locale is invalid or unsupported.
-func (c *AccountsAlertsListCall) Locale(locale string) *AccountsAlertsListCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAlertsListCall) Fields(s ...googleapi.Field) *AccountsAlertsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsAlertsListCall) IfNoneMatch(entityTag string) *AccountsAlertsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAlertsListCall) Context(ctx context.Context) *AccountsAlertsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAlertsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/alerts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.alerts.list" call.
-// Exactly one of *Alerts or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Alerts.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsAlertsListCall) Do() (*Alerts, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Alerts{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List the alerts for the specified AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.alerts.list",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account for which to retrieve the alerts.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "locale": {
- // "description": "The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/alerts",
- // "response": {
- // "$ref": "Alerts"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.customchannels.get":
-
-type AccountsCustomchannelsGetCall struct {
- s *Service
- accountId string
- adClientId string
- customChannelId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get the specified custom channel from the specified ad client
-// for the specified account.
-func (r *AccountsCustomchannelsService) Get(accountId string, adClientId string, customChannelId string) *AccountsCustomchannelsGetCall {
- c := &AccountsCustomchannelsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- c.customChannelId = customChannelId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsCustomchannelsGetCall) Fields(s ...googleapi.Field) *AccountsCustomchannelsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsCustomchannelsGetCall) IfNoneMatch(entityTag string) *AccountsCustomchannelsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsCustomchannelsGetCall) Context(ctx context.Context) *AccountsCustomchannelsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsCustomchannelsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- "customChannelId": c.customChannelId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.customchannels.get" call.
-// Exactly one of *CustomChannel or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannel.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountsCustomchannelsGetCall) Do() (*CustomChannel, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannel{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get the specified custom channel from the specified ad client for the specified account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.customchannels.get",
- // "parameterOrder": [
- // "accountId",
- // "adClientId",
- // "customChannelId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the ad client belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client which contains the custom channel.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "customChannelId": {
- // "description": "Custom channel to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}",
- // "response": {
- // "$ref": "CustomChannel"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.customchannels.list":
-
-type AccountsCustomchannelsListCall struct {
- s *Service
- accountId string
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all custom channels in the specified ad client for the
-// specified account.
-func (r *AccountsCustomchannelsService) List(accountId string, adClientId string) *AccountsCustomchannelsListCall {
- c := &AccountsCustomchannelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of custom channels to include in the response, used for
-// paging.
-func (c *AccountsCustomchannelsListCall) MaxResults(maxResults int64) *AccountsCustomchannelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through custom channels. To retrieve the next
-// page, set this parameter to the value of "nextPageToken" from the
-// previous response.
-func (c *AccountsCustomchannelsListCall) PageToken(pageToken string) *AccountsCustomchannelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsCustomchannelsListCall) Fields(s ...googleapi.Field) *AccountsCustomchannelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsCustomchannelsListCall) IfNoneMatch(entityTag string) *AccountsCustomchannelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsCustomchannelsListCall) Context(ctx context.Context) *AccountsCustomchannelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsCustomchannelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/customchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.customchannels.list" call.
-// Exactly one of *CustomChannels or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannels.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountsCustomchannelsListCall) Do() (*CustomChannels, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannels{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all custom channels in the specified ad client for the specified account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.customchannels.list",
- // "parameterOrder": [
- // "accountId",
- // "adClientId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the ad client belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client for which to list custom channels.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of custom channels to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/customchannels",
- // "response": {
- // "$ref": "CustomChannels"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.customchannels.adunits.list":
-
-type AccountsCustomchannelsAdunitsListCall struct {
- s *Service
- accountId string
- adClientId string
- customChannelId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all ad units in the specified custom channel.
-func (r *AccountsCustomchannelsAdunitsService) List(accountId string, adClientId string, customChannelId string) *AccountsCustomchannelsAdunitsListCall {
- c := &AccountsCustomchannelsAdunitsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- c.customChannelId = customChannelId
- return c
-}
-
-// IncludeInactive sets the optional parameter "includeInactive":
-// Whether to include inactive ad units. Default: true.
-func (c *AccountsCustomchannelsAdunitsListCall) IncludeInactive(includeInactive bool) *AccountsCustomchannelsAdunitsListCall {
- c.opt_["includeInactive"] = includeInactive
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of ad units to include in the response, used for paging.
-func (c *AccountsCustomchannelsAdunitsListCall) MaxResults(maxResults int64) *AccountsCustomchannelsAdunitsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad units. To retrieve the next page, set
-// this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AccountsCustomchannelsAdunitsListCall) PageToken(pageToken string) *AccountsCustomchannelsAdunitsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsCustomchannelsAdunitsListCall) Fields(s ...googleapi.Field) *AccountsCustomchannelsAdunitsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsCustomchannelsAdunitsListCall) IfNoneMatch(entityTag string) *AccountsCustomchannelsAdunitsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsCustomchannelsAdunitsListCall) Context(ctx context.Context) *AccountsCustomchannelsAdunitsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsCustomchannelsAdunitsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["includeInactive"]; ok {
- params.Set("includeInactive", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}/adunits")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- "customChannelId": c.customChannelId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.customchannels.adunits.list" call.
-// Exactly one of *AdUnits or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnits.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsCustomchannelsAdunitsListCall) Do() (*AdUnits, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnits{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all ad units in the specified custom channel.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.customchannels.adunits.list",
- // "parameterOrder": [
- // "accountId",
- // "adClientId",
- // "customChannelId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the ad client belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client which contains the custom channel.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "customChannelId": {
- // "description": "Custom channel for which to list ad units.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "includeInactive": {
- // "description": "Whether to include inactive ad units. Default: true.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "The maximum number of ad units to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}/adunits",
- // "response": {
- // "$ref": "AdUnits"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.payments.list":
-
-type AccountsPaymentsListCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List the payments for the specified AdSense account.
-func (r *AccountsPaymentsService) List(accountId string) *AccountsPaymentsListCall {
- c := &AccountsPaymentsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsPaymentsListCall) Fields(s ...googleapi.Field) *AccountsPaymentsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsPaymentsListCall) IfNoneMatch(entityTag string) *AccountsPaymentsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsPaymentsListCall) Context(ctx context.Context) *AccountsPaymentsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsPaymentsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/payments")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.payments.list" call.
-// Exactly one of *Payments or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Payments.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccountsPaymentsListCall) Do() (*Payments, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Payments{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List the payments for the specified AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.payments.list",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account for which to retrieve the payments.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/payments",
- // "response": {
- // "$ref": "Payments"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.reports.generate":
-
-type AccountsReportsGenerateCall struct {
- s *Service
- accountId string
- startDate string
- endDate string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Generate: Generate an AdSense report based on the report request sent
-// in the query parameters. Returns the result as JSON; to retrieve
-// output in CSV format specify "alt=csv" as a query parameter.
-func (r *AccountsReportsService) Generate(accountId string, startDate string, endDate string) *AccountsReportsGenerateCall {
- c := &AccountsReportsGenerateCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.startDate = startDate
- c.endDate = endDate
- return c
-}
-
-// Currency sets the optional parameter "currency": Optional currency to
-// use when reporting on monetary metrics. Defaults to the account's
-// currency if not set.
-func (c *AccountsReportsGenerateCall) Currency(currency string) *AccountsReportsGenerateCall {
- c.opt_["currency"] = currency
- return c
-}
-
-// Dimension sets the optional parameter "dimension": Dimensions to base
-// the report on.
-func (c *AccountsReportsGenerateCall) Dimension(dimension string) *AccountsReportsGenerateCall {
- c.opt_["dimension"] = dimension
- return c
-}
-
-// Filter sets the optional parameter "filter": Filters to be run on the
-// report.
-func (c *AccountsReportsGenerateCall) Filter(filter string) *AccountsReportsGenerateCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// Locale sets the optional parameter "locale": Optional locale to use
-// for translating report output to a local language. Defaults to
-// "en_US" if not specified.
-func (c *AccountsReportsGenerateCall) Locale(locale string) *AccountsReportsGenerateCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of rows of report data to return.
-func (c *AccountsReportsGenerateCall) MaxResults(maxResults int64) *AccountsReportsGenerateCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// Metric sets the optional parameter "metric": Numeric columns to
-// include in the report.
-func (c *AccountsReportsGenerateCall) Metric(metric string) *AccountsReportsGenerateCall {
- c.opt_["metric"] = metric
- return c
-}
-
-// Sort sets the optional parameter "sort": The name of a dimension or
-// metric to sort the resulting report on, optionally prefixed with "+"
-// to sort ascending or "-" to sort descending. If no prefix is
-// specified, the column is sorted ascending.
-func (c *AccountsReportsGenerateCall) Sort(sort string) *AccountsReportsGenerateCall {
- c.opt_["sort"] = sort
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex": Index of the
-// first row of report data to return.
-func (c *AccountsReportsGenerateCall) StartIndex(startIndex int64) *AccountsReportsGenerateCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// UseTimezoneReporting sets the optional parameter
-// "useTimezoneReporting": Whether the report should be generated in the
-// AdSense account's local timezone. If false default PST/PDT timezone
-// will be used.
-func (c *AccountsReportsGenerateCall) UseTimezoneReporting(useTimezoneReporting bool) *AccountsReportsGenerateCall {
- c.opt_["useTimezoneReporting"] = useTimezoneReporting
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsReportsGenerateCall) Fields(s ...googleapi.Field) *AccountsReportsGenerateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsReportsGenerateCall) IfNoneMatch(entityTag string) *AccountsReportsGenerateCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do and Download methods.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsReportsGenerateCall) Context(ctx context.Context) *AccountsReportsGenerateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsReportsGenerateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("endDate", fmt.Sprintf("%v", c.endDate))
- params.Set("startDate", fmt.Sprintf("%v", c.startDate))
- if v, ok := c.opt_["currency"]; ok {
- params.Set("currency", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["dimension"]; ok {
- params.Set("dimension", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["metric"]; ok {
- params.Set("metric", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sort"]; ok {
- params.Set("sort", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["useTimezoneReporting"]; ok {
- params.Set("useTimezoneReporting", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/reports")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Download fetches the API endpoint's "media" value, instead of the normal
-// API response value. If the returned error is nil, the Response is guaranteed to
-// have a 2xx status code. Callers must close the Response.Body as usual.
-func (c *AccountsReportsGenerateCall) Download() (*http.Response, error) {
- res, err := c.doRequest("media")
- if err != nil {
- return nil, err
- }
- if err := googleapi.CheckMediaResponse(res); err != nil {
- res.Body.Close()
- return nil, err
- }
- return res, nil
-}
-
-// Do executes the "adsense.accounts.reports.generate" call.
-// Exactly one of *AdsenseReportsGenerateResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *AdsenseReportsGenerateResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountsReportsGenerateCall) Do() (*AdsenseReportsGenerateResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdsenseReportsGenerateResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.reports.generate",
- // "parameterOrder": [
- // "accountId",
- // "startDate",
- // "endDate"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account upon which to report.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "currency": {
- // "description": "Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.",
- // "location": "query",
- // "pattern": "[a-zA-Z]+",
- // "type": "string"
- // },
- // "dimension": {
- // "description": "Dimensions to base the report on.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "endDate": {
- // "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- // "location": "query",
- // "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)|(latest-(\\d{2})-(\\d{2})(-\\d+y)?)|(latest-latest-(\\d{2})(-\\d+m)?)",
- // "required": true,
- // "type": "string"
- // },
- // "filter": {
- // "description": "Filters to be run on the report.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+(==|=@).+",
- // "repeated": true,
- // "type": "string"
- // },
- // "locale": {
- // "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of rows of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "50000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "metric": {
- // "description": "Numeric columns to include in the report.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "sort": {
- // "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
- // "location": "query",
- // "pattern": "(\\+|-)?[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "startDate": {
- // "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- // "location": "query",
- // "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)|(latest-(\\d{2})-(\\d{2})(-\\d+y)?)|(latest-latest-(\\d{2})(-\\d+m)?)",
- // "required": true,
- // "type": "string"
- // },
- // "startIndex": {
- // "description": "Index of the first row of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "5000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "useTimezoneReporting": {
- // "description": "Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "accounts/{accountId}/reports",
- // "response": {
- // "$ref": "AdsenseReportsGenerateResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ],
- // "supportsMediaDownload": true
- // }
-
-}
-
-// method id "adsense.accounts.reports.saved.generate":
-
-type AccountsReportsSavedGenerateCall struct {
- s *Service
- accountId string
- savedReportId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Generate: Generate an AdSense report based on the saved report ID
-// sent in the query parameters.
-func (r *AccountsReportsSavedService) Generate(accountId string, savedReportId string) *AccountsReportsSavedGenerateCall {
- c := &AccountsReportsSavedGenerateCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.savedReportId = savedReportId
- return c
-}
-
-// Locale sets the optional parameter "locale": Optional locale to use
-// for translating report output to a local language. Defaults to
-// "en_US" if not specified.
-func (c *AccountsReportsSavedGenerateCall) Locale(locale string) *AccountsReportsSavedGenerateCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of rows of report data to return.
-func (c *AccountsReportsSavedGenerateCall) MaxResults(maxResults int64) *AccountsReportsSavedGenerateCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex": Index of the
-// first row of report data to return.
-func (c *AccountsReportsSavedGenerateCall) StartIndex(startIndex int64) *AccountsReportsSavedGenerateCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsReportsSavedGenerateCall) Fields(s ...googleapi.Field) *AccountsReportsSavedGenerateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsReportsSavedGenerateCall) IfNoneMatch(entityTag string) *AccountsReportsSavedGenerateCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsReportsSavedGenerateCall) Context(ctx context.Context) *AccountsReportsSavedGenerateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsReportsSavedGenerateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/reports/{savedReportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "savedReportId": c.savedReportId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.reports.saved.generate" call.
-// Exactly one of *AdsenseReportsGenerateResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *AdsenseReportsGenerateResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountsReportsSavedGenerateCall) Do() (*AdsenseReportsGenerateResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdsenseReportsGenerateResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Generate an AdSense report based on the saved report ID sent in the query parameters.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.reports.saved.generate",
- // "parameterOrder": [
- // "accountId",
- // "savedReportId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the saved reports belong.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "locale": {
- // "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of rows of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "50000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "savedReportId": {
- // "description": "The saved report to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "startIndex": {
- // "description": "Index of the first row of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "5000",
- // "minimum": "0",
- // "type": "integer"
- // }
- // },
- // "path": "accounts/{accountId}/reports/{savedReportId}",
- // "response": {
- // "$ref": "AdsenseReportsGenerateResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.reports.saved.list":
-
-type AccountsReportsSavedListCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all saved reports in the specified AdSense account.
-func (r *AccountsReportsSavedService) List(accountId string) *AccountsReportsSavedListCall {
- c := &AccountsReportsSavedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of saved reports to include in the response, used for paging.
-func (c *AccountsReportsSavedListCall) MaxResults(maxResults int64) *AccountsReportsSavedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through saved reports. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AccountsReportsSavedListCall) PageToken(pageToken string) *AccountsReportsSavedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsReportsSavedListCall) Fields(s ...googleapi.Field) *AccountsReportsSavedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsReportsSavedListCall) IfNoneMatch(entityTag string) *AccountsReportsSavedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsReportsSavedListCall) Context(ctx context.Context) *AccountsReportsSavedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsReportsSavedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/reports/saved")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.reports.saved.list" call.
-// Exactly one of *SavedReports or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *SavedReports.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccountsReportsSavedListCall) Do() (*SavedReports, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SavedReports{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all saved reports in the specified AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.reports.saved.list",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the saved reports belong.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of saved reports to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "100",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/reports/saved",
- // "response": {
- // "$ref": "SavedReports"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.savedadstyles.get":
-
-type AccountsSavedadstylesGetCall struct {
- s *Service
- accountId string
- savedAdStyleId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: List a specific saved ad style for the specified account.
-func (r *AccountsSavedadstylesService) Get(accountId string, savedAdStyleId string) *AccountsSavedadstylesGetCall {
- c := &AccountsSavedadstylesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.savedAdStyleId = savedAdStyleId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsSavedadstylesGetCall) Fields(s ...googleapi.Field) *AccountsSavedadstylesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsSavedadstylesGetCall) IfNoneMatch(entityTag string) *AccountsSavedadstylesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsSavedadstylesGetCall) Context(ctx context.Context) *AccountsSavedadstylesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsSavedadstylesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/savedadstyles/{savedAdStyleId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "savedAdStyleId": c.savedAdStyleId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.savedadstyles.get" call.
-// Exactly one of *SavedAdStyle or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *SavedAdStyle.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccountsSavedadstylesGetCall) Do() (*SavedAdStyle, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SavedAdStyle{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List a specific saved ad style for the specified account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.savedadstyles.get",
- // "parameterOrder": [
- // "accountId",
- // "savedAdStyleId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account for which to get the saved ad style.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "savedAdStyleId": {
- // "description": "Saved ad style to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/savedadstyles/{savedAdStyleId}",
- // "response": {
- // "$ref": "SavedAdStyle"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.savedadstyles.list":
-
-type AccountsSavedadstylesListCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all saved ad styles in the specified account.
-func (r *AccountsSavedadstylesService) List(accountId string) *AccountsSavedadstylesListCall {
- c := &AccountsSavedadstylesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of saved ad styles to include in the response, used for
-// paging.
-func (c *AccountsSavedadstylesListCall) MaxResults(maxResults int64) *AccountsSavedadstylesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through saved ad styles. To retrieve the next
-// page, set this parameter to the value of "nextPageToken" from the
-// previous response.
-func (c *AccountsSavedadstylesListCall) PageToken(pageToken string) *AccountsSavedadstylesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsSavedadstylesListCall) Fields(s ...googleapi.Field) *AccountsSavedadstylesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsSavedadstylesListCall) IfNoneMatch(entityTag string) *AccountsSavedadstylesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsSavedadstylesListCall) Context(ctx context.Context) *AccountsSavedadstylesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsSavedadstylesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/savedadstyles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.savedadstyles.list" call.
-// Exactly one of *SavedAdStyles or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *SavedAdStyles.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountsSavedadstylesListCall) Do() (*SavedAdStyles, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SavedAdStyles{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all saved ad styles in the specified account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.savedadstyles.list",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account for which to list saved ad styles.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of saved ad styles to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/savedadstyles",
- // "response": {
- // "$ref": "SavedAdStyles"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.accounts.urlchannels.list":
-
-type AccountsUrlchannelsListCall struct {
- s *Service
- accountId string
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all URL channels in the specified ad client for the
-// specified account.
-func (r *AccountsUrlchannelsService) List(accountId string, adClientId string) *AccountsUrlchannelsListCall {
- c := &AccountsUrlchannelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of URL channels to include in the response, used for paging.
-func (c *AccountsUrlchannelsListCall) MaxResults(maxResults int64) *AccountsUrlchannelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through URL channels. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AccountsUrlchannelsListCall) PageToken(pageToken string) *AccountsUrlchannelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsUrlchannelsListCall) Fields(s ...googleapi.Field) *AccountsUrlchannelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsUrlchannelsListCall) IfNoneMatch(entityTag string) *AccountsUrlchannelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsUrlchannelsListCall) Context(ctx context.Context) *AccountsUrlchannelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsUrlchannelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/urlchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.accounts.urlchannels.list" call.
-// Exactly one of *UrlChannels or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UrlChannels.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccountsUrlchannelsListCall) Do() (*UrlChannels, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UrlChannels{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all URL channels in the specified ad client for the specified account.",
- // "httpMethod": "GET",
- // "id": "adsense.accounts.urlchannels.list",
- // "parameterOrder": [
- // "accountId",
- // "adClientId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to which the ad client belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client for which to list URL channels.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of URL channels to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/urlchannels",
- // "response": {
- // "$ref": "UrlChannels"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.adclients.list":
-
-type AdclientsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all ad clients in this AdSense account.
-func (r *AdclientsService) List() *AdclientsListCall {
- c := &AdclientsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of ad clients to include in the response, used for paging.
-func (c *AdclientsListCall) MaxResults(maxResults int64) *AdclientsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad clients. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AdclientsListCall) PageToken(pageToken string) *AdclientsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdclientsListCall) Fields(s ...googleapi.Field) *AdclientsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdclientsListCall) IfNoneMatch(entityTag string) *AdclientsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdclientsListCall) Context(ctx context.Context) *AdclientsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdclientsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.adclients.list" call.
-// Exactly one of *AdClients or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AdClients.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AdclientsListCall) Do() (*AdClients, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdClients{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all ad clients in this AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.adclients.list",
- // "parameters": {
- // "maxResults": {
- // "description": "The maximum number of ad clients to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients",
- // "response": {
- // "$ref": "AdClients"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.adunits.get":
-
-type AdunitsGetCall struct {
- s *Service
- adClientId string
- adUnitId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets the specified ad unit in the specified ad client.
-func (r *AdunitsService) Get(adClientId string, adUnitId string) *AdunitsGetCall {
- c := &AdunitsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.adUnitId = adUnitId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdunitsGetCall) Fields(s ...googleapi.Field) *AdunitsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdunitsGetCall) IfNoneMatch(entityTag string) *AdunitsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdunitsGetCall) Context(ctx context.Context) *AdunitsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdunitsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/adunits/{adUnitId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- "adUnitId": c.adUnitId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.adunits.get" call.
-// Exactly one of *AdUnit or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnit.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AdunitsGetCall) Do() (*AdUnit, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnit{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the specified ad unit in the specified ad client.",
- // "httpMethod": "GET",
- // "id": "adsense.adunits.get",
- // "parameterOrder": [
- // "adClientId",
- // "adUnitId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client for which to get the ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adUnitId": {
- // "description": "Ad unit to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/adunits/{adUnitId}",
- // "response": {
- // "$ref": "AdUnit"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.adunits.getAdCode":
-
-type AdunitsGetAdCodeCall struct {
- s *Service
- adClientId string
- adUnitId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetAdCode: Get ad code for the specified ad unit.
-func (r *AdunitsService) GetAdCode(adClientId string, adUnitId string) *AdunitsGetAdCodeCall {
- c := &AdunitsGetAdCodeCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.adUnitId = adUnitId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdunitsGetAdCodeCall) Fields(s ...googleapi.Field) *AdunitsGetAdCodeCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdunitsGetAdCodeCall) IfNoneMatch(entityTag string) *AdunitsGetAdCodeCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdunitsGetAdCodeCall) Context(ctx context.Context) *AdunitsGetAdCodeCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdunitsGetAdCodeCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/adunits/{adUnitId}/adcode")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- "adUnitId": c.adUnitId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.adunits.getAdCode" call.
-// Exactly one of *AdCode or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdCode.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AdunitsGetAdCodeCall) Do() (*AdCode, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdCode{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get ad code for the specified ad unit.",
- // "httpMethod": "GET",
- // "id": "adsense.adunits.getAdCode",
- // "parameterOrder": [
- // "adClientId",
- // "adUnitId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client with contains the ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adUnitId": {
- // "description": "Ad unit to get the code for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/adunits/{adUnitId}/adcode",
- // "response": {
- // "$ref": "AdCode"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.adunits.list":
-
-type AdunitsListCall struct {
- s *Service
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all ad units in the specified ad client for this AdSense
-// account.
-func (r *AdunitsService) List(adClientId string) *AdunitsListCall {
- c := &AdunitsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- return c
-}
-
-// IncludeInactive sets the optional parameter "includeInactive":
-// Whether to include inactive ad units. Default: true.
-func (c *AdunitsListCall) IncludeInactive(includeInactive bool) *AdunitsListCall {
- c.opt_["includeInactive"] = includeInactive
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of ad units to include in the response, used for paging.
-func (c *AdunitsListCall) MaxResults(maxResults int64) *AdunitsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad units. To retrieve the next page, set
-// this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AdunitsListCall) PageToken(pageToken string) *AdunitsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdunitsListCall) Fields(s ...googleapi.Field) *AdunitsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdunitsListCall) IfNoneMatch(entityTag string) *AdunitsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdunitsListCall) Context(ctx context.Context) *AdunitsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdunitsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["includeInactive"]; ok {
- params.Set("includeInactive", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/adunits")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.adunits.list" call.
-// Exactly one of *AdUnits or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnits.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AdunitsListCall) Do() (*AdUnits, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnits{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all ad units in the specified ad client for this AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.adunits.list",
- // "parameterOrder": [
- // "adClientId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client for which to list ad units.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "includeInactive": {
- // "description": "Whether to include inactive ad units. Default: true.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "The maximum number of ad units to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/adunits",
- // "response": {
- // "$ref": "AdUnits"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.adunits.customchannels.list":
-
-type AdunitsCustomchannelsListCall struct {
- s *Service
- adClientId string
- adUnitId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all custom channels which the specified ad unit belongs
-// to.
-func (r *AdunitsCustomchannelsService) List(adClientId string, adUnitId string) *AdunitsCustomchannelsListCall {
- c := &AdunitsCustomchannelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.adUnitId = adUnitId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of custom channels to include in the response, used for
-// paging.
-func (c *AdunitsCustomchannelsListCall) MaxResults(maxResults int64) *AdunitsCustomchannelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through custom channels. To retrieve the next
-// page, set this parameter to the value of "nextPageToken" from the
-// previous response.
-func (c *AdunitsCustomchannelsListCall) PageToken(pageToken string) *AdunitsCustomchannelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdunitsCustomchannelsListCall) Fields(s ...googleapi.Field) *AdunitsCustomchannelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdunitsCustomchannelsListCall) IfNoneMatch(entityTag string) *AdunitsCustomchannelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdunitsCustomchannelsListCall) Context(ctx context.Context) *AdunitsCustomchannelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdunitsCustomchannelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/adunits/{adUnitId}/customchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- "adUnitId": c.adUnitId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.adunits.customchannels.list" call.
-// Exactly one of *CustomChannels or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannels.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AdunitsCustomchannelsListCall) Do() (*CustomChannels, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannels{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all custom channels which the specified ad unit belongs to.",
- // "httpMethod": "GET",
- // "id": "adsense.adunits.customchannels.list",
- // "parameterOrder": [
- // "adClientId",
- // "adUnitId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client which contains the ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adUnitId": {
- // "description": "Ad unit for which to list custom channels.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of custom channels to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/adunits/{adUnitId}/customchannels",
- // "response": {
- // "$ref": "CustomChannels"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.alerts.delete":
-
-type AlertsDeleteCall struct {
- s *Service
- alertId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Dismiss (delete) the specified alert from the publisher's
-// AdSense account.
-func (r *AlertsService) Delete(alertId string) *AlertsDeleteCall {
- c := &AlertsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.alertId = alertId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AlertsDeleteCall) Fields(s ...googleapi.Field) *AlertsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AlertsDeleteCall) Context(ctx context.Context) *AlertsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AlertsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "alerts/{alertId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "alertId": c.alertId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.alerts.delete" call.
-func (c *AlertsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Dismiss (delete) the specified alert from the publisher's AdSense account.",
- // "httpMethod": "DELETE",
- // "id": "adsense.alerts.delete",
- // "parameterOrder": [
- // "alertId"
- // ],
- // "parameters": {
- // "alertId": {
- // "description": "Alert to delete.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "alerts/{alertId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense"
- // ]
- // }
-
-}
-
-// method id "adsense.alerts.list":
-
-type AlertsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List the alerts for this AdSense account.
-func (r *AlertsService) List() *AlertsListCall {
- c := &AlertsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Locale sets the optional parameter "locale": The locale to use for
-// translating alert messages. The account locale will be used if this
-// is not supplied. The AdSense default (English) will be used if the
-// supplied locale is invalid or unsupported.
-func (c *AlertsListCall) Locale(locale string) *AlertsListCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AlertsListCall) Fields(s ...googleapi.Field) *AlertsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AlertsListCall) IfNoneMatch(entityTag string) *AlertsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AlertsListCall) Context(ctx context.Context) *AlertsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AlertsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "alerts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.alerts.list" call.
-// Exactly one of *Alerts or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Alerts.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AlertsListCall) Do() (*Alerts, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Alerts{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List the alerts for this AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.alerts.list",
- // "parameters": {
- // "locale": {
- // "description": "The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "alerts",
- // "response": {
- // "$ref": "Alerts"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.customchannels.get":
-
-type CustomchannelsGetCall struct {
- s *Service
- adClientId string
- customChannelId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get the specified custom channel from the specified ad client.
-func (r *CustomchannelsService) Get(adClientId string, customChannelId string) *CustomchannelsGetCall {
- c := &CustomchannelsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.customChannelId = customChannelId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CustomchannelsGetCall) Fields(s ...googleapi.Field) *CustomchannelsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CustomchannelsGetCall) IfNoneMatch(entityTag string) *CustomchannelsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CustomchannelsGetCall) Context(ctx context.Context) *CustomchannelsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CustomchannelsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/customchannels/{customChannelId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- "customChannelId": c.customChannelId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.customchannels.get" call.
-// Exactly one of *CustomChannel or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannel.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CustomchannelsGetCall) Do() (*CustomChannel, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannel{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get the specified custom channel from the specified ad client.",
- // "httpMethod": "GET",
- // "id": "adsense.customchannels.get",
- // "parameterOrder": [
- // "adClientId",
- // "customChannelId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client which contains the custom channel.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "customChannelId": {
- // "description": "Custom channel to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/customchannels/{customChannelId}",
- // "response": {
- // "$ref": "CustomChannel"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.customchannels.list":
-
-type CustomchannelsListCall struct {
- s *Service
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all custom channels in the specified ad client for this
-// AdSense account.
-func (r *CustomchannelsService) List(adClientId string) *CustomchannelsListCall {
- c := &CustomchannelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of custom channels to include in the response, used for
-// paging.
-func (c *CustomchannelsListCall) MaxResults(maxResults int64) *CustomchannelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through custom channels. To retrieve the next
-// page, set this parameter to the value of "nextPageToken" from the
-// previous response.
-func (c *CustomchannelsListCall) PageToken(pageToken string) *CustomchannelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CustomchannelsListCall) Fields(s ...googleapi.Field) *CustomchannelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CustomchannelsListCall) IfNoneMatch(entityTag string) *CustomchannelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CustomchannelsListCall) Context(ctx context.Context) *CustomchannelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CustomchannelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/customchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.customchannels.list" call.
-// Exactly one of *CustomChannels or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannels.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CustomchannelsListCall) Do() (*CustomChannels, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannels{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all custom channels in the specified ad client for this AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.customchannels.list",
- // "parameterOrder": [
- // "adClientId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client for which to list custom channels.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of custom channels to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/customchannels",
- // "response": {
- // "$ref": "CustomChannels"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.customchannels.adunits.list":
-
-type CustomchannelsAdunitsListCall struct {
- s *Service
- adClientId string
- customChannelId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all ad units in the specified custom channel.
-func (r *CustomchannelsAdunitsService) List(adClientId string, customChannelId string) *CustomchannelsAdunitsListCall {
- c := &CustomchannelsAdunitsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.customChannelId = customChannelId
- return c
-}
-
-// IncludeInactive sets the optional parameter "includeInactive":
-// Whether to include inactive ad units. Default: true.
-func (c *CustomchannelsAdunitsListCall) IncludeInactive(includeInactive bool) *CustomchannelsAdunitsListCall {
- c.opt_["includeInactive"] = includeInactive
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of ad units to include in the response, used for paging.
-func (c *CustomchannelsAdunitsListCall) MaxResults(maxResults int64) *CustomchannelsAdunitsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad units. To retrieve the next page, set
-// this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *CustomchannelsAdunitsListCall) PageToken(pageToken string) *CustomchannelsAdunitsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CustomchannelsAdunitsListCall) Fields(s ...googleapi.Field) *CustomchannelsAdunitsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CustomchannelsAdunitsListCall) IfNoneMatch(entityTag string) *CustomchannelsAdunitsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CustomchannelsAdunitsListCall) Context(ctx context.Context) *CustomchannelsAdunitsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CustomchannelsAdunitsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["includeInactive"]; ok {
- params.Set("includeInactive", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/customchannels/{customChannelId}/adunits")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- "customChannelId": c.customChannelId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.customchannels.adunits.list" call.
-// Exactly one of *AdUnits or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnits.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *CustomchannelsAdunitsListCall) Do() (*AdUnits, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnits{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all ad units in the specified custom channel.",
- // "httpMethod": "GET",
- // "id": "adsense.customchannels.adunits.list",
- // "parameterOrder": [
- // "adClientId",
- // "customChannelId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client which contains the custom channel.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "customChannelId": {
- // "description": "Custom channel for which to list ad units.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "includeInactive": {
- // "description": "Whether to include inactive ad units. Default: true.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "The maximum number of ad units to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/customchannels/{customChannelId}/adunits",
- // "response": {
- // "$ref": "AdUnits"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.metadata.dimensions.list":
-
-type MetadataDimensionsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List the metadata for the dimensions available to this AdSense
-// account.
-func (r *MetadataDimensionsService) List() *MetadataDimensionsListCall {
- c := &MetadataDimensionsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MetadataDimensionsListCall) Fields(s ...googleapi.Field) *MetadataDimensionsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MetadataDimensionsListCall) IfNoneMatch(entityTag string) *MetadataDimensionsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MetadataDimensionsListCall) Context(ctx context.Context) *MetadataDimensionsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MetadataDimensionsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "metadata/dimensions")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.metadata.dimensions.list" call.
-// Exactly one of *Metadata or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Metadata.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *MetadataDimensionsListCall) Do() (*Metadata, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Metadata{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List the metadata for the dimensions available to this AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.metadata.dimensions.list",
- // "path": "metadata/dimensions",
- // "response": {
- // "$ref": "Metadata"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.metadata.metrics.list":
-
-type MetadataMetricsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List the metadata for the metrics available to this AdSense
-// account.
-func (r *MetadataMetricsService) List() *MetadataMetricsListCall {
- c := &MetadataMetricsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MetadataMetricsListCall) Fields(s ...googleapi.Field) *MetadataMetricsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MetadataMetricsListCall) IfNoneMatch(entityTag string) *MetadataMetricsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MetadataMetricsListCall) Context(ctx context.Context) *MetadataMetricsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MetadataMetricsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "metadata/metrics")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.metadata.metrics.list" call.
-// Exactly one of *Metadata or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Metadata.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *MetadataMetricsListCall) Do() (*Metadata, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Metadata{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List the metadata for the metrics available to this AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.metadata.metrics.list",
- // "path": "metadata/metrics",
- // "response": {
- // "$ref": "Metadata"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.payments.list":
-
-type PaymentsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List the payments for this AdSense account.
-func (r *PaymentsService) List() *PaymentsListCall {
- c := &PaymentsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PaymentsListCall) Fields(s ...googleapi.Field) *PaymentsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PaymentsListCall) IfNoneMatch(entityTag string) *PaymentsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PaymentsListCall) Context(ctx context.Context) *PaymentsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PaymentsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "payments")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.payments.list" call.
-// Exactly one of *Payments or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Payments.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *PaymentsListCall) Do() (*Payments, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Payments{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List the payments for this AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.payments.list",
- // "path": "payments",
- // "response": {
- // "$ref": "Payments"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.reports.generate":
-
-type ReportsGenerateCall struct {
- s *Service
- startDate string
- endDate string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Generate: Generate an AdSense report based on the report request sent
-// in the query parameters. Returns the result as JSON; to retrieve
-// output in CSV format specify "alt=csv" as a query parameter.
-func (r *ReportsService) Generate(startDate string, endDate string) *ReportsGenerateCall {
- c := &ReportsGenerateCall{s: r.s, opt_: make(map[string]interface{})}
- c.startDate = startDate
- c.endDate = endDate
- return c
-}
-
-// AccountId sets the optional parameter "accountId": Accounts upon
-// which to report.
-func (c *ReportsGenerateCall) AccountId(accountId string) *ReportsGenerateCall {
- c.opt_["accountId"] = accountId
- return c
-}
-
-// Currency sets the optional parameter "currency": Optional currency to
-// use when reporting on monetary metrics. Defaults to the account's
-// currency if not set.
-func (c *ReportsGenerateCall) Currency(currency string) *ReportsGenerateCall {
- c.opt_["currency"] = currency
- return c
-}
-
-// Dimension sets the optional parameter "dimension": Dimensions to base
-// the report on.
-func (c *ReportsGenerateCall) Dimension(dimension string) *ReportsGenerateCall {
- c.opt_["dimension"] = dimension
- return c
-}
-
-// Filter sets the optional parameter "filter": Filters to be run on the
-// report.
-func (c *ReportsGenerateCall) Filter(filter string) *ReportsGenerateCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// Locale sets the optional parameter "locale": Optional locale to use
-// for translating report output to a local language. Defaults to
-// "en_US" if not specified.
-func (c *ReportsGenerateCall) Locale(locale string) *ReportsGenerateCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of rows of report data to return.
-func (c *ReportsGenerateCall) MaxResults(maxResults int64) *ReportsGenerateCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// Metric sets the optional parameter "metric": Numeric columns to
-// include in the report.
-func (c *ReportsGenerateCall) Metric(metric string) *ReportsGenerateCall {
- c.opt_["metric"] = metric
- return c
-}
-
-// Sort sets the optional parameter "sort": The name of a dimension or
-// metric to sort the resulting report on, optionally prefixed with "+"
-// to sort ascending or "-" to sort descending. If no prefix is
-// specified, the column is sorted ascending.
-func (c *ReportsGenerateCall) Sort(sort string) *ReportsGenerateCall {
- c.opt_["sort"] = sort
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex": Index of the
-// first row of report data to return.
-func (c *ReportsGenerateCall) StartIndex(startIndex int64) *ReportsGenerateCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// UseTimezoneReporting sets the optional parameter
-// "useTimezoneReporting": Whether the report should be generated in the
-// AdSense account's local timezone. If false default PST/PDT timezone
-// will be used.
-func (c *ReportsGenerateCall) UseTimezoneReporting(useTimezoneReporting bool) *ReportsGenerateCall {
- c.opt_["useTimezoneReporting"] = useTimezoneReporting
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsGenerateCall) Fields(s ...googleapi.Field) *ReportsGenerateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsGenerateCall) IfNoneMatch(entityTag string) *ReportsGenerateCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do and Download methods.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsGenerateCall) Context(ctx context.Context) *ReportsGenerateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsGenerateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("endDate", fmt.Sprintf("%v", c.endDate))
- params.Set("startDate", fmt.Sprintf("%v", c.startDate))
- if v, ok := c.opt_["accountId"]; ok {
- params.Set("accountId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["currency"]; ok {
- params.Set("currency", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["dimension"]; ok {
- params.Set("dimension", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["metric"]; ok {
- params.Set("metric", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sort"]; ok {
- params.Set("sort", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["useTimezoneReporting"]; ok {
- params.Set("useTimezoneReporting", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "reports")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Download fetches the API endpoint's "media" value, instead of the normal
-// API response value. If the returned error is nil, the Response is guaranteed to
-// have a 2xx status code. Callers must close the Response.Body as usual.
-func (c *ReportsGenerateCall) Download() (*http.Response, error) {
- res, err := c.doRequest("media")
- if err != nil {
- return nil, err
- }
- if err := googleapi.CheckMediaResponse(res); err != nil {
- res.Body.Close()
- return nil, err
- }
- return res, nil
-}
-
-// Do executes the "adsense.reports.generate" call.
-// Exactly one of *AdsenseReportsGenerateResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *AdsenseReportsGenerateResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ReportsGenerateCall) Do() (*AdsenseReportsGenerateResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdsenseReportsGenerateResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
- // "httpMethod": "GET",
- // "id": "adsense.reports.generate",
- // "parameterOrder": [
- // "startDate",
- // "endDate"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Accounts upon which to report.",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "currency": {
- // "description": "Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.",
- // "location": "query",
- // "pattern": "[a-zA-Z]+",
- // "type": "string"
- // },
- // "dimension": {
- // "description": "Dimensions to base the report on.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "endDate": {
- // "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- // "location": "query",
- // "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)|(latest-(\\d{2})-(\\d{2})(-\\d+y)?)|(latest-latest-(\\d{2})(-\\d+m)?)",
- // "required": true,
- // "type": "string"
- // },
- // "filter": {
- // "description": "Filters to be run on the report.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+(==|=@).+",
- // "repeated": true,
- // "type": "string"
- // },
- // "locale": {
- // "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of rows of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "50000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "metric": {
- // "description": "Numeric columns to include in the report.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "sort": {
- // "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
- // "location": "query",
- // "pattern": "(\\+|-)?[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "startDate": {
- // "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- // "location": "query",
- // "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)|(latest-(\\d{2})-(\\d{2})(-\\d+y)?)|(latest-latest-(\\d{2})(-\\d+m)?)",
- // "required": true,
- // "type": "string"
- // },
- // "startIndex": {
- // "description": "Index of the first row of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "5000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "useTimezoneReporting": {
- // "description": "Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "reports",
- // "response": {
- // "$ref": "AdsenseReportsGenerateResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ],
- // "supportsMediaDownload": true
- // }
-
-}
-
-// method id "adsense.reports.saved.generate":
-
-type ReportsSavedGenerateCall struct {
- s *Service
- savedReportId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Generate: Generate an AdSense report based on the saved report ID
-// sent in the query parameters.
-func (r *ReportsSavedService) Generate(savedReportId string) *ReportsSavedGenerateCall {
- c := &ReportsSavedGenerateCall{s: r.s, opt_: make(map[string]interface{})}
- c.savedReportId = savedReportId
- return c
-}
-
-// Locale sets the optional parameter "locale": Optional locale to use
-// for translating report output to a local language. Defaults to
-// "en_US" if not specified.
-func (c *ReportsSavedGenerateCall) Locale(locale string) *ReportsSavedGenerateCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of rows of report data to return.
-func (c *ReportsSavedGenerateCall) MaxResults(maxResults int64) *ReportsSavedGenerateCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex": Index of the
-// first row of report data to return.
-func (c *ReportsSavedGenerateCall) StartIndex(startIndex int64) *ReportsSavedGenerateCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsSavedGenerateCall) Fields(s ...googleapi.Field) *ReportsSavedGenerateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsSavedGenerateCall) IfNoneMatch(entityTag string) *ReportsSavedGenerateCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsSavedGenerateCall) Context(ctx context.Context) *ReportsSavedGenerateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsSavedGenerateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "reports/{savedReportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "savedReportId": c.savedReportId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.reports.saved.generate" call.
-// Exactly one of *AdsenseReportsGenerateResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *AdsenseReportsGenerateResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ReportsSavedGenerateCall) Do() (*AdsenseReportsGenerateResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdsenseReportsGenerateResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Generate an AdSense report based on the saved report ID sent in the query parameters.",
- // "httpMethod": "GET",
- // "id": "adsense.reports.saved.generate",
- // "parameterOrder": [
- // "savedReportId"
- // ],
- // "parameters": {
- // "locale": {
- // "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of rows of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "50000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "savedReportId": {
- // "description": "The saved report to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "startIndex": {
- // "description": "Index of the first row of report data to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "5000",
- // "minimum": "0",
- // "type": "integer"
- // }
- // },
- // "path": "reports/{savedReportId}",
- // "response": {
- // "$ref": "AdsenseReportsGenerateResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.reports.saved.list":
-
-type ReportsSavedListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all saved reports in this AdSense account.
-func (r *ReportsSavedService) List() *ReportsSavedListCall {
- c := &ReportsSavedListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of saved reports to include in the response, used for paging.
-func (c *ReportsSavedListCall) MaxResults(maxResults int64) *ReportsSavedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through saved reports. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *ReportsSavedListCall) PageToken(pageToken string) *ReportsSavedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsSavedListCall) Fields(s ...googleapi.Field) *ReportsSavedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsSavedListCall) IfNoneMatch(entityTag string) *ReportsSavedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsSavedListCall) Context(ctx context.Context) *ReportsSavedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsSavedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "reports/saved")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.reports.saved.list" call.
-// Exactly one of *SavedReports or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *SavedReports.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ReportsSavedListCall) Do() (*SavedReports, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SavedReports{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all saved reports in this AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.reports.saved.list",
- // "parameters": {
- // "maxResults": {
- // "description": "The maximum number of saved reports to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "100",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "reports/saved",
- // "response": {
- // "$ref": "SavedReports"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.savedadstyles.get":
-
-type SavedadstylesGetCall struct {
- s *Service
- savedAdStyleId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get a specific saved ad style from the user's account.
-func (r *SavedadstylesService) Get(savedAdStyleId string) *SavedadstylesGetCall {
- c := &SavedadstylesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.savedAdStyleId = savedAdStyleId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SavedadstylesGetCall) Fields(s ...googleapi.Field) *SavedadstylesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SavedadstylesGetCall) IfNoneMatch(entityTag string) *SavedadstylesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SavedadstylesGetCall) Context(ctx context.Context) *SavedadstylesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SavedadstylesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "savedadstyles/{savedAdStyleId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "savedAdStyleId": c.savedAdStyleId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.savedadstyles.get" call.
-// Exactly one of *SavedAdStyle or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *SavedAdStyle.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *SavedadstylesGetCall) Do() (*SavedAdStyle, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SavedAdStyle{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get a specific saved ad style from the user's account.",
- // "httpMethod": "GET",
- // "id": "adsense.savedadstyles.get",
- // "parameterOrder": [
- // "savedAdStyleId"
- // ],
- // "parameters": {
- // "savedAdStyleId": {
- // "description": "Saved ad style to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "savedadstyles/{savedAdStyleId}",
- // "response": {
- // "$ref": "SavedAdStyle"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.savedadstyles.list":
-
-type SavedadstylesListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all saved ad styles in the user's account.
-func (r *SavedadstylesService) List() *SavedadstylesListCall {
- c := &SavedadstylesListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of saved ad styles to include in the response, used for
-// paging.
-func (c *SavedadstylesListCall) MaxResults(maxResults int64) *SavedadstylesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through saved ad styles. To retrieve the next
-// page, set this parameter to the value of "nextPageToken" from the
-// previous response.
-func (c *SavedadstylesListCall) PageToken(pageToken string) *SavedadstylesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SavedadstylesListCall) Fields(s ...googleapi.Field) *SavedadstylesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SavedadstylesListCall) IfNoneMatch(entityTag string) *SavedadstylesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SavedadstylesListCall) Context(ctx context.Context) *SavedadstylesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SavedadstylesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "savedadstyles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.savedadstyles.list" call.
-// Exactly one of *SavedAdStyles or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *SavedAdStyles.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *SavedadstylesListCall) Do() (*SavedAdStyles, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SavedAdStyles{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all saved ad styles in the user's account.",
- // "httpMethod": "GET",
- // "id": "adsense.savedadstyles.list",
- // "parameters": {
- // "maxResults": {
- // "description": "The maximum number of saved ad styles to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "savedadstyles",
- // "response": {
- // "$ref": "SavedAdStyles"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
-
-// method id "adsense.urlchannels.list":
-
-type UrlchannelsListCall struct {
- s *Service
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all URL channels in the specified ad client for this
-// AdSense account.
-func (r *UrlchannelsService) List(adClientId string) *UrlchannelsListCall {
- c := &UrlchannelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of URL channels to include in the response, used for paging.
-func (c *UrlchannelsListCall) MaxResults(maxResults int64) *UrlchannelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through URL channels. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *UrlchannelsListCall) PageToken(pageToken string) *UrlchannelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UrlchannelsListCall) Fields(s ...googleapi.Field) *UrlchannelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UrlchannelsListCall) IfNoneMatch(entityTag string) *UrlchannelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UrlchannelsListCall) Context(ctx context.Context) *UrlchannelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UrlchannelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/urlchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsense.urlchannels.list" call.
-// Exactly one of *UrlChannels or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UrlChannels.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UrlchannelsListCall) Do() (*UrlChannels, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UrlChannels{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all URL channels in the specified ad client for this AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsense.urlchannels.list",
- // "parameterOrder": [
- // "adClientId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client for which to list URL channels.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of URL channels to include in the response, used for paging.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/urlchannels",
- // "response": {
- // "$ref": "UrlChannels"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsense",
- // "https://www.googleapis.com/auth/adsense.readonly"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/adsensehost/v4.1/adsensehost-api.json b/vendor/google.golang.org/api/adsensehost/v4.1/adsensehost-api.json
deleted file mode 100644
index e4979b1d..00000000
--- a/vendor/google.golang.org/api/adsensehost/v4.1/adsensehost-api.json
+++ /dev/null
@@ -1,1569 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/yoGXlEwGPLEAr1fmq3U4dFpyoyQ\"",
- "discoveryVersion": "v1",
- "id": "adsensehost:v4.1",
- "name": "adsensehost",
- "canonicalName": "AdSense Host",
- "version": "v4.1",
- "revision": "20141229",
- "title": "AdSense Host API",
- "description": "Gives AdSense Hosts access to report generation, ad code generation, and publisher management capabilities.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/adsense-16.png",
- "x32": "https://www.google.com/images/icons/product/adsense-32.png"
- },
- "documentationLink": "https://developers.google.com/adsense/host/",
- "labels": [
- "limited_availability"
- ],
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/adsensehost/v4.1/",
- "basePath": "/adsensehost/v4.1/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "adsensehost/v4.1/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "csv",
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of text/csv",
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/adsensehost": {
- "description": "View and manage your AdSense host data and associated accounts"
- }
- }
- }
- },
- "schemas": {
- "Account": {
- "id": "Account",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this account."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsensehost#account.",
- "default": "adsensehost#account"
- },
- "name": {
- "type": "string",
- "description": "Name of this account."
- },
- "status": {
- "type": "string",
- "description": "Approval status of this account. One of: PENDING, APPROVED, DISABLED."
- }
- }
- },
- "Accounts": {
- "id": "Accounts",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The accounts returned in this list response.",
- "items": {
- "$ref": "Account"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsensehost#accounts.",
- "default": "adsensehost#accounts"
- }
- }
- },
- "AdClient": {
- "id": "AdClient",
- "type": "object",
- "properties": {
- "arcOptIn": {
- "type": "boolean",
- "description": "Whether this ad client is opted in to ARC."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this ad client."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsensehost#adClient.",
- "default": "adsensehost#adClient"
- },
- "productCode": {
- "type": "string",
- "description": "This ad client's product code, which corresponds to the PRODUCT_CODE report dimension."
- },
- "supportsReporting": {
- "type": "boolean",
- "description": "Whether this ad client supports being reported on."
- }
- }
- },
- "AdClients": {
- "id": "AdClients",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The ad clients returned in this list response.",
- "items": {
- "$ref": "AdClient"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsensehost#adClients.",
- "default": "adsensehost#adClients"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "AdCode": {
- "id": "AdCode",
- "type": "object",
- "properties": {
- "adCode": {
- "type": "string",
- "description": "The ad code snippet."
- },
- "kind": {
- "type": "string",
- "description": "Kind this is, in this case adsensehost#adCode.",
- "default": "adsensehost#adCode"
- }
- }
- },
- "AdStyle": {
- "id": "AdStyle",
- "type": "object",
- "properties": {
- "colors": {
- "type": "object",
- "description": "The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.",
- "properties": {
- "background": {
- "type": "string",
- "description": "The color of the ad background."
- },
- "border": {
- "type": "string",
- "description": "The color of the ad border."
- },
- "text": {
- "type": "string",
- "description": "The color of the ad text."
- },
- "title": {
- "type": "string",
- "description": "The color of the ad title."
- },
- "url": {
- "type": "string",
- "description": "The color of the ad url."
- }
- }
- },
- "corners": {
- "type": "string",
- "description": "The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED."
- },
- "font": {
- "type": "object",
- "description": "The font which is included in the style.",
- "properties": {
- "family": {
- "type": "string",
- "description": "The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA."
- },
- "size": {
- "type": "string",
- "description": "The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE."
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind this is, in this case adsensehost#adStyle.",
- "default": "adsensehost#adStyle"
- }
- }
- },
- "AdUnit": {
- "id": "AdUnit",
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "Identity code of this ad unit, not necessarily unique across ad clients."
- },
- "contentAdsSettings": {
- "type": "object",
- "description": "Settings specific to content ads (AFC) and highend mobile content ads (AFMC).",
- "properties": {
- "backupOption": {
- "type": "object",
- "description": "The backup option to be used in instances where no ad is available.",
- "properties": {
- "color": {
- "type": "string",
- "description": "Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash."
- },
- "type": {
- "type": "string",
- "description": "Type of the backup option. Possible values are BLANK, COLOR and URL."
- },
- "url": {
- "type": "string",
- "description": "URL to use when type is set to URL."
- }
- }
- },
- "size": {
- "type": "string",
- "description": "Size of this ad unit. Size values are in the form SIZE_{width}_{height}."
- },
- "type": {
- "type": "string",
- "description": "Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK."
- }
- }
- },
- "customStyle": {
- "$ref": "AdStyle",
- "description": "Custom style information specific to this ad unit."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsensehost#adUnit.",
- "default": "adsensehost#adUnit"
- },
- "mobileContentAdsSettings": {
- "type": "object",
- "description": "Settings specific to WAP mobile content ads (AFMC).",
- "properties": {
- "markupLanguage": {
- "type": "string",
- "description": "The markup language to use for this ad unit."
- },
- "scriptingLanguage": {
- "type": "string",
- "description": "The scripting language to use for this ad unit."
- },
- "size": {
- "type": "string",
- "description": "Size of this ad unit."
- },
- "type": {
- "type": "string",
- "description": "Type of this ad unit."
- }
- }
- },
- "name": {
- "type": "string",
- "description": "Name of this ad unit."
- },
- "status": {
- "type": "string",
- "description": "Status of this ad unit. Possible values are:\nNEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.\n\nACTIVE: Indicates that there has been activity on this ad unit in the last seven days.\n\nINACTIVE: Indicates that there has been no activity on this ad unit in the last seven days."
- }
- }
- },
- "AdUnits": {
- "id": "AdUnits",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The ad units returned in this list response.",
- "items": {
- "$ref": "AdUnit"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsensehost#adUnits.",
- "default": "adsensehost#adUnits"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through ad units. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "AssociationSession": {
- "id": "AssociationSession",
- "type": "object",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Hosted account id of the associated publisher after association. Present if status is ACCEPTED."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this association session."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsensehost#associationSession.",
- "default": "adsensehost#associationSession"
- },
- "productCodes": {
- "type": "array",
- "description": "The products to associate with the user. Options: AFC, AFF, AFS, AFMC",
- "items": {
- "type": "string"
- }
- },
- "redirectUrl": {
- "type": "string",
- "description": "Redirect URL of this association session. Used to redirect users into the AdSense association flow."
- },
- "status": {
- "type": "string",
- "description": "Status of the completed association, available once the association callback token has been verified. One of ACCEPTED, REJECTED, or ERROR."
- },
- "userLocale": {
- "type": "string",
- "description": "The preferred locale of the user themselves when going through the AdSense association flow."
- },
- "websiteLocale": {
- "type": "string",
- "description": "The locale of the user's hosted website."
- },
- "websiteUrl": {
- "type": "string",
- "description": "The URL of the user's hosted website."
- }
- }
- },
- "CustomChannel": {
- "id": "CustomChannel",
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "Code of this custom channel, not necessarily unique across ad clients."
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsensehost#customChannel.",
- "default": "adsensehost#customChannel"
- },
- "name": {
- "type": "string",
- "description": "Name of this custom channel."
- }
- }
- },
- "CustomChannels": {
- "id": "CustomChannels",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The custom channels returned in this list response.",
- "items": {
- "$ref": "CustomChannel"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsensehost#customChannels.",
- "default": "adsensehost#customChannels"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- },
- "Report": {
- "id": "Report",
- "type": "object",
- "properties": {
- "averages": {
- "type": "array",
- "description": "The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
- "items": {
- "type": "string"
- }
- },
- "headers": {
- "type": "array",
- "description": "The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.",
- "items": {
- "type": "object",
- "properties": {
- "currency": {
- "type": "string",
- "description": "The currency of this column. Only present if the header type is METRIC_CURRENCY."
- },
- "name": {
- "type": "string",
- "description": "The name of the header."
- },
- "type": {
- "type": "string",
- "description": "The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY."
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind this is, in this case adsensehost#report.",
- "default": "adsensehost#report"
- },
- "rows": {
- "type": "array",
- "description": "The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.",
- "items": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "totalMatchedRows": {
- "type": "string",
- "description": "The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.",
- "format": "int64"
- },
- "totals": {
- "type": "array",
- "description": "The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.",
- "items": {
- "type": "string"
- }
- },
- "warnings": {
- "type": "array",
- "description": "Any warnings associated with generation of the report.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "UrlChannel": {
- "id": "UrlChannel",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case adsensehost#urlChannel.",
- "default": "adsensehost#urlChannel"
- },
- "urlPattern": {
- "type": "string",
- "description": "URL Pattern of this URL channel. Does not include \"http://\" or \"https://\". Example: www.example.com/home"
- }
- }
- },
- "UrlChannels": {
- "id": "UrlChannels",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The URL channels returned in this list response.",
- "items": {
- "$ref": "UrlChannel"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case adsensehost#urlChannels.",
- "default": "adsensehost#urlChannels"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
- }
- }
- }
- },
- "resources": {
- "accounts": {
- "methods": {
- "get": {
- "id": "adsensehost.accounts.get",
- "path": "accounts/{accountId}",
- "httpMethod": "GET",
- "description": "Get information about the selected associated AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account to get information about.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "list": {
- "id": "adsensehost.accounts.list",
- "path": "accounts",
- "httpMethod": "GET",
- "description": "List hosted accounts associated with this AdSense account by ad client id.",
- "parameters": {
- "filterAdClientId": {
- "type": "string",
- "description": "Ad clients to list accounts for.",
- "required": true,
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "filterAdClientId"
- ],
- "response": {
- "$ref": "Accounts"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- }
- },
- "resources": {
- "adclients": {
- "methods": {
- "get": {
- "id": "adsensehost.accounts.adclients.get",
- "path": "accounts/{accountId}/adclients/{adClientId}",
- "httpMethod": "GET",
- "description": "Get information about one of the ad clients in the specified publisher's AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account which contains the ad client.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client to get.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId"
- ],
- "response": {
- "$ref": "AdClient"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "list": {
- "id": "adsensehost.accounts.adclients.list",
- "path": "accounts/{accountId}/adclients",
- "httpMethod": "GET",
- "description": "List all hosted ad clients in the specified hosted account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account for which to list ad clients.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad clients to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "AdClients"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- }
- }
- },
- "adunits": {
- "methods": {
- "delete": {
- "id": "adsensehost.accounts.adunits.delete",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}",
- "httpMethod": "DELETE",
- "description": "Delete the specified ad unit from the specified publisher AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account which contains the ad unit.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to get ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit to delete.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "AdUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "get": {
- "id": "adsensehost.accounts.adunits.get",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}",
- "httpMethod": "GET",
- "description": "Get the specified host ad unit in this AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account which contains the ad unit.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to get ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit to get.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "AdUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "getAdCode": {
- "id": "adsensehost.accounts.adunits.getAdCode",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/adcode",
- "httpMethod": "GET",
- "description": "Get ad code for the specified ad unit, attaching the specified host custom channels.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account which contains the ad client.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client with contains the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit to get the code for.",
- "required": true,
- "location": "path"
- },
- "hostCustomChannelId": {
- "type": "string",
- "description": "Host custom channel to attach to the ad code.",
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "adUnitId"
- ],
- "response": {
- "$ref": "AdCode"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "insert": {
- "id": "adsensehost.accounts.adunits.insert",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
- "httpMethod": "POST",
- "description": "Insert the supplied ad unit into the specified publisher AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account which will contain the ad unit.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client into which to insert the ad unit.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId"
- ],
- "request": {
- "$ref": "AdUnit"
- },
- "response": {
- "$ref": "AdUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "list": {
- "id": "adsensehost.accounts.adunits.list",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
- "httpMethod": "GET",
- "description": "List all ad units in the specified publisher's AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account which contains the ad client.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list ad units.",
- "required": true,
- "location": "path"
- },
- "includeInactive": {
- "type": "boolean",
- "description": "Whether to include inactive ad units. Default: true.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad units to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId"
- ],
- "response": {
- "$ref": "AdUnits"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "patch": {
- "id": "adsensehost.accounts.adunits.patch",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
- "httpMethod": "PATCH",
- "description": "Update the supplied ad unit in the specified publisher AdSense account. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account which contains the ad client.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the ad unit.",
- "required": true,
- "location": "path"
- },
- "adUnitId": {
- "type": "string",
- "description": "Ad unit to get.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId",
- "adUnitId"
- ],
- "request": {
- "$ref": "AdUnit"
- },
- "response": {
- "$ref": "AdUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "update": {
- "id": "adsensehost.accounts.adunits.update",
- "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
- "httpMethod": "PUT",
- "description": "Update the supplied ad unit in the specified publisher AdSense account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account which contains the ad client.",
- "required": true,
- "location": "path"
- },
- "adClientId": {
- "type": "string",
- "description": "Ad client which contains the ad unit.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "adClientId"
- ],
- "request": {
- "$ref": "AdUnit"
- },
- "response": {
- "$ref": "AdUnit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- }
- }
- },
- "reports": {
- "methods": {
- "generate": {
- "id": "adsensehost.accounts.reports.generate",
- "path": "accounts/{accountId}/reports",
- "httpMethod": "GET",
- "description": "Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Hosted account upon which to report.",
- "required": true,
- "location": "path"
- },
- "dimension": {
- "type": "string",
- "description": "Dimensions to base the report on.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "endDate": {
- "type": "string",
- "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "Filters to be run on the report.",
- "pattern": "[a-zA-Z_]+(==|=@).+",
- "repeated": true,
- "location": "query"
- },
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "metric": {
- "type": "string",
- "description": "Numeric columns to include in the report.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "sort": {
- "type": "string",
- "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
- "pattern": "(\\+|-)?[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "startDate": {
- "type": "string",
- "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId",
- "startDate",
- "endDate"
- ],
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- }
- }
- }
- }
- },
- "adclients": {
- "methods": {
- "get": {
- "id": "adsensehost.adclients.get",
- "path": "adclients/{adClientId}",
- "httpMethod": "GET",
- "description": "Get information about one of the ad clients in the Host AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client to get.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "AdClient"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "list": {
- "id": "adsensehost.adclients.list",
- "path": "adclients",
- "httpMethod": "GET",
- "description": "List all host ad clients in this AdSense account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of ad clients to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "AdClients"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- }
- }
- },
- "associationsessions": {
- "methods": {
- "start": {
- "id": "adsensehost.associationsessions.start",
- "path": "associationsessions/start",
- "httpMethod": "GET",
- "description": "Create an association session for initiating an association with an AdSense user.",
- "parameters": {
- "productCode": {
- "type": "string",
- "description": "Products to associate with the user.",
- "required": true,
- "enum": [
- "AFC",
- "AFG",
- "AFMC",
- "AFS",
- "AFV"
- ],
- "enumDescriptions": [
- "AdSense For Content",
- "AdSense For Games",
- "AdSense For Mobile Content",
- "AdSense For Search",
- "AdSense For Video"
- ],
- "repeated": true,
- "location": "query"
- },
- "userLocale": {
- "type": "string",
- "description": "The preferred locale of the user.",
- "location": "query"
- },
- "websiteLocale": {
- "type": "string",
- "description": "The locale of the user's hosted website.",
- "location": "query"
- },
- "websiteUrl": {
- "type": "string",
- "description": "The URL of the user's hosted website.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "productCode",
- "websiteUrl"
- ],
- "response": {
- "$ref": "AssociationSession"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "verify": {
- "id": "adsensehost.associationsessions.verify",
- "path": "associationsessions/verify",
- "httpMethod": "GET",
- "description": "Verify an association session after the association callback returns from AdSense signup.",
- "parameters": {
- "token": {
- "type": "string",
- "description": "The token returned to the association callback URL.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "token"
- ],
- "response": {
- "$ref": "AssociationSession"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- }
- }
- },
- "customchannels": {
- "methods": {
- "delete": {
- "id": "adsensehost.customchannels.delete",
- "path": "adclients/{adClientId}/customchannels/{customChannelId}",
- "httpMethod": "DELETE",
- "description": "Delete a specific custom channel from the host AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client from which to delete the custom channel.",
- "required": true,
- "location": "path"
- },
- "customChannelId": {
- "type": "string",
- "description": "Custom channel to delete.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "CustomChannel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "get": {
- "id": "adsensehost.customchannels.get",
- "path": "adclients/{adClientId}/customchannels/{customChannelId}",
- "httpMethod": "GET",
- "description": "Get a specific custom channel from the host AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client from which to get the custom channel.",
- "required": true,
- "location": "path"
- },
- "customChannelId": {
- "type": "string",
- "description": "Custom channel to get.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId",
- "customChannelId"
- ],
- "response": {
- "$ref": "CustomChannel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "insert": {
- "id": "adsensehost.customchannels.insert",
- "path": "adclients/{adClientId}/customchannels",
- "httpMethod": "POST",
- "description": "Add a new custom channel to the host AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client to which the new custom channel will be added.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "request": {
- "$ref": "CustomChannel"
- },
- "response": {
- "$ref": "CustomChannel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "list": {
- "id": "adsensehost.customchannels.list",
- "path": "adclients/{adClientId}/customchannels",
- "httpMethod": "GET",
- "description": "List all host custom channels in this AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list custom channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of custom channels to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "CustomChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "patch": {
- "id": "adsensehost.customchannels.patch",
- "path": "adclients/{adClientId}/customchannels",
- "httpMethod": "PATCH",
- "description": "Update a custom channel in the host AdSense account. This method supports patch semantics.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client in which the custom channel will be updated.",
- "required": true,
- "location": "path"
- },
- "customChannelId": {
- "type": "string",
- "description": "Custom channel to get.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId",
- "customChannelId"
- ],
- "request": {
- "$ref": "CustomChannel"
- },
- "response": {
- "$ref": "CustomChannel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "update": {
- "id": "adsensehost.customchannels.update",
- "path": "adclients/{adClientId}/customchannels",
- "httpMethod": "PUT",
- "description": "Update a custom channel in the host AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client in which the custom channel will be updated.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "request": {
- "$ref": "CustomChannel"
- },
- "response": {
- "$ref": "CustomChannel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- }
- }
- },
- "reports": {
- "methods": {
- "generate": {
- "id": "adsensehost.reports.generate",
- "path": "reports",
- "httpMethod": "GET",
- "description": "Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
- "parameters": {
- "dimension": {
- "type": "string",
- "description": "Dimensions to base the report on.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "endDate": {
- "type": "string",
- "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "Filters to be run on the report.",
- "pattern": "[a-zA-Z_]+(==|=@).+",
- "repeated": true,
- "location": "query"
- },
- "locale": {
- "type": "string",
- "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- "pattern": "[a-zA-Z_]+",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of rows of report data to return.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "50000",
- "location": "query"
- },
- "metric": {
- "type": "string",
- "description": "Numeric columns to include in the report.",
- "pattern": "[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "sort": {
- "type": "string",
- "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
- "pattern": "(\\+|-)?[a-zA-Z_]+",
- "repeated": true,
- "location": "query"
- },
- "startDate": {
- "type": "string",
- "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- "required": true,
- "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first row of report data to return.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "5000",
- "location": "query"
- }
- },
- "parameterOrder": [
- "startDate",
- "endDate"
- ],
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- }
- }
- },
- "urlchannels": {
- "methods": {
- "delete": {
- "id": "adsensehost.urlchannels.delete",
- "path": "adclients/{adClientId}/urlchannels/{urlChannelId}",
- "httpMethod": "DELETE",
- "description": "Delete a URL channel from the host AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client from which to delete the URL channel.",
- "required": true,
- "location": "path"
- },
- "urlChannelId": {
- "type": "string",
- "description": "URL channel to delete.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId",
- "urlChannelId"
- ],
- "response": {
- "$ref": "UrlChannel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "insert": {
- "id": "adsensehost.urlchannels.insert",
- "path": "adclients/{adClientId}/urlchannels",
- "httpMethod": "POST",
- "description": "Add a new URL channel to the host AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client to which the new URL channel will be added.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "request": {
- "$ref": "UrlChannel"
- },
- "response": {
- "$ref": "UrlChannel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- },
- "list": {
- "id": "adsensehost.urlchannels.list",
- "path": "adclients/{adClientId}/urlchannels",
- "httpMethod": "GET",
- "description": "List all host URL channels in the host AdSense account.",
- "parameters": {
- "adClientId": {
- "type": "string",
- "description": "Ad client for which to list URL channels.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of URL channels to include in the response, used for paging.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "10000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "adClientId"
- ],
- "response": {
- "$ref": "UrlChannels"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adsensehost"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/adsensehost/v4.1/adsensehost-gen.go b/vendor/google.golang.org/api/adsensehost/v4.1/adsensehost-gen.go
deleted file mode 100644
index 3b8d0302..00000000
--- a/vendor/google.golang.org/api/adsensehost/v4.1/adsensehost-gen.go
+++ /dev/null
@@ -1,4809 +0,0 @@
-// Package adsensehost provides access to the AdSense Host API.
-//
-// See https://developers.google.com/adsense/host/
-//
-// Usage example:
-//
-// import "google.golang.org/api/adsensehost/v4.1"
-// ...
-// adsensehostService, err := adsensehost.New(oauthHttpClient)
-package adsensehost // import "google.golang.org/api/adsensehost/v4.1"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "adsensehost:v4.1"
-const apiName = "adsensehost"
-const apiVersion = "v4.1"
-const basePath = "https://www.googleapis.com/adsensehost/v4.1/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your AdSense host data and associated accounts
- AdsensehostScope = "https://www.googleapis.com/auth/adsensehost"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Accounts = NewAccountsService(s)
- s.Adclients = NewAdclientsService(s)
- s.Associationsessions = NewAssociationsessionsService(s)
- s.Customchannels = NewCustomchannelsService(s)
- s.Reports = NewReportsService(s)
- s.Urlchannels = NewUrlchannelsService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Accounts *AccountsService
-
- Adclients *AdclientsService
-
- Associationsessions *AssociationsessionsService
-
- Customchannels *CustomchannelsService
-
- Reports *ReportsService
-
- Urlchannels *UrlchannelsService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewAccountsService(s *Service) *AccountsService {
- rs := &AccountsService{s: s}
- rs.Adclients = NewAccountsAdclientsService(s)
- rs.Adunits = NewAccountsAdunitsService(s)
- rs.Reports = NewAccountsReportsService(s)
- return rs
-}
-
-type AccountsService struct {
- s *Service
-
- Adclients *AccountsAdclientsService
-
- Adunits *AccountsAdunitsService
-
- Reports *AccountsReportsService
-}
-
-func NewAccountsAdclientsService(s *Service) *AccountsAdclientsService {
- rs := &AccountsAdclientsService{s: s}
- return rs
-}
-
-type AccountsAdclientsService struct {
- s *Service
-}
-
-func NewAccountsAdunitsService(s *Service) *AccountsAdunitsService {
- rs := &AccountsAdunitsService{s: s}
- return rs
-}
-
-type AccountsAdunitsService struct {
- s *Service
-}
-
-func NewAccountsReportsService(s *Service) *AccountsReportsService {
- rs := &AccountsReportsService{s: s}
- return rs
-}
-
-type AccountsReportsService struct {
- s *Service
-}
-
-func NewAdclientsService(s *Service) *AdclientsService {
- rs := &AdclientsService{s: s}
- return rs
-}
-
-type AdclientsService struct {
- s *Service
-}
-
-func NewAssociationsessionsService(s *Service) *AssociationsessionsService {
- rs := &AssociationsessionsService{s: s}
- return rs
-}
-
-type AssociationsessionsService struct {
- s *Service
-}
-
-func NewCustomchannelsService(s *Service) *CustomchannelsService {
- rs := &CustomchannelsService{s: s}
- return rs
-}
-
-type CustomchannelsService struct {
- s *Service
-}
-
-func NewReportsService(s *Service) *ReportsService {
- rs := &ReportsService{s: s}
- return rs
-}
-
-type ReportsService struct {
- s *Service
-}
-
-func NewUrlchannelsService(s *Service) *UrlchannelsService {
- rs := &UrlchannelsService{s: s}
- return rs
-}
-
-type UrlchannelsService struct {
- s *Service
-}
-
-type Account struct {
- // Id: Unique identifier of this account.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adsensehost#account.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this account.
- Name string `json:"name,omitempty"`
-
- // Status: Approval status of this account. One of: PENDING, APPROVED,
- // DISABLED.
- Status string `json:"status,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Account) MarshalJSON() ([]byte, error) {
- type noMethod Account
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Accounts struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The accounts returned in this list response.
- Items []*Account `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsensehost#accounts.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Accounts) MarshalJSON() ([]byte, error) {
- type noMethod Accounts
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdClient struct {
- // ArcOptIn: Whether this ad client is opted in to ARC.
- ArcOptIn bool `json:"arcOptIn,omitempty"`
-
- // Id: Unique identifier of this ad client.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adsensehost#adClient.
- Kind string `json:"kind,omitempty"`
-
- // ProductCode: This ad client's product code, which corresponds to the
- // PRODUCT_CODE report dimension.
- ProductCode string `json:"productCode,omitempty"`
-
- // SupportsReporting: Whether this ad client supports being reported on.
- SupportsReporting bool `json:"supportsReporting,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ArcOptIn") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdClient) MarshalJSON() ([]byte, error) {
- type noMethod AdClient
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdClients struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The ad clients returned in this list response.
- Items []*AdClient `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsensehost#adClients.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through ad clients. To
- // retrieve the next page of results, set the next request's "pageToken"
- // value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdClients) MarshalJSON() ([]byte, error) {
- type noMethod AdClients
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdCode struct {
- // AdCode: The ad code snippet.
- AdCode string `json:"adCode,omitempty"`
-
- // Kind: Kind this is, in this case adsensehost#adCode.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AdCode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdCode) MarshalJSON() ([]byte, error) {
- type noMethod AdCode
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdStyle struct {
- // Colors: The colors included in the style. These are represented as
- // six hexadecimal characters, similar to HTML color codes, but without
- // the leading hash.
- Colors *AdStyleColors `json:"colors,omitempty"`
-
- // Corners: The style of the corners in the ad. Possible values are
- // SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
- Corners string `json:"corners,omitempty"`
-
- // Font: The font which is included in the style.
- Font *AdStyleFont `json:"font,omitempty"`
-
- // Kind: Kind this is, in this case adsensehost#adStyle.
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Colors") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdStyle) MarshalJSON() ([]byte, error) {
- type noMethod AdStyle
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdStyleColors: The colors included in the style. These are
-// represented as six hexadecimal characters, similar to HTML color
-// codes, but without the leading hash.
-type AdStyleColors struct {
- // Background: The color of the ad background.
- Background string `json:"background,omitempty"`
-
- // Border: The color of the ad border.
- Border string `json:"border,omitempty"`
-
- // Text: The color of the ad text.
- Text string `json:"text,omitempty"`
-
- // Title: The color of the ad title.
- Title string `json:"title,omitempty"`
-
- // Url: The color of the ad url.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Background") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdStyleColors) MarshalJSON() ([]byte, error) {
- type noMethod AdStyleColors
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdStyleFont: The font which is included in the style.
-type AdStyleFont struct {
- // Family: The family of the font. Possible values are:
- // ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and
- // VERDANA.
- Family string `json:"family,omitempty"`
-
- // Size: The size of the font. Possible values are:
- // ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
- Size string `json:"size,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Family") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdStyleFont) MarshalJSON() ([]byte, error) {
- type noMethod AdStyleFont
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdUnit struct {
- // Code: Identity code of this ad unit, not necessarily unique across ad
- // clients.
- Code string `json:"code,omitempty"`
-
- // ContentAdsSettings: Settings specific to content ads (AFC) and
- // highend mobile content ads (AFMC).
- ContentAdsSettings *AdUnitContentAdsSettings `json:"contentAdsSettings,omitempty"`
-
- // CustomStyle: Custom style information specific to this ad unit.
- CustomStyle *AdStyle `json:"customStyle,omitempty"`
-
- // Id: Unique identifier of this ad unit. This should be considered an
- // opaque identifier; it is not safe to rely on it being in any
- // particular format.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adsensehost#adUnit.
- Kind string `json:"kind,omitempty"`
-
- // MobileContentAdsSettings: Settings specific to WAP mobile content ads
- // (AFMC).
- MobileContentAdsSettings *AdUnitMobileContentAdsSettings `json:"mobileContentAdsSettings,omitempty"`
-
- // Name: Name of this ad unit.
- Name string `json:"name,omitempty"`
-
- // Status: Status of this ad unit. Possible values are:
- // NEW: Indicates that the ad unit was created within the last seven
- // days and does not yet have any activity associated with it.
- //
- // ACTIVE: Indicates that there has been activity on this ad unit in the
- // last seven days.
- //
- // INACTIVE: Indicates that there has been no activity on this ad unit
- // in the last seven days.
- Status string `json:"status,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdUnit) MarshalJSON() ([]byte, error) {
- type noMethod AdUnit
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdUnitContentAdsSettings: Settings specific to content ads (AFC) and
-// highend mobile content ads (AFMC).
-type AdUnitContentAdsSettings struct {
- // BackupOption: The backup option to be used in instances where no ad
- // is available.
- BackupOption *AdUnitContentAdsSettingsBackupOption `json:"backupOption,omitempty"`
-
- // Size: Size of this ad unit. Size values are in the form
- // SIZE_{width}_{height}.
- Size string `json:"size,omitempty"`
-
- // Type: Type of this ad unit. Possible values are TEXT, TEXT_IMAGE,
- // IMAGE and LINK.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BackupOption") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdUnitContentAdsSettings) MarshalJSON() ([]byte, error) {
- type noMethod AdUnitContentAdsSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdUnitContentAdsSettingsBackupOption: The backup option to be used in
-// instances where no ad is available.
-type AdUnitContentAdsSettingsBackupOption struct {
- // Color: Color to use when type is set to COLOR. These are represented
- // as six hexadecimal characters, similar to HTML color codes, but
- // without the leading hash.
- Color string `json:"color,omitempty"`
-
- // Type: Type of the backup option. Possible values are BLANK, COLOR and
- // URL.
- Type string `json:"type,omitempty"`
-
- // Url: URL to use when type is set to URL.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Color") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdUnitContentAdsSettingsBackupOption) MarshalJSON() ([]byte, error) {
- type noMethod AdUnitContentAdsSettingsBackupOption
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdUnitMobileContentAdsSettings: Settings specific to WAP mobile
-// content ads (AFMC).
-type AdUnitMobileContentAdsSettings struct {
- // MarkupLanguage: The markup language to use for this ad unit.
- MarkupLanguage string `json:"markupLanguage,omitempty"`
-
- // ScriptingLanguage: The scripting language to use for this ad unit.
- ScriptingLanguage string `json:"scriptingLanguage,omitempty"`
-
- // Size: Size of this ad unit.
- Size string `json:"size,omitempty"`
-
- // Type: Type of this ad unit.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "MarkupLanguage") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdUnitMobileContentAdsSettings) MarshalJSON() ([]byte, error) {
- type noMethod AdUnitMobileContentAdsSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AdUnits struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The ad units returned in this list response.
- Items []*AdUnit `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsensehost#adUnits.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through ad units. To
- // retrieve the next page of results, set the next request's "pageToken"
- // value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdUnits) MarshalJSON() ([]byte, error) {
- type noMethod AdUnits
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AssociationSession struct {
- // AccountId: Hosted account id of the associated publisher after
- // association. Present if status is ACCEPTED.
- AccountId string `json:"accountId,omitempty"`
-
- // Id: Unique identifier of this association session.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case
- // adsensehost#associationSession.
- Kind string `json:"kind,omitempty"`
-
- // ProductCodes: The products to associate with the user. Options: AFC,
- // AFF, AFS, AFMC
- ProductCodes []string `json:"productCodes,omitempty"`
-
- // RedirectUrl: Redirect URL of this association session. Used to
- // redirect users into the AdSense association flow.
- RedirectUrl string `json:"redirectUrl,omitempty"`
-
- // Status: Status of the completed association, available once the
- // association callback token has been verified. One of ACCEPTED,
- // REJECTED, or ERROR.
- Status string `json:"status,omitempty"`
-
- // UserLocale: The preferred locale of the user themselves when going
- // through the AdSense association flow.
- UserLocale string `json:"userLocale,omitempty"`
-
- // WebsiteLocale: The locale of the user's hosted website.
- WebsiteLocale string `json:"websiteLocale,omitempty"`
-
- // WebsiteUrl: The URL of the user's hosted website.
- WebsiteUrl string `json:"websiteUrl,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AssociationSession) MarshalJSON() ([]byte, error) {
- type noMethod AssociationSession
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CustomChannel struct {
- // Code: Code of this custom channel, not necessarily unique across ad
- // clients.
- Code string `json:"code,omitempty"`
-
- // Id: Unique identifier of this custom channel. This should be
- // considered an opaque identifier; it is not safe to rely on it being
- // in any particular format.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case
- // adsensehost#customChannel.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this custom channel.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomChannel) MarshalJSON() ([]byte, error) {
- type noMethod CustomChannel
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CustomChannels struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The custom channels returned in this list response.
- Items []*CustomChannel `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsensehost#customChannels.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through custom
- // channels. To retrieve the next page of results, set the next
- // request's "pageToken" value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomChannels) MarshalJSON() ([]byte, error) {
- type noMethod CustomChannels
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Report struct {
- // Averages: The averages of the report. This is the same length as any
- // other row in the report; cells corresponding to dimension columns are
- // empty.
- Averages []string `json:"averages,omitempty"`
-
- // Headers: The header information of the columns requested in the
- // report. This is a list of headers; one for each dimension in the
- // request, followed by one for each metric in the request.
- Headers []*ReportHeaders `json:"headers,omitempty"`
-
- // Kind: Kind this is, in this case adsensehost#report.
- Kind string `json:"kind,omitempty"`
-
- // Rows: The output rows of the report. Each row is a list of cells; one
- // for each dimension in the request, followed by one for each metric in
- // the request. The dimension cells contain strings, and the metric
- // cells contain numbers.
- Rows [][]string `json:"rows,omitempty"`
-
- // TotalMatchedRows: The total number of rows matched by the report
- // request. Fewer rows may be returned in the response due to being
- // limited by the row count requested or the report row limit.
- TotalMatchedRows int64 `json:"totalMatchedRows,omitempty,string"`
-
- // Totals: The totals of the report. This is the same length as any
- // other row in the report; cells corresponding to dimension columns are
- // empty.
- Totals []string `json:"totals,omitempty"`
-
- // Warnings: Any warnings associated with generation of the report.
- Warnings []string `json:"warnings,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Averages") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Report) MarshalJSON() ([]byte, error) {
- type noMethod Report
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ReportHeaders struct {
- // Currency: The currency of this column. Only present if the header
- // type is METRIC_CURRENCY.
- Currency string `json:"currency,omitempty"`
-
- // Name: The name of the header.
- Name string `json:"name,omitempty"`
-
- // Type: The type of the header; one of DIMENSION, METRIC_TALLY,
- // METRIC_RATIO, or METRIC_CURRENCY.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Currency") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportHeaders) MarshalJSON() ([]byte, error) {
- type noMethod ReportHeaders
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UrlChannel struct {
- // Id: Unique identifier of this URL channel. This should be considered
- // an opaque identifier; it is not safe to rely on it being in any
- // particular format.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case adsensehost#urlChannel.
- Kind string `json:"kind,omitempty"`
-
- // UrlPattern: URL Pattern of this URL channel. Does not include
- // "http://" or "https://". Example: www.example.com/home
- UrlPattern string `json:"urlPattern,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlChannel) MarshalJSON() ([]byte, error) {
- type noMethod UrlChannel
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UrlChannels struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The URL channels returned in this list response.
- Items []*UrlChannel `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case adsensehost#urlChannels.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through URL channels.
- // To retrieve the next page of results, set the next request's
- // "pageToken" value to this.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlChannels) MarshalJSON() ([]byte, error) {
- type noMethod UrlChannels
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "adsensehost.accounts.get":
-
-type AccountsGetCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get information about the selected associated AdSense account.
-func (r *AccountsService) Get(accountId string) *AccountsGetCall {
- c := &AccountsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsGetCall) Fields(s ...googleapi.Field) *AccountsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsGetCall) IfNoneMatch(entityTag string) *AccountsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsGetCall) Context(ctx context.Context) *AccountsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsensehost.accounts.get" call.
-// Exactly one of *Account or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Account.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsGetCall) Do() (*Account, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Account{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get information about the selected associated AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsensehost.accounts.get",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account to get information about.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}",
- // "response": {
- // "$ref": "Account"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsensehost"
- // ]
- // }
-
-}
-
-// method id "adsensehost.accounts.list":
-
-type AccountsListCall struct {
- s *Service
- filterAdClientId []string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List hosted accounts associated with this AdSense account by ad
-// client id.
-func (r *AccountsService) List(filterAdClientId []string) *AccountsListCall {
- c := &AccountsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.filterAdClientId = filterAdClientId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsListCall) Fields(s ...googleapi.Field) *AccountsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsListCall) IfNoneMatch(entityTag string) *AccountsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsListCall) Context(ctx context.Context) *AccountsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- for _, v := range c.filterAdClientId {
- params.Add("filterAdClientId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsensehost.accounts.list" call.
-// Exactly one of *Accounts or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Accounts.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccountsListCall) Do() (*Accounts, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Accounts{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List hosted accounts associated with this AdSense account by ad client id.",
- // "httpMethod": "GET",
- // "id": "adsensehost.accounts.list",
- // "parameterOrder": [
- // "filterAdClientId"
- // ],
- // "parameters": {
- // "filterAdClientId": {
- // "description": "Ad clients to list accounts for.",
- // "location": "query",
- // "repeated": true,
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts",
- // "response": {
- // "$ref": "Accounts"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsensehost"
- // ]
- // }
-
-}
-
-// method id "adsensehost.accounts.adclients.get":
-
-type AccountsAdclientsGetCall struct {
- s *Service
- accountId string
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get information about one of the ad clients in the specified
-// publisher's AdSense account.
-func (r *AccountsAdclientsService) Get(accountId string, adClientId string) *AccountsAdclientsGetCall {
- c := &AccountsAdclientsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAdclientsGetCall) Fields(s ...googleapi.Field) *AccountsAdclientsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsAdclientsGetCall) IfNoneMatch(entityTag string) *AccountsAdclientsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAdclientsGetCall) Context(ctx context.Context) *AccountsAdclientsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAdclientsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsensehost.accounts.adclients.get" call.
-// Exactly one of *AdClient or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdClient.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccountsAdclientsGetCall) Do() (*AdClient, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdClient{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get information about one of the ad clients in the specified publisher's AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsensehost.accounts.adclients.get",
- // "parameterOrder": [
- // "accountId",
- // "adClientId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account which contains the ad client.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client to get.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}",
- // "response": {
- // "$ref": "AdClient"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsensehost"
- // ]
- // }
-
-}
-
-// method id "adsensehost.accounts.adclients.list":
-
-type AccountsAdclientsListCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all hosted ad clients in the specified hosted account.
-func (r *AccountsAdclientsService) List(accountId string) *AccountsAdclientsListCall {
- c := &AccountsAdclientsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of ad clients to include in the response, used for paging.
-func (c *AccountsAdclientsListCall) MaxResults(maxResults int64) *AccountsAdclientsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad clients. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AccountsAdclientsListCall) PageToken(pageToken string) *AccountsAdclientsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAdclientsListCall) Fields(s ...googleapi.Field) *AccountsAdclientsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsAdclientsListCall) IfNoneMatch(entityTag string) *AccountsAdclientsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAdclientsListCall) Context(ctx context.Context) *AccountsAdclientsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAdclientsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsensehost.accounts.adclients.list" call.
-// Exactly one of *AdClients or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AdClients.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccountsAdclientsListCall) Do() (*AdClients, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdClients{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all hosted ad clients in the specified hosted account.",
- // "httpMethod": "GET",
- // "id": "adsensehost.accounts.adclients.list",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account for which to list ad clients.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of ad clients to include in the response, used for paging.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients",
- // "response": {
- // "$ref": "AdClients"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsensehost"
- // ]
- // }
-
-}
-
-// method id "adsensehost.accounts.adunits.delete":
-
-type AccountsAdunitsDeleteCall struct {
- s *Service
- accountId string
- adClientId string
- adUnitId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Delete the specified ad unit from the specified publisher
-// AdSense account.
-func (r *AccountsAdunitsService) Delete(accountId string, adClientId string, adUnitId string) *AccountsAdunitsDeleteCall {
- c := &AccountsAdunitsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- c.adUnitId = adUnitId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAdunitsDeleteCall) Fields(s ...googleapi.Field) *AccountsAdunitsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAdunitsDeleteCall) Context(ctx context.Context) *AccountsAdunitsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAdunitsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- "adUnitId": c.adUnitId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsensehost.accounts.adunits.delete" call.
-// Exactly one of *AdUnit or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnit.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsAdunitsDeleteCall) Do() (*AdUnit, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnit{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Delete the specified ad unit from the specified publisher AdSense account.",
- // "httpMethod": "DELETE",
- // "id": "adsensehost.accounts.adunits.delete",
- // "parameterOrder": [
- // "accountId",
- // "adClientId",
- // "adUnitId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account which contains the ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client for which to get ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adUnitId": {
- // "description": "Ad unit to delete.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}",
- // "response": {
- // "$ref": "AdUnit"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsensehost"
- // ]
- // }
-
-}
-
-// method id "adsensehost.accounts.adunits.get":
-
-type AccountsAdunitsGetCall struct {
- s *Service
- accountId string
- adClientId string
- adUnitId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get the specified host ad unit in this AdSense account.
-func (r *AccountsAdunitsService) Get(accountId string, adClientId string, adUnitId string) *AccountsAdunitsGetCall {
- c := &AccountsAdunitsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- c.adUnitId = adUnitId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAdunitsGetCall) Fields(s ...googleapi.Field) *AccountsAdunitsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsAdunitsGetCall) IfNoneMatch(entityTag string) *AccountsAdunitsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAdunitsGetCall) Context(ctx context.Context) *AccountsAdunitsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAdunitsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- "adUnitId": c.adUnitId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsensehost.accounts.adunits.get" call.
-// Exactly one of *AdUnit or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnit.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsAdunitsGetCall) Do() (*AdUnit, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnit{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get the specified host ad unit in this AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsensehost.accounts.adunits.get",
- // "parameterOrder": [
- // "accountId",
- // "adClientId",
- // "adUnitId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account which contains the ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client for which to get ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adUnitId": {
- // "description": "Ad unit to get.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}",
- // "response": {
- // "$ref": "AdUnit"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsensehost"
- // ]
- // }
-
-}
-
-// method id "adsensehost.accounts.adunits.getAdCode":
-
-type AccountsAdunitsGetAdCodeCall struct {
- s *Service
- accountId string
- adClientId string
- adUnitId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetAdCode: Get ad code for the specified ad unit, attaching the
-// specified host custom channels.
-func (r *AccountsAdunitsService) GetAdCode(accountId string, adClientId string, adUnitId string) *AccountsAdunitsGetAdCodeCall {
- c := &AccountsAdunitsGetAdCodeCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- c.adUnitId = adUnitId
- return c
-}
-
-// HostCustomChannelId sets the optional parameter
-// "hostCustomChannelId": Host custom channel to attach to the ad code.
-func (c *AccountsAdunitsGetAdCodeCall) HostCustomChannelId(hostCustomChannelId string) *AccountsAdunitsGetAdCodeCall {
- c.opt_["hostCustomChannelId"] = hostCustomChannelId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAdunitsGetAdCodeCall) Fields(s ...googleapi.Field) *AccountsAdunitsGetAdCodeCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsAdunitsGetAdCodeCall) IfNoneMatch(entityTag string) *AccountsAdunitsGetAdCodeCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAdunitsGetAdCodeCall) Context(ctx context.Context) *AccountsAdunitsGetAdCodeCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAdunitsGetAdCodeCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["hostCustomChannelId"]; ok {
- params.Set("hostCustomChannelId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/adcode")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- "adUnitId": c.adUnitId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsensehost.accounts.adunits.getAdCode" call.
-// Exactly one of *AdCode or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdCode.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsAdunitsGetAdCodeCall) Do() (*AdCode, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdCode{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get ad code for the specified ad unit, attaching the specified host custom channels.",
- // "httpMethod": "GET",
- // "id": "adsensehost.accounts.adunits.getAdCode",
- // "parameterOrder": [
- // "accountId",
- // "adClientId",
- // "adUnitId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account which contains the ad client.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client with contains the ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adUnitId": {
- // "description": "Ad unit to get the code for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "hostCustomChannelId": {
- // "description": "Host custom channel to attach to the ad code.",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/adcode",
- // "response": {
- // "$ref": "AdCode"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsensehost"
- // ]
- // }
-
-}
-
-// method id "adsensehost.accounts.adunits.insert":
-
-type AccountsAdunitsInsertCall struct {
- s *Service
- accountId string
- adClientId string
- adunit *AdUnit
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Insert the supplied ad unit into the specified publisher
-// AdSense account.
-func (r *AccountsAdunitsService) Insert(accountId string, adClientId string, adunit *AdUnit) *AccountsAdunitsInsertCall {
- c := &AccountsAdunitsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- c.adunit = adunit
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAdunitsInsertCall) Fields(s ...googleapi.Field) *AccountsAdunitsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAdunitsInsertCall) Context(ctx context.Context) *AccountsAdunitsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAdunitsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.adunit)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/adunits")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsensehost.accounts.adunits.insert" call.
-// Exactly one of *AdUnit or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnit.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsAdunitsInsertCall) Do() (*AdUnit, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnit{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Insert the supplied ad unit into the specified publisher AdSense account.",
- // "httpMethod": "POST",
- // "id": "adsensehost.accounts.adunits.insert",
- // "parameterOrder": [
- // "accountId",
- // "adClientId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account which will contain the ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client into which to insert the ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
- // "request": {
- // "$ref": "AdUnit"
- // },
- // "response": {
- // "$ref": "AdUnit"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsensehost"
- // ]
- // }
-
-}
-
-// method id "adsensehost.accounts.adunits.list":
-
-type AccountsAdunitsListCall struct {
- s *Service
- accountId string
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all ad units in the specified publisher's AdSense account.
-func (r *AccountsAdunitsService) List(accountId string, adClientId string) *AccountsAdunitsListCall {
- c := &AccountsAdunitsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- return c
-}
-
-// IncludeInactive sets the optional parameter "includeInactive":
-// Whether to include inactive ad units. Default: true.
-func (c *AccountsAdunitsListCall) IncludeInactive(includeInactive bool) *AccountsAdunitsListCall {
- c.opt_["includeInactive"] = includeInactive
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of ad units to include in the response, used for paging.
-func (c *AccountsAdunitsListCall) MaxResults(maxResults int64) *AccountsAdunitsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad units. To retrieve the next page, set
-// this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AccountsAdunitsListCall) PageToken(pageToken string) *AccountsAdunitsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAdunitsListCall) Fields(s ...googleapi.Field) *AccountsAdunitsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsAdunitsListCall) IfNoneMatch(entityTag string) *AccountsAdunitsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAdunitsListCall) Context(ctx context.Context) *AccountsAdunitsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAdunitsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["includeInactive"]; ok {
- params.Set("includeInactive", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/adunits")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsensehost.accounts.adunits.list" call.
-// Exactly one of *AdUnits or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnits.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsAdunitsListCall) Do() (*AdUnits, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnits{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all ad units in the specified publisher's AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsensehost.accounts.adunits.list",
- // "parameterOrder": [
- // "accountId",
- // "adClientId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account which contains the ad client.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client for which to list ad units.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "includeInactive": {
- // "description": "Whether to include inactive ad units. Default: true.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "The maximum number of ad units to include in the response, used for paging.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
- // "response": {
- // "$ref": "AdUnits"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsensehost"
- // ]
- // }
-
-}
-
-// method id "adsensehost.accounts.adunits.patch":
-
-type AccountsAdunitsPatchCall struct {
- s *Service
- accountId string
- adClientId string
- adUnitId string
- adunit *AdUnit
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Update the supplied ad unit in the specified publisher AdSense
-// account. This method supports patch semantics.
-func (r *AccountsAdunitsService) Patch(accountId string, adClientId string, adUnitId string, adunit *AdUnit) *AccountsAdunitsPatchCall {
- c := &AccountsAdunitsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- c.adUnitId = adUnitId
- c.adunit = adunit
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAdunitsPatchCall) Fields(s ...googleapi.Field) *AccountsAdunitsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAdunitsPatchCall) Context(ctx context.Context) *AccountsAdunitsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAdunitsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.adunit)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("adUnitId", fmt.Sprintf("%v", c.adUnitId))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/adunits")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsensehost.accounts.adunits.patch" call.
-// Exactly one of *AdUnit or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnit.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsAdunitsPatchCall) Do() (*AdUnit, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnit{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update the supplied ad unit in the specified publisher AdSense account. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "adsensehost.accounts.adunits.patch",
- // "parameterOrder": [
- // "accountId",
- // "adClientId",
- // "adUnitId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account which contains the ad client.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client which contains the ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adUnitId": {
- // "description": "Ad unit to get.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
- // "request": {
- // "$ref": "AdUnit"
- // },
- // "response": {
- // "$ref": "AdUnit"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsensehost"
- // ]
- // }
-
-}
-
-// method id "adsensehost.accounts.adunits.update":
-
-type AccountsAdunitsUpdateCall struct {
- s *Service
- accountId string
- adClientId string
- adunit *AdUnit
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Update the supplied ad unit in the specified publisher
-// AdSense account.
-func (r *AccountsAdunitsService) Update(accountId string, adClientId string, adunit *AdUnit) *AccountsAdunitsUpdateCall {
- c := &AccountsAdunitsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.adClientId = adClientId
- c.adunit = adunit
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAdunitsUpdateCall) Fields(s ...googleapi.Field) *AccountsAdunitsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAdunitsUpdateCall) Context(ctx context.Context) *AccountsAdunitsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAdunitsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.adunit)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/adclients/{adClientId}/adunits")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "adClientId": c.adClientId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsensehost.accounts.adunits.update" call.
-// Exactly one of *AdUnit or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdUnit.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsAdunitsUpdateCall) Do() (*AdUnit, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdUnit{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update the supplied ad unit in the specified publisher AdSense account.",
- // "httpMethod": "PUT",
- // "id": "adsensehost.accounts.adunits.update",
- // "parameterOrder": [
- // "accountId",
- // "adClientId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account which contains the ad client.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "adClientId": {
- // "description": "Ad client which contains the ad unit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "accounts/{accountId}/adclients/{adClientId}/adunits",
- // "request": {
- // "$ref": "AdUnit"
- // },
- // "response": {
- // "$ref": "AdUnit"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsensehost"
- // ]
- // }
-
-}
-
-// method id "adsensehost.accounts.reports.generate":
-
-type AccountsReportsGenerateCall struct {
- s *Service
- accountId string
- startDate string
- endDate string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Generate: Generate an AdSense report based on the report request sent
-// in the query parameters. Returns the result as JSON; to retrieve
-// output in CSV format specify "alt=csv" as a query parameter.
-func (r *AccountsReportsService) Generate(accountId string, startDate string, endDate string) *AccountsReportsGenerateCall {
- c := &AccountsReportsGenerateCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.startDate = startDate
- c.endDate = endDate
- return c
-}
-
-// Dimension sets the optional parameter "dimension": Dimensions to base
-// the report on.
-func (c *AccountsReportsGenerateCall) Dimension(dimension string) *AccountsReportsGenerateCall {
- c.opt_["dimension"] = dimension
- return c
-}
-
-// Filter sets the optional parameter "filter": Filters to be run on the
-// report.
-func (c *AccountsReportsGenerateCall) Filter(filter string) *AccountsReportsGenerateCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// Locale sets the optional parameter "locale": Optional locale to use
-// for translating report output to a local language. Defaults to
-// "en_US" if not specified.
-func (c *AccountsReportsGenerateCall) Locale(locale string) *AccountsReportsGenerateCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of rows of report data to return.
-func (c *AccountsReportsGenerateCall) MaxResults(maxResults int64) *AccountsReportsGenerateCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// Metric sets the optional parameter "metric": Numeric columns to
-// include in the report.
-func (c *AccountsReportsGenerateCall) Metric(metric string) *AccountsReportsGenerateCall {
- c.opt_["metric"] = metric
- return c
-}
-
-// Sort sets the optional parameter "sort": The name of a dimension or
-// metric to sort the resulting report on, optionally prefixed with "+"
-// to sort ascending or "-" to sort descending. If no prefix is
-// specified, the column is sorted ascending.
-func (c *AccountsReportsGenerateCall) Sort(sort string) *AccountsReportsGenerateCall {
- c.opt_["sort"] = sort
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex": Index of the
-// first row of report data to return.
-func (c *AccountsReportsGenerateCall) StartIndex(startIndex int64) *AccountsReportsGenerateCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsReportsGenerateCall) Fields(s ...googleapi.Field) *AccountsReportsGenerateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsReportsGenerateCall) IfNoneMatch(entityTag string) *AccountsReportsGenerateCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsReportsGenerateCall) Context(ctx context.Context) *AccountsReportsGenerateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsReportsGenerateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("endDate", fmt.Sprintf("%v", c.endDate))
- params.Set("startDate", fmt.Sprintf("%v", c.startDate))
- if v, ok := c.opt_["dimension"]; ok {
- params.Set("dimension", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["metric"]; ok {
- params.Set("metric", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sort"]; ok {
- params.Set("sort", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/{accountId}/reports")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsensehost.accounts.reports.generate" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsReportsGenerateCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
- // "httpMethod": "GET",
- // "id": "adsensehost.accounts.reports.generate",
- // "parameterOrder": [
- // "accountId",
- // "startDate",
- // "endDate"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Hosted account upon which to report.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "dimension": {
- // "description": "Dimensions to base the report on.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "endDate": {
- // "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- // "location": "query",
- // "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- // "required": true,
- // "type": "string"
- // },
- // "filter": {
- // "description": "Filters to be run on the report.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+(==|=@).+",
- // "repeated": true,
- // "type": "string"
- // },
- // "locale": {
- // "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of rows of report data to return.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "50000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "metric": {
- // "description": "Numeric columns to include in the report.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "sort": {
- // "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
- // "location": "query",
- // "pattern": "(\\+|-)?[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "startDate": {
- // "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- // "location": "query",
- // "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- // "required": true,
- // "type": "string"
- // },
- // "startIndex": {
- // "description": "Index of the first row of report data to return.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "5000",
- // "minimum": "0",
- // "type": "integer"
- // }
- // },
- // "path": "accounts/{accountId}/reports",
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsensehost"
- // ]
- // }
-
-}
-
-// method id "adsensehost.adclients.get":
-
-type AdclientsGetCall struct {
- s *Service
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get information about one of the ad clients in the Host AdSense
-// account.
-func (r *AdclientsService) Get(adClientId string) *AdclientsGetCall {
- c := &AdclientsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdclientsGetCall) Fields(s ...googleapi.Field) *AdclientsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdclientsGetCall) IfNoneMatch(entityTag string) *AdclientsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdclientsGetCall) Context(ctx context.Context) *AdclientsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdclientsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsensehost.adclients.get" call.
-// Exactly one of *AdClient or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AdClient.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AdclientsGetCall) Do() (*AdClient, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdClient{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get information about one of the ad clients in the Host AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsensehost.adclients.get",
- // "parameterOrder": [
- // "adClientId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client to get.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}",
- // "response": {
- // "$ref": "AdClient"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsensehost"
- // ]
- // }
-
-}
-
-// method id "adsensehost.adclients.list":
-
-type AdclientsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all host ad clients in this AdSense account.
-func (r *AdclientsService) List() *AdclientsListCall {
- c := &AdclientsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of ad clients to include in the response, used for paging.
-func (c *AdclientsListCall) MaxResults(maxResults int64) *AdclientsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through ad clients. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *AdclientsListCall) PageToken(pageToken string) *AdclientsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdclientsListCall) Fields(s ...googleapi.Field) *AdclientsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdclientsListCall) IfNoneMatch(entityTag string) *AdclientsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdclientsListCall) Context(ctx context.Context) *AdclientsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdclientsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsensehost.adclients.list" call.
-// Exactly one of *AdClients or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AdClients.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AdclientsListCall) Do() (*AdClients, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdClients{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all host ad clients in this AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsensehost.adclients.list",
- // "parameters": {
- // "maxResults": {
- // "description": "The maximum number of ad clients to include in the response, used for paging.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients",
- // "response": {
- // "$ref": "AdClients"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsensehost"
- // ]
- // }
-
-}
-
-// method id "adsensehost.associationsessions.start":
-
-type AssociationsessionsStartCall struct {
- s *Service
- productCode []string
- websiteUrl string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Start: Create an association session for initiating an association
-// with an AdSense user.
-func (r *AssociationsessionsService) Start(productCode []string, websiteUrl string) *AssociationsessionsStartCall {
- c := &AssociationsessionsStartCall{s: r.s, opt_: make(map[string]interface{})}
- c.productCode = productCode
- c.websiteUrl = websiteUrl
- return c
-}
-
-// UserLocale sets the optional parameter "userLocale": The preferred
-// locale of the user.
-func (c *AssociationsessionsStartCall) UserLocale(userLocale string) *AssociationsessionsStartCall {
- c.opt_["userLocale"] = userLocale
- return c
-}
-
-// WebsiteLocale sets the optional parameter "websiteLocale": The locale
-// of the user's hosted website.
-func (c *AssociationsessionsStartCall) WebsiteLocale(websiteLocale string) *AssociationsessionsStartCall {
- c.opt_["websiteLocale"] = websiteLocale
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AssociationsessionsStartCall) Fields(s ...googleapi.Field) *AssociationsessionsStartCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AssociationsessionsStartCall) IfNoneMatch(entityTag string) *AssociationsessionsStartCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AssociationsessionsStartCall) Context(ctx context.Context) *AssociationsessionsStartCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AssociationsessionsStartCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("websiteUrl", fmt.Sprintf("%v", c.websiteUrl))
- for _, v := range c.productCode {
- params.Add("productCode", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["userLocale"]; ok {
- params.Set("userLocale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["websiteLocale"]; ok {
- params.Set("websiteLocale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "associationsessions/start")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsensehost.associationsessions.start" call.
-// Exactly one of *AssociationSession or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AssociationSession.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AssociationsessionsStartCall) Do() (*AssociationSession, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AssociationSession{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Create an association session for initiating an association with an AdSense user.",
- // "httpMethod": "GET",
- // "id": "adsensehost.associationsessions.start",
- // "parameterOrder": [
- // "productCode",
- // "websiteUrl"
- // ],
- // "parameters": {
- // "productCode": {
- // "description": "Products to associate with the user.",
- // "enum": [
- // "AFC",
- // "AFG",
- // "AFMC",
- // "AFS",
- // "AFV"
- // ],
- // "enumDescriptions": [
- // "AdSense For Content",
- // "AdSense For Games",
- // "AdSense For Mobile Content",
- // "AdSense For Search",
- // "AdSense For Video"
- // ],
- // "location": "query",
- // "repeated": true,
- // "required": true,
- // "type": "string"
- // },
- // "userLocale": {
- // "description": "The preferred locale of the user.",
- // "location": "query",
- // "type": "string"
- // },
- // "websiteLocale": {
- // "description": "The locale of the user's hosted website.",
- // "location": "query",
- // "type": "string"
- // },
- // "websiteUrl": {
- // "description": "The URL of the user's hosted website.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "associationsessions/start",
- // "response": {
- // "$ref": "AssociationSession"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsensehost"
- // ]
- // }
-
-}
-
-// method id "adsensehost.associationsessions.verify":
-
-type AssociationsessionsVerifyCall struct {
- s *Service
- token string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Verify: Verify an association session after the association callback
-// returns from AdSense signup.
-func (r *AssociationsessionsService) Verify(token string) *AssociationsessionsVerifyCall {
- c := &AssociationsessionsVerifyCall{s: r.s, opt_: make(map[string]interface{})}
- c.token = token
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AssociationsessionsVerifyCall) Fields(s ...googleapi.Field) *AssociationsessionsVerifyCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AssociationsessionsVerifyCall) IfNoneMatch(entityTag string) *AssociationsessionsVerifyCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AssociationsessionsVerifyCall) Context(ctx context.Context) *AssociationsessionsVerifyCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AssociationsessionsVerifyCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("token", fmt.Sprintf("%v", c.token))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "associationsessions/verify")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsensehost.associationsessions.verify" call.
-// Exactly one of *AssociationSession or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AssociationSession.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AssociationsessionsVerifyCall) Do() (*AssociationSession, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AssociationSession{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Verify an association session after the association callback returns from AdSense signup.",
- // "httpMethod": "GET",
- // "id": "adsensehost.associationsessions.verify",
- // "parameterOrder": [
- // "token"
- // ],
- // "parameters": {
- // "token": {
- // "description": "The token returned to the association callback URL.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "associationsessions/verify",
- // "response": {
- // "$ref": "AssociationSession"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsensehost"
- // ]
- // }
-
-}
-
-// method id "adsensehost.customchannels.delete":
-
-type CustomchannelsDeleteCall struct {
- s *Service
- adClientId string
- customChannelId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Delete a specific custom channel from the host AdSense
-// account.
-func (r *CustomchannelsService) Delete(adClientId string, customChannelId string) *CustomchannelsDeleteCall {
- c := &CustomchannelsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.customChannelId = customChannelId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CustomchannelsDeleteCall) Fields(s ...googleapi.Field) *CustomchannelsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CustomchannelsDeleteCall) Context(ctx context.Context) *CustomchannelsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CustomchannelsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/customchannels/{customChannelId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- "customChannelId": c.customChannelId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsensehost.customchannels.delete" call.
-// Exactly one of *CustomChannel or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannel.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CustomchannelsDeleteCall) Do() (*CustomChannel, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannel{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Delete a specific custom channel from the host AdSense account.",
- // "httpMethod": "DELETE",
- // "id": "adsensehost.customchannels.delete",
- // "parameterOrder": [
- // "adClientId",
- // "customChannelId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client from which to delete the custom channel.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "customChannelId": {
- // "description": "Custom channel to delete.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/customchannels/{customChannelId}",
- // "response": {
- // "$ref": "CustomChannel"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsensehost"
- // ]
- // }
-
-}
-
-// method id "adsensehost.customchannels.get":
-
-type CustomchannelsGetCall struct {
- s *Service
- adClientId string
- customChannelId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get a specific custom channel from the host AdSense account.
-func (r *CustomchannelsService) Get(adClientId string, customChannelId string) *CustomchannelsGetCall {
- c := &CustomchannelsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.customChannelId = customChannelId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CustomchannelsGetCall) Fields(s ...googleapi.Field) *CustomchannelsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CustomchannelsGetCall) IfNoneMatch(entityTag string) *CustomchannelsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CustomchannelsGetCall) Context(ctx context.Context) *CustomchannelsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CustomchannelsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/customchannels/{customChannelId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- "customChannelId": c.customChannelId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsensehost.customchannels.get" call.
-// Exactly one of *CustomChannel or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannel.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CustomchannelsGetCall) Do() (*CustomChannel, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannel{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get a specific custom channel from the host AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsensehost.customchannels.get",
- // "parameterOrder": [
- // "adClientId",
- // "customChannelId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client from which to get the custom channel.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "customChannelId": {
- // "description": "Custom channel to get.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/customchannels/{customChannelId}",
- // "response": {
- // "$ref": "CustomChannel"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsensehost"
- // ]
- // }
-
-}
-
-// method id "adsensehost.customchannels.insert":
-
-type CustomchannelsInsertCall struct {
- s *Service
- adClientId string
- customchannel *CustomChannel
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Add a new custom channel to the host AdSense account.
-func (r *CustomchannelsService) Insert(adClientId string, customchannel *CustomChannel) *CustomchannelsInsertCall {
- c := &CustomchannelsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.customchannel = customchannel
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CustomchannelsInsertCall) Fields(s ...googleapi.Field) *CustomchannelsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CustomchannelsInsertCall) Context(ctx context.Context) *CustomchannelsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CustomchannelsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.customchannel)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/customchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsensehost.customchannels.insert" call.
-// Exactly one of *CustomChannel or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannel.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CustomchannelsInsertCall) Do() (*CustomChannel, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannel{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Add a new custom channel to the host AdSense account.",
- // "httpMethod": "POST",
- // "id": "adsensehost.customchannels.insert",
- // "parameterOrder": [
- // "adClientId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client to which the new custom channel will be added.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/customchannels",
- // "request": {
- // "$ref": "CustomChannel"
- // },
- // "response": {
- // "$ref": "CustomChannel"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsensehost"
- // ]
- // }
-
-}
-
-// method id "adsensehost.customchannels.list":
-
-type CustomchannelsListCall struct {
- s *Service
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all host custom channels in this AdSense account.
-func (r *CustomchannelsService) List(adClientId string) *CustomchannelsListCall {
- c := &CustomchannelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of custom channels to include in the response, used for
-// paging.
-func (c *CustomchannelsListCall) MaxResults(maxResults int64) *CustomchannelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through custom channels. To retrieve the next
-// page, set this parameter to the value of "nextPageToken" from the
-// previous response.
-func (c *CustomchannelsListCall) PageToken(pageToken string) *CustomchannelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CustomchannelsListCall) Fields(s ...googleapi.Field) *CustomchannelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CustomchannelsListCall) IfNoneMatch(entityTag string) *CustomchannelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CustomchannelsListCall) Context(ctx context.Context) *CustomchannelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CustomchannelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/customchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsensehost.customchannels.list" call.
-// Exactly one of *CustomChannels or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannels.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CustomchannelsListCall) Do() (*CustomChannels, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannels{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all host custom channels in this AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsensehost.customchannels.list",
- // "parameterOrder": [
- // "adClientId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client for which to list custom channels.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of custom channels to include in the response, used for paging.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/customchannels",
- // "response": {
- // "$ref": "CustomChannels"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsensehost"
- // ]
- // }
-
-}
-
-// method id "adsensehost.customchannels.patch":
-
-type CustomchannelsPatchCall struct {
- s *Service
- adClientId string
- customChannelId string
- customchannel *CustomChannel
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Update a custom channel in the host AdSense account. This
-// method supports patch semantics.
-func (r *CustomchannelsService) Patch(adClientId string, customChannelId string, customchannel *CustomChannel) *CustomchannelsPatchCall {
- c := &CustomchannelsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.customChannelId = customChannelId
- c.customchannel = customchannel
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CustomchannelsPatchCall) Fields(s ...googleapi.Field) *CustomchannelsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CustomchannelsPatchCall) Context(ctx context.Context) *CustomchannelsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CustomchannelsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.customchannel)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("customChannelId", fmt.Sprintf("%v", c.customChannelId))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/customchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsensehost.customchannels.patch" call.
-// Exactly one of *CustomChannel or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannel.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CustomchannelsPatchCall) Do() (*CustomChannel, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannel{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update a custom channel in the host AdSense account. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "adsensehost.customchannels.patch",
- // "parameterOrder": [
- // "adClientId",
- // "customChannelId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client in which the custom channel will be updated.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "customChannelId": {
- // "description": "Custom channel to get.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/customchannels",
- // "request": {
- // "$ref": "CustomChannel"
- // },
- // "response": {
- // "$ref": "CustomChannel"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsensehost"
- // ]
- // }
-
-}
-
-// method id "adsensehost.customchannels.update":
-
-type CustomchannelsUpdateCall struct {
- s *Service
- adClientId string
- customchannel *CustomChannel
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Update a custom channel in the host AdSense account.
-func (r *CustomchannelsService) Update(adClientId string, customchannel *CustomChannel) *CustomchannelsUpdateCall {
- c := &CustomchannelsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.customchannel = customchannel
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CustomchannelsUpdateCall) Fields(s ...googleapi.Field) *CustomchannelsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CustomchannelsUpdateCall) Context(ctx context.Context) *CustomchannelsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CustomchannelsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.customchannel)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/customchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsensehost.customchannels.update" call.
-// Exactly one of *CustomChannel or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomChannel.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CustomchannelsUpdateCall) Do() (*CustomChannel, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomChannel{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update a custom channel in the host AdSense account.",
- // "httpMethod": "PUT",
- // "id": "adsensehost.customchannels.update",
- // "parameterOrder": [
- // "adClientId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client in which the custom channel will be updated.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/customchannels",
- // "request": {
- // "$ref": "CustomChannel"
- // },
- // "response": {
- // "$ref": "CustomChannel"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsensehost"
- // ]
- // }
-
-}
-
-// method id "adsensehost.reports.generate":
-
-type ReportsGenerateCall struct {
- s *Service
- startDate string
- endDate string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Generate: Generate an AdSense report based on the report request sent
-// in the query parameters. Returns the result as JSON; to retrieve
-// output in CSV format specify "alt=csv" as a query parameter.
-func (r *ReportsService) Generate(startDate string, endDate string) *ReportsGenerateCall {
- c := &ReportsGenerateCall{s: r.s, opt_: make(map[string]interface{})}
- c.startDate = startDate
- c.endDate = endDate
- return c
-}
-
-// Dimension sets the optional parameter "dimension": Dimensions to base
-// the report on.
-func (c *ReportsGenerateCall) Dimension(dimension string) *ReportsGenerateCall {
- c.opt_["dimension"] = dimension
- return c
-}
-
-// Filter sets the optional parameter "filter": Filters to be run on the
-// report.
-func (c *ReportsGenerateCall) Filter(filter string) *ReportsGenerateCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// Locale sets the optional parameter "locale": Optional locale to use
-// for translating report output to a local language. Defaults to
-// "en_US" if not specified.
-func (c *ReportsGenerateCall) Locale(locale string) *ReportsGenerateCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of rows of report data to return.
-func (c *ReportsGenerateCall) MaxResults(maxResults int64) *ReportsGenerateCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// Metric sets the optional parameter "metric": Numeric columns to
-// include in the report.
-func (c *ReportsGenerateCall) Metric(metric string) *ReportsGenerateCall {
- c.opt_["metric"] = metric
- return c
-}
-
-// Sort sets the optional parameter "sort": The name of a dimension or
-// metric to sort the resulting report on, optionally prefixed with "+"
-// to sort ascending or "-" to sort descending. If no prefix is
-// specified, the column is sorted ascending.
-func (c *ReportsGenerateCall) Sort(sort string) *ReportsGenerateCall {
- c.opt_["sort"] = sort
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex": Index of the
-// first row of report data to return.
-func (c *ReportsGenerateCall) StartIndex(startIndex int64) *ReportsGenerateCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsGenerateCall) Fields(s ...googleapi.Field) *ReportsGenerateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsGenerateCall) IfNoneMatch(entityTag string) *ReportsGenerateCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsGenerateCall) Context(ctx context.Context) *ReportsGenerateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsGenerateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("endDate", fmt.Sprintf("%v", c.endDate))
- params.Set("startDate", fmt.Sprintf("%v", c.startDate))
- if v, ok := c.opt_["dimension"]; ok {
- params.Set("dimension", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["metric"]; ok {
- params.Set("metric", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sort"]; ok {
- params.Set("sort", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "reports")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsensehost.reports.generate" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsGenerateCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
- // "httpMethod": "GET",
- // "id": "adsensehost.reports.generate",
- // "parameterOrder": [
- // "startDate",
- // "endDate"
- // ],
- // "parameters": {
- // "dimension": {
- // "description": "Dimensions to base the report on.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "endDate": {
- // "description": "End of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- // "location": "query",
- // "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- // "required": true,
- // "type": "string"
- // },
- // "filter": {
- // "description": "Filters to be run on the report.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+(==|=@).+",
- // "repeated": true,
- // "type": "string"
- // },
- // "locale": {
- // "description": "Optional locale to use for translating report output to a local language. Defaults to \"en_US\" if not specified.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of rows of report data to return.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "50000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "metric": {
- // "description": "Numeric columns to include in the report.",
- // "location": "query",
- // "pattern": "[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "sort": {
- // "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.",
- // "location": "query",
- // "pattern": "(\\+|-)?[a-zA-Z_]+",
- // "repeated": true,
- // "type": "string"
- // },
- // "startDate": {
- // "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
- // "location": "query",
- // "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
- // "required": true,
- // "type": "string"
- // },
- // "startIndex": {
- // "description": "Index of the first row of report data to return.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "5000",
- // "minimum": "0",
- // "type": "integer"
- // }
- // },
- // "path": "reports",
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsensehost"
- // ]
- // }
-
-}
-
-// method id "adsensehost.urlchannels.delete":
-
-type UrlchannelsDeleteCall struct {
- s *Service
- adClientId string
- urlChannelId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Delete a URL channel from the host AdSense account.
-func (r *UrlchannelsService) Delete(adClientId string, urlChannelId string) *UrlchannelsDeleteCall {
- c := &UrlchannelsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.urlChannelId = urlChannelId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UrlchannelsDeleteCall) Fields(s ...googleapi.Field) *UrlchannelsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UrlchannelsDeleteCall) Context(ctx context.Context) *UrlchannelsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UrlchannelsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/urlchannels/{urlChannelId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- "urlChannelId": c.urlChannelId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsensehost.urlchannels.delete" call.
-// Exactly one of *UrlChannel or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UrlChannel.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UrlchannelsDeleteCall) Do() (*UrlChannel, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UrlChannel{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Delete a URL channel from the host AdSense account.",
- // "httpMethod": "DELETE",
- // "id": "adsensehost.urlchannels.delete",
- // "parameterOrder": [
- // "adClientId",
- // "urlChannelId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client from which to delete the URL channel.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "urlChannelId": {
- // "description": "URL channel to delete.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/urlchannels/{urlChannelId}",
- // "response": {
- // "$ref": "UrlChannel"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsensehost"
- // ]
- // }
-
-}
-
-// method id "adsensehost.urlchannels.insert":
-
-type UrlchannelsInsertCall struct {
- s *Service
- adClientId string
- urlchannel *UrlChannel
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Add a new URL channel to the host AdSense account.
-func (r *UrlchannelsService) Insert(adClientId string, urlchannel *UrlChannel) *UrlchannelsInsertCall {
- c := &UrlchannelsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- c.urlchannel = urlchannel
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UrlchannelsInsertCall) Fields(s ...googleapi.Field) *UrlchannelsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UrlchannelsInsertCall) Context(ctx context.Context) *UrlchannelsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UrlchannelsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.urlchannel)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/urlchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsensehost.urlchannels.insert" call.
-// Exactly one of *UrlChannel or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UrlChannel.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UrlchannelsInsertCall) Do() (*UrlChannel, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UrlChannel{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Add a new URL channel to the host AdSense account.",
- // "httpMethod": "POST",
- // "id": "adsensehost.urlchannels.insert",
- // "parameterOrder": [
- // "adClientId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client to which the new URL channel will be added.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/urlchannels",
- // "request": {
- // "$ref": "UrlChannel"
- // },
- // "response": {
- // "$ref": "UrlChannel"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsensehost"
- // ]
- // }
-
-}
-
-// method id "adsensehost.urlchannels.list":
-
-type UrlchannelsListCall struct {
- s *Service
- adClientId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all host URL channels in the host AdSense account.
-func (r *UrlchannelsService) List(adClientId string) *UrlchannelsListCall {
- c := &UrlchannelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.adClientId = adClientId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of URL channels to include in the response, used for paging.
-func (c *UrlchannelsListCall) MaxResults(maxResults int64) *UrlchannelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A continuation
-// token, used to page through URL channels. To retrieve the next page,
-// set this parameter to the value of "nextPageToken" from the previous
-// response.
-func (c *UrlchannelsListCall) PageToken(pageToken string) *UrlchannelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UrlchannelsListCall) Fields(s ...googleapi.Field) *UrlchannelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UrlchannelsListCall) IfNoneMatch(entityTag string) *UrlchannelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UrlchannelsListCall) Context(ctx context.Context) *UrlchannelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UrlchannelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "adclients/{adClientId}/urlchannels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "adClientId": c.adClientId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "adsensehost.urlchannels.list" call.
-// Exactly one of *UrlChannels or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UrlChannels.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UrlchannelsListCall) Do() (*UrlChannels, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UrlChannels{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all host URL channels in the host AdSense account.",
- // "httpMethod": "GET",
- // "id": "adsensehost.urlchannels.list",
- // "parameterOrder": [
- // "adClientId"
- // ],
- // "parameters": {
- // "adClientId": {
- // "description": "Ad client for which to list URL channels.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "The maximum number of URL channels to include in the response, used for paging.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "10000",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "adclients/{adClientId}/urlchannels",
- // "response": {
- // "$ref": "UrlChannels"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/adsensehost"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/analytics/v2.4/analytics-api.json b/vendor/google.golang.org/api/analytics/v2.4/analytics-api.json
deleted file mode 100644
index 384b7a37..00000000
--- a/vendor/google.golang.org/api/analytics/v2.4/analytics-api.json
+++ /dev/null
@@ -1,366 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/deWKWLiFywg1_Xne7G92xyJt8HA\"",
- "discoveryVersion": "v1",
- "id": "analytics:v2.4",
- "name": "analytics",
- "version": "v2.4",
- "revision": "20150115",
- "title": "Google Analytics API",
- "description": "View and manage your Google Analytics data",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/analytics-16.png",
- "x32": "https://www.google.com/images/icons/product/analytics-32.png"
- },
- "documentationLink": "https://developers.google.com/analytics/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/analytics/v2.4/",
- "basePath": "/analytics/v2.4/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "analytics/v2.4/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "atom",
- "enum": [
- "atom"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/atom+xml"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "false",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/analytics": {
- "description": "View and manage your Google Analytics data"
- },
- "https://www.googleapis.com/auth/analytics.readonly": {
- "description": "View your Google Analytics data"
- }
- }
- }
- },
- "resources": {
- "data": {
- "methods": {
- "get": {
- "id": "analytics.data.get",
- "path": "data",
- "httpMethod": "GET",
- "description": "Returns Analytics report data for a view (profile).",
- "parameters": {
- "dimensions": {
- "type": "string",
- "description": "A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.",
- "pattern": "(ga:.+)?",
- "location": "query"
- },
- "end-date": {
- "type": "string",
- "description": "End date for fetching report data. All requests should specify an end date formatted as YYYY-MM-DD.",
- "required": true,
- "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}",
- "location": "query"
- },
- "filters": {
- "type": "string",
- "description": "A comma-separated list of dimension or metric filters to be applied to the report data.",
- "pattern": "ga:.+",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Unique table ID for retrieving report data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.",
- "required": true,
- "pattern": "ga:[0-9]+",
- "location": "query"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of entries to include in this feed.",
- "format": "int32",
- "location": "query"
- },
- "metrics": {
- "type": "string",
- "description": "A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified to retrieve a valid Analytics report.",
- "required": true,
- "pattern": "ga:.+",
- "location": "query"
- },
- "segment": {
- "type": "string",
- "description": "An Analytics advanced segment to be applied to the report data.",
- "location": "query"
- },
- "sort": {
- "type": "string",
- "description": "A comma-separated list of dimensions or metrics that determine the sort order for the report data.",
- "pattern": "(-)?ga:.+",
- "location": "query"
- },
- "start-date": {
- "type": "string",
- "description": "Start date for fetching report data. All requests should specify a start date formatted as YYYY-MM-DD.",
- "required": true,
- "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- }
- },
- "parameterOrder": [
- "ids",
- "start-date",
- "end-date",
- "metrics"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
- },
- "management": {
- "resources": {
- "accounts": {
- "methods": {
- "list": {
- "id": "analytics.management.accounts.list",
- "path": "management/accounts",
- "httpMethod": "GET",
- "description": "Lists all accounts to which the user has access.",
- "parameters": {
- "max-results": {
- "type": "integer",
- "description": "The maximum number of accounts to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
- },
- "goals": {
- "methods": {
- "list": {
- "id": "analytics.management.goals.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals",
- "httpMethod": "GET",
- "description": "Lists goals to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.",
- "required": true,
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of goals to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to.",
- "required": true,
- "location": "path"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
- },
- "profiles": {
- "methods": {
- "list": {
- "id": "analytics.management.profiles.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles",
- "httpMethod": "GET",
- "description": "Lists views (profiles) to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID for the views (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access.",
- "required": true,
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of views (profiles) to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
- },
- "segments": {
- "methods": {
- "list": {
- "id": "analytics.management.segments.list",
- "path": "management/segments",
- "httpMethod": "GET",
- "description": "Lists advanced segments to which the user has access.",
- "parameters": {
- "max-results": {
- "type": "integer",
- "description": "The maximum number of advanced segments to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first advanced segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
- },
- "webproperties": {
- "methods": {
- "list": {
- "id": "analytics.management.webproperties.list",
- "path": "management/accounts/{accountId}/webproperties",
- "httpMethod": "GET",
- "description": "Lists web properties to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.",
- "required": true,
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of web properties to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/analytics/v2.4/analytics-gen.go b/vendor/google.golang.org/api/analytics/v2.4/analytics-gen.go
deleted file mode 100644
index b0bdf2a2..00000000
--- a/vendor/google.golang.org/api/analytics/v2.4/analytics-gen.go
+++ /dev/null
@@ -1,1066 +0,0 @@
-// Package analytics provides access to the Google Analytics API.
-//
-// See https://developers.google.com/analytics/
-//
-// Usage example:
-//
-// import "google.golang.org/api/analytics/v2.4"
-// ...
-// analyticsService, err := analytics.New(oauthHttpClient)
-package analytics // import "google.golang.org/api/analytics/v2.4"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "analytics:v2.4"
-const apiName = "analytics"
-const apiVersion = "v2.4"
-const basePath = "https://www.googleapis.com/analytics/v2.4/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your Google Analytics data
- AnalyticsScope = "https://www.googleapis.com/auth/analytics"
-
- // View your Google Analytics data
- AnalyticsReadonlyScope = "https://www.googleapis.com/auth/analytics.readonly"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Data = NewDataService(s)
- s.Management = NewManagementService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Data *DataService
-
- Management *ManagementService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewDataService(s *Service) *DataService {
- rs := &DataService{s: s}
- return rs
-}
-
-type DataService struct {
- s *Service
-}
-
-func NewManagementService(s *Service) *ManagementService {
- rs := &ManagementService{s: s}
- rs.Accounts = NewManagementAccountsService(s)
- rs.Goals = NewManagementGoalsService(s)
- rs.Profiles = NewManagementProfilesService(s)
- rs.Segments = NewManagementSegmentsService(s)
- rs.Webproperties = NewManagementWebpropertiesService(s)
- return rs
-}
-
-type ManagementService struct {
- s *Service
-
- Accounts *ManagementAccountsService
-
- Goals *ManagementGoalsService
-
- Profiles *ManagementProfilesService
-
- Segments *ManagementSegmentsService
-
- Webproperties *ManagementWebpropertiesService
-}
-
-func NewManagementAccountsService(s *Service) *ManagementAccountsService {
- rs := &ManagementAccountsService{s: s}
- return rs
-}
-
-type ManagementAccountsService struct {
- s *Service
-}
-
-func NewManagementGoalsService(s *Service) *ManagementGoalsService {
- rs := &ManagementGoalsService{s: s}
- return rs
-}
-
-type ManagementGoalsService struct {
- s *Service
-}
-
-func NewManagementProfilesService(s *Service) *ManagementProfilesService {
- rs := &ManagementProfilesService{s: s}
- return rs
-}
-
-type ManagementProfilesService struct {
- s *Service
-}
-
-func NewManagementSegmentsService(s *Service) *ManagementSegmentsService {
- rs := &ManagementSegmentsService{s: s}
- return rs
-}
-
-type ManagementSegmentsService struct {
- s *Service
-}
-
-func NewManagementWebpropertiesService(s *Service) *ManagementWebpropertiesService {
- rs := &ManagementWebpropertiesService{s: s}
- return rs
-}
-
-type ManagementWebpropertiesService struct {
- s *Service
-}
-
-// method id "analytics.data.get":
-
-type DataGetCall struct {
- s *Service
- ids string
- startDate string
- endDate string
- metrics string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns Analytics report data for a view (profile).
-func (r *DataService) Get(ids string, startDate string, endDate string, metrics string) *DataGetCall {
- c := &DataGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.ids = ids
- c.startDate = startDate
- c.endDate = endDate
- c.metrics = metrics
- return c
-}
-
-// Dimensions sets the optional parameter "dimensions": A
-// comma-separated list of Analytics dimensions. E.g.,
-// 'ga:browser,ga:city'.
-func (c *DataGetCall) Dimensions(dimensions string) *DataGetCall {
- c.opt_["dimensions"] = dimensions
- return c
-}
-
-// Filters sets the optional parameter "filters": A comma-separated list
-// of dimension or metric filters to be applied to the report data.
-func (c *DataGetCall) Filters(filters string) *DataGetCall {
- c.opt_["filters"] = filters
- return c
-}
-
-// MaxResults sets the optional parameter "max-results": The maximum
-// number of entries to include in this feed.
-func (c *DataGetCall) MaxResults(maxResults int64) *DataGetCall {
- c.opt_["max-results"] = maxResults
- return c
-}
-
-// Segment sets the optional parameter "segment": An Analytics advanced
-// segment to be applied to the report data.
-func (c *DataGetCall) Segment(segment string) *DataGetCall {
- c.opt_["segment"] = segment
- return c
-}
-
-// Sort sets the optional parameter "sort": A comma-separated list of
-// dimensions or metrics that determine the sort order for the report
-// data.
-func (c *DataGetCall) Sort(sort string) *DataGetCall {
- c.opt_["sort"] = sort
- return c
-}
-
-// StartIndex sets the optional parameter "start-index": An index of the
-// first entity to retrieve. Use this parameter as a pagination
-// mechanism along with the max-results parameter.
-func (c *DataGetCall) StartIndex(startIndex int64) *DataGetCall {
- c.opt_["start-index"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DataGetCall) Fields(s ...googleapi.Field) *DataGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DataGetCall) IfNoneMatch(entityTag string) *DataGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DataGetCall) Context(ctx context.Context) *DataGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DataGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("end-date", fmt.Sprintf("%v", c.endDate))
- params.Set("ids", fmt.Sprintf("%v", c.ids))
- params.Set("metrics", fmt.Sprintf("%v", c.metrics))
- params.Set("start-date", fmt.Sprintf("%v", c.startDate))
- if v, ok := c.opt_["dimensions"]; ok {
- params.Set("dimensions", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["filters"]; ok {
- params.Set("filters", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["max-results"]; ok {
- params.Set("max-results", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["segment"]; ok {
- params.Set("segment", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sort"]; ok {
- params.Set("sort", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["start-index"]; ok {
- params.Set("start-index", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "data")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.data.get" call.
-func (c *DataGetCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Returns Analytics report data for a view (profile).",
- // "httpMethod": "GET",
- // "id": "analytics.data.get",
- // "parameterOrder": [
- // "ids",
- // "start-date",
- // "end-date",
- // "metrics"
- // ],
- // "parameters": {
- // "dimensions": {
- // "description": "A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.",
- // "location": "query",
- // "pattern": "(ga:.+)?",
- // "type": "string"
- // },
- // "end-date": {
- // "description": "End date for fetching report data. All requests should specify an end date formatted as YYYY-MM-DD.",
- // "location": "query",
- // "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}",
- // "required": true,
- // "type": "string"
- // },
- // "filters": {
- // "description": "A comma-separated list of dimension or metric filters to be applied to the report data.",
- // "location": "query",
- // "pattern": "ga:.+",
- // "type": "string"
- // },
- // "ids": {
- // "description": "Unique table ID for retrieving report data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.",
- // "location": "query",
- // "pattern": "ga:[0-9]+",
- // "required": true,
- // "type": "string"
- // },
- // "max-results": {
- // "description": "The maximum number of entries to include in this feed.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "metrics": {
- // "description": "A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified to retrieve a valid Analytics report.",
- // "location": "query",
- // "pattern": "ga:.+",
- // "required": true,
- // "type": "string"
- // },
- // "segment": {
- // "description": "An Analytics advanced segment to be applied to the report data.",
- // "location": "query",
- // "type": "string"
- // },
- // "sort": {
- // "description": "A comma-separated list of dimensions or metrics that determine the sort order for the report data.",
- // "location": "query",
- // "pattern": "(-)?ga:.+",
- // "type": "string"
- // },
- // "start-date": {
- // "description": "Start date for fetching report data. All requests should specify a start date formatted as YYYY-MM-DD.",
- // "location": "query",
- // "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}",
- // "required": true,
- // "type": "string"
- // },
- // "start-index": {
- // "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // }
- // },
- // "path": "data",
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.accounts.list":
-
-type ManagementAccountsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all accounts to which the user has access.
-func (r *ManagementAccountsService) List() *ManagementAccountsListCall {
- c := &ManagementAccountsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// MaxResults sets the optional parameter "max-results": The maximum
-// number of accounts to include in this response.
-func (c *ManagementAccountsListCall) MaxResults(maxResults int64) *ManagementAccountsListCall {
- c.opt_["max-results"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "start-index": An index of the
-// first account to retrieve. Use this parameter as a pagination
-// mechanism along with the max-results parameter.
-func (c *ManagementAccountsListCall) StartIndex(startIndex int64) *ManagementAccountsListCall {
- c.opt_["start-index"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementAccountsListCall) Fields(s ...googleapi.Field) *ManagementAccountsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementAccountsListCall) IfNoneMatch(entityTag string) *ManagementAccountsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementAccountsListCall) Context(ctx context.Context) *ManagementAccountsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementAccountsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["max-results"]; ok {
- params.Set("max-results", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["start-index"]; ok {
- params.Set("start-index", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.accounts.list" call.
-func (c *ManagementAccountsListCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Lists all accounts to which the user has access.",
- // "httpMethod": "GET",
- // "id": "analytics.management.accounts.list",
- // "parameters": {
- // "max-results": {
- // "description": "The maximum number of accounts to include in this response.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "start-index": {
- // "description": "An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // }
- // },
- // "path": "management/accounts",
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.goals.list":
-
-type ManagementGoalsListCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists goals to which the user has access.
-func (r *ManagementGoalsService) List(accountId string, webPropertyId string, profileId string) *ManagementGoalsListCall {
- c := &ManagementGoalsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- return c
-}
-
-// MaxResults sets the optional parameter "max-results": The maximum
-// number of goals to include in this response.
-func (c *ManagementGoalsListCall) MaxResults(maxResults int64) *ManagementGoalsListCall {
- c.opt_["max-results"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "start-index": An index of the
-// first goal to retrieve. Use this parameter as a pagination mechanism
-// along with the max-results parameter.
-func (c *ManagementGoalsListCall) StartIndex(startIndex int64) *ManagementGoalsListCall {
- c.opt_["start-index"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementGoalsListCall) Fields(s ...googleapi.Field) *ManagementGoalsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementGoalsListCall) IfNoneMatch(entityTag string) *ManagementGoalsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementGoalsListCall) Context(ctx context.Context) *ManagementGoalsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementGoalsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["max-results"]; ok {
- params.Set("max-results", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["start-index"]; ok {
- params.Set("start-index", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.goals.list" call.
-func (c *ManagementGoalsListCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Lists goals to which the user has access.",
- // "httpMethod": "GET",
- // "id": "analytics.management.goals.list",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "max-results": {
- // "description": "The maximum number of goals to include in this response.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "profileId": {
- // "description": "View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "start-index": {
- // "description": "An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "webPropertyId": {
- // "description": "Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals",
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.profiles.list":
-
-type ManagementProfilesListCall struct {
- s *Service
- accountId string
- webPropertyId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists views (profiles) to which the user has access.
-func (r *ManagementProfilesService) List(accountId string, webPropertyId string) *ManagementProfilesListCall {
- c := &ManagementProfilesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- return c
-}
-
-// MaxResults sets the optional parameter "max-results": The maximum
-// number of views (profiles) to include in this response.
-func (c *ManagementProfilesListCall) MaxResults(maxResults int64) *ManagementProfilesListCall {
- c.opt_["max-results"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "start-index": An index of the
-// first entity to retrieve. Use this parameter as a pagination
-// mechanism along with the max-results parameter.
-func (c *ManagementProfilesListCall) StartIndex(startIndex int64) *ManagementProfilesListCall {
- c.opt_["start-index"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementProfilesListCall) Fields(s ...googleapi.Field) *ManagementProfilesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementProfilesListCall) IfNoneMatch(entityTag string) *ManagementProfilesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementProfilesListCall) Context(ctx context.Context) *ManagementProfilesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementProfilesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["max-results"]; ok {
- params.Set("max-results", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["start-index"]; ok {
- params.Set("start-index", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.profiles.list" call.
-func (c *ManagementProfilesListCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Lists views (profiles) to which the user has access.",
- // "httpMethod": "GET",
- // "id": "analytics.management.profiles.list",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID for the views (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "max-results": {
- // "description": "The maximum number of views (profiles) to include in this response.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "start-index": {
- // "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "webPropertyId": {
- // "description": "Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles",
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.segments.list":
-
-type ManagementSegmentsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists advanced segments to which the user has access.
-func (r *ManagementSegmentsService) List() *ManagementSegmentsListCall {
- c := &ManagementSegmentsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// MaxResults sets the optional parameter "max-results": The maximum
-// number of advanced segments to include in this response.
-func (c *ManagementSegmentsListCall) MaxResults(maxResults int64) *ManagementSegmentsListCall {
- c.opt_["max-results"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "start-index": An index of the
-// first advanced segment to retrieve. Use this parameter as a
-// pagination mechanism along with the max-results parameter.
-func (c *ManagementSegmentsListCall) StartIndex(startIndex int64) *ManagementSegmentsListCall {
- c.opt_["start-index"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementSegmentsListCall) Fields(s ...googleapi.Field) *ManagementSegmentsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementSegmentsListCall) IfNoneMatch(entityTag string) *ManagementSegmentsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementSegmentsListCall) Context(ctx context.Context) *ManagementSegmentsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementSegmentsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["max-results"]; ok {
- params.Set("max-results", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["start-index"]; ok {
- params.Set("start-index", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/segments")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.segments.list" call.
-func (c *ManagementSegmentsListCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Lists advanced segments to which the user has access.",
- // "httpMethod": "GET",
- // "id": "analytics.management.segments.list",
- // "parameters": {
- // "max-results": {
- // "description": "The maximum number of advanced segments to include in this response.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "start-index": {
- // "description": "An index of the first advanced segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // }
- // },
- // "path": "management/segments",
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.webproperties.list":
-
-type ManagementWebpropertiesListCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists web properties to which the user has access.
-func (r *ManagementWebpropertiesService) List(accountId string) *ManagementWebpropertiesListCall {
- c := &ManagementWebpropertiesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// MaxResults sets the optional parameter "max-results": The maximum
-// number of web properties to include in this response.
-func (c *ManagementWebpropertiesListCall) MaxResults(maxResults int64) *ManagementWebpropertiesListCall {
- c.opt_["max-results"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "start-index": An index of the
-// first entity to retrieve. Use this parameter as a pagination
-// mechanism along with the max-results parameter.
-func (c *ManagementWebpropertiesListCall) StartIndex(startIndex int64) *ManagementWebpropertiesListCall {
- c.opt_["start-index"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementWebpropertiesListCall) Fields(s ...googleapi.Field) *ManagementWebpropertiesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementWebpropertiesListCall) IfNoneMatch(entityTag string) *ManagementWebpropertiesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementWebpropertiesListCall) Context(ctx context.Context) *ManagementWebpropertiesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementWebpropertiesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["max-results"]; ok {
- params.Set("max-results", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["start-index"]; ok {
- params.Set("start-index", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.webproperties.list" call.
-func (c *ManagementWebpropertiesListCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Lists web properties to which the user has access.",
- // "httpMethod": "GET",
- // "id": "analytics.management.webproperties.list",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "max-results": {
- // "description": "The maximum number of web properties to include in this response.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "start-index": {
- // "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties",
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/analytics/v3/analytics-api.json b/vendor/google.golang.org/api/analytics/v3/analytics-api.json
deleted file mode 100644
index ce2af4b9..00000000
--- a/vendor/google.golang.org/api/analytics/v3/analytics-api.json
+++ /dev/null
@@ -1,6675 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/tkvvUCeQm-DiyKpCr0Y-A0UaVuo\"",
- "discoveryVersion": "v1",
- "id": "analytics:v3",
- "name": "analytics",
- "version": "v3",
- "revision": "20150814",
- "title": "Google Analytics API",
- "description": "View and manage your Google Analytics data",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/analytics-16.png",
- "x32": "https://www.google.com/images/icons/product/analytics-32.png"
- },
- "documentationLink": "https://developers.google.com/analytics/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/analytics/v3/",
- "basePath": "/analytics/v3/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "analytics/v3/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "false",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/analytics": {
- "description": "View and manage your Google Analytics data"
- },
- "https://www.googleapis.com/auth/analytics.edit": {
- "description": "Edit Google Analytics management entities"
- },
- "https://www.googleapis.com/auth/analytics.manage.users": {
- "description": "Manage Google Analytics Account users by email address"
- },
- "https://www.googleapis.com/auth/analytics.manage.users.readonly": {
- "description": "View Google Analytics user permissions"
- },
- "https://www.googleapis.com/auth/analytics.provision": {
- "description": "Create a new Google Analytics account along with its default property and view"
- },
- "https://www.googleapis.com/auth/analytics.readonly": {
- "description": "View your Google Analytics data"
- }
- }
- }
- },
- "schemas": {
- "Account": {
- "id": "Account",
- "type": "object",
- "description": "JSON template for Analytics account entry.",
- "properties": {
- "childLink": {
- "type": "object",
- "description": "Child link for an account entry. Points to the list of web properties for this account.",
- "properties": {
- "href": {
- "type": "string",
- "description": "Link to the list of web properties for this account."
- },
- "type": {
- "type": "string",
- "description": "Type of the child link. Its value is \"analytics#webproperties\".",
- "default": "analytics#webproperties"
- }
- }
- },
- "created": {
- "type": "string",
- "description": "Time the account was created.",
- "format": "date-time"
- },
- "id": {
- "type": "string",
- "description": "Account ID."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for Analytics account.",
- "default": "analytics#account"
- },
- "name": {
- "type": "string",
- "description": "Account name."
- },
- "permissions": {
- "type": "object",
- "description": "Permissions the user has for this account.",
- "properties": {
- "effective": {
- "type": "array",
- "description": "All the permissions that the user has for this account. These include any implied permissions (e.g., EDIT implies VIEW).",
- "readOnly": true,
- "items": {
- "type": "string"
- }
- }
- }
- },
- "selfLink": {
- "type": "string",
- "description": "Link for this account."
- },
- "updated": {
- "type": "string",
- "description": "Time the account was last modified.",
- "format": "date-time"
- }
- }
- },
- "AccountRef": {
- "id": "AccountRef",
- "type": "object",
- "description": "JSON template for a linked account.",
- "properties": {
- "href": {
- "type": "string",
- "description": "Link for this account."
- },
- "id": {
- "type": "string",
- "description": "Account ID."
- },
- "kind": {
- "type": "string",
- "description": "Analytics account reference.",
- "default": "analytics#accountRef"
- },
- "name": {
- "type": "string",
- "description": "Account name."
- }
- }
- },
- "AccountSummaries": {
- "id": "AccountSummaries",
- "type": "object",
- "description": "An AccountSummary collection lists a summary of accounts, properties and views (profiles) to which the user has access. Each resource in the collection corresponds to a single AccountSummary.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of AccountSummaries.",
- "items": {
- "$ref": "AccountSummary"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#accountSummaries"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this AccountSummary collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this AccountSummary collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of results in the response.",
- "format": "int32"
- },
- "username": {
- "type": "string",
- "description": "Email ID of the authenticated user"
- }
- }
- },
- "AccountSummary": {
- "id": "AccountSummary",
- "type": "object",
- "description": "JSON template for an Analytics AccountSummary. An AccountSummary is a lightweight tree comprised of properties/profiles.",
- "properties": {
- "id": {
- "type": "string",
- "description": "Account ID."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for Analytics AccountSummary.",
- "default": "analytics#accountSummary"
- },
- "name": {
- "type": "string",
- "description": "Account name."
- },
- "webProperties": {
- "type": "array",
- "description": "List of web properties under this account.",
- "items": {
- "$ref": "WebPropertySummary"
- }
- }
- }
- },
- "AccountTicket": {
- "id": "AccountTicket",
- "type": "object",
- "description": "JSON template for an Analytics account ticket. The account ticket consists of the ticket ID and the basic information for the account, property and profile.",
- "properties": {
- "account": {
- "$ref": "Account",
- "description": "Account for this ticket."
- },
- "id": {
- "type": "string",
- "description": "Account ticket ID used to access the account ticket."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for account ticket.",
- "default": "analytics#accountTicket"
- },
- "profile": {
- "$ref": "Profile",
- "description": "View (Profile) for the account."
- },
- "redirectUri": {
- "type": "string",
- "description": "Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in APIs console as a callback URL."
- },
- "webproperty": {
- "$ref": "Webproperty",
- "description": "Web property for the account."
- }
- }
- },
- "Accounts": {
- "id": "Accounts",
- "type": "object",
- "description": "An account collection provides a list of Analytics accounts to which a user has access. The account collection is the entry point to all management information. Each resource in the collection corresponds to a single Analytics account.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of accounts.",
- "items": {
- "$ref": "Account"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#accounts"
- },
- "nextLink": {
- "type": "string",
- "description": "Next link for this account collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Previous link for this account collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of results in the response.",
- "format": "int32"
- },
- "username": {
- "type": "string",
- "description": "Email ID of the authenticated user"
- }
- }
- },
- "AdWordsAccount": {
- "id": "AdWordsAccount",
- "type": "object",
- "description": "JSON template for an AdWords account.",
- "properties": {
- "autoTaggingEnabled": {
- "type": "boolean",
- "description": "True if auto-tagging is enabled on the AdWords account. Read-only after the insert operation."
- },
- "customerId": {
- "type": "string",
- "description": "Customer ID. This field is required when creating an AdWords link.",
- "annotations": {
- "required": [
- "analytics.management.webPropertyAdWordsLinks.insert",
- "analytics.management.webPropertyAdWordsLinks.update"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type for AdWords account.",
- "default": "analytics#adWordsAccount"
- }
- }
- },
- "AnalyticsDataimportDeleteUploadDataRequest": {
- "id": "AnalyticsDataimportDeleteUploadDataRequest",
- "type": "object",
- "description": "Request template for the delete upload data request.",
- "properties": {
- "customDataImportUids": {
- "type": "array",
- "description": "A list of upload UIDs.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "Column": {
- "id": "Column",
- "type": "object",
- "description": "JSON template for a metadata column.",
- "properties": {
- "attributes": {
- "type": "object",
- "description": "Map of attribute name and value for this column.",
- "additionalProperties": {
- "type": "string",
- "description": "The name of the attribute."
- }
- },
- "id": {
- "type": "string",
- "description": "Column id."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for Analytics column.",
- "default": "analytics#column"
- }
- }
- },
- "Columns": {
- "id": "Columns",
- "type": "object",
- "description": "Lists columns (dimensions and metrics) for a particular report type.",
- "properties": {
- "attributeNames": {
- "type": "array",
- "description": "List of attributes names returned by columns.",
- "items": {
- "type": "string"
- }
- },
- "etag": {
- "type": "string",
- "description": "Etag of collection. This etag can be compared with the last response etag to check if response has changed."
- },
- "items": {
- "type": "array",
- "description": "List of columns for a report type.",
- "items": {
- "$ref": "Column"
- }
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#columns"
- },
- "totalResults": {
- "type": "integer",
- "description": "Total number of columns returned in the response.",
- "format": "int32"
- }
- }
- },
- "CustomDataSource": {
- "id": "CustomDataSource",
- "type": "object",
- "description": "JSON template for an Analytics custom data source.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which this custom data source belongs."
- },
- "childLink": {
- "type": "object",
- "properties": {
- "href": {
- "type": "string",
- "description": "Link to the list of daily uploads for this custom data source. Link to the list of uploads for this custom data source."
- },
- "type": {
- "type": "string",
- "description": "Value is \"analytics#dailyUploads\". Value is \"analytics#uploads\"."
- }
- }
- },
- "created": {
- "type": "string",
- "description": "Time this custom data source was created.",
- "format": "date-time"
- },
- "description": {
- "type": "string",
- "description": "Description of custom data source."
- },
- "id": {
- "type": "string",
- "description": "Custom data source ID."
- },
- "importBehavior": {
- "type": "string"
- },
- "kind": {
- "type": "string",
- "description": "Resource type for Analytics custom data source.",
- "default": "analytics#customDataSource"
- },
- "name": {
- "type": "string",
- "description": "Name of this custom data source."
- },
- "parentLink": {
- "type": "object",
- "description": "Parent link for this custom data source. Points to the web property to which this custom data source belongs.",
- "properties": {
- "href": {
- "type": "string",
- "description": "Link to the web property to which this custom data source belongs."
- },
- "type": {
- "type": "string",
- "description": "Value is \"analytics#webproperty\".",
- "default": "analytics#webproperty"
- }
- }
- },
- "profilesLinked": {
- "type": "array",
- "description": "IDs of views (profiles) linked to the custom data source.",
- "items": {
- "type": "string"
- }
- },
- "selfLink": {
- "type": "string",
- "description": "Link for this Analytics custom data source."
- },
- "type": {
- "type": "string",
- "description": "Type of the custom data source."
- },
- "updated": {
- "type": "string",
- "description": "Time this custom data source was last modified.",
- "format": "date-time"
- },
- "uploadType": {
- "type": "string"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID of the form UA-XXXXX-YY to which this custom data source belongs."
- }
- }
- },
- "CustomDataSources": {
- "id": "CustomDataSources",
- "type": "object",
- "description": "Lists Analytics custom data sources to which the user has access. Each resource in the collection corresponds to a single Analytics custom data source.",
- "properties": {
- "items": {
- "type": "array",
- "description": "Collection of custom data sources.",
- "items": {
- "$ref": "CustomDataSource"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#customDataSources"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this custom data source collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this custom data source collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of results in the response.",
- "format": "int32"
- },
- "username": {
- "type": "string",
- "description": "Email ID of the authenticated user"
- }
- }
- },
- "CustomDimension": {
- "id": "CustomDimension",
- "type": "object",
- "description": "JSON template for Analytics Custom Dimension.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID."
- },
- "active": {
- "type": "boolean",
- "description": "Boolean indicating whether the custom dimension is active."
- },
- "created": {
- "type": "string",
- "description": "Time the custom dimension was created.",
- "format": "date-time",
- "readOnly": true
- },
- "id": {
- "type": "string",
- "description": "Custom dimension ID."
- },
- "index": {
- "type": "integer",
- "description": "Index of the custom dimension.",
- "format": "int32",
- "readOnly": true
- },
- "kind": {
- "type": "string",
- "description": "Kind value for a custom dimension. Set to \"analytics#customDimension\". It is a read-only field.",
- "default": "analytics#customDimension",
- "readOnly": true
- },
- "name": {
- "type": "string",
- "description": "Name of the custom dimension."
- },
- "parentLink": {
- "type": "object",
- "description": "Parent link for the custom dimension. Points to the property to which the custom dimension belongs.",
- "properties": {
- "href": {
- "type": "string",
- "description": "Link to the property to which the custom dimension belongs."
- },
- "type": {
- "type": "string",
- "description": "Type of the parent link. Set to \"analytics#webproperty\".",
- "default": "analytics#webproperty"
- }
- }
- },
- "scope": {
- "type": "string",
- "description": "Scope of the custom dimension: HIT, SESSION, USER or PRODUCT."
- },
- "selfLink": {
- "type": "string",
- "description": "Link for the custom dimension",
- "readOnly": true
- },
- "updated": {
- "type": "string",
- "description": "Time the custom dimension was last modified.",
- "format": "date-time",
- "readOnly": true
- },
- "webPropertyId": {
- "type": "string",
- "description": "Property ID."
- }
- }
- },
- "CustomDimensions": {
- "id": "CustomDimensions",
- "type": "object",
- "description": "A custom dimension collection lists Analytics custom dimensions to which the user has access. Each resource in the collection corresponds to a single Analytics custom dimension.",
- "properties": {
- "items": {
- "type": "array",
- "description": "Collection of custom dimensions.",
- "items": {
- "$ref": "CustomDimension"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#customDimensions"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this custom dimension collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this custom dimension collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of results in the response.",
- "format": "int32"
- },
- "username": {
- "type": "string",
- "description": "Email ID of the authenticated user"
- }
- }
- },
- "CustomMetric": {
- "id": "CustomMetric",
- "type": "object",
- "description": "JSON template for Analytics Custom Metric.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID."
- },
- "active": {
- "type": "boolean",
- "description": "Boolean indicating whether the custom metric is active."
- },
- "created": {
- "type": "string",
- "description": "Time the custom metric was created.",
- "format": "date-time",
- "readOnly": true
- },
- "id": {
- "type": "string",
- "description": "Custom metric ID."
- },
- "index": {
- "type": "integer",
- "description": "Index of the custom metric.",
- "format": "int32",
- "readOnly": true
- },
- "kind": {
- "type": "string",
- "description": "Kind value for a custom metric. Set to \"analytics#customMetric\". It is a read-only field.",
- "default": "analytics#customMetric",
- "readOnly": true
- },
- "max_value": {
- "type": "string",
- "description": "Max value of custom metric."
- },
- "min_value": {
- "type": "string",
- "description": "Min value of custom metric."
- },
- "name": {
- "type": "string",
- "description": "Name of the custom metric."
- },
- "parentLink": {
- "type": "object",
- "description": "Parent link for the custom metric. Points to the property to which the custom metric belongs.",
- "properties": {
- "href": {
- "type": "string",
- "description": "Link to the property to which the custom metric belongs."
- },
- "type": {
- "type": "string",
- "description": "Type of the parent link. Set to \"analytics#webproperty\".",
- "default": "analytics#webproperty"
- }
- }
- },
- "scope": {
- "type": "string",
- "description": "Scope of the custom metric: HIT or PRODUCT."
- },
- "selfLink": {
- "type": "string",
- "description": "Link for the custom metric",
- "readOnly": true
- },
- "type": {
- "type": "string",
- "description": "Data type of custom metric."
- },
- "updated": {
- "type": "string",
- "description": "Time the custom metric was last modified.",
- "format": "date-time",
- "readOnly": true
- },
- "webPropertyId": {
- "type": "string",
- "description": "Property ID."
- }
- }
- },
- "CustomMetrics": {
- "id": "CustomMetrics",
- "type": "object",
- "description": "A custom metric collection lists Analytics custom metrics to which the user has access. Each resource in the collection corresponds to a single Analytics custom metric.",
- "properties": {
- "items": {
- "type": "array",
- "description": "Collection of custom metrics.",
- "items": {
- "$ref": "CustomMetric"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#customMetrics"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this custom metric collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this custom metric collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of results in the response.",
- "format": "int32"
- },
- "username": {
- "type": "string",
- "description": "Email ID of the authenticated user"
- }
- }
- },
- "EntityAdWordsLink": {
- "id": "EntityAdWordsLink",
- "type": "object",
- "description": "JSON template for Analytics Entity AdWords Link.",
- "properties": {
- "adWordsAccounts": {
- "type": "array",
- "description": "A list of AdWords client accounts. These cannot be MCC accounts. This field is required when creating an AdWords link. It cannot be empty.",
- "items": {
- "$ref": "AdWordsAccount"
- },
- "annotations": {
- "required": [
- "analytics.management.webPropertyAdWordsLinks.insert",
- "analytics.management.webPropertyAdWordsLinks.update"
- ]
- }
- },
- "entity": {
- "type": "object",
- "description": "Web property being linked.",
- "properties": {
- "webPropertyRef": {
- "$ref": "WebPropertyRef"
- }
- }
- },
- "id": {
- "type": "string",
- "description": "Entity AdWords link ID"
- },
- "kind": {
- "type": "string",
- "description": "Resource type for entity AdWords link.",
- "default": "analytics#entityAdWordsLink"
- },
- "name": {
- "type": "string",
- "description": "Name of the link. This field is required when creating an AdWords link.",
- "annotations": {
- "required": [
- "analytics.management.webPropertyAdWordsLinks.insert",
- "analytics.management.webPropertyAdWordsLinks.update"
- ]
- }
- },
- "profileIds": {
- "type": "array",
- "description": "IDs of linked Views (Profiles) represented as strings.",
- "items": {
- "type": "string"
- }
- },
- "selfLink": {
- "type": "string",
- "description": "URL link for this Google Analytics - Google AdWords link."
- }
- }
- },
- "EntityAdWordsLinks": {
- "id": "EntityAdWordsLinks",
- "type": "object",
- "description": "An entity AdWords link collection provides a list of GA-AdWords links Each resource in this collection corresponds to a single link.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of entity AdWords links.",
- "items": {
- "$ref": "EntityAdWordsLink"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#entityAdWordsLinks"
- },
- "nextLink": {
- "type": "string",
- "description": "Next link for this AdWords link collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Previous link for this AdWords link collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of results in the response.",
- "format": "int32"
- }
- }
- },
- "EntityUserLink": {
- "id": "EntityUserLink",
- "type": "object",
- "description": "JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.",
- "properties": {
- "entity": {
- "type": "object",
- "description": "Entity for this link. It can be an account, a web property, or a view (profile).",
- "properties": {
- "accountRef": {
- "$ref": "AccountRef",
- "description": "Account for this link."
- },
- "profileRef": {
- "$ref": "ProfileRef",
- "description": "View (Profile) for this link."
- },
- "webPropertyRef": {
- "$ref": "WebPropertyRef",
- "description": "Web property for this link."
- }
- }
- },
- "id": {
- "type": "string",
- "description": "Entity user link ID"
- },
- "kind": {
- "type": "string",
- "description": "Resource type for entity user link.",
- "default": "analytics#entityUserLink"
- },
- "permissions": {
- "type": "object",
- "description": "Permissions the user has for this entity.",
- "properties": {
- "effective": {
- "type": "array",
- "description": "Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only.",
- "readOnly": true,
- "items": {
- "type": "string"
- }
- },
- "local": {
- "type": "array",
- "description": "Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "selfLink": {
- "type": "string",
- "description": "Self link for this resource."
- },
- "userRef": {
- "$ref": "UserRef",
- "description": "User reference."
- }
- }
- },
- "EntityUserLinks": {
- "id": "EntityUserLinks",
- "type": "object",
- "description": "An entity user link collection provides a list of Analytics ACL links Each resource in this collection corresponds to a single link.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of entity user links.",
- "items": {
- "$ref": "EntityUserLink"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#entityUserLinks"
- },
- "nextLink": {
- "type": "string",
- "description": "Next link for this account collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Previous link for this account collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of results in the response.",
- "format": "int32"
- }
- }
- },
- "Experiment": {
- "id": "Experiment",
- "type": "object",
- "description": "JSON template for Analytics experiment resource.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which this experiment belongs. This field is read-only."
- },
- "created": {
- "type": "string",
- "description": "Time the experiment was created. This field is read-only.",
- "format": "date-time"
- },
- "description": {
- "type": "string",
- "description": "Notes about this experiment."
- },
- "editableInGaUi": {
- "type": "boolean",
- "description": "If true, the end user will be able to edit the experiment via the Google Analytics user interface."
- },
- "endTime": {
- "type": "string",
- "description": "The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.",
- "format": "date-time"
- },
- "equalWeighting": {
- "type": "boolean",
- "description": "Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED."
- },
- "id": {
- "type": "string",
- "description": "Experiment ID. Required for patch and update. Disallowed for create.",
- "annotations": {
- "required": [
- "analytics.management.experiments.patch",
- "analytics.management.experiments.update"
- ]
- }
- },
- "internalWebPropertyId": {
- "type": "string",
- "description": "Internal ID for the web property to which this experiment belongs. This field is read-only."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for an Analytics experiment. This field is read-only.",
- "default": "analytics#experiment"
- },
- "minimumExperimentLengthInDays": {
- "type": "integer",
- "description": "An integer number in [3, 90]. Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.",
- "format": "int32"
- },
- "name": {
- "type": "string",
- "description": "Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.",
- "annotations": {
- "required": [
- "analytics.management.experiments.insert",
- "analytics.management.experiments.update"
- ]
- }
- },
- "objectiveMetric": {
- "type": "string",
- "description": "The metric that the experiment is optimizing. Valid values: \"ga:goal(n)Completions\", \"ga:adsenseAdsClicks\", \"ga:adsenseAdsViewed\", \"ga:adsenseRevenue\", \"ga:bounces\", \"ga:pageviews\", \"ga:sessionDuration\", \"ga:transactions\", \"ga:transactionRevenue\". This field is required if status is \"RUNNING\" and servingFramework is one of \"REDIRECT\" or \"API\"."
- },
- "optimizationType": {
- "type": "string",
- "description": "Whether the objectiveMetric should be minimized or maximized. Possible values: \"MAXIMUM\", \"MINIMUM\". Optional--defaults to \"MAXIMUM\". Cannot be specified without objectiveMetric. Cannot be modified when status is \"RUNNING\" or \"ENDED\"."
- },
- "parentLink": {
- "type": "object",
- "description": "Parent link for an experiment. Points to the view (profile) to which this experiment belongs.",
- "properties": {
- "href": {
- "type": "string",
- "description": "Link to the view (profile) to which this experiment belongs. This field is read-only."
- },
- "type": {
- "type": "string",
- "description": "Value is \"analytics#profile\". This field is read-only.",
- "default": "analytics#profile"
- }
- }
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to which this experiment belongs. This field is read-only."
- },
- "reasonExperimentEnded": {
- "type": "string",
- "description": "Why the experiment ended. Possible values: \"STOPPED_BY_USER\", \"WINNER_FOUND\", \"EXPERIMENT_EXPIRED\", \"ENDED_WITH_NO_WINNER\", \"GOAL_OBJECTIVE_CHANGED\". \"ENDED_WITH_NO_WINNER\" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only."
- },
- "rewriteVariationUrlsAsOriginal": {
- "type": "boolean",
- "description": "Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED."
- },
- "selfLink": {
- "type": "string",
- "description": "Link for this experiment. This field is read-only."
- },
- "servingFramework": {
- "type": "string",
- "description": "The framework used to serve the experiment variations and evaluate the results. One of: \n- REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.\n- API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.\n- EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results."
- },
- "snippet": {
- "type": "string",
- "description": "The snippet of code to include on the control page(s). This field is read-only."
- },
- "startTime": {
- "type": "string",
- "description": "The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.",
- "format": "date-time"
- },
- "status": {
- "type": "string",
- "description": "Experiment status. Possible values: \"DRAFT\", \"READY_TO_RUN\", \"RUNNING\", \"ENDED\". Experiments can be created in the \"DRAFT\", \"READY_TO_RUN\" or \"RUNNING\" state. This field is required when creating an experiment.",
- "annotations": {
- "required": [
- "analytics.management.experiments.insert",
- "analytics.management.experiments.update"
- ]
- }
- },
- "trafficCoverage": {
- "type": "number",
- "description": "A floating-point number in (0, 1]. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.",
- "format": "double"
- },
- "updated": {
- "type": "string",
- "description": "Time the experiment was last modified. This field is read-only.",
- "format": "date-time"
- },
- "variations": {
- "type": "array",
- "description": "Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.",
- "items": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.",
- "annotations": {
- "required": [
- "analytics.management.experiments.insert",
- "analytics.management.experiments.update"
- ]
- }
- },
- "status": {
- "type": "string",
- "description": "Status of the variation. Possible values: \"ACTIVE\", \"INACTIVE\". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED."
- },
- "url": {
- "type": "string",
- "description": "The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED."
- },
- "weight": {
- "type": "number",
- "description": "Weight that this variation should receive. Only present if the experiment is running. This field is read-only.",
- "format": "double"
- },
- "won": {
- "type": "boolean",
- "description": "True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only."
- }
- }
- }
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only."
- },
- "winnerConfidenceLevel": {
- "type": "number",
- "description": "A floating-point number in (0, 1). Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.",
- "format": "double"
- },
- "winnerFound": {
- "type": "boolean",
- "description": "Boolean specifying whether a winner has been found for this experiment. This field is read-only."
- }
- }
- },
- "Experiments": {
- "id": "Experiments",
- "type": "object",
- "description": "An experiment collection lists Analytics experiments to which the user has access. Each view (profile) can have a set of experiments. Each resource in the Experiment collection corresponds to a single Analytics experiment.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of experiments.",
- "items": {
- "$ref": "Experiment"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#experiments"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this experiment collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this experiment collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of resources in the result.",
- "format": "int32"
- },
- "username": {
- "type": "string",
- "description": "Email ID of the authenticated user"
- }
- }
- },
- "Filter": {
- "id": "Filter",
- "type": "object",
- "description": "JSON template for an Analytics account filter.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which this filter belongs."
- },
- "advancedDetails": {
- "type": "object",
- "description": "Details for the filter of the type ADVANCED.",
- "properties": {
- "caseSensitive": {
- "type": "boolean",
- "description": "Indicates if the filter expressions are case sensitive."
- },
- "extractA": {
- "type": "string",
- "description": "Expression to extract from field A."
- },
- "extractB": {
- "type": "string",
- "description": "Expression to extract from field B."
- },
- "fieldA": {
- "type": "string",
- "description": "Field A."
- },
- "fieldAIndex": {
- "type": "integer",
- "description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.",
- "format": "int32"
- },
- "fieldARequired": {
- "type": "boolean",
- "description": "Indicates if field A is required to match."
- },
- "fieldB": {
- "type": "string",
- "description": "Field B."
- },
- "fieldBIndex": {
- "type": "integer",
- "description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.",
- "format": "int32"
- },
- "fieldBRequired": {
- "type": "boolean",
- "description": "Indicates if field B is required to match."
- },
- "outputConstructor": {
- "type": "string",
- "description": "Expression used to construct the output value."
- },
- "outputToField": {
- "type": "string",
- "description": "Output field."
- },
- "outputToFieldIndex": {
- "type": "integer",
- "description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.",
- "format": "int32"
- },
- "overrideOutputField": {
- "type": "boolean",
- "description": "Indicates if the existing value of the output field, if any, should be overridden by the output expression."
- }
- }
- },
- "created": {
- "type": "string",
- "description": "Time this filter was created.",
- "format": "date-time",
- "readOnly": true
- },
- "excludeDetails": {
- "$ref": "FilterExpression",
- "description": "Details for the filter of the type EXCLUDE."
- },
- "id": {
- "type": "string",
- "description": "Filter ID."
- },
- "includeDetails": {
- "$ref": "FilterExpression",
- "description": "Details for the filter of the type INCLUDE."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for Analytics filter.",
- "default": "analytics#filter",
- "readOnly": true
- },
- "lowercaseDetails": {
- "type": "object",
- "description": "Details for the filter of the type LOWER.",
- "properties": {
- "field": {
- "type": "string",
- "description": "Field to use in the filter."
- },
- "fieldIndex": {
- "type": "integer",
- "description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.",
- "format": "int32"
- }
- }
- },
- "name": {
- "type": "string",
- "description": "Name of this filter.",
- "annotations": {
- "required": [
- "analytics.management.filters.insert",
- "analytics.management.filters.update"
- ]
- }
- },
- "parentLink": {
- "type": "object",
- "description": "Parent link for this filter. Points to the account to which this filter belongs.",
- "properties": {
- "href": {
- "type": "string",
- "description": "Link to the account to which this filter belongs."
- },
- "type": {
- "type": "string",
- "description": "Value is \"analytics#account\".",
- "default": "analytics#account"
- }
- }
- },
- "searchAndReplaceDetails": {
- "type": "object",
- "description": "Details for the filter of the type SEARCH_AND_REPLACE.",
- "properties": {
- "caseSensitive": {
- "type": "boolean",
- "description": "Determines if the filter is case sensitive."
- },
- "field": {
- "type": "string",
- "description": "Field to use in the filter."
- },
- "fieldIndex": {
- "type": "integer",
- "description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.",
- "format": "int32"
- },
- "replaceString": {
- "type": "string",
- "description": "Term to replace the search term with."
- },
- "searchString": {
- "type": "string",
- "description": "Term to search."
- }
- }
- },
- "selfLink": {
- "type": "string",
- "description": "Link for this filter.",
- "readOnly": true
- },
- "type": {
- "type": "string",
- "description": "Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED.",
- "annotations": {
- "required": [
- "analytics.management.filters.insert",
- "analytics.management.filters.update"
- ]
- }
- },
- "updated": {
- "type": "string",
- "description": "Time this filter was last modified.",
- "format": "date-time",
- "readOnly": true
- },
- "uppercaseDetails": {
- "type": "object",
- "description": "Details for the filter of the type UPPER.",
- "properties": {
- "field": {
- "type": "string",
- "description": "Field to use in the filter."
- },
- "fieldIndex": {
- "type": "integer",
- "description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.",
- "format": "int32"
- }
- }
- }
- }
- },
- "FilterExpression": {
- "id": "FilterExpression",
- "type": "object",
- "description": "JSON template for an Analytics filter expression.",
- "properties": {
- "caseSensitive": {
- "type": "boolean",
- "description": "Determines if the filter is case sensitive."
- },
- "expressionValue": {
- "type": "string",
- "description": "Filter expression value"
- },
- "field": {
- "type": "string",
- "description": "Field to filter. Possible values: \n- Content and Traffic \n- PAGE_REQUEST_URI, \n- PAGE_HOSTNAME, \n- PAGE_TITLE, \n- REFERRAL, \n- COST_DATA_URI (Campaign target URL), \n- HIT_TYPE, \n- INTERNAL_SEARCH_TERM, \n- INTERNAL_SEARCH_TYPE, \n- SOURCE_PROPERTY_TRACKING_ID, \n- Campaign or AdGroup \n- CAMPAIGN_SOURCE, \n- CAMPAIGN_MEDIUM, \n- CAMPAIGN_NAME, \n- CAMPAIGN_AD_GROUP, \n- CAMPAIGN_TERM, \n- CAMPAIGN_CONTENT, \n- CAMPAIGN_CODE, \n- CAMPAIGN_REFERRAL_PATH, \n- E-Commerce \n- TRANSACTION_COUNTRY, \n- TRANSACTION_REGION, \n- TRANSACTION_CITY, \n- TRANSACTION_AFFILIATION (Store or order location), \n- ITEM_NAME, \n- ITEM_CODE, \n- ITEM_VARIATION, \n- TRANSACTION_ID, \n- TRANSACTION_CURRENCY_CODE, \n- PRODUCT_ACTION_TYPE, \n- Audience/Users \n- BROWSER, \n- BROWSER_VERSION, \n- BROWSER_SIZE, \n- PLATFORM, \n- PLATFORM_VERSION, \n- LANGUAGE, \n- SCREEN_RESOLUTION, \n- SCREEN_COLORS, \n- JAVA_ENABLED (Boolean Field), \n- FLASH_VERSION, \n- GEO_SPEED (Connection speed), \n- VISITOR_TYPE, \n- GEO_ORGANIZATION (ISP organization), \n- GEO_DOMAIN, \n- GEO_IP_ADDRESS, \n- GEO_IP_VERSION, \n- Location \n- GEO_COUNTRY, \n- GEO_REGION, \n- GEO_CITY, \n- Event \n- EVENT_CATEGORY, \n- EVENT_ACTION, \n- EVENT_LABEL, \n- Other \n- CUSTOM_FIELD_1, \n- CUSTOM_FIELD_2, \n- USER_DEFINED_VALUE, \n- Application \n- APP_ID, \n- APP_INSTALLER_ID, \n- APP_NAME, \n- APP_VERSION, \n- SCREEN, \n- IS_APP (Boolean Field), \n- IS_FATAL_EXCEPTION (Boolean Field), \n- EXCEPTION_DESCRIPTION, \n- Mobile device \n- IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), \n- IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), \n- DEVICE_CATEGORY, \n- MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), \n- MOBILE_HAS_NFC_SUPPORT (Boolean Field), \n- MOBILE_HAS_CELLULAR_RADIO (Boolean Field), \n- MOBILE_HAS_WIFI_SUPPORT (Boolean Field), \n- MOBILE_BRAND_NAME, \n- MOBILE_MODEL_NAME, \n- MOBILE_MARKETING_NAME, \n- MOBILE_POINTING_METHOD, \n- Social \n- SOCIAL_NETWORK, \n- SOCIAL_ACTION, \n- SOCIAL_ACTION_TARGET, \n- Custom dimension \n- CUSTOM_DIMENSION (See accompanying field index),"
- },
- "fieldIndex": {
- "type": "integer",
- "description": "The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Kind value for filter expression",
- "default": "analytics#filterExpression"
- },
- "matchType": {
- "type": "string",
- "description": "Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES."
- }
- }
- },
- "FilterRef": {
- "id": "FilterRef",
- "type": "object",
- "description": "JSON template for a profile filter link.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which this filter belongs.",
- "readOnly": true
- },
- "href": {
- "type": "string",
- "description": "Link for this filter."
- },
- "id": {
- "type": "string",
- "description": "Filter ID.",
- "annotations": {
- "required": [
- "analytics.management.profileFilterLinks.insert"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind value for filter reference.",
- "default": "analytics#filterRef"
- },
- "name": {
- "type": "string",
- "description": "Name of this filter.",
- "readOnly": true
- }
- }
- },
- "Filters": {
- "id": "Filters",
- "type": "object",
- "description": "A filter collection lists filters created by users in an Analytics account. Each resource in the collection corresponds to a filter.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of filters.",
- "items": {
- "$ref": "Filter"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#filters"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this filter collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this filter collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of results in the response.",
- "format": "int32"
- },
- "username": {
- "type": "string",
- "description": "Email ID of the authenticated user"
- }
- }
- },
- "GaData": {
- "id": "GaData",
- "type": "object",
- "description": "Analytics data for a given view (profile).",
- "properties": {
- "columnHeaders": {
- "type": "array",
- "description": "Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.",
- "items": {
- "type": "object",
- "properties": {
- "columnType": {
- "type": "string",
- "description": "Column Type. Either DIMENSION or METRIC."
- },
- "dataType": {
- "type": "string",
- "description": "Data type. Dimension column headers have only STRING as the data type. Metric column headers have data types for metric values such as INTEGER, DOUBLE, CURRENCY etc."
- },
- "name": {
- "type": "string",
- "description": "Column name."
- }
- }
- }
- },
- "containsSampledData": {
- "type": "boolean",
- "description": "Determines if Analytics data contains samples."
- },
- "dataTable": {
- "type": "object",
- "properties": {
- "cols": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "label": {
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- }
- }
- },
- "rows": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "c": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "v": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "id": {
- "type": "string",
- "description": "Unique ID for this data response."
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "analytics#gaData"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this Analytics data query."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this Analytics data query."
- },
- "profileInfo": {
- "type": "object",
- "description": "Information for the view (profile), for which the Analytics data was requested.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which this view (profile) belongs."
- },
- "internalWebPropertyId": {
- "type": "string",
- "description": "Internal ID for the web property to which this view (profile) belongs."
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID."
- },
- "profileName": {
- "type": "string",
- "description": "View (Profile) name."
- },
- "tableId": {
- "type": "string",
- "description": "Table ID for view (profile)."
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web Property ID to which this view (profile) belongs."
- }
- }
- },
- "query": {
- "type": "object",
- "description": "Analytics data request query parameters.",
- "properties": {
- "dimensions": {
- "type": "string",
- "description": "List of analytics dimensions."
- },
- "end-date": {
- "type": "string",
- "description": "End date."
- },
- "filters": {
- "type": "string",
- "description": "Comma-separated list of dimension or metric filters."
- },
- "ids": {
- "type": "string",
- "description": "Unique table ID."
- },
- "max-results": {
- "type": "integer",
- "description": "Maximum results per page.",
- "format": "int32"
- },
- "metrics": {
- "type": "array",
- "description": "List of analytics metrics.",
- "items": {
- "type": "string"
- }
- },
- "samplingLevel": {
- "type": "string",
- "description": "Desired sampling level"
- },
- "segment": {
- "type": "string",
- "description": "Analytics advanced segment."
- },
- "sort": {
- "type": "array",
- "description": "List of dimensions or metrics based on which Analytics data is sorted.",
- "items": {
- "type": "string"
- }
- },
- "start-date": {
- "type": "string",
- "description": "Start date."
- },
- "start-index": {
- "type": "integer",
- "description": "Start index.",
- "format": "int32"
- }
- }
- },
- "rows": {
- "type": "array",
- "description": "Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.",
- "items": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "sampleSize": {
- "type": "string",
- "description": "The number of samples used to calculate the result.",
- "format": "int64"
- },
- "sampleSpace": {
- "type": "string",
- "description": "Total size of the sample space from which the samples were selected.",
- "format": "int64"
- },
- "selfLink": {
- "type": "string",
- "description": "Link to this page."
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of rows for the query, regardless of the number of rows in the response.",
- "format": "int32"
- },
- "totalsForAllResults": {
- "type": "object",
- "description": "Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.",
- "additionalProperties": {
- "type": "string",
- "description": "Key-value pair for the total value of a metric. Key is the metric name and the value is the total value for that metric."
- }
- }
- }
- },
- "Goal": {
- "id": "Goal",
- "type": "object",
- "description": "JSON template for Analytics goal resource.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which this goal belongs."
- },
- "active": {
- "type": "boolean",
- "description": "Determines whether this goal is active."
- },
- "created": {
- "type": "string",
- "description": "Time this goal was created.",
- "format": "date-time"
- },
- "eventDetails": {
- "type": "object",
- "description": "Details for the goal of the type EVENT.",
- "properties": {
- "eventConditions": {
- "type": "array",
- "description": "List of event conditions.",
- "items": {
- "type": "object",
- "properties": {
- "comparisonType": {
- "type": "string",
- "description": "Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL."
- },
- "comparisonValue": {
- "type": "string",
- "description": "Value used for this comparison.",
- "format": "int64"
- },
- "expression": {
- "type": "string",
- "description": "Expression used for this match."
- },
- "matchType": {
- "type": "string",
- "description": "Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT."
- },
- "type": {
- "type": "string",
- "description": "Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE."
- }
- }
- }
- },
- "useEventValue": {
- "type": "boolean",
- "description": "Determines if the event value should be used as the value for this goal."
- }
- }
- },
- "id": {
- "type": "string",
- "description": "Goal ID."
- },
- "internalWebPropertyId": {
- "type": "string",
- "description": "Internal ID for the web property to which this goal belongs."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for an Analytics goal.",
- "default": "analytics#goal"
- },
- "name": {
- "type": "string",
- "description": "Goal name."
- },
- "parentLink": {
- "type": "object",
- "description": "Parent link for a goal. Points to the view (profile) to which this goal belongs.",
- "properties": {
- "href": {
- "type": "string",
- "description": "Link to the view (profile) to which this goal belongs."
- },
- "type": {
- "type": "string",
- "description": "Value is \"analytics#profile\".",
- "default": "analytics#profile"
- }
- }
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to which this goal belongs."
- },
- "selfLink": {
- "type": "string",
- "description": "Link for this goal."
- },
- "type": {
- "type": "string",
- "description": "Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT."
- },
- "updated": {
- "type": "string",
- "description": "Time this goal was last modified.",
- "format": "date-time"
- },
- "urlDestinationDetails": {
- "type": "object",
- "description": "Details for the goal of the type URL_DESTINATION.",
- "properties": {
- "caseSensitive": {
- "type": "boolean",
- "description": "Determines if the goal URL must exactly match the capitalization of visited URLs."
- },
- "firstStepRequired": {
- "type": "boolean",
- "description": "Determines if the first step in this goal is required."
- },
- "matchType": {
- "type": "string",
- "description": "Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX."
- },
- "steps": {
- "type": "array",
- "description": "List of steps configured for this goal funnel.",
- "items": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "Step name."
- },
- "number": {
- "type": "integer",
- "description": "Step number.",
- "format": "int32"
- },
- "url": {
- "type": "string",
- "description": "URL for this step."
- }
- }
- }
- },
- "url": {
- "type": "string",
- "description": "URL for this goal."
- }
- }
- },
- "value": {
- "type": "number",
- "description": "Goal value.",
- "format": "float"
- },
- "visitNumPagesDetails": {
- "type": "object",
- "description": "Details for the goal of the type VISIT_NUM_PAGES.",
- "properties": {
- "comparisonType": {
- "type": "string",
- "description": "Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL."
- },
- "comparisonValue": {
- "type": "string",
- "description": "Value used for this comparison.",
- "format": "int64"
- }
- }
- },
- "visitTimeOnSiteDetails": {
- "type": "object",
- "description": "Details for the goal of the type VISIT_TIME_ON_SITE.",
- "properties": {
- "comparisonType": {
- "type": "string",
- "description": "Type of comparison. Possible values are LESS_THAN or GREATER_THAN."
- },
- "comparisonValue": {
- "type": "string",
- "description": "Value used for this comparison.",
- "format": "int64"
- }
- }
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY."
- }
- }
- },
- "Goals": {
- "id": "Goals",
- "type": "object",
- "description": "A goal collection lists Analytics goals to which the user has access. Each view (profile) can have a set of goals. Each resource in the Goal collection corresponds to a single Analytics goal.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of goals.",
- "items": {
- "$ref": "Goal"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#goals"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this goal collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this goal collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of resources in the result.",
- "format": "int32"
- },
- "username": {
- "type": "string",
- "description": "Email ID of the authenticated user"
- }
- }
- },
- "McfData": {
- "id": "McfData",
- "type": "object",
- "description": "Multi-Channel Funnels data for a given view (profile).",
- "properties": {
- "columnHeaders": {
- "type": "array",
- "description": "Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.",
- "items": {
- "type": "object",
- "properties": {
- "columnType": {
- "type": "string",
- "description": "Column Type. Either DIMENSION or METRIC."
- },
- "dataType": {
- "type": "string",
- "description": "Data type. Dimension and metric values data types such as INTEGER, DOUBLE, CURRENCY, MCF_SEQUENCE etc."
- },
- "name": {
- "type": "string",
- "description": "Column name."
- }
- }
- }
- },
- "containsSampledData": {
- "type": "boolean",
- "description": "Determines if the Analytics data contains sampled data."
- },
- "id": {
- "type": "string",
- "description": "Unique ID for this data response."
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "analytics#mcfData"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this Analytics data query."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this Analytics data query."
- },
- "profileInfo": {
- "type": "object",
- "description": "Information for the view (profile), for which the Analytics data was requested.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which this view (profile) belongs."
- },
- "internalWebPropertyId": {
- "type": "string",
- "description": "Internal ID for the web property to which this view (profile) belongs."
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID."
- },
- "profileName": {
- "type": "string",
- "description": "View (Profile) name."
- },
- "tableId": {
- "type": "string",
- "description": "Table ID for view (profile)."
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web Property ID to which this view (profile) belongs."
- }
- }
- },
- "query": {
- "type": "object",
- "description": "Analytics data request query parameters.",
- "properties": {
- "dimensions": {
- "type": "string",
- "description": "List of analytics dimensions."
- },
- "end-date": {
- "type": "string",
- "description": "End date."
- },
- "filters": {
- "type": "string",
- "description": "Comma-separated list of dimension or metric filters."
- },
- "ids": {
- "type": "string",
- "description": "Unique table ID."
- },
- "max-results": {
- "type": "integer",
- "description": "Maximum results per page.",
- "format": "int32"
- },
- "metrics": {
- "type": "array",
- "description": "List of analytics metrics.",
- "items": {
- "type": "string"
- }
- },
- "samplingLevel": {
- "type": "string",
- "description": "Desired sampling level"
- },
- "segment": {
- "type": "string",
- "description": "Analytics advanced segment."
- },
- "sort": {
- "type": "array",
- "description": "List of dimensions or metrics based on which Analytics data is sorted.",
- "items": {
- "type": "string"
- }
- },
- "start-date": {
- "type": "string",
- "description": "Start date."
- },
- "start-index": {
- "type": "integer",
- "description": "Start index.",
- "format": "int32"
- }
- }
- },
- "rows": {
- "type": "array",
- "description": "Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.",
- "items": {
- "type": "array",
- "items": {
- "type": "object",
- "description": "A union object representing a dimension or metric value. Only one of \"primitiveValue\" or \"conversionPathValue\" attribute will be populated.",
- "properties": {
- "conversionPathValue": {
- "type": "array",
- "description": "A conversion path dimension value, containing a list of interactions with their attributes.",
- "items": {
- "type": "object",
- "properties": {
- "interactionType": {
- "type": "string",
- "description": "Type of an interaction on conversion path. Such as CLICK, IMPRESSION etc."
- },
- "nodeValue": {
- "type": "string",
- "description": "Node value of an interaction on conversion path. Such as source, medium etc."
- }
- }
- }
- },
- "primitiveValue": {
- "type": "string",
- "description": "A primitive dimension value. A primitive metric value."
- }
- }
- }
- }
- },
- "sampleSize": {
- "type": "string",
- "description": "The number of samples used to calculate the result.",
- "format": "int64"
- },
- "sampleSpace": {
- "type": "string",
- "description": "Total size of the sample space from which the samples were selected.",
- "format": "int64"
- },
- "selfLink": {
- "type": "string",
- "description": "Link to this page."
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of rows for the query, regardless of the number of rows in the response.",
- "format": "int32"
- },
- "totalsForAllResults": {
- "type": "object",
- "description": "Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.",
- "additionalProperties": {
- "type": "string",
- "description": "Key-value pair for the total value of a metric. Key is the metric name and the value is the total value for that metric."
- }
- }
- }
- },
- "Profile": {
- "id": "Profile",
- "type": "object",
- "description": "JSON template for an Analytics view (profile).",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which this view (profile) belongs."
- },
- "childLink": {
- "type": "object",
- "description": "Child link for this view (profile). Points to the list of goals for this view (profile).",
- "properties": {
- "href": {
- "type": "string",
- "description": "Link to the list of goals for this view (profile)."
- },
- "type": {
- "type": "string",
- "description": "Value is \"analytics#goals\".",
- "default": "analytics#goals"
- }
- }
- },
- "created": {
- "type": "string",
- "description": "Time this view (profile) was created.",
- "format": "date-time",
- "readOnly": true
- },
- "currency": {
- "type": "string",
- "description": "The currency type associated with this view (profile), defaults to USD. The supported values are:\nARS, AUD, BGN, BRL, CAD, CHF, CNY, CZK, DKK, EUR, GBP, HKD, HUF, IDR, INR, JPY, KRW, LTL, MXN, NOK, NZD, PHP, PLN, RUB, SEK, THB, TRY, TWD, USD, VND, ZAR"
- },
- "defaultPage": {
- "type": "string",
- "description": "Default page for this view (profile)."
- },
- "eCommerceTracking": {
- "type": "boolean",
- "description": "Indicates whether ecommerce tracking is enabled for this view (profile)."
- },
- "enhancedECommerceTracking": {
- "type": "boolean",
- "description": "Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled."
- },
- "excludeQueryParameters": {
- "type": "string",
- "description": "The query parameters that are excluded from this view (profile)."
- },
- "id": {
- "type": "string",
- "description": "View (Profile) ID."
- },
- "internalWebPropertyId": {
- "type": "string",
- "description": "Internal ID for the web property to which this view (profile) belongs.",
- "readOnly": true
- },
- "kind": {
- "type": "string",
- "description": "Resource type for Analytics view (profile).",
- "default": "analytics#profile",
- "readOnly": true
- },
- "name": {
- "type": "string",
- "description": "Name of this view (profile)."
- },
- "parentLink": {
- "type": "object",
- "description": "Parent link for this view (profile). Points to the web property to which this view (profile) belongs.",
- "properties": {
- "href": {
- "type": "string",
- "description": "Link to the web property to which this view (profile) belongs."
- },
- "type": {
- "type": "string",
- "description": "Value is \"analytics#webproperty\".",
- "default": "analytics#webproperty"
- }
- }
- },
- "permissions": {
- "type": "object",
- "description": "Permissions the user has for this view (profile).",
- "properties": {
- "effective": {
- "type": "array",
- "description": "All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.",
- "readOnly": true,
- "items": {
- "type": "string"
- }
- }
- }
- },
- "selfLink": {
- "type": "string",
- "description": "Link for this view (profile).",
- "readOnly": true
- },
- "siteSearchCategoryParameters": {
- "type": "string",
- "description": "Site search category parameters for this view (profile)."
- },
- "siteSearchQueryParameters": {
- "type": "string",
- "description": "The site search query parameters for this view (profile)."
- },
- "stripSiteSearchCategoryParameters": {
- "type": "boolean",
- "description": "Whether or not Analytics will strip search category parameters from the URLs in your reports."
- },
- "stripSiteSearchQueryParameters": {
- "type": "boolean",
- "description": "Whether or not Analytics will strip search query parameters from the URLs in your reports."
- },
- "timezone": {
- "type": "string",
- "description": "Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database."
- },
- "type": {
- "type": "string",
- "description": "View (Profile) type. Supported types: WEB or APP."
- },
- "updated": {
- "type": "string",
- "description": "Time this view (profile) was last modified.",
- "format": "date-time",
- "readOnly": true
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.",
- "readOnly": true
- },
- "websiteUrl": {
- "type": "string",
- "description": "Website URL for this view (profile)."
- }
- }
- },
- "ProfileFilterLink": {
- "id": "ProfileFilterLink",
- "type": "object",
- "description": "JSON template for an Analytics profile filter link.",
- "properties": {
- "filterRef": {
- "$ref": "FilterRef",
- "description": "Filter for this link."
- },
- "id": {
- "type": "string",
- "description": "Profile filter link ID."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for Analytics filter.",
- "default": "analytics#profileFilterLink",
- "readOnly": true
- },
- "profileRef": {
- "$ref": "ProfileRef",
- "description": "View (Profile) for this link."
- },
- "rank": {
- "type": "integer",
- "description": "The rank of this profile filter link relative to the other filters linked to the same profile.\nFor readonly (i.e., list and get) operations, the rank always starts at 1.\nFor write (i.e., create, update, or delete) operations, you may specify a value between 0 and 255 inclusively, [0, 255]. In order to insert a link at the end of the list, either don't specify a rank or set a rank to a number greater than the largest rank in the list. In order to insert a link to the beginning of the list specify a rank that is less than or equal to 1. The new link will move all existing filters with the same or lower rank down the list. After the link is inserted/updated/deleted all profile filter links will be renumbered starting at 1.",
- "format": "int32"
- },
- "selfLink": {
- "type": "string",
- "description": "Link for this profile filter link.",
- "readOnly": true
- }
- }
- },
- "ProfileFilterLinks": {
- "id": "ProfileFilterLinks",
- "type": "object",
- "description": "A profile filter link collection lists profile filter links between profiles and filters. Each resource in the collection corresponds to a profile filter link.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of profile filter links.",
- "items": {
- "$ref": "ProfileFilterLink"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#profileFilterLinks"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this profile filter link collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this profile filter link collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of results in the response.",
- "format": "int32"
- },
- "username": {
- "type": "string",
- "description": "Email ID of the authenticated user"
- }
- }
- },
- "ProfileRef": {
- "id": "ProfileRef",
- "type": "object",
- "description": "JSON template for a linked view (profile).",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which this view (profile) belongs."
- },
- "href": {
- "type": "string",
- "description": "Link for this view (profile)."
- },
- "id": {
- "type": "string",
- "description": "View (Profile) ID."
- },
- "internalWebPropertyId": {
- "type": "string",
- "description": "Internal ID for the web property to which this view (profile) belongs."
- },
- "kind": {
- "type": "string",
- "description": "Analytics view (profile) reference.",
- "default": "analytics#profileRef"
- },
- "name": {
- "type": "string",
- "description": "Name of this view (profile)."
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs."
- }
- }
- },
- "ProfileSummary": {
- "id": "ProfileSummary",
- "type": "object",
- "description": "JSON template for an Analytics ProfileSummary. ProfileSummary returns basic information (i.e., summary) for a profile.",
- "properties": {
- "id": {
- "type": "string",
- "description": "View (profile) ID."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for Analytics ProfileSummary.",
- "default": "analytics#profileSummary"
- },
- "name": {
- "type": "string",
- "description": "View (profile) name."
- },
- "type": {
- "type": "string",
- "description": "View (Profile) type. Supported types: WEB or APP."
- }
- }
- },
- "Profiles": {
- "id": "Profiles",
- "type": "object",
- "description": "A view (profile) collection lists Analytics views (profiles) to which the user has access. Each resource in the collection corresponds to a single Analytics view (profile).",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of views (profiles).",
- "items": {
- "$ref": "Profile"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#profiles"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this view (profile) collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this view (profile) collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of results in the response.",
- "format": "int32"
- },
- "username": {
- "type": "string",
- "description": "Email ID of the authenticated user"
- }
- }
- },
- "RealtimeData": {
- "id": "RealtimeData",
- "type": "object",
- "description": "Real time data for a given view (profile).",
- "properties": {
- "columnHeaders": {
- "type": "array",
- "description": "Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.",
- "items": {
- "type": "object",
- "properties": {
- "columnType": {
- "type": "string",
- "description": "Column Type. Either DIMENSION or METRIC."
- },
- "dataType": {
- "type": "string",
- "description": "Data type. Dimension column headers have only STRING as the data type. Metric column headers have data types for metric values such as INTEGER, DOUBLE, CURRENCY etc."
- },
- "name": {
- "type": "string",
- "description": "Column name."
- }
- }
- }
- },
- "id": {
- "type": "string",
- "description": "Unique ID for this data response."
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "analytics#realtimeData"
- },
- "profileInfo": {
- "type": "object",
- "description": "Information for the view (profile), for which the real time data was requested.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which this view (profile) belongs."
- },
- "internalWebPropertyId": {
- "type": "string",
- "description": "Internal ID for the web property to which this view (profile) belongs."
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID."
- },
- "profileName": {
- "type": "string",
- "description": "View (Profile) name."
- },
- "tableId": {
- "type": "string",
- "description": "Table ID for view (profile)."
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web Property ID to which this view (profile) belongs."
- }
- }
- },
- "query": {
- "type": "object",
- "description": "Real time data request query parameters.",
- "properties": {
- "dimensions": {
- "type": "string",
- "description": "List of real time dimensions."
- },
- "filters": {
- "type": "string",
- "description": "Comma-separated list of dimension or metric filters."
- },
- "ids": {
- "type": "string",
- "description": "Unique table ID."
- },
- "max-results": {
- "type": "integer",
- "description": "Maximum results per page.",
- "format": "int32"
- },
- "metrics": {
- "type": "array",
- "description": "List of real time metrics.",
- "items": {
- "type": "string"
- }
- },
- "sort": {
- "type": "array",
- "description": "List of dimensions or metrics based on which real time data is sorted.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "rows": {
- "type": "array",
- "description": "Real time data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.",
- "items": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "selfLink": {
- "type": "string",
- "description": "Link to this page."
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of rows for the query, regardless of the number of rows in the response.",
- "format": "int32"
- },
- "totalsForAllResults": {
- "type": "object",
- "description": "Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.",
- "additionalProperties": {
- "type": "string",
- "description": "Key-value pair for the total value of a metric. Key is the metric name and the value is the total value for that metric."
- }
- }
- }
- },
- "Segment": {
- "id": "Segment",
- "type": "object",
- "description": "JSON template for an Analytics segment.",
- "properties": {
- "created": {
- "type": "string",
- "description": "Time the segment was created.",
- "format": "date-time"
- },
- "definition": {
- "type": "string",
- "description": "Segment definition."
- },
- "id": {
- "type": "string",
- "description": "Segment ID."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for Analytics segment.",
- "default": "analytics#segment"
- },
- "name": {
- "type": "string",
- "description": "Segment name."
- },
- "segmentId": {
- "type": "string",
- "description": "Segment ID. Can be used with the 'segment' parameter in Core Reporting API."
- },
- "selfLink": {
- "type": "string",
- "description": "Link for this segment."
- },
- "type": {
- "type": "string",
- "description": "Type for a segment. Possible values are \"BUILT_IN\" or \"CUSTOM\"."
- },
- "updated": {
- "type": "string",
- "description": "Time the segment was last modified.",
- "format": "date-time"
- }
- }
- },
- "Segments": {
- "id": "Segments",
- "type": "object",
- "description": "An segment collection lists Analytics segments that the user has access to. Each resource in the collection corresponds to a single Analytics segment.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of segments.",
- "items": {
- "$ref": "Segment"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type for segments.",
- "default": "analytics#segments"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this segment collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this segment collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of results in the response.",
- "format": "int32"
- },
- "username": {
- "type": "string",
- "description": "Email ID of the authenticated user"
- }
- }
- },
- "UnsampledReport": {
- "id": "UnsampledReport",
- "type": "object",
- "description": "JSON template for Analytics unsampled report resource.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which this unsampled report belongs."
- },
- "cloudStorageDownloadDetails": {
- "type": "object",
- "description": "Download details for a file stored in Google Cloud Storage.",
- "readOnly": true,
- "properties": {
- "bucketId": {
- "type": "string",
- "description": "Id of the bucket the file object is stored in."
- },
- "objectId": {
- "type": "string",
- "description": "Id of the file object containing the report data."
- }
- }
- },
- "created": {
- "type": "string",
- "description": "Time this unsampled report was created.",
- "format": "date-time",
- "readOnly": true
- },
- "dimensions": {
- "type": "string",
- "description": "The dimensions for the unsampled report."
- },
- "downloadType": {
- "type": "string",
- "description": "The type of download you need to use for the report data file.",
- "readOnly": true
- },
- "driveDownloadDetails": {
- "type": "object",
- "description": "Download details for a file stored in Google Drive.",
- "readOnly": true,
- "properties": {
- "documentId": {
- "type": "string",
- "description": "Id of the document/file containing the report data."
- }
- }
- },
- "end-date": {
- "type": "string",
- "description": "The end date for the unsampled report.",
- "annotations": {
- "required": [
- "analytics.management.filters.insert",
- "analytics.management.unsampledReports.insert"
- ]
- }
- },
- "filters": {
- "type": "string",
- "description": "The filters for the unsampled report."
- },
- "id": {
- "type": "string",
- "description": "Unsampled report ID."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for an Analytics unsampled report.",
- "default": "analytics#unsampledReport",
- "readOnly": true
- },
- "metrics": {
- "type": "string",
- "description": "The metrics for the unsampled report.",
- "annotations": {
- "required": [
- "analytics.management.filters.insert",
- "analytics.management.unsampledReports.insert"
- ]
- }
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to which this unsampled report belongs."
- },
- "segment": {
- "type": "string",
- "description": "The segment for the unsampled report."
- },
- "selfLink": {
- "type": "string",
- "description": "Link for this unsampled report.",
- "readOnly": true
- },
- "start-date": {
- "type": "string",
- "description": "The start date for the unsampled report.",
- "annotations": {
- "required": [
- "analytics.management.filters.insert",
- "analytics.management.unsampledReports.insert"
- ]
- }
- },
- "status": {
- "type": "string",
- "description": "Status of this unsampled report. Possible values are PENDING, COMPLETED, or FAILED.",
- "readOnly": true
- },
- "title": {
- "type": "string",
- "description": "Title of the unsampled report.",
- "annotations": {
- "required": [
- "analytics.management.filters.insert",
- "analytics.management.unsampledReports.insert"
- ]
- }
- },
- "updated": {
- "type": "string",
- "description": "Time this unsampled report was last modified.",
- "format": "date-time",
- "readOnly": true
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY."
- }
- }
- },
- "UnsampledReports": {
- "id": "UnsampledReports",
- "type": "object",
- "description": "An unsampled report collection lists Analytics unsampled reports to which the user has access. Each view (profile) can have a set of unsampled reports. Each resource in the unsampled report collection corresponds to a single Analytics unsampled report.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of unsampled reports.",
- "items": {
- "$ref": "UnsampledReport"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#unsampledReports"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this unsampled report collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this unsampled report collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of resources in the result.",
- "format": "int32"
- },
- "username": {
- "type": "string",
- "description": "Email ID of the authenticated user"
- }
- }
- },
- "Upload": {
- "id": "Upload",
- "type": "object",
- "description": "Metadata returned for an upload operation.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account Id to which this upload belongs.",
- "format": "int64"
- },
- "customDataSourceId": {
- "type": "string",
- "description": "Custom data source Id to which this data import belongs."
- },
- "errors": {
- "type": "array",
- "description": "Data import errors collection.",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "type": "string",
- "description": "A unique ID for this upload."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for Analytics upload.",
- "default": "analytics#upload"
- },
- "status": {
- "type": "string",
- "description": "Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED."
- }
- }
- },
- "Uploads": {
- "id": "Uploads",
- "type": "object",
- "description": "Upload collection lists Analytics uploads to which the user has access. Each custom data source can have a set of uploads. Each resource in the upload collection corresponds to a single Analytics data upload.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of uploads.",
- "items": {
- "$ref": "Upload"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#uploads"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this upload collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this upload collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of resources in the result.",
- "format": "int32"
- }
- }
- },
- "UserRef": {
- "id": "UserRef",
- "type": "object",
- "description": "JSON template for a user reference.",
- "properties": {
- "email": {
- "type": "string",
- "description": "Email ID of this user."
- },
- "id": {
- "type": "string",
- "description": "User ID."
- },
- "kind": {
- "type": "string",
- "default": "analytics#userRef"
- }
- }
- },
- "WebPropertyRef": {
- "id": "WebPropertyRef",
- "type": "object",
- "description": "JSON template for a web property reference.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which this web property belongs."
- },
- "href": {
- "type": "string",
- "description": "Link for this web property."
- },
- "id": {
- "type": "string",
- "description": "Web property ID of the form UA-XXXXX-YY."
- },
- "internalWebPropertyId": {
- "type": "string",
- "description": "Internal ID for this web property."
- },
- "kind": {
- "type": "string",
- "description": "Analytics web property reference.",
- "default": "analytics#webPropertyRef"
- },
- "name": {
- "type": "string",
- "description": "Name of this web property."
- }
- }
- },
- "WebPropertySummary": {
- "id": "WebPropertySummary",
- "type": "object",
- "description": "JSON template for an Analytics WebPropertySummary. WebPropertySummary returns basic information (i.e., summary) for a web property.",
- "properties": {
- "id": {
- "type": "string",
- "description": "Web property ID of the form UA-XXXXX-YY."
- },
- "internalWebPropertyId": {
- "type": "string",
- "description": "Internal ID for this web property."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for Analytics WebPropertySummary.",
- "default": "analytics#webPropertySummary"
- },
- "level": {
- "type": "string",
- "description": "Level for this web property. Possible values are STANDARD or PREMIUM."
- },
- "name": {
- "type": "string",
- "description": "Web property name."
- },
- "profiles": {
- "type": "array",
- "description": "List of profiles under this web property.",
- "items": {
- "$ref": "ProfileSummary"
- }
- },
- "websiteUrl": {
- "type": "string",
- "description": "Website url for this web property."
- }
- }
- },
- "Webproperties": {
- "id": "Webproperties",
- "type": "object",
- "description": "A web property collection lists Analytics web properties to which the user has access. Each resource in the collection corresponds to a single Analytics web property.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of web properties.",
- "items": {
- "$ref": "Webproperty"
- }
- },
- "itemsPerPage": {
- "type": "integer",
- "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Collection type.",
- "default": "analytics#webproperties"
- },
- "nextLink": {
- "type": "string",
- "description": "Link to next page for this web property collection."
- },
- "previousLink": {
- "type": "string",
- "description": "Link to previous page for this web property collection."
- },
- "startIndex": {
- "type": "integer",
- "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "description": "The total number of results for the query, regardless of the number of results in the response.",
- "format": "int32"
- },
- "username": {
- "type": "string",
- "description": "Email ID of the authenticated user"
- }
- }
- },
- "Webproperty": {
- "id": "Webproperty",
- "type": "object",
- "description": "JSON template for an Analytics web property.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which this web property belongs."
- },
- "childLink": {
- "type": "object",
- "description": "Child link for this web property. Points to the list of views (profiles) for this web property.",
- "properties": {
- "href": {
- "type": "string",
- "description": "Link to the list of views (profiles) for this web property."
- },
- "type": {
- "type": "string",
- "description": "Type of the parent link. Its value is \"analytics#profiles\".",
- "default": "analytics#profiles"
- }
- }
- },
- "created": {
- "type": "string",
- "description": "Time this web property was created.",
- "format": "date-time",
- "readOnly": true
- },
- "defaultProfileId": {
- "type": "string",
- "description": "Default view (profile) ID.",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "Web property ID of the form UA-XXXXX-YY."
- },
- "industryVertical": {
- "type": "string",
- "description": "The industry vertical/category selected for this web property."
- },
- "internalWebPropertyId": {
- "type": "string",
- "description": "Internal ID for this web property.",
- "readOnly": true
- },
- "kind": {
- "type": "string",
- "description": "Resource type for Analytics WebProperty.",
- "default": "analytics#webproperty",
- "readOnly": true
- },
- "level": {
- "type": "string",
- "description": "Level for this web property. Possible values are STANDARD or PREMIUM.",
- "readOnly": true
- },
- "name": {
- "type": "string",
- "description": "Name of this web property."
- },
- "parentLink": {
- "type": "object",
- "description": "Parent link for this web property. Points to the account to which this web property belongs.",
- "properties": {
- "href": {
- "type": "string",
- "description": "Link to the account for this web property."
- },
- "type": {
- "type": "string",
- "description": "Type of the parent link. Its value is \"analytics#account\".",
- "default": "analytics#account"
- }
- }
- },
- "permissions": {
- "type": "object",
- "description": "Permissions the user has for this web property.",
- "properties": {
- "effective": {
- "type": "array",
- "description": "All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.",
- "readOnly": true,
- "items": {
- "type": "string"
- }
- }
- }
- },
- "profileCount": {
- "type": "integer",
- "description": "View (Profile) count for this web property.",
- "format": "int32",
- "readOnly": true
- },
- "selfLink": {
- "type": "string",
- "description": "Link for this web property.",
- "readOnly": true
- },
- "updated": {
- "type": "string",
- "description": "Time this web property was last modified.",
- "format": "date-time",
- "readOnly": true
- },
- "websiteUrl": {
- "type": "string",
- "description": "Website url for this web property."
- }
- }
- }
- },
- "resources": {
- "data": {
- "resources": {
- "ga": {
- "methods": {
- "get": {
- "id": "analytics.data.ga.get",
- "path": "data/ga",
- "httpMethod": "GET",
- "description": "Returns Analytics data for a view (profile).",
- "parameters": {
- "dimensions": {
- "type": "string",
- "description": "A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.",
- "pattern": "(ga:.+)?",
- "location": "query"
- },
- "end-date": {
- "type": "string",
- "description": "End date for fetching Analytics data. Request can should specify an end date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is yesterday.",
- "required": true,
- "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)",
- "location": "query"
- },
- "filters": {
- "type": "string",
- "description": "A comma-separated list of dimension or metric filters to be applied to Analytics data.",
- "pattern": "ga:.+",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.",
- "required": true,
- "pattern": "ga:[0-9]+",
- "location": "query"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of entries to include in this feed.",
- "format": "int32",
- "location": "query"
- },
- "metrics": {
- "type": "string",
- "description": "A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified.",
- "required": true,
- "pattern": "ga:.+",
- "location": "query"
- },
- "output": {
- "type": "string",
- "description": "The selected format for the response. Default format is JSON.",
- "enum": [
- "dataTable",
- "json"
- ],
- "enumDescriptions": [
- "Returns the response in Google Charts Data Table format. This is useful in creating visualization using Google Charts.",
- "Returns the response in standard JSON format."
- ],
- "location": "query"
- },
- "samplingLevel": {
- "type": "string",
- "description": "The desired sampling level.",
- "enum": [
- "DEFAULT",
- "FASTER",
- "HIGHER_PRECISION"
- ],
- "enumDescriptions": [
- "Returns response with a sample size that balances speed and accuracy.",
- "Returns a fast response with a smaller sample size.",
- "Returns a more accurate response using a large sample size, but this may result in the response being slower."
- ],
- "location": "query"
- },
- "segment": {
- "type": "string",
- "description": "An Analytics segment to be applied to data.",
- "location": "query"
- },
- "sort": {
- "type": "string",
- "description": "A comma-separated list of dimensions or metrics that determine the sort order for Analytics data.",
- "pattern": "(-)?ga:.+",
- "location": "query"
- },
- "start-date": {
- "type": "string",
- "description": "Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.",
- "required": true,
- "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- }
- },
- "parameterOrder": [
- "ids",
- "start-date",
- "end-date",
- "metrics"
- ],
- "response": {
- "$ref": "GaData"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
- },
- "mcf": {
- "methods": {
- "get": {
- "id": "analytics.data.mcf.get",
- "path": "data/mcf",
- "httpMethod": "GET",
- "description": "Returns Analytics Multi-Channel Funnels data for a view (profile).",
- "parameters": {
- "dimensions": {
- "type": "string",
- "description": "A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'.",
- "pattern": "(mcf:.+)?",
- "location": "query"
- },
- "end-date": {
- "type": "string",
- "description": "End date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.",
- "required": true,
- "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)",
- "location": "query"
- },
- "filters": {
- "type": "string",
- "description": "A comma-separated list of dimension or metric filters to be applied to the Analytics data.",
- "pattern": "mcf:.+",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.",
- "required": true,
- "pattern": "ga:[0-9]+",
- "location": "query"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of entries to include in this feed.",
- "format": "int32",
- "location": "query"
- },
- "metrics": {
- "type": "string",
- "description": "A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric must be specified.",
- "required": true,
- "pattern": "mcf:.+",
- "location": "query"
- },
- "samplingLevel": {
- "type": "string",
- "description": "The desired sampling level.",
- "enum": [
- "DEFAULT",
- "FASTER",
- "HIGHER_PRECISION"
- ],
- "enumDescriptions": [
- "Returns response with a sample size that balances speed and accuracy.",
- "Returns a fast response with a smaller sample size.",
- "Returns a more accurate response using a large sample size, but this may result in the response being slower."
- ],
- "location": "query"
- },
- "sort": {
- "type": "string",
- "description": "A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data.",
- "pattern": "(-)?mcf:.+",
- "location": "query"
- },
- "start-date": {
- "type": "string",
- "description": "Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.",
- "required": true,
- "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- }
- },
- "parameterOrder": [
- "ids",
- "start-date",
- "end-date",
- "metrics"
- ],
- "response": {
- "$ref": "McfData"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
- },
- "realtime": {
- "methods": {
- "get": {
- "id": "analytics.data.realtime.get",
- "path": "data/realtime",
- "httpMethod": "GET",
- "description": "Returns real time data for a view (profile).",
- "parameters": {
- "dimensions": {
- "type": "string",
- "description": "A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'.",
- "pattern": "(ga:.+)|(rt:.+)",
- "location": "query"
- },
- "filters": {
- "type": "string",
- "description": "A comma-separated list of dimension or metric filters to be applied to real time data.",
- "pattern": "(ga:.+)|(rt:.+)",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.",
- "required": true,
- "pattern": "ga:[0-9]+",
- "location": "query"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of entries to include in this feed.",
- "format": "int32",
- "location": "query"
- },
- "metrics": {
- "type": "string",
- "description": "A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified.",
- "required": true,
- "pattern": "(ga:.+)|(rt:.+)",
- "location": "query"
- },
- "sort": {
- "type": "string",
- "description": "A comma-separated list of dimensions or metrics that determine the sort order for real time data.",
- "pattern": "(-)?((ga:.+)|(rt:.+))",
- "location": "query"
- }
- },
- "parameterOrder": [
- "ids",
- "metrics"
- ],
- "response": {
- "$ref": "RealtimeData"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
- }
- }
- },
- "management": {
- "resources": {
- "accountSummaries": {
- "methods": {
- "list": {
- "id": "analytics.management.accountSummaries.list",
- "path": "management/accountSummaries",
- "httpMethod": "GET",
- "description": "Lists account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access.",
- "parameters": {
- "max-results": {
- "type": "integer",
- "description": "The maximum number of account summaries to include in this response, where the largest acceptable value is 1000.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- }
- },
- "response": {
- "$ref": "AccountSummaries"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
- },
- "accountUserLinks": {
- "methods": {
- "delete": {
- "id": "analytics.management.accountUserLinks.delete",
- "path": "management/accounts/{accountId}/entityUserLinks/{linkId}",
- "httpMethod": "DELETE",
- "description": "Removes a user from the given account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to delete the user link for.",
- "required": true,
- "location": "path"
- },
- "linkId": {
- "type": "string",
- "description": "Link ID to delete the user link for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "linkId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/analytics.manage.users"
- ]
- },
- "insert": {
- "id": "analytics.management.accountUserLinks.insert",
- "path": "management/accounts/{accountId}/entityUserLinks",
- "httpMethod": "POST",
- "description": "Adds a new user to the given account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to create the user link for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "request": {
- "$ref": "EntityUserLink"
- },
- "response": {
- "$ref": "EntityUserLink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.manage.users"
- ]
- },
- "list": {
- "id": "analytics.management.accountUserLinks.list",
- "path": "management/accounts/{accountId}/entityUserLinks",
- "httpMethod": "GET",
- "description": "Lists account-user links for a given account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to retrieve the user links for.",
- "required": true,
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of account-user links to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first account-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "EntityUserLinks"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.manage.users",
- "https://www.googleapis.com/auth/analytics.manage.users.readonly"
- ]
- },
- "update": {
- "id": "analytics.management.accountUserLinks.update",
- "path": "management/accounts/{accountId}/entityUserLinks/{linkId}",
- "httpMethod": "PUT",
- "description": "Updates permissions for an existing user on the given account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to update the account-user link for.",
- "required": true,
- "location": "path"
- },
- "linkId": {
- "type": "string",
- "description": "Link ID to update the account-user link for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "linkId"
- ],
- "request": {
- "$ref": "EntityUserLink"
- },
- "response": {
- "$ref": "EntityUserLink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.manage.users"
- ]
- }
- }
- },
- "accounts": {
- "methods": {
- "list": {
- "id": "analytics.management.accounts.list",
- "path": "management/accounts",
- "httpMethod": "GET",
- "description": "Lists all accounts to which the user has access.",
- "parameters": {
- "max-results": {
- "type": "integer",
- "description": "The maximum number of accounts to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Accounts"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
- },
- "customDataSources": {
- "methods": {
- "list": {
- "id": "analytics.management.customDataSources.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources",
- "httpMethod": "GET",
- "description": "List custom data sources to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account Id for the custom data sources to retrieve.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of custom data sources to include in this response.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "A 1-based index of the first custom data source to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property Id for the custom data sources to retrieve.",
- "required": true,
- "pattern": "UA-(\\d+)-(\\d+)",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "response": {
- "$ref": "CustomDataSources"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
- },
- "customDimensions": {
- "methods": {
- "get": {
- "id": "analytics.management.customDimensions.get",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}",
- "httpMethod": "GET",
- "description": "Get a custom dimension to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID for the custom dimension to retrieve.",
- "required": true,
- "location": "path"
- },
- "customDimensionId": {
- "type": "string",
- "description": "The ID of the custom dimension to retrieve.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID for the custom dimension to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "customDimensionId"
- ],
- "response": {
- "$ref": "CustomDimension"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "insert": {
- "id": "analytics.management.customDimensions.insert",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions",
- "httpMethod": "POST",
- "description": "Create a new custom dimension.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID for the custom dimension to create.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID for the custom dimension to create.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "request": {
- "$ref": "CustomDimension"
- },
- "response": {
- "$ref": "CustomDimension"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "list": {
- "id": "analytics.management.customDimensions.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions",
- "httpMethod": "GET",
- "description": "Lists custom dimensions to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID for the custom dimensions to retrieve.",
- "required": true,
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of custom dimensions to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID for the custom dimensions to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "response": {
- "$ref": "CustomDimensions"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "patch": {
- "id": "analytics.management.customDimensions.patch",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}",
- "httpMethod": "PATCH",
- "description": "Updates an existing custom dimension. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID for the custom dimension to update.",
- "required": true,
- "location": "path"
- },
- "customDimensionId": {
- "type": "string",
- "description": "Custom dimension ID for the custom dimension to update.",
- "required": true,
- "location": "path"
- },
- "ignoreCustomDataSourceLinks": {
- "type": "boolean",
- "description": "Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.",
- "default": "false",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID for the custom dimension to update.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "customDimensionId"
- ],
- "request": {
- "$ref": "CustomDimension"
- },
- "response": {
- "$ref": "CustomDimension"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "update": {
- "id": "analytics.management.customDimensions.update",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}",
- "httpMethod": "PUT",
- "description": "Updates an existing custom dimension.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID for the custom dimension to update.",
- "required": true,
- "location": "path"
- },
- "customDimensionId": {
- "type": "string",
- "description": "Custom dimension ID for the custom dimension to update.",
- "required": true,
- "location": "path"
- },
- "ignoreCustomDataSourceLinks": {
- "type": "boolean",
- "description": "Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.",
- "default": "false",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID for the custom dimension to update.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "customDimensionId"
- ],
- "request": {
- "$ref": "CustomDimension"
- },
- "response": {
- "$ref": "CustomDimension"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- }
- }
- },
- "customMetrics": {
- "methods": {
- "get": {
- "id": "analytics.management.customMetrics.get",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}",
- "httpMethod": "GET",
- "description": "Get a custom metric to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID for the custom metric to retrieve.",
- "required": true,
- "location": "path"
- },
- "customMetricId": {
- "type": "string",
- "description": "The ID of the custom metric to retrieve.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID for the custom metric to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "customMetricId"
- ],
- "response": {
- "$ref": "CustomMetric"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "insert": {
- "id": "analytics.management.customMetrics.insert",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics",
- "httpMethod": "POST",
- "description": "Create a new custom metric.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID for the custom metric to create.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID for the custom dimension to create.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "request": {
- "$ref": "CustomMetric"
- },
- "response": {
- "$ref": "CustomMetric"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "list": {
- "id": "analytics.management.customMetrics.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics",
- "httpMethod": "GET",
- "description": "Lists custom metrics to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID for the custom metrics to retrieve.",
- "required": true,
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of custom metrics to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID for the custom metrics to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "response": {
- "$ref": "CustomMetrics"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "patch": {
- "id": "analytics.management.customMetrics.patch",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}",
- "httpMethod": "PATCH",
- "description": "Updates an existing custom metric. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID for the custom metric to update.",
- "required": true,
- "location": "path"
- },
- "customMetricId": {
- "type": "string",
- "description": "Custom metric ID for the custom metric to update.",
- "required": true,
- "location": "path"
- },
- "ignoreCustomDataSourceLinks": {
- "type": "boolean",
- "description": "Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.",
- "default": "false",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID for the custom metric to update.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "customMetricId"
- ],
- "request": {
- "$ref": "CustomMetric"
- },
- "response": {
- "$ref": "CustomMetric"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "update": {
- "id": "analytics.management.customMetrics.update",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}",
- "httpMethod": "PUT",
- "description": "Updates an existing custom metric.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID for the custom metric to update.",
- "required": true,
- "location": "path"
- },
- "customMetricId": {
- "type": "string",
- "description": "Custom metric ID for the custom metric to update.",
- "required": true,
- "location": "path"
- },
- "ignoreCustomDataSourceLinks": {
- "type": "boolean",
- "description": "Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.",
- "default": "false",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID for the custom metric to update.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "customMetricId"
- ],
- "request": {
- "$ref": "CustomMetric"
- },
- "response": {
- "$ref": "CustomMetric"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- }
- }
- },
- "experiments": {
- "methods": {
- "delete": {
- "id": "analytics.management.experiments.delete",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}",
- "httpMethod": "DELETE",
- "description": "Delete an experiment.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which the experiment belongs",
- "required": true,
- "location": "path"
- },
- "experimentId": {
- "type": "string",
- "description": "ID of the experiment to delete",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to which the experiment belongs",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to which the experiment belongs",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "experimentId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "get": {
- "id": "analytics.management.experiments.get",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}",
- "httpMethod": "GET",
- "description": "Returns an experiment to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to retrieve the experiment for.",
- "required": true,
- "location": "path"
- },
- "experimentId": {
- "type": "string",
- "description": "Experiment ID to retrieve the experiment for.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to retrieve the experiment for.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to retrieve the experiment for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "experimentId"
- ],
- "response": {
- "$ref": "Experiment"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "insert": {
- "id": "analytics.management.experiments.insert",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments",
- "httpMethod": "POST",
- "description": "Create a new experiment.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to create the experiment for.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to create the experiment for.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to create the experiment for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "request": {
- "$ref": "Experiment"
- },
- "response": {
- "$ref": "Experiment"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "list": {
- "id": "analytics.management.experiments.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments",
- "httpMethod": "GET",
- "description": "Lists experiments to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to retrieve experiments for.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of experiments to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to retrieve experiments for.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first experiment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to retrieve experiments for.",
- "required": true,
- "pattern": "UA-(\\d+)-(\\d+)",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "response": {
- "$ref": "Experiments"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "patch": {
- "id": "analytics.management.experiments.patch",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}",
- "httpMethod": "PATCH",
- "description": "Update an existing experiment. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID of the experiment to update.",
- "required": true,
- "location": "path"
- },
- "experimentId": {
- "type": "string",
- "description": "Experiment ID of the experiment to update.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID of the experiment to update.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID of the experiment to update.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "experimentId"
- ],
- "request": {
- "$ref": "Experiment"
- },
- "response": {
- "$ref": "Experiment"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "update": {
- "id": "analytics.management.experiments.update",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}",
- "httpMethod": "PUT",
- "description": "Update an existing experiment.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID of the experiment to update.",
- "required": true,
- "location": "path"
- },
- "experimentId": {
- "type": "string",
- "description": "Experiment ID of the experiment to update.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID of the experiment to update.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID of the experiment to update.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "experimentId"
- ],
- "request": {
- "$ref": "Experiment"
- },
- "response": {
- "$ref": "Experiment"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- }
- }
- },
- "filters": {
- "methods": {
- "delete": {
- "id": "analytics.management.filters.delete",
- "path": "management/accounts/{accountId}/filters/{filterId}",
- "httpMethod": "DELETE",
- "description": "Delete a filter.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to delete the filter for.",
- "required": true,
- "location": "path"
- },
- "filterId": {
- "type": "string",
- "description": "ID of the filter to be deleted.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "filterId"
- ],
- "response": {
- "$ref": "Filter"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "get": {
- "id": "analytics.management.filters.get",
- "path": "management/accounts/{accountId}/filters/{filterId}",
- "httpMethod": "GET",
- "description": "Returns a filters to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to retrieve filters for.",
- "required": true,
- "location": "path"
- },
- "filterId": {
- "type": "string",
- "description": "Filter ID to retrieve filters for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "filterId"
- ],
- "response": {
- "$ref": "Filter"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "insert": {
- "id": "analytics.management.filters.insert",
- "path": "management/accounts/{accountId}/filters",
- "httpMethod": "POST",
- "description": "Create a new filter.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to create filter for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "request": {
- "$ref": "Filter"
- },
- "response": {
- "$ref": "Filter"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "list": {
- "id": "analytics.management.filters.list",
- "path": "management/accounts/{accountId}/filters",
- "httpMethod": "GET",
- "description": "Lists all filters for an account",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to retrieve filters for.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of filters to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "Filters"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "patch": {
- "id": "analytics.management.filters.patch",
- "path": "management/accounts/{accountId}/filters/{filterId}",
- "httpMethod": "PATCH",
- "description": "Updates an existing filter. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which the filter belongs.",
- "required": true,
- "location": "path"
- },
- "filterId": {
- "type": "string",
- "description": "ID of the filter to be updated.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "filterId"
- ],
- "request": {
- "$ref": "Filter"
- },
- "response": {
- "$ref": "Filter"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "update": {
- "id": "analytics.management.filters.update",
- "path": "management/accounts/{accountId}/filters/{filterId}",
- "httpMethod": "PUT",
- "description": "Updates an existing filter.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which the filter belongs.",
- "required": true,
- "location": "path"
- },
- "filterId": {
- "type": "string",
- "description": "ID of the filter to be updated.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "filterId"
- ],
- "request": {
- "$ref": "Filter"
- },
- "response": {
- "$ref": "Filter"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- }
- }
- },
- "goals": {
- "methods": {
- "get": {
- "id": "analytics.management.goals.get",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}",
- "httpMethod": "GET",
- "description": "Gets a goal to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to retrieve the goal for.",
- "required": true,
- "location": "path"
- },
- "goalId": {
- "type": "string",
- "description": "Goal ID to retrieve the goal for.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to retrieve the goal for.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to retrieve the goal for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "goalId"
- ],
- "response": {
- "$ref": "Goal"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "insert": {
- "id": "analytics.management.goals.insert",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals",
- "httpMethod": "POST",
- "description": "Create a new goal.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to create the goal for.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to create the goal for.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to create the goal for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "request": {
- "$ref": "Goal"
- },
- "response": {
- "$ref": "Goal"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "list": {
- "id": "analytics.management.goals.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals",
- "httpMethod": "GET",
- "description": "Lists goals to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.",
- "required": true,
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of goals to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to.",
- "required": true,
- "location": "path"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "response": {
- "$ref": "Goals"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "patch": {
- "id": "analytics.management.goals.patch",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}",
- "httpMethod": "PATCH",
- "description": "Updates an existing view (profile). This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to update the goal.",
- "required": true,
- "location": "path"
- },
- "goalId": {
- "type": "string",
- "description": "Index of the goal to be updated.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to update the goal.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to update the goal.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "goalId"
- ],
- "request": {
- "$ref": "Goal"
- },
- "response": {
- "$ref": "Goal"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "update": {
- "id": "analytics.management.goals.update",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}",
- "httpMethod": "PUT",
- "description": "Updates an existing view (profile).",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to update the goal.",
- "required": true,
- "location": "path"
- },
- "goalId": {
- "type": "string",
- "description": "Index of the goal to be updated.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to update the goal.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to update the goal.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "goalId"
- ],
- "request": {
- "$ref": "Goal"
- },
- "response": {
- "$ref": "Goal"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- }
- }
- },
- "profileFilterLinks": {
- "methods": {
- "delete": {
- "id": "analytics.management.profileFilterLinks.delete",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}",
- "httpMethod": "DELETE",
- "description": "Delete a profile filter link.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which the profile filter link belongs.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "linkId": {
- "type": "string",
- "description": "ID of the profile filter link to delete.",
- "required": true,
- "pattern": "\\d+:\\d+",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "Profile ID to which the filter link belongs.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property Id to which the profile filter link belongs.",
- "required": true,
- "pattern": "UA-(\\d+)-(\\d+)",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "linkId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "get": {
- "id": "analytics.management.profileFilterLinks.get",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}",
- "httpMethod": "GET",
- "description": "Returns a single profile filter link.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to retrieve profile filter link for.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "linkId": {
- "type": "string",
- "description": "ID of the profile filter link.",
- "required": true,
- "pattern": "\\d+:\\d+",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "Profile ID to retrieve filter link for.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property Id to retrieve profile filter link for.",
- "required": true,
- "pattern": "UA-(\\d+)-(\\d+)",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "linkId"
- ],
- "response": {
- "$ref": "ProfileFilterLink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "insert": {
- "id": "analytics.management.profileFilterLinks.insert",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks",
- "httpMethod": "POST",
- "description": "Create a new profile filter link.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to create profile filter link for.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "Profile ID to create filter link for.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property Id to create profile filter link for.",
- "required": true,
- "pattern": "UA-(\\d+)-(\\d+)",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "request": {
- "$ref": "ProfileFilterLink"
- },
- "response": {
- "$ref": "ProfileFilterLink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "list": {
- "id": "analytics.management.profileFilterLinks.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks",
- "httpMethod": "GET",
- "description": "Lists all profile filter links for a profile.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to retrieve profile filter links for.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of profile filter links to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "Profile ID to retrieve filter links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to.",
- "required": true,
- "location": "path"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property Id for profile filter links for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "response": {
- "$ref": "ProfileFilterLinks"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "patch": {
- "id": "analytics.management.profileFilterLinks.patch",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}",
- "httpMethod": "PATCH",
- "description": "Update an existing profile filter link. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which profile filter link belongs.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "linkId": {
- "type": "string",
- "description": "ID of the profile filter link to be updated.",
- "required": true,
- "pattern": "\\d+:\\d+",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "Profile ID to which filter link belongs",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property Id to which profile filter link belongs",
- "required": true,
- "pattern": "UA-(\\d+)-(\\d+)",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "linkId"
- ],
- "request": {
- "$ref": "ProfileFilterLink"
- },
- "response": {
- "$ref": "ProfileFilterLink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "update": {
- "id": "analytics.management.profileFilterLinks.update",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}",
- "httpMethod": "PUT",
- "description": "Update an existing profile filter link.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which profile filter link belongs.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "linkId": {
- "type": "string",
- "description": "ID of the profile filter link to be updated.",
- "required": true,
- "pattern": "\\d+:\\d+",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "Profile ID to which filter link belongs",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property Id to which profile filter link belongs",
- "required": true,
- "pattern": "UA-(\\d+)-(\\d+)",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "linkId"
- ],
- "request": {
- "$ref": "ProfileFilterLink"
- },
- "response": {
- "$ref": "ProfileFilterLink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- }
- }
- },
- "profileUserLinks": {
- "methods": {
- "delete": {
- "id": "analytics.management.profileUserLinks.delete",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}",
- "httpMethod": "DELETE",
- "description": "Removes a user from the given view (profile).",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to delete the user link for.",
- "required": true,
- "location": "path"
- },
- "linkId": {
- "type": "string",
- "description": "Link ID to delete the user link for.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to delete the user link for.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web Property ID to delete the user link for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "linkId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/analytics.manage.users"
- ]
- },
- "insert": {
- "id": "analytics.management.profileUserLinks.insert",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks",
- "httpMethod": "POST",
- "description": "Adds a new user to the given view (profile).",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to create the user link for.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to create the user link for.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web Property ID to create the user link for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "request": {
- "$ref": "EntityUserLink"
- },
- "response": {
- "$ref": "EntityUserLink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.manage.users"
- ]
- },
- "list": {
- "id": "analytics.management.profileUserLinks.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks",
- "httpMethod": "GET",
- "description": "Lists profile-user links for a given view (profile).",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID which the given view (profile) belongs to.",
- "required": true,
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of profile-user links to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to retrieve the profile-user links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to.",
- "required": true,
- "location": "path"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first profile-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web Property ID which the given view (profile) belongs to. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "response": {
- "$ref": "EntityUserLinks"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.manage.users",
- "https://www.googleapis.com/auth/analytics.manage.users.readonly"
- ]
- },
- "update": {
- "id": "analytics.management.profileUserLinks.update",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}",
- "httpMethod": "PUT",
- "description": "Updates permissions for an existing user on the given view (profile).",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to update the user link for.",
- "required": true,
- "location": "path"
- },
- "linkId": {
- "type": "string",
- "description": "Link ID to update the user link for.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile ID) to update the user link for.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web Property ID to update the user link for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "linkId"
- ],
- "request": {
- "$ref": "EntityUserLink"
- },
- "response": {
- "$ref": "EntityUserLink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.manage.users"
- ]
- }
- }
- },
- "profiles": {
- "methods": {
- "delete": {
- "id": "analytics.management.profiles.delete",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}",
- "httpMethod": "DELETE",
- "description": "Deletes a view (profile).",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to delete the view (profile) for.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "ID of the view (profile) to be deleted.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to delete the view (profile) for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "get": {
- "id": "analytics.management.profiles.get",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}",
- "httpMethod": "GET",
- "description": "Gets a view (profile) to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to retrieve the goal for.",
- "required": true,
- "pattern": "[0-9]+",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to retrieve the goal for.",
- "required": true,
- "pattern": "[0-9]+",
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to retrieve the goal for.",
- "required": true,
- "pattern": "UA-[0-9]+-[0-9]+",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "response": {
- "$ref": "Profile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "insert": {
- "id": "analytics.management.profiles.insert",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles",
- "httpMethod": "POST",
- "description": "Create a new view (profile).",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to create the view (profile) for.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to create the view (profile) for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "request": {
- "$ref": "Profile"
- },
- "response": {
- "$ref": "Profile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "list": {
- "id": "analytics.management.profiles.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles",
- "httpMethod": "GET",
- "description": "Lists views (profiles) to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID for the view (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access.",
- "required": true,
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of views (profiles) to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "response": {
- "$ref": "Profiles"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "patch": {
- "id": "analytics.management.profiles.patch",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}",
- "httpMethod": "PATCH",
- "description": "Updates an existing view (profile). This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which the view (profile) belongs",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "ID of the view (profile) to be updated.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to which the view (profile) belongs",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "request": {
- "$ref": "Profile"
- },
- "response": {
- "$ref": "Profile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "update": {
- "id": "analytics.management.profiles.update",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}",
- "httpMethod": "PUT",
- "description": "Updates an existing view (profile).",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which the view (profile) belongs",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "ID of the view (profile) to be updated.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to which the view (profile) belongs",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "request": {
- "$ref": "Profile"
- },
- "response": {
- "$ref": "Profile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- }
- }
- },
- "segments": {
- "methods": {
- "list": {
- "id": "analytics.management.segments.list",
- "path": "management/segments",
- "httpMethod": "GET",
- "description": "Lists segments to which the user has access.",
- "parameters": {
- "max-results": {
- "type": "integer",
- "description": "The maximum number of segments to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Segments"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
- },
- "unsampledReports": {
- "methods": {
- "get": {
- "id": "analytics.management.unsampledReports.get",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}",
- "httpMethod": "GET",
- "description": "Returns a single unsampled report.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to retrieve unsampled report for.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to retrieve unsampled report for.",
- "required": true,
- "location": "path"
- },
- "unsampledReportId": {
- "type": "string",
- "description": "ID of the unsampled report to retrieve.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to retrieve unsampled reports for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId",
- "unsampledReportId"
- ],
- "response": {
- "$ref": "UnsampledReport"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "insert": {
- "id": "analytics.management.unsampledReports.insert",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports",
- "httpMethod": "POST",
- "description": "Create a new unsampled report.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to create the unsampled report for.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to create the unsampled report for.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to create the unsampled report for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "request": {
- "$ref": "UnsampledReport"
- },
- "response": {
- "$ref": "UnsampledReport"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "list": {
- "id": "analytics.management.unsampledReports.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports",
- "httpMethod": "GET",
- "description": "Lists unsampled reports to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to retrieve unsampled reports for. Must be a specific account ID, ~all is not supported.",
- "required": true,
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of unsampled reports to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "View (Profile) ID to retrieve unsampled reports for. Must be a specific view (profile) ID, ~all is not supported.",
- "required": true,
- "location": "path"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first unsampled report to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to retrieve unsampled reports for. Must be a specific web property ID, ~all is not supported.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "profileId"
- ],
- "response": {
- "$ref": "UnsampledReports"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
- },
- "uploads": {
- "methods": {
- "deleteUploadData": {
- "id": "analytics.management.uploads.deleteUploadData",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/deleteUploadData",
- "httpMethod": "POST",
- "description": "Delete data associated with a previous upload.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account Id for the uploads to be deleted.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "customDataSourceId": {
- "type": "string",
- "description": "Custom data source Id for the uploads to be deleted.",
- "required": true,
- "pattern": ".{22}",
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property Id for the uploads to be deleted.",
- "required": true,
- "pattern": "UA-(\\d+)-(\\d+)",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "customDataSourceId"
- ],
- "request": {
- "$ref": "AnalyticsDataimportDeleteUploadDataRequest"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "get": {
- "id": "analytics.management.uploads.get",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads/{uploadId}",
- "httpMethod": "GET",
- "description": "List uploads to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account Id for the upload to retrieve.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "customDataSourceId": {
- "type": "string",
- "description": "Custom data source Id for upload to retrieve.",
- "required": true,
- "pattern": ".{22}",
- "location": "path"
- },
- "uploadId": {
- "type": "string",
- "description": "Upload Id to retrieve.",
- "required": true,
- "pattern": ".{22}",
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property Id for the upload to retrieve.",
- "required": true,
- "pattern": "UA-(\\d+)-(\\d+)",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "customDataSourceId",
- "uploadId"
- ],
- "response": {
- "$ref": "Upload"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "list": {
- "id": "analytics.management.uploads.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads",
- "httpMethod": "GET",
- "description": "List uploads to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account Id for the uploads to retrieve.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "customDataSourceId": {
- "type": "string",
- "description": "Custom data source Id for uploads to retrieve.",
- "required": true,
- "pattern": ".{22}",
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of uploads to include in this response.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "A 1-based index of the first upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property Id for the uploads to retrieve.",
- "required": true,
- "pattern": "UA-(\\d+)-(\\d+)",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "customDataSourceId"
- ],
- "response": {
- "$ref": "Uploads"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "uploadData": {
- "id": "analytics.management.uploads.uploadData",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads",
- "httpMethod": "POST",
- "description": "Upload data for a custom data source.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account Id associated with the upload.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "customDataSourceId": {
- "type": "string",
- "description": "Custom data source Id to which the data being uploaded belongs.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property UA-string associated with the upload.",
- "required": true,
- "pattern": "UA-\\d+-\\d+",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "customDataSourceId"
- ],
- "response": {
- "$ref": "Upload"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit"
- ],
- "supportsMediaUpload": true,
- "mediaUpload": {
- "accept": [
- "application/octet-stream"
- ],
- "maxSize": "1GB",
- "protocols": {
- "simple": {
- "multipart": true,
- "path": "/upload/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads"
- },
- "resumable": {
- "multipart": true,
- "path": "/resumable/upload/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads"
- }
- }
- }
- }
- }
- },
- "webPropertyAdWordsLinks": {
- "methods": {
- "delete": {
- "id": "analytics.management.webPropertyAdWordsLinks.delete",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}",
- "httpMethod": "DELETE",
- "description": "Deletes a web property-AdWords link.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "ID of the account which the given web property belongs to.",
- "required": true,
- "location": "path"
- },
- "webPropertyAdWordsLinkId": {
- "type": "string",
- "description": "Web property AdWords link ID.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to delete the AdWords link for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "webPropertyAdWordsLinkId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "get": {
- "id": "analytics.management.webPropertyAdWordsLinks.get",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}",
- "httpMethod": "GET",
- "description": "Returns a web property-AdWords link to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "ID of the account which the given web property belongs to.",
- "required": true,
- "location": "path"
- },
- "webPropertyAdWordsLinkId": {
- "type": "string",
- "description": "Web property-AdWords link ID.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to retrieve the AdWords link for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "webPropertyAdWordsLinkId"
- ],
- "response": {
- "$ref": "EntityAdWordsLink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "insert": {
- "id": "analytics.management.webPropertyAdWordsLinks.insert",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks",
- "httpMethod": "POST",
- "description": "Creates a webProperty-AdWords link.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "ID of the Google Analytics account to create the link for.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to create the link for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "request": {
- "$ref": "EntityAdWordsLink"
- },
- "response": {
- "$ref": "EntityAdWordsLink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "list": {
- "id": "analytics.management.webPropertyAdWordsLinks.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks",
- "httpMethod": "GET",
- "description": "Lists webProperty-AdWords links for a given web property.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "ID of the account which the given web property belongs to.",
- "required": true,
- "pattern": "\\d+",
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of webProperty-AdWords links to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first webProperty-AdWords link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to retrieve the AdWords links for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "response": {
- "$ref": "EntityAdWordsLinks"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "patch": {
- "id": "analytics.management.webPropertyAdWordsLinks.patch",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}",
- "httpMethod": "PATCH",
- "description": "Updates an existing webProperty-AdWords link. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "ID of the account which the given web property belongs to.",
- "required": true,
- "location": "path"
- },
- "webPropertyAdWordsLinkId": {
- "type": "string",
- "description": "Web property-AdWords link ID.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to retrieve the AdWords link for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "webPropertyAdWordsLinkId"
- ],
- "request": {
- "$ref": "EntityAdWordsLink"
- },
- "response": {
- "$ref": "EntityAdWordsLink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "update": {
- "id": "analytics.management.webPropertyAdWordsLinks.update",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}",
- "httpMethod": "PUT",
- "description": "Updates an existing webProperty-AdWords link.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "ID of the account which the given web property belongs to.",
- "required": true,
- "location": "path"
- },
- "webPropertyAdWordsLinkId": {
- "type": "string",
- "description": "Web property-AdWords link ID.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to retrieve the AdWords link for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "webPropertyAdWordsLinkId"
- ],
- "request": {
- "$ref": "EntityAdWordsLink"
- },
- "response": {
- "$ref": "EntityAdWordsLink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- }
- }
- },
- "webproperties": {
- "methods": {
- "get": {
- "id": "analytics.management.webproperties.get",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}",
- "httpMethod": "GET",
- "description": "Gets a web property to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to retrieve the web property for.",
- "required": true,
- "pattern": "[0-9]+",
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "ID to retrieve the web property for.",
- "required": true,
- "pattern": "UA-[0-9]+-[0-9]+",
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "response": {
- "$ref": "Webproperty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "insert": {
- "id": "analytics.management.webproperties.insert",
- "path": "management/accounts/{accountId}/webproperties",
- "httpMethod": "POST",
- "description": "Create a new property if the account has fewer than 20 properties. Web properties are visible in the Google Analytics interface only if they have at least one profile.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to create the web property for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "request": {
- "$ref": "Webproperty"
- },
- "response": {
- "$ref": "Webproperty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "list": {
- "id": "analytics.management.webproperties.list",
- "path": "management/accounts/{accountId}/webproperties",
- "httpMethod": "GET",
- "description": "Lists web properties to which the user has access.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.",
- "required": true,
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of web properties to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "Webproperties"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- },
- "patch": {
- "id": "analytics.management.webproperties.patch",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}",
- "httpMethod": "PATCH",
- "description": "Updates an existing web property. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which the web property belongs",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "request": {
- "$ref": "Webproperty"
- },
- "response": {
- "$ref": "Webproperty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- },
- "update": {
- "id": "analytics.management.webproperties.update",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}",
- "httpMethod": "PUT",
- "description": "Updates an existing web property.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to which the web property belongs",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "request": {
- "$ref": "Webproperty"
- },
- "response": {
- "$ref": "Webproperty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.edit"
- ]
- }
- }
- },
- "webpropertyUserLinks": {
- "methods": {
- "delete": {
- "id": "analytics.management.webpropertyUserLinks.delete",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}",
- "httpMethod": "DELETE",
- "description": "Removes a user from the given web property.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to delete the user link for.",
- "required": true,
- "location": "path"
- },
- "linkId": {
- "type": "string",
- "description": "Link ID to delete the user link for.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web Property ID to delete the user link for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "linkId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/analytics.manage.users"
- ]
- },
- "insert": {
- "id": "analytics.management.webpropertyUserLinks.insert",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks",
- "httpMethod": "POST",
- "description": "Adds a new user to the given web property.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to create the user link for.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web Property ID to create the user link for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "request": {
- "$ref": "EntityUserLink"
- },
- "response": {
- "$ref": "EntityUserLink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.manage.users"
- ]
- },
- "list": {
- "id": "analytics.management.webpropertyUserLinks.list",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks",
- "httpMethod": "GET",
- "description": "Lists webProperty-user links for a given web property.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID which the given web property belongs to.",
- "required": true,
- "location": "path"
- },
- "max-results": {
- "type": "integer",
- "description": "The maximum number of webProperty-user Links to include in this response.",
- "format": "int32",
- "location": "query"
- },
- "start-index": {
- "type": "integer",
- "description": "An index of the first webProperty-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web Property ID for the webProperty-user links to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId"
- ],
- "response": {
- "$ref": "EntityUserLinks"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.manage.users",
- "https://www.googleapis.com/auth/analytics.manage.users.readonly"
- ]
- },
- "update": {
- "id": "analytics.management.webpropertyUserLinks.update",
- "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}",
- "httpMethod": "PUT",
- "description": "Updates permissions for an existing user on the given web property.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "Account ID to update the account-user link for.",
- "required": true,
- "location": "path"
- },
- "linkId": {
- "type": "string",
- "description": "Link ID to update the account-user link for.",
- "required": true,
- "location": "path"
- },
- "webPropertyId": {
- "type": "string",
- "description": "Web property ID to update the account-user link for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "webPropertyId",
- "linkId"
- ],
- "request": {
- "$ref": "EntityUserLink"
- },
- "response": {
- "$ref": "EntityUserLink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.manage.users"
- ]
- }
- }
- }
- }
- },
- "metadata": {
- "resources": {
- "columns": {
- "methods": {
- "list": {
- "id": "analytics.metadata.columns.list",
- "path": "metadata/{reportType}/columns",
- "httpMethod": "GET",
- "description": "Lists all columns for a report type",
- "parameters": {
- "reportType": {
- "type": "string",
- "description": "Report type. Allowed Values: 'ga'. Where 'ga' corresponds to the Core Reporting API",
- "required": true,
- "pattern": "ga",
- "location": "path"
- }
- },
- "parameterOrder": [
- "reportType"
- ],
- "response": {
- "$ref": "Columns"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.edit",
- "https://www.googleapis.com/auth/analytics.readonly"
- ]
- }
- }
- }
- }
- },
- "provisioning": {
- "methods": {
- "createAccountTicket": {
- "id": "analytics.provisioning.createAccountTicket",
- "path": "provisioning/createAccountTicket",
- "httpMethod": "POST",
- "description": "Creates an account ticket.",
- "request": {
- "$ref": "AccountTicket"
- },
- "response": {
- "$ref": "AccountTicket"
- },
- "scopes": [
- "https://www.googleapis.com/auth/analytics.provision"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/analytics/v3/analytics-gen.go b/vendor/google.golang.org/api/analytics/v3/analytics-gen.go
deleted file mode 100644
index 634d8ba8..00000000
--- a/vendor/google.golang.org/api/analytics/v3/analytics-gen.go
+++ /dev/null
@@ -1,16243 +0,0 @@
-// Package analytics provides access to the Google Analytics API.
-//
-// See https://developers.google.com/analytics/
-//
-// Usage example:
-//
-// import "google.golang.org/api/analytics/v3"
-// ...
-// analyticsService, err := analytics.New(oauthHttpClient)
-package analytics // import "google.golang.org/api/analytics/v3"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "analytics:v3"
-const apiName = "analytics"
-const apiVersion = "v3"
-const basePath = "https://www.googleapis.com/analytics/v3/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your Google Analytics data
- AnalyticsScope = "https://www.googleapis.com/auth/analytics"
-
- // Edit Google Analytics management entities
- AnalyticsEditScope = "https://www.googleapis.com/auth/analytics.edit"
-
- // Manage Google Analytics Account users by email address
- AnalyticsManageUsersScope = "https://www.googleapis.com/auth/analytics.manage.users"
-
- // View Google Analytics user permissions
- AnalyticsManageUsersReadonlyScope = "https://www.googleapis.com/auth/analytics.manage.users.readonly"
-
- // Create a new Google Analytics account along with its default property
- // and view
- AnalyticsProvisionScope = "https://www.googleapis.com/auth/analytics.provision"
-
- // View your Google Analytics data
- AnalyticsReadonlyScope = "https://www.googleapis.com/auth/analytics.readonly"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Data = NewDataService(s)
- s.Management = NewManagementService(s)
- s.Metadata = NewMetadataService(s)
- s.Provisioning = NewProvisioningService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Data *DataService
-
- Management *ManagementService
-
- Metadata *MetadataService
-
- Provisioning *ProvisioningService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewDataService(s *Service) *DataService {
- rs := &DataService{s: s}
- rs.Ga = NewDataGaService(s)
- rs.Mcf = NewDataMcfService(s)
- rs.Realtime = NewDataRealtimeService(s)
- return rs
-}
-
-type DataService struct {
- s *Service
-
- Ga *DataGaService
-
- Mcf *DataMcfService
-
- Realtime *DataRealtimeService
-}
-
-func NewDataGaService(s *Service) *DataGaService {
- rs := &DataGaService{s: s}
- return rs
-}
-
-type DataGaService struct {
- s *Service
-}
-
-func NewDataMcfService(s *Service) *DataMcfService {
- rs := &DataMcfService{s: s}
- return rs
-}
-
-type DataMcfService struct {
- s *Service
-}
-
-func NewDataRealtimeService(s *Service) *DataRealtimeService {
- rs := &DataRealtimeService{s: s}
- return rs
-}
-
-type DataRealtimeService struct {
- s *Service
-}
-
-func NewManagementService(s *Service) *ManagementService {
- rs := &ManagementService{s: s}
- rs.AccountSummaries = NewManagementAccountSummariesService(s)
- rs.AccountUserLinks = NewManagementAccountUserLinksService(s)
- rs.Accounts = NewManagementAccountsService(s)
- rs.CustomDataSources = NewManagementCustomDataSourcesService(s)
- rs.CustomDimensions = NewManagementCustomDimensionsService(s)
- rs.CustomMetrics = NewManagementCustomMetricsService(s)
- rs.Experiments = NewManagementExperimentsService(s)
- rs.Filters = NewManagementFiltersService(s)
- rs.Goals = NewManagementGoalsService(s)
- rs.ProfileFilterLinks = NewManagementProfileFilterLinksService(s)
- rs.ProfileUserLinks = NewManagementProfileUserLinksService(s)
- rs.Profiles = NewManagementProfilesService(s)
- rs.Segments = NewManagementSegmentsService(s)
- rs.UnsampledReports = NewManagementUnsampledReportsService(s)
- rs.Uploads = NewManagementUploadsService(s)
- rs.WebPropertyAdWordsLinks = NewManagementWebPropertyAdWordsLinksService(s)
- rs.Webproperties = NewManagementWebpropertiesService(s)
- rs.WebpropertyUserLinks = NewManagementWebpropertyUserLinksService(s)
- return rs
-}
-
-type ManagementService struct {
- s *Service
-
- AccountSummaries *ManagementAccountSummariesService
-
- AccountUserLinks *ManagementAccountUserLinksService
-
- Accounts *ManagementAccountsService
-
- CustomDataSources *ManagementCustomDataSourcesService
-
- CustomDimensions *ManagementCustomDimensionsService
-
- CustomMetrics *ManagementCustomMetricsService
-
- Experiments *ManagementExperimentsService
-
- Filters *ManagementFiltersService
-
- Goals *ManagementGoalsService
-
- ProfileFilterLinks *ManagementProfileFilterLinksService
-
- ProfileUserLinks *ManagementProfileUserLinksService
-
- Profiles *ManagementProfilesService
-
- Segments *ManagementSegmentsService
-
- UnsampledReports *ManagementUnsampledReportsService
-
- Uploads *ManagementUploadsService
-
- WebPropertyAdWordsLinks *ManagementWebPropertyAdWordsLinksService
-
- Webproperties *ManagementWebpropertiesService
-
- WebpropertyUserLinks *ManagementWebpropertyUserLinksService
-}
-
-func NewManagementAccountSummariesService(s *Service) *ManagementAccountSummariesService {
- rs := &ManagementAccountSummariesService{s: s}
- return rs
-}
-
-type ManagementAccountSummariesService struct {
- s *Service
-}
-
-func NewManagementAccountUserLinksService(s *Service) *ManagementAccountUserLinksService {
- rs := &ManagementAccountUserLinksService{s: s}
- return rs
-}
-
-type ManagementAccountUserLinksService struct {
- s *Service
-}
-
-func NewManagementAccountsService(s *Service) *ManagementAccountsService {
- rs := &ManagementAccountsService{s: s}
- return rs
-}
-
-type ManagementAccountsService struct {
- s *Service
-}
-
-func NewManagementCustomDataSourcesService(s *Service) *ManagementCustomDataSourcesService {
- rs := &ManagementCustomDataSourcesService{s: s}
- return rs
-}
-
-type ManagementCustomDataSourcesService struct {
- s *Service
-}
-
-func NewManagementCustomDimensionsService(s *Service) *ManagementCustomDimensionsService {
- rs := &ManagementCustomDimensionsService{s: s}
- return rs
-}
-
-type ManagementCustomDimensionsService struct {
- s *Service
-}
-
-func NewManagementCustomMetricsService(s *Service) *ManagementCustomMetricsService {
- rs := &ManagementCustomMetricsService{s: s}
- return rs
-}
-
-type ManagementCustomMetricsService struct {
- s *Service
-}
-
-func NewManagementExperimentsService(s *Service) *ManagementExperimentsService {
- rs := &ManagementExperimentsService{s: s}
- return rs
-}
-
-type ManagementExperimentsService struct {
- s *Service
-}
-
-func NewManagementFiltersService(s *Service) *ManagementFiltersService {
- rs := &ManagementFiltersService{s: s}
- return rs
-}
-
-type ManagementFiltersService struct {
- s *Service
-}
-
-func NewManagementGoalsService(s *Service) *ManagementGoalsService {
- rs := &ManagementGoalsService{s: s}
- return rs
-}
-
-type ManagementGoalsService struct {
- s *Service
-}
-
-func NewManagementProfileFilterLinksService(s *Service) *ManagementProfileFilterLinksService {
- rs := &ManagementProfileFilterLinksService{s: s}
- return rs
-}
-
-type ManagementProfileFilterLinksService struct {
- s *Service
-}
-
-func NewManagementProfileUserLinksService(s *Service) *ManagementProfileUserLinksService {
- rs := &ManagementProfileUserLinksService{s: s}
- return rs
-}
-
-type ManagementProfileUserLinksService struct {
- s *Service
-}
-
-func NewManagementProfilesService(s *Service) *ManagementProfilesService {
- rs := &ManagementProfilesService{s: s}
- return rs
-}
-
-type ManagementProfilesService struct {
- s *Service
-}
-
-func NewManagementSegmentsService(s *Service) *ManagementSegmentsService {
- rs := &ManagementSegmentsService{s: s}
- return rs
-}
-
-type ManagementSegmentsService struct {
- s *Service
-}
-
-func NewManagementUnsampledReportsService(s *Service) *ManagementUnsampledReportsService {
- rs := &ManagementUnsampledReportsService{s: s}
- return rs
-}
-
-type ManagementUnsampledReportsService struct {
- s *Service
-}
-
-func NewManagementUploadsService(s *Service) *ManagementUploadsService {
- rs := &ManagementUploadsService{s: s}
- return rs
-}
-
-type ManagementUploadsService struct {
- s *Service
-}
-
-func NewManagementWebPropertyAdWordsLinksService(s *Service) *ManagementWebPropertyAdWordsLinksService {
- rs := &ManagementWebPropertyAdWordsLinksService{s: s}
- return rs
-}
-
-type ManagementWebPropertyAdWordsLinksService struct {
- s *Service
-}
-
-func NewManagementWebpropertiesService(s *Service) *ManagementWebpropertiesService {
- rs := &ManagementWebpropertiesService{s: s}
- return rs
-}
-
-type ManagementWebpropertiesService struct {
- s *Service
-}
-
-func NewManagementWebpropertyUserLinksService(s *Service) *ManagementWebpropertyUserLinksService {
- rs := &ManagementWebpropertyUserLinksService{s: s}
- return rs
-}
-
-type ManagementWebpropertyUserLinksService struct {
- s *Service
-}
-
-func NewMetadataService(s *Service) *MetadataService {
- rs := &MetadataService{s: s}
- rs.Columns = NewMetadataColumnsService(s)
- return rs
-}
-
-type MetadataService struct {
- s *Service
-
- Columns *MetadataColumnsService
-}
-
-func NewMetadataColumnsService(s *Service) *MetadataColumnsService {
- rs := &MetadataColumnsService{s: s}
- return rs
-}
-
-type MetadataColumnsService struct {
- s *Service
-}
-
-func NewProvisioningService(s *Service) *ProvisioningService {
- rs := &ProvisioningService{s: s}
- return rs
-}
-
-type ProvisioningService struct {
- s *Service
-}
-
-// Account: JSON template for Analytics account entry.
-type Account struct {
- // ChildLink: Child link for an account entry. Points to the list of web
- // properties for this account.
- ChildLink *AccountChildLink `json:"childLink,omitempty"`
-
- // Created: Time the account was created.
- Created string `json:"created,omitempty"`
-
- // Id: Account ID.
- Id string `json:"id,omitempty"`
-
- // Kind: Resource type for Analytics account.
- Kind string `json:"kind,omitempty"`
-
- // Name: Account name.
- Name string `json:"name,omitempty"`
-
- // Permissions: Permissions the user has for this account.
- Permissions *AccountPermissions `json:"permissions,omitempty"`
-
- // SelfLink: Link for this account.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Updated: Time the account was last modified.
- Updated string `json:"updated,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ChildLink") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Account) MarshalJSON() ([]byte, error) {
- type noMethod Account
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountChildLink: Child link for an account entry. Points to the list
-// of web properties for this account.
-type AccountChildLink struct {
- // Href: Link to the list of web properties for this account.
- Href string `json:"href,omitempty"`
-
- // Type: Type of the child link. Its value is "analytics#webproperties".
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Href") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountChildLink) MarshalJSON() ([]byte, error) {
- type noMethod AccountChildLink
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountPermissions: Permissions the user has for this account.
-type AccountPermissions struct {
- // Effective: All the permissions that the user has for this account.
- // These include any implied permissions (e.g., EDIT implies VIEW).
- Effective []string `json:"effective,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Effective") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountPermissions) MarshalJSON() ([]byte, error) {
- type noMethod AccountPermissions
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountRef: JSON template for a linked account.
-type AccountRef struct {
- // Href: Link for this account.
- Href string `json:"href,omitempty"`
-
- // Id: Account ID.
- Id string `json:"id,omitempty"`
-
- // Kind: Analytics account reference.
- Kind string `json:"kind,omitempty"`
-
- // Name: Account name.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Href") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountRef) MarshalJSON() ([]byte, error) {
- type noMethod AccountRef
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountSummaries: An AccountSummary collection lists a summary of
-// accounts, properties and views (profiles) to which the user has
-// access. Each resource in the collection corresponds to a single
-// AccountSummary.
-type AccountSummaries struct {
- // Items: A list of AccountSummaries.
- Items []*AccountSummary `json:"items,omitempty"`
-
- // ItemsPerPage: The maximum number of resources the response can
- // contain, regardless of the actual number of resources returned. Its
- // value ranges from 1 to 1000 with a value of 1000 by default, or
- // otherwise specified by the max-results query parameter.
- ItemsPerPage int64 `json:"itemsPerPage,omitempty"`
-
- // Kind: Collection type.
- Kind string `json:"kind,omitempty"`
-
- // NextLink: Link to next page for this AccountSummary collection.
- NextLink string `json:"nextLink,omitempty"`
-
- // PreviousLink: Link to previous page for this AccountSummary
- // collection.
- PreviousLink string `json:"previousLink,omitempty"`
-
- // StartIndex: The starting index of the resources, which is 1 by
- // default or otherwise specified by the start-index query parameter.
- StartIndex int64 `json:"startIndex,omitempty"`
-
- // TotalResults: The total number of results for the query, regardless
- // of the number of results in the response.
- TotalResults int64 `json:"totalResults,omitempty"`
-
- // Username: Email ID of the authenticated user
- Username string `json:"username,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountSummaries) MarshalJSON() ([]byte, error) {
- type noMethod AccountSummaries
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountSummary: JSON template for an Analytics AccountSummary. An
-// AccountSummary is a lightweight tree comprised of
-// properties/profiles.
-type AccountSummary struct {
- // Id: Account ID.
- Id string `json:"id,omitempty"`
-
- // Kind: Resource type for Analytics AccountSummary.
- Kind string `json:"kind,omitempty"`
-
- // Name: Account name.
- Name string `json:"name,omitempty"`
-
- // WebProperties: List of web properties under this account.
- WebProperties []*WebPropertySummary `json:"webProperties,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountSummary) MarshalJSON() ([]byte, error) {
- type noMethod AccountSummary
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountTicket: JSON template for an Analytics account ticket. The
-// account ticket consists of the ticket ID and the basic information
-// for the account, property and profile.
-type AccountTicket struct {
- // Account: Account for this ticket.
- Account *Account `json:"account,omitempty"`
-
- // Id: Account ticket ID used to access the account ticket.
- Id string `json:"id,omitempty"`
-
- // Kind: Resource type for account ticket.
- Kind string `json:"kind,omitempty"`
-
- // Profile: View (Profile) for the account.
- Profile *Profile `json:"profile,omitempty"`
-
- // RedirectUri: Redirect URI where the user will be sent after accepting
- // Terms of Service. Must be configured in APIs console as a callback
- // URL.
- RedirectUri string `json:"redirectUri,omitempty"`
-
- // Webproperty: Web property for the account.
- Webproperty *Webproperty `json:"webproperty,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Account") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountTicket) MarshalJSON() ([]byte, error) {
- type noMethod AccountTicket
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Accounts: An account collection provides a list of Analytics accounts
-// to which a user has access. The account collection is the entry point
-// to all management information. Each resource in the collection
-// corresponds to a single Analytics account.
-type Accounts struct {
- // Items: A list of accounts.
- Items []*Account `json:"items,omitempty"`
-
- // ItemsPerPage: The maximum number of entries the response can contain,
- // regardless of the actual number of entries returned. Its value ranges
- // from 1 to 1000 with a value of 1000 by default, or otherwise
- // specified by the max-results query parameter.
- ItemsPerPage int64 `json:"itemsPerPage,omitempty"`
-
- // Kind: Collection type.
- Kind string `json:"kind,omitempty"`
-
- // NextLink: Next link for this account collection.
- NextLink string `json:"nextLink,omitempty"`
-
- // PreviousLink: Previous link for this account collection.
- PreviousLink string `json:"previousLink,omitempty"`
-
- // StartIndex: The starting index of the entries, which is 1 by default
- // or otherwise specified by the start-index query parameter.
- StartIndex int64 `json:"startIndex,omitempty"`
-
- // TotalResults: The total number of results for the query, regardless
- // of the number of results in the response.
- TotalResults int64 `json:"totalResults,omitempty"`
-
- // Username: Email ID of the authenticated user
- Username string `json:"username,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Accounts) MarshalJSON() ([]byte, error) {
- type noMethod Accounts
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdWordsAccount: JSON template for an AdWords account.
-type AdWordsAccount struct {
- // AutoTaggingEnabled: True if auto-tagging is enabled on the AdWords
- // account. Read-only after the insert operation.
- AutoTaggingEnabled bool `json:"autoTaggingEnabled,omitempty"`
-
- // CustomerId: Customer ID. This field is required when creating an
- // AdWords link.
- CustomerId string `json:"customerId,omitempty"`
-
- // Kind: Resource type for AdWords account.
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AutoTaggingEnabled")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdWordsAccount) MarshalJSON() ([]byte, error) {
- type noMethod AdWordsAccount
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AnalyticsDataimportDeleteUploadDataRequest: Request template for the
-// delete upload data request.
-type AnalyticsDataimportDeleteUploadDataRequest struct {
- // CustomDataImportUids: A list of upload UIDs.
- CustomDataImportUids []string `json:"customDataImportUids,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "CustomDataImportUids") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AnalyticsDataimportDeleteUploadDataRequest) MarshalJSON() ([]byte, error) {
- type noMethod AnalyticsDataimportDeleteUploadDataRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Column: JSON template for a metadata column.
-type Column struct {
- // Attributes: Map of attribute name and value for this column.
- Attributes map[string]string `json:"attributes,omitempty"`
-
- // Id: Column id.
- Id string `json:"id,omitempty"`
-
- // Kind: Resource type for Analytics column.
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Attributes") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Column) MarshalJSON() ([]byte, error) {
- type noMethod Column
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Columns: Lists columns (dimensions and metrics) for a particular
-// report type.
-type Columns struct {
- // AttributeNames: List of attributes names returned by columns.
- AttributeNames []string `json:"attributeNames,omitempty"`
-
- // Etag: Etag of collection. This etag can be compared with the last
- // response etag to check if response has changed.
- Etag string `json:"etag,omitempty"`
-
- // Items: List of columns for a report type.
- Items []*Column `json:"items,omitempty"`
-
- // Kind: Collection type.
- Kind string `json:"kind,omitempty"`
-
- // TotalResults: Total number of columns returned in the response.
- TotalResults int64 `json:"totalResults,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AttributeNames") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Columns) MarshalJSON() ([]byte, error) {
- type noMethod Columns
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CustomDataSource: JSON template for an Analytics custom data source.
-type CustomDataSource struct {
- // AccountId: Account ID to which this custom data source belongs.
- AccountId string `json:"accountId,omitempty"`
-
- ChildLink *CustomDataSourceChildLink `json:"childLink,omitempty"`
-
- // Created: Time this custom data source was created.
- Created string `json:"created,omitempty"`
-
- // Description: Description of custom data source.
- Description string `json:"description,omitempty"`
-
- // Id: Custom data source ID.
- Id string `json:"id,omitempty"`
-
- ImportBehavior string `json:"importBehavior,omitempty"`
-
- // Kind: Resource type for Analytics custom data source.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this custom data source.
- Name string `json:"name,omitempty"`
-
- // ParentLink: Parent link for this custom data source. Points to the
- // web property to which this custom data source belongs.
- ParentLink *CustomDataSourceParentLink `json:"parentLink,omitempty"`
-
- // ProfilesLinked: IDs of views (profiles) linked to the custom data
- // source.
- ProfilesLinked []string `json:"profilesLinked,omitempty"`
-
- // SelfLink: Link for this Analytics custom data source.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Type: Type of the custom data source.
- Type string `json:"type,omitempty"`
-
- // Updated: Time this custom data source was last modified.
- Updated string `json:"updated,omitempty"`
-
- UploadType string `json:"uploadType,omitempty"`
-
- // WebPropertyId: Web property ID of the form UA-XXXXX-YY to which this
- // custom data source belongs.
- WebPropertyId string `json:"webPropertyId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomDataSource) MarshalJSON() ([]byte, error) {
- type noMethod CustomDataSource
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CustomDataSourceChildLink struct {
- // Href: Link to the list of daily uploads for this custom data source.
- // Link to the list of uploads for this custom data source.
- Href string `json:"href,omitempty"`
-
- // Type: Value is "analytics#dailyUploads". Value is
- // "analytics#uploads".
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Href") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomDataSourceChildLink) MarshalJSON() ([]byte, error) {
- type noMethod CustomDataSourceChildLink
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CustomDataSourceParentLink: Parent link for this custom data source.
-// Points to the web property to which this custom data source belongs.
-type CustomDataSourceParentLink struct {
- // Href: Link to the web property to which this custom data source
- // belongs.
- Href string `json:"href,omitempty"`
-
- // Type: Value is "analytics#webproperty".
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Href") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomDataSourceParentLink) MarshalJSON() ([]byte, error) {
- type noMethod CustomDataSourceParentLink
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CustomDataSources: Lists Analytics custom data sources to which the
-// user has access. Each resource in the collection corresponds to a
-// single Analytics custom data source.
-type CustomDataSources struct {
- // Items: Collection of custom data sources.
- Items []*CustomDataSource `json:"items,omitempty"`
-
- // ItemsPerPage: The maximum number of resources the response can
- // contain, regardless of the actual number of resources returned. Its
- // value ranges from 1 to 1000 with a value of 1000 by default, or
- // otherwise specified by the max-results query parameter.
- ItemsPerPage int64 `json:"itemsPerPage,omitempty"`
-
- // Kind: Collection type.
- Kind string `json:"kind,omitempty"`
-
- // NextLink: Link to next page for this custom data source collection.
- NextLink string `json:"nextLink,omitempty"`
-
- // PreviousLink: Link to previous page for this custom data source
- // collection.
- PreviousLink string `json:"previousLink,omitempty"`
-
- // StartIndex: The starting index of the resources, which is 1 by
- // default or otherwise specified by the start-index query parameter.
- StartIndex int64 `json:"startIndex,omitempty"`
-
- // TotalResults: The total number of results for the query, regardless
- // of the number of results in the response.
- TotalResults int64 `json:"totalResults,omitempty"`
-
- // Username: Email ID of the authenticated user
- Username string `json:"username,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomDataSources) MarshalJSON() ([]byte, error) {
- type noMethod CustomDataSources
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CustomDimension: JSON template for Analytics Custom Dimension.
-type CustomDimension struct {
- // AccountId: Account ID.
- AccountId string `json:"accountId,omitempty"`
-
- // Active: Boolean indicating whether the custom dimension is active.
- Active bool `json:"active,omitempty"`
-
- // Created: Time the custom dimension was created.
- Created string `json:"created,omitempty"`
-
- // Id: Custom dimension ID.
- Id string `json:"id,omitempty"`
-
- // Index: Index of the custom dimension.
- Index int64 `json:"index,omitempty"`
-
- // Kind: Kind value for a custom dimension. Set to
- // "analytics#customDimension". It is a read-only field.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the custom dimension.
- Name string `json:"name,omitempty"`
-
- // ParentLink: Parent link for the custom dimension. Points to the
- // property to which the custom dimension belongs.
- ParentLink *CustomDimensionParentLink `json:"parentLink,omitempty"`
-
- // Scope: Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
- Scope string `json:"scope,omitempty"`
-
- // SelfLink: Link for the custom dimension
- SelfLink string `json:"selfLink,omitempty"`
-
- // Updated: Time the custom dimension was last modified.
- Updated string `json:"updated,omitempty"`
-
- // WebPropertyId: Property ID.
- WebPropertyId string `json:"webPropertyId,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomDimension) MarshalJSON() ([]byte, error) {
- type noMethod CustomDimension
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CustomDimensionParentLink: Parent link for the custom dimension.
-// Points to the property to which the custom dimension belongs.
-type CustomDimensionParentLink struct {
- // Href: Link to the property to which the custom dimension belongs.
- Href string `json:"href,omitempty"`
-
- // Type: Type of the parent link. Set to "analytics#webproperty".
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Href") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomDimensionParentLink) MarshalJSON() ([]byte, error) {
- type noMethod CustomDimensionParentLink
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CustomDimensions: A custom dimension collection lists Analytics
-// custom dimensions to which the user has access. Each resource in the
-// collection corresponds to a single Analytics custom dimension.
-type CustomDimensions struct {
- // Items: Collection of custom dimensions.
- Items []*CustomDimension `json:"items,omitempty"`
-
- // ItemsPerPage: The maximum number of resources the response can
- // contain, regardless of the actual number of resources returned. Its
- // value ranges from 1 to 1000 with a value of 1000 by default, or
- // otherwise specified by the max-results query parameter.
- ItemsPerPage int64 `json:"itemsPerPage,omitempty"`
-
- // Kind: Collection type.
- Kind string `json:"kind,omitempty"`
-
- // NextLink: Link to next page for this custom dimension collection.
- NextLink string `json:"nextLink,omitempty"`
-
- // PreviousLink: Link to previous page for this custom dimension
- // collection.
- PreviousLink string `json:"previousLink,omitempty"`
-
- // StartIndex: The starting index of the resources, which is 1 by
- // default or otherwise specified by the start-index query parameter.
- StartIndex int64 `json:"startIndex,omitempty"`
-
- // TotalResults: The total number of results for the query, regardless
- // of the number of results in the response.
- TotalResults int64 `json:"totalResults,omitempty"`
-
- // Username: Email ID of the authenticated user
- Username string `json:"username,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomDimensions) MarshalJSON() ([]byte, error) {
- type noMethod CustomDimensions
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CustomMetric: JSON template for Analytics Custom Metric.
-type CustomMetric struct {
- // AccountId: Account ID.
- AccountId string `json:"accountId,omitempty"`
-
- // Active: Boolean indicating whether the custom metric is active.
- Active bool `json:"active,omitempty"`
-
- // Created: Time the custom metric was created.
- Created string `json:"created,omitempty"`
-
- // Id: Custom metric ID.
- Id string `json:"id,omitempty"`
-
- // Index: Index of the custom metric.
- Index int64 `json:"index,omitempty"`
-
- // Kind: Kind value for a custom metric. Set to
- // "analytics#customMetric". It is a read-only field.
- Kind string `json:"kind,omitempty"`
-
- // MaxValue: Max value of custom metric.
- MaxValue string `json:"max_value,omitempty"`
-
- // MinValue: Min value of custom metric.
- MinValue string `json:"min_value,omitempty"`
-
- // Name: Name of the custom metric.
- Name string `json:"name,omitempty"`
-
- // ParentLink: Parent link for the custom metric. Points to the property
- // to which the custom metric belongs.
- ParentLink *CustomMetricParentLink `json:"parentLink,omitempty"`
-
- // Scope: Scope of the custom metric: HIT or PRODUCT.
- Scope string `json:"scope,omitempty"`
-
- // SelfLink: Link for the custom metric
- SelfLink string `json:"selfLink,omitempty"`
-
- // Type: Data type of custom metric.
- Type string `json:"type,omitempty"`
-
- // Updated: Time the custom metric was last modified.
- Updated string `json:"updated,omitempty"`
-
- // WebPropertyId: Property ID.
- WebPropertyId string `json:"webPropertyId,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomMetric) MarshalJSON() ([]byte, error) {
- type noMethod CustomMetric
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CustomMetricParentLink: Parent link for the custom metric. Points to
-// the property to which the custom metric belongs.
-type CustomMetricParentLink struct {
- // Href: Link to the property to which the custom metric belongs.
- Href string `json:"href,omitempty"`
-
- // Type: Type of the parent link. Set to "analytics#webproperty".
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Href") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomMetricParentLink) MarshalJSON() ([]byte, error) {
- type noMethod CustomMetricParentLink
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CustomMetrics: A custom metric collection lists Analytics custom
-// metrics to which the user has access. Each resource in the collection
-// corresponds to a single Analytics custom metric.
-type CustomMetrics struct {
- // Items: Collection of custom metrics.
- Items []*CustomMetric `json:"items,omitempty"`
-
- // ItemsPerPage: The maximum number of resources the response can
- // contain, regardless of the actual number of resources returned. Its
- // value ranges from 1 to 1000 with a value of 1000 by default, or
- // otherwise specified by the max-results query parameter.
- ItemsPerPage int64 `json:"itemsPerPage,omitempty"`
-
- // Kind: Collection type.
- Kind string `json:"kind,omitempty"`
-
- // NextLink: Link to next page for this custom metric collection.
- NextLink string `json:"nextLink,omitempty"`
-
- // PreviousLink: Link to previous page for this custom metric
- // collection.
- PreviousLink string `json:"previousLink,omitempty"`
-
- // StartIndex: The starting index of the resources, which is 1 by
- // default or otherwise specified by the start-index query parameter.
- StartIndex int64 `json:"startIndex,omitempty"`
-
- // TotalResults: The total number of results for the query, regardless
- // of the number of results in the response.
- TotalResults int64 `json:"totalResults,omitempty"`
-
- // Username: Email ID of the authenticated user
- Username string `json:"username,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomMetrics) MarshalJSON() ([]byte, error) {
- type noMethod CustomMetrics
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// EntityAdWordsLink: JSON template for Analytics Entity AdWords Link.
-type EntityAdWordsLink struct {
- // AdWordsAccounts: A list of AdWords client accounts. These cannot be
- // MCC accounts. This field is required when creating an AdWords link.
- // It cannot be empty.
- AdWordsAccounts []*AdWordsAccount `json:"adWordsAccounts,omitempty"`
-
- // Entity: Web property being linked.
- Entity *EntityAdWordsLinkEntity `json:"entity,omitempty"`
-
- // Id: Entity AdWords link ID
- Id string `json:"id,omitempty"`
-
- // Kind: Resource type for entity AdWords link.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the link. This field is required when creating an
- // AdWords link.
- Name string `json:"name,omitempty"`
-
- // ProfileIds: IDs of linked Views (Profiles) represented as strings.
- ProfileIds []string `json:"profileIds,omitempty"`
-
- // SelfLink: URL link for this Google Analytics - Google AdWords link.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AdWordsAccounts") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EntityAdWordsLink) MarshalJSON() ([]byte, error) {
- type noMethod EntityAdWordsLink
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// EntityAdWordsLinkEntity: Web property being linked.
-type EntityAdWordsLinkEntity struct {
- WebPropertyRef *WebPropertyRef `json:"webPropertyRef,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "WebPropertyRef") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EntityAdWordsLinkEntity) MarshalJSON() ([]byte, error) {
- type noMethod EntityAdWordsLinkEntity
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// EntityAdWordsLinks: An entity AdWords link collection provides a list
-// of GA-AdWords links Each resource in this collection corresponds to a
-// single link.
-type EntityAdWordsLinks struct {
- // Items: A list of entity AdWords links.
- Items []*EntityAdWordsLink `json:"items,omitempty"`
-
- // ItemsPerPage: The maximum number of entries the response can contain,
- // regardless of the actual number of entries returned. Its value ranges
- // from 1 to 1000 with a value of 1000 by default, or otherwise
- // specified by the max-results query parameter.
- ItemsPerPage int64 `json:"itemsPerPage,omitempty"`
-
- // Kind: Collection type.
- Kind string `json:"kind,omitempty"`
-
- // NextLink: Next link for this AdWords link collection.
- NextLink string `json:"nextLink,omitempty"`
-
- // PreviousLink: Previous link for this AdWords link collection.
- PreviousLink string `json:"previousLink,omitempty"`
-
- // StartIndex: The starting index of the entries, which is 1 by default
- // or otherwise specified by the start-index query parameter.
- StartIndex int64 `json:"startIndex,omitempty"`
-
- // TotalResults: The total number of results for the query, regardless
- // of the number of results in the response.
- TotalResults int64 `json:"totalResults,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EntityAdWordsLinks) MarshalJSON() ([]byte, error) {
- type noMethod EntityAdWordsLinks
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// EntityUserLink: JSON template for an Analytics Entity-User Link.
-// Returns permissions that a user has for an entity.
-type EntityUserLink struct {
- // Entity: Entity for this link. It can be an account, a web property,
- // or a view (profile).
- Entity *EntityUserLinkEntity `json:"entity,omitempty"`
-
- // Id: Entity user link ID
- Id string `json:"id,omitempty"`
-
- // Kind: Resource type for entity user link.
- Kind string `json:"kind,omitempty"`
-
- // Permissions: Permissions the user has for this entity.
- Permissions *EntityUserLinkPermissions `json:"permissions,omitempty"`
-
- // SelfLink: Self link for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // UserRef: User reference.
- UserRef *UserRef `json:"userRef,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Entity") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EntityUserLink) MarshalJSON() ([]byte, error) {
- type noMethod EntityUserLink
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// EntityUserLinkEntity: Entity for this link. It can be an account, a
-// web property, or a view (profile).
-type EntityUserLinkEntity struct {
- // AccountRef: Account for this link.
- AccountRef *AccountRef `json:"accountRef,omitempty"`
-
- // ProfileRef: View (Profile) for this link.
- ProfileRef *ProfileRef `json:"profileRef,omitempty"`
-
- // WebPropertyRef: Web property for this link.
- WebPropertyRef *WebPropertyRef `json:"webPropertyRef,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AccountRef") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EntityUserLinkEntity) MarshalJSON() ([]byte, error) {
- type noMethod EntityUserLinkEntity
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// EntityUserLinkPermissions: Permissions the user has for this entity.
-type EntityUserLinkPermissions struct {
- // Effective: Effective permissions represent all the permissions that a
- // user has for this entity. These include any implied permissions
- // (e.g., EDIT implies VIEW) or inherited permissions from the parent
- // entity. Effective permissions are read-only.
- Effective []string `json:"effective,omitempty"`
-
- // Local: Permissions that a user has been assigned at this very level.
- // Does not include any implied or inherited permissions. Local
- // permissions are modifiable.
- Local []string `json:"local,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Effective") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EntityUserLinkPermissions) MarshalJSON() ([]byte, error) {
- type noMethod EntityUserLinkPermissions
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// EntityUserLinks: An entity user link collection provides a list of
-// Analytics ACL links Each resource in this collection corresponds to a
-// single link.
-type EntityUserLinks struct {
- // Items: A list of entity user links.
- Items []*EntityUserLink `json:"items,omitempty"`
-
- // ItemsPerPage: The maximum number of entries the response can contain,
- // regardless of the actual number of entries returned. Its value ranges
- // from 1 to 1000 with a value of 1000 by default, or otherwise
- // specified by the max-results query parameter.
- ItemsPerPage int64 `json:"itemsPerPage,omitempty"`
-
- // Kind: Collection type.
- Kind string `json:"kind,omitempty"`
-
- // NextLink: Next link for this account collection.
- NextLink string `json:"nextLink,omitempty"`
-
- // PreviousLink: Previous link for this account collection.
- PreviousLink string `json:"previousLink,omitempty"`
-
- // StartIndex: The starting index of the entries, which is 1 by default
- // or otherwise specified by the start-index query parameter.
- StartIndex int64 `json:"startIndex,omitempty"`
-
- // TotalResults: The total number of results for the query, regardless
- // of the number of results in the response.
- TotalResults int64 `json:"totalResults,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EntityUserLinks) MarshalJSON() ([]byte, error) {
- type noMethod EntityUserLinks
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Experiment: JSON template for Analytics experiment resource.
-type Experiment struct {
- // AccountId: Account ID to which this experiment belongs. This field is
- // read-only.
- AccountId string `json:"accountId,omitempty"`
-
- // Created: Time the experiment was created. This field is read-only.
- Created string `json:"created,omitempty"`
-
- // Description: Notes about this experiment.
- Description string `json:"description,omitempty"`
-
- // EditableInGaUi: If true, the end user will be able to edit the
- // experiment via the Google Analytics user interface.
- EditableInGaUi bool `json:"editableInGaUi,omitempty"`
-
- // EndTime: The ending time of the experiment (the time the status
- // changed from RUNNING to ENDED). This field is present only if the
- // experiment has ended. This field is read-only.
- EndTime string `json:"endTime,omitempty"`
-
- // EqualWeighting: Boolean specifying whether to distribute traffic
- // evenly across all variations. If the value is False, content
- // experiments follows the default behavior of adjusting traffic
- // dynamically based on variation performance. Optional -- defaults to
- // False. This field may not be changed for an experiment whose status
- // is ENDED.
- EqualWeighting bool `json:"equalWeighting,omitempty"`
-
- // Id: Experiment ID. Required for patch and update. Disallowed for
- // create.
- Id string `json:"id,omitempty"`
-
- // InternalWebPropertyId: Internal ID for the web property to which this
- // experiment belongs. This field is read-only.
- InternalWebPropertyId string `json:"internalWebPropertyId,omitempty"`
-
- // Kind: Resource type for an Analytics experiment. This field is
- // read-only.
- Kind string `json:"kind,omitempty"`
-
- // MinimumExperimentLengthInDays: An integer number in [3, 90].
- // Specifies the minimum length of the experiment. Can be changed for a
- // running experiment. This field may not be changed for an experiments
- // whose status is ENDED.
- MinimumExperimentLengthInDays int64 `json:"minimumExperimentLengthInDays,omitempty"`
-
- // Name: Experiment name. This field may not be changed for an
- // experiment whose status is ENDED. This field is required when
- // creating an experiment.
- Name string `json:"name,omitempty"`
-
- // ObjectiveMetric: The metric that the experiment is optimizing. Valid
- // values: "ga:goal(n)Completions", "ga:adsenseAdsClicks",
- // "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces",
- // "ga:pageviews", "ga:sessionDuration", "ga:transactions",
- // "ga:transactionRevenue". This field is required if status is
- // "RUNNING" and servingFramework is one of "REDIRECT" or "API".
- ObjectiveMetric string `json:"objectiveMetric,omitempty"`
-
- // OptimizationType: Whether the objectiveMetric should be minimized or
- // maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults
- // to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be
- // modified when status is "RUNNING" or "ENDED".
- OptimizationType string `json:"optimizationType,omitempty"`
-
- // ParentLink: Parent link for an experiment. Points to the view
- // (profile) to which this experiment belongs.
- ParentLink *ExperimentParentLink `json:"parentLink,omitempty"`
-
- // ProfileId: View (Profile) ID to which this experiment belongs. This
- // field is read-only.
- ProfileId string `json:"profileId,omitempty"`
-
- // ReasonExperimentEnded: Why the experiment ended. Possible values:
- // "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED",
- // "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED".
- // "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no
- // winner was projected to be found. If the experiment status is changed
- // via the API to ENDED this field is set to STOPPED_BY_USER. This field
- // is read-only.
- ReasonExperimentEnded string `json:"reasonExperimentEnded,omitempty"`
-
- // RewriteVariationUrlsAsOriginal: Boolean specifying whether variations
- // URLS are rewritten to match those of the original. This field may not
- // be changed for an experiments whose status is ENDED.
- RewriteVariationUrlsAsOriginal bool `json:"rewriteVariationUrlsAsOriginal,omitempty"`
-
- // SelfLink: Link for this experiment. This field is read-only.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServingFramework: The framework used to serve the experiment
- // variations and evaluate the results. One of:
- // - REDIRECT: Google Analytics redirects traffic to different variation
- // pages, reports the chosen variation and evaluates the results.
- // - API: Google Analytics chooses and reports the variation to serve
- // and evaluates the results; the caller is responsible for serving the
- // selected variation.
- // - EXTERNAL: The variations will be served externally and the chosen
- // variation reported to Google Analytics. The caller is responsible for
- // serving the selected variation and evaluating the results.
- ServingFramework string `json:"servingFramework,omitempty"`
-
- // Snippet: The snippet of code to include on the control page(s). This
- // field is read-only.
- Snippet string `json:"snippet,omitempty"`
-
- // StartTime: The starting time of the experiment (the time the status
- // changed from READY_TO_RUN to RUNNING). This field is present only if
- // the experiment has started. This field is read-only.
- StartTime string `json:"startTime,omitempty"`
-
- // Status: Experiment status. Possible values: "DRAFT", "READY_TO_RUN",
- // "RUNNING", "ENDED". Experiments can be created in the "DRAFT",
- // "READY_TO_RUN" or "RUNNING" state. This field is required when
- // creating an experiment.
- Status string `json:"status,omitempty"`
-
- // TrafficCoverage: A floating-point number in (0, 1]. Specifies the
- // fraction of the traffic that participates in the experiment. Can be
- // changed for a running experiment. This field may not be changed for
- // an experiments whose status is ENDED.
- TrafficCoverage float64 `json:"trafficCoverage,omitempty"`
-
- // Updated: Time the experiment was last modified. This field is
- // read-only.
- Updated string `json:"updated,omitempty"`
-
- // Variations: Array of variations. The first variation in the array is
- // the original. The number of variations may not change once an
- // experiment is in the RUNNING state. At least two variations are
- // required before status can be set to RUNNING.
- Variations []*ExperimentVariations `json:"variations,omitempty"`
-
- // WebPropertyId: Web property ID to which this experiment belongs. The
- // web property ID is of the form UA-XXXXX-YY. This field is read-only.
- WebPropertyId string `json:"webPropertyId,omitempty"`
-
- // WinnerConfidenceLevel: A floating-point number in (0, 1). Specifies
- // the necessary confidence level to choose a winner. This field may not
- // be changed for an experiments whose status is ENDED.
- WinnerConfidenceLevel float64 `json:"winnerConfidenceLevel,omitempty"`
-
- // WinnerFound: Boolean specifying whether a winner has been found for
- // this experiment. This field is read-only.
- WinnerFound bool `json:"winnerFound,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Experiment) MarshalJSON() ([]byte, error) {
- type noMethod Experiment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ExperimentParentLink: Parent link for an experiment. Points to the
-// view (profile) to which this experiment belongs.
-type ExperimentParentLink struct {
- // Href: Link to the view (profile) to which this experiment belongs.
- // This field is read-only.
- Href string `json:"href,omitempty"`
-
- // Type: Value is "analytics#profile". This field is read-only.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Href") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ExperimentParentLink) MarshalJSON() ([]byte, error) {
- type noMethod ExperimentParentLink
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ExperimentVariations struct {
- // Name: The name of the variation. This field is required when creating
- // an experiment. This field may not be changed for an experiment whose
- // status is ENDED.
- Name string `json:"name,omitempty"`
-
- // Status: Status of the variation. Possible values: "ACTIVE",
- // "INACTIVE". INACTIVE variations are not served. This field may not be
- // changed for an experiment whose status is ENDED.
- Status string `json:"status,omitempty"`
-
- // Url: The URL of the variation. This field may not be changed for an
- // experiment whose status is RUNNING or ENDED.
- Url string `json:"url,omitempty"`
-
- // Weight: Weight that this variation should receive. Only present if
- // the experiment is running. This field is read-only.
- Weight float64 `json:"weight,omitempty"`
-
- // Won: True if the experiment has ended and this variation performed
- // (statistically) significantly better than the original. This field is
- // read-only.
- Won bool `json:"won,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Name") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ExperimentVariations) MarshalJSON() ([]byte, error) {
- type noMethod ExperimentVariations
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Experiments: An experiment collection lists Analytics experiments to
-// which the user has access. Each view (profile) can have a set of
-// experiments. Each resource in the Experiment collection corresponds
-// to a single Analytics experiment.
-type Experiments struct {
- // Items: A list of experiments.
- Items []*Experiment `json:"items,omitempty"`
-
- // ItemsPerPage: The maximum number of resources the response can
- // contain, regardless of the actual number of resources returned. Its
- // value ranges from 1 to 1000 with a value of 1000 by default, or
- // otherwise specified by the max-results query parameter.
- ItemsPerPage int64 `json:"itemsPerPage,omitempty"`
-
- // Kind: Collection type.
- Kind string `json:"kind,omitempty"`
-
- // NextLink: Link to next page for this experiment collection.
- NextLink string `json:"nextLink,omitempty"`
-
- // PreviousLink: Link to previous page for this experiment collection.
- PreviousLink string `json:"previousLink,omitempty"`
-
- // StartIndex: The starting index of the resources, which is 1 by
- // default or otherwise specified by the start-index query parameter.
- StartIndex int64 `json:"startIndex,omitempty"`
-
- // TotalResults: The total number of results for the query, regardless
- // of the number of resources in the result.
- TotalResults int64 `json:"totalResults,omitempty"`
-
- // Username: Email ID of the authenticated user
- Username string `json:"username,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Experiments) MarshalJSON() ([]byte, error) {
- type noMethod Experiments
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Filter: JSON template for an Analytics account filter.
-type Filter struct {
- // AccountId: Account ID to which this filter belongs.
- AccountId string `json:"accountId,omitempty"`
-
- // AdvancedDetails: Details for the filter of the type ADVANCED.
- AdvancedDetails *FilterAdvancedDetails `json:"advancedDetails,omitempty"`
-
- // Created: Time this filter was created.
- Created string `json:"created,omitempty"`
-
- // ExcludeDetails: Details for the filter of the type EXCLUDE.
- ExcludeDetails *FilterExpression `json:"excludeDetails,omitempty"`
-
- // Id: Filter ID.
- Id string `json:"id,omitempty"`
-
- // IncludeDetails: Details for the filter of the type INCLUDE.
- IncludeDetails *FilterExpression `json:"includeDetails,omitempty"`
-
- // Kind: Resource type for Analytics filter.
- Kind string `json:"kind,omitempty"`
-
- // LowercaseDetails: Details for the filter of the type LOWER.
- LowercaseDetails *FilterLowercaseDetails `json:"lowercaseDetails,omitempty"`
-
- // Name: Name of this filter.
- Name string `json:"name,omitempty"`
-
- // ParentLink: Parent link for this filter. Points to the account to
- // which this filter belongs.
- ParentLink *FilterParentLink `json:"parentLink,omitempty"`
-
- // SearchAndReplaceDetails: Details for the filter of the type
- // SEARCH_AND_REPLACE.
- SearchAndReplaceDetails *FilterSearchAndReplaceDetails `json:"searchAndReplaceDetails,omitempty"`
-
- // SelfLink: Link for this filter.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Type: Type of this filter. Possible values are INCLUDE, EXCLUDE,
- // LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED.
- Type string `json:"type,omitempty"`
-
- // Updated: Time this filter was last modified.
- Updated string `json:"updated,omitempty"`
-
- // UppercaseDetails: Details for the filter of the type UPPER.
- UppercaseDetails *FilterUppercaseDetails `json:"uppercaseDetails,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Filter) MarshalJSON() ([]byte, error) {
- type noMethod Filter
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FilterAdvancedDetails: Details for the filter of the type ADVANCED.
-type FilterAdvancedDetails struct {
- // CaseSensitive: Indicates if the filter expressions are case
- // sensitive.
- CaseSensitive bool `json:"caseSensitive,omitempty"`
-
- // ExtractA: Expression to extract from field A.
- ExtractA string `json:"extractA,omitempty"`
-
- // ExtractB: Expression to extract from field B.
- ExtractB string `json:"extractB,omitempty"`
-
- // FieldA: Field A.
- FieldA string `json:"fieldA,omitempty"`
-
- // FieldAIndex: The Index of the custom dimension. Required if field is
- // a CUSTOM_DIMENSION.
- FieldAIndex int64 `json:"fieldAIndex,omitempty"`
-
- // FieldARequired: Indicates if field A is required to match.
- FieldARequired bool `json:"fieldARequired,omitempty"`
-
- // FieldB: Field B.
- FieldB string `json:"fieldB,omitempty"`
-
- // FieldBIndex: The Index of the custom dimension. Required if field is
- // a CUSTOM_DIMENSION.
- FieldBIndex int64 `json:"fieldBIndex,omitempty"`
-
- // FieldBRequired: Indicates if field B is required to match.
- FieldBRequired bool `json:"fieldBRequired,omitempty"`
-
- // OutputConstructor: Expression used to construct the output value.
- OutputConstructor string `json:"outputConstructor,omitempty"`
-
- // OutputToField: Output field.
- OutputToField string `json:"outputToField,omitempty"`
-
- // OutputToFieldIndex: The Index of the custom dimension. Required if
- // field is a CUSTOM_DIMENSION.
- OutputToFieldIndex int64 `json:"outputToFieldIndex,omitempty"`
-
- // OverrideOutputField: Indicates if the existing value of the output
- // field, if any, should be overridden by the output expression.
- OverrideOutputField bool `json:"overrideOutputField,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CaseSensitive") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FilterAdvancedDetails) MarshalJSON() ([]byte, error) {
- type noMethod FilterAdvancedDetails
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FilterLowercaseDetails: Details for the filter of the type LOWER.
-type FilterLowercaseDetails struct {
- // Field: Field to use in the filter.
- Field string `json:"field,omitempty"`
-
- // FieldIndex: The Index of the custom dimension. Required if field is a
- // CUSTOM_DIMENSION.
- FieldIndex int64 `json:"fieldIndex,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Field") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FilterLowercaseDetails) MarshalJSON() ([]byte, error) {
- type noMethod FilterLowercaseDetails
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FilterParentLink: Parent link for this filter. Points to the account
-// to which this filter belongs.
-type FilterParentLink struct {
- // Href: Link to the account to which this filter belongs.
- Href string `json:"href,omitempty"`
-
- // Type: Value is "analytics#account".
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Href") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FilterParentLink) MarshalJSON() ([]byte, error) {
- type noMethod FilterParentLink
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FilterSearchAndReplaceDetails: Details for the filter of the type
-// SEARCH_AND_REPLACE.
-type FilterSearchAndReplaceDetails struct {
- // CaseSensitive: Determines if the filter is case sensitive.
- CaseSensitive bool `json:"caseSensitive,omitempty"`
-
- // Field: Field to use in the filter.
- Field string `json:"field,omitempty"`
-
- // FieldIndex: The Index of the custom dimension. Required if field is a
- // CUSTOM_DIMENSION.
- FieldIndex int64 `json:"fieldIndex,omitempty"`
-
- // ReplaceString: Term to replace the search term with.
- ReplaceString string `json:"replaceString,omitempty"`
-
- // SearchString: Term to search.
- SearchString string `json:"searchString,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CaseSensitive") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FilterSearchAndReplaceDetails) MarshalJSON() ([]byte, error) {
- type noMethod FilterSearchAndReplaceDetails
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FilterUppercaseDetails: Details for the filter of the type UPPER.
-type FilterUppercaseDetails struct {
- // Field: Field to use in the filter.
- Field string `json:"field,omitempty"`
-
- // FieldIndex: The Index of the custom dimension. Required if field is a
- // CUSTOM_DIMENSION.
- FieldIndex int64 `json:"fieldIndex,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Field") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FilterUppercaseDetails) MarshalJSON() ([]byte, error) {
- type noMethod FilterUppercaseDetails
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FilterExpression: JSON template for an Analytics filter expression.
-type FilterExpression struct {
- // CaseSensitive: Determines if the filter is case sensitive.
- CaseSensitive bool `json:"caseSensitive,omitempty"`
-
- // ExpressionValue: Filter expression value
- ExpressionValue string `json:"expressionValue,omitempty"`
-
- // Field: Field to filter. Possible values:
- // - Content and Traffic
- // - PAGE_REQUEST_URI,
- // - PAGE_HOSTNAME,
- // - PAGE_TITLE,
- // - REFERRAL,
- // - COST_DATA_URI (Campaign target URL),
- // - HIT_TYPE,
- // - INTERNAL_SEARCH_TERM,
- // - INTERNAL_SEARCH_TYPE,
- // - SOURCE_PROPERTY_TRACKING_ID,
- // - Campaign or AdGroup
- // - CAMPAIGN_SOURCE,
- // - CAMPAIGN_MEDIUM,
- // - CAMPAIGN_NAME,
- // - CAMPAIGN_AD_GROUP,
- // - CAMPAIGN_TERM,
- // - CAMPAIGN_CONTENT,
- // - CAMPAIGN_CODE,
- // - CAMPAIGN_REFERRAL_PATH,
- // - E-Commerce
- // - TRANSACTION_COUNTRY,
- // - TRANSACTION_REGION,
- // - TRANSACTION_CITY,
- // - TRANSACTION_AFFILIATION (Store or order location),
- // - ITEM_NAME,
- // - ITEM_CODE,
- // - ITEM_VARIATION,
- // - TRANSACTION_ID,
- // - TRANSACTION_CURRENCY_CODE,
- // - PRODUCT_ACTION_TYPE,
- // - Audience/Users
- // - BROWSER,
- // - BROWSER_VERSION,
- // - BROWSER_SIZE,
- // - PLATFORM,
- // - PLATFORM_VERSION,
- // - LANGUAGE,
- // - SCREEN_RESOLUTION,
- // - SCREEN_COLORS,
- // - JAVA_ENABLED (Boolean Field),
- // - FLASH_VERSION,
- // - GEO_SPEED (Connection speed),
- // - VISITOR_TYPE,
- // - GEO_ORGANIZATION (ISP organization),
- // - GEO_DOMAIN,
- // - GEO_IP_ADDRESS,
- // - GEO_IP_VERSION,
- // - Location
- // - GEO_COUNTRY,
- // - GEO_REGION,
- // - GEO_CITY,
- // - Event
- // - EVENT_CATEGORY,
- // - EVENT_ACTION,
- // - EVENT_LABEL,
- // - Other
- // - CUSTOM_FIELD_1,
- // - CUSTOM_FIELD_2,
- // - USER_DEFINED_VALUE,
- // - Application
- // - APP_ID,
- // - APP_INSTALLER_ID,
- // - APP_NAME,
- // - APP_VERSION,
- // - SCREEN,
- // - IS_APP (Boolean Field),
- // - IS_FATAL_EXCEPTION (Boolean Field),
- // - EXCEPTION_DESCRIPTION,
- // - Mobile device
- // - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile),
- //
- // - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet),
- //
- // - DEVICE_CATEGORY,
- // - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field),
- // - MOBILE_HAS_NFC_SUPPORT (Boolean Field),
- // - MOBILE_HAS_CELLULAR_RADIO (Boolean Field),
- // - MOBILE_HAS_WIFI_SUPPORT (Boolean Field),
- // - MOBILE_BRAND_NAME,
- // - MOBILE_MODEL_NAME,
- // - MOBILE_MARKETING_NAME,
- // - MOBILE_POINTING_METHOD,
- // - Social
- // - SOCIAL_NETWORK,
- // - SOCIAL_ACTION,
- // - SOCIAL_ACTION_TARGET,
- // - Custom dimension
- // - CUSTOM_DIMENSION (See accompanying field index),
- Field string `json:"field,omitempty"`
-
- // FieldIndex: The Index of the custom dimension. Set only if the field
- // is a is CUSTOM_DIMENSION.
- FieldIndex int64 `json:"fieldIndex,omitempty"`
-
- // Kind: Kind value for filter expression
- Kind string `json:"kind,omitempty"`
-
- // MatchType: Match type for this filter. Possible values are
- // BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN,
- // GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use
- // any match type; all other filters must use MATCHES.
- MatchType string `json:"matchType,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CaseSensitive") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FilterExpression) MarshalJSON() ([]byte, error) {
- type noMethod FilterExpression
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FilterRef: JSON template for a profile filter link.
-type FilterRef struct {
- // AccountId: Account ID to which this filter belongs.
- AccountId string `json:"accountId,omitempty"`
-
- // Href: Link for this filter.
- Href string `json:"href,omitempty"`
-
- // Id: Filter ID.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind value for filter reference.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this filter.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FilterRef) MarshalJSON() ([]byte, error) {
- type noMethod FilterRef
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Filters: A filter collection lists filters created by users in an
-// Analytics account. Each resource in the collection corresponds to a
-// filter.
-type Filters struct {
- // Items: A list of filters.
- Items []*Filter `json:"items,omitempty"`
-
- // ItemsPerPage: The maximum number of resources the response can
- // contain, regardless of the actual number of resources returned. Its
- // value ranges from 1 to 1,000 with a value of 1000 by default, or
- // otherwise specified by the max-results query parameter.
- ItemsPerPage int64 `json:"itemsPerPage,omitempty"`
-
- // Kind: Collection type.
- Kind string `json:"kind,omitempty"`
-
- // NextLink: Link to next page for this filter collection.
- NextLink string `json:"nextLink,omitempty"`
-
- // PreviousLink: Link to previous page for this filter collection.
- PreviousLink string `json:"previousLink,omitempty"`
-
- // StartIndex: The starting index of the resources, which is 1 by
- // default or otherwise specified by the start-index query parameter.
- StartIndex int64 `json:"startIndex,omitempty"`
-
- // TotalResults: The total number of results for the query, regardless
- // of the number of results in the response.
- TotalResults int64 `json:"totalResults,omitempty"`
-
- // Username: Email ID of the authenticated user
- Username string `json:"username,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Filters) MarshalJSON() ([]byte, error) {
- type noMethod Filters
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// GaData: Analytics data for a given view (profile).
-type GaData struct {
- // ColumnHeaders: Column headers that list dimension names followed by
- // the metric names. The order of dimensions and metrics is same as
- // specified in the request.
- ColumnHeaders []*GaDataColumnHeaders `json:"columnHeaders,omitempty"`
-
- // ContainsSampledData: Determines if Analytics data contains samples.
- ContainsSampledData bool `json:"containsSampledData,omitempty"`
-
- DataTable *GaDataDataTable `json:"dataTable,omitempty"`
-
- // Id: Unique ID for this data response.
- Id string `json:"id,omitempty"`
-
- // ItemsPerPage: The maximum number of rows the response can contain,
- // regardless of the actual number of rows returned. Its value ranges
- // from 1 to 10,000 with a value of 1000 by default, or otherwise
- // specified by the max-results query parameter.
- ItemsPerPage int64 `json:"itemsPerPage,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // NextLink: Link to next page for this Analytics data query.
- NextLink string `json:"nextLink,omitempty"`
-
- // PreviousLink: Link to previous page for this Analytics data query.
- PreviousLink string `json:"previousLink,omitempty"`
-
- // ProfileInfo: Information for the view (profile), for which the
- // Analytics data was requested.
- ProfileInfo *GaDataProfileInfo `json:"profileInfo,omitempty"`
-
- // Query: Analytics data request query parameters.
- Query *GaDataQuery `json:"query,omitempty"`
-
- // Rows: Analytics data rows, where each row contains a list of
- // dimension values followed by the metric values. The order of
- // dimensions and metrics is same as specified in the request.
- Rows [][]string `json:"rows,omitempty"`
-
- // SampleSize: The number of samples used to calculate the result.
- SampleSize int64 `json:"sampleSize,omitempty,string"`
-
- // SampleSpace: Total size of the sample space from which the samples
- // were selected.
- SampleSpace int64 `json:"sampleSpace,omitempty,string"`
-
- // SelfLink: Link to this page.
- SelfLink string `json:"selfLink,omitempty"`
-
- // TotalResults: The total number of rows for the query, regardless of
- // the number of rows in the response.
- TotalResults int64 `json:"totalResults,omitempty"`
-
- // TotalsForAllResults: Total values for the requested metrics over all
- // the results, not just the results returned in this response. The
- // order of the metric totals is same as the metric order specified in
- // the request.
- TotalsForAllResults map[string]string `json:"totalsForAllResults,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ColumnHeaders") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GaData) MarshalJSON() ([]byte, error) {
- type noMethod GaData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GaDataColumnHeaders struct {
- // ColumnType: Column Type. Either DIMENSION or METRIC.
- ColumnType string `json:"columnType,omitempty"`
-
- // DataType: Data type. Dimension column headers have only STRING as the
- // data type. Metric column headers have data types for metric values
- // such as INTEGER, DOUBLE, CURRENCY etc.
- DataType string `json:"dataType,omitempty"`
-
- // Name: Column name.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ColumnType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GaDataColumnHeaders) MarshalJSON() ([]byte, error) {
- type noMethod GaDataColumnHeaders
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GaDataDataTable struct {
- Cols []*GaDataDataTableCols `json:"cols,omitempty"`
-
- Rows []*GaDataDataTableRows `json:"rows,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Cols") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GaDataDataTable) MarshalJSON() ([]byte, error) {
- type noMethod GaDataDataTable
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GaDataDataTableCols struct {
- Id string `json:"id,omitempty"`
-
- Label string `json:"label,omitempty"`
-
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GaDataDataTableCols) MarshalJSON() ([]byte, error) {
- type noMethod GaDataDataTableCols
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GaDataDataTableRows struct {
- C []*GaDataDataTableRowsC `json:"c,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "C") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GaDataDataTableRows) MarshalJSON() ([]byte, error) {
- type noMethod GaDataDataTableRows
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GaDataDataTableRowsC struct {
- V string `json:"v,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "V") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GaDataDataTableRowsC) MarshalJSON() ([]byte, error) {
- type noMethod GaDataDataTableRowsC
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// GaDataProfileInfo: Information for the view (profile), for which the
-// Analytics data was requested.
-type GaDataProfileInfo struct {
- // AccountId: Account ID to which this view (profile) belongs.
- AccountId string `json:"accountId,omitempty"`
-
- // InternalWebPropertyId: Internal ID for the web property to which this
- // view (profile) belongs.
- InternalWebPropertyId string `json:"internalWebPropertyId,omitempty"`
-
- // ProfileId: View (Profile) ID.
- ProfileId string `json:"profileId,omitempty"`
-
- // ProfileName: View (Profile) name.
- ProfileName string `json:"profileName,omitempty"`
-
- // TableId: Table ID for view (profile).
- TableId string `json:"tableId,omitempty"`
-
- // WebPropertyId: Web Property ID to which this view (profile) belongs.
- WebPropertyId string `json:"webPropertyId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GaDataProfileInfo) MarshalJSON() ([]byte, error) {
- type noMethod GaDataProfileInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// GaDataQuery: Analytics data request query parameters.
-type GaDataQuery struct {
- // Dimensions: List of analytics dimensions.
- Dimensions string `json:"dimensions,omitempty"`
-
- // EndDate: End date.
- EndDate string `json:"end-date,omitempty"`
-
- // Filters: Comma-separated list of dimension or metric filters.
- Filters string `json:"filters,omitempty"`
-
- // Ids: Unique table ID.
- Ids string `json:"ids,omitempty"`
-
- // MaxResults: Maximum results per page.
- MaxResults int64 `json:"max-results,omitempty"`
-
- // Metrics: List of analytics metrics.
- Metrics []string `json:"metrics,omitempty"`
-
- // SamplingLevel: Desired sampling level
- SamplingLevel string `json:"samplingLevel,omitempty"`
-
- // Segment: Analytics advanced segment.
- Segment string `json:"segment,omitempty"`
-
- // Sort: List of dimensions or metrics based on which Analytics data is
- // sorted.
- Sort []string `json:"sort,omitempty"`
-
- // StartDate: Start date.
- StartDate string `json:"start-date,omitempty"`
-
- // StartIndex: Start index.
- StartIndex int64 `json:"start-index,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Dimensions") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GaDataQuery) MarshalJSON() ([]byte, error) {
- type noMethod GaDataQuery
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Goal: JSON template for Analytics goal resource.
-type Goal struct {
- // AccountId: Account ID to which this goal belongs.
- AccountId string `json:"accountId,omitempty"`
-
- // Active: Determines whether this goal is active.
- Active bool `json:"active,omitempty"`
-
- // Created: Time this goal was created.
- Created string `json:"created,omitempty"`
-
- // EventDetails: Details for the goal of the type EVENT.
- EventDetails *GoalEventDetails `json:"eventDetails,omitempty"`
-
- // Id: Goal ID.
- Id string `json:"id,omitempty"`
-
- // InternalWebPropertyId: Internal ID for the web property to which this
- // goal belongs.
- InternalWebPropertyId string `json:"internalWebPropertyId,omitempty"`
-
- // Kind: Resource type for an Analytics goal.
- Kind string `json:"kind,omitempty"`
-
- // Name: Goal name.
- Name string `json:"name,omitempty"`
-
- // ParentLink: Parent link for a goal. Points to the view (profile) to
- // which this goal belongs.
- ParentLink *GoalParentLink `json:"parentLink,omitempty"`
-
- // ProfileId: View (Profile) ID to which this goal belongs.
- ProfileId string `json:"profileId,omitempty"`
-
- // SelfLink: Link for this goal.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Type: Goal type. Possible values are URL_DESTINATION,
- // VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
- Type string `json:"type,omitempty"`
-
- // Updated: Time this goal was last modified.
- Updated string `json:"updated,omitempty"`
-
- // UrlDestinationDetails: Details for the goal of the type
- // URL_DESTINATION.
- UrlDestinationDetails *GoalUrlDestinationDetails `json:"urlDestinationDetails,omitempty"`
-
- // Value: Goal value.
- Value float64 `json:"value,omitempty"`
-
- // VisitNumPagesDetails: Details for the goal of the type
- // VISIT_NUM_PAGES.
- VisitNumPagesDetails *GoalVisitNumPagesDetails `json:"visitNumPagesDetails,omitempty"`
-
- // VisitTimeOnSiteDetails: Details for the goal of the type
- // VISIT_TIME_ON_SITE.
- VisitTimeOnSiteDetails *GoalVisitTimeOnSiteDetails `json:"visitTimeOnSiteDetails,omitempty"`
-
- // WebPropertyId: Web property ID to which this goal belongs. The web
- // property ID is of the form UA-XXXXX-YY.
- WebPropertyId string `json:"webPropertyId,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Goal) MarshalJSON() ([]byte, error) {
- type noMethod Goal
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// GoalEventDetails: Details for the goal of the type EVENT.
-type GoalEventDetails struct {
- // EventConditions: List of event conditions.
- EventConditions []*GoalEventDetailsEventConditions `json:"eventConditions,omitempty"`
-
- // UseEventValue: Determines if the event value should be used as the
- // value for this goal.
- UseEventValue bool `json:"useEventValue,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "EventConditions") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GoalEventDetails) MarshalJSON() ([]byte, error) {
- type noMethod GoalEventDetails
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GoalEventDetailsEventConditions struct {
- // ComparisonType: Type of comparison. Possible values are LESS_THAN,
- // GREATER_THAN or EQUAL.
- ComparisonType string `json:"comparisonType,omitempty"`
-
- // ComparisonValue: Value used for this comparison.
- ComparisonValue int64 `json:"comparisonValue,omitempty,string"`
-
- // Expression: Expression used for this match.
- Expression string `json:"expression,omitempty"`
-
- // MatchType: Type of the match to be performed. Possible values are
- // REGEXP, BEGINS_WITH, or EXACT.
- MatchType string `json:"matchType,omitempty"`
-
- // Type: Type of this event condition. Possible values are CATEGORY,
- // ACTION, LABEL, or VALUE.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ComparisonType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GoalEventDetailsEventConditions) MarshalJSON() ([]byte, error) {
- type noMethod GoalEventDetailsEventConditions
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// GoalParentLink: Parent link for a goal. Points to the view (profile)
-// to which this goal belongs.
-type GoalParentLink struct {
- // Href: Link to the view (profile) to which this goal belongs.
- Href string `json:"href,omitempty"`
-
- // Type: Value is "analytics#profile".
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Href") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GoalParentLink) MarshalJSON() ([]byte, error) {
- type noMethod GoalParentLink
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// GoalUrlDestinationDetails: Details for the goal of the type
-// URL_DESTINATION.
-type GoalUrlDestinationDetails struct {
- // CaseSensitive: Determines if the goal URL must exactly match the
- // capitalization of visited URLs.
- CaseSensitive bool `json:"caseSensitive,omitempty"`
-
- // FirstStepRequired: Determines if the first step in this goal is
- // required.
- FirstStepRequired bool `json:"firstStepRequired,omitempty"`
-
- // MatchType: Match type for the goal URL. Possible values are HEAD,
- // EXACT, or REGEX.
- MatchType string `json:"matchType,omitempty"`
-
- // Steps: List of steps configured for this goal funnel.
- Steps []*GoalUrlDestinationDetailsSteps `json:"steps,omitempty"`
-
- // Url: URL for this goal.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CaseSensitive") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GoalUrlDestinationDetails) MarshalJSON() ([]byte, error) {
- type noMethod GoalUrlDestinationDetails
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GoalUrlDestinationDetailsSteps struct {
- // Name: Step name.
- Name string `json:"name,omitempty"`
-
- // Number: Step number.
- Number int64 `json:"number,omitempty"`
-
- // Url: URL for this step.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Name") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GoalUrlDestinationDetailsSteps) MarshalJSON() ([]byte, error) {
- type noMethod GoalUrlDestinationDetailsSteps
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// GoalVisitNumPagesDetails: Details for the goal of the type
-// VISIT_NUM_PAGES.
-type GoalVisitNumPagesDetails struct {
- // ComparisonType: Type of comparison. Possible values are LESS_THAN,
- // GREATER_THAN, or EQUAL.
- ComparisonType string `json:"comparisonType,omitempty"`
-
- // ComparisonValue: Value used for this comparison.
- ComparisonValue int64 `json:"comparisonValue,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "ComparisonType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GoalVisitNumPagesDetails) MarshalJSON() ([]byte, error) {
- type noMethod GoalVisitNumPagesDetails
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// GoalVisitTimeOnSiteDetails: Details for the goal of the type
-// VISIT_TIME_ON_SITE.
-type GoalVisitTimeOnSiteDetails struct {
- // ComparisonType: Type of comparison. Possible values are LESS_THAN or
- // GREATER_THAN.
- ComparisonType string `json:"comparisonType,omitempty"`
-
- // ComparisonValue: Value used for this comparison.
- ComparisonValue int64 `json:"comparisonValue,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "ComparisonType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GoalVisitTimeOnSiteDetails) MarshalJSON() ([]byte, error) {
- type noMethod GoalVisitTimeOnSiteDetails
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Goals: A goal collection lists Analytics goals to which the user has
-// access. Each view (profile) can have a set of goals. Each resource in
-// the Goal collection corresponds to a single Analytics goal.
-type Goals struct {
- // Items: A list of goals.
- Items []*Goal `json:"items,omitempty"`
-
- // ItemsPerPage: The maximum number of resources the response can
- // contain, regardless of the actual number of resources returned. Its
- // value ranges from 1 to 1000 with a value of 1000 by default, or
- // otherwise specified by the max-results query parameter.
- ItemsPerPage int64 `json:"itemsPerPage,omitempty"`
-
- // Kind: Collection type.
- Kind string `json:"kind,omitempty"`
-
- // NextLink: Link to next page for this goal collection.
- NextLink string `json:"nextLink,omitempty"`
-
- // PreviousLink: Link to previous page for this goal collection.
- PreviousLink string `json:"previousLink,omitempty"`
-
- // StartIndex: The starting index of the resources, which is 1 by
- // default or otherwise specified by the start-index query parameter.
- StartIndex int64 `json:"startIndex,omitempty"`
-
- // TotalResults: The total number of results for the query, regardless
- // of the number of resources in the result.
- TotalResults int64 `json:"totalResults,omitempty"`
-
- // Username: Email ID of the authenticated user
- Username string `json:"username,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Goals) MarshalJSON() ([]byte, error) {
- type noMethod Goals
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// McfData: Multi-Channel Funnels data for a given view (profile).
-type McfData struct {
- // ColumnHeaders: Column headers that list dimension names followed by
- // the metric names. The order of dimensions and metrics is same as
- // specified in the request.
- ColumnHeaders []*McfDataColumnHeaders `json:"columnHeaders,omitempty"`
-
- // ContainsSampledData: Determines if the Analytics data contains
- // sampled data.
- ContainsSampledData bool `json:"containsSampledData,omitempty"`
-
- // Id: Unique ID for this data response.
- Id string `json:"id,omitempty"`
-
- // ItemsPerPage: The maximum number of rows the response can contain,
- // regardless of the actual number of rows returned. Its value ranges
- // from 1 to 10,000 with a value of 1000 by default, or otherwise
- // specified by the max-results query parameter.
- ItemsPerPage int64 `json:"itemsPerPage,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // NextLink: Link to next page for this Analytics data query.
- NextLink string `json:"nextLink,omitempty"`
-
- // PreviousLink: Link to previous page for this Analytics data query.
- PreviousLink string `json:"previousLink,omitempty"`
-
- // ProfileInfo: Information for the view (profile), for which the
- // Analytics data was requested.
- ProfileInfo *McfDataProfileInfo `json:"profileInfo,omitempty"`
-
- // Query: Analytics data request query parameters.
- Query *McfDataQuery `json:"query,omitempty"`
-
- // Rows: Analytics data rows, where each row contains a list of
- // dimension values followed by the metric values. The order of
- // dimensions and metrics is same as specified in the request.
- Rows [][]*McfDataRowsItem `json:"rows,omitempty"`
-
- // SampleSize: The number of samples used to calculate the result.
- SampleSize int64 `json:"sampleSize,omitempty,string"`
-
- // SampleSpace: Total size of the sample space from which the samples
- // were selected.
- SampleSpace int64 `json:"sampleSpace,omitempty,string"`
-
- // SelfLink: Link to this page.
- SelfLink string `json:"selfLink,omitempty"`
-
- // TotalResults: The total number of rows for the query, regardless of
- // the number of rows in the response.
- TotalResults int64 `json:"totalResults,omitempty"`
-
- // TotalsForAllResults: Total values for the requested metrics over all
- // the results, not just the results returned in this response. The
- // order of the metric totals is same as the metric order specified in
- // the request.
- TotalsForAllResults map[string]string `json:"totalsForAllResults,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ColumnHeaders") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *McfData) MarshalJSON() ([]byte, error) {
- type noMethod McfData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type McfDataColumnHeaders struct {
- // ColumnType: Column Type. Either DIMENSION or METRIC.
- ColumnType string `json:"columnType,omitempty"`
-
- // DataType: Data type. Dimension and metric values data types such as
- // INTEGER, DOUBLE, CURRENCY, MCF_SEQUENCE etc.
- DataType string `json:"dataType,omitempty"`
-
- // Name: Column name.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ColumnType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *McfDataColumnHeaders) MarshalJSON() ([]byte, error) {
- type noMethod McfDataColumnHeaders
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// McfDataProfileInfo: Information for the view (profile), for which the
-// Analytics data was requested.
-type McfDataProfileInfo struct {
- // AccountId: Account ID to which this view (profile) belongs.
- AccountId string `json:"accountId,omitempty"`
-
- // InternalWebPropertyId: Internal ID for the web property to which this
- // view (profile) belongs.
- InternalWebPropertyId string `json:"internalWebPropertyId,omitempty"`
-
- // ProfileId: View (Profile) ID.
- ProfileId string `json:"profileId,omitempty"`
-
- // ProfileName: View (Profile) name.
- ProfileName string `json:"profileName,omitempty"`
-
- // TableId: Table ID for view (profile).
- TableId string `json:"tableId,omitempty"`
-
- // WebPropertyId: Web Property ID to which this view (profile) belongs.
- WebPropertyId string `json:"webPropertyId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *McfDataProfileInfo) MarshalJSON() ([]byte, error) {
- type noMethod McfDataProfileInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// McfDataQuery: Analytics data request query parameters.
-type McfDataQuery struct {
- // Dimensions: List of analytics dimensions.
- Dimensions string `json:"dimensions,omitempty"`
-
- // EndDate: End date.
- EndDate string `json:"end-date,omitempty"`
-
- // Filters: Comma-separated list of dimension or metric filters.
- Filters string `json:"filters,omitempty"`
-
- // Ids: Unique table ID.
- Ids string `json:"ids,omitempty"`
-
- // MaxResults: Maximum results per page.
- MaxResults int64 `json:"max-results,omitempty"`
-
- // Metrics: List of analytics metrics.
- Metrics []string `json:"metrics,omitempty"`
-
- // SamplingLevel: Desired sampling level
- SamplingLevel string `json:"samplingLevel,omitempty"`
-
- // Segment: Analytics advanced segment.
- Segment string `json:"segment,omitempty"`
-
- // Sort: List of dimensions or metrics based on which Analytics data is
- // sorted.
- Sort []string `json:"sort,omitempty"`
-
- // StartDate: Start date.
- StartDate string `json:"start-date,omitempty"`
-
- // StartIndex: Start index.
- StartIndex int64 `json:"start-index,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Dimensions") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *McfDataQuery) MarshalJSON() ([]byte, error) {
- type noMethod McfDataQuery
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// McfDataRowsItem: A union object representing a dimension or metric
-// value. Only one of "primitiveValue" or "conversionPathValue"
-// attribute will be populated.
-type McfDataRowsItem struct {
- // ConversionPathValue: A conversion path dimension value, containing a
- // list of interactions with their attributes.
- ConversionPathValue []*McfDataRowsItemConversionPathValue `json:"conversionPathValue,omitempty"`
-
- // PrimitiveValue: A primitive dimension value. A primitive metric
- // value.
- PrimitiveValue string `json:"primitiveValue,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ConversionPathValue")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *McfDataRowsItem) MarshalJSON() ([]byte, error) {
- type noMethod McfDataRowsItem
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type McfDataRowsItemConversionPathValue struct {
- // InteractionType: Type of an interaction on conversion path. Such as
- // CLICK, IMPRESSION etc.
- InteractionType string `json:"interactionType,omitempty"`
-
- // NodeValue: Node value of an interaction on conversion path. Such as
- // source, medium etc.
- NodeValue string `json:"nodeValue,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "InteractionType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *McfDataRowsItemConversionPathValue) MarshalJSON() ([]byte, error) {
- type noMethod McfDataRowsItemConversionPathValue
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Profile: JSON template for an Analytics view (profile).
-type Profile struct {
- // AccountId: Account ID to which this view (profile) belongs.
- AccountId string `json:"accountId,omitempty"`
-
- // ChildLink: Child link for this view (profile). Points to the list of
- // goals for this view (profile).
- ChildLink *ProfileChildLink `json:"childLink,omitempty"`
-
- // Created: Time this view (profile) was created.
- Created string `json:"created,omitempty"`
-
- // Currency: The currency type associated with this view (profile),
- // defaults to USD. The supported values are:
- // ARS, AUD, BGN, BRL, CAD, CHF, CNY, CZK, DKK, EUR, GBP, HKD, HUF, IDR,
- // INR, JPY, KRW, LTL, MXN, NOK, NZD, PHP, PLN, RUB, SEK, THB, TRY, TWD,
- // USD, VND, ZAR
- Currency string `json:"currency,omitempty"`
-
- // DefaultPage: Default page for this view (profile).
- DefaultPage string `json:"defaultPage,omitempty"`
-
- // ECommerceTracking: Indicates whether ecommerce tracking is enabled
- // for this view (profile).
- ECommerceTracking bool `json:"eCommerceTracking,omitempty"`
-
- // EnhancedECommerceTracking: Indicates whether enhanced ecommerce
- // tracking is enabled for this view (profile). This property can only
- // be enabled if ecommerce tracking is enabled.
- EnhancedECommerceTracking bool `json:"enhancedECommerceTracking,omitempty"`
-
- // ExcludeQueryParameters: The query parameters that are excluded from
- // this view (profile).
- ExcludeQueryParameters string `json:"excludeQueryParameters,omitempty"`
-
- // Id: View (Profile) ID.
- Id string `json:"id,omitempty"`
-
- // InternalWebPropertyId: Internal ID for the web property to which this
- // view (profile) belongs.
- InternalWebPropertyId string `json:"internalWebPropertyId,omitempty"`
-
- // Kind: Resource type for Analytics view (profile).
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this view (profile).
- Name string `json:"name,omitempty"`
-
- // ParentLink: Parent link for this view (profile). Points to the web
- // property to which this view (profile) belongs.
- ParentLink *ProfileParentLink `json:"parentLink,omitempty"`
-
- // Permissions: Permissions the user has for this view (profile).
- Permissions *ProfilePermissions `json:"permissions,omitempty"`
-
- // SelfLink: Link for this view (profile).
- SelfLink string `json:"selfLink,omitempty"`
-
- // SiteSearchCategoryParameters: Site search category parameters for
- // this view (profile).
- SiteSearchCategoryParameters string `json:"siteSearchCategoryParameters,omitempty"`
-
- // SiteSearchQueryParameters: The site search query parameters for this
- // view (profile).
- SiteSearchQueryParameters string `json:"siteSearchQueryParameters,omitempty"`
-
- // StripSiteSearchCategoryParameters: Whether or not Analytics will
- // strip search category parameters from the URLs in your reports.
- StripSiteSearchCategoryParameters bool `json:"stripSiteSearchCategoryParameters,omitempty"`
-
- // StripSiteSearchQueryParameters: Whether or not Analytics will strip
- // search query parameters from the URLs in your reports.
- StripSiteSearchQueryParameters bool `json:"stripSiteSearchQueryParameters,omitempty"`
-
- // Timezone: Time zone for which this view (profile) has been
- // configured. Time zones are identified by strings from the TZ
- // database.
- Timezone string `json:"timezone,omitempty"`
-
- // Type: View (Profile) type. Supported types: WEB or APP.
- Type string `json:"type,omitempty"`
-
- // Updated: Time this view (profile) was last modified.
- Updated string `json:"updated,omitempty"`
-
- // WebPropertyId: Web property ID of the form UA-XXXXX-YY to which this
- // view (profile) belongs.
- WebPropertyId string `json:"webPropertyId,omitempty"`
-
- // WebsiteUrl: Website URL for this view (profile).
- WebsiteUrl string `json:"websiteUrl,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Profile) MarshalJSON() ([]byte, error) {
- type noMethod Profile
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ProfileChildLink: Child link for this view (profile). Points to the
-// list of goals for this view (profile).
-type ProfileChildLink struct {
- // Href: Link to the list of goals for this view (profile).
- Href string `json:"href,omitempty"`
-
- // Type: Value is "analytics#goals".
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Href") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProfileChildLink) MarshalJSON() ([]byte, error) {
- type noMethod ProfileChildLink
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ProfileParentLink: Parent link for this view (profile). Points to the
-// web property to which this view (profile) belongs.
-type ProfileParentLink struct {
- // Href: Link to the web property to which this view (profile) belongs.
- Href string `json:"href,omitempty"`
-
- // Type: Value is "analytics#webproperty".
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Href") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProfileParentLink) MarshalJSON() ([]byte, error) {
- type noMethod ProfileParentLink
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ProfilePermissions: Permissions the user has for this view (profile).
-type ProfilePermissions struct {
- // Effective: All the permissions that the user has for this view
- // (profile). These include any implied permissions (e.g., EDIT implies
- // VIEW) or inherited permissions from the parent web property.
- Effective []string `json:"effective,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Effective") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProfilePermissions) MarshalJSON() ([]byte, error) {
- type noMethod ProfilePermissions
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ProfileFilterLink: JSON template for an Analytics profile filter
-// link.
-type ProfileFilterLink struct {
- // FilterRef: Filter for this link.
- FilterRef *FilterRef `json:"filterRef,omitempty"`
-
- // Id: Profile filter link ID.
- Id string `json:"id,omitempty"`
-
- // Kind: Resource type for Analytics filter.
- Kind string `json:"kind,omitempty"`
-
- // ProfileRef: View (Profile) for this link.
- ProfileRef *ProfileRef `json:"profileRef,omitempty"`
-
- // Rank: The rank of this profile filter link relative to the other
- // filters linked to the same profile.
- // For readonly (i.e., list and get) operations, the rank always starts
- // at 1.
- // For write (i.e., create, update, or delete) operations, you may
- // specify a value between 0 and 255 inclusively, [0, 255]. In order to
- // insert a link at the end of the list, either don't specify a rank or
- // set a rank to a number greater than the largest rank in the list. In
- // order to insert a link to the beginning of the list specify a rank
- // that is less than or equal to 1. The new link will move all existing
- // filters with the same or lower rank down the list. After the link is
- // inserted/updated/deleted all profile filter links will be renumbered
- // starting at 1.
- Rank int64 `json:"rank,omitempty"`
-
- // SelfLink: Link for this profile filter link.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "FilterRef") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProfileFilterLink) MarshalJSON() ([]byte, error) {
- type noMethod ProfileFilterLink
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ProfileFilterLinks: A profile filter link collection lists profile
-// filter links between profiles and filters. Each resource in the
-// collection corresponds to a profile filter link.
-type ProfileFilterLinks struct {
- // Items: A list of profile filter links.
- Items []*ProfileFilterLink `json:"items,omitempty"`
-
- // ItemsPerPage: The maximum number of resources the response can
- // contain, regardless of the actual number of resources returned. Its
- // value ranges from 1 to 1,000 with a value of 1000 by default, or
- // otherwise specified by the max-results query parameter.
- ItemsPerPage int64 `json:"itemsPerPage,omitempty"`
-
- // Kind: Collection type.
- Kind string `json:"kind,omitempty"`
-
- // NextLink: Link to next page for this profile filter link collection.
- NextLink string `json:"nextLink,omitempty"`
-
- // PreviousLink: Link to previous page for this profile filter link
- // collection.
- PreviousLink string `json:"previousLink,omitempty"`
-
- // StartIndex: The starting index of the resources, which is 1 by
- // default or otherwise specified by the start-index query parameter.
- StartIndex int64 `json:"startIndex,omitempty"`
-
- // TotalResults: The total number of results for the query, regardless
- // of the number of results in the response.
- TotalResults int64 `json:"totalResults,omitempty"`
-
- // Username: Email ID of the authenticated user
- Username string `json:"username,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProfileFilterLinks) MarshalJSON() ([]byte, error) {
- type noMethod ProfileFilterLinks
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ProfileRef: JSON template for a linked view (profile).
-type ProfileRef struct {
- // AccountId: Account ID to which this view (profile) belongs.
- AccountId string `json:"accountId,omitempty"`
-
- // Href: Link for this view (profile).
- Href string `json:"href,omitempty"`
-
- // Id: View (Profile) ID.
- Id string `json:"id,omitempty"`
-
- // InternalWebPropertyId: Internal ID for the web property to which this
- // view (profile) belongs.
- InternalWebPropertyId string `json:"internalWebPropertyId,omitempty"`
-
- // Kind: Analytics view (profile) reference.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this view (profile).
- Name string `json:"name,omitempty"`
-
- // WebPropertyId: Web property ID of the form UA-XXXXX-YY to which this
- // view (profile) belongs.
- WebPropertyId string `json:"webPropertyId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProfileRef) MarshalJSON() ([]byte, error) {
- type noMethod ProfileRef
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ProfileSummary: JSON template for an Analytics ProfileSummary.
-// ProfileSummary returns basic information (i.e., summary) for a
-// profile.
-type ProfileSummary struct {
- // Id: View (profile) ID.
- Id string `json:"id,omitempty"`
-
- // Kind: Resource type for Analytics ProfileSummary.
- Kind string `json:"kind,omitempty"`
-
- // Name: View (profile) name.
- Name string `json:"name,omitempty"`
-
- // Type: View (Profile) type. Supported types: WEB or APP.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProfileSummary) MarshalJSON() ([]byte, error) {
- type noMethod ProfileSummary
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Profiles: A view (profile) collection lists Analytics views
-// (profiles) to which the user has access. Each resource in the
-// collection corresponds to a single Analytics view (profile).
-type Profiles struct {
- // Items: A list of views (profiles).
- Items []*Profile `json:"items,omitempty"`
-
- // ItemsPerPage: The maximum number of resources the response can
- // contain, regardless of the actual number of resources returned. Its
- // value ranges from 1 to 1000 with a value of 1000 by default, or
- // otherwise specified by the max-results query parameter.
- ItemsPerPage int64 `json:"itemsPerPage,omitempty"`
-
- // Kind: Collection type.
- Kind string `json:"kind,omitempty"`
-
- // NextLink: Link to next page for this view (profile) collection.
- NextLink string `json:"nextLink,omitempty"`
-
- // PreviousLink: Link to previous page for this view (profile)
- // collection.
- PreviousLink string `json:"previousLink,omitempty"`
-
- // StartIndex: The starting index of the resources, which is 1 by
- // default or otherwise specified by the start-index query parameter.
- StartIndex int64 `json:"startIndex,omitempty"`
-
- // TotalResults: The total number of results for the query, regardless
- // of the number of results in the response.
- TotalResults int64 `json:"totalResults,omitempty"`
-
- // Username: Email ID of the authenticated user
- Username string `json:"username,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Profiles) MarshalJSON() ([]byte, error) {
- type noMethod Profiles
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// RealtimeData: Real time data for a given view (profile).
-type RealtimeData struct {
- // ColumnHeaders: Column headers that list dimension names followed by
- // the metric names. The order of dimensions and metrics is same as
- // specified in the request.
- ColumnHeaders []*RealtimeDataColumnHeaders `json:"columnHeaders,omitempty"`
-
- // Id: Unique ID for this data response.
- Id string `json:"id,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // ProfileInfo: Information for the view (profile), for which the real
- // time data was requested.
- ProfileInfo *RealtimeDataProfileInfo `json:"profileInfo,omitempty"`
-
- // Query: Real time data request query parameters.
- Query *RealtimeDataQuery `json:"query,omitempty"`
-
- // Rows: Real time data rows, where each row contains a list of
- // dimension values followed by the metric values. The order of
- // dimensions and metrics is same as specified in the request.
- Rows [][]string `json:"rows,omitempty"`
-
- // SelfLink: Link to this page.
- SelfLink string `json:"selfLink,omitempty"`
-
- // TotalResults: The total number of rows for the query, regardless of
- // the number of rows in the response.
- TotalResults int64 `json:"totalResults,omitempty"`
-
- // TotalsForAllResults: Total values for the requested metrics over all
- // the results, not just the results returned in this response. The
- // order of the metric totals is same as the metric order specified in
- // the request.
- TotalsForAllResults map[string]string `json:"totalsForAllResults,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ColumnHeaders") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RealtimeData) MarshalJSON() ([]byte, error) {
- type noMethod RealtimeData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type RealtimeDataColumnHeaders struct {
- // ColumnType: Column Type. Either DIMENSION or METRIC.
- ColumnType string `json:"columnType,omitempty"`
-
- // DataType: Data type. Dimension column headers have only STRING as the
- // data type. Metric column headers have data types for metric values
- // such as INTEGER, DOUBLE, CURRENCY etc.
- DataType string `json:"dataType,omitempty"`
-
- // Name: Column name.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ColumnType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RealtimeDataColumnHeaders) MarshalJSON() ([]byte, error) {
- type noMethod RealtimeDataColumnHeaders
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// RealtimeDataProfileInfo: Information for the view (profile), for
-// which the real time data was requested.
-type RealtimeDataProfileInfo struct {
- // AccountId: Account ID to which this view (profile) belongs.
- AccountId string `json:"accountId,omitempty"`
-
- // InternalWebPropertyId: Internal ID for the web property to which this
- // view (profile) belongs.
- InternalWebPropertyId string `json:"internalWebPropertyId,omitempty"`
-
- // ProfileId: View (Profile) ID.
- ProfileId string `json:"profileId,omitempty"`
-
- // ProfileName: View (Profile) name.
- ProfileName string `json:"profileName,omitempty"`
-
- // TableId: Table ID for view (profile).
- TableId string `json:"tableId,omitempty"`
-
- // WebPropertyId: Web Property ID to which this view (profile) belongs.
- WebPropertyId string `json:"webPropertyId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RealtimeDataProfileInfo) MarshalJSON() ([]byte, error) {
- type noMethod RealtimeDataProfileInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// RealtimeDataQuery: Real time data request query parameters.
-type RealtimeDataQuery struct {
- // Dimensions: List of real time dimensions.
- Dimensions string `json:"dimensions,omitempty"`
-
- // Filters: Comma-separated list of dimension or metric filters.
- Filters string `json:"filters,omitempty"`
-
- // Ids: Unique table ID.
- Ids string `json:"ids,omitempty"`
-
- // MaxResults: Maximum results per page.
- MaxResults int64 `json:"max-results,omitempty"`
-
- // Metrics: List of real time metrics.
- Metrics []string `json:"metrics,omitempty"`
-
- // Sort: List of dimensions or metrics based on which real time data is
- // sorted.
- Sort []string `json:"sort,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Dimensions") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RealtimeDataQuery) MarshalJSON() ([]byte, error) {
- type noMethod RealtimeDataQuery
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Segment: JSON template for an Analytics segment.
-type Segment struct {
- // Created: Time the segment was created.
- Created string `json:"created,omitempty"`
-
- // Definition: Segment definition.
- Definition string `json:"definition,omitempty"`
-
- // Id: Segment ID.
- Id string `json:"id,omitempty"`
-
- // Kind: Resource type for Analytics segment.
- Kind string `json:"kind,omitempty"`
-
- // Name: Segment name.
- Name string `json:"name,omitempty"`
-
- // SegmentId: Segment ID. Can be used with the 'segment' parameter in
- // Core Reporting API.
- SegmentId string `json:"segmentId,omitempty"`
-
- // SelfLink: Link for this segment.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Type: Type for a segment. Possible values are "BUILT_IN" or "CUSTOM".
- Type string `json:"type,omitempty"`
-
- // Updated: Time the segment was last modified.
- Updated string `json:"updated,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Created") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Segment) MarshalJSON() ([]byte, error) {
- type noMethod Segment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Segments: An segment collection lists Analytics segments that the
-// user has access to. Each resource in the collection corresponds to a
-// single Analytics segment.
-type Segments struct {
- // Items: A list of segments.
- Items []*Segment `json:"items,omitempty"`
-
- // ItemsPerPage: The maximum number of resources the response can
- // contain, regardless of the actual number of resources returned. Its
- // value ranges from 1 to 1000 with a value of 1000 by default, or
- // otherwise specified by the max-results query parameter.
- ItemsPerPage int64 `json:"itemsPerPage,omitempty"`
-
- // Kind: Collection type for segments.
- Kind string `json:"kind,omitempty"`
-
- // NextLink: Link to next page for this segment collection.
- NextLink string `json:"nextLink,omitempty"`
-
- // PreviousLink: Link to previous page for this segment collection.
- PreviousLink string `json:"previousLink,omitempty"`
-
- // StartIndex: The starting index of the resources, which is 1 by
- // default or otherwise specified by the start-index query parameter.
- StartIndex int64 `json:"startIndex,omitempty"`
-
- // TotalResults: The total number of results for the query, regardless
- // of the number of results in the response.
- TotalResults int64 `json:"totalResults,omitempty"`
-
- // Username: Email ID of the authenticated user
- Username string `json:"username,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Segments) MarshalJSON() ([]byte, error) {
- type noMethod Segments
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UnsampledReport: JSON template for Analytics unsampled report
-// resource.
-type UnsampledReport struct {
- // AccountId: Account ID to which this unsampled report belongs.
- AccountId string `json:"accountId,omitempty"`
-
- // CloudStorageDownloadDetails: Download details for a file stored in
- // Google Cloud Storage.
- CloudStorageDownloadDetails *UnsampledReportCloudStorageDownloadDetails `json:"cloudStorageDownloadDetails,omitempty"`
-
- // Created: Time this unsampled report was created.
- Created string `json:"created,omitempty"`
-
- // Dimensions: The dimensions for the unsampled report.
- Dimensions string `json:"dimensions,omitempty"`
-
- // DownloadType: The type of download you need to use for the report
- // data file.
- DownloadType string `json:"downloadType,omitempty"`
-
- // DriveDownloadDetails: Download details for a file stored in Google
- // Drive.
- DriveDownloadDetails *UnsampledReportDriveDownloadDetails `json:"driveDownloadDetails,omitempty"`
-
- // EndDate: The end date for the unsampled report.
- EndDate string `json:"end-date,omitempty"`
-
- // Filters: The filters for the unsampled report.
- Filters string `json:"filters,omitempty"`
-
- // Id: Unsampled report ID.
- Id string `json:"id,omitempty"`
-
- // Kind: Resource type for an Analytics unsampled report.
- Kind string `json:"kind,omitempty"`
-
- // Metrics: The metrics for the unsampled report.
- Metrics string `json:"metrics,omitempty"`
-
- // ProfileId: View (Profile) ID to which this unsampled report belongs.
- ProfileId string `json:"profileId,omitempty"`
-
- // Segment: The segment for the unsampled report.
- Segment string `json:"segment,omitempty"`
-
- // SelfLink: Link for this unsampled report.
- SelfLink string `json:"selfLink,omitempty"`
-
- // StartDate: The start date for the unsampled report.
- StartDate string `json:"start-date,omitempty"`
-
- // Status: Status of this unsampled report. Possible values are PENDING,
- // COMPLETED, or FAILED.
- Status string `json:"status,omitempty"`
-
- // Title: Title of the unsampled report.
- Title string `json:"title,omitempty"`
-
- // Updated: Time this unsampled report was last modified.
- Updated string `json:"updated,omitempty"`
-
- // WebPropertyId: Web property ID to which this unsampled report
- // belongs. The web property ID is of the form UA-XXXXX-YY.
- WebPropertyId string `json:"webPropertyId,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UnsampledReport) MarshalJSON() ([]byte, error) {
- type noMethod UnsampledReport
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UnsampledReportCloudStorageDownloadDetails: Download details for a
-// file stored in Google Cloud Storage.
-type UnsampledReportCloudStorageDownloadDetails struct {
- // BucketId: Id of the bucket the file object is stored in.
- BucketId string `json:"bucketId,omitempty"`
-
- // ObjectId: Id of the file object containing the report data.
- ObjectId string `json:"objectId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BucketId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UnsampledReportCloudStorageDownloadDetails) MarshalJSON() ([]byte, error) {
- type noMethod UnsampledReportCloudStorageDownloadDetails
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UnsampledReportDriveDownloadDetails: Download details for a file
-// stored in Google Drive.
-type UnsampledReportDriveDownloadDetails struct {
- // DocumentId: Id of the document/file containing the report data.
- DocumentId string `json:"documentId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DocumentId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UnsampledReportDriveDownloadDetails) MarshalJSON() ([]byte, error) {
- type noMethod UnsampledReportDriveDownloadDetails
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UnsampledReports: An unsampled report collection lists Analytics
-// unsampled reports to which the user has access. Each view (profile)
-// can have a set of unsampled reports. Each resource in the unsampled
-// report collection corresponds to a single Analytics unsampled report.
-type UnsampledReports struct {
- // Items: A list of unsampled reports.
- Items []*UnsampledReport `json:"items,omitempty"`
-
- // ItemsPerPage: The maximum number of resources the response can
- // contain, regardless of the actual number of resources returned. Its
- // value ranges from 1 to 1000 with a value of 1000 by default, or
- // otherwise specified by the max-results query parameter.
- ItemsPerPage int64 `json:"itemsPerPage,omitempty"`
-
- // Kind: Collection type.
- Kind string `json:"kind,omitempty"`
-
- // NextLink: Link to next page for this unsampled report collection.
- NextLink string `json:"nextLink,omitempty"`
-
- // PreviousLink: Link to previous page for this unsampled report
- // collection.
- PreviousLink string `json:"previousLink,omitempty"`
-
- // StartIndex: The starting index of the resources, which is 1 by
- // default or otherwise specified by the start-index query parameter.
- StartIndex int64 `json:"startIndex,omitempty"`
-
- // TotalResults: The total number of results for the query, regardless
- // of the number of resources in the result.
- TotalResults int64 `json:"totalResults,omitempty"`
-
- // Username: Email ID of the authenticated user
- Username string `json:"username,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UnsampledReports) MarshalJSON() ([]byte, error) {
- type noMethod UnsampledReports
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Upload: Metadata returned for an upload operation.
-type Upload struct {
- // AccountId: Account Id to which this upload belongs.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // CustomDataSourceId: Custom data source Id to which this data import
- // belongs.
- CustomDataSourceId string `json:"customDataSourceId,omitempty"`
-
- // Errors: Data import errors collection.
- Errors []string `json:"errors,omitempty"`
-
- // Id: A unique ID for this upload.
- Id string `json:"id,omitempty"`
-
- // Kind: Resource type for Analytics upload.
- Kind string `json:"kind,omitempty"`
-
- // Status: Upload status. Possible values: PENDING, COMPLETED, FAILED,
- // DELETING, DELETED.
- Status string `json:"status,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Upload) MarshalJSON() ([]byte, error) {
- type noMethod Upload
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Uploads: Upload collection lists Analytics uploads to which the user
-// has access. Each custom data source can have a set of uploads. Each
-// resource in the upload collection corresponds to a single Analytics
-// data upload.
-type Uploads struct {
- // Items: A list of uploads.
- Items []*Upload `json:"items,omitempty"`
-
- // ItemsPerPage: The maximum number of resources the response can
- // contain, regardless of the actual number of resources returned. Its
- // value ranges from 1 to 1000 with a value of 1000 by default, or
- // otherwise specified by the max-results query parameter.
- ItemsPerPage int64 `json:"itemsPerPage,omitempty"`
-
- // Kind: Collection type.
- Kind string `json:"kind,omitempty"`
-
- // NextLink: Link to next page for this upload collection.
- NextLink string `json:"nextLink,omitempty"`
-
- // PreviousLink: Link to previous page for this upload collection.
- PreviousLink string `json:"previousLink,omitempty"`
-
- // StartIndex: The starting index of the resources, which is 1 by
- // default or otherwise specified by the start-index query parameter.
- StartIndex int64 `json:"startIndex,omitempty"`
-
- // TotalResults: The total number of results for the query, regardless
- // of the number of resources in the result.
- TotalResults int64 `json:"totalResults,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Uploads) MarshalJSON() ([]byte, error) {
- type noMethod Uploads
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserRef: JSON template for a user reference.
-type UserRef struct {
- // Email: Email ID of this user.
- Email string `json:"email,omitempty"`
-
- // Id: User ID.
- Id string `json:"id,omitempty"`
-
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Email") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserRef) MarshalJSON() ([]byte, error) {
- type noMethod UserRef
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// WebPropertyRef: JSON template for a web property reference.
-type WebPropertyRef struct {
- // AccountId: Account ID to which this web property belongs.
- AccountId string `json:"accountId,omitempty"`
-
- // Href: Link for this web property.
- Href string `json:"href,omitempty"`
-
- // Id: Web property ID of the form UA-XXXXX-YY.
- Id string `json:"id,omitempty"`
-
- // InternalWebPropertyId: Internal ID for this web property.
- InternalWebPropertyId string `json:"internalWebPropertyId,omitempty"`
-
- // Kind: Analytics web property reference.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this web property.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *WebPropertyRef) MarshalJSON() ([]byte, error) {
- type noMethod WebPropertyRef
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// WebPropertySummary: JSON template for an Analytics
-// WebPropertySummary. WebPropertySummary returns basic information
-// (i.e., summary) for a web property.
-type WebPropertySummary struct {
- // Id: Web property ID of the form UA-XXXXX-YY.
- Id string `json:"id,omitempty"`
-
- // InternalWebPropertyId: Internal ID for this web property.
- InternalWebPropertyId string `json:"internalWebPropertyId,omitempty"`
-
- // Kind: Resource type for Analytics WebPropertySummary.
- Kind string `json:"kind,omitempty"`
-
- // Level: Level for this web property. Possible values are STANDARD or
- // PREMIUM.
- Level string `json:"level,omitempty"`
-
- // Name: Web property name.
- Name string `json:"name,omitempty"`
-
- // Profiles: List of profiles under this web property.
- Profiles []*ProfileSummary `json:"profiles,omitempty"`
-
- // WebsiteUrl: Website url for this web property.
- WebsiteUrl string `json:"websiteUrl,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *WebPropertySummary) MarshalJSON() ([]byte, error) {
- type noMethod WebPropertySummary
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Webproperties: A web property collection lists Analytics web
-// properties to which the user has access. Each resource in the
-// collection corresponds to a single Analytics web property.
-type Webproperties struct {
- // Items: A list of web properties.
- Items []*Webproperty `json:"items,omitempty"`
-
- // ItemsPerPage: The maximum number of resources the response can
- // contain, regardless of the actual number of resources returned. Its
- // value ranges from 1 to 1000 with a value of 1000 by default, or
- // otherwise specified by the max-results query parameter.
- ItemsPerPage int64 `json:"itemsPerPage,omitempty"`
-
- // Kind: Collection type.
- Kind string `json:"kind,omitempty"`
-
- // NextLink: Link to next page for this web property collection.
- NextLink string `json:"nextLink,omitempty"`
-
- // PreviousLink: Link to previous page for this web property collection.
- PreviousLink string `json:"previousLink,omitempty"`
-
- // StartIndex: The starting index of the resources, which is 1 by
- // default or otherwise specified by the start-index query parameter.
- StartIndex int64 `json:"startIndex,omitempty"`
-
- // TotalResults: The total number of results for the query, regardless
- // of the number of results in the response.
- TotalResults int64 `json:"totalResults,omitempty"`
-
- // Username: Email ID of the authenticated user
- Username string `json:"username,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Webproperties) MarshalJSON() ([]byte, error) {
- type noMethod Webproperties
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Webproperty: JSON template for an Analytics web property.
-type Webproperty struct {
- // AccountId: Account ID to which this web property belongs.
- AccountId string `json:"accountId,omitempty"`
-
- // ChildLink: Child link for this web property. Points to the list of
- // views (profiles) for this web property.
- ChildLink *WebpropertyChildLink `json:"childLink,omitempty"`
-
- // Created: Time this web property was created.
- Created string `json:"created,omitempty"`
-
- // DefaultProfileId: Default view (profile) ID.
- DefaultProfileId int64 `json:"defaultProfileId,omitempty,string"`
-
- // Id: Web property ID of the form UA-XXXXX-YY.
- Id string `json:"id,omitempty"`
-
- // IndustryVertical: The industry vertical/category selected for this
- // web property.
- IndustryVertical string `json:"industryVertical,omitempty"`
-
- // InternalWebPropertyId: Internal ID for this web property.
- InternalWebPropertyId string `json:"internalWebPropertyId,omitempty"`
-
- // Kind: Resource type for Analytics WebProperty.
- Kind string `json:"kind,omitempty"`
-
- // Level: Level for this web property. Possible values are STANDARD or
- // PREMIUM.
- Level string `json:"level,omitempty"`
-
- // Name: Name of this web property.
- Name string `json:"name,omitempty"`
-
- // ParentLink: Parent link for this web property. Points to the account
- // to which this web property belongs.
- ParentLink *WebpropertyParentLink `json:"parentLink,omitempty"`
-
- // Permissions: Permissions the user has for this web property.
- Permissions *WebpropertyPermissions `json:"permissions,omitempty"`
-
- // ProfileCount: View (Profile) count for this web property.
- ProfileCount int64 `json:"profileCount,omitempty"`
-
- // SelfLink: Link for this web property.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Updated: Time this web property was last modified.
- Updated string `json:"updated,omitempty"`
-
- // WebsiteUrl: Website url for this web property.
- WebsiteUrl string `json:"websiteUrl,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Webproperty) MarshalJSON() ([]byte, error) {
- type noMethod Webproperty
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// WebpropertyChildLink: Child link for this web property. Points to the
-// list of views (profiles) for this web property.
-type WebpropertyChildLink struct {
- // Href: Link to the list of views (profiles) for this web property.
- Href string `json:"href,omitempty"`
-
- // Type: Type of the parent link. Its value is "analytics#profiles".
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Href") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *WebpropertyChildLink) MarshalJSON() ([]byte, error) {
- type noMethod WebpropertyChildLink
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// WebpropertyParentLink: Parent link for this web property. Points to
-// the account to which this web property belongs.
-type WebpropertyParentLink struct {
- // Href: Link to the account for this web property.
- Href string `json:"href,omitempty"`
-
- // Type: Type of the parent link. Its value is "analytics#account".
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Href") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *WebpropertyParentLink) MarshalJSON() ([]byte, error) {
- type noMethod WebpropertyParentLink
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// WebpropertyPermissions: Permissions the user has for this web
-// property.
-type WebpropertyPermissions struct {
- // Effective: All the permissions that the user has for this web
- // property. These include any implied permissions (e.g., EDIT implies
- // VIEW) or inherited permissions from the parent account.
- Effective []string `json:"effective,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Effective") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *WebpropertyPermissions) MarshalJSON() ([]byte, error) {
- type noMethod WebpropertyPermissions
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "analytics.data.ga.get":
-
-type DataGaGetCall struct {
- s *Service
- ids string
- startDate string
- endDate string
- metrics string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns Analytics data for a view (profile).
-func (r *DataGaService) Get(ids string, startDate string, endDate string, metrics string) *DataGaGetCall {
- c := &DataGaGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.ids = ids
- c.startDate = startDate
- c.endDate = endDate
- c.metrics = metrics
- return c
-}
-
-// Dimensions sets the optional parameter "dimensions": A
-// comma-separated list of Analytics dimensions. E.g.,
-// 'ga:browser,ga:city'.
-func (c *DataGaGetCall) Dimensions(dimensions string) *DataGaGetCall {
- c.opt_["dimensions"] = dimensions
- return c
-}
-
-// Filters sets the optional parameter "filters": A comma-separated list
-// of dimension or metric filters to be applied to Analytics data.
-func (c *DataGaGetCall) Filters(filters string) *DataGaGetCall {
- c.opt_["filters"] = filters
- return c
-}
-
-// MaxResults sets the optional parameter "max-results": The maximum
-// number of entries to include in this feed.
-func (c *DataGaGetCall) MaxResults(maxResults int64) *DataGaGetCall {
- c.opt_["max-results"] = maxResults
- return c
-}
-
-// Output sets the optional parameter "output": The selected format for
-// the response. Default format is JSON.
-//
-// Possible values:
-// "dataTable" - Returns the response in Google Charts Data Table
-// format. This is useful in creating visualization using Google Charts.
-// "json" - Returns the response in standard JSON format.
-func (c *DataGaGetCall) Output(output string) *DataGaGetCall {
- c.opt_["output"] = output
- return c
-}
-
-// SamplingLevel sets the optional parameter "samplingLevel": The
-// desired sampling level.
-//
-// Possible values:
-// "DEFAULT" - Returns response with a sample size that balances speed
-// and accuracy.
-// "FASTER" - Returns a fast response with a smaller sample size.
-// "HIGHER_PRECISION" - Returns a more accurate response using a large
-// sample size, but this may result in the response being slower.
-func (c *DataGaGetCall) SamplingLevel(samplingLevel string) *DataGaGetCall {
- c.opt_["samplingLevel"] = samplingLevel
- return c
-}
-
-// Segment sets the optional parameter "segment": An Analytics segment
-// to be applied to data.
-func (c *DataGaGetCall) Segment(segment string) *DataGaGetCall {
- c.opt_["segment"] = segment
- return c
-}
-
-// Sort sets the optional parameter "sort": A comma-separated list of
-// dimensions or metrics that determine the sort order for Analytics
-// data.
-func (c *DataGaGetCall) Sort(sort string) *DataGaGetCall {
- c.opt_["sort"] = sort
- return c
-}
-
-// StartIndex sets the optional parameter "start-index": An index of the
-// first entity to retrieve. Use this parameter as a pagination
-// mechanism along with the max-results parameter.
-func (c *DataGaGetCall) StartIndex(startIndex int64) *DataGaGetCall {
- c.opt_["start-index"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DataGaGetCall) Fields(s ...googleapi.Field) *DataGaGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DataGaGetCall) IfNoneMatch(entityTag string) *DataGaGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DataGaGetCall) Context(ctx context.Context) *DataGaGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DataGaGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("end-date", fmt.Sprintf("%v", c.endDate))
- params.Set("ids", fmt.Sprintf("%v", c.ids))
- params.Set("metrics", fmt.Sprintf("%v", c.metrics))
- params.Set("start-date", fmt.Sprintf("%v", c.startDate))
- if v, ok := c.opt_["dimensions"]; ok {
- params.Set("dimensions", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["filters"]; ok {
- params.Set("filters", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["max-results"]; ok {
- params.Set("max-results", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["output"]; ok {
- params.Set("output", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["samplingLevel"]; ok {
- params.Set("samplingLevel", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["segment"]; ok {
- params.Set("segment", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sort"]; ok {
- params.Set("sort", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["start-index"]; ok {
- params.Set("start-index", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "data/ga")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.data.ga.get" call.
-// Exactly one of *GaData or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *GaData.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *DataGaGetCall) Do() (*GaData, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &GaData{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns Analytics data for a view (profile).",
- // "httpMethod": "GET",
- // "id": "analytics.data.ga.get",
- // "parameterOrder": [
- // "ids",
- // "start-date",
- // "end-date",
- // "metrics"
- // ],
- // "parameters": {
- // "dimensions": {
- // "description": "A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.",
- // "location": "query",
- // "pattern": "(ga:.+)?",
- // "type": "string"
- // },
- // "end-date": {
- // "description": "End date for fetching Analytics data. Request can should specify an end date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is yesterday.",
- // "location": "query",
- // "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)",
- // "required": true,
- // "type": "string"
- // },
- // "filters": {
- // "description": "A comma-separated list of dimension or metric filters to be applied to Analytics data.",
- // "location": "query",
- // "pattern": "ga:.+",
- // "type": "string"
- // },
- // "ids": {
- // "description": "Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.",
- // "location": "query",
- // "pattern": "ga:[0-9]+",
- // "required": true,
- // "type": "string"
- // },
- // "max-results": {
- // "description": "The maximum number of entries to include in this feed.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "metrics": {
- // "description": "A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified.",
- // "location": "query",
- // "pattern": "ga:.+",
- // "required": true,
- // "type": "string"
- // },
- // "output": {
- // "description": "The selected format for the response. Default format is JSON.",
- // "enum": [
- // "dataTable",
- // "json"
- // ],
- // "enumDescriptions": [
- // "Returns the response in Google Charts Data Table format. This is useful in creating visualization using Google Charts.",
- // "Returns the response in standard JSON format."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "samplingLevel": {
- // "description": "The desired sampling level.",
- // "enum": [
- // "DEFAULT",
- // "FASTER",
- // "HIGHER_PRECISION"
- // ],
- // "enumDescriptions": [
- // "Returns response with a sample size that balances speed and accuracy.",
- // "Returns a fast response with a smaller sample size.",
- // "Returns a more accurate response using a large sample size, but this may result in the response being slower."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "segment": {
- // "description": "An Analytics segment to be applied to data.",
- // "location": "query",
- // "type": "string"
- // },
- // "sort": {
- // "description": "A comma-separated list of dimensions or metrics that determine the sort order for Analytics data.",
- // "location": "query",
- // "pattern": "(-)?ga:.+",
- // "type": "string"
- // },
- // "start-date": {
- // "description": "Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.",
- // "location": "query",
- // "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)",
- // "required": true,
- // "type": "string"
- // },
- // "start-index": {
- // "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // }
- // },
- // "path": "data/ga",
- // "response": {
- // "$ref": "GaData"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.data.mcf.get":
-
-type DataMcfGetCall struct {
- s *Service
- ids string
- startDate string
- endDate string
- metrics string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns Analytics Multi-Channel Funnels data for a view
-// (profile).
-func (r *DataMcfService) Get(ids string, startDate string, endDate string, metrics string) *DataMcfGetCall {
- c := &DataMcfGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.ids = ids
- c.startDate = startDate
- c.endDate = endDate
- c.metrics = metrics
- return c
-}
-
-// Dimensions sets the optional parameter "dimensions": A
-// comma-separated list of Multi-Channel Funnels dimensions. E.g.,
-// 'mcf:source,mcf:medium'.
-func (c *DataMcfGetCall) Dimensions(dimensions string) *DataMcfGetCall {
- c.opt_["dimensions"] = dimensions
- return c
-}
-
-// Filters sets the optional parameter "filters": A comma-separated list
-// of dimension or metric filters to be applied to the Analytics data.
-func (c *DataMcfGetCall) Filters(filters string) *DataMcfGetCall {
- c.opt_["filters"] = filters
- return c
-}
-
-// MaxResults sets the optional parameter "max-results": The maximum
-// number of entries to include in this feed.
-func (c *DataMcfGetCall) MaxResults(maxResults int64) *DataMcfGetCall {
- c.opt_["max-results"] = maxResults
- return c
-}
-
-// SamplingLevel sets the optional parameter "samplingLevel": The
-// desired sampling level.
-//
-// Possible values:
-// "DEFAULT" - Returns response with a sample size that balances speed
-// and accuracy.
-// "FASTER" - Returns a fast response with a smaller sample size.
-// "HIGHER_PRECISION" - Returns a more accurate response using a large
-// sample size, but this may result in the response being slower.
-func (c *DataMcfGetCall) SamplingLevel(samplingLevel string) *DataMcfGetCall {
- c.opt_["samplingLevel"] = samplingLevel
- return c
-}
-
-// Sort sets the optional parameter "sort": A comma-separated list of
-// dimensions or metrics that determine the sort order for the Analytics
-// data.
-func (c *DataMcfGetCall) Sort(sort string) *DataMcfGetCall {
- c.opt_["sort"] = sort
- return c
-}
-
-// StartIndex sets the optional parameter "start-index": An index of the
-// first entity to retrieve. Use this parameter as a pagination
-// mechanism along with the max-results parameter.
-func (c *DataMcfGetCall) StartIndex(startIndex int64) *DataMcfGetCall {
- c.opt_["start-index"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DataMcfGetCall) Fields(s ...googleapi.Field) *DataMcfGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DataMcfGetCall) IfNoneMatch(entityTag string) *DataMcfGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DataMcfGetCall) Context(ctx context.Context) *DataMcfGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DataMcfGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("end-date", fmt.Sprintf("%v", c.endDate))
- params.Set("ids", fmt.Sprintf("%v", c.ids))
- params.Set("metrics", fmt.Sprintf("%v", c.metrics))
- params.Set("start-date", fmt.Sprintf("%v", c.startDate))
- if v, ok := c.opt_["dimensions"]; ok {
- params.Set("dimensions", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["filters"]; ok {
- params.Set("filters", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["max-results"]; ok {
- params.Set("max-results", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["samplingLevel"]; ok {
- params.Set("samplingLevel", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sort"]; ok {
- params.Set("sort", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["start-index"]; ok {
- params.Set("start-index", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "data/mcf")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.data.mcf.get" call.
-// Exactly one of *McfData or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *McfData.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *DataMcfGetCall) Do() (*McfData, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &McfData{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns Analytics Multi-Channel Funnels data for a view (profile).",
- // "httpMethod": "GET",
- // "id": "analytics.data.mcf.get",
- // "parameterOrder": [
- // "ids",
- // "start-date",
- // "end-date",
- // "metrics"
- // ],
- // "parameters": {
- // "dimensions": {
- // "description": "A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'.",
- // "location": "query",
- // "pattern": "(mcf:.+)?",
- // "type": "string"
- // },
- // "end-date": {
- // "description": "End date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.",
- // "location": "query",
- // "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)",
- // "required": true,
- // "type": "string"
- // },
- // "filters": {
- // "description": "A comma-separated list of dimension or metric filters to be applied to the Analytics data.",
- // "location": "query",
- // "pattern": "mcf:.+",
- // "type": "string"
- // },
- // "ids": {
- // "description": "Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.",
- // "location": "query",
- // "pattern": "ga:[0-9]+",
- // "required": true,
- // "type": "string"
- // },
- // "max-results": {
- // "description": "The maximum number of entries to include in this feed.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "metrics": {
- // "description": "A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric must be specified.",
- // "location": "query",
- // "pattern": "mcf:.+",
- // "required": true,
- // "type": "string"
- // },
- // "samplingLevel": {
- // "description": "The desired sampling level.",
- // "enum": [
- // "DEFAULT",
- // "FASTER",
- // "HIGHER_PRECISION"
- // ],
- // "enumDescriptions": [
- // "Returns response with a sample size that balances speed and accuracy.",
- // "Returns a fast response with a smaller sample size.",
- // "Returns a more accurate response using a large sample size, but this may result in the response being slower."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sort": {
- // "description": "A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data.",
- // "location": "query",
- // "pattern": "(-)?mcf:.+",
- // "type": "string"
- // },
- // "start-date": {
- // "description": "Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.",
- // "location": "query",
- // "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)",
- // "required": true,
- // "type": "string"
- // },
- // "start-index": {
- // "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // }
- // },
- // "path": "data/mcf",
- // "response": {
- // "$ref": "McfData"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.data.realtime.get":
-
-type DataRealtimeGetCall struct {
- s *Service
- ids string
- metrics string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns real time data for a view (profile).
-func (r *DataRealtimeService) Get(ids string, metrics string) *DataRealtimeGetCall {
- c := &DataRealtimeGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.ids = ids
- c.metrics = metrics
- return c
-}
-
-// Dimensions sets the optional parameter "dimensions": A
-// comma-separated list of real time dimensions. E.g.,
-// 'rt:medium,rt:city'.
-func (c *DataRealtimeGetCall) Dimensions(dimensions string) *DataRealtimeGetCall {
- c.opt_["dimensions"] = dimensions
- return c
-}
-
-// Filters sets the optional parameter "filters": A comma-separated list
-// of dimension or metric filters to be applied to real time data.
-func (c *DataRealtimeGetCall) Filters(filters string) *DataRealtimeGetCall {
- c.opt_["filters"] = filters
- return c
-}
-
-// MaxResults sets the optional parameter "max-results": The maximum
-// number of entries to include in this feed.
-func (c *DataRealtimeGetCall) MaxResults(maxResults int64) *DataRealtimeGetCall {
- c.opt_["max-results"] = maxResults
- return c
-}
-
-// Sort sets the optional parameter "sort": A comma-separated list of
-// dimensions or metrics that determine the sort order for real time
-// data.
-func (c *DataRealtimeGetCall) Sort(sort string) *DataRealtimeGetCall {
- c.opt_["sort"] = sort
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DataRealtimeGetCall) Fields(s ...googleapi.Field) *DataRealtimeGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DataRealtimeGetCall) IfNoneMatch(entityTag string) *DataRealtimeGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DataRealtimeGetCall) Context(ctx context.Context) *DataRealtimeGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DataRealtimeGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("ids", fmt.Sprintf("%v", c.ids))
- params.Set("metrics", fmt.Sprintf("%v", c.metrics))
- if v, ok := c.opt_["dimensions"]; ok {
- params.Set("dimensions", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["filters"]; ok {
- params.Set("filters", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["max-results"]; ok {
- params.Set("max-results", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sort"]; ok {
- params.Set("sort", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "data/realtime")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.data.realtime.get" call.
-// Exactly one of *RealtimeData or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *RealtimeData.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DataRealtimeGetCall) Do() (*RealtimeData, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &RealtimeData{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns real time data for a view (profile).",
- // "httpMethod": "GET",
- // "id": "analytics.data.realtime.get",
- // "parameterOrder": [
- // "ids",
- // "metrics"
- // ],
- // "parameters": {
- // "dimensions": {
- // "description": "A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'.",
- // "location": "query",
- // "pattern": "(ga:.+)|(rt:.+)",
- // "type": "string"
- // },
- // "filters": {
- // "description": "A comma-separated list of dimension or metric filters to be applied to real time data.",
- // "location": "query",
- // "pattern": "(ga:.+)|(rt:.+)",
- // "type": "string"
- // },
- // "ids": {
- // "description": "Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.",
- // "location": "query",
- // "pattern": "ga:[0-9]+",
- // "required": true,
- // "type": "string"
- // },
- // "max-results": {
- // "description": "The maximum number of entries to include in this feed.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "metrics": {
- // "description": "A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified.",
- // "location": "query",
- // "pattern": "(ga:.+)|(rt:.+)",
- // "required": true,
- // "type": "string"
- // },
- // "sort": {
- // "description": "A comma-separated list of dimensions or metrics that determine the sort order for real time data.",
- // "location": "query",
- // "pattern": "(-)?((ga:.+)|(rt:.+))",
- // "type": "string"
- // }
- // },
- // "path": "data/realtime",
- // "response": {
- // "$ref": "RealtimeData"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.accountSummaries.list":
-
-type ManagementAccountSummariesListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists account summaries (lightweight tree comprised of
-// accounts/properties/profiles) to which the user has access.
-func (r *ManagementAccountSummariesService) List() *ManagementAccountSummariesListCall {
- c := &ManagementAccountSummariesListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// MaxResults sets the optional parameter "max-results": The maximum
-// number of account summaries to include in this response, where the
-// largest acceptable value is 1000.
-func (c *ManagementAccountSummariesListCall) MaxResults(maxResults int64) *ManagementAccountSummariesListCall {
- c.opt_["max-results"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "start-index": An index of the
-// first entity to retrieve. Use this parameter as a pagination
-// mechanism along with the max-results parameter.
-func (c *ManagementAccountSummariesListCall) StartIndex(startIndex int64) *ManagementAccountSummariesListCall {
- c.opt_["start-index"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementAccountSummariesListCall) Fields(s ...googleapi.Field) *ManagementAccountSummariesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementAccountSummariesListCall) IfNoneMatch(entityTag string) *ManagementAccountSummariesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementAccountSummariesListCall) Context(ctx context.Context) *ManagementAccountSummariesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementAccountSummariesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["max-results"]; ok {
- params.Set("max-results", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["start-index"]; ok {
- params.Set("start-index", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accountSummaries")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.accountSummaries.list" call.
-// Exactly one of *AccountSummaries or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AccountSummaries.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementAccountSummariesListCall) Do() (*AccountSummaries, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountSummaries{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access.",
- // "httpMethod": "GET",
- // "id": "analytics.management.accountSummaries.list",
- // "parameters": {
- // "max-results": {
- // "description": "The maximum number of account summaries to include in this response, where the largest acceptable value is 1000.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "start-index": {
- // "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // }
- // },
- // "path": "management/accountSummaries",
- // "response": {
- // "$ref": "AccountSummaries"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.accountUserLinks.delete":
-
-type ManagementAccountUserLinksDeleteCall struct {
- s *Service
- accountId string
- linkId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Removes a user from the given account.
-func (r *ManagementAccountUserLinksService) Delete(accountId string, linkId string) *ManagementAccountUserLinksDeleteCall {
- c := &ManagementAccountUserLinksDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.linkId = linkId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementAccountUserLinksDeleteCall) Fields(s ...googleapi.Field) *ManagementAccountUserLinksDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementAccountUserLinksDeleteCall) Context(ctx context.Context) *ManagementAccountUserLinksDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementAccountUserLinksDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/entityUserLinks/{linkId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "linkId": c.linkId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.accountUserLinks.delete" call.
-func (c *ManagementAccountUserLinksDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Removes a user from the given account.",
- // "httpMethod": "DELETE",
- // "id": "analytics.management.accountUserLinks.delete",
- // "parameterOrder": [
- // "accountId",
- // "linkId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to delete the user link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "linkId": {
- // "description": "Link ID to delete the user link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/entityUserLinks/{linkId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.manage.users"
- // ]
- // }
-
-}
-
-// method id "analytics.management.accountUserLinks.insert":
-
-type ManagementAccountUserLinksInsertCall struct {
- s *Service
- accountId string
- entityuserlink *EntityUserLink
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Adds a new user to the given account.
-func (r *ManagementAccountUserLinksService) Insert(accountId string, entityuserlink *EntityUserLink) *ManagementAccountUserLinksInsertCall {
- c := &ManagementAccountUserLinksInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.entityuserlink = entityuserlink
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementAccountUserLinksInsertCall) Fields(s ...googleapi.Field) *ManagementAccountUserLinksInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementAccountUserLinksInsertCall) Context(ctx context.Context) *ManagementAccountUserLinksInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementAccountUserLinksInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.entityuserlink)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/entityUserLinks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.accountUserLinks.insert" call.
-// Exactly one of *EntityUserLink or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *EntityUserLink.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementAccountUserLinksInsertCall) Do() (*EntityUserLink, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EntityUserLink{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Adds a new user to the given account.",
- // "httpMethod": "POST",
- // "id": "analytics.management.accountUserLinks.insert",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to create the user link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/entityUserLinks",
- // "request": {
- // "$ref": "EntityUserLink"
- // },
- // "response": {
- // "$ref": "EntityUserLink"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.manage.users"
- // ]
- // }
-
-}
-
-// method id "analytics.management.accountUserLinks.list":
-
-type ManagementAccountUserLinksListCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists account-user links for a given account.
-func (r *ManagementAccountUserLinksService) List(accountId string) *ManagementAccountUserLinksListCall {
- c := &ManagementAccountUserLinksListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// MaxResults sets the optional parameter "max-results": The maximum
-// number of account-user links to include in this response.
-func (c *ManagementAccountUserLinksListCall) MaxResults(maxResults int64) *ManagementAccountUserLinksListCall {
- c.opt_["max-results"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "start-index": An index of the
-// first account-user link to retrieve. Use this parameter as a
-// pagination mechanism along with the max-results parameter.
-func (c *ManagementAccountUserLinksListCall) StartIndex(startIndex int64) *ManagementAccountUserLinksListCall {
- c.opt_["start-index"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementAccountUserLinksListCall) Fields(s ...googleapi.Field) *ManagementAccountUserLinksListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementAccountUserLinksListCall) IfNoneMatch(entityTag string) *ManagementAccountUserLinksListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementAccountUserLinksListCall) Context(ctx context.Context) *ManagementAccountUserLinksListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementAccountUserLinksListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["max-results"]; ok {
- params.Set("max-results", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["start-index"]; ok {
- params.Set("start-index", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/entityUserLinks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.accountUserLinks.list" call.
-// Exactly one of *EntityUserLinks or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *EntityUserLinks.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementAccountUserLinksListCall) Do() (*EntityUserLinks, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EntityUserLinks{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists account-user links for a given account.",
- // "httpMethod": "GET",
- // "id": "analytics.management.accountUserLinks.list",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to retrieve the user links for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "max-results": {
- // "description": "The maximum number of account-user links to include in this response.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "start-index": {
- // "description": "An index of the first account-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // }
- // },
- // "path": "management/accounts/{accountId}/entityUserLinks",
- // "response": {
- // "$ref": "EntityUserLinks"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.manage.users",
- // "https://www.googleapis.com/auth/analytics.manage.users.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.accountUserLinks.update":
-
-type ManagementAccountUserLinksUpdateCall struct {
- s *Service
- accountId string
- linkId string
- entityuserlink *EntityUserLink
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates permissions for an existing user on the given
-// account.
-func (r *ManagementAccountUserLinksService) Update(accountId string, linkId string, entityuserlink *EntityUserLink) *ManagementAccountUserLinksUpdateCall {
- c := &ManagementAccountUserLinksUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.linkId = linkId
- c.entityuserlink = entityuserlink
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementAccountUserLinksUpdateCall) Fields(s ...googleapi.Field) *ManagementAccountUserLinksUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementAccountUserLinksUpdateCall) Context(ctx context.Context) *ManagementAccountUserLinksUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementAccountUserLinksUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.entityuserlink)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/entityUserLinks/{linkId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "linkId": c.linkId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.accountUserLinks.update" call.
-// Exactly one of *EntityUserLink or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *EntityUserLink.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementAccountUserLinksUpdateCall) Do() (*EntityUserLink, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EntityUserLink{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates permissions for an existing user on the given account.",
- // "httpMethod": "PUT",
- // "id": "analytics.management.accountUserLinks.update",
- // "parameterOrder": [
- // "accountId",
- // "linkId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to update the account-user link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "linkId": {
- // "description": "Link ID to update the account-user link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/entityUserLinks/{linkId}",
- // "request": {
- // "$ref": "EntityUserLink"
- // },
- // "response": {
- // "$ref": "EntityUserLink"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.manage.users"
- // ]
- // }
-
-}
-
-// method id "analytics.management.accounts.list":
-
-type ManagementAccountsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all accounts to which the user has access.
-func (r *ManagementAccountsService) List() *ManagementAccountsListCall {
- c := &ManagementAccountsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// MaxResults sets the optional parameter "max-results": The maximum
-// number of accounts to include in this response.
-func (c *ManagementAccountsListCall) MaxResults(maxResults int64) *ManagementAccountsListCall {
- c.opt_["max-results"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "start-index": An index of the
-// first account to retrieve. Use this parameter as a pagination
-// mechanism along with the max-results parameter.
-func (c *ManagementAccountsListCall) StartIndex(startIndex int64) *ManagementAccountsListCall {
- c.opt_["start-index"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementAccountsListCall) Fields(s ...googleapi.Field) *ManagementAccountsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementAccountsListCall) IfNoneMatch(entityTag string) *ManagementAccountsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementAccountsListCall) Context(ctx context.Context) *ManagementAccountsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementAccountsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["max-results"]; ok {
- params.Set("max-results", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["start-index"]; ok {
- params.Set("start-index", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.accounts.list" call.
-// Exactly one of *Accounts or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Accounts.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ManagementAccountsListCall) Do() (*Accounts, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Accounts{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all accounts to which the user has access.",
- // "httpMethod": "GET",
- // "id": "analytics.management.accounts.list",
- // "parameters": {
- // "max-results": {
- // "description": "The maximum number of accounts to include in this response.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "start-index": {
- // "description": "An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // }
- // },
- // "path": "management/accounts",
- // "response": {
- // "$ref": "Accounts"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.edit",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.customDataSources.list":
-
-type ManagementCustomDataSourcesListCall struct {
- s *Service
- accountId string
- webPropertyId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List custom data sources to which the user has access.
-func (r *ManagementCustomDataSourcesService) List(accountId string, webPropertyId string) *ManagementCustomDataSourcesListCall {
- c := &ManagementCustomDataSourcesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- return c
-}
-
-// MaxResults sets the optional parameter "max-results": The maximum
-// number of custom data sources to include in this response.
-func (c *ManagementCustomDataSourcesListCall) MaxResults(maxResults int64) *ManagementCustomDataSourcesListCall {
- c.opt_["max-results"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "start-index": A 1-based index
-// of the first custom data source to retrieve. Use this parameter as a
-// pagination mechanism along with the max-results parameter.
-func (c *ManagementCustomDataSourcesListCall) StartIndex(startIndex int64) *ManagementCustomDataSourcesListCall {
- c.opt_["start-index"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementCustomDataSourcesListCall) Fields(s ...googleapi.Field) *ManagementCustomDataSourcesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementCustomDataSourcesListCall) IfNoneMatch(entityTag string) *ManagementCustomDataSourcesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementCustomDataSourcesListCall) Context(ctx context.Context) *ManagementCustomDataSourcesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementCustomDataSourcesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["max-results"]; ok {
- params.Set("max-results", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["start-index"]; ok {
- params.Set("start-index", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.customDataSources.list" call.
-// Exactly one of *CustomDataSources or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CustomDataSources.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementCustomDataSourcesListCall) Do() (*CustomDataSources, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomDataSources{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List custom data sources to which the user has access.",
- // "httpMethod": "GET",
- // "id": "analytics.management.customDataSources.list",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account Id for the custom data sources to retrieve.",
- // "location": "path",
- // "pattern": "\\d+",
- // "required": true,
- // "type": "string"
- // },
- // "max-results": {
- // "description": "The maximum number of custom data sources to include in this response.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "start-index": {
- // "description": "A 1-based index of the first custom data source to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "webPropertyId": {
- // "description": "Web property Id for the custom data sources to retrieve.",
- // "location": "path",
- // "pattern": "UA-(\\d+)-(\\d+)",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources",
- // "response": {
- // "$ref": "CustomDataSources"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.edit",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.customDimensions.get":
-
-type ManagementCustomDimensionsGetCall struct {
- s *Service
- accountId string
- webPropertyId string
- customDimensionId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get a custom dimension to which the user has access.
-func (r *ManagementCustomDimensionsService) Get(accountId string, webPropertyId string, customDimensionId string) *ManagementCustomDimensionsGetCall {
- c := &ManagementCustomDimensionsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.customDimensionId = customDimensionId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementCustomDimensionsGetCall) Fields(s ...googleapi.Field) *ManagementCustomDimensionsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementCustomDimensionsGetCall) IfNoneMatch(entityTag string) *ManagementCustomDimensionsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementCustomDimensionsGetCall) Context(ctx context.Context) *ManagementCustomDimensionsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementCustomDimensionsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "customDimensionId": c.customDimensionId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.customDimensions.get" call.
-// Exactly one of *CustomDimension or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomDimension.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementCustomDimensionsGetCall) Do() (*CustomDimension, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomDimension{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get a custom dimension to which the user has access.",
- // "httpMethod": "GET",
- // "id": "analytics.management.customDimensions.get",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "customDimensionId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID for the custom dimension to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "customDimensionId": {
- // "description": "The ID of the custom dimension to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property ID for the custom dimension to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}",
- // "response": {
- // "$ref": "CustomDimension"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.customDimensions.insert":
-
-type ManagementCustomDimensionsInsertCall struct {
- s *Service
- accountId string
- webPropertyId string
- customdimension *CustomDimension
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Create a new custom dimension.
-func (r *ManagementCustomDimensionsService) Insert(accountId string, webPropertyId string, customdimension *CustomDimension) *ManagementCustomDimensionsInsertCall {
- c := &ManagementCustomDimensionsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.customdimension = customdimension
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementCustomDimensionsInsertCall) Fields(s ...googleapi.Field) *ManagementCustomDimensionsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementCustomDimensionsInsertCall) Context(ctx context.Context) *ManagementCustomDimensionsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementCustomDimensionsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.customdimension)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.customDimensions.insert" call.
-// Exactly one of *CustomDimension or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomDimension.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementCustomDimensionsInsertCall) Do() (*CustomDimension, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomDimension{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Create a new custom dimension.",
- // "httpMethod": "POST",
- // "id": "analytics.management.customDimensions.insert",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID for the custom dimension to create.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property ID for the custom dimension to create.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions",
- // "request": {
- // "$ref": "CustomDimension"
- // },
- // "response": {
- // "$ref": "CustomDimension"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.customDimensions.list":
-
-type ManagementCustomDimensionsListCall struct {
- s *Service
- accountId string
- webPropertyId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists custom dimensions to which the user has access.
-func (r *ManagementCustomDimensionsService) List(accountId string, webPropertyId string) *ManagementCustomDimensionsListCall {
- c := &ManagementCustomDimensionsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- return c
-}
-
-// MaxResults sets the optional parameter "max-results": The maximum
-// number of custom dimensions to include in this response.
-func (c *ManagementCustomDimensionsListCall) MaxResults(maxResults int64) *ManagementCustomDimensionsListCall {
- c.opt_["max-results"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "start-index": An index of the
-// first entity to retrieve. Use this parameter as a pagination
-// mechanism along with the max-results parameter.
-func (c *ManagementCustomDimensionsListCall) StartIndex(startIndex int64) *ManagementCustomDimensionsListCall {
- c.opt_["start-index"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementCustomDimensionsListCall) Fields(s ...googleapi.Field) *ManagementCustomDimensionsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementCustomDimensionsListCall) IfNoneMatch(entityTag string) *ManagementCustomDimensionsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementCustomDimensionsListCall) Context(ctx context.Context) *ManagementCustomDimensionsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementCustomDimensionsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["max-results"]; ok {
- params.Set("max-results", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["start-index"]; ok {
- params.Set("start-index", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.customDimensions.list" call.
-// Exactly one of *CustomDimensions or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CustomDimensions.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementCustomDimensionsListCall) Do() (*CustomDimensions, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomDimensions{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists custom dimensions to which the user has access.",
- // "httpMethod": "GET",
- // "id": "analytics.management.customDimensions.list",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID for the custom dimensions to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "max-results": {
- // "description": "The maximum number of custom dimensions to include in this response.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "start-index": {
- // "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "webPropertyId": {
- // "description": "Web property ID for the custom dimensions to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions",
- // "response": {
- // "$ref": "CustomDimensions"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.customDimensions.patch":
-
-type ManagementCustomDimensionsPatchCall struct {
- s *Service
- accountId string
- webPropertyId string
- customDimensionId string
- customdimension *CustomDimension
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing custom dimension. This method supports
-// patch semantics.
-func (r *ManagementCustomDimensionsService) Patch(accountId string, webPropertyId string, customDimensionId string, customdimension *CustomDimension) *ManagementCustomDimensionsPatchCall {
- c := &ManagementCustomDimensionsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.customDimensionId = customDimensionId
- c.customdimension = customdimension
- return c
-}
-
-// IgnoreCustomDataSourceLinks sets the optional parameter
-// "ignoreCustomDataSourceLinks": Force the update and ignore any
-// warnings related to the custom dimension being linked to a custom
-// data source / data set.
-func (c *ManagementCustomDimensionsPatchCall) IgnoreCustomDataSourceLinks(ignoreCustomDataSourceLinks bool) *ManagementCustomDimensionsPatchCall {
- c.opt_["ignoreCustomDataSourceLinks"] = ignoreCustomDataSourceLinks
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementCustomDimensionsPatchCall) Fields(s ...googleapi.Field) *ManagementCustomDimensionsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementCustomDimensionsPatchCall) Context(ctx context.Context) *ManagementCustomDimensionsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementCustomDimensionsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.customdimension)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["ignoreCustomDataSourceLinks"]; ok {
- params.Set("ignoreCustomDataSourceLinks", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "customDimensionId": c.customDimensionId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.customDimensions.patch" call.
-// Exactly one of *CustomDimension or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomDimension.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementCustomDimensionsPatchCall) Do() (*CustomDimension, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomDimension{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing custom dimension. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "analytics.management.customDimensions.patch",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "customDimensionId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID for the custom dimension to update.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "customDimensionId": {
- // "description": "Custom dimension ID for the custom dimension to update.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "ignoreCustomDataSourceLinks": {
- // "default": "false",
- // "description": "Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "webPropertyId": {
- // "description": "Web property ID for the custom dimension to update.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}",
- // "request": {
- // "$ref": "CustomDimension"
- // },
- // "response": {
- // "$ref": "CustomDimension"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.customDimensions.update":
-
-type ManagementCustomDimensionsUpdateCall struct {
- s *Service
- accountId string
- webPropertyId string
- customDimensionId string
- customdimension *CustomDimension
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing custom dimension.
-func (r *ManagementCustomDimensionsService) Update(accountId string, webPropertyId string, customDimensionId string, customdimension *CustomDimension) *ManagementCustomDimensionsUpdateCall {
- c := &ManagementCustomDimensionsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.customDimensionId = customDimensionId
- c.customdimension = customdimension
- return c
-}
-
-// IgnoreCustomDataSourceLinks sets the optional parameter
-// "ignoreCustomDataSourceLinks": Force the update and ignore any
-// warnings related to the custom dimension being linked to a custom
-// data source / data set.
-func (c *ManagementCustomDimensionsUpdateCall) IgnoreCustomDataSourceLinks(ignoreCustomDataSourceLinks bool) *ManagementCustomDimensionsUpdateCall {
- c.opt_["ignoreCustomDataSourceLinks"] = ignoreCustomDataSourceLinks
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementCustomDimensionsUpdateCall) Fields(s ...googleapi.Field) *ManagementCustomDimensionsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementCustomDimensionsUpdateCall) Context(ctx context.Context) *ManagementCustomDimensionsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementCustomDimensionsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.customdimension)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["ignoreCustomDataSourceLinks"]; ok {
- params.Set("ignoreCustomDataSourceLinks", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "customDimensionId": c.customDimensionId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.customDimensions.update" call.
-// Exactly one of *CustomDimension or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomDimension.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementCustomDimensionsUpdateCall) Do() (*CustomDimension, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomDimension{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing custom dimension.",
- // "httpMethod": "PUT",
- // "id": "analytics.management.customDimensions.update",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "customDimensionId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID for the custom dimension to update.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "customDimensionId": {
- // "description": "Custom dimension ID for the custom dimension to update.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "ignoreCustomDataSourceLinks": {
- // "default": "false",
- // "description": "Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "webPropertyId": {
- // "description": "Web property ID for the custom dimension to update.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}",
- // "request": {
- // "$ref": "CustomDimension"
- // },
- // "response": {
- // "$ref": "CustomDimension"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.customMetrics.get":
-
-type ManagementCustomMetricsGetCall struct {
- s *Service
- accountId string
- webPropertyId string
- customMetricId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get a custom metric to which the user has access.
-func (r *ManagementCustomMetricsService) Get(accountId string, webPropertyId string, customMetricId string) *ManagementCustomMetricsGetCall {
- c := &ManagementCustomMetricsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.customMetricId = customMetricId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementCustomMetricsGetCall) Fields(s ...googleapi.Field) *ManagementCustomMetricsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementCustomMetricsGetCall) IfNoneMatch(entityTag string) *ManagementCustomMetricsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementCustomMetricsGetCall) Context(ctx context.Context) *ManagementCustomMetricsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementCustomMetricsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "customMetricId": c.customMetricId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.customMetrics.get" call.
-// Exactly one of *CustomMetric or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomMetric.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ManagementCustomMetricsGetCall) Do() (*CustomMetric, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomMetric{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get a custom metric to which the user has access.",
- // "httpMethod": "GET",
- // "id": "analytics.management.customMetrics.get",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "customMetricId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID for the custom metric to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "customMetricId": {
- // "description": "The ID of the custom metric to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property ID for the custom metric to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}",
- // "response": {
- // "$ref": "CustomMetric"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.customMetrics.insert":
-
-type ManagementCustomMetricsInsertCall struct {
- s *Service
- accountId string
- webPropertyId string
- custommetric *CustomMetric
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Create a new custom metric.
-func (r *ManagementCustomMetricsService) Insert(accountId string, webPropertyId string, custommetric *CustomMetric) *ManagementCustomMetricsInsertCall {
- c := &ManagementCustomMetricsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.custommetric = custommetric
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementCustomMetricsInsertCall) Fields(s ...googleapi.Field) *ManagementCustomMetricsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementCustomMetricsInsertCall) Context(ctx context.Context) *ManagementCustomMetricsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementCustomMetricsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.custommetric)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.customMetrics.insert" call.
-// Exactly one of *CustomMetric or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomMetric.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ManagementCustomMetricsInsertCall) Do() (*CustomMetric, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomMetric{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Create a new custom metric.",
- // "httpMethod": "POST",
- // "id": "analytics.management.customMetrics.insert",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID for the custom metric to create.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property ID for the custom dimension to create.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics",
- // "request": {
- // "$ref": "CustomMetric"
- // },
- // "response": {
- // "$ref": "CustomMetric"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.customMetrics.list":
-
-type ManagementCustomMetricsListCall struct {
- s *Service
- accountId string
- webPropertyId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists custom metrics to which the user has access.
-func (r *ManagementCustomMetricsService) List(accountId string, webPropertyId string) *ManagementCustomMetricsListCall {
- c := &ManagementCustomMetricsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- return c
-}
-
-// MaxResults sets the optional parameter "max-results": The maximum
-// number of custom metrics to include in this response.
-func (c *ManagementCustomMetricsListCall) MaxResults(maxResults int64) *ManagementCustomMetricsListCall {
- c.opt_["max-results"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "start-index": An index of the
-// first entity to retrieve. Use this parameter as a pagination
-// mechanism along with the max-results parameter.
-func (c *ManagementCustomMetricsListCall) StartIndex(startIndex int64) *ManagementCustomMetricsListCall {
- c.opt_["start-index"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementCustomMetricsListCall) Fields(s ...googleapi.Field) *ManagementCustomMetricsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementCustomMetricsListCall) IfNoneMatch(entityTag string) *ManagementCustomMetricsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementCustomMetricsListCall) Context(ctx context.Context) *ManagementCustomMetricsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementCustomMetricsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["max-results"]; ok {
- params.Set("max-results", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["start-index"]; ok {
- params.Set("start-index", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.customMetrics.list" call.
-// Exactly one of *CustomMetrics or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomMetrics.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementCustomMetricsListCall) Do() (*CustomMetrics, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomMetrics{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists custom metrics to which the user has access.",
- // "httpMethod": "GET",
- // "id": "analytics.management.customMetrics.list",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID for the custom metrics to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "max-results": {
- // "description": "The maximum number of custom metrics to include in this response.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "start-index": {
- // "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "webPropertyId": {
- // "description": "Web property ID for the custom metrics to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics",
- // "response": {
- // "$ref": "CustomMetrics"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.customMetrics.patch":
-
-type ManagementCustomMetricsPatchCall struct {
- s *Service
- accountId string
- webPropertyId string
- customMetricId string
- custommetric *CustomMetric
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing custom metric. This method supports patch
-// semantics.
-func (r *ManagementCustomMetricsService) Patch(accountId string, webPropertyId string, customMetricId string, custommetric *CustomMetric) *ManagementCustomMetricsPatchCall {
- c := &ManagementCustomMetricsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.customMetricId = customMetricId
- c.custommetric = custommetric
- return c
-}
-
-// IgnoreCustomDataSourceLinks sets the optional parameter
-// "ignoreCustomDataSourceLinks": Force the update and ignore any
-// warnings related to the custom metric being linked to a custom data
-// source / data set.
-func (c *ManagementCustomMetricsPatchCall) IgnoreCustomDataSourceLinks(ignoreCustomDataSourceLinks bool) *ManagementCustomMetricsPatchCall {
- c.opt_["ignoreCustomDataSourceLinks"] = ignoreCustomDataSourceLinks
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementCustomMetricsPatchCall) Fields(s ...googleapi.Field) *ManagementCustomMetricsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementCustomMetricsPatchCall) Context(ctx context.Context) *ManagementCustomMetricsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementCustomMetricsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.custommetric)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["ignoreCustomDataSourceLinks"]; ok {
- params.Set("ignoreCustomDataSourceLinks", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "customMetricId": c.customMetricId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.customMetrics.patch" call.
-// Exactly one of *CustomMetric or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomMetric.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ManagementCustomMetricsPatchCall) Do() (*CustomMetric, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomMetric{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing custom metric. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "analytics.management.customMetrics.patch",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "customMetricId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID for the custom metric to update.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "customMetricId": {
- // "description": "Custom metric ID for the custom metric to update.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "ignoreCustomDataSourceLinks": {
- // "default": "false",
- // "description": "Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "webPropertyId": {
- // "description": "Web property ID for the custom metric to update.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}",
- // "request": {
- // "$ref": "CustomMetric"
- // },
- // "response": {
- // "$ref": "CustomMetric"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.customMetrics.update":
-
-type ManagementCustomMetricsUpdateCall struct {
- s *Service
- accountId string
- webPropertyId string
- customMetricId string
- custommetric *CustomMetric
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing custom metric.
-func (r *ManagementCustomMetricsService) Update(accountId string, webPropertyId string, customMetricId string, custommetric *CustomMetric) *ManagementCustomMetricsUpdateCall {
- c := &ManagementCustomMetricsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.customMetricId = customMetricId
- c.custommetric = custommetric
- return c
-}
-
-// IgnoreCustomDataSourceLinks sets the optional parameter
-// "ignoreCustomDataSourceLinks": Force the update and ignore any
-// warnings related to the custom metric being linked to a custom data
-// source / data set.
-func (c *ManagementCustomMetricsUpdateCall) IgnoreCustomDataSourceLinks(ignoreCustomDataSourceLinks bool) *ManagementCustomMetricsUpdateCall {
- c.opt_["ignoreCustomDataSourceLinks"] = ignoreCustomDataSourceLinks
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementCustomMetricsUpdateCall) Fields(s ...googleapi.Field) *ManagementCustomMetricsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementCustomMetricsUpdateCall) Context(ctx context.Context) *ManagementCustomMetricsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementCustomMetricsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.custommetric)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["ignoreCustomDataSourceLinks"]; ok {
- params.Set("ignoreCustomDataSourceLinks", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "customMetricId": c.customMetricId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.customMetrics.update" call.
-// Exactly one of *CustomMetric or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CustomMetric.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ManagementCustomMetricsUpdateCall) Do() (*CustomMetric, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomMetric{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing custom metric.",
- // "httpMethod": "PUT",
- // "id": "analytics.management.customMetrics.update",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "customMetricId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID for the custom metric to update.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "customMetricId": {
- // "description": "Custom metric ID for the custom metric to update.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "ignoreCustomDataSourceLinks": {
- // "default": "false",
- // "description": "Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "webPropertyId": {
- // "description": "Web property ID for the custom metric to update.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}",
- // "request": {
- // "$ref": "CustomMetric"
- // },
- // "response": {
- // "$ref": "CustomMetric"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.experiments.delete":
-
-type ManagementExperimentsDeleteCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- experimentId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Delete an experiment.
-func (r *ManagementExperimentsService) Delete(accountId string, webPropertyId string, profileId string, experimentId string) *ManagementExperimentsDeleteCall {
- c := &ManagementExperimentsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- c.experimentId = experimentId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementExperimentsDeleteCall) Fields(s ...googleapi.Field) *ManagementExperimentsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementExperimentsDeleteCall) Context(ctx context.Context) *ManagementExperimentsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementExperimentsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- "experimentId": c.experimentId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.experiments.delete" call.
-func (c *ManagementExperimentsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Delete an experiment.",
- // "httpMethod": "DELETE",
- // "id": "analytics.management.experiments.delete",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId",
- // "experimentId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to which the experiment belongs",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "experimentId": {
- // "description": "ID of the experiment to delete",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "View (Profile) ID to which the experiment belongs",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property ID to which the experiment belongs",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.experiments.get":
-
-type ManagementExperimentsGetCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- experimentId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns an experiment to which the user has access.
-func (r *ManagementExperimentsService) Get(accountId string, webPropertyId string, profileId string, experimentId string) *ManagementExperimentsGetCall {
- c := &ManagementExperimentsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- c.experimentId = experimentId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementExperimentsGetCall) Fields(s ...googleapi.Field) *ManagementExperimentsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementExperimentsGetCall) IfNoneMatch(entityTag string) *ManagementExperimentsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementExperimentsGetCall) Context(ctx context.Context) *ManagementExperimentsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementExperimentsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- "experimentId": c.experimentId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.experiments.get" call.
-// Exactly one of *Experiment or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Experiment.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ManagementExperimentsGetCall) Do() (*Experiment, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Experiment{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns an experiment to which the user has access.",
- // "httpMethod": "GET",
- // "id": "analytics.management.experiments.get",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId",
- // "experimentId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to retrieve the experiment for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "experimentId": {
- // "description": "Experiment ID to retrieve the experiment for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "View (Profile) ID to retrieve the experiment for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property ID to retrieve the experiment for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}",
- // "response": {
- // "$ref": "Experiment"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.edit",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.experiments.insert":
-
-type ManagementExperimentsInsertCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- experiment *Experiment
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Create a new experiment.
-func (r *ManagementExperimentsService) Insert(accountId string, webPropertyId string, profileId string, experiment *Experiment) *ManagementExperimentsInsertCall {
- c := &ManagementExperimentsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- c.experiment = experiment
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementExperimentsInsertCall) Fields(s ...googleapi.Field) *ManagementExperimentsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementExperimentsInsertCall) Context(ctx context.Context) *ManagementExperimentsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementExperimentsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.experiment)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.experiments.insert" call.
-// Exactly one of *Experiment or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Experiment.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ManagementExperimentsInsertCall) Do() (*Experiment, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Experiment{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Create a new experiment.",
- // "httpMethod": "POST",
- // "id": "analytics.management.experiments.insert",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to create the experiment for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "View (Profile) ID to create the experiment for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property ID to create the experiment for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments",
- // "request": {
- // "$ref": "Experiment"
- // },
- // "response": {
- // "$ref": "Experiment"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.experiments.list":
-
-type ManagementExperimentsListCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists experiments to which the user has access.
-func (r *ManagementExperimentsService) List(accountId string, webPropertyId string, profileId string) *ManagementExperimentsListCall {
- c := &ManagementExperimentsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- return c
-}
-
-// MaxResults sets the optional parameter "max-results": The maximum
-// number of experiments to include in this response.
-func (c *ManagementExperimentsListCall) MaxResults(maxResults int64) *ManagementExperimentsListCall {
- c.opt_["max-results"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "start-index": An index of the
-// first experiment to retrieve. Use this parameter as a pagination
-// mechanism along with the max-results parameter.
-func (c *ManagementExperimentsListCall) StartIndex(startIndex int64) *ManagementExperimentsListCall {
- c.opt_["start-index"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementExperimentsListCall) Fields(s ...googleapi.Field) *ManagementExperimentsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementExperimentsListCall) IfNoneMatch(entityTag string) *ManagementExperimentsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementExperimentsListCall) Context(ctx context.Context) *ManagementExperimentsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementExperimentsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["max-results"]; ok {
- params.Set("max-results", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["start-index"]; ok {
- params.Set("start-index", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.experiments.list" call.
-// Exactly one of *Experiments or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Experiments.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ManagementExperimentsListCall) Do() (*Experiments, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Experiments{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists experiments to which the user has access.",
- // "httpMethod": "GET",
- // "id": "analytics.management.experiments.list",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to retrieve experiments for.",
- // "location": "path",
- // "pattern": "\\d+",
- // "required": true,
- // "type": "string"
- // },
- // "max-results": {
- // "description": "The maximum number of experiments to include in this response.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "profileId": {
- // "description": "View (Profile) ID to retrieve experiments for.",
- // "location": "path",
- // "pattern": "\\d+",
- // "required": true,
- // "type": "string"
- // },
- // "start-index": {
- // "description": "An index of the first experiment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "webPropertyId": {
- // "description": "Web property ID to retrieve experiments for.",
- // "location": "path",
- // "pattern": "UA-(\\d+)-(\\d+)",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments",
- // "response": {
- // "$ref": "Experiments"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.edit",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.experiments.patch":
-
-type ManagementExperimentsPatchCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- experimentId string
- experiment *Experiment
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Update an existing experiment. This method supports patch
-// semantics.
-func (r *ManagementExperimentsService) Patch(accountId string, webPropertyId string, profileId string, experimentId string, experiment *Experiment) *ManagementExperimentsPatchCall {
- c := &ManagementExperimentsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- c.experimentId = experimentId
- c.experiment = experiment
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementExperimentsPatchCall) Fields(s ...googleapi.Field) *ManagementExperimentsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementExperimentsPatchCall) Context(ctx context.Context) *ManagementExperimentsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementExperimentsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.experiment)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- "experimentId": c.experimentId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.experiments.patch" call.
-// Exactly one of *Experiment or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Experiment.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ManagementExperimentsPatchCall) Do() (*Experiment, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Experiment{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update an existing experiment. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "analytics.management.experiments.patch",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId",
- // "experimentId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID of the experiment to update.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "experimentId": {
- // "description": "Experiment ID of the experiment to update.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "View (Profile) ID of the experiment to update.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property ID of the experiment to update.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}",
- // "request": {
- // "$ref": "Experiment"
- // },
- // "response": {
- // "$ref": "Experiment"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.experiments.update":
-
-type ManagementExperimentsUpdateCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- experimentId string
- experiment *Experiment
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Update an existing experiment.
-func (r *ManagementExperimentsService) Update(accountId string, webPropertyId string, profileId string, experimentId string, experiment *Experiment) *ManagementExperimentsUpdateCall {
- c := &ManagementExperimentsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- c.experimentId = experimentId
- c.experiment = experiment
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementExperimentsUpdateCall) Fields(s ...googleapi.Field) *ManagementExperimentsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementExperimentsUpdateCall) Context(ctx context.Context) *ManagementExperimentsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementExperimentsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.experiment)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- "experimentId": c.experimentId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.experiments.update" call.
-// Exactly one of *Experiment or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Experiment.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ManagementExperimentsUpdateCall) Do() (*Experiment, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Experiment{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update an existing experiment.",
- // "httpMethod": "PUT",
- // "id": "analytics.management.experiments.update",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId",
- // "experimentId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID of the experiment to update.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "experimentId": {
- // "description": "Experiment ID of the experiment to update.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "View (Profile) ID of the experiment to update.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property ID of the experiment to update.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}",
- // "request": {
- // "$ref": "Experiment"
- // },
- // "response": {
- // "$ref": "Experiment"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.filters.delete":
-
-type ManagementFiltersDeleteCall struct {
- s *Service
- accountId string
- filterId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Delete a filter.
-func (r *ManagementFiltersService) Delete(accountId string, filterId string) *ManagementFiltersDeleteCall {
- c := &ManagementFiltersDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.filterId = filterId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementFiltersDeleteCall) Fields(s ...googleapi.Field) *ManagementFiltersDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementFiltersDeleteCall) Context(ctx context.Context) *ManagementFiltersDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementFiltersDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/filters/{filterId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "filterId": c.filterId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.filters.delete" call.
-// Exactly one of *Filter or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Filter.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ManagementFiltersDeleteCall) Do() (*Filter, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Filter{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Delete a filter.",
- // "httpMethod": "DELETE",
- // "id": "analytics.management.filters.delete",
- // "parameterOrder": [
- // "accountId",
- // "filterId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to delete the filter for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "filterId": {
- // "description": "ID of the filter to be deleted.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/filters/{filterId}",
- // "response": {
- // "$ref": "Filter"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.filters.get":
-
-type ManagementFiltersGetCall struct {
- s *Service
- accountId string
- filterId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns a filters to which the user has access.
-func (r *ManagementFiltersService) Get(accountId string, filterId string) *ManagementFiltersGetCall {
- c := &ManagementFiltersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.filterId = filterId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementFiltersGetCall) Fields(s ...googleapi.Field) *ManagementFiltersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementFiltersGetCall) IfNoneMatch(entityTag string) *ManagementFiltersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementFiltersGetCall) Context(ctx context.Context) *ManagementFiltersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementFiltersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/filters/{filterId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "filterId": c.filterId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.filters.get" call.
-// Exactly one of *Filter or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Filter.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ManagementFiltersGetCall) Do() (*Filter, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Filter{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns a filters to which the user has access.",
- // "httpMethod": "GET",
- // "id": "analytics.management.filters.get",
- // "parameterOrder": [
- // "accountId",
- // "filterId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to retrieve filters for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "filterId": {
- // "description": "Filter ID to retrieve filters for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/filters/{filterId}",
- // "response": {
- // "$ref": "Filter"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.filters.insert":
-
-type ManagementFiltersInsertCall struct {
- s *Service
- accountId string
- filter *Filter
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Create a new filter.
-func (r *ManagementFiltersService) Insert(accountId string, filter *Filter) *ManagementFiltersInsertCall {
- c := &ManagementFiltersInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.filter = filter
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementFiltersInsertCall) Fields(s ...googleapi.Field) *ManagementFiltersInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementFiltersInsertCall) Context(ctx context.Context) *ManagementFiltersInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementFiltersInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.filter)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/filters")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.filters.insert" call.
-// Exactly one of *Filter or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Filter.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ManagementFiltersInsertCall) Do() (*Filter, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Filter{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Create a new filter.",
- // "httpMethod": "POST",
- // "id": "analytics.management.filters.insert",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to create filter for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/filters",
- // "request": {
- // "$ref": "Filter"
- // },
- // "response": {
- // "$ref": "Filter"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.filters.list":
-
-type ManagementFiltersListCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all filters for an account
-func (r *ManagementFiltersService) List(accountId string) *ManagementFiltersListCall {
- c := &ManagementFiltersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// MaxResults sets the optional parameter "max-results": The maximum
-// number of filters to include in this response.
-func (c *ManagementFiltersListCall) MaxResults(maxResults int64) *ManagementFiltersListCall {
- c.opt_["max-results"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "start-index": An index of the
-// first entity to retrieve. Use this parameter as a pagination
-// mechanism along with the max-results parameter.
-func (c *ManagementFiltersListCall) StartIndex(startIndex int64) *ManagementFiltersListCall {
- c.opt_["start-index"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementFiltersListCall) Fields(s ...googleapi.Field) *ManagementFiltersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementFiltersListCall) IfNoneMatch(entityTag string) *ManagementFiltersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementFiltersListCall) Context(ctx context.Context) *ManagementFiltersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementFiltersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["max-results"]; ok {
- params.Set("max-results", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["start-index"]; ok {
- params.Set("start-index", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/filters")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.filters.list" call.
-// Exactly one of *Filters or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Filters.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ManagementFiltersListCall) Do() (*Filters, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Filters{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all filters for an account",
- // "httpMethod": "GET",
- // "id": "analytics.management.filters.list",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to retrieve filters for.",
- // "location": "path",
- // "pattern": "\\d+",
- // "required": true,
- // "type": "string"
- // },
- // "max-results": {
- // "description": "The maximum number of filters to include in this response.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "start-index": {
- // "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // }
- // },
- // "path": "management/accounts/{accountId}/filters",
- // "response": {
- // "$ref": "Filters"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.filters.patch":
-
-type ManagementFiltersPatchCall struct {
- s *Service
- accountId string
- filterId string
- filter *Filter
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing filter. This method supports patch
-// semantics.
-func (r *ManagementFiltersService) Patch(accountId string, filterId string, filter *Filter) *ManagementFiltersPatchCall {
- c := &ManagementFiltersPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.filterId = filterId
- c.filter = filter
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementFiltersPatchCall) Fields(s ...googleapi.Field) *ManagementFiltersPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementFiltersPatchCall) Context(ctx context.Context) *ManagementFiltersPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementFiltersPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.filter)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/filters/{filterId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "filterId": c.filterId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.filters.patch" call.
-// Exactly one of *Filter or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Filter.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ManagementFiltersPatchCall) Do() (*Filter, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Filter{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing filter. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "analytics.management.filters.patch",
- // "parameterOrder": [
- // "accountId",
- // "filterId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to which the filter belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "filterId": {
- // "description": "ID of the filter to be updated.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/filters/{filterId}",
- // "request": {
- // "$ref": "Filter"
- // },
- // "response": {
- // "$ref": "Filter"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.filters.update":
-
-type ManagementFiltersUpdateCall struct {
- s *Service
- accountId string
- filterId string
- filter *Filter
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing filter.
-func (r *ManagementFiltersService) Update(accountId string, filterId string, filter *Filter) *ManagementFiltersUpdateCall {
- c := &ManagementFiltersUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.filterId = filterId
- c.filter = filter
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementFiltersUpdateCall) Fields(s ...googleapi.Field) *ManagementFiltersUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementFiltersUpdateCall) Context(ctx context.Context) *ManagementFiltersUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementFiltersUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.filter)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/filters/{filterId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "filterId": c.filterId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.filters.update" call.
-// Exactly one of *Filter or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Filter.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ManagementFiltersUpdateCall) Do() (*Filter, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Filter{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing filter.",
- // "httpMethod": "PUT",
- // "id": "analytics.management.filters.update",
- // "parameterOrder": [
- // "accountId",
- // "filterId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to which the filter belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "filterId": {
- // "description": "ID of the filter to be updated.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/filters/{filterId}",
- // "request": {
- // "$ref": "Filter"
- // },
- // "response": {
- // "$ref": "Filter"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.goals.get":
-
-type ManagementGoalsGetCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- goalId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets a goal to which the user has access.
-func (r *ManagementGoalsService) Get(accountId string, webPropertyId string, profileId string, goalId string) *ManagementGoalsGetCall {
- c := &ManagementGoalsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- c.goalId = goalId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementGoalsGetCall) Fields(s ...googleapi.Field) *ManagementGoalsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementGoalsGetCall) IfNoneMatch(entityTag string) *ManagementGoalsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementGoalsGetCall) Context(ctx context.Context) *ManagementGoalsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementGoalsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- "goalId": c.goalId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.goals.get" call.
-// Exactly one of *Goal or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Goal.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *ManagementGoalsGetCall) Do() (*Goal, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Goal{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets a goal to which the user has access.",
- // "httpMethod": "GET",
- // "id": "analytics.management.goals.get",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId",
- // "goalId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to retrieve the goal for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "goalId": {
- // "description": "Goal ID to retrieve the goal for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "View (Profile) ID to retrieve the goal for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property ID to retrieve the goal for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}",
- // "response": {
- // "$ref": "Goal"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.goals.insert":
-
-type ManagementGoalsInsertCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- goal *Goal
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Create a new goal.
-func (r *ManagementGoalsService) Insert(accountId string, webPropertyId string, profileId string, goal *Goal) *ManagementGoalsInsertCall {
- c := &ManagementGoalsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- c.goal = goal
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementGoalsInsertCall) Fields(s ...googleapi.Field) *ManagementGoalsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementGoalsInsertCall) Context(ctx context.Context) *ManagementGoalsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementGoalsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.goal)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.goals.insert" call.
-// Exactly one of *Goal or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Goal.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *ManagementGoalsInsertCall) Do() (*Goal, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Goal{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Create a new goal.",
- // "httpMethod": "POST",
- // "id": "analytics.management.goals.insert",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to create the goal for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "View (Profile) ID to create the goal for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property ID to create the goal for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals",
- // "request": {
- // "$ref": "Goal"
- // },
- // "response": {
- // "$ref": "Goal"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.goals.list":
-
-type ManagementGoalsListCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists goals to which the user has access.
-func (r *ManagementGoalsService) List(accountId string, webPropertyId string, profileId string) *ManagementGoalsListCall {
- c := &ManagementGoalsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- return c
-}
-
-// MaxResults sets the optional parameter "max-results": The maximum
-// number of goals to include in this response.
-func (c *ManagementGoalsListCall) MaxResults(maxResults int64) *ManagementGoalsListCall {
- c.opt_["max-results"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "start-index": An index of the
-// first goal to retrieve. Use this parameter as a pagination mechanism
-// along with the max-results parameter.
-func (c *ManagementGoalsListCall) StartIndex(startIndex int64) *ManagementGoalsListCall {
- c.opt_["start-index"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementGoalsListCall) Fields(s ...googleapi.Field) *ManagementGoalsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementGoalsListCall) IfNoneMatch(entityTag string) *ManagementGoalsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementGoalsListCall) Context(ctx context.Context) *ManagementGoalsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementGoalsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["max-results"]; ok {
- params.Set("max-results", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["start-index"]; ok {
- params.Set("start-index", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.goals.list" call.
-// Exactly one of *Goals or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Goals.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ManagementGoalsListCall) Do() (*Goals, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Goals{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists goals to which the user has access.",
- // "httpMethod": "GET",
- // "id": "analytics.management.goals.list",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "max-results": {
- // "description": "The maximum number of goals to include in this response.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "profileId": {
- // "description": "View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "start-index": {
- // "description": "An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "webPropertyId": {
- // "description": "Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals",
- // "response": {
- // "$ref": "Goals"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.edit",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.goals.patch":
-
-type ManagementGoalsPatchCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- goalId string
- goal *Goal
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing view (profile). This method supports patch
-// semantics.
-func (r *ManagementGoalsService) Patch(accountId string, webPropertyId string, profileId string, goalId string, goal *Goal) *ManagementGoalsPatchCall {
- c := &ManagementGoalsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- c.goalId = goalId
- c.goal = goal
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementGoalsPatchCall) Fields(s ...googleapi.Field) *ManagementGoalsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementGoalsPatchCall) Context(ctx context.Context) *ManagementGoalsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementGoalsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.goal)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- "goalId": c.goalId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.goals.patch" call.
-// Exactly one of *Goal or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Goal.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *ManagementGoalsPatchCall) Do() (*Goal, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Goal{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing view (profile). This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "analytics.management.goals.patch",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId",
- // "goalId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to update the goal.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "goalId": {
- // "description": "Index of the goal to be updated.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "View (Profile) ID to update the goal.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property ID to update the goal.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}",
- // "request": {
- // "$ref": "Goal"
- // },
- // "response": {
- // "$ref": "Goal"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.goals.update":
-
-type ManagementGoalsUpdateCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- goalId string
- goal *Goal
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing view (profile).
-func (r *ManagementGoalsService) Update(accountId string, webPropertyId string, profileId string, goalId string, goal *Goal) *ManagementGoalsUpdateCall {
- c := &ManagementGoalsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- c.goalId = goalId
- c.goal = goal
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementGoalsUpdateCall) Fields(s ...googleapi.Field) *ManagementGoalsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementGoalsUpdateCall) Context(ctx context.Context) *ManagementGoalsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementGoalsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.goal)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- "goalId": c.goalId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.goals.update" call.
-// Exactly one of *Goal or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Goal.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *ManagementGoalsUpdateCall) Do() (*Goal, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Goal{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing view (profile).",
- // "httpMethod": "PUT",
- // "id": "analytics.management.goals.update",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId",
- // "goalId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to update the goal.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "goalId": {
- // "description": "Index of the goal to be updated.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "View (Profile) ID to update the goal.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property ID to update the goal.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}",
- // "request": {
- // "$ref": "Goal"
- // },
- // "response": {
- // "$ref": "Goal"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.profileFilterLinks.delete":
-
-type ManagementProfileFilterLinksDeleteCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- linkId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Delete a profile filter link.
-func (r *ManagementProfileFilterLinksService) Delete(accountId string, webPropertyId string, profileId string, linkId string) *ManagementProfileFilterLinksDeleteCall {
- c := &ManagementProfileFilterLinksDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- c.linkId = linkId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementProfileFilterLinksDeleteCall) Fields(s ...googleapi.Field) *ManagementProfileFilterLinksDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementProfileFilterLinksDeleteCall) Context(ctx context.Context) *ManagementProfileFilterLinksDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementProfileFilterLinksDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- "linkId": c.linkId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.profileFilterLinks.delete" call.
-func (c *ManagementProfileFilterLinksDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Delete a profile filter link.",
- // "httpMethod": "DELETE",
- // "id": "analytics.management.profileFilterLinks.delete",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId",
- // "linkId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to which the profile filter link belongs.",
- // "location": "path",
- // "pattern": "\\d+",
- // "required": true,
- // "type": "string"
- // },
- // "linkId": {
- // "description": "ID of the profile filter link to delete.",
- // "location": "path",
- // "pattern": "\\d+:\\d+",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "Profile ID to which the filter link belongs.",
- // "location": "path",
- // "pattern": "\\d+",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property Id to which the profile filter link belongs.",
- // "location": "path",
- // "pattern": "UA-(\\d+)-(\\d+)",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.profileFilterLinks.get":
-
-type ManagementProfileFilterLinksGetCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- linkId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns a single profile filter link.
-func (r *ManagementProfileFilterLinksService) Get(accountId string, webPropertyId string, profileId string, linkId string) *ManagementProfileFilterLinksGetCall {
- c := &ManagementProfileFilterLinksGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- c.linkId = linkId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementProfileFilterLinksGetCall) Fields(s ...googleapi.Field) *ManagementProfileFilterLinksGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementProfileFilterLinksGetCall) IfNoneMatch(entityTag string) *ManagementProfileFilterLinksGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementProfileFilterLinksGetCall) Context(ctx context.Context) *ManagementProfileFilterLinksGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementProfileFilterLinksGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- "linkId": c.linkId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.profileFilterLinks.get" call.
-// Exactly one of *ProfileFilterLink or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ProfileFilterLink.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementProfileFilterLinksGetCall) Do() (*ProfileFilterLink, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ProfileFilterLink{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns a single profile filter link.",
- // "httpMethod": "GET",
- // "id": "analytics.management.profileFilterLinks.get",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId",
- // "linkId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to retrieve profile filter link for.",
- // "location": "path",
- // "pattern": "\\d+",
- // "required": true,
- // "type": "string"
- // },
- // "linkId": {
- // "description": "ID of the profile filter link.",
- // "location": "path",
- // "pattern": "\\d+:\\d+",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "Profile ID to retrieve filter link for.",
- // "location": "path",
- // "pattern": "\\d+",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property Id to retrieve profile filter link for.",
- // "location": "path",
- // "pattern": "UA-(\\d+)-(\\d+)",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}",
- // "response": {
- // "$ref": "ProfileFilterLink"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.profileFilterLinks.insert":
-
-type ManagementProfileFilterLinksInsertCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- profilefilterlink *ProfileFilterLink
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Create a new profile filter link.
-func (r *ManagementProfileFilterLinksService) Insert(accountId string, webPropertyId string, profileId string, profilefilterlink *ProfileFilterLink) *ManagementProfileFilterLinksInsertCall {
- c := &ManagementProfileFilterLinksInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- c.profilefilterlink = profilefilterlink
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementProfileFilterLinksInsertCall) Fields(s ...googleapi.Field) *ManagementProfileFilterLinksInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementProfileFilterLinksInsertCall) Context(ctx context.Context) *ManagementProfileFilterLinksInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementProfileFilterLinksInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.profilefilterlink)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.profileFilterLinks.insert" call.
-// Exactly one of *ProfileFilterLink or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ProfileFilterLink.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementProfileFilterLinksInsertCall) Do() (*ProfileFilterLink, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ProfileFilterLink{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Create a new profile filter link.",
- // "httpMethod": "POST",
- // "id": "analytics.management.profileFilterLinks.insert",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to create profile filter link for.",
- // "location": "path",
- // "pattern": "\\d+",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "Profile ID to create filter link for.",
- // "location": "path",
- // "pattern": "\\d+",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property Id to create profile filter link for.",
- // "location": "path",
- // "pattern": "UA-(\\d+)-(\\d+)",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks",
- // "request": {
- // "$ref": "ProfileFilterLink"
- // },
- // "response": {
- // "$ref": "ProfileFilterLink"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.profileFilterLinks.list":
-
-type ManagementProfileFilterLinksListCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all profile filter links for a profile.
-func (r *ManagementProfileFilterLinksService) List(accountId string, webPropertyId string, profileId string) *ManagementProfileFilterLinksListCall {
- c := &ManagementProfileFilterLinksListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- return c
-}
-
-// MaxResults sets the optional parameter "max-results": The maximum
-// number of profile filter links to include in this response.
-func (c *ManagementProfileFilterLinksListCall) MaxResults(maxResults int64) *ManagementProfileFilterLinksListCall {
- c.opt_["max-results"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "start-index": An index of the
-// first entity to retrieve. Use this parameter as a pagination
-// mechanism along with the max-results parameter.
-func (c *ManagementProfileFilterLinksListCall) StartIndex(startIndex int64) *ManagementProfileFilterLinksListCall {
- c.opt_["start-index"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementProfileFilterLinksListCall) Fields(s ...googleapi.Field) *ManagementProfileFilterLinksListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementProfileFilterLinksListCall) IfNoneMatch(entityTag string) *ManagementProfileFilterLinksListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementProfileFilterLinksListCall) Context(ctx context.Context) *ManagementProfileFilterLinksListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementProfileFilterLinksListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["max-results"]; ok {
- params.Set("max-results", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["start-index"]; ok {
- params.Set("start-index", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.profileFilterLinks.list" call.
-// Exactly one of *ProfileFilterLinks or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ProfileFilterLinks.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementProfileFilterLinksListCall) Do() (*ProfileFilterLinks, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ProfileFilterLinks{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all profile filter links for a profile.",
- // "httpMethod": "GET",
- // "id": "analytics.management.profileFilterLinks.list",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to retrieve profile filter links for.",
- // "location": "path",
- // "pattern": "\\d+",
- // "required": true,
- // "type": "string"
- // },
- // "max-results": {
- // "description": "The maximum number of profile filter links to include in this response.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "profileId": {
- // "description": "Profile ID to retrieve filter links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "start-index": {
- // "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "webPropertyId": {
- // "description": "Web property Id for profile filter links for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks",
- // "response": {
- // "$ref": "ProfileFilterLinks"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.profileFilterLinks.patch":
-
-type ManagementProfileFilterLinksPatchCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- linkId string
- profilefilterlink *ProfileFilterLink
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Update an existing profile filter link. This method supports
-// patch semantics.
-func (r *ManagementProfileFilterLinksService) Patch(accountId string, webPropertyId string, profileId string, linkId string, profilefilterlink *ProfileFilterLink) *ManagementProfileFilterLinksPatchCall {
- c := &ManagementProfileFilterLinksPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- c.linkId = linkId
- c.profilefilterlink = profilefilterlink
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementProfileFilterLinksPatchCall) Fields(s ...googleapi.Field) *ManagementProfileFilterLinksPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementProfileFilterLinksPatchCall) Context(ctx context.Context) *ManagementProfileFilterLinksPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementProfileFilterLinksPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.profilefilterlink)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- "linkId": c.linkId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.profileFilterLinks.patch" call.
-// Exactly one of *ProfileFilterLink or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ProfileFilterLink.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementProfileFilterLinksPatchCall) Do() (*ProfileFilterLink, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ProfileFilterLink{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update an existing profile filter link. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "analytics.management.profileFilterLinks.patch",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId",
- // "linkId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to which profile filter link belongs.",
- // "location": "path",
- // "pattern": "\\d+",
- // "required": true,
- // "type": "string"
- // },
- // "linkId": {
- // "description": "ID of the profile filter link to be updated.",
- // "location": "path",
- // "pattern": "\\d+:\\d+",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "Profile ID to which filter link belongs",
- // "location": "path",
- // "pattern": "\\d+",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property Id to which profile filter link belongs",
- // "location": "path",
- // "pattern": "UA-(\\d+)-(\\d+)",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}",
- // "request": {
- // "$ref": "ProfileFilterLink"
- // },
- // "response": {
- // "$ref": "ProfileFilterLink"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.profileFilterLinks.update":
-
-type ManagementProfileFilterLinksUpdateCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- linkId string
- profilefilterlink *ProfileFilterLink
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Update an existing profile filter link.
-func (r *ManagementProfileFilterLinksService) Update(accountId string, webPropertyId string, profileId string, linkId string, profilefilterlink *ProfileFilterLink) *ManagementProfileFilterLinksUpdateCall {
- c := &ManagementProfileFilterLinksUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- c.linkId = linkId
- c.profilefilterlink = profilefilterlink
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementProfileFilterLinksUpdateCall) Fields(s ...googleapi.Field) *ManagementProfileFilterLinksUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementProfileFilterLinksUpdateCall) Context(ctx context.Context) *ManagementProfileFilterLinksUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementProfileFilterLinksUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.profilefilterlink)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- "linkId": c.linkId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.profileFilterLinks.update" call.
-// Exactly one of *ProfileFilterLink or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ProfileFilterLink.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementProfileFilterLinksUpdateCall) Do() (*ProfileFilterLink, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ProfileFilterLink{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update an existing profile filter link.",
- // "httpMethod": "PUT",
- // "id": "analytics.management.profileFilterLinks.update",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId",
- // "linkId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to which profile filter link belongs.",
- // "location": "path",
- // "pattern": "\\d+",
- // "required": true,
- // "type": "string"
- // },
- // "linkId": {
- // "description": "ID of the profile filter link to be updated.",
- // "location": "path",
- // "pattern": "\\d+:\\d+",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "Profile ID to which filter link belongs",
- // "location": "path",
- // "pattern": "\\d+",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property Id to which profile filter link belongs",
- // "location": "path",
- // "pattern": "UA-(\\d+)-(\\d+)",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}",
- // "request": {
- // "$ref": "ProfileFilterLink"
- // },
- // "response": {
- // "$ref": "ProfileFilterLink"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.profileUserLinks.delete":
-
-type ManagementProfileUserLinksDeleteCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- linkId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Removes a user from the given view (profile).
-func (r *ManagementProfileUserLinksService) Delete(accountId string, webPropertyId string, profileId string, linkId string) *ManagementProfileUserLinksDeleteCall {
- c := &ManagementProfileUserLinksDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- c.linkId = linkId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementProfileUserLinksDeleteCall) Fields(s ...googleapi.Field) *ManagementProfileUserLinksDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementProfileUserLinksDeleteCall) Context(ctx context.Context) *ManagementProfileUserLinksDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementProfileUserLinksDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- "linkId": c.linkId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.profileUserLinks.delete" call.
-func (c *ManagementProfileUserLinksDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Removes a user from the given view (profile).",
- // "httpMethod": "DELETE",
- // "id": "analytics.management.profileUserLinks.delete",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId",
- // "linkId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to delete the user link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "linkId": {
- // "description": "Link ID to delete the user link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "View (Profile) ID to delete the user link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web Property ID to delete the user link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.manage.users"
- // ]
- // }
-
-}
-
-// method id "analytics.management.profileUserLinks.insert":
-
-type ManagementProfileUserLinksInsertCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- entityuserlink *EntityUserLink
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Adds a new user to the given view (profile).
-func (r *ManagementProfileUserLinksService) Insert(accountId string, webPropertyId string, profileId string, entityuserlink *EntityUserLink) *ManagementProfileUserLinksInsertCall {
- c := &ManagementProfileUserLinksInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- c.entityuserlink = entityuserlink
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementProfileUserLinksInsertCall) Fields(s ...googleapi.Field) *ManagementProfileUserLinksInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementProfileUserLinksInsertCall) Context(ctx context.Context) *ManagementProfileUserLinksInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementProfileUserLinksInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.entityuserlink)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.profileUserLinks.insert" call.
-// Exactly one of *EntityUserLink or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *EntityUserLink.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementProfileUserLinksInsertCall) Do() (*EntityUserLink, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EntityUserLink{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Adds a new user to the given view (profile).",
- // "httpMethod": "POST",
- // "id": "analytics.management.profileUserLinks.insert",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to create the user link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "View (Profile) ID to create the user link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web Property ID to create the user link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks",
- // "request": {
- // "$ref": "EntityUserLink"
- // },
- // "response": {
- // "$ref": "EntityUserLink"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.manage.users"
- // ]
- // }
-
-}
-
-// method id "analytics.management.profileUserLinks.list":
-
-type ManagementProfileUserLinksListCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists profile-user links for a given view (profile).
-func (r *ManagementProfileUserLinksService) List(accountId string, webPropertyId string, profileId string) *ManagementProfileUserLinksListCall {
- c := &ManagementProfileUserLinksListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- return c
-}
-
-// MaxResults sets the optional parameter "max-results": The maximum
-// number of profile-user links to include in this response.
-func (c *ManagementProfileUserLinksListCall) MaxResults(maxResults int64) *ManagementProfileUserLinksListCall {
- c.opt_["max-results"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "start-index": An index of the
-// first profile-user link to retrieve. Use this parameter as a
-// pagination mechanism along with the max-results parameter.
-func (c *ManagementProfileUserLinksListCall) StartIndex(startIndex int64) *ManagementProfileUserLinksListCall {
- c.opt_["start-index"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementProfileUserLinksListCall) Fields(s ...googleapi.Field) *ManagementProfileUserLinksListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementProfileUserLinksListCall) IfNoneMatch(entityTag string) *ManagementProfileUserLinksListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementProfileUserLinksListCall) Context(ctx context.Context) *ManagementProfileUserLinksListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementProfileUserLinksListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["max-results"]; ok {
- params.Set("max-results", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["start-index"]; ok {
- params.Set("start-index", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.profileUserLinks.list" call.
-// Exactly one of *EntityUserLinks or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *EntityUserLinks.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementProfileUserLinksListCall) Do() (*EntityUserLinks, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EntityUserLinks{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists profile-user links for a given view (profile).",
- // "httpMethod": "GET",
- // "id": "analytics.management.profileUserLinks.list",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID which the given view (profile) belongs to.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "max-results": {
- // "description": "The maximum number of profile-user links to include in this response.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "profileId": {
- // "description": "View (Profile) ID to retrieve the profile-user links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "start-index": {
- // "description": "An index of the first profile-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "webPropertyId": {
- // "description": "Web Property ID which the given view (profile) belongs to. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks",
- // "response": {
- // "$ref": "EntityUserLinks"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.manage.users",
- // "https://www.googleapis.com/auth/analytics.manage.users.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.profileUserLinks.update":
-
-type ManagementProfileUserLinksUpdateCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- linkId string
- entityuserlink *EntityUserLink
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates permissions for an existing user on the given view
-// (profile).
-func (r *ManagementProfileUserLinksService) Update(accountId string, webPropertyId string, profileId string, linkId string, entityuserlink *EntityUserLink) *ManagementProfileUserLinksUpdateCall {
- c := &ManagementProfileUserLinksUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- c.linkId = linkId
- c.entityuserlink = entityuserlink
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementProfileUserLinksUpdateCall) Fields(s ...googleapi.Field) *ManagementProfileUserLinksUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementProfileUserLinksUpdateCall) Context(ctx context.Context) *ManagementProfileUserLinksUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementProfileUserLinksUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.entityuserlink)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- "linkId": c.linkId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.profileUserLinks.update" call.
-// Exactly one of *EntityUserLink or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *EntityUserLink.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementProfileUserLinksUpdateCall) Do() (*EntityUserLink, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EntityUserLink{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates permissions for an existing user on the given view (profile).",
- // "httpMethod": "PUT",
- // "id": "analytics.management.profileUserLinks.update",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId",
- // "linkId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to update the user link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "linkId": {
- // "description": "Link ID to update the user link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "View (Profile ID) to update the user link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web Property ID to update the user link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}",
- // "request": {
- // "$ref": "EntityUserLink"
- // },
- // "response": {
- // "$ref": "EntityUserLink"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.manage.users"
- // ]
- // }
-
-}
-
-// method id "analytics.management.profiles.delete":
-
-type ManagementProfilesDeleteCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes a view (profile).
-func (r *ManagementProfilesService) Delete(accountId string, webPropertyId string, profileId string) *ManagementProfilesDeleteCall {
- c := &ManagementProfilesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementProfilesDeleteCall) Fields(s ...googleapi.Field) *ManagementProfilesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementProfilesDeleteCall) Context(ctx context.Context) *ManagementProfilesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementProfilesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.profiles.delete" call.
-func (c *ManagementProfilesDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes a view (profile).",
- // "httpMethod": "DELETE",
- // "id": "analytics.management.profiles.delete",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to delete the view (profile) for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "ID of the view (profile) to be deleted.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property ID to delete the view (profile) for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.profiles.get":
-
-type ManagementProfilesGetCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets a view (profile) to which the user has access.
-func (r *ManagementProfilesService) Get(accountId string, webPropertyId string, profileId string) *ManagementProfilesGetCall {
- c := &ManagementProfilesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementProfilesGetCall) Fields(s ...googleapi.Field) *ManagementProfilesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementProfilesGetCall) IfNoneMatch(entityTag string) *ManagementProfilesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementProfilesGetCall) Context(ctx context.Context) *ManagementProfilesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementProfilesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.profiles.get" call.
-// Exactly one of *Profile or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Profile.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ManagementProfilesGetCall) Do() (*Profile, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Profile{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets a view (profile) to which the user has access.",
- // "httpMethod": "GET",
- // "id": "analytics.management.profiles.get",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to retrieve the goal for.",
- // "location": "path",
- // "pattern": "[0-9]+",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "View (Profile) ID to retrieve the goal for.",
- // "location": "path",
- // "pattern": "[0-9]+",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property ID to retrieve the goal for.",
- // "location": "path",
- // "pattern": "UA-[0-9]+-[0-9]+",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}",
- // "response": {
- // "$ref": "Profile"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.profiles.insert":
-
-type ManagementProfilesInsertCall struct {
- s *Service
- accountId string
- webPropertyId string
- profile *Profile
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Create a new view (profile).
-func (r *ManagementProfilesService) Insert(accountId string, webPropertyId string, profile *Profile) *ManagementProfilesInsertCall {
- c := &ManagementProfilesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profile = profile
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementProfilesInsertCall) Fields(s ...googleapi.Field) *ManagementProfilesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementProfilesInsertCall) Context(ctx context.Context) *ManagementProfilesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementProfilesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.profile)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.profiles.insert" call.
-// Exactly one of *Profile or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Profile.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ManagementProfilesInsertCall) Do() (*Profile, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Profile{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Create a new view (profile).",
- // "httpMethod": "POST",
- // "id": "analytics.management.profiles.insert",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to create the view (profile) for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property ID to create the view (profile) for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles",
- // "request": {
- // "$ref": "Profile"
- // },
- // "response": {
- // "$ref": "Profile"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.profiles.list":
-
-type ManagementProfilesListCall struct {
- s *Service
- accountId string
- webPropertyId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists views (profiles) to which the user has access.
-func (r *ManagementProfilesService) List(accountId string, webPropertyId string) *ManagementProfilesListCall {
- c := &ManagementProfilesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- return c
-}
-
-// MaxResults sets the optional parameter "max-results": The maximum
-// number of views (profiles) to include in this response.
-func (c *ManagementProfilesListCall) MaxResults(maxResults int64) *ManagementProfilesListCall {
- c.opt_["max-results"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "start-index": An index of the
-// first entity to retrieve. Use this parameter as a pagination
-// mechanism along with the max-results parameter.
-func (c *ManagementProfilesListCall) StartIndex(startIndex int64) *ManagementProfilesListCall {
- c.opt_["start-index"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementProfilesListCall) Fields(s ...googleapi.Field) *ManagementProfilesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementProfilesListCall) IfNoneMatch(entityTag string) *ManagementProfilesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementProfilesListCall) Context(ctx context.Context) *ManagementProfilesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementProfilesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["max-results"]; ok {
- params.Set("max-results", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["start-index"]; ok {
- params.Set("start-index", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.profiles.list" call.
-// Exactly one of *Profiles or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Profiles.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ManagementProfilesListCall) Do() (*Profiles, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Profiles{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists views (profiles) to which the user has access.",
- // "httpMethod": "GET",
- // "id": "analytics.management.profiles.list",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID for the view (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "max-results": {
- // "description": "The maximum number of views (profiles) to include in this response.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "start-index": {
- // "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "webPropertyId": {
- // "description": "Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles",
- // "response": {
- // "$ref": "Profiles"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.edit",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.profiles.patch":
-
-type ManagementProfilesPatchCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- profile *Profile
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing view (profile). This method supports patch
-// semantics.
-func (r *ManagementProfilesService) Patch(accountId string, webPropertyId string, profileId string, profile *Profile) *ManagementProfilesPatchCall {
- c := &ManagementProfilesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- c.profile = profile
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementProfilesPatchCall) Fields(s ...googleapi.Field) *ManagementProfilesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementProfilesPatchCall) Context(ctx context.Context) *ManagementProfilesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementProfilesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.profile)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.profiles.patch" call.
-// Exactly one of *Profile or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Profile.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ManagementProfilesPatchCall) Do() (*Profile, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Profile{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing view (profile). This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "analytics.management.profiles.patch",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to which the view (profile) belongs",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "ID of the view (profile) to be updated.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property ID to which the view (profile) belongs",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}",
- // "request": {
- // "$ref": "Profile"
- // },
- // "response": {
- // "$ref": "Profile"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.profiles.update":
-
-type ManagementProfilesUpdateCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- profile *Profile
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing view (profile).
-func (r *ManagementProfilesService) Update(accountId string, webPropertyId string, profileId string, profile *Profile) *ManagementProfilesUpdateCall {
- c := &ManagementProfilesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- c.profile = profile
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementProfilesUpdateCall) Fields(s ...googleapi.Field) *ManagementProfilesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementProfilesUpdateCall) Context(ctx context.Context) *ManagementProfilesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementProfilesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.profile)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.profiles.update" call.
-// Exactly one of *Profile or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Profile.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ManagementProfilesUpdateCall) Do() (*Profile, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Profile{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing view (profile).",
- // "httpMethod": "PUT",
- // "id": "analytics.management.profiles.update",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to which the view (profile) belongs",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "ID of the view (profile) to be updated.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property ID to which the view (profile) belongs",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}",
- // "request": {
- // "$ref": "Profile"
- // },
- // "response": {
- // "$ref": "Profile"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.segments.list":
-
-type ManagementSegmentsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists segments to which the user has access.
-func (r *ManagementSegmentsService) List() *ManagementSegmentsListCall {
- c := &ManagementSegmentsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// MaxResults sets the optional parameter "max-results": The maximum
-// number of segments to include in this response.
-func (c *ManagementSegmentsListCall) MaxResults(maxResults int64) *ManagementSegmentsListCall {
- c.opt_["max-results"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "start-index": An index of the
-// first segment to retrieve. Use this parameter as a pagination
-// mechanism along with the max-results parameter.
-func (c *ManagementSegmentsListCall) StartIndex(startIndex int64) *ManagementSegmentsListCall {
- c.opt_["start-index"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementSegmentsListCall) Fields(s ...googleapi.Field) *ManagementSegmentsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementSegmentsListCall) IfNoneMatch(entityTag string) *ManagementSegmentsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementSegmentsListCall) Context(ctx context.Context) *ManagementSegmentsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementSegmentsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["max-results"]; ok {
- params.Set("max-results", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["start-index"]; ok {
- params.Set("start-index", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/segments")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.segments.list" call.
-// Exactly one of *Segments or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Segments.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ManagementSegmentsListCall) Do() (*Segments, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Segments{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists segments to which the user has access.",
- // "httpMethod": "GET",
- // "id": "analytics.management.segments.list",
- // "parameters": {
- // "max-results": {
- // "description": "The maximum number of segments to include in this response.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "start-index": {
- // "description": "An index of the first segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // }
- // },
- // "path": "management/segments",
- // "response": {
- // "$ref": "Segments"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.edit",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.unsampledReports.get":
-
-type ManagementUnsampledReportsGetCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- unsampledReportId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns a single unsampled report.
-func (r *ManagementUnsampledReportsService) Get(accountId string, webPropertyId string, profileId string, unsampledReportId string) *ManagementUnsampledReportsGetCall {
- c := &ManagementUnsampledReportsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- c.unsampledReportId = unsampledReportId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementUnsampledReportsGetCall) Fields(s ...googleapi.Field) *ManagementUnsampledReportsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementUnsampledReportsGetCall) IfNoneMatch(entityTag string) *ManagementUnsampledReportsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementUnsampledReportsGetCall) Context(ctx context.Context) *ManagementUnsampledReportsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementUnsampledReportsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- "unsampledReportId": c.unsampledReportId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.unsampledReports.get" call.
-// Exactly one of *UnsampledReport or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UnsampledReport.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementUnsampledReportsGetCall) Do() (*UnsampledReport, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UnsampledReport{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns a single unsampled report.",
- // "httpMethod": "GET",
- // "id": "analytics.management.unsampledReports.get",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId",
- // "unsampledReportId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to retrieve unsampled report for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "View (Profile) ID to retrieve unsampled report for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "unsampledReportId": {
- // "description": "ID of the unsampled report to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property ID to retrieve unsampled reports for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}",
- // "response": {
- // "$ref": "UnsampledReport"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.edit",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.unsampledReports.insert":
-
-type ManagementUnsampledReportsInsertCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- unsampledreport *UnsampledReport
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Create a new unsampled report.
-func (r *ManagementUnsampledReportsService) Insert(accountId string, webPropertyId string, profileId string, unsampledreport *UnsampledReport) *ManagementUnsampledReportsInsertCall {
- c := &ManagementUnsampledReportsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- c.unsampledreport = unsampledreport
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementUnsampledReportsInsertCall) Fields(s ...googleapi.Field) *ManagementUnsampledReportsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementUnsampledReportsInsertCall) Context(ctx context.Context) *ManagementUnsampledReportsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementUnsampledReportsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.unsampledreport)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.unsampledReports.insert" call.
-// Exactly one of *UnsampledReport or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UnsampledReport.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementUnsampledReportsInsertCall) Do() (*UnsampledReport, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UnsampledReport{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Create a new unsampled report.",
- // "httpMethod": "POST",
- // "id": "analytics.management.unsampledReports.insert",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to create the unsampled report for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "View (Profile) ID to create the unsampled report for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property ID to create the unsampled report for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports",
- // "request": {
- // "$ref": "UnsampledReport"
- // },
- // "response": {
- // "$ref": "UnsampledReport"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.unsampledReports.list":
-
-type ManagementUnsampledReportsListCall struct {
- s *Service
- accountId string
- webPropertyId string
- profileId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists unsampled reports to which the user has access.
-func (r *ManagementUnsampledReportsService) List(accountId string, webPropertyId string, profileId string) *ManagementUnsampledReportsListCall {
- c := &ManagementUnsampledReportsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.profileId = profileId
- return c
-}
-
-// MaxResults sets the optional parameter "max-results": The maximum
-// number of unsampled reports to include in this response.
-func (c *ManagementUnsampledReportsListCall) MaxResults(maxResults int64) *ManagementUnsampledReportsListCall {
- c.opt_["max-results"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "start-index": An index of the
-// first unsampled report to retrieve. Use this parameter as a
-// pagination mechanism along with the max-results parameter.
-func (c *ManagementUnsampledReportsListCall) StartIndex(startIndex int64) *ManagementUnsampledReportsListCall {
- c.opt_["start-index"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementUnsampledReportsListCall) Fields(s ...googleapi.Field) *ManagementUnsampledReportsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementUnsampledReportsListCall) IfNoneMatch(entityTag string) *ManagementUnsampledReportsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementUnsampledReportsListCall) Context(ctx context.Context) *ManagementUnsampledReportsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementUnsampledReportsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["max-results"]; ok {
- params.Set("max-results", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["start-index"]; ok {
- params.Set("start-index", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "profileId": c.profileId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.unsampledReports.list" call.
-// Exactly one of *UnsampledReports or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *UnsampledReports.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementUnsampledReportsListCall) Do() (*UnsampledReports, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UnsampledReports{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists unsampled reports to which the user has access.",
- // "httpMethod": "GET",
- // "id": "analytics.management.unsampledReports.list",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "profileId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to retrieve unsampled reports for. Must be a specific account ID, ~all is not supported.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "max-results": {
- // "description": "The maximum number of unsampled reports to include in this response.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "profileId": {
- // "description": "View (Profile) ID to retrieve unsampled reports for. Must be a specific view (profile) ID, ~all is not supported.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "start-index": {
- // "description": "An index of the first unsampled report to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "webPropertyId": {
- // "description": "Web property ID to retrieve unsampled reports for. Must be a specific web property ID, ~all is not supported.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports",
- // "response": {
- // "$ref": "UnsampledReports"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.edit",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.uploads.deleteUploadData":
-
-type ManagementUploadsDeleteUploadDataCall struct {
- s *Service
- accountId string
- webPropertyId string
- customDataSourceId string
- analyticsdataimportdeleteuploaddatarequest *AnalyticsDataimportDeleteUploadDataRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// DeleteUploadData: Delete data associated with a previous upload.
-func (r *ManagementUploadsService) DeleteUploadData(accountId string, webPropertyId string, customDataSourceId string, analyticsdataimportdeleteuploaddatarequest *AnalyticsDataimportDeleteUploadDataRequest) *ManagementUploadsDeleteUploadDataCall {
- c := &ManagementUploadsDeleteUploadDataCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.customDataSourceId = customDataSourceId
- c.analyticsdataimportdeleteuploaddatarequest = analyticsdataimportdeleteuploaddatarequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementUploadsDeleteUploadDataCall) Fields(s ...googleapi.Field) *ManagementUploadsDeleteUploadDataCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementUploadsDeleteUploadDataCall) Context(ctx context.Context) *ManagementUploadsDeleteUploadDataCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementUploadsDeleteUploadDataCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.analyticsdataimportdeleteuploaddatarequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/deleteUploadData")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "customDataSourceId": c.customDataSourceId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.uploads.deleteUploadData" call.
-func (c *ManagementUploadsDeleteUploadDataCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Delete data associated with a previous upload.",
- // "httpMethod": "POST",
- // "id": "analytics.management.uploads.deleteUploadData",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "customDataSourceId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account Id for the uploads to be deleted.",
- // "location": "path",
- // "pattern": "\\d+",
- // "required": true,
- // "type": "string"
- // },
- // "customDataSourceId": {
- // "description": "Custom data source Id for the uploads to be deleted.",
- // "location": "path",
- // "pattern": ".{22}",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property Id for the uploads to be deleted.",
- // "location": "path",
- // "pattern": "UA-(\\d+)-(\\d+)",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/deleteUploadData",
- // "request": {
- // "$ref": "AnalyticsDataimportDeleteUploadDataRequest"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.uploads.get":
-
-type ManagementUploadsGetCall struct {
- s *Service
- accountId string
- webPropertyId string
- customDataSourceId string
- uploadId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: List uploads to which the user has access.
-func (r *ManagementUploadsService) Get(accountId string, webPropertyId string, customDataSourceId string, uploadId string) *ManagementUploadsGetCall {
- c := &ManagementUploadsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.customDataSourceId = customDataSourceId
- c.uploadId = uploadId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementUploadsGetCall) Fields(s ...googleapi.Field) *ManagementUploadsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementUploadsGetCall) IfNoneMatch(entityTag string) *ManagementUploadsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementUploadsGetCall) Context(ctx context.Context) *ManagementUploadsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementUploadsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads/{uploadId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "customDataSourceId": c.customDataSourceId,
- "uploadId": c.uploadId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.uploads.get" call.
-// Exactly one of *Upload or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Upload.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ManagementUploadsGetCall) Do() (*Upload, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Upload{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List uploads to which the user has access.",
- // "httpMethod": "GET",
- // "id": "analytics.management.uploads.get",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "customDataSourceId",
- // "uploadId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account Id for the upload to retrieve.",
- // "location": "path",
- // "pattern": "\\d+",
- // "required": true,
- // "type": "string"
- // },
- // "customDataSourceId": {
- // "description": "Custom data source Id for upload to retrieve.",
- // "location": "path",
- // "pattern": ".{22}",
- // "required": true,
- // "type": "string"
- // },
- // "uploadId": {
- // "description": "Upload Id to retrieve.",
- // "location": "path",
- // "pattern": ".{22}",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property Id for the upload to retrieve.",
- // "location": "path",
- // "pattern": "UA-(\\d+)-(\\d+)",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads/{uploadId}",
- // "response": {
- // "$ref": "Upload"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.edit",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.uploads.list":
-
-type ManagementUploadsListCall struct {
- s *Service
- accountId string
- webPropertyId string
- customDataSourceId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List uploads to which the user has access.
-func (r *ManagementUploadsService) List(accountId string, webPropertyId string, customDataSourceId string) *ManagementUploadsListCall {
- c := &ManagementUploadsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.customDataSourceId = customDataSourceId
- return c
-}
-
-// MaxResults sets the optional parameter "max-results": The maximum
-// number of uploads to include in this response.
-func (c *ManagementUploadsListCall) MaxResults(maxResults int64) *ManagementUploadsListCall {
- c.opt_["max-results"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "start-index": A 1-based index
-// of the first upload to retrieve. Use this parameter as a pagination
-// mechanism along with the max-results parameter.
-func (c *ManagementUploadsListCall) StartIndex(startIndex int64) *ManagementUploadsListCall {
- c.opt_["start-index"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementUploadsListCall) Fields(s ...googleapi.Field) *ManagementUploadsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementUploadsListCall) IfNoneMatch(entityTag string) *ManagementUploadsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementUploadsListCall) Context(ctx context.Context) *ManagementUploadsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementUploadsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["max-results"]; ok {
- params.Set("max-results", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["start-index"]; ok {
- params.Set("start-index", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "customDataSourceId": c.customDataSourceId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.uploads.list" call.
-// Exactly one of *Uploads or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Uploads.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ManagementUploadsListCall) Do() (*Uploads, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Uploads{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List uploads to which the user has access.",
- // "httpMethod": "GET",
- // "id": "analytics.management.uploads.list",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "customDataSourceId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account Id for the uploads to retrieve.",
- // "location": "path",
- // "pattern": "\\d+",
- // "required": true,
- // "type": "string"
- // },
- // "customDataSourceId": {
- // "description": "Custom data source Id for uploads to retrieve.",
- // "location": "path",
- // "pattern": ".{22}",
- // "required": true,
- // "type": "string"
- // },
- // "max-results": {
- // "description": "The maximum number of uploads to include in this response.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "start-index": {
- // "description": "A 1-based index of the first upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "webPropertyId": {
- // "description": "Web property Id for the uploads to retrieve.",
- // "location": "path",
- // "pattern": "UA-(\\d+)-(\\d+)",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads",
- // "response": {
- // "$ref": "Uploads"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.edit",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.uploads.uploadData":
-
-type ManagementUploadsUploadDataCall struct {
- s *Service
- accountId string
- webPropertyId string
- customDataSourceId string
- opt_ map[string]interface{}
- media_ io.Reader
- resumable_ googleapi.SizeReaderAt
- mediaType_ string
- protocol_ string
- ctx_ context.Context
-}
-
-// UploadData: Upload data for a custom data source.
-func (r *ManagementUploadsService) UploadData(accountId string, webPropertyId string, customDataSourceId string) *ManagementUploadsUploadDataCall {
- c := &ManagementUploadsUploadDataCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.customDataSourceId = customDataSourceId
- return c
-}
-
-// Media specifies the media to upload in a single chunk.
-// At most one of Media and ResumableMedia may be set.
-func (c *ManagementUploadsUploadDataCall) Media(r io.Reader) *ManagementUploadsUploadDataCall {
- c.media_ = r
- c.protocol_ = "multipart"
- return c
-}
-
-// ResumableMedia specifies the media to upload in chunks and can be canceled with ctx.
-// At most one of Media and ResumableMedia may be set.
-// mediaType identifies the MIME media type of the upload, such as "image/png".
-// If mediaType is "", it will be auto-detected.
-// The provided ctx will supersede any context previously provided to
-// the Context method.
-func (c *ManagementUploadsUploadDataCall) ResumableMedia(ctx context.Context, r io.ReaderAt, size int64, mediaType string) *ManagementUploadsUploadDataCall {
- c.ctx_ = ctx
- c.resumable_ = io.NewSectionReader(r, 0, size)
- c.mediaType_ = mediaType
- c.protocol_ = "resumable"
- return c
-}
-
-// ProgressUpdater provides a callback function that will be called after every chunk.
-// It should be a low-latency function in order to not slow down the upload operation.
-// This should only be called when using ResumableMedia (as opposed to Media).
-func (c *ManagementUploadsUploadDataCall) ProgressUpdater(pu googleapi.ProgressUpdater) *ManagementUploadsUploadDataCall {
- c.opt_["progressUpdater"] = pu
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementUploadsUploadDataCall) Fields(s ...googleapi.Field) *ManagementUploadsUploadDataCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-// This context will supersede any context previously provided to
-// the ResumableMedia method.
-func (c *ManagementUploadsUploadDataCall) Context(ctx context.Context) *ManagementUploadsUploadDataCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementUploadsUploadDataCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads")
- if c.media_ != nil || c.resumable_ != nil {
- urls = strings.Replace(urls, "https://www.googleapis.com/", "https://www.googleapis.com/upload/", 1)
- params.Set("uploadType", c.protocol_)
- }
- urls += "?" + params.Encode()
- body = new(bytes.Buffer)
- ctype := "application/json"
- if c.protocol_ != "resumable" {
- var cancel func()
- cancel, _ = googleapi.ConditionallyIncludeMedia(c.media_, &body, &ctype)
- if cancel != nil {
- defer cancel()
- }
- }
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "customDataSourceId": c.customDataSourceId,
- })
- if c.protocol_ == "resumable" {
- if c.mediaType_ == "" {
- c.mediaType_ = googleapi.DetectMediaType(c.resumable_)
- }
- req.Header.Set("X-Upload-Content-Type", c.mediaType_)
- req.Header.Set("Content-Type", "application/json; charset=utf-8")
- } else {
- req.Header.Set("Content-Type", ctype)
- }
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.uploads.uploadData" call.
-// Exactly one of *Upload or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Upload.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ManagementUploadsUploadDataCall) Do() (*Upload, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- var progressUpdater_ googleapi.ProgressUpdater
- if v, ok := c.opt_["progressUpdater"]; ok {
- if pu, ok := v.(googleapi.ProgressUpdater); ok {
- progressUpdater_ = pu
- }
- }
- if c.protocol_ == "resumable" {
- loc := res.Header.Get("Location")
- rx := &googleapi.ResumableUpload{
- Client: c.s.client,
- UserAgent: c.s.userAgent(),
- URI: loc,
- Media: c.resumable_,
- MediaType: c.mediaType_,
- ContentLength: c.resumable_.Size(),
- Callback: progressUpdater_,
- }
- res, err = rx.Upload(c.ctx_)
- if err != nil {
- return nil, err
- }
- defer res.Body.Close()
- }
- ret := &Upload{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Upload data for a custom data source.",
- // "httpMethod": "POST",
- // "id": "analytics.management.uploads.uploadData",
- // "mediaUpload": {
- // "accept": [
- // "application/octet-stream"
- // ],
- // "maxSize": "1GB",
- // "protocols": {
- // "resumable": {
- // "multipart": true,
- // "path": "/resumable/upload/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads"
- // },
- // "simple": {
- // "multipart": true,
- // "path": "/upload/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads"
- // }
- // }
- // },
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "customDataSourceId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account Id associated with the upload.",
- // "location": "path",
- // "pattern": "\\d+",
- // "required": true,
- // "type": "string"
- // },
- // "customDataSourceId": {
- // "description": "Custom data source Id to which the data being uploaded belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property UA-string associated with the upload.",
- // "location": "path",
- // "pattern": "UA-\\d+-\\d+",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads",
- // "response": {
- // "$ref": "Upload"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.edit"
- // ],
- // "supportsMediaUpload": true
- // }
-
-}
-
-// method id "analytics.management.webPropertyAdWordsLinks.delete":
-
-type ManagementWebPropertyAdWordsLinksDeleteCall struct {
- s *Service
- accountId string
- webPropertyId string
- webPropertyAdWordsLinkId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes a web property-AdWords link.
-func (r *ManagementWebPropertyAdWordsLinksService) Delete(accountId string, webPropertyId string, webPropertyAdWordsLinkId string) *ManagementWebPropertyAdWordsLinksDeleteCall {
- c := &ManagementWebPropertyAdWordsLinksDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.webPropertyAdWordsLinkId = webPropertyAdWordsLinkId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementWebPropertyAdWordsLinksDeleteCall) Fields(s ...googleapi.Field) *ManagementWebPropertyAdWordsLinksDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementWebPropertyAdWordsLinksDeleteCall) Context(ctx context.Context) *ManagementWebPropertyAdWordsLinksDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementWebPropertyAdWordsLinksDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "webPropertyAdWordsLinkId": c.webPropertyAdWordsLinkId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.webPropertyAdWordsLinks.delete" call.
-func (c *ManagementWebPropertyAdWordsLinksDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes a web property-AdWords link.",
- // "httpMethod": "DELETE",
- // "id": "analytics.management.webPropertyAdWordsLinks.delete",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "webPropertyAdWordsLinkId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "ID of the account which the given web property belongs to.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyAdWordsLinkId": {
- // "description": "Web property AdWords link ID.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property ID to delete the AdWords link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.webPropertyAdWordsLinks.get":
-
-type ManagementWebPropertyAdWordsLinksGetCall struct {
- s *Service
- accountId string
- webPropertyId string
- webPropertyAdWordsLinkId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns a web property-AdWords link to which the user has
-// access.
-func (r *ManagementWebPropertyAdWordsLinksService) Get(accountId string, webPropertyId string, webPropertyAdWordsLinkId string) *ManagementWebPropertyAdWordsLinksGetCall {
- c := &ManagementWebPropertyAdWordsLinksGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.webPropertyAdWordsLinkId = webPropertyAdWordsLinkId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementWebPropertyAdWordsLinksGetCall) Fields(s ...googleapi.Field) *ManagementWebPropertyAdWordsLinksGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementWebPropertyAdWordsLinksGetCall) IfNoneMatch(entityTag string) *ManagementWebPropertyAdWordsLinksGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementWebPropertyAdWordsLinksGetCall) Context(ctx context.Context) *ManagementWebPropertyAdWordsLinksGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementWebPropertyAdWordsLinksGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "webPropertyAdWordsLinkId": c.webPropertyAdWordsLinkId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.webPropertyAdWordsLinks.get" call.
-// Exactly one of *EntityAdWordsLink or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *EntityAdWordsLink.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementWebPropertyAdWordsLinksGetCall) Do() (*EntityAdWordsLink, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EntityAdWordsLink{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns a web property-AdWords link to which the user has access.",
- // "httpMethod": "GET",
- // "id": "analytics.management.webPropertyAdWordsLinks.get",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "webPropertyAdWordsLinkId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "ID of the account which the given web property belongs to.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyAdWordsLinkId": {
- // "description": "Web property-AdWords link ID.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property ID to retrieve the AdWords link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}",
- // "response": {
- // "$ref": "EntityAdWordsLink"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.webPropertyAdWordsLinks.insert":
-
-type ManagementWebPropertyAdWordsLinksInsertCall struct {
- s *Service
- accountId string
- webPropertyId string
- entityadwordslink *EntityAdWordsLink
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a webProperty-AdWords link.
-func (r *ManagementWebPropertyAdWordsLinksService) Insert(accountId string, webPropertyId string, entityadwordslink *EntityAdWordsLink) *ManagementWebPropertyAdWordsLinksInsertCall {
- c := &ManagementWebPropertyAdWordsLinksInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.entityadwordslink = entityadwordslink
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementWebPropertyAdWordsLinksInsertCall) Fields(s ...googleapi.Field) *ManagementWebPropertyAdWordsLinksInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementWebPropertyAdWordsLinksInsertCall) Context(ctx context.Context) *ManagementWebPropertyAdWordsLinksInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementWebPropertyAdWordsLinksInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.entityadwordslink)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.webPropertyAdWordsLinks.insert" call.
-// Exactly one of *EntityAdWordsLink or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *EntityAdWordsLink.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementWebPropertyAdWordsLinksInsertCall) Do() (*EntityAdWordsLink, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EntityAdWordsLink{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a webProperty-AdWords link.",
- // "httpMethod": "POST",
- // "id": "analytics.management.webPropertyAdWordsLinks.insert",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "ID of the Google Analytics account to create the link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property ID to create the link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks",
- // "request": {
- // "$ref": "EntityAdWordsLink"
- // },
- // "response": {
- // "$ref": "EntityAdWordsLink"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.webPropertyAdWordsLinks.list":
-
-type ManagementWebPropertyAdWordsLinksListCall struct {
- s *Service
- accountId string
- webPropertyId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists webProperty-AdWords links for a given web property.
-func (r *ManagementWebPropertyAdWordsLinksService) List(accountId string, webPropertyId string) *ManagementWebPropertyAdWordsLinksListCall {
- c := &ManagementWebPropertyAdWordsLinksListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- return c
-}
-
-// MaxResults sets the optional parameter "max-results": The maximum
-// number of webProperty-AdWords links to include in this response.
-func (c *ManagementWebPropertyAdWordsLinksListCall) MaxResults(maxResults int64) *ManagementWebPropertyAdWordsLinksListCall {
- c.opt_["max-results"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "start-index": An index of the
-// first webProperty-AdWords link to retrieve. Use this parameter as a
-// pagination mechanism along with the max-results parameter.
-func (c *ManagementWebPropertyAdWordsLinksListCall) StartIndex(startIndex int64) *ManagementWebPropertyAdWordsLinksListCall {
- c.opt_["start-index"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementWebPropertyAdWordsLinksListCall) Fields(s ...googleapi.Field) *ManagementWebPropertyAdWordsLinksListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementWebPropertyAdWordsLinksListCall) IfNoneMatch(entityTag string) *ManagementWebPropertyAdWordsLinksListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementWebPropertyAdWordsLinksListCall) Context(ctx context.Context) *ManagementWebPropertyAdWordsLinksListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementWebPropertyAdWordsLinksListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["max-results"]; ok {
- params.Set("max-results", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["start-index"]; ok {
- params.Set("start-index", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.webPropertyAdWordsLinks.list" call.
-// Exactly one of *EntityAdWordsLinks or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *EntityAdWordsLinks.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementWebPropertyAdWordsLinksListCall) Do() (*EntityAdWordsLinks, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EntityAdWordsLinks{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists webProperty-AdWords links for a given web property.",
- // "httpMethod": "GET",
- // "id": "analytics.management.webPropertyAdWordsLinks.list",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "ID of the account which the given web property belongs to.",
- // "location": "path",
- // "pattern": "\\d+",
- // "required": true,
- // "type": "string"
- // },
- // "max-results": {
- // "description": "The maximum number of webProperty-AdWords links to include in this response.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "start-index": {
- // "description": "An index of the first webProperty-AdWords link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "webPropertyId": {
- // "description": "Web property ID to retrieve the AdWords links for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks",
- // "response": {
- // "$ref": "EntityAdWordsLinks"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.webPropertyAdWordsLinks.patch":
-
-type ManagementWebPropertyAdWordsLinksPatchCall struct {
- s *Service
- accountId string
- webPropertyId string
- webPropertyAdWordsLinkId string
- entityadwordslink *EntityAdWordsLink
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing webProperty-AdWords link. This method
-// supports patch semantics.
-func (r *ManagementWebPropertyAdWordsLinksService) Patch(accountId string, webPropertyId string, webPropertyAdWordsLinkId string, entityadwordslink *EntityAdWordsLink) *ManagementWebPropertyAdWordsLinksPatchCall {
- c := &ManagementWebPropertyAdWordsLinksPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.webPropertyAdWordsLinkId = webPropertyAdWordsLinkId
- c.entityadwordslink = entityadwordslink
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementWebPropertyAdWordsLinksPatchCall) Fields(s ...googleapi.Field) *ManagementWebPropertyAdWordsLinksPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementWebPropertyAdWordsLinksPatchCall) Context(ctx context.Context) *ManagementWebPropertyAdWordsLinksPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementWebPropertyAdWordsLinksPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.entityadwordslink)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "webPropertyAdWordsLinkId": c.webPropertyAdWordsLinkId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.webPropertyAdWordsLinks.patch" call.
-// Exactly one of *EntityAdWordsLink or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *EntityAdWordsLink.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementWebPropertyAdWordsLinksPatchCall) Do() (*EntityAdWordsLink, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EntityAdWordsLink{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing webProperty-AdWords link. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "analytics.management.webPropertyAdWordsLinks.patch",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "webPropertyAdWordsLinkId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "ID of the account which the given web property belongs to.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyAdWordsLinkId": {
- // "description": "Web property-AdWords link ID.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property ID to retrieve the AdWords link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}",
- // "request": {
- // "$ref": "EntityAdWordsLink"
- // },
- // "response": {
- // "$ref": "EntityAdWordsLink"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.webPropertyAdWordsLinks.update":
-
-type ManagementWebPropertyAdWordsLinksUpdateCall struct {
- s *Service
- accountId string
- webPropertyId string
- webPropertyAdWordsLinkId string
- entityadwordslink *EntityAdWordsLink
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing webProperty-AdWords link.
-func (r *ManagementWebPropertyAdWordsLinksService) Update(accountId string, webPropertyId string, webPropertyAdWordsLinkId string, entityadwordslink *EntityAdWordsLink) *ManagementWebPropertyAdWordsLinksUpdateCall {
- c := &ManagementWebPropertyAdWordsLinksUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.webPropertyAdWordsLinkId = webPropertyAdWordsLinkId
- c.entityadwordslink = entityadwordslink
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementWebPropertyAdWordsLinksUpdateCall) Fields(s ...googleapi.Field) *ManagementWebPropertyAdWordsLinksUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementWebPropertyAdWordsLinksUpdateCall) Context(ctx context.Context) *ManagementWebPropertyAdWordsLinksUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementWebPropertyAdWordsLinksUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.entityadwordslink)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "webPropertyAdWordsLinkId": c.webPropertyAdWordsLinkId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.webPropertyAdWordsLinks.update" call.
-// Exactly one of *EntityAdWordsLink or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *EntityAdWordsLink.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementWebPropertyAdWordsLinksUpdateCall) Do() (*EntityAdWordsLink, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EntityAdWordsLink{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing webProperty-AdWords link.",
- // "httpMethod": "PUT",
- // "id": "analytics.management.webPropertyAdWordsLinks.update",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "webPropertyAdWordsLinkId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "ID of the account which the given web property belongs to.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyAdWordsLinkId": {
- // "description": "Web property-AdWords link ID.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property ID to retrieve the AdWords link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}",
- // "request": {
- // "$ref": "EntityAdWordsLink"
- // },
- // "response": {
- // "$ref": "EntityAdWordsLink"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.webproperties.get":
-
-type ManagementWebpropertiesGetCall struct {
- s *Service
- accountId string
- webPropertyId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets a web property to which the user has access.
-func (r *ManagementWebpropertiesService) Get(accountId string, webPropertyId string) *ManagementWebpropertiesGetCall {
- c := &ManagementWebpropertiesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementWebpropertiesGetCall) Fields(s ...googleapi.Field) *ManagementWebpropertiesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementWebpropertiesGetCall) IfNoneMatch(entityTag string) *ManagementWebpropertiesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementWebpropertiesGetCall) Context(ctx context.Context) *ManagementWebpropertiesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementWebpropertiesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.webproperties.get" call.
-// Exactly one of *Webproperty or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Webproperty.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ManagementWebpropertiesGetCall) Do() (*Webproperty, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Webproperty{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets a web property to which the user has access.",
- // "httpMethod": "GET",
- // "id": "analytics.management.webproperties.get",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to retrieve the web property for.",
- // "location": "path",
- // "pattern": "[0-9]+",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "ID to retrieve the web property for.",
- // "location": "path",
- // "pattern": "UA-[0-9]+-[0-9]+",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}",
- // "response": {
- // "$ref": "Webproperty"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.webproperties.insert":
-
-type ManagementWebpropertiesInsertCall struct {
- s *Service
- accountId string
- webproperty *Webproperty
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Create a new property if the account has fewer than 20
-// properties. Web properties are visible in the Google Analytics
-// interface only if they have at least one profile.
-func (r *ManagementWebpropertiesService) Insert(accountId string, webproperty *Webproperty) *ManagementWebpropertiesInsertCall {
- c := &ManagementWebpropertiesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webproperty = webproperty
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementWebpropertiesInsertCall) Fields(s ...googleapi.Field) *ManagementWebpropertiesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementWebpropertiesInsertCall) Context(ctx context.Context) *ManagementWebpropertiesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementWebpropertiesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.webproperty)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.webproperties.insert" call.
-// Exactly one of *Webproperty or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Webproperty.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ManagementWebpropertiesInsertCall) Do() (*Webproperty, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Webproperty{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Create a new property if the account has fewer than 20 properties. Web properties are visible in the Google Analytics interface only if they have at least one profile.",
- // "httpMethod": "POST",
- // "id": "analytics.management.webproperties.insert",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to create the web property for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties",
- // "request": {
- // "$ref": "Webproperty"
- // },
- // "response": {
- // "$ref": "Webproperty"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.webproperties.list":
-
-type ManagementWebpropertiesListCall struct {
- s *Service
- accountId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists web properties to which the user has access.
-func (r *ManagementWebpropertiesService) List(accountId string) *ManagementWebpropertiesListCall {
- c := &ManagementWebpropertiesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- return c
-}
-
-// MaxResults sets the optional parameter "max-results": The maximum
-// number of web properties to include in this response.
-func (c *ManagementWebpropertiesListCall) MaxResults(maxResults int64) *ManagementWebpropertiesListCall {
- c.opt_["max-results"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "start-index": An index of the
-// first entity to retrieve. Use this parameter as a pagination
-// mechanism along with the max-results parameter.
-func (c *ManagementWebpropertiesListCall) StartIndex(startIndex int64) *ManagementWebpropertiesListCall {
- c.opt_["start-index"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementWebpropertiesListCall) Fields(s ...googleapi.Field) *ManagementWebpropertiesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementWebpropertiesListCall) IfNoneMatch(entityTag string) *ManagementWebpropertiesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementWebpropertiesListCall) Context(ctx context.Context) *ManagementWebpropertiesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementWebpropertiesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["max-results"]; ok {
- params.Set("max-results", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["start-index"]; ok {
- params.Set("start-index", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.webproperties.list" call.
-// Exactly one of *Webproperties or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Webproperties.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementWebpropertiesListCall) Do() (*Webproperties, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Webproperties{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists web properties to which the user has access.",
- // "httpMethod": "GET",
- // "id": "analytics.management.webproperties.list",
- // "parameterOrder": [
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "max-results": {
- // "description": "The maximum number of web properties to include in this response.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "start-index": {
- // "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties",
- // "response": {
- // "$ref": "Webproperties"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.edit",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.webproperties.patch":
-
-type ManagementWebpropertiesPatchCall struct {
- s *Service
- accountId string
- webPropertyId string
- webproperty *Webproperty
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing web property. This method supports patch
-// semantics.
-func (r *ManagementWebpropertiesService) Patch(accountId string, webPropertyId string, webproperty *Webproperty) *ManagementWebpropertiesPatchCall {
- c := &ManagementWebpropertiesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.webproperty = webproperty
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementWebpropertiesPatchCall) Fields(s ...googleapi.Field) *ManagementWebpropertiesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementWebpropertiesPatchCall) Context(ctx context.Context) *ManagementWebpropertiesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementWebpropertiesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.webproperty)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.webproperties.patch" call.
-// Exactly one of *Webproperty or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Webproperty.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ManagementWebpropertiesPatchCall) Do() (*Webproperty, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Webproperty{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing web property. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "analytics.management.webproperties.patch",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to which the web property belongs",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property ID",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}",
- // "request": {
- // "$ref": "Webproperty"
- // },
- // "response": {
- // "$ref": "Webproperty"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.webproperties.update":
-
-type ManagementWebpropertiesUpdateCall struct {
- s *Service
- accountId string
- webPropertyId string
- webproperty *Webproperty
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing web property.
-func (r *ManagementWebpropertiesService) Update(accountId string, webPropertyId string, webproperty *Webproperty) *ManagementWebpropertiesUpdateCall {
- c := &ManagementWebpropertiesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.webproperty = webproperty
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementWebpropertiesUpdateCall) Fields(s ...googleapi.Field) *ManagementWebpropertiesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementWebpropertiesUpdateCall) Context(ctx context.Context) *ManagementWebpropertiesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementWebpropertiesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.webproperty)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.webproperties.update" call.
-// Exactly one of *Webproperty or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Webproperty.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ManagementWebpropertiesUpdateCall) Do() (*Webproperty, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Webproperty{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing web property.",
- // "httpMethod": "PUT",
- // "id": "analytics.management.webproperties.update",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to which the web property belongs",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property ID",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}",
- // "request": {
- // "$ref": "Webproperty"
- // },
- // "response": {
- // "$ref": "Webproperty"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.edit"
- // ]
- // }
-
-}
-
-// method id "analytics.management.webpropertyUserLinks.delete":
-
-type ManagementWebpropertyUserLinksDeleteCall struct {
- s *Service
- accountId string
- webPropertyId string
- linkId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Removes a user from the given web property.
-func (r *ManagementWebpropertyUserLinksService) Delete(accountId string, webPropertyId string, linkId string) *ManagementWebpropertyUserLinksDeleteCall {
- c := &ManagementWebpropertyUserLinksDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.linkId = linkId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementWebpropertyUserLinksDeleteCall) Fields(s ...googleapi.Field) *ManagementWebpropertyUserLinksDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementWebpropertyUserLinksDeleteCall) Context(ctx context.Context) *ManagementWebpropertyUserLinksDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementWebpropertyUserLinksDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "linkId": c.linkId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.webpropertyUserLinks.delete" call.
-func (c *ManagementWebpropertyUserLinksDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Removes a user from the given web property.",
- // "httpMethod": "DELETE",
- // "id": "analytics.management.webpropertyUserLinks.delete",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "linkId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to delete the user link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "linkId": {
- // "description": "Link ID to delete the user link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web Property ID to delete the user link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.manage.users"
- // ]
- // }
-
-}
-
-// method id "analytics.management.webpropertyUserLinks.insert":
-
-type ManagementWebpropertyUserLinksInsertCall struct {
- s *Service
- accountId string
- webPropertyId string
- entityuserlink *EntityUserLink
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Adds a new user to the given web property.
-func (r *ManagementWebpropertyUserLinksService) Insert(accountId string, webPropertyId string, entityuserlink *EntityUserLink) *ManagementWebpropertyUserLinksInsertCall {
- c := &ManagementWebpropertyUserLinksInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.entityuserlink = entityuserlink
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementWebpropertyUserLinksInsertCall) Fields(s ...googleapi.Field) *ManagementWebpropertyUserLinksInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementWebpropertyUserLinksInsertCall) Context(ctx context.Context) *ManagementWebpropertyUserLinksInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementWebpropertyUserLinksInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.entityuserlink)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.webpropertyUserLinks.insert" call.
-// Exactly one of *EntityUserLink or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *EntityUserLink.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementWebpropertyUserLinksInsertCall) Do() (*EntityUserLink, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EntityUserLink{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Adds a new user to the given web property.",
- // "httpMethod": "POST",
- // "id": "analytics.management.webpropertyUserLinks.insert",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to create the user link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web Property ID to create the user link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks",
- // "request": {
- // "$ref": "EntityUserLink"
- // },
- // "response": {
- // "$ref": "EntityUserLink"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.manage.users"
- // ]
- // }
-
-}
-
-// method id "analytics.management.webpropertyUserLinks.list":
-
-type ManagementWebpropertyUserLinksListCall struct {
- s *Service
- accountId string
- webPropertyId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists webProperty-user links for a given web property.
-func (r *ManagementWebpropertyUserLinksService) List(accountId string, webPropertyId string) *ManagementWebpropertyUserLinksListCall {
- c := &ManagementWebpropertyUserLinksListCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- return c
-}
-
-// MaxResults sets the optional parameter "max-results": The maximum
-// number of webProperty-user Links to include in this response.
-func (c *ManagementWebpropertyUserLinksListCall) MaxResults(maxResults int64) *ManagementWebpropertyUserLinksListCall {
- c.opt_["max-results"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "start-index": An index of the
-// first webProperty-user link to retrieve. Use this parameter as a
-// pagination mechanism along with the max-results parameter.
-func (c *ManagementWebpropertyUserLinksListCall) StartIndex(startIndex int64) *ManagementWebpropertyUserLinksListCall {
- c.opt_["start-index"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementWebpropertyUserLinksListCall) Fields(s ...googleapi.Field) *ManagementWebpropertyUserLinksListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManagementWebpropertyUserLinksListCall) IfNoneMatch(entityTag string) *ManagementWebpropertyUserLinksListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementWebpropertyUserLinksListCall) Context(ctx context.Context) *ManagementWebpropertyUserLinksListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementWebpropertyUserLinksListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["max-results"]; ok {
- params.Set("max-results", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["start-index"]; ok {
- params.Set("start-index", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.webpropertyUserLinks.list" call.
-// Exactly one of *EntityUserLinks or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *EntityUserLinks.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementWebpropertyUserLinksListCall) Do() (*EntityUserLinks, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EntityUserLinks{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists webProperty-user links for a given web property.",
- // "httpMethod": "GET",
- // "id": "analytics.management.webpropertyUserLinks.list",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID which the given web property belongs to.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "max-results": {
- // "description": "The maximum number of webProperty-user Links to include in this response.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "start-index": {
- // "description": "An index of the first webProperty-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "webPropertyId": {
- // "description": "Web Property ID for the webProperty-user links to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks",
- // "response": {
- // "$ref": "EntityUserLinks"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.manage.users",
- // "https://www.googleapis.com/auth/analytics.manage.users.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.management.webpropertyUserLinks.update":
-
-type ManagementWebpropertyUserLinksUpdateCall struct {
- s *Service
- accountId string
- webPropertyId string
- linkId string
- entityuserlink *EntityUserLink
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates permissions for an existing user on the given web
-// property.
-func (r *ManagementWebpropertyUserLinksService) Update(accountId string, webPropertyId string, linkId string, entityuserlink *EntityUserLink) *ManagementWebpropertyUserLinksUpdateCall {
- c := &ManagementWebpropertyUserLinksUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountId = accountId
- c.webPropertyId = webPropertyId
- c.linkId = linkId
- c.entityuserlink = entityuserlink
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManagementWebpropertyUserLinksUpdateCall) Fields(s ...googleapi.Field) *ManagementWebpropertyUserLinksUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManagementWebpropertyUserLinksUpdateCall) Context(ctx context.Context) *ManagementWebpropertyUserLinksUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManagementWebpropertyUserLinksUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.entityuserlink)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "accountId": c.accountId,
- "webPropertyId": c.webPropertyId,
- "linkId": c.linkId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.management.webpropertyUserLinks.update" call.
-// Exactly one of *EntityUserLink or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *EntityUserLink.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManagementWebpropertyUserLinksUpdateCall) Do() (*EntityUserLink, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EntityUserLink{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates permissions for an existing user on the given web property.",
- // "httpMethod": "PUT",
- // "id": "analytics.management.webpropertyUserLinks.update",
- // "parameterOrder": [
- // "accountId",
- // "webPropertyId",
- // "linkId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "Account ID to update the account-user link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "linkId": {
- // "description": "Link ID to update the account-user link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "webPropertyId": {
- // "description": "Web property ID to update the account-user link for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}",
- // "request": {
- // "$ref": "EntityUserLink"
- // },
- // "response": {
- // "$ref": "EntityUserLink"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.manage.users"
- // ]
- // }
-
-}
-
-// method id "analytics.metadata.columns.list":
-
-type MetadataColumnsListCall struct {
- s *Service
- reportType string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all columns for a report type
-func (r *MetadataColumnsService) List(reportType string) *MetadataColumnsListCall {
- c := &MetadataColumnsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.reportType = reportType
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MetadataColumnsListCall) Fields(s ...googleapi.Field) *MetadataColumnsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MetadataColumnsListCall) IfNoneMatch(entityTag string) *MetadataColumnsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MetadataColumnsListCall) Context(ctx context.Context) *MetadataColumnsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MetadataColumnsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "metadata/{reportType}/columns")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "reportType": c.reportType,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.metadata.columns.list" call.
-// Exactly one of *Columns or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Columns.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *MetadataColumnsListCall) Do() (*Columns, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Columns{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all columns for a report type",
- // "httpMethod": "GET",
- // "id": "analytics.metadata.columns.list",
- // "parameterOrder": [
- // "reportType"
- // ],
- // "parameters": {
- // "reportType": {
- // "description": "Report type. Allowed Values: 'ga'. Where 'ga' corresponds to the Core Reporting API",
- // "location": "path",
- // "pattern": "ga",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "metadata/{reportType}/columns",
- // "response": {
- // "$ref": "Columns"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics",
- // "https://www.googleapis.com/auth/analytics.edit",
- // "https://www.googleapis.com/auth/analytics.readonly"
- // ]
- // }
-
-}
-
-// method id "analytics.provisioning.createAccountTicket":
-
-type ProvisioningCreateAccountTicketCall struct {
- s *Service
- accountticket *AccountTicket
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// CreateAccountTicket: Creates an account ticket.
-func (r *ProvisioningService) CreateAccountTicket(accountticket *AccountTicket) *ProvisioningCreateAccountTicketCall {
- c := &ProvisioningCreateAccountTicketCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountticket = accountticket
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProvisioningCreateAccountTicketCall) Fields(s ...googleapi.Field) *ProvisioningCreateAccountTicketCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProvisioningCreateAccountTicketCall) Context(ctx context.Context) *ProvisioningCreateAccountTicketCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProvisioningCreateAccountTicketCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.accountticket)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "provisioning/createAccountTicket")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "analytics.provisioning.createAccountTicket" call.
-// Exactly one of *AccountTicket or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AccountTicket.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ProvisioningCreateAccountTicketCall) Do() (*AccountTicket, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountTicket{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates an account ticket.",
- // "httpMethod": "POST",
- // "id": "analytics.provisioning.createAccountTicket",
- // "path": "provisioning/createAccountTicket",
- // "request": {
- // "$ref": "AccountTicket"
- // },
- // "response": {
- // "$ref": "AccountTicket"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/analytics.provision"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/androidenterprise/v1/androidenterprise-api.json b/vendor/google.golang.org/api/androidenterprise/v1/androidenterprise-api.json
deleted file mode 100644
index 21eb8506..00000000
--- a/vendor/google.golang.org/api/androidenterprise/v1/androidenterprise-api.json
+++ /dev/null
@@ -1,2415 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/k50i1jH6d5mxm7o5MPctHqUGfAg\"",
- "discoveryVersion": "v1",
- "id": "androidenterprise:v1",
- "name": "androidenterprise",
- "canonicalName": "Android Enterprise",
- "version": "v1",
- "revision": "20150910",
- "title": "Google Play EMM API",
- "description": "Allows MDMs/EMMs and enterprises to manage the deployment of apps to Android for Work users.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/android-16.png",
- "x32": "https://www.google.com/images/icons/product/android-32.png"
- },
- "documentationLink": "https://developers.google.com/play/enterprise",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/androidenterprise/v1/",
- "basePath": "/androidenterprise/v1/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "androidenterprise/v1/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/androidenterprise": {
- "description": "Manage corporate Android devices"
- }
- }
- }
- },
- "schemas": {
- "AppRestrictionsSchema": {
- "id": "AppRestrictionsSchema",
- "type": "object",
- "description": "Represents the list of app restrictions available to be pre-configured for the product.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#appRestrictionsSchema\".",
- "default": "androidenterprise#appRestrictionsSchema"
- },
- "restrictions": {
- "type": "array",
- "description": "The set of restrictions that make up this schema.",
- "items": {
- "$ref": "AppRestrictionsSchemaRestriction"
- }
- }
- }
- },
- "AppRestrictionsSchemaRestriction": {
- "id": "AppRestrictionsSchemaRestriction",
- "type": "object",
- "description": "A restriction in the App Restriction Schema represents a piece of configuration that may be pre-applied.",
- "properties": {
- "defaultValue": {
- "$ref": "AppRestrictionsSchemaRestrictionRestrictionValue",
- "description": "The default value of the restriction."
- },
- "description": {
- "type": "string",
- "description": "A longer description of the restriction, giving more detail of what it affects."
- },
- "entry": {
- "type": "array",
- "description": "For choice or multiselect restrictions, the list of possible entries' human-readable names.",
- "items": {
- "type": "string"
- }
- },
- "entryValue": {
- "type": "array",
- "description": "For choice or multiselect restrictions, the list of possible entries' machine-readable values.",
- "items": {
- "type": "string"
- }
- },
- "key": {
- "type": "string",
- "description": "The unique key that the product uses to identify the restriction, e.g. \"com.google.android.gm.fieldname\"."
- },
- "restrictionType": {
- "type": "string",
- "description": "The type of the restriction."
- },
- "title": {
- "type": "string",
- "description": "The name of the restriction."
- }
- }
- },
- "AppRestrictionsSchemaRestrictionRestrictionValue": {
- "id": "AppRestrictionsSchemaRestrictionRestrictionValue",
- "type": "object",
- "description": "A typed value for the restriction.",
- "properties": {
- "type": {
- "type": "string",
- "description": "The type of the value being provided."
- },
- "valueBool": {
- "type": "boolean",
- "description": "The boolean value - this will only be present if type is bool."
- },
- "valueInteger": {
- "type": "integer",
- "description": "The integer value - this will only be present if type is integer.",
- "format": "int32"
- },
- "valueMultiselect": {
- "type": "array",
- "description": "The list of string values - this will only be present if type is multiselect.",
- "items": {
- "type": "string"
- }
- },
- "valueString": {
- "type": "string",
- "description": "The string value - this will be present for types string, choice and hidden."
- }
- }
- },
- "AppVersion": {
- "id": "AppVersion",
- "type": "object",
- "description": "This represents a single version of the app.",
- "properties": {
- "versionCode": {
- "type": "integer",
- "description": "Unique increasing identifier for the app version.",
- "format": "int32"
- },
- "versionString": {
- "type": "string",
- "description": "The string used in the Play Store by the app developer to identify the version. The string is not necessarily unique or localized (for example, the string could be \"1.4\")."
- }
- }
- },
- "ApprovalUrlInfo": {
- "id": "ApprovalUrlInfo",
- "type": "object",
- "description": "Information on an approval URL.",
- "properties": {
- "approvalUrl": {
- "type": "string",
- "description": "A URL that displays a product's permissions and that can also be used to approve the product with the Products.approve call."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#approvalUrlInfo\".",
- "default": "androidenterprise#approvalUrlInfo"
- }
- }
- },
- "Collection": {
- "id": "Collection",
- "type": "object",
- "description": "A collection resource defines a named set of apps that is visible to a set of users in the Google Play Store app running on those users' managed devices. Those users can then install any of those apps if they wish (which will trigger creation of install and entitlement resources). A user cannot install an app on a managed device unless the app is listed in at least one collection that is visible to that user.\n\nNote that the API can be used to directly install an app regardless of whether it is in any collection - so an enterprise has a choice of either directly pushing apps to users, or allowing users to install apps if they want. Which is appropriate will depend on the enterprise's policies and the purpose of the apps concerned.",
- "properties": {
- "collectionId": {
- "type": "string",
- "description": "Arbitrary unique ID, allocated by the API on creation."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#collection\".",
- "default": "androidenterprise#collection"
- },
- "name": {
- "type": "string",
- "description": "A user-friendly name for the collection (should be unique), e.g. \"Accounting apps\".",
- "annotations": {
- "required": [
- "androidenterprise.collections.insert",
- "androidenterprise.collections.update"
- ]
- }
- },
- "productId": {
- "type": "array",
- "description": "The IDs of the products in the collection, in the order in which they should be displayed.",
- "items": {
- "type": "string"
- },
- "annotations": {
- "required": [
- "androidenterprise.collections.insert",
- "androidenterprise.collections.update"
- ]
- }
- },
- "visibility": {
- "type": "string",
- "description": "Whether this collection is visible to all users, or only to the users that have been granted access through the \"Collectionviewers\" API. With the launch of the \"setAvailableProductSet\" API, this property should always be set to \"viewersOnly\", as the \"allUsers\" option will bypass the \"availableProductSet\" for all users within a domain.\n\nThe \"allUsers\" setting is deprecated, and will be removed."
- }
- }
- },
- "CollectionViewersListResponse": {
- "id": "CollectionViewersListResponse",
- "type": "object",
- "description": "The user resources for the collection.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#collectionViewersListResponse\".",
- "default": "androidenterprise#collectionViewersListResponse"
- },
- "user": {
- "type": "array",
- "description": "A user of an enterprise.",
- "items": {
- "$ref": "User"
- }
- }
- }
- },
- "CollectionsListResponse": {
- "id": "CollectionsListResponse",
- "type": "object",
- "description": "The collection resources for the enterprise.",
- "properties": {
- "collection": {
- "type": "array",
- "description": "An ordered collection of products which can be made visible on the Google Play Store to a selected group of users.",
- "items": {
- "$ref": "Collection"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#collectionsListResponse\".",
- "default": "androidenterprise#collectionsListResponse"
- }
- }
- },
- "Device": {
- "id": "Device",
- "type": "object",
- "description": "A device resource represents a mobile device managed by the MDM and belonging to a specific enterprise user.\n\nThis collection cannot be modified via the API; it is automatically populated as devices are set up to be managed.",
- "properties": {
- "androidId": {
- "type": "string",
- "description": "The Google Play Services Android ID for the device encoded as a lowercase hex string, e.g. \"123456789abcdef0\"."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#device\".",
- "default": "androidenterprise#device"
- },
- "managementType": {
- "type": "string",
- "description": "The mechanism by which this device is managed by the MDM. \"managedDevice\" means that the MDM's app is a device owner. \"managedProfile\" means that the MDM's app is the profile owner (and there is a separate personal profile which is not managed). \"containerApp\" means that the MDM's app is managing the Android for Work container app on the device."
- }
- }
- },
- "DeviceState": {
- "id": "DeviceState",
- "type": "object",
- "description": "The state of a user's device, as accessed by the getState and setState methods on device resources.",
- "properties": {
- "accountState": {
- "type": "string",
- "description": "The state of the Google account on the device. \"enabled\" indicates that the Google account on the device can be used to access Google services (including Google Play), while \"disabled\" means that it cannot. A new device is initially in the \"disabled\" state."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#deviceState\".",
- "default": "androidenterprise#deviceState"
- }
- }
- },
- "DevicesListResponse": {
- "id": "DevicesListResponse",
- "type": "object",
- "description": "The device resources for the user.",
- "properties": {
- "device": {
- "type": "array",
- "description": "A managed device.",
- "items": {
- "$ref": "Device"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#devicesListResponse\".",
- "default": "androidenterprise#devicesListResponse"
- }
- }
- },
- "Enterprise": {
- "id": "Enterprise",
- "type": "object",
- "description": "An enterprise resource represents a binding between an organisation and their MDM.\n\nTo create an enterprise, an admin of the enterprise must first go through a Play for Work sign-up flow. At the end of this the admin will be presented with a token (a short opaque alphanumeric string). They must then present this to the MDM, who then supplies it to the enroll method. Until this is done the MDM will not have any access to the enterprise.\n\nAfter calling enroll the MDM should call setAccount to specify the service account that will be allowed to act on behalf of the enterprise, which will be required for access to the enterprise's data through this API. Only one call of setAccount is allowed for a given enterprise; the only way to change the account later is to unenroll the enterprise and enroll it again (obtaining a new token).\n\nThe MDM can unenroll an enterprise in order to sever the binding between them. Re-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the MDM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) Enterprises.insert call must be unenrolled with Enterprises.delete and can then be re-enrolled using the Enterprises.enroll call.\n\nThe ID for an enterprise is an opaque string. It is returned by insert and enroll and can also be retrieved if the enterprise's primary domain is known using the list method.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The unique ID for the enterprise."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#enterprise\".",
- "default": "androidenterprise#enterprise"
- },
- "name": {
- "type": "string",
- "description": "The name of the enterprise, e.g. \"Example Inc\"."
- },
- "primaryDomain": {
- "type": "string",
- "description": "The enterprise's primary domain, e.g. \"example.com\".",
- "annotations": {
- "required": [
- "androidenterprise.enterprises.insert"
- ]
- }
- }
- }
- },
- "EnterpriseAccount": {
- "id": "EnterpriseAccount",
- "type": "object",
- "description": "A service account that can be used to authenticate as the enterprise to API calls that require such authentication.",
- "properties": {
- "accountEmail": {
- "type": "string",
- "description": "The email address of the service account."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#enterpriseAccount\".",
- "default": "androidenterprise#enterpriseAccount"
- }
- }
- },
- "EnterprisesListResponse": {
- "id": "EnterprisesListResponse",
- "type": "object",
- "description": "The matching enterprise resources.",
- "properties": {
- "enterprise": {
- "type": "array",
- "description": "An enterprise.",
- "items": {
- "$ref": "Enterprise"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#enterprisesListResponse\".",
- "default": "androidenterprise#enterprisesListResponse"
- }
- }
- },
- "EnterprisesSendTestPushNotificationResponse": {
- "id": "EnterprisesSendTestPushNotificationResponse",
- "type": "object",
- "properties": {
- "messageId": {
- "type": "string",
- "description": "The message ID of the test push notification that was sent."
- },
- "topicName": {
- "type": "string",
- "description": "The name of the Cloud Pub/Sub topic to which notifications for this enterprise's enrolled account will be sent."
- }
- }
- },
- "Entitlement": {
- "id": "Entitlement",
- "type": "object",
- "description": "The existence of an entitlement resource means that a user has the right to use a particular app on any of their devices. This might be because the app is free or because they have been allocated a license to the app from a group license purchased by the enterprise.\n\nIt should always be true that a user has an app installed on one of their devices only if they have an entitlement to it. So if an entitlement is deleted, the app will be uninstalled from all devices. Similarly if the user installs an app (and is permitted to do so), or the MDM triggers an install of the app, an entitlement to that app is automatically created. If this is impossible - e.g. the enterprise has not purchased sufficient licenses - then installation fails.\n\nNote that entitlements are always user specific, not device specific; a user may have an entitlement even though they have not installed the app anywhere. Once they have an entitlement they can install the app on multiple devices.\n\nThe API can be used to create an entitlement. If the app is a free app, a group license for that app is created. If it's a paid app, creating the entitlement consumes one license; it remains consumed until the entitlement is removed. Optionally an installation of the app on all the user's managed devices can be triggered at the time the entitlement is created. An entitlement cannot be created for an app if the app requires permissions that the enterprise has not yet accepted.\n\nEntitlements for paid apps that are due to purchases by the user on a non-managed profile will have \"userPurchase\" as entitlement reason; those entitlements cannot be removed via the API.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#entitlement\".",
- "default": "androidenterprise#entitlement"
- },
- "productId": {
- "type": "string",
- "description": "The ID of the product that the entitlement is for, e.g. \"app:com.google.android.gm\"."
- },
- "reason": {
- "type": "string",
- "description": "The reason for the entitlement, e.g. \"free\" for free apps. This is temporary, it will be replaced by the acquisition kind field of group licenses."
- }
- }
- },
- "EntitlementsListResponse": {
- "id": "EntitlementsListResponse",
- "type": "object",
- "description": "The entitlement resources for the user.",
- "properties": {
- "entitlement": {
- "type": "array",
- "description": "An entitlement of a user to a product (e.g. an app). For example, a free app that they have installed, or a paid app that they have been allocated a license to.",
- "items": {
- "$ref": "Entitlement"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#entitlementsListResponse\".",
- "default": "androidenterprise#entitlementsListResponse"
- }
- }
- },
- "GroupLicense": {
- "id": "GroupLicense",
- "type": "object",
- "description": "A group license object indicates a product that an enterprise admin has approved for use in the enterprise. The product may be free or paid. For free products, a group license object is created in these cases: if the enterprise admin approves a product in Google Play, if the product is added to a collection, or if an entitlement for the product is created for a user via the API. For paid products, a group license object is only created as part of the first bulk purchase of that product in Google Play by the enterprise admin.\n\nThe API can be used to query group licenses; the available information includes the total number of licenses purchased (for paid products) and the total number of licenses that have been provisioned, that is, the total number of user entitlements in existence for the product.\n\nGroup license objects are never deleted. If, for example, a free app is added to a collection and then removed, the group license will remain, allowing the enterprise admin to keep track of any remaining entitlements. An enterprise admin may indicate they are no longer interested in the group license by marking it as unapproved in Google Play.",
- "properties": {
- "acquisitionKind": {
- "type": "string",
- "description": "How this group license was acquired. \"bulkPurchase\" means that this group license object was created because the enterprise purchased licenses for this product; this is \"free\" otherwise (for free products)."
- },
- "approval": {
- "type": "string",
- "description": "Whether the product to which this group license relates is currently approved by the enterprise, as either \"approved\" or \"unapproved\". Products are approved when a group license is first created, but this approval may be revoked by an enterprise admin via Google Play. Unapproved products will not be visible to end users in collections and new entitlements to them should not normally be created."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#groupLicense\".",
- "default": "androidenterprise#groupLicense"
- },
- "numProvisioned": {
- "type": "integer",
- "description": "The total number of provisioned licenses for this product. Returned by read operations, but ignored in write operations.",
- "format": "int32"
- },
- "numPurchased": {
- "type": "integer",
- "description": "The number of purchased licenses (possibly in multiple purchases). If this field is omitted then there is no limit on the number of licenses that can be provisioned (e.g. if the acquisition kind is \"free\").",
- "format": "int32"
- },
- "productId": {
- "type": "string",
- "description": "The ID of the product that the license is for, e.g. \"app:com.google.android.gm\"."
- }
- }
- },
- "GroupLicenseUsersListResponse": {
- "id": "GroupLicenseUsersListResponse",
- "type": "object",
- "description": "The user resources for the group license.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#groupLicenseUsersListResponse\".",
- "default": "androidenterprise#groupLicenseUsersListResponse"
- },
- "user": {
- "type": "array",
- "description": "A user of an enterprise.",
- "items": {
- "$ref": "User"
- }
- }
- }
- },
- "GroupLicensesListResponse": {
- "id": "GroupLicensesListResponse",
- "type": "object",
- "description": "The grouplicense resources for the enterprise.",
- "properties": {
- "groupLicense": {
- "type": "array",
- "description": "A group license for a product approved for use in the enterprise.",
- "items": {
- "$ref": "GroupLicense"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#groupLicensesListResponse\".",
- "default": "androidenterprise#groupLicensesListResponse"
- }
- }
- },
- "Install": {
- "id": "Install",
- "type": "object",
- "description": "The existence of an install resource indicates that an app is installed on a particular device (or that an install is pending).\n\nThe API can be used to create an install resource using the update method. This triggers the actual install of the app on the device. If the user does not already have an entitlement for the app then an attempt is made to create one. If this fails (e.g. because the app is not free and there is no available license) then the creation of the install fails.\n\nThe API can also be used to update an installed app. If the update method is used on an existing install then the app will be updated to the latest available version.\n\nNote that it is not possible to force the installation of a specific version of an app; the version code is read-only.\n\nIf a user installs an app themselves (as permitted by the enterprise), then again an install resource and possibly an entitlement resource are automatically created.\n\nThe API can also be used to delete an install resource, which triggers the removal of the app from the device. Note that deleting an install does not automatically remove the corresponding entitlement, even if there are no remaining installs. The install resource will also be deleted if the user uninstalls the app themselves.",
- "properties": {
- "installState": {
- "type": "string",
- "description": "Install state. The state \"installPending\" means that an install request has recently been made and download to the device is in progress. The state \"installed\" means that the app has been installed. This field is read-only."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#install\".",
- "default": "androidenterprise#install"
- },
- "productId": {
- "type": "string",
- "description": "The ID of the product that the install is for, e.g. \"app:com.google.android.gm\"."
- },
- "versionCode": {
- "type": "integer",
- "description": "The version of the installed product. Guaranteed to be set only if the install state is \"installed\".",
- "format": "int32"
- }
- }
- },
- "InstallsListResponse": {
- "id": "InstallsListResponse",
- "type": "object",
- "description": "The install resources for the device.",
- "properties": {
- "install": {
- "type": "array",
- "description": "An installation of an app for a user on a specific device. The existence of an install implies that the user must have an entitlement to the app.",
- "items": {
- "$ref": "Install"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#installsListResponse\".",
- "default": "androidenterprise#installsListResponse"
- }
- }
- },
- "Permission": {
- "id": "Permission",
- "type": "object",
- "description": "A permission represents some extra capability, to be granted to an Android app, which requires explicit consent. An enterprise admin must consent to these permissions on behalf of their users before an entitlement for the app can be created.\n\nThe permissions collection is read-only. The information provided for each permission (localized name and description) is intended to be used in the MDM user interface when obtaining consent from the enterprise.",
- "properties": {
- "description": {
- "type": "string",
- "description": "A longer description of the permissions giving more details of what it affects."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#permission\".",
- "default": "androidenterprise#permission"
- },
- "name": {
- "type": "string",
- "description": "The name of the permission."
- },
- "permissionId": {
- "type": "string",
- "description": "An opaque string uniquely identifying the permission."
- }
- }
- },
- "Product": {
- "id": "Product",
- "type": "object",
- "description": "A product represents an app in the Google Play Store that is available to at least some users in the enterprise. (Some apps are restricted to a single enterprise, and no information about them is made available outside that enterprise.)\n\nThe information provided for each product (localized name, icon, link to the full Google Play details page) is intended to allow a basic representation of the product within an MDM user interface.",
- "properties": {
- "appVersion": {
- "type": "array",
- "description": "App versions currently available for this product. The returned list contains only public versions. Alpha and beta versions are not included.",
- "items": {
- "$ref": "AppVersion"
- }
- },
- "authorName": {
- "type": "string",
- "description": "The name of the author of the product (e.g. the app developer)."
- },
- "detailsUrl": {
- "type": "string",
- "description": "A link to the (consumer) Google Play details page for the product."
- },
- "distributionChannel": {
- "type": "string",
- "description": "How and to whom the package is made available. The value publicGoogleHosted means that the package is available through the Play Store and not restricted to a specific enterprise. The value privateGoogleHosted means that the package is a private app (restricted to an enterprise) but hosted by Google. The value privateSelfHosted means that the package is a private app (restricted to an enterprise) and is privately hosted."
- },
- "iconUrl": {
- "type": "string",
- "description": "A link to an image that can be used as an icon for the product."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#product\".",
- "default": "androidenterprise#product"
- },
- "productId": {
- "type": "string",
- "description": "A string of the form app:\u003cpackage name\u003e. For example, app:com.google.android.gm represents the Gmail app."
- },
- "requiresContainerApp": {
- "type": "boolean",
- "description": "Whether this app can only be installed on devices using the Android for Work container app."
- },
- "title": {
- "type": "string",
- "description": "The name of the product."
- },
- "workDetailsUrl": {
- "type": "string",
- "description": "A link to the Google Play for Work details page for the product, for use by an Enterprise administrator."
- }
- }
- },
- "ProductPermission": {
- "id": "ProductPermission",
- "type": "object",
- "description": "A product permissions resource represents the set of permissions required by a specific app and whether or not they have been accepted by an enterprise admin.\n\nThe API can be used to read the set of permissions, and also to update the set to indicate that permissions have been accepted.",
- "properties": {
- "permissionId": {
- "type": "string",
- "description": "An opaque string uniquely identifying the permission."
- },
- "state": {
- "type": "string",
- "description": "Whether the permission has been accepted or not."
- }
- }
- },
- "ProductPermissions": {
- "id": "ProductPermissions",
- "type": "object",
- "description": "Information about the permissions required by a specific app and whether they have been accepted by the enterprise.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#productPermissions\".",
- "default": "androidenterprise#productPermissions"
- },
- "permission": {
- "type": "array",
- "description": "The permissions required by the app.",
- "items": {
- "$ref": "ProductPermission"
- },
- "annotations": {
- "required": [
- "androidenterprise.products.updatePermissions"
- ]
- }
- },
- "productId": {
- "type": "string",
- "description": "The ID of the app that the permissions relate to, e.g. \"app:com.google.android.gm\"."
- }
- }
- },
- "ProductSet": {
- "id": "ProductSet",
- "type": "object",
- "description": "A set of products.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#productSet\".",
- "default": "androidenterprise#productSet"
- },
- "productId": {
- "type": "array",
- "description": "The list of product IDs making up the set of products.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "ProductsApproveRequest": {
- "id": "ProductsApproveRequest",
- "type": "object",
- "properties": {
- "approvalUrlInfo": {
- "$ref": "ApprovalUrlInfo",
- "description": "The approval URL that was shown to the user. Only the permissions shown to the user with that URL will be accepted, which may not be the product's entire set of permissions. For example, the URL may only display new permissions from an update after the product was approved, or not include new permissions if the product was updated since the URL was generated."
- }
- }
- },
- "ProductsGenerateApprovalUrlResponse": {
- "id": "ProductsGenerateApprovalUrlResponse",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "description": "A URL that can be rendered in an iframe to display the permissions (if any) of a product. This URL can be used to approve the product only once and only within 24 hours of being generated, using the Products.approve call. If the product is currently unapproved and has no permissions, this URL will point to an empty page. If the product is currently approved, a URL will only be generated if that product has added permissions since it was last approved, and the URL will only display those new permissions that have not yet been accepted."
- }
- }
- },
- "User": {
- "id": "User",
- "type": "object",
- "description": "A user resource represents an individual user within the enterprise's domain.\n\nNote that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API.\n\nThe ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The unique ID for the user."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#user\".",
- "default": "androidenterprise#user"
- },
- "primaryEmail": {
- "type": "string",
- "description": "The user's primary email, e.g. \"jsmith@example.com\"."
- }
- }
- },
- "UserToken": {
- "id": "UserToken",
- "type": "object",
- "description": "A UserToken is used by a user when setting up a managed device or profile with their work account on a device. When the user enters their email address and token (activation code) the appropriate MDM app can be automatically downloaded.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#userToken\".",
- "default": "androidenterprise#userToken"
- },
- "token": {
- "type": "string",
- "description": "The token (activation code) to be entered by the user. This consists of a sequence of decimal digits. Note that the leading digit may be 0."
- },
- "userId": {
- "type": "string",
- "description": "The unique ID for the user."
- }
- }
- },
- "UsersListResponse": {
- "id": "UsersListResponse",
- "type": "object",
- "description": "The matching user resources.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#usersListResponse\".",
- "default": "androidenterprise#usersListResponse"
- },
- "user": {
- "type": "array",
- "description": "A user of an enterprise.",
- "items": {
- "$ref": "User"
- }
- }
- }
- }
- },
- "resources": {
- "collections": {
- "methods": {
- "delete": {
- "id": "androidenterprise.collections.delete",
- "path": "enterprises/{enterpriseId}/collections/{collectionId}",
- "httpMethod": "DELETE",
- "description": "Deletes a collection.",
- "parameters": {
- "collectionId": {
- "type": "string",
- "description": "The ID of the collection.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "collectionId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "get": {
- "id": "androidenterprise.collections.get",
- "path": "enterprises/{enterpriseId}/collections/{collectionId}",
- "httpMethod": "GET",
- "description": "Retrieves the details of a collection.",
- "parameters": {
- "collectionId": {
- "type": "string",
- "description": "The ID of the collection.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "collectionId"
- ],
- "response": {
- "$ref": "Collection"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "insert": {
- "id": "androidenterprise.collections.insert",
- "path": "enterprises/{enterpriseId}/collections",
- "httpMethod": "POST",
- "description": "Creates a new collection.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId"
- ],
- "request": {
- "$ref": "Collection"
- },
- "response": {
- "$ref": "Collection"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "list": {
- "id": "androidenterprise.collections.list",
- "path": "enterprises/{enterpriseId}/collections",
- "httpMethod": "GET",
- "description": "Retrieves the IDs of all the collections for an enterprise.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId"
- ],
- "response": {
- "$ref": "CollectionsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "patch": {
- "id": "androidenterprise.collections.patch",
- "path": "enterprises/{enterpriseId}/collections/{collectionId}",
- "httpMethod": "PATCH",
- "description": "Updates a collection. This method supports patch semantics.",
- "parameters": {
- "collectionId": {
- "type": "string",
- "description": "The ID of the collection.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "collectionId"
- ],
- "request": {
- "$ref": "Collection"
- },
- "response": {
- "$ref": "Collection"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "update": {
- "id": "androidenterprise.collections.update",
- "path": "enterprises/{enterpriseId}/collections/{collectionId}",
- "httpMethod": "PUT",
- "description": "Updates a collection.",
- "parameters": {
- "collectionId": {
- "type": "string",
- "description": "The ID of the collection.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "collectionId"
- ],
- "request": {
- "$ref": "Collection"
- },
- "response": {
- "$ref": "Collection"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- }
- }
- },
- "collectionviewers": {
- "methods": {
- "delete": {
- "id": "androidenterprise.collectionviewers.delete",
- "path": "enterprises/{enterpriseId}/collections/{collectionId}/users/{userId}",
- "httpMethod": "DELETE",
- "description": "Removes the user from the list of those specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only such users will see the collection.",
- "parameters": {
- "collectionId": {
- "type": "string",
- "description": "The ID of the collection.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "collectionId",
- "userId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "get": {
- "id": "androidenterprise.collectionviewers.get",
- "path": "enterprises/{enterpriseId}/collections/{collectionId}/users/{userId}",
- "httpMethod": "GET",
- "description": "Retrieves the ID of the user if they have been specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only these users will see the collection.",
- "parameters": {
- "collectionId": {
- "type": "string",
- "description": "The ID of the collection.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "collectionId",
- "userId"
- ],
- "response": {
- "$ref": "User"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "list": {
- "id": "androidenterprise.collectionviewers.list",
- "path": "enterprises/{enterpriseId}/collections/{collectionId}/users",
- "httpMethod": "GET",
- "description": "Retrieves the IDs of the users who have been specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only these users will see the collection.",
- "parameters": {
- "collectionId": {
- "type": "string",
- "description": "The ID of the collection.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "collectionId"
- ],
- "response": {
- "$ref": "CollectionViewersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "patch": {
- "id": "androidenterprise.collectionviewers.patch",
- "path": "enterprises/{enterpriseId}/collections/{collectionId}/users/{userId}",
- "httpMethod": "PATCH",
- "description": "Adds the user to the list of those specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only such users will see the collection. This method supports patch semantics.",
- "parameters": {
- "collectionId": {
- "type": "string",
- "description": "The ID of the collection.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "collectionId",
- "userId"
- ],
- "request": {
- "$ref": "User"
- },
- "response": {
- "$ref": "User"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "update": {
- "id": "androidenterprise.collectionviewers.update",
- "path": "enterprises/{enterpriseId}/collections/{collectionId}/users/{userId}",
- "httpMethod": "PUT",
- "description": "Adds the user to the list of those specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only such users will see the collection.",
- "parameters": {
- "collectionId": {
- "type": "string",
- "description": "The ID of the collection.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "collectionId",
- "userId"
- ],
- "request": {
- "$ref": "User"
- },
- "response": {
- "$ref": "User"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- }
- }
- },
- "devices": {
- "methods": {
- "get": {
- "id": "androidenterprise.devices.get",
- "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}",
- "httpMethod": "GET",
- "description": "Retrieves the details of a device.",
- "parameters": {
- "deviceId": {
- "type": "string",
- "description": "The ID of the device.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "deviceId"
- ],
- "response": {
- "$ref": "Device"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "getState": {
- "id": "androidenterprise.devices.getState",
- "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state",
- "httpMethod": "GET",
- "description": "Retrieves whether a device is enabled or disabled for access by the user to Google services. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services.",
- "parameters": {
- "deviceId": {
- "type": "string",
- "description": "The ID of the device.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "deviceId"
- ],
- "response": {
- "$ref": "DeviceState"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "list": {
- "id": "androidenterprise.devices.list",
- "path": "enterprises/{enterpriseId}/users/{userId}/devices",
- "httpMethod": "GET",
- "description": "Retrieves the IDs of all of a user's devices.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId"
- ],
- "response": {
- "$ref": "DevicesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "setState": {
- "id": "androidenterprise.devices.setState",
- "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state",
- "httpMethod": "PUT",
- "description": "Sets whether a device is enabled or disabled for access by the user to Google services. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services.",
- "parameters": {
- "deviceId": {
- "type": "string",
- "description": "The ID of the device.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "deviceId"
- ],
- "request": {
- "$ref": "DeviceState"
- },
- "response": {
- "$ref": "DeviceState"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- }
- }
- },
- "enterprises": {
- "methods": {
- "delete": {
- "id": "androidenterprise.enterprises.delete",
- "path": "enterprises/{enterpriseId}",
- "httpMethod": "DELETE",
- "description": "Deletes the binding between the MDM and enterprise. This is now deprecated; use this to unenroll customers that were previously enrolled with the 'insert' call, then enroll them again with the 'enroll' call.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "enroll": {
- "id": "androidenterprise.enterprises.enroll",
- "path": "enterprises/enroll",
- "httpMethod": "POST",
- "description": "Enrolls an enterprise with the calling MDM.",
- "parameters": {
- "token": {
- "type": "string",
- "description": "The token provided by the enterprise to register the MDM.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "token"
- ],
- "request": {
- "$ref": "Enterprise"
- },
- "response": {
- "$ref": "Enterprise"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "get": {
- "id": "androidenterprise.enterprises.get",
- "path": "enterprises/{enterpriseId}",
- "httpMethod": "GET",
- "description": "Retrieves the name and domain of an enterprise.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId"
- ],
- "response": {
- "$ref": "Enterprise"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "insert": {
- "id": "androidenterprise.enterprises.insert",
- "path": "enterprises",
- "httpMethod": "POST",
- "description": "Establishes the binding between the MDM and an enterprise. This is now deprecated; use enroll instead.",
- "parameters": {
- "token": {
- "type": "string",
- "description": "The token provided by the enterprise to register the MDM.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "token"
- ],
- "request": {
- "$ref": "Enterprise"
- },
- "response": {
- "$ref": "Enterprise"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "list": {
- "id": "androidenterprise.enterprises.list",
- "path": "enterprises",
- "httpMethod": "GET",
- "description": "Looks up an enterprise by domain name.",
- "parameters": {
- "domain": {
- "type": "string",
- "description": "The exact primary domain name of the enterprise to look up.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "domain"
- ],
- "response": {
- "$ref": "EnterprisesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "sendTestPushNotification": {
- "id": "androidenterprise.enterprises.sendTestPushNotification",
- "path": "enterprises/{enterpriseId}/sendTestPushNotification",
- "httpMethod": "POST",
- "description": "Sends a test push notification to validate the MDM integration with the Google Cloud Pub/Sub service for this enterprise.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId"
- ],
- "response": {
- "$ref": "EnterprisesSendTestPushNotificationResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "setAccount": {
- "id": "androidenterprise.enterprises.setAccount",
- "path": "enterprises/{enterpriseId}/account",
- "httpMethod": "PUT",
- "description": "Set the account that will be used to authenticate to the API as the enterprise.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId"
- ],
- "request": {
- "$ref": "EnterpriseAccount"
- },
- "response": {
- "$ref": "EnterpriseAccount"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "unenroll": {
- "id": "androidenterprise.enterprises.unenroll",
- "path": "enterprises/{enterpriseId}/unenroll",
- "httpMethod": "POST",
- "description": "Unenrolls an enterprise from the calling MDM.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- }
- }
- },
- "entitlements": {
- "methods": {
- "delete": {
- "id": "androidenterprise.entitlements.delete",
- "path": "enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
- "httpMethod": "DELETE",
- "description": "Removes an entitlement to an app for a user and uninstalls it.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "entitlementId": {
- "type": "string",
- "description": "The ID of the entitlement, e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "entitlementId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "get": {
- "id": "androidenterprise.entitlements.get",
- "path": "enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
- "httpMethod": "GET",
- "description": "Retrieves details of an entitlement.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "entitlementId": {
- "type": "string",
- "description": "The ID of the entitlement, e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "entitlementId"
- ],
- "response": {
- "$ref": "Entitlement"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "list": {
- "id": "androidenterprise.entitlements.list",
- "path": "enterprises/{enterpriseId}/users/{userId}/entitlements",
- "httpMethod": "GET",
- "description": "List of all entitlements for the specified user. Only the ID is set.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId"
- ],
- "response": {
- "$ref": "EntitlementsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "patch": {
- "id": "androidenterprise.entitlements.patch",
- "path": "enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
- "httpMethod": "PATCH",
- "description": "Adds or updates an entitlement to an app for a user. This method supports patch semantics.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "entitlementId": {
- "type": "string",
- "description": "The ID of the entitlement, e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- },
- "install": {
- "type": "boolean",
- "description": "Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user.",
- "location": "query"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "entitlementId"
- ],
- "request": {
- "$ref": "Entitlement"
- },
- "response": {
- "$ref": "Entitlement"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "update": {
- "id": "androidenterprise.entitlements.update",
- "path": "enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
- "httpMethod": "PUT",
- "description": "Adds or updates an entitlement to an app for a user.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "entitlementId": {
- "type": "string",
- "description": "The ID of the entitlement, e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- },
- "install": {
- "type": "boolean",
- "description": "Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user.",
- "location": "query"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "entitlementId"
- ],
- "request": {
- "$ref": "Entitlement"
- },
- "response": {
- "$ref": "Entitlement"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- }
- }
- },
- "grouplicenses": {
- "methods": {
- "get": {
- "id": "androidenterprise.grouplicenses.get",
- "path": "enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}",
- "httpMethod": "GET",
- "description": "Retrieves details of an enterprise's group license for a product.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "groupLicenseId": {
- "type": "string",
- "description": "The ID of the product the group license is for, e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "groupLicenseId"
- ],
- "response": {
- "$ref": "GroupLicense"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "list": {
- "id": "androidenterprise.grouplicenses.list",
- "path": "enterprises/{enterpriseId}/groupLicenses",
- "httpMethod": "GET",
- "description": "Retrieves IDs of all products for which the enterprise has a group license.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId"
- ],
- "response": {
- "$ref": "GroupLicensesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- }
- }
- },
- "grouplicenseusers": {
- "methods": {
- "list": {
- "id": "androidenterprise.grouplicenseusers.list",
- "path": "enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}/users",
- "httpMethod": "GET",
- "description": "Retrieves the IDs of the users who have been granted entitlements under the license.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "groupLicenseId": {
- "type": "string",
- "description": "The ID of the product the group license is for, e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "groupLicenseId"
- ],
- "response": {
- "$ref": "GroupLicenseUsersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- }
- }
- },
- "installs": {
- "methods": {
- "delete": {
- "id": "androidenterprise.installs.delete",
- "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
- "httpMethod": "DELETE",
- "description": "Requests to remove an app from a device. A call to get or list will still show the app as installed on the device until it is actually removed.",
- "parameters": {
- "deviceId": {
- "type": "string",
- "description": "The Android ID of the device.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "installId": {
- "type": "string",
- "description": "The ID of the product represented by the install, e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "deviceId",
- "installId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "get": {
- "id": "androidenterprise.installs.get",
- "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
- "httpMethod": "GET",
- "description": "Retrieves details of an installation of an app on a device.",
- "parameters": {
- "deviceId": {
- "type": "string",
- "description": "The Android ID of the device.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "installId": {
- "type": "string",
- "description": "The ID of the product represented by the install, e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "deviceId",
- "installId"
- ],
- "response": {
- "$ref": "Install"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "list": {
- "id": "androidenterprise.installs.list",
- "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs",
- "httpMethod": "GET",
- "description": "Retrieves the details of all apps installed on the specified device.",
- "parameters": {
- "deviceId": {
- "type": "string",
- "description": "The Android ID of the device.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "deviceId"
- ],
- "response": {
- "$ref": "InstallsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "patch": {
- "id": "androidenterprise.installs.patch",
- "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
- "httpMethod": "PATCH",
- "description": "Requests to install the latest version of an app to a device. If the app is already installed then it is updated to the latest version if necessary. This method supports patch semantics.",
- "parameters": {
- "deviceId": {
- "type": "string",
- "description": "The Android ID of the device.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "installId": {
- "type": "string",
- "description": "The ID of the product represented by the install, e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "deviceId",
- "installId"
- ],
- "request": {
- "$ref": "Install"
- },
- "response": {
- "$ref": "Install"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "update": {
- "id": "androidenterprise.installs.update",
- "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
- "httpMethod": "PUT",
- "description": "Requests to install the latest version of an app to a device. If the app is already installed then it is updated to the latest version if necessary.",
- "parameters": {
- "deviceId": {
- "type": "string",
- "description": "The Android ID of the device.",
- "required": true,
- "location": "path"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "installId": {
- "type": "string",
- "description": "The ID of the product represented by the install, e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId",
- "deviceId",
- "installId"
- ],
- "request": {
- "$ref": "Install"
- },
- "response": {
- "$ref": "Install"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- }
- }
- },
- "permissions": {
- "methods": {
- "get": {
- "id": "androidenterprise.permissions.get",
- "path": "permissions/{permissionId}",
- "httpMethod": "GET",
- "description": "Retrieves details of an Android app permission for display to an enterprise admin.",
- "parameters": {
- "language": {
- "type": "string",
- "description": "The BCP47 tag for the user's preferred language (e.g. \"en-US\", \"de\")",
- "location": "query"
- },
- "permissionId": {
- "type": "string",
- "description": "The ID of the permission.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "permissionId"
- ],
- "response": {
- "$ref": "Permission"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- }
- }
- },
- "products": {
- "methods": {
- "approve": {
- "id": "androidenterprise.products.approve",
- "path": "enterprises/{enterpriseId}/products/{productId}/approve",
- "httpMethod": "POST",
- "description": "Approves the specified product (and the relevant app permissions, if any).",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "productId": {
- "type": "string",
- "description": "The ID of the product.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "productId"
- ],
- "request": {
- "$ref": "ProductsApproveRequest"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "generateApprovalUrl": {
- "id": "androidenterprise.products.generateApprovalUrl",
- "path": "enterprises/{enterpriseId}/products/{productId}/generateApprovalUrl",
- "httpMethod": "POST",
- "description": "Generates a URL that can be rendered in an iframe to display the permissions (if any) of a product. An enterprise admin must view these permissions and accept them on behalf of their organization in order to approve that product.\n\nAdmins should accept the displayed permissions by interacting with a separate UI element in the EMM console, which in turn should trigger the use of this URL as the approvalUrlInfo.approvalUrl property in a Products.approve call to approve the product. This URL can only be used to display permissions for up to 1 day.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "languageCode": {
- "type": "string",
- "description": "The BCP 47 language code used for permission names and descriptions in the returned iframe, for instance \"en-US\".",
- "location": "query"
- },
- "productId": {
- "type": "string",
- "description": "The ID of the product.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "productId"
- ],
- "response": {
- "$ref": "ProductsGenerateApprovalUrlResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "get": {
- "id": "androidenterprise.products.get",
- "path": "enterprises/{enterpriseId}/products/{productId}",
- "httpMethod": "GET",
- "description": "Retrieves details of a product for display to an enterprise admin.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "The BCP47 tag for the user's preferred language (e.g. \"en-US\", \"de\").",
- "location": "query"
- },
- "productId": {
- "type": "string",
- "description": "The ID of the product, e.g. \"app:com.google.android.gm\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "productId"
- ],
- "response": {
- "$ref": "Product"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "getAppRestrictionsSchema": {
- "id": "androidenterprise.products.getAppRestrictionsSchema",
- "path": "enterprises/{enterpriseId}/products/{productId}/appRestrictionsSchema",
- "httpMethod": "GET",
- "description": "Retrieves the schema defining app restrictions configurable for this product. All products have a schema, but this may be empty if no app restrictions are defined.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "The BCP47 tag for the user's preferred language (e.g. \"en-US\", \"de\").",
- "location": "query"
- },
- "productId": {
- "type": "string",
- "description": "The ID of the product.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "productId"
- ],
- "response": {
- "$ref": "AppRestrictionsSchema"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "getPermissions": {
- "id": "androidenterprise.products.getPermissions",
- "path": "enterprises/{enterpriseId}/products/{productId}/permissions",
- "httpMethod": "GET",
- "description": "Retrieves the Android app permissions required by this app.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "productId": {
- "type": "string",
- "description": "The ID of the product.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "productId"
- ],
- "response": {
- "$ref": "ProductPermissions"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "updatePermissions": {
- "id": "androidenterprise.products.updatePermissions",
- "path": "enterprises/{enterpriseId}/products/{productId}/permissions",
- "httpMethod": "PUT",
- "description": "Updates the set of Android app permissions for this app that have been accepted by the enterprise.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "productId": {
- "type": "string",
- "description": "The ID of the product.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "productId"
- ],
- "request": {
- "$ref": "ProductPermissions"
- },
- "response": {
- "$ref": "ProductPermissions"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- }
- }
- },
- "users": {
- "methods": {
- "generateToken": {
- "id": "androidenterprise.users.generateToken",
- "path": "enterprises/{enterpriseId}/users/{userId}/token",
- "httpMethod": "POST",
- "description": "Generates a token (activation code) to allow this user to configure their work account in the Android Setup Wizard. Revokes any previously generated token.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId"
- ],
- "response": {
- "$ref": "UserToken"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "get": {
- "id": "androidenterprise.users.get",
- "path": "enterprises/{enterpriseId}/users/{userId}",
- "httpMethod": "GET",
- "description": "Retrieves a user's details.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId"
- ],
- "response": {
- "$ref": "User"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "getAvailableProductSet": {
- "id": "androidenterprise.users.getAvailableProductSet",
- "path": "enterprises/{enterpriseId}/users/{userId}/availableProductSet",
- "httpMethod": "GET",
- "description": "Retrieves the set of products a user is entitled to access.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId"
- ],
- "response": {
- "$ref": "ProductSet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "list": {
- "id": "androidenterprise.users.list",
- "path": "enterprises/{enterpriseId}/users",
- "httpMethod": "GET",
- "description": "Looks up a user by email address.",
- "parameters": {
- "email": {
- "type": "string",
- "description": "The exact primary email address of the user to look up.",
- "required": true,
- "location": "query"
- },
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "email"
- ],
- "response": {
- "$ref": "UsersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "revokeToken": {
- "id": "androidenterprise.users.revokeToken",
- "path": "enterprises/{enterpriseId}/users/{userId}/token",
- "httpMethod": "DELETE",
- "description": "Revokes a previously generated token (activation code) for the user.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- },
- "setAvailableProductSet": {
- "id": "androidenterprise.users.setAvailableProductSet",
- "path": "enterprises/{enterpriseId}/users/{userId}/availableProductSet",
- "httpMethod": "PUT",
- "description": "Modifies the set of products a user is entitled to access.",
- "parameters": {
- "enterpriseId": {
- "type": "string",
- "description": "The ID of the enterprise.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "The ID of the user.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "enterpriseId",
- "userId"
- ],
- "request": {
- "$ref": "ProductSet"
- },
- "response": {
- "$ref": "ProductSet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidenterprise"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/androidenterprise/v1/androidenterprise-gen.go b/vendor/google.golang.org/api/androidenterprise/v1/androidenterprise-gen.go
deleted file mode 100644
index e2d8664d..00000000
--- a/vendor/google.golang.org/api/androidenterprise/v1/androidenterprise-gen.go
+++ /dev/null
@@ -1,7947 +0,0 @@
-// Package androidenterprise provides access to the Google Play EMM API.
-//
-// See https://developers.google.com/play/enterprise
-//
-// Usage example:
-//
-// import "google.golang.org/api/androidenterprise/v1"
-// ...
-// androidenterpriseService, err := androidenterprise.New(oauthHttpClient)
-package androidenterprise // import "google.golang.org/api/androidenterprise/v1"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "androidenterprise:v1"
-const apiName = "androidenterprise"
-const apiVersion = "v1"
-const basePath = "https://www.googleapis.com/androidenterprise/v1/"
-
-// OAuth2 scopes used by this API.
-const (
- // Manage corporate Android devices
- AndroidenterpriseScope = "https://www.googleapis.com/auth/androidenterprise"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Collections = NewCollectionsService(s)
- s.Collectionviewers = NewCollectionviewersService(s)
- s.Devices = NewDevicesService(s)
- s.Enterprises = NewEnterprisesService(s)
- s.Entitlements = NewEntitlementsService(s)
- s.Grouplicenses = NewGrouplicensesService(s)
- s.Grouplicenseusers = NewGrouplicenseusersService(s)
- s.Installs = NewInstallsService(s)
- s.Permissions = NewPermissionsService(s)
- s.Products = NewProductsService(s)
- s.Users = NewUsersService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Collections *CollectionsService
-
- Collectionviewers *CollectionviewersService
-
- Devices *DevicesService
-
- Enterprises *EnterprisesService
-
- Entitlements *EntitlementsService
-
- Grouplicenses *GrouplicensesService
-
- Grouplicenseusers *GrouplicenseusersService
-
- Installs *InstallsService
-
- Permissions *PermissionsService
-
- Products *ProductsService
-
- Users *UsersService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewCollectionsService(s *Service) *CollectionsService {
- rs := &CollectionsService{s: s}
- return rs
-}
-
-type CollectionsService struct {
- s *Service
-}
-
-func NewCollectionviewersService(s *Service) *CollectionviewersService {
- rs := &CollectionviewersService{s: s}
- return rs
-}
-
-type CollectionviewersService struct {
- s *Service
-}
-
-func NewDevicesService(s *Service) *DevicesService {
- rs := &DevicesService{s: s}
- return rs
-}
-
-type DevicesService struct {
- s *Service
-}
-
-func NewEnterprisesService(s *Service) *EnterprisesService {
- rs := &EnterprisesService{s: s}
- return rs
-}
-
-type EnterprisesService struct {
- s *Service
-}
-
-func NewEntitlementsService(s *Service) *EntitlementsService {
- rs := &EntitlementsService{s: s}
- return rs
-}
-
-type EntitlementsService struct {
- s *Service
-}
-
-func NewGrouplicensesService(s *Service) *GrouplicensesService {
- rs := &GrouplicensesService{s: s}
- return rs
-}
-
-type GrouplicensesService struct {
- s *Service
-}
-
-func NewGrouplicenseusersService(s *Service) *GrouplicenseusersService {
- rs := &GrouplicenseusersService{s: s}
- return rs
-}
-
-type GrouplicenseusersService struct {
- s *Service
-}
-
-func NewInstallsService(s *Service) *InstallsService {
- rs := &InstallsService{s: s}
- return rs
-}
-
-type InstallsService struct {
- s *Service
-}
-
-func NewPermissionsService(s *Service) *PermissionsService {
- rs := &PermissionsService{s: s}
- return rs
-}
-
-type PermissionsService struct {
- s *Service
-}
-
-func NewProductsService(s *Service) *ProductsService {
- rs := &ProductsService{s: s}
- return rs
-}
-
-type ProductsService struct {
- s *Service
-}
-
-func NewUsersService(s *Service) *UsersService {
- rs := &UsersService{s: s}
- return rs
-}
-
-type UsersService struct {
- s *Service
-}
-
-// AppRestrictionsSchema: Represents the list of app restrictions
-// available to be pre-configured for the product.
-type AppRestrictionsSchema struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidenterprise#appRestrictionsSchema".
- Kind string `json:"kind,omitempty"`
-
- // Restrictions: The set of restrictions that make up this schema.
- Restrictions []*AppRestrictionsSchemaRestriction `json:"restrictions,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AppRestrictionsSchema) MarshalJSON() ([]byte, error) {
- type noMethod AppRestrictionsSchema
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AppRestrictionsSchemaRestriction: A restriction in the App
-// Restriction Schema represents a piece of configuration that may be
-// pre-applied.
-type AppRestrictionsSchemaRestriction struct {
- // DefaultValue: The default value of the restriction.
- DefaultValue *AppRestrictionsSchemaRestrictionRestrictionValue `json:"defaultValue,omitempty"`
-
- // Description: A longer description of the restriction, giving more
- // detail of what it affects.
- Description string `json:"description,omitempty"`
-
- // Entry: For choice or multiselect restrictions, the list of possible
- // entries' human-readable names.
- Entry []string `json:"entry,omitempty"`
-
- // EntryValue: For choice or multiselect restrictions, the list of
- // possible entries' machine-readable values.
- EntryValue []string `json:"entryValue,omitempty"`
-
- // Key: The unique key that the product uses to identify the
- // restriction, e.g. "com.google.android.gm.fieldname".
- Key string `json:"key,omitempty"`
-
- // RestrictionType: The type of the restriction.
- RestrictionType string `json:"restrictionType,omitempty"`
-
- // Title: The name of the restriction.
- Title string `json:"title,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DefaultValue") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AppRestrictionsSchemaRestriction) MarshalJSON() ([]byte, error) {
- type noMethod AppRestrictionsSchemaRestriction
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AppRestrictionsSchemaRestrictionRestrictionValue: A typed value for
-// the restriction.
-type AppRestrictionsSchemaRestrictionRestrictionValue struct {
- // Type: The type of the value being provided.
- Type string `json:"type,omitempty"`
-
- // ValueBool: The boolean value - this will only be present if type is
- // bool.
- ValueBool bool `json:"valueBool,omitempty"`
-
- // ValueInteger: The integer value - this will only be present if type
- // is integer.
- ValueInteger int64 `json:"valueInteger,omitempty"`
-
- // ValueMultiselect: The list of string values - this will only be
- // present if type is multiselect.
- ValueMultiselect []string `json:"valueMultiselect,omitempty"`
-
- // ValueString: The string value - this will be present for types
- // string, choice and hidden.
- ValueString string `json:"valueString,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Type") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AppRestrictionsSchemaRestrictionRestrictionValue) MarshalJSON() ([]byte, error) {
- type noMethod AppRestrictionsSchemaRestrictionRestrictionValue
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AppVersion: This represents a single version of the app.
-type AppVersion struct {
- // VersionCode: Unique increasing identifier for the app version.
- VersionCode int64 `json:"versionCode,omitempty"`
-
- // VersionString: The string used in the Play Store by the app developer
- // to identify the version. The string is not necessarily unique or
- // localized (for example, the string could be "1.4").
- VersionString string `json:"versionString,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "VersionCode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AppVersion) MarshalJSON() ([]byte, error) {
- type noMethod AppVersion
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ApprovalUrlInfo: Information on an approval URL.
-type ApprovalUrlInfo struct {
- // ApprovalUrl: A URL that displays a product's permissions and that can
- // also be used to approve the product with the Products.approve call.
- ApprovalUrl string `json:"approvalUrl,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidenterprise#approvalUrlInfo".
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ApprovalUrl") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ApprovalUrlInfo) MarshalJSON() ([]byte, error) {
- type noMethod ApprovalUrlInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Collection: A collection resource defines a named set of apps that is
-// visible to a set of users in the Google Play Store app running on
-// those users' managed devices. Those users can then install any of
-// those apps if they wish (which will trigger creation of install and
-// entitlement resources). A user cannot install an app on a managed
-// device unless the app is listed in at least one collection that is
-// visible to that user.
-//
-// Note that the API can be used to directly install an app regardless
-// of whether it is in any collection - so an enterprise has a choice of
-// either directly pushing apps to users, or allowing users to install
-// apps if they want. Which is appropriate will depend on the
-// enterprise's policies and the purpose of the apps concerned.
-type Collection struct {
- // CollectionId: Arbitrary unique ID, allocated by the API on creation.
- CollectionId string `json:"collectionId,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidenterprise#collection".
- Kind string `json:"kind,omitempty"`
-
- // Name: A user-friendly name for the collection (should be unique),
- // e.g. "Accounting apps".
- Name string `json:"name,omitempty"`
-
- // ProductId: The IDs of the products in the collection, in the order in
- // which they should be displayed.
- ProductId []string `json:"productId,omitempty"`
-
- // Visibility: Whether this collection is visible to all users, or only
- // to the users that have been granted access through the
- // "Collectionviewers" API. With the launch of the
- // "setAvailableProductSet" API, this property should always be set to
- // "viewersOnly", as the "allUsers" option will bypass the
- // "availableProductSet" for all users within a domain.
- //
- // The "allUsers" setting is deprecated, and will be removed.
- Visibility string `json:"visibility,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CollectionId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Collection) MarshalJSON() ([]byte, error) {
- type noMethod Collection
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CollectionViewersListResponse: The user resources for the collection.
-type CollectionViewersListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidenterprise#collectionViewersListResponse".
- Kind string `json:"kind,omitempty"`
-
- // User: A user of an enterprise.
- User []*User `json:"user,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CollectionViewersListResponse) MarshalJSON() ([]byte, error) {
- type noMethod CollectionViewersListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CollectionsListResponse: The collection resources for the enterprise.
-type CollectionsListResponse struct {
- // Collection: An ordered collection of products which can be made
- // visible on the Google Play Store to a selected group of users.
- Collection []*Collection `json:"collection,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidenterprise#collectionsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Collection") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CollectionsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod CollectionsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Device: A device resource represents a mobile device managed by the
-// MDM and belonging to a specific enterprise user.
-//
-// This collection cannot be modified via the API; it is automatically
-// populated as devices are set up to be managed.
-type Device struct {
- // AndroidId: The Google Play Services Android ID for the device encoded
- // as a lowercase hex string, e.g. "123456789abcdef0".
- AndroidId string `json:"androidId,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidenterprise#device".
- Kind string `json:"kind,omitempty"`
-
- // ManagementType: The mechanism by which this device is managed by the
- // MDM. "managedDevice" means that the MDM's app is a device owner.
- // "managedProfile" means that the MDM's app is the profile owner (and
- // there is a separate personal profile which is not managed).
- // "containerApp" means that the MDM's app is managing the Android for
- // Work container app on the device.
- ManagementType string `json:"managementType,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AndroidId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Device) MarshalJSON() ([]byte, error) {
- type noMethod Device
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DeviceState: The state of a user's device, as accessed by the
-// getState and setState methods on device resources.
-type DeviceState struct {
- // AccountState: The state of the Google account on the device.
- // "enabled" indicates that the Google account on the device can be used
- // to access Google services (including Google Play), while "disabled"
- // means that it cannot. A new device is initially in the "disabled"
- // state.
- AccountState string `json:"accountState,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidenterprise#deviceState".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountState") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DeviceState) MarshalJSON() ([]byte, error) {
- type noMethod DeviceState
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DevicesListResponse: The device resources for the user.
-type DevicesListResponse struct {
- // Device: A managed device.
- Device []*Device `json:"device,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidenterprise#devicesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Device") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DevicesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod DevicesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Enterprise: An enterprise resource represents a binding between an
-// organisation and their MDM.
-//
-// To create an enterprise, an admin of the enterprise must first go
-// through a Play for Work sign-up flow. At the end of this the admin
-// will be presented with a token (a short opaque alphanumeric string).
-// They must then present this to the MDM, who then supplies it to the
-// enroll method. Until this is done the MDM will not have any access to
-// the enterprise.
-//
-// After calling enroll the MDM should call setAccount to specify the
-// service account that will be allowed to act on behalf of the
-// enterprise, which will be required for access to the enterprise's
-// data through this API. Only one call of setAccount is allowed for a
-// given enterprise; the only way to change the account later is to
-// unenroll the enterprise and enroll it again (obtaining a new
-// token).
-//
-// The MDM can unenroll an enterprise in order to sever the binding
-// between them. Re-enrolling an enterprise is possible, but requires a
-// new token to be retrieved. Enterprises.unenroll requires the MDM's
-// credentials (as enroll does), not the enterprise's.
-// Enterprises.unenroll can only be used for enterprises that were
-// previously enrolled with the enroll call. Any enterprises that were
-// enrolled using the (deprecated) Enterprises.insert call must be
-// unenrolled with Enterprises.delete and can then be re-enrolled using
-// the Enterprises.enroll call.
-//
-// The ID for an enterprise is an opaque string. It is returned by
-// insert and enroll and can also be retrieved if the enterprise's
-// primary domain is known using the list method.
-type Enterprise struct {
- // Id: The unique ID for the enterprise.
- Id string `json:"id,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidenterprise#enterprise".
- Kind string `json:"kind,omitempty"`
-
- // Name: The name of the enterprise, e.g. "Example Inc".
- Name string `json:"name,omitempty"`
-
- // PrimaryDomain: The enterprise's primary domain, e.g. "example.com".
- PrimaryDomain string `json:"primaryDomain,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Enterprise) MarshalJSON() ([]byte, error) {
- type noMethod Enterprise
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// EnterpriseAccount: A service account that can be used to authenticate
-// as the enterprise to API calls that require such authentication.
-type EnterpriseAccount struct {
- // AccountEmail: The email address of the service account.
- AccountEmail string `json:"accountEmail,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidenterprise#enterpriseAccount".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountEmail") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EnterpriseAccount) MarshalJSON() ([]byte, error) {
- type noMethod EnterpriseAccount
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// EnterprisesListResponse: The matching enterprise resources.
-type EnterprisesListResponse struct {
- // Enterprise: An enterprise.
- Enterprise []*Enterprise `json:"enterprise,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidenterprise#enterprisesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Enterprise") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EnterprisesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod EnterprisesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type EnterprisesSendTestPushNotificationResponse struct {
- // MessageId: The message ID of the test push notification that was
- // sent.
- MessageId string `json:"messageId,omitempty"`
-
- // TopicName: The name of the Cloud Pub/Sub topic to which notifications
- // for this enterprise's enrolled account will be sent.
- TopicName string `json:"topicName,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "MessageId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EnterprisesSendTestPushNotificationResponse) MarshalJSON() ([]byte, error) {
- type noMethod EnterprisesSendTestPushNotificationResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Entitlement: The existence of an entitlement resource means that a
-// user has the right to use a particular app on any of their devices.
-// This might be because the app is free or because they have been
-// allocated a license to the app from a group license purchased by the
-// enterprise.
-//
-// It should always be true that a user has an app installed on one of
-// their devices only if they have an entitlement to it. So if an
-// entitlement is deleted, the app will be uninstalled from all devices.
-// Similarly if the user installs an app (and is permitted to do so), or
-// the MDM triggers an install of the app, an entitlement to that app is
-// automatically created. If this is impossible - e.g. the enterprise
-// has not purchased sufficient licenses - then installation
-// fails.
-//
-// Note that entitlements are always user specific, not device specific;
-// a user may have an entitlement even though they have not installed
-// the app anywhere. Once they have an entitlement they can install the
-// app on multiple devices.
-//
-// The API can be used to create an entitlement. If the app is a free
-// app, a group license for that app is created. If it's a paid app,
-// creating the entitlement consumes one license; it remains consumed
-// until the entitlement is removed. Optionally an installation of the
-// app on all the user's managed devices can be triggered at the time
-// the entitlement is created. An entitlement cannot be created for an
-// app if the app requires permissions that the enterprise has not yet
-// accepted.
-//
-// Entitlements for paid apps that are due to purchases by the user on a
-// non-managed profile will have "userPurchase" as entitlement reason;
-// those entitlements cannot be removed via the API.
-type Entitlement struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidenterprise#entitlement".
- Kind string `json:"kind,omitempty"`
-
- // ProductId: The ID of the product that the entitlement is for, e.g.
- // "app:com.google.android.gm".
- ProductId string `json:"productId,omitempty"`
-
- // Reason: The reason for the entitlement, e.g. "free" for free apps.
- // This is temporary, it will be replaced by the acquisition kind field
- // of group licenses.
- Reason string `json:"reason,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Entitlement) MarshalJSON() ([]byte, error) {
- type noMethod Entitlement
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// EntitlementsListResponse: The entitlement resources for the user.
-type EntitlementsListResponse struct {
- // Entitlement: An entitlement of a user to a product (e.g. an app). For
- // example, a free app that they have installed, or a paid app that they
- // have been allocated a license to.
- Entitlement []*Entitlement `json:"entitlement,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidenterprise#entitlementsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Entitlement") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EntitlementsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod EntitlementsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// GroupLicense: A group license object indicates a product that an
-// enterprise admin has approved for use in the enterprise. The product
-// may be free or paid. For free products, a group license object is
-// created in these cases: if the enterprise admin approves a product in
-// Google Play, if the product is added to a collection, or if an
-// entitlement for the product is created for a user via the API. For
-// paid products, a group license object is only created as part of the
-// first bulk purchase of that product in Google Play by the enterprise
-// admin.
-//
-// The API can be used to query group licenses; the available
-// information includes the total number of licenses purchased (for paid
-// products) and the total number of licenses that have been
-// provisioned, that is, the total number of user entitlements in
-// existence for the product.
-//
-// Group license objects are never deleted. If, for example, a free app
-// is added to a collection and then removed, the group license will
-// remain, allowing the enterprise admin to keep track of any remaining
-// entitlements. An enterprise admin may indicate they are no longer
-// interested in the group license by marking it as unapproved in Google
-// Play.
-type GroupLicense struct {
- // AcquisitionKind: How this group license was acquired. "bulkPurchase"
- // means that this group license object was created because the
- // enterprise purchased licenses for this product; this is "free"
- // otherwise (for free products).
- AcquisitionKind string `json:"acquisitionKind,omitempty"`
-
- // Approval: Whether the product to which this group license relates is
- // currently approved by the enterprise, as either "approved" or
- // "unapproved". Products are approved when a group license is first
- // created, but this approval may be revoked by an enterprise admin via
- // Google Play. Unapproved products will not be visible to end users in
- // collections and new entitlements to them should not normally be
- // created.
- Approval string `json:"approval,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidenterprise#groupLicense".
- Kind string `json:"kind,omitempty"`
-
- // NumProvisioned: The total number of provisioned licenses for this
- // product. Returned by read operations, but ignored in write
- // operations.
- NumProvisioned int64 `json:"numProvisioned,omitempty"`
-
- // NumPurchased: The number of purchased licenses (possibly in multiple
- // purchases). If this field is omitted then there is no limit on the
- // number of licenses that can be provisioned (e.g. if the acquisition
- // kind is "free").
- NumPurchased int64 `json:"numPurchased,omitempty"`
-
- // ProductId: The ID of the product that the license is for, e.g.
- // "app:com.google.android.gm".
- ProductId string `json:"productId,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AcquisitionKind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GroupLicense) MarshalJSON() ([]byte, error) {
- type noMethod GroupLicense
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// GroupLicenseUsersListResponse: The user resources for the group
-// license.
-type GroupLicenseUsersListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidenterprise#groupLicenseUsersListResponse".
- Kind string `json:"kind,omitempty"`
-
- // User: A user of an enterprise.
- User []*User `json:"user,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GroupLicenseUsersListResponse) MarshalJSON() ([]byte, error) {
- type noMethod GroupLicenseUsersListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// GroupLicensesListResponse: The grouplicense resources for the
-// enterprise.
-type GroupLicensesListResponse struct {
- // GroupLicense: A group license for a product approved for use in the
- // enterprise.
- GroupLicense []*GroupLicense `json:"groupLicense,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidenterprise#groupLicensesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "GroupLicense") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GroupLicensesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod GroupLicensesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Install: The existence of an install resource indicates that an app
-// is installed on a particular device (or that an install is
-// pending).
-//
-// The API can be used to create an install resource using the update
-// method. This triggers the actual install of the app on the device. If
-// the user does not already have an entitlement for the app then an
-// attempt is made to create one. If this fails (e.g. because the app is
-// not free and there is no available license) then the creation of the
-// install fails.
-//
-// The API can also be used to update an installed app. If the update
-// method is used on an existing install then the app will be updated to
-// the latest available version.
-//
-// Note that it is not possible to force the installation of a specific
-// version of an app; the version code is read-only.
-//
-// If a user installs an app themselves (as permitted by the
-// enterprise), then again an install resource and possibly an
-// entitlement resource are automatically created.
-//
-// The API can also be used to delete an install resource, which
-// triggers the removal of the app from the device. Note that deleting
-// an install does not automatically remove the corresponding
-// entitlement, even if there are no remaining installs. The install
-// resource will also be deleted if the user uninstalls the app
-// themselves.
-type Install struct {
- // InstallState: Install state. The state "installPending" means that an
- // install request has recently been made and download to the device is
- // in progress. The state "installed" means that the app has been
- // installed. This field is read-only.
- InstallState string `json:"installState,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidenterprise#install".
- Kind string `json:"kind,omitempty"`
-
- // ProductId: The ID of the product that the install is for, e.g.
- // "app:com.google.android.gm".
- ProductId string `json:"productId,omitempty"`
-
- // VersionCode: The version of the installed product. Guaranteed to be
- // set only if the install state is "installed".
- VersionCode int64 `json:"versionCode,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "InstallState") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Install) MarshalJSON() ([]byte, error) {
- type noMethod Install
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// InstallsListResponse: The install resources for the device.
-type InstallsListResponse struct {
- // Install: An installation of an app for a user on a specific device.
- // The existence of an install implies that the user must have an
- // entitlement to the app.
- Install []*Install `json:"install,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidenterprise#installsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Install") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstallsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod InstallsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Permission: A permission represents some extra capability, to be
-// granted to an Android app, which requires explicit consent. An
-// enterprise admin must consent to these permissions on behalf of their
-// users before an entitlement for the app can be created.
-//
-// The permissions collection is read-only. The information provided for
-// each permission (localized name and description) is intended to be
-// used in the MDM user interface when obtaining consent from the
-// enterprise.
-type Permission struct {
- // Description: A longer description of the permissions giving more
- // details of what it affects.
- Description string `json:"description,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidenterprise#permission".
- Kind string `json:"kind,omitempty"`
-
- // Name: The name of the permission.
- Name string `json:"name,omitempty"`
-
- // PermissionId: An opaque string uniquely identifying the permission.
- PermissionId string `json:"permissionId,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Description") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Permission) MarshalJSON() ([]byte, error) {
- type noMethod Permission
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Product: A product represents an app in the Google Play Store that is
-// available to at least some users in the enterprise. (Some apps are
-// restricted to a single enterprise, and no information about them is
-// made available outside that enterprise.)
-//
-// The information provided for each product (localized name, icon, link
-// to the full Google Play details page) is intended to allow a basic
-// representation of the product within an MDM user interface.
-type Product struct {
- // AppVersion: App versions currently available for this product. The
- // returned list contains only public versions. Alpha and beta versions
- // are not included.
- AppVersion []*AppVersion `json:"appVersion,omitempty"`
-
- // AuthorName: The name of the author of the product (e.g. the app
- // developer).
- AuthorName string `json:"authorName,omitempty"`
-
- // DetailsUrl: A link to the (consumer) Google Play details page for the
- // product.
- DetailsUrl string `json:"detailsUrl,omitempty"`
-
- // DistributionChannel: How and to whom the package is made available.
- // The value publicGoogleHosted means that the package is available
- // through the Play Store and not restricted to a specific enterprise.
- // The value privateGoogleHosted means that the package is a private app
- // (restricted to an enterprise) but hosted by Google. The value
- // privateSelfHosted means that the package is a private app (restricted
- // to an enterprise) and is privately hosted.
- DistributionChannel string `json:"distributionChannel,omitempty"`
-
- // IconUrl: A link to an image that can be used as an icon for the
- // product.
- IconUrl string `json:"iconUrl,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidenterprise#product".
- Kind string `json:"kind,omitempty"`
-
- // ProductId: A string of the form app:. For example,
- // app:com.google.android.gm represents the Gmail app.
- ProductId string `json:"productId,omitempty"`
-
- // RequiresContainerApp: Whether this app can only be installed on
- // devices using the Android for Work container app.
- RequiresContainerApp bool `json:"requiresContainerApp,omitempty"`
-
- // Title: The name of the product.
- Title string `json:"title,omitempty"`
-
- // WorkDetailsUrl: A link to the Google Play for Work details page for
- // the product, for use by an Enterprise administrator.
- WorkDetailsUrl string `json:"workDetailsUrl,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AppVersion") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Product) MarshalJSON() ([]byte, error) {
- type noMethod Product
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ProductPermission: A product permissions resource represents the set
-// of permissions required by a specific app and whether or not they
-// have been accepted by an enterprise admin.
-//
-// The API can be used to read the set of permissions, and also to
-// update the set to indicate that permissions have been accepted.
-type ProductPermission struct {
- // PermissionId: An opaque string uniquely identifying the permission.
- PermissionId string `json:"permissionId,omitempty"`
-
- // State: Whether the permission has been accepted or not.
- State string `json:"state,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "PermissionId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductPermission) MarshalJSON() ([]byte, error) {
- type noMethod ProductPermission
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ProductPermissions: Information about the permissions required by a
-// specific app and whether they have been accepted by the enterprise.
-type ProductPermissions struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidenterprise#productPermissions".
- Kind string `json:"kind,omitempty"`
-
- // Permission: The permissions required by the app.
- Permission []*ProductPermission `json:"permission,omitempty"`
-
- // ProductId: The ID of the app that the permissions relate to, e.g.
- // "app:com.google.android.gm".
- ProductId string `json:"productId,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductPermissions) MarshalJSON() ([]byte, error) {
- type noMethod ProductPermissions
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ProductSet: A set of products.
-type ProductSet struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidenterprise#productSet".
- Kind string `json:"kind,omitempty"`
-
- // ProductId: The list of product IDs making up the set of products.
- ProductId []string `json:"productId,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductSet) MarshalJSON() ([]byte, error) {
- type noMethod ProductSet
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ProductsApproveRequest struct {
- // ApprovalUrlInfo: The approval URL that was shown to the user. Only
- // the permissions shown to the user with that URL will be accepted,
- // which may not be the product's entire set of permissions. For
- // example, the URL may only display new permissions from an update
- // after the product was approved, or not include new permissions if the
- // product was updated since the URL was generated.
- ApprovalUrlInfo *ApprovalUrlInfo `json:"approvalUrlInfo,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ApprovalUrlInfo") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductsApproveRequest) MarshalJSON() ([]byte, error) {
- type noMethod ProductsApproveRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ProductsGenerateApprovalUrlResponse struct {
- // Url: A URL that can be rendered in an iframe to display the
- // permissions (if any) of a product. This URL can be used to approve
- // the product only once and only within 24 hours of being generated,
- // using the Products.approve call. If the product is currently
- // unapproved and has no permissions, this URL will point to an empty
- // page. If the product is currently approved, a URL will only be
- // generated if that product has added permissions since it was last
- // approved, and the URL will only display those new permissions that
- // have not yet been accepted.
- Url string `json:"url,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Url") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductsGenerateApprovalUrlResponse) MarshalJSON() ([]byte, error) {
- type noMethod ProductsGenerateApprovalUrlResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// User: A user resource represents an individual user within the
-// enterprise's domain.
-//
-// Note that each user is associated with a Google account based on the
-// user's corporate email address (which must be in one of the
-// enterprise's domains). As part of installing an MDM app to manage a
-// device the Google account must be provisioned to the device, and so
-// the user resource must be created before that. This can be done using
-// the Google Admin SDK Directory API.
-//
-// The ID for a user is an opaque string. It can be retrieved using the
-// list method queried by the user's primary email address.
-type User struct {
- // Id: The unique ID for the user.
- Id string `json:"id,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidenterprise#user".
- Kind string `json:"kind,omitempty"`
-
- // PrimaryEmail: The user's primary email, e.g. "jsmith@example.com".
- PrimaryEmail string `json:"primaryEmail,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *User) MarshalJSON() ([]byte, error) {
- type noMethod User
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserToken: A UserToken is used by a user when setting up a managed
-// device or profile with their work account on a device. When the user
-// enters their email address and token (activation code) the
-// appropriate MDM app can be automatically downloaded.
-type UserToken struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidenterprise#userToken".
- Kind string `json:"kind,omitempty"`
-
- // Token: The token (activation code) to be entered by the user. This
- // consists of a sequence of decimal digits. Note that the leading digit
- // may be 0.
- Token string `json:"token,omitempty"`
-
- // UserId: The unique ID for the user.
- UserId string `json:"userId,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserToken) MarshalJSON() ([]byte, error) {
- type noMethod UserToken
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UsersListResponse: The matching user resources.
-type UsersListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidenterprise#usersListResponse".
- Kind string `json:"kind,omitempty"`
-
- // User: A user of an enterprise.
- User []*User `json:"user,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UsersListResponse) MarshalJSON() ([]byte, error) {
- type noMethod UsersListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "androidenterprise.collections.delete":
-
-type CollectionsDeleteCall struct {
- s *Service
- enterpriseId string
- collectionId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes a collection.
-func (r *CollectionsService) Delete(enterpriseId string, collectionId string) *CollectionsDeleteCall {
- c := &CollectionsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.collectionId = collectionId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CollectionsDeleteCall) Fields(s ...googleapi.Field) *CollectionsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CollectionsDeleteCall) Context(ctx context.Context) *CollectionsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CollectionsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/collections/{collectionId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "collectionId": c.collectionId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.collections.delete" call.
-func (c *CollectionsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes a collection.",
- // "httpMethod": "DELETE",
- // "id": "androidenterprise.collections.delete",
- // "parameterOrder": [
- // "enterpriseId",
- // "collectionId"
- // ],
- // "parameters": {
- // "collectionId": {
- // "description": "The ID of the collection.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/collections/{collectionId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.collections.get":
-
-type CollectionsGetCall struct {
- s *Service
- enterpriseId string
- collectionId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves the details of a collection.
-func (r *CollectionsService) Get(enterpriseId string, collectionId string) *CollectionsGetCall {
- c := &CollectionsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.collectionId = collectionId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CollectionsGetCall) Fields(s ...googleapi.Field) *CollectionsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CollectionsGetCall) IfNoneMatch(entityTag string) *CollectionsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CollectionsGetCall) Context(ctx context.Context) *CollectionsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CollectionsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/collections/{collectionId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "collectionId": c.collectionId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.collections.get" call.
-// Exactly one of *Collection or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Collection.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CollectionsGetCall) Do() (*Collection, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Collection{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the details of a collection.",
- // "httpMethod": "GET",
- // "id": "androidenterprise.collections.get",
- // "parameterOrder": [
- // "enterpriseId",
- // "collectionId"
- // ],
- // "parameters": {
- // "collectionId": {
- // "description": "The ID of the collection.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/collections/{collectionId}",
- // "response": {
- // "$ref": "Collection"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.collections.insert":
-
-type CollectionsInsertCall struct {
- s *Service
- enterpriseId string
- collection *Collection
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a new collection.
-func (r *CollectionsService) Insert(enterpriseId string, collection *Collection) *CollectionsInsertCall {
- c := &CollectionsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.collection = collection
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CollectionsInsertCall) Fields(s ...googleapi.Field) *CollectionsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CollectionsInsertCall) Context(ctx context.Context) *CollectionsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CollectionsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.collection)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/collections")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.collections.insert" call.
-// Exactly one of *Collection or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Collection.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CollectionsInsertCall) Do() (*Collection, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Collection{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a new collection.",
- // "httpMethod": "POST",
- // "id": "androidenterprise.collections.insert",
- // "parameterOrder": [
- // "enterpriseId"
- // ],
- // "parameters": {
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/collections",
- // "request": {
- // "$ref": "Collection"
- // },
- // "response": {
- // "$ref": "Collection"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.collections.list":
-
-type CollectionsListCall struct {
- s *Service
- enterpriseId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the IDs of all the collections for an enterprise.
-func (r *CollectionsService) List(enterpriseId string) *CollectionsListCall {
- c := &CollectionsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CollectionsListCall) Fields(s ...googleapi.Field) *CollectionsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CollectionsListCall) IfNoneMatch(entityTag string) *CollectionsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CollectionsListCall) Context(ctx context.Context) *CollectionsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CollectionsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/collections")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.collections.list" call.
-// Exactly one of *CollectionsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CollectionsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CollectionsListCall) Do() (*CollectionsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CollectionsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the IDs of all the collections for an enterprise.",
- // "httpMethod": "GET",
- // "id": "androidenterprise.collections.list",
- // "parameterOrder": [
- // "enterpriseId"
- // ],
- // "parameters": {
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/collections",
- // "response": {
- // "$ref": "CollectionsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.collections.patch":
-
-type CollectionsPatchCall struct {
- s *Service
- enterpriseId string
- collectionId string
- collection *Collection
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates a collection. This method supports patch semantics.
-func (r *CollectionsService) Patch(enterpriseId string, collectionId string, collection *Collection) *CollectionsPatchCall {
- c := &CollectionsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.collectionId = collectionId
- c.collection = collection
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CollectionsPatchCall) Fields(s ...googleapi.Field) *CollectionsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CollectionsPatchCall) Context(ctx context.Context) *CollectionsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CollectionsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.collection)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/collections/{collectionId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "collectionId": c.collectionId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.collections.patch" call.
-// Exactly one of *Collection or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Collection.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CollectionsPatchCall) Do() (*Collection, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Collection{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a collection. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "androidenterprise.collections.patch",
- // "parameterOrder": [
- // "enterpriseId",
- // "collectionId"
- // ],
- // "parameters": {
- // "collectionId": {
- // "description": "The ID of the collection.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/collections/{collectionId}",
- // "request": {
- // "$ref": "Collection"
- // },
- // "response": {
- // "$ref": "Collection"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.collections.update":
-
-type CollectionsUpdateCall struct {
- s *Service
- enterpriseId string
- collectionId string
- collection *Collection
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates a collection.
-func (r *CollectionsService) Update(enterpriseId string, collectionId string, collection *Collection) *CollectionsUpdateCall {
- c := &CollectionsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.collectionId = collectionId
- c.collection = collection
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CollectionsUpdateCall) Fields(s ...googleapi.Field) *CollectionsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CollectionsUpdateCall) Context(ctx context.Context) *CollectionsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CollectionsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.collection)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/collections/{collectionId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "collectionId": c.collectionId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.collections.update" call.
-// Exactly one of *Collection or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Collection.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CollectionsUpdateCall) Do() (*Collection, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Collection{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a collection.",
- // "httpMethod": "PUT",
- // "id": "androidenterprise.collections.update",
- // "parameterOrder": [
- // "enterpriseId",
- // "collectionId"
- // ],
- // "parameters": {
- // "collectionId": {
- // "description": "The ID of the collection.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/collections/{collectionId}",
- // "request": {
- // "$ref": "Collection"
- // },
- // "response": {
- // "$ref": "Collection"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.collectionviewers.delete":
-
-type CollectionviewersDeleteCall struct {
- s *Service
- enterpriseId string
- collectionId string
- userId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Removes the user from the list of those specifically allowed
-// to see the collection. If the collection's visibility is set to
-// viewersOnly then only such users will see the collection.
-func (r *CollectionviewersService) Delete(enterpriseId string, collectionId string, userId string) *CollectionviewersDeleteCall {
- c := &CollectionviewersDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.collectionId = collectionId
- c.userId = userId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CollectionviewersDeleteCall) Fields(s ...googleapi.Field) *CollectionviewersDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CollectionviewersDeleteCall) Context(ctx context.Context) *CollectionviewersDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CollectionviewersDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/collections/{collectionId}/users/{userId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "collectionId": c.collectionId,
- "userId": c.userId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.collectionviewers.delete" call.
-func (c *CollectionviewersDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Removes the user from the list of those specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only such users will see the collection.",
- // "httpMethod": "DELETE",
- // "id": "androidenterprise.collectionviewers.delete",
- // "parameterOrder": [
- // "enterpriseId",
- // "collectionId",
- // "userId"
- // ],
- // "parameters": {
- // "collectionId": {
- // "description": "The ID of the collection.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userId": {
- // "description": "The ID of the user.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/collections/{collectionId}/users/{userId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.collectionviewers.get":
-
-type CollectionviewersGetCall struct {
- s *Service
- enterpriseId string
- collectionId string
- userId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves the ID of the user if they have been specifically
-// allowed to see the collection. If the collection's visibility is set
-// to viewersOnly then only these users will see the collection.
-func (r *CollectionviewersService) Get(enterpriseId string, collectionId string, userId string) *CollectionviewersGetCall {
- c := &CollectionviewersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.collectionId = collectionId
- c.userId = userId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CollectionviewersGetCall) Fields(s ...googleapi.Field) *CollectionviewersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CollectionviewersGetCall) IfNoneMatch(entityTag string) *CollectionviewersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CollectionviewersGetCall) Context(ctx context.Context) *CollectionviewersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CollectionviewersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/collections/{collectionId}/users/{userId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "collectionId": c.collectionId,
- "userId": c.userId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.collectionviewers.get" call.
-// Exactly one of *User or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *User.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *CollectionviewersGetCall) Do() (*User, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &User{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the ID of the user if they have been specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only these users will see the collection.",
- // "httpMethod": "GET",
- // "id": "androidenterprise.collectionviewers.get",
- // "parameterOrder": [
- // "enterpriseId",
- // "collectionId",
- // "userId"
- // ],
- // "parameters": {
- // "collectionId": {
- // "description": "The ID of the collection.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userId": {
- // "description": "The ID of the user.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/collections/{collectionId}/users/{userId}",
- // "response": {
- // "$ref": "User"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.collectionviewers.list":
-
-type CollectionviewersListCall struct {
- s *Service
- enterpriseId string
- collectionId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the IDs of the users who have been specifically
-// allowed to see the collection. If the collection's visibility is set
-// to viewersOnly then only these users will see the collection.
-func (r *CollectionviewersService) List(enterpriseId string, collectionId string) *CollectionviewersListCall {
- c := &CollectionviewersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.collectionId = collectionId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CollectionviewersListCall) Fields(s ...googleapi.Field) *CollectionviewersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CollectionviewersListCall) IfNoneMatch(entityTag string) *CollectionviewersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CollectionviewersListCall) Context(ctx context.Context) *CollectionviewersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CollectionviewersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/collections/{collectionId}/users")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "collectionId": c.collectionId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.collectionviewers.list" call.
-// Exactly one of *CollectionViewersListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *CollectionViewersListResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CollectionviewersListCall) Do() (*CollectionViewersListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CollectionViewersListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the IDs of the users who have been specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only these users will see the collection.",
- // "httpMethod": "GET",
- // "id": "androidenterprise.collectionviewers.list",
- // "parameterOrder": [
- // "enterpriseId",
- // "collectionId"
- // ],
- // "parameters": {
- // "collectionId": {
- // "description": "The ID of the collection.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/collections/{collectionId}/users",
- // "response": {
- // "$ref": "CollectionViewersListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.collectionviewers.patch":
-
-type CollectionviewersPatchCall struct {
- s *Service
- enterpriseId string
- collectionId string
- userId string
- user *User
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Adds the user to the list of those specifically allowed to see
-// the collection. If the collection's visibility is set to viewersOnly
-// then only such users will see the collection. This method supports
-// patch semantics.
-func (r *CollectionviewersService) Patch(enterpriseId string, collectionId string, userId string, user *User) *CollectionviewersPatchCall {
- c := &CollectionviewersPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.collectionId = collectionId
- c.userId = userId
- c.user = user
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CollectionviewersPatchCall) Fields(s ...googleapi.Field) *CollectionviewersPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CollectionviewersPatchCall) Context(ctx context.Context) *CollectionviewersPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CollectionviewersPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.user)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/collections/{collectionId}/users/{userId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "collectionId": c.collectionId,
- "userId": c.userId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.collectionviewers.patch" call.
-// Exactly one of *User or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *User.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *CollectionviewersPatchCall) Do() (*User, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &User{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Adds the user to the list of those specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only such users will see the collection. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "androidenterprise.collectionviewers.patch",
- // "parameterOrder": [
- // "enterpriseId",
- // "collectionId",
- // "userId"
- // ],
- // "parameters": {
- // "collectionId": {
- // "description": "The ID of the collection.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userId": {
- // "description": "The ID of the user.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/collections/{collectionId}/users/{userId}",
- // "request": {
- // "$ref": "User"
- // },
- // "response": {
- // "$ref": "User"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.collectionviewers.update":
-
-type CollectionviewersUpdateCall struct {
- s *Service
- enterpriseId string
- collectionId string
- userId string
- user *User
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Adds the user to the list of those specifically allowed to
-// see the collection. If the collection's visibility is set to
-// viewersOnly then only such users will see the collection.
-func (r *CollectionviewersService) Update(enterpriseId string, collectionId string, userId string, user *User) *CollectionviewersUpdateCall {
- c := &CollectionviewersUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.collectionId = collectionId
- c.userId = userId
- c.user = user
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CollectionviewersUpdateCall) Fields(s ...googleapi.Field) *CollectionviewersUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CollectionviewersUpdateCall) Context(ctx context.Context) *CollectionviewersUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CollectionviewersUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.user)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/collections/{collectionId}/users/{userId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "collectionId": c.collectionId,
- "userId": c.userId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.collectionviewers.update" call.
-// Exactly one of *User or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *User.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *CollectionviewersUpdateCall) Do() (*User, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &User{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Adds the user to the list of those specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only such users will see the collection.",
- // "httpMethod": "PUT",
- // "id": "androidenterprise.collectionviewers.update",
- // "parameterOrder": [
- // "enterpriseId",
- // "collectionId",
- // "userId"
- // ],
- // "parameters": {
- // "collectionId": {
- // "description": "The ID of the collection.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userId": {
- // "description": "The ID of the user.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/collections/{collectionId}/users/{userId}",
- // "request": {
- // "$ref": "User"
- // },
- // "response": {
- // "$ref": "User"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.devices.get":
-
-type DevicesGetCall struct {
- s *Service
- enterpriseId string
- userId string
- deviceId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves the details of a device.
-func (r *DevicesService) Get(enterpriseId string, userId string, deviceId string) *DevicesGetCall {
- c := &DevicesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.userId = userId
- c.deviceId = deviceId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DevicesGetCall) Fields(s ...googleapi.Field) *DevicesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DevicesGetCall) IfNoneMatch(entityTag string) *DevicesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DevicesGetCall) Context(ctx context.Context) *DevicesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DevicesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "userId": c.userId,
- "deviceId": c.deviceId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.devices.get" call.
-// Exactly one of *Device or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Device.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *DevicesGetCall) Do() (*Device, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Device{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the details of a device.",
- // "httpMethod": "GET",
- // "id": "androidenterprise.devices.get",
- // "parameterOrder": [
- // "enterpriseId",
- // "userId",
- // "deviceId"
- // ],
- // "parameters": {
- // "deviceId": {
- // "description": "The ID of the device.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userId": {
- // "description": "The ID of the user.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}",
- // "response": {
- // "$ref": "Device"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.devices.getState":
-
-type DevicesGetStateCall struct {
- s *Service
- enterpriseId string
- userId string
- deviceId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetState: Retrieves whether a device is enabled or disabled for
-// access by the user to Google services. The device state takes effect
-// only if enforcing EMM policies on Android devices is enabled in the
-// Google Admin Console. Otherwise, the device state is ignored and all
-// devices are allowed access to Google services.
-func (r *DevicesService) GetState(enterpriseId string, userId string, deviceId string) *DevicesGetStateCall {
- c := &DevicesGetStateCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.userId = userId
- c.deviceId = deviceId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DevicesGetStateCall) Fields(s ...googleapi.Field) *DevicesGetStateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DevicesGetStateCall) IfNoneMatch(entityTag string) *DevicesGetStateCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DevicesGetStateCall) Context(ctx context.Context) *DevicesGetStateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DevicesGetStateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "userId": c.userId,
- "deviceId": c.deviceId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.devices.getState" call.
-// Exactly one of *DeviceState or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *DeviceState.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DevicesGetStateCall) Do() (*DeviceState, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DeviceState{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves whether a device is enabled or disabled for access by the user to Google services. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services.",
- // "httpMethod": "GET",
- // "id": "androidenterprise.devices.getState",
- // "parameterOrder": [
- // "enterpriseId",
- // "userId",
- // "deviceId"
- // ],
- // "parameters": {
- // "deviceId": {
- // "description": "The ID of the device.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userId": {
- // "description": "The ID of the user.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state",
- // "response": {
- // "$ref": "DeviceState"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.devices.list":
-
-type DevicesListCall struct {
- s *Service
- enterpriseId string
- userId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the IDs of all of a user's devices.
-func (r *DevicesService) List(enterpriseId string, userId string) *DevicesListCall {
- c := &DevicesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.userId = userId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DevicesListCall) Fields(s ...googleapi.Field) *DevicesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DevicesListCall) IfNoneMatch(entityTag string) *DevicesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DevicesListCall) Context(ctx context.Context) *DevicesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DevicesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/users/{userId}/devices")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "userId": c.userId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.devices.list" call.
-// Exactly one of *DevicesListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *DevicesListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DevicesListCall) Do() (*DevicesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DevicesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the IDs of all of a user's devices.",
- // "httpMethod": "GET",
- // "id": "androidenterprise.devices.list",
- // "parameterOrder": [
- // "enterpriseId",
- // "userId"
- // ],
- // "parameters": {
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userId": {
- // "description": "The ID of the user.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/users/{userId}/devices",
- // "response": {
- // "$ref": "DevicesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.devices.setState":
-
-type DevicesSetStateCall struct {
- s *Service
- enterpriseId string
- userId string
- deviceId string
- devicestate *DeviceState
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetState: Sets whether a device is enabled or disabled for access by
-// the user to Google services. The device state takes effect only if
-// enforcing EMM policies on Android devices is enabled in the Google
-// Admin Console. Otherwise, the device state is ignored and all devices
-// are allowed access to Google services.
-func (r *DevicesService) SetState(enterpriseId string, userId string, deviceId string, devicestate *DeviceState) *DevicesSetStateCall {
- c := &DevicesSetStateCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.userId = userId
- c.deviceId = deviceId
- c.devicestate = devicestate
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DevicesSetStateCall) Fields(s ...googleapi.Field) *DevicesSetStateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DevicesSetStateCall) Context(ctx context.Context) *DevicesSetStateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DevicesSetStateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.devicestate)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "userId": c.userId,
- "deviceId": c.deviceId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.devices.setState" call.
-// Exactly one of *DeviceState or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *DeviceState.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DevicesSetStateCall) Do() (*DeviceState, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DeviceState{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sets whether a device is enabled or disabled for access by the user to Google services. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services.",
- // "httpMethod": "PUT",
- // "id": "androidenterprise.devices.setState",
- // "parameterOrder": [
- // "enterpriseId",
- // "userId",
- // "deviceId"
- // ],
- // "parameters": {
- // "deviceId": {
- // "description": "The ID of the device.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userId": {
- // "description": "The ID of the user.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state",
- // "request": {
- // "$ref": "DeviceState"
- // },
- // "response": {
- // "$ref": "DeviceState"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.enterprises.delete":
-
-type EnterprisesDeleteCall struct {
- s *Service
- enterpriseId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the binding between the MDM and enterprise. This is
-// now deprecated; use this to unenroll customers that were previously
-// enrolled with the 'insert' call, then enroll them again with the
-// 'enroll' call.
-func (r *EnterprisesService) Delete(enterpriseId string) *EnterprisesDeleteCall {
- c := &EnterprisesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EnterprisesDeleteCall) Fields(s ...googleapi.Field) *EnterprisesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EnterprisesDeleteCall) Context(ctx context.Context) *EnterprisesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EnterprisesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.enterprises.delete" call.
-func (c *EnterprisesDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes the binding between the MDM and enterprise. This is now deprecated; use this to unenroll customers that were previously enrolled with the 'insert' call, then enroll them again with the 'enroll' call.",
- // "httpMethod": "DELETE",
- // "id": "androidenterprise.enterprises.delete",
- // "parameterOrder": [
- // "enterpriseId"
- // ],
- // "parameters": {
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.enterprises.enroll":
-
-type EnterprisesEnrollCall struct {
- s *Service
- token string
- enterprise *Enterprise
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Enroll: Enrolls an enterprise with the calling MDM.
-func (r *EnterprisesService) Enroll(token string, enterprise *Enterprise) *EnterprisesEnrollCall {
- c := &EnterprisesEnrollCall{s: r.s, opt_: make(map[string]interface{})}
- c.token = token
- c.enterprise = enterprise
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EnterprisesEnrollCall) Fields(s ...googleapi.Field) *EnterprisesEnrollCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EnterprisesEnrollCall) Context(ctx context.Context) *EnterprisesEnrollCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EnterprisesEnrollCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.enterprise)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("token", fmt.Sprintf("%v", c.token))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/enroll")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.enterprises.enroll" call.
-// Exactly one of *Enterprise or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Enterprise.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *EnterprisesEnrollCall) Do() (*Enterprise, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Enterprise{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Enrolls an enterprise with the calling MDM.",
- // "httpMethod": "POST",
- // "id": "androidenterprise.enterprises.enroll",
- // "parameterOrder": [
- // "token"
- // ],
- // "parameters": {
- // "token": {
- // "description": "The token provided by the enterprise to register the MDM.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/enroll",
- // "request": {
- // "$ref": "Enterprise"
- // },
- // "response": {
- // "$ref": "Enterprise"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.enterprises.get":
-
-type EnterprisesGetCall struct {
- s *Service
- enterpriseId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves the name and domain of an enterprise.
-func (r *EnterprisesService) Get(enterpriseId string) *EnterprisesGetCall {
- c := &EnterprisesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EnterprisesGetCall) Fields(s ...googleapi.Field) *EnterprisesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *EnterprisesGetCall) IfNoneMatch(entityTag string) *EnterprisesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EnterprisesGetCall) Context(ctx context.Context) *EnterprisesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EnterprisesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.enterprises.get" call.
-// Exactly one of *Enterprise or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Enterprise.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *EnterprisesGetCall) Do() (*Enterprise, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Enterprise{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the name and domain of an enterprise.",
- // "httpMethod": "GET",
- // "id": "androidenterprise.enterprises.get",
- // "parameterOrder": [
- // "enterpriseId"
- // ],
- // "parameters": {
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}",
- // "response": {
- // "$ref": "Enterprise"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.enterprises.insert":
-
-type EnterprisesInsertCall struct {
- s *Service
- token string
- enterprise *Enterprise
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Establishes the binding between the MDM and an enterprise.
-// This is now deprecated; use enroll instead.
-func (r *EnterprisesService) Insert(token string, enterprise *Enterprise) *EnterprisesInsertCall {
- c := &EnterprisesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.token = token
- c.enterprise = enterprise
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EnterprisesInsertCall) Fields(s ...googleapi.Field) *EnterprisesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EnterprisesInsertCall) Context(ctx context.Context) *EnterprisesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EnterprisesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.enterprise)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("token", fmt.Sprintf("%v", c.token))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.enterprises.insert" call.
-// Exactly one of *Enterprise or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Enterprise.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *EnterprisesInsertCall) Do() (*Enterprise, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Enterprise{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Establishes the binding between the MDM and an enterprise. This is now deprecated; use enroll instead.",
- // "httpMethod": "POST",
- // "id": "androidenterprise.enterprises.insert",
- // "parameterOrder": [
- // "token"
- // ],
- // "parameters": {
- // "token": {
- // "description": "The token provided by the enterprise to register the MDM.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises",
- // "request": {
- // "$ref": "Enterprise"
- // },
- // "response": {
- // "$ref": "Enterprise"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.enterprises.list":
-
-type EnterprisesListCall struct {
- s *Service
- domain string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Looks up an enterprise by domain name.
-func (r *EnterprisesService) List(domain string) *EnterprisesListCall {
- c := &EnterprisesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.domain = domain
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EnterprisesListCall) Fields(s ...googleapi.Field) *EnterprisesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *EnterprisesListCall) IfNoneMatch(entityTag string) *EnterprisesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EnterprisesListCall) Context(ctx context.Context) *EnterprisesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EnterprisesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("domain", fmt.Sprintf("%v", c.domain))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.enterprises.list" call.
-// Exactly one of *EnterprisesListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *EnterprisesListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *EnterprisesListCall) Do() (*EnterprisesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EnterprisesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Looks up an enterprise by domain name.",
- // "httpMethod": "GET",
- // "id": "androidenterprise.enterprises.list",
- // "parameterOrder": [
- // "domain"
- // ],
- // "parameters": {
- // "domain": {
- // "description": "The exact primary domain name of the enterprise to look up.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises",
- // "response": {
- // "$ref": "EnterprisesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.enterprises.sendTestPushNotification":
-
-type EnterprisesSendTestPushNotificationCall struct {
- s *Service
- enterpriseId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SendTestPushNotification: Sends a test push notification to validate
-// the MDM integration with the Google Cloud Pub/Sub service for this
-// enterprise.
-func (r *EnterprisesService) SendTestPushNotification(enterpriseId string) *EnterprisesSendTestPushNotificationCall {
- c := &EnterprisesSendTestPushNotificationCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EnterprisesSendTestPushNotificationCall) Fields(s ...googleapi.Field) *EnterprisesSendTestPushNotificationCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EnterprisesSendTestPushNotificationCall) Context(ctx context.Context) *EnterprisesSendTestPushNotificationCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EnterprisesSendTestPushNotificationCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/sendTestPushNotification")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.enterprises.sendTestPushNotification" call.
-// Exactly one of *EnterprisesSendTestPushNotificationResponse or error
-// will be non-nil. Any non-2xx status code is an error. Response
-// headers are in either
-// *EnterprisesSendTestPushNotificationResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *EnterprisesSendTestPushNotificationCall) Do() (*EnterprisesSendTestPushNotificationResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EnterprisesSendTestPushNotificationResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sends a test push notification to validate the MDM integration with the Google Cloud Pub/Sub service for this enterprise.",
- // "httpMethod": "POST",
- // "id": "androidenterprise.enterprises.sendTestPushNotification",
- // "parameterOrder": [
- // "enterpriseId"
- // ],
- // "parameters": {
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/sendTestPushNotification",
- // "response": {
- // "$ref": "EnterprisesSendTestPushNotificationResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.enterprises.setAccount":
-
-type EnterprisesSetAccountCall struct {
- s *Service
- enterpriseId string
- enterpriseaccount *EnterpriseAccount
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetAccount: Set the account that will be used to authenticate to the
-// API as the enterprise.
-func (r *EnterprisesService) SetAccount(enterpriseId string, enterpriseaccount *EnterpriseAccount) *EnterprisesSetAccountCall {
- c := &EnterprisesSetAccountCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.enterpriseaccount = enterpriseaccount
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EnterprisesSetAccountCall) Fields(s ...googleapi.Field) *EnterprisesSetAccountCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EnterprisesSetAccountCall) Context(ctx context.Context) *EnterprisesSetAccountCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EnterprisesSetAccountCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.enterpriseaccount)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/account")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.enterprises.setAccount" call.
-// Exactly one of *EnterpriseAccount or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *EnterpriseAccount.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *EnterprisesSetAccountCall) Do() (*EnterpriseAccount, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EnterpriseAccount{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Set the account that will be used to authenticate to the API as the enterprise.",
- // "httpMethod": "PUT",
- // "id": "androidenterprise.enterprises.setAccount",
- // "parameterOrder": [
- // "enterpriseId"
- // ],
- // "parameters": {
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/account",
- // "request": {
- // "$ref": "EnterpriseAccount"
- // },
- // "response": {
- // "$ref": "EnterpriseAccount"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.enterprises.unenroll":
-
-type EnterprisesUnenrollCall struct {
- s *Service
- enterpriseId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Unenroll: Unenrolls an enterprise from the calling MDM.
-func (r *EnterprisesService) Unenroll(enterpriseId string) *EnterprisesUnenrollCall {
- c := &EnterprisesUnenrollCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EnterprisesUnenrollCall) Fields(s ...googleapi.Field) *EnterprisesUnenrollCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EnterprisesUnenrollCall) Context(ctx context.Context) *EnterprisesUnenrollCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EnterprisesUnenrollCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/unenroll")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.enterprises.unenroll" call.
-func (c *EnterprisesUnenrollCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Unenrolls an enterprise from the calling MDM.",
- // "httpMethod": "POST",
- // "id": "androidenterprise.enterprises.unenroll",
- // "parameterOrder": [
- // "enterpriseId"
- // ],
- // "parameters": {
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/unenroll",
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.entitlements.delete":
-
-type EntitlementsDeleteCall struct {
- s *Service
- enterpriseId string
- userId string
- entitlementId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Removes an entitlement to an app for a user and uninstalls
-// it.
-func (r *EntitlementsService) Delete(enterpriseId string, userId string, entitlementId string) *EntitlementsDeleteCall {
- c := &EntitlementsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.userId = userId
- c.entitlementId = entitlementId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EntitlementsDeleteCall) Fields(s ...googleapi.Field) *EntitlementsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EntitlementsDeleteCall) Context(ctx context.Context) *EntitlementsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EntitlementsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "userId": c.userId,
- "entitlementId": c.entitlementId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.entitlements.delete" call.
-func (c *EntitlementsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Removes an entitlement to an app for a user and uninstalls it.",
- // "httpMethod": "DELETE",
- // "id": "androidenterprise.entitlements.delete",
- // "parameterOrder": [
- // "enterpriseId",
- // "userId",
- // "entitlementId"
- // ],
- // "parameters": {
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "entitlementId": {
- // "description": "The ID of the entitlement, e.g. \"app:com.google.android.gm\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userId": {
- // "description": "The ID of the user.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.entitlements.get":
-
-type EntitlementsGetCall struct {
- s *Service
- enterpriseId string
- userId string
- entitlementId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves details of an entitlement.
-func (r *EntitlementsService) Get(enterpriseId string, userId string, entitlementId string) *EntitlementsGetCall {
- c := &EntitlementsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.userId = userId
- c.entitlementId = entitlementId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EntitlementsGetCall) Fields(s ...googleapi.Field) *EntitlementsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *EntitlementsGetCall) IfNoneMatch(entityTag string) *EntitlementsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EntitlementsGetCall) Context(ctx context.Context) *EntitlementsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EntitlementsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "userId": c.userId,
- "entitlementId": c.entitlementId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.entitlements.get" call.
-// Exactly one of *Entitlement or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Entitlement.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *EntitlementsGetCall) Do() (*Entitlement, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Entitlement{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves details of an entitlement.",
- // "httpMethod": "GET",
- // "id": "androidenterprise.entitlements.get",
- // "parameterOrder": [
- // "enterpriseId",
- // "userId",
- // "entitlementId"
- // ],
- // "parameters": {
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "entitlementId": {
- // "description": "The ID of the entitlement, e.g. \"app:com.google.android.gm\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userId": {
- // "description": "The ID of the user.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
- // "response": {
- // "$ref": "Entitlement"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.entitlements.list":
-
-type EntitlementsListCall struct {
- s *Service
- enterpriseId string
- userId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List of all entitlements for the specified user. Only the ID is
-// set.
-func (r *EntitlementsService) List(enterpriseId string, userId string) *EntitlementsListCall {
- c := &EntitlementsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.userId = userId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EntitlementsListCall) Fields(s ...googleapi.Field) *EntitlementsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *EntitlementsListCall) IfNoneMatch(entityTag string) *EntitlementsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EntitlementsListCall) Context(ctx context.Context) *EntitlementsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EntitlementsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/users/{userId}/entitlements")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "userId": c.userId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.entitlements.list" call.
-// Exactly one of *EntitlementsListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *EntitlementsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *EntitlementsListCall) Do() (*EntitlementsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EntitlementsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List of all entitlements for the specified user. Only the ID is set.",
- // "httpMethod": "GET",
- // "id": "androidenterprise.entitlements.list",
- // "parameterOrder": [
- // "enterpriseId",
- // "userId"
- // ],
- // "parameters": {
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userId": {
- // "description": "The ID of the user.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/users/{userId}/entitlements",
- // "response": {
- // "$ref": "EntitlementsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.entitlements.patch":
-
-type EntitlementsPatchCall struct {
- s *Service
- enterpriseId string
- userId string
- entitlementId string
- entitlement *Entitlement
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Adds or updates an entitlement to an app for a user. This
-// method supports patch semantics.
-func (r *EntitlementsService) Patch(enterpriseId string, userId string, entitlementId string, entitlement *Entitlement) *EntitlementsPatchCall {
- c := &EntitlementsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.userId = userId
- c.entitlementId = entitlementId
- c.entitlement = entitlement
- return c
-}
-
-// Install sets the optional parameter "install": Set to true to also
-// install the product on all the user's devices where possible. Failure
-// to install on one or more devices will not prevent this operation
-// from returning successfully, as long as the entitlement was
-// successfully assigned to the user.
-func (c *EntitlementsPatchCall) Install(install bool) *EntitlementsPatchCall {
- c.opt_["install"] = install
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EntitlementsPatchCall) Fields(s ...googleapi.Field) *EntitlementsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EntitlementsPatchCall) Context(ctx context.Context) *EntitlementsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EntitlementsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.entitlement)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["install"]; ok {
- params.Set("install", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "userId": c.userId,
- "entitlementId": c.entitlementId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.entitlements.patch" call.
-// Exactly one of *Entitlement or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Entitlement.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *EntitlementsPatchCall) Do() (*Entitlement, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Entitlement{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Adds or updates an entitlement to an app for a user. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "androidenterprise.entitlements.patch",
- // "parameterOrder": [
- // "enterpriseId",
- // "userId",
- // "entitlementId"
- // ],
- // "parameters": {
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "entitlementId": {
- // "description": "The ID of the entitlement, e.g. \"app:com.google.android.gm\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "install": {
- // "description": "Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "userId": {
- // "description": "The ID of the user.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
- // "request": {
- // "$ref": "Entitlement"
- // },
- // "response": {
- // "$ref": "Entitlement"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.entitlements.update":
-
-type EntitlementsUpdateCall struct {
- s *Service
- enterpriseId string
- userId string
- entitlementId string
- entitlement *Entitlement
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Adds or updates an entitlement to an app for a user.
-func (r *EntitlementsService) Update(enterpriseId string, userId string, entitlementId string, entitlement *Entitlement) *EntitlementsUpdateCall {
- c := &EntitlementsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.userId = userId
- c.entitlementId = entitlementId
- c.entitlement = entitlement
- return c
-}
-
-// Install sets the optional parameter "install": Set to true to also
-// install the product on all the user's devices where possible. Failure
-// to install on one or more devices will not prevent this operation
-// from returning successfully, as long as the entitlement was
-// successfully assigned to the user.
-func (c *EntitlementsUpdateCall) Install(install bool) *EntitlementsUpdateCall {
- c.opt_["install"] = install
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EntitlementsUpdateCall) Fields(s ...googleapi.Field) *EntitlementsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EntitlementsUpdateCall) Context(ctx context.Context) *EntitlementsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EntitlementsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.entitlement)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["install"]; ok {
- params.Set("install", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "userId": c.userId,
- "entitlementId": c.entitlementId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.entitlements.update" call.
-// Exactly one of *Entitlement or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Entitlement.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *EntitlementsUpdateCall) Do() (*Entitlement, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Entitlement{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Adds or updates an entitlement to an app for a user.",
- // "httpMethod": "PUT",
- // "id": "androidenterprise.entitlements.update",
- // "parameterOrder": [
- // "enterpriseId",
- // "userId",
- // "entitlementId"
- // ],
- // "parameters": {
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "entitlementId": {
- // "description": "The ID of the entitlement, e.g. \"app:com.google.android.gm\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "install": {
- // "description": "Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "userId": {
- // "description": "The ID of the user.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
- // "request": {
- // "$ref": "Entitlement"
- // },
- // "response": {
- // "$ref": "Entitlement"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.grouplicenses.get":
-
-type GrouplicensesGetCall struct {
- s *Service
- enterpriseId string
- groupLicenseId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves details of an enterprise's group license for a
-// product.
-func (r *GrouplicensesService) Get(enterpriseId string, groupLicenseId string) *GrouplicensesGetCall {
- c := &GrouplicensesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.groupLicenseId = groupLicenseId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GrouplicensesGetCall) Fields(s ...googleapi.Field) *GrouplicensesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GrouplicensesGetCall) IfNoneMatch(entityTag string) *GrouplicensesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GrouplicensesGetCall) Context(ctx context.Context) *GrouplicensesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GrouplicensesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "groupLicenseId": c.groupLicenseId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.grouplicenses.get" call.
-// Exactly one of *GroupLicense or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *GroupLicense.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GrouplicensesGetCall) Do() (*GroupLicense, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &GroupLicense{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves details of an enterprise's group license for a product.",
- // "httpMethod": "GET",
- // "id": "androidenterprise.grouplicenses.get",
- // "parameterOrder": [
- // "enterpriseId",
- // "groupLicenseId"
- // ],
- // "parameters": {
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "groupLicenseId": {
- // "description": "The ID of the product the group license is for, e.g. \"app:com.google.android.gm\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}",
- // "response": {
- // "$ref": "GroupLicense"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.grouplicenses.list":
-
-type GrouplicensesListCall struct {
- s *Service
- enterpriseId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves IDs of all products for which the enterprise has a
-// group license.
-func (r *GrouplicensesService) List(enterpriseId string) *GrouplicensesListCall {
- c := &GrouplicensesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GrouplicensesListCall) Fields(s ...googleapi.Field) *GrouplicensesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GrouplicensesListCall) IfNoneMatch(entityTag string) *GrouplicensesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GrouplicensesListCall) Context(ctx context.Context) *GrouplicensesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GrouplicensesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/groupLicenses")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.grouplicenses.list" call.
-// Exactly one of *GroupLicensesListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *GroupLicensesListResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *GrouplicensesListCall) Do() (*GroupLicensesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &GroupLicensesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves IDs of all products for which the enterprise has a group license.",
- // "httpMethod": "GET",
- // "id": "androidenterprise.grouplicenses.list",
- // "parameterOrder": [
- // "enterpriseId"
- // ],
- // "parameters": {
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/groupLicenses",
- // "response": {
- // "$ref": "GroupLicensesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.grouplicenseusers.list":
-
-type GrouplicenseusersListCall struct {
- s *Service
- enterpriseId string
- groupLicenseId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the IDs of the users who have been granted
-// entitlements under the license.
-func (r *GrouplicenseusersService) List(enterpriseId string, groupLicenseId string) *GrouplicenseusersListCall {
- c := &GrouplicenseusersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.groupLicenseId = groupLicenseId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GrouplicenseusersListCall) Fields(s ...googleapi.Field) *GrouplicenseusersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GrouplicenseusersListCall) IfNoneMatch(entityTag string) *GrouplicenseusersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GrouplicenseusersListCall) Context(ctx context.Context) *GrouplicenseusersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GrouplicenseusersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}/users")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "groupLicenseId": c.groupLicenseId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.grouplicenseusers.list" call.
-// Exactly one of *GroupLicenseUsersListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *GroupLicenseUsersListResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *GrouplicenseusersListCall) Do() (*GroupLicenseUsersListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &GroupLicenseUsersListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the IDs of the users who have been granted entitlements under the license.",
- // "httpMethod": "GET",
- // "id": "androidenterprise.grouplicenseusers.list",
- // "parameterOrder": [
- // "enterpriseId",
- // "groupLicenseId"
- // ],
- // "parameters": {
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "groupLicenseId": {
- // "description": "The ID of the product the group license is for, e.g. \"app:com.google.android.gm\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}/users",
- // "response": {
- // "$ref": "GroupLicenseUsersListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.installs.delete":
-
-type InstallsDeleteCall struct {
- s *Service
- enterpriseId string
- userId string
- deviceId string
- installId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Requests to remove an app from a device. A call to get or
-// list will still show the app as installed on the device until it is
-// actually removed.
-func (r *InstallsService) Delete(enterpriseId string, userId string, deviceId string, installId string) *InstallsDeleteCall {
- c := &InstallsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.userId = userId
- c.deviceId = deviceId
- c.installId = installId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstallsDeleteCall) Fields(s ...googleapi.Field) *InstallsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstallsDeleteCall) Context(ctx context.Context) *InstallsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstallsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "userId": c.userId,
- "deviceId": c.deviceId,
- "installId": c.installId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.installs.delete" call.
-func (c *InstallsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Requests to remove an app from a device. A call to get or list will still show the app as installed on the device until it is actually removed.",
- // "httpMethod": "DELETE",
- // "id": "androidenterprise.installs.delete",
- // "parameterOrder": [
- // "enterpriseId",
- // "userId",
- // "deviceId",
- // "installId"
- // ],
- // "parameters": {
- // "deviceId": {
- // "description": "The Android ID of the device.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "installId": {
- // "description": "The ID of the product represented by the install, e.g. \"app:com.google.android.gm\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userId": {
- // "description": "The ID of the user.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.installs.get":
-
-type InstallsGetCall struct {
- s *Service
- enterpriseId string
- userId string
- deviceId string
- installId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves details of an installation of an app on a device.
-func (r *InstallsService) Get(enterpriseId string, userId string, deviceId string, installId string) *InstallsGetCall {
- c := &InstallsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.userId = userId
- c.deviceId = deviceId
- c.installId = installId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstallsGetCall) Fields(s ...googleapi.Field) *InstallsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InstallsGetCall) IfNoneMatch(entityTag string) *InstallsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstallsGetCall) Context(ctx context.Context) *InstallsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstallsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "userId": c.userId,
- "deviceId": c.deviceId,
- "installId": c.installId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.installs.get" call.
-// Exactly one of *Install or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Install.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *InstallsGetCall) Do() (*Install, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Install{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves details of an installation of an app on a device.",
- // "httpMethod": "GET",
- // "id": "androidenterprise.installs.get",
- // "parameterOrder": [
- // "enterpriseId",
- // "userId",
- // "deviceId",
- // "installId"
- // ],
- // "parameters": {
- // "deviceId": {
- // "description": "The Android ID of the device.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "installId": {
- // "description": "The ID of the product represented by the install, e.g. \"app:com.google.android.gm\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userId": {
- // "description": "The ID of the user.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
- // "response": {
- // "$ref": "Install"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.installs.list":
-
-type InstallsListCall struct {
- s *Service
- enterpriseId string
- userId string
- deviceId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the details of all apps installed on the specified
-// device.
-func (r *InstallsService) List(enterpriseId string, userId string, deviceId string) *InstallsListCall {
- c := &InstallsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.userId = userId
- c.deviceId = deviceId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstallsListCall) Fields(s ...googleapi.Field) *InstallsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InstallsListCall) IfNoneMatch(entityTag string) *InstallsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstallsListCall) Context(ctx context.Context) *InstallsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstallsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "userId": c.userId,
- "deviceId": c.deviceId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.installs.list" call.
-// Exactly one of *InstallsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *InstallsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InstallsListCall) Do() (*InstallsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InstallsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the details of all apps installed on the specified device.",
- // "httpMethod": "GET",
- // "id": "androidenterprise.installs.list",
- // "parameterOrder": [
- // "enterpriseId",
- // "userId",
- // "deviceId"
- // ],
- // "parameters": {
- // "deviceId": {
- // "description": "The Android ID of the device.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userId": {
- // "description": "The ID of the user.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs",
- // "response": {
- // "$ref": "InstallsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.installs.patch":
-
-type InstallsPatchCall struct {
- s *Service
- enterpriseId string
- userId string
- deviceId string
- installId string
- install *Install
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Requests to install the latest version of an app to a device.
-// If the app is already installed then it is updated to the latest
-// version if necessary. This method supports patch semantics.
-func (r *InstallsService) Patch(enterpriseId string, userId string, deviceId string, installId string, install *Install) *InstallsPatchCall {
- c := &InstallsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.userId = userId
- c.deviceId = deviceId
- c.installId = installId
- c.install = install
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstallsPatchCall) Fields(s ...googleapi.Field) *InstallsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstallsPatchCall) Context(ctx context.Context) *InstallsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstallsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.install)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "userId": c.userId,
- "deviceId": c.deviceId,
- "installId": c.installId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.installs.patch" call.
-// Exactly one of *Install or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Install.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *InstallsPatchCall) Do() (*Install, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Install{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Requests to install the latest version of an app to a device. If the app is already installed then it is updated to the latest version if necessary. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "androidenterprise.installs.patch",
- // "parameterOrder": [
- // "enterpriseId",
- // "userId",
- // "deviceId",
- // "installId"
- // ],
- // "parameters": {
- // "deviceId": {
- // "description": "The Android ID of the device.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "installId": {
- // "description": "The ID of the product represented by the install, e.g. \"app:com.google.android.gm\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userId": {
- // "description": "The ID of the user.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
- // "request": {
- // "$ref": "Install"
- // },
- // "response": {
- // "$ref": "Install"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.installs.update":
-
-type InstallsUpdateCall struct {
- s *Service
- enterpriseId string
- userId string
- deviceId string
- installId string
- install *Install
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Requests to install the latest version of an app to a device.
-// If the app is already installed then it is updated to the latest
-// version if necessary.
-func (r *InstallsService) Update(enterpriseId string, userId string, deviceId string, installId string, install *Install) *InstallsUpdateCall {
- c := &InstallsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.userId = userId
- c.deviceId = deviceId
- c.installId = installId
- c.install = install
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstallsUpdateCall) Fields(s ...googleapi.Field) *InstallsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstallsUpdateCall) Context(ctx context.Context) *InstallsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstallsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.install)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "userId": c.userId,
- "deviceId": c.deviceId,
- "installId": c.installId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.installs.update" call.
-// Exactly one of *Install or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Install.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *InstallsUpdateCall) Do() (*Install, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Install{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Requests to install the latest version of an app to a device. If the app is already installed then it is updated to the latest version if necessary.",
- // "httpMethod": "PUT",
- // "id": "androidenterprise.installs.update",
- // "parameterOrder": [
- // "enterpriseId",
- // "userId",
- // "deviceId",
- // "installId"
- // ],
- // "parameters": {
- // "deviceId": {
- // "description": "The Android ID of the device.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "installId": {
- // "description": "The ID of the product represented by the install, e.g. \"app:com.google.android.gm\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userId": {
- // "description": "The ID of the user.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
- // "request": {
- // "$ref": "Install"
- // },
- // "response": {
- // "$ref": "Install"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.permissions.get":
-
-type PermissionsGetCall struct {
- s *Service
- permissionId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves details of an Android app permission for display to an
-// enterprise admin.
-func (r *PermissionsService) Get(permissionId string) *PermissionsGetCall {
- c := &PermissionsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.permissionId = permissionId
- return c
-}
-
-// Language sets the optional parameter "language": The BCP47 tag for
-// the user's preferred language (e.g. "en-US", "de")
-func (c *PermissionsGetCall) Language(language string) *PermissionsGetCall {
- c.opt_["language"] = language
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PermissionsGetCall) Fields(s ...googleapi.Field) *PermissionsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PermissionsGetCall) IfNoneMatch(entityTag string) *PermissionsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PermissionsGetCall) Context(ctx context.Context) *PermissionsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PermissionsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["language"]; ok {
- params.Set("language", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "permissions/{permissionId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "permissionId": c.permissionId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.permissions.get" call.
-// Exactly one of *Permission or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Permission.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *PermissionsGetCall) Do() (*Permission, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Permission{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves details of an Android app permission for display to an enterprise admin.",
- // "httpMethod": "GET",
- // "id": "androidenterprise.permissions.get",
- // "parameterOrder": [
- // "permissionId"
- // ],
- // "parameters": {
- // "language": {
- // "description": "The BCP47 tag for the user's preferred language (e.g. \"en-US\", \"de\")",
- // "location": "query",
- // "type": "string"
- // },
- // "permissionId": {
- // "description": "The ID of the permission.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "permissions/{permissionId}",
- // "response": {
- // "$ref": "Permission"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.products.approve":
-
-type ProductsApproveCall struct {
- s *Service
- enterpriseId string
- productId string
- productsapproverequest *ProductsApproveRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Approve: Approves the specified product (and the relevant app
-// permissions, if any).
-func (r *ProductsService) Approve(enterpriseId string, productId string, productsapproverequest *ProductsApproveRequest) *ProductsApproveCall {
- c := &ProductsApproveCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.productId = productId
- c.productsapproverequest = productsapproverequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProductsApproveCall) Fields(s ...googleapi.Field) *ProductsApproveCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProductsApproveCall) Context(ctx context.Context) *ProductsApproveCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProductsApproveCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.productsapproverequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/products/{productId}/approve")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "productId": c.productId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.products.approve" call.
-func (c *ProductsApproveCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Approves the specified product (and the relevant app permissions, if any).",
- // "httpMethod": "POST",
- // "id": "androidenterprise.products.approve",
- // "parameterOrder": [
- // "enterpriseId",
- // "productId"
- // ],
- // "parameters": {
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "productId": {
- // "description": "The ID of the product.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/products/{productId}/approve",
- // "request": {
- // "$ref": "ProductsApproveRequest"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.products.generateApprovalUrl":
-
-type ProductsGenerateApprovalUrlCall struct {
- s *Service
- enterpriseId string
- productId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GenerateApprovalUrl: Generates a URL that can be rendered in an
-// iframe to display the permissions (if any) of a product. An
-// enterprise admin must view these permissions and accept them on
-// behalf of their organization in order to approve that
-// product.
-//
-// Admins should accept the displayed permissions by interacting with a
-// separate UI element in the EMM console, which in turn should trigger
-// the use of this URL as the approvalUrlInfo.approvalUrl property in a
-// Products.approve call to approve the product. This URL can only be
-// used to display permissions for up to 1 day.
-func (r *ProductsService) GenerateApprovalUrl(enterpriseId string, productId string) *ProductsGenerateApprovalUrlCall {
- c := &ProductsGenerateApprovalUrlCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.productId = productId
- return c
-}
-
-// LanguageCode sets the optional parameter "languageCode": The BCP 47
-// language code used for permission names and descriptions in the
-// returned iframe, for instance "en-US".
-func (c *ProductsGenerateApprovalUrlCall) LanguageCode(languageCode string) *ProductsGenerateApprovalUrlCall {
- c.opt_["languageCode"] = languageCode
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProductsGenerateApprovalUrlCall) Fields(s ...googleapi.Field) *ProductsGenerateApprovalUrlCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProductsGenerateApprovalUrlCall) Context(ctx context.Context) *ProductsGenerateApprovalUrlCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProductsGenerateApprovalUrlCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["languageCode"]; ok {
- params.Set("languageCode", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/products/{productId}/generateApprovalUrl")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "productId": c.productId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.products.generateApprovalUrl" call.
-// Exactly one of *ProductsGenerateApprovalUrlResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *ProductsGenerateApprovalUrlResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *ProductsGenerateApprovalUrlCall) Do() (*ProductsGenerateApprovalUrlResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ProductsGenerateApprovalUrlResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Generates a URL that can be rendered in an iframe to display the permissions (if any) of a product. An enterprise admin must view these permissions and accept them on behalf of their organization in order to approve that product.\n\nAdmins should accept the displayed permissions by interacting with a separate UI element in the EMM console, which in turn should trigger the use of this URL as the approvalUrlInfo.approvalUrl property in a Products.approve call to approve the product. This URL can only be used to display permissions for up to 1 day.",
- // "httpMethod": "POST",
- // "id": "androidenterprise.products.generateApprovalUrl",
- // "parameterOrder": [
- // "enterpriseId",
- // "productId"
- // ],
- // "parameters": {
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "languageCode": {
- // "description": "The BCP 47 language code used for permission names and descriptions in the returned iframe, for instance \"en-US\".",
- // "location": "query",
- // "type": "string"
- // },
- // "productId": {
- // "description": "The ID of the product.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/products/{productId}/generateApprovalUrl",
- // "response": {
- // "$ref": "ProductsGenerateApprovalUrlResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.products.get":
-
-type ProductsGetCall struct {
- s *Service
- enterpriseId string
- productId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves details of a product for display to an enterprise
-// admin.
-func (r *ProductsService) Get(enterpriseId string, productId string) *ProductsGetCall {
- c := &ProductsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.productId = productId
- return c
-}
-
-// Language sets the optional parameter "language": The BCP47 tag for
-// the user's preferred language (e.g. "en-US", "de").
-func (c *ProductsGetCall) Language(language string) *ProductsGetCall {
- c.opt_["language"] = language
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProductsGetCall) Fields(s ...googleapi.Field) *ProductsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ProductsGetCall) IfNoneMatch(entityTag string) *ProductsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProductsGetCall) Context(ctx context.Context) *ProductsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProductsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["language"]; ok {
- params.Set("language", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/products/{productId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "productId": c.productId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.products.get" call.
-// Exactly one of *Product or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Product.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ProductsGetCall) Do() (*Product, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Product{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves details of a product for display to an enterprise admin.",
- // "httpMethod": "GET",
- // "id": "androidenterprise.products.get",
- // "parameterOrder": [
- // "enterpriseId",
- // "productId"
- // ],
- // "parameters": {
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "language": {
- // "description": "The BCP47 tag for the user's preferred language (e.g. \"en-US\", \"de\").",
- // "location": "query",
- // "type": "string"
- // },
- // "productId": {
- // "description": "The ID of the product, e.g. \"app:com.google.android.gm\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/products/{productId}",
- // "response": {
- // "$ref": "Product"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.products.getAppRestrictionsSchema":
-
-type ProductsGetAppRestrictionsSchemaCall struct {
- s *Service
- enterpriseId string
- productId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetAppRestrictionsSchema: Retrieves the schema defining app
-// restrictions configurable for this product. All products have a
-// schema, but this may be empty if no app restrictions are defined.
-func (r *ProductsService) GetAppRestrictionsSchema(enterpriseId string, productId string) *ProductsGetAppRestrictionsSchemaCall {
- c := &ProductsGetAppRestrictionsSchemaCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.productId = productId
- return c
-}
-
-// Language sets the optional parameter "language": The BCP47 tag for
-// the user's preferred language (e.g. "en-US", "de").
-func (c *ProductsGetAppRestrictionsSchemaCall) Language(language string) *ProductsGetAppRestrictionsSchemaCall {
- c.opt_["language"] = language
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProductsGetAppRestrictionsSchemaCall) Fields(s ...googleapi.Field) *ProductsGetAppRestrictionsSchemaCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ProductsGetAppRestrictionsSchemaCall) IfNoneMatch(entityTag string) *ProductsGetAppRestrictionsSchemaCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProductsGetAppRestrictionsSchemaCall) Context(ctx context.Context) *ProductsGetAppRestrictionsSchemaCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProductsGetAppRestrictionsSchemaCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["language"]; ok {
- params.Set("language", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/products/{productId}/appRestrictionsSchema")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "productId": c.productId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.products.getAppRestrictionsSchema" call.
-// Exactly one of *AppRestrictionsSchema or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AppRestrictionsSchema.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ProductsGetAppRestrictionsSchemaCall) Do() (*AppRestrictionsSchema, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AppRestrictionsSchema{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the schema defining app restrictions configurable for this product. All products have a schema, but this may be empty if no app restrictions are defined.",
- // "httpMethod": "GET",
- // "id": "androidenterprise.products.getAppRestrictionsSchema",
- // "parameterOrder": [
- // "enterpriseId",
- // "productId"
- // ],
- // "parameters": {
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "language": {
- // "description": "The BCP47 tag for the user's preferred language (e.g. \"en-US\", \"de\").",
- // "location": "query",
- // "type": "string"
- // },
- // "productId": {
- // "description": "The ID of the product.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/products/{productId}/appRestrictionsSchema",
- // "response": {
- // "$ref": "AppRestrictionsSchema"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.products.getPermissions":
-
-type ProductsGetPermissionsCall struct {
- s *Service
- enterpriseId string
- productId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetPermissions: Retrieves the Android app permissions required by
-// this app.
-func (r *ProductsService) GetPermissions(enterpriseId string, productId string) *ProductsGetPermissionsCall {
- c := &ProductsGetPermissionsCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.productId = productId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProductsGetPermissionsCall) Fields(s ...googleapi.Field) *ProductsGetPermissionsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ProductsGetPermissionsCall) IfNoneMatch(entityTag string) *ProductsGetPermissionsCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProductsGetPermissionsCall) Context(ctx context.Context) *ProductsGetPermissionsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProductsGetPermissionsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/products/{productId}/permissions")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "productId": c.productId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.products.getPermissions" call.
-// Exactly one of *ProductPermissions or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ProductPermissions.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ProductsGetPermissionsCall) Do() (*ProductPermissions, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ProductPermissions{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the Android app permissions required by this app.",
- // "httpMethod": "GET",
- // "id": "androidenterprise.products.getPermissions",
- // "parameterOrder": [
- // "enterpriseId",
- // "productId"
- // ],
- // "parameters": {
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "productId": {
- // "description": "The ID of the product.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/products/{productId}/permissions",
- // "response": {
- // "$ref": "ProductPermissions"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.products.updatePermissions":
-
-type ProductsUpdatePermissionsCall struct {
- s *Service
- enterpriseId string
- productId string
- productpermissions *ProductPermissions
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// UpdatePermissions: Updates the set of Android app permissions for
-// this app that have been accepted by the enterprise.
-func (r *ProductsService) UpdatePermissions(enterpriseId string, productId string, productpermissions *ProductPermissions) *ProductsUpdatePermissionsCall {
- c := &ProductsUpdatePermissionsCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.productId = productId
- c.productpermissions = productpermissions
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProductsUpdatePermissionsCall) Fields(s ...googleapi.Field) *ProductsUpdatePermissionsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProductsUpdatePermissionsCall) Context(ctx context.Context) *ProductsUpdatePermissionsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProductsUpdatePermissionsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.productpermissions)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/products/{productId}/permissions")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "productId": c.productId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.products.updatePermissions" call.
-// Exactly one of *ProductPermissions or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ProductPermissions.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ProductsUpdatePermissionsCall) Do() (*ProductPermissions, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ProductPermissions{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates the set of Android app permissions for this app that have been accepted by the enterprise.",
- // "httpMethod": "PUT",
- // "id": "androidenterprise.products.updatePermissions",
- // "parameterOrder": [
- // "enterpriseId",
- // "productId"
- // ],
- // "parameters": {
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "productId": {
- // "description": "The ID of the product.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/products/{productId}/permissions",
- // "request": {
- // "$ref": "ProductPermissions"
- // },
- // "response": {
- // "$ref": "ProductPermissions"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.users.generateToken":
-
-type UsersGenerateTokenCall struct {
- s *Service
- enterpriseId string
- userId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GenerateToken: Generates a token (activation code) to allow this user
-// to configure their work account in the Android Setup Wizard. Revokes
-// any previously generated token.
-func (r *UsersService) GenerateToken(enterpriseId string, userId string) *UsersGenerateTokenCall {
- c := &UsersGenerateTokenCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.userId = userId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersGenerateTokenCall) Fields(s ...googleapi.Field) *UsersGenerateTokenCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersGenerateTokenCall) Context(ctx context.Context) *UsersGenerateTokenCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersGenerateTokenCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/users/{userId}/token")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "userId": c.userId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.users.generateToken" call.
-// Exactly one of *UserToken or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UserToken.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UsersGenerateTokenCall) Do() (*UserToken, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserToken{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Generates a token (activation code) to allow this user to configure their work account in the Android Setup Wizard. Revokes any previously generated token.",
- // "httpMethod": "POST",
- // "id": "androidenterprise.users.generateToken",
- // "parameterOrder": [
- // "enterpriseId",
- // "userId"
- // ],
- // "parameters": {
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userId": {
- // "description": "The ID of the user.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/users/{userId}/token",
- // "response": {
- // "$ref": "UserToken"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.users.get":
-
-type UsersGetCall struct {
- s *Service
- enterpriseId string
- userId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves a user's details.
-func (r *UsersService) Get(enterpriseId string, userId string) *UsersGetCall {
- c := &UsersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.userId = userId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersGetCall) Fields(s ...googleapi.Field) *UsersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UsersGetCall) IfNoneMatch(entityTag string) *UsersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersGetCall) Context(ctx context.Context) *UsersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/users/{userId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "userId": c.userId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.users.get" call.
-// Exactly one of *User or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *User.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *UsersGetCall) Do() (*User, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &User{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a user's details.",
- // "httpMethod": "GET",
- // "id": "androidenterprise.users.get",
- // "parameterOrder": [
- // "enterpriseId",
- // "userId"
- // ],
- // "parameters": {
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userId": {
- // "description": "The ID of the user.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/users/{userId}",
- // "response": {
- // "$ref": "User"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.users.getAvailableProductSet":
-
-type UsersGetAvailableProductSetCall struct {
- s *Service
- enterpriseId string
- userId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetAvailableProductSet: Retrieves the set of products a user is
-// entitled to access.
-func (r *UsersService) GetAvailableProductSet(enterpriseId string, userId string) *UsersGetAvailableProductSetCall {
- c := &UsersGetAvailableProductSetCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.userId = userId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersGetAvailableProductSetCall) Fields(s ...googleapi.Field) *UsersGetAvailableProductSetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UsersGetAvailableProductSetCall) IfNoneMatch(entityTag string) *UsersGetAvailableProductSetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersGetAvailableProductSetCall) Context(ctx context.Context) *UsersGetAvailableProductSetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersGetAvailableProductSetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/users/{userId}/availableProductSet")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "userId": c.userId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.users.getAvailableProductSet" call.
-// Exactly one of *ProductSet or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ProductSet.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UsersGetAvailableProductSetCall) Do() (*ProductSet, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ProductSet{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the set of products a user is entitled to access.",
- // "httpMethod": "GET",
- // "id": "androidenterprise.users.getAvailableProductSet",
- // "parameterOrder": [
- // "enterpriseId",
- // "userId"
- // ],
- // "parameters": {
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userId": {
- // "description": "The ID of the user.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/users/{userId}/availableProductSet",
- // "response": {
- // "$ref": "ProductSet"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.users.list":
-
-type UsersListCall struct {
- s *Service
- enterpriseId string
- email string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Looks up a user by email address.
-func (r *UsersService) List(enterpriseId string, email string) *UsersListCall {
- c := &UsersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.email = email
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersListCall) Fields(s ...googleapi.Field) *UsersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UsersListCall) IfNoneMatch(entityTag string) *UsersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersListCall) Context(ctx context.Context) *UsersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("email", fmt.Sprintf("%v", c.email))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/users")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.users.list" call.
-// Exactly one of *UsersListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *UsersListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *UsersListCall) Do() (*UsersListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UsersListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Looks up a user by email address.",
- // "httpMethod": "GET",
- // "id": "androidenterprise.users.list",
- // "parameterOrder": [
- // "enterpriseId",
- // "email"
- // ],
- // "parameters": {
- // "email": {
- // "description": "The exact primary email address of the user to look up.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/users",
- // "response": {
- // "$ref": "UsersListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.users.revokeToken":
-
-type UsersRevokeTokenCall struct {
- s *Service
- enterpriseId string
- userId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// RevokeToken: Revokes a previously generated token (activation code)
-// for the user.
-func (r *UsersService) RevokeToken(enterpriseId string, userId string) *UsersRevokeTokenCall {
- c := &UsersRevokeTokenCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.userId = userId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersRevokeTokenCall) Fields(s ...googleapi.Field) *UsersRevokeTokenCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersRevokeTokenCall) Context(ctx context.Context) *UsersRevokeTokenCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersRevokeTokenCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/users/{userId}/token")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "userId": c.userId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.users.revokeToken" call.
-func (c *UsersRevokeTokenCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Revokes a previously generated token (activation code) for the user.",
- // "httpMethod": "DELETE",
- // "id": "androidenterprise.users.revokeToken",
- // "parameterOrder": [
- // "enterpriseId",
- // "userId"
- // ],
- // "parameters": {
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userId": {
- // "description": "The ID of the user.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/users/{userId}/token",
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
-
-// method id "androidenterprise.users.setAvailableProductSet":
-
-type UsersSetAvailableProductSetCall struct {
- s *Service
- enterpriseId string
- userId string
- productset *ProductSet
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetAvailableProductSet: Modifies the set of products a user is
-// entitled to access.
-func (r *UsersService) SetAvailableProductSet(enterpriseId string, userId string, productset *ProductSet) *UsersSetAvailableProductSetCall {
- c := &UsersSetAvailableProductSetCall{s: r.s, opt_: make(map[string]interface{})}
- c.enterpriseId = enterpriseId
- c.userId = userId
- c.productset = productset
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersSetAvailableProductSetCall) Fields(s ...googleapi.Field) *UsersSetAvailableProductSetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersSetAvailableProductSetCall) Context(ctx context.Context) *UsersSetAvailableProductSetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersSetAvailableProductSetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.productset)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "enterprises/{enterpriseId}/users/{userId}/availableProductSet")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "enterpriseId": c.enterpriseId,
- "userId": c.userId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidenterprise.users.setAvailableProductSet" call.
-// Exactly one of *ProductSet or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ProductSet.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UsersSetAvailableProductSetCall) Do() (*ProductSet, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ProductSet{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Modifies the set of products a user is entitled to access.",
- // "httpMethod": "PUT",
- // "id": "androidenterprise.users.setAvailableProductSet",
- // "parameterOrder": [
- // "enterpriseId",
- // "userId"
- // ],
- // "parameters": {
- // "enterpriseId": {
- // "description": "The ID of the enterprise.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userId": {
- // "description": "The ID of the user.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "enterprises/{enterpriseId}/users/{userId}/availableProductSet",
- // "request": {
- // "$ref": "ProductSet"
- // },
- // "response": {
- // "$ref": "ProductSet"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidenterprise"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/androidpublisher/v1.1/androidpublisher-api.json b/vendor/google.golang.org/api/androidpublisher/v1.1/androidpublisher-api.json
deleted file mode 100644
index 372070cc..00000000
--- a/vendor/google.golang.org/api/androidpublisher/v1.1/androidpublisher-api.json
+++ /dev/null
@@ -1,256 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/yLZNoMooQ7qHvZwtvucNfre7PCU\"",
- "discoveryVersion": "v1",
- "id": "androidpublisher:v1.1",
- "name": "androidpublisher",
- "canonicalName": "Android Publisher",
- "version": "v1.1",
- "revision": "20150323",
- "title": "Google Play Developer API",
- "description": "Lets Android application developers access their Google Play accounts.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/android-16.png",
- "x32": "https://www.google.com/images/icons/product/android-32.png"
- },
- "documentationLink": "https://developers.google.com/android-publisher",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/androidpublisher/v1.1/applications/",
- "basePath": "/androidpublisher/v1.1/applications/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "androidpublisher/v1.1/applications/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/androidpublisher": {
- "description": "View and manage your Google Play Developer account"
- }
- }
- }
- },
- "schemas": {
- "InappPurchase": {
- "id": "InappPurchase",
- "type": "object",
- "description": "An InappPurchase resource indicates the status of a user's inapp product purchase.",
- "properties": {
- "consumptionState": {
- "type": "integer",
- "description": "The consumption state of the inapp product. Possible values are: \n- Yet to be consumed \n- Consumed",
- "format": "int32"
- },
- "developerPayload": {
- "type": "string",
- "description": "A developer-specified string that contains supplemental information about an order."
- },
- "kind": {
- "type": "string",
- "description": "This kind represents an inappPurchase object in the androidpublisher service.",
- "default": "androidpublisher#inappPurchase"
- },
- "purchaseState": {
- "type": "integer",
- "description": "The purchase state of the order. Possible values are: \n- Purchased \n- Cancelled",
- "format": "int32"
- },
- "purchaseTime": {
- "type": "string",
- "description": "The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970).",
- "format": "int64"
- }
- }
- },
- "SubscriptionPurchase": {
- "id": "SubscriptionPurchase",
- "type": "object",
- "description": "A SubscriptionPurchase resource indicates the status of a user's subscription purchase.",
- "properties": {
- "autoRenewing": {
- "type": "boolean",
- "description": "Whether the subscription will automatically be renewed when it reaches its current expiry time."
- },
- "initiationTimestampMsec": {
- "type": "string",
- "description": "Time at which the subscription was granted, in milliseconds since Epoch.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "This kind represents a subscriptionPurchase object in the androidpublisher service.",
- "default": "androidpublisher#subscriptionPurchase"
- },
- "validUntilTimestampMsec": {
- "type": "string",
- "description": "Time at which the subscription will expire, in milliseconds since Epoch.",
- "format": "int64"
- }
- }
- }
- },
- "resources": {
- "inapppurchases": {
- "methods": {
- "get": {
- "id": "androidpublisher.inapppurchases.get",
- "path": "{packageName}/inapp/{productId}/purchases/{token}",
- "httpMethod": "GET",
- "description": "Checks the purchase and consumption status of an inapp item.",
- "parameters": {
- "packageName": {
- "type": "string",
- "description": "The package name of the application the inapp product was sold in (for example, 'com.some.thing').",
- "required": true,
- "location": "path"
- },
- "productId": {
- "type": "string",
- "description": "The inapp product SKU (for example, 'com.some.thing.inapp1').",
- "required": true,
- "location": "path"
- },
- "token": {
- "type": "string",
- "description": "The token provided to the user's device when the inapp product was purchased.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "productId",
- "token"
- ],
- "response": {
- "$ref": "InappPurchase"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- }
- }
- },
- "purchases": {
- "methods": {
- "cancel": {
- "id": "androidpublisher.purchases.cancel",
- "path": "{packageName}/subscriptions/{subscriptionId}/purchases/{token}/cancel",
- "httpMethod": "POST",
- "description": "Cancels a user's subscription purchase. The subscription remains valid until its expiration time.",
- "parameters": {
- "packageName": {
- "type": "string",
- "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
- "required": true,
- "location": "path"
- },
- "subscriptionId": {
- "type": "string",
- "description": "The purchased subscription ID (for example, 'monthly001').",
- "required": true,
- "location": "path"
- },
- "token": {
- "type": "string",
- "description": "The token provided to the user's device when the subscription was purchased.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "subscriptionId",
- "token"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "get": {
- "id": "androidpublisher.purchases.get",
- "path": "{packageName}/subscriptions/{subscriptionId}/purchases/{token}",
- "httpMethod": "GET",
- "description": "Checks whether a user's subscription purchase is valid and returns its expiry time.",
- "parameters": {
- "packageName": {
- "type": "string",
- "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
- "required": true,
- "location": "path"
- },
- "subscriptionId": {
- "type": "string",
- "description": "The purchased subscription ID (for example, 'monthly001').",
- "required": true,
- "location": "path"
- },
- "token": {
- "type": "string",
- "description": "The token provided to the user's device when the subscription was purchased.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "subscriptionId",
- "token"
- ],
- "response": {
- "$ref": "SubscriptionPurchase"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/androidpublisher/v1.1/androidpublisher-gen.go b/vendor/google.golang.org/api/androidpublisher/v1.1/androidpublisher-gen.go
deleted file mode 100644
index ca55607a..00000000
--- a/vendor/google.golang.org/api/androidpublisher/v1.1/androidpublisher-gen.go
+++ /dev/null
@@ -1,581 +0,0 @@
-// Package androidpublisher provides access to the Google Play Developer API.
-//
-// See https://developers.google.com/android-publisher
-//
-// Usage example:
-//
-// import "google.golang.org/api/androidpublisher/v1.1"
-// ...
-// androidpublisherService, err := androidpublisher.New(oauthHttpClient)
-package androidpublisher // import "google.golang.org/api/androidpublisher/v1.1"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "androidpublisher:v1.1"
-const apiName = "androidpublisher"
-const apiVersion = "v1.1"
-const basePath = "https://www.googleapis.com/androidpublisher/v1.1/applications/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your Google Play Developer account
- AndroidpublisherScope = "https://www.googleapis.com/auth/androidpublisher"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Inapppurchases = NewInapppurchasesService(s)
- s.Purchases = NewPurchasesService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Inapppurchases *InapppurchasesService
-
- Purchases *PurchasesService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewInapppurchasesService(s *Service) *InapppurchasesService {
- rs := &InapppurchasesService{s: s}
- return rs
-}
-
-type InapppurchasesService struct {
- s *Service
-}
-
-func NewPurchasesService(s *Service) *PurchasesService {
- rs := &PurchasesService{s: s}
- return rs
-}
-
-type PurchasesService struct {
- s *Service
-}
-
-// InappPurchase: An InappPurchase resource indicates the status of a
-// user's inapp product purchase.
-type InappPurchase struct {
- // ConsumptionState: The consumption state of the inapp product.
- // Possible values are:
- // - Yet to be consumed
- // - Consumed
- ConsumptionState int64 `json:"consumptionState,omitempty"`
-
- // DeveloperPayload: A developer-specified string that contains
- // supplemental information about an order.
- DeveloperPayload string `json:"developerPayload,omitempty"`
-
- // Kind: This kind represents an inappPurchase object in the
- // androidpublisher service.
- Kind string `json:"kind,omitempty"`
-
- // PurchaseState: The purchase state of the order. Possible values are:
- //
- // - Purchased
- // - Cancelled
- PurchaseState int64 `json:"purchaseState,omitempty"`
-
- // PurchaseTime: The time the product was purchased, in milliseconds
- // since the epoch (Jan 1, 1970).
- PurchaseTime int64 `json:"purchaseTime,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ConsumptionState") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InappPurchase) MarshalJSON() ([]byte, error) {
- type noMethod InappPurchase
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SubscriptionPurchase: A SubscriptionPurchase resource indicates the
-// status of a user's subscription purchase.
-type SubscriptionPurchase struct {
- // AutoRenewing: Whether the subscription will automatically be renewed
- // when it reaches its current expiry time.
- AutoRenewing bool `json:"autoRenewing,omitempty"`
-
- // InitiationTimestampMsec: Time at which the subscription was granted,
- // in milliseconds since Epoch.
- InitiationTimestampMsec int64 `json:"initiationTimestampMsec,omitempty,string"`
-
- // Kind: This kind represents a subscriptionPurchase object in the
- // androidpublisher service.
- Kind string `json:"kind,omitempty"`
-
- // ValidUntilTimestampMsec: Time at which the subscription will expire,
- // in milliseconds since Epoch.
- ValidUntilTimestampMsec int64 `json:"validUntilTimestampMsec,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AutoRenewing") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SubscriptionPurchase) MarshalJSON() ([]byte, error) {
- type noMethod SubscriptionPurchase
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "androidpublisher.inapppurchases.get":
-
-type InapppurchasesGetCall struct {
- s *Service
- packageName string
- productId string
- token string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Checks the purchase and consumption status of an inapp item.
-func (r *InapppurchasesService) Get(packageName string, productId string, token string) *InapppurchasesGetCall {
- c := &InapppurchasesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageName = packageName
- c.productId = productId
- c.token = token
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InapppurchasesGetCall) Fields(s ...googleapi.Field) *InapppurchasesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InapppurchasesGetCall) IfNoneMatch(entityTag string) *InapppurchasesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InapppurchasesGetCall) Context(ctx context.Context) *InapppurchasesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InapppurchasesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/inapp/{productId}/purchases/{token}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageName,
- "productId": c.productId,
- "token": c.token,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.inapppurchases.get" call.
-// Exactly one of *InappPurchase or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *InappPurchase.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InapppurchasesGetCall) Do() (*InappPurchase, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InappPurchase{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Checks the purchase and consumption status of an inapp item.",
- // "httpMethod": "GET",
- // "id": "androidpublisher.inapppurchases.get",
- // "parameterOrder": [
- // "packageName",
- // "productId",
- // "token"
- // ],
- // "parameters": {
- // "packageName": {
- // "description": "The package name of the application the inapp product was sold in (for example, 'com.some.thing').",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "productId": {
- // "description": "The inapp product SKU (for example, 'com.some.thing.inapp1').",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "token": {
- // "description": "The token provided to the user's device when the inapp product was purchased.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/inapp/{productId}/purchases/{token}",
- // "response": {
- // "$ref": "InappPurchase"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.purchases.cancel":
-
-type PurchasesCancelCall struct {
- s *Service
- packageName string
- subscriptionId string
- token string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Cancel: Cancels a user's subscription purchase. The subscription
-// remains valid until its expiration time.
-func (r *PurchasesService) Cancel(packageName string, subscriptionId string, token string) *PurchasesCancelCall {
- c := &PurchasesCancelCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageName = packageName
- c.subscriptionId = subscriptionId
- c.token = token
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PurchasesCancelCall) Fields(s ...googleapi.Field) *PurchasesCancelCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PurchasesCancelCall) Context(ctx context.Context) *PurchasesCancelCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PurchasesCancelCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/subscriptions/{subscriptionId}/purchases/{token}/cancel")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageName,
- "subscriptionId": c.subscriptionId,
- "token": c.token,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.purchases.cancel" call.
-func (c *PurchasesCancelCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Cancels a user's subscription purchase. The subscription remains valid until its expiration time.",
- // "httpMethod": "POST",
- // "id": "androidpublisher.purchases.cancel",
- // "parameterOrder": [
- // "packageName",
- // "subscriptionId",
- // "token"
- // ],
- // "parameters": {
- // "packageName": {
- // "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "subscriptionId": {
- // "description": "The purchased subscription ID (for example, 'monthly001').",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "token": {
- // "description": "The token provided to the user's device when the subscription was purchased.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/subscriptions/{subscriptionId}/purchases/{token}/cancel",
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.purchases.get":
-
-type PurchasesGetCall struct {
- s *Service
- packageName string
- subscriptionId string
- token string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Checks whether a user's subscription purchase is valid and
-// returns its expiry time.
-func (r *PurchasesService) Get(packageName string, subscriptionId string, token string) *PurchasesGetCall {
- c := &PurchasesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageName = packageName
- c.subscriptionId = subscriptionId
- c.token = token
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PurchasesGetCall) Fields(s ...googleapi.Field) *PurchasesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PurchasesGetCall) IfNoneMatch(entityTag string) *PurchasesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PurchasesGetCall) Context(ctx context.Context) *PurchasesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PurchasesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/subscriptions/{subscriptionId}/purchases/{token}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageName,
- "subscriptionId": c.subscriptionId,
- "token": c.token,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.purchases.get" call.
-// Exactly one of *SubscriptionPurchase or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *SubscriptionPurchase.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PurchasesGetCall) Do() (*SubscriptionPurchase, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SubscriptionPurchase{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Checks whether a user's subscription purchase is valid and returns its expiry time.",
- // "httpMethod": "GET",
- // "id": "androidpublisher.purchases.get",
- // "parameterOrder": [
- // "packageName",
- // "subscriptionId",
- // "token"
- // ],
- // "parameters": {
- // "packageName": {
- // "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "subscriptionId": {
- // "description": "The purchased subscription ID (for example, 'monthly001').",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "token": {
- // "description": "The token provided to the user's device when the subscription was purchased.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/subscriptions/{subscriptionId}/purchases/{token}",
- // "response": {
- // "$ref": "SubscriptionPurchase"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/androidpublisher/v1/androidpublisher-api.json b/vendor/google.golang.org/api/androidpublisher/v1/androidpublisher-api.json
deleted file mode 100644
index d0d65ec8..00000000
--- a/vendor/google.golang.org/api/androidpublisher/v1/androidpublisher-api.json
+++ /dev/null
@@ -1,184 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/JGynskXPDYAm7HfLDYPma5VcVjE\"",
- "discoveryVersion": "v1",
- "id": "androidpublisher:v1",
- "name": "androidpublisher",
- "canonicalName": "Android Publisher",
- "version": "v1",
- "revision": "20150323",
- "title": "Google Play Developer API",
- "description": "Lets Android application developers access their Google Play accounts.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/android-16.png",
- "x32": "https://www.google.com/images/icons/product/android-32.png"
- },
- "documentationLink": "https://developers.google.com/android-publisher",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/androidpublisher/v1/applications/",
- "basePath": "/androidpublisher/v1/applications/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "androidpublisher/v1/applications/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/androidpublisher": {
- "description": "View and manage your Google Play Developer account"
- }
- }
- }
- },
- "schemas": {
- "SubscriptionPurchase": {
- "id": "SubscriptionPurchase",
- "type": "object",
- "description": "A SubscriptionPurchase resource indicates the status of a user's subscription purchase.",
- "properties": {
- "autoRenewing": {
- "type": "boolean",
- "description": "Whether the subscription will automatically be renewed when it reaches its current expiry time."
- },
- "initiationTimestampMsec": {
- "type": "string",
- "description": "Time at which the subscription was granted, in milliseconds since Epoch.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "This kind represents a subscriptionPurchase object in the androidpublisher service.",
- "default": "androidpublisher#subscriptionPurchase"
- },
- "validUntilTimestampMsec": {
- "type": "string",
- "description": "Time at which the subscription will expire, in milliseconds since Epoch.",
- "format": "int64"
- }
- }
- }
- },
- "resources": {
- "purchases": {
- "methods": {
- "cancel": {
- "id": "androidpublisher.purchases.cancel",
- "path": "{packageName}/subscriptions/{subscriptionId}/purchases/{token}/cancel",
- "httpMethod": "POST",
- "description": "Cancels a user's subscription purchase. The subscription remains valid until its expiration time.",
- "parameters": {
- "packageName": {
- "type": "string",
- "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
- "required": true,
- "location": "path"
- },
- "subscriptionId": {
- "type": "string",
- "description": "The purchased subscription ID (for example, 'monthly001').",
- "required": true,
- "location": "path"
- },
- "token": {
- "type": "string",
- "description": "The token provided to the user's device when the subscription was purchased.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "subscriptionId",
- "token"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "get": {
- "id": "androidpublisher.purchases.get",
- "path": "{packageName}/subscriptions/{subscriptionId}/purchases/{token}",
- "httpMethod": "GET",
- "description": "Checks whether a user's subscription purchase is valid and returns its expiry time.",
- "parameters": {
- "packageName": {
- "type": "string",
- "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
- "required": true,
- "location": "path"
- },
- "subscriptionId": {
- "type": "string",
- "description": "The purchased subscription ID (for example, 'monthly001').",
- "required": true,
- "location": "path"
- },
- "token": {
- "type": "string",
- "description": "The token provided to the user's device when the subscription was purchased.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "subscriptionId",
- "token"
- ],
- "response": {
- "$ref": "SubscriptionPurchase"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/androidpublisher/v1/androidpublisher-gen.go b/vendor/google.golang.org/api/androidpublisher/v1/androidpublisher-gen.go
deleted file mode 100644
index f2f53211..00000000
--- a/vendor/google.golang.org/api/androidpublisher/v1/androidpublisher-gen.go
+++ /dev/null
@@ -1,377 +0,0 @@
-// Package androidpublisher provides access to the Google Play Developer API.
-//
-// See https://developers.google.com/android-publisher
-//
-// Usage example:
-//
-// import "google.golang.org/api/androidpublisher/v1"
-// ...
-// androidpublisherService, err := androidpublisher.New(oauthHttpClient)
-package androidpublisher // import "google.golang.org/api/androidpublisher/v1"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "androidpublisher:v1"
-const apiName = "androidpublisher"
-const apiVersion = "v1"
-const basePath = "https://www.googleapis.com/androidpublisher/v1/applications/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your Google Play Developer account
- AndroidpublisherScope = "https://www.googleapis.com/auth/androidpublisher"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Purchases = NewPurchasesService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Purchases *PurchasesService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewPurchasesService(s *Service) *PurchasesService {
- rs := &PurchasesService{s: s}
- return rs
-}
-
-type PurchasesService struct {
- s *Service
-}
-
-// SubscriptionPurchase: A SubscriptionPurchase resource indicates the
-// status of a user's subscription purchase.
-type SubscriptionPurchase struct {
- // AutoRenewing: Whether the subscription will automatically be renewed
- // when it reaches its current expiry time.
- AutoRenewing bool `json:"autoRenewing,omitempty"`
-
- // InitiationTimestampMsec: Time at which the subscription was granted,
- // in milliseconds since Epoch.
- InitiationTimestampMsec int64 `json:"initiationTimestampMsec,omitempty,string"`
-
- // Kind: This kind represents a subscriptionPurchase object in the
- // androidpublisher service.
- Kind string `json:"kind,omitempty"`
-
- // ValidUntilTimestampMsec: Time at which the subscription will expire,
- // in milliseconds since Epoch.
- ValidUntilTimestampMsec int64 `json:"validUntilTimestampMsec,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AutoRenewing") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SubscriptionPurchase) MarshalJSON() ([]byte, error) {
- type noMethod SubscriptionPurchase
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "androidpublisher.purchases.cancel":
-
-type PurchasesCancelCall struct {
- s *Service
- packageName string
- subscriptionId string
- token string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Cancel: Cancels a user's subscription purchase. The subscription
-// remains valid until its expiration time.
-func (r *PurchasesService) Cancel(packageName string, subscriptionId string, token string) *PurchasesCancelCall {
- c := &PurchasesCancelCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageName = packageName
- c.subscriptionId = subscriptionId
- c.token = token
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PurchasesCancelCall) Fields(s ...googleapi.Field) *PurchasesCancelCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PurchasesCancelCall) Context(ctx context.Context) *PurchasesCancelCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PurchasesCancelCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/subscriptions/{subscriptionId}/purchases/{token}/cancel")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageName,
- "subscriptionId": c.subscriptionId,
- "token": c.token,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.purchases.cancel" call.
-func (c *PurchasesCancelCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Cancels a user's subscription purchase. The subscription remains valid until its expiration time.",
- // "httpMethod": "POST",
- // "id": "androidpublisher.purchases.cancel",
- // "parameterOrder": [
- // "packageName",
- // "subscriptionId",
- // "token"
- // ],
- // "parameters": {
- // "packageName": {
- // "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "subscriptionId": {
- // "description": "The purchased subscription ID (for example, 'monthly001').",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "token": {
- // "description": "The token provided to the user's device when the subscription was purchased.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/subscriptions/{subscriptionId}/purchases/{token}/cancel",
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.purchases.get":
-
-type PurchasesGetCall struct {
- s *Service
- packageName string
- subscriptionId string
- token string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Checks whether a user's subscription purchase is valid and
-// returns its expiry time.
-func (r *PurchasesService) Get(packageName string, subscriptionId string, token string) *PurchasesGetCall {
- c := &PurchasesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageName = packageName
- c.subscriptionId = subscriptionId
- c.token = token
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PurchasesGetCall) Fields(s ...googleapi.Field) *PurchasesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PurchasesGetCall) IfNoneMatch(entityTag string) *PurchasesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PurchasesGetCall) Context(ctx context.Context) *PurchasesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PurchasesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/subscriptions/{subscriptionId}/purchases/{token}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageName,
- "subscriptionId": c.subscriptionId,
- "token": c.token,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.purchases.get" call.
-// Exactly one of *SubscriptionPurchase or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *SubscriptionPurchase.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PurchasesGetCall) Do() (*SubscriptionPurchase, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SubscriptionPurchase{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Checks whether a user's subscription purchase is valid and returns its expiry time.",
- // "httpMethod": "GET",
- // "id": "androidpublisher.purchases.get",
- // "parameterOrder": [
- // "packageName",
- // "subscriptionId",
- // "token"
- // ],
- // "parameters": {
- // "packageName": {
- // "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "subscriptionId": {
- // "description": "The purchased subscription ID (for example, 'monthly001').",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "token": {
- // "description": "The token provided to the user's device when the subscription was purchased.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/subscriptions/{subscriptionId}/purchases/{token}",
- // "response": {
- // "$ref": "SubscriptionPurchase"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/androidpublisher/v2/androidpublisher-api.json b/vendor/google.golang.org/api/androidpublisher/v2/androidpublisher-api.json
deleted file mode 100644
index cb691769..00000000
--- a/vendor/google.golang.org/api/androidpublisher/v2/androidpublisher-api.json
+++ /dev/null
@@ -1,3071 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/QvChBL9zzkcDEEIqZpwPMr9_TRs\"",
- "discoveryVersion": "v1",
- "id": "androidpublisher:v2",
- "name": "androidpublisher",
- "canonicalName": "Android Publisher",
- "version": "v2",
- "revision": "20150910",
- "title": "Google Play Developer API",
- "description": "Lets Android application developers access their Google Play accounts.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/android-16.png",
- "x32": "https://www.google.com/images/icons/product/android-32.png"
- },
- "documentationLink": "https://developers.google.com/android-publisher",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/androidpublisher/v2/applications/",
- "basePath": "/androidpublisher/v2/applications/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "androidpublisher/v2/applications/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/androidpublisher": {
- "description": "View and manage your Google Play Developer account"
- }
- }
- }
- },
- "schemas": {
- "Apk": {
- "id": "Apk",
- "type": "object",
- "properties": {
- "binary": {
- "$ref": "ApkBinary",
- "description": "Information about the binary payload of this APK."
- },
- "versionCode": {
- "type": "integer",
- "description": "The version code of the APK, as specified in the APK's manifest file.",
- "format": "int32"
- }
- }
- },
- "ApkBinary": {
- "id": "ApkBinary",
- "type": "object",
- "description": "Represents the binary payload of an APK.",
- "properties": {
- "sha1": {
- "type": "string",
- "description": "A sha1 hash of the APK payload, encoded as a hex string and matching the output of the sha1sum command."
- }
- }
- },
- "ApkListing": {
- "id": "ApkListing",
- "type": "object",
- "properties": {
- "language": {
- "type": "string",
- "description": "The language code, in BCP 47 format (eg \"en-US\")."
- },
- "recentChanges": {
- "type": "string",
- "description": "Describe what's new in your APK."
- }
- }
- },
- "ApkListingsListResponse": {
- "id": "ApkListingsListResponse",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidpublisher#apkListingsListResponse\".",
- "default": "androidpublisher#apkListingsListResponse"
- },
- "listings": {
- "type": "array",
- "items": {
- "$ref": "ApkListing"
- }
- }
- }
- },
- "ApksAddExternallyHostedRequest": {
- "id": "ApksAddExternallyHostedRequest",
- "type": "object",
- "properties": {
- "externallyHostedApk": {
- "$ref": "ExternallyHostedApk",
- "description": "The definition of the externally-hosted APK and where it is located."
- }
- }
- },
- "ApksAddExternallyHostedResponse": {
- "id": "ApksAddExternallyHostedResponse",
- "type": "object",
- "properties": {
- "externallyHostedApk": {
- "$ref": "ExternallyHostedApk",
- "description": "The definition of the externally-hosted APK and where it is located."
- }
- }
- },
- "ApksListResponse": {
- "id": "ApksListResponse",
- "type": "object",
- "properties": {
- "apks": {
- "type": "array",
- "items": {
- "$ref": "Apk"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidpublisher#apksListResponse\".",
- "default": "androidpublisher#apksListResponse"
- }
- }
- },
- "AppDetails": {
- "id": "AppDetails",
- "type": "object",
- "properties": {
- "contactEmail": {
- "type": "string",
- "description": "The user-visible support email for this app."
- },
- "contactPhone": {
- "type": "string",
- "description": "The user-visible support telephone number for this app."
- },
- "contactWebsite": {
- "type": "string",
- "description": "The user-visible website for this app."
- },
- "defaultLanguage": {
- "type": "string",
- "description": "Default language code, in BCP 47 format (eg \"en-US\")."
- }
- }
- },
- "AppEdit": {
- "id": "AppEdit",
- "type": "object",
- "description": "Represents an edit of an app. An edit allows clients to make multiple changes before committing them in one operation.",
- "properties": {
- "expiryTimeSeconds": {
- "type": "string",
- "description": "The time at which the edit will expire and will be no longer valid for use in any subsequent API calls (encoded as seconds since the Epoch)."
- },
- "id": {
- "type": "string",
- "description": "The ID of the edit that can be used in subsequent API calls."
- }
- }
- },
- "Entitlement": {
- "id": "Entitlement",
- "type": "object",
- "description": "An Entitlement resource indicates a user's current entitlement to an inapp item or subscription.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "This kind represents an entitlement object in the androidpublisher service.",
- "default": "androidpublisher#entitlement"
- },
- "productId": {
- "type": "string",
- "description": "The SKU of the product."
- },
- "productType": {
- "type": "string",
- "description": "The type of the inapp product. Possible values are: \n- In-app item: \"inapp\" \n- Subscription: \"subs\""
- },
- "token": {
- "type": "string",
- "description": "The token which can be verified using the subscriptions or products API."
- }
- }
- },
- "EntitlementsListResponse": {
- "id": "EntitlementsListResponse",
- "type": "object",
- "properties": {
- "pageInfo": {
- "$ref": "PageInfo"
- },
- "resources": {
- "type": "array",
- "items": {
- "$ref": "Entitlement"
- }
- },
- "tokenPagination": {
- "$ref": "TokenPagination"
- }
- }
- },
- "ExpansionFile": {
- "id": "ExpansionFile",
- "type": "object",
- "properties": {
- "fileSize": {
- "type": "string",
- "description": "If set this field indicates that this APK has an Expansion File uploaded to it: this APK does not reference another APK's Expansion File. The field's value is the size of the uploaded Expansion File in bytes.",
- "format": "int64"
- },
- "referencesVersion": {
- "type": "integer",
- "description": "If set this APK's Expansion File references another APK's Expansion File. The file_size field will not be set.",
- "format": "int32"
- }
- }
- },
- "ExpansionFilesUploadResponse": {
- "id": "ExpansionFilesUploadResponse",
- "type": "object",
- "properties": {
- "expansionFile": {
- "$ref": "ExpansionFile"
- }
- }
- },
- "ExternallyHostedApk": {
- "id": "ExternallyHostedApk",
- "type": "object",
- "description": "Defines an APK available for this application that is hosted externally and not uploaded to Google Play. This function is only available to enterprises who are using Google Play for Work, and whos application is restricted to the enterprise private channel",
- "properties": {
- "applicationLabel": {
- "type": "string",
- "description": "The application label."
- },
- "certificateBase64s": {
- "type": "array",
- "description": "A certificate (or array of certificates if a certificate-chain is used) used to signed this APK, represented as a base64 encoded byte array.",
- "items": {
- "type": "string"
- }
- },
- "externallyHostedUrl": {
- "type": "string",
- "description": "The URL at which the APK is hosted. This must be an https URL."
- },
- "fileSha1Base64": {
- "type": "string",
- "description": "The SHA1 checksum of this APK, represented as a base64 encoded byte array."
- },
- "fileSha256Base64": {
- "type": "string",
- "description": "The SHA256 checksum of this APK, represented as a base64 encoded byte array."
- },
- "fileSize": {
- "type": "string",
- "description": "The file size in bytes of this APK.",
- "format": "int64"
- },
- "iconBase64": {
- "type": "string",
- "description": "The icon image from the APK, as a base64 encoded byte array."
- },
- "maximumSdk": {
- "type": "integer",
- "description": "The maximum SDK supported by this APK (optional).",
- "format": "int32"
- },
- "minimumSdk": {
- "type": "integer",
- "description": "The minimum SDK targeted by this APK.",
- "format": "int32"
- },
- "nativeCodes": {
- "type": "array",
- "description": "The native code environments supported by this APK (optional).",
- "items": {
- "type": "string"
- }
- },
- "packageName": {
- "type": "string",
- "description": "The package name."
- },
- "usesFeatures": {
- "type": "array",
- "description": "The features required by this APK (optional).",
- "items": {
- "type": "string"
- }
- },
- "usesPermissions": {
- "type": "array",
- "description": "The permissions requested by this APK.",
- "items": {
- "$ref": "ExternallyHostedApkUsesPermission"
- }
- },
- "versionCode": {
- "type": "integer",
- "description": "The version code of this APK.",
- "format": "int32"
- },
- "versionName": {
- "type": "string",
- "description": "The version name of this APK."
- }
- }
- },
- "ExternallyHostedApkUsesPermission": {
- "id": "ExternallyHostedApkUsesPermission",
- "type": "object",
- "description": "A permission used by this APK.",
- "properties": {
- "maxSdkVersion": {
- "type": "integer",
- "description": "Optionally, the maximum SDK version for which the permission is required.",
- "format": "int32"
- },
- "name": {
- "type": "string",
- "description": "The name of the permission requested."
- }
- }
- },
- "Image": {
- "id": "Image",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "A unique id representing this image."
- },
- "sha1": {
- "type": "string",
- "description": "A sha1 hash of the image that was uploaded."
- },
- "url": {
- "type": "string",
- "description": "A URL that will serve a preview of the image."
- }
- }
- },
- "ImagesDeleteAllResponse": {
- "id": "ImagesDeleteAllResponse",
- "type": "object",
- "properties": {
- "deleted": {
- "type": "array",
- "items": {
- "$ref": "Image"
- }
- }
- }
- },
- "ImagesListResponse": {
- "id": "ImagesListResponse",
- "type": "object",
- "properties": {
- "images": {
- "type": "array",
- "items": {
- "$ref": "Image"
- }
- }
- }
- },
- "ImagesUploadResponse": {
- "id": "ImagesUploadResponse",
- "type": "object",
- "properties": {
- "image": {
- "$ref": "Image"
- }
- }
- },
- "InAppProduct": {
- "id": "InAppProduct",
- "type": "object",
- "properties": {
- "defaultLanguage": {
- "type": "string",
- "description": "The default language of the localized data, as defined by BCP 47. e.g. \"en-US\", \"en-GB\"."
- },
- "defaultPrice": {
- "$ref": "Price",
- "description": "Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency."
- },
- "listings": {
- "type": "object",
- "description": "List of localized title and description data.",
- "additionalProperties": {
- "$ref": "InAppProductListing",
- "description": "The language of the localized data, as defined by BCP 47. i.e.: \"en-US\", \"en-GB\"."
- }
- },
- "packageName": {
- "type": "string",
- "description": "The package name of the parent app."
- },
- "prices": {
- "type": "object",
- "description": "Prices per buyer region. None of these prices should be zero. In-app products can never be free.",
- "additionalProperties": {
- "$ref": "Price",
- "description": "Region code, as defined by ISO 3166-2."
- }
- },
- "purchaseType": {
- "type": "string",
- "description": "Purchase type enum value. Unmodifiable after creation."
- },
- "season": {
- "$ref": "Season",
- "description": "Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions."
- },
- "sku": {
- "type": "string",
- "description": "The stock-keeping-unit (SKU) of the product, unique within an app."
- },
- "status": {
- "type": "string"
- },
- "subscriptionPeriod": {
- "type": "string",
- "description": "Subscription period, specified in ISO 8601 format. Acceptable values are \"P1W\" (one week), \"P1M\" (one month) and \"P1Y\" (one year)."
- },
- "trialPeriod": {
- "type": "string",
- "description": "Trial period, specified in ISO 8601 format. Acceptable values are anything between \"P7D\" (seven days) and \"P999D\" (999 days). Seasonal subscriptions cannot have a trial period."
- }
- }
- },
- "InAppProductListing": {
- "id": "InAppProductListing",
- "type": "object",
- "properties": {
- "description": {
- "type": "string"
- },
- "title": {
- "type": "string"
- }
- }
- },
- "InappproductsBatchRequest": {
- "id": "InappproductsBatchRequest",
- "type": "object",
- "properties": {
- "entrys": {
- "type": "array",
- "items": {
- "$ref": "InappproductsBatchRequestEntry"
- }
- }
- }
- },
- "InappproductsBatchRequestEntry": {
- "id": "InappproductsBatchRequestEntry",
- "type": "object",
- "properties": {
- "batchId": {
- "type": "integer",
- "format": "uint32"
- },
- "inappproductsinsertrequest": {
- "$ref": "InappproductsInsertRequest"
- },
- "inappproductsupdaterequest": {
- "$ref": "InappproductsUpdateRequest"
- },
- "methodName": {
- "type": "string"
- }
- }
- },
- "InappproductsBatchResponse": {
- "id": "InappproductsBatchResponse",
- "type": "object",
- "properties": {
- "entrys": {
- "type": "array",
- "items": {
- "$ref": "InappproductsBatchResponseEntry"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidpublisher#inappproductsBatchResponse\".",
- "default": "androidpublisher#inappproductsBatchResponse"
- }
- }
- },
- "InappproductsBatchResponseEntry": {
- "id": "InappproductsBatchResponseEntry",
- "type": "object",
- "properties": {
- "batchId": {
- "type": "integer",
- "format": "uint32"
- },
- "inappproductsinsertresponse": {
- "$ref": "InappproductsInsertResponse"
- },
- "inappproductsupdateresponse": {
- "$ref": "InappproductsUpdateResponse"
- }
- }
- },
- "InappproductsInsertRequest": {
- "id": "InappproductsInsertRequest",
- "type": "object",
- "properties": {
- "inappproduct": {
- "$ref": "InAppProduct"
- }
- }
- },
- "InappproductsInsertResponse": {
- "id": "InappproductsInsertResponse",
- "type": "object",
- "properties": {
- "inappproduct": {
- "$ref": "InAppProduct"
- }
- }
- },
- "InappproductsListResponse": {
- "id": "InappproductsListResponse",
- "type": "object",
- "properties": {
- "inappproduct": {
- "type": "array",
- "items": {
- "$ref": "InAppProduct"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidpublisher#inappproductsListResponse\".",
- "default": "androidpublisher#inappproductsListResponse"
- },
- "pageInfo": {
- "$ref": "PageInfo"
- },
- "tokenPagination": {
- "$ref": "TokenPagination"
- }
- }
- },
- "InappproductsUpdateRequest": {
- "id": "InappproductsUpdateRequest",
- "type": "object",
- "properties": {
- "inappproduct": {
- "$ref": "InAppProduct"
- }
- }
- },
- "InappproductsUpdateResponse": {
- "id": "InappproductsUpdateResponse",
- "type": "object",
- "properties": {
- "inappproduct": {
- "$ref": "InAppProduct"
- }
- }
- },
- "Listing": {
- "id": "Listing",
- "type": "object",
- "properties": {
- "fullDescription": {
- "type": "string",
- "description": "Full description of the app; this may be up to 4000 characters in length."
- },
- "language": {
- "type": "string",
- "description": "Language localization code (for example, \"de-AT\" for Austrian German)."
- },
- "shortDescription": {
- "type": "string",
- "description": "Short description of the app (previously known as promo text); this may be up to 80 characters in length."
- },
- "title": {
- "type": "string",
- "description": "App's localized title."
- },
- "video": {
- "type": "string",
- "description": "URL of a promotional YouTube video for the app."
- }
- }
- },
- "ListingsListResponse": {
- "id": "ListingsListResponse",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidpublisher#listingsListResponse\".",
- "default": "androidpublisher#listingsListResponse"
- },
- "listings": {
- "type": "array",
- "items": {
- "$ref": "Listing"
- }
- }
- }
- },
- "MonthDay": {
- "id": "MonthDay",
- "type": "object",
- "properties": {
- "day": {
- "type": "integer",
- "description": "Day of a month, value in [1, 31] range. Valid range depends on the specified month.",
- "format": "uint32"
- },
- "month": {
- "type": "integer",
- "description": "Month of a year. e.g. 1 = JAN, 2 = FEB etc.",
- "format": "uint32"
- }
- }
- },
- "PageInfo": {
- "id": "PageInfo",
- "type": "object",
- "properties": {
- "resultPerPage": {
- "type": "integer",
- "format": "int32"
- },
- "startIndex": {
- "type": "integer",
- "format": "int32"
- },
- "totalResults": {
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "Price": {
- "id": "Price",
- "type": "object",
- "properties": {
- "currency": {
- "type": "string",
- "description": "3 letter Currency code, as defined by ISO 4217."
- },
- "priceMicros": {
- "type": "string",
- "description": "The price in millionths of the currency base unit represented as a string."
- }
- }
- },
- "ProductPurchase": {
- "id": "ProductPurchase",
- "type": "object",
- "description": "A ProductPurchase resource indicates the status of a user's inapp product purchase.",
- "properties": {
- "consumptionState": {
- "type": "integer",
- "description": "The consumption state of the inapp product. Possible values are: \n- Yet to be consumed \n- Consumed",
- "format": "int32"
- },
- "developerPayload": {
- "type": "string",
- "description": "A developer-specified string that contains supplemental information about an order."
- },
- "kind": {
- "type": "string",
- "description": "This kind represents an inappPurchase object in the androidpublisher service.",
- "default": "androidpublisher#productPurchase"
- },
- "purchaseState": {
- "type": "integer",
- "description": "The purchase state of the order. Possible values are: \n- Purchased \n- Cancelled",
- "format": "int32"
- },
- "purchaseTimeMillis": {
- "type": "string",
- "description": "The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970).",
- "format": "int64"
- }
- }
- },
- "Season": {
- "id": "Season",
- "type": "object",
- "properties": {
- "end": {
- "$ref": "MonthDay",
- "description": "Inclusive end date of the recurrence period."
- },
- "start": {
- "$ref": "MonthDay",
- "description": "Inclusive start date of the recurrence period."
- }
- }
- },
- "SubscriptionDeferralInfo": {
- "id": "SubscriptionDeferralInfo",
- "type": "object",
- "description": "A SubscriptionDeferralInfo contains the data needed to defer a subscription purchase to a future expiry time.",
- "properties": {
- "desiredExpiryTimeMillis": {
- "type": "string",
- "description": "The desired next expiry time for the subscription in milliseconds since Epoch. The given time must be after the current expiry time for the subscription.",
- "format": "int64"
- },
- "expectedExpiryTimeMillis": {
- "type": "string",
- "description": "The expected expiry time for the subscription. If the current expiry time for the subscription is not the value specified here, the deferral will not occur.",
- "format": "int64"
- }
- }
- },
- "SubscriptionPurchase": {
- "id": "SubscriptionPurchase",
- "type": "object",
- "description": "A SubscriptionPurchase resource indicates the status of a user's subscription purchase.",
- "properties": {
- "autoRenewing": {
- "type": "boolean",
- "description": "Whether the subscription will automatically be renewed when it reaches its current expiry time."
- },
- "expiryTimeMillis": {
- "type": "string",
- "description": "Time at which the subscription will expire, in milliseconds since Epoch.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "This kind represents a subscriptionPurchase object in the androidpublisher service.",
- "default": "androidpublisher#subscriptionPurchase"
- },
- "startTimeMillis": {
- "type": "string",
- "description": "Time at which the subscription was granted, in milliseconds since Epoch.",
- "format": "int64"
- }
- }
- },
- "SubscriptionPurchasesDeferRequest": {
- "id": "SubscriptionPurchasesDeferRequest",
- "type": "object",
- "properties": {
- "deferralInfo": {
- "$ref": "SubscriptionDeferralInfo",
- "description": "The information about the new desired expiry time for the subscription."
- }
- }
- },
- "SubscriptionPurchasesDeferResponse": {
- "id": "SubscriptionPurchasesDeferResponse",
- "type": "object",
- "properties": {
- "newExpiryTimeMillis": {
- "type": "string",
- "description": "The new expiry time for the subscription in milliseconds since the Epoch.",
- "format": "int64"
- }
- }
- },
- "Testers": {
- "id": "Testers",
- "type": "object",
- "properties": {
- "googleGroups": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "googlePlusCommunities": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "TokenPagination": {
- "id": "TokenPagination",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "type": "string"
- },
- "previousPageToken": {
- "type": "string"
- }
- }
- },
- "Track": {
- "id": "Track",
- "type": "object",
- "properties": {
- "track": {
- "type": "string"
- },
- "userFraction": {
- "type": "number",
- "format": "double"
- },
- "versionCodes": {
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- }
- }
- },
- "TracksListResponse": {
- "id": "TracksListResponse",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"androidpublisher#tracksListResponse\".",
- "default": "androidpublisher#tracksListResponse"
- },
- "tracks": {
- "type": "array",
- "items": {
- "$ref": "Track"
- }
- }
- }
- }
- },
- "resources": {
- "edits": {
- "methods": {
- "commit": {
- "id": "androidpublisher.edits.commit",
- "path": "{packageName}/edits/{editId}:commit",
- "httpMethod": "POST",
- "description": "Commits/applies the changes made in this edit back to the app.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId"
- ],
- "response": {
- "$ref": "AppEdit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "delete": {
- "id": "androidpublisher.edits.delete",
- "path": "{packageName}/edits/{editId}",
- "httpMethod": "DELETE",
- "description": "Deletes an edit for an app. Creating a new edit will automatically delete any of your previous edits so this method need only be called if you want to preemptively abandon an edit.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "get": {
- "id": "androidpublisher.edits.get",
- "path": "{packageName}/edits/{editId}",
- "httpMethod": "GET",
- "description": "Returns information about the edit specified. Calls will fail if the edit is no long active (e.g. has been deleted, superseded or expired).",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId"
- ],
- "response": {
- "$ref": "AppEdit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "insert": {
- "id": "androidpublisher.edits.insert",
- "path": "{packageName}/edits",
- "httpMethod": "POST",
- "description": "Creates a new edit for an app, populated with the app's current state.",
- "parameters": {
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName"
- ],
- "request": {
- "$ref": "AppEdit"
- },
- "response": {
- "$ref": "AppEdit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "validate": {
- "id": "androidpublisher.edits.validate",
- "path": "{packageName}/edits/{editId}:validate",
- "httpMethod": "POST",
- "description": "Checks that the edit can be successfully committed. The edit's changes are not applied to the live app.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId"
- ],
- "response": {
- "$ref": "AppEdit"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- }
- },
- "resources": {
- "apklistings": {
- "methods": {
- "delete": {
- "id": "androidpublisher.edits.apklistings.delete",
- "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}",
- "httpMethod": "DELETE",
- "description": "Deletes the APK-specific localized listing for a specified APK and language code.",
- "parameters": {
- "apkVersionCode": {
- "type": "integer",
- "description": "The APK version code whose APK-specific listings should be read or modified.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "The language code (a BCP-47 language tag) of the APK-specific localized listing to read or modify. For example, to select Austrian German, pass \"de-AT\".",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "apkVersionCode",
- "language"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "deleteall": {
- "id": "androidpublisher.edits.apklistings.deleteall",
- "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings",
- "httpMethod": "DELETE",
- "description": "Deletes all the APK-specific localized listings for a specified APK.",
- "parameters": {
- "apkVersionCode": {
- "type": "integer",
- "description": "The APK version code whose APK-specific listings should be read or modified.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "apkVersionCode"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "get": {
- "id": "androidpublisher.edits.apklistings.get",
- "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}",
- "httpMethod": "GET",
- "description": "Fetches the APK-specific localized listing for a specified APK and language code.",
- "parameters": {
- "apkVersionCode": {
- "type": "integer",
- "description": "The APK version code whose APK-specific listings should be read or modified.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "The language code (a BCP-47 language tag) of the APK-specific localized listing to read or modify. For example, to select Austrian German, pass \"de-AT\".",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "apkVersionCode",
- "language"
- ],
- "response": {
- "$ref": "ApkListing"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "list": {
- "id": "androidpublisher.edits.apklistings.list",
- "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings",
- "httpMethod": "GET",
- "description": "Lists all the APK-specific localized listings for a specified APK.",
- "parameters": {
- "apkVersionCode": {
- "type": "integer",
- "description": "The APK version code whose APK-specific listings should be read or modified.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "apkVersionCode"
- ],
- "response": {
- "$ref": "ApkListingsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "patch": {
- "id": "androidpublisher.edits.apklistings.patch",
- "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}",
- "httpMethod": "PATCH",
- "description": "Updates or creates the APK-specific localized listing for a specified APK and language code. This method supports patch semantics.",
- "parameters": {
- "apkVersionCode": {
- "type": "integer",
- "description": "The APK version code whose APK-specific listings should be read or modified.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "The language code (a BCP-47 language tag) of the APK-specific localized listing to read or modify. For example, to select Austrian German, pass \"de-AT\".",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "apkVersionCode",
- "language"
- ],
- "request": {
- "$ref": "ApkListing"
- },
- "response": {
- "$ref": "ApkListing"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "update": {
- "id": "androidpublisher.edits.apklistings.update",
- "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}",
- "httpMethod": "PUT",
- "description": "Updates or creates the APK-specific localized listing for a specified APK and language code.",
- "parameters": {
- "apkVersionCode": {
- "type": "integer",
- "description": "The APK version code whose APK-specific listings should be read or modified.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "The language code (a BCP-47 language tag) of the APK-specific localized listing to read or modify. For example, to select Austrian German, pass \"de-AT\".",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "apkVersionCode",
- "language"
- ],
- "request": {
- "$ref": "ApkListing"
- },
- "response": {
- "$ref": "ApkListing"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- }
- }
- },
- "apks": {
- "methods": {
- "addexternallyhosted": {
- "id": "androidpublisher.edits.apks.addexternallyhosted",
- "path": "{packageName}/edits/{editId}/apks/externallyHosted",
- "httpMethod": "POST",
- "description": "Creates a new APK without uploading the APK itself to Google Play, instead hosting the APK at a specified URL. This function is only available to enterprises using Google Play for Work whose application is configured to restrict distribution to the enterprise domain.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId"
- ],
- "request": {
- "$ref": "ApksAddExternallyHostedRequest"
- },
- "response": {
- "$ref": "ApksAddExternallyHostedResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "list": {
- "id": "androidpublisher.edits.apks.list",
- "path": "{packageName}/edits/{editId}/apks",
- "httpMethod": "GET",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId"
- ],
- "response": {
- "$ref": "ApksListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "upload": {
- "id": "androidpublisher.edits.apks.upload",
- "path": "{packageName}/edits/{editId}/apks",
- "httpMethod": "POST",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId"
- ],
- "response": {
- "$ref": "Apk"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ],
- "supportsMediaUpload": true,
- "mediaUpload": {
- "accept": [
- "application/octet-stream",
- "application/vnd.android.package-archive"
- ],
- "maxSize": "1GB",
- "protocols": {
- "simple": {
- "multipart": true,
- "path": "/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/apks"
- },
- "resumable": {
- "multipart": true,
- "path": "/resumable/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/apks"
- }
- }
- }
- }
- }
- },
- "details": {
- "methods": {
- "get": {
- "id": "androidpublisher.edits.details.get",
- "path": "{packageName}/edits/{editId}/details",
- "httpMethod": "GET",
- "description": "Fetches app details for this edit. This includes the default language and developer support contact information.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId"
- ],
- "response": {
- "$ref": "AppDetails"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "patch": {
- "id": "androidpublisher.edits.details.patch",
- "path": "{packageName}/edits/{editId}/details",
- "httpMethod": "PATCH",
- "description": "Updates app details for this edit. This method supports patch semantics.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId"
- ],
- "request": {
- "$ref": "AppDetails"
- },
- "response": {
- "$ref": "AppDetails"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "update": {
- "id": "androidpublisher.edits.details.update",
- "path": "{packageName}/edits/{editId}/details",
- "httpMethod": "PUT",
- "description": "Updates app details for this edit.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId"
- ],
- "request": {
- "$ref": "AppDetails"
- },
- "response": {
- "$ref": "AppDetails"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- }
- }
- },
- "expansionfiles": {
- "methods": {
- "get": {
- "id": "androidpublisher.edits.expansionfiles.get",
- "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}",
- "httpMethod": "GET",
- "description": "Fetches the Expansion File configuration for the APK specified.",
- "parameters": {
- "apkVersionCode": {
- "type": "integer",
- "description": "The version code of the APK whose Expansion File configuration is being read or modified.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "expansionFileType": {
- "type": "string",
- "required": true,
- "enum": [
- "main",
- "patch"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "apkVersionCode",
- "expansionFileType"
- ],
- "response": {
- "$ref": "ExpansionFile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "patch": {
- "id": "androidpublisher.edits.expansionfiles.patch",
- "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}",
- "httpMethod": "PATCH",
- "description": "Updates the APK's Expansion File configuration to reference another APK's Expansion Files. To add a new Expansion File use the Upload method. This method supports patch semantics.",
- "parameters": {
- "apkVersionCode": {
- "type": "integer",
- "description": "The version code of the APK whose Expansion File configuration is being read or modified.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "expansionFileType": {
- "type": "string",
- "required": true,
- "enum": [
- "main",
- "patch"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "apkVersionCode",
- "expansionFileType"
- ],
- "request": {
- "$ref": "ExpansionFile"
- },
- "response": {
- "$ref": "ExpansionFile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "update": {
- "id": "androidpublisher.edits.expansionfiles.update",
- "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}",
- "httpMethod": "PUT",
- "description": "Updates the APK's Expansion File configuration to reference another APK's Expansion Files. To add a new Expansion File use the Upload method.",
- "parameters": {
- "apkVersionCode": {
- "type": "integer",
- "description": "The version code of the APK whose Expansion File configuration is being read or modified.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "expansionFileType": {
- "type": "string",
- "required": true,
- "enum": [
- "main",
- "patch"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "apkVersionCode",
- "expansionFileType"
- ],
- "request": {
- "$ref": "ExpansionFile"
- },
- "response": {
- "$ref": "ExpansionFile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "upload": {
- "id": "androidpublisher.edits.expansionfiles.upload",
- "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}",
- "httpMethod": "POST",
- "description": "Uploads and attaches a new Expansion File to the APK specified.",
- "parameters": {
- "apkVersionCode": {
- "type": "integer",
- "description": "The version code of the APK whose Expansion File configuration is being read or modified.",
- "required": true,
- "format": "int32",
- "location": "path"
- },
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "expansionFileType": {
- "type": "string",
- "required": true,
- "enum": [
- "main",
- "patch"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "apkVersionCode",
- "expansionFileType"
- ],
- "response": {
- "$ref": "ExpansionFilesUploadResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ],
- "supportsMediaUpload": true,
- "mediaUpload": {
- "accept": [
- "application/octet-stream"
- ],
- "maxSize": "2048MB",
- "protocols": {
- "simple": {
- "multipart": true,
- "path": "/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}"
- },
- "resumable": {
- "multipart": true,
- "path": "/resumable/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}"
- }
- }
- }
- }
- }
- },
- "images": {
- "methods": {
- "delete": {
- "id": "androidpublisher.edits.images.delete",
- "path": "{packageName}/edits/{editId}/listings/{language}/{imageType}/{imageId}",
- "httpMethod": "DELETE",
- "description": "Deletes the image (specified by id) from the edit.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "imageId": {
- "type": "string",
- "description": "Unique identifier an image within the set of images attached to this edit.",
- "required": true,
- "location": "path"
- },
- "imageType": {
- "type": "string",
- "required": true,
- "enum": [
- "featureGraphic",
- "icon",
- "phoneScreenshots",
- "promoGraphic",
- "sevenInchScreenshots",
- "tenInchScreenshots",
- "tvBanner",
- "tvScreenshots",
- "wearScreenshots"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass \"de-AT\".",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "language",
- "imageType",
- "imageId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "deleteall": {
- "id": "androidpublisher.edits.images.deleteall",
- "path": "{packageName}/edits/{editId}/listings/{language}/{imageType}",
- "httpMethod": "DELETE",
- "description": "Deletes all images for the specified language and image type.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "imageType": {
- "type": "string",
- "required": true,
- "enum": [
- "featureGraphic",
- "icon",
- "phoneScreenshots",
- "promoGraphic",
- "sevenInchScreenshots",
- "tenInchScreenshots",
- "tvBanner",
- "tvScreenshots",
- "wearScreenshots"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass \"de-AT\".",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "language",
- "imageType"
- ],
- "response": {
- "$ref": "ImagesDeleteAllResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "list": {
- "id": "androidpublisher.edits.images.list",
- "path": "{packageName}/edits/{editId}/listings/{language}/{imageType}",
- "httpMethod": "GET",
- "description": "Lists all images for the specified language and image type.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "imageType": {
- "type": "string",
- "required": true,
- "enum": [
- "featureGraphic",
- "icon",
- "phoneScreenshots",
- "promoGraphic",
- "sevenInchScreenshots",
- "tenInchScreenshots",
- "tvBanner",
- "tvScreenshots",
- "wearScreenshots"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass \"de-AT\".",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "language",
- "imageType"
- ],
- "response": {
- "$ref": "ImagesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "upload": {
- "id": "androidpublisher.edits.images.upload",
- "path": "{packageName}/edits/{editId}/listings/{language}/{imageType}",
- "httpMethod": "POST",
- "description": "Uploads a new image and adds it to the list of images for the specified language and image type.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "imageType": {
- "type": "string",
- "required": true,
- "enum": [
- "featureGraphic",
- "icon",
- "phoneScreenshots",
- "promoGraphic",
- "sevenInchScreenshots",
- "tenInchScreenshots",
- "tvBanner",
- "tvScreenshots",
- "wearScreenshots"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass \"de-AT\".",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "language",
- "imageType"
- ],
- "response": {
- "$ref": "ImagesUploadResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ],
- "supportsMediaUpload": true,
- "mediaUpload": {
- "accept": [
- "image/*"
- ],
- "maxSize": "15MB",
- "protocols": {
- "simple": {
- "multipart": true,
- "path": "/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}"
- },
- "resumable": {
- "multipart": true,
- "path": "/resumable/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}"
- }
- }
- }
- }
- }
- },
- "listings": {
- "methods": {
- "delete": {
- "id": "androidpublisher.edits.listings.delete",
- "path": "{packageName}/edits/{editId}/listings/{language}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified localized store listing from an edit.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass \"de-AT\".",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "language"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "deleteall": {
- "id": "androidpublisher.edits.listings.deleteall",
- "path": "{packageName}/edits/{editId}/listings",
- "httpMethod": "DELETE",
- "description": "Deletes all localized listings from an edit.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "get": {
- "id": "androidpublisher.edits.listings.get",
- "path": "{packageName}/edits/{editId}/listings/{language}",
- "httpMethod": "GET",
- "description": "Fetches information about a localized store listing.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass \"de-AT\".",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "language"
- ],
- "response": {
- "$ref": "Listing"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "list": {
- "id": "androidpublisher.edits.listings.list",
- "path": "{packageName}/edits/{editId}/listings",
- "httpMethod": "GET",
- "description": "Returns all of the localized store listings attached to this edit.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId"
- ],
- "response": {
- "$ref": "ListingsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "patch": {
- "id": "androidpublisher.edits.listings.patch",
- "path": "{packageName}/edits/{editId}/listings/{language}",
- "httpMethod": "PATCH",
- "description": "Creates or updates a localized store listing. This method supports patch semantics.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass \"de-AT\".",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "language"
- ],
- "request": {
- "$ref": "Listing"
- },
- "response": {
- "$ref": "Listing"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "update": {
- "id": "androidpublisher.edits.listings.update",
- "path": "{packageName}/edits/{editId}/listings/{language}",
- "httpMethod": "PUT",
- "description": "Creates or updates a localized store listing.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "language": {
- "type": "string",
- "description": "The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass \"de-AT\".",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "language"
- ],
- "request": {
- "$ref": "Listing"
- },
- "response": {
- "$ref": "Listing"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- }
- }
- },
- "testers": {
- "methods": {
- "get": {
- "id": "androidpublisher.edits.testers.get",
- "path": "{packageName}/edits/{editId}/testers/{track}",
- "httpMethod": "GET",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- },
- "track": {
- "type": "string",
- "required": true,
- "enum": [
- "alpha",
- "beta",
- "production",
- "rollout"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "track"
- ],
- "response": {
- "$ref": "Testers"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "patch": {
- "id": "androidpublisher.edits.testers.patch",
- "path": "{packageName}/edits/{editId}/testers/{track}",
- "httpMethod": "PATCH",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- },
- "track": {
- "type": "string",
- "required": true,
- "enum": [
- "alpha",
- "beta",
- "production",
- "rollout"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "track"
- ],
- "request": {
- "$ref": "Testers"
- },
- "response": {
- "$ref": "Testers"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "update": {
- "id": "androidpublisher.edits.testers.update",
- "path": "{packageName}/edits/{editId}/testers/{track}",
- "httpMethod": "PUT",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- },
- "track": {
- "type": "string",
- "required": true,
- "enum": [
- "alpha",
- "beta",
- "production",
- "rollout"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "track"
- ],
- "request": {
- "$ref": "Testers"
- },
- "response": {
- "$ref": "Testers"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- }
- }
- },
- "tracks": {
- "methods": {
- "get": {
- "id": "androidpublisher.edits.tracks.get",
- "path": "{packageName}/edits/{editId}/tracks/{track}",
- "httpMethod": "GET",
- "description": "Fetches the track configuration for the specified track type. Includes the APK version codes that are in this track.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- },
- "track": {
- "type": "string",
- "description": "The track type to read or modify.",
- "required": true,
- "enum": [
- "alpha",
- "beta",
- "production",
- "rollout"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "track"
- ],
- "response": {
- "$ref": "Track"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "list": {
- "id": "androidpublisher.edits.tracks.list",
- "path": "{packageName}/edits/{editId}/tracks",
- "httpMethod": "GET",
- "description": "Lists all the track configurations for this edit.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId"
- ],
- "response": {
- "$ref": "TracksListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "patch": {
- "id": "androidpublisher.edits.tracks.patch",
- "path": "{packageName}/edits/{editId}/tracks/{track}",
- "httpMethod": "PATCH",
- "description": "Updates the track configuration for the specified track type. When halted, the rollout track cannot be updated without adding new APKs, and adding new APKs will cause it to resume. This method supports patch semantics.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- },
- "track": {
- "type": "string",
- "description": "The track type to read or modify.",
- "required": true,
- "enum": [
- "alpha",
- "beta",
- "production",
- "rollout"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "track"
- ],
- "request": {
- "$ref": "Track"
- },
- "response": {
- "$ref": "Track"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "update": {
- "id": "androidpublisher.edits.tracks.update",
- "path": "{packageName}/edits/{editId}/tracks/{track}",
- "httpMethod": "PUT",
- "description": "Updates the track configuration for the specified track type. When halted, the rollout track cannot be updated without adding new APKs, and adding new APKs will cause it to resume.",
- "parameters": {
- "editId": {
- "type": "string",
- "description": "Unique identifier for this edit.",
- "required": true,
- "location": "path"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- },
- "track": {
- "type": "string",
- "description": "The track type to read or modify.",
- "required": true,
- "enum": [
- "alpha",
- "beta",
- "production",
- "rollout"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "editId",
- "track"
- ],
- "request": {
- "$ref": "Track"
- },
- "response": {
- "$ref": "Track"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- }
- }
- }
- }
- },
- "entitlements": {
- "methods": {
- "list": {
- "id": "androidpublisher.entitlements.list",
- "path": "{packageName}/entitlements",
- "httpMethod": "GET",
- "description": "Lists the user's current inapp item or subscription entitlements",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "format": "uint32",
- "location": "query"
- },
- "packageName": {
- "type": "string",
- "description": "The package name of the application the inapp product was sold in (for example, 'com.some.thing').",
- "required": true,
- "location": "path"
- },
- "productId": {
- "type": "string",
- "description": "The product id of the inapp product (for example, 'sku1'). This can be used to restrict the result set.",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "format": "uint32",
- "location": "query"
- },
- "token": {
- "type": "string",
- "location": "query"
- }
- },
- "parameterOrder": [
- "packageName"
- ],
- "response": {
- "$ref": "EntitlementsListResponse"
- }
- }
- }
- },
- "inappproducts": {
- "methods": {
- "batch": {
- "id": "androidpublisher.inappproducts.batch",
- "path": "inappproducts/batch",
- "httpMethod": "POST",
- "request": {
- "$ref": "InappproductsBatchRequest"
- },
- "response": {
- "$ref": "InappproductsBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "delete": {
- "id": "androidpublisher.inappproducts.delete",
- "path": "{packageName}/inappproducts/{sku}",
- "httpMethod": "DELETE",
- "description": "Delete an in-app product for an app.",
- "parameters": {
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app with the in-app product; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- },
- "sku": {
- "type": "string",
- "description": "Unique identifier for the in-app product.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "sku"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "get": {
- "id": "androidpublisher.inappproducts.get",
- "path": "{packageName}/inappproducts/{sku}",
- "httpMethod": "GET",
- "description": "Returns information about the in-app product specified.",
- "parameters": {
- "packageName": {
- "type": "string",
- "required": true,
- "location": "path"
- },
- "sku": {
- "type": "string",
- "description": "Unique identifier for the in-app product.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "sku"
- ],
- "response": {
- "$ref": "InAppProduct"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "insert": {
- "id": "androidpublisher.inappproducts.insert",
- "path": "{packageName}/inappproducts",
- "httpMethod": "POST",
- "description": "Creates a new in-app product for an app.",
- "parameters": {
- "autoConvertMissingPrices": {
- "type": "boolean",
- "description": "If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.",
- "location": "query"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName"
- ],
- "request": {
- "$ref": "InAppProduct"
- },
- "response": {
- "$ref": "InAppProduct"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "list": {
- "id": "androidpublisher.inappproducts.list",
- "path": "{packageName}/inappproducts",
- "httpMethod": "GET",
- "description": "List all the in-app products for an Android app, both subscriptions and managed in-app products..",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "format": "uint32",
- "location": "query"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app with in-app products; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- },
- "startIndex": {
- "type": "integer",
- "format": "uint32",
- "location": "query"
- },
- "token": {
- "type": "string",
- "location": "query"
- }
- },
- "parameterOrder": [
- "packageName"
- ],
- "response": {
- "$ref": "InappproductsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "patch": {
- "id": "androidpublisher.inappproducts.patch",
- "path": "{packageName}/inappproducts/{sku}",
- "httpMethod": "PATCH",
- "description": "Updates the details of an in-app product. This method supports patch semantics.",
- "parameters": {
- "autoConvertMissingPrices": {
- "type": "boolean",
- "description": "If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.",
- "location": "query"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app with the in-app product; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- },
- "sku": {
- "type": "string",
- "description": "Unique identifier for the in-app product.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "sku"
- ],
- "request": {
- "$ref": "InAppProduct"
- },
- "response": {
- "$ref": "InAppProduct"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "update": {
- "id": "androidpublisher.inappproducts.update",
- "path": "{packageName}/inappproducts/{sku}",
- "httpMethod": "PUT",
- "description": "Updates the details of an in-app product.",
- "parameters": {
- "autoConvertMissingPrices": {
- "type": "boolean",
- "description": "If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.",
- "location": "query"
- },
- "packageName": {
- "type": "string",
- "description": "Unique identifier for the Android app with the in-app product; for example, \"com.spiffygame\".",
- "required": true,
- "location": "path"
- },
- "sku": {
- "type": "string",
- "description": "Unique identifier for the in-app product.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "sku"
- ],
- "request": {
- "$ref": "InAppProduct"
- },
- "response": {
- "$ref": "InAppProduct"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- }
- }
- },
- "purchases": {
- "resources": {
- "products": {
- "methods": {
- "get": {
- "id": "androidpublisher.purchases.products.get",
- "path": "{packageName}/purchases/products/{productId}/tokens/{token}",
- "httpMethod": "GET",
- "description": "Checks the purchase and consumption status of an inapp item.",
- "parameters": {
- "packageName": {
- "type": "string",
- "description": "The package name of the application the inapp product was sold in (for example, 'com.some.thing').",
- "required": true,
- "location": "path"
- },
- "productId": {
- "type": "string",
- "description": "The inapp product SKU (for example, 'com.some.thing.inapp1').",
- "required": true,
- "location": "path"
- },
- "token": {
- "type": "string",
- "description": "The token provided to the user's device when the inapp product was purchased.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "productId",
- "token"
- ],
- "response": {
- "$ref": "ProductPurchase"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- }
- }
- },
- "subscriptions": {
- "methods": {
- "cancel": {
- "id": "androidpublisher.purchases.subscriptions.cancel",
- "path": "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:cancel",
- "httpMethod": "POST",
- "description": "Cancels a user's subscription purchase. The subscription remains valid until its expiration time.",
- "parameters": {
- "packageName": {
- "type": "string",
- "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
- "required": true,
- "location": "path"
- },
- "subscriptionId": {
- "type": "string",
- "description": "The purchased subscription ID (for example, 'monthly001').",
- "required": true,
- "location": "path"
- },
- "token": {
- "type": "string",
- "description": "The token provided to the user's device when the subscription was purchased.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "subscriptionId",
- "token"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "defer": {
- "id": "androidpublisher.purchases.subscriptions.defer",
- "path": "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:defer",
- "httpMethod": "POST",
- "description": "Defers a user's subscription purchase until a specified future expiration time.",
- "parameters": {
- "packageName": {
- "type": "string",
- "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
- "required": true,
- "location": "path"
- },
- "subscriptionId": {
- "type": "string",
- "description": "The purchased subscription ID (for example, 'monthly001').",
- "required": true,
- "location": "path"
- },
- "token": {
- "type": "string",
- "description": "The token provided to the user's device when the subscription was purchased.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "subscriptionId",
- "token"
- ],
- "request": {
- "$ref": "SubscriptionPurchasesDeferRequest"
- },
- "response": {
- "$ref": "SubscriptionPurchasesDeferResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "get": {
- "id": "androidpublisher.purchases.subscriptions.get",
- "path": "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}",
- "httpMethod": "GET",
- "description": "Checks whether a user's subscription purchase is valid and returns its expiry time.",
- "parameters": {
- "packageName": {
- "type": "string",
- "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
- "required": true,
- "location": "path"
- },
- "subscriptionId": {
- "type": "string",
- "description": "The purchased subscription ID (for example, 'monthly001').",
- "required": true,
- "location": "path"
- },
- "token": {
- "type": "string",
- "description": "The token provided to the user's device when the subscription was purchased.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "subscriptionId",
- "token"
- ],
- "response": {
- "$ref": "SubscriptionPurchase"
- },
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "refund": {
- "id": "androidpublisher.purchases.subscriptions.refund",
- "path": "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:refund",
- "httpMethod": "POST",
- "description": "Refunds a user's subscription purchase, but the subscription remains valid until its expiration time and it will continue to recur.",
- "parameters": {
- "packageName": {
- "type": "string",
- "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
- "required": true,
- "location": "path"
- },
- "subscriptionId": {
- "type": "string",
- "description": "The purchased subscription ID (for example, 'monthly001').",
- "required": true,
- "location": "path"
- },
- "token": {
- "type": "string",
- "description": "The token provided to the user's device when the subscription was purchased.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "subscriptionId",
- "token"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- },
- "revoke": {
- "id": "androidpublisher.purchases.subscriptions.revoke",
- "path": "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:revoke",
- "httpMethod": "POST",
- "description": "Refunds and immediately revokes a user's subscription purchase. Access to the subscription will be terminated immediately and it will stop recurring.",
- "parameters": {
- "packageName": {
- "type": "string",
- "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
- "required": true,
- "location": "path"
- },
- "subscriptionId": {
- "type": "string",
- "description": "The purchased subscription ID (for example, 'monthly001').",
- "required": true,
- "location": "path"
- },
- "token": {
- "type": "string",
- "description": "The token provided to the user's device when the subscription was purchased.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "packageName",
- "subscriptionId",
- "token"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/androidpublisher"
- ]
- }
- }
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/androidpublisher/v2/androidpublisher-gen.go b/vendor/google.golang.org/api/androidpublisher/v2/androidpublisher-gen.go
deleted file mode 100644
index e88b027f..00000000
--- a/vendor/google.golang.org/api/androidpublisher/v2/androidpublisher-gen.go
+++ /dev/null
@@ -1,9050 +0,0 @@
-// Package androidpublisher provides access to the Google Play Developer API.
-//
-// See https://developers.google.com/android-publisher
-//
-// Usage example:
-//
-// import "google.golang.org/api/androidpublisher/v2"
-// ...
-// androidpublisherService, err := androidpublisher.New(oauthHttpClient)
-package androidpublisher // import "google.golang.org/api/androidpublisher/v2"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "androidpublisher:v2"
-const apiName = "androidpublisher"
-const apiVersion = "v2"
-const basePath = "https://www.googleapis.com/androidpublisher/v2/applications/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your Google Play Developer account
- AndroidpublisherScope = "https://www.googleapis.com/auth/androidpublisher"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Edits = NewEditsService(s)
- s.Entitlements = NewEntitlementsService(s)
- s.Inappproducts = NewInappproductsService(s)
- s.Purchases = NewPurchasesService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Edits *EditsService
-
- Entitlements *EntitlementsService
-
- Inappproducts *InappproductsService
-
- Purchases *PurchasesService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewEditsService(s *Service) *EditsService {
- rs := &EditsService{s: s}
- rs.Apklistings = NewEditsApklistingsService(s)
- rs.Apks = NewEditsApksService(s)
- rs.Details = NewEditsDetailsService(s)
- rs.Expansionfiles = NewEditsExpansionfilesService(s)
- rs.Images = NewEditsImagesService(s)
- rs.Listings = NewEditsListingsService(s)
- rs.Testers = NewEditsTestersService(s)
- rs.Tracks = NewEditsTracksService(s)
- return rs
-}
-
-type EditsService struct {
- s *Service
-
- Apklistings *EditsApklistingsService
-
- Apks *EditsApksService
-
- Details *EditsDetailsService
-
- Expansionfiles *EditsExpansionfilesService
-
- Images *EditsImagesService
-
- Listings *EditsListingsService
-
- Testers *EditsTestersService
-
- Tracks *EditsTracksService
-}
-
-func NewEditsApklistingsService(s *Service) *EditsApklistingsService {
- rs := &EditsApklistingsService{s: s}
- return rs
-}
-
-type EditsApklistingsService struct {
- s *Service
-}
-
-func NewEditsApksService(s *Service) *EditsApksService {
- rs := &EditsApksService{s: s}
- return rs
-}
-
-type EditsApksService struct {
- s *Service
-}
-
-func NewEditsDetailsService(s *Service) *EditsDetailsService {
- rs := &EditsDetailsService{s: s}
- return rs
-}
-
-type EditsDetailsService struct {
- s *Service
-}
-
-func NewEditsExpansionfilesService(s *Service) *EditsExpansionfilesService {
- rs := &EditsExpansionfilesService{s: s}
- return rs
-}
-
-type EditsExpansionfilesService struct {
- s *Service
-}
-
-func NewEditsImagesService(s *Service) *EditsImagesService {
- rs := &EditsImagesService{s: s}
- return rs
-}
-
-type EditsImagesService struct {
- s *Service
-}
-
-func NewEditsListingsService(s *Service) *EditsListingsService {
- rs := &EditsListingsService{s: s}
- return rs
-}
-
-type EditsListingsService struct {
- s *Service
-}
-
-func NewEditsTestersService(s *Service) *EditsTestersService {
- rs := &EditsTestersService{s: s}
- return rs
-}
-
-type EditsTestersService struct {
- s *Service
-}
-
-func NewEditsTracksService(s *Service) *EditsTracksService {
- rs := &EditsTracksService{s: s}
- return rs
-}
-
-type EditsTracksService struct {
- s *Service
-}
-
-func NewEntitlementsService(s *Service) *EntitlementsService {
- rs := &EntitlementsService{s: s}
- return rs
-}
-
-type EntitlementsService struct {
- s *Service
-}
-
-func NewInappproductsService(s *Service) *InappproductsService {
- rs := &InappproductsService{s: s}
- return rs
-}
-
-type InappproductsService struct {
- s *Service
-}
-
-func NewPurchasesService(s *Service) *PurchasesService {
- rs := &PurchasesService{s: s}
- rs.Products = NewPurchasesProductsService(s)
- rs.Subscriptions = NewPurchasesSubscriptionsService(s)
- return rs
-}
-
-type PurchasesService struct {
- s *Service
-
- Products *PurchasesProductsService
-
- Subscriptions *PurchasesSubscriptionsService
-}
-
-func NewPurchasesProductsService(s *Service) *PurchasesProductsService {
- rs := &PurchasesProductsService{s: s}
- return rs
-}
-
-type PurchasesProductsService struct {
- s *Service
-}
-
-func NewPurchasesSubscriptionsService(s *Service) *PurchasesSubscriptionsService {
- rs := &PurchasesSubscriptionsService{s: s}
- return rs
-}
-
-type PurchasesSubscriptionsService struct {
- s *Service
-}
-
-type Apk struct {
- // Binary: Information about the binary payload of this APK.
- Binary *ApkBinary `json:"binary,omitempty"`
-
- // VersionCode: The version code of the APK, as specified in the APK's
- // manifest file.
- VersionCode int64 `json:"versionCode,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Binary") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Apk) MarshalJSON() ([]byte, error) {
- type noMethod Apk
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ApkBinary: Represents the binary payload of an APK.
-type ApkBinary struct {
- // Sha1: A sha1 hash of the APK payload, encoded as a hex string and
- // matching the output of the sha1sum command.
- Sha1 string `json:"sha1,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Sha1") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ApkBinary) MarshalJSON() ([]byte, error) {
- type noMethod ApkBinary
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ApkListing struct {
- // Language: The language code, in BCP 47 format (eg "en-US").
- Language string `json:"language,omitempty"`
-
- // RecentChanges: Describe what's new in your APK.
- RecentChanges string `json:"recentChanges,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Language") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ApkListing) MarshalJSON() ([]byte, error) {
- type noMethod ApkListing
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ApkListingsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidpublisher#apkListingsListResponse".
- Kind string `json:"kind,omitempty"`
-
- Listings []*ApkListing `json:"listings,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ApkListingsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod ApkListingsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ApksAddExternallyHostedRequest struct {
- // ExternallyHostedApk: The definition of the externally-hosted APK and
- // where it is located.
- ExternallyHostedApk *ExternallyHostedApk `json:"externallyHostedApk,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ExternallyHostedApk")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ApksAddExternallyHostedRequest) MarshalJSON() ([]byte, error) {
- type noMethod ApksAddExternallyHostedRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ApksAddExternallyHostedResponse struct {
- // ExternallyHostedApk: The definition of the externally-hosted APK and
- // where it is located.
- ExternallyHostedApk *ExternallyHostedApk `json:"externallyHostedApk,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ExternallyHostedApk")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ApksAddExternallyHostedResponse) MarshalJSON() ([]byte, error) {
- type noMethod ApksAddExternallyHostedResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ApksListResponse struct {
- Apks []*Apk `json:"apks,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidpublisher#apksListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Apks") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ApksListResponse) MarshalJSON() ([]byte, error) {
- type noMethod ApksListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AppDetails struct {
- // ContactEmail: The user-visible support email for this app.
- ContactEmail string `json:"contactEmail,omitempty"`
-
- // ContactPhone: The user-visible support telephone number for this app.
- ContactPhone string `json:"contactPhone,omitempty"`
-
- // ContactWebsite: The user-visible website for this app.
- ContactWebsite string `json:"contactWebsite,omitempty"`
-
- // DefaultLanguage: Default language code, in BCP 47 format (eg
- // "en-US").
- DefaultLanguage string `json:"defaultLanguage,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ContactEmail") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AppDetails) MarshalJSON() ([]byte, error) {
- type noMethod AppDetails
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AppEdit: Represents an edit of an app. An edit allows clients to make
-// multiple changes before committing them in one operation.
-type AppEdit struct {
- // ExpiryTimeSeconds: The time at which the edit will expire and will be
- // no longer valid for use in any subsequent API calls (encoded as
- // seconds since the Epoch).
- ExpiryTimeSeconds string `json:"expiryTimeSeconds,omitempty"`
-
- // Id: The ID of the edit that can be used in subsequent API calls.
- Id string `json:"id,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ExpiryTimeSeconds")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AppEdit) MarshalJSON() ([]byte, error) {
- type noMethod AppEdit
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Entitlement: An Entitlement resource indicates a user's current
-// entitlement to an inapp item or subscription.
-type Entitlement struct {
- // Kind: This kind represents an entitlement object in the
- // androidpublisher service.
- Kind string `json:"kind,omitempty"`
-
- // ProductId: The SKU of the product.
- ProductId string `json:"productId,omitempty"`
-
- // ProductType: The type of the inapp product. Possible values are:
- // - In-app item: "inapp"
- // - Subscription: "subs"
- ProductType string `json:"productType,omitempty"`
-
- // Token: The token which can be verified using the subscriptions or
- // products API.
- Token string `json:"token,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Entitlement) MarshalJSON() ([]byte, error) {
- type noMethod Entitlement
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type EntitlementsListResponse struct {
- PageInfo *PageInfo `json:"pageInfo,omitempty"`
-
- Resources []*Entitlement `json:"resources,omitempty"`
-
- TokenPagination *TokenPagination `json:"tokenPagination,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "PageInfo") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EntitlementsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod EntitlementsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ExpansionFile struct {
- // FileSize: If set this field indicates that this APK has an Expansion
- // File uploaded to it: this APK does not reference another APK's
- // Expansion File. The field's value is the size of the uploaded
- // Expansion File in bytes.
- FileSize int64 `json:"fileSize,omitempty,string"`
-
- // ReferencesVersion: If set this APK's Expansion File references
- // another APK's Expansion File. The file_size field will not be set.
- ReferencesVersion int64 `json:"referencesVersion,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "FileSize") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ExpansionFile) MarshalJSON() ([]byte, error) {
- type noMethod ExpansionFile
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ExpansionFilesUploadResponse struct {
- ExpansionFile *ExpansionFile `json:"expansionFile,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ExpansionFile") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ExpansionFilesUploadResponse) MarshalJSON() ([]byte, error) {
- type noMethod ExpansionFilesUploadResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ExternallyHostedApk: Defines an APK available for this application
-// that is hosted externally and not uploaded to Google Play. This
-// function is only available to enterprises who are using Google Play
-// for Work, and whos application is restricted to the enterprise
-// private channel
-type ExternallyHostedApk struct {
- // ApplicationLabel: The application label.
- ApplicationLabel string `json:"applicationLabel,omitempty"`
-
- // CertificateBase64s: A certificate (or array of certificates if a
- // certificate-chain is used) used to signed this APK, represented as a
- // base64 encoded byte array.
- CertificateBase64s []string `json:"certificateBase64s,omitempty"`
-
- // ExternallyHostedUrl: The URL at which the APK is hosted. This must be
- // an https URL.
- ExternallyHostedUrl string `json:"externallyHostedUrl,omitempty"`
-
- // FileSha1Base64: The SHA1 checksum of this APK, represented as a
- // base64 encoded byte array.
- FileSha1Base64 string `json:"fileSha1Base64,omitempty"`
-
- // FileSha256Base64: The SHA256 checksum of this APK, represented as a
- // base64 encoded byte array.
- FileSha256Base64 string `json:"fileSha256Base64,omitempty"`
-
- // FileSize: The file size in bytes of this APK.
- FileSize int64 `json:"fileSize,omitempty,string"`
-
- // IconBase64: The icon image from the APK, as a base64 encoded byte
- // array.
- IconBase64 string `json:"iconBase64,omitempty"`
-
- // MaximumSdk: The maximum SDK supported by this APK (optional).
- MaximumSdk int64 `json:"maximumSdk,omitempty"`
-
- // MinimumSdk: The minimum SDK targeted by this APK.
- MinimumSdk int64 `json:"minimumSdk,omitempty"`
-
- // NativeCodes: The native code environments supported by this APK
- // (optional).
- NativeCodes []string `json:"nativeCodes,omitempty"`
-
- // PackageName: The package name.
- PackageName string `json:"packageName,omitempty"`
-
- // UsesFeatures: The features required by this APK (optional).
- UsesFeatures []string `json:"usesFeatures,omitempty"`
-
- // UsesPermissions: The permissions requested by this APK.
- UsesPermissions []*ExternallyHostedApkUsesPermission `json:"usesPermissions,omitempty"`
-
- // VersionCode: The version code of this APK.
- VersionCode int64 `json:"versionCode,omitempty"`
-
- // VersionName: The version name of this APK.
- VersionName string `json:"versionName,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ApplicationLabel") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ExternallyHostedApk) MarshalJSON() ([]byte, error) {
- type noMethod ExternallyHostedApk
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ExternallyHostedApkUsesPermission: A permission used by this APK.
-type ExternallyHostedApkUsesPermission struct {
- // MaxSdkVersion: Optionally, the maximum SDK version for which the
- // permission is required.
- MaxSdkVersion int64 `json:"maxSdkVersion,omitempty"`
-
- // Name: The name of the permission requested.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "MaxSdkVersion") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ExternallyHostedApkUsesPermission) MarshalJSON() ([]byte, error) {
- type noMethod ExternallyHostedApkUsesPermission
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Image struct {
- // Id: A unique id representing this image.
- Id string `json:"id,omitempty"`
-
- // Sha1: A sha1 hash of the image that was uploaded.
- Sha1 string `json:"sha1,omitempty"`
-
- // Url: A URL that will serve a preview of the image.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Image) MarshalJSON() ([]byte, error) {
- type noMethod Image
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ImagesDeleteAllResponse struct {
- Deleted []*Image `json:"deleted,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Deleted") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ImagesDeleteAllResponse) MarshalJSON() ([]byte, error) {
- type noMethod ImagesDeleteAllResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ImagesListResponse struct {
- Images []*Image `json:"images,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Images") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ImagesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod ImagesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ImagesUploadResponse struct {
- Image *Image `json:"image,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Image") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ImagesUploadResponse) MarshalJSON() ([]byte, error) {
- type noMethod ImagesUploadResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InAppProduct struct {
- // DefaultLanguage: The default language of the localized data, as
- // defined by BCP 47. e.g. "en-US", "en-GB".
- DefaultLanguage string `json:"defaultLanguage,omitempty"`
-
- // DefaultPrice: Default price cannot be zero. In-app products can never
- // be free. Default price is always in the developer's Checkout merchant
- // currency.
- DefaultPrice *Price `json:"defaultPrice,omitempty"`
-
- // Listings: List of localized title and description data.
- Listings map[string]InAppProductListing `json:"listings,omitempty"`
-
- // PackageName: The package name of the parent app.
- PackageName string `json:"packageName,omitempty"`
-
- // Prices: Prices per buyer region. None of these prices should be zero.
- // In-app products can never be free.
- Prices map[string]Price `json:"prices,omitempty"`
-
- // PurchaseType: Purchase type enum value. Unmodifiable after creation.
- PurchaseType string `json:"purchaseType,omitempty"`
-
- // Season: Definition of a season for a seasonal subscription. Can be
- // defined only for yearly subscriptions.
- Season *Season `json:"season,omitempty"`
-
- // Sku: The stock-keeping-unit (SKU) of the product, unique within an
- // app.
- Sku string `json:"sku,omitempty"`
-
- Status string `json:"status,omitempty"`
-
- // SubscriptionPeriod: Subscription period, specified in ISO 8601
- // format. Acceptable values are "P1W" (one week), "P1M" (one month) and
- // "P1Y" (one year).
- SubscriptionPeriod string `json:"subscriptionPeriod,omitempty"`
-
- // TrialPeriod: Trial period, specified in ISO 8601 format. Acceptable
- // values are anything between "P7D" (seven days) and "P999D" (999
- // days). Seasonal subscriptions cannot have a trial period.
- TrialPeriod string `json:"trialPeriod,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "DefaultLanguage") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InAppProduct) MarshalJSON() ([]byte, error) {
- type noMethod InAppProduct
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InAppProductListing struct {
- Description string `json:"description,omitempty"`
-
- Title string `json:"title,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Description") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InAppProductListing) MarshalJSON() ([]byte, error) {
- type noMethod InAppProductListing
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InappproductsBatchRequest struct {
- Entrys []*InappproductsBatchRequestEntry `json:"entrys,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Entrys") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InappproductsBatchRequest) MarshalJSON() ([]byte, error) {
- type noMethod InappproductsBatchRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InappproductsBatchRequestEntry struct {
- BatchId int64 `json:"batchId,omitempty"`
-
- Inappproductsinsertrequest *InappproductsInsertRequest `json:"inappproductsinsertrequest,omitempty"`
-
- Inappproductsupdaterequest *InappproductsUpdateRequest `json:"inappproductsupdaterequest,omitempty"`
-
- MethodName string `json:"methodName,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BatchId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InappproductsBatchRequestEntry) MarshalJSON() ([]byte, error) {
- type noMethod InappproductsBatchRequestEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InappproductsBatchResponse struct {
- Entrys []*InappproductsBatchResponseEntry `json:"entrys,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidpublisher#inappproductsBatchResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Entrys") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InappproductsBatchResponse) MarshalJSON() ([]byte, error) {
- type noMethod InappproductsBatchResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InappproductsBatchResponseEntry struct {
- BatchId int64 `json:"batchId,omitempty"`
-
- Inappproductsinsertresponse *InappproductsInsertResponse `json:"inappproductsinsertresponse,omitempty"`
-
- Inappproductsupdateresponse *InappproductsUpdateResponse `json:"inappproductsupdateresponse,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BatchId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InappproductsBatchResponseEntry) MarshalJSON() ([]byte, error) {
- type noMethod InappproductsBatchResponseEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InappproductsInsertRequest struct {
- Inappproduct *InAppProduct `json:"inappproduct,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Inappproduct") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InappproductsInsertRequest) MarshalJSON() ([]byte, error) {
- type noMethod InappproductsInsertRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InappproductsInsertResponse struct {
- Inappproduct *InAppProduct `json:"inappproduct,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Inappproduct") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InappproductsInsertResponse) MarshalJSON() ([]byte, error) {
- type noMethod InappproductsInsertResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InappproductsListResponse struct {
- Inappproduct []*InAppProduct `json:"inappproduct,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidpublisher#inappproductsListResponse".
- Kind string `json:"kind,omitempty"`
-
- PageInfo *PageInfo `json:"pageInfo,omitempty"`
-
- TokenPagination *TokenPagination `json:"tokenPagination,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Inappproduct") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InappproductsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod InappproductsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InappproductsUpdateRequest struct {
- Inappproduct *InAppProduct `json:"inappproduct,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Inappproduct") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InappproductsUpdateRequest) MarshalJSON() ([]byte, error) {
- type noMethod InappproductsUpdateRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InappproductsUpdateResponse struct {
- Inappproduct *InAppProduct `json:"inappproduct,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Inappproduct") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InappproductsUpdateResponse) MarshalJSON() ([]byte, error) {
- type noMethod InappproductsUpdateResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Listing struct {
- // FullDescription: Full description of the app; this may be up to 4000
- // characters in length.
- FullDescription string `json:"fullDescription,omitempty"`
-
- // Language: Language localization code (for example, "de-AT" for
- // Austrian German).
- Language string `json:"language,omitempty"`
-
- // ShortDescription: Short description of the app (previously known as
- // promo text); this may be up to 80 characters in length.
- ShortDescription string `json:"shortDescription,omitempty"`
-
- // Title: App's localized title.
- Title string `json:"title,omitempty"`
-
- // Video: URL of a promotional YouTube video for the app.
- Video string `json:"video,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "FullDescription") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Listing) MarshalJSON() ([]byte, error) {
- type noMethod Listing
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ListingsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidpublisher#listingsListResponse".
- Kind string `json:"kind,omitempty"`
-
- Listings []*Listing `json:"listings,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListingsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListingsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type MonthDay struct {
- // Day: Day of a month, value in [1, 31] range. Valid range depends on
- // the specified month.
- Day int64 `json:"day,omitempty"`
-
- // Month: Month of a year. e.g. 1 = JAN, 2 = FEB etc.
- Month int64 `json:"month,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Day") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MonthDay) MarshalJSON() ([]byte, error) {
- type noMethod MonthDay
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type PageInfo struct {
- ResultPerPage int64 `json:"resultPerPage,omitempty"`
-
- StartIndex int64 `json:"startIndex,omitempty"`
-
- TotalResults int64 `json:"totalResults,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ResultPerPage") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PageInfo) MarshalJSON() ([]byte, error) {
- type noMethod PageInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Price struct {
- // Currency: 3 letter Currency code, as defined by ISO 4217.
- Currency string `json:"currency,omitempty"`
-
- // PriceMicros: The price in millionths of the currency base unit
- // represented as a string.
- PriceMicros string `json:"priceMicros,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Currency") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Price) MarshalJSON() ([]byte, error) {
- type noMethod Price
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ProductPurchase: A ProductPurchase resource indicates the status of a
-// user's inapp product purchase.
-type ProductPurchase struct {
- // ConsumptionState: The consumption state of the inapp product.
- // Possible values are:
- // - Yet to be consumed
- // - Consumed
- ConsumptionState int64 `json:"consumptionState,omitempty"`
-
- // DeveloperPayload: A developer-specified string that contains
- // supplemental information about an order.
- DeveloperPayload string `json:"developerPayload,omitempty"`
-
- // Kind: This kind represents an inappPurchase object in the
- // androidpublisher service.
- Kind string `json:"kind,omitempty"`
-
- // PurchaseState: The purchase state of the order. Possible values are:
- //
- // - Purchased
- // - Cancelled
- PurchaseState int64 `json:"purchaseState,omitempty"`
-
- // PurchaseTimeMillis: The time the product was purchased, in
- // milliseconds since the epoch (Jan 1, 1970).
- PurchaseTimeMillis int64 `json:"purchaseTimeMillis,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ConsumptionState") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductPurchase) MarshalJSON() ([]byte, error) {
- type noMethod ProductPurchase
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Season struct {
- // End: Inclusive end date of the recurrence period.
- End *MonthDay `json:"end,omitempty"`
-
- // Start: Inclusive start date of the recurrence period.
- Start *MonthDay `json:"start,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "End") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Season) MarshalJSON() ([]byte, error) {
- type noMethod Season
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SubscriptionDeferralInfo: A SubscriptionDeferralInfo contains the
-// data needed to defer a subscription purchase to a future expiry time.
-type SubscriptionDeferralInfo struct {
- // DesiredExpiryTimeMillis: The desired next expiry time for the
- // subscription in milliseconds since Epoch. The given time must be
- // after the current expiry time for the subscription.
- DesiredExpiryTimeMillis int64 `json:"desiredExpiryTimeMillis,omitempty,string"`
-
- // ExpectedExpiryTimeMillis: The expected expiry time for the
- // subscription. If the current expiry time for the subscription is not
- // the value specified here, the deferral will not occur.
- ExpectedExpiryTimeMillis int64 `json:"expectedExpiryTimeMillis,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g.
- // "DesiredExpiryTimeMillis") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SubscriptionDeferralInfo) MarshalJSON() ([]byte, error) {
- type noMethod SubscriptionDeferralInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SubscriptionPurchase: A SubscriptionPurchase resource indicates the
-// status of a user's subscription purchase.
-type SubscriptionPurchase struct {
- // AutoRenewing: Whether the subscription will automatically be renewed
- // when it reaches its current expiry time.
- AutoRenewing bool `json:"autoRenewing,omitempty"`
-
- // ExpiryTimeMillis: Time at which the subscription will expire, in
- // milliseconds since Epoch.
- ExpiryTimeMillis int64 `json:"expiryTimeMillis,omitempty,string"`
-
- // Kind: This kind represents a subscriptionPurchase object in the
- // androidpublisher service.
- Kind string `json:"kind,omitempty"`
-
- // StartTimeMillis: Time at which the subscription was granted, in
- // milliseconds since Epoch.
- StartTimeMillis int64 `json:"startTimeMillis,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AutoRenewing") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SubscriptionPurchase) MarshalJSON() ([]byte, error) {
- type noMethod SubscriptionPurchase
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type SubscriptionPurchasesDeferRequest struct {
- // DeferralInfo: The information about the new desired expiry time for
- // the subscription.
- DeferralInfo *SubscriptionDeferralInfo `json:"deferralInfo,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DeferralInfo") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SubscriptionPurchasesDeferRequest) MarshalJSON() ([]byte, error) {
- type noMethod SubscriptionPurchasesDeferRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type SubscriptionPurchasesDeferResponse struct {
- // NewExpiryTimeMillis: The new expiry time for the subscription in
- // milliseconds since the Epoch.
- NewExpiryTimeMillis int64 `json:"newExpiryTimeMillis,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "NewExpiryTimeMillis")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SubscriptionPurchasesDeferResponse) MarshalJSON() ([]byte, error) {
- type noMethod SubscriptionPurchasesDeferResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Testers struct {
- GoogleGroups []string `json:"googleGroups,omitempty"`
-
- GooglePlusCommunities []string `json:"googlePlusCommunities,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "GoogleGroups") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Testers) MarshalJSON() ([]byte, error) {
- type noMethod Testers
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TokenPagination struct {
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- PreviousPageToken string `json:"previousPageToken,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "NextPageToken") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TokenPagination) MarshalJSON() ([]byte, error) {
- type noMethod TokenPagination
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Track struct {
- Track string `json:"track,omitempty"`
-
- UserFraction float64 `json:"userFraction,omitempty"`
-
- VersionCodes []int64 `json:"versionCodes,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Track") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Track) MarshalJSON() ([]byte, error) {
- type noMethod Track
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TracksListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "androidpublisher#tracksListResponse".
- Kind string `json:"kind,omitempty"`
-
- Tracks []*Track `json:"tracks,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TracksListResponse) MarshalJSON() ([]byte, error) {
- type noMethod TracksListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "androidpublisher.edits.commit":
-
-type EditsCommitCall struct {
- s *Service
- packageNameid string
- editId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Commit: Commits/applies the changes made in this edit back to the
-// app.
-func (r *EditsService) Commit(packageNameid string, editId string) *EditsCommitCall {
- c := &EditsCommitCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsCommitCall) Fields(s ...googleapi.Field) *EditsCommitCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsCommitCall) Context(ctx context.Context) *EditsCommitCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsCommitCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}:commit")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.commit" call.
-// Exactly one of *AppEdit or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AppEdit.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *EditsCommitCall) Do() (*AppEdit, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AppEdit{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Commits/applies the changes made in this edit back to the app.",
- // "httpMethod": "POST",
- // "id": "androidpublisher.edits.commit",
- // "parameterOrder": [
- // "packageName",
- // "editId"
- // ],
- // "parameters": {
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}:commit",
- // "response": {
- // "$ref": "AppEdit"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.delete":
-
-type EditsDeleteCall struct {
- s *Service
- packageNameid string
- editId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an edit for an app. Creating a new edit will
-// automatically delete any of your previous edits so this method need
-// only be called if you want to preemptively abandon an edit.
-func (r *EditsService) Delete(packageNameid string, editId string) *EditsDeleteCall {
- c := &EditsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsDeleteCall) Fields(s ...googleapi.Field) *EditsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsDeleteCall) Context(ctx context.Context) *EditsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.delete" call.
-func (c *EditsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes an edit for an app. Creating a new edit will automatically delete any of your previous edits so this method need only be called if you want to preemptively abandon an edit.",
- // "httpMethod": "DELETE",
- // "id": "androidpublisher.edits.delete",
- // "parameterOrder": [
- // "packageName",
- // "editId"
- // ],
- // "parameters": {
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.get":
-
-type EditsGetCall struct {
- s *Service
- packageNameid string
- editId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns information about the edit specified. Calls will fail if
-// the edit is no long active (e.g. has been deleted, superseded or
-// expired).
-func (r *EditsService) Get(packageNameid string, editId string) *EditsGetCall {
- c := &EditsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsGetCall) Fields(s ...googleapi.Field) *EditsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *EditsGetCall) IfNoneMatch(entityTag string) *EditsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsGetCall) Context(ctx context.Context) *EditsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.get" call.
-// Exactly one of *AppEdit or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AppEdit.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *EditsGetCall) Do() (*AppEdit, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AppEdit{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns information about the edit specified. Calls will fail if the edit is no long active (e.g. has been deleted, superseded or expired).",
- // "httpMethod": "GET",
- // "id": "androidpublisher.edits.get",
- // "parameterOrder": [
- // "packageName",
- // "editId"
- // ],
- // "parameters": {
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}",
- // "response": {
- // "$ref": "AppEdit"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.insert":
-
-type EditsInsertCall struct {
- s *Service
- packageNameid string
- appedit *AppEdit
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a new edit for an app, populated with the app's
-// current state.
-func (r *EditsService) Insert(packageNameid string, appedit *AppEdit) *EditsInsertCall {
- c := &EditsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.appedit = appedit
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsInsertCall) Fields(s ...googleapi.Field) *EditsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsInsertCall) Context(ctx context.Context) *EditsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.appedit)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.insert" call.
-// Exactly one of *AppEdit or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AppEdit.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *EditsInsertCall) Do() (*AppEdit, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AppEdit{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a new edit for an app, populated with the app's current state.",
- // "httpMethod": "POST",
- // "id": "androidpublisher.edits.insert",
- // "parameterOrder": [
- // "packageName"
- // ],
- // "parameters": {
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits",
- // "request": {
- // "$ref": "AppEdit"
- // },
- // "response": {
- // "$ref": "AppEdit"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.validate":
-
-type EditsValidateCall struct {
- s *Service
- packageNameid string
- editId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Validate: Checks that the edit can be successfully committed. The
-// edit's changes are not applied to the live app.
-func (r *EditsService) Validate(packageNameid string, editId string) *EditsValidateCall {
- c := &EditsValidateCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsValidateCall) Fields(s ...googleapi.Field) *EditsValidateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsValidateCall) Context(ctx context.Context) *EditsValidateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsValidateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}:validate")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.validate" call.
-// Exactly one of *AppEdit or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AppEdit.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *EditsValidateCall) Do() (*AppEdit, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AppEdit{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Checks that the edit can be successfully committed. The edit's changes are not applied to the live app.",
- // "httpMethod": "POST",
- // "id": "androidpublisher.edits.validate",
- // "parameterOrder": [
- // "packageName",
- // "editId"
- // ],
- // "parameters": {
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}:validate",
- // "response": {
- // "$ref": "AppEdit"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.apklistings.delete":
-
-type EditsApklistingsDeleteCall struct {
- s *Service
- packageNameid string
- editId string
- apkVersionCode int64
- language string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the APK-specific localized listing for a specified
-// APK and language code.
-func (r *EditsApklistingsService) Delete(packageNameid string, editId string, apkVersionCode int64, language string) *EditsApklistingsDeleteCall {
- c := &EditsApklistingsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- c.apkVersionCode = apkVersionCode
- c.language = language
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsApklistingsDeleteCall) Fields(s ...googleapi.Field) *EditsApklistingsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsApklistingsDeleteCall) Context(ctx context.Context) *EditsApklistingsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsApklistingsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- "apkVersionCode": strconv.FormatInt(c.apkVersionCode, 10),
- "language": c.language,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.apklistings.delete" call.
-func (c *EditsApklistingsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes the APK-specific localized listing for a specified APK and language code.",
- // "httpMethod": "DELETE",
- // "id": "androidpublisher.edits.apklistings.delete",
- // "parameterOrder": [
- // "packageName",
- // "editId",
- // "apkVersionCode",
- // "language"
- // ],
- // "parameters": {
- // "apkVersionCode": {
- // "description": "The APK version code whose APK-specific listings should be read or modified.",
- // "format": "int32",
- // "location": "path",
- // "required": true,
- // "type": "integer"
- // },
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "language": {
- // "description": "The language code (a BCP-47 language tag) of the APK-specific localized listing to read or modify. For example, to select Austrian German, pass \"de-AT\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}",
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.apklistings.deleteall":
-
-type EditsApklistingsDeleteallCall struct {
- s *Service
- packageNameid string
- editId string
- apkVersionCode int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Deleteall: Deletes all the APK-specific localized listings for a
-// specified APK.
-func (r *EditsApklistingsService) Deleteall(packageNameid string, editId string, apkVersionCode int64) *EditsApklistingsDeleteallCall {
- c := &EditsApklistingsDeleteallCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- c.apkVersionCode = apkVersionCode
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsApklistingsDeleteallCall) Fields(s ...googleapi.Field) *EditsApklistingsDeleteallCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsApklistingsDeleteallCall) Context(ctx context.Context) *EditsApklistingsDeleteallCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsApklistingsDeleteallCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- "apkVersionCode": strconv.FormatInt(c.apkVersionCode, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.apklistings.deleteall" call.
-func (c *EditsApklistingsDeleteallCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes all the APK-specific localized listings for a specified APK.",
- // "httpMethod": "DELETE",
- // "id": "androidpublisher.edits.apklistings.deleteall",
- // "parameterOrder": [
- // "packageName",
- // "editId",
- // "apkVersionCode"
- // ],
- // "parameters": {
- // "apkVersionCode": {
- // "description": "The APK version code whose APK-specific listings should be read or modified.",
- // "format": "int32",
- // "location": "path",
- // "required": true,
- // "type": "integer"
- // },
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings",
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.apklistings.get":
-
-type EditsApklistingsGetCall struct {
- s *Service
- packageNameid string
- editId string
- apkVersionCode int64
- language string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Fetches the APK-specific localized listing for a specified APK
-// and language code.
-func (r *EditsApklistingsService) Get(packageNameid string, editId string, apkVersionCode int64, language string) *EditsApklistingsGetCall {
- c := &EditsApklistingsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- c.apkVersionCode = apkVersionCode
- c.language = language
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsApklistingsGetCall) Fields(s ...googleapi.Field) *EditsApklistingsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *EditsApklistingsGetCall) IfNoneMatch(entityTag string) *EditsApklistingsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsApklistingsGetCall) Context(ctx context.Context) *EditsApklistingsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsApklistingsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- "apkVersionCode": strconv.FormatInt(c.apkVersionCode, 10),
- "language": c.language,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.apklistings.get" call.
-// Exactly one of *ApkListing or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ApkListing.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *EditsApklistingsGetCall) Do() (*ApkListing, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ApkListing{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Fetches the APK-specific localized listing for a specified APK and language code.",
- // "httpMethod": "GET",
- // "id": "androidpublisher.edits.apklistings.get",
- // "parameterOrder": [
- // "packageName",
- // "editId",
- // "apkVersionCode",
- // "language"
- // ],
- // "parameters": {
- // "apkVersionCode": {
- // "description": "The APK version code whose APK-specific listings should be read or modified.",
- // "format": "int32",
- // "location": "path",
- // "required": true,
- // "type": "integer"
- // },
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "language": {
- // "description": "The language code (a BCP-47 language tag) of the APK-specific localized listing to read or modify. For example, to select Austrian German, pass \"de-AT\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}",
- // "response": {
- // "$ref": "ApkListing"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.apklistings.list":
-
-type EditsApklistingsListCall struct {
- s *Service
- packageNameid string
- editId string
- apkVersionCode int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all the APK-specific localized listings for a specified
-// APK.
-func (r *EditsApklistingsService) List(packageNameid string, editId string, apkVersionCode int64) *EditsApklistingsListCall {
- c := &EditsApklistingsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- c.apkVersionCode = apkVersionCode
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsApklistingsListCall) Fields(s ...googleapi.Field) *EditsApklistingsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *EditsApklistingsListCall) IfNoneMatch(entityTag string) *EditsApklistingsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsApklistingsListCall) Context(ctx context.Context) *EditsApklistingsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsApklistingsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- "apkVersionCode": strconv.FormatInt(c.apkVersionCode, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.apklistings.list" call.
-// Exactly one of *ApkListingsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ApkListingsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *EditsApklistingsListCall) Do() (*ApkListingsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ApkListingsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all the APK-specific localized listings for a specified APK.",
- // "httpMethod": "GET",
- // "id": "androidpublisher.edits.apklistings.list",
- // "parameterOrder": [
- // "packageName",
- // "editId",
- // "apkVersionCode"
- // ],
- // "parameters": {
- // "apkVersionCode": {
- // "description": "The APK version code whose APK-specific listings should be read or modified.",
- // "format": "int32",
- // "location": "path",
- // "required": true,
- // "type": "integer"
- // },
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings",
- // "response": {
- // "$ref": "ApkListingsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.apklistings.patch":
-
-type EditsApklistingsPatchCall struct {
- s *Service
- packageNameid string
- editId string
- apkVersionCode int64
- language string
- apklisting *ApkListing
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates or creates the APK-specific localized listing for a
-// specified APK and language code. This method supports patch
-// semantics.
-func (r *EditsApklistingsService) Patch(packageNameid string, editId string, apkVersionCode int64, language string, apklisting *ApkListing) *EditsApklistingsPatchCall {
- c := &EditsApklistingsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- c.apkVersionCode = apkVersionCode
- c.language = language
- c.apklisting = apklisting
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsApklistingsPatchCall) Fields(s ...googleapi.Field) *EditsApklistingsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsApklistingsPatchCall) Context(ctx context.Context) *EditsApklistingsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsApklistingsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.apklisting)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- "apkVersionCode": strconv.FormatInt(c.apkVersionCode, 10),
- "language": c.language,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.apklistings.patch" call.
-// Exactly one of *ApkListing or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ApkListing.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *EditsApklistingsPatchCall) Do() (*ApkListing, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ApkListing{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates or creates the APK-specific localized listing for a specified APK and language code. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "androidpublisher.edits.apklistings.patch",
- // "parameterOrder": [
- // "packageName",
- // "editId",
- // "apkVersionCode",
- // "language"
- // ],
- // "parameters": {
- // "apkVersionCode": {
- // "description": "The APK version code whose APK-specific listings should be read or modified.",
- // "format": "int32",
- // "location": "path",
- // "required": true,
- // "type": "integer"
- // },
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "language": {
- // "description": "The language code (a BCP-47 language tag) of the APK-specific localized listing to read or modify. For example, to select Austrian German, pass \"de-AT\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}",
- // "request": {
- // "$ref": "ApkListing"
- // },
- // "response": {
- // "$ref": "ApkListing"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.apklistings.update":
-
-type EditsApklistingsUpdateCall struct {
- s *Service
- packageNameid string
- editId string
- apkVersionCode int64
- language string
- apklisting *ApkListing
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates or creates the APK-specific localized listing for a
-// specified APK and language code.
-func (r *EditsApklistingsService) Update(packageNameid string, editId string, apkVersionCode int64, language string, apklisting *ApkListing) *EditsApklistingsUpdateCall {
- c := &EditsApklistingsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- c.apkVersionCode = apkVersionCode
- c.language = language
- c.apklisting = apklisting
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsApklistingsUpdateCall) Fields(s ...googleapi.Field) *EditsApklistingsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsApklistingsUpdateCall) Context(ctx context.Context) *EditsApklistingsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsApklistingsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.apklisting)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- "apkVersionCode": strconv.FormatInt(c.apkVersionCode, 10),
- "language": c.language,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.apklistings.update" call.
-// Exactly one of *ApkListing or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ApkListing.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *EditsApklistingsUpdateCall) Do() (*ApkListing, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ApkListing{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates or creates the APK-specific localized listing for a specified APK and language code.",
- // "httpMethod": "PUT",
- // "id": "androidpublisher.edits.apklistings.update",
- // "parameterOrder": [
- // "packageName",
- // "editId",
- // "apkVersionCode",
- // "language"
- // ],
- // "parameters": {
- // "apkVersionCode": {
- // "description": "The APK version code whose APK-specific listings should be read or modified.",
- // "format": "int32",
- // "location": "path",
- // "required": true,
- // "type": "integer"
- // },
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "language": {
- // "description": "The language code (a BCP-47 language tag) of the APK-specific localized listing to read or modify. For example, to select Austrian German, pass \"de-AT\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}",
- // "request": {
- // "$ref": "ApkListing"
- // },
- // "response": {
- // "$ref": "ApkListing"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.apks.addexternallyhosted":
-
-type EditsApksAddexternallyhostedCall struct {
- s *Service
- packageNameid string
- editId string
- apksaddexternallyhostedrequest *ApksAddExternallyHostedRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Addexternallyhosted: Creates a new APK without uploading the APK
-// itself to Google Play, instead hosting the APK at a specified URL.
-// This function is only available to enterprises using Google Play for
-// Work whose application is configured to restrict distribution to the
-// enterprise domain.
-func (r *EditsApksService) Addexternallyhosted(packageNameid string, editId string, apksaddexternallyhostedrequest *ApksAddExternallyHostedRequest) *EditsApksAddexternallyhostedCall {
- c := &EditsApksAddexternallyhostedCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- c.apksaddexternallyhostedrequest = apksaddexternallyhostedrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsApksAddexternallyhostedCall) Fields(s ...googleapi.Field) *EditsApksAddexternallyhostedCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsApksAddexternallyhostedCall) Context(ctx context.Context) *EditsApksAddexternallyhostedCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsApksAddexternallyhostedCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.apksaddexternallyhostedrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/apks/externallyHosted")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.apks.addexternallyhosted" call.
-// Exactly one of *ApksAddExternallyHostedResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *ApksAddExternallyHostedResponse.ServerResponse.Header or (if
-// a response was returned at all) in error.(*googleapi.Error).Header.
-// Use googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *EditsApksAddexternallyhostedCall) Do() (*ApksAddExternallyHostedResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ApksAddExternallyHostedResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a new APK without uploading the APK itself to Google Play, instead hosting the APK at a specified URL. This function is only available to enterprises using Google Play for Work whose application is configured to restrict distribution to the enterprise domain.",
- // "httpMethod": "POST",
- // "id": "androidpublisher.edits.apks.addexternallyhosted",
- // "parameterOrder": [
- // "packageName",
- // "editId"
- // ],
- // "parameters": {
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/apks/externallyHosted",
- // "request": {
- // "$ref": "ApksAddExternallyHostedRequest"
- // },
- // "response": {
- // "$ref": "ApksAddExternallyHostedResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.apks.list":
-
-type EditsApksListCall struct {
- s *Service
- packageNameid string
- editId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List:
-func (r *EditsApksService) List(packageNameid string, editId string) *EditsApksListCall {
- c := &EditsApksListCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsApksListCall) Fields(s ...googleapi.Field) *EditsApksListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *EditsApksListCall) IfNoneMatch(entityTag string) *EditsApksListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsApksListCall) Context(ctx context.Context) *EditsApksListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsApksListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/apks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.apks.list" call.
-// Exactly one of *ApksListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ApksListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *EditsApksListCall) Do() (*ApksListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ApksListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "httpMethod": "GET",
- // "id": "androidpublisher.edits.apks.list",
- // "parameterOrder": [
- // "packageName",
- // "editId"
- // ],
- // "parameters": {
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/apks",
- // "response": {
- // "$ref": "ApksListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.apks.upload":
-
-type EditsApksUploadCall struct {
- s *Service
- packageNameid string
- editId string
- opt_ map[string]interface{}
- media_ io.Reader
- resumable_ googleapi.SizeReaderAt
- mediaType_ string
- protocol_ string
- ctx_ context.Context
-}
-
-// Upload:
-func (r *EditsApksService) Upload(packageNameid string, editId string) *EditsApksUploadCall {
- c := &EditsApksUploadCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- return c
-}
-
-// Media specifies the media to upload in a single chunk.
-// At most one of Media and ResumableMedia may be set.
-func (c *EditsApksUploadCall) Media(r io.Reader) *EditsApksUploadCall {
- c.media_ = r
- c.protocol_ = "multipart"
- return c
-}
-
-// ResumableMedia specifies the media to upload in chunks and can be canceled with ctx.
-// At most one of Media and ResumableMedia may be set.
-// mediaType identifies the MIME media type of the upload, such as "image/png".
-// If mediaType is "", it will be auto-detected.
-// The provided ctx will supersede any context previously provided to
-// the Context method.
-func (c *EditsApksUploadCall) ResumableMedia(ctx context.Context, r io.ReaderAt, size int64, mediaType string) *EditsApksUploadCall {
- c.ctx_ = ctx
- c.resumable_ = io.NewSectionReader(r, 0, size)
- c.mediaType_ = mediaType
- c.protocol_ = "resumable"
- return c
-}
-
-// ProgressUpdater provides a callback function that will be called after every chunk.
-// It should be a low-latency function in order to not slow down the upload operation.
-// This should only be called when using ResumableMedia (as opposed to Media).
-func (c *EditsApksUploadCall) ProgressUpdater(pu googleapi.ProgressUpdater) *EditsApksUploadCall {
- c.opt_["progressUpdater"] = pu
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsApksUploadCall) Fields(s ...googleapi.Field) *EditsApksUploadCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-// This context will supersede any context previously provided to
-// the ResumableMedia method.
-func (c *EditsApksUploadCall) Context(ctx context.Context) *EditsApksUploadCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsApksUploadCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/apks")
- if c.media_ != nil || c.resumable_ != nil {
- urls = strings.Replace(urls, "https://www.googleapis.com/", "https://www.googleapis.com/upload/", 1)
- params.Set("uploadType", c.protocol_)
- }
- urls += "?" + params.Encode()
- body = new(bytes.Buffer)
- ctype := "application/json"
- if c.protocol_ != "resumable" {
- var cancel func()
- cancel, _ = googleapi.ConditionallyIncludeMedia(c.media_, &body, &ctype)
- if cancel != nil {
- defer cancel()
- }
- }
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- })
- if c.protocol_ == "resumable" {
- if c.mediaType_ == "" {
- c.mediaType_ = googleapi.DetectMediaType(c.resumable_)
- }
- req.Header.Set("X-Upload-Content-Type", c.mediaType_)
- req.Header.Set("Content-Type", "application/json; charset=utf-8")
- } else {
- req.Header.Set("Content-Type", ctype)
- }
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.apks.upload" call.
-// Exactly one of *Apk or error will be non-nil. Any non-2xx status code
-// is an error. Response headers are in either
-// *Apk.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *EditsApksUploadCall) Do() (*Apk, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- var progressUpdater_ googleapi.ProgressUpdater
- if v, ok := c.opt_["progressUpdater"]; ok {
- if pu, ok := v.(googleapi.ProgressUpdater); ok {
- progressUpdater_ = pu
- }
- }
- if c.protocol_ == "resumable" {
- loc := res.Header.Get("Location")
- rx := &googleapi.ResumableUpload{
- Client: c.s.client,
- UserAgent: c.s.userAgent(),
- URI: loc,
- Media: c.resumable_,
- MediaType: c.mediaType_,
- ContentLength: c.resumable_.Size(),
- Callback: progressUpdater_,
- }
- res, err = rx.Upload(c.ctx_)
- if err != nil {
- return nil, err
- }
- defer res.Body.Close()
- }
- ret := &Apk{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "httpMethod": "POST",
- // "id": "androidpublisher.edits.apks.upload",
- // "mediaUpload": {
- // "accept": [
- // "application/octet-stream",
- // "application/vnd.android.package-archive"
- // ],
- // "maxSize": "1GB",
- // "protocols": {
- // "resumable": {
- // "multipart": true,
- // "path": "/resumable/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/apks"
- // },
- // "simple": {
- // "multipart": true,
- // "path": "/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/apks"
- // }
- // }
- // },
- // "parameterOrder": [
- // "packageName",
- // "editId"
- // ],
- // "parameters": {
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/apks",
- // "response": {
- // "$ref": "Apk"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ],
- // "supportsMediaUpload": true
- // }
-
-}
-
-// method id "androidpublisher.edits.details.get":
-
-type EditsDetailsGetCall struct {
- s *Service
- packageNameid string
- editId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Fetches app details for this edit. This includes the default
-// language and developer support contact information.
-func (r *EditsDetailsService) Get(packageNameid string, editId string) *EditsDetailsGetCall {
- c := &EditsDetailsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsDetailsGetCall) Fields(s ...googleapi.Field) *EditsDetailsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *EditsDetailsGetCall) IfNoneMatch(entityTag string) *EditsDetailsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsDetailsGetCall) Context(ctx context.Context) *EditsDetailsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsDetailsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/details")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.details.get" call.
-// Exactly one of *AppDetails or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AppDetails.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *EditsDetailsGetCall) Do() (*AppDetails, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AppDetails{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Fetches app details for this edit. This includes the default language and developer support contact information.",
- // "httpMethod": "GET",
- // "id": "androidpublisher.edits.details.get",
- // "parameterOrder": [
- // "packageName",
- // "editId"
- // ],
- // "parameters": {
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/details",
- // "response": {
- // "$ref": "AppDetails"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.details.patch":
-
-type EditsDetailsPatchCall struct {
- s *Service
- packageNameid string
- editId string
- appdetails *AppDetails
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates app details for this edit. This method supports patch
-// semantics.
-func (r *EditsDetailsService) Patch(packageNameid string, editId string, appdetails *AppDetails) *EditsDetailsPatchCall {
- c := &EditsDetailsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- c.appdetails = appdetails
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsDetailsPatchCall) Fields(s ...googleapi.Field) *EditsDetailsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsDetailsPatchCall) Context(ctx context.Context) *EditsDetailsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsDetailsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.appdetails)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/details")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.details.patch" call.
-// Exactly one of *AppDetails or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AppDetails.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *EditsDetailsPatchCall) Do() (*AppDetails, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AppDetails{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates app details for this edit. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "androidpublisher.edits.details.patch",
- // "parameterOrder": [
- // "packageName",
- // "editId"
- // ],
- // "parameters": {
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/details",
- // "request": {
- // "$ref": "AppDetails"
- // },
- // "response": {
- // "$ref": "AppDetails"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.details.update":
-
-type EditsDetailsUpdateCall struct {
- s *Service
- packageNameid string
- editId string
- appdetails *AppDetails
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates app details for this edit.
-func (r *EditsDetailsService) Update(packageNameid string, editId string, appdetails *AppDetails) *EditsDetailsUpdateCall {
- c := &EditsDetailsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- c.appdetails = appdetails
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsDetailsUpdateCall) Fields(s ...googleapi.Field) *EditsDetailsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsDetailsUpdateCall) Context(ctx context.Context) *EditsDetailsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsDetailsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.appdetails)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/details")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.details.update" call.
-// Exactly one of *AppDetails or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AppDetails.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *EditsDetailsUpdateCall) Do() (*AppDetails, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AppDetails{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates app details for this edit.",
- // "httpMethod": "PUT",
- // "id": "androidpublisher.edits.details.update",
- // "parameterOrder": [
- // "packageName",
- // "editId"
- // ],
- // "parameters": {
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/details",
- // "request": {
- // "$ref": "AppDetails"
- // },
- // "response": {
- // "$ref": "AppDetails"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.expansionfiles.get":
-
-type EditsExpansionfilesGetCall struct {
- s *Service
- packageNameid string
- editId string
- apkVersionCode int64
- expansionFileType string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Fetches the Expansion File configuration for the APK specified.
-func (r *EditsExpansionfilesService) Get(packageNameid string, editId string, apkVersionCode int64, expansionFileType string) *EditsExpansionfilesGetCall {
- c := &EditsExpansionfilesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- c.apkVersionCode = apkVersionCode
- c.expansionFileType = expansionFileType
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsExpansionfilesGetCall) Fields(s ...googleapi.Field) *EditsExpansionfilesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *EditsExpansionfilesGetCall) IfNoneMatch(entityTag string) *EditsExpansionfilesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsExpansionfilesGetCall) Context(ctx context.Context) *EditsExpansionfilesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsExpansionfilesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- "apkVersionCode": strconv.FormatInt(c.apkVersionCode, 10),
- "expansionFileType": c.expansionFileType,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.expansionfiles.get" call.
-// Exactly one of *ExpansionFile or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ExpansionFile.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *EditsExpansionfilesGetCall) Do() (*ExpansionFile, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ExpansionFile{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Fetches the Expansion File configuration for the APK specified.",
- // "httpMethod": "GET",
- // "id": "androidpublisher.edits.expansionfiles.get",
- // "parameterOrder": [
- // "packageName",
- // "editId",
- // "apkVersionCode",
- // "expansionFileType"
- // ],
- // "parameters": {
- // "apkVersionCode": {
- // "description": "The version code of the APK whose Expansion File configuration is being read or modified.",
- // "format": "int32",
- // "location": "path",
- // "required": true,
- // "type": "integer"
- // },
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "expansionFileType": {
- // "enum": [
- // "main",
- // "patch"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}",
- // "response": {
- // "$ref": "ExpansionFile"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.expansionfiles.patch":
-
-type EditsExpansionfilesPatchCall struct {
- s *Service
- packageNameid string
- editId string
- apkVersionCode int64
- expansionFileType string
- expansionfile *ExpansionFile
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates the APK's Expansion File configuration to reference
-// another APK's Expansion Files. To add a new Expansion File use the
-// Upload method. This method supports patch semantics.
-func (r *EditsExpansionfilesService) Patch(packageNameid string, editId string, apkVersionCode int64, expansionFileType string, expansionfile *ExpansionFile) *EditsExpansionfilesPatchCall {
- c := &EditsExpansionfilesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- c.apkVersionCode = apkVersionCode
- c.expansionFileType = expansionFileType
- c.expansionfile = expansionfile
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsExpansionfilesPatchCall) Fields(s ...googleapi.Field) *EditsExpansionfilesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsExpansionfilesPatchCall) Context(ctx context.Context) *EditsExpansionfilesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsExpansionfilesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.expansionfile)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- "apkVersionCode": strconv.FormatInt(c.apkVersionCode, 10),
- "expansionFileType": c.expansionFileType,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.expansionfiles.patch" call.
-// Exactly one of *ExpansionFile or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ExpansionFile.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *EditsExpansionfilesPatchCall) Do() (*ExpansionFile, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ExpansionFile{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates the APK's Expansion File configuration to reference another APK's Expansion Files. To add a new Expansion File use the Upload method. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "androidpublisher.edits.expansionfiles.patch",
- // "parameterOrder": [
- // "packageName",
- // "editId",
- // "apkVersionCode",
- // "expansionFileType"
- // ],
- // "parameters": {
- // "apkVersionCode": {
- // "description": "The version code of the APK whose Expansion File configuration is being read or modified.",
- // "format": "int32",
- // "location": "path",
- // "required": true,
- // "type": "integer"
- // },
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "expansionFileType": {
- // "enum": [
- // "main",
- // "patch"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}",
- // "request": {
- // "$ref": "ExpansionFile"
- // },
- // "response": {
- // "$ref": "ExpansionFile"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.expansionfiles.update":
-
-type EditsExpansionfilesUpdateCall struct {
- s *Service
- packageNameid string
- editId string
- apkVersionCode int64
- expansionFileType string
- expansionfile *ExpansionFile
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates the APK's Expansion File configuration to reference
-// another APK's Expansion Files. To add a new Expansion File use the
-// Upload method.
-func (r *EditsExpansionfilesService) Update(packageNameid string, editId string, apkVersionCode int64, expansionFileType string, expansionfile *ExpansionFile) *EditsExpansionfilesUpdateCall {
- c := &EditsExpansionfilesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- c.apkVersionCode = apkVersionCode
- c.expansionFileType = expansionFileType
- c.expansionfile = expansionfile
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsExpansionfilesUpdateCall) Fields(s ...googleapi.Field) *EditsExpansionfilesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsExpansionfilesUpdateCall) Context(ctx context.Context) *EditsExpansionfilesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsExpansionfilesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.expansionfile)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- "apkVersionCode": strconv.FormatInt(c.apkVersionCode, 10),
- "expansionFileType": c.expansionFileType,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.expansionfiles.update" call.
-// Exactly one of *ExpansionFile or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ExpansionFile.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *EditsExpansionfilesUpdateCall) Do() (*ExpansionFile, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ExpansionFile{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates the APK's Expansion File configuration to reference another APK's Expansion Files. To add a new Expansion File use the Upload method.",
- // "httpMethod": "PUT",
- // "id": "androidpublisher.edits.expansionfiles.update",
- // "parameterOrder": [
- // "packageName",
- // "editId",
- // "apkVersionCode",
- // "expansionFileType"
- // ],
- // "parameters": {
- // "apkVersionCode": {
- // "description": "The version code of the APK whose Expansion File configuration is being read or modified.",
- // "format": "int32",
- // "location": "path",
- // "required": true,
- // "type": "integer"
- // },
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "expansionFileType": {
- // "enum": [
- // "main",
- // "patch"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}",
- // "request": {
- // "$ref": "ExpansionFile"
- // },
- // "response": {
- // "$ref": "ExpansionFile"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.expansionfiles.upload":
-
-type EditsExpansionfilesUploadCall struct {
- s *Service
- packageNameid string
- editId string
- apkVersionCode int64
- expansionFileType string
- opt_ map[string]interface{}
- media_ io.Reader
- resumable_ googleapi.SizeReaderAt
- mediaType_ string
- protocol_ string
- ctx_ context.Context
-}
-
-// Upload: Uploads and attaches a new Expansion File to the APK
-// specified.
-func (r *EditsExpansionfilesService) Upload(packageNameid string, editId string, apkVersionCode int64, expansionFileType string) *EditsExpansionfilesUploadCall {
- c := &EditsExpansionfilesUploadCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- c.apkVersionCode = apkVersionCode
- c.expansionFileType = expansionFileType
- return c
-}
-
-// Media specifies the media to upload in a single chunk.
-// At most one of Media and ResumableMedia may be set.
-func (c *EditsExpansionfilesUploadCall) Media(r io.Reader) *EditsExpansionfilesUploadCall {
- c.media_ = r
- c.protocol_ = "multipart"
- return c
-}
-
-// ResumableMedia specifies the media to upload in chunks and can be canceled with ctx.
-// At most one of Media and ResumableMedia may be set.
-// mediaType identifies the MIME media type of the upload, such as "image/png".
-// If mediaType is "", it will be auto-detected.
-// The provided ctx will supersede any context previously provided to
-// the Context method.
-func (c *EditsExpansionfilesUploadCall) ResumableMedia(ctx context.Context, r io.ReaderAt, size int64, mediaType string) *EditsExpansionfilesUploadCall {
- c.ctx_ = ctx
- c.resumable_ = io.NewSectionReader(r, 0, size)
- c.mediaType_ = mediaType
- c.protocol_ = "resumable"
- return c
-}
-
-// ProgressUpdater provides a callback function that will be called after every chunk.
-// It should be a low-latency function in order to not slow down the upload operation.
-// This should only be called when using ResumableMedia (as opposed to Media).
-func (c *EditsExpansionfilesUploadCall) ProgressUpdater(pu googleapi.ProgressUpdater) *EditsExpansionfilesUploadCall {
- c.opt_["progressUpdater"] = pu
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsExpansionfilesUploadCall) Fields(s ...googleapi.Field) *EditsExpansionfilesUploadCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-// This context will supersede any context previously provided to
-// the ResumableMedia method.
-func (c *EditsExpansionfilesUploadCall) Context(ctx context.Context) *EditsExpansionfilesUploadCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsExpansionfilesUploadCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}")
- if c.media_ != nil || c.resumable_ != nil {
- urls = strings.Replace(urls, "https://www.googleapis.com/", "https://www.googleapis.com/upload/", 1)
- params.Set("uploadType", c.protocol_)
- }
- urls += "?" + params.Encode()
- body = new(bytes.Buffer)
- ctype := "application/json"
- if c.protocol_ != "resumable" {
- var cancel func()
- cancel, _ = googleapi.ConditionallyIncludeMedia(c.media_, &body, &ctype)
- if cancel != nil {
- defer cancel()
- }
- }
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- "apkVersionCode": strconv.FormatInt(c.apkVersionCode, 10),
- "expansionFileType": c.expansionFileType,
- })
- if c.protocol_ == "resumable" {
- if c.mediaType_ == "" {
- c.mediaType_ = googleapi.DetectMediaType(c.resumable_)
- }
- req.Header.Set("X-Upload-Content-Type", c.mediaType_)
- req.Header.Set("Content-Type", "application/json; charset=utf-8")
- } else {
- req.Header.Set("Content-Type", ctype)
- }
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.expansionfiles.upload" call.
-// Exactly one of *ExpansionFilesUploadResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *ExpansionFilesUploadResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *EditsExpansionfilesUploadCall) Do() (*ExpansionFilesUploadResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- var progressUpdater_ googleapi.ProgressUpdater
- if v, ok := c.opt_["progressUpdater"]; ok {
- if pu, ok := v.(googleapi.ProgressUpdater); ok {
- progressUpdater_ = pu
- }
- }
- if c.protocol_ == "resumable" {
- loc := res.Header.Get("Location")
- rx := &googleapi.ResumableUpload{
- Client: c.s.client,
- UserAgent: c.s.userAgent(),
- URI: loc,
- Media: c.resumable_,
- MediaType: c.mediaType_,
- ContentLength: c.resumable_.Size(),
- Callback: progressUpdater_,
- }
- res, err = rx.Upload(c.ctx_)
- if err != nil {
- return nil, err
- }
- defer res.Body.Close()
- }
- ret := &ExpansionFilesUploadResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Uploads and attaches a new Expansion File to the APK specified.",
- // "httpMethod": "POST",
- // "id": "androidpublisher.edits.expansionfiles.upload",
- // "mediaUpload": {
- // "accept": [
- // "application/octet-stream"
- // ],
- // "maxSize": "2048MB",
- // "protocols": {
- // "resumable": {
- // "multipart": true,
- // "path": "/resumable/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}"
- // },
- // "simple": {
- // "multipart": true,
- // "path": "/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}"
- // }
- // }
- // },
- // "parameterOrder": [
- // "packageName",
- // "editId",
- // "apkVersionCode",
- // "expansionFileType"
- // ],
- // "parameters": {
- // "apkVersionCode": {
- // "description": "The version code of the APK whose Expansion File configuration is being read or modified.",
- // "format": "int32",
- // "location": "path",
- // "required": true,
- // "type": "integer"
- // },
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "expansionFileType": {
- // "enum": [
- // "main",
- // "patch"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}",
- // "response": {
- // "$ref": "ExpansionFilesUploadResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ],
- // "supportsMediaUpload": true
- // }
-
-}
-
-// method id "androidpublisher.edits.images.delete":
-
-type EditsImagesDeleteCall struct {
- s *Service
- packageNameid string
- editId string
- language string
- imageType string
- imageId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the image (specified by id) from the edit.
-func (r *EditsImagesService) Delete(packageNameid string, editId string, language string, imageType string, imageId string) *EditsImagesDeleteCall {
- c := &EditsImagesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- c.language = language
- c.imageType = imageType
- c.imageId = imageId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsImagesDeleteCall) Fields(s ...googleapi.Field) *EditsImagesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsImagesDeleteCall) Context(ctx context.Context) *EditsImagesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsImagesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/listings/{language}/{imageType}/{imageId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- "language": c.language,
- "imageType": c.imageType,
- "imageId": c.imageId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.images.delete" call.
-func (c *EditsImagesDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes the image (specified by id) from the edit.",
- // "httpMethod": "DELETE",
- // "id": "androidpublisher.edits.images.delete",
- // "parameterOrder": [
- // "packageName",
- // "editId",
- // "language",
- // "imageType",
- // "imageId"
- // ],
- // "parameters": {
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "imageId": {
- // "description": "Unique identifier an image within the set of images attached to this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "imageType": {
- // "enum": [
- // "featureGraphic",
- // "icon",
- // "phoneScreenshots",
- // "promoGraphic",
- // "sevenInchScreenshots",
- // "tenInchScreenshots",
- // "tvBanner",
- // "tvScreenshots",
- // "wearScreenshots"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "language": {
- // "description": "The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass \"de-AT\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/listings/{language}/{imageType}/{imageId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.images.deleteall":
-
-type EditsImagesDeleteallCall struct {
- s *Service
- packageNameid string
- editId string
- language string
- imageType string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Deleteall: Deletes all images for the specified language and image
-// type.
-func (r *EditsImagesService) Deleteall(packageNameid string, editId string, language string, imageType string) *EditsImagesDeleteallCall {
- c := &EditsImagesDeleteallCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- c.language = language
- c.imageType = imageType
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsImagesDeleteallCall) Fields(s ...googleapi.Field) *EditsImagesDeleteallCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsImagesDeleteallCall) Context(ctx context.Context) *EditsImagesDeleteallCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsImagesDeleteallCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/listings/{language}/{imageType}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- "language": c.language,
- "imageType": c.imageType,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.images.deleteall" call.
-// Exactly one of *ImagesDeleteAllResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ImagesDeleteAllResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *EditsImagesDeleteallCall) Do() (*ImagesDeleteAllResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ImagesDeleteAllResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes all images for the specified language and image type.",
- // "httpMethod": "DELETE",
- // "id": "androidpublisher.edits.images.deleteall",
- // "parameterOrder": [
- // "packageName",
- // "editId",
- // "language",
- // "imageType"
- // ],
- // "parameters": {
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "imageType": {
- // "enum": [
- // "featureGraphic",
- // "icon",
- // "phoneScreenshots",
- // "promoGraphic",
- // "sevenInchScreenshots",
- // "tenInchScreenshots",
- // "tvBanner",
- // "tvScreenshots",
- // "wearScreenshots"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "language": {
- // "description": "The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass \"de-AT\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/listings/{language}/{imageType}",
- // "response": {
- // "$ref": "ImagesDeleteAllResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.images.list":
-
-type EditsImagesListCall struct {
- s *Service
- packageNameid string
- editId string
- language string
- imageType string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all images for the specified language and image type.
-func (r *EditsImagesService) List(packageNameid string, editId string, language string, imageType string) *EditsImagesListCall {
- c := &EditsImagesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- c.language = language
- c.imageType = imageType
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsImagesListCall) Fields(s ...googleapi.Field) *EditsImagesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *EditsImagesListCall) IfNoneMatch(entityTag string) *EditsImagesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsImagesListCall) Context(ctx context.Context) *EditsImagesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsImagesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/listings/{language}/{imageType}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- "language": c.language,
- "imageType": c.imageType,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.images.list" call.
-// Exactly one of *ImagesListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ImagesListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *EditsImagesListCall) Do() (*ImagesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ImagesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all images for the specified language and image type.",
- // "httpMethod": "GET",
- // "id": "androidpublisher.edits.images.list",
- // "parameterOrder": [
- // "packageName",
- // "editId",
- // "language",
- // "imageType"
- // ],
- // "parameters": {
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "imageType": {
- // "enum": [
- // "featureGraphic",
- // "icon",
- // "phoneScreenshots",
- // "promoGraphic",
- // "sevenInchScreenshots",
- // "tenInchScreenshots",
- // "tvBanner",
- // "tvScreenshots",
- // "wearScreenshots"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "language": {
- // "description": "The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass \"de-AT\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/listings/{language}/{imageType}",
- // "response": {
- // "$ref": "ImagesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.images.upload":
-
-type EditsImagesUploadCall struct {
- s *Service
- packageNameid string
- editId string
- language string
- imageType string
- opt_ map[string]interface{}
- media_ io.Reader
- resumable_ googleapi.SizeReaderAt
- mediaType_ string
- protocol_ string
- ctx_ context.Context
-}
-
-// Upload: Uploads a new image and adds it to the list of images for the
-// specified language and image type.
-func (r *EditsImagesService) Upload(packageNameid string, editId string, language string, imageType string) *EditsImagesUploadCall {
- c := &EditsImagesUploadCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- c.language = language
- c.imageType = imageType
- return c
-}
-
-// Media specifies the media to upload in a single chunk.
-// At most one of Media and ResumableMedia may be set.
-func (c *EditsImagesUploadCall) Media(r io.Reader) *EditsImagesUploadCall {
- c.media_ = r
- c.protocol_ = "multipart"
- return c
-}
-
-// ResumableMedia specifies the media to upload in chunks and can be canceled with ctx.
-// At most one of Media and ResumableMedia may be set.
-// mediaType identifies the MIME media type of the upload, such as "image/png".
-// If mediaType is "", it will be auto-detected.
-// The provided ctx will supersede any context previously provided to
-// the Context method.
-func (c *EditsImagesUploadCall) ResumableMedia(ctx context.Context, r io.ReaderAt, size int64, mediaType string) *EditsImagesUploadCall {
- c.ctx_ = ctx
- c.resumable_ = io.NewSectionReader(r, 0, size)
- c.mediaType_ = mediaType
- c.protocol_ = "resumable"
- return c
-}
-
-// ProgressUpdater provides a callback function that will be called after every chunk.
-// It should be a low-latency function in order to not slow down the upload operation.
-// This should only be called when using ResumableMedia (as opposed to Media).
-func (c *EditsImagesUploadCall) ProgressUpdater(pu googleapi.ProgressUpdater) *EditsImagesUploadCall {
- c.opt_["progressUpdater"] = pu
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsImagesUploadCall) Fields(s ...googleapi.Field) *EditsImagesUploadCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-// This context will supersede any context previously provided to
-// the ResumableMedia method.
-func (c *EditsImagesUploadCall) Context(ctx context.Context) *EditsImagesUploadCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsImagesUploadCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/listings/{language}/{imageType}")
- if c.media_ != nil || c.resumable_ != nil {
- urls = strings.Replace(urls, "https://www.googleapis.com/", "https://www.googleapis.com/upload/", 1)
- params.Set("uploadType", c.protocol_)
- }
- urls += "?" + params.Encode()
- body = new(bytes.Buffer)
- ctype := "application/json"
- if c.protocol_ != "resumable" {
- var cancel func()
- cancel, _ = googleapi.ConditionallyIncludeMedia(c.media_, &body, &ctype)
- if cancel != nil {
- defer cancel()
- }
- }
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- "language": c.language,
- "imageType": c.imageType,
- })
- if c.protocol_ == "resumable" {
- if c.mediaType_ == "" {
- c.mediaType_ = googleapi.DetectMediaType(c.resumable_)
- }
- req.Header.Set("X-Upload-Content-Type", c.mediaType_)
- req.Header.Set("Content-Type", "application/json; charset=utf-8")
- } else {
- req.Header.Set("Content-Type", ctype)
- }
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.images.upload" call.
-// Exactly one of *ImagesUploadResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ImagesUploadResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *EditsImagesUploadCall) Do() (*ImagesUploadResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- var progressUpdater_ googleapi.ProgressUpdater
- if v, ok := c.opt_["progressUpdater"]; ok {
- if pu, ok := v.(googleapi.ProgressUpdater); ok {
- progressUpdater_ = pu
- }
- }
- if c.protocol_ == "resumable" {
- loc := res.Header.Get("Location")
- rx := &googleapi.ResumableUpload{
- Client: c.s.client,
- UserAgent: c.s.userAgent(),
- URI: loc,
- Media: c.resumable_,
- MediaType: c.mediaType_,
- ContentLength: c.resumable_.Size(),
- Callback: progressUpdater_,
- }
- res, err = rx.Upload(c.ctx_)
- if err != nil {
- return nil, err
- }
- defer res.Body.Close()
- }
- ret := &ImagesUploadResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Uploads a new image and adds it to the list of images for the specified language and image type.",
- // "httpMethod": "POST",
- // "id": "androidpublisher.edits.images.upload",
- // "mediaUpload": {
- // "accept": [
- // "image/*"
- // ],
- // "maxSize": "15MB",
- // "protocols": {
- // "resumable": {
- // "multipart": true,
- // "path": "/resumable/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}"
- // },
- // "simple": {
- // "multipart": true,
- // "path": "/upload/androidpublisher/v2/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}"
- // }
- // }
- // },
- // "parameterOrder": [
- // "packageName",
- // "editId",
- // "language",
- // "imageType"
- // ],
- // "parameters": {
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "imageType": {
- // "enum": [
- // "featureGraphic",
- // "icon",
- // "phoneScreenshots",
- // "promoGraphic",
- // "sevenInchScreenshots",
- // "tenInchScreenshots",
- // "tvBanner",
- // "tvScreenshots",
- // "wearScreenshots"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "language": {
- // "description": "The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass \"de-AT\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/listings/{language}/{imageType}",
- // "response": {
- // "$ref": "ImagesUploadResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ],
- // "supportsMediaUpload": true
- // }
-
-}
-
-// method id "androidpublisher.edits.listings.delete":
-
-type EditsListingsDeleteCall struct {
- s *Service
- packageNameid string
- editId string
- language string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified localized store listing from an edit.
-func (r *EditsListingsService) Delete(packageNameid string, editId string, language string) *EditsListingsDeleteCall {
- c := &EditsListingsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- c.language = language
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsListingsDeleteCall) Fields(s ...googleapi.Field) *EditsListingsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsListingsDeleteCall) Context(ctx context.Context) *EditsListingsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsListingsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/listings/{language}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- "language": c.language,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.listings.delete" call.
-func (c *EditsListingsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes the specified localized store listing from an edit.",
- // "httpMethod": "DELETE",
- // "id": "androidpublisher.edits.listings.delete",
- // "parameterOrder": [
- // "packageName",
- // "editId",
- // "language"
- // ],
- // "parameters": {
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "language": {
- // "description": "The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass \"de-AT\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/listings/{language}",
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.listings.deleteall":
-
-type EditsListingsDeleteallCall struct {
- s *Service
- packageNameid string
- editId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Deleteall: Deletes all localized listings from an edit.
-func (r *EditsListingsService) Deleteall(packageNameid string, editId string) *EditsListingsDeleteallCall {
- c := &EditsListingsDeleteallCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsListingsDeleteallCall) Fields(s ...googleapi.Field) *EditsListingsDeleteallCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsListingsDeleteallCall) Context(ctx context.Context) *EditsListingsDeleteallCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsListingsDeleteallCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/listings")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.listings.deleteall" call.
-func (c *EditsListingsDeleteallCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes all localized listings from an edit.",
- // "httpMethod": "DELETE",
- // "id": "androidpublisher.edits.listings.deleteall",
- // "parameterOrder": [
- // "packageName",
- // "editId"
- // ],
- // "parameters": {
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/listings",
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.listings.get":
-
-type EditsListingsGetCall struct {
- s *Service
- packageNameid string
- editId string
- language string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Fetches information about a localized store listing.
-func (r *EditsListingsService) Get(packageNameid string, editId string, language string) *EditsListingsGetCall {
- c := &EditsListingsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- c.language = language
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsListingsGetCall) Fields(s ...googleapi.Field) *EditsListingsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *EditsListingsGetCall) IfNoneMatch(entityTag string) *EditsListingsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsListingsGetCall) Context(ctx context.Context) *EditsListingsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsListingsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/listings/{language}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- "language": c.language,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.listings.get" call.
-// Exactly one of *Listing or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Listing.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *EditsListingsGetCall) Do() (*Listing, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Listing{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Fetches information about a localized store listing.",
- // "httpMethod": "GET",
- // "id": "androidpublisher.edits.listings.get",
- // "parameterOrder": [
- // "packageName",
- // "editId",
- // "language"
- // ],
- // "parameters": {
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "language": {
- // "description": "The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass \"de-AT\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/listings/{language}",
- // "response": {
- // "$ref": "Listing"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.listings.list":
-
-type EditsListingsListCall struct {
- s *Service
- packageNameid string
- editId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Returns all of the localized store listings attached to this
-// edit.
-func (r *EditsListingsService) List(packageNameid string, editId string) *EditsListingsListCall {
- c := &EditsListingsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsListingsListCall) Fields(s ...googleapi.Field) *EditsListingsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *EditsListingsListCall) IfNoneMatch(entityTag string) *EditsListingsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsListingsListCall) Context(ctx context.Context) *EditsListingsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsListingsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/listings")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.listings.list" call.
-// Exactly one of *ListingsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ListingsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *EditsListingsListCall) Do() (*ListingsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ListingsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns all of the localized store listings attached to this edit.",
- // "httpMethod": "GET",
- // "id": "androidpublisher.edits.listings.list",
- // "parameterOrder": [
- // "packageName",
- // "editId"
- // ],
- // "parameters": {
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/listings",
- // "response": {
- // "$ref": "ListingsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.listings.patch":
-
-type EditsListingsPatchCall struct {
- s *Service
- packageNameid string
- editId string
- language string
- listing *Listing
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Creates or updates a localized store listing. This method
-// supports patch semantics.
-func (r *EditsListingsService) Patch(packageNameid string, editId string, language string, listing *Listing) *EditsListingsPatchCall {
- c := &EditsListingsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- c.language = language
- c.listing = listing
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsListingsPatchCall) Fields(s ...googleapi.Field) *EditsListingsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsListingsPatchCall) Context(ctx context.Context) *EditsListingsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsListingsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.listing)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/listings/{language}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- "language": c.language,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.listings.patch" call.
-// Exactly one of *Listing or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Listing.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *EditsListingsPatchCall) Do() (*Listing, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Listing{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates or updates a localized store listing. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "androidpublisher.edits.listings.patch",
- // "parameterOrder": [
- // "packageName",
- // "editId",
- // "language"
- // ],
- // "parameters": {
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "language": {
- // "description": "The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass \"de-AT\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/listings/{language}",
- // "request": {
- // "$ref": "Listing"
- // },
- // "response": {
- // "$ref": "Listing"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.listings.update":
-
-type EditsListingsUpdateCall struct {
- s *Service
- packageNameid string
- editId string
- language string
- listing *Listing
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Creates or updates a localized store listing.
-func (r *EditsListingsService) Update(packageNameid string, editId string, language string, listing *Listing) *EditsListingsUpdateCall {
- c := &EditsListingsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- c.language = language
- c.listing = listing
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsListingsUpdateCall) Fields(s ...googleapi.Field) *EditsListingsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsListingsUpdateCall) Context(ctx context.Context) *EditsListingsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsListingsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.listing)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/listings/{language}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- "language": c.language,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.listings.update" call.
-// Exactly one of *Listing or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Listing.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *EditsListingsUpdateCall) Do() (*Listing, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Listing{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates or updates a localized store listing.",
- // "httpMethod": "PUT",
- // "id": "androidpublisher.edits.listings.update",
- // "parameterOrder": [
- // "packageName",
- // "editId",
- // "language"
- // ],
- // "parameters": {
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "language": {
- // "description": "The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass \"de-AT\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/listings/{language}",
- // "request": {
- // "$ref": "Listing"
- // },
- // "response": {
- // "$ref": "Listing"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.testers.get":
-
-type EditsTestersGetCall struct {
- s *Service
- packageNameid string
- editId string
- track string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get:
-func (r *EditsTestersService) Get(packageNameid string, editId string, track string) *EditsTestersGetCall {
- c := &EditsTestersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- c.track = track
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsTestersGetCall) Fields(s ...googleapi.Field) *EditsTestersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *EditsTestersGetCall) IfNoneMatch(entityTag string) *EditsTestersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsTestersGetCall) Context(ctx context.Context) *EditsTestersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsTestersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/testers/{track}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- "track": c.track,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.testers.get" call.
-// Exactly one of *Testers or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Testers.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *EditsTestersGetCall) Do() (*Testers, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Testers{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "httpMethod": "GET",
- // "id": "androidpublisher.edits.testers.get",
- // "parameterOrder": [
- // "packageName",
- // "editId",
- // "track"
- // ],
- // "parameters": {
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "track": {
- // "enum": [
- // "alpha",
- // "beta",
- // "production",
- // "rollout"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/testers/{track}",
- // "response": {
- // "$ref": "Testers"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.testers.patch":
-
-type EditsTestersPatchCall struct {
- s *Service
- packageNameid string
- editId string
- track string
- testers *Testers
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch:
-func (r *EditsTestersService) Patch(packageNameid string, editId string, track string, testers *Testers) *EditsTestersPatchCall {
- c := &EditsTestersPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- c.track = track
- c.testers = testers
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsTestersPatchCall) Fields(s ...googleapi.Field) *EditsTestersPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsTestersPatchCall) Context(ctx context.Context) *EditsTestersPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsTestersPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.testers)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/testers/{track}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- "track": c.track,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.testers.patch" call.
-// Exactly one of *Testers or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Testers.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *EditsTestersPatchCall) Do() (*Testers, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Testers{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "httpMethod": "PATCH",
- // "id": "androidpublisher.edits.testers.patch",
- // "parameterOrder": [
- // "packageName",
- // "editId",
- // "track"
- // ],
- // "parameters": {
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "track": {
- // "enum": [
- // "alpha",
- // "beta",
- // "production",
- // "rollout"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/testers/{track}",
- // "request": {
- // "$ref": "Testers"
- // },
- // "response": {
- // "$ref": "Testers"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.testers.update":
-
-type EditsTestersUpdateCall struct {
- s *Service
- packageNameid string
- editId string
- track string
- testers *Testers
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update:
-func (r *EditsTestersService) Update(packageNameid string, editId string, track string, testers *Testers) *EditsTestersUpdateCall {
- c := &EditsTestersUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- c.track = track
- c.testers = testers
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsTestersUpdateCall) Fields(s ...googleapi.Field) *EditsTestersUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsTestersUpdateCall) Context(ctx context.Context) *EditsTestersUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsTestersUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.testers)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/testers/{track}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- "track": c.track,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.testers.update" call.
-// Exactly one of *Testers or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Testers.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *EditsTestersUpdateCall) Do() (*Testers, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Testers{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "httpMethod": "PUT",
- // "id": "androidpublisher.edits.testers.update",
- // "parameterOrder": [
- // "packageName",
- // "editId",
- // "track"
- // ],
- // "parameters": {
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "track": {
- // "enum": [
- // "alpha",
- // "beta",
- // "production",
- // "rollout"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/testers/{track}",
- // "request": {
- // "$ref": "Testers"
- // },
- // "response": {
- // "$ref": "Testers"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.tracks.get":
-
-type EditsTracksGetCall struct {
- s *Service
- packageNameid string
- editId string
- track string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Fetches the track configuration for the specified track type.
-// Includes the APK version codes that are in this track.
-func (r *EditsTracksService) Get(packageNameid string, editId string, track string) *EditsTracksGetCall {
- c := &EditsTracksGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- c.track = track
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsTracksGetCall) Fields(s ...googleapi.Field) *EditsTracksGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *EditsTracksGetCall) IfNoneMatch(entityTag string) *EditsTracksGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsTracksGetCall) Context(ctx context.Context) *EditsTracksGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsTracksGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/tracks/{track}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- "track": c.track,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.tracks.get" call.
-// Exactly one of *Track or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Track.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *EditsTracksGetCall) Do() (*Track, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Track{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Fetches the track configuration for the specified track type. Includes the APK version codes that are in this track.",
- // "httpMethod": "GET",
- // "id": "androidpublisher.edits.tracks.get",
- // "parameterOrder": [
- // "packageName",
- // "editId",
- // "track"
- // ],
- // "parameters": {
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "track": {
- // "description": "The track type to read or modify.",
- // "enum": [
- // "alpha",
- // "beta",
- // "production",
- // "rollout"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/tracks/{track}",
- // "response": {
- // "$ref": "Track"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.tracks.list":
-
-type EditsTracksListCall struct {
- s *Service
- packageNameid string
- editId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all the track configurations for this edit.
-func (r *EditsTracksService) List(packageNameid string, editId string) *EditsTracksListCall {
- c := &EditsTracksListCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsTracksListCall) Fields(s ...googleapi.Field) *EditsTracksListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *EditsTracksListCall) IfNoneMatch(entityTag string) *EditsTracksListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsTracksListCall) Context(ctx context.Context) *EditsTracksListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsTracksListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/tracks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.tracks.list" call.
-// Exactly one of *TracksListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *TracksListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *EditsTracksListCall) Do() (*TracksListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TracksListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all the track configurations for this edit.",
- // "httpMethod": "GET",
- // "id": "androidpublisher.edits.tracks.list",
- // "parameterOrder": [
- // "packageName",
- // "editId"
- // ],
- // "parameters": {
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/tracks",
- // "response": {
- // "$ref": "TracksListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.tracks.patch":
-
-type EditsTracksPatchCall struct {
- s *Service
- packageNameid string
- editId string
- track string
- track2 *Track
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates the track configuration for the specified track type.
-// When halted, the rollout track cannot be updated without adding new
-// APKs, and adding new APKs will cause it to resume. This method
-// supports patch semantics.
-func (r *EditsTracksService) Patch(packageNameid string, editId string, track string, track2 *Track) *EditsTracksPatchCall {
- c := &EditsTracksPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- c.track = track
- c.track2 = track2
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsTracksPatchCall) Fields(s ...googleapi.Field) *EditsTracksPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsTracksPatchCall) Context(ctx context.Context) *EditsTracksPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsTracksPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.track2)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/tracks/{track}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- "track": c.track,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.tracks.patch" call.
-// Exactly one of *Track or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Track.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *EditsTracksPatchCall) Do() (*Track, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Track{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates the track configuration for the specified track type. When halted, the rollout track cannot be updated without adding new APKs, and adding new APKs will cause it to resume. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "androidpublisher.edits.tracks.patch",
- // "parameterOrder": [
- // "packageName",
- // "editId",
- // "track"
- // ],
- // "parameters": {
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "track": {
- // "description": "The track type to read or modify.",
- // "enum": [
- // "alpha",
- // "beta",
- // "production",
- // "rollout"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/tracks/{track}",
- // "request": {
- // "$ref": "Track"
- // },
- // "response": {
- // "$ref": "Track"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.edits.tracks.update":
-
-type EditsTracksUpdateCall struct {
- s *Service
- packageNameid string
- editId string
- track string
- track2 *Track
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates the track configuration for the specified track type.
-// When halted, the rollout track cannot be updated without adding new
-// APKs, and adding new APKs will cause it to resume.
-func (r *EditsTracksService) Update(packageNameid string, editId string, track string, track2 *Track) *EditsTracksUpdateCall {
- c := &EditsTracksUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.editId = editId
- c.track = track
- c.track2 = track2
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EditsTracksUpdateCall) Fields(s ...googleapi.Field) *EditsTracksUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EditsTracksUpdateCall) Context(ctx context.Context) *EditsTracksUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EditsTracksUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.track2)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/edits/{editId}/tracks/{track}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "editId": c.editId,
- "track": c.track,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.edits.tracks.update" call.
-// Exactly one of *Track or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Track.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *EditsTracksUpdateCall) Do() (*Track, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Track{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates the track configuration for the specified track type. When halted, the rollout track cannot be updated without adding new APKs, and adding new APKs will cause it to resume.",
- // "httpMethod": "PUT",
- // "id": "androidpublisher.edits.tracks.update",
- // "parameterOrder": [
- // "packageName",
- // "editId",
- // "track"
- // ],
- // "parameters": {
- // "editId": {
- // "description": "Unique identifier for this edit.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app that is being updated; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "track": {
- // "description": "The track type to read or modify.",
- // "enum": [
- // "alpha",
- // "beta",
- // "production",
- // "rollout"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/edits/{editId}/tracks/{track}",
- // "request": {
- // "$ref": "Track"
- // },
- // "response": {
- // "$ref": "Track"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.entitlements.list":
-
-type EntitlementsListCall struct {
- s *Service
- packageName string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists the user's current inapp item or subscription
-// entitlements
-func (r *EntitlementsService) List(packageName string) *EntitlementsListCall {
- c := &EntitlementsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageName = packageName
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults":
-func (c *EntitlementsListCall) MaxResults(maxResults int64) *EntitlementsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// ProductId sets the optional parameter "productId": The product id of
-// the inapp product (for example, 'sku1'). This can be used to restrict
-// the result set.
-func (c *EntitlementsListCall) ProductId(productId string) *EntitlementsListCall {
- c.opt_["productId"] = productId
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex":
-func (c *EntitlementsListCall) StartIndex(startIndex int64) *EntitlementsListCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// Token sets the optional parameter "token":
-func (c *EntitlementsListCall) Token(token string) *EntitlementsListCall {
- c.opt_["token"] = token
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EntitlementsListCall) Fields(s ...googleapi.Field) *EntitlementsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *EntitlementsListCall) IfNoneMatch(entityTag string) *EntitlementsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EntitlementsListCall) Context(ctx context.Context) *EntitlementsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EntitlementsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["productId"]; ok {
- params.Set("productId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["token"]; ok {
- params.Set("token", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/entitlements")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageName,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.entitlements.list" call.
-// Exactly one of *EntitlementsListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *EntitlementsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *EntitlementsListCall) Do() (*EntitlementsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EntitlementsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists the user's current inapp item or subscription entitlements",
- // "httpMethod": "GET",
- // "id": "androidpublisher.entitlements.list",
- // "parameterOrder": [
- // "packageName"
- // ],
- // "parameters": {
- // "maxResults": {
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "packageName": {
- // "description": "The package name of the application the inapp product was sold in (for example, 'com.some.thing').",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "productId": {
- // "description": "The product id of the inapp product (for example, 'sku1'). This can be used to restrict the result set.",
- // "location": "query",
- // "type": "string"
- // },
- // "startIndex": {
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "token": {
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/entitlements",
- // "response": {
- // "$ref": "EntitlementsListResponse"
- // }
- // }
-
-}
-
-// method id "androidpublisher.inappproducts.batch":
-
-type InappproductsBatchCall struct {
- s *Service
- inappproductsbatchrequest *InappproductsBatchRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Batch:
-func (r *InappproductsService) Batch(inappproductsbatchrequest *InappproductsBatchRequest) *InappproductsBatchCall {
- c := &InappproductsBatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.inappproductsbatchrequest = inappproductsbatchrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InappproductsBatchCall) Fields(s ...googleapi.Field) *InappproductsBatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InappproductsBatchCall) Context(ctx context.Context) *InappproductsBatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InappproductsBatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.inappproductsbatchrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "inappproducts/batch")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.inappproducts.batch" call.
-// Exactly one of *InappproductsBatchResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *InappproductsBatchResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InappproductsBatchCall) Do() (*InappproductsBatchResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InappproductsBatchResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "httpMethod": "POST",
- // "id": "androidpublisher.inappproducts.batch",
- // "path": "inappproducts/batch",
- // "request": {
- // "$ref": "InappproductsBatchRequest"
- // },
- // "response": {
- // "$ref": "InappproductsBatchResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.inappproducts.delete":
-
-type InappproductsDeleteCall struct {
- s *Service
- packageNameid string
- skuid string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Delete an in-app product for an app.
-func (r *InappproductsService) Delete(packageNameid string, skuid string) *InappproductsDeleteCall {
- c := &InappproductsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.skuid = skuid
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InappproductsDeleteCall) Fields(s ...googleapi.Field) *InappproductsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InappproductsDeleteCall) Context(ctx context.Context) *InappproductsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InappproductsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/inappproducts/{sku}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "sku": c.skuid,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.inappproducts.delete" call.
-func (c *InappproductsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Delete an in-app product for an app.",
- // "httpMethod": "DELETE",
- // "id": "androidpublisher.inappproducts.delete",
- // "parameterOrder": [
- // "packageName",
- // "sku"
- // ],
- // "parameters": {
- // "packageName": {
- // "description": "Unique identifier for the Android app with the in-app product; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "sku": {
- // "description": "Unique identifier for the in-app product.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/inappproducts/{sku}",
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.inappproducts.get":
-
-type InappproductsGetCall struct {
- s *Service
- packageName string
- skuid string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns information about the in-app product specified.
-func (r *InappproductsService) Get(packageName string, skuid string) *InappproductsGetCall {
- c := &InappproductsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageName = packageName
- c.skuid = skuid
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InappproductsGetCall) Fields(s ...googleapi.Field) *InappproductsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InappproductsGetCall) IfNoneMatch(entityTag string) *InappproductsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InappproductsGetCall) Context(ctx context.Context) *InappproductsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InappproductsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/inappproducts/{sku}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageName,
- "sku": c.skuid,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.inappproducts.get" call.
-// Exactly one of *InAppProduct or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *InAppProduct.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InappproductsGetCall) Do() (*InAppProduct, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InAppProduct{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns information about the in-app product specified.",
- // "httpMethod": "GET",
- // "id": "androidpublisher.inappproducts.get",
- // "parameterOrder": [
- // "packageName",
- // "sku"
- // ],
- // "parameters": {
- // "packageName": {
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "sku": {
- // "description": "Unique identifier for the in-app product.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/inappproducts/{sku}",
- // "response": {
- // "$ref": "InAppProduct"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.inappproducts.insert":
-
-type InappproductsInsertCall struct {
- s *Service
- packageNameid string
- inappproduct *InAppProduct
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a new in-app product for an app.
-func (r *InappproductsService) Insert(packageNameid string, inappproduct *InAppProduct) *InappproductsInsertCall {
- c := &InappproductsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.inappproduct = inappproduct
- return c
-}
-
-// AutoConvertMissingPrices sets the optional parameter
-// "autoConvertMissingPrices": If true the prices for all regions
-// targeted by the parent app that don't have a price specified for this
-// in-app product will be auto converted to the target currency based on
-// the default price. Defaults to false.
-func (c *InappproductsInsertCall) AutoConvertMissingPrices(autoConvertMissingPrices bool) *InappproductsInsertCall {
- c.opt_["autoConvertMissingPrices"] = autoConvertMissingPrices
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InappproductsInsertCall) Fields(s ...googleapi.Field) *InappproductsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InappproductsInsertCall) Context(ctx context.Context) *InappproductsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InappproductsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.inappproduct)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["autoConvertMissingPrices"]; ok {
- params.Set("autoConvertMissingPrices", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/inappproducts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.inappproducts.insert" call.
-// Exactly one of *InAppProduct or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *InAppProduct.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InappproductsInsertCall) Do() (*InAppProduct, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InAppProduct{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a new in-app product for an app.",
- // "httpMethod": "POST",
- // "id": "androidpublisher.inappproducts.insert",
- // "parameterOrder": [
- // "packageName"
- // ],
- // "parameters": {
- // "autoConvertMissingPrices": {
- // "description": "If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/inappproducts",
- // "request": {
- // "$ref": "InAppProduct"
- // },
- // "response": {
- // "$ref": "InAppProduct"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.inappproducts.list":
-
-type InappproductsListCall struct {
- s *Service
- packageNameid string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List all the in-app products for an Android app, both
-// subscriptions and managed in-app products..
-func (r *InappproductsService) List(packageNameid string) *InappproductsListCall {
- c := &InappproductsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults":
-func (c *InappproductsListCall) MaxResults(maxResults int64) *InappproductsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex":
-func (c *InappproductsListCall) StartIndex(startIndex int64) *InappproductsListCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// Token sets the optional parameter "token":
-func (c *InappproductsListCall) Token(token string) *InappproductsListCall {
- c.opt_["token"] = token
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InappproductsListCall) Fields(s ...googleapi.Field) *InappproductsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InappproductsListCall) IfNoneMatch(entityTag string) *InappproductsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InappproductsListCall) Context(ctx context.Context) *InappproductsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InappproductsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["token"]; ok {
- params.Set("token", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/inappproducts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.inappproducts.list" call.
-// Exactly one of *InappproductsListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *InappproductsListResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InappproductsListCall) Do() (*InappproductsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InappproductsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List all the in-app products for an Android app, both subscriptions and managed in-app products..",
- // "httpMethod": "GET",
- // "id": "androidpublisher.inappproducts.list",
- // "parameterOrder": [
- // "packageName"
- // ],
- // "parameters": {
- // "maxResults": {
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app with in-app products; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "startIndex": {
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "token": {
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/inappproducts",
- // "response": {
- // "$ref": "InappproductsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.inappproducts.patch":
-
-type InappproductsPatchCall struct {
- s *Service
- packageNameid string
- skuid string
- inappproduct *InAppProduct
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates the details of an in-app product. This method supports
-// patch semantics.
-func (r *InappproductsService) Patch(packageNameid string, skuid string, inappproduct *InAppProduct) *InappproductsPatchCall {
- c := &InappproductsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.skuid = skuid
- c.inappproduct = inappproduct
- return c
-}
-
-// AutoConvertMissingPrices sets the optional parameter
-// "autoConvertMissingPrices": If true the prices for all regions
-// targeted by the parent app that don't have a price specified for this
-// in-app product will be auto converted to the target currency based on
-// the default price. Defaults to false.
-func (c *InappproductsPatchCall) AutoConvertMissingPrices(autoConvertMissingPrices bool) *InappproductsPatchCall {
- c.opt_["autoConvertMissingPrices"] = autoConvertMissingPrices
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InappproductsPatchCall) Fields(s ...googleapi.Field) *InappproductsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InappproductsPatchCall) Context(ctx context.Context) *InappproductsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InappproductsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.inappproduct)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["autoConvertMissingPrices"]; ok {
- params.Set("autoConvertMissingPrices", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/inappproducts/{sku}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "sku": c.skuid,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.inappproducts.patch" call.
-// Exactly one of *InAppProduct or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *InAppProduct.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InappproductsPatchCall) Do() (*InAppProduct, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InAppProduct{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates the details of an in-app product. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "androidpublisher.inappproducts.patch",
- // "parameterOrder": [
- // "packageName",
- // "sku"
- // ],
- // "parameters": {
- // "autoConvertMissingPrices": {
- // "description": "If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app with the in-app product; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "sku": {
- // "description": "Unique identifier for the in-app product.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/inappproducts/{sku}",
- // "request": {
- // "$ref": "InAppProduct"
- // },
- // "response": {
- // "$ref": "InAppProduct"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.inappproducts.update":
-
-type InappproductsUpdateCall struct {
- s *Service
- packageNameid string
- skuid string
- inappproduct *InAppProduct
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates the details of an in-app product.
-func (r *InappproductsService) Update(packageNameid string, skuid string, inappproduct *InAppProduct) *InappproductsUpdateCall {
- c := &InappproductsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageNameid = packageNameid
- c.skuid = skuid
- c.inappproduct = inappproduct
- return c
-}
-
-// AutoConvertMissingPrices sets the optional parameter
-// "autoConvertMissingPrices": If true the prices for all regions
-// targeted by the parent app that don't have a price specified for this
-// in-app product will be auto converted to the target currency based on
-// the default price. Defaults to false.
-func (c *InappproductsUpdateCall) AutoConvertMissingPrices(autoConvertMissingPrices bool) *InappproductsUpdateCall {
- c.opt_["autoConvertMissingPrices"] = autoConvertMissingPrices
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InappproductsUpdateCall) Fields(s ...googleapi.Field) *InappproductsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InappproductsUpdateCall) Context(ctx context.Context) *InappproductsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InappproductsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.inappproduct)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["autoConvertMissingPrices"]; ok {
- params.Set("autoConvertMissingPrices", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/inappproducts/{sku}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageNameid,
- "sku": c.skuid,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.inappproducts.update" call.
-// Exactly one of *InAppProduct or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *InAppProduct.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InappproductsUpdateCall) Do() (*InAppProduct, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InAppProduct{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates the details of an in-app product.",
- // "httpMethod": "PUT",
- // "id": "androidpublisher.inappproducts.update",
- // "parameterOrder": [
- // "packageName",
- // "sku"
- // ],
- // "parameters": {
- // "autoConvertMissingPrices": {
- // "description": "If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "packageName": {
- // "description": "Unique identifier for the Android app with the in-app product; for example, \"com.spiffygame\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "sku": {
- // "description": "Unique identifier for the in-app product.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/inappproducts/{sku}",
- // "request": {
- // "$ref": "InAppProduct"
- // },
- // "response": {
- // "$ref": "InAppProduct"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.purchases.products.get":
-
-type PurchasesProductsGetCall struct {
- s *Service
- packageName string
- productId string
- token string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Checks the purchase and consumption status of an inapp item.
-func (r *PurchasesProductsService) Get(packageName string, productId string, token string) *PurchasesProductsGetCall {
- c := &PurchasesProductsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageName = packageName
- c.productId = productId
- c.token = token
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PurchasesProductsGetCall) Fields(s ...googleapi.Field) *PurchasesProductsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PurchasesProductsGetCall) IfNoneMatch(entityTag string) *PurchasesProductsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PurchasesProductsGetCall) Context(ctx context.Context) *PurchasesProductsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PurchasesProductsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/purchases/products/{productId}/tokens/{token}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageName,
- "productId": c.productId,
- "token": c.token,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.purchases.products.get" call.
-// Exactly one of *ProductPurchase or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ProductPurchase.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PurchasesProductsGetCall) Do() (*ProductPurchase, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ProductPurchase{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Checks the purchase and consumption status of an inapp item.",
- // "httpMethod": "GET",
- // "id": "androidpublisher.purchases.products.get",
- // "parameterOrder": [
- // "packageName",
- // "productId",
- // "token"
- // ],
- // "parameters": {
- // "packageName": {
- // "description": "The package name of the application the inapp product was sold in (for example, 'com.some.thing').",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "productId": {
- // "description": "The inapp product SKU (for example, 'com.some.thing.inapp1').",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "token": {
- // "description": "The token provided to the user's device when the inapp product was purchased.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/purchases/products/{productId}/tokens/{token}",
- // "response": {
- // "$ref": "ProductPurchase"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.purchases.subscriptions.cancel":
-
-type PurchasesSubscriptionsCancelCall struct {
- s *Service
- packageName string
- subscriptionId string
- token string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Cancel: Cancels a user's subscription purchase. The subscription
-// remains valid until its expiration time.
-func (r *PurchasesSubscriptionsService) Cancel(packageName string, subscriptionId string, token string) *PurchasesSubscriptionsCancelCall {
- c := &PurchasesSubscriptionsCancelCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageName = packageName
- c.subscriptionId = subscriptionId
- c.token = token
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PurchasesSubscriptionsCancelCall) Fields(s ...googleapi.Field) *PurchasesSubscriptionsCancelCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PurchasesSubscriptionsCancelCall) Context(ctx context.Context) *PurchasesSubscriptionsCancelCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PurchasesSubscriptionsCancelCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:cancel")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageName,
- "subscriptionId": c.subscriptionId,
- "token": c.token,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.purchases.subscriptions.cancel" call.
-func (c *PurchasesSubscriptionsCancelCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Cancels a user's subscription purchase. The subscription remains valid until its expiration time.",
- // "httpMethod": "POST",
- // "id": "androidpublisher.purchases.subscriptions.cancel",
- // "parameterOrder": [
- // "packageName",
- // "subscriptionId",
- // "token"
- // ],
- // "parameters": {
- // "packageName": {
- // "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "subscriptionId": {
- // "description": "The purchased subscription ID (for example, 'monthly001').",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "token": {
- // "description": "The token provided to the user's device when the subscription was purchased.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:cancel",
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.purchases.subscriptions.defer":
-
-type PurchasesSubscriptionsDeferCall struct {
- s *Service
- packageName string
- subscriptionId string
- token string
- subscriptionpurchasesdeferrequest *SubscriptionPurchasesDeferRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Defer: Defers a user's subscription purchase until a specified future
-// expiration time.
-func (r *PurchasesSubscriptionsService) Defer(packageName string, subscriptionId string, token string, subscriptionpurchasesdeferrequest *SubscriptionPurchasesDeferRequest) *PurchasesSubscriptionsDeferCall {
- c := &PurchasesSubscriptionsDeferCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageName = packageName
- c.subscriptionId = subscriptionId
- c.token = token
- c.subscriptionpurchasesdeferrequest = subscriptionpurchasesdeferrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PurchasesSubscriptionsDeferCall) Fields(s ...googleapi.Field) *PurchasesSubscriptionsDeferCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PurchasesSubscriptionsDeferCall) Context(ctx context.Context) *PurchasesSubscriptionsDeferCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PurchasesSubscriptionsDeferCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.subscriptionpurchasesdeferrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:defer")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageName,
- "subscriptionId": c.subscriptionId,
- "token": c.token,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.purchases.subscriptions.defer" call.
-// Exactly one of *SubscriptionPurchasesDeferResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *SubscriptionPurchasesDeferResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *PurchasesSubscriptionsDeferCall) Do() (*SubscriptionPurchasesDeferResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SubscriptionPurchasesDeferResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Defers a user's subscription purchase until a specified future expiration time.",
- // "httpMethod": "POST",
- // "id": "androidpublisher.purchases.subscriptions.defer",
- // "parameterOrder": [
- // "packageName",
- // "subscriptionId",
- // "token"
- // ],
- // "parameters": {
- // "packageName": {
- // "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "subscriptionId": {
- // "description": "The purchased subscription ID (for example, 'monthly001').",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "token": {
- // "description": "The token provided to the user's device when the subscription was purchased.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:defer",
- // "request": {
- // "$ref": "SubscriptionPurchasesDeferRequest"
- // },
- // "response": {
- // "$ref": "SubscriptionPurchasesDeferResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.purchases.subscriptions.get":
-
-type PurchasesSubscriptionsGetCall struct {
- s *Service
- packageName string
- subscriptionId string
- token string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Checks whether a user's subscription purchase is valid and
-// returns its expiry time.
-func (r *PurchasesSubscriptionsService) Get(packageName string, subscriptionId string, token string) *PurchasesSubscriptionsGetCall {
- c := &PurchasesSubscriptionsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageName = packageName
- c.subscriptionId = subscriptionId
- c.token = token
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PurchasesSubscriptionsGetCall) Fields(s ...googleapi.Field) *PurchasesSubscriptionsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PurchasesSubscriptionsGetCall) IfNoneMatch(entityTag string) *PurchasesSubscriptionsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PurchasesSubscriptionsGetCall) Context(ctx context.Context) *PurchasesSubscriptionsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PurchasesSubscriptionsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageName,
- "subscriptionId": c.subscriptionId,
- "token": c.token,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.purchases.subscriptions.get" call.
-// Exactly one of *SubscriptionPurchase or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *SubscriptionPurchase.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PurchasesSubscriptionsGetCall) Do() (*SubscriptionPurchase, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SubscriptionPurchase{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Checks whether a user's subscription purchase is valid and returns its expiry time.",
- // "httpMethod": "GET",
- // "id": "androidpublisher.purchases.subscriptions.get",
- // "parameterOrder": [
- // "packageName",
- // "subscriptionId",
- // "token"
- // ],
- // "parameters": {
- // "packageName": {
- // "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "subscriptionId": {
- // "description": "The purchased subscription ID (for example, 'monthly001').",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "token": {
- // "description": "The token provided to the user's device when the subscription was purchased.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}",
- // "response": {
- // "$ref": "SubscriptionPurchase"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.purchases.subscriptions.refund":
-
-type PurchasesSubscriptionsRefundCall struct {
- s *Service
- packageName string
- subscriptionId string
- token string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Refund: Refunds a user's subscription purchase, but the subscription
-// remains valid until its expiration time and it will continue to
-// recur.
-func (r *PurchasesSubscriptionsService) Refund(packageName string, subscriptionId string, token string) *PurchasesSubscriptionsRefundCall {
- c := &PurchasesSubscriptionsRefundCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageName = packageName
- c.subscriptionId = subscriptionId
- c.token = token
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PurchasesSubscriptionsRefundCall) Fields(s ...googleapi.Field) *PurchasesSubscriptionsRefundCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PurchasesSubscriptionsRefundCall) Context(ctx context.Context) *PurchasesSubscriptionsRefundCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PurchasesSubscriptionsRefundCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:refund")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageName,
- "subscriptionId": c.subscriptionId,
- "token": c.token,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.purchases.subscriptions.refund" call.
-func (c *PurchasesSubscriptionsRefundCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Refunds a user's subscription purchase, but the subscription remains valid until its expiration time and it will continue to recur.",
- // "httpMethod": "POST",
- // "id": "androidpublisher.purchases.subscriptions.refund",
- // "parameterOrder": [
- // "packageName",
- // "subscriptionId",
- // "token"
- // ],
- // "parameters": {
- // "packageName": {
- // "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "subscriptionId": {
- // "description": "The purchased subscription ID (for example, 'monthly001').",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "token": {
- // "description": "The token provided to the user's device when the subscription was purchased.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:refund",
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
-
-// method id "androidpublisher.purchases.subscriptions.revoke":
-
-type PurchasesSubscriptionsRevokeCall struct {
- s *Service
- packageName string
- subscriptionId string
- token string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Revoke: Refunds and immediately revokes a user's subscription
-// purchase. Access to the subscription will be terminated immediately
-// and it will stop recurring.
-func (r *PurchasesSubscriptionsService) Revoke(packageName string, subscriptionId string, token string) *PurchasesSubscriptionsRevokeCall {
- c := &PurchasesSubscriptionsRevokeCall{s: r.s, opt_: make(map[string]interface{})}
- c.packageName = packageName
- c.subscriptionId = subscriptionId
- c.token = token
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PurchasesSubscriptionsRevokeCall) Fields(s ...googleapi.Field) *PurchasesSubscriptionsRevokeCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PurchasesSubscriptionsRevokeCall) Context(ctx context.Context) *PurchasesSubscriptionsRevokeCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PurchasesSubscriptionsRevokeCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:revoke")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "packageName": c.packageName,
- "subscriptionId": c.subscriptionId,
- "token": c.token,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "androidpublisher.purchases.subscriptions.revoke" call.
-func (c *PurchasesSubscriptionsRevokeCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Refunds and immediately revokes a user's subscription purchase. Access to the subscription will be terminated immediately and it will stop recurring.",
- // "httpMethod": "POST",
- // "id": "androidpublisher.purchases.subscriptions.revoke",
- // "parameterOrder": [
- // "packageName",
- // "subscriptionId",
- // "token"
- // ],
- // "parameters": {
- // "packageName": {
- // "description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "subscriptionId": {
- // "description": "The purchased subscription ID (for example, 'monthly001').",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "token": {
- // "description": "The token provided to the user's device when the subscription was purchased.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:revoke",
- // "scopes": [
- // "https://www.googleapis.com/auth/androidpublisher"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/api-list.json b/vendor/google.golang.org/api/api-list.json
deleted file mode 100644
index 41f792a2..00000000
--- a/vendor/google.golang.org/api/api-list.json
+++ /dev/null
@@ -1,2226 +0,0 @@
-{
- "kind": "discovery#directoryList",
- "discoveryVersion": "v1",
- "items": [
- {
- "kind": "discovery#directoryItem",
- "id": "adexchangebuyer:v1.2",
- "name": "adexchangebuyer",
- "version": "v1.2",
- "title": "Ad Exchange Buyer API",
- "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/adexchangebuyer/v1.2/rest",
- "discoveryLink": "./apis/adexchangebuyer/v1.2/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "adexchangebuyer:v1.3",
- "name": "adexchangebuyer",
- "version": "v1.3",
- "title": "Ad Exchange Buyer API",
- "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/adexchangebuyer/v1.3/rest",
- "discoveryLink": "./apis/adexchangebuyer/v1.3/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "adexchangebuyer:v1.4",
- "name": "adexchangebuyer",
- "version": "v1.4",
- "title": "Ad Exchange Buyer API",
- "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/adexchangebuyer/v1.4/rest",
- "discoveryLink": "./apis/adexchangebuyer/v1.4/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "adexchangeseller:v1",
- "name": "adexchangeseller",
- "version": "v1",
- "title": "Ad Exchange Seller API",
- "description": "Gives Ad Exchange seller users access to their inventory and the ability to generate reports",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/adexchangeseller/v1/rest",
- "discoveryLink": "./apis/adexchangeseller/v1/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/ad-exchange/seller-rest/",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "adexchangeseller:v1.1",
- "name": "adexchangeseller",
- "version": "v1.1",
- "title": "Ad Exchange Seller API",
- "description": "Gives Ad Exchange seller users access to their inventory and the ability to generate reports",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/adexchangeseller/v1.1/rest",
- "discoveryLink": "./apis/adexchangeseller/v1.1/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/ad-exchange/seller-rest/",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "adexchangeseller:v2.0",
- "name": "adexchangeseller",
- "version": "v2.0",
- "title": "Ad Exchange Seller API",
- "description": "Gives Ad Exchange seller users access to their inventory and the ability to generate reports",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/adexchangeseller/v2.0/rest",
- "discoveryLink": "./apis/adexchangeseller/v2.0/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/ad-exchange/seller-rest/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "admin:datatransfer_v1",
- "name": "admin",
- "version": "datatransfer_v1",
- "title": "Admin Data Transfer API",
- "description": "Admin Data Transfer API lets you transfer user data from one user to another.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/admin/datatransfer_v1/rest",
- "discoveryLink": "./apis/admin/datatransfer_v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/admin-sdk/data-transfer/",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "admin:directory_v1",
- "name": "admin",
- "version": "directory_v1",
- "title": "Admin Directory API",
- "description": "The Admin SDK Directory API lets you view and manage enterprise resources such as users and groups, administrative notifications, security features, and more.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/admin/directory_v1/rest",
- "discoveryLink": "./apis/admin/directory_v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/admin-sdk/directory/",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "admin:email_migration_v2",
- "name": "admin",
- "version": "email_migration_v2",
- "title": "Email Migration API v2",
- "description": "Email Migration API lets you migrate emails of users to Google backends.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/admin/email_migration_v2/rest",
- "discoveryLink": "./apis/admin/email_migration_v2/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/googlemail-16.png",
- "x32": "https://www.google.com/images/icons/product/googlemail-32.png"
- },
- "documentationLink": "https://developers.google.com/admin-sdk/email-migration/v2/",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "admin:reports_v1",
- "name": "admin",
- "version": "reports_v1",
- "title": "Admin Reports API",
- "description": "Allows the administrators of Google Apps customers to fetch reports about the usage, collaboration, security and risk for their users.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/admin/reports_v1/rest",
- "discoveryLink": "./apis/admin/reports_v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/admin-sdk/reports/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "adsense:v1.2",
- "name": "adsense",
- "version": "v1.2",
- "title": "AdSense Management API",
- "description": "Gives AdSense publishers access to their inventory and the ability to generate reports",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/adsense/v1.2/rest",
- "discoveryLink": "./apis/adsense/v1.2/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/adsense-16.png",
- "x32": "https://www.google.com/images/icons/product/adsense-32.png"
- },
- "documentationLink": "https://developers.google.com/adsense/management/",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "adsense:v1.3",
- "name": "adsense",
- "version": "v1.3",
- "title": "AdSense Management API",
- "description": "Gives AdSense publishers access to their inventory and the ability to generate reports",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/adsense/v1.3/rest",
- "discoveryLink": "./apis/adsense/v1.3/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/adsense-16.png",
- "x32": "https://www.google.com/images/icons/product/adsense-32.png"
- },
- "documentationLink": "https://developers.google.com/adsense/management/",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "adsense:v1.4",
- "name": "adsense",
- "version": "v1.4",
- "title": "AdSense Management API",
- "description": "Gives AdSense publishers access to their inventory and the ability to generate reports",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/adsense/v1.4/rest",
- "discoveryLink": "./apis/adsense/v1.4/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/adsense-16.png",
- "x32": "https://www.google.com/images/icons/product/adsense-32.png"
- },
- "documentationLink": "https://developers.google.com/adsense/management/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "adsensehost:v4.1",
- "name": "adsensehost",
- "version": "v4.1",
- "title": "AdSense Host API",
- "description": "Gives AdSense Hosts access to report generation, ad code generation, and publisher management capabilities.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/adsensehost/v4.1/rest",
- "discoveryLink": "./apis/adsensehost/v4.1/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/adsense-16.png",
- "x32": "https://www.google.com/images/icons/product/adsense-32.png"
- },
- "documentationLink": "https://developers.google.com/adsense/host/",
- "labels": [
- "limited_availability"
- ],
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "analytics:v2.4",
- "name": "analytics",
- "version": "v2.4",
- "title": "Google Analytics API",
- "description": "View and manage your Google Analytics data",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/analytics/v2.4/rest",
- "discoveryLink": "./apis/analytics/v2.4/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/analytics-16.png",
- "x32": "https://www.google.com/images/icons/product/analytics-32.png"
- },
- "documentationLink": "https://developers.google.com/analytics/",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "analytics:v3",
- "name": "analytics",
- "version": "v3",
- "title": "Google Analytics API",
- "description": "View and manage your Google Analytics data",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/analytics/v3/rest",
- "discoveryLink": "./apis/analytics/v3/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/analytics-16.png",
- "x32": "https://www.google.com/images/icons/product/analytics-32.png"
- },
- "documentationLink": "https://developers.google.com/analytics/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "androidenterprise:v1",
- "name": "androidenterprise",
- "version": "v1",
- "title": "Google Play EMM API",
- "description": "Allows MDMs/EMMs and enterprises to manage the deployment of apps to Android for Work users.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/androidenterprise/v1/rest",
- "discoveryLink": "./apis/androidenterprise/v1/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/android-16.png",
- "x32": "https://www.google.com/images/icons/product/android-32.png"
- },
- "documentationLink": "https://developers.google.com/play/enterprise",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "androidpublisher:v1",
- "name": "androidpublisher",
- "version": "v1",
- "title": "Google Play Developer API",
- "description": "Lets Android application developers access their Google Play accounts.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/androidpublisher/v1/rest",
- "discoveryLink": "./apis/androidpublisher/v1/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/android-16.png",
- "x32": "https://www.google.com/images/icons/product/android-32.png"
- },
- "documentationLink": "https://developers.google.com/android-publisher",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "androidpublisher:v1.1",
- "name": "androidpublisher",
- "version": "v1.1",
- "title": "Google Play Developer API",
- "description": "Lets Android application developers access their Google Play accounts.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/androidpublisher/v1.1/rest",
- "discoveryLink": "./apis/androidpublisher/v1.1/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/android-16.png",
- "x32": "https://www.google.com/images/icons/product/android-32.png"
- },
- "documentationLink": "https://developers.google.com/android-publisher",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "androidpublisher:v2",
- "name": "androidpublisher",
- "version": "v2",
- "title": "Google Play Developer API",
- "description": "Lets Android application developers access their Google Play accounts.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/androidpublisher/v2/rest",
- "discoveryLink": "./apis/androidpublisher/v2/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/android-16.png",
- "x32": "https://www.google.com/images/icons/product/android-32.png"
- },
- "documentationLink": "https://developers.google.com/android-publisher",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "appsactivity:v1",
- "name": "appsactivity",
- "version": "v1",
- "title": "Google Apps Activity API",
- "description": "Provides a historical view of activity.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/appsactivity/v1/rest",
- "discoveryLink": "./apis/appsactivity/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/google-apps/activity/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "appstate:v1",
- "name": "appstate",
- "version": "v1",
- "title": "Google App State API",
- "description": "The Google App State API.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/appstate/v1/rest",
- "discoveryLink": "./apis/appstate/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/games/services/web/api/states",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "autoscaler:v1beta2",
- "name": "autoscaler",
- "version": "v1beta2",
- "title": "Google Compute Engine Autoscaler API",
- "description": "The Google Compute Engine Autoscaler API provides autoscaling for groups of Cloud VMs.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/autoscaler/v1beta2/rest",
- "discoveryLink": "./apis/autoscaler/v1beta2/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "http://developers.google.com/compute/docs/autoscaler",
- "labels": [
- "limited_availability"
- ],
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "bigquery:v2",
- "name": "bigquery",
- "version": "v2",
- "title": "BigQuery API",
- "description": "A data platform for customers to create, manage, share and query data.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/bigquery/v2/rest",
- "discoveryLink": "./apis/bigquery/v2/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/search-16.gif",
- "x32": "https://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/bigquery/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "blogger:v2",
- "name": "blogger",
- "version": "v2",
- "title": "Blogger API",
- "description": "API for access to the data within Blogger.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/blogger/v2/rest",
- "discoveryLink": "./apis/blogger/v2/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/blogger-16.png",
- "x32": "https://www.google.com/images/icons/product/blogger-32.png"
- },
- "documentationLink": "https://developers.google.com/blogger/docs/2.0/json/getting_started",
- "labels": [
- "limited_availability"
- ],
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "blogger:v3",
- "name": "blogger",
- "version": "v3",
- "title": "Blogger API",
- "description": "API for access to the data within Blogger.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/blogger/v3/rest",
- "discoveryLink": "./apis/blogger/v3/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/blogger-16.png",
- "x32": "https://www.google.com/images/icons/product/blogger-32.png"
- },
- "documentationLink": "https://developers.google.com/blogger/docs/3.0/getting_started",
- "labels": [
- "limited_availability"
- ],
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "books:v1",
- "name": "books",
- "version": "v1",
- "title": "Books API",
- "description": "Lets you search for books and manage your Google Books library.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/books/v1/rest",
- "discoveryLink": "./apis/books/v1/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/ebooks-16.png",
- "x32": "https://www.google.com/images/icons/product/ebooks-32.png"
- },
- "documentationLink": "https://developers.google.com/books/docs/v1/getting_started",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "calendar:v3",
- "name": "calendar",
- "version": "v3",
- "title": "Calendar API",
- "description": "Lets you manipulate events and other calendar data.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/calendar/v3/rest",
- "discoveryLink": "./apis/calendar/v3/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/calendar-16.png",
- "x32": "http://www.google.com/images/icons/product/calendar-32.png"
- },
- "documentationLink": "https://developers.google.com/google-apps/calendar/firstapp",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "civicinfo:v2",
- "name": "civicinfo",
- "version": "v2",
- "title": "Google Civic Information API",
- "description": "An API for accessing civic information.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/civicinfo/v2/rest",
- "discoveryLink": "./apis/civicinfo/v2/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/civic-information",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "cloudlatencytest:v2",
- "name": "cloudlatencytest",
- "version": "v2",
- "title": "Google Cloud Network Performance Monitoring API",
- "description": "A Test API to report latency data.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/cloudlatencytest/v2/rest",
- "discoveryLink": "./apis/cloudlatencytest/v2/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "cloudmonitoring:v2beta2",
- "name": "cloudmonitoring",
- "version": "v2beta2",
- "title": "Cloud Monitoring API",
- "description": "API for accessing Google Cloud and API monitoring data.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/cloudmonitoring/v2beta2/rest",
- "discoveryLink": "./apis/cloudmonitoring/v2beta2/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/monitoring/v2beta2/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "clouduseraccounts:alpha",
- "name": "clouduseraccounts",
- "version": "alpha",
- "title": "Cloud User Accounts API",
- "description": "API for the Google Cloud User Accounts service.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/clouduseraccounts/alpha/rest",
- "discoveryLink": "./apis/clouduseraccounts/alpha/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/compute_engine-16.png",
- "x32": "https://www.google.com/images/icons/product/compute_engine-32.png"
- },
- "documentationLink": "https://cloud.google.com/compute/docs/access/user-accounts/api/latest/",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "clouduseraccounts:beta",
- "name": "clouduseraccounts",
- "version": "beta",
- "title": "Cloud User Accounts API",
- "description": "API for the Google Cloud User Accounts service.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/clouduseraccounts/beta/rest",
- "discoveryLink": "./apis/clouduseraccounts/beta/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/compute_engine-16.png",
- "x32": "https://www.google.com/images/icons/product/compute_engine-32.png"
- },
- "documentationLink": "https://cloud.google.com/compute/docs/access/user-accounts/api/latest/",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "clouduseraccounts:vm_alpha",
- "name": "clouduseraccounts",
- "version": "vm_alpha",
- "title": "Cloud User Accounts API",
- "description": "API for the Google Cloud User Accounts service.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/clouduseraccounts/vm_alpha/rest",
- "discoveryLink": "./apis/clouduseraccounts/vm_alpha/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/compute_engine-16.png",
- "x32": "https://www.google.com/images/icons/product/compute_engine-32.png"
- },
- "documentationLink": "https://cloud.google.com/compute/docs/access/user-accounts/api/latest/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "clouduseraccounts:vm_beta",
- "name": "clouduseraccounts",
- "version": "vm_beta",
- "title": "Cloud User Accounts API",
- "description": "API for the Google Cloud User Accounts service.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/clouduseraccounts/vm_beta/rest",
- "discoveryLink": "./apis/clouduseraccounts/vm_beta/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/compute_engine-16.png",
- "x32": "https://www.google.com/images/icons/product/compute_engine-32.png"
- },
- "documentationLink": "https://cloud.google.com/compute/docs/access/user-accounts/api/latest/",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "compute:v1",
- "name": "compute",
- "version": "v1",
- "title": "Compute Engine API",
- "description": "API for the Google Compute Engine service.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/compute/v1/rest",
- "discoveryLink": "./apis/compute/v1/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/compute_engine-16.png",
- "x32": "https://www.google.com/images/icons/product/compute_engine-32.png"
- },
- "documentationLink": "https://developers.google.com/compute/docs/reference/latest/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "content:v2sandbox",
- "name": "content",
- "version": "v2sandbox",
- "title": "Content API for Shopping",
- "description": "Manage product items, inventory, and Merchant Center accounts for Google Shopping.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/content/v2sandbox/rest",
- "discoveryLink": "./apis/content/v2sandbox/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/shopping-content",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "content:v2",
- "name": "content",
- "version": "v2",
- "title": "Content API for Shopping",
- "description": "Manage product items, inventory, and Merchant Center accounts for Google Shopping.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/content/v2/rest",
- "discoveryLink": "./apis/content/v2/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/shopping-content",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "coordinate:v1",
- "name": "coordinate",
- "version": "v1",
- "title": "Google Maps Coordinate API",
- "description": "Lets you view and manage jobs in a Coordinate team.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/coordinate/v1/rest",
- "discoveryLink": "./apis/coordinate/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/coordinate/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "customsearch:v1",
- "name": "customsearch",
- "version": "v1",
- "title": "CustomSearch API",
- "description": "Lets you search over a website or collection of websites",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/customsearch/v1/rest",
- "discoveryLink": "./apis/customsearch/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/custom-search/v1/using_rest",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "datastore:v1beta1",
- "name": "datastore",
- "version": "v1beta1",
- "title": "Google Cloud Datastore API",
- "description": "API for accessing Google Cloud Datastore.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/datastore/v1beta1/rest",
- "discoveryLink": "./apis/datastore/v1beta1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/datastore/",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "datastore:v1beta2",
- "name": "datastore",
- "version": "v1beta2",
- "title": "Google Cloud Datastore API",
- "description": "API for accessing Google Cloud Datastore.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/datastore/v1beta2/rest",
- "discoveryLink": "./apis/datastore/v1beta2/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/datastore/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "deploymentmanager:v2",
- "name": "deploymentmanager",
- "version": "v2",
- "title": "Google Cloud Deployment Manager API",
- "description": "The Deployment Manager API allows users to declaratively configure, deploy and run complex solutions on the Google Cloud Platform.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/deploymentmanager/v2/rest",
- "discoveryLink": "./apis/deploymentmanager/v2/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/deployment-manager/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "deploymentmanager:v2beta1",
- "name": "deploymentmanager",
- "version": "v2beta1",
- "title": "Google Cloud Deployment Manager API",
- "description": "The Deployment Manager API allows users to declaratively configure, deploy and run complex solutions on the Google Cloud Platform.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/deploymentmanager/v2beta1/rest",
- "discoveryLink": "./apis/deploymentmanager/v2beta1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/deployment-manager/",
- "labels": [
- "limited_availability"
- ],
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "deploymentmanager:v2beta2",
- "name": "deploymentmanager",
- "version": "v2beta2",
- "title": "Google Cloud Deployment Manager API",
- "description": "The Deployment Manager API allows users to declaratively configure, deploy and run complex solutions on the Google Cloud Platform.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/deploymentmanager/v2beta2/rest",
- "discoveryLink": "./apis/deploymentmanager/v2beta2/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/deployment-manager/",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "dfareporting:v1",
- "name": "dfareporting",
- "version": "v1",
- "title": "DFA Reporting API",
- "description": "Lets you create, run and download reports.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/dfareporting/v1/rest",
- "discoveryLink": "./apis/dfareporting/v1/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/doubleclick-advertisers/reporting/",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "dfareporting:v1.1",
- "name": "dfareporting",
- "version": "v1.1",
- "title": "DFA Reporting API",
- "description": "Lets you create, run and download reports.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/dfareporting/v1.1/rest",
- "discoveryLink": "./apis/dfareporting/v1.1/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/doubleclick-advertisers/reporting/",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "dfareporting:v1.2",
- "name": "dfareporting",
- "version": "v1.2",
- "title": "DFA Reporting API",
- "description": "Lets you create, run and download reports.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/dfareporting/v1.2/rest",
- "discoveryLink": "./apis/dfareporting/v1.2/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/doubleclick-advertisers/reporting/",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "dfareporting:v1.3",
- "name": "dfareporting",
- "version": "v1.3",
- "title": "DFA Reporting API",
- "description": "Lets you create, run and download reports.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/dfareporting/v1.3/rest",
- "discoveryLink": "./apis/dfareporting/v1.3/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/doubleclick-advertisers/reporting/",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "dfareporting:v2.0",
- "name": "dfareporting",
- "version": "v2.0",
- "title": "DCM/DFA Reporting And Trafficking API",
- "description": "Manage your DoubleClick Campaign Manager ad campaigns and reports.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/dfareporting/v2.0/rest",
- "discoveryLink": "./apis/dfareporting/v2.0/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/doubleclick-advertisers/reporting/",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "dfareporting:v2.1",
- "name": "dfareporting",
- "version": "v2.1",
- "title": "DCM/DFA Reporting And Trafficking API",
- "description": "Manage your DoubleClick Campaign Manager ad campaigns and reports.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/dfareporting/v2.1/rest",
- "discoveryLink": "./apis/dfareporting/v2.1/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/doubleclick-advertisers/reporting/",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "dfareporting:v2.2",
- "name": "dfareporting",
- "version": "v2.2",
- "title": "DCM/DFA Reporting And Trafficking API",
- "description": "Manage your DoubleClick Campaign Manager ad campaigns and reports.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/dfareporting/v2.2/rest",
- "discoveryLink": "./apis/dfareporting/v2.2/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/doubleclick-advertisers/reporting/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "discovery:v1",
- "name": "discovery",
- "version": "v1",
- "title": "APIs Discovery Service",
- "description": "Lets you discover information about other Google APIs, such as what APIs are available, the resource and method details for each API.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/discovery/v1/rest",
- "discoveryLink": "./apis/discovery/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/feature/filing_cabinet_search-g16.png",
- "x32": "http://www.google.com/images/icons/feature/filing_cabinet_search-g32.png"
- },
- "documentationLink": "https://developers.google.com/discovery/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "dns:v1",
- "name": "dns",
- "version": "v1",
- "title": "Google Cloud DNS API",
- "description": "The Google Cloud DNS API provides services for configuring and serving authoritative DNS records.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/dns/v1/rest",
- "discoveryLink": "./apis/dns/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/cloud-dns",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "dns:v1beta1",
- "name": "dns",
- "version": "v1beta1",
- "title": "Google Cloud DNS API",
- "description": "The Google Cloud DNS API provides services for configuring and serving authoritative DNS records.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/dns/v1beta1/rest",
- "discoveryLink": "./apis/dns/v1beta1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/cloud-dns",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "doubleclickbidmanager:v1",
- "name": "doubleclickbidmanager",
- "version": "v1",
- "title": "DoubleClick Bid Manager API",
- "description": "API for viewing and managing your reports in DoubleClick Bid Manager.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/doubleclickbidmanager/v1/rest",
- "discoveryLink": "./apis/doubleclickbidmanager/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/bid-manager/",
- "labels": [
- "limited_availability"
- ],
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "doubleclicksearch:v2",
- "name": "doubleclicksearch",
- "version": "v2",
- "title": "DoubleClick Search API",
- "description": "Report and modify your advertising data in DoubleClick Search (for example, campaigns, ad groups, keywords, and conversions).",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/doubleclicksearch/v2/rest",
- "discoveryLink": "./apis/doubleclicksearch/v2/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/doubleclick-search/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "drive:v1",
- "name": "drive",
- "version": "v1",
- "title": "Drive API",
- "description": "The API to interact with Drive.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/drive/v1/rest",
- "discoveryLink": "./apis/drive/v1/rest",
- "icons": {
- "x16": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_16.png",
- "x32": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_32.png"
- },
- "documentationLink": "https://developers.google.com/drive/",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "drive:v2",
- "name": "drive",
- "version": "v2",
- "title": "Drive API",
- "description": "The API to interact with Drive.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/drive/v2/rest",
- "discoveryLink": "./apis/drive/v2/rest",
- "icons": {
- "x16": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_16.png",
- "x32": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_32.png"
- },
- "documentationLink": "https://developers.google.com/drive/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "fitness:v1",
- "name": "fitness",
- "version": "v1",
- "title": "Fitness",
- "description": "Google Fit API",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/fitness/v1/rest",
- "discoveryLink": "./apis/fitness/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/fit/rest/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "freebase:v1",
- "name": "freebase",
- "version": "v1",
- "title": "Freebase Search",
- "description": "Find Freebase entities using textual queries and other constraints.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/freebase/v1/rest",
- "discoveryLink": "./apis/freebase/v1/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/freebase-16.png",
- "x32": "https://www.google.com/images/icons/product/freebase-32.png"
- },
- "documentationLink": "https://developers.google.com/freebase/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "fusiontables:v1",
- "name": "fusiontables",
- "version": "v1",
- "title": "Fusion Tables API",
- "description": "API for working with Fusion Tables data.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/fusiontables/v1/rest",
- "discoveryLink": "./apis/fusiontables/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/fusiontables",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "fusiontables:v2",
- "name": "fusiontables",
- "version": "v2",
- "title": "Fusion Tables API",
- "description": "API for working with Fusion Tables data.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/fusiontables/v2/rest",
- "discoveryLink": "./apis/fusiontables/v2/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/fusiontables",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "games:v1",
- "name": "games",
- "version": "v1",
- "title": "Google Play Game Services API",
- "description": "The API for Google Play Game Services.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/games/v1/rest",
- "discoveryLink": "./apis/games/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/games/services/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "gamesConfiguration:v1configuration",
- "name": "gamesConfiguration",
- "version": "v1configuration",
- "title": "Google Play Game Services Publishing API",
- "description": "The Publishing API for Google Play Game Services.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/gamesConfiguration/v1configuration/rest",
- "discoveryLink": "./apis/gamesConfiguration/v1configuration/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/games/services",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "gamesManagement:v1management",
- "name": "gamesManagement",
- "version": "v1management",
- "title": "Google Play Game Services Management API",
- "description": "The Management API for Google Play Game Services.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/gamesManagement/v1management/rest",
- "discoveryLink": "./apis/gamesManagement/v1management/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/games/services",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "gan:v1beta1",
- "name": "gan",
- "version": "v1beta1",
- "title": "Google Affiliate Network API",
- "description": "Lets you have programmatic access to your Google Affiliate Network data.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/gan/v1beta1/rest",
- "discoveryLink": "./apis/gan/v1beta1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/affiliatenetwork-16.png",
- "x32": "http://www.google.com/images/icons/product/affiliatenetwork-32.png"
- },
- "documentationLink": "https://developers.google.com/affiliate-network/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "genomics:v1beta2",
- "name": "genomics",
- "version": "v1beta2",
- "title": "Genomics API",
- "description": "Provides access to Genomics data.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/genomics/v1beta2/rest",
- "discoveryLink": "./apis/genomics/v1beta2/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/genomics/v1beta2/reference",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "gmail:v1",
- "name": "gmail",
- "version": "v1",
- "title": "Gmail API",
- "description": "The Gmail REST API.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/gmail/v1/rest",
- "discoveryLink": "./apis/gmail/v1/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/googlemail-16.png",
- "x32": "https://www.google.com/images/icons/product/googlemail-32.png"
- },
- "documentationLink": "https://developers.google.com/gmail/api/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "groupsmigration:v1",
- "name": "groupsmigration",
- "version": "v1",
- "title": "Groups Migration API",
- "description": "Groups Migration Api.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/groupsmigration/v1/rest",
- "discoveryLink": "./apis/groupsmigration/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/discussions-16.gif",
- "x32": "http://www.google.com/images/icons/product/discussions-32.gif"
- },
- "documentationLink": "https://developers.google.com/google-apps/groups-migration/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "groupssettings:v1",
- "name": "groupssettings",
- "version": "v1",
- "title": "Groups Settings API",
- "description": "Lets you manage permission levels and related settings of a group.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/groupssettings/v1/rest",
- "discoveryLink": "./apis/groupssettings/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/google-apps/groups-settings/get_started",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "appengine:v1beta4",
- "name": "appengine",
- "version": "v1beta4",
- "title": "Google App Engine Admin API",
- "description": "The Google App Engine Admin API enables developers to provision and manage their App Engine applications.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/appengine/v1beta4/rest",
- "discoveryLink": "./apis/appengine/v1beta4/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/appengine/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "classroom:v1",
- "name": "classroom",
- "version": "v1",
- "title": "Google Classroom API",
- "description": "Google Classroom API",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/classroom/v1/rest",
- "discoveryLink": "./apis/classroom/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/classroom/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "cloudbilling:v1",
- "name": "cloudbilling",
- "version": "v1",
- "title": "Google Cloud Billing API",
- "description": "Retrieves Google Developers Console billing accounts and associates them with projects.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/cloudbilling/v1/rest",
- "discoveryLink": "./apis/cloudbilling/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/billing/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "clouddebugger:v2",
- "name": "clouddebugger",
- "version": "v2",
- "title": "Google Cloud Debugger API",
- "description": "Lets you examine the stack and variables of your running application without stopping or slowing it down.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/clouddebugger/v2/rest",
- "discoveryLink": "./apis/clouddebugger/v2/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/tools/cloud-debugger",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "cloudresourcemanager:v1beta1",
- "name": "cloudresourcemanager",
- "version": "v1beta1",
- "title": "Google Cloud Resource Manager API",
- "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating of project metadata.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/cloudresourcemanager/v1beta1/rest",
- "discoveryLink": "./apis/cloudresourcemanager/v1beta1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/resource-manager",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "cloudtrace:v1",
- "name": "cloudtrace",
- "version": "v1",
- "title": "Google Cloud Trace API",
- "description": "The Google Cloud Trace API provides services for reading and writing runtime trace data for Cloud applications.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/cloudtrace/v1/rest",
- "discoveryLink": "./apis/cloudtrace/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/tools/cloud-trace",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "container:v1",
- "name": "container",
- "version": "v1",
- "title": "Google Container Engine API",
- "description": "The Google Container Engine API is used for building and managing container based applications, powered by the open source Kubernetes technology.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/container/v1/rest",
- "discoveryLink": "./apis/container/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/container-engine/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "dataflow:v1b3",
- "name": "dataflow",
- "version": "v1b3",
- "title": "Google Dataflow API",
- "description": "Google Dataflow API.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/dataflow/v1b3/rest",
- "discoveryLink": "./apis/dataflow/v1b3/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/dataflow",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "genomics:v1",
- "name": "genomics",
- "version": "v1",
- "title": "Genomics API",
- "description": "An API to store, process, explore, and share DNA sequence reads, reference-based alignments, and variant calls.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/genomics/v1/rest",
- "discoveryLink": "./apis/genomics/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "logging:v1beta3",
- "name": "logging",
- "version": "v1beta3",
- "title": "Google Cloud Logging API",
- "description": "Google Cloud Logging API lets you create logs, ingest log entries, and manage log sinks.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/logging/v1beta3/rest",
- "discoveryLink": "./apis/logging/v1beta3/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/logging/docs/",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "logging:v2beta1",
- "name": "logging",
- "version": "v2beta1",
- "title": "Google Cloud Logging API",
- "description": "Google Cloud Logging API lets you create logs, ingest log entries, and manage log sinks.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/logging/v2beta1/rest",
- "discoveryLink": "./apis/logging/v2beta1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/logging/docs/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "partners:v2",
- "name": "partners",
- "version": "v2",
- "title": "Google Partners API",
- "description": "Lets advertisers search certified companies and create contact leads with them, and also audits the usage of clients.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/partners/v2/rest",
- "discoveryLink": "./apis/partners/v2/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/partners/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "playmoviespartner:v1",
- "name": "playmoviespartner",
- "version": "v1",
- "title": "Google Play Movies Partner API",
- "description": "Lets Google Play Movies Partners get the delivery status of their titles.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/playmoviespartner/v1/rest",
- "discoveryLink": "./apis/playmoviespartner/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/playmoviespartner/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "proximitybeacon:v1beta1",
- "name": "proximitybeacon",
- "version": "v1beta1",
- "title": "Google Proximity Beacon API",
- "description": "This API provides services to register, manage, index, and search beacons.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/proximitybeacon/v1beta1/rest",
- "discoveryLink": "./apis/proximitybeacon/v1beta1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/beacons/proximity/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "pubsub:v1beta1a",
- "name": "pubsub",
- "version": "v1beta1a",
- "title": "Google Cloud Pub/Sub API",
- "description": "Provides reliable, many-to-many, asynchronous messaging between applications.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/pubsub/v1beta1a/rest",
- "discoveryLink": "./apis/pubsub/v1beta1a/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/pubsub/docs",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "pubsub:v1",
- "name": "pubsub",
- "version": "v1",
- "title": "Google Cloud Pub/Sub API",
- "description": "Provides reliable, many-to-many, asynchronous messaging between applications.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/pubsub/v1/rest",
- "discoveryLink": "./apis/pubsub/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/pubsub/docs",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "pubsub:v1beta2",
- "name": "pubsub",
- "version": "v1beta2",
- "title": "Google Cloud Pub/Sub API",
- "description": "Provides reliable, many-to-many, asynchronous messaging between applications.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/pubsub/v1beta2/rest",
- "discoveryLink": "./apis/pubsub/v1beta2/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/pubsub/docs",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "script:v1",
- "name": "script",
- "version": "v1",
- "title": "Google Apps Script Execution API",
- "description": "An API for executing Google Apps Script projects.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/script/v1/rest",
- "discoveryLink": "./apis/script/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/apps-script/execution/rest/v1/run",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "storagetransfer:v1",
- "name": "storagetransfer",
- "version": "v1",
- "title": "Google Storage Transfer API",
- "description": "Transfers data from external data sources to a Google Cloud Storage bucket or between Google Cloud Storage buckets.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/storagetransfer/v1/rest",
- "discoveryLink": "./apis/storagetransfer/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/storage/transfer",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "youtubereporting:v1",
- "name": "youtubereporting",
- "version": "v1",
- "title": "YouTube Reporting API",
- "description": "An API to schedule reporting jobs and download the resulting bulk data reports about YouTube channels, videos etc. in the form of CSV files.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/youtubereporting/v1/rest",
- "discoveryLink": "./apis/youtubereporting/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/youtube/reporting/v1/reports/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "identitytoolkit:v3",
- "name": "identitytoolkit",
- "version": "v3",
- "title": "Google Identity Toolkit API",
- "description": "Help the third party sites to implement federated login.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/identitytoolkit/v3/rest",
- "discoveryLink": "./apis/identitytoolkit/v3/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/identity-toolkit/v3/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "licensing:v1",
- "name": "licensing",
- "version": "v1",
- "title": "Enterprise License Manager API",
- "description": "Licensing API to view and manage license for your domain.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/licensing/v1/rest",
- "discoveryLink": "./apis/licensing/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/google-apps/licensing/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "manager:v1beta2",
- "name": "manager",
- "version": "v1beta2",
- "title": "Deployment Manager API",
- "description": "The Deployment Manager API allows users to declaratively configure, deploy and run complex solutions on the Google Cloud Platform.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/manager/v1beta2/rest",
- "discoveryLink": "./apis/manager/v1beta2/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/deployment-manager/",
- "labels": [
- "limited_availability"
- ],
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "mapsengine:exp2",
- "name": "mapsengine",
- "version": "exp2",
- "title": "Google Maps Engine API",
- "description": "The Google Maps Engine API allows developers to store and query geospatial vector and raster data.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/mapsengine/exp2/rest",
- "discoveryLink": "./apis/mapsengine/exp2/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/maps_engine-16.png",
- "x32": "https://www.google.com/images/icons/product/maps_engine-32.png"
- },
- "documentationLink": "https://developers.google.com/maps-engine/",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "mapsengine:v1",
- "name": "mapsengine",
- "version": "v1",
- "title": "Google Maps Engine API",
- "description": "The Google Maps Engine API allows developers to store and query geospatial vector and raster data.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/mapsengine/v1/rest",
- "discoveryLink": "./apis/mapsengine/v1/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/maps_engine-16.png",
- "x32": "https://www.google.com/images/icons/product/maps_engine-32.png"
- },
- "documentationLink": "https://developers.google.com/maps-engine/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "mirror:v1",
- "name": "mirror",
- "version": "v1",
- "title": "Google Mirror API",
- "description": "API for interacting with Glass users via the timeline.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/mirror/v1/rest",
- "discoveryLink": "./apis/mirror/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/glass",
- "labels": [
- "limited_availability"
- ],
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "oauth2:v1",
- "name": "oauth2",
- "version": "v1",
- "title": "Google OAuth2 API",
- "description": "Lets you access OAuth2 protocol related APIs.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/oauth2/v1/rest",
- "discoveryLink": "./apis/oauth2/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/accounts/docs/OAuth2",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "oauth2:v2",
- "name": "oauth2",
- "version": "v2",
- "title": "Google OAuth2 API",
- "description": "Lets you access OAuth2 protocol related APIs.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/oauth2/v2/rest",
- "discoveryLink": "./apis/oauth2/v2/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/accounts/docs/OAuth2",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "pagespeedonline:v1",
- "name": "pagespeedonline",
- "version": "v1",
- "title": "PageSpeed Insights API",
- "description": "Lets you analyze the performance of a web page and get tailored suggestions to make that page faster.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/pagespeedonline/v1/rest",
- "discoveryLink": "./apis/pagespeedonline/v1/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/pagespeed-16.png",
- "x32": "https://www.google.com/images/icons/product/pagespeed-32.png"
- },
- "documentationLink": "https://developers.google.com/speed/docs/insights/v1/getting_started",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "pagespeedonline:v2",
- "name": "pagespeedonline",
- "version": "v2",
- "title": "PageSpeed Insights API",
- "description": "Lets you analyze the performance of a web page and get tailored suggestions to make that page faster.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/pagespeedonline/v2/rest",
- "discoveryLink": "./apis/pagespeedonline/v2/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/pagespeed-16.png",
- "x32": "https://www.google.com/images/icons/product/pagespeed-32.png"
- },
- "documentationLink": "https://developers.google.com/speed/docs/insights/v2/getting-started",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "plus:v1",
- "name": "plus",
- "version": "v1",
- "title": "Google+ API",
- "description": "The Google+ API enables developers to build on top of the Google+ platform.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/plus/v1/rest",
- "discoveryLink": "./apis/plus/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/gplus-16.png",
- "x32": "http://www.google.com/images/icons/product/gplus-32.png"
- },
- "documentationLink": "https://developers.google.com/+/api/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "plusDomains:v1",
- "name": "plusDomains",
- "version": "v1",
- "title": "Google+ Domains API",
- "description": "The Google+ API enables developers to build on top of the Google+ platform.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/plusDomains/v1/rest",
- "discoveryLink": "./apis/plusDomains/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/gplus-16.png",
- "x32": "http://www.google.com/images/icons/product/gplus-32.png"
- },
- "documentationLink": "https://developers.google.com/+/domains/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "prediction:v1.2",
- "name": "prediction",
- "version": "v1.2",
- "title": "Prediction API",
- "description": "Lets you access a cloud hosted machine learning service that makes it easy to build smart apps",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/prediction/v1.2/rest",
- "discoveryLink": "./apis/prediction/v1.2/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/feature/predictionapi-16.png",
- "x32": "http://www.google.com/images/icons/feature/predictionapi-32.png"
- },
- "documentationLink": "https://developers.google.com/prediction/docs/developer-guide",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "prediction:v1.3",
- "name": "prediction",
- "version": "v1.3",
- "title": "Prediction API",
- "description": "Lets you access a cloud hosted machine learning service that makes it easy to build smart apps",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/prediction/v1.3/rest",
- "discoveryLink": "./apis/prediction/v1.3/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/feature/predictionapi-16.png",
- "x32": "http://www.google.com/images/icons/feature/predictionapi-32.png"
- },
- "documentationLink": "https://developers.google.com/prediction/docs/developer-guide",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "prediction:v1.4",
- "name": "prediction",
- "version": "v1.4",
- "title": "Prediction API",
- "description": "Lets you access a cloud hosted machine learning service that makes it easy to build smart apps",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/prediction/v1.4/rest",
- "discoveryLink": "./apis/prediction/v1.4/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/feature/predictionapi-16.png",
- "x32": "http://www.google.com/images/icons/feature/predictionapi-32.png"
- },
- "documentationLink": "https://developers.google.com/prediction/docs/developer-guide",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "prediction:v1.5",
- "name": "prediction",
- "version": "v1.5",
- "title": "Prediction API",
- "description": "Lets you access a cloud hosted machine learning service that makes it easy to build smart apps",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/prediction/v1.5/rest",
- "discoveryLink": "./apis/prediction/v1.5/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/feature/predictionapi-16.png",
- "x32": "http://www.google.com/images/icons/feature/predictionapi-32.png"
- },
- "documentationLink": "https://developers.google.com/prediction/docs/developer-guide",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "prediction:v1.6",
- "name": "prediction",
- "version": "v1.6",
- "title": "Prediction API",
- "description": "Lets you access a cloud hosted machine learning service that makes it easy to build smart apps",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/prediction/v1.6/rest",
- "discoveryLink": "./apis/prediction/v1.6/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/feature/predictionapi-16.png",
- "x32": "http://www.google.com/images/icons/feature/predictionapi-32.png"
- },
- "documentationLink": "https://developers.google.com/prediction/docs/developer-guide",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "pubsub:v1beta1",
- "name": "pubsub",
- "version": "v1beta1",
- "title": "Google Cloud Pub/Sub API",
- "description": "Provides reliable, many-to-many, asynchronous messaging between applications.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/pubsub/v1beta1/rest",
- "discoveryLink": "./apis/pubsub/v1beta1/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/search-16.gif",
- "x32": "https://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/pubsub/v1beta1",
- "labels": [
- "limited_availability"
- ],
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "qpxExpress:v1",
- "name": "qpxExpress",
- "version": "v1",
- "title": "QPX Express API",
- "description": "Lets you find the least expensive flights between an origin and a destination.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/qpxExpress/v1/rest",
- "discoveryLink": "./apis/qpxExpress/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "http://developers.google.com/qpx-express",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "replicapool:v1beta1",
- "name": "replicapool",
- "version": "v1beta1",
- "title": "Replica Pool API",
- "description": "The Replica Pool API allows users to declaratively provision and manage groups of Google Compute Engine instances based on a common template.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/replicapool/v1beta1/rest",
- "discoveryLink": "./apis/replicapool/v1beta1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/compute/docs/replica-pool/",
- "labels": [
- "limited_availability"
- ],
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "replicapool:v1beta2",
- "name": "replicapool",
- "version": "v1beta2",
- "title": "Google Compute Engine Instance Group Manager API",
- "description": "The Google Compute Engine Instance Group Manager API provides groups of homogenous Compute Engine Instances.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/replicapool/v1beta2/rest",
- "discoveryLink": "./apis/replicapool/v1beta2/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/compute/docs/instance-groups/manager/v1beta2",
- "labels": [
- "limited_availability"
- ],
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "replicapoolupdater:v1beta1",
- "name": "replicapoolupdater",
- "version": "v1beta1",
- "title": "Google Compute Engine Instance Group Updater API",
- "description": "The Google Compute Engine Instance Group Updater API provides services for updating groups of Compute Engine Instances.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/replicapoolupdater/v1beta1/rest",
- "discoveryLink": "./apis/replicapoolupdater/v1beta1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/compute/docs/instance-groups/manager/#applying_rolling_updates_using_the_updater_service",
- "labels": [
- "limited_availability"
- ],
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "reseller:v1sandbox",
- "name": "reseller",
- "version": "v1sandbox",
- "title": "Enterprise Apps Reseller API",
- "description": "Lets you create and manage your customers and their subscriptions.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/reseller/v1sandbox/rest",
- "discoveryLink": "./apis/reseller/v1sandbox/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/google-apps/reseller/",
- "labels": [
- "limited_availability"
- ],
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "reseller:v1",
- "name": "reseller",
- "version": "v1",
- "title": "Enterprise Apps Reseller API",
- "description": "Lets you create and manage your customers and their subscriptions.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/reseller/v1/rest",
- "discoveryLink": "./apis/reseller/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/google-apps/reseller/",
- "labels": [
- "limited_availability"
- ],
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "resourceviews:v1beta1",
- "name": "resourceviews",
- "version": "v1beta1",
- "title": "Resource Views API",
- "description": "The Resource View API allows users to create and manage logical sets of Google Compute Engine instances.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/resourceviews/v1beta1/rest",
- "discoveryLink": "./apis/resourceviews/v1beta1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/compute/",
- "labels": [
- "limited_availability"
- ],
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "resourceviews:v1beta2",
- "name": "resourceviews",
- "version": "v1beta2",
- "title": "Google Compute Engine Instance Groups API",
- "description": "The Resource View API allows users to create and manage logical sets of Google Compute Engine instances.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/resourceviews/v1beta2/rest",
- "discoveryLink": "./apis/resourceviews/v1beta2/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/compute/",
- "labels": [
- "limited_availability"
- ],
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "siteVerification:v1",
- "name": "siteVerification",
- "version": "v1",
- "title": "Google Site Verification API",
- "description": "Lets you programatically verify ownership of websites or domains with Google.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/siteVerification/v1/rest",
- "discoveryLink": "./apis/siteVerification/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/site-verification/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "spectrum:v1explorer",
- "name": "spectrum",
- "version": "v1explorer",
- "title": "Google Spectrum Database API",
- "description": "API for spectrum-management functions.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/spectrum/v1explorer/rest",
- "discoveryLink": "./apis/spectrum/v1explorer/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "http://developers.google.com/spectrum",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "sqladmin:v1beta3",
- "name": "sqladmin",
- "version": "v1beta3",
- "title": "Cloud SQL Administration API",
- "description": "API for Cloud SQL database instance management.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/sqladmin/v1beta3/rest",
- "discoveryLink": "./apis/sqladmin/v1beta3/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/sql/docs/reference/latest",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "sqladmin:v1beta4",
- "name": "sqladmin",
- "version": "v1beta4",
- "title": "Cloud SQL Administration API",
- "description": "API for Cloud SQL database instance management.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/sqladmin/v1beta4/rest",
- "discoveryLink": "./apis/sqladmin/v1beta4/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/sql/docs/reference/latest",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "storage:v1",
- "name": "storage",
- "version": "v1",
- "title": "Cloud Storage JSON API",
- "description": "Lets you store and retrieve potentially-large, immutable data objects.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/storage/v1/rest",
- "discoveryLink": "./apis/storage/v1/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/cloud_storage-16.png",
- "x32": "https://www.google.com/images/icons/product/cloud_storage-32.png"
- },
- "documentationLink": "https://developers.google.com/storage/docs/json_api/",
- "labels": [
- "labs"
- ],
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "storage:v1beta1",
- "name": "storage",
- "version": "v1beta1",
- "title": "Cloud Storage JSON API",
- "description": "Lets you store and retrieve potentially-large, immutable data objects.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/storage/v1beta1/rest",
- "discoveryLink": "./apis/storage/v1beta1/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/cloud_storage-16.png",
- "x32": "https://www.google.com/images/icons/product/cloud_storage-32.png"
- },
- "documentationLink": "https://developers.google.com/storage/docs/json_api/",
- "labels": [
- "labs"
- ],
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "storage:v1beta2",
- "name": "storage",
- "version": "v1beta2",
- "title": "Cloud Storage JSON API",
- "description": "Lets you store and retrieve potentially-large, immutable data objects.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/storage/v1beta2/rest",
- "discoveryLink": "./apis/storage/v1beta2/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/cloud_storage-16.png",
- "x32": "https://www.google.com/images/icons/product/cloud_storage-32.png"
- },
- "documentationLink": "https://developers.google.com/storage/docs/json_api/",
- "labels": [
- "labs"
- ],
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "tagmanager:v1",
- "name": "tagmanager",
- "version": "v1",
- "title": "Tag Manager API",
- "description": "API for accessing Tag Manager accounts and containers.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/tagmanager/v1/rest",
- "discoveryLink": "./apis/tagmanager/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/tag-manager/api/v1/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "taskqueue:v1beta1",
- "name": "taskqueue",
- "version": "v1beta1",
- "title": "TaskQueue API",
- "description": "Lets you access a Google App Engine Pull Task Queue over REST.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/taskqueue/v1beta1/rest",
- "discoveryLink": "./apis/taskqueue/v1beta1/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/app_engine-16.png",
- "x32": "https://www.google.com/images/icons/product/app_engine-32.png"
- },
- "documentationLink": "https://developers.google.com/appengine/docs/python/taskqueue/rest",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
- "id": "taskqueue:v1beta2",
- "name": "taskqueue",
- "version": "v1beta2",
- "title": "TaskQueue API",
- "description": "Lets you access a Google App Engine Pull Task Queue over REST.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/taskqueue/v1beta2/rest",
- "discoveryLink": "./apis/taskqueue/v1beta2/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/app_engine-16.png",
- "x32": "https://www.google.com/images/icons/product/app_engine-32.png"
- },
- "documentationLink": "https://developers.google.com/appengine/docs/python/taskqueue/rest",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "tasks:v1",
- "name": "tasks",
- "version": "v1",
- "title": "Tasks API",
- "description": "Lets you manage your tasks and task lists.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/tasks/v1/rest",
- "discoveryLink": "./apis/tasks/v1/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/tasks-16.png",
- "x32": "https://www.google.com/images/icons/product/tasks-32.png"
- },
- "documentationLink": "https://developers.google.com/google-apps/tasks/firstapp",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "translate:v2",
- "name": "translate",
- "version": "v2",
- "title": "Translate API",
- "description": "Lets you translate text from one language to another",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/translate/v2/rest",
- "discoveryLink": "./apis/translate/v2/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/translate-16.png",
- "x32": "https://www.google.com/images/icons/product/translate-32.png"
- },
- "documentationLink": "https://developers.google.com/translate/v2/using_rest",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "urlshortener:v1",
- "name": "urlshortener",
- "version": "v1",
- "title": "URL Shortener API",
- "description": "Lets you create, inspect, and manage goo.gl short URLs",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/urlshortener/v1/rest",
- "discoveryLink": "./apis/urlshortener/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/url-shortener/v1/getting_started",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "webfonts:v1",
- "name": "webfonts",
- "version": "v1",
- "title": "Google Fonts Developer API",
- "description": "The Google Fonts Developer API.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/webfonts/v1/rest",
- "discoveryLink": "./apis/webfonts/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/feature/font_api-16.png",
- "x32": "http://www.google.com/images/icons/feature/font_api-32.gif"
- },
- "documentationLink": "https://developers.google.com/fonts/docs/developer_api",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "webmasters:v3",
- "name": "webmasters",
- "version": "v3",
- "title": "Webmaster Tools API",
- "description": "Lets you view Google Webmaster Tools data for your verified sites.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/webmasters/v3/rest",
- "discoveryLink": "./apis/webmasters/v3/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/webmaster_tools-16.png",
- "x32": "https://www.google.com/images/icons/product/webmaster_tools-32.png"
- },
- "documentationLink": "https://developers.google.com/webmaster-tools/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "youtube:v3",
- "name": "youtube",
- "version": "v3",
- "title": "YouTube Data API",
- "description": "Programmatic access to YouTube features.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/youtube/v3/rest",
- "discoveryLink": "./apis/youtube/v3/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/youtube-16.png",
- "x32": "https://www.google.com/images/icons/product/youtube-32.png"
- },
- "documentationLink": "https://developers.google.com/youtube/v3",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "youtubeAnalytics:v1",
- "name": "youtubeAnalytics",
- "version": "v1",
- "title": "YouTube Analytics API",
- "description": "Retrieve your YouTube Analytics reports.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/youtubeAnalytics/v1/rest",
- "discoveryLink": "./apis/youtubeAnalytics/v1/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/youtube-16.png",
- "x32": "https://www.google.com/images/icons/product/youtube-32.png"
- },
- "documentationLink": "http://developers.google.com/youtube/analytics/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "youtubeAnalytics:v1beta1",
- "name": "youtubeAnalytics",
- "version": "v1beta1",
- "title": "YouTube Analytics API",
- "description": "Retrieve your YouTube Analytics reports.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/youtubeAnalytics/v1beta1/rest",
- "discoveryLink": "./apis/youtubeAnalytics/v1beta1/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/youtube-16.png",
- "x32": "https://www.google.com/images/icons/product/youtube-32.png"
- },
- "documentationLink": "http://developers.google.com/youtube/analytics/",
- "labels": [
- "deprecated"
- ],
- "preferred": false
- }
- ]
-}
diff --git a/vendor/google.golang.org/api/appengine/v1beta4/appengine-api.json b/vendor/google.golang.org/api/appengine/v1beta4/appengine-api.json
deleted file mode 100644
index 7d1851a8..00000000
--- a/vendor/google.golang.org/api/appengine/v1beta4/appengine-api.json
+++ /dev/null
@@ -1,1423 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/MxcrsWLtc_45Vl0dvlLXLZx13VM\"",
- "discoveryVersion": "v1",
- "id": "appengine:v1beta4",
- "name": "appengine",
- "version": "v1beta4",
- "revision": "20150831",
- "title": "Google App Engine Admin API",
- "description": "The Google App Engine Admin API enables developers to provision and manage their App Engine applications.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/appengine/",
- "protocol": "rest",
- "baseUrl": "https://appengine.googleapis.com/",
- "basePath": "/",
- "rootUrl": "https://appengine.googleapis.com/",
- "servicePath": "",
- "batchPath": "batch",
- "parameters": {
- "access_token": {
- "type": "string",
- "description": "OAuth access token.",
- "location": "query"
- },
- "alt": {
- "type": "string",
- "description": "Data format for response.",
- "default": "json",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "bearer_token": {
- "type": "string",
- "description": "OAuth bearer token.",
- "location": "query"
- },
- "callback": {
- "type": "string",
- "description": "JSONP",
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "pp": {
- "type": "boolean",
- "description": "Pretty-print response.",
- "default": "true",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "location": "query"
- },
- "upload_protocol": {
- "type": "string",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "location": "query"
- },
- "uploadType": {
- "type": "string",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query"
- },
- "$.xgafv": {
- "type": "string",
- "description": "V1 error format.",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "schemas": {
- "Application": {
- "id": "Application",
- "type": "object",
- "description": "An Application contains the top-level configuration of an App Engine application.",
- "properties": {
- "name": {
- "type": "string",
- "description": "The full path to the application in the API. Example: \"apps/myapp\". @OutputOnly"
- },
- "id": {
- "type": "string",
- "description": "The relative name/path of the application. Example: \"myapp\". @OutputOnly"
- },
- "dispatchRules": {
- "type": "array",
- "description": "HTTP path dispatch rules for requests to the app that do not explicitly target a module or version. The rules are order-dependent.",
- "items": {
- "$ref": "UrlDispatchRule"
- }
- },
- "location": {
- "type": "string",
- "description": "The location from which the application will be run. Choices are \"us-central\" for United States and \"europe-west\" for European Union. Application instances will run out of data centers in the chosen location and all of the application's End User Content will be stored at rest in the chosen location. The default is \"us-central\"."
- },
- "codeBucket": {
- "type": "string",
- "description": "A Google Cloud Storage bucket which can be used for storing files associated with an application. This bucket is associated with the application and can be used by the gcloud deployment commands. @OutputOnly"
- }
- }
- },
- "UrlDispatchRule": {
- "id": "UrlDispatchRule",
- "type": "object",
- "description": "Rules to match an HTTP request and dispatch that request to a module.",
- "properties": {
- "domain": {
- "type": "string",
- "description": "The domain name to match on. Supports '*' (glob) wildcarding on the left-hand side of a '.'. If empty, all domains will be matched (the same as '*')."
- },
- "path": {
- "type": "string",
- "description": "The pathname within the host. This must start with a '/'. A single '*' (glob) can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters."
- },
- "module": {
- "type": "string",
- "description": "The resource id of a Module in this application that should service the matched request. The Module must already exist. Example: \"default\"."
- }
- }
- },
- "Version": {
- "id": "Version",
- "type": "object",
- "description": "A Version is a specific set of source code and configuration files deployed to a module.",
- "properties": {
- "name": {
- "type": "string",
- "description": "The full path to the Version resource in the API. Example: \"apps/myapp/modules/default/versions/v1\". @OutputOnly"
- },
- "id": {
- "type": "string",
- "description": "The relative name/path of the Version within the module. Example: \"v1\". Version specifiers can contain lowercase letters, digits, and hyphens. It cannot begin with the prefix `ah-` and the names `default` and `latest` are reserved and cannot be used."
- },
- "automaticScaling": {
- "$ref": "AutomaticScaling",
- "description": "Automatic scaling is the scaling policy that App Engine has used since its inception. It is based on request rate, response latencies, and other application metrics."
- },
- "basicScaling": {
- "$ref": "BasicScaling",
- "description": "A module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity."
- },
- "manualScaling": {
- "$ref": "ManualScaling",
- "description": "A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time."
- },
- "inboundServices": {
- "type": "array",
- "description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.",
- "enumDescriptions": [
- "Not specified.",
- "Allows an application to receive mail.",
- "Allows an application receive email bound notifications.",
- "Allows an application to receive error stanzas.",
- "Allows an application to receive instant messages.",
- "Allows an application to receive user subscription POSTs.",
- "Allows an application to receive a user's chat presence.",
- "Registers an application for notifications when a client connects or disconnects from a channel.",
- "Enables warmup requests."
- ],
- "items": {
- "type": "string",
- "enum": [
- "INBOUND_SERVICE_UNSPECIFIED",
- "INBOUND_SERVICE_MAIL",
- "INBOUND_SERVICE_MAIL_BOUNCE",
- "INBOUND_SERVICE_XMPP_ERROR",
- "INBOUND_SERVICE_XMPP_MESSAGE",
- "INBOUND_SERVICE_XMPP_SUBSCRIBE",
- "INBOUND_SERVICE_XMPP_PRESENCE",
- "INBOUND_SERVICE_CHANNEL_PRESENCE",
- "INBOUND_SERVICE_WARMUP"
- ]
- }
- },
- "instanceClass": {
- "type": "string",
- "description": "The frontend instance class to use to run this app. Valid values are `[F1, F2, F4, F4_1G]`. Default: \"F1\""
- },
- "network": {
- "$ref": "Network",
- "description": "Used to specify extra network settings (for VM runtimes only)."
- },
- "resources": {
- "$ref": "Resources",
- "description": "Used to specify how many machine resources an app version needs (for VM runtimes only)."
- },
- "runtime": {
- "type": "string",
- "description": "The desired runtime. Values can include python27, java7, go, etc."
- },
- "threadsafe": {
- "type": "boolean",
- "description": "If true, multiple requests can be dispatched to the app at once."
- },
- "vm": {
- "type": "boolean",
- "description": "Whether to deploy this app in a VM container (deprecated, use \"env\":\"2\")."
- },
- "betaSettings": {
- "type": "object",
- "description": "Beta settings supplied to the application via metadata.",
- "additionalProperties": {
- "type": "string"
- }
- },
- "env": {
- "type": "string",
- "description": "The App Engine execution environment to use for this version. Default: \"1\""
- },
- "servingStatus": {
- "type": "string",
- "description": "The current serving status of this version. Only `SERVING` versions will have instances created or billed for. If this field is unset when a version is created, `SERVING` status will be assumed. It is an error to explicitly set this field to `SERVING_STATUS_UNSPECIFIED`.",
- "enum": [
- "SERVING_STATUS_UNSPECIFIED",
- "SERVING",
- "STOPPED"
- ]
- },
- "deployer": {
- "type": "string",
- "description": "The email address of the user who created this version. @OutputOnly"
- },
- "creationTime": {
- "type": "string",
- "description": "Creation time of this version. This will be between the start and end times of the operation that creates this version. @OutputOnly"
- },
- "handlers": {
- "type": "array",
- "description": "An ordered list of URL Matching patterns that should be applied to incoming requests. The first matching URL consumes the request, and subsequent handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.",
- "items": {
- "$ref": "UrlMap"
- }
- },
- "errorHandlers": {
- "type": "array",
- "description": "Custom static error pages instead of these generic error pages, (limit 10 KB/page) Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.",
- "items": {
- "$ref": "ErrorHandler"
- }
- },
- "libraries": {
- "type": "array",
- "description": "Configuration for Python runtime third-party libraries required by the application. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.",
- "items": {
- "$ref": "Library"
- }
- },
- "apiConfig": {
- "$ref": "ApiConfigHandler",
- "description": "Serving configuration for Google Cloud Endpoints. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable."
- },
- "envVariables": {
- "type": "object",
- "description": "Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.",
- "additionalProperties": {
- "type": "string"
- }
- },
- "defaultExpiration": {
- "type": "string",
- "description": "The length of time a static file served by a static file handler ought to be cached by web proxies and browsers, if the handler does not specify its own expiration. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable."
- },
- "healthCheck": {
- "$ref": "HealthCheck",
- "description": "Configure health checking for the VM instances. Unhealthy VM instances will be stopped and replaced with new instances. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable."
- },
- "nobuildFilesRegex": {
- "type": "string",
- "description": "Go only. Files that match this pattern will not be built into the app. May only be set on create requests."
- },
- "deployment": {
- "$ref": "Deployment",
- "description": "Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable."
- }
- }
- },
- "AutomaticScaling": {
- "id": "AutomaticScaling",
- "type": "object",
- "description": "Automatic scaling is the scaling policy that App Engine has used since its inception. It is based on request rate, response latencies, and other application metrics.",
- "properties": {
- "coolDownPeriod": {
- "type": "string",
- "description": "The amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Applies only to the VM runtime."
- },
- "cpuUtilization": {
- "$ref": "CpuUtilization",
- "description": "Target scaling by CPU usage."
- },
- "maxConcurrentRequests": {
- "type": "integer",
- "description": "The number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Default value is chosen based on the runtime.",
- "format": "int32"
- },
- "maxIdleInstances": {
- "type": "integer",
- "description": "The maximum number of idle instances that App Engine should maintain for this version.",
- "format": "int32"
- },
- "maxTotalInstances": {
- "type": "integer",
- "description": "Max number of instances that App Engine should start to handle requests.",
- "format": "int32"
- },
- "maxPendingLatency": {
- "type": "string",
- "description": "The maximum amount of time that App Engine should allow a request to wait in the pending queue before starting a new instance to handle it."
- },
- "minIdleInstances": {
- "type": "integer",
- "description": "The minimum number of idle instances that App Engine should maintain for this version. Only applies to the default version of a module, since other versions are not expected to receive significant traffic.",
- "format": "int32"
- },
- "minTotalInstances": {
- "type": "integer",
- "description": "Minimum number of instances that App Engine should maintain.",
- "format": "int32"
- },
- "minPendingLatency": {
- "type": "string",
- "description": "The minimum amount of time that App Engine should allow a request to wait in the pending queue before starting a new instance to handle it."
- }
- }
- },
- "CpuUtilization": {
- "id": "CpuUtilization",
- "type": "object",
- "description": "Target scaling by CPU usage.",
- "properties": {
- "aggregationWindowLength": {
- "type": "string",
- "description": "The period of time over which CPU utilization is calculated."
- },
- "targetUtilization": {
- "type": "number",
- "description": "Target (0-1) CPU utilization ratio to maintain when scaling.",
- "format": "double"
- }
- }
- },
- "BasicScaling": {
- "id": "BasicScaling",
- "type": "object",
- "description": "A module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
- "properties": {
- "idleTimeout": {
- "type": "string",
- "description": "The instance will be shut down this amount of time after receiving its last request."
- },
- "maxInstances": {
- "type": "integer",
- "description": "The maximum number of instances for App Engine to create for this version.",
- "format": "int32"
- }
- }
- },
- "ManualScaling": {
- "id": "ManualScaling",
- "type": "object",
- "description": "A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
- "properties": {
- "instances": {
- "type": "integer",
- "description": "The number of instances to assign to the module at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.",
- "format": "int32"
- }
- }
- },
- "Network": {
- "id": "Network",
- "type": "object",
- "description": "Used to specify extra network settings (for VM runtimes only).",
- "properties": {
- "forwardedPorts": {
- "type": "array",
- "description": "A list of ports (or port pairs) to forward from the VM into the app container.",
- "items": {
- "type": "string"
- }
- },
- "instanceTag": {
- "type": "string",
- "description": "A tag to apply to the VM instance during creation."
- },
- "name": {
- "type": "string",
- "description": "The Google Compute Engine network where the VMs will be created. If not specified, or empty, the network named \"default\" will be used. (The short name should be specified, not the resource path.)"
- }
- }
- },
- "Resources": {
- "id": "Resources",
- "type": "object",
- "description": "Used to specify how many machine resources an app version needs.",
- "properties": {
- "cpu": {
- "type": "number",
- "description": "How many CPU cores an app version needs.",
- "format": "double"
- },
- "diskGb": {
- "type": "number",
- "description": "How much disk size, in GB, an app version needs.",
- "format": "double"
- },
- "memoryGb": {
- "type": "number",
- "description": "How much memory, in GB, an app version needs.",
- "format": "double"
- }
- }
- },
- "UrlMap": {
- "id": "UrlMap",
- "type": "object",
- "description": "A URL pattern and description of how it should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the code, such as images, CSS or JavaScript.",
- "properties": {
- "urlRegex": {
- "type": "string",
- "description": "A URL prefix. This value uses regular expression syntax (and so regexp special characters must be escaped), but it should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path. This is always required."
- },
- "staticFiles": {
- "$ref": "StaticFilesHandler",
- "description": "Returns the contents of a file, such as an image, as the response."
- },
- "staticDirectory": {
- "$ref": "StaticDirectoryHandler",
- "description": "Serves the entire contents of a directory as static files. This attribute is deprecated. You can mimic the behavior of static directories using static files."
- },
- "script": {
- "$ref": "ScriptHandler",
- "description": "Executes a script to handle the request that matches the URL pattern."
- },
- "apiEndpoint": {
- "$ref": "ApiEndpointHandler",
- "description": "Use API Endpoints to handle requests."
- },
- "securityLevel": {
- "type": "string",
- "description": "Configures whether security (HTTPS) should be enforced for this URL.",
- "enum": [
- "SECURE_UNSPECIFIED",
- "SECURE_DEFAULT",
- "SECURE_NEVER",
- "SECURE_OPTIONAL",
- "SECURE_ALWAYS"
- ]
- },
- "login": {
- "type": "string",
- "description": "What level of login is required to access this resource.",
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ]
- },
- "authFailAction": {
- "type": "string",
- "description": "For users not logged in, how to handle access to resources with required login. Defaults to \"redirect\".",
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
- ]
- },
- "redirectHttpResponseCode": {
- "type": "string",
- "description": "`30x` code to use when performing redirects for the `secure` field. A `302` is used by default.",
- "enum": [
- "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
- "REDIRECT_HTTP_RESPONSE_CODE_301",
- "REDIRECT_HTTP_RESPONSE_CODE_302",
- "REDIRECT_HTTP_RESPONSE_CODE_303",
- "REDIRECT_HTTP_RESPONSE_CODE_307"
- ]
- }
- }
- },
- "StaticFilesHandler": {
- "id": "StaticFilesHandler",
- "type": "object",
- "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.",
- "properties": {
- "path": {
- "type": "string",
- "description": "The path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern."
- },
- "uploadPathRegex": {
- "type": "string",
- "description": "A regular expression that matches the file paths for all files that will be referenced by this handler."
- },
- "httpHeaders": {
- "type": "object",
- "description": "HTTP headers to use for all responses from these URLs.",
- "additionalProperties": {
- "type": "string"
- }
- },
- "mimeType": {
- "type": "string",
- "description": "If specified, all files served by this handler will be served using the specified MIME type. If not specified, the MIME type for a file will be derived from the file's filename extension."
- },
- "expiration": {
- "type": "string",
- "description": "The length of time a static file served by this handler ought to be cached by web proxies and browsers."
- },
- "requireMatchingFile": {
- "type": "boolean",
- "description": "If true, this [UrlMap][google.appengine.v1beta4.UrlMap] entry does not match the request unless the file referenced by the handler also exists. If no such file exists, processing will continue with the next [UrlMap][google.appengine.v1beta4.UrlMap] that matches the requested URL."
- },
- "applicationReadable": {
- "type": "boolean",
- "description": "By default, files declared in static file handlers are uploaded as static data and are only served to end users, they cannot be read by an application. If this field is set to true, the files are also uploaded as code data so your application can read them. Both uploads are charged against your code and static data storage resource quotas."
- }
- }
- },
- "StaticDirectoryHandler": {
- "id": "StaticDirectoryHandler",
- "type": "object",
- "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static directory handlers make it easy to serve the entire contents of a directory as static files.",
- "properties": {
- "directory": {
- "type": "string",
- "description": "The path to the directory containing the static files, from the application root directory. Everything after the end of the matched url pattern is appended to static_dir to form the full path to the requested file."
- },
- "httpHeaders": {
- "type": "object",
- "description": "HTTP headers to use for all responses from these URLs.",
- "additionalProperties": {
- "type": "string"
- }
- },
- "mimeType": {
- "type": "string",
- "description": "If specified, all files served by this handler will be served using the specified MIME type. If not specified, the MIME type for a file will be derived from the file's filename extension."
- },
- "expiration": {
- "type": "string",
- "description": "The length of time a static file served by this handler ought to be cached by web proxies and browsers."
- },
- "requireMatchingFile": {
- "type": "boolean",
- "description": "If true, this UrlMap entry does not match the request unless the file referenced by the handler also exists. If no such file exists, processing will continue with the next UrlMap that matches the requested URL."
- },
- "applicationReadable": {
- "type": "boolean",
- "description": "By default, files declared in static file handlers are uploaded as static data and are only served to end users, they cannot be read by an application. If this field is set to true, the files are also uploaded as code data so your application can read them. Both uploads are charged against your code and static data storage resource quotas."
- }
- }
- },
- "ScriptHandler": {
- "id": "ScriptHandler",
- "type": "object",
- "description": "Executes a script to handle the request that matches the URL pattern.",
- "properties": {
- "scriptPath": {
- "type": "string",
- "description": "Specifies the path to the script from the application root directory."
- }
- }
- },
- "ApiEndpointHandler": {
- "id": "ApiEndpointHandler",
- "type": "object",
- "description": "Use Google Cloud Endpoints to handle requests.",
- "properties": {
- "scriptPath": {
- "type": "string",
- "description": "Specifies the path to the script from the application root directory."
- }
- }
- },
- "ErrorHandler": {
- "id": "ErrorHandler",
- "type": "object",
- "description": "A custom static error page to be served when an error occurs.",
- "properties": {
- "errorCode": {
- "type": "string",
- "description": "The error condition this handler applies to.",
- "enum": [
- "ERROR_CODE_UNSPECIFIED",
- "ERROR_CODE_DEFAULT",
- "ERROR_CODE_OVER_QUOTA",
- "ERROR_CODE_DOS_API_DENIAL",
- "ERROR_CODE_TIMEOUT"
- ]
- },
- "staticFile": {
- "type": "string",
- "description": "Static file content to be served for this error."
- },
- "mimeType": {
- "type": "string",
- "description": "MIME type of file. If unspecified, \"text/html\" is assumed."
- }
- }
- },
- "Library": {
- "id": "Library",
- "type": "object",
- "description": "A Python runtime third-party library required by the application.",
- "properties": {
- "name": {
- "type": "string",
- "description": "The name of the library, e.g. \"PIL\" or \"django\"."
- },
- "version": {
- "type": "string",
- "description": "The version of the library to select, or \"latest\"."
- }
- }
- },
- "ApiConfigHandler": {
- "id": "ApiConfigHandler",
- "type": "object",
- "description": "API Serving configuration for Cloud Endpoints.",
- "properties": {
- "authFailAction": {
- "type": "string",
- "description": "For users not logged in, how to handle access to resources with required login. Defaults to \"redirect\".",
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
- ]
- },
- "login": {
- "type": "string",
- "description": "What level of login is required to access this resource. Default is \"optional\".",
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ]
- },
- "script": {
- "type": "string",
- "description": "Specifies the path to the script from the application root directory."
- },
- "securityLevel": {
- "type": "string",
- "description": "Configures whether security (HTTPS) should be enforced for this URL.",
- "enum": [
- "SECURE_UNSPECIFIED",
- "SECURE_DEFAULT",
- "SECURE_NEVER",
- "SECURE_OPTIONAL",
- "SECURE_ALWAYS"
- ]
- },
- "url": {
- "type": "string",
- "description": "URL to serve the endpoint at."
- }
- }
- },
- "HealthCheck": {
- "id": "HealthCheck",
- "type": "object",
- "description": "Configure health checking for the VM instances. Unhealthy VM instances will be killed and replaced with new instances.",
- "properties": {
- "disableHealthCheck": {
- "type": "boolean",
- "description": "Whether to explicitly disable health checks for this instance."
- },
- "host": {
- "type": "string",
- "description": "The host header to send when performing an HTTP health check (e.g. myapp.appspot.com)"
- },
- "healthyThreshold": {
- "type": "integer",
- "description": "The number of consecutive successful health checks before receiving traffic.",
- "format": "uint32"
- },
- "unhealthyThreshold": {
- "type": "integer",
- "description": "The number of consecutive failed health checks before removing traffic.",
- "format": "uint32"
- },
- "restartThreshold": {
- "type": "integer",
- "description": "The number of consecutive failed health checks before an instance is restarted.",
- "format": "uint32"
- },
- "checkInterval": {
- "type": "string",
- "description": "The interval between health checks."
- },
- "timeout": {
- "type": "string",
- "description": "The amount of time before the health check is considered failed."
- }
- }
- },
- "Deployment": {
- "id": "Deployment",
- "type": "object",
- "description": "Code and application artifacts used to deploy a version to App Engine.",
- "properties": {
- "files": {
- "type": "object",
- "description": "A manifest of files stored in Google Cloud Storage which should be included as part of this application. All files must be readable using the credentials supplied with this call.",
- "additionalProperties": {
- "$ref": "FileInfo"
- }
- },
- "container": {
- "$ref": "ContainerInfo",
- "description": "If supplied, a docker (container) image which should be used to start the application. Only applicable to the 'vm' runtime."
- },
- "sourceReferences": {
- "type": "array",
- "description": "The origin of the source code for this deployment. There can be more than one source reference per Version if source code is distributed among multiple repositories.",
- "items": {
- "$ref": "SourceReference"
- }
- }
- }
- },
- "FileInfo": {
- "id": "FileInfo",
- "type": "object",
- "description": "A single source file which is part of the application to be deployed.",
- "properties": {
- "sourceUrl": {
- "type": "string",
- "description": "The URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage."
- },
- "sha1Sum": {
- "type": "string",
- "description": "The SHA1 (160 bits) hash of the file in hex."
- },
- "mimeType": {
- "type": "string",
- "description": "The MIME type of the file; if unspecified, the value from Google Cloud Storage will be used."
- }
- }
- },
- "ContainerInfo": {
- "id": "ContainerInfo",
- "type": "object",
- "description": "A Docker (container) image which should be used to start the application.",
- "properties": {
- "image": {
- "type": "string",
- "description": "Reference to a hosted container image. Must be a URI to a resource in a Docker repository. Must be fully qualified, including tag or digest. e.g. gcr.io/my-project/image:tag or gcr.io/my-project/image@digest"
- }
- }
- },
- "SourceReference": {
- "id": "SourceReference",
- "type": "object",
- "description": "A reference to a particular snapshot of the source tree used to build and deploy the application.",
- "properties": {
- "repository": {
- "type": "string",
- "description": "Optional. A URI string identifying the repository. Example: \"https://source.developers.google.com/p/app-123/r/default\""
- },
- "revisionId": {
- "type": "string",
- "description": "The canonical (and persistent) identifier of the deployed revision, i.e. any kind of aliases including tags or branch names are not allowed. Example (git): \"2198322f89e0bb2e25021667c2ed489d1fd34e6b\""
- }
- }
- },
- "Operation": {
- "id": "Operation",
- "type": "object",
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "properties": {
- "name": {
- "type": "string",
- "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping above, the `name` should have the format of `operations/some/unique/name`."
- },
- "metadata": {
- "type": "object",
- "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @ype with type URL."
- }
- },
- "done": {
- "type": "boolean",
- "description": "If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available."
- },
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure."
- },
- "response": {
- "type": "object",
- "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @ype with type URL."
- }
- }
- }
- },
- "Status": {
- "id": "Status",
- "type": "object",
- "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][google.rpc.Code], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.",
- "properties": {
- "code": {
- "type": "integer",
- "description": "The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].",
- "format": "int32"
- },
- "message": {
- "type": "string",
- "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client."
- },
- "details": {
- "type": "array",
- "description": "A list of messages that carry the error details. There will be a common set of message types for APIs to use.",
- "items": {
- "type": "object",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @ype with type URL."
- }
- }
- }
- }
- },
- "ListVersionsResponse": {
- "id": "ListVersionsResponse",
- "type": "object",
- "description": "Response message for `Versions.ListVersions`.",
- "properties": {
- "versions": {
- "type": "array",
- "description": "The versions belonging to the requested application module.",
- "items": {
- "$ref": "Version"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token for fetching the next page of results."
- }
- }
- },
- "Module": {
- "id": "Module",
- "type": "object",
- "description": "A module is a component of an application that provides a single service or configuration. A module has a collection of versions that define a specific set of code used to implement the functionality of that module.",
- "properties": {
- "name": {
- "type": "string",
- "description": "The full path to the Module resource in the API. Example: \"apps/myapp/modules/default\" @OutputOnly"
- },
- "id": {
- "type": "string",
- "description": "The relative name/path of the module within the application. Example: \"default\" @OutputOnly"
- },
- "split": {
- "$ref": "TrafficSplit",
- "description": "A mapping that defines fractional HTTP traffic diversion to different versions within the module."
- }
- }
- },
- "TrafficSplit": {
- "id": "TrafficSplit",
- "type": "object",
- "description": "Configuration for traffic splitting for versions within a single module. Traffic splitting allows traffic directed to the module to be assigned to one of several versions in a fractional way, enabling experiments and canarying new builds, for example.",
- "properties": {
- "shardBy": {
- "type": "string",
- "description": "Which mechanism should be used as a selector when choosing a version to send a request to. The traffic selection algorithm will be stable for either type until allocations are changed.",
- "enum": [
- "UNSPECIFIED",
- "COOKIE",
- "IP"
- ]
- },
- "allocations": {
- "type": "object",
- "description": "Mapping from module version IDs within the module to fractional (0.000, 1] allocations of traffic for that version. Each version may only be specified once, but some versions in the module may not have any traffic allocation. Modules that have traffic allocated in this field may not be deleted until the module is deleted, or their traffic allocation is removed. Allocations must sum to 1. Supports precision up to two decimal places for IP-based splits and up to three decimal places for cookie-based splits.",
- "additionalProperties": {
- "type": "number",
- "format": "double"
- }
- }
- }
- },
- "ListModulesResponse": {
- "id": "ListModulesResponse",
- "type": "object",
- "description": "Response message for `Modules.ListModules`.",
- "properties": {
- "modules": {
- "type": "array",
- "description": "The modules belonging to the requested application.",
- "items": {
- "$ref": "Module"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token for fetching the next page of results."
- }
- }
- },
- "ListOperationsResponse": {
- "id": "ListOperationsResponse",
- "type": "object",
- "description": "The response message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].",
- "properties": {
- "operations": {
- "type": "array",
- "description": "A list of operations that matches the specified filter in the request.",
- "items": {
- "$ref": "Operation"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "The standard List next-page token."
- }
- }
- },
- "OperationMetadata": {
- "id": "OperationMetadata",
- "type": "object",
- "description": "Metadata for the given [google.longrunning.Operation][google.longrunning.Operation].",
- "properties": {
- "operationType": {
- "type": "string",
- "description": "The type of the operation (deprecated, use method field instead). Example: \"create_version\". @OutputOnly"
- },
- "insertTime": {
- "type": "string",
- "description": "Timestamp that this operation was received. @OutputOnly"
- },
- "endTime": {
- "type": "string",
- "description": "Timestamp that this operation was completed. (Not present if the operation is still in progress.) @OutputOnly"
- },
- "user": {
- "type": "string",
- "description": "The user who requested this operation. @OutputOnly"
- },
- "target": {
- "type": "string",
- "description": "Resource that this operation is acting on. Example: \"apps/myapp/modules/default\". @OutputOnly"
- },
- "method": {
- "type": "string",
- "description": "API method name that initiated the operation. Example: \"google.appengine.v1beta4.Version.CreateVersion\". @OutputOnly"
- }
- }
- }
- },
- "resources": {
- "apps": {
- "methods": {
- "get": {
- "id": "appengine.apps.get",
- "path": "v1beta4/apps/{appsId}",
- "httpMethod": "GET",
- "description": "Gets information about an application.",
- "parameters": {
- "appsId": {
- "type": "string",
- "description": "Part of `name`. Name of the application to get. For example: \"apps/myapp\".",
- "required": true,
- "location": "path"
- },
- "ensureResourcesExist": {
- "type": "boolean",
- "description": "Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the `GET` operation. If specified and any resources cloud not be created, the request will fail with an error code.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "Application"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- },
- "resources": {
- "modules": {
- "methods": {
- "delete": {
- "id": "appengine.apps.modules.delete",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "httpMethod": "DELETE",
- "description": "Deletes a module and all enclosed versions.",
- "parameters": {
- "appsId": {
- "type": "string",
- "description": "Part of `name`. Name of the resource requested. For example: \"apps/myapp/modules/default\".",
- "required": true,
- "location": "path"
- },
- "modulesId": {
- "type": "string",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "appsId",
- "modulesId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "get": {
- "id": "appengine.apps.modules.get",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "httpMethod": "GET",
- "description": "Gets the current configuration of the module.",
- "parameters": {
- "appsId": {
- "type": "string",
- "description": "Part of `name`. Name of the resource requested. For example: \"apps/myapp/modules/default\".",
- "required": true,
- "location": "path"
- },
- "modulesId": {
- "type": "string",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "appsId",
- "modulesId"
- ],
- "response": {
- "$ref": "Module"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "list": {
- "id": "appengine.apps.modules.list",
- "path": "v1beta4/apps/{appsId}/modules",
- "httpMethod": "GET",
- "description": "Lists all the modules in the application.",
- "parameters": {
- "appsId": {
- "type": "string",
- "description": "Part of `name`. Name of the resource requested. For example: \"apps/myapp\".",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "type": "integer",
- "description": "Maximum results to return per page.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Continuation token for fetching the next page of results.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "ListModulesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "patch": {
- "id": "appengine.apps.modules.patch",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "httpMethod": "PATCH",
- "description": "Updates the configuration of the specified module.",
- "parameters": {
- "appsId": {
- "type": "string",
- "description": "Part of `name`. Name of the resource to update. For example: \"apps/myapp/modules/default\".",
- "required": true,
- "location": "path"
- },
- "modulesId": {
- "type": "string",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "location": "path"
- },
- "mask": {
- "type": "string",
- "description": "Standard field mask for the set of fields to be updated.",
- "location": "query"
- },
- "migrateTraffic": {
- "type": "boolean",
- "description": "Whether to use Traffic Migration to shift traffic gradually. Traffic can only be migrated from a single version to another single version.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "appsId",
- "modulesId"
- ],
- "request": {
- "$ref": "Module"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- },
- "resources": {
- "versions": {
- "methods": {
- "create": {
- "id": "appengine.apps.modules.versions.create",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
- "httpMethod": "POST",
- "description": "Deploys new code and resource files to a version.",
- "parameters": {
- "appsId": {
- "type": "string",
- "description": "Part of `name`. Name of the resource to update. For example: \"apps/myapp/modules/default\".",
- "required": true,
- "location": "path"
- },
- "modulesId": {
- "type": "string",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "appsId",
- "modulesId"
- ],
- "request": {
- "$ref": "Version"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "delete": {
- "id": "appengine.apps.modules.versions.delete",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing version.",
- "parameters": {
- "appsId": {
- "type": "string",
- "description": "Part of `name`. Name of the resource requested. For example: \"apps/myapp/modules/default/versions/v1\".",
- "required": true,
- "location": "path"
- },
- "modulesId": {
- "type": "string",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "location": "path"
- },
- "versionsId": {
- "type": "string",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "get": {
- "id": "appengine.apps.modules.versions.get",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
- "httpMethod": "GET",
- "description": "Gets application deployment information.",
- "parameters": {
- "appsId": {
- "type": "string",
- "description": "Part of `name`. Name of the resource requested. For example: \"apps/myapp/modules/default/versions/v1\".",
- "required": true,
- "location": "path"
- },
- "modulesId": {
- "type": "string",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "location": "path"
- },
- "versionsId": {
- "type": "string",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "location": "path"
- },
- "view": {
- "type": "string",
- "description": "Controls the set of fields returned in the `Get` response.",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId"
- ],
- "response": {
- "$ref": "Version"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "list": {
- "id": "appengine.apps.modules.versions.list",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
- "httpMethod": "GET",
- "description": "Lists the versions of a module.",
- "parameters": {
- "appsId": {
- "type": "string",
- "description": "Part of `name`. Name of the resource requested. For example: \"apps/myapp/modules/default\".",
- "required": true,
- "location": "path"
- },
- "modulesId": {
- "type": "string",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "location": "path"
- },
- "view": {
- "type": "string",
- "description": "Controls the set of fields returned in the `List` response.",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "location": "query"
- },
- "pageSize": {
- "type": "integer",
- "description": "Maximum results to return per page.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Continuation token for fetching the next page of results.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "appsId",
- "modulesId"
- ],
- "response": {
- "$ref": "ListVersionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- }
- }
- },
- "operations": {
- "methods": {
- "get": {
- "id": "appengine.apps.operations.get",
- "path": "v1beta4/apps/{appsId}/operations/{operationsId}",
- "httpMethod": "GET",
- "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
- "parameters": {
- "appsId": {
- "type": "string",
- "description": "Part of `name`. The name of the operation resource.",
- "required": true,
- "location": "path"
- },
- "operationsId": {
- "type": "string",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "appsId",
- "operationsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "list": {
- "id": "appengine.apps.operations.list",
- "path": "v1beta4/apps/{appsId}/operations",
- "httpMethod": "GET",
- "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.",
- "parameters": {
- "appsId": {
- "type": "string",
- "description": "Part of `name`. The name of the operation collection.",
- "required": true,
- "location": "path"
- },
- "filter": {
- "type": "string",
- "description": "The standard list filter.",
- "location": "query"
- },
- "pageSize": {
- "type": "integer",
- "description": "The standard list page size.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The standard list page token.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/appengine/v1beta4/appengine-gen.go b/vendor/google.golang.org/api/appengine/v1beta4/appengine-gen.go
deleted file mode 100644
index 7c4ca946..00000000
--- a/vendor/google.golang.org/api/appengine/v1beta4/appengine-gen.go
+++ /dev/null
@@ -1,3083 +0,0 @@
-// Package appengine provides access to the Google App Engine Admin API.
-//
-// See https://developers.google.com/appengine/
-//
-// Usage example:
-//
-// import "google.golang.org/api/appengine/v1beta4"
-// ...
-// appengineService, err := appengine.New(oauthHttpClient)
-package appengine // import "google.golang.org/api/appengine/v1beta4"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "appengine:v1beta4"
-const apiName = "appengine"
-const apiVersion = "v1beta4"
-const basePath = "https://appengine.googleapis.com/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your data across Google Cloud Platform services
- CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Apps = NewAppsService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Apps *AppsService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewAppsService(s *Service) *AppsService {
- rs := &AppsService{s: s}
- rs.Modules = NewAppsModulesService(s)
- rs.Operations = NewAppsOperationsService(s)
- return rs
-}
-
-type AppsService struct {
- s *Service
-
- Modules *AppsModulesService
-
- Operations *AppsOperationsService
-}
-
-func NewAppsModulesService(s *Service) *AppsModulesService {
- rs := &AppsModulesService{s: s}
- rs.Versions = NewAppsModulesVersionsService(s)
- return rs
-}
-
-type AppsModulesService struct {
- s *Service
-
- Versions *AppsModulesVersionsService
-}
-
-func NewAppsModulesVersionsService(s *Service) *AppsModulesVersionsService {
- rs := &AppsModulesVersionsService{s: s}
- return rs
-}
-
-type AppsModulesVersionsService struct {
- s *Service
-}
-
-func NewAppsOperationsService(s *Service) *AppsOperationsService {
- rs := &AppsOperationsService{s: s}
- return rs
-}
-
-type AppsOperationsService struct {
- s *Service
-}
-
-// ApiConfigHandler: API Serving configuration for Cloud Endpoints.
-type ApiConfigHandler struct {
- // AuthFailAction: For users not logged in, how to handle access to
- // resources with required login. Defaults to "redirect".
- //
- // Possible values:
- // "AUTH_FAIL_ACTION_UNSPECIFIED"
- // "AUTH_FAIL_ACTION_REDIRECT"
- // "AUTH_FAIL_ACTION_UNAUTHORIZED"
- AuthFailAction string `json:"authFailAction,omitempty"`
-
- // Login: What level of login is required to access this resource.
- // Default is "optional".
- //
- // Possible values:
- // "LOGIN_UNSPECIFIED"
- // "LOGIN_OPTIONAL"
- // "LOGIN_ADMIN"
- // "LOGIN_REQUIRED"
- Login string `json:"login,omitempty"`
-
- // Script: Specifies the path to the script from the application root
- // directory.
- Script string `json:"script,omitempty"`
-
- // SecurityLevel: Configures whether security (HTTPS) should be enforced
- // for this URL.
- //
- // Possible values:
- // "SECURE_UNSPECIFIED"
- // "SECURE_DEFAULT"
- // "SECURE_NEVER"
- // "SECURE_OPTIONAL"
- // "SECURE_ALWAYS"
- SecurityLevel string `json:"securityLevel,omitempty"`
-
- // Url: URL to serve the endpoint at.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AuthFailAction") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ApiConfigHandler) MarshalJSON() ([]byte, error) {
- type noMethod ApiConfigHandler
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ApiEndpointHandler: Use Google Cloud Endpoints to handle requests.
-type ApiEndpointHandler struct {
- // ScriptPath: Specifies the path to the script from the application
- // root directory.
- ScriptPath string `json:"scriptPath,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ScriptPath") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ApiEndpointHandler) MarshalJSON() ([]byte, error) {
- type noMethod ApiEndpointHandler
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Application: An Application contains the top-level configuration of
-// an App Engine application.
-type Application struct {
- // CodeBucket: A Google Cloud Storage bucket which can be used for
- // storing files associated with an application. This bucket is
- // associated with the application and can be used by the gcloud
- // deployment commands. @OutputOnly
- CodeBucket string `json:"codeBucket,omitempty"`
-
- // DispatchRules: HTTP path dispatch rules for requests to the app that
- // do not explicitly target a module or version. The rules are
- // order-dependent.
- DispatchRules []*UrlDispatchRule `json:"dispatchRules,omitempty"`
-
- // Id: The relative name/path of the application. Example: "myapp".
- // @OutputOnly
- Id string `json:"id,omitempty"`
-
- // Location: The location from which the application will be run.
- // Choices are "us-central" for United States and "europe-west" for
- // European Union. Application instances will run out of data centers in
- // the chosen location and all of the application's End User Content
- // will be stored at rest in the chosen location. The default is
- // "us-central".
- Location string `json:"location,omitempty"`
-
- // Name: The full path to the application in the API. Example:
- // "apps/myapp". @OutputOnly
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CodeBucket") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Application) MarshalJSON() ([]byte, error) {
- type noMethod Application
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AutomaticScaling: Automatic scaling is the scaling policy that App
-// Engine has used since its inception. It is based on request rate,
-// response latencies, and other application metrics.
-type AutomaticScaling struct {
- // CoolDownPeriod: The amount of time that the
- // [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/)
- // should wait between changes to the number of virtual machines.
- // Applies only to the VM runtime.
- CoolDownPeriod string `json:"coolDownPeriod,omitempty"`
-
- // CpuUtilization: Target scaling by CPU usage.
- CpuUtilization *CpuUtilization `json:"cpuUtilization,omitempty"`
-
- // MaxConcurrentRequests: The number of concurrent requests an automatic
- // scaling instance can accept before the scheduler spawns a new
- // instance. Default value is chosen based on the runtime.
- MaxConcurrentRequests int64 `json:"maxConcurrentRequests,omitempty"`
-
- // MaxIdleInstances: The maximum number of idle instances that App
- // Engine should maintain for this version.
- MaxIdleInstances int64 `json:"maxIdleInstances,omitempty"`
-
- // MaxPendingLatency: The maximum amount of time that App Engine should
- // allow a request to wait in the pending queue before starting a new
- // instance to handle it.
- MaxPendingLatency string `json:"maxPendingLatency,omitempty"`
-
- // MaxTotalInstances: Max number of instances that App Engine should
- // start to handle requests.
- MaxTotalInstances int64 `json:"maxTotalInstances,omitempty"`
-
- // MinIdleInstances: The minimum number of idle instances that App
- // Engine should maintain for this version. Only applies to the default
- // version of a module, since other versions are not expected to receive
- // significant traffic.
- MinIdleInstances int64 `json:"minIdleInstances,omitempty"`
-
- // MinPendingLatency: The minimum amount of time that App Engine should
- // allow a request to wait in the pending queue before starting a new
- // instance to handle it.
- MinPendingLatency string `json:"minPendingLatency,omitempty"`
-
- // MinTotalInstances: Minimum number of instances that App Engine should
- // maintain.
- MinTotalInstances int64 `json:"minTotalInstances,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CoolDownPeriod") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AutomaticScaling) MarshalJSON() ([]byte, error) {
- type noMethod AutomaticScaling
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// BasicScaling: A module with basic scaling will create an instance
-// when the application receives a request. The instance will be turned
-// down when the app becomes idle. Basic scaling is ideal for work that
-// is intermittent or driven by user activity.
-type BasicScaling struct {
- // IdleTimeout: The instance will be shut down this amount of time after
- // receiving its last request.
- IdleTimeout string `json:"idleTimeout,omitempty"`
-
- // MaxInstances: The maximum number of instances for App Engine to
- // create for this version.
- MaxInstances int64 `json:"maxInstances,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "IdleTimeout") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BasicScaling) MarshalJSON() ([]byte, error) {
- type noMethod BasicScaling
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ContainerInfo: A Docker (container) image which should be used to
-// start the application.
-type ContainerInfo struct {
- // Image: Reference to a hosted container image. Must be a URI to a
- // resource in a Docker repository. Must be fully qualified, including
- // tag or digest. e.g. gcr.io/my-project/image:tag or
- // gcr.io/my-project/image@digest
- Image string `json:"image,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Image") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ContainerInfo) MarshalJSON() ([]byte, error) {
- type noMethod ContainerInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CpuUtilization: Target scaling by CPU usage.
-type CpuUtilization struct {
- // AggregationWindowLength: The period of time over which CPU
- // utilization is calculated.
- AggregationWindowLength string `json:"aggregationWindowLength,omitempty"`
-
- // TargetUtilization: Target (0-1) CPU utilization ratio to maintain
- // when scaling.
- TargetUtilization float64 `json:"targetUtilization,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "AggregationWindowLength") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CpuUtilization) MarshalJSON() ([]byte, error) {
- type noMethod CpuUtilization
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Deployment: Code and application artifacts used to deploy a version
-// to App Engine.
-type Deployment struct {
- // Container: If supplied, a docker (container) image which should be
- // used to start the application. Only applicable to the 'vm' runtime.
- Container *ContainerInfo `json:"container,omitempty"`
-
- // Files: A manifest of files stored in Google Cloud Storage which
- // should be included as part of this application. All files must be
- // readable using the credentials supplied with this call.
- Files map[string]FileInfo `json:"files,omitempty"`
-
- // SourceReferences: The origin of the source code for this deployment.
- // There can be more than one source reference per Version if source
- // code is distributed among multiple repositories.
- SourceReferences []*SourceReference `json:"sourceReferences,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Container") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Deployment) MarshalJSON() ([]byte, error) {
- type noMethod Deployment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ErrorHandler: A custom static error page to be served when an error
-// occurs.
-type ErrorHandler struct {
- // ErrorCode: The error condition this handler applies to.
- //
- // Possible values:
- // "ERROR_CODE_UNSPECIFIED"
- // "ERROR_CODE_DEFAULT"
- // "ERROR_CODE_OVER_QUOTA"
- // "ERROR_CODE_DOS_API_DENIAL"
- // "ERROR_CODE_TIMEOUT"
- ErrorCode string `json:"errorCode,omitempty"`
-
- // MimeType: MIME type of file. If unspecified, "text/html" is assumed.
- MimeType string `json:"mimeType,omitempty"`
-
- // StaticFile: Static file content to be served for this error.
- StaticFile string `json:"staticFile,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ErrorCode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ErrorHandler) MarshalJSON() ([]byte, error) {
- type noMethod ErrorHandler
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FileInfo: A single source file which is part of the application to be
-// deployed.
-type FileInfo struct {
- // MimeType: The MIME type of the file; if unspecified, the value from
- // Google Cloud Storage will be used.
- MimeType string `json:"mimeType,omitempty"`
-
- // Sha1Sum: The SHA1 (160 bits) hash of the file in hex.
- Sha1Sum string `json:"sha1Sum,omitempty"`
-
- // SourceUrl: The URL source to use to fetch this file. Must be a URL to
- // a resource in Google Cloud Storage.
- SourceUrl string `json:"sourceUrl,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "MimeType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FileInfo) MarshalJSON() ([]byte, error) {
- type noMethod FileInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// HealthCheck: Configure health checking for the VM instances.
-// Unhealthy VM instances will be killed and replaced with new
-// instances.
-type HealthCheck struct {
- // CheckInterval: The interval between health checks.
- CheckInterval string `json:"checkInterval,omitempty"`
-
- // DisableHealthCheck: Whether to explicitly disable health checks for
- // this instance.
- DisableHealthCheck bool `json:"disableHealthCheck,omitempty"`
-
- // HealthyThreshold: The number of consecutive successful health checks
- // before receiving traffic.
- HealthyThreshold int64 `json:"healthyThreshold,omitempty"`
-
- // Host: The host header to send when performing an HTTP health check
- // (e.g. myapp.appspot.com)
- Host string `json:"host,omitempty"`
-
- // RestartThreshold: The number of consecutive failed health checks
- // before an instance is restarted.
- RestartThreshold int64 `json:"restartThreshold,omitempty"`
-
- // Timeout: The amount of time before the health check is considered
- // failed.
- Timeout string `json:"timeout,omitempty"`
-
- // UnhealthyThreshold: The number of consecutive failed health checks
- // before removing traffic.
- UnhealthyThreshold int64 `json:"unhealthyThreshold,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CheckInterval") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *HealthCheck) MarshalJSON() ([]byte, error) {
- type noMethod HealthCheck
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Library: A Python runtime third-party library required by the
-// application.
-type Library struct {
- // Name: The name of the library, e.g. "PIL" or "django".
- Name string `json:"name,omitempty"`
-
- // Version: The version of the library to select, or "latest".
- Version string `json:"version,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Name") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Library) MarshalJSON() ([]byte, error) {
- type noMethod Library
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListModulesResponse: Response message for `Modules.ListModules`.
-type ListModulesResponse struct {
- // Modules: The modules belonging to the requested application.
- Modules []*Module `json:"modules,omitempty"`
-
- // NextPageToken: Continuation token for fetching the next page of
- // results.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Modules") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListModulesResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListModulesResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListOperationsResponse: The response message for
-// [Operations.ListOperations][google.longrunning.Operations.ListOperatio
-// ns].
-type ListOperationsResponse struct {
- // NextPageToken: The standard List next-page token.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Operations: A list of operations that matches the specified filter in
- // the request.
- Operations []*Operation `json:"operations,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "NextPageToken") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListOperationsResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListOperationsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListVersionsResponse: Response message for `Versions.ListVersions`.
-type ListVersionsResponse struct {
- // NextPageToken: Continuation token for fetching the next page of
- // results.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Versions: The versions belonging to the requested application module.
- Versions []*Version `json:"versions,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "NextPageToken") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListVersionsResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListVersionsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ManualScaling: A module with manual scaling runs continuously,
-// allowing you to perform complex initialization and rely on the state
-// of its memory over time.
-type ManualScaling struct {
- // Instances: The number of instances to assign to the module at the
- // start. This number can later be altered by using the [Modules
- // API](https://cloud.google.com/appengine/docs/python/modules/functions)
- // `set_num_instances()` function.
- Instances int64 `json:"instances,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Instances") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ManualScaling) MarshalJSON() ([]byte, error) {
- type noMethod ManualScaling
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Module: A module is a component of an application that provides a
-// single service or configuration. A module has a collection of
-// versions that define a specific set of code used to implement the
-// functionality of that module.
-type Module struct {
- // Id: The relative name/path of the module within the application.
- // Example: "default" @OutputOnly
- Id string `json:"id,omitempty"`
-
- // Name: The full path to the Module resource in the API. Example:
- // "apps/myapp/modules/default" @OutputOnly
- Name string `json:"name,omitempty"`
-
- // Split: A mapping that defines fractional HTTP traffic diversion to
- // different versions within the module.
- Split *TrafficSplit `json:"split,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Module) MarshalJSON() ([]byte, error) {
- type noMethod Module
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Network: Used to specify extra network settings (for VM runtimes
-// only).
-type Network struct {
- // ForwardedPorts: A list of ports (or port pairs) to forward from the
- // VM into the app container.
- ForwardedPorts []string `json:"forwardedPorts,omitempty"`
-
- // InstanceTag: A tag to apply to the VM instance during creation.
- InstanceTag string `json:"instanceTag,omitempty"`
-
- // Name: The Google Compute Engine network where the VMs will be
- // created. If not specified, or empty, the network named "default" will
- // be used. (The short name should be specified, not the resource path.)
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ForwardedPorts") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Network) MarshalJSON() ([]byte, error) {
- type noMethod Network
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Operation: This resource represents a long-running operation that is
-// the result of a network API call.
-type Operation struct {
- // Done: If the value is `false`, it means the operation is still in
- // progress. If true, the operation is completed, and either `error` or
- // `response` is available.
- Done bool `json:"done,omitempty"`
-
- // Error: The error result of the operation in case of failure.
- Error *Status `json:"error,omitempty"`
-
- // Metadata: Service-specific metadata associated with the operation. It
- // typically contains progress information and common metadata such as
- // create time. Some services might not provide such metadata. Any
- // method that returns a long-running operation should document the
- // metadata type, if any.
- Metadata OperationMetadata `json:"metadata,omitempty"`
-
- // Name: The server-assigned name, which is only unique within the same
- // service that originally returns it. If you use the default HTTP
- // mapping above, the `name` should have the format of
- // `operations/some/unique/name`.
- Name string `json:"name,omitempty"`
-
- // Response: The normal response of the operation in case of success. If
- // the original method returns no data on success, such as `Delete`, the
- // response is `google.protobuf.Empty`. If the original method is
- // standard `Get`/`Create`/`Update`, the response should be the
- // resource. For other methods, the response should have the type
- // `XxxResponse`, where `Xxx` is the original method name. For example,
- // if the original method name is `TakeSnapshot()`, the inferred
- // response type is `TakeSnapshotResponse`.
- Response OperationResponse `json:"response,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Done") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Operation) MarshalJSON() ([]byte, error) {
- type noMethod Operation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationMetadata interface{}
-
-type OperationResponse interface{}
-
-// OperationMetadata1: Metadata for the given
-// [google.longrunning.Operation][google.longrunning.Operation].
-type OperationMetadata1 struct {
- // EndTime: Timestamp that this operation was completed. (Not present if
- // the operation is still in progress.) @OutputOnly
- EndTime string `json:"endTime,omitempty"`
-
- // InsertTime: Timestamp that this operation was received. @OutputOnly
- InsertTime string `json:"insertTime,omitempty"`
-
- // Method: API method name that initiated the operation. Example:
- // "google.appengine.v1beta4.Version.CreateVersion". @OutputOnly
- Method string `json:"method,omitempty"`
-
- // OperationType: The type of the operation (deprecated, use method
- // field instead). Example: "create_version". @OutputOnly
- OperationType string `json:"operationType,omitempty"`
-
- // Target: Resource that this operation is acting on. Example:
- // "apps/myapp/modules/default". @OutputOnly
- Target string `json:"target,omitempty"`
-
- // User: The user who requested this operation. @OutputOnly
- User string `json:"user,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "EndTime") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationMetadata1) MarshalJSON() ([]byte, error) {
- type noMethod OperationMetadata1
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Resources: Used to specify how many machine resources an app version
-// needs.
-type Resources struct {
- // Cpu: How many CPU cores an app version needs.
- Cpu float64 `json:"cpu,omitempty"`
-
- // DiskGb: How much disk size, in GB, an app version needs.
- DiskGb float64 `json:"diskGb,omitempty"`
-
- // MemoryGb: How much memory, in GB, an app version needs.
- MemoryGb float64 `json:"memoryGb,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Cpu") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Resources) MarshalJSON() ([]byte, error) {
- type noMethod Resources
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ScriptHandler: Executes a script to handle the request that matches
-// the URL pattern.
-type ScriptHandler struct {
- // ScriptPath: Specifies the path to the script from the application
- // root directory.
- ScriptPath string `json:"scriptPath,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ScriptPath") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ScriptHandler) MarshalJSON() ([]byte, error) {
- type noMethod ScriptHandler
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SourceReference: A reference to a particular snapshot of the source
-// tree used to build and deploy the application.
-type SourceReference struct {
- // Repository: Optional. A URI string identifying the repository.
- // Example: "https://source.developers.google.com/p/app-123/r/default"
- Repository string `json:"repository,omitempty"`
-
- // RevisionId: The canonical (and persistent) identifier of the deployed
- // revision, i.e. any kind of aliases including tags or branch names are
- // not allowed. Example (git):
- // "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
- RevisionId string `json:"revisionId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Repository") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SourceReference) MarshalJSON() ([]byte, error) {
- type noMethod SourceReference
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// StaticDirectoryHandler: Files served directly to the user for a given
-// URL, such as images, CSS stylesheets, or JavaScript source files.
-// Static directory handlers make it easy to serve the entire contents
-// of a directory as static files.
-type StaticDirectoryHandler struct {
- // ApplicationReadable: By default, files declared in static file
- // handlers are uploaded as static data and are only served to end
- // users, they cannot be read by an application. If this field is set to
- // true, the files are also uploaded as code data so your application
- // can read them. Both uploads are charged against your code and static
- // data storage resource quotas.
- ApplicationReadable bool `json:"applicationReadable,omitempty"`
-
- // Directory: The path to the directory containing the static files,
- // from the application root directory. Everything after the end of the
- // matched url pattern is appended to static_dir to form the full path
- // to the requested file.
- Directory string `json:"directory,omitempty"`
-
- // Expiration: The length of time a static file served by this handler
- // ought to be cached by web proxies and browsers.
- Expiration string `json:"expiration,omitempty"`
-
- // HttpHeaders: HTTP headers to use for all responses from these URLs.
- HttpHeaders map[string]string `json:"httpHeaders,omitempty"`
-
- // MimeType: If specified, all files served by this handler will be
- // served using the specified MIME type. If not specified, the MIME type
- // for a file will be derived from the file's filename extension.
- MimeType string `json:"mimeType,omitempty"`
-
- // RequireMatchingFile: If true, this UrlMap entry does not match the
- // request unless the file referenced by the handler also exists. If no
- // such file exists, processing will continue with the next UrlMap that
- // matches the requested URL.
- RequireMatchingFile bool `json:"requireMatchingFile,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ApplicationReadable")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *StaticDirectoryHandler) MarshalJSON() ([]byte, error) {
- type noMethod StaticDirectoryHandler
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// StaticFilesHandler: Files served directly to the user for a given
-// URL, such as images, CSS stylesheets, or JavaScript source files.
-// Static file handlers describe which files in the application
-// directory are static files, and which URLs serve them.
-type StaticFilesHandler struct {
- // ApplicationReadable: By default, files declared in static file
- // handlers are uploaded as static data and are only served to end
- // users, they cannot be read by an application. If this field is set to
- // true, the files are also uploaded as code data so your application
- // can read them. Both uploads are charged against your code and static
- // data storage resource quotas.
- ApplicationReadable bool `json:"applicationReadable,omitempty"`
-
- // Expiration: The length of time a static file served by this handler
- // ought to be cached by web proxies and browsers.
- Expiration string `json:"expiration,omitempty"`
-
- // HttpHeaders: HTTP headers to use for all responses from these URLs.
- HttpHeaders map[string]string `json:"httpHeaders,omitempty"`
-
- // MimeType: If specified, all files served by this handler will be
- // served using the specified MIME type. If not specified, the MIME type
- // for a file will be derived from the file's filename extension.
- MimeType string `json:"mimeType,omitempty"`
-
- // Path: The path to the static files matched by the URL pattern, from
- // the application root directory. The path can refer to text matched in
- // groupings in the URL pattern.
- Path string `json:"path,omitempty"`
-
- // RequireMatchingFile: If true, this
- // [UrlMap][google.appengine.v1beta4.UrlMap] entry does not match the
- // request unless the file referenced by the handler also exists. If no
- // such file exists, processing will continue with the next
- // [UrlMap][google.appengine.v1beta4.UrlMap] that matches the requested
- // URL.
- RequireMatchingFile bool `json:"requireMatchingFile,omitempty"`
-
- // UploadPathRegex: A regular expression that matches the file paths for
- // all files that will be referenced by this handler.
- UploadPathRegex string `json:"uploadPathRegex,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ApplicationReadable")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *StaticFilesHandler) MarshalJSON() ([]byte, error) {
- type noMethod StaticFilesHandler
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Status: The `Status` type defines a logical error model that is
-// suitable for different programming environments, including REST APIs
-// and RPC APIs. It is used by [gRPC](https://github.com/grpc). The
-// error model is designed to be: - Simple to use and understand for
-// most users - Flexible enough to meet unexpected needs # Overview The
-// `Status` message contains three pieces of data: error code, error
-// message, and error details. The error code should be an enum value of
-// [google.rpc.Code][google.rpc.Code], but it may accept additional
-// error codes if needed. The error message should be a developer-facing
-// English message that helps developers *understand* and *resolve* the
-// error. If a localized user-facing error message is needed, put the
-// localized message in the error details or localize it in the client.
-// The optional error details may contain arbitrary information about
-// the error. There is a predefined set of error detail types in the
-// package `google.rpc` which can be used for common error conditions. #
-// Language mapping The `Status` message is the logical representation
-// of the error model, but it is not necessarily the actual wire format.
-// When the `Status` message is exposed in different client libraries
-// and different wire protocols, it can be mapped differently. For
-// example, it will likely be mapped to some exceptions in Java, but
-// more likely mapped to some error codes in C. # Other uses The error
-// model and the `Status` message can be used in a variety of
-// environments, either with or without APIs, to provide a consistent
-// developer experience across different environments. Example uses of
-// this error model include: - Partial errors. If a service needs to
-// return partial errors to the client, it may embed the `Status` in the
-// normal response to indicate the partial errors. - Workflow errors. A
-// typical workflow has multiple steps. Each step may have a `Status`
-// message for error reporting purpose. - Batch operations. If a client
-// uses batch request and batch response, the `Status` message should be
-// used directly inside batch response, one for each error sub-response.
-// - Asynchronous operations. If an API call embeds asynchronous
-// operation results in its response, the status of those operations
-// should be represented directly using the `Status` message. - Logging.
-// If some API errors are stored in logs, the message `Status` could be
-// used directly after any stripping needed for security/privacy
-// reasons.
-type Status struct {
- // Code: The status code, which should be an enum value of
- // [google.rpc.Code][google.rpc.Code].
- Code int64 `json:"code,omitempty"`
-
- // Details: A list of messages that carry the error details. There will
- // be a common set of message types for APIs to use.
- Details []StatusDetails `json:"details,omitempty"`
-
- // Message: A developer-facing error message, which should be in
- // English. Any user-facing error message should be localized and sent
- // in the [google.rpc.Status.details][google.rpc.Status.details] field,
- // or localized by the client.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Status) MarshalJSON() ([]byte, error) {
- type noMethod Status
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type StatusDetails interface{}
-
-// TrafficSplit: Configuration for traffic splitting for versions within
-// a single module. Traffic splitting allows traffic directed to the
-// module to be assigned to one of several versions in a fractional way,
-// enabling experiments and canarying new builds, for example.
-type TrafficSplit struct {
- // Allocations: Mapping from module version IDs within the module to
- // fractional (0.000, 1] allocations of traffic for that version. Each
- // version may only be specified once, but some versions in the module
- // may not have any traffic allocation. Modules that have traffic
- // allocated in this field may not be deleted until the module is
- // deleted, or their traffic allocation is removed. Allocations must sum
- // to 1. Supports precision up to two decimal places for IP-based splits
- // and up to three decimal places for cookie-based splits.
- Allocations *TrafficSplitAllocations `json:"allocations,omitempty"`
-
- // ShardBy: Which mechanism should be used as a selector when choosing a
- // version to send a request to. The traffic selection algorithm will be
- // stable for either type until allocations are changed.
- //
- // Possible values:
- // "UNSPECIFIED"
- // "COOKIE"
- // "IP"
- ShardBy string `json:"shardBy,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Allocations") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TrafficSplit) MarshalJSON() ([]byte, error) {
- type noMethod TrafficSplit
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TrafficSplitAllocations: Mapping from module version IDs within the
-// module to fractional (0.000, 1] allocations of traffic for that
-// version. Each version may only be specified once, but some versions
-// in the module may not have any traffic allocation. Modules that have
-// traffic allocated in this field may not be deleted until the module
-// is deleted, or their traffic allocation is removed. Allocations must
-// sum to 1. Supports precision up to two decimal places for IP-based
-// splits and up to three decimal places for cookie-based splits.
-type TrafficSplitAllocations struct {
-}
-
-// UrlDispatchRule: Rules to match an HTTP request and dispatch that
-// request to a module.
-type UrlDispatchRule struct {
- // Domain: The domain name to match on. Supports '*' (glob) wildcarding
- // on the left-hand side of a '.'. If empty, all domains will be matched
- // (the same as '*').
- Domain string `json:"domain,omitempty"`
-
- // Module: The resource id of a Module in this application that should
- // service the matched request. The Module must already exist. Example:
- // "default".
- Module string `json:"module,omitempty"`
-
- // Path: The pathname within the host. This must start with a '/'. A
- // single '*' (glob) can be included at the end of the path. The sum of
- // the lengths of the domain and path may not exceed 100 characters.
- Path string `json:"path,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Domain") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlDispatchRule) MarshalJSON() ([]byte, error) {
- type noMethod UrlDispatchRule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UrlMap: A URL pattern and description of how it should be handled.
-// App Engine can handle URLs by executing application code, or by
-// serving static files uploaded with the code, such as images, CSS or
-// JavaScript.
-type UrlMap struct {
- // ApiEndpoint: Use API Endpoints to handle requests.
- ApiEndpoint *ApiEndpointHandler `json:"apiEndpoint,omitempty"`
-
- // AuthFailAction: For users not logged in, how to handle access to
- // resources with required login. Defaults to "redirect".
- //
- // Possible values:
- // "AUTH_FAIL_ACTION_UNSPECIFIED"
- // "AUTH_FAIL_ACTION_REDIRECT"
- // "AUTH_FAIL_ACTION_UNAUTHORIZED"
- AuthFailAction string `json:"authFailAction,omitempty"`
-
- // Login: What level of login is required to access this resource.
- //
- // Possible values:
- // "LOGIN_UNSPECIFIED"
- // "LOGIN_OPTIONAL"
- // "LOGIN_ADMIN"
- // "LOGIN_REQUIRED"
- Login string `json:"login,omitempty"`
-
- // RedirectHttpResponseCode: `30x` code to use when performing redirects
- // for the `secure` field. A `302` is used by default.
- //
- // Possible values:
- // "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED"
- // "REDIRECT_HTTP_RESPONSE_CODE_301"
- // "REDIRECT_HTTP_RESPONSE_CODE_302"
- // "REDIRECT_HTTP_RESPONSE_CODE_303"
- // "REDIRECT_HTTP_RESPONSE_CODE_307"
- RedirectHttpResponseCode string `json:"redirectHttpResponseCode,omitempty"`
-
- // Script: Executes a script to handle the request that matches the URL
- // pattern.
- Script *ScriptHandler `json:"script,omitempty"`
-
- // SecurityLevel: Configures whether security (HTTPS) should be enforced
- // for this URL.
- //
- // Possible values:
- // "SECURE_UNSPECIFIED"
- // "SECURE_DEFAULT"
- // "SECURE_NEVER"
- // "SECURE_OPTIONAL"
- // "SECURE_ALWAYS"
- SecurityLevel string `json:"securityLevel,omitempty"`
-
- // StaticDirectory: Serves the entire contents of a directory as static
- // files. This attribute is deprecated. You can mimic the behavior of
- // static directories using static files.
- StaticDirectory *StaticDirectoryHandler `json:"staticDirectory,omitempty"`
-
- // StaticFiles: Returns the contents of a file, such as an image, as the
- // response.
- StaticFiles *StaticFilesHandler `json:"staticFiles,omitempty"`
-
- // UrlRegex: A URL prefix. This value uses regular expression syntax
- // (and so regexp special characters must be escaped), but it should not
- // contain groupings. All URLs that begin with this prefix are handled
- // by this handler, using the portion of the URL after the prefix as
- // part of the file path. This is always required.
- UrlRegex string `json:"urlRegex,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ApiEndpoint") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlMap) MarshalJSON() ([]byte, error) {
- type noMethod UrlMap
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Version: A Version is a specific set of source code and configuration
-// files deployed to a module.
-type Version struct {
- // ApiConfig: Serving configuration for Google Cloud Endpoints. Only
- // returned in `GET` requests if `view=FULL` is set. May only be set on
- // create requests; once created, is immutable.
- ApiConfig *ApiConfigHandler `json:"apiConfig,omitempty"`
-
- // AutomaticScaling: Automatic scaling is the scaling policy that App
- // Engine has used since its inception. It is based on request rate,
- // response latencies, and other application metrics.
- AutomaticScaling *AutomaticScaling `json:"automaticScaling,omitempty"`
-
- // BasicScaling: A module with basic scaling will create an instance
- // when the application receives a request. The instance will be turned
- // down when the app becomes idle. Basic scaling is ideal for work that
- // is intermittent or driven by user activity.
- BasicScaling *BasicScaling `json:"basicScaling,omitempty"`
-
- // BetaSettings: Beta settings supplied to the application via metadata.
- BetaSettings map[string]string `json:"betaSettings,omitempty"`
-
- // CreationTime: Creation time of this version. This will be between the
- // start and end times of the operation that creates this version.
- // @OutputOnly
- CreationTime string `json:"creationTime,omitempty"`
-
- // DefaultExpiration: The length of time a static file served by a
- // static file handler ought to be cached by web proxies and browsers,
- // if the handler does not specify its own expiration. Only returned in
- // `GET` requests if `view=FULL` is set. May only be set on create
- // requests; once created, is immutable.
- DefaultExpiration string `json:"defaultExpiration,omitempty"`
-
- // Deployer: The email address of the user who created this version.
- // @OutputOnly
- Deployer string `json:"deployer,omitempty"`
-
- // Deployment: Code and application artifacts that make up this version.
- // Only returned in `GET` requests if `view=FULL` is set. May only be
- // set on create requests; once created, is immutable.
- Deployment *Deployment `json:"deployment,omitempty"`
-
- // Env: The App Engine execution environment to use for this version.
- // Default: "1"
- Env string `json:"env,omitempty"`
-
- // EnvVariables: Environment variables made available to the
- // application. Only returned in `GET` requests if `view=FULL` is set.
- // May only be set on create requests; once created, is immutable.
- EnvVariables map[string]string `json:"envVariables,omitempty"`
-
- // ErrorHandlers: Custom static error pages instead of these generic
- // error pages, (limit 10 KB/page) Only returned in `GET` requests if
- // `view=FULL` is set. May only be set on create requests; once created,
- // is immutable.
- ErrorHandlers []*ErrorHandler `json:"errorHandlers,omitempty"`
-
- // Handlers: An ordered list of URL Matching patterns that should be
- // applied to incoming requests. The first matching URL consumes the
- // request, and subsequent handlers are not attempted. Only returned in
- // `GET` requests if `view=FULL` is set. May only be set on create
- // requests; once created, is immutable.
- Handlers []*UrlMap `json:"handlers,omitempty"`
-
- // HealthCheck: Configure health checking for the VM instances.
- // Unhealthy VM instances will be stopped and replaced with new
- // instances. Only returned in `GET` requests if `view=FULL` is set. May
- // only be set on create requests; once created, is immutable.
- HealthCheck *HealthCheck `json:"healthCheck,omitempty"`
-
- // Id: The relative name/path of the Version within the module. Example:
- // "v1". Version specifiers can contain lowercase letters, digits, and
- // hyphens. It cannot begin with the prefix `ah-` and the names
- // `default` and `latest` are reserved and cannot be used.
- Id string `json:"id,omitempty"`
-
- // InboundServices: Before an application can receive email or XMPP
- // messages, the application must be configured to enable the service.
- //
- // Possible values:
- // "INBOUND_SERVICE_UNSPECIFIED" - Not specified.
- // "INBOUND_SERVICE_MAIL" - Allows an application to receive mail.
- // "INBOUND_SERVICE_MAIL_BOUNCE" - Allows an application receive email
- // bound notifications.
- // "INBOUND_SERVICE_XMPP_ERROR" - Allows an application to receive
- // error stanzas.
- // "INBOUND_SERVICE_XMPP_MESSAGE" - Allows an application to receive
- // instant messages.
- // "INBOUND_SERVICE_XMPP_SUBSCRIBE" - Allows an application to receive
- // user subscription POSTs.
- // "INBOUND_SERVICE_XMPP_PRESENCE" - Allows an application to receive
- // a user's chat presence.
- // "INBOUND_SERVICE_CHANNEL_PRESENCE" - Registers an application for
- // notifications when a client connects or disconnects from a channel.
- // "INBOUND_SERVICE_WARMUP" - Enables warmup requests.
- InboundServices []string `json:"inboundServices,omitempty"`
-
- // InstanceClass: The frontend instance class to use to run this app.
- // Valid values are `[F1, F2, F4, F4_1G]`. Default: "F1"
- InstanceClass string `json:"instanceClass,omitempty"`
-
- // Libraries: Configuration for Python runtime third-party libraries
- // required by the application. Only returned in `GET` requests if
- // `view=FULL` is set. May only be set on create requests; once created,
- // is immutable.
- Libraries []*Library `json:"libraries,omitempty"`
-
- // ManualScaling: A module with manual scaling runs continuously,
- // allowing you to perform complex initialization and rely on the state
- // of its memory over time.
- ManualScaling *ManualScaling `json:"manualScaling,omitempty"`
-
- // Name: The full path to the Version resource in the API. Example:
- // "apps/myapp/modules/default/versions/v1". @OutputOnly
- Name string `json:"name,omitempty"`
-
- // Network: Used to specify extra network settings (for VM runtimes
- // only).
- Network *Network `json:"network,omitempty"`
-
- // NobuildFilesRegex: Go only. Files that match this pattern will not be
- // built into the app. May only be set on create requests.
- NobuildFilesRegex string `json:"nobuildFilesRegex,omitempty"`
-
- // Resources: Used to specify how many machine resources an app version
- // needs (for VM runtimes only).
- Resources *Resources `json:"resources,omitempty"`
-
- // Runtime: The desired runtime. Values can include python27, java7, go,
- // etc.
- Runtime string `json:"runtime,omitempty"`
-
- // ServingStatus: The current serving status of this version. Only
- // `SERVING` versions will have instances created or billed for. If this
- // field is unset when a version is created, `SERVING` status will be
- // assumed. It is an error to explicitly set this field to
- // `SERVING_STATUS_UNSPECIFIED`.
- //
- // Possible values:
- // "SERVING_STATUS_UNSPECIFIED"
- // "SERVING"
- // "STOPPED"
- ServingStatus string `json:"servingStatus,omitempty"`
-
- // Threadsafe: If true, multiple requests can be dispatched to the app
- // at once.
- Threadsafe bool `json:"threadsafe,omitempty"`
-
- // Vm: Whether to deploy this app in a VM container (deprecated, use
- // "env":"2").
- Vm bool `json:"vm,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ApiConfig") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Version) MarshalJSON() ([]byte, error) {
- type noMethod Version
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "appengine.apps.get":
-
-type AppsGetCall struct {
- s *Service
- appsId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets information about an application.
-func (r *AppsService) Get(appsId string) *AppsGetCall {
- c := &AppsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.appsId = appsId
- return c
-}
-
-// EnsureResourcesExist sets the optional parameter
-// "ensureResourcesExist": Certain resources associated with an
-// application are created on-demand. Controls whether these resources
-// should be created when performing the `GET` operation. If specified
-// and any resources cloud not be created, the request will fail with an
-// error code.
-func (c *AppsGetCall) EnsureResourcesExist(ensureResourcesExist bool) *AppsGetCall {
- c.opt_["ensureResourcesExist"] = ensureResourcesExist
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AppsGetCall) Fields(s ...googleapi.Field) *AppsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AppsGetCall) IfNoneMatch(entityTag string) *AppsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AppsGetCall) Context(ctx context.Context) *AppsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AppsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["ensureResourcesExist"]; ok {
- params.Set("ensureResourcesExist", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta4/apps/{appsId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "appsId": c.appsId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "appengine.apps.get" call.
-// Exactly one of *Application or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Application.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AppsGetCall) Do() (*Application, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Application{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets information about an application.",
- // "httpMethod": "GET",
- // "id": "appengine.apps.get",
- // "parameterOrder": [
- // "appsId"
- // ],
- // "parameters": {
- // "appsId": {
- // "description": "Part of `name`. Name of the application to get. For example: \"apps/myapp\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "ensureResourcesExist": {
- // "description": "Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the `GET` operation. If specified and any resources cloud not be created, the request will fail with an error code.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "v1beta4/apps/{appsId}",
- // "response": {
- // "$ref": "Application"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "appengine.apps.modules.delete":
-
-type AppsModulesDeleteCall struct {
- s *Service
- appsId string
- modulesId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes a module and all enclosed versions.
-func (r *AppsModulesService) Delete(appsId string, modulesId string) *AppsModulesDeleteCall {
- c := &AppsModulesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.appsId = appsId
- c.modulesId = modulesId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AppsModulesDeleteCall) Fields(s ...googleapi.Field) *AppsModulesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AppsModulesDeleteCall) Context(ctx context.Context) *AppsModulesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AppsModulesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta4/apps/{appsId}/modules/{modulesId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "appsId": c.appsId,
- "modulesId": c.modulesId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "appengine.apps.modules.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AppsModulesDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes a module and all enclosed versions.",
- // "httpMethod": "DELETE",
- // "id": "appengine.apps.modules.delete",
- // "parameterOrder": [
- // "appsId",
- // "modulesId"
- // ],
- // "parameters": {
- // "appsId": {
- // "description": "Part of `name`. Name of the resource requested. For example: \"apps/myapp/modules/default\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "modulesId": {
- // "description": "Part of `name`. See documentation of `appsId`.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "appengine.apps.modules.get":
-
-type AppsModulesGetCall struct {
- s *Service
- appsId string
- modulesId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets the current configuration of the module.
-func (r *AppsModulesService) Get(appsId string, modulesId string) *AppsModulesGetCall {
- c := &AppsModulesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.appsId = appsId
- c.modulesId = modulesId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AppsModulesGetCall) Fields(s ...googleapi.Field) *AppsModulesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AppsModulesGetCall) IfNoneMatch(entityTag string) *AppsModulesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AppsModulesGetCall) Context(ctx context.Context) *AppsModulesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AppsModulesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta4/apps/{appsId}/modules/{modulesId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "appsId": c.appsId,
- "modulesId": c.modulesId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "appengine.apps.modules.get" call.
-// Exactly one of *Module or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Module.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AppsModulesGetCall) Do() (*Module, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Module{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the current configuration of the module.",
- // "httpMethod": "GET",
- // "id": "appengine.apps.modules.get",
- // "parameterOrder": [
- // "appsId",
- // "modulesId"
- // ],
- // "parameters": {
- // "appsId": {
- // "description": "Part of `name`. Name of the resource requested. For example: \"apps/myapp/modules/default\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "modulesId": {
- // "description": "Part of `name`. See documentation of `appsId`.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
- // "response": {
- // "$ref": "Module"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "appengine.apps.modules.list":
-
-type AppsModulesListCall struct {
- s *Service
- appsId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all the modules in the application.
-func (r *AppsModulesService) List(appsId string) *AppsModulesListCall {
- c := &AppsModulesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.appsId = appsId
- return c
-}
-
-// PageSize sets the optional parameter "pageSize": Maximum results to
-// return per page.
-func (c *AppsModulesListCall) PageSize(pageSize int64) *AppsModulesListCall {
- c.opt_["pageSize"] = pageSize
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Continuation token
-// for fetching the next page of results.
-func (c *AppsModulesListCall) PageToken(pageToken string) *AppsModulesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AppsModulesListCall) Fields(s ...googleapi.Field) *AppsModulesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AppsModulesListCall) IfNoneMatch(entityTag string) *AppsModulesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AppsModulesListCall) Context(ctx context.Context) *AppsModulesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AppsModulesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["pageSize"]; ok {
- params.Set("pageSize", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta4/apps/{appsId}/modules")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "appsId": c.appsId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "appengine.apps.modules.list" call.
-// Exactly one of *ListModulesResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ListModulesResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AppsModulesListCall) Do() (*ListModulesResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ListModulesResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all the modules in the application.",
- // "httpMethod": "GET",
- // "id": "appengine.apps.modules.list",
- // "parameterOrder": [
- // "appsId"
- // ],
- // "parameters": {
- // "appsId": {
- // "description": "Part of `name`. Name of the resource requested. For example: \"apps/myapp\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "pageSize": {
- // "description": "Maximum results to return per page.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Continuation token for fetching the next page of results.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "v1beta4/apps/{appsId}/modules",
- // "response": {
- // "$ref": "ListModulesResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "appengine.apps.modules.patch":
-
-type AppsModulesPatchCall struct {
- s *Service
- appsId string
- modulesId string
- module *Module
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates the configuration of the specified module.
-func (r *AppsModulesService) Patch(appsId string, modulesId string, module *Module) *AppsModulesPatchCall {
- c := &AppsModulesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.appsId = appsId
- c.modulesId = modulesId
- c.module = module
- return c
-}
-
-// Mask sets the optional parameter "mask": Standard field mask for the
-// set of fields to be updated.
-func (c *AppsModulesPatchCall) Mask(mask string) *AppsModulesPatchCall {
- c.opt_["mask"] = mask
- return c
-}
-
-// MigrateTraffic sets the optional parameter "migrateTraffic": Whether
-// to use Traffic Migration to shift traffic gradually. Traffic can only
-// be migrated from a single version to another single version.
-func (c *AppsModulesPatchCall) MigrateTraffic(migrateTraffic bool) *AppsModulesPatchCall {
- c.opt_["migrateTraffic"] = migrateTraffic
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AppsModulesPatchCall) Fields(s ...googleapi.Field) *AppsModulesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AppsModulesPatchCall) Context(ctx context.Context) *AppsModulesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AppsModulesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.module)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["mask"]; ok {
- params.Set("mask", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["migrateTraffic"]; ok {
- params.Set("migrateTraffic", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta4/apps/{appsId}/modules/{modulesId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "appsId": c.appsId,
- "modulesId": c.modulesId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "appengine.apps.modules.patch" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AppsModulesPatchCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates the configuration of the specified module.",
- // "httpMethod": "PATCH",
- // "id": "appengine.apps.modules.patch",
- // "parameterOrder": [
- // "appsId",
- // "modulesId"
- // ],
- // "parameters": {
- // "appsId": {
- // "description": "Part of `name`. Name of the resource to update. For example: \"apps/myapp/modules/default\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "mask": {
- // "description": "Standard field mask for the set of fields to be updated.",
- // "location": "query",
- // "type": "string"
- // },
- // "migrateTraffic": {
- // "description": "Whether to use Traffic Migration to shift traffic gradually. Traffic can only be migrated from a single version to another single version.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "modulesId": {
- // "description": "Part of `name`. See documentation of `appsId`.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
- // "request": {
- // "$ref": "Module"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "appengine.apps.modules.versions.create":
-
-type AppsModulesVersionsCreateCall struct {
- s *Service
- appsId string
- modulesId string
- version *Version
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Create: Deploys new code and resource files to a version.
-func (r *AppsModulesVersionsService) Create(appsId string, modulesId string, version *Version) *AppsModulesVersionsCreateCall {
- c := &AppsModulesVersionsCreateCall{s: r.s, opt_: make(map[string]interface{})}
- c.appsId = appsId
- c.modulesId = modulesId
- c.version = version
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AppsModulesVersionsCreateCall) Fields(s ...googleapi.Field) *AppsModulesVersionsCreateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AppsModulesVersionsCreateCall) Context(ctx context.Context) *AppsModulesVersionsCreateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AppsModulesVersionsCreateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.version)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta4/apps/{appsId}/modules/{modulesId}/versions")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "appsId": c.appsId,
- "modulesId": c.modulesId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "appengine.apps.modules.versions.create" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AppsModulesVersionsCreateCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deploys new code and resource files to a version.",
- // "httpMethod": "POST",
- // "id": "appengine.apps.modules.versions.create",
- // "parameterOrder": [
- // "appsId",
- // "modulesId"
- // ],
- // "parameters": {
- // "appsId": {
- // "description": "Part of `name`. Name of the resource to update. For example: \"apps/myapp/modules/default\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "modulesId": {
- // "description": "Part of `name`. See documentation of `appsId`.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
- // "request": {
- // "$ref": "Version"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "appengine.apps.modules.versions.delete":
-
-type AppsModulesVersionsDeleteCall struct {
- s *Service
- appsId string
- modulesId string
- versionsId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an existing version.
-func (r *AppsModulesVersionsService) Delete(appsId string, modulesId string, versionsId string) *AppsModulesVersionsDeleteCall {
- c := &AppsModulesVersionsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.appsId = appsId
- c.modulesId = modulesId
- c.versionsId = versionsId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AppsModulesVersionsDeleteCall) Fields(s ...googleapi.Field) *AppsModulesVersionsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AppsModulesVersionsDeleteCall) Context(ctx context.Context) *AppsModulesVersionsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AppsModulesVersionsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "appsId": c.appsId,
- "modulesId": c.modulesId,
- "versionsId": c.versionsId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "appengine.apps.modules.versions.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AppsModulesVersionsDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes an existing version.",
- // "httpMethod": "DELETE",
- // "id": "appengine.apps.modules.versions.delete",
- // "parameterOrder": [
- // "appsId",
- // "modulesId",
- // "versionsId"
- // ],
- // "parameters": {
- // "appsId": {
- // "description": "Part of `name`. Name of the resource requested. For example: \"apps/myapp/modules/default/versions/v1\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "modulesId": {
- // "description": "Part of `name`. See documentation of `appsId`.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "versionsId": {
- // "description": "Part of `name`. See documentation of `appsId`.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "appengine.apps.modules.versions.get":
-
-type AppsModulesVersionsGetCall struct {
- s *Service
- appsId string
- modulesId string
- versionsId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets application deployment information.
-func (r *AppsModulesVersionsService) Get(appsId string, modulesId string, versionsId string) *AppsModulesVersionsGetCall {
- c := &AppsModulesVersionsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.appsId = appsId
- c.modulesId = modulesId
- c.versionsId = versionsId
- return c
-}
-
-// View sets the optional parameter "view": Controls the set of fields
-// returned in the `Get` response.
-//
-// Possible values:
-// "BASIC"
-// "FULL"
-func (c *AppsModulesVersionsGetCall) View(view string) *AppsModulesVersionsGetCall {
- c.opt_["view"] = view
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AppsModulesVersionsGetCall) Fields(s ...googleapi.Field) *AppsModulesVersionsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AppsModulesVersionsGetCall) IfNoneMatch(entityTag string) *AppsModulesVersionsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AppsModulesVersionsGetCall) Context(ctx context.Context) *AppsModulesVersionsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AppsModulesVersionsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["view"]; ok {
- params.Set("view", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "appsId": c.appsId,
- "modulesId": c.modulesId,
- "versionsId": c.versionsId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "appengine.apps.modules.versions.get" call.
-// Exactly one of *Version or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Version.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AppsModulesVersionsGetCall) Do() (*Version, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Version{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets application deployment information.",
- // "httpMethod": "GET",
- // "id": "appengine.apps.modules.versions.get",
- // "parameterOrder": [
- // "appsId",
- // "modulesId",
- // "versionsId"
- // ],
- // "parameters": {
- // "appsId": {
- // "description": "Part of `name`. Name of the resource requested. For example: \"apps/myapp/modules/default/versions/v1\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "modulesId": {
- // "description": "Part of `name`. See documentation of `appsId`.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "versionsId": {
- // "description": "Part of `name`. See documentation of `appsId`.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "view": {
- // "description": "Controls the set of fields returned in the `Get` response.",
- // "enum": [
- // "BASIC",
- // "FULL"
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
- // "response": {
- // "$ref": "Version"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "appengine.apps.modules.versions.list":
-
-type AppsModulesVersionsListCall struct {
- s *Service
- appsId string
- modulesId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists the versions of a module.
-func (r *AppsModulesVersionsService) List(appsId string, modulesId string) *AppsModulesVersionsListCall {
- c := &AppsModulesVersionsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.appsId = appsId
- c.modulesId = modulesId
- return c
-}
-
-// PageSize sets the optional parameter "pageSize": Maximum results to
-// return per page.
-func (c *AppsModulesVersionsListCall) PageSize(pageSize int64) *AppsModulesVersionsListCall {
- c.opt_["pageSize"] = pageSize
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Continuation token
-// for fetching the next page of results.
-func (c *AppsModulesVersionsListCall) PageToken(pageToken string) *AppsModulesVersionsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// View sets the optional parameter "view": Controls the set of fields
-// returned in the `List` response.
-//
-// Possible values:
-// "BASIC"
-// "FULL"
-func (c *AppsModulesVersionsListCall) View(view string) *AppsModulesVersionsListCall {
- c.opt_["view"] = view
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AppsModulesVersionsListCall) Fields(s ...googleapi.Field) *AppsModulesVersionsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AppsModulesVersionsListCall) IfNoneMatch(entityTag string) *AppsModulesVersionsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AppsModulesVersionsListCall) Context(ctx context.Context) *AppsModulesVersionsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AppsModulesVersionsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["pageSize"]; ok {
- params.Set("pageSize", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["view"]; ok {
- params.Set("view", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta4/apps/{appsId}/modules/{modulesId}/versions")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "appsId": c.appsId,
- "modulesId": c.modulesId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "appengine.apps.modules.versions.list" call.
-// Exactly one of *ListVersionsResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ListVersionsResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AppsModulesVersionsListCall) Do() (*ListVersionsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ListVersionsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists the versions of a module.",
- // "httpMethod": "GET",
- // "id": "appengine.apps.modules.versions.list",
- // "parameterOrder": [
- // "appsId",
- // "modulesId"
- // ],
- // "parameters": {
- // "appsId": {
- // "description": "Part of `name`. Name of the resource requested. For example: \"apps/myapp/modules/default\".",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "modulesId": {
- // "description": "Part of `name`. See documentation of `appsId`.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "pageSize": {
- // "description": "Maximum results to return per page.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Continuation token for fetching the next page of results.",
- // "location": "query",
- // "type": "string"
- // },
- // "view": {
- // "description": "Controls the set of fields returned in the `List` response.",
- // "enum": [
- // "BASIC",
- // "FULL"
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
- // "response": {
- // "$ref": "ListVersionsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "appengine.apps.operations.get":
-
-type AppsOperationsGetCall struct {
- s *Service
- appsId string
- operationsId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets the latest state of a long-running operation. Clients can
-// use this method to poll the operation result at intervals as
-// recommended by the API service.
-func (r *AppsOperationsService) Get(appsId string, operationsId string) *AppsOperationsGetCall {
- c := &AppsOperationsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.appsId = appsId
- c.operationsId = operationsId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AppsOperationsGetCall) Fields(s ...googleapi.Field) *AppsOperationsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AppsOperationsGetCall) IfNoneMatch(entityTag string) *AppsOperationsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AppsOperationsGetCall) Context(ctx context.Context) *AppsOperationsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AppsOperationsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta4/apps/{appsId}/operations/{operationsId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "appsId": c.appsId,
- "operationsId": c.operationsId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "appengine.apps.operations.get" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AppsOperationsGetCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
- // "httpMethod": "GET",
- // "id": "appengine.apps.operations.get",
- // "parameterOrder": [
- // "appsId",
- // "operationsId"
- // ],
- // "parameters": {
- // "appsId": {
- // "description": "Part of `name`. The name of the operation resource.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "operationsId": {
- // "description": "Part of `name`. See documentation of `appsId`.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1beta4/apps/{appsId}/operations/{operationsId}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "appengine.apps.operations.list":
-
-type AppsOperationsListCall struct {
- s *Service
- appsId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists operations that match the specified filter in the
-// request. If the server doesn't support this method, it returns
-// `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services
-// to override the binding to use different resource name schemes, such
-// as `users/*/operations`.
-func (r *AppsOperationsService) List(appsId string) *AppsOperationsListCall {
- c := &AppsOperationsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.appsId = appsId
- return c
-}
-
-// Filter sets the optional parameter "filter": The standard list
-// filter.
-func (c *AppsOperationsListCall) Filter(filter string) *AppsOperationsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// PageSize sets the optional parameter "pageSize": The standard list
-// page size.
-func (c *AppsOperationsListCall) PageSize(pageSize int64) *AppsOperationsListCall {
- c.opt_["pageSize"] = pageSize
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The standard list
-// page token.
-func (c *AppsOperationsListCall) PageToken(pageToken string) *AppsOperationsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AppsOperationsListCall) Fields(s ...googleapi.Field) *AppsOperationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AppsOperationsListCall) IfNoneMatch(entityTag string) *AppsOperationsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AppsOperationsListCall) Context(ctx context.Context) *AppsOperationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AppsOperationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageSize"]; ok {
- params.Set("pageSize", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta4/apps/{appsId}/operations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "appsId": c.appsId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "appengine.apps.operations.list" call.
-// Exactly one of *ListOperationsResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ListOperationsResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AppsOperationsListCall) Do() (*ListOperationsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ListOperationsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.",
- // "httpMethod": "GET",
- // "id": "appengine.apps.operations.list",
- // "parameterOrder": [
- // "appsId"
- // ],
- // "parameters": {
- // "appsId": {
- // "description": "Part of `name`. The name of the operation collection.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "filter": {
- // "description": "The standard list filter.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageSize": {
- // "description": "The standard list page size.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The standard list page token.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "v1beta4/apps/{appsId}/operations",
- // "response": {
- // "$ref": "ListOperationsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/appsactivity/v1/appsactivity-api.json b/vendor/google.golang.org/api/appsactivity/v1/appsactivity-api.json
deleted file mode 100644
index b36756be..00000000
--- a/vendor/google.golang.org/api/appsactivity/v1/appsactivity-api.json
+++ /dev/null
@@ -1,477 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/ZeC-oWzDKj1E5_H69LVDW5wAByE\"",
- "discoveryVersion": "v1",
- "id": "appsactivity:v1",
- "name": "appsactivity",
- "version": "v1",
- "revision": "20150326",
- "title": "Google Apps Activity API",
- "description": "Provides a historical view of activity.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/google-apps/activity/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/appsactivity/v1/",
- "basePath": "/appsactivity/v1/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "appsactivity/v1/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/activity": {
- "description": "View the activity history of your Google Apps"
- },
- "https://www.googleapis.com/auth/drive": {
- "description": "View and manage the files in your Google Drive"
- },
- "https://www.googleapis.com/auth/drive.metadata": {
- "description": "View and manage metadata of files in your Google Drive"
- },
- "https://www.googleapis.com/auth/drive.metadata.readonly": {
- "description": "View metadata for files in your Google Drive"
- },
- "https://www.googleapis.com/auth/drive.readonly": {
- "description": "View the files in your Google Drive"
- }
- }
- }
- },
- "schemas": {
- "Activity": {
- "id": "Activity",
- "type": "object",
- "description": "An Activity resource is a combined view of multiple events. An activity has a list of individual events and a combined view of the common fields among all events.",
- "properties": {
- "combinedEvent": {
- "$ref": "Event",
- "description": "The fields common to all of the singleEvents that make up the Activity."
- },
- "singleEvents": {
- "type": "array",
- "description": "A list of all the Events that make up the Activity.",
- "items": {
- "$ref": "Event"
- }
- }
- }
- },
- "Event": {
- "id": "Event",
- "type": "object",
- "description": "Represents the changes associated with an action taken by a user.",
- "properties": {
- "additionalEventTypes": {
- "type": "array",
- "description": "Additional event types. Some events may have multiple types when multiple actions are part of a single event. For example, creating a document, renaming it, and sharing it may be part of a single file-creation event.",
- "items": {
- "type": "string",
- "enum": [
- "comment",
- "create",
- "edit",
- "emptyTrash",
- "move",
- "permissionChange",
- "rename",
- "trash",
- "unknown",
- "untrash",
- "upload"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- },
- "eventTimeMillis": {
- "type": "string",
- "description": "The time at which the event occurred formatted as Unix time in milliseconds.",
- "format": "uint64"
- },
- "fromUserDeletion": {
- "type": "boolean",
- "description": "Whether this event is caused by a user being deleted."
- },
- "move": {
- "$ref": "Move",
- "description": "Extra information for move type events, such as changes in an object's parents."
- },
- "permissionChanges": {
- "type": "array",
- "description": "Extra information for permissionChange type events, such as the user or group the new permission applies to.",
- "items": {
- "$ref": "PermissionChange"
- }
- },
- "primaryEventType": {
- "type": "string",
- "description": "The main type of event that occurred.",
- "enum": [
- "comment",
- "create",
- "edit",
- "emptyTrash",
- "move",
- "permissionChange",
- "rename",
- "trash",
- "unknown",
- "untrash",
- "upload"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "rename": {
- "$ref": "Rename",
- "description": "Extra information for rename type events, such as the old and new names."
- },
- "target": {
- "$ref": "Target",
- "description": "Information specific to the Target object modified by the event."
- },
- "user": {
- "$ref": "User",
- "description": "Represents the user responsible for the event."
- }
- }
- },
- "ListActivitiesResponse": {
- "id": "ListActivitiesResponse",
- "type": "object",
- "description": "The response from the list request. Contains a list of activities and a token to retrieve the next page of results.",
- "properties": {
- "activities": {
- "type": "array",
- "description": "List of activities.",
- "items": {
- "$ref": "Activity"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token for the next page of results."
- }
- }
- },
- "Move": {
- "id": "Move",
- "type": "object",
- "description": "Contains information about changes in an object's parents as a result of a move type event.",
- "properties": {
- "addedParents": {
- "type": "array",
- "description": "The added parent(s).",
- "items": {
- "$ref": "Parent"
- }
- },
- "removedParents": {
- "type": "array",
- "description": "The removed parent(s).",
- "items": {
- "$ref": "Parent"
- }
- }
- }
- },
- "Parent": {
- "id": "Parent",
- "type": "object",
- "description": "Contains information about a parent object. For example, a folder in Drive is a parent for all files within it.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The parent's ID."
- },
- "isRoot": {
- "type": "boolean",
- "description": "Whether this is the root folder."
- },
- "title": {
- "type": "string",
- "description": "The parent's title."
- }
- }
- },
- "Permission": {
- "id": "Permission",
- "type": "object",
- "description": "Contains information about the permissions and type of access allowed with regards to a Google Drive object. This is a subset of the fields contained in a corresponding Drive Permissions object.",
- "properties": {
- "name": {
- "type": "string",
- "description": "The name of the user or group the permission applies to."
- },
- "permissionId": {
- "type": "string",
- "description": "The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource."
- },
- "role": {
- "type": "string",
- "description": "Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.",
- "enum": [
- "commenter",
- "owner",
- "reader",
- "writer"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- },
- "type": {
- "type": "string",
- "description": "Indicates how widely permissions are granted.",
- "enum": [
- "anyone",
- "domain",
- "group",
- "user"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- },
- "user": {
- "$ref": "User",
- "description": "The user's information if the type is USER."
- },
- "withLink": {
- "type": "boolean",
- "description": "Whether the permission requires a link to the file."
- }
- }
- },
- "PermissionChange": {
- "id": "PermissionChange",
- "type": "object",
- "description": "Contains information about a Drive object's permissions that changed as a result of a permissionChange type event.",
- "properties": {
- "addedPermissions": {
- "type": "array",
- "description": "Lists all Permission objects added.",
- "items": {
- "$ref": "Permission"
- }
- },
- "removedPermissions": {
- "type": "array",
- "description": "Lists all Permission objects removed.",
- "items": {
- "$ref": "Permission"
- }
- }
- }
- },
- "Photo": {
- "id": "Photo",
- "type": "object",
- "description": "Photo information for a user.",
- "properties": {
- "url": {
- "type": "string",
- "description": "The URL of the photo."
- }
- }
- },
- "Rename": {
- "id": "Rename",
- "type": "object",
- "description": "Contains information about a renametype event.",
- "properties": {
- "newTitle": {
- "type": "string",
- "description": "The new title."
- },
- "oldTitle": {
- "type": "string",
- "description": "The old title."
- }
- }
- },
- "Target": {
- "id": "Target",
- "type": "object",
- "description": "Information about the object modified by the event.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The ID of the target. For example, in Google Drive, this is the file or folder ID."
- },
- "mimeType": {
- "type": "string",
- "description": "The MIME type of the target."
- },
- "name": {
- "type": "string",
- "description": "The name of the target. For example, in Google Drive, this is the title of the file."
- }
- }
- },
- "User": {
- "id": "User",
- "type": "object",
- "description": "A representation of a user.",
- "properties": {
- "name": {
- "type": "string",
- "description": "The displayable name of the user."
- },
- "photo": {
- "$ref": "Photo",
- "description": "The profile photo of the user."
- }
- }
- }
- },
- "resources": {
- "activities": {
- "methods": {
- "list": {
- "id": "appsactivity.activities.list",
- "path": "activities",
- "httpMethod": "GET",
- "description": "Returns a list of activities visible to the current logged in user. Visible activities are determined by the visiblity settings of the object that was acted on, e.g. Drive files a user can see. An activity is a record of past events. Multiple events may be merged if they are similar. A request is scoped to activities from a given Google service using the source parameter.",
- "parameters": {
- "drive.ancestorId": {
- "type": "string",
- "description": "Identifies the Drive folder containing the items for which to return activities.",
- "location": "query"
- },
- "drive.fileId": {
- "type": "string",
- "description": "Identifies the Drive item to return activities for.",
- "location": "query"
- },
- "groupingStrategy": {
- "type": "string",
- "description": "Indicates the strategy to use when grouping singleEvents items in the associated combinedEvent object.",
- "default": "driveUi",
- "enum": [
- "driveUi",
- "none"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "pageSize": {
- "type": "integer",
- "description": "The maximum number of events to return on a page. The response includes a continuation token if there are more events.",
- "default": "50",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A token to retrieve a specific page of results.",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "The Google service from which to return activities. Possible values of source are: \n- drive.google.com",
- "location": "query"
- },
- "userId": {
- "type": "string",
- "description": "Indicates the user to return activity for. Use the special value me to indicate the currently authenticated user.",
- "default": "me",
- "location": "query"
- }
- },
- "response": {
- "$ref": "ListActivitiesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/activity",
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.metadata",
- "https://www.googleapis.com/auth/drive.metadata.readonly",
- "https://www.googleapis.com/auth/drive.readonly"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/appsactivity/v1/appsactivity-gen.go b/vendor/google.golang.org/api/appsactivity/v1/appsactivity-gen.go
deleted file mode 100644
index 65220740..00000000
--- a/vendor/google.golang.org/api/appsactivity/v1/appsactivity-gen.go
+++ /dev/null
@@ -1,704 +0,0 @@
-// Package appsactivity provides access to the Google Apps Activity API.
-//
-// See https://developers.google.com/google-apps/activity/
-//
-// Usage example:
-//
-// import "google.golang.org/api/appsactivity/v1"
-// ...
-// appsactivityService, err := appsactivity.New(oauthHttpClient)
-package appsactivity // import "google.golang.org/api/appsactivity/v1"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "appsactivity:v1"
-const apiName = "appsactivity"
-const apiVersion = "v1"
-const basePath = "https://www.googleapis.com/appsactivity/v1/"
-
-// OAuth2 scopes used by this API.
-const (
- // View the activity history of your Google Apps
- ActivityScope = "https://www.googleapis.com/auth/activity"
-
- // View and manage the files in your Google Drive
- DriveScope = "https://www.googleapis.com/auth/drive"
-
- // View and manage metadata of files in your Google Drive
- DriveMetadataScope = "https://www.googleapis.com/auth/drive.metadata"
-
- // View metadata for files in your Google Drive
- DriveMetadataReadonlyScope = "https://www.googleapis.com/auth/drive.metadata.readonly"
-
- // View the files in your Google Drive
- DriveReadonlyScope = "https://www.googleapis.com/auth/drive.readonly"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Activities = NewActivitiesService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Activities *ActivitiesService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewActivitiesService(s *Service) *ActivitiesService {
- rs := &ActivitiesService{s: s}
- return rs
-}
-
-type ActivitiesService struct {
- s *Service
-}
-
-// Activity: An Activity resource is a combined view of multiple events.
-// An activity has a list of individual events and a combined view of
-// the common fields among all events.
-type Activity struct {
- // CombinedEvent: The fields common to all of the singleEvents that make
- // up the Activity.
- CombinedEvent *Event `json:"combinedEvent,omitempty"`
-
- // SingleEvents: A list of all the Events that make up the Activity.
- SingleEvents []*Event `json:"singleEvents,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CombinedEvent") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Activity) MarshalJSON() ([]byte, error) {
- type noMethod Activity
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Event: Represents the changes associated with an action taken by a
-// user.
-type Event struct {
- // AdditionalEventTypes: Additional event types. Some events may have
- // multiple types when multiple actions are part of a single event. For
- // example, creating a document, renaming it, and sharing it may be part
- // of a single file-creation event.
- //
- // Possible values:
- // "comment"
- // "create"
- // "edit"
- // "emptyTrash"
- // "move"
- // "permissionChange"
- // "rename"
- // "trash"
- // "unknown"
- // "untrash"
- // "upload"
- AdditionalEventTypes []string `json:"additionalEventTypes,omitempty"`
-
- // EventTimeMillis: The time at which the event occurred formatted as
- // Unix time in milliseconds.
- EventTimeMillis uint64 `json:"eventTimeMillis,omitempty,string"`
-
- // FromUserDeletion: Whether this event is caused by a user being
- // deleted.
- FromUserDeletion bool `json:"fromUserDeletion,omitempty"`
-
- // Move: Extra information for move type events, such as changes in an
- // object's parents.
- Move *Move `json:"move,omitempty"`
-
- // PermissionChanges: Extra information for permissionChange type
- // events, such as the user or group the new permission applies to.
- PermissionChanges []*PermissionChange `json:"permissionChanges,omitempty"`
-
- // PrimaryEventType: The main type of event that occurred.
- //
- // Possible values:
- // "comment"
- // "create"
- // "edit"
- // "emptyTrash"
- // "move"
- // "permissionChange"
- // "rename"
- // "trash"
- // "unknown"
- // "untrash"
- // "upload"
- PrimaryEventType string `json:"primaryEventType,omitempty"`
-
- // Rename: Extra information for rename type events, such as the old and
- // new names.
- Rename *Rename `json:"rename,omitempty"`
-
- // Target: Information specific to the Target object modified by the
- // event.
- Target *Target `json:"target,omitempty"`
-
- // User: Represents the user responsible for the event.
- User *User `json:"user,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "AdditionalEventTypes") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Event) MarshalJSON() ([]byte, error) {
- type noMethod Event
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListActivitiesResponse: The response from the list request. Contains
-// a list of activities and a token to retrieve the next page of
-// results.
-type ListActivitiesResponse struct {
- // Activities: List of activities.
- Activities []*Activity `json:"activities,omitempty"`
-
- // NextPageToken: Token for the next page of results.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Activities") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListActivitiesResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListActivitiesResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Move: Contains information about changes in an object's parents as a
-// result of a move type event.
-type Move struct {
- // AddedParents: The added parent(s).
- AddedParents []*Parent `json:"addedParents,omitempty"`
-
- // RemovedParents: The removed parent(s).
- RemovedParents []*Parent `json:"removedParents,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AddedParents") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Move) MarshalJSON() ([]byte, error) {
- type noMethod Move
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Parent: Contains information about a parent object. For example, a
-// folder in Drive is a parent for all files within it.
-type Parent struct {
- // Id: The parent's ID.
- Id string `json:"id,omitempty"`
-
- // IsRoot: Whether this is the root folder.
- IsRoot bool `json:"isRoot,omitempty"`
-
- // Title: The parent's title.
- Title string `json:"title,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Parent) MarshalJSON() ([]byte, error) {
- type noMethod Parent
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Permission: Contains information about the permissions and type of
-// access allowed with regards to a Google Drive object. This is a
-// subset of the fields contained in a corresponding Drive Permissions
-// object.
-type Permission struct {
- // Name: The name of the user or group the permission applies to.
- Name string `json:"name,omitempty"`
-
- // PermissionId: The ID for this permission. Corresponds to the Drive
- // API's permission ID returned as part of the Drive Permissions
- // resource.
- PermissionId string `json:"permissionId,omitempty"`
-
- // Role: Indicates the Google Drive permissions role. The role
- // determines a user's ability to read, write, or comment on the file.
- //
- // Possible values:
- // "commenter"
- // "owner"
- // "reader"
- // "writer"
- Role string `json:"role,omitempty"`
-
- // Type: Indicates how widely permissions are granted.
- //
- // Possible values:
- // "anyone"
- // "domain"
- // "group"
- // "user"
- Type string `json:"type,omitempty"`
-
- // User: The user's information if the type is USER.
- User *User `json:"user,omitempty"`
-
- // WithLink: Whether the permission requires a link to the file.
- WithLink bool `json:"withLink,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Name") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Permission) MarshalJSON() ([]byte, error) {
- type noMethod Permission
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PermissionChange: Contains information about a Drive object's
-// permissions that changed as a result of a permissionChange type
-// event.
-type PermissionChange struct {
- // AddedPermissions: Lists all Permission objects added.
- AddedPermissions []*Permission `json:"addedPermissions,omitempty"`
-
- // RemovedPermissions: Lists all Permission objects removed.
- RemovedPermissions []*Permission `json:"removedPermissions,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AddedPermissions") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PermissionChange) MarshalJSON() ([]byte, error) {
- type noMethod PermissionChange
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Photo: Photo information for a user.
-type Photo struct {
- // Url: The URL of the photo.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Url") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Photo) MarshalJSON() ([]byte, error) {
- type noMethod Photo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Rename: Contains information about a renametype event.
-type Rename struct {
- // NewTitle: The new title.
- NewTitle string `json:"newTitle,omitempty"`
-
- // OldTitle: The old title.
- OldTitle string `json:"oldTitle,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "NewTitle") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Rename) MarshalJSON() ([]byte, error) {
- type noMethod Rename
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Target: Information about the object modified by the event.
-type Target struct {
- // Id: The ID of the target. For example, in Google Drive, this is the
- // file or folder ID.
- Id string `json:"id,omitempty"`
-
- // MimeType: The MIME type of the target.
- MimeType string `json:"mimeType,omitempty"`
-
- // Name: The name of the target. For example, in Google Drive, this is
- // the title of the file.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Target) MarshalJSON() ([]byte, error) {
- type noMethod Target
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// User: A representation of a user.
-type User struct {
- // Name: The displayable name of the user.
- Name string `json:"name,omitempty"`
-
- // Photo: The profile photo of the user.
- Photo *Photo `json:"photo,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Name") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *User) MarshalJSON() ([]byte, error) {
- type noMethod User
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "appsactivity.activities.list":
-
-type ActivitiesListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Returns a list of activities visible to the current logged in
-// user. Visible activities are determined by the visiblity settings of
-// the object that was acted on, e.g. Drive files a user can see. An
-// activity is a record of past events. Multiple events may be merged if
-// they are similar. A request is scoped to activities from a given
-// Google service using the source parameter.
-func (r *ActivitiesService) List() *ActivitiesListCall {
- c := &ActivitiesListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// DriveAncestorId sets the optional parameter "drive.ancestorId":
-// Identifies the Drive folder containing the items for which to return
-// activities.
-func (c *ActivitiesListCall) DriveAncestorId(driveAncestorId string) *ActivitiesListCall {
- c.opt_["drive.ancestorId"] = driveAncestorId
- return c
-}
-
-// DriveFileId sets the optional parameter "drive.fileId": Identifies
-// the Drive item to return activities for.
-func (c *ActivitiesListCall) DriveFileId(driveFileId string) *ActivitiesListCall {
- c.opt_["drive.fileId"] = driveFileId
- return c
-}
-
-// GroupingStrategy sets the optional parameter "groupingStrategy":
-// Indicates the strategy to use when grouping singleEvents items in the
-// associated combinedEvent object.
-//
-// Possible values:
-// "driveUi" (default)
-// "none"
-func (c *ActivitiesListCall) GroupingStrategy(groupingStrategy string) *ActivitiesListCall {
- c.opt_["groupingStrategy"] = groupingStrategy
- return c
-}
-
-// PageSize sets the optional parameter "pageSize": The maximum number
-// of events to return on a page. The response includes a continuation
-// token if there are more events.
-func (c *ActivitiesListCall) PageSize(pageSize int64) *ActivitiesListCall {
- c.opt_["pageSize"] = pageSize
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A token to
-// retrieve a specific page of results.
-func (c *ActivitiesListCall) PageToken(pageToken string) *ActivitiesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Source sets the optional parameter "source": The Google service from
-// which to return activities. Possible values of source are:
-// - drive.google.com
-func (c *ActivitiesListCall) Source(source string) *ActivitiesListCall {
- c.opt_["source"] = source
- return c
-}
-
-// UserId sets the optional parameter "userId": Indicates the user to
-// return activity for. Use the special value me to indicate the
-// currently authenticated user.
-func (c *ActivitiesListCall) UserId(userId string) *ActivitiesListCall {
- c.opt_["userId"] = userId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ActivitiesListCall) Fields(s ...googleapi.Field) *ActivitiesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ActivitiesListCall) IfNoneMatch(entityTag string) *ActivitiesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ActivitiesListCall) Context(ctx context.Context) *ActivitiesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ActivitiesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["drive.ancestorId"]; ok {
- params.Set("drive.ancestorId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["drive.fileId"]; ok {
- params.Set("drive.fileId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["groupingStrategy"]; ok {
- params.Set("groupingStrategy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageSize"]; ok {
- params.Set("pageSize", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["userId"]; ok {
- params.Set("userId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "activities")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "appsactivity.activities.list" call.
-// Exactly one of *ListActivitiesResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ListActivitiesResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ActivitiesListCall) Do() (*ListActivitiesResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ListActivitiesResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns a list of activities visible to the current logged in user. Visible activities are determined by the visiblity settings of the object that was acted on, e.g. Drive files a user can see. An activity is a record of past events. Multiple events may be merged if they are similar. A request is scoped to activities from a given Google service using the source parameter.",
- // "httpMethod": "GET",
- // "id": "appsactivity.activities.list",
- // "parameters": {
- // "drive.ancestorId": {
- // "description": "Identifies the Drive folder containing the items for which to return activities.",
- // "location": "query",
- // "type": "string"
- // },
- // "drive.fileId": {
- // "description": "Identifies the Drive item to return activities for.",
- // "location": "query",
- // "type": "string"
- // },
- // "groupingStrategy": {
- // "default": "driveUi",
- // "description": "Indicates the strategy to use when grouping singleEvents items in the associated combinedEvent object.",
- // "enum": [
- // "driveUi",
- // "none"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "pageSize": {
- // "default": "50",
- // "description": "The maximum number of events to return on a page. The response includes a continuation token if there are more events.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A token to retrieve a specific page of results.",
- // "location": "query",
- // "type": "string"
- // },
- // "source": {
- // "description": "The Google service from which to return activities. Possible values of source are: \n- drive.google.com",
- // "location": "query",
- // "type": "string"
- // },
- // "userId": {
- // "default": "me",
- // "description": "Indicates the user to return activity for. Use the special value me to indicate the currently authenticated user.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "activities",
- // "response": {
- // "$ref": "ListActivitiesResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/activity",
- // "https://www.googleapis.com/auth/drive",
- // "https://www.googleapis.com/auth/drive.metadata",
- // "https://www.googleapis.com/auth/drive.metadata.readonly",
- // "https://www.googleapis.com/auth/drive.readonly"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/appstate/v1/appstate-api.json b/vendor/google.golang.org/api/appstate/v1/appstate-api.json
deleted file mode 100644
index f46cac78..00000000
--- a/vendor/google.golang.org/api/appstate/v1/appstate-api.json
+++ /dev/null
@@ -1,307 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/fq2tcHmUUpw0BqgyQT2jiNE1XgU\"",
- "discoveryVersion": "v1",
- "id": "appstate:v1",
- "name": "appstate",
- "canonicalName": "App State",
- "version": "v1",
- "revision": "20150119",
- "title": "Google App State API",
- "description": "The Google App State API.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/games/services/web/api/states",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/appstate/v1/",
- "basePath": "/appstate/v1/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "appstate/v1/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/appstate": {
- "description": "View and manage your data for this application"
- }
- }
- }
- },
- "schemas": {
- "GetResponse": {
- "id": "GetResponse",
- "type": "object",
- "description": "This is a JSON template for an app state resource.",
- "properties": {
- "currentStateVersion": {
- "type": "string",
- "description": "The current app state version."
- },
- "data": {
- "type": "string",
- "description": "The requested data."
- },
- "kind": {
- "type": "string",
- "description": "Uniquely identifies the type of this resource. Value is always the fixed string appstate#getResponse.",
- "default": "appstate#getResponse"
- },
- "stateKey": {
- "type": "integer",
- "description": "The key for the data.",
- "format": "int32"
- }
- }
- },
- "ListResponse": {
- "id": "ListResponse",
- "type": "object",
- "description": "This is a JSON template to convert a list-response for app state.",
- "properties": {
- "items": {
- "type": "array",
- "description": "The app state data.",
- "items": {
- "$ref": "GetResponse"
- }
- },
- "kind": {
- "type": "string",
- "description": "Uniquely identifies the type of this resource. Value is always the fixed string appstate#listResponse.",
- "default": "appstate#listResponse"
- },
- "maximumKeyCount": {
- "type": "integer",
- "description": "The maximum number of keys allowed for this user.",
- "format": "int32"
- }
- }
- },
- "UpdateRequest": {
- "id": "UpdateRequest",
- "type": "object",
- "description": "This is a JSON template for a requests which update app state",
- "properties": {
- "data": {
- "type": "string",
- "description": "The new app state data that your application is trying to update with."
- },
- "kind": {
- "type": "string",
- "description": "Uniquely identifies the type of this resource. Value is always the fixed string appstate#updateRequest.",
- "default": "appstate#updateRequest"
- }
- }
- },
- "WriteResult": {
- "id": "WriteResult",
- "type": "object",
- "description": "This is a JSON template for an app state write result.",
- "properties": {
- "currentStateVersion": {
- "type": "string",
- "description": "The version of the data for this key on the server."
- },
- "kind": {
- "type": "string",
- "description": "Uniquely identifies the type of this resource. Value is always the fixed string appstate#writeResult.",
- "default": "appstate#writeResult"
- },
- "stateKey": {
- "type": "integer",
- "description": "The written key.",
- "format": "int32"
- }
- }
- }
- },
- "resources": {
- "states": {
- "methods": {
- "clear": {
- "id": "appstate.states.clear",
- "path": "states/{stateKey}/clear",
- "httpMethod": "POST",
- "description": "Clears (sets to empty) the data for the passed key if and only if the passed version matches the currently stored version. This method results in a conflict error on version mismatch.",
- "parameters": {
- "currentDataVersion": {
- "type": "string",
- "description": "The version of the data to be cleared. Version strings are returned by the server.",
- "location": "query"
- },
- "stateKey": {
- "type": "integer",
- "description": "The key for the data to be retrieved.",
- "required": true,
- "format": "int32",
- "minimum": "0",
- "maximum": "3",
- "location": "path"
- }
- },
- "parameterOrder": [
- "stateKey"
- ],
- "response": {
- "$ref": "WriteResult"
- },
- "scopes": [
- "https://www.googleapis.com/auth/appstate"
- ]
- },
- "delete": {
- "id": "appstate.states.delete",
- "path": "states/{stateKey}",
- "httpMethod": "DELETE",
- "description": "Deletes a key and the data associated with it. The key is removed and no longer counts against the key quota. Note that since this method is not safe in the face of concurrent modifications, it should only be used for development and testing purposes. Invoking this method in shipping code can result in data loss and data corruption.",
- "parameters": {
- "stateKey": {
- "type": "integer",
- "description": "The key for the data to be retrieved.",
- "required": true,
- "format": "int32",
- "minimum": "0",
- "maximum": "3",
- "location": "path"
- }
- },
- "parameterOrder": [
- "stateKey"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/appstate"
- ]
- },
- "get": {
- "id": "appstate.states.get",
- "path": "states/{stateKey}",
- "httpMethod": "GET",
- "description": "Retrieves the data corresponding to the passed key. If the key does not exist on the server, an HTTP 404 will be returned.",
- "parameters": {
- "stateKey": {
- "type": "integer",
- "description": "The key for the data to be retrieved.",
- "required": true,
- "format": "int32",
- "minimum": "0",
- "maximum": "3",
- "location": "path"
- }
- },
- "parameterOrder": [
- "stateKey"
- ],
- "response": {
- "$ref": "GetResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/appstate"
- ]
- },
- "list": {
- "id": "appstate.states.list",
- "path": "states",
- "httpMethod": "GET",
- "description": "Lists all the states keys, and optionally the state data.",
- "parameters": {
- "includeData": {
- "type": "boolean",
- "description": "Whether to include the full data in addition to the version number",
- "default": "false",
- "location": "query"
- }
- },
- "response": {
- "$ref": "ListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/appstate"
- ]
- },
- "update": {
- "id": "appstate.states.update",
- "path": "states/{stateKey}",
- "httpMethod": "PUT",
- "description": "Update the data associated with the input key if and only if the passed version matches the currently stored version. This method is safe in the face of concurrent writes. Maximum per-key size is 128KB.",
- "parameters": {
- "currentStateVersion": {
- "type": "string",
- "description": "The version of the app state your application is attempting to update. If this does not match the current version, this method will return a conflict error. If there is no data stored on the server for this key, the update will succeed irrespective of the value of this parameter.",
- "location": "query"
- },
- "stateKey": {
- "type": "integer",
- "description": "The key for the data to be retrieved.",
- "required": true,
- "format": "int32",
- "minimum": "0",
- "maximum": "3",
- "location": "path"
- }
- },
- "parameterOrder": [
- "stateKey"
- ],
- "request": {
- "$ref": "UpdateRequest"
- },
- "response": {
- "$ref": "WriteResult"
- },
- "scopes": [
- "https://www.googleapis.com/auth/appstate"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/appstate/v1/appstate-gen.go b/vendor/google.golang.org/api/appstate/v1/appstate-gen.go
deleted file mode 100644
index d65077a4..00000000
--- a/vendor/google.golang.org/api/appstate/v1/appstate-gen.go
+++ /dev/null
@@ -1,845 +0,0 @@
-// Package appstate provides access to the Google App State API.
-//
-// See https://developers.google.com/games/services/web/api/states
-//
-// Usage example:
-//
-// import "google.golang.org/api/appstate/v1"
-// ...
-// appstateService, err := appstate.New(oauthHttpClient)
-package appstate // import "google.golang.org/api/appstate/v1"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "appstate:v1"
-const apiName = "appstate"
-const apiVersion = "v1"
-const basePath = "https://www.googleapis.com/appstate/v1/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your data for this application
- AppstateScope = "https://www.googleapis.com/auth/appstate"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.States = NewStatesService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- States *StatesService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewStatesService(s *Service) *StatesService {
- rs := &StatesService{s: s}
- return rs
-}
-
-type StatesService struct {
- s *Service
-}
-
-// GetResponse: This is a JSON template for an app state resource.
-type GetResponse struct {
- // CurrentStateVersion: The current app state version.
- CurrentStateVersion string `json:"currentStateVersion,omitempty"`
-
- // Data: The requested data.
- Data string `json:"data,omitempty"`
-
- // Kind: Uniquely identifies the type of this resource. Value is always
- // the fixed string appstate#getResponse.
- Kind string `json:"kind,omitempty"`
-
- // StateKey: The key for the data.
- StateKey int64 `json:"stateKey,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CurrentStateVersion")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GetResponse) MarshalJSON() ([]byte, error) {
- type noMethod GetResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListResponse: This is a JSON template to convert a list-response for
-// app state.
-type ListResponse struct {
- // Items: The app state data.
- Items []*GetResponse `json:"items,omitempty"`
-
- // Kind: Uniquely identifies the type of this resource. Value is always
- // the fixed string appstate#listResponse.
- Kind string `json:"kind,omitempty"`
-
- // MaximumKeyCount: The maximum number of keys allowed for this user.
- MaximumKeyCount int64 `json:"maximumKeyCount,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UpdateRequest: This is a JSON template for a requests which update
-// app state
-type UpdateRequest struct {
- // Data: The new app state data that your application is trying to
- // update with.
- Data string `json:"data,omitempty"`
-
- // Kind: Uniquely identifies the type of this resource. Value is always
- // the fixed string appstate#updateRequest.
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Data") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UpdateRequest) MarshalJSON() ([]byte, error) {
- type noMethod UpdateRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// WriteResult: This is a JSON template for an app state write result.
-type WriteResult struct {
- // CurrentStateVersion: The version of the data for this key on the
- // server.
- CurrentStateVersion string `json:"currentStateVersion,omitempty"`
-
- // Kind: Uniquely identifies the type of this resource. Value is always
- // the fixed string appstate#writeResult.
- Kind string `json:"kind,omitempty"`
-
- // StateKey: The written key.
- StateKey int64 `json:"stateKey,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CurrentStateVersion")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *WriteResult) MarshalJSON() ([]byte, error) {
- type noMethod WriteResult
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "appstate.states.clear":
-
-type StatesClearCall struct {
- s *Service
- stateKey int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Clear: Clears (sets to empty) the data for the passed key if and only
-// if the passed version matches the currently stored version. This
-// method results in a conflict error on version mismatch.
-func (r *StatesService) Clear(stateKey int64) *StatesClearCall {
- c := &StatesClearCall{s: r.s, opt_: make(map[string]interface{})}
- c.stateKey = stateKey
- return c
-}
-
-// CurrentDataVersion sets the optional parameter "currentDataVersion":
-// The version of the data to be cleared. Version strings are returned
-// by the server.
-func (c *StatesClearCall) CurrentDataVersion(currentDataVersion string) *StatesClearCall {
- c.opt_["currentDataVersion"] = currentDataVersion
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *StatesClearCall) Fields(s ...googleapi.Field) *StatesClearCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *StatesClearCall) Context(ctx context.Context) *StatesClearCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *StatesClearCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["currentDataVersion"]; ok {
- params.Set("currentDataVersion", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "states/{stateKey}/clear")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "stateKey": strconv.FormatInt(c.stateKey, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "appstate.states.clear" call.
-// Exactly one of *WriteResult or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *WriteResult.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *StatesClearCall) Do() (*WriteResult, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &WriteResult{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Clears (sets to empty) the data for the passed key if and only if the passed version matches the currently stored version. This method results in a conflict error on version mismatch.",
- // "httpMethod": "POST",
- // "id": "appstate.states.clear",
- // "parameterOrder": [
- // "stateKey"
- // ],
- // "parameters": {
- // "currentDataVersion": {
- // "description": "The version of the data to be cleared. Version strings are returned by the server.",
- // "location": "query",
- // "type": "string"
- // },
- // "stateKey": {
- // "description": "The key for the data to be retrieved.",
- // "format": "int32",
- // "location": "path",
- // "maximum": "3",
- // "minimum": "0",
- // "required": true,
- // "type": "integer"
- // }
- // },
- // "path": "states/{stateKey}/clear",
- // "response": {
- // "$ref": "WriteResult"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/appstate"
- // ]
- // }
-
-}
-
-// method id "appstate.states.delete":
-
-type StatesDeleteCall struct {
- s *Service
- stateKey int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes a key and the data associated with it. The key is
-// removed and no longer counts against the key quota. Note that since
-// this method is not safe in the face of concurrent modifications, it
-// should only be used for development and testing purposes. Invoking
-// this method in shipping code can result in data loss and data
-// corruption.
-func (r *StatesService) Delete(stateKey int64) *StatesDeleteCall {
- c := &StatesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.stateKey = stateKey
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *StatesDeleteCall) Fields(s ...googleapi.Field) *StatesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *StatesDeleteCall) Context(ctx context.Context) *StatesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *StatesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "states/{stateKey}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "stateKey": strconv.FormatInt(c.stateKey, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "appstate.states.delete" call.
-func (c *StatesDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes a key and the data associated with it. The key is removed and no longer counts against the key quota. Note that since this method is not safe in the face of concurrent modifications, it should only be used for development and testing purposes. Invoking this method in shipping code can result in data loss and data corruption.",
- // "httpMethod": "DELETE",
- // "id": "appstate.states.delete",
- // "parameterOrder": [
- // "stateKey"
- // ],
- // "parameters": {
- // "stateKey": {
- // "description": "The key for the data to be retrieved.",
- // "format": "int32",
- // "location": "path",
- // "maximum": "3",
- // "minimum": "0",
- // "required": true,
- // "type": "integer"
- // }
- // },
- // "path": "states/{stateKey}",
- // "scopes": [
- // "https://www.googleapis.com/auth/appstate"
- // ]
- // }
-
-}
-
-// method id "appstate.states.get":
-
-type StatesGetCall struct {
- s *Service
- stateKey int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves the data corresponding to the passed key. If the key
-// does not exist on the server, an HTTP 404 will be returned.
-func (r *StatesService) Get(stateKey int64) *StatesGetCall {
- c := &StatesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.stateKey = stateKey
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *StatesGetCall) Fields(s ...googleapi.Field) *StatesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *StatesGetCall) IfNoneMatch(entityTag string) *StatesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *StatesGetCall) Context(ctx context.Context) *StatesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *StatesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "states/{stateKey}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "stateKey": strconv.FormatInt(c.stateKey, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "appstate.states.get" call.
-// Exactly one of *GetResponse or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *GetResponse.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *StatesGetCall) Do() (*GetResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &GetResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the data corresponding to the passed key. If the key does not exist on the server, an HTTP 404 will be returned.",
- // "httpMethod": "GET",
- // "id": "appstate.states.get",
- // "parameterOrder": [
- // "stateKey"
- // ],
- // "parameters": {
- // "stateKey": {
- // "description": "The key for the data to be retrieved.",
- // "format": "int32",
- // "location": "path",
- // "maximum": "3",
- // "minimum": "0",
- // "required": true,
- // "type": "integer"
- // }
- // },
- // "path": "states/{stateKey}",
- // "response": {
- // "$ref": "GetResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/appstate"
- // ]
- // }
-
-}
-
-// method id "appstate.states.list":
-
-type StatesListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all the states keys, and optionally the state data.
-func (r *StatesService) List() *StatesListCall {
- c := &StatesListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// IncludeData sets the optional parameter "includeData": Whether to
-// include the full data in addition to the version number
-func (c *StatesListCall) IncludeData(includeData bool) *StatesListCall {
- c.opt_["includeData"] = includeData
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *StatesListCall) Fields(s ...googleapi.Field) *StatesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *StatesListCall) IfNoneMatch(entityTag string) *StatesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *StatesListCall) Context(ctx context.Context) *StatesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *StatesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["includeData"]; ok {
- params.Set("includeData", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "states")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "appstate.states.list" call.
-// Exactly one of *ListResponse or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ListResponse.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *StatesListCall) Do() (*ListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all the states keys, and optionally the state data.",
- // "httpMethod": "GET",
- // "id": "appstate.states.list",
- // "parameters": {
- // "includeData": {
- // "default": "false",
- // "description": "Whether to include the full data in addition to the version number",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "states",
- // "response": {
- // "$ref": "ListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/appstate"
- // ]
- // }
-
-}
-
-// method id "appstate.states.update":
-
-type StatesUpdateCall struct {
- s *Service
- stateKey int64
- updaterequest *UpdateRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Update the data associated with the input key if and only if
-// the passed version matches the currently stored version. This method
-// is safe in the face of concurrent writes. Maximum per-key size is
-// 128KB.
-func (r *StatesService) Update(stateKey int64, updaterequest *UpdateRequest) *StatesUpdateCall {
- c := &StatesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.stateKey = stateKey
- c.updaterequest = updaterequest
- return c
-}
-
-// CurrentStateVersion sets the optional parameter
-// "currentStateVersion": The version of the app state your application
-// is attempting to update. If this does not match the current version,
-// this method will return a conflict error. If there is no data stored
-// on the server for this key, the update will succeed irrespective of
-// the value of this parameter.
-func (c *StatesUpdateCall) CurrentStateVersion(currentStateVersion string) *StatesUpdateCall {
- c.opt_["currentStateVersion"] = currentStateVersion
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *StatesUpdateCall) Fields(s ...googleapi.Field) *StatesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *StatesUpdateCall) Context(ctx context.Context) *StatesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *StatesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.updaterequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["currentStateVersion"]; ok {
- params.Set("currentStateVersion", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "states/{stateKey}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "stateKey": strconv.FormatInt(c.stateKey, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "appstate.states.update" call.
-// Exactly one of *WriteResult or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *WriteResult.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *StatesUpdateCall) Do() (*WriteResult, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &WriteResult{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update the data associated with the input key if and only if the passed version matches the currently stored version. This method is safe in the face of concurrent writes. Maximum per-key size is 128KB.",
- // "httpMethod": "PUT",
- // "id": "appstate.states.update",
- // "parameterOrder": [
- // "stateKey"
- // ],
- // "parameters": {
- // "currentStateVersion": {
- // "description": "The version of the app state your application is attempting to update. If this does not match the current version, this method will return a conflict error. If there is no data stored on the server for this key, the update will succeed irrespective of the value of this parameter.",
- // "location": "query",
- // "type": "string"
- // },
- // "stateKey": {
- // "description": "The key for the data to be retrieved.",
- // "format": "int32",
- // "location": "path",
- // "maximum": "3",
- // "minimum": "0",
- // "required": true,
- // "type": "integer"
- // }
- // },
- // "path": "states/{stateKey}",
- // "request": {
- // "$ref": "UpdateRequest"
- // },
- // "response": {
- // "$ref": "WriteResult"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/appstate"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/autoscaler/v1beta2/autoscaler-api.json b/vendor/google.golang.org/api/autoscaler/v1beta2/autoscaler-api.json
deleted file mode 100644
index 421797b2..00000000
--- a/vendor/google.golang.org/api/autoscaler/v1beta2/autoscaler-api.json
+++ /dev/null
@@ -1,891 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/UcR-fBYlWEXj2JrwS8u3wjdNZ58\"",
- "discoveryVersion": "v1",
- "id": "autoscaler:v1beta2",
- "name": "autoscaler",
- "version": "v1beta2",
- "revision": "20150213",
- "title": "Google Compute Engine Autoscaler API",
- "description": "The Google Compute Engine Autoscaler API provides autoscaling for groups of Cloud VMs.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "http://developers.google.com/compute/docs/autoscaler",
- "labels": [
- "limited_availability"
- ],
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/autoscaler/v1beta2/",
- "basePath": "/autoscaler/v1beta2/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "autoscaler/v1beta2/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/compute": {
- "description": "View and manage your Google Compute Engine resources"
- },
- "https://www.googleapis.com/auth/compute.readonly": {
- "description": "View your Google Compute Engine resources"
- }
- }
- }
- },
- "schemas": {
- "Autoscaler": {
- "id": "Autoscaler",
- "type": "object",
- "description": "Cloud Autoscaler resource.",
- "properties": {
- "autoscalingPolicy": {
- "$ref": "AutoscalingPolicy",
- "description": "Configuration parameters for autoscaling algorithm."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource provided by the client."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#autoscaler"
- },
- "name": {
- "type": "string",
- "description": "Name of the Autoscaler resource. Must be unique per project and zone."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] A self-link to the Autoscaler configuration resource."
- },
- "target": {
- "type": "string",
- "description": "URL to the entity which will be autoscaled. Currently the only supported value is ReplicaPool?s URL. Note: it is illegal to specify multiple Autoscalers for the same target."
- }
- }
- },
- "AutoscalerListResponse": {
- "id": "AutoscalerListResponse",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "Autoscaler resources.",
- "items": {
- "$ref": "Autoscaler"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#autoscalerList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output only] A token used to continue a truncated list request."
- }
- }
- },
- "AutoscalingPolicy": {
- "id": "AutoscalingPolicy",
- "type": "object",
- "description": "Cloud Autoscaler policy.",
- "properties": {
- "coolDownPeriodSec": {
- "type": "integer",
- "description": "The number of seconds that the Autoscaler should wait between two succeeding changes to the number of virtual machines. You should define an interval that is at least as long as the initialization time of a virtual machine and the time it may take for replica pool to create the virtual machine. The default is 60 seconds.",
- "format": "int32"
- },
- "cpuUtilization": {
- "$ref": "AutoscalingPolicyCpuUtilization",
- "description": "Exactly one utilization policy should be provided. Configuration parameters of CPU based autoscaling policy."
- },
- "customMetricUtilizations": {
- "type": "array",
- "description": "Configuration parameters of autoscaling based on custom metric.",
- "items": {
- "$ref": "AutoscalingPolicyCustomMetricUtilization"
- }
- },
- "loadBalancingUtilization": {
- "$ref": "AutoscalingPolicyLoadBalancingUtilization",
- "description": "Configuration parameters of autoscaling based on load balancer."
- },
- "maxNumReplicas": {
- "type": "integer",
- "description": "The maximum number of replicas that the Autoscaler can scale up to.",
- "format": "int32"
- },
- "minNumReplicas": {
- "type": "integer",
- "description": "The minimum number of replicas that the Autoscaler can scale down to.",
- "format": "int32"
- }
- }
- },
- "AutoscalingPolicyCpuUtilization": {
- "id": "AutoscalingPolicyCpuUtilization",
- "type": "object",
- "description": "CPU utilization policy.",
- "properties": {
- "utilizationTarget": {
- "type": "number",
- "description": "The target utilization that the Autoscaler should maintain. It is represented as a fraction of used cores. For example: 6 cores used in 8-core VM are represented here as 0.75. Must be a float value between (0, 1]. If not defined, the default is 0.8.",
- "format": "double"
- }
- }
- },
- "AutoscalingPolicyCustomMetricUtilization": {
- "id": "AutoscalingPolicyCustomMetricUtilization",
- "type": "object",
- "description": "Custom utilization metric policy.",
- "properties": {
- "metric": {
- "type": "string",
- "description": "Identifier of the metric. It should be a Cloud Monitoring metric. The metric can not have negative values. The metric should be an utilization metric (increasing number of VMs handling requests x times should reduce average value of the metric roughly x times). For example you could use: compute.googleapis.com/instance/network/received_bytes_count."
- },
- "utilizationTarget": {
- "type": "number",
- "description": "Target value of the metric which Autoscaler should maintain. Must be a positive value.",
- "format": "double"
- },
- "utilizationTargetType": {
- "type": "string",
- "description": "Defines type in which utilization_target is expressed."
- }
- }
- },
- "AutoscalingPolicyLoadBalancingUtilization": {
- "id": "AutoscalingPolicyLoadBalancingUtilization",
- "type": "object",
- "description": "Load balancing utilization policy.",
- "properties": {
- "utilizationTarget": {
- "type": "number",
- "description": "Fraction of backend capacity utilization (set in HTTP load balancing configuration) that Autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8. For example if your maxRatePerInstance capacity (in HTTP Load Balancing configuration) is set at 10 and you would like to keep number of instances such that each instance receives 7 QPS on average, set this to 0.7.",
- "format": "double"
- }
- }
- },
- "DeprecationStatus": {
- "id": "DeprecationStatus",
- "type": "object",
- "properties": {
- "deleted": {
- "type": "string"
- },
- "deprecated": {
- "type": "string"
- },
- "obsolete": {
- "type": "string"
- },
- "replacement": {
- "type": "string"
- },
- "state": {
- "type": "string"
- }
- }
- },
- "Operation": {
- "id": "Operation",
- "type": "object",
- "properties": {
- "clientOperationId": {
- "type": "string"
- },
- "creationTimestamp": {
- "type": "string"
- },
- "endTime": {
- "type": "string"
- },
- "error": {
- "type": "object",
- "properties": {
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string"
- },
- "location": {
- "type": "string"
- },
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "httpErrorMessage": {
- "type": "string"
- },
- "httpErrorStatusCode": {
- "type": "integer",
- "format": "int32"
- },
- "id": {
- "type": "string",
- "format": "uint64"
- },
- "insertTime": {
- "type": "string"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#Operation for Operation resources.",
- "default": "autoscaler#operation"
- },
- "name": {
- "type": "string"
- },
- "operationType": {
- "type": "string"
- },
- "progress": {
- "type": "integer",
- "format": "int32"
- },
- "region": {
- "type": "string"
- },
- "selfLink": {
- "type": "string"
- },
- "startTime": {
- "type": "string"
- },
- "status": {
- "type": "string"
- },
- "statusMessage": {
- "type": "string"
- },
- "targetId": {
- "type": "string",
- "format": "uint64"
- },
- "targetLink": {
- "type": "string"
- },
- "user": {
- "type": "string"
- },
- "warnings": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string"
- },
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string"
- },
- "value": {
- "type": "string"
- }
- }
- }
- },
- "message": {
- "type": "string"
- }
- }
- }
- },
- "zone": {
- "type": "string"
- }
- }
- },
- "OperationList": {
- "id": "OperationList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "$ref": "Operation"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#operations for Operations resource.",
- "default": "autoscaler#operationList"
- },
- "nextPageToken": {
- "type": "string"
- },
- "selfLink": {
- "type": "string"
- }
- }
- },
- "Zone": {
- "id": "Zone",
- "type": "object",
- "properties": {
- "creationTimestamp": {
- "type": "string"
- },
- "deprecated": {
- "$ref": "DeprecationStatus"
- },
- "description": {
- "type": "string"
- },
- "id": {
- "type": "string",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always kind#zone for zones.",
- "default": "autoscaler#zone"
- },
- "maintenanceWindows": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "beginTime": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "endTime": {
- "type": "string"
- },
- "name": {
- "type": "string"
- }
- }
- }
- },
- "name": {
- "type": "string"
- },
- "region": {
- "type": "string"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server defined URL for the resource."
- },
- "status": {
- "type": "string"
- }
- }
- },
- "ZoneList": {
- "id": "ZoneList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "$ref": "Zone"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "autoscaler#zoneList"
- },
- "nextPageToken": {
- "type": "string"
- },
- "selfLink": {
- "type": "string",
- "description": "Server defined URL for this resource (output only)."
- }
- }
- }
- },
- "resources": {
- "autoscalers": {
- "methods": {
- "delete": {
- "id": "autoscaler.autoscalers.delete",
- "path": "projects/{project}/zones/{zone}/autoscalers/{autoscaler}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified Autoscaler resource.",
- "parameters": {
- "autoscaler": {
- "type": "string",
- "description": "Name of the Autoscaler resource.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID of Autoscaler resource.",
- "required": true,
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Zone name of Autoscaler resource.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "autoscaler"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "autoscaler.autoscalers.get",
- "path": "projects/{project}/zones/{zone}/autoscalers/{autoscaler}",
- "httpMethod": "GET",
- "description": "Gets the specified Autoscaler resource.",
- "parameters": {
- "autoscaler": {
- "type": "string",
- "description": "Name of the Autoscaler resource.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID of Autoscaler resource.",
- "required": true,
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Zone name of Autoscaler resource.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "autoscaler"
- ],
- "response": {
- "$ref": "Autoscaler"
- },
- "scopes": [
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "autoscaler.autoscalers.insert",
- "path": "projects/{project}/zones/{zone}/autoscalers",
- "httpMethod": "POST",
- "description": "Adds new Autoscaler resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID of Autoscaler resource.",
- "required": true,
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Zone name of Autoscaler resource.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "request": {
- "$ref": "Autoscaler"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "autoscaler.autoscalers.list",
- "path": "projects/{project}/zones/{zone}/autoscalers",
- "httpMethod": "GET",
- "description": "Lists all Autoscaler resources in this zone.",
- "parameters": {
- "filter": {
- "type": "string",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID of Autoscaler resource.",
- "required": true,
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Zone name of Autoscaler resource.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "response": {
- "$ref": "AutoscalerListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "patch": {
- "id": "autoscaler.autoscalers.patch",
- "path": "projects/{project}/zones/{zone}/autoscalers/{autoscaler}",
- "httpMethod": "PATCH",
- "description": "Update the entire content of the Autoscaler resource. This method supports patch semantics.",
- "parameters": {
- "autoscaler": {
- "type": "string",
- "description": "Name of the Autoscaler resource.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID of Autoscaler resource.",
- "required": true,
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Zone name of Autoscaler resource.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "autoscaler"
- ],
- "request": {
- "$ref": "Autoscaler"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "update": {
- "id": "autoscaler.autoscalers.update",
- "path": "projects/{project}/zones/{zone}/autoscalers/{autoscaler}",
- "httpMethod": "PUT",
- "description": "Update the entire content of the Autoscaler resource.",
- "parameters": {
- "autoscaler": {
- "type": "string",
- "description": "Name of the Autoscaler resource.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID of Autoscaler resource.",
- "required": true,
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Zone name of Autoscaler resource.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "autoscaler"
- ],
- "request": {
- "$ref": "Autoscaler"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "zoneOperations": {
- "methods": {
- "delete": {
- "id": "autoscaler.zoneOperations.delete",
- "path": "{project}/zones/{zone}/operations/{operation}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified zone-specific operation resource.",
- "parameters": {
- "operation": {
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "operation"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "autoscaler.zoneOperations.get",
- "path": "{project}/zones/{zone}/operations/{operation}",
- "httpMethod": "GET",
- "description": "Retrieves the specified zone-specific operation resource.",
- "parameters": {
- "operation": {
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "operation"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "list": {
- "id": "autoscaler.zoneOperations.list",
- "path": "{project}/zones/{zone}/operations",
- "httpMethod": "GET",
- "description": "Retrieves the list of operation resources contained within the specified zone.",
- "parameters": {
- "filter": {
- "type": "string",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "location": "query"
- },
- "project": {
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "response": {
- "$ref": "OperationList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "zones": {
- "methods": {
- "list": {
- "id": "autoscaler.zones.list",
- "path": "{project}/zones",
- "httpMethod": "GET",
- "description": "",
- "parameters": {
- "filter": {
- "type": "string",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "location": "query"
- },
- "project": {
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "ZoneList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/autoscaler/v1beta2/autoscaler-gen.go b/vendor/google.golang.org/api/autoscaler/v1beta2/autoscaler-gen.go
deleted file mode 100644
index 71439abe..00000000
--- a/vendor/google.golang.org/api/autoscaler/v1beta2/autoscaler-gen.go
+++ /dev/null
@@ -1,2111 +0,0 @@
-// Package autoscaler provides access to the Google Compute Engine Autoscaler API.
-//
-// See http://developers.google.com/compute/docs/autoscaler
-//
-// Usage example:
-//
-// import "google.golang.org/api/autoscaler/v1beta2"
-// ...
-// autoscalerService, err := autoscaler.New(oauthHttpClient)
-package autoscaler // import "google.golang.org/api/autoscaler/v1beta2"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "autoscaler:v1beta2"
-const apiName = "autoscaler"
-const apiVersion = "v1beta2"
-const basePath = "https://www.googleapis.com/autoscaler/v1beta2/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your Google Compute Engine resources
- ComputeScope = "https://www.googleapis.com/auth/compute"
-
- // View your Google Compute Engine resources
- ComputeReadonlyScope = "https://www.googleapis.com/auth/compute.readonly"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Autoscalers = NewAutoscalersService(s)
- s.ZoneOperations = NewZoneOperationsService(s)
- s.Zones = NewZonesService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Autoscalers *AutoscalersService
-
- ZoneOperations *ZoneOperationsService
-
- Zones *ZonesService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewAutoscalersService(s *Service) *AutoscalersService {
- rs := &AutoscalersService{s: s}
- return rs
-}
-
-type AutoscalersService struct {
- s *Service
-}
-
-func NewZoneOperationsService(s *Service) *ZoneOperationsService {
- rs := &ZoneOperationsService{s: s}
- return rs
-}
-
-type ZoneOperationsService struct {
- s *Service
-}
-
-func NewZonesService(s *Service) *ZonesService {
- rs := &ZonesService{s: s}
- return rs
-}
-
-type ZonesService struct {
- s *Service
-}
-
-// Autoscaler: Cloud Autoscaler resource.
-type Autoscaler struct {
- // AutoscalingPolicy: Configuration parameters for autoscaling
- // algorithm.
- AutoscalingPolicy *AutoscalingPolicy `json:"autoscalingPolicy,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource provided
- // by the client.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the Autoscaler resource. Must be unique per project and
- // zone.
- Name string `json:"name,omitempty"`
-
- // SelfLink: [Output Only] A self-link to the Autoscaler configuration
- // resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Target: URL to the entity which will be autoscaled. Currently the
- // only supported value is ReplicaPool?s URL. Note: it is illegal to
- // specify multiple Autoscalers for the same target.
- Target string `json:"target,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AutoscalingPolicy")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Autoscaler) MarshalJSON() ([]byte, error) {
- type noMethod Autoscaler
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AutoscalerListResponse struct {
- // Items: Autoscaler resources.
- Items []*Autoscaler `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AutoscalerListResponse) MarshalJSON() ([]byte, error) {
- type noMethod AutoscalerListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AutoscalingPolicy: Cloud Autoscaler policy.
-type AutoscalingPolicy struct {
- // CoolDownPeriodSec: The number of seconds that the Autoscaler should
- // wait between two succeeding changes to the number of virtual
- // machines. You should define an interval that is at least as long as
- // the initialization time of a virtual machine and the time it may take
- // for replica pool to create the virtual machine. The default is 60
- // seconds.
- CoolDownPeriodSec int64 `json:"coolDownPeriodSec,omitempty"`
-
- // CpuUtilization: Exactly one utilization policy should be provided.
- // Configuration parameters of CPU based autoscaling policy.
- CpuUtilization *AutoscalingPolicyCpuUtilization `json:"cpuUtilization,omitempty"`
-
- // CustomMetricUtilizations: Configuration parameters of autoscaling
- // based on custom metric.
- CustomMetricUtilizations []*AutoscalingPolicyCustomMetricUtilization `json:"customMetricUtilizations,omitempty"`
-
- // LoadBalancingUtilization: Configuration parameters of autoscaling
- // based on load balancer.
- LoadBalancingUtilization *AutoscalingPolicyLoadBalancingUtilization `json:"loadBalancingUtilization,omitempty"`
-
- // MaxNumReplicas: The maximum number of replicas that the Autoscaler
- // can scale up to.
- MaxNumReplicas int64 `json:"maxNumReplicas,omitempty"`
-
- // MinNumReplicas: The minimum number of replicas that the Autoscaler
- // can scale down to.
- MinNumReplicas int64 `json:"minNumReplicas,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CoolDownPeriodSec")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AutoscalingPolicy) MarshalJSON() ([]byte, error) {
- type noMethod AutoscalingPolicy
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AutoscalingPolicyCpuUtilization: CPU utilization policy.
-type AutoscalingPolicyCpuUtilization struct {
- // UtilizationTarget: The target utilization that the Autoscaler should
- // maintain. It is represented as a fraction of used cores. For example:
- // 6 cores used in 8-core VM are represented here as 0.75. Must be a
- // float value between (0, 1]. If not defined, the default is 0.8.
- UtilizationTarget float64 `json:"utilizationTarget,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "UtilizationTarget")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AutoscalingPolicyCpuUtilization) MarshalJSON() ([]byte, error) {
- type noMethod AutoscalingPolicyCpuUtilization
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AutoscalingPolicyCustomMetricUtilization: Custom utilization metric
-// policy.
-type AutoscalingPolicyCustomMetricUtilization struct {
- // Metric: Identifier of the metric. It should be a Cloud Monitoring
- // metric. The metric can not have negative values. The metric should be
- // an utilization metric (increasing number of VMs handling requests x
- // times should reduce average value of the metric roughly x times). For
- // example you could use:
- // compute.googleapis.com/instance/network/received_bytes_count.
- Metric string `json:"metric,omitempty"`
-
- // UtilizationTarget: Target value of the metric which Autoscaler should
- // maintain. Must be a positive value.
- UtilizationTarget float64 `json:"utilizationTarget,omitempty"`
-
- // UtilizationTargetType: Defines type in which utilization_target is
- // expressed.
- UtilizationTargetType string `json:"utilizationTargetType,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Metric") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AutoscalingPolicyCustomMetricUtilization) MarshalJSON() ([]byte, error) {
- type noMethod AutoscalingPolicyCustomMetricUtilization
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AutoscalingPolicyLoadBalancingUtilization: Load balancing utilization
-// policy.
-type AutoscalingPolicyLoadBalancingUtilization struct {
- // UtilizationTarget: Fraction of backend capacity utilization (set in
- // HTTP load balancing configuration) that Autoscaler should maintain.
- // Must be a positive float value. If not defined, the default is 0.8.
- // For example if your maxRatePerInstance capacity (in HTTP Load
- // Balancing configuration) is set at 10 and you would like to keep
- // number of instances such that each instance receives 7 QPS on
- // average, set this to 0.7.
- UtilizationTarget float64 `json:"utilizationTarget,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "UtilizationTarget")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AutoscalingPolicyLoadBalancingUtilization) MarshalJSON() ([]byte, error) {
- type noMethod AutoscalingPolicyLoadBalancingUtilization
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DeprecationStatus struct {
- Deleted string `json:"deleted,omitempty"`
-
- Deprecated string `json:"deprecated,omitempty"`
-
- Obsolete string `json:"obsolete,omitempty"`
-
- Replacement string `json:"replacement,omitempty"`
-
- State string `json:"state,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Deleted") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DeprecationStatus) MarshalJSON() ([]byte, error) {
- type noMethod DeprecationStatus
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Operation struct {
- ClientOperationId string `json:"clientOperationId,omitempty"`
-
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- EndTime string `json:"endTime,omitempty"`
-
- Error *OperationError `json:"error,omitempty"`
-
- HttpErrorMessage string `json:"httpErrorMessage,omitempty"`
-
- HttpErrorStatusCode int64 `json:"httpErrorStatusCode,omitempty"`
-
- Id uint64 `json:"id,omitempty,string"`
-
- InsertTime string `json:"insertTime,omitempty"`
-
- // Kind: [Output Only] Type of the resource. Always compute#Operation
- // for Operation resources.
- Kind string `json:"kind,omitempty"`
-
- Name string `json:"name,omitempty"`
-
- OperationType string `json:"operationType,omitempty"`
-
- Progress int64 `json:"progress,omitempty"`
-
- Region string `json:"region,omitempty"`
-
- SelfLink string `json:"selfLink,omitempty"`
-
- StartTime string `json:"startTime,omitempty"`
-
- Status string `json:"status,omitempty"`
-
- StatusMessage string `json:"statusMessage,omitempty"`
-
- TargetId uint64 `json:"targetId,omitempty,string"`
-
- TargetLink string `json:"targetLink,omitempty"`
-
- User string `json:"user,omitempty"`
-
- Warnings []*OperationWarnings `json:"warnings,omitempty"`
-
- Zone string `json:"zone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ClientOperationId")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Operation) MarshalJSON() ([]byte, error) {
- type noMethod Operation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationError struct {
- Errors []*OperationErrorErrors `json:"errors,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Errors") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationError) MarshalJSON() ([]byte, error) {
- type noMethod OperationError
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationErrorErrors struct {
- Code string `json:"code,omitempty"`
-
- Location string `json:"location,omitempty"`
-
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationErrorErrors) MarshalJSON() ([]byte, error) {
- type noMethod OperationErrorErrors
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationWarnings struct {
- Code string `json:"code,omitempty"`
-
- Data []*OperationWarningsData `json:"data,omitempty"`
-
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationWarnings) MarshalJSON() ([]byte, error) {
- type noMethod OperationWarnings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationWarningsData struct {
- Key string `json:"key,omitempty"`
-
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationWarningsData) MarshalJSON() ([]byte, error) {
- type noMethod OperationWarningsData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationList struct {
- Id string `json:"id,omitempty"`
-
- Items []*Operation `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#operations for
- // Operations resource.
- Kind string `json:"kind,omitempty"`
-
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationList) MarshalJSON() ([]byte, error) {
- type noMethod OperationList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Zone struct {
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- Deprecated *DeprecationStatus `json:"deprecated,omitempty"`
-
- Description string `json:"description,omitempty"`
-
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always kind#zone for zones.
- Kind string `json:"kind,omitempty"`
-
- MaintenanceWindows []*ZoneMaintenanceWindows `json:"maintenanceWindows,omitempty"`
-
- Name string `json:"name,omitempty"`
-
- Region string `json:"region,omitempty"`
-
- // SelfLink: [Output Only] Server defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- Status string `json:"status,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Zone) MarshalJSON() ([]byte, error) {
- type noMethod Zone
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ZoneMaintenanceWindows struct {
- BeginTime string `json:"beginTime,omitempty"`
-
- Description string `json:"description,omitempty"`
-
- EndTime string `json:"endTime,omitempty"`
-
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BeginTime") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ZoneMaintenanceWindows) MarshalJSON() ([]byte, error) {
- type noMethod ZoneMaintenanceWindows
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ZoneList struct {
- Id string `json:"id,omitempty"`
-
- Items []*Zone `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: Server defined URL for this resource (output only).
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ZoneList) MarshalJSON() ([]byte, error) {
- type noMethod ZoneList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "autoscaler.autoscalers.delete":
-
-type AutoscalersDeleteCall struct {
- s *Service
- project string
- zone string
- autoscaler string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified Autoscaler resource.
-func (r *AutoscalersService) Delete(project string, zone string, autoscaler string) *AutoscalersDeleteCall {
- c := &AutoscalersDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.autoscaler = autoscaler
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AutoscalersDeleteCall) Fields(s ...googleapi.Field) *AutoscalersDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AutoscalersDeleteCall) Context(ctx context.Context) *AutoscalersDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AutoscalersDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{project}/zones/{zone}/autoscalers/{autoscaler}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "autoscaler": c.autoscaler,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "autoscaler.autoscalers.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AutoscalersDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified Autoscaler resource.",
- // "httpMethod": "DELETE",
- // "id": "autoscaler.autoscalers.delete",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "autoscaler"
- // ],
- // "parameters": {
- // "autoscaler": {
- // "description": "Name of the Autoscaler resource.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID of Autoscaler resource.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Zone name of Autoscaler resource.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "projects/{project}/zones/{zone}/autoscalers/{autoscaler}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "autoscaler.autoscalers.get":
-
-type AutoscalersGetCall struct {
- s *Service
- project string
- zone string
- autoscaler string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets the specified Autoscaler resource.
-func (r *AutoscalersService) Get(project string, zone string, autoscaler string) *AutoscalersGetCall {
- c := &AutoscalersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.autoscaler = autoscaler
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AutoscalersGetCall) Fields(s ...googleapi.Field) *AutoscalersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AutoscalersGetCall) IfNoneMatch(entityTag string) *AutoscalersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AutoscalersGetCall) Context(ctx context.Context) *AutoscalersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AutoscalersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{project}/zones/{zone}/autoscalers/{autoscaler}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "autoscaler": c.autoscaler,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "autoscaler.autoscalers.get" call.
-// Exactly one of *Autoscaler or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Autoscaler.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AutoscalersGetCall) Do() (*Autoscaler, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Autoscaler{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the specified Autoscaler resource.",
- // "httpMethod": "GET",
- // "id": "autoscaler.autoscalers.get",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "autoscaler"
- // ],
- // "parameters": {
- // "autoscaler": {
- // "description": "Name of the Autoscaler resource.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID of Autoscaler resource.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Zone name of Autoscaler resource.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "projects/{project}/zones/{zone}/autoscalers/{autoscaler}",
- // "response": {
- // "$ref": "Autoscaler"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "autoscaler.autoscalers.insert":
-
-type AutoscalersInsertCall struct {
- s *Service
- project string
- zone string
- autoscaler *Autoscaler
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Adds new Autoscaler resource.
-func (r *AutoscalersService) Insert(project string, zone string, autoscaler *Autoscaler) *AutoscalersInsertCall {
- c := &AutoscalersInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.autoscaler = autoscaler
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AutoscalersInsertCall) Fields(s ...googleapi.Field) *AutoscalersInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AutoscalersInsertCall) Context(ctx context.Context) *AutoscalersInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AutoscalersInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.autoscaler)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{project}/zones/{zone}/autoscalers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "autoscaler.autoscalers.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AutoscalersInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Adds new Autoscaler resource.",
- // "httpMethod": "POST",
- // "id": "autoscaler.autoscalers.insert",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID of Autoscaler resource.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Zone name of Autoscaler resource.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "projects/{project}/zones/{zone}/autoscalers",
- // "request": {
- // "$ref": "Autoscaler"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "autoscaler.autoscalers.list":
-
-type AutoscalersListCall struct {
- s *Service
- project string
- zone string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all Autoscaler resources in this zone.
-func (r *AutoscalersService) List(project string, zone string) *AutoscalersListCall {
- c := &AutoscalersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- return c
-}
-
-// Filter sets the optional parameter "filter":
-func (c *AutoscalersListCall) Filter(filter string) *AutoscalersListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults":
-func (c *AutoscalersListCall) MaxResults(maxResults int64) *AutoscalersListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken":
-func (c *AutoscalersListCall) PageToken(pageToken string) *AutoscalersListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AutoscalersListCall) Fields(s ...googleapi.Field) *AutoscalersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AutoscalersListCall) IfNoneMatch(entityTag string) *AutoscalersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AutoscalersListCall) Context(ctx context.Context) *AutoscalersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AutoscalersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{project}/zones/{zone}/autoscalers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "autoscaler.autoscalers.list" call.
-// Exactly one of *AutoscalerListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AutoscalerListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AutoscalersListCall) Do() (*AutoscalerListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AutoscalerListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all Autoscaler resources in this zone.",
- // "httpMethod": "GET",
- // "id": "autoscaler.autoscalers.list",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "filter": {
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID of Autoscaler resource.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Zone name of Autoscaler resource.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "projects/{project}/zones/{zone}/autoscalers",
- // "response": {
- // "$ref": "AutoscalerListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "autoscaler.autoscalers.patch":
-
-type AutoscalersPatchCall struct {
- s *Service
- project string
- zone string
- autoscaler string
- autoscaler2 *Autoscaler
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Update the entire content of the Autoscaler resource. This
-// method supports patch semantics.
-func (r *AutoscalersService) Patch(project string, zone string, autoscaler string, autoscaler2 *Autoscaler) *AutoscalersPatchCall {
- c := &AutoscalersPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.autoscaler = autoscaler
- c.autoscaler2 = autoscaler2
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AutoscalersPatchCall) Fields(s ...googleapi.Field) *AutoscalersPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AutoscalersPatchCall) Context(ctx context.Context) *AutoscalersPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AutoscalersPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.autoscaler2)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{project}/zones/{zone}/autoscalers/{autoscaler}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "autoscaler": c.autoscaler,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "autoscaler.autoscalers.patch" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AutoscalersPatchCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update the entire content of the Autoscaler resource. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "autoscaler.autoscalers.patch",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "autoscaler"
- // ],
- // "parameters": {
- // "autoscaler": {
- // "description": "Name of the Autoscaler resource.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID of Autoscaler resource.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Zone name of Autoscaler resource.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "projects/{project}/zones/{zone}/autoscalers/{autoscaler}",
- // "request": {
- // "$ref": "Autoscaler"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "autoscaler.autoscalers.update":
-
-type AutoscalersUpdateCall struct {
- s *Service
- project string
- zone string
- autoscaler string
- autoscaler2 *Autoscaler
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Update the entire content of the Autoscaler resource.
-func (r *AutoscalersService) Update(project string, zone string, autoscaler string, autoscaler2 *Autoscaler) *AutoscalersUpdateCall {
- c := &AutoscalersUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.autoscaler = autoscaler
- c.autoscaler2 = autoscaler2
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AutoscalersUpdateCall) Fields(s ...googleapi.Field) *AutoscalersUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AutoscalersUpdateCall) Context(ctx context.Context) *AutoscalersUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AutoscalersUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.autoscaler2)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{project}/zones/{zone}/autoscalers/{autoscaler}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "autoscaler": c.autoscaler,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "autoscaler.autoscalers.update" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AutoscalersUpdateCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update the entire content of the Autoscaler resource.",
- // "httpMethod": "PUT",
- // "id": "autoscaler.autoscalers.update",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "autoscaler"
- // ],
- // "parameters": {
- // "autoscaler": {
- // "description": "Name of the Autoscaler resource.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID of Autoscaler resource.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Zone name of Autoscaler resource.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "projects/{project}/zones/{zone}/autoscalers/{autoscaler}",
- // "request": {
- // "$ref": "Autoscaler"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "autoscaler.zoneOperations.delete":
-
-type ZoneOperationsDeleteCall struct {
- s *Service
- project string
- zone string
- operation string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified zone-specific operation resource.
-func (r *ZoneOperationsService) Delete(project string, zone string, operation string) *ZoneOperationsDeleteCall {
- c := &ZoneOperationsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.operation = operation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ZoneOperationsDeleteCall) Fields(s ...googleapi.Field) *ZoneOperationsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ZoneOperationsDeleteCall) Context(ctx context.Context) *ZoneOperationsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ZoneOperationsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/operations/{operation}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "operation": c.operation,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "autoscaler.zoneOperations.delete" call.
-func (c *ZoneOperationsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes the specified zone-specific operation resource.",
- // "httpMethod": "DELETE",
- // "id": "autoscaler.zoneOperations.delete",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "operation"
- // ],
- // "parameters": {
- // "operation": {
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/operations/{operation}",
- // "scopes": [
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "autoscaler.zoneOperations.get":
-
-type ZoneOperationsGetCall struct {
- s *Service
- project string
- zone string
- operation string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves the specified zone-specific operation resource.
-func (r *ZoneOperationsService) Get(project string, zone string, operation string) *ZoneOperationsGetCall {
- c := &ZoneOperationsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.operation = operation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ZoneOperationsGetCall) Fields(s ...googleapi.Field) *ZoneOperationsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ZoneOperationsGetCall) IfNoneMatch(entityTag string) *ZoneOperationsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ZoneOperationsGetCall) Context(ctx context.Context) *ZoneOperationsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ZoneOperationsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/operations/{operation}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "operation": c.operation,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "autoscaler.zoneOperations.get" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ZoneOperationsGetCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the specified zone-specific operation resource.",
- // "httpMethod": "GET",
- // "id": "autoscaler.zoneOperations.get",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "operation"
- // ],
- // "parameters": {
- // "operation": {
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/operations/{operation}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "autoscaler.zoneOperations.list":
-
-type ZoneOperationsListCall struct {
- s *Service
- project string
- zone string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of operation resources contained within the
-// specified zone.
-func (r *ZoneOperationsService) List(project string, zone string) *ZoneOperationsListCall {
- c := &ZoneOperationsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- return c
-}
-
-// Filter sets the optional parameter "filter":
-func (c *ZoneOperationsListCall) Filter(filter string) *ZoneOperationsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults":
-func (c *ZoneOperationsListCall) MaxResults(maxResults int64) *ZoneOperationsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken":
-func (c *ZoneOperationsListCall) PageToken(pageToken string) *ZoneOperationsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ZoneOperationsListCall) Fields(s ...googleapi.Field) *ZoneOperationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ZoneOperationsListCall) IfNoneMatch(entityTag string) *ZoneOperationsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ZoneOperationsListCall) Context(ctx context.Context) *ZoneOperationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ZoneOperationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/operations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "autoscaler.zoneOperations.list" call.
-// Exactly one of *OperationList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *OperationList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ZoneOperationsListCall) Do() (*OperationList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OperationList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of operation resources contained within the specified zone.",
- // "httpMethod": "GET",
- // "id": "autoscaler.zoneOperations.list",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "filter": {
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/operations",
- // "response": {
- // "$ref": "OperationList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "autoscaler.zones.list":
-
-type ZonesListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List:
-func (r *ZonesService) List(project string) *ZonesListCall {
- c := &ZonesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter":
-func (c *ZonesListCall) Filter(filter string) *ZonesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults":
-func (c *ZonesListCall) MaxResults(maxResults int64) *ZonesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken":
-func (c *ZonesListCall) PageToken(pageToken string) *ZonesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ZonesListCall) Fields(s ...googleapi.Field) *ZonesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ZonesListCall) IfNoneMatch(entityTag string) *ZonesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ZonesListCall) Context(ctx context.Context) *ZonesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ZonesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "autoscaler.zones.list" call.
-// Exactly one of *ZoneList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *ZoneList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ZonesListCall) Do() (*ZoneList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ZoneList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "",
- // "httpMethod": "GET",
- // "id": "autoscaler.zones.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones",
- // "response": {
- // "$ref": "ZoneList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/bigquery/v2/bigquery-api.json b/vendor/google.golang.org/api/bigquery/v2/bigquery-api.json
deleted file mode 100644
index 8e27c7fb..00000000
--- a/vendor/google.golang.org/api/bigquery/v2/bigquery-api.json
+++ /dev/null
@@ -1,2348 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/_4HD2Yk5KBJwf4ZwHLl0cnazBI0\"",
- "discoveryVersion": "v1",
- "id": "bigquery:v2",
- "name": "bigquery",
- "version": "v2",
- "revision": "20150911",
- "title": "BigQuery API",
- "description": "A data platform for customers to create, manage, share and query data.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/search-16.gif",
- "x32": "https://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/bigquery/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/bigquery/v2/",
- "basePath": "/bigquery/v2/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "bigquery/v2/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "csv",
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of text/csv",
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/bigquery": {
- "description": "View and manage your data in Google BigQuery"
- },
- "https://www.googleapis.com/auth/bigquery.insertdata": {
- "description": "Insert data into Google BigQuery"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/devstorage.full_control": {
- "description": "Manage your data and permissions in Google Cloud Storage"
- },
- "https://www.googleapis.com/auth/devstorage.read_only": {
- "description": "View your data in Google Cloud Storage"
- },
- "https://www.googleapis.com/auth/devstorage.read_write": {
- "description": "Manage your data in Google Cloud Storage"
- }
- }
- }
- },
- "schemas": {
- "CsvOptions": {
- "id": "CsvOptions",
- "type": "object",
- "properties": {
- "allowJaggedRows": {
- "type": "boolean",
- "description": "[Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false."
- },
- "allowQuotedNewlines": {
- "type": "boolean",
- "description": "[Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false."
- },
- "encoding": {
- "type": "string",
- "description": "[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties."
- },
- "fieldDelimiter": {
- "type": "string",
- "description": "[Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence \"\\t\" to specify a tab separator. The default value is a comma (',')."
- },
- "quote": {
- "type": "string",
- "description": "[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('\"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.",
- "default": "\"",
- "pattern": ".?"
- },
- "skipLeadingRows": {
- "type": "integer",
- "description": "[Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.",
- "format": "int32"
- }
- }
- },
- "Dataset": {
- "id": "Dataset",
- "type": "object",
- "properties": {
- "access": {
- "type": "array",
- "description": "[Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;",
- "items": {
- "type": "object",
- "properties": {
- "domain": {
- "type": "string",
- "description": "[Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: \"example.com\"."
- },
- "groupByEmail": {
- "type": "string",
- "description": "[Pick one] An email address of a Google Group to grant access to."
- },
- "role": {
- "type": "string",
- "description": "[Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READER, WRITER, OWNER."
- },
- "specialGroup": {
- "type": "string",
- "description": "[Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users."
- },
- "userByEmail": {
- "type": "string",
- "description": "[Pick one] An email address of a user to grant access to. For example: fred@example.com."
- },
- "view": {
- "$ref": "TableReference",
- "description": "[Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation."
- }
- }
- }
- },
- "creationTime": {
- "type": "string",
- "description": "[Output-only] The time when this dataset was created, in milliseconds since the epoch.",
- "format": "int64"
- },
- "datasetReference": {
- "$ref": "DatasetReference",
- "description": "[Required] A reference that identifies the dataset."
- },
- "defaultTableExpirationMs": {
- "type": "string",
- "description": "[Experimental] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.",
- "format": "int64"
- },
- "description": {
- "type": "string",
- "description": "[Optional] A user-friendly description of the dataset."
- },
- "etag": {
- "type": "string",
- "description": "[Output-only] A hash of the resource."
- },
- "friendlyName": {
- "type": "string",
- "description": "[Optional] A descriptive name for the dataset."
- },
- "id": {
- "type": "string",
- "description": "[Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field."
- },
- "kind": {
- "type": "string",
- "description": "[Output-only] The resource type.",
- "default": "bigquery#dataset"
- },
- "lastModifiedTime": {
- "type": "string",
- "description": "[Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.",
- "format": "int64"
- },
- "location": {
- "type": "string",
- "description": "[Experimental] The geographic location where the dataset should reside. Possible values include EU and US. The default value is US."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output-only] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource."
- }
- }
- },
- "DatasetList": {
- "id": "DatasetList",
- "type": "object",
- "properties": {
- "datasets": {
- "type": "array",
- "description": "An array of the dataset resources in the project. Each resource contains basic information. For full information about a particular dataset resource, use the Datasets: get method. This property is omitted when there are no datasets in the project.",
- "items": {
- "type": "object",
- "properties": {
- "datasetReference": {
- "$ref": "DatasetReference",
- "description": "The dataset reference. Use this property to access specific parts of the dataset's ID, such as project ID or dataset ID."
- },
- "friendlyName": {
- "type": "string",
- "description": "A descriptive name for the dataset, if one exists."
- },
- "id": {
- "type": "string",
- "description": "The fully-qualified, unique, opaque ID of the dataset."
- },
- "kind": {
- "type": "string",
- "description": "The resource type. This property always returns the value \"bigquery#dataset\".",
- "default": "bigquery#dataset"
- }
- }
- }
- },
- "etag": {
- "type": "string",
- "description": "A hash value of the results page. You can use this property to determine if the page has changed since the last request."
- },
- "kind": {
- "type": "string",
- "description": "The list type. This property always returns the value \"bigquery#datasetList\".",
- "default": "bigquery#datasetList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "A token that can be used to request the next results page. This property is omitted on the final results page."
- }
- }
- },
- "DatasetReference": {
- "id": "DatasetReference",
- "type": "object",
- "properties": {
- "datasetId": {
- "type": "string",
- "description": "[Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.",
- "annotations": {
- "required": [
- "bigquery.datasets.update"
- ]
- }
- },
- "projectId": {
- "type": "string",
- "description": "[Optional] The ID of the project containing this dataset.",
- "annotations": {
- "required": [
- "bigquery.datasets.update"
- ]
- }
- }
- }
- },
- "ErrorProto": {
- "id": "ErrorProto",
- "type": "object",
- "properties": {
- "debugInfo": {
- "type": "string",
- "description": "Debugging information. This property is internal to Google and should not be used."
- },
- "location": {
- "type": "string",
- "description": "Specifies where the error occurred, if present."
- },
- "message": {
- "type": "string",
- "description": "A human-readable description of the error."
- },
- "reason": {
- "type": "string",
- "description": "A short error code that summarizes the error."
- }
- }
- },
- "ExternalDataConfiguration": {
- "id": "ExternalDataConfiguration",
- "type": "object",
- "properties": {
- "compression": {
- "type": "string",
- "description": "[Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE."
- },
- "csvOptions": {
- "$ref": "CsvOptions",
- "description": "Additional properties to set if sourceFormat is set to CSV."
- },
- "ignoreUnknownValues": {
- "type": "boolean",
- "description": "[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names"
- },
- "maxBadRecords": {
- "type": "integer",
- "description": "[Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid.",
- "format": "int32"
- },
- "schema": {
- "$ref": "TableSchema",
- "description": "[Required] The schema for the data."
- },
- "sourceFormat": {
- "type": "string",
- "description": "[Required] The data format. For CSV files, specify \"CSV\". For newline-delimited JSON, specify \"NEWLINE_DELIMITED_JSON\"."
- },
- "sourceUris": {
- "type": "array",
- "description": "[Required] The fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources, plus an additional limit of 10 GB maximum size across all URIs.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "GetQueryResultsResponse": {
- "id": "GetQueryResultsResponse",
- "type": "object",
- "properties": {
- "cacheHit": {
- "type": "boolean",
- "description": "Whether the query result was fetched from the query cache."
- },
- "errors": {
- "type": "array",
- "description": "[Output-only] All errors and warnings encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.",
- "items": {
- "$ref": "ErrorProto"
- }
- },
- "etag": {
- "type": "string",
- "description": "A hash of this response."
- },
- "jobComplete": {
- "type": "boolean",
- "description": "Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available."
- },
- "jobReference": {
- "$ref": "JobReference",
- "description": "Reference to the BigQuery Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults)."
- },
- "kind": {
- "type": "string",
- "description": "The resource type of the response.",
- "default": "bigquery#getQueryResultsResponse"
- },
- "pageToken": {
- "type": "string",
- "description": "A token used for paging results."
- },
- "rows": {
- "type": "array",
- "description": "An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. Present only when the query completes successfully.",
- "items": {
- "$ref": "TableRow"
- }
- },
- "schema": {
- "$ref": "TableSchema",
- "description": "The schema of the results. Present only when the query completes successfully."
- },
- "totalBytesProcessed": {
- "type": "string",
- "description": "The total number of bytes processed for this query.",
- "format": "int64"
- },
- "totalRows": {
- "type": "string",
- "description": "The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. Present only when the query completes successfully.",
- "format": "uint64"
- }
- }
- },
- "Job": {
- "id": "Job",
- "type": "object",
- "properties": {
- "configuration": {
- "$ref": "JobConfiguration",
- "description": "[Required] Describes the job configuration."
- },
- "etag": {
- "type": "string",
- "description": "[Output-only] A hash of this resource."
- },
- "id": {
- "type": "string",
- "description": "[Output-only] Opaque ID field of the job"
- },
- "jobReference": {
- "$ref": "JobReference",
- "description": "[Optional] Reference describing the unique-per-user name of the job."
- },
- "kind": {
- "type": "string",
- "description": "[Output-only] The type of the resource.",
- "default": "bigquery#job"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output-only] A URL that can be used to access this resource again."
- },
- "statistics": {
- "$ref": "JobStatistics",
- "description": "[Output-only] Information about the job, including starting time and ending time of the job."
- },
- "status": {
- "$ref": "JobStatus",
- "description": "[Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete."
- },
- "user_email": {
- "type": "string",
- "description": "[Output-only] Email address of the user who ran the job."
- }
- }
- },
- "JobCancelResponse": {
- "id": "JobCancelResponse",
- "type": "object",
- "properties": {
- "job": {
- "$ref": "Job",
- "description": "The final state of the job."
- },
- "kind": {
- "type": "string",
- "description": "The resource type of the response.",
- "default": "bigquery#jobCancelResponse"
- }
- }
- },
- "JobConfiguration": {
- "id": "JobConfiguration",
- "type": "object",
- "properties": {
- "copy": {
- "$ref": "JobConfigurationTableCopy",
- "description": "[Pick one] Copies a table."
- },
- "dryRun": {
- "type": "boolean",
- "description": "[Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined."
- },
- "extract": {
- "$ref": "JobConfigurationExtract",
- "description": "[Pick one] Configures an extract job."
- },
- "link": {
- "$ref": "JobConfigurationLink",
- "description": "[Pick one] Configures a link job."
- },
- "load": {
- "$ref": "JobConfigurationLoad",
- "description": "[Pick one] Configures a load job."
- },
- "query": {
- "$ref": "JobConfigurationQuery",
- "description": "[Pick one] Configures a query job."
- }
- }
- },
- "JobConfigurationExtract": {
- "id": "JobConfigurationExtract",
- "type": "object",
- "properties": {
- "compression": {
- "type": "string",
- "description": "[Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE."
- },
- "destinationFormat": {
- "type": "string",
- "description": "[Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV."
- },
- "destinationUri": {
- "type": "string",
- "description": "[Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written."
- },
- "destinationUris": {
- "type": "array",
- "description": "[Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.",
- "items": {
- "type": "string"
- }
- },
- "fieldDelimiter": {
- "type": "string",
- "description": "[Optional] Delimiter to use between fields in the exported data. Default is ','"
- },
- "printHeader": {
- "type": "boolean",
- "description": "[Optional] Whether to print out a header row in the results. Default is true.",
- "default": "true"
- },
- "sourceTable": {
- "$ref": "TableReference",
- "description": "[Required] A reference to the table being exported."
- }
- }
- },
- "JobConfigurationLink": {
- "id": "JobConfigurationLink",
- "type": "object",
- "properties": {
- "createDisposition": {
- "type": "string",
- "description": "[Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion."
- },
- "destinationTable": {
- "$ref": "TableReference",
- "description": "[Required] The destination table of the link job."
- },
- "sourceUri": {
- "type": "array",
- "description": "[Required] URI of source table to link.",
- "items": {
- "type": "string"
- }
- },
- "writeDisposition": {
- "type": "string",
- "description": "[Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion."
- }
- }
- },
- "JobConfigurationLoad": {
- "id": "JobConfigurationLoad",
- "type": "object",
- "properties": {
- "allowJaggedRows": {
- "type": "boolean",
- "description": "[Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats."
- },
- "allowQuotedNewlines": {
- "type": "boolean",
- "description": "Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false."
- },
- "createDisposition": {
- "type": "string",
- "description": "[Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion."
- },
- "destinationTable": {
- "$ref": "TableReference",
- "description": "[Required] The destination table to load the data into."
- },
- "encoding": {
- "type": "string",
- "description": "[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties."
- },
- "fieldDelimiter": {
- "type": "string",
- "description": "[Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence \"\\t\" to specify a tab separator. The default value is a comma (',')."
- },
- "ignoreUnknownValues": {
- "type": "boolean",
- "description": "[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names"
- },
- "maxBadRecords": {
- "type": "integer",
- "description": "[Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid.",
- "format": "int32"
- },
- "projectionFields": {
- "type": "array",
- "description": "[Experimental] If sourceFormat is set to \"DATASTORE_BACKUP\", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.",
- "items": {
- "type": "string"
- }
- },
- "quote": {
- "type": "string",
- "description": "[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('\"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.",
- "default": "\"",
- "pattern": ".?"
- },
- "schema": {
- "$ref": "TableSchema",
- "description": "[Optional] The schema for the destination table. The schema can be omitted if the destination table already exists or if the schema can be inferred from the loaded data."
- },
- "schemaInline": {
- "type": "string",
- "description": "[Deprecated] The inline schema. For CSV schemas, specify as \"Field1:Type1[,Field2:Type2]*\". For example, \"foo:STRING, bar:INTEGER, baz:FLOAT\"."
- },
- "schemaInlineFormat": {
- "type": "string",
- "description": "[Deprecated] The format of the schemaInline property."
- },
- "skipLeadingRows": {
- "type": "integer",
- "description": "[Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.",
- "format": "int32"
- },
- "sourceFormat": {
- "type": "string",
- "description": "[Optional] The format of the data files. For CSV files, specify \"CSV\". For datastore backups, specify \"DATASTORE_BACKUP\". For newline-delimited JSON, specify \"NEWLINE_DELIMITED_JSON\". The default value is CSV."
- },
- "sourceUris": {
- "type": "array",
- "description": "[Required] The fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name.",
- "items": {
- "type": "string"
- }
- },
- "writeDisposition": {
- "type": "string",
- "description": "[Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion."
- }
- }
- },
- "JobConfigurationQuery": {
- "id": "JobConfigurationQuery",
- "type": "object",
- "properties": {
- "allowLargeResults": {
- "type": "boolean",
- "description": "If true, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set."
- },
- "createDisposition": {
- "type": "string",
- "description": "[Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion."
- },
- "defaultDataset": {
- "$ref": "DatasetReference",
- "description": "[Optional] Specifies the default dataset to use for unqualified table names in the query."
- },
- "destinationTable": {
- "$ref": "TableReference",
- "description": "[Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results."
- },
- "flattenResults": {
- "type": "boolean",
- "description": "[Optional] Flattens all nested and repeated fields in the query results. The default value is true. allowLargeResults must be true if this is set to false.",
- "default": "true"
- },
- "preserveNulls": {
- "type": "boolean",
- "description": "[Deprecated] This property is deprecated."
- },
- "priority": {
- "type": "string",
- "description": "[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE."
- },
- "query": {
- "type": "string",
- "description": "[Required] BigQuery SQL query to execute."
- },
- "tableDefinitions": {
- "type": "object",
- "description": "[Experimental] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.",
- "additionalProperties": {
- "$ref": "ExternalDataConfiguration"
- }
- },
- "useQueryCache": {
- "type": "boolean",
- "description": "[Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.",
- "default": "true"
- },
- "userDefinedFunctionResources": {
- "type": "array",
- "description": "[Experimental] Describes user-defined function resources used in the query.",
- "items": {
- "$ref": "UserDefinedFunctionResource"
- }
- },
- "writeDisposition": {
- "type": "string",
- "description": "[Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion."
- }
- }
- },
- "JobConfigurationTableCopy": {
- "id": "JobConfigurationTableCopy",
- "type": "object",
- "properties": {
- "createDisposition": {
- "type": "string",
- "description": "[Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion."
- },
- "destinationTable": {
- "$ref": "TableReference",
- "description": "[Required] The destination table"
- },
- "sourceTable": {
- "$ref": "TableReference",
- "description": "[Pick one] Source table to copy."
- },
- "sourceTables": {
- "type": "array",
- "description": "[Pick one] Source tables to copy.",
- "items": {
- "$ref": "TableReference"
- }
- },
- "writeDisposition": {
- "type": "string",
- "description": "[Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion."
- }
- }
- },
- "JobList": {
- "id": "JobList",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "A hash of this page of results."
- },
- "jobs": {
- "type": "array",
- "description": "List of jobs that were requested.",
- "items": {
- "type": "object",
- "properties": {
- "configuration": {
- "$ref": "JobConfiguration",
- "description": "[Full-projection-only] Specifies the job configuration."
- },
- "errorResult": {
- "$ref": "ErrorProto",
- "description": "A result object that will be present only if the job has failed."
- },
- "id": {
- "type": "string",
- "description": "Unique opaque ID of the job."
- },
- "jobReference": {
- "$ref": "JobReference",
- "description": "Job reference uniquely identifying the job."
- },
- "kind": {
- "type": "string",
- "description": "The resource type.",
- "default": "bigquery#job"
- },
- "state": {
- "type": "string",
- "description": "Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed."
- },
- "statistics": {
- "$ref": "JobStatistics",
- "description": "[Output-only] Information about the job, including starting time and ending time of the job."
- },
- "status": {
- "$ref": "JobStatus",
- "description": "[Full-projection-only] Describes the state of the job."
- },
- "user_email": {
- "type": "string",
- "description": "[Full-projection-only] Email address of the user who ran the job."
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "The resource type of the response.",
- "default": "bigquery#jobList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "A token to request the next page of results."
- }
- }
- },
- "JobReference": {
- "id": "JobReference",
- "type": "object",
- "properties": {
- "jobId": {
- "type": "string",
- "description": "[Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.",
- "annotations": {
- "required": [
- "bigquery.jobs.getQueryResults"
- ]
- }
- },
- "projectId": {
- "type": "string",
- "description": "[Required] The ID of the project containing this job.",
- "annotations": {
- "required": [
- "bigquery.jobs.getQueryResults"
- ]
- }
- }
- }
- },
- "JobStatistics": {
- "id": "JobStatistics",
- "type": "object",
- "properties": {
- "creationTime": {
- "type": "string",
- "description": "[Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.",
- "format": "int64"
- },
- "endTime": {
- "type": "string",
- "description": "[Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.",
- "format": "int64"
- },
- "extract": {
- "$ref": "JobStatistics4",
- "description": "[Output-only] Statistics for an extract job."
- },
- "load": {
- "$ref": "JobStatistics3",
- "description": "[Output-only] Statistics for a load job."
- },
- "query": {
- "$ref": "JobStatistics2",
- "description": "[Output-only] Statistics for a query job."
- },
- "startTime": {
- "type": "string",
- "description": "[Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.",
- "format": "int64"
- },
- "totalBytesProcessed": {
- "type": "string",
- "description": "[Output-only] [Deprecated] Use the bytes processed in the query statistics instead.",
- "format": "int64"
- }
- }
- },
- "JobStatistics2": {
- "id": "JobStatistics2",
- "type": "object",
- "properties": {
- "billingTier": {
- "type": "integer",
- "description": "[Output-only] Billing tier for the job.",
- "format": "int32"
- },
- "cacheHit": {
- "type": "boolean",
- "description": "[Output-only] Whether the query result was fetched from the query cache."
- },
- "totalBytesBilled": {
- "type": "string",
- "description": "[Output-only] Total bytes billed for the job.",
- "format": "int64"
- },
- "totalBytesProcessed": {
- "type": "string",
- "description": "[Output-only] Total bytes processed for the job.",
- "format": "int64"
- }
- }
- },
- "JobStatistics3": {
- "id": "JobStatistics3",
- "type": "object",
- "properties": {
- "inputFileBytes": {
- "type": "string",
- "description": "[Output-only] Number of bytes of source data in a load job.",
- "format": "int64"
- },
- "inputFiles": {
- "type": "string",
- "description": "[Output-only] Number of source files in a load job.",
- "format": "int64"
- },
- "outputBytes": {
- "type": "string",
- "description": "[Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.",
- "format": "int64"
- },
- "outputRows": {
- "type": "string",
- "description": "[Output-only] Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.",
- "format": "int64"
- }
- }
- },
- "JobStatistics4": {
- "id": "JobStatistics4",
- "type": "object",
- "properties": {
- "destinationUriFileCounts": {
- "type": "array",
- "description": "[Output-only] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- }
- }
- },
- "JobStatus": {
- "id": "JobStatus",
- "type": "object",
- "properties": {
- "errorResult": {
- "$ref": "ErrorProto",
- "description": "[Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful."
- },
- "errors": {
- "type": "array",
- "description": "[Output-only] All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.",
- "items": {
- "$ref": "ErrorProto"
- }
- },
- "state": {
- "type": "string",
- "description": "[Output-only] Running state of the job."
- }
- }
- },
- "JsonObject": {
- "id": "JsonObject",
- "type": "object",
- "description": "Represents a single JSON object.",
- "additionalProperties": {
- "$ref": "JsonValue"
- }
- },
- "JsonValue": {
- "id": "JsonValue",
- "type": "any"
- },
- "ProjectList": {
- "id": "ProjectList",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "A hash of the page of results"
- },
- "kind": {
- "type": "string",
- "description": "The type of list.",
- "default": "bigquery#projectList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "A token to request the next page of results."
- },
- "projects": {
- "type": "array",
- "description": "Projects to which you have at least READ access.",
- "items": {
- "type": "object",
- "properties": {
- "friendlyName": {
- "type": "string",
- "description": "A descriptive name for this project."
- },
- "id": {
- "type": "string",
- "description": "An opaque ID of this project."
- },
- "kind": {
- "type": "string",
- "description": "The resource type.",
- "default": "bigquery#project"
- },
- "numericId": {
- "type": "string",
- "description": "The numeric ID of this project.",
- "format": "uint64"
- },
- "projectReference": {
- "$ref": "ProjectReference",
- "description": "A unique reference to this project."
- }
- }
- }
- },
- "totalItems": {
- "type": "integer",
- "description": "The total number of projects in the list.",
- "format": "int32"
- }
- }
- },
- "ProjectReference": {
- "id": "ProjectReference",
- "type": "object",
- "properties": {
- "projectId": {
- "type": "string",
- "description": "[Required] ID of the project. Can be either the numeric ID or the assigned ID of the project."
- }
- }
- },
- "QueryRequest": {
- "id": "QueryRequest",
- "type": "object",
- "properties": {
- "defaultDataset": {
- "$ref": "DatasetReference",
- "description": "[Optional] Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be qualified in the format 'datasetId.tableId'."
- },
- "dryRun": {
- "type": "boolean",
- "description": "[Optional] If set to true, BigQuery doesn't run the job. Instead, if the query is valid, BigQuery returns statistics about the job such as how many bytes would be processed. If the query is invalid, an error returns. The default value is false."
- },
- "kind": {
- "type": "string",
- "description": "The resource type of the request.",
- "default": "bigquery#queryRequest"
- },
- "maxResults": {
- "type": "integer",
- "description": "[Optional] The maximum number of rows of data to return per page of results. Setting this flag to a small value such as 1000 and then paging through results might improve reliability when the query result set is large. In addition to this limit, responses are also limited to 10 MB. By default, there is no maximum row count, and only the byte limit applies.",
- "format": "uint32"
- },
- "preserveNulls": {
- "type": "boolean",
- "description": "[Deprecated] This property is deprecated."
- },
- "query": {
- "type": "string",
- "description": "[Required] A query string, following the BigQuery query syntax, of the query to execute. Example: \"SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId]\".",
- "annotations": {
- "required": [
- "bigquery.jobs.query"
- ]
- }
- },
- "timeoutMs": {
- "type": "integer",
- "description": "[Optional] How long to wait for the query to complete, in milliseconds, before the request times out and returns. Note that this is only a timeout for the request, not the query. If the query takes longer to run than the timeout value, the call returns without any results and with the 'jobComplete' flag set to false. You can call GetQueryResults() to wait for the query to complete and read the results. The default value is 10000 milliseconds (10 seconds).",
- "format": "uint32"
- },
- "useQueryCache": {
- "type": "boolean",
- "description": "[Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true.",
- "default": "true"
- }
- }
- },
- "QueryResponse": {
- "id": "QueryResponse",
- "type": "object",
- "properties": {
- "cacheHit": {
- "type": "boolean",
- "description": "Whether the query result was fetched from the query cache."
- },
- "errors": {
- "type": "array",
- "description": "[Output-only] All errors and warnings encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.",
- "items": {
- "$ref": "ErrorProto"
- }
- },
- "jobComplete": {
- "type": "boolean",
- "description": "Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available."
- },
- "jobReference": {
- "$ref": "JobReference",
- "description": "Reference to the Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults)."
- },
- "kind": {
- "type": "string",
- "description": "The resource type.",
- "default": "bigquery#queryResponse"
- },
- "pageToken": {
- "type": "string",
- "description": "A token used for paging results."
- },
- "rows": {
- "type": "array",
- "description": "An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above.",
- "items": {
- "$ref": "TableRow"
- }
- },
- "schema": {
- "$ref": "TableSchema",
- "description": "The schema of the results. Present only when the query completes successfully."
- },
- "totalBytesProcessed": {
- "type": "string",
- "description": "The total number of bytes processed for this query. If this query was a dry run, this is the number of bytes that would be processed if the query were run.",
- "format": "int64"
- },
- "totalRows": {
- "type": "string",
- "description": "The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results.",
- "format": "uint64"
- }
- }
- },
- "Streamingbuffer": {
- "id": "Streamingbuffer",
- "type": "object",
- "properties": {
- "estimatedBytes": {
- "type": "string",
- "description": "[Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.",
- "format": "uint64"
- },
- "estimatedRows": {
- "type": "string",
- "description": "[Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.",
- "format": "uint64"
- },
- "oldestEntryTime": {
- "type": "string",
- "description": "[Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.",
- "format": "uint64"
- }
- }
- },
- "Table": {
- "id": "Table",
- "type": "object",
- "properties": {
- "creationTime": {
- "type": "string",
- "description": "[Output-only] The time when this table was created, in milliseconds since the epoch.",
- "format": "int64"
- },
- "description": {
- "type": "string",
- "description": "[Optional] A user-friendly description of this table."
- },
- "etag": {
- "type": "string",
- "description": "[Output-only] A hash of this resource."
- },
- "expirationTime": {
- "type": "string",
- "description": "[Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.",
- "format": "int64"
- },
- "externalDataConfiguration": {
- "$ref": "ExternalDataConfiguration",
- "description": "[Experimental] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table."
- },
- "friendlyName": {
- "type": "string",
- "description": "[Optional] A descriptive name for this table."
- },
- "id": {
- "type": "string",
- "description": "[Output-only] An opaque ID uniquely identifying the table."
- },
- "kind": {
- "type": "string",
- "description": "[Output-only] The type of the resource.",
- "default": "bigquery#table"
- },
- "lastModifiedTime": {
- "type": "string",
- "description": "[Output-only] The time when this table was last modified, in milliseconds since the epoch.",
- "format": "uint64"
- },
- "location": {
- "type": "string",
- "description": "[Output-only] The geographic location where the table resides. This value is inherited from the dataset."
- },
- "numBytes": {
- "type": "string",
- "description": "[Output-only] The size of this table in bytes, excluding any data in the streaming buffer.",
- "format": "int64"
- },
- "numRows": {
- "type": "string",
- "description": "[Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.",
- "format": "uint64"
- },
- "schema": {
- "$ref": "TableSchema",
- "description": "[Optional] Describes the schema of this table."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output-only] A URL that can be used to access this resource again."
- },
- "streamingBuffer": {
- "$ref": "Streamingbuffer",
- "description": "[Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer."
- },
- "tableReference": {
- "$ref": "TableReference",
- "description": "[Required] Reference describing the ID of this table."
- },
- "type": {
- "type": "string",
- "description": "[Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. The default value is TABLE."
- },
- "view": {
- "$ref": "ViewDefinition",
- "description": "[Optional] The view definition."
- }
- }
- },
- "TableCell": {
- "id": "TableCell",
- "type": "object",
- "properties": {
- "v": {
- "type": "any"
- }
- }
- },
- "TableDataInsertAllRequest": {
- "id": "TableDataInsertAllRequest",
- "type": "object",
- "properties": {
- "ignoreUnknownValues": {
- "type": "boolean",
- "description": "[Optional] Accept rows that contain values that do not match the schema. The unknown values are ignored. Default is false, which treats unknown values as errors."
- },
- "kind": {
- "type": "string",
- "description": "The resource type of the response.",
- "default": "bigquery#tableDataInsertAllRequest"
- },
- "rows": {
- "type": "array",
- "description": "The rows to insert.",
- "items": {
- "type": "object",
- "properties": {
- "insertId": {
- "type": "string",
- "description": "[Optional] A unique ID for each row. BigQuery uses this property to detect duplicate insertion requests on a best-effort basis."
- },
- "json": {
- "$ref": "JsonObject",
- "description": "[Required] A JSON object that contains a row of data. The object's properties and values must match the destination table's schema."
- }
- }
- }
- },
- "skipInvalidRows": {
- "type": "boolean",
- "description": "[Optional] Insert all valid rows of a request, even if invalid rows exist. The default value is false, which causes the entire request to fail if any invalid rows exist."
- }
- }
- },
- "TableDataInsertAllResponse": {
- "id": "TableDataInsertAllResponse",
- "type": "object",
- "properties": {
- "insertErrors": {
- "type": "array",
- "description": "An array of errors for rows that were not inserted.",
- "items": {
- "type": "object",
- "properties": {
- "errors": {
- "type": "array",
- "description": "Error information for the row indicated by the index property.",
- "items": {
- "$ref": "ErrorProto"
- }
- },
- "index": {
- "type": "integer",
- "description": "The index of the row that error applies to.",
- "format": "uint32"
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "The resource type of the response.",
- "default": "bigquery#tableDataInsertAllResponse"
- }
- }
- },
- "TableDataList": {
- "id": "TableDataList",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "A hash of this page of results."
- },
- "kind": {
- "type": "string",
- "description": "The resource type of the response.",
- "default": "bigquery#tableDataList"
- },
- "pageToken": {
- "type": "string",
- "description": "A token used for paging results. Providing this token instead of the startIndex parameter can help you retrieve stable results when an underlying table is changing."
- },
- "rows": {
- "type": "array",
- "description": "Rows of results.",
- "items": {
- "$ref": "TableRow"
- }
- },
- "totalRows": {
- "type": "string",
- "description": "The total number of rows in the complete table.",
- "format": "int64"
- }
- }
- },
- "TableFieldSchema": {
- "id": "TableFieldSchema",
- "type": "object",
- "properties": {
- "description": {
- "type": "string",
- "description": "[Optional] The field description. The maximum length is 16K characters."
- },
- "fields": {
- "type": "array",
- "description": "[Optional] Describes the nested schema fields if the type property is set to RECORD.",
- "items": {
- "$ref": "TableFieldSchema"
- }
- },
- "mode": {
- "type": "string",
- "description": "[Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE."
- },
- "name": {
- "type": "string",
- "description": "[Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters."
- },
- "type": {
- "type": "string",
- "description": "[Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema)."
- }
- }
- },
- "TableList": {
- "id": "TableList",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "A hash of this page of results."
- },
- "kind": {
- "type": "string",
- "description": "The type of list.",
- "default": "bigquery#tableList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "A token to request the next page of results."
- },
- "tables": {
- "type": "array",
- "description": "Tables in the requested dataset.",
- "items": {
- "type": "object",
- "properties": {
- "friendlyName": {
- "type": "string",
- "description": "The user-friendly name for this table."
- },
- "id": {
- "type": "string",
- "description": "An opaque ID of the table"
- },
- "kind": {
- "type": "string",
- "description": "The resource type.",
- "default": "bigquery#table"
- },
- "tableReference": {
- "$ref": "TableReference",
- "description": "A reference uniquely identifying the table."
- },
- "type": {
- "type": "string",
- "description": "The type of table. Possible values are: TABLE, VIEW."
- }
- }
- }
- },
- "totalItems": {
- "type": "integer",
- "description": "The total number of tables in the dataset.",
- "format": "int32"
- }
- }
- },
- "TableReference": {
- "id": "TableReference",
- "type": "object",
- "properties": {
- "datasetId": {
- "type": "string",
- "description": "[Required] The ID of the dataset containing this table.",
- "annotations": {
- "required": [
- "bigquery.tables.update"
- ]
- }
- },
- "projectId": {
- "type": "string",
- "description": "[Required] The ID of the project containing this table.",
- "annotations": {
- "required": [
- "bigquery.tables.update"
- ]
- }
- },
- "tableId": {
- "type": "string",
- "description": "[Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.",
- "annotations": {
- "required": [
- "bigquery.tables.update"
- ]
- }
- }
- }
- },
- "TableRow": {
- "id": "TableRow",
- "type": "object",
- "properties": {
- "f": {
- "type": "array",
- "description": "Represents a single row in the result set, consisting of one or more fields.",
- "items": {
- "$ref": "TableCell"
- }
- }
- }
- },
- "TableSchema": {
- "id": "TableSchema",
- "type": "object",
- "properties": {
- "fields": {
- "type": "array",
- "description": "Describes the fields in a table.",
- "items": {
- "$ref": "TableFieldSchema"
- }
- }
- }
- },
- "UserDefinedFunctionResource": {
- "id": "UserDefinedFunctionResource",
- "type": "object",
- "properties": {
- "inlineCode": {
- "type": "string",
- "description": "[Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code."
- },
- "resourceUri": {
- "type": "string",
- "description": "[Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path)."
- }
- }
- },
- "ViewDefinition": {
- "id": "ViewDefinition",
- "type": "object",
- "properties": {
- "query": {
- "type": "string",
- "description": "[Required] A query that BigQuery executes when the view is referenced."
- }
- }
- }
- },
- "resources": {
- "datasets": {
- "methods": {
- "delete": {
- "id": "bigquery.datasets.delete",
- "path": "projects/{projectId}/datasets/{datasetId}",
- "httpMethod": "DELETE",
- "description": "Deletes the dataset specified by the datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Dataset ID of dataset being deleted",
- "required": true,
- "location": "path"
- },
- "deleteContents": {
- "type": "boolean",
- "description": "If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False",
- "location": "query"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the dataset being deleted",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "datasetId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "get": {
- "id": "bigquery.datasets.get",
- "path": "projects/{projectId}/datasets/{datasetId}",
- "httpMethod": "GET",
- "description": "Returns the dataset specified by datasetID.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Dataset ID of the requested dataset",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the requested dataset",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "datasetId"
- ],
- "response": {
- "$ref": "Dataset"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "insert": {
- "id": "bigquery.datasets.insert",
- "path": "projects/{projectId}/datasets",
- "httpMethod": "POST",
- "description": "Creates a new empty dataset.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "Project ID of the new dataset",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId"
- ],
- "request": {
- "$ref": "Dataset"
- },
- "response": {
- "$ref": "Dataset"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "list": {
- "id": "bigquery.datasets.list",
- "path": "projects/{projectId}/datasets",
- "httpMethod": "GET",
- "description": "Lists all datasets in the specified project to which you have been granted the READER dataset role.",
- "parameters": {
- "all": {
- "type": "boolean",
- "description": "Whether to list all datasets, including hidden ones",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of results to return",
- "format": "uint32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Page token, returned by a previous call, to request the next page of results",
- "location": "query"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the datasets to be listed",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "DatasetList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "patch": {
- "id": "bigquery.datasets.patch",
- "path": "projects/{projectId}/datasets/{datasetId}",
- "httpMethod": "PATCH",
- "description": "Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports patch semantics.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Dataset ID of the dataset being updated",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the dataset being updated",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "datasetId"
- ],
- "request": {
- "$ref": "Dataset"
- },
- "response": {
- "$ref": "Dataset"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "update": {
- "id": "bigquery.datasets.update",
- "path": "projects/{projectId}/datasets/{datasetId}",
- "httpMethod": "PUT",
- "description": "Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Dataset ID of the dataset being updated",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the dataset being updated",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "datasetId"
- ],
- "request": {
- "$ref": "Dataset"
- },
- "response": {
- "$ref": "Dataset"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- },
- "jobs": {
- "methods": {
- "cancel": {
- "id": "bigquery.jobs.cancel",
- "path": "project/{projectId}/jobs/{jobId}/cancel",
- "httpMethod": "POST",
- "description": "Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs.",
- "parameters": {
- "jobId": {
- "type": "string",
- "description": "Job ID of the job to cancel",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the job to cancel",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "response": {
- "$ref": "JobCancelResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "get": {
- "id": "bigquery.jobs.get",
- "path": "projects/{projectId}/jobs/{jobId}",
- "httpMethod": "GET",
- "description": "Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role.",
- "parameters": {
- "jobId": {
- "type": "string",
- "description": "Job ID of the requested job",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the requested job",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "response": {
- "$ref": "Job"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "getQueryResults": {
- "id": "bigquery.jobs.getQueryResults",
- "path": "projects/{projectId}/queries/{jobId}",
- "httpMethod": "GET",
- "description": "Retrieves the results of a query job.",
- "parameters": {
- "jobId": {
- "type": "string",
- "description": "Job ID of the query job",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to read",
- "format": "uint32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Page token, returned by a previous call, to request the next page of results",
- "location": "query"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the query job",
- "required": true,
- "location": "path"
- },
- "startIndex": {
- "type": "string",
- "description": "Zero-based index of the starting row",
- "format": "uint64",
- "location": "query"
- },
- "timeoutMs": {
- "type": "integer",
- "description": "How long to wait for the query to complete, in milliseconds, before returning. Default is 10 seconds. If the timeout passes before the job completes, the 'jobComplete' field in the response will be false",
- "format": "uint32",
- "location": "query"
- }
- },
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "response": {
- "$ref": "GetQueryResultsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "insert": {
- "id": "bigquery.jobs.insert",
- "path": "projects/{projectId}/jobs",
- "httpMethod": "POST",
- "description": "Starts a new asynchronous job. Requires the Can View project role.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "Project ID of the project that will be billed for the job",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId"
- ],
- "request": {
- "$ref": "Job"
- },
- "response": {
- "$ref": "Job"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/devstorage.full_control",
- "https://www.googleapis.com/auth/devstorage.read_only",
- "https://www.googleapis.com/auth/devstorage.read_write"
- ],
- "supportsMediaUpload": true,
- "mediaUpload": {
- "accept": [
- "*/*"
- ],
- "protocols": {
- "simple": {
- "multipart": true,
- "path": "/upload/bigquery/v2/projects/{projectId}/jobs"
- },
- "resumable": {
- "multipart": true,
- "path": "/resumable/upload/bigquery/v2/projects/{projectId}/jobs"
- }
- }
- }
- },
- "list": {
- "id": "bigquery.jobs.list",
- "path": "projects/{projectId}/jobs",
- "httpMethod": "GET",
- "description": "Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property.",
- "parameters": {
- "allUsers": {
- "type": "boolean",
- "description": "Whether to display jobs owned by all users in the project. Default false",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return",
- "format": "uint32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Page token, returned by a previous call, to request the next page of results",
- "location": "query"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the jobs to list",
- "required": true,
- "location": "path"
- },
- "projection": {
- "type": "string",
- "description": "Restrict information returned to a set of selected fields",
- "enum": [
- "full",
- "minimal"
- ],
- "enumDescriptions": [
- "Includes all job data",
- "Does not include the job configuration"
- ],
- "location": "query"
- },
- "stateFilter": {
- "type": "string",
- "description": "Filter for job state",
- "enum": [
- "done",
- "pending",
- "running"
- ],
- "enumDescriptions": [
- "Finished jobs",
- "Pending jobs",
- "Running jobs"
- ],
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "JobList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "query": {
- "id": "bigquery.jobs.query",
- "path": "projects/{projectId}/queries",
- "httpMethod": "POST",
- "description": "Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "Project ID of the project billed for the query",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId"
- ],
- "request": {
- "$ref": "QueryRequest"
- },
- "response": {
- "$ref": "QueryResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- }
- }
- },
- "projects": {
- "methods": {
- "list": {
- "id": "bigquery.projects.list",
- "path": "projects",
- "httpMethod": "GET",
- "description": "Lists all projects to which you have been granted any project role.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return",
- "format": "uint32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Page token, returned by a previous call, to request the next page of results",
- "location": "query"
- }
- },
- "response": {
- "$ref": "ProjectList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- }
- }
- },
- "tabledata": {
- "methods": {
- "insertAll": {
- "id": "bigquery.tabledata.insertAll",
- "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}/insertAll",
- "httpMethod": "POST",
- "description": "Streams data into BigQuery one record at a time without needing to run a load job. Requires the WRITER dataset role.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Dataset ID of the destination table.",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the destination table.",
- "required": true,
- "location": "path"
- },
- "tableId": {
- "type": "string",
- "description": "Table ID of the destination table.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "datasetId",
- "tableId"
- ],
- "request": {
- "$ref": "TableDataInsertAllRequest"
- },
- "response": {
- "$ref": "TableDataInsertAllResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/bigquery.insertdata",
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "list": {
- "id": "bigquery.tabledata.list",
- "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}/data",
- "httpMethod": "GET",
- "description": "Retrieves table data from a specified set of rows. Requires the READER dataset role.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Dataset ID of the table to read",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return",
- "format": "uint32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Page token, returned by a previous call, identifying the result set",
- "location": "query"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the table to read",
- "required": true,
- "location": "path"
- },
- "startIndex": {
- "type": "string",
- "description": "Zero-based index of the starting row to read",
- "format": "uint64",
- "location": "query"
- },
- "tableId": {
- "type": "string",
- "description": "Table ID of the table to read",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "datasetId",
- "tableId"
- ],
- "response": {
- "$ref": "TableDataList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- }
- }
- },
- "tables": {
- "methods": {
- "delete": {
- "id": "bigquery.tables.delete",
- "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}",
- "httpMethod": "DELETE",
- "description": "Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Dataset ID of the table to delete",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the table to delete",
- "required": true,
- "location": "path"
- },
- "tableId": {
- "type": "string",
- "description": "Table ID of the table to delete",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "datasetId",
- "tableId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "get": {
- "id": "bigquery.tables.get",
- "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}",
- "httpMethod": "GET",
- "description": "Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Dataset ID of the requested table",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the requested table",
- "required": true,
- "location": "path"
- },
- "tableId": {
- "type": "string",
- "description": "Table ID of the requested table",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "datasetId",
- "tableId"
- ],
- "response": {
- "$ref": "Table"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "insert": {
- "id": "bigquery.tables.insert",
- "path": "projects/{projectId}/datasets/{datasetId}/tables",
- "httpMethod": "POST",
- "description": "Creates a new, empty table in the dataset.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Dataset ID of the new table",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the new table",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "datasetId"
- ],
- "request": {
- "$ref": "Table"
- },
- "response": {
- "$ref": "Table"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "list": {
- "id": "bigquery.tables.list",
- "path": "projects/{projectId}/datasets/{datasetId}/tables",
- "httpMethod": "GET",
- "description": "Lists all tables in the specified dataset. Requires the READER dataset role.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Dataset ID of the tables to list",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return",
- "format": "uint32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Page token, returned by a previous call, to request the next page of results",
- "location": "query"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the tables to list",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "datasetId"
- ],
- "response": {
- "$ref": "TableList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "patch": {
- "id": "bigquery.tables.patch",
- "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}",
- "httpMethod": "PATCH",
- "description": "Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. This method supports patch semantics.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Dataset ID of the table to update",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the table to update",
- "required": true,
- "location": "path"
- },
- "tableId": {
- "type": "string",
- "description": "Table ID of the table to update",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "datasetId",
- "tableId"
- ],
- "request": {
- "$ref": "Table"
- },
- "response": {
- "$ref": "Table"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "update": {
- "id": "bigquery.tables.update",
- "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}",
- "httpMethod": "PUT",
- "description": "Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Dataset ID of the table to update",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of the table to update",
- "required": true,
- "location": "path"
- },
- "tableId": {
- "type": "string",
- "description": "Table ID of the table to update",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "datasetId",
- "tableId"
- ],
- "request": {
- "$ref": "Table"
- },
- "response": {
- "$ref": "Table"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/bigquery/v2/bigquery-gen.go b/vendor/google.golang.org/api/bigquery/v2/bigquery-gen.go
deleted file mode 100644
index 279f8aeb..00000000
--- a/vendor/google.golang.org/api/bigquery/v2/bigquery-gen.go
+++ /dev/null
@@ -1,5266 +0,0 @@
-// Package bigquery provides access to the BigQuery API.
-//
-// See https://cloud.google.com/bigquery/
-//
-// Usage example:
-//
-// import "google.golang.org/api/bigquery/v2"
-// ...
-// bigqueryService, err := bigquery.New(oauthHttpClient)
-package bigquery // import "google.golang.org/api/bigquery/v2"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "bigquery:v2"
-const apiName = "bigquery"
-const apiVersion = "v2"
-const basePath = "https://www.googleapis.com/bigquery/v2/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your data in Google BigQuery
- BigqueryScope = "https://www.googleapis.com/auth/bigquery"
-
- // Insert data into Google BigQuery
- BigqueryInsertdataScope = "https://www.googleapis.com/auth/bigquery.insertdata"
-
- // View and manage your data across Google Cloud Platform services
- CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
-
- // View your data across Google Cloud Platform services
- CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"
-
- // Manage your data and permissions in Google Cloud Storage
- DevstorageFullControlScope = "https://www.googleapis.com/auth/devstorage.full_control"
-
- // View your data in Google Cloud Storage
- DevstorageReadOnlyScope = "https://www.googleapis.com/auth/devstorage.read_only"
-
- // Manage your data in Google Cloud Storage
- DevstorageReadWriteScope = "https://www.googleapis.com/auth/devstorage.read_write"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Datasets = NewDatasetsService(s)
- s.Jobs = NewJobsService(s)
- s.Projects = NewProjectsService(s)
- s.Tabledata = NewTabledataService(s)
- s.Tables = NewTablesService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Datasets *DatasetsService
-
- Jobs *JobsService
-
- Projects *ProjectsService
-
- Tabledata *TabledataService
-
- Tables *TablesService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewDatasetsService(s *Service) *DatasetsService {
- rs := &DatasetsService{s: s}
- return rs
-}
-
-type DatasetsService struct {
- s *Service
-}
-
-func NewJobsService(s *Service) *JobsService {
- rs := &JobsService{s: s}
- return rs
-}
-
-type JobsService struct {
- s *Service
-}
-
-func NewProjectsService(s *Service) *ProjectsService {
- rs := &ProjectsService{s: s}
- return rs
-}
-
-type ProjectsService struct {
- s *Service
-}
-
-func NewTabledataService(s *Service) *TabledataService {
- rs := &TabledataService{s: s}
- return rs
-}
-
-type TabledataService struct {
- s *Service
-}
-
-func NewTablesService(s *Service) *TablesService {
- rs := &TablesService{s: s}
- return rs
-}
-
-type TablesService struct {
- s *Service
-}
-
-type CsvOptions struct {
- // AllowJaggedRows: [Optional] Indicates if BigQuery should accept rows
- // that are missing trailing optional columns. If true, BigQuery treats
- // missing trailing columns as null values. If false, records with
- // missing trailing columns are treated as bad records, and if there are
- // too many bad records, an invalid error is returned in the job result.
- // The default value is false.
- AllowJaggedRows bool `json:"allowJaggedRows,omitempty"`
-
- // AllowQuotedNewlines: [Optional] Indicates if BigQuery should allow
- // quoted data sections that contain newline characters in a CSV file.
- // The default value is false.
- AllowQuotedNewlines bool `json:"allowQuotedNewlines,omitempty"`
-
- // Encoding: [Optional] The character encoding of the data. The
- // supported values are UTF-8 or ISO-8859-1. The default value is UTF-8.
- // BigQuery decodes the data after the raw, binary data has been split
- // using the values of the quote and fieldDelimiter properties.
- Encoding string `json:"encoding,omitempty"`
-
- // FieldDelimiter: [Optional] The separator for fields in a CSV file.
- // BigQuery converts the string to ISO-8859-1 encoding, and then uses
- // the first byte of the encoded string to split the data in its raw,
- // binary state. BigQuery also supports the escape sequence "\t" to
- // specify a tab separator. The default value is a comma (',').
- FieldDelimiter string `json:"fieldDelimiter,omitempty"`
-
- // Quote: [Optional] The value that is used to quote data sections in a
- // CSV file. BigQuery converts the string to ISO-8859-1 encoding, and
- // then uses the first byte of the encoded string to split the data in
- // its raw, binary state. The default value is a double-quote ('"'). If
- // your data does not contain quoted sections, set the property value to
- // an empty string. If your data contains quoted newline characters, you
- // must also set the allowQuotedNewlines property to true.
- //
- // Default: "
- Quote *string `json:"quote,omitempty"`
-
- // SkipLeadingRows: [Optional] The number of rows at the top of a CSV
- // file that BigQuery will skip when reading the data. The default value
- // is 0. This property is useful if you have header rows in the file
- // that should be skipped.
- SkipLeadingRows int64 `json:"skipLeadingRows,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AllowJaggedRows") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CsvOptions) MarshalJSON() ([]byte, error) {
- type noMethod CsvOptions
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Dataset struct {
- // Access: [Optional] An array of objects that define dataset access for
- // one or more entities. You can set this property when inserting or
- // updating a dataset in order to control who is allowed to access the
- // data. If unspecified at dataset creation time, BigQuery adds default
- // dataset access for the following entities: access.specialGroup:
- // projectReaders; access.role: READER; access.specialGroup:
- // projectWriters; access.role: WRITER; access.specialGroup:
- // projectOwners; access.role: OWNER; access.userByEmail: [dataset
- // creator email]; access.role: OWNER;
- Access []*DatasetAccess `json:"access,omitempty"`
-
- // CreationTime: [Output-only] The time when this dataset was created,
- // in milliseconds since the epoch.
- CreationTime int64 `json:"creationTime,omitempty,string"`
-
- // DatasetReference: [Required] A reference that identifies the dataset.
- DatasetReference *DatasetReference `json:"datasetReference,omitempty"`
-
- // DefaultTableExpirationMs: [Experimental] The default lifetime of all
- // tables in the dataset, in milliseconds. The minimum value is 3600000
- // milliseconds (one hour). Once this property is set, all newly-created
- // tables in the dataset will have an expirationTime property set to the
- // creation time plus the value in this property, and changing the value
- // will only affect new tables, not existing ones. When the
- // expirationTime for a given table is reached, that table will be
- // deleted automatically. If a table's expirationTime is modified or
- // removed before the table expires, or if you provide an explicit
- // expirationTime when creating a table, that value takes precedence
- // over the default expiration time indicated by this property.
- DefaultTableExpirationMs int64 `json:"defaultTableExpirationMs,omitempty,string"`
-
- // Description: [Optional] A user-friendly description of the dataset.
- Description string `json:"description,omitempty"`
-
- // Etag: [Output-only] A hash of the resource.
- Etag string `json:"etag,omitempty"`
-
- // FriendlyName: [Optional] A descriptive name for the dataset.
- FriendlyName string `json:"friendlyName,omitempty"`
-
- // Id: [Output-only] The fully-qualified unique name of the dataset in
- // the format projectId:datasetId. The dataset name without the project
- // name is given in the datasetId field. When creating a new dataset,
- // leave this field blank, and instead specify the datasetId field.
- Id string `json:"id,omitempty"`
-
- // Kind: [Output-only] The resource type.
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedTime: [Output-only] The date when this dataset or any of
- // its tables was last modified, in milliseconds since the epoch.
- LastModifiedTime int64 `json:"lastModifiedTime,omitempty,string"`
-
- // Location: [Experimental] The geographic location where the dataset
- // should reside. Possible values include EU and US. The default value
- // is US.
- Location string `json:"location,omitempty"`
-
- // SelfLink: [Output-only] A URL that can be used to access the resource
- // again. You can use this URL in Get or Update requests to the
- // resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Access") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Dataset) MarshalJSON() ([]byte, error) {
- type noMethod Dataset
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DatasetAccess struct {
- // Domain: [Pick one] A domain to grant access to. Any users signed in
- // with the domain specified will be granted the specified access.
- // Example: "example.com".
- Domain string `json:"domain,omitempty"`
-
- // GroupByEmail: [Pick one] An email address of a Google Group to grant
- // access to.
- GroupByEmail string `json:"groupByEmail,omitempty"`
-
- // Role: [Required] Describes the rights granted to the user specified
- // by the other member of the access object. The following string values
- // are supported: READER, WRITER, OWNER.
- Role string `json:"role,omitempty"`
-
- // SpecialGroup: [Pick one] A special group to grant access to. Possible
- // values include: projectOwners: Owners of the enclosing project.
- // projectReaders: Readers of the enclosing project. projectWriters:
- // Writers of the enclosing project. allAuthenticatedUsers: All
- // authenticated BigQuery users.
- SpecialGroup string `json:"specialGroup,omitempty"`
-
- // UserByEmail: [Pick one] An email address of a user to grant access
- // to. For example: fred@example.com.
- UserByEmail string `json:"userByEmail,omitempty"`
-
- // View: [Pick one] A view from a different dataset to grant access to.
- // Queries executed against that view will have read access to tables in
- // this dataset. The role field is not required when this field is set.
- // If that view is updated by any user, access to the view needs to be
- // granted again via an update operation.
- View *TableReference `json:"view,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Domain") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DatasetAccess) MarshalJSON() ([]byte, error) {
- type noMethod DatasetAccess
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DatasetList struct {
- // Datasets: An array of the dataset resources in the project. Each
- // resource contains basic information. For full information about a
- // particular dataset resource, use the Datasets: get method. This
- // property is omitted when there are no datasets in the project.
- Datasets []*DatasetListDatasets `json:"datasets,omitempty"`
-
- // Etag: A hash value of the results page. You can use this property to
- // determine if the page has changed since the last request.
- Etag string `json:"etag,omitempty"`
-
- // Kind: The list type. This property always returns the value
- // "bigquery#datasetList".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: A token that can be used to request the next results
- // page. This property is omitted on the final results page.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Datasets") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DatasetList) MarshalJSON() ([]byte, error) {
- type noMethod DatasetList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DatasetListDatasets struct {
- // DatasetReference: The dataset reference. Use this property to access
- // specific parts of the dataset's ID, such as project ID or dataset ID.
- DatasetReference *DatasetReference `json:"datasetReference,omitempty"`
-
- // FriendlyName: A descriptive name for the dataset, if one exists.
- FriendlyName string `json:"friendlyName,omitempty"`
-
- // Id: The fully-qualified, unique, opaque ID of the dataset.
- Id string `json:"id,omitempty"`
-
- // Kind: The resource type. This property always returns the value
- // "bigquery#dataset".
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DatasetReference") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DatasetListDatasets) MarshalJSON() ([]byte, error) {
- type noMethod DatasetListDatasets
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DatasetReference struct {
- // DatasetId: [Required] A unique ID for this dataset, without the
- // project name. The ID must contain only letters (a-z, A-Z), numbers
- // (0-9), or underscores (_). The maximum length is 1,024 characters.
- DatasetId string `json:"datasetId,omitempty"`
-
- // ProjectId: [Optional] The ID of the project containing this dataset.
- ProjectId string `json:"projectId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DatasetId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DatasetReference) MarshalJSON() ([]byte, error) {
- type noMethod DatasetReference
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ErrorProto struct {
- // DebugInfo: Debugging information. This property is internal to Google
- // and should not be used.
- DebugInfo string `json:"debugInfo,omitempty"`
-
- // Location: Specifies where the error occurred, if present.
- Location string `json:"location,omitempty"`
-
- // Message: A human-readable description of the error.
- Message string `json:"message,omitempty"`
-
- // Reason: A short error code that summarizes the error.
- Reason string `json:"reason,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DebugInfo") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ErrorProto) MarshalJSON() ([]byte, error) {
- type noMethod ErrorProto
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ExternalDataConfiguration struct {
- // Compression: [Optional] The compression type of the data source.
- // Possible values include GZIP and NONE. The default value is NONE.
- Compression string `json:"compression,omitempty"`
-
- // CsvOptions: Additional properties to set if sourceFormat is set to
- // CSV.
- CsvOptions *CsvOptions `json:"csvOptions,omitempty"`
-
- // IgnoreUnknownValues: [Optional] Indicates if BigQuery should allow
- // extra values that are not represented in the table schema. If true,
- // the extra values are ignored. If false, records with extra columns
- // are treated as bad records, and if there are too many bad records, an
- // invalid error is returned in the job result. The default value is
- // false. The sourceFormat property determines what BigQuery treats as
- // an extra value: CSV: Trailing columns JSON: Named values that don't
- // match any column names
- IgnoreUnknownValues bool `json:"ignoreUnknownValues,omitempty"`
-
- // MaxBadRecords: [Optional] The maximum number of bad records that
- // BigQuery can ignore when reading data. If the number of bad records
- // exceeds this value, an invalid error is returned in the job result.
- // The default value is 0, which requires that all records are valid.
- MaxBadRecords int64 `json:"maxBadRecords,omitempty"`
-
- // Schema: [Required] The schema for the data.
- Schema *TableSchema `json:"schema,omitempty"`
-
- // SourceFormat: [Required] The data format. For CSV files, specify
- // "CSV". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON".
- SourceFormat string `json:"sourceFormat,omitempty"`
-
- // SourceUris: [Required] The fully-qualified URIs that point to your
- // data in Google Cloud Storage. Each URI can contain one '*' wildcard
- // character and it must come after the 'bucket' name. Size limits
- // related to load jobs apply to external data sources, plus an
- // additional limit of 10 GB maximum size across all URIs.
- SourceUris []string `json:"sourceUris,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Compression") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ExternalDataConfiguration) MarshalJSON() ([]byte, error) {
- type noMethod ExternalDataConfiguration
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GetQueryResultsResponse struct {
- // CacheHit: Whether the query result was fetched from the query cache.
- CacheHit bool `json:"cacheHit,omitempty"`
-
- // Errors: [Output-only] All errors and warnings encountered during the
- // running of the job. Errors here do not necessarily mean that the job
- // has completed or was unsuccessful.
- Errors []*ErrorProto `json:"errors,omitempty"`
-
- // Etag: A hash of this response.
- Etag string `json:"etag,omitempty"`
-
- // JobComplete: Whether the query has completed or not. If rows or
- // totalRows are present, this will always be true. If this is false,
- // totalRows will not be available.
- JobComplete bool `json:"jobComplete,omitempty"`
-
- // JobReference: Reference to the BigQuery Job that was created to run
- // the query. This field will be present even if the original request
- // timed out, in which case GetQueryResults can be used to read the
- // results once the query has completed. Since this API only returns the
- // first page of results, subsequent pages can be fetched via the same
- // mechanism (GetQueryResults).
- JobReference *JobReference `json:"jobReference,omitempty"`
-
- // Kind: The resource type of the response.
- Kind string `json:"kind,omitempty"`
-
- // PageToken: A token used for paging results.
- PageToken string `json:"pageToken,omitempty"`
-
- // Rows: An object with as many results as can be contained within the
- // maximum permitted reply size. To get any additional rows, you can
- // call GetQueryResults and specify the jobReference returned above.
- // Present only when the query completes successfully.
- Rows []*TableRow `json:"rows,omitempty"`
-
- // Schema: The schema of the results. Present only when the query
- // completes successfully.
- Schema *TableSchema `json:"schema,omitempty"`
-
- // TotalBytesProcessed: The total number of bytes processed for this
- // query.
- TotalBytesProcessed int64 `json:"totalBytesProcessed,omitempty,string"`
-
- // TotalRows: The total number of rows in the complete query result set,
- // which can be more than the number of rows in this single page of
- // results. Present only when the query completes successfully.
- TotalRows uint64 `json:"totalRows,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CacheHit") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GetQueryResultsResponse) MarshalJSON() ([]byte, error) {
- type noMethod GetQueryResultsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Job struct {
- // Configuration: [Required] Describes the job configuration.
- Configuration *JobConfiguration `json:"configuration,omitempty"`
-
- // Etag: [Output-only] A hash of this resource.
- Etag string `json:"etag,omitempty"`
-
- // Id: [Output-only] Opaque ID field of the job
- Id string `json:"id,omitempty"`
-
- // JobReference: [Optional] Reference describing the unique-per-user
- // name of the job.
- JobReference *JobReference `json:"jobReference,omitempty"`
-
- // Kind: [Output-only] The type of the resource.
- Kind string `json:"kind,omitempty"`
-
- // SelfLink: [Output-only] A URL that can be used to access this
- // resource again.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Statistics: [Output-only] Information about the job, including
- // starting time and ending time of the job.
- Statistics *JobStatistics `json:"statistics,omitempty"`
-
- // Status: [Output-only] The status of this job. Examine this value when
- // polling an asynchronous job to see if the job is complete.
- Status *JobStatus `json:"status,omitempty"`
-
- // UserEmail: [Output-only] Email address of the user who ran the job.
- UserEmail string `json:"user_email,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Configuration") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Job) MarshalJSON() ([]byte, error) {
- type noMethod Job
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type JobCancelResponse struct {
- // Job: The final state of the job.
- Job *Job `json:"job,omitempty"`
-
- // Kind: The resource type of the response.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Job") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *JobCancelResponse) MarshalJSON() ([]byte, error) {
- type noMethod JobCancelResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type JobConfiguration struct {
- // Copy: [Pick one] Copies a table.
- Copy *JobConfigurationTableCopy `json:"copy,omitempty"`
-
- // DryRun: [Optional] If set, don't actually run this job. A valid query
- // will return a mostly empty response with some processing statistics,
- // while an invalid query will return the same error it would if it
- // wasn't a dry run. Behavior of non-query jobs is undefined.
- DryRun bool `json:"dryRun,omitempty"`
-
- // Extract: [Pick one] Configures an extract job.
- Extract *JobConfigurationExtract `json:"extract,omitempty"`
-
- // Link: [Pick one] Configures a link job.
- Link *JobConfigurationLink `json:"link,omitempty"`
-
- // Load: [Pick one] Configures a load job.
- Load *JobConfigurationLoad `json:"load,omitempty"`
-
- // Query: [Pick one] Configures a query job.
- Query *JobConfigurationQuery `json:"query,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Copy") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *JobConfiguration) MarshalJSON() ([]byte, error) {
- type noMethod JobConfiguration
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type JobConfigurationExtract struct {
- // Compression: [Optional] The compression type to use for exported
- // files. Possible values include GZIP and NONE. The default value is
- // NONE.
- Compression string `json:"compression,omitempty"`
-
- // DestinationFormat: [Optional] The exported file format. Possible
- // values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default
- // value is CSV. Tables with nested or repeated fields cannot be
- // exported as CSV.
- DestinationFormat string `json:"destinationFormat,omitempty"`
-
- // DestinationUri: [Pick one] DEPRECATED: Use destinationUris instead,
- // passing only one URI as necessary. The fully-qualified Google Cloud
- // Storage URI where the extracted table should be written.
- DestinationUri string `json:"destinationUri,omitempty"`
-
- // DestinationUris: [Pick one] A list of fully-qualified Google Cloud
- // Storage URIs where the extracted table should be written.
- DestinationUris []string `json:"destinationUris,omitempty"`
-
- // FieldDelimiter: [Optional] Delimiter to use between fields in the
- // exported data. Default is ','
- FieldDelimiter string `json:"fieldDelimiter,omitempty"`
-
- // PrintHeader: [Optional] Whether to print out a header row in the
- // results. Default is true.
- //
- // Default: true
- PrintHeader *bool `json:"printHeader,omitempty"`
-
- // SourceTable: [Required] A reference to the table being exported.
- SourceTable *TableReference `json:"sourceTable,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Compression") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *JobConfigurationExtract) MarshalJSON() ([]byte, error) {
- type noMethod JobConfigurationExtract
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type JobConfigurationLink struct {
- // CreateDisposition: [Optional] Specifies whether the job is allowed to
- // create new tables. The following values are supported:
- // CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the
- // table. CREATE_NEVER: The table must already exist. If it does not, a
- // 'notFound' error is returned in the job result. The default value is
- // CREATE_IF_NEEDED. Creation, truncation and append actions occur as
- // one atomic update upon job completion.
- CreateDisposition string `json:"createDisposition,omitempty"`
-
- // DestinationTable: [Required] The destination table of the link job.
- DestinationTable *TableReference `json:"destinationTable,omitempty"`
-
- // SourceUri: [Required] URI of source table to link.
- SourceUri []string `json:"sourceUri,omitempty"`
-
- // WriteDisposition: [Optional] Specifies the action that occurs if the
- // destination table already exists. The following values are supported:
- // WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the
- // table data. WRITE_APPEND: If the table already exists, BigQuery
- // appends the data to the table. WRITE_EMPTY: If the table already
- // exists and contains data, a 'duplicate' error is returned in the job
- // result. The default value is WRITE_EMPTY. Each action is atomic and
- // only occurs if BigQuery is able to complete the job successfully.
- // Creation, truncation and append actions occur as one atomic update
- // upon job completion.
- WriteDisposition string `json:"writeDisposition,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CreateDisposition")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *JobConfigurationLink) MarshalJSON() ([]byte, error) {
- type noMethod JobConfigurationLink
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type JobConfigurationLoad struct {
- // AllowJaggedRows: [Optional] Accept rows that are missing trailing
- // optional columns. The missing values are treated as nulls. If false,
- // records with missing trailing columns are treated as bad records, and
- // if there are too many bad records, an invalid error is returned in
- // the job result. The default value is false. Only applicable to CSV,
- // ignored for other formats.
- AllowJaggedRows bool `json:"allowJaggedRows,omitempty"`
-
- // AllowQuotedNewlines: Indicates if BigQuery should allow quoted data
- // sections that contain newline characters in a CSV file. The default
- // value is false.
- AllowQuotedNewlines bool `json:"allowQuotedNewlines,omitempty"`
-
- // CreateDisposition: [Optional] Specifies whether the job is allowed to
- // create new tables. The following values are supported:
- // CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the
- // table. CREATE_NEVER: The table must already exist. If it does not, a
- // 'notFound' error is returned in the job result. The default value is
- // CREATE_IF_NEEDED. Creation, truncation and append actions occur as
- // one atomic update upon job completion.
- CreateDisposition string `json:"createDisposition,omitempty"`
-
- // DestinationTable: [Required] The destination table to load the data
- // into.
- DestinationTable *TableReference `json:"destinationTable,omitempty"`
-
- // Encoding: [Optional] The character encoding of the data. The
- // supported values are UTF-8 or ISO-8859-1. The default value is UTF-8.
- // BigQuery decodes the data after the raw, binary data has been split
- // using the values of the quote and fieldDelimiter properties.
- Encoding string `json:"encoding,omitempty"`
-
- // FieldDelimiter: [Optional] The separator for fields in a CSV file.
- // BigQuery converts the string to ISO-8859-1 encoding, and then uses
- // the first byte of the encoded string to split the data in its raw,
- // binary state. BigQuery also supports the escape sequence "\t" to
- // specify a tab separator. The default value is a comma (',').
- FieldDelimiter string `json:"fieldDelimiter,omitempty"`
-
- // IgnoreUnknownValues: [Optional] Indicates if BigQuery should allow
- // extra values that are not represented in the table schema. If true,
- // the extra values are ignored. If false, records with extra columns
- // are treated as bad records, and if there are too many bad records, an
- // invalid error is returned in the job result. The default value is
- // false. The sourceFormat property determines what BigQuery treats as
- // an extra value: CSV: Trailing columns JSON: Named values that don't
- // match any column names
- IgnoreUnknownValues bool `json:"ignoreUnknownValues,omitempty"`
-
- // MaxBadRecords: [Optional] The maximum number of bad records that
- // BigQuery can ignore when running the job. If the number of bad
- // records exceeds this value, an invalid error is returned in the job
- // result. The default value is 0, which requires that all records are
- // valid.
- MaxBadRecords int64 `json:"maxBadRecords,omitempty"`
-
- // ProjectionFields: [Experimental] If sourceFormat is set to
- // "DATASTORE_BACKUP", indicates which entity properties to load into
- // BigQuery from a Cloud Datastore backup. Property names are case
- // sensitive and must be top-level properties. If no properties are
- // specified, BigQuery loads all properties. If any named property isn't
- // found in the Cloud Datastore backup, an invalid error is returned in
- // the job result.
- ProjectionFields []string `json:"projectionFields,omitempty"`
-
- // Quote: [Optional] The value that is used to quote data sections in a
- // CSV file. BigQuery converts the string to ISO-8859-1 encoding, and
- // then uses the first byte of the encoded string to split the data in
- // its raw, binary state. The default value is a double-quote ('"'). If
- // your data does not contain quoted sections, set the property value to
- // an empty string. If your data contains quoted newline characters, you
- // must also set the allowQuotedNewlines property to true.
- //
- // Default: "
- Quote *string `json:"quote,omitempty"`
-
- // Schema: [Optional] The schema for the destination table. The schema
- // can be omitted if the destination table already exists or if the
- // schema can be inferred from the loaded data.
- Schema *TableSchema `json:"schema,omitempty"`
-
- // SchemaInline: [Deprecated] The inline schema. For CSV schemas,
- // specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING,
- // bar:INTEGER, baz:FLOAT".
- SchemaInline string `json:"schemaInline,omitempty"`
-
- // SchemaInlineFormat: [Deprecated] The format of the schemaInline
- // property.
- SchemaInlineFormat string `json:"schemaInlineFormat,omitempty"`
-
- // SkipLeadingRows: [Optional] The number of rows at the top of a CSV
- // file that BigQuery will skip when loading the data. The default value
- // is 0. This property is useful if you have header rows in the file
- // that should be skipped.
- SkipLeadingRows int64 `json:"skipLeadingRows,omitempty"`
-
- // SourceFormat: [Optional] The format of the data files. For CSV files,
- // specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For
- // newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". The default
- // value is CSV.
- SourceFormat string `json:"sourceFormat,omitempty"`
-
- // SourceUris: [Required] The fully-qualified URIs that point to your
- // data in Google Cloud Storage. Each URI can contain one '*' wildcard
- // character and it must come after the 'bucket' name.
- SourceUris []string `json:"sourceUris,omitempty"`
-
- // WriteDisposition: [Optional] Specifies the action that occurs if the
- // destination table already exists. The following values are supported:
- // WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the
- // table data. WRITE_APPEND: If the table already exists, BigQuery
- // appends the data to the table. WRITE_EMPTY: If the table already
- // exists and contains data, a 'duplicate' error is returned in the job
- // result. The default value is WRITE_APPEND. Each action is atomic and
- // only occurs if BigQuery is able to complete the job successfully.
- // Creation, truncation and append actions occur as one atomic update
- // upon job completion.
- WriteDisposition string `json:"writeDisposition,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AllowJaggedRows") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *JobConfigurationLoad) MarshalJSON() ([]byte, error) {
- type noMethod JobConfigurationLoad
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type JobConfigurationQuery struct {
- // AllowLargeResults: If true, allows the query to produce arbitrarily
- // large result tables at a slight cost in performance. Requires
- // destinationTable to be set.
- AllowLargeResults bool `json:"allowLargeResults,omitempty"`
-
- // CreateDisposition: [Optional] Specifies whether the job is allowed to
- // create new tables. The following values are supported:
- // CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the
- // table. CREATE_NEVER: The table must already exist. If it does not, a
- // 'notFound' error is returned in the job result. The default value is
- // CREATE_IF_NEEDED. Creation, truncation and append actions occur as
- // one atomic update upon job completion.
- CreateDisposition string `json:"createDisposition,omitempty"`
-
- // DefaultDataset: [Optional] Specifies the default dataset to use for
- // unqualified table names in the query.
- DefaultDataset *DatasetReference `json:"defaultDataset,omitempty"`
-
- // DestinationTable: [Optional] Describes the table where the query
- // results should be stored. If not present, a new table will be created
- // to store the results.
- DestinationTable *TableReference `json:"destinationTable,omitempty"`
-
- // FlattenResults: [Optional] Flattens all nested and repeated fields in
- // the query results. The default value is true. allowLargeResults must
- // be true if this is set to false.
- //
- // Default: true
- FlattenResults *bool `json:"flattenResults,omitempty"`
-
- // PreserveNulls: [Deprecated] This property is deprecated.
- PreserveNulls bool `json:"preserveNulls,omitempty"`
-
- // Priority: [Optional] Specifies a priority for the query. Possible
- // values include INTERACTIVE and BATCH. The default value is
- // INTERACTIVE.
- Priority string `json:"priority,omitempty"`
-
- // Query: [Required] BigQuery SQL query to execute.
- Query string `json:"query,omitempty"`
-
- // TableDefinitions: [Experimental] If querying an external data source
- // outside of BigQuery, describes the data format, location and other
- // properties of the data source. By defining these properties, the data
- // source can then be queried as if it were a standard BigQuery table.
- TableDefinitions map[string]ExternalDataConfiguration `json:"tableDefinitions,omitempty"`
-
- // UseQueryCache: [Optional] Whether to look for the result in the query
- // cache. The query cache is a best-effort cache that will be flushed
- // whenever tables in the query are modified. Moreover, the query cache
- // is only available when a query does not have a destination table
- // specified. The default value is true.
- //
- // Default: true
- UseQueryCache *bool `json:"useQueryCache,omitempty"`
-
- // UserDefinedFunctionResources: [Experimental] Describes user-defined
- // function resources used in the query.
- UserDefinedFunctionResources []*UserDefinedFunctionResource `json:"userDefinedFunctionResources,omitempty"`
-
- // WriteDisposition: [Optional] Specifies the action that occurs if the
- // destination table already exists. The following values are supported:
- // WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the
- // table data. WRITE_APPEND: If the table already exists, BigQuery
- // appends the data to the table. WRITE_EMPTY: If the table already
- // exists and contains data, a 'duplicate' error is returned in the job
- // result. The default value is WRITE_EMPTY. Each action is atomic and
- // only occurs if BigQuery is able to complete the job successfully.
- // Creation, truncation and append actions occur as one atomic update
- // upon job completion.
- WriteDisposition string `json:"writeDisposition,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AllowLargeResults")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *JobConfigurationQuery) MarshalJSON() ([]byte, error) {
- type noMethod JobConfigurationQuery
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type JobConfigurationTableCopy struct {
- // CreateDisposition: [Optional] Specifies whether the job is allowed to
- // create new tables. The following values are supported:
- // CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the
- // table. CREATE_NEVER: The table must already exist. If it does not, a
- // 'notFound' error is returned in the job result. The default value is
- // CREATE_IF_NEEDED. Creation, truncation and append actions occur as
- // one atomic update upon job completion.
- CreateDisposition string `json:"createDisposition,omitempty"`
-
- // DestinationTable: [Required] The destination table
- DestinationTable *TableReference `json:"destinationTable,omitempty"`
-
- // SourceTable: [Pick one] Source table to copy.
- SourceTable *TableReference `json:"sourceTable,omitempty"`
-
- // SourceTables: [Pick one] Source tables to copy.
- SourceTables []*TableReference `json:"sourceTables,omitempty"`
-
- // WriteDisposition: [Optional] Specifies the action that occurs if the
- // destination table already exists. The following values are supported:
- // WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the
- // table data. WRITE_APPEND: If the table already exists, BigQuery
- // appends the data to the table. WRITE_EMPTY: If the table already
- // exists and contains data, a 'duplicate' error is returned in the job
- // result. The default value is WRITE_EMPTY. Each action is atomic and
- // only occurs if BigQuery is able to complete the job successfully.
- // Creation, truncation and append actions occur as one atomic update
- // upon job completion.
- WriteDisposition string `json:"writeDisposition,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CreateDisposition")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *JobConfigurationTableCopy) MarshalJSON() ([]byte, error) {
- type noMethod JobConfigurationTableCopy
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type JobList struct {
- // Etag: A hash of this page of results.
- Etag string `json:"etag,omitempty"`
-
- // Jobs: List of jobs that were requested.
- Jobs []*JobListJobs `json:"jobs,omitempty"`
-
- // Kind: The resource type of the response.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: A token to request the next page of results.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *JobList) MarshalJSON() ([]byte, error) {
- type noMethod JobList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type JobListJobs struct {
- // Configuration: [Full-projection-only] Specifies the job
- // configuration.
- Configuration *JobConfiguration `json:"configuration,omitempty"`
-
- // ErrorResult: A result object that will be present only if the job has
- // failed.
- ErrorResult *ErrorProto `json:"errorResult,omitempty"`
-
- // Id: Unique opaque ID of the job.
- Id string `json:"id,omitempty"`
-
- // JobReference: Job reference uniquely identifying the job.
- JobReference *JobReference `json:"jobReference,omitempty"`
-
- // Kind: The resource type.
- Kind string `json:"kind,omitempty"`
-
- // State: Running state of the job. When the state is DONE, errorResult
- // can be checked to determine whether the job succeeded or failed.
- State string `json:"state,omitempty"`
-
- // Statistics: [Output-only] Information about the job, including
- // starting time and ending time of the job.
- Statistics *JobStatistics `json:"statistics,omitempty"`
-
- // Status: [Full-projection-only] Describes the state of the job.
- Status *JobStatus `json:"status,omitempty"`
-
- // UserEmail: [Full-projection-only] Email address of the user who ran
- // the job.
- UserEmail string `json:"user_email,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Configuration") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *JobListJobs) MarshalJSON() ([]byte, error) {
- type noMethod JobListJobs
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type JobReference struct {
- // JobId: [Required] The ID of the job. The ID must contain only letters
- // (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The
- // maximum length is 1,024 characters.
- JobId string `json:"jobId,omitempty"`
-
- // ProjectId: [Required] The ID of the project containing this job.
- ProjectId string `json:"projectId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "JobId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *JobReference) MarshalJSON() ([]byte, error) {
- type noMethod JobReference
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type JobStatistics struct {
- // CreationTime: [Output-only] Creation time of this job, in
- // milliseconds since the epoch. This field will be present on all jobs.
- CreationTime int64 `json:"creationTime,omitempty,string"`
-
- // EndTime: [Output-only] End time of this job, in milliseconds since
- // the epoch. This field will be present whenever a job is in the DONE
- // state.
- EndTime int64 `json:"endTime,omitempty,string"`
-
- // Extract: [Output-only] Statistics for an extract job.
- Extract *JobStatistics4 `json:"extract,omitempty"`
-
- // Load: [Output-only] Statistics for a load job.
- Load *JobStatistics3 `json:"load,omitempty"`
-
- // Query: [Output-only] Statistics for a query job.
- Query *JobStatistics2 `json:"query,omitempty"`
-
- // StartTime: [Output-only] Start time of this job, in milliseconds
- // since the epoch. This field will be present when the job transitions
- // from the PENDING state to either RUNNING or DONE.
- StartTime int64 `json:"startTime,omitempty,string"`
-
- // TotalBytesProcessed: [Output-only] [Deprecated] Use the bytes
- // processed in the query statistics instead.
- TotalBytesProcessed int64 `json:"totalBytesProcessed,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTime") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *JobStatistics) MarshalJSON() ([]byte, error) {
- type noMethod JobStatistics
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type JobStatistics2 struct {
- // BillingTier: [Output-only] Billing tier for the job.
- BillingTier int64 `json:"billingTier,omitempty"`
-
- // CacheHit: [Output-only] Whether the query result was fetched from the
- // query cache.
- CacheHit bool `json:"cacheHit,omitempty"`
-
- // TotalBytesBilled: [Output-only] Total bytes billed for the job.
- TotalBytesBilled int64 `json:"totalBytesBilled,omitempty,string"`
-
- // TotalBytesProcessed: [Output-only] Total bytes processed for the job.
- TotalBytesProcessed int64 `json:"totalBytesProcessed,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "BillingTier") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *JobStatistics2) MarshalJSON() ([]byte, error) {
- type noMethod JobStatistics2
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type JobStatistics3 struct {
- // InputFileBytes: [Output-only] Number of bytes of source data in a
- // load job.
- InputFileBytes int64 `json:"inputFileBytes,omitempty,string"`
-
- // InputFiles: [Output-only] Number of source files in a load job.
- InputFiles int64 `json:"inputFiles,omitempty,string"`
-
- // OutputBytes: [Output-only] Size of the loaded data in bytes. Note
- // that while a load job is in the running state, this value may change.
- OutputBytes int64 `json:"outputBytes,omitempty,string"`
-
- // OutputRows: [Output-only] Number of rows imported in a load job. Note
- // that while an import job is in the running state, this value may
- // change.
- OutputRows int64 `json:"outputRows,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "InputFileBytes") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *JobStatistics3) MarshalJSON() ([]byte, error) {
- type noMethod JobStatistics3
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type JobStatistics4 struct {
- // DestinationUriFileCounts: [Output-only] Number of files per
- // destination URI or URI pattern specified in the extract
- // configuration. These values will be in the same order as the URIs
- // specified in the 'destinationUris' field.
- DestinationUriFileCounts googleapi.Int64s `json:"destinationUriFileCounts,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "DestinationUriFileCounts") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *JobStatistics4) MarshalJSON() ([]byte, error) {
- type noMethod JobStatistics4
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type JobStatus struct {
- // ErrorResult: [Output-only] Final error result of the job. If present,
- // indicates that the job has completed and was unsuccessful.
- ErrorResult *ErrorProto `json:"errorResult,omitempty"`
-
- // Errors: [Output-only] All errors encountered during the running of
- // the job. Errors here do not necessarily mean that the job has
- // completed or was unsuccessful.
- Errors []*ErrorProto `json:"errors,omitempty"`
-
- // State: [Output-only] Running state of the job.
- State string `json:"state,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ErrorResult") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *JobStatus) MarshalJSON() ([]byte, error) {
- type noMethod JobStatus
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type JsonValue interface{}
-
-type ProjectList struct {
- // Etag: A hash of the page of results
- Etag string `json:"etag,omitempty"`
-
- // Kind: The type of list.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: A token to request the next page of results.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Projects: Projects to which you have at least READ access.
- Projects []*ProjectListProjects `json:"projects,omitempty"`
-
- // TotalItems: The total number of projects in the list.
- TotalItems int64 `json:"totalItems,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProjectList) MarshalJSON() ([]byte, error) {
- type noMethod ProjectList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ProjectListProjects struct {
- // FriendlyName: A descriptive name for this project.
- FriendlyName string `json:"friendlyName,omitempty"`
-
- // Id: An opaque ID of this project.
- Id string `json:"id,omitempty"`
-
- // Kind: The resource type.
- Kind string `json:"kind,omitempty"`
-
- // NumericId: The numeric ID of this project.
- NumericId uint64 `json:"numericId,omitempty,string"`
-
- // ProjectReference: A unique reference to this project.
- ProjectReference *ProjectReference `json:"projectReference,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "FriendlyName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProjectListProjects) MarshalJSON() ([]byte, error) {
- type noMethod ProjectListProjects
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ProjectReference struct {
- // ProjectId: [Required] ID of the project. Can be either the numeric ID
- // or the assigned ID of the project.
- ProjectId string `json:"projectId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ProjectId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProjectReference) MarshalJSON() ([]byte, error) {
- type noMethod ProjectReference
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type QueryRequest struct {
- // DefaultDataset: [Optional] Specifies the default datasetId and
- // projectId to assume for any unqualified table names in the query. If
- // not set, all table names in the query string must be qualified in the
- // format 'datasetId.tableId'.
- DefaultDataset *DatasetReference `json:"defaultDataset,omitempty"`
-
- // DryRun: [Optional] If set to true, BigQuery doesn't run the job.
- // Instead, if the query is valid, BigQuery returns statistics about the
- // job such as how many bytes would be processed. If the query is
- // invalid, an error returns. The default value is false.
- DryRun bool `json:"dryRun,omitempty"`
-
- // Kind: The resource type of the request.
- Kind string `json:"kind,omitempty"`
-
- // MaxResults: [Optional] The maximum number of rows of data to return
- // per page of results. Setting this flag to a small value such as 1000
- // and then paging through results might improve reliability when the
- // query result set is large. In addition to this limit, responses are
- // also limited to 10 MB. By default, there is no maximum row count, and
- // only the byte limit applies.
- MaxResults int64 `json:"maxResults,omitempty"`
-
- // PreserveNulls: [Deprecated] This property is deprecated.
- PreserveNulls bool `json:"preserveNulls,omitempty"`
-
- // Query: [Required] A query string, following the BigQuery query
- // syntax, of the query to execute. Example: "SELECT count(f1) FROM
- // [myProjectId:myDatasetId.myTableId]".
- Query string `json:"query,omitempty"`
-
- // TimeoutMs: [Optional] How long to wait for the query to complete, in
- // milliseconds, before the request times out and returns. Note that
- // this is only a timeout for the request, not the query. If the query
- // takes longer to run than the timeout value, the call returns without
- // any results and with the 'jobComplete' flag set to false. You can
- // call GetQueryResults() to wait for the query to complete and read the
- // results. The default value is 10000 milliseconds (10 seconds).
- TimeoutMs int64 `json:"timeoutMs,omitempty"`
-
- // UseQueryCache: [Optional] Whether to look for the result in the query
- // cache. The query cache is a best-effort cache that will be flushed
- // whenever tables in the query are modified. The default value is true.
- //
- // Default: true
- UseQueryCache *bool `json:"useQueryCache,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DefaultDataset") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *QueryRequest) MarshalJSON() ([]byte, error) {
- type noMethod QueryRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type QueryResponse struct {
- // CacheHit: Whether the query result was fetched from the query cache.
- CacheHit bool `json:"cacheHit,omitempty"`
-
- // Errors: [Output-only] All errors and warnings encountered during the
- // running of the job. Errors here do not necessarily mean that the job
- // has completed or was unsuccessful.
- Errors []*ErrorProto `json:"errors,omitempty"`
-
- // JobComplete: Whether the query has completed or not. If rows or
- // totalRows are present, this will always be true. If this is false,
- // totalRows will not be available.
- JobComplete bool `json:"jobComplete,omitempty"`
-
- // JobReference: Reference to the Job that was created to run the query.
- // This field will be present even if the original request timed out, in
- // which case GetQueryResults can be used to read the results once the
- // query has completed. Since this API only returns the first page of
- // results, subsequent pages can be fetched via the same mechanism
- // (GetQueryResults).
- JobReference *JobReference `json:"jobReference,omitempty"`
-
- // Kind: The resource type.
- Kind string `json:"kind,omitempty"`
-
- // PageToken: A token used for paging results.
- PageToken string `json:"pageToken,omitempty"`
-
- // Rows: An object with as many results as can be contained within the
- // maximum permitted reply size. To get any additional rows, you can
- // call GetQueryResults and specify the jobReference returned above.
- Rows []*TableRow `json:"rows,omitempty"`
-
- // Schema: The schema of the results. Present only when the query
- // completes successfully.
- Schema *TableSchema `json:"schema,omitempty"`
-
- // TotalBytesProcessed: The total number of bytes processed for this
- // query. If this query was a dry run, this is the number of bytes that
- // would be processed if the query were run.
- TotalBytesProcessed int64 `json:"totalBytesProcessed,omitempty,string"`
-
- // TotalRows: The total number of rows in the complete query result set,
- // which can be more than the number of rows in this single page of
- // results.
- TotalRows uint64 `json:"totalRows,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CacheHit") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *QueryResponse) MarshalJSON() ([]byte, error) {
- type noMethod QueryResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Streamingbuffer struct {
- // EstimatedBytes: [Output-only] A lower-bound estimate of the number of
- // bytes currently in the streaming buffer.
- EstimatedBytes uint64 `json:"estimatedBytes,omitempty,string"`
-
- // EstimatedRows: [Output-only] A lower-bound estimate of the number of
- // rows currently in the streaming buffer.
- EstimatedRows uint64 `json:"estimatedRows,omitempty,string"`
-
- // OldestEntryTime: [Output-only] Contains the timestamp of the oldest
- // entry in the streaming buffer, in milliseconds since the epoch, if
- // the streaming buffer is available.
- OldestEntryTime uint64 `json:"oldestEntryTime,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "EstimatedBytes") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Streamingbuffer) MarshalJSON() ([]byte, error) {
- type noMethod Streamingbuffer
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Table struct {
- // CreationTime: [Output-only] The time when this table was created, in
- // milliseconds since the epoch.
- CreationTime int64 `json:"creationTime,omitempty,string"`
-
- // Description: [Optional] A user-friendly description of this table.
- Description string `json:"description,omitempty"`
-
- // Etag: [Output-only] A hash of this resource.
- Etag string `json:"etag,omitempty"`
-
- // ExpirationTime: [Optional] The time when this table expires, in
- // milliseconds since the epoch. If not present, the table will persist
- // indefinitely. Expired tables will be deleted and their storage
- // reclaimed.
- ExpirationTime int64 `json:"expirationTime,omitempty,string"`
-
- // ExternalDataConfiguration: [Experimental] Describes the data format,
- // location, and other properties of a table stored outside of BigQuery.
- // By defining these properties, the data source can then be queried as
- // if it were a standard BigQuery table.
- ExternalDataConfiguration *ExternalDataConfiguration `json:"externalDataConfiguration,omitempty"`
-
- // FriendlyName: [Optional] A descriptive name for this table.
- FriendlyName string `json:"friendlyName,omitempty"`
-
- // Id: [Output-only] An opaque ID uniquely identifying the table.
- Id string `json:"id,omitempty"`
-
- // Kind: [Output-only] The type of the resource.
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedTime: [Output-only] The time when this table was last
- // modified, in milliseconds since the epoch.
- LastModifiedTime uint64 `json:"lastModifiedTime,omitempty,string"`
-
- // Location: [Output-only] The geographic location where the table
- // resides. This value is inherited from the dataset.
- Location string `json:"location,omitempty"`
-
- // NumBytes: [Output-only] The size of this table in bytes, excluding
- // any data in the streaming buffer.
- NumBytes int64 `json:"numBytes,omitempty,string"`
-
- // NumRows: [Output-only] The number of rows of data in this table,
- // excluding any data in the streaming buffer.
- NumRows uint64 `json:"numRows,omitempty,string"`
-
- // Schema: [Optional] Describes the schema of this table.
- Schema *TableSchema `json:"schema,omitempty"`
-
- // SelfLink: [Output-only] A URL that can be used to access this
- // resource again.
- SelfLink string `json:"selfLink,omitempty"`
-
- // StreamingBuffer: [Output-only] Contains information regarding this
- // table's streaming buffer, if one is present. This field will be
- // absent if the table is not being streamed to or if there is no data
- // in the streaming buffer.
- StreamingBuffer *Streamingbuffer `json:"streamingBuffer,omitempty"`
-
- // TableReference: [Required] Reference describing the ID of this table.
- TableReference *TableReference `json:"tableReference,omitempty"`
-
- // Type: [Output-only] Describes the table type. The following values
- // are supported: TABLE: A normal BigQuery table. VIEW: A virtual table
- // defined by a SQL query. The default value is TABLE.
- Type string `json:"type,omitempty"`
-
- // View: [Optional] The view definition.
- View *ViewDefinition `json:"view,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTime") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Table) MarshalJSON() ([]byte, error) {
- type noMethod Table
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TableCell struct {
- V interface{} `json:"v,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "V") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TableCell) MarshalJSON() ([]byte, error) {
- type noMethod TableCell
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TableDataInsertAllRequest struct {
- // IgnoreUnknownValues: [Optional] Accept rows that contain values that
- // do not match the schema. The unknown values are ignored. Default is
- // false, which treats unknown values as errors.
- IgnoreUnknownValues bool `json:"ignoreUnknownValues,omitempty"`
-
- // Kind: The resource type of the response.
- Kind string `json:"kind,omitempty"`
-
- // Rows: The rows to insert.
- Rows []*TableDataInsertAllRequestRows `json:"rows,omitempty"`
-
- // SkipInvalidRows: [Optional] Insert all valid rows of a request, even
- // if invalid rows exist. The default value is false, which causes the
- // entire request to fail if any invalid rows exist.
- SkipInvalidRows bool `json:"skipInvalidRows,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "IgnoreUnknownValues")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TableDataInsertAllRequest) MarshalJSON() ([]byte, error) {
- type noMethod TableDataInsertAllRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TableDataInsertAllRequestRows struct {
- // InsertId: [Optional] A unique ID for each row. BigQuery uses this
- // property to detect duplicate insertion requests on a best-effort
- // basis.
- InsertId string `json:"insertId,omitempty"`
-
- // Json: [Required] A JSON object that contains a row of data. The
- // object's properties and values must match the destination table's
- // schema.
- Json map[string]JsonValue `json:"json,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "InsertId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TableDataInsertAllRequestRows) MarshalJSON() ([]byte, error) {
- type noMethod TableDataInsertAllRequestRows
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TableDataInsertAllResponse struct {
- // InsertErrors: An array of errors for rows that were not inserted.
- InsertErrors []*TableDataInsertAllResponseInsertErrors `json:"insertErrors,omitempty"`
-
- // Kind: The resource type of the response.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "InsertErrors") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TableDataInsertAllResponse) MarshalJSON() ([]byte, error) {
- type noMethod TableDataInsertAllResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TableDataInsertAllResponseInsertErrors struct {
- // Errors: Error information for the row indicated by the index
- // property.
- Errors []*ErrorProto `json:"errors,omitempty"`
-
- // Index: The index of the row that error applies to.
- Index int64 `json:"index,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Errors") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TableDataInsertAllResponseInsertErrors) MarshalJSON() ([]byte, error) {
- type noMethod TableDataInsertAllResponseInsertErrors
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TableDataList struct {
- // Etag: A hash of this page of results.
- Etag string `json:"etag,omitempty"`
-
- // Kind: The resource type of the response.
- Kind string `json:"kind,omitempty"`
-
- // PageToken: A token used for paging results. Providing this token
- // instead of the startIndex parameter can help you retrieve stable
- // results when an underlying table is changing.
- PageToken string `json:"pageToken,omitempty"`
-
- // Rows: Rows of results.
- Rows []*TableRow `json:"rows,omitempty"`
-
- // TotalRows: The total number of rows in the complete table.
- TotalRows int64 `json:"totalRows,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TableDataList) MarshalJSON() ([]byte, error) {
- type noMethod TableDataList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TableFieldSchema struct {
- // Description: [Optional] The field description. The maximum length is
- // 16K characters.
- Description string `json:"description,omitempty"`
-
- // Fields: [Optional] Describes the nested schema fields if the type
- // property is set to RECORD.
- Fields []*TableFieldSchema `json:"fields,omitempty"`
-
- // Mode: [Optional] The field mode. Possible values include NULLABLE,
- // REQUIRED and REPEATED. The default value is NULLABLE.
- Mode string `json:"mode,omitempty"`
-
- // Name: [Required] The field name. The name must contain only letters
- // (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a
- // letter or underscore. The maximum length is 128 characters.
- Name string `json:"name,omitempty"`
-
- // Type: [Required] The field data type. Possible values include STRING,
- // INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates
- // that the field contains a nested schema).
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Description") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TableFieldSchema) MarshalJSON() ([]byte, error) {
- type noMethod TableFieldSchema
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TableList struct {
- // Etag: A hash of this page of results.
- Etag string `json:"etag,omitempty"`
-
- // Kind: The type of list.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: A token to request the next page of results.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Tables: Tables in the requested dataset.
- Tables []*TableListTables `json:"tables,omitempty"`
-
- // TotalItems: The total number of tables in the dataset.
- TotalItems int64 `json:"totalItems,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TableList) MarshalJSON() ([]byte, error) {
- type noMethod TableList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TableListTables struct {
- // FriendlyName: The user-friendly name for this table.
- FriendlyName string `json:"friendlyName,omitempty"`
-
- // Id: An opaque ID of the table
- Id string `json:"id,omitempty"`
-
- // Kind: The resource type.
- Kind string `json:"kind,omitempty"`
-
- // TableReference: A reference uniquely identifying the table.
- TableReference *TableReference `json:"tableReference,omitempty"`
-
- // Type: The type of table. Possible values are: TABLE, VIEW.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "FriendlyName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TableListTables) MarshalJSON() ([]byte, error) {
- type noMethod TableListTables
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TableReference struct {
- // DatasetId: [Required] The ID of the dataset containing this table.
- DatasetId string `json:"datasetId,omitempty"`
-
- // ProjectId: [Required] The ID of the project containing this table.
- ProjectId string `json:"projectId,omitempty"`
-
- // TableId: [Required] The ID of the table. The ID must contain only
- // letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum
- // length is 1,024 characters.
- TableId string `json:"tableId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DatasetId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TableReference) MarshalJSON() ([]byte, error) {
- type noMethod TableReference
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TableRow struct {
- // F: Represents a single row in the result set, consisting of one or
- // more fields.
- F []*TableCell `json:"f,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "F") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TableRow) MarshalJSON() ([]byte, error) {
- type noMethod TableRow
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TableSchema struct {
- // Fields: Describes the fields in a table.
- Fields []*TableFieldSchema `json:"fields,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Fields") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TableSchema) MarshalJSON() ([]byte, error) {
- type noMethod TableSchema
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UserDefinedFunctionResource struct {
- // InlineCode: [Pick one] An inline resource that contains code for a
- // user-defined function (UDF). Providing a inline code resource is
- // equivalent to providing a URI for a file containing the same code.
- InlineCode string `json:"inlineCode,omitempty"`
-
- // ResourceUri: [Pick one] A code resource to load from a Google Cloud
- // Storage URI (gs://bucket/path).
- ResourceUri string `json:"resourceUri,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "InlineCode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserDefinedFunctionResource) MarshalJSON() ([]byte, error) {
- type noMethod UserDefinedFunctionResource
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ViewDefinition struct {
- // Query: [Required] A query that BigQuery executes when the view is
- // referenced.
- Query string `json:"query,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Query") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ViewDefinition) MarshalJSON() ([]byte, error) {
- type noMethod ViewDefinition
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "bigquery.datasets.delete":
-
-type DatasetsDeleteCall struct {
- s *Service
- projectId string
- datasetId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the dataset specified by the datasetId value. Before
-// you can delete a dataset, you must delete all its tables, either
-// manually or by specifying deleteContents. Immediately after deletion,
-// you can create another dataset with the same name.
-func (r *DatasetsService) Delete(projectId string, datasetId string) *DatasetsDeleteCall {
- c := &DatasetsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.datasetId = datasetId
- return c
-}
-
-// DeleteContents sets the optional parameter "deleteContents": If True,
-// delete all the tables in the dataset. If False and the dataset
-// contains tables, the request will fail. Default is False
-func (c *DatasetsDeleteCall) DeleteContents(deleteContents bool) *DatasetsDeleteCall {
- c.opt_["deleteContents"] = deleteContents
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatasetsDeleteCall) Fields(s ...googleapi.Field) *DatasetsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatasetsDeleteCall) Context(ctx context.Context) *DatasetsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatasetsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["deleteContents"]; ok {
- params.Set("deleteContents", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{projectId}/datasets/{datasetId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "datasetId": c.datasetId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "bigquery.datasets.delete" call.
-func (c *DatasetsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes the dataset specified by the datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name.",
- // "httpMethod": "DELETE",
- // "id": "bigquery.datasets.delete",
- // "parameterOrder": [
- // "projectId",
- // "datasetId"
- // ],
- // "parameters": {
- // "datasetId": {
- // "description": "Dataset ID of dataset being deleted",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "deleteContents": {
- // "description": "If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False",
- // "location": "query",
- // "type": "boolean"
- // },
- // "projectId": {
- // "description": "Project ID of the dataset being deleted",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "projects/{projectId}/datasets/{datasetId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/bigquery",
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "bigquery.datasets.get":
-
-type DatasetsGetCall struct {
- s *Service
- projectId string
- datasetId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the dataset specified by datasetID.
-func (r *DatasetsService) Get(projectId string, datasetId string) *DatasetsGetCall {
- c := &DatasetsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.datasetId = datasetId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatasetsGetCall) Fields(s ...googleapi.Field) *DatasetsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DatasetsGetCall) IfNoneMatch(entityTag string) *DatasetsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatasetsGetCall) Context(ctx context.Context) *DatasetsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatasetsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{projectId}/datasets/{datasetId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "datasetId": c.datasetId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "bigquery.datasets.get" call.
-// Exactly one of *Dataset or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Dataset.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *DatasetsGetCall) Do() (*Dataset, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Dataset{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the dataset specified by datasetID.",
- // "httpMethod": "GET",
- // "id": "bigquery.datasets.get",
- // "parameterOrder": [
- // "projectId",
- // "datasetId"
- // ],
- // "parameters": {
- // "datasetId": {
- // "description": "Dataset ID of the requested dataset",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "Project ID of the requested dataset",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "projects/{projectId}/datasets/{datasetId}",
- // "response": {
- // "$ref": "Dataset"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/bigquery",
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only"
- // ]
- // }
-
-}
-
-// method id "bigquery.datasets.insert":
-
-type DatasetsInsertCall struct {
- s *Service
- projectId string
- dataset *Dataset
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a new empty dataset.
-func (r *DatasetsService) Insert(projectId string, dataset *Dataset) *DatasetsInsertCall {
- c := &DatasetsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.dataset = dataset
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatasetsInsertCall) Fields(s ...googleapi.Field) *DatasetsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatasetsInsertCall) Context(ctx context.Context) *DatasetsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatasetsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.dataset)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{projectId}/datasets")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "bigquery.datasets.insert" call.
-// Exactly one of *Dataset or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Dataset.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *DatasetsInsertCall) Do() (*Dataset, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Dataset{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a new empty dataset.",
- // "httpMethod": "POST",
- // "id": "bigquery.datasets.insert",
- // "parameterOrder": [
- // "projectId"
- // ],
- // "parameters": {
- // "projectId": {
- // "description": "Project ID of the new dataset",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "projects/{projectId}/datasets",
- // "request": {
- // "$ref": "Dataset"
- // },
- // "response": {
- // "$ref": "Dataset"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/bigquery",
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "bigquery.datasets.list":
-
-type DatasetsListCall struct {
- s *Service
- projectId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all datasets in the specified project to which you have
-// been granted the READER dataset role.
-func (r *DatasetsService) List(projectId string) *DatasetsListCall {
- c := &DatasetsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- return c
-}
-
-// All sets the optional parameter "all": Whether to list all datasets,
-// including hidden ones
-func (c *DatasetsListCall) All(all bool) *DatasetsListCall {
- c.opt_["all"] = all
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of results to return
-func (c *DatasetsListCall) MaxResults(maxResults int64) *DatasetsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Page token,
-// returned by a previous call, to request the next page of results
-func (c *DatasetsListCall) PageToken(pageToken string) *DatasetsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatasetsListCall) Fields(s ...googleapi.Field) *DatasetsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DatasetsListCall) IfNoneMatch(entityTag string) *DatasetsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatasetsListCall) Context(ctx context.Context) *DatasetsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatasetsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["all"]; ok {
- params.Set("all", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{projectId}/datasets")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "bigquery.datasets.list" call.
-// Exactly one of *DatasetList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *DatasetList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DatasetsListCall) Do() (*DatasetList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DatasetList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all datasets in the specified project to which you have been granted the READER dataset role.",
- // "httpMethod": "GET",
- // "id": "bigquery.datasets.list",
- // "parameterOrder": [
- // "projectId"
- // ],
- // "parameters": {
- // "all": {
- // "description": "Whether to list all datasets, including hidden ones",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "The maximum number of results to return",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Page token, returned by a previous call, to request the next page of results",
- // "location": "query",
- // "type": "string"
- // },
- // "projectId": {
- // "description": "Project ID of the datasets to be listed",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "projects/{projectId}/datasets",
- // "response": {
- // "$ref": "DatasetList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/bigquery",
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only"
- // ]
- // }
-
-}
-
-// method id "bigquery.datasets.patch":
-
-type DatasetsPatchCall struct {
- s *Service
- projectId string
- datasetId string
- dataset *Dataset
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates information in an existing dataset. The update method
-// replaces the entire dataset resource, whereas the patch method only
-// replaces fields that are provided in the submitted dataset resource.
-// This method supports patch semantics.
-func (r *DatasetsService) Patch(projectId string, datasetId string, dataset *Dataset) *DatasetsPatchCall {
- c := &DatasetsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.datasetId = datasetId
- c.dataset = dataset
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatasetsPatchCall) Fields(s ...googleapi.Field) *DatasetsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatasetsPatchCall) Context(ctx context.Context) *DatasetsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatasetsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.dataset)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{projectId}/datasets/{datasetId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "datasetId": c.datasetId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "bigquery.datasets.patch" call.
-// Exactly one of *Dataset or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Dataset.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *DatasetsPatchCall) Do() (*Dataset, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Dataset{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "bigquery.datasets.patch",
- // "parameterOrder": [
- // "projectId",
- // "datasetId"
- // ],
- // "parameters": {
- // "datasetId": {
- // "description": "Dataset ID of the dataset being updated",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "Project ID of the dataset being updated",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "projects/{projectId}/datasets/{datasetId}",
- // "request": {
- // "$ref": "Dataset"
- // },
- // "response": {
- // "$ref": "Dataset"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/bigquery",
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "bigquery.datasets.update":
-
-type DatasetsUpdateCall struct {
- s *Service
- projectId string
- datasetId string
- dataset *Dataset
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates information in an existing dataset. The update method
-// replaces the entire dataset resource, whereas the patch method only
-// replaces fields that are provided in the submitted dataset resource.
-func (r *DatasetsService) Update(projectId string, datasetId string, dataset *Dataset) *DatasetsUpdateCall {
- c := &DatasetsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.datasetId = datasetId
- c.dataset = dataset
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatasetsUpdateCall) Fields(s ...googleapi.Field) *DatasetsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatasetsUpdateCall) Context(ctx context.Context) *DatasetsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatasetsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.dataset)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{projectId}/datasets/{datasetId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "datasetId": c.datasetId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "bigquery.datasets.update" call.
-// Exactly one of *Dataset or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Dataset.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *DatasetsUpdateCall) Do() (*Dataset, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Dataset{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource.",
- // "httpMethod": "PUT",
- // "id": "bigquery.datasets.update",
- // "parameterOrder": [
- // "projectId",
- // "datasetId"
- // ],
- // "parameters": {
- // "datasetId": {
- // "description": "Dataset ID of the dataset being updated",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "Project ID of the dataset being updated",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "projects/{projectId}/datasets/{datasetId}",
- // "request": {
- // "$ref": "Dataset"
- // },
- // "response": {
- // "$ref": "Dataset"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/bigquery",
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "bigquery.jobs.cancel":
-
-type JobsCancelCall struct {
- s *Service
- projectId string
- jobId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Cancel: Requests that a job be cancelled. This call will return
-// immediately, and the client will need to poll for the job status to
-// see if the cancel completed successfully. Cancelled jobs may still
-// incur costs.
-func (r *JobsService) Cancel(projectId string, jobId string) *JobsCancelCall {
- c := &JobsCancelCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.jobId = jobId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *JobsCancelCall) Fields(s ...googleapi.Field) *JobsCancelCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *JobsCancelCall) Context(ctx context.Context) *JobsCancelCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *JobsCancelCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "project/{projectId}/jobs/{jobId}/cancel")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "jobId": c.jobId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "bigquery.jobs.cancel" call.
-// Exactly one of *JobCancelResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *JobCancelResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *JobsCancelCall) Do() (*JobCancelResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &JobCancelResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs.",
- // "httpMethod": "POST",
- // "id": "bigquery.jobs.cancel",
- // "parameterOrder": [
- // "projectId",
- // "jobId"
- // ],
- // "parameters": {
- // "jobId": {
- // "description": "Job ID of the job to cancel",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "Project ID of the job to cancel",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "project/{projectId}/jobs/{jobId}/cancel",
- // "response": {
- // "$ref": "JobCancelResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/bigquery",
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "bigquery.jobs.get":
-
-type JobsGetCall struct {
- s *Service
- projectId string
- jobId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns information about a specific job. Job information is
-// available for a six month period after creation. Requires that you're
-// the person who ran the job, or have the Is Owner project role.
-func (r *JobsService) Get(projectId string, jobId string) *JobsGetCall {
- c := &JobsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.jobId = jobId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *JobsGetCall) Fields(s ...googleapi.Field) *JobsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *JobsGetCall) IfNoneMatch(entityTag string) *JobsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *JobsGetCall) Context(ctx context.Context) *JobsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *JobsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{projectId}/jobs/{jobId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "jobId": c.jobId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "bigquery.jobs.get" call.
-// Exactly one of *Job or error will be non-nil. Any non-2xx status code
-// is an error. Response headers are in either
-// *Job.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *JobsGetCall) Do() (*Job, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Job{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role.",
- // "httpMethod": "GET",
- // "id": "bigquery.jobs.get",
- // "parameterOrder": [
- // "projectId",
- // "jobId"
- // ],
- // "parameters": {
- // "jobId": {
- // "description": "Job ID of the requested job",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "Project ID of the requested job",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "projects/{projectId}/jobs/{jobId}",
- // "response": {
- // "$ref": "Job"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/bigquery",
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only"
- // ]
- // }
-
-}
-
-// method id "bigquery.jobs.getQueryResults":
-
-type JobsGetQueryResultsCall struct {
- s *Service
- projectId string
- jobId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetQueryResults: Retrieves the results of a query job.
-func (r *JobsService) GetQueryResults(projectId string, jobId string) *JobsGetQueryResultsCall {
- c := &JobsGetQueryResultsCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.jobId = jobId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to read
-func (c *JobsGetQueryResultsCall) MaxResults(maxResults int64) *JobsGetQueryResultsCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Page token,
-// returned by a previous call, to request the next page of results
-func (c *JobsGetQueryResultsCall) PageToken(pageToken string) *JobsGetQueryResultsCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex": Zero-based index
-// of the starting row
-func (c *JobsGetQueryResultsCall) StartIndex(startIndex uint64) *JobsGetQueryResultsCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// TimeoutMs sets the optional parameter "timeoutMs": How long to wait
-// for the query to complete, in milliseconds, before returning. Default
-// is 10 seconds. If the timeout passes before the job completes, the
-// 'jobComplete' field in the response will be false
-func (c *JobsGetQueryResultsCall) TimeoutMs(timeoutMs int64) *JobsGetQueryResultsCall {
- c.opt_["timeoutMs"] = timeoutMs
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *JobsGetQueryResultsCall) Fields(s ...googleapi.Field) *JobsGetQueryResultsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *JobsGetQueryResultsCall) IfNoneMatch(entityTag string) *JobsGetQueryResultsCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *JobsGetQueryResultsCall) Context(ctx context.Context) *JobsGetQueryResultsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *JobsGetQueryResultsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["timeoutMs"]; ok {
- params.Set("timeoutMs", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{projectId}/queries/{jobId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "jobId": c.jobId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "bigquery.jobs.getQueryResults" call.
-// Exactly one of *GetQueryResultsResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *GetQueryResultsResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *JobsGetQueryResultsCall) Do() (*GetQueryResultsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &GetQueryResultsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the results of a query job.",
- // "httpMethod": "GET",
- // "id": "bigquery.jobs.getQueryResults",
- // "parameterOrder": [
- // "projectId",
- // "jobId"
- // ],
- // "parameters": {
- // "jobId": {
- // "description": "Job ID of the query job",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to read",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Page token, returned by a previous call, to request the next page of results",
- // "location": "query",
- // "type": "string"
- // },
- // "projectId": {
- // "description": "Project ID of the query job",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "startIndex": {
- // "description": "Zero-based index of the starting row",
- // "format": "uint64",
- // "location": "query",
- // "type": "string"
- // },
- // "timeoutMs": {
- // "description": "How long to wait for the query to complete, in milliseconds, before returning. Default is 10 seconds. If the timeout passes before the job completes, the 'jobComplete' field in the response will be false",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // }
- // },
- // "path": "projects/{projectId}/queries/{jobId}",
- // "response": {
- // "$ref": "GetQueryResultsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/bigquery",
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only"
- // ]
- // }
-
-}
-
-// method id "bigquery.jobs.insert":
-
-type JobsInsertCall struct {
- s *Service
- projectId string
- job *Job
- opt_ map[string]interface{}
- media_ io.Reader
- resumable_ googleapi.SizeReaderAt
- mediaType_ string
- protocol_ string
- ctx_ context.Context
-}
-
-// Insert: Starts a new asynchronous job. Requires the Can View project
-// role.
-func (r *JobsService) Insert(projectId string, job *Job) *JobsInsertCall {
- c := &JobsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.job = job
- return c
-}
-
-// Media specifies the media to upload in a single chunk.
-// At most one of Media and ResumableMedia may be set.
-func (c *JobsInsertCall) Media(r io.Reader) *JobsInsertCall {
- c.media_ = r
- c.protocol_ = "multipart"
- return c
-}
-
-// ResumableMedia specifies the media to upload in chunks and can be canceled with ctx.
-// At most one of Media and ResumableMedia may be set.
-// mediaType identifies the MIME media type of the upload, such as "image/png".
-// If mediaType is "", it will be auto-detected.
-// The provided ctx will supersede any context previously provided to
-// the Context method.
-func (c *JobsInsertCall) ResumableMedia(ctx context.Context, r io.ReaderAt, size int64, mediaType string) *JobsInsertCall {
- c.ctx_ = ctx
- c.resumable_ = io.NewSectionReader(r, 0, size)
- c.mediaType_ = mediaType
- c.protocol_ = "resumable"
- return c
-}
-
-// ProgressUpdater provides a callback function that will be called after every chunk.
-// It should be a low-latency function in order to not slow down the upload operation.
-// This should only be called when using ResumableMedia (as opposed to Media).
-func (c *JobsInsertCall) ProgressUpdater(pu googleapi.ProgressUpdater) *JobsInsertCall {
- c.opt_["progressUpdater"] = pu
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *JobsInsertCall) Fields(s ...googleapi.Field) *JobsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-// This context will supersede any context previously provided to
-// the ResumableMedia method.
-func (c *JobsInsertCall) Context(ctx context.Context) *JobsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *JobsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.job)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{projectId}/jobs")
- if c.media_ != nil || c.resumable_ != nil {
- urls = strings.Replace(urls, "https://www.googleapis.com/", "https://www.googleapis.com/upload/", 1)
- params.Set("uploadType", c.protocol_)
- }
- urls += "?" + params.Encode()
- if c.protocol_ != "resumable" {
- var cancel func()
- cancel, _ = googleapi.ConditionallyIncludeMedia(c.media_, &body, &ctype)
- if cancel != nil {
- defer cancel()
- }
- }
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- })
- if c.protocol_ == "resumable" {
- if c.mediaType_ == "" {
- c.mediaType_ = googleapi.DetectMediaType(c.resumable_)
- }
- req.Header.Set("X-Upload-Content-Type", c.mediaType_)
- req.Header.Set("Content-Type", "application/json; charset=utf-8")
- } else {
- req.Header.Set("Content-Type", ctype)
- }
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "bigquery.jobs.insert" call.
-// Exactly one of *Job or error will be non-nil. Any non-2xx status code
-// is an error. Response headers are in either
-// *Job.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *JobsInsertCall) Do() (*Job, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- var progressUpdater_ googleapi.ProgressUpdater
- if v, ok := c.opt_["progressUpdater"]; ok {
- if pu, ok := v.(googleapi.ProgressUpdater); ok {
- progressUpdater_ = pu
- }
- }
- if c.protocol_ == "resumable" {
- loc := res.Header.Get("Location")
- rx := &googleapi.ResumableUpload{
- Client: c.s.client,
- UserAgent: c.s.userAgent(),
- URI: loc,
- Media: c.resumable_,
- MediaType: c.mediaType_,
- ContentLength: c.resumable_.Size(),
- Callback: progressUpdater_,
- }
- res, err = rx.Upload(c.ctx_)
- if err != nil {
- return nil, err
- }
- defer res.Body.Close()
- }
- ret := &Job{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Starts a new asynchronous job. Requires the Can View project role.",
- // "httpMethod": "POST",
- // "id": "bigquery.jobs.insert",
- // "mediaUpload": {
- // "accept": [
- // "*/*"
- // ],
- // "protocols": {
- // "resumable": {
- // "multipart": true,
- // "path": "/resumable/upload/bigquery/v2/projects/{projectId}/jobs"
- // },
- // "simple": {
- // "multipart": true,
- // "path": "/upload/bigquery/v2/projects/{projectId}/jobs"
- // }
- // }
- // },
- // "parameterOrder": [
- // "projectId"
- // ],
- // "parameters": {
- // "projectId": {
- // "description": "Project ID of the project that will be billed for the job",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "projects/{projectId}/jobs",
- // "request": {
- // "$ref": "Job"
- // },
- // "response": {
- // "$ref": "Job"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/bigquery",
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/devstorage.full_control",
- // "https://www.googleapis.com/auth/devstorage.read_only",
- // "https://www.googleapis.com/auth/devstorage.read_write"
- // ],
- // "supportsMediaUpload": true
- // }
-
-}
-
-// method id "bigquery.jobs.list":
-
-type JobsListCall struct {
- s *Service
- projectId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all jobs that you started in the specified project. Job
-// information is available for a six month period after creation. The
-// job list is sorted in reverse chronological order, by job creation
-// time. Requires the Can View project role, or the Is Owner project
-// role if you set the allUsers property.
-func (r *JobsService) List(projectId string) *JobsListCall {
- c := &JobsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- return c
-}
-
-// AllUsers sets the optional parameter "allUsers": Whether to display
-// jobs owned by all users in the project. Default false
-func (c *JobsListCall) AllUsers(allUsers bool) *JobsListCall {
- c.opt_["allUsers"] = allUsers
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return
-func (c *JobsListCall) MaxResults(maxResults int64) *JobsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Page token,
-// returned by a previous call, to request the next page of results
-func (c *JobsListCall) PageToken(pageToken string) *JobsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Projection sets the optional parameter "projection": Restrict
-// information returned to a set of selected fields
-//
-// Possible values:
-// "full" - Includes all job data
-// "minimal" - Does not include the job configuration
-func (c *JobsListCall) Projection(projection string) *JobsListCall {
- c.opt_["projection"] = projection
- return c
-}
-
-// StateFilter sets the optional parameter "stateFilter": Filter for job
-// state
-//
-// Possible values:
-// "done" - Finished jobs
-// "pending" - Pending jobs
-// "running" - Running jobs
-func (c *JobsListCall) StateFilter(stateFilter string) *JobsListCall {
- c.opt_["stateFilter"] = stateFilter
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *JobsListCall) Fields(s ...googleapi.Field) *JobsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *JobsListCall) IfNoneMatch(entityTag string) *JobsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *JobsListCall) Context(ctx context.Context) *JobsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *JobsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["allUsers"]; ok {
- params.Set("allUsers", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["projection"]; ok {
- params.Set("projection", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["stateFilter"]; ok {
- params.Set("stateFilter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{projectId}/jobs")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "bigquery.jobs.list" call.
-// Exactly one of *JobList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *JobList.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *JobsListCall) Do() (*JobList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &JobList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property.",
- // "httpMethod": "GET",
- // "id": "bigquery.jobs.list",
- // "parameterOrder": [
- // "projectId"
- // ],
- // "parameters": {
- // "allUsers": {
- // "description": "Whether to display jobs owned by all users in the project. Default false",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Page token, returned by a previous call, to request the next page of results",
- // "location": "query",
- // "type": "string"
- // },
- // "projectId": {
- // "description": "Project ID of the jobs to list",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projection": {
- // "description": "Restrict information returned to a set of selected fields",
- // "enum": [
- // "full",
- // "minimal"
- // ],
- // "enumDescriptions": [
- // "Includes all job data",
- // "Does not include the job configuration"
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "stateFilter": {
- // "description": "Filter for job state",
- // "enum": [
- // "done",
- // "pending",
- // "running"
- // ],
- // "enumDescriptions": [
- // "Finished jobs",
- // "Pending jobs",
- // "Running jobs"
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // }
- // },
- // "path": "projects/{projectId}/jobs",
- // "response": {
- // "$ref": "JobList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/bigquery",
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only"
- // ]
- // }
-
-}
-
-// method id "bigquery.jobs.query":
-
-type JobsQueryCall struct {
- s *Service
- projectId string
- queryrequest *QueryRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Query: Runs a BigQuery SQL query synchronously and returns query
-// results if the query completes within a specified timeout.
-func (r *JobsService) Query(projectId string, queryrequest *QueryRequest) *JobsQueryCall {
- c := &JobsQueryCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.queryrequest = queryrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *JobsQueryCall) Fields(s ...googleapi.Field) *JobsQueryCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *JobsQueryCall) Context(ctx context.Context) *JobsQueryCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *JobsQueryCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.queryrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{projectId}/queries")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "bigquery.jobs.query" call.
-// Exactly one of *QueryResponse or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *QueryResponse.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *JobsQueryCall) Do() (*QueryResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &QueryResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.",
- // "httpMethod": "POST",
- // "id": "bigquery.jobs.query",
- // "parameterOrder": [
- // "projectId"
- // ],
- // "parameters": {
- // "projectId": {
- // "description": "Project ID of the project billed for the query",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "projects/{projectId}/queries",
- // "request": {
- // "$ref": "QueryRequest"
- // },
- // "response": {
- // "$ref": "QueryResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/bigquery",
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only"
- // ]
- // }
-
-}
-
-// method id "bigquery.projects.list":
-
-type ProjectsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all projects to which you have been granted any project
-// role.
-func (r *ProjectsService) List() *ProjectsListCall {
- c := &ProjectsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return
-func (c *ProjectsListCall) MaxResults(maxResults int64) *ProjectsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Page token,
-// returned by a previous call, to request the next page of results
-func (c *ProjectsListCall) PageToken(pageToken string) *ProjectsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsListCall) Fields(s ...googleapi.Field) *ProjectsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ProjectsListCall) IfNoneMatch(entityTag string) *ProjectsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsListCall) Context(ctx context.Context) *ProjectsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "projects")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "bigquery.projects.list" call.
-// Exactly one of *ProjectList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ProjectList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ProjectsListCall) Do() (*ProjectList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ProjectList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all projects to which you have been granted any project role.",
- // "httpMethod": "GET",
- // "id": "bigquery.projects.list",
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of results to return",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Page token, returned by a previous call, to request the next page of results",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "projects",
- // "response": {
- // "$ref": "ProjectList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/bigquery",
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only"
- // ]
- // }
-
-}
-
-// method id "bigquery.tabledata.insertAll":
-
-type TabledataInsertAllCall struct {
- s *Service
- projectId string
- datasetId string
- tableId string
- tabledatainsertallrequest *TableDataInsertAllRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// InsertAll: Streams data into BigQuery one record at a time without
-// needing to run a load job. Requires the WRITER dataset role.
-func (r *TabledataService) InsertAll(projectId string, datasetId string, tableId string, tabledatainsertallrequest *TableDataInsertAllRequest) *TabledataInsertAllCall {
- c := &TabledataInsertAllCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.datasetId = datasetId
- c.tableId = tableId
- c.tabledatainsertallrequest = tabledatainsertallrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TabledataInsertAllCall) Fields(s ...googleapi.Field) *TabledataInsertAllCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TabledataInsertAllCall) Context(ctx context.Context) *TabledataInsertAllCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TabledataInsertAllCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.tabledatainsertallrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{projectId}/datasets/{datasetId}/tables/{tableId}/insertAll")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "datasetId": c.datasetId,
- "tableId": c.tableId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "bigquery.tabledata.insertAll" call.
-// Exactly one of *TableDataInsertAllResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *TableDataInsertAllResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TabledataInsertAllCall) Do() (*TableDataInsertAllResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TableDataInsertAllResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Streams data into BigQuery one record at a time without needing to run a load job. Requires the WRITER dataset role.",
- // "httpMethod": "POST",
- // "id": "bigquery.tabledata.insertAll",
- // "parameterOrder": [
- // "projectId",
- // "datasetId",
- // "tableId"
- // ],
- // "parameters": {
- // "datasetId": {
- // "description": "Dataset ID of the destination table.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "Project ID of the destination table.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "tableId": {
- // "description": "Table ID of the destination table.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}/insertAll",
- // "request": {
- // "$ref": "TableDataInsertAllRequest"
- // },
- // "response": {
- // "$ref": "TableDataInsertAllResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/bigquery",
- // "https://www.googleapis.com/auth/bigquery.insertdata",
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "bigquery.tabledata.list":
-
-type TabledataListCall struct {
- s *Service
- projectId string
- datasetId string
- tableId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves table data from a specified set of rows. Requires the
-// READER dataset role.
-func (r *TabledataService) List(projectId string, datasetId string, tableId string) *TabledataListCall {
- c := &TabledataListCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.datasetId = datasetId
- c.tableId = tableId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return
-func (c *TabledataListCall) MaxResults(maxResults int64) *TabledataListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Page token,
-// returned by a previous call, identifying the result set
-func (c *TabledataListCall) PageToken(pageToken string) *TabledataListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex": Zero-based index
-// of the starting row to read
-func (c *TabledataListCall) StartIndex(startIndex uint64) *TabledataListCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TabledataListCall) Fields(s ...googleapi.Field) *TabledataListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TabledataListCall) IfNoneMatch(entityTag string) *TabledataListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TabledataListCall) Context(ctx context.Context) *TabledataListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TabledataListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{projectId}/datasets/{datasetId}/tables/{tableId}/data")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "datasetId": c.datasetId,
- "tableId": c.tableId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "bigquery.tabledata.list" call.
-// Exactly one of *TableDataList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *TableDataList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TabledataListCall) Do() (*TableDataList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TableDataList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves table data from a specified set of rows. Requires the READER dataset role.",
- // "httpMethod": "GET",
- // "id": "bigquery.tabledata.list",
- // "parameterOrder": [
- // "projectId",
- // "datasetId",
- // "tableId"
- // ],
- // "parameters": {
- // "datasetId": {
- // "description": "Dataset ID of the table to read",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Page token, returned by a previous call, identifying the result set",
- // "location": "query",
- // "type": "string"
- // },
- // "projectId": {
- // "description": "Project ID of the table to read",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "startIndex": {
- // "description": "Zero-based index of the starting row to read",
- // "format": "uint64",
- // "location": "query",
- // "type": "string"
- // },
- // "tableId": {
- // "description": "Table ID of the table to read",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}/data",
- // "response": {
- // "$ref": "TableDataList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/bigquery",
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only"
- // ]
- // }
-
-}
-
-// method id "bigquery.tables.delete":
-
-type TablesDeleteCall struct {
- s *Service
- projectId string
- datasetId string
- tableId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the table specified by tableId from the dataset. If
-// the table contains data, all the data will be deleted.
-func (r *TablesService) Delete(projectId string, datasetId string, tableId string) *TablesDeleteCall {
- c := &TablesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.datasetId = datasetId
- c.tableId = tableId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TablesDeleteCall) Fields(s ...googleapi.Field) *TablesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TablesDeleteCall) Context(ctx context.Context) *TablesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TablesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{projectId}/datasets/{datasetId}/tables/{tableId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "datasetId": c.datasetId,
- "tableId": c.tableId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "bigquery.tables.delete" call.
-func (c *TablesDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.",
- // "httpMethod": "DELETE",
- // "id": "bigquery.tables.delete",
- // "parameterOrder": [
- // "projectId",
- // "datasetId",
- // "tableId"
- // ],
- // "parameters": {
- // "datasetId": {
- // "description": "Dataset ID of the table to delete",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "Project ID of the table to delete",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "tableId": {
- // "description": "Table ID of the table to delete",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/bigquery",
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "bigquery.tables.get":
-
-type TablesGetCall struct {
- s *Service
- projectId string
- datasetId string
- tableId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets the specified table resource by table ID. This method does
-// not return the data in the table, it only returns the table resource,
-// which describes the structure of this table.
-func (r *TablesService) Get(projectId string, datasetId string, tableId string) *TablesGetCall {
- c := &TablesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.datasetId = datasetId
- c.tableId = tableId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TablesGetCall) Fields(s ...googleapi.Field) *TablesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TablesGetCall) IfNoneMatch(entityTag string) *TablesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TablesGetCall) Context(ctx context.Context) *TablesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TablesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{projectId}/datasets/{datasetId}/tables/{tableId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "datasetId": c.datasetId,
- "tableId": c.tableId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "bigquery.tables.get" call.
-// Exactly one of *Table or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Table.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *TablesGetCall) Do() (*Table, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Table{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table.",
- // "httpMethod": "GET",
- // "id": "bigquery.tables.get",
- // "parameterOrder": [
- // "projectId",
- // "datasetId",
- // "tableId"
- // ],
- // "parameters": {
- // "datasetId": {
- // "description": "Dataset ID of the requested table",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "Project ID of the requested table",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "tableId": {
- // "description": "Table ID of the requested table",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}",
- // "response": {
- // "$ref": "Table"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/bigquery",
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only"
- // ]
- // }
-
-}
-
-// method id "bigquery.tables.insert":
-
-type TablesInsertCall struct {
- s *Service
- projectId string
- datasetId string
- table *Table
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a new, empty table in the dataset.
-func (r *TablesService) Insert(projectId string, datasetId string, table *Table) *TablesInsertCall {
- c := &TablesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.datasetId = datasetId
- c.table = table
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TablesInsertCall) Fields(s ...googleapi.Field) *TablesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TablesInsertCall) Context(ctx context.Context) *TablesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TablesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.table)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{projectId}/datasets/{datasetId}/tables")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "datasetId": c.datasetId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "bigquery.tables.insert" call.
-// Exactly one of *Table or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Table.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *TablesInsertCall) Do() (*Table, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Table{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a new, empty table in the dataset.",
- // "httpMethod": "POST",
- // "id": "bigquery.tables.insert",
- // "parameterOrder": [
- // "projectId",
- // "datasetId"
- // ],
- // "parameters": {
- // "datasetId": {
- // "description": "Dataset ID of the new table",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "Project ID of the new table",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "projects/{projectId}/datasets/{datasetId}/tables",
- // "request": {
- // "$ref": "Table"
- // },
- // "response": {
- // "$ref": "Table"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/bigquery",
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "bigquery.tables.list":
-
-type TablesListCall struct {
- s *Service
- projectId string
- datasetId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all tables in the specified dataset. Requires the READER
-// dataset role.
-func (r *TablesService) List(projectId string, datasetId string) *TablesListCall {
- c := &TablesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.datasetId = datasetId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return
-func (c *TablesListCall) MaxResults(maxResults int64) *TablesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Page token,
-// returned by a previous call, to request the next page of results
-func (c *TablesListCall) PageToken(pageToken string) *TablesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TablesListCall) Fields(s ...googleapi.Field) *TablesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TablesListCall) IfNoneMatch(entityTag string) *TablesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TablesListCall) Context(ctx context.Context) *TablesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TablesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{projectId}/datasets/{datasetId}/tables")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "datasetId": c.datasetId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "bigquery.tables.list" call.
-// Exactly one of *TableList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *TableList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TablesListCall) Do() (*TableList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TableList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all tables in the specified dataset. Requires the READER dataset role.",
- // "httpMethod": "GET",
- // "id": "bigquery.tables.list",
- // "parameterOrder": [
- // "projectId",
- // "datasetId"
- // ],
- // "parameters": {
- // "datasetId": {
- // "description": "Dataset ID of the tables to list",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Page token, returned by a previous call, to request the next page of results",
- // "location": "query",
- // "type": "string"
- // },
- // "projectId": {
- // "description": "Project ID of the tables to list",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "projects/{projectId}/datasets/{datasetId}/tables",
- // "response": {
- // "$ref": "TableList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/bigquery",
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only"
- // ]
- // }
-
-}
-
-// method id "bigquery.tables.patch":
-
-type TablesPatchCall struct {
- s *Service
- projectId string
- datasetId string
- tableId string
- table *Table
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates information in an existing table. The update method
-// replaces the entire table resource, whereas the patch method only
-// replaces fields that are provided in the submitted table resource.
-// This method supports patch semantics.
-func (r *TablesService) Patch(projectId string, datasetId string, tableId string, table *Table) *TablesPatchCall {
- c := &TablesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.datasetId = datasetId
- c.tableId = tableId
- c.table = table
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TablesPatchCall) Fields(s ...googleapi.Field) *TablesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TablesPatchCall) Context(ctx context.Context) *TablesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TablesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.table)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{projectId}/datasets/{datasetId}/tables/{tableId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "datasetId": c.datasetId,
- "tableId": c.tableId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "bigquery.tables.patch" call.
-// Exactly one of *Table or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Table.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *TablesPatchCall) Do() (*Table, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Table{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "bigquery.tables.patch",
- // "parameterOrder": [
- // "projectId",
- // "datasetId",
- // "tableId"
- // ],
- // "parameters": {
- // "datasetId": {
- // "description": "Dataset ID of the table to update",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "Project ID of the table to update",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "tableId": {
- // "description": "Table ID of the table to update",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}",
- // "request": {
- // "$ref": "Table"
- // },
- // "response": {
- // "$ref": "Table"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/bigquery",
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "bigquery.tables.update":
-
-type TablesUpdateCall struct {
- s *Service
- projectId string
- datasetId string
- tableId string
- table *Table
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates information in an existing table. The update method
-// replaces the entire table resource, whereas the patch method only
-// replaces fields that are provided in the submitted table resource.
-func (r *TablesService) Update(projectId string, datasetId string, tableId string, table *Table) *TablesUpdateCall {
- c := &TablesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.datasetId = datasetId
- c.tableId = tableId
- c.table = table
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TablesUpdateCall) Fields(s ...googleapi.Field) *TablesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TablesUpdateCall) Context(ctx context.Context) *TablesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TablesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.table)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{projectId}/datasets/{datasetId}/tables/{tableId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "datasetId": c.datasetId,
- "tableId": c.tableId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "bigquery.tables.update" call.
-// Exactly one of *Table or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Table.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *TablesUpdateCall) Do() (*Table, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Table{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource.",
- // "httpMethod": "PUT",
- // "id": "bigquery.tables.update",
- // "parameterOrder": [
- // "projectId",
- // "datasetId",
- // "tableId"
- // ],
- // "parameters": {
- // "datasetId": {
- // "description": "Dataset ID of the table to update",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "Project ID of the table to update",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "tableId": {
- // "description": "Table ID of the table to update",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}",
- // "request": {
- // "$ref": "Table"
- // },
- // "response": {
- // "$ref": "Table"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/bigquery",
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/blogger/v2/blogger-api.json b/vendor/google.golang.org/api/blogger/v2/blogger-api.json
deleted file mode 100644
index d1bcc5d5..00000000
--- a/vendor/google.golang.org/api/blogger/v2/blogger-api.json
+++ /dev/null
@@ -1,923 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"uUWyYHXmEn-ab7WLvo8qNz2S8ws/sAKs5msKBJR7SX4fg3Ahfyr5uno\"",
- "discoveryVersion": "v1",
- "id": "blogger:v2",
- "name": "blogger",
- "version": "v2",
- "revision": "20140827",
- "title": "Blogger API",
- "description": "API for access to the data within Blogger.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/blogger-16.png",
- "x32": "https://www.google.com/images/icons/product/blogger-32.png"
- },
- "documentationLink": "https://developers.google.com/blogger/docs/2.0/json/getting_started",
- "labels": [
- "limited_availability"
- ],
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/blogger/v2/",
- "basePath": "/blogger/v2/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "blogger/v2/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/blogger": {
- "description": "Manage your Blogger account"
- }
- }
- }
- },
- "schemas": {
- "Blog": {
- "id": "Blog",
- "type": "object",
- "properties": {
- "description": {
- "type": "string",
- "description": "The description of this blog. This is displayed underneath the title."
- },
- "id": {
- "type": "string",
- "description": "The identifier for this resource.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entry. Always blogger#blog",
- "default": "blogger#blog"
- },
- "locale": {
- "type": "object",
- "description": "The locale this Blog is set to.",
- "properties": {
- "country": {
- "type": "string",
- "description": "The country this blog's locale is set to."
- },
- "language": {
- "type": "string",
- "description": "The language this blog is authored in."
- },
- "variant": {
- "type": "string",
- "description": "The language variant this blog is authored in."
- }
- }
- },
- "name": {
- "type": "string",
- "description": "The name of this blog. This is displayed as the title."
- },
- "pages": {
- "type": "object",
- "description": "The container of pages in this blog.",
- "properties": {
- "selfLink": {
- "type": "string",
- "description": "The URL of the container for pages in this blog."
- },
- "totalItems": {
- "type": "integer",
- "description": "The count of pages in this blog.",
- "format": "int32"
- }
- }
- },
- "posts": {
- "type": "object",
- "description": "The container of posts in this blog.",
- "properties": {
- "selfLink": {
- "type": "string",
- "description": "The URL of the container for posts in this blog."
- },
- "totalItems": {
- "type": "integer",
- "description": "The count of posts in this blog.",
- "format": "int32"
- }
- }
- },
- "published": {
- "type": "string",
- "description": "RFC 3339 date-time when this blog was published.",
- "format": "date-time"
- },
- "selfLink": {
- "type": "string",
- "description": "The API REST URL to fetch this resource from."
- },
- "updated": {
- "type": "string",
- "description": "RFC 3339 date-time when this blog was last updated.",
- "format": "date-time"
- },
- "url": {
- "type": "string",
- "description": "The URL where this blog is published."
- }
- }
- },
- "BlogList": {
- "id": "BlogList",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "The list of Blogs this user has Authorship or Admin rights over.",
- "items": {
- "$ref": "Blog"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#blogList",
- "default": "blogger#blogList"
- }
- }
- },
- "Comment": {
- "id": "Comment",
- "type": "object",
- "properties": {
- "author": {
- "type": "object",
- "description": "The author of this Comment.",
- "properties": {
- "displayName": {
- "type": "string",
- "description": "The display name."
- },
- "id": {
- "type": "string",
- "description": "The identifier of the Comment creator."
- },
- "image": {
- "type": "object",
- "description": "The comment creator's avatar.",
- "properties": {
- "url": {
- "type": "string",
- "description": "The comment creator's avatar URL."
- }
- }
- },
- "url": {
- "type": "string",
- "description": "The URL of the Comment creator's Profile page."
- }
- }
- },
- "blog": {
- "type": "object",
- "description": "Data about the blog containing this comment.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The identifier of the blog containing this comment.",
- "format": "int64"
- }
- }
- },
- "content": {
- "type": "string",
- "description": "The actual content of the comment. May include HTML markup."
- },
- "id": {
- "type": "string",
- "description": "The identifier for this resource.",
- "format": "int64"
- },
- "inReplyTo": {
- "type": "object",
- "description": "Data about the comment this is in reply to.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The identified of the parent of this comment.",
- "format": "int64"
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entry. Always blogger#comment",
- "default": "blogger#comment"
- },
- "post": {
- "type": "object",
- "description": "Data about the post containing this comment.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The identifier of the post containing this comment.",
- "format": "int64"
- }
- }
- },
- "published": {
- "type": "string",
- "description": "RFC 3339 date-time when this comment was published.",
- "format": "date-time"
- },
- "selfLink": {
- "type": "string",
- "description": "The API REST URL to fetch this resource from."
- },
- "updated": {
- "type": "string",
- "description": "RFC 3339 date-time when this comment was last updated.",
- "format": "date-time"
- }
- }
- },
- "CommentList": {
- "id": "CommentList",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "The List of Comments for a Post.",
- "items": {
- "$ref": "Comment"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entry. Always blogger#commentList",
- "default": "blogger#commentList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to fetch the next page, if one exists."
- },
- "prevPageToken": {
- "type": "string",
- "description": "Pagination token to fetch the previous page, if one exists."
- }
- }
- },
- "Page": {
- "id": "Page",
- "type": "object",
- "properties": {
- "author": {
- "type": "object",
- "description": "The author of this Page.",
- "properties": {
- "displayName": {
- "type": "string",
- "description": "The display name."
- },
- "id": {
- "type": "string",
- "description": "The identifier of the Page creator."
- },
- "image": {
- "type": "object",
- "description": "The page author's avatar.",
- "properties": {
- "url": {
- "type": "string",
- "description": "The page author's avatar URL."
- }
- }
- },
- "url": {
- "type": "string",
- "description": "The URL of the Page creator's Profile page."
- }
- }
- },
- "blog": {
- "type": "object",
- "description": "Data about the blog containing this Page.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The identifier of the blog containing this page.",
- "format": "int64"
- }
- }
- },
- "content": {
- "type": "string",
- "description": "The body content of this Page, in HTML."
- },
- "id": {
- "type": "string",
- "description": "The identifier for this resource.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#page",
- "default": "blogger#page"
- },
- "published": {
- "type": "string",
- "description": "RFC 3339 date-time when this Page was published.",
- "format": "date-time"
- },
- "selfLink": {
- "type": "string",
- "description": "The API REST URL to fetch this resource from."
- },
- "title": {
- "type": "string",
- "description": "The title of this entity. This is the name displayed in the Admin user interface."
- },
- "updated": {
- "type": "string",
- "description": "RFC 3339 date-time when this Page was last updated.",
- "format": "date-time"
- },
- "url": {
- "type": "string",
- "description": "The URL that this Page is displayed at."
- }
- }
- },
- "PageList": {
- "id": "PageList",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "The list of Pages for a Blog.",
- "items": {
- "$ref": "Page"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#pageList",
- "default": "blogger#pageList"
- }
- }
- },
- "Post": {
- "id": "Post",
- "type": "object",
- "properties": {
- "author": {
- "type": "object",
- "description": "The author of this Post.",
- "properties": {
- "displayName": {
- "type": "string",
- "description": "The display name."
- },
- "id": {
- "type": "string",
- "description": "The identifier of the Post creator."
- },
- "image": {
- "type": "object",
- "description": "The Post author's avatar.",
- "properties": {
- "url": {
- "type": "string",
- "description": "The Post author's avatar URL."
- }
- }
- },
- "url": {
- "type": "string",
- "description": "The URL of the Post creator's Profile page."
- }
- }
- },
- "blog": {
- "type": "object",
- "description": "Data about the blog containing this Post.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The identifier of the Blog that contains this Post.",
- "format": "int64"
- }
- }
- },
- "content": {
- "type": "string",
- "description": "The content of the Post. May contain HTML markup."
- },
- "id": {
- "type": "string",
- "description": "The identifier of this Post.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#post",
- "default": "blogger#post"
- },
- "labels": {
- "type": "array",
- "description": "The list of labels this Post was tagged with.",
- "items": {
- "type": "string"
- }
- },
- "published": {
- "type": "string",
- "description": "RFC 3339 date-time when this Post was published.",
- "format": "date-time"
- },
- "replies": {
- "type": "object",
- "description": "The container of comments on this Post.",
- "properties": {
- "selfLink": {
- "type": "string",
- "description": "The URL of the comments on this post."
- },
- "totalItems": {
- "type": "string",
- "description": "The count of comments on this post.",
- "format": "int64"
- }
- }
- },
- "selfLink": {
- "type": "string",
- "description": "The API REST URL to fetch this resource from."
- },
- "title": {
- "type": "string",
- "description": "The title of the Post."
- },
- "updated": {
- "type": "string",
- "description": "RFC 3339 date-time when this Post was last updated.",
- "format": "date-time"
- },
- "url": {
- "type": "string",
- "description": "The URL where this Post is displayed."
- }
- }
- },
- "PostList": {
- "id": "PostList",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "The list of Posts for this Blog.",
- "items": {
- "$ref": "Post"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#postList",
- "default": "blogger#postList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to fetch the next page, if one exists."
- },
- "prevPageToken": {
- "type": "string",
- "description": "Pagination token to fetch the previous page, if one exists."
- }
- }
- },
- "User": {
- "id": "User",
- "type": "object",
- "properties": {
- "about": {
- "type": "string",
- "description": "Profile summary information."
- },
- "blogs": {
- "type": "object",
- "description": "The container of blogs for this user.",
- "properties": {
- "selfLink": {
- "type": "string",
- "description": "The URL of the Blogs for this user."
- }
- }
- },
- "created": {
- "type": "string",
- "description": "The timestamp of when this profile was created, in seconds since epoch.",
- "format": "date-time"
- },
- "displayName": {
- "type": "string",
- "description": "The display name."
- },
- "id": {
- "type": "string",
- "description": "The identifier for this User."
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#user",
- "default": "blogger#user"
- },
- "locale": {
- "type": "object",
- "description": "This user's locale",
- "properties": {
- "country": {
- "type": "string",
- "description": "The user's country setting."
- },
- "language": {
- "type": "string",
- "description": "The user's language setting."
- },
- "variant": {
- "type": "string",
- "description": "The user's language variant setting."
- }
- }
- },
- "selfLink": {
- "type": "string",
- "description": "The API REST URL to fetch this resource from."
- },
- "url": {
- "type": "string",
- "description": "The user's profile page."
- }
- }
- }
- },
- "resources": {
- "blogs": {
- "methods": {
- "get": {
- "id": "blogger.blogs.get",
- "path": "blogs/{blogId}",
- "httpMethod": "GET",
- "description": "Gets one blog by id.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the blog to get.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "blogId"
- ],
- "response": {
- "$ref": "Blog"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- }
- }
- },
- "comments": {
- "methods": {
- "get": {
- "id": "blogger.comments.get",
- "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}",
- "httpMethod": "GET",
- "description": "Gets one comment by id.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to containing the comment.",
- "required": true,
- "location": "path"
- },
- "commentId": {
- "type": "string",
- "description": "The ID of the comment to get.",
- "required": true,
- "location": "path"
- },
- "postId": {
- "type": "string",
- "description": "ID of the post to fetch posts from.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId",
- "commentId"
- ],
- "response": {
- "$ref": "Comment"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "list": {
- "id": "blogger.comments.list",
- "path": "blogs/{blogId}/posts/{postId}/comments",
- "httpMethod": "GET",
- "description": "Retrieves the comments for a blog, possibly filtered.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to fetch comments from.",
- "required": true,
- "location": "path"
- },
- "fetchBodies": {
- "type": "boolean",
- "description": "Whether the body content of the comments is included.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of comments to include in the result.",
- "format": "uint32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Continuation token if request is paged.",
- "location": "query"
- },
- "postId": {
- "type": "string",
- "description": "ID of the post to fetch posts from.",
- "required": true,
- "location": "path"
- },
- "startDate": {
- "type": "string",
- "description": "Earliest date of comment to fetch, a date-time with RFC 3339 formatting.",
- "format": "date-time",
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId"
- ],
- "response": {
- "$ref": "CommentList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- }
- }
- },
- "pages": {
- "methods": {
- "get": {
- "id": "blogger.pages.get",
- "path": "blogs/{blogId}/pages/{pageId}",
- "httpMethod": "GET",
- "description": "Gets one blog page by id.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog containing the page.",
- "required": true,
- "location": "path"
- },
- "pageId": {
- "type": "string",
- "description": "The ID of the page to get.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "blogId",
- "pageId"
- ],
- "response": {
- "$ref": "Page"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "list": {
- "id": "blogger.pages.list",
- "path": "blogs/{blogId}/pages",
- "httpMethod": "GET",
- "description": "Retrieves pages for a blog, possibly filtered.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to fetch pages from.",
- "required": true,
- "location": "path"
- },
- "fetchBodies": {
- "type": "boolean",
- "description": "Whether to retrieve the Page bodies.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId"
- ],
- "response": {
- "$ref": "PageList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- }
- }
- },
- "posts": {
- "methods": {
- "get": {
- "id": "blogger.posts.get",
- "path": "blogs/{blogId}/posts/{postId}",
- "httpMethod": "GET",
- "description": "Get a post by id.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to fetch the post from.",
- "required": true,
- "location": "path"
- },
- "postId": {
- "type": "string",
- "description": "The ID of the post",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId"
- ],
- "response": {
- "$ref": "Post"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "list": {
- "id": "blogger.posts.list",
- "path": "blogs/{blogId}/posts",
- "httpMethod": "GET",
- "description": "Retrieves a list of posts, possibly filtered.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to fetch posts from.",
- "required": true,
- "location": "path"
- },
- "fetchBodies": {
- "type": "boolean",
- "description": "Whether the body content of posts is included.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of posts to fetch.",
- "format": "uint32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Continuation token if the request is paged.",
- "location": "query"
- },
- "startDate": {
- "type": "string",
- "description": "Earliest post date to fetch, a date-time with RFC 3339 formatting.",
- "format": "date-time",
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId"
- ],
- "response": {
- "$ref": "PostList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- }
- }
- },
- "users": {
- "methods": {
- "get": {
- "id": "blogger.users.get",
- "path": "users/{userId}",
- "httpMethod": "GET",
- "description": "Gets one user by id.",
- "parameters": {
- "userId": {
- "type": "string",
- "description": "The ID of the user to get.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userId"
- ],
- "response": {
- "$ref": "User"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- }
- },
- "resources": {
- "blogs": {
- "methods": {
- "list": {
- "id": "blogger.users.blogs.list",
- "path": "users/{userId}/blogs",
- "httpMethod": "GET",
- "description": "Retrieves a list of blogs, possibly filtered.",
- "parameters": {
- "userId": {
- "type": "string",
- "description": "ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userId"
- ],
- "response": {
- "$ref": "BlogList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- }
- }
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/blogger/v2/blogger-gen.go b/vendor/google.golang.org/api/blogger/v2/blogger-gen.go
deleted file mode 100644
index 05b8f644..00000000
--- a/vendor/google.golang.org/api/blogger/v2/blogger-gen.go
+++ /dev/null
@@ -1,2236 +0,0 @@
-// Package blogger provides access to the Blogger API.
-//
-// See https://developers.google.com/blogger/docs/2.0/json/getting_started
-//
-// Usage example:
-//
-// import "google.golang.org/api/blogger/v2"
-// ...
-// bloggerService, err := blogger.New(oauthHttpClient)
-package blogger // import "google.golang.org/api/blogger/v2"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "blogger:v2"
-const apiName = "blogger"
-const apiVersion = "v2"
-const basePath = "https://www.googleapis.com/blogger/v2/"
-
-// OAuth2 scopes used by this API.
-const (
- // Manage your Blogger account
- BloggerScope = "https://www.googleapis.com/auth/blogger"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Blogs = NewBlogsService(s)
- s.Comments = NewCommentsService(s)
- s.Pages = NewPagesService(s)
- s.Posts = NewPostsService(s)
- s.Users = NewUsersService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Blogs *BlogsService
-
- Comments *CommentsService
-
- Pages *PagesService
-
- Posts *PostsService
-
- Users *UsersService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewBlogsService(s *Service) *BlogsService {
- rs := &BlogsService{s: s}
- return rs
-}
-
-type BlogsService struct {
- s *Service
-}
-
-func NewCommentsService(s *Service) *CommentsService {
- rs := &CommentsService{s: s}
- return rs
-}
-
-type CommentsService struct {
- s *Service
-}
-
-func NewPagesService(s *Service) *PagesService {
- rs := &PagesService{s: s}
- return rs
-}
-
-type PagesService struct {
- s *Service
-}
-
-func NewPostsService(s *Service) *PostsService {
- rs := &PostsService{s: s}
- return rs
-}
-
-type PostsService struct {
- s *Service
-}
-
-func NewUsersService(s *Service) *UsersService {
- rs := &UsersService{s: s}
- rs.Blogs = NewUsersBlogsService(s)
- return rs
-}
-
-type UsersService struct {
- s *Service
-
- Blogs *UsersBlogsService
-}
-
-func NewUsersBlogsService(s *Service) *UsersBlogsService {
- rs := &UsersBlogsService{s: s}
- return rs
-}
-
-type UsersBlogsService struct {
- s *Service
-}
-
-type Blog struct {
- // Description: The description of this blog. This is displayed
- // underneath the title.
- Description string `json:"description,omitempty"`
-
- // Id: The identifier for this resource.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: The kind of this entry. Always blogger#blog
- Kind string `json:"kind,omitempty"`
-
- // Locale: The locale this Blog is set to.
- Locale *BlogLocale `json:"locale,omitempty"`
-
- // Name: The name of this blog. This is displayed as the title.
- Name string `json:"name,omitempty"`
-
- // Pages: The container of pages in this blog.
- Pages *BlogPages `json:"pages,omitempty"`
-
- // Posts: The container of posts in this blog.
- Posts *BlogPosts `json:"posts,omitempty"`
-
- // Published: RFC 3339 date-time when this blog was published.
- Published string `json:"published,omitempty"`
-
- // SelfLink: The API REST URL to fetch this resource from.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Updated: RFC 3339 date-time when this blog was last updated.
- Updated string `json:"updated,omitempty"`
-
- // Url: The URL where this blog is published.
- Url string `json:"url,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Description") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Blog) MarshalJSON() ([]byte, error) {
- type noMethod Blog
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// BlogLocale: The locale this Blog is set to.
-type BlogLocale struct {
- // Country: The country this blog's locale is set to.
- Country string `json:"country,omitempty"`
-
- // Language: The language this blog is authored in.
- Language string `json:"language,omitempty"`
-
- // Variant: The language variant this blog is authored in.
- Variant string `json:"variant,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Country") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BlogLocale) MarshalJSON() ([]byte, error) {
- type noMethod BlogLocale
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// BlogPages: The container of pages in this blog.
-type BlogPages struct {
- // SelfLink: The URL of the container for pages in this blog.
- SelfLink string `json:"selfLink,omitempty"`
-
- // TotalItems: The count of pages in this blog.
- TotalItems int64 `json:"totalItems,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "SelfLink") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BlogPages) MarshalJSON() ([]byte, error) {
- type noMethod BlogPages
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// BlogPosts: The container of posts in this blog.
-type BlogPosts struct {
- // SelfLink: The URL of the container for posts in this blog.
- SelfLink string `json:"selfLink,omitempty"`
-
- // TotalItems: The count of posts in this blog.
- TotalItems int64 `json:"totalItems,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "SelfLink") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BlogPosts) MarshalJSON() ([]byte, error) {
- type noMethod BlogPosts
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type BlogList struct {
- // Items: The list of Blogs this user has Authorship or Admin rights
- // over.
- Items []*Blog `json:"items,omitempty"`
-
- // Kind: The kind of this entity. Always blogger#blogList
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BlogList) MarshalJSON() ([]byte, error) {
- type noMethod BlogList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Comment struct {
- // Author: The author of this Comment.
- Author *CommentAuthor `json:"author,omitempty"`
-
- // Blog: Data about the blog containing this comment.
- Blog *CommentBlog `json:"blog,omitempty"`
-
- // Content: The actual content of the comment. May include HTML markup.
- Content string `json:"content,omitempty"`
-
- // Id: The identifier for this resource.
- Id int64 `json:"id,omitempty,string"`
-
- // InReplyTo: Data about the comment this is in reply to.
- InReplyTo *CommentInReplyTo `json:"inReplyTo,omitempty"`
-
- // Kind: The kind of this entry. Always blogger#comment
- Kind string `json:"kind,omitempty"`
-
- // Post: Data about the post containing this comment.
- Post *CommentPost `json:"post,omitempty"`
-
- // Published: RFC 3339 date-time when this comment was published.
- Published string `json:"published,omitempty"`
-
- // SelfLink: The API REST URL to fetch this resource from.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Updated: RFC 3339 date-time when this comment was last updated.
- Updated string `json:"updated,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Author") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Comment) MarshalJSON() ([]byte, error) {
- type noMethod Comment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CommentAuthor: The author of this Comment.
-type CommentAuthor struct {
- // DisplayName: The display name.
- DisplayName string `json:"displayName,omitempty"`
-
- // Id: The identifier of the Comment creator.
- Id string `json:"id,omitempty"`
-
- // Image: The comment creator's avatar.
- Image *CommentAuthorImage `json:"image,omitempty"`
-
- // Url: The URL of the Comment creator's Profile page.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DisplayName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CommentAuthor) MarshalJSON() ([]byte, error) {
- type noMethod CommentAuthor
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CommentAuthorImage: The comment creator's avatar.
-type CommentAuthorImage struct {
- // Url: The comment creator's avatar URL.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Url") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CommentAuthorImage) MarshalJSON() ([]byte, error) {
- type noMethod CommentAuthorImage
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CommentBlog: Data about the blog containing this comment.
-type CommentBlog struct {
- // Id: The identifier of the blog containing this comment.
- Id int64 `json:"id,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CommentBlog) MarshalJSON() ([]byte, error) {
- type noMethod CommentBlog
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CommentInReplyTo: Data about the comment this is in reply to.
-type CommentInReplyTo struct {
- // Id: The identified of the parent of this comment.
- Id int64 `json:"id,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CommentInReplyTo) MarshalJSON() ([]byte, error) {
- type noMethod CommentInReplyTo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CommentPost: Data about the post containing this comment.
-type CommentPost struct {
- // Id: The identifier of the post containing this comment.
- Id int64 `json:"id,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CommentPost) MarshalJSON() ([]byte, error) {
- type noMethod CommentPost
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CommentList struct {
- // Items: The List of Comments for a Post.
- Items []*Comment `json:"items,omitempty"`
-
- // Kind: The kind of this entry. Always blogger#commentList
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to fetch the next page, if one
- // exists.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // PrevPageToken: Pagination token to fetch the previous page, if one
- // exists.
- PrevPageToken string `json:"prevPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CommentList) MarshalJSON() ([]byte, error) {
- type noMethod CommentList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Page struct {
- // Author: The author of this Page.
- Author *PageAuthor `json:"author,omitempty"`
-
- // Blog: Data about the blog containing this Page.
- Blog *PageBlog `json:"blog,omitempty"`
-
- // Content: The body content of this Page, in HTML.
- Content string `json:"content,omitempty"`
-
- // Id: The identifier for this resource.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: The kind of this entity. Always blogger#page
- Kind string `json:"kind,omitempty"`
-
- // Published: RFC 3339 date-time when this Page was published.
- Published string `json:"published,omitempty"`
-
- // SelfLink: The API REST URL to fetch this resource from.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Title: The title of this entity. This is the name displayed in the
- // Admin user interface.
- Title string `json:"title,omitempty"`
-
- // Updated: RFC 3339 date-time when this Page was last updated.
- Updated string `json:"updated,omitempty"`
-
- // Url: The URL that this Page is displayed at.
- Url string `json:"url,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Author") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Page) MarshalJSON() ([]byte, error) {
- type noMethod Page
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PageAuthor: The author of this Page.
-type PageAuthor struct {
- // DisplayName: The display name.
- DisplayName string `json:"displayName,omitempty"`
-
- // Id: The identifier of the Page creator.
- Id string `json:"id,omitempty"`
-
- // Image: The page author's avatar.
- Image *PageAuthorImage `json:"image,omitempty"`
-
- // Url: The URL of the Page creator's Profile page.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DisplayName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PageAuthor) MarshalJSON() ([]byte, error) {
- type noMethod PageAuthor
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PageAuthorImage: The page author's avatar.
-type PageAuthorImage struct {
- // Url: The page author's avatar URL.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Url") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PageAuthorImage) MarshalJSON() ([]byte, error) {
- type noMethod PageAuthorImage
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PageBlog: Data about the blog containing this Page.
-type PageBlog struct {
- // Id: The identifier of the blog containing this page.
- Id int64 `json:"id,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PageBlog) MarshalJSON() ([]byte, error) {
- type noMethod PageBlog
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type PageList struct {
- // Items: The list of Pages for a Blog.
- Items []*Page `json:"items,omitempty"`
-
- // Kind: The kind of this entity. Always blogger#pageList
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PageList) MarshalJSON() ([]byte, error) {
- type noMethod PageList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Post struct {
- // Author: The author of this Post.
- Author *PostAuthor `json:"author,omitempty"`
-
- // Blog: Data about the blog containing this Post.
- Blog *PostBlog `json:"blog,omitempty"`
-
- // Content: The content of the Post. May contain HTML markup.
- Content string `json:"content,omitempty"`
-
- // Id: The identifier of this Post.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: The kind of this entity. Always blogger#post
- Kind string `json:"kind,omitempty"`
-
- // Labels: The list of labels this Post was tagged with.
- Labels []string `json:"labels,omitempty"`
-
- // Published: RFC 3339 date-time when this Post was published.
- Published string `json:"published,omitempty"`
-
- // Replies: The container of comments on this Post.
- Replies *PostReplies `json:"replies,omitempty"`
-
- // SelfLink: The API REST URL to fetch this resource from.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Title: The title of the Post.
- Title string `json:"title,omitempty"`
-
- // Updated: RFC 3339 date-time when this Post was last updated.
- Updated string `json:"updated,omitempty"`
-
- // Url: The URL where this Post is displayed.
- Url string `json:"url,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Author") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Post) MarshalJSON() ([]byte, error) {
- type noMethod Post
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PostAuthor: The author of this Post.
-type PostAuthor struct {
- // DisplayName: The display name.
- DisplayName string `json:"displayName,omitempty"`
-
- // Id: The identifier of the Post creator.
- Id string `json:"id,omitempty"`
-
- // Image: The Post author's avatar.
- Image *PostAuthorImage `json:"image,omitempty"`
-
- // Url: The URL of the Post creator's Profile page.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DisplayName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PostAuthor) MarshalJSON() ([]byte, error) {
- type noMethod PostAuthor
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PostAuthorImage: The Post author's avatar.
-type PostAuthorImage struct {
- // Url: The Post author's avatar URL.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Url") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PostAuthorImage) MarshalJSON() ([]byte, error) {
- type noMethod PostAuthorImage
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PostBlog: Data about the blog containing this Post.
-type PostBlog struct {
- // Id: The identifier of the Blog that contains this Post.
- Id int64 `json:"id,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PostBlog) MarshalJSON() ([]byte, error) {
- type noMethod PostBlog
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PostReplies: The container of comments on this Post.
-type PostReplies struct {
- // SelfLink: The URL of the comments on this post.
- SelfLink string `json:"selfLink,omitempty"`
-
- // TotalItems: The count of comments on this post.
- TotalItems int64 `json:"totalItems,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "SelfLink") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PostReplies) MarshalJSON() ([]byte, error) {
- type noMethod PostReplies
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type PostList struct {
- // Items: The list of Posts for this Blog.
- Items []*Post `json:"items,omitempty"`
-
- // Kind: The kind of this entity. Always blogger#postList
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to fetch the next page, if one
- // exists.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // PrevPageToken: Pagination token to fetch the previous page, if one
- // exists.
- PrevPageToken string `json:"prevPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PostList) MarshalJSON() ([]byte, error) {
- type noMethod PostList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type User struct {
- // About: Profile summary information.
- About string `json:"about,omitempty"`
-
- // Blogs: The container of blogs for this user.
- Blogs *UserBlogs `json:"blogs,omitempty"`
-
- // Created: The timestamp of when this profile was created, in seconds
- // since epoch.
- Created string `json:"created,omitempty"`
-
- // DisplayName: The display name.
- DisplayName string `json:"displayName,omitempty"`
-
- // Id: The identifier for this User.
- Id string `json:"id,omitempty"`
-
- // Kind: The kind of this entity. Always blogger#user
- Kind string `json:"kind,omitempty"`
-
- // Locale: This user's locale
- Locale *UserLocale `json:"locale,omitempty"`
-
- // SelfLink: The API REST URL to fetch this resource from.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Url: The user's profile page.
- Url string `json:"url,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "About") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *User) MarshalJSON() ([]byte, error) {
- type noMethod User
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserBlogs: The container of blogs for this user.
-type UserBlogs struct {
- // SelfLink: The URL of the Blogs for this user.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "SelfLink") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserBlogs) MarshalJSON() ([]byte, error) {
- type noMethod UserBlogs
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserLocale: This user's locale
-type UserLocale struct {
- // Country: The user's country setting.
- Country string `json:"country,omitempty"`
-
- // Language: The user's language setting.
- Language string `json:"language,omitempty"`
-
- // Variant: The user's language variant setting.
- Variant string `json:"variant,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Country") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserLocale) MarshalJSON() ([]byte, error) {
- type noMethod UserLocale
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "blogger.blogs.get":
-
-type BlogsGetCall struct {
- s *Service
- blogId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one blog by id.
-func (r *BlogsService) Get(blogId string) *BlogsGetCall {
- c := &BlogsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BlogsGetCall) Fields(s ...googleapi.Field) *BlogsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *BlogsGetCall) IfNoneMatch(entityTag string) *BlogsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BlogsGetCall) Context(ctx context.Context) *BlogsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BlogsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.blogs.get" call.
-// Exactly one of *Blog or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Blog.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *BlogsGetCall) Do() (*Blog, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Blog{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one blog by id.",
- // "httpMethod": "GET",
- // "id": "blogger.blogs.get",
- // "parameterOrder": [
- // "blogId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "The ID of the blog to get.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "blogs/{blogId}",
- // "response": {
- // "$ref": "Blog"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger"
- // ]
- // }
-
-}
-
-// method id "blogger.comments.get":
-
-type CommentsGetCall struct {
- s *Service
- blogId string
- postId string
- commentId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one comment by id.
-func (r *CommentsService) Get(blogId string, postId string, commentId string) *CommentsGetCall {
- c := &CommentsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- c.postId = postId
- c.commentId = commentId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CommentsGetCall) Fields(s ...googleapi.Field) *CommentsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CommentsGetCall) IfNoneMatch(entityTag string) *CommentsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CommentsGetCall) Context(ctx context.Context) *CommentsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CommentsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/posts/{postId}/comments/{commentId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- "postId": c.postId,
- "commentId": c.commentId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.comments.get" call.
-// Exactly one of *Comment or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Comment.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *CommentsGetCall) Do() (*Comment, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Comment{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one comment by id.",
- // "httpMethod": "GET",
- // "id": "blogger.comments.get",
- // "parameterOrder": [
- // "blogId",
- // "postId",
- // "commentId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "ID of the blog to containing the comment.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "commentId": {
- // "description": "The ID of the comment to get.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "postId": {
- // "description": "ID of the post to fetch posts from.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}",
- // "response": {
- // "$ref": "Comment"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger"
- // ]
- // }
-
-}
-
-// method id "blogger.comments.list":
-
-type CommentsListCall struct {
- s *Service
- blogId string
- postId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the comments for a blog, possibly filtered.
-func (r *CommentsService) List(blogId string, postId string) *CommentsListCall {
- c := &CommentsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- c.postId = postId
- return c
-}
-
-// FetchBodies sets the optional parameter "fetchBodies": Whether the
-// body content of the comments is included.
-func (c *CommentsListCall) FetchBodies(fetchBodies bool) *CommentsListCall {
- c.opt_["fetchBodies"] = fetchBodies
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of comments to include in the result.
-func (c *CommentsListCall) MaxResults(maxResults int64) *CommentsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Continuation token
-// if request is paged.
-func (c *CommentsListCall) PageToken(pageToken string) *CommentsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// StartDate sets the optional parameter "startDate": Earliest date of
-// comment to fetch, a date-time with RFC 3339 formatting.
-func (c *CommentsListCall) StartDate(startDate string) *CommentsListCall {
- c.opt_["startDate"] = startDate
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CommentsListCall) Fields(s ...googleapi.Field) *CommentsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CommentsListCall) IfNoneMatch(entityTag string) *CommentsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CommentsListCall) Context(ctx context.Context) *CommentsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CommentsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fetchBodies"]; ok {
- params.Set("fetchBodies", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startDate"]; ok {
- params.Set("startDate", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/posts/{postId}/comments")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- "postId": c.postId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.comments.list" call.
-// Exactly one of *CommentList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CommentList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CommentsListCall) Do() (*CommentList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CommentList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the comments for a blog, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "blogger.comments.list",
- // "parameterOrder": [
- // "blogId",
- // "postId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "ID of the blog to fetch comments from.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "fetchBodies": {
- // "description": "Whether the body content of the comments is included.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "Maximum number of comments to include in the result.",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Continuation token if request is paged.",
- // "location": "query",
- // "type": "string"
- // },
- // "postId": {
- // "description": "ID of the post to fetch posts from.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "startDate": {
- // "description": "Earliest date of comment to fetch, a date-time with RFC 3339 formatting.",
- // "format": "date-time",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "blogs/{blogId}/posts/{postId}/comments",
- // "response": {
- // "$ref": "CommentList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger"
- // ]
- // }
-
-}
-
-// method id "blogger.pages.get":
-
-type PagesGetCall struct {
- s *Service
- blogId string
- pageId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one blog page by id.
-func (r *PagesService) Get(blogId string, pageId string) *PagesGetCall {
- c := &PagesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- c.pageId = pageId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PagesGetCall) Fields(s ...googleapi.Field) *PagesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PagesGetCall) IfNoneMatch(entityTag string) *PagesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PagesGetCall) Context(ctx context.Context) *PagesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PagesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/pages/{pageId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- "pageId": c.pageId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.pages.get" call.
-// Exactly one of *Page or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Page.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *PagesGetCall) Do() (*Page, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Page{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one blog page by id.",
- // "httpMethod": "GET",
- // "id": "blogger.pages.get",
- // "parameterOrder": [
- // "blogId",
- // "pageId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "ID of the blog containing the page.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "pageId": {
- // "description": "The ID of the page to get.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "blogs/{blogId}/pages/{pageId}",
- // "response": {
- // "$ref": "Page"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger"
- // ]
- // }
-
-}
-
-// method id "blogger.pages.list":
-
-type PagesListCall struct {
- s *Service
- blogId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves pages for a blog, possibly filtered.
-func (r *PagesService) List(blogId string) *PagesListCall {
- c := &PagesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- return c
-}
-
-// FetchBodies sets the optional parameter "fetchBodies": Whether to
-// retrieve the Page bodies.
-func (c *PagesListCall) FetchBodies(fetchBodies bool) *PagesListCall {
- c.opt_["fetchBodies"] = fetchBodies
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PagesListCall) Fields(s ...googleapi.Field) *PagesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PagesListCall) IfNoneMatch(entityTag string) *PagesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PagesListCall) Context(ctx context.Context) *PagesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PagesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fetchBodies"]; ok {
- params.Set("fetchBodies", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/pages")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.pages.list" call.
-// Exactly one of *PageList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *PageList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *PagesListCall) Do() (*PageList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PageList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves pages for a blog, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "blogger.pages.list",
- // "parameterOrder": [
- // "blogId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "ID of the blog to fetch pages from.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "fetchBodies": {
- // "description": "Whether to retrieve the Page bodies.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "blogs/{blogId}/pages",
- // "response": {
- // "$ref": "PageList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger"
- // ]
- // }
-
-}
-
-// method id "blogger.posts.get":
-
-type PostsGetCall struct {
- s *Service
- blogId string
- postId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get a post by id.
-func (r *PostsService) Get(blogId string, postId string) *PostsGetCall {
- c := &PostsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- c.postId = postId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PostsGetCall) Fields(s ...googleapi.Field) *PostsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PostsGetCall) IfNoneMatch(entityTag string) *PostsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PostsGetCall) Context(ctx context.Context) *PostsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PostsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/posts/{postId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- "postId": c.postId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.posts.get" call.
-// Exactly one of *Post or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Post.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *PostsGetCall) Do() (*Post, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Post{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get a post by id.",
- // "httpMethod": "GET",
- // "id": "blogger.posts.get",
- // "parameterOrder": [
- // "blogId",
- // "postId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "ID of the blog to fetch the post from.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "postId": {
- // "description": "The ID of the post",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "blogs/{blogId}/posts/{postId}",
- // "response": {
- // "$ref": "Post"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger"
- // ]
- // }
-
-}
-
-// method id "blogger.posts.list":
-
-type PostsListCall struct {
- s *Service
- blogId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of posts, possibly filtered.
-func (r *PostsService) List(blogId string) *PostsListCall {
- c := &PostsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- return c
-}
-
-// FetchBodies sets the optional parameter "fetchBodies": Whether the
-// body content of posts is included.
-func (c *PostsListCall) FetchBodies(fetchBodies bool) *PostsListCall {
- c.opt_["fetchBodies"] = fetchBodies
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of posts to fetch.
-func (c *PostsListCall) MaxResults(maxResults int64) *PostsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Continuation token
-// if the request is paged.
-func (c *PostsListCall) PageToken(pageToken string) *PostsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// StartDate sets the optional parameter "startDate": Earliest post date
-// to fetch, a date-time with RFC 3339 formatting.
-func (c *PostsListCall) StartDate(startDate string) *PostsListCall {
- c.opt_["startDate"] = startDate
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PostsListCall) Fields(s ...googleapi.Field) *PostsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PostsListCall) IfNoneMatch(entityTag string) *PostsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PostsListCall) Context(ctx context.Context) *PostsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PostsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fetchBodies"]; ok {
- params.Set("fetchBodies", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startDate"]; ok {
- params.Set("startDate", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/posts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.posts.list" call.
-// Exactly one of *PostList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *PostList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *PostsListCall) Do() (*PostList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PostList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of posts, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "blogger.posts.list",
- // "parameterOrder": [
- // "blogId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "ID of the blog to fetch posts from.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "fetchBodies": {
- // "description": "Whether the body content of posts is included.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "Maximum number of posts to fetch.",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Continuation token if the request is paged.",
- // "location": "query",
- // "type": "string"
- // },
- // "startDate": {
- // "description": "Earliest post date to fetch, a date-time with RFC 3339 formatting.",
- // "format": "date-time",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "blogs/{blogId}/posts",
- // "response": {
- // "$ref": "PostList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger"
- // ]
- // }
-
-}
-
-// method id "blogger.users.get":
-
-type UsersGetCall struct {
- s *Service
- userId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one user by id.
-func (r *UsersService) Get(userId string) *UsersGetCall {
- c := &UsersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.userId = userId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersGetCall) Fields(s ...googleapi.Field) *UsersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UsersGetCall) IfNoneMatch(entityTag string) *UsersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersGetCall) Context(ctx context.Context) *UsersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userId": c.userId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.users.get" call.
-// Exactly one of *User or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *User.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *UsersGetCall) Do() (*User, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &User{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one user by id.",
- // "httpMethod": "GET",
- // "id": "blogger.users.get",
- // "parameterOrder": [
- // "userId"
- // ],
- // "parameters": {
- // "userId": {
- // "description": "The ID of the user to get.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userId}",
- // "response": {
- // "$ref": "User"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger"
- // ]
- // }
-
-}
-
-// method id "blogger.users.blogs.list":
-
-type UsersBlogsListCall struct {
- s *Service
- userId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of blogs, possibly filtered.
-func (r *UsersBlogsService) List(userId string) *UsersBlogsListCall {
- c := &UsersBlogsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.userId = userId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersBlogsListCall) Fields(s ...googleapi.Field) *UsersBlogsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UsersBlogsListCall) IfNoneMatch(entityTag string) *UsersBlogsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersBlogsListCall) Context(ctx context.Context) *UsersBlogsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersBlogsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userId}/blogs")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userId": c.userId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.users.blogs.list" call.
-// Exactly one of *BlogList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *BlogList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UsersBlogsListCall) Do() (*BlogList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &BlogList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of blogs, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "blogger.users.blogs.list",
- // "parameterOrder": [
- // "userId"
- // ],
- // "parameters": {
- // "userId": {
- // "description": "ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userId}/blogs",
- // "response": {
- // "$ref": "BlogList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/blogger/v3/blogger-api.json b/vendor/google.golang.org/api/blogger/v3/blogger-api.json
deleted file mode 100644
index 069814be..00000000
--- a/vendor/google.golang.org/api/blogger/v3/blogger-api.json
+++ /dev/null
@@ -1,2507 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/ZRgj7Ah7gwQETAdvqLpx-xGEmV8\"",
- "discoveryVersion": "v1",
- "id": "blogger:v3",
- "name": "blogger",
- "version": "v3",
- "revision": "20150422",
- "title": "Blogger API",
- "description": "API for access to the data within Blogger.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/blogger-16.png",
- "x32": "https://www.google.com/images/icons/product/blogger-32.png"
- },
- "documentationLink": "https://developers.google.com/blogger/docs/3.0/getting_started",
- "labels": [
- "limited_availability"
- ],
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/blogger/v3/",
- "basePath": "/blogger/v3/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "blogger/v3/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/blogger": {
- "description": "Manage your Blogger account"
- },
- "https://www.googleapis.com/auth/blogger.readonly": {
- "description": "View your Blogger account"
- }
- }
- }
- },
- "schemas": {
- "Blog": {
- "id": "Blog",
- "type": "object",
- "properties": {
- "customMetaData": {
- "type": "string",
- "description": "The JSON custom meta-data for the Blog"
- },
- "description": {
- "type": "string",
- "description": "The description of this blog. This is displayed underneath the title."
- },
- "id": {
- "type": "string",
- "description": "The identifier for this resource."
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entry. Always blogger#blog",
- "default": "blogger#blog"
- },
- "locale": {
- "type": "object",
- "description": "The locale this Blog is set to.",
- "properties": {
- "country": {
- "type": "string",
- "description": "The country this blog's locale is set to."
- },
- "language": {
- "type": "string",
- "description": "The language this blog is authored in."
- },
- "variant": {
- "type": "string",
- "description": "The language variant this blog is authored in."
- }
- }
- },
- "name": {
- "type": "string",
- "description": "The name of this blog. This is displayed as the title."
- },
- "pages": {
- "type": "object",
- "description": "The container of pages in this blog.",
- "properties": {
- "selfLink": {
- "type": "string",
- "description": "The URL of the container for pages in this blog."
- },
- "totalItems": {
- "type": "integer",
- "description": "The count of pages in this blog.",
- "format": "int32"
- }
- }
- },
- "posts": {
- "type": "object",
- "description": "The container of posts in this blog.",
- "properties": {
- "items": {
- "type": "array",
- "description": "The List of Posts for this Blog.",
- "items": {
- "$ref": "Post"
- }
- },
- "selfLink": {
- "type": "string",
- "description": "The URL of the container for posts in this blog."
- },
- "totalItems": {
- "type": "integer",
- "description": "The count of posts in this blog.",
- "format": "int32"
- }
- }
- },
- "published": {
- "type": "string",
- "description": "RFC 3339 date-time when this blog was published.",
- "format": "date-time"
- },
- "selfLink": {
- "type": "string",
- "description": "The API REST URL to fetch this resource from."
- },
- "status": {
- "type": "string",
- "description": "The status of the blog."
- },
- "updated": {
- "type": "string",
- "description": "RFC 3339 date-time when this blog was last updated.",
- "format": "date-time"
- },
- "url": {
- "type": "string",
- "description": "The URL where this blog is published."
- }
- }
- },
- "BlogList": {
- "id": "BlogList",
- "type": "object",
- "properties": {
- "blogUserInfos": {
- "type": "array",
- "description": "Admin level list of blog per-user information",
- "items": {
- "$ref": "BlogUserInfo"
- }
- },
- "items": {
- "type": "array",
- "description": "The list of Blogs this user has Authorship or Admin rights over.",
- "items": {
- "$ref": "Blog"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#blogList",
- "default": "blogger#blogList"
- }
- }
- },
- "BlogPerUserInfo": {
- "id": "BlogPerUserInfo",
- "type": "object",
- "properties": {
- "blogId": {
- "type": "string",
- "description": "ID of the Blog resource"
- },
- "hasAdminAccess": {
- "type": "boolean",
- "description": "True if the user has Admin level access to the blog."
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#blogPerUserInfo",
- "default": "blogger#blogPerUserInfo"
- },
- "photosAlbumKey": {
- "type": "string",
- "description": "The Photo Album Key for the user when adding photos to the blog"
- },
- "role": {
- "type": "string",
- "description": "Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER)."
- },
- "userId": {
- "type": "string",
- "description": "ID of the User"
- }
- }
- },
- "BlogUserInfo": {
- "id": "BlogUserInfo",
- "type": "object",
- "properties": {
- "blog": {
- "$ref": "Blog",
- "description": "The Blog resource."
- },
- "blog_user_info": {
- "$ref": "BlogPerUserInfo",
- "description": "Information about a User for the Blog."
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#blogUserInfo",
- "default": "blogger#blogUserInfo"
- }
- }
- },
- "Comment": {
- "id": "Comment",
- "type": "object",
- "properties": {
- "author": {
- "type": "object",
- "description": "The author of this Comment.",
- "properties": {
- "displayName": {
- "type": "string",
- "description": "The display name."
- },
- "id": {
- "type": "string",
- "description": "The identifier of the Comment creator."
- },
- "image": {
- "type": "object",
- "description": "The comment creator's avatar.",
- "properties": {
- "url": {
- "type": "string",
- "description": "The comment creator's avatar URL."
- }
- }
- },
- "url": {
- "type": "string",
- "description": "The URL of the Comment creator's Profile page."
- }
- }
- },
- "blog": {
- "type": "object",
- "description": "Data about the blog containing this comment.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The identifier of the blog containing this comment."
- }
- }
- },
- "content": {
- "type": "string",
- "description": "The actual content of the comment. May include HTML markup."
- },
- "id": {
- "type": "string",
- "description": "The identifier for this resource."
- },
- "inReplyTo": {
- "type": "object",
- "description": "Data about the comment this is in reply to.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The identified of the parent of this comment."
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entry. Always blogger#comment",
- "default": "blogger#comment"
- },
- "post": {
- "type": "object",
- "description": "Data about the post containing this comment.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The identifier of the post containing this comment."
- }
- }
- },
- "published": {
- "type": "string",
- "description": "RFC 3339 date-time when this comment was published.",
- "format": "date-time"
- },
- "selfLink": {
- "type": "string",
- "description": "The API REST URL to fetch this resource from."
- },
- "status": {
- "type": "string",
- "description": "The status of the comment (only populated for admin users)"
- },
- "updated": {
- "type": "string",
- "description": "RFC 3339 date-time when this comment was last updated.",
- "format": "date-time"
- }
- }
- },
- "CommentList": {
- "id": "CommentList",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "Etag of the response."
- },
- "items": {
- "type": "array",
- "description": "The List of Comments for a Post.",
- "items": {
- "$ref": "Comment"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entry. Always blogger#commentList",
- "default": "blogger#commentList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to fetch the next page, if one exists."
- },
- "prevPageToken": {
- "type": "string",
- "description": "Pagination token to fetch the previous page, if one exists."
- }
- }
- },
- "Page": {
- "id": "Page",
- "type": "object",
- "properties": {
- "author": {
- "type": "object",
- "description": "The author of this Page.",
- "properties": {
- "displayName": {
- "type": "string",
- "description": "The display name."
- },
- "id": {
- "type": "string",
- "description": "The identifier of the Page creator."
- },
- "image": {
- "type": "object",
- "description": "The page author's avatar.",
- "properties": {
- "url": {
- "type": "string",
- "description": "The page author's avatar URL."
- }
- }
- },
- "url": {
- "type": "string",
- "description": "The URL of the Page creator's Profile page."
- }
- }
- },
- "blog": {
- "type": "object",
- "description": "Data about the blog containing this Page.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The identifier of the blog containing this page."
- }
- }
- },
- "content": {
- "type": "string",
- "description": "The body content of this Page, in HTML."
- },
- "etag": {
- "type": "string",
- "description": "Etag of the resource."
- },
- "id": {
- "type": "string",
- "description": "The identifier for this resource."
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#page",
- "default": "blogger#page"
- },
- "published": {
- "type": "string",
- "description": "RFC 3339 date-time when this Page was published.",
- "format": "date-time"
- },
- "selfLink": {
- "type": "string",
- "description": "The API REST URL to fetch this resource from."
- },
- "status": {
- "type": "string",
- "description": "The status of the page for admin resources (either LIVE or DRAFT)."
- },
- "title": {
- "type": "string",
- "description": "The title of this entity. This is the name displayed in the Admin user interface."
- },
- "updated": {
- "type": "string",
- "description": "RFC 3339 date-time when this Page was last updated.",
- "format": "date-time"
- },
- "url": {
- "type": "string",
- "description": "The URL that this Page is displayed at."
- }
- }
- },
- "PageList": {
- "id": "PageList",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "Etag of the response."
- },
- "items": {
- "type": "array",
- "description": "The list of Pages for a Blog.",
- "items": {
- "$ref": "Page"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#pageList",
- "default": "blogger#pageList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to fetch the next page, if one exists."
- }
- }
- },
- "Pageviews": {
- "id": "Pageviews",
- "type": "object",
- "properties": {
- "blogId": {
- "type": "string",
- "description": "Blog Id"
- },
- "counts": {
- "type": "array",
- "description": "The container of posts in this blog.",
- "items": {
- "type": "object",
- "properties": {
- "count": {
- "type": "string",
- "description": "Count of page views for the given time range",
- "format": "int64"
- },
- "timeRange": {
- "type": "string",
- "description": "Time range the given count applies to"
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entry. Always blogger#page_views",
- "default": "blogger#page_views"
- }
- }
- },
- "Post": {
- "id": "Post",
- "type": "object",
- "properties": {
- "author": {
- "type": "object",
- "description": "The author of this Post.",
- "properties": {
- "displayName": {
- "type": "string",
- "description": "The display name."
- },
- "id": {
- "type": "string",
- "description": "The identifier of the Post creator."
- },
- "image": {
- "type": "object",
- "description": "The Post author's avatar.",
- "properties": {
- "url": {
- "type": "string",
- "description": "The Post author's avatar URL."
- }
- }
- },
- "url": {
- "type": "string",
- "description": "The URL of the Post creator's Profile page."
- }
- }
- },
- "blog": {
- "type": "object",
- "description": "Data about the blog containing this Post.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The identifier of the Blog that contains this Post."
- }
- }
- },
- "content": {
- "type": "string",
- "description": "The content of the Post. May contain HTML markup."
- },
- "customMetaData": {
- "type": "string",
- "description": "The JSON meta-data for the Post."
- },
- "etag": {
- "type": "string",
- "description": "Etag of the resource."
- },
- "id": {
- "type": "string",
- "description": "The identifier of this Post."
- },
- "images": {
- "type": "array",
- "description": "Display image for the Post.",
- "items": {
- "type": "object",
- "properties": {
- "url": {
- "type": "string"
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#post",
- "default": "blogger#post"
- },
- "labels": {
- "type": "array",
- "description": "The list of labels this Post was tagged with.",
- "items": {
- "type": "string"
- }
- },
- "location": {
- "type": "object",
- "description": "The location for geotagged posts.",
- "properties": {
- "lat": {
- "type": "number",
- "description": "Location's latitude.",
- "format": "double"
- },
- "lng": {
- "type": "number",
- "description": "Location's longitude.",
- "format": "double"
- },
- "name": {
- "type": "string",
- "description": "Location name."
- },
- "span": {
- "type": "string",
- "description": "Location's viewport span. Can be used when rendering a map preview."
- }
- }
- },
- "published": {
- "type": "string",
- "description": "RFC 3339 date-time when this Post was published.",
- "format": "date-time"
- },
- "readerComments": {
- "type": "string",
- "description": "Comment control and display setting for readers of this post."
- },
- "replies": {
- "type": "object",
- "description": "The container of comments on this Post.",
- "properties": {
- "items": {
- "type": "array",
- "description": "The List of Comments for this Post.",
- "items": {
- "$ref": "Comment"
- }
- },
- "selfLink": {
- "type": "string",
- "description": "The URL of the comments on this post."
- },
- "totalItems": {
- "type": "string",
- "description": "The count of comments on this post.",
- "format": "int64"
- }
- }
- },
- "selfLink": {
- "type": "string",
- "description": "The API REST URL to fetch this resource from."
- },
- "status": {
- "type": "string",
- "description": "Status of the post. Only set for admin-level requests"
- },
- "title": {
- "type": "string",
- "description": "The title of the Post."
- },
- "titleLink": {
- "type": "string",
- "description": "The title link URL, similar to atom's related link."
- },
- "updated": {
- "type": "string",
- "description": "RFC 3339 date-time when this Post was last updated.",
- "format": "date-time"
- },
- "url": {
- "type": "string",
- "description": "The URL where this Post is displayed."
- }
- }
- },
- "PostList": {
- "id": "PostList",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "Etag of the response."
- },
- "items": {
- "type": "array",
- "description": "The list of Posts for this Blog.",
- "items": {
- "$ref": "Post"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#postList",
- "default": "blogger#postList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to fetch the next page, if one exists."
- }
- }
- },
- "PostPerUserInfo": {
- "id": "PostPerUserInfo",
- "type": "object",
- "properties": {
- "blogId": {
- "type": "string",
- "description": "ID of the Blog that the post resource belongs to."
- },
- "hasEditAccess": {
- "type": "boolean",
- "description": "True if the user has Author level access to the post."
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#postPerUserInfo",
- "default": "blogger#postPerUserInfo"
- },
- "postId": {
- "type": "string",
- "description": "ID of the Post resource."
- },
- "userId": {
- "type": "string",
- "description": "ID of the User."
- }
- }
- },
- "PostUserInfo": {
- "id": "PostUserInfo",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#postUserInfo",
- "default": "blogger#postUserInfo"
- },
- "post": {
- "$ref": "Post",
- "description": "The Post resource."
- },
- "post_user_info": {
- "$ref": "PostPerUserInfo",
- "description": "Information about a User for the Post."
- }
- }
- },
- "PostUserInfosList": {
- "id": "PostUserInfosList",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "The list of Posts with User information for the post, for this Blog.",
- "items": {
- "$ref": "PostUserInfo"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#postList",
- "default": "blogger#postUserInfosList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to fetch the next page, if one exists."
- }
- }
- },
- "User": {
- "id": "User",
- "type": "object",
- "properties": {
- "about": {
- "type": "string",
- "description": "Profile summary information."
- },
- "blogs": {
- "type": "object",
- "description": "The container of blogs for this user.",
- "properties": {
- "selfLink": {
- "type": "string",
- "description": "The URL of the Blogs for this user."
- }
- }
- },
- "created": {
- "type": "string",
- "description": "The timestamp of when this profile was created, in seconds since epoch.",
- "format": "date-time"
- },
- "displayName": {
- "type": "string",
- "description": "The display name."
- },
- "id": {
- "type": "string",
- "description": "The identifier for this User."
- },
- "kind": {
- "type": "string",
- "description": "The kind of this entity. Always blogger#user",
- "default": "blogger#user"
- },
- "locale": {
- "type": "object",
- "description": "This user's locale",
- "properties": {
- "country": {
- "type": "string",
- "description": "The user's country setting."
- },
- "language": {
- "type": "string",
- "description": "The user's language setting."
- },
- "variant": {
- "type": "string",
- "description": "The user's language variant setting."
- }
- }
- },
- "selfLink": {
- "type": "string",
- "description": "The API REST URL to fetch this resource from."
- },
- "url": {
- "type": "string",
- "description": "The user's profile page."
- }
- }
- }
- },
- "resources": {
- "blogUserInfos": {
- "methods": {
- "get": {
- "id": "blogger.blogUserInfos.get",
- "path": "users/{userId}/blogs/{blogId}",
- "httpMethod": "GET",
- "description": "Gets one blog and user info pair by blogId and userId.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the blog to get.",
- "required": true,
- "location": "path"
- },
- "maxPosts": {
- "type": "integer",
- "description": "Maximum number of posts to pull back with the blog.",
- "format": "uint32",
- "location": "query"
- },
- "userId": {
- "type": "string",
- "description": "ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userId",
- "blogId"
- ],
- "response": {
- "$ref": "BlogUserInfo"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- }
- }
- },
- "blogs": {
- "methods": {
- "get": {
- "id": "blogger.blogs.get",
- "path": "blogs/{blogId}",
- "httpMethod": "GET",
- "description": "Gets one blog by ID.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the blog to get.",
- "required": true,
- "location": "path"
- },
- "maxPosts": {
- "type": "integer",
- "description": "Maximum number of posts to pull back with the blog.",
- "format": "uint32",
- "location": "query"
- },
- "view": {
- "type": "string",
- "description": "Access level with which to view the blog. Note that some fields require elevated access.",
- "enum": [
- "ADMIN",
- "AUTHOR",
- "READER"
- ],
- "enumDescriptions": [
- "Admin level detail.",
- "Author level detail.",
- "Reader level detail."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId"
- ],
- "response": {
- "$ref": "Blog"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- },
- "getByUrl": {
- "id": "blogger.blogs.getByUrl",
- "path": "blogs/byurl",
- "httpMethod": "GET",
- "description": "Retrieve a Blog by URL.",
- "parameters": {
- "url": {
- "type": "string",
- "description": "The URL of the blog to retrieve.",
- "required": true,
- "location": "query"
- },
- "view": {
- "type": "string",
- "description": "Access level with which to view the blog. Note that some fields require elevated access.",
- "enum": [
- "ADMIN",
- "AUTHOR",
- "READER"
- ],
- "enumDescriptions": [
- "Admin level detail.",
- "Author level detail.",
- "Reader level detail."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "url"
- ],
- "response": {
- "$ref": "Blog"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- },
- "listByUser": {
- "id": "blogger.blogs.listByUser",
- "path": "users/{userId}/blogs",
- "httpMethod": "GET",
- "description": "Retrieves a list of blogs, possibly filtered.",
- "parameters": {
- "fetchUserInfo": {
- "type": "boolean",
- "description": "Whether the response is a list of blogs with per-user information instead of just blogs.",
- "location": "query"
- },
- "role": {
- "type": "string",
- "description": "User access types for blogs to include in the results, e.g. AUTHOR will return blogs where the user has author level access. If no roles are specified, defaults to ADMIN and AUTHOR roles.",
- "enum": [
- "ADMIN",
- "AUTHOR",
- "READER"
- ],
- "enumDescriptions": [
- "Admin role - Blogs where the user has Admin level access.",
- "Author role - Blogs where the user has Author level access.",
- "Reader role - Blogs where the user has Reader level access (to a private blog)."
- ],
- "repeated": true,
- "location": "query"
- },
- "status": {
- "type": "string",
- "description": "Blog statuses to include in the result (default: Live blogs only). Note that ADMIN access is required to view deleted blogs.",
- "default": "LIVE",
- "enum": [
- "DELETED",
- "LIVE"
- ],
- "enumDescriptions": [
- "Blog has been deleted by an administrator.",
- "Blog is currently live."
- ],
- "repeated": true,
- "location": "query"
- },
- "userId": {
- "type": "string",
- "description": "ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier.",
- "required": true,
- "location": "path"
- },
- "view": {
- "type": "string",
- "description": "Access level with which to view the blogs. Note that some fields require elevated access.",
- "enum": [
- "ADMIN",
- "AUTHOR",
- "READER"
- ],
- "enumDescriptions": [
- "Admin level detail.",
- "Author level detail.",
- "Reader level detail."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "userId"
- ],
- "response": {
- "$ref": "BlogList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- }
- }
- },
- "comments": {
- "methods": {
- "approve": {
- "id": "blogger.comments.approve",
- "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}/approve",
- "httpMethod": "POST",
- "description": "Marks a comment as not spam.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the Blog.",
- "required": true,
- "location": "path"
- },
- "commentId": {
- "type": "string",
- "description": "The ID of the comment to mark as not spam.",
- "required": true,
- "location": "path"
- },
- "postId": {
- "type": "string",
- "description": "The ID of the Post.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId",
- "commentId"
- ],
- "response": {
- "$ref": "Comment"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "delete": {
- "id": "blogger.comments.delete",
- "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}",
- "httpMethod": "DELETE",
- "description": "Delete a comment by ID.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the Blog.",
- "required": true,
- "location": "path"
- },
- "commentId": {
- "type": "string",
- "description": "The ID of the comment to delete.",
- "required": true,
- "location": "path"
- },
- "postId": {
- "type": "string",
- "description": "The ID of the Post.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId",
- "commentId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "get": {
- "id": "blogger.comments.get",
- "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}",
- "httpMethod": "GET",
- "description": "Gets one comment by ID.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to containing the comment.",
- "required": true,
- "location": "path"
- },
- "commentId": {
- "type": "string",
- "description": "The ID of the comment to get.",
- "required": true,
- "location": "path"
- },
- "postId": {
- "type": "string",
- "description": "ID of the post to fetch posts from.",
- "required": true,
- "location": "path"
- },
- "view": {
- "type": "string",
- "description": "Access level for the requested comment (default: READER). Note that some comments will require elevated permissions, for example comments where the parent posts which is in a draft state, or comments that are pending moderation.",
- "enum": [
- "ADMIN",
- "AUTHOR",
- "READER"
- ],
- "enumDescriptions": [
- "Admin level detail",
- "Author level detail",
- "Admin level detail"
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId",
- "commentId"
- ],
- "response": {
- "$ref": "Comment"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- },
- "list": {
- "id": "blogger.comments.list",
- "path": "blogs/{blogId}/posts/{postId}/comments",
- "httpMethod": "GET",
- "description": "Retrieves the comments for a post, possibly filtered.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to fetch comments from.",
- "required": true,
- "location": "path"
- },
- "endDate": {
- "type": "string",
- "description": "Latest date of comment to fetch, a date-time with RFC 3339 formatting.",
- "format": "date-time",
- "location": "query"
- },
- "fetchBodies": {
- "type": "boolean",
- "description": "Whether the body content of the comments is included.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of comments to include in the result.",
- "format": "uint32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Continuation token if request is paged.",
- "location": "query"
- },
- "postId": {
- "type": "string",
- "description": "ID of the post to fetch posts from.",
- "required": true,
- "location": "path"
- },
- "startDate": {
- "type": "string",
- "description": "Earliest date of comment to fetch, a date-time with RFC 3339 formatting.",
- "format": "date-time",
- "location": "query"
- },
- "status": {
- "type": "string",
- "enum": [
- "emptied",
- "live",
- "pending",
- "spam"
- ],
- "enumDescriptions": [
- "Comments that have had their content removed",
- "Comments that are publicly visible",
- "Comments that are awaiting administrator approval",
- "Comments marked as spam by the administrator"
- ],
- "repeated": true,
- "location": "query"
- },
- "view": {
- "type": "string",
- "description": "Access level with which to view the returned result. Note that some fields require elevated access.",
- "enum": [
- "ADMIN",
- "AUTHOR",
- "READER"
- ],
- "enumDescriptions": [
- "Admin level detail",
- "Author level detail",
- "Reader level detail"
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId"
- ],
- "response": {
- "$ref": "CommentList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- },
- "listByBlog": {
- "id": "blogger.comments.listByBlog",
- "path": "blogs/{blogId}/comments",
- "httpMethod": "GET",
- "description": "Retrieves the comments for a blog, across all posts, possibly filtered.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to fetch comments from.",
- "required": true,
- "location": "path"
- },
- "endDate": {
- "type": "string",
- "description": "Latest date of comment to fetch, a date-time with RFC 3339 formatting.",
- "format": "date-time",
- "location": "query"
- },
- "fetchBodies": {
- "type": "boolean",
- "description": "Whether the body content of the comments is included.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of comments to include in the result.",
- "format": "uint32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Continuation token if request is paged.",
- "location": "query"
- },
- "startDate": {
- "type": "string",
- "description": "Earliest date of comment to fetch, a date-time with RFC 3339 formatting.",
- "format": "date-time",
- "location": "query"
- },
- "status": {
- "type": "string",
- "enum": [
- "emptied",
- "live",
- "pending",
- "spam"
- ],
- "enumDescriptions": [
- "Comments that have had their content removed",
- "Comments that are publicly visible",
- "Comments that are awaiting administrator approval",
- "Comments marked as spam by the administrator"
- ],
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId"
- ],
- "response": {
- "$ref": "CommentList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- },
- "markAsSpam": {
- "id": "blogger.comments.markAsSpam",
- "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}/spam",
- "httpMethod": "POST",
- "description": "Marks a comment as spam.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the Blog.",
- "required": true,
- "location": "path"
- },
- "commentId": {
- "type": "string",
- "description": "The ID of the comment to mark as spam.",
- "required": true,
- "location": "path"
- },
- "postId": {
- "type": "string",
- "description": "The ID of the Post.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId",
- "commentId"
- ],
- "response": {
- "$ref": "Comment"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "removeContent": {
- "id": "blogger.comments.removeContent",
- "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}/removecontent",
- "httpMethod": "POST",
- "description": "Removes the content of a comment.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the Blog.",
- "required": true,
- "location": "path"
- },
- "commentId": {
- "type": "string",
- "description": "The ID of the comment to delete content from.",
- "required": true,
- "location": "path"
- },
- "postId": {
- "type": "string",
- "description": "The ID of the Post.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId",
- "commentId"
- ],
- "response": {
- "$ref": "Comment"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- }
- }
- },
- "pageViews": {
- "methods": {
- "get": {
- "id": "blogger.pageViews.get",
- "path": "blogs/{blogId}/pageviews",
- "httpMethod": "GET",
- "description": "Retrieve pageview stats for a Blog.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the blog to get.",
- "required": true,
- "location": "path"
- },
- "range": {
- "type": "string",
- "enum": [
- "30DAYS",
- "7DAYS",
- "all"
- ],
- "enumDescriptions": [
- "Page view counts from the last thirty days.",
- "Page view counts from the last seven days.",
- "Total page view counts from all time."
- ],
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId"
- ],
- "response": {
- "$ref": "Pageviews"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- }
- }
- },
- "pages": {
- "methods": {
- "delete": {
- "id": "blogger.pages.delete",
- "path": "blogs/{blogId}/pages/{pageId}",
- "httpMethod": "DELETE",
- "description": "Delete a page by ID.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the Blog.",
- "required": true,
- "location": "path"
- },
- "pageId": {
- "type": "string",
- "description": "The ID of the Page.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "blogId",
- "pageId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "get": {
- "id": "blogger.pages.get",
- "path": "blogs/{blogId}/pages/{pageId}",
- "httpMethod": "GET",
- "description": "Gets one blog page by ID.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog containing the page.",
- "required": true,
- "location": "path"
- },
- "pageId": {
- "type": "string",
- "description": "The ID of the page to get.",
- "required": true,
- "location": "path"
- },
- "view": {
- "type": "string",
- "enum": [
- "ADMIN",
- "AUTHOR",
- "READER"
- ],
- "enumDescriptions": [
- "Admin level detail",
- "Author level detail",
- "Reader level detail"
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId",
- "pageId"
- ],
- "response": {
- "$ref": "Page"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- },
- "insert": {
- "id": "blogger.pages.insert",
- "path": "blogs/{blogId}/pages",
- "httpMethod": "POST",
- "description": "Add a page.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to add the page to.",
- "required": true,
- "location": "path"
- },
- "isDraft": {
- "type": "boolean",
- "description": "Whether to create the page as a draft (default: false).",
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId"
- ],
- "request": {
- "$ref": "Page"
- },
- "response": {
- "$ref": "Page"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "list": {
- "id": "blogger.pages.list",
- "path": "blogs/{blogId}/pages",
- "httpMethod": "GET",
- "description": "Retrieves the pages for a blog, optionally including non-LIVE statuses.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to fetch Pages from.",
- "required": true,
- "location": "path"
- },
- "fetchBodies": {
- "type": "boolean",
- "description": "Whether to retrieve the Page bodies.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of Pages to fetch.",
- "format": "uint32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Continuation token if the request is paged.",
- "location": "query"
- },
- "status": {
- "type": "string",
- "enum": [
- "draft",
- "live"
- ],
- "enumDescriptions": [
- "Draft (unpublished) Pages",
- "Pages that are publicly visible"
- ],
- "repeated": true,
- "location": "query"
- },
- "view": {
- "type": "string",
- "description": "Access level with which to view the returned result. Note that some fields require elevated access.",
- "enum": [
- "ADMIN",
- "AUTHOR",
- "READER"
- ],
- "enumDescriptions": [
- "Admin level detail",
- "Author level detail",
- "Reader level detail"
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId"
- ],
- "response": {
- "$ref": "PageList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- },
- "patch": {
- "id": "blogger.pages.patch",
- "path": "blogs/{blogId}/pages/{pageId}",
- "httpMethod": "PATCH",
- "description": "Update a page. This method supports patch semantics.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the Blog.",
- "required": true,
- "location": "path"
- },
- "pageId": {
- "type": "string",
- "description": "The ID of the Page.",
- "required": true,
- "location": "path"
- },
- "publish": {
- "type": "boolean",
- "description": "Whether a publish action should be performed when the page is updated (default: false).",
- "location": "query"
- },
- "revert": {
- "type": "boolean",
- "description": "Whether a revert action should be performed when the page is updated (default: false).",
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId",
- "pageId"
- ],
- "request": {
- "$ref": "Page"
- },
- "response": {
- "$ref": "Page"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "publish": {
- "id": "blogger.pages.publish",
- "path": "blogs/{blogId}/pages/{pageId}/publish",
- "httpMethod": "POST",
- "description": "Publishes a draft page.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the blog.",
- "required": true,
- "location": "path"
- },
- "pageId": {
- "type": "string",
- "description": "The ID of the page.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "blogId",
- "pageId"
- ],
- "response": {
- "$ref": "Page"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "revert": {
- "id": "blogger.pages.revert",
- "path": "blogs/{blogId}/pages/{pageId}/revert",
- "httpMethod": "POST",
- "description": "Revert a published or scheduled page to draft state.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the blog.",
- "required": true,
- "location": "path"
- },
- "pageId": {
- "type": "string",
- "description": "The ID of the page.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "blogId",
- "pageId"
- ],
- "response": {
- "$ref": "Page"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "update": {
- "id": "blogger.pages.update",
- "path": "blogs/{blogId}/pages/{pageId}",
- "httpMethod": "PUT",
- "description": "Update a page.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the Blog.",
- "required": true,
- "location": "path"
- },
- "pageId": {
- "type": "string",
- "description": "The ID of the Page.",
- "required": true,
- "location": "path"
- },
- "publish": {
- "type": "boolean",
- "description": "Whether a publish action should be performed when the page is updated (default: false).",
- "location": "query"
- },
- "revert": {
- "type": "boolean",
- "description": "Whether a revert action should be performed when the page is updated (default: false).",
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId",
- "pageId"
- ],
- "request": {
- "$ref": "Page"
- },
- "response": {
- "$ref": "Page"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- }
- }
- },
- "postUserInfos": {
- "methods": {
- "get": {
- "id": "blogger.postUserInfos.get",
- "path": "users/{userId}/blogs/{blogId}/posts/{postId}",
- "httpMethod": "GET",
- "description": "Gets one post and user info pair, by post ID and user ID. The post user info contains per-user information about the post, such as access rights, specific to the user.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the blog.",
- "required": true,
- "location": "path"
- },
- "maxComments": {
- "type": "integer",
- "description": "Maximum number of comments to pull back on a post.",
- "format": "uint32",
- "location": "query"
- },
- "postId": {
- "type": "string",
- "description": "The ID of the post to get.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "ID of the user for the per-user information to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userId",
- "blogId",
- "postId"
- ],
- "response": {
- "$ref": "PostUserInfo"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- },
- "list": {
- "id": "blogger.postUserInfos.list",
- "path": "users/{userId}/blogs/{blogId}/posts",
- "httpMethod": "GET",
- "description": "Retrieves a list of post and post user info pairs, possibly filtered. The post user info contains per-user information about the post, such as access rights, specific to the user.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to fetch posts from.",
- "required": true,
- "location": "path"
- },
- "endDate": {
- "type": "string",
- "description": "Latest post date to fetch, a date-time with RFC 3339 formatting.",
- "format": "date-time",
- "location": "query"
- },
- "fetchBodies": {
- "type": "boolean",
- "description": "Whether the body content of posts is included. Default is false.",
- "default": "false",
- "location": "query"
- },
- "labels": {
- "type": "string",
- "description": "Comma-separated list of labels to search for.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of posts to fetch.",
- "format": "uint32",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sort order applied to search results. Default is published.",
- "default": "PUBLISHED",
- "enum": [
- "published",
- "updated"
- ],
- "enumDescriptions": [
- "Order by the date the post was published",
- "Order by the date the post was last updated"
- ],
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Continuation token if the request is paged.",
- "location": "query"
- },
- "startDate": {
- "type": "string",
- "description": "Earliest post date to fetch, a date-time with RFC 3339 formatting.",
- "format": "date-time",
- "location": "query"
- },
- "status": {
- "type": "string",
- "enum": [
- "draft",
- "live",
- "scheduled"
- ],
- "enumDescriptions": [
- "Draft posts",
- "Published posts",
- "Posts that are scheduled to publish in future."
- ],
- "repeated": true,
- "location": "query"
- },
- "userId": {
- "type": "string",
- "description": "ID of the user for the per-user information to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier.",
- "required": true,
- "location": "path"
- },
- "view": {
- "type": "string",
- "description": "Access level with which to view the returned result. Note that some fields require elevated access.",
- "enum": [
- "ADMIN",
- "AUTHOR",
- "READER"
- ],
- "enumDescriptions": [
- "Admin level detail",
- "Author level detail",
- "Reader level detail"
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "userId",
- "blogId"
- ],
- "response": {
- "$ref": "PostUserInfosList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- }
- }
- },
- "posts": {
- "methods": {
- "delete": {
- "id": "blogger.posts.delete",
- "path": "blogs/{blogId}/posts/{postId}",
- "httpMethod": "DELETE",
- "description": "Delete a post by ID.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the Blog.",
- "required": true,
- "location": "path"
- },
- "postId": {
- "type": "string",
- "description": "The ID of the Post.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "get": {
- "id": "blogger.posts.get",
- "path": "blogs/{blogId}/posts/{postId}",
- "httpMethod": "GET",
- "description": "Get a post by ID.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to fetch the post from.",
- "required": true,
- "location": "path"
- },
- "fetchBody": {
- "type": "boolean",
- "description": "Whether the body content of the post is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic.",
- "default": "true",
- "location": "query"
- },
- "fetchImages": {
- "type": "boolean",
- "description": "Whether image URL metadata for each post is included (default: false).",
- "location": "query"
- },
- "maxComments": {
- "type": "integer",
- "description": "Maximum number of comments to pull back on a post.",
- "format": "uint32",
- "location": "query"
- },
- "postId": {
- "type": "string",
- "description": "The ID of the post",
- "required": true,
- "location": "path"
- },
- "view": {
- "type": "string",
- "description": "Access level with which to view the returned result. Note that some fields require elevated access.",
- "enum": [
- "ADMIN",
- "AUTHOR",
- "READER"
- ],
- "enumDescriptions": [
- "Admin level detail",
- "Author level detail",
- "Reader level detail"
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId"
- ],
- "response": {
- "$ref": "Post"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- },
- "getByPath": {
- "id": "blogger.posts.getByPath",
- "path": "blogs/{blogId}/posts/bypath",
- "httpMethod": "GET",
- "description": "Retrieve a Post by Path.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to fetch the post from.",
- "required": true,
- "location": "path"
- },
- "maxComments": {
- "type": "integer",
- "description": "Maximum number of comments to pull back on a post.",
- "format": "uint32",
- "location": "query"
- },
- "path": {
- "type": "string",
- "description": "Path of the Post to retrieve.",
- "required": true,
- "location": "query"
- },
- "view": {
- "type": "string",
- "description": "Access level with which to view the returned result. Note that some fields require elevated access.",
- "enum": [
- "ADMIN",
- "AUTHOR",
- "READER"
- ],
- "enumDescriptions": [
- "Admin level detail",
- "Author level detail",
- "Reader level detail"
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId",
- "path"
- ],
- "response": {
- "$ref": "Post"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- },
- "insert": {
- "id": "blogger.posts.insert",
- "path": "blogs/{blogId}/posts",
- "httpMethod": "POST",
- "description": "Add a post.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to add the post to.",
- "required": true,
- "location": "path"
- },
- "fetchBody": {
- "type": "boolean",
- "description": "Whether the body content of the post is included with the result (default: true).",
- "default": "true",
- "location": "query"
- },
- "fetchImages": {
- "type": "boolean",
- "description": "Whether image URL metadata for each post is included in the returned result (default: false).",
- "location": "query"
- },
- "isDraft": {
- "type": "boolean",
- "description": "Whether to create the post as a draft (default: false).",
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId"
- ],
- "request": {
- "$ref": "Post"
- },
- "response": {
- "$ref": "Post"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "list": {
- "id": "blogger.posts.list",
- "path": "blogs/{blogId}/posts",
- "httpMethod": "GET",
- "description": "Retrieves a list of posts, possibly filtered.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to fetch posts from.",
- "required": true,
- "location": "path"
- },
- "endDate": {
- "type": "string",
- "description": "Latest post date to fetch, a date-time with RFC 3339 formatting.",
- "format": "date-time",
- "location": "query"
- },
- "fetchBodies": {
- "type": "boolean",
- "description": "Whether the body content of posts is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic.",
- "default": "true",
- "location": "query"
- },
- "fetchImages": {
- "type": "boolean",
- "description": "Whether image URL metadata for each post is included.",
- "location": "query"
- },
- "labels": {
- "type": "string",
- "description": "Comma-separated list of labels to search for.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of posts to fetch.",
- "format": "uint32",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sort search results",
- "default": "PUBLISHED",
- "enum": [
- "published",
- "updated"
- ],
- "enumDescriptions": [
- "Order by the date the post was published",
- "Order by the date the post was last updated"
- ],
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Continuation token if the request is paged.",
- "location": "query"
- },
- "startDate": {
- "type": "string",
- "description": "Earliest post date to fetch, a date-time with RFC 3339 formatting.",
- "format": "date-time",
- "location": "query"
- },
- "status": {
- "type": "string",
- "description": "Statuses to include in the results.",
- "enum": [
- "draft",
- "live",
- "scheduled"
- ],
- "enumDescriptions": [
- "Draft (non-published) posts.",
- "Published posts",
- "Posts that are scheduled to publish in the future."
- ],
- "repeated": true,
- "location": "query"
- },
- "view": {
- "type": "string",
- "description": "Access level with which to view the returned result. Note that some fields require escalated access.",
- "enum": [
- "ADMIN",
- "AUTHOR",
- "READER"
- ],
- "enumDescriptions": [
- "Admin level detail",
- "Author level detail",
- "Reader level detail"
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId"
- ],
- "response": {
- "$ref": "PostList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- },
- "patch": {
- "id": "blogger.posts.patch",
- "path": "blogs/{blogId}/posts/{postId}",
- "httpMethod": "PATCH",
- "description": "Update a post. This method supports patch semantics.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the Blog.",
- "required": true,
- "location": "path"
- },
- "fetchBody": {
- "type": "boolean",
- "description": "Whether the body content of the post is included with the result (default: true).",
- "default": "true",
- "location": "query"
- },
- "fetchImages": {
- "type": "boolean",
- "description": "Whether image URL metadata for each post is included in the returned result (default: false).",
- "location": "query"
- },
- "maxComments": {
- "type": "integer",
- "description": "Maximum number of comments to retrieve with the returned post.",
- "format": "uint32",
- "location": "query"
- },
- "postId": {
- "type": "string",
- "description": "The ID of the Post.",
- "required": true,
- "location": "path"
- },
- "publish": {
- "type": "boolean",
- "description": "Whether a publish action should be performed when the post is updated (default: false).",
- "location": "query"
- },
- "revert": {
- "type": "boolean",
- "description": "Whether a revert action should be performed when the post is updated (default: false).",
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId"
- ],
- "request": {
- "$ref": "Post"
- },
- "response": {
- "$ref": "Post"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "publish": {
- "id": "blogger.posts.publish",
- "path": "blogs/{blogId}/posts/{postId}/publish",
- "httpMethod": "POST",
- "description": "Publishes a draft post, optionally at the specific time of the given publishDate parameter.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the Blog.",
- "required": true,
- "location": "path"
- },
- "postId": {
- "type": "string",
- "description": "The ID of the Post.",
- "required": true,
- "location": "path"
- },
- "publishDate": {
- "type": "string",
- "description": "Optional date and time to schedule the publishing of the Blog. If no publishDate parameter is given, the post is either published at the a previously saved schedule date (if present), or the current time. If a future date is given, the post will be scheduled to be published.",
- "format": "date-time",
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId"
- ],
- "response": {
- "$ref": "Post"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "revert": {
- "id": "blogger.posts.revert",
- "path": "blogs/{blogId}/posts/{postId}/revert",
- "httpMethod": "POST",
- "description": "Revert a published or scheduled post to draft state.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the Blog.",
- "required": true,
- "location": "path"
- },
- "postId": {
- "type": "string",
- "description": "The ID of the Post.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId"
- ],
- "response": {
- "$ref": "Post"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- },
- "search": {
- "id": "blogger.posts.search",
- "path": "blogs/{blogId}/posts/search",
- "httpMethod": "GET",
- "description": "Search for a post.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "ID of the blog to fetch the post from.",
- "required": true,
- "location": "path"
- },
- "fetchBodies": {
- "type": "boolean",
- "description": "Whether the body content of posts is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic.",
- "default": "true",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sort search results",
- "default": "PUBLISHED",
- "enum": [
- "published",
- "updated"
- ],
- "enumDescriptions": [
- "Order by the date the post was published",
- "Order by the date the post was last updated"
- ],
- "location": "query"
- },
- "q": {
- "type": "string",
- "description": "Query terms to search this blog for matching posts.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId",
- "q"
- ],
- "response": {
- "$ref": "PostList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- },
- "update": {
- "id": "blogger.posts.update",
- "path": "blogs/{blogId}/posts/{postId}",
- "httpMethod": "PUT",
- "description": "Update a post.",
- "parameters": {
- "blogId": {
- "type": "string",
- "description": "The ID of the Blog.",
- "required": true,
- "location": "path"
- },
- "fetchBody": {
- "type": "boolean",
- "description": "Whether the body content of the post is included with the result (default: true).",
- "default": "true",
- "location": "query"
- },
- "fetchImages": {
- "type": "boolean",
- "description": "Whether image URL metadata for each post is included in the returned result (default: false).",
- "location": "query"
- },
- "maxComments": {
- "type": "integer",
- "description": "Maximum number of comments to retrieve with the returned post.",
- "format": "uint32",
- "location": "query"
- },
- "postId": {
- "type": "string",
- "description": "The ID of the Post.",
- "required": true,
- "location": "path"
- },
- "publish": {
- "type": "boolean",
- "description": "Whether a publish action should be performed when the post is updated (default: false).",
- "location": "query"
- },
- "revert": {
- "type": "boolean",
- "description": "Whether a revert action should be performed when the post is updated (default: false).",
- "location": "query"
- }
- },
- "parameterOrder": [
- "blogId",
- "postId"
- ],
- "request": {
- "$ref": "Post"
- },
- "response": {
- "$ref": "Post"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger"
- ]
- }
- }
- },
- "users": {
- "methods": {
- "get": {
- "id": "blogger.users.get",
- "path": "users/{userId}",
- "httpMethod": "GET",
- "description": "Gets one user by ID.",
- "parameters": {
- "userId": {
- "type": "string",
- "description": "The ID of the user to get.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userId"
- ],
- "response": {
- "$ref": "User"
- },
- "scopes": [
- "https://www.googleapis.com/auth/blogger",
- "https://www.googleapis.com/auth/blogger.readonly"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/blogger/v3/blogger-gen.go b/vendor/google.golang.org/api/blogger/v3/blogger-gen.go
deleted file mode 100644
index d66ef091..00000000
--- a/vendor/google.golang.org/api/blogger/v3/blogger-gen.go
+++ /dev/null
@@ -1,7012 +0,0 @@
-// Package blogger provides access to the Blogger API.
-//
-// See https://developers.google.com/blogger/docs/3.0/getting_started
-//
-// Usage example:
-//
-// import "google.golang.org/api/blogger/v3"
-// ...
-// bloggerService, err := blogger.New(oauthHttpClient)
-package blogger // import "google.golang.org/api/blogger/v3"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "blogger:v3"
-const apiName = "blogger"
-const apiVersion = "v3"
-const basePath = "https://www.googleapis.com/blogger/v3/"
-
-// OAuth2 scopes used by this API.
-const (
- // Manage your Blogger account
- BloggerScope = "https://www.googleapis.com/auth/blogger"
-
- // View your Blogger account
- BloggerReadonlyScope = "https://www.googleapis.com/auth/blogger.readonly"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.BlogUserInfos = NewBlogUserInfosService(s)
- s.Blogs = NewBlogsService(s)
- s.Comments = NewCommentsService(s)
- s.PageViews = NewPageViewsService(s)
- s.Pages = NewPagesService(s)
- s.PostUserInfos = NewPostUserInfosService(s)
- s.Posts = NewPostsService(s)
- s.Users = NewUsersService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- BlogUserInfos *BlogUserInfosService
-
- Blogs *BlogsService
-
- Comments *CommentsService
-
- PageViews *PageViewsService
-
- Pages *PagesService
-
- PostUserInfos *PostUserInfosService
-
- Posts *PostsService
-
- Users *UsersService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewBlogUserInfosService(s *Service) *BlogUserInfosService {
- rs := &BlogUserInfosService{s: s}
- return rs
-}
-
-type BlogUserInfosService struct {
- s *Service
-}
-
-func NewBlogsService(s *Service) *BlogsService {
- rs := &BlogsService{s: s}
- return rs
-}
-
-type BlogsService struct {
- s *Service
-}
-
-func NewCommentsService(s *Service) *CommentsService {
- rs := &CommentsService{s: s}
- return rs
-}
-
-type CommentsService struct {
- s *Service
-}
-
-func NewPageViewsService(s *Service) *PageViewsService {
- rs := &PageViewsService{s: s}
- return rs
-}
-
-type PageViewsService struct {
- s *Service
-}
-
-func NewPagesService(s *Service) *PagesService {
- rs := &PagesService{s: s}
- return rs
-}
-
-type PagesService struct {
- s *Service
-}
-
-func NewPostUserInfosService(s *Service) *PostUserInfosService {
- rs := &PostUserInfosService{s: s}
- return rs
-}
-
-type PostUserInfosService struct {
- s *Service
-}
-
-func NewPostsService(s *Service) *PostsService {
- rs := &PostsService{s: s}
- return rs
-}
-
-type PostsService struct {
- s *Service
-}
-
-func NewUsersService(s *Service) *UsersService {
- rs := &UsersService{s: s}
- return rs
-}
-
-type UsersService struct {
- s *Service
-}
-
-type Blog struct {
- // CustomMetaData: The JSON custom meta-data for the Blog
- CustomMetaData string `json:"customMetaData,omitempty"`
-
- // Description: The description of this blog. This is displayed
- // underneath the title.
- Description string `json:"description,omitempty"`
-
- // Id: The identifier for this resource.
- Id string `json:"id,omitempty"`
-
- // Kind: The kind of this entry. Always blogger#blog
- Kind string `json:"kind,omitempty"`
-
- // Locale: The locale this Blog is set to.
- Locale *BlogLocale `json:"locale,omitempty"`
-
- // Name: The name of this blog. This is displayed as the title.
- Name string `json:"name,omitempty"`
-
- // Pages: The container of pages in this blog.
- Pages *BlogPages `json:"pages,omitempty"`
-
- // Posts: The container of posts in this blog.
- Posts *BlogPosts `json:"posts,omitempty"`
-
- // Published: RFC 3339 date-time when this blog was published.
- Published string `json:"published,omitempty"`
-
- // SelfLink: The API REST URL to fetch this resource from.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Status: The status of the blog.
- Status string `json:"status,omitempty"`
-
- // Updated: RFC 3339 date-time when this blog was last updated.
- Updated string `json:"updated,omitempty"`
-
- // Url: The URL where this blog is published.
- Url string `json:"url,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CustomMetaData") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Blog) MarshalJSON() ([]byte, error) {
- type noMethod Blog
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// BlogLocale: The locale this Blog is set to.
-type BlogLocale struct {
- // Country: The country this blog's locale is set to.
- Country string `json:"country,omitempty"`
-
- // Language: The language this blog is authored in.
- Language string `json:"language,omitempty"`
-
- // Variant: The language variant this blog is authored in.
- Variant string `json:"variant,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Country") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BlogLocale) MarshalJSON() ([]byte, error) {
- type noMethod BlogLocale
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// BlogPages: The container of pages in this blog.
-type BlogPages struct {
- // SelfLink: The URL of the container for pages in this blog.
- SelfLink string `json:"selfLink,omitempty"`
-
- // TotalItems: The count of pages in this blog.
- TotalItems int64 `json:"totalItems,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "SelfLink") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BlogPages) MarshalJSON() ([]byte, error) {
- type noMethod BlogPages
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// BlogPosts: The container of posts in this blog.
-type BlogPosts struct {
- // Items: The List of Posts for this Blog.
- Items []*Post `json:"items,omitempty"`
-
- // SelfLink: The URL of the container for posts in this blog.
- SelfLink string `json:"selfLink,omitempty"`
-
- // TotalItems: The count of posts in this blog.
- TotalItems int64 `json:"totalItems,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BlogPosts) MarshalJSON() ([]byte, error) {
- type noMethod BlogPosts
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type BlogList struct {
- // BlogUserInfos: Admin level list of blog per-user information
- BlogUserInfos []*BlogUserInfo `json:"blogUserInfos,omitempty"`
-
- // Items: The list of Blogs this user has Authorship or Admin rights
- // over.
- Items []*Blog `json:"items,omitempty"`
-
- // Kind: The kind of this entity. Always blogger#blogList
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "BlogUserInfos") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BlogList) MarshalJSON() ([]byte, error) {
- type noMethod BlogList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type BlogPerUserInfo struct {
- // BlogId: ID of the Blog resource
- BlogId string `json:"blogId,omitempty"`
-
- // HasAdminAccess: True if the user has Admin level access to the blog.
- HasAdminAccess bool `json:"hasAdminAccess,omitempty"`
-
- // Kind: The kind of this entity. Always blogger#blogPerUserInfo
- Kind string `json:"kind,omitempty"`
-
- // PhotosAlbumKey: The Photo Album Key for the user when adding photos
- // to the blog
- PhotosAlbumKey string `json:"photosAlbumKey,omitempty"`
-
- // Role: Access permissions that the user has for the blog (ADMIN,
- // AUTHOR, or READER).
- Role string `json:"role,omitempty"`
-
- // UserId: ID of the User
- UserId string `json:"userId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BlogId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BlogPerUserInfo) MarshalJSON() ([]byte, error) {
- type noMethod BlogPerUserInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type BlogUserInfo struct {
- // Blog: The Blog resource.
- Blog *Blog `json:"blog,omitempty"`
-
- // BlogUserInfo: Information about a User for the Blog.
- BlogUserInfo *BlogPerUserInfo `json:"blog_user_info,omitempty"`
-
- // Kind: The kind of this entity. Always blogger#blogUserInfo
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Blog") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BlogUserInfo) MarshalJSON() ([]byte, error) {
- type noMethod BlogUserInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Comment struct {
- // Author: The author of this Comment.
- Author *CommentAuthor `json:"author,omitempty"`
-
- // Blog: Data about the blog containing this comment.
- Blog *CommentBlog `json:"blog,omitempty"`
-
- // Content: The actual content of the comment. May include HTML markup.
- Content string `json:"content,omitempty"`
-
- // Id: The identifier for this resource.
- Id string `json:"id,omitempty"`
-
- // InReplyTo: Data about the comment this is in reply to.
- InReplyTo *CommentInReplyTo `json:"inReplyTo,omitempty"`
-
- // Kind: The kind of this entry. Always blogger#comment
- Kind string `json:"kind,omitempty"`
-
- // Post: Data about the post containing this comment.
- Post *CommentPost `json:"post,omitempty"`
-
- // Published: RFC 3339 date-time when this comment was published.
- Published string `json:"published,omitempty"`
-
- // SelfLink: The API REST URL to fetch this resource from.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Status: The status of the comment (only populated for admin users)
- Status string `json:"status,omitempty"`
-
- // Updated: RFC 3339 date-time when this comment was last updated.
- Updated string `json:"updated,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Author") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Comment) MarshalJSON() ([]byte, error) {
- type noMethod Comment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CommentAuthor: The author of this Comment.
-type CommentAuthor struct {
- // DisplayName: The display name.
- DisplayName string `json:"displayName,omitempty"`
-
- // Id: The identifier of the Comment creator.
- Id string `json:"id,omitempty"`
-
- // Image: The comment creator's avatar.
- Image *CommentAuthorImage `json:"image,omitempty"`
-
- // Url: The URL of the Comment creator's Profile page.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DisplayName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CommentAuthor) MarshalJSON() ([]byte, error) {
- type noMethod CommentAuthor
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CommentAuthorImage: The comment creator's avatar.
-type CommentAuthorImage struct {
- // Url: The comment creator's avatar URL.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Url") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CommentAuthorImage) MarshalJSON() ([]byte, error) {
- type noMethod CommentAuthorImage
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CommentBlog: Data about the blog containing this comment.
-type CommentBlog struct {
- // Id: The identifier of the blog containing this comment.
- Id string `json:"id,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CommentBlog) MarshalJSON() ([]byte, error) {
- type noMethod CommentBlog
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CommentInReplyTo: Data about the comment this is in reply to.
-type CommentInReplyTo struct {
- // Id: The identified of the parent of this comment.
- Id string `json:"id,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CommentInReplyTo) MarshalJSON() ([]byte, error) {
- type noMethod CommentInReplyTo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CommentPost: Data about the post containing this comment.
-type CommentPost struct {
- // Id: The identifier of the post containing this comment.
- Id string `json:"id,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CommentPost) MarshalJSON() ([]byte, error) {
- type noMethod CommentPost
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CommentList struct {
- // Etag: Etag of the response.
- Etag string `json:"etag,omitempty"`
-
- // Items: The List of Comments for a Post.
- Items []*Comment `json:"items,omitempty"`
-
- // Kind: The kind of this entry. Always blogger#commentList
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to fetch the next page, if one
- // exists.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // PrevPageToken: Pagination token to fetch the previous page, if one
- // exists.
- PrevPageToken string `json:"prevPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CommentList) MarshalJSON() ([]byte, error) {
- type noMethod CommentList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Page struct {
- // Author: The author of this Page.
- Author *PageAuthor `json:"author,omitempty"`
-
- // Blog: Data about the blog containing this Page.
- Blog *PageBlog `json:"blog,omitempty"`
-
- // Content: The body content of this Page, in HTML.
- Content string `json:"content,omitempty"`
-
- // Etag: Etag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Id: The identifier for this resource.
- Id string `json:"id,omitempty"`
-
- // Kind: The kind of this entity. Always blogger#page
- Kind string `json:"kind,omitempty"`
-
- // Published: RFC 3339 date-time when this Page was published.
- Published string `json:"published,omitempty"`
-
- // SelfLink: The API REST URL to fetch this resource from.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Status: The status of the page for admin resources (either LIVE or
- // DRAFT).
- Status string `json:"status,omitempty"`
-
- // Title: The title of this entity. This is the name displayed in the
- // Admin user interface.
- Title string `json:"title,omitempty"`
-
- // Updated: RFC 3339 date-time when this Page was last updated.
- Updated string `json:"updated,omitempty"`
-
- // Url: The URL that this Page is displayed at.
- Url string `json:"url,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Author") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Page) MarshalJSON() ([]byte, error) {
- type noMethod Page
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PageAuthor: The author of this Page.
-type PageAuthor struct {
- // DisplayName: The display name.
- DisplayName string `json:"displayName,omitempty"`
-
- // Id: The identifier of the Page creator.
- Id string `json:"id,omitempty"`
-
- // Image: The page author's avatar.
- Image *PageAuthorImage `json:"image,omitempty"`
-
- // Url: The URL of the Page creator's Profile page.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DisplayName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PageAuthor) MarshalJSON() ([]byte, error) {
- type noMethod PageAuthor
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PageAuthorImage: The page author's avatar.
-type PageAuthorImage struct {
- // Url: The page author's avatar URL.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Url") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PageAuthorImage) MarshalJSON() ([]byte, error) {
- type noMethod PageAuthorImage
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PageBlog: Data about the blog containing this Page.
-type PageBlog struct {
- // Id: The identifier of the blog containing this page.
- Id string `json:"id,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PageBlog) MarshalJSON() ([]byte, error) {
- type noMethod PageBlog
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type PageList struct {
- // Etag: Etag of the response.
- Etag string `json:"etag,omitempty"`
-
- // Items: The list of Pages for a Blog.
- Items []*Page `json:"items,omitempty"`
-
- // Kind: The kind of this entity. Always blogger#pageList
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to fetch the next page, if one
- // exists.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PageList) MarshalJSON() ([]byte, error) {
- type noMethod PageList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Pageviews struct {
- // BlogId: Blog Id
- BlogId string `json:"blogId,omitempty"`
-
- // Counts: The container of posts in this blog.
- Counts []*PageviewsCounts `json:"counts,omitempty"`
-
- // Kind: The kind of this entry. Always blogger#page_views
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "BlogId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Pageviews) MarshalJSON() ([]byte, error) {
- type noMethod Pageviews
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type PageviewsCounts struct {
- // Count: Count of page views for the given time range
- Count int64 `json:"count,omitempty,string"`
-
- // TimeRange: Time range the given count applies to
- TimeRange string `json:"timeRange,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Count") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PageviewsCounts) MarshalJSON() ([]byte, error) {
- type noMethod PageviewsCounts
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Post struct {
- // Author: The author of this Post.
- Author *PostAuthor `json:"author,omitempty"`
-
- // Blog: Data about the blog containing this Post.
- Blog *PostBlog `json:"blog,omitempty"`
-
- // Content: The content of the Post. May contain HTML markup.
- Content string `json:"content,omitempty"`
-
- // CustomMetaData: The JSON meta-data for the Post.
- CustomMetaData string `json:"customMetaData,omitempty"`
-
- // Etag: Etag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Id: The identifier of this Post.
- Id string `json:"id,omitempty"`
-
- // Images: Display image for the Post.
- Images []*PostImages `json:"images,omitempty"`
-
- // Kind: The kind of this entity. Always blogger#post
- Kind string `json:"kind,omitempty"`
-
- // Labels: The list of labels this Post was tagged with.
- Labels []string `json:"labels,omitempty"`
-
- // Location: The location for geotagged posts.
- Location *PostLocation `json:"location,omitempty"`
-
- // Published: RFC 3339 date-time when this Post was published.
- Published string `json:"published,omitempty"`
-
- // ReaderComments: Comment control and display setting for readers of
- // this post.
- ReaderComments string `json:"readerComments,omitempty"`
-
- // Replies: The container of comments on this Post.
- Replies *PostReplies `json:"replies,omitempty"`
-
- // SelfLink: The API REST URL to fetch this resource from.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Status: Status of the post. Only set for admin-level requests
- Status string `json:"status,omitempty"`
-
- // Title: The title of the Post.
- Title string `json:"title,omitempty"`
-
- // TitleLink: The title link URL, similar to atom's related link.
- TitleLink string `json:"titleLink,omitempty"`
-
- // Updated: RFC 3339 date-time when this Post was last updated.
- Updated string `json:"updated,omitempty"`
-
- // Url: The URL where this Post is displayed.
- Url string `json:"url,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Author") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Post) MarshalJSON() ([]byte, error) {
- type noMethod Post
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PostAuthor: The author of this Post.
-type PostAuthor struct {
- // DisplayName: The display name.
- DisplayName string `json:"displayName,omitempty"`
-
- // Id: The identifier of the Post creator.
- Id string `json:"id,omitempty"`
-
- // Image: The Post author's avatar.
- Image *PostAuthorImage `json:"image,omitempty"`
-
- // Url: The URL of the Post creator's Profile page.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DisplayName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PostAuthor) MarshalJSON() ([]byte, error) {
- type noMethod PostAuthor
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PostAuthorImage: The Post author's avatar.
-type PostAuthorImage struct {
- // Url: The Post author's avatar URL.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Url") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PostAuthorImage) MarshalJSON() ([]byte, error) {
- type noMethod PostAuthorImage
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PostBlog: Data about the blog containing this Post.
-type PostBlog struct {
- // Id: The identifier of the Blog that contains this Post.
- Id string `json:"id,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PostBlog) MarshalJSON() ([]byte, error) {
- type noMethod PostBlog
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type PostImages struct {
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Url") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PostImages) MarshalJSON() ([]byte, error) {
- type noMethod PostImages
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PostLocation: The location for geotagged posts.
-type PostLocation struct {
- // Lat: Location's latitude.
- Lat float64 `json:"lat,omitempty"`
-
- // Lng: Location's longitude.
- Lng float64 `json:"lng,omitempty"`
-
- // Name: Location name.
- Name string `json:"name,omitempty"`
-
- // Span: Location's viewport span. Can be used when rendering a map
- // preview.
- Span string `json:"span,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Lat") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PostLocation) MarshalJSON() ([]byte, error) {
- type noMethod PostLocation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PostReplies: The container of comments on this Post.
-type PostReplies struct {
- // Items: The List of Comments for this Post.
- Items []*Comment `json:"items,omitempty"`
-
- // SelfLink: The URL of the comments on this post.
- SelfLink string `json:"selfLink,omitempty"`
-
- // TotalItems: The count of comments on this post.
- TotalItems int64 `json:"totalItems,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PostReplies) MarshalJSON() ([]byte, error) {
- type noMethod PostReplies
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type PostList struct {
- // Etag: Etag of the response.
- Etag string `json:"etag,omitempty"`
-
- // Items: The list of Posts for this Blog.
- Items []*Post `json:"items,omitempty"`
-
- // Kind: The kind of this entity. Always blogger#postList
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to fetch the next page, if one
- // exists.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PostList) MarshalJSON() ([]byte, error) {
- type noMethod PostList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type PostPerUserInfo struct {
- // BlogId: ID of the Blog that the post resource belongs to.
- BlogId string `json:"blogId,omitempty"`
-
- // HasEditAccess: True if the user has Author level access to the post.
- HasEditAccess bool `json:"hasEditAccess,omitempty"`
-
- // Kind: The kind of this entity. Always blogger#postPerUserInfo
- Kind string `json:"kind,omitempty"`
-
- // PostId: ID of the Post resource.
- PostId string `json:"postId,omitempty"`
-
- // UserId: ID of the User.
- UserId string `json:"userId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BlogId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PostPerUserInfo) MarshalJSON() ([]byte, error) {
- type noMethod PostPerUserInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type PostUserInfo struct {
- // Kind: The kind of this entity. Always blogger#postUserInfo
- Kind string `json:"kind,omitempty"`
-
- // Post: The Post resource.
- Post *Post `json:"post,omitempty"`
-
- // PostUserInfo: Information about a User for the Post.
- PostUserInfo *PostPerUserInfo `json:"post_user_info,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PostUserInfo) MarshalJSON() ([]byte, error) {
- type noMethod PostUserInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type PostUserInfosList struct {
- // Items: The list of Posts with User information for the post, for this
- // Blog.
- Items []*PostUserInfo `json:"items,omitempty"`
-
- // Kind: The kind of this entity. Always blogger#postList
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to fetch the next page, if one
- // exists.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PostUserInfosList) MarshalJSON() ([]byte, error) {
- type noMethod PostUserInfosList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type User struct {
- // About: Profile summary information.
- About string `json:"about,omitempty"`
-
- // Blogs: The container of blogs for this user.
- Blogs *UserBlogs `json:"blogs,omitempty"`
-
- // Created: The timestamp of when this profile was created, in seconds
- // since epoch.
- Created string `json:"created,omitempty"`
-
- // DisplayName: The display name.
- DisplayName string `json:"displayName,omitempty"`
-
- // Id: The identifier for this User.
- Id string `json:"id,omitempty"`
-
- // Kind: The kind of this entity. Always blogger#user
- Kind string `json:"kind,omitempty"`
-
- // Locale: This user's locale
- Locale *UserLocale `json:"locale,omitempty"`
-
- // SelfLink: The API REST URL to fetch this resource from.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Url: The user's profile page.
- Url string `json:"url,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "About") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *User) MarshalJSON() ([]byte, error) {
- type noMethod User
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserBlogs: The container of blogs for this user.
-type UserBlogs struct {
- // SelfLink: The URL of the Blogs for this user.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "SelfLink") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserBlogs) MarshalJSON() ([]byte, error) {
- type noMethod UserBlogs
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserLocale: This user's locale
-type UserLocale struct {
- // Country: The user's country setting.
- Country string `json:"country,omitempty"`
-
- // Language: The user's language setting.
- Language string `json:"language,omitempty"`
-
- // Variant: The user's language variant setting.
- Variant string `json:"variant,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Country") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserLocale) MarshalJSON() ([]byte, error) {
- type noMethod UserLocale
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "blogger.blogUserInfos.get":
-
-type BlogUserInfosGetCall struct {
- s *Service
- userId string
- blogId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one blog and user info pair by blogId and userId.
-func (r *BlogUserInfosService) Get(userId string, blogId string) *BlogUserInfosGetCall {
- c := &BlogUserInfosGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.userId = userId
- c.blogId = blogId
- return c
-}
-
-// MaxPosts sets the optional parameter "maxPosts": Maximum number of
-// posts to pull back with the blog.
-func (c *BlogUserInfosGetCall) MaxPosts(maxPosts int64) *BlogUserInfosGetCall {
- c.opt_["maxPosts"] = maxPosts
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BlogUserInfosGetCall) Fields(s ...googleapi.Field) *BlogUserInfosGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *BlogUserInfosGetCall) IfNoneMatch(entityTag string) *BlogUserInfosGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BlogUserInfosGetCall) Context(ctx context.Context) *BlogUserInfosGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BlogUserInfosGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxPosts"]; ok {
- params.Set("maxPosts", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userId}/blogs/{blogId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userId": c.userId,
- "blogId": c.blogId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.blogUserInfos.get" call.
-// Exactly one of *BlogUserInfo or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *BlogUserInfo.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *BlogUserInfosGetCall) Do() (*BlogUserInfo, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &BlogUserInfo{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one blog and user info pair by blogId and userId.",
- // "httpMethod": "GET",
- // "id": "blogger.blogUserInfos.get",
- // "parameterOrder": [
- // "userId",
- // "blogId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "The ID of the blog to get.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxPosts": {
- // "description": "Maximum number of posts to pull back with the blog.",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "userId": {
- // "description": "ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userId}/blogs/{blogId}",
- // "response": {
- // "$ref": "BlogUserInfo"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger",
- // "https://www.googleapis.com/auth/blogger.readonly"
- // ]
- // }
-
-}
-
-// method id "blogger.blogs.get":
-
-type BlogsGetCall struct {
- s *Service
- blogId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one blog by ID.
-func (r *BlogsService) Get(blogId string) *BlogsGetCall {
- c := &BlogsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- return c
-}
-
-// MaxPosts sets the optional parameter "maxPosts": Maximum number of
-// posts to pull back with the blog.
-func (c *BlogsGetCall) MaxPosts(maxPosts int64) *BlogsGetCall {
- c.opt_["maxPosts"] = maxPosts
- return c
-}
-
-// View sets the optional parameter "view": Access level with which to
-// view the blog. Note that some fields require elevated access.
-//
-// Possible values:
-// "ADMIN" - Admin level detail.
-// "AUTHOR" - Author level detail.
-// "READER" - Reader level detail.
-func (c *BlogsGetCall) View(view string) *BlogsGetCall {
- c.opt_["view"] = view
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BlogsGetCall) Fields(s ...googleapi.Field) *BlogsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *BlogsGetCall) IfNoneMatch(entityTag string) *BlogsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BlogsGetCall) Context(ctx context.Context) *BlogsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BlogsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxPosts"]; ok {
- params.Set("maxPosts", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["view"]; ok {
- params.Set("view", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.blogs.get" call.
-// Exactly one of *Blog or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Blog.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *BlogsGetCall) Do() (*Blog, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Blog{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one blog by ID.",
- // "httpMethod": "GET",
- // "id": "blogger.blogs.get",
- // "parameterOrder": [
- // "blogId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "The ID of the blog to get.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxPosts": {
- // "description": "Maximum number of posts to pull back with the blog.",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "view": {
- // "description": "Access level with which to view the blog. Note that some fields require elevated access.",
- // "enum": [
- // "ADMIN",
- // "AUTHOR",
- // "READER"
- // ],
- // "enumDescriptions": [
- // "Admin level detail.",
- // "Author level detail.",
- // "Reader level detail."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "blogs/{blogId}",
- // "response": {
- // "$ref": "Blog"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger",
- // "https://www.googleapis.com/auth/blogger.readonly"
- // ]
- // }
-
-}
-
-// method id "blogger.blogs.getByUrl":
-
-type BlogsGetByUrlCall struct {
- s *Service
- url string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetByUrl: Retrieve a Blog by URL.
-func (r *BlogsService) GetByUrl(url string) *BlogsGetByUrlCall {
- c := &BlogsGetByUrlCall{s: r.s, opt_: make(map[string]interface{})}
- c.url = url
- return c
-}
-
-// View sets the optional parameter "view": Access level with which to
-// view the blog. Note that some fields require elevated access.
-//
-// Possible values:
-// "ADMIN" - Admin level detail.
-// "AUTHOR" - Author level detail.
-// "READER" - Reader level detail.
-func (c *BlogsGetByUrlCall) View(view string) *BlogsGetByUrlCall {
- c.opt_["view"] = view
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BlogsGetByUrlCall) Fields(s ...googleapi.Field) *BlogsGetByUrlCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *BlogsGetByUrlCall) IfNoneMatch(entityTag string) *BlogsGetByUrlCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BlogsGetByUrlCall) Context(ctx context.Context) *BlogsGetByUrlCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BlogsGetByUrlCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("url", fmt.Sprintf("%v", c.url))
- if v, ok := c.opt_["view"]; ok {
- params.Set("view", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/byurl")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.blogs.getByUrl" call.
-// Exactly one of *Blog or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Blog.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *BlogsGetByUrlCall) Do() (*Blog, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Blog{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieve a Blog by URL.",
- // "httpMethod": "GET",
- // "id": "blogger.blogs.getByUrl",
- // "parameterOrder": [
- // "url"
- // ],
- // "parameters": {
- // "url": {
- // "description": "The URL of the blog to retrieve.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "view": {
- // "description": "Access level with which to view the blog. Note that some fields require elevated access.",
- // "enum": [
- // "ADMIN",
- // "AUTHOR",
- // "READER"
- // ],
- // "enumDescriptions": [
- // "Admin level detail.",
- // "Author level detail.",
- // "Reader level detail."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "blogs/byurl",
- // "response": {
- // "$ref": "Blog"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger",
- // "https://www.googleapis.com/auth/blogger.readonly"
- // ]
- // }
-
-}
-
-// method id "blogger.blogs.listByUser":
-
-type BlogsListByUserCall struct {
- s *Service
- userId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// ListByUser: Retrieves a list of blogs, possibly filtered.
-func (r *BlogsService) ListByUser(userId string) *BlogsListByUserCall {
- c := &BlogsListByUserCall{s: r.s, opt_: make(map[string]interface{})}
- c.userId = userId
- return c
-}
-
-// FetchUserInfo sets the optional parameter "fetchUserInfo": Whether
-// the response is a list of blogs with per-user information instead of
-// just blogs.
-func (c *BlogsListByUserCall) FetchUserInfo(fetchUserInfo bool) *BlogsListByUserCall {
- c.opt_["fetchUserInfo"] = fetchUserInfo
- return c
-}
-
-// Role sets the optional parameter "role": User access types for blogs
-// to include in the results, e.g. AUTHOR will return blogs where the
-// user has author level access. If no roles are specified, defaults to
-// ADMIN and AUTHOR roles.
-//
-// Possible values:
-// "ADMIN" - Admin role - Blogs where the user has Admin level access.
-// "AUTHOR" - Author role - Blogs where the user has Author level
-// access.
-// "READER" - Reader role - Blogs where the user has Reader level
-// access (to a private blog).
-func (c *BlogsListByUserCall) Role(role string) *BlogsListByUserCall {
- c.opt_["role"] = role
- return c
-}
-
-// Status sets the optional parameter "status": Blog statuses to include
-// in the result (default: Live blogs only). Note that ADMIN access is
-// required to view deleted blogs.
-//
-// Possible values:
-// "DELETED" - Blog has been deleted by an administrator.
-// "LIVE" (default) - Blog is currently live.
-func (c *BlogsListByUserCall) Status(status string) *BlogsListByUserCall {
- c.opt_["status"] = status
- return c
-}
-
-// View sets the optional parameter "view": Access level with which to
-// view the blogs. Note that some fields require elevated access.
-//
-// Possible values:
-// "ADMIN" - Admin level detail.
-// "AUTHOR" - Author level detail.
-// "READER" - Reader level detail.
-func (c *BlogsListByUserCall) View(view string) *BlogsListByUserCall {
- c.opt_["view"] = view
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BlogsListByUserCall) Fields(s ...googleapi.Field) *BlogsListByUserCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *BlogsListByUserCall) IfNoneMatch(entityTag string) *BlogsListByUserCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BlogsListByUserCall) Context(ctx context.Context) *BlogsListByUserCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BlogsListByUserCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fetchUserInfo"]; ok {
- params.Set("fetchUserInfo", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["role"]; ok {
- params.Set("role", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["status"]; ok {
- params.Set("status", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["view"]; ok {
- params.Set("view", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userId}/blogs")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userId": c.userId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.blogs.listByUser" call.
-// Exactly one of *BlogList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *BlogList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *BlogsListByUserCall) Do() (*BlogList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &BlogList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of blogs, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "blogger.blogs.listByUser",
- // "parameterOrder": [
- // "userId"
- // ],
- // "parameters": {
- // "fetchUserInfo": {
- // "description": "Whether the response is a list of blogs with per-user information instead of just blogs.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "role": {
- // "description": "User access types for blogs to include in the results, e.g. AUTHOR will return blogs where the user has author level access. If no roles are specified, defaults to ADMIN and AUTHOR roles.",
- // "enum": [
- // "ADMIN",
- // "AUTHOR",
- // "READER"
- // ],
- // "enumDescriptions": [
- // "Admin role - Blogs where the user has Admin level access.",
- // "Author role - Blogs where the user has Author level access.",
- // "Reader role - Blogs where the user has Reader level access (to a private blog)."
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "status": {
- // "default": "LIVE",
- // "description": "Blog statuses to include in the result (default: Live blogs only). Note that ADMIN access is required to view deleted blogs.",
- // "enum": [
- // "DELETED",
- // "LIVE"
- // ],
- // "enumDescriptions": [
- // "Blog has been deleted by an administrator.",
- // "Blog is currently live."
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "userId": {
- // "description": "ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "view": {
- // "description": "Access level with which to view the blogs. Note that some fields require elevated access.",
- // "enum": [
- // "ADMIN",
- // "AUTHOR",
- // "READER"
- // ],
- // "enumDescriptions": [
- // "Admin level detail.",
- // "Author level detail.",
- // "Reader level detail."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "users/{userId}/blogs",
- // "response": {
- // "$ref": "BlogList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger",
- // "https://www.googleapis.com/auth/blogger.readonly"
- // ]
- // }
-
-}
-
-// method id "blogger.comments.approve":
-
-type CommentsApproveCall struct {
- s *Service
- blogId string
- postId string
- commentId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Approve: Marks a comment as not spam.
-func (r *CommentsService) Approve(blogId string, postId string, commentId string) *CommentsApproveCall {
- c := &CommentsApproveCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- c.postId = postId
- c.commentId = commentId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CommentsApproveCall) Fields(s ...googleapi.Field) *CommentsApproveCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CommentsApproveCall) Context(ctx context.Context) *CommentsApproveCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CommentsApproveCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/posts/{postId}/comments/{commentId}/approve")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- "postId": c.postId,
- "commentId": c.commentId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.comments.approve" call.
-// Exactly one of *Comment or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Comment.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *CommentsApproveCall) Do() (*Comment, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Comment{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Marks a comment as not spam.",
- // "httpMethod": "POST",
- // "id": "blogger.comments.approve",
- // "parameterOrder": [
- // "blogId",
- // "postId",
- // "commentId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "The ID of the Blog.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "commentId": {
- // "description": "The ID of the comment to mark as not spam.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "postId": {
- // "description": "The ID of the Post.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}/approve",
- // "response": {
- // "$ref": "Comment"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger"
- // ]
- // }
-
-}
-
-// method id "blogger.comments.delete":
-
-type CommentsDeleteCall struct {
- s *Service
- blogId string
- postId string
- commentId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Delete a comment by ID.
-func (r *CommentsService) Delete(blogId string, postId string, commentId string) *CommentsDeleteCall {
- c := &CommentsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- c.postId = postId
- c.commentId = commentId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CommentsDeleteCall) Fields(s ...googleapi.Field) *CommentsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CommentsDeleteCall) Context(ctx context.Context) *CommentsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CommentsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/posts/{postId}/comments/{commentId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- "postId": c.postId,
- "commentId": c.commentId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.comments.delete" call.
-func (c *CommentsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Delete a comment by ID.",
- // "httpMethod": "DELETE",
- // "id": "blogger.comments.delete",
- // "parameterOrder": [
- // "blogId",
- // "postId",
- // "commentId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "The ID of the Blog.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "commentId": {
- // "description": "The ID of the comment to delete.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "postId": {
- // "description": "The ID of the Post.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger"
- // ]
- // }
-
-}
-
-// method id "blogger.comments.get":
-
-type CommentsGetCall struct {
- s *Service
- blogId string
- postId string
- commentId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one comment by ID.
-func (r *CommentsService) Get(blogId string, postId string, commentId string) *CommentsGetCall {
- c := &CommentsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- c.postId = postId
- c.commentId = commentId
- return c
-}
-
-// View sets the optional parameter "view": Access level for the
-// requested comment (default: READER). Note that some comments will
-// require elevated permissions, for example comments where the parent
-// posts which is in a draft state, or comments that are pending
-// moderation.
-//
-// Possible values:
-// "ADMIN" - Admin level detail
-// "AUTHOR" - Author level detail
-// "READER" - Admin level detail
-func (c *CommentsGetCall) View(view string) *CommentsGetCall {
- c.opt_["view"] = view
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CommentsGetCall) Fields(s ...googleapi.Field) *CommentsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CommentsGetCall) IfNoneMatch(entityTag string) *CommentsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CommentsGetCall) Context(ctx context.Context) *CommentsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CommentsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["view"]; ok {
- params.Set("view", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/posts/{postId}/comments/{commentId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- "postId": c.postId,
- "commentId": c.commentId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.comments.get" call.
-// Exactly one of *Comment or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Comment.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *CommentsGetCall) Do() (*Comment, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Comment{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one comment by ID.",
- // "httpMethod": "GET",
- // "id": "blogger.comments.get",
- // "parameterOrder": [
- // "blogId",
- // "postId",
- // "commentId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "ID of the blog to containing the comment.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "commentId": {
- // "description": "The ID of the comment to get.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "postId": {
- // "description": "ID of the post to fetch posts from.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "view": {
- // "description": "Access level for the requested comment (default: READER). Note that some comments will require elevated permissions, for example comments where the parent posts which is in a draft state, or comments that are pending moderation.",
- // "enum": [
- // "ADMIN",
- // "AUTHOR",
- // "READER"
- // ],
- // "enumDescriptions": [
- // "Admin level detail",
- // "Author level detail",
- // "Admin level detail"
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}",
- // "response": {
- // "$ref": "Comment"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger",
- // "https://www.googleapis.com/auth/blogger.readonly"
- // ]
- // }
-
-}
-
-// method id "blogger.comments.list":
-
-type CommentsListCall struct {
- s *Service
- blogId string
- postId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the comments for a post, possibly filtered.
-func (r *CommentsService) List(blogId string, postId string) *CommentsListCall {
- c := &CommentsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- c.postId = postId
- return c
-}
-
-// EndDate sets the optional parameter "endDate": Latest date of comment
-// to fetch, a date-time with RFC 3339 formatting.
-func (c *CommentsListCall) EndDate(endDate string) *CommentsListCall {
- c.opt_["endDate"] = endDate
- return c
-}
-
-// FetchBodies sets the optional parameter "fetchBodies": Whether the
-// body content of the comments is included.
-func (c *CommentsListCall) FetchBodies(fetchBodies bool) *CommentsListCall {
- c.opt_["fetchBodies"] = fetchBodies
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of comments to include in the result.
-func (c *CommentsListCall) MaxResults(maxResults int64) *CommentsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Continuation token
-// if request is paged.
-func (c *CommentsListCall) PageToken(pageToken string) *CommentsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// StartDate sets the optional parameter "startDate": Earliest date of
-// comment to fetch, a date-time with RFC 3339 formatting.
-func (c *CommentsListCall) StartDate(startDate string) *CommentsListCall {
- c.opt_["startDate"] = startDate
- return c
-}
-
-// Status sets the optional parameter "status":
-//
-// Possible values:
-// "emptied" - Comments that have had their content removed
-// "live" - Comments that are publicly visible
-// "pending" - Comments that are awaiting administrator approval
-// "spam" - Comments marked as spam by the administrator
-func (c *CommentsListCall) Status(status string) *CommentsListCall {
- c.opt_["status"] = status
- return c
-}
-
-// View sets the optional parameter "view": Access level with which to
-// view the returned result. Note that some fields require elevated
-// access.
-//
-// Possible values:
-// "ADMIN" - Admin level detail
-// "AUTHOR" - Author level detail
-// "READER" - Reader level detail
-func (c *CommentsListCall) View(view string) *CommentsListCall {
- c.opt_["view"] = view
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CommentsListCall) Fields(s ...googleapi.Field) *CommentsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CommentsListCall) IfNoneMatch(entityTag string) *CommentsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CommentsListCall) Context(ctx context.Context) *CommentsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CommentsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["endDate"]; ok {
- params.Set("endDate", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fetchBodies"]; ok {
- params.Set("fetchBodies", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startDate"]; ok {
- params.Set("startDate", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["status"]; ok {
- params.Set("status", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["view"]; ok {
- params.Set("view", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/posts/{postId}/comments")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- "postId": c.postId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.comments.list" call.
-// Exactly one of *CommentList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CommentList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CommentsListCall) Do() (*CommentList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CommentList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the comments for a post, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "blogger.comments.list",
- // "parameterOrder": [
- // "blogId",
- // "postId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "ID of the blog to fetch comments from.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "endDate": {
- // "description": "Latest date of comment to fetch, a date-time with RFC 3339 formatting.",
- // "format": "date-time",
- // "location": "query",
- // "type": "string"
- // },
- // "fetchBodies": {
- // "description": "Whether the body content of the comments is included.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "Maximum number of comments to include in the result.",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Continuation token if request is paged.",
- // "location": "query",
- // "type": "string"
- // },
- // "postId": {
- // "description": "ID of the post to fetch posts from.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "startDate": {
- // "description": "Earliest date of comment to fetch, a date-time with RFC 3339 formatting.",
- // "format": "date-time",
- // "location": "query",
- // "type": "string"
- // },
- // "status": {
- // "enum": [
- // "emptied",
- // "live",
- // "pending",
- // "spam"
- // ],
- // "enumDescriptions": [
- // "Comments that have had their content removed",
- // "Comments that are publicly visible",
- // "Comments that are awaiting administrator approval",
- // "Comments marked as spam by the administrator"
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "view": {
- // "description": "Access level with which to view the returned result. Note that some fields require elevated access.",
- // "enum": [
- // "ADMIN",
- // "AUTHOR",
- // "READER"
- // ],
- // "enumDescriptions": [
- // "Admin level detail",
- // "Author level detail",
- // "Reader level detail"
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "blogs/{blogId}/posts/{postId}/comments",
- // "response": {
- // "$ref": "CommentList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger",
- // "https://www.googleapis.com/auth/blogger.readonly"
- // ]
- // }
-
-}
-
-// method id "blogger.comments.listByBlog":
-
-type CommentsListByBlogCall struct {
- s *Service
- blogId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// ListByBlog: Retrieves the comments for a blog, across all posts,
-// possibly filtered.
-func (r *CommentsService) ListByBlog(blogId string) *CommentsListByBlogCall {
- c := &CommentsListByBlogCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- return c
-}
-
-// EndDate sets the optional parameter "endDate": Latest date of comment
-// to fetch, a date-time with RFC 3339 formatting.
-func (c *CommentsListByBlogCall) EndDate(endDate string) *CommentsListByBlogCall {
- c.opt_["endDate"] = endDate
- return c
-}
-
-// FetchBodies sets the optional parameter "fetchBodies": Whether the
-// body content of the comments is included.
-func (c *CommentsListByBlogCall) FetchBodies(fetchBodies bool) *CommentsListByBlogCall {
- c.opt_["fetchBodies"] = fetchBodies
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of comments to include in the result.
-func (c *CommentsListByBlogCall) MaxResults(maxResults int64) *CommentsListByBlogCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Continuation token
-// if request is paged.
-func (c *CommentsListByBlogCall) PageToken(pageToken string) *CommentsListByBlogCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// StartDate sets the optional parameter "startDate": Earliest date of
-// comment to fetch, a date-time with RFC 3339 formatting.
-func (c *CommentsListByBlogCall) StartDate(startDate string) *CommentsListByBlogCall {
- c.opt_["startDate"] = startDate
- return c
-}
-
-// Status sets the optional parameter "status":
-//
-// Possible values:
-// "emptied" - Comments that have had their content removed
-// "live" - Comments that are publicly visible
-// "pending" - Comments that are awaiting administrator approval
-// "spam" - Comments marked as spam by the administrator
-func (c *CommentsListByBlogCall) Status(status string) *CommentsListByBlogCall {
- c.opt_["status"] = status
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CommentsListByBlogCall) Fields(s ...googleapi.Field) *CommentsListByBlogCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CommentsListByBlogCall) IfNoneMatch(entityTag string) *CommentsListByBlogCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CommentsListByBlogCall) Context(ctx context.Context) *CommentsListByBlogCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CommentsListByBlogCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["endDate"]; ok {
- params.Set("endDate", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fetchBodies"]; ok {
- params.Set("fetchBodies", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startDate"]; ok {
- params.Set("startDate", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["status"]; ok {
- params.Set("status", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/comments")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.comments.listByBlog" call.
-// Exactly one of *CommentList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CommentList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CommentsListByBlogCall) Do() (*CommentList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CommentList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the comments for a blog, across all posts, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "blogger.comments.listByBlog",
- // "parameterOrder": [
- // "blogId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "ID of the blog to fetch comments from.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "endDate": {
- // "description": "Latest date of comment to fetch, a date-time with RFC 3339 formatting.",
- // "format": "date-time",
- // "location": "query",
- // "type": "string"
- // },
- // "fetchBodies": {
- // "description": "Whether the body content of the comments is included.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "Maximum number of comments to include in the result.",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Continuation token if request is paged.",
- // "location": "query",
- // "type": "string"
- // },
- // "startDate": {
- // "description": "Earliest date of comment to fetch, a date-time with RFC 3339 formatting.",
- // "format": "date-time",
- // "location": "query",
- // "type": "string"
- // },
- // "status": {
- // "enum": [
- // "emptied",
- // "live",
- // "pending",
- // "spam"
- // ],
- // "enumDescriptions": [
- // "Comments that have had their content removed",
- // "Comments that are publicly visible",
- // "Comments that are awaiting administrator approval",
- // "Comments marked as spam by the administrator"
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // }
- // },
- // "path": "blogs/{blogId}/comments",
- // "response": {
- // "$ref": "CommentList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger",
- // "https://www.googleapis.com/auth/blogger.readonly"
- // ]
- // }
-
-}
-
-// method id "blogger.comments.markAsSpam":
-
-type CommentsMarkAsSpamCall struct {
- s *Service
- blogId string
- postId string
- commentId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// MarkAsSpam: Marks a comment as spam.
-func (r *CommentsService) MarkAsSpam(blogId string, postId string, commentId string) *CommentsMarkAsSpamCall {
- c := &CommentsMarkAsSpamCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- c.postId = postId
- c.commentId = commentId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CommentsMarkAsSpamCall) Fields(s ...googleapi.Field) *CommentsMarkAsSpamCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CommentsMarkAsSpamCall) Context(ctx context.Context) *CommentsMarkAsSpamCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CommentsMarkAsSpamCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/posts/{postId}/comments/{commentId}/spam")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- "postId": c.postId,
- "commentId": c.commentId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.comments.markAsSpam" call.
-// Exactly one of *Comment or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Comment.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *CommentsMarkAsSpamCall) Do() (*Comment, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Comment{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Marks a comment as spam.",
- // "httpMethod": "POST",
- // "id": "blogger.comments.markAsSpam",
- // "parameterOrder": [
- // "blogId",
- // "postId",
- // "commentId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "The ID of the Blog.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "commentId": {
- // "description": "The ID of the comment to mark as spam.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "postId": {
- // "description": "The ID of the Post.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}/spam",
- // "response": {
- // "$ref": "Comment"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger"
- // ]
- // }
-
-}
-
-// method id "blogger.comments.removeContent":
-
-type CommentsRemoveContentCall struct {
- s *Service
- blogId string
- postId string
- commentId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// RemoveContent: Removes the content of a comment.
-func (r *CommentsService) RemoveContent(blogId string, postId string, commentId string) *CommentsRemoveContentCall {
- c := &CommentsRemoveContentCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- c.postId = postId
- c.commentId = commentId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CommentsRemoveContentCall) Fields(s ...googleapi.Field) *CommentsRemoveContentCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CommentsRemoveContentCall) Context(ctx context.Context) *CommentsRemoveContentCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CommentsRemoveContentCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/posts/{postId}/comments/{commentId}/removecontent")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- "postId": c.postId,
- "commentId": c.commentId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.comments.removeContent" call.
-// Exactly one of *Comment or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Comment.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *CommentsRemoveContentCall) Do() (*Comment, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Comment{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Removes the content of a comment.",
- // "httpMethod": "POST",
- // "id": "blogger.comments.removeContent",
- // "parameterOrder": [
- // "blogId",
- // "postId",
- // "commentId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "The ID of the Blog.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "commentId": {
- // "description": "The ID of the comment to delete content from.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "postId": {
- // "description": "The ID of the Post.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}/removecontent",
- // "response": {
- // "$ref": "Comment"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger"
- // ]
- // }
-
-}
-
-// method id "blogger.pageViews.get":
-
-type PageViewsGetCall struct {
- s *Service
- blogId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieve pageview stats for a Blog.
-func (r *PageViewsService) Get(blogId string) *PageViewsGetCall {
- c := &PageViewsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- return c
-}
-
-// Range sets the optional parameter "range":
-//
-// Possible values:
-// "30DAYS" - Page view counts from the last thirty days.
-// "7DAYS" - Page view counts from the last seven days.
-// "all" - Total page view counts from all time.
-func (c *PageViewsGetCall) Range(range_ string) *PageViewsGetCall {
- c.opt_["range"] = range_
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PageViewsGetCall) Fields(s ...googleapi.Field) *PageViewsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PageViewsGetCall) IfNoneMatch(entityTag string) *PageViewsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PageViewsGetCall) Context(ctx context.Context) *PageViewsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PageViewsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["range"]; ok {
- params.Set("range", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/pageviews")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.pageViews.get" call.
-// Exactly one of *Pageviews or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Pageviews.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *PageViewsGetCall) Do() (*Pageviews, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Pageviews{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieve pageview stats for a Blog.",
- // "httpMethod": "GET",
- // "id": "blogger.pageViews.get",
- // "parameterOrder": [
- // "blogId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "The ID of the blog to get.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "range": {
- // "enum": [
- // "30DAYS",
- // "7DAYS",
- // "all"
- // ],
- // "enumDescriptions": [
- // "Page view counts from the last thirty days.",
- // "Page view counts from the last seven days.",
- // "Total page view counts from all time."
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // }
- // },
- // "path": "blogs/{blogId}/pageviews",
- // "response": {
- // "$ref": "Pageviews"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger"
- // ]
- // }
-
-}
-
-// method id "blogger.pages.delete":
-
-type PagesDeleteCall struct {
- s *Service
- blogId string
- pageId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Delete a page by ID.
-func (r *PagesService) Delete(blogId string, pageId string) *PagesDeleteCall {
- c := &PagesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- c.pageId = pageId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PagesDeleteCall) Fields(s ...googleapi.Field) *PagesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PagesDeleteCall) Context(ctx context.Context) *PagesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PagesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/pages/{pageId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- "pageId": c.pageId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.pages.delete" call.
-func (c *PagesDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Delete a page by ID.",
- // "httpMethod": "DELETE",
- // "id": "blogger.pages.delete",
- // "parameterOrder": [
- // "blogId",
- // "pageId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "The ID of the Blog.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "pageId": {
- // "description": "The ID of the Page.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "blogs/{blogId}/pages/{pageId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger"
- // ]
- // }
-
-}
-
-// method id "blogger.pages.get":
-
-type PagesGetCall struct {
- s *Service
- blogId string
- pageId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one blog page by ID.
-func (r *PagesService) Get(blogId string, pageId string) *PagesGetCall {
- c := &PagesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- c.pageId = pageId
- return c
-}
-
-// View sets the optional parameter "view":
-//
-// Possible values:
-// "ADMIN" - Admin level detail
-// "AUTHOR" - Author level detail
-// "READER" - Reader level detail
-func (c *PagesGetCall) View(view string) *PagesGetCall {
- c.opt_["view"] = view
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PagesGetCall) Fields(s ...googleapi.Field) *PagesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PagesGetCall) IfNoneMatch(entityTag string) *PagesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PagesGetCall) Context(ctx context.Context) *PagesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PagesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["view"]; ok {
- params.Set("view", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/pages/{pageId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- "pageId": c.pageId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.pages.get" call.
-// Exactly one of *Page or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Page.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *PagesGetCall) Do() (*Page, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Page{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one blog page by ID.",
- // "httpMethod": "GET",
- // "id": "blogger.pages.get",
- // "parameterOrder": [
- // "blogId",
- // "pageId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "ID of the blog containing the page.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "pageId": {
- // "description": "The ID of the page to get.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "view": {
- // "enum": [
- // "ADMIN",
- // "AUTHOR",
- // "READER"
- // ],
- // "enumDescriptions": [
- // "Admin level detail",
- // "Author level detail",
- // "Reader level detail"
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "blogs/{blogId}/pages/{pageId}",
- // "response": {
- // "$ref": "Page"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger",
- // "https://www.googleapis.com/auth/blogger.readonly"
- // ]
- // }
-
-}
-
-// method id "blogger.pages.insert":
-
-type PagesInsertCall struct {
- s *Service
- blogId string
- page *Page
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Add a page.
-func (r *PagesService) Insert(blogId string, page *Page) *PagesInsertCall {
- c := &PagesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- c.page = page
- return c
-}
-
-// IsDraft sets the optional parameter "isDraft": Whether to create the
-// page as a draft (default: false).
-func (c *PagesInsertCall) IsDraft(isDraft bool) *PagesInsertCall {
- c.opt_["isDraft"] = isDraft
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PagesInsertCall) Fields(s ...googleapi.Field) *PagesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PagesInsertCall) Context(ctx context.Context) *PagesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PagesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.page)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["isDraft"]; ok {
- params.Set("isDraft", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/pages")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.pages.insert" call.
-// Exactly one of *Page or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Page.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *PagesInsertCall) Do() (*Page, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Page{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Add a page.",
- // "httpMethod": "POST",
- // "id": "blogger.pages.insert",
- // "parameterOrder": [
- // "blogId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "ID of the blog to add the page to.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "isDraft": {
- // "description": "Whether to create the page as a draft (default: false).",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "blogs/{blogId}/pages",
- // "request": {
- // "$ref": "Page"
- // },
- // "response": {
- // "$ref": "Page"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger"
- // ]
- // }
-
-}
-
-// method id "blogger.pages.list":
-
-type PagesListCall struct {
- s *Service
- blogId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the pages for a blog, optionally including non-LIVE
-// statuses.
-func (r *PagesService) List(blogId string) *PagesListCall {
- c := &PagesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- return c
-}
-
-// FetchBodies sets the optional parameter "fetchBodies": Whether to
-// retrieve the Page bodies.
-func (c *PagesListCall) FetchBodies(fetchBodies bool) *PagesListCall {
- c.opt_["fetchBodies"] = fetchBodies
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of Pages to fetch.
-func (c *PagesListCall) MaxResults(maxResults int64) *PagesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Continuation token
-// if the request is paged.
-func (c *PagesListCall) PageToken(pageToken string) *PagesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Status sets the optional parameter "status":
-//
-// Possible values:
-// "draft" - Draft (unpublished) Pages
-// "live" - Pages that are publicly visible
-func (c *PagesListCall) Status(status string) *PagesListCall {
- c.opt_["status"] = status
- return c
-}
-
-// View sets the optional parameter "view": Access level with which to
-// view the returned result. Note that some fields require elevated
-// access.
-//
-// Possible values:
-// "ADMIN" - Admin level detail
-// "AUTHOR" - Author level detail
-// "READER" - Reader level detail
-func (c *PagesListCall) View(view string) *PagesListCall {
- c.opt_["view"] = view
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PagesListCall) Fields(s ...googleapi.Field) *PagesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PagesListCall) IfNoneMatch(entityTag string) *PagesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PagesListCall) Context(ctx context.Context) *PagesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PagesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fetchBodies"]; ok {
- params.Set("fetchBodies", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["status"]; ok {
- params.Set("status", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["view"]; ok {
- params.Set("view", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/pages")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.pages.list" call.
-// Exactly one of *PageList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *PageList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *PagesListCall) Do() (*PageList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PageList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the pages for a blog, optionally including non-LIVE statuses.",
- // "httpMethod": "GET",
- // "id": "blogger.pages.list",
- // "parameterOrder": [
- // "blogId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "ID of the blog to fetch Pages from.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "fetchBodies": {
- // "description": "Whether to retrieve the Page bodies.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "Maximum number of Pages to fetch.",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Continuation token if the request is paged.",
- // "location": "query",
- // "type": "string"
- // },
- // "status": {
- // "enum": [
- // "draft",
- // "live"
- // ],
- // "enumDescriptions": [
- // "Draft (unpublished) Pages",
- // "Pages that are publicly visible"
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "view": {
- // "description": "Access level with which to view the returned result. Note that some fields require elevated access.",
- // "enum": [
- // "ADMIN",
- // "AUTHOR",
- // "READER"
- // ],
- // "enumDescriptions": [
- // "Admin level detail",
- // "Author level detail",
- // "Reader level detail"
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "blogs/{blogId}/pages",
- // "response": {
- // "$ref": "PageList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger",
- // "https://www.googleapis.com/auth/blogger.readonly"
- // ]
- // }
-
-}
-
-// method id "blogger.pages.patch":
-
-type PagesPatchCall struct {
- s *Service
- blogId string
- pageId string
- page *Page
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Update a page. This method supports patch semantics.
-func (r *PagesService) Patch(blogId string, pageId string, page *Page) *PagesPatchCall {
- c := &PagesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- c.pageId = pageId
- c.page = page
- return c
-}
-
-// Publish sets the optional parameter "publish": Whether a publish
-// action should be performed when the page is updated (default: false).
-func (c *PagesPatchCall) Publish(publish bool) *PagesPatchCall {
- c.opt_["publish"] = publish
- return c
-}
-
-// Revert sets the optional parameter "revert": Whether a revert action
-// should be performed when the page is updated (default: false).
-func (c *PagesPatchCall) Revert(revert bool) *PagesPatchCall {
- c.opt_["revert"] = revert
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PagesPatchCall) Fields(s ...googleapi.Field) *PagesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PagesPatchCall) Context(ctx context.Context) *PagesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PagesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.page)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["publish"]; ok {
- params.Set("publish", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["revert"]; ok {
- params.Set("revert", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/pages/{pageId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- "pageId": c.pageId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.pages.patch" call.
-// Exactly one of *Page or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Page.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *PagesPatchCall) Do() (*Page, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Page{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update a page. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "blogger.pages.patch",
- // "parameterOrder": [
- // "blogId",
- // "pageId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "The ID of the Blog.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "pageId": {
- // "description": "The ID of the Page.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "publish": {
- // "description": "Whether a publish action should be performed when the page is updated (default: false).",
- // "location": "query",
- // "type": "boolean"
- // },
- // "revert": {
- // "description": "Whether a revert action should be performed when the page is updated (default: false).",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "blogs/{blogId}/pages/{pageId}",
- // "request": {
- // "$ref": "Page"
- // },
- // "response": {
- // "$ref": "Page"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger"
- // ]
- // }
-
-}
-
-// method id "blogger.pages.publish":
-
-type PagesPublishCall struct {
- s *Service
- blogId string
- pageId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Publish: Publishes a draft page.
-func (r *PagesService) Publish(blogId string, pageId string) *PagesPublishCall {
- c := &PagesPublishCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- c.pageId = pageId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PagesPublishCall) Fields(s ...googleapi.Field) *PagesPublishCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PagesPublishCall) Context(ctx context.Context) *PagesPublishCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PagesPublishCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/pages/{pageId}/publish")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- "pageId": c.pageId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.pages.publish" call.
-// Exactly one of *Page or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Page.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *PagesPublishCall) Do() (*Page, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Page{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Publishes a draft page.",
- // "httpMethod": "POST",
- // "id": "blogger.pages.publish",
- // "parameterOrder": [
- // "blogId",
- // "pageId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "The ID of the blog.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "pageId": {
- // "description": "The ID of the page.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "blogs/{blogId}/pages/{pageId}/publish",
- // "response": {
- // "$ref": "Page"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger"
- // ]
- // }
-
-}
-
-// method id "blogger.pages.revert":
-
-type PagesRevertCall struct {
- s *Service
- blogId string
- pageId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Revert: Revert a published or scheduled page to draft state.
-func (r *PagesService) Revert(blogId string, pageId string) *PagesRevertCall {
- c := &PagesRevertCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- c.pageId = pageId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PagesRevertCall) Fields(s ...googleapi.Field) *PagesRevertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PagesRevertCall) Context(ctx context.Context) *PagesRevertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PagesRevertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/pages/{pageId}/revert")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- "pageId": c.pageId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.pages.revert" call.
-// Exactly one of *Page or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Page.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *PagesRevertCall) Do() (*Page, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Page{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Revert a published or scheduled page to draft state.",
- // "httpMethod": "POST",
- // "id": "blogger.pages.revert",
- // "parameterOrder": [
- // "blogId",
- // "pageId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "The ID of the blog.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "pageId": {
- // "description": "The ID of the page.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "blogs/{blogId}/pages/{pageId}/revert",
- // "response": {
- // "$ref": "Page"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger"
- // ]
- // }
-
-}
-
-// method id "blogger.pages.update":
-
-type PagesUpdateCall struct {
- s *Service
- blogId string
- pageId string
- page *Page
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Update a page.
-func (r *PagesService) Update(blogId string, pageId string, page *Page) *PagesUpdateCall {
- c := &PagesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- c.pageId = pageId
- c.page = page
- return c
-}
-
-// Publish sets the optional parameter "publish": Whether a publish
-// action should be performed when the page is updated (default: false).
-func (c *PagesUpdateCall) Publish(publish bool) *PagesUpdateCall {
- c.opt_["publish"] = publish
- return c
-}
-
-// Revert sets the optional parameter "revert": Whether a revert action
-// should be performed when the page is updated (default: false).
-func (c *PagesUpdateCall) Revert(revert bool) *PagesUpdateCall {
- c.opt_["revert"] = revert
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PagesUpdateCall) Fields(s ...googleapi.Field) *PagesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PagesUpdateCall) Context(ctx context.Context) *PagesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PagesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.page)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["publish"]; ok {
- params.Set("publish", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["revert"]; ok {
- params.Set("revert", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/pages/{pageId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- "pageId": c.pageId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.pages.update" call.
-// Exactly one of *Page or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Page.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *PagesUpdateCall) Do() (*Page, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Page{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update a page.",
- // "httpMethod": "PUT",
- // "id": "blogger.pages.update",
- // "parameterOrder": [
- // "blogId",
- // "pageId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "The ID of the Blog.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "pageId": {
- // "description": "The ID of the Page.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "publish": {
- // "description": "Whether a publish action should be performed when the page is updated (default: false).",
- // "location": "query",
- // "type": "boolean"
- // },
- // "revert": {
- // "description": "Whether a revert action should be performed when the page is updated (default: false).",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "blogs/{blogId}/pages/{pageId}",
- // "request": {
- // "$ref": "Page"
- // },
- // "response": {
- // "$ref": "Page"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger"
- // ]
- // }
-
-}
-
-// method id "blogger.postUserInfos.get":
-
-type PostUserInfosGetCall struct {
- s *Service
- userId string
- blogId string
- postId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one post and user info pair, by post ID and user ID. The
-// post user info contains per-user information about the post, such as
-// access rights, specific to the user.
-func (r *PostUserInfosService) Get(userId string, blogId string, postId string) *PostUserInfosGetCall {
- c := &PostUserInfosGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.userId = userId
- c.blogId = blogId
- c.postId = postId
- return c
-}
-
-// MaxComments sets the optional parameter "maxComments": Maximum number
-// of comments to pull back on a post.
-func (c *PostUserInfosGetCall) MaxComments(maxComments int64) *PostUserInfosGetCall {
- c.opt_["maxComments"] = maxComments
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PostUserInfosGetCall) Fields(s ...googleapi.Field) *PostUserInfosGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PostUserInfosGetCall) IfNoneMatch(entityTag string) *PostUserInfosGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PostUserInfosGetCall) Context(ctx context.Context) *PostUserInfosGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PostUserInfosGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxComments"]; ok {
- params.Set("maxComments", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userId}/blogs/{blogId}/posts/{postId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userId": c.userId,
- "blogId": c.blogId,
- "postId": c.postId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.postUserInfos.get" call.
-// Exactly one of *PostUserInfo or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *PostUserInfo.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *PostUserInfosGetCall) Do() (*PostUserInfo, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PostUserInfo{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one post and user info pair, by post ID and user ID. The post user info contains per-user information about the post, such as access rights, specific to the user.",
- // "httpMethod": "GET",
- // "id": "blogger.postUserInfos.get",
- // "parameterOrder": [
- // "userId",
- // "blogId",
- // "postId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "The ID of the blog.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxComments": {
- // "description": "Maximum number of comments to pull back on a post.",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "postId": {
- // "description": "The ID of the post to get.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userId": {
- // "description": "ID of the user for the per-user information to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userId}/blogs/{blogId}/posts/{postId}",
- // "response": {
- // "$ref": "PostUserInfo"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger",
- // "https://www.googleapis.com/auth/blogger.readonly"
- // ]
- // }
-
-}
-
-// method id "blogger.postUserInfos.list":
-
-type PostUserInfosListCall struct {
- s *Service
- userId string
- blogId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of post and post user info pairs, possibly
-// filtered. The post user info contains per-user information about the
-// post, such as access rights, specific to the user.
-func (r *PostUserInfosService) List(userId string, blogId string) *PostUserInfosListCall {
- c := &PostUserInfosListCall{s: r.s, opt_: make(map[string]interface{})}
- c.userId = userId
- c.blogId = blogId
- return c
-}
-
-// EndDate sets the optional parameter "endDate": Latest post date to
-// fetch, a date-time with RFC 3339 formatting.
-func (c *PostUserInfosListCall) EndDate(endDate string) *PostUserInfosListCall {
- c.opt_["endDate"] = endDate
- return c
-}
-
-// FetchBodies sets the optional parameter "fetchBodies": Whether the
-// body content of posts is included. Default is false.
-func (c *PostUserInfosListCall) FetchBodies(fetchBodies bool) *PostUserInfosListCall {
- c.opt_["fetchBodies"] = fetchBodies
- return c
-}
-
-// Labels sets the optional parameter "labels": Comma-separated list of
-// labels to search for.
-func (c *PostUserInfosListCall) Labels(labels string) *PostUserInfosListCall {
- c.opt_["labels"] = labels
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of posts to fetch.
-func (c *PostUserInfosListCall) MaxResults(maxResults int64) *PostUserInfosListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sort order applied to
-// search results. Default is published.
-//
-// Possible values:
-// "published" - Order by the date the post was published
-// "updated" - Order by the date the post was last updated
-func (c *PostUserInfosListCall) OrderBy(orderBy string) *PostUserInfosListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Continuation token
-// if the request is paged.
-func (c *PostUserInfosListCall) PageToken(pageToken string) *PostUserInfosListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// StartDate sets the optional parameter "startDate": Earliest post date
-// to fetch, a date-time with RFC 3339 formatting.
-func (c *PostUserInfosListCall) StartDate(startDate string) *PostUserInfosListCall {
- c.opt_["startDate"] = startDate
- return c
-}
-
-// Status sets the optional parameter "status":
-//
-// Possible values:
-// "draft" - Draft posts
-// "live" - Published posts
-// "scheduled" - Posts that are scheduled to publish in future.
-func (c *PostUserInfosListCall) Status(status string) *PostUserInfosListCall {
- c.opt_["status"] = status
- return c
-}
-
-// View sets the optional parameter "view": Access level with which to
-// view the returned result. Note that some fields require elevated
-// access.
-//
-// Possible values:
-// "ADMIN" - Admin level detail
-// "AUTHOR" - Author level detail
-// "READER" - Reader level detail
-func (c *PostUserInfosListCall) View(view string) *PostUserInfosListCall {
- c.opt_["view"] = view
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PostUserInfosListCall) Fields(s ...googleapi.Field) *PostUserInfosListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PostUserInfosListCall) IfNoneMatch(entityTag string) *PostUserInfosListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PostUserInfosListCall) Context(ctx context.Context) *PostUserInfosListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PostUserInfosListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["endDate"]; ok {
- params.Set("endDate", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fetchBodies"]; ok {
- params.Set("fetchBodies", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["labels"]; ok {
- params.Set("labels", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startDate"]; ok {
- params.Set("startDate", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["status"]; ok {
- params.Set("status", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["view"]; ok {
- params.Set("view", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userId}/blogs/{blogId}/posts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userId": c.userId,
- "blogId": c.blogId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.postUserInfos.list" call.
-// Exactly one of *PostUserInfosList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *PostUserInfosList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PostUserInfosListCall) Do() (*PostUserInfosList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PostUserInfosList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of post and post user info pairs, possibly filtered. The post user info contains per-user information about the post, such as access rights, specific to the user.",
- // "httpMethod": "GET",
- // "id": "blogger.postUserInfos.list",
- // "parameterOrder": [
- // "userId",
- // "blogId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "ID of the blog to fetch posts from.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "endDate": {
- // "description": "Latest post date to fetch, a date-time with RFC 3339 formatting.",
- // "format": "date-time",
- // "location": "query",
- // "type": "string"
- // },
- // "fetchBodies": {
- // "default": "false",
- // "description": "Whether the body content of posts is included. Default is false.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "labels": {
- // "description": "Comma-separated list of labels to search for.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of posts to fetch.",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "orderBy": {
- // "default": "PUBLISHED",
- // "description": "Sort order applied to search results. Default is published.",
- // "enum": [
- // "published",
- // "updated"
- // ],
- // "enumDescriptions": [
- // "Order by the date the post was published",
- // "Order by the date the post was last updated"
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Continuation token if the request is paged.",
- // "location": "query",
- // "type": "string"
- // },
- // "startDate": {
- // "description": "Earliest post date to fetch, a date-time with RFC 3339 formatting.",
- // "format": "date-time",
- // "location": "query",
- // "type": "string"
- // },
- // "status": {
- // "enum": [
- // "draft",
- // "live",
- // "scheduled"
- // ],
- // "enumDescriptions": [
- // "Draft posts",
- // "Published posts",
- // "Posts that are scheduled to publish in future."
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "userId": {
- // "description": "ID of the user for the per-user information to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "view": {
- // "description": "Access level with which to view the returned result. Note that some fields require elevated access.",
- // "enum": [
- // "ADMIN",
- // "AUTHOR",
- // "READER"
- // ],
- // "enumDescriptions": [
- // "Admin level detail",
- // "Author level detail",
- // "Reader level detail"
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "users/{userId}/blogs/{blogId}/posts",
- // "response": {
- // "$ref": "PostUserInfosList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger",
- // "https://www.googleapis.com/auth/blogger.readonly"
- // ]
- // }
-
-}
-
-// method id "blogger.posts.delete":
-
-type PostsDeleteCall struct {
- s *Service
- blogId string
- postId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Delete a post by ID.
-func (r *PostsService) Delete(blogId string, postId string) *PostsDeleteCall {
- c := &PostsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- c.postId = postId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PostsDeleteCall) Fields(s ...googleapi.Field) *PostsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PostsDeleteCall) Context(ctx context.Context) *PostsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PostsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/posts/{postId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- "postId": c.postId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.posts.delete" call.
-func (c *PostsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Delete a post by ID.",
- // "httpMethod": "DELETE",
- // "id": "blogger.posts.delete",
- // "parameterOrder": [
- // "blogId",
- // "postId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "The ID of the Blog.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "postId": {
- // "description": "The ID of the Post.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "blogs/{blogId}/posts/{postId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger"
- // ]
- // }
-
-}
-
-// method id "blogger.posts.get":
-
-type PostsGetCall struct {
- s *Service
- blogId string
- postId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Get a post by ID.
-func (r *PostsService) Get(blogId string, postId string) *PostsGetCall {
- c := &PostsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- c.postId = postId
- return c
-}
-
-// FetchBody sets the optional parameter "fetchBody": Whether the body
-// content of the post is included (default: true). This should be set
-// to false when the post bodies are not required, to help minimize
-// traffic.
-func (c *PostsGetCall) FetchBody(fetchBody bool) *PostsGetCall {
- c.opt_["fetchBody"] = fetchBody
- return c
-}
-
-// FetchImages sets the optional parameter "fetchImages": Whether image
-// URL metadata for each post is included (default: false).
-func (c *PostsGetCall) FetchImages(fetchImages bool) *PostsGetCall {
- c.opt_["fetchImages"] = fetchImages
- return c
-}
-
-// MaxComments sets the optional parameter "maxComments": Maximum number
-// of comments to pull back on a post.
-func (c *PostsGetCall) MaxComments(maxComments int64) *PostsGetCall {
- c.opt_["maxComments"] = maxComments
- return c
-}
-
-// View sets the optional parameter "view": Access level with which to
-// view the returned result. Note that some fields require elevated
-// access.
-//
-// Possible values:
-// "ADMIN" - Admin level detail
-// "AUTHOR" - Author level detail
-// "READER" - Reader level detail
-func (c *PostsGetCall) View(view string) *PostsGetCall {
- c.opt_["view"] = view
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PostsGetCall) Fields(s ...googleapi.Field) *PostsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PostsGetCall) IfNoneMatch(entityTag string) *PostsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PostsGetCall) Context(ctx context.Context) *PostsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PostsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fetchBody"]; ok {
- params.Set("fetchBody", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fetchImages"]; ok {
- params.Set("fetchImages", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxComments"]; ok {
- params.Set("maxComments", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["view"]; ok {
- params.Set("view", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/posts/{postId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- "postId": c.postId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.posts.get" call.
-// Exactly one of *Post or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Post.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *PostsGetCall) Do() (*Post, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Post{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Get a post by ID.",
- // "httpMethod": "GET",
- // "id": "blogger.posts.get",
- // "parameterOrder": [
- // "blogId",
- // "postId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "ID of the blog to fetch the post from.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "fetchBody": {
- // "default": "true",
- // "description": "Whether the body content of the post is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "fetchImages": {
- // "description": "Whether image URL metadata for each post is included (default: false).",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxComments": {
- // "description": "Maximum number of comments to pull back on a post.",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "postId": {
- // "description": "The ID of the post",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "view": {
- // "description": "Access level with which to view the returned result. Note that some fields require elevated access.",
- // "enum": [
- // "ADMIN",
- // "AUTHOR",
- // "READER"
- // ],
- // "enumDescriptions": [
- // "Admin level detail",
- // "Author level detail",
- // "Reader level detail"
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "blogs/{blogId}/posts/{postId}",
- // "response": {
- // "$ref": "Post"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger",
- // "https://www.googleapis.com/auth/blogger.readonly"
- // ]
- // }
-
-}
-
-// method id "blogger.posts.getByPath":
-
-type PostsGetByPathCall struct {
- s *Service
- blogId string
- path string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetByPath: Retrieve a Post by Path.
-func (r *PostsService) GetByPath(blogId string, path string) *PostsGetByPathCall {
- c := &PostsGetByPathCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- c.path = path
- return c
-}
-
-// MaxComments sets the optional parameter "maxComments": Maximum number
-// of comments to pull back on a post.
-func (c *PostsGetByPathCall) MaxComments(maxComments int64) *PostsGetByPathCall {
- c.opt_["maxComments"] = maxComments
- return c
-}
-
-// View sets the optional parameter "view": Access level with which to
-// view the returned result. Note that some fields require elevated
-// access.
-//
-// Possible values:
-// "ADMIN" - Admin level detail
-// "AUTHOR" - Author level detail
-// "READER" - Reader level detail
-func (c *PostsGetByPathCall) View(view string) *PostsGetByPathCall {
- c.opt_["view"] = view
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PostsGetByPathCall) Fields(s ...googleapi.Field) *PostsGetByPathCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PostsGetByPathCall) IfNoneMatch(entityTag string) *PostsGetByPathCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PostsGetByPathCall) Context(ctx context.Context) *PostsGetByPathCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PostsGetByPathCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("path", fmt.Sprintf("%v", c.path))
- if v, ok := c.opt_["maxComments"]; ok {
- params.Set("maxComments", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["view"]; ok {
- params.Set("view", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/posts/bypath")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.posts.getByPath" call.
-// Exactly one of *Post or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Post.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *PostsGetByPathCall) Do() (*Post, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Post{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieve a Post by Path.",
- // "httpMethod": "GET",
- // "id": "blogger.posts.getByPath",
- // "parameterOrder": [
- // "blogId",
- // "path"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "ID of the blog to fetch the post from.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxComments": {
- // "description": "Maximum number of comments to pull back on a post.",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "path": {
- // "description": "Path of the Post to retrieve.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "view": {
- // "description": "Access level with which to view the returned result. Note that some fields require elevated access.",
- // "enum": [
- // "ADMIN",
- // "AUTHOR",
- // "READER"
- // ],
- // "enumDescriptions": [
- // "Admin level detail",
- // "Author level detail",
- // "Reader level detail"
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "blogs/{blogId}/posts/bypath",
- // "response": {
- // "$ref": "Post"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger",
- // "https://www.googleapis.com/auth/blogger.readonly"
- // ]
- // }
-
-}
-
-// method id "blogger.posts.insert":
-
-type PostsInsertCall struct {
- s *Service
- blogId string
- post *Post
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Add a post.
-func (r *PostsService) Insert(blogId string, post *Post) *PostsInsertCall {
- c := &PostsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- c.post = post
- return c
-}
-
-// FetchBody sets the optional parameter "fetchBody": Whether the body
-// content of the post is included with the result (default: true).
-func (c *PostsInsertCall) FetchBody(fetchBody bool) *PostsInsertCall {
- c.opt_["fetchBody"] = fetchBody
- return c
-}
-
-// FetchImages sets the optional parameter "fetchImages": Whether image
-// URL metadata for each post is included in the returned result
-// (default: false).
-func (c *PostsInsertCall) FetchImages(fetchImages bool) *PostsInsertCall {
- c.opt_["fetchImages"] = fetchImages
- return c
-}
-
-// IsDraft sets the optional parameter "isDraft": Whether to create the
-// post as a draft (default: false).
-func (c *PostsInsertCall) IsDraft(isDraft bool) *PostsInsertCall {
- c.opt_["isDraft"] = isDraft
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PostsInsertCall) Fields(s ...googleapi.Field) *PostsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PostsInsertCall) Context(ctx context.Context) *PostsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PostsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.post)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fetchBody"]; ok {
- params.Set("fetchBody", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fetchImages"]; ok {
- params.Set("fetchImages", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["isDraft"]; ok {
- params.Set("isDraft", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/posts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.posts.insert" call.
-// Exactly one of *Post or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Post.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *PostsInsertCall) Do() (*Post, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Post{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Add a post.",
- // "httpMethod": "POST",
- // "id": "blogger.posts.insert",
- // "parameterOrder": [
- // "blogId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "ID of the blog to add the post to.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "fetchBody": {
- // "default": "true",
- // "description": "Whether the body content of the post is included with the result (default: true).",
- // "location": "query",
- // "type": "boolean"
- // },
- // "fetchImages": {
- // "description": "Whether image URL metadata for each post is included in the returned result (default: false).",
- // "location": "query",
- // "type": "boolean"
- // },
- // "isDraft": {
- // "description": "Whether to create the post as a draft (default: false).",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "blogs/{blogId}/posts",
- // "request": {
- // "$ref": "Post"
- // },
- // "response": {
- // "$ref": "Post"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger"
- // ]
- // }
-
-}
-
-// method id "blogger.posts.list":
-
-type PostsListCall struct {
- s *Service
- blogId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of posts, possibly filtered.
-func (r *PostsService) List(blogId string) *PostsListCall {
- c := &PostsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- return c
-}
-
-// EndDate sets the optional parameter "endDate": Latest post date to
-// fetch, a date-time with RFC 3339 formatting.
-func (c *PostsListCall) EndDate(endDate string) *PostsListCall {
- c.opt_["endDate"] = endDate
- return c
-}
-
-// FetchBodies sets the optional parameter "fetchBodies": Whether the
-// body content of posts is included (default: true). This should be set
-// to false when the post bodies are not required, to help minimize
-// traffic.
-func (c *PostsListCall) FetchBodies(fetchBodies bool) *PostsListCall {
- c.opt_["fetchBodies"] = fetchBodies
- return c
-}
-
-// FetchImages sets the optional parameter "fetchImages": Whether image
-// URL metadata for each post is included.
-func (c *PostsListCall) FetchImages(fetchImages bool) *PostsListCall {
- c.opt_["fetchImages"] = fetchImages
- return c
-}
-
-// Labels sets the optional parameter "labels": Comma-separated list of
-// labels to search for.
-func (c *PostsListCall) Labels(labels string) *PostsListCall {
- c.opt_["labels"] = labels
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of posts to fetch.
-func (c *PostsListCall) MaxResults(maxResults int64) *PostsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sort search results
-//
-// Possible values:
-// "published" - Order by the date the post was published
-// "updated" - Order by the date the post was last updated
-func (c *PostsListCall) OrderBy(orderBy string) *PostsListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Continuation token
-// if the request is paged.
-func (c *PostsListCall) PageToken(pageToken string) *PostsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// StartDate sets the optional parameter "startDate": Earliest post date
-// to fetch, a date-time with RFC 3339 formatting.
-func (c *PostsListCall) StartDate(startDate string) *PostsListCall {
- c.opt_["startDate"] = startDate
- return c
-}
-
-// Status sets the optional parameter "status": Statuses to include in
-// the results.
-//
-// Possible values:
-// "draft" - Draft (non-published) posts.
-// "live" - Published posts
-// "scheduled" - Posts that are scheduled to publish in the future.
-func (c *PostsListCall) Status(status string) *PostsListCall {
- c.opt_["status"] = status
- return c
-}
-
-// View sets the optional parameter "view": Access level with which to
-// view the returned result. Note that some fields require escalated
-// access.
-//
-// Possible values:
-// "ADMIN" - Admin level detail
-// "AUTHOR" - Author level detail
-// "READER" - Reader level detail
-func (c *PostsListCall) View(view string) *PostsListCall {
- c.opt_["view"] = view
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PostsListCall) Fields(s ...googleapi.Field) *PostsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PostsListCall) IfNoneMatch(entityTag string) *PostsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PostsListCall) Context(ctx context.Context) *PostsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PostsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["endDate"]; ok {
- params.Set("endDate", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fetchBodies"]; ok {
- params.Set("fetchBodies", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fetchImages"]; ok {
- params.Set("fetchImages", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["labels"]; ok {
- params.Set("labels", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startDate"]; ok {
- params.Set("startDate", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["status"]; ok {
- params.Set("status", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["view"]; ok {
- params.Set("view", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/posts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.posts.list" call.
-// Exactly one of *PostList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *PostList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *PostsListCall) Do() (*PostList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PostList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of posts, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "blogger.posts.list",
- // "parameterOrder": [
- // "blogId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "ID of the blog to fetch posts from.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "endDate": {
- // "description": "Latest post date to fetch, a date-time with RFC 3339 formatting.",
- // "format": "date-time",
- // "location": "query",
- // "type": "string"
- // },
- // "fetchBodies": {
- // "default": "true",
- // "description": "Whether the body content of posts is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "fetchImages": {
- // "description": "Whether image URL metadata for each post is included.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "labels": {
- // "description": "Comma-separated list of labels to search for.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of posts to fetch.",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "orderBy": {
- // "default": "PUBLISHED",
- // "description": "Sort search results",
- // "enum": [
- // "published",
- // "updated"
- // ],
- // "enumDescriptions": [
- // "Order by the date the post was published",
- // "Order by the date the post was last updated"
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Continuation token if the request is paged.",
- // "location": "query",
- // "type": "string"
- // },
- // "startDate": {
- // "description": "Earliest post date to fetch, a date-time with RFC 3339 formatting.",
- // "format": "date-time",
- // "location": "query",
- // "type": "string"
- // },
- // "status": {
- // "description": "Statuses to include in the results.",
- // "enum": [
- // "draft",
- // "live",
- // "scheduled"
- // ],
- // "enumDescriptions": [
- // "Draft (non-published) posts.",
- // "Published posts",
- // "Posts that are scheduled to publish in the future."
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "view": {
- // "description": "Access level with which to view the returned result. Note that some fields require escalated access.",
- // "enum": [
- // "ADMIN",
- // "AUTHOR",
- // "READER"
- // ],
- // "enumDescriptions": [
- // "Admin level detail",
- // "Author level detail",
- // "Reader level detail"
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "blogs/{blogId}/posts",
- // "response": {
- // "$ref": "PostList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger",
- // "https://www.googleapis.com/auth/blogger.readonly"
- // ]
- // }
-
-}
-
-// method id "blogger.posts.patch":
-
-type PostsPatchCall struct {
- s *Service
- blogId string
- postId string
- post *Post
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Update a post. This method supports patch semantics.
-func (r *PostsService) Patch(blogId string, postId string, post *Post) *PostsPatchCall {
- c := &PostsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- c.postId = postId
- c.post = post
- return c
-}
-
-// FetchBody sets the optional parameter "fetchBody": Whether the body
-// content of the post is included with the result (default: true).
-func (c *PostsPatchCall) FetchBody(fetchBody bool) *PostsPatchCall {
- c.opt_["fetchBody"] = fetchBody
- return c
-}
-
-// FetchImages sets the optional parameter "fetchImages": Whether image
-// URL metadata for each post is included in the returned result
-// (default: false).
-func (c *PostsPatchCall) FetchImages(fetchImages bool) *PostsPatchCall {
- c.opt_["fetchImages"] = fetchImages
- return c
-}
-
-// MaxComments sets the optional parameter "maxComments": Maximum number
-// of comments to retrieve with the returned post.
-func (c *PostsPatchCall) MaxComments(maxComments int64) *PostsPatchCall {
- c.opt_["maxComments"] = maxComments
- return c
-}
-
-// Publish sets the optional parameter "publish": Whether a publish
-// action should be performed when the post is updated (default: false).
-func (c *PostsPatchCall) Publish(publish bool) *PostsPatchCall {
- c.opt_["publish"] = publish
- return c
-}
-
-// Revert sets the optional parameter "revert": Whether a revert action
-// should be performed when the post is updated (default: false).
-func (c *PostsPatchCall) Revert(revert bool) *PostsPatchCall {
- c.opt_["revert"] = revert
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PostsPatchCall) Fields(s ...googleapi.Field) *PostsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PostsPatchCall) Context(ctx context.Context) *PostsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PostsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.post)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fetchBody"]; ok {
- params.Set("fetchBody", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fetchImages"]; ok {
- params.Set("fetchImages", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxComments"]; ok {
- params.Set("maxComments", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["publish"]; ok {
- params.Set("publish", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["revert"]; ok {
- params.Set("revert", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/posts/{postId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- "postId": c.postId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.posts.patch" call.
-// Exactly one of *Post or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Post.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *PostsPatchCall) Do() (*Post, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Post{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update a post. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "blogger.posts.patch",
- // "parameterOrder": [
- // "blogId",
- // "postId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "The ID of the Blog.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "fetchBody": {
- // "default": "true",
- // "description": "Whether the body content of the post is included with the result (default: true).",
- // "location": "query",
- // "type": "boolean"
- // },
- // "fetchImages": {
- // "description": "Whether image URL metadata for each post is included in the returned result (default: false).",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxComments": {
- // "description": "Maximum number of comments to retrieve with the returned post.",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "postId": {
- // "description": "The ID of the Post.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "publish": {
- // "description": "Whether a publish action should be performed when the post is updated (default: false).",
- // "location": "query",
- // "type": "boolean"
- // },
- // "revert": {
- // "description": "Whether a revert action should be performed when the post is updated (default: false).",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "blogs/{blogId}/posts/{postId}",
- // "request": {
- // "$ref": "Post"
- // },
- // "response": {
- // "$ref": "Post"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger"
- // ]
- // }
-
-}
-
-// method id "blogger.posts.publish":
-
-type PostsPublishCall struct {
- s *Service
- blogId string
- postId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Publish: Publishes a draft post, optionally at the specific time of
-// the given publishDate parameter.
-func (r *PostsService) Publish(blogId string, postId string) *PostsPublishCall {
- c := &PostsPublishCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- c.postId = postId
- return c
-}
-
-// PublishDate sets the optional parameter "publishDate": Optional date
-// and time to schedule the publishing of the Blog. If no publishDate
-// parameter is given, the post is either published at the a previously
-// saved schedule date (if present), or the current time. If a future
-// date is given, the post will be scheduled to be published.
-func (c *PostsPublishCall) PublishDate(publishDate string) *PostsPublishCall {
- c.opt_["publishDate"] = publishDate
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PostsPublishCall) Fields(s ...googleapi.Field) *PostsPublishCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PostsPublishCall) Context(ctx context.Context) *PostsPublishCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PostsPublishCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["publishDate"]; ok {
- params.Set("publishDate", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/posts/{postId}/publish")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- "postId": c.postId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.posts.publish" call.
-// Exactly one of *Post or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Post.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *PostsPublishCall) Do() (*Post, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Post{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Publishes a draft post, optionally at the specific time of the given publishDate parameter.",
- // "httpMethod": "POST",
- // "id": "blogger.posts.publish",
- // "parameterOrder": [
- // "blogId",
- // "postId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "The ID of the Blog.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "postId": {
- // "description": "The ID of the Post.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "publishDate": {
- // "description": "Optional date and time to schedule the publishing of the Blog. If no publishDate parameter is given, the post is either published at the a previously saved schedule date (if present), or the current time. If a future date is given, the post will be scheduled to be published.",
- // "format": "date-time",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "blogs/{blogId}/posts/{postId}/publish",
- // "response": {
- // "$ref": "Post"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger"
- // ]
- // }
-
-}
-
-// method id "blogger.posts.revert":
-
-type PostsRevertCall struct {
- s *Service
- blogId string
- postId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Revert: Revert a published or scheduled post to draft state.
-func (r *PostsService) Revert(blogId string, postId string) *PostsRevertCall {
- c := &PostsRevertCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- c.postId = postId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PostsRevertCall) Fields(s ...googleapi.Field) *PostsRevertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PostsRevertCall) Context(ctx context.Context) *PostsRevertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PostsRevertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/posts/{postId}/revert")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- "postId": c.postId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.posts.revert" call.
-// Exactly one of *Post or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Post.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *PostsRevertCall) Do() (*Post, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Post{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Revert a published or scheduled post to draft state.",
- // "httpMethod": "POST",
- // "id": "blogger.posts.revert",
- // "parameterOrder": [
- // "blogId",
- // "postId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "The ID of the Blog.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "postId": {
- // "description": "The ID of the Post.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "blogs/{blogId}/posts/{postId}/revert",
- // "response": {
- // "$ref": "Post"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger"
- // ]
- // }
-
-}
-
-// method id "blogger.posts.search":
-
-type PostsSearchCall struct {
- s *Service
- blogId string
- q string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Search: Search for a post.
-func (r *PostsService) Search(blogId string, q string) *PostsSearchCall {
- c := &PostsSearchCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- c.q = q
- return c
-}
-
-// FetchBodies sets the optional parameter "fetchBodies": Whether the
-// body content of posts is included (default: true). This should be set
-// to false when the post bodies are not required, to help minimize
-// traffic.
-func (c *PostsSearchCall) FetchBodies(fetchBodies bool) *PostsSearchCall {
- c.opt_["fetchBodies"] = fetchBodies
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sort search results
-//
-// Possible values:
-// "published" - Order by the date the post was published
-// "updated" - Order by the date the post was last updated
-func (c *PostsSearchCall) OrderBy(orderBy string) *PostsSearchCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PostsSearchCall) Fields(s ...googleapi.Field) *PostsSearchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PostsSearchCall) IfNoneMatch(entityTag string) *PostsSearchCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PostsSearchCall) Context(ctx context.Context) *PostsSearchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PostsSearchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("q", fmt.Sprintf("%v", c.q))
- if v, ok := c.opt_["fetchBodies"]; ok {
- params.Set("fetchBodies", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/posts/search")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.posts.search" call.
-// Exactly one of *PostList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *PostList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *PostsSearchCall) Do() (*PostList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PostList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Search for a post.",
- // "httpMethod": "GET",
- // "id": "blogger.posts.search",
- // "parameterOrder": [
- // "blogId",
- // "q"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "ID of the blog to fetch the post from.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "fetchBodies": {
- // "default": "true",
- // "description": "Whether the body content of posts is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "orderBy": {
- // "default": "PUBLISHED",
- // "description": "Sort search results",
- // "enum": [
- // "published",
- // "updated"
- // ],
- // "enumDescriptions": [
- // "Order by the date the post was published",
- // "Order by the date the post was last updated"
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "q": {
- // "description": "Query terms to search this blog for matching posts.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "blogs/{blogId}/posts/search",
- // "response": {
- // "$ref": "PostList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger",
- // "https://www.googleapis.com/auth/blogger.readonly"
- // ]
- // }
-
-}
-
-// method id "blogger.posts.update":
-
-type PostsUpdateCall struct {
- s *Service
- blogId string
- postId string
- post *Post
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Update a post.
-func (r *PostsService) Update(blogId string, postId string, post *Post) *PostsUpdateCall {
- c := &PostsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.blogId = blogId
- c.postId = postId
- c.post = post
- return c
-}
-
-// FetchBody sets the optional parameter "fetchBody": Whether the body
-// content of the post is included with the result (default: true).
-func (c *PostsUpdateCall) FetchBody(fetchBody bool) *PostsUpdateCall {
- c.opt_["fetchBody"] = fetchBody
- return c
-}
-
-// FetchImages sets the optional parameter "fetchImages": Whether image
-// URL metadata for each post is included in the returned result
-// (default: false).
-func (c *PostsUpdateCall) FetchImages(fetchImages bool) *PostsUpdateCall {
- c.opt_["fetchImages"] = fetchImages
- return c
-}
-
-// MaxComments sets the optional parameter "maxComments": Maximum number
-// of comments to retrieve with the returned post.
-func (c *PostsUpdateCall) MaxComments(maxComments int64) *PostsUpdateCall {
- c.opt_["maxComments"] = maxComments
- return c
-}
-
-// Publish sets the optional parameter "publish": Whether a publish
-// action should be performed when the post is updated (default: false).
-func (c *PostsUpdateCall) Publish(publish bool) *PostsUpdateCall {
- c.opt_["publish"] = publish
- return c
-}
-
-// Revert sets the optional parameter "revert": Whether a revert action
-// should be performed when the post is updated (default: false).
-func (c *PostsUpdateCall) Revert(revert bool) *PostsUpdateCall {
- c.opt_["revert"] = revert
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PostsUpdateCall) Fields(s ...googleapi.Field) *PostsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PostsUpdateCall) Context(ctx context.Context) *PostsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PostsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.post)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fetchBody"]; ok {
- params.Set("fetchBody", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fetchImages"]; ok {
- params.Set("fetchImages", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxComments"]; ok {
- params.Set("maxComments", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["publish"]; ok {
- params.Set("publish", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["revert"]; ok {
- params.Set("revert", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "blogs/{blogId}/posts/{postId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "blogId": c.blogId,
- "postId": c.postId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.posts.update" call.
-// Exactly one of *Post or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Post.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *PostsUpdateCall) Do() (*Post, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Post{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update a post.",
- // "httpMethod": "PUT",
- // "id": "blogger.posts.update",
- // "parameterOrder": [
- // "blogId",
- // "postId"
- // ],
- // "parameters": {
- // "blogId": {
- // "description": "The ID of the Blog.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "fetchBody": {
- // "default": "true",
- // "description": "Whether the body content of the post is included with the result (default: true).",
- // "location": "query",
- // "type": "boolean"
- // },
- // "fetchImages": {
- // "description": "Whether image URL metadata for each post is included in the returned result (default: false).",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxComments": {
- // "description": "Maximum number of comments to retrieve with the returned post.",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "postId": {
- // "description": "The ID of the Post.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "publish": {
- // "description": "Whether a publish action should be performed when the post is updated (default: false).",
- // "location": "query",
- // "type": "boolean"
- // },
- // "revert": {
- // "description": "Whether a revert action should be performed when the post is updated (default: false).",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "blogs/{blogId}/posts/{postId}",
- // "request": {
- // "$ref": "Post"
- // },
- // "response": {
- // "$ref": "Post"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger"
- // ]
- // }
-
-}
-
-// method id "blogger.users.get":
-
-type UsersGetCall struct {
- s *Service
- userId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one user by ID.
-func (r *UsersService) Get(userId string) *UsersGetCall {
- c := &UsersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.userId = userId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersGetCall) Fields(s ...googleapi.Field) *UsersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UsersGetCall) IfNoneMatch(entityTag string) *UsersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersGetCall) Context(ctx context.Context) *UsersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userId": c.userId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "blogger.users.get" call.
-// Exactly one of *User or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *User.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *UsersGetCall) Do() (*User, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &User{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one user by ID.",
- // "httpMethod": "GET",
- // "id": "blogger.users.get",
- // "parameterOrder": [
- // "userId"
- // ],
- // "parameters": {
- // "userId": {
- // "description": "The ID of the user to get.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userId}",
- // "response": {
- // "$ref": "User"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/blogger",
- // "https://www.googleapis.com/auth/blogger.readonly"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/books/v1/books-api.json b/vendor/google.golang.org/api/books/v1/books-api.json
deleted file mode 100644
index ca354312..00000000
--- a/vendor/google.golang.org/api/books/v1/books-api.json
+++ /dev/null
@@ -1,4293 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/NfC6HUSyutjMUJzqUOocETnJU2I\"",
- "discoveryVersion": "v1",
- "id": "books:v1",
- "name": "books",
- "version": "v1",
- "revision": "20150921",
- "title": "Books API",
- "description": "Lets you search for books and manage your Google Books library.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/ebooks-16.png",
- "x32": "https://www.google.com/images/icons/product/ebooks-32.png"
- },
- "documentationLink": "https://developers.google.com/books/docs/v1/getting_started",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/books/v1/",
- "basePath": "/books/v1/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "books/v1/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/books": {
- "description": "Manage your books"
- }
- }
- }
- },
- "schemas": {
- "Annotation": {
- "id": "Annotation",
- "type": "object",
- "properties": {
- "afterSelectedText": {
- "type": "string",
- "description": "Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty."
- },
- "beforeSelectedText": {
- "type": "string",
- "description": "Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty."
- },
- "clientVersionRanges": {
- "type": "object",
- "description": "Selection ranges sent from the client.",
- "properties": {
- "cfiRange": {
- "$ref": "BooksAnnotationsRange",
- "description": "Range in CFI format for this annotation sent by client."
- },
- "contentVersion": {
- "type": "string",
- "description": "Content version the client sent in."
- },
- "gbImageRange": {
- "$ref": "BooksAnnotationsRange",
- "description": "Range in GB image format for this annotation sent by client."
- },
- "gbTextRange": {
- "$ref": "BooksAnnotationsRange",
- "description": "Range in GB text format for this annotation sent by client."
- },
- "imageCfiRange": {
- "$ref": "BooksAnnotationsRange",
- "description": "Range in image CFI format for this annotation sent by client."
- }
- }
- },
- "created": {
- "type": "string",
- "description": "Timestamp for the created time of this annotation.",
- "format": "date-time"
- },
- "currentVersionRanges": {
- "type": "object",
- "description": "Selection ranges for the most recent content version.",
- "properties": {
- "cfiRange": {
- "$ref": "BooksAnnotationsRange",
- "description": "Range in CFI format for this annotation for version above."
- },
- "contentVersion": {
- "type": "string",
- "description": "Content version applicable to ranges below."
- },
- "gbImageRange": {
- "$ref": "BooksAnnotationsRange",
- "description": "Range in GB image format for this annotation for version above."
- },
- "gbTextRange": {
- "$ref": "BooksAnnotationsRange",
- "description": "Range in GB text format for this annotation for version above."
- },
- "imageCfiRange": {
- "$ref": "BooksAnnotationsRange",
- "description": "Range in image CFI format for this annotation for version above."
- }
- }
- },
- "data": {
- "type": "string",
- "description": "User-created data for this annotation."
- },
- "deleted": {
- "type": "boolean",
- "description": "Indicates that this annotation is deleted."
- },
- "highlightStyle": {
- "type": "string",
- "description": "The highlight style for this annotation."
- },
- "id": {
- "type": "string",
- "description": "Id of this annotation, in the form of a GUID."
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "books#annotation"
- },
- "layerId": {
- "type": "string",
- "description": "The layer this annotation is for."
- },
- "layerSummary": {
- "type": "object",
- "properties": {
- "allowedCharacterCount": {
- "type": "integer",
- "description": "Maximum allowed characters on this layer, especially for the \"copy\" layer.",
- "format": "int32"
- },
- "limitType": {
- "type": "string",
- "description": "Type of limitation on this layer. \"limited\" or \"unlimited\" for the \"copy\" layer."
- },
- "remainingCharacterCount": {
- "type": "integer",
- "description": "Remaining allowed characters on this layer, especially for the \"copy\" layer.",
- "format": "int32"
- }
- }
- },
- "pageIds": {
- "type": "array",
- "description": "Pages that this annotation spans.",
- "items": {
- "type": "string"
- }
- },
- "selectedText": {
- "type": "string",
- "description": "Excerpt from the volume."
- },
- "selfLink": {
- "type": "string",
- "description": "URL to this resource."
- },
- "updated": {
- "type": "string",
- "description": "Timestamp for the last time this annotation was modified.",
- "format": "date-time"
- },
- "volumeId": {
- "type": "string",
- "description": "The volume that this annotation belongs to."
- }
- }
- },
- "Annotationdata": {
- "id": "Annotationdata",
- "type": "object",
- "properties": {
- "annotationType": {
- "type": "string",
- "description": "The type of annotation this data is for."
- },
- "data": {
- "type": "any"
- },
- "encoded_data": {
- "type": "string",
- "description": "Base64 encoded data for this annotation data.",
- "format": "byte"
- },
- "id": {
- "type": "string",
- "description": "Unique id for this annotation data."
- },
- "kind": {
- "type": "string",
- "description": "Resource Type",
- "default": "books#annotationdata"
- },
- "layerId": {
- "type": "string",
- "description": "The Layer id for this data. *"
- },
- "selfLink": {
- "type": "string",
- "description": "URL for this resource. *"
- },
- "updated": {
- "type": "string",
- "description": "Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format).",
- "format": "date-time"
- },
- "volumeId": {
- "type": "string",
- "description": "The volume id for this data. *"
- }
- }
- },
- "Annotations": {
- "id": "Annotations",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of annotations.",
- "items": {
- "$ref": "Annotation"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "books#annotations"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token to pass in for pagination for the next page. This will not be present if this request does not have more results."
- },
- "totalItems": {
- "type": "integer",
- "description": "Total number of annotations found. This may be greater than the number of notes returned in this response if results have been paginated.",
- "format": "int32"
- }
- }
- },
- "AnnotationsSummary": {
- "id": "AnnotationsSummary",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "default": "books#annotationsSummary"
- },
- "layers": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "allowedCharacterCount": {
- "type": "integer",
- "format": "int32"
- },
- "layerId": {
- "type": "string"
- },
- "limitType": {
- "type": "string"
- },
- "remainingCharacterCount": {
- "type": "integer",
- "format": "int32"
- },
- "updated": {
- "type": "string",
- "format": "date-time"
- }
- }
- }
- }
- }
- },
- "Annotationsdata": {
- "id": "Annotationsdata",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of Annotation Data.",
- "items": {
- "$ref": "Annotationdata"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type",
- "default": "books#annotationsdata"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token to pass in for pagination for the next page. This will not be present if this request does not have more results."
- },
- "totalItems": {
- "type": "integer",
- "description": "The total number of volume annotations found.",
- "format": "int32"
- }
- }
- },
- "BooksAnnotationsRange": {
- "id": "BooksAnnotationsRange",
- "type": "object",
- "properties": {
- "endOffset": {
- "type": "string",
- "description": "The offset from the ending position."
- },
- "endPosition": {
- "type": "string",
- "description": "The ending position for the range."
- },
- "startOffset": {
- "type": "string",
- "description": "The offset from the starting position."
- },
- "startPosition": {
- "type": "string",
- "description": "The starting position for the range."
- }
- }
- },
- "BooksCloudloadingResource": {
- "id": "BooksCloudloadingResource",
- "type": "object",
- "properties": {
- "author": {
- "type": "string"
- },
- "processingState": {
- "type": "string"
- },
- "title": {
- "type": "string"
- },
- "volumeId": {
- "type": "string"
- }
- }
- },
- "BooksVolumesRecommendedRateResponse": {
- "id": "BooksVolumesRecommendedRateResponse",
- "type": "object",
- "properties": {
- "consistency_token": {
- "type": "string"
- }
- }
- },
- "Bookshelf": {
- "id": "Bookshelf",
- "type": "object",
- "properties": {
- "access": {
- "type": "string",
- "description": "Whether this bookshelf is PUBLIC or PRIVATE."
- },
- "created": {
- "type": "string",
- "description": "Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).",
- "format": "date-time"
- },
- "description": {
- "type": "string",
- "description": "Description of this bookshelf."
- },
- "id": {
- "type": "integer",
- "description": "Id of this bookshelf, only unique by user.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Resource type for bookshelf metadata.",
- "default": "books#bookshelf"
- },
- "selfLink": {
- "type": "string",
- "description": "URL to this resource."
- },
- "title": {
- "type": "string",
- "description": "Title of this bookshelf."
- },
- "updated": {
- "type": "string",
- "description": "Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).",
- "format": "date-time"
- },
- "volumeCount": {
- "type": "integer",
- "description": "Number of volumes in this bookshelf.",
- "format": "int32"
- },
- "volumesLastUpdated": {
- "type": "string",
- "description": "Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).",
- "format": "date-time"
- }
- }
- },
- "Bookshelves": {
- "id": "Bookshelves",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of bookshelves.",
- "items": {
- "$ref": "Bookshelf"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "books#bookshelves"
- }
- }
- },
- "Category": {
- "id": "Category",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of onboarding categories.",
- "items": {
- "type": "object",
- "properties": {
- "badgeUrl": {
- "type": "string"
- },
- "categoryId": {
- "type": "string"
- },
- "name": {
- "type": "string"
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "onboarding#category"
- }
- }
- },
- "ConcurrentAccessRestriction": {
- "id": "ConcurrentAccessRestriction",
- "type": "object",
- "properties": {
- "deviceAllowed": {
- "type": "boolean",
- "description": "Whether access is granted for this (user, device, volume)."
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "books#concurrentAccessRestriction"
- },
- "maxConcurrentDevices": {
- "type": "integer",
- "description": "The maximum number of concurrent access licenses for this volume.",
- "format": "int32"
- },
- "message": {
- "type": "string",
- "description": "Error/warning message."
- },
- "nonce": {
- "type": "string",
- "description": "Client nonce for verification. Download access and client-validation only."
- },
- "reasonCode": {
- "type": "string",
- "description": "Error/warning reason code."
- },
- "restricted": {
- "type": "boolean",
- "description": "Whether this volume has any concurrent access restrictions."
- },
- "signature": {
- "type": "string",
- "description": "Response signature."
- },
- "source": {
- "type": "string",
- "description": "Client app identifier for verification. Download access and client-validation only."
- },
- "timeWindowSeconds": {
- "type": "integer",
- "description": "Time in seconds for license auto-expiration.",
- "format": "int32"
- },
- "volumeId": {
- "type": "string",
- "description": "Identifies the volume for which this entry applies."
- }
- }
- },
- "Dictlayerdata": {
- "id": "Dictlayerdata",
- "type": "object",
- "properties": {
- "common": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The display title and localized canonical name to use when searching for this entity on Google search."
- }
- }
- },
- "dict": {
- "type": "object",
- "properties": {
- "source": {
- "type": "object",
- "description": "The source, url and attribution for this dictionary data.",
- "properties": {
- "attribution": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- },
- "words": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "derivatives": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "source": {
- "type": "object",
- "properties": {
- "attribution": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- },
- "text": {
- "type": "string"
- }
- }
- }
- },
- "examples": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "source": {
- "type": "object",
- "properties": {
- "attribution": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- },
- "text": {
- "type": "string"
- }
- }
- }
- },
- "senses": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "conjugations": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string"
- },
- "value": {
- "type": "string"
- }
- }
- }
- },
- "definitions": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "definition": {
- "type": "string"
- },
- "examples": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "source": {
- "type": "object",
- "properties": {
- "attribution": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- },
- "text": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "partOfSpeech": {
- "type": "string"
- },
- "pronunciation": {
- "type": "string"
- },
- "pronunciationUrl": {
- "type": "string"
- },
- "source": {
- "type": "object",
- "properties": {
- "attribution": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- },
- "syllabification": {
- "type": "string"
- },
- "synonyms": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "source": {
- "type": "object",
- "properties": {
- "attribution": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- },
- "text": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "source": {
- "type": "object",
- "description": "The words with different meanings but not related words, e.g. \"go\" (game) and \"go\" (verb).",
- "properties": {
- "attribution": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "default": "books#dictlayerdata"
- }
- }
- },
- "Discoveryclusters": {
- "id": "Discoveryclusters",
- "type": "object",
- "properties": {
- "clusters": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "banner_with_content_container": {
- "type": "object",
- "properties": {
- "fillColorArgb": {
- "type": "string"
- },
- "imageUrl": {
- "type": "string"
- },
- "maskColorArgb": {
- "type": "string"
- },
- "moreButtonText": {
- "type": "string"
- },
- "moreButtonUrl": {
- "type": "string"
- },
- "textColorArgb": {
- "type": "string"
- }
- }
- },
- "subTitle": {
- "type": "string"
- },
- "title": {
- "type": "string"
- },
- "totalVolumes": {
- "type": "integer",
- "format": "int32"
- },
- "uid": {
- "type": "string"
- },
- "volumes": {
- "type": "array",
- "items": {
- "$ref": "Volume"
- }
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Resorce type.",
- "default": "books#discovery#clusters"
- },
- "totalClusters": {
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "DownloadAccessRestriction": {
- "id": "DownloadAccessRestriction",
- "type": "object",
- "properties": {
- "deviceAllowed": {
- "type": "boolean",
- "description": "If restricted, whether access is granted for this (user, device, volume)."
- },
- "downloadsAcquired": {
- "type": "integer",
- "description": "If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).",
- "format": "int32"
- },
- "justAcquired": {
- "type": "boolean",
- "description": "If deviceAllowed, whether access was just acquired with this request."
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "books#downloadAccessRestriction"
- },
- "maxDownloadDevices": {
- "type": "integer",
- "description": "If restricted, the maximum number of content download licenses for this volume.",
- "format": "int32"
- },
- "message": {
- "type": "string",
- "description": "Error/warning message."
- },
- "nonce": {
- "type": "string",
- "description": "Client nonce for verification. Download access and client-validation only."
- },
- "reasonCode": {
- "type": "string",
- "description": "Error/warning reason code. Additional codes may be added in the future. 0 OK 100 ACCESS_DENIED_PUBLISHER_LIMIT 101 ACCESS_DENIED_LIMIT 200 WARNING_USED_LAST_ACCESS"
- },
- "restricted": {
- "type": "boolean",
- "description": "Whether this volume has any download access restrictions."
- },
- "signature": {
- "type": "string",
- "description": "Response signature."
- },
- "source": {
- "type": "string",
- "description": "Client app identifier for verification. Download access and client-validation only."
- },
- "volumeId": {
- "type": "string",
- "description": "Identifies the volume for which this entry applies."
- }
- }
- },
- "DownloadAccesses": {
- "id": "DownloadAccesses",
- "type": "object",
- "properties": {
- "downloadAccessList": {
- "type": "array",
- "description": "A list of download access responses.",
- "items": {
- "$ref": "DownloadAccessRestriction"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "books#downloadAccesses"
- }
- }
- },
- "Geolayerdata": {
- "id": "Geolayerdata",
- "type": "object",
- "properties": {
- "common": {
- "type": "object",
- "properties": {
- "lang": {
- "type": "string",
- "description": "The language of the information url and description."
- },
- "previewImageUrl": {
- "type": "string",
- "description": "The URL for the preview image information."
- },
- "snippet": {
- "type": "string",
- "description": "The description for this location."
- },
- "snippetUrl": {
- "type": "string",
- "description": "The URL for information for this location. Ex: wikipedia link."
- },
- "title": {
- "type": "string",
- "description": "The display title and localized canonical name to use when searching for this entity on Google search."
- }
- }
- },
- "geo": {
- "type": "object",
- "properties": {
- "boundary": {
- "type": "array",
- "description": "The boundary of the location as a set of loops containing pairs of latitude, longitude coordinates.",
- "items": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "latitude": {
- "type": "integer",
- "format": "uint32"
- },
- "longitude": {
- "type": "integer",
- "format": "uint32"
- }
- }
- }
- }
- },
- "cachePolicy": {
- "type": "string",
- "description": "The cache policy active for this data. EX: UNRESTRICTED, RESTRICTED, NEVER"
- },
- "countryCode": {
- "type": "string",
- "description": "The country code of the location."
- },
- "latitude": {
- "type": "number",
- "description": "The latitude of the location.",
- "format": "double"
- },
- "longitude": {
- "type": "number",
- "description": "The longitude of the location.",
- "format": "double"
- },
- "mapType": {
- "type": "string",
- "description": "The type of map that should be used for this location. EX: HYBRID, ROADMAP, SATELLITE, TERRAIN"
- },
- "viewport": {
- "type": "object",
- "description": "The viewport for showing this location. This is a latitude, longitude rectangle.",
- "properties": {
- "hi": {
- "type": "object",
- "properties": {
- "latitude": {
- "type": "number",
- "format": "double"
- },
- "longitude": {
- "type": "number",
- "format": "double"
- }
- }
- },
- "lo": {
- "type": "object",
- "properties": {
- "latitude": {
- "type": "number",
- "format": "double"
- },
- "longitude": {
- "type": "number",
- "format": "double"
- }
- }
- }
- }
- },
- "zoom": {
- "type": "integer",
- "description": "The Zoom level to use for the map. Zoom levels between 0 (the lowest zoom level, in which the entire world can be seen on one map) to 21+ (down to individual buildings). See: https://developers.google.com/maps/documentation/staticmaps/#Zoomlevels",
- "format": "int32"
- }
- }
- },
- "kind": {
- "type": "string",
- "default": "books#geolayerdata"
- }
- }
- },
- "Layersummaries": {
- "id": "Layersummaries",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of layer summary items.",
- "items": {
- "$ref": "Layersummary"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "books#layersummaries"
- },
- "totalItems": {
- "type": "integer",
- "description": "The total number of layer summaries found.",
- "format": "int32"
- }
- }
- },
- "Layersummary": {
- "id": "Layersummary",
- "type": "object",
- "properties": {
- "annotationCount": {
- "type": "integer",
- "description": "The number of annotations for this layer.",
- "format": "int32"
- },
- "annotationTypes": {
- "type": "array",
- "description": "The list of annotation types contained for this layer.",
- "items": {
- "type": "string"
- }
- },
- "annotationsDataLink": {
- "type": "string",
- "description": "Link to get data for this annotation."
- },
- "annotationsLink": {
- "type": "string",
- "description": "The link to get the annotations for this layer."
- },
- "contentVersion": {
- "type": "string",
- "description": "The content version this resource is for."
- },
- "dataCount": {
- "type": "integer",
- "description": "The number of data items for this layer.",
- "format": "int32"
- },
- "id": {
- "type": "string",
- "description": "Unique id of this layer summary."
- },
- "kind": {
- "type": "string",
- "description": "Resource Type",
- "default": "books#layersummary"
- },
- "layerId": {
- "type": "string",
- "description": "The layer id for this summary."
- },
- "selfLink": {
- "type": "string",
- "description": "URL to this resource."
- },
- "updated": {
- "type": "string",
- "description": "Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC date-time format).",
- "format": "date-time"
- },
- "volumeAnnotationsVersion": {
- "type": "string",
- "description": "The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately."
- },
- "volumeId": {
- "type": "string",
- "description": "The volume id this resource is for."
- }
- }
- },
- "Metadata": {
- "id": "Metadata",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of offline dictionary metadata.",
- "items": {
- "type": "object",
- "properties": {
- "download_url": {
- "type": "string"
- },
- "encrypted_key": {
- "type": "string"
- },
- "language": {
- "type": "string"
- },
- "size": {
- "type": "string",
- "format": "int64"
- },
- "version": {
- "type": "string",
- "format": "int64"
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "dictionary#metadata"
- }
- }
- },
- "Notification": {
- "id": "Notification",
- "type": "object",
- "properties": {
- "body": {
- "type": "string"
- },
- "iconUrl": {
- "type": "string"
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "books#notification"
- },
- "linkUrl": {
- "type": "string"
- },
- "title": {
- "type": "string"
- }
- }
- },
- "Offers": {
- "id": "Offers",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of offers.",
- "items": {
- "type": "object",
- "properties": {
- "artUrl": {
- "type": "string"
- },
- "gservicesKey": {
- "type": "string"
- },
- "id": {
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "author": {
- "type": "string"
- },
- "canonicalVolumeLink": {
- "type": "string"
- },
- "coverUrl": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "title": {
- "type": "string"
- },
- "volumeId": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "promooffer#offers"
- }
- }
- },
- "ReadingPosition": {
- "id": "ReadingPosition",
- "type": "object",
- "properties": {
- "epubCfiPosition": {
- "type": "string",
- "description": "Position in an EPUB as a CFI."
- },
- "gbImagePosition": {
- "type": "string",
- "description": "Position in a volume for image-based content."
- },
- "gbTextPosition": {
- "type": "string",
- "description": "Position in a volume for text-based content."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for a reading position.",
- "default": "books#readingPosition"
- },
- "pdfPosition": {
- "type": "string",
- "description": "Position in a PDF file."
- },
- "updated": {
- "type": "string",
- "description": "Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).",
- "format": "date-time"
- },
- "volumeId": {
- "type": "string",
- "description": "Volume id associated with this reading position."
- }
- }
- },
- "RequestAccess": {
- "id": "RequestAccess",
- "type": "object",
- "properties": {
- "concurrentAccess": {
- "$ref": "ConcurrentAccessRestriction",
- "description": "A concurrent access response."
- },
- "downloadAccess": {
- "$ref": "DownloadAccessRestriction",
- "description": "A download access response."
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "books#requestAccess"
- }
- }
- },
- "Review": {
- "id": "Review",
- "type": "object",
- "properties": {
- "author": {
- "type": "object",
- "description": "Author of this review.",
- "properties": {
- "displayName": {
- "type": "string",
- "description": "Name of this person."
- }
- }
- },
- "content": {
- "type": "string",
- "description": "Review text."
- },
- "date": {
- "type": "string",
- "description": "Date of this review."
- },
- "fullTextUrl": {
- "type": "string",
- "description": "URL for the full review text, for reviews gathered from the web."
- },
- "kind": {
- "type": "string",
- "description": "Resource type for a review.",
- "default": "books#review"
- },
- "rating": {
- "type": "string",
- "description": "Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED."
- },
- "source": {
- "type": "object",
- "description": "Information regarding the source of this review, when the review is not from a Google Books user.",
- "properties": {
- "description": {
- "type": "string",
- "description": "Name of the source."
- },
- "extraDescription": {
- "type": "string",
- "description": "Extra text about the source of the review."
- },
- "url": {
- "type": "string",
- "description": "URL of the source of the review."
- }
- }
- },
- "title": {
- "type": "string",
- "description": "Title for this review."
- },
- "type": {
- "type": "string",
- "description": "Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER."
- },
- "volumeId": {
- "type": "string",
- "description": "Volume that this review is for."
- }
- }
- },
- "Usersettings": {
- "id": "Usersettings",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "books#usersettings"
- },
- "notesExport": {
- "type": "object",
- "description": "User settings in sub-objects, each for different purposes.",
- "properties": {
- "folderName": {
- "type": "string"
- },
- "isEnabled": {
- "type": "boolean"
- }
- }
- },
- "notification": {
- "type": "object",
- "properties": {
- "moreFromAuthors": {
- "type": "object",
- "properties": {
- "opted_state": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "Volume": {
- "id": "Volume",
- "type": "object",
- "properties": {
- "accessInfo": {
- "type": "object",
- "description": "Any information about a volume related to reading or obtaining that volume text. This information can depend on country (books may be public domain in one country but not in another, e.g.).",
- "properties": {
- "accessViewStatus": {
- "type": "string",
- "description": "Combines the access and viewability of this volume into a single status field for this user. Values can be FULL_PURCHASED, FULL_PUBLIC_DOMAIN, SAMPLE or NONE. (In LITE projection.)"
- },
- "country": {
- "type": "string",
- "description": "The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)"
- },
- "downloadAccess": {
- "$ref": "DownloadAccessRestriction",
- "description": "Information about a volume's download license access restrictions."
- },
- "driveImportedContentLink": {
- "type": "string",
- "description": "URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive."
- },
- "embeddable": {
- "type": "boolean",
- "description": "Whether this volume can be embedded in a viewport using the Embedded Viewer API."
- },
- "epub": {
- "type": "object",
- "description": "Information about epub content. (In LITE projection.)",
- "properties": {
- "acsTokenLink": {
- "type": "string",
- "description": "URL to retrieve ACS token for epub download. (In LITE projection.)"
- },
- "downloadLink": {
- "type": "string",
- "description": "URL to download epub. (In LITE projection.)"
- },
- "isAvailable": {
- "type": "boolean",
- "description": "Is a flowing text epub available either as public domain or for purchase. (In LITE projection.)"
- }
- }
- },
- "explicitOfflineLicenseManagement": {
- "type": "boolean",
- "description": "Whether this volume requires that the client explicitly request offline download license rather than have it done automatically when loading the content, if the client supports it."
- },
- "pdf": {
- "type": "object",
- "description": "Information about pdf content. (In LITE projection.)",
- "properties": {
- "acsTokenLink": {
- "type": "string",
- "description": "URL to retrieve ACS token for pdf download. (In LITE projection.)"
- },
- "downloadLink": {
- "type": "string",
- "description": "URL to download pdf. (In LITE projection.)"
- },
- "isAvailable": {
- "type": "boolean",
- "description": "Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)"
- }
- }
- },
- "publicDomain": {
- "type": "boolean",
- "description": "Whether or not this book is public domain in the country listed above."
- },
- "quoteSharingAllowed": {
- "type": "boolean",
- "description": "Whether quote sharing is allowed for this volume."
- },
- "textToSpeechPermission": {
- "type": "string",
- "description": "Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED."
- },
- "viewOrderUrl": {
- "type": "string",
- "description": "For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page."
- },
- "viewability": {
- "type": "string",
- "description": "The read access of a volume. Possible values are PARTIAL, ALL_PAGES, NO_PAGES or UNKNOWN. This value depends on the country listed above. A value of PARTIAL means that the publisher has allowed some portion of the volume to be viewed publicly, without purchase. This can apply to eBooks as well as non-eBooks. Public domain books will always have a value of ALL_PAGES."
- },
- "webReaderLink": {
- "type": "string",
- "description": "URL to read this volume on the Google Books site. Link will not allow users to read non-viewable volumes."
- }
- }
- },
- "etag": {
- "type": "string",
- "description": "Opaque identifier for a specific version of a volume resource. (In LITE projection)"
- },
- "id": {
- "type": "string",
- "description": "Unique identifier for a volume. (In LITE projection.)"
- },
- "kind": {
- "type": "string",
- "description": "Resource type for a volume. (In LITE projection.)",
- "default": "books#volume"
- },
- "layerInfo": {
- "type": "object",
- "description": "What layers exist in this volume and high level information about them.",
- "properties": {
- "layers": {
- "type": "array",
- "description": "A layer should appear here if and only if the layer exists for this book.",
- "items": {
- "type": "object",
- "properties": {
- "layerId": {
- "type": "string",
- "description": "The layer id of this layer (e.g. \"geo\")."
- },
- "volumeAnnotationsVersion": {
- "type": "string",
- "description": "The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately."
- }
- }
- }
- }
- }
- },
- "recommendedInfo": {
- "type": "object",
- "description": "Recommendation related information for this volume.",
- "properties": {
- "explanation": {
- "type": "string",
- "description": "A text explaining why this volume is recommended."
- }
- }
- },
- "saleInfo": {
- "type": "object",
- "description": "Any information about a volume related to the eBookstore and/or purchaseability. This information can depend on the country where the request originates from (i.e. books may not be for sale in certain countries).",
- "properties": {
- "buyLink": {
- "type": "string",
- "description": "URL to purchase this volume on the Google Books site. (In LITE projection)"
- },
- "country": {
- "type": "string",
- "description": "The two-letter ISO_3166-1 country code for which this sale information is valid. (In LITE projection.)"
- },
- "isEbook": {
- "type": "boolean",
- "description": "Whether or not this volume is an eBook (can be added to the My eBooks shelf)."
- },
- "listPrice": {
- "type": "object",
- "description": "Suggested retail price. (In LITE projection.)",
- "properties": {
- "amount": {
- "type": "number",
- "description": "Amount in the currency listed below. (In LITE projection.)",
- "format": "double"
- },
- "currencyCode": {
- "type": "string",
- "description": "An ISO 4217, three-letter currency code. (In LITE projection.)"
- }
- }
- },
- "offers": {
- "type": "array",
- "description": "Offers available for this volume (sales and rentals).",
- "items": {
- "type": "object",
- "properties": {
- "finskyOfferType": {
- "type": "integer",
- "description": "The finsky offer type (e.g., PURCHASE=0 RENTAL=3)",
- "format": "int32"
- },
- "listPrice": {
- "type": "object",
- "description": "Offer list (=undiscounted) price in Micros.",
- "properties": {
- "amountInMicros": {
- "type": "number",
- "format": "double"
- },
- "currencyCode": {
- "type": "string"
- }
- }
- },
- "rentalDuration": {
- "type": "object",
- "description": "The rental duration (for rental offers only).",
- "properties": {
- "count": {
- "type": "number",
- "format": "double"
- },
- "unit": {
- "type": "string"
- }
- }
- },
- "retailPrice": {
- "type": "object",
- "description": "Offer retail (=discounted) price in Micros",
- "properties": {
- "amountInMicros": {
- "type": "number",
- "format": "double"
- },
- "currencyCode": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "onSaleDate": {
- "type": "string",
- "description": "The date on which this book is available for sale.",
- "format": "date-time"
- },
- "retailPrice": {
- "type": "object",
- "description": "The actual selling price of the book. This is the same as the suggested retail or list price unless there are offers or discounts on this volume. (In LITE projection.)",
- "properties": {
- "amount": {
- "type": "number",
- "description": "Amount in the currency listed below. (In LITE projection.)",
- "format": "double"
- },
- "currencyCode": {
- "type": "string",
- "description": "An ISO 4217, three-letter currency code. (In LITE projection.)"
- }
- }
- },
- "saleability": {
- "type": "string",
- "description": "Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, FREE, NOT_FOR_SALE, or FOR_PREORDER."
- }
- }
- },
- "searchInfo": {
- "type": "object",
- "description": "Search result information related to this volume.",
- "properties": {
- "textSnippet": {
- "type": "string",
- "description": "A text snippet containing the search query."
- }
- }
- },
- "selfLink": {
- "type": "string",
- "description": "URL to this resource. (In LITE projection.)"
- },
- "userInfo": {
- "type": "object",
- "description": "User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)",
- "properties": {
- "acquisitionType": {
- "type": "integer",
- "description": "How this volume was acquired.",
- "format": "int32"
- },
- "copy": {
- "type": "object",
- "description": "Copy/Paste accounting information.",
- "properties": {
- "allowedCharacterCount": {
- "type": "integer",
- "format": "int32"
- },
- "limitType": {
- "type": "string"
- },
- "remainingCharacterCount": {
- "type": "integer",
- "format": "int32"
- },
- "updated": {
- "type": "string",
- "format": "date-time"
- }
- }
- },
- "entitlementType": {
- "type": "integer",
- "description": "Whether this volume is purchased, sample, pd download etc.",
- "format": "int32"
- },
- "isInMyBooks": {
- "type": "boolean",
- "description": "Whether or not this volume is currently in \"my books.\""
- },
- "isPreordered": {
- "type": "boolean",
- "description": "Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)"
- },
- "isPurchased": {
- "type": "boolean",
- "description": "Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)"
- },
- "isUploaded": {
- "type": "boolean",
- "description": "Whether or not this volume was user uploaded."
- },
- "readingPosition": {
- "$ref": "ReadingPosition",
- "description": "The user's current reading position in the volume, if one is available. (In LITE projection.)"
- },
- "rentalPeriod": {
- "type": "object",
- "description": "Period during this book is/was a valid rental.",
- "properties": {
- "endUtcSec": {
- "type": "string",
- "format": "int64"
- },
- "startUtcSec": {
- "type": "string",
- "format": "int64"
- }
- }
- },
- "rentalState": {
- "type": "string",
- "description": "Whether this book is an active or an expired rental."
- },
- "review": {
- "$ref": "Review",
- "description": "This user's review of this volume, if one exists."
- },
- "updated": {
- "type": "string",
- "description": "Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).",
- "format": "date-time"
- },
- "userUploadedVolumeInfo": {
- "type": "object",
- "properties": {
- "processingState": {
- "type": "string"
- }
- }
- }
- }
- },
- "volumeInfo": {
- "type": "object",
- "description": "General volume information.",
- "properties": {
- "allowAnonLogging": {
- "type": "boolean",
- "description": "Whether anonymous logging should be allowed."
- },
- "authors": {
- "type": "array",
- "description": "The names of the authors and/or editors for this volume. (In LITE projection)",
- "items": {
- "type": "string"
- }
- },
- "averageRating": {
- "type": "number",
- "description": "The mean review rating for this volume. (min = 1.0, max = 5.0)",
- "format": "double"
- },
- "canonicalVolumeLink": {
- "type": "string",
- "description": "Canonical URL for a volume. (In LITE projection.)"
- },
- "categories": {
- "type": "array",
- "description": "A list of subject categories, such as \"Fiction\", \"Suspense\", etc.",
- "items": {
- "type": "string"
- }
- },
- "contentVersion": {
- "type": "string",
- "description": "An identifier for the version of the volume content (text & images). (In LITE projection)"
- },
- "description": {
- "type": "string",
- "description": "A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)"
- },
- "dimensions": {
- "type": "object",
- "description": "Physical dimensions of this volume.",
- "properties": {
- "height": {
- "type": "string",
- "description": "Height or length of this volume (in cm)."
- },
- "thickness": {
- "type": "string",
- "description": "Thickness of this volume (in cm)."
- },
- "width": {
- "type": "string",
- "description": "Width of this volume (in cm)."
- }
- }
- },
- "imageLinks": {
- "type": "object",
- "description": "A list of image links for all the sizes that are available. (In LITE projection.)",
- "properties": {
- "extraLarge": {
- "type": "string",
- "description": "Image link for extra large size (width of ~1280 pixels). (In LITE projection)"
- },
- "large": {
- "type": "string",
- "description": "Image link for large size (width of ~800 pixels). (In LITE projection)"
- },
- "medium": {
- "type": "string",
- "description": "Image link for medium size (width of ~575 pixels). (In LITE projection)"
- },
- "small": {
- "type": "string",
- "description": "Image link for small size (width of ~300 pixels). (In LITE projection)"
- },
- "smallThumbnail": {
- "type": "string",
- "description": "Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)"
- },
- "thumbnail": {
- "type": "string",
- "description": "Image link for thumbnail size (width of ~128 pixels). (In LITE projection)"
- }
- }
- },
- "industryIdentifiers": {
- "type": "array",
- "description": "Industry standard identifiers for this volume.",
- "items": {
- "type": "object",
- "properties": {
- "identifier": {
- "type": "string",
- "description": "Industry specific volume identifier."
- },
- "type": {
- "type": "string",
- "description": "Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER."
- }
- }
- }
- },
- "infoLink": {
- "type": "string",
- "description": "URL to view information about this volume on the Google Books site. (In LITE projection)"
- },
- "language": {
- "type": "string",
- "description": "Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc."
- },
- "mainCategory": {
- "type": "string",
- "description": "The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight."
- },
- "maturityRating": {
- "type": "string"
- },
- "pageCount": {
- "type": "integer",
- "description": "Total number of pages as per publisher metadata.",
- "format": "int32"
- },
- "previewLink": {
- "type": "string",
- "description": "URL to preview this volume on the Google Books site."
- },
- "printType": {
- "type": "string",
- "description": "Type of publication of this volume. Possible values are BOOK or MAGAZINE."
- },
- "printedPageCount": {
- "type": "integer",
- "description": "Total number of printed pages in generated pdf representation.",
- "format": "int32"
- },
- "publishedDate": {
- "type": "string",
- "description": "Date of publication. (In LITE projection.)"
- },
- "publisher": {
- "type": "string",
- "description": "Publisher of this volume. (In LITE projection.)"
- },
- "ratingsCount": {
- "type": "integer",
- "description": "The number of review ratings for this volume.",
- "format": "int32"
- },
- "readingModes": {
- "type": "any",
- "description": "The reading modes available for this volume."
- },
- "samplePageCount": {
- "type": "integer",
- "description": "Total number of sample pages as per publisher metadata.",
- "format": "int32"
- },
- "subtitle": {
- "type": "string",
- "description": "Volume subtitle. (In LITE projection.)"
- },
- "title": {
- "type": "string",
- "description": "Volume title. (In LITE projection.)"
- }
- }
- }
- }
- },
- "Volume2": {
- "id": "Volume2",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of volumes.",
- "items": {
- "$ref": "Volume"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "onboarding#volume"
- },
- "nextPageToken": {
- "type": "string"
- }
- }
- },
- "Volumeannotation": {
- "id": "Volumeannotation",
- "type": "object",
- "properties": {
- "annotationDataId": {
- "type": "string",
- "description": "The annotation data id for this volume annotation."
- },
- "annotationDataLink": {
- "type": "string",
- "description": "Link to get data for this annotation."
- },
- "annotationType": {
- "type": "string",
- "description": "The type of annotation this is."
- },
- "contentRanges": {
- "type": "object",
- "description": "The content ranges to identify the selected text.",
- "properties": {
- "cfiRange": {
- "$ref": "BooksAnnotationsRange",
- "description": "Range in CFI format for this annotation for version above."
- },
- "contentVersion": {
- "type": "string",
- "description": "Content version applicable to ranges below."
- },
- "gbImageRange": {
- "$ref": "BooksAnnotationsRange",
- "description": "Range in GB image format for this annotation for version above."
- },
- "gbTextRange": {
- "$ref": "BooksAnnotationsRange",
- "description": "Range in GB text format for this annotation for version above."
- }
- }
- },
- "data": {
- "type": "string",
- "description": "Data for this annotation."
- },
- "deleted": {
- "type": "boolean",
- "description": "Indicates that this annotation is deleted."
- },
- "id": {
- "type": "string",
- "description": "Unique id of this volume annotation."
- },
- "kind": {
- "type": "string",
- "description": "Resource Type",
- "default": "books#volumeannotation"
- },
- "layerId": {
- "type": "string",
- "description": "The Layer this annotation is for."
- },
- "pageIds": {
- "type": "array",
- "description": "Pages the annotation spans.",
- "items": {
- "type": "string"
- }
- },
- "selectedText": {
- "type": "string",
- "description": "Excerpt from the volume."
- },
- "selfLink": {
- "type": "string",
- "description": "URL to this resource."
- },
- "updated": {
- "type": "string",
- "description": "Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format).",
- "format": "date-time"
- },
- "volumeId": {
- "type": "string",
- "description": "The Volume this annotation is for."
- }
- }
- },
- "Volumeannotations": {
- "id": "Volumeannotations",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of volume annotations.",
- "items": {
- "$ref": "Volumeannotation"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type",
- "default": "books#volumeannotations"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token to pass in for pagination for the next page. This will not be present if this request does not have more results."
- },
- "totalItems": {
- "type": "integer",
- "description": "The total number of volume annotations found.",
- "format": "int32"
- },
- "version": {
- "type": "string",
- "description": "The version string for all of the volume annotations in this layer (not just the ones in this response). Note: the version string doesn't apply to the annotation data, just the information in this response (e.g. the location of annotations in the book)."
- }
- }
- },
- "Volumes": {
- "id": "Volumes",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of volumes.",
- "items": {
- "$ref": "Volume"
- }
- },
- "kind": {
- "type": "string",
- "description": "Resource type.",
- "default": "books#volumes"
- },
- "totalItems": {
- "type": "integer",
- "description": "Total number of volumes found. This might be greater than the number of volumes returned in this response if results have been paginated.",
- "format": "int32"
- }
- }
- }
- },
- "resources": {
- "bookshelves": {
- "methods": {
- "get": {
- "id": "books.bookshelves.get",
- "path": "users/{userId}/bookshelves/{shelf}",
- "httpMethod": "GET",
- "description": "Retrieves metadata for a specific bookshelf for the specified user.",
- "parameters": {
- "shelf": {
- "type": "string",
- "description": "ID of bookshelf to retrieve.",
- "required": true,
- "location": "path"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "userId": {
- "type": "string",
- "description": "ID of user for whom to retrieve bookshelves.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userId",
- "shelf"
- ],
- "response": {
- "$ref": "Bookshelf"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "list": {
- "id": "books.bookshelves.list",
- "path": "users/{userId}/bookshelves",
- "httpMethod": "GET",
- "description": "Retrieves a list of public bookshelves for the specified user.",
- "parameters": {
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "userId": {
- "type": "string",
- "description": "ID of user for whom to retrieve bookshelves.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userId"
- ],
- "response": {
- "$ref": "Bookshelves"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- },
- "resources": {
- "volumes": {
- "methods": {
- "list": {
- "id": "books.bookshelves.volumes.list",
- "path": "users/{userId}/bookshelves/{shelf}/volumes",
- "httpMethod": "GET",
- "description": "Retrieves volumes in a specific bookshelf for the specified user.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return",
- "format": "uint32",
- "minimum": "0",
- "location": "query"
- },
- "shelf": {
- "type": "string",
- "description": "ID of bookshelf to retrieve volumes.",
- "required": true,
- "location": "path"
- },
- "showPreorders": {
- "type": "boolean",
- "description": "Set to true to show pre-ordered books. Defaults to false.",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first element to return (starts at 0)",
- "format": "uint32",
- "minimum": "0",
- "location": "query"
- },
- "userId": {
- "type": "string",
- "description": "ID of user for whom to retrieve bookshelf volumes.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userId",
- "shelf"
- ],
- "response": {
- "$ref": "Volumes"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- }
- }
- },
- "cloudloading": {
- "methods": {
- "addBook": {
- "id": "books.cloudloading.addBook",
- "path": "cloudloading/addBook",
- "httpMethod": "POST",
- "description": "",
- "parameters": {
- "drive_document_id": {
- "type": "string",
- "description": "A drive document id. The upload_client_token must not be set.",
- "location": "query"
- },
- "mime_type": {
- "type": "string",
- "description": "The document MIME type. It can be set only if the drive_document_id is set.",
- "location": "query"
- },
- "name": {
- "type": "string",
- "description": "The document name. It can be set only if the drive_document_id is set.",
- "location": "query"
- },
- "upload_client_token": {
- "type": "string",
- "location": "query"
- }
- },
- "response": {
- "$ref": "BooksCloudloadingResource"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "deleteBook": {
- "id": "books.cloudloading.deleteBook",
- "path": "cloudloading/deleteBook",
- "httpMethod": "POST",
- "description": "Remove the book and its contents",
- "parameters": {
- "volumeId": {
- "type": "string",
- "description": "The id of the book to be removed.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "volumeId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "updateBook": {
- "id": "books.cloudloading.updateBook",
- "path": "cloudloading/updateBook",
- "httpMethod": "POST",
- "description": "",
- "request": {
- "$ref": "BooksCloudloadingResource"
- },
- "response": {
- "$ref": "BooksCloudloadingResource"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- },
- "dictionary": {
- "methods": {
- "listOfflineMetadata": {
- "id": "books.dictionary.listOfflineMetadata",
- "path": "dictionary/listOfflineMetadata",
- "httpMethod": "GET",
- "description": "Returns a list of offline dictionary metadata available",
- "parameters": {
- "cpksver": {
- "type": "string",
- "description": "The device/version ID from which to request the data.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "cpksver"
- ],
- "response": {
- "$ref": "Metadata"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- },
- "layers": {
- "methods": {
- "get": {
- "id": "books.layers.get",
- "path": "volumes/{volumeId}/layersummary/{summaryId}",
- "httpMethod": "GET",
- "description": "Gets the layer summary for a volume.",
- "parameters": {
- "contentVersion": {
- "type": "string",
- "description": "The content version for the requested volume.",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "summaryId": {
- "type": "string",
- "description": "The ID for the layer to get the summary for.",
- "required": true,
- "location": "path"
- },
- "volumeId": {
- "type": "string",
- "description": "The volume to retrieve layers for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "volumeId",
- "summaryId"
- ],
- "response": {
- "$ref": "Layersummary"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "list": {
- "id": "books.layers.list",
- "path": "volumes/{volumeId}/layersummary",
- "httpMethod": "GET",
- "description": "List the layer summaries for a volume.",
- "parameters": {
- "contentVersion": {
- "type": "string",
- "description": "The content version for the requested volume.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return",
- "format": "uint32",
- "minimum": "0",
- "maximum": "200",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous page.",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "The volume to retrieve layers for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "volumeId"
- ],
- "response": {
- "$ref": "Layersummaries"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- },
- "resources": {
- "annotationData": {
- "methods": {
- "get": {
- "id": "books.layers.annotationData.get",
- "path": "volumes/{volumeId}/layers/{layerId}/data/{annotationDataId}",
- "httpMethod": "GET",
- "description": "Gets the annotation data.",
- "parameters": {
- "allowWebDefinitions": {
- "type": "boolean",
- "description": "For the dictionary layer. Whether or not to allow web definitions.",
- "location": "query"
- },
- "annotationDataId": {
- "type": "string",
- "description": "The ID of the annotation data to retrieve.",
- "required": true,
- "location": "path"
- },
- "contentVersion": {
- "type": "string",
- "description": "The content version for the volume you are trying to retrieve.",
- "required": true,
- "location": "query"
- },
- "h": {
- "type": "integer",
- "description": "The requested pixel height for any images. If height is provided width must also be provided.",
- "format": "int32",
- "location": "query"
- },
- "layerId": {
- "type": "string",
- "description": "The ID for the layer to get the annotations.",
- "required": true,
- "location": "path"
- },
- "locale": {
- "type": "string",
- "description": "The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.",
- "location": "query"
- },
- "scale": {
- "type": "integer",
- "description": "The requested scale for the image.",
- "format": "int32",
- "minimum": "0",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "The volume to retrieve annotations for.",
- "required": true,
- "location": "path"
- },
- "w": {
- "type": "integer",
- "description": "The requested pixel width for any images. If width is provided height must also be provided.",
- "format": "int32",
- "location": "query"
- }
- },
- "parameterOrder": [
- "volumeId",
- "layerId",
- "annotationDataId",
- "contentVersion"
- ],
- "response": {
- "$ref": "Annotationdata"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "list": {
- "id": "books.layers.annotationData.list",
- "path": "volumes/{volumeId}/layers/{layerId}/data",
- "httpMethod": "GET",
- "description": "Gets the annotation data for a volume and layer.",
- "parameters": {
- "annotationDataId": {
- "type": "string",
- "description": "The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set.",
- "repeated": true,
- "location": "query"
- },
- "contentVersion": {
- "type": "string",
- "description": "The content version for the requested volume.",
- "required": true,
- "location": "query"
- },
- "h": {
- "type": "integer",
- "description": "The requested pixel height for any images. If height is provided width must also be provided.",
- "format": "int32",
- "location": "query"
- },
- "layerId": {
- "type": "string",
- "description": "The ID for the layer to get the annotation data.",
- "required": true,
- "location": "path"
- },
- "locale": {
- "type": "string",
- "description": "The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return",
- "format": "uint32",
- "minimum": "0",
- "maximum": "200",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous page.",
- "location": "query"
- },
- "scale": {
- "type": "integer",
- "description": "The requested scale for the image.",
- "format": "int32",
- "minimum": "0",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "updatedMax": {
- "type": "string",
- "description": "RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).",
- "location": "query"
- },
- "updatedMin": {
- "type": "string",
- "description": "RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).",
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "The volume to retrieve annotation data for.",
- "required": true,
- "location": "path"
- },
- "w": {
- "type": "integer",
- "description": "The requested pixel width for any images. If width is provided height must also be provided.",
- "format": "int32",
- "location": "query"
- }
- },
- "parameterOrder": [
- "volumeId",
- "layerId",
- "contentVersion"
- ],
- "response": {
- "$ref": "Annotationsdata"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- },
- "volumeAnnotations": {
- "methods": {
- "get": {
- "id": "books.layers.volumeAnnotations.get",
- "path": "volumes/{volumeId}/layers/{layerId}/annotations/{annotationId}",
- "httpMethod": "GET",
- "description": "Gets the volume annotation.",
- "parameters": {
- "annotationId": {
- "type": "string",
- "description": "The ID of the volume annotation to retrieve.",
- "required": true,
- "location": "path"
- },
- "layerId": {
- "type": "string",
- "description": "The ID for the layer to get the annotations.",
- "required": true,
- "location": "path"
- },
- "locale": {
- "type": "string",
- "description": "The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "The volume to retrieve annotations for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "volumeId",
- "layerId",
- "annotationId"
- ],
- "response": {
- "$ref": "Volumeannotation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "list": {
- "id": "books.layers.volumeAnnotations.list",
- "path": "volumes/{volumeId}/layers/{layerId}",
- "httpMethod": "GET",
- "description": "Gets the volume annotations for a volume and layer.",
- "parameters": {
- "contentVersion": {
- "type": "string",
- "description": "The content version for the requested volume.",
- "required": true,
- "location": "query"
- },
- "endOffset": {
- "type": "string",
- "description": "The end offset to end retrieving data from.",
- "location": "query"
- },
- "endPosition": {
- "type": "string",
- "description": "The end position to end retrieving data from.",
- "location": "query"
- },
- "layerId": {
- "type": "string",
- "description": "The ID for the layer to get the annotations.",
- "required": true,
- "location": "path"
- },
- "locale": {
- "type": "string",
- "description": "The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return",
- "format": "uint32",
- "minimum": "0",
- "maximum": "200",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous page.",
- "location": "query"
- },
- "showDeleted": {
- "type": "boolean",
- "description": "Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "startOffset": {
- "type": "string",
- "description": "The start offset to start retrieving data from.",
- "location": "query"
- },
- "startPosition": {
- "type": "string",
- "description": "The start position to start retrieving data from.",
- "location": "query"
- },
- "updatedMax": {
- "type": "string",
- "description": "RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).",
- "location": "query"
- },
- "updatedMin": {
- "type": "string",
- "description": "RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).",
- "location": "query"
- },
- "volumeAnnotationsVersion": {
- "type": "string",
- "description": "The version of the volume annotations that you are requesting.",
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "The volume to retrieve annotations for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "volumeId",
- "layerId",
- "contentVersion"
- ],
- "response": {
- "$ref": "Volumeannotations"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- }
- }
- },
- "myconfig": {
- "methods": {
- "getUserSettings": {
- "id": "books.myconfig.getUserSettings",
- "path": "myconfig/getUserSettings",
- "httpMethod": "GET",
- "description": "Gets the current settings for the user.",
- "response": {
- "$ref": "Usersettings"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "releaseDownloadAccess": {
- "id": "books.myconfig.releaseDownloadAccess",
- "path": "myconfig/releaseDownloadAccess",
- "httpMethod": "POST",
- "description": "Release downloaded content access restriction.",
- "parameters": {
- "cpksver": {
- "type": "string",
- "description": "The device/version ID from which to release the restriction.",
- "required": true,
- "location": "query"
- },
- "locale": {
- "type": "string",
- "description": "ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "volumeIds": {
- "type": "string",
- "description": "The volume(s) to release restrictions for.",
- "required": true,
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "volumeIds",
- "cpksver"
- ],
- "response": {
- "$ref": "DownloadAccesses"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "requestAccess": {
- "id": "books.myconfig.requestAccess",
- "path": "myconfig/requestAccess",
- "httpMethod": "POST",
- "description": "Request concurrent and download access restrictions.",
- "parameters": {
- "cpksver": {
- "type": "string",
- "description": "The device/version ID from which to request the restrictions.",
- "required": true,
- "location": "query"
- },
- "licenseTypes": {
- "type": "string",
- "description": "The type of access license to request. If not specified, the default is BOTH.",
- "enum": [
- "BOTH",
- "CONCURRENT",
- "DOWNLOAD"
- ],
- "enumDescriptions": [
- "Both concurrent and download licenses.",
- "Concurrent access license.",
- "Offline download access license."
- ],
- "location": "query"
- },
- "locale": {
- "type": "string",
- "description": "ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.",
- "location": "query"
- },
- "nonce": {
- "type": "string",
- "description": "The client nonce value.",
- "required": true,
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "required": true,
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "The volume to request concurrent/download restrictions for.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "source",
- "volumeId",
- "nonce",
- "cpksver"
- ],
- "response": {
- "$ref": "RequestAccess"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "syncVolumeLicenses": {
- "id": "books.myconfig.syncVolumeLicenses",
- "path": "myconfig/syncVolumeLicenses",
- "httpMethod": "POST",
- "description": "Request downloaded content access for specified volumes on the My eBooks shelf.",
- "parameters": {
- "cpksver": {
- "type": "string",
- "description": "The device/version ID from which to release the restriction.",
- "required": true,
- "location": "query"
- },
- "features": {
- "type": "string",
- "description": "List of features supported by the client, i.e., 'RENTALS'",
- "enum": [
- "RENTALS"
- ],
- "enumDescriptions": [
- "Client supports rentals."
- ],
- "repeated": true,
- "location": "query"
- },
- "locale": {
- "type": "string",
- "description": "ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.",
- "location": "query"
- },
- "nonce": {
- "type": "string",
- "description": "The client nonce value.",
- "required": true,
- "location": "query"
- },
- "showPreorders": {
- "type": "boolean",
- "description": "Set to true to show pre-ordered books. Defaults to false.",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "required": true,
- "location": "query"
- },
- "volumeIds": {
- "type": "string",
- "description": "The volume(s) to request download restrictions for.",
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "source",
- "nonce",
- "cpksver"
- ],
- "response": {
- "$ref": "Volumes"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "updateUserSettings": {
- "id": "books.myconfig.updateUserSettings",
- "path": "myconfig/updateUserSettings",
- "httpMethod": "POST",
- "description": "Sets the settings for the user. If a sub-object is specified, it will overwrite the existing sub-object stored in the server. Unspecified sub-objects will retain the existing value.",
- "request": {
- "$ref": "Usersettings"
- },
- "response": {
- "$ref": "Usersettings"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- },
- "mylibrary": {
- "resources": {
- "annotations": {
- "methods": {
- "delete": {
- "id": "books.mylibrary.annotations.delete",
- "path": "mylibrary/annotations/{annotationId}",
- "httpMethod": "DELETE",
- "description": "Deletes an annotation.",
- "parameters": {
- "annotationId": {
- "type": "string",
- "description": "The ID for the annotation to delete.",
- "required": true,
- "location": "path"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "annotationId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "insert": {
- "id": "books.mylibrary.annotations.insert",
- "path": "mylibrary/annotations",
- "httpMethod": "POST",
- "description": "Inserts a new annotation.",
- "parameters": {
- "country": {
- "type": "string",
- "description": "ISO-3166-1 code to override the IP-based location.",
- "location": "query"
- },
- "showOnlySummaryInResponse": {
- "type": "boolean",
- "description": "Requests that only the summary of the specified layer be provided in the response.",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- }
- },
- "request": {
- "$ref": "Annotation"
- },
- "response": {
- "$ref": "Annotation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "list": {
- "id": "books.mylibrary.annotations.list",
- "path": "mylibrary/annotations",
- "httpMethod": "GET",
- "description": "Retrieves a list of annotations, possibly filtered.",
- "parameters": {
- "contentVersion": {
- "type": "string",
- "description": "The content version for the requested volume.",
- "location": "query"
- },
- "layerId": {
- "type": "string",
- "description": "The layer ID to limit annotation by.",
- "location": "query"
- },
- "layerIds": {
- "type": "string",
- "description": "The layer ID(s) to limit annotation by.",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return",
- "format": "uint32",
- "minimum": "0",
- "maximum": "40",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous page.",
- "location": "query"
- },
- "showDeleted": {
- "type": "boolean",
- "description": "Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "updatedMax": {
- "type": "string",
- "description": "RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).",
- "location": "query"
- },
- "updatedMin": {
- "type": "string",
- "description": "RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).",
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "The volume to restrict annotations to.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Annotations"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "summary": {
- "id": "books.mylibrary.annotations.summary",
- "path": "mylibrary/annotations/summary",
- "httpMethod": "POST",
- "description": "Gets the summary of specified layers.",
- "parameters": {
- "layerIds": {
- "type": "string",
- "description": "Array of layer IDs to get the summary for.",
- "required": true,
- "repeated": true,
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "Volume id to get the summary for.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "layerIds",
- "volumeId"
- ],
- "response": {
- "$ref": "AnnotationsSummary"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "update": {
- "id": "books.mylibrary.annotations.update",
- "path": "mylibrary/annotations/{annotationId}",
- "httpMethod": "PUT",
- "description": "Updates an existing annotation.",
- "parameters": {
- "annotationId": {
- "type": "string",
- "description": "The ID for the annotation to update.",
- "required": true,
- "location": "path"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "annotationId"
- ],
- "request": {
- "$ref": "Annotation"
- },
- "response": {
- "$ref": "Annotation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- },
- "bookshelves": {
- "methods": {
- "addVolume": {
- "id": "books.mylibrary.bookshelves.addVolume",
- "path": "mylibrary/bookshelves/{shelf}/addVolume",
- "httpMethod": "POST",
- "description": "Adds a volume to a bookshelf.",
- "parameters": {
- "reason": {
- "type": "string",
- "description": "The reason for which the book is added to the library.",
- "enum": [
- "IOS_PREX",
- "IOS_SEARCH",
- "ONBOARDING"
- ],
- "enumDescriptions": [
- "Volumes added from the PREX flow on iOS.",
- "Volumes added from the Search flow on iOS.",
- "Volumes added from the Onboarding flow."
- ],
- "location": "query"
- },
- "shelf": {
- "type": "string",
- "description": "ID of bookshelf to which to add a volume.",
- "required": true,
- "location": "path"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "ID of volume to add.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "shelf",
- "volumeId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "clearVolumes": {
- "id": "books.mylibrary.bookshelves.clearVolumes",
- "path": "mylibrary/bookshelves/{shelf}/clearVolumes",
- "httpMethod": "POST",
- "description": "Clears all volumes from a bookshelf.",
- "parameters": {
- "shelf": {
- "type": "string",
- "description": "ID of bookshelf from which to remove a volume.",
- "required": true,
- "location": "path"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "shelf"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "get": {
- "id": "books.mylibrary.bookshelves.get",
- "path": "mylibrary/bookshelves/{shelf}",
- "httpMethod": "GET",
- "description": "Retrieves metadata for a specific bookshelf belonging to the authenticated user.",
- "parameters": {
- "shelf": {
- "type": "string",
- "description": "ID of bookshelf to retrieve.",
- "required": true,
- "location": "path"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "shelf"
- ],
- "response": {
- "$ref": "Bookshelf"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "list": {
- "id": "books.mylibrary.bookshelves.list",
- "path": "mylibrary/bookshelves",
- "httpMethod": "GET",
- "description": "Retrieves a list of bookshelves belonging to the authenticated user.",
- "parameters": {
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Bookshelves"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "moveVolume": {
- "id": "books.mylibrary.bookshelves.moveVolume",
- "path": "mylibrary/bookshelves/{shelf}/moveVolume",
- "httpMethod": "POST",
- "description": "Moves a volume within a bookshelf.",
- "parameters": {
- "shelf": {
- "type": "string",
- "description": "ID of bookshelf with the volume.",
- "required": true,
- "location": "path"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "ID of volume to move.",
- "required": true,
- "location": "query"
- },
- "volumePosition": {
- "type": "integer",
- "description": "Position on shelf to move the item (0 puts the item before the current first item, 1 puts it between the first and the second and so on.)",
- "required": true,
- "format": "int32",
- "location": "query"
- }
- },
- "parameterOrder": [
- "shelf",
- "volumeId",
- "volumePosition"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "removeVolume": {
- "id": "books.mylibrary.bookshelves.removeVolume",
- "path": "mylibrary/bookshelves/{shelf}/removeVolume",
- "httpMethod": "POST",
- "description": "Removes a volume from a bookshelf.",
- "parameters": {
- "reason": {
- "type": "string",
- "description": "The reason for which the book is removed from the library.",
- "enum": [
- "ONBOARDING"
- ],
- "enumDescriptions": [
- "Samples removed from the Onboarding flow."
- ],
- "location": "query"
- },
- "shelf": {
- "type": "string",
- "description": "ID of bookshelf from which to remove a volume.",
- "required": true,
- "location": "path"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "ID of volume to remove.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "shelf",
- "volumeId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- },
- "resources": {
- "volumes": {
- "methods": {
- "list": {
- "id": "books.mylibrary.bookshelves.volumes.list",
- "path": "mylibrary/bookshelves/{shelf}/volumes",
- "httpMethod": "GET",
- "description": "Gets volume information for volumes on a bookshelf.",
- "parameters": {
- "country": {
- "type": "string",
- "description": "ISO-3166-1 code to override the IP-based location.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return",
- "format": "uint32",
- "minimum": "0",
- "location": "query"
- },
- "projection": {
- "type": "string",
- "description": "Restrict information returned to a set of selected fields.",
- "enum": [
- "full",
- "lite"
- ],
- "enumDescriptions": [
- "Includes all volume data.",
- "Includes a subset of fields in volumeInfo and accessInfo."
- ],
- "location": "query"
- },
- "q": {
- "type": "string",
- "description": "Full-text search query string in this bookshelf.",
- "location": "query"
- },
- "shelf": {
- "type": "string",
- "description": "The bookshelf ID or name retrieve volumes for.",
- "required": true,
- "location": "path"
- },
- "showPreorders": {
- "type": "boolean",
- "description": "Set to true to show pre-ordered books. Defaults to false.",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first element to return (starts at 0)",
- "format": "uint32",
- "minimum": "0",
- "location": "query"
- }
- },
- "parameterOrder": [
- "shelf"
- ],
- "response": {
- "$ref": "Volumes"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- }
- }
- },
- "readingpositions": {
- "methods": {
- "get": {
- "id": "books.mylibrary.readingpositions.get",
- "path": "mylibrary/readingpositions/{volumeId}",
- "httpMethod": "GET",
- "description": "Retrieves my reading position information for a volume.",
- "parameters": {
- "contentVersion": {
- "type": "string",
- "description": "Volume content version for which this reading position is requested.",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "ID of volume for which to retrieve a reading position.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "volumeId"
- ],
- "response": {
- "$ref": "ReadingPosition"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "setPosition": {
- "id": "books.mylibrary.readingpositions.setPosition",
- "path": "mylibrary/readingpositions/{volumeId}/setPosition",
- "httpMethod": "POST",
- "description": "Sets my reading position information for a volume.",
- "parameters": {
- "action": {
- "type": "string",
- "description": "Action that caused this reading position to be set.",
- "enum": [
- "bookmark",
- "chapter",
- "next-page",
- "prev-page",
- "scroll",
- "search"
- ],
- "enumDescriptions": [
- "User chose bookmark within volume.",
- "User selected chapter from list.",
- "Next page event.",
- "Previous page event.",
- "User navigated to page.",
- "User chose search results within volume."
- ],
- "location": "query"
- },
- "contentVersion": {
- "type": "string",
- "description": "Volume content version for which this reading position applies.",
- "location": "query"
- },
- "deviceCookie": {
- "type": "string",
- "description": "Random persistent device cookie optional on set position.",
- "location": "query"
- },
- "position": {
- "type": "string",
- "description": "Position string for the new volume reading position.",
- "required": true,
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "timestamp": {
- "type": "string",
- "description": "RFC 3339 UTC format timestamp associated with this reading position.",
- "required": true,
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "ID of volume for which to update the reading position.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "volumeId",
- "timestamp",
- "position"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- }
- }
- },
- "notification": {
- "methods": {
- "get": {
- "id": "books.notification.get",
- "path": "notification/get",
- "httpMethod": "GET",
- "description": "Returns notification details for a given notification id.",
- "parameters": {
- "locale": {
- "type": "string",
- "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating notification title and body.",
- "location": "query"
- },
- "notification_id": {
- "type": "string",
- "description": "String to identify the notification.",
- "required": true,
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "notification_id"
- ],
- "response": {
- "$ref": "Notification"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- },
- "onboarding": {
- "methods": {
- "listCategories": {
- "id": "books.onboarding.listCategories",
- "path": "onboarding/listCategories",
- "httpMethod": "GET",
- "description": "List categories for onboarding experience.",
- "parameters": {
- "locale": {
- "type": "string",
- "description": "ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Category"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "listCategoryVolumes": {
- "id": "books.onboarding.listCategoryVolumes",
- "path": "onboarding/listCategoryVolumes",
- "httpMethod": "GET",
- "description": "List available volumes under categories for onboarding experience.",
- "parameters": {
- "categoryId": {
- "type": "string",
- "description": "List of category ids requested.",
- "repeated": true,
- "location": "query"
- },
- "locale": {
- "type": "string",
- "description": "ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.",
- "location": "query"
- },
- "maxAllowedMaturityRating": {
- "type": "string",
- "description": "The maximum allowed maturity rating of returned volumes. Books with a higher maturity rating are filtered out.",
- "enum": [
- "mature",
- "not-mature"
- ],
- "enumDescriptions": [
- "Show books which are rated mature or lower.",
- "Show books which are rated not mature."
- ],
- "location": "query"
- },
- "pageSize": {
- "type": "integer",
- "description": "Number of maximum results per page to be included in the response.",
- "format": "uint32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous page.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Volume2"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- },
- "personalizedstream": {
- "methods": {
- "get": {
- "id": "books.personalizedstream.get",
- "path": "personalizedstream/get",
- "httpMethod": "GET",
- "description": "Returns a stream of personalized book clusters",
- "parameters": {
- "locale": {
- "type": "string",
- "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.",
- "location": "query"
- },
- "maxAllowedMaturityRating": {
- "type": "string",
- "description": "The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.",
- "enum": [
- "mature",
- "not-mature"
- ],
- "enumDescriptions": [
- "Show books which are rated mature or lower.",
- "Show books which are rated not mature."
- ],
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Discoveryclusters"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- },
- "promooffer": {
- "methods": {
- "accept": {
- "id": "books.promooffer.accept",
- "path": "promooffer/accept",
- "httpMethod": "POST",
- "description": "",
- "parameters": {
- "androidId": {
- "type": "string",
- "description": "device android_id",
- "location": "query"
- },
- "device": {
- "type": "string",
- "description": "device device",
- "location": "query"
- },
- "manufacturer": {
- "type": "string",
- "description": "device manufacturer",
- "location": "query"
- },
- "model": {
- "type": "string",
- "description": "device model",
- "location": "query"
- },
- "offerId": {
- "type": "string",
- "location": "query"
- },
- "product": {
- "type": "string",
- "description": "device product",
- "location": "query"
- },
- "serial": {
- "type": "string",
- "description": "device serial",
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "Volume id to exercise the offer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "dismiss": {
- "id": "books.promooffer.dismiss",
- "path": "promooffer/dismiss",
- "httpMethod": "POST",
- "description": "",
- "parameters": {
- "androidId": {
- "type": "string",
- "description": "device android_id",
- "location": "query"
- },
- "device": {
- "type": "string",
- "description": "device device",
- "location": "query"
- },
- "manufacturer": {
- "type": "string",
- "description": "device manufacturer",
- "location": "query"
- },
- "model": {
- "type": "string",
- "description": "device model",
- "location": "query"
- },
- "offerId": {
- "type": "string",
- "description": "Offer to dimiss",
- "location": "query"
- },
- "product": {
- "type": "string",
- "description": "device product",
- "location": "query"
- },
- "serial": {
- "type": "string",
- "description": "device serial",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "get": {
- "id": "books.promooffer.get",
- "path": "promooffer/get",
- "httpMethod": "GET",
- "description": "Returns a list of promo offers available to the user",
- "parameters": {
- "androidId": {
- "type": "string",
- "description": "device android_id",
- "location": "query"
- },
- "device": {
- "type": "string",
- "description": "device device",
- "location": "query"
- },
- "manufacturer": {
- "type": "string",
- "description": "device manufacturer",
- "location": "query"
- },
- "model": {
- "type": "string",
- "description": "device model",
- "location": "query"
- },
- "product": {
- "type": "string",
- "description": "device product",
- "location": "query"
- },
- "serial": {
- "type": "string",
- "description": "device serial",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Offers"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- },
- "volumes": {
- "methods": {
- "get": {
- "id": "books.volumes.get",
- "path": "volumes/{volumeId}",
- "httpMethod": "GET",
- "description": "Gets volume information for a single volume.",
- "parameters": {
- "country": {
- "type": "string",
- "description": "ISO-3166-1 code to override the IP-based location.",
- "location": "query"
- },
- "partner": {
- "type": "string",
- "description": "Brand results for partner ID.",
- "location": "query"
- },
- "projection": {
- "type": "string",
- "description": "Restrict information returned to a set of selected fields.",
- "enum": [
- "full",
- "lite"
- ],
- "enumDescriptions": [
- "Includes all volume data.",
- "Includes a subset of fields in volumeInfo and accessInfo."
- ],
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "user_library_consistent_read": {
- "type": "boolean",
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "ID of volume to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "volumeId"
- ],
- "response": {
- "$ref": "Volume"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "list": {
- "id": "books.volumes.list",
- "path": "volumes",
- "httpMethod": "GET",
- "description": "Performs a book search.",
- "parameters": {
- "download": {
- "type": "string",
- "description": "Restrict to volumes by download availability.",
- "enum": [
- "epub"
- ],
- "enumDescriptions": [
- "All volumes with epub."
- ],
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "Filter search results.",
- "enum": [
- "ebooks",
- "free-ebooks",
- "full",
- "paid-ebooks",
- "partial"
- ],
- "enumDescriptions": [
- "All Google eBooks.",
- "Google eBook with full volume text viewability.",
- "Public can view entire volume text.",
- "Google eBook with a price.",
- "Public able to see parts of text."
- ],
- "location": "query"
- },
- "langRestrict": {
- "type": "string",
- "description": "Restrict results to books with this language code.",
- "location": "query"
- },
- "libraryRestrict": {
- "type": "string",
- "description": "Restrict search to this user's library.",
- "enum": [
- "my-library",
- "no-restrict"
- ],
- "enumDescriptions": [
- "Restrict to the user's library, any shelf.",
- "Do not restrict based on user's library."
- ],
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "40",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sort search results.",
- "enum": [
- "newest",
- "relevance"
- ],
- "enumDescriptions": [
- "Most recently published.",
- "Relevance to search terms."
- ],
- "location": "query"
- },
- "partner": {
- "type": "string",
- "description": "Restrict and brand results for partner ID.",
- "location": "query"
- },
- "printType": {
- "type": "string",
- "description": "Restrict to books or magazines.",
- "enum": [
- "all",
- "books",
- "magazines"
- ],
- "enumDescriptions": [
- "All volume content types.",
- "Just books.",
- "Just magazines."
- ],
- "location": "query"
- },
- "projection": {
- "type": "string",
- "description": "Restrict information returned to a set of selected fields.",
- "enum": [
- "full",
- "lite"
- ],
- "enumDescriptions": [
- "Includes all volume data.",
- "Includes a subset of fields in volumeInfo and accessInfo."
- ],
- "location": "query"
- },
- "q": {
- "type": "string",
- "description": "Full-text search query string.",
- "required": true,
- "location": "query"
- },
- "showPreorders": {
- "type": "boolean",
- "description": "Set to true to show books available for preorder. Defaults to false.",
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first result to return (starts at 0)",
- "format": "uint32",
- "minimum": "0",
- "location": "query"
- }
- },
- "parameterOrder": [
- "q"
- ],
- "response": {
- "$ref": "Volumes"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- },
- "resources": {
- "associated": {
- "methods": {
- "list": {
- "id": "books.volumes.associated.list",
- "path": "volumes/{volumeId}/associated",
- "httpMethod": "GET",
- "description": "Return a list of associated books.",
- "parameters": {
- "association": {
- "type": "string",
- "description": "Association type.",
- "enum": [
- "end-of-sample",
- "end-of-volume",
- "related-for-play"
- ],
- "enumDescriptions": [
- "Recommendations for display end-of-sample.",
- "Recommendations for display end-of-volume.",
- "Related volumes for Play Store."
- ],
- "location": "query"
- },
- "locale": {
- "type": "string",
- "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.",
- "location": "query"
- },
- "maxAllowedMaturityRating": {
- "type": "string",
- "description": "The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.",
- "enum": [
- "mature",
- "not-mature"
- ],
- "enumDescriptions": [
- "Show books which are rated mature or lower.",
- "Show books which are rated not mature."
- ],
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "ID of the source volume.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "volumeId"
- ],
- "response": {
- "$ref": "Volumes"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- },
- "mybooks": {
- "methods": {
- "list": {
- "id": "books.volumes.mybooks.list",
- "path": "volumes/mybooks",
- "httpMethod": "GET",
- "description": "Return a list of books in My Library.",
- "parameters": {
- "acquireMethod": {
- "type": "string",
- "description": "How the book was aquired",
- "enum": [
- "PREORDERED",
- "PREVIOUSLY_RENTED",
- "PUBLIC_DOMAIN",
- "PURCHASED",
- "RENTED",
- "SAMPLE",
- "UPLOADED"
- ],
- "enumDescriptions": [
- "Preordered books (not yet available)",
- "User-rented books past their expiration time",
- "Public domain books",
- "Purchased books",
- "User-rented books",
- "Sample books",
- "User uploaded books"
- ],
- "repeated": true,
- "location": "query"
- },
- "locale": {
- "type": "string",
- "description": "ISO-639-1 language and ISO-3166-1 country code. Ex:'en_US'. Used for generating recommendations.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
- },
- "processingState": {
- "type": "string",
- "description": "The processing state of the user uploaded volumes to be returned. Applicable only if the UPLOADED is specified in the acquireMethod.",
- "enum": [
- "COMPLETED_FAILED",
- "COMPLETED_SUCCESS",
- "RUNNING"
- ],
- "enumDescriptions": [
- "The volume processing hase failed.",
- "The volume processing was completed.",
- "The volume processing is not completed."
- ],
- "repeated": true,
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first result to return (starts at 0)",
- "format": "uint32",
- "minimum": "0",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Volumes"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- },
- "recommended": {
- "methods": {
- "list": {
- "id": "books.volumes.recommended.list",
- "path": "volumes/recommended",
- "httpMethod": "GET",
- "description": "Return a list of recommended books for the current user.",
- "parameters": {
- "locale": {
- "type": "string",
- "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.",
- "location": "query"
- },
- "maxAllowedMaturityRating": {
- "type": "string",
- "description": "The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.",
- "enum": [
- "mature",
- "not-mature"
- ],
- "enumDescriptions": [
- "Show books which are rated mature or lower.",
- "Show books which are rated not mature."
- ],
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Volumes"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- },
- "rate": {
- "id": "books.volumes.recommended.rate",
- "path": "volumes/recommended/rate",
- "httpMethod": "POST",
- "description": "Rate a recommended book for the current user.",
- "parameters": {
- "locale": {
- "type": "string",
- "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.",
- "location": "query"
- },
- "rating": {
- "type": "string",
- "description": "Rating to be given to the volume.",
- "required": true,
- "enum": [
- "HAVE_IT",
- "NOT_INTERESTED"
- ],
- "enumDescriptions": [
- "Rating indicating a dismissal due to ownership.",
- "Rating indicating a negative dismissal of a volume."
- ],
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "ID of the source volume.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "rating",
- "volumeId"
- ],
- "response": {
- "$ref": "BooksVolumesRecommendedRateResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- },
- "useruploaded": {
- "methods": {
- "list": {
- "id": "books.volumes.useruploaded.list",
- "path": "volumes/useruploaded",
- "httpMethod": "GET",
- "description": "Return a list of books uploaded by the current user.",
- "parameters": {
- "locale": {
- "type": "string",
- "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "uint32",
- "minimum": "0",
- "maximum": "40",
- "location": "query"
- },
- "processingState": {
- "type": "string",
- "description": "The processing state of the user uploaded volumes to be returned.",
- "enum": [
- "COMPLETED_FAILED",
- "COMPLETED_SUCCESS",
- "RUNNING"
- ],
- "enumDescriptions": [
- "The volume processing hase failed.",
- "The volume processing was completed.",
- "The volume processing is not completed."
- ],
- "repeated": true,
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "String to identify the originator of this request.",
- "location": "query"
- },
- "startIndex": {
- "type": "integer",
- "description": "Index of the first result to return (starts at 0)",
- "format": "uint32",
- "minimum": "0",
- "location": "query"
- },
- "volumeId": {
- "type": "string",
- "description": "The ids of the volumes to be returned. If not specified all that match the processingState are returned.",
- "repeated": true,
- "location": "query"
- }
- },
- "response": {
- "$ref": "Volumes"
- },
- "scopes": [
- "https://www.googleapis.com/auth/books"
- ]
- }
- }
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/books/v1/books-gen.go b/vendor/google.golang.org/api/books/v1/books-gen.go
deleted file mode 100644
index 09c47f7f..00000000
--- a/vendor/google.golang.org/api/books/v1/books-gen.go
+++ /dev/null
@@ -1,11363 +0,0 @@
-// Package books provides access to the Books API.
-//
-// See https://developers.google.com/books/docs/v1/getting_started
-//
-// Usage example:
-//
-// import "google.golang.org/api/books/v1"
-// ...
-// booksService, err := books.New(oauthHttpClient)
-package books // import "google.golang.org/api/books/v1"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "books:v1"
-const apiName = "books"
-const apiVersion = "v1"
-const basePath = "https://www.googleapis.com/books/v1/"
-
-// OAuth2 scopes used by this API.
-const (
- // Manage your books
- BooksScope = "https://www.googleapis.com/auth/books"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Bookshelves = NewBookshelvesService(s)
- s.Cloudloading = NewCloudloadingService(s)
- s.Dictionary = NewDictionaryService(s)
- s.Layers = NewLayersService(s)
- s.Myconfig = NewMyconfigService(s)
- s.Mylibrary = NewMylibraryService(s)
- s.Notification = NewNotificationService(s)
- s.Onboarding = NewOnboardingService(s)
- s.Personalizedstream = NewPersonalizedstreamService(s)
- s.Promooffer = NewPromoofferService(s)
- s.Volumes = NewVolumesService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Bookshelves *BookshelvesService
-
- Cloudloading *CloudloadingService
-
- Dictionary *DictionaryService
-
- Layers *LayersService
-
- Myconfig *MyconfigService
-
- Mylibrary *MylibraryService
-
- Notification *NotificationService
-
- Onboarding *OnboardingService
-
- Personalizedstream *PersonalizedstreamService
-
- Promooffer *PromoofferService
-
- Volumes *VolumesService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewBookshelvesService(s *Service) *BookshelvesService {
- rs := &BookshelvesService{s: s}
- rs.Volumes = NewBookshelvesVolumesService(s)
- return rs
-}
-
-type BookshelvesService struct {
- s *Service
-
- Volumes *BookshelvesVolumesService
-}
-
-func NewBookshelvesVolumesService(s *Service) *BookshelvesVolumesService {
- rs := &BookshelvesVolumesService{s: s}
- return rs
-}
-
-type BookshelvesVolumesService struct {
- s *Service
-}
-
-func NewCloudloadingService(s *Service) *CloudloadingService {
- rs := &CloudloadingService{s: s}
- return rs
-}
-
-type CloudloadingService struct {
- s *Service
-}
-
-func NewDictionaryService(s *Service) *DictionaryService {
- rs := &DictionaryService{s: s}
- return rs
-}
-
-type DictionaryService struct {
- s *Service
-}
-
-func NewLayersService(s *Service) *LayersService {
- rs := &LayersService{s: s}
- rs.AnnotationData = NewLayersAnnotationDataService(s)
- rs.VolumeAnnotations = NewLayersVolumeAnnotationsService(s)
- return rs
-}
-
-type LayersService struct {
- s *Service
-
- AnnotationData *LayersAnnotationDataService
-
- VolumeAnnotations *LayersVolumeAnnotationsService
-}
-
-func NewLayersAnnotationDataService(s *Service) *LayersAnnotationDataService {
- rs := &LayersAnnotationDataService{s: s}
- return rs
-}
-
-type LayersAnnotationDataService struct {
- s *Service
-}
-
-func NewLayersVolumeAnnotationsService(s *Service) *LayersVolumeAnnotationsService {
- rs := &LayersVolumeAnnotationsService{s: s}
- return rs
-}
-
-type LayersVolumeAnnotationsService struct {
- s *Service
-}
-
-func NewMyconfigService(s *Service) *MyconfigService {
- rs := &MyconfigService{s: s}
- return rs
-}
-
-type MyconfigService struct {
- s *Service
-}
-
-func NewMylibraryService(s *Service) *MylibraryService {
- rs := &MylibraryService{s: s}
- rs.Annotations = NewMylibraryAnnotationsService(s)
- rs.Bookshelves = NewMylibraryBookshelvesService(s)
- rs.Readingpositions = NewMylibraryReadingpositionsService(s)
- return rs
-}
-
-type MylibraryService struct {
- s *Service
-
- Annotations *MylibraryAnnotationsService
-
- Bookshelves *MylibraryBookshelvesService
-
- Readingpositions *MylibraryReadingpositionsService
-}
-
-func NewMylibraryAnnotationsService(s *Service) *MylibraryAnnotationsService {
- rs := &MylibraryAnnotationsService{s: s}
- return rs
-}
-
-type MylibraryAnnotationsService struct {
- s *Service
-}
-
-func NewMylibraryBookshelvesService(s *Service) *MylibraryBookshelvesService {
- rs := &MylibraryBookshelvesService{s: s}
- rs.Volumes = NewMylibraryBookshelvesVolumesService(s)
- return rs
-}
-
-type MylibraryBookshelvesService struct {
- s *Service
-
- Volumes *MylibraryBookshelvesVolumesService
-}
-
-func NewMylibraryBookshelvesVolumesService(s *Service) *MylibraryBookshelvesVolumesService {
- rs := &MylibraryBookshelvesVolumesService{s: s}
- return rs
-}
-
-type MylibraryBookshelvesVolumesService struct {
- s *Service
-}
-
-func NewMylibraryReadingpositionsService(s *Service) *MylibraryReadingpositionsService {
- rs := &MylibraryReadingpositionsService{s: s}
- return rs
-}
-
-type MylibraryReadingpositionsService struct {
- s *Service
-}
-
-func NewNotificationService(s *Service) *NotificationService {
- rs := &NotificationService{s: s}
- return rs
-}
-
-type NotificationService struct {
- s *Service
-}
-
-func NewOnboardingService(s *Service) *OnboardingService {
- rs := &OnboardingService{s: s}
- return rs
-}
-
-type OnboardingService struct {
- s *Service
-}
-
-func NewPersonalizedstreamService(s *Service) *PersonalizedstreamService {
- rs := &PersonalizedstreamService{s: s}
- return rs
-}
-
-type PersonalizedstreamService struct {
- s *Service
-}
-
-func NewPromoofferService(s *Service) *PromoofferService {
- rs := &PromoofferService{s: s}
- return rs
-}
-
-type PromoofferService struct {
- s *Service
-}
-
-func NewVolumesService(s *Service) *VolumesService {
- rs := &VolumesService{s: s}
- rs.Associated = NewVolumesAssociatedService(s)
- rs.Mybooks = NewVolumesMybooksService(s)
- rs.Recommended = NewVolumesRecommendedService(s)
- rs.Useruploaded = NewVolumesUseruploadedService(s)
- return rs
-}
-
-type VolumesService struct {
- s *Service
-
- Associated *VolumesAssociatedService
-
- Mybooks *VolumesMybooksService
-
- Recommended *VolumesRecommendedService
-
- Useruploaded *VolumesUseruploadedService
-}
-
-func NewVolumesAssociatedService(s *Service) *VolumesAssociatedService {
- rs := &VolumesAssociatedService{s: s}
- return rs
-}
-
-type VolumesAssociatedService struct {
- s *Service
-}
-
-func NewVolumesMybooksService(s *Service) *VolumesMybooksService {
- rs := &VolumesMybooksService{s: s}
- return rs
-}
-
-type VolumesMybooksService struct {
- s *Service
-}
-
-func NewVolumesRecommendedService(s *Service) *VolumesRecommendedService {
- rs := &VolumesRecommendedService{s: s}
- return rs
-}
-
-type VolumesRecommendedService struct {
- s *Service
-}
-
-func NewVolumesUseruploadedService(s *Service) *VolumesUseruploadedService {
- rs := &VolumesUseruploadedService{s: s}
- return rs
-}
-
-type VolumesUseruploadedService struct {
- s *Service
-}
-
-type Annotation struct {
- // AfterSelectedText: Anchor text after excerpt. For requests, if the
- // user bookmarked a screen that has no flowing text on it, then this
- // field should be empty.
- AfterSelectedText string `json:"afterSelectedText,omitempty"`
-
- // BeforeSelectedText: Anchor text before excerpt. For requests, if the
- // user bookmarked a screen that has no flowing text on it, then this
- // field should be empty.
- BeforeSelectedText string `json:"beforeSelectedText,omitempty"`
-
- // ClientVersionRanges: Selection ranges sent from the client.
- ClientVersionRanges *AnnotationClientVersionRanges `json:"clientVersionRanges,omitempty"`
-
- // Created: Timestamp for the created time of this annotation.
- Created string `json:"created,omitempty"`
-
- // CurrentVersionRanges: Selection ranges for the most recent content
- // version.
- CurrentVersionRanges *AnnotationCurrentVersionRanges `json:"currentVersionRanges,omitempty"`
-
- // Data: User-created data for this annotation.
- Data string `json:"data,omitempty"`
-
- // Deleted: Indicates that this annotation is deleted.
- Deleted bool `json:"deleted,omitempty"`
-
- // HighlightStyle: The highlight style for this annotation.
- HighlightStyle string `json:"highlightStyle,omitempty"`
-
- // Id: Id of this annotation, in the form of a GUID.
- Id string `json:"id,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // LayerId: The layer this annotation is for.
- LayerId string `json:"layerId,omitempty"`
-
- LayerSummary *AnnotationLayerSummary `json:"layerSummary,omitempty"`
-
- // PageIds: Pages that this annotation spans.
- PageIds []string `json:"pageIds,omitempty"`
-
- // SelectedText: Excerpt from the volume.
- SelectedText string `json:"selectedText,omitempty"`
-
- // SelfLink: URL to this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Updated: Timestamp for the last time this annotation was modified.
- Updated string `json:"updated,omitempty"`
-
- // VolumeId: The volume that this annotation belongs to.
- VolumeId string `json:"volumeId,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AfterSelectedText")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Annotation) MarshalJSON() ([]byte, error) {
- type noMethod Annotation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AnnotationClientVersionRanges: Selection ranges sent from the client.
-type AnnotationClientVersionRanges struct {
- // CfiRange: Range in CFI format for this annotation sent by client.
- CfiRange *BooksAnnotationsRange `json:"cfiRange,omitempty"`
-
- // ContentVersion: Content version the client sent in.
- ContentVersion string `json:"contentVersion,omitempty"`
-
- // GbImageRange: Range in GB image format for this annotation sent by
- // client.
- GbImageRange *BooksAnnotationsRange `json:"gbImageRange,omitempty"`
-
- // GbTextRange: Range in GB text format for this annotation sent by
- // client.
- GbTextRange *BooksAnnotationsRange `json:"gbTextRange,omitempty"`
-
- // ImageCfiRange: Range in image CFI format for this annotation sent by
- // client.
- ImageCfiRange *BooksAnnotationsRange `json:"imageCfiRange,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CfiRange") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AnnotationClientVersionRanges) MarshalJSON() ([]byte, error) {
- type noMethod AnnotationClientVersionRanges
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AnnotationCurrentVersionRanges: Selection ranges for the most recent
-// content version.
-type AnnotationCurrentVersionRanges struct {
- // CfiRange: Range in CFI format for this annotation for version above.
- CfiRange *BooksAnnotationsRange `json:"cfiRange,omitempty"`
-
- // ContentVersion: Content version applicable to ranges below.
- ContentVersion string `json:"contentVersion,omitempty"`
-
- // GbImageRange: Range in GB image format for this annotation for
- // version above.
- GbImageRange *BooksAnnotationsRange `json:"gbImageRange,omitempty"`
-
- // GbTextRange: Range in GB text format for this annotation for version
- // above.
- GbTextRange *BooksAnnotationsRange `json:"gbTextRange,omitempty"`
-
- // ImageCfiRange: Range in image CFI format for this annotation for
- // version above.
- ImageCfiRange *BooksAnnotationsRange `json:"imageCfiRange,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CfiRange") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AnnotationCurrentVersionRanges) MarshalJSON() ([]byte, error) {
- type noMethod AnnotationCurrentVersionRanges
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AnnotationLayerSummary struct {
- // AllowedCharacterCount: Maximum allowed characters on this layer,
- // especially for the "copy" layer.
- AllowedCharacterCount int64 `json:"allowedCharacterCount,omitempty"`
-
- // LimitType: Type of limitation on this layer. "limited" or "unlimited"
- // for the "copy" layer.
- LimitType string `json:"limitType,omitempty"`
-
- // RemainingCharacterCount: Remaining allowed characters on this layer,
- // especially for the "copy" layer.
- RemainingCharacterCount int64 `json:"remainingCharacterCount,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "AllowedCharacterCount") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AnnotationLayerSummary) MarshalJSON() ([]byte, error) {
- type noMethod AnnotationLayerSummary
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Annotationdata struct {
- // AnnotationType: The type of annotation this data is for.
- AnnotationType string `json:"annotationType,omitempty"`
-
- Data interface{} `json:"data,omitempty"`
-
- // EncodedData: Base64 encoded data for this annotation data.
- EncodedData string `json:"encoded_data,omitempty"`
-
- // Id: Unique id for this annotation data.
- Id string `json:"id,omitempty"`
-
- // Kind: Resource Type
- Kind string `json:"kind,omitempty"`
-
- // LayerId: The Layer id for this data. *
- LayerId string `json:"layerId,omitempty"`
-
- // SelfLink: URL for this resource. *
- SelfLink string `json:"selfLink,omitempty"`
-
- // Updated: Timestamp for the last time this data was updated. (RFC 3339
- // UTC date-time format).
- Updated string `json:"updated,omitempty"`
-
- // VolumeId: The volume id for this data. *
- VolumeId string `json:"volumeId,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AnnotationType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Annotationdata) MarshalJSON() ([]byte, error) {
- type noMethod Annotationdata
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Annotations struct {
- // Items: A list of annotations.
- Items []*Annotation `json:"items,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Token to pass in for pagination for the next page.
- // This will not be present if this request does not have more results.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // TotalItems: Total number of annotations found. This may be greater
- // than the number of notes returned in this response if results have
- // been paginated.
- TotalItems int64 `json:"totalItems,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Annotations) MarshalJSON() ([]byte, error) {
- type noMethod Annotations
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AnnotationsSummary struct {
- Kind string `json:"kind,omitempty"`
-
- Layers []*AnnotationsSummaryLayers `json:"layers,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AnnotationsSummary) MarshalJSON() ([]byte, error) {
- type noMethod AnnotationsSummary
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AnnotationsSummaryLayers struct {
- AllowedCharacterCount int64 `json:"allowedCharacterCount,omitempty"`
-
- LayerId string `json:"layerId,omitempty"`
-
- LimitType string `json:"limitType,omitempty"`
-
- RemainingCharacterCount int64 `json:"remainingCharacterCount,omitempty"`
-
- Updated string `json:"updated,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "AllowedCharacterCount") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AnnotationsSummaryLayers) MarshalJSON() ([]byte, error) {
- type noMethod AnnotationsSummaryLayers
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Annotationsdata struct {
- // Items: A list of Annotation Data.
- Items []*Annotationdata `json:"items,omitempty"`
-
- // Kind: Resource type
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Token to pass in for pagination for the next page.
- // This will not be present if this request does not have more results.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // TotalItems: The total number of volume annotations found.
- TotalItems int64 `json:"totalItems,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Annotationsdata) MarshalJSON() ([]byte, error) {
- type noMethod Annotationsdata
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type BooksAnnotationsRange struct {
- // EndOffset: The offset from the ending position.
- EndOffset string `json:"endOffset,omitempty"`
-
- // EndPosition: The ending position for the range.
- EndPosition string `json:"endPosition,omitempty"`
-
- // StartOffset: The offset from the starting position.
- StartOffset string `json:"startOffset,omitempty"`
-
- // StartPosition: The starting position for the range.
- StartPosition string `json:"startPosition,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "EndOffset") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BooksAnnotationsRange) MarshalJSON() ([]byte, error) {
- type noMethod BooksAnnotationsRange
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type BooksCloudloadingResource struct {
- Author string `json:"author,omitempty"`
-
- ProcessingState string `json:"processingState,omitempty"`
-
- Title string `json:"title,omitempty"`
-
- VolumeId string `json:"volumeId,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Author") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BooksCloudloadingResource) MarshalJSON() ([]byte, error) {
- type noMethod BooksCloudloadingResource
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type BooksVolumesRecommendedRateResponse struct {
- ConsistencyToken string `json:"consistency_token,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ConsistencyToken") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BooksVolumesRecommendedRateResponse) MarshalJSON() ([]byte, error) {
- type noMethod BooksVolumesRecommendedRateResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Bookshelf struct {
- // Access: Whether this bookshelf is PUBLIC or PRIVATE.
- Access string `json:"access,omitempty"`
-
- // Created: Created time for this bookshelf (formatted UTC timestamp
- // with millisecond resolution).
- Created string `json:"created,omitempty"`
-
- // Description: Description of this bookshelf.
- Description string `json:"description,omitempty"`
-
- // Id: Id of this bookshelf, only unique by user.
- Id int64 `json:"id,omitempty"`
-
- // Kind: Resource type for bookshelf metadata.
- Kind string `json:"kind,omitempty"`
-
- // SelfLink: URL to this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Title: Title of this bookshelf.
- Title string `json:"title,omitempty"`
-
- // Updated: Last modified time of this bookshelf (formatted UTC
- // timestamp with millisecond resolution).
- Updated string `json:"updated,omitempty"`
-
- // VolumeCount: Number of volumes in this bookshelf.
- VolumeCount int64 `json:"volumeCount,omitempty"`
-
- // VolumesLastUpdated: Last time a volume was added or removed from this
- // bookshelf (formatted UTC timestamp with millisecond resolution).
- VolumesLastUpdated string `json:"volumesLastUpdated,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Access") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Bookshelf) MarshalJSON() ([]byte, error) {
- type noMethod Bookshelf
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Bookshelves struct {
- // Items: A list of bookshelves.
- Items []*Bookshelf `json:"items,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Bookshelves) MarshalJSON() ([]byte, error) {
- type noMethod Bookshelves
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Category struct {
- // Items: A list of onboarding categories.
- Items []*CategoryItems `json:"items,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Category) MarshalJSON() ([]byte, error) {
- type noMethod Category
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CategoryItems struct {
- BadgeUrl string `json:"badgeUrl,omitempty"`
-
- CategoryId string `json:"categoryId,omitempty"`
-
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BadgeUrl") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CategoryItems) MarshalJSON() ([]byte, error) {
- type noMethod CategoryItems
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ConcurrentAccessRestriction struct {
- // DeviceAllowed: Whether access is granted for this (user, device,
- // volume).
- DeviceAllowed bool `json:"deviceAllowed,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // MaxConcurrentDevices: The maximum number of concurrent access
- // licenses for this volume.
- MaxConcurrentDevices int64 `json:"maxConcurrentDevices,omitempty"`
-
- // Message: Error/warning message.
- Message string `json:"message,omitempty"`
-
- // Nonce: Client nonce for verification. Download access and
- // client-validation only.
- Nonce string `json:"nonce,omitempty"`
-
- // ReasonCode: Error/warning reason code.
- ReasonCode string `json:"reasonCode,omitempty"`
-
- // Restricted: Whether this volume has any concurrent access
- // restrictions.
- Restricted bool `json:"restricted,omitempty"`
-
- // Signature: Response signature.
- Signature string `json:"signature,omitempty"`
-
- // Source: Client app identifier for verification. Download access and
- // client-validation only.
- Source string `json:"source,omitempty"`
-
- // TimeWindowSeconds: Time in seconds for license auto-expiration.
- TimeWindowSeconds int64 `json:"timeWindowSeconds,omitempty"`
-
- // VolumeId: Identifies the volume for which this entry applies.
- VolumeId string `json:"volumeId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DeviceAllowed") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ConcurrentAccessRestriction) MarshalJSON() ([]byte, error) {
- type noMethod ConcurrentAccessRestriction
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Dictlayerdata struct {
- Common *DictlayerdataCommon `json:"common,omitempty"`
-
- Dict *DictlayerdataDict `json:"dict,omitempty"`
-
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Common") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Dictlayerdata) MarshalJSON() ([]byte, error) {
- type noMethod Dictlayerdata
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DictlayerdataCommon struct {
- // Title: The display title and localized canonical name to use when
- // searching for this entity on Google search.
- Title string `json:"title,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Title") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DictlayerdataCommon) MarshalJSON() ([]byte, error) {
- type noMethod DictlayerdataCommon
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DictlayerdataDict struct {
- // Source: The source, url and attribution for this dictionary data.
- Source *DictlayerdataDictSource `json:"source,omitempty"`
-
- Words []*DictlayerdataDictWords `json:"words,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Source") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DictlayerdataDict) MarshalJSON() ([]byte, error) {
- type noMethod DictlayerdataDict
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DictlayerdataDictSource: The source, url and attribution for this
-// dictionary data.
-type DictlayerdataDictSource struct {
- Attribution string `json:"attribution,omitempty"`
-
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Attribution") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DictlayerdataDictSource) MarshalJSON() ([]byte, error) {
- type noMethod DictlayerdataDictSource
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DictlayerdataDictWords struct {
- Derivatives []*DictlayerdataDictWordsDerivatives `json:"derivatives,omitempty"`
-
- Examples []*DictlayerdataDictWordsExamples `json:"examples,omitempty"`
-
- Senses []*DictlayerdataDictWordsSenses `json:"senses,omitempty"`
-
- // Source: The words with different meanings but not related words, e.g.
- // "go" (game) and "go" (verb).
- Source *DictlayerdataDictWordsSource `json:"source,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Derivatives") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DictlayerdataDictWords) MarshalJSON() ([]byte, error) {
- type noMethod DictlayerdataDictWords
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DictlayerdataDictWordsDerivatives struct {
- Source *DictlayerdataDictWordsDerivativesSource `json:"source,omitempty"`
-
- Text string `json:"text,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Source") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DictlayerdataDictWordsDerivatives) MarshalJSON() ([]byte, error) {
- type noMethod DictlayerdataDictWordsDerivatives
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DictlayerdataDictWordsDerivativesSource struct {
- Attribution string `json:"attribution,omitempty"`
-
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Attribution") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DictlayerdataDictWordsDerivativesSource) MarshalJSON() ([]byte, error) {
- type noMethod DictlayerdataDictWordsDerivativesSource
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DictlayerdataDictWordsExamples struct {
- Source *DictlayerdataDictWordsExamplesSource `json:"source,omitempty"`
-
- Text string `json:"text,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Source") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DictlayerdataDictWordsExamples) MarshalJSON() ([]byte, error) {
- type noMethod DictlayerdataDictWordsExamples
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DictlayerdataDictWordsExamplesSource struct {
- Attribution string `json:"attribution,omitempty"`
-
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Attribution") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DictlayerdataDictWordsExamplesSource) MarshalJSON() ([]byte, error) {
- type noMethod DictlayerdataDictWordsExamplesSource
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DictlayerdataDictWordsSenses struct {
- Conjugations []*DictlayerdataDictWordsSensesConjugations `json:"conjugations,omitempty"`
-
- Definitions []*DictlayerdataDictWordsSensesDefinitions `json:"definitions,omitempty"`
-
- PartOfSpeech string `json:"partOfSpeech,omitempty"`
-
- Pronunciation string `json:"pronunciation,omitempty"`
-
- PronunciationUrl string `json:"pronunciationUrl,omitempty"`
-
- Source *DictlayerdataDictWordsSensesSource `json:"source,omitempty"`
-
- Syllabification string `json:"syllabification,omitempty"`
-
- Synonyms []*DictlayerdataDictWordsSensesSynonyms `json:"synonyms,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Conjugations") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DictlayerdataDictWordsSenses) MarshalJSON() ([]byte, error) {
- type noMethod DictlayerdataDictWordsSenses
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DictlayerdataDictWordsSensesConjugations struct {
- Type string `json:"type,omitempty"`
-
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Type") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DictlayerdataDictWordsSensesConjugations) MarshalJSON() ([]byte, error) {
- type noMethod DictlayerdataDictWordsSensesConjugations
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DictlayerdataDictWordsSensesDefinitions struct {
- Definition string `json:"definition,omitempty"`
-
- Examples []*DictlayerdataDictWordsSensesDefinitionsExamples `json:"examples,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Definition") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DictlayerdataDictWordsSensesDefinitions) MarshalJSON() ([]byte, error) {
- type noMethod DictlayerdataDictWordsSensesDefinitions
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DictlayerdataDictWordsSensesDefinitionsExamples struct {
- Source *DictlayerdataDictWordsSensesDefinitionsExamplesSource `json:"source,omitempty"`
-
- Text string `json:"text,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Source") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DictlayerdataDictWordsSensesDefinitionsExamples) MarshalJSON() ([]byte, error) {
- type noMethod DictlayerdataDictWordsSensesDefinitionsExamples
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DictlayerdataDictWordsSensesDefinitionsExamplesSource struct {
- Attribution string `json:"attribution,omitempty"`
-
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Attribution") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DictlayerdataDictWordsSensesDefinitionsExamplesSource) MarshalJSON() ([]byte, error) {
- type noMethod DictlayerdataDictWordsSensesDefinitionsExamplesSource
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DictlayerdataDictWordsSensesSource struct {
- Attribution string `json:"attribution,omitempty"`
-
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Attribution") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DictlayerdataDictWordsSensesSource) MarshalJSON() ([]byte, error) {
- type noMethod DictlayerdataDictWordsSensesSource
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DictlayerdataDictWordsSensesSynonyms struct {
- Source *DictlayerdataDictWordsSensesSynonymsSource `json:"source,omitempty"`
-
- Text string `json:"text,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Source") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DictlayerdataDictWordsSensesSynonyms) MarshalJSON() ([]byte, error) {
- type noMethod DictlayerdataDictWordsSensesSynonyms
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DictlayerdataDictWordsSensesSynonymsSource struct {
- Attribution string `json:"attribution,omitempty"`
-
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Attribution") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DictlayerdataDictWordsSensesSynonymsSource) MarshalJSON() ([]byte, error) {
- type noMethod DictlayerdataDictWordsSensesSynonymsSource
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DictlayerdataDictWordsSource: The words with different meanings but
-// not related words, e.g. "go" (game) and "go" (verb).
-type DictlayerdataDictWordsSource struct {
- Attribution string `json:"attribution,omitempty"`
-
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Attribution") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DictlayerdataDictWordsSource) MarshalJSON() ([]byte, error) {
- type noMethod DictlayerdataDictWordsSource
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Discoveryclusters struct {
- Clusters []*DiscoveryclustersClusters `json:"clusters,omitempty"`
-
- // Kind: Resorce type.
- Kind string `json:"kind,omitempty"`
-
- TotalClusters int64 `json:"totalClusters,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Clusters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Discoveryclusters) MarshalJSON() ([]byte, error) {
- type noMethod Discoveryclusters
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DiscoveryclustersClusters struct {
- BannerWithContentContainer *DiscoveryclustersClustersBannerWithContentContainer `json:"banner_with_content_container,omitempty"`
-
- SubTitle string `json:"subTitle,omitempty"`
-
- Title string `json:"title,omitempty"`
-
- TotalVolumes int64 `json:"totalVolumes,omitempty"`
-
- Uid string `json:"uid,omitempty"`
-
- Volumes []*Volume `json:"volumes,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "BannerWithContentContainer") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DiscoveryclustersClusters) MarshalJSON() ([]byte, error) {
- type noMethod DiscoveryclustersClusters
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DiscoveryclustersClustersBannerWithContentContainer struct {
- FillColorArgb string `json:"fillColorArgb,omitempty"`
-
- ImageUrl string `json:"imageUrl,omitempty"`
-
- MaskColorArgb string `json:"maskColorArgb,omitempty"`
-
- MoreButtonText string `json:"moreButtonText,omitempty"`
-
- MoreButtonUrl string `json:"moreButtonUrl,omitempty"`
-
- TextColorArgb string `json:"textColorArgb,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "FillColorArgb") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DiscoveryclustersClustersBannerWithContentContainer) MarshalJSON() ([]byte, error) {
- type noMethod DiscoveryclustersClustersBannerWithContentContainer
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DownloadAccessRestriction struct {
- // DeviceAllowed: If restricted, whether access is granted for this
- // (user, device, volume).
- DeviceAllowed bool `json:"deviceAllowed,omitempty"`
-
- // DownloadsAcquired: If restricted, the number of content download
- // licenses already acquired (including the requesting client, if
- // licensed).
- DownloadsAcquired int64 `json:"downloadsAcquired,omitempty"`
-
- // JustAcquired: If deviceAllowed, whether access was just acquired with
- // this request.
- JustAcquired bool `json:"justAcquired,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // MaxDownloadDevices: If restricted, the maximum number of content
- // download licenses for this volume.
- MaxDownloadDevices int64 `json:"maxDownloadDevices,omitempty"`
-
- // Message: Error/warning message.
- Message string `json:"message,omitempty"`
-
- // Nonce: Client nonce for verification. Download access and
- // client-validation only.
- Nonce string `json:"nonce,omitempty"`
-
- // ReasonCode: Error/warning reason code. Additional codes may be added
- // in the future. 0 OK 100 ACCESS_DENIED_PUBLISHER_LIMIT 101
- // ACCESS_DENIED_LIMIT 200 WARNING_USED_LAST_ACCESS
- ReasonCode string `json:"reasonCode,omitempty"`
-
- // Restricted: Whether this volume has any download access restrictions.
- Restricted bool `json:"restricted,omitempty"`
-
- // Signature: Response signature.
- Signature string `json:"signature,omitempty"`
-
- // Source: Client app identifier for verification. Download access and
- // client-validation only.
- Source string `json:"source,omitempty"`
-
- // VolumeId: Identifies the volume for which this entry applies.
- VolumeId string `json:"volumeId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DeviceAllowed") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DownloadAccessRestriction) MarshalJSON() ([]byte, error) {
- type noMethod DownloadAccessRestriction
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DownloadAccesses struct {
- // DownloadAccessList: A list of download access responses.
- DownloadAccessList []*DownloadAccessRestriction `json:"downloadAccessList,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "DownloadAccessList")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DownloadAccesses) MarshalJSON() ([]byte, error) {
- type noMethod DownloadAccesses
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Geolayerdata struct {
- Common *GeolayerdataCommon `json:"common,omitempty"`
-
- Geo *GeolayerdataGeo `json:"geo,omitempty"`
-
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Common") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Geolayerdata) MarshalJSON() ([]byte, error) {
- type noMethod Geolayerdata
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GeolayerdataCommon struct {
- // Lang: The language of the information url and description.
- Lang string `json:"lang,omitempty"`
-
- // PreviewImageUrl: The URL for the preview image information.
- PreviewImageUrl string `json:"previewImageUrl,omitempty"`
-
- // Snippet: The description for this location.
- Snippet string `json:"snippet,omitempty"`
-
- // SnippetUrl: The URL for information for this location. Ex: wikipedia
- // link.
- SnippetUrl string `json:"snippetUrl,omitempty"`
-
- // Title: The display title and localized canonical name to use when
- // searching for this entity on Google search.
- Title string `json:"title,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Lang") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GeolayerdataCommon) MarshalJSON() ([]byte, error) {
- type noMethod GeolayerdataCommon
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GeolayerdataGeo struct {
- // Boundary: The boundary of the location as a set of loops containing
- // pairs of latitude, longitude coordinates.
- Boundary [][]*GeolayerdataGeoBoundaryItem `json:"boundary,omitempty"`
-
- // CachePolicy: The cache policy active for this data. EX: UNRESTRICTED,
- // RESTRICTED, NEVER
- CachePolicy string `json:"cachePolicy,omitempty"`
-
- // CountryCode: The country code of the location.
- CountryCode string `json:"countryCode,omitempty"`
-
- // Latitude: The latitude of the location.
- Latitude float64 `json:"latitude,omitempty"`
-
- // Longitude: The longitude of the location.
- Longitude float64 `json:"longitude,omitempty"`
-
- // MapType: The type of map that should be used for this location. EX:
- // HYBRID, ROADMAP, SATELLITE, TERRAIN
- MapType string `json:"mapType,omitempty"`
-
- // Viewport: The viewport for showing this location. This is a latitude,
- // longitude rectangle.
- Viewport *GeolayerdataGeoViewport `json:"viewport,omitempty"`
-
- // Zoom: The Zoom level to use for the map. Zoom levels between 0 (the
- // lowest zoom level, in which the entire world can be seen on one map)
- // to 21+ (down to individual buildings). See:
- // https://developers.google.com/maps/documentation/staticmaps/#Zoomlevels
- Zoom int64 `json:"zoom,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Boundary") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GeolayerdataGeo) MarshalJSON() ([]byte, error) {
- type noMethod GeolayerdataGeo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GeolayerdataGeoBoundaryItem struct {
- Latitude int64 `json:"latitude,omitempty"`
-
- Longitude int64 `json:"longitude,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Latitude") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GeolayerdataGeoBoundaryItem) MarshalJSON() ([]byte, error) {
- type noMethod GeolayerdataGeoBoundaryItem
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// GeolayerdataGeoViewport: The viewport for showing this location. This
-// is a latitude, longitude rectangle.
-type GeolayerdataGeoViewport struct {
- Hi *GeolayerdataGeoViewportHi `json:"hi,omitempty"`
-
- Lo *GeolayerdataGeoViewportLo `json:"lo,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Hi") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GeolayerdataGeoViewport) MarshalJSON() ([]byte, error) {
- type noMethod GeolayerdataGeoViewport
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GeolayerdataGeoViewportHi struct {
- Latitude float64 `json:"latitude,omitempty"`
-
- Longitude float64 `json:"longitude,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Latitude") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GeolayerdataGeoViewportHi) MarshalJSON() ([]byte, error) {
- type noMethod GeolayerdataGeoViewportHi
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GeolayerdataGeoViewportLo struct {
- Latitude float64 `json:"latitude,omitempty"`
-
- Longitude float64 `json:"longitude,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Latitude") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GeolayerdataGeoViewportLo) MarshalJSON() ([]byte, error) {
- type noMethod GeolayerdataGeoViewportLo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Layersummaries struct {
- // Items: A list of layer summary items.
- Items []*Layersummary `json:"items,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // TotalItems: The total number of layer summaries found.
- TotalItems int64 `json:"totalItems,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Layersummaries) MarshalJSON() ([]byte, error) {
- type noMethod Layersummaries
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Layersummary struct {
- // AnnotationCount: The number of annotations for this layer.
- AnnotationCount int64 `json:"annotationCount,omitempty"`
-
- // AnnotationTypes: The list of annotation types contained for this
- // layer.
- AnnotationTypes []string `json:"annotationTypes,omitempty"`
-
- // AnnotationsDataLink: Link to get data for this annotation.
- AnnotationsDataLink string `json:"annotationsDataLink,omitempty"`
-
- // AnnotationsLink: The link to get the annotations for this layer.
- AnnotationsLink string `json:"annotationsLink,omitempty"`
-
- // ContentVersion: The content version this resource is for.
- ContentVersion string `json:"contentVersion,omitempty"`
-
- // DataCount: The number of data items for this layer.
- DataCount int64 `json:"dataCount,omitempty"`
-
- // Id: Unique id of this layer summary.
- Id string `json:"id,omitempty"`
-
- // Kind: Resource Type
- Kind string `json:"kind,omitempty"`
-
- // LayerId: The layer id for this summary.
- LayerId string `json:"layerId,omitempty"`
-
- // SelfLink: URL to this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Updated: Timestamp for the last time an item in this layer was
- // updated. (RFC 3339 UTC date-time format).
- Updated string `json:"updated,omitempty"`
-
- // VolumeAnnotationsVersion: The current version of this layer's volume
- // annotations. Note that this version applies only to the data in the
- // books.layers.volumeAnnotations.* responses. The actual annotation
- // data is versioned separately.
- VolumeAnnotationsVersion string `json:"volumeAnnotationsVersion,omitempty"`
-
- // VolumeId: The volume id this resource is for.
- VolumeId string `json:"volumeId,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AnnotationCount") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Layersummary) MarshalJSON() ([]byte, error) {
- type noMethod Layersummary
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Metadata struct {
- // Items: A list of offline dictionary metadata.
- Items []*MetadataItems `json:"items,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Metadata) MarshalJSON() ([]byte, error) {
- type noMethod Metadata
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type MetadataItems struct {
- DownloadUrl string `json:"download_url,omitempty"`
-
- EncryptedKey string `json:"encrypted_key,omitempty"`
-
- Language string `json:"language,omitempty"`
-
- Size int64 `json:"size,omitempty,string"`
-
- Version int64 `json:"version,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "DownloadUrl") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MetadataItems) MarshalJSON() ([]byte, error) {
- type noMethod MetadataItems
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Notification struct {
- Body string `json:"body,omitempty"`
-
- IconUrl string `json:"iconUrl,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- LinkUrl string `json:"linkUrl,omitempty"`
-
- Title string `json:"title,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Body") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Notification) MarshalJSON() ([]byte, error) {
- type noMethod Notification
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Offers struct {
- // Items: A list of offers.
- Items []*OffersItems `json:"items,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Offers) MarshalJSON() ([]byte, error) {
- type noMethod Offers
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OffersItems struct {
- ArtUrl string `json:"artUrl,omitempty"`
-
- GservicesKey string `json:"gservicesKey,omitempty"`
-
- Id string `json:"id,omitempty"`
-
- Items []*OffersItemsItems `json:"items,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ArtUrl") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OffersItems) MarshalJSON() ([]byte, error) {
- type noMethod OffersItems
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OffersItemsItems struct {
- Author string `json:"author,omitempty"`
-
- CanonicalVolumeLink string `json:"canonicalVolumeLink,omitempty"`
-
- CoverUrl string `json:"coverUrl,omitempty"`
-
- Description string `json:"description,omitempty"`
-
- Title string `json:"title,omitempty"`
-
- VolumeId string `json:"volumeId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Author") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OffersItemsItems) MarshalJSON() ([]byte, error) {
- type noMethod OffersItemsItems
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ReadingPosition struct {
- // EpubCfiPosition: Position in an EPUB as a CFI.
- EpubCfiPosition string `json:"epubCfiPosition,omitempty"`
-
- // GbImagePosition: Position in a volume for image-based content.
- GbImagePosition string `json:"gbImagePosition,omitempty"`
-
- // GbTextPosition: Position in a volume for text-based content.
- GbTextPosition string `json:"gbTextPosition,omitempty"`
-
- // Kind: Resource type for a reading position.
- Kind string `json:"kind,omitempty"`
-
- // PdfPosition: Position in a PDF file.
- PdfPosition string `json:"pdfPosition,omitempty"`
-
- // Updated: Timestamp when this reading position was last updated
- // (formatted UTC timestamp with millisecond resolution).
- Updated string `json:"updated,omitempty"`
-
- // VolumeId: Volume id associated with this reading position.
- VolumeId string `json:"volumeId,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "EpubCfiPosition") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReadingPosition) MarshalJSON() ([]byte, error) {
- type noMethod ReadingPosition
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type RequestAccess struct {
- // ConcurrentAccess: A concurrent access response.
- ConcurrentAccess *ConcurrentAccessRestriction `json:"concurrentAccess,omitempty"`
-
- // DownloadAccess: A download access response.
- DownloadAccess *DownloadAccessRestriction `json:"downloadAccess,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ConcurrentAccess") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RequestAccess) MarshalJSON() ([]byte, error) {
- type noMethod RequestAccess
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Review struct {
- // Author: Author of this review.
- Author *ReviewAuthor `json:"author,omitempty"`
-
- // Content: Review text.
- Content string `json:"content,omitempty"`
-
- // Date: Date of this review.
- Date string `json:"date,omitempty"`
-
- // FullTextUrl: URL for the full review text, for reviews gathered from
- // the web.
- FullTextUrl string `json:"fullTextUrl,omitempty"`
-
- // Kind: Resource type for a review.
- Kind string `json:"kind,omitempty"`
-
- // Rating: Star rating for this review. Possible values are ONE, TWO,
- // THREE, FOUR, FIVE or NOT_RATED.
- Rating string `json:"rating,omitempty"`
-
- // Source: Information regarding the source of this review, when the
- // review is not from a Google Books user.
- Source *ReviewSource `json:"source,omitempty"`
-
- // Title: Title for this review.
- Title string `json:"title,omitempty"`
-
- // Type: Source type for this review. Possible values are EDITORIAL,
- // WEB_USER or GOOGLE_USER.
- Type string `json:"type,omitempty"`
-
- // VolumeId: Volume that this review is for.
- VolumeId string `json:"volumeId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Author") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Review) MarshalJSON() ([]byte, error) {
- type noMethod Review
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReviewAuthor: Author of this review.
-type ReviewAuthor struct {
- // DisplayName: Name of this person.
- DisplayName string `json:"displayName,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DisplayName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReviewAuthor) MarshalJSON() ([]byte, error) {
- type noMethod ReviewAuthor
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReviewSource: Information regarding the source of this review, when
-// the review is not from a Google Books user.
-type ReviewSource struct {
- // Description: Name of the source.
- Description string `json:"description,omitempty"`
-
- // ExtraDescription: Extra text about the source of the review.
- ExtraDescription string `json:"extraDescription,omitempty"`
-
- // Url: URL of the source of the review.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Description") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReviewSource) MarshalJSON() ([]byte, error) {
- type noMethod ReviewSource
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Usersettings struct {
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // NotesExport: User settings in sub-objects, each for different
- // purposes.
- NotesExport *UsersettingsNotesExport `json:"notesExport,omitempty"`
-
- Notification *UsersettingsNotification `json:"notification,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Usersettings) MarshalJSON() ([]byte, error) {
- type noMethod Usersettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UsersettingsNotesExport: User settings in sub-objects, each for
-// different purposes.
-type UsersettingsNotesExport struct {
- FolderName string `json:"folderName,omitempty"`
-
- IsEnabled bool `json:"isEnabled,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "FolderName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UsersettingsNotesExport) MarshalJSON() ([]byte, error) {
- type noMethod UsersettingsNotesExport
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UsersettingsNotification struct {
- MoreFromAuthors *UsersettingsNotificationMoreFromAuthors `json:"moreFromAuthors,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "MoreFromAuthors") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UsersettingsNotification) MarshalJSON() ([]byte, error) {
- type noMethod UsersettingsNotification
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UsersettingsNotificationMoreFromAuthors struct {
- OptedState string `json:"opted_state,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "OptedState") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UsersettingsNotificationMoreFromAuthors) MarshalJSON() ([]byte, error) {
- type noMethod UsersettingsNotificationMoreFromAuthors
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Volume struct {
- // AccessInfo: Any information about a volume related to reading or
- // obtaining that volume text. This information can depend on country
- // (books may be public domain in one country but not in another, e.g.).
- AccessInfo *VolumeAccessInfo `json:"accessInfo,omitempty"`
-
- // Etag: Opaque identifier for a specific version of a volume resource.
- // (In LITE projection)
- Etag string `json:"etag,omitempty"`
-
- // Id: Unique identifier for a volume. (In LITE projection.)
- Id string `json:"id,omitempty"`
-
- // Kind: Resource type for a volume. (In LITE projection.)
- Kind string `json:"kind,omitempty"`
-
- // LayerInfo: What layers exist in this volume and high level
- // information about them.
- LayerInfo *VolumeLayerInfo `json:"layerInfo,omitempty"`
-
- // RecommendedInfo: Recommendation related information for this volume.
- RecommendedInfo *VolumeRecommendedInfo `json:"recommendedInfo,omitempty"`
-
- // SaleInfo: Any information about a volume related to the eBookstore
- // and/or purchaseability. This information can depend on the country
- // where the request originates from (i.e. books may not be for sale in
- // certain countries).
- SaleInfo *VolumeSaleInfo `json:"saleInfo,omitempty"`
-
- // SearchInfo: Search result information related to this volume.
- SearchInfo *VolumeSearchInfo `json:"searchInfo,omitempty"`
-
- // SelfLink: URL to this resource. (In LITE projection.)
- SelfLink string `json:"selfLink,omitempty"`
-
- // UserInfo: User specific information related to this volume. (e.g.
- // page this user last read or whether they purchased this book)
- UserInfo *VolumeUserInfo `json:"userInfo,omitempty"`
-
- // VolumeInfo: General volume information.
- VolumeInfo *VolumeVolumeInfo `json:"volumeInfo,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccessInfo") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Volume) MarshalJSON() ([]byte, error) {
- type noMethod Volume
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// VolumeAccessInfo: Any information about a volume related to reading
-// or obtaining that volume text. This information can depend on country
-// (books may be public domain in one country but not in another, e.g.).
-type VolumeAccessInfo struct {
- // AccessViewStatus: Combines the access and viewability of this volume
- // into a single status field for this user. Values can be
- // FULL_PURCHASED, FULL_PUBLIC_DOMAIN, SAMPLE or NONE. (In LITE
- // projection.)
- AccessViewStatus string `json:"accessViewStatus,omitempty"`
-
- // Country: The two-letter ISO_3166-1 country code for which this access
- // information is valid. (In LITE projection.)
- Country string `json:"country,omitempty"`
-
- // DownloadAccess: Information about a volume's download license access
- // restrictions.
- DownloadAccess *DownloadAccessRestriction `json:"downloadAccess,omitempty"`
-
- // DriveImportedContentLink: URL to the Google Drive viewer if this
- // volume is uploaded by the user by selecting the file from Google
- // Drive.
- DriveImportedContentLink string `json:"driveImportedContentLink,omitempty"`
-
- // Embeddable: Whether this volume can be embedded in a viewport using
- // the Embedded Viewer API.
- Embeddable bool `json:"embeddable,omitempty"`
-
- // Epub: Information about epub content. (In LITE projection.)
- Epub *VolumeAccessInfoEpub `json:"epub,omitempty"`
-
- // ExplicitOfflineLicenseManagement: Whether this volume requires that
- // the client explicitly request offline download license rather than
- // have it done automatically when loading the content, if the client
- // supports it.
- ExplicitOfflineLicenseManagement bool `json:"explicitOfflineLicenseManagement,omitempty"`
-
- // Pdf: Information about pdf content. (In LITE projection.)
- Pdf *VolumeAccessInfoPdf `json:"pdf,omitempty"`
-
- // PublicDomain: Whether or not this book is public domain in the
- // country listed above.
- PublicDomain bool `json:"publicDomain,omitempty"`
-
- // QuoteSharingAllowed: Whether quote sharing is allowed for this
- // volume.
- QuoteSharingAllowed bool `json:"quoteSharingAllowed,omitempty"`
-
- // TextToSpeechPermission: Whether text-to-speech is permitted for this
- // volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or
- // NOT_ALLOWED.
- TextToSpeechPermission string `json:"textToSpeechPermission,omitempty"`
-
- // ViewOrderUrl: For ordered but not yet processed orders, we give a URL
- // that can be used to go to the appropriate Google Wallet page.
- ViewOrderUrl string `json:"viewOrderUrl,omitempty"`
-
- // Viewability: The read access of a volume. Possible values are
- // PARTIAL, ALL_PAGES, NO_PAGES or UNKNOWN. This value depends on the
- // country listed above. A value of PARTIAL means that the publisher has
- // allowed some portion of the volume to be viewed publicly, without
- // purchase. This can apply to eBooks as well as non-eBooks. Public
- // domain books will always have a value of ALL_PAGES.
- Viewability string `json:"viewability,omitempty"`
-
- // WebReaderLink: URL to read this volume on the Google Books site. Link
- // will not allow users to read non-viewable volumes.
- WebReaderLink string `json:"webReaderLink,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AccessViewStatus") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VolumeAccessInfo) MarshalJSON() ([]byte, error) {
- type noMethod VolumeAccessInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// VolumeAccessInfoEpub: Information about epub content. (In LITE
-// projection.)
-type VolumeAccessInfoEpub struct {
- // AcsTokenLink: URL to retrieve ACS token for epub download. (In LITE
- // projection.)
- AcsTokenLink string `json:"acsTokenLink,omitempty"`
-
- // DownloadLink: URL to download epub. (In LITE projection.)
- DownloadLink string `json:"downloadLink,omitempty"`
-
- // IsAvailable: Is a flowing text epub available either as public domain
- // or for purchase. (In LITE projection.)
- IsAvailable bool `json:"isAvailable,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AcsTokenLink") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VolumeAccessInfoEpub) MarshalJSON() ([]byte, error) {
- type noMethod VolumeAccessInfoEpub
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// VolumeAccessInfoPdf: Information about pdf content. (In LITE
-// projection.)
-type VolumeAccessInfoPdf struct {
- // AcsTokenLink: URL to retrieve ACS token for pdf download. (In LITE
- // projection.)
- AcsTokenLink string `json:"acsTokenLink,omitempty"`
-
- // DownloadLink: URL to download pdf. (In LITE projection.)
- DownloadLink string `json:"downloadLink,omitempty"`
-
- // IsAvailable: Is a scanned image pdf available either as public domain
- // or for purchase. (In LITE projection.)
- IsAvailable bool `json:"isAvailable,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AcsTokenLink") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VolumeAccessInfoPdf) MarshalJSON() ([]byte, error) {
- type noMethod VolumeAccessInfoPdf
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// VolumeLayerInfo: What layers exist in this volume and high level
-// information about them.
-type VolumeLayerInfo struct {
- // Layers: A layer should appear here if and only if the layer exists
- // for this book.
- Layers []*VolumeLayerInfoLayers `json:"layers,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Layers") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VolumeLayerInfo) MarshalJSON() ([]byte, error) {
- type noMethod VolumeLayerInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type VolumeLayerInfoLayers struct {
- // LayerId: The layer id of this layer (e.g. "geo").
- LayerId string `json:"layerId,omitempty"`
-
- // VolumeAnnotationsVersion: The current version of this layer's volume
- // annotations. Note that this version applies only to the data in the
- // books.layers.volumeAnnotations.* responses. The actual annotation
- // data is versioned separately.
- VolumeAnnotationsVersion string `json:"volumeAnnotationsVersion,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "LayerId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VolumeLayerInfoLayers) MarshalJSON() ([]byte, error) {
- type noMethod VolumeLayerInfoLayers
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// VolumeRecommendedInfo: Recommendation related information for this
-// volume.
-type VolumeRecommendedInfo struct {
- // Explanation: A text explaining why this volume is recommended.
- Explanation string `json:"explanation,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Explanation") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VolumeRecommendedInfo) MarshalJSON() ([]byte, error) {
- type noMethod VolumeRecommendedInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// VolumeSaleInfo: Any information about a volume related to the
-// eBookstore and/or purchaseability. This information can depend on the
-// country where the request originates from (i.e. books may not be for
-// sale in certain countries).
-type VolumeSaleInfo struct {
- // BuyLink: URL to purchase this volume on the Google Books site. (In
- // LITE projection)
- BuyLink string `json:"buyLink,omitempty"`
-
- // Country: The two-letter ISO_3166-1 country code for which this sale
- // information is valid. (In LITE projection.)
- Country string `json:"country,omitempty"`
-
- // IsEbook: Whether or not this volume is an eBook (can be added to the
- // My eBooks shelf).
- IsEbook bool `json:"isEbook,omitempty"`
-
- // ListPrice: Suggested retail price. (In LITE projection.)
- ListPrice *VolumeSaleInfoListPrice `json:"listPrice,omitempty"`
-
- // Offers: Offers available for this volume (sales and rentals).
- Offers []*VolumeSaleInfoOffers `json:"offers,omitempty"`
-
- // OnSaleDate: The date on which this book is available for sale.
- OnSaleDate string `json:"onSaleDate,omitempty"`
-
- // RetailPrice: The actual selling price of the book. This is the same
- // as the suggested retail or list price unless there are offers or
- // discounts on this volume. (In LITE projection.)
- RetailPrice *VolumeSaleInfoRetailPrice `json:"retailPrice,omitempty"`
-
- // Saleability: Whether or not this book is available for sale or
- // offered for free in the Google eBookstore for the country listed
- // above. Possible values are FOR_SALE, FOR_RENTAL_ONLY,
- // FOR_SALE_AND_RENTAL, FREE, NOT_FOR_SALE, or FOR_PREORDER.
- Saleability string `json:"saleability,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BuyLink") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VolumeSaleInfo) MarshalJSON() ([]byte, error) {
- type noMethod VolumeSaleInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// VolumeSaleInfoListPrice: Suggested retail price. (In LITE
-// projection.)
-type VolumeSaleInfoListPrice struct {
- // Amount: Amount in the currency listed below. (In LITE projection.)
- Amount float64 `json:"amount,omitempty"`
-
- // CurrencyCode: An ISO 4217, three-letter currency code. (In LITE
- // projection.)
- CurrencyCode string `json:"currencyCode,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Amount") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VolumeSaleInfoListPrice) MarshalJSON() ([]byte, error) {
- type noMethod VolumeSaleInfoListPrice
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type VolumeSaleInfoOffers struct {
- // FinskyOfferType: The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
- FinskyOfferType int64 `json:"finskyOfferType,omitempty"`
-
- // ListPrice: Offer list (=undiscounted) price in Micros.
- ListPrice *VolumeSaleInfoOffersListPrice `json:"listPrice,omitempty"`
-
- // RentalDuration: The rental duration (for rental offers only).
- RentalDuration *VolumeSaleInfoOffersRentalDuration `json:"rentalDuration,omitempty"`
-
- // RetailPrice: Offer retail (=discounted) price in Micros
- RetailPrice *VolumeSaleInfoOffersRetailPrice `json:"retailPrice,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "FinskyOfferType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VolumeSaleInfoOffers) MarshalJSON() ([]byte, error) {
- type noMethod VolumeSaleInfoOffers
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// VolumeSaleInfoOffersListPrice: Offer list (=undiscounted) price in
-// Micros.
-type VolumeSaleInfoOffersListPrice struct {
- AmountInMicros float64 `json:"amountInMicros,omitempty"`
-
- CurrencyCode string `json:"currencyCode,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AmountInMicros") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VolumeSaleInfoOffersListPrice) MarshalJSON() ([]byte, error) {
- type noMethod VolumeSaleInfoOffersListPrice
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// VolumeSaleInfoOffersRentalDuration: The rental duration (for rental
-// offers only).
-type VolumeSaleInfoOffersRentalDuration struct {
- Count float64 `json:"count,omitempty"`
-
- Unit string `json:"unit,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Count") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VolumeSaleInfoOffersRentalDuration) MarshalJSON() ([]byte, error) {
- type noMethod VolumeSaleInfoOffersRentalDuration
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// VolumeSaleInfoOffersRetailPrice: Offer retail (=discounted) price in
-// Micros
-type VolumeSaleInfoOffersRetailPrice struct {
- AmountInMicros float64 `json:"amountInMicros,omitempty"`
-
- CurrencyCode string `json:"currencyCode,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AmountInMicros") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VolumeSaleInfoOffersRetailPrice) MarshalJSON() ([]byte, error) {
- type noMethod VolumeSaleInfoOffersRetailPrice
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// VolumeSaleInfoRetailPrice: The actual selling price of the book. This
-// is the same as the suggested retail or list price unless there are
-// offers or discounts on this volume. (In LITE projection.)
-type VolumeSaleInfoRetailPrice struct {
- // Amount: Amount in the currency listed below. (In LITE projection.)
- Amount float64 `json:"amount,omitempty"`
-
- // CurrencyCode: An ISO 4217, three-letter currency code. (In LITE
- // projection.)
- CurrencyCode string `json:"currencyCode,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Amount") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VolumeSaleInfoRetailPrice) MarshalJSON() ([]byte, error) {
- type noMethod VolumeSaleInfoRetailPrice
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// VolumeSearchInfo: Search result information related to this volume.
-type VolumeSearchInfo struct {
- // TextSnippet: A text snippet containing the search query.
- TextSnippet string `json:"textSnippet,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "TextSnippet") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VolumeSearchInfo) MarshalJSON() ([]byte, error) {
- type noMethod VolumeSearchInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// VolumeUserInfo: User specific information related to this volume.
-// (e.g. page this user last read or whether they purchased this book)
-type VolumeUserInfo struct {
- // AcquisitionType: How this volume was acquired.
- AcquisitionType int64 `json:"acquisitionType,omitempty"`
-
- // Copy: Copy/Paste accounting information.
- Copy *VolumeUserInfoCopy `json:"copy,omitempty"`
-
- // EntitlementType: Whether this volume is purchased, sample, pd
- // download etc.
- EntitlementType int64 `json:"entitlementType,omitempty"`
-
- // IsInMyBooks: Whether or not this volume is currently in "my books."
- IsInMyBooks bool `json:"isInMyBooks,omitempty"`
-
- // IsPreordered: Whether or not this volume was pre-ordered by the
- // authenticated user making the request. (In LITE projection.)
- IsPreordered bool `json:"isPreordered,omitempty"`
-
- // IsPurchased: Whether or not this volume was purchased by the
- // authenticated user making the request. (In LITE projection.)
- IsPurchased bool `json:"isPurchased,omitempty"`
-
- // IsUploaded: Whether or not this volume was user uploaded.
- IsUploaded bool `json:"isUploaded,omitempty"`
-
- // ReadingPosition: The user's current reading position in the volume,
- // if one is available. (In LITE projection.)
- ReadingPosition *ReadingPosition `json:"readingPosition,omitempty"`
-
- // RentalPeriod: Period during this book is/was a valid rental.
- RentalPeriod *VolumeUserInfoRentalPeriod `json:"rentalPeriod,omitempty"`
-
- // RentalState: Whether this book is an active or an expired rental.
- RentalState string `json:"rentalState,omitempty"`
-
- // Review: This user's review of this volume, if one exists.
- Review *Review `json:"review,omitempty"`
-
- // Updated: Timestamp when this volume was last modified by a user
- // action, such as a reading position update, volume purchase or writing
- // a review. (RFC 3339 UTC date-time format).
- Updated string `json:"updated,omitempty"`
-
- UserUploadedVolumeInfo *VolumeUserInfoUserUploadedVolumeInfo `json:"userUploadedVolumeInfo,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AcquisitionType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VolumeUserInfo) MarshalJSON() ([]byte, error) {
- type noMethod VolumeUserInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// VolumeUserInfoCopy: Copy/Paste accounting information.
-type VolumeUserInfoCopy struct {
- AllowedCharacterCount int64 `json:"allowedCharacterCount,omitempty"`
-
- LimitType string `json:"limitType,omitempty"`
-
- RemainingCharacterCount int64 `json:"remainingCharacterCount,omitempty"`
-
- Updated string `json:"updated,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "AllowedCharacterCount") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VolumeUserInfoCopy) MarshalJSON() ([]byte, error) {
- type noMethod VolumeUserInfoCopy
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// VolumeUserInfoRentalPeriod: Period during this book is/was a valid
-// rental.
-type VolumeUserInfoRentalPeriod struct {
- EndUtcSec int64 `json:"endUtcSec,omitempty,string"`
-
- StartUtcSec int64 `json:"startUtcSec,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "EndUtcSec") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VolumeUserInfoRentalPeriod) MarshalJSON() ([]byte, error) {
- type noMethod VolumeUserInfoRentalPeriod
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type VolumeUserInfoUserUploadedVolumeInfo struct {
- ProcessingState string `json:"processingState,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ProcessingState") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VolumeUserInfoUserUploadedVolumeInfo) MarshalJSON() ([]byte, error) {
- type noMethod VolumeUserInfoUserUploadedVolumeInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// VolumeVolumeInfo: General volume information.
-type VolumeVolumeInfo struct {
- // AllowAnonLogging: Whether anonymous logging should be allowed.
- AllowAnonLogging bool `json:"allowAnonLogging,omitempty"`
-
- // Authors: The names of the authors and/or editors for this volume. (In
- // LITE projection)
- Authors []string `json:"authors,omitempty"`
-
- // AverageRating: The mean review rating for this volume. (min = 1.0,
- // max = 5.0)
- AverageRating float64 `json:"averageRating,omitempty"`
-
- // CanonicalVolumeLink: Canonical URL for a volume. (In LITE
- // projection.)
- CanonicalVolumeLink string `json:"canonicalVolumeLink,omitempty"`
-
- // Categories: A list of subject categories, such as "Fiction",
- // "Suspense", etc.
- Categories []string `json:"categories,omitempty"`
-
- // ContentVersion: An identifier for the version of the volume content
- // (text & images). (In LITE projection)
- ContentVersion string `json:"contentVersion,omitempty"`
-
- // Description: A synopsis of the volume. The text of the description is
- // formatted in HTML and includes simple formatting elements, such as b,
- // i, and br tags. (In LITE projection.)
- Description string `json:"description,omitempty"`
-
- // Dimensions: Physical dimensions of this volume.
- Dimensions *VolumeVolumeInfoDimensions `json:"dimensions,omitempty"`
-
- // ImageLinks: A list of image links for all the sizes that are
- // available. (In LITE projection.)
- ImageLinks *VolumeVolumeInfoImageLinks `json:"imageLinks,omitempty"`
-
- // IndustryIdentifiers: Industry standard identifiers for this volume.
- IndustryIdentifiers []*VolumeVolumeInfoIndustryIdentifiers `json:"industryIdentifiers,omitempty"`
-
- // InfoLink: URL to view information about this volume on the Google
- // Books site. (In LITE projection)
- InfoLink string `json:"infoLink,omitempty"`
-
- // Language: Best language for this volume (based on content). It is the
- // two-letter ISO 639-1 code such as 'fr', 'en', etc.
- Language string `json:"language,omitempty"`
-
- // MainCategory: The main category to which this volume belongs. It will
- // be the category from the categories list returned below that has the
- // highest weight.
- MainCategory string `json:"mainCategory,omitempty"`
-
- MaturityRating string `json:"maturityRating,omitempty"`
-
- // PageCount: Total number of pages as per publisher metadata.
- PageCount int64 `json:"pageCount,omitempty"`
-
- // PreviewLink: URL to preview this volume on the Google Books site.
- PreviewLink string `json:"previewLink,omitempty"`
-
- // PrintType: Type of publication of this volume. Possible values are
- // BOOK or MAGAZINE.
- PrintType string `json:"printType,omitempty"`
-
- // PrintedPageCount: Total number of printed pages in generated pdf
- // representation.
- PrintedPageCount int64 `json:"printedPageCount,omitempty"`
-
- // PublishedDate: Date of publication. (In LITE projection.)
- PublishedDate string `json:"publishedDate,omitempty"`
-
- // Publisher: Publisher of this volume. (In LITE projection.)
- Publisher string `json:"publisher,omitempty"`
-
- // RatingsCount: The number of review ratings for this volume.
- RatingsCount int64 `json:"ratingsCount,omitempty"`
-
- // ReadingModes: The reading modes available for this volume.
- ReadingModes interface{} `json:"readingModes,omitempty"`
-
- // SamplePageCount: Total number of sample pages as per publisher
- // metadata.
- SamplePageCount int64 `json:"samplePageCount,omitempty"`
-
- // Subtitle: Volume subtitle. (In LITE projection.)
- Subtitle string `json:"subtitle,omitempty"`
-
- // Title: Volume title. (In LITE projection.)
- Title string `json:"title,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AllowAnonLogging") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VolumeVolumeInfo) MarshalJSON() ([]byte, error) {
- type noMethod VolumeVolumeInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// VolumeVolumeInfoDimensions: Physical dimensions of this volume.
-type VolumeVolumeInfoDimensions struct {
- // Height: Height or length of this volume (in cm).
- Height string `json:"height,omitempty"`
-
- // Thickness: Thickness of this volume (in cm).
- Thickness string `json:"thickness,omitempty"`
-
- // Width: Width of this volume (in cm).
- Width string `json:"width,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Height") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VolumeVolumeInfoDimensions) MarshalJSON() ([]byte, error) {
- type noMethod VolumeVolumeInfoDimensions
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// VolumeVolumeInfoImageLinks: A list of image links for all the sizes
-// that are available. (In LITE projection.)
-type VolumeVolumeInfoImageLinks struct {
- // ExtraLarge: Image link for extra large size (width of ~1280 pixels).
- // (In LITE projection)
- ExtraLarge string `json:"extraLarge,omitempty"`
-
- // Large: Image link for large size (width of ~800 pixels). (In LITE
- // projection)
- Large string `json:"large,omitempty"`
-
- // Medium: Image link for medium size (width of ~575 pixels). (In LITE
- // projection)
- Medium string `json:"medium,omitempty"`
-
- // Small: Image link for small size (width of ~300 pixels). (In LITE
- // projection)
- Small string `json:"small,omitempty"`
-
- // SmallThumbnail: Image link for small thumbnail size (width of ~80
- // pixels). (In LITE projection)
- SmallThumbnail string `json:"smallThumbnail,omitempty"`
-
- // Thumbnail: Image link for thumbnail size (width of ~128 pixels). (In
- // LITE projection)
- Thumbnail string `json:"thumbnail,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ExtraLarge") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VolumeVolumeInfoImageLinks) MarshalJSON() ([]byte, error) {
- type noMethod VolumeVolumeInfoImageLinks
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type VolumeVolumeInfoIndustryIdentifiers struct {
- // Identifier: Industry specific volume identifier.
- Identifier string `json:"identifier,omitempty"`
-
- // Type: Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and
- // OTHER.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Identifier") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VolumeVolumeInfoIndustryIdentifiers) MarshalJSON() ([]byte, error) {
- type noMethod VolumeVolumeInfoIndustryIdentifiers
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Volume2 struct {
- // Items: A list of volumes.
- Items []*Volume `json:"items,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Volume2) MarshalJSON() ([]byte, error) {
- type noMethod Volume2
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Volumeannotation struct {
- // AnnotationDataId: The annotation data id for this volume annotation.
- AnnotationDataId string `json:"annotationDataId,omitempty"`
-
- // AnnotationDataLink: Link to get data for this annotation.
- AnnotationDataLink string `json:"annotationDataLink,omitempty"`
-
- // AnnotationType: The type of annotation this is.
- AnnotationType string `json:"annotationType,omitempty"`
-
- // ContentRanges: The content ranges to identify the selected text.
- ContentRanges *VolumeannotationContentRanges `json:"contentRanges,omitempty"`
-
- // Data: Data for this annotation.
- Data string `json:"data,omitempty"`
-
- // Deleted: Indicates that this annotation is deleted.
- Deleted bool `json:"deleted,omitempty"`
-
- // Id: Unique id of this volume annotation.
- Id string `json:"id,omitempty"`
-
- // Kind: Resource Type
- Kind string `json:"kind,omitempty"`
-
- // LayerId: The Layer this annotation is for.
- LayerId string `json:"layerId,omitempty"`
-
- // PageIds: Pages the annotation spans.
- PageIds []string `json:"pageIds,omitempty"`
-
- // SelectedText: Excerpt from the volume.
- SelectedText string `json:"selectedText,omitempty"`
-
- // SelfLink: URL to this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Updated: Timestamp for the last time this anntoation was updated.
- // (RFC 3339 UTC date-time format).
- Updated string `json:"updated,omitempty"`
-
- // VolumeId: The Volume this annotation is for.
- VolumeId string `json:"volumeId,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AnnotationDataId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Volumeannotation) MarshalJSON() ([]byte, error) {
- type noMethod Volumeannotation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// VolumeannotationContentRanges: The content ranges to identify the
-// selected text.
-type VolumeannotationContentRanges struct {
- // CfiRange: Range in CFI format for this annotation for version above.
- CfiRange *BooksAnnotationsRange `json:"cfiRange,omitempty"`
-
- // ContentVersion: Content version applicable to ranges below.
- ContentVersion string `json:"contentVersion,omitempty"`
-
- // GbImageRange: Range in GB image format for this annotation for
- // version above.
- GbImageRange *BooksAnnotationsRange `json:"gbImageRange,omitempty"`
-
- // GbTextRange: Range in GB text format for this annotation for version
- // above.
- GbTextRange *BooksAnnotationsRange `json:"gbTextRange,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CfiRange") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VolumeannotationContentRanges) MarshalJSON() ([]byte, error) {
- type noMethod VolumeannotationContentRanges
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Volumeannotations struct {
- // Items: A list of volume annotations.
- Items []*Volumeannotation `json:"items,omitempty"`
-
- // Kind: Resource type
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Token to pass in for pagination for the next page.
- // This will not be present if this request does not have more results.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // TotalItems: The total number of volume annotations found.
- TotalItems int64 `json:"totalItems,omitempty"`
-
- // Version: The version string for all of the volume annotations in this
- // layer (not just the ones in this response). Note: the version string
- // doesn't apply to the annotation data, just the information in this
- // response (e.g. the location of annotations in the book).
- Version string `json:"version,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Volumeannotations) MarshalJSON() ([]byte, error) {
- type noMethod Volumeannotations
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Volumes struct {
- // Items: A list of volumes.
- Items []*Volume `json:"items,omitempty"`
-
- // Kind: Resource type.
- Kind string `json:"kind,omitempty"`
-
- // TotalItems: Total number of volumes found. This might be greater than
- // the number of volumes returned in this response if results have been
- // paginated.
- TotalItems int64 `json:"totalItems,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Volumes) MarshalJSON() ([]byte, error) {
- type noMethod Volumes
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "books.bookshelves.get":
-
-type BookshelvesGetCall struct {
- s *Service
- userId string
- shelf string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves metadata for a specific bookshelf for the specified
-// user.
-func (r *BookshelvesService) Get(userId string, shelf string) *BookshelvesGetCall {
- c := &BookshelvesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.userId = userId
- c.shelf = shelf
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *BookshelvesGetCall) Source(source string) *BookshelvesGetCall {
- c.opt_["source"] = source
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BookshelvesGetCall) Fields(s ...googleapi.Field) *BookshelvesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *BookshelvesGetCall) IfNoneMatch(entityTag string) *BookshelvesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BookshelvesGetCall) Context(ctx context.Context) *BookshelvesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BookshelvesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userId}/bookshelves/{shelf}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userId": c.userId,
- "shelf": c.shelf,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.bookshelves.get" call.
-// Exactly one of *Bookshelf or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Bookshelf.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *BookshelvesGetCall) Do() (*Bookshelf, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Bookshelf{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves metadata for a specific bookshelf for the specified user.",
- // "httpMethod": "GET",
- // "id": "books.bookshelves.get",
- // "parameterOrder": [
- // "userId",
- // "shelf"
- // ],
- // "parameters": {
- // "shelf": {
- // "description": "ID of bookshelf to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // },
- // "userId": {
- // "description": "ID of user for whom to retrieve bookshelves.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userId}/bookshelves/{shelf}",
- // "response": {
- // "$ref": "Bookshelf"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.bookshelves.list":
-
-type BookshelvesListCall struct {
- s *Service
- userId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of public bookshelves for the specified user.
-func (r *BookshelvesService) List(userId string) *BookshelvesListCall {
- c := &BookshelvesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.userId = userId
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *BookshelvesListCall) Source(source string) *BookshelvesListCall {
- c.opt_["source"] = source
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BookshelvesListCall) Fields(s ...googleapi.Field) *BookshelvesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *BookshelvesListCall) IfNoneMatch(entityTag string) *BookshelvesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BookshelvesListCall) Context(ctx context.Context) *BookshelvesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BookshelvesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userId}/bookshelves")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userId": c.userId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.bookshelves.list" call.
-// Exactly one of *Bookshelves or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Bookshelves.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *BookshelvesListCall) Do() (*Bookshelves, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Bookshelves{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of public bookshelves for the specified user.",
- // "httpMethod": "GET",
- // "id": "books.bookshelves.list",
- // "parameterOrder": [
- // "userId"
- // ],
- // "parameters": {
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // },
- // "userId": {
- // "description": "ID of user for whom to retrieve bookshelves.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userId}/bookshelves",
- // "response": {
- // "$ref": "Bookshelves"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.bookshelves.volumes.list":
-
-type BookshelvesVolumesListCall struct {
- s *Service
- userId string
- shelf string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves volumes in a specific bookshelf for the specified
-// user.
-func (r *BookshelvesVolumesService) List(userId string, shelf string) *BookshelvesVolumesListCall {
- c := &BookshelvesVolumesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.userId = userId
- c.shelf = shelf
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return
-func (c *BookshelvesVolumesListCall) MaxResults(maxResults int64) *BookshelvesVolumesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// ShowPreorders sets the optional parameter "showPreorders": Set to
-// true to show pre-ordered books. Defaults to false.
-func (c *BookshelvesVolumesListCall) ShowPreorders(showPreorders bool) *BookshelvesVolumesListCall {
- c.opt_["showPreorders"] = showPreorders
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *BookshelvesVolumesListCall) Source(source string) *BookshelvesVolumesListCall {
- c.opt_["source"] = source
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex": Index of the
-// first element to return (starts at 0)
-func (c *BookshelvesVolumesListCall) StartIndex(startIndex int64) *BookshelvesVolumesListCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BookshelvesVolumesListCall) Fields(s ...googleapi.Field) *BookshelvesVolumesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *BookshelvesVolumesListCall) IfNoneMatch(entityTag string) *BookshelvesVolumesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BookshelvesVolumesListCall) Context(ctx context.Context) *BookshelvesVolumesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BookshelvesVolumesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["showPreorders"]; ok {
- params.Set("showPreorders", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/{userId}/bookshelves/{shelf}/volumes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userId": c.userId,
- "shelf": c.shelf,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.bookshelves.volumes.list" call.
-// Exactly one of *Volumes or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Volumes.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *BookshelvesVolumesListCall) Do() (*Volumes, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Volumes{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves volumes in a specific bookshelf for the specified user.",
- // "httpMethod": "GET",
- // "id": "books.bookshelves.volumes.list",
- // "parameterOrder": [
- // "userId",
- // "shelf"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of results to return",
- // "format": "uint32",
- // "location": "query",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "shelf": {
- // "description": "ID of bookshelf to retrieve volumes.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "showPreorders": {
- // "description": "Set to true to show pre-ordered books. Defaults to false.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // },
- // "startIndex": {
- // "description": "Index of the first element to return (starts at 0)",
- // "format": "uint32",
- // "location": "query",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "userId": {
- // "description": "ID of user for whom to retrieve bookshelf volumes.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/{userId}/bookshelves/{shelf}/volumes",
- // "response": {
- // "$ref": "Volumes"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.cloudloading.addBook":
-
-type CloudloadingAddBookCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AddBook:
-func (r *CloudloadingService) AddBook() *CloudloadingAddBookCall {
- c := &CloudloadingAddBookCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// DriveDocumentId sets the optional parameter "drive_document_id": A
-// drive document id. The upload_client_token must not be set.
-func (c *CloudloadingAddBookCall) DriveDocumentId(driveDocumentId string) *CloudloadingAddBookCall {
- c.opt_["drive_document_id"] = driveDocumentId
- return c
-}
-
-// MimeType sets the optional parameter "mime_type": The document MIME
-// type. It can be set only if the drive_document_id is set.
-func (c *CloudloadingAddBookCall) MimeType(mimeType string) *CloudloadingAddBookCall {
- c.opt_["mime_type"] = mimeType
- return c
-}
-
-// Name sets the optional parameter "name": The document name. It can be
-// set only if the drive_document_id is set.
-func (c *CloudloadingAddBookCall) Name(name string) *CloudloadingAddBookCall {
- c.opt_["name"] = name
- return c
-}
-
-// UploadClientToken sets the optional parameter "upload_client_token":
-func (c *CloudloadingAddBookCall) UploadClientToken(uploadClientToken string) *CloudloadingAddBookCall {
- c.opt_["upload_client_token"] = uploadClientToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CloudloadingAddBookCall) Fields(s ...googleapi.Field) *CloudloadingAddBookCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CloudloadingAddBookCall) Context(ctx context.Context) *CloudloadingAddBookCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CloudloadingAddBookCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["drive_document_id"]; ok {
- params.Set("drive_document_id", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["mime_type"]; ok {
- params.Set("mime_type", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["name"]; ok {
- params.Set("name", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["upload_client_token"]; ok {
- params.Set("upload_client_token", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "cloudloading/addBook")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.cloudloading.addBook" call.
-// Exactly one of *BooksCloudloadingResource or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *BooksCloudloadingResource.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CloudloadingAddBookCall) Do() (*BooksCloudloadingResource, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &BooksCloudloadingResource{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "",
- // "httpMethod": "POST",
- // "id": "books.cloudloading.addBook",
- // "parameters": {
- // "drive_document_id": {
- // "description": "A drive document id. The upload_client_token must not be set.",
- // "location": "query",
- // "type": "string"
- // },
- // "mime_type": {
- // "description": "The document MIME type. It can be set only if the drive_document_id is set.",
- // "location": "query",
- // "type": "string"
- // },
- // "name": {
- // "description": "The document name. It can be set only if the drive_document_id is set.",
- // "location": "query",
- // "type": "string"
- // },
- // "upload_client_token": {
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "cloudloading/addBook",
- // "response": {
- // "$ref": "BooksCloudloadingResource"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.cloudloading.deleteBook":
-
-type CloudloadingDeleteBookCall struct {
- s *Service
- volumeId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// DeleteBook: Remove the book and its contents
-func (r *CloudloadingService) DeleteBook(volumeId string) *CloudloadingDeleteBookCall {
- c := &CloudloadingDeleteBookCall{s: r.s, opt_: make(map[string]interface{})}
- c.volumeId = volumeId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CloudloadingDeleteBookCall) Fields(s ...googleapi.Field) *CloudloadingDeleteBookCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CloudloadingDeleteBookCall) Context(ctx context.Context) *CloudloadingDeleteBookCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CloudloadingDeleteBookCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("volumeId", fmt.Sprintf("%v", c.volumeId))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "cloudloading/deleteBook")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.cloudloading.deleteBook" call.
-func (c *CloudloadingDeleteBookCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Remove the book and its contents",
- // "httpMethod": "POST",
- // "id": "books.cloudloading.deleteBook",
- // "parameterOrder": [
- // "volumeId"
- // ],
- // "parameters": {
- // "volumeId": {
- // "description": "The id of the book to be removed.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "cloudloading/deleteBook",
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.cloudloading.updateBook":
-
-type CloudloadingUpdateBookCall struct {
- s *Service
- bookscloudloadingresource *BooksCloudloadingResource
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// UpdateBook:
-func (r *CloudloadingService) UpdateBook(bookscloudloadingresource *BooksCloudloadingResource) *CloudloadingUpdateBookCall {
- c := &CloudloadingUpdateBookCall{s: r.s, opt_: make(map[string]interface{})}
- c.bookscloudloadingresource = bookscloudloadingresource
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CloudloadingUpdateBookCall) Fields(s ...googleapi.Field) *CloudloadingUpdateBookCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CloudloadingUpdateBookCall) Context(ctx context.Context) *CloudloadingUpdateBookCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CloudloadingUpdateBookCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.bookscloudloadingresource)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "cloudloading/updateBook")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.cloudloading.updateBook" call.
-// Exactly one of *BooksCloudloadingResource or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *BooksCloudloadingResource.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CloudloadingUpdateBookCall) Do() (*BooksCloudloadingResource, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &BooksCloudloadingResource{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "",
- // "httpMethod": "POST",
- // "id": "books.cloudloading.updateBook",
- // "path": "cloudloading/updateBook",
- // "request": {
- // "$ref": "BooksCloudloadingResource"
- // },
- // "response": {
- // "$ref": "BooksCloudloadingResource"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.dictionary.listOfflineMetadata":
-
-type DictionaryListOfflineMetadataCall struct {
- s *Service
- cpksver string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// ListOfflineMetadata: Returns a list of offline dictionary metadata
-// available
-func (r *DictionaryService) ListOfflineMetadata(cpksver string) *DictionaryListOfflineMetadataCall {
- c := &DictionaryListOfflineMetadataCall{s: r.s, opt_: make(map[string]interface{})}
- c.cpksver = cpksver
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DictionaryListOfflineMetadataCall) Fields(s ...googleapi.Field) *DictionaryListOfflineMetadataCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DictionaryListOfflineMetadataCall) IfNoneMatch(entityTag string) *DictionaryListOfflineMetadataCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DictionaryListOfflineMetadataCall) Context(ctx context.Context) *DictionaryListOfflineMetadataCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DictionaryListOfflineMetadataCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("cpksver", fmt.Sprintf("%v", c.cpksver))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "dictionary/listOfflineMetadata")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.dictionary.listOfflineMetadata" call.
-// Exactly one of *Metadata or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Metadata.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DictionaryListOfflineMetadataCall) Do() (*Metadata, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Metadata{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns a list of offline dictionary metadata available",
- // "httpMethod": "GET",
- // "id": "books.dictionary.listOfflineMetadata",
- // "parameterOrder": [
- // "cpksver"
- // ],
- // "parameters": {
- // "cpksver": {
- // "description": "The device/version ID from which to request the data.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "dictionary/listOfflineMetadata",
- // "response": {
- // "$ref": "Metadata"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.layers.get":
-
-type LayersGetCall struct {
- s *Service
- volumeId string
- summaryId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets the layer summary for a volume.
-func (r *LayersService) Get(volumeId string, summaryId string) *LayersGetCall {
- c := &LayersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.volumeId = volumeId
- c.summaryId = summaryId
- return c
-}
-
-// ContentVersion sets the optional parameter "contentVersion": The
-// content version for the requested volume.
-func (c *LayersGetCall) ContentVersion(contentVersion string) *LayersGetCall {
- c.opt_["contentVersion"] = contentVersion
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *LayersGetCall) Source(source string) *LayersGetCall {
- c.opt_["source"] = source
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LayersGetCall) Fields(s ...googleapi.Field) *LayersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *LayersGetCall) IfNoneMatch(entityTag string) *LayersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LayersGetCall) Context(ctx context.Context) *LayersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LayersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["contentVersion"]; ok {
- params.Set("contentVersion", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "volumes/{volumeId}/layersummary/{summaryId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "volumeId": c.volumeId,
- "summaryId": c.summaryId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.layers.get" call.
-// Exactly one of *Layersummary or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Layersummary.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *LayersGetCall) Do() (*Layersummary, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Layersummary{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the layer summary for a volume.",
- // "httpMethod": "GET",
- // "id": "books.layers.get",
- // "parameterOrder": [
- // "volumeId",
- // "summaryId"
- // ],
- // "parameters": {
- // "contentVersion": {
- // "description": "The content version for the requested volume.",
- // "location": "query",
- // "type": "string"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // },
- // "summaryId": {
- // "description": "The ID for the layer to get the summary for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "volumeId": {
- // "description": "The volume to retrieve layers for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "volumes/{volumeId}/layersummary/{summaryId}",
- // "response": {
- // "$ref": "Layersummary"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.layers.list":
-
-type LayersListCall struct {
- s *Service
- volumeId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List the layer summaries for a volume.
-func (r *LayersService) List(volumeId string) *LayersListCall {
- c := &LayersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.volumeId = volumeId
- return c
-}
-
-// ContentVersion sets the optional parameter "contentVersion": The
-// content version for the requested volume.
-func (c *LayersListCall) ContentVersion(contentVersion string) *LayersListCall {
- c.opt_["contentVersion"] = contentVersion
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return
-func (c *LayersListCall) MaxResults(maxResults int64) *LayersListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous page.
-func (c *LayersListCall) PageToken(pageToken string) *LayersListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *LayersListCall) Source(source string) *LayersListCall {
- c.opt_["source"] = source
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LayersListCall) Fields(s ...googleapi.Field) *LayersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *LayersListCall) IfNoneMatch(entityTag string) *LayersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LayersListCall) Context(ctx context.Context) *LayersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LayersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["contentVersion"]; ok {
- params.Set("contentVersion", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "volumes/{volumeId}/layersummary")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "volumeId": c.volumeId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.layers.list" call.
-// Exactly one of *Layersummaries or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Layersummaries.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *LayersListCall) Do() (*Layersummaries, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Layersummaries{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List the layer summaries for a volume.",
- // "httpMethod": "GET",
- // "id": "books.layers.list",
- // "parameterOrder": [
- // "volumeId"
- // ],
- // "parameters": {
- // "contentVersion": {
- // "description": "The content version for the requested volume.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "200",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous page.",
- // "location": "query",
- // "type": "string"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // },
- // "volumeId": {
- // "description": "The volume to retrieve layers for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "volumes/{volumeId}/layersummary",
- // "response": {
- // "$ref": "Layersummaries"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.layers.annotationData.get":
-
-type LayersAnnotationDataGetCall struct {
- s *Service
- volumeId string
- layerId string
- annotationDataId string
- contentVersion string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets the annotation data.
-func (r *LayersAnnotationDataService) Get(volumeId string, layerId string, annotationDataId string, contentVersion string) *LayersAnnotationDataGetCall {
- c := &LayersAnnotationDataGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.volumeId = volumeId
- c.layerId = layerId
- c.annotationDataId = annotationDataId
- c.contentVersion = contentVersion
- return c
-}
-
-// AllowWebDefinitions sets the optional parameter
-// "allowWebDefinitions": For the dictionary layer. Whether or not to
-// allow web definitions.
-func (c *LayersAnnotationDataGetCall) AllowWebDefinitions(allowWebDefinitions bool) *LayersAnnotationDataGetCall {
- c.opt_["allowWebDefinitions"] = allowWebDefinitions
- return c
-}
-
-// H sets the optional parameter "h": The requested pixel height for any
-// images. If height is provided width must also be provided.
-func (c *LayersAnnotationDataGetCall) H(h int64) *LayersAnnotationDataGetCall {
- c.opt_["h"] = h
- return c
-}
-
-// Locale sets the optional parameter "locale": The locale information
-// for the data. ISO-639-1 language and ISO-3166-1 country code. Ex:
-// 'en_US'.
-func (c *LayersAnnotationDataGetCall) Locale(locale string) *LayersAnnotationDataGetCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// Scale sets the optional parameter "scale": The requested scale for
-// the image.
-func (c *LayersAnnotationDataGetCall) Scale(scale int64) *LayersAnnotationDataGetCall {
- c.opt_["scale"] = scale
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *LayersAnnotationDataGetCall) Source(source string) *LayersAnnotationDataGetCall {
- c.opt_["source"] = source
- return c
-}
-
-// W sets the optional parameter "w": The requested pixel width for any
-// images. If width is provided height must also be provided.
-func (c *LayersAnnotationDataGetCall) W(w int64) *LayersAnnotationDataGetCall {
- c.opt_["w"] = w
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LayersAnnotationDataGetCall) Fields(s ...googleapi.Field) *LayersAnnotationDataGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *LayersAnnotationDataGetCall) IfNoneMatch(entityTag string) *LayersAnnotationDataGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LayersAnnotationDataGetCall) Context(ctx context.Context) *LayersAnnotationDataGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LayersAnnotationDataGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("contentVersion", fmt.Sprintf("%v", c.contentVersion))
- if v, ok := c.opt_["allowWebDefinitions"]; ok {
- params.Set("allowWebDefinitions", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["h"]; ok {
- params.Set("h", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["scale"]; ok {
- params.Set("scale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["w"]; ok {
- params.Set("w", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "volumes/{volumeId}/layers/{layerId}/data/{annotationDataId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "volumeId": c.volumeId,
- "layerId": c.layerId,
- "annotationDataId": c.annotationDataId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.layers.annotationData.get" call.
-// Exactly one of *Annotationdata or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Annotationdata.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *LayersAnnotationDataGetCall) Do() (*Annotationdata, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Annotationdata{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the annotation data.",
- // "httpMethod": "GET",
- // "id": "books.layers.annotationData.get",
- // "parameterOrder": [
- // "volumeId",
- // "layerId",
- // "annotationDataId",
- // "contentVersion"
- // ],
- // "parameters": {
- // "allowWebDefinitions": {
- // "description": "For the dictionary layer. Whether or not to allow web definitions.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "annotationDataId": {
- // "description": "The ID of the annotation data to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "contentVersion": {
- // "description": "The content version for the volume you are trying to retrieve.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "h": {
- // "description": "The requested pixel height for any images. If height is provided width must also be provided.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "layerId": {
- // "description": "The ID for the layer to get the annotations.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "locale": {
- // "description": "The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.",
- // "location": "query",
- // "type": "string"
- // },
- // "scale": {
- // "description": "The requested scale for the image.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // },
- // "volumeId": {
- // "description": "The volume to retrieve annotations for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "w": {
- // "description": "The requested pixel width for any images. If width is provided height must also be provided.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // }
- // },
- // "path": "volumes/{volumeId}/layers/{layerId}/data/{annotationDataId}",
- // "response": {
- // "$ref": "Annotationdata"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.layers.annotationData.list":
-
-type LayersAnnotationDataListCall struct {
- s *Service
- volumeId string
- layerId string
- contentVersion string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Gets the annotation data for a volume and layer.
-func (r *LayersAnnotationDataService) List(volumeId string, layerId string, contentVersion string) *LayersAnnotationDataListCall {
- c := &LayersAnnotationDataListCall{s: r.s, opt_: make(map[string]interface{})}
- c.volumeId = volumeId
- c.layerId = layerId
- c.contentVersion = contentVersion
- return c
-}
-
-// AnnotationDataId sets the optional parameter "annotationDataId": The
-// list of Annotation Data Ids to retrieve. Pagination is ignored if
-// this is set.
-func (c *LayersAnnotationDataListCall) AnnotationDataId(annotationDataId string) *LayersAnnotationDataListCall {
- c.opt_["annotationDataId"] = annotationDataId
- return c
-}
-
-// H sets the optional parameter "h": The requested pixel height for any
-// images. If height is provided width must also be provided.
-func (c *LayersAnnotationDataListCall) H(h int64) *LayersAnnotationDataListCall {
- c.opt_["h"] = h
- return c
-}
-
-// Locale sets the optional parameter "locale": The locale information
-// for the data. ISO-639-1 language and ISO-3166-1 country code. Ex:
-// 'en_US'.
-func (c *LayersAnnotationDataListCall) Locale(locale string) *LayersAnnotationDataListCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return
-func (c *LayersAnnotationDataListCall) MaxResults(maxResults int64) *LayersAnnotationDataListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous page.
-func (c *LayersAnnotationDataListCall) PageToken(pageToken string) *LayersAnnotationDataListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Scale sets the optional parameter "scale": The requested scale for
-// the image.
-func (c *LayersAnnotationDataListCall) Scale(scale int64) *LayersAnnotationDataListCall {
- c.opt_["scale"] = scale
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *LayersAnnotationDataListCall) Source(source string) *LayersAnnotationDataListCall {
- c.opt_["source"] = source
- return c
-}
-
-// UpdatedMax sets the optional parameter "updatedMax": RFC 3339
-// timestamp to restrict to items updated prior to this timestamp
-// (exclusive).
-func (c *LayersAnnotationDataListCall) UpdatedMax(updatedMax string) *LayersAnnotationDataListCall {
- c.opt_["updatedMax"] = updatedMax
- return c
-}
-
-// UpdatedMin sets the optional parameter "updatedMin": RFC 3339
-// timestamp to restrict to items updated since this timestamp
-// (inclusive).
-func (c *LayersAnnotationDataListCall) UpdatedMin(updatedMin string) *LayersAnnotationDataListCall {
- c.opt_["updatedMin"] = updatedMin
- return c
-}
-
-// W sets the optional parameter "w": The requested pixel width for any
-// images. If width is provided height must also be provided.
-func (c *LayersAnnotationDataListCall) W(w int64) *LayersAnnotationDataListCall {
- c.opt_["w"] = w
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LayersAnnotationDataListCall) Fields(s ...googleapi.Field) *LayersAnnotationDataListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *LayersAnnotationDataListCall) IfNoneMatch(entityTag string) *LayersAnnotationDataListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LayersAnnotationDataListCall) Context(ctx context.Context) *LayersAnnotationDataListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LayersAnnotationDataListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("contentVersion", fmt.Sprintf("%v", c.contentVersion))
- if v, ok := c.opt_["annotationDataId"]; ok {
- params.Set("annotationDataId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["h"]; ok {
- params.Set("h", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["scale"]; ok {
- params.Set("scale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["updatedMax"]; ok {
- params.Set("updatedMax", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["updatedMin"]; ok {
- params.Set("updatedMin", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["w"]; ok {
- params.Set("w", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "volumes/{volumeId}/layers/{layerId}/data")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "volumeId": c.volumeId,
- "layerId": c.layerId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.layers.annotationData.list" call.
-// Exactly one of *Annotationsdata or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Annotationsdata.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *LayersAnnotationDataListCall) Do() (*Annotationsdata, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Annotationsdata{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the annotation data for a volume and layer.",
- // "httpMethod": "GET",
- // "id": "books.layers.annotationData.list",
- // "parameterOrder": [
- // "volumeId",
- // "layerId",
- // "contentVersion"
- // ],
- // "parameters": {
- // "annotationDataId": {
- // "description": "The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set.",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "contentVersion": {
- // "description": "The content version for the requested volume.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "h": {
- // "description": "The requested pixel height for any images. If height is provided width must also be provided.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "layerId": {
- // "description": "The ID for the layer to get the annotation data.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "locale": {
- // "description": "The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "200",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous page.",
- // "location": "query",
- // "type": "string"
- // },
- // "scale": {
- // "description": "The requested scale for the image.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // },
- // "updatedMax": {
- // "description": "RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).",
- // "location": "query",
- // "type": "string"
- // },
- // "updatedMin": {
- // "description": "RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).",
- // "location": "query",
- // "type": "string"
- // },
- // "volumeId": {
- // "description": "The volume to retrieve annotation data for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "w": {
- // "description": "The requested pixel width for any images. If width is provided height must also be provided.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // }
- // },
- // "path": "volumes/{volumeId}/layers/{layerId}/data",
- // "response": {
- // "$ref": "Annotationsdata"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.layers.volumeAnnotations.get":
-
-type LayersVolumeAnnotationsGetCall struct {
- s *Service
- volumeId string
- layerId string
- annotationId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets the volume annotation.
-func (r *LayersVolumeAnnotationsService) Get(volumeId string, layerId string, annotationId string) *LayersVolumeAnnotationsGetCall {
- c := &LayersVolumeAnnotationsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.volumeId = volumeId
- c.layerId = layerId
- c.annotationId = annotationId
- return c
-}
-
-// Locale sets the optional parameter "locale": The locale information
-// for the data. ISO-639-1 language and ISO-3166-1 country code. Ex:
-// 'en_US'.
-func (c *LayersVolumeAnnotationsGetCall) Locale(locale string) *LayersVolumeAnnotationsGetCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *LayersVolumeAnnotationsGetCall) Source(source string) *LayersVolumeAnnotationsGetCall {
- c.opt_["source"] = source
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LayersVolumeAnnotationsGetCall) Fields(s ...googleapi.Field) *LayersVolumeAnnotationsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *LayersVolumeAnnotationsGetCall) IfNoneMatch(entityTag string) *LayersVolumeAnnotationsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LayersVolumeAnnotationsGetCall) Context(ctx context.Context) *LayersVolumeAnnotationsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LayersVolumeAnnotationsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "volumes/{volumeId}/layers/{layerId}/annotations/{annotationId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "volumeId": c.volumeId,
- "layerId": c.layerId,
- "annotationId": c.annotationId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.layers.volumeAnnotations.get" call.
-// Exactly one of *Volumeannotation or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *Volumeannotation.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *LayersVolumeAnnotationsGetCall) Do() (*Volumeannotation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Volumeannotation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the volume annotation.",
- // "httpMethod": "GET",
- // "id": "books.layers.volumeAnnotations.get",
- // "parameterOrder": [
- // "volumeId",
- // "layerId",
- // "annotationId"
- // ],
- // "parameters": {
- // "annotationId": {
- // "description": "The ID of the volume annotation to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "layerId": {
- // "description": "The ID for the layer to get the annotations.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "locale": {
- // "description": "The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.",
- // "location": "query",
- // "type": "string"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // },
- // "volumeId": {
- // "description": "The volume to retrieve annotations for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "volumes/{volumeId}/layers/{layerId}/annotations/{annotationId}",
- // "response": {
- // "$ref": "Volumeannotation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.layers.volumeAnnotations.list":
-
-type LayersVolumeAnnotationsListCall struct {
- s *Service
- volumeId string
- layerId string
- contentVersion string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Gets the volume annotations for a volume and layer.
-func (r *LayersVolumeAnnotationsService) List(volumeId string, layerId string, contentVersion string) *LayersVolumeAnnotationsListCall {
- c := &LayersVolumeAnnotationsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.volumeId = volumeId
- c.layerId = layerId
- c.contentVersion = contentVersion
- return c
-}
-
-// EndOffset sets the optional parameter "endOffset": The end offset to
-// end retrieving data from.
-func (c *LayersVolumeAnnotationsListCall) EndOffset(endOffset string) *LayersVolumeAnnotationsListCall {
- c.opt_["endOffset"] = endOffset
- return c
-}
-
-// EndPosition sets the optional parameter "endPosition": The end
-// position to end retrieving data from.
-func (c *LayersVolumeAnnotationsListCall) EndPosition(endPosition string) *LayersVolumeAnnotationsListCall {
- c.opt_["endPosition"] = endPosition
- return c
-}
-
-// Locale sets the optional parameter "locale": The locale information
-// for the data. ISO-639-1 language and ISO-3166-1 country code. Ex:
-// 'en_US'.
-func (c *LayersVolumeAnnotationsListCall) Locale(locale string) *LayersVolumeAnnotationsListCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return
-func (c *LayersVolumeAnnotationsListCall) MaxResults(maxResults int64) *LayersVolumeAnnotationsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous page.
-func (c *LayersVolumeAnnotationsListCall) PageToken(pageToken string) *LayersVolumeAnnotationsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// ShowDeleted sets the optional parameter "showDeleted": Set to true to
-// return deleted annotations. updatedMin must be in the request to use
-// this. Defaults to false.
-func (c *LayersVolumeAnnotationsListCall) ShowDeleted(showDeleted bool) *LayersVolumeAnnotationsListCall {
- c.opt_["showDeleted"] = showDeleted
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *LayersVolumeAnnotationsListCall) Source(source string) *LayersVolumeAnnotationsListCall {
- c.opt_["source"] = source
- return c
-}
-
-// StartOffset sets the optional parameter "startOffset": The start
-// offset to start retrieving data from.
-func (c *LayersVolumeAnnotationsListCall) StartOffset(startOffset string) *LayersVolumeAnnotationsListCall {
- c.opt_["startOffset"] = startOffset
- return c
-}
-
-// StartPosition sets the optional parameter "startPosition": The start
-// position to start retrieving data from.
-func (c *LayersVolumeAnnotationsListCall) StartPosition(startPosition string) *LayersVolumeAnnotationsListCall {
- c.opt_["startPosition"] = startPosition
- return c
-}
-
-// UpdatedMax sets the optional parameter "updatedMax": RFC 3339
-// timestamp to restrict to items updated prior to this timestamp
-// (exclusive).
-func (c *LayersVolumeAnnotationsListCall) UpdatedMax(updatedMax string) *LayersVolumeAnnotationsListCall {
- c.opt_["updatedMax"] = updatedMax
- return c
-}
-
-// UpdatedMin sets the optional parameter "updatedMin": RFC 3339
-// timestamp to restrict to items updated since this timestamp
-// (inclusive).
-func (c *LayersVolumeAnnotationsListCall) UpdatedMin(updatedMin string) *LayersVolumeAnnotationsListCall {
- c.opt_["updatedMin"] = updatedMin
- return c
-}
-
-// VolumeAnnotationsVersion sets the optional parameter
-// "volumeAnnotationsVersion": The version of the volume annotations
-// that you are requesting.
-func (c *LayersVolumeAnnotationsListCall) VolumeAnnotationsVersion(volumeAnnotationsVersion string) *LayersVolumeAnnotationsListCall {
- c.opt_["volumeAnnotationsVersion"] = volumeAnnotationsVersion
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LayersVolumeAnnotationsListCall) Fields(s ...googleapi.Field) *LayersVolumeAnnotationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *LayersVolumeAnnotationsListCall) IfNoneMatch(entityTag string) *LayersVolumeAnnotationsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LayersVolumeAnnotationsListCall) Context(ctx context.Context) *LayersVolumeAnnotationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LayersVolumeAnnotationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("contentVersion", fmt.Sprintf("%v", c.contentVersion))
- if v, ok := c.opt_["endOffset"]; ok {
- params.Set("endOffset", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["endPosition"]; ok {
- params.Set("endPosition", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["showDeleted"]; ok {
- params.Set("showDeleted", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startOffset"]; ok {
- params.Set("startOffset", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startPosition"]; ok {
- params.Set("startPosition", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["updatedMax"]; ok {
- params.Set("updatedMax", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["updatedMin"]; ok {
- params.Set("updatedMin", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["volumeAnnotationsVersion"]; ok {
- params.Set("volumeAnnotationsVersion", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "volumes/{volumeId}/layers/{layerId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "volumeId": c.volumeId,
- "layerId": c.layerId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.layers.volumeAnnotations.list" call.
-// Exactly one of *Volumeannotations or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *Volumeannotations.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *LayersVolumeAnnotationsListCall) Do() (*Volumeannotations, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Volumeannotations{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the volume annotations for a volume and layer.",
- // "httpMethod": "GET",
- // "id": "books.layers.volumeAnnotations.list",
- // "parameterOrder": [
- // "volumeId",
- // "layerId",
- // "contentVersion"
- // ],
- // "parameters": {
- // "contentVersion": {
- // "description": "The content version for the requested volume.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "endOffset": {
- // "description": "The end offset to end retrieving data from.",
- // "location": "query",
- // "type": "string"
- // },
- // "endPosition": {
- // "description": "The end position to end retrieving data from.",
- // "location": "query",
- // "type": "string"
- // },
- // "layerId": {
- // "description": "The ID for the layer to get the annotations.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "locale": {
- // "description": "The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "200",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous page.",
- // "location": "query",
- // "type": "string"
- // },
- // "showDeleted": {
- // "description": "Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // },
- // "startOffset": {
- // "description": "The start offset to start retrieving data from.",
- // "location": "query",
- // "type": "string"
- // },
- // "startPosition": {
- // "description": "The start position to start retrieving data from.",
- // "location": "query",
- // "type": "string"
- // },
- // "updatedMax": {
- // "description": "RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).",
- // "location": "query",
- // "type": "string"
- // },
- // "updatedMin": {
- // "description": "RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).",
- // "location": "query",
- // "type": "string"
- // },
- // "volumeAnnotationsVersion": {
- // "description": "The version of the volume annotations that you are requesting.",
- // "location": "query",
- // "type": "string"
- // },
- // "volumeId": {
- // "description": "The volume to retrieve annotations for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "volumes/{volumeId}/layers/{layerId}",
- // "response": {
- // "$ref": "Volumeannotations"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.myconfig.getUserSettings":
-
-type MyconfigGetUserSettingsCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetUserSettings: Gets the current settings for the user.
-func (r *MyconfigService) GetUserSettings() *MyconfigGetUserSettingsCall {
- c := &MyconfigGetUserSettingsCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MyconfigGetUserSettingsCall) Fields(s ...googleapi.Field) *MyconfigGetUserSettingsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MyconfigGetUserSettingsCall) IfNoneMatch(entityTag string) *MyconfigGetUserSettingsCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MyconfigGetUserSettingsCall) Context(ctx context.Context) *MyconfigGetUserSettingsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MyconfigGetUserSettingsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "myconfig/getUserSettings")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.myconfig.getUserSettings" call.
-// Exactly one of *Usersettings or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Usersettings.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *MyconfigGetUserSettingsCall) Do() (*Usersettings, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Usersettings{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the current settings for the user.",
- // "httpMethod": "GET",
- // "id": "books.myconfig.getUserSettings",
- // "path": "myconfig/getUserSettings",
- // "response": {
- // "$ref": "Usersettings"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.myconfig.releaseDownloadAccess":
-
-type MyconfigReleaseDownloadAccessCall struct {
- s *Service
- volumeIds []string
- cpksver string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// ReleaseDownloadAccess: Release downloaded content access restriction.
-func (r *MyconfigService) ReleaseDownloadAccess(volumeIds []string, cpksver string) *MyconfigReleaseDownloadAccessCall {
- c := &MyconfigReleaseDownloadAccessCall{s: r.s, opt_: make(map[string]interface{})}
- c.volumeIds = volumeIds
- c.cpksver = cpksver
- return c
-}
-
-// Locale sets the optional parameter "locale": ISO-639-1, ISO-3166-1
-// codes for message localization, i.e. en_US.
-func (c *MyconfigReleaseDownloadAccessCall) Locale(locale string) *MyconfigReleaseDownloadAccessCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *MyconfigReleaseDownloadAccessCall) Source(source string) *MyconfigReleaseDownloadAccessCall {
- c.opt_["source"] = source
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MyconfigReleaseDownloadAccessCall) Fields(s ...googleapi.Field) *MyconfigReleaseDownloadAccessCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MyconfigReleaseDownloadAccessCall) Context(ctx context.Context) *MyconfigReleaseDownloadAccessCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MyconfigReleaseDownloadAccessCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("cpksver", fmt.Sprintf("%v", c.cpksver))
- for _, v := range c.volumeIds {
- params.Add("volumeIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "myconfig/releaseDownloadAccess")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.myconfig.releaseDownloadAccess" call.
-// Exactly one of *DownloadAccesses or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *DownloadAccesses.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MyconfigReleaseDownloadAccessCall) Do() (*DownloadAccesses, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DownloadAccesses{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Release downloaded content access restriction.",
- // "httpMethod": "POST",
- // "id": "books.myconfig.releaseDownloadAccess",
- // "parameterOrder": [
- // "volumeIds",
- // "cpksver"
- // ],
- // "parameters": {
- // "cpksver": {
- // "description": "The device/version ID from which to release the restriction.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "locale": {
- // "description": "ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.",
- // "location": "query",
- // "type": "string"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // },
- // "volumeIds": {
- // "description": "The volume(s) to release restrictions for.",
- // "location": "query",
- // "repeated": true,
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "myconfig/releaseDownloadAccess",
- // "response": {
- // "$ref": "DownloadAccesses"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.myconfig.requestAccess":
-
-type MyconfigRequestAccessCall struct {
- s *Service
- source string
- volumeId string
- nonce string
- cpksver string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// RequestAccess: Request concurrent and download access restrictions.
-func (r *MyconfigService) RequestAccess(source string, volumeId string, nonce string, cpksver string) *MyconfigRequestAccessCall {
- c := &MyconfigRequestAccessCall{s: r.s, opt_: make(map[string]interface{})}
- c.source = source
- c.volumeId = volumeId
- c.nonce = nonce
- c.cpksver = cpksver
- return c
-}
-
-// LicenseTypes sets the optional parameter "licenseTypes": The type of
-// access license to request. If not specified, the default is BOTH.
-//
-// Possible values:
-// "BOTH" - Both concurrent and download licenses.
-// "CONCURRENT" - Concurrent access license.
-// "DOWNLOAD" - Offline download access license.
-func (c *MyconfigRequestAccessCall) LicenseTypes(licenseTypes string) *MyconfigRequestAccessCall {
- c.opt_["licenseTypes"] = licenseTypes
- return c
-}
-
-// Locale sets the optional parameter "locale": ISO-639-1, ISO-3166-1
-// codes for message localization, i.e. en_US.
-func (c *MyconfigRequestAccessCall) Locale(locale string) *MyconfigRequestAccessCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MyconfigRequestAccessCall) Fields(s ...googleapi.Field) *MyconfigRequestAccessCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MyconfigRequestAccessCall) Context(ctx context.Context) *MyconfigRequestAccessCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MyconfigRequestAccessCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("cpksver", fmt.Sprintf("%v", c.cpksver))
- params.Set("nonce", fmt.Sprintf("%v", c.nonce))
- params.Set("source", fmt.Sprintf("%v", c.source))
- params.Set("volumeId", fmt.Sprintf("%v", c.volumeId))
- if v, ok := c.opt_["licenseTypes"]; ok {
- params.Set("licenseTypes", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "myconfig/requestAccess")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.myconfig.requestAccess" call.
-// Exactly one of *RequestAccess or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *RequestAccess.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MyconfigRequestAccessCall) Do() (*RequestAccess, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &RequestAccess{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Request concurrent and download access restrictions.",
- // "httpMethod": "POST",
- // "id": "books.myconfig.requestAccess",
- // "parameterOrder": [
- // "source",
- // "volumeId",
- // "nonce",
- // "cpksver"
- // ],
- // "parameters": {
- // "cpksver": {
- // "description": "The device/version ID from which to request the restrictions.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "licenseTypes": {
- // "description": "The type of access license to request. If not specified, the default is BOTH.",
- // "enum": [
- // "BOTH",
- // "CONCURRENT",
- // "DOWNLOAD"
- // ],
- // "enumDescriptions": [
- // "Both concurrent and download licenses.",
- // "Concurrent access license.",
- // "Offline download access license."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "locale": {
- // "description": "ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.",
- // "location": "query",
- // "type": "string"
- // },
- // "nonce": {
- // "description": "The client nonce value.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "volumeId": {
- // "description": "The volume to request concurrent/download restrictions for.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "myconfig/requestAccess",
- // "response": {
- // "$ref": "RequestAccess"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.myconfig.syncVolumeLicenses":
-
-type MyconfigSyncVolumeLicensesCall struct {
- s *Service
- source string
- nonce string
- cpksver string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SyncVolumeLicenses: Request downloaded content access for specified
-// volumes on the My eBooks shelf.
-func (r *MyconfigService) SyncVolumeLicenses(source string, nonce string, cpksver string) *MyconfigSyncVolumeLicensesCall {
- c := &MyconfigSyncVolumeLicensesCall{s: r.s, opt_: make(map[string]interface{})}
- c.source = source
- c.nonce = nonce
- c.cpksver = cpksver
- return c
-}
-
-// Features sets the optional parameter "features": List of features
-// supported by the client, i.e., 'RENTALS'
-//
-// Possible values:
-// "RENTALS" - Client supports rentals.
-func (c *MyconfigSyncVolumeLicensesCall) Features(features string) *MyconfigSyncVolumeLicensesCall {
- c.opt_["features"] = features
- return c
-}
-
-// Locale sets the optional parameter "locale": ISO-639-1, ISO-3166-1
-// codes for message localization, i.e. en_US.
-func (c *MyconfigSyncVolumeLicensesCall) Locale(locale string) *MyconfigSyncVolumeLicensesCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// ShowPreorders sets the optional parameter "showPreorders": Set to
-// true to show pre-ordered books. Defaults to false.
-func (c *MyconfigSyncVolumeLicensesCall) ShowPreorders(showPreorders bool) *MyconfigSyncVolumeLicensesCall {
- c.opt_["showPreorders"] = showPreorders
- return c
-}
-
-// VolumeIds sets the optional parameter "volumeIds": The volume(s) to
-// request download restrictions for.
-func (c *MyconfigSyncVolumeLicensesCall) VolumeIds(volumeIds string) *MyconfigSyncVolumeLicensesCall {
- c.opt_["volumeIds"] = volumeIds
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MyconfigSyncVolumeLicensesCall) Fields(s ...googleapi.Field) *MyconfigSyncVolumeLicensesCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MyconfigSyncVolumeLicensesCall) Context(ctx context.Context) *MyconfigSyncVolumeLicensesCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MyconfigSyncVolumeLicensesCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("cpksver", fmt.Sprintf("%v", c.cpksver))
- params.Set("nonce", fmt.Sprintf("%v", c.nonce))
- params.Set("source", fmt.Sprintf("%v", c.source))
- if v, ok := c.opt_["features"]; ok {
- params.Set("features", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["showPreorders"]; ok {
- params.Set("showPreorders", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["volumeIds"]; ok {
- params.Set("volumeIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "myconfig/syncVolumeLicenses")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.myconfig.syncVolumeLicenses" call.
-// Exactly one of *Volumes or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Volumes.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *MyconfigSyncVolumeLicensesCall) Do() (*Volumes, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Volumes{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Request downloaded content access for specified volumes on the My eBooks shelf.",
- // "httpMethod": "POST",
- // "id": "books.myconfig.syncVolumeLicenses",
- // "parameterOrder": [
- // "source",
- // "nonce",
- // "cpksver"
- // ],
- // "parameters": {
- // "cpksver": {
- // "description": "The device/version ID from which to release the restriction.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "features": {
- // "description": "List of features supported by the client, i.e., 'RENTALS'",
- // "enum": [
- // "RENTALS"
- // ],
- // "enumDescriptions": [
- // "Client supports rentals."
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "locale": {
- // "description": "ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.",
- // "location": "query",
- // "type": "string"
- // },
- // "nonce": {
- // "description": "The client nonce value.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "showPreorders": {
- // "description": "Set to true to show pre-ordered books. Defaults to false.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "volumeIds": {
- // "description": "The volume(s) to request download restrictions for.",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // }
- // },
- // "path": "myconfig/syncVolumeLicenses",
- // "response": {
- // "$ref": "Volumes"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.myconfig.updateUserSettings":
-
-type MyconfigUpdateUserSettingsCall struct {
- s *Service
- usersettings *Usersettings
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// UpdateUserSettings: Sets the settings for the user. If a sub-object
-// is specified, it will overwrite the existing sub-object stored in the
-// server. Unspecified sub-objects will retain the existing value.
-func (r *MyconfigService) UpdateUserSettings(usersettings *Usersettings) *MyconfigUpdateUserSettingsCall {
- c := &MyconfigUpdateUserSettingsCall{s: r.s, opt_: make(map[string]interface{})}
- c.usersettings = usersettings
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MyconfigUpdateUserSettingsCall) Fields(s ...googleapi.Field) *MyconfigUpdateUserSettingsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MyconfigUpdateUserSettingsCall) Context(ctx context.Context) *MyconfigUpdateUserSettingsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MyconfigUpdateUserSettingsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.usersettings)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "myconfig/updateUserSettings")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.myconfig.updateUserSettings" call.
-// Exactly one of *Usersettings or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Usersettings.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *MyconfigUpdateUserSettingsCall) Do() (*Usersettings, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Usersettings{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sets the settings for the user. If a sub-object is specified, it will overwrite the existing sub-object stored in the server. Unspecified sub-objects will retain the existing value.",
- // "httpMethod": "POST",
- // "id": "books.myconfig.updateUserSettings",
- // "path": "myconfig/updateUserSettings",
- // "request": {
- // "$ref": "Usersettings"
- // },
- // "response": {
- // "$ref": "Usersettings"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.mylibrary.annotations.delete":
-
-type MylibraryAnnotationsDeleteCall struct {
- s *Service
- annotationId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an annotation.
-func (r *MylibraryAnnotationsService) Delete(annotationId string) *MylibraryAnnotationsDeleteCall {
- c := &MylibraryAnnotationsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.annotationId = annotationId
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *MylibraryAnnotationsDeleteCall) Source(source string) *MylibraryAnnotationsDeleteCall {
- c.opt_["source"] = source
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MylibraryAnnotationsDeleteCall) Fields(s ...googleapi.Field) *MylibraryAnnotationsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MylibraryAnnotationsDeleteCall) Context(ctx context.Context) *MylibraryAnnotationsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MylibraryAnnotationsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "mylibrary/annotations/{annotationId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "annotationId": c.annotationId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.mylibrary.annotations.delete" call.
-func (c *MylibraryAnnotationsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes an annotation.",
- // "httpMethod": "DELETE",
- // "id": "books.mylibrary.annotations.delete",
- // "parameterOrder": [
- // "annotationId"
- // ],
- // "parameters": {
- // "annotationId": {
- // "description": "The ID for the annotation to delete.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "mylibrary/annotations/{annotationId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.mylibrary.annotations.insert":
-
-type MylibraryAnnotationsInsertCall struct {
- s *Service
- annotation *Annotation
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new annotation.
-func (r *MylibraryAnnotationsService) Insert(annotation *Annotation) *MylibraryAnnotationsInsertCall {
- c := &MylibraryAnnotationsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.annotation = annotation
- return c
-}
-
-// Country sets the optional parameter "country": ISO-3166-1 code to
-// override the IP-based location.
-func (c *MylibraryAnnotationsInsertCall) Country(country string) *MylibraryAnnotationsInsertCall {
- c.opt_["country"] = country
- return c
-}
-
-// ShowOnlySummaryInResponse sets the optional parameter
-// "showOnlySummaryInResponse": Requests that only the summary of the
-// specified layer be provided in the response.
-func (c *MylibraryAnnotationsInsertCall) ShowOnlySummaryInResponse(showOnlySummaryInResponse bool) *MylibraryAnnotationsInsertCall {
- c.opt_["showOnlySummaryInResponse"] = showOnlySummaryInResponse
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *MylibraryAnnotationsInsertCall) Source(source string) *MylibraryAnnotationsInsertCall {
- c.opt_["source"] = source
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MylibraryAnnotationsInsertCall) Fields(s ...googleapi.Field) *MylibraryAnnotationsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MylibraryAnnotationsInsertCall) Context(ctx context.Context) *MylibraryAnnotationsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MylibraryAnnotationsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.annotation)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["country"]; ok {
- params.Set("country", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["showOnlySummaryInResponse"]; ok {
- params.Set("showOnlySummaryInResponse", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "mylibrary/annotations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.mylibrary.annotations.insert" call.
-// Exactly one of *Annotation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Annotation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *MylibraryAnnotationsInsertCall) Do() (*Annotation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Annotation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new annotation.",
- // "httpMethod": "POST",
- // "id": "books.mylibrary.annotations.insert",
- // "parameters": {
- // "country": {
- // "description": "ISO-3166-1 code to override the IP-based location.",
- // "location": "query",
- // "type": "string"
- // },
- // "showOnlySummaryInResponse": {
- // "description": "Requests that only the summary of the specified layer be provided in the response.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "mylibrary/annotations",
- // "request": {
- // "$ref": "Annotation"
- // },
- // "response": {
- // "$ref": "Annotation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.mylibrary.annotations.list":
-
-type MylibraryAnnotationsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of annotations, possibly filtered.
-func (r *MylibraryAnnotationsService) List() *MylibraryAnnotationsListCall {
- c := &MylibraryAnnotationsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// ContentVersion sets the optional parameter "contentVersion": The
-// content version for the requested volume.
-func (c *MylibraryAnnotationsListCall) ContentVersion(contentVersion string) *MylibraryAnnotationsListCall {
- c.opt_["contentVersion"] = contentVersion
- return c
-}
-
-// LayerId sets the optional parameter "layerId": The layer ID to limit
-// annotation by.
-func (c *MylibraryAnnotationsListCall) LayerId(layerId string) *MylibraryAnnotationsListCall {
- c.opt_["layerId"] = layerId
- return c
-}
-
-// LayerIds sets the optional parameter "layerIds": The layer ID(s) to
-// limit annotation by.
-func (c *MylibraryAnnotationsListCall) LayerIds(layerIds string) *MylibraryAnnotationsListCall {
- c.opt_["layerIds"] = layerIds
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return
-func (c *MylibraryAnnotationsListCall) MaxResults(maxResults int64) *MylibraryAnnotationsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous page.
-func (c *MylibraryAnnotationsListCall) PageToken(pageToken string) *MylibraryAnnotationsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// ShowDeleted sets the optional parameter "showDeleted": Set to true to
-// return deleted annotations. updatedMin must be in the request to use
-// this. Defaults to false.
-func (c *MylibraryAnnotationsListCall) ShowDeleted(showDeleted bool) *MylibraryAnnotationsListCall {
- c.opt_["showDeleted"] = showDeleted
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *MylibraryAnnotationsListCall) Source(source string) *MylibraryAnnotationsListCall {
- c.opt_["source"] = source
- return c
-}
-
-// UpdatedMax sets the optional parameter "updatedMax": RFC 3339
-// timestamp to restrict to items updated prior to this timestamp
-// (exclusive).
-func (c *MylibraryAnnotationsListCall) UpdatedMax(updatedMax string) *MylibraryAnnotationsListCall {
- c.opt_["updatedMax"] = updatedMax
- return c
-}
-
-// UpdatedMin sets the optional parameter "updatedMin": RFC 3339
-// timestamp to restrict to items updated since this timestamp
-// (inclusive).
-func (c *MylibraryAnnotationsListCall) UpdatedMin(updatedMin string) *MylibraryAnnotationsListCall {
- c.opt_["updatedMin"] = updatedMin
- return c
-}
-
-// VolumeId sets the optional parameter "volumeId": The volume to
-// restrict annotations to.
-func (c *MylibraryAnnotationsListCall) VolumeId(volumeId string) *MylibraryAnnotationsListCall {
- c.opt_["volumeId"] = volumeId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MylibraryAnnotationsListCall) Fields(s ...googleapi.Field) *MylibraryAnnotationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MylibraryAnnotationsListCall) IfNoneMatch(entityTag string) *MylibraryAnnotationsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MylibraryAnnotationsListCall) Context(ctx context.Context) *MylibraryAnnotationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MylibraryAnnotationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["contentVersion"]; ok {
- params.Set("contentVersion", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["layerId"]; ok {
- params.Set("layerId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["layerIds"]; ok {
- params.Set("layerIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["showDeleted"]; ok {
- params.Set("showDeleted", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["updatedMax"]; ok {
- params.Set("updatedMax", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["updatedMin"]; ok {
- params.Set("updatedMin", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["volumeId"]; ok {
- params.Set("volumeId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "mylibrary/annotations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.mylibrary.annotations.list" call.
-// Exactly one of *Annotations or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Annotations.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *MylibraryAnnotationsListCall) Do() (*Annotations, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Annotations{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of annotations, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "books.mylibrary.annotations.list",
- // "parameters": {
- // "contentVersion": {
- // "description": "The content version for the requested volume.",
- // "location": "query",
- // "type": "string"
- // },
- // "layerId": {
- // "description": "The layer ID to limit annotation by.",
- // "location": "query",
- // "type": "string"
- // },
- // "layerIds": {
- // "description": "The layer ID(s) to limit annotation by.",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "40",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous page.",
- // "location": "query",
- // "type": "string"
- // },
- // "showDeleted": {
- // "description": "Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // },
- // "updatedMax": {
- // "description": "RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).",
- // "location": "query",
- // "type": "string"
- // },
- // "updatedMin": {
- // "description": "RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).",
- // "location": "query",
- // "type": "string"
- // },
- // "volumeId": {
- // "description": "The volume to restrict annotations to.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "mylibrary/annotations",
- // "response": {
- // "$ref": "Annotations"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.mylibrary.annotations.summary":
-
-type MylibraryAnnotationsSummaryCall struct {
- s *Service
- layerIds []string
- volumeId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Summary: Gets the summary of specified layers.
-func (r *MylibraryAnnotationsService) Summary(layerIds []string, volumeId string) *MylibraryAnnotationsSummaryCall {
- c := &MylibraryAnnotationsSummaryCall{s: r.s, opt_: make(map[string]interface{})}
- c.layerIds = layerIds
- c.volumeId = volumeId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MylibraryAnnotationsSummaryCall) Fields(s ...googleapi.Field) *MylibraryAnnotationsSummaryCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MylibraryAnnotationsSummaryCall) Context(ctx context.Context) *MylibraryAnnotationsSummaryCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MylibraryAnnotationsSummaryCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("volumeId", fmt.Sprintf("%v", c.volumeId))
- for _, v := range c.layerIds {
- params.Add("layerIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "mylibrary/annotations/summary")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.mylibrary.annotations.summary" call.
-// Exactly one of *AnnotationsSummary or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AnnotationsSummary.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MylibraryAnnotationsSummaryCall) Do() (*AnnotationsSummary, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AnnotationsSummary{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the summary of specified layers.",
- // "httpMethod": "POST",
- // "id": "books.mylibrary.annotations.summary",
- // "parameterOrder": [
- // "layerIds",
- // "volumeId"
- // ],
- // "parameters": {
- // "layerIds": {
- // "description": "Array of layer IDs to get the summary for.",
- // "location": "query",
- // "repeated": true,
- // "required": true,
- // "type": "string"
- // },
- // "volumeId": {
- // "description": "Volume id to get the summary for.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "mylibrary/annotations/summary",
- // "response": {
- // "$ref": "AnnotationsSummary"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.mylibrary.annotations.update":
-
-type MylibraryAnnotationsUpdateCall struct {
- s *Service
- annotationId string
- annotation *Annotation
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing annotation.
-func (r *MylibraryAnnotationsService) Update(annotationId string, annotation *Annotation) *MylibraryAnnotationsUpdateCall {
- c := &MylibraryAnnotationsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.annotationId = annotationId
- c.annotation = annotation
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *MylibraryAnnotationsUpdateCall) Source(source string) *MylibraryAnnotationsUpdateCall {
- c.opt_["source"] = source
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MylibraryAnnotationsUpdateCall) Fields(s ...googleapi.Field) *MylibraryAnnotationsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MylibraryAnnotationsUpdateCall) Context(ctx context.Context) *MylibraryAnnotationsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MylibraryAnnotationsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.annotation)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "mylibrary/annotations/{annotationId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "annotationId": c.annotationId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.mylibrary.annotations.update" call.
-// Exactly one of *Annotation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Annotation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *MylibraryAnnotationsUpdateCall) Do() (*Annotation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Annotation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing annotation.",
- // "httpMethod": "PUT",
- // "id": "books.mylibrary.annotations.update",
- // "parameterOrder": [
- // "annotationId"
- // ],
- // "parameters": {
- // "annotationId": {
- // "description": "The ID for the annotation to update.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "mylibrary/annotations/{annotationId}",
- // "request": {
- // "$ref": "Annotation"
- // },
- // "response": {
- // "$ref": "Annotation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.mylibrary.bookshelves.addVolume":
-
-type MylibraryBookshelvesAddVolumeCall struct {
- s *Service
- shelf string
- volumeId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AddVolume: Adds a volume to a bookshelf.
-func (r *MylibraryBookshelvesService) AddVolume(shelf string, volumeId string) *MylibraryBookshelvesAddVolumeCall {
- c := &MylibraryBookshelvesAddVolumeCall{s: r.s, opt_: make(map[string]interface{})}
- c.shelf = shelf
- c.volumeId = volumeId
- return c
-}
-
-// Reason sets the optional parameter "reason": The reason for which the
-// book is added to the library.
-//
-// Possible values:
-// "IOS_PREX" - Volumes added from the PREX flow on iOS.
-// "IOS_SEARCH" - Volumes added from the Search flow on iOS.
-// "ONBOARDING" - Volumes added from the Onboarding flow.
-func (c *MylibraryBookshelvesAddVolumeCall) Reason(reason string) *MylibraryBookshelvesAddVolumeCall {
- c.opt_["reason"] = reason
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *MylibraryBookshelvesAddVolumeCall) Source(source string) *MylibraryBookshelvesAddVolumeCall {
- c.opt_["source"] = source
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MylibraryBookshelvesAddVolumeCall) Fields(s ...googleapi.Field) *MylibraryBookshelvesAddVolumeCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MylibraryBookshelvesAddVolumeCall) Context(ctx context.Context) *MylibraryBookshelvesAddVolumeCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MylibraryBookshelvesAddVolumeCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("volumeId", fmt.Sprintf("%v", c.volumeId))
- if v, ok := c.opt_["reason"]; ok {
- params.Set("reason", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "mylibrary/bookshelves/{shelf}/addVolume")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "shelf": c.shelf,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.mylibrary.bookshelves.addVolume" call.
-func (c *MylibraryBookshelvesAddVolumeCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Adds a volume to a bookshelf.",
- // "httpMethod": "POST",
- // "id": "books.mylibrary.bookshelves.addVolume",
- // "parameterOrder": [
- // "shelf",
- // "volumeId"
- // ],
- // "parameters": {
- // "reason": {
- // "description": "The reason for which the book is added to the library.",
- // "enum": [
- // "IOS_PREX",
- // "IOS_SEARCH",
- // "ONBOARDING"
- // ],
- // "enumDescriptions": [
- // "Volumes added from the PREX flow on iOS.",
- // "Volumes added from the Search flow on iOS.",
- // "Volumes added from the Onboarding flow."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "shelf": {
- // "description": "ID of bookshelf to which to add a volume.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // },
- // "volumeId": {
- // "description": "ID of volume to add.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "mylibrary/bookshelves/{shelf}/addVolume",
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.mylibrary.bookshelves.clearVolumes":
-
-type MylibraryBookshelvesClearVolumesCall struct {
- s *Service
- shelf string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// ClearVolumes: Clears all volumes from a bookshelf.
-func (r *MylibraryBookshelvesService) ClearVolumes(shelf string) *MylibraryBookshelvesClearVolumesCall {
- c := &MylibraryBookshelvesClearVolumesCall{s: r.s, opt_: make(map[string]interface{})}
- c.shelf = shelf
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *MylibraryBookshelvesClearVolumesCall) Source(source string) *MylibraryBookshelvesClearVolumesCall {
- c.opt_["source"] = source
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MylibraryBookshelvesClearVolumesCall) Fields(s ...googleapi.Field) *MylibraryBookshelvesClearVolumesCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MylibraryBookshelvesClearVolumesCall) Context(ctx context.Context) *MylibraryBookshelvesClearVolumesCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MylibraryBookshelvesClearVolumesCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "mylibrary/bookshelves/{shelf}/clearVolumes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "shelf": c.shelf,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.mylibrary.bookshelves.clearVolumes" call.
-func (c *MylibraryBookshelvesClearVolumesCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Clears all volumes from a bookshelf.",
- // "httpMethod": "POST",
- // "id": "books.mylibrary.bookshelves.clearVolumes",
- // "parameterOrder": [
- // "shelf"
- // ],
- // "parameters": {
- // "shelf": {
- // "description": "ID of bookshelf from which to remove a volume.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "mylibrary/bookshelves/{shelf}/clearVolumes",
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.mylibrary.bookshelves.get":
-
-type MylibraryBookshelvesGetCall struct {
- s *Service
- shelf string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves metadata for a specific bookshelf belonging to the
-// authenticated user.
-func (r *MylibraryBookshelvesService) Get(shelf string) *MylibraryBookshelvesGetCall {
- c := &MylibraryBookshelvesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.shelf = shelf
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *MylibraryBookshelvesGetCall) Source(source string) *MylibraryBookshelvesGetCall {
- c.opt_["source"] = source
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MylibraryBookshelvesGetCall) Fields(s ...googleapi.Field) *MylibraryBookshelvesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MylibraryBookshelvesGetCall) IfNoneMatch(entityTag string) *MylibraryBookshelvesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MylibraryBookshelvesGetCall) Context(ctx context.Context) *MylibraryBookshelvesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MylibraryBookshelvesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "mylibrary/bookshelves/{shelf}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "shelf": c.shelf,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.mylibrary.bookshelves.get" call.
-// Exactly one of *Bookshelf or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Bookshelf.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *MylibraryBookshelvesGetCall) Do() (*Bookshelf, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Bookshelf{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves metadata for a specific bookshelf belonging to the authenticated user.",
- // "httpMethod": "GET",
- // "id": "books.mylibrary.bookshelves.get",
- // "parameterOrder": [
- // "shelf"
- // ],
- // "parameters": {
- // "shelf": {
- // "description": "ID of bookshelf to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "mylibrary/bookshelves/{shelf}",
- // "response": {
- // "$ref": "Bookshelf"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.mylibrary.bookshelves.list":
-
-type MylibraryBookshelvesListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of bookshelves belonging to the authenticated
-// user.
-func (r *MylibraryBookshelvesService) List() *MylibraryBookshelvesListCall {
- c := &MylibraryBookshelvesListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *MylibraryBookshelvesListCall) Source(source string) *MylibraryBookshelvesListCall {
- c.opt_["source"] = source
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MylibraryBookshelvesListCall) Fields(s ...googleapi.Field) *MylibraryBookshelvesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MylibraryBookshelvesListCall) IfNoneMatch(entityTag string) *MylibraryBookshelvesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MylibraryBookshelvesListCall) Context(ctx context.Context) *MylibraryBookshelvesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MylibraryBookshelvesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "mylibrary/bookshelves")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.mylibrary.bookshelves.list" call.
-// Exactly one of *Bookshelves or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Bookshelves.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *MylibraryBookshelvesListCall) Do() (*Bookshelves, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Bookshelves{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of bookshelves belonging to the authenticated user.",
- // "httpMethod": "GET",
- // "id": "books.mylibrary.bookshelves.list",
- // "parameters": {
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "mylibrary/bookshelves",
- // "response": {
- // "$ref": "Bookshelves"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.mylibrary.bookshelves.moveVolume":
-
-type MylibraryBookshelvesMoveVolumeCall struct {
- s *Service
- shelf string
- volumeId string
- volumePosition int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// MoveVolume: Moves a volume within a bookshelf.
-func (r *MylibraryBookshelvesService) MoveVolume(shelf string, volumeId string, volumePosition int64) *MylibraryBookshelvesMoveVolumeCall {
- c := &MylibraryBookshelvesMoveVolumeCall{s: r.s, opt_: make(map[string]interface{})}
- c.shelf = shelf
- c.volumeId = volumeId
- c.volumePosition = volumePosition
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *MylibraryBookshelvesMoveVolumeCall) Source(source string) *MylibraryBookshelvesMoveVolumeCall {
- c.opt_["source"] = source
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MylibraryBookshelvesMoveVolumeCall) Fields(s ...googleapi.Field) *MylibraryBookshelvesMoveVolumeCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MylibraryBookshelvesMoveVolumeCall) Context(ctx context.Context) *MylibraryBookshelvesMoveVolumeCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MylibraryBookshelvesMoveVolumeCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("volumeId", fmt.Sprintf("%v", c.volumeId))
- params.Set("volumePosition", fmt.Sprintf("%v", c.volumePosition))
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "mylibrary/bookshelves/{shelf}/moveVolume")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "shelf": c.shelf,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.mylibrary.bookshelves.moveVolume" call.
-func (c *MylibraryBookshelvesMoveVolumeCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Moves a volume within a bookshelf.",
- // "httpMethod": "POST",
- // "id": "books.mylibrary.bookshelves.moveVolume",
- // "parameterOrder": [
- // "shelf",
- // "volumeId",
- // "volumePosition"
- // ],
- // "parameters": {
- // "shelf": {
- // "description": "ID of bookshelf with the volume.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // },
- // "volumeId": {
- // "description": "ID of volume to move.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "volumePosition": {
- // "description": "Position on shelf to move the item (0 puts the item before the current first item, 1 puts it between the first and the second and so on.)",
- // "format": "int32",
- // "location": "query",
- // "required": true,
- // "type": "integer"
- // }
- // },
- // "path": "mylibrary/bookshelves/{shelf}/moveVolume",
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.mylibrary.bookshelves.removeVolume":
-
-type MylibraryBookshelvesRemoveVolumeCall struct {
- s *Service
- shelf string
- volumeId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// RemoveVolume: Removes a volume from a bookshelf.
-func (r *MylibraryBookshelvesService) RemoveVolume(shelf string, volumeId string) *MylibraryBookshelvesRemoveVolumeCall {
- c := &MylibraryBookshelvesRemoveVolumeCall{s: r.s, opt_: make(map[string]interface{})}
- c.shelf = shelf
- c.volumeId = volumeId
- return c
-}
-
-// Reason sets the optional parameter "reason": The reason for which the
-// book is removed from the library.
-//
-// Possible values:
-// "ONBOARDING" - Samples removed from the Onboarding flow.
-func (c *MylibraryBookshelvesRemoveVolumeCall) Reason(reason string) *MylibraryBookshelvesRemoveVolumeCall {
- c.opt_["reason"] = reason
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *MylibraryBookshelvesRemoveVolumeCall) Source(source string) *MylibraryBookshelvesRemoveVolumeCall {
- c.opt_["source"] = source
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MylibraryBookshelvesRemoveVolumeCall) Fields(s ...googleapi.Field) *MylibraryBookshelvesRemoveVolumeCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MylibraryBookshelvesRemoveVolumeCall) Context(ctx context.Context) *MylibraryBookshelvesRemoveVolumeCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MylibraryBookshelvesRemoveVolumeCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("volumeId", fmt.Sprintf("%v", c.volumeId))
- if v, ok := c.opt_["reason"]; ok {
- params.Set("reason", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "mylibrary/bookshelves/{shelf}/removeVolume")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "shelf": c.shelf,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.mylibrary.bookshelves.removeVolume" call.
-func (c *MylibraryBookshelvesRemoveVolumeCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Removes a volume from a bookshelf.",
- // "httpMethod": "POST",
- // "id": "books.mylibrary.bookshelves.removeVolume",
- // "parameterOrder": [
- // "shelf",
- // "volumeId"
- // ],
- // "parameters": {
- // "reason": {
- // "description": "The reason for which the book is removed from the library.",
- // "enum": [
- // "ONBOARDING"
- // ],
- // "enumDescriptions": [
- // "Samples removed from the Onboarding flow."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "shelf": {
- // "description": "ID of bookshelf from which to remove a volume.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // },
- // "volumeId": {
- // "description": "ID of volume to remove.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "mylibrary/bookshelves/{shelf}/removeVolume",
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.mylibrary.bookshelves.volumes.list":
-
-type MylibraryBookshelvesVolumesListCall struct {
- s *Service
- shelf string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Gets volume information for volumes on a bookshelf.
-func (r *MylibraryBookshelvesVolumesService) List(shelf string) *MylibraryBookshelvesVolumesListCall {
- c := &MylibraryBookshelvesVolumesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.shelf = shelf
- return c
-}
-
-// Country sets the optional parameter "country": ISO-3166-1 code to
-// override the IP-based location.
-func (c *MylibraryBookshelvesVolumesListCall) Country(country string) *MylibraryBookshelvesVolumesListCall {
- c.opt_["country"] = country
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return
-func (c *MylibraryBookshelvesVolumesListCall) MaxResults(maxResults int64) *MylibraryBookshelvesVolumesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// Projection sets the optional parameter "projection": Restrict
-// information returned to a set of selected fields.
-//
-// Possible values:
-// "full" - Includes all volume data.
-// "lite" - Includes a subset of fields in volumeInfo and accessInfo.
-func (c *MylibraryBookshelvesVolumesListCall) Projection(projection string) *MylibraryBookshelvesVolumesListCall {
- c.opt_["projection"] = projection
- return c
-}
-
-// Q sets the optional parameter "q": Full-text search query string in
-// this bookshelf.
-func (c *MylibraryBookshelvesVolumesListCall) Q(q string) *MylibraryBookshelvesVolumesListCall {
- c.opt_["q"] = q
- return c
-}
-
-// ShowPreorders sets the optional parameter "showPreorders": Set to
-// true to show pre-ordered books. Defaults to false.
-func (c *MylibraryBookshelvesVolumesListCall) ShowPreorders(showPreorders bool) *MylibraryBookshelvesVolumesListCall {
- c.opt_["showPreorders"] = showPreorders
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *MylibraryBookshelvesVolumesListCall) Source(source string) *MylibraryBookshelvesVolumesListCall {
- c.opt_["source"] = source
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex": Index of the
-// first element to return (starts at 0)
-func (c *MylibraryBookshelvesVolumesListCall) StartIndex(startIndex int64) *MylibraryBookshelvesVolumesListCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MylibraryBookshelvesVolumesListCall) Fields(s ...googleapi.Field) *MylibraryBookshelvesVolumesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MylibraryBookshelvesVolumesListCall) IfNoneMatch(entityTag string) *MylibraryBookshelvesVolumesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MylibraryBookshelvesVolumesListCall) Context(ctx context.Context) *MylibraryBookshelvesVolumesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MylibraryBookshelvesVolumesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["country"]; ok {
- params.Set("country", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["projection"]; ok {
- params.Set("projection", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["q"]; ok {
- params.Set("q", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["showPreorders"]; ok {
- params.Set("showPreorders", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "mylibrary/bookshelves/{shelf}/volumes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "shelf": c.shelf,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.mylibrary.bookshelves.volumes.list" call.
-// Exactly one of *Volumes or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Volumes.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *MylibraryBookshelvesVolumesListCall) Do() (*Volumes, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Volumes{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets volume information for volumes on a bookshelf.",
- // "httpMethod": "GET",
- // "id": "books.mylibrary.bookshelves.volumes.list",
- // "parameterOrder": [
- // "shelf"
- // ],
- // "parameters": {
- // "country": {
- // "description": "ISO-3166-1 code to override the IP-based location.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return",
- // "format": "uint32",
- // "location": "query",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "projection": {
- // "description": "Restrict information returned to a set of selected fields.",
- // "enum": [
- // "full",
- // "lite"
- // ],
- // "enumDescriptions": [
- // "Includes all volume data.",
- // "Includes a subset of fields in volumeInfo and accessInfo."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "q": {
- // "description": "Full-text search query string in this bookshelf.",
- // "location": "query",
- // "type": "string"
- // },
- // "shelf": {
- // "description": "The bookshelf ID or name retrieve volumes for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "showPreorders": {
- // "description": "Set to true to show pre-ordered books. Defaults to false.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // },
- // "startIndex": {
- // "description": "Index of the first element to return (starts at 0)",
- // "format": "uint32",
- // "location": "query",
- // "minimum": "0",
- // "type": "integer"
- // }
- // },
- // "path": "mylibrary/bookshelves/{shelf}/volumes",
- // "response": {
- // "$ref": "Volumes"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.mylibrary.readingpositions.get":
-
-type MylibraryReadingpositionsGetCall struct {
- s *Service
- volumeId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves my reading position information for a volume.
-func (r *MylibraryReadingpositionsService) Get(volumeId string) *MylibraryReadingpositionsGetCall {
- c := &MylibraryReadingpositionsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.volumeId = volumeId
- return c
-}
-
-// ContentVersion sets the optional parameter "contentVersion": Volume
-// content version for which this reading position is requested.
-func (c *MylibraryReadingpositionsGetCall) ContentVersion(contentVersion string) *MylibraryReadingpositionsGetCall {
- c.opt_["contentVersion"] = contentVersion
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *MylibraryReadingpositionsGetCall) Source(source string) *MylibraryReadingpositionsGetCall {
- c.opt_["source"] = source
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MylibraryReadingpositionsGetCall) Fields(s ...googleapi.Field) *MylibraryReadingpositionsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MylibraryReadingpositionsGetCall) IfNoneMatch(entityTag string) *MylibraryReadingpositionsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MylibraryReadingpositionsGetCall) Context(ctx context.Context) *MylibraryReadingpositionsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MylibraryReadingpositionsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["contentVersion"]; ok {
- params.Set("contentVersion", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "mylibrary/readingpositions/{volumeId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "volumeId": c.volumeId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.mylibrary.readingpositions.get" call.
-// Exactly one of *ReadingPosition or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ReadingPosition.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MylibraryReadingpositionsGetCall) Do() (*ReadingPosition, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ReadingPosition{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves my reading position information for a volume.",
- // "httpMethod": "GET",
- // "id": "books.mylibrary.readingpositions.get",
- // "parameterOrder": [
- // "volumeId"
- // ],
- // "parameters": {
- // "contentVersion": {
- // "description": "Volume content version for which this reading position is requested.",
- // "location": "query",
- // "type": "string"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // },
- // "volumeId": {
- // "description": "ID of volume for which to retrieve a reading position.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "mylibrary/readingpositions/{volumeId}",
- // "response": {
- // "$ref": "ReadingPosition"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.mylibrary.readingpositions.setPosition":
-
-type MylibraryReadingpositionsSetPositionCall struct {
- s *Service
- volumeId string
- timestamp string
- position string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetPosition: Sets my reading position information for a volume.
-func (r *MylibraryReadingpositionsService) SetPosition(volumeId string, timestamp string, position string) *MylibraryReadingpositionsSetPositionCall {
- c := &MylibraryReadingpositionsSetPositionCall{s: r.s, opt_: make(map[string]interface{})}
- c.volumeId = volumeId
- c.timestamp = timestamp
- c.position = position
- return c
-}
-
-// Action sets the optional parameter "action": Action that caused this
-// reading position to be set.
-//
-// Possible values:
-// "bookmark" - User chose bookmark within volume.
-// "chapter" - User selected chapter from list.
-// "next-page" - Next page event.
-// "prev-page" - Previous page event.
-// "scroll" - User navigated to page.
-// "search" - User chose search results within volume.
-func (c *MylibraryReadingpositionsSetPositionCall) Action(action string) *MylibraryReadingpositionsSetPositionCall {
- c.opt_["action"] = action
- return c
-}
-
-// ContentVersion sets the optional parameter "contentVersion": Volume
-// content version for which this reading position applies.
-func (c *MylibraryReadingpositionsSetPositionCall) ContentVersion(contentVersion string) *MylibraryReadingpositionsSetPositionCall {
- c.opt_["contentVersion"] = contentVersion
- return c
-}
-
-// DeviceCookie sets the optional parameter "deviceCookie": Random
-// persistent device cookie optional on set position.
-func (c *MylibraryReadingpositionsSetPositionCall) DeviceCookie(deviceCookie string) *MylibraryReadingpositionsSetPositionCall {
- c.opt_["deviceCookie"] = deviceCookie
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *MylibraryReadingpositionsSetPositionCall) Source(source string) *MylibraryReadingpositionsSetPositionCall {
- c.opt_["source"] = source
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MylibraryReadingpositionsSetPositionCall) Fields(s ...googleapi.Field) *MylibraryReadingpositionsSetPositionCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MylibraryReadingpositionsSetPositionCall) Context(ctx context.Context) *MylibraryReadingpositionsSetPositionCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MylibraryReadingpositionsSetPositionCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("position", fmt.Sprintf("%v", c.position))
- params.Set("timestamp", fmt.Sprintf("%v", c.timestamp))
- if v, ok := c.opt_["action"]; ok {
- params.Set("action", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["contentVersion"]; ok {
- params.Set("contentVersion", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["deviceCookie"]; ok {
- params.Set("deviceCookie", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "mylibrary/readingpositions/{volumeId}/setPosition")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "volumeId": c.volumeId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.mylibrary.readingpositions.setPosition" call.
-func (c *MylibraryReadingpositionsSetPositionCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Sets my reading position information for a volume.",
- // "httpMethod": "POST",
- // "id": "books.mylibrary.readingpositions.setPosition",
- // "parameterOrder": [
- // "volumeId",
- // "timestamp",
- // "position"
- // ],
- // "parameters": {
- // "action": {
- // "description": "Action that caused this reading position to be set.",
- // "enum": [
- // "bookmark",
- // "chapter",
- // "next-page",
- // "prev-page",
- // "scroll",
- // "search"
- // ],
- // "enumDescriptions": [
- // "User chose bookmark within volume.",
- // "User selected chapter from list.",
- // "Next page event.",
- // "Previous page event.",
- // "User navigated to page.",
- // "User chose search results within volume."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "contentVersion": {
- // "description": "Volume content version for which this reading position applies.",
- // "location": "query",
- // "type": "string"
- // },
- // "deviceCookie": {
- // "description": "Random persistent device cookie optional on set position.",
- // "location": "query",
- // "type": "string"
- // },
- // "position": {
- // "description": "Position string for the new volume reading position.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // },
- // "timestamp": {
- // "description": "RFC 3339 UTC format timestamp associated with this reading position.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "volumeId": {
- // "description": "ID of volume for which to update the reading position.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "mylibrary/readingpositions/{volumeId}/setPosition",
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.notification.get":
-
-type NotificationGetCall struct {
- s *Service
- notificationId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns notification details for a given notification id.
-func (r *NotificationService) Get(notificationId string) *NotificationGetCall {
- c := &NotificationGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.notificationId = notificationId
- return c
-}
-
-// Locale sets the optional parameter "locale": ISO-639-1 language and
-// ISO-3166-1 country code. Ex: 'en_US'. Used for generating
-// notification title and body.
-func (c *NotificationGetCall) Locale(locale string) *NotificationGetCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *NotificationGetCall) Source(source string) *NotificationGetCall {
- c.opt_["source"] = source
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *NotificationGetCall) Fields(s ...googleapi.Field) *NotificationGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *NotificationGetCall) IfNoneMatch(entityTag string) *NotificationGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *NotificationGetCall) Context(ctx context.Context) *NotificationGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *NotificationGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("notification_id", fmt.Sprintf("%v", c.notificationId))
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "notification/get")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.notification.get" call.
-// Exactly one of *Notification or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Notification.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *NotificationGetCall) Do() (*Notification, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Notification{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns notification details for a given notification id.",
- // "httpMethod": "GET",
- // "id": "books.notification.get",
- // "parameterOrder": [
- // "notification_id"
- // ],
- // "parameters": {
- // "locale": {
- // "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating notification title and body.",
- // "location": "query",
- // "type": "string"
- // },
- // "notification_id": {
- // "description": "String to identify the notification.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "notification/get",
- // "response": {
- // "$ref": "Notification"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.onboarding.listCategories":
-
-type OnboardingListCategoriesCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// ListCategories: List categories for onboarding experience.
-func (r *OnboardingService) ListCategories() *OnboardingListCategoriesCall {
- c := &OnboardingListCategoriesCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Locale sets the optional parameter "locale": ISO-639-1 language and
-// ISO-3166-1 country code. Default is en-US if unset.
-func (c *OnboardingListCategoriesCall) Locale(locale string) *OnboardingListCategoriesCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OnboardingListCategoriesCall) Fields(s ...googleapi.Field) *OnboardingListCategoriesCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OnboardingListCategoriesCall) IfNoneMatch(entityTag string) *OnboardingListCategoriesCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OnboardingListCategoriesCall) Context(ctx context.Context) *OnboardingListCategoriesCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OnboardingListCategoriesCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "onboarding/listCategories")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.onboarding.listCategories" call.
-// Exactly one of *Category or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Category.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *OnboardingListCategoriesCall) Do() (*Category, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Category{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List categories for onboarding experience.",
- // "httpMethod": "GET",
- // "id": "books.onboarding.listCategories",
- // "parameters": {
- // "locale": {
- // "description": "ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "onboarding/listCategories",
- // "response": {
- // "$ref": "Category"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.onboarding.listCategoryVolumes":
-
-type OnboardingListCategoryVolumesCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// ListCategoryVolumes: List available volumes under categories for
-// onboarding experience.
-func (r *OnboardingService) ListCategoryVolumes() *OnboardingListCategoryVolumesCall {
- c := &OnboardingListCategoryVolumesCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// CategoryId sets the optional parameter "categoryId": List of category
-// ids requested.
-func (c *OnboardingListCategoryVolumesCall) CategoryId(categoryId string) *OnboardingListCategoryVolumesCall {
- c.opt_["categoryId"] = categoryId
- return c
-}
-
-// Locale sets the optional parameter "locale": ISO-639-1 language and
-// ISO-3166-1 country code. Default is en-US if unset.
-func (c *OnboardingListCategoryVolumesCall) Locale(locale string) *OnboardingListCategoryVolumesCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// MaxAllowedMaturityRating sets the optional parameter
-// "maxAllowedMaturityRating": The maximum allowed maturity rating of
-// returned volumes. Books with a higher maturity rating are filtered
-// out.
-//
-// Possible values:
-// "mature" - Show books which are rated mature or lower.
-// "not-mature" - Show books which are rated not mature.
-func (c *OnboardingListCategoryVolumesCall) MaxAllowedMaturityRating(maxAllowedMaturityRating string) *OnboardingListCategoryVolumesCall {
- c.opt_["maxAllowedMaturityRating"] = maxAllowedMaturityRating
- return c
-}
-
-// PageSize sets the optional parameter "pageSize": Number of maximum
-// results per page to be included in the response.
-func (c *OnboardingListCategoryVolumesCall) PageSize(pageSize int64) *OnboardingListCategoryVolumesCall {
- c.opt_["pageSize"] = pageSize
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous page.
-func (c *OnboardingListCategoryVolumesCall) PageToken(pageToken string) *OnboardingListCategoryVolumesCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OnboardingListCategoryVolumesCall) Fields(s ...googleapi.Field) *OnboardingListCategoryVolumesCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OnboardingListCategoryVolumesCall) IfNoneMatch(entityTag string) *OnboardingListCategoryVolumesCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OnboardingListCategoryVolumesCall) Context(ctx context.Context) *OnboardingListCategoryVolumesCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OnboardingListCategoryVolumesCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["categoryId"]; ok {
- params.Set("categoryId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxAllowedMaturityRating"]; ok {
- params.Set("maxAllowedMaturityRating", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageSize"]; ok {
- params.Set("pageSize", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "onboarding/listCategoryVolumes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.onboarding.listCategoryVolumes" call.
-// Exactly one of *Volume2 or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Volume2.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *OnboardingListCategoryVolumesCall) Do() (*Volume2, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Volume2{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List available volumes under categories for onboarding experience.",
- // "httpMethod": "GET",
- // "id": "books.onboarding.listCategoryVolumes",
- // "parameters": {
- // "categoryId": {
- // "description": "List of category ids requested.",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "locale": {
- // "description": "ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxAllowedMaturityRating": {
- // "description": "The maximum allowed maturity rating of returned volumes. Books with a higher maturity rating are filtered out.",
- // "enum": [
- // "mature",
- // "not-mature"
- // ],
- // "enumDescriptions": [
- // "Show books which are rated mature or lower.",
- // "Show books which are rated not mature."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "pageSize": {
- // "description": "Number of maximum results per page to be included in the response.",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous page.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "onboarding/listCategoryVolumes",
- // "response": {
- // "$ref": "Volume2"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.personalizedstream.get":
-
-type PersonalizedstreamGetCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns a stream of personalized book clusters
-func (r *PersonalizedstreamService) Get() *PersonalizedstreamGetCall {
- c := &PersonalizedstreamGetCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Locale sets the optional parameter "locale": ISO-639-1 language and
-// ISO-3166-1 country code. Ex: 'en_US'. Used for generating
-// recommendations.
-func (c *PersonalizedstreamGetCall) Locale(locale string) *PersonalizedstreamGetCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// MaxAllowedMaturityRating sets the optional parameter
-// "maxAllowedMaturityRating": The maximum allowed maturity rating of
-// returned recommendations. Books with a higher maturity rating are
-// filtered out.
-//
-// Possible values:
-// "mature" - Show books which are rated mature or lower.
-// "not-mature" - Show books which are rated not mature.
-func (c *PersonalizedstreamGetCall) MaxAllowedMaturityRating(maxAllowedMaturityRating string) *PersonalizedstreamGetCall {
- c.opt_["maxAllowedMaturityRating"] = maxAllowedMaturityRating
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *PersonalizedstreamGetCall) Source(source string) *PersonalizedstreamGetCall {
- c.opt_["source"] = source
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PersonalizedstreamGetCall) Fields(s ...googleapi.Field) *PersonalizedstreamGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PersonalizedstreamGetCall) IfNoneMatch(entityTag string) *PersonalizedstreamGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PersonalizedstreamGetCall) Context(ctx context.Context) *PersonalizedstreamGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PersonalizedstreamGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxAllowedMaturityRating"]; ok {
- params.Set("maxAllowedMaturityRating", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "personalizedstream/get")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.personalizedstream.get" call.
-// Exactly one of *Discoveryclusters or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *Discoveryclusters.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PersonalizedstreamGetCall) Do() (*Discoveryclusters, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Discoveryclusters{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns a stream of personalized book clusters",
- // "httpMethod": "GET",
- // "id": "books.personalizedstream.get",
- // "parameters": {
- // "locale": {
- // "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxAllowedMaturityRating": {
- // "description": "The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.",
- // "enum": [
- // "mature",
- // "not-mature"
- // ],
- // "enumDescriptions": [
- // "Show books which are rated mature or lower.",
- // "Show books which are rated not mature."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "personalizedstream/get",
- // "response": {
- // "$ref": "Discoveryclusters"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.promooffer.accept":
-
-type PromoofferAcceptCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Accept:
-func (r *PromoofferService) Accept() *PromoofferAcceptCall {
- c := &PromoofferAcceptCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// AndroidId sets the optional parameter "androidId": device android_id
-func (c *PromoofferAcceptCall) AndroidId(androidId string) *PromoofferAcceptCall {
- c.opt_["androidId"] = androidId
- return c
-}
-
-// Device sets the optional parameter "device": device device
-func (c *PromoofferAcceptCall) Device(device string) *PromoofferAcceptCall {
- c.opt_["device"] = device
- return c
-}
-
-// Manufacturer sets the optional parameter "manufacturer": device
-// manufacturer
-func (c *PromoofferAcceptCall) Manufacturer(manufacturer string) *PromoofferAcceptCall {
- c.opt_["manufacturer"] = manufacturer
- return c
-}
-
-// Model sets the optional parameter "model": device model
-func (c *PromoofferAcceptCall) Model(model string) *PromoofferAcceptCall {
- c.opt_["model"] = model
- return c
-}
-
-// OfferId sets the optional parameter "offerId":
-func (c *PromoofferAcceptCall) OfferId(offerId string) *PromoofferAcceptCall {
- c.opt_["offerId"] = offerId
- return c
-}
-
-// Product sets the optional parameter "product": device product
-func (c *PromoofferAcceptCall) Product(product string) *PromoofferAcceptCall {
- c.opt_["product"] = product
- return c
-}
-
-// Serial sets the optional parameter "serial": device serial
-func (c *PromoofferAcceptCall) Serial(serial string) *PromoofferAcceptCall {
- c.opt_["serial"] = serial
- return c
-}
-
-// VolumeId sets the optional parameter "volumeId": Volume id to
-// exercise the offer
-func (c *PromoofferAcceptCall) VolumeId(volumeId string) *PromoofferAcceptCall {
- c.opt_["volumeId"] = volumeId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PromoofferAcceptCall) Fields(s ...googleapi.Field) *PromoofferAcceptCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PromoofferAcceptCall) Context(ctx context.Context) *PromoofferAcceptCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PromoofferAcceptCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["androidId"]; ok {
- params.Set("androidId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["device"]; ok {
- params.Set("device", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["manufacturer"]; ok {
- params.Set("manufacturer", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["model"]; ok {
- params.Set("model", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["offerId"]; ok {
- params.Set("offerId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["product"]; ok {
- params.Set("product", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["serial"]; ok {
- params.Set("serial", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["volumeId"]; ok {
- params.Set("volumeId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "promooffer/accept")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.promooffer.accept" call.
-func (c *PromoofferAcceptCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "",
- // "httpMethod": "POST",
- // "id": "books.promooffer.accept",
- // "parameters": {
- // "androidId": {
- // "description": "device android_id",
- // "location": "query",
- // "type": "string"
- // },
- // "device": {
- // "description": "device device",
- // "location": "query",
- // "type": "string"
- // },
- // "manufacturer": {
- // "description": "device manufacturer",
- // "location": "query",
- // "type": "string"
- // },
- // "model": {
- // "description": "device model",
- // "location": "query",
- // "type": "string"
- // },
- // "offerId": {
- // "location": "query",
- // "type": "string"
- // },
- // "product": {
- // "description": "device product",
- // "location": "query",
- // "type": "string"
- // },
- // "serial": {
- // "description": "device serial",
- // "location": "query",
- // "type": "string"
- // },
- // "volumeId": {
- // "description": "Volume id to exercise the offer",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "promooffer/accept",
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.promooffer.dismiss":
-
-type PromoofferDismissCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Dismiss:
-func (r *PromoofferService) Dismiss() *PromoofferDismissCall {
- c := &PromoofferDismissCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// AndroidId sets the optional parameter "androidId": device android_id
-func (c *PromoofferDismissCall) AndroidId(androidId string) *PromoofferDismissCall {
- c.opt_["androidId"] = androidId
- return c
-}
-
-// Device sets the optional parameter "device": device device
-func (c *PromoofferDismissCall) Device(device string) *PromoofferDismissCall {
- c.opt_["device"] = device
- return c
-}
-
-// Manufacturer sets the optional parameter "manufacturer": device
-// manufacturer
-func (c *PromoofferDismissCall) Manufacturer(manufacturer string) *PromoofferDismissCall {
- c.opt_["manufacturer"] = manufacturer
- return c
-}
-
-// Model sets the optional parameter "model": device model
-func (c *PromoofferDismissCall) Model(model string) *PromoofferDismissCall {
- c.opt_["model"] = model
- return c
-}
-
-// OfferId sets the optional parameter "offerId": Offer to dimiss
-func (c *PromoofferDismissCall) OfferId(offerId string) *PromoofferDismissCall {
- c.opt_["offerId"] = offerId
- return c
-}
-
-// Product sets the optional parameter "product": device product
-func (c *PromoofferDismissCall) Product(product string) *PromoofferDismissCall {
- c.opt_["product"] = product
- return c
-}
-
-// Serial sets the optional parameter "serial": device serial
-func (c *PromoofferDismissCall) Serial(serial string) *PromoofferDismissCall {
- c.opt_["serial"] = serial
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PromoofferDismissCall) Fields(s ...googleapi.Field) *PromoofferDismissCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PromoofferDismissCall) Context(ctx context.Context) *PromoofferDismissCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PromoofferDismissCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["androidId"]; ok {
- params.Set("androidId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["device"]; ok {
- params.Set("device", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["manufacturer"]; ok {
- params.Set("manufacturer", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["model"]; ok {
- params.Set("model", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["offerId"]; ok {
- params.Set("offerId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["product"]; ok {
- params.Set("product", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["serial"]; ok {
- params.Set("serial", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "promooffer/dismiss")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.promooffer.dismiss" call.
-func (c *PromoofferDismissCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "",
- // "httpMethod": "POST",
- // "id": "books.promooffer.dismiss",
- // "parameters": {
- // "androidId": {
- // "description": "device android_id",
- // "location": "query",
- // "type": "string"
- // },
- // "device": {
- // "description": "device device",
- // "location": "query",
- // "type": "string"
- // },
- // "manufacturer": {
- // "description": "device manufacturer",
- // "location": "query",
- // "type": "string"
- // },
- // "model": {
- // "description": "device model",
- // "location": "query",
- // "type": "string"
- // },
- // "offerId": {
- // "description": "Offer to dimiss",
- // "location": "query",
- // "type": "string"
- // },
- // "product": {
- // "description": "device product",
- // "location": "query",
- // "type": "string"
- // },
- // "serial": {
- // "description": "device serial",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "promooffer/dismiss",
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.promooffer.get":
-
-type PromoofferGetCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns a list of promo offers available to the user
-func (r *PromoofferService) Get() *PromoofferGetCall {
- c := &PromoofferGetCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// AndroidId sets the optional parameter "androidId": device android_id
-func (c *PromoofferGetCall) AndroidId(androidId string) *PromoofferGetCall {
- c.opt_["androidId"] = androidId
- return c
-}
-
-// Device sets the optional parameter "device": device device
-func (c *PromoofferGetCall) Device(device string) *PromoofferGetCall {
- c.opt_["device"] = device
- return c
-}
-
-// Manufacturer sets the optional parameter "manufacturer": device
-// manufacturer
-func (c *PromoofferGetCall) Manufacturer(manufacturer string) *PromoofferGetCall {
- c.opt_["manufacturer"] = manufacturer
- return c
-}
-
-// Model sets the optional parameter "model": device model
-func (c *PromoofferGetCall) Model(model string) *PromoofferGetCall {
- c.opt_["model"] = model
- return c
-}
-
-// Product sets the optional parameter "product": device product
-func (c *PromoofferGetCall) Product(product string) *PromoofferGetCall {
- c.opt_["product"] = product
- return c
-}
-
-// Serial sets the optional parameter "serial": device serial
-func (c *PromoofferGetCall) Serial(serial string) *PromoofferGetCall {
- c.opt_["serial"] = serial
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PromoofferGetCall) Fields(s ...googleapi.Field) *PromoofferGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PromoofferGetCall) IfNoneMatch(entityTag string) *PromoofferGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PromoofferGetCall) Context(ctx context.Context) *PromoofferGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PromoofferGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["androidId"]; ok {
- params.Set("androidId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["device"]; ok {
- params.Set("device", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["manufacturer"]; ok {
- params.Set("manufacturer", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["model"]; ok {
- params.Set("model", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["product"]; ok {
- params.Set("product", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["serial"]; ok {
- params.Set("serial", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "promooffer/get")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.promooffer.get" call.
-// Exactly one of *Offers or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Offers.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *PromoofferGetCall) Do() (*Offers, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Offers{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns a list of promo offers available to the user",
- // "httpMethod": "GET",
- // "id": "books.promooffer.get",
- // "parameters": {
- // "androidId": {
- // "description": "device android_id",
- // "location": "query",
- // "type": "string"
- // },
- // "device": {
- // "description": "device device",
- // "location": "query",
- // "type": "string"
- // },
- // "manufacturer": {
- // "description": "device manufacturer",
- // "location": "query",
- // "type": "string"
- // },
- // "model": {
- // "description": "device model",
- // "location": "query",
- // "type": "string"
- // },
- // "product": {
- // "description": "device product",
- // "location": "query",
- // "type": "string"
- // },
- // "serial": {
- // "description": "device serial",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "promooffer/get",
- // "response": {
- // "$ref": "Offers"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.volumes.get":
-
-type VolumesGetCall struct {
- s *Service
- volumeId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets volume information for a single volume.
-func (r *VolumesService) Get(volumeId string) *VolumesGetCall {
- c := &VolumesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.volumeId = volumeId
- return c
-}
-
-// Country sets the optional parameter "country": ISO-3166-1 code to
-// override the IP-based location.
-func (c *VolumesGetCall) Country(country string) *VolumesGetCall {
- c.opt_["country"] = country
- return c
-}
-
-// Partner sets the optional parameter "partner": Brand results for
-// partner ID.
-func (c *VolumesGetCall) Partner(partner string) *VolumesGetCall {
- c.opt_["partner"] = partner
- return c
-}
-
-// Projection sets the optional parameter "projection": Restrict
-// information returned to a set of selected fields.
-//
-// Possible values:
-// "full" - Includes all volume data.
-// "lite" - Includes a subset of fields in volumeInfo and accessInfo.
-func (c *VolumesGetCall) Projection(projection string) *VolumesGetCall {
- c.opt_["projection"] = projection
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *VolumesGetCall) Source(source string) *VolumesGetCall {
- c.opt_["source"] = source
- return c
-}
-
-// UserLibraryConsistentRead sets the optional parameter
-// "user_library_consistent_read":
-func (c *VolumesGetCall) UserLibraryConsistentRead(userLibraryConsistentRead bool) *VolumesGetCall {
- c.opt_["user_library_consistent_read"] = userLibraryConsistentRead
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *VolumesGetCall) Fields(s ...googleapi.Field) *VolumesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *VolumesGetCall) IfNoneMatch(entityTag string) *VolumesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *VolumesGetCall) Context(ctx context.Context) *VolumesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *VolumesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["country"]; ok {
- params.Set("country", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["partner"]; ok {
- params.Set("partner", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["projection"]; ok {
- params.Set("projection", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["user_library_consistent_read"]; ok {
- params.Set("user_library_consistent_read", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "volumes/{volumeId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "volumeId": c.volumeId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.volumes.get" call.
-// Exactly one of *Volume or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Volume.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *VolumesGetCall) Do() (*Volume, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Volume{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets volume information for a single volume.",
- // "httpMethod": "GET",
- // "id": "books.volumes.get",
- // "parameterOrder": [
- // "volumeId"
- // ],
- // "parameters": {
- // "country": {
- // "description": "ISO-3166-1 code to override the IP-based location.",
- // "location": "query",
- // "type": "string"
- // },
- // "partner": {
- // "description": "Brand results for partner ID.",
- // "location": "query",
- // "type": "string"
- // },
- // "projection": {
- // "description": "Restrict information returned to a set of selected fields.",
- // "enum": [
- // "full",
- // "lite"
- // ],
- // "enumDescriptions": [
- // "Includes all volume data.",
- // "Includes a subset of fields in volumeInfo and accessInfo."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // },
- // "user_library_consistent_read": {
- // "location": "query",
- // "type": "boolean"
- // },
- // "volumeId": {
- // "description": "ID of volume to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "volumes/{volumeId}",
- // "response": {
- // "$ref": "Volume"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.volumes.list":
-
-type VolumesListCall struct {
- s *Service
- q string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Performs a book search.
-func (r *VolumesService) List(q string) *VolumesListCall {
- c := &VolumesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.q = q
- return c
-}
-
-// Download sets the optional parameter "download": Restrict to volumes
-// by download availability.
-//
-// Possible values:
-// "epub" - All volumes with epub.
-func (c *VolumesListCall) Download(download string) *VolumesListCall {
- c.opt_["download"] = download
- return c
-}
-
-// Filter sets the optional parameter "filter": Filter search results.
-//
-// Possible values:
-// "ebooks" - All Google eBooks.
-// "free-ebooks" - Google eBook with full volume text viewability.
-// "full" - Public can view entire volume text.
-// "paid-ebooks" - Google eBook with a price.
-// "partial" - Public able to see parts of text.
-func (c *VolumesListCall) Filter(filter string) *VolumesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// LangRestrict sets the optional parameter "langRestrict": Restrict
-// results to books with this language code.
-func (c *VolumesListCall) LangRestrict(langRestrict string) *VolumesListCall {
- c.opt_["langRestrict"] = langRestrict
- return c
-}
-
-// LibraryRestrict sets the optional parameter "libraryRestrict":
-// Restrict search to this user's library.
-//
-// Possible values:
-// "my-library" - Restrict to the user's library, any shelf.
-// "no-restrict" - Do not restrict based on user's library.
-func (c *VolumesListCall) LibraryRestrict(libraryRestrict string) *VolumesListCall {
- c.opt_["libraryRestrict"] = libraryRestrict
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *VolumesListCall) MaxResults(maxResults int64) *VolumesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sort search results.
-//
-// Possible values:
-// "newest" - Most recently published.
-// "relevance" - Relevance to search terms.
-func (c *VolumesListCall) OrderBy(orderBy string) *VolumesListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// Partner sets the optional parameter "partner": Restrict and brand
-// results for partner ID.
-func (c *VolumesListCall) Partner(partner string) *VolumesListCall {
- c.opt_["partner"] = partner
- return c
-}
-
-// PrintType sets the optional parameter "printType": Restrict to books
-// or magazines.
-//
-// Possible values:
-// "all" - All volume content types.
-// "books" - Just books.
-// "magazines" - Just magazines.
-func (c *VolumesListCall) PrintType(printType string) *VolumesListCall {
- c.opt_["printType"] = printType
- return c
-}
-
-// Projection sets the optional parameter "projection": Restrict
-// information returned to a set of selected fields.
-//
-// Possible values:
-// "full" - Includes all volume data.
-// "lite" - Includes a subset of fields in volumeInfo and accessInfo.
-func (c *VolumesListCall) Projection(projection string) *VolumesListCall {
- c.opt_["projection"] = projection
- return c
-}
-
-// ShowPreorders sets the optional parameter "showPreorders": Set to
-// true to show books available for preorder. Defaults to false.
-func (c *VolumesListCall) ShowPreorders(showPreorders bool) *VolumesListCall {
- c.opt_["showPreorders"] = showPreorders
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *VolumesListCall) Source(source string) *VolumesListCall {
- c.opt_["source"] = source
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex": Index of the
-// first result to return (starts at 0)
-func (c *VolumesListCall) StartIndex(startIndex int64) *VolumesListCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *VolumesListCall) Fields(s ...googleapi.Field) *VolumesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *VolumesListCall) IfNoneMatch(entityTag string) *VolumesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *VolumesListCall) Context(ctx context.Context) *VolumesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *VolumesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("q", fmt.Sprintf("%v", c.q))
- if v, ok := c.opt_["download"]; ok {
- params.Set("download", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["langRestrict"]; ok {
- params.Set("langRestrict", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["libraryRestrict"]; ok {
- params.Set("libraryRestrict", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["partner"]; ok {
- params.Set("partner", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["printType"]; ok {
- params.Set("printType", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["projection"]; ok {
- params.Set("projection", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["showPreorders"]; ok {
- params.Set("showPreorders", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "volumes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.volumes.list" call.
-// Exactly one of *Volumes or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Volumes.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *VolumesListCall) Do() (*Volumes, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Volumes{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Performs a book search.",
- // "httpMethod": "GET",
- // "id": "books.volumes.list",
- // "parameterOrder": [
- // "q"
- // ],
- // "parameters": {
- // "download": {
- // "description": "Restrict to volumes by download availability.",
- // "enum": [
- // "epub"
- // ],
- // "enumDescriptions": [
- // "All volumes with epub."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "filter": {
- // "description": "Filter search results.",
- // "enum": [
- // "ebooks",
- // "free-ebooks",
- // "full",
- // "paid-ebooks",
- // "partial"
- // ],
- // "enumDescriptions": [
- // "All Google eBooks.",
- // "Google eBook with full volume text viewability.",
- // "Public can view entire volume text.",
- // "Google eBook with a price.",
- // "Public able to see parts of text."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "langRestrict": {
- // "description": "Restrict results to books with this language code.",
- // "location": "query",
- // "type": "string"
- // },
- // "libraryRestrict": {
- // "description": "Restrict search to this user's library.",
- // "enum": [
- // "my-library",
- // "no-restrict"
- // ],
- // "enumDescriptions": [
- // "Restrict to the user's library, any shelf.",
- // "Do not restrict based on user's library."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "40",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sort search results.",
- // "enum": [
- // "newest",
- // "relevance"
- // ],
- // "enumDescriptions": [
- // "Most recently published.",
- // "Relevance to search terms."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "partner": {
- // "description": "Restrict and brand results for partner ID.",
- // "location": "query",
- // "type": "string"
- // },
- // "printType": {
- // "description": "Restrict to books or magazines.",
- // "enum": [
- // "all",
- // "books",
- // "magazines"
- // ],
- // "enumDescriptions": [
- // "All volume content types.",
- // "Just books.",
- // "Just magazines."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "projection": {
- // "description": "Restrict information returned to a set of selected fields.",
- // "enum": [
- // "full",
- // "lite"
- // ],
- // "enumDescriptions": [
- // "Includes all volume data.",
- // "Includes a subset of fields in volumeInfo and accessInfo."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "q": {
- // "description": "Full-text search query string.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "showPreorders": {
- // "description": "Set to true to show books available for preorder. Defaults to false.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // },
- // "startIndex": {
- // "description": "Index of the first result to return (starts at 0)",
- // "format": "uint32",
- // "location": "query",
- // "minimum": "0",
- // "type": "integer"
- // }
- // },
- // "path": "volumes",
- // "response": {
- // "$ref": "Volumes"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.volumes.associated.list":
-
-type VolumesAssociatedListCall struct {
- s *Service
- volumeId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Return a list of associated books.
-func (r *VolumesAssociatedService) List(volumeId string) *VolumesAssociatedListCall {
- c := &VolumesAssociatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.volumeId = volumeId
- return c
-}
-
-// Association sets the optional parameter "association": Association
-// type.
-//
-// Possible values:
-// "end-of-sample" - Recommendations for display end-of-sample.
-// "end-of-volume" - Recommendations for display end-of-volume.
-// "related-for-play" - Related volumes for Play Store.
-func (c *VolumesAssociatedListCall) Association(association string) *VolumesAssociatedListCall {
- c.opt_["association"] = association
- return c
-}
-
-// Locale sets the optional parameter "locale": ISO-639-1 language and
-// ISO-3166-1 country code. Ex: 'en_US'. Used for generating
-// recommendations.
-func (c *VolumesAssociatedListCall) Locale(locale string) *VolumesAssociatedListCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// MaxAllowedMaturityRating sets the optional parameter
-// "maxAllowedMaturityRating": The maximum allowed maturity rating of
-// returned recommendations. Books with a higher maturity rating are
-// filtered out.
-//
-// Possible values:
-// "mature" - Show books which are rated mature or lower.
-// "not-mature" - Show books which are rated not mature.
-func (c *VolumesAssociatedListCall) MaxAllowedMaturityRating(maxAllowedMaturityRating string) *VolumesAssociatedListCall {
- c.opt_["maxAllowedMaturityRating"] = maxAllowedMaturityRating
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *VolumesAssociatedListCall) Source(source string) *VolumesAssociatedListCall {
- c.opt_["source"] = source
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *VolumesAssociatedListCall) Fields(s ...googleapi.Field) *VolumesAssociatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *VolumesAssociatedListCall) IfNoneMatch(entityTag string) *VolumesAssociatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *VolumesAssociatedListCall) Context(ctx context.Context) *VolumesAssociatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *VolumesAssociatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["association"]; ok {
- params.Set("association", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxAllowedMaturityRating"]; ok {
- params.Set("maxAllowedMaturityRating", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "volumes/{volumeId}/associated")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "volumeId": c.volumeId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.volumes.associated.list" call.
-// Exactly one of *Volumes or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Volumes.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *VolumesAssociatedListCall) Do() (*Volumes, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Volumes{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Return a list of associated books.",
- // "httpMethod": "GET",
- // "id": "books.volumes.associated.list",
- // "parameterOrder": [
- // "volumeId"
- // ],
- // "parameters": {
- // "association": {
- // "description": "Association type.",
- // "enum": [
- // "end-of-sample",
- // "end-of-volume",
- // "related-for-play"
- // ],
- // "enumDescriptions": [
- // "Recommendations for display end-of-sample.",
- // "Recommendations for display end-of-volume.",
- // "Related volumes for Play Store."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "locale": {
- // "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxAllowedMaturityRating": {
- // "description": "The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.",
- // "enum": [
- // "mature",
- // "not-mature"
- // ],
- // "enumDescriptions": [
- // "Show books which are rated mature or lower.",
- // "Show books which are rated not mature."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // },
- // "volumeId": {
- // "description": "ID of the source volume.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "volumes/{volumeId}/associated",
- // "response": {
- // "$ref": "Volumes"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.volumes.mybooks.list":
-
-type VolumesMybooksListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Return a list of books in My Library.
-func (r *VolumesMybooksService) List() *VolumesMybooksListCall {
- c := &VolumesMybooksListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// AcquireMethod sets the optional parameter "acquireMethod": How the
-// book was aquired
-//
-// Possible values:
-// "PREORDERED" - Preordered books (not yet available)
-// "PREVIOUSLY_RENTED" - User-rented books past their expiration time
-// "PUBLIC_DOMAIN" - Public domain books
-// "PURCHASED" - Purchased books
-// "RENTED" - User-rented books
-// "SAMPLE" - Sample books
-// "UPLOADED" - User uploaded books
-func (c *VolumesMybooksListCall) AcquireMethod(acquireMethod string) *VolumesMybooksListCall {
- c.opt_["acquireMethod"] = acquireMethod
- return c
-}
-
-// Locale sets the optional parameter "locale": ISO-639-1 language and
-// ISO-3166-1 country code. Ex:'en_US'. Used for generating
-// recommendations.
-func (c *VolumesMybooksListCall) Locale(locale string) *VolumesMybooksListCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *VolumesMybooksListCall) MaxResults(maxResults int64) *VolumesMybooksListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// ProcessingState sets the optional parameter "processingState": The
-// processing state of the user uploaded volumes to be returned.
-// Applicable only if the UPLOADED is specified in the acquireMethod.
-//
-// Possible values:
-// "COMPLETED_FAILED" - The volume processing hase failed.
-// "COMPLETED_SUCCESS" - The volume processing was completed.
-// "RUNNING" - The volume processing is not completed.
-func (c *VolumesMybooksListCall) ProcessingState(processingState string) *VolumesMybooksListCall {
- c.opt_["processingState"] = processingState
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *VolumesMybooksListCall) Source(source string) *VolumesMybooksListCall {
- c.opt_["source"] = source
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex": Index of the
-// first result to return (starts at 0)
-func (c *VolumesMybooksListCall) StartIndex(startIndex int64) *VolumesMybooksListCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *VolumesMybooksListCall) Fields(s ...googleapi.Field) *VolumesMybooksListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *VolumesMybooksListCall) IfNoneMatch(entityTag string) *VolumesMybooksListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *VolumesMybooksListCall) Context(ctx context.Context) *VolumesMybooksListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *VolumesMybooksListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["acquireMethod"]; ok {
- params.Set("acquireMethod", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["processingState"]; ok {
- params.Set("processingState", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "volumes/mybooks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.volumes.mybooks.list" call.
-// Exactly one of *Volumes or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Volumes.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *VolumesMybooksListCall) Do() (*Volumes, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Volumes{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Return a list of books in My Library.",
- // "httpMethod": "GET",
- // "id": "books.volumes.mybooks.list",
- // "parameters": {
- // "acquireMethod": {
- // "description": "How the book was aquired",
- // "enum": [
- // "PREORDERED",
- // "PREVIOUSLY_RENTED",
- // "PUBLIC_DOMAIN",
- // "PURCHASED",
- // "RENTED",
- // "SAMPLE",
- // "UPLOADED"
- // ],
- // "enumDescriptions": [
- // "Preordered books (not yet available)",
- // "User-rented books past their expiration time",
- // "Public domain books",
- // "Purchased books",
- // "User-rented books",
- // "Sample books",
- // "User uploaded books"
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "locale": {
- // "description": "ISO-639-1 language and ISO-3166-1 country code. Ex:'en_US'. Used for generating recommendations.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "100",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "processingState": {
- // "description": "The processing state of the user uploaded volumes to be returned. Applicable only if the UPLOADED is specified in the acquireMethod.",
- // "enum": [
- // "COMPLETED_FAILED",
- // "COMPLETED_SUCCESS",
- // "RUNNING"
- // ],
- // "enumDescriptions": [
- // "The volume processing hase failed.",
- // "The volume processing was completed.",
- // "The volume processing is not completed."
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // },
- // "startIndex": {
- // "description": "Index of the first result to return (starts at 0)",
- // "format": "uint32",
- // "location": "query",
- // "minimum": "0",
- // "type": "integer"
- // }
- // },
- // "path": "volumes/mybooks",
- // "response": {
- // "$ref": "Volumes"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.volumes.recommended.list":
-
-type VolumesRecommendedListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Return a list of recommended books for the current user.
-func (r *VolumesRecommendedService) List() *VolumesRecommendedListCall {
- c := &VolumesRecommendedListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Locale sets the optional parameter "locale": ISO-639-1 language and
-// ISO-3166-1 country code. Ex: 'en_US'. Used for generating
-// recommendations.
-func (c *VolumesRecommendedListCall) Locale(locale string) *VolumesRecommendedListCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// MaxAllowedMaturityRating sets the optional parameter
-// "maxAllowedMaturityRating": The maximum allowed maturity rating of
-// returned recommendations. Books with a higher maturity rating are
-// filtered out.
-//
-// Possible values:
-// "mature" - Show books which are rated mature or lower.
-// "not-mature" - Show books which are rated not mature.
-func (c *VolumesRecommendedListCall) MaxAllowedMaturityRating(maxAllowedMaturityRating string) *VolumesRecommendedListCall {
- c.opt_["maxAllowedMaturityRating"] = maxAllowedMaturityRating
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *VolumesRecommendedListCall) Source(source string) *VolumesRecommendedListCall {
- c.opt_["source"] = source
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *VolumesRecommendedListCall) Fields(s ...googleapi.Field) *VolumesRecommendedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *VolumesRecommendedListCall) IfNoneMatch(entityTag string) *VolumesRecommendedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *VolumesRecommendedListCall) Context(ctx context.Context) *VolumesRecommendedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *VolumesRecommendedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxAllowedMaturityRating"]; ok {
- params.Set("maxAllowedMaturityRating", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "volumes/recommended")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.volumes.recommended.list" call.
-// Exactly one of *Volumes or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Volumes.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *VolumesRecommendedListCall) Do() (*Volumes, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Volumes{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Return a list of recommended books for the current user.",
- // "httpMethod": "GET",
- // "id": "books.volumes.recommended.list",
- // "parameters": {
- // "locale": {
- // "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxAllowedMaturityRating": {
- // "description": "The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.",
- // "enum": [
- // "mature",
- // "not-mature"
- // ],
- // "enumDescriptions": [
- // "Show books which are rated mature or lower.",
- // "Show books which are rated not mature."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "volumes/recommended",
- // "response": {
- // "$ref": "Volumes"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.volumes.recommended.rate":
-
-type VolumesRecommendedRateCall struct {
- s *Service
- rating string
- volumeId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Rate: Rate a recommended book for the current user.
-func (r *VolumesRecommendedService) Rate(rating string, volumeId string) *VolumesRecommendedRateCall {
- c := &VolumesRecommendedRateCall{s: r.s, opt_: make(map[string]interface{})}
- c.rating = rating
- c.volumeId = volumeId
- return c
-}
-
-// Locale sets the optional parameter "locale": ISO-639-1 language and
-// ISO-3166-1 country code. Ex: 'en_US'. Used for generating
-// recommendations.
-func (c *VolumesRecommendedRateCall) Locale(locale string) *VolumesRecommendedRateCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *VolumesRecommendedRateCall) Source(source string) *VolumesRecommendedRateCall {
- c.opt_["source"] = source
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *VolumesRecommendedRateCall) Fields(s ...googleapi.Field) *VolumesRecommendedRateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *VolumesRecommendedRateCall) Context(ctx context.Context) *VolumesRecommendedRateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *VolumesRecommendedRateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("rating", fmt.Sprintf("%v", c.rating))
- params.Set("volumeId", fmt.Sprintf("%v", c.volumeId))
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "volumes/recommended/rate")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.volumes.recommended.rate" call.
-// Exactly one of *BooksVolumesRecommendedRateResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *BooksVolumesRecommendedRateResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *VolumesRecommendedRateCall) Do() (*BooksVolumesRecommendedRateResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &BooksVolumesRecommendedRateResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Rate a recommended book for the current user.",
- // "httpMethod": "POST",
- // "id": "books.volumes.recommended.rate",
- // "parameterOrder": [
- // "rating",
- // "volumeId"
- // ],
- // "parameters": {
- // "locale": {
- // "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.",
- // "location": "query",
- // "type": "string"
- // },
- // "rating": {
- // "description": "Rating to be given to the volume.",
- // "enum": [
- // "HAVE_IT",
- // "NOT_INTERESTED"
- // ],
- // "enumDescriptions": [
- // "Rating indicating a dismissal due to ownership.",
- // "Rating indicating a negative dismissal of a volume."
- // ],
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // },
- // "volumeId": {
- // "description": "ID of the source volume.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "volumes/recommended/rate",
- // "response": {
- // "$ref": "BooksVolumesRecommendedRateResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
-
-// method id "books.volumes.useruploaded.list":
-
-type VolumesUseruploadedListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Return a list of books uploaded by the current user.
-func (r *VolumesUseruploadedService) List() *VolumesUseruploadedListCall {
- c := &VolumesUseruploadedListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Locale sets the optional parameter "locale": ISO-639-1 language and
-// ISO-3166-1 country code. Ex: 'en_US'. Used for generating
-// recommendations.
-func (c *VolumesUseruploadedListCall) Locale(locale string) *VolumesUseruploadedListCall {
- c.opt_["locale"] = locale
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *VolumesUseruploadedListCall) MaxResults(maxResults int64) *VolumesUseruploadedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// ProcessingState sets the optional parameter "processingState": The
-// processing state of the user uploaded volumes to be returned.
-//
-// Possible values:
-// "COMPLETED_FAILED" - The volume processing hase failed.
-// "COMPLETED_SUCCESS" - The volume processing was completed.
-// "RUNNING" - The volume processing is not completed.
-func (c *VolumesUseruploadedListCall) ProcessingState(processingState string) *VolumesUseruploadedListCall {
- c.opt_["processingState"] = processingState
- return c
-}
-
-// Source sets the optional parameter "source": String to identify the
-// originator of this request.
-func (c *VolumesUseruploadedListCall) Source(source string) *VolumesUseruploadedListCall {
- c.opt_["source"] = source
- return c
-}
-
-// StartIndex sets the optional parameter "startIndex": Index of the
-// first result to return (starts at 0)
-func (c *VolumesUseruploadedListCall) StartIndex(startIndex int64) *VolumesUseruploadedListCall {
- c.opt_["startIndex"] = startIndex
- return c
-}
-
-// VolumeId sets the optional parameter "volumeId": The ids of the
-// volumes to be returned. If not specified all that match the
-// processingState are returned.
-func (c *VolumesUseruploadedListCall) VolumeId(volumeId string) *VolumesUseruploadedListCall {
- c.opt_["volumeId"] = volumeId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *VolumesUseruploadedListCall) Fields(s ...googleapi.Field) *VolumesUseruploadedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *VolumesUseruploadedListCall) IfNoneMatch(entityTag string) *VolumesUseruploadedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *VolumesUseruploadedListCall) Context(ctx context.Context) *VolumesUseruploadedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *VolumesUseruploadedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["locale"]; ok {
- params.Set("locale", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["processingState"]; ok {
- params.Set("processingState", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["source"]; ok {
- params.Set("source", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startIndex"]; ok {
- params.Set("startIndex", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["volumeId"]; ok {
- params.Set("volumeId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "volumes/useruploaded")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "books.volumes.useruploaded.list" call.
-// Exactly one of *Volumes or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Volumes.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *VolumesUseruploadedListCall) Do() (*Volumes, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Volumes{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Return a list of books uploaded by the current user.",
- // "httpMethod": "GET",
- // "id": "books.volumes.useruploaded.list",
- // "parameters": {
- // "locale": {
- // "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "40",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "processingState": {
- // "description": "The processing state of the user uploaded volumes to be returned.",
- // "enum": [
- // "COMPLETED_FAILED",
- // "COMPLETED_SUCCESS",
- // "RUNNING"
- // ],
- // "enumDescriptions": [
- // "The volume processing hase failed.",
- // "The volume processing was completed.",
- // "The volume processing is not completed."
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "source": {
- // "description": "String to identify the originator of this request.",
- // "location": "query",
- // "type": "string"
- // },
- // "startIndex": {
- // "description": "Index of the first result to return (starts at 0)",
- // "format": "uint32",
- // "location": "query",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "volumeId": {
- // "description": "The ids of the volumes to be returned. If not specified all that match the processingState are returned.",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // }
- // },
- // "path": "volumes/useruploaded",
- // "response": {
- // "$ref": "Volumes"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/books"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/calendar/v3/calendar-api.json b/vendor/google.golang.org/api/calendar/v3/calendar-api.json
deleted file mode 100644
index 887eadf1..00000000
--- a/vendor/google.golang.org/api/calendar/v3/calendar-api.json
+++ /dev/null
@@ -1,2666 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/l_k1z-nMnRAcKQK6zuQvkZvA4dI\"",
- "discoveryVersion": "v1",
- "id": "calendar:v3",
- "name": "calendar",
- "version": "v3",
- "revision": "20150902",
- "title": "Calendar API",
- "description": "Lets you manipulate events and other calendar data.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/calendar-16.png",
- "x32": "http://www.google.com/images/icons/product/calendar-32.png"
- },
- "documentationLink": "https://developers.google.com/google-apps/calendar/firstapp",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/calendar/v3/",
- "basePath": "/calendar/v3/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "calendar/v3/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/calendar": {
- "description": "Manage your calendars"
- },
- "https://www.googleapis.com/auth/calendar.readonly": {
- "description": "View your calendars"
- }
- }
- }
- },
- "schemas": {
- "Acl": {
- "id": "Acl",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the collection."
- },
- "items": {
- "type": "array",
- "description": "List of rules on the access control list.",
- "items": {
- "$ref": "AclRule"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of the collection (\"calendar#acl\").",
- "default": "calendar#acl"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided."
- },
- "nextSyncToken": {
- "type": "string",
- "description": "Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided."
- }
- }
- },
- "AclRule": {
- "id": "AclRule",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "id": {
- "type": "string",
- "description": "Identifier of the ACL rule."
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource (\"calendar#aclRule\").",
- "default": "calendar#aclRule"
- },
- "role": {
- "type": "string",
- "description": "The role assigned to the scope. Possible values are: \n- \"none\" - Provides no access. \n- \"freeBusyReader\" - Provides read access to free/busy information. \n- \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. \n- \"owner\" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.",
- "annotations": {
- "required": [
- "calendar.acl.insert"
- ]
- }
- },
- "scope": {
- "type": "object",
- "description": "The scope of the rule.",
- "properties": {
- "type": {
- "type": "string",
- "description": "The type of the scope. Possible values are: \n- \"default\" - The public scope. This is the default value. \n- \"user\" - Limits the scope to a single user. \n- \"group\" - Limits the scope to a group. \n- \"domain\" - Limits the scope to a domain. Note: The permissions granted to the \"default\", or public, scope apply to any user, authenticated or not.",
- "annotations": {
- "required": [
- "calendar.acl.insert"
- ]
- }
- },
- "value": {
- "type": "string",
- "description": "The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type \"default\"."
- }
- },
- "annotations": {
- "required": [
- "calendar.acl.insert"
- ]
- }
- }
- }
- },
- "Calendar": {
- "id": "Calendar",
- "type": "object",
- "properties": {
- "description": {
- "type": "string",
- "description": "Description of the calendar. Optional."
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "id": {
- "type": "string",
- "description": "Identifier of the calendar. To retrieve IDs call the calendarList.list() method."
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource (\"calendar#calendar\").",
- "default": "calendar#calendar"
- },
- "location": {
- "type": "string",
- "description": "Geographic location of the calendar as free-form text. Optional."
- },
- "summary": {
- "type": "string",
- "description": "Title of the calendar.",
- "annotations": {
- "required": [
- "calendar.calendars.insert"
- ]
- }
- },
- "timeZone": {
- "type": "string",
- "description": "The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. \"Europe/Zurich\".) Optional."
- }
- }
- },
- "CalendarList": {
- "id": "CalendarList",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the collection."
- },
- "items": {
- "type": "array",
- "description": "Calendars that are present on the user's calendar list.",
- "items": {
- "$ref": "CalendarListEntry"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of the collection (\"calendar#calendarList\").",
- "default": "calendar#calendarList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided."
- },
- "nextSyncToken": {
- "type": "string",
- "description": "Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided."
- }
- }
- },
- "CalendarListEntry": {
- "id": "CalendarListEntry",
- "type": "object",
- "properties": {
- "accessRole": {
- "type": "string",
- "description": "The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: \n- \"freeBusyReader\" - Provides read access to free/busy information. \n- \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. \n- \"owner\" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs."
- },
- "backgroundColor": {
- "type": "string",
- "description": "The main color of the calendar in the hexadecimal format \"#0088aa\". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional."
- },
- "colorId": {
- "type": "string",
- "description": "The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional."
- },
- "defaultReminders": {
- "type": "array",
- "description": "The default reminders that the authenticated user has for this calendar.",
- "items": {
- "$ref": "EventReminder"
- }
- },
- "deleted": {
- "type": "boolean",
- "description": "Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.",
- "default": "false"
- },
- "description": {
- "type": "string",
- "description": "Description of the calendar. Optional. Read-only."
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "foregroundColor": {
- "type": "string",
- "description": "The foreground color of the calendar in the hexadecimal format \"#ffffff\". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional."
- },
- "hidden": {
- "type": "boolean",
- "description": "Whether the calendar has been hidden from the list. Optional. The default is False.",
- "default": "false"
- },
- "id": {
- "type": "string",
- "description": "Identifier of the calendar.",
- "annotations": {
- "required": [
- "calendar.calendarList.insert"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource (\"calendar#calendarListEntry\").",
- "default": "calendar#calendarListEntry"
- },
- "location": {
- "type": "string",
- "description": "Geographic location of the calendar as free-form text. Optional. Read-only."
- },
- "notificationSettings": {
- "type": "object",
- "description": "The notifications that the authenticated user is receiving for this calendar.",
- "properties": {
- "notifications": {
- "type": "array",
- "description": "The list of notifications set for this calendar.",
- "items": {
- "$ref": "CalendarNotification"
- }
- }
- }
- },
- "primary": {
- "type": "boolean",
- "description": "Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.",
- "default": "false"
- },
- "selected": {
- "type": "boolean",
- "description": "Whether the calendar content shows up in the calendar UI. Optional. The default is False.",
- "default": "false"
- },
- "summary": {
- "type": "string",
- "description": "Title of the calendar. Read-only."
- },
- "summaryOverride": {
- "type": "string",
- "description": "The summary that the authenticated user has set for this calendar. Optional."
- },
- "timeZone": {
- "type": "string",
- "description": "The time zone of the calendar. Optional. Read-only."
- }
- }
- },
- "CalendarNotification": {
- "id": "CalendarNotification",
- "type": "object",
- "properties": {
- "method": {
- "type": "string",
- "description": "The method used to deliver the notification. Possible values are: \n- \"email\" - Reminders are sent via email. \n- \"sms\" - Reminders are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS reminders are only available for Google Apps for Work, Education, and Government customers.",
- "annotations": {
- "required": [
- "calendar.calendarList.insert",
- "calendar.calendarList.update"
- ]
- }
- },
- "type": {
- "type": "string",
- "description": "The type of notification. Possible values are: \n- \"eventCreation\" - Notification sent when a new event is put on the calendar. \n- \"eventChange\" - Notification sent when an event is changed. \n- \"eventCancellation\" - Notification sent when an event is cancelled. \n- \"eventResponse\" - Notification sent when an event is changed. \n- \"agenda\" - An agenda with the events of the day (sent out in the morning).",
- "annotations": {
- "required": [
- "calendar.calendarList.insert",
- "calendar.calendarList.update"
- ]
- }
- }
- }
- },
- "Channel": {
- "id": "Channel",
- "type": "object",
- "properties": {
- "address": {
- "type": "string",
- "description": "The address where notifications are delivered for this channel."
- },
- "expiration": {
- "type": "string",
- "description": "Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "A UUID or similar unique string that identifies this channel."
- },
- "kind": {
- "type": "string",
- "description": "Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string \"api#channel\".",
- "default": "api#channel"
- },
- "params": {
- "type": "object",
- "description": "Additional parameters controlling delivery channel behavior. Optional.",
- "additionalProperties": {
- "type": "string",
- "description": "Declares a new parameter by name."
- }
- },
- "payload": {
- "type": "boolean",
- "description": "A Boolean value to indicate whether payload is wanted. Optional."
- },
- "resourceId": {
- "type": "string",
- "description": "An opaque ID that identifies the resource being watched on this channel. Stable across different API versions."
- },
- "resourceUri": {
- "type": "string",
- "description": "A version-specific identifier for the watched resource."
- },
- "token": {
- "type": "string",
- "description": "An arbitrary string delivered to the target address with each notification delivered over this channel. Optional."
- },
- "type": {
- "type": "string",
- "description": "The type of delivery mechanism used for this channel."
- }
- }
- },
- "ColorDefinition": {
- "id": "ColorDefinition",
- "type": "object",
- "properties": {
- "background": {
- "type": "string",
- "description": "The background color associated with this color definition."
- },
- "foreground": {
- "type": "string",
- "description": "The foreground color that can be used to write on top of a background with 'background' color."
- }
- }
- },
- "Colors": {
- "id": "Colors",
- "type": "object",
- "properties": {
- "calendar": {
- "type": "object",
- "description": "A global palette of calendar colors, mapping from the color ID to its definition. A calendarListEntry resource refers to one of these color IDs in its color field. Read-only.",
- "additionalProperties": {
- "$ref": "ColorDefinition",
- "description": "A calendar color defintion."
- }
- },
- "event": {
- "type": "object",
- "description": "A global palette of event colors, mapping from the color ID to its definition. An event resource may refer to one of these color IDs in its color field. Read-only.",
- "additionalProperties": {
- "$ref": "ColorDefinition",
- "description": "An event color definition."
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource (\"calendar#colors\").",
- "default": "calendar#colors"
- },
- "updated": {
- "type": "string",
- "description": "Last modification time of the color palette (as a RFC3339 timestamp). Read-only.",
- "format": "date-time"
- }
- }
- },
- "Error": {
- "id": "Error",
- "type": "object",
- "properties": {
- "domain": {
- "type": "string",
- "description": "Domain, or broad category, of the error."
- },
- "reason": {
- "type": "string",
- "description": "Specific reason for the error. Some of the possible values are: \n- \"groupTooBig\" - The group of users requested is too large for a single query. \n- \"tooManyCalendarsRequested\" - The number of calendars requested is too large for a single query. \n- \"notFound\" - The requested resource was not found. \n- \"internalError\" - The API service has encountered an internal error. Additional error types may be added in the future, so clients should gracefully handle additional error statuses not included in this list."
- }
- }
- },
- "Event": {
- "id": "Event",
- "type": "object",
- "properties": {
- "anyoneCanAddSelf": {
- "type": "boolean",
- "description": "Whether anyone can invite themselves to the event. Optional. The default is False.",
- "default": "false"
- },
- "attachments": {
- "type": "array",
- "description": "File attachments for the event. Currently only Google Drive attachments are supported.\nIn order to modify attachments the supportsAttachments request parameter should be set to true.\nThere can be at most 25 attachments per event,",
- "items": {
- "$ref": "EventAttachment"
- }
- },
- "attendees": {
- "type": "array",
- "description": "The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.",
- "items": {
- "$ref": "EventAttendee"
- }
- },
- "attendeesOmitted": {
- "type": "boolean",
- "description": "Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.",
- "default": "false"
- },
- "colorId": {
- "type": "string",
- "description": "The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional."
- },
- "created": {
- "type": "string",
- "description": "Creation time of the event (as a RFC3339 timestamp). Read-only.",
- "format": "date-time"
- },
- "creator": {
- "type": "object",
- "description": "The creator of the event. Read-only.",
- "properties": {
- "displayName": {
- "type": "string",
- "description": "The creator's name, if available."
- },
- "email": {
- "type": "string",
- "description": "The creator's email address, if available."
- },
- "id": {
- "type": "string",
- "description": "The creator's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API"
- },
- "self": {
- "type": "boolean",
- "description": "Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.",
- "default": "false"
- }
- }
- },
- "description": {
- "type": "string",
- "description": "Description of the event. Optional."
- },
- "end": {
- "$ref": "EventDateTime",
- "description": "The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.",
- "annotations": {
- "required": [
- "calendar.events.import",
- "calendar.events.insert",
- "calendar.events.update"
- ]
- }
- },
- "endTimeUnspecified": {
- "type": "boolean",
- "description": "Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.",
- "default": "false"
- },
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "extendedProperties": {
- "type": "object",
- "description": "Extended properties of the event.",
- "properties": {
- "private": {
- "type": "object",
- "description": "Properties that are private to the copy of the event that appears on this calendar.",
- "additionalProperties": {
- "type": "string",
- "description": "The name of the private property and the corresponding value."
- }
- },
- "shared": {
- "type": "object",
- "description": "Properties that are shared between copies of the event on other attendees' calendars.",
- "additionalProperties": {
- "type": "string",
- "description": "The name of the shared property and the corresponding value."
- }
- }
- }
- },
- "gadget": {
- "type": "object",
- "description": "A gadget that extends this event.",
- "properties": {
- "display": {
- "type": "string",
- "description": "The gadget's display mode. Optional. Possible values are: \n- \"icon\" - The gadget displays next to the event's title in the calendar view. \n- \"chip\" - The gadget displays when the event is clicked."
- },
- "height": {
- "type": "integer",
- "description": "The gadget's height in pixels. The height must be an integer greater than 0. Optional.",
- "format": "int32"
- },
- "iconLink": {
- "type": "string",
- "description": "The gadget's icon URL. The URL scheme must be HTTPS."
- },
- "link": {
- "type": "string",
- "description": "The gadget's URL. The URL scheme must be HTTPS."
- },
- "preferences": {
- "type": "object",
- "description": "Preferences.",
- "additionalProperties": {
- "type": "string",
- "description": "The preference name and corresponding value."
- }
- },
- "title": {
- "type": "string",
- "description": "The gadget's title."
- },
- "type": {
- "type": "string",
- "description": "The gadget's type."
- },
- "width": {
- "type": "integer",
- "description": "The gadget's width in pixels. The width must be an integer greater than 0. Optional.",
- "format": "int32"
- }
- }
- },
- "guestsCanInviteOthers": {
- "type": "boolean",
- "description": "Whether attendees other than the organizer can invite others to the event. Optional. The default is True.",
- "default": "true"
- },
- "guestsCanModify": {
- "type": "boolean",
- "description": "Whether attendees other than the organizer can modify the event. Optional. The default is False.",
- "default": "false"
- },
- "guestsCanSeeOtherGuests": {
- "type": "boolean",
- "description": "Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.",
- "default": "true"
- },
- "hangoutLink": {
- "type": "string",
- "description": "An absolute link to the Google+ hangout associated with this event. Read-only."
- },
- "htmlLink": {
- "type": "string",
- "description": "An absolute link to this event in the Google Calendar Web UI. Read-only."
- },
- "iCalUID": {
- "type": "string",
- "description": "Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.\nNote that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.",
- "annotations": {
- "required": [
- "calendar.events.import"
- ]
- }
- },
- "id": {
- "type": "string",
- "description": "Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: \n- characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 \n- the length of the ID must be between 5 and 1024 characters \n- the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.\nIf you do not specify an ID, it will be automatically generated by the server.\nNote that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs."
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource (\"calendar#event\").",
- "default": "calendar#event"
- },
- "location": {
- "type": "string",
- "description": "Geographic location of the event as free-form text. Optional."
- },
- "locked": {
- "type": "boolean",
- "description": "Whether this is a locked event copy where no changes can be made to the main event fields \"summary\", \"description\", \"location\", \"start\", \"end\" or \"recurrence\". The default is False. Read-Only.",
- "default": "false"
- },
- "organizer": {
- "type": "object",
- "description": "The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event.",
- "properties": {
- "displayName": {
- "type": "string",
- "description": "The organizer's name, if available."
- },
- "email": {
- "type": "string",
- "description": "The organizer's email address, if available. It must be a valid email address as per RFC5322."
- },
- "id": {
- "type": "string",
- "description": "The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API"
- },
- "self": {
- "type": "boolean",
- "description": "Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.",
- "default": "false"
- }
- }
- },
- "originalStartTime": {
- "$ref": "EventDateTime",
- "description": "For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable."
- },
- "privateCopy": {
- "type": "boolean",
- "description": "Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.",
- "default": "false"
- },
- "recurrence": {
- "type": "array",
- "description": "List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.",
- "items": {
- "type": "string"
- }
- },
- "recurringEventId": {
- "type": "string",
- "description": "For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable."
- },
- "reminders": {
- "type": "object",
- "description": "Information about the event's reminders for the authenticated user.",
- "properties": {
- "overrides": {
- "type": "array",
- "description": "If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5.",
- "items": {
- "$ref": "EventReminder"
- }
- },
- "useDefault": {
- "type": "boolean",
- "description": "Whether the default reminders of the calendar apply to the event."
- }
- }
- },
- "sequence": {
- "type": "integer",
- "description": "Sequence number as per iCalendar.",
- "format": "int32"
- },
- "source": {
- "type": "object",
- "description": "Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.",
- "properties": {
- "title": {
- "type": "string",
- "description": "Title of the source; for example a title of a web page or an email subject."
- },
- "url": {
- "type": "string",
- "description": "URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS."
- }
- }
- },
- "start": {
- "$ref": "EventDateTime",
- "description": "The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.",
- "annotations": {
- "required": [
- "calendar.events.import",
- "calendar.events.insert",
- "calendar.events.update"
- ]
- }
- },
- "status": {
- "type": "string",
- "description": "Status of the event. Optional. Possible values are: \n- \"confirmed\" - The event is confirmed. This is the default status. \n- \"tentative\" - The event is tentatively confirmed. \n- \"cancelled\" - The event is cancelled."
- },
- "summary": {
- "type": "string",
- "description": "Title of the event."
- },
- "transparency": {
- "type": "string",
- "description": "Whether the event blocks time on the calendar. Optional. Possible values are: \n- \"opaque\" - The event blocks time on the calendar. This is the default value. \n- \"transparent\" - The event does not block time on the calendar.",
- "default": "opaque"
- },
- "updated": {
- "type": "string",
- "description": "Last modification time of the event (as a RFC3339 timestamp). Read-only.",
- "format": "date-time"
- },
- "visibility": {
- "type": "string",
- "description": "Visibility of the event. Optional. Possible values are: \n- \"default\" - Uses the default visibility for events on the calendar. This is the default value. \n- \"public\" - The event is public and event details are visible to all readers of the calendar. \n- \"private\" - The event is private and only event attendees may view event details. \n- \"confidential\" - The event is private. This value is provided for compatibility reasons.",
- "default": "default"
- }
- }
- },
- "EventAttachment": {
- "id": "EventAttachment",
- "type": "object",
- "properties": {
- "fileId": {
- "type": "string",
- "description": "ID of the attached file. Read-only.\nFor Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API."
- },
- "fileUrl": {
- "type": "string",
- "description": "URL link to the attachment.\nFor adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.",
- "annotations": {
- "required": [
- "calendar.events.import",
- "calendar.events.insert",
- "calendar.events.update"
- ]
- }
- },
- "iconLink": {
- "type": "string",
- "description": "URL link to the attachment's icon. Read-only."
- },
- "mimeType": {
- "type": "string",
- "description": "Internet media type (MIME type) of the attachment."
- },
- "title": {
- "type": "string",
- "description": "Attachment title."
- }
- }
- },
- "EventAttendee": {
- "id": "EventAttendee",
- "type": "object",
- "properties": {
- "additionalGuests": {
- "type": "integer",
- "description": "Number of additional guests. Optional. The default is 0.",
- "default": "0",
- "format": "int32"
- },
- "comment": {
- "type": "string",
- "description": "The attendee's response comment. Optional."
- },
- "displayName": {
- "type": "string",
- "description": "The attendee's name, if available. Optional."
- },
- "email": {
- "type": "string",
- "description": "The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322.",
- "annotations": {
- "required": [
- "calendar.events.import",
- "calendar.events.insert",
- "calendar.events.update"
- ]
- }
- },
- "id": {
- "type": "string",
- "description": "The attendee's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API"
- },
- "optional": {
- "type": "boolean",
- "description": "Whether this is an optional attendee. Optional. The default is False.",
- "default": "false"
- },
- "organizer": {
- "type": "boolean",
- "description": "Whether the attendee is the organizer of the event. Read-only. The default is False."
- },
- "resource": {
- "type": "boolean",
- "description": "Whether the attendee is a resource. Read-only. The default is False.",
- "default": "false"
- },
- "responseStatus": {
- "type": "string",
- "description": "The attendee's response status. Possible values are: \n- \"needsAction\" - The attendee has not responded to the invitation. \n- \"declined\" - The attendee has declined the invitation. \n- \"tentative\" - The attendee has tentatively accepted the invitation. \n- \"accepted\" - The attendee has accepted the invitation."
- },
- "self": {
- "type": "boolean",
- "description": "Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.",
- "default": "false"
- }
- }
- },
- "EventDateTime": {
- "id": "EventDateTime",
- "type": "object",
- "properties": {
- "date": {
- "type": "string",
- "description": "The date, in the format \"yyyy-mm-dd\", if this is an all-day event.",
- "format": "date"
- },
- "dateTime": {
- "type": "string",
- "description": "The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.",
- "format": "date-time"
- },
- "timeZone": {
- "type": "string",
- "description": "The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. \"Europe/Zurich\".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end."
- }
- }
- },
- "EventReminder": {
- "id": "EventReminder",
- "type": "object",
- "properties": {
- "method": {
- "type": "string",
- "description": "The method used by this reminder. Possible values are: \n- \"email\" - Reminders are sent via email. \n- \"sms\" - Reminders are sent via SMS. These are only available for Google Apps for Work, Education, and Government customers. Requests to set SMS reminders for other account types are ignored. \n- \"popup\" - Reminders are sent via a UI popup.",
- "annotations": {
- "required": [
- "calendar.calendarList.insert",
- "calendar.calendarList.update",
- "calendar.events.import",
- "calendar.events.insert",
- "calendar.events.update"
- ]
- }
- },
- "minutes": {
- "type": "integer",
- "description": "Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).",
- "format": "int32",
- "annotations": {
- "required": [
- "calendar.calendarList.insert",
- "calendar.calendarList.update",
- "calendar.events.import",
- "calendar.events.insert",
- "calendar.events.update"
- ]
- }
- }
- }
- },
- "Events": {
- "id": "Events",
- "type": "object",
- "properties": {
- "accessRole": {
- "type": "string",
- "description": "The user's access role for this calendar. Read-only. Possible values are: \n- \"none\" - The user has no access. \n- \"freeBusyReader\" - The user has read access to free/busy information. \n- \"reader\" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"writer\" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. \n- \"owner\" - The user has ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs."
- },
- "defaultReminders": {
- "type": "array",
- "description": "The default reminders on the calendar for the authenticated user. These reminders apply to all events on this calendar that do not explicitly override them (i.e. do not have reminders.useDefault set to True).",
- "items": {
- "$ref": "EventReminder"
- }
- },
- "description": {
- "type": "string",
- "description": "Description of the calendar. Read-only."
- },
- "etag": {
- "type": "string",
- "description": "ETag of the collection."
- },
- "items": {
- "type": "array",
- "description": "List of events on the calendar.",
- "items": {
- "$ref": "Event"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of the collection (\"calendar#events\").",
- "default": "calendar#events"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided."
- },
- "nextSyncToken": {
- "type": "string",
- "description": "Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided."
- },
- "summary": {
- "type": "string",
- "description": "Title of the calendar. Read-only."
- },
- "timeZone": {
- "type": "string",
- "description": "The time zone of the calendar. Read-only."
- },
- "updated": {
- "type": "string",
- "description": "Last modification time of the calendar (as a RFC3339 timestamp). Read-only.",
- "format": "date-time"
- }
- }
- },
- "FreeBusyCalendar": {
- "id": "FreeBusyCalendar",
- "type": "object",
- "properties": {
- "busy": {
- "type": "array",
- "description": "List of time ranges during which this calendar should be regarded as busy.",
- "items": {
- "$ref": "TimePeriod"
- }
- },
- "errors": {
- "type": "array",
- "description": "Optional error(s) (if computation for the calendar failed).",
- "items": {
- "$ref": "Error"
- }
- }
- }
- },
- "FreeBusyGroup": {
- "id": "FreeBusyGroup",
- "type": "object",
- "properties": {
- "calendars": {
- "type": "array",
- "description": "List of calendars' identifiers within a group.",
- "items": {
- "type": "string"
- }
- },
- "errors": {
- "type": "array",
- "description": "Optional error(s) (if computation for the group failed).",
- "items": {
- "$ref": "Error"
- }
- }
- }
- },
- "FreeBusyRequest": {
- "id": "FreeBusyRequest",
- "type": "object",
- "properties": {
- "calendarExpansionMax": {
- "type": "integer",
- "description": "Maximal number of calendars for which FreeBusy information is to be provided. Optional.",
- "format": "int32"
- },
- "groupExpansionMax": {
- "type": "integer",
- "description": "Maximal number of calendar identifiers to be provided for a single group. Optional. An error will be returned for a group with more members than this value.",
- "format": "int32"
- },
- "items": {
- "type": "array",
- "description": "List of calendars and/or groups to query.",
- "items": {
- "$ref": "FreeBusyRequestItem"
- }
- },
- "timeMax": {
- "type": "string",
- "description": "The end of the interval for the query.",
- "format": "date-time"
- },
- "timeMin": {
- "type": "string",
- "description": "The start of the interval for the query.",
- "format": "date-time"
- },
- "timeZone": {
- "type": "string",
- "description": "Time zone used in the response. Optional. The default is UTC.",
- "default": "UTC"
- }
- }
- },
- "FreeBusyRequestItem": {
- "id": "FreeBusyRequestItem",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "The identifier of a calendar or a group."
- }
- }
- },
- "FreeBusyResponse": {
- "id": "FreeBusyResponse",
- "type": "object",
- "properties": {
- "calendars": {
- "type": "object",
- "description": "List of free/busy information for calendars.",
- "additionalProperties": {
- "$ref": "FreeBusyCalendar",
- "description": "Free/busy expansions for a single calendar."
- }
- },
- "groups": {
- "type": "object",
- "description": "Expansion of groups.",
- "additionalProperties": {
- "$ref": "FreeBusyGroup",
- "description": "List of calendars that are members of this group."
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource (\"calendar#freeBusy\").",
- "default": "calendar#freeBusy"
- },
- "timeMax": {
- "type": "string",
- "description": "The end of the interval.",
- "format": "date-time"
- },
- "timeMin": {
- "type": "string",
- "description": "The start of the interval.",
- "format": "date-time"
- }
- }
- },
- "Setting": {
- "id": "Setting",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the resource."
- },
- "id": {
- "type": "string",
- "description": "The id of the user setting."
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource (\"calendar#setting\").",
- "default": "calendar#setting"
- },
- "value": {
- "type": "string",
- "description": "Value of the user setting. The format of the value depends on the ID of the setting. It must always be a UTF-8 string of length up to 1024 characters."
- }
- }
- },
- "Settings": {
- "id": "Settings",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "Etag of the collection."
- },
- "items": {
- "type": "array",
- "description": "List of user settings.",
- "items": {
- "$ref": "Setting"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of the collection (\"calendar#settings\").",
- "default": "calendar#settings"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided."
- },
- "nextSyncToken": {
- "type": "string",
- "description": "Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided."
- }
- }
- },
- "TimePeriod": {
- "id": "TimePeriod",
- "type": "object",
- "properties": {
- "end": {
- "type": "string",
- "description": "The (exclusive) end of the time period.",
- "format": "date-time"
- },
- "start": {
- "type": "string",
- "description": "The (inclusive) start of the time period.",
- "format": "date-time"
- }
- }
- }
- },
- "resources": {
- "acl": {
- "methods": {
- "delete": {
- "id": "calendar.acl.delete",
- "path": "calendars/{calendarId}/acl/{ruleId}",
- "httpMethod": "DELETE",
- "description": "Deletes an access control rule.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- "required": true,
- "location": "path"
- },
- "ruleId": {
- "type": "string",
- "description": "ACL rule identifier.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "calendarId",
- "ruleId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "get": {
- "id": "calendar.acl.get",
- "path": "calendars/{calendarId}/acl/{ruleId}",
- "httpMethod": "GET",
- "description": "Returns an access control rule.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- "required": true,
- "location": "path"
- },
- "ruleId": {
- "type": "string",
- "description": "ACL rule identifier.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "calendarId",
- "ruleId"
- ],
- "response": {
- "$ref": "AclRule"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ]
- },
- "insert": {
- "id": "calendar.acl.insert",
- "path": "calendars/{calendarId}/acl",
- "httpMethod": "POST",
- "description": "Creates an access control rule.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "request": {
- "$ref": "AclRule"
- },
- "response": {
- "$ref": "AclRule"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "list": {
- "id": "calendar.acl.list",
- "path": "calendars/{calendarId}/acl",
- "httpMethod": "GET",
- "description": "Returns the rules in the access control list for the calendar.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token specifying which result page to return. Optional.",
- "location": "query"
- },
- "showDeleted": {
- "type": "boolean",
- "description": "Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to \"none\". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.",
- "location": "query"
- },
- "syncToken": {
- "type": "string",
- "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "response": {
- "$ref": "Acl"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ],
- "supportsSubscription": true
- },
- "patch": {
- "id": "calendar.acl.patch",
- "path": "calendars/{calendarId}/acl/{ruleId}",
- "httpMethod": "PATCH",
- "description": "Updates an access control rule. This method supports patch semantics.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- "required": true,
- "location": "path"
- },
- "ruleId": {
- "type": "string",
- "description": "ACL rule identifier.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "calendarId",
- "ruleId"
- ],
- "request": {
- "$ref": "AclRule"
- },
- "response": {
- "$ref": "AclRule"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "update": {
- "id": "calendar.acl.update",
- "path": "calendars/{calendarId}/acl/{ruleId}",
- "httpMethod": "PUT",
- "description": "Updates an access control rule.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- "required": true,
- "location": "path"
- },
- "ruleId": {
- "type": "string",
- "description": "ACL rule identifier.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "calendarId",
- "ruleId"
- ],
- "request": {
- "$ref": "AclRule"
- },
- "response": {
- "$ref": "AclRule"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "watch": {
- "id": "calendar.acl.watch",
- "path": "calendars/{calendarId}/acl/watch",
- "httpMethod": "POST",
- "description": "Watch for changes to ACL resources.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token specifying which result page to return. Optional.",
- "location": "query"
- },
- "showDeleted": {
- "type": "boolean",
- "description": "Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to \"none\". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.",
- "location": "query"
- },
- "syncToken": {
- "type": "string",
- "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "request": {
- "$ref": "Channel",
- "parameterName": "resource"
- },
- "response": {
- "$ref": "Channel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ],
- "supportsSubscription": true
- }
- }
- },
- "calendarList": {
- "methods": {
- "delete": {
- "id": "calendar.calendarList.delete",
- "path": "users/me/calendarList/{calendarId}",
- "httpMethod": "DELETE",
- "description": "Deletes an entry on the user's calendar list.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "get": {
- "id": "calendar.calendarList.get",
- "path": "users/me/calendarList/{calendarId}",
- "httpMethod": "GET",
- "description": "Returns an entry on the user's calendar list.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "response": {
- "$ref": "CalendarListEntry"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ]
- },
- "insert": {
- "id": "calendar.calendarList.insert",
- "path": "users/me/calendarList",
- "httpMethod": "POST",
- "description": "Adds an entry to the user's calendar list.",
- "parameters": {
- "colorRgbFormat": {
- "type": "boolean",
- "description": "Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.",
- "location": "query"
- }
- },
- "request": {
- "$ref": "CalendarListEntry"
- },
- "response": {
- "$ref": "CalendarListEntry"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "list": {
- "id": "calendar.calendarList.list",
- "path": "users/me/calendarList",
- "httpMethod": "GET",
- "description": "Returns entries on the user's calendar list.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "minAccessRole": {
- "type": "string",
- "description": "The minimum access role for the user in the returned entries. Optional. The default is no restriction.",
- "enum": [
- "freeBusyReader",
- "owner",
- "reader",
- "writer"
- ],
- "enumDescriptions": [
- "The user can read free/busy information.",
- "The user can read and modify events and access control lists.",
- "The user can read events that are not private.",
- "The user can read and modify events."
- ],
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token specifying which result page to return. Optional.",
- "location": "query"
- },
- "showDeleted": {
- "type": "boolean",
- "description": "Whether to include deleted calendar list entries in the result. Optional. The default is False.",
- "location": "query"
- },
- "showHidden": {
- "type": "boolean",
- "description": "Whether to show hidden entries. Optional. The default is False.",
- "location": "query"
- },
- "syncToken": {
- "type": "string",
- "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False.\nTo ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "CalendarList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ],
- "supportsSubscription": true
- },
- "patch": {
- "id": "calendar.calendarList.patch",
- "path": "users/me/calendarList/{calendarId}",
- "httpMethod": "PATCH",
- "description": "Updates an entry on the user's calendar list. This method supports patch semantics.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- "required": true,
- "location": "path"
- },
- "colorRgbFormat": {
- "type": "boolean",
- "description": "Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "request": {
- "$ref": "CalendarListEntry"
- },
- "response": {
- "$ref": "CalendarListEntry"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "update": {
- "id": "calendar.calendarList.update",
- "path": "users/me/calendarList/{calendarId}",
- "httpMethod": "PUT",
- "description": "Updates an entry on the user's calendar list.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- "required": true,
- "location": "path"
- },
- "colorRgbFormat": {
- "type": "boolean",
- "description": "Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "request": {
- "$ref": "CalendarListEntry"
- },
- "response": {
- "$ref": "CalendarListEntry"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "watch": {
- "id": "calendar.calendarList.watch",
- "path": "users/me/calendarList/watch",
- "httpMethod": "POST",
- "description": "Watch for changes to CalendarList resources.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "minAccessRole": {
- "type": "string",
- "description": "The minimum access role for the user in the returned entries. Optional. The default is no restriction.",
- "enum": [
- "freeBusyReader",
- "owner",
- "reader",
- "writer"
- ],
- "enumDescriptions": [
- "The user can read free/busy information.",
- "The user can read and modify events and access control lists.",
- "The user can read events that are not private.",
- "The user can read and modify events."
- ],
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token specifying which result page to return. Optional.",
- "location": "query"
- },
- "showDeleted": {
- "type": "boolean",
- "description": "Whether to include deleted calendar list entries in the result. Optional. The default is False.",
- "location": "query"
- },
- "showHidden": {
- "type": "boolean",
- "description": "Whether to show hidden entries. Optional. The default is False.",
- "location": "query"
- },
- "syncToken": {
- "type": "string",
- "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False.\nTo ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
- "location": "query"
- }
- },
- "request": {
- "$ref": "Channel",
- "parameterName": "resource"
- },
- "response": {
- "$ref": "Channel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ],
- "supportsSubscription": true
- }
- }
- },
- "calendars": {
- "methods": {
- "clear": {
- "id": "calendar.calendars.clear",
- "path": "calendars/{calendarId}/clear",
- "httpMethod": "POST",
- "description": "Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "delete": {
- "id": "calendar.calendars.delete",
- "path": "calendars/{calendarId}",
- "httpMethod": "DELETE",
- "description": "Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "get": {
- "id": "calendar.calendars.get",
- "path": "calendars/{calendarId}",
- "httpMethod": "GET",
- "description": "Returns metadata for a calendar.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "response": {
- "$ref": "Calendar"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ]
- },
- "insert": {
- "id": "calendar.calendars.insert",
- "path": "calendars",
- "httpMethod": "POST",
- "description": "Creates a secondary calendar.",
- "request": {
- "$ref": "Calendar"
- },
- "response": {
- "$ref": "Calendar"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "patch": {
- "id": "calendar.calendars.patch",
- "path": "calendars/{calendarId}",
- "httpMethod": "PATCH",
- "description": "Updates metadata for a calendar. This method supports patch semantics.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "request": {
- "$ref": "Calendar"
- },
- "response": {
- "$ref": "Calendar"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "update": {
- "id": "calendar.calendars.update",
- "path": "calendars/{calendarId}",
- "httpMethod": "PUT",
- "description": "Updates metadata for a calendar.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "request": {
- "$ref": "Calendar"
- },
- "response": {
- "$ref": "Calendar"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- }
- }
- },
- "channels": {
- "methods": {
- "stop": {
- "id": "calendar.channels.stop",
- "path": "channels/stop",
- "httpMethod": "POST",
- "description": "Stop watching resources through this channel",
- "request": {
- "$ref": "Channel",
- "parameterName": "resource"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ]
- }
- }
- },
- "colors": {
- "methods": {
- "get": {
- "id": "calendar.colors.get",
- "path": "colors",
- "httpMethod": "GET",
- "description": "Returns the color definitions for calendars and events.",
- "response": {
- "$ref": "Colors"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ]
- }
- }
- },
- "events": {
- "methods": {
- "delete": {
- "id": "calendar.events.delete",
- "path": "calendars/{calendarId}/events/{eventId}",
- "httpMethod": "DELETE",
- "description": "Deletes an event.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- "required": true,
- "location": "path"
- },
- "eventId": {
- "type": "string",
- "description": "Event identifier.",
- "required": true,
- "location": "path"
- },
- "sendNotifications": {
- "type": "boolean",
- "description": "Whether to send notifications about the deletion of the event. Optional. The default is False.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId",
- "eventId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "get": {
- "id": "calendar.events.get",
- "path": "calendars/{calendarId}/events/{eventId}",
- "httpMethod": "GET",
- "description": "Returns an event.",
- "parameters": {
- "alwaysIncludeEmail": {
- "type": "boolean",
- "description": "Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.",
- "location": "query"
- },
- "calendarId": {
- "type": "string",
- "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- "required": true,
- "location": "path"
- },
- "eventId": {
- "type": "string",
- "description": "Event identifier.",
- "required": true,
- "location": "path"
- },
- "maxAttendees": {
- "type": "integer",
- "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "timeZone": {
- "type": "string",
- "description": "Time zone used in the response. Optional. The default is the time zone of the calendar.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId",
- "eventId"
- ],
- "response": {
- "$ref": "Event"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ]
- },
- "import": {
- "id": "calendar.events.import",
- "path": "calendars/{calendarId}/events/import",
- "httpMethod": "POST",
- "description": "Imports an event. This operation is used to add a private copy of an existing event to a calendar.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- "required": true,
- "location": "path"
- },
- "supportsAttachments": {
- "type": "boolean",
- "description": "Whether API client performing operation supports event attachments. Optional. The default is False.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "request": {
- "$ref": "Event"
- },
- "response": {
- "$ref": "Event"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "insert": {
- "id": "calendar.events.insert",
- "path": "calendars/{calendarId}/events",
- "httpMethod": "POST",
- "description": "Creates an event.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- "required": true,
- "location": "path"
- },
- "maxAttendees": {
- "type": "integer",
- "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "sendNotifications": {
- "type": "boolean",
- "description": "Whether to send notifications about the creation of the new event. Optional. The default is False.",
- "location": "query"
- },
- "supportsAttachments": {
- "type": "boolean",
- "description": "Whether API client performing operation supports event attachments. Optional. The default is False.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "request": {
- "$ref": "Event"
- },
- "response": {
- "$ref": "Event"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "instances": {
- "id": "calendar.events.instances",
- "path": "calendars/{calendarId}/events/{eventId}/instances",
- "httpMethod": "GET",
- "description": "Returns instances of the specified recurring event.",
- "parameters": {
- "alwaysIncludeEmail": {
- "type": "boolean",
- "description": "Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.",
- "location": "query"
- },
- "calendarId": {
- "type": "string",
- "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- "required": true,
- "location": "path"
- },
- "eventId": {
- "type": "string",
- "description": "Recurring event identifier.",
- "required": true,
- "location": "path"
- },
- "maxAttendees": {
- "type": "integer",
- "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "originalStart": {
- "type": "string",
- "description": "The original start time of the instance in the result. Optional.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token specifying which result page to return. Optional.",
- "location": "query"
- },
- "showDeleted": {
- "type": "boolean",
- "description": "Whether to include deleted events (with status equals \"cancelled\") in the result. Cancelled instances of recurring events will still be included if singleEvents is False. Optional. The default is False.",
- "location": "query"
- },
- "timeMax": {
- "type": "string",
- "description": "Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset.",
- "format": "date-time",
- "location": "query"
- },
- "timeMin": {
- "type": "string",
- "description": "Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset.",
- "format": "date-time",
- "location": "query"
- },
- "timeZone": {
- "type": "string",
- "description": "Time zone used in the response. Optional. The default is the time zone of the calendar.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId",
- "eventId"
- ],
- "response": {
- "$ref": "Events"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ],
- "supportsSubscription": true
- },
- "list": {
- "id": "calendar.events.list",
- "path": "calendars/{calendarId}/events",
- "httpMethod": "GET",
- "description": "Returns events on the specified calendar.",
- "parameters": {
- "alwaysIncludeEmail": {
- "type": "boolean",
- "description": "Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.",
- "location": "query"
- },
- "calendarId": {
- "type": "string",
- "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- "required": true,
- "location": "path"
- },
- "iCalUID": {
- "type": "string",
- "description": "Specifies event ID in the iCalendar format to be included in the response. Optional.",
- "location": "query"
- },
- "maxAttendees": {
- "type": "integer",
- "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "The order of the events returned in the result. Optional. The default is an unspecified, stable order.",
- "enum": [
- "startTime",
- "updated"
- ],
- "enumDescriptions": [
- "Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)",
- "Order by last modification time (ascending)."
- ],
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token specifying which result page to return. Optional.",
- "location": "query"
- },
- "privateExtendedProperty": {
- "type": "string",
- "description": "Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.",
- "repeated": true,
- "location": "query"
- },
- "q": {
- "type": "string",
- "description": "Free text search terms to find events that match these terms in any field, except for extended properties. Optional.",
- "location": "query"
- },
- "sharedExtendedProperty": {
- "type": "string",
- "description": "Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.",
- "repeated": true,
- "location": "query"
- },
- "showDeleted": {
- "type": "boolean",
- "description": "Whether to include deleted events (with status equals \"cancelled\") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.",
- "location": "query"
- },
- "showHiddenInvitations": {
- "type": "boolean",
- "description": "Whether to include hidden invitations in the result. Optional. The default is False.",
- "location": "query"
- },
- "singleEvents": {
- "type": "boolean",
- "description": "Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.",
- "location": "query"
- },
- "syncToken": {
- "type": "string",
- "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nThere are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.\n\nThese are: \n- iCalUID \n- orderBy \n- privateExtendedProperty \n- q \n- sharedExtendedProperty \n- timeMin \n- timeMax \n- updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
- "location": "query"
- },
- "timeMax": {
- "type": "string",
- "description": "Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored.",
- "format": "date-time",
- "location": "query"
- },
- "timeMin": {
- "type": "string",
- "description": "Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored.",
- "format": "date-time",
- "location": "query"
- },
- "timeZone": {
- "type": "string",
- "description": "Time zone used in the response. Optional. The default is the time zone of the calendar.",
- "location": "query"
- },
- "updatedMin": {
- "type": "string",
- "description": "Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.",
- "format": "date-time",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "response": {
- "$ref": "Events"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ],
- "supportsSubscription": true
- },
- "move": {
- "id": "calendar.events.move",
- "path": "calendars/{calendarId}/events/{eventId}/move",
- "httpMethod": "POST",
- "description": "Moves an event to another calendar, i.e. changes an event's organizer.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "Calendar identifier of the source calendar where the event currently is on.",
- "required": true,
- "location": "path"
- },
- "destination": {
- "type": "string",
- "description": "Calendar identifier of the target calendar where the event is to be moved to.",
- "required": true,
- "location": "query"
- },
- "eventId": {
- "type": "string",
- "description": "Event identifier.",
- "required": true,
- "location": "path"
- },
- "sendNotifications": {
- "type": "boolean",
- "description": "Whether to send notifications about the change of the event's organizer. Optional. The default is False.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId",
- "eventId",
- "destination"
- ],
- "response": {
- "$ref": "Event"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "patch": {
- "id": "calendar.events.patch",
- "path": "calendars/{calendarId}/events/{eventId}",
- "httpMethod": "PATCH",
- "description": "Updates an event. This method supports patch semantics.",
- "parameters": {
- "alwaysIncludeEmail": {
- "type": "boolean",
- "description": "Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.",
- "location": "query"
- },
- "calendarId": {
- "type": "string",
- "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- "required": true,
- "location": "path"
- },
- "eventId": {
- "type": "string",
- "description": "Event identifier.",
- "required": true,
- "location": "path"
- },
- "maxAttendees": {
- "type": "integer",
- "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "sendNotifications": {
- "type": "boolean",
- "description": "Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.",
- "location": "query"
- },
- "supportsAttachments": {
- "type": "boolean",
- "description": "Whether API client performing operation supports event attachments. Optional. The default is False.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId",
- "eventId"
- ],
- "request": {
- "$ref": "Event"
- },
- "response": {
- "$ref": "Event"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "quickAdd": {
- "id": "calendar.events.quickAdd",
- "path": "calendars/{calendarId}/events/quickAdd",
- "httpMethod": "POST",
- "description": "Creates an event based on a simple text string.",
- "parameters": {
- "calendarId": {
- "type": "string",
- "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- "required": true,
- "location": "path"
- },
- "sendNotifications": {
- "type": "boolean",
- "description": "Whether to send notifications about the creation of the event. Optional. The default is False.",
- "location": "query"
- },
- "text": {
- "type": "string",
- "description": "The text describing the event to be created.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId",
- "text"
- ],
- "response": {
- "$ref": "Event"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "update": {
- "id": "calendar.events.update",
- "path": "calendars/{calendarId}/events/{eventId}",
- "httpMethod": "PUT",
- "description": "Updates an event.",
- "parameters": {
- "alwaysIncludeEmail": {
- "type": "boolean",
- "description": "Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.",
- "location": "query"
- },
- "calendarId": {
- "type": "string",
- "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- "required": true,
- "location": "path"
- },
- "eventId": {
- "type": "string",
- "description": "Event identifier.",
- "required": true,
- "location": "path"
- },
- "maxAttendees": {
- "type": "integer",
- "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "sendNotifications": {
- "type": "boolean",
- "description": "Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.",
- "location": "query"
- },
- "supportsAttachments": {
- "type": "boolean",
- "description": "Whether API client performing operation supports event attachments. Optional. The default is False.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId",
- "eventId"
- ],
- "request": {
- "$ref": "Event"
- },
- "response": {
- "$ref": "Event"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar"
- ]
- },
- "watch": {
- "id": "calendar.events.watch",
- "path": "calendars/{calendarId}/events/watch",
- "httpMethod": "POST",
- "description": "Watch for changes to Events resources.",
- "parameters": {
- "alwaysIncludeEmail": {
- "type": "boolean",
- "description": "Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.",
- "location": "query"
- },
- "calendarId": {
- "type": "string",
- "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- "required": true,
- "location": "path"
- },
- "iCalUID": {
- "type": "string",
- "description": "Specifies event ID in the iCalendar format to be included in the response. Optional.",
- "location": "query"
- },
- "maxAttendees": {
- "type": "integer",
- "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "The order of the events returned in the result. Optional. The default is an unspecified, stable order.",
- "enum": [
- "startTime",
- "updated"
- ],
- "enumDescriptions": [
- "Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)",
- "Order by last modification time (ascending)."
- ],
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token specifying which result page to return. Optional.",
- "location": "query"
- },
- "privateExtendedProperty": {
- "type": "string",
- "description": "Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.",
- "repeated": true,
- "location": "query"
- },
- "q": {
- "type": "string",
- "description": "Free text search terms to find events that match these terms in any field, except for extended properties. Optional.",
- "location": "query"
- },
- "sharedExtendedProperty": {
- "type": "string",
- "description": "Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.",
- "repeated": true,
- "location": "query"
- },
- "showDeleted": {
- "type": "boolean",
- "description": "Whether to include deleted events (with status equals \"cancelled\") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.",
- "location": "query"
- },
- "showHiddenInvitations": {
- "type": "boolean",
- "description": "Whether to include hidden invitations in the result. Optional. The default is False.",
- "location": "query"
- },
- "singleEvents": {
- "type": "boolean",
- "description": "Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.",
- "location": "query"
- },
- "syncToken": {
- "type": "string",
- "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nThere are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.\n\nThese are: \n- iCalUID \n- orderBy \n- privateExtendedProperty \n- q \n- sharedExtendedProperty \n- timeMin \n- timeMax \n- updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
- "location": "query"
- },
- "timeMax": {
- "type": "string",
- "description": "Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored.",
- "format": "date-time",
- "location": "query"
- },
- "timeMin": {
- "type": "string",
- "description": "Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored.",
- "format": "date-time",
- "location": "query"
- },
- "timeZone": {
- "type": "string",
- "description": "Time zone used in the response. Optional. The default is the time zone of the calendar.",
- "location": "query"
- },
- "updatedMin": {
- "type": "string",
- "description": "Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.",
- "format": "date-time",
- "location": "query"
- }
- },
- "parameterOrder": [
- "calendarId"
- ],
- "request": {
- "$ref": "Channel",
- "parameterName": "resource"
- },
- "response": {
- "$ref": "Channel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ],
- "supportsSubscription": true
- }
- }
- },
- "freebusy": {
- "methods": {
- "query": {
- "id": "calendar.freebusy.query",
- "path": "freeBusy",
- "httpMethod": "POST",
- "description": "Returns free/busy information for a set of calendars.",
- "request": {
- "$ref": "FreeBusyRequest"
- },
- "response": {
- "$ref": "FreeBusyResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ]
- }
- }
- },
- "settings": {
- "methods": {
- "get": {
- "id": "calendar.settings.get",
- "path": "users/me/settings/{setting}",
- "httpMethod": "GET",
- "description": "Returns a single user setting.",
- "parameters": {
- "setting": {
- "type": "string",
- "description": "The id of the user setting.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "setting"
- ],
- "response": {
- "$ref": "Setting"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ]
- },
- "list": {
- "id": "calendar.settings.list",
- "path": "users/me/settings",
- "httpMethod": "GET",
- "description": "Returns all user settings for the authenticated user.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token specifying which result page to return. Optional.",
- "location": "query"
- },
- "syncToken": {
- "type": "string",
- "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Settings"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ],
- "supportsSubscription": true
- },
- "watch": {
- "id": "calendar.settings.watch",
- "path": "users/me/settings/watch",
- "httpMethod": "POST",
- "description": "Watch for changes to Settings resources.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.",
- "format": "int32",
- "minimum": "1",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Token specifying which result page to return. Optional.",
- "location": "query"
- },
- "syncToken": {
- "type": "string",
- "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
- "location": "query"
- }
- },
- "request": {
- "$ref": "Channel",
- "parameterName": "resource"
- },
- "response": {
- "$ref": "Channel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/calendar",
- "https://www.googleapis.com/auth/calendar.readonly"
- ],
- "supportsSubscription": true
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/calendar/v3/calendar-gen.go b/vendor/google.golang.org/api/calendar/v3/calendar-gen.go
deleted file mode 100644
index 17b3628d..00000000
--- a/vendor/google.golang.org/api/calendar/v3/calendar-gen.go
+++ /dev/null
@@ -1,7663 +0,0 @@
-// Package calendar provides access to the Calendar API.
-//
-// See https://developers.google.com/google-apps/calendar/firstapp
-//
-// Usage example:
-//
-// import "google.golang.org/api/calendar/v3"
-// ...
-// calendarService, err := calendar.New(oauthHttpClient)
-package calendar // import "google.golang.org/api/calendar/v3"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "calendar:v3"
-const apiName = "calendar"
-const apiVersion = "v3"
-const basePath = "https://www.googleapis.com/calendar/v3/"
-
-// OAuth2 scopes used by this API.
-const (
- // Manage your calendars
- CalendarScope = "https://www.googleapis.com/auth/calendar"
-
- // View your calendars
- CalendarReadonlyScope = "https://www.googleapis.com/auth/calendar.readonly"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Acl = NewAclService(s)
- s.CalendarList = NewCalendarListService(s)
- s.Calendars = NewCalendarsService(s)
- s.Channels = NewChannelsService(s)
- s.Colors = NewColorsService(s)
- s.Events = NewEventsService(s)
- s.Freebusy = NewFreebusyService(s)
- s.Settings = NewSettingsService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Acl *AclService
-
- CalendarList *CalendarListService
-
- Calendars *CalendarsService
-
- Channels *ChannelsService
-
- Colors *ColorsService
-
- Events *EventsService
-
- Freebusy *FreebusyService
-
- Settings *SettingsService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewAclService(s *Service) *AclService {
- rs := &AclService{s: s}
- return rs
-}
-
-type AclService struct {
- s *Service
-}
-
-func NewCalendarListService(s *Service) *CalendarListService {
- rs := &CalendarListService{s: s}
- return rs
-}
-
-type CalendarListService struct {
- s *Service
-}
-
-func NewCalendarsService(s *Service) *CalendarsService {
- rs := &CalendarsService{s: s}
- return rs
-}
-
-type CalendarsService struct {
- s *Service
-}
-
-func NewChannelsService(s *Service) *ChannelsService {
- rs := &ChannelsService{s: s}
- return rs
-}
-
-type ChannelsService struct {
- s *Service
-}
-
-func NewColorsService(s *Service) *ColorsService {
- rs := &ColorsService{s: s}
- return rs
-}
-
-type ColorsService struct {
- s *Service
-}
-
-func NewEventsService(s *Service) *EventsService {
- rs := &EventsService{s: s}
- return rs
-}
-
-type EventsService struct {
- s *Service
-}
-
-func NewFreebusyService(s *Service) *FreebusyService {
- rs := &FreebusyService{s: s}
- return rs
-}
-
-type FreebusyService struct {
- s *Service
-}
-
-func NewSettingsService(s *Service) *SettingsService {
- rs := &SettingsService{s: s}
- return rs
-}
-
-type SettingsService struct {
- s *Service
-}
-
-type Acl struct {
- // Etag: ETag of the collection.
- Etag string `json:"etag,omitempty"`
-
- // Items: List of rules on the access control list.
- Items []*AclRule `json:"items,omitempty"`
-
- // Kind: Type of the collection ("calendar#acl").
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Token used to access the next page of this result.
- // Omitted if no further results are available, in which case
- // nextSyncToken is provided.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // NextSyncToken: Token used at a later point in time to retrieve only
- // the entries that have changed since this result was returned. Omitted
- // if further results are available, in which case nextPageToken is
- // provided.
- NextSyncToken string `json:"nextSyncToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Acl) MarshalJSON() ([]byte, error) {
- type noMethod Acl
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AclRule struct {
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Id: Identifier of the ACL rule.
- Id string `json:"id,omitempty"`
-
- // Kind: Type of the resource ("calendar#aclRule").
- Kind string `json:"kind,omitempty"`
-
- // Role: The role assigned to the scope. Possible values are:
- // - "none" - Provides no access.
- // - "freeBusyReader" - Provides read access to free/busy information.
- //
- // - "reader" - Provides read access to the calendar. Private events
- // will appear to users with reader access, but event details will be
- // hidden.
- // - "writer" - Provides read and write access to the calendar. Private
- // events will appear to users with writer access, and event details
- // will be visible.
- // - "owner" - Provides ownership of the calendar. This role has all of
- // the permissions of the writer role with the additional ability to see
- // and manipulate ACLs.
- Role string `json:"role,omitempty"`
-
- // Scope: The scope of the rule.
- Scope *AclRuleScope `json:"scope,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AclRule) MarshalJSON() ([]byte, error) {
- type noMethod AclRule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AclRuleScope: The scope of the rule.
-type AclRuleScope struct {
- // Type: The type of the scope. Possible values are:
- // - "default" - The public scope. This is the default value.
- // - "user" - Limits the scope to a single user.
- // - "group" - Limits the scope to a group.
- // - "domain" - Limits the scope to a domain. Note: The permissions
- // granted to the "default", or public, scope apply to any user,
- // authenticated or not.
- Type string `json:"type,omitempty"`
-
- // Value: The email address of a user or group, or the name of a domain,
- // depending on the scope type. Omitted for type "default".
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Type") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AclRuleScope) MarshalJSON() ([]byte, error) {
- type noMethod AclRuleScope
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Calendar struct {
- // Description: Description of the calendar. Optional.
- Description string `json:"description,omitempty"`
-
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Id: Identifier of the calendar. To retrieve IDs call the
- // calendarList.list() method.
- Id string `json:"id,omitempty"`
-
- // Kind: Type of the resource ("calendar#calendar").
- Kind string `json:"kind,omitempty"`
-
- // Location: Geographic location of the calendar as free-form text.
- // Optional.
- Location string `json:"location,omitempty"`
-
- // Summary: Title of the calendar.
- Summary string `json:"summary,omitempty"`
-
- // TimeZone: The time zone of the calendar. (Formatted as an IANA Time
- // Zone Database name, e.g. "Europe/Zurich".) Optional.
- TimeZone string `json:"timeZone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Description") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Calendar) MarshalJSON() ([]byte, error) {
- type noMethod Calendar
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CalendarList struct {
- // Etag: ETag of the collection.
- Etag string `json:"etag,omitempty"`
-
- // Items: Calendars that are present on the user's calendar list.
- Items []*CalendarListEntry `json:"items,omitempty"`
-
- // Kind: Type of the collection ("calendar#calendarList").
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Token used to access the next page of this result.
- // Omitted if no further results are available, in which case
- // nextSyncToken is provided.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // NextSyncToken: Token used at a later point in time to retrieve only
- // the entries that have changed since this result was returned. Omitted
- // if further results are available, in which case nextPageToken is
- // provided.
- NextSyncToken string `json:"nextSyncToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CalendarList) MarshalJSON() ([]byte, error) {
- type noMethod CalendarList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CalendarListEntry struct {
- // AccessRole: The effective access role that the authenticated user has
- // on the calendar. Read-only. Possible values are:
- // - "freeBusyReader" - Provides read access to free/busy information.
- //
- // - "reader" - Provides read access to the calendar. Private events
- // will appear to users with reader access, but event details will be
- // hidden.
- // - "writer" - Provides read and write access to the calendar. Private
- // events will appear to users with writer access, and event details
- // will be visible.
- // - "owner" - Provides ownership of the calendar. This role has all of
- // the permissions of the writer role with the additional ability to see
- // and manipulate ACLs.
- AccessRole string `json:"accessRole,omitempty"`
-
- // BackgroundColor: The main color of the calendar in the hexadecimal
- // format "#0088aa". This property supersedes the index-based colorId
- // property. To set or change this property, you need to specify
- // colorRgbFormat=true in the parameters of the insert, update and patch
- // methods. Optional.
- BackgroundColor string `json:"backgroundColor,omitempty"`
-
- // ColorId: The color of the calendar. This is an ID referring to an
- // entry in the calendar section of the colors definition (see the
- // colors endpoint). This property is superseded by the backgroundColor
- // and foregroundColor properties and can be ignored when using these
- // properties. Optional.
- ColorId string `json:"colorId,omitempty"`
-
- // DefaultReminders: The default reminders that the authenticated user
- // has for this calendar.
- DefaultReminders []*EventReminder `json:"defaultReminders,omitempty"`
-
- // Deleted: Whether this calendar list entry has been deleted from the
- // calendar list. Read-only. Optional. The default is False.
- Deleted bool `json:"deleted,omitempty"`
-
- // Description: Description of the calendar. Optional. Read-only.
- Description string `json:"description,omitempty"`
-
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // ForegroundColor: The foreground color of the calendar in the
- // hexadecimal format "#ffffff". This property supersedes the
- // index-based colorId property. To set or change this property, you
- // need to specify colorRgbFormat=true in the parameters of the insert,
- // update and patch methods. Optional.
- ForegroundColor string `json:"foregroundColor,omitempty"`
-
- // Hidden: Whether the calendar has been hidden from the list. Optional.
- // The default is False.
- Hidden bool `json:"hidden,omitempty"`
-
- // Id: Identifier of the calendar.
- Id string `json:"id,omitempty"`
-
- // Kind: Type of the resource ("calendar#calendarListEntry").
- Kind string `json:"kind,omitempty"`
-
- // Location: Geographic location of the calendar as free-form text.
- // Optional. Read-only.
- Location string `json:"location,omitempty"`
-
- // NotificationSettings: The notifications that the authenticated user
- // is receiving for this calendar.
- NotificationSettings *CalendarListEntryNotificationSettings `json:"notificationSettings,omitempty"`
-
- // Primary: Whether the calendar is the primary calendar of the
- // authenticated user. Read-only. Optional. The default is False.
- Primary bool `json:"primary,omitempty"`
-
- // Selected: Whether the calendar content shows up in the calendar UI.
- // Optional. The default is False.
- Selected bool `json:"selected,omitempty"`
-
- // Summary: Title of the calendar. Read-only.
- Summary string `json:"summary,omitempty"`
-
- // SummaryOverride: The summary that the authenticated user has set for
- // this calendar. Optional.
- SummaryOverride string `json:"summaryOverride,omitempty"`
-
- // TimeZone: The time zone of the calendar. Optional. Read-only.
- TimeZone string `json:"timeZone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccessRole") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CalendarListEntry) MarshalJSON() ([]byte, error) {
- type noMethod CalendarListEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CalendarListEntryNotificationSettings: The notifications that the
-// authenticated user is receiving for this calendar.
-type CalendarListEntryNotificationSettings struct {
- // Notifications: The list of notifications set for this calendar.
- Notifications []*CalendarNotification `json:"notifications,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Notifications") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CalendarListEntryNotificationSettings) MarshalJSON() ([]byte, error) {
- type noMethod CalendarListEntryNotificationSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CalendarNotification struct {
- // Method: The method used to deliver the notification. Possible values
- // are:
- // - "email" - Reminders are sent via email.
- // - "sms" - Reminders are sent via SMS. This value is read-only and is
- // ignored on inserts and updates. SMS reminders are only available for
- // Google Apps for Work, Education, and Government customers.
- Method string `json:"method,omitempty"`
-
- // Type: The type of notification. Possible values are:
- // - "eventCreation" - Notification sent when a new event is put on the
- // calendar.
- // - "eventChange" - Notification sent when an event is changed.
- // - "eventCancellation" - Notification sent when an event is cancelled.
- //
- // - "eventResponse" - Notification sent when an event is changed.
- // - "agenda" - An agenda with the events of the day (sent out in the
- // morning).
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Method") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CalendarNotification) MarshalJSON() ([]byte, error) {
- type noMethod CalendarNotification
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Channel struct {
- // Address: The address where notifications are delivered for this
- // channel.
- Address string `json:"address,omitempty"`
-
- // Expiration: Date and time of notification channel expiration,
- // expressed as a Unix timestamp, in milliseconds. Optional.
- Expiration int64 `json:"expiration,omitempty,string"`
-
- // Id: A UUID or similar unique string that identifies this channel.
- Id string `json:"id,omitempty"`
-
- // Kind: Identifies this as a notification channel used to watch for
- // changes to a resource. Value: the fixed string "api#channel".
- Kind string `json:"kind,omitempty"`
-
- // Params: Additional parameters controlling delivery channel behavior.
- // Optional.
- Params map[string]string `json:"params,omitempty"`
-
- // Payload: A Boolean value to indicate whether payload is wanted.
- // Optional.
- Payload bool `json:"payload,omitempty"`
-
- // ResourceId: An opaque ID that identifies the resource being watched
- // on this channel. Stable across different API versions.
- ResourceId string `json:"resourceId,omitempty"`
-
- // ResourceUri: A version-specific identifier for the watched resource.
- ResourceUri string `json:"resourceUri,omitempty"`
-
- // Token: An arbitrary string delivered to the target address with each
- // notification delivered over this channel. Optional.
- Token string `json:"token,omitempty"`
-
- // Type: The type of delivery mechanism used for this channel.
- Type string `json:"type,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Address") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Channel) MarshalJSON() ([]byte, error) {
- type noMethod Channel
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ColorDefinition struct {
- // Background: The background color associated with this color
- // definition.
- Background string `json:"background,omitempty"`
-
- // Foreground: The foreground color that can be used to write on top of
- // a background with 'background' color.
- Foreground string `json:"foreground,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Background") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ColorDefinition) MarshalJSON() ([]byte, error) {
- type noMethod ColorDefinition
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Colors struct {
- // Calendar: A global palette of calendar colors, mapping from the color
- // ID to its definition. A calendarListEntry resource refers to one of
- // these color IDs in its color field. Read-only.
- Calendar map[string]ColorDefinition `json:"calendar,omitempty"`
-
- // Event: A global palette of event colors, mapping from the color ID to
- // its definition. An event resource may refer to one of these color IDs
- // in its color field. Read-only.
- Event map[string]ColorDefinition `json:"event,omitempty"`
-
- // Kind: Type of the resource ("calendar#colors").
- Kind string `json:"kind,omitempty"`
-
- // Updated: Last modification time of the color palette (as a RFC3339
- // timestamp). Read-only.
- Updated string `json:"updated,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Calendar") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Colors) MarshalJSON() ([]byte, error) {
- type noMethod Colors
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Error struct {
- // Domain: Domain, or broad category, of the error.
- Domain string `json:"domain,omitempty"`
-
- // Reason: Specific reason for the error. Some of the possible values
- // are:
- // - "groupTooBig" - The group of users requested is too large for a
- // single query.
- // - "tooManyCalendarsRequested" - The number of calendars requested is
- // too large for a single query.
- // - "notFound" - The requested resource was not found.
- // - "internalError" - The API service has encountered an internal
- // error. Additional error types may be added in the future, so clients
- // should gracefully handle additional error statuses not included in
- // this list.
- Reason string `json:"reason,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Domain") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Error) MarshalJSON() ([]byte, error) {
- type noMethod Error
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Event struct {
- // AnyoneCanAddSelf: Whether anyone can invite themselves to the event.
- // Optional. The default is False.
- AnyoneCanAddSelf bool `json:"anyoneCanAddSelf,omitempty"`
-
- // Attachments: File attachments for the event. Currently only Google
- // Drive attachments are supported.
- // In order to modify attachments the supportsAttachments request
- // parameter should be set to true.
- // There can be at most 25 attachments per event,
- Attachments []*EventAttachment `json:"attachments,omitempty"`
-
- // Attendees: The attendees of the event. See the Events with attendees
- // guide for more information on scheduling events with other calendar
- // users.
- Attendees []*EventAttendee `json:"attendees,omitempty"`
-
- // AttendeesOmitted: Whether attendees may have been omitted from the
- // event's representation. When retrieving an event, this may be due to
- // a restriction specified by the maxAttendee query parameter. When
- // updating an event, this can be used to only update the participant's
- // response. Optional. The default is False.
- AttendeesOmitted bool `json:"attendeesOmitted,omitempty"`
-
- // ColorId: The color of the event. This is an ID referring to an entry
- // in the event section of the colors definition (see the colors
- // endpoint). Optional.
- ColorId string `json:"colorId,omitempty"`
-
- // Created: Creation time of the event (as a RFC3339 timestamp).
- // Read-only.
- Created string `json:"created,omitempty"`
-
- // Creator: The creator of the event. Read-only.
- Creator *EventCreator `json:"creator,omitempty"`
-
- // Description: Description of the event. Optional.
- Description string `json:"description,omitempty"`
-
- // End: The (exclusive) end time of the event. For a recurring event,
- // this is the end time of the first instance.
- End *EventDateTime `json:"end,omitempty"`
-
- // EndTimeUnspecified: Whether the end time is actually unspecified. An
- // end time is still provided for compatibility reasons, even if this
- // attribute is set to True. The default is False.
- EndTimeUnspecified bool `json:"endTimeUnspecified,omitempty"`
-
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // ExtendedProperties: Extended properties of the event.
- ExtendedProperties *EventExtendedProperties `json:"extendedProperties,omitempty"`
-
- // Gadget: A gadget that extends this event.
- Gadget *EventGadget `json:"gadget,omitempty"`
-
- // GuestsCanInviteOthers: Whether attendees other than the organizer can
- // invite others to the event. Optional. The default is True.
- //
- // Default: true
- GuestsCanInviteOthers *bool `json:"guestsCanInviteOthers,omitempty"`
-
- // GuestsCanModify: Whether attendees other than the organizer can
- // modify the event. Optional. The default is False.
- GuestsCanModify bool `json:"guestsCanModify,omitempty"`
-
- // GuestsCanSeeOtherGuests: Whether attendees other than the organizer
- // can see who the event's attendees are. Optional. The default is True.
- //
- // Default: true
- GuestsCanSeeOtherGuests *bool `json:"guestsCanSeeOtherGuests,omitempty"`
-
- // HangoutLink: An absolute link to the Google+ hangout associated with
- // this event. Read-only.
- HangoutLink string `json:"hangoutLink,omitempty"`
-
- // HtmlLink: An absolute link to this event in the Google Calendar Web
- // UI. Read-only.
- HtmlLink string `json:"htmlLink,omitempty"`
-
- // ICalUID: Event unique identifier as defined in RFC5545. It is used to
- // uniquely identify events accross calendaring systems and must be
- // supplied when importing events via the import method.
- // Note that the icalUID and the id are not identical and only one of
- // them should be supplied at event creation time. One difference in
- // their semantics is that in recurring events, all occurrences of one
- // event have different ids while they all share the same icalUIDs.
- ICalUID string `json:"iCalUID,omitempty"`
-
- // Id: Opaque identifier of the event. When creating new single or
- // recurring events, you can specify their IDs. Provided IDs must follow
- // these rules:
- // - characters allowed in the ID are those used in base32hex encoding,
- // i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in
- // RFC2938
- // - the length of the ID must be between 5 and 1024 characters
- // - the ID must be unique per calendar Due to the globally distributed
- // nature of the system, we cannot guarantee that ID collisions will be
- // detected at event creation time. To minimize the risk of collisions
- // we recommend using an established UUID algorithm such as one
- // described in RFC4122.
- // If you do not specify an ID, it will be automatically generated by
- // the server.
- // Note that the icalUID and the id are not identical and only one of
- // them should be supplied at event creation time. One difference in
- // their semantics is that in recurring events, all occurrences of one
- // event have different ids while they all share the same icalUIDs.
- Id string `json:"id,omitempty"`
-
- // Kind: Type of the resource ("calendar#event").
- Kind string `json:"kind,omitempty"`
-
- // Location: Geographic location of the event as free-form text.
- // Optional.
- Location string `json:"location,omitempty"`
-
- // Locked: Whether this is a locked event copy where no changes can be
- // made to the main event fields "summary", "description", "location",
- // "start", "end" or "recurrence". The default is False. Read-Only.
- Locked bool `json:"locked,omitempty"`
-
- // Organizer: The organizer of the event. If the organizer is also an
- // attendee, this is indicated with a separate entry in attendees with
- // the organizer field set to True. To change the organizer, use the
- // move operation. Read-only, except when importing an event.
- Organizer *EventOrganizer `json:"organizer,omitempty"`
-
- // OriginalStartTime: For an instance of a recurring event, this is the
- // time at which this event would start according to the recurrence data
- // in the recurring event identified by recurringEventId. Immutable.
- OriginalStartTime *EventDateTime `json:"originalStartTime,omitempty"`
-
- // PrivateCopy: Whether this is a private event copy where changes are
- // not shared with other copies on other calendars. Optional. Immutable.
- // The default is False.
- PrivateCopy bool `json:"privateCopy,omitempty"`
-
- // Recurrence: List of RRULE, EXRULE, RDATE and EXDATE lines for a
- // recurring event, as specified in RFC5545. Note that DTSTART and DTEND
- // lines are not allowed in this field; event start and end times are
- // specified in the start and end fields. This field is omitted for
- // single events or instances of recurring events.
- Recurrence []string `json:"recurrence,omitempty"`
-
- // RecurringEventId: For an instance of a recurring event, this is the
- // id of the recurring event to which this instance belongs. Immutable.
- RecurringEventId string `json:"recurringEventId,omitempty"`
-
- // Reminders: Information about the event's reminders for the
- // authenticated user.
- Reminders *EventReminders `json:"reminders,omitempty"`
-
- // Sequence: Sequence number as per iCalendar.
- Sequence int64 `json:"sequence,omitempty"`
-
- // Source: Source from which the event was created. For example, a web
- // page, an email message or any document identifiable by an URL with
- // HTTP or HTTPS scheme. Can only be seen or modified by the creator of
- // the event.
- Source *EventSource `json:"source,omitempty"`
-
- // Start: The (inclusive) start time of the event. For a recurring
- // event, this is the start time of the first instance.
- Start *EventDateTime `json:"start,omitempty"`
-
- // Status: Status of the event. Optional. Possible values are:
- // - "confirmed" - The event is confirmed. This is the default status.
- //
- // - "tentative" - The event is tentatively confirmed.
- // - "cancelled" - The event is cancelled.
- Status string `json:"status,omitempty"`
-
- // Summary: Title of the event.
- Summary string `json:"summary,omitempty"`
-
- // Transparency: Whether the event blocks time on the calendar.
- // Optional. Possible values are:
- // - "opaque" - The event blocks time on the calendar. This is the
- // default value.
- // - "transparent" - The event does not block time on the calendar.
- Transparency string `json:"transparency,omitempty"`
-
- // Updated: Last modification time of the event (as a RFC3339
- // timestamp). Read-only.
- Updated string `json:"updated,omitempty"`
-
- // Visibility: Visibility of the event. Optional. Possible values are:
- //
- // - "default" - Uses the default visibility for events on the calendar.
- // This is the default value.
- // - "public" - The event is public and event details are visible to all
- // readers of the calendar.
- // - "private" - The event is private and only event attendees may view
- // event details.
- // - "confidential" - The event is private. This value is provided for
- // compatibility reasons.
- Visibility string `json:"visibility,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AnyoneCanAddSelf") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Event) MarshalJSON() ([]byte, error) {
- type noMethod Event
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// EventCreator: The creator of the event. Read-only.
-type EventCreator struct {
- // DisplayName: The creator's name, if available.
- DisplayName string `json:"displayName,omitempty"`
-
- // Email: The creator's email address, if available.
- Email string `json:"email,omitempty"`
-
- // Id: The creator's Profile ID, if available. It corresponds to theid
- // field in the People collection of the Google+ API
- Id string `json:"id,omitempty"`
-
- // Self: Whether the creator corresponds to the calendar on which this
- // copy of the event appears. Read-only. The default is False.
- Self bool `json:"self,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DisplayName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EventCreator) MarshalJSON() ([]byte, error) {
- type noMethod EventCreator
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// EventExtendedProperties: Extended properties of the event.
-type EventExtendedProperties struct {
- // Private: Properties that are private to the copy of the event that
- // appears on this calendar.
- Private map[string]string `json:"private,omitempty"`
-
- // Shared: Properties that are shared between copies of the event on
- // other attendees' calendars.
- Shared map[string]string `json:"shared,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Private") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EventExtendedProperties) MarshalJSON() ([]byte, error) {
- type noMethod EventExtendedProperties
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// EventGadget: A gadget that extends this event.
-type EventGadget struct {
- // Display: The gadget's display mode. Optional. Possible values are:
- //
- // - "icon" - The gadget displays next to the event's title in the
- // calendar view.
- // - "chip" - The gadget displays when the event is clicked.
- Display string `json:"display,omitempty"`
-
- // Height: The gadget's height in pixels. The height must be an integer
- // greater than 0. Optional.
- Height int64 `json:"height,omitempty"`
-
- // IconLink: The gadget's icon URL. The URL scheme must be HTTPS.
- IconLink string `json:"iconLink,omitempty"`
-
- // Link: The gadget's URL. The URL scheme must be HTTPS.
- Link string `json:"link,omitempty"`
-
- // Preferences: Preferences.
- Preferences map[string]string `json:"preferences,omitempty"`
-
- // Title: The gadget's title.
- Title string `json:"title,omitempty"`
-
- // Type: The gadget's type.
- Type string `json:"type,omitempty"`
-
- // Width: The gadget's width in pixels. The width must be an integer
- // greater than 0. Optional.
- Width int64 `json:"width,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Display") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EventGadget) MarshalJSON() ([]byte, error) {
- type noMethod EventGadget
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// EventOrganizer: The organizer of the event. If the organizer is also
-// an attendee, this is indicated with a separate entry in attendees
-// with the organizer field set to True. To change the organizer, use
-// the move operation. Read-only, except when importing an event.
-type EventOrganizer struct {
- // DisplayName: The organizer's name, if available.
- DisplayName string `json:"displayName,omitempty"`
-
- // Email: The organizer's email address, if available. It must be a
- // valid email address as per RFC5322.
- Email string `json:"email,omitempty"`
-
- // Id: The organizer's Profile ID, if available. It corresponds to theid
- // field in the People collection of the Google+ API
- Id string `json:"id,omitempty"`
-
- // Self: Whether the organizer corresponds to the calendar on which this
- // copy of the event appears. Read-only. The default is False.
- Self bool `json:"self,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DisplayName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EventOrganizer) MarshalJSON() ([]byte, error) {
- type noMethod EventOrganizer
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// EventReminders: Information about the event's reminders for the
-// authenticated user.
-type EventReminders struct {
- // Overrides: If the event doesn't use the default reminders, this lists
- // the reminders specific to the event, or, if not set, indicates that
- // no reminders are set for this event. The maximum number of override
- // reminders is 5.
- Overrides []*EventReminder `json:"overrides,omitempty"`
-
- // UseDefault: Whether the default reminders of the calendar apply to
- // the event.
- UseDefault bool `json:"useDefault,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Overrides") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EventReminders) MarshalJSON() ([]byte, error) {
- type noMethod EventReminders
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// EventSource: Source from which the event was created. For example, a
-// web page, an email message or any document identifiable by an URL
-// with HTTP or HTTPS scheme. Can only be seen or modified by the
-// creator of the event.
-type EventSource struct {
- // Title: Title of the source; for example a title of a web page or an
- // email subject.
- Title string `json:"title,omitempty"`
-
- // Url: URL of the source pointing to a resource. The URL scheme must be
- // HTTP or HTTPS.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Title") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EventSource) MarshalJSON() ([]byte, error) {
- type noMethod EventSource
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type EventAttachment struct {
- // FileId: ID of the attached file. Read-only.
- // For Google Drive files, this is the ID of the corresponding Files
- // resource entry in the Drive API.
- FileId string `json:"fileId,omitempty"`
-
- // FileUrl: URL link to the attachment.
- // For adding Google Drive file attachments use the same format as in
- // alternateLink property of the Files resource in the Drive API.
- FileUrl string `json:"fileUrl,omitempty"`
-
- // IconLink: URL link to the attachment's icon. Read-only.
- IconLink string `json:"iconLink,omitempty"`
-
- // MimeType: Internet media type (MIME type) of the attachment.
- MimeType string `json:"mimeType,omitempty"`
-
- // Title: Attachment title.
- Title string `json:"title,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "FileId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EventAttachment) MarshalJSON() ([]byte, error) {
- type noMethod EventAttachment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type EventAttendee struct {
- // AdditionalGuests: Number of additional guests. Optional. The default
- // is 0.
- AdditionalGuests int64 `json:"additionalGuests,omitempty"`
-
- // Comment: The attendee's response comment. Optional.
- Comment string `json:"comment,omitempty"`
-
- // DisplayName: The attendee's name, if available. Optional.
- DisplayName string `json:"displayName,omitempty"`
-
- // Email: The attendee's email address, if available. This field must be
- // present when adding an attendee. It must be a valid email address as
- // per RFC5322.
- Email string `json:"email,omitempty"`
-
- // Id: The attendee's Profile ID, if available. It corresponds to theid
- // field in the People collection of the Google+ API
- Id string `json:"id,omitempty"`
-
- // Optional: Whether this is an optional attendee. Optional. The default
- // is False.
- Optional bool `json:"optional,omitempty"`
-
- // Organizer: Whether the attendee is the organizer of the event.
- // Read-only. The default is False.
- Organizer bool `json:"organizer,omitempty"`
-
- // Resource: Whether the attendee is a resource. Read-only. The default
- // is False.
- Resource bool `json:"resource,omitempty"`
-
- // ResponseStatus: The attendee's response status. Possible values are:
- //
- // - "needsAction" - The attendee has not responded to the invitation.
- //
- // - "declined" - The attendee has declined the invitation.
- // - "tentative" - The attendee has tentatively accepted the invitation.
- //
- // - "accepted" - The attendee has accepted the invitation.
- ResponseStatus string `json:"responseStatus,omitempty"`
-
- // Self: Whether this entry represents the calendar on which this copy
- // of the event appears. Read-only. The default is False.
- Self bool `json:"self,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AdditionalGuests") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EventAttendee) MarshalJSON() ([]byte, error) {
- type noMethod EventAttendee
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type EventDateTime struct {
- // Date: The date, in the format "yyyy-mm-dd", if this is an all-day
- // event.
- Date string `json:"date,omitempty"`
-
- // DateTime: The time, as a combined date-time value (formatted
- // according to RFC3339). A time zone offset is required unless a time
- // zone is explicitly specified in timeZone.
- DateTime string `json:"dateTime,omitempty"`
-
- // TimeZone: The time zone in which the time is specified. (Formatted as
- // an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring
- // events this field is required and specifies the time zone in which
- // the recurrence is expanded. For single events this field is optional
- // and indicates a custom time zone for the event start/end.
- TimeZone string `json:"timeZone,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Date") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EventDateTime) MarshalJSON() ([]byte, error) {
- type noMethod EventDateTime
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type EventReminder struct {
- // Method: The method used by this reminder. Possible values are:
- // - "email" - Reminders are sent via email.
- // - "sms" - Reminders are sent via SMS. These are only available for
- // Google Apps for Work, Education, and Government customers. Requests
- // to set SMS reminders for other account types are ignored.
- // - "popup" - Reminders are sent via a UI popup.
- Method string `json:"method,omitempty"`
-
- // Minutes: Number of minutes before the start of the event when the
- // reminder should trigger. Valid values are between 0 and 40320 (4
- // weeks in minutes).
- Minutes int64 `json:"minutes,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Method") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EventReminder) MarshalJSON() ([]byte, error) {
- type noMethod EventReminder
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Events struct {
- // AccessRole: The user's access role for this calendar. Read-only.
- // Possible values are:
- // - "none" - The user has no access.
- // - "freeBusyReader" - The user has read access to free/busy
- // information.
- // - "reader" - The user has read access to the calendar. Private events
- // will appear to users with reader access, but event details will be
- // hidden.
- // - "writer" - The user has read and write access to the calendar.
- // Private events will appear to users with writer access, and event
- // details will be visible.
- // - "owner" - The user has ownership of the calendar. This role has all
- // of the permissions of the writer role with the additional ability to
- // see and manipulate ACLs.
- AccessRole string `json:"accessRole,omitempty"`
-
- // DefaultReminders: The default reminders on the calendar for the
- // authenticated user. These reminders apply to all events on this
- // calendar that do not explicitly override them (i.e. do not have
- // reminders.useDefault set to True).
- DefaultReminders []*EventReminder `json:"defaultReminders,omitempty"`
-
- // Description: Description of the calendar. Read-only.
- Description string `json:"description,omitempty"`
-
- // Etag: ETag of the collection.
- Etag string `json:"etag,omitempty"`
-
- // Items: List of events on the calendar.
- Items []*Event `json:"items,omitempty"`
-
- // Kind: Type of the collection ("calendar#events").
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Token used to access the next page of this result.
- // Omitted if no further results are available, in which case
- // nextSyncToken is provided.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // NextSyncToken: Token used at a later point in time to retrieve only
- // the entries that have changed since this result was returned. Omitted
- // if further results are available, in which case nextPageToken is
- // provided.
- NextSyncToken string `json:"nextSyncToken,omitempty"`
-
- // Summary: Title of the calendar. Read-only.
- Summary string `json:"summary,omitempty"`
-
- // TimeZone: The time zone of the calendar. Read-only.
- TimeZone string `json:"timeZone,omitempty"`
-
- // Updated: Last modification time of the calendar (as a RFC3339
- // timestamp). Read-only.
- Updated string `json:"updated,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccessRole") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Events) MarshalJSON() ([]byte, error) {
- type noMethod Events
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type FreeBusyCalendar struct {
- // Busy: List of time ranges during which this calendar should be
- // regarded as busy.
- Busy []*TimePeriod `json:"busy,omitempty"`
-
- // Errors: Optional error(s) (if computation for the calendar failed).
- Errors []*Error `json:"errors,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Busy") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FreeBusyCalendar) MarshalJSON() ([]byte, error) {
- type noMethod FreeBusyCalendar
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type FreeBusyGroup struct {
- // Calendars: List of calendars' identifiers within a group.
- Calendars []string `json:"calendars,omitempty"`
-
- // Errors: Optional error(s) (if computation for the group failed).
- Errors []*Error `json:"errors,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Calendars") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FreeBusyGroup) MarshalJSON() ([]byte, error) {
- type noMethod FreeBusyGroup
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type FreeBusyRequest struct {
- // CalendarExpansionMax: Maximal number of calendars for which FreeBusy
- // information is to be provided. Optional.
- CalendarExpansionMax int64 `json:"calendarExpansionMax,omitempty"`
-
- // GroupExpansionMax: Maximal number of calendar identifiers to be
- // provided for a single group. Optional. An error will be returned for
- // a group with more members than this value.
- GroupExpansionMax int64 `json:"groupExpansionMax,omitempty"`
-
- // Items: List of calendars and/or groups to query.
- Items []*FreeBusyRequestItem `json:"items,omitempty"`
-
- // TimeMax: The end of the interval for the query.
- TimeMax string `json:"timeMax,omitempty"`
-
- // TimeMin: The start of the interval for the query.
- TimeMin string `json:"timeMin,omitempty"`
-
- // TimeZone: Time zone used in the response. Optional. The default is
- // UTC.
- TimeZone string `json:"timeZone,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "CalendarExpansionMax") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FreeBusyRequest) MarshalJSON() ([]byte, error) {
- type noMethod FreeBusyRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type FreeBusyRequestItem struct {
- // Id: The identifier of a calendar or a group.
- Id string `json:"id,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FreeBusyRequestItem) MarshalJSON() ([]byte, error) {
- type noMethod FreeBusyRequestItem
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type FreeBusyResponse struct {
- // Calendars: List of free/busy information for calendars.
- Calendars map[string]FreeBusyCalendar `json:"calendars,omitempty"`
-
- // Groups: Expansion of groups.
- Groups map[string]FreeBusyGroup `json:"groups,omitempty"`
-
- // Kind: Type of the resource ("calendar#freeBusy").
- Kind string `json:"kind,omitempty"`
-
- // TimeMax: The end of the interval.
- TimeMax string `json:"timeMax,omitempty"`
-
- // TimeMin: The start of the interval.
- TimeMin string `json:"timeMin,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Calendars") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FreeBusyResponse) MarshalJSON() ([]byte, error) {
- type noMethod FreeBusyResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Setting struct {
- // Etag: ETag of the resource.
- Etag string `json:"etag,omitempty"`
-
- // Id: The id of the user setting.
- Id string `json:"id,omitempty"`
-
- // Kind: Type of the resource ("calendar#setting").
- Kind string `json:"kind,omitempty"`
-
- // Value: Value of the user setting. The format of the value depends on
- // the ID of the setting. It must always be a UTF-8 string of length up
- // to 1024 characters.
- Value string `json:"value,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Setting) MarshalJSON() ([]byte, error) {
- type noMethod Setting
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Settings struct {
- // Etag: Etag of the collection.
- Etag string `json:"etag,omitempty"`
-
- // Items: List of user settings.
- Items []*Setting `json:"items,omitempty"`
-
- // Kind: Type of the collection ("calendar#settings").
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Token used to access the next page of this result.
- // Omitted if no further results are available, in which case
- // nextSyncToken is provided.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // NextSyncToken: Token used at a later point in time to retrieve only
- // the entries that have changed since this result was returned. Omitted
- // if further results are available, in which case nextPageToken is
- // provided.
- NextSyncToken string `json:"nextSyncToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Settings) MarshalJSON() ([]byte, error) {
- type noMethod Settings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TimePeriod struct {
- // End: The (exclusive) end of the time period.
- End string `json:"end,omitempty"`
-
- // Start: The (inclusive) start of the time period.
- Start string `json:"start,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "End") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TimePeriod) MarshalJSON() ([]byte, error) {
- type noMethod TimePeriod
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "calendar.acl.delete":
-
-type AclDeleteCall struct {
- s *Service
- calendarId string
- ruleId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an access control rule.
-func (r *AclService) Delete(calendarId string, ruleId string) *AclDeleteCall {
- c := &AclDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendarId = calendarId
- c.ruleId = ruleId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AclDeleteCall) Fields(s ...googleapi.Field) *AclDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AclDeleteCall) Context(ctx context.Context) *AclDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AclDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "calendars/{calendarId}/acl/{ruleId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "calendarId": c.calendarId,
- "ruleId": c.ruleId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.acl.delete" call.
-func (c *AclDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes an access control rule.",
- // "httpMethod": "DELETE",
- // "id": "calendar.acl.delete",
- // "parameterOrder": [
- // "calendarId",
- // "ruleId"
- // ],
- // "parameters": {
- // "calendarId": {
- // "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "ruleId": {
- // "description": "ACL rule identifier.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "calendars/{calendarId}/acl/{ruleId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar"
- // ]
- // }
-
-}
-
-// method id "calendar.acl.get":
-
-type AclGetCall struct {
- s *Service
- calendarId string
- ruleId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns an access control rule.
-func (r *AclService) Get(calendarId string, ruleId string) *AclGetCall {
- c := &AclGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendarId = calendarId
- c.ruleId = ruleId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AclGetCall) Fields(s ...googleapi.Field) *AclGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AclGetCall) IfNoneMatch(entityTag string) *AclGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AclGetCall) Context(ctx context.Context) *AclGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AclGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "calendars/{calendarId}/acl/{ruleId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "calendarId": c.calendarId,
- "ruleId": c.ruleId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.acl.get" call.
-// Exactly one of *AclRule or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AclRule.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AclGetCall) Do() (*AclRule, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AclRule{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns an access control rule.",
- // "httpMethod": "GET",
- // "id": "calendar.acl.get",
- // "parameterOrder": [
- // "calendarId",
- // "ruleId"
- // ],
- // "parameters": {
- // "calendarId": {
- // "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "ruleId": {
- // "description": "ACL rule identifier.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "calendars/{calendarId}/acl/{ruleId}",
- // "response": {
- // "$ref": "AclRule"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar",
- // "https://www.googleapis.com/auth/calendar.readonly"
- // ]
- // }
-
-}
-
-// method id "calendar.acl.insert":
-
-type AclInsertCall struct {
- s *Service
- calendarId string
- aclrule *AclRule
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates an access control rule.
-func (r *AclService) Insert(calendarId string, aclrule *AclRule) *AclInsertCall {
- c := &AclInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendarId = calendarId
- c.aclrule = aclrule
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AclInsertCall) Fields(s ...googleapi.Field) *AclInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AclInsertCall) Context(ctx context.Context) *AclInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AclInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.aclrule)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "calendars/{calendarId}/acl")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "calendarId": c.calendarId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.acl.insert" call.
-// Exactly one of *AclRule or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AclRule.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AclInsertCall) Do() (*AclRule, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AclRule{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates an access control rule.",
- // "httpMethod": "POST",
- // "id": "calendar.acl.insert",
- // "parameterOrder": [
- // "calendarId"
- // ],
- // "parameters": {
- // "calendarId": {
- // "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "calendars/{calendarId}/acl",
- // "request": {
- // "$ref": "AclRule"
- // },
- // "response": {
- // "$ref": "AclRule"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar"
- // ]
- // }
-
-}
-
-// method id "calendar.acl.list":
-
-type AclListCall struct {
- s *Service
- calendarId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Returns the rules in the access control list for the calendar.
-func (r *AclService) List(calendarId string) *AclListCall {
- c := &AclListCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendarId = calendarId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of entries returned on one result page. By default the value is 100
-// entries. The page size can never be larger than 250 entries.
-func (c *AclListCall) MaxResults(maxResults int64) *AclListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Token specifying
-// which result page to return.
-func (c *AclListCall) PageToken(pageToken string) *AclListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// ShowDeleted sets the optional parameter "showDeleted": Whether to
-// include deleted ACLs in the result. Deleted ACLs are represented by
-// role equal to "none". Deleted ACLs will always be included if
-// syncToken is provided. The default is False.
-func (c *AclListCall) ShowDeleted(showDeleted bool) *AclListCall {
- c.opt_["showDeleted"] = showDeleted
- return c
-}
-
-// SyncToken sets the optional parameter "syncToken": Token obtained
-// from the nextSyncToken field returned on the last page of results
-// from the previous list request. It makes the result of this list
-// request contain only entries that have changed since then. All
-// entries deleted since the previous list request will always be in the
-// result set and it is not allowed to set showDeleted to False.
-// If the syncToken expires, the server will respond with a 410 GONE
-// response code and the client should clear its storage and perform a
-// full synchronization without any syncToken.
-// Learn more about incremental synchronization.
-// The default is to return all entries.
-func (c *AclListCall) SyncToken(syncToken string) *AclListCall {
- c.opt_["syncToken"] = syncToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AclListCall) Fields(s ...googleapi.Field) *AclListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AclListCall) IfNoneMatch(entityTag string) *AclListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AclListCall) Context(ctx context.Context) *AclListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AclListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["showDeleted"]; ok {
- params.Set("showDeleted", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["syncToken"]; ok {
- params.Set("syncToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "calendars/{calendarId}/acl")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "calendarId": c.calendarId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.acl.list" call.
-// Exactly one of *Acl or error will be non-nil. Any non-2xx status code
-// is an error. Response headers are in either
-// *Acl.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *AclListCall) Do() (*Acl, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Acl{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the rules in the access control list for the calendar.",
- // "httpMethod": "GET",
- // "id": "calendar.acl.list",
- // "parameterOrder": [
- // "calendarId"
- // ],
- // "parameters": {
- // "calendarId": {
- // "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Token specifying which result page to return. Optional.",
- // "location": "query",
- // "type": "string"
- // },
- // "showDeleted": {
- // "description": "Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to \"none\". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "syncToken": {
- // "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "calendars/{calendarId}/acl",
- // "response": {
- // "$ref": "Acl"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar"
- // ],
- // "supportsSubscription": true
- // }
-
-}
-
-// method id "calendar.acl.patch":
-
-type AclPatchCall struct {
- s *Service
- calendarId string
- ruleId string
- aclrule *AclRule
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an access control rule. This method supports patch
-// semantics.
-func (r *AclService) Patch(calendarId string, ruleId string, aclrule *AclRule) *AclPatchCall {
- c := &AclPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendarId = calendarId
- c.ruleId = ruleId
- c.aclrule = aclrule
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AclPatchCall) Fields(s ...googleapi.Field) *AclPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AclPatchCall) Context(ctx context.Context) *AclPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AclPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.aclrule)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "calendars/{calendarId}/acl/{ruleId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "calendarId": c.calendarId,
- "ruleId": c.ruleId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.acl.patch" call.
-// Exactly one of *AclRule or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AclRule.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AclPatchCall) Do() (*AclRule, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AclRule{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an access control rule. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "calendar.acl.patch",
- // "parameterOrder": [
- // "calendarId",
- // "ruleId"
- // ],
- // "parameters": {
- // "calendarId": {
- // "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "ruleId": {
- // "description": "ACL rule identifier.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "calendars/{calendarId}/acl/{ruleId}",
- // "request": {
- // "$ref": "AclRule"
- // },
- // "response": {
- // "$ref": "AclRule"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar"
- // ]
- // }
-
-}
-
-// method id "calendar.acl.update":
-
-type AclUpdateCall struct {
- s *Service
- calendarId string
- ruleId string
- aclrule *AclRule
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an access control rule.
-func (r *AclService) Update(calendarId string, ruleId string, aclrule *AclRule) *AclUpdateCall {
- c := &AclUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendarId = calendarId
- c.ruleId = ruleId
- c.aclrule = aclrule
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AclUpdateCall) Fields(s ...googleapi.Field) *AclUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AclUpdateCall) Context(ctx context.Context) *AclUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AclUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.aclrule)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "calendars/{calendarId}/acl/{ruleId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "calendarId": c.calendarId,
- "ruleId": c.ruleId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.acl.update" call.
-// Exactly one of *AclRule or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *AclRule.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AclUpdateCall) Do() (*AclRule, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AclRule{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an access control rule.",
- // "httpMethod": "PUT",
- // "id": "calendar.acl.update",
- // "parameterOrder": [
- // "calendarId",
- // "ruleId"
- // ],
- // "parameters": {
- // "calendarId": {
- // "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "ruleId": {
- // "description": "ACL rule identifier.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "calendars/{calendarId}/acl/{ruleId}",
- // "request": {
- // "$ref": "AclRule"
- // },
- // "response": {
- // "$ref": "AclRule"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar"
- // ]
- // }
-
-}
-
-// method id "calendar.acl.watch":
-
-type AclWatchCall struct {
- s *Service
- calendarId string
- channel *Channel
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Watch: Watch for changes to ACL resources.
-func (r *AclService) Watch(calendarId string, channel *Channel) *AclWatchCall {
- c := &AclWatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendarId = calendarId
- c.channel = channel
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of entries returned on one result page. By default the value is 100
-// entries. The page size can never be larger than 250 entries.
-func (c *AclWatchCall) MaxResults(maxResults int64) *AclWatchCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Token specifying
-// which result page to return.
-func (c *AclWatchCall) PageToken(pageToken string) *AclWatchCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// ShowDeleted sets the optional parameter "showDeleted": Whether to
-// include deleted ACLs in the result. Deleted ACLs are represented by
-// role equal to "none". Deleted ACLs will always be included if
-// syncToken is provided. The default is False.
-func (c *AclWatchCall) ShowDeleted(showDeleted bool) *AclWatchCall {
- c.opt_["showDeleted"] = showDeleted
- return c
-}
-
-// SyncToken sets the optional parameter "syncToken": Token obtained
-// from the nextSyncToken field returned on the last page of results
-// from the previous list request. It makes the result of this list
-// request contain only entries that have changed since then. All
-// entries deleted since the previous list request will always be in the
-// result set and it is not allowed to set showDeleted to False.
-// If the syncToken expires, the server will respond with a 410 GONE
-// response code and the client should clear its storage and perform a
-// full synchronization without any syncToken.
-// Learn more about incremental synchronization.
-// The default is to return all entries.
-func (c *AclWatchCall) SyncToken(syncToken string) *AclWatchCall {
- c.opt_["syncToken"] = syncToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AclWatchCall) Fields(s ...googleapi.Field) *AclWatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AclWatchCall) Context(ctx context.Context) *AclWatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AclWatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.channel)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["showDeleted"]; ok {
- params.Set("showDeleted", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["syncToken"]; ok {
- params.Set("syncToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "calendars/{calendarId}/acl/watch")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "calendarId": c.calendarId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.acl.watch" call.
-// Exactly one of *Channel or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Channel.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AclWatchCall) Do() (*Channel, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Channel{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Watch for changes to ACL resources.",
- // "httpMethod": "POST",
- // "id": "calendar.acl.watch",
- // "parameterOrder": [
- // "calendarId"
- // ],
- // "parameters": {
- // "calendarId": {
- // "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Token specifying which result page to return. Optional.",
- // "location": "query",
- // "type": "string"
- // },
- // "showDeleted": {
- // "description": "Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to \"none\". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "syncToken": {
- // "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "calendars/{calendarId}/acl/watch",
- // "request": {
- // "$ref": "Channel",
- // "parameterName": "resource"
- // },
- // "response": {
- // "$ref": "Channel"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar"
- // ],
- // "supportsSubscription": true
- // }
-
-}
-
-// method id "calendar.calendarList.delete":
-
-type CalendarListDeleteCall struct {
- s *Service
- calendarId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an entry on the user's calendar list.
-func (r *CalendarListService) Delete(calendarId string) *CalendarListDeleteCall {
- c := &CalendarListDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendarId = calendarId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CalendarListDeleteCall) Fields(s ...googleapi.Field) *CalendarListDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CalendarListDeleteCall) Context(ctx context.Context) *CalendarListDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CalendarListDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/me/calendarList/{calendarId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "calendarId": c.calendarId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.calendarList.delete" call.
-func (c *CalendarListDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes an entry on the user's calendar list.",
- // "httpMethod": "DELETE",
- // "id": "calendar.calendarList.delete",
- // "parameterOrder": [
- // "calendarId"
- // ],
- // "parameters": {
- // "calendarId": {
- // "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/me/calendarList/{calendarId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar"
- // ]
- // }
-
-}
-
-// method id "calendar.calendarList.get":
-
-type CalendarListGetCall struct {
- s *Service
- calendarId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns an entry on the user's calendar list.
-func (r *CalendarListService) Get(calendarId string) *CalendarListGetCall {
- c := &CalendarListGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendarId = calendarId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CalendarListGetCall) Fields(s ...googleapi.Field) *CalendarListGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CalendarListGetCall) IfNoneMatch(entityTag string) *CalendarListGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CalendarListGetCall) Context(ctx context.Context) *CalendarListGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CalendarListGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/me/calendarList/{calendarId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "calendarId": c.calendarId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.calendarList.get" call.
-// Exactly one of *CalendarListEntry or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CalendarListEntry.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CalendarListGetCall) Do() (*CalendarListEntry, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CalendarListEntry{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns an entry on the user's calendar list.",
- // "httpMethod": "GET",
- // "id": "calendar.calendarList.get",
- // "parameterOrder": [
- // "calendarId"
- // ],
- // "parameters": {
- // "calendarId": {
- // "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/me/calendarList/{calendarId}",
- // "response": {
- // "$ref": "CalendarListEntry"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar",
- // "https://www.googleapis.com/auth/calendar.readonly"
- // ]
- // }
-
-}
-
-// method id "calendar.calendarList.insert":
-
-type CalendarListInsertCall struct {
- s *Service
- calendarlistentry *CalendarListEntry
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Adds an entry to the user's calendar list.
-func (r *CalendarListService) Insert(calendarlistentry *CalendarListEntry) *CalendarListInsertCall {
- c := &CalendarListInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendarlistentry = calendarlistentry
- return c
-}
-
-// ColorRgbFormat sets the optional parameter "colorRgbFormat": Whether
-// to use the foregroundColor and backgroundColor fields to write the
-// calendar colors (RGB). If this feature is used, the index-based
-// colorId field will be set to the best matching option automatically.
-// The default is False.
-func (c *CalendarListInsertCall) ColorRgbFormat(colorRgbFormat bool) *CalendarListInsertCall {
- c.opt_["colorRgbFormat"] = colorRgbFormat
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CalendarListInsertCall) Fields(s ...googleapi.Field) *CalendarListInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CalendarListInsertCall) Context(ctx context.Context) *CalendarListInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CalendarListInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.calendarlistentry)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["colorRgbFormat"]; ok {
- params.Set("colorRgbFormat", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/me/calendarList")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.calendarList.insert" call.
-// Exactly one of *CalendarListEntry or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CalendarListEntry.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CalendarListInsertCall) Do() (*CalendarListEntry, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CalendarListEntry{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Adds an entry to the user's calendar list.",
- // "httpMethod": "POST",
- // "id": "calendar.calendarList.insert",
- // "parameters": {
- // "colorRgbFormat": {
- // "description": "Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "users/me/calendarList",
- // "request": {
- // "$ref": "CalendarListEntry"
- // },
- // "response": {
- // "$ref": "CalendarListEntry"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar"
- // ]
- // }
-
-}
-
-// method id "calendar.calendarList.list":
-
-type CalendarListListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Returns entries on the user's calendar list.
-func (r *CalendarListService) List() *CalendarListListCall {
- c := &CalendarListListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of entries returned on one result page. By default the value is 100
-// entries. The page size can never be larger than 250 entries.
-func (c *CalendarListListCall) MaxResults(maxResults int64) *CalendarListListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// MinAccessRole sets the optional parameter "minAccessRole": The
-// minimum access role for the user in the returned entries. The
-// default is no restriction.
-//
-// Possible values:
-// "freeBusyReader" - The user can read free/busy information.
-// "owner" - The user can read and modify events and access control
-// lists.
-// "reader" - The user can read events that are not private.
-// "writer" - The user can read and modify events.
-func (c *CalendarListListCall) MinAccessRole(minAccessRole string) *CalendarListListCall {
- c.opt_["minAccessRole"] = minAccessRole
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Token specifying
-// which result page to return.
-func (c *CalendarListListCall) PageToken(pageToken string) *CalendarListListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// ShowDeleted sets the optional parameter "showDeleted": Whether to
-// include deleted calendar list entries in the result. The default is
-// False.
-func (c *CalendarListListCall) ShowDeleted(showDeleted bool) *CalendarListListCall {
- c.opt_["showDeleted"] = showDeleted
- return c
-}
-
-// ShowHidden sets the optional parameter "showHidden": Whether to show
-// hidden entries. The default is False.
-func (c *CalendarListListCall) ShowHidden(showHidden bool) *CalendarListListCall {
- c.opt_["showHidden"] = showHidden
- return c
-}
-
-// SyncToken sets the optional parameter "syncToken": Token obtained
-// from the nextSyncToken field returned on the last page of results
-// from the previous list request. It makes the result of this list
-// request contain only entries that have changed since then. If only
-// read-only fields such as calendar properties or ACLs have changed,
-// the entry won't be returned. All entries deleted and hidden since the
-// previous list request will always be in the result set and it is not
-// allowed to set showDeleted neither showHidden to False.
-// To ensure client state consistency minAccessRole query parameter
-// cannot be specified together with nextSyncToken.
-// If the syncToken expires, the server will respond with a 410 GONE
-// response code and the client should clear its storage and perform a
-// full synchronization without any syncToken.
-// Learn more about incremental synchronization.
-// The default is to return all entries.
-func (c *CalendarListListCall) SyncToken(syncToken string) *CalendarListListCall {
- c.opt_["syncToken"] = syncToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CalendarListListCall) Fields(s ...googleapi.Field) *CalendarListListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CalendarListListCall) IfNoneMatch(entityTag string) *CalendarListListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CalendarListListCall) Context(ctx context.Context) *CalendarListListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CalendarListListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["minAccessRole"]; ok {
- params.Set("minAccessRole", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["showDeleted"]; ok {
- params.Set("showDeleted", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["showHidden"]; ok {
- params.Set("showHidden", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["syncToken"]; ok {
- params.Set("syncToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/me/calendarList")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.calendarList.list" call.
-// Exactly one of *CalendarList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CalendarList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CalendarListListCall) Do() (*CalendarList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CalendarList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns entries on the user's calendar list.",
- // "httpMethod": "GET",
- // "id": "calendar.calendarList.list",
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "minAccessRole": {
- // "description": "The minimum access role for the user in the returned entries. Optional. The default is no restriction.",
- // "enum": [
- // "freeBusyReader",
- // "owner",
- // "reader",
- // "writer"
- // ],
- // "enumDescriptions": [
- // "The user can read free/busy information.",
- // "The user can read and modify events and access control lists.",
- // "The user can read events that are not private.",
- // "The user can read and modify events."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Token specifying which result page to return. Optional.",
- // "location": "query",
- // "type": "string"
- // },
- // "showDeleted": {
- // "description": "Whether to include deleted calendar list entries in the result. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "showHidden": {
- // "description": "Whether to show hidden entries. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "syncToken": {
- // "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False.\nTo ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "users/me/calendarList",
- // "response": {
- // "$ref": "CalendarList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar",
- // "https://www.googleapis.com/auth/calendar.readonly"
- // ],
- // "supportsSubscription": true
- // }
-
-}
-
-// method id "calendar.calendarList.patch":
-
-type CalendarListPatchCall struct {
- s *Service
- calendarId string
- calendarlistentry *CalendarListEntry
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an entry on the user's calendar list. This method
-// supports patch semantics.
-func (r *CalendarListService) Patch(calendarId string, calendarlistentry *CalendarListEntry) *CalendarListPatchCall {
- c := &CalendarListPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendarId = calendarId
- c.calendarlistentry = calendarlistentry
- return c
-}
-
-// ColorRgbFormat sets the optional parameter "colorRgbFormat": Whether
-// to use the foregroundColor and backgroundColor fields to write the
-// calendar colors (RGB). If this feature is used, the index-based
-// colorId field will be set to the best matching option automatically.
-// The default is False.
-func (c *CalendarListPatchCall) ColorRgbFormat(colorRgbFormat bool) *CalendarListPatchCall {
- c.opt_["colorRgbFormat"] = colorRgbFormat
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CalendarListPatchCall) Fields(s ...googleapi.Field) *CalendarListPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CalendarListPatchCall) Context(ctx context.Context) *CalendarListPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CalendarListPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.calendarlistentry)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["colorRgbFormat"]; ok {
- params.Set("colorRgbFormat", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/me/calendarList/{calendarId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "calendarId": c.calendarId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.calendarList.patch" call.
-// Exactly one of *CalendarListEntry or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CalendarListEntry.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CalendarListPatchCall) Do() (*CalendarListEntry, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CalendarListEntry{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an entry on the user's calendar list. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "calendar.calendarList.patch",
- // "parameterOrder": [
- // "calendarId"
- // ],
- // "parameters": {
- // "calendarId": {
- // "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "colorRgbFormat": {
- // "description": "Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "users/me/calendarList/{calendarId}",
- // "request": {
- // "$ref": "CalendarListEntry"
- // },
- // "response": {
- // "$ref": "CalendarListEntry"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar"
- // ]
- // }
-
-}
-
-// method id "calendar.calendarList.update":
-
-type CalendarListUpdateCall struct {
- s *Service
- calendarId string
- calendarlistentry *CalendarListEntry
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an entry on the user's calendar list.
-func (r *CalendarListService) Update(calendarId string, calendarlistentry *CalendarListEntry) *CalendarListUpdateCall {
- c := &CalendarListUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendarId = calendarId
- c.calendarlistentry = calendarlistentry
- return c
-}
-
-// ColorRgbFormat sets the optional parameter "colorRgbFormat": Whether
-// to use the foregroundColor and backgroundColor fields to write the
-// calendar colors (RGB). If this feature is used, the index-based
-// colorId field will be set to the best matching option automatically.
-// The default is False.
-func (c *CalendarListUpdateCall) ColorRgbFormat(colorRgbFormat bool) *CalendarListUpdateCall {
- c.opt_["colorRgbFormat"] = colorRgbFormat
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CalendarListUpdateCall) Fields(s ...googleapi.Field) *CalendarListUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CalendarListUpdateCall) Context(ctx context.Context) *CalendarListUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CalendarListUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.calendarlistentry)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["colorRgbFormat"]; ok {
- params.Set("colorRgbFormat", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/me/calendarList/{calendarId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "calendarId": c.calendarId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.calendarList.update" call.
-// Exactly one of *CalendarListEntry or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CalendarListEntry.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CalendarListUpdateCall) Do() (*CalendarListEntry, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CalendarListEntry{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an entry on the user's calendar list.",
- // "httpMethod": "PUT",
- // "id": "calendar.calendarList.update",
- // "parameterOrder": [
- // "calendarId"
- // ],
- // "parameters": {
- // "calendarId": {
- // "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "colorRgbFormat": {
- // "description": "Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "users/me/calendarList/{calendarId}",
- // "request": {
- // "$ref": "CalendarListEntry"
- // },
- // "response": {
- // "$ref": "CalendarListEntry"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar"
- // ]
- // }
-
-}
-
-// method id "calendar.calendarList.watch":
-
-type CalendarListWatchCall struct {
- s *Service
- channel *Channel
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Watch: Watch for changes to CalendarList resources.
-func (r *CalendarListService) Watch(channel *Channel) *CalendarListWatchCall {
- c := &CalendarListWatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.channel = channel
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of entries returned on one result page. By default the value is 100
-// entries. The page size can never be larger than 250 entries.
-func (c *CalendarListWatchCall) MaxResults(maxResults int64) *CalendarListWatchCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// MinAccessRole sets the optional parameter "minAccessRole": The
-// minimum access role for the user in the returned entries. The
-// default is no restriction.
-//
-// Possible values:
-// "freeBusyReader" - The user can read free/busy information.
-// "owner" - The user can read and modify events and access control
-// lists.
-// "reader" - The user can read events that are not private.
-// "writer" - The user can read and modify events.
-func (c *CalendarListWatchCall) MinAccessRole(minAccessRole string) *CalendarListWatchCall {
- c.opt_["minAccessRole"] = minAccessRole
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Token specifying
-// which result page to return.
-func (c *CalendarListWatchCall) PageToken(pageToken string) *CalendarListWatchCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// ShowDeleted sets the optional parameter "showDeleted": Whether to
-// include deleted calendar list entries in the result. The default is
-// False.
-func (c *CalendarListWatchCall) ShowDeleted(showDeleted bool) *CalendarListWatchCall {
- c.opt_["showDeleted"] = showDeleted
- return c
-}
-
-// ShowHidden sets the optional parameter "showHidden": Whether to show
-// hidden entries. The default is False.
-func (c *CalendarListWatchCall) ShowHidden(showHidden bool) *CalendarListWatchCall {
- c.opt_["showHidden"] = showHidden
- return c
-}
-
-// SyncToken sets the optional parameter "syncToken": Token obtained
-// from the nextSyncToken field returned on the last page of results
-// from the previous list request. It makes the result of this list
-// request contain only entries that have changed since then. If only
-// read-only fields such as calendar properties or ACLs have changed,
-// the entry won't be returned. All entries deleted and hidden since the
-// previous list request will always be in the result set and it is not
-// allowed to set showDeleted neither showHidden to False.
-// To ensure client state consistency minAccessRole query parameter
-// cannot be specified together with nextSyncToken.
-// If the syncToken expires, the server will respond with a 410 GONE
-// response code and the client should clear its storage and perform a
-// full synchronization without any syncToken.
-// Learn more about incremental synchronization.
-// The default is to return all entries.
-func (c *CalendarListWatchCall) SyncToken(syncToken string) *CalendarListWatchCall {
- c.opt_["syncToken"] = syncToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CalendarListWatchCall) Fields(s ...googleapi.Field) *CalendarListWatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CalendarListWatchCall) Context(ctx context.Context) *CalendarListWatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CalendarListWatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.channel)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["minAccessRole"]; ok {
- params.Set("minAccessRole", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["showDeleted"]; ok {
- params.Set("showDeleted", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["showHidden"]; ok {
- params.Set("showHidden", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["syncToken"]; ok {
- params.Set("syncToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/me/calendarList/watch")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.calendarList.watch" call.
-// Exactly one of *Channel or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Channel.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *CalendarListWatchCall) Do() (*Channel, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Channel{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Watch for changes to CalendarList resources.",
- // "httpMethod": "POST",
- // "id": "calendar.calendarList.watch",
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "minAccessRole": {
- // "description": "The minimum access role for the user in the returned entries. Optional. The default is no restriction.",
- // "enum": [
- // "freeBusyReader",
- // "owner",
- // "reader",
- // "writer"
- // ],
- // "enumDescriptions": [
- // "The user can read free/busy information.",
- // "The user can read and modify events and access control lists.",
- // "The user can read events that are not private.",
- // "The user can read and modify events."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Token specifying which result page to return. Optional.",
- // "location": "query",
- // "type": "string"
- // },
- // "showDeleted": {
- // "description": "Whether to include deleted calendar list entries in the result. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "showHidden": {
- // "description": "Whether to show hidden entries. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "syncToken": {
- // "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False.\nTo ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "users/me/calendarList/watch",
- // "request": {
- // "$ref": "Channel",
- // "parameterName": "resource"
- // },
- // "response": {
- // "$ref": "Channel"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar",
- // "https://www.googleapis.com/auth/calendar.readonly"
- // ],
- // "supportsSubscription": true
- // }
-
-}
-
-// method id "calendar.calendars.clear":
-
-type CalendarsClearCall struct {
- s *Service
- calendarId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Clear: Clears a primary calendar. This operation deletes all events
-// associated with the primary calendar of an account.
-func (r *CalendarsService) Clear(calendarId string) *CalendarsClearCall {
- c := &CalendarsClearCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendarId = calendarId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CalendarsClearCall) Fields(s ...googleapi.Field) *CalendarsClearCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CalendarsClearCall) Context(ctx context.Context) *CalendarsClearCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CalendarsClearCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "calendars/{calendarId}/clear")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "calendarId": c.calendarId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.calendars.clear" call.
-func (c *CalendarsClearCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.",
- // "httpMethod": "POST",
- // "id": "calendar.calendars.clear",
- // "parameterOrder": [
- // "calendarId"
- // ],
- // "parameters": {
- // "calendarId": {
- // "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "calendars/{calendarId}/clear",
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar"
- // ]
- // }
-
-}
-
-// method id "calendar.calendars.delete":
-
-type CalendarsDeleteCall struct {
- s *Service
- calendarId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes a secondary calendar. Use calendars.clear for
-// clearing all events on primary calendars.
-func (r *CalendarsService) Delete(calendarId string) *CalendarsDeleteCall {
- c := &CalendarsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendarId = calendarId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CalendarsDeleteCall) Fields(s ...googleapi.Field) *CalendarsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CalendarsDeleteCall) Context(ctx context.Context) *CalendarsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CalendarsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "calendars/{calendarId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "calendarId": c.calendarId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.calendars.delete" call.
-func (c *CalendarsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.",
- // "httpMethod": "DELETE",
- // "id": "calendar.calendars.delete",
- // "parameterOrder": [
- // "calendarId"
- // ],
- // "parameters": {
- // "calendarId": {
- // "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "calendars/{calendarId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar"
- // ]
- // }
-
-}
-
-// method id "calendar.calendars.get":
-
-type CalendarsGetCall struct {
- s *Service
- calendarId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns metadata for a calendar.
-func (r *CalendarsService) Get(calendarId string) *CalendarsGetCall {
- c := &CalendarsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendarId = calendarId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CalendarsGetCall) Fields(s ...googleapi.Field) *CalendarsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CalendarsGetCall) IfNoneMatch(entityTag string) *CalendarsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CalendarsGetCall) Context(ctx context.Context) *CalendarsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CalendarsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "calendars/{calendarId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "calendarId": c.calendarId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.calendars.get" call.
-// Exactly one of *Calendar or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Calendar.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CalendarsGetCall) Do() (*Calendar, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Calendar{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns metadata for a calendar.",
- // "httpMethod": "GET",
- // "id": "calendar.calendars.get",
- // "parameterOrder": [
- // "calendarId"
- // ],
- // "parameters": {
- // "calendarId": {
- // "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "calendars/{calendarId}",
- // "response": {
- // "$ref": "Calendar"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar",
- // "https://www.googleapis.com/auth/calendar.readonly"
- // ]
- // }
-
-}
-
-// method id "calendar.calendars.insert":
-
-type CalendarsInsertCall struct {
- s *Service
- calendar *Calendar
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a secondary calendar.
-func (r *CalendarsService) Insert(calendar *Calendar) *CalendarsInsertCall {
- c := &CalendarsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendar = calendar
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CalendarsInsertCall) Fields(s ...googleapi.Field) *CalendarsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CalendarsInsertCall) Context(ctx context.Context) *CalendarsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CalendarsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.calendar)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "calendars")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.calendars.insert" call.
-// Exactly one of *Calendar or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Calendar.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CalendarsInsertCall) Do() (*Calendar, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Calendar{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a secondary calendar.",
- // "httpMethod": "POST",
- // "id": "calendar.calendars.insert",
- // "path": "calendars",
- // "request": {
- // "$ref": "Calendar"
- // },
- // "response": {
- // "$ref": "Calendar"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar"
- // ]
- // }
-
-}
-
-// method id "calendar.calendars.patch":
-
-type CalendarsPatchCall struct {
- s *Service
- calendarId string
- calendar *Calendar
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates metadata for a calendar. This method supports patch
-// semantics.
-func (r *CalendarsService) Patch(calendarId string, calendar *Calendar) *CalendarsPatchCall {
- c := &CalendarsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendarId = calendarId
- c.calendar = calendar
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CalendarsPatchCall) Fields(s ...googleapi.Field) *CalendarsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CalendarsPatchCall) Context(ctx context.Context) *CalendarsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CalendarsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.calendar)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "calendars/{calendarId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "calendarId": c.calendarId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.calendars.patch" call.
-// Exactly one of *Calendar or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Calendar.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CalendarsPatchCall) Do() (*Calendar, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Calendar{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates metadata for a calendar. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "calendar.calendars.patch",
- // "parameterOrder": [
- // "calendarId"
- // ],
- // "parameters": {
- // "calendarId": {
- // "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "calendars/{calendarId}",
- // "request": {
- // "$ref": "Calendar"
- // },
- // "response": {
- // "$ref": "Calendar"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar"
- // ]
- // }
-
-}
-
-// method id "calendar.calendars.update":
-
-type CalendarsUpdateCall struct {
- s *Service
- calendarId string
- calendar *Calendar
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates metadata for a calendar.
-func (r *CalendarsService) Update(calendarId string, calendar *Calendar) *CalendarsUpdateCall {
- c := &CalendarsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendarId = calendarId
- c.calendar = calendar
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CalendarsUpdateCall) Fields(s ...googleapi.Field) *CalendarsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CalendarsUpdateCall) Context(ctx context.Context) *CalendarsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CalendarsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.calendar)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "calendars/{calendarId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "calendarId": c.calendarId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.calendars.update" call.
-// Exactly one of *Calendar or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Calendar.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CalendarsUpdateCall) Do() (*Calendar, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Calendar{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates metadata for a calendar.",
- // "httpMethod": "PUT",
- // "id": "calendar.calendars.update",
- // "parameterOrder": [
- // "calendarId"
- // ],
- // "parameters": {
- // "calendarId": {
- // "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "calendars/{calendarId}",
- // "request": {
- // "$ref": "Calendar"
- // },
- // "response": {
- // "$ref": "Calendar"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar"
- // ]
- // }
-
-}
-
-// method id "calendar.channels.stop":
-
-type ChannelsStopCall struct {
- s *Service
- channel *Channel
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Stop: Stop watching resources through this channel
-func (r *ChannelsService) Stop(channel *Channel) *ChannelsStopCall {
- c := &ChannelsStopCall{s: r.s, opt_: make(map[string]interface{})}
- c.channel = channel
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ChannelsStopCall) Fields(s ...googleapi.Field) *ChannelsStopCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ChannelsStopCall) Context(ctx context.Context) *ChannelsStopCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ChannelsStopCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.channel)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "channels/stop")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.channels.stop" call.
-func (c *ChannelsStopCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Stop watching resources through this channel",
- // "httpMethod": "POST",
- // "id": "calendar.channels.stop",
- // "path": "channels/stop",
- // "request": {
- // "$ref": "Channel",
- // "parameterName": "resource"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar",
- // "https://www.googleapis.com/auth/calendar.readonly"
- // ]
- // }
-
-}
-
-// method id "calendar.colors.get":
-
-type ColorsGetCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the color definitions for calendars and events.
-func (r *ColorsService) Get() *ColorsGetCall {
- c := &ColorsGetCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ColorsGetCall) Fields(s ...googleapi.Field) *ColorsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ColorsGetCall) IfNoneMatch(entityTag string) *ColorsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ColorsGetCall) Context(ctx context.Context) *ColorsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ColorsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "colors")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.colors.get" call.
-// Exactly one of *Colors or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Colors.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ColorsGetCall) Do() (*Colors, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Colors{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the color definitions for calendars and events.",
- // "httpMethod": "GET",
- // "id": "calendar.colors.get",
- // "path": "colors",
- // "response": {
- // "$ref": "Colors"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar",
- // "https://www.googleapis.com/auth/calendar.readonly"
- // ]
- // }
-
-}
-
-// method id "calendar.events.delete":
-
-type EventsDeleteCall struct {
- s *Service
- calendarId string
- eventId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an event.
-func (r *EventsService) Delete(calendarId string, eventId string) *EventsDeleteCall {
- c := &EventsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendarId = calendarId
- c.eventId = eventId
- return c
-}
-
-// SendNotifications sets the optional parameter "sendNotifications":
-// Whether to send notifications about the deletion of the event. The
-// default is False.
-func (c *EventsDeleteCall) SendNotifications(sendNotifications bool) *EventsDeleteCall {
- c.opt_["sendNotifications"] = sendNotifications
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EventsDeleteCall) Fields(s ...googleapi.Field) *EventsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EventsDeleteCall) Context(ctx context.Context) *EventsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EventsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["sendNotifications"]; ok {
- params.Set("sendNotifications", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "calendars/{calendarId}/events/{eventId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "calendarId": c.calendarId,
- "eventId": c.eventId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.events.delete" call.
-func (c *EventsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes an event.",
- // "httpMethod": "DELETE",
- // "id": "calendar.events.delete",
- // "parameterOrder": [
- // "calendarId",
- // "eventId"
- // ],
- // "parameters": {
- // "calendarId": {
- // "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "eventId": {
- // "description": "Event identifier.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "sendNotifications": {
- // "description": "Whether to send notifications about the deletion of the event. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "calendars/{calendarId}/events/{eventId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar"
- // ]
- // }
-
-}
-
-// method id "calendar.events.get":
-
-type EventsGetCall struct {
- s *Service
- calendarId string
- eventId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns an event.
-func (r *EventsService) Get(calendarId string, eventId string) *EventsGetCall {
- c := &EventsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendarId = calendarId
- c.eventId = eventId
- return c
-}
-
-// AlwaysIncludeEmail sets the optional parameter "alwaysIncludeEmail":
-// Whether to always include a value in the email field for the
-// organizer, creator and attendees, even if no real email is available
-// (i.e. a generated, non-working value will be provided). The use of
-// this option is discouraged and should only be used by clients which
-// cannot handle the absence of an email address value in the mentioned
-// places. The default is False.
-func (c *EventsGetCall) AlwaysIncludeEmail(alwaysIncludeEmail bool) *EventsGetCall {
- c.opt_["alwaysIncludeEmail"] = alwaysIncludeEmail
- return c
-}
-
-// MaxAttendees sets the optional parameter "maxAttendees": The maximum
-// number of attendees to include in the response. If there are more
-// than the specified number of attendees, only the participant is
-// returned.
-func (c *EventsGetCall) MaxAttendees(maxAttendees int64) *EventsGetCall {
- c.opt_["maxAttendees"] = maxAttendees
- return c
-}
-
-// TimeZone sets the optional parameter "timeZone": Time zone used in
-// the response. The default is the time zone of the calendar.
-func (c *EventsGetCall) TimeZone(timeZone string) *EventsGetCall {
- c.opt_["timeZone"] = timeZone
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EventsGetCall) Fields(s ...googleapi.Field) *EventsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *EventsGetCall) IfNoneMatch(entityTag string) *EventsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EventsGetCall) Context(ctx context.Context) *EventsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EventsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["alwaysIncludeEmail"]; ok {
- params.Set("alwaysIncludeEmail", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxAttendees"]; ok {
- params.Set("maxAttendees", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["timeZone"]; ok {
- params.Set("timeZone", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "calendars/{calendarId}/events/{eventId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "calendarId": c.calendarId,
- "eventId": c.eventId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.events.get" call.
-// Exactly one of *Event or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Event.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *EventsGetCall) Do() (*Event, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Event{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns an event.",
- // "httpMethod": "GET",
- // "id": "calendar.events.get",
- // "parameterOrder": [
- // "calendarId",
- // "eventId"
- // ],
- // "parameters": {
- // "alwaysIncludeEmail": {
- // "description": "Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "calendarId": {
- // "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "eventId": {
- // "description": "Event identifier.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxAttendees": {
- // "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "timeZone": {
- // "description": "Time zone used in the response. Optional. The default is the time zone of the calendar.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "calendars/{calendarId}/events/{eventId}",
- // "response": {
- // "$ref": "Event"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar",
- // "https://www.googleapis.com/auth/calendar.readonly"
- // ]
- // }
-
-}
-
-// method id "calendar.events.import":
-
-type EventsImportCall struct {
- s *Service
- calendarId string
- event *Event
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Import: Imports an event. This operation is used to add a private
-// copy of an existing event to a calendar.
-func (r *EventsService) Import(calendarId string, event *Event) *EventsImportCall {
- c := &EventsImportCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendarId = calendarId
- c.event = event
- return c
-}
-
-// SupportsAttachments sets the optional parameter
-// "supportsAttachments": Whether API client performing operation
-// supports event attachments. The default is False.
-func (c *EventsImportCall) SupportsAttachments(supportsAttachments bool) *EventsImportCall {
- c.opt_["supportsAttachments"] = supportsAttachments
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EventsImportCall) Fields(s ...googleapi.Field) *EventsImportCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EventsImportCall) Context(ctx context.Context) *EventsImportCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EventsImportCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.event)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["supportsAttachments"]; ok {
- params.Set("supportsAttachments", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "calendars/{calendarId}/events/import")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "calendarId": c.calendarId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.events.import" call.
-// Exactly one of *Event or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Event.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *EventsImportCall) Do() (*Event, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Event{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Imports an event. This operation is used to add a private copy of an existing event to a calendar.",
- // "httpMethod": "POST",
- // "id": "calendar.events.import",
- // "parameterOrder": [
- // "calendarId"
- // ],
- // "parameters": {
- // "calendarId": {
- // "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "supportsAttachments": {
- // "description": "Whether API client performing operation supports event attachments. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "calendars/{calendarId}/events/import",
- // "request": {
- // "$ref": "Event"
- // },
- // "response": {
- // "$ref": "Event"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar"
- // ]
- // }
-
-}
-
-// method id "calendar.events.insert":
-
-type EventsInsertCall struct {
- s *Service
- calendarId string
- event *Event
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates an event.
-func (r *EventsService) Insert(calendarId string, event *Event) *EventsInsertCall {
- c := &EventsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendarId = calendarId
- c.event = event
- return c
-}
-
-// MaxAttendees sets the optional parameter "maxAttendees": The maximum
-// number of attendees to include in the response. If there are more
-// than the specified number of attendees, only the participant is
-// returned.
-func (c *EventsInsertCall) MaxAttendees(maxAttendees int64) *EventsInsertCall {
- c.opt_["maxAttendees"] = maxAttendees
- return c
-}
-
-// SendNotifications sets the optional parameter "sendNotifications":
-// Whether to send notifications about the creation of the new event.
-// The default is False.
-func (c *EventsInsertCall) SendNotifications(sendNotifications bool) *EventsInsertCall {
- c.opt_["sendNotifications"] = sendNotifications
- return c
-}
-
-// SupportsAttachments sets the optional parameter
-// "supportsAttachments": Whether API client performing operation
-// supports event attachments. The default is False.
-func (c *EventsInsertCall) SupportsAttachments(supportsAttachments bool) *EventsInsertCall {
- c.opt_["supportsAttachments"] = supportsAttachments
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EventsInsertCall) Fields(s ...googleapi.Field) *EventsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EventsInsertCall) Context(ctx context.Context) *EventsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EventsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.event)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxAttendees"]; ok {
- params.Set("maxAttendees", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sendNotifications"]; ok {
- params.Set("sendNotifications", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["supportsAttachments"]; ok {
- params.Set("supportsAttachments", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "calendars/{calendarId}/events")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "calendarId": c.calendarId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.events.insert" call.
-// Exactly one of *Event or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Event.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *EventsInsertCall) Do() (*Event, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Event{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates an event.",
- // "httpMethod": "POST",
- // "id": "calendar.events.insert",
- // "parameterOrder": [
- // "calendarId"
- // ],
- // "parameters": {
- // "calendarId": {
- // "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxAttendees": {
- // "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "sendNotifications": {
- // "description": "Whether to send notifications about the creation of the new event. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "supportsAttachments": {
- // "description": "Whether API client performing operation supports event attachments. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "calendars/{calendarId}/events",
- // "request": {
- // "$ref": "Event"
- // },
- // "response": {
- // "$ref": "Event"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar"
- // ]
- // }
-
-}
-
-// method id "calendar.events.instances":
-
-type EventsInstancesCall struct {
- s *Service
- calendarId string
- eventId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Instances: Returns instances of the specified recurring event.
-func (r *EventsService) Instances(calendarId string, eventId string) *EventsInstancesCall {
- c := &EventsInstancesCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendarId = calendarId
- c.eventId = eventId
- return c
-}
-
-// AlwaysIncludeEmail sets the optional parameter "alwaysIncludeEmail":
-// Whether to always include a value in the email field for the
-// organizer, creator and attendees, even if no real email is available
-// (i.e. a generated, non-working value will be provided). The use of
-// this option is discouraged and should only be used by clients which
-// cannot handle the absence of an email address value in the mentioned
-// places. The default is False.
-func (c *EventsInstancesCall) AlwaysIncludeEmail(alwaysIncludeEmail bool) *EventsInstancesCall {
- c.opt_["alwaysIncludeEmail"] = alwaysIncludeEmail
- return c
-}
-
-// MaxAttendees sets the optional parameter "maxAttendees": The maximum
-// number of attendees to include in the response. If there are more
-// than the specified number of attendees, only the participant is
-// returned.
-func (c *EventsInstancesCall) MaxAttendees(maxAttendees int64) *EventsInstancesCall {
- c.opt_["maxAttendees"] = maxAttendees
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of events returned on one result page. By default the value is 250
-// events. The page size can never be larger than 2500 events.
-func (c *EventsInstancesCall) MaxResults(maxResults int64) *EventsInstancesCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OriginalStart sets the optional parameter "originalStart": The
-// original start time of the instance in the result.
-func (c *EventsInstancesCall) OriginalStart(originalStart string) *EventsInstancesCall {
- c.opt_["originalStart"] = originalStart
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Token specifying
-// which result page to return.
-func (c *EventsInstancesCall) PageToken(pageToken string) *EventsInstancesCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// ShowDeleted sets the optional parameter "showDeleted": Whether to
-// include deleted events (with status equals "cancelled") in the
-// result. Cancelled instances of recurring events will still be
-// included if singleEvents is False. The default is False.
-func (c *EventsInstancesCall) ShowDeleted(showDeleted bool) *EventsInstancesCall {
- c.opt_["showDeleted"] = showDeleted
- return c
-}
-
-// TimeMax sets the optional parameter "timeMax": Upper bound
-// (exclusive) for an event's start time to filter by. The default is
-// not to filter by start time. Must be an RFC3339 timestamp with
-// mandatory time zone offset.
-func (c *EventsInstancesCall) TimeMax(timeMax string) *EventsInstancesCall {
- c.opt_["timeMax"] = timeMax
- return c
-}
-
-// TimeMin sets the optional parameter "timeMin": Lower bound
-// (inclusive) for an event's end time to filter by. The default is not
-// to filter by end time. Must be an RFC3339 timestamp with mandatory
-// time zone offset.
-func (c *EventsInstancesCall) TimeMin(timeMin string) *EventsInstancesCall {
- c.opt_["timeMin"] = timeMin
- return c
-}
-
-// TimeZone sets the optional parameter "timeZone": Time zone used in
-// the response. The default is the time zone of the calendar.
-func (c *EventsInstancesCall) TimeZone(timeZone string) *EventsInstancesCall {
- c.opt_["timeZone"] = timeZone
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EventsInstancesCall) Fields(s ...googleapi.Field) *EventsInstancesCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *EventsInstancesCall) IfNoneMatch(entityTag string) *EventsInstancesCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EventsInstancesCall) Context(ctx context.Context) *EventsInstancesCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EventsInstancesCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["alwaysIncludeEmail"]; ok {
- params.Set("alwaysIncludeEmail", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxAttendees"]; ok {
- params.Set("maxAttendees", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["originalStart"]; ok {
- params.Set("originalStart", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["showDeleted"]; ok {
- params.Set("showDeleted", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["timeMax"]; ok {
- params.Set("timeMax", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["timeMin"]; ok {
- params.Set("timeMin", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["timeZone"]; ok {
- params.Set("timeZone", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "calendars/{calendarId}/events/{eventId}/instances")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "calendarId": c.calendarId,
- "eventId": c.eventId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.events.instances" call.
-// Exactly one of *Events or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Events.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *EventsInstancesCall) Do() (*Events, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Events{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns instances of the specified recurring event.",
- // "httpMethod": "GET",
- // "id": "calendar.events.instances",
- // "parameterOrder": [
- // "calendarId",
- // "eventId"
- // ],
- // "parameters": {
- // "alwaysIncludeEmail": {
- // "description": "Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "calendarId": {
- // "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "eventId": {
- // "description": "Recurring event identifier.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxAttendees": {
- // "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "maxResults": {
- // "description": "Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "originalStart": {
- // "description": "The original start time of the instance in the result. Optional.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Token specifying which result page to return. Optional.",
- // "location": "query",
- // "type": "string"
- // },
- // "showDeleted": {
- // "description": "Whether to include deleted events (with status equals \"cancelled\") in the result. Cancelled instances of recurring events will still be included if singleEvents is False. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "timeMax": {
- // "description": "Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset.",
- // "format": "date-time",
- // "location": "query",
- // "type": "string"
- // },
- // "timeMin": {
- // "description": "Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset.",
- // "format": "date-time",
- // "location": "query",
- // "type": "string"
- // },
- // "timeZone": {
- // "description": "Time zone used in the response. Optional. The default is the time zone of the calendar.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "calendars/{calendarId}/events/{eventId}/instances",
- // "response": {
- // "$ref": "Events"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar",
- // "https://www.googleapis.com/auth/calendar.readonly"
- // ],
- // "supportsSubscription": true
- // }
-
-}
-
-// method id "calendar.events.list":
-
-type EventsListCall struct {
- s *Service
- calendarId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Returns events on the specified calendar.
-func (r *EventsService) List(calendarId string) *EventsListCall {
- c := &EventsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendarId = calendarId
- return c
-}
-
-// AlwaysIncludeEmail sets the optional parameter "alwaysIncludeEmail":
-// Whether to always include a value in the email field for the
-// organizer, creator and attendees, even if no real email is available
-// (i.e. a generated, non-working value will be provided). The use of
-// this option is discouraged and should only be used by clients which
-// cannot handle the absence of an email address value in the mentioned
-// places. The default is False.
-func (c *EventsListCall) AlwaysIncludeEmail(alwaysIncludeEmail bool) *EventsListCall {
- c.opt_["alwaysIncludeEmail"] = alwaysIncludeEmail
- return c
-}
-
-// ICalUID sets the optional parameter "iCalUID": Specifies event ID in
-// the iCalendar format to be included in the response.
-func (c *EventsListCall) ICalUID(iCalUID string) *EventsListCall {
- c.opt_["iCalUID"] = iCalUID
- return c
-}
-
-// MaxAttendees sets the optional parameter "maxAttendees": The maximum
-// number of attendees to include in the response. If there are more
-// than the specified number of attendees, only the participant is
-// returned.
-func (c *EventsListCall) MaxAttendees(maxAttendees int64) *EventsListCall {
- c.opt_["maxAttendees"] = maxAttendees
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of events returned on one result page. By default the value is 250
-// events. The page size can never be larger than 2500 events.
-func (c *EventsListCall) MaxResults(maxResults int64) *EventsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": The order of the
-// events returned in the result. The default is an unspecified, stable
-// order.
-//
-// Possible values:
-// "startTime" - Order by the start date/time (ascending). This is
-// only available when querying single events (i.e. the parameter
-// singleEvents is True)
-// "updated" - Order by last modification time (ascending).
-func (c *EventsListCall) OrderBy(orderBy string) *EventsListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Token specifying
-// which result page to return.
-func (c *EventsListCall) PageToken(pageToken string) *EventsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// PrivateExtendedProperty sets the optional parameter
-// "privateExtendedProperty": Extended properties constraint specified
-// as propertyName=value. Matches only private properties. This
-// parameter might be repeated multiple times to return events that
-// match all given constraints.
-func (c *EventsListCall) PrivateExtendedProperty(privateExtendedProperty string) *EventsListCall {
- c.opt_["privateExtendedProperty"] = privateExtendedProperty
- return c
-}
-
-// Q sets the optional parameter "q": Free text search terms to find
-// events that match these terms in any field, except for extended
-// properties.
-func (c *EventsListCall) Q(q string) *EventsListCall {
- c.opt_["q"] = q
- return c
-}
-
-// SharedExtendedProperty sets the optional parameter
-// "sharedExtendedProperty": Extended properties constraint specified as
-// propertyName=value. Matches only shared properties. This parameter
-// might be repeated multiple times to return events that match all
-// given constraints.
-func (c *EventsListCall) SharedExtendedProperty(sharedExtendedProperty string) *EventsListCall {
- c.opt_["sharedExtendedProperty"] = sharedExtendedProperty
- return c
-}
-
-// ShowDeleted sets the optional parameter "showDeleted": Whether to
-// include deleted events (with status equals "cancelled") in the
-// result. Cancelled instances of recurring events (but not the
-// underlying recurring event) will still be included if showDeleted and
-// singleEvents are both False. If showDeleted and singleEvents are both
-// True, only single instances of deleted events (but not the underlying
-// recurring events) are returned. The default is False.
-func (c *EventsListCall) ShowDeleted(showDeleted bool) *EventsListCall {
- c.opt_["showDeleted"] = showDeleted
- return c
-}
-
-// ShowHiddenInvitations sets the optional parameter
-// "showHiddenInvitations": Whether to include hidden invitations in the
-// result. The default is False.
-func (c *EventsListCall) ShowHiddenInvitations(showHiddenInvitations bool) *EventsListCall {
- c.opt_["showHiddenInvitations"] = showHiddenInvitations
- return c
-}
-
-// SingleEvents sets the optional parameter "singleEvents": Whether to
-// expand recurring events into instances and only return single one-off
-// events and instances of recurring events, but not the underlying
-// recurring events themselves. The default is False.
-func (c *EventsListCall) SingleEvents(singleEvents bool) *EventsListCall {
- c.opt_["singleEvents"] = singleEvents
- return c
-}
-
-// SyncToken sets the optional parameter "syncToken": Token obtained
-// from the nextSyncToken field returned on the last page of results
-// from the previous list request. It makes the result of this list
-// request contain only entries that have changed since then. All events
-// deleted since the previous list request will always be in the result
-// set and it is not allowed to set showDeleted to False.
-// There are several query parameters that cannot be specified together
-// with nextSyncToken to ensure consistency of the client state.
-//
-// These are:
-// - iCalUID
-// - orderBy
-// - privateExtendedProperty
-// - q
-// - sharedExtendedProperty
-// - timeMin
-// - timeMax
-// - updatedMin If the syncToken expires, the server will respond with a
-// 410 GONE response code and the client should clear its storage and
-// perform a full synchronization without any syncToken.
-// Learn more about incremental synchronization.
-// The default is to return all entries.
-func (c *EventsListCall) SyncToken(syncToken string) *EventsListCall {
- c.opt_["syncToken"] = syncToken
- return c
-}
-
-// TimeMax sets the optional parameter "timeMax": Upper bound
-// (exclusive) for an event's start time to filter by. The default is
-// not to filter by start time. Must be an RFC3339 timestamp with
-// mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00,
-// 2011-06-03T10:00:00Z. Milliseconds may be provided but will be
-// ignored.
-func (c *EventsListCall) TimeMax(timeMax string) *EventsListCall {
- c.opt_["timeMax"] = timeMax
- return c
-}
-
-// TimeMin sets the optional parameter "timeMin": Lower bound
-// (inclusive) for an event's end time to filter by. The default is not
-// to filter by end time. Must be an RFC3339 timestamp with mandatory
-// time zone offset, e.g., 2011-06-03T10:00:00-07:00,
-// 2011-06-03T10:00:00Z. Milliseconds may be provided but will be
-// ignored.
-func (c *EventsListCall) TimeMin(timeMin string) *EventsListCall {
- c.opt_["timeMin"] = timeMin
- return c
-}
-
-// TimeZone sets the optional parameter "timeZone": Time zone used in
-// the response. The default is the time zone of the calendar.
-func (c *EventsListCall) TimeZone(timeZone string) *EventsListCall {
- c.opt_["timeZone"] = timeZone
- return c
-}
-
-// UpdatedMin sets the optional parameter "updatedMin": Lower bound for
-// an event's last modification time (as a RFC3339 timestamp) to filter
-// by. When specified, entries deleted since this time will always be
-// included regardless of showDeleted. The default is not to filter by
-// last modification time.
-func (c *EventsListCall) UpdatedMin(updatedMin string) *EventsListCall {
- c.opt_["updatedMin"] = updatedMin
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EventsListCall) Fields(s ...googleapi.Field) *EventsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *EventsListCall) IfNoneMatch(entityTag string) *EventsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EventsListCall) Context(ctx context.Context) *EventsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EventsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["alwaysIncludeEmail"]; ok {
- params.Set("alwaysIncludeEmail", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["iCalUID"]; ok {
- params.Set("iCalUID", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxAttendees"]; ok {
- params.Set("maxAttendees", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["privateExtendedProperty"]; ok {
- params.Set("privateExtendedProperty", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["q"]; ok {
- params.Set("q", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sharedExtendedProperty"]; ok {
- params.Set("sharedExtendedProperty", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["showDeleted"]; ok {
- params.Set("showDeleted", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["showHiddenInvitations"]; ok {
- params.Set("showHiddenInvitations", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["singleEvents"]; ok {
- params.Set("singleEvents", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["syncToken"]; ok {
- params.Set("syncToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["timeMax"]; ok {
- params.Set("timeMax", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["timeMin"]; ok {
- params.Set("timeMin", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["timeZone"]; ok {
- params.Set("timeZone", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["updatedMin"]; ok {
- params.Set("updatedMin", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "calendars/{calendarId}/events")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "calendarId": c.calendarId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.events.list" call.
-// Exactly one of *Events or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Events.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *EventsListCall) Do() (*Events, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Events{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns events on the specified calendar.",
- // "httpMethod": "GET",
- // "id": "calendar.events.list",
- // "parameterOrder": [
- // "calendarId"
- // ],
- // "parameters": {
- // "alwaysIncludeEmail": {
- // "description": "Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "calendarId": {
- // "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "iCalUID": {
- // "description": "Specifies event ID in the iCalendar format to be included in the response. Optional.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxAttendees": {
- // "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "maxResults": {
- // "description": "Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "The order of the events returned in the result. Optional. The default is an unspecified, stable order.",
- // "enum": [
- // "startTime",
- // "updated"
- // ],
- // "enumDescriptions": [
- // "Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)",
- // "Order by last modification time (ascending)."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Token specifying which result page to return. Optional.",
- // "location": "query",
- // "type": "string"
- // },
- // "privateExtendedProperty": {
- // "description": "Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "q": {
- // "description": "Free text search terms to find events that match these terms in any field, except for extended properties. Optional.",
- // "location": "query",
- // "type": "string"
- // },
- // "sharedExtendedProperty": {
- // "description": "Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "showDeleted": {
- // "description": "Whether to include deleted events (with status equals \"cancelled\") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "showHiddenInvitations": {
- // "description": "Whether to include hidden invitations in the result. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "singleEvents": {
- // "description": "Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "syncToken": {
- // "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nThere are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.\n\nThese are: \n- iCalUID \n- orderBy \n- privateExtendedProperty \n- q \n- sharedExtendedProperty \n- timeMin \n- timeMax \n- updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
- // "location": "query",
- // "type": "string"
- // },
- // "timeMax": {
- // "description": "Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored.",
- // "format": "date-time",
- // "location": "query",
- // "type": "string"
- // },
- // "timeMin": {
- // "description": "Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored.",
- // "format": "date-time",
- // "location": "query",
- // "type": "string"
- // },
- // "timeZone": {
- // "description": "Time zone used in the response. Optional. The default is the time zone of the calendar.",
- // "location": "query",
- // "type": "string"
- // },
- // "updatedMin": {
- // "description": "Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.",
- // "format": "date-time",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "calendars/{calendarId}/events",
- // "response": {
- // "$ref": "Events"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar",
- // "https://www.googleapis.com/auth/calendar.readonly"
- // ],
- // "supportsSubscription": true
- // }
-
-}
-
-// method id "calendar.events.move":
-
-type EventsMoveCall struct {
- s *Service
- calendarId string
- eventId string
- destinationid string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Move: Moves an event to another calendar, i.e. changes an event's
-// organizer.
-func (r *EventsService) Move(calendarId string, eventId string, destinationid string) *EventsMoveCall {
- c := &EventsMoveCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendarId = calendarId
- c.eventId = eventId
- c.destinationid = destinationid
- return c
-}
-
-// SendNotifications sets the optional parameter "sendNotifications":
-// Whether to send notifications about the change of the event's
-// organizer. The default is False.
-func (c *EventsMoveCall) SendNotifications(sendNotifications bool) *EventsMoveCall {
- c.opt_["sendNotifications"] = sendNotifications
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EventsMoveCall) Fields(s ...googleapi.Field) *EventsMoveCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EventsMoveCall) Context(ctx context.Context) *EventsMoveCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EventsMoveCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("destination", fmt.Sprintf("%v", c.destinationid))
- if v, ok := c.opt_["sendNotifications"]; ok {
- params.Set("sendNotifications", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "calendars/{calendarId}/events/{eventId}/move")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "calendarId": c.calendarId,
- "eventId": c.eventId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.events.move" call.
-// Exactly one of *Event or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Event.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *EventsMoveCall) Do() (*Event, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Event{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Moves an event to another calendar, i.e. changes an event's organizer.",
- // "httpMethod": "POST",
- // "id": "calendar.events.move",
- // "parameterOrder": [
- // "calendarId",
- // "eventId",
- // "destination"
- // ],
- // "parameters": {
- // "calendarId": {
- // "description": "Calendar identifier of the source calendar where the event currently is on.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "destination": {
- // "description": "Calendar identifier of the target calendar where the event is to be moved to.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "eventId": {
- // "description": "Event identifier.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "sendNotifications": {
- // "description": "Whether to send notifications about the change of the event's organizer. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "calendars/{calendarId}/events/{eventId}/move",
- // "response": {
- // "$ref": "Event"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar"
- // ]
- // }
-
-}
-
-// method id "calendar.events.patch":
-
-type EventsPatchCall struct {
- s *Service
- calendarId string
- eventId string
- event *Event
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an event. This method supports patch semantics.
-func (r *EventsService) Patch(calendarId string, eventId string, event *Event) *EventsPatchCall {
- c := &EventsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendarId = calendarId
- c.eventId = eventId
- c.event = event
- return c
-}
-
-// AlwaysIncludeEmail sets the optional parameter "alwaysIncludeEmail":
-// Whether to always include a value in the email field for the
-// organizer, creator and attendees, even if no real email is available
-// (i.e. a generated, non-working value will be provided). The use of
-// this option is discouraged and should only be used by clients which
-// cannot handle the absence of an email address value in the mentioned
-// places. The default is False.
-func (c *EventsPatchCall) AlwaysIncludeEmail(alwaysIncludeEmail bool) *EventsPatchCall {
- c.opt_["alwaysIncludeEmail"] = alwaysIncludeEmail
- return c
-}
-
-// MaxAttendees sets the optional parameter "maxAttendees": The maximum
-// number of attendees to include in the response. If there are more
-// than the specified number of attendees, only the participant is
-// returned.
-func (c *EventsPatchCall) MaxAttendees(maxAttendees int64) *EventsPatchCall {
- c.opt_["maxAttendees"] = maxAttendees
- return c
-}
-
-// SendNotifications sets the optional parameter "sendNotifications":
-// Whether to send notifications about the event update (e.g. attendee's
-// responses, title changes, etc.). The default is False.
-func (c *EventsPatchCall) SendNotifications(sendNotifications bool) *EventsPatchCall {
- c.opt_["sendNotifications"] = sendNotifications
- return c
-}
-
-// SupportsAttachments sets the optional parameter
-// "supportsAttachments": Whether API client performing operation
-// supports event attachments. The default is False.
-func (c *EventsPatchCall) SupportsAttachments(supportsAttachments bool) *EventsPatchCall {
- c.opt_["supportsAttachments"] = supportsAttachments
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EventsPatchCall) Fields(s ...googleapi.Field) *EventsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EventsPatchCall) Context(ctx context.Context) *EventsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EventsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.event)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["alwaysIncludeEmail"]; ok {
- params.Set("alwaysIncludeEmail", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxAttendees"]; ok {
- params.Set("maxAttendees", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sendNotifications"]; ok {
- params.Set("sendNotifications", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["supportsAttachments"]; ok {
- params.Set("supportsAttachments", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "calendars/{calendarId}/events/{eventId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "calendarId": c.calendarId,
- "eventId": c.eventId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.events.patch" call.
-// Exactly one of *Event or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Event.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *EventsPatchCall) Do() (*Event, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Event{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an event. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "calendar.events.patch",
- // "parameterOrder": [
- // "calendarId",
- // "eventId"
- // ],
- // "parameters": {
- // "alwaysIncludeEmail": {
- // "description": "Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "calendarId": {
- // "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "eventId": {
- // "description": "Event identifier.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxAttendees": {
- // "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "sendNotifications": {
- // "description": "Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "supportsAttachments": {
- // "description": "Whether API client performing operation supports event attachments. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "calendars/{calendarId}/events/{eventId}",
- // "request": {
- // "$ref": "Event"
- // },
- // "response": {
- // "$ref": "Event"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar"
- // ]
- // }
-
-}
-
-// method id "calendar.events.quickAdd":
-
-type EventsQuickAddCall struct {
- s *Service
- calendarId string
- text string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// QuickAdd: Creates an event based on a simple text string.
-func (r *EventsService) QuickAdd(calendarId string, text string) *EventsQuickAddCall {
- c := &EventsQuickAddCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendarId = calendarId
- c.text = text
- return c
-}
-
-// SendNotifications sets the optional parameter "sendNotifications":
-// Whether to send notifications about the creation of the event. The
-// default is False.
-func (c *EventsQuickAddCall) SendNotifications(sendNotifications bool) *EventsQuickAddCall {
- c.opt_["sendNotifications"] = sendNotifications
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EventsQuickAddCall) Fields(s ...googleapi.Field) *EventsQuickAddCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EventsQuickAddCall) Context(ctx context.Context) *EventsQuickAddCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EventsQuickAddCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("text", fmt.Sprintf("%v", c.text))
- if v, ok := c.opt_["sendNotifications"]; ok {
- params.Set("sendNotifications", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "calendars/{calendarId}/events/quickAdd")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "calendarId": c.calendarId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.events.quickAdd" call.
-// Exactly one of *Event or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Event.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *EventsQuickAddCall) Do() (*Event, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Event{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates an event based on a simple text string.",
- // "httpMethod": "POST",
- // "id": "calendar.events.quickAdd",
- // "parameterOrder": [
- // "calendarId",
- // "text"
- // ],
- // "parameters": {
- // "calendarId": {
- // "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "sendNotifications": {
- // "description": "Whether to send notifications about the creation of the event. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "text": {
- // "description": "The text describing the event to be created.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "calendars/{calendarId}/events/quickAdd",
- // "response": {
- // "$ref": "Event"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar"
- // ]
- // }
-
-}
-
-// method id "calendar.events.update":
-
-type EventsUpdateCall struct {
- s *Service
- calendarId string
- eventId string
- event *Event
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an event.
-func (r *EventsService) Update(calendarId string, eventId string, event *Event) *EventsUpdateCall {
- c := &EventsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendarId = calendarId
- c.eventId = eventId
- c.event = event
- return c
-}
-
-// AlwaysIncludeEmail sets the optional parameter "alwaysIncludeEmail":
-// Whether to always include a value in the email field for the
-// organizer, creator and attendees, even if no real email is available
-// (i.e. a generated, non-working value will be provided). The use of
-// this option is discouraged and should only be used by clients which
-// cannot handle the absence of an email address value in the mentioned
-// places. The default is False.
-func (c *EventsUpdateCall) AlwaysIncludeEmail(alwaysIncludeEmail bool) *EventsUpdateCall {
- c.opt_["alwaysIncludeEmail"] = alwaysIncludeEmail
- return c
-}
-
-// MaxAttendees sets the optional parameter "maxAttendees": The maximum
-// number of attendees to include in the response. If there are more
-// than the specified number of attendees, only the participant is
-// returned.
-func (c *EventsUpdateCall) MaxAttendees(maxAttendees int64) *EventsUpdateCall {
- c.opt_["maxAttendees"] = maxAttendees
- return c
-}
-
-// SendNotifications sets the optional parameter "sendNotifications":
-// Whether to send notifications about the event update (e.g. attendee's
-// responses, title changes, etc.). The default is False.
-func (c *EventsUpdateCall) SendNotifications(sendNotifications bool) *EventsUpdateCall {
- c.opt_["sendNotifications"] = sendNotifications
- return c
-}
-
-// SupportsAttachments sets the optional parameter
-// "supportsAttachments": Whether API client performing operation
-// supports event attachments. The default is False.
-func (c *EventsUpdateCall) SupportsAttachments(supportsAttachments bool) *EventsUpdateCall {
- c.opt_["supportsAttachments"] = supportsAttachments
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EventsUpdateCall) Fields(s ...googleapi.Field) *EventsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EventsUpdateCall) Context(ctx context.Context) *EventsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EventsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.event)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["alwaysIncludeEmail"]; ok {
- params.Set("alwaysIncludeEmail", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxAttendees"]; ok {
- params.Set("maxAttendees", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sendNotifications"]; ok {
- params.Set("sendNotifications", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["supportsAttachments"]; ok {
- params.Set("supportsAttachments", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "calendars/{calendarId}/events/{eventId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "calendarId": c.calendarId,
- "eventId": c.eventId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.events.update" call.
-// Exactly one of *Event or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Event.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *EventsUpdateCall) Do() (*Event, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Event{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an event.",
- // "httpMethod": "PUT",
- // "id": "calendar.events.update",
- // "parameterOrder": [
- // "calendarId",
- // "eventId"
- // ],
- // "parameters": {
- // "alwaysIncludeEmail": {
- // "description": "Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "calendarId": {
- // "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "eventId": {
- // "description": "Event identifier.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxAttendees": {
- // "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "sendNotifications": {
- // "description": "Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "supportsAttachments": {
- // "description": "Whether API client performing operation supports event attachments. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "calendars/{calendarId}/events/{eventId}",
- // "request": {
- // "$ref": "Event"
- // },
- // "response": {
- // "$ref": "Event"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar"
- // ]
- // }
-
-}
-
-// method id "calendar.events.watch":
-
-type EventsWatchCall struct {
- s *Service
- calendarId string
- channel *Channel
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Watch: Watch for changes to Events resources.
-func (r *EventsService) Watch(calendarId string, channel *Channel) *EventsWatchCall {
- c := &EventsWatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.calendarId = calendarId
- c.channel = channel
- return c
-}
-
-// AlwaysIncludeEmail sets the optional parameter "alwaysIncludeEmail":
-// Whether to always include a value in the email field for the
-// organizer, creator and attendees, even if no real email is available
-// (i.e. a generated, non-working value will be provided). The use of
-// this option is discouraged and should only be used by clients which
-// cannot handle the absence of an email address value in the mentioned
-// places. The default is False.
-func (c *EventsWatchCall) AlwaysIncludeEmail(alwaysIncludeEmail bool) *EventsWatchCall {
- c.opt_["alwaysIncludeEmail"] = alwaysIncludeEmail
- return c
-}
-
-// ICalUID sets the optional parameter "iCalUID": Specifies event ID in
-// the iCalendar format to be included in the response.
-func (c *EventsWatchCall) ICalUID(iCalUID string) *EventsWatchCall {
- c.opt_["iCalUID"] = iCalUID
- return c
-}
-
-// MaxAttendees sets the optional parameter "maxAttendees": The maximum
-// number of attendees to include in the response. If there are more
-// than the specified number of attendees, only the participant is
-// returned.
-func (c *EventsWatchCall) MaxAttendees(maxAttendees int64) *EventsWatchCall {
- c.opt_["maxAttendees"] = maxAttendees
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of events returned on one result page. By default the value is 250
-// events. The page size can never be larger than 2500 events.
-func (c *EventsWatchCall) MaxResults(maxResults int64) *EventsWatchCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": The order of the
-// events returned in the result. The default is an unspecified, stable
-// order.
-//
-// Possible values:
-// "startTime" - Order by the start date/time (ascending). This is
-// only available when querying single events (i.e. the parameter
-// singleEvents is True)
-// "updated" - Order by last modification time (ascending).
-func (c *EventsWatchCall) OrderBy(orderBy string) *EventsWatchCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Token specifying
-// which result page to return.
-func (c *EventsWatchCall) PageToken(pageToken string) *EventsWatchCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// PrivateExtendedProperty sets the optional parameter
-// "privateExtendedProperty": Extended properties constraint specified
-// as propertyName=value. Matches only private properties. This
-// parameter might be repeated multiple times to return events that
-// match all given constraints.
-func (c *EventsWatchCall) PrivateExtendedProperty(privateExtendedProperty string) *EventsWatchCall {
- c.opt_["privateExtendedProperty"] = privateExtendedProperty
- return c
-}
-
-// Q sets the optional parameter "q": Free text search terms to find
-// events that match these terms in any field, except for extended
-// properties.
-func (c *EventsWatchCall) Q(q string) *EventsWatchCall {
- c.opt_["q"] = q
- return c
-}
-
-// SharedExtendedProperty sets the optional parameter
-// "sharedExtendedProperty": Extended properties constraint specified as
-// propertyName=value. Matches only shared properties. This parameter
-// might be repeated multiple times to return events that match all
-// given constraints.
-func (c *EventsWatchCall) SharedExtendedProperty(sharedExtendedProperty string) *EventsWatchCall {
- c.opt_["sharedExtendedProperty"] = sharedExtendedProperty
- return c
-}
-
-// ShowDeleted sets the optional parameter "showDeleted": Whether to
-// include deleted events (with status equals "cancelled") in the
-// result. Cancelled instances of recurring events (but not the
-// underlying recurring event) will still be included if showDeleted and
-// singleEvents are both False. If showDeleted and singleEvents are both
-// True, only single instances of deleted events (but not the underlying
-// recurring events) are returned. The default is False.
-func (c *EventsWatchCall) ShowDeleted(showDeleted bool) *EventsWatchCall {
- c.opt_["showDeleted"] = showDeleted
- return c
-}
-
-// ShowHiddenInvitations sets the optional parameter
-// "showHiddenInvitations": Whether to include hidden invitations in the
-// result. The default is False.
-func (c *EventsWatchCall) ShowHiddenInvitations(showHiddenInvitations bool) *EventsWatchCall {
- c.opt_["showHiddenInvitations"] = showHiddenInvitations
- return c
-}
-
-// SingleEvents sets the optional parameter "singleEvents": Whether to
-// expand recurring events into instances and only return single one-off
-// events and instances of recurring events, but not the underlying
-// recurring events themselves. The default is False.
-func (c *EventsWatchCall) SingleEvents(singleEvents bool) *EventsWatchCall {
- c.opt_["singleEvents"] = singleEvents
- return c
-}
-
-// SyncToken sets the optional parameter "syncToken": Token obtained
-// from the nextSyncToken field returned on the last page of results
-// from the previous list request. It makes the result of this list
-// request contain only entries that have changed since then. All events
-// deleted since the previous list request will always be in the result
-// set and it is not allowed to set showDeleted to False.
-// There are several query parameters that cannot be specified together
-// with nextSyncToken to ensure consistency of the client state.
-//
-// These are:
-// - iCalUID
-// - orderBy
-// - privateExtendedProperty
-// - q
-// - sharedExtendedProperty
-// - timeMin
-// - timeMax
-// - updatedMin If the syncToken expires, the server will respond with a
-// 410 GONE response code and the client should clear its storage and
-// perform a full synchronization without any syncToken.
-// Learn more about incremental synchronization.
-// The default is to return all entries.
-func (c *EventsWatchCall) SyncToken(syncToken string) *EventsWatchCall {
- c.opt_["syncToken"] = syncToken
- return c
-}
-
-// TimeMax sets the optional parameter "timeMax": Upper bound
-// (exclusive) for an event's start time to filter by. The default is
-// not to filter by start time. Must be an RFC3339 timestamp with
-// mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00,
-// 2011-06-03T10:00:00Z. Milliseconds may be provided but will be
-// ignored.
-func (c *EventsWatchCall) TimeMax(timeMax string) *EventsWatchCall {
- c.opt_["timeMax"] = timeMax
- return c
-}
-
-// TimeMin sets the optional parameter "timeMin": Lower bound
-// (inclusive) for an event's end time to filter by. The default is not
-// to filter by end time. Must be an RFC3339 timestamp with mandatory
-// time zone offset, e.g., 2011-06-03T10:00:00-07:00,
-// 2011-06-03T10:00:00Z. Milliseconds may be provided but will be
-// ignored.
-func (c *EventsWatchCall) TimeMin(timeMin string) *EventsWatchCall {
- c.opt_["timeMin"] = timeMin
- return c
-}
-
-// TimeZone sets the optional parameter "timeZone": Time zone used in
-// the response. The default is the time zone of the calendar.
-func (c *EventsWatchCall) TimeZone(timeZone string) *EventsWatchCall {
- c.opt_["timeZone"] = timeZone
- return c
-}
-
-// UpdatedMin sets the optional parameter "updatedMin": Lower bound for
-// an event's last modification time (as a RFC3339 timestamp) to filter
-// by. When specified, entries deleted since this time will always be
-// included regardless of showDeleted. The default is not to filter by
-// last modification time.
-func (c *EventsWatchCall) UpdatedMin(updatedMin string) *EventsWatchCall {
- c.opt_["updatedMin"] = updatedMin
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EventsWatchCall) Fields(s ...googleapi.Field) *EventsWatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EventsWatchCall) Context(ctx context.Context) *EventsWatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EventsWatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.channel)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["alwaysIncludeEmail"]; ok {
- params.Set("alwaysIncludeEmail", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["iCalUID"]; ok {
- params.Set("iCalUID", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxAttendees"]; ok {
- params.Set("maxAttendees", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["privateExtendedProperty"]; ok {
- params.Set("privateExtendedProperty", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["q"]; ok {
- params.Set("q", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sharedExtendedProperty"]; ok {
- params.Set("sharedExtendedProperty", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["showDeleted"]; ok {
- params.Set("showDeleted", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["showHiddenInvitations"]; ok {
- params.Set("showHiddenInvitations", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["singleEvents"]; ok {
- params.Set("singleEvents", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["syncToken"]; ok {
- params.Set("syncToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["timeMax"]; ok {
- params.Set("timeMax", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["timeMin"]; ok {
- params.Set("timeMin", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["timeZone"]; ok {
- params.Set("timeZone", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["updatedMin"]; ok {
- params.Set("updatedMin", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "calendars/{calendarId}/events/watch")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "calendarId": c.calendarId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.events.watch" call.
-// Exactly one of *Channel or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Channel.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *EventsWatchCall) Do() (*Channel, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Channel{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Watch for changes to Events resources.",
- // "httpMethod": "POST",
- // "id": "calendar.events.watch",
- // "parameterOrder": [
- // "calendarId"
- // ],
- // "parameters": {
- // "alwaysIncludeEmail": {
- // "description": "Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "calendarId": {
- // "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "iCalUID": {
- // "description": "Specifies event ID in the iCalendar format to be included in the response. Optional.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxAttendees": {
- // "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "maxResults": {
- // "description": "Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "The order of the events returned in the result. Optional. The default is an unspecified, stable order.",
- // "enum": [
- // "startTime",
- // "updated"
- // ],
- // "enumDescriptions": [
- // "Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)",
- // "Order by last modification time (ascending)."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Token specifying which result page to return. Optional.",
- // "location": "query",
- // "type": "string"
- // },
- // "privateExtendedProperty": {
- // "description": "Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "q": {
- // "description": "Free text search terms to find events that match these terms in any field, except for extended properties. Optional.",
- // "location": "query",
- // "type": "string"
- // },
- // "sharedExtendedProperty": {
- // "description": "Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "showDeleted": {
- // "description": "Whether to include deleted events (with status equals \"cancelled\") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "showHiddenInvitations": {
- // "description": "Whether to include hidden invitations in the result. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "singleEvents": {
- // "description": "Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "syncToken": {
- // "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nThere are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.\n\nThese are: \n- iCalUID \n- orderBy \n- privateExtendedProperty \n- q \n- sharedExtendedProperty \n- timeMin \n- timeMax \n- updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
- // "location": "query",
- // "type": "string"
- // },
- // "timeMax": {
- // "description": "Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored.",
- // "format": "date-time",
- // "location": "query",
- // "type": "string"
- // },
- // "timeMin": {
- // "description": "Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored.",
- // "format": "date-time",
- // "location": "query",
- // "type": "string"
- // },
- // "timeZone": {
- // "description": "Time zone used in the response. Optional. The default is the time zone of the calendar.",
- // "location": "query",
- // "type": "string"
- // },
- // "updatedMin": {
- // "description": "Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.",
- // "format": "date-time",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "calendars/{calendarId}/events/watch",
- // "request": {
- // "$ref": "Channel",
- // "parameterName": "resource"
- // },
- // "response": {
- // "$ref": "Channel"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar",
- // "https://www.googleapis.com/auth/calendar.readonly"
- // ],
- // "supportsSubscription": true
- // }
-
-}
-
-// method id "calendar.freebusy.query":
-
-type FreebusyQueryCall struct {
- s *Service
- freebusyrequest *FreeBusyRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Query: Returns free/busy information for a set of calendars.
-func (r *FreebusyService) Query(freebusyrequest *FreeBusyRequest) *FreebusyQueryCall {
- c := &FreebusyQueryCall{s: r.s, opt_: make(map[string]interface{})}
- c.freebusyrequest = freebusyrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FreebusyQueryCall) Fields(s ...googleapi.Field) *FreebusyQueryCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FreebusyQueryCall) Context(ctx context.Context) *FreebusyQueryCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FreebusyQueryCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.freebusyrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "freeBusy")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.freebusy.query" call.
-// Exactly one of *FreeBusyResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *FreeBusyResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *FreebusyQueryCall) Do() (*FreeBusyResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FreeBusyResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns free/busy information for a set of calendars.",
- // "httpMethod": "POST",
- // "id": "calendar.freebusy.query",
- // "path": "freeBusy",
- // "request": {
- // "$ref": "FreeBusyRequest"
- // },
- // "response": {
- // "$ref": "FreeBusyResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar",
- // "https://www.googleapis.com/auth/calendar.readonly"
- // ]
- // }
-
-}
-
-// method id "calendar.settings.get":
-
-type SettingsGetCall struct {
- s *Service
- setting string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns a single user setting.
-func (r *SettingsService) Get(setting string) *SettingsGetCall {
- c := &SettingsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.setting = setting
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SettingsGetCall) Fields(s ...googleapi.Field) *SettingsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SettingsGetCall) IfNoneMatch(entityTag string) *SettingsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SettingsGetCall) Context(ctx context.Context) *SettingsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SettingsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/me/settings/{setting}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "setting": c.setting,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.settings.get" call.
-// Exactly one of *Setting or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Setting.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *SettingsGetCall) Do() (*Setting, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Setting{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns a single user setting.",
- // "httpMethod": "GET",
- // "id": "calendar.settings.get",
- // "parameterOrder": [
- // "setting"
- // ],
- // "parameters": {
- // "setting": {
- // "description": "The id of the user setting.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "users/me/settings/{setting}",
- // "response": {
- // "$ref": "Setting"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar",
- // "https://www.googleapis.com/auth/calendar.readonly"
- // ]
- // }
-
-}
-
-// method id "calendar.settings.list":
-
-type SettingsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Returns all user settings for the authenticated user.
-func (r *SettingsService) List() *SettingsListCall {
- c := &SettingsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of entries returned on one result page. By default the value is 100
-// entries. The page size can never be larger than 250 entries.
-func (c *SettingsListCall) MaxResults(maxResults int64) *SettingsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Token specifying
-// which result page to return.
-func (c *SettingsListCall) PageToken(pageToken string) *SettingsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SyncToken sets the optional parameter "syncToken": Token obtained
-// from the nextSyncToken field returned on the last page of results
-// from the previous list request. It makes the result of this list
-// request contain only entries that have changed since then.
-// If the syncToken expires, the server will respond with a 410 GONE
-// response code and the client should clear its storage and perform a
-// full synchronization without any syncToken.
-// Learn more about incremental synchronization.
-// The default is to return all entries.
-func (c *SettingsListCall) SyncToken(syncToken string) *SettingsListCall {
- c.opt_["syncToken"] = syncToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SettingsListCall) Fields(s ...googleapi.Field) *SettingsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SettingsListCall) IfNoneMatch(entityTag string) *SettingsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SettingsListCall) Context(ctx context.Context) *SettingsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SettingsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["syncToken"]; ok {
- params.Set("syncToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/me/settings")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.settings.list" call.
-// Exactly one of *Settings or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Settings.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *SettingsListCall) Do() (*Settings, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Settings{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns all user settings for the authenticated user.",
- // "httpMethod": "GET",
- // "id": "calendar.settings.list",
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Token specifying which result page to return. Optional.",
- // "location": "query",
- // "type": "string"
- // },
- // "syncToken": {
- // "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "users/me/settings",
- // "response": {
- // "$ref": "Settings"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar",
- // "https://www.googleapis.com/auth/calendar.readonly"
- // ],
- // "supportsSubscription": true
- // }
-
-}
-
-// method id "calendar.settings.watch":
-
-type SettingsWatchCall struct {
- s *Service
- channel *Channel
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Watch: Watch for changes to Settings resources.
-func (r *SettingsService) Watch(channel *Channel) *SettingsWatchCall {
- c := &SettingsWatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.channel = channel
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of entries returned on one result page. By default the value is 100
-// entries. The page size can never be larger than 250 entries.
-func (c *SettingsWatchCall) MaxResults(maxResults int64) *SettingsWatchCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Token specifying
-// which result page to return.
-func (c *SettingsWatchCall) PageToken(pageToken string) *SettingsWatchCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SyncToken sets the optional parameter "syncToken": Token obtained
-// from the nextSyncToken field returned on the last page of results
-// from the previous list request. It makes the result of this list
-// request contain only entries that have changed since then.
-// If the syncToken expires, the server will respond with a 410 GONE
-// response code and the client should clear its storage and perform a
-// full synchronization without any syncToken.
-// Learn more about incremental synchronization.
-// The default is to return all entries.
-func (c *SettingsWatchCall) SyncToken(syncToken string) *SettingsWatchCall {
- c.opt_["syncToken"] = syncToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SettingsWatchCall) Fields(s ...googleapi.Field) *SettingsWatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SettingsWatchCall) Context(ctx context.Context) *SettingsWatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SettingsWatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.channel)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["syncToken"]; ok {
- params.Set("syncToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "users/me/settings/watch")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "calendar.settings.watch" call.
-// Exactly one of *Channel or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Channel.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *SettingsWatchCall) Do() (*Channel, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Channel{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Watch for changes to Settings resources.",
- // "httpMethod": "POST",
- // "id": "calendar.settings.watch",
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.",
- // "format": "int32",
- // "location": "query",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Token specifying which result page to return. Optional.",
- // "location": "query",
- // "type": "string"
- // },
- // "syncToken": {
- // "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "users/me/settings/watch",
- // "request": {
- // "$ref": "Channel",
- // "parameterName": "resource"
- // },
- // "response": {
- // "$ref": "Channel"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/calendar",
- // "https://www.googleapis.com/auth/calendar.readonly"
- // ],
- // "supportsSubscription": true
- // }
-
-}
diff --git a/vendor/google.golang.org/api/civicinfo/v2/civicinfo-api.json b/vendor/google.golang.org/api/civicinfo/v2/civicinfo-api.json
deleted file mode 100644
index e9faf765..00000000
--- a/vendor/google.golang.org/api/civicinfo/v2/civicinfo-api.json
+++ /dev/null
@@ -1,1069 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/ZiNhyAfCE7ZKhbU1KQ-igi1g1zk\"",
- "discoveryVersion": "v1",
- "id": "civicinfo:v2",
- "name": "civicinfo",
- "canonicalName": "Civic Info",
- "version": "v2",
- "revision": "20150820",
- "title": "Google Civic Information API",
- "description": "An API for accessing civic information.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/civic-information",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/civicinfo/v2/",
- "basePath": "/civicinfo/v2/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "civicinfo/v2/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "schemas": {
- "AdministrationRegion": {
- "id": "AdministrationRegion",
- "type": "object",
- "description": "Describes information about a regional election administrative area.",
- "properties": {
- "electionAdministrationBody": {
- "$ref": "AdministrativeBody",
- "description": "The election administration body for this area."
- },
- "id": {
- "type": "string",
- "description": "An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page."
- },
- "local_jurisdiction": {
- "$ref": "AdministrationRegion",
- "description": "The city or county that provides election information for this voter. This object can have the same elements as state."
- },
- "name": {
- "type": "string",
- "description": "The name of the jurisdiction."
- },
- "sources": {
- "type": "array",
- "description": "A list of sources for this area. If multiple sources are listed the data has been aggregated from those sources.",
- "items": {
- "$ref": "Source"
- }
- }
- }
- },
- "AdministrativeBody": {
- "id": "AdministrativeBody",
- "type": "object",
- "description": "Information about an election administrative body (e.g. County Board of Elections).",
- "properties": {
- "absenteeVotingInfoUrl": {
- "type": "string",
- "description": "A URL provided by this administrative body for information on absentee voting."
- },
- "ballotInfoUrl": {
- "type": "string",
- "description": "A URL provided by this administrative body to give contest information to the voter."
- },
- "correspondenceAddress": {
- "$ref": "SimpleAddressType",
- "description": "The mailing address of this administrative body."
- },
- "electionInfoUrl": {
- "type": "string",
- "description": "A URL provided by this administrative body for looking up general election information."
- },
- "electionOfficials": {
- "type": "array",
- "description": "The election officials for this election administrative body.",
- "items": {
- "$ref": "ElectionOfficial"
- }
- },
- "electionRegistrationConfirmationUrl": {
- "type": "string",
- "description": "A URL provided by this administrative body for confirming that the voter is registered to vote."
- },
- "electionRegistrationUrl": {
- "type": "string",
- "description": "A URL provided by this administrative body for looking up how to register to vote."
- },
- "electionRulesUrl": {
- "type": "string",
- "description": "A URL provided by this administrative body describing election rules to the voter."
- },
- "hoursOfOperation": {
- "type": "string",
- "description": "A description of the hours of operation for this administrative body."
- },
- "name": {
- "type": "string",
- "description": "The name of this election administrative body."
- },
- "physicalAddress": {
- "$ref": "SimpleAddressType",
- "description": "The physical address of this administrative body."
- },
- "voter_services": {
- "type": "array",
- "description": "A description of the services this administrative body may provide.",
- "items": {
- "type": "string"
- }
- },
- "votingLocationFinderUrl": {
- "type": "string",
- "description": "A URL provided by this administrative body for looking up where to vote."
- }
- }
- },
- "Candidate": {
- "id": "Candidate",
- "type": "object",
- "description": "Information about a candidate running for elected office.",
- "properties": {
- "candidateUrl": {
- "type": "string",
- "description": "The URL for the candidate's campaign web site."
- },
- "channels": {
- "type": "array",
- "description": "A list of known (social) media channels for this candidate.",
- "items": {
- "$ref": "Channel"
- }
- },
- "email": {
- "type": "string",
- "description": "The email address for the candidate's campaign."
- },
- "name": {
- "type": "string",
- "description": "The candidate's name."
- },
- "orderOnBallot": {
- "type": "string",
- "description": "The order the candidate appears on the ballot for this contest.",
- "format": "int64"
- },
- "party": {
- "type": "string",
- "description": "The full name of the party the candidate is a member of."
- },
- "phone": {
- "type": "string",
- "description": "The voice phone number for the candidate's campaign office."
- },
- "photoUrl": {
- "type": "string",
- "description": "A URL for a photo of the candidate."
- }
- }
- },
- "Channel": {
- "id": "Channel",
- "type": "object",
- "description": "A social media or web channel for a candidate.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The unique public identifier for the candidate's channel."
- },
- "type": {
- "type": "string",
- "description": "The type of channel. The following is a list of types of channels, but is not exhaustive. More channel types may be added at a later time. One of: GooglePlus, YouTube, Facebook, Twitter"
- }
- }
- },
- "Contest": {
- "id": "Contest",
- "type": "object",
- "description": "Information about a contest that appears on a voter's ballot.",
- "properties": {
- "ballotPlacement": {
- "type": "string",
- "description": "A number specifying the position of this contest on the voter's ballot.",
- "format": "int64"
- },
- "candidates": {
- "type": "array",
- "description": "The candidate choices for this contest.",
- "items": {
- "$ref": "Candidate"
- }
- },
- "district": {
- "$ref": "ElectoralDistrict",
- "description": "Information about the electoral district that this contest is in."
- },
- "electorateSpecifications": {
- "type": "string",
- "description": "A description of any additional eligibility requirements for voting in this contest."
- },
- "id": {
- "type": "string",
- "description": "An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page."
- },
- "level": {
- "type": "array",
- "description": "The levels of government of the office for this contest. There may be more than one in cases where a jurisdiction effectively acts at two different levels of government; for example, the mayor of the District of Columbia acts at \"locality\" level, but also effectively at both \"administrative-area-2\" and \"administrative-area-1\".",
- "items": {
- "type": "string"
- }
- },
- "numberElected": {
- "type": "string",
- "description": "The number of candidates that will be elected to office in this contest.",
- "format": "int64"
- },
- "numberVotingFor": {
- "type": "string",
- "description": "The number of candidates that a voter may vote for in this contest.",
- "format": "int64"
- },
- "office": {
- "type": "string",
- "description": "The name of the office for this contest."
- },
- "primaryParty": {
- "type": "string",
- "description": "If this is a partisan election, the name of the party it is for."
- },
- "referendumBallotResponses": {
- "type": "array",
- "description": "The set of ballot responses for the referendum. A ballot response represents a line on the ballot. Common examples might include \"yes\" or \"no\" for referenda, or a judge's name for a retention contest. This field is only populated for contests of type 'Referendum'.",
- "items": {
- "type": "string"
- }
- },
- "referendumBrief": {
- "type": "string",
- "description": "Specifies a short summary of the referendum that is typically on the ballot below the title but above the text. This field is only populated for contests of type 'Referendum'."
- },
- "referendumConStatement": {
- "type": "string",
- "description": "A statement in opposition to the referendum. It does not necessarily appear on the ballot. This field is only populated for contests of type 'Referendum'."
- },
- "referendumEffectOfAbstain": {
- "type": "string",
- "description": "Specifies what effect abstaining (not voting) on the proposition will have (i.e. whether abstaining is considered a vote against it). This field is only populated for contests of type 'Referendum'."
- },
- "referendumPassageThreshold": {
- "type": "string",
- "description": "The threshold of votes that the referendum needs in order to pass, e.g. \"two-thirds\". This field is only populated for contests of type 'Referendum'."
- },
- "referendumProStatement": {
- "type": "string",
- "description": "A statement in favor of the referendum. It does not necessarily appear on the ballot. This field is only populated for contests of type 'Referendum'."
- },
- "referendumSubtitle": {
- "type": "string",
- "description": "A brief description of the referendum. This field is only populated for contests of type 'Referendum'."
- },
- "referendumText": {
- "type": "string",
- "description": "The full text of the referendum. This field is only populated for contests of type 'Referendum'."
- },
- "referendumTitle": {
- "type": "string",
- "description": "The title of the referendum (e.g. 'Proposition 42'). This field is only populated for contests of type 'Referendum'."
- },
- "referendumUrl": {
- "type": "string",
- "description": "A link to the referendum. This field is only populated for contests of type 'Referendum'."
- },
- "roles": {
- "type": "array",
- "description": "The roles which this office fulfills.",
- "items": {
- "type": "string"
- }
- },
- "sources": {
- "type": "array",
- "description": "A list of sources for this contest. If multiple sources are listed, the data has been aggregated from those sources.",
- "items": {
- "$ref": "Source"
- }
- },
- "special": {
- "type": "string",
- "description": "\"Yes\" or \"No\" depending on whether this a contest being held outside the normal election cycle."
- },
- "type": {
- "type": "string",
- "description": "The type of contest. Usually this will be 'General', 'Primary', or 'Run-off' for contests with candidates. For referenda this will be 'Referendum'."
- }
- }
- },
- "DivisionSearchResponse": {
- "id": "DivisionSearchResponse",
- "type": "object",
- "description": "The result of a division search query.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#divisionSearchResponse\".",
- "default": "civicinfo#divisionSearchResponse"
- },
- "results": {
- "type": "array",
- "items": {
- "$ref": "DivisionSearchResult"
- }
- }
- }
- },
- "DivisionSearchResult": {
- "id": "DivisionSearchResult",
- "type": "object",
- "description": "Represents a political geographic division that matches the requested query.",
- "properties": {
- "aliases": {
- "type": "array",
- "description": "Other Open Civic Data identifiers that refer to the same division -- for example, those that refer to other political divisions whose boundaries are defined to be coterminous with this one. For example, ocd-division/country:us/state:wy will include an alias of ocd-division/country:us/state:wy/cd:1, since Wyoming has only one Congressional district.",
- "items": {
- "type": "string"
- }
- },
- "name": {
- "type": "string",
- "description": "The name of the division."
- },
- "ocdId": {
- "type": "string",
- "description": "The unique Open Civic Data identifier for this division."
- }
- }
- },
- "Election": {
- "id": "Election",
- "type": "object",
- "description": "Information about the election that was queried.",
- "properties": {
- "electionDay": {
- "type": "string",
- "description": "Day of the election in YYYY-MM-DD format."
- },
- "id": {
- "type": "string",
- "description": "The unique ID of this election.",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "A displayable name for the election."
- },
- "ocdDivisionId": {
- "type": "string",
- "description": "The political division of the election. Represented as an OCD Division ID. Voters within these political jurisdictions are covered by this election. This is typically a state such as ocd-division/country:us/state:ca or for the midterms or general election the entire US (i.e. ocd-division/country:us)."
- }
- }
- },
- "ElectionOfficial": {
- "id": "ElectionOfficial",
- "type": "object",
- "description": "Information about individual election officials.",
- "properties": {
- "emailAddress": {
- "type": "string",
- "description": "The email address of the election official."
- },
- "faxNumber": {
- "type": "string",
- "description": "The fax number of the election official."
- },
- "name": {
- "type": "string",
- "description": "The full name of the election official."
- },
- "officePhoneNumber": {
- "type": "string",
- "description": "The office phone number of the election official."
- },
- "title": {
- "type": "string",
- "description": "The title of the election official."
- }
- }
- },
- "ElectionsQueryResponse": {
- "id": "ElectionsQueryResponse",
- "type": "object",
- "description": "The list of elections available for this version of the API.",
- "properties": {
- "elections": {
- "type": "array",
- "description": "A list of available elections",
- "items": {
- "$ref": "Election"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#electionsQueryResponse\".",
- "default": "civicinfo#electionsQueryResponse"
- }
- }
- },
- "ElectoralDistrict": {
- "id": "ElectoralDistrict",
- "type": "object",
- "description": "Describes the geographic scope of a contest.",
- "properties": {
- "id": {
- "type": "string",
- "description": "An identifier for this district, relative to its scope. For example, the 34th State Senate district would have id \"34\" and a scope of stateUpper."
- },
- "name": {
- "type": "string",
- "description": "The name of the district."
- },
- "scope": {
- "type": "string",
- "description": "The geographic scope of this district. If unspecified the district's geography is not known. One of: national, statewide, congressional, stateUpper, stateLower, countywide, judicial, schoolBoard, cityWide, township, countyCouncil, cityCouncil, ward, special"
- }
- }
- },
- "GeographicDivision": {
- "id": "GeographicDivision",
- "type": "object",
- "description": "Describes a political geography.",
- "properties": {
- "alsoKnownAs": {
- "type": "array",
- "description": "Any other valid OCD IDs that refer to the same division.\n\nBecause OCD IDs are meant to be human-readable and at least somewhat predictable, there are occasionally several identifiers for a single division. These identifiers are defined to be equivalent to one another, and one is always indicated as the primary identifier. The primary identifier will be returned in ocd_id above, and any other equivalent valid identifiers will be returned in this list.\n\nFor example, if this division's OCD ID is ocd-division/country:us/district:dc, this will contain ocd-division/country:us/state:dc.",
- "items": {
- "type": "string"
- }
- },
- "name": {
- "type": "string",
- "description": "The name of the division."
- },
- "officeIndices": {
- "type": "array",
- "description": "List of indices in the offices array, one for each office elected from this division. Will only be present if includeOffices was true (or absent) in the request.",
- "items": {
- "type": "integer",
- "format": "uint32"
- }
- }
- }
- },
- "Office": {
- "id": "Office",
- "type": "object",
- "description": "Information about an Office held by one or more Officials.",
- "properties": {
- "divisionId": {
- "type": "string",
- "description": "The OCD ID of the division with which this office is associated."
- },
- "levels": {
- "type": "array",
- "description": "The levels of government of which this office is part. There may be more than one in cases where a jurisdiction effectively acts at two different levels of government; for example, the mayor of the District of Columbia acts at \"locality\" level, but also effectively at both \"administrative-area-2\" and \"administrative-area-1\".",
- "items": {
- "type": "string"
- }
- },
- "name": {
- "type": "string",
- "description": "The human-readable name of the office."
- },
- "officialIndices": {
- "type": "array",
- "description": "List of indices in the officials array of people who presently hold this office.",
- "items": {
- "type": "integer",
- "format": "uint32"
- }
- },
- "roles": {
- "type": "array",
- "description": "The roles which this office fulfills. Roles are not meant to be exhaustive, or to exactly specify the entire set of responsibilities of a given office, but are meant to be rough categories that are useful for general selection from or sorting of a list of offices.",
- "items": {
- "type": "string"
- }
- },
- "sources": {
- "type": "array",
- "description": "A list of sources for this office. If multiple sources are listed, the data has been aggregated from those sources.",
- "items": {
- "$ref": "Source"
- }
- }
- }
- },
- "Official": {
- "id": "Official",
- "type": "object",
- "description": "Information about a person holding an elected office.",
- "properties": {
- "address": {
- "type": "array",
- "description": "Addresses at which to contact the official.",
- "items": {
- "$ref": "SimpleAddressType"
- }
- },
- "channels": {
- "type": "array",
- "description": "A list of known (social) media channels for this official.",
- "items": {
- "$ref": "Channel"
- }
- },
- "emails": {
- "type": "array",
- "description": "The direct email addresses for the official.",
- "items": {
- "type": "string"
- }
- },
- "name": {
- "type": "string",
- "description": "The official's name."
- },
- "party": {
- "type": "string",
- "description": "The full name of the party the official belongs to."
- },
- "phones": {
- "type": "array",
- "description": "The official's public contact phone numbers.",
- "items": {
- "type": "string"
- }
- },
- "photoUrl": {
- "type": "string",
- "description": "A URL for a photo of the official."
- },
- "urls": {
- "type": "array",
- "description": "The official's public website URLs.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "PollingLocation": {
- "id": "PollingLocation",
- "type": "object",
- "description": "A location where a voter can vote. This may be an early vote site, an election day voting location, or a drop off location for a completed ballot.",
- "properties": {
- "address": {
- "$ref": "SimpleAddressType",
- "description": "The address of the location."
- },
- "endDate": {
- "type": "string",
- "description": "The last date that this early vote site or drop off location may be used. This field is not populated for polling locations."
- },
- "id": {
- "type": "string",
- "description": "An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page."
- },
- "name": {
- "type": "string",
- "description": "The name of the early vote site or drop off location. This field is not populated for polling locations."
- },
- "notes": {
- "type": "string",
- "description": "Notes about this location (e.g. accessibility ramp or entrance to use)."
- },
- "pollingHours": {
- "type": "string",
- "description": "A description of when this location is open."
- },
- "sources": {
- "type": "array",
- "description": "A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources.",
- "items": {
- "$ref": "Source"
- }
- },
- "startDate": {
- "type": "string",
- "description": "The first date that this early vote site or drop off location may be used. This field is not populated for polling locations."
- },
- "voterServices": {
- "type": "string",
- "description": "The services provided by this early vote site or drop off location. This field is not populated for polling locations."
- }
- }
- },
- "RepresentativeInfoData": {
- "id": "RepresentativeInfoData",
- "type": "object",
- "properties": {
- "divisions": {
- "type": "object",
- "description": "Political geographic divisions that contain the requested address.",
- "additionalProperties": {
- "$ref": "GeographicDivision",
- "description": "The unique Open Civic Data identifier for this division."
- }
- },
- "offices": {
- "type": "array",
- "description": "Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.",
- "items": {
- "$ref": "Office"
- }
- },
- "officials": {
- "type": "array",
- "description": "Officials holding the offices listed above. Will only be present if includeOffices was true in the request.",
- "items": {
- "$ref": "Official"
- }
- }
- }
- },
- "RepresentativeInfoResponse": {
- "id": "RepresentativeInfoResponse",
- "type": "object",
- "description": "The result of a representative info lookup query.",
- "properties": {
- "divisions": {
- "type": "object",
- "description": "Political geographic divisions that contain the requested address.",
- "additionalProperties": {
- "$ref": "GeographicDivision",
- "description": "The unique Open Civic Data identifier for this division."
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#representativeInfoResponse\".",
- "default": "civicinfo#representativeInfoResponse"
- },
- "normalizedInput": {
- "$ref": "SimpleAddressType",
- "description": "The normalized version of the requested address"
- },
- "offices": {
- "type": "array",
- "description": "Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.",
- "items": {
- "$ref": "Office"
- }
- },
- "officials": {
- "type": "array",
- "description": "Officials holding the offices listed above. Will only be present if includeOffices was true in the request.",
- "items": {
- "$ref": "Official"
- }
- }
- }
- },
- "SimpleAddressType": {
- "id": "SimpleAddressType",
- "type": "object",
- "description": "A simple representation of an address.",
- "properties": {
- "city": {
- "type": "string",
- "description": "The city or town for the address."
- },
- "line1": {
- "type": "string",
- "description": "The street name and number of this address."
- },
- "line2": {
- "type": "string",
- "description": "The second line the address, if needed."
- },
- "line3": {
- "type": "string",
- "description": "The third line of the address, if needed."
- },
- "locationName": {
- "type": "string",
- "description": "The name of the location."
- },
- "state": {
- "type": "string",
- "description": "The US two letter state abbreviation of the address."
- },
- "zip": {
- "type": "string",
- "description": "The US Postal Zip Code of the address."
- }
- }
- },
- "Source": {
- "id": "Source",
- "type": "object",
- "description": "Contains information about the data source for the element containing it.",
- "properties": {
- "name": {
- "type": "string",
- "description": "The name of the data source."
- },
- "official": {
- "type": "boolean",
- "description": "Whether this data comes from an official government source."
- }
- }
- },
- "VoterInfoResponse": {
- "id": "VoterInfoResponse",
- "type": "object",
- "description": "The result of a voter info lookup query.",
- "properties": {
- "contests": {
- "type": "array",
- "description": "Contests that will appear on the voter's ballot.",
- "items": {
- "$ref": "Contest"
- }
- },
- "dropOffLocations": {
- "type": "array",
- "description": "Locations where a voter is eligible to drop off a completed ballot. The voter must have received and completed a ballot prior to arriving at the location. The location may not have ballots available on the premises. These locations could be open on or before election day as indicated in the pollingHours field.",
- "items": {
- "$ref": "PollingLocation"
- }
- },
- "earlyVoteSites": {
- "type": "array",
- "description": "Locations where the voter is eligible to vote early, prior to election day.",
- "items": {
- "$ref": "PollingLocation"
- }
- },
- "election": {
- "$ref": "Election",
- "description": "The election that was queried."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#voterInfoResponse\".",
- "default": "civicinfo#voterInfoResponse"
- },
- "mailOnly": {
- "type": "boolean",
- "description": "Specifies whether voters in the precinct vote only by mailing their ballots (with the possible option of dropping off their ballots as well)."
- },
- "normalizedInput": {
- "$ref": "SimpleAddressType",
- "description": "The normalized version of the requested address"
- },
- "otherElections": {
- "type": "array",
- "description": "If no election ID was specified in the query, and there was more than one election with data for the given voter, this will contain information about the other elections that could apply.",
- "items": {
- "$ref": "Election"
- }
- },
- "pollingLocations": {
- "type": "array",
- "description": "Locations where the voter is eligible to vote on election day.",
- "items": {
- "$ref": "PollingLocation"
- }
- },
- "precinctId": {
- "type": "string"
- },
- "state": {
- "type": "array",
- "description": "Local Election Information for the state that the voter votes in. For the US, there will only be one element in this array.",
- "items": {
- "$ref": "AdministrationRegion"
- }
- }
- }
- }
- },
- "resources": {
- "divisions": {
- "methods": {
- "search": {
- "id": "civicinfo.divisions.search",
- "path": "divisions",
- "httpMethod": "GET",
- "description": "Searches for political divisions by their natural name or OCD ID.",
- "parameters": {
- "query": {
- "type": "string",
- "description": "The search query. Queries can cover any parts of a OCD ID or a human readable division name. All words given in the query are treated as required patterns. In addition to that, most query operators of the Apache Lucene library are supported. See http://lucene.apache.org/core/2_9_4/queryparsersyntax.html",
- "location": "query"
- }
- },
- "response": {
- "$ref": "DivisionSearchResponse"
- }
- }
- }
- },
- "elections": {
- "methods": {
- "electionQuery": {
- "id": "civicinfo.elections.electionQuery",
- "path": "elections",
- "httpMethod": "GET",
- "description": "List of available elections to query.",
- "response": {
- "$ref": "ElectionsQueryResponse"
- }
- },
- "voterInfoQuery": {
- "id": "civicinfo.elections.voterInfoQuery",
- "path": "voterinfo",
- "httpMethod": "GET",
- "description": "Looks up information relevant to a voter based on the voter's registered address.",
- "parameters": {
- "address": {
- "type": "string",
- "description": "The registered address of the voter to look up.",
- "required": true,
- "location": "query"
- },
- "electionId": {
- "type": "string",
- "description": "The unique ID of the election to look up. A list of election IDs can be obtained at https://www.googleapis.com/civicinfo/{version}/elections",
- "default": "0",
- "format": "int64",
- "location": "query"
- },
- "officialOnly": {
- "type": "boolean",
- "description": "If set to true, only data from official state sources will be returned.",
- "default": "false",
- "location": "query"
- }
- },
- "parameterOrder": [
- "address"
- ],
- "response": {
- "$ref": "VoterInfoResponse"
- }
- }
- }
- },
- "representatives": {
- "methods": {
- "representativeInfoByAddress": {
- "id": "civicinfo.representatives.representativeInfoByAddress",
- "path": "representatives",
- "httpMethod": "GET",
- "description": "Looks up political geography and representative information for a single address.",
- "parameters": {
- "address": {
- "type": "string",
- "description": "The address to look up. May only be specified if the field ocdId is not given in the URL.",
- "location": "query"
- },
- "includeOffices": {
- "type": "boolean",
- "description": "Whether to return information about offices and officials. If false, only the top-level district information will be returned.",
- "default": "true",
- "location": "query"
- },
- "levels": {
- "type": "string",
- "description": "A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don't contain a matching office will not be returned.",
- "enum": [
- "administrativeArea1",
- "administrativeArea2",
- "country",
- "international",
- "locality",
- "regional",
- "special",
- "subLocality1",
- "subLocality2"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- },
- "roles": {
- "type": "string",
- "description": "A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don't contain a matching office will not be returned.",
- "enum": [
- "deputyHeadOfGovernment",
- "executiveCouncil",
- "governmentOfficer",
- "headOfGovernment",
- "headOfState",
- "highestCourtJudge",
- "judge",
- "legislatorLowerBody",
- "legislatorUpperBody",
- "schoolBoard",
- "specialPurposeOfficer"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- }
- },
- "response": {
- "$ref": "RepresentativeInfoResponse"
- }
- },
- "representativeInfoByDivision": {
- "id": "civicinfo.representatives.representativeInfoByDivision",
- "path": "representatives/{ocdId}",
- "httpMethod": "GET",
- "description": "Looks up representative information for a single geographic division.",
- "parameters": {
- "levels": {
- "type": "string",
- "description": "A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don't contain a matching office will not be returned.",
- "enum": [
- "administrativeArea1",
- "administrativeArea2",
- "country",
- "international",
- "locality",
- "regional",
- "special",
- "subLocality1",
- "subLocality2"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- },
- "ocdId": {
- "type": "string",
- "description": "The Open Civic Data division identifier of the division to look up.",
- "required": true,
- "location": "path"
- },
- "recursive": {
- "type": "boolean",
- "description": "If true, information about all divisions contained in the division requested will be included as well. For example, if querying ocd-division/country:us/district:dc, this would also return all DC's wards and ANCs.",
- "location": "query"
- },
- "roles": {
- "type": "string",
- "description": "A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don't contain a matching office will not be returned.",
- "enum": [
- "deputyHeadOfGovernment",
- "executiveCouncil",
- "governmentOfficer",
- "headOfGovernment",
- "headOfState",
- "highestCourtJudge",
- "judge",
- "legislatorLowerBody",
- "legislatorUpperBody",
- "schoolBoard",
- "specialPurposeOfficer"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "ocdId"
- ],
- "response": {
- "$ref": "RepresentativeInfoData"
- }
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/civicinfo/v2/civicinfo-gen.go b/vendor/google.golang.org/api/civicinfo/v2/civicinfo-gen.go
deleted file mode 100644
index a05ee35f..00000000
--- a/vendor/google.golang.org/api/civicinfo/v2/civicinfo-gen.go
+++ /dev/null
@@ -1,1868 +0,0 @@
-// Package civicinfo provides access to the Google Civic Information API.
-//
-// See https://developers.google.com/civic-information
-//
-// Usage example:
-//
-// import "google.golang.org/api/civicinfo/v2"
-// ...
-// civicinfoService, err := civicinfo.New(oauthHttpClient)
-package civicinfo // import "google.golang.org/api/civicinfo/v2"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "civicinfo:v2"
-const apiName = "civicinfo"
-const apiVersion = "v2"
-const basePath = "https://www.googleapis.com/civicinfo/v2/"
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Divisions = NewDivisionsService(s)
- s.Elections = NewElectionsService(s)
- s.Representatives = NewRepresentativesService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Divisions *DivisionsService
-
- Elections *ElectionsService
-
- Representatives *RepresentativesService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewDivisionsService(s *Service) *DivisionsService {
- rs := &DivisionsService{s: s}
- return rs
-}
-
-type DivisionsService struct {
- s *Service
-}
-
-func NewElectionsService(s *Service) *ElectionsService {
- rs := &ElectionsService{s: s}
- return rs
-}
-
-type ElectionsService struct {
- s *Service
-}
-
-func NewRepresentativesService(s *Service) *RepresentativesService {
- rs := &RepresentativesService{s: s}
- return rs
-}
-
-type RepresentativesService struct {
- s *Service
-}
-
-// AdministrationRegion: Describes information about a regional election
-// administrative area.
-type AdministrationRegion struct {
- // ElectionAdministrationBody: The election administration body for this
- // area.
- ElectionAdministrationBody *AdministrativeBody `json:"electionAdministrationBody,omitempty"`
-
- // Id: An ID for this object. IDs may change in future requests and
- // should not be cached. Access to this field requires special access
- // that can be requested from the Request more link on the Quotas page.
- Id string `json:"id,omitempty"`
-
- // LocalJurisdiction: The city or county that provides election
- // information for this voter. This object can have the same elements as
- // state.
- LocalJurisdiction *AdministrationRegion `json:"local_jurisdiction,omitempty"`
-
- // Name: The name of the jurisdiction.
- Name string `json:"name,omitempty"`
-
- // Sources: A list of sources for this area. If multiple sources are
- // listed the data has been aggregated from those sources.
- Sources []*Source `json:"sources,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "ElectionAdministrationBody") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdministrationRegion) MarshalJSON() ([]byte, error) {
- type noMethod AdministrationRegion
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdministrativeBody: Information about an election administrative body
-// (e.g. County Board of Elections).
-type AdministrativeBody struct {
- // AbsenteeVotingInfoUrl: A URL provided by this administrative body for
- // information on absentee voting.
- AbsenteeVotingInfoUrl string `json:"absenteeVotingInfoUrl,omitempty"`
-
- // BallotInfoUrl: A URL provided by this administrative body to give
- // contest information to the voter.
- BallotInfoUrl string `json:"ballotInfoUrl,omitempty"`
-
- // CorrespondenceAddress: The mailing address of this administrative
- // body.
- CorrespondenceAddress *SimpleAddressType `json:"correspondenceAddress,omitempty"`
-
- // ElectionInfoUrl: A URL provided by this administrative body for
- // looking up general election information.
- ElectionInfoUrl string `json:"electionInfoUrl,omitempty"`
-
- // ElectionOfficials: The election officials for this election
- // administrative body.
- ElectionOfficials []*ElectionOfficial `json:"electionOfficials,omitempty"`
-
- // ElectionRegistrationConfirmationUrl: A URL provided by this
- // administrative body for confirming that the voter is registered to
- // vote.
- ElectionRegistrationConfirmationUrl string `json:"electionRegistrationConfirmationUrl,omitempty"`
-
- // ElectionRegistrationUrl: A URL provided by this administrative body
- // for looking up how to register to vote.
- ElectionRegistrationUrl string `json:"electionRegistrationUrl,omitempty"`
-
- // ElectionRulesUrl: A URL provided by this administrative body
- // describing election rules to the voter.
- ElectionRulesUrl string `json:"electionRulesUrl,omitempty"`
-
- // HoursOfOperation: A description of the hours of operation for this
- // administrative body.
- HoursOfOperation string `json:"hoursOfOperation,omitempty"`
-
- // Name: The name of this election administrative body.
- Name string `json:"name,omitempty"`
-
- // PhysicalAddress: The physical address of this administrative body.
- PhysicalAddress *SimpleAddressType `json:"physicalAddress,omitempty"`
-
- // VoterServices: A description of the services this administrative body
- // may provide.
- VoterServices []string `json:"voter_services,omitempty"`
-
- // VotingLocationFinderUrl: A URL provided by this administrative body
- // for looking up where to vote.
- VotingLocationFinderUrl string `json:"votingLocationFinderUrl,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "AbsenteeVotingInfoUrl") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdministrativeBody) MarshalJSON() ([]byte, error) {
- type noMethod AdministrativeBody
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Candidate: Information about a candidate running for elected office.
-type Candidate struct {
- // CandidateUrl: The URL for the candidate's campaign web site.
- CandidateUrl string `json:"candidateUrl,omitempty"`
-
- // Channels: A list of known (social) media channels for this candidate.
- Channels []*Channel `json:"channels,omitempty"`
-
- // Email: The email address for the candidate's campaign.
- Email string `json:"email,omitempty"`
-
- // Name: The candidate's name.
- Name string `json:"name,omitempty"`
-
- // OrderOnBallot: The order the candidate appears on the ballot for this
- // contest.
- OrderOnBallot int64 `json:"orderOnBallot,omitempty,string"`
-
- // Party: The full name of the party the candidate is a member of.
- Party string `json:"party,omitempty"`
-
- // Phone: The voice phone number for the candidate's campaign office.
- Phone string `json:"phone,omitempty"`
-
- // PhotoUrl: A URL for a photo of the candidate.
- PhotoUrl string `json:"photoUrl,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CandidateUrl") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Candidate) MarshalJSON() ([]byte, error) {
- type noMethod Candidate
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Channel: A social media or web channel for a candidate.
-type Channel struct {
- // Id: The unique public identifier for the candidate's channel.
- Id string `json:"id,omitempty"`
-
- // Type: The type of channel. The following is a list of types of
- // channels, but is not exhaustive. More channel types may be added at a
- // later time. One of: GooglePlus, YouTube, Facebook, Twitter
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Channel) MarshalJSON() ([]byte, error) {
- type noMethod Channel
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Contest: Information about a contest that appears on a voter's
-// ballot.
-type Contest struct {
- // BallotPlacement: A number specifying the position of this contest on
- // the voter's ballot.
- BallotPlacement int64 `json:"ballotPlacement,omitempty,string"`
-
- // Candidates: The candidate choices for this contest.
- Candidates []*Candidate `json:"candidates,omitempty"`
-
- // District: Information about the electoral district that this contest
- // is in.
- District *ElectoralDistrict `json:"district,omitempty"`
-
- // ElectorateSpecifications: A description of any additional eligibility
- // requirements for voting in this contest.
- ElectorateSpecifications string `json:"electorateSpecifications,omitempty"`
-
- // Id: An ID for this object. IDs may change in future requests and
- // should not be cached. Access to this field requires special access
- // that can be requested from the Request more link on the Quotas page.
- Id string `json:"id,omitempty"`
-
- // Level: The levels of government of the office for this contest. There
- // may be more than one in cases where a jurisdiction effectively acts
- // at two different levels of government; for example, the mayor of the
- // District of Columbia acts at "locality" level, but also effectively
- // at both "administrative-area-2" and "administrative-area-1".
- Level []string `json:"level,omitempty"`
-
- // NumberElected: The number of candidates that will be elected to
- // office in this contest.
- NumberElected int64 `json:"numberElected,omitempty,string"`
-
- // NumberVotingFor: The number of candidates that a voter may vote for
- // in this contest.
- NumberVotingFor int64 `json:"numberVotingFor,omitempty,string"`
-
- // Office: The name of the office for this contest.
- Office string `json:"office,omitempty"`
-
- // PrimaryParty: If this is a partisan election, the name of the party
- // it is for.
- PrimaryParty string `json:"primaryParty,omitempty"`
-
- // ReferendumBallotResponses: The set of ballot responses for the
- // referendum. A ballot response represents a line on the ballot. Common
- // examples might include "yes" or "no" for referenda, or a judge's name
- // for a retention contest. This field is only populated for contests of
- // type 'Referendum'.
- ReferendumBallotResponses []string `json:"referendumBallotResponses,omitempty"`
-
- // ReferendumBrief: Specifies a short summary of the referendum that is
- // typically on the ballot below the title but above the text. This
- // field is only populated for contests of type 'Referendum'.
- ReferendumBrief string `json:"referendumBrief,omitempty"`
-
- // ReferendumConStatement: A statement in opposition to the referendum.
- // It does not necessarily appear on the ballot. This field is only
- // populated for contests of type 'Referendum'.
- ReferendumConStatement string `json:"referendumConStatement,omitempty"`
-
- // ReferendumEffectOfAbstain: Specifies what effect abstaining (not
- // voting) on the proposition will have (i.e. whether abstaining is
- // considered a vote against it). This field is only populated for
- // contests of type 'Referendum'.
- ReferendumEffectOfAbstain string `json:"referendumEffectOfAbstain,omitempty"`
-
- // ReferendumPassageThreshold: The threshold of votes that the
- // referendum needs in order to pass, e.g. "two-thirds". This field is
- // only populated for contests of type 'Referendum'.
- ReferendumPassageThreshold string `json:"referendumPassageThreshold,omitempty"`
-
- // ReferendumProStatement: A statement in favor of the referendum. It
- // does not necessarily appear on the ballot. This field is only
- // populated for contests of type 'Referendum'.
- ReferendumProStatement string `json:"referendumProStatement,omitempty"`
-
- // ReferendumSubtitle: A brief description of the referendum. This field
- // is only populated for contests of type 'Referendum'.
- ReferendumSubtitle string `json:"referendumSubtitle,omitempty"`
-
- // ReferendumText: The full text of the referendum. This field is only
- // populated for contests of type 'Referendum'.
- ReferendumText string `json:"referendumText,omitempty"`
-
- // ReferendumTitle: The title of the referendum (e.g. 'Proposition 42').
- // This field is only populated for contests of type 'Referendum'.
- ReferendumTitle string `json:"referendumTitle,omitempty"`
-
- // ReferendumUrl: A link to the referendum. This field is only populated
- // for contests of type 'Referendum'.
- ReferendumUrl string `json:"referendumUrl,omitempty"`
-
- // Roles: The roles which this office fulfills.
- Roles []string `json:"roles,omitempty"`
-
- // Sources: A list of sources for this contest. If multiple sources are
- // listed, the data has been aggregated from those sources.
- Sources []*Source `json:"sources,omitempty"`
-
- // Special: "Yes" or "No" depending on whether this a contest being held
- // outside the normal election cycle.
- Special string `json:"special,omitempty"`
-
- // Type: The type of contest. Usually this will be 'General', 'Primary',
- // or 'Run-off' for contests with candidates. For referenda this will be
- // 'Referendum'.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BallotPlacement") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Contest) MarshalJSON() ([]byte, error) {
- type noMethod Contest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DivisionSearchResponse: The result of a division search query.
-type DivisionSearchResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "civicinfo#divisionSearchResponse".
- Kind string `json:"kind,omitempty"`
-
- Results []*DivisionSearchResult `json:"results,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DivisionSearchResponse) MarshalJSON() ([]byte, error) {
- type noMethod DivisionSearchResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DivisionSearchResult: Represents a political geographic division that
-// matches the requested query.
-type DivisionSearchResult struct {
- // Aliases: Other Open Civic Data identifiers that refer to the same
- // division -- for example, those that refer to other political
- // divisions whose boundaries are defined to be coterminous with this
- // one. For example, ocd-division/country:us/state:wy will include an
- // alias of ocd-division/country:us/state:wy/cd:1, since Wyoming has
- // only one Congressional district.
- Aliases []string `json:"aliases,omitempty"`
-
- // Name: The name of the division.
- Name string `json:"name,omitempty"`
-
- // OcdId: The unique Open Civic Data identifier for this division.
- OcdId string `json:"ocdId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Aliases") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DivisionSearchResult) MarshalJSON() ([]byte, error) {
- type noMethod DivisionSearchResult
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Election: Information about the election that was queried.
-type Election struct {
- // ElectionDay: Day of the election in YYYY-MM-DD format.
- ElectionDay string `json:"electionDay,omitempty"`
-
- // Id: The unique ID of this election.
- Id int64 `json:"id,omitempty,string"`
-
- // Name: A displayable name for the election.
- Name string `json:"name,omitempty"`
-
- // OcdDivisionId: The political division of the election. Represented as
- // an OCD Division ID. Voters within these political jurisdictions are
- // covered by this election. This is typically a state such as
- // ocd-division/country:us/state:ca or for the midterms or general
- // election the entire US (i.e. ocd-division/country:us).
- OcdDivisionId string `json:"ocdDivisionId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ElectionDay") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Election) MarshalJSON() ([]byte, error) {
- type noMethod Election
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ElectionOfficial: Information about individual election officials.
-type ElectionOfficial struct {
- // EmailAddress: The email address of the election official.
- EmailAddress string `json:"emailAddress,omitempty"`
-
- // FaxNumber: The fax number of the election official.
- FaxNumber string `json:"faxNumber,omitempty"`
-
- // Name: The full name of the election official.
- Name string `json:"name,omitempty"`
-
- // OfficePhoneNumber: The office phone number of the election official.
- OfficePhoneNumber string `json:"officePhoneNumber,omitempty"`
-
- // Title: The title of the election official.
- Title string `json:"title,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "EmailAddress") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ElectionOfficial) MarshalJSON() ([]byte, error) {
- type noMethod ElectionOfficial
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ElectionsQueryResponse: The list of elections available for this
-// version of the API.
-type ElectionsQueryResponse struct {
- // Elections: A list of available elections
- Elections []*Election `json:"elections,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "civicinfo#electionsQueryResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Elections") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ElectionsQueryResponse) MarshalJSON() ([]byte, error) {
- type noMethod ElectionsQueryResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ElectoralDistrict: Describes the geographic scope of a contest.
-type ElectoralDistrict struct {
- // Id: An identifier for this district, relative to its scope. For
- // example, the 34th State Senate district would have id "34" and a
- // scope of stateUpper.
- Id string `json:"id,omitempty"`
-
- // Name: The name of the district.
- Name string `json:"name,omitempty"`
-
- // Scope: The geographic scope of this district. If unspecified the
- // district's geography is not known. One of: national, statewide,
- // congressional, stateUpper, stateLower, countywide, judicial,
- // schoolBoard, cityWide, township, countyCouncil, cityCouncil, ward,
- // special
- Scope string `json:"scope,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ElectoralDistrict) MarshalJSON() ([]byte, error) {
- type noMethod ElectoralDistrict
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// GeographicDivision: Describes a political geography.
-type GeographicDivision struct {
- // AlsoKnownAs: Any other valid OCD IDs that refer to the same
- // division.
- //
- // Because OCD IDs are meant to be human-readable and at least somewhat
- // predictable, there are occasionally several identifiers for a single
- // division. These identifiers are defined to be equivalent to one
- // another, and one is always indicated as the primary identifier. The
- // primary identifier will be returned in ocd_id above, and any other
- // equivalent valid identifiers will be returned in this list.
- //
- // For example, if this division's OCD ID is
- // ocd-division/country:us/district:dc, this will contain
- // ocd-division/country:us/state:dc.
- AlsoKnownAs []string `json:"alsoKnownAs,omitempty"`
-
- // Name: The name of the division.
- Name string `json:"name,omitempty"`
-
- // OfficeIndices: List of indices in the offices array, one for each
- // office elected from this division. Will only be present if
- // includeOffices was true (or absent) in the request.
- OfficeIndices []int64 `json:"officeIndices,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AlsoKnownAs") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GeographicDivision) MarshalJSON() ([]byte, error) {
- type noMethod GeographicDivision
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Office: Information about an Office held by one or more Officials.
-type Office struct {
- // DivisionId: The OCD ID of the division with which this office is
- // associated.
- DivisionId string `json:"divisionId,omitempty"`
-
- // Levels: The levels of government of which this office is part. There
- // may be more than one in cases where a jurisdiction effectively acts
- // at two different levels of government; for example, the mayor of the
- // District of Columbia acts at "locality" level, but also effectively
- // at both "administrative-area-2" and "administrative-area-1".
- Levels []string `json:"levels,omitempty"`
-
- // Name: The human-readable name of the office.
- Name string `json:"name,omitempty"`
-
- // OfficialIndices: List of indices in the officials array of people who
- // presently hold this office.
- OfficialIndices []int64 `json:"officialIndices,omitempty"`
-
- // Roles: The roles which this office fulfills. Roles are not meant to
- // be exhaustive, or to exactly specify the entire set of
- // responsibilities of a given office, but are meant to be rough
- // categories that are useful for general selection from or sorting of a
- // list of offices.
- Roles []string `json:"roles,omitempty"`
-
- // Sources: A list of sources for this office. If multiple sources are
- // listed, the data has been aggregated from those sources.
- Sources []*Source `json:"sources,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DivisionId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Office) MarshalJSON() ([]byte, error) {
- type noMethod Office
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Official: Information about a person holding an elected office.
-type Official struct {
- // Address: Addresses at which to contact the official.
- Address []*SimpleAddressType `json:"address,omitempty"`
-
- // Channels: A list of known (social) media channels for this official.
- Channels []*Channel `json:"channels,omitempty"`
-
- // Emails: The direct email addresses for the official.
- Emails []string `json:"emails,omitempty"`
-
- // Name: The official's name.
- Name string `json:"name,omitempty"`
-
- // Party: The full name of the party the official belongs to.
- Party string `json:"party,omitempty"`
-
- // Phones: The official's public contact phone numbers.
- Phones []string `json:"phones,omitempty"`
-
- // PhotoUrl: A URL for a photo of the official.
- PhotoUrl string `json:"photoUrl,omitempty"`
-
- // Urls: The official's public website URLs.
- Urls []string `json:"urls,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Address") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Official) MarshalJSON() ([]byte, error) {
- type noMethod Official
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PollingLocation: A location where a voter can vote. This may be an
-// early vote site, an election day voting location, or a drop off
-// location for a completed ballot.
-type PollingLocation struct {
- // Address: The address of the location.
- Address *SimpleAddressType `json:"address,omitempty"`
-
- // EndDate: The last date that this early vote site or drop off location
- // may be used. This field is not populated for polling locations.
- EndDate string `json:"endDate,omitempty"`
-
- // Id: An ID for this object. IDs may change in future requests and
- // should not be cached. Access to this field requires special access
- // that can be requested from the Request more link on the Quotas page.
- Id string `json:"id,omitempty"`
-
- // Name: The name of the early vote site or drop off location. This
- // field is not populated for polling locations.
- Name string `json:"name,omitempty"`
-
- // Notes: Notes about this location (e.g. accessibility ramp or entrance
- // to use).
- Notes string `json:"notes,omitempty"`
-
- // PollingHours: A description of when this location is open.
- PollingHours string `json:"pollingHours,omitempty"`
-
- // Sources: A list of sources for this location. If multiple sources are
- // listed the data has been aggregated from those sources.
- Sources []*Source `json:"sources,omitempty"`
-
- // StartDate: The first date that this early vote site or drop off
- // location may be used. This field is not populated for polling
- // locations.
- StartDate string `json:"startDate,omitempty"`
-
- // VoterServices: The services provided by this early vote site or drop
- // off location. This field is not populated for polling locations.
- VoterServices string `json:"voterServices,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Address") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PollingLocation) MarshalJSON() ([]byte, error) {
- type noMethod PollingLocation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type RepresentativeInfoData struct {
- // Divisions: Political geographic divisions that contain the requested
- // address.
- Divisions map[string]GeographicDivision `json:"divisions,omitempty"`
-
- // Offices: Elected offices referenced by the divisions listed above.
- // Will only be present if includeOffices was true in the request.
- Offices []*Office `json:"offices,omitempty"`
-
- // Officials: Officials holding the offices listed above. Will only be
- // present if includeOffices was true in the request.
- Officials []*Official `json:"officials,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Divisions") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RepresentativeInfoData) MarshalJSON() ([]byte, error) {
- type noMethod RepresentativeInfoData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// RepresentativeInfoResponse: The result of a representative info
-// lookup query.
-type RepresentativeInfoResponse struct {
- // Divisions: Political geographic divisions that contain the requested
- // address.
- Divisions map[string]GeographicDivision `json:"divisions,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "civicinfo#representativeInfoResponse".
- Kind string `json:"kind,omitempty"`
-
- // NormalizedInput: The normalized version of the requested address
- NormalizedInput *SimpleAddressType `json:"normalizedInput,omitempty"`
-
- // Offices: Elected offices referenced by the divisions listed above.
- // Will only be present if includeOffices was true in the request.
- Offices []*Office `json:"offices,omitempty"`
-
- // Officials: Officials holding the offices listed above. Will only be
- // present if includeOffices was true in the request.
- Officials []*Official `json:"officials,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Divisions") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RepresentativeInfoResponse) MarshalJSON() ([]byte, error) {
- type noMethod RepresentativeInfoResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SimpleAddressType: A simple representation of an address.
-type SimpleAddressType struct {
- // City: The city or town for the address.
- City string `json:"city,omitempty"`
-
- // Line1: The street name and number of this address.
- Line1 string `json:"line1,omitempty"`
-
- // Line2: The second line the address, if needed.
- Line2 string `json:"line2,omitempty"`
-
- // Line3: The third line of the address, if needed.
- Line3 string `json:"line3,omitempty"`
-
- // LocationName: The name of the location.
- LocationName string `json:"locationName,omitempty"`
-
- // State: The US two letter state abbreviation of the address.
- State string `json:"state,omitempty"`
-
- // Zip: The US Postal Zip Code of the address.
- Zip string `json:"zip,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "City") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SimpleAddressType) MarshalJSON() ([]byte, error) {
- type noMethod SimpleAddressType
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Source: Contains information about the data source for the element
-// containing it.
-type Source struct {
- // Name: The name of the data source.
- Name string `json:"name,omitempty"`
-
- // Official: Whether this data comes from an official government source.
- Official bool `json:"official,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Name") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Source) MarshalJSON() ([]byte, error) {
- type noMethod Source
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// VoterInfoResponse: The result of a voter info lookup query.
-type VoterInfoResponse struct {
- // Contests: Contests that will appear on the voter's ballot.
- Contests []*Contest `json:"contests,omitempty"`
-
- // DropOffLocations: Locations where a voter is eligible to drop off a
- // completed ballot. The voter must have received and completed a ballot
- // prior to arriving at the location. The location may not have ballots
- // available on the premises. These locations could be open on or before
- // election day as indicated in the pollingHours field.
- DropOffLocations []*PollingLocation `json:"dropOffLocations,omitempty"`
-
- // EarlyVoteSites: Locations where the voter is eligible to vote early,
- // prior to election day.
- EarlyVoteSites []*PollingLocation `json:"earlyVoteSites,omitempty"`
-
- // Election: The election that was queried.
- Election *Election `json:"election,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "civicinfo#voterInfoResponse".
- Kind string `json:"kind,omitempty"`
-
- // MailOnly: Specifies whether voters in the precinct vote only by
- // mailing their ballots (with the possible option of dropping off their
- // ballots as well).
- MailOnly bool `json:"mailOnly,omitempty"`
-
- // NormalizedInput: The normalized version of the requested address
- NormalizedInput *SimpleAddressType `json:"normalizedInput,omitempty"`
-
- // OtherElections: If no election ID was specified in the query, and
- // there was more than one election with data for the given voter, this
- // will contain information about the other elections that could apply.
- OtherElections []*Election `json:"otherElections,omitempty"`
-
- // PollingLocations: Locations where the voter is eligible to vote on
- // election day.
- PollingLocations []*PollingLocation `json:"pollingLocations,omitempty"`
-
- PrecinctId string `json:"precinctId,omitempty"`
-
- // State: Local Election Information for the state that the voter votes
- // in. For the US, there will only be one element in this array.
- State []*AdministrationRegion `json:"state,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Contests") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VoterInfoResponse) MarshalJSON() ([]byte, error) {
- type noMethod VoterInfoResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "civicinfo.divisions.search":
-
-type DivisionsSearchCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Search: Searches for political divisions by their natural name or OCD
-// ID.
-func (r *DivisionsService) Search() *DivisionsSearchCall {
- c := &DivisionsSearchCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Query sets the optional parameter "query": The search query. Queries
-// can cover any parts of a OCD ID or a human readable division name.
-// All words given in the query are treated as required patterns. In
-// addition to that, most query operators of the Apache Lucene library
-// are supported. See
-// http://lucene.apache.org/core/2_9_4/queryparsersyntax.html
-func (c *DivisionsSearchCall) Query(query string) *DivisionsSearchCall {
- c.opt_["query"] = query
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DivisionsSearchCall) Fields(s ...googleapi.Field) *DivisionsSearchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DivisionsSearchCall) IfNoneMatch(entityTag string) *DivisionsSearchCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DivisionsSearchCall) Context(ctx context.Context) *DivisionsSearchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DivisionsSearchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["query"]; ok {
- params.Set("query", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "divisions")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "civicinfo.divisions.search" call.
-// Exactly one of *DivisionSearchResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *DivisionSearchResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DivisionsSearchCall) Do() (*DivisionSearchResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DivisionSearchResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Searches for political divisions by their natural name or OCD ID.",
- // "httpMethod": "GET",
- // "id": "civicinfo.divisions.search",
- // "parameters": {
- // "query": {
- // "description": "The search query. Queries can cover any parts of a OCD ID or a human readable division name. All words given in the query are treated as required patterns. In addition to that, most query operators of the Apache Lucene library are supported. See http://lucene.apache.org/core/2_9_4/queryparsersyntax.html",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "divisions",
- // "response": {
- // "$ref": "DivisionSearchResponse"
- // }
- // }
-
-}
-
-// method id "civicinfo.elections.electionQuery":
-
-type ElectionsElectionQueryCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// ElectionQuery: List of available elections to query.
-func (r *ElectionsService) ElectionQuery() *ElectionsElectionQueryCall {
- c := &ElectionsElectionQueryCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ElectionsElectionQueryCall) Fields(s ...googleapi.Field) *ElectionsElectionQueryCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ElectionsElectionQueryCall) IfNoneMatch(entityTag string) *ElectionsElectionQueryCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ElectionsElectionQueryCall) Context(ctx context.Context) *ElectionsElectionQueryCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ElectionsElectionQueryCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "elections")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "civicinfo.elections.electionQuery" call.
-// Exactly one of *ElectionsQueryResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ElectionsQueryResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ElectionsElectionQueryCall) Do() (*ElectionsQueryResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ElectionsQueryResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List of available elections to query.",
- // "httpMethod": "GET",
- // "id": "civicinfo.elections.electionQuery",
- // "path": "elections",
- // "response": {
- // "$ref": "ElectionsQueryResponse"
- // }
- // }
-
-}
-
-// method id "civicinfo.elections.voterInfoQuery":
-
-type ElectionsVoterInfoQueryCall struct {
- s *Service
- address string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// VoterInfoQuery: Looks up information relevant to a voter based on the
-// voter's registered address.
-func (r *ElectionsService) VoterInfoQuery(address string) *ElectionsVoterInfoQueryCall {
- c := &ElectionsVoterInfoQueryCall{s: r.s, opt_: make(map[string]interface{})}
- c.address = address
- return c
-}
-
-// ElectionId sets the optional parameter "electionId": The unique ID of
-// the election to look up. A list of election IDs can be obtained at
-// https://www.googleapis.com/civicinfo/{version}/elections
-func (c *ElectionsVoterInfoQueryCall) ElectionId(electionId int64) *ElectionsVoterInfoQueryCall {
- c.opt_["electionId"] = electionId
- return c
-}
-
-// OfficialOnly sets the optional parameter "officialOnly": If set to
-// true, only data from official state sources will be returned.
-func (c *ElectionsVoterInfoQueryCall) OfficialOnly(officialOnly bool) *ElectionsVoterInfoQueryCall {
- c.opt_["officialOnly"] = officialOnly
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ElectionsVoterInfoQueryCall) Fields(s ...googleapi.Field) *ElectionsVoterInfoQueryCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ElectionsVoterInfoQueryCall) IfNoneMatch(entityTag string) *ElectionsVoterInfoQueryCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ElectionsVoterInfoQueryCall) Context(ctx context.Context) *ElectionsVoterInfoQueryCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ElectionsVoterInfoQueryCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("address", fmt.Sprintf("%v", c.address))
- if v, ok := c.opt_["electionId"]; ok {
- params.Set("electionId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["officialOnly"]; ok {
- params.Set("officialOnly", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "voterinfo")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "civicinfo.elections.voterInfoQuery" call.
-// Exactly one of *VoterInfoResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *VoterInfoResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ElectionsVoterInfoQueryCall) Do() (*VoterInfoResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &VoterInfoResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Looks up information relevant to a voter based on the voter's registered address.",
- // "httpMethod": "GET",
- // "id": "civicinfo.elections.voterInfoQuery",
- // "parameterOrder": [
- // "address"
- // ],
- // "parameters": {
- // "address": {
- // "description": "The registered address of the voter to look up.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "electionId": {
- // "default": "0",
- // "description": "The unique ID of the election to look up. A list of election IDs can be obtained at https://www.googleapis.com/civicinfo/{version}/elections",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "officialOnly": {
- // "default": "false",
- // "description": "If set to true, only data from official state sources will be returned.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "voterinfo",
- // "response": {
- // "$ref": "VoterInfoResponse"
- // }
- // }
-
-}
-
-// method id "civicinfo.representatives.representativeInfoByAddress":
-
-type RepresentativesRepresentativeInfoByAddressCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// RepresentativeInfoByAddress: Looks up political geography and
-// representative information for a single address.
-func (r *RepresentativesService) RepresentativeInfoByAddress() *RepresentativesRepresentativeInfoByAddressCall {
- c := &RepresentativesRepresentativeInfoByAddressCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Address sets the optional parameter "address": The address to look
-// up. May only be specified if the field ocdId is not given in the URL.
-func (c *RepresentativesRepresentativeInfoByAddressCall) Address(address string) *RepresentativesRepresentativeInfoByAddressCall {
- c.opt_["address"] = address
- return c
-}
-
-// IncludeOffices sets the optional parameter "includeOffices": Whether
-// to return information about offices and officials. If false, only the
-// top-level district information will be returned.
-func (c *RepresentativesRepresentativeInfoByAddressCall) IncludeOffices(includeOffices bool) *RepresentativesRepresentativeInfoByAddressCall {
- c.opt_["includeOffices"] = includeOffices
- return c
-}
-
-// Levels sets the optional parameter "levels": A list of office levels
-// to filter by. Only offices that serve at least one of these levels
-// will be returned. Divisions that don't contain a matching office will
-// not be returned.
-//
-// Possible values:
-// "administrativeArea1"
-// "administrativeArea2"
-// "country"
-// "international"
-// "locality"
-// "regional"
-// "special"
-// "subLocality1"
-// "subLocality2"
-func (c *RepresentativesRepresentativeInfoByAddressCall) Levels(levels string) *RepresentativesRepresentativeInfoByAddressCall {
- c.opt_["levels"] = levels
- return c
-}
-
-// Roles sets the optional parameter "roles": A list of office roles to
-// filter by. Only offices fulfilling one of these roles will be
-// returned. Divisions that don't contain a matching office will not be
-// returned.
-//
-// Possible values:
-// "deputyHeadOfGovernment"
-// "executiveCouncil"
-// "governmentOfficer"
-// "headOfGovernment"
-// "headOfState"
-// "highestCourtJudge"
-// "judge"
-// "legislatorLowerBody"
-// "legislatorUpperBody"
-// "schoolBoard"
-// "specialPurposeOfficer"
-func (c *RepresentativesRepresentativeInfoByAddressCall) Roles(roles string) *RepresentativesRepresentativeInfoByAddressCall {
- c.opt_["roles"] = roles
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RepresentativesRepresentativeInfoByAddressCall) Fields(s ...googleapi.Field) *RepresentativesRepresentativeInfoByAddressCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *RepresentativesRepresentativeInfoByAddressCall) IfNoneMatch(entityTag string) *RepresentativesRepresentativeInfoByAddressCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RepresentativesRepresentativeInfoByAddressCall) Context(ctx context.Context) *RepresentativesRepresentativeInfoByAddressCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RepresentativesRepresentativeInfoByAddressCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["address"]; ok {
- params.Set("address", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["includeOffices"]; ok {
- params.Set("includeOffices", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["levels"]; ok {
- params.Set("levels", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["roles"]; ok {
- params.Set("roles", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "representatives")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "civicinfo.representatives.representativeInfoByAddress" call.
-// Exactly one of *RepresentativeInfoResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *RepresentativeInfoResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *RepresentativesRepresentativeInfoByAddressCall) Do() (*RepresentativeInfoResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &RepresentativeInfoResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Looks up political geography and representative information for a single address.",
- // "httpMethod": "GET",
- // "id": "civicinfo.representatives.representativeInfoByAddress",
- // "parameters": {
- // "address": {
- // "description": "The address to look up. May only be specified if the field ocdId is not given in the URL.",
- // "location": "query",
- // "type": "string"
- // },
- // "includeOffices": {
- // "default": "true",
- // "description": "Whether to return information about offices and officials. If false, only the top-level district information will be returned.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "levels": {
- // "description": "A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don't contain a matching office will not be returned.",
- // "enum": [
- // "administrativeArea1",
- // "administrativeArea2",
- // "country",
- // "international",
- // "locality",
- // "regional",
- // "special",
- // "subLocality1",
- // "subLocality2"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "roles": {
- // "description": "A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don't contain a matching office will not be returned.",
- // "enum": [
- // "deputyHeadOfGovernment",
- // "executiveCouncil",
- // "governmentOfficer",
- // "headOfGovernment",
- // "headOfState",
- // "highestCourtJudge",
- // "judge",
- // "legislatorLowerBody",
- // "legislatorUpperBody",
- // "schoolBoard",
- // "specialPurposeOfficer"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // }
- // },
- // "path": "representatives",
- // "response": {
- // "$ref": "RepresentativeInfoResponse"
- // }
- // }
-
-}
-
-// method id "civicinfo.representatives.representativeInfoByDivision":
-
-type RepresentativesRepresentativeInfoByDivisionCall struct {
- s *Service
- ocdId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// RepresentativeInfoByDivision: Looks up representative information for
-// a single geographic division.
-func (r *RepresentativesService) RepresentativeInfoByDivision(ocdId string) *RepresentativesRepresentativeInfoByDivisionCall {
- c := &RepresentativesRepresentativeInfoByDivisionCall{s: r.s, opt_: make(map[string]interface{})}
- c.ocdId = ocdId
- return c
-}
-
-// Levels sets the optional parameter "levels": A list of office levels
-// to filter by. Only offices that serve at least one of these levels
-// will be returned. Divisions that don't contain a matching office will
-// not be returned.
-//
-// Possible values:
-// "administrativeArea1"
-// "administrativeArea2"
-// "country"
-// "international"
-// "locality"
-// "regional"
-// "special"
-// "subLocality1"
-// "subLocality2"
-func (c *RepresentativesRepresentativeInfoByDivisionCall) Levels(levels string) *RepresentativesRepresentativeInfoByDivisionCall {
- c.opt_["levels"] = levels
- return c
-}
-
-// Recursive sets the optional parameter "recursive": If true,
-// information about all divisions contained in the division requested
-// will be included as well. For example, if querying
-// ocd-division/country:us/district:dc, this would also return all DC's
-// wards and ANCs.
-func (c *RepresentativesRepresentativeInfoByDivisionCall) Recursive(recursive bool) *RepresentativesRepresentativeInfoByDivisionCall {
- c.opt_["recursive"] = recursive
- return c
-}
-
-// Roles sets the optional parameter "roles": A list of office roles to
-// filter by. Only offices fulfilling one of these roles will be
-// returned. Divisions that don't contain a matching office will not be
-// returned.
-//
-// Possible values:
-// "deputyHeadOfGovernment"
-// "executiveCouncil"
-// "governmentOfficer"
-// "headOfGovernment"
-// "headOfState"
-// "highestCourtJudge"
-// "judge"
-// "legislatorLowerBody"
-// "legislatorUpperBody"
-// "schoolBoard"
-// "specialPurposeOfficer"
-func (c *RepresentativesRepresentativeInfoByDivisionCall) Roles(roles string) *RepresentativesRepresentativeInfoByDivisionCall {
- c.opt_["roles"] = roles
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RepresentativesRepresentativeInfoByDivisionCall) Fields(s ...googleapi.Field) *RepresentativesRepresentativeInfoByDivisionCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *RepresentativesRepresentativeInfoByDivisionCall) IfNoneMatch(entityTag string) *RepresentativesRepresentativeInfoByDivisionCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RepresentativesRepresentativeInfoByDivisionCall) Context(ctx context.Context) *RepresentativesRepresentativeInfoByDivisionCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RepresentativesRepresentativeInfoByDivisionCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["levels"]; ok {
- params.Set("levels", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["recursive"]; ok {
- params.Set("recursive", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["roles"]; ok {
- params.Set("roles", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "representatives/{ocdId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "ocdId": c.ocdId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "civicinfo.representatives.representativeInfoByDivision" call.
-// Exactly one of *RepresentativeInfoData or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *RepresentativeInfoData.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *RepresentativesRepresentativeInfoByDivisionCall) Do() (*RepresentativeInfoData, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &RepresentativeInfoData{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Looks up representative information for a single geographic division.",
- // "httpMethod": "GET",
- // "id": "civicinfo.representatives.representativeInfoByDivision",
- // "parameterOrder": [
- // "ocdId"
- // ],
- // "parameters": {
- // "levels": {
- // "description": "A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don't contain a matching office will not be returned.",
- // "enum": [
- // "administrativeArea1",
- // "administrativeArea2",
- // "country",
- // "international",
- // "locality",
- // "regional",
- // "special",
- // "subLocality1",
- // "subLocality2"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "ocdId": {
- // "description": "The Open Civic Data division identifier of the division to look up.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "recursive": {
- // "description": "If true, information about all divisions contained in the division requested will be included as well. For example, if querying ocd-division/country:us/district:dc, this would also return all DC's wards and ANCs.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "roles": {
- // "description": "A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don't contain a matching office will not be returned.",
- // "enum": [
- // "deputyHeadOfGovernment",
- // "executiveCouncil",
- // "governmentOfficer",
- // "headOfGovernment",
- // "headOfState",
- // "highestCourtJudge",
- // "judge",
- // "legislatorLowerBody",
- // "legislatorUpperBody",
- // "schoolBoard",
- // "specialPurposeOfficer"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // }
- // },
- // "path": "representatives/{ocdId}",
- // "response": {
- // "$ref": "RepresentativeInfoData"
- // }
- // }
-
-}
diff --git a/vendor/google.golang.org/api/classroom/v1/classroom-api.json b/vendor/google.golang.org/api/classroom/v1/classroom-api.json
deleted file mode 100644
index 58c117f0..00000000
--- a/vendor/google.golang.org/api/classroom/v1/classroom-api.json
+++ /dev/null
@@ -1,1109 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/VbFh0P5gIX42P6rhPLVK-GI_3-Y\"",
- "discoveryVersion": "v1",
- "id": "classroom:v1",
- "name": "classroom",
- "version": "v1",
- "revision": "20151013",
- "title": "Google Classroom API",
- "description": "Google Classroom API",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/classroom/",
- "protocol": "rest",
- "baseUrl": "https://classroom.googleapis.com/",
- "basePath": "/",
- "rootUrl": "https://classroom.googleapis.com/",
- "servicePath": "",
- "batchPath": "batch",
- "parameters": {
- "access_token": {
- "type": "string",
- "description": "OAuth access token.",
- "location": "query"
- },
- "alt": {
- "type": "string",
- "description": "Data format for response.",
- "default": "json",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "bearer_token": {
- "type": "string",
- "description": "OAuth bearer token.",
- "location": "query"
- },
- "callback": {
- "type": "string",
- "description": "JSONP",
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "pp": {
- "type": "boolean",
- "description": "Pretty-print response.",
- "default": "true",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "location": "query"
- },
- "upload_protocol": {
- "type": "string",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "location": "query"
- },
- "uploadType": {
- "type": "string",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query"
- },
- "$.xgafv": {
- "type": "string",
- "description": "V1 error format.",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/classroom.courses": {
- "description": "Manage your Google Classroom classes"
- },
- "https://www.googleapis.com/auth/classroom.courses.readonly": {
- "description": "View your Google Classroom classes"
- },
- "https://www.googleapis.com/auth/classroom.profile.emails": {
- "description": "View the email addresses of people in your classes"
- },
- "https://www.googleapis.com/auth/classroom.profile.photos": {
- "description": "View the profile photos of people in your classes"
- },
- "https://www.googleapis.com/auth/classroom.rosters": {
- "description": "Manage your Google Classroom class rosters"
- },
- "https://www.googleapis.com/auth/classroom.rosters.readonly": {
- "description": "View your Google Classroom class rosters"
- }
- }
- }
- },
- "schemas": {
- "Course": {
- "id": "Course",
- "type": "object",
- "description": "A Course in Classroom.",
- "properties": {
- "id": {
- "type": "string",
- "description": "Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask will result in an error."
- },
- "name": {
- "type": "string",
- "description": "Name of the course. For example, \"10th Grade Biology\". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string."
- },
- "section": {
- "type": "string",
- "description": "Section of the course. For example, \"Period 2\". If set, this field must be a valid UTF-8 string and no longer than 2800 characters."
- },
- "descriptionHeading": {
- "type": "string",
- "description": "Optional heading for the description. For example, \"Welcome to 10th Grade Biology.\" If set, this field must be a valid UTF-8 string and no longer than 3600 characters."
- },
- "description": {
- "type": "string",
- "description": "Optional description. For example, \"We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!\" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters."
- },
- "room": {
- "type": "string",
- "description": "Optional room location. For example, \"301\". If set, this field must be a valid UTF-8 string and no longer than 650 characters."
- },
- "ownerId": {
- "type": "string",
- "description": "The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user This must be set in a create request. Specifying this field in a course update mask will result in an `INVALID_ARGUMENT` error."
- },
- "creationTime": {
- "type": "string",
- "description": "Creation time of the course. Specifying this field in a course update mask will result in an error. Read-only."
- },
- "updateTime": {
- "type": "string",
- "description": "Time of the most recent update to this course. Specifying this field in a course update mask will result in an error. Read-only."
- },
- "enrollmentCode": {
- "type": "string",
- "description": "Enrollment code to use when joining this course. Specifying this field in a course update mask will result in an error. Read-only."
- },
- "courseState": {
- "type": "string",
- "description": "State of the course. If unspecified, the default state is `PROVISIONED`.",
- "enum": [
- "COURSE_STATE_UNSPECIFIED",
- "ACTIVE",
- "ARCHIVED",
- "PROVISIONED",
- "DECLINED"
- ]
- },
- "alternateLink": {
- "type": "string",
- "description": "Absolute link to this course in the Classroom web UI. Read-only."
- }
- }
- },
- "Empty": {
- "id": "Empty",
- "type": "object",
- "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`."
- },
- "ListCoursesResponse": {
- "id": "ListCoursesResponse",
- "type": "object",
- "description": "Response when listing courses.",
- "properties": {
- "courses": {
- "type": "array",
- "description": "Courses that match the list request.",
- "items": {
- "$ref": "Course"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token identifying the next page of results to return. If empty, no further results are available."
- }
- }
- },
- "CourseAlias": {
- "id": "CourseAlias",
- "type": "object",
- "description": "Alternative identifier for a course. An alias uniquely identifies a course. It must be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return `ALREADY_EXISTS` if a previous one has succeeded.",
- "properties": {
- "alias": {
- "type": "string",
- "description": "Alias string. The format of the string indicates the desired alias scoping. * `d:` indicates a domain-scoped alias. Example: `d:math_101` * `p:` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters."
- }
- }
- },
- "ListCourseAliasesResponse": {
- "id": "ListCourseAliasesResponse",
- "type": "object",
- "description": "Response when listing course aliases.",
- "properties": {
- "aliases": {
- "type": "array",
- "description": "The course aliases.",
- "items": {
- "$ref": "CourseAlias"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token identifying the next page of results to return. If empty, no further results are available."
- }
- }
- },
- "Invitation": {
- "id": "Invitation",
- "type": "object",
- "description": "An invitation to join a course.",
- "properties": {
- "id": {
- "type": "string",
- "description": "Identifier assigned by Classroom. Read-only."
- },
- "userId": {
- "type": "string",
- "description": "Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user"
- },
- "courseId": {
- "type": "string",
- "description": "Identifier of the course to invite the user to."
- },
- "role": {
- "type": "string",
- "description": "Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.",
- "enum": [
- "COURSE_ROLE_UNSPECIFIED",
- "STUDENT",
- "TEACHER"
- ]
- }
- }
- },
- "ListInvitationsResponse": {
- "id": "ListInvitationsResponse",
- "type": "object",
- "description": "Response when listing invitations.",
- "properties": {
- "invitations": {
- "type": "array",
- "description": "Invitations that match the list request.",
- "items": {
- "$ref": "Invitation"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token identifying the next page of results to return. If empty, no further results are available."
- }
- }
- },
- "UserProfile": {
- "id": "UserProfile",
- "type": "object",
- "description": "Global information for a user.",
- "properties": {
- "id": {
- "type": "string",
- "description": "Identifier of the user. Read-only."
- },
- "name": {
- "$ref": "Name",
- "description": "Name of the user. Read-only."
- },
- "emailAddress": {
- "type": "string",
- "description": "Email address of the user. Read-only."
- },
- "photoUrl": {
- "type": "string",
- "description": "URL of user's profile photo. Read-only."
- },
- "permissions": {
- "type": "array",
- "description": "Global permissions of the user. Read-only.",
- "items": {
- "$ref": "GlobalPermission"
- }
- }
- }
- },
- "Name": {
- "id": "Name",
- "type": "object",
- "description": "Details of the user's name.",
- "properties": {
- "givenName": {
- "type": "string",
- "description": "The user's first name. Read-only."
- },
- "familyName": {
- "type": "string",
- "description": "The user's last name. Read-only."
- },
- "fullName": {
- "type": "string",
- "description": "The user's full name formed by concatenating the first and last name values. Read-only."
- }
- }
- },
- "GlobalPermission": {
- "id": "GlobalPermission",
- "type": "object",
- "description": "Global user permission description.",
- "properties": {
- "permission": {
- "type": "string",
- "description": "Permission value.",
- "enum": [
- "PERMISSION_UNSPECIFIED",
- "CREATE_COURSE"
- ]
- }
- }
- },
- "Teacher": {
- "id": "Teacher",
- "type": "object",
- "description": "Teacher of a course.",
- "properties": {
- "courseId": {
- "type": "string",
- "description": "Identifier of the course. Read-only."
- },
- "userId": {
- "type": "string",
- "description": "Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user"
- },
- "profile": {
- "$ref": "UserProfile",
- "description": "Global user information for the teacher. Read-only."
- }
- }
- },
- "ListTeachersResponse": {
- "id": "ListTeachersResponse",
- "type": "object",
- "description": "Response when listing teachers.",
- "properties": {
- "teachers": {
- "type": "array",
- "description": "Teachers who match the list request.",
- "items": {
- "$ref": "Teacher"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token identifying the next page of results to return. If empty, no further results are available."
- }
- }
- },
- "Student": {
- "id": "Student",
- "type": "object",
- "description": "Student in a course.",
- "properties": {
- "courseId": {
- "type": "string",
- "description": "Identifier of the course. Read-only."
- },
- "userId": {
- "type": "string",
- "description": "Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user"
- },
- "profile": {
- "$ref": "UserProfile",
- "description": "Global user information for the student. Read-only."
- }
- }
- },
- "ListStudentsResponse": {
- "id": "ListStudentsResponse",
- "type": "object",
- "description": "Response when listing students.",
- "properties": {
- "students": {
- "type": "array",
- "description": "Students who match the list request.",
- "items": {
- "$ref": "Student"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token identifying the next page of results to return. If empty, no further results are available."
- }
- }
- }
- },
- "resources": {
- "courses": {
- "methods": {
- "create": {
- "id": "classroom.courses.create",
- "path": "v1/courses",
- "httpMethod": "POST",
- "description": "Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.",
- "request": {
- "$ref": "Course"
- },
- "response": {
- "$ref": "Course"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ]
- },
- "get": {
- "id": "classroom.courses.get",
- "path": "v1/courses/{id}",
- "httpMethod": "GET",
- "description": "Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "response": {
- "$ref": "Course"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses",
- "https://www.googleapis.com/auth/classroom.courses.readonly"
- ]
- },
- "update": {
- "id": "classroom.courses.update",
- "path": "v1/courses/{id}",
- "httpMethod": "PUT",
- "description": "Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "request": {
- "$ref": "Course"
- },
- "response": {
- "$ref": "Course"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ]
- },
- "patch": {
- "id": "classroom.courses.patch",
- "path": "v1/courses/{id}",
- "httpMethod": "PATCH",
- "description": "Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.",
- "required": true,
- "location": "path"
- },
- "updateMask": {
- "type": "string",
- "description": "Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `name` * `section` * `descriptionHeading` * `description` * `room` * `courseState` When set in a query parameter, this field should be specified as `updateMask=,,...`",
- "location": "query"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "request": {
- "$ref": "Course"
- },
- "response": {
- "$ref": "Course"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ]
- },
- "delete": {
- "id": "classroom.courses.delete",
- "path": "v1/courses/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ]
- },
- "list": {
- "id": "classroom.courses.list",
- "path": "v1/courses",
- "httpMethod": "GET",
- "description": "Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.",
- "parameters": {
- "studentId": {
- "type": "string",
- "description": "Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
- "location": "query"
- },
- "teacherId": {
- "type": "string",
- "description": "Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
- "location": "query"
- },
- "pageSize": {
- "type": "integer",
- "description": "Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "ListCoursesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses",
- "https://www.googleapis.com/auth/classroom.courses.readonly"
- ]
- }
- },
- "resources": {
- "aliases": {
- "methods": {
- "create": {
- "id": "classroom.courses.aliases.create",
- "path": "v1/courses/{courseId}/aliases",
- "httpMethod": "POST",
- "description": "Creates an alias for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists.",
- "parameters": {
- "courseId": {
- "type": "string",
- "description": "Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "courseId"
- ],
- "request": {
- "$ref": "CourseAlias"
- },
- "response": {
- "$ref": "CourseAlias"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ]
- },
- "delete": {
- "id": "classroom.courses.aliases.delete",
- "path": "v1/courses/{courseId}/aliases/{alias}",
- "httpMethod": "DELETE",
- "description": "Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` if the alias does not exist.",
- "parameters": {
- "courseId": {
- "type": "string",
- "description": "Identifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias.",
- "required": true,
- "location": "path"
- },
- "alias": {
- "type": "string",
- "description": "Alias to delete. This may not be the Classroom-assigned identifier.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "courseId",
- "alias"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ]
- },
- "list": {
- "id": "classroom.courses.aliases.list",
- "path": "v1/courses/{courseId}/aliases",
- "httpMethod": "GET",
- "description": "Returns a list of aliases for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist.",
- "parameters": {
- "courseId": {
- "type": "string",
- "description": "The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "type": "integer",
- "description": "Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "courseId"
- ],
- "response": {
- "$ref": "ListCourseAliasesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses",
- "https://www.googleapis.com/auth/classroom.courses.readonly"
- ]
- }
- }
- },
- "teachers": {
- "methods": {
- "create": {
- "id": "classroom.courses.teachers.create",
- "path": "v1/courses/{courseId}/teachers",
- "httpMethod": "POST",
- "description": "Creates a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a teacher or student in the course.",
- "parameters": {
- "courseId": {
- "type": "string",
- "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "courseId"
- ],
- "request": {
- "$ref": "Teacher"
- },
- "response": {
- "$ref": "Teacher"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters"
- ]
- },
- "get": {
- "id": "classroom.courses.teachers.get",
- "path": "v1/courses/{courseId}/teachers/{userId}",
- "httpMethod": "GET",
- "description": "Returns a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist.",
- "parameters": {
- "courseId": {
- "type": "string",
- "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "Identifier of the teacher to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "courseId",
- "userId"
- ],
- "response": {
- "$ref": "Teacher"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ]
- },
- "delete": {
- "id": "classroom.courses.teachers.delete",
- "path": "v1/courses/{courseId}/teachers/{userId}",
- "httpMethod": "DELETE",
- "description": "Deletes a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course.",
- "parameters": {
- "courseId": {
- "type": "string",
- "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "Identifier of the teacher to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "courseId",
- "userId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ]
- },
- "list": {
- "id": "classroom.courses.teachers.list",
- "path": "v1/courses/{courseId}/teachers",
- "httpMethod": "GET",
- "description": "Returns a list of teachers of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.",
- "parameters": {
- "courseId": {
- "type": "string",
- "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "type": "integer",
- "description": "Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "courseId"
- ],
- "response": {
- "$ref": "ListTeachersResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ]
- }
- }
- },
- "students": {
- "methods": {
- "create": {
- "id": "classroom.courses.students.create",
- "path": "v1/courses/{courseId}/students",
- "httpMethod": "POST",
- "description": "Adds a user as a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a student or teacher in the course.",
- "parameters": {
- "courseId": {
- "type": "string",
- "description": "Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias.",
- "required": true,
- "location": "path"
- },
- "enrollmentCode": {
- "type": "string",
- "description": "Enrollment code of the course to create the student in. This code is required if userId corresponds to the requesting user; it may be omitted if the requesting user has administrative permissions to create students for any user.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "courseId"
- ],
- "request": {
- "$ref": "Student"
- },
- "response": {
- "$ref": "Student"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters"
- ]
- },
- "get": {
- "id": "classroom.courses.students.get",
- "path": "v1/courses/{courseId}/students/{userId}",
- "httpMethod": "GET",
- "description": "Returns a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.",
- "parameters": {
- "courseId": {
- "type": "string",
- "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "Identifier of the student to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "courseId",
- "userId"
- ],
- "response": {
- "$ref": "Student"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ]
- },
- "delete": {
- "id": "classroom.courses.students.delete",
- "path": "v1/courses/{courseId}/students/{userId}",
- "httpMethod": "DELETE",
- "description": "Deletes a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.",
- "parameters": {
- "courseId": {
- "type": "string",
- "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
- "required": true,
- "location": "path"
- },
- "userId": {
- "type": "string",
- "description": "Identifier of the student to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "courseId",
- "userId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ]
- },
- "list": {
- "id": "classroom.courses.students.list",
- "path": "v1/courses/{courseId}/students",
- "httpMethod": "GET",
- "description": "Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.",
- "parameters": {
- "courseId": {
- "type": "string",
- "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "type": "integer",
- "description": "Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "courseId"
- ],
- "response": {
- "$ref": "ListStudentsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ]
- }
- }
- }
- }
- },
- "invitations": {
- "methods": {
- "create": {
- "id": "classroom.invitations.create",
- "path": "v1/invitations",
- "httpMethod": "POST",
- "description": "Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course or for access errors. * `NOT_FOUND` if the course or the user does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled or if the user already has this role or a role with greater permissions. * `ALREADY_EXISTS` if an invitation for the specified user and course already exists.",
- "request": {
- "$ref": "Invitation"
- },
- "response": {
- "$ref": "Invitation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ]
- },
- "get": {
- "id": "classroom.invitations.get",
- "path": "v1/invitations/{id}",
- "httpMethod": "GET",
- "description": "Returns an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Identifier of the invitation to return.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "response": {
- "$ref": "Invitation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ]
- },
- "delete": {
- "id": "classroom.invitations.delete",
- "path": "v1/invitations/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Identifier of the invitation to delete.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ]
- },
- "list": {
- "id": "classroom.invitations.list",
- "path": "v1/invitations",
- "httpMethod": "GET",
- "description": "Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. *Note:* At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied. This method returns the following error codes: * `PERMISSION_DENIED` for access errors.",
- "parameters": {
- "userId": {
- "type": "string",
- "description": "Restricts returned invitations to those for a specific user. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
- "location": "query"
- },
- "courseId": {
- "type": "string",
- "description": "Restricts returned invitations to those for a course with the specified identifier.",
- "location": "query"
- },
- "pageSize": {
- "type": "integer",
- "description": "Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "ListInvitationsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ]
- },
- "accept": {
- "id": "classroom.invitations.accept",
- "path": "v1/invitations/{id}:accept",
- "httpMethod": "POST",
- "description": "Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation or for access errors. * `FAILED_PRECONDITION` for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if no invitation exists with the requested ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Identifier of the invitation to accept.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "id"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ]
- }
- }
- },
- "userProfiles": {
- "methods": {
- "get": {
- "id": "classroom.userProfiles.get",
- "path": "v1/userProfiles/{userId}",
- "httpMethod": "GET",
- "description": "Returns a user profile. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access this user profile or if no profile exists with the requested ID or for access errors.",
- "parameters": {
- "userId": {
- "type": "string",
- "description": "Identifier of the profile to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "userId"
- ],
- "response": {
- "$ref": "UserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/classroom/v1/classroom-gen.go b/vendor/google.golang.org/api/classroom/v1/classroom-gen.go
deleted file mode 100644
index 6e809d31..00000000
--- a/vendor/google.golang.org/api/classroom/v1/classroom-gen.go
+++ /dev/null
@@ -1,3849 +0,0 @@
-// Package classroom provides access to the Google Classroom API.
-//
-// See https://developers.google.com/classroom/
-//
-// Usage example:
-//
-// import "google.golang.org/api/classroom/v1"
-// ...
-// classroomService, err := classroom.New(oauthHttpClient)
-package classroom // import "google.golang.org/api/classroom/v1"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "classroom:v1"
-const apiName = "classroom"
-const apiVersion = "v1"
-const basePath = "https://classroom.googleapis.com/"
-
-// OAuth2 scopes used by this API.
-const (
- // Manage your Google Classroom classes
- ClassroomCoursesScope = "https://www.googleapis.com/auth/classroom.courses"
-
- // View your Google Classroom classes
- ClassroomCoursesReadonlyScope = "https://www.googleapis.com/auth/classroom.courses.readonly"
-
- // View the email addresses of people in your classes
- ClassroomProfileEmailsScope = "https://www.googleapis.com/auth/classroom.profile.emails"
-
- // View the profile photos of people in your classes
- ClassroomProfilePhotosScope = "https://www.googleapis.com/auth/classroom.profile.photos"
-
- // Manage your Google Classroom class rosters
- ClassroomRostersScope = "https://www.googleapis.com/auth/classroom.rosters"
-
- // View your Google Classroom class rosters
- ClassroomRostersReadonlyScope = "https://www.googleapis.com/auth/classroom.rosters.readonly"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Courses = NewCoursesService(s)
- s.Invitations = NewInvitationsService(s)
- s.UserProfiles = NewUserProfilesService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Courses *CoursesService
-
- Invitations *InvitationsService
-
- UserProfiles *UserProfilesService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewCoursesService(s *Service) *CoursesService {
- rs := &CoursesService{s: s}
- rs.Aliases = NewCoursesAliasesService(s)
- rs.Students = NewCoursesStudentsService(s)
- rs.Teachers = NewCoursesTeachersService(s)
- return rs
-}
-
-type CoursesService struct {
- s *Service
-
- Aliases *CoursesAliasesService
-
- Students *CoursesStudentsService
-
- Teachers *CoursesTeachersService
-}
-
-func NewCoursesAliasesService(s *Service) *CoursesAliasesService {
- rs := &CoursesAliasesService{s: s}
- return rs
-}
-
-type CoursesAliasesService struct {
- s *Service
-}
-
-func NewCoursesStudentsService(s *Service) *CoursesStudentsService {
- rs := &CoursesStudentsService{s: s}
- return rs
-}
-
-type CoursesStudentsService struct {
- s *Service
-}
-
-func NewCoursesTeachersService(s *Service) *CoursesTeachersService {
- rs := &CoursesTeachersService{s: s}
- return rs
-}
-
-type CoursesTeachersService struct {
- s *Service
-}
-
-func NewInvitationsService(s *Service) *InvitationsService {
- rs := &InvitationsService{s: s}
- return rs
-}
-
-type InvitationsService struct {
- s *Service
-}
-
-func NewUserProfilesService(s *Service) *UserProfilesService {
- rs := &UserProfilesService{s: s}
- return rs
-}
-
-type UserProfilesService struct {
- s *Service
-}
-
-// Course: A Course in Classroom.
-type Course struct {
- // AlternateLink: Absolute link to this course in the Classroom web UI.
- // Read-only.
- AlternateLink string `json:"alternateLink,omitempty"`
-
- // CourseState: State of the course. If unspecified, the default state
- // is `PROVISIONED`.
- //
- // Possible values:
- // "COURSE_STATE_UNSPECIFIED"
- // "ACTIVE"
- // "ARCHIVED"
- // "PROVISIONED"
- // "DECLINED"
- CourseState string `json:"courseState,omitempty"`
-
- // CreationTime: Creation time of the course. Specifying this field in a
- // course update mask will result in an error. Read-only.
- CreationTime string `json:"creationTime,omitempty"`
-
- // Description: Optional description. For example, "We'll be learning
- // about the structure of living creatures from a combination of
- // textbooks, guest lectures, and lab work. Expect to be excited!" If
- // set, this field must be a valid UTF-8 string and no longer than
- // 30,000 characters.
- Description string `json:"description,omitempty"`
-
- // DescriptionHeading: Optional heading for the description. For
- // example, "Welcome to 10th Grade Biology." If set, this field must be
- // a valid UTF-8 string and no longer than 3600 characters.
- DescriptionHeading string `json:"descriptionHeading,omitempty"`
-
- // EnrollmentCode: Enrollment code to use when joining this course.
- // Specifying this field in a course update mask will result in an
- // error. Read-only.
- EnrollmentCode string `json:"enrollmentCode,omitempty"`
-
- // Id: Identifier for this course assigned by Classroom. When creating a
- // course, you may optionally set this identifier to an alias string in
- // the request to create a corresponding alias. The `id` is still
- // assigned by Classroom and cannot be updated after the course is
- // created. Specifying this field in a course update mask will result in
- // an error.
- Id string `json:"id,omitempty"`
-
- // Name: Name of the course. For example, "10th Grade Biology". The name
- // is required. It must be between 1 and 750 characters and a valid
- // UTF-8 string.
- Name string `json:"name,omitempty"`
-
- // OwnerId: The identifier of the owner of a course. When specified as a
- // parameter of a create course request, this field is required. The
- // identifier can be one of the following: * the numeric identifier for
- // the user * the email address of the user * the string literal "me",
- // indicating the requesting user This must be set in a create request.
- // Specifying this field in a course update mask will result in an
- // `INVALID_ARGUMENT` error.
- OwnerId string `json:"ownerId,omitempty"`
-
- // Room: Optional room location. For example, "301". If set, this field
- // must be a valid UTF-8 string and no longer than 650 characters.
- Room string `json:"room,omitempty"`
-
- // Section: Section of the course. For example, "Period 2". If set, this
- // field must be a valid UTF-8 string and no longer than 2800
- // characters.
- Section string `json:"section,omitempty"`
-
- // UpdateTime: Time of the most recent update to this course. Specifying
- // this field in a course update mask will result in an error.
- // Read-only.
- UpdateTime string `json:"updateTime,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AlternateLink") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Course) MarshalJSON() ([]byte, error) {
- type noMethod Course
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CourseAlias: Alternative identifier for a course. An alias uniquely
-// identifies a course. It must be unique within one of the following
-// scopes: * domain: A domain-scoped alias is visible to all users
-// within the alias creator's domain and can be created only by a domain
-// admin. A domain-scoped alias is often used when a course has an
-// identifier external to Classroom. * project: A project-scoped alias
-// is visible to any request from an application using the Developer
-// Console project ID that created the alias and can be created by any
-// project. A project-scoped alias is often used when an application has
-// alternative identifiers. A random value can also be used to avoid
-// duplicate courses in the event of transmission failures, as retrying
-// a request will return `ALREADY_EXISTS` if a previous one has
-// succeeded.
-type CourseAlias struct {
- // Alias: Alias string. The format of the string indicates the desired
- // alias scoping. * `d:` indicates a domain-scoped alias. Example:
- // `d:math_101` * `p:` indicates a project-scoped alias. Example:
- // `p:abc123` This field has a maximum length of 256 characters.
- Alias string `json:"alias,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Alias") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CourseAlias) MarshalJSON() ([]byte, error) {
- type noMethod CourseAlias
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Empty: A generic empty message that you can re-use to avoid defining
-// duplicated empty messages in your APIs. A typical example is to use
-// it as the request or the response type of an API method. For
-// instance: service Foo { rpc Bar(google.protobuf.Empty) returns
-// (google.protobuf.Empty); } The JSON representation for `Empty` is
-// empty JSON object `{}`.
-type Empty struct {
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-}
-
-// GlobalPermission: Global user permission description.
-type GlobalPermission struct {
- // Permission: Permission value.
- //
- // Possible values:
- // "PERMISSION_UNSPECIFIED"
- // "CREATE_COURSE"
- Permission string `json:"permission,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Permission") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GlobalPermission) MarshalJSON() ([]byte, error) {
- type noMethod GlobalPermission
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Invitation: An invitation to join a course.
-type Invitation struct {
- // CourseId: Identifier of the course to invite the user to.
- CourseId string `json:"courseId,omitempty"`
-
- // Id: Identifier assigned by Classroom. Read-only.
- Id string `json:"id,omitempty"`
-
- // Role: Role to invite the user to have. Must not be
- // `COURSE_ROLE_UNSPECIFIED`.
- //
- // Possible values:
- // "COURSE_ROLE_UNSPECIFIED"
- // "STUDENT"
- // "TEACHER"
- Role string `json:"role,omitempty"`
-
- // UserId: Identifier of the invited user. When specified as a parameter
- // of a request, this identifier can be set to one of the following: *
- // the numeric identifier for the user * the email address of the user *
- // the string literal "me", indicating the requesting user
- UserId string `json:"userId,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CourseId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Invitation) MarshalJSON() ([]byte, error) {
- type noMethod Invitation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListCourseAliasesResponse: Response when listing course aliases.
-type ListCourseAliasesResponse struct {
- // Aliases: The course aliases.
- Aliases []*CourseAlias `json:"aliases,omitempty"`
-
- // NextPageToken: Token identifying the next page of results to return.
- // If empty, no further results are available.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Aliases") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListCourseAliasesResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListCourseAliasesResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListCoursesResponse: Response when listing courses.
-type ListCoursesResponse struct {
- // Courses: Courses that match the list request.
- Courses []*Course `json:"courses,omitempty"`
-
- // NextPageToken: Token identifying the next page of results to return.
- // If empty, no further results are available.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Courses") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListCoursesResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListCoursesResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListInvitationsResponse: Response when listing invitations.
-type ListInvitationsResponse struct {
- // Invitations: Invitations that match the list request.
- Invitations []*Invitation `json:"invitations,omitempty"`
-
- // NextPageToken: Token identifying the next page of results to return.
- // If empty, no further results are available.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Invitations") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListInvitationsResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListInvitationsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListStudentsResponse: Response when listing students.
-type ListStudentsResponse struct {
- // NextPageToken: Token identifying the next page of results to return.
- // If empty, no further results are available.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Students: Students who match the list request.
- Students []*Student `json:"students,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "NextPageToken") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListStudentsResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListStudentsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListTeachersResponse: Response when listing teachers.
-type ListTeachersResponse struct {
- // NextPageToken: Token identifying the next page of results to return.
- // If empty, no further results are available.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Teachers: Teachers who match the list request.
- Teachers []*Teacher `json:"teachers,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "NextPageToken") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListTeachersResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListTeachersResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Name: Details of the user's name.
-type Name struct {
- // FamilyName: The user's last name. Read-only.
- FamilyName string `json:"familyName,omitempty"`
-
- // FullName: The user's full name formed by concatenating the first and
- // last name values. Read-only.
- FullName string `json:"fullName,omitempty"`
-
- // GivenName: The user's first name. Read-only.
- GivenName string `json:"givenName,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "FamilyName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Name) MarshalJSON() ([]byte, error) {
- type noMethod Name
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Student: Student in a course.
-type Student struct {
- // CourseId: Identifier of the course. Read-only.
- CourseId string `json:"courseId,omitempty"`
-
- // Profile: Global user information for the student. Read-only.
- Profile *UserProfile `json:"profile,omitempty"`
-
- // UserId: Identifier of the user. When specified as a parameter of a
- // request, this identifier can be one of the following: * the numeric
- // identifier for the user * the email address of the user * the string
- // literal "me", indicating the requesting user
- UserId string `json:"userId,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CourseId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Student) MarshalJSON() ([]byte, error) {
- type noMethod Student
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Teacher: Teacher of a course.
-type Teacher struct {
- // CourseId: Identifier of the course. Read-only.
- CourseId string `json:"courseId,omitempty"`
-
- // Profile: Global user information for the teacher. Read-only.
- Profile *UserProfile `json:"profile,omitempty"`
-
- // UserId: Identifier of the user. When specified as a parameter of a
- // request, this identifier can be one of the following: * the numeric
- // identifier for the user * the email address of the user * the string
- // literal "me", indicating the requesting user
- UserId string `json:"userId,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CourseId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Teacher) MarshalJSON() ([]byte, error) {
- type noMethod Teacher
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserProfile: Global information for a user.
-type UserProfile struct {
- // EmailAddress: Email address of the user. Read-only.
- EmailAddress string `json:"emailAddress,omitempty"`
-
- // Id: Identifier of the user. Read-only.
- Id string `json:"id,omitempty"`
-
- // Name: Name of the user. Read-only.
- Name *Name `json:"name,omitempty"`
-
- // Permissions: Global permissions of the user. Read-only.
- Permissions []*GlobalPermission `json:"permissions,omitempty"`
-
- // PhotoUrl: URL of user's profile photo. Read-only.
- PhotoUrl string `json:"photoUrl,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "EmailAddress") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserProfile) MarshalJSON() ([]byte, error) {
- type noMethod UserProfile
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "classroom.courses.create":
-
-type CoursesCreateCall struct {
- s *Service
- course *Course
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Create: Creates a course. The user specified in `ownerId` is the
-// owner of the created course and added as a teacher. This method
-// returns the following error codes: * `PERMISSION_DENIED` if the
-// requesting user is not permitted to create courses or for access
-// errors. * `NOT_FOUND` if the primary teacher is not a valid user. *
-// `FAILED_PRECONDITION` if the course owner's account is disabled or
-// for the following request errors: * UserGroupsMembershipLimitReached
-// * `ALREADY_EXISTS` if an alias was specified in the `id` and already
-// exists.
-func (r *CoursesService) Create(course *Course) *CoursesCreateCall {
- c := &CoursesCreateCall{s: r.s, opt_: make(map[string]interface{})}
- c.course = course
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CoursesCreateCall) Fields(s ...googleapi.Field) *CoursesCreateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CoursesCreateCall) Context(ctx context.Context) *CoursesCreateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CoursesCreateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.course)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/courses")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "classroom.courses.create" call.
-// Exactly one of *Course or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Course.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *CoursesCreateCall) Do() (*Course, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Course{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.",
- // "httpMethod": "POST",
- // "id": "classroom.courses.create",
- // "path": "v1/courses",
- // "request": {
- // "$ref": "Course"
- // },
- // "response": {
- // "$ref": "Course"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/classroom.courses"
- // ]
- // }
-
-}
-
-// method id "classroom.courses.delete":
-
-type CoursesDeleteCall struct {
- s *Service
- id string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes a course. This method returns the following error
-// codes: * `PERMISSION_DENIED` if the requesting user is not permitted
-// to delete the requested course or for access errors. * `NOT_FOUND` if
-// no course exists with the requested ID.
-func (r *CoursesService) Delete(id string) *CoursesDeleteCall {
- c := &CoursesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CoursesDeleteCall) Fields(s ...googleapi.Field) *CoursesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CoursesDeleteCall) Context(ctx context.Context) *CoursesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CoursesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/courses/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "id": c.id,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "classroom.courses.delete" call.
-// Exactly one of *Empty or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Empty.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *CoursesDeleteCall) Do() (*Empty, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Empty{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.",
- // "httpMethod": "DELETE",
- // "id": "classroom.courses.delete",
- // "parameterOrder": [
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1/courses/{id}",
- // "response": {
- // "$ref": "Empty"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/classroom.courses"
- // ]
- // }
-
-}
-
-// method id "classroom.courses.get":
-
-type CoursesGetCall struct {
- s *Service
- id string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns a course. This method returns the following error codes:
-// * `PERMISSION_DENIED` if the requesting user is not permitted to
-// access the requested course or for access errors. * `NOT_FOUND` if no
-// course exists with the requested ID.
-func (r *CoursesService) Get(id string) *CoursesGetCall {
- c := &CoursesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CoursesGetCall) Fields(s ...googleapi.Field) *CoursesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CoursesGetCall) IfNoneMatch(entityTag string) *CoursesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CoursesGetCall) Context(ctx context.Context) *CoursesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CoursesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/courses/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "id": c.id,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "classroom.courses.get" call.
-// Exactly one of *Course or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Course.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *CoursesGetCall) Do() (*Course, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Course{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.",
- // "httpMethod": "GET",
- // "id": "classroom.courses.get",
- // "parameterOrder": [
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1/courses/{id}",
- // "response": {
- // "$ref": "Course"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/classroom.courses",
- // "https://www.googleapis.com/auth/classroom.courses.readonly"
- // ]
- // }
-
-}
-
-// method id "classroom.courses.list":
-
-type CoursesListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Returns a list of courses that the requesting user is permitted
-// to view, restricted to those that match the request. This method
-// returns the following error codes: * `PERMISSION_DENIED` for access
-// errors. * `INVALID_ARGUMENT` if the query argument is malformed. *
-// `NOT_FOUND` if any users specified in the query arguments do not
-// exist.
-func (r *CoursesService) List() *CoursesListCall {
- c := &CoursesListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// PageSize sets the optional parameter "pageSize": Maximum number of
-// items to return. Zero or unspecified indicates that the server may
-// assign a maximum. The server may return fewer than the specified
-// number of results.
-func (c *CoursesListCall) PageSize(pageSize int64) *CoursesListCall {
- c.opt_["pageSize"] = pageSize
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": nextPageToken
-// value returned from a previous list call, indicating that the
-// subsequent page of results should be returned. The list request must
-// be otherwise identical to the one that resulted in this token.
-func (c *CoursesListCall) PageToken(pageToken string) *CoursesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// StudentId sets the optional parameter "studentId": Restricts returned
-// courses to those having a student with the specified identifier. The
-// identifier can be one of the following: * the numeric identifier for
-// the user * the email address of the user * the string literal "me",
-// indicating the requesting user
-func (c *CoursesListCall) StudentId(studentId string) *CoursesListCall {
- c.opt_["studentId"] = studentId
- return c
-}
-
-// TeacherId sets the optional parameter "teacherId": Restricts returned
-// courses to those having a teacher with the specified identifier. The
-// identifier can be one of the following: * the numeric identifier for
-// the user * the email address of the user * the string literal "me",
-// indicating the requesting user
-func (c *CoursesListCall) TeacherId(teacherId string) *CoursesListCall {
- c.opt_["teacherId"] = teacherId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CoursesListCall) Fields(s ...googleapi.Field) *CoursesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CoursesListCall) IfNoneMatch(entityTag string) *CoursesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CoursesListCall) Context(ctx context.Context) *CoursesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CoursesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["pageSize"]; ok {
- params.Set("pageSize", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["studentId"]; ok {
- params.Set("studentId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["teacherId"]; ok {
- params.Set("teacherId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/courses")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "classroom.courses.list" call.
-// Exactly one of *ListCoursesResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ListCoursesResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CoursesListCall) Do() (*ListCoursesResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ListCoursesResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.",
- // "httpMethod": "GET",
- // "id": "classroom.courses.list",
- // "parameters": {
- // "pageSize": {
- // "description": "Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.",
- // "location": "query",
- // "type": "string"
- // },
- // "studentId": {
- // "description": "Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
- // "location": "query",
- // "type": "string"
- // },
- // "teacherId": {
- // "description": "Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "v1/courses",
- // "response": {
- // "$ref": "ListCoursesResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/classroom.courses",
- // "https://www.googleapis.com/auth/classroom.courses.readonly"
- // ]
- // }
-
-}
-
-// method id "classroom.courses.patch":
-
-type CoursesPatchCall struct {
- s *Service
- id string
- course *Course
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates one or more fields in a course. This method returns
-// the following error codes: * `PERMISSION_DENIED` if the requesting
-// user is not permitted to modify the requested course or for access
-// errors. * `NOT_FOUND` if no course exists with the requested ID. *
-// `INVALID_ARGUMENT` if invalid fields are specified in the update mask
-// or if no update mask is supplied. * `FAILED_PRECONDITION` for the
-// following request errors: * CourseNotModifiable
-func (r *CoursesService) Patch(id string, course *Course) *CoursesPatchCall {
- c := &CoursesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.id = id
- c.course = course
- return c
-}
-
-// UpdateMask sets the optional parameter "updateMask": Mask that
-// identifies which fields on the course to update. This field is
-// required to do an update. The update will fail if invalid fields are
-// specified. The following fields are valid: * `name` * `section` *
-// `descriptionHeading` * `description` * `room` * `courseState` When
-// set in a query parameter, this field should be specified as
-// `updateMask=,,...`
-func (c *CoursesPatchCall) UpdateMask(updateMask string) *CoursesPatchCall {
- c.opt_["updateMask"] = updateMask
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CoursesPatchCall) Fields(s ...googleapi.Field) *CoursesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CoursesPatchCall) Context(ctx context.Context) *CoursesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CoursesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.course)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["updateMask"]; ok {
- params.Set("updateMask", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/courses/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "id": c.id,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "classroom.courses.patch" call.
-// Exactly one of *Course or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Course.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *CoursesPatchCall) Do() (*Course, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Course{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable",
- // "httpMethod": "PATCH",
- // "id": "classroom.courses.patch",
- // "parameterOrder": [
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "updateMask": {
- // "description": "Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `name` * `section` * `descriptionHeading` * `description` * `room` * `courseState` When set in a query parameter, this field should be specified as `updateMask=,,...`",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "v1/courses/{id}",
- // "request": {
- // "$ref": "Course"
- // },
- // "response": {
- // "$ref": "Course"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/classroom.courses"
- // ]
- // }
-
-}
-
-// method id "classroom.courses.update":
-
-type CoursesUpdateCall struct {
- s *Service
- id string
- course *Course
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates a course. This method returns the following error
-// codes: * `PERMISSION_DENIED` if the requesting user is not permitted
-// to modify the requested course or for access errors. * `NOT_FOUND` if
-// no course exists with the requested ID. * `FAILED_PRECONDITION` for
-// the following request errors: * CourseNotModifiable
-func (r *CoursesService) Update(id string, course *Course) *CoursesUpdateCall {
- c := &CoursesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.id = id
- c.course = course
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CoursesUpdateCall) Fields(s ...googleapi.Field) *CoursesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CoursesUpdateCall) Context(ctx context.Context) *CoursesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CoursesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.course)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/courses/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "id": c.id,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "classroom.courses.update" call.
-// Exactly one of *Course or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Course.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *CoursesUpdateCall) Do() (*Course, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Course{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable",
- // "httpMethod": "PUT",
- // "id": "classroom.courses.update",
- // "parameterOrder": [
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1/courses/{id}",
- // "request": {
- // "$ref": "Course"
- // },
- // "response": {
- // "$ref": "Course"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/classroom.courses"
- // ]
- // }
-
-}
-
-// method id "classroom.courses.aliases.create":
-
-type CoursesAliasesCreateCall struct {
- s *Service
- courseId string
- coursealias *CourseAlias
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Create: Creates an alias for a course. This method returns the
-// following error codes: * `PERMISSION_DENIED` if the requesting user
-// is not permitted to create the alias or for access errors. *
-// `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the
-// alias already exists.
-func (r *CoursesAliasesService) Create(courseId string, coursealias *CourseAlias) *CoursesAliasesCreateCall {
- c := &CoursesAliasesCreateCall{s: r.s, opt_: make(map[string]interface{})}
- c.courseId = courseId
- c.coursealias = coursealias
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CoursesAliasesCreateCall) Fields(s ...googleapi.Field) *CoursesAliasesCreateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CoursesAliasesCreateCall) Context(ctx context.Context) *CoursesAliasesCreateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CoursesAliasesCreateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.coursealias)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/courses/{courseId}/aliases")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "courseId": c.courseId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "classroom.courses.aliases.create" call.
-// Exactly one of *CourseAlias or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CourseAlias.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CoursesAliasesCreateCall) Do() (*CourseAlias, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CourseAlias{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates an alias for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists.",
- // "httpMethod": "POST",
- // "id": "classroom.courses.aliases.create",
- // "parameterOrder": [
- // "courseId"
- // ],
- // "parameters": {
- // "courseId": {
- // "description": "Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1/courses/{courseId}/aliases",
- // "request": {
- // "$ref": "CourseAlias"
- // },
- // "response": {
- // "$ref": "CourseAlias"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/classroom.courses"
- // ]
- // }
-
-}
-
-// method id "classroom.courses.aliases.delete":
-
-type CoursesAliasesDeleteCall struct {
- s *Service
- courseId string
- aliasid string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an alias of a course. This method returns the
-// following error codes: * `PERMISSION_DENIED` if the requesting user
-// is not permitted to remove the alias or for access errors. *
-// `NOT_FOUND` if the alias does not exist.
-func (r *CoursesAliasesService) Delete(courseId string, aliasid string) *CoursesAliasesDeleteCall {
- c := &CoursesAliasesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.courseId = courseId
- c.aliasid = aliasid
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CoursesAliasesDeleteCall) Fields(s ...googleapi.Field) *CoursesAliasesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CoursesAliasesDeleteCall) Context(ctx context.Context) *CoursesAliasesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CoursesAliasesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/courses/{courseId}/aliases/{alias}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "courseId": c.courseId,
- "alias": c.aliasid,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "classroom.courses.aliases.delete" call.
-// Exactly one of *Empty or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Empty.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *CoursesAliasesDeleteCall) Do() (*Empty, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Empty{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` if the alias does not exist.",
- // "httpMethod": "DELETE",
- // "id": "classroom.courses.aliases.delete",
- // "parameterOrder": [
- // "courseId",
- // "alias"
- // ],
- // "parameters": {
- // "alias": {
- // "description": "Alias to delete. This may not be the Classroom-assigned identifier.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "courseId": {
- // "description": "Identifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1/courses/{courseId}/aliases/{alias}",
- // "response": {
- // "$ref": "Empty"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/classroom.courses"
- // ]
- // }
-
-}
-
-// method id "classroom.courses.aliases.list":
-
-type CoursesAliasesListCall struct {
- s *Service
- courseId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Returns a list of aliases for a course. This method returns the
-// following error codes: * `PERMISSION_DENIED` if the requesting user
-// is not permitted to access the course or for access errors. *
-// `NOT_FOUND` if the course does not exist.
-func (r *CoursesAliasesService) List(courseId string) *CoursesAliasesListCall {
- c := &CoursesAliasesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.courseId = courseId
- return c
-}
-
-// PageSize sets the optional parameter "pageSize": Maximum number of
-// items to return. Zero or unspecified indicates that the server may
-// assign a maximum. The server may return fewer than the specified
-// number of results.
-func (c *CoursesAliasesListCall) PageSize(pageSize int64) *CoursesAliasesListCall {
- c.opt_["pageSize"] = pageSize
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": nextPageToken
-// value returned from a previous list call, indicating that the
-// subsequent page of results should be returned. The list request must
-// be otherwise identical to the one that resulted in this token.
-func (c *CoursesAliasesListCall) PageToken(pageToken string) *CoursesAliasesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CoursesAliasesListCall) Fields(s ...googleapi.Field) *CoursesAliasesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CoursesAliasesListCall) IfNoneMatch(entityTag string) *CoursesAliasesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CoursesAliasesListCall) Context(ctx context.Context) *CoursesAliasesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CoursesAliasesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["pageSize"]; ok {
- params.Set("pageSize", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/courses/{courseId}/aliases")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "courseId": c.courseId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "classroom.courses.aliases.list" call.
-// Exactly one of *ListCourseAliasesResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *ListCourseAliasesResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CoursesAliasesListCall) Do() (*ListCourseAliasesResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ListCourseAliasesResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns a list of aliases for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist.",
- // "httpMethod": "GET",
- // "id": "classroom.courses.aliases.list",
- // "parameterOrder": [
- // "courseId"
- // ],
- // "parameters": {
- // "courseId": {
- // "description": "The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "pageSize": {
- // "description": "Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "v1/courses/{courseId}/aliases",
- // "response": {
- // "$ref": "ListCourseAliasesResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/classroom.courses",
- // "https://www.googleapis.com/auth/classroom.courses.readonly"
- // ]
- // }
-
-}
-
-// method id "classroom.courses.students.create":
-
-type CoursesStudentsCreateCall struct {
- s *Service
- courseId string
- student *Student
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Create: Adds a user as a student of a course. This method returns the
-// following error codes: * `PERMISSION_DENIED` if the requesting user
-// is not permitted to create students in this course or for access
-// errors. * `NOT_FOUND` if the requested course ID does not exist. *
-// `FAILED_PRECONDITION` if the requested user's account is disabled,
-// for the following request errors: * CourseMemberLimitReached *
-// CourseNotModifiable * UserGroupsMembershipLimitReached *
-// `ALREADY_EXISTS` if the user is already a student or teacher in the
-// course.
-func (r *CoursesStudentsService) Create(courseId string, student *Student) *CoursesStudentsCreateCall {
- c := &CoursesStudentsCreateCall{s: r.s, opt_: make(map[string]interface{})}
- c.courseId = courseId
- c.student = student
- return c
-}
-
-// EnrollmentCode sets the optional parameter "enrollmentCode":
-// Enrollment code of the course to create the student in. This code is
-// required if userId corresponds to the requesting user; it may be
-// omitted if the requesting user has administrative permissions to
-// create students for any user.
-func (c *CoursesStudentsCreateCall) EnrollmentCode(enrollmentCode string) *CoursesStudentsCreateCall {
- c.opt_["enrollmentCode"] = enrollmentCode
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CoursesStudentsCreateCall) Fields(s ...googleapi.Field) *CoursesStudentsCreateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CoursesStudentsCreateCall) Context(ctx context.Context) *CoursesStudentsCreateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CoursesStudentsCreateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.student)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["enrollmentCode"]; ok {
- params.Set("enrollmentCode", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/courses/{courseId}/students")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "courseId": c.courseId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "classroom.courses.students.create" call.
-// Exactly one of *Student or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Student.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *CoursesStudentsCreateCall) Do() (*Student, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Student{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Adds a user as a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a student or teacher in the course.",
- // "httpMethod": "POST",
- // "id": "classroom.courses.students.create",
- // "parameterOrder": [
- // "courseId"
- // ],
- // "parameters": {
- // "courseId": {
- // "description": "Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "enrollmentCode": {
- // "description": "Enrollment code of the course to create the student in. This code is required if userId corresponds to the requesting user; it may be omitted if the requesting user has administrative permissions to create students for any user.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "v1/courses/{courseId}/students",
- // "request": {
- // "$ref": "Student"
- // },
- // "response": {
- // "$ref": "Student"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/classroom.profile.emails",
- // "https://www.googleapis.com/auth/classroom.profile.photos",
- // "https://www.googleapis.com/auth/classroom.rosters"
- // ]
- // }
-
-}
-
-// method id "classroom.courses.students.delete":
-
-type CoursesStudentsDeleteCall struct {
- s *Service
- courseId string
- userId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes a student of a course. This method returns the
-// following error codes: * `PERMISSION_DENIED` if the requesting user
-// is not permitted to delete students of this course or for access
-// errors. * `NOT_FOUND` if no student of this course has the requested
-// ID or if the course does not exist.
-func (r *CoursesStudentsService) Delete(courseId string, userId string) *CoursesStudentsDeleteCall {
- c := &CoursesStudentsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.courseId = courseId
- c.userId = userId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CoursesStudentsDeleteCall) Fields(s ...googleapi.Field) *CoursesStudentsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CoursesStudentsDeleteCall) Context(ctx context.Context) *CoursesStudentsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CoursesStudentsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/courses/{courseId}/students/{userId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "courseId": c.courseId,
- "userId": c.userId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "classroom.courses.students.delete" call.
-// Exactly one of *Empty or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Empty.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *CoursesStudentsDeleteCall) Do() (*Empty, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Empty{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.",
- // "httpMethod": "DELETE",
- // "id": "classroom.courses.students.delete",
- // "parameterOrder": [
- // "courseId",
- // "userId"
- // ],
- // "parameters": {
- // "courseId": {
- // "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userId": {
- // "description": "Identifier of the student to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1/courses/{courseId}/students/{userId}",
- // "response": {
- // "$ref": "Empty"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/classroom.rosters"
- // ]
- // }
-
-}
-
-// method id "classroom.courses.students.get":
-
-type CoursesStudentsGetCall struct {
- s *Service
- courseId string
- userId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns a student of a course. This method returns the following
-// error codes: * `PERMISSION_DENIED` if the requesting user is not
-// permitted to view students of this course or for access errors. *
-// `NOT_FOUND` if no student of this course has the requested ID or if
-// the course does not exist.
-func (r *CoursesStudentsService) Get(courseId string, userId string) *CoursesStudentsGetCall {
- c := &CoursesStudentsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.courseId = courseId
- c.userId = userId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CoursesStudentsGetCall) Fields(s ...googleapi.Field) *CoursesStudentsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CoursesStudentsGetCall) IfNoneMatch(entityTag string) *CoursesStudentsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CoursesStudentsGetCall) Context(ctx context.Context) *CoursesStudentsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CoursesStudentsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/courses/{courseId}/students/{userId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "courseId": c.courseId,
- "userId": c.userId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "classroom.courses.students.get" call.
-// Exactly one of *Student or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Student.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *CoursesStudentsGetCall) Do() (*Student, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Student{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.",
- // "httpMethod": "GET",
- // "id": "classroom.courses.students.get",
- // "parameterOrder": [
- // "courseId",
- // "userId"
- // ],
- // "parameters": {
- // "courseId": {
- // "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userId": {
- // "description": "Identifier of the student to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1/courses/{courseId}/students/{userId}",
- // "response": {
- // "$ref": "Student"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/classroom.profile.emails",
- // "https://www.googleapis.com/auth/classroom.profile.photos",
- // "https://www.googleapis.com/auth/classroom.rosters",
- // "https://www.googleapis.com/auth/classroom.rosters.readonly"
- // ]
- // }
-
-}
-
-// method id "classroom.courses.students.list":
-
-type CoursesStudentsListCall struct {
- s *Service
- courseId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Returns a list of students of this course that the requester is
-// permitted to view. This method returns the following error codes: *
-// `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for
-// access errors.
-func (r *CoursesStudentsService) List(courseId string) *CoursesStudentsListCall {
- c := &CoursesStudentsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.courseId = courseId
- return c
-}
-
-// PageSize sets the optional parameter "pageSize": Maximum number of
-// items to return. Zero means no maximum. The server may return fewer
-// than the specified number of results.
-func (c *CoursesStudentsListCall) PageSize(pageSize int64) *CoursesStudentsListCall {
- c.opt_["pageSize"] = pageSize
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": nextPageToken
-// value returned from a previous list call, indicating that the
-// subsequent page of results should be returned. The list request must
-// be otherwise identical to the one that resulted in this token.
-func (c *CoursesStudentsListCall) PageToken(pageToken string) *CoursesStudentsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CoursesStudentsListCall) Fields(s ...googleapi.Field) *CoursesStudentsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CoursesStudentsListCall) IfNoneMatch(entityTag string) *CoursesStudentsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CoursesStudentsListCall) Context(ctx context.Context) *CoursesStudentsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CoursesStudentsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["pageSize"]; ok {
- params.Set("pageSize", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/courses/{courseId}/students")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "courseId": c.courseId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "classroom.courses.students.list" call.
-// Exactly one of *ListStudentsResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ListStudentsResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CoursesStudentsListCall) Do() (*ListStudentsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ListStudentsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.",
- // "httpMethod": "GET",
- // "id": "classroom.courses.students.list",
- // "parameterOrder": [
- // "courseId"
- // ],
- // "parameters": {
- // "courseId": {
- // "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "pageSize": {
- // "description": "Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "v1/courses/{courseId}/students",
- // "response": {
- // "$ref": "ListStudentsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/classroom.profile.emails",
- // "https://www.googleapis.com/auth/classroom.profile.photos",
- // "https://www.googleapis.com/auth/classroom.rosters",
- // "https://www.googleapis.com/auth/classroom.rosters.readonly"
- // ]
- // }
-
-}
-
-// method id "classroom.courses.teachers.create":
-
-type CoursesTeachersCreateCall struct {
- s *Service
- courseId string
- teacher *Teacher
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Create: Creates a teacher of a course. This method returns the
-// following error codes: * `PERMISSION_DENIED` if the requesting user
-// is not permitted to create teachers in this course or for access
-// errors. * `NOT_FOUND` if the requested course ID does not exist. *
-// `FAILED_PRECONDITION` if the requested user's account is disabled,
-// for the following request errors: * CourseMemberLimitReached *
-// CourseNotModifiable * CourseTeacherLimitReached *
-// UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is
-// already a teacher or student in the course.
-func (r *CoursesTeachersService) Create(courseId string, teacher *Teacher) *CoursesTeachersCreateCall {
- c := &CoursesTeachersCreateCall{s: r.s, opt_: make(map[string]interface{})}
- c.courseId = courseId
- c.teacher = teacher
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CoursesTeachersCreateCall) Fields(s ...googleapi.Field) *CoursesTeachersCreateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CoursesTeachersCreateCall) Context(ctx context.Context) *CoursesTeachersCreateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CoursesTeachersCreateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.teacher)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/courses/{courseId}/teachers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "courseId": c.courseId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "classroom.courses.teachers.create" call.
-// Exactly one of *Teacher or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Teacher.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *CoursesTeachersCreateCall) Do() (*Teacher, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Teacher{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a teacher or student in the course.",
- // "httpMethod": "POST",
- // "id": "classroom.courses.teachers.create",
- // "parameterOrder": [
- // "courseId"
- // ],
- // "parameters": {
- // "courseId": {
- // "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1/courses/{courseId}/teachers",
- // "request": {
- // "$ref": "Teacher"
- // },
- // "response": {
- // "$ref": "Teacher"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/classroom.profile.emails",
- // "https://www.googleapis.com/auth/classroom.profile.photos",
- // "https://www.googleapis.com/auth/classroom.rosters"
- // ]
- // }
-
-}
-
-// method id "classroom.courses.teachers.delete":
-
-type CoursesTeachersDeleteCall struct {
- s *Service
- courseId string
- userId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes a teacher of a course. This method returns the
-// following error codes: * `PERMISSION_DENIED` if the requesting user
-// is not permitted to delete teachers of this course or for access
-// errors. * `NOT_FOUND` if no teacher of this course has the requested
-// ID or if the course does not exist. * `FAILED_PRECONDITION` if the
-// requested ID belongs to the primary teacher of this course.
-func (r *CoursesTeachersService) Delete(courseId string, userId string) *CoursesTeachersDeleteCall {
- c := &CoursesTeachersDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.courseId = courseId
- c.userId = userId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CoursesTeachersDeleteCall) Fields(s ...googleapi.Field) *CoursesTeachersDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CoursesTeachersDeleteCall) Context(ctx context.Context) *CoursesTeachersDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CoursesTeachersDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/courses/{courseId}/teachers/{userId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "courseId": c.courseId,
- "userId": c.userId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "classroom.courses.teachers.delete" call.
-// Exactly one of *Empty or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Empty.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *CoursesTeachersDeleteCall) Do() (*Empty, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Empty{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course.",
- // "httpMethod": "DELETE",
- // "id": "classroom.courses.teachers.delete",
- // "parameterOrder": [
- // "courseId",
- // "userId"
- // ],
- // "parameters": {
- // "courseId": {
- // "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userId": {
- // "description": "Identifier of the teacher to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1/courses/{courseId}/teachers/{userId}",
- // "response": {
- // "$ref": "Empty"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/classroom.rosters"
- // ]
- // }
-
-}
-
-// method id "classroom.courses.teachers.get":
-
-type CoursesTeachersGetCall struct {
- s *Service
- courseId string
- userId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns a teacher of a course. This method returns the following
-// error codes: * `PERMISSION_DENIED` if the requesting user is not
-// permitted to view teachers of this course or for access errors. *
-// `NOT_FOUND` if no teacher of this course has the requested ID or if
-// the course does not exist.
-func (r *CoursesTeachersService) Get(courseId string, userId string) *CoursesTeachersGetCall {
- c := &CoursesTeachersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.courseId = courseId
- c.userId = userId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CoursesTeachersGetCall) Fields(s ...googleapi.Field) *CoursesTeachersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CoursesTeachersGetCall) IfNoneMatch(entityTag string) *CoursesTeachersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CoursesTeachersGetCall) Context(ctx context.Context) *CoursesTeachersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CoursesTeachersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/courses/{courseId}/teachers/{userId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "courseId": c.courseId,
- "userId": c.userId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "classroom.courses.teachers.get" call.
-// Exactly one of *Teacher or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Teacher.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *CoursesTeachersGetCall) Do() (*Teacher, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Teacher{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist.",
- // "httpMethod": "GET",
- // "id": "classroom.courses.teachers.get",
- // "parameterOrder": [
- // "courseId",
- // "userId"
- // ],
- // "parameters": {
- // "courseId": {
- // "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "userId": {
- // "description": "Identifier of the teacher to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1/courses/{courseId}/teachers/{userId}",
- // "response": {
- // "$ref": "Teacher"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/classroom.profile.emails",
- // "https://www.googleapis.com/auth/classroom.profile.photos",
- // "https://www.googleapis.com/auth/classroom.rosters",
- // "https://www.googleapis.com/auth/classroom.rosters.readonly"
- // ]
- // }
-
-}
-
-// method id "classroom.courses.teachers.list":
-
-type CoursesTeachersListCall struct {
- s *Service
- courseId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Returns a list of teachers of this course that the requester is
-// permitted to view. This method returns the following error codes: *
-// `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for
-// access errors.
-func (r *CoursesTeachersService) List(courseId string) *CoursesTeachersListCall {
- c := &CoursesTeachersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.courseId = courseId
- return c
-}
-
-// PageSize sets the optional parameter "pageSize": Maximum number of
-// items to return. Zero means no maximum. The server may return fewer
-// than the specified number of results.
-func (c *CoursesTeachersListCall) PageSize(pageSize int64) *CoursesTeachersListCall {
- c.opt_["pageSize"] = pageSize
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": nextPageToken
-// value returned from a previous list call, indicating that the
-// subsequent page of results should be returned. The list request must
-// be otherwise identical to the one that resulted in this token.
-func (c *CoursesTeachersListCall) PageToken(pageToken string) *CoursesTeachersListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CoursesTeachersListCall) Fields(s ...googleapi.Field) *CoursesTeachersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CoursesTeachersListCall) IfNoneMatch(entityTag string) *CoursesTeachersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CoursesTeachersListCall) Context(ctx context.Context) *CoursesTeachersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CoursesTeachersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["pageSize"]; ok {
- params.Set("pageSize", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/courses/{courseId}/teachers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "courseId": c.courseId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "classroom.courses.teachers.list" call.
-// Exactly one of *ListTeachersResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ListTeachersResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CoursesTeachersListCall) Do() (*ListTeachersResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ListTeachersResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns a list of teachers of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.",
- // "httpMethod": "GET",
- // "id": "classroom.courses.teachers.list",
- // "parameterOrder": [
- // "courseId"
- // ],
- // "parameters": {
- // "courseId": {
- // "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "pageSize": {
- // "description": "Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "v1/courses/{courseId}/teachers",
- // "response": {
- // "$ref": "ListTeachersResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/classroom.profile.emails",
- // "https://www.googleapis.com/auth/classroom.profile.photos",
- // "https://www.googleapis.com/auth/classroom.rosters",
- // "https://www.googleapis.com/auth/classroom.rosters.readonly"
- // ]
- // }
-
-}
-
-// method id "classroom.invitations.accept":
-
-type InvitationsAcceptCall struct {
- s *Service
- id string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Accept: Accepts an invitation, removing it and adding the invited
-// user to the teachers or students (as appropriate) of the specified
-// course. Only the invited user may accept an invitation. This method
-// returns the following error codes: * `PERMISSION_DENIED` if the
-// requesting user is not permitted to accept the requested invitation
-// or for access errors. * `FAILED_PRECONDITION` for the following
-// request errors: * CourseMemberLimitReached * CourseNotModifiable *
-// CourseTeacherLimitReached * UserGroupsMembershipLimitReached *
-// `NOT_FOUND` if no invitation exists with the requested ID.
-func (r *InvitationsService) Accept(id string) *InvitationsAcceptCall {
- c := &InvitationsAcceptCall{s: r.s, opt_: make(map[string]interface{})}
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InvitationsAcceptCall) Fields(s ...googleapi.Field) *InvitationsAcceptCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InvitationsAcceptCall) Context(ctx context.Context) *InvitationsAcceptCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InvitationsAcceptCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/invitations/{id}:accept")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "id": c.id,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "classroom.invitations.accept" call.
-// Exactly one of *Empty or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Empty.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *InvitationsAcceptCall) Do() (*Empty, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Empty{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation or for access errors. * `FAILED_PRECONDITION` for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if no invitation exists with the requested ID.",
- // "httpMethod": "POST",
- // "id": "classroom.invitations.accept",
- // "parameterOrder": [
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Identifier of the invitation to accept.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1/invitations/{id}:accept",
- // "response": {
- // "$ref": "Empty"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/classroom.rosters"
- // ]
- // }
-
-}
-
-// method id "classroom.invitations.create":
-
-type InvitationsCreateCall struct {
- s *Service
- invitation *Invitation
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Create: Creates an invitation. Only one invitation for a user and
-// course may exist at a time. Delete and re-create an invitation to
-// make changes. This method returns the following error codes: *
-// `PERMISSION_DENIED` if the requesting user is not permitted to create
-// invitations for this course or for access errors. * `NOT_FOUND` if
-// the course or the user does not exist. * `FAILED_PRECONDITION` if the
-// requested user's account is disabled or if the user already has this
-// role or a role with greater permissions. * `ALREADY_EXISTS` if an
-// invitation for the specified user and course already exists.
-func (r *InvitationsService) Create(invitation *Invitation) *InvitationsCreateCall {
- c := &InvitationsCreateCall{s: r.s, opt_: make(map[string]interface{})}
- c.invitation = invitation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InvitationsCreateCall) Fields(s ...googleapi.Field) *InvitationsCreateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InvitationsCreateCall) Context(ctx context.Context) *InvitationsCreateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InvitationsCreateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.invitation)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/invitations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "classroom.invitations.create" call.
-// Exactly one of *Invitation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Invitation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InvitationsCreateCall) Do() (*Invitation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Invitation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course or for access errors. * `NOT_FOUND` if the course or the user does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled or if the user already has this role or a role with greater permissions. * `ALREADY_EXISTS` if an invitation for the specified user and course already exists.",
- // "httpMethod": "POST",
- // "id": "classroom.invitations.create",
- // "path": "v1/invitations",
- // "request": {
- // "$ref": "Invitation"
- // },
- // "response": {
- // "$ref": "Invitation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/classroom.rosters"
- // ]
- // }
-
-}
-
-// method id "classroom.invitations.delete":
-
-type InvitationsDeleteCall struct {
- s *Service
- id string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an invitation. This method returns the following
-// error codes: * `PERMISSION_DENIED` if the requesting user is not
-// permitted to delete the requested invitation or for access errors. *
-// `NOT_FOUND` if no invitation exists with the requested ID.
-func (r *InvitationsService) Delete(id string) *InvitationsDeleteCall {
- c := &InvitationsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InvitationsDeleteCall) Fields(s ...googleapi.Field) *InvitationsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InvitationsDeleteCall) Context(ctx context.Context) *InvitationsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InvitationsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/invitations/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "id": c.id,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "classroom.invitations.delete" call.
-// Exactly one of *Empty or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Empty.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *InvitationsDeleteCall) Do() (*Empty, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Empty{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.",
- // "httpMethod": "DELETE",
- // "id": "classroom.invitations.delete",
- // "parameterOrder": [
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Identifier of the invitation to delete.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1/invitations/{id}",
- // "response": {
- // "$ref": "Empty"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/classroom.rosters"
- // ]
- // }
-
-}
-
-// method id "classroom.invitations.get":
-
-type InvitationsGetCall struct {
- s *Service
- id string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns an invitation. This method returns the following error
-// codes: * `PERMISSION_DENIED` if the requesting user is not permitted
-// to view the requested invitation or for access errors. * `NOT_FOUND`
-// if no invitation exists with the requested ID.
-func (r *InvitationsService) Get(id string) *InvitationsGetCall {
- c := &InvitationsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InvitationsGetCall) Fields(s ...googleapi.Field) *InvitationsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InvitationsGetCall) IfNoneMatch(entityTag string) *InvitationsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InvitationsGetCall) Context(ctx context.Context) *InvitationsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InvitationsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/invitations/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "id": c.id,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "classroom.invitations.get" call.
-// Exactly one of *Invitation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Invitation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InvitationsGetCall) Do() (*Invitation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Invitation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.",
- // "httpMethod": "GET",
- // "id": "classroom.invitations.get",
- // "parameterOrder": [
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Identifier of the invitation to return.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1/invitations/{id}",
- // "response": {
- // "$ref": "Invitation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/classroom.rosters",
- // "https://www.googleapis.com/auth/classroom.rosters.readonly"
- // ]
- // }
-
-}
-
-// method id "classroom.invitations.list":
-
-type InvitationsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Returns a list of invitations that the requesting user is
-// permitted to view, restricted to those that match the list request.
-// *Note:* At least one of `user_id` or `course_id` must be supplied.
-// Both fields can be supplied. This method returns the following error
-// codes: * `PERMISSION_DENIED` for access errors.
-func (r *InvitationsService) List() *InvitationsListCall {
- c := &InvitationsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// CourseId sets the optional parameter "courseId": Restricts returned
-// invitations to those for a course with the specified identifier.
-func (c *InvitationsListCall) CourseId(courseId string) *InvitationsListCall {
- c.opt_["courseId"] = courseId
- return c
-}
-
-// PageSize sets the optional parameter "pageSize": Maximum number of
-// items to return. Zero means no maximum. The server may return fewer
-// than the specified number of results.
-func (c *InvitationsListCall) PageSize(pageSize int64) *InvitationsListCall {
- c.opt_["pageSize"] = pageSize
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": nextPageToken
-// value returned from a previous list call, indicating that the
-// subsequent page of results should be returned. The list request must
-// be otherwise identical to the one that resulted in this token.
-func (c *InvitationsListCall) PageToken(pageToken string) *InvitationsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// UserId sets the optional parameter "userId": Restricts returned
-// invitations to those for a specific user. The identifier can be one
-// of the following: * the numeric identifier for the user * the email
-// address of the user * the string literal "me", indicating the
-// requesting user
-func (c *InvitationsListCall) UserId(userId string) *InvitationsListCall {
- c.opt_["userId"] = userId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InvitationsListCall) Fields(s ...googleapi.Field) *InvitationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InvitationsListCall) IfNoneMatch(entityTag string) *InvitationsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InvitationsListCall) Context(ctx context.Context) *InvitationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InvitationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["courseId"]; ok {
- params.Set("courseId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageSize"]; ok {
- params.Set("pageSize", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["userId"]; ok {
- params.Set("userId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/invitations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "classroom.invitations.list" call.
-// Exactly one of *ListInvitationsResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ListInvitationsResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InvitationsListCall) Do() (*ListInvitationsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ListInvitationsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. *Note:* At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied. This method returns the following error codes: * `PERMISSION_DENIED` for access errors.",
- // "httpMethod": "GET",
- // "id": "classroom.invitations.list",
- // "parameters": {
- // "courseId": {
- // "description": "Restricts returned invitations to those for a course with the specified identifier.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageSize": {
- // "description": "Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.",
- // "location": "query",
- // "type": "string"
- // },
- // "userId": {
- // "description": "Restricts returned invitations to those for a specific user. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "v1/invitations",
- // "response": {
- // "$ref": "ListInvitationsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/classroom.rosters",
- // "https://www.googleapis.com/auth/classroom.rosters.readonly"
- // ]
- // }
-
-}
-
-// method id "classroom.userProfiles.get":
-
-type UserProfilesGetCall struct {
- s *Service
- userId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns a user profile. This method returns the following error
-// codes: * `PERMISSION_DENIED` if the requesting user is not permitted
-// to access this user profile or if no profile exists with the
-// requested ID or for access errors.
-func (r *UserProfilesService) Get(userId string) *UserProfilesGetCall {
- c := &UserProfilesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.userId = userId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserProfilesGetCall) Fields(s ...googleapi.Field) *UserProfilesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UserProfilesGetCall) IfNoneMatch(entityTag string) *UserProfilesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserProfilesGetCall) Context(ctx context.Context) *UserProfilesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserProfilesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/userProfiles/{userId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "userId": c.userId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "classroom.userProfiles.get" call.
-// Exactly one of *UserProfile or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UserProfile.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UserProfilesGetCall) Do() (*UserProfile, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserProfile{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns a user profile. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access this user profile or if no profile exists with the requested ID or for access errors.",
- // "httpMethod": "GET",
- // "id": "classroom.userProfiles.get",
- // "parameterOrder": [
- // "userId"
- // ],
- // "parameters": {
- // "userId": {
- // "description": "Identifier of the profile to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1/userProfiles/{userId}",
- // "response": {
- // "$ref": "UserProfile"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/classroom.profile.emails",
- // "https://www.googleapis.com/auth/classroom.profile.photos",
- // "https://www.googleapis.com/auth/classroom.rosters",
- // "https://www.googleapis.com/auth/classroom.rosters.readonly"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/cloudbilling/v1/cloudbilling-api.json b/vendor/google.golang.org/api/cloudbilling/v1/cloudbilling-api.json
deleted file mode 100644
index 6033ea66..00000000
--- a/vendor/google.golang.org/api/cloudbilling/v1/cloudbilling-api.json
+++ /dev/null
@@ -1,343 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/vc2WYrePuDcqazgNVjmdzE5Mns4\"",
- "discoveryVersion": "v1",
- "id": "cloudbilling:v1",
- "name": "cloudbilling",
- "version": "v1",
- "revision": "20150903",
- "title": "Google Cloud Billing API",
- "description": "Retrieves Google Developers Console billing accounts and associates them with projects.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/billing/",
- "protocol": "rest",
- "baseUrl": "https://cloudbilling.googleapis.com/",
- "basePath": "/",
- "rootUrl": "https://cloudbilling.googleapis.com/",
- "servicePath": "",
- "batchPath": "batch",
- "parameters": {
- "access_token": {
- "type": "string",
- "description": "OAuth access token.",
- "location": "query"
- },
- "alt": {
- "type": "string",
- "description": "Data format for response.",
- "default": "json",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "bearer_token": {
- "type": "string",
- "description": "OAuth bearer token.",
- "location": "query"
- },
- "callback": {
- "type": "string",
- "description": "JSONP",
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "pp": {
- "type": "boolean",
- "description": "Pretty-print response.",
- "default": "true",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "location": "query"
- },
- "upload_protocol": {
- "type": "string",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "location": "query"
- },
- "uploadType": {
- "type": "string",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query"
- },
- "$.xgafv": {
- "type": "string",
- "description": "V1 error format.",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "schemas": {
- "BillingAccount": {
- "id": "BillingAccount",
- "type": "object",
- "description": "A billing account in [Google Developers Console](https://console.developers.google.com/). You can assign a billing account to one or more projects.",
- "properties": {
- "name": {
- "type": "string",
- "description": "The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`."
- },
- "open": {
- "type": "boolean",
- "description": "True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it will be unable to use paid services."
- },
- "displayName": {
- "type": "string",
- "description": "The display name given to the billing account, such as `My Billing Account`. This name is displayed in the Google Developers Console."
- }
- }
- },
- "ListBillingAccountsResponse": {
- "id": "ListBillingAccountsResponse",
- "type": "object",
- "description": "Response message for `ListBillingAccounts`.",
- "properties": {
- "billingAccounts": {
- "type": "array",
- "description": "A list of billing accounts.",
- "items": {
- "$ref": "BillingAccount"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "A token to retrieve the next page of results. To retrieve the next page, call `ListBillingAccounts` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve."
- }
- }
- },
- "ListProjectBillingInfoResponse": {
- "id": "ListProjectBillingInfoResponse",
- "type": "object",
- "description": "Request message for `ListProjectBillingInfoResponse`.",
- "properties": {
- "projectBillingInfo": {
- "type": "array",
- "description": "A list of `ProjectBillingInfo` resources representing the projects associated with the billing account.",
- "items": {
- "$ref": "ProjectBillingInfo"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "A token to retrieve the next page of results. To retrieve the next page, call `ListProjectBillingInfo` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve."
- }
- }
- },
- "ProjectBillingInfo": {
- "id": "ProjectBillingInfo",
- "type": "object",
- "description": "Encapsulation of billing information for a Developers Console project. A project has at most one associated billing account at a time (but a billing account can be assigned to multiple projects).",
- "properties": {
- "name": {
- "type": "string",
- "description": "The resource name for the `ProjectBillingInfo`; has the form `projects/{project_id}/billingInfo`. For example, the resource name for the billing information for project `tokyo-rain-123` would be `projects/tokyo-rain-123/billingInfo`. This field is read-only."
- },
- "projectId": {
- "type": "string",
- "description": "The ID of the project that this `ProjectBillingInfo` represents, such as `tokyo-rain-123`. This is a convenience field so that you don't need to parse the `name` field to obtain a project ID. This field is read-only."
- },
- "billingAccountName": {
- "type": "string",
- "description": "The resource name of the billing account associated with the project, if any. For example, `billingAccounts/012345-567890-ABCDEF`."
- },
- "billingEnabled": {
- "type": "boolean",
- "description": "True if the project is associated with an open billing account, to which usage on the project is charged. False if the project is associated with a closed billing account, or no billing account at all, and therefore cannot use paid services. This field is read-only."
- }
- }
- }
- },
- "resources": {
- "billingAccounts": {
- "methods": {
- "get": {
- "id": "cloudbilling.billingAccounts.get",
- "path": "v1/{+name}",
- "httpMethod": "GET",
- "description": "Gets information about a billing account. The current authenticated user must be an [owner of the billing account](https://support.google.com/cloud/answer/4430947).",
- "parameters": {
- "name": {
- "type": "string",
- "description": "The resource name of the billing account to retrieve. For example, `billingAccounts/012345-567890-ABCDEF`.",
- "required": true,
- "pattern": "^billingAccounts/[^/]*$",
- "location": "path"
- }
- },
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "BillingAccount"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "list": {
- "id": "cloudbilling.billingAccounts.list",
- "path": "v1/billingAccounts",
- "httpMethod": "GET",
- "description": "Lists the billing accounts that the current authenticated user [owns](https://support.google.com/cloud/answer/4430947).",
- "parameters": {
- "pageSize": {
- "type": "integer",
- "description": "Requested page size. The maximum page size is 100; this is also the default.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A token identifying a page of results to return. This should be a `next_page_token` value returned from a previous `ListBillingAccounts` call. If unspecified, the first page of results is returned.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "ListBillingAccountsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- },
- "resources": {
- "projects": {
- "methods": {
- "list": {
- "id": "cloudbilling.billingAccounts.projects.list",
- "path": "v1/{+name}/projects",
- "httpMethod": "GET",
- "description": "Lists the projects associated with a billing account. The current authenticated user must be an [owner of the billing account](https://support.google.com/cloud/answer/4430947).",
- "parameters": {
- "name": {
- "type": "string",
- "description": "The resource name of the billing account associated with the projects that you want to list. For example, `billingAccounts/012345-567890-ABCDEF`.",
- "required": true,
- "pattern": "^billingAccounts/[^/]*$",
- "location": "path"
- },
- "pageSize": {
- "type": "integer",
- "description": "Requested page size. The maximum page size is 100; this is also the default.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous `ListProjectBillingInfo` call. If unspecified, the first page of results is returned.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ListProjectBillingInfoResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- }
- }
- },
- "projects": {
- "methods": {
- "getBillingInfo": {
- "id": "cloudbilling.projects.getBillingInfo",
- "path": "v1/{+name}/billingInfo",
- "httpMethod": "GET",
- "description": "Gets the billing information for a project. The current authenticated user must have [permission to view the project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo ).",
- "parameters": {
- "name": {
- "type": "string",
- "description": "The resource name of the project for which billing information is retrieved. For example, `projects/tokyo-rain-123`.",
- "required": true,
- "pattern": "^projects/[^/]*$",
- "location": "path"
- }
- },
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ProjectBillingInfo"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "updateBillingInfo": {
- "id": "cloudbilling.projects.updateBillingInfo",
- "path": "v1/{+name}/billingInfo",
- "httpMethod": "PUT",
- "description": "Sets or updates the billing account associated with a project. You specify the new billing account by setting the `billing_account_name` in the `ProjectBillingInfo` resource to the resource name of a billing account. Associating a project with an open billing account enables billing on the project and allows charges for resource usage. If the project already had a billing account, this method changes the billing account used for resource usage charges. *Note:* Incurred charges that have not yet been reported in the transaction history of the Google Developers Console may be billed to the new billing account, even if the charge occurred before the new billing account was assigned to the project. The current authenticated user must have ownership privileges for both the [project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo ) and the [billing account](https://support.google.com/cloud/answer/4430947). You can disable billing on the project by setting the `billing_account_name` field to empty. This action disassociates the current billing account from the project. Any billable activity of your in-use services will stop, and your application could stop functioning as expected. Any unbilled charges to date will be billed to the previously associated account. The current authenticated user must be either an owner of the project or an owner of the billing account for the project. Note that associating a project with a *closed* billing account will have much the same effect as disabling billing on the project: any paid resources used by the project will be shut down. Thus, unless you wish to disable billing, you should always call this method with the name of an *open* billing account.",
- "parameters": {
- "name": {
- "type": "string",
- "description": "The resource name of the project associated with the billing information that you want to update. For example, `projects/tokyo-rain-123`.",
- "required": true,
- "pattern": "^projects/[^/]*$",
- "location": "path"
- }
- },
- "parameterOrder": [
- "name"
- ],
- "request": {
- "$ref": "ProjectBillingInfo"
- },
- "response": {
- "$ref": "ProjectBillingInfo"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/cloudbilling/v1/cloudbilling-gen.go b/vendor/google.golang.org/api/cloudbilling/v1/cloudbilling-gen.go
deleted file mode 100644
index 475c3d52..00000000
--- a/vendor/google.golang.org/api/cloudbilling/v1/cloudbilling-gen.go
+++ /dev/null
@@ -1,982 +0,0 @@
-// Package cloudbilling provides access to the Google Cloud Billing API.
-//
-// See https://cloud.google.com/billing/
-//
-// Usage example:
-//
-// import "google.golang.org/api/cloudbilling/v1"
-// ...
-// cloudbillingService, err := cloudbilling.New(oauthHttpClient)
-package cloudbilling // import "google.golang.org/api/cloudbilling/v1"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "cloudbilling:v1"
-const apiName = "cloudbilling"
-const apiVersion = "v1"
-const basePath = "https://cloudbilling.googleapis.com/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your data across Google Cloud Platform services
- CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.BillingAccounts = NewBillingAccountsService(s)
- s.Projects = NewProjectsService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- BillingAccounts *BillingAccountsService
-
- Projects *ProjectsService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewBillingAccountsService(s *Service) *BillingAccountsService {
- rs := &BillingAccountsService{s: s}
- rs.Projects = NewBillingAccountsProjectsService(s)
- return rs
-}
-
-type BillingAccountsService struct {
- s *Service
-
- Projects *BillingAccountsProjectsService
-}
-
-func NewBillingAccountsProjectsService(s *Service) *BillingAccountsProjectsService {
- rs := &BillingAccountsProjectsService{s: s}
- return rs
-}
-
-type BillingAccountsProjectsService struct {
- s *Service
-}
-
-func NewProjectsService(s *Service) *ProjectsService {
- rs := &ProjectsService{s: s}
- return rs
-}
-
-type ProjectsService struct {
- s *Service
-}
-
-// BillingAccount: A billing account in [Google Developers
-// Console](https://console.developers.google.com/). You can assign a
-// billing account to one or more projects.
-type BillingAccount struct {
- // DisplayName: The display name given to the billing account, such as
- // `My Billing Account`. This name is displayed in the Google Developers
- // Console.
- DisplayName string `json:"displayName,omitempty"`
-
- // Name: The resource name of the billing account. The resource name has
- // the form `billingAccounts/{billing_account_id}`. For example,
- // `billingAccounts/012345-567890-ABCDEF` would be the resource name for
- // billing account `012345-567890-ABCDEF`.
- Name string `json:"name,omitempty"`
-
- // Open: True if the billing account is open, and will therefore be
- // charged for any usage on associated projects. False if the billing
- // account is closed, and therefore projects associated with it will be
- // unable to use paid services.
- Open bool `json:"open,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "DisplayName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BillingAccount) MarshalJSON() ([]byte, error) {
- type noMethod BillingAccount
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListBillingAccountsResponse: Response message for
-// `ListBillingAccounts`.
-type ListBillingAccountsResponse struct {
- // BillingAccounts: A list of billing accounts.
- BillingAccounts []*BillingAccount `json:"billingAccounts,omitempty"`
-
- // NextPageToken: A token to retrieve the next page of results. To
- // retrieve the next page, call `ListBillingAccounts` again with the
- // `page_token` field set to this value. This field is empty if there
- // are no more results to retrieve.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "BillingAccounts") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListBillingAccountsResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListBillingAccountsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListProjectBillingInfoResponse: Request message for
-// `ListProjectBillingInfoResponse`.
-type ListProjectBillingInfoResponse struct {
- // NextPageToken: A token to retrieve the next page of results. To
- // retrieve the next page, call `ListProjectBillingInfo` again with the
- // `page_token` field set to this value. This field is empty if there
- // are no more results to retrieve.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ProjectBillingInfo: A list of `ProjectBillingInfo` resources
- // representing the projects associated with the billing account.
- ProjectBillingInfo []*ProjectBillingInfo `json:"projectBillingInfo,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "NextPageToken") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListProjectBillingInfoResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListProjectBillingInfoResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ProjectBillingInfo: Encapsulation of billing information for a
-// Developers Console project. A project has at most one associated
-// billing account at a time (but a billing account can be assigned to
-// multiple projects).
-type ProjectBillingInfo struct {
- // BillingAccountName: The resource name of the billing account
- // associated with the project, if any. For example,
- // `billingAccounts/012345-567890-ABCDEF`.
- BillingAccountName string `json:"billingAccountName,omitempty"`
-
- // BillingEnabled: True if the project is associated with an open
- // billing account, to which usage on the project is charged. False if
- // the project is associated with a closed billing account, or no
- // billing account at all, and therefore cannot use paid services. This
- // field is read-only.
- BillingEnabled bool `json:"billingEnabled,omitempty"`
-
- // Name: The resource name for the `ProjectBillingInfo`; has the form
- // `projects/{project_id}/billingInfo`. For example, the resource name
- // for the billing information for project `tokyo-rain-123` would be
- // `projects/tokyo-rain-123/billingInfo`. This field is read-only.
- Name string `json:"name,omitempty"`
-
- // ProjectId: The ID of the project that this `ProjectBillingInfo`
- // represents, such as `tokyo-rain-123`. This is a convenience field so
- // that you don't need to parse the `name` field to obtain a project ID.
- // This field is read-only.
- ProjectId string `json:"projectId,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "BillingAccountName")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProjectBillingInfo) MarshalJSON() ([]byte, error) {
- type noMethod ProjectBillingInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "cloudbilling.billingAccounts.get":
-
-type BillingAccountsGetCall struct {
- s *Service
- name string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets information about a billing account. The current
-// authenticated user must be an [owner of the billing
-// account](https://support.google.com/cloud/answer/4430947).
-func (r *BillingAccountsService) Get(name string) *BillingAccountsGetCall {
- c := &BillingAccountsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.name = name
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BillingAccountsGetCall) Fields(s ...googleapi.Field) *BillingAccountsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *BillingAccountsGetCall) IfNoneMatch(entityTag string) *BillingAccountsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BillingAccountsGetCall) Context(ctx context.Context) *BillingAccountsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BillingAccountsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "name": c.name,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudbilling.billingAccounts.get" call.
-// Exactly one of *BillingAccount or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *BillingAccount.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *BillingAccountsGetCall) Do() (*BillingAccount, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &BillingAccount{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets information about a billing account. The current authenticated user must be an [owner of the billing account](https://support.google.com/cloud/answer/4430947).",
- // "httpMethod": "GET",
- // "id": "cloudbilling.billingAccounts.get",
- // "parameterOrder": [
- // "name"
- // ],
- // "parameters": {
- // "name": {
- // "description": "The resource name of the billing account to retrieve. For example, `billingAccounts/012345-567890-ABCDEF`.",
- // "location": "path",
- // "pattern": "^billingAccounts/[^/]*$",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1/{+name}",
- // "response": {
- // "$ref": "BillingAccount"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "cloudbilling.billingAccounts.list":
-
-type BillingAccountsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists the billing accounts that the current authenticated user
-// [owns](https://support.google.com/cloud/answer/4430947).
-func (r *BillingAccountsService) List() *BillingAccountsListCall {
- c := &BillingAccountsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// PageSize sets the optional parameter "pageSize": Requested page size.
-// The maximum page size is 100; this is also the default.
-func (c *BillingAccountsListCall) PageSize(pageSize int64) *BillingAccountsListCall {
- c.opt_["pageSize"] = pageSize
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A token
-// identifying a page of results to return. This should be a
-// `next_page_token` value returned from a previous
-// `ListBillingAccounts` call. If unspecified, the first page of results
-// is returned.
-func (c *BillingAccountsListCall) PageToken(pageToken string) *BillingAccountsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BillingAccountsListCall) Fields(s ...googleapi.Field) *BillingAccountsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *BillingAccountsListCall) IfNoneMatch(entityTag string) *BillingAccountsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BillingAccountsListCall) Context(ctx context.Context) *BillingAccountsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BillingAccountsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["pageSize"]; ok {
- params.Set("pageSize", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/billingAccounts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudbilling.billingAccounts.list" call.
-// Exactly one of *ListBillingAccountsResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *ListBillingAccountsResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *BillingAccountsListCall) Do() (*ListBillingAccountsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ListBillingAccountsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists the billing accounts that the current authenticated user [owns](https://support.google.com/cloud/answer/4430947).",
- // "httpMethod": "GET",
- // "id": "cloudbilling.billingAccounts.list",
- // "parameters": {
- // "pageSize": {
- // "description": "Requested page size. The maximum page size is 100; this is also the default.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A token identifying a page of results to return. This should be a `next_page_token` value returned from a previous `ListBillingAccounts` call. If unspecified, the first page of results is returned.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "v1/billingAccounts",
- // "response": {
- // "$ref": "ListBillingAccountsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "cloudbilling.billingAccounts.projects.list":
-
-type BillingAccountsProjectsListCall struct {
- s *Service
- name string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists the projects associated with a billing account. The
-// current authenticated user must be an [owner of the billing
-// account](https://support.google.com/cloud/answer/4430947).
-func (r *BillingAccountsProjectsService) List(name string) *BillingAccountsProjectsListCall {
- c := &BillingAccountsProjectsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.name = name
- return c
-}
-
-// PageSize sets the optional parameter "pageSize": Requested page size.
-// The maximum page size is 100; this is also the default.
-func (c *BillingAccountsProjectsListCall) PageSize(pageSize int64) *BillingAccountsProjectsListCall {
- c.opt_["pageSize"] = pageSize
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A token
-// identifying a page of results to be returned. This should be a
-// `next_page_token` value returned from a previous
-// `ListProjectBillingInfo` call. If unspecified, the first page of
-// results is returned.
-func (c *BillingAccountsProjectsListCall) PageToken(pageToken string) *BillingAccountsProjectsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BillingAccountsProjectsListCall) Fields(s ...googleapi.Field) *BillingAccountsProjectsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *BillingAccountsProjectsListCall) IfNoneMatch(entityTag string) *BillingAccountsProjectsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BillingAccountsProjectsListCall) Context(ctx context.Context) *BillingAccountsProjectsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BillingAccountsProjectsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["pageSize"]; ok {
- params.Set("pageSize", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}/projects")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "name": c.name,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudbilling.billingAccounts.projects.list" call.
-// Exactly one of *ListProjectBillingInfoResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *ListProjectBillingInfoResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *BillingAccountsProjectsListCall) Do() (*ListProjectBillingInfoResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ListProjectBillingInfoResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists the projects associated with a billing account. The current authenticated user must be an [owner of the billing account](https://support.google.com/cloud/answer/4430947).",
- // "httpMethod": "GET",
- // "id": "cloudbilling.billingAccounts.projects.list",
- // "parameterOrder": [
- // "name"
- // ],
- // "parameters": {
- // "name": {
- // "description": "The resource name of the billing account associated with the projects that you want to list. For example, `billingAccounts/012345-567890-ABCDEF`.",
- // "location": "path",
- // "pattern": "^billingAccounts/[^/]*$",
- // "required": true,
- // "type": "string"
- // },
- // "pageSize": {
- // "description": "Requested page size. The maximum page size is 100; this is also the default.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous `ListProjectBillingInfo` call. If unspecified, the first page of results is returned.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "v1/{+name}/projects",
- // "response": {
- // "$ref": "ListProjectBillingInfoResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "cloudbilling.projects.getBillingInfo":
-
-type ProjectsGetBillingInfoCall struct {
- s *Service
- name string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetBillingInfo: Gets the billing information for a project. The
-// current authenticated user must have [permission to view the
-// project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxof
-// vnoo ).
-func (r *ProjectsService) GetBillingInfo(name string) *ProjectsGetBillingInfoCall {
- c := &ProjectsGetBillingInfoCall{s: r.s, opt_: make(map[string]interface{})}
- c.name = name
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsGetBillingInfoCall) Fields(s ...googleapi.Field) *ProjectsGetBillingInfoCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ProjectsGetBillingInfoCall) IfNoneMatch(entityTag string) *ProjectsGetBillingInfoCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsGetBillingInfoCall) Context(ctx context.Context) *ProjectsGetBillingInfoCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsGetBillingInfoCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}/billingInfo")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "name": c.name,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudbilling.projects.getBillingInfo" call.
-// Exactly one of *ProjectBillingInfo or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ProjectBillingInfo.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ProjectsGetBillingInfoCall) Do() (*ProjectBillingInfo, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ProjectBillingInfo{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the billing information for a project. The current authenticated user must have [permission to view the project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo ).",
- // "httpMethod": "GET",
- // "id": "cloudbilling.projects.getBillingInfo",
- // "parameterOrder": [
- // "name"
- // ],
- // "parameters": {
- // "name": {
- // "description": "The resource name of the project for which billing information is retrieved. For example, `projects/tokyo-rain-123`.",
- // "location": "path",
- // "pattern": "^projects/[^/]*$",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1/{+name}/billingInfo",
- // "response": {
- // "$ref": "ProjectBillingInfo"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "cloudbilling.projects.updateBillingInfo":
-
-type ProjectsUpdateBillingInfoCall struct {
- s *Service
- name string
- projectbillinginfo *ProjectBillingInfo
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// UpdateBillingInfo: Sets or updates the billing account associated
-// with a project. You specify the new billing account by setting the
-// `billing_account_name` in the `ProjectBillingInfo` resource to the
-// resource name of a billing account. Associating a project with an
-// open billing account enables billing on the project and allows
-// charges for resource usage. If the project already had a billing
-// account, this method changes the billing account used for resource
-// usage charges. *Note:* Incurred charges that have not yet been
-// reported in the transaction history of the Google Developers Console
-// may be billed to the new billing account, even if the charge occurred
-// before the new billing account was assigned to the project. The
-// current authenticated user must have ownership privileges for both
-// the
-// [project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxo
-// fvnoo ) and the [billing
-// account](https://support.google.com/cloud/answer/4430947). You can
-// disable billing on the project by setting the `billing_account_name`
-// field to empty. This action disassociates the current billing account
-// from the project. Any billable activity of your in-use services will
-// stop, and your application could stop functioning as expected. Any
-// unbilled charges to date will be billed to the previously associated
-// account. The current authenticated user must be either an owner of
-// the project or an owner of the billing account for the project. Note
-// that associating a project with a *closed* billing account will have
-// much the same effect as disabling billing on the project: any paid
-// resources used by the project will be shut down. Thus, unless you
-// wish to disable billing, you should always call this method with the
-// name of an *open* billing account.
-func (r *ProjectsService) UpdateBillingInfo(name string, projectbillinginfo *ProjectBillingInfo) *ProjectsUpdateBillingInfoCall {
- c := &ProjectsUpdateBillingInfoCall{s: r.s, opt_: make(map[string]interface{})}
- c.name = name
- c.projectbillinginfo = projectbillinginfo
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsUpdateBillingInfoCall) Fields(s ...googleapi.Field) *ProjectsUpdateBillingInfoCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsUpdateBillingInfoCall) Context(ctx context.Context) *ProjectsUpdateBillingInfoCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsUpdateBillingInfoCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.projectbillinginfo)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}/billingInfo")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "name": c.name,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudbilling.projects.updateBillingInfo" call.
-// Exactly one of *ProjectBillingInfo or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ProjectBillingInfo.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ProjectsUpdateBillingInfoCall) Do() (*ProjectBillingInfo, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ProjectBillingInfo{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sets or updates the billing account associated with a project. You specify the new billing account by setting the `billing_account_name` in the `ProjectBillingInfo` resource to the resource name of a billing account. Associating a project with an open billing account enables billing on the project and allows charges for resource usage. If the project already had a billing account, this method changes the billing account used for resource usage charges. *Note:* Incurred charges that have not yet been reported in the transaction history of the Google Developers Console may be billed to the new billing account, even if the charge occurred before the new billing account was assigned to the project. The current authenticated user must have ownership privileges for both the [project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo ) and the [billing account](https://support.google.com/cloud/answer/4430947). You can disable billing on the project by setting the `billing_account_name` field to empty. This action disassociates the current billing account from the project. Any billable activity of your in-use services will stop, and your application could stop functioning as expected. Any unbilled charges to date will be billed to the previously associated account. The current authenticated user must be either an owner of the project or an owner of the billing account for the project. Note that associating a project with a *closed* billing account will have much the same effect as disabling billing on the project: any paid resources used by the project will be shut down. Thus, unless you wish to disable billing, you should always call this method with the name of an *open* billing account.",
- // "httpMethod": "PUT",
- // "id": "cloudbilling.projects.updateBillingInfo",
- // "parameterOrder": [
- // "name"
- // ],
- // "parameters": {
- // "name": {
- // "description": "The resource name of the project associated with the billing information that you want to update. For example, `projects/tokyo-rain-123`.",
- // "location": "path",
- // "pattern": "^projects/[^/]*$",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1/{+name}/billingInfo",
- // "request": {
- // "$ref": "ProjectBillingInfo"
- // },
- // "response": {
- // "$ref": "ProjectBillingInfo"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/clouddebugger/v2/clouddebugger-api.json b/vendor/google.golang.org/api/clouddebugger/v2/clouddebugger-api.json
deleted file mode 100644
index 81cc52b0..00000000
--- a/vendor/google.golang.org/api/clouddebugger/v2/clouddebugger-api.json
+++ /dev/null
@@ -1,913 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/IirqKiawPBlWznB4XZKKLikRaQQ\"",
- "discoveryVersion": "v1",
- "id": "clouddebugger:v2",
- "name": "clouddebugger",
- "version": "v2",
- "revision": "20150725",
- "title": "Google Cloud Debugger API",
- "description": "Lets you examine the stack and variables of your running application without stopping or slowing it down.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/tools/cloud-debugger",
- "protocol": "rest",
- "baseUrl": "https://clouddebugger.googleapis.com/",
- "basePath": "/",
- "rootUrl": "https://clouddebugger.googleapis.com/",
- "servicePath": "",
- "batchPath": "batch",
- "parameters": {
- "access_token": {
- "type": "string",
- "description": "OAuth access token.",
- "location": "query"
- },
- "alt": {
- "type": "string",
- "description": "Data format for response.",
- "default": "json",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "bearer_token": {
- "type": "string",
- "description": "OAuth bearer token.",
- "location": "query"
- },
- "callback": {
- "type": "string",
- "description": "JSONP",
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "pp": {
- "type": "boolean",
- "description": "Pretty-print response.",
- "default": "true",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "location": "query"
- },
- "upload_protocol": {
- "type": "string",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "location": "query"
- },
- "uploadType": {
- "type": "string",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query"
- },
- "$.xgafv": {
- "type": "string",
- "description": "V1 error format.",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud_debugger": {
- "description": "Manage cloud debugger"
- },
- "https://www.googleapis.com/auth/cloud_debugletcontroller": {
- "description": "Manage active breakpoints in cloud debugger"
- }
- }
- }
- },
- "schemas": {
- "RegisterDebuggeeRequest": {
- "id": "RegisterDebuggeeRequest",
- "type": "object",
- "description": "The request to register a debuggee.",
- "properties": {
- "debuggee": {
- "$ref": "Debuggee",
- "description": "The debuggee information to register. The fields 'project', 'uniquifier', 'description' and 'agent_version' of the debuggee must be set."
- }
- }
- },
- "Debuggee": {
- "id": "Debuggee",
- "type": "object",
- "description": "Represents the application to debug. The application may include one or more replicated processes executing the same code. Each of these processes is attached with a debugger agent, carrying out the debugging commands. The agents attached to the same debuggee are identified by using exactly the same fields' values when registering.",
- "properties": {
- "id": {
- "type": "string",
- "description": "Debuggee unique identifer generated by the server."
- },
- "project": {
- "type": "string",
- "description": "The project the debuggee is associated with. Use the project number when registering a Google Cloud Platform project."
- },
- "uniquifier": {
- "type": "string",
- "description": "The debuggee uniqifier within the project. Any string that id the application within the project can be used. Recomended to include environement and version or build id's."
- },
- "description": {
- "type": "string",
- "description": "A human readable description of the debuggee. Recommended to include human readable project name, environment name, and version information ."
- },
- "isInactive": {
- "type": "boolean",
- "description": "If set to true indicates that the debuggee has not been seen by the Controller service in the last active time period (defined by the server)."
- },
- "agentVersion": {
- "type": "string",
- "description": "Version ID of the agent release. The version ID is structured as following: \"domain/type/vmajor.minor\" (for example \"google.com/gcp-java/v1.1\")."
- },
- "isDisabled": {
- "type": "boolean",
- "description": "If set to true, indicates that the agent should disable itself and detach from the debuggee."
- },
- "status": {
- "$ref": "StatusMessage",
- "description": "Human readable message to be displayed to the user about this debuggee. Absense of this field indicates no message. The message can be either informational or error."
- },
- "sourceContexts": {
- "type": "array",
- "description": "Repository snapshots containing the source code of the project.",
- "items": {
- "$ref": "SourceContext"
- }
- },
- "labels": {
- "type": "object",
- "description": "A set of custom debuggee properties, populated by the agent, to be displayed to the user.",
- "additionalProperties": {
- "type": "string"
- }
- }
- }
- },
- "StatusMessage": {
- "id": "StatusMessage",
- "type": "object",
- "description": "Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message \"Location not found\".",
- "properties": {
- "isError": {
- "type": "boolean",
- "description": "Distinguishes errors from informational messages."
- },
- "refersTo": {
- "type": "string",
- "description": "Reference to which the message applies.",
- "enum": [
- "UNSPECIFIED",
- "BREAKPOINT_SOURCE_LOCATION",
- "BREAKPOINT_CONDITION",
- "BREAKPOINT_EXPRESSION",
- "VARIABLE_NAME",
- "VARIABLE_VALUE"
- ]
- },
- "description": {
- "$ref": "FormatMessage",
- "description": "Status message text."
- }
- }
- },
- "FormatMessage": {
- "id": "FormatMessage",
- "type": "object",
- "description": "Represents a message with parameters.",
- "properties": {
- "format": {
- "type": "string",
- "description": "Format template of the message. The \"format\" uses placeholders \"$0\", \"$1\", etc. to reference parameters. \"$$\" can be used to denote the '$' character. Examples: \"Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.\" \"Please pay $$10 to use $0 instead of $1.\""
- },
- "parameters": {
- "type": "array",
- "description": "Optional parameters to be embedded into the message.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "SourceContext": {
- "id": "SourceContext",
- "type": "object",
- "description": "A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory.",
- "properties": {
- "cloudRepo": {
- "$ref": "CloudRepoSourceContext",
- "description": "A SourceContext referring to a revision in a cloud repo."
- },
- "cloudWorkspace": {
- "$ref": "CloudWorkspaceSourceContext",
- "description": "A SourceContext referring to a snapshot in a cloud workspace."
- },
- "gerrit": {
- "$ref": "GerritSourceContext",
- "description": "A SourceContext referring to a Gerrit project."
- },
- "git": {
- "$ref": "GitSourceContext",
- "description": "A SourceContext referring to any third party Git repo (e.g. GitHub)."
- }
- }
- },
- "CloudRepoSourceContext": {
- "id": "CloudRepoSourceContext",
- "type": "object",
- "description": "A CloudRepoSourceContext denotes a particular revision in a cloud repo (a repo hosted by the Google Cloud Platform).",
- "properties": {
- "repoId": {
- "$ref": "RepoId",
- "description": "The ID of the repo."
- },
- "revisionId": {
- "type": "string",
- "description": "A revision ID."
- },
- "aliasName": {
- "type": "string",
- "description": "The name of an alias (branch, tag, etc.)."
- }
- }
- },
- "RepoId": {
- "id": "RepoId",
- "type": "object",
- "description": "A unique identifier for a cloud repo.",
- "properties": {
- "projectRepoId": {
- "$ref": "ProjectRepoId",
- "description": "A combination of a project ID and a repo name."
- },
- "uid": {
- "type": "string",
- "description": "A server-assigned, globally unique identifier."
- }
- }
- },
- "ProjectRepoId": {
- "id": "ProjectRepoId",
- "type": "object",
- "description": "Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project.",
- "properties": {
- "projectId": {
- "type": "string",
- "description": "The ID of the project."
- },
- "repoName": {
- "type": "string",
- "description": "The name of the repo. Leave empty for the default repo."
- }
- }
- },
- "CloudWorkspaceSourceContext": {
- "id": "CloudWorkspaceSourceContext",
- "type": "object",
- "description": "A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot.",
- "properties": {
- "workspaceId": {
- "$ref": "CloudWorkspaceId",
- "description": "The ID of the workspace."
- },
- "snapshotId": {
- "type": "string",
- "description": "The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot."
- }
- }
- },
- "CloudWorkspaceId": {
- "id": "CloudWorkspaceId",
- "type": "object",
- "description": "A CloudWorkspaceId is a unique identifier for a cloud workspace. A cloud workspace is a place associated with a repo where modified files can be stored before they are committed.",
- "properties": {
- "repoId": {
- "$ref": "RepoId",
- "description": "The ID of the repo containing the workspace."
- },
- "name": {
- "type": "string",
- "description": "The unique name of the workspace within the repo. This is the name chosen by the client in the Source API's CreateWorkspace method."
- }
- }
- },
- "GerritSourceContext": {
- "id": "GerritSourceContext",
- "type": "object",
- "description": "A SourceContext referring to a Gerrit project.",
- "properties": {
- "hostUri": {
- "type": "string",
- "description": "The URI of a running Gerrit instance."
- },
- "gerritProject": {
- "type": "string",
- "description": "The full project name within the host. Projects may be nested, so \"project/subproject\" is a valid project name. The \"repo name\" is hostURI/project."
- },
- "revisionId": {
- "type": "string",
- "description": "A revision (commit) ID."
- },
- "aliasName": {
- "type": "string",
- "description": "The name of an alias (branch, tag, etc.)."
- }
- }
- },
- "GitSourceContext": {
- "id": "GitSourceContext",
- "type": "object",
- "description": "A GitSourceContext denotes a particular revision in a third party Git repository (e.g. GitHub).",
- "properties": {
- "url": {
- "type": "string",
- "description": "Git repository URL."
- },
- "revisionId": {
- "type": "string",
- "description": "Git commit hash. required."
- }
- }
- },
- "RegisterDebuggeeResponse": {
- "id": "RegisterDebuggeeResponse",
- "type": "object",
- "description": "The response of registering a debuggee.",
- "properties": {
- "debuggee": {
- "$ref": "Debuggee",
- "description": "The debuggee resource. The field 'id' is guranteed to be set (in addition to the echoed fields)."
- }
- }
- },
- "ListActiveBreakpointsResponse": {
- "id": "ListActiveBreakpointsResponse",
- "type": "object",
- "description": "The response of listing active breakpoints.",
- "properties": {
- "breakpoints": {
- "type": "array",
- "description": "List of all active breakpoints. The fields 'id' and 'location' are guranteed to be set on each breakpoint.",
- "items": {
- "$ref": "Breakpoint"
- }
- },
- "nextWaitToken": {
- "type": "string",
- "description": "A wait token that can be used in the next method call to block until the list of breakpoints changes."
- }
- }
- },
- "Breakpoint": {
- "id": "Breakpoint",
- "type": "object",
- "description": "Represents the breakpoint specification, status and results.",
- "properties": {
- "id": {
- "type": "string",
- "description": "Breakpoint identifier, unique in the scope of the debuggee."
- },
- "action": {
- "type": "string",
- "description": "Defines what to do when the breakpoint hits.",
- "enum": [
- "CAPTURE",
- "LOG"
- ]
- },
- "location": {
- "$ref": "SourceLocation",
- "description": "The breakpoint source location."
- },
- "condition": {
- "type": "string",
- "description": "A condition to trigger the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location."
- },
- "expressions": {
- "type": "array",
- "description": "A list of read-only expressions to evaluate at the breakpoint location. The expressions are composed using expressions in the programming language at the source location. If the breakpoint action is \"LOG\", the evaluated expressions are included in log statements.",
- "items": {
- "type": "string"
- }
- },
- "logMessageFormat": {
- "type": "string",
- "description": "Only relevant when action is \"LOG\". Defines the message to log when the breakpoint hits. The message may include parameter placeholders \"$0\", \"$1\", etc. These placeholders will be replaced with the evaluated value of the appropriate expression. Expressions not referenced in \"log_message_format\" will not be logged. Example: \"Poisonous message received, id = $0, count = $1\" with expressions = [ \"message.id\", \"message.count\" ]."
- },
- "logLevel": {
- "type": "string",
- "description": "Indicates the severity of the log. Only relevant when action is \"LOG\".",
- "enum": [
- "INFO",
- "WARNING",
- "ERROR"
- ]
- },
- "isFinalState": {
- "type": "boolean",
- "description": "When true, indicates that this is a final result and the breakpoint state will not change from here on."
- },
- "createTime": {
- "type": "string",
- "description": "The time this breakpoint was created by the server. The value is in seconds resolution."
- },
- "finalTime": {
- "type": "string",
- "description": "The time this breakpoint was finalized as seen by the server. The value is in seconds resolution."
- },
- "userEmail": {
- "type": "string",
- "description": "The e-mail of the user that created this breakpoint"
- },
- "status": {
- "$ref": "StatusMessage",
- "description": "Breakpoint status. The status includes an error flag and a human readable message. This field will usually stay unset. The message can be either informational or error. Nevertheless, clients should always display the text message back to the user. Error status of a breakpoint indicates complete failure. Example (non-final state): 'Still loading symbols...' Examples (final state): 'Failed to insert breakpoint' referring to breakpoint, 'Field f not found in class C' referring to condition, ..."
- },
- "stackFrames": {
- "type": "array",
- "description": "The stack at breakpoint time.",
- "items": {
- "$ref": "StackFrame"
- }
- },
- "evaluatedExpressions": {
- "type": "array",
- "description": "The evaluated expressions' values at breakpoint time. The evaluated expressions appear in exactly the same order they are listed in the 'expressions' field. The 'name' field holds the original expression text, the 'value'/'members' field holds the result of the evaluated expression. If the expression can not be evaluated, an error text is placed in the value field.",
- "items": {
- "$ref": "Variable"
- }
- },
- "variableTable": {
- "type": "array",
- "description": "The variable_table exists to aid with computation, memory and network traffic optimization. It enables storing a variable once and reference it from multiple variables, including variables stored in the variable_table itself. For example, the object 'this', which may appear at many levels of the stack, can have all of it's data stored once in this table. The stack frame variables then would hold only a reference to it. The variable var_index field is an index into this repeated field. The stored objects are nameless and get their name from the referencing variable. The effective variable is a merge of the referencing veariable and the referenced variable.",
- "items": {
- "$ref": "Variable"
- }
- }
- }
- },
- "SourceLocation": {
- "id": "SourceLocation",
- "type": "object",
- "description": "Represents a location in the source code.",
- "properties": {
- "path": {
- "type": "string",
- "description": "A path to the source file within the source context of the target binary."
- },
- "line": {
- "type": "integer",
- "description": "The line inside the file (first line value is '1').",
- "format": "int32"
- }
- }
- },
- "StackFrame": {
- "id": "StackFrame",
- "type": "object",
- "description": "Represents a stack frame context.",
- "properties": {
- "function": {
- "type": "string",
- "description": "The unmangled function name at the call site."
- },
- "location": {
- "$ref": "SourceLocation",
- "description": "The source location of the call site."
- },
- "arguments": {
- "type": "array",
- "description": "The set of arguments passed to this function Note that this might not be populated for all stack frames.",
- "items": {
- "$ref": "Variable"
- }
- },
- "locals": {
- "type": "array",
- "description": "The set of local variables at the stack frame location. Note that this might not be populated for all stack frames.",
- "items": {
- "$ref": "Variable"
- }
- }
- }
- },
- "Variable": {
- "id": "Variable",
- "type": "object",
- "description": "Represents a variable or an argument possibly of a compound object type. 1. A simple variable such as, int x = 5 is represented as: { name: \"x\", value: \"5\" } 2. A compound object such as, struct T { int m1; int m2; }; T x = { 3, 7 }; is represented as: { name: \"x\", members { name: \"m1\", value: \"3\" }, members { name: \"m2\", value: \"7\" } } 3. A pointer where the pointee was captured such as, T x = { 3, 7 }; T* p = &x; is represented as: { name: \"p\", value: \"0x00500500\", members { name: \"m1\", value: \"3\" }, members { name: \"m2\", value: \"7\" } } 4. A pointer where the pointee was not captured or is inaccessible such as, T* p = new T; is represented as: { name: \"p\", value: \"0x00400400\", members { value: \"\" } } the value text should decribe the reason for the missing value. such as , ,\n. note that a null pointer should not have members. 5. An unnamed value such as, int* p = new int(7); is represented as, { name: \"p\", value: \"0x00500500\", members { value: \"7\" } } 6. An unnamed pointer where the pointee was not captured such as, int* p = new int(7); int** pp = &p; is represented as: { name: \"pp\", value: \"0x00500500\", members { value: \"0x00400400\", members { value: \"\" } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable merge the referencing variable with the referenced variable. When using the shared variable table, variables can be represented as: T x = { 3, 7 }; T* p = &x; T& r = x; are represented as, { name: \"x\", var_index: 3 } { name: \"p\", value \"0x00500500\", var_index: 3 } { name: \"r\", var_index: 3 } with shared variable table entry #3: { members { name: \"m1\", value: \"3\" }, members { name: \"m2\", value: \"7\" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable, to allow the referenced variable to be shared between pointer and references.",
- "properties": {
- "name": {
- "type": "string",
- "description": "The name of the variable, if any."
- },
- "value": {
- "type": "string",
- "description": "The simple value of the variable."
- },
- "members": {
- "type": "array",
- "description": "The members contained or pointed to by the variable.",
- "items": {
- "$ref": "Variable"
- }
- },
- "varTableIndex": {
- "type": "integer",
- "description": "This is a reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_index field is an index into variable_table in Breakpoint.",
- "format": "int32"
- },
- "status": {
- "$ref": "StatusMessage",
- "description": "Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with \"refers_to\" set to \"VARIABLE_NAME\". Alternatively \"refers_to\" will be set to \"VARIABLE_VALUE\". In either case variable value and members will be unset. Example of error message applied to name: \"Invalid expression syntax\". Example of information message applied to value: \"Not captured\". Examples of error message applied to value: \"Malformed string\", \"Field f not found in class C\", \"Null pointer dereference\"."
- }
- }
- },
- "UpdateActiveBreakpointRequest": {
- "id": "UpdateActiveBreakpointRequest",
- "type": "object",
- "description": "The request to update an active breakpoint.",
- "properties": {
- "breakpoint": {
- "$ref": "Breakpoint",
- "description": "The updated breakpoint information. The field 'id' must be set."
- }
- }
- },
- "UpdateActiveBreakpointResponse": {
- "id": "UpdateActiveBreakpointResponse",
- "type": "object",
- "description": "The response of updating an active breakpoint. The message is defined to allow future extensions."
- },
- "SetBreakpointResponse": {
- "id": "SetBreakpointResponse",
- "type": "object",
- "description": "The response of setting a breakpoint.",
- "properties": {
- "breakpoint": {
- "$ref": "Breakpoint",
- "description": "The breakpoint resource. The field 'id' is guranteed to be set (in addition to the echoed fileds)."
- }
- }
- },
- "GetBreakpointResponse": {
- "id": "GetBreakpointResponse",
- "type": "object",
- "description": "The response of getting breakpoint information.",
- "properties": {
- "breakpoint": {
- "$ref": "Breakpoint",
- "description": "The complete breakpoint state. The fields 'id' and 'location' are guranteed to be set."
- }
- }
- },
- "Empty": {
- "id": "Empty",
- "type": "object",
- "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`."
- },
- "ListBreakpointsResponse": {
- "id": "ListBreakpointsResponse",
- "type": "object",
- "description": "The response of listing breakpoints.",
- "properties": {
- "breakpoints": {
- "type": "array",
- "description": "List of all breakpoints with complete state. The fields 'id' and 'location' are guranteed to be set on each breakpoint.",
- "items": {
- "$ref": "Breakpoint"
- }
- },
- "nextWaitToken": {
- "type": "string",
- "description": "A wait token that can be used in the next call to ListBreakpoints to block until the list of breakpoints has changes."
- }
- }
- },
- "ListDebuggeesResponse": {
- "id": "ListDebuggeesResponse",
- "type": "object",
- "description": "The response of listing debuggees.",
- "properties": {
- "debuggees": {
- "type": "array",
- "description": "The list of debuggees accessible to the calling user. Note that the description field is the only human readable field that should be displayed to the user. The fields 'debuggee.id' and 'description' are guranteed to be set on each debuggee.",
- "items": {
- "$ref": "Debuggee"
- }
- }
- }
- }
- },
- "resources": {
- "controller": {
- "resources": {
- "debuggees": {
- "methods": {
- "register": {
- "id": "clouddebugger.controller.debuggees.register",
- "path": "v2/controller/debuggees/register",
- "httpMethod": "POST",
- "description": "Registers the debuggee with the controller. All agents should call this API with the same request content to get back the same stable 'debuggee_id'. Agents should call this API again whenever ListActiveBreakpoints or UpdateActiveBreakpoint return the error google.rpc.Code.NOT_FOUND. It allows the server to disable the agent or recover from any registration loss. If the debuggee is disabled server, the response will have is_disabled' set to true.",
- "request": {
- "$ref": "RegisterDebuggeeRequest"
- },
- "response": {
- "$ref": "RegisterDebuggeeResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugletcontroller"
- ]
- }
- },
- "resources": {
- "breakpoints": {
- "methods": {
- "list": {
- "id": "clouddebugger.controller.debuggees.breakpoints.list",
- "path": "v2/controller/debuggees/{debuggeeId}/breakpoints",
- "httpMethod": "GET",
- "description": "Returns the list of all active breakpoints for the specified debuggee. The breakpoint specification (location, condition, and expression fields) is semantically immutable, although the field values may change. For example, an agent may update the location line number to reflect the actual line the breakpoint was set to, but that doesn't change the breakpoint semantics. Thus, an agent does not need to check if a breakpoint has changed when it encounters the same breakpoint on a successive call. Moreover, an agent should remember breakpoints that are complete until the controller removes them from the active list to avoid setting those breakpoints again.",
- "parameters": {
- "debuggeeId": {
- "type": "string",
- "description": "Identifies the debuggee.",
- "required": true,
- "location": "path"
- },
- "waitToken": {
- "type": "string",
- "description": "A wait token that, if specified, blocks the method call until the list of active breakpoints has changed, or a server selected timeout has expired. The value should be set from the last returned response. The error code google.rpc.Code.ABORTED is returned on wait timeout (which does not require the agent to re-register with the server)",
- "location": "query"
- }
- },
- "parameterOrder": [
- "debuggeeId"
- ],
- "response": {
- "$ref": "ListActiveBreakpointsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugletcontroller"
- ]
- },
- "update": {
- "id": "clouddebugger.controller.debuggees.breakpoints.update",
- "path": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}",
- "httpMethod": "PUT",
- "description": "Updates the breakpoint state or mutable fields. The entire Breakpoint protobuf must be sent back to the controller. Updates to active breakpoint fields are only allowed if the new value does not change the breakpoint specification. Updates to the 'location', 'condition' and 'expression' fields should not alter the breakpoint semantics. They are restricted to changes such as canonicalizing a value or snapping the location to the correct line of code.",
- "parameters": {
- "debuggeeId": {
- "type": "string",
- "description": "Identifies the debuggee being debugged.",
- "required": true,
- "location": "path"
- },
- "id": {
- "type": "string",
- "description": "Breakpoint identifier, unique in the scope of the debuggee.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "debuggeeId",
- "id"
- ],
- "request": {
- "$ref": "UpdateActiveBreakpointRequest"
- },
- "response": {
- "$ref": "UpdateActiveBreakpointResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugletcontroller"
- ]
- }
- }
- }
- }
- }
- }
- },
- "debugger": {
- "resources": {
- "debuggees": {
- "methods": {
- "list": {
- "id": "clouddebugger.debugger.debuggees.list",
- "path": "v2/debugger/debuggees",
- "httpMethod": "GET",
- "description": "Lists all the debuggees that the user can set breakpoints to.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Set to the project number of the Google Cloud Platform to list the debuggees that are part of that project.",
- "location": "query"
- },
- "includeInactive": {
- "type": "boolean",
- "description": "When set to true the result includes all debuggees, otherwise only debugees that are active.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "ListDebuggeesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ]
- }
- },
- "resources": {
- "breakpoints": {
- "methods": {
- "set": {
- "id": "clouddebugger.debugger.debuggees.breakpoints.set",
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/set",
- "httpMethod": "POST",
- "description": "Sets the breakpoint to the debuggee.",
- "parameters": {
- "debuggeeId": {
- "type": "string",
- "description": "The debuggee id to set the breakpoint to.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "debuggeeId"
- ],
- "request": {
- "$ref": "Breakpoint"
- },
- "response": {
- "$ref": "SetBreakpointResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ]
- },
- "get": {
- "id": "clouddebugger.debugger.debuggees.breakpoints.get",
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
- "httpMethod": "GET",
- "description": "Gets breakpoint information.",
- "parameters": {
- "debuggeeId": {
- "type": "string",
- "description": "The debuggee id to get the breakpoint from.",
- "required": true,
- "location": "path"
- },
- "breakpointId": {
- "type": "string",
- "description": "The breakpoint to get.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "debuggeeId",
- "breakpointId"
- ],
- "response": {
- "$ref": "GetBreakpointResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ]
- },
- "delete": {
- "id": "clouddebugger.debugger.debuggees.breakpoints.delete",
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
- "httpMethod": "DELETE",
- "description": "Deletes the breakpoint from the debuggee.",
- "parameters": {
- "debuggeeId": {
- "type": "string",
- "description": "The debuggee id to delete the breakpoint from.",
- "required": true,
- "location": "path"
- },
- "breakpointId": {
- "type": "string",
- "description": "The breakpoint to delete.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "debuggeeId",
- "breakpointId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ]
- },
- "list": {
- "id": "clouddebugger.debugger.debuggees.breakpoints.list",
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints",
- "httpMethod": "GET",
- "description": "Lists all breakpoints of the debuggee that the user has access to.",
- "parameters": {
- "debuggeeId": {
- "type": "string",
- "description": "The debuggee id to list breakpoint from.",
- "required": true,
- "location": "path"
- },
- "includeAllUsers": {
- "type": "boolean",
- "description": "When set to true the response includes the list of breakpoints set by any user, otherwise only breakpoints set by the caller.",
- "location": "query"
- },
- "includeInactive": {
- "type": "boolean",
- "description": "When set to true the response includes active and inactive breakpoints, otherwise only active breakpoints are returned.",
- "location": "query"
- },
- "action.value": {
- "type": "string",
- "description": "Only breakpoints with the specified action will pass the filter.",
- "enum": [
- "CAPTURE",
- "LOG"
- ],
- "location": "query"
- },
- "stripResults": {
- "type": "boolean",
- "description": "When set to true the response breakpoints will be stripped of the results fields: stack_frames, evaluated_expressions and variable_table.",
- "location": "query"
- },
- "waitToken": {
- "type": "string",
- "description": "A wait token that, if specified, blocks the call until the breakpoints list has changed, or a server selected timeout has expired. The value should be set from the last response to ListBreakpoints. The error code ABORTED is returned on wait timeout, which should be called again with the same wait_token.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "debuggeeId"
- ],
- "response": {
- "$ref": "ListBreakpointsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ]
- }
- }
- }
- }
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/clouddebugger/v2/clouddebugger-gen.go b/vendor/google.golang.org/api/clouddebugger/v2/clouddebugger-gen.go
deleted file mode 100644
index 23d0639a..00000000
--- a/vendor/google.golang.org/api/clouddebugger/v2/clouddebugger-gen.go
+++ /dev/null
@@ -1,2126 +0,0 @@
-// Package clouddebugger provides access to the Google Cloud Debugger API.
-//
-// See https://cloud.google.com/tools/cloud-debugger
-//
-// Usage example:
-//
-// import "google.golang.org/api/clouddebugger/v2"
-// ...
-// clouddebuggerService, err := clouddebugger.New(oauthHttpClient)
-package clouddebugger // import "google.golang.org/api/clouddebugger/v2"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "clouddebugger:v2"
-const apiName = "clouddebugger"
-const apiVersion = "v2"
-const basePath = "https://clouddebugger.googleapis.com/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your data across Google Cloud Platform services
- CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
-
- // Manage cloud debugger
- CloudDebuggerScope = "https://www.googleapis.com/auth/cloud_debugger"
-
- // Manage active breakpoints in cloud debugger
- CloudDebugletcontrollerScope = "https://www.googleapis.com/auth/cloud_debugletcontroller"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Controller = NewControllerService(s)
- s.Debugger = NewDebuggerService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Controller *ControllerService
-
- Debugger *DebuggerService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewControllerService(s *Service) *ControllerService {
- rs := &ControllerService{s: s}
- rs.Debuggees = NewControllerDebuggeesService(s)
- return rs
-}
-
-type ControllerService struct {
- s *Service
-
- Debuggees *ControllerDebuggeesService
-}
-
-func NewControllerDebuggeesService(s *Service) *ControllerDebuggeesService {
- rs := &ControllerDebuggeesService{s: s}
- rs.Breakpoints = NewControllerDebuggeesBreakpointsService(s)
- return rs
-}
-
-type ControllerDebuggeesService struct {
- s *Service
-
- Breakpoints *ControllerDebuggeesBreakpointsService
-}
-
-func NewControllerDebuggeesBreakpointsService(s *Service) *ControllerDebuggeesBreakpointsService {
- rs := &ControllerDebuggeesBreakpointsService{s: s}
- return rs
-}
-
-type ControllerDebuggeesBreakpointsService struct {
- s *Service
-}
-
-func NewDebuggerService(s *Service) *DebuggerService {
- rs := &DebuggerService{s: s}
- rs.Debuggees = NewDebuggerDebuggeesService(s)
- return rs
-}
-
-type DebuggerService struct {
- s *Service
-
- Debuggees *DebuggerDebuggeesService
-}
-
-func NewDebuggerDebuggeesService(s *Service) *DebuggerDebuggeesService {
- rs := &DebuggerDebuggeesService{s: s}
- rs.Breakpoints = NewDebuggerDebuggeesBreakpointsService(s)
- return rs
-}
-
-type DebuggerDebuggeesService struct {
- s *Service
-
- Breakpoints *DebuggerDebuggeesBreakpointsService
-}
-
-func NewDebuggerDebuggeesBreakpointsService(s *Service) *DebuggerDebuggeesBreakpointsService {
- rs := &DebuggerDebuggeesBreakpointsService{s: s}
- return rs
-}
-
-type DebuggerDebuggeesBreakpointsService struct {
- s *Service
-}
-
-// Breakpoint: Represents the breakpoint specification, status and
-// results.
-type Breakpoint struct {
- // Action: Defines what to do when the breakpoint hits.
- //
- // Possible values:
- // "CAPTURE"
- // "LOG"
- Action string `json:"action,omitempty"`
-
- // Condition: A condition to trigger the breakpoint. The condition is a
- // compound boolean expression composed using expressions in a
- // programming language at the source location.
- Condition string `json:"condition,omitempty"`
-
- // CreateTime: The time this breakpoint was created by the server. The
- // value is in seconds resolution.
- CreateTime string `json:"createTime,omitempty"`
-
- // EvaluatedExpressions: The evaluated expressions' values at breakpoint
- // time. The evaluated expressions appear in exactly the same order they
- // are listed in the 'expressions' field. The 'name' field holds the
- // original expression text, the 'value'/'members' field holds the
- // result of the evaluated expression. If the expression can not be
- // evaluated, an error text is placed in the value field.
- EvaluatedExpressions []*Variable `json:"evaluatedExpressions,omitempty"`
-
- // Expressions: A list of read-only expressions to evaluate at the
- // breakpoint location. The expressions are composed using expressions
- // in the programming language at the source location. If the breakpoint
- // action is "LOG", the evaluated expressions are included in log
- // statements.
- Expressions []string `json:"expressions,omitempty"`
-
- // FinalTime: The time this breakpoint was finalized as seen by the
- // server. The value is in seconds resolution.
- FinalTime string `json:"finalTime,omitempty"`
-
- // Id: Breakpoint identifier, unique in the scope of the debuggee.
- Id string `json:"id,omitempty"`
-
- // IsFinalState: When true, indicates that this is a final result and
- // the breakpoint state will not change from here on.
- IsFinalState bool `json:"isFinalState,omitempty"`
-
- // Location: The breakpoint source location.
- Location *SourceLocation `json:"location,omitempty"`
-
- // LogLevel: Indicates the severity of the log. Only relevant when
- // action is "LOG".
- //
- // Possible values:
- // "INFO"
- // "WARNING"
- // "ERROR"
- LogLevel string `json:"logLevel,omitempty"`
-
- // LogMessageFormat: Only relevant when action is "LOG". Defines the
- // message to log when the breakpoint hits. The message may include
- // parameter placeholders "$0", "$1", etc. These placeholders will be
- // replaced with the evaluated value of the appropriate expression.
- // Expressions not referenced in "log_message_format" will not be
- // logged. Example: "Poisonous message received, id = $0, count = $1"
- // with expressions = [ "message.id", "message.count" ].
- LogMessageFormat string `json:"logMessageFormat,omitempty"`
-
- // StackFrames: The stack at breakpoint time.
- StackFrames []*StackFrame `json:"stackFrames,omitempty"`
-
- // Status: Breakpoint status. The status includes an error flag and a
- // human readable message. This field will usually stay unset. The
- // message can be either informational or error. Nevertheless, clients
- // should always display the text message back to the user. Error status
- // of a breakpoint indicates complete failure. Example (non-final
- // state): 'Still loading symbols...' Examples (final state): 'Failed to
- // insert breakpoint' referring to breakpoint, 'Field f not found in
- // class C' referring to condition, ...
- Status *StatusMessage `json:"status,omitempty"`
-
- // UserEmail: The e-mail of the user that created this breakpoint
- UserEmail string `json:"userEmail,omitempty"`
-
- // VariableTable: The variable_table exists to aid with computation,
- // memory and network traffic optimization. It enables storing a
- // variable once and reference it from multiple variables, including
- // variables stored in the variable_table itself. For example, the
- // object 'this', which may appear at many levels of the stack, can have
- // all of it's data stored once in this table. The stack frame variables
- // then would hold only a reference to it. The variable var_index field
- // is an index into this repeated field. The stored objects are nameless
- // and get their name from the referencing variable. The effective
- // variable is a merge of the referencing veariable and the referenced
- // variable.
- VariableTable []*Variable `json:"variableTable,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Action") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Breakpoint) MarshalJSON() ([]byte, error) {
- type noMethod Breakpoint
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CloudRepoSourceContext: A CloudRepoSourceContext denotes a particular
-// revision in a cloud repo (a repo hosted by the Google Cloud
-// Platform).
-type CloudRepoSourceContext struct {
- // AliasName: The name of an alias (branch, tag, etc.).
- AliasName string `json:"aliasName,omitempty"`
-
- // RepoId: The ID of the repo.
- RepoId *RepoId `json:"repoId,omitempty"`
-
- // RevisionId: A revision ID.
- RevisionId string `json:"revisionId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AliasName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CloudRepoSourceContext) MarshalJSON() ([]byte, error) {
- type noMethod CloudRepoSourceContext
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CloudWorkspaceId: A CloudWorkspaceId is a unique identifier for a
-// cloud workspace. A cloud workspace is a place associated with a repo
-// where modified files can be stored before they are committed.
-type CloudWorkspaceId struct {
- // Name: The unique name of the workspace within the repo. This is the
- // name chosen by the client in the Source API's CreateWorkspace method.
- Name string `json:"name,omitempty"`
-
- // RepoId: The ID of the repo containing the workspace.
- RepoId *RepoId `json:"repoId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Name") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CloudWorkspaceId) MarshalJSON() ([]byte, error) {
- type noMethod CloudWorkspaceId
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CloudWorkspaceSourceContext: A CloudWorkspaceSourceContext denotes a
-// workspace at a particular snapshot.
-type CloudWorkspaceSourceContext struct {
- // SnapshotId: The ID of the snapshot. An empty snapshot_id refers to
- // the most recent snapshot.
- SnapshotId string `json:"snapshotId,omitempty"`
-
- // WorkspaceId: The ID of the workspace.
- WorkspaceId *CloudWorkspaceId `json:"workspaceId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "SnapshotId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CloudWorkspaceSourceContext) MarshalJSON() ([]byte, error) {
- type noMethod CloudWorkspaceSourceContext
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Debuggee: Represents the application to debug. The application may
-// include one or more replicated processes executing the same code.
-// Each of these processes is attached with a debugger agent, carrying
-// out the debugging commands. The agents attached to the same debuggee
-// are identified by using exactly the same fields' values when
-// registering.
-type Debuggee struct {
- // AgentVersion: Version ID of the agent release. The version ID is
- // structured as following: "domain/type/vmajor.minor" (for example
- // "google.com/gcp-java/v1.1").
- AgentVersion string `json:"agentVersion,omitempty"`
-
- // Description: A human readable description of the debuggee.
- // Recommended to include human readable project name, environment name,
- // and version information .
- Description string `json:"description,omitempty"`
-
- // Id: Debuggee unique identifer generated by the server.
- Id string `json:"id,omitempty"`
-
- // IsDisabled: If set to true, indicates that the agent should disable
- // itself and detach from the debuggee.
- IsDisabled bool `json:"isDisabled,omitempty"`
-
- // IsInactive: If set to true indicates that the debuggee has not been
- // seen by the Controller service in the last active time period
- // (defined by the server).
- IsInactive bool `json:"isInactive,omitempty"`
-
- // Labels: A set of custom debuggee properties, populated by the agent,
- // to be displayed to the user.
- Labels map[string]string `json:"labels,omitempty"`
-
- // Project: The project the debuggee is associated with. Use the project
- // number when registering a Google Cloud Platform project.
- Project string `json:"project,omitempty"`
-
- // SourceContexts: Repository snapshots containing the source code of
- // the project.
- SourceContexts []*SourceContext `json:"sourceContexts,omitempty"`
-
- // Status: Human readable message to be displayed to the user about this
- // debuggee. Absense of this field indicates no message. The message can
- // be either informational or error.
- Status *StatusMessage `json:"status,omitempty"`
-
- // Uniquifier: The debuggee uniqifier within the project. Any string
- // that id the application within the project can be used. Recomended to
- // include environement and version or build id's.
- Uniquifier string `json:"uniquifier,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AgentVersion") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Debuggee) MarshalJSON() ([]byte, error) {
- type noMethod Debuggee
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Empty: A generic empty message that you can re-use to avoid defining
-// duplicated empty messages in your APIs. A typical example is to use
-// it as the request or the response type of an API method. For
-// instance: service Foo { rpc Bar(google.protobuf.Empty) returns
-// (google.protobuf.Empty); } The JSON representation for `Empty` is
-// empty JSON object `{}`.
-type Empty struct {
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-}
-
-// FormatMessage: Represents a message with parameters.
-type FormatMessage struct {
- // Format: Format template of the message. The "format" uses
- // placeholders "$0", "$1", etc. to reference parameters. "$$" can be
- // used to denote the '$' character. Examples: "Failed to load '$0'
- // which helps debug $1 the first time it is loaded. Again, $0 is very
- // important." "Please pay $$10 to use $0 instead of $1."
- Format string `json:"format,omitempty"`
-
- // Parameters: Optional parameters to be embedded into the message.
- Parameters []string `json:"parameters,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Format") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FormatMessage) MarshalJSON() ([]byte, error) {
- type noMethod FormatMessage
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// GerritSourceContext: A SourceContext referring to a Gerrit project.
-type GerritSourceContext struct {
- // AliasName: The name of an alias (branch, tag, etc.).
- AliasName string `json:"aliasName,omitempty"`
-
- // GerritProject: The full project name within the host. Projects may be
- // nested, so "project/subproject" is a valid project name. The "repo
- // name" is hostURI/project.
- GerritProject string `json:"gerritProject,omitempty"`
-
- // HostUri: The URI of a running Gerrit instance.
- HostUri string `json:"hostUri,omitempty"`
-
- // RevisionId: A revision (commit) ID.
- RevisionId string `json:"revisionId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AliasName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GerritSourceContext) MarshalJSON() ([]byte, error) {
- type noMethod GerritSourceContext
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// GetBreakpointResponse: The response of getting breakpoint
-// information.
-type GetBreakpointResponse struct {
- // Breakpoint: The complete breakpoint state. The fields 'id' and
- // 'location' are guranteed to be set.
- Breakpoint *Breakpoint `json:"breakpoint,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Breakpoint") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GetBreakpointResponse) MarshalJSON() ([]byte, error) {
- type noMethod GetBreakpointResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// GitSourceContext: A GitSourceContext denotes a particular revision in
-// a third party Git repository (e.g. GitHub).
-type GitSourceContext struct {
- // RevisionId: Git commit hash. required.
- RevisionId string `json:"revisionId,omitempty"`
-
- // Url: Git repository URL.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "RevisionId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GitSourceContext) MarshalJSON() ([]byte, error) {
- type noMethod GitSourceContext
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListActiveBreakpointsResponse: The response of listing active
-// breakpoints.
-type ListActiveBreakpointsResponse struct {
- // Breakpoints: List of all active breakpoints. The fields 'id' and
- // 'location' are guranteed to be set on each breakpoint.
- Breakpoints []*Breakpoint `json:"breakpoints,omitempty"`
-
- // NextWaitToken: A wait token that can be used in the next method call
- // to block until the list of breakpoints changes.
- NextWaitToken string `json:"nextWaitToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Breakpoints") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListActiveBreakpointsResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListActiveBreakpointsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListBreakpointsResponse: The response of listing breakpoints.
-type ListBreakpointsResponse struct {
- // Breakpoints: List of all breakpoints with complete state. The fields
- // 'id' and 'location' are guranteed to be set on each breakpoint.
- Breakpoints []*Breakpoint `json:"breakpoints,omitempty"`
-
- // NextWaitToken: A wait token that can be used in the next call to
- // ListBreakpoints to block until the list of breakpoints has changes.
- NextWaitToken string `json:"nextWaitToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Breakpoints") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListBreakpointsResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListBreakpointsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListDebuggeesResponse: The response of listing debuggees.
-type ListDebuggeesResponse struct {
- // Debuggees: The list of debuggees accessible to the calling user. Note
- // that the description field is the only human readable field that
- // should be displayed to the user. The fields 'debuggee.id' and
- // 'description' are guranteed to be set on each debuggee.
- Debuggees []*Debuggee `json:"debuggees,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Debuggees") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListDebuggeesResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListDebuggeesResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ProjectRepoId: Selects a repo using a Google Cloud Platform project
-// ID (e.g. winged-cargo-31) and a repo name within that project.
-type ProjectRepoId struct {
- // ProjectId: The ID of the project.
- ProjectId string `json:"projectId,omitempty"`
-
- // RepoName: The name of the repo. Leave empty for the default repo.
- RepoName string `json:"repoName,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ProjectId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProjectRepoId) MarshalJSON() ([]byte, error) {
- type noMethod ProjectRepoId
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// RegisterDebuggeeRequest: The request to register a debuggee.
-type RegisterDebuggeeRequest struct {
- // Debuggee: The debuggee information to register. The fields 'project',
- // 'uniquifier', 'description' and 'agent_version' of the debuggee must
- // be set.
- Debuggee *Debuggee `json:"debuggee,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Debuggee") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RegisterDebuggeeRequest) MarshalJSON() ([]byte, error) {
- type noMethod RegisterDebuggeeRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// RegisterDebuggeeResponse: The response of registering a debuggee.
-type RegisterDebuggeeResponse struct {
- // Debuggee: The debuggee resource. The field 'id' is guranteed to be
- // set (in addition to the echoed fields).
- Debuggee *Debuggee `json:"debuggee,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Debuggee") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RegisterDebuggeeResponse) MarshalJSON() ([]byte, error) {
- type noMethod RegisterDebuggeeResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// RepoId: A unique identifier for a cloud repo.
-type RepoId struct {
- // ProjectRepoId: A combination of a project ID and a repo name.
- ProjectRepoId *ProjectRepoId `json:"projectRepoId,omitempty"`
-
- // Uid: A server-assigned, globally unique identifier.
- Uid string `json:"uid,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ProjectRepoId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RepoId) MarshalJSON() ([]byte, error) {
- type noMethod RepoId
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SetBreakpointResponse: The response of setting a breakpoint.
-type SetBreakpointResponse struct {
- // Breakpoint: The breakpoint resource. The field 'id' is guranteed to
- // be set (in addition to the echoed fileds).
- Breakpoint *Breakpoint `json:"breakpoint,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Breakpoint") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SetBreakpointResponse) MarshalJSON() ([]byte, error) {
- type noMethod SetBreakpointResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SourceContext: A SourceContext is a reference to a tree of files. A
-// SourceContext together with a path point to a unique revision of a
-// single file or directory.
-type SourceContext struct {
- // CloudRepo: A SourceContext referring to a revision in a cloud repo.
- CloudRepo *CloudRepoSourceContext `json:"cloudRepo,omitempty"`
-
- // CloudWorkspace: A SourceContext referring to a snapshot in a cloud
- // workspace.
- CloudWorkspace *CloudWorkspaceSourceContext `json:"cloudWorkspace,omitempty"`
-
- // Gerrit: A SourceContext referring to a Gerrit project.
- Gerrit *GerritSourceContext `json:"gerrit,omitempty"`
-
- // Git: A SourceContext referring to any third party Git repo (e.g.
- // GitHub).
- Git *GitSourceContext `json:"git,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CloudRepo") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SourceContext) MarshalJSON() ([]byte, error) {
- type noMethod SourceContext
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SourceLocation: Represents a location in the source code.
-type SourceLocation struct {
- // Line: The line inside the file (first line value is '1').
- Line int64 `json:"line,omitempty"`
-
- // Path: A path to the source file within the source context of the
- // target binary.
- Path string `json:"path,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Line") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SourceLocation) MarshalJSON() ([]byte, error) {
- type noMethod SourceLocation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// StackFrame: Represents a stack frame context.
-type StackFrame struct {
- // Arguments: The set of arguments passed to this function Note that
- // this might not be populated for all stack frames.
- Arguments []*Variable `json:"arguments,omitempty"`
-
- // Function: The unmangled function name at the call site.
- Function string `json:"function,omitempty"`
-
- // Locals: The set of local variables at the stack frame location. Note
- // that this might not be populated for all stack frames.
- Locals []*Variable `json:"locals,omitempty"`
-
- // Location: The source location of the call site.
- Location *SourceLocation `json:"location,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Arguments") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *StackFrame) MarshalJSON() ([]byte, error) {
- type noMethod StackFrame
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// StatusMessage: Represents a contextual status message. The message
-// can indicate an error or informational status, and refer to specific
-// parts of the containing object. For example, the Breakpoint.status
-// field can indicate an error referring to the
-// BREAKPOINT_SOURCE_LOCATION with the message "Location not found".
-type StatusMessage struct {
- // Description: Status message text.
- Description *FormatMessage `json:"description,omitempty"`
-
- // IsError: Distinguishes errors from informational messages.
- IsError bool `json:"isError,omitempty"`
-
- // RefersTo: Reference to which the message applies.
- //
- // Possible values:
- // "UNSPECIFIED"
- // "BREAKPOINT_SOURCE_LOCATION"
- // "BREAKPOINT_CONDITION"
- // "BREAKPOINT_EXPRESSION"
- // "VARIABLE_NAME"
- // "VARIABLE_VALUE"
- RefersTo string `json:"refersTo,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Description") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *StatusMessage) MarshalJSON() ([]byte, error) {
- type noMethod StatusMessage
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UpdateActiveBreakpointRequest: The request to update an active
-// breakpoint.
-type UpdateActiveBreakpointRequest struct {
- // Breakpoint: The updated breakpoint information. The field 'id' must
- // be set.
- Breakpoint *Breakpoint `json:"breakpoint,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Breakpoint") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UpdateActiveBreakpointRequest) MarshalJSON() ([]byte, error) {
- type noMethod UpdateActiveBreakpointRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UpdateActiveBreakpointResponse: The response of updating an active
-// breakpoint. The message is defined to allow future extensions.
-type UpdateActiveBreakpointResponse struct {
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-}
-
-// Variable: Represents a variable or an argument possibly of a compound
-// object type. 1. A simple variable such as, int x = 5 is represented
-// as: { name: "x", value: "5" } 2. A compound object such as, struct T
-// { int m1; int m2; }; T x = { 3, 7 }; is represented as: { name: "x",
-// members { name: "m1", value: "3" }, members { name: "m2", value: "7"
-// } } 3. A pointer where the pointee was captured such as, T x = { 3, 7
-// }; T* p = &x; is represented as: { name: "p", value: "0x00500500",
-// members { name: "m1", value: "3" }, members { name: "m2", value: "7"
-// } } 4. A pointer where the pointee was not captured or is
-// inaccessible such as, T* p = new T; is represented as: { name: "p",
-// value: "0x00400400", members { value: "" } } the value text should
-// decribe the reason for the missing value. such as , ,
-// . note that a null pointer should not have members. 5. An unnamed
-// value such as, int* p = new int(7); is represented as, { name: "p",
-// value: "0x00500500", members { value: "7" } } 6. An unnamed pointer
-// where the pointee was not captured such as, int* p = new int(7);
-// int** pp = &p; is represented as: { name: "pp", value: "0x00500500",
-// members { value: "0x00400400", members { value: "" } } } To optimize
-// computation, memory and network traffic, variables that repeat in the
-// output multiple times can be stored once in a shared variable table
-// and be referenced using the var_index field. The variables stored in
-// the shared table are nameless and are essentially a partition of the
-// complete variable. To reconstruct the complete variable merge the
-// referencing variable with the referenced variable. When using the
-// shared variable table, variables can be represented as: T x = { 3, 7
-// }; T* p = &x; T& r = x; are represented as, { name: "x", var_index: 3
-// } { name: "p", value "0x00500500", var_index: 3 } { name: "r",
-// var_index: 3 } with shared variable table entry #3: { members { name:
-// "m1", value: "3" }, members { name: "m2", value: "7" } } Note that
-// the pointer address is stored with the referencing variable and not
-// with the referenced variable, to allow the referenced variable to be
-// shared between pointer and references.
-type Variable struct {
- // Members: The members contained or pointed to by the variable.
- Members []*Variable `json:"members,omitempty"`
-
- // Name: The name of the variable, if any.
- Name string `json:"name,omitempty"`
-
- // Status: Status associated with the variable. This field will usually
- // stay unset. A status of a single variable only applies to that
- // variable or expression. The rest of breakpoint data still remains
- // valid. Variables might be reported in error state even when
- // breakpoint is not in final state. The message may refer to variable
- // name with "refers_to" set to "VARIABLE_NAME". Alternatively
- // "refers_to" will be set to "VARIABLE_VALUE". In either case variable
- // value and members will be unset. Example of error message applied to
- // name: "Invalid expression syntax". Example of information message
- // applied to value: "Not captured". Examples of error message applied
- // to value: "Malformed string", "Field f not found in class C", "Null
- // pointer dereference".
- Status *StatusMessage `json:"status,omitempty"`
-
- // Value: The simple value of the variable.
- Value string `json:"value,omitempty"`
-
- // VarTableIndex: This is a reference to a variable in the shared
- // variable table. More than one variable can reference the same
- // variable in the table. The var_index field is an index into
- // variable_table in Breakpoint.
- VarTableIndex int64 `json:"varTableIndex,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Members") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Variable) MarshalJSON() ([]byte, error) {
- type noMethod Variable
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "clouddebugger.controller.debuggees.register":
-
-type ControllerDebuggeesRegisterCall struct {
- s *Service
- registerdebuggeerequest *RegisterDebuggeeRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Register: Registers the debuggee with the controller. All agents
-// should call this API with the same request content to get back the
-// same stable 'debuggee_id'. Agents should call this API again whenever
-// ListActiveBreakpoints or UpdateActiveBreakpoint return the error
-// google.rpc.Code.NOT_FOUND. It allows the server to disable the agent
-// or recover from any registration loss. If the debuggee is disabled
-// server, the response will have is_disabled' set to true.
-func (r *ControllerDebuggeesService) Register(registerdebuggeerequest *RegisterDebuggeeRequest) *ControllerDebuggeesRegisterCall {
- c := &ControllerDebuggeesRegisterCall{s: r.s, opt_: make(map[string]interface{})}
- c.registerdebuggeerequest = registerdebuggeerequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ControllerDebuggeesRegisterCall) Fields(s ...googleapi.Field) *ControllerDebuggeesRegisterCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ControllerDebuggeesRegisterCall) Context(ctx context.Context) *ControllerDebuggeesRegisterCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ControllerDebuggeesRegisterCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.registerdebuggeerequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v2/controller/debuggees/register")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouddebugger.controller.debuggees.register" call.
-// Exactly one of *RegisterDebuggeeResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *RegisterDebuggeeResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ControllerDebuggeesRegisterCall) Do() (*RegisterDebuggeeResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &RegisterDebuggeeResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Registers the debuggee with the controller. All agents should call this API with the same request content to get back the same stable 'debuggee_id'. Agents should call this API again whenever ListActiveBreakpoints or UpdateActiveBreakpoint return the error google.rpc.Code.NOT_FOUND. It allows the server to disable the agent or recover from any registration loss. If the debuggee is disabled server, the response will have is_disabled' set to true.",
- // "httpMethod": "POST",
- // "id": "clouddebugger.controller.debuggees.register",
- // "path": "v2/controller/debuggees/register",
- // "request": {
- // "$ref": "RegisterDebuggeeRequest"
- // },
- // "response": {
- // "$ref": "RegisterDebuggeeResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud_debugletcontroller"
- // ]
- // }
-
-}
-
-// method id "clouddebugger.controller.debuggees.breakpoints.list":
-
-type ControllerDebuggeesBreakpointsListCall struct {
- s *Service
- debuggeeId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Returns the list of all active breakpoints for the specified
-// debuggee. The breakpoint specification (location, condition, and
-// expression fields) is semantically immutable, although the field
-// values may change. For example, an agent may update the location line
-// number to reflect the actual line the breakpoint was set to, but that
-// doesn't change the breakpoint semantics. Thus, an agent does not need
-// to check if a breakpoint has changed when it encounters the same
-// breakpoint on a successive call. Moreover, an agent should remember
-// breakpoints that are complete until the controller removes them from
-// the active list to avoid setting those breakpoints again.
-func (r *ControllerDebuggeesBreakpointsService) List(debuggeeId string) *ControllerDebuggeesBreakpointsListCall {
- c := &ControllerDebuggeesBreakpointsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.debuggeeId = debuggeeId
- return c
-}
-
-// WaitToken sets the optional parameter "waitToken": A wait token that,
-// if specified, blocks the method call until the list of active
-// breakpoints has changed, or a server selected timeout has expired.
-// The value should be set from the last returned response. The error
-// code google.rpc.Code.ABORTED is returned on wait timeout (which does
-// not require the agent to re-register with the server)
-func (c *ControllerDebuggeesBreakpointsListCall) WaitToken(waitToken string) *ControllerDebuggeesBreakpointsListCall {
- c.opt_["waitToken"] = waitToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ControllerDebuggeesBreakpointsListCall) Fields(s ...googleapi.Field) *ControllerDebuggeesBreakpointsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ControllerDebuggeesBreakpointsListCall) IfNoneMatch(entityTag string) *ControllerDebuggeesBreakpointsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ControllerDebuggeesBreakpointsListCall) Context(ctx context.Context) *ControllerDebuggeesBreakpointsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ControllerDebuggeesBreakpointsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["waitToken"]; ok {
- params.Set("waitToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v2/controller/debuggees/{debuggeeId}/breakpoints")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "debuggeeId": c.debuggeeId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouddebugger.controller.debuggees.breakpoints.list" call.
-// Exactly one of *ListActiveBreakpointsResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *ListActiveBreakpointsResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ControllerDebuggeesBreakpointsListCall) Do() (*ListActiveBreakpointsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ListActiveBreakpointsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the list of all active breakpoints for the specified debuggee. The breakpoint specification (location, condition, and expression fields) is semantically immutable, although the field values may change. For example, an agent may update the location line number to reflect the actual line the breakpoint was set to, but that doesn't change the breakpoint semantics. Thus, an agent does not need to check if a breakpoint has changed when it encounters the same breakpoint on a successive call. Moreover, an agent should remember breakpoints that are complete until the controller removes them from the active list to avoid setting those breakpoints again.",
- // "httpMethod": "GET",
- // "id": "clouddebugger.controller.debuggees.breakpoints.list",
- // "parameterOrder": [
- // "debuggeeId"
- // ],
- // "parameters": {
- // "debuggeeId": {
- // "description": "Identifies the debuggee.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "waitToken": {
- // "description": "A wait token that, if specified, blocks the method call until the list of active breakpoints has changed, or a server selected timeout has expired. The value should be set from the last returned response. The error code google.rpc.Code.ABORTED is returned on wait timeout (which does not require the agent to re-register with the server)",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "v2/controller/debuggees/{debuggeeId}/breakpoints",
- // "response": {
- // "$ref": "ListActiveBreakpointsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud_debugletcontroller"
- // ]
- // }
-
-}
-
-// method id "clouddebugger.controller.debuggees.breakpoints.update":
-
-type ControllerDebuggeesBreakpointsUpdateCall struct {
- s *Service
- debuggeeId string
- id string
- updateactivebreakpointrequest *UpdateActiveBreakpointRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates the breakpoint state or mutable fields. The entire
-// Breakpoint protobuf must be sent back to the controller. Updates to
-// active breakpoint fields are only allowed if the new value does not
-// change the breakpoint specification. Updates to the 'location',
-// 'condition' and 'expression' fields should not alter the breakpoint
-// semantics. They are restricted to changes such as canonicalizing a
-// value or snapping the location to the correct line of code.
-func (r *ControllerDebuggeesBreakpointsService) Update(debuggeeId string, id string, updateactivebreakpointrequest *UpdateActiveBreakpointRequest) *ControllerDebuggeesBreakpointsUpdateCall {
- c := &ControllerDebuggeesBreakpointsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.debuggeeId = debuggeeId
- c.id = id
- c.updateactivebreakpointrequest = updateactivebreakpointrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ControllerDebuggeesBreakpointsUpdateCall) Fields(s ...googleapi.Field) *ControllerDebuggeesBreakpointsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ControllerDebuggeesBreakpointsUpdateCall) Context(ctx context.Context) *ControllerDebuggeesBreakpointsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ControllerDebuggeesBreakpointsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.updateactivebreakpointrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "debuggeeId": c.debuggeeId,
- "id": c.id,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouddebugger.controller.debuggees.breakpoints.update" call.
-// Exactly one of *UpdateActiveBreakpointResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *UpdateActiveBreakpointResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ControllerDebuggeesBreakpointsUpdateCall) Do() (*UpdateActiveBreakpointResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UpdateActiveBreakpointResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates the breakpoint state or mutable fields. The entire Breakpoint protobuf must be sent back to the controller. Updates to active breakpoint fields are only allowed if the new value does not change the breakpoint specification. Updates to the 'location', 'condition' and 'expression' fields should not alter the breakpoint semantics. They are restricted to changes such as canonicalizing a value or snapping the location to the correct line of code.",
- // "httpMethod": "PUT",
- // "id": "clouddebugger.controller.debuggees.breakpoints.update",
- // "parameterOrder": [
- // "debuggeeId",
- // "id"
- // ],
- // "parameters": {
- // "debuggeeId": {
- // "description": "Identifies the debuggee being debugged.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "id": {
- // "description": "Breakpoint identifier, unique in the scope of the debuggee.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}",
- // "request": {
- // "$ref": "UpdateActiveBreakpointRequest"
- // },
- // "response": {
- // "$ref": "UpdateActiveBreakpointResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud_debugletcontroller"
- // ]
- // }
-
-}
-
-// method id "clouddebugger.debugger.debuggees.list":
-
-type DebuggerDebuggeesListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all the debuggees that the user can set breakpoints to.
-func (r *DebuggerDebuggeesService) List() *DebuggerDebuggeesListCall {
- c := &DebuggerDebuggeesListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// IncludeInactive sets the optional parameter "includeInactive": When
-// set to true the result includes all debuggees, otherwise only
-// debugees that are active.
-func (c *DebuggerDebuggeesListCall) IncludeInactive(includeInactive bool) *DebuggerDebuggeesListCall {
- c.opt_["includeInactive"] = includeInactive
- return c
-}
-
-// Project sets the optional parameter "project": Set to the project
-// number of the Google Cloud Platform to list the debuggees that are
-// part of that project.
-func (c *DebuggerDebuggeesListCall) Project(project string) *DebuggerDebuggeesListCall {
- c.opt_["project"] = project
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DebuggerDebuggeesListCall) Fields(s ...googleapi.Field) *DebuggerDebuggeesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DebuggerDebuggeesListCall) IfNoneMatch(entityTag string) *DebuggerDebuggeesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DebuggerDebuggeesListCall) Context(ctx context.Context) *DebuggerDebuggeesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DebuggerDebuggeesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["includeInactive"]; ok {
- params.Set("includeInactive", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["project"]; ok {
- params.Set("project", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v2/debugger/debuggees")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouddebugger.debugger.debuggees.list" call.
-// Exactly one of *ListDebuggeesResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ListDebuggeesResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DebuggerDebuggeesListCall) Do() (*ListDebuggeesResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ListDebuggeesResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all the debuggees that the user can set breakpoints to.",
- // "httpMethod": "GET",
- // "id": "clouddebugger.debugger.debuggees.list",
- // "parameters": {
- // "includeInactive": {
- // "description": "When set to true the result includes all debuggees, otherwise only debugees that are active.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "project": {
- // "description": "Set to the project number of the Google Cloud Platform to list the debuggees that are part of that project.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "v2/debugger/debuggees",
- // "response": {
- // "$ref": "ListDebuggeesResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud_debugger"
- // ]
- // }
-
-}
-
-// method id "clouddebugger.debugger.debuggees.breakpoints.delete":
-
-type DebuggerDebuggeesBreakpointsDeleteCall struct {
- s *Service
- debuggeeId string
- breakpointId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the breakpoint from the debuggee.
-func (r *DebuggerDebuggeesBreakpointsService) Delete(debuggeeId string, breakpointId string) *DebuggerDebuggeesBreakpointsDeleteCall {
- c := &DebuggerDebuggeesBreakpointsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.debuggeeId = debuggeeId
- c.breakpointId = breakpointId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DebuggerDebuggeesBreakpointsDeleteCall) Fields(s ...googleapi.Field) *DebuggerDebuggeesBreakpointsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DebuggerDebuggeesBreakpointsDeleteCall) Context(ctx context.Context) *DebuggerDebuggeesBreakpointsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DebuggerDebuggeesBreakpointsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "debuggeeId": c.debuggeeId,
- "breakpointId": c.breakpointId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouddebugger.debugger.debuggees.breakpoints.delete" call.
-// Exactly one of *Empty or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Empty.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *DebuggerDebuggeesBreakpointsDeleteCall) Do() (*Empty, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Empty{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the breakpoint from the debuggee.",
- // "httpMethod": "DELETE",
- // "id": "clouddebugger.debugger.debuggees.breakpoints.delete",
- // "parameterOrder": [
- // "debuggeeId",
- // "breakpointId"
- // ],
- // "parameters": {
- // "breakpointId": {
- // "description": "The breakpoint to delete.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "debuggeeId": {
- // "description": "The debuggee id to delete the breakpoint from.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
- // "response": {
- // "$ref": "Empty"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud_debugger"
- // ]
- // }
-
-}
-
-// method id "clouddebugger.debugger.debuggees.breakpoints.get":
-
-type DebuggerDebuggeesBreakpointsGetCall struct {
- s *Service
- debuggeeId string
- breakpointId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets breakpoint information.
-func (r *DebuggerDebuggeesBreakpointsService) Get(debuggeeId string, breakpointId string) *DebuggerDebuggeesBreakpointsGetCall {
- c := &DebuggerDebuggeesBreakpointsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.debuggeeId = debuggeeId
- c.breakpointId = breakpointId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DebuggerDebuggeesBreakpointsGetCall) Fields(s ...googleapi.Field) *DebuggerDebuggeesBreakpointsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DebuggerDebuggeesBreakpointsGetCall) IfNoneMatch(entityTag string) *DebuggerDebuggeesBreakpointsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DebuggerDebuggeesBreakpointsGetCall) Context(ctx context.Context) *DebuggerDebuggeesBreakpointsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DebuggerDebuggeesBreakpointsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "debuggeeId": c.debuggeeId,
- "breakpointId": c.breakpointId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouddebugger.debugger.debuggees.breakpoints.get" call.
-// Exactly one of *GetBreakpointResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *GetBreakpointResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DebuggerDebuggeesBreakpointsGetCall) Do() (*GetBreakpointResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &GetBreakpointResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets breakpoint information.",
- // "httpMethod": "GET",
- // "id": "clouddebugger.debugger.debuggees.breakpoints.get",
- // "parameterOrder": [
- // "debuggeeId",
- // "breakpointId"
- // ],
- // "parameters": {
- // "breakpointId": {
- // "description": "The breakpoint to get.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "debuggeeId": {
- // "description": "The debuggee id to get the breakpoint from.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
- // "response": {
- // "$ref": "GetBreakpointResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud_debugger"
- // ]
- // }
-
-}
-
-// method id "clouddebugger.debugger.debuggees.breakpoints.list":
-
-type DebuggerDebuggeesBreakpointsListCall struct {
- s *Service
- debuggeeId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all breakpoints of the debuggee that the user has access
-// to.
-func (r *DebuggerDebuggeesBreakpointsService) List(debuggeeId string) *DebuggerDebuggeesBreakpointsListCall {
- c := &DebuggerDebuggeesBreakpointsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.debuggeeId = debuggeeId
- return c
-}
-
-// ActionValue sets the optional parameter "action.value": Only
-// breakpoints with the specified action will pass the filter.
-//
-// Possible values:
-// "CAPTURE"
-// "LOG"
-func (c *DebuggerDebuggeesBreakpointsListCall) ActionValue(actionValue string) *DebuggerDebuggeesBreakpointsListCall {
- c.opt_["action.value"] = actionValue
- return c
-}
-
-// IncludeAllUsers sets the optional parameter "includeAllUsers": When
-// set to true the response includes the list of breakpoints set by any
-// user, otherwise only breakpoints set by the caller.
-func (c *DebuggerDebuggeesBreakpointsListCall) IncludeAllUsers(includeAllUsers bool) *DebuggerDebuggeesBreakpointsListCall {
- c.opt_["includeAllUsers"] = includeAllUsers
- return c
-}
-
-// IncludeInactive sets the optional parameter "includeInactive": When
-// set to true the response includes active and inactive breakpoints,
-// otherwise only active breakpoints are returned.
-func (c *DebuggerDebuggeesBreakpointsListCall) IncludeInactive(includeInactive bool) *DebuggerDebuggeesBreakpointsListCall {
- c.opt_["includeInactive"] = includeInactive
- return c
-}
-
-// StripResults sets the optional parameter "stripResults": When set to
-// true the response breakpoints will be stripped of the results fields:
-// stack_frames, evaluated_expressions and variable_table.
-func (c *DebuggerDebuggeesBreakpointsListCall) StripResults(stripResults bool) *DebuggerDebuggeesBreakpointsListCall {
- c.opt_["stripResults"] = stripResults
- return c
-}
-
-// WaitToken sets the optional parameter "waitToken": A wait token that,
-// if specified, blocks the call until the breakpoints list has changed,
-// or a server selected timeout has expired. The value should be set
-// from the last response to ListBreakpoints. The error code ABORTED is
-// returned on wait timeout, which should be called again with the same
-// wait_token.
-func (c *DebuggerDebuggeesBreakpointsListCall) WaitToken(waitToken string) *DebuggerDebuggeesBreakpointsListCall {
- c.opt_["waitToken"] = waitToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DebuggerDebuggeesBreakpointsListCall) Fields(s ...googleapi.Field) *DebuggerDebuggeesBreakpointsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DebuggerDebuggeesBreakpointsListCall) IfNoneMatch(entityTag string) *DebuggerDebuggeesBreakpointsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DebuggerDebuggeesBreakpointsListCall) Context(ctx context.Context) *DebuggerDebuggeesBreakpointsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DebuggerDebuggeesBreakpointsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["action.value"]; ok {
- params.Set("action.value", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["includeAllUsers"]; ok {
- params.Set("includeAllUsers", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["includeInactive"]; ok {
- params.Set("includeInactive", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["stripResults"]; ok {
- params.Set("stripResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["waitToken"]; ok {
- params.Set("waitToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v2/debugger/debuggees/{debuggeeId}/breakpoints")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "debuggeeId": c.debuggeeId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouddebugger.debugger.debuggees.breakpoints.list" call.
-// Exactly one of *ListBreakpointsResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ListBreakpointsResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DebuggerDebuggeesBreakpointsListCall) Do() (*ListBreakpointsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ListBreakpointsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all breakpoints of the debuggee that the user has access to.",
- // "httpMethod": "GET",
- // "id": "clouddebugger.debugger.debuggees.breakpoints.list",
- // "parameterOrder": [
- // "debuggeeId"
- // ],
- // "parameters": {
- // "action.value": {
- // "description": "Only breakpoints with the specified action will pass the filter.",
- // "enum": [
- // "CAPTURE",
- // "LOG"
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "debuggeeId": {
- // "description": "The debuggee id to list breakpoint from.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "includeAllUsers": {
- // "description": "When set to true the response includes the list of breakpoints set by any user, otherwise only breakpoints set by the caller.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "includeInactive": {
- // "description": "When set to true the response includes active and inactive breakpoints, otherwise only active breakpoints are returned.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "stripResults": {
- // "description": "When set to true the response breakpoints will be stripped of the results fields: stack_frames, evaluated_expressions and variable_table.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "waitToken": {
- // "description": "A wait token that, if specified, blocks the call until the breakpoints list has changed, or a server selected timeout has expired. The value should be set from the last response to ListBreakpoints. The error code ABORTED is returned on wait timeout, which should be called again with the same wait_token.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints",
- // "response": {
- // "$ref": "ListBreakpointsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud_debugger"
- // ]
- // }
-
-}
-
-// method id "clouddebugger.debugger.debuggees.breakpoints.set":
-
-type DebuggerDebuggeesBreakpointsSetCall struct {
- s *Service
- debuggeeId string
- breakpoint *Breakpoint
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Set: Sets the breakpoint to the debuggee.
-func (r *DebuggerDebuggeesBreakpointsService) Set(debuggeeId string, breakpoint *Breakpoint) *DebuggerDebuggeesBreakpointsSetCall {
- c := &DebuggerDebuggeesBreakpointsSetCall{s: r.s, opt_: make(map[string]interface{})}
- c.debuggeeId = debuggeeId
- c.breakpoint = breakpoint
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DebuggerDebuggeesBreakpointsSetCall) Fields(s ...googleapi.Field) *DebuggerDebuggeesBreakpointsSetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DebuggerDebuggeesBreakpointsSetCall) Context(ctx context.Context) *DebuggerDebuggeesBreakpointsSetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DebuggerDebuggeesBreakpointsSetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.breakpoint)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v2/debugger/debuggees/{debuggeeId}/breakpoints/set")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "debuggeeId": c.debuggeeId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouddebugger.debugger.debuggees.breakpoints.set" call.
-// Exactly one of *SetBreakpointResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *SetBreakpointResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DebuggerDebuggeesBreakpointsSetCall) Do() (*SetBreakpointResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SetBreakpointResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sets the breakpoint to the debuggee.",
- // "httpMethod": "POST",
- // "id": "clouddebugger.debugger.debuggees.breakpoints.set",
- // "parameterOrder": [
- // "debuggeeId"
- // ],
- // "parameters": {
- // "debuggeeId": {
- // "description": "The debuggee id to set the breakpoint to.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/set",
- // "request": {
- // "$ref": "Breakpoint"
- // },
- // "response": {
- // "$ref": "SetBreakpointResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud_debugger"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/cloudlatencytest/v2/cloudlatencytest-api.json b/vendor/google.golang.org/api/cloudlatencytest/v2/cloudlatencytest-api.json
deleted file mode 100644
index 3f0f1a08..00000000
--- a/vendor/google.golang.org/api/cloudlatencytest/v2/cloudlatencytest-api.json
+++ /dev/null
@@ -1,212 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/qJOZypus2JZqrrIOB0BaiZ76VFY\"",
- "discoveryVersion": "v1",
- "id": "cloudlatencytest:v2",
- "name": "cloudlatencytest",
- "version": "v2",
- "revision": "20150206",
- "title": "Google Cloud Network Performance Monitoring API",
- "description": "A Test API to report latency data.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "",
- "protocol": "rest",
- "baseUrl": "https://cloudlatencytest-pa.googleapis.com/v2/statscollection/",
- "basePath": "/v2/statscollection/",
- "rootUrl": "https://cloudlatencytest-pa.googleapis.com/",
- "servicePath": "v2/statscollection/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/monitoring.readonly": {
- "description": "View monitoring data for all of your Google Cloud and API projects"
- }
- }
- }
- },
- "schemas": {
- "AggregatedStats": {
- "id": "AggregatedStats",
- "type": "object",
- "properties": {
- "stats": {
- "type": "array",
- "items": {
- "$ref": "Stats"
- }
- }
- }
- },
- "AggregatedStatsReply": {
- "id": "AggregatedStatsReply",
- "type": "object",
- "properties": {
- "testValue": {
- "type": "string"
- }
- }
- },
- "DoubleValue": {
- "id": "DoubleValue",
- "type": "object",
- "properties": {
- "label": {
- "type": "string"
- },
- "value": {
- "type": "number",
- "format": "float"
- }
- }
- },
- "IntValue": {
- "id": "IntValue",
- "type": "object",
- "properties": {
- "label": {
- "type": "string"
- },
- "value": {
- "type": "string",
- "format": "int64"
- }
- }
- },
- "Stats": {
- "id": "Stats",
- "type": "object",
- "properties": {
- "doubleValues": {
- "type": "array",
- "items": {
- "$ref": "DoubleValue"
- }
- },
- "intValues": {
- "type": "array",
- "items": {
- "$ref": "IntValue"
- }
- },
- "stringValues": {
- "type": "array",
- "items": {
- "$ref": "StringValue"
- }
- },
- "time": {
- "type": "number",
- "format": "double"
- }
- }
- },
- "StatsReply": {
- "id": "StatsReply",
- "type": "object",
- "properties": {
- "testValue": {
- "type": "string"
- }
- }
- },
- "StringValue": {
- "id": "StringValue",
- "type": "object",
- "properties": {
- "label": {
- "type": "string"
- },
- "value": {
- "type": "string"
- }
- }
- }
- },
- "resources": {
- "statscollection": {
- "methods": {
- "updateaggregatedstats": {
- "id": "cloudlatencytest.statscollection.updateaggregatedstats",
- "path": "updateaggregatedstats",
- "httpMethod": "POST",
- "description": "RPC to update the new TCP stats.",
- "request": {
- "$ref": "AggregatedStats"
- },
- "response": {
- "$ref": "AggregatedStatsReply"
- },
- "scopes": [
- "https://www.googleapis.com/auth/monitoring.readonly"
- ]
- },
- "updatestats": {
- "id": "cloudlatencytest.statscollection.updatestats",
- "path": "updatestats",
- "httpMethod": "POST",
- "description": "RPC to update the new TCP stats.",
- "request": {
- "$ref": "Stats"
- },
- "response": {
- "$ref": "StatsReply"
- },
- "scopes": [
- "https://www.googleapis.com/auth/monitoring.readonly"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/cloudlatencytest/v2/cloudlatencytest-gen.go b/vendor/google.golang.org/api/cloudlatencytest/v2/cloudlatencytest-gen.go
deleted file mode 100644
index 7f1efde4..00000000
--- a/vendor/google.golang.org/api/cloudlatencytest/v2/cloudlatencytest-gen.go
+++ /dev/null
@@ -1,447 +0,0 @@
-// Package cloudlatencytest provides access to the Google Cloud Network Performance Monitoring API.
-//
-// Usage example:
-//
-// import "google.golang.org/api/cloudlatencytest/v2"
-// ...
-// cloudlatencytestService, err := cloudlatencytest.New(oauthHttpClient)
-package cloudlatencytest // import "google.golang.org/api/cloudlatencytest/v2"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "cloudlatencytest:v2"
-const apiName = "cloudlatencytest"
-const apiVersion = "v2"
-const basePath = "https://cloudlatencytest-pa.googleapis.com/v2/statscollection/"
-
-// OAuth2 scopes used by this API.
-const (
- // View monitoring data for all of your Google Cloud and API projects
- MonitoringReadonlyScope = "https://www.googleapis.com/auth/monitoring.readonly"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Statscollection = NewStatscollectionService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Statscollection *StatscollectionService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewStatscollectionService(s *Service) *StatscollectionService {
- rs := &StatscollectionService{s: s}
- return rs
-}
-
-type StatscollectionService struct {
- s *Service
-}
-
-type AggregatedStats struct {
- Stats []*Stats `json:"stats,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Stats") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AggregatedStats) MarshalJSON() ([]byte, error) {
- type noMethod AggregatedStats
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AggregatedStatsReply struct {
- TestValue string `json:"testValue,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "TestValue") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AggregatedStatsReply) MarshalJSON() ([]byte, error) {
- type noMethod AggregatedStatsReply
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DoubleValue struct {
- Label string `json:"label,omitempty"`
-
- Value float64 `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Label") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DoubleValue) MarshalJSON() ([]byte, error) {
- type noMethod DoubleValue
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type IntValue struct {
- Label string `json:"label,omitempty"`
-
- Value int64 `json:"value,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "Label") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *IntValue) MarshalJSON() ([]byte, error) {
- type noMethod IntValue
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Stats struct {
- DoubleValues []*DoubleValue `json:"doubleValues,omitempty"`
-
- IntValues []*IntValue `json:"intValues,omitempty"`
-
- StringValues []*StringValue `json:"stringValues,omitempty"`
-
- Time float64 `json:"time,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DoubleValues") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Stats) MarshalJSON() ([]byte, error) {
- type noMethod Stats
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type StatsReply struct {
- TestValue string `json:"testValue,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "TestValue") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *StatsReply) MarshalJSON() ([]byte, error) {
- type noMethod StatsReply
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type StringValue struct {
- Label string `json:"label,omitempty"`
-
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Label") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *StringValue) MarshalJSON() ([]byte, error) {
- type noMethod StringValue
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "cloudlatencytest.statscollection.updateaggregatedstats":
-
-type StatscollectionUpdateaggregatedstatsCall struct {
- s *Service
- aggregatedstats *AggregatedStats
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Updateaggregatedstats: RPC to update the new TCP stats.
-func (r *StatscollectionService) Updateaggregatedstats(aggregatedstats *AggregatedStats) *StatscollectionUpdateaggregatedstatsCall {
- c := &StatscollectionUpdateaggregatedstatsCall{s: r.s, opt_: make(map[string]interface{})}
- c.aggregatedstats = aggregatedstats
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *StatscollectionUpdateaggregatedstatsCall) Fields(s ...googleapi.Field) *StatscollectionUpdateaggregatedstatsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *StatscollectionUpdateaggregatedstatsCall) Context(ctx context.Context) *StatscollectionUpdateaggregatedstatsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *StatscollectionUpdateaggregatedstatsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.aggregatedstats)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "updateaggregatedstats")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudlatencytest.statscollection.updateaggregatedstats" call.
-// Exactly one of *AggregatedStatsReply or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AggregatedStatsReply.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *StatscollectionUpdateaggregatedstatsCall) Do() (*AggregatedStatsReply, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AggregatedStatsReply{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "RPC to update the new TCP stats.",
- // "httpMethod": "POST",
- // "id": "cloudlatencytest.statscollection.updateaggregatedstats",
- // "path": "updateaggregatedstats",
- // "request": {
- // "$ref": "AggregatedStats"
- // },
- // "response": {
- // "$ref": "AggregatedStatsReply"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/monitoring.readonly"
- // ]
- // }
-
-}
-
-// method id "cloudlatencytest.statscollection.updatestats":
-
-type StatscollectionUpdatestatsCall struct {
- s *Service
- stats *Stats
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Updatestats: RPC to update the new TCP stats.
-func (r *StatscollectionService) Updatestats(stats *Stats) *StatscollectionUpdatestatsCall {
- c := &StatscollectionUpdatestatsCall{s: r.s, opt_: make(map[string]interface{})}
- c.stats = stats
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *StatscollectionUpdatestatsCall) Fields(s ...googleapi.Field) *StatscollectionUpdatestatsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *StatscollectionUpdatestatsCall) Context(ctx context.Context) *StatscollectionUpdatestatsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *StatscollectionUpdatestatsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.stats)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "updatestats")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudlatencytest.statscollection.updatestats" call.
-// Exactly one of *StatsReply or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *StatsReply.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *StatscollectionUpdatestatsCall) Do() (*StatsReply, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &StatsReply{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "RPC to update the new TCP stats.",
- // "httpMethod": "POST",
- // "id": "cloudlatencytest.statscollection.updatestats",
- // "path": "updatestats",
- // "request": {
- // "$ref": "Stats"
- // },
- // "response": {
- // "$ref": "StatsReply"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/monitoring.readonly"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/cloudmonitoring/v2beta2/cloudmonitoring-api.json b/vendor/google.golang.org/api/cloudmonitoring/v2beta2/cloudmonitoring-api.json
deleted file mode 100644
index c6b2d23a..00000000
--- a/vendor/google.golang.org/api/cloudmonitoring/v2beta2/cloudmonitoring-api.json
+++ /dev/null
@@ -1,839 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/avMl03W4ktR_Q7PS4O3ogtyT8Dc\"",
- "discoveryVersion": "v1",
- "id": "cloudmonitoring:v2beta2",
- "name": "cloudmonitoring",
- "canonicalName": "Cloud Monitoring",
- "version": "v2beta2",
- "revision": "20150713",
- "title": "Cloud Monitoring API",
- "description": "API for accessing Google Cloud and API monitoring data.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/monitoring/v2beta2/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/cloudmonitoring/v2beta2/projects/",
- "basePath": "/cloudmonitoring/v2beta2/projects/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "cloudmonitoring/v2beta2/projects/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/monitoring": {
- "description": "View and write monitoring data for all of your Google and third-party Cloud and API projects"
- }
- }
- }
- },
- "schemas": {
- "DeleteMetricDescriptorResponse": {
- "id": "DeleteMetricDescriptorResponse",
- "type": "object",
- "description": "The response of cloudmonitoring.metricDescriptors.delete.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"cloudmonitoring#deleteMetricDescriptorResponse\".",
- "default": "cloudmonitoring#deleteMetricDescriptorResponse"
- }
- }
- },
- "ListMetricDescriptorsRequest": {
- "id": "ListMetricDescriptorsRequest",
- "type": "object",
- "description": "The request of cloudmonitoring.metricDescriptors.list.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"cloudmonitoring#listMetricDescriptorsRequest\".",
- "default": "cloudmonitoring#listMetricDescriptorsRequest"
- }
- }
- },
- "ListMetricDescriptorsResponse": {
- "id": "ListMetricDescriptorsResponse",
- "type": "object",
- "description": "The response of cloudmonitoring.metricDescriptors.list.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"cloudmonitoring#listMetricDescriptorsResponse\".",
- "default": "cloudmonitoring#listMetricDescriptorsResponse"
- },
- "metrics": {
- "type": "array",
- "description": "The returned metric descriptors.",
- "items": {
- "$ref": "MetricDescriptor"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token. If present, indicates that additional results are available for retrieval. To access the results past the pagination limit, pass this value to the pageToken query parameter."
- }
- }
- },
- "ListTimeseriesDescriptorsRequest": {
- "id": "ListTimeseriesDescriptorsRequest",
- "type": "object",
- "description": "The request of cloudmonitoring.timeseriesDescriptors.list",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"cloudmonitoring#listTimeseriesDescriptorsRequest\".",
- "default": "cloudmonitoring#listTimeseriesDescriptorsRequest"
- }
- }
- },
- "ListTimeseriesDescriptorsResponse": {
- "id": "ListTimeseriesDescriptorsResponse",
- "type": "object",
- "description": "The response of cloudmonitoring.timeseriesDescriptors.list",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"cloudmonitoring#listTimeseriesDescriptorsResponse\".",
- "default": "cloudmonitoring#listTimeseriesDescriptorsResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token. If present, indicates that additional results are available for retrieval. To access the results past the pagination limit, set this value to the pageToken query parameter."
- },
- "oldest": {
- "type": "string",
- "description": "The oldest timestamp of the interval of this query, as an RFC 3339 string.",
- "format": "date-time"
- },
- "timeseries": {
- "type": "array",
- "description": "The returned time series descriptors.",
- "items": {
- "$ref": "TimeseriesDescriptor"
- }
- },
- "youngest": {
- "type": "string",
- "description": "The youngest timestamp of the interval of this query, as an RFC 3339 string.",
- "format": "date-time"
- }
- }
- },
- "ListTimeseriesRequest": {
- "id": "ListTimeseriesRequest",
- "type": "object",
- "description": "The request of cloudmonitoring.timeseries.list",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"cloudmonitoring#listTimeseriesRequest\".",
- "default": "cloudmonitoring#listTimeseriesRequest"
- }
- }
- },
- "ListTimeseriesResponse": {
- "id": "ListTimeseriesResponse",
- "type": "object",
- "description": "The response of cloudmonitoring.timeseries.list",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"cloudmonitoring#listTimeseriesResponse\".",
- "default": "cloudmonitoring#listTimeseriesResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token. If present, indicates that additional results are available for retrieval. To access the results past the pagination limit, set the pageToken query parameter to this value. All of the points of a time series will be returned before returning any point of the subsequent time series."
- },
- "oldest": {
- "type": "string",
- "description": "The oldest timestamp of the interval of this query as an RFC 3339 string.",
- "format": "date-time"
- },
- "timeseries": {
- "type": "array",
- "description": "The returned time series.",
- "items": {
- "$ref": "Timeseries"
- }
- },
- "youngest": {
- "type": "string",
- "description": "The youngest timestamp of the interval of this query as an RFC 3339 string.",
- "format": "date-time"
- }
- }
- },
- "MetricDescriptor": {
- "id": "MetricDescriptor",
- "type": "object",
- "description": "A metricDescriptor defines the name, label keys, and data type of a particular metric.",
- "properties": {
- "description": {
- "type": "string",
- "description": "Description of this metric."
- },
- "labels": {
- "type": "array",
- "description": "Labels defined for this metric.",
- "items": {
- "$ref": "MetricDescriptorLabelDescriptor"
- }
- },
- "name": {
- "type": "string",
- "description": "The name of this metric."
- },
- "project": {
- "type": "string",
- "description": "The project ID to which the metric belongs."
- },
- "typeDescriptor": {
- "$ref": "MetricDescriptorTypeDescriptor",
- "description": "Type description for this metric."
- }
- }
- },
- "MetricDescriptorLabelDescriptor": {
- "id": "MetricDescriptorLabelDescriptor",
- "type": "object",
- "description": "A label in a metric is a description of this metric, including the key of this description (what the description is), and the value for this description.",
- "properties": {
- "description": {
- "type": "string",
- "description": "Label description."
- },
- "key": {
- "type": "string",
- "description": "Label key."
- }
- }
- },
- "MetricDescriptorTypeDescriptor": {
- "id": "MetricDescriptorTypeDescriptor",
- "type": "object",
- "description": "A type in a metric contains information about how the metric is collected and what its data points look like.",
- "properties": {
- "metricType": {
- "type": "string",
- "description": "The method of collecting data for the metric. See Metric types."
- },
- "valueType": {
- "type": "string",
- "description": "The data type of of individual points in the metric's time series. See Metric value types."
- }
- }
- },
- "Point": {
- "id": "Point",
- "type": "object",
- "description": "Point is a single point in a time series. It consists of a start time, an end time, and a value.",
- "properties": {
- "boolValue": {
- "type": "boolean",
- "description": "The value of this data point. Either \"true\" or \"false\"."
- },
- "distributionValue": {
- "$ref": "PointDistribution",
- "description": "The value of this data point as a distribution. A distribution value can contain a list of buckets and/or an underflowBucket and an overflowBucket. The values of these points can be used to create a histogram."
- },
- "doubleValue": {
- "type": "number",
- "description": "The value of this data point as a double-precision floating-point number.",
- "format": "double"
- },
- "end": {
- "type": "string",
- "description": "The interval [start, end] is the time period to which the point's value applies. For gauge metrics, whose values are instantaneous measurements, this interval should be empty (start should equal end). For cumulative metrics (of which deltas and rates are special cases), the interval should be non-empty. Both start and end are RFC 3339 strings.",
- "format": "date-time"
- },
- "int64Value": {
- "type": "string",
- "description": "The value of this data point as a 64-bit integer.",
- "format": "int64"
- },
- "start": {
- "type": "string",
- "description": "The interval [start, end] is the time period to which the point's value applies. For gauge metrics, whose values are instantaneous measurements, this interval should be empty (start should equal end). For cumulative metrics (of which deltas and rates are special cases), the interval should be non-empty. Both start and end are RFC 3339 strings.",
- "format": "date-time"
- },
- "stringValue": {
- "type": "string",
- "description": "The value of this data point in string format."
- }
- }
- },
- "PointDistribution": {
- "id": "PointDistribution",
- "type": "object",
- "description": "Distribution data point value type. When writing distribution points, try to be consistent with the boundaries of your buckets. If you must modify the bucket boundaries, then do so by merging, partitioning, or appending rather than skewing them.",
- "properties": {
- "buckets": {
- "type": "array",
- "description": "The finite buckets.",
- "items": {
- "$ref": "PointDistributionBucket"
- }
- },
- "overflowBucket": {
- "$ref": "PointDistributionOverflowBucket",
- "description": "The overflow bucket."
- },
- "underflowBucket": {
- "$ref": "PointDistributionUnderflowBucket",
- "description": "The underflow bucket."
- }
- }
- },
- "PointDistributionBucket": {
- "id": "PointDistributionBucket",
- "type": "object",
- "description": "The histogram's bucket. Buckets that form the histogram of a distribution value. If the upper bound of a bucket, say U1, does not equal the lower bound of the next bucket, say L2, this means that there is no event in [U1, L2).",
- "properties": {
- "count": {
- "type": "string",
- "description": "The number of events whose values are in the interval defined by this bucket.",
- "format": "int64"
- },
- "lowerBound": {
- "type": "number",
- "description": "The lower bound of the value interval of this bucket (inclusive).",
- "format": "double"
- },
- "upperBound": {
- "type": "number",
- "description": "The upper bound of the value interval of this bucket (exclusive).",
- "format": "double"
- }
- }
- },
- "PointDistributionOverflowBucket": {
- "id": "PointDistributionOverflowBucket",
- "type": "object",
- "description": "The overflow bucket is a special bucket that does not have the upperBound field; it includes all of the events that are no less than its lower bound.",
- "properties": {
- "count": {
- "type": "string",
- "description": "The number of events whose values are in the interval defined by this bucket.",
- "format": "int64"
- },
- "lowerBound": {
- "type": "number",
- "description": "The lower bound of the value interval of this bucket (inclusive).",
- "format": "double"
- }
- }
- },
- "PointDistributionUnderflowBucket": {
- "id": "PointDistributionUnderflowBucket",
- "type": "object",
- "description": "The underflow bucket is a special bucket that does not have the lowerBound field; it includes all of the events that are less than its upper bound.",
- "properties": {
- "count": {
- "type": "string",
- "description": "The number of events whose values are in the interval defined by this bucket.",
- "format": "int64"
- },
- "upperBound": {
- "type": "number",
- "description": "The upper bound of the value interval of this bucket (exclusive).",
- "format": "double"
- }
- }
- },
- "Timeseries": {
- "id": "Timeseries",
- "type": "object",
- "description": "The monitoring data is organized as metrics and stored as data points that are recorded over time. Each data point represents information like the CPU utilization of your virtual machine. A historical record of these data points is called a time series.",
- "properties": {
- "points": {
- "type": "array",
- "description": "The data points of this time series. The points are listed in order of their end timestamp, from younger to older.",
- "items": {
- "$ref": "Point"
- }
- },
- "timeseriesDesc": {
- "$ref": "TimeseriesDescriptor",
- "description": "The descriptor of this time series."
- }
- }
- },
- "TimeseriesDescriptor": {
- "id": "TimeseriesDescriptor",
- "type": "object",
- "description": "TimeseriesDescriptor identifies a single time series.",
- "properties": {
- "labels": {
- "type": "object",
- "description": "The label's name.",
- "additionalProperties": {
- "type": "string",
- "description": "The label's name."
- }
- },
- "metric": {
- "type": "string",
- "description": "The name of the metric."
- },
- "project": {
- "type": "string",
- "description": "The Developers Console project number to which this time series belongs."
- }
- }
- },
- "TimeseriesDescriptorLabel": {
- "id": "TimeseriesDescriptorLabel",
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "The label's name."
- },
- "value": {
- "type": "string",
- "description": "The label's value."
- }
- }
- },
- "TimeseriesPoint": {
- "id": "TimeseriesPoint",
- "type": "object",
- "description": "When writing time series, TimeseriesPoint should be used instead of Timeseries, to enforce single point for each time series in the timeseries.write request.",
- "properties": {
- "point": {
- "$ref": "Point",
- "description": "The data point in this time series snapshot."
- },
- "timeseriesDesc": {
- "$ref": "TimeseriesDescriptor",
- "description": "The descriptor of this time series."
- }
- }
- },
- "WriteTimeseriesRequest": {
- "id": "WriteTimeseriesRequest",
- "type": "object",
- "description": "The request of cloudmonitoring.timeseries.write",
- "properties": {
- "commonLabels": {
- "type": "object",
- "description": "The label's name.",
- "additionalProperties": {
- "type": "string",
- "description": "The label's name."
- }
- },
- "timeseries": {
- "type": "array",
- "description": "Provide time series specific labels and the data points for each time series. The labels in timeseries and the common_labels should form a complete list of labels that required by the metric.",
- "items": {
- "$ref": "TimeseriesPoint"
- }
- }
- }
- },
- "WriteTimeseriesResponse": {
- "id": "WriteTimeseriesResponse",
- "type": "object",
- "description": "The response of cloudmonitoring.timeseries.write",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"cloudmonitoring#writeTimeseriesResponse\".",
- "default": "cloudmonitoring#writeTimeseriesResponse"
- }
- }
- }
- },
- "resources": {
- "metricDescriptors": {
- "methods": {
- "create": {
- "id": "cloudmonitoring.metricDescriptors.create",
- "path": "{project}/metricDescriptors",
- "httpMethod": "POST",
- "description": "Create a new metric.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "The project id. The value can be the numeric project ID or string-based project name.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "MetricDescriptor"
- },
- "response": {
- "$ref": "MetricDescriptor"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring"
- ]
- },
- "delete": {
- "id": "cloudmonitoring.metricDescriptors.delete",
- "path": "{project}/metricDescriptors/{metric}",
- "httpMethod": "DELETE",
- "description": "Delete an existing metric.",
- "parameters": {
- "metric": {
- "type": "string",
- "description": "Name of the metric.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID to which the metric belongs.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "metric"
- ],
- "response": {
- "$ref": "DeleteMetricDescriptorResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring"
- ]
- },
- "list": {
- "id": "cloudmonitoring.metricDescriptors.list",
- "path": "{project}/metricDescriptors",
- "httpMethod": "GET",
- "description": "List metric descriptors that match the query. If the query is not set, then all of the metric descriptors will be returned. Large responses will be paginated, use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.",
- "parameters": {
- "count": {
- "type": "integer",
- "description": "Maximum number of metric descriptors per page. Used for pagination. If not specified, count = 100.",
- "default": "100",
- "format": "int32",
- "minimum": "1",
- "maximum": "1000",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The pagination token, which is used to page through large result sets. Set this value to the value of the nextPageToken to retrieve the next page of results.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "The project id. The value can be the numeric project ID or string-based project name.",
- "required": true,
- "location": "path"
- },
- "query": {
- "type": "string",
- "description": "The query used to search against existing metrics. Separate keywords with a space; the service joins all keywords with AND, meaning that all keywords must match for a metric to be returned. If this field is omitted, all metrics are returned. If an empty string is passed with this field, no metrics are returned.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "ListMetricDescriptorsRequest"
- },
- "response": {
- "$ref": "ListMetricDescriptorsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring"
- ]
- }
- }
- },
- "timeseries": {
- "methods": {
- "list": {
- "id": "cloudmonitoring.timeseries.list",
- "path": "{project}/timeseries/{metric}",
- "httpMethod": "GET",
- "description": "List the data points of the time series that match the metric and labels values and that have data points in the interval. Large responses are paginated; use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.",
- "parameters": {
- "aggregator": {
- "type": "string",
- "description": "The aggregation function that will reduce the data points in each window to a single point. This parameter is only valid for non-cumulative metrics with a value type of INT64 or DOUBLE.",
- "enum": [
- "max",
- "mean",
- "min",
- "sum"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "location": "query"
- },
- "count": {
- "type": "integer",
- "description": "Maximum number of data points per page, which is used for pagination of results.",
- "default": "6000",
- "format": "int32",
- "minimum": "1",
- "maximum": "12000",
- "location": "query"
- },
- "labels": {
- "type": "string",
- "description": "A collection of labels for the matching time series, which are represented as: \n- key==value: key equals the value \n- key=~value: key regex matches the value \n- key!=value: key does not equal the value \n- key!~value: key regex does not match the value For example, to list all of the time series descriptors for the region us-central1, you could specify:\nlabel=cloud.googleapis.com%2Flocation=~us-central1.*",
- "pattern": "(.+?)(==|=~|!=|!~)(.+)",
- "repeated": true,
- "location": "query"
- },
- "metric": {
- "type": "string",
- "description": "Metric names are protocol-free URLs as listed in the Supported Metrics page. For example, compute.googleapis.com/instance/disk/read_ops_count.",
- "required": true,
- "location": "path"
- },
- "oldest": {
- "type": "string",
- "description": "Start of the time interval (exclusive), which is expressed as an RFC 3339 timestamp. If neither oldest nor timespan is specified, the default time interval will be (youngest - 4 hours, youngest]",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The pagination token, which is used to page through large result sets. Set this value to the value of the nextPageToken to retrieve the next page of results.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "The project ID to which this time series belongs. The value can be the numeric project ID or string-based project name.",
- "required": true,
- "location": "path"
- },
- "timespan": {
- "type": "string",
- "description": "Length of the time interval to query, which is an alternative way to declare the interval: (youngest - timespan, youngest]. The timespan and oldest parameters should not be used together. Units: \n- s: second \n- m: minute \n- h: hour \n- d: day \n- w: week Examples: 2s, 3m, 4w. Only one unit is allowed, for example: 2w3d is not allowed; you should use 17d instead.\n\nIf neither oldest nor timespan is specified, the default time interval will be (youngest - 4 hours, youngest].",
- "pattern": "[0-9]+[smhdw]?",
- "location": "query"
- },
- "window": {
- "type": "string",
- "description": "The sampling window. At most one data point will be returned for each window in the requested time interval. This parameter is only valid for non-cumulative metric types. Units: \n- m: minute \n- h: hour \n- d: day \n- w: week Examples: 3m, 4w. Only one unit is allowed, for example: 2w3d is not allowed; you should use 17d instead.",
- "pattern": "[0-9]+[mhdw]?",
- "location": "query"
- },
- "youngest": {
- "type": "string",
- "description": "End of the time interval (inclusive), which is expressed as an RFC 3339 timestamp.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "project",
- "metric",
- "youngest"
- ],
- "request": {
- "$ref": "ListTimeseriesRequest"
- },
- "response": {
- "$ref": "ListTimeseriesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring"
- ]
- },
- "write": {
- "id": "cloudmonitoring.timeseries.write",
- "path": "{project}/timeseries:write",
- "httpMethod": "POST",
- "description": "Put data points to one or more time series for one or more metrics. If a time series does not exist, a new time series will be created. It is not allowed to write a time series point that is older than the existing youngest point of that time series. Points that are older than the existing youngest point of that time series will be discarded silently. Therefore, users should make sure that points of a time series are written sequentially in the order of their end time.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "The project ID. The value can be the numeric project ID or string-based project name.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "WriteTimeseriesRequest"
- },
- "response": {
- "$ref": "WriteTimeseriesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring"
- ]
- }
- }
- },
- "timeseriesDescriptors": {
- "methods": {
- "list": {
- "id": "cloudmonitoring.timeseriesDescriptors.list",
- "path": "{project}/timeseriesDescriptors/{metric}",
- "httpMethod": "GET",
- "description": "List the descriptors of the time series that match the metric and labels values and that have data points in the interval. Large responses are paginated; use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.",
- "parameters": {
- "aggregator": {
- "type": "string",
- "description": "The aggregation function that will reduce the data points in each window to a single point. This parameter is only valid for non-cumulative metrics with a value type of INT64 or DOUBLE.",
- "enum": [
- "max",
- "mean",
- "min",
- "sum"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "location": "query"
- },
- "count": {
- "type": "integer",
- "description": "Maximum number of time series descriptors per page. Used for pagination. If not specified, count = 100.",
- "default": "100",
- "format": "int32",
- "minimum": "1",
- "maximum": "1000",
- "location": "query"
- },
- "labels": {
- "type": "string",
- "description": "A collection of labels for the matching time series, which are represented as: \n- key==value: key equals the value \n- key=~value: key regex matches the value \n- key!=value: key does not equal the value \n- key!~value: key regex does not match the value For example, to list all of the time series descriptors for the region us-central1, you could specify:\nlabel=cloud.googleapis.com%2Flocation=~us-central1.*",
- "pattern": "(.+?)(==|=~|!=|!~)(.+)",
- "repeated": true,
- "location": "query"
- },
- "metric": {
- "type": "string",
- "description": "Metric names are protocol-free URLs as listed in the Supported Metrics page. For example, compute.googleapis.com/instance/disk/read_ops_count.",
- "required": true,
- "location": "path"
- },
- "oldest": {
- "type": "string",
- "description": "Start of the time interval (exclusive), which is expressed as an RFC 3339 timestamp. If neither oldest nor timespan is specified, the default time interval will be (youngest - 4 hours, youngest]",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The pagination token, which is used to page through large result sets. Set this value to the value of the nextPageToken to retrieve the next page of results.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "The project ID to which this time series belongs. The value can be the numeric project ID or string-based project name.",
- "required": true,
- "location": "path"
- },
- "timespan": {
- "type": "string",
- "description": "Length of the time interval to query, which is an alternative way to declare the interval: (youngest - timespan, youngest]. The timespan and oldest parameters should not be used together. Units: \n- s: second \n- m: minute \n- h: hour \n- d: day \n- w: week Examples: 2s, 3m, 4w. Only one unit is allowed, for example: 2w3d is not allowed; you should use 17d instead.\n\nIf neither oldest nor timespan is specified, the default time interval will be (youngest - 4 hours, youngest].",
- "pattern": "[0-9]+[smhdw]?",
- "location": "query"
- },
- "window": {
- "type": "string",
- "description": "The sampling window. At most one data point will be returned for each window in the requested time interval. This parameter is only valid for non-cumulative metric types. Units: \n- m: minute \n- h: hour \n- d: day \n- w: week Examples: 3m, 4w. Only one unit is allowed, for example: 2w3d is not allowed; you should use 17d instead.",
- "pattern": "[0-9]+[mhdw]?",
- "location": "query"
- },
- "youngest": {
- "type": "string",
- "description": "End of the time interval (inclusive), which is expressed as an RFC 3339 timestamp.",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "project",
- "metric",
- "youngest"
- ],
- "request": {
- "$ref": "ListTimeseriesDescriptorsRequest"
- },
- "response": {
- "$ref": "ListTimeseriesDescriptorsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/cloudmonitoring/v2beta2/cloudmonitoring-gen.go b/vendor/google.golang.org/api/cloudmonitoring/v2beta2/cloudmonitoring-gen.go
deleted file mode 100644
index 5cfbeea7..00000000
--- a/vendor/google.golang.org/api/cloudmonitoring/v2beta2/cloudmonitoring-gen.go
+++ /dev/null
@@ -1,1950 +0,0 @@
-// Package cloudmonitoring provides access to the Cloud Monitoring API.
-//
-// See https://cloud.google.com/monitoring/v2beta2/
-//
-// Usage example:
-//
-// import "google.golang.org/api/cloudmonitoring/v2beta2"
-// ...
-// cloudmonitoringService, err := cloudmonitoring.New(oauthHttpClient)
-package cloudmonitoring // import "google.golang.org/api/cloudmonitoring/v2beta2"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "cloudmonitoring:v2beta2"
-const apiName = "cloudmonitoring"
-const apiVersion = "v2beta2"
-const basePath = "https://www.googleapis.com/cloudmonitoring/v2beta2/projects/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your data across Google Cloud Platform services
- CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
-
- // View and write monitoring data for all of your Google and third-party
- // Cloud and API projects
- MonitoringScope = "https://www.googleapis.com/auth/monitoring"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.MetricDescriptors = NewMetricDescriptorsService(s)
- s.Timeseries = NewTimeseriesService(s)
- s.TimeseriesDescriptors = NewTimeseriesDescriptorsService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- MetricDescriptors *MetricDescriptorsService
-
- Timeseries *TimeseriesService
-
- TimeseriesDescriptors *TimeseriesDescriptorsService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewMetricDescriptorsService(s *Service) *MetricDescriptorsService {
- rs := &MetricDescriptorsService{s: s}
- return rs
-}
-
-type MetricDescriptorsService struct {
- s *Service
-}
-
-func NewTimeseriesService(s *Service) *TimeseriesService {
- rs := &TimeseriesService{s: s}
- return rs
-}
-
-type TimeseriesService struct {
- s *Service
-}
-
-func NewTimeseriesDescriptorsService(s *Service) *TimeseriesDescriptorsService {
- rs := &TimeseriesDescriptorsService{s: s}
- return rs
-}
-
-type TimeseriesDescriptorsService struct {
- s *Service
-}
-
-// DeleteMetricDescriptorResponse: The response of
-// cloudmonitoring.metricDescriptors.delete.
-type DeleteMetricDescriptorResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "cloudmonitoring#deleteMetricDescriptorResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DeleteMetricDescriptorResponse) MarshalJSON() ([]byte, error) {
- type noMethod DeleteMetricDescriptorResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListMetricDescriptorsRequest: The request of
-// cloudmonitoring.metricDescriptors.list.
-type ListMetricDescriptorsRequest struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "cloudmonitoring#listMetricDescriptorsRequest".
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListMetricDescriptorsRequest) MarshalJSON() ([]byte, error) {
- type noMethod ListMetricDescriptorsRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListMetricDescriptorsResponse: The response of
-// cloudmonitoring.metricDescriptors.list.
-type ListMetricDescriptorsResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "cloudmonitoring#listMetricDescriptorsResponse".
- Kind string `json:"kind,omitempty"`
-
- // Metrics: The returned metric descriptors.
- Metrics []*MetricDescriptor `json:"metrics,omitempty"`
-
- // NextPageToken: Pagination token. If present, indicates that
- // additional results are available for retrieval. To access the results
- // past the pagination limit, pass this value to the pageToken query
- // parameter.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListMetricDescriptorsResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListMetricDescriptorsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListTimeseriesDescriptorsRequest: The request of
-// cloudmonitoring.timeseriesDescriptors.list
-type ListTimeseriesDescriptorsRequest struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "cloudmonitoring#listTimeseriesDescriptorsRequest".
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListTimeseriesDescriptorsRequest) MarshalJSON() ([]byte, error) {
- type noMethod ListTimeseriesDescriptorsRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListTimeseriesDescriptorsResponse: The response of
-// cloudmonitoring.timeseriesDescriptors.list
-type ListTimeseriesDescriptorsResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "cloudmonitoring#listTimeseriesDescriptorsResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token. If present, indicates that
- // additional results are available for retrieval. To access the results
- // past the pagination limit, set this value to the pageToken query
- // parameter.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Oldest: The oldest timestamp of the interval of this query, as an RFC
- // 3339 string.
- Oldest string `json:"oldest,omitempty"`
-
- // Timeseries: The returned time series descriptors.
- Timeseries []*TimeseriesDescriptor `json:"timeseries,omitempty"`
-
- // Youngest: The youngest timestamp of the interval of this query, as an
- // RFC 3339 string.
- Youngest string `json:"youngest,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListTimeseriesDescriptorsResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListTimeseriesDescriptorsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListTimeseriesRequest: The request of cloudmonitoring.timeseries.list
-type ListTimeseriesRequest struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "cloudmonitoring#listTimeseriesRequest".
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListTimeseriesRequest) MarshalJSON() ([]byte, error) {
- type noMethod ListTimeseriesRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListTimeseriesResponse: The response of
-// cloudmonitoring.timeseries.list
-type ListTimeseriesResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "cloudmonitoring#listTimeseriesResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token. If present, indicates that
- // additional results are available for retrieval. To access the results
- // past the pagination limit, set the pageToken query parameter to this
- // value. All of the points of a time series will be returned before
- // returning any point of the subsequent time series.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Oldest: The oldest timestamp of the interval of this query as an RFC
- // 3339 string.
- Oldest string `json:"oldest,omitempty"`
-
- // Timeseries: The returned time series.
- Timeseries []*Timeseries `json:"timeseries,omitempty"`
-
- // Youngest: The youngest timestamp of the interval of this query as an
- // RFC 3339 string.
- Youngest string `json:"youngest,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListTimeseriesResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListTimeseriesResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MetricDescriptor: A metricDescriptor defines the name, label keys,
-// and data type of a particular metric.
-type MetricDescriptor struct {
- // Description: Description of this metric.
- Description string `json:"description,omitempty"`
-
- // Labels: Labels defined for this metric.
- Labels []*MetricDescriptorLabelDescriptor `json:"labels,omitempty"`
-
- // Name: The name of this metric.
- Name string `json:"name,omitempty"`
-
- // Project: The project ID to which the metric belongs.
- Project string `json:"project,omitempty"`
-
- // TypeDescriptor: Type description for this metric.
- TypeDescriptor *MetricDescriptorTypeDescriptor `json:"typeDescriptor,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Description") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MetricDescriptor) MarshalJSON() ([]byte, error) {
- type noMethod MetricDescriptor
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MetricDescriptorLabelDescriptor: A label in a metric is a description
-// of this metric, including the key of this description (what the
-// description is), and the value for this description.
-type MetricDescriptorLabelDescriptor struct {
- // Description: Label description.
- Description string `json:"description,omitempty"`
-
- // Key: Label key.
- Key string `json:"key,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Description") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MetricDescriptorLabelDescriptor) MarshalJSON() ([]byte, error) {
- type noMethod MetricDescriptorLabelDescriptor
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MetricDescriptorTypeDescriptor: A type in a metric contains
-// information about how the metric is collected and what its data
-// points look like.
-type MetricDescriptorTypeDescriptor struct {
- // MetricType: The method of collecting data for the metric. See Metric
- // types.
- MetricType string `json:"metricType,omitempty"`
-
- // ValueType: The data type of of individual points in the metric's time
- // series. See Metric value types.
- ValueType string `json:"valueType,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "MetricType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MetricDescriptorTypeDescriptor) MarshalJSON() ([]byte, error) {
- type noMethod MetricDescriptorTypeDescriptor
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Point: Point is a single point in a time series. It consists of a
-// start time, an end time, and a value.
-type Point struct {
- // BoolValue: The value of this data point. Either "true" or "false".
- BoolValue *bool `json:"boolValue,omitempty"`
-
- // DistributionValue: The value of this data point as a distribution. A
- // distribution value can contain a list of buckets and/or an
- // underflowBucket and an overflowBucket. The values of these points can
- // be used to create a histogram.
- DistributionValue *PointDistribution `json:"distributionValue,omitempty"`
-
- // DoubleValue: The value of this data point as a double-precision
- // floating-point number.
- DoubleValue *float64 `json:"doubleValue,omitempty"`
-
- // End: The interval [start, end] is the time period to which the
- // point's value applies. For gauge metrics, whose values are
- // instantaneous measurements, this interval should be empty (start
- // should equal end). For cumulative metrics (of which deltas and rates
- // are special cases), the interval should be non-empty. Both start and
- // end are RFC 3339 strings.
- End string `json:"end,omitempty"`
-
- // Int64Value: The value of this data point as a 64-bit integer.
- Int64Value *int64 `json:"int64Value,omitempty,string"`
-
- // Start: The interval [start, end] is the time period to which the
- // point's value applies. For gauge metrics, whose values are
- // instantaneous measurements, this interval should be empty (start
- // should equal end). For cumulative metrics (of which deltas and rates
- // are special cases), the interval should be non-empty. Both start and
- // end are RFC 3339 strings.
- Start string `json:"start,omitempty"`
-
- // StringValue: The value of this data point in string format.
- StringValue *string `json:"stringValue,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BoolValue") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Point) MarshalJSON() ([]byte, error) {
- type noMethod Point
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PointDistribution: Distribution data point value type. When writing
-// distribution points, try to be consistent with the boundaries of your
-// buckets. If you must modify the bucket boundaries, then do so by
-// merging, partitioning, or appending rather than skewing them.
-type PointDistribution struct {
- // Buckets: The finite buckets.
- Buckets []*PointDistributionBucket `json:"buckets,omitempty"`
-
- // OverflowBucket: The overflow bucket.
- OverflowBucket *PointDistributionOverflowBucket `json:"overflowBucket,omitempty"`
-
- // UnderflowBucket: The underflow bucket.
- UnderflowBucket *PointDistributionUnderflowBucket `json:"underflowBucket,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Buckets") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PointDistribution) MarshalJSON() ([]byte, error) {
- type noMethod PointDistribution
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PointDistributionBucket: The histogram's bucket. Buckets that form
-// the histogram of a distribution value. If the upper bound of a
-// bucket, say U1, does not equal the lower bound of the next bucket,
-// say L2, this means that there is no event in [U1, L2).
-type PointDistributionBucket struct {
- // Count: The number of events whose values are in the interval defined
- // by this bucket.
- Count int64 `json:"count,omitempty,string"`
-
- // LowerBound: The lower bound of the value interval of this bucket
- // (inclusive).
- LowerBound float64 `json:"lowerBound,omitempty"`
-
- // UpperBound: The upper bound of the value interval of this bucket
- // (exclusive).
- UpperBound float64 `json:"upperBound,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Count") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PointDistributionBucket) MarshalJSON() ([]byte, error) {
- type noMethod PointDistributionBucket
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PointDistributionOverflowBucket: The overflow bucket is a special
-// bucket that does not have the upperBound field; it includes all of
-// the events that are no less than its lower bound.
-type PointDistributionOverflowBucket struct {
- // Count: The number of events whose values are in the interval defined
- // by this bucket.
- Count int64 `json:"count,omitempty,string"`
-
- // LowerBound: The lower bound of the value interval of this bucket
- // (inclusive).
- LowerBound float64 `json:"lowerBound,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Count") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PointDistributionOverflowBucket) MarshalJSON() ([]byte, error) {
- type noMethod PointDistributionOverflowBucket
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PointDistributionUnderflowBucket: The underflow bucket is a special
-// bucket that does not have the lowerBound field; it includes all of
-// the events that are less than its upper bound.
-type PointDistributionUnderflowBucket struct {
- // Count: The number of events whose values are in the interval defined
- // by this bucket.
- Count int64 `json:"count,omitempty,string"`
-
- // UpperBound: The upper bound of the value interval of this bucket
- // (exclusive).
- UpperBound float64 `json:"upperBound,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Count") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PointDistributionUnderflowBucket) MarshalJSON() ([]byte, error) {
- type noMethod PointDistributionUnderflowBucket
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Timeseries: The monitoring data is organized as metrics and stored as
-// data points that are recorded over time. Each data point represents
-// information like the CPU utilization of your virtual machine. A
-// historical record of these data points is called a time series.
-type Timeseries struct {
- // Points: The data points of this time series. The points are listed in
- // order of their end timestamp, from younger to older.
- Points []*Point `json:"points,omitempty"`
-
- // TimeseriesDesc: The descriptor of this time series.
- TimeseriesDesc *TimeseriesDescriptor `json:"timeseriesDesc,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Points") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Timeseries) MarshalJSON() ([]byte, error) {
- type noMethod Timeseries
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TimeseriesDescriptor: TimeseriesDescriptor identifies a single time
-// series.
-type TimeseriesDescriptor struct {
- // Labels: The label's name.
- Labels map[string]string `json:"labels,omitempty"`
-
- // Metric: The name of the metric.
- Metric string `json:"metric,omitempty"`
-
- // Project: The Developers Console project number to which this time
- // series belongs.
- Project string `json:"project,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Labels") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TimeseriesDescriptor) MarshalJSON() ([]byte, error) {
- type noMethod TimeseriesDescriptor
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TimeseriesDescriptorLabel struct {
- // Key: The label's name.
- Key string `json:"key,omitempty"`
-
- // Value: The label's value.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TimeseriesDescriptorLabel) MarshalJSON() ([]byte, error) {
- type noMethod TimeseriesDescriptorLabel
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TimeseriesPoint: When writing time series, TimeseriesPoint should be
-// used instead of Timeseries, to enforce single point for each time
-// series in the timeseries.write request.
-type TimeseriesPoint struct {
- // Point: The data point in this time series snapshot.
- Point *Point `json:"point,omitempty"`
-
- // TimeseriesDesc: The descriptor of this time series.
- TimeseriesDesc *TimeseriesDescriptor `json:"timeseriesDesc,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Point") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TimeseriesPoint) MarshalJSON() ([]byte, error) {
- type noMethod TimeseriesPoint
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// WriteTimeseriesRequest: The request of
-// cloudmonitoring.timeseries.write
-type WriteTimeseriesRequest struct {
- // CommonLabels: The label's name.
- CommonLabels map[string]string `json:"commonLabels,omitempty"`
-
- // Timeseries: Provide time series specific labels and the data points
- // for each time series. The labels in timeseries and the common_labels
- // should form a complete list of labels that required by the metric.
- Timeseries []*TimeseriesPoint `json:"timeseries,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CommonLabels") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *WriteTimeseriesRequest) MarshalJSON() ([]byte, error) {
- type noMethod WriteTimeseriesRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// WriteTimeseriesResponse: The response of
-// cloudmonitoring.timeseries.write
-type WriteTimeseriesResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "cloudmonitoring#writeTimeseriesResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *WriteTimeseriesResponse) MarshalJSON() ([]byte, error) {
- type noMethod WriteTimeseriesResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "cloudmonitoring.metricDescriptors.create":
-
-type MetricDescriptorsCreateCall struct {
- s *Service
- project string
- metricdescriptor *MetricDescriptor
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Create: Create a new metric.
-func (r *MetricDescriptorsService) Create(project string, metricdescriptor *MetricDescriptor) *MetricDescriptorsCreateCall {
- c := &MetricDescriptorsCreateCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.metricdescriptor = metricdescriptor
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MetricDescriptorsCreateCall) Fields(s ...googleapi.Field) *MetricDescriptorsCreateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MetricDescriptorsCreateCall) Context(ctx context.Context) *MetricDescriptorsCreateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MetricDescriptorsCreateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.metricdescriptor)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/metricDescriptors")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudmonitoring.metricDescriptors.create" call.
-// Exactly one of *MetricDescriptor or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *MetricDescriptor.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MetricDescriptorsCreateCall) Do() (*MetricDescriptor, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &MetricDescriptor{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Create a new metric.",
- // "httpMethod": "POST",
- // "id": "cloudmonitoring.metricDescriptors.create",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "The project id. The value can be the numeric project ID or string-based project name.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/metricDescriptors",
- // "request": {
- // "$ref": "MetricDescriptor"
- // },
- // "response": {
- // "$ref": "MetricDescriptor"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/monitoring"
- // ]
- // }
-
-}
-
-// method id "cloudmonitoring.metricDescriptors.delete":
-
-type MetricDescriptorsDeleteCall struct {
- s *Service
- project string
- metric string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Delete an existing metric.
-func (r *MetricDescriptorsService) Delete(project string, metric string) *MetricDescriptorsDeleteCall {
- c := &MetricDescriptorsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.metric = metric
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MetricDescriptorsDeleteCall) Fields(s ...googleapi.Field) *MetricDescriptorsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MetricDescriptorsDeleteCall) Context(ctx context.Context) *MetricDescriptorsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MetricDescriptorsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/metricDescriptors/{metric}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "metric": c.metric,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudmonitoring.metricDescriptors.delete" call.
-// Exactly one of *DeleteMetricDescriptorResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *DeleteMetricDescriptorResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MetricDescriptorsDeleteCall) Do() (*DeleteMetricDescriptorResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DeleteMetricDescriptorResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Delete an existing metric.",
- // "httpMethod": "DELETE",
- // "id": "cloudmonitoring.metricDescriptors.delete",
- // "parameterOrder": [
- // "project",
- // "metric"
- // ],
- // "parameters": {
- // "metric": {
- // "description": "Name of the metric.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID to which the metric belongs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/metricDescriptors/{metric}",
- // "response": {
- // "$ref": "DeleteMetricDescriptorResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/monitoring"
- // ]
- // }
-
-}
-
-// method id "cloudmonitoring.metricDescriptors.list":
-
-type MetricDescriptorsListCall struct {
- s *Service
- project string
- listmetricdescriptorsrequest *ListMetricDescriptorsRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List metric descriptors that match the query. If the query is
-// not set, then all of the metric descriptors will be returned. Large
-// responses will be paginated, use the nextPageToken returned in the
-// response to request subsequent pages of results by setting the
-// pageToken query parameter to the value of the nextPageToken.
-func (r *MetricDescriptorsService) List(project string, listmetricdescriptorsrequest *ListMetricDescriptorsRequest) *MetricDescriptorsListCall {
- c := &MetricDescriptorsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.listmetricdescriptorsrequest = listmetricdescriptorsrequest
- return c
-}
-
-// Count sets the optional parameter "count": Maximum number of metric
-// descriptors per page. Used for pagination. If not specified, count =
-// 100.
-func (c *MetricDescriptorsListCall) Count(count int64) *MetricDescriptorsListCall {
- c.opt_["count"] = count
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The pagination
-// token, which is used to page through large result sets. Set this
-// value to the value of the nextPageToken to retrieve the next page of
-// results.
-func (c *MetricDescriptorsListCall) PageToken(pageToken string) *MetricDescriptorsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Query sets the optional parameter "query": The query used to search
-// against existing metrics. Separate keywords with a space; the service
-// joins all keywords with AND, meaning that all keywords must match for
-// a metric to be returned. If this field is omitted, all metrics are
-// returned. If an empty string is passed with this field, no metrics
-// are returned.
-func (c *MetricDescriptorsListCall) Query(query string) *MetricDescriptorsListCall {
- c.opt_["query"] = query
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MetricDescriptorsListCall) Fields(s ...googleapi.Field) *MetricDescriptorsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MetricDescriptorsListCall) IfNoneMatch(entityTag string) *MetricDescriptorsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MetricDescriptorsListCall) Context(ctx context.Context) *MetricDescriptorsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MetricDescriptorsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["count"]; ok {
- params.Set("count", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["query"]; ok {
- params.Set("query", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/metricDescriptors")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudmonitoring.metricDescriptors.list" call.
-// Exactly one of *ListMetricDescriptorsResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *ListMetricDescriptorsResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MetricDescriptorsListCall) Do() (*ListMetricDescriptorsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ListMetricDescriptorsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List metric descriptors that match the query. If the query is not set, then all of the metric descriptors will be returned. Large responses will be paginated, use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.",
- // "httpMethod": "GET",
- // "id": "cloudmonitoring.metricDescriptors.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "count": {
- // "default": "100",
- // "description": "Maximum number of metric descriptors per page. Used for pagination. If not specified, count = 100.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "1000",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The pagination token, which is used to page through large result sets. Set this value to the value of the nextPageToken to retrieve the next page of results.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "The project id. The value can be the numeric project ID or string-based project name.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "query": {
- // "description": "The query used to search against existing metrics. Separate keywords with a space; the service joins all keywords with AND, meaning that all keywords must match for a metric to be returned. If this field is omitted, all metrics are returned. If an empty string is passed with this field, no metrics are returned.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "{project}/metricDescriptors",
- // "request": {
- // "$ref": "ListMetricDescriptorsRequest"
- // },
- // "response": {
- // "$ref": "ListMetricDescriptorsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/monitoring"
- // ]
- // }
-
-}
-
-// method id "cloudmonitoring.timeseries.list":
-
-type TimeseriesListCall struct {
- s *Service
- project string
- metric string
- youngest string
- listtimeseriesrequest *ListTimeseriesRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List the data points of the time series that match the metric
-// and labels values and that have data points in the interval. Large
-// responses are paginated; use the nextPageToken returned in the
-// response to request subsequent pages of results by setting the
-// pageToken query parameter to the value of the nextPageToken.
-func (r *TimeseriesService) List(project string, metric string, youngest string, listtimeseriesrequest *ListTimeseriesRequest) *TimeseriesListCall {
- c := &TimeseriesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.metric = metric
- c.youngest = youngest
- c.listtimeseriesrequest = listtimeseriesrequest
- return c
-}
-
-// Aggregator sets the optional parameter "aggregator": The aggregation
-// function that will reduce the data points in each window to a single
-// point. This parameter is only valid for non-cumulative metrics with a
-// value type of INT64 or DOUBLE.
-//
-// Possible values:
-// "max"
-// "mean"
-// "min"
-// "sum"
-func (c *TimeseriesListCall) Aggregator(aggregator string) *TimeseriesListCall {
- c.opt_["aggregator"] = aggregator
- return c
-}
-
-// Count sets the optional parameter "count": Maximum number of data
-// points per page, which is used for pagination of results.
-func (c *TimeseriesListCall) Count(count int64) *TimeseriesListCall {
- c.opt_["count"] = count
- return c
-}
-
-// Labels sets the optional parameter "labels": A collection of labels
-// for the matching time series, which are represented as:
-// - key==value: key equals the value
-// - key=~value: key regex matches the value
-// - key!=value: key does not equal the value
-// - key!~value: key regex does not match the value For example, to
-// list all of the time series descriptors for the region us-central1,
-// you could
-// specify:
-// label=cloud.googleapis.com%2Flocation=~us-central1.*
-func (c *TimeseriesListCall) Labels(labels string) *TimeseriesListCall {
- c.opt_["labels"] = labels
- return c
-}
-
-// Oldest sets the optional parameter "oldest": Start of the time
-// interval (exclusive), which is expressed as an RFC 3339 timestamp. If
-// neither oldest nor timespan is specified, the default time interval
-// will be (youngest - 4 hours, youngest]
-func (c *TimeseriesListCall) Oldest(oldest string) *TimeseriesListCall {
- c.opt_["oldest"] = oldest
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The pagination
-// token, which is used to page through large result sets. Set this
-// value to the value of the nextPageToken to retrieve the next page of
-// results.
-func (c *TimeseriesListCall) PageToken(pageToken string) *TimeseriesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Timespan sets the optional parameter "timespan": Length of the time
-// interval to query, which is an alternative way to declare the
-// interval: (youngest - timespan, youngest]. The timespan and oldest
-// parameters should not be used together. Units:
-// - s: second
-// - m: minute
-// - h: hour
-// - d: day
-// - w: week Examples: 2s, 3m, 4w. Only one unit is allowed, for
-// example: 2w3d is not allowed; you should use 17d instead.
-//
-// If neither oldest nor timespan is specified, the default time
-// interval will be (youngest - 4 hours, youngest].
-func (c *TimeseriesListCall) Timespan(timespan string) *TimeseriesListCall {
- c.opt_["timespan"] = timespan
- return c
-}
-
-// Window sets the optional parameter "window": The sampling window. At
-// most one data point will be returned for each window in the requested
-// time interval. This parameter is only valid for non-cumulative metric
-// types. Units:
-// - m: minute
-// - h: hour
-// - d: day
-// - w: week Examples: 3m, 4w. Only one unit is allowed, for example:
-// 2w3d is not allowed; you should use 17d instead.
-func (c *TimeseriesListCall) Window(window string) *TimeseriesListCall {
- c.opt_["window"] = window
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TimeseriesListCall) Fields(s ...googleapi.Field) *TimeseriesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TimeseriesListCall) IfNoneMatch(entityTag string) *TimeseriesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TimeseriesListCall) Context(ctx context.Context) *TimeseriesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TimeseriesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("youngest", fmt.Sprintf("%v", c.youngest))
- if v, ok := c.opt_["aggregator"]; ok {
- params.Set("aggregator", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["count"]; ok {
- params.Set("count", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["labels"]; ok {
- params.Set("labels", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["oldest"]; ok {
- params.Set("oldest", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["timespan"]; ok {
- params.Set("timespan", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["window"]; ok {
- params.Set("window", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/timeseries/{metric}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "metric": c.metric,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudmonitoring.timeseries.list" call.
-// Exactly one of *ListTimeseriesResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ListTimeseriesResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TimeseriesListCall) Do() (*ListTimeseriesResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ListTimeseriesResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List the data points of the time series that match the metric and labels values and that have data points in the interval. Large responses are paginated; use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.",
- // "httpMethod": "GET",
- // "id": "cloudmonitoring.timeseries.list",
- // "parameterOrder": [
- // "project",
- // "metric",
- // "youngest"
- // ],
- // "parameters": {
- // "aggregator": {
- // "description": "The aggregation function that will reduce the data points in each window to a single point. This parameter is only valid for non-cumulative metrics with a value type of INT64 or DOUBLE.",
- // "enum": [
- // "max",
- // "mean",
- // "min",
- // "sum"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "count": {
- // "default": "6000",
- // "description": "Maximum number of data points per page, which is used for pagination of results.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "12000",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "labels": {
- // "description": "A collection of labels for the matching time series, which are represented as: \n- key==value: key equals the value \n- key=~value: key regex matches the value \n- key!=value: key does not equal the value \n- key!~value: key regex does not match the value For example, to list all of the time series descriptors for the region us-central1, you could specify:\nlabel=cloud.googleapis.com%2Flocation=~us-central1.*",
- // "location": "query",
- // "pattern": "(.+?)(==|=~|!=|!~)(.+)",
- // "repeated": true,
- // "type": "string"
- // },
- // "metric": {
- // "description": "Metric names are protocol-free URLs as listed in the Supported Metrics page. For example, compute.googleapis.com/instance/disk/read_ops_count.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "oldest": {
- // "description": "Start of the time interval (exclusive), which is expressed as an RFC 3339 timestamp. If neither oldest nor timespan is specified, the default time interval will be (youngest - 4 hours, youngest]",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "The pagination token, which is used to page through large result sets. Set this value to the value of the nextPageToken to retrieve the next page of results.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID to which this time series belongs. The value can be the numeric project ID or string-based project name.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "timespan": {
- // "description": "Length of the time interval to query, which is an alternative way to declare the interval: (youngest - timespan, youngest]. The timespan and oldest parameters should not be used together. Units: \n- s: second \n- m: minute \n- h: hour \n- d: day \n- w: week Examples: 2s, 3m, 4w. Only one unit is allowed, for example: 2w3d is not allowed; you should use 17d instead.\n\nIf neither oldest nor timespan is specified, the default time interval will be (youngest - 4 hours, youngest].",
- // "location": "query",
- // "pattern": "[0-9]+[smhdw]?",
- // "type": "string"
- // },
- // "window": {
- // "description": "The sampling window. At most one data point will be returned for each window in the requested time interval. This parameter is only valid for non-cumulative metric types. Units: \n- m: minute \n- h: hour \n- d: day \n- w: week Examples: 3m, 4w. Only one unit is allowed, for example: 2w3d is not allowed; you should use 17d instead.",
- // "location": "query",
- // "pattern": "[0-9]+[mhdw]?",
- // "type": "string"
- // },
- // "youngest": {
- // "description": "End of the time interval (inclusive), which is expressed as an RFC 3339 timestamp.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/timeseries/{metric}",
- // "request": {
- // "$ref": "ListTimeseriesRequest"
- // },
- // "response": {
- // "$ref": "ListTimeseriesResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/monitoring"
- // ]
- // }
-
-}
-
-// method id "cloudmonitoring.timeseries.write":
-
-type TimeseriesWriteCall struct {
- s *Service
- project string
- writetimeseriesrequest *WriteTimeseriesRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Write: Put data points to one or more time series for one or more
-// metrics. If a time series does not exist, a new time series will be
-// created. It is not allowed to write a time series point that is older
-// than the existing youngest point of that time series. Points that are
-// older than the existing youngest point of that time series will be
-// discarded silently. Therefore, users should make sure that points of
-// a time series are written sequentially in the order of their end
-// time.
-func (r *TimeseriesService) Write(project string, writetimeseriesrequest *WriteTimeseriesRequest) *TimeseriesWriteCall {
- c := &TimeseriesWriteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.writetimeseriesrequest = writetimeseriesrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TimeseriesWriteCall) Fields(s ...googleapi.Field) *TimeseriesWriteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TimeseriesWriteCall) Context(ctx context.Context) *TimeseriesWriteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TimeseriesWriteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.writetimeseriesrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/timeseries:write")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudmonitoring.timeseries.write" call.
-// Exactly one of *WriteTimeseriesResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *WriteTimeseriesResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TimeseriesWriteCall) Do() (*WriteTimeseriesResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &WriteTimeseriesResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Put data points to one or more time series for one or more metrics. If a time series does not exist, a new time series will be created. It is not allowed to write a time series point that is older than the existing youngest point of that time series. Points that are older than the existing youngest point of that time series will be discarded silently. Therefore, users should make sure that points of a time series are written sequentially in the order of their end time.",
- // "httpMethod": "POST",
- // "id": "cloudmonitoring.timeseries.write",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "The project ID. The value can be the numeric project ID or string-based project name.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/timeseries:write",
- // "request": {
- // "$ref": "WriteTimeseriesRequest"
- // },
- // "response": {
- // "$ref": "WriteTimeseriesResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/monitoring"
- // ]
- // }
-
-}
-
-// method id "cloudmonitoring.timeseriesDescriptors.list":
-
-type TimeseriesDescriptorsListCall struct {
- s *Service
- project string
- metric string
- youngest string
- listtimeseriesdescriptorsrequest *ListTimeseriesDescriptorsRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List the descriptors of the time series that match the metric
-// and labels values and that have data points in the interval. Large
-// responses are paginated; use the nextPageToken returned in the
-// response to request subsequent pages of results by setting the
-// pageToken query parameter to the value of the nextPageToken.
-func (r *TimeseriesDescriptorsService) List(project string, metric string, youngest string, listtimeseriesdescriptorsrequest *ListTimeseriesDescriptorsRequest) *TimeseriesDescriptorsListCall {
- c := &TimeseriesDescriptorsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.metric = metric
- c.youngest = youngest
- c.listtimeseriesdescriptorsrequest = listtimeseriesdescriptorsrequest
- return c
-}
-
-// Aggregator sets the optional parameter "aggregator": The aggregation
-// function that will reduce the data points in each window to a single
-// point. This parameter is only valid for non-cumulative metrics with a
-// value type of INT64 or DOUBLE.
-//
-// Possible values:
-// "max"
-// "mean"
-// "min"
-// "sum"
-func (c *TimeseriesDescriptorsListCall) Aggregator(aggregator string) *TimeseriesDescriptorsListCall {
- c.opt_["aggregator"] = aggregator
- return c
-}
-
-// Count sets the optional parameter "count": Maximum number of time
-// series descriptors per page. Used for pagination. If not specified,
-// count = 100.
-func (c *TimeseriesDescriptorsListCall) Count(count int64) *TimeseriesDescriptorsListCall {
- c.opt_["count"] = count
- return c
-}
-
-// Labels sets the optional parameter "labels": A collection of labels
-// for the matching time series, which are represented as:
-// - key==value: key equals the value
-// - key=~value: key regex matches the value
-// - key!=value: key does not equal the value
-// - key!~value: key regex does not match the value For example, to
-// list all of the time series descriptors for the region us-central1,
-// you could
-// specify:
-// label=cloud.googleapis.com%2Flocation=~us-central1.*
-func (c *TimeseriesDescriptorsListCall) Labels(labels string) *TimeseriesDescriptorsListCall {
- c.opt_["labels"] = labels
- return c
-}
-
-// Oldest sets the optional parameter "oldest": Start of the time
-// interval (exclusive), which is expressed as an RFC 3339 timestamp. If
-// neither oldest nor timespan is specified, the default time interval
-// will be (youngest - 4 hours, youngest]
-func (c *TimeseriesDescriptorsListCall) Oldest(oldest string) *TimeseriesDescriptorsListCall {
- c.opt_["oldest"] = oldest
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The pagination
-// token, which is used to page through large result sets. Set this
-// value to the value of the nextPageToken to retrieve the next page of
-// results.
-func (c *TimeseriesDescriptorsListCall) PageToken(pageToken string) *TimeseriesDescriptorsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Timespan sets the optional parameter "timespan": Length of the time
-// interval to query, which is an alternative way to declare the
-// interval: (youngest - timespan, youngest]. The timespan and oldest
-// parameters should not be used together. Units:
-// - s: second
-// - m: minute
-// - h: hour
-// - d: day
-// - w: week Examples: 2s, 3m, 4w. Only one unit is allowed, for
-// example: 2w3d is not allowed; you should use 17d instead.
-//
-// If neither oldest nor timespan is specified, the default time
-// interval will be (youngest - 4 hours, youngest].
-func (c *TimeseriesDescriptorsListCall) Timespan(timespan string) *TimeseriesDescriptorsListCall {
- c.opt_["timespan"] = timespan
- return c
-}
-
-// Window sets the optional parameter "window": The sampling window. At
-// most one data point will be returned for each window in the requested
-// time interval. This parameter is only valid for non-cumulative metric
-// types. Units:
-// - m: minute
-// - h: hour
-// - d: day
-// - w: week Examples: 3m, 4w. Only one unit is allowed, for example:
-// 2w3d is not allowed; you should use 17d instead.
-func (c *TimeseriesDescriptorsListCall) Window(window string) *TimeseriesDescriptorsListCall {
- c.opt_["window"] = window
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TimeseriesDescriptorsListCall) Fields(s ...googleapi.Field) *TimeseriesDescriptorsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TimeseriesDescriptorsListCall) IfNoneMatch(entityTag string) *TimeseriesDescriptorsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TimeseriesDescriptorsListCall) Context(ctx context.Context) *TimeseriesDescriptorsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TimeseriesDescriptorsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("youngest", fmt.Sprintf("%v", c.youngest))
- if v, ok := c.opt_["aggregator"]; ok {
- params.Set("aggregator", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["count"]; ok {
- params.Set("count", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["labels"]; ok {
- params.Set("labels", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["oldest"]; ok {
- params.Set("oldest", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["timespan"]; ok {
- params.Set("timespan", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["window"]; ok {
- params.Set("window", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/timeseriesDescriptors/{metric}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "metric": c.metric,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudmonitoring.timeseriesDescriptors.list" call.
-// Exactly one of *ListTimeseriesDescriptorsResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *ListTimeseriesDescriptorsResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *TimeseriesDescriptorsListCall) Do() (*ListTimeseriesDescriptorsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ListTimeseriesDescriptorsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List the descriptors of the time series that match the metric and labels values and that have data points in the interval. Large responses are paginated; use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.",
- // "httpMethod": "GET",
- // "id": "cloudmonitoring.timeseriesDescriptors.list",
- // "parameterOrder": [
- // "project",
- // "metric",
- // "youngest"
- // ],
- // "parameters": {
- // "aggregator": {
- // "description": "The aggregation function that will reduce the data points in each window to a single point. This parameter is only valid for non-cumulative metrics with a value type of INT64 or DOUBLE.",
- // "enum": [
- // "max",
- // "mean",
- // "min",
- // "sum"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "count": {
- // "default": "100",
- // "description": "Maximum number of time series descriptors per page. Used for pagination. If not specified, count = 100.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "1000",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "labels": {
- // "description": "A collection of labels for the matching time series, which are represented as: \n- key==value: key equals the value \n- key=~value: key regex matches the value \n- key!=value: key does not equal the value \n- key!~value: key regex does not match the value For example, to list all of the time series descriptors for the region us-central1, you could specify:\nlabel=cloud.googleapis.com%2Flocation=~us-central1.*",
- // "location": "query",
- // "pattern": "(.+?)(==|=~|!=|!~)(.+)",
- // "repeated": true,
- // "type": "string"
- // },
- // "metric": {
- // "description": "Metric names are protocol-free URLs as listed in the Supported Metrics page. For example, compute.googleapis.com/instance/disk/read_ops_count.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "oldest": {
- // "description": "Start of the time interval (exclusive), which is expressed as an RFC 3339 timestamp. If neither oldest nor timespan is specified, the default time interval will be (youngest - 4 hours, youngest]",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "The pagination token, which is used to page through large result sets. Set this value to the value of the nextPageToken to retrieve the next page of results.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID to which this time series belongs. The value can be the numeric project ID or string-based project name.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "timespan": {
- // "description": "Length of the time interval to query, which is an alternative way to declare the interval: (youngest - timespan, youngest]. The timespan and oldest parameters should not be used together. Units: \n- s: second \n- m: minute \n- h: hour \n- d: day \n- w: week Examples: 2s, 3m, 4w. Only one unit is allowed, for example: 2w3d is not allowed; you should use 17d instead.\n\nIf neither oldest nor timespan is specified, the default time interval will be (youngest - 4 hours, youngest].",
- // "location": "query",
- // "pattern": "[0-9]+[smhdw]?",
- // "type": "string"
- // },
- // "window": {
- // "description": "The sampling window. At most one data point will be returned for each window in the requested time interval. This parameter is only valid for non-cumulative metric types. Units: \n- m: minute \n- h: hour \n- d: day \n- w: week Examples: 3m, 4w. Only one unit is allowed, for example: 2w3d is not allowed; you should use 17d instead.",
- // "location": "query",
- // "pattern": "[0-9]+[mhdw]?",
- // "type": "string"
- // },
- // "youngest": {
- // "description": "End of the time interval (inclusive), which is expressed as an RFC 3339 timestamp.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/timeseriesDescriptors/{metric}",
- // "request": {
- // "$ref": "ListTimeseriesDescriptorsRequest"
- // },
- // "response": {
- // "$ref": "ListTimeseriesDescriptorsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/monitoring"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json b/vendor/google.golang.org/api/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
deleted file mode 100644
index 64728338..00000000
--- a/vendor/google.golang.org/api/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
+++ /dev/null
@@ -1,716 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/YIS10F0R5FiTmx2jJKQHlRv-GwY\"",
- "discoveryVersion": "v1",
- "id": "cloudresourcemanager:v1beta1",
- "name": "cloudresourcemanager",
- "version": "v1beta1",
- "revision": "20150909",
- "title": "Google Cloud Resource Manager API",
- "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating of project metadata.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/resource-manager",
- "protocol": "rest",
- "baseUrl": "https://cloudresourcemanager.googleapis.com/",
- "basePath": "/",
- "rootUrl": "https://cloudresourcemanager.googleapis.com/",
- "servicePath": "",
- "batchPath": "batch",
- "parameters": {
- "access_token": {
- "type": "string",
- "description": "OAuth access token.",
- "location": "query"
- },
- "alt": {
- "type": "string",
- "description": "Data format for response.",
- "default": "json",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "bearer_token": {
- "type": "string",
- "description": "OAuth bearer token.",
- "location": "query"
- },
- "callback": {
- "type": "string",
- "description": "JSONP",
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "pp": {
- "type": "boolean",
- "description": "Pretty-print response.",
- "default": "true",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "location": "query"
- },
- "upload_protocol": {
- "type": "string",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "location": "query"
- },
- "uploadType": {
- "type": "string",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query"
- },
- "$.xgafv": {
- "type": "string",
- "description": "V1 error format.",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "schemas": {
- "Project": {
- "id": "Project",
- "type": "object",
- "description": "A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources.",
- "properties": {
- "projectNumber": {
- "type": "string",
- "description": "The number uniquely identifying the project. Example: 415104041262 Read-only.",
- "format": "int64"
- },
- "projectId": {
- "type": "string",
- "description": "The unique, user-assigned ID of the project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation."
- },
- "lifecycleState": {
- "type": "string",
- "description": "The project lifecycle state. Read-only.",
- "enum": [
- "LIFECYCLE_STATE_UNSPECIFIED",
- "ACTIVE",
- "DELETE_REQUESTED",
- "DELETE_IN_PROGRESS"
- ]
- },
- "name": {
- "type": "string",
- "description": "The user-assigned name of the project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write."
- },
- "createTime": {
- "type": "string",
- "description": "Creation time. Read-only."
- },
- "labels": {
- "type": "object",
- "description": "The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: \"environment\" : \"dev\" Read-write.",
- "additionalProperties": {
- "type": "string"
- }
- },
- "parent": {
- "$ref": "ResourceId",
- "description": "An optional reference to a parent Resource. The only supported parent type is \"organization\". Once set, the parent cannot be modified. Read-write."
- }
- }
- },
- "ResourceId": {
- "id": "ResourceId",
- "type": "object",
- "description": "A container to reference an id for any resource type. A 'resource' in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, Cloud SQL database, ...",
- "properties": {
- "type": {
- "type": "string",
- "description": "Required field representing the resource type this id is for. At present, the only valid type is \"organization\"."
- },
- "id": {
- "type": "string",
- "description": "Required field for the type-specific id. This should correspond to the id used in the type-specific API's."
- }
- }
- },
- "ListProjectsResponse": {
- "id": "ListProjectsResponse",
- "type": "object",
- "description": "A page of the response received from the [ListProjects][google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.ListProjects] method. A paginated response where more pages are available has `next_page_token` set. This token can be used in a subsequent request to retrieve the next request page.",
- "properties": {
- "projects": {
- "type": "array",
- "description": "The list of projects that matched the list filter. This list can be paginated.",
- "items": {
- "$ref": "Project"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime. Note: pagination is not yet supported; the server will not set this field."
- }
- }
- },
- "Empty": {
- "id": "Empty",
- "type": "object",
- "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`."
- },
- "GetIamPolicyRequest": {
- "id": "GetIamPolicyRequest",
- "type": "object",
- "description": "Request message for `GetIamPolicy` method."
- },
- "Policy": {
- "id": "Policy",
- "type": "object",
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** ``` { \"bindings\": [ { \"role\": \"roles/owner\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"] }, { \"role\": \"roles/viewer\", \"members\": [\"user:sean@example.com\"] } ] } ``` For a description of IAM and its features, see the [IAM developer's guide][https://cloud.google.com/iam].",
- "properties": {
- "version": {
- "type": "integer",
- "description": "Version of the `Policy`. The default version is 0.",
- "format": "int32"
- },
- "bindings": {
- "type": "array",
- "description": "Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.",
- "items": {
- "$ref": "Binding"
- }
- },
- "etag": {
- "type": "string",
- "description": "Can be used to perform a read-modify-write.",
- "format": "byte"
- }
- }
- },
- "Binding": {
- "id": "Binding",
- "type": "object",
- "description": "Associates `members` with a `role`.",
- "properties": {
- "role": {
- "type": "string",
- "description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required"
- },
- "members": {
- "type": "array",
- "description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following formats: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "SetIamPolicyRequest": {
- "id": "SetIamPolicyRequest",
- "type": "object",
- "description": "Request message for `SetIamPolicy` method.",
- "properties": {
- "policy": {
- "$ref": "Policy",
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them."
- }
- }
- },
- "TestIamPermissionsRequest": {
- "id": "TestIamPermissionsRequest",
- "type": "object",
- "description": "Request message for `TestIamPermissions` method.",
- "properties": {
- "permissions": {
- "type": "array",
- "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "TestIamPermissionsResponse": {
- "id": "TestIamPermissionsResponse",
- "type": "object",
- "description": "Response message for `TestIamPermissions` method.",
- "properties": {
- "permissions": {
- "type": "array",
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "ListOrganizationsResponse": {
- "id": "ListOrganizationsResponse",
- "type": "object",
- "description": "The response returned from the ListOrganizations method.",
- "properties": {
- "organizations": {
- "type": "array",
- "description": "The list of Organizations that matched the list query, possibly paginated.",
- "items": {
- "$ref": "Organization"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "A pagination token to be used to retrieve the next page of results. If the result is too large to fit within the page size specified in the request, this field will be set with a token that can be used to fetch the next page of results. If this field is empty, it indicates that this response contains the last page of results."
- }
- }
- },
- "Organization": {
- "id": "Organization",
- "type": "object",
- "description": "The root node in the resource hierarchy to which a particular entity's (e.g., company) resources belong.",
- "properties": {
- "organizationId": {
- "type": "string",
- "description": "An immutable id for the Organization that is assigned on creation. This should be omitted when creating a new Organization. This field is read-only."
- },
- "displayName": {
- "type": "string",
- "description": "A friendly string to be used to refer to the Organization in the UI. This field is required."
- },
- "owner": {
- "$ref": "OrganizationOwner",
- "description": "The owner of this Organization. The owner should be specified upon creation. Once set, it cannot be changed. This field is required."
- }
- }
- },
- "OrganizationOwner": {
- "id": "OrganizationOwner",
- "type": "object",
- "description": "The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the OrganizationOwner. If the OrganizationOwner is deleted, the Organization and all its descendants will be deleted.",
- "properties": {
- "directoryCustomerId": {
- "type": "string",
- "description": "The Google for Work customer id used in the Directory API."
- }
- }
- }
- },
- "resources": {
- "projects": {
- "methods": {
- "create": {
- "id": "cloudresourcemanager.projects.create",
- "path": "v1beta1/projects",
- "httpMethod": "POST",
- "description": "Creates a project resource. Initially, the project resource is owned by its creator exclusively. The creator can later grant permission to others to read or update the project. Several APIs are activated automatically for the project, including Google Cloud Storage.",
- "request": {
- "$ref": "Project"
- },
- "response": {
- "$ref": "Project"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "list": {
- "id": "cloudresourcemanager.projects.list",
- "path": "v1beta1/projects",
- "httpMethod": "GET",
- "description": "Lists projects that are visible to the user and satisfy the specified filter. This method returns projects in an unspecified order. New projects do not necessarily appear at the end of the list.",
- "parameters": {
- "pageToken": {
- "type": "string",
- "description": "A pagination token returned from a previous call to ListProject that indicates from where listing should continue. Note: pagination is not yet supported; the server ignores this field. Optional.",
- "location": "query"
- },
- "pageSize": {
- "type": "integer",
- "description": "The maximum number of Projects to return in the response. The server can return fewer projects than requested. If unspecified, server picks an appropriate default. Note: pagination is not yet supported; the server ignores this field. Optional.",
- "format": "int32",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: + `name` + `id` + labels.key where *key* is the name of a label Some examples of using labels as filters: |Filter|Description| |------|-----------| |name:*|The project has a name.| |name:Howl|The project's name is `Howl` or `howl`.| |name:HOWL|Equivalent to above.| |NAME:howl|Equivalent to above.| |labels.color:*|The project has the label `color`.| |labels.color:red|The project's label `color` has the value `red`.| |labels.color:red label.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`. Optional.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "ListProjectsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "get": {
- "id": "cloudresourcemanager.projects.get",
- "path": "v1beta1/projects/{projectId}",
- "httpMethod": "GET",
- "description": "Retrieves the project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this project.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "The project ID (for example, `my-project-123`). Required.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "Project"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "update": {
- "id": "cloudresourcemanager.projects.update",
- "path": "v1beta1/projects/{projectId}",
- "httpMethod": "PUT",
- "description": "Updates the attributes of the project identified by the specified `project_id` (for example, `my-project-123`). The caller must have modify permissions for this project.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "The project ID (for example, `my-project-123`). Required.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId"
- ],
- "request": {
- "$ref": "Project"
- },
- "response": {
- "$ref": "Project"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "delete": {
- "id": "cloudresourcemanager.projects.delete",
- "path": "v1beta1/projects/{projectId}",
- "httpMethod": "DELETE",
- "description": "Marks the project identified by the specified `project_id` (for example, `my-project-123`) for deletion. This method will only affect the project if the following criteria are met: + The project does not have a billing account associated with it. + The project has a lifecycle state of [ACTIVE][google.cloudresourcemanager.projects.v1beta1.LifecycleState.ACTIVE]. This method changes the project's lifecycle state from [ACTIVE][google.cloudresourcemanager.projects.v1beta1.LifecycleState.ACTIVE] to [DELETE_REQUESTED] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_REQUESTED]. The deletion starts at an unspecified time, at which point the lifecycle state changes to [DELETE_IN_PROGRESS] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_IN_PROGRESS]. Until the deletion completes, you can check the lifecycle state checked by retrieving the project with [GetProject] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.GetProject], and the project remains visible to [ListProjects] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.ListProjects]. However, you cannot update the project. After the deletion completes, the project is not retrievable by the [GetProject] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.GetProject] and [ListProjects] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.ListProjects] methods. The caller must have modify permissions for this project.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "The project ID (for example, `foo-bar-123`). Required.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "undelete": {
- "id": "cloudresourcemanager.projects.undelete",
- "path": "v1beta1/projects/{projectId}:undelete",
- "httpMethod": "POST",
- "description": "Restores the project identified by the specified `project_id` (for example, `my-project-123`). You can only use this method for a project that has a lifecycle state of [DELETE_REQUESTED] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_REQUESTED]. After deletion starts, as indicated by a lifecycle state of [DELETE_IN_PROGRESS] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_IN_PROGRESS], the project cannot be restored. The caller must have modify permissions for this project.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "The project ID (for example, `foo-bar-123`). Required.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "getIamPolicy": {
- "id": "cloudresourcemanager.projects.getIamPolicy",
- "path": "v1beta1/projects/{resource}:getIamPolicy",
- "httpMethod": "POST",
- "description": "Returns the IAM access control policy for specified project.",
- "parameters": {
- "resource": {
- "type": "string",
- "description": "REQUIRED: The resource for which policy is being requested. Resource is usually specified as a path, such as, `projects/{project}`.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "resource"
- ],
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "setIamPolicy": {
- "id": "cloudresourcemanager.projects.setIamPolicy",
- "path": "v1beta1/projects/{resource}:setIamPolicy",
- "httpMethod": "POST",
- "description": "Sets the IAM access control policy for the specified project. We do not currently support 'domain:' prefixed members in a Binding of a Policy. Calling this method requires enabling the App Engine Admin API.",
- "parameters": {
- "resource": {
- "type": "string",
- "description": "REQUIRED: The resource for which policy is being specified. `resource` is usually specified as a path, such as, `projects/{project}/zones/{zone}/disks/{disk}`.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "resource"
- ],
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "testIamPermissions": {
- "id": "cloudresourcemanager.projects.testIamPermissions",
- "path": "v1beta1/projects/{resource}:testIamPermissions",
- "httpMethod": "POST",
- "description": "Tests the specified permissions against the IAM access control policy for the specified project.",
- "parameters": {
- "resource": {
- "type": "string",
- "description": "REQUIRED: The resource for which policy detail is being requested. `resource` is usually specified as a path, such as, `projects/{project}`.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "resource"
- ],
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- },
- "organizations": {
- "methods": {
- "list": {
- "id": "cloudresourcemanager.organizations.list",
- "path": "v1beta1/organizations",
- "httpMethod": "GET",
- "description": "Query Organization resources.",
- "parameters": {
- "pageSize": {
- "type": "integer",
- "description": "The maximum number of Organizations to return in the response. This field is optional.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A pagination token returned from a previous call to ListOrganizations that indicates from where listing should continue. This field is optional.",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "An optional query string used to filter the Organizations to be return in the response. Filter rules are case-insensitive. Organizations may be filtered by `owner.directoryCustomerId` or by `domain`, where the domain is a Google for Work domain, for example: |Filter|Description| |------|-----------| |owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.| |domain:google.com|Organizations corresponding to the domain `google.com`.| This field is optional.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "ListOrganizationsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "get": {
- "id": "cloudresourcemanager.organizations.get",
- "path": "v1beta1/organizations/{organizationId}",
- "httpMethod": "GET",
- "description": "Fetches an Organization resource by id.",
- "parameters": {
- "organizationId": {
- "type": "string",
- "description": "The id of the Organization resource to fetch.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "organizationId"
- ],
- "response": {
- "$ref": "Organization"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "update": {
- "id": "cloudresourcemanager.organizations.update",
- "path": "v1beta1/organizations/{organizationId}",
- "httpMethod": "PUT",
- "description": "Updates an Organization resource.",
- "parameters": {
- "organizationId": {
- "type": "string",
- "description": "An immutable id for the Organization that is assigned on creation. This should be omitted when creating a new Organization. This field is read-only.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "organizationId"
- ],
- "request": {
- "$ref": "Organization"
- },
- "response": {
- "$ref": "Organization"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "setIamPolicy": {
- "id": "cloudresourcemanager.organizations.setIamPolicy",
- "path": "v1beta1/organizations/{resource}:setIamPolicy",
- "httpMethod": "POST",
- "description": "Sets the access control policy on a Organization resource. Replaces any existing policy.",
- "parameters": {
- "resource": {
- "type": "string",
- "description": "REQUIRED: The resource for which policy is being specified. `resource` is usually specified as a path, such as, `projects/{project}/zones/{zone}/disks/{disk}`.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "resource"
- ],
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "getIamPolicy": {
- "id": "cloudresourcemanager.organizations.getIamPolicy",
- "path": "v1beta1/organizations/{resource}:getIamPolicy",
- "httpMethod": "POST",
- "description": "Gets the access control policy for a Organization resource. May be empty if no such policy or resource exists.",
- "parameters": {
- "resource": {
- "type": "string",
- "description": "REQUIRED: The resource for which policy is being requested. Resource is usually specified as a path, such as, `projects/{project}`.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "resource"
- ],
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "testIamPermissions": {
- "id": "cloudresourcemanager.organizations.testIamPermissions",
- "path": "v1beta1/organizations/{resource}:testIamPermissions",
- "httpMethod": "POST",
- "description": "Returns permissions that a caller has on the specified Organization.",
- "parameters": {
- "resource": {
- "type": "string",
- "description": "REQUIRED: The resource for which policy detail is being requested. `resource` is usually specified as a path, such as, `projects/{project}`.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "resource"
- ],
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/cloudresourcemanager/v1beta1/cloudresourcemanager-gen.go b/vendor/google.golang.org/api/cloudresourcemanager/v1beta1/cloudresourcemanager-gen.go
deleted file mode 100644
index 756d0b45..00000000
--- a/vendor/google.golang.org/api/cloudresourcemanager/v1beta1/cloudresourcemanager-gen.go
+++ /dev/null
@@ -1,2466 +0,0 @@
-// Package cloudresourcemanager provides access to the Google Cloud Resource Manager API.
-//
-// See https://cloud.google.com/resource-manager
-//
-// Usage example:
-//
-// import "google.golang.org/api/cloudresourcemanager/v1beta1"
-// ...
-// cloudresourcemanagerService, err := cloudresourcemanager.New(oauthHttpClient)
-package cloudresourcemanager // import "google.golang.org/api/cloudresourcemanager/v1beta1"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "cloudresourcemanager:v1beta1"
-const apiName = "cloudresourcemanager"
-const apiVersion = "v1beta1"
-const basePath = "https://cloudresourcemanager.googleapis.com/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your data across Google Cloud Platform services
- CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Organizations = NewOrganizationsService(s)
- s.Projects = NewProjectsService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Organizations *OrganizationsService
-
- Projects *ProjectsService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewOrganizationsService(s *Service) *OrganizationsService {
- rs := &OrganizationsService{s: s}
- return rs
-}
-
-type OrganizationsService struct {
- s *Service
-}
-
-func NewProjectsService(s *Service) *ProjectsService {
- rs := &ProjectsService{s: s}
- return rs
-}
-
-type ProjectsService struct {
- s *Service
-}
-
-// Binding: Associates `members` with a `role`.
-type Binding struct {
- // Members: Specifies the identities requesting access for a Cloud
- // Platform resource. `members` can have the following formats: *
- // `allUsers`: A special identifier that represents anyone who is on the
- // internet; with or without a Google account. *
- // `allAuthenticatedUsers`: A special identifier that represents anyone
- // who is authenticated with a Google account or a service account. *
- // `user:{emailid}`: An email address that represents a specific Google
- // account. For example, `alice@gmail.com` or `joe@example.com`. *
- // `serviceAccount:{emailid}`: An email address that represents a
- // service account. For example,
- // `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An
- // email address that represents a Google group. For example,
- // `admins@example.com`. * `domain:{domain}`: A Google Apps domain name
- // that represents all the users of that domain. For example,
- // `google.com` or `example.com`.
- Members []string `json:"members,omitempty"`
-
- // Role: Role that is assigned to `members`. For example,
- // `roles/viewer`, `roles/editor`, or `roles/owner`. Required
- Role string `json:"role,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Members") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Binding) MarshalJSON() ([]byte, error) {
- type noMethod Binding
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Empty: A generic empty message that you can re-use to avoid defining
-// duplicated empty messages in your APIs. A typical example is to use
-// it as the request or the response type of an API method. For
-// instance: service Foo { rpc Bar(google.protobuf.Empty) returns
-// (google.protobuf.Empty); } The JSON representation for `Empty` is
-// empty JSON object `{}`.
-type Empty struct {
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-}
-
-// GetIamPolicyRequest: Request message for `GetIamPolicy` method.
-type GetIamPolicyRequest struct {
-}
-
-// ListOrganizationsResponse: The response returned from the
-// ListOrganizations method.
-type ListOrganizationsResponse struct {
- // NextPageToken: A pagination token to be used to retrieve the next
- // page of results. If the result is too large to fit within the page
- // size specified in the request, this field will be set with a token
- // that can be used to fetch the next page of results. If this field is
- // empty, it indicates that this response contains the last page of
- // results.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Organizations: The list of Organizations that matched the list query,
- // possibly paginated.
- Organizations []*Organization `json:"organizations,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "NextPageToken") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListOrganizationsResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListOrganizationsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListProjectsResponse: A page of the response received from the
-// [ListProjects][google.cloudresourcemanager.projects.v1beta1.DeveloperP
-// rojects.ListProjects] method. A paginated response where more pages
-// are available has `next_page_token` set. This token can be used in a
-// subsequent request to retrieve the next request page.
-type ListProjectsResponse struct {
- // NextPageToken: Pagination token. If the result set is too large to
- // fit in a single response, this token is returned. It encodes the
- // position of the current result cursor. Feeding this value into a new
- // list request with the `page_token` parameter gives the next page of
- // the results. When `next_page_token` is not filled in, there is no
- // next page and the list returned is the last page in the result set.
- // Pagination tokens have a limited lifetime. Note: pagination is not
- // yet supported; the server will not set this field.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Projects: The list of projects that matched the list filter. This
- // list can be paginated.
- Projects []*Project `json:"projects,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "NextPageToken") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListProjectsResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListProjectsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Organization: The root node in the resource hierarchy to which a
-// particular entity's (e.g., company) resources belong.
-type Organization struct {
- // DisplayName: A friendly string to be used to refer to the
- // Organization in the UI. This field is required.
- DisplayName string `json:"displayName,omitempty"`
-
- // OrganizationId: An immutable id for the Organization that is assigned
- // on creation. This should be omitted when creating a new Organization.
- // This field is read-only.
- OrganizationId string `json:"organizationId,omitempty"`
-
- // Owner: The owner of this Organization. The owner should be specified
- // upon creation. Once set, it cannot be changed. This field is
- // required.
- Owner *OrganizationOwner `json:"owner,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "DisplayName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Organization) MarshalJSON() ([]byte, error) {
- type noMethod Organization
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OrganizationOwner: The entity that owns an Organization. The lifetime
-// of the Organization and all of its descendants are bound to the
-// OrganizationOwner. If the OrganizationOwner is deleted, the
-// Organization and all its descendants will be deleted.
-type OrganizationOwner struct {
- // DirectoryCustomerId: The Google for Work customer id used in the
- // Directory API.
- DirectoryCustomerId string `json:"directoryCustomerId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DirectoryCustomerId")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrganizationOwner) MarshalJSON() ([]byte, error) {
- type noMethod OrganizationOwner
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Policy: Defines an Identity and Access Management (IAM) policy. It is
-// used to specify access control policies for Cloud Platform resources.
-// A `Policy` consists of a list of `bindings`. A `Binding` binds a list
-// of `members` to a `role`, where the members can be user accounts,
-// Google groups, Google domains, and service accounts. A `role` is a
-// named list of permissions defined by IAM. **Example** ``` {
-// "bindings": [ { "role": "roles/owner", "members": [
-// "user:mike@example.com", "group:admins@example.com",
-// "domain:google.com",
-// "serviceAccount:my-other-app@appspot.gserviceaccount.com"] }, {
-// "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
-// ``` For a description of IAM and its features, see the [IAM
-// developer's guide][https://cloud.google.com/iam].
-type Policy struct {
- // Bindings: Associates a list of `members` to a `role`. Multiple
- // `bindings` must not be specified for the same `role`. `bindings` with
- // no members will result in an error.
- Bindings []*Binding `json:"bindings,omitempty"`
-
- // Etag: Can be used to perform a read-modify-write.
- Etag string `json:"etag,omitempty"`
-
- // Version: Version of the `Policy`. The default version is 0.
- Version int64 `json:"version,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Bindings") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Policy) MarshalJSON() ([]byte, error) {
- type noMethod Policy
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Project: A Project is a high-level Google Cloud Platform entity. It
-// is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google
-// Cloud Platform resources.
-type Project struct {
- // CreateTime: Creation time. Read-only.
- CreateTime string `json:"createTime,omitempty"`
-
- // Labels: The labels associated with this project. Label keys must be
- // between 1 and 63 characters long and must conform to the following
- // regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values
- // must be between 0 and 63 characters long and must conform to the
- // regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than
- // 256 labels can be associated with a given resource. Clients should
- // store labels in a representation such as JSON that does not depend on
- // specific characters being disallowed. Example: "environment" : "dev"
- // Read-write.
- Labels map[string]string `json:"labels,omitempty"`
-
- // LifecycleState: The project lifecycle state. Read-only.
- //
- // Possible values:
- // "LIFECYCLE_STATE_UNSPECIFIED"
- // "ACTIVE"
- // "DELETE_REQUESTED"
- // "DELETE_IN_PROGRESS"
- LifecycleState string `json:"lifecycleState,omitempty"`
-
- // Name: The user-assigned name of the project. It must be 4 to 30
- // characters. Allowed characters are: lowercase and uppercase letters,
- // numbers, hyphen, single-quote, double-quote, space, and exclamation
- // point. Example: My Project Read-write.
- Name string `json:"name,omitempty"`
-
- // Parent: An optional reference to a parent Resource. The only
- // supported parent type is "organization". Once set, the parent cannot
- // be modified. Read-write.
- Parent *ResourceId `json:"parent,omitempty"`
-
- // ProjectId: The unique, user-assigned ID of the project. It must be 6
- // to 30 lowercase letters, digits, or hyphens. It must start with a
- // letter. Trailing hyphens are prohibited. Example: tokyo-rain-123
- // Read-only after creation.
- ProjectId string `json:"projectId,omitempty"`
-
- // ProjectNumber: The number uniquely identifying the project. Example:
- // 415104041262 Read-only.
- ProjectNumber int64 `json:"projectNumber,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreateTime") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Project) MarshalJSON() ([]byte, error) {
- type noMethod Project
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ResourceId: A container to reference an id for any resource type. A
-// 'resource' in Google Cloud Platform is a generic term for something
-// you (a developer) may want to interact with through one of our API's.
-// Some examples are an AppEngine app, a Compute Engine instance, Cloud
-// SQL database, ...
-type ResourceId struct {
- // Id: Required field for the type-specific id. This should correspond
- // to the id used in the type-specific API's.
- Id string `json:"id,omitempty"`
-
- // Type: Required field representing the resource type this id is for.
- // At present, the only valid type is "organization".
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ResourceId) MarshalJSON() ([]byte, error) {
- type noMethod ResourceId
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SetIamPolicyRequest: Request message for `SetIamPolicy` method.
-type SetIamPolicyRequest struct {
- // Policy: REQUIRED: The complete policy to be applied to the
- // `resource`. The size of the policy is limited to a few 10s of KB. An
- // empty policy is a valid policy but certain Cloud Platform services
- // (such as Projects) might reject them.
- Policy *Policy `json:"policy,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Policy") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SetIamPolicyRequest) MarshalJSON() ([]byte, error) {
- type noMethod SetIamPolicyRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TestIamPermissionsRequest: Request message for `TestIamPermissions`
-// method.
-type TestIamPermissionsRequest struct {
- // Permissions: The set of permissions to check for the `resource`.
- // Permissions with wildcards (such as '*' or 'storage.*') are not
- // allowed.
- Permissions []string `json:"permissions,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Permissions") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TestIamPermissionsRequest) MarshalJSON() ([]byte, error) {
- type noMethod TestIamPermissionsRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TestIamPermissionsResponse: Response message for `TestIamPermissions`
-// method.
-type TestIamPermissionsResponse struct {
- // Permissions: A subset of `TestPermissionsRequest.permissions` that
- // the caller is allowed.
- Permissions []string `json:"permissions,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Permissions") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TestIamPermissionsResponse) MarshalJSON() ([]byte, error) {
- type noMethod TestIamPermissionsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "cloudresourcemanager.organizations.get":
-
-type OrganizationsGetCall struct {
- s *Service
- organizationId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Fetches an Organization resource by id.
-func (r *OrganizationsService) Get(organizationId string) *OrganizationsGetCall {
- c := &OrganizationsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.organizationId = organizationId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrganizationsGetCall) Fields(s ...googleapi.Field) *OrganizationsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OrganizationsGetCall) IfNoneMatch(entityTag string) *OrganizationsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrganizationsGetCall) Context(ctx context.Context) *OrganizationsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrganizationsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/organizations/{organizationId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "organizationId": c.organizationId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudresourcemanager.organizations.get" call.
-// Exactly one of *Organization or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Organization.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *OrganizationsGetCall) Do() (*Organization, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Organization{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Fetches an Organization resource by id.",
- // "httpMethod": "GET",
- // "id": "cloudresourcemanager.organizations.get",
- // "parameterOrder": [
- // "organizationId"
- // ],
- // "parameters": {
- // "organizationId": {
- // "description": "The id of the Organization resource to fetch.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1beta1/organizations/{organizationId}",
- // "response": {
- // "$ref": "Organization"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "cloudresourcemanager.organizations.getIamPolicy":
-
-type OrganizationsGetIamPolicyCall struct {
- s *Service
- resource string
- getiampolicyrequest *GetIamPolicyRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetIamPolicy: Gets the access control policy for a Organization
-// resource. May be empty if no such policy or resource exists.
-func (r *OrganizationsService) GetIamPolicy(resource string, getiampolicyrequest *GetIamPolicyRequest) *OrganizationsGetIamPolicyCall {
- c := &OrganizationsGetIamPolicyCall{s: r.s, opt_: make(map[string]interface{})}
- c.resource = resource
- c.getiampolicyrequest = getiampolicyrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrganizationsGetIamPolicyCall) Fields(s ...googleapi.Field) *OrganizationsGetIamPolicyCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrganizationsGetIamPolicyCall) Context(ctx context.Context) *OrganizationsGetIamPolicyCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrganizationsGetIamPolicyCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.getiampolicyrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/organizations/{resource}:getIamPolicy")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "resource": c.resource,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudresourcemanager.organizations.getIamPolicy" call.
-// Exactly one of *Policy or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Policy.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *OrganizationsGetIamPolicyCall) Do() (*Policy, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Policy{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the access control policy for a Organization resource. May be empty if no such policy or resource exists.",
- // "httpMethod": "POST",
- // "id": "cloudresourcemanager.organizations.getIamPolicy",
- // "parameterOrder": [
- // "resource"
- // ],
- // "parameters": {
- // "resource": {
- // "description": "REQUIRED: The resource for which policy is being requested. Resource is usually specified as a path, such as, `projects/{project}`.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1beta1/organizations/{resource}:getIamPolicy",
- // "request": {
- // "$ref": "GetIamPolicyRequest"
- // },
- // "response": {
- // "$ref": "Policy"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "cloudresourcemanager.organizations.list":
-
-type OrganizationsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Query Organization resources.
-func (r *OrganizationsService) List() *OrganizationsListCall {
- c := &OrganizationsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Filter sets the optional parameter "filter": An optional query string
-// used to filter the Organizations to be return in the response. Filter
-// rules are case-insensitive. Organizations may be filtered by
-// `owner.directoryCustomerId` or by `domain`, where the domain is a
-// Google for Work domain, for example: |Filter|Description|
-// |------|-----------|
-// |owner.directorycustomerid:123456789|Organizations with
-// `owner.directory_customer_id` equal to `123456789`.|
-// |domain:google.com|Organizations corresponding to the domain
-// `google.com`.| This field is optional.
-func (c *OrganizationsListCall) Filter(filter string) *OrganizationsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// PageSize sets the optional parameter "pageSize": The maximum number
-// of Organizations to return in the response. This field is optional.
-func (c *OrganizationsListCall) PageSize(pageSize int64) *OrganizationsListCall {
- c.opt_["pageSize"] = pageSize
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A pagination token
-// returned from a previous call to ListOrganizations that indicates
-// from where listing should continue. This field is optional.
-func (c *OrganizationsListCall) PageToken(pageToken string) *OrganizationsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrganizationsListCall) Fields(s ...googleapi.Field) *OrganizationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OrganizationsListCall) IfNoneMatch(entityTag string) *OrganizationsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrganizationsListCall) Context(ctx context.Context) *OrganizationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrganizationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageSize"]; ok {
- params.Set("pageSize", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/organizations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudresourcemanager.organizations.list" call.
-// Exactly one of *ListOrganizationsResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *ListOrganizationsResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OrganizationsListCall) Do() (*ListOrganizationsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ListOrganizationsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Query Organization resources.",
- // "httpMethod": "GET",
- // "id": "cloudresourcemanager.organizations.list",
- // "parameters": {
- // "filter": {
- // "description": "An optional query string used to filter the Organizations to be return in the response. Filter rules are case-insensitive. Organizations may be filtered by `owner.directoryCustomerId` or by `domain`, where the domain is a Google for Work domain, for example: |Filter|Description| |------|-----------| |owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.| |domain:google.com|Organizations corresponding to the domain `google.com`.| This field is optional.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageSize": {
- // "description": "The maximum number of Organizations to return in the response. This field is optional.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A pagination token returned from a previous call to ListOrganizations that indicates from where listing should continue. This field is optional.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "v1beta1/organizations",
- // "response": {
- // "$ref": "ListOrganizationsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "cloudresourcemanager.organizations.setIamPolicy":
-
-type OrganizationsSetIamPolicyCall struct {
- s *Service
- resource string
- setiampolicyrequest *SetIamPolicyRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetIamPolicy: Sets the access control policy on a Organization
-// resource. Replaces any existing policy.
-func (r *OrganizationsService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *OrganizationsSetIamPolicyCall {
- c := &OrganizationsSetIamPolicyCall{s: r.s, opt_: make(map[string]interface{})}
- c.resource = resource
- c.setiampolicyrequest = setiampolicyrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrganizationsSetIamPolicyCall) Fields(s ...googleapi.Field) *OrganizationsSetIamPolicyCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrganizationsSetIamPolicyCall) Context(ctx context.Context) *OrganizationsSetIamPolicyCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrganizationsSetIamPolicyCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.setiampolicyrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/organizations/{resource}:setIamPolicy")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "resource": c.resource,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudresourcemanager.organizations.setIamPolicy" call.
-// Exactly one of *Policy or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Policy.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *OrganizationsSetIamPolicyCall) Do() (*Policy, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Policy{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sets the access control policy on a Organization resource. Replaces any existing policy.",
- // "httpMethod": "POST",
- // "id": "cloudresourcemanager.organizations.setIamPolicy",
- // "parameterOrder": [
- // "resource"
- // ],
- // "parameters": {
- // "resource": {
- // "description": "REQUIRED: The resource for which policy is being specified. `resource` is usually specified as a path, such as, `projects/{project}/zones/{zone}/disks/{disk}`.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1beta1/organizations/{resource}:setIamPolicy",
- // "request": {
- // "$ref": "SetIamPolicyRequest"
- // },
- // "response": {
- // "$ref": "Policy"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "cloudresourcemanager.organizations.testIamPermissions":
-
-type OrganizationsTestIamPermissionsCall struct {
- s *Service
- resource string
- testiampermissionsrequest *TestIamPermissionsRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// TestIamPermissions: Returns permissions that a caller has on the
-// specified Organization.
-func (r *OrganizationsService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *OrganizationsTestIamPermissionsCall {
- c := &OrganizationsTestIamPermissionsCall{s: r.s, opt_: make(map[string]interface{})}
- c.resource = resource
- c.testiampermissionsrequest = testiampermissionsrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrganizationsTestIamPermissionsCall) Fields(s ...googleapi.Field) *OrganizationsTestIamPermissionsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrganizationsTestIamPermissionsCall) Context(ctx context.Context) *OrganizationsTestIamPermissionsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrganizationsTestIamPermissionsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.testiampermissionsrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/organizations/{resource}:testIamPermissions")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "resource": c.resource,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudresourcemanager.organizations.testIamPermissions" call.
-// Exactly one of *TestIamPermissionsResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *TestIamPermissionsResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OrganizationsTestIamPermissionsCall) Do() (*TestIamPermissionsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TestIamPermissionsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns permissions that a caller has on the specified Organization.",
- // "httpMethod": "POST",
- // "id": "cloudresourcemanager.organizations.testIamPermissions",
- // "parameterOrder": [
- // "resource"
- // ],
- // "parameters": {
- // "resource": {
- // "description": "REQUIRED: The resource for which policy detail is being requested. `resource` is usually specified as a path, such as, `projects/{project}`.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1beta1/organizations/{resource}:testIamPermissions",
- // "request": {
- // "$ref": "TestIamPermissionsRequest"
- // },
- // "response": {
- // "$ref": "TestIamPermissionsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "cloudresourcemanager.organizations.update":
-
-type OrganizationsUpdateCall struct {
- s *Service
- organizationId string
- organization *Organization
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an Organization resource.
-func (r *OrganizationsService) Update(organizationId string, organization *Organization) *OrganizationsUpdateCall {
- c := &OrganizationsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.organizationId = organizationId
- c.organization = organization
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrganizationsUpdateCall) Fields(s ...googleapi.Field) *OrganizationsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrganizationsUpdateCall) Context(ctx context.Context) *OrganizationsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrganizationsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.organization)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/organizations/{organizationId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "organizationId": c.organizationId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudresourcemanager.organizations.update" call.
-// Exactly one of *Organization or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Organization.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *OrganizationsUpdateCall) Do() (*Organization, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Organization{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an Organization resource.",
- // "httpMethod": "PUT",
- // "id": "cloudresourcemanager.organizations.update",
- // "parameterOrder": [
- // "organizationId"
- // ],
- // "parameters": {
- // "organizationId": {
- // "description": "An immutable id for the Organization that is assigned on creation. This should be omitted when creating a new Organization. This field is read-only.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1beta1/organizations/{organizationId}",
- // "request": {
- // "$ref": "Organization"
- // },
- // "response": {
- // "$ref": "Organization"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "cloudresourcemanager.projects.create":
-
-type ProjectsCreateCall struct {
- s *Service
- project *Project
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Create: Creates a project resource. Initially, the project resource
-// is owned by its creator exclusively. The creator can later grant
-// permission to others to read or update the project. Several APIs are
-// activated automatically for the project, including Google Cloud
-// Storage.
-func (r *ProjectsService) Create(project *Project) *ProjectsCreateCall {
- c := &ProjectsCreateCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsCreateCall) Fields(s ...googleapi.Field) *ProjectsCreateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsCreateCall) Context(ctx context.Context) *ProjectsCreateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsCreateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.project)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/projects")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudresourcemanager.projects.create" call.
-// Exactly one of *Project or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Project.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ProjectsCreateCall) Do() (*Project, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Project{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a project resource. Initially, the project resource is owned by its creator exclusively. The creator can later grant permission to others to read or update the project. Several APIs are activated automatically for the project, including Google Cloud Storage.",
- // "httpMethod": "POST",
- // "id": "cloudresourcemanager.projects.create",
- // "path": "v1beta1/projects",
- // "request": {
- // "$ref": "Project"
- // },
- // "response": {
- // "$ref": "Project"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "cloudresourcemanager.projects.delete":
-
-type ProjectsDeleteCall struct {
- s *Service
- projectId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Marks the project identified by the specified `project_id`
-// (for example, `my-project-123`) for deletion. This method will only
-// affect the project if the following criteria are met: + The project
-// does not have a billing account associated with it. + The project has
-// a lifecycle state of
-// [ACTIVE][google.cloudresourcemanager.projects.v1beta1.LifecycleState.A
-// CTIVE]. This method changes the project's lifecycle state from
-// [ACTIVE][google.cloudresourcemanager.projects.v1beta1.LifecycleState.A
-// CTIVE] to [DELETE_REQUESTED]
-// [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_RE
-// QUESTED]. The deletion starts at an unspecified time, at which point
-// the lifecycle state changes to [DELETE_IN_PROGRESS]
-// [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_IN
-// _PROGRESS]. Until the deletion completes, you can check the lifecycle
-// state checked by retrieving the project with [GetProject]
-// [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.GetPro
-// ject], and the project remains visible to [ListProjects]
-// [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.ListPr
-// ojects]. However, you cannot update the project. After the deletion
-// completes, the project is not retrievable by the [GetProject]
-// [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.GetPro
-// ject] and [ListProjects]
-// [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.ListPr
-// ojects] methods. The caller must have modify permissions for this
-// project.
-func (r *ProjectsService) Delete(projectId string) *ProjectsDeleteCall {
- c := &ProjectsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsDeleteCall) Fields(s ...googleapi.Field) *ProjectsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsDeleteCall) Context(ctx context.Context) *ProjectsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/projects/{projectId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudresourcemanager.projects.delete" call.
-// Exactly one of *Empty or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Empty.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ProjectsDeleteCall) Do() (*Empty, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Empty{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Marks the project identified by the specified `project_id` (for example, `my-project-123`) for deletion. This method will only affect the project if the following criteria are met: + The project does not have a billing account associated with it. + The project has a lifecycle state of [ACTIVE][google.cloudresourcemanager.projects.v1beta1.LifecycleState.ACTIVE]. This method changes the project's lifecycle state from [ACTIVE][google.cloudresourcemanager.projects.v1beta1.LifecycleState.ACTIVE] to [DELETE_REQUESTED] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_REQUESTED]. The deletion starts at an unspecified time, at which point the lifecycle state changes to [DELETE_IN_PROGRESS] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_IN_PROGRESS]. Until the deletion completes, you can check the lifecycle state checked by retrieving the project with [GetProject] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.GetProject], and the project remains visible to [ListProjects] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.ListProjects]. However, you cannot update the project. After the deletion completes, the project is not retrievable by the [GetProject] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.GetProject] and [ListProjects] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.ListProjects] methods. The caller must have modify permissions for this project.",
- // "httpMethod": "DELETE",
- // "id": "cloudresourcemanager.projects.delete",
- // "parameterOrder": [
- // "projectId"
- // ],
- // "parameters": {
- // "projectId": {
- // "description": "The project ID (for example, `foo-bar-123`). Required.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1beta1/projects/{projectId}",
- // "response": {
- // "$ref": "Empty"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "cloudresourcemanager.projects.get":
-
-type ProjectsGetCall struct {
- s *Service
- projectId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves the project identified by the specified `project_id`
-// (for example, `my-project-123`). The caller must have read
-// permissions for this project.
-func (r *ProjectsService) Get(projectId string) *ProjectsGetCall {
- c := &ProjectsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsGetCall) Fields(s ...googleapi.Field) *ProjectsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ProjectsGetCall) IfNoneMatch(entityTag string) *ProjectsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsGetCall) Context(ctx context.Context) *ProjectsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/projects/{projectId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudresourcemanager.projects.get" call.
-// Exactly one of *Project or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Project.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ProjectsGetCall) Do() (*Project, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Project{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this project.",
- // "httpMethod": "GET",
- // "id": "cloudresourcemanager.projects.get",
- // "parameterOrder": [
- // "projectId"
- // ],
- // "parameters": {
- // "projectId": {
- // "description": "The project ID (for example, `my-project-123`). Required.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1beta1/projects/{projectId}",
- // "response": {
- // "$ref": "Project"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "cloudresourcemanager.projects.getIamPolicy":
-
-type ProjectsGetIamPolicyCall struct {
- s *Service
- resource string
- getiampolicyrequest *GetIamPolicyRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetIamPolicy: Returns the IAM access control policy for specified
-// project.
-func (r *ProjectsService) GetIamPolicy(resource string, getiampolicyrequest *GetIamPolicyRequest) *ProjectsGetIamPolicyCall {
- c := &ProjectsGetIamPolicyCall{s: r.s, opt_: make(map[string]interface{})}
- c.resource = resource
- c.getiampolicyrequest = getiampolicyrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsGetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsGetIamPolicyCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsGetIamPolicyCall) Context(ctx context.Context) *ProjectsGetIamPolicyCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsGetIamPolicyCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.getiampolicyrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/projects/{resource}:getIamPolicy")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "resource": c.resource,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudresourcemanager.projects.getIamPolicy" call.
-// Exactly one of *Policy or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Policy.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ProjectsGetIamPolicyCall) Do() (*Policy, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Policy{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the IAM access control policy for specified project.",
- // "httpMethod": "POST",
- // "id": "cloudresourcemanager.projects.getIamPolicy",
- // "parameterOrder": [
- // "resource"
- // ],
- // "parameters": {
- // "resource": {
- // "description": "REQUIRED: The resource for which policy is being requested. Resource is usually specified as a path, such as, `projects/{project}`.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1beta1/projects/{resource}:getIamPolicy",
- // "request": {
- // "$ref": "GetIamPolicyRequest"
- // },
- // "response": {
- // "$ref": "Policy"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "cloudresourcemanager.projects.list":
-
-type ProjectsListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists projects that are visible to the user and satisfy the
-// specified filter. This method returns projects in an unspecified
-// order. New projects do not necessarily appear at the end of the list.
-func (r *ProjectsService) List() *ProjectsListCall {
- c := &ProjectsListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Filter sets the optional parameter "filter": An expression for
-// filtering the results of the request. Filter rules are case
-// insensitive. The fields eligible for filtering are: + `name` + `id` +
-// labels.key where *key* is the name of a label Some examples of using
-// labels as filters: |Filter|Description| |------|-----------|
-// |name:*|The project has a name.| |name:Howl|The project's name is
-// `Howl` or `howl`.| |name:HOWL|Equivalent to above.|
-// |NAME:howl|Equivalent to above.| |labels.color:*|The project has the
-// label `color`.| |labels.color:red|The project's label `color` has the
-// value `red`.| |labels.color:red label.size:big|The project's label
-// `color` has the value `red` and its label `size` has the value `big`.
-func (c *ProjectsListCall) Filter(filter string) *ProjectsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// PageSize sets the optional parameter "pageSize": The maximum number
-// of Projects to return in the response. The server can return fewer
-// projects than requested. If unspecified, server picks an appropriate
-// default. Note: pagination is not yet supported; the server ignores
-// this field.
-func (c *ProjectsListCall) PageSize(pageSize int64) *ProjectsListCall {
- c.opt_["pageSize"] = pageSize
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": A pagination token
-// returned from a previous call to ListProject that indicates from
-// where listing should continue. Note: pagination is not yet supported;
-// the server ignores this field.
-func (c *ProjectsListCall) PageToken(pageToken string) *ProjectsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsListCall) Fields(s ...googleapi.Field) *ProjectsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ProjectsListCall) IfNoneMatch(entityTag string) *ProjectsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsListCall) Context(ctx context.Context) *ProjectsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageSize"]; ok {
- params.Set("pageSize", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/projects")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudresourcemanager.projects.list" call.
-// Exactly one of *ListProjectsResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ListProjectsResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ProjectsListCall) Do() (*ListProjectsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ListProjectsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists projects that are visible to the user and satisfy the specified filter. This method returns projects in an unspecified order. New projects do not necessarily appear at the end of the list.",
- // "httpMethod": "GET",
- // "id": "cloudresourcemanager.projects.list",
- // "parameters": {
- // "filter": {
- // "description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: + `name` + `id` + labels.key where *key* is the name of a label Some examples of using labels as filters: |Filter|Description| |------|-----------| |name:*|The project has a name.| |name:Howl|The project's name is `Howl` or `howl`.| |name:HOWL|Equivalent to above.| |NAME:howl|Equivalent to above.| |labels.color:*|The project has the label `color`.| |labels.color:red|The project's label `color` has the value `red`.| |labels.color:red label.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`. Optional.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageSize": {
- // "description": "The maximum number of Projects to return in the response. The server can return fewer projects than requested. If unspecified, server picks an appropriate default. Note: pagination is not yet supported; the server ignores this field. Optional.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "A pagination token returned from a previous call to ListProject that indicates from where listing should continue. Note: pagination is not yet supported; the server ignores this field. Optional.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "v1beta1/projects",
- // "response": {
- // "$ref": "ListProjectsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "cloudresourcemanager.projects.setIamPolicy":
-
-type ProjectsSetIamPolicyCall struct {
- s *Service
- resource string
- setiampolicyrequest *SetIamPolicyRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetIamPolicy: Sets the IAM access control policy for the specified
-// project. We do not currently support 'domain:' prefixed members in a
-// Binding of a Policy. Calling this method requires enabling the App
-// Engine Admin API.
-func (r *ProjectsService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsSetIamPolicyCall {
- c := &ProjectsSetIamPolicyCall{s: r.s, opt_: make(map[string]interface{})}
- c.resource = resource
- c.setiampolicyrequest = setiampolicyrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsSetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsSetIamPolicyCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsSetIamPolicyCall) Context(ctx context.Context) *ProjectsSetIamPolicyCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsSetIamPolicyCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.setiampolicyrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/projects/{resource}:setIamPolicy")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "resource": c.resource,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudresourcemanager.projects.setIamPolicy" call.
-// Exactly one of *Policy or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Policy.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ProjectsSetIamPolicyCall) Do() (*Policy, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Policy{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sets the IAM access control policy for the specified project. We do not currently support 'domain:' prefixed members in a Binding of a Policy. Calling this method requires enabling the App Engine Admin API.",
- // "httpMethod": "POST",
- // "id": "cloudresourcemanager.projects.setIamPolicy",
- // "parameterOrder": [
- // "resource"
- // ],
- // "parameters": {
- // "resource": {
- // "description": "REQUIRED: The resource for which policy is being specified. `resource` is usually specified as a path, such as, `projects/{project}/zones/{zone}/disks/{disk}`.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1beta1/projects/{resource}:setIamPolicy",
- // "request": {
- // "$ref": "SetIamPolicyRequest"
- // },
- // "response": {
- // "$ref": "Policy"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "cloudresourcemanager.projects.testIamPermissions":
-
-type ProjectsTestIamPermissionsCall struct {
- s *Service
- resource string
- testiampermissionsrequest *TestIamPermissionsRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// TestIamPermissions: Tests the specified permissions against the IAM
-// access control policy for the specified project.
-func (r *ProjectsService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsTestIamPermissionsCall {
- c := &ProjectsTestIamPermissionsCall{s: r.s, opt_: make(map[string]interface{})}
- c.resource = resource
- c.testiampermissionsrequest = testiampermissionsrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsTestIamPermissionsCall) Fields(s ...googleapi.Field) *ProjectsTestIamPermissionsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsTestIamPermissionsCall) Context(ctx context.Context) *ProjectsTestIamPermissionsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsTestIamPermissionsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.testiampermissionsrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/projects/{resource}:testIamPermissions")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "resource": c.resource,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudresourcemanager.projects.testIamPermissions" call.
-// Exactly one of *TestIamPermissionsResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *TestIamPermissionsResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ProjectsTestIamPermissionsCall) Do() (*TestIamPermissionsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TestIamPermissionsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Tests the specified permissions against the IAM access control policy for the specified project.",
- // "httpMethod": "POST",
- // "id": "cloudresourcemanager.projects.testIamPermissions",
- // "parameterOrder": [
- // "resource"
- // ],
- // "parameters": {
- // "resource": {
- // "description": "REQUIRED: The resource for which policy detail is being requested. `resource` is usually specified as a path, such as, `projects/{project}`.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1beta1/projects/{resource}:testIamPermissions",
- // "request": {
- // "$ref": "TestIamPermissionsRequest"
- // },
- // "response": {
- // "$ref": "TestIamPermissionsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "cloudresourcemanager.projects.undelete":
-
-type ProjectsUndeleteCall struct {
- s *Service
- projectId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Undelete: Restores the project identified by the specified
-// `project_id` (for example, `my-project-123`). You can only use this
-// method for a project that has a lifecycle state of [DELETE_REQUESTED]
-// [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_RE
-// QUESTED]. After deletion starts, as indicated by a lifecycle state of
-// [DELETE_IN_PROGRESS]
-// [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_IN
-// _PROGRESS], the project cannot be restored. The caller must have
-// modify permissions for this project.
-func (r *ProjectsService) Undelete(projectId string) *ProjectsUndeleteCall {
- c := &ProjectsUndeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsUndeleteCall) Fields(s ...googleapi.Field) *ProjectsUndeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsUndeleteCall) Context(ctx context.Context) *ProjectsUndeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsUndeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/projects/{projectId}:undelete")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudresourcemanager.projects.undelete" call.
-// Exactly one of *Empty or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Empty.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ProjectsUndeleteCall) Do() (*Empty, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Empty{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Restores the project identified by the specified `project_id` (for example, `my-project-123`). You can only use this method for a project that has a lifecycle state of [DELETE_REQUESTED] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_REQUESTED]. After deletion starts, as indicated by a lifecycle state of [DELETE_IN_PROGRESS] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_IN_PROGRESS], the project cannot be restored. The caller must have modify permissions for this project.",
- // "httpMethod": "POST",
- // "id": "cloudresourcemanager.projects.undelete",
- // "parameterOrder": [
- // "projectId"
- // ],
- // "parameters": {
- // "projectId": {
- // "description": "The project ID (for example, `foo-bar-123`). Required.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1beta1/projects/{projectId}:undelete",
- // "response": {
- // "$ref": "Empty"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "cloudresourcemanager.projects.update":
-
-type ProjectsUpdateCall struct {
- s *Service
- projectId string
- project *Project
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates the attributes of the project identified by the
-// specified `project_id` (for example, `my-project-123`). The caller
-// must have modify permissions for this project.
-func (r *ProjectsService) Update(projectId string, project *Project) *ProjectsUpdateCall {
- c := &ProjectsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.project = project
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsUpdateCall) Fields(s ...googleapi.Field) *ProjectsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsUpdateCall) Context(ctx context.Context) *ProjectsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.project)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/projects/{projectId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudresourcemanager.projects.update" call.
-// Exactly one of *Project or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Project.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ProjectsUpdateCall) Do() (*Project, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Project{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates the attributes of the project identified by the specified `project_id` (for example, `my-project-123`). The caller must have modify permissions for this project.",
- // "httpMethod": "PUT",
- // "id": "cloudresourcemanager.projects.update",
- // "parameterOrder": [
- // "projectId"
- // ],
- // "parameters": {
- // "projectId": {
- // "description": "The project ID (for example, `my-project-123`). Required.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1beta1/projects/{projectId}",
- // "request": {
- // "$ref": "Project"
- // },
- // "response": {
- // "$ref": "Project"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/cloudtrace/v1/cloudtrace-api.json b/vendor/google.golang.org/api/cloudtrace/v1/cloudtrace-api.json
deleted file mode 100644
index a2ad026b..00000000
--- a/vendor/google.golang.org/api/cloudtrace/v1/cloudtrace-api.json
+++ /dev/null
@@ -1,385 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/aRfd7FZnMyWmSYyC0t8ruQh7iCI\"",
- "discoveryVersion": "v1",
- "id": "cloudtrace:v1",
- "name": "cloudtrace",
- "version": "v1",
- "revision": "20150825",
- "title": "Google Cloud Trace API",
- "description": "The Google Cloud Trace API provides services for reading and writing runtime trace data for Cloud applications.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/tools/cloud-trace",
- "protocol": "rest",
- "baseUrl": "https://cloudtrace.googleapis.com/",
- "basePath": "/",
- "rootUrl": "https://cloudtrace.googleapis.com/",
- "servicePath": "",
- "batchPath": "batch",
- "parameters": {
- "access_token": {
- "type": "string",
- "description": "OAuth access token.",
- "location": "query"
- },
- "alt": {
- "type": "string",
- "description": "Data format for response.",
- "default": "json",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "bearer_token": {
- "type": "string",
- "description": "OAuth bearer token.",
- "location": "query"
- },
- "callback": {
- "type": "string",
- "description": "JSONP",
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "pp": {
- "type": "boolean",
- "description": "Pretty-print response.",
- "default": "true",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "location": "query"
- },
- "upload_protocol": {
- "type": "string",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "location": "query"
- },
- "uploadType": {
- "type": "string",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query"
- },
- "$.xgafv": {
- "type": "string",
- "description": "V1 error format.",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "schemas": {
- "ListTracesResponse": {
- "id": "ListTracesResponse",
- "type": "object",
- "description": "The response message for the ListTraces method.",
- "properties": {
- "traces": {
- "type": "array",
- "description": "The list of trace records returned.",
- "items": {
- "$ref": "Trace"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "If defined, indicates that there are more topics that match the request, and this value should be passed to the next ListTopicsRequest to continue."
- }
- }
- },
- "Trace": {
- "id": "Trace",
- "type": "object",
- "description": "A Trace is a collection of spans describing the execution timings of a single operation.",
- "properties": {
- "projectId": {
- "type": "string",
- "description": "The Project ID of the Google Cloud project."
- },
- "traceId": {
- "type": "string",
- "description": "A 128-bit numeric value, formatted as a 32-byte hex string, that represents a trace. Each trace should have an identifier that is globally unique."
- },
- "spans": {
- "type": "array",
- "description": "The collection of span records within this trace. Spans that appear in calls to PatchTraces may be incomplete or partial.",
- "items": {
- "$ref": "TraceSpan"
- }
- }
- }
- },
- "TraceSpan": {
- "id": "TraceSpan",
- "type": "object",
- "description": "A span is the data recorded with a single span.",
- "properties": {
- "spanId": {
- "type": "string",
- "description": "Identifier of the span within the trace. Each span should have an identifier that is unique per trace.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "SpanKind distinguishes spans generated in a particular context. For example, two spans with the same name, one with the kind RPC_CLIENT, and the other with RPC_SERVER can indicate the queueing latency associated with the span.",
- "enum": [
- "SPAN_KIND_UNSPECIFIED",
- "RPC_SERVER",
- "RPC_CLIENT"
- ]
- },
- "name": {
- "type": "string",
- "description": "The name of the trace. This is sanitized and displayed on the UI. This may be a method name or some other per-callsite name. For the same binary and the same call point, it is a good practice to choose a consistent name in order to correlate cross-trace spans."
- },
- "startTime": {
- "type": "string",
- "description": "The start time of the span in nanoseconds from the UNIX epoch."
- },
- "endTime": {
- "type": "string",
- "description": "The end time of the span in nanoseconds from the UNIX epoch."
- },
- "parentSpanId": {
- "type": "string",
- "description": "Identifies the parent of the current span. May be missing. Serialized bytes representation of SpanId.",
- "format": "uint64"
- },
- "labels": {
- "type": "object",
- "description": "Annotations via labels.",
- "additionalProperties": {
- "type": "string"
- }
- }
- }
- },
- "Traces": {
- "id": "Traces",
- "type": "object",
- "description": "A list of traces for the PatchTraces method.",
- "properties": {
- "traces": {
- "type": "array",
- "description": "A list of traces.",
- "items": {
- "$ref": "Trace"
- }
- }
- }
- },
- "Empty": {
- "id": "Empty",
- "type": "object",
- "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`."
- }
- },
- "resources": {
- "projects": {
- "methods": {
- "patchTraces": {
- "id": "cloudtrace.projects.patchTraces",
- "path": "v1/projects/{projectId}/traces",
- "httpMethod": "PATCH",
- "description": "Updates the existing traces specified by PatchTracesRequest and inserts the new traces. Any existing trace or span fields included in an update are overwritten by the update, and any additional fields in an update are merged with the existing trace data.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "The project id of the trace to patch.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId"
- ],
- "request": {
- "$ref": "Traces"
- },
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- },
- "resources": {
- "traces": {
- "methods": {
- "list": {
- "id": "cloudtrace.projects.traces.list",
- "path": "v1/projects/{projectId}/traces",
- "httpMethod": "GET",
- "description": "List traces matching the filter expression.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "The stringified-version of the project id.",
- "required": true,
- "location": "path"
- },
- "view": {
- "type": "string",
- "description": "ViewType specifies the projection of the result.",
- "enum": [
- "VIEW_TYPE_UNSPECIFIED",
- "MINIMAL",
- "ROOTSPAN",
- "COMPLETE"
- ],
- "location": "query"
- },
- "pageSize": {
- "type": "integer",
- "description": "Maximum number of topics to return. If not specified or \u003c= 0, the implementation will select a reasonable value. The implemenation may always return fewer than the requested page_size.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The token identifying the page of results to return from the ListTraces method. If present, this value is should be taken from the next_page_token field of a previous ListTracesResponse.",
- "location": "query"
- },
- "startTime": {
- "type": "string",
- "description": "End of the time interval (inclusive).",
- "location": "query"
- },
- "endTime": {
- "type": "string",
- "description": "Start of the time interval (exclusive).",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "An optional filter for the request.",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "The trace field used to establish the order of traces returned by the ListTraces method. Possible options are: trace_id name (name field of root span) duration (different between end_time and start_time fields of root span) start (start_time field of root span) Descending order can be specified by appending \"desc\" to the sort field: name desc Only one sort field is permitted, though this may change in the future.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "ListTracesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "get": {
- "id": "cloudtrace.projects.traces.get",
- "path": "v1/projects/{projectId}/traces/{traceId}",
- "httpMethod": "GET",
- "description": "Gets one trace by id.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "The project id of the trace to return.",
- "required": true,
- "location": "path"
- },
- "traceId": {
- "type": "string",
- "description": "The trace id of the trace to return.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "traceId"
- ],
- "response": {
- "$ref": "Trace"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- }
- }
- },
- "v1": {
- "methods": {
- "getDiscovery": {
- "id": "cloudtrace.getDiscovery",
- "path": "v1/discovery",
- "httpMethod": "GET",
- "description": "Returns a discovery document in the specified `format`. The typeurl in the returned google.protobuf.Any value depends on the requested format.",
- "parameters": {
- "format": {
- "type": "string",
- "description": "The format requested for discovery.",
- "location": "query"
- },
- "labels": {
- "type": "string",
- "description": "A list of labels (like visibility) influencing the scope of the requested doc.",
- "repeated": true,
- "location": "query"
- },
- "version": {
- "type": "string",
- "description": "The API version of the requested discovery doc.",
- "location": "query"
- },
- "args": {
- "type": "string",
- "description": "Any additional arguments.",
- "repeated": true,
- "location": "query"
- }
- }
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/cloudtrace/v1/cloudtrace-gen.go b/vendor/google.golang.org/api/cloudtrace/v1/cloudtrace-gen.go
deleted file mode 100644
index e79c4d58..00000000
--- a/vendor/google.golang.org/api/cloudtrace/v1/cloudtrace-gen.go
+++ /dev/null
@@ -1,919 +0,0 @@
-// Package cloudtrace provides access to the Google Cloud Trace API.
-//
-// See https://cloud.google.com/tools/cloud-trace
-//
-// Usage example:
-//
-// import "google.golang.org/api/cloudtrace/v1"
-// ...
-// cloudtraceService, err := cloudtrace.New(oauthHttpClient)
-package cloudtrace // import "google.golang.org/api/cloudtrace/v1"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "cloudtrace:v1"
-const apiName = "cloudtrace"
-const apiVersion = "v1"
-const basePath = "https://cloudtrace.googleapis.com/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your data across Google Cloud Platform services
- CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Projects = NewProjectsService(s)
- s.V1 = NewV1Service(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Projects *ProjectsService
-
- V1 *V1Service
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewProjectsService(s *Service) *ProjectsService {
- rs := &ProjectsService{s: s}
- rs.Traces = NewProjectsTracesService(s)
- return rs
-}
-
-type ProjectsService struct {
- s *Service
-
- Traces *ProjectsTracesService
-}
-
-func NewProjectsTracesService(s *Service) *ProjectsTracesService {
- rs := &ProjectsTracesService{s: s}
- return rs
-}
-
-type ProjectsTracesService struct {
- s *Service
-}
-
-func NewV1Service(s *Service) *V1Service {
- rs := &V1Service{s: s}
- return rs
-}
-
-type V1Service struct {
- s *Service
-}
-
-// Empty: A generic empty message that you can re-use to avoid defining
-// duplicated empty messages in your APIs. A typical example is to use
-// it as the request or the response type of an API method. For
-// instance: service Foo { rpc Bar(google.protobuf.Empty) returns
-// (google.protobuf.Empty); } The JSON representation for `Empty` is
-// empty JSON object `{}`.
-type Empty struct {
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-}
-
-// ListTracesResponse: The response message for the ListTraces method.
-type ListTracesResponse struct {
- // NextPageToken: If defined, indicates that there are more topics that
- // match the request, and this value should be passed to the next
- // ListTopicsRequest to continue.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Traces: The list of trace records returned.
- Traces []*Trace `json:"traces,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "NextPageToken") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListTracesResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListTracesResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Trace: A Trace is a collection of spans describing the execution
-// timings of a single operation.
-type Trace struct {
- // ProjectId: The Project ID of the Google Cloud project.
- ProjectId string `json:"projectId,omitempty"`
-
- // Spans: The collection of span records within this trace. Spans that
- // appear in calls to PatchTraces may be incomplete or partial.
- Spans []*TraceSpan `json:"spans,omitempty"`
-
- // TraceId: A 128-bit numeric value, formatted as a 32-byte hex string,
- // that represents a trace. Each trace should have an identifier that is
- // globally unique.
- TraceId string `json:"traceId,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ProjectId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Trace) MarshalJSON() ([]byte, error) {
- type noMethod Trace
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TraceSpan: A span is the data recorded with a single span.
-type TraceSpan struct {
- // EndTime: The end time of the span in nanoseconds from the UNIX epoch.
- EndTime string `json:"endTime,omitempty"`
-
- // Kind: SpanKind distinguishes spans generated in a particular context.
- // For example, two spans with the same name, one with the kind
- // RPC_CLIENT, and the other with RPC_SERVER can indicate the queueing
- // latency associated with the span.
- //
- // Possible values:
- // "SPAN_KIND_UNSPECIFIED"
- // "RPC_SERVER"
- // "RPC_CLIENT"
- Kind string `json:"kind,omitempty"`
-
- // Labels: Annotations via labels.
- Labels map[string]string `json:"labels,omitempty"`
-
- // Name: The name of the trace. This is sanitized and displayed on the
- // UI. This may be a method name or some other per-callsite name. For
- // the same binary and the same call point, it is a good practice to
- // choose a consistent name in order to correlate cross-trace spans.
- Name string `json:"name,omitempty"`
-
- // ParentSpanId: Identifies the parent of the current span. May be
- // missing. Serialized bytes representation of SpanId.
- ParentSpanId uint64 `json:"parentSpanId,omitempty,string"`
-
- // SpanId: Identifier of the span within the trace. Each span should
- // have an identifier that is unique per trace.
- SpanId uint64 `json:"spanId,omitempty,string"`
-
- // StartTime: The start time of the span in nanoseconds from the UNIX
- // epoch.
- StartTime string `json:"startTime,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "EndTime") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TraceSpan) MarshalJSON() ([]byte, error) {
- type noMethod TraceSpan
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Traces: A list of traces for the PatchTraces method.
-type Traces struct {
- // Traces: A list of traces.
- Traces []*Trace `json:"traces,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Traces") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Traces) MarshalJSON() ([]byte, error) {
- type noMethod Traces
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "cloudtrace.projects.patchTraces":
-
-type ProjectsPatchTracesCall struct {
- s *Service
- projectId string
- traces *Traces
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// PatchTraces: Updates the existing traces specified by
-// PatchTracesRequest and inserts the new traces. Any existing trace or
-// span fields included in an update are overwritten by the update, and
-// any additional fields in an update are merged with the existing trace
-// data.
-func (r *ProjectsService) PatchTraces(projectId string, traces *Traces) *ProjectsPatchTracesCall {
- c := &ProjectsPatchTracesCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.traces = traces
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsPatchTracesCall) Fields(s ...googleapi.Field) *ProjectsPatchTracesCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsPatchTracesCall) Context(ctx context.Context) *ProjectsPatchTracesCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsPatchTracesCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.traces)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/projects/{projectId}/traces")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudtrace.projects.patchTraces" call.
-// Exactly one of *Empty or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Empty.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ProjectsPatchTracesCall) Do() (*Empty, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Empty{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates the existing traces specified by PatchTracesRequest and inserts the new traces. Any existing trace or span fields included in an update are overwritten by the update, and any additional fields in an update are merged with the existing trace data.",
- // "httpMethod": "PATCH",
- // "id": "cloudtrace.projects.patchTraces",
- // "parameterOrder": [
- // "projectId"
- // ],
- // "parameters": {
- // "projectId": {
- // "description": "The project id of the trace to patch.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1/projects/{projectId}/traces",
- // "request": {
- // "$ref": "Traces"
- // },
- // "response": {
- // "$ref": "Empty"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "cloudtrace.projects.traces.get":
-
-type ProjectsTracesGetCall struct {
- s *Service
- projectId string
- traceId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one trace by id.
-func (r *ProjectsTracesService) Get(projectId string, traceId string) *ProjectsTracesGetCall {
- c := &ProjectsTracesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.traceId = traceId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsTracesGetCall) Fields(s ...googleapi.Field) *ProjectsTracesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ProjectsTracesGetCall) IfNoneMatch(entityTag string) *ProjectsTracesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsTracesGetCall) Context(ctx context.Context) *ProjectsTracesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsTracesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/projects/{projectId}/traces/{traceId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "traceId": c.traceId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudtrace.projects.traces.get" call.
-// Exactly one of *Trace or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Trace.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ProjectsTracesGetCall) Do() (*Trace, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Trace{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one trace by id.",
- // "httpMethod": "GET",
- // "id": "cloudtrace.projects.traces.get",
- // "parameterOrder": [
- // "projectId",
- // "traceId"
- // ],
- // "parameters": {
- // "projectId": {
- // "description": "The project id of the trace to return.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "traceId": {
- // "description": "The trace id of the trace to return.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1/projects/{projectId}/traces/{traceId}",
- // "response": {
- // "$ref": "Trace"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "cloudtrace.projects.traces.list":
-
-type ProjectsTracesListCall struct {
- s *Service
- projectId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List traces matching the filter expression.
-func (r *ProjectsTracesService) List(projectId string) *ProjectsTracesListCall {
- c := &ProjectsTracesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- return c
-}
-
-// EndTime sets the optional parameter "endTime": Start of the time
-// interval (exclusive).
-func (c *ProjectsTracesListCall) EndTime(endTime string) *ProjectsTracesListCall {
- c.opt_["endTime"] = endTime
- return c
-}
-
-// Filter sets the optional parameter "filter": An optional filter for
-// the request.
-func (c *ProjectsTracesListCall) Filter(filter string) *ProjectsTracesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": The trace field used
-// to establish the order of traces returned by the ListTraces method.
-// Possible options are: trace_id name (name field of root span)
-// duration (different between end_time and start_time fields of root
-// span) start (start_time field of root span) Descending order can be
-// specified by appending "desc" to the sort field: name desc Only one
-// sort field is permitted, though this may change in the future.
-func (c *ProjectsTracesListCall) OrderBy(orderBy string) *ProjectsTracesListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageSize sets the optional parameter "pageSize": Maximum number of
-// topics to return. If not specified or <= 0, the implementation will
-// select a reasonable value. The implemenation may always return fewer
-// than the requested page_size.
-func (c *ProjectsTracesListCall) PageSize(pageSize int64) *ProjectsTracesListCall {
- c.opt_["pageSize"] = pageSize
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The token
-// identifying the page of results to return from the ListTraces method.
-// If present, this value is should be taken from the next_page_token
-// field of a previous ListTracesResponse.
-func (c *ProjectsTracesListCall) PageToken(pageToken string) *ProjectsTracesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// StartTime sets the optional parameter "startTime": End of the time
-// interval (inclusive).
-func (c *ProjectsTracesListCall) StartTime(startTime string) *ProjectsTracesListCall {
- c.opt_["startTime"] = startTime
- return c
-}
-
-// View sets the optional parameter "view": ViewType specifies the
-// projection of the result.
-//
-// Possible values:
-// "VIEW_TYPE_UNSPECIFIED"
-// "MINIMAL"
-// "ROOTSPAN"
-// "COMPLETE"
-func (c *ProjectsTracesListCall) View(view string) *ProjectsTracesListCall {
- c.opt_["view"] = view
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsTracesListCall) Fields(s ...googleapi.Field) *ProjectsTracesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ProjectsTracesListCall) IfNoneMatch(entityTag string) *ProjectsTracesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsTracesListCall) Context(ctx context.Context) *ProjectsTracesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsTracesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["endTime"]; ok {
- params.Set("endTime", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageSize"]; ok {
- params.Set("pageSize", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startTime"]; ok {
- params.Set("startTime", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["view"]; ok {
- params.Set("view", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/projects/{projectId}/traces")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudtrace.projects.traces.list" call.
-// Exactly one of *ListTracesResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ListTracesResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ProjectsTracesListCall) Do() (*ListTracesResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ListTracesResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List traces matching the filter expression.",
- // "httpMethod": "GET",
- // "id": "cloudtrace.projects.traces.list",
- // "parameterOrder": [
- // "projectId"
- // ],
- // "parameters": {
- // "endTime": {
- // "description": "Start of the time interval (exclusive).",
- // "location": "query",
- // "type": "string"
- // },
- // "filter": {
- // "description": "An optional filter for the request.",
- // "location": "query",
- // "type": "string"
- // },
- // "orderBy": {
- // "description": "The trace field used to establish the order of traces returned by the ListTraces method. Possible options are: trace_id name (name field of root span) duration (different between end_time and start_time fields of root span) start (start_time field of root span) Descending order can be specified by appending \"desc\" to the sort field: name desc Only one sort field is permitted, though this may change in the future.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageSize": {
- // "description": "Maximum number of topics to return. If not specified or \u003c= 0, the implementation will select a reasonable value. The implemenation may always return fewer than the requested page_size.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The token identifying the page of results to return from the ListTraces method. If present, this value is should be taken from the next_page_token field of a previous ListTracesResponse.",
- // "location": "query",
- // "type": "string"
- // },
- // "projectId": {
- // "description": "The stringified-version of the project id.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "startTime": {
- // "description": "End of the time interval (inclusive).",
- // "location": "query",
- // "type": "string"
- // },
- // "view": {
- // "description": "ViewType specifies the projection of the result.",
- // "enum": [
- // "VIEW_TYPE_UNSPECIFIED",
- // "MINIMAL",
- // "ROOTSPAN",
- // "COMPLETE"
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "v1/projects/{projectId}/traces",
- // "response": {
- // "$ref": "ListTracesResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "cloudtrace.getDiscovery":
-
-type V1GetDiscoveryCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetDiscovery: Returns a discovery document in the specified `format`.
-// The typeurl in the returned google.protobuf.Any value depends on the
-// requested format.
-func (r *V1Service) GetDiscovery() *V1GetDiscoveryCall {
- c := &V1GetDiscoveryCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Args sets the optional parameter "args": Any additional arguments.
-func (c *V1GetDiscoveryCall) Args(args string) *V1GetDiscoveryCall {
- c.opt_["args"] = args
- return c
-}
-
-// Format sets the optional parameter "format": The format requested for
-// discovery.
-func (c *V1GetDiscoveryCall) Format(format string) *V1GetDiscoveryCall {
- c.opt_["format"] = format
- return c
-}
-
-// Labels sets the optional parameter "labels": A list of labels (like
-// visibility) influencing the scope of the requested doc.
-func (c *V1GetDiscoveryCall) Labels(labels string) *V1GetDiscoveryCall {
- c.opt_["labels"] = labels
- return c
-}
-
-// Version sets the optional parameter "version": The API version of the
-// requested discovery doc.
-func (c *V1GetDiscoveryCall) Version(version string) *V1GetDiscoveryCall {
- c.opt_["version"] = version
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *V1GetDiscoveryCall) Fields(s ...googleapi.Field) *V1GetDiscoveryCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *V1GetDiscoveryCall) IfNoneMatch(entityTag string) *V1GetDiscoveryCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *V1GetDiscoveryCall) Context(ctx context.Context) *V1GetDiscoveryCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *V1GetDiscoveryCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["args"]; ok {
- params.Set("args", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["format"]; ok {
- params.Set("format", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["labels"]; ok {
- params.Set("labels", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["version"]; ok {
- params.Set("version", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/discovery")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "cloudtrace.getDiscovery" call.
-func (c *V1GetDiscoveryCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Returns a discovery document in the specified `format`. The typeurl in the returned google.protobuf.Any value depends on the requested format.",
- // "httpMethod": "GET",
- // "id": "cloudtrace.getDiscovery",
- // "parameters": {
- // "args": {
- // "description": "Any additional arguments.",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "format": {
- // "description": "The format requested for discovery.",
- // "location": "query",
- // "type": "string"
- // },
- // "labels": {
- // "description": "A list of labels (like visibility) influencing the scope of the requested doc.",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "version": {
- // "description": "The API version of the requested discovery doc.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "v1/discovery"
- // }
-
-}
diff --git a/vendor/google.golang.org/api/clouduseraccounts/v0.alpha/clouduseraccounts-api.json b/vendor/google.golang.org/api/clouduseraccounts/v0.alpha/clouduseraccounts-api.json
deleted file mode 100644
index 7d148dc3..00000000
--- a/vendor/google.golang.org/api/clouduseraccounts/v0.alpha/clouduseraccounts-api.json
+++ /dev/null
@@ -1,1818 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/D_beAFQQyveoQCMpniTgyTLEBjs\"",
- "discoveryVersion": "v1",
- "id": "clouduseraccounts:alpha",
- "name": "clouduseraccounts",
- "canonicalName": "Cloud User Accounts",
- "version": "alpha",
- "revision": "20150917",
- "title": "Cloud User Accounts API",
- "description": "API for the Google Cloud User Accounts service.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/compute_engine-16.png",
- "x32": "https://www.google.com/images/icons/product/compute_engine-32.png"
- },
- "documentationLink": "https://cloud.google.com/compute/docs/access/user-accounts/api/latest/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/clouduseraccounts/alpha/projects/",
- "basePath": "/clouduseraccounts/alpha/projects/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "clouduseraccounts/alpha/projects/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud.useraccounts": {
- "description": "Manage your Google Cloud User Accounts"
- },
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly": {
- "description": "View your Google Cloud User Accounts"
- }
- }
- }
- },
- "schemas": {
- "AuthorizedKeysView": {
- "id": "AuthorizedKeysView",
- "type": "object",
- "description": "A list of authorized public keys for a user account.",
- "properties": {
- "keys": {
- "type": "array",
- "description": "[Output Only] The list of authorized public keys in SSH format.",
- "items": {
- "type": "string"
- }
- },
- "sudoer": {
- "type": "boolean",
- "description": "[Output Only] Whether the user has the ability to elevate on the instance that requested the authorized keys."
- }
- }
- },
- "Binding": {
- "id": "Binding",
- "type": "object",
- "description": "Associates `members` with a `role`.",
- "properties": {
- "members": {
- "type": "array",
- "description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following formats:\n\n* `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.\n\n* `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.\n\n* `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.",
- "items": {
- "type": "string"
- }
- },
- "role": {
- "type": "string",
- "description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`."
- }
- }
- },
- "Condition": {
- "id": "Condition",
- "type": "object",
- "description": "A condition to be met.",
- "properties": {
- "iam": {
- "type": "string",
- "description": "Trusted attributes supplied by the IAM system.",
- "enum": [
- "ATTRIBUTION",
- "AUTHORITY",
- "NO_ATTR"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "op": {
- "type": "string",
- "description": "An operator to apply the subject with.",
- "enum": [
- "DISCHARGED",
- "EQUALS",
- "IN",
- "NOT_EQUALS",
- "NOT_IN",
- "NO_OP"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "svc": {
- "type": "string",
- "description": "Trusted attributes discharged by the service."
- },
- "sys": {
- "type": "string",
- "description": "Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.",
- "enum": [
- "IP",
- "NAME",
- "NO_ATTR",
- "REGION",
- "SERVICE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "value": {
- "type": "string",
- "description": "The object of the condition. Exactly one of these must be set."
- },
- "values": {
- "type": "array",
- "description": "The objects of the condition. This is mutually exclusive with 'value'.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "Group": {
- "id": "Group",
- "type": "object",
- "description": "A Group resource.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always clouduseraccounts#group for groups.",
- "default": "clouduseraccounts#group"
- },
- "members": {
- "type": "array",
- "description": "[Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.",
- "items": {
- "type": "string"
- }
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created.",
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "annotations": {
- "required": [
- "clouduseraccounts.groups.insert"
- ]
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server defined URL for the resource."
- }
- }
- },
- "GroupList": {
- "id": "GroupList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of Group resources.",
- "items": {
- "$ref": "Group"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always clouduseraccounts#groupList for lists of groups.",
- "default": "clouduseraccounts#groupList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server defined URL for this resource."
- }
- }
- },
- "GroupsAddMemberRequest": {
- "id": "GroupsAddMemberRequest",
- "type": "object",
- "properties": {
- "users": {
- "type": "array",
- "description": "Fully-qualified URLs of the User resources to add.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "GroupsRemoveMemberRequest": {
- "id": "GroupsRemoveMemberRequest",
- "type": "object",
- "properties": {
- "users": {
- "type": "array",
- "description": "Fully-qualified URLs of the User resources to remove.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "LinuxAccountViews": {
- "id": "LinuxAccountViews",
- "type": "object",
- "description": "A list of all Linux accounts for this project. This API is only used by Compute Engine virtual machines to get information about user accounts for a project or instance. Linux resources are read-only views into users and groups managed by the Compute Engine Accounts API.",
- "properties": {
- "groupViews": {
- "type": "array",
- "description": "[Output Only] A list of all groups within a project.",
- "items": {
- "$ref": "LinuxGroupView"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always clouduseraccounts#linuxAccountViews for Linux resources.",
- "default": "clouduseraccounts#linuxAccountViews"
- },
- "userViews": {
- "type": "array",
- "description": "[Output Only] A list of all users within a project.",
- "items": {
- "$ref": "LinuxUserView"
- }
- }
- }
- },
- "LinuxGetAuthorizedKeysViewResponse": {
- "id": "LinuxGetAuthorizedKeysViewResponse",
- "type": "object",
- "properties": {
- "resource": {
- "$ref": "AuthorizedKeysView",
- "description": "[Output Only] A list of authorized public keys for a user."
- }
- }
- },
- "LinuxGetLinuxAccountViewsResponse": {
- "id": "LinuxGetLinuxAccountViewsResponse",
- "type": "object",
- "properties": {
- "resource": {
- "$ref": "LinuxAccountViews",
- "description": "[Output Only] A list of authorized user accounts and groups."
- }
- }
- },
- "LinuxGroupView": {
- "id": "LinuxGroupView",
- "type": "object",
- "description": "A detailed view of a Linux group.",
- "properties": {
- "gid": {
- "type": "integer",
- "description": "[Output Only] The Group ID.",
- "format": "uint32"
- },
- "groupName": {
- "type": "string",
- "description": "[Output Only] Group name."
- },
- "members": {
- "type": "array",
- "description": "[Output Only] List of user accounts that belong to the group.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "LinuxUserView": {
- "id": "LinuxUserView",
- "type": "object",
- "description": "A detailed view of a Linux user account.",
- "properties": {
- "gecos": {
- "type": "string",
- "description": "[Output Only] The GECOS (user information) entry for this account."
- },
- "gid": {
- "type": "integer",
- "description": "[Output Only] User's default group ID.",
- "format": "uint32"
- },
- "homeDirectory": {
- "type": "string",
- "description": "[Output Only] The path to the home directory for this account."
- },
- "shell": {
- "type": "string",
- "description": "[Output Only] The path to the login shell for this account."
- },
- "uid": {
- "type": "integer",
- "description": "[Output Only] User ID.",
- "format": "uint32"
- },
- "username": {
- "type": "string",
- "description": "[Output Only] The username of the account."
- }
- }
- },
- "LogConfig": {
- "id": "LogConfig",
- "type": "object",
- "description": "Specifies what kind of log the caller must write",
- "properties": {
- "counter": {
- "$ref": "LogConfigCounterOptions",
- "description": "Counter options."
- }
- }
- },
- "LogConfigCounterOptions": {
- "id": "LogConfigCounterOptions",
- "type": "object",
- "description": "Options for counters",
- "properties": {
- "field": {
- "type": "string",
- "description": "The field value to attribute."
- },
- "metric": {
- "type": "string",
- "description": "The metric to update."
- }
- }
- },
- "Operation": {
- "id": "Operation",
- "type": "object",
- "description": "An Operation resource, used to manage asynchronous API requests.",
- "properties": {
- "clientOperationId": {
- "type": "string",
- "description": "[Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "endTime": {
- "type": "string",
- "description": "[Output Only] The time that this operation was completed. This is in RFC3339 text format."
- },
- "error": {
- "type": "object",
- "description": "[Output Only] If errors are generated during processing of the operation, this field will be populated.",
- "properties": {
- "errors": {
- "type": "array",
- "description": "[Output Only] The array of errors encountered while processing this operation.",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The error type identifier for this error."
- },
- "location": {
- "type": "string",
- "description": "[Output Only] Indicates the field in the request which caused the error. This property is optional."
- },
- "message": {
- "type": "string",
- "description": "[Output Only] An optional, human-readable error message."
- }
- }
- }
- }
- }
- },
- "httpErrorMessage": {
- "type": "string",
- "description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND."
- },
- "httpErrorStatusCode": {
- "type": "integer",
- "description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.",
- "format": "int32"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "insertTime": {
- "type": "string",
- "description": "[Output Only] The time that this operation was requested. This is in RFC3339 text format."
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#operation for Operation resources.",
- "default": "clouduseraccounts#operation"
- },
- "name": {
- "type": "string",
- "description": "[Output Only] Name of the resource."
- },
- "operationType": {
- "type": "string",
- "description": "[Output Only] Type of the operation, such as insert, compute.instanceGroups.update, or compute.instanceGroups.delete."
- },
- "progress": {
- "type": "integer",
- "description": "[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.",
- "format": "int32"
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the operation resides. Only applicable for regional resources."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "startTime": {
- "type": "string",
- "description": "[Output Only] The time that this operation was started by the server. This is in RFC3339 text format."
- },
- "status": {
- "type": "string",
- "description": "[Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.",
- "enum": [
- "DONE",
- "PENDING",
- "RUNNING"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "statusMessage": {
- "type": "string",
- "description": "[Output Only] An optional textual description of the current status of the operation."
- },
- "targetId": {
- "type": "string",
- "description": "[Output Only] Unique target ID which identifies a particular incarnation of the target.",
- "format": "uint64"
- },
- "targetLink": {
- "type": "string",
- "description": "[Output Only] URL of the resource the operation is mutating."
- },
- "user": {
- "type": "string",
- "description": "[Output Only] User who requested the operation, for example: user@example.com."
- },
- "warnings": {
- "type": "array",
- "description": "[Output Only] If warning messages are generated during processing of the operation, this field will be populated.",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- },
- "zone": {
- "type": "string",
- "description": "[Output Only] URL of the zone where the operation resides."
- }
- }
- },
- "OperationList": {
- "id": "OperationList",
- "type": "object",
- "description": "Contains a list of Operation resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] The Operation resources.",
- "items": {
- "$ref": "Operation"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#operations for Operations resource.",
- "default": "clouduseraccounts#operationList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncate."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "Policy": {
- "id": "Policy",
- "type": "object",
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.\n\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.\n\n**Example**\n\n{ \"bindings\": [ { \"role\": \"roles/owner\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"] }, { \"role\": \"roles/viewer\", \"members\": [\"user:sean@example.com\"] } ] }\n\nFor a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).",
- "properties": {
- "bindings": {
- "type": "array",
- "description": "Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.",
- "items": {
- "$ref": "Binding"
- }
- },
- "etag": {
- "type": "string",
- "description": "Can be used to perform a read-modify-write.",
- "format": "byte"
- },
- "rules": {
- "type": "array",
- "description": "",
- "items": {
- "$ref": "Rule"
- }
- },
- "version": {
- "type": "integer",
- "description": "Version of the `Policy`. The default version is 0.",
- "format": "int32"
- }
- }
- },
- "PublicKey": {
- "id": "PublicKey",
- "type": "object",
- "description": "A public key for authenticating to guests.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "expirationTimestamp": {
- "type": "string",
- "description": "Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires."
- },
- "fingerprint": {
- "type": "string",
- "description": "[Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key."
- },
- "key": {
- "type": "string",
- "description": "Public key text in SSH format, defined by RFC4253 section 6.6."
- }
- }
- },
- "Rule": {
- "id": "Rule",
- "type": "object",
- "description": "A rule to be applied in a Policy.",
- "properties": {
- "action": {
- "type": "string",
- "description": "Required",
- "enum": [
- "ALLOW",
- "ALLOW_WITH_LOG",
- "DENY",
- "DENY_WITH_LOG",
- "LOG",
- "NO_ACTION"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "conditions": {
- "type": "array",
- "description": "Additional restrictions that must be met",
- "items": {
- "$ref": "Condition"
- }
- },
- "description": {
- "type": "string",
- "description": "Human-readable description of the rule."
- },
- "ins": {
- "type": "array",
- "description": "The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.",
- "items": {
- "type": "string"
- }
- },
- "logConfigs": {
- "type": "array",
- "description": "The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.",
- "items": {
- "$ref": "LogConfig"
- }
- },
- "notIns": {
- "type": "array",
- "description": "The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries.",
- "items": {
- "type": "string"
- }
- },
- "permissions": {
- "type": "array",
- "description": "A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "TestPermissionsRequest": {
- "id": "TestPermissionsRequest",
- "type": "object",
- "properties": {
- "permissions": {
- "type": "array",
- "description": "The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "TestPermissionsResponse": {
- "id": "TestPermissionsResponse",
- "type": "object",
- "properties": {
- "permissions": {
- "type": "array",
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "User": {
- "id": "User",
- "type": "object",
- "description": "A User resource.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "groups": {
- "type": "array",
- "description": "[Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always clouduseraccounts#user for users.",
- "default": "clouduseraccounts#user"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created.",
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "annotations": {
- "required": [
- "clouduseraccounts.users.insert"
- ]
- }
- },
- "owner": {
- "type": "string",
- "description": "Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.",
- "annotations": {
- "required": [
- "clouduseraccounts.users.insert"
- ]
- }
- },
- "publicKeys": {
- "type": "array",
- "description": "[Output Only] Public keys that this user may use to login.",
- "items": {
- "$ref": "PublicKey"
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server defined URL for the resource."
- }
- }
- },
- "UserList": {
- "id": "UserList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of User resources.",
- "items": {
- "$ref": "User"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always clouduseraccounts#userList for lists of users.",
- "default": "clouduseraccounts#userList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server defined URL for this resource."
- }
- }
- }
- },
- "resources": {
- "globalAccountsOperations": {
- "methods": {
- "delete": {
- "id": "clouduseraccounts.globalAccountsOperations.delete",
- "path": "{project}/global/operations/{operation}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified operation resource.",
- "parameters": {
- "operation": {
- "type": "string",
- "description": "Name of the Operations resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "operation"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "get": {
- "id": "clouduseraccounts.globalAccountsOperations.get",
- "path": "{project}/global/operations/{operation}",
- "httpMethod": "GET",
- "description": "Retrieves the specified operation resource.",
- "parameters": {
- "operation": {
- "type": "string",
- "description": "Name of the Operations resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "operation"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "list": {
- "id": "clouduseraccounts.globalAccountsOperations.list",
- "path": "{project}/global/operations",
- "httpMethod": "GET",
- "description": "Retrieves the list of operation resources contained within the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "OperationList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- }
- }
- },
- "groups": {
- "methods": {
- "addMember": {
- "id": "clouduseraccounts.groups.addMember",
- "path": "{project}/global/groups/{groupName}/addMember",
- "httpMethod": "POST",
- "description": "Adds users to the specified group.",
- "parameters": {
- "groupName": {
- "type": "string",
- "description": "Name of the group for this request.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "groupName"
- ],
- "request": {
- "$ref": "GroupsAddMemberRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "delete": {
- "id": "clouduseraccounts.groups.delete",
- "path": "{project}/global/groups/{groupName}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified Group resource.",
- "parameters": {
- "groupName": {
- "type": "string",
- "description": "Name of the Group resource to delete.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "groupName"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "get": {
- "id": "clouduseraccounts.groups.get",
- "path": "{project}/global/groups/{groupName}",
- "httpMethod": "GET",
- "description": "Returns the specified Group resource.",
- "parameters": {
- "groupName": {
- "type": "string",
- "description": "Name of the Group resource to return.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "groupName"
- ],
- "response": {
- "$ref": "Group"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "getIamPolicy": {
- "id": "clouduseraccounts.groups.getIamPolicy",
- "path": "{project}/global/groups/{resource}/getIamPolicy",
- "httpMethod": "GET",
- "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "resource": {
- "type": "string",
- "description": "Name of the resource for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "insert": {
- "id": "clouduseraccounts.groups.insert",
- "path": "{project}/global/groups",
- "httpMethod": "POST",
- "description": "Creates a Group resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "Group"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "list": {
- "id": "clouduseraccounts.groups.list",
- "path": "{project}/global/groups",
- "httpMethod": "GET",
- "description": "Retrieves the list of groups contained within the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "GroupList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "removeMember": {
- "id": "clouduseraccounts.groups.removeMember",
- "path": "{project}/global/groups/{groupName}/removeMember",
- "httpMethod": "POST",
- "description": "Removes users from the specified group.",
- "parameters": {
- "groupName": {
- "type": "string",
- "description": "Name of the group for this request.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "groupName"
- ],
- "request": {
- "$ref": "GroupsRemoveMemberRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "setIamPolicy": {
- "id": "clouduseraccounts.groups.setIamPolicy",
- "path": "{project}/global/groups/{resource}/setIamPolicy",
- "httpMethod": "POST",
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "resource": {
- "type": "string",
- "description": "Name of the resource for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "resource"
- ],
- "request": {
- "$ref": "Policy"
- },
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "testIamPermissions": {
- "id": "clouduseraccounts.groups.testIamPermissions",
- "path": "{project}/global/groups/{resource}/testIamPermissions",
- "httpMethod": "POST",
- "description": "Returns permissions that a caller has on the specified resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "resource": {
- "type": "string",
- "description": "Name of the resource for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "resource"
- ],
- "request": {
- "$ref": "TestPermissionsRequest"
- },
- "response": {
- "$ref": "TestPermissionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- }
- }
- },
- "linux": {
- "methods": {
- "getAuthorizedKeysView": {
- "id": "clouduseraccounts.linux.getAuthorizedKeysView",
- "path": "{project}/zones/{zone}/authorizedKeysView/{user}",
- "httpMethod": "POST",
- "description": "Returns a list of authorized public keys for a specific user account.",
- "parameters": {
- "instance": {
- "type": "string",
- "description": "The fully-qualified URL of the virtual machine requesting the view.",
- "required": true,
- "location": "query"
- },
- "login": {
- "type": "boolean",
- "description": "Whether the view was requested as part of a user-initiated login.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "user": {
- "type": "string",
- "description": "The user account for which you want to get a list of authorized public keys.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "user",
- "instance"
- ],
- "response": {
- "$ref": "LinuxGetAuthorizedKeysViewResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "getLinuxAccountViews": {
- "id": "clouduseraccounts.linux.getLinuxAccountViews",
- "path": "{project}/zones/{zone}/linuxAccountViews",
- "httpMethod": "POST",
- "description": "Retrieves a list of user accounts for an instance within a specific project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "instance": {
- "type": "string",
- "description": "The fully-qualified URL of the virtual machine requesting the views.",
- "required": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "response": {
- "$ref": "LinuxGetLinuxAccountViewsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- }
- }
- },
- "users": {
- "methods": {
- "addPublicKey": {
- "id": "clouduseraccounts.users.addPublicKey",
- "path": "{project}/global/users/{user}/addPublicKey",
- "httpMethod": "POST",
- "description": "Adds a public key to the specified User resource with the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "user": {
- "type": "string",
- "description": "Name of the user for this request.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "user"
- ],
- "request": {
- "$ref": "PublicKey"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "delete": {
- "id": "clouduseraccounts.users.delete",
- "path": "{project}/global/users/{user}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified User resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "user": {
- "type": "string",
- "description": "Name of the user resource to delete.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "user"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "get": {
- "id": "clouduseraccounts.users.get",
- "path": "{project}/global/users/{user}",
- "httpMethod": "GET",
- "description": "Returns the specified User resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "user": {
- "type": "string",
- "description": "Name of the user resource to return.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "user"
- ],
- "response": {
- "$ref": "User"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "getIamPolicy": {
- "id": "clouduseraccounts.users.getIamPolicy",
- "path": "{project}/global/users/{resource}/getIamPolicy",
- "httpMethod": "GET",
- "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "resource": {
- "type": "string",
- "description": "Name of the resource for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "insert": {
- "id": "clouduseraccounts.users.insert",
- "path": "{project}/global/users",
- "httpMethod": "POST",
- "description": "Creates a User resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "User"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "list": {
- "id": "clouduseraccounts.users.list",
- "path": "{project}/global/users",
- "httpMethod": "GET",
- "description": "Retrieves a list of users contained within the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "UserList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "removePublicKey": {
- "id": "clouduseraccounts.users.removePublicKey",
- "path": "{project}/global/users/{user}/removePublicKey",
- "httpMethod": "POST",
- "description": "Removes the specified public key from the user.",
- "parameters": {
- "fingerprint": {
- "type": "string",
- "description": "The fingerprint of the public key to delete. Public keys are identified by their fingerprint, which is defined by RFC4716 to be the MD5 digest of the public key.",
- "required": true,
- "pattern": "[a-f0-9]{32}",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "user": {
- "type": "string",
- "description": "Name of the user for this request.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "user",
- "fingerprint"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "setIamPolicy": {
- "id": "clouduseraccounts.users.setIamPolicy",
- "path": "{project}/global/users/{resource}/setIamPolicy",
- "httpMethod": "POST",
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "resource": {
- "type": "string",
- "description": "Name of the resource for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "resource"
- ],
- "request": {
- "$ref": "Policy"
- },
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "testIamPermissions": {
- "id": "clouduseraccounts.users.testIamPermissions",
- "path": "{project}/global/users/{resource}/testIamPermissions",
- "httpMethod": "POST",
- "description": "Returns permissions that a caller has on the specified resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "resource": {
- "type": "string",
- "description": "Name of the resource for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "resource"
- ],
- "request": {
- "$ref": "TestPermissionsRequest"
- },
- "response": {
- "$ref": "TestPermissionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/clouduseraccounts/v0.alpha/clouduseraccounts-gen.go b/vendor/google.golang.org/api/clouduseraccounts/v0.alpha/clouduseraccounts-gen.go
deleted file mode 100644
index d49b7089..00000000
--- a/vendor/google.golang.org/api/clouduseraccounts/v0.alpha/clouduseraccounts-gen.go
+++ /dev/null
@@ -1,4592 +0,0 @@
-// Package clouduseraccounts provides access to the Cloud User Accounts API.
-//
-// See https://cloud.google.com/compute/docs/access/user-accounts/api/latest/
-//
-// Usage example:
-//
-// import "google.golang.org/api/clouduseraccounts/v0.alpha"
-// ...
-// clouduseraccountsService, err := clouduseraccounts.New(oauthHttpClient)
-package clouduseraccounts // import "google.golang.org/api/clouduseraccounts/v0.alpha"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "clouduseraccounts:alpha"
-const apiName = "clouduseraccounts"
-const apiVersion = "alpha"
-const basePath = "https://www.googleapis.com/clouduseraccounts/alpha/projects/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your data across Google Cloud Platform services
- CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
-
- // View your data across Google Cloud Platform services
- CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"
-
- // Manage your Google Cloud User Accounts
- CloudUseraccountsScope = "https://www.googleapis.com/auth/cloud.useraccounts"
-
- // View your Google Cloud User Accounts
- CloudUseraccountsReadonlyScope = "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.GlobalAccountsOperations = NewGlobalAccountsOperationsService(s)
- s.Groups = NewGroupsService(s)
- s.Linux = NewLinuxService(s)
- s.Users = NewUsersService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- GlobalAccountsOperations *GlobalAccountsOperationsService
-
- Groups *GroupsService
-
- Linux *LinuxService
-
- Users *UsersService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewGlobalAccountsOperationsService(s *Service) *GlobalAccountsOperationsService {
- rs := &GlobalAccountsOperationsService{s: s}
- return rs
-}
-
-type GlobalAccountsOperationsService struct {
- s *Service
-}
-
-func NewGroupsService(s *Service) *GroupsService {
- rs := &GroupsService{s: s}
- return rs
-}
-
-type GroupsService struct {
- s *Service
-}
-
-func NewLinuxService(s *Service) *LinuxService {
- rs := &LinuxService{s: s}
- return rs
-}
-
-type LinuxService struct {
- s *Service
-}
-
-func NewUsersService(s *Service) *UsersService {
- rs := &UsersService{s: s}
- return rs
-}
-
-type UsersService struct {
- s *Service
-}
-
-// AuthorizedKeysView: A list of authorized public keys for a user
-// account.
-type AuthorizedKeysView struct {
- // Keys: [Output Only] The list of authorized public keys in SSH format.
- Keys []string `json:"keys,omitempty"`
-
- // Sudoer: [Output Only] Whether the user has the ability to elevate on
- // the instance that requested the authorized keys.
- Sudoer bool `json:"sudoer,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Keys") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AuthorizedKeysView) MarshalJSON() ([]byte, error) {
- type noMethod AuthorizedKeysView
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Binding: Associates `members` with a `role`.
-type Binding struct {
- // Members: Specifies the identities requesting access for a Cloud
- // Platform resource. `members` can have the following formats:
- //
- // * `allUsers`: A special identifier that represents anyone who is on
- // the internet; with or without a Google account.
- //
- // * `allAuthenticatedUsers`: A special identifier that represents
- // anyone who is authenticated with a Google account or a service
- // account.
- //
- // * `user:{emailid}`: An email address that represents a specific
- // Google account. For example, `alice@gmail.com` or
- // `joe@example.com`.
- //
- // * `serviceAccount:{emailid}`: An email address that represents a
- // service account. For example,
- // `my-other-app@appspot.gserviceaccount.com`.
- //
- // * `group:{emailid}`: An email address that represents a Google group.
- // For example, `admins@example.com`.
- //
- // * `domain:{domain}`: A Google Apps domain name that represents all
- // the users of that domain. For example, `google.com` or `example.com`.
- Members []string `json:"members,omitempty"`
-
- // Role: Role that is assigned to `members`. For example,
- // `roles/viewer`, `roles/editor`, or `roles/owner`.
- Role string `json:"role,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Members") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Binding) MarshalJSON() ([]byte, error) {
- type noMethod Binding
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Condition: A condition to be met.
-type Condition struct {
- // Iam: Trusted attributes supplied by the IAM system.
- //
- // Possible values:
- // "ATTRIBUTION"
- // "AUTHORITY"
- // "NO_ATTR"
- Iam string `json:"iam,omitempty"`
-
- // Op: An operator to apply the subject with.
- //
- // Possible values:
- // "DISCHARGED"
- // "EQUALS"
- // "IN"
- // "NOT_EQUALS"
- // "NOT_IN"
- // "NO_OP"
- Op string `json:"op,omitempty"`
-
- // Svc: Trusted attributes discharged by the service.
- Svc string `json:"svc,omitempty"`
-
- // Sys: Trusted attributes supplied by any service that owns resources
- // and uses the IAM system for access control.
- //
- // Possible values:
- // "IP"
- // "NAME"
- // "NO_ATTR"
- // "REGION"
- // "SERVICE"
- Sys string `json:"sys,omitempty"`
-
- // Value: The object of the condition. Exactly one of these must be set.
- Value string `json:"value,omitempty"`
-
- // Values: The objects of the condition. This is mutually exclusive with
- // 'value'.
- Values []string `json:"values,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Iam") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Condition) MarshalJSON() ([]byte, error) {
- type noMethod Condition
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Group: A Group resource.
-type Group struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always
- // clouduseraccounts#group for groups.
- Kind string `json:"kind,omitempty"`
-
- // Members: [Output Only] A list of URLs to User resources who belong to
- // the group. Users may only be members of groups in the same project.
- Members []string `json:"members,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created.
- Name string `json:"name,omitempty"`
-
- // SelfLink: [Output Only] Server defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Group) MarshalJSON() ([]byte, error) {
- type noMethod Group
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GroupList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of Group resources.
- Items []*Group `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always
- // clouduseraccounts#groupList for lists of groups.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GroupList) MarshalJSON() ([]byte, error) {
- type noMethod GroupList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GroupsAddMemberRequest struct {
- // Users: Fully-qualified URLs of the User resources to add.
- Users []string `json:"users,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Users") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GroupsAddMemberRequest) MarshalJSON() ([]byte, error) {
- type noMethod GroupsAddMemberRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GroupsRemoveMemberRequest struct {
- // Users: Fully-qualified URLs of the User resources to remove.
- Users []string `json:"users,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Users") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GroupsRemoveMemberRequest) MarshalJSON() ([]byte, error) {
- type noMethod GroupsRemoveMemberRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LinuxAccountViews: A list of all Linux accounts for this project.
-// This API is only used by Compute Engine virtual machines to get
-// information about user accounts for a project or instance. Linux
-// resources are read-only views into users and groups managed by the
-// Compute Engine Accounts API.
-type LinuxAccountViews struct {
- // GroupViews: [Output Only] A list of all groups within a project.
- GroupViews []*LinuxGroupView `json:"groupViews,omitempty"`
-
- // Kind: [Output Only] Type of the resource. Always
- // clouduseraccounts#linuxAccountViews for Linux resources.
- Kind string `json:"kind,omitempty"`
-
- // UserViews: [Output Only] A list of all users within a project.
- UserViews []*LinuxUserView `json:"userViews,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "GroupViews") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LinuxAccountViews) MarshalJSON() ([]byte, error) {
- type noMethod LinuxAccountViews
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type LinuxGetAuthorizedKeysViewResponse struct {
- // Resource: [Output Only] A list of authorized public keys for a user.
- Resource *AuthorizedKeysView `json:"resource,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Resource") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LinuxGetAuthorizedKeysViewResponse) MarshalJSON() ([]byte, error) {
- type noMethod LinuxGetAuthorizedKeysViewResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type LinuxGetLinuxAccountViewsResponse struct {
- // Resource: [Output Only] A list of authorized user accounts and
- // groups.
- Resource *LinuxAccountViews `json:"resource,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Resource") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LinuxGetLinuxAccountViewsResponse) MarshalJSON() ([]byte, error) {
- type noMethod LinuxGetLinuxAccountViewsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LinuxGroupView: A detailed view of a Linux group.
-type LinuxGroupView struct {
- // Gid: [Output Only] The Group ID.
- Gid int64 `json:"gid,omitempty"`
-
- // GroupName: [Output Only] Group name.
- GroupName string `json:"groupName,omitempty"`
-
- // Members: [Output Only] List of user accounts that belong to the
- // group.
- Members []string `json:"members,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Gid") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LinuxGroupView) MarshalJSON() ([]byte, error) {
- type noMethod LinuxGroupView
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LinuxUserView: A detailed view of a Linux user account.
-type LinuxUserView struct {
- // Gecos: [Output Only] The GECOS (user information) entry for this
- // account.
- Gecos string `json:"gecos,omitempty"`
-
- // Gid: [Output Only] User's default group ID.
- Gid int64 `json:"gid,omitempty"`
-
- // HomeDirectory: [Output Only] The path to the home directory for this
- // account.
- HomeDirectory string `json:"homeDirectory,omitempty"`
-
- // Shell: [Output Only] The path to the login shell for this account.
- Shell string `json:"shell,omitempty"`
-
- // Uid: [Output Only] User ID.
- Uid int64 `json:"uid,omitempty"`
-
- // Username: [Output Only] The username of the account.
- Username string `json:"username,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Gecos") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LinuxUserView) MarshalJSON() ([]byte, error) {
- type noMethod LinuxUserView
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LogConfig: Specifies what kind of log the caller must write
-type LogConfig struct {
- // Counter: Counter options.
- Counter *LogConfigCounterOptions `json:"counter,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Counter") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LogConfig) MarshalJSON() ([]byte, error) {
- type noMethod LogConfig
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LogConfigCounterOptions: Options for counters
-type LogConfigCounterOptions struct {
- // Field: The field value to attribute.
- Field string `json:"field,omitempty"`
-
- // Metric: The metric to update.
- Metric string `json:"metric,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Field") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LogConfigCounterOptions) MarshalJSON() ([]byte, error) {
- type noMethod LogConfigCounterOptions
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Operation: An Operation resource, used to manage asynchronous API
-// requests.
-type Operation struct {
- // ClientOperationId: [Output Only] An optional identifier specified by
- // the client when the mutation was initiated. Must be unique for all
- // Operation resources in the project.
- ClientOperationId string `json:"clientOperationId,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // EndTime: [Output Only] The time that this operation was completed.
- // This is in RFC3339 text format.
- EndTime string `json:"endTime,omitempty"`
-
- // Error: [Output Only] If errors are generated during processing of the
- // operation, this field will be populated.
- Error *OperationError `json:"error,omitempty"`
-
- // HttpErrorMessage: [Output Only] If the operation fails, this field
- // contains the HTTP error message that was returned, such as NOT FOUND.
- HttpErrorMessage string `json:"httpErrorMessage,omitempty"`
-
- // HttpErrorStatusCode: [Output Only] If the operation fails, this field
- // contains the HTTP error message that was returned, such as 404.
- HttpErrorStatusCode int64 `json:"httpErrorStatusCode,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // InsertTime: [Output Only] The time that this operation was requested.
- // This is in RFC3339 text format.
- InsertTime string `json:"insertTime,omitempty"`
-
- // Kind: [Output Only] Type of the resource. Always compute#operation
- // for Operation resources.
- Kind string `json:"kind,omitempty"`
-
- // Name: [Output Only] Name of the resource.
- Name string `json:"name,omitempty"`
-
- // OperationType: [Output Only] Type of the operation, such as insert,
- // compute.instanceGroups.update, or compute.instanceGroups.delete.
- OperationType string `json:"operationType,omitempty"`
-
- // Progress: [Output Only] An optional progress indicator that ranges
- // from 0 to 100. There is no requirement that this be linear or support
- // any granularity of operations. This should not be used to guess at
- // when the operation will be complete. This number should monotonically
- // increase as the operation progresses.
- Progress int64 `json:"progress,omitempty"`
-
- // Region: [Output Only] URL of the region where the operation resides.
- // Only applicable for regional resources.
- Region string `json:"region,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // StartTime: [Output Only] The time that this operation was started by
- // the server. This is in RFC3339 text format.
- StartTime string `json:"startTime,omitempty"`
-
- // Status: [Output Only] Status of the operation. Can be one of the
- // following: PENDING, RUNNING, or DONE.
- //
- // Possible values:
- // "DONE"
- // "PENDING"
- // "RUNNING"
- Status string `json:"status,omitempty"`
-
- // StatusMessage: [Output Only] An optional textual description of the
- // current status of the operation.
- StatusMessage string `json:"statusMessage,omitempty"`
-
- // TargetId: [Output Only] Unique target ID which identifies a
- // particular incarnation of the target.
- TargetId uint64 `json:"targetId,omitempty,string"`
-
- // TargetLink: [Output Only] URL of the resource the operation is
- // mutating.
- TargetLink string `json:"targetLink,omitempty"`
-
- // User: [Output Only] User who requested the operation, for example:
- // user@example.com.
- User string `json:"user,omitempty"`
-
- // Warnings: [Output Only] If warning messages are generated during
- // processing of the operation, this field will be populated.
- Warnings []*OperationWarnings `json:"warnings,omitempty"`
-
- // Zone: [Output Only] URL of the zone where the operation resides.
- Zone string `json:"zone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ClientOperationId")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Operation) MarshalJSON() ([]byte, error) {
- type noMethod Operation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperationError: [Output Only] If errors are generated during
-// processing of the operation, this field will be populated.
-type OperationError struct {
- // Errors: [Output Only] The array of errors encountered while
- // processing this operation.
- Errors []*OperationErrorErrors `json:"errors,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Errors") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationError) MarshalJSON() ([]byte, error) {
- type noMethod OperationError
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationErrorErrors struct {
- // Code: [Output Only] The error type identifier for this error.
- Code string `json:"code,omitempty"`
-
- // Location: [Output Only] Indicates the field in the request which
- // caused the error. This property is optional.
- Location string `json:"location,omitempty"`
-
- // Message: [Output Only] An optional, human-readable error message.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationErrorErrors) MarshalJSON() ([]byte, error) {
- type noMethod OperationErrorErrors
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationWarnings struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*OperationWarningsData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationWarnings) MarshalJSON() ([]byte, error) {
- type noMethod OperationWarnings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationWarningsData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationWarningsData) MarshalJSON() ([]byte, error) {
- type noMethod OperationWarningsData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperationList: Contains a list of Operation resources.
-type OperationList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] The Operation resources.
- Items []*Operation `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#operations for
- // Operations resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncate.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationList) MarshalJSON() ([]byte, error) {
- type noMethod OperationList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Policy: Defines an Identity and Access Management (IAM) policy. It is
-// used to specify access control policies for Cloud Platform
-// resources.
-//
-//
-//
-// A `Policy` consists of a list of `bindings`. A `Binding` binds a list
-// of `members` to a `role`, where the members can be user accounts,
-// Google groups, Google domains, and service accounts. A `role` is a
-// named list of permissions defined by IAM.
-//
-// **Example**
-//
-// { "bindings": [ { "role": "roles/owner", "members": [
-// "user:mike@example.com", "group:admins@example.com",
-// "domain:google.com",
-// "serviceAccount:my-other-app@appspot.gserviceaccount.com"] }, {
-// "role": "roles/viewer", "members": ["user:sean@example.com"] } ]
-// }
-//
-// For a description of IAM and its features, see the [IAM developer's
-// guide](https://cloud.google.com/iam).
-type Policy struct {
- // Bindings: Associates a list of `members` to a `role`. Multiple
- // `bindings` must not be specified for the same `role`. `bindings` with
- // no members will result in an error.
- Bindings []*Binding `json:"bindings,omitempty"`
-
- // Etag: Can be used to perform a read-modify-write.
- Etag string `json:"etag,omitempty"`
-
- Rules []*Rule `json:"rules,omitempty"`
-
- // Version: Version of the `Policy`. The default version is 0.
- Version int64 `json:"version,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Bindings") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Policy) MarshalJSON() ([]byte, error) {
- type noMethod Policy
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PublicKey: A public key for authenticating to guests.
-type PublicKey struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // ExpirationTimestamp: Optional expiration timestamp. If provided, the
- // timestamp must be in RFC3339 text format. If not provided, the public
- // key never expires.
- ExpirationTimestamp string `json:"expirationTimestamp,omitempty"`
-
- // Fingerprint: [Output Only] The fingerprint of the key is defined by
- // RFC4716 to be the MD5 digest of the public key.
- Fingerprint string `json:"fingerprint,omitempty"`
-
- // Key: Public key text in SSH format, defined by RFC4253 section 6.6.
- Key string `json:"key,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PublicKey) MarshalJSON() ([]byte, error) {
- type noMethod PublicKey
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Rule: A rule to be applied in a Policy.
-type Rule struct {
- // Action: Required
- //
- // Possible values:
- // "ALLOW"
- // "ALLOW_WITH_LOG"
- // "DENY"
- // "DENY_WITH_LOG"
- // "LOG"
- // "NO_ACTION"
- Action string `json:"action,omitempty"`
-
- // Conditions: Additional restrictions that must be met
- Conditions []*Condition `json:"conditions,omitempty"`
-
- // Description: Human-readable description of the rule.
- Description string `json:"description,omitempty"`
-
- // Ins: The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this
- // set of entries.
- Ins []string `json:"ins,omitempty"`
-
- // LogConfigs: The config returned to callers of
- // tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
- LogConfigs []*LogConfig `json:"logConfigs,omitempty"`
-
- // NotIns: The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not
- // in this set of entries.
- NotIns []string `json:"notIns,omitempty"`
-
- // Permissions: A permission is a string of form '..' (e.g.,
- // 'storage.buckets.list'). A value of '*' matches all permissions, and
- // a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
- Permissions []string `json:"permissions,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Action") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Rule) MarshalJSON() ([]byte, error) {
- type noMethod Rule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TestPermissionsRequest struct {
- // Permissions: The set of permissions to check for the 'resource'.
- // Permissions with wildcards (such as '*' or 'storage.*') are not
- // allowed.
- Permissions []string `json:"permissions,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Permissions") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TestPermissionsRequest) MarshalJSON() ([]byte, error) {
- type noMethod TestPermissionsRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TestPermissionsResponse struct {
- // Permissions: A subset of `TestPermissionsRequest.permissions` that
- // the caller is allowed.
- Permissions []string `json:"permissions,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Permissions") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TestPermissionsResponse) MarshalJSON() ([]byte, error) {
- type noMethod TestPermissionsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// User: A User resource.
-type User struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Groups: [Output Only] A list of URLs to Group resources who contain
- // the user. Users are only members of groups in the same project.
- Groups []string `json:"groups,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always
- // clouduseraccounts#user for users.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created.
- Name string `json:"name,omitempty"`
-
- // Owner: Email address of account's owner. This account will be
- // validated to make sure it exists. The email can belong to any domain,
- // but it must be tied to a Google account.
- Owner string `json:"owner,omitempty"`
-
- // PublicKeys: [Output Only] Public keys that this user may use to
- // login.
- PublicKeys []*PublicKey `json:"publicKeys,omitempty"`
-
- // SelfLink: [Output Only] Server defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *User) MarshalJSON() ([]byte, error) {
- type noMethod User
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UserList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of User resources.
- Items []*User `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always
- // clouduseraccounts#userList for lists of users.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserList) MarshalJSON() ([]byte, error) {
- type noMethod UserList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "clouduseraccounts.globalAccountsOperations.delete":
-
-type GlobalAccountsOperationsDeleteCall struct {
- s *Service
- project string
- operation string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified operation resource.
-func (r *GlobalAccountsOperationsService) Delete(project string, operation string) *GlobalAccountsOperationsDeleteCall {
- c := &GlobalAccountsOperationsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.operation = operation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalAccountsOperationsDeleteCall) Fields(s ...googleapi.Field) *GlobalAccountsOperationsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalAccountsOperationsDeleteCall) Context(ctx context.Context) *GlobalAccountsOperationsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalAccountsOperationsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/operations/{operation}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "operation": c.operation,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.globalAccountsOperations.delete" call.
-func (c *GlobalAccountsOperationsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes the specified operation resource.",
- // "httpMethod": "DELETE",
- // "id": "clouduseraccounts.globalAccountsOperations.delete",
- // "parameterOrder": [
- // "project",
- // "operation"
- // ],
- // "parameters": {
- // "operation": {
- // "description": "Name of the Operations resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/operations/{operation}",
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.globalAccountsOperations.get":
-
-type GlobalAccountsOperationsGetCall struct {
- s *Service
- project string
- operation string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves the specified operation resource.
-func (r *GlobalAccountsOperationsService) Get(project string, operation string) *GlobalAccountsOperationsGetCall {
- c := &GlobalAccountsOperationsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.operation = operation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalAccountsOperationsGetCall) Fields(s ...googleapi.Field) *GlobalAccountsOperationsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GlobalAccountsOperationsGetCall) IfNoneMatch(entityTag string) *GlobalAccountsOperationsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalAccountsOperationsGetCall) Context(ctx context.Context) *GlobalAccountsOperationsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalAccountsOperationsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/operations/{operation}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "operation": c.operation,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.globalAccountsOperations.get" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GlobalAccountsOperationsGetCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the specified operation resource.",
- // "httpMethod": "GET",
- // "id": "clouduseraccounts.globalAccountsOperations.get",
- // "parameterOrder": [
- // "project",
- // "operation"
- // ],
- // "parameters": {
- // "operation": {
- // "description": "Name of the Operations resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/operations/{operation}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.globalAccountsOperations.list":
-
-type GlobalAccountsOperationsListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of operation resources contained within the
-// specified project.
-func (r *GlobalAccountsOperationsService) List(project string) *GlobalAccountsOperationsListCall {
- c := &GlobalAccountsOperationsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *GlobalAccountsOperationsListCall) Filter(filter string) *GlobalAccountsOperationsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *GlobalAccountsOperationsListCall) MaxResults(maxResults int64) *GlobalAccountsOperationsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *GlobalAccountsOperationsListCall) OrderBy(orderBy string) *GlobalAccountsOperationsListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *GlobalAccountsOperationsListCall) PageToken(pageToken string) *GlobalAccountsOperationsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalAccountsOperationsListCall) Fields(s ...googleapi.Field) *GlobalAccountsOperationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GlobalAccountsOperationsListCall) IfNoneMatch(entityTag string) *GlobalAccountsOperationsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalAccountsOperationsListCall) Context(ctx context.Context) *GlobalAccountsOperationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalAccountsOperationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/operations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.globalAccountsOperations.list" call.
-// Exactly one of *OperationList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *OperationList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *GlobalAccountsOperationsListCall) Do() (*OperationList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OperationList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of operation resources contained within the specified project.",
- // "httpMethod": "GET",
- // "id": "clouduseraccounts.globalAccountsOperations.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/operations",
- // "response": {
- // "$ref": "OperationList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.addMember":
-
-type GroupsAddMemberCall struct {
- s *Service
- project string
- groupName string
- groupsaddmemberrequest *GroupsAddMemberRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AddMember: Adds users to the specified group.
-func (r *GroupsService) AddMember(project string, groupName string, groupsaddmemberrequest *GroupsAddMemberRequest) *GroupsAddMemberCall {
- c := &GroupsAddMemberCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.groupName = groupName
- c.groupsaddmemberrequest = groupsaddmemberrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsAddMemberCall) Fields(s ...googleapi.Field) *GroupsAddMemberCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsAddMemberCall) Context(ctx context.Context) *GroupsAddMemberCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsAddMemberCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.groupsaddmemberrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups/{groupName}/addMember")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "groupName": c.groupName,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.addMember" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GroupsAddMemberCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Adds users to the specified group.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.groups.addMember",
- // "parameterOrder": [
- // "project",
- // "groupName"
- // ],
- // "parameters": {
- // "groupName": {
- // "description": "Name of the group for this request.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups/{groupName}/addMember",
- // "request": {
- // "$ref": "GroupsAddMemberRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.delete":
-
-type GroupsDeleteCall struct {
- s *Service
- project string
- groupName string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified Group resource.
-func (r *GroupsService) Delete(project string, groupName string) *GroupsDeleteCall {
- c := &GroupsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.groupName = groupName
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsDeleteCall) Fields(s ...googleapi.Field) *GroupsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsDeleteCall) Context(ctx context.Context) *GroupsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups/{groupName}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "groupName": c.groupName,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GroupsDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified Group resource.",
- // "httpMethod": "DELETE",
- // "id": "clouduseraccounts.groups.delete",
- // "parameterOrder": [
- // "project",
- // "groupName"
- // ],
- // "parameters": {
- // "groupName": {
- // "description": "Name of the Group resource to delete.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups/{groupName}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.get":
-
-type GroupsGetCall struct {
- s *Service
- project string
- groupName string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified Group resource.
-func (r *GroupsService) Get(project string, groupName string) *GroupsGetCall {
- c := &GroupsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.groupName = groupName
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsGetCall) Fields(s ...googleapi.Field) *GroupsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GroupsGetCall) IfNoneMatch(entityTag string) *GroupsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsGetCall) Context(ctx context.Context) *GroupsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups/{groupName}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "groupName": c.groupName,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.get" call.
-// Exactly one of *Group or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Group.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *GroupsGetCall) Do() (*Group, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Group{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified Group resource.",
- // "httpMethod": "GET",
- // "id": "clouduseraccounts.groups.get",
- // "parameterOrder": [
- // "project",
- // "groupName"
- // ],
- // "parameters": {
- // "groupName": {
- // "description": "Name of the Group resource to return.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups/{groupName}",
- // "response": {
- // "$ref": "Group"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.getIamPolicy":
-
-type GroupsGetIamPolicyCall struct {
- s *Service
- project string
- resource string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetIamPolicy: Gets the access control policy for a resource. May be
-// empty if no such policy or resource exists.
-func (r *GroupsService) GetIamPolicy(project string, resource string) *GroupsGetIamPolicyCall {
- c := &GroupsGetIamPolicyCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.resource = resource
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsGetIamPolicyCall) Fields(s ...googleapi.Field) *GroupsGetIamPolicyCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GroupsGetIamPolicyCall) IfNoneMatch(entityTag string) *GroupsGetIamPolicyCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsGetIamPolicyCall) Context(ctx context.Context) *GroupsGetIamPolicyCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsGetIamPolicyCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups/{resource}/getIamPolicy")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "resource": c.resource,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.getIamPolicy" call.
-// Exactly one of *Policy or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Policy.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *GroupsGetIamPolicyCall) Do() (*Policy, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Policy{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
- // "httpMethod": "GET",
- // "id": "clouduseraccounts.groups.getIamPolicy",
- // "parameterOrder": [
- // "project",
- // "resource"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "resource": {
- // "description": "Name of the resource for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups/{resource}/getIamPolicy",
- // "response": {
- // "$ref": "Policy"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.insert":
-
-type GroupsInsertCall struct {
- s *Service
- project string
- group *Group
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a Group resource in the specified project using the
-// data included in the request.
-func (r *GroupsService) Insert(project string, group *Group) *GroupsInsertCall {
- c := &GroupsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.group = group
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsInsertCall) Fields(s ...googleapi.Field) *GroupsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsInsertCall) Context(ctx context.Context) *GroupsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.group)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GroupsInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a Group resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.groups.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups",
- // "request": {
- // "$ref": "Group"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.list":
-
-type GroupsListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of groups contained within the specified
-// project.
-func (r *GroupsService) List(project string) *GroupsListCall {
- c := &GroupsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *GroupsListCall) Filter(filter string) *GroupsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *GroupsListCall) MaxResults(maxResults int64) *GroupsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *GroupsListCall) OrderBy(orderBy string) *GroupsListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *GroupsListCall) PageToken(pageToken string) *GroupsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsListCall) Fields(s ...googleapi.Field) *GroupsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GroupsListCall) IfNoneMatch(entityTag string) *GroupsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsListCall) Context(ctx context.Context) *GroupsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.list" call.
-// Exactly one of *GroupList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *GroupList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GroupsListCall) Do() (*GroupList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &GroupList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of groups contained within the specified project.",
- // "httpMethod": "GET",
- // "id": "clouduseraccounts.groups.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups",
- // "response": {
- // "$ref": "GroupList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.removeMember":
-
-type GroupsRemoveMemberCall struct {
- s *Service
- project string
- groupName string
- groupsremovememberrequest *GroupsRemoveMemberRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// RemoveMember: Removes users from the specified group.
-func (r *GroupsService) RemoveMember(project string, groupName string, groupsremovememberrequest *GroupsRemoveMemberRequest) *GroupsRemoveMemberCall {
- c := &GroupsRemoveMemberCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.groupName = groupName
- c.groupsremovememberrequest = groupsremovememberrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsRemoveMemberCall) Fields(s ...googleapi.Field) *GroupsRemoveMemberCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsRemoveMemberCall) Context(ctx context.Context) *GroupsRemoveMemberCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsRemoveMemberCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.groupsremovememberrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups/{groupName}/removeMember")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "groupName": c.groupName,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.removeMember" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GroupsRemoveMemberCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Removes users from the specified group.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.groups.removeMember",
- // "parameterOrder": [
- // "project",
- // "groupName"
- // ],
- // "parameters": {
- // "groupName": {
- // "description": "Name of the group for this request.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups/{groupName}/removeMember",
- // "request": {
- // "$ref": "GroupsRemoveMemberRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.setIamPolicy":
-
-type GroupsSetIamPolicyCall struct {
- s *Service
- project string
- resource string
- policy *Policy
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetIamPolicy: Sets the access control policy on the specified
-// resource. Replaces any existing policy.
-func (r *GroupsService) SetIamPolicy(project string, resource string, policy *Policy) *GroupsSetIamPolicyCall {
- c := &GroupsSetIamPolicyCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.resource = resource
- c.policy = policy
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsSetIamPolicyCall) Fields(s ...googleapi.Field) *GroupsSetIamPolicyCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsSetIamPolicyCall) Context(ctx context.Context) *GroupsSetIamPolicyCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsSetIamPolicyCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.policy)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups/{resource}/setIamPolicy")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "resource": c.resource,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.setIamPolicy" call.
-// Exactly one of *Policy or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Policy.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *GroupsSetIamPolicyCall) Do() (*Policy, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Policy{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.groups.setIamPolicy",
- // "parameterOrder": [
- // "project",
- // "resource"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "resource": {
- // "description": "Name of the resource for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups/{resource}/setIamPolicy",
- // "request": {
- // "$ref": "Policy"
- // },
- // "response": {
- // "$ref": "Policy"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.testIamPermissions":
-
-type GroupsTestIamPermissionsCall struct {
- s *Service
- project string
- resource string
- testpermissionsrequest *TestPermissionsRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// TestIamPermissions: Returns permissions that a caller has on the
-// specified resource.
-func (r *GroupsService) TestIamPermissions(project string, resource string, testpermissionsrequest *TestPermissionsRequest) *GroupsTestIamPermissionsCall {
- c := &GroupsTestIamPermissionsCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.resource = resource
- c.testpermissionsrequest = testpermissionsrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsTestIamPermissionsCall) Fields(s ...googleapi.Field) *GroupsTestIamPermissionsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsTestIamPermissionsCall) Context(ctx context.Context) *GroupsTestIamPermissionsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsTestIamPermissionsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.testpermissionsrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups/{resource}/testIamPermissions")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "resource": c.resource,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.testIamPermissions" call.
-// Exactly one of *TestPermissionsResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *TestPermissionsResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *GroupsTestIamPermissionsCall) Do() (*TestPermissionsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TestPermissionsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns permissions that a caller has on the specified resource.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.groups.testIamPermissions",
- // "parameterOrder": [
- // "project",
- // "resource"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "resource": {
- // "description": "Name of the resource for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups/{resource}/testIamPermissions",
- // "request": {
- // "$ref": "TestPermissionsRequest"
- // },
- // "response": {
- // "$ref": "TestPermissionsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.linux.getAuthorizedKeysView":
-
-type LinuxGetAuthorizedKeysViewCall struct {
- s *Service
- project string
- zone string
- user string
- instance string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetAuthorizedKeysView: Returns a list of authorized public keys for a
-// specific user account.
-func (r *LinuxService) GetAuthorizedKeysView(project string, zone string, user string, instance string) *LinuxGetAuthorizedKeysViewCall {
- c := &LinuxGetAuthorizedKeysViewCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.user = user
- c.instance = instance
- return c
-}
-
-// Login sets the optional parameter "login": Whether the view was
-// requested as part of a user-initiated login.
-func (c *LinuxGetAuthorizedKeysViewCall) Login(login bool) *LinuxGetAuthorizedKeysViewCall {
- c.opt_["login"] = login
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LinuxGetAuthorizedKeysViewCall) Fields(s ...googleapi.Field) *LinuxGetAuthorizedKeysViewCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LinuxGetAuthorizedKeysViewCall) Context(ctx context.Context) *LinuxGetAuthorizedKeysViewCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LinuxGetAuthorizedKeysViewCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("instance", fmt.Sprintf("%v", c.instance))
- if v, ok := c.opt_["login"]; ok {
- params.Set("login", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/authorizedKeysView/{user}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "user": c.user,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.linux.getAuthorizedKeysView" call.
-// Exactly one of *LinuxGetAuthorizedKeysViewResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *LinuxGetAuthorizedKeysViewResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *LinuxGetAuthorizedKeysViewCall) Do() (*LinuxGetAuthorizedKeysViewResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &LinuxGetAuthorizedKeysViewResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns a list of authorized public keys for a specific user account.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.linux.getAuthorizedKeysView",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "user",
- // "instance"
- // ],
- // "parameters": {
- // "instance": {
- // "description": "The fully-qualified URL of the virtual machine requesting the view.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "login": {
- // "description": "Whether the view was requested as part of a user-initiated login.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "user": {
- // "description": "The user account for which you want to get a list of authorized public keys.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/authorizedKeysView/{user}",
- // "response": {
- // "$ref": "LinuxGetAuthorizedKeysViewResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.linux.getLinuxAccountViews":
-
-type LinuxGetLinuxAccountViewsCall struct {
- s *Service
- project string
- zone string
- instance string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetLinuxAccountViews: Retrieves a list of user accounts for an
-// instance within a specific project.
-func (r *LinuxService) GetLinuxAccountViews(project string, zone string, instance string) *LinuxGetLinuxAccountViewsCall {
- c := &LinuxGetLinuxAccountViewsCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *LinuxGetLinuxAccountViewsCall) Filter(filter string) *LinuxGetLinuxAccountViewsCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *LinuxGetLinuxAccountViewsCall) MaxResults(maxResults int64) *LinuxGetLinuxAccountViewsCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *LinuxGetLinuxAccountViewsCall) OrderBy(orderBy string) *LinuxGetLinuxAccountViewsCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *LinuxGetLinuxAccountViewsCall) PageToken(pageToken string) *LinuxGetLinuxAccountViewsCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LinuxGetLinuxAccountViewsCall) Fields(s ...googleapi.Field) *LinuxGetLinuxAccountViewsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LinuxGetLinuxAccountViewsCall) Context(ctx context.Context) *LinuxGetLinuxAccountViewsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LinuxGetLinuxAccountViewsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("instance", fmt.Sprintf("%v", c.instance))
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/linuxAccountViews")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.linux.getLinuxAccountViews" call.
-// Exactly one of *LinuxGetLinuxAccountViewsResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *LinuxGetLinuxAccountViewsResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *LinuxGetLinuxAccountViewsCall) Do() (*LinuxGetLinuxAccountViewsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &LinuxGetLinuxAccountViewsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of user accounts for an instance within a specific project.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.linux.getLinuxAccountViews",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "instance": {
- // "description": "The fully-qualified URL of the virtual machine requesting the views.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/linuxAccountViews",
- // "response": {
- // "$ref": "LinuxGetLinuxAccountViewsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.addPublicKey":
-
-type UsersAddPublicKeyCall struct {
- s *Service
- project string
- user string
- publickey *PublicKey
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AddPublicKey: Adds a public key to the specified User resource with
-// the data included in the request.
-func (r *UsersService) AddPublicKey(project string, user string, publickey *PublicKey) *UsersAddPublicKeyCall {
- c := &UsersAddPublicKeyCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.user = user
- c.publickey = publickey
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersAddPublicKeyCall) Fields(s ...googleapi.Field) *UsersAddPublicKeyCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersAddPublicKeyCall) Context(ctx context.Context) *UsersAddPublicKeyCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersAddPublicKeyCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.publickey)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users/{user}/addPublicKey")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "user": c.user,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.addPublicKey" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UsersAddPublicKeyCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Adds a public key to the specified User resource with the data included in the request.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.users.addPublicKey",
- // "parameterOrder": [
- // "project",
- // "user"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "user": {
- // "description": "Name of the user for this request.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users/{user}/addPublicKey",
- // "request": {
- // "$ref": "PublicKey"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.delete":
-
-type UsersDeleteCall struct {
- s *Service
- project string
- user string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified User resource.
-func (r *UsersService) Delete(project string, user string) *UsersDeleteCall {
- c := &UsersDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.user = user
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersDeleteCall) Fields(s ...googleapi.Field) *UsersDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersDeleteCall) Context(ctx context.Context) *UsersDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users/{user}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "user": c.user,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UsersDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified User resource.",
- // "httpMethod": "DELETE",
- // "id": "clouduseraccounts.users.delete",
- // "parameterOrder": [
- // "project",
- // "user"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "user": {
- // "description": "Name of the user resource to delete.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users/{user}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.get":
-
-type UsersGetCall struct {
- s *Service
- project string
- user string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified User resource.
-func (r *UsersService) Get(project string, user string) *UsersGetCall {
- c := &UsersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.user = user
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersGetCall) Fields(s ...googleapi.Field) *UsersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UsersGetCall) IfNoneMatch(entityTag string) *UsersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersGetCall) Context(ctx context.Context) *UsersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users/{user}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "user": c.user,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.get" call.
-// Exactly one of *User or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *User.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *UsersGetCall) Do() (*User, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &User{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified User resource.",
- // "httpMethod": "GET",
- // "id": "clouduseraccounts.users.get",
- // "parameterOrder": [
- // "project",
- // "user"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "user": {
- // "description": "Name of the user resource to return.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users/{user}",
- // "response": {
- // "$ref": "User"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.getIamPolicy":
-
-type UsersGetIamPolicyCall struct {
- s *Service
- project string
- resource string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetIamPolicy: Gets the access control policy for a resource. May be
-// empty if no such policy or resource exists.
-func (r *UsersService) GetIamPolicy(project string, resource string) *UsersGetIamPolicyCall {
- c := &UsersGetIamPolicyCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.resource = resource
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersGetIamPolicyCall) Fields(s ...googleapi.Field) *UsersGetIamPolicyCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UsersGetIamPolicyCall) IfNoneMatch(entityTag string) *UsersGetIamPolicyCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersGetIamPolicyCall) Context(ctx context.Context) *UsersGetIamPolicyCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersGetIamPolicyCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users/{resource}/getIamPolicy")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "resource": c.resource,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.getIamPolicy" call.
-// Exactly one of *Policy or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Policy.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *UsersGetIamPolicyCall) Do() (*Policy, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Policy{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
- // "httpMethod": "GET",
- // "id": "clouduseraccounts.users.getIamPolicy",
- // "parameterOrder": [
- // "project",
- // "resource"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "resource": {
- // "description": "Name of the resource for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users/{resource}/getIamPolicy",
- // "response": {
- // "$ref": "Policy"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.insert":
-
-type UsersInsertCall struct {
- s *Service
- project string
- user *User
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a User resource in the specified project using the
-// data included in the request.
-func (r *UsersService) Insert(project string, user *User) *UsersInsertCall {
- c := &UsersInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.user = user
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersInsertCall) Fields(s ...googleapi.Field) *UsersInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersInsertCall) Context(ctx context.Context) *UsersInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.user)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UsersInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a User resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.users.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users",
- // "request": {
- // "$ref": "User"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.list":
-
-type UsersListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of users contained within the specified
-// project.
-func (r *UsersService) List(project string) *UsersListCall {
- c := &UsersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *UsersListCall) Filter(filter string) *UsersListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *UsersListCall) MaxResults(maxResults int64) *UsersListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *UsersListCall) OrderBy(orderBy string) *UsersListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *UsersListCall) PageToken(pageToken string) *UsersListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersListCall) Fields(s ...googleapi.Field) *UsersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UsersListCall) IfNoneMatch(entityTag string) *UsersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersListCall) Context(ctx context.Context) *UsersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.list" call.
-// Exactly one of *UserList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *UserList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UsersListCall) Do() (*UserList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of users contained within the specified project.",
- // "httpMethod": "GET",
- // "id": "clouduseraccounts.users.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users",
- // "response": {
- // "$ref": "UserList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.removePublicKey":
-
-type UsersRemovePublicKeyCall struct {
- s *Service
- project string
- user string
- fingerprint string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// RemovePublicKey: Removes the specified public key from the user.
-func (r *UsersService) RemovePublicKey(project string, user string, fingerprint string) *UsersRemovePublicKeyCall {
- c := &UsersRemovePublicKeyCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.user = user
- c.fingerprint = fingerprint
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersRemovePublicKeyCall) Fields(s ...googleapi.Field) *UsersRemovePublicKeyCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersRemovePublicKeyCall) Context(ctx context.Context) *UsersRemovePublicKeyCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersRemovePublicKeyCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("fingerprint", fmt.Sprintf("%v", c.fingerprint))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users/{user}/removePublicKey")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "user": c.user,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.removePublicKey" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UsersRemovePublicKeyCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Removes the specified public key from the user.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.users.removePublicKey",
- // "parameterOrder": [
- // "project",
- // "user",
- // "fingerprint"
- // ],
- // "parameters": {
- // "fingerprint": {
- // "description": "The fingerprint of the public key to delete. Public keys are identified by their fingerprint, which is defined by RFC4716 to be the MD5 digest of the public key.",
- // "location": "query",
- // "pattern": "[a-f0-9]{32}",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "user": {
- // "description": "Name of the user for this request.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users/{user}/removePublicKey",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.setIamPolicy":
-
-type UsersSetIamPolicyCall struct {
- s *Service
- project string
- resource string
- policy *Policy
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetIamPolicy: Sets the access control policy on the specified
-// resource. Replaces any existing policy.
-func (r *UsersService) SetIamPolicy(project string, resource string, policy *Policy) *UsersSetIamPolicyCall {
- c := &UsersSetIamPolicyCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.resource = resource
- c.policy = policy
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersSetIamPolicyCall) Fields(s ...googleapi.Field) *UsersSetIamPolicyCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersSetIamPolicyCall) Context(ctx context.Context) *UsersSetIamPolicyCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersSetIamPolicyCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.policy)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users/{resource}/setIamPolicy")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "resource": c.resource,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.setIamPolicy" call.
-// Exactly one of *Policy or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Policy.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *UsersSetIamPolicyCall) Do() (*Policy, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Policy{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.users.setIamPolicy",
- // "parameterOrder": [
- // "project",
- // "resource"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "resource": {
- // "description": "Name of the resource for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users/{resource}/setIamPolicy",
- // "request": {
- // "$ref": "Policy"
- // },
- // "response": {
- // "$ref": "Policy"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.testIamPermissions":
-
-type UsersTestIamPermissionsCall struct {
- s *Service
- project string
- resource string
- testpermissionsrequest *TestPermissionsRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// TestIamPermissions: Returns permissions that a caller has on the
-// specified resource.
-func (r *UsersService) TestIamPermissions(project string, resource string, testpermissionsrequest *TestPermissionsRequest) *UsersTestIamPermissionsCall {
- c := &UsersTestIamPermissionsCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.resource = resource
- c.testpermissionsrequest = testpermissionsrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersTestIamPermissionsCall) Fields(s ...googleapi.Field) *UsersTestIamPermissionsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersTestIamPermissionsCall) Context(ctx context.Context) *UsersTestIamPermissionsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersTestIamPermissionsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.testpermissionsrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users/{resource}/testIamPermissions")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "resource": c.resource,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.testIamPermissions" call.
-// Exactly one of *TestPermissionsResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *TestPermissionsResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *UsersTestIamPermissionsCall) Do() (*TestPermissionsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TestPermissionsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns permissions that a caller has on the specified resource.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.users.testIamPermissions",
- // "parameterOrder": [
- // "project",
- // "resource"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "resource": {
- // "description": "Name of the resource for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users/{resource}/testIamPermissions",
- // "request": {
- // "$ref": "TestPermissionsRequest"
- // },
- // "response": {
- // "$ref": "TestPermissionsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/clouduseraccounts/v0.beta/clouduseraccounts-api.json b/vendor/google.golang.org/api/clouduseraccounts/v0.beta/clouduseraccounts-api.json
deleted file mode 100644
index 4c69589c..00000000
--- a/vendor/google.golang.org/api/clouduseraccounts/v0.beta/clouduseraccounts-api.json
+++ /dev/null
@@ -1,1355 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/xBfFzMk6wt9FD4JzWVbI-t4fKcE\"",
- "discoveryVersion": "v1",
- "id": "clouduseraccounts:beta",
- "name": "clouduseraccounts",
- "canonicalName": "Cloud User Accounts",
- "version": "beta",
- "revision": "20150917",
- "title": "Cloud User Accounts API",
- "description": "API for the Google Cloud User Accounts service.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/compute_engine-16.png",
- "x32": "https://www.google.com/images/icons/product/compute_engine-32.png"
- },
- "documentationLink": "https://cloud.google.com/compute/docs/access/user-accounts/api/latest/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/clouduseraccounts/beta/projects/",
- "basePath": "/clouduseraccounts/beta/projects/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "clouduseraccounts/beta/projects/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud.useraccounts": {
- "description": "Manage your Google Cloud User Accounts"
- },
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly": {
- "description": "View your Google Cloud User Accounts"
- }
- }
- }
- },
- "schemas": {
- "AuthorizedKeysView": {
- "id": "AuthorizedKeysView",
- "type": "object",
- "description": "A list of authorized public keys for a user account.",
- "properties": {
- "keys": {
- "type": "array",
- "description": "[Output Only] The list of authorized public keys in SSH format.",
- "items": {
- "type": "string"
- }
- },
- "sudoer": {
- "type": "boolean",
- "description": "[Output Only] Whether the user has the ability to elevate on the instance that requested the authorized keys."
- }
- }
- },
- "Group": {
- "id": "Group",
- "type": "object",
- "description": "A Group resource.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always clouduseraccounts#group for groups.",
- "default": "clouduseraccounts#group"
- },
- "members": {
- "type": "array",
- "description": "[Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.",
- "items": {
- "type": "string"
- }
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created.",
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "annotations": {
- "required": [
- "clouduseraccounts.groups.insert"
- ]
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server defined URL for the resource."
- }
- }
- },
- "GroupList": {
- "id": "GroupList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of Group resources.",
- "items": {
- "$ref": "Group"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always clouduseraccounts#groupList for lists of groups.",
- "default": "clouduseraccounts#groupList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server defined URL for this resource."
- }
- }
- },
- "GroupsAddMemberRequest": {
- "id": "GroupsAddMemberRequest",
- "type": "object",
- "properties": {
- "users": {
- "type": "array",
- "description": "Fully-qualified URLs of the User resources to add.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "GroupsRemoveMemberRequest": {
- "id": "GroupsRemoveMemberRequest",
- "type": "object",
- "properties": {
- "users": {
- "type": "array",
- "description": "Fully-qualified URLs of the User resources to remove.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "LinuxAccountViews": {
- "id": "LinuxAccountViews",
- "type": "object",
- "description": "A list of all Linux accounts for this project. This API is only used by Compute Engine virtual machines to get information about user accounts for a project or instance. Linux resources are read-only views into users and groups managed by the Compute Engine Accounts API.",
- "properties": {
- "groupViews": {
- "type": "array",
- "description": "[Output Only] A list of all groups within a project.",
- "items": {
- "$ref": "LinuxGroupView"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always clouduseraccounts#linuxAccountViews for Linux resources.",
- "default": "clouduseraccounts#linuxAccountViews"
- },
- "userViews": {
- "type": "array",
- "description": "[Output Only] A list of all users within a project.",
- "items": {
- "$ref": "LinuxUserView"
- }
- }
- }
- },
- "LinuxGetAuthorizedKeysViewResponse": {
- "id": "LinuxGetAuthorizedKeysViewResponse",
- "type": "object",
- "properties": {
- "resource": {
- "$ref": "AuthorizedKeysView",
- "description": "[Output Only] A list of authorized public keys for a user."
- }
- }
- },
- "LinuxGetLinuxAccountViewsResponse": {
- "id": "LinuxGetLinuxAccountViewsResponse",
- "type": "object",
- "properties": {
- "resource": {
- "$ref": "LinuxAccountViews",
- "description": "[Output Only] A list of authorized user accounts and groups."
- }
- }
- },
- "LinuxGroupView": {
- "id": "LinuxGroupView",
- "type": "object",
- "description": "A detailed view of a Linux group.",
- "properties": {
- "gid": {
- "type": "integer",
- "description": "[Output Only] The Group ID.",
- "format": "uint32"
- },
- "groupName": {
- "type": "string",
- "description": "[Output Only] Group name."
- },
- "members": {
- "type": "array",
- "description": "[Output Only] List of user accounts that belong to the group.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "LinuxUserView": {
- "id": "LinuxUserView",
- "type": "object",
- "description": "A detailed view of a Linux user account.",
- "properties": {
- "gecos": {
- "type": "string",
- "description": "[Output Only] The GECOS (user information) entry for this account."
- },
- "gid": {
- "type": "integer",
- "description": "[Output Only] User's default group ID.",
- "format": "uint32"
- },
- "homeDirectory": {
- "type": "string",
- "description": "[Output Only] The path to the home directory for this account."
- },
- "shell": {
- "type": "string",
- "description": "[Output Only] The path to the login shell for this account."
- },
- "uid": {
- "type": "integer",
- "description": "[Output Only] User ID.",
- "format": "uint32"
- },
- "username": {
- "type": "string",
- "description": "[Output Only] The username of the account."
- }
- }
- },
- "Operation": {
- "id": "Operation",
- "type": "object",
- "description": "An Operation resource, used to manage asynchronous API requests.",
- "properties": {
- "clientOperationId": {
- "type": "string",
- "description": "[Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "endTime": {
- "type": "string",
- "description": "[Output Only] The time that this operation was completed. This is in RFC3339 text format."
- },
- "error": {
- "type": "object",
- "description": "[Output Only] If errors are generated during processing of the operation, this field will be populated.",
- "properties": {
- "errors": {
- "type": "array",
- "description": "[Output Only] The array of errors encountered while processing this operation.",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The error type identifier for this error."
- },
- "location": {
- "type": "string",
- "description": "[Output Only] Indicates the field in the request which caused the error. This property is optional."
- },
- "message": {
- "type": "string",
- "description": "[Output Only] An optional, human-readable error message."
- }
- }
- }
- }
- }
- },
- "httpErrorMessage": {
- "type": "string",
- "description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND."
- },
- "httpErrorStatusCode": {
- "type": "integer",
- "description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.",
- "format": "int32"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "insertTime": {
- "type": "string",
- "description": "[Output Only] The time that this operation was requested. This is in RFC3339 text format."
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#operation for Operation resources.",
- "default": "clouduseraccounts#operation"
- },
- "name": {
- "type": "string",
- "description": "[Output Only] Name of the resource."
- },
- "operationType": {
- "type": "string",
- "description": "[Output Only] Type of the operation, such as insert, compute.instanceGroups.update, or compute.instanceGroups.delete."
- },
- "progress": {
- "type": "integer",
- "description": "[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.",
- "format": "int32"
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the operation resides. Only applicable for regional resources."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "startTime": {
- "type": "string",
- "description": "[Output Only] The time that this operation was started by the server. This is in RFC3339 text format."
- },
- "status": {
- "type": "string",
- "description": "[Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.",
- "enum": [
- "DONE",
- "PENDING",
- "RUNNING"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "statusMessage": {
- "type": "string",
- "description": "[Output Only] An optional textual description of the current status of the operation."
- },
- "targetId": {
- "type": "string",
- "description": "[Output Only] Unique target ID which identifies a particular incarnation of the target.",
- "format": "uint64"
- },
- "targetLink": {
- "type": "string",
- "description": "[Output Only] URL of the resource the operation is mutating."
- },
- "user": {
- "type": "string",
- "description": "[Output Only] User who requested the operation, for example: user@example.com."
- },
- "warnings": {
- "type": "array",
- "description": "[Output Only] If warning messages are generated during processing of the operation, this field will be populated.",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- },
- "zone": {
- "type": "string",
- "description": "[Output Only] URL of the zone where the operation resides."
- }
- }
- },
- "OperationList": {
- "id": "OperationList",
- "type": "object",
- "description": "Contains a list of Operation resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] The Operation resources.",
- "items": {
- "$ref": "Operation"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#operations for Operations resource.",
- "default": "clouduseraccounts#operationList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncate."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "PublicKey": {
- "id": "PublicKey",
- "type": "object",
- "description": "A public key for authenticating to guests.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "expirationTimestamp": {
- "type": "string",
- "description": "Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires."
- },
- "fingerprint": {
- "type": "string",
- "description": "[Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key."
- },
- "key": {
- "type": "string",
- "description": "Public key text in SSH format, defined by RFC4253 section 6.6."
- }
- }
- },
- "User": {
- "id": "User",
- "type": "object",
- "description": "A User resource.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "groups": {
- "type": "array",
- "description": "[Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always clouduseraccounts#user for users.",
- "default": "clouduseraccounts#user"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created.",
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "annotations": {
- "required": [
- "clouduseraccounts.users.insert"
- ]
- }
- },
- "owner": {
- "type": "string",
- "description": "Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.",
- "annotations": {
- "required": [
- "clouduseraccounts.users.insert"
- ]
- }
- },
- "publicKeys": {
- "type": "array",
- "description": "[Output Only] Public keys that this user may use to login.",
- "items": {
- "$ref": "PublicKey"
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server defined URL for the resource."
- }
- }
- },
- "UserList": {
- "id": "UserList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of User resources.",
- "items": {
- "$ref": "User"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always clouduseraccounts#userList for lists of users.",
- "default": "clouduseraccounts#userList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server defined URL for this resource."
- }
- }
- }
- },
- "resources": {
- "globalAccountsOperations": {
- "methods": {
- "delete": {
- "id": "clouduseraccounts.globalAccountsOperations.delete",
- "path": "{project}/global/operations/{operation}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified operation resource.",
- "parameters": {
- "operation": {
- "type": "string",
- "description": "Name of the Operations resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "operation"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "get": {
- "id": "clouduseraccounts.globalAccountsOperations.get",
- "path": "{project}/global/operations/{operation}",
- "httpMethod": "GET",
- "description": "Retrieves the specified operation resource.",
- "parameters": {
- "operation": {
- "type": "string",
- "description": "Name of the Operations resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "operation"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "list": {
- "id": "clouduseraccounts.globalAccountsOperations.list",
- "path": "{project}/global/operations",
- "httpMethod": "GET",
- "description": "Retrieves the list of operation resources contained within the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "OperationList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- }
- }
- },
- "groups": {
- "methods": {
- "addMember": {
- "id": "clouduseraccounts.groups.addMember",
- "path": "{project}/global/groups/{groupName}/addMember",
- "httpMethod": "POST",
- "description": "Adds users to the specified group.",
- "parameters": {
- "groupName": {
- "type": "string",
- "description": "Name of the group for this request.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "groupName"
- ],
- "request": {
- "$ref": "GroupsAddMemberRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "delete": {
- "id": "clouduseraccounts.groups.delete",
- "path": "{project}/global/groups/{groupName}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified Group resource.",
- "parameters": {
- "groupName": {
- "type": "string",
- "description": "Name of the Group resource to delete.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "groupName"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "get": {
- "id": "clouduseraccounts.groups.get",
- "path": "{project}/global/groups/{groupName}",
- "httpMethod": "GET",
- "description": "Returns the specified Group resource.",
- "parameters": {
- "groupName": {
- "type": "string",
- "description": "Name of the Group resource to return.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "groupName"
- ],
- "response": {
- "$ref": "Group"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "insert": {
- "id": "clouduseraccounts.groups.insert",
- "path": "{project}/global/groups",
- "httpMethod": "POST",
- "description": "Creates a Group resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "Group"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "list": {
- "id": "clouduseraccounts.groups.list",
- "path": "{project}/global/groups",
- "httpMethod": "GET",
- "description": "Retrieves the list of groups contained within the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "GroupList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "removeMember": {
- "id": "clouduseraccounts.groups.removeMember",
- "path": "{project}/global/groups/{groupName}/removeMember",
- "httpMethod": "POST",
- "description": "Removes users from the specified group.",
- "parameters": {
- "groupName": {
- "type": "string",
- "description": "Name of the group for this request.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "groupName"
- ],
- "request": {
- "$ref": "GroupsRemoveMemberRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- }
- }
- },
- "linux": {
- "methods": {
- "getAuthorizedKeysView": {
- "id": "clouduseraccounts.linux.getAuthorizedKeysView",
- "path": "{project}/zones/{zone}/authorizedKeysView/{user}",
- "httpMethod": "POST",
- "description": "Returns a list of authorized public keys for a specific user account.",
- "parameters": {
- "instance": {
- "type": "string",
- "description": "The fully-qualified URL of the virtual machine requesting the view.",
- "required": true,
- "location": "query"
- },
- "login": {
- "type": "boolean",
- "description": "Whether the view was requested as part of a user-initiated login.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "user": {
- "type": "string",
- "description": "The user account for which you want to get a list of authorized public keys.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "user",
- "instance"
- ],
- "response": {
- "$ref": "LinuxGetAuthorizedKeysViewResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "getLinuxAccountViews": {
- "id": "clouduseraccounts.linux.getLinuxAccountViews",
- "path": "{project}/zones/{zone}/linuxAccountViews",
- "httpMethod": "POST",
- "description": "Retrieves a list of user accounts for an instance within a specific project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "instance": {
- "type": "string",
- "description": "The fully-qualified URL of the virtual machine requesting the views.",
- "required": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "response": {
- "$ref": "LinuxGetLinuxAccountViewsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- }
- }
- },
- "users": {
- "methods": {
- "addPublicKey": {
- "id": "clouduseraccounts.users.addPublicKey",
- "path": "{project}/global/users/{user}/addPublicKey",
- "httpMethod": "POST",
- "description": "Adds a public key to the specified User resource with the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "user": {
- "type": "string",
- "description": "Name of the user for this request.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "user"
- ],
- "request": {
- "$ref": "PublicKey"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "delete": {
- "id": "clouduseraccounts.users.delete",
- "path": "{project}/global/users/{user}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified User resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "user": {
- "type": "string",
- "description": "Name of the user resource to delete.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "user"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "get": {
- "id": "clouduseraccounts.users.get",
- "path": "{project}/global/users/{user}",
- "httpMethod": "GET",
- "description": "Returns the specified User resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "user": {
- "type": "string",
- "description": "Name of the user resource to return.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "user"
- ],
- "response": {
- "$ref": "User"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "insert": {
- "id": "clouduseraccounts.users.insert",
- "path": "{project}/global/users",
- "httpMethod": "POST",
- "description": "Creates a User resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "User"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "list": {
- "id": "clouduseraccounts.users.list",
- "path": "{project}/global/users",
- "httpMethod": "GET",
- "description": "Retrieves a list of users contained within the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "UserList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "removePublicKey": {
- "id": "clouduseraccounts.users.removePublicKey",
- "path": "{project}/global/users/{user}/removePublicKey",
- "httpMethod": "POST",
- "description": "Removes the specified public key from the user.",
- "parameters": {
- "fingerprint": {
- "type": "string",
- "description": "The fingerprint of the public key to delete. Public keys are identified by their fingerprint, which is defined by RFC4716 to be the MD5 digest of the public key.",
- "required": true,
- "pattern": "[a-f0-9]{32}",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "user": {
- "type": "string",
- "description": "Name of the user for this request.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "user",
- "fingerprint"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/clouduseraccounts/v0.beta/clouduseraccounts-gen.go b/vendor/google.golang.org/api/clouduseraccounts/v0.beta/clouduseraccounts-gen.go
deleted file mode 100644
index 9dd8f887..00000000
--- a/vendor/google.golang.org/api/clouduseraccounts/v0.beta/clouduseraccounts-gen.go
+++ /dev/null
@@ -1,3451 +0,0 @@
-// Package clouduseraccounts provides access to the Cloud User Accounts API.
-//
-// See https://cloud.google.com/compute/docs/access/user-accounts/api/latest/
-//
-// Usage example:
-//
-// import "google.golang.org/api/clouduseraccounts/v0.beta"
-// ...
-// clouduseraccountsService, err := clouduseraccounts.New(oauthHttpClient)
-package clouduseraccounts // import "google.golang.org/api/clouduseraccounts/v0.beta"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "clouduseraccounts:beta"
-const apiName = "clouduseraccounts"
-const apiVersion = "beta"
-const basePath = "https://www.googleapis.com/clouduseraccounts/beta/projects/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your data across Google Cloud Platform services
- CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
-
- // View your data across Google Cloud Platform services
- CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"
-
- // Manage your Google Cloud User Accounts
- CloudUseraccountsScope = "https://www.googleapis.com/auth/cloud.useraccounts"
-
- // View your Google Cloud User Accounts
- CloudUseraccountsReadonlyScope = "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.GlobalAccountsOperations = NewGlobalAccountsOperationsService(s)
- s.Groups = NewGroupsService(s)
- s.Linux = NewLinuxService(s)
- s.Users = NewUsersService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- GlobalAccountsOperations *GlobalAccountsOperationsService
-
- Groups *GroupsService
-
- Linux *LinuxService
-
- Users *UsersService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewGlobalAccountsOperationsService(s *Service) *GlobalAccountsOperationsService {
- rs := &GlobalAccountsOperationsService{s: s}
- return rs
-}
-
-type GlobalAccountsOperationsService struct {
- s *Service
-}
-
-func NewGroupsService(s *Service) *GroupsService {
- rs := &GroupsService{s: s}
- return rs
-}
-
-type GroupsService struct {
- s *Service
-}
-
-func NewLinuxService(s *Service) *LinuxService {
- rs := &LinuxService{s: s}
- return rs
-}
-
-type LinuxService struct {
- s *Service
-}
-
-func NewUsersService(s *Service) *UsersService {
- rs := &UsersService{s: s}
- return rs
-}
-
-type UsersService struct {
- s *Service
-}
-
-// AuthorizedKeysView: A list of authorized public keys for a user
-// account.
-type AuthorizedKeysView struct {
- // Keys: [Output Only] The list of authorized public keys in SSH format.
- Keys []string `json:"keys,omitempty"`
-
- // Sudoer: [Output Only] Whether the user has the ability to elevate on
- // the instance that requested the authorized keys.
- Sudoer bool `json:"sudoer,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Keys") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AuthorizedKeysView) MarshalJSON() ([]byte, error) {
- type noMethod AuthorizedKeysView
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Group: A Group resource.
-type Group struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always
- // clouduseraccounts#group for groups.
- Kind string `json:"kind,omitempty"`
-
- // Members: [Output Only] A list of URLs to User resources who belong to
- // the group. Users may only be members of groups in the same project.
- Members []string `json:"members,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created.
- Name string `json:"name,omitempty"`
-
- // SelfLink: [Output Only] Server defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Group) MarshalJSON() ([]byte, error) {
- type noMethod Group
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GroupList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of Group resources.
- Items []*Group `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always
- // clouduseraccounts#groupList for lists of groups.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GroupList) MarshalJSON() ([]byte, error) {
- type noMethod GroupList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GroupsAddMemberRequest struct {
- // Users: Fully-qualified URLs of the User resources to add.
- Users []string `json:"users,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Users") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GroupsAddMemberRequest) MarshalJSON() ([]byte, error) {
- type noMethod GroupsAddMemberRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GroupsRemoveMemberRequest struct {
- // Users: Fully-qualified URLs of the User resources to remove.
- Users []string `json:"users,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Users") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GroupsRemoveMemberRequest) MarshalJSON() ([]byte, error) {
- type noMethod GroupsRemoveMemberRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LinuxAccountViews: A list of all Linux accounts for this project.
-// This API is only used by Compute Engine virtual machines to get
-// information about user accounts for a project or instance. Linux
-// resources are read-only views into users and groups managed by the
-// Compute Engine Accounts API.
-type LinuxAccountViews struct {
- // GroupViews: [Output Only] A list of all groups within a project.
- GroupViews []*LinuxGroupView `json:"groupViews,omitempty"`
-
- // Kind: [Output Only] Type of the resource. Always
- // clouduseraccounts#linuxAccountViews for Linux resources.
- Kind string `json:"kind,omitempty"`
-
- // UserViews: [Output Only] A list of all users within a project.
- UserViews []*LinuxUserView `json:"userViews,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "GroupViews") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LinuxAccountViews) MarshalJSON() ([]byte, error) {
- type noMethod LinuxAccountViews
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type LinuxGetAuthorizedKeysViewResponse struct {
- // Resource: [Output Only] A list of authorized public keys for a user.
- Resource *AuthorizedKeysView `json:"resource,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Resource") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LinuxGetAuthorizedKeysViewResponse) MarshalJSON() ([]byte, error) {
- type noMethod LinuxGetAuthorizedKeysViewResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type LinuxGetLinuxAccountViewsResponse struct {
- // Resource: [Output Only] A list of authorized user accounts and
- // groups.
- Resource *LinuxAccountViews `json:"resource,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Resource") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LinuxGetLinuxAccountViewsResponse) MarshalJSON() ([]byte, error) {
- type noMethod LinuxGetLinuxAccountViewsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LinuxGroupView: A detailed view of a Linux group.
-type LinuxGroupView struct {
- // Gid: [Output Only] The Group ID.
- Gid int64 `json:"gid,omitempty"`
-
- // GroupName: [Output Only] Group name.
- GroupName string `json:"groupName,omitempty"`
-
- // Members: [Output Only] List of user accounts that belong to the
- // group.
- Members []string `json:"members,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Gid") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LinuxGroupView) MarshalJSON() ([]byte, error) {
- type noMethod LinuxGroupView
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LinuxUserView: A detailed view of a Linux user account.
-type LinuxUserView struct {
- // Gecos: [Output Only] The GECOS (user information) entry for this
- // account.
- Gecos string `json:"gecos,omitempty"`
-
- // Gid: [Output Only] User's default group ID.
- Gid int64 `json:"gid,omitempty"`
-
- // HomeDirectory: [Output Only] The path to the home directory for this
- // account.
- HomeDirectory string `json:"homeDirectory,omitempty"`
-
- // Shell: [Output Only] The path to the login shell for this account.
- Shell string `json:"shell,omitempty"`
-
- // Uid: [Output Only] User ID.
- Uid int64 `json:"uid,omitempty"`
-
- // Username: [Output Only] The username of the account.
- Username string `json:"username,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Gecos") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LinuxUserView) MarshalJSON() ([]byte, error) {
- type noMethod LinuxUserView
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Operation: An Operation resource, used to manage asynchronous API
-// requests.
-type Operation struct {
- // ClientOperationId: [Output Only] An optional identifier specified by
- // the client when the mutation was initiated. Must be unique for all
- // Operation resources in the project.
- ClientOperationId string `json:"clientOperationId,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // EndTime: [Output Only] The time that this operation was completed.
- // This is in RFC3339 text format.
- EndTime string `json:"endTime,omitempty"`
-
- // Error: [Output Only] If errors are generated during processing of the
- // operation, this field will be populated.
- Error *OperationError `json:"error,omitempty"`
-
- // HttpErrorMessage: [Output Only] If the operation fails, this field
- // contains the HTTP error message that was returned, such as NOT FOUND.
- HttpErrorMessage string `json:"httpErrorMessage,omitempty"`
-
- // HttpErrorStatusCode: [Output Only] If the operation fails, this field
- // contains the HTTP error message that was returned, such as 404.
- HttpErrorStatusCode int64 `json:"httpErrorStatusCode,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // InsertTime: [Output Only] The time that this operation was requested.
- // This is in RFC3339 text format.
- InsertTime string `json:"insertTime,omitempty"`
-
- // Kind: [Output Only] Type of the resource. Always compute#operation
- // for Operation resources.
- Kind string `json:"kind,omitempty"`
-
- // Name: [Output Only] Name of the resource.
- Name string `json:"name,omitempty"`
-
- // OperationType: [Output Only] Type of the operation, such as insert,
- // compute.instanceGroups.update, or compute.instanceGroups.delete.
- OperationType string `json:"operationType,omitempty"`
-
- // Progress: [Output Only] An optional progress indicator that ranges
- // from 0 to 100. There is no requirement that this be linear or support
- // any granularity of operations. This should not be used to guess at
- // when the operation will be complete. This number should monotonically
- // increase as the operation progresses.
- Progress int64 `json:"progress,omitempty"`
-
- // Region: [Output Only] URL of the region where the operation resides.
- // Only applicable for regional resources.
- Region string `json:"region,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // StartTime: [Output Only] The time that this operation was started by
- // the server. This is in RFC3339 text format.
- StartTime string `json:"startTime,omitempty"`
-
- // Status: [Output Only] Status of the operation. Can be one of the
- // following: PENDING, RUNNING, or DONE.
- //
- // Possible values:
- // "DONE"
- // "PENDING"
- // "RUNNING"
- Status string `json:"status,omitempty"`
-
- // StatusMessage: [Output Only] An optional textual description of the
- // current status of the operation.
- StatusMessage string `json:"statusMessage,omitempty"`
-
- // TargetId: [Output Only] Unique target ID which identifies a
- // particular incarnation of the target.
- TargetId uint64 `json:"targetId,omitempty,string"`
-
- // TargetLink: [Output Only] URL of the resource the operation is
- // mutating.
- TargetLink string `json:"targetLink,omitempty"`
-
- // User: [Output Only] User who requested the operation, for example:
- // user@example.com.
- User string `json:"user,omitempty"`
-
- // Warnings: [Output Only] If warning messages are generated during
- // processing of the operation, this field will be populated.
- Warnings []*OperationWarnings `json:"warnings,omitempty"`
-
- // Zone: [Output Only] URL of the zone where the operation resides.
- Zone string `json:"zone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ClientOperationId")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Operation) MarshalJSON() ([]byte, error) {
- type noMethod Operation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperationError: [Output Only] If errors are generated during
-// processing of the operation, this field will be populated.
-type OperationError struct {
- // Errors: [Output Only] The array of errors encountered while
- // processing this operation.
- Errors []*OperationErrorErrors `json:"errors,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Errors") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationError) MarshalJSON() ([]byte, error) {
- type noMethod OperationError
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationErrorErrors struct {
- // Code: [Output Only] The error type identifier for this error.
- Code string `json:"code,omitempty"`
-
- // Location: [Output Only] Indicates the field in the request which
- // caused the error. This property is optional.
- Location string `json:"location,omitempty"`
-
- // Message: [Output Only] An optional, human-readable error message.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationErrorErrors) MarshalJSON() ([]byte, error) {
- type noMethod OperationErrorErrors
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationWarnings struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*OperationWarningsData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationWarnings) MarshalJSON() ([]byte, error) {
- type noMethod OperationWarnings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationWarningsData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationWarningsData) MarshalJSON() ([]byte, error) {
- type noMethod OperationWarningsData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperationList: Contains a list of Operation resources.
-type OperationList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] The Operation resources.
- Items []*Operation `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#operations for
- // Operations resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncate.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationList) MarshalJSON() ([]byte, error) {
- type noMethod OperationList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PublicKey: A public key for authenticating to guests.
-type PublicKey struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // ExpirationTimestamp: Optional expiration timestamp. If provided, the
- // timestamp must be in RFC3339 text format. If not provided, the public
- // key never expires.
- ExpirationTimestamp string `json:"expirationTimestamp,omitempty"`
-
- // Fingerprint: [Output Only] The fingerprint of the key is defined by
- // RFC4716 to be the MD5 digest of the public key.
- Fingerprint string `json:"fingerprint,omitempty"`
-
- // Key: Public key text in SSH format, defined by RFC4253 section 6.6.
- Key string `json:"key,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PublicKey) MarshalJSON() ([]byte, error) {
- type noMethod PublicKey
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// User: A User resource.
-type User struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Groups: [Output Only] A list of URLs to Group resources who contain
- // the user. Users are only members of groups in the same project.
- Groups []string `json:"groups,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always
- // clouduseraccounts#user for users.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created.
- Name string `json:"name,omitempty"`
-
- // Owner: Email address of account's owner. This account will be
- // validated to make sure it exists. The email can belong to any domain,
- // but it must be tied to a Google account.
- Owner string `json:"owner,omitempty"`
-
- // PublicKeys: [Output Only] Public keys that this user may use to
- // login.
- PublicKeys []*PublicKey `json:"publicKeys,omitempty"`
-
- // SelfLink: [Output Only] Server defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *User) MarshalJSON() ([]byte, error) {
- type noMethod User
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UserList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of User resources.
- Items []*User `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always
- // clouduseraccounts#userList for lists of users.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserList) MarshalJSON() ([]byte, error) {
- type noMethod UserList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "clouduseraccounts.globalAccountsOperations.delete":
-
-type GlobalAccountsOperationsDeleteCall struct {
- s *Service
- project string
- operation string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified operation resource.
-func (r *GlobalAccountsOperationsService) Delete(project string, operation string) *GlobalAccountsOperationsDeleteCall {
- c := &GlobalAccountsOperationsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.operation = operation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalAccountsOperationsDeleteCall) Fields(s ...googleapi.Field) *GlobalAccountsOperationsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalAccountsOperationsDeleteCall) Context(ctx context.Context) *GlobalAccountsOperationsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalAccountsOperationsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/operations/{operation}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "operation": c.operation,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.globalAccountsOperations.delete" call.
-func (c *GlobalAccountsOperationsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes the specified operation resource.",
- // "httpMethod": "DELETE",
- // "id": "clouduseraccounts.globalAccountsOperations.delete",
- // "parameterOrder": [
- // "project",
- // "operation"
- // ],
- // "parameters": {
- // "operation": {
- // "description": "Name of the Operations resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/operations/{operation}",
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.globalAccountsOperations.get":
-
-type GlobalAccountsOperationsGetCall struct {
- s *Service
- project string
- operation string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves the specified operation resource.
-func (r *GlobalAccountsOperationsService) Get(project string, operation string) *GlobalAccountsOperationsGetCall {
- c := &GlobalAccountsOperationsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.operation = operation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalAccountsOperationsGetCall) Fields(s ...googleapi.Field) *GlobalAccountsOperationsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GlobalAccountsOperationsGetCall) IfNoneMatch(entityTag string) *GlobalAccountsOperationsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalAccountsOperationsGetCall) Context(ctx context.Context) *GlobalAccountsOperationsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalAccountsOperationsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/operations/{operation}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "operation": c.operation,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.globalAccountsOperations.get" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GlobalAccountsOperationsGetCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the specified operation resource.",
- // "httpMethod": "GET",
- // "id": "clouduseraccounts.globalAccountsOperations.get",
- // "parameterOrder": [
- // "project",
- // "operation"
- // ],
- // "parameters": {
- // "operation": {
- // "description": "Name of the Operations resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/operations/{operation}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.globalAccountsOperations.list":
-
-type GlobalAccountsOperationsListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of operation resources contained within the
-// specified project.
-func (r *GlobalAccountsOperationsService) List(project string) *GlobalAccountsOperationsListCall {
- c := &GlobalAccountsOperationsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *GlobalAccountsOperationsListCall) Filter(filter string) *GlobalAccountsOperationsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *GlobalAccountsOperationsListCall) MaxResults(maxResults int64) *GlobalAccountsOperationsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *GlobalAccountsOperationsListCall) OrderBy(orderBy string) *GlobalAccountsOperationsListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *GlobalAccountsOperationsListCall) PageToken(pageToken string) *GlobalAccountsOperationsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalAccountsOperationsListCall) Fields(s ...googleapi.Field) *GlobalAccountsOperationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GlobalAccountsOperationsListCall) IfNoneMatch(entityTag string) *GlobalAccountsOperationsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalAccountsOperationsListCall) Context(ctx context.Context) *GlobalAccountsOperationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalAccountsOperationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/operations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.globalAccountsOperations.list" call.
-// Exactly one of *OperationList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *OperationList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *GlobalAccountsOperationsListCall) Do() (*OperationList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OperationList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of operation resources contained within the specified project.",
- // "httpMethod": "GET",
- // "id": "clouduseraccounts.globalAccountsOperations.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/operations",
- // "response": {
- // "$ref": "OperationList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.addMember":
-
-type GroupsAddMemberCall struct {
- s *Service
- project string
- groupName string
- groupsaddmemberrequest *GroupsAddMemberRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AddMember: Adds users to the specified group.
-func (r *GroupsService) AddMember(project string, groupName string, groupsaddmemberrequest *GroupsAddMemberRequest) *GroupsAddMemberCall {
- c := &GroupsAddMemberCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.groupName = groupName
- c.groupsaddmemberrequest = groupsaddmemberrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsAddMemberCall) Fields(s ...googleapi.Field) *GroupsAddMemberCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsAddMemberCall) Context(ctx context.Context) *GroupsAddMemberCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsAddMemberCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.groupsaddmemberrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups/{groupName}/addMember")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "groupName": c.groupName,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.addMember" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GroupsAddMemberCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Adds users to the specified group.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.groups.addMember",
- // "parameterOrder": [
- // "project",
- // "groupName"
- // ],
- // "parameters": {
- // "groupName": {
- // "description": "Name of the group for this request.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups/{groupName}/addMember",
- // "request": {
- // "$ref": "GroupsAddMemberRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.delete":
-
-type GroupsDeleteCall struct {
- s *Service
- project string
- groupName string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified Group resource.
-func (r *GroupsService) Delete(project string, groupName string) *GroupsDeleteCall {
- c := &GroupsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.groupName = groupName
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsDeleteCall) Fields(s ...googleapi.Field) *GroupsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsDeleteCall) Context(ctx context.Context) *GroupsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups/{groupName}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "groupName": c.groupName,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GroupsDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified Group resource.",
- // "httpMethod": "DELETE",
- // "id": "clouduseraccounts.groups.delete",
- // "parameterOrder": [
- // "project",
- // "groupName"
- // ],
- // "parameters": {
- // "groupName": {
- // "description": "Name of the Group resource to delete.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups/{groupName}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.get":
-
-type GroupsGetCall struct {
- s *Service
- project string
- groupName string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified Group resource.
-func (r *GroupsService) Get(project string, groupName string) *GroupsGetCall {
- c := &GroupsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.groupName = groupName
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsGetCall) Fields(s ...googleapi.Field) *GroupsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GroupsGetCall) IfNoneMatch(entityTag string) *GroupsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsGetCall) Context(ctx context.Context) *GroupsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups/{groupName}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "groupName": c.groupName,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.get" call.
-// Exactly one of *Group or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Group.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *GroupsGetCall) Do() (*Group, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Group{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified Group resource.",
- // "httpMethod": "GET",
- // "id": "clouduseraccounts.groups.get",
- // "parameterOrder": [
- // "project",
- // "groupName"
- // ],
- // "parameters": {
- // "groupName": {
- // "description": "Name of the Group resource to return.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups/{groupName}",
- // "response": {
- // "$ref": "Group"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.insert":
-
-type GroupsInsertCall struct {
- s *Service
- project string
- group *Group
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a Group resource in the specified project using the
-// data included in the request.
-func (r *GroupsService) Insert(project string, group *Group) *GroupsInsertCall {
- c := &GroupsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.group = group
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsInsertCall) Fields(s ...googleapi.Field) *GroupsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsInsertCall) Context(ctx context.Context) *GroupsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.group)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GroupsInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a Group resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.groups.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups",
- // "request": {
- // "$ref": "Group"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.list":
-
-type GroupsListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of groups contained within the specified
-// project.
-func (r *GroupsService) List(project string) *GroupsListCall {
- c := &GroupsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *GroupsListCall) Filter(filter string) *GroupsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *GroupsListCall) MaxResults(maxResults int64) *GroupsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *GroupsListCall) OrderBy(orderBy string) *GroupsListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *GroupsListCall) PageToken(pageToken string) *GroupsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsListCall) Fields(s ...googleapi.Field) *GroupsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GroupsListCall) IfNoneMatch(entityTag string) *GroupsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsListCall) Context(ctx context.Context) *GroupsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.list" call.
-// Exactly one of *GroupList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *GroupList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GroupsListCall) Do() (*GroupList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &GroupList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of groups contained within the specified project.",
- // "httpMethod": "GET",
- // "id": "clouduseraccounts.groups.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups",
- // "response": {
- // "$ref": "GroupList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.removeMember":
-
-type GroupsRemoveMemberCall struct {
- s *Service
- project string
- groupName string
- groupsremovememberrequest *GroupsRemoveMemberRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// RemoveMember: Removes users from the specified group.
-func (r *GroupsService) RemoveMember(project string, groupName string, groupsremovememberrequest *GroupsRemoveMemberRequest) *GroupsRemoveMemberCall {
- c := &GroupsRemoveMemberCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.groupName = groupName
- c.groupsremovememberrequest = groupsremovememberrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsRemoveMemberCall) Fields(s ...googleapi.Field) *GroupsRemoveMemberCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsRemoveMemberCall) Context(ctx context.Context) *GroupsRemoveMemberCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsRemoveMemberCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.groupsremovememberrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups/{groupName}/removeMember")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "groupName": c.groupName,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.removeMember" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GroupsRemoveMemberCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Removes users from the specified group.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.groups.removeMember",
- // "parameterOrder": [
- // "project",
- // "groupName"
- // ],
- // "parameters": {
- // "groupName": {
- // "description": "Name of the group for this request.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups/{groupName}/removeMember",
- // "request": {
- // "$ref": "GroupsRemoveMemberRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.linux.getAuthorizedKeysView":
-
-type LinuxGetAuthorizedKeysViewCall struct {
- s *Service
- project string
- zone string
- user string
- instance string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetAuthorizedKeysView: Returns a list of authorized public keys for a
-// specific user account.
-func (r *LinuxService) GetAuthorizedKeysView(project string, zone string, user string, instance string) *LinuxGetAuthorizedKeysViewCall {
- c := &LinuxGetAuthorizedKeysViewCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.user = user
- c.instance = instance
- return c
-}
-
-// Login sets the optional parameter "login": Whether the view was
-// requested as part of a user-initiated login.
-func (c *LinuxGetAuthorizedKeysViewCall) Login(login bool) *LinuxGetAuthorizedKeysViewCall {
- c.opt_["login"] = login
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LinuxGetAuthorizedKeysViewCall) Fields(s ...googleapi.Field) *LinuxGetAuthorizedKeysViewCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LinuxGetAuthorizedKeysViewCall) Context(ctx context.Context) *LinuxGetAuthorizedKeysViewCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LinuxGetAuthorizedKeysViewCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("instance", fmt.Sprintf("%v", c.instance))
- if v, ok := c.opt_["login"]; ok {
- params.Set("login", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/authorizedKeysView/{user}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "user": c.user,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.linux.getAuthorizedKeysView" call.
-// Exactly one of *LinuxGetAuthorizedKeysViewResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *LinuxGetAuthorizedKeysViewResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *LinuxGetAuthorizedKeysViewCall) Do() (*LinuxGetAuthorizedKeysViewResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &LinuxGetAuthorizedKeysViewResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns a list of authorized public keys for a specific user account.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.linux.getAuthorizedKeysView",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "user",
- // "instance"
- // ],
- // "parameters": {
- // "instance": {
- // "description": "The fully-qualified URL of the virtual machine requesting the view.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "login": {
- // "description": "Whether the view was requested as part of a user-initiated login.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "user": {
- // "description": "The user account for which you want to get a list of authorized public keys.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/authorizedKeysView/{user}",
- // "response": {
- // "$ref": "LinuxGetAuthorizedKeysViewResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.linux.getLinuxAccountViews":
-
-type LinuxGetLinuxAccountViewsCall struct {
- s *Service
- project string
- zone string
- instance string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetLinuxAccountViews: Retrieves a list of user accounts for an
-// instance within a specific project.
-func (r *LinuxService) GetLinuxAccountViews(project string, zone string, instance string) *LinuxGetLinuxAccountViewsCall {
- c := &LinuxGetLinuxAccountViewsCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *LinuxGetLinuxAccountViewsCall) Filter(filter string) *LinuxGetLinuxAccountViewsCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *LinuxGetLinuxAccountViewsCall) MaxResults(maxResults int64) *LinuxGetLinuxAccountViewsCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *LinuxGetLinuxAccountViewsCall) OrderBy(orderBy string) *LinuxGetLinuxAccountViewsCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *LinuxGetLinuxAccountViewsCall) PageToken(pageToken string) *LinuxGetLinuxAccountViewsCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LinuxGetLinuxAccountViewsCall) Fields(s ...googleapi.Field) *LinuxGetLinuxAccountViewsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LinuxGetLinuxAccountViewsCall) Context(ctx context.Context) *LinuxGetLinuxAccountViewsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LinuxGetLinuxAccountViewsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("instance", fmt.Sprintf("%v", c.instance))
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/linuxAccountViews")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.linux.getLinuxAccountViews" call.
-// Exactly one of *LinuxGetLinuxAccountViewsResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *LinuxGetLinuxAccountViewsResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *LinuxGetLinuxAccountViewsCall) Do() (*LinuxGetLinuxAccountViewsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &LinuxGetLinuxAccountViewsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of user accounts for an instance within a specific project.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.linux.getLinuxAccountViews",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "instance": {
- // "description": "The fully-qualified URL of the virtual machine requesting the views.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/linuxAccountViews",
- // "response": {
- // "$ref": "LinuxGetLinuxAccountViewsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.addPublicKey":
-
-type UsersAddPublicKeyCall struct {
- s *Service
- project string
- user string
- publickey *PublicKey
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AddPublicKey: Adds a public key to the specified User resource with
-// the data included in the request.
-func (r *UsersService) AddPublicKey(project string, user string, publickey *PublicKey) *UsersAddPublicKeyCall {
- c := &UsersAddPublicKeyCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.user = user
- c.publickey = publickey
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersAddPublicKeyCall) Fields(s ...googleapi.Field) *UsersAddPublicKeyCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersAddPublicKeyCall) Context(ctx context.Context) *UsersAddPublicKeyCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersAddPublicKeyCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.publickey)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users/{user}/addPublicKey")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "user": c.user,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.addPublicKey" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UsersAddPublicKeyCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Adds a public key to the specified User resource with the data included in the request.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.users.addPublicKey",
- // "parameterOrder": [
- // "project",
- // "user"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "user": {
- // "description": "Name of the user for this request.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users/{user}/addPublicKey",
- // "request": {
- // "$ref": "PublicKey"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.delete":
-
-type UsersDeleteCall struct {
- s *Service
- project string
- user string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified User resource.
-func (r *UsersService) Delete(project string, user string) *UsersDeleteCall {
- c := &UsersDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.user = user
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersDeleteCall) Fields(s ...googleapi.Field) *UsersDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersDeleteCall) Context(ctx context.Context) *UsersDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users/{user}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "user": c.user,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UsersDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified User resource.",
- // "httpMethod": "DELETE",
- // "id": "clouduseraccounts.users.delete",
- // "parameterOrder": [
- // "project",
- // "user"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "user": {
- // "description": "Name of the user resource to delete.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users/{user}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.get":
-
-type UsersGetCall struct {
- s *Service
- project string
- user string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified User resource.
-func (r *UsersService) Get(project string, user string) *UsersGetCall {
- c := &UsersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.user = user
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersGetCall) Fields(s ...googleapi.Field) *UsersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UsersGetCall) IfNoneMatch(entityTag string) *UsersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersGetCall) Context(ctx context.Context) *UsersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users/{user}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "user": c.user,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.get" call.
-// Exactly one of *User or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *User.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *UsersGetCall) Do() (*User, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &User{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified User resource.",
- // "httpMethod": "GET",
- // "id": "clouduseraccounts.users.get",
- // "parameterOrder": [
- // "project",
- // "user"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "user": {
- // "description": "Name of the user resource to return.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users/{user}",
- // "response": {
- // "$ref": "User"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.insert":
-
-type UsersInsertCall struct {
- s *Service
- project string
- user *User
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a User resource in the specified project using the
-// data included in the request.
-func (r *UsersService) Insert(project string, user *User) *UsersInsertCall {
- c := &UsersInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.user = user
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersInsertCall) Fields(s ...googleapi.Field) *UsersInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersInsertCall) Context(ctx context.Context) *UsersInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.user)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UsersInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a User resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.users.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users",
- // "request": {
- // "$ref": "User"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.list":
-
-type UsersListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of users contained within the specified
-// project.
-func (r *UsersService) List(project string) *UsersListCall {
- c := &UsersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *UsersListCall) Filter(filter string) *UsersListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *UsersListCall) MaxResults(maxResults int64) *UsersListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *UsersListCall) OrderBy(orderBy string) *UsersListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *UsersListCall) PageToken(pageToken string) *UsersListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersListCall) Fields(s ...googleapi.Field) *UsersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UsersListCall) IfNoneMatch(entityTag string) *UsersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersListCall) Context(ctx context.Context) *UsersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.list" call.
-// Exactly one of *UserList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *UserList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UsersListCall) Do() (*UserList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of users contained within the specified project.",
- // "httpMethod": "GET",
- // "id": "clouduseraccounts.users.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users",
- // "response": {
- // "$ref": "UserList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.removePublicKey":
-
-type UsersRemovePublicKeyCall struct {
- s *Service
- project string
- user string
- fingerprint string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// RemovePublicKey: Removes the specified public key from the user.
-func (r *UsersService) RemovePublicKey(project string, user string, fingerprint string) *UsersRemovePublicKeyCall {
- c := &UsersRemovePublicKeyCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.user = user
- c.fingerprint = fingerprint
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersRemovePublicKeyCall) Fields(s ...googleapi.Field) *UsersRemovePublicKeyCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersRemovePublicKeyCall) Context(ctx context.Context) *UsersRemovePublicKeyCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersRemovePublicKeyCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("fingerprint", fmt.Sprintf("%v", c.fingerprint))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users/{user}/removePublicKey")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "user": c.user,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.removePublicKey" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UsersRemovePublicKeyCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Removes the specified public key from the user.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.users.removePublicKey",
- // "parameterOrder": [
- // "project",
- // "user",
- // "fingerprint"
- // ],
- // "parameters": {
- // "fingerprint": {
- // "description": "The fingerprint of the public key to delete. Public keys are identified by their fingerprint, which is defined by RFC4716 to be the MD5 digest of the public key.",
- // "location": "query",
- // "pattern": "[a-f0-9]{32}",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "user": {
- // "description": "Name of the user for this request.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users/{user}/removePublicKey",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/clouduseraccounts/vm_alpha/clouduseraccounts-api.json b/vendor/google.golang.org/api/clouduseraccounts/vm_alpha/clouduseraccounts-api.json
deleted file mode 100644
index c714973a..00000000
--- a/vendor/google.golang.org/api/clouduseraccounts/vm_alpha/clouduseraccounts-api.json
+++ /dev/null
@@ -1,1818 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/5nMv6T9tApKbBeNZEQlnf4XjGl0\"",
- "discoveryVersion": "v1",
- "id": "clouduseraccounts:vm_alpha",
- "name": "clouduseraccounts",
- "canonicalName": "Cloud User Accounts",
- "version": "vm_alpha",
- "revision": "20150917",
- "title": "Cloud User Accounts API",
- "description": "API for the Google Cloud User Accounts service.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/compute_engine-16.png",
- "x32": "https://www.google.com/images/icons/product/compute_engine-32.png"
- },
- "documentationLink": "https://cloud.google.com/compute/docs/access/user-accounts/api/latest/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/clouduseraccounts/vm_alpha/projects/",
- "basePath": "/clouduseraccounts/vm_alpha/projects/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "clouduseraccounts/vm_alpha/projects/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud.useraccounts": {
- "description": "Manage your Google Cloud User Accounts"
- },
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly": {
- "description": "View your Google Cloud User Accounts"
- }
- }
- }
- },
- "schemas": {
- "AuthorizedKeysView": {
- "id": "AuthorizedKeysView",
- "type": "object",
- "description": "A list of authorized public keys for a user account.",
- "properties": {
- "keys": {
- "type": "array",
- "description": "[Output Only] The list of authorized public keys in SSH format.",
- "items": {
- "type": "string"
- }
- },
- "sudoer": {
- "type": "boolean",
- "description": "[Output Only] Whether the user has the ability to elevate on the instance that requested the authorized keys."
- }
- }
- },
- "Binding": {
- "id": "Binding",
- "type": "object",
- "description": "Associates `members` with a `role`.",
- "properties": {
- "members": {
- "type": "array",
- "description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following formats:\n\n* `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.\n\n* `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.\n\n* `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.",
- "items": {
- "type": "string"
- }
- },
- "role": {
- "type": "string",
- "description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`."
- }
- }
- },
- "Condition": {
- "id": "Condition",
- "type": "object",
- "description": "A condition to be met.",
- "properties": {
- "iam": {
- "type": "string",
- "description": "Trusted attributes supplied by the IAM system.",
- "enum": [
- "ATTRIBUTION",
- "AUTHORITY",
- "NO_ATTR"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "op": {
- "type": "string",
- "description": "An operator to apply the subject with.",
- "enum": [
- "DISCHARGED",
- "EQUALS",
- "IN",
- "NOT_EQUALS",
- "NOT_IN",
- "NO_OP"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "svc": {
- "type": "string",
- "description": "Trusted attributes discharged by the service."
- },
- "sys": {
- "type": "string",
- "description": "Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.",
- "enum": [
- "IP",
- "NAME",
- "NO_ATTR",
- "REGION",
- "SERVICE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "value": {
- "type": "string",
- "description": "The object of the condition. Exactly one of these must be set."
- },
- "values": {
- "type": "array",
- "description": "The objects of the condition. This is mutually exclusive with 'value'.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "Group": {
- "id": "Group",
- "type": "object",
- "description": "A Group resource.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always clouduseraccounts#group for groups.",
- "default": "clouduseraccounts#group"
- },
- "members": {
- "type": "array",
- "description": "[Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.",
- "items": {
- "type": "string"
- }
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created.",
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "annotations": {
- "required": [
- "clouduseraccounts.groups.insert"
- ]
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server defined URL for the resource."
- }
- }
- },
- "GroupList": {
- "id": "GroupList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of Group resources.",
- "items": {
- "$ref": "Group"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always clouduseraccounts#groupList for lists of groups.",
- "default": "clouduseraccounts#groupList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server defined URL for this resource."
- }
- }
- },
- "GroupsAddMemberRequest": {
- "id": "GroupsAddMemberRequest",
- "type": "object",
- "properties": {
- "users": {
- "type": "array",
- "description": "Fully-qualified URLs of the User resources to add.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "GroupsRemoveMemberRequest": {
- "id": "GroupsRemoveMemberRequest",
- "type": "object",
- "properties": {
- "users": {
- "type": "array",
- "description": "Fully-qualified URLs of the User resources to remove.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "LinuxAccountViews": {
- "id": "LinuxAccountViews",
- "type": "object",
- "description": "A list of all Linux accounts for this project. This API is only used by Compute Engine virtual machines to get information about user accounts for a project or instance. Linux resources are read-only views into users and groups managed by the Compute Engine Accounts API.",
- "properties": {
- "groupViews": {
- "type": "array",
- "description": "[Output Only] A list of all groups within a project.",
- "items": {
- "$ref": "LinuxGroupView"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always clouduseraccounts#linuxAccountViews for Linux resources.",
- "default": "clouduseraccounts#linuxAccountViews"
- },
- "userViews": {
- "type": "array",
- "description": "[Output Only] A list of all users within a project.",
- "items": {
- "$ref": "LinuxUserView"
- }
- }
- }
- },
- "LinuxGetAuthorizedKeysViewResponse": {
- "id": "LinuxGetAuthorizedKeysViewResponse",
- "type": "object",
- "properties": {
- "resource": {
- "$ref": "AuthorizedKeysView",
- "description": "[Output Only] A list of authorized public keys for a user."
- }
- }
- },
- "LinuxGetLinuxAccountViewsResponse": {
- "id": "LinuxGetLinuxAccountViewsResponse",
- "type": "object",
- "properties": {
- "resource": {
- "$ref": "LinuxAccountViews",
- "description": "[Output Only] A list of authorized user accounts and groups."
- }
- }
- },
- "LinuxGroupView": {
- "id": "LinuxGroupView",
- "type": "object",
- "description": "A detailed view of a Linux group.",
- "properties": {
- "gid": {
- "type": "integer",
- "description": "[Output Only] The Group ID.",
- "format": "uint32"
- },
- "groupName": {
- "type": "string",
- "description": "[Output Only] Group name."
- },
- "members": {
- "type": "array",
- "description": "[Output Only] List of user accounts that belong to the group.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "LinuxUserView": {
- "id": "LinuxUserView",
- "type": "object",
- "description": "A detailed view of a Linux user account.",
- "properties": {
- "gecos": {
- "type": "string",
- "description": "[Output Only] The GECOS (user information) entry for this account."
- },
- "gid": {
- "type": "integer",
- "description": "[Output Only] User's default group ID.",
- "format": "uint32"
- },
- "homeDirectory": {
- "type": "string",
- "description": "[Output Only] The path to the home directory for this account."
- },
- "shell": {
- "type": "string",
- "description": "[Output Only] The path to the login shell for this account."
- },
- "uid": {
- "type": "integer",
- "description": "[Output Only] User ID.",
- "format": "uint32"
- },
- "username": {
- "type": "string",
- "description": "[Output Only] The username of the account."
- }
- }
- },
- "LogConfig": {
- "id": "LogConfig",
- "type": "object",
- "description": "Specifies what kind of log the caller must write",
- "properties": {
- "counter": {
- "$ref": "LogConfigCounterOptions",
- "description": "Counter options."
- }
- }
- },
- "LogConfigCounterOptions": {
- "id": "LogConfigCounterOptions",
- "type": "object",
- "description": "Options for counters",
- "properties": {
- "field": {
- "type": "string",
- "description": "The field value to attribute."
- },
- "metric": {
- "type": "string",
- "description": "The metric to update."
- }
- }
- },
- "Operation": {
- "id": "Operation",
- "type": "object",
- "description": "An Operation resource, used to manage asynchronous API requests.",
- "properties": {
- "clientOperationId": {
- "type": "string",
- "description": "[Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "endTime": {
- "type": "string",
- "description": "[Output Only] The time that this operation was completed. This is in RFC3339 text format."
- },
- "error": {
- "type": "object",
- "description": "[Output Only] If errors are generated during processing of the operation, this field will be populated.",
- "properties": {
- "errors": {
- "type": "array",
- "description": "[Output Only] The array of errors encountered while processing this operation.",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The error type identifier for this error."
- },
- "location": {
- "type": "string",
- "description": "[Output Only] Indicates the field in the request which caused the error. This property is optional."
- },
- "message": {
- "type": "string",
- "description": "[Output Only] An optional, human-readable error message."
- }
- }
- }
- }
- }
- },
- "httpErrorMessage": {
- "type": "string",
- "description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND."
- },
- "httpErrorStatusCode": {
- "type": "integer",
- "description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.",
- "format": "int32"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "insertTime": {
- "type": "string",
- "description": "[Output Only] The time that this operation was requested. This is in RFC3339 text format."
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#operation for Operation resources.",
- "default": "clouduseraccounts#operation"
- },
- "name": {
- "type": "string",
- "description": "[Output Only] Name of the resource."
- },
- "operationType": {
- "type": "string",
- "description": "[Output Only] Type of the operation, such as insert, compute.instanceGroups.update, or compute.instanceGroups.delete."
- },
- "progress": {
- "type": "integer",
- "description": "[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.",
- "format": "int32"
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the operation resides. Only applicable for regional resources."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "startTime": {
- "type": "string",
- "description": "[Output Only] The time that this operation was started by the server. This is in RFC3339 text format."
- },
- "status": {
- "type": "string",
- "description": "[Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.",
- "enum": [
- "DONE",
- "PENDING",
- "RUNNING"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "statusMessage": {
- "type": "string",
- "description": "[Output Only] An optional textual description of the current status of the operation."
- },
- "targetId": {
- "type": "string",
- "description": "[Output Only] Unique target ID which identifies a particular incarnation of the target.",
- "format": "uint64"
- },
- "targetLink": {
- "type": "string",
- "description": "[Output Only] URL of the resource the operation is mutating."
- },
- "user": {
- "type": "string",
- "description": "[Output Only] User who requested the operation, for example: user@example.com."
- },
- "warnings": {
- "type": "array",
- "description": "[Output Only] If warning messages are generated during processing of the operation, this field will be populated.",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- },
- "zone": {
- "type": "string",
- "description": "[Output Only] URL of the zone where the operation resides."
- }
- }
- },
- "OperationList": {
- "id": "OperationList",
- "type": "object",
- "description": "Contains a list of Operation resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] The Operation resources.",
- "items": {
- "$ref": "Operation"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#operations for Operations resource.",
- "default": "clouduseraccounts#operationList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncate."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "Policy": {
- "id": "Policy",
- "type": "object",
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.\n\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.\n\n**Example**\n\n{ \"bindings\": [ { \"role\": \"roles/owner\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"] }, { \"role\": \"roles/viewer\", \"members\": [\"user:sean@example.com\"] } ] }\n\nFor a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).",
- "properties": {
- "bindings": {
- "type": "array",
- "description": "Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.",
- "items": {
- "$ref": "Binding"
- }
- },
- "etag": {
- "type": "string",
- "description": "Can be used to perform a read-modify-write.",
- "format": "byte"
- },
- "rules": {
- "type": "array",
- "description": "",
- "items": {
- "$ref": "Rule"
- }
- },
- "version": {
- "type": "integer",
- "description": "Version of the `Policy`. The default version is 0.",
- "format": "int32"
- }
- }
- },
- "PublicKey": {
- "id": "PublicKey",
- "type": "object",
- "description": "A public key for authenticating to guests.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "expirationTimestamp": {
- "type": "string",
- "description": "Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires."
- },
- "fingerprint": {
- "type": "string",
- "description": "[Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key."
- },
- "key": {
- "type": "string",
- "description": "Public key text in SSH format, defined by RFC4253 section 6.6."
- }
- }
- },
- "Rule": {
- "id": "Rule",
- "type": "object",
- "description": "A rule to be applied in a Policy.",
- "properties": {
- "action": {
- "type": "string",
- "description": "Required",
- "enum": [
- "ALLOW",
- "ALLOW_WITH_LOG",
- "DENY",
- "DENY_WITH_LOG",
- "LOG",
- "NO_ACTION"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "conditions": {
- "type": "array",
- "description": "Additional restrictions that must be met",
- "items": {
- "$ref": "Condition"
- }
- },
- "description": {
- "type": "string",
- "description": "Human-readable description of the rule."
- },
- "ins": {
- "type": "array",
- "description": "The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.",
- "items": {
- "type": "string"
- }
- },
- "logConfigs": {
- "type": "array",
- "description": "The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.",
- "items": {
- "$ref": "LogConfig"
- }
- },
- "notIns": {
- "type": "array",
- "description": "The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries.",
- "items": {
- "type": "string"
- }
- },
- "permissions": {
- "type": "array",
- "description": "A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "TestPermissionsRequest": {
- "id": "TestPermissionsRequest",
- "type": "object",
- "properties": {
- "permissions": {
- "type": "array",
- "description": "The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "TestPermissionsResponse": {
- "id": "TestPermissionsResponse",
- "type": "object",
- "properties": {
- "permissions": {
- "type": "array",
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "User": {
- "id": "User",
- "type": "object",
- "description": "A User resource.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "groups": {
- "type": "array",
- "description": "[Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always clouduseraccounts#user for users.",
- "default": "clouduseraccounts#user"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created.",
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "annotations": {
- "required": [
- "clouduseraccounts.users.insert"
- ]
- }
- },
- "owner": {
- "type": "string",
- "description": "Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.",
- "annotations": {
- "required": [
- "clouduseraccounts.users.insert"
- ]
- }
- },
- "publicKeys": {
- "type": "array",
- "description": "[Output Only] Public keys that this user may use to login.",
- "items": {
- "$ref": "PublicKey"
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server defined URL for the resource."
- }
- }
- },
- "UserList": {
- "id": "UserList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of User resources.",
- "items": {
- "$ref": "User"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always clouduseraccounts#userList for lists of users.",
- "default": "clouduseraccounts#userList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server defined URL for this resource."
- }
- }
- }
- },
- "resources": {
- "globalAccountsOperations": {
- "methods": {
- "delete": {
- "id": "clouduseraccounts.globalAccountsOperations.delete",
- "path": "{project}/global/operations/{operation}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified operation resource.",
- "parameters": {
- "operation": {
- "type": "string",
- "description": "Name of the Operations resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "operation"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "get": {
- "id": "clouduseraccounts.globalAccountsOperations.get",
- "path": "{project}/global/operations/{operation}",
- "httpMethod": "GET",
- "description": "Retrieves the specified operation resource.",
- "parameters": {
- "operation": {
- "type": "string",
- "description": "Name of the Operations resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "operation"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "list": {
- "id": "clouduseraccounts.globalAccountsOperations.list",
- "path": "{project}/global/operations",
- "httpMethod": "GET",
- "description": "Retrieves the list of operation resources contained within the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "OperationList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- }
- }
- },
- "groups": {
- "methods": {
- "addMember": {
- "id": "clouduseraccounts.groups.addMember",
- "path": "{project}/global/groups/{groupName}/addMember",
- "httpMethod": "POST",
- "description": "Adds users to the specified group.",
- "parameters": {
- "groupName": {
- "type": "string",
- "description": "Name of the group for this request.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "groupName"
- ],
- "request": {
- "$ref": "GroupsAddMemberRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "delete": {
- "id": "clouduseraccounts.groups.delete",
- "path": "{project}/global/groups/{groupName}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified Group resource.",
- "parameters": {
- "groupName": {
- "type": "string",
- "description": "Name of the Group resource to delete.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "groupName"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "get": {
- "id": "clouduseraccounts.groups.get",
- "path": "{project}/global/groups/{groupName}",
- "httpMethod": "GET",
- "description": "Returns the specified Group resource.",
- "parameters": {
- "groupName": {
- "type": "string",
- "description": "Name of the Group resource to return.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "groupName"
- ],
- "response": {
- "$ref": "Group"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "getIamPolicy": {
- "id": "clouduseraccounts.groups.getIamPolicy",
- "path": "{project}/global/groups/{resource}/getIamPolicy",
- "httpMethod": "GET",
- "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "resource": {
- "type": "string",
- "description": "Name of the resource for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "insert": {
- "id": "clouduseraccounts.groups.insert",
- "path": "{project}/global/groups",
- "httpMethod": "POST",
- "description": "Creates a Group resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "Group"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "list": {
- "id": "clouduseraccounts.groups.list",
- "path": "{project}/global/groups",
- "httpMethod": "GET",
- "description": "Retrieves the list of groups contained within the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "GroupList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "removeMember": {
- "id": "clouduseraccounts.groups.removeMember",
- "path": "{project}/global/groups/{groupName}/removeMember",
- "httpMethod": "POST",
- "description": "Removes users from the specified group.",
- "parameters": {
- "groupName": {
- "type": "string",
- "description": "Name of the group for this request.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "groupName"
- ],
- "request": {
- "$ref": "GroupsRemoveMemberRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "setIamPolicy": {
- "id": "clouduseraccounts.groups.setIamPolicy",
- "path": "{project}/global/groups/{resource}/setIamPolicy",
- "httpMethod": "POST",
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "resource": {
- "type": "string",
- "description": "Name of the resource for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "resource"
- ],
- "request": {
- "$ref": "Policy"
- },
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "testIamPermissions": {
- "id": "clouduseraccounts.groups.testIamPermissions",
- "path": "{project}/global/groups/{resource}/testIamPermissions",
- "httpMethod": "POST",
- "description": "Returns permissions that a caller has on the specified resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "resource": {
- "type": "string",
- "description": "Name of the resource for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "resource"
- ],
- "request": {
- "$ref": "TestPermissionsRequest"
- },
- "response": {
- "$ref": "TestPermissionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- }
- }
- },
- "linux": {
- "methods": {
- "getAuthorizedKeysView": {
- "id": "clouduseraccounts.linux.getAuthorizedKeysView",
- "path": "{project}/zones/{zone}/authorizedKeysView/{user}",
- "httpMethod": "POST",
- "description": "Returns a list of authorized public keys for a specific user account.",
- "parameters": {
- "instance": {
- "type": "string",
- "description": "The fully-qualified URL of the virtual machine requesting the view.",
- "required": true,
- "location": "query"
- },
- "login": {
- "type": "boolean",
- "description": "Whether the view was requested as part of a user-initiated login.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "user": {
- "type": "string",
- "description": "The user account for which you want to get a list of authorized public keys.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "user",
- "instance"
- ],
- "response": {
- "$ref": "LinuxGetAuthorizedKeysViewResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "getLinuxAccountViews": {
- "id": "clouduseraccounts.linux.getLinuxAccountViews",
- "path": "{project}/zones/{zone}/linuxAccountViews",
- "httpMethod": "POST",
- "description": "Retrieves a list of user accounts for an instance within a specific project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "instance": {
- "type": "string",
- "description": "The fully-qualified URL of the virtual machine requesting the views.",
- "required": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "response": {
- "$ref": "LinuxGetLinuxAccountViewsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- }
- }
- },
- "users": {
- "methods": {
- "addPublicKey": {
- "id": "clouduseraccounts.users.addPublicKey",
- "path": "{project}/global/users/{user}/addPublicKey",
- "httpMethod": "POST",
- "description": "Adds a public key to the specified User resource with the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "user": {
- "type": "string",
- "description": "Name of the user for this request.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "user"
- ],
- "request": {
- "$ref": "PublicKey"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "delete": {
- "id": "clouduseraccounts.users.delete",
- "path": "{project}/global/users/{user}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified User resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "user": {
- "type": "string",
- "description": "Name of the user resource to delete.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "user"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "get": {
- "id": "clouduseraccounts.users.get",
- "path": "{project}/global/users/{user}",
- "httpMethod": "GET",
- "description": "Returns the specified User resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "user": {
- "type": "string",
- "description": "Name of the user resource to return.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "user"
- ],
- "response": {
- "$ref": "User"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "getIamPolicy": {
- "id": "clouduseraccounts.users.getIamPolicy",
- "path": "{project}/global/users/{resource}/getIamPolicy",
- "httpMethod": "GET",
- "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "resource": {
- "type": "string",
- "description": "Name of the resource for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "insert": {
- "id": "clouduseraccounts.users.insert",
- "path": "{project}/global/users",
- "httpMethod": "POST",
- "description": "Creates a User resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "User"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "list": {
- "id": "clouduseraccounts.users.list",
- "path": "{project}/global/users",
- "httpMethod": "GET",
- "description": "Retrieves a list of users contained within the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "UserList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "removePublicKey": {
- "id": "clouduseraccounts.users.removePublicKey",
- "path": "{project}/global/users/{user}/removePublicKey",
- "httpMethod": "POST",
- "description": "Removes the specified public key from the user.",
- "parameters": {
- "fingerprint": {
- "type": "string",
- "description": "The fingerprint of the public key to delete. Public keys are identified by their fingerprint, which is defined by RFC4716 to be the MD5 digest of the public key.",
- "required": true,
- "pattern": "[a-f0-9]{32}",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "user": {
- "type": "string",
- "description": "Name of the user for this request.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "user",
- "fingerprint"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "setIamPolicy": {
- "id": "clouduseraccounts.users.setIamPolicy",
- "path": "{project}/global/users/{resource}/setIamPolicy",
- "httpMethod": "POST",
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "resource": {
- "type": "string",
- "description": "Name of the resource for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "resource"
- ],
- "request": {
- "$ref": "Policy"
- },
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "testIamPermissions": {
- "id": "clouduseraccounts.users.testIamPermissions",
- "path": "{project}/global/users/{resource}/testIamPermissions",
- "httpMethod": "POST",
- "description": "Returns permissions that a caller has on the specified resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "resource": {
- "type": "string",
- "description": "Name of the resource for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "resource"
- ],
- "request": {
- "$ref": "TestPermissionsRequest"
- },
- "response": {
- "$ref": "TestPermissionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/clouduseraccounts/vm_alpha/clouduseraccounts-gen.go b/vendor/google.golang.org/api/clouduseraccounts/vm_alpha/clouduseraccounts-gen.go
deleted file mode 100644
index e5e3bec3..00000000
--- a/vendor/google.golang.org/api/clouduseraccounts/vm_alpha/clouduseraccounts-gen.go
+++ /dev/null
@@ -1,4592 +0,0 @@
-// Package clouduseraccounts provides access to the Cloud User Accounts API.
-//
-// See https://cloud.google.com/compute/docs/access/user-accounts/api/latest/
-//
-// Usage example:
-//
-// import "google.golang.org/api/clouduseraccounts/vm_alpha"
-// ...
-// clouduseraccountsService, err := clouduseraccounts.New(oauthHttpClient)
-package clouduseraccounts // import "google.golang.org/api/clouduseraccounts/vm_alpha"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "clouduseraccounts:vm_alpha"
-const apiName = "clouduseraccounts"
-const apiVersion = "vm_alpha"
-const basePath = "https://www.googleapis.com/clouduseraccounts/vm_alpha/projects/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your data across Google Cloud Platform services
- CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
-
- // View your data across Google Cloud Platform services
- CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"
-
- // Manage your Google Cloud User Accounts
- CloudUseraccountsScope = "https://www.googleapis.com/auth/cloud.useraccounts"
-
- // View your Google Cloud User Accounts
- CloudUseraccountsReadonlyScope = "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.GlobalAccountsOperations = NewGlobalAccountsOperationsService(s)
- s.Groups = NewGroupsService(s)
- s.Linux = NewLinuxService(s)
- s.Users = NewUsersService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- GlobalAccountsOperations *GlobalAccountsOperationsService
-
- Groups *GroupsService
-
- Linux *LinuxService
-
- Users *UsersService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewGlobalAccountsOperationsService(s *Service) *GlobalAccountsOperationsService {
- rs := &GlobalAccountsOperationsService{s: s}
- return rs
-}
-
-type GlobalAccountsOperationsService struct {
- s *Service
-}
-
-func NewGroupsService(s *Service) *GroupsService {
- rs := &GroupsService{s: s}
- return rs
-}
-
-type GroupsService struct {
- s *Service
-}
-
-func NewLinuxService(s *Service) *LinuxService {
- rs := &LinuxService{s: s}
- return rs
-}
-
-type LinuxService struct {
- s *Service
-}
-
-func NewUsersService(s *Service) *UsersService {
- rs := &UsersService{s: s}
- return rs
-}
-
-type UsersService struct {
- s *Service
-}
-
-// AuthorizedKeysView: A list of authorized public keys for a user
-// account.
-type AuthorizedKeysView struct {
- // Keys: [Output Only] The list of authorized public keys in SSH format.
- Keys []string `json:"keys,omitempty"`
-
- // Sudoer: [Output Only] Whether the user has the ability to elevate on
- // the instance that requested the authorized keys.
- Sudoer bool `json:"sudoer,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Keys") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AuthorizedKeysView) MarshalJSON() ([]byte, error) {
- type noMethod AuthorizedKeysView
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Binding: Associates `members` with a `role`.
-type Binding struct {
- // Members: Specifies the identities requesting access for a Cloud
- // Platform resource. `members` can have the following formats:
- //
- // * `allUsers`: A special identifier that represents anyone who is on
- // the internet; with or without a Google account.
- //
- // * `allAuthenticatedUsers`: A special identifier that represents
- // anyone who is authenticated with a Google account or a service
- // account.
- //
- // * `user:{emailid}`: An email address that represents a specific
- // Google account. For example, `alice@gmail.com` or
- // `joe@example.com`.
- //
- // * `serviceAccount:{emailid}`: An email address that represents a
- // service account. For example,
- // `my-other-app@appspot.gserviceaccount.com`.
- //
- // * `group:{emailid}`: An email address that represents a Google group.
- // For example, `admins@example.com`.
- //
- // * `domain:{domain}`: A Google Apps domain name that represents all
- // the users of that domain. For example, `google.com` or `example.com`.
- Members []string `json:"members,omitempty"`
-
- // Role: Role that is assigned to `members`. For example,
- // `roles/viewer`, `roles/editor`, or `roles/owner`.
- Role string `json:"role,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Members") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Binding) MarshalJSON() ([]byte, error) {
- type noMethod Binding
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Condition: A condition to be met.
-type Condition struct {
- // Iam: Trusted attributes supplied by the IAM system.
- //
- // Possible values:
- // "ATTRIBUTION"
- // "AUTHORITY"
- // "NO_ATTR"
- Iam string `json:"iam,omitempty"`
-
- // Op: An operator to apply the subject with.
- //
- // Possible values:
- // "DISCHARGED"
- // "EQUALS"
- // "IN"
- // "NOT_EQUALS"
- // "NOT_IN"
- // "NO_OP"
- Op string `json:"op,omitempty"`
-
- // Svc: Trusted attributes discharged by the service.
- Svc string `json:"svc,omitempty"`
-
- // Sys: Trusted attributes supplied by any service that owns resources
- // and uses the IAM system for access control.
- //
- // Possible values:
- // "IP"
- // "NAME"
- // "NO_ATTR"
- // "REGION"
- // "SERVICE"
- Sys string `json:"sys,omitempty"`
-
- // Value: The object of the condition. Exactly one of these must be set.
- Value string `json:"value,omitempty"`
-
- // Values: The objects of the condition. This is mutually exclusive with
- // 'value'.
- Values []string `json:"values,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Iam") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Condition) MarshalJSON() ([]byte, error) {
- type noMethod Condition
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Group: A Group resource.
-type Group struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always
- // clouduseraccounts#group for groups.
- Kind string `json:"kind,omitempty"`
-
- // Members: [Output Only] A list of URLs to User resources who belong to
- // the group. Users may only be members of groups in the same project.
- Members []string `json:"members,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created.
- Name string `json:"name,omitempty"`
-
- // SelfLink: [Output Only] Server defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Group) MarshalJSON() ([]byte, error) {
- type noMethod Group
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GroupList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of Group resources.
- Items []*Group `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always
- // clouduseraccounts#groupList for lists of groups.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GroupList) MarshalJSON() ([]byte, error) {
- type noMethod GroupList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GroupsAddMemberRequest struct {
- // Users: Fully-qualified URLs of the User resources to add.
- Users []string `json:"users,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Users") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GroupsAddMemberRequest) MarshalJSON() ([]byte, error) {
- type noMethod GroupsAddMemberRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GroupsRemoveMemberRequest struct {
- // Users: Fully-qualified URLs of the User resources to remove.
- Users []string `json:"users,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Users") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GroupsRemoveMemberRequest) MarshalJSON() ([]byte, error) {
- type noMethod GroupsRemoveMemberRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LinuxAccountViews: A list of all Linux accounts for this project.
-// This API is only used by Compute Engine virtual machines to get
-// information about user accounts for a project or instance. Linux
-// resources are read-only views into users and groups managed by the
-// Compute Engine Accounts API.
-type LinuxAccountViews struct {
- // GroupViews: [Output Only] A list of all groups within a project.
- GroupViews []*LinuxGroupView `json:"groupViews,omitempty"`
-
- // Kind: [Output Only] Type of the resource. Always
- // clouduseraccounts#linuxAccountViews for Linux resources.
- Kind string `json:"kind,omitempty"`
-
- // UserViews: [Output Only] A list of all users within a project.
- UserViews []*LinuxUserView `json:"userViews,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "GroupViews") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LinuxAccountViews) MarshalJSON() ([]byte, error) {
- type noMethod LinuxAccountViews
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type LinuxGetAuthorizedKeysViewResponse struct {
- // Resource: [Output Only] A list of authorized public keys for a user.
- Resource *AuthorizedKeysView `json:"resource,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Resource") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LinuxGetAuthorizedKeysViewResponse) MarshalJSON() ([]byte, error) {
- type noMethod LinuxGetAuthorizedKeysViewResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type LinuxGetLinuxAccountViewsResponse struct {
- // Resource: [Output Only] A list of authorized user accounts and
- // groups.
- Resource *LinuxAccountViews `json:"resource,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Resource") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LinuxGetLinuxAccountViewsResponse) MarshalJSON() ([]byte, error) {
- type noMethod LinuxGetLinuxAccountViewsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LinuxGroupView: A detailed view of a Linux group.
-type LinuxGroupView struct {
- // Gid: [Output Only] The Group ID.
- Gid int64 `json:"gid,omitempty"`
-
- // GroupName: [Output Only] Group name.
- GroupName string `json:"groupName,omitempty"`
-
- // Members: [Output Only] List of user accounts that belong to the
- // group.
- Members []string `json:"members,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Gid") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LinuxGroupView) MarshalJSON() ([]byte, error) {
- type noMethod LinuxGroupView
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LinuxUserView: A detailed view of a Linux user account.
-type LinuxUserView struct {
- // Gecos: [Output Only] The GECOS (user information) entry for this
- // account.
- Gecos string `json:"gecos,omitempty"`
-
- // Gid: [Output Only] User's default group ID.
- Gid int64 `json:"gid,omitempty"`
-
- // HomeDirectory: [Output Only] The path to the home directory for this
- // account.
- HomeDirectory string `json:"homeDirectory,omitempty"`
-
- // Shell: [Output Only] The path to the login shell for this account.
- Shell string `json:"shell,omitempty"`
-
- // Uid: [Output Only] User ID.
- Uid int64 `json:"uid,omitempty"`
-
- // Username: [Output Only] The username of the account.
- Username string `json:"username,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Gecos") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LinuxUserView) MarshalJSON() ([]byte, error) {
- type noMethod LinuxUserView
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LogConfig: Specifies what kind of log the caller must write
-type LogConfig struct {
- // Counter: Counter options.
- Counter *LogConfigCounterOptions `json:"counter,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Counter") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LogConfig) MarshalJSON() ([]byte, error) {
- type noMethod LogConfig
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LogConfigCounterOptions: Options for counters
-type LogConfigCounterOptions struct {
- // Field: The field value to attribute.
- Field string `json:"field,omitempty"`
-
- // Metric: The metric to update.
- Metric string `json:"metric,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Field") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LogConfigCounterOptions) MarshalJSON() ([]byte, error) {
- type noMethod LogConfigCounterOptions
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Operation: An Operation resource, used to manage asynchronous API
-// requests.
-type Operation struct {
- // ClientOperationId: [Output Only] An optional identifier specified by
- // the client when the mutation was initiated. Must be unique for all
- // Operation resources in the project.
- ClientOperationId string `json:"clientOperationId,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // EndTime: [Output Only] The time that this operation was completed.
- // This is in RFC3339 text format.
- EndTime string `json:"endTime,omitempty"`
-
- // Error: [Output Only] If errors are generated during processing of the
- // operation, this field will be populated.
- Error *OperationError `json:"error,omitempty"`
-
- // HttpErrorMessage: [Output Only] If the operation fails, this field
- // contains the HTTP error message that was returned, such as NOT FOUND.
- HttpErrorMessage string `json:"httpErrorMessage,omitempty"`
-
- // HttpErrorStatusCode: [Output Only] If the operation fails, this field
- // contains the HTTP error message that was returned, such as 404.
- HttpErrorStatusCode int64 `json:"httpErrorStatusCode,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // InsertTime: [Output Only] The time that this operation was requested.
- // This is in RFC3339 text format.
- InsertTime string `json:"insertTime,omitempty"`
-
- // Kind: [Output Only] Type of the resource. Always compute#operation
- // for Operation resources.
- Kind string `json:"kind,omitempty"`
-
- // Name: [Output Only] Name of the resource.
- Name string `json:"name,omitempty"`
-
- // OperationType: [Output Only] Type of the operation, such as insert,
- // compute.instanceGroups.update, or compute.instanceGroups.delete.
- OperationType string `json:"operationType,omitempty"`
-
- // Progress: [Output Only] An optional progress indicator that ranges
- // from 0 to 100. There is no requirement that this be linear or support
- // any granularity of operations. This should not be used to guess at
- // when the operation will be complete. This number should monotonically
- // increase as the operation progresses.
- Progress int64 `json:"progress,omitempty"`
-
- // Region: [Output Only] URL of the region where the operation resides.
- // Only applicable for regional resources.
- Region string `json:"region,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // StartTime: [Output Only] The time that this operation was started by
- // the server. This is in RFC3339 text format.
- StartTime string `json:"startTime,omitempty"`
-
- // Status: [Output Only] Status of the operation. Can be one of the
- // following: PENDING, RUNNING, or DONE.
- //
- // Possible values:
- // "DONE"
- // "PENDING"
- // "RUNNING"
- Status string `json:"status,omitempty"`
-
- // StatusMessage: [Output Only] An optional textual description of the
- // current status of the operation.
- StatusMessage string `json:"statusMessage,omitempty"`
-
- // TargetId: [Output Only] Unique target ID which identifies a
- // particular incarnation of the target.
- TargetId uint64 `json:"targetId,omitempty,string"`
-
- // TargetLink: [Output Only] URL of the resource the operation is
- // mutating.
- TargetLink string `json:"targetLink,omitempty"`
-
- // User: [Output Only] User who requested the operation, for example:
- // user@example.com.
- User string `json:"user,omitempty"`
-
- // Warnings: [Output Only] If warning messages are generated during
- // processing of the operation, this field will be populated.
- Warnings []*OperationWarnings `json:"warnings,omitempty"`
-
- // Zone: [Output Only] URL of the zone where the operation resides.
- Zone string `json:"zone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ClientOperationId")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Operation) MarshalJSON() ([]byte, error) {
- type noMethod Operation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperationError: [Output Only] If errors are generated during
-// processing of the operation, this field will be populated.
-type OperationError struct {
- // Errors: [Output Only] The array of errors encountered while
- // processing this operation.
- Errors []*OperationErrorErrors `json:"errors,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Errors") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationError) MarshalJSON() ([]byte, error) {
- type noMethod OperationError
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationErrorErrors struct {
- // Code: [Output Only] The error type identifier for this error.
- Code string `json:"code,omitempty"`
-
- // Location: [Output Only] Indicates the field in the request which
- // caused the error. This property is optional.
- Location string `json:"location,omitempty"`
-
- // Message: [Output Only] An optional, human-readable error message.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationErrorErrors) MarshalJSON() ([]byte, error) {
- type noMethod OperationErrorErrors
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationWarnings struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*OperationWarningsData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationWarnings) MarshalJSON() ([]byte, error) {
- type noMethod OperationWarnings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationWarningsData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationWarningsData) MarshalJSON() ([]byte, error) {
- type noMethod OperationWarningsData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperationList: Contains a list of Operation resources.
-type OperationList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] The Operation resources.
- Items []*Operation `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#operations for
- // Operations resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncate.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationList) MarshalJSON() ([]byte, error) {
- type noMethod OperationList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Policy: Defines an Identity and Access Management (IAM) policy. It is
-// used to specify access control policies for Cloud Platform
-// resources.
-//
-//
-//
-// A `Policy` consists of a list of `bindings`. A `Binding` binds a list
-// of `members` to a `role`, where the members can be user accounts,
-// Google groups, Google domains, and service accounts. A `role` is a
-// named list of permissions defined by IAM.
-//
-// **Example**
-//
-// { "bindings": [ { "role": "roles/owner", "members": [
-// "user:mike@example.com", "group:admins@example.com",
-// "domain:google.com",
-// "serviceAccount:my-other-app@appspot.gserviceaccount.com"] }, {
-// "role": "roles/viewer", "members": ["user:sean@example.com"] } ]
-// }
-//
-// For a description of IAM and its features, see the [IAM developer's
-// guide](https://cloud.google.com/iam).
-type Policy struct {
- // Bindings: Associates a list of `members` to a `role`. Multiple
- // `bindings` must not be specified for the same `role`. `bindings` with
- // no members will result in an error.
- Bindings []*Binding `json:"bindings,omitempty"`
-
- // Etag: Can be used to perform a read-modify-write.
- Etag string `json:"etag,omitempty"`
-
- Rules []*Rule `json:"rules,omitempty"`
-
- // Version: Version of the `Policy`. The default version is 0.
- Version int64 `json:"version,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Bindings") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Policy) MarshalJSON() ([]byte, error) {
- type noMethod Policy
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PublicKey: A public key for authenticating to guests.
-type PublicKey struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // ExpirationTimestamp: Optional expiration timestamp. If provided, the
- // timestamp must be in RFC3339 text format. If not provided, the public
- // key never expires.
- ExpirationTimestamp string `json:"expirationTimestamp,omitempty"`
-
- // Fingerprint: [Output Only] The fingerprint of the key is defined by
- // RFC4716 to be the MD5 digest of the public key.
- Fingerprint string `json:"fingerprint,omitempty"`
-
- // Key: Public key text in SSH format, defined by RFC4253 section 6.6.
- Key string `json:"key,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PublicKey) MarshalJSON() ([]byte, error) {
- type noMethod PublicKey
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Rule: A rule to be applied in a Policy.
-type Rule struct {
- // Action: Required
- //
- // Possible values:
- // "ALLOW"
- // "ALLOW_WITH_LOG"
- // "DENY"
- // "DENY_WITH_LOG"
- // "LOG"
- // "NO_ACTION"
- Action string `json:"action,omitempty"`
-
- // Conditions: Additional restrictions that must be met
- Conditions []*Condition `json:"conditions,omitempty"`
-
- // Description: Human-readable description of the rule.
- Description string `json:"description,omitempty"`
-
- // Ins: The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this
- // set of entries.
- Ins []string `json:"ins,omitempty"`
-
- // LogConfigs: The config returned to callers of
- // tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
- LogConfigs []*LogConfig `json:"logConfigs,omitempty"`
-
- // NotIns: The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not
- // in this set of entries.
- NotIns []string `json:"notIns,omitempty"`
-
- // Permissions: A permission is a string of form '..' (e.g.,
- // 'storage.buckets.list'). A value of '*' matches all permissions, and
- // a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
- Permissions []string `json:"permissions,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Action") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Rule) MarshalJSON() ([]byte, error) {
- type noMethod Rule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TestPermissionsRequest struct {
- // Permissions: The set of permissions to check for the 'resource'.
- // Permissions with wildcards (such as '*' or 'storage.*') are not
- // allowed.
- Permissions []string `json:"permissions,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Permissions") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TestPermissionsRequest) MarshalJSON() ([]byte, error) {
- type noMethod TestPermissionsRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TestPermissionsResponse struct {
- // Permissions: A subset of `TestPermissionsRequest.permissions` that
- // the caller is allowed.
- Permissions []string `json:"permissions,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Permissions") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TestPermissionsResponse) MarshalJSON() ([]byte, error) {
- type noMethod TestPermissionsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// User: A User resource.
-type User struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Groups: [Output Only] A list of URLs to Group resources who contain
- // the user. Users are only members of groups in the same project.
- Groups []string `json:"groups,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always
- // clouduseraccounts#user for users.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created.
- Name string `json:"name,omitempty"`
-
- // Owner: Email address of account's owner. This account will be
- // validated to make sure it exists. The email can belong to any domain,
- // but it must be tied to a Google account.
- Owner string `json:"owner,omitempty"`
-
- // PublicKeys: [Output Only] Public keys that this user may use to
- // login.
- PublicKeys []*PublicKey `json:"publicKeys,omitempty"`
-
- // SelfLink: [Output Only] Server defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *User) MarshalJSON() ([]byte, error) {
- type noMethod User
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UserList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of User resources.
- Items []*User `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always
- // clouduseraccounts#userList for lists of users.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserList) MarshalJSON() ([]byte, error) {
- type noMethod UserList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "clouduseraccounts.globalAccountsOperations.delete":
-
-type GlobalAccountsOperationsDeleteCall struct {
- s *Service
- project string
- operation string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified operation resource.
-func (r *GlobalAccountsOperationsService) Delete(project string, operation string) *GlobalAccountsOperationsDeleteCall {
- c := &GlobalAccountsOperationsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.operation = operation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalAccountsOperationsDeleteCall) Fields(s ...googleapi.Field) *GlobalAccountsOperationsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalAccountsOperationsDeleteCall) Context(ctx context.Context) *GlobalAccountsOperationsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalAccountsOperationsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/operations/{operation}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "operation": c.operation,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.globalAccountsOperations.delete" call.
-func (c *GlobalAccountsOperationsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes the specified operation resource.",
- // "httpMethod": "DELETE",
- // "id": "clouduseraccounts.globalAccountsOperations.delete",
- // "parameterOrder": [
- // "project",
- // "operation"
- // ],
- // "parameters": {
- // "operation": {
- // "description": "Name of the Operations resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/operations/{operation}",
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.globalAccountsOperations.get":
-
-type GlobalAccountsOperationsGetCall struct {
- s *Service
- project string
- operation string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves the specified operation resource.
-func (r *GlobalAccountsOperationsService) Get(project string, operation string) *GlobalAccountsOperationsGetCall {
- c := &GlobalAccountsOperationsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.operation = operation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalAccountsOperationsGetCall) Fields(s ...googleapi.Field) *GlobalAccountsOperationsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GlobalAccountsOperationsGetCall) IfNoneMatch(entityTag string) *GlobalAccountsOperationsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalAccountsOperationsGetCall) Context(ctx context.Context) *GlobalAccountsOperationsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalAccountsOperationsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/operations/{operation}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "operation": c.operation,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.globalAccountsOperations.get" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GlobalAccountsOperationsGetCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the specified operation resource.",
- // "httpMethod": "GET",
- // "id": "clouduseraccounts.globalAccountsOperations.get",
- // "parameterOrder": [
- // "project",
- // "operation"
- // ],
- // "parameters": {
- // "operation": {
- // "description": "Name of the Operations resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/operations/{operation}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.globalAccountsOperations.list":
-
-type GlobalAccountsOperationsListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of operation resources contained within the
-// specified project.
-func (r *GlobalAccountsOperationsService) List(project string) *GlobalAccountsOperationsListCall {
- c := &GlobalAccountsOperationsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *GlobalAccountsOperationsListCall) Filter(filter string) *GlobalAccountsOperationsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *GlobalAccountsOperationsListCall) MaxResults(maxResults int64) *GlobalAccountsOperationsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *GlobalAccountsOperationsListCall) OrderBy(orderBy string) *GlobalAccountsOperationsListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *GlobalAccountsOperationsListCall) PageToken(pageToken string) *GlobalAccountsOperationsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalAccountsOperationsListCall) Fields(s ...googleapi.Field) *GlobalAccountsOperationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GlobalAccountsOperationsListCall) IfNoneMatch(entityTag string) *GlobalAccountsOperationsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalAccountsOperationsListCall) Context(ctx context.Context) *GlobalAccountsOperationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalAccountsOperationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/operations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.globalAccountsOperations.list" call.
-// Exactly one of *OperationList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *OperationList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *GlobalAccountsOperationsListCall) Do() (*OperationList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OperationList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of operation resources contained within the specified project.",
- // "httpMethod": "GET",
- // "id": "clouduseraccounts.globalAccountsOperations.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/operations",
- // "response": {
- // "$ref": "OperationList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.addMember":
-
-type GroupsAddMemberCall struct {
- s *Service
- project string
- groupName string
- groupsaddmemberrequest *GroupsAddMemberRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AddMember: Adds users to the specified group.
-func (r *GroupsService) AddMember(project string, groupName string, groupsaddmemberrequest *GroupsAddMemberRequest) *GroupsAddMemberCall {
- c := &GroupsAddMemberCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.groupName = groupName
- c.groupsaddmemberrequest = groupsaddmemberrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsAddMemberCall) Fields(s ...googleapi.Field) *GroupsAddMemberCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsAddMemberCall) Context(ctx context.Context) *GroupsAddMemberCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsAddMemberCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.groupsaddmemberrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups/{groupName}/addMember")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "groupName": c.groupName,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.addMember" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GroupsAddMemberCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Adds users to the specified group.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.groups.addMember",
- // "parameterOrder": [
- // "project",
- // "groupName"
- // ],
- // "parameters": {
- // "groupName": {
- // "description": "Name of the group for this request.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups/{groupName}/addMember",
- // "request": {
- // "$ref": "GroupsAddMemberRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.delete":
-
-type GroupsDeleteCall struct {
- s *Service
- project string
- groupName string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified Group resource.
-func (r *GroupsService) Delete(project string, groupName string) *GroupsDeleteCall {
- c := &GroupsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.groupName = groupName
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsDeleteCall) Fields(s ...googleapi.Field) *GroupsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsDeleteCall) Context(ctx context.Context) *GroupsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups/{groupName}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "groupName": c.groupName,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GroupsDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified Group resource.",
- // "httpMethod": "DELETE",
- // "id": "clouduseraccounts.groups.delete",
- // "parameterOrder": [
- // "project",
- // "groupName"
- // ],
- // "parameters": {
- // "groupName": {
- // "description": "Name of the Group resource to delete.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups/{groupName}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.get":
-
-type GroupsGetCall struct {
- s *Service
- project string
- groupName string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified Group resource.
-func (r *GroupsService) Get(project string, groupName string) *GroupsGetCall {
- c := &GroupsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.groupName = groupName
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsGetCall) Fields(s ...googleapi.Field) *GroupsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GroupsGetCall) IfNoneMatch(entityTag string) *GroupsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsGetCall) Context(ctx context.Context) *GroupsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups/{groupName}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "groupName": c.groupName,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.get" call.
-// Exactly one of *Group or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Group.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *GroupsGetCall) Do() (*Group, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Group{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified Group resource.",
- // "httpMethod": "GET",
- // "id": "clouduseraccounts.groups.get",
- // "parameterOrder": [
- // "project",
- // "groupName"
- // ],
- // "parameters": {
- // "groupName": {
- // "description": "Name of the Group resource to return.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups/{groupName}",
- // "response": {
- // "$ref": "Group"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.getIamPolicy":
-
-type GroupsGetIamPolicyCall struct {
- s *Service
- project string
- resource string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetIamPolicy: Gets the access control policy for a resource. May be
-// empty if no such policy or resource exists.
-func (r *GroupsService) GetIamPolicy(project string, resource string) *GroupsGetIamPolicyCall {
- c := &GroupsGetIamPolicyCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.resource = resource
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsGetIamPolicyCall) Fields(s ...googleapi.Field) *GroupsGetIamPolicyCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GroupsGetIamPolicyCall) IfNoneMatch(entityTag string) *GroupsGetIamPolicyCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsGetIamPolicyCall) Context(ctx context.Context) *GroupsGetIamPolicyCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsGetIamPolicyCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups/{resource}/getIamPolicy")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "resource": c.resource,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.getIamPolicy" call.
-// Exactly one of *Policy or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Policy.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *GroupsGetIamPolicyCall) Do() (*Policy, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Policy{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
- // "httpMethod": "GET",
- // "id": "clouduseraccounts.groups.getIamPolicy",
- // "parameterOrder": [
- // "project",
- // "resource"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "resource": {
- // "description": "Name of the resource for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups/{resource}/getIamPolicy",
- // "response": {
- // "$ref": "Policy"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.insert":
-
-type GroupsInsertCall struct {
- s *Service
- project string
- group *Group
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a Group resource in the specified project using the
-// data included in the request.
-func (r *GroupsService) Insert(project string, group *Group) *GroupsInsertCall {
- c := &GroupsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.group = group
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsInsertCall) Fields(s ...googleapi.Field) *GroupsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsInsertCall) Context(ctx context.Context) *GroupsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.group)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GroupsInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a Group resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.groups.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups",
- // "request": {
- // "$ref": "Group"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.list":
-
-type GroupsListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of groups contained within the specified
-// project.
-func (r *GroupsService) List(project string) *GroupsListCall {
- c := &GroupsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *GroupsListCall) Filter(filter string) *GroupsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *GroupsListCall) MaxResults(maxResults int64) *GroupsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *GroupsListCall) OrderBy(orderBy string) *GroupsListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *GroupsListCall) PageToken(pageToken string) *GroupsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsListCall) Fields(s ...googleapi.Field) *GroupsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GroupsListCall) IfNoneMatch(entityTag string) *GroupsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsListCall) Context(ctx context.Context) *GroupsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.list" call.
-// Exactly one of *GroupList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *GroupList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GroupsListCall) Do() (*GroupList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &GroupList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of groups contained within the specified project.",
- // "httpMethod": "GET",
- // "id": "clouduseraccounts.groups.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups",
- // "response": {
- // "$ref": "GroupList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.removeMember":
-
-type GroupsRemoveMemberCall struct {
- s *Service
- project string
- groupName string
- groupsremovememberrequest *GroupsRemoveMemberRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// RemoveMember: Removes users from the specified group.
-func (r *GroupsService) RemoveMember(project string, groupName string, groupsremovememberrequest *GroupsRemoveMemberRequest) *GroupsRemoveMemberCall {
- c := &GroupsRemoveMemberCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.groupName = groupName
- c.groupsremovememberrequest = groupsremovememberrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsRemoveMemberCall) Fields(s ...googleapi.Field) *GroupsRemoveMemberCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsRemoveMemberCall) Context(ctx context.Context) *GroupsRemoveMemberCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsRemoveMemberCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.groupsremovememberrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups/{groupName}/removeMember")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "groupName": c.groupName,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.removeMember" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GroupsRemoveMemberCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Removes users from the specified group.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.groups.removeMember",
- // "parameterOrder": [
- // "project",
- // "groupName"
- // ],
- // "parameters": {
- // "groupName": {
- // "description": "Name of the group for this request.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups/{groupName}/removeMember",
- // "request": {
- // "$ref": "GroupsRemoveMemberRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.setIamPolicy":
-
-type GroupsSetIamPolicyCall struct {
- s *Service
- project string
- resource string
- policy *Policy
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetIamPolicy: Sets the access control policy on the specified
-// resource. Replaces any existing policy.
-func (r *GroupsService) SetIamPolicy(project string, resource string, policy *Policy) *GroupsSetIamPolicyCall {
- c := &GroupsSetIamPolicyCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.resource = resource
- c.policy = policy
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsSetIamPolicyCall) Fields(s ...googleapi.Field) *GroupsSetIamPolicyCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsSetIamPolicyCall) Context(ctx context.Context) *GroupsSetIamPolicyCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsSetIamPolicyCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.policy)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups/{resource}/setIamPolicy")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "resource": c.resource,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.setIamPolicy" call.
-// Exactly one of *Policy or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Policy.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *GroupsSetIamPolicyCall) Do() (*Policy, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Policy{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.groups.setIamPolicy",
- // "parameterOrder": [
- // "project",
- // "resource"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "resource": {
- // "description": "Name of the resource for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups/{resource}/setIamPolicy",
- // "request": {
- // "$ref": "Policy"
- // },
- // "response": {
- // "$ref": "Policy"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.testIamPermissions":
-
-type GroupsTestIamPermissionsCall struct {
- s *Service
- project string
- resource string
- testpermissionsrequest *TestPermissionsRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// TestIamPermissions: Returns permissions that a caller has on the
-// specified resource.
-func (r *GroupsService) TestIamPermissions(project string, resource string, testpermissionsrequest *TestPermissionsRequest) *GroupsTestIamPermissionsCall {
- c := &GroupsTestIamPermissionsCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.resource = resource
- c.testpermissionsrequest = testpermissionsrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsTestIamPermissionsCall) Fields(s ...googleapi.Field) *GroupsTestIamPermissionsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsTestIamPermissionsCall) Context(ctx context.Context) *GroupsTestIamPermissionsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsTestIamPermissionsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.testpermissionsrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups/{resource}/testIamPermissions")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "resource": c.resource,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.testIamPermissions" call.
-// Exactly one of *TestPermissionsResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *TestPermissionsResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *GroupsTestIamPermissionsCall) Do() (*TestPermissionsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TestPermissionsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns permissions that a caller has on the specified resource.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.groups.testIamPermissions",
- // "parameterOrder": [
- // "project",
- // "resource"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "resource": {
- // "description": "Name of the resource for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups/{resource}/testIamPermissions",
- // "request": {
- // "$ref": "TestPermissionsRequest"
- // },
- // "response": {
- // "$ref": "TestPermissionsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.linux.getAuthorizedKeysView":
-
-type LinuxGetAuthorizedKeysViewCall struct {
- s *Service
- project string
- zone string
- user string
- instance string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetAuthorizedKeysView: Returns a list of authorized public keys for a
-// specific user account.
-func (r *LinuxService) GetAuthorizedKeysView(project string, zone string, user string, instance string) *LinuxGetAuthorizedKeysViewCall {
- c := &LinuxGetAuthorizedKeysViewCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.user = user
- c.instance = instance
- return c
-}
-
-// Login sets the optional parameter "login": Whether the view was
-// requested as part of a user-initiated login.
-func (c *LinuxGetAuthorizedKeysViewCall) Login(login bool) *LinuxGetAuthorizedKeysViewCall {
- c.opt_["login"] = login
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LinuxGetAuthorizedKeysViewCall) Fields(s ...googleapi.Field) *LinuxGetAuthorizedKeysViewCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LinuxGetAuthorizedKeysViewCall) Context(ctx context.Context) *LinuxGetAuthorizedKeysViewCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LinuxGetAuthorizedKeysViewCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("instance", fmt.Sprintf("%v", c.instance))
- if v, ok := c.opt_["login"]; ok {
- params.Set("login", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/authorizedKeysView/{user}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "user": c.user,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.linux.getAuthorizedKeysView" call.
-// Exactly one of *LinuxGetAuthorizedKeysViewResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *LinuxGetAuthorizedKeysViewResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *LinuxGetAuthorizedKeysViewCall) Do() (*LinuxGetAuthorizedKeysViewResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &LinuxGetAuthorizedKeysViewResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns a list of authorized public keys for a specific user account.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.linux.getAuthorizedKeysView",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "user",
- // "instance"
- // ],
- // "parameters": {
- // "instance": {
- // "description": "The fully-qualified URL of the virtual machine requesting the view.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "login": {
- // "description": "Whether the view was requested as part of a user-initiated login.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "user": {
- // "description": "The user account for which you want to get a list of authorized public keys.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/authorizedKeysView/{user}",
- // "response": {
- // "$ref": "LinuxGetAuthorizedKeysViewResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.linux.getLinuxAccountViews":
-
-type LinuxGetLinuxAccountViewsCall struct {
- s *Service
- project string
- zone string
- instance string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetLinuxAccountViews: Retrieves a list of user accounts for an
-// instance within a specific project.
-func (r *LinuxService) GetLinuxAccountViews(project string, zone string, instance string) *LinuxGetLinuxAccountViewsCall {
- c := &LinuxGetLinuxAccountViewsCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *LinuxGetLinuxAccountViewsCall) Filter(filter string) *LinuxGetLinuxAccountViewsCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *LinuxGetLinuxAccountViewsCall) MaxResults(maxResults int64) *LinuxGetLinuxAccountViewsCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *LinuxGetLinuxAccountViewsCall) OrderBy(orderBy string) *LinuxGetLinuxAccountViewsCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *LinuxGetLinuxAccountViewsCall) PageToken(pageToken string) *LinuxGetLinuxAccountViewsCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LinuxGetLinuxAccountViewsCall) Fields(s ...googleapi.Field) *LinuxGetLinuxAccountViewsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LinuxGetLinuxAccountViewsCall) Context(ctx context.Context) *LinuxGetLinuxAccountViewsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LinuxGetLinuxAccountViewsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("instance", fmt.Sprintf("%v", c.instance))
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/linuxAccountViews")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.linux.getLinuxAccountViews" call.
-// Exactly one of *LinuxGetLinuxAccountViewsResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *LinuxGetLinuxAccountViewsResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *LinuxGetLinuxAccountViewsCall) Do() (*LinuxGetLinuxAccountViewsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &LinuxGetLinuxAccountViewsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of user accounts for an instance within a specific project.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.linux.getLinuxAccountViews",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "instance": {
- // "description": "The fully-qualified URL of the virtual machine requesting the views.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/linuxAccountViews",
- // "response": {
- // "$ref": "LinuxGetLinuxAccountViewsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.addPublicKey":
-
-type UsersAddPublicKeyCall struct {
- s *Service
- project string
- user string
- publickey *PublicKey
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AddPublicKey: Adds a public key to the specified User resource with
-// the data included in the request.
-func (r *UsersService) AddPublicKey(project string, user string, publickey *PublicKey) *UsersAddPublicKeyCall {
- c := &UsersAddPublicKeyCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.user = user
- c.publickey = publickey
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersAddPublicKeyCall) Fields(s ...googleapi.Field) *UsersAddPublicKeyCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersAddPublicKeyCall) Context(ctx context.Context) *UsersAddPublicKeyCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersAddPublicKeyCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.publickey)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users/{user}/addPublicKey")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "user": c.user,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.addPublicKey" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UsersAddPublicKeyCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Adds a public key to the specified User resource with the data included in the request.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.users.addPublicKey",
- // "parameterOrder": [
- // "project",
- // "user"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "user": {
- // "description": "Name of the user for this request.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users/{user}/addPublicKey",
- // "request": {
- // "$ref": "PublicKey"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.delete":
-
-type UsersDeleteCall struct {
- s *Service
- project string
- user string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified User resource.
-func (r *UsersService) Delete(project string, user string) *UsersDeleteCall {
- c := &UsersDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.user = user
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersDeleteCall) Fields(s ...googleapi.Field) *UsersDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersDeleteCall) Context(ctx context.Context) *UsersDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users/{user}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "user": c.user,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UsersDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified User resource.",
- // "httpMethod": "DELETE",
- // "id": "clouduseraccounts.users.delete",
- // "parameterOrder": [
- // "project",
- // "user"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "user": {
- // "description": "Name of the user resource to delete.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users/{user}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.get":
-
-type UsersGetCall struct {
- s *Service
- project string
- user string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified User resource.
-func (r *UsersService) Get(project string, user string) *UsersGetCall {
- c := &UsersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.user = user
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersGetCall) Fields(s ...googleapi.Field) *UsersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UsersGetCall) IfNoneMatch(entityTag string) *UsersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersGetCall) Context(ctx context.Context) *UsersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users/{user}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "user": c.user,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.get" call.
-// Exactly one of *User or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *User.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *UsersGetCall) Do() (*User, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &User{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified User resource.",
- // "httpMethod": "GET",
- // "id": "clouduseraccounts.users.get",
- // "parameterOrder": [
- // "project",
- // "user"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "user": {
- // "description": "Name of the user resource to return.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users/{user}",
- // "response": {
- // "$ref": "User"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.getIamPolicy":
-
-type UsersGetIamPolicyCall struct {
- s *Service
- project string
- resource string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetIamPolicy: Gets the access control policy for a resource. May be
-// empty if no such policy or resource exists.
-func (r *UsersService) GetIamPolicy(project string, resource string) *UsersGetIamPolicyCall {
- c := &UsersGetIamPolicyCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.resource = resource
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersGetIamPolicyCall) Fields(s ...googleapi.Field) *UsersGetIamPolicyCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UsersGetIamPolicyCall) IfNoneMatch(entityTag string) *UsersGetIamPolicyCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersGetIamPolicyCall) Context(ctx context.Context) *UsersGetIamPolicyCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersGetIamPolicyCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users/{resource}/getIamPolicy")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "resource": c.resource,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.getIamPolicy" call.
-// Exactly one of *Policy or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Policy.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *UsersGetIamPolicyCall) Do() (*Policy, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Policy{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
- // "httpMethod": "GET",
- // "id": "clouduseraccounts.users.getIamPolicy",
- // "parameterOrder": [
- // "project",
- // "resource"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "resource": {
- // "description": "Name of the resource for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users/{resource}/getIamPolicy",
- // "response": {
- // "$ref": "Policy"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.insert":
-
-type UsersInsertCall struct {
- s *Service
- project string
- user *User
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a User resource in the specified project using the
-// data included in the request.
-func (r *UsersService) Insert(project string, user *User) *UsersInsertCall {
- c := &UsersInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.user = user
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersInsertCall) Fields(s ...googleapi.Field) *UsersInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersInsertCall) Context(ctx context.Context) *UsersInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.user)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UsersInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a User resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.users.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users",
- // "request": {
- // "$ref": "User"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.list":
-
-type UsersListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of users contained within the specified
-// project.
-func (r *UsersService) List(project string) *UsersListCall {
- c := &UsersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *UsersListCall) Filter(filter string) *UsersListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *UsersListCall) MaxResults(maxResults int64) *UsersListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *UsersListCall) OrderBy(orderBy string) *UsersListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *UsersListCall) PageToken(pageToken string) *UsersListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersListCall) Fields(s ...googleapi.Field) *UsersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UsersListCall) IfNoneMatch(entityTag string) *UsersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersListCall) Context(ctx context.Context) *UsersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.list" call.
-// Exactly one of *UserList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *UserList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UsersListCall) Do() (*UserList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of users contained within the specified project.",
- // "httpMethod": "GET",
- // "id": "clouduseraccounts.users.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users",
- // "response": {
- // "$ref": "UserList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.removePublicKey":
-
-type UsersRemovePublicKeyCall struct {
- s *Service
- project string
- user string
- fingerprint string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// RemovePublicKey: Removes the specified public key from the user.
-func (r *UsersService) RemovePublicKey(project string, user string, fingerprint string) *UsersRemovePublicKeyCall {
- c := &UsersRemovePublicKeyCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.user = user
- c.fingerprint = fingerprint
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersRemovePublicKeyCall) Fields(s ...googleapi.Field) *UsersRemovePublicKeyCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersRemovePublicKeyCall) Context(ctx context.Context) *UsersRemovePublicKeyCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersRemovePublicKeyCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("fingerprint", fmt.Sprintf("%v", c.fingerprint))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users/{user}/removePublicKey")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "user": c.user,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.removePublicKey" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UsersRemovePublicKeyCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Removes the specified public key from the user.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.users.removePublicKey",
- // "parameterOrder": [
- // "project",
- // "user",
- // "fingerprint"
- // ],
- // "parameters": {
- // "fingerprint": {
- // "description": "The fingerprint of the public key to delete. Public keys are identified by their fingerprint, which is defined by RFC4716 to be the MD5 digest of the public key.",
- // "location": "query",
- // "pattern": "[a-f0-9]{32}",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "user": {
- // "description": "Name of the user for this request.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users/{user}/removePublicKey",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.setIamPolicy":
-
-type UsersSetIamPolicyCall struct {
- s *Service
- project string
- resource string
- policy *Policy
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetIamPolicy: Sets the access control policy on the specified
-// resource. Replaces any existing policy.
-func (r *UsersService) SetIamPolicy(project string, resource string, policy *Policy) *UsersSetIamPolicyCall {
- c := &UsersSetIamPolicyCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.resource = resource
- c.policy = policy
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersSetIamPolicyCall) Fields(s ...googleapi.Field) *UsersSetIamPolicyCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersSetIamPolicyCall) Context(ctx context.Context) *UsersSetIamPolicyCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersSetIamPolicyCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.policy)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users/{resource}/setIamPolicy")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "resource": c.resource,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.setIamPolicy" call.
-// Exactly one of *Policy or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Policy.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *UsersSetIamPolicyCall) Do() (*Policy, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Policy{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.users.setIamPolicy",
- // "parameterOrder": [
- // "project",
- // "resource"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "resource": {
- // "description": "Name of the resource for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users/{resource}/setIamPolicy",
- // "request": {
- // "$ref": "Policy"
- // },
- // "response": {
- // "$ref": "Policy"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.testIamPermissions":
-
-type UsersTestIamPermissionsCall struct {
- s *Service
- project string
- resource string
- testpermissionsrequest *TestPermissionsRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// TestIamPermissions: Returns permissions that a caller has on the
-// specified resource.
-func (r *UsersService) TestIamPermissions(project string, resource string, testpermissionsrequest *TestPermissionsRequest) *UsersTestIamPermissionsCall {
- c := &UsersTestIamPermissionsCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.resource = resource
- c.testpermissionsrequest = testpermissionsrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersTestIamPermissionsCall) Fields(s ...googleapi.Field) *UsersTestIamPermissionsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersTestIamPermissionsCall) Context(ctx context.Context) *UsersTestIamPermissionsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersTestIamPermissionsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.testpermissionsrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users/{resource}/testIamPermissions")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "resource": c.resource,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.testIamPermissions" call.
-// Exactly one of *TestPermissionsResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *TestPermissionsResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *UsersTestIamPermissionsCall) Do() (*TestPermissionsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TestPermissionsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns permissions that a caller has on the specified resource.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.users.testIamPermissions",
- // "parameterOrder": [
- // "project",
- // "resource"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "resource": {
- // "description": "Name of the resource for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users/{resource}/testIamPermissions",
- // "request": {
- // "$ref": "TestPermissionsRequest"
- // },
- // "response": {
- // "$ref": "TestPermissionsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/clouduseraccounts/vm_beta/clouduseraccounts-api.json b/vendor/google.golang.org/api/clouduseraccounts/vm_beta/clouduseraccounts-api.json
deleted file mode 100644
index cba1ad01..00000000
--- a/vendor/google.golang.org/api/clouduseraccounts/vm_beta/clouduseraccounts-api.json
+++ /dev/null
@@ -1,1355 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/w-hH-zUDJ75oKTTP-1F8OjQaYyU\"",
- "discoveryVersion": "v1",
- "id": "clouduseraccounts:vm_beta",
- "name": "clouduseraccounts",
- "canonicalName": "Cloud User Accounts",
- "version": "vm_beta",
- "revision": "20150917",
- "title": "Cloud User Accounts API",
- "description": "API for the Google Cloud User Accounts service.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/compute_engine-16.png",
- "x32": "https://www.google.com/images/icons/product/compute_engine-32.png"
- },
- "documentationLink": "https://cloud.google.com/compute/docs/access/user-accounts/api/latest/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/clouduseraccounts/vm_beta/projects/",
- "basePath": "/clouduseraccounts/vm_beta/projects/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "clouduseraccounts/vm_beta/projects/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud.useraccounts": {
- "description": "Manage your Google Cloud User Accounts"
- },
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly": {
- "description": "View your Google Cloud User Accounts"
- }
- }
- }
- },
- "schemas": {
- "AuthorizedKeysView": {
- "id": "AuthorizedKeysView",
- "type": "object",
- "description": "A list of authorized public keys for a user account.",
- "properties": {
- "keys": {
- "type": "array",
- "description": "[Output Only] The list of authorized public keys in SSH format.",
- "items": {
- "type": "string"
- }
- },
- "sudoer": {
- "type": "boolean",
- "description": "[Output Only] Whether the user has the ability to elevate on the instance that requested the authorized keys."
- }
- }
- },
- "Group": {
- "id": "Group",
- "type": "object",
- "description": "A Group resource.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always clouduseraccounts#group for groups.",
- "default": "clouduseraccounts#group"
- },
- "members": {
- "type": "array",
- "description": "[Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.",
- "items": {
- "type": "string"
- }
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created.",
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "annotations": {
- "required": [
- "clouduseraccounts.groups.insert"
- ]
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server defined URL for the resource."
- }
- }
- },
- "GroupList": {
- "id": "GroupList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of Group resources.",
- "items": {
- "$ref": "Group"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always clouduseraccounts#groupList for lists of groups.",
- "default": "clouduseraccounts#groupList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server defined URL for this resource."
- }
- }
- },
- "GroupsAddMemberRequest": {
- "id": "GroupsAddMemberRequest",
- "type": "object",
- "properties": {
- "users": {
- "type": "array",
- "description": "Fully-qualified URLs of the User resources to add.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "GroupsRemoveMemberRequest": {
- "id": "GroupsRemoveMemberRequest",
- "type": "object",
- "properties": {
- "users": {
- "type": "array",
- "description": "Fully-qualified URLs of the User resources to remove.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "LinuxAccountViews": {
- "id": "LinuxAccountViews",
- "type": "object",
- "description": "A list of all Linux accounts for this project. This API is only used by Compute Engine virtual machines to get information about user accounts for a project or instance. Linux resources are read-only views into users and groups managed by the Compute Engine Accounts API.",
- "properties": {
- "groupViews": {
- "type": "array",
- "description": "[Output Only] A list of all groups within a project.",
- "items": {
- "$ref": "LinuxGroupView"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always clouduseraccounts#linuxAccountViews for Linux resources.",
- "default": "clouduseraccounts#linuxAccountViews"
- },
- "userViews": {
- "type": "array",
- "description": "[Output Only] A list of all users within a project.",
- "items": {
- "$ref": "LinuxUserView"
- }
- }
- }
- },
- "LinuxGetAuthorizedKeysViewResponse": {
- "id": "LinuxGetAuthorizedKeysViewResponse",
- "type": "object",
- "properties": {
- "resource": {
- "$ref": "AuthorizedKeysView",
- "description": "[Output Only] A list of authorized public keys for a user."
- }
- }
- },
- "LinuxGetLinuxAccountViewsResponse": {
- "id": "LinuxGetLinuxAccountViewsResponse",
- "type": "object",
- "properties": {
- "resource": {
- "$ref": "LinuxAccountViews",
- "description": "[Output Only] A list of authorized user accounts and groups."
- }
- }
- },
- "LinuxGroupView": {
- "id": "LinuxGroupView",
- "type": "object",
- "description": "A detailed view of a Linux group.",
- "properties": {
- "gid": {
- "type": "integer",
- "description": "[Output Only] The Group ID.",
- "format": "uint32"
- },
- "groupName": {
- "type": "string",
- "description": "[Output Only] Group name."
- },
- "members": {
- "type": "array",
- "description": "[Output Only] List of user accounts that belong to the group.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "LinuxUserView": {
- "id": "LinuxUserView",
- "type": "object",
- "description": "A detailed view of a Linux user account.",
- "properties": {
- "gecos": {
- "type": "string",
- "description": "[Output Only] The GECOS (user information) entry for this account."
- },
- "gid": {
- "type": "integer",
- "description": "[Output Only] User's default group ID.",
- "format": "uint32"
- },
- "homeDirectory": {
- "type": "string",
- "description": "[Output Only] The path to the home directory for this account."
- },
- "shell": {
- "type": "string",
- "description": "[Output Only] The path to the login shell for this account."
- },
- "uid": {
- "type": "integer",
- "description": "[Output Only] User ID.",
- "format": "uint32"
- },
- "username": {
- "type": "string",
- "description": "[Output Only] The username of the account."
- }
- }
- },
- "Operation": {
- "id": "Operation",
- "type": "object",
- "description": "An Operation resource, used to manage asynchronous API requests.",
- "properties": {
- "clientOperationId": {
- "type": "string",
- "description": "[Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "endTime": {
- "type": "string",
- "description": "[Output Only] The time that this operation was completed. This is in RFC3339 text format."
- },
- "error": {
- "type": "object",
- "description": "[Output Only] If errors are generated during processing of the operation, this field will be populated.",
- "properties": {
- "errors": {
- "type": "array",
- "description": "[Output Only] The array of errors encountered while processing this operation.",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The error type identifier for this error."
- },
- "location": {
- "type": "string",
- "description": "[Output Only] Indicates the field in the request which caused the error. This property is optional."
- },
- "message": {
- "type": "string",
- "description": "[Output Only] An optional, human-readable error message."
- }
- }
- }
- }
- }
- },
- "httpErrorMessage": {
- "type": "string",
- "description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND."
- },
- "httpErrorStatusCode": {
- "type": "integer",
- "description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.",
- "format": "int32"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "insertTime": {
- "type": "string",
- "description": "[Output Only] The time that this operation was requested. This is in RFC3339 text format."
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#operation for Operation resources.",
- "default": "clouduseraccounts#operation"
- },
- "name": {
- "type": "string",
- "description": "[Output Only] Name of the resource."
- },
- "operationType": {
- "type": "string",
- "description": "[Output Only] Type of the operation, such as insert, compute.instanceGroups.update, or compute.instanceGroups.delete."
- },
- "progress": {
- "type": "integer",
- "description": "[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.",
- "format": "int32"
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the operation resides. Only applicable for regional resources."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "startTime": {
- "type": "string",
- "description": "[Output Only] The time that this operation was started by the server. This is in RFC3339 text format."
- },
- "status": {
- "type": "string",
- "description": "[Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.",
- "enum": [
- "DONE",
- "PENDING",
- "RUNNING"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "statusMessage": {
- "type": "string",
- "description": "[Output Only] An optional textual description of the current status of the operation."
- },
- "targetId": {
- "type": "string",
- "description": "[Output Only] Unique target ID which identifies a particular incarnation of the target.",
- "format": "uint64"
- },
- "targetLink": {
- "type": "string",
- "description": "[Output Only] URL of the resource the operation is mutating."
- },
- "user": {
- "type": "string",
- "description": "[Output Only] User who requested the operation, for example: user@example.com."
- },
- "warnings": {
- "type": "array",
- "description": "[Output Only] If warning messages are generated during processing of the operation, this field will be populated.",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- },
- "zone": {
- "type": "string",
- "description": "[Output Only] URL of the zone where the operation resides."
- }
- }
- },
- "OperationList": {
- "id": "OperationList",
- "type": "object",
- "description": "Contains a list of Operation resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] The Operation resources.",
- "items": {
- "$ref": "Operation"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#operations for Operations resource.",
- "default": "clouduseraccounts#operationList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncate."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "PublicKey": {
- "id": "PublicKey",
- "type": "object",
- "description": "A public key for authenticating to guests.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "expirationTimestamp": {
- "type": "string",
- "description": "Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires."
- },
- "fingerprint": {
- "type": "string",
- "description": "[Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key."
- },
- "key": {
- "type": "string",
- "description": "Public key text in SSH format, defined by RFC4253 section 6.6."
- }
- }
- },
- "User": {
- "id": "User",
- "type": "object",
- "description": "A User resource.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "groups": {
- "type": "array",
- "description": "[Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always clouduseraccounts#user for users.",
- "default": "clouduseraccounts#user"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created.",
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "annotations": {
- "required": [
- "clouduseraccounts.users.insert"
- ]
- }
- },
- "owner": {
- "type": "string",
- "description": "Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.",
- "annotations": {
- "required": [
- "clouduseraccounts.users.insert"
- ]
- }
- },
- "publicKeys": {
- "type": "array",
- "description": "[Output Only] Public keys that this user may use to login.",
- "items": {
- "$ref": "PublicKey"
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server defined URL for the resource."
- }
- }
- },
- "UserList": {
- "id": "UserList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of User resources.",
- "items": {
- "$ref": "User"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always clouduseraccounts#userList for lists of users.",
- "default": "clouduseraccounts#userList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server defined URL for this resource."
- }
- }
- }
- },
- "resources": {
- "globalAccountsOperations": {
- "methods": {
- "delete": {
- "id": "clouduseraccounts.globalAccountsOperations.delete",
- "path": "{project}/global/operations/{operation}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified operation resource.",
- "parameters": {
- "operation": {
- "type": "string",
- "description": "Name of the Operations resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "operation"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "get": {
- "id": "clouduseraccounts.globalAccountsOperations.get",
- "path": "{project}/global/operations/{operation}",
- "httpMethod": "GET",
- "description": "Retrieves the specified operation resource.",
- "parameters": {
- "operation": {
- "type": "string",
- "description": "Name of the Operations resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "operation"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "list": {
- "id": "clouduseraccounts.globalAccountsOperations.list",
- "path": "{project}/global/operations",
- "httpMethod": "GET",
- "description": "Retrieves the list of operation resources contained within the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "OperationList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- }
- }
- },
- "groups": {
- "methods": {
- "addMember": {
- "id": "clouduseraccounts.groups.addMember",
- "path": "{project}/global/groups/{groupName}/addMember",
- "httpMethod": "POST",
- "description": "Adds users to the specified group.",
- "parameters": {
- "groupName": {
- "type": "string",
- "description": "Name of the group for this request.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "groupName"
- ],
- "request": {
- "$ref": "GroupsAddMemberRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "delete": {
- "id": "clouduseraccounts.groups.delete",
- "path": "{project}/global/groups/{groupName}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified Group resource.",
- "parameters": {
- "groupName": {
- "type": "string",
- "description": "Name of the Group resource to delete.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "groupName"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "get": {
- "id": "clouduseraccounts.groups.get",
- "path": "{project}/global/groups/{groupName}",
- "httpMethod": "GET",
- "description": "Returns the specified Group resource.",
- "parameters": {
- "groupName": {
- "type": "string",
- "description": "Name of the Group resource to return.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "groupName"
- ],
- "response": {
- "$ref": "Group"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "insert": {
- "id": "clouduseraccounts.groups.insert",
- "path": "{project}/global/groups",
- "httpMethod": "POST",
- "description": "Creates a Group resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "Group"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "list": {
- "id": "clouduseraccounts.groups.list",
- "path": "{project}/global/groups",
- "httpMethod": "GET",
- "description": "Retrieves the list of groups contained within the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "GroupList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "removeMember": {
- "id": "clouduseraccounts.groups.removeMember",
- "path": "{project}/global/groups/{groupName}/removeMember",
- "httpMethod": "POST",
- "description": "Removes users from the specified group.",
- "parameters": {
- "groupName": {
- "type": "string",
- "description": "Name of the group for this request.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "groupName"
- ],
- "request": {
- "$ref": "GroupsRemoveMemberRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- }
- }
- },
- "linux": {
- "methods": {
- "getAuthorizedKeysView": {
- "id": "clouduseraccounts.linux.getAuthorizedKeysView",
- "path": "{project}/zones/{zone}/authorizedKeysView/{user}",
- "httpMethod": "POST",
- "description": "Returns a list of authorized public keys for a specific user account.",
- "parameters": {
- "instance": {
- "type": "string",
- "description": "The fully-qualified URL of the virtual machine requesting the view.",
- "required": true,
- "location": "query"
- },
- "login": {
- "type": "boolean",
- "description": "Whether the view was requested as part of a user-initiated login.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "user": {
- "type": "string",
- "description": "The user account for which you want to get a list of authorized public keys.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "user",
- "instance"
- ],
- "response": {
- "$ref": "LinuxGetAuthorizedKeysViewResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "getLinuxAccountViews": {
- "id": "clouduseraccounts.linux.getLinuxAccountViews",
- "path": "{project}/zones/{zone}/linuxAccountViews",
- "httpMethod": "POST",
- "description": "Retrieves a list of user accounts for an instance within a specific project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "instance": {
- "type": "string",
- "description": "The fully-qualified URL of the virtual machine requesting the views.",
- "required": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "response": {
- "$ref": "LinuxGetLinuxAccountViewsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- }
- }
- },
- "users": {
- "methods": {
- "addPublicKey": {
- "id": "clouduseraccounts.users.addPublicKey",
- "path": "{project}/global/users/{user}/addPublicKey",
- "httpMethod": "POST",
- "description": "Adds a public key to the specified User resource with the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "user": {
- "type": "string",
- "description": "Name of the user for this request.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "user"
- ],
- "request": {
- "$ref": "PublicKey"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "delete": {
- "id": "clouduseraccounts.users.delete",
- "path": "{project}/global/users/{user}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified User resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "user": {
- "type": "string",
- "description": "Name of the user resource to delete.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "user"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "get": {
- "id": "clouduseraccounts.users.get",
- "path": "{project}/global/users/{user}",
- "httpMethod": "GET",
- "description": "Returns the specified User resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "user": {
- "type": "string",
- "description": "Name of the user resource to return.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "user"
- ],
- "response": {
- "$ref": "User"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "insert": {
- "id": "clouduseraccounts.users.insert",
- "path": "{project}/global/users",
- "httpMethod": "POST",
- "description": "Creates a User resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "User"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- },
- "list": {
- "id": "clouduseraccounts.users.list",
- "path": "{project}/global/users",
- "httpMethod": "GET",
- "description": "Retrieves a list of users contained within the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "UserList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/cloud.useraccounts",
- "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- ]
- },
- "removePublicKey": {
- "id": "clouduseraccounts.users.removePublicKey",
- "path": "{project}/global/users/{user}/removePublicKey",
- "httpMethod": "POST",
- "description": "Removes the specified public key from the user.",
- "parameters": {
- "fingerprint": {
- "type": "string",
- "description": "The fingerprint of the public key to delete. Public keys are identified by their fingerprint, which is defined by RFC4716 to be the MD5 digest of the public key.",
- "required": true,
- "pattern": "[a-f0-9]{32}",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "user": {
- "type": "string",
- "description": "Name of the user for this request.",
- "required": true,
- "pattern": "[a-z][-a-z0-9_]{0,31}",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "user",
- "fingerprint"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud.useraccounts"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/clouduseraccounts/vm_beta/clouduseraccounts-gen.go b/vendor/google.golang.org/api/clouduseraccounts/vm_beta/clouduseraccounts-gen.go
deleted file mode 100644
index 30075b3c..00000000
--- a/vendor/google.golang.org/api/clouduseraccounts/vm_beta/clouduseraccounts-gen.go
+++ /dev/null
@@ -1,3451 +0,0 @@
-// Package clouduseraccounts provides access to the Cloud User Accounts API.
-//
-// See https://cloud.google.com/compute/docs/access/user-accounts/api/latest/
-//
-// Usage example:
-//
-// import "google.golang.org/api/clouduseraccounts/vm_beta"
-// ...
-// clouduseraccountsService, err := clouduseraccounts.New(oauthHttpClient)
-package clouduseraccounts // import "google.golang.org/api/clouduseraccounts/vm_beta"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "clouduseraccounts:vm_beta"
-const apiName = "clouduseraccounts"
-const apiVersion = "vm_beta"
-const basePath = "https://www.googleapis.com/clouduseraccounts/vm_beta/projects/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your data across Google Cloud Platform services
- CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
-
- // View your data across Google Cloud Platform services
- CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"
-
- // Manage your Google Cloud User Accounts
- CloudUseraccountsScope = "https://www.googleapis.com/auth/cloud.useraccounts"
-
- // View your Google Cloud User Accounts
- CloudUseraccountsReadonlyScope = "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.GlobalAccountsOperations = NewGlobalAccountsOperationsService(s)
- s.Groups = NewGroupsService(s)
- s.Linux = NewLinuxService(s)
- s.Users = NewUsersService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- GlobalAccountsOperations *GlobalAccountsOperationsService
-
- Groups *GroupsService
-
- Linux *LinuxService
-
- Users *UsersService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewGlobalAccountsOperationsService(s *Service) *GlobalAccountsOperationsService {
- rs := &GlobalAccountsOperationsService{s: s}
- return rs
-}
-
-type GlobalAccountsOperationsService struct {
- s *Service
-}
-
-func NewGroupsService(s *Service) *GroupsService {
- rs := &GroupsService{s: s}
- return rs
-}
-
-type GroupsService struct {
- s *Service
-}
-
-func NewLinuxService(s *Service) *LinuxService {
- rs := &LinuxService{s: s}
- return rs
-}
-
-type LinuxService struct {
- s *Service
-}
-
-func NewUsersService(s *Service) *UsersService {
- rs := &UsersService{s: s}
- return rs
-}
-
-type UsersService struct {
- s *Service
-}
-
-// AuthorizedKeysView: A list of authorized public keys for a user
-// account.
-type AuthorizedKeysView struct {
- // Keys: [Output Only] The list of authorized public keys in SSH format.
- Keys []string `json:"keys,omitempty"`
-
- // Sudoer: [Output Only] Whether the user has the ability to elevate on
- // the instance that requested the authorized keys.
- Sudoer bool `json:"sudoer,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Keys") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AuthorizedKeysView) MarshalJSON() ([]byte, error) {
- type noMethod AuthorizedKeysView
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Group: A Group resource.
-type Group struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always
- // clouduseraccounts#group for groups.
- Kind string `json:"kind,omitempty"`
-
- // Members: [Output Only] A list of URLs to User resources who belong to
- // the group. Users may only be members of groups in the same project.
- Members []string `json:"members,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created.
- Name string `json:"name,omitempty"`
-
- // SelfLink: [Output Only] Server defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Group) MarshalJSON() ([]byte, error) {
- type noMethod Group
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GroupList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of Group resources.
- Items []*Group `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always
- // clouduseraccounts#groupList for lists of groups.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GroupList) MarshalJSON() ([]byte, error) {
- type noMethod GroupList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GroupsAddMemberRequest struct {
- // Users: Fully-qualified URLs of the User resources to add.
- Users []string `json:"users,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Users") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GroupsAddMemberRequest) MarshalJSON() ([]byte, error) {
- type noMethod GroupsAddMemberRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type GroupsRemoveMemberRequest struct {
- // Users: Fully-qualified URLs of the User resources to remove.
- Users []string `json:"users,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Users") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GroupsRemoveMemberRequest) MarshalJSON() ([]byte, error) {
- type noMethod GroupsRemoveMemberRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LinuxAccountViews: A list of all Linux accounts for this project.
-// This API is only used by Compute Engine virtual machines to get
-// information about user accounts for a project or instance. Linux
-// resources are read-only views into users and groups managed by the
-// Compute Engine Accounts API.
-type LinuxAccountViews struct {
- // GroupViews: [Output Only] A list of all groups within a project.
- GroupViews []*LinuxGroupView `json:"groupViews,omitempty"`
-
- // Kind: [Output Only] Type of the resource. Always
- // clouduseraccounts#linuxAccountViews for Linux resources.
- Kind string `json:"kind,omitempty"`
-
- // UserViews: [Output Only] A list of all users within a project.
- UserViews []*LinuxUserView `json:"userViews,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "GroupViews") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LinuxAccountViews) MarshalJSON() ([]byte, error) {
- type noMethod LinuxAccountViews
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type LinuxGetAuthorizedKeysViewResponse struct {
- // Resource: [Output Only] A list of authorized public keys for a user.
- Resource *AuthorizedKeysView `json:"resource,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Resource") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LinuxGetAuthorizedKeysViewResponse) MarshalJSON() ([]byte, error) {
- type noMethod LinuxGetAuthorizedKeysViewResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type LinuxGetLinuxAccountViewsResponse struct {
- // Resource: [Output Only] A list of authorized user accounts and
- // groups.
- Resource *LinuxAccountViews `json:"resource,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Resource") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LinuxGetLinuxAccountViewsResponse) MarshalJSON() ([]byte, error) {
- type noMethod LinuxGetLinuxAccountViewsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LinuxGroupView: A detailed view of a Linux group.
-type LinuxGroupView struct {
- // Gid: [Output Only] The Group ID.
- Gid int64 `json:"gid,omitempty"`
-
- // GroupName: [Output Only] Group name.
- GroupName string `json:"groupName,omitempty"`
-
- // Members: [Output Only] List of user accounts that belong to the
- // group.
- Members []string `json:"members,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Gid") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LinuxGroupView) MarshalJSON() ([]byte, error) {
- type noMethod LinuxGroupView
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LinuxUserView: A detailed view of a Linux user account.
-type LinuxUserView struct {
- // Gecos: [Output Only] The GECOS (user information) entry for this
- // account.
- Gecos string `json:"gecos,omitempty"`
-
- // Gid: [Output Only] User's default group ID.
- Gid int64 `json:"gid,omitempty"`
-
- // HomeDirectory: [Output Only] The path to the home directory for this
- // account.
- HomeDirectory string `json:"homeDirectory,omitempty"`
-
- // Shell: [Output Only] The path to the login shell for this account.
- Shell string `json:"shell,omitempty"`
-
- // Uid: [Output Only] User ID.
- Uid int64 `json:"uid,omitempty"`
-
- // Username: [Output Only] The username of the account.
- Username string `json:"username,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Gecos") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LinuxUserView) MarshalJSON() ([]byte, error) {
- type noMethod LinuxUserView
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Operation: An Operation resource, used to manage asynchronous API
-// requests.
-type Operation struct {
- // ClientOperationId: [Output Only] An optional identifier specified by
- // the client when the mutation was initiated. Must be unique for all
- // Operation resources in the project.
- ClientOperationId string `json:"clientOperationId,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // EndTime: [Output Only] The time that this operation was completed.
- // This is in RFC3339 text format.
- EndTime string `json:"endTime,omitempty"`
-
- // Error: [Output Only] If errors are generated during processing of the
- // operation, this field will be populated.
- Error *OperationError `json:"error,omitempty"`
-
- // HttpErrorMessage: [Output Only] If the operation fails, this field
- // contains the HTTP error message that was returned, such as NOT FOUND.
- HttpErrorMessage string `json:"httpErrorMessage,omitempty"`
-
- // HttpErrorStatusCode: [Output Only] If the operation fails, this field
- // contains the HTTP error message that was returned, such as 404.
- HttpErrorStatusCode int64 `json:"httpErrorStatusCode,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // InsertTime: [Output Only] The time that this operation was requested.
- // This is in RFC3339 text format.
- InsertTime string `json:"insertTime,omitempty"`
-
- // Kind: [Output Only] Type of the resource. Always compute#operation
- // for Operation resources.
- Kind string `json:"kind,omitempty"`
-
- // Name: [Output Only] Name of the resource.
- Name string `json:"name,omitempty"`
-
- // OperationType: [Output Only] Type of the operation, such as insert,
- // compute.instanceGroups.update, or compute.instanceGroups.delete.
- OperationType string `json:"operationType,omitempty"`
-
- // Progress: [Output Only] An optional progress indicator that ranges
- // from 0 to 100. There is no requirement that this be linear or support
- // any granularity of operations. This should not be used to guess at
- // when the operation will be complete. This number should monotonically
- // increase as the operation progresses.
- Progress int64 `json:"progress,omitempty"`
-
- // Region: [Output Only] URL of the region where the operation resides.
- // Only applicable for regional resources.
- Region string `json:"region,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // StartTime: [Output Only] The time that this operation was started by
- // the server. This is in RFC3339 text format.
- StartTime string `json:"startTime,omitempty"`
-
- // Status: [Output Only] Status of the operation. Can be one of the
- // following: PENDING, RUNNING, or DONE.
- //
- // Possible values:
- // "DONE"
- // "PENDING"
- // "RUNNING"
- Status string `json:"status,omitempty"`
-
- // StatusMessage: [Output Only] An optional textual description of the
- // current status of the operation.
- StatusMessage string `json:"statusMessage,omitempty"`
-
- // TargetId: [Output Only] Unique target ID which identifies a
- // particular incarnation of the target.
- TargetId uint64 `json:"targetId,omitempty,string"`
-
- // TargetLink: [Output Only] URL of the resource the operation is
- // mutating.
- TargetLink string `json:"targetLink,omitempty"`
-
- // User: [Output Only] User who requested the operation, for example:
- // user@example.com.
- User string `json:"user,omitempty"`
-
- // Warnings: [Output Only] If warning messages are generated during
- // processing of the operation, this field will be populated.
- Warnings []*OperationWarnings `json:"warnings,omitempty"`
-
- // Zone: [Output Only] URL of the zone where the operation resides.
- Zone string `json:"zone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ClientOperationId")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Operation) MarshalJSON() ([]byte, error) {
- type noMethod Operation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperationError: [Output Only] If errors are generated during
-// processing of the operation, this field will be populated.
-type OperationError struct {
- // Errors: [Output Only] The array of errors encountered while
- // processing this operation.
- Errors []*OperationErrorErrors `json:"errors,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Errors") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationError) MarshalJSON() ([]byte, error) {
- type noMethod OperationError
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationErrorErrors struct {
- // Code: [Output Only] The error type identifier for this error.
- Code string `json:"code,omitempty"`
-
- // Location: [Output Only] Indicates the field in the request which
- // caused the error. This property is optional.
- Location string `json:"location,omitempty"`
-
- // Message: [Output Only] An optional, human-readable error message.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationErrorErrors) MarshalJSON() ([]byte, error) {
- type noMethod OperationErrorErrors
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationWarnings struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*OperationWarningsData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationWarnings) MarshalJSON() ([]byte, error) {
- type noMethod OperationWarnings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationWarningsData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationWarningsData) MarshalJSON() ([]byte, error) {
- type noMethod OperationWarningsData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperationList: Contains a list of Operation resources.
-type OperationList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] The Operation resources.
- Items []*Operation `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#operations for
- // Operations resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncate.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationList) MarshalJSON() ([]byte, error) {
- type noMethod OperationList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PublicKey: A public key for authenticating to guests.
-type PublicKey struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // ExpirationTimestamp: Optional expiration timestamp. If provided, the
- // timestamp must be in RFC3339 text format. If not provided, the public
- // key never expires.
- ExpirationTimestamp string `json:"expirationTimestamp,omitempty"`
-
- // Fingerprint: [Output Only] The fingerprint of the key is defined by
- // RFC4716 to be the MD5 digest of the public key.
- Fingerprint string `json:"fingerprint,omitempty"`
-
- // Key: Public key text in SSH format, defined by RFC4253 section 6.6.
- Key string `json:"key,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PublicKey) MarshalJSON() ([]byte, error) {
- type noMethod PublicKey
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// User: A User resource.
-type User struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Groups: [Output Only] A list of URLs to Group resources who contain
- // the user. Users are only members of groups in the same project.
- Groups []string `json:"groups,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always
- // clouduseraccounts#user for users.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created.
- Name string `json:"name,omitempty"`
-
- // Owner: Email address of account's owner. This account will be
- // validated to make sure it exists. The email can belong to any domain,
- // but it must be tied to a Google account.
- Owner string `json:"owner,omitempty"`
-
- // PublicKeys: [Output Only] Public keys that this user may use to
- // login.
- PublicKeys []*PublicKey `json:"publicKeys,omitempty"`
-
- // SelfLink: [Output Only] Server defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *User) MarshalJSON() ([]byte, error) {
- type noMethod User
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UserList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of User resources.
- Items []*User `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always
- // clouduseraccounts#userList for lists of users.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserList) MarshalJSON() ([]byte, error) {
- type noMethod UserList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "clouduseraccounts.globalAccountsOperations.delete":
-
-type GlobalAccountsOperationsDeleteCall struct {
- s *Service
- project string
- operation string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified operation resource.
-func (r *GlobalAccountsOperationsService) Delete(project string, operation string) *GlobalAccountsOperationsDeleteCall {
- c := &GlobalAccountsOperationsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.operation = operation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalAccountsOperationsDeleteCall) Fields(s ...googleapi.Field) *GlobalAccountsOperationsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalAccountsOperationsDeleteCall) Context(ctx context.Context) *GlobalAccountsOperationsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalAccountsOperationsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/operations/{operation}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "operation": c.operation,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.globalAccountsOperations.delete" call.
-func (c *GlobalAccountsOperationsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes the specified operation resource.",
- // "httpMethod": "DELETE",
- // "id": "clouduseraccounts.globalAccountsOperations.delete",
- // "parameterOrder": [
- // "project",
- // "operation"
- // ],
- // "parameters": {
- // "operation": {
- // "description": "Name of the Operations resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/operations/{operation}",
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.globalAccountsOperations.get":
-
-type GlobalAccountsOperationsGetCall struct {
- s *Service
- project string
- operation string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves the specified operation resource.
-func (r *GlobalAccountsOperationsService) Get(project string, operation string) *GlobalAccountsOperationsGetCall {
- c := &GlobalAccountsOperationsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.operation = operation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalAccountsOperationsGetCall) Fields(s ...googleapi.Field) *GlobalAccountsOperationsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GlobalAccountsOperationsGetCall) IfNoneMatch(entityTag string) *GlobalAccountsOperationsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalAccountsOperationsGetCall) Context(ctx context.Context) *GlobalAccountsOperationsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalAccountsOperationsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/operations/{operation}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "operation": c.operation,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.globalAccountsOperations.get" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GlobalAccountsOperationsGetCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the specified operation resource.",
- // "httpMethod": "GET",
- // "id": "clouduseraccounts.globalAccountsOperations.get",
- // "parameterOrder": [
- // "project",
- // "operation"
- // ],
- // "parameters": {
- // "operation": {
- // "description": "Name of the Operations resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/operations/{operation}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.globalAccountsOperations.list":
-
-type GlobalAccountsOperationsListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of operation resources contained within the
-// specified project.
-func (r *GlobalAccountsOperationsService) List(project string) *GlobalAccountsOperationsListCall {
- c := &GlobalAccountsOperationsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *GlobalAccountsOperationsListCall) Filter(filter string) *GlobalAccountsOperationsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *GlobalAccountsOperationsListCall) MaxResults(maxResults int64) *GlobalAccountsOperationsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *GlobalAccountsOperationsListCall) OrderBy(orderBy string) *GlobalAccountsOperationsListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *GlobalAccountsOperationsListCall) PageToken(pageToken string) *GlobalAccountsOperationsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalAccountsOperationsListCall) Fields(s ...googleapi.Field) *GlobalAccountsOperationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GlobalAccountsOperationsListCall) IfNoneMatch(entityTag string) *GlobalAccountsOperationsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalAccountsOperationsListCall) Context(ctx context.Context) *GlobalAccountsOperationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalAccountsOperationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/operations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.globalAccountsOperations.list" call.
-// Exactly one of *OperationList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *OperationList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *GlobalAccountsOperationsListCall) Do() (*OperationList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OperationList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of operation resources contained within the specified project.",
- // "httpMethod": "GET",
- // "id": "clouduseraccounts.globalAccountsOperations.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/operations",
- // "response": {
- // "$ref": "OperationList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.addMember":
-
-type GroupsAddMemberCall struct {
- s *Service
- project string
- groupName string
- groupsaddmemberrequest *GroupsAddMemberRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AddMember: Adds users to the specified group.
-func (r *GroupsService) AddMember(project string, groupName string, groupsaddmemberrequest *GroupsAddMemberRequest) *GroupsAddMemberCall {
- c := &GroupsAddMemberCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.groupName = groupName
- c.groupsaddmemberrequest = groupsaddmemberrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsAddMemberCall) Fields(s ...googleapi.Field) *GroupsAddMemberCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsAddMemberCall) Context(ctx context.Context) *GroupsAddMemberCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsAddMemberCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.groupsaddmemberrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups/{groupName}/addMember")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "groupName": c.groupName,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.addMember" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GroupsAddMemberCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Adds users to the specified group.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.groups.addMember",
- // "parameterOrder": [
- // "project",
- // "groupName"
- // ],
- // "parameters": {
- // "groupName": {
- // "description": "Name of the group for this request.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups/{groupName}/addMember",
- // "request": {
- // "$ref": "GroupsAddMemberRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.delete":
-
-type GroupsDeleteCall struct {
- s *Service
- project string
- groupName string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified Group resource.
-func (r *GroupsService) Delete(project string, groupName string) *GroupsDeleteCall {
- c := &GroupsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.groupName = groupName
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsDeleteCall) Fields(s ...googleapi.Field) *GroupsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsDeleteCall) Context(ctx context.Context) *GroupsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups/{groupName}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "groupName": c.groupName,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GroupsDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified Group resource.",
- // "httpMethod": "DELETE",
- // "id": "clouduseraccounts.groups.delete",
- // "parameterOrder": [
- // "project",
- // "groupName"
- // ],
- // "parameters": {
- // "groupName": {
- // "description": "Name of the Group resource to delete.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups/{groupName}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.get":
-
-type GroupsGetCall struct {
- s *Service
- project string
- groupName string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified Group resource.
-func (r *GroupsService) Get(project string, groupName string) *GroupsGetCall {
- c := &GroupsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.groupName = groupName
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsGetCall) Fields(s ...googleapi.Field) *GroupsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GroupsGetCall) IfNoneMatch(entityTag string) *GroupsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsGetCall) Context(ctx context.Context) *GroupsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups/{groupName}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "groupName": c.groupName,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.get" call.
-// Exactly one of *Group or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Group.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *GroupsGetCall) Do() (*Group, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Group{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified Group resource.",
- // "httpMethod": "GET",
- // "id": "clouduseraccounts.groups.get",
- // "parameterOrder": [
- // "project",
- // "groupName"
- // ],
- // "parameters": {
- // "groupName": {
- // "description": "Name of the Group resource to return.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups/{groupName}",
- // "response": {
- // "$ref": "Group"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.insert":
-
-type GroupsInsertCall struct {
- s *Service
- project string
- group *Group
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a Group resource in the specified project using the
-// data included in the request.
-func (r *GroupsService) Insert(project string, group *Group) *GroupsInsertCall {
- c := &GroupsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.group = group
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsInsertCall) Fields(s ...googleapi.Field) *GroupsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsInsertCall) Context(ctx context.Context) *GroupsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.group)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GroupsInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a Group resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.groups.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups",
- // "request": {
- // "$ref": "Group"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.list":
-
-type GroupsListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of groups contained within the specified
-// project.
-func (r *GroupsService) List(project string) *GroupsListCall {
- c := &GroupsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *GroupsListCall) Filter(filter string) *GroupsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *GroupsListCall) MaxResults(maxResults int64) *GroupsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *GroupsListCall) OrderBy(orderBy string) *GroupsListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *GroupsListCall) PageToken(pageToken string) *GroupsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsListCall) Fields(s ...googleapi.Field) *GroupsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GroupsListCall) IfNoneMatch(entityTag string) *GroupsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsListCall) Context(ctx context.Context) *GroupsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.list" call.
-// Exactly one of *GroupList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *GroupList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GroupsListCall) Do() (*GroupList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &GroupList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of groups contained within the specified project.",
- // "httpMethod": "GET",
- // "id": "clouduseraccounts.groups.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups",
- // "response": {
- // "$ref": "GroupList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.groups.removeMember":
-
-type GroupsRemoveMemberCall struct {
- s *Service
- project string
- groupName string
- groupsremovememberrequest *GroupsRemoveMemberRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// RemoveMember: Removes users from the specified group.
-func (r *GroupsService) RemoveMember(project string, groupName string, groupsremovememberrequest *GroupsRemoveMemberRequest) *GroupsRemoveMemberCall {
- c := &GroupsRemoveMemberCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.groupName = groupName
- c.groupsremovememberrequest = groupsremovememberrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GroupsRemoveMemberCall) Fields(s ...googleapi.Field) *GroupsRemoveMemberCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GroupsRemoveMemberCall) Context(ctx context.Context) *GroupsRemoveMemberCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GroupsRemoveMemberCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.groupsremovememberrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/groups/{groupName}/removeMember")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "groupName": c.groupName,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.groups.removeMember" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GroupsRemoveMemberCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Removes users from the specified group.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.groups.removeMember",
- // "parameterOrder": [
- // "project",
- // "groupName"
- // ],
- // "parameters": {
- // "groupName": {
- // "description": "Name of the group for this request.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/groups/{groupName}/removeMember",
- // "request": {
- // "$ref": "GroupsRemoveMemberRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.linux.getAuthorizedKeysView":
-
-type LinuxGetAuthorizedKeysViewCall struct {
- s *Service
- project string
- zone string
- user string
- instance string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetAuthorizedKeysView: Returns a list of authorized public keys for a
-// specific user account.
-func (r *LinuxService) GetAuthorizedKeysView(project string, zone string, user string, instance string) *LinuxGetAuthorizedKeysViewCall {
- c := &LinuxGetAuthorizedKeysViewCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.user = user
- c.instance = instance
- return c
-}
-
-// Login sets the optional parameter "login": Whether the view was
-// requested as part of a user-initiated login.
-func (c *LinuxGetAuthorizedKeysViewCall) Login(login bool) *LinuxGetAuthorizedKeysViewCall {
- c.opt_["login"] = login
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LinuxGetAuthorizedKeysViewCall) Fields(s ...googleapi.Field) *LinuxGetAuthorizedKeysViewCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LinuxGetAuthorizedKeysViewCall) Context(ctx context.Context) *LinuxGetAuthorizedKeysViewCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LinuxGetAuthorizedKeysViewCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("instance", fmt.Sprintf("%v", c.instance))
- if v, ok := c.opt_["login"]; ok {
- params.Set("login", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/authorizedKeysView/{user}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "user": c.user,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.linux.getAuthorizedKeysView" call.
-// Exactly one of *LinuxGetAuthorizedKeysViewResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *LinuxGetAuthorizedKeysViewResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *LinuxGetAuthorizedKeysViewCall) Do() (*LinuxGetAuthorizedKeysViewResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &LinuxGetAuthorizedKeysViewResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns a list of authorized public keys for a specific user account.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.linux.getAuthorizedKeysView",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "user",
- // "instance"
- // ],
- // "parameters": {
- // "instance": {
- // "description": "The fully-qualified URL of the virtual machine requesting the view.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "login": {
- // "description": "Whether the view was requested as part of a user-initiated login.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "user": {
- // "description": "The user account for which you want to get a list of authorized public keys.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/authorizedKeysView/{user}",
- // "response": {
- // "$ref": "LinuxGetAuthorizedKeysViewResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.linux.getLinuxAccountViews":
-
-type LinuxGetLinuxAccountViewsCall struct {
- s *Service
- project string
- zone string
- instance string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetLinuxAccountViews: Retrieves a list of user accounts for an
-// instance within a specific project.
-func (r *LinuxService) GetLinuxAccountViews(project string, zone string, instance string) *LinuxGetLinuxAccountViewsCall {
- c := &LinuxGetLinuxAccountViewsCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *LinuxGetLinuxAccountViewsCall) Filter(filter string) *LinuxGetLinuxAccountViewsCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *LinuxGetLinuxAccountViewsCall) MaxResults(maxResults int64) *LinuxGetLinuxAccountViewsCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *LinuxGetLinuxAccountViewsCall) OrderBy(orderBy string) *LinuxGetLinuxAccountViewsCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *LinuxGetLinuxAccountViewsCall) PageToken(pageToken string) *LinuxGetLinuxAccountViewsCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LinuxGetLinuxAccountViewsCall) Fields(s ...googleapi.Field) *LinuxGetLinuxAccountViewsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LinuxGetLinuxAccountViewsCall) Context(ctx context.Context) *LinuxGetLinuxAccountViewsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LinuxGetLinuxAccountViewsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("instance", fmt.Sprintf("%v", c.instance))
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/linuxAccountViews")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.linux.getLinuxAccountViews" call.
-// Exactly one of *LinuxGetLinuxAccountViewsResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *LinuxGetLinuxAccountViewsResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *LinuxGetLinuxAccountViewsCall) Do() (*LinuxGetLinuxAccountViewsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &LinuxGetLinuxAccountViewsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of user accounts for an instance within a specific project.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.linux.getLinuxAccountViews",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "instance": {
- // "description": "The fully-qualified URL of the virtual machine requesting the views.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/linuxAccountViews",
- // "response": {
- // "$ref": "LinuxGetLinuxAccountViewsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.addPublicKey":
-
-type UsersAddPublicKeyCall struct {
- s *Service
- project string
- user string
- publickey *PublicKey
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AddPublicKey: Adds a public key to the specified User resource with
-// the data included in the request.
-func (r *UsersService) AddPublicKey(project string, user string, publickey *PublicKey) *UsersAddPublicKeyCall {
- c := &UsersAddPublicKeyCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.user = user
- c.publickey = publickey
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersAddPublicKeyCall) Fields(s ...googleapi.Field) *UsersAddPublicKeyCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersAddPublicKeyCall) Context(ctx context.Context) *UsersAddPublicKeyCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersAddPublicKeyCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.publickey)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users/{user}/addPublicKey")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "user": c.user,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.addPublicKey" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UsersAddPublicKeyCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Adds a public key to the specified User resource with the data included in the request.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.users.addPublicKey",
- // "parameterOrder": [
- // "project",
- // "user"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "user": {
- // "description": "Name of the user for this request.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users/{user}/addPublicKey",
- // "request": {
- // "$ref": "PublicKey"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.delete":
-
-type UsersDeleteCall struct {
- s *Service
- project string
- user string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified User resource.
-func (r *UsersService) Delete(project string, user string) *UsersDeleteCall {
- c := &UsersDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.user = user
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersDeleteCall) Fields(s ...googleapi.Field) *UsersDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersDeleteCall) Context(ctx context.Context) *UsersDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users/{user}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "user": c.user,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UsersDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified User resource.",
- // "httpMethod": "DELETE",
- // "id": "clouduseraccounts.users.delete",
- // "parameterOrder": [
- // "project",
- // "user"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "user": {
- // "description": "Name of the user resource to delete.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users/{user}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.get":
-
-type UsersGetCall struct {
- s *Service
- project string
- user string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified User resource.
-func (r *UsersService) Get(project string, user string) *UsersGetCall {
- c := &UsersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.user = user
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersGetCall) Fields(s ...googleapi.Field) *UsersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UsersGetCall) IfNoneMatch(entityTag string) *UsersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersGetCall) Context(ctx context.Context) *UsersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users/{user}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "user": c.user,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.get" call.
-// Exactly one of *User or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *User.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *UsersGetCall) Do() (*User, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &User{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified User resource.",
- // "httpMethod": "GET",
- // "id": "clouduseraccounts.users.get",
- // "parameterOrder": [
- // "project",
- // "user"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "user": {
- // "description": "Name of the user resource to return.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users/{user}",
- // "response": {
- // "$ref": "User"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.insert":
-
-type UsersInsertCall struct {
- s *Service
- project string
- user *User
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a User resource in the specified project using the
-// data included in the request.
-func (r *UsersService) Insert(project string, user *User) *UsersInsertCall {
- c := &UsersInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.user = user
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersInsertCall) Fields(s ...googleapi.Field) *UsersInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersInsertCall) Context(ctx context.Context) *UsersInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.user)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UsersInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a User resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.users.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users",
- // "request": {
- // "$ref": "User"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.list":
-
-type UsersListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of users contained within the specified
-// project.
-func (r *UsersService) List(project string) *UsersListCall {
- c := &UsersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *UsersListCall) Filter(filter string) *UsersListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *UsersListCall) MaxResults(maxResults int64) *UsersListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *UsersListCall) OrderBy(orderBy string) *UsersListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *UsersListCall) PageToken(pageToken string) *UsersListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersListCall) Fields(s ...googleapi.Field) *UsersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UsersListCall) IfNoneMatch(entityTag string) *UsersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersListCall) Context(ctx context.Context) *UsersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.list" call.
-// Exactly one of *UserList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *UserList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UsersListCall) Do() (*UserList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of users contained within the specified project.",
- // "httpMethod": "GET",
- // "id": "clouduseraccounts.users.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users",
- // "response": {
- // "$ref": "UserList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/cloud.useraccounts",
- // "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
- // ]
- // }
-
-}
-
-// method id "clouduseraccounts.users.removePublicKey":
-
-type UsersRemovePublicKeyCall struct {
- s *Service
- project string
- user string
- fingerprint string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// RemovePublicKey: Removes the specified public key from the user.
-func (r *UsersService) RemovePublicKey(project string, user string, fingerprint string) *UsersRemovePublicKeyCall {
- c := &UsersRemovePublicKeyCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.user = user
- c.fingerprint = fingerprint
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UsersRemovePublicKeyCall) Fields(s ...googleapi.Field) *UsersRemovePublicKeyCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UsersRemovePublicKeyCall) Context(ctx context.Context) *UsersRemovePublicKeyCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UsersRemovePublicKeyCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("fingerprint", fmt.Sprintf("%v", c.fingerprint))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/users/{user}/removePublicKey")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "user": c.user,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "clouduseraccounts.users.removePublicKey" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UsersRemovePublicKeyCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Removes the specified public key from the user.",
- // "httpMethod": "POST",
- // "id": "clouduseraccounts.users.removePublicKey",
- // "parameterOrder": [
- // "project",
- // "user",
- // "fingerprint"
- // ],
- // "parameters": {
- // "fingerprint": {
- // "description": "The fingerprint of the public key to delete. Public keys are identified by their fingerprint, which is defined by RFC4716 to be the MD5 digest of the public key.",
- // "location": "query",
- // "pattern": "[a-f0-9]{32}",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "user": {
- // "description": "Name of the user for this request.",
- // "location": "path",
- // "pattern": "[a-z][-a-z0-9_]{0,31}",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/users/{user}/removePublicKey",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud.useraccounts"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/compute/v0.beta/compute-api.json b/vendor/google.golang.org/api/compute/v0.beta/compute-api.json
deleted file mode 100644
index 4a803f04..00000000
--- a/vendor/google.golang.org/api/compute/v0.beta/compute-api.json
+++ /dev/null
@@ -1,14405 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/53Hy10U_as1pSFK_KirJ2eQZmGA\"",
- "discoveryVersion": "v1",
- "id": "compute:beta",
- "name": "compute",
- "version": "beta",
- "revision": "20151015",
- "title": "Compute Engine API",
- "description": "API for the Google Compute Engine service.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/compute_engine-16.png",
- "x32": "https://www.google.com/images/icons/product/compute_engine-32.png"
- },
- "documentationLink": "https://developers.google.com/compute/docs/reference/latest/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/compute/beta/projects/",
- "basePath": "/compute/beta/projects/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "compute/beta/projects/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/compute": {
- "description": "View and manage your Google Compute Engine resources"
- },
- "https://www.googleapis.com/auth/compute.readonly": {
- "description": "View your Google Compute Engine resources"
- },
- "https://www.googleapis.com/auth/devstorage.full_control": {
- "description": "Manage your data and permissions in Google Cloud Storage"
- },
- "https://www.googleapis.com/auth/devstorage.read_only": {
- "description": "View your data in Google Cloud Storage"
- },
- "https://www.googleapis.com/auth/devstorage.read_write": {
- "description": "Manage your data in Google Cloud Storage"
- }
- }
- }
- },
- "schemas": {
- "AccessConfig": {
- "id": "AccessConfig",
- "type": "object",
- "description": "An access configuration attached to an instance's network interface.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#accessConfig for access configs.",
- "default": "compute#accessConfig"
- },
- "name": {
- "type": "string",
- "description": "Name of this access configuration."
- },
- "natIP": {
- "type": "string",
- "description": "An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance."
- },
- "type": {
- "type": "string",
- "description": "The type of configuration. The default and only option is ONE_TO_ONE_NAT.",
- "default": "ONE_TO_ONE_NAT",
- "enum": [
- "ONE_TO_ONE_NAT"
- ],
- "enumDescriptions": [
- ""
- ]
- }
- }
- },
- "Address": {
- "id": "Address",
- "type": "object",
- "description": "A reserved address resource.",
- "properties": {
- "address": {
- "type": "string",
- "description": "The static external IP address represented by this resource."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#address for addresses.",
- "default": "compute#address"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.addresses.insert"
- ]
- }
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "status": {
- "type": "string",
- "description": "[Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.",
- "enum": [
- "IN_USE",
- "RESERVED"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "users": {
- "type": "array",
- "description": "[Output Only] The URLs of the resources that are using this address.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "AddressAggregatedList": {
- "id": "AddressAggregatedList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "object",
- "description": "[Output Only] A map of scoped address lists.",
- "additionalProperties": {
- "$ref": "AddressesScopedList",
- "description": "[Output Only] Name of the scope containing this set of addresses."
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses.",
- "default": "compute#addressAggregatedList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "AddressList": {
- "id": "AddressList",
- "type": "object",
- "description": "Contains a list of address resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of Address resources.",
- "items": {
- "$ref": "Address"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#addressList for lists of addresses.",
- "default": "compute#addressList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- }
- }
- },
- "AddressesScopedList": {
- "id": "AddressesScopedList",
- "type": "object",
- "properties": {
- "addresses": {
- "type": "array",
- "description": "[Output Only] List of addresses contained in this scope.",
- "items": {
- "$ref": "Address"
- }
- },
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning which replaces the list of addresses when the list is empty.",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- },
- "AttachedDisk": {
- "id": "AttachedDisk",
- "type": "object",
- "description": "An instance-attached disk resource.",
- "properties": {
- "autoDelete": {
- "type": "boolean",
- "description": "Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance)."
- },
- "boot": {
- "type": "boolean",
- "description": "Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem."
- },
- "deviceName": {
- "type": "string",
- "description": "Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.\n\nIf not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks."
- },
- "diskEncryptionKey": {
- "$ref": "CustomerEncryptionKey",
- "description": "Encrypts or decrypts a disk using a customer-supplied encryption key.\n\nIf you are creating a new disk, this field encrypts the disk using a customer-supplied encryption key. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.\n\nIf you encrypt a new disk using a customer-supplied encryption key, you must provide the same key again when attempting to use this resource at a later time (e.g. to create a snapshot or image from the disk or to attach the disk to a virtual machine).\n\nIf no customer-supplied encryption key is provided at creation, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later."
- },
- "index": {
- "type": "integer",
- "description": "Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.",
- "format": "int32"
- },
- "initializeParams": {
- "$ref": "AttachedDiskInitializeParams",
- "description": "[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.\n\nThis property is mutually exclusive with the source property; you can only define one or the other, but not both."
- },
- "interface": {
- "type": "string",
- "description": "Specifies the disk interface to use for attaching this disk, either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.",
- "enum": [
- "NVME",
- "SCSI"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.",
- "default": "compute#attachedDisk"
- },
- "licenses": {
- "type": "array",
- "description": "[Output Only] Any valid publicly visible licenses.",
- "items": {
- "type": "string"
- }
- },
- "mode": {
- "type": "string",
- "description": "The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.",
- "enum": [
- "READ_ONLY",
- "READ_WRITE"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "source": {
- "type": "string",
- "description": "Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks."
- },
- "type": {
- "type": "string",
- "description": "Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.",
- "enum": [
- "PERSISTENT",
- "SCRATCH"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "annotations": {
- "required": [
- "compute.instances.insert"
- ]
- }
- }
- }
- },
- "AttachedDiskInitializeParams": {
- "id": "AttachedDiskInitializeParams",
- "type": "object",
- "description": "[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.\n\nThis property is mutually exclusive with the source property; you can only define one or the other, but not both.",
- "properties": {
- "diskName": {
- "type": "string",
- "description": "Specifies the disk name. If not specified, the default is to use the name of the instance."
- },
- "diskSizeGb": {
- "type": "string",
- "description": "Specifies the size of the disk in base-2 GB.",
- "format": "int64"
- },
- "diskStorageType": {
- "type": "string",
- "description": "Storage type of the disk.",
- "enum": [
- "HDD",
- "SSD"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "diskType": {
- "type": "string",
- "description": "Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:\n\nhttps://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard \n\nOther values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType \n- projects/project/zones/zone/diskTypes/diskType \n- zones/zone/diskTypes/diskType"
- },
- "sourceImage": {
- "type": "string",
- "description": "A source image used to create the disk. You can provide a private (custom) image, and Compute Engine will use the corresponding image from your project. For example:\n\nglobal/images/my-private-image \n\nOr you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:\n\nprojects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD \n\nwhere vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases."
- },
- "sourceImageEncryptionKey": {
- "$ref": "CustomerEncryptionKey",
- "description": "The customer-supplied encryption key of the source image. This key is required if the source image is protected by a customer-supplied encryption key.\n\nIf the incorrect key is provided, the operation will fail."
- }
- }
- },
- "Autoscaler": {
- "id": "Autoscaler",
- "type": "object",
- "properties": {
- "autoscalingPolicy": {
- "$ref": "AutoscalingPolicy",
- "description": "Autoscaling configuration."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource.",
- "default": "compute#autoscaler"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.instanceGroups.insert"
- ]
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "target": {
- "type": "string",
- "description": "URL of Instance Group Manager or Replica Pool which will be controlled by Autoscaler."
- },
- "zone": {
- "type": "string",
- "description": "[Output Only] URL of the zone where the instance group resides."
- }
- }
- },
- "AutoscalerAggregatedList": {
- "id": "AutoscalerAggregatedList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "object",
- "description": "A map of scoped autoscaler lists.",
- "additionalProperties": {
- "$ref": "AutoscalersScopedList",
- "description": "Name of the scope containing this set of autoscalers."
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#autoscalerAggregatedList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "AutoscalerList": {
- "id": "AutoscalerList",
- "type": "object",
- "description": "Contains a list of persistent autoscaler resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "A list of Autoscaler resources.",
- "items": {
- "$ref": "Autoscaler"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#autoscalerList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "AutoscalersScopedList": {
- "id": "AutoscalersScopedList",
- "type": "object",
- "properties": {
- "autoscalers": {
- "type": "array",
- "description": "List of autoscalers contained in this scope.",
- "items": {
- "$ref": "Autoscaler"
- }
- },
- "warning": {
- "type": "object",
- "description": "Informational warning which replaces the list of autoscalers when the list is empty.",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- },
- "AutoscalingPolicy": {
- "id": "AutoscalingPolicy",
- "type": "object",
- "description": "Cloud Autoscaler policy.",
- "properties": {
- "coolDownPeriodSec": {
- "type": "integer",
- "description": "The number of seconds that the Autoscaler should wait between two succeeding changes to the number of virtual machines. You should define an interval that is at least as long as the initialization time of a virtual machine and the time it may take for replica pool to create the virtual machine. The default is 60 seconds.",
- "format": "int32"
- },
- "cpuUtilization": {
- "$ref": "AutoscalingPolicyCpuUtilization",
- "description": "TODO(jbartosik): Add support for scaling based on muliple utilization metrics (take max recommendation). Exactly one utilization policy should be provided. Configuration parameters of CPU based autoscaling policy."
- },
- "customMetricUtilizations": {
- "type": "array",
- "description": "Configuration parameters of autoscaling based on custom metric.",
- "items": {
- "$ref": "AutoscalingPolicyCustomMetricUtilization"
- }
- },
- "loadBalancingUtilization": {
- "$ref": "AutoscalingPolicyLoadBalancingUtilization",
- "description": "Configuration parameters of autoscaling based on load balancer."
- },
- "maxNumReplicas": {
- "type": "integer",
- "description": "The maximum number of replicas that the Autoscaler can scale up to. This field is required for config to be effective. Maximum number of replicas should be not lower than minimal number of replicas. Absolute limit for this value is defined in Autoscaler backend.",
- "format": "int32"
- },
- "minNumReplicas": {
- "type": "integer",
- "description": "The minimum number of replicas that the Autoscaler can scale down to. Can't be less than 0. If not provided Autoscaler will choose default value depending on maximal number of replicas.",
- "format": "int32"
- }
- }
- },
- "AutoscalingPolicyCpuUtilization": {
- "id": "AutoscalingPolicyCpuUtilization",
- "type": "object",
- "description": "CPU utilization policy.",
- "properties": {
- "utilizationTarget": {
- "type": "number",
- "description": "The target utilization that the Autoscaler should maintain. It is represented as a fraction of used cores. For example: 6 cores used in 8-core VM are represented here as 0.75. Must be a float value between (0, 1]. If not defined, the default is 0.8.",
- "format": "double"
- }
- }
- },
- "AutoscalingPolicyCustomMetricUtilization": {
- "id": "AutoscalingPolicyCustomMetricUtilization",
- "type": "object",
- "description": "Custom utilization metric policy.",
- "properties": {
- "metric": {
- "type": "string",
- "description": "Identifier of the metric. It should be a Cloud Monitoring metric. The metric can not have negative values. The metric should be an utilization metric (increasing number of VMs handling requests x times should reduce average value of the metric roughly x times). For example you could use: compute.googleapis.com/instance/network/received_bytes_count."
- },
- "utilizationTarget": {
- "type": "number",
- "description": "Target value of the metric which Autoscaler should maintain. Must be a positive value.",
- "format": "double"
- },
- "utilizationTargetType": {
- "type": "string",
- "description": "Defines type in which utilization_target is expressed.",
- "enum": [
- "DELTA_PER_MINUTE",
- "DELTA_PER_SECOND",
- "GAUGE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- }
- }
- },
- "AutoscalingPolicyLoadBalancingUtilization": {
- "id": "AutoscalingPolicyLoadBalancingUtilization",
- "type": "object",
- "description": "Load balancing utilization policy.",
- "properties": {
- "utilizationTarget": {
- "type": "number",
- "description": "Fraction of backend capacity utilization (set in HTTP load balancing configuration) that Autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8. For example if your maxRatePerInstance capacity (in HTTP Load Balancing configuration) is set at 10 and you would like to keep number of instances such that each instance receives 7 QPS on average, set this to 0.7.",
- "format": "double"
- }
- }
- },
- "Backend": {
- "id": "Backend",
- "type": "object",
- "description": "Message containing information of one individual backend.",
- "properties": {
- "balancingMode": {
- "type": "string",
- "description": "Specifies the balancing mode for this backend. The default is UTILIZATION but available values are UTILIZATION and RATE.",
- "enum": [
- "RATE",
- "UTILIZATION"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "capacityScaler": {
- "type": "number",
- "description": "A multiplier applied to the group's maximum servicing capacity (either UTILIZATION or RATE). Default value is 1, which means the group will serve up to 100% of its configured CPU or RPS (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available CPU or RPS. Valid range is [0.0,1.0].",
- "format": "float"
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource. Provided by the client when the resource is created."
- },
- "group": {
- "type": "string",
- "description": "The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.\n\nNote that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL."
- },
- "maxRate": {
- "type": "integer",
- "description": "The max RPS of the group. Can be used with either balancing mode, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.",
- "format": "int32"
- },
- "maxRatePerInstance": {
- "type": "number",
- "description": "The max RPS that a single backed instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.",
- "format": "float"
- },
- "maxUtilization": {
- "type": "number",
- "description": "Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].",
- "format": "float"
- }
- }
- },
- "BackendService": {
- "id": "BackendService",
- "type": "object",
- "description": "A BackendService resource. This resource defines a group of backend virtual machines together with their serving capacity.",
- "properties": {
- "backends": {
- "type": "array",
- "description": "The list of backends that serve this BackendService.",
- "items": {
- "$ref": "Backend"
- }
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource. Provided by the client when the resource is created."
- },
- "fingerprint": {
- "type": "string",
- "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.",
- "format": "byte"
- },
- "healthChecks": {
- "type": "array",
- "description": "The list of URLs to the HttpHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#backendService for backend services.",
- "default": "compute#backendService"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "port": {
- "type": "integer",
- "description": "Deprecated in favor of port name. The TCP port to connect on the backend. The default value is 80.",
- "format": "int32"
- },
- "portName": {
- "type": "string",
- "description": "Name of backend port. The same name should appear in the resource views referenced by this service. Required."
- },
- "protocol": {
- "type": "string",
- "enum": [
- "HTTP",
- "HTTPS"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "timeoutSec": {
- "type": "integer",
- "description": "How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.",
- "format": "int32"
- }
- }
- },
- "BackendServiceGroupHealth": {
- "id": "BackendServiceGroupHealth",
- "type": "object",
- "properties": {
- "healthStatus": {
- "type": "array",
- "items": {
- "$ref": "HealthStatus"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services.",
- "default": "compute#backendServiceGroupHealth"
- }
- }
- },
- "BackendServiceList": {
- "id": "BackendServiceList",
- "type": "object",
- "description": "Contains a list of BackendService resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "A list of BackendService resources.",
- "items": {
- "$ref": "BackendService"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#backendServiceList for lists of backend services.",
- "default": "compute#backendServiceList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "CustomerEncryptionKey": {
- "id": "CustomerEncryptionKey",
- "type": "object",
- "description": "Represents a customer-supplied encryption key",
- "properties": {
- "rawKey": {
- "type": "string",
- "description": "Specifies a 256-bit customer-supplied encryption key, encoded in base64 to either encrypt or decrypt this resource."
- },
- "rsaEncryptedKey": {
- "type": "string",
- "description": "Specifies a base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.\n\nThe key must meet the following requirements before you can provide it to Compute Engine: \n- The key is wrapped using a RSA public key certificate provided by Google. \n- After being wrapped, the key must be encoded in base64 encoding. Get the RSA public key certificate provided by Google at:\nhttps://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem"
- },
- "sha256": {
- "type": "string",
- "description": "[Output only] The base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource."
- }
- }
- },
- "DeprecationStatus": {
- "id": "DeprecationStatus",
- "type": "object",
- "description": "Deprecation status for a public resource.",
- "properties": {
- "deleted": {
- "type": "string",
- "description": "An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED."
- },
- "deprecated": {
- "type": "string",
- "description": "An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED."
- },
- "obsolete": {
- "type": "string",
- "description": "An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE."
- },
- "replacement": {
- "type": "string",
- "description": "The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource."
- },
- "state": {
- "type": "string",
- "description": "The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.",
- "enum": [
- "DELETED",
- "DEPRECATED",
- "OBSOLETE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- }
- }
- },
- "Disk": {
- "id": "Disk",
- "type": "object",
- "description": "A Disk resource.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "diskEncryptionKey": {
- "$ref": "CustomerEncryptionKey",
- "description": "Encrypts the disk using a customer-supplied encryption key.\n\nIf you encrypt the disk using a customer-supplied encryption key, and you want to use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine), you must provide the same key in your request. If you provide an incorrect key, or no key, the operation will fail.\n\nCustomer-supplied encryption keys do not protect access to metadata of the disk.\n\nIf no customer-supplied encryption key is provided at creation, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#disk for disks.",
- "default": "compute#disk"
- },
- "lastAttachTimestamp": {
- "type": "string",
- "description": "[Output Only] Last attach timestamp in RFC3339 text format."
- },
- "lastDetachTimestamp": {
- "type": "string",
- "description": "[Output Only] Last detach timestamp in RFC3339 text format."
- },
- "licenses": {
- "type": "array",
- "description": "Any applicable publicly visible licenses.",
- "items": {
- "type": "string"
- }
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.disks.insert"
- ]
- }
- },
- "options": {
- "type": "string",
- "description": "Internal use only."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined fully-qualified URL for this resource."
- },
- "sizeGb": {
- "type": "string",
- "description": "Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.\n\nIf you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.",
- "format": "int64"
- },
- "sourceImage": {
- "type": "string",
- "description": "The source image used to create this disk. If the source image is deleted from the system, this field will not be set, even if an image with the same name has been re-created.\n\nWhen creating a disk, you can provide a private (custom) image using the following input, and Compute Engine will use the corresponding image from your project. For example:\n\nglobal/images/my-private-image \n\nOr you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:\n\nprojects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD \n\nwhere vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases."
- },
- "sourceImageEncryptionKey": {
- "$ref": "CustomerEncryptionKey",
- "description": "The customer-supplied encryption key of the source image. This key is required if the source image is protected by a customer-supplied encryption key.\n\nIf the incorrect key is provided, the operation will fail."
- },
- "sourceImageId": {
- "type": "string",
- "description": "The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used."
- },
- "sourceSnapshot": {
- "type": "string",
- "description": "The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: \n- https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot \n- projects/project/global/snapshots/snapshot \n- global/snapshots/snapshot"
- },
- "sourceSnapshotEncryptionKey": {
- "$ref": "CustomerEncryptionKey",
- "description": "The customer-supplied encryption key of the source snapshot. This key is required if the source snapshot is protected by a customer-supplied encryption key.\n\nIf the incorrect key is provided, the operation will fail."
- },
- "sourceSnapshotId": {
- "type": "string",
- "description": "[Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used."
- },
- "status": {
- "type": "string",
- "description": "[Output Only] The status of disk creation. Applicable statuses includes: CREATING, FAILED, READY, RESTORING.",
- "enum": [
- "CREATING",
- "FAILED",
- "READY",
- "RESTORING"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- },
- "storageType": {
- "type": "string",
- "description": "[Deprecated] Storage type of the persistent disk.",
- "enum": [
- "HDD",
- "SSD"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "type": {
- "type": "string",
- "description": "URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created."
- },
- "users": {
- "type": "array",
- "description": "Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance",
- "items": {
- "type": "string"
- }
- },
- "zone": {
- "type": "string",
- "description": "[Output Only] URL of the zone where the disk resides."
- }
- }
- },
- "DiskAggregatedList": {
- "id": "DiskAggregatedList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "object",
- "description": "[Output Only] A map of scoped disk lists.",
- "additionalProperties": {
- "$ref": "DisksScopedList",
- "description": "[Output Only] Name of the scope containing this set of disks."
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#diskAggregatedList for aggregated lists of persistent disks.",
- "default": "compute#diskAggregatedList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "DiskList": {
- "id": "DiskList",
- "type": "object",
- "description": "A list of Disk resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of persistent disks.",
- "items": {
- "$ref": "Disk"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#diskList for lists of disks.",
- "default": "compute#diskList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "DiskType": {
- "id": "DiskType",
- "type": "object",
- "description": "A disk type resource.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "defaultDiskSizeGb": {
- "type": "string",
- "description": "[Output Only] Server-defined default disk size in GB.",
- "format": "int64"
- },
- "deprecated": {
- "$ref": "DeprecationStatus",
- "description": "[Output Only] The deprecation status associated with this disk type."
- },
- "description": {
- "type": "string",
- "description": "[Output Only] An optional textual description of the resource."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#diskType for disk types.",
- "default": "compute#diskType"
- },
- "name": {
- "type": "string",
- "description": "[Output Only] Name of the resource.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "validDiskSize": {
- "type": "string",
- "description": "[Output Only] An optional textual description of the valid disk size, such as \"10GB-10TB\"."
- },
- "zone": {
- "type": "string",
- "description": "[Output Only] URL of the zone where the disk type resides."
- }
- }
- },
- "DiskTypeAggregatedList": {
- "id": "DiskTypeAggregatedList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "object",
- "description": "[Output Only] A map of scoped disk type lists.",
- "additionalProperties": {
- "$ref": "DiskTypesScopedList",
- "description": "[Output Only] Name of the scope containing this set of disk types."
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#diskTypeAggregatedList.",
- "default": "compute#diskTypeAggregatedList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "DiskTypeList": {
- "id": "DiskTypeList",
- "type": "object",
- "description": "Contains a list of disk type resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of Disk Type resources.",
- "items": {
- "$ref": "DiskType"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#diskTypeList for disk types.",
- "default": "compute#diskTypeList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "DiskTypesScopedList": {
- "id": "DiskTypesScopedList",
- "type": "object",
- "properties": {
- "diskTypes": {
- "type": "array",
- "description": "[Output Only] List of disk types contained in this scope.",
- "items": {
- "$ref": "DiskType"
- }
- },
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning which replaces the list of disk types when the list is empty.",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- },
- "DisksScopedList": {
- "id": "DisksScopedList",
- "type": "object",
- "properties": {
- "disks": {
- "type": "array",
- "description": "[Output Only] List of disks contained in this scope.",
- "items": {
- "$ref": "Disk"
- }
- },
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning which replaces the list of disks when the list is empty.",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- },
- "Firewall": {
- "id": "Firewall",
- "type": "object",
- "description": "A Firewall resource.",
- "properties": {
- "allowed": {
- "type": "array",
- "description": "The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.",
- "items": {
- "type": "object",
- "properties": {
- "IPProtocol": {
- "type": "string",
- "description": "The IP protocol that is allowed for this rule. The protocol type is required when creating a firewall. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number."
- },
- "ports": {
- "type": "array",
- "description": "An optional list of ports which are allowed. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, connections through any port are allowed\n\nExample inputs include: [\"22\"], [\"80\",\"443\"], and [\"12345-12349\"].",
- "items": {
- "type": "string"
- }
- }
- }
- }
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Ony] Type of the resource. Always compute#firewall for firewall rules.",
- "default": "compute#firewall"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.firewalls.insert",
- "compute.firewalls.patch"
- ]
- }
- },
- "network": {
- "type": "string",
- "description": "URL of the network resource for this firewall rule. This field is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:\nglobal/networks/default\nIf you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: \n- https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network \n- projects/myproject/global/networks/my-network \n- global/networks/default"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "sourceRanges": {
- "type": "array",
- "description": "The IP address blocks that this rule applies to, expressed in CIDR format. One or both of sourceRanges and sourceTags may be set.\n\nIf both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.",
- "items": {
- "type": "string"
- }
- },
- "sourceTags": {
- "type": "array",
- "description": "A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set.\n\nIf both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.",
- "items": {
- "type": "string"
- }
- },
- "targetTags": {
- "type": "array",
- "description": "A list of instance tags indicating sets of instances located in the network that may make network connections as specified in allowed[]. If no targetTags are specified, the firewall rule applies to all instances on the specified network.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "FirewallList": {
- "id": "FirewallList",
- "type": "object",
- "description": "Contains a list of Firewall resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of Firewall resources.",
- "items": {
- "$ref": "Firewall"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#firewallList for lists of firewalls.",
- "default": "compute#firewallList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "ForwardingRule": {
- "id": "ForwardingRule",
- "type": "object",
- "description": "A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.",
- "properties": {
- "IPAddress": {
- "type": "string",
- "description": "Value of the reserved IP address that this forwarding rule is serving on behalf of. For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. If left empty (default value), an ephemeral IP from the same scope (global or regional) will be assigned."
- },
- "IPProtocol": {
- "type": "string",
- "description": "The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH or SCTP.",
- "enum": [
- "AH",
- "ESP",
- "SCTP",
- "TCP",
- "UDP"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#forwardingRule.",
- "default": "compute#forwardingRule"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "portRange": {
- "type": "string",
- "description": "Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same `[IPAddress, IPProtocol]` pair must have disjoint port ranges."
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "target": {
- "type": "string",
- "description": "The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource."
- }
- }
- },
- "ForwardingRuleAggregatedList": {
- "id": "ForwardingRuleAggregatedList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "object",
- "description": "A map of scoped forwarding rule lists.",
- "additionalProperties": {
- "$ref": "ForwardingRulesScopedList",
- "description": "Name of the scope containing this set of addresses."
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#forwardingRuleAggregatedList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "ForwardingRuleList": {
- "id": "ForwardingRuleList",
- "type": "object",
- "description": "Contains a list of ForwardingRule resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Set by the server."
- },
- "items": {
- "type": "array",
- "description": "A list of ForwardingRule resources.",
- "items": {
- "$ref": "ForwardingRule"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#forwardingRuleList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "ForwardingRulesScopedList": {
- "id": "ForwardingRulesScopedList",
- "type": "object",
- "properties": {
- "forwardingRules": {
- "type": "array",
- "description": "List of forwarding rules contained in this scope.",
- "items": {
- "$ref": "ForwardingRule"
- }
- },
- "warning": {
- "type": "object",
- "description": "Informational warning which replaces the list of forwarding rules when the list is empty.",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- },
- "HealthCheckReference": {
- "id": "HealthCheckReference",
- "type": "object",
- "properties": {
- "healthCheck": {
- "type": "string"
- }
- }
- },
- "HealthStatus": {
- "id": "HealthStatus",
- "type": "object",
- "properties": {
- "healthState": {
- "type": "string",
- "description": "Health state of the instance.",
- "enum": [
- "HEALTHY",
- "UNHEALTHY"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "instance": {
- "type": "string",
- "description": "URL of the instance resource."
- },
- "ipAddress": {
- "type": "string",
- "description": "The IP address represented by this resource."
- },
- "port": {
- "type": "integer",
- "description": "The port on the instance.",
- "format": "int32"
- }
- }
- },
- "HostRule": {
- "id": "HostRule",
- "type": "object",
- "description": "UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.",
- "properties": {
- "description": {
- "type": "string",
- "description": "An optional textual description."
- },
- "hosts": {
- "type": "array",
- "description": "The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..",
- "items": {
- "type": "string"
- }
- },
- "pathMatcher": {
- "type": "string",
- "description": "The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion."
- }
- }
- },
- "HttpHealthCheck": {
- "id": "HttpHealthCheck",
- "type": "object",
- "description": "An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.",
- "properties": {
- "checkIntervalSec": {
- "type": "integer",
- "description": "How often (in seconds) to send a health check. The default value is 5 seconds.",
- "format": "int32"
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "healthyThreshold": {
- "type": "integer",
- "description": "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.",
- "format": "int32"
- },
- "host": {
- "type": "string",
- "description": "The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource.",
- "default": "compute#httpHealthCheck"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "port": {
- "type": "integer",
- "description": "The TCP port number for the HTTP health check request. The default value is 80.",
- "format": "int32"
- },
- "requestPath": {
- "type": "string",
- "description": "The request path of the HTTP health check request. The default value is \"/\"."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "timeoutSec": {
- "type": "integer",
- "description": "How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.",
- "format": "int32"
- },
- "unhealthyThreshold": {
- "type": "integer",
- "description": "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.",
- "format": "int32"
- }
- }
- },
- "HttpHealthCheckList": {
- "id": "HttpHealthCheckList",
- "type": "object",
- "description": "Contains a list of HttpHealthCheck resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server."
- },
- "items": {
- "type": "array",
- "description": "A list of HttpHealthCheck resources.",
- "items": {
- "$ref": "HttpHealthCheck"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#httpHealthCheckList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "HttpsHealthCheck": {
- "id": "HttpsHealthCheck",
- "type": "object",
- "description": "An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.",
- "properties": {
- "checkIntervalSec": {
- "type": "integer",
- "description": "How often (in seconds) to send a health check. The default value is 5 seconds.",
- "format": "int32"
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "healthyThreshold": {
- "type": "integer",
- "description": "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.",
- "format": "int32"
- },
- "host": {
- "type": "string",
- "description": "The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource.",
- "default": "compute#httpsHealthCheck"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "port": {
- "type": "integer",
- "description": "The TCP port number for the HTTPS health check request. The default value is 443.",
- "format": "int32"
- },
- "requestPath": {
- "type": "string",
- "description": "The request path of the HTTPS health check request. The default value is \"/\"."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "timeoutSec": {
- "type": "integer",
- "description": "How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.",
- "format": "int32"
- },
- "unhealthyThreshold": {
- "type": "integer",
- "description": "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.",
- "format": "int32"
- }
- }
- },
- "HttpsHealthCheckList": {
- "id": "HttpsHealthCheckList",
- "type": "object",
- "description": "Contains a list of HttpsHealthCheck resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "A list of HttpsHealthCheck resources.",
- "items": {
- "$ref": "HttpsHealthCheck"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#httpsHealthCheckList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "Image": {
- "id": "Image",
- "type": "object",
- "description": "An Image resource.",
- "properties": {
- "archiveSizeBytes": {
- "type": "string",
- "description": "Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).",
- "format": "int64"
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "deprecated": {
- "$ref": "DeprecationStatus",
- "description": "The deprecation status associated with this image."
- },
- "description": {
- "type": "string",
- "description": "Textual description of the resource; provided by the client when the resource is created."
- },
- "diskSizeGb": {
- "type": "string",
- "description": "Size of the image when restored onto a persistent disk (in GB).",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "imageEncryptionKey": {
- "$ref": "CustomerEncryptionKey",
- "description": "Encrypts the image using a customer-supplied encryption key.\n\nIf you encrypt an image using a customer-supplied encryption key, and you want to use the image later (e.g. to create a disk from the image), you must provide the same key used encrypt the image in your future request. If you provide an incorrect key, or no key, the operation will fail.\n\nCustomer-supplied encryption keys do not protect access to metadata of the disk.\n\nIf no customer-supplied encryption key is provided at creation, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later."
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#image for images.",
- "default": "compute#image"
- },
- "licenses": {
- "type": "array",
- "description": "Any applicable publicly visible licenses.",
- "items": {
- "type": "string"
- }
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.images.insert"
- ]
- }
- },
- "rawDisk": {
- "type": "object",
- "description": "The parameters of the raw disk image.",
- "properties": {
- "containerType": {
- "type": "string",
- "description": "The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.",
- "enum": [
- "TAR"
- ],
- "enumDescriptions": [
- ""
- ]
- },
- "sha1Checksum": {
- "type": "string",
- "description": "An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.",
- "pattern": "[a-f0-9]{40}"
- },
- "source": {
- "type": "string",
- "description": "The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both.",
- "annotations": {
- "required": [
- "compute.images.insert"
- ]
- }
- }
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "sourceDisk": {
- "type": "string",
- "description": "URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone/disk/disk \n- projects/project/zones/zone/disk/disk \n- zones/zone/disks/disk"
- },
- "sourceDiskEncryptionKey": {
- "$ref": "CustomerEncryptionKey",
- "description": "Specifies the customer-supplied encryption key of the source disk. This key is required if the source disk is protected by a customer-supplied encryption key.\n\nIf the incorrect key is provided the operation will fail."
- },
- "sourceDiskId": {
- "type": "string",
- "description": "The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name."
- },
- "sourceType": {
- "type": "string",
- "description": "The type of the image used to create this disk. The default and only value is RAW",
- "default": "RAW",
- "enum": [
- "RAW"
- ],
- "enumDescriptions": [
- ""
- ]
- },
- "status": {
- "type": "string",
- "description": "[Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.",
- "enum": [
- "FAILED",
- "PENDING",
- "READY"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- }
- }
- },
- "ImageList": {
- "id": "ImageList",
- "type": "object",
- "description": "Contains a list of Image resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of Image resources.",
- "items": {
- "$ref": "Image"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#imageList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "Instance": {
- "id": "Instance",
- "type": "object",
- "description": "An Instance resource.",
- "properties": {
- "canIpForward": {
- "type": "boolean",
- "description": "Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding."
- },
- "cpuPlatform": {
- "type": "string",
- "description": "[Output Only] The CPU platform used by this instance."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "disks": {
- "type": "array",
- "description": "Array of disks associated with this instance. Persistent disks must be created before you can assign them.",
- "items": {
- "$ref": "AttachedDisk"
- }
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#instance for instances.",
- "default": "compute#instance"
- },
- "labelFingerprint": {
- "type": "string",
- "description": "A fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.\n\nTo see the latest fingerprint, make get() request to the instance.",
- "format": "byte"
- },
- "labels": {
- "type": "object",
- "description": "Labels to apply to this instance. These can be later modified by the setLabels method. Each label key & value must comply with RFC1035. Label values may be empty.",
- "additionalProperties": {
- "type": "string"
- }
- },
- "machineType": {
- "type": "string",
- "description": "Full or partial URL of the machine type resource to use for this instance. This is provided by the client when the instance is created. For example, the following is a valid partial url:\n\nzones/zone/machineTypes/machine-type",
- "annotations": {
- "required": [
- "compute.instances.insert"
- ]
- }
- },
- "metadata": {
- "$ref": "Metadata",
- "description": "The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys."
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash."
- },
- "networkInterfaces": {
- "type": "array",
- "description": "An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet.",
- "items": {
- "$ref": "NetworkInterface"
- }
- },
- "scheduling": {
- "$ref": "Scheduling",
- "description": "Scheduling options for this instance."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server defined URL for this resource."
- },
- "serviceAccounts": {
- "type": "array",
- "description": "A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Authenticating from Google Compute Engine for more information.",
- "items": {
- "$ref": "ServiceAccount"
- }
- },
- "status": {
- "type": "string",
- "description": "[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, and TERMINATED.",
- "enum": [
- "PROVISIONING",
- "RUNNING",
- "STAGING",
- "STOPPED",
- "STOPPING",
- "SUSPENDED",
- "SUSPENDING",
- "TERMINATED"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "statusMessage": {
- "type": "string",
- "description": "[Output Only] An optional, human-readable explanation of the status."
- },
- "tags": {
- "$ref": "Tags",
- "description": "A list of tags to appy to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035."
- },
- "zone": {
- "type": "string",
- "description": "[Output Only] URL of the zone where the instance resides."
- }
- }
- },
- "InstanceAggregatedList": {
- "id": "InstanceAggregatedList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "object",
- "description": "[Output Only] A map of scoped instance lists.",
- "additionalProperties": {
- "$ref": "InstancesScopedList",
- "description": "Name of the scope containing this set of instances."
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.",
- "default": "compute#instanceAggregatedList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server defined URL for this resource."
- }
- }
- },
- "InstanceGroup": {
- "id": "InstanceGroup",
- "type": "object",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] The creation timestamp for this instance group in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional text description for the instance group."
- },
- "fingerprint": {
- "type": "string",
- "description": "[Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.",
- "format": "byte"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] A unique identifier for this resource type. The server generates this identifier.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] The resource type, which is always compute#instanceGroup for instance groups.",
- "default": "compute#instanceGroup"
- },
- "name": {
- "type": "string",
- "description": "The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.instanceGroupManagers.insert"
- ]
- }
- },
- "namedPorts": {
- "type": "array",
- "description": "Assigns a name to a port number. For example: {name: \"http\", port: 80}\n\nThis allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: \"http\", port: 80},{name: \"http\", port: 8080}] \n\nNamed ports apply to all instances in this instance group.",
- "items": {
- "$ref": "NamedPort"
- }
- },
- "network": {
- "type": "string",
- "description": "[Output Only] The URL of the network to which all instances in the instance group belong."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] The URL for this instance group. The server generates this URL."
- },
- "size": {
- "type": "integer",
- "description": "[Output Only] The total number of instances in the instance group.",
- "format": "int32"
- },
- "zone": {
- "type": "string",
- "description": "[Output Only] The URL of the zone where the instance group is located."
- }
- }
- },
- "InstanceGroupAggregatedList": {
- "id": "InstanceGroupAggregatedList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] A unique identifier for this aggregated list of instance groups. The server generates this identifier."
- },
- "items": {
- "type": "object",
- "description": "A map of scoped instance group lists.",
- "additionalProperties": {
- "$ref": "InstanceGroupsScopedList",
- "description": "The name of the scope that contains this set of instance groups."
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups.",
- "default": "compute#instanceGroupAggregatedList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token that is used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] The URL for this resource type. The server generates this URL."
- }
- }
- },
- "InstanceGroupList": {
- "id": "InstanceGroupList",
- "type": "object",
- "description": "A list of InstanceGroup resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] A unique identifier for this list of instance groups. The server generates this identifier."
- },
- "items": {
- "type": "array",
- "description": "A list of instance groups.",
- "items": {
- "$ref": "InstanceGroup"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] The resource type, which is always compute#instanceGroupList for instance group lists.",
- "default": "compute#instanceGroupList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token that is used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] The URL for this resource type. The server generates this URL."
- }
- }
- },
- "InstanceGroupManager": {
- "id": "InstanceGroupManager",
- "type": "object",
- "description": "InstanceGroupManagers\n\nNext available tag: 19",
- "properties": {
- "autoHealingPolicies": {
- "type": "array",
- "description": "The autohealing policy for this managed instance group. You can specify only one value.",
- "items": {
- "$ref": "InstanceGroupManagerAutoHealingPolicy"
- }
- },
- "baseInstanceName": {
- "type": "string",
- "description": "The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.",
- "pattern": "[a-z][-a-z0-9]{0,57}",
- "annotations": {
- "required": [
- "compute.instanceGroupManagers.insert"
- ]
- }
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] The creation timestamp for this managed instance group in RFC3339 text format."
- },
- "currentActions": {
- "$ref": "InstanceGroupManagerActionsSummary",
- "description": "[Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions."
- },
- "description": {
- "type": "string",
- "description": "An optional text description for the managed instance group."
- },
- "fingerprint": {
- "type": "string",
- "description": "[Output Only] The fingerprint of the target pools information. You can use this optional field for optimistic locking when you update the target pool entries.",
- "format": "byte"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] A unique identifier for this resource type. The server generates this identifier.",
- "format": "uint64"
- },
- "instanceGroup": {
- "type": "string",
- "description": "[Output Only] The URL of the Instance Group resource."
- },
- "instanceTemplate": {
- "type": "string",
- "description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.",
- "annotations": {
- "required": [
- "compute.instanceGroupManagers.insert"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.",
- "default": "compute#instanceGroupManager"
- },
- "name": {
- "type": "string",
- "description": "The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.instanceGroupManagers.insert"
- ]
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] The URL for this managed instance group. The server defines this URL."
- },
- "targetPools": {
- "type": "array",
- "description": "The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.",
- "items": {
- "type": "string"
- }
- },
- "targetSize": {
- "type": "integer",
- "description": "The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.",
- "format": "int32",
- "annotations": {
- "required": [
- "compute.instanceGroupManagers.insert"
- ]
- }
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the managed instance group is located."
- }
- }
- },
- "InstanceGroupManagerActionsSummary": {
- "id": "InstanceGroupManagerActionsSummary",
- "type": "object",
- "properties": {
- "abandoning": {
- "type": "integer",
- "description": "[Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.",
- "format": "int32"
- },
- "creating": {
- "type": "integer",
- "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created.",
- "format": "int32"
- },
- "deleting": {
- "type": "integer",
- "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.",
- "format": "int32"
- },
- "none": {
- "type": "integer",
- "description": "[Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.",
- "format": "int32"
- },
- "recreating": {
- "type": "integer",
- "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.",
- "format": "int32"
- },
- "refreshing": {
- "type": "integer",
- "description": "[Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.",
- "format": "int32"
- },
- "restarting": {
- "type": "integer",
- "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.",
- "format": "int32"
- }
- }
- },
- "InstanceGroupManagerAggregatedList": {
- "id": "InstanceGroupManagerAggregatedList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] A unique identifier for this aggregated list of managed instance groups. The server generates this identifier."
- },
- "items": {
- "type": "object",
- "description": "[Output Only] A map of filtered managed instance group lists.",
- "additionalProperties": {
- "$ref": "InstanceGroupManagersScopedList",
- "description": "[Output Only] The name of the scope that contains this set of managed instance groups."
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups.",
- "default": "compute#instanceGroupManagerAggregatedList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token that is used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] The URL for this resource type. The server generates this URL."
- }
- }
- },
- "InstanceGroupManagerAutoHealingPolicy": {
- "id": "InstanceGroupManagerAutoHealingPolicy",
- "type": "object",
- "properties": {
- "actionType": {
- "type": "string",
- "description": "The action to perform when an instance in this group becomes unhealthy. Possible values are RECREATE or RESTART. RECREATE replaces an unhealthy instance using the same name and instance template as the unhealthy instance. RESTART performs a soft restart on an instance. If the instance cannot reboot, the instance performs a hard restart.",
- "enum": [
- "RECREATE",
- "RESTART"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "healthCheck": {
- "type": "string",
- "description": "The URL for the HealthCheck that signals autohealing."
- }
- }
- },
- "InstanceGroupManagerList": {
- "id": "InstanceGroupManagerList",
- "type": "object",
- "description": "[Output Only] A list of managed instance groups.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] A unique identifier for this resource type. The server generates this identifier."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of managed instance groups.",
- "items": {
- "$ref": "InstanceGroupManager"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups.",
- "default": "compute#instanceGroupManagerList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token that is used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] The URL for this resource type. The server generates this URL."
- }
- }
- },
- "InstanceGroupManagersAbandonInstancesRequest": {
- "id": "InstanceGroupManagersAbandonInstancesRequest",
- "type": "object",
- "properties": {
- "instances": {
- "type": "array",
- "description": "The URL for one or more instances to abandon from the managed instance group.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "InstanceGroupManagersDeleteInstancesRequest": {
- "id": "InstanceGroupManagersDeleteInstancesRequest",
- "type": "object",
- "properties": {
- "instances": {
- "type": "array",
- "description": "The list of instances to delete from this managed instance group. Specify one or more instance URLs.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "InstanceGroupManagersListManagedInstancesResponse": {
- "id": "InstanceGroupManagersListManagedInstancesResponse",
- "type": "object",
- "properties": {
- "managedInstances": {
- "type": "array",
- "description": "[Output Only] The list of instances in the managed instance group.",
- "items": {
- "$ref": "ManagedInstance"
- }
- }
- }
- },
- "InstanceGroupManagersRecreateInstancesRequest": {
- "id": "InstanceGroupManagersRecreateInstancesRequest",
- "type": "object",
- "properties": {
- "instances": {
- "type": "array",
- "description": "The URL for one or more instances to recreate.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "InstanceGroupManagersScopedList": {
- "id": "InstanceGroupManagersScopedList",
- "type": "object",
- "properties": {
- "instanceGroupManagers": {
- "type": "array",
- "description": "[Output Only] The list of managed instance groups that are contained in the specified project and zone.",
- "items": {
- "$ref": "InstanceGroupManager"
- }
- },
- "warning": {
- "type": "object",
- "description": "[Output Only] The warning that replaces the list of managed instance groups when the list is empty.",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- },
- "InstanceGroupManagersSetAutoHealingRequest": {
- "id": "InstanceGroupManagersSetAutoHealingRequest",
- "type": "object",
- "properties": {
- "autoHealingPolicies": {
- "type": "array",
- "items": {
- "$ref": "InstanceGroupManagerAutoHealingPolicy"
- }
- }
- }
- },
- "InstanceGroupManagersSetInstanceTemplateRequest": {
- "id": "InstanceGroupManagersSetInstanceTemplateRequest",
- "type": "object",
- "properties": {
- "instanceTemplate": {
- "type": "string",
- "description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group."
- }
- }
- },
- "InstanceGroupManagersSetTargetPoolsRequest": {
- "id": "InstanceGroupManagersSetTargetPoolsRequest",
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string",
- "description": "The fingerprint of the target pools information. Use this optional property to prevent conflicts when multiple users change the target pools settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.",
- "format": "byte"
- },
- "targetPools": {
- "type": "array",
- "description": "The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "InstanceGroupsAddInstancesRequest": {
- "id": "InstanceGroupsAddInstancesRequest",
- "type": "object",
- "properties": {
- "instances": {
- "type": "array",
- "description": "The list of instances to add to the instance group.",
- "items": {
- "$ref": "InstanceReference"
- }
- }
- }
- },
- "InstanceGroupsListInstances": {
- "id": "InstanceGroupsListInstances",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] A unique identifier for this list of instance groups. The server generates this identifier."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of instances and any named ports that are assigned to those instances.",
- "items": {
- "$ref": "InstanceWithNamedPorts"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] The resource type, which is always compute#instanceGroupsListInstances for lists of instance groups.",
- "default": "compute#instanceGroupsListInstances"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token that is used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] The URL for this list of instance groups. The server generates this URL."
- }
- }
- },
- "InstanceGroupsListInstancesRequest": {
- "id": "InstanceGroupsListInstancesRequest",
- "type": "object",
- "properties": {
- "instanceState": {
- "type": "string",
- "description": "A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state.",
- "enum": [
- "ALL",
- "RUNNING"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- }
- }
- },
- "InstanceGroupsRemoveInstancesRequest": {
- "id": "InstanceGroupsRemoveInstancesRequest",
- "type": "object",
- "properties": {
- "instances": {
- "type": "array",
- "description": "The list of instances to remove from the instance group.",
- "items": {
- "$ref": "InstanceReference"
- }
- }
- }
- },
- "InstanceGroupsScopedList": {
- "id": "InstanceGroupsScopedList",
- "type": "object",
- "properties": {
- "instanceGroups": {
- "type": "array",
- "description": "[Output Only] The list of instance groups that are contained in this scope.",
- "items": {
- "$ref": "InstanceGroup"
- }
- },
- "warning": {
- "type": "object",
- "description": "[Output Only] An informational warning that replaces the list of instance groups when the list is empty.",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- },
- "InstanceGroupsSetNamedPortsRequest": {
- "id": "InstanceGroupsSetNamedPortsRequest",
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string",
- "description": "The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.",
- "format": "byte"
- },
- "namedPorts": {
- "type": "array",
- "description": "The list of named ports to set for this instance group.",
- "items": {
- "$ref": "NamedPort"
- }
- }
- }
- },
- "InstanceList": {
- "id": "InstanceList",
- "type": "object",
- "description": "Contains a list of instance resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of Instance resources.",
- "items": {
- "$ref": "Instance"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.",
- "default": "compute#instanceList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server defined URL for this resource."
- }
- }
- },
- "InstanceProperties": {
- "id": "InstanceProperties",
- "type": "object",
- "description": "",
- "properties": {
- "canIpForward": {
- "type": "boolean",
- "description": "Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the canIpForward documentation for more information."
- },
- "description": {
- "type": "string",
- "description": "An optional text description for the instances that are created from this instance template."
- },
- "disks": {
- "type": "array",
- "description": "An array of disks that are associated with the instances that are created from this template.",
- "items": {
- "$ref": "AttachedDisk"
- }
- },
- "machineType": {
- "type": "string",
- "description": "The machine type to use for instances that are created from this template.",
- "annotations": {
- "required": [
- "compute.instanceTemplates.insert"
- ]
- }
- },
- "metadata": {
- "$ref": "Metadata",
- "description": "The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information."
- },
- "networkInterfaces": {
- "type": "array",
- "description": "An array of network access configurations for this interface.",
- "items": {
- "$ref": "NetworkInterface"
- }
- },
- "scheduling": {
- "$ref": "Scheduling",
- "description": "Specifies the scheduling options for the instances that are created from this template."
- },
- "serviceAccounts": {
- "type": "array",
- "description": "A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances.",
- "items": {
- "$ref": "ServiceAccount"
- }
- },
- "tags": {
- "$ref": "Tags",
- "description": "A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035."
- }
- }
- },
- "InstanceReference": {
- "id": "InstanceReference",
- "type": "object",
- "properties": {
- "instance": {
- "type": "string",
- "description": "The URL for a specific instance."
- }
- }
- },
- "InstanceTemplate": {
- "id": "InstanceTemplate",
- "type": "object",
- "description": "An Instance Template resource.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] The creation timestamp for this instance template in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional text description for the instance template."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] A unique identifier for this instance template. The server defines this identifier.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] The resource type, which is always compute#instanceTemplate for instance templates.",
- "default": "compute#instanceTemplate"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.instanceTemplates.insert"
- ]
- }
- },
- "properties": {
- "$ref": "InstanceProperties",
- "description": "The instance properties for this instance template."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] The URL for this instance template. The server defines this URL."
- }
- }
- },
- "InstanceTemplateList": {
- "id": "InstanceTemplateList",
- "type": "object",
- "description": "A list of instance templates.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] A unique identifier for this instance template. The server defines this identifier."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] list of InstanceTemplate resources.",
- "items": {
- "$ref": "InstanceTemplate"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists.",
- "default": "compute#instanceTemplateList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token that is used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] The URL for this instance template list. The server defines this URL."
- }
- }
- },
- "InstanceWithNamedPorts": {
- "id": "InstanceWithNamedPorts",
- "type": "object",
- "properties": {
- "instance": {
- "type": "string",
- "description": "[Output Only] The URL of the instance."
- },
- "namedPorts": {
- "type": "array",
- "description": "[Output Only] The named ports that belong to this instance group.",
- "items": {
- "$ref": "NamedPort"
- }
- },
- "status": {
- "type": "string",
- "description": "[Output Only] The status of the instance.",
- "enum": [
- "PROVISIONING",
- "RUNNING",
- "STAGING",
- "STOPPED",
- "STOPPING",
- "SUSPENDED",
- "SUSPENDING",
- "TERMINATED"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- }
- },
- "InstancesScopedList": {
- "id": "InstancesScopedList",
- "type": "object",
- "properties": {
- "instances": {
- "type": "array",
- "description": "[Output Only] List of instances contained in this scope.",
- "items": {
- "$ref": "Instance"
- }
- },
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning which replaces the list of instances when the list is empty.",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- },
- "InstancesSetLabelsRequest": {
- "id": "InstancesSetLabelsRequest",
- "type": "object",
- "properties": {
- "labelFingerprint": {
- "type": "string",
- "format": "byte"
- },
- "labels": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- }
- }
- },
- "InstancesSetMachineTypeRequest": {
- "id": "InstancesSetMachineTypeRequest",
- "type": "object",
- "properties": {
- "machineType": {
- "type": "string",
- "description": "Full or partial URL of the machine type resource. See Instance.machine_type."
- }
- }
- },
- "License": {
- "id": "License",
- "type": "object",
- "description": "A license resource.",
- "properties": {
- "chargesUseFee": {
- "type": "boolean",
- "description": "If true, the customer will be charged license fee for running software that contains this license on an instance."
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#license for licenses.",
- "default": "compute#license"
- },
- "name": {
- "type": "string",
- "description": "[Output Only] Name of the resource. The name is 1-63 characters long and complies with RFC1035.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.images.insert"
- ]
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- }
- }
- },
- "MachineType": {
- "id": "MachineType",
- "type": "object",
- "description": "A Machine Type resource.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "deprecated": {
- "$ref": "DeprecationStatus",
- "description": "[Output Only] The deprecation status associated with this machine type."
- },
- "description": {
- "type": "string",
- "description": "[Output Only] An optional textual description of the resource."
- },
- "guestCpus": {
- "type": "integer",
- "description": "[Output Only] The tumber of CPUs exposed to the instance.",
- "format": "int32"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource.",
- "default": "compute#machineType"
- },
- "maximumPersistentDisks": {
- "type": "integer",
- "description": "[Output Only] Maximum persistent disks allowed.",
- "format": "int32"
- },
- "maximumPersistentDisksSizeGb": {
- "type": "string",
- "description": "[Output Only] Maximum total persistent disks size (GB) allowed.",
- "format": "int64"
- },
- "memoryMb": {
- "type": "integer",
- "description": "[Output Only] The amount of physical memory available to the instance, defined in MB.",
- "format": "int32"
- },
- "name": {
- "type": "string",
- "description": "[Output Only] Name of the resource.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "zone": {
- "type": "string",
- "description": "[Output Only] The name of the zone where the machine type resides, such as us-central1-a."
- }
- }
- },
- "MachineTypeAggregatedList": {
- "id": "MachineTypeAggregatedList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "object",
- "description": "[Output Only] A map of scoped machine type lists.",
- "additionalProperties": {
- "$ref": "MachineTypesScopedList",
- "description": "[Output Only] Name of the scope containing this set of machine types."
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types.",
- "default": "compute#machineTypeAggregatedList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "MachineTypeList": {
- "id": "MachineTypeList",
- "type": "object",
- "description": "Contains a list of Machine Type resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of Machine Type resources.",
- "items": {
- "$ref": "MachineType"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#machineTypeList for lists of machine types.",
- "default": "compute#machineTypeList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "MachineTypesScopedList": {
- "id": "MachineTypesScopedList",
- "type": "object",
- "properties": {
- "machineTypes": {
- "type": "array",
- "description": "[Output Only] List of machine types contained in this scope.",
- "items": {
- "$ref": "MachineType"
- }
- },
- "warning": {
- "type": "object",
- "description": "[Output Only] An informational warning that appears when the machine types list is empty.",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- },
- "ManagedInstance": {
- "id": "ManagedInstance",
- "type": "object",
- "properties": {
- "currentAction": {
- "type": "string",
- "description": "[Output Only] The current action that the managed instance group has scheduled for the instance. Possible values: \n- NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance. \n- CREATING The managed instance group is creating this instance. \n- RECREATING The managed instance group is recreating this instance. \n- DELETING The managed instance group is permanently deleting this instance. \n- ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group. \n- RESTARTING The managed instance group is restarting the instance. \n- REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.",
- "enum": [
- "ABANDONING",
- "CREATING",
- "DELETING",
- "NONE",
- "RECREATING",
- "REFRESHING",
- "RESTARTING"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "id": {
- "type": "string",
- "description": "[Output only] The unique identifier for this resource. This field is empty when instance does not exist.",
- "format": "uint64"
- },
- "instance": {
- "type": "string",
- "description": "[Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created."
- },
- "instanceStatus": {
- "type": "string",
- "description": "[Output Only] The status of the instance. This field is empty when the instance does not exist.",
- "enum": [
- "PROVISIONING",
- "RUNNING",
- "STAGING",
- "STOPPED",
- "STOPPING",
- "SUSPENDED",
- "SUSPENDING",
- "TERMINATED"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "lastAttempt": {
- "$ref": "ManagedInstanceLastAttempt",
- "description": "[Output Only] Information about the last attempt to create or delete the instance."
- }
- }
- },
- "ManagedInstanceLastAttempt": {
- "id": "ManagedInstanceLastAttempt",
- "type": "object",
- "properties": {
- "errors": {
- "type": "object",
- "description": "[Output Only] Encountered errors during the last attempt to create or delete the instance.",
- "properties": {
- "errors": {
- "type": "array",
- "description": "[Output Only] The array of errors encountered while processing this operation.",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The error type identifier for this error."
- },
- "location": {
- "type": "string",
- "description": "[Output Only] Indicates the field in the request which caused the error. This property is optional."
- },
- "message": {
- "type": "string",
- "description": "[Output Only] An optional, human-readable error message."
- }
- }
- }
- }
- }
- }
- }
- },
- "Metadata": {
- "id": "Metadata",
- "type": "object",
- "description": "A metadata key/value entry.",
- "properties": {
- "fingerprint": {
- "type": "string",
- "description": "Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.",
- "format": "byte"
- },
- "items": {
- "type": "array",
- "description": "Array of key/value pairs. The total size of all keys and values must be less than 512 KB.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.",
- "pattern": "[a-zA-Z0-9-_]{1,128}",
- "annotations": {
- "required": [
- "compute.instances.insert",
- "compute.projects.setCommonInstanceMetadata"
- ]
- }
- },
- "value": {
- "type": "string",
- "description": "Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.",
- "annotations": {
- "required": [
- "compute.instances.insert",
- "compute.projects.setCommonInstanceMetadata"
- ]
- }
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#metadata for metadata.",
- "default": "compute#metadata"
- }
- }
- },
- "NamedPort": {
- "id": "NamedPort",
- "type": "object",
- "description": "The named port. For example: .",
- "properties": {
- "name": {
- "type": "string",
- "description": "The name for this named port. The name must be 1-63 characters long, and comply with RFC1035."
- },
- "port": {
- "type": "integer",
- "description": "The port number, which can be a value between 1 and 65535.",
- "format": "int32"
- }
- }
- },
- "Network": {
- "id": "Network",
- "type": "object",
- "description": "A network resource.",
- "properties": {
- "IPv4Range": {
- "type": "string",
- "description": "The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.",
- "pattern": "[0-9]{1,3}(?:\\.[0-9]{1,3}){3}/[0-9]{1,2}"
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource. Provided by the client when the resource is created."
- },
- "gatewayIPv4": {
- "type": "string",
- "description": "A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.",
- "pattern": "[0-9]{1,3}(?:\\.[0-9]{1,3}){3}"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#network for networks.",
- "default": "compute#network"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.networks.insert"
- ]
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- }
- }
- },
- "NetworkInterface": {
- "id": "NetworkInterface",
- "type": "object",
- "description": "A network interface resource attached to an instance.",
- "properties": {
- "accessConfigs": {
- "type": "array",
- "description": "An array of configurations for this interface. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.",
- "items": {
- "$ref": "AccessConfig"
- }
- },
- "name": {
- "type": "string",
- "description": "[Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc."
- },
- "network": {
- "type": "string",
- "description": "URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:\n\nglobal/networks/default \n\nIf you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: \n- https://www.googleapis.com/compute/v1/projects/project/global/networks/network \n- projects/project/global/networks/network \n- global/networks/default",
- "annotations": {
- "required": [
- "compute.instances.insert"
- ]
- }
- },
- "networkIP": {
- "type": "string",
- "description": "[Output Only] An optional IPV4 internal network address assigned to the instance for this network interface."
- }
- }
- },
- "NetworkList": {
- "id": "NetworkList",
- "type": "object",
- "description": "Contains a list of Network resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of Network resources.",
- "items": {
- "$ref": "Network"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#networkList for lists of networks.",
- "default": "compute#networkList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource ."
- }
- }
- },
- "Operation": {
- "id": "Operation",
- "type": "object",
- "description": "An Operation resource, used to manage asynchronous API requests.",
- "properties": {
- "clientOperationId": {
- "type": "string",
- "description": "[Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "endTime": {
- "type": "string",
- "description": "[Output Only] The time that this operation was completed. This is in RFC3339 text format."
- },
- "error": {
- "type": "object",
- "description": "[Output Only] If errors are generated during processing of the operation, this field will be populated.",
- "properties": {
- "errors": {
- "type": "array",
- "description": "[Output Only] The array of errors encountered while processing this operation.",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The error type identifier for this error."
- },
- "location": {
- "type": "string",
- "description": "[Output Only] Indicates the field in the request which caused the error. This property is optional."
- },
- "message": {
- "type": "string",
- "description": "[Output Only] An optional, human-readable error message."
- }
- }
- }
- }
- }
- },
- "httpErrorMessage": {
- "type": "string",
- "description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND."
- },
- "httpErrorStatusCode": {
- "type": "integer",
- "description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.",
- "format": "int32"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "insertTime": {
- "type": "string",
- "description": "[Output Only] The time that this operation was requested. This is in RFC3339 text format."
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#operation for Operation resources.",
- "default": "compute#operation"
- },
- "name": {
- "type": "string",
- "description": "[Output Only] Name of the resource."
- },
- "operationType": {
- "type": "string",
- "description": "[Output Only] Type of the operation, such as insert, compute.instanceGroups.update, or compute.instanceGroups.delete."
- },
- "progress": {
- "type": "integer",
- "description": "[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.",
- "format": "int32"
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the operation resides. Only applicable for regional resources."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "startTime": {
- "type": "string",
- "description": "[Output Only] The time that this operation was started by the server. This is in RFC3339 text format."
- },
- "status": {
- "type": "string",
- "description": "[Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.",
- "enum": [
- "DONE",
- "PENDING",
- "RUNNING"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "statusMessage": {
- "type": "string",
- "description": "[Output Only] An optional textual description of the current status of the operation."
- },
- "targetId": {
- "type": "string",
- "description": "[Output Only] Unique target ID which identifies a particular incarnation of the target.",
- "format": "uint64"
- },
- "targetLink": {
- "type": "string",
- "description": "[Output Only] URL of the resource the operation is mutating."
- },
- "user": {
- "type": "string",
- "description": "[Output Only] User who requested the operation, for example: user@example.com."
- },
- "warnings": {
- "type": "array",
- "description": "[Output Only] If warning messages are generated during processing of the operation, this field will be populated.",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- },
- "zone": {
- "type": "string",
- "description": "[Output Only] URL of the zone where the operation resides."
- }
- }
- },
- "OperationAggregatedList": {
- "id": "OperationAggregatedList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "object",
- "description": "[Output Only] A map of scoped operation lists.",
- "additionalProperties": {
- "$ref": "OperationsScopedList",
- "description": "[Output Only] Name of the scope containing this set of operations."
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#operationAggregatedList for aggregated lists of operations.",
- "default": "compute#operationAggregatedList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "OperationList": {
- "id": "OperationList",
- "type": "object",
- "description": "Contains a list of Operation resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] The Operation resources.",
- "items": {
- "$ref": "Operation"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#operations for Operations resource.",
- "default": "compute#operationList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncate."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "OperationsScopedList": {
- "id": "OperationsScopedList",
- "type": "object",
- "properties": {
- "operations": {
- "type": "array",
- "description": "[Output Only] List of operations contained in this scope.",
- "items": {
- "$ref": "Operation"
- }
- },
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning which replaces the list of operations when the list is empty.",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- },
- "PathMatcher": {
- "id": "PathMatcher",
- "type": "object",
- "description": "A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.",
- "properties": {
- "defaultService": {
- "type": "string",
- "description": "The URL to the BackendService resource. This will be used if none of the 'pathRules' defined by this PathMatcher is met by the URL's path portion."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource."
- },
- "name": {
- "type": "string",
- "description": "The name to which this PathMatcher is referred by the HostRule."
- },
- "pathRules": {
- "type": "array",
- "description": "The list of path rules.",
- "items": {
- "$ref": "PathRule"
- }
- }
- }
- },
- "PathRule": {
- "id": "PathRule",
- "type": "object",
- "description": "A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.",
- "properties": {
- "paths": {
- "type": "array",
- "description": "The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.",
- "items": {
- "type": "string"
- }
- },
- "service": {
- "type": "string",
- "description": "The URL of the BackendService resource if this rule is matched."
- }
- }
- },
- "Project": {
- "id": "Project",
- "type": "object",
- "description": "A Project resource. Projects can only be created in the Google Developers Console. Unless marked otherwise, values can only be modified in the console.",
- "properties": {
- "commonInstanceMetadata": {
- "$ref": "Metadata",
- "description": "Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource."
- },
- "enabledFeatures": {
- "type": "array",
- "description": "Restricted features enabled for use on this project.",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#project for projects.",
- "default": "compute#project"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource."
- },
- "quotas": {
- "type": "array",
- "description": "[Output Only] Quotas assigned to this project.",
- "items": {
- "$ref": "Quota"
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "usageExportLocation": {
- "$ref": "UsageExportLocation",
- "description": "The location in Cloud Storage and naming method of the daily usage report."
- }
- }
- },
- "Quota": {
- "id": "Quota",
- "type": "object",
- "description": "A quotas entry.",
- "properties": {
- "limit": {
- "type": "number",
- "description": "[Output Only] Quota limit for this metric.",
- "format": "double"
- },
- "metric": {
- "type": "string",
- "description": "[Output Only] Name of the quota metric.",
- "enum": [
- "BACKEND_SERVICES",
- "CPUS",
- "DISKS_TOTAL_GB",
- "FIREWALLS",
- "FORWARDING_RULES",
- "HEALTH_CHECKS",
- "IMAGES",
- "INSTANCES",
- "INSTANCE_GROUPS",
- "INSTANCE_GROUP_MANAGERS",
- "INSTANCE_TEMPLATES",
- "IN_USE_ADDRESSES",
- "LOCAL_SSD_TOTAL_GB",
- "NETWORKS",
- "ROUTES",
- "SNAPSHOTS",
- "SSD_TOTAL_GB",
- "STATIC_ADDRESSES",
- "TARGET_HTTP_PROXIES",
- "TARGET_INSTANCES",
- "TARGET_POOLS",
- "TARGET_VPN_GATEWAYS",
- "URL_MAPS",
- "VPN_TUNNELS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "usage": {
- "type": "number",
- "description": "[Output Only] Current usage of this metric.",
- "format": "double"
- }
- }
- },
- "Region": {
- "id": "Region",
- "type": "object",
- "description": "Region resource.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "deprecated": {
- "$ref": "DeprecationStatus",
- "description": "[Output Only] The deprecation status associated with this region."
- },
- "description": {
- "type": "string",
- "description": "[Output Only] Textual description of the resource."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server .",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#region for regions.",
- "default": "compute#region"
- },
- "name": {
- "type": "string",
- "description": "[Output Only] Name of the resource."
- },
- "quotas": {
- "type": "array",
- "description": "[Output Only] Quotas assigned to this region.",
- "items": {
- "$ref": "Quota"
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "status": {
- "type": "string",
- "description": "[Output Only] Status of the region, either UP or DOWN.",
- "enum": [
- "DOWN",
- "UP"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "zones": {
- "type": "array",
- "description": "[Output Only] A list of zones available in this region, in the form of resource URLs.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "RegionList": {
- "id": "RegionList",
- "type": "object",
- "description": "Contains a list of region resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of Region resources.",
- "items": {
- "$ref": "Region"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#regionList for lists of regions.",
- "default": "compute#regionList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "ResourceGroupReference": {
- "id": "ResourceGroupReference",
- "type": "object",
- "properties": {
- "group": {
- "type": "string",
- "description": "A URI referencing one of the resource views listed in the backend service."
- }
- }
- },
- "Route": {
- "id": "Route",
- "type": "object",
- "description": "The route resource. A Route is a rule that specifies how certain packets should be handled by the virtual network. Routes are associated with instances by tag and the set of Routes for a particular instance is called its routing table. For each packet leaving a instance, the system searches that instance's routing table for a single best matching Route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the Route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching Routes. The packet is then forwarded as specified by the nextHop field of the winning Route -- either to another instance destination, a instance gateway or a Google Compute Engien-operated gateway. Packets that do not match any Route in the sending instance's routing table are dropped.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource. Provided by the client when the resource is created."
- },
- "destRange": {
- "type": "string",
- "description": "The destination range of outgoing packets that this route applies to.",
- "annotations": {
- "required": [
- "compute.routes.insert"
- ]
- }
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of this resource. Always compute#routes for Route resources.",
- "default": "compute#route"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.routes.insert"
- ]
- }
- },
- "network": {
- "type": "string",
- "description": "Fully-qualified URL of the network that this route applies to.",
- "annotations": {
- "required": [
- "compute.routes.insert"
- ]
- }
- },
- "nextHopGateway": {
- "type": "string",
- "description": "The URL to a gateway that should handle matching packets. Currently, this is only the internet gateway: projects/\u003cproject-id\u003e/global/gateways/default-internet-gateway"
- },
- "nextHopInstance": {
- "type": "string",
- "description": "The fully-qualified URL to an instance that should handle matching packets. For example:\nhttps://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/"
- },
- "nextHopIp": {
- "type": "string",
- "description": "The network IP address of an instance that should handle matching packets."
- },
- "nextHopNetwork": {
- "type": "string",
- "description": "The URL of the local network if it should handle matching packets."
- },
- "nextHopVpnTunnel": {
- "type": "string",
- "description": "The URL to a VpnTunnel that should handle matching packets."
- },
- "priority": {
- "type": "integer",
- "description": "Breaks ties between Routes of equal specificity. Routes with smaller values win when tied with routes with larger values. Default value is 1000. A valid range is between 0 and 65535.",
- "format": "uint32",
- "annotations": {
- "required": [
- "compute.routes.insert"
- ]
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined fully-qualified URL for this resource."
- },
- "tags": {
- "type": "array",
- "description": "A list of instance tags to which this route applies.",
- "items": {
- "type": "string"
- },
- "annotations": {
- "required": [
- "compute.routes.insert"
- ]
- }
- },
- "warnings": {
- "type": "array",
- "description": "[Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- }
- },
- "RouteList": {
- "id": "RouteList",
- "type": "object",
- "description": "Contains a list of route resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server."
- },
- "items": {
- "type": "array",
- "description": "A list of Route resources.",
- "items": {
- "$ref": "Route"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#routeList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "Scheduling": {
- "id": "Scheduling",
- "type": "object",
- "description": "Sets the scheduling options for an Instance.",
- "properties": {
- "automaticRestart": {
- "type": "boolean",
- "description": "Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted."
- },
- "onHostMaintenance": {
- "type": "string",
- "description": "Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting maintenance behavior.",
- "enum": [
- "MIGRATE",
- "TERMINATE"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "preemptible": {
- "type": "boolean",
- "description": "Whether the instance is preemptible."
- }
- }
- },
- "SerialPortOutput": {
- "id": "SerialPortOutput",
- "type": "object",
- "description": "An instance's serial console output.",
- "properties": {
- "contents": {
- "type": "string",
- "description": "[Output Only] The contents of the console output."
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.",
- "default": "compute#serialPortOutput"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server defined URL for the resource."
- }
- }
- },
- "ServiceAccount": {
- "id": "ServiceAccount",
- "type": "object",
- "description": "A service account.",
- "properties": {
- "email": {
- "type": "string",
- "description": "Email address of the service account."
- },
- "scopes": {
- "type": "array",
- "description": "The list of scopes to be made available for this service account.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "Snapshot": {
- "id": "Snapshot",
- "type": "object",
- "description": "A persistent disk snapshot resource.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "diskSizeGb": {
- "type": "string",
- "description": "[Output Only] Size of the snapshot, specified in GB.",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.",
- "default": "compute#snapshot"
- },
- "licenses": {
- "type": "array",
- "description": "Public visible licenses.",
- "items": {
- "type": "string"
- }
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "snapshotEncryptionKey": {
- "$ref": "CustomerEncryptionKey",
- "description": "Encrypts the snapshot using a customer-supplied encryption key.\n\nIf you encrypt a snapshot using a customer-supplied encryption key, and you want to use the snapshot later (e.g. to create a disk from the snapshot), you must provide the same key used encrypt the snapshot in your future request. If you provide an incorrect key, or no key, the request will fail.\n\nCustomer-supplied encryption keys do not protect access to metadata of the disk.\n\nIf no customer-supplied encryption key is provided at creation, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later."
- },
- "sourceDisk": {
- "type": "string",
- "description": "The source disk used to create this snapshot."
- },
- "sourceDiskEncryptionKey": {
- "$ref": "CustomerEncryptionKey",
- "description": "Specifies the customer-supplied encryption key of the source disk. This key is required if the source disk is protected by a customer-supplied encryption key.\n\nIf the incorrect key is provided, the request will fail."
- },
- "sourceDiskId": {
- "type": "string",
- "description": "[Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name."
- },
- "status": {
- "type": "string",
- "description": "[Output Only] The status of the snapshot.",
- "enum": [
- "CREATING",
- "DELETING",
- "FAILED",
- "READY",
- "UPLOADING"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "storageBytes": {
- "type": "string",
- "description": "[Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.",
- "format": "int64"
- },
- "storageBytesStatus": {
- "type": "string",
- "description": "[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation.",
- "enum": [
- "UPDATING",
- "UP_TO_DATE"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- }
- }
- },
- "SnapshotList": {
- "id": "SnapshotList",
- "type": "object",
- "description": "Contains a list of Snapshot resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server."
- },
- "items": {
- "type": "array",
- "description": "A list of Snapshot resources.",
- "items": {
- "$ref": "Snapshot"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#snapshotList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "SslCertificate": {
- "id": "SslCertificate",
- "type": "object",
- "description": "An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to global HTTPS loadbalancer to serve secure connections.",
- "properties": {
- "certificate": {
- "type": "string",
- "description": "A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource. Provided by the client when the resource is created."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.",
- "default": "compute#sslCertificate"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "privateKey": {
- "type": "string",
- "description": "A write-only private key in PEM format. Only insert RPCs will include this field."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output only] Server-defined URL for the resource."
- }
- }
- },
- "SslCertificateList": {
- "id": "SslCertificateList",
- "type": "object",
- "description": "Contains a list of SslCertificate resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server."
- },
- "items": {
- "type": "array",
- "description": "A list of SslCertificate resources.",
- "items": {
- "$ref": "SslCertificate"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#sslCertificateList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "Tags": {
- "id": "Tags",
- "type": "object",
- "description": "A set of instance tags.",
- "properties": {
- "fingerprint": {
- "type": "string",
- "description": "Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.\n\nTo see the latest fingerprint, make get() request to the instance.",
- "format": "byte"
- },
- "items": {
- "type": "array",
- "description": "An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "TargetHttpProxy": {
- "id": "TargetHttpProxy",
- "type": "object",
- "description": "A TargetHttpProxy resource. This resource defines an HTTP proxy.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#operation for Operation resources.",
- "default": "compute#targetHttpProxy"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "urlMap": {
- "type": "string",
- "description": "URL to the UrlMap resource that defines the mapping from URL to the BackendService."
- }
- }
- },
- "TargetHttpProxyList": {
- "id": "TargetHttpProxyList",
- "type": "object",
- "description": "A list of TargetHttpProxy resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "A list of TargetHttpProxy resources.",
- "items": {
- "$ref": "TargetHttpProxy"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource. Always compute#targetHttpProxyList for lists of Target HTTP proxies.",
- "default": "compute#targetHttpProxyList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "TargetHttpsProxiesSetSslCertificatesRequest": {
- "id": "TargetHttpsProxiesSetSslCertificatesRequest",
- "type": "object",
- "properties": {
- "sslCertificates": {
- "type": "array",
- "description": "New set of URLs to SslCertificate resources to associate with this TargetHttpProxy. Currently exactly one ssl certificate must be specified.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "TargetHttpsProxy": {
- "id": "TargetHttpsProxy",
- "type": "object",
- "description": "A TargetHttpsProxy resource. This resource defines an HTTPS proxy.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource. Provided by the client when the resource is created."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource.",
- "default": "compute#targetHttpsProxy"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "sslCertificates": {
- "type": "array",
- "description": "URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified.",
- "items": {
- "type": "string"
- }
- },
- "urlMap": {
- "type": "string",
- "description": "URL to the UrlMap resource that defines the mapping from URL to the BackendService."
- }
- }
- },
- "TargetHttpsProxyList": {
- "id": "TargetHttpsProxyList",
- "type": "object",
- "description": "Contains a list of TargetHttpsProxy resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "A list of TargetHttpsProxy resources.",
- "items": {
- "$ref": "TargetHttpsProxy"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#targetHttpsProxyList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "TargetInstance": {
- "id": "TargetInstance",
- "type": "object",
- "description": "A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "instance": {
- "type": "string",
- "description": "The URL to the instance that terminates the relevant traffic."
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource.",
- "default": "compute#targetInstance"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "natPolicy": {
- "type": "string",
- "description": "NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.",
- "enum": [
- "NO_NAT"
- ],
- "enumDescriptions": [
- ""
- ]
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "zone": {
- "type": "string",
- "description": "[Output Only] URL of the zone where the target instance resides."
- }
- }
- },
- "TargetInstanceAggregatedList": {
- "id": "TargetInstanceAggregatedList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "object",
- "description": "A map of scoped target instance lists.",
- "additionalProperties": {
- "$ref": "TargetInstancesScopedList",
- "description": "Name of the scope containing this set of target instances."
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#targetInstanceAggregatedList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "TargetInstanceList": {
- "id": "TargetInstanceList",
- "type": "object",
- "description": "Contains a list of TargetInstance resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "A list of TargetInstance resources.",
- "items": {
- "$ref": "TargetInstance"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#targetInstanceList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "TargetInstancesScopedList": {
- "id": "TargetInstancesScopedList",
- "type": "object",
- "properties": {
- "targetInstances": {
- "type": "array",
- "description": "List of target instances contained in this scope.",
- "items": {
- "$ref": "TargetInstance"
- }
- },
- "warning": {
- "type": "object",
- "description": "Informational warning which replaces the list of addresses when the list is empty.",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- },
- "TargetPool": {
- "id": "TargetPool",
- "type": "object",
- "description": "A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback TargetPool.",
- "properties": {
- "backupPool": {
- "type": "string",
- "description": "This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].\n\nbackupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.\n\nIn case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the \"force\" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "failoverRatio": {
- "type": "number",
- "description": "This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].\n\nIf set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.\n\nIn case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the \"force\" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.",
- "format": "float"
- },
- "healthChecks": {
- "type": "array",
- "description": "A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "instances": {
- "type": "array",
- "description": "A list of resource URLs to the member virtual machines serving this pool. They must live in zones contained in the same region as this pool.",
- "items": {
- "type": "string"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource.",
- "default": "compute#targetPool"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the target pool resides."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "sessionAffinity": {
- "type": "string",
- "description": "Sesssion affinity option, must be one of the following values:\nNONE: Connections from the same client IP may go to any instance in the pool.\nCLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.\nCLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.",
- "enum": [
- "CLIENT_IP",
- "CLIENT_IP_PROTO",
- "NONE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- }
- }
- },
- "TargetPoolAggregatedList": {
- "id": "TargetPoolAggregatedList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server."
- },
- "items": {
- "type": "object",
- "description": "A map of scoped target pool lists.",
- "additionalProperties": {
- "$ref": "TargetPoolsScopedList",
- "description": "Name of the scope containing this set of target pools."
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#targetPoolAggregatedList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "TargetPoolInstanceHealth": {
- "id": "TargetPoolInstanceHealth",
- "type": "object",
- "properties": {
- "healthStatus": {
- "type": "array",
- "items": {
- "$ref": "HealthStatus"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#targetPoolInstanceHealth"
- }
- }
- },
- "TargetPoolList": {
- "id": "TargetPoolList",
- "type": "object",
- "description": "Contains a list of TargetPool resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server."
- },
- "items": {
- "type": "array",
- "description": "A list of TargetPool resources.",
- "items": {
- "$ref": "TargetPool"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#targetPoolList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "TargetPoolsAddHealthCheckRequest": {
- "id": "TargetPoolsAddHealthCheckRequest",
- "type": "object",
- "properties": {
- "healthChecks": {
- "type": "array",
- "description": "Health check URLs to be added to targetPool.",
- "items": {
- "$ref": "HealthCheckReference"
- }
- }
- }
- },
- "TargetPoolsAddInstanceRequest": {
- "id": "TargetPoolsAddInstanceRequest",
- "type": "object",
- "properties": {
- "instances": {
- "type": "array",
- "description": "URLs of the instances to be added to targetPool.",
- "items": {
- "$ref": "InstanceReference"
- }
- }
- }
- },
- "TargetPoolsRemoveHealthCheckRequest": {
- "id": "TargetPoolsRemoveHealthCheckRequest",
- "type": "object",
- "properties": {
- "healthChecks": {
- "type": "array",
- "description": "Health check URLs to be removed from targetPool.",
- "items": {
- "$ref": "HealthCheckReference"
- }
- }
- }
- },
- "TargetPoolsRemoveInstanceRequest": {
- "id": "TargetPoolsRemoveInstanceRequest",
- "type": "object",
- "properties": {
- "instances": {
- "type": "array",
- "description": "URLs of the instances to be removed from targetPool.",
- "items": {
- "$ref": "InstanceReference"
- }
- }
- }
- },
- "TargetPoolsScopedList": {
- "id": "TargetPoolsScopedList",
- "type": "object",
- "properties": {
- "targetPools": {
- "type": "array",
- "description": "List of target pools contained in this scope.",
- "items": {
- "$ref": "TargetPool"
- }
- },
- "warning": {
- "type": "object",
- "description": "Informational warning which replaces the list of addresses when the list is empty.",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- },
- "TargetReference": {
- "id": "TargetReference",
- "type": "object",
- "properties": {
- "target": {
- "type": "string"
- }
- }
- },
- "TargetVpnGateway": {
- "id": "TargetVpnGateway",
- "type": "object",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource. Provided by the client when the resource is created."
- },
- "forwardingRules": {
- "type": "array",
- "description": "[Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.",
- "default": "compute#targetVpnGateway"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.targetVpnGateways.insert"
- ]
- }
- },
- "network": {
- "type": "string",
- "description": "URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.",
- "annotations": {
- "required": [
- "compute.targetVpnGateways.insert"
- ]
- }
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the target VPN gateway resides."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "status": {
- "type": "string",
- "description": "[Output Only] The status of the VPN gateway.",
- "enum": [
- "CREATING",
- "DELETING",
- "FAILED",
- "READY"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- },
- "tunnels": {
- "type": "array",
- "description": "[Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert and associated to a VPN gateway.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "TargetVpnGatewayAggregatedList": {
- "id": "TargetVpnGatewayAggregatedList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server."
- },
- "items": {
- "type": "object",
- "description": "A map of scoped target vpn gateway lists.",
- "additionalProperties": {
- "$ref": "TargetVpnGatewaysScopedList",
- "description": "[Output Only] Name of the scope containing this set of target vpn gateways."
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.",
- "default": "compute#targetVpnGatewayAggregatedList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- }
- }
- },
- "TargetVpnGatewayList": {
- "id": "TargetVpnGatewayList",
- "type": "object",
- "description": "Contains a list of TargetVpnGateway resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of TargetVpnGateway resources.",
- "items": {
- "$ref": "TargetVpnGateway"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.",
- "default": "compute#targetVpnGatewayList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- }
- }
- },
- "TargetVpnGatewaysScopedList": {
- "id": "TargetVpnGatewaysScopedList",
- "type": "object",
- "properties": {
- "targetVpnGateways": {
- "type": "array",
- "description": "[Output Only] List of target vpn gateways contained in this scope.",
- "items": {
- "$ref": "TargetVpnGateway"
- }
- },
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning which replaces the list of addresses when the list is empty.",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- },
- "TestFailure": {
- "id": "TestFailure",
- "type": "object",
- "properties": {
- "actualService": {
- "type": "string"
- },
- "expectedService": {
- "type": "string"
- },
- "host": {
- "type": "string"
- },
- "path": {
- "type": "string"
- }
- }
- },
- "UrlMap": {
- "id": "UrlMap",
- "type": "object",
- "description": "A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the \"longest-match\" of the URL's host and path.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "defaultService": {
- "type": "string",
- "description": "The URL of the BackendService resource if none of the hostRules match."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource. Provided by the client when the resource is created."
- },
- "fingerprint": {
- "type": "string",
- "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.",
- "format": "byte"
- },
- "hostRules": {
- "type": "array",
- "description": "The list of HostRules to use against the URL.",
- "items": {
- "$ref": "HostRule"
- }
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Set by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource.",
- "default": "compute#urlMap"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "pathMatchers": {
- "type": "array",
- "description": "The list of named PathMatchers to use against the URL.",
- "items": {
- "$ref": "PathMatcher"
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "tests": {
- "type": "array",
- "description": "The list of expected URL mappings. Request to update this UrlMap will succeed only all of the test cases pass.",
- "items": {
- "$ref": "UrlMapTest"
- }
- }
- }
- },
- "UrlMapList": {
- "id": "UrlMapList",
- "type": "object",
- "description": "Contains a list of UrlMap resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Set by the server."
- },
- "items": {
- "type": "array",
- "description": "A list of UrlMap resources.",
- "items": {
- "$ref": "UrlMap"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#urlMapList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "UrlMapReference": {
- "id": "UrlMapReference",
- "type": "object",
- "properties": {
- "urlMap": {
- "type": "string"
- }
- }
- },
- "UrlMapTest": {
- "id": "UrlMapTest",
- "type": "object",
- "description": "Message for the expected URL mappings.",
- "properties": {
- "description": {
- "type": "string",
- "description": "Description of this test case."
- },
- "host": {
- "type": "string",
- "description": "Host portion of the URL."
- },
- "path": {
- "type": "string",
- "description": "Path portion of the URL."
- },
- "service": {
- "type": "string",
- "description": "Expected BackendService resource the given URL should be mapped to."
- }
- }
- },
- "UrlMapValidationResult": {
- "id": "UrlMapValidationResult",
- "type": "object",
- "description": "Message representing the validation result for a UrlMap.",
- "properties": {
- "loadErrors": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "loadSucceeded": {
- "type": "boolean",
- "description": "Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons."
- },
- "testFailures": {
- "type": "array",
- "items": {
- "$ref": "TestFailure"
- }
- },
- "testPassed": {
- "type": "boolean",
- "description": "If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure."
- }
- }
- },
- "UrlMapsValidateRequest": {
- "id": "UrlMapsValidateRequest",
- "type": "object",
- "properties": {
- "resource": {
- "$ref": "UrlMap",
- "description": "Content of the UrlMap to be validated."
- }
- }
- },
- "UrlMapsValidateResponse": {
- "id": "UrlMapsValidateResponse",
- "type": "object",
- "properties": {
- "result": {
- "$ref": "UrlMapValidationResult"
- }
- }
- },
- "UsageExportLocation": {
- "id": "UsageExportLocation",
- "type": "object",
- "description": "The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix.",
- "properties": {
- "bucketName": {
- "type": "string",
- "description": "The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This is just the bucket name, with no gs:// or https://storage.googleapis.com/ in front of it."
- },
- "reportNamePrefix": {
- "type": "string",
- "description": "An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions."
- }
- }
- },
- "VpnTunnel": {
- "id": "VpnTunnel",
- "type": "object",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource. Provided by the client when the resource is created."
- },
- "detailedStatus": {
- "type": "string",
- "description": "[Output Only] Detailed status message for the VPN tunnel."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server.",
- "format": "uint64"
- },
- "ikeVersion": {
- "type": "integer",
- "description": "IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.",
- "default": "compute#vpnTunnel"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.vpnTunnels.insert"
- ]
- }
- },
- "peerIp": {
- "type": "string",
- "description": "IP address of the peer VPN gateway."
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the VPN tunnel resides."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "sharedSecret": {
- "type": "string",
- "description": "Shared secret used to set the secure session between the GCE VPN gateway and the peer VPN gateway."
- },
- "sharedSecretHash": {
- "type": "string",
- "description": "Hash of the shared secret."
- },
- "status": {
- "type": "string",
- "description": "[Output Only] The status of the VPN tunnel.",
- "enum": [
- "AUTHORIZATION_ERROR",
- "DEPROVISIONING",
- "ESTABLISHED",
- "FAILED",
- "FIRST_HANDSHAKE",
- "NEGOTIATION_FAILURE",
- "NETWORK_ERROR",
- "NO_INCOMING_PACKETS",
- "PROVISIONING",
- "REJECTED",
- "WAITING_FOR_FULL_CONFIG"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "targetVpnGateway": {
- "type": "string",
- "description": "URL of the VPN gateway to which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.",
- "annotations": {
- "required": [
- "compute.vpnTunnels.insert"
- ]
- }
- }
- }
- },
- "VpnTunnelAggregatedList": {
- "id": "VpnTunnelAggregatedList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "object",
- "description": "[Output Only] A map of scoped vpn tunnel lists.",
- "additionalProperties": {
- "$ref": "VpnTunnelsScopedList",
- "description": "Name of the scope containing this set of vpn tunnels."
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.",
- "default": "compute#vpnTunnelAggregatedList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "VpnTunnelList": {
- "id": "VpnTunnelList",
- "type": "object",
- "description": "Contains a list of VpnTunnel resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of VpnTunnel resources.",
- "items": {
- "$ref": "VpnTunnel"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.",
- "default": "compute#vpnTunnelList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- }
- }
- },
- "VpnTunnelsScopedList": {
- "id": "VpnTunnelsScopedList",
- "type": "object",
- "properties": {
- "vpnTunnels": {
- "type": "array",
- "description": "List of vpn tunnels contained in this scope.",
- "items": {
- "$ref": "VpnTunnel"
- }
- },
- "warning": {
- "type": "object",
- "description": "Informational warning which replaces the list of addresses when the list is empty.",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- },
- "Zone": {
- "id": "Zone",
- "type": "object",
- "description": "A Zone resource.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "deprecated": {
- "$ref": "DeprecationStatus",
- "description": "[Output Only] The deprecation status associated with this zone."
- },
- "description": {
- "type": "string",
- "description": "[Output Only] Textual description of the resource."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always kind#zone for zones.",
- "default": "compute#zone"
- },
- "maintenanceWindows": {
- "type": "array",
- "description": "[Output Only] Any scheduled maintenance windows for this zone. When the zone is in a maintenance window, all resources which reside in the zone will be unavailable. For more information, see Maintenance Windows",
- "items": {
- "type": "object",
- "properties": {
- "beginTime": {
- "type": "string",
- "description": "[Output Only] Starting time of the maintenance window, in RFC3339 format."
- },
- "description": {
- "type": "string",
- "description": "[Output Only] Textual description of the maintenance window."
- },
- "endTime": {
- "type": "string",
- "description": "[Output Only] Ending time of the maintenance window, in RFC3339 format."
- },
- "name": {
- "type": "string",
- "description": "[Output Only] Name of the maintenance window."
- }
- }
- }
- },
- "name": {
- "type": "string",
- "description": "[Output Only] Name of the resource."
- },
- "region": {
- "type": "string",
- "description": "[Output Only] Full URL reference to the region which hosts the zone."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "status": {
- "type": "string",
- "description": "[Output Only] Status of the zone, either UP or DOWN.",
- "enum": [
- "DOWN",
- "UP"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- }
- }
- },
- "ZoneList": {
- "id": "ZoneList",
- "type": "object",
- "description": "Contains a list of zone resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of Zone resources.",
- "items": {
- "$ref": "Zone"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#zoneList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- }
- },
- "resources": {
- "addresses": {
- "methods": {
- "aggregatedList": {
- "id": "compute.addresses.aggregatedList",
- "path": "{project}/aggregated/addresses",
- "httpMethod": "GET",
- "description": "Retrieves the list of addresses grouped by scope.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "AddressAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "delete": {
- "id": "compute.addresses.delete",
- "path": "{project}/regions/{region}/addresses/{address}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified address resource.",
- "parameters": {
- "address": {
- "type": "string",
- "description": "Name of the address resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "The name of the region for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "address"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.addresses.get",
- "path": "{project}/regions/{region}/addresses/{address}",
- "httpMethod": "GET",
- "description": "Returns the specified address resource.",
- "parameters": {
- "address": {
- "type": "string",
- "description": "Name of the address resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "The name of the region for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "address"
- ],
- "response": {
- "$ref": "Address"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.addresses.insert",
- "path": "{project}/regions/{region}/addresses",
- "httpMethod": "POST",
- "description": "Creates an address resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "The name of the region for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "request": {
- "$ref": "Address"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.addresses.list",
- "path": "{project}/regions/{region}/addresses",
- "httpMethod": "GET",
- "description": "Retrieves the list of address resources contained within the specified region.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "The name of the region for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "response": {
- "$ref": "AddressList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "autoscalers": {
- "methods": {
- "aggregatedList": {
- "id": "compute.autoscalers.aggregatedList",
- "path": "{project}/aggregated/autoscalers",
- "httpMethod": "GET",
- "description": "Retrieves the list of autoscalers grouped by scope.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "AutoscalerAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "delete": {
- "id": "compute.autoscalers.delete",
- "path": "{project}/zones/{zone}/autoscalers/{autoscaler}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified autoscaler resource.",
- "parameters": {
- "autoscaler": {
- "type": "string",
- "description": "Name of the persistent autoscaler resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "autoscaler"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.autoscalers.get",
- "path": "{project}/zones/{zone}/autoscalers/{autoscaler}",
- "httpMethod": "GET",
- "description": "Returns the specified autoscaler resource.",
- "parameters": {
- "autoscaler": {
- "type": "string",
- "description": "Name of the persistent autoscaler resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "autoscaler"
- ],
- "response": {
- "$ref": "Autoscaler"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.autoscalers.insert",
- "path": "{project}/zones/{zone}/autoscalers",
- "httpMethod": "POST",
- "description": "Creates an autoscaler resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "request": {
- "$ref": "Autoscaler"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.autoscalers.list",
- "path": "{project}/zones/{zone}/autoscalers",
- "httpMethod": "GET",
- "description": "Retrieves the list of autoscaler resources contained within the specified zone.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "response": {
- "$ref": "AutoscalerList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "patch": {
- "id": "compute.autoscalers.patch",
- "path": "{project}/zones/{zone}/autoscalers",
- "httpMethod": "PATCH",
- "description": "Updates an autoscaler resource in the specified project using the data included in the request. This method supports patch semantics.",
- "parameters": {
- "autoscaler": {
- "type": "string",
- "description": "Name of the autoscaler resource to update.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "autoscaler"
- ],
- "request": {
- "$ref": "Autoscaler"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "update": {
- "id": "compute.autoscalers.update",
- "path": "{project}/zones/{zone}/autoscalers",
- "httpMethod": "PUT",
- "description": "Updates an autoscaler resource in the specified project using the data included in the request.",
- "parameters": {
- "autoscaler": {
- "type": "string",
- "description": "Name of the autoscaler resource to update.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "request": {
- "$ref": "Autoscaler"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "backendServices": {
- "methods": {
- "delete": {
- "id": "compute.backendServices.delete",
- "path": "{project}/global/backendServices/{backendService}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified BackendService resource.",
- "parameters": {
- "backendService": {
- "type": "string",
- "description": "Name of the BackendService resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "backendService"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.backendServices.get",
- "path": "{project}/global/backendServices/{backendService}",
- "httpMethod": "GET",
- "description": "Returns the specified BackendService resource.",
- "parameters": {
- "backendService": {
- "type": "string",
- "description": "Name of the BackendService resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "backendService"
- ],
- "response": {
- "$ref": "BackendService"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "getHealth": {
- "id": "compute.backendServices.getHealth",
- "path": "{project}/global/backendServices/{backendService}/getHealth",
- "httpMethod": "POST",
- "description": "Gets the most recent health check results for this BackendService.",
- "parameters": {
- "backendService": {
- "type": "string",
- "description": "Name of the BackendService resource to which the queried instance belongs.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "backendService"
- ],
- "request": {
- "$ref": "ResourceGroupReference"
- },
- "response": {
- "$ref": "BackendServiceGroupHealth"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.backendServices.insert",
- "path": "{project}/global/backendServices",
- "httpMethod": "POST",
- "description": "Creates a BackendService resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "BackendService"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.backendServices.list",
- "path": "{project}/global/backendServices",
- "httpMethod": "GET",
- "description": "Retrieves the list of BackendService resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "BackendServiceList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "patch": {
- "id": "compute.backendServices.patch",
- "path": "{project}/global/backendServices/{backendService}",
- "httpMethod": "PATCH",
- "description": "Update the entire content of the BackendService resource. This method supports patch semantics.",
- "parameters": {
- "backendService": {
- "type": "string",
- "description": "Name of the BackendService resource to update.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "backendService"
- ],
- "request": {
- "$ref": "BackendService"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "update": {
- "id": "compute.backendServices.update",
- "path": "{project}/global/backendServices/{backendService}",
- "httpMethod": "PUT",
- "description": "Update the entire content of the BackendService resource.",
- "parameters": {
- "backendService": {
- "type": "string",
- "description": "Name of the BackendService resource to update.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "backendService"
- ],
- "request": {
- "$ref": "BackendService"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "diskTypes": {
- "methods": {
- "aggregatedList": {
- "id": "compute.diskTypes.aggregatedList",
- "path": "{project}/aggregated/diskTypes",
- "httpMethod": "GET",
- "description": "Retrieves the list of disk type resources grouped by scope.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "DiskTypeAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "get": {
- "id": "compute.diskTypes.get",
- "path": "{project}/zones/{zone}/diskTypes/{diskType}",
- "httpMethod": "GET",
- "description": "Returns the specified disk type resource.",
- "parameters": {
- "diskType": {
- "type": "string",
- "description": "Name of the disk type resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "diskType"
- ],
- "response": {
- "$ref": "DiskType"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "list": {
- "id": "compute.diskTypes.list",
- "path": "{project}/zones/{zone}/diskTypes",
- "httpMethod": "GET",
- "description": "Retrieves the list of disk type resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "response": {
- "$ref": "DiskTypeList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "disks": {
- "methods": {
- "aggregatedList": {
- "id": "compute.disks.aggregatedList",
- "path": "{project}/aggregated/disks",
- "httpMethod": "GET",
- "description": "Retrieves the list of disks grouped by scope.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "DiskAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "createSnapshot": {
- "id": "compute.disks.createSnapshot",
- "path": "{project}/zones/{zone}/disks/{disk}/createSnapshot",
- "httpMethod": "POST",
- "description": "Creates a snapshot of this disk.",
- "parameters": {
- "disk": {
- "type": "string",
- "description": "Name of the persistent disk to snapshot.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "disk"
- ],
- "request": {
- "$ref": "Snapshot"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "delete": {
- "id": "compute.disks.delete",
- "path": "{project}/zones/{zone}/disks/{disk}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.",
- "parameters": {
- "disk": {
- "type": "string",
- "description": "Name of the persistent disk to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "disk"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.disks.get",
- "path": "{project}/zones/{zone}/disks/{disk}",
- "httpMethod": "GET",
- "description": "Returns a specified persistent disk.",
- "parameters": {
- "disk": {
- "type": "string",
- "description": "Name of the persistent disk to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "disk"
- ],
- "response": {
- "$ref": "Disk"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.disks.insert",
- "path": "{project}/zones/{zone}/disks",
- "httpMethod": "POST",
- "description": "Creates a persistent disk in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "sourceImage": {
- "type": "string",
- "description": "Optional. Source image to restore onto a disk.",
- "location": "query"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "request": {
- "$ref": "Disk"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.disks.list",
- "path": "{project}/zones/{zone}/disks",
- "httpMethod": "GET",
- "description": "Retrieves the list of persistent disks contained within the specified zone.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "response": {
- "$ref": "DiskList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "firewalls": {
- "methods": {
- "delete": {
- "id": "compute.firewalls.delete",
- "path": "{project}/global/firewalls/{firewall}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified firewall resource.",
- "parameters": {
- "firewall": {
- "type": "string",
- "description": "Name of the firewall resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "firewall"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.firewalls.get",
- "path": "{project}/global/firewalls/{firewall}",
- "httpMethod": "GET",
- "description": "Returns the specified firewall resource.",
- "parameters": {
- "firewall": {
- "type": "string",
- "description": "Name of the firewall resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "firewall"
- ],
- "response": {
- "$ref": "Firewall"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.firewalls.insert",
- "path": "{project}/global/firewalls",
- "httpMethod": "POST",
- "description": "Creates a firewall resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "Firewall"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.firewalls.list",
- "path": "{project}/global/firewalls",
- "httpMethod": "GET",
- "description": "Retrieves the list of firewall resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "FirewallList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "patch": {
- "id": "compute.firewalls.patch",
- "path": "{project}/global/firewalls/{firewall}",
- "httpMethod": "PATCH",
- "description": "Updates the specified firewall resource with the data included in the request. This method supports patch semantics.",
- "parameters": {
- "firewall": {
- "type": "string",
- "description": "Name of the firewall resource to update.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "firewall"
- ],
- "request": {
- "$ref": "Firewall"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "update": {
- "id": "compute.firewalls.update",
- "path": "{project}/global/firewalls/{firewall}",
- "httpMethod": "PUT",
- "description": "Updates the specified firewall resource with the data included in the request.",
- "parameters": {
- "firewall": {
- "type": "string",
- "description": "Name of the firewall resource to update.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "firewall"
- ],
- "request": {
- "$ref": "Firewall"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "forwardingRules": {
- "methods": {
- "aggregatedList": {
- "id": "compute.forwardingRules.aggregatedList",
- "path": "{project}/aggregated/forwardingRules",
- "httpMethod": "GET",
- "description": "Retrieves the list of forwarding rules grouped by scope.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "ForwardingRuleAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "delete": {
- "id": "compute.forwardingRules.delete",
- "path": "{project}/regions/{region}/forwardingRules/{forwardingRule}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified ForwardingRule resource.",
- "parameters": {
- "forwardingRule": {
- "type": "string",
- "description": "Name of the ForwardingRule resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "forwardingRule"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.forwardingRules.get",
- "path": "{project}/regions/{region}/forwardingRules/{forwardingRule}",
- "httpMethod": "GET",
- "description": "Returns the specified ForwardingRule resource.",
- "parameters": {
- "forwardingRule": {
- "type": "string",
- "description": "Name of the ForwardingRule resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "forwardingRule"
- ],
- "response": {
- "$ref": "ForwardingRule"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.forwardingRules.insert",
- "path": "{project}/regions/{region}/forwardingRules",
- "httpMethod": "POST",
- "description": "Creates a ForwardingRule resource in the specified project and region using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "request": {
- "$ref": "ForwardingRule"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.forwardingRules.list",
- "path": "{project}/regions/{region}/forwardingRules",
- "httpMethod": "GET",
- "description": "Retrieves the list of ForwardingRule resources available to the specified project and region.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "response": {
- "$ref": "ForwardingRuleList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "setTarget": {
- "id": "compute.forwardingRules.setTarget",
- "path": "{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget",
- "httpMethod": "POST",
- "description": "Changes target url for forwarding rule.",
- "parameters": {
- "forwardingRule": {
- "type": "string",
- "description": "Name of the ForwardingRule resource in which target is to be set.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "forwardingRule"
- ],
- "request": {
- "$ref": "TargetReference"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "globalAddresses": {
- "methods": {
- "delete": {
- "id": "compute.globalAddresses.delete",
- "path": "{project}/global/addresses/{address}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified address resource.",
- "parameters": {
- "address": {
- "type": "string",
- "description": "Name of the address resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "address"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.globalAddresses.get",
- "path": "{project}/global/addresses/{address}",
- "httpMethod": "GET",
- "description": "Returns the specified address resource.",
- "parameters": {
- "address": {
- "type": "string",
- "description": "Name of the address resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "address"
- ],
- "response": {
- "$ref": "Address"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.globalAddresses.insert",
- "path": "{project}/global/addresses",
- "httpMethod": "POST",
- "description": "Creates an address resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "Address"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.globalAddresses.list",
- "path": "{project}/global/addresses",
- "httpMethod": "GET",
- "description": "Retrieves the list of global address resources.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "AddressList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "globalForwardingRules": {
- "methods": {
- "delete": {
- "id": "compute.globalForwardingRules.delete",
- "path": "{project}/global/forwardingRules/{forwardingRule}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified ForwardingRule resource.",
- "parameters": {
- "forwardingRule": {
- "type": "string",
- "description": "Name of the ForwardingRule resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "forwardingRule"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.globalForwardingRules.get",
- "path": "{project}/global/forwardingRules/{forwardingRule}",
- "httpMethod": "GET",
- "description": "Returns the specified ForwardingRule resource.",
- "parameters": {
- "forwardingRule": {
- "type": "string",
- "description": "Name of the ForwardingRule resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "forwardingRule"
- ],
- "response": {
- "$ref": "ForwardingRule"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.globalForwardingRules.insert",
- "path": "{project}/global/forwardingRules",
- "httpMethod": "POST",
- "description": "Creates a ForwardingRule resource in the specified project and region using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "ForwardingRule"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.globalForwardingRules.list",
- "path": "{project}/global/forwardingRules",
- "httpMethod": "GET",
- "description": "Retrieves the list of ForwardingRule resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "ForwardingRuleList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "setTarget": {
- "id": "compute.globalForwardingRules.setTarget",
- "path": "{project}/global/forwardingRules/{forwardingRule}/setTarget",
- "httpMethod": "POST",
- "description": "Changes target url for forwarding rule.",
- "parameters": {
- "forwardingRule": {
- "type": "string",
- "description": "Name of the ForwardingRule resource in which target is to be set.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "forwardingRule"
- ],
- "request": {
- "$ref": "TargetReference"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "globalOperations": {
- "methods": {
- "aggregatedList": {
- "id": "compute.globalOperations.aggregatedList",
- "path": "{project}/aggregated/operations",
- "httpMethod": "GET",
- "description": "Retrieves the list of all operations grouped by scope.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "OperationAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "delete": {
- "id": "compute.globalOperations.delete",
- "path": "{project}/global/operations/{operation}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified Operations resource.",
- "parameters": {
- "operation": {
- "type": "string",
- "description": "Name of the Operations resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "operation"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.globalOperations.get",
- "path": "{project}/global/operations/{operation}",
- "httpMethod": "GET",
- "description": "Retrieves the specified Operations resource.",
- "parameters": {
- "operation": {
- "type": "string",
- "description": "Name of the Operations resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "operation"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "list": {
- "id": "compute.globalOperations.list",
- "path": "{project}/global/operations",
- "httpMethod": "GET",
- "description": "Retrieves the list of Operation resources contained within the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "OperationList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "httpHealthChecks": {
- "methods": {
- "delete": {
- "id": "compute.httpHealthChecks.delete",
- "path": "{project}/global/httpHealthChecks/{httpHealthCheck}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified HttpHealthCheck resource.",
- "parameters": {
- "httpHealthCheck": {
- "type": "string",
- "description": "Name of the HttpHealthCheck resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "httpHealthCheck"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.httpHealthChecks.get",
- "path": "{project}/global/httpHealthChecks/{httpHealthCheck}",
- "httpMethod": "GET",
- "description": "Returns the specified HttpHealthCheck resource.",
- "parameters": {
- "httpHealthCheck": {
- "type": "string",
- "description": "Name of the HttpHealthCheck resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "httpHealthCheck"
- ],
- "response": {
- "$ref": "HttpHealthCheck"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.httpHealthChecks.insert",
- "path": "{project}/global/httpHealthChecks",
- "httpMethod": "POST",
- "description": "Creates a HttpHealthCheck resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "HttpHealthCheck"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.httpHealthChecks.list",
- "path": "{project}/global/httpHealthChecks",
- "httpMethod": "GET",
- "description": "Retrieves the list of HttpHealthCheck resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "HttpHealthCheckList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "patch": {
- "id": "compute.httpHealthChecks.patch",
- "path": "{project}/global/httpHealthChecks/{httpHealthCheck}",
- "httpMethod": "PATCH",
- "description": "Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.",
- "parameters": {
- "httpHealthCheck": {
- "type": "string",
- "description": "Name of the HttpHealthCheck resource to update.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "httpHealthCheck"
- ],
- "request": {
- "$ref": "HttpHealthCheck"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "update": {
- "id": "compute.httpHealthChecks.update",
- "path": "{project}/global/httpHealthChecks/{httpHealthCheck}",
- "httpMethod": "PUT",
- "description": "Updates a HttpHealthCheck resource in the specified project using the data included in the request.",
- "parameters": {
- "httpHealthCheck": {
- "type": "string",
- "description": "Name of the HttpHealthCheck resource to update.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "httpHealthCheck"
- ],
- "request": {
- "$ref": "HttpHealthCheck"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "httpsHealthChecks": {
- "methods": {
- "delete": {
- "id": "compute.httpsHealthChecks.delete",
- "path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified HttpsHealthCheck resource.",
- "parameters": {
- "httpsHealthCheck": {
- "type": "string",
- "description": "Name of the HttpsHealthCheck resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "httpsHealthCheck"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.httpsHealthChecks.get",
- "path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}",
- "httpMethod": "GET",
- "description": "Returns the specified HttpsHealthCheck resource.",
- "parameters": {
- "httpsHealthCheck": {
- "type": "string",
- "description": "Name of the HttpsHealthCheck resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "httpsHealthCheck"
- ],
- "response": {
- "$ref": "HttpsHealthCheck"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.httpsHealthChecks.insert",
- "path": "{project}/global/httpsHealthChecks",
- "httpMethod": "POST",
- "description": "Creates a HttpsHealthCheck resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "HttpsHealthCheck"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.httpsHealthChecks.list",
- "path": "{project}/global/httpsHealthChecks",
- "httpMethod": "GET",
- "description": "Retrieves the list of HttpsHealthCheck resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "HttpsHealthCheckList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "patch": {
- "id": "compute.httpsHealthChecks.patch",
- "path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}",
- "httpMethod": "PATCH",
- "description": "Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.",
- "parameters": {
- "httpsHealthCheck": {
- "type": "string",
- "description": "Name of the HttpsHealthCheck resource to update.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "httpsHealthCheck"
- ],
- "request": {
- "$ref": "HttpsHealthCheck"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "update": {
- "id": "compute.httpsHealthChecks.update",
- "path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}",
- "httpMethod": "PUT",
- "description": "Updates a HttpsHealthCheck resource in the specified project using the data included in the request.",
- "parameters": {
- "httpsHealthCheck": {
- "type": "string",
- "description": "Name of the HttpsHealthCheck resource to update.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "httpsHealthCheck"
- ],
- "request": {
- "$ref": "HttpsHealthCheck"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "images": {
- "methods": {
- "delete": {
- "id": "compute.images.delete",
- "path": "{project}/global/images/{image}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified image resource.",
- "parameters": {
- "image": {
- "type": "string",
- "description": "Name of the image resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "image"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "deprecate": {
- "id": "compute.images.deprecate",
- "path": "{project}/global/images/{image}/deprecate",
- "httpMethod": "POST",
- "description": "Sets the deprecation status of an image.\n\nIf an empty request body is given, clears the deprecation status instead.",
- "parameters": {
- "image": {
- "type": "string",
- "description": "Image name.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "image"
- ],
- "request": {
- "$ref": "DeprecationStatus"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.images.get",
- "path": "{project}/global/images/{image}",
- "httpMethod": "GET",
- "description": "Returns the specified image resource.",
- "parameters": {
- "image": {
- "type": "string",
- "description": "Name of the image resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "image"
- ],
- "response": {
- "$ref": "Image"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.images.insert",
- "path": "{project}/global/images",
- "httpMethod": "POST",
- "description": "Creates an image resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "Image"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/devstorage.full_control",
- "https://www.googleapis.com/auth/devstorage.read_only",
- "https://www.googleapis.com/auth/devstorage.read_write"
- ]
- },
- "list": {
- "id": "compute.images.list",
- "path": "{project}/global/images",
- "httpMethod": "GET",
- "description": "Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 7. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.\n\nSee Accessing images for more information.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "ImageList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "instanceGroupManagers": {
- "methods": {
- "abandonInstances": {
- "id": "compute.instanceGroupManagers.abandonInstances",
- "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances",
- "httpMethod": "POST",
- "description": "Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.",
- "parameters": {
- "instanceGroupManager": {
- "type": "string",
- "description": "The name of the managed instance group.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the managed instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
- ],
- "request": {
- "$ref": "InstanceGroupManagersAbandonInstancesRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "aggregatedList": {
- "id": "compute.instanceGroupManagers.aggregatedList",
- "path": "{project}/aggregated/instanceGroupManagers",
- "httpMethod": "GET",
- "description": "Retrieves the list of managed instance groups and groups them by zone.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "InstanceGroupManagerAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "delete": {
- "id": "compute.instanceGroupManagers.delete",
- "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified managed instance group and all of the instances in that group.",
- "parameters": {
- "instanceGroupManager": {
- "type": "string",
- "description": "The name of the managed instance group to delete.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the managed instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "deleteInstances": {
- "id": "compute.instanceGroupManagers.deleteInstances",
- "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances",
- "httpMethod": "POST",
- "description": "Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.",
- "parameters": {
- "instanceGroupManager": {
- "type": "string",
- "description": "The name of the managed instance group.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the managed instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
- ],
- "request": {
- "$ref": "InstanceGroupManagersDeleteInstancesRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.instanceGroupManagers.get",
- "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}",
- "httpMethod": "GET",
- "description": "Returns all of the details about the specified managed instance group.",
- "parameters": {
- "instanceGroupManager": {
- "type": "string",
- "description": "The name of the managed instance group.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the managed instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
- ],
- "response": {
- "$ref": "InstanceGroupManager"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.instanceGroupManagers.insert",
- "path": "{project}/zones/{zone}/instanceGroupManagers",
- "httpMethod": "POST",
- "description": "Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where you want to create the managed instance group.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "request": {
- "$ref": "InstanceGroupManager"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.instanceGroupManagers.list",
- "path": "{project}/zones/{zone}/instanceGroupManagers",
- "httpMethod": "GET",
- "description": "Retrieves a list of managed instance groups that are contained within the specified project and zone.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the managed instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "response": {
- "$ref": "InstanceGroupManagerList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "listManagedInstances": {
- "id": "compute.instanceGroupManagers.listManagedInstances",
- "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances",
- "httpMethod": "POST",
- "description": "Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action.",
- "parameters": {
- "instanceGroupManager": {
- "type": "string",
- "description": "The name of the managed instance group.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the managed instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
- ],
- "response": {
- "$ref": "InstanceGroupManagersListManagedInstancesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "recreateInstances": {
- "id": "compute.instanceGroupManagers.recreateInstances",
- "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances",
- "httpMethod": "POST",
- "description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.",
- "parameters": {
- "instanceGroupManager": {
- "type": "string",
- "description": "The name of the managed instance group.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the managed instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
- ],
- "request": {
- "$ref": "InstanceGroupManagersRecreateInstancesRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "resize": {
- "id": "compute.instanceGroupManagers.resize",
- "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize",
- "httpMethod": "POST",
- "description": "Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.",
- "parameters": {
- "instanceGroupManager": {
- "type": "string",
- "description": "The name of the managed instance group.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "size": {
- "type": "integer",
- "description": "The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter.",
- "required": true,
- "format": "int32",
- "location": "query"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the managed instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager",
- "size"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "setAutoHealingPolicies": {
- "id": "compute.instanceGroupManagers.setAutoHealingPolicies",
- "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setAutoHealingPolicies",
- "httpMethod": "POST",
- "description": "Modifies the autohealing policy.",
- "parameters": {
- "instanceGroupManager": {
- "type": "string",
- "description": "The name of the instance group manager.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The URL of the zone where the managed instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
- ],
- "request": {
- "$ref": "InstanceGroupManagersSetAutoHealingRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "setInstanceTemplate": {
- "id": "compute.instanceGroupManagers.setInstanceTemplate",
- "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate",
- "httpMethod": "POST",
- "description": "Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.",
- "parameters": {
- "instanceGroupManager": {
- "type": "string",
- "description": "The name of the managed instance group.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the managed instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
- ],
- "request": {
- "$ref": "InstanceGroupManagersSetInstanceTemplateRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "setTargetPools": {
- "id": "compute.instanceGroupManagers.setTargetPools",
- "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools",
- "httpMethod": "POST",
- "description": "Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.",
- "parameters": {
- "instanceGroupManager": {
- "type": "string",
- "description": "The name of the managed instance group.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the managed instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
- ],
- "request": {
- "$ref": "InstanceGroupManagersSetTargetPoolsRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "instanceGroups": {
- "methods": {
- "addInstances": {
- "id": "compute.instanceGroups.addInstances",
- "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances",
- "httpMethod": "POST",
- "description": "Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. TODO: Change to comment to state \"if IG is load balanced.\"",
- "parameters": {
- "instanceGroup": {
- "type": "string",
- "description": "The name of the instance group where you are adding instances.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroup"
- ],
- "request": {
- "$ref": "InstanceGroupsAddInstancesRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "aggregatedList": {
- "id": "compute.instanceGroups.aggregatedList",
- "path": "{project}/aggregated/instanceGroups",
- "httpMethod": "GET",
- "description": "Retrieves the list of instance groups and sorts them by zone.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "InstanceGroupAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "delete": {
- "id": "compute.instanceGroups.delete",
- "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified instance group. The instances in the group are not deleted.",
- "parameters": {
- "instanceGroup": {
- "type": "string",
- "description": "The name of the instance group to delete.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroup"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.instanceGroups.get",
- "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}",
- "httpMethod": "GET",
- "description": "Returns the specified instance group resource.",
- "parameters": {
- "instanceGroup": {
- "type": "string",
- "description": "The name of the instance group.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroup"
- ],
- "response": {
- "$ref": "InstanceGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.instanceGroups.insert",
- "path": "{project}/zones/{zone}/instanceGroups",
- "httpMethod": "POST",
- "description": "Creates an instance group in the specified project using the parameters that are included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where you want to create the instance group.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "request": {
- "$ref": "InstanceGroup"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.instanceGroups.list",
- "path": "{project}/zones/{zone}/instanceGroups",
- "httpMethod": "GET",
- "description": "Retrieves the list of instance groups that are located in the specified project and zone.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "response": {
- "$ref": "InstanceGroupList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "listInstances": {
- "id": "compute.instanceGroups.listInstances",
- "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances",
- "httpMethod": "POST",
- "description": "Lists the instances in the specified instance group.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "instanceGroup": {
- "type": "string",
- "description": "The name of the instance group from which you want to generate a list of included instances.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroup"
- ],
- "request": {
- "$ref": "InstanceGroupsListInstancesRequest"
- },
- "response": {
- "$ref": "InstanceGroupsListInstances"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "removeInstances": {
- "id": "compute.instanceGroups.removeInstances",
- "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances",
- "httpMethod": "POST",
- "description": "Removes one or more instances from the specified instance group, but does not delete those instances.",
- "parameters": {
- "instanceGroup": {
- "type": "string",
- "description": "The name of the instance group where the specified instances will be removed.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroup"
- ],
- "request": {
- "$ref": "InstanceGroupsRemoveInstancesRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "setNamedPorts": {
- "id": "compute.instanceGroups.setNamedPorts",
- "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts",
- "httpMethod": "POST",
- "description": "Sets the named ports for the specified instance group.",
- "parameters": {
- "instanceGroup": {
- "type": "string",
- "description": "The name of the instance group where the named ports are updated.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroup"
- ],
- "request": {
- "$ref": "InstanceGroupsSetNamedPortsRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "instanceTemplates": {
- "methods": {
- "delete": {
- "id": "compute.instanceTemplates.delete",
- "path": "{project}/global/instanceTemplates/{instanceTemplate}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified instance template.",
- "parameters": {
- "instanceTemplate": {
- "type": "string",
- "description": "The name of the instance template to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "instanceTemplate"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.instanceTemplates.get",
- "path": "{project}/global/instanceTemplates/{instanceTemplate}",
- "httpMethod": "GET",
- "description": "Returns the specified instance template resource.",
- "parameters": {
- "instanceTemplate": {
- "type": "string",
- "description": "The name of the instance template.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "instanceTemplate"
- ],
- "response": {
- "$ref": "InstanceTemplate"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.instanceTemplates.insert",
- "path": "{project}/global/instanceTemplates",
- "httpMethod": "POST",
- "description": "Creates an instance template in the specified project using the data that is included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "InstanceTemplate"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.instanceTemplates.list",
- "path": "{project}/global/instanceTemplates",
- "httpMethod": "GET",
- "description": "Retrieves a list of instance templates that are contained within the specified project and zone.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "InstanceTemplateList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "instances": {
- "methods": {
- "addAccessConfig": {
- "id": "compute.instances.addAccessConfig",
- "path": "{project}/zones/{zone}/instances/{instance}/addAccessConfig",
- "httpMethod": "POST",
- "description": "Adds an access config to an instance's network interface.",
- "parameters": {
- "instance": {
- "type": "string",
- "description": "The instance name for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "networkInterface": {
- "type": "string",
- "description": "The name of the network interface to add to this instance.",
- "required": true,
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance",
- "networkInterface"
- ],
- "request": {
- "$ref": "AccessConfig"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "aggregatedList": {
- "id": "compute.instances.aggregatedList",
- "path": "{project}/aggregated/instances",
- "httpMethod": "GET",
- "description": "Retrieves aggregated list of instance resources.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "InstanceAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "attachDisk": {
- "id": "compute.instances.attachDisk",
- "path": "{project}/zones/{zone}/instances/{instance}/attachDisk",
- "httpMethod": "POST",
- "description": "Attaches a Disk resource to an instance.",
- "parameters": {
- "instance": {
- "type": "string",
- "description": "Instance name.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "request": {
- "$ref": "AttachedDisk"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "delete": {
- "id": "compute.instances.delete",
- "path": "{project}/zones/{zone}/instances/{instance}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified Instance resource. For more information, see Shutting down an instance.",
- "parameters": {
- "instance": {
- "type": "string",
- "description": "Name of the instance resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "deleteAccessConfig": {
- "id": "compute.instances.deleteAccessConfig",
- "path": "{project}/zones/{zone}/instances/{instance}/deleteAccessConfig",
- "httpMethod": "POST",
- "description": "Deletes an access config from an instance's network interface.",
- "parameters": {
- "accessConfig": {
- "type": "string",
- "description": "The name of the access config to delete.",
- "required": true,
- "location": "query"
- },
- "instance": {
- "type": "string",
- "description": "The instance name for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "networkInterface": {
- "type": "string",
- "description": "The name of the network interface.",
- "required": true,
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance",
- "accessConfig",
- "networkInterface"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "detachDisk": {
- "id": "compute.instances.detachDisk",
- "path": "{project}/zones/{zone}/instances/{instance}/detachDisk",
- "httpMethod": "POST",
- "description": "Detaches a disk from an instance.",
- "parameters": {
- "deviceName": {
- "type": "string",
- "description": "Disk device name to detach.",
- "required": true,
- "pattern": "\\w[\\w.-]{0,254}",
- "location": "query"
- },
- "instance": {
- "type": "string",
- "description": "Instance name.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance",
- "deviceName"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.instances.get",
- "path": "{project}/zones/{zone}/instances/{instance}",
- "httpMethod": "GET",
- "description": "Returns the specified instance resource.",
- "parameters": {
- "instance": {
- "type": "string",
- "description": "Name of the instance resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "response": {
- "$ref": "Instance"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "getSerialPortOutput": {
- "id": "compute.instances.getSerialPortOutput",
- "path": "{project}/zones/{zone}/instances/{instance}/serialPort",
- "httpMethod": "GET",
- "description": "Returns the specified instance's serial port output.",
- "parameters": {
- "instance": {
- "type": "string",
- "description": "Name of the instance scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "port": {
- "type": "integer",
- "description": "Specifies which COM or serial port to retrieve data from.",
- "default": "1",
- "format": "int32",
- "minimum": "1",
- "maximum": "4",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "response": {
- "$ref": "SerialPortOutput"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.instances.insert",
- "path": "{project}/zones/{zone}/instances",
- "httpMethod": "POST",
- "description": "Creates an instance resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "request": {
- "$ref": "Instance"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.instances.list",
- "path": "{project}/zones/{zone}/instances",
- "httpMethod": "GET",
- "description": "Retrieves the list of instance resources contained within the specified zone.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "response": {
- "$ref": "InstanceList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "reset": {
- "id": "compute.instances.reset",
- "path": "{project}/zones/{zone}/instances/{instance}/reset",
- "httpMethod": "POST",
- "description": "Performs a hard reset on the instance.",
- "parameters": {
- "instance": {
- "type": "string",
- "description": "Name of the instance scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "setDiskAutoDelete": {
- "id": "compute.instances.setDiskAutoDelete",
- "path": "{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete",
- "httpMethod": "POST",
- "description": "Sets the auto-delete flag for a disk attached to an instance.",
- "parameters": {
- "autoDelete": {
- "type": "boolean",
- "description": "Whether to auto-delete the disk when the instance is deleted.",
- "required": true,
- "location": "query"
- },
- "deviceName": {
- "type": "string",
- "description": "The device name of the disk to modify.",
- "required": true,
- "pattern": "\\w[\\w.-]{0,254}",
- "location": "query"
- },
- "instance": {
- "type": "string",
- "description": "The instance name.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance",
- "autoDelete",
- "deviceName"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "setLabels": {
- "id": "compute.instances.setLabels",
- "path": "{project}/zones/{zone}/instances/{instance}/setLabels",
- "httpMethod": "POST",
- "description": "Sets labels for the specified instance to the data included in the request.",
- "parameters": {
- "instance": {
- "type": "string",
- "description": "Name of the instance scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "request": {
- "$ref": "InstancesSetLabelsRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "setMachineType": {
- "id": "compute.instances.setMachineType",
- "path": "{project}/zones/{zone}/instances/{instance}/setMachineType",
- "httpMethod": "POST",
- "description": "Sets machine type for the specified instances to the data included in the request.",
- "parameters": {
- "instance": {
- "type": "string",
- "description": "Name of the instance scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "request": {
- "$ref": "InstancesSetMachineTypeRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "setMetadata": {
- "id": "compute.instances.setMetadata",
- "path": "{project}/zones/{zone}/instances/{instance}/setMetadata",
- "httpMethod": "POST",
- "description": "Sets metadata for the specified instance to the data included in the request.",
- "parameters": {
- "instance": {
- "type": "string",
- "description": "Name of the instance scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "request": {
- "$ref": "Metadata"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "setScheduling": {
- "id": "compute.instances.setScheduling",
- "path": "{project}/zones/{zone}/instances/{instance}/setScheduling",
- "httpMethod": "POST",
- "description": "Sets an instance's scheduling options.",
- "parameters": {
- "instance": {
- "type": "string",
- "description": "Instance name.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "request": {
- "$ref": "Scheduling"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "setTags": {
- "id": "compute.instances.setTags",
- "path": "{project}/zones/{zone}/instances/{instance}/setTags",
- "httpMethod": "POST",
- "description": "Sets tags for the specified instance to the data included in the request.",
- "parameters": {
- "instance": {
- "type": "string",
- "description": "Name of the instance scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "request": {
- "$ref": "Tags"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "start": {
- "id": "compute.instances.start",
- "path": "{project}/zones/{zone}/instances/{instance}/start",
- "httpMethod": "POST",
- "description": "This method starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.",
- "parameters": {
- "instance": {
- "type": "string",
- "description": "Name of the instance resource to start.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "stop": {
- "id": "compute.instances.stop",
- "path": "{project}/zones/{zone}/instances/{instance}/stop",
- "httpMethod": "POST",
- "description": "This method stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses,will continue to be charged until they are deleted. For more information, see Stopping an instance.",
- "parameters": {
- "instance": {
- "type": "string",
- "description": "Name of the instance resource to stop.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "licenses": {
- "methods": {
- "get": {
- "id": "compute.licenses.get",
- "path": "{project}/global/licenses/{license}",
- "httpMethod": "GET",
- "description": "Returns the specified license resource.",
- "parameters": {
- "license": {
- "type": "string",
- "description": "Name of the license resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "license"
- ],
- "response": {
- "$ref": "License"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "machineTypes": {
- "methods": {
- "aggregatedList": {
- "id": "compute.machineTypes.aggregatedList",
- "path": "{project}/aggregated/machineTypes",
- "httpMethod": "GET",
- "description": "Retrieves the list of machine type resources grouped by scope.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "MachineTypeAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "get": {
- "id": "compute.machineTypes.get",
- "path": "{project}/zones/{zone}/machineTypes/{machineType}",
- "httpMethod": "GET",
- "description": "Returns the specified machine type resource.",
- "parameters": {
- "machineType": {
- "type": "string",
- "description": "Name of the machine type resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "machineType"
- ],
- "response": {
- "$ref": "MachineType"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "list": {
- "id": "compute.machineTypes.list",
- "path": "{project}/zones/{zone}/machineTypes",
- "httpMethod": "GET",
- "description": "Retrieves the list of machine type resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "response": {
- "$ref": "MachineTypeList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "networks": {
- "methods": {
- "delete": {
- "id": "compute.networks.delete",
- "path": "{project}/global/networks/{network}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified network resource.",
- "parameters": {
- "network": {
- "type": "string",
- "description": "Name of the network resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "network"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.networks.get",
- "path": "{project}/global/networks/{network}",
- "httpMethod": "GET",
- "description": "Returns the specified network resource.",
- "parameters": {
- "network": {
- "type": "string",
- "description": "Name of the network resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "network"
- ],
- "response": {
- "$ref": "Network"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.networks.insert",
- "path": "{project}/global/networks",
- "httpMethod": "POST",
- "description": "Creates a network resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "Network"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.networks.list",
- "path": "{project}/global/networks",
- "httpMethod": "GET",
- "description": "Retrieves the list of network resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "NetworkList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "projects": {
- "methods": {
- "get": {
- "id": "compute.projects.get",
- "path": "{project}",
- "httpMethod": "GET",
- "description": "Returns the specified project resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "Project"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "setCommonInstanceMetadata": {
- "id": "compute.projects.setCommonInstanceMetadata",
- "path": "{project}/setCommonInstanceMetadata",
- "httpMethod": "POST",
- "description": "Sets metadata common to all instances within the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "Metadata"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "setUsageExportBucket": {
- "id": "compute.projects.setUsageExportBucket",
- "path": "{project}/setUsageExportBucket",
- "httpMethod": "POST",
- "description": "Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "UsageExportLocation"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/devstorage.full_control",
- "https://www.googleapis.com/auth/devstorage.read_only",
- "https://www.googleapis.com/auth/devstorage.read_write"
- ]
- },
- "setUsageExportCloudStorageBucket": {
- "id": "compute.projects.setUsageExportCloudStorageBucket",
- "path": "{project}/setUsageExportCloudStorageBucket",
- "httpMethod": "POST",
- "description": "[Deprecated] Use setUsageExportBucket instead.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "UsageExportLocation"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/devstorage.full_control",
- "https://www.googleapis.com/auth/devstorage.read_only",
- "https://www.googleapis.com/auth/devstorage.read_write"
- ]
- }
- }
- },
- "regionOperations": {
- "methods": {
- "delete": {
- "id": "compute.regionOperations.delete",
- "path": "{project}/regions/{region}/operations/{operation}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified region-specific Operations resource.",
- "parameters": {
- "operation": {
- "type": "string",
- "description": "Name of the Operations resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "operation"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.regionOperations.get",
- "path": "{project}/regions/{region}/operations/{operation}",
- "httpMethod": "GET",
- "description": "Retrieves the specified region-specific Operations resource.",
- "parameters": {
- "operation": {
- "type": "string",
- "description": "Name of the Operations resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "operation"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "list": {
- "id": "compute.regionOperations.list",
- "path": "{project}/regions/{region}/operations",
- "httpMethod": "GET",
- "description": "Retrieves the list of Operation resources contained within the specified region.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "response": {
- "$ref": "OperationList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "regions": {
- "methods": {
- "get": {
- "id": "compute.regions.get",
- "path": "{project}/regions/{region}",
- "httpMethod": "GET",
- "description": "Returns the specified region resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "response": {
- "$ref": "Region"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "list": {
- "id": "compute.regions.list",
- "path": "{project}/regions",
- "httpMethod": "GET",
- "description": "Retrieves the list of region resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "RegionList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "routes": {
- "methods": {
- "delete": {
- "id": "compute.routes.delete",
- "path": "{project}/global/routes/{route}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified route resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "route": {
- "type": "string",
- "description": "Name of the route resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "route"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.routes.get",
- "path": "{project}/global/routes/{route}",
- "httpMethod": "GET",
- "description": "Returns the specified route resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "route": {
- "type": "string",
- "description": "Name of the route resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "route"
- ],
- "response": {
- "$ref": "Route"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.routes.insert",
- "path": "{project}/global/routes",
- "httpMethod": "POST",
- "description": "Creates a route resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "Route"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.routes.list",
- "path": "{project}/global/routes",
- "httpMethod": "GET",
- "description": "Retrieves the list of route resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "RouteList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "snapshots": {
- "methods": {
- "delete": {
- "id": "compute.snapshots.delete",
- "path": "{project}/global/snapshots/{snapshot}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.\n\nFor more information, see Deleting snaphots.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "snapshot": {
- "type": "string",
- "description": "Name of the Snapshot resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "snapshot"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.snapshots.get",
- "path": "{project}/global/snapshots/{snapshot}",
- "httpMethod": "GET",
- "description": "Returns the specified Snapshot resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "snapshot": {
- "type": "string",
- "description": "Name of the Snapshot resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "snapshot"
- ],
- "response": {
- "$ref": "Snapshot"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "list": {
- "id": "compute.snapshots.list",
- "path": "{project}/global/snapshots",
- "httpMethod": "GET",
- "description": "Retrieves the list of Snapshot resources contained within the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "SnapshotList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "sslCertificates": {
- "methods": {
- "delete": {
- "id": "compute.sslCertificates.delete",
- "path": "{project}/global/sslCertificates/{sslCertificate}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified SslCertificate resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "sslCertificate": {
- "type": "string",
- "description": "Name of the SslCertificate resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "sslCertificate"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.sslCertificates.get",
- "path": "{project}/global/sslCertificates/{sslCertificate}",
- "httpMethod": "GET",
- "description": "Returns the specified SslCertificate resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "sslCertificate": {
- "type": "string",
- "description": "Name of the SslCertificate resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "sslCertificate"
- ],
- "response": {
- "$ref": "SslCertificate"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.sslCertificates.insert",
- "path": "{project}/global/sslCertificates",
- "httpMethod": "POST",
- "description": "Creates a SslCertificate resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "SslCertificate"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.sslCertificates.list",
- "path": "{project}/global/sslCertificates",
- "httpMethod": "GET",
- "description": "Retrieves the list of SslCertificate resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "SslCertificateList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "targetHttpProxies": {
- "methods": {
- "delete": {
- "id": "compute.targetHttpProxies.delete",
- "path": "{project}/global/targetHttpProxies/{targetHttpProxy}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified TargetHttpProxy resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "targetHttpProxy": {
- "type": "string",
- "description": "Name of the TargetHttpProxy resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "targetHttpProxy"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.targetHttpProxies.get",
- "path": "{project}/global/targetHttpProxies/{targetHttpProxy}",
- "httpMethod": "GET",
- "description": "Returns the specified TargetHttpProxy resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "targetHttpProxy": {
- "type": "string",
- "description": "Name of the TargetHttpProxy resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "targetHttpProxy"
- ],
- "response": {
- "$ref": "TargetHttpProxy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.targetHttpProxies.insert",
- "path": "{project}/global/targetHttpProxies",
- "httpMethod": "POST",
- "description": "Creates a TargetHttpProxy resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "TargetHttpProxy"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.targetHttpProxies.list",
- "path": "{project}/global/targetHttpProxies",
- "httpMethod": "GET",
- "description": "Retrieves the list of TargetHttpProxy resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "TargetHttpProxyList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "setUrlMap": {
- "id": "compute.targetHttpProxies.setUrlMap",
- "path": "{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap",
- "httpMethod": "POST",
- "description": "Changes the URL map for TargetHttpProxy.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "targetHttpProxy": {
- "type": "string",
- "description": "Name of the TargetHttpProxy resource whose URL map is to be set.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "targetHttpProxy"
- ],
- "request": {
- "$ref": "UrlMapReference"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "targetHttpsProxies": {
- "methods": {
- "delete": {
- "id": "compute.targetHttpsProxies.delete",
- "path": "{project}/global/targetHttpsProxies/{targetHttpsProxy}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified TargetHttpsProxy resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "targetHttpsProxy": {
- "type": "string",
- "description": "Name of the TargetHttpsProxy resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "targetHttpsProxy"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.targetHttpsProxies.get",
- "path": "{project}/global/targetHttpsProxies/{targetHttpsProxy}",
- "httpMethod": "GET",
- "description": "Returns the specified TargetHttpsProxy resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "targetHttpsProxy": {
- "type": "string",
- "description": "Name of the TargetHttpsProxy resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "targetHttpsProxy"
- ],
- "response": {
- "$ref": "TargetHttpsProxy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.targetHttpsProxies.insert",
- "path": "{project}/global/targetHttpsProxies",
- "httpMethod": "POST",
- "description": "Creates a TargetHttpsProxy resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "TargetHttpsProxy"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.targetHttpsProxies.list",
- "path": "{project}/global/targetHttpsProxies",
- "httpMethod": "GET",
- "description": "Retrieves the list of TargetHttpsProxy resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "TargetHttpsProxyList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "setSslCertificates": {
- "id": "compute.targetHttpsProxies.setSslCertificates",
- "path": "{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates",
- "httpMethod": "POST",
- "description": "Replaces SslCertificates for TargetHttpsProxy.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "targetHttpsProxy": {
- "type": "string",
- "description": "Name of the TargetHttpsProxy resource whose URL map is to be set.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "targetHttpsProxy"
- ],
- "request": {
- "$ref": "TargetHttpsProxiesSetSslCertificatesRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "setUrlMap": {
- "id": "compute.targetHttpsProxies.setUrlMap",
- "path": "{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap",
- "httpMethod": "POST",
- "description": "Changes the URL map for TargetHttpsProxy.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "targetHttpsProxy": {
- "type": "string",
- "description": "Name of the TargetHttpsProxy resource whose URL map is to be set.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "targetHttpsProxy"
- ],
- "request": {
- "$ref": "UrlMapReference"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "targetInstances": {
- "methods": {
- "aggregatedList": {
- "id": "compute.targetInstances.aggregatedList",
- "path": "{project}/aggregated/targetInstances",
- "httpMethod": "GET",
- "description": "Retrieves the list of target instances grouped by scope.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "TargetInstanceAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "delete": {
- "id": "compute.targetInstances.delete",
- "path": "{project}/zones/{zone}/targetInstances/{targetInstance}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified TargetInstance resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "targetInstance": {
- "type": "string",
- "description": "Name of the TargetInstance resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "targetInstance"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.targetInstances.get",
- "path": "{project}/zones/{zone}/targetInstances/{targetInstance}",
- "httpMethod": "GET",
- "description": "Returns the specified TargetInstance resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "targetInstance": {
- "type": "string",
- "description": "Name of the TargetInstance resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "targetInstance"
- ],
- "response": {
- "$ref": "TargetInstance"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.targetInstances.insert",
- "path": "{project}/zones/{zone}/targetInstances",
- "httpMethod": "POST",
- "description": "Creates a TargetInstance resource in the specified project and zone using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "request": {
- "$ref": "TargetInstance"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.targetInstances.list",
- "path": "{project}/zones/{zone}/targetInstances",
- "httpMethod": "GET",
- "description": "Retrieves the list of TargetInstance resources available to the specified project and zone.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "response": {
- "$ref": "TargetInstanceList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "targetPools": {
- "methods": {
- "addHealthCheck": {
- "id": "compute.targetPools.addHealthCheck",
- "path": "{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck",
- "httpMethod": "POST",
- "description": "Adds health check URL to targetPool.",
- "parameters": {
- "project": {
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "targetPool": {
- "type": "string",
- "description": "Name of the TargetPool resource to which health_check_url is to be added.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "targetPool"
- ],
- "request": {
- "$ref": "TargetPoolsAddHealthCheckRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "addInstance": {
- "id": "compute.targetPools.addInstance",
- "path": "{project}/regions/{region}/targetPools/{targetPool}/addInstance",
- "httpMethod": "POST",
- "description": "Adds instance url to targetPool.",
- "parameters": {
- "project": {
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "targetPool": {
- "type": "string",
- "description": "Name of the TargetPool resource to which instance_url is to be added.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "targetPool"
- ],
- "request": {
- "$ref": "TargetPoolsAddInstanceRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "aggregatedList": {
- "id": "compute.targetPools.aggregatedList",
- "path": "{project}/aggregated/targetPools",
- "httpMethod": "GET",
- "description": "Retrieves the list of target pools grouped by scope.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "TargetPoolAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "delete": {
- "id": "compute.targetPools.delete",
- "path": "{project}/regions/{region}/targetPools/{targetPool}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified TargetPool resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "targetPool": {
- "type": "string",
- "description": "Name of the TargetPool resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "targetPool"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.targetPools.get",
- "path": "{project}/regions/{region}/targetPools/{targetPool}",
- "httpMethod": "GET",
- "description": "Returns the specified TargetPool resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "targetPool": {
- "type": "string",
- "description": "Name of the TargetPool resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "targetPool"
- ],
- "response": {
- "$ref": "TargetPool"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "getHealth": {
- "id": "compute.targetPools.getHealth",
- "path": "{project}/regions/{region}/targetPools/{targetPool}/getHealth",
- "httpMethod": "POST",
- "description": "Gets the most recent health check results for each IP for the given instance that is referenced by given TargetPool.",
- "parameters": {
- "project": {
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "targetPool": {
- "type": "string",
- "description": "Name of the TargetPool resource to which the queried instance belongs.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "targetPool"
- ],
- "request": {
- "$ref": "InstanceReference"
- },
- "response": {
- "$ref": "TargetPoolInstanceHealth"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.targetPools.insert",
- "path": "{project}/regions/{region}/targetPools",
- "httpMethod": "POST",
- "description": "Creates a TargetPool resource in the specified project and region using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "request": {
- "$ref": "TargetPool"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.targetPools.list",
- "path": "{project}/regions/{region}/targetPools",
- "httpMethod": "GET",
- "description": "Retrieves the list of TargetPool resources available to the specified project and region.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "response": {
- "$ref": "TargetPoolList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "removeHealthCheck": {
- "id": "compute.targetPools.removeHealthCheck",
- "path": "{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck",
- "httpMethod": "POST",
- "description": "Removes health check URL from targetPool.",
- "parameters": {
- "project": {
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "targetPool": {
- "type": "string",
- "description": "Name of the TargetPool resource to which health_check_url is to be removed.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "targetPool"
- ],
- "request": {
- "$ref": "TargetPoolsRemoveHealthCheckRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "removeInstance": {
- "id": "compute.targetPools.removeInstance",
- "path": "{project}/regions/{region}/targetPools/{targetPool}/removeInstance",
- "httpMethod": "POST",
- "description": "Removes instance URL from targetPool.",
- "parameters": {
- "project": {
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "targetPool": {
- "type": "string",
- "description": "Name of the TargetPool resource to which instance_url is to be removed.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "targetPool"
- ],
- "request": {
- "$ref": "TargetPoolsRemoveInstanceRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "setBackup": {
- "id": "compute.targetPools.setBackup",
- "path": "{project}/regions/{region}/targetPools/{targetPool}/setBackup",
- "httpMethod": "POST",
- "description": "Changes backup pool configurations.",
- "parameters": {
- "failoverRatio": {
- "type": "number",
- "description": "New failoverRatio value for the containing target pool.",
- "format": "float",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "targetPool": {
- "type": "string",
- "description": "Name of the TargetPool resource for which the backup is to be set.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "targetPool"
- ],
- "request": {
- "$ref": "TargetReference"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "targetVpnGateways": {
- "methods": {
- "aggregatedList": {
- "id": "compute.targetVpnGateways.aggregatedList",
- "path": "{project}/aggregated/targetVpnGateways",
- "httpMethod": "GET",
- "description": "Retrieves the list of target VPN gateways grouped by scope.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "TargetVpnGatewayAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "delete": {
- "id": "compute.targetVpnGateways.delete",
- "path": "{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified TargetVpnGateway resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "The name of the region for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "targetVpnGateway": {
- "type": "string",
- "description": "Name of the TargetVpnGateway resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "targetVpnGateway"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.targetVpnGateways.get",
- "path": "{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}",
- "httpMethod": "GET",
- "description": "Returns the specified TargetVpnGateway resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "The name of the region for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "targetVpnGateway": {
- "type": "string",
- "description": "Name of the TargetVpnGateway resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "targetVpnGateway"
- ],
- "response": {
- "$ref": "TargetVpnGateway"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.targetVpnGateways.insert",
- "path": "{project}/regions/{region}/targetVpnGateways",
- "httpMethod": "POST",
- "description": "Creates a TargetVpnGateway resource in the specified project and region using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "The name of the region for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "request": {
- "$ref": "TargetVpnGateway"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.targetVpnGateways.list",
- "path": "{project}/regions/{region}/targetVpnGateways",
- "httpMethod": "GET",
- "description": "Retrieves the list of TargetVpnGateway resources available to the specified project and region.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "The name of the region for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "response": {
- "$ref": "TargetVpnGatewayList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "urlMaps": {
- "methods": {
- "delete": {
- "id": "compute.urlMaps.delete",
- "path": "{project}/global/urlMaps/{urlMap}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified UrlMap resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "urlMap": {
- "type": "string",
- "description": "Name of the UrlMap resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "urlMap"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.urlMaps.get",
- "path": "{project}/global/urlMaps/{urlMap}",
- "httpMethod": "GET",
- "description": "Returns the specified UrlMap resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "urlMap": {
- "type": "string",
- "description": "Name of the UrlMap resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "urlMap"
- ],
- "response": {
- "$ref": "UrlMap"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.urlMaps.insert",
- "path": "{project}/global/urlMaps",
- "httpMethod": "POST",
- "description": "Creates a UrlMap resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "UrlMap"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.urlMaps.list",
- "path": "{project}/global/urlMaps",
- "httpMethod": "GET",
- "description": "Retrieves the list of UrlMap resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "UrlMapList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "patch": {
- "id": "compute.urlMaps.patch",
- "path": "{project}/global/urlMaps/{urlMap}",
- "httpMethod": "PATCH",
- "description": "Update the entire content of the UrlMap resource. This method supports patch semantics.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "urlMap": {
- "type": "string",
- "description": "Name of the UrlMap resource to update.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "urlMap"
- ],
- "request": {
- "$ref": "UrlMap"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "update": {
- "id": "compute.urlMaps.update",
- "path": "{project}/global/urlMaps/{urlMap}",
- "httpMethod": "PUT",
- "description": "Update the entire content of the UrlMap resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "urlMap": {
- "type": "string",
- "description": "Name of the UrlMap resource to update.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "urlMap"
- ],
- "request": {
- "$ref": "UrlMap"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "validate": {
- "id": "compute.urlMaps.validate",
- "path": "{project}/global/urlMaps/{urlMap}/validate",
- "httpMethod": "POST",
- "description": "Run static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "urlMap": {
- "type": "string",
- "description": "Name of the UrlMap resource to be validated as.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "urlMap"
- ],
- "request": {
- "$ref": "UrlMapsValidateRequest"
- },
- "response": {
- "$ref": "UrlMapsValidateResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "vpnTunnels": {
- "methods": {
- "aggregatedList": {
- "id": "compute.vpnTunnels.aggregatedList",
- "path": "{project}/aggregated/vpnTunnels",
- "httpMethod": "GET",
- "description": "Retrieves the list of VPN tunnels grouped by scope.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "VpnTunnelAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "delete": {
- "id": "compute.vpnTunnels.delete",
- "path": "{project}/regions/{region}/vpnTunnels/{vpnTunnel}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified VpnTunnel resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "The name of the region for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "vpnTunnel": {
- "type": "string",
- "description": "Name of the VpnTunnel resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "vpnTunnel"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.vpnTunnels.get",
- "path": "{project}/regions/{region}/vpnTunnels/{vpnTunnel}",
- "httpMethod": "GET",
- "description": "Returns the specified VpnTunnel resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "The name of the region for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "vpnTunnel": {
- "type": "string",
- "description": "Name of the VpnTunnel resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "vpnTunnel"
- ],
- "response": {
- "$ref": "VpnTunnel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.vpnTunnels.insert",
- "path": "{project}/regions/{region}/vpnTunnels",
- "httpMethod": "POST",
- "description": "Creates a VpnTunnel resource in the specified project and region using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "The name of the region for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "request": {
- "$ref": "VpnTunnel"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.vpnTunnels.list",
- "path": "{project}/regions/{region}/vpnTunnels",
- "httpMethod": "GET",
- "description": "Retrieves the list of VpnTunnel resources contained in the specified project and region.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "The name of the region for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "response": {
- "$ref": "VpnTunnelList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "zoneOperations": {
- "methods": {
- "delete": {
- "id": "compute.zoneOperations.delete",
- "path": "{project}/zones/{zone}/operations/{operation}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified zone-specific Operations resource.",
- "parameters": {
- "operation": {
- "type": "string",
- "description": "Name of the Operations resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "operation"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.zoneOperations.get",
- "path": "{project}/zones/{zone}/operations/{operation}",
- "httpMethod": "GET",
- "description": "Retrieves the specified zone-specific Operations resource.",
- "parameters": {
- "operation": {
- "type": "string",
- "description": "Name of the Operations resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "operation"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "list": {
- "id": "compute.zoneOperations.list",
- "path": "{project}/zones/{zone}/operations",
- "httpMethod": "GET",
- "description": "Retrieves the list of Operation resources contained within the specified zone.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "response": {
- "$ref": "OperationList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "zones": {
- "methods": {
- "get": {
- "id": "compute.zones.get",
- "path": "{project}/zones/{zone}",
- "httpMethod": "GET",
- "description": "Returns the specified zone resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "response": {
- "$ref": "Zone"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "list": {
- "id": "compute.zones.list",
- "path": "{project}/zones",
- "httpMethod": "GET",
- "description": "Retrieves the list of zone resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "ZoneList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/compute/v0.beta/compute-gen.go b/vendor/google.golang.org/api/compute/v0.beta/compute-gen.go
deleted file mode 100644
index ae14a801..00000000
--- a/vendor/google.golang.org/api/compute/v0.beta/compute-gen.go
+++ /dev/null
@@ -1,39109 +0,0 @@
-// Package compute provides access to the Compute Engine API.
-//
-// See https://developers.google.com/compute/docs/reference/latest/
-//
-// Usage example:
-//
-// import "google.golang.org/api/compute/v0.beta"
-// ...
-// computeService, err := compute.New(oauthHttpClient)
-package compute // import "google.golang.org/api/compute/v0.beta"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "compute:beta"
-const apiName = "compute"
-const apiVersion = "beta"
-const basePath = "https://www.googleapis.com/compute/beta/projects/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your data across Google Cloud Platform services
- CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
-
- // View and manage your Google Compute Engine resources
- ComputeScope = "https://www.googleapis.com/auth/compute"
-
- // View your Google Compute Engine resources
- ComputeReadonlyScope = "https://www.googleapis.com/auth/compute.readonly"
-
- // Manage your data and permissions in Google Cloud Storage
- DevstorageFullControlScope = "https://www.googleapis.com/auth/devstorage.full_control"
-
- // View your data in Google Cloud Storage
- DevstorageReadOnlyScope = "https://www.googleapis.com/auth/devstorage.read_only"
-
- // Manage your data in Google Cloud Storage
- DevstorageReadWriteScope = "https://www.googleapis.com/auth/devstorage.read_write"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Addresses = NewAddressesService(s)
- s.Autoscalers = NewAutoscalersService(s)
- s.BackendServices = NewBackendServicesService(s)
- s.DiskTypes = NewDiskTypesService(s)
- s.Disks = NewDisksService(s)
- s.Firewalls = NewFirewallsService(s)
- s.ForwardingRules = NewForwardingRulesService(s)
- s.GlobalAddresses = NewGlobalAddressesService(s)
- s.GlobalForwardingRules = NewGlobalForwardingRulesService(s)
- s.GlobalOperations = NewGlobalOperationsService(s)
- s.HttpHealthChecks = NewHttpHealthChecksService(s)
- s.HttpsHealthChecks = NewHttpsHealthChecksService(s)
- s.Images = NewImagesService(s)
- s.InstanceGroupManagers = NewInstanceGroupManagersService(s)
- s.InstanceGroups = NewInstanceGroupsService(s)
- s.InstanceTemplates = NewInstanceTemplatesService(s)
- s.Instances = NewInstancesService(s)
- s.Licenses = NewLicensesService(s)
- s.MachineTypes = NewMachineTypesService(s)
- s.Networks = NewNetworksService(s)
- s.Projects = NewProjectsService(s)
- s.RegionOperations = NewRegionOperationsService(s)
- s.Regions = NewRegionsService(s)
- s.Routes = NewRoutesService(s)
- s.Snapshots = NewSnapshotsService(s)
- s.SslCertificates = NewSslCertificatesService(s)
- s.TargetHttpProxies = NewTargetHttpProxiesService(s)
- s.TargetHttpsProxies = NewTargetHttpsProxiesService(s)
- s.TargetInstances = NewTargetInstancesService(s)
- s.TargetPools = NewTargetPoolsService(s)
- s.TargetVpnGateways = NewTargetVpnGatewaysService(s)
- s.UrlMaps = NewUrlMapsService(s)
- s.VpnTunnels = NewVpnTunnelsService(s)
- s.ZoneOperations = NewZoneOperationsService(s)
- s.Zones = NewZonesService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Addresses *AddressesService
-
- Autoscalers *AutoscalersService
-
- BackendServices *BackendServicesService
-
- DiskTypes *DiskTypesService
-
- Disks *DisksService
-
- Firewalls *FirewallsService
-
- ForwardingRules *ForwardingRulesService
-
- GlobalAddresses *GlobalAddressesService
-
- GlobalForwardingRules *GlobalForwardingRulesService
-
- GlobalOperations *GlobalOperationsService
-
- HttpHealthChecks *HttpHealthChecksService
-
- HttpsHealthChecks *HttpsHealthChecksService
-
- Images *ImagesService
-
- InstanceGroupManagers *InstanceGroupManagersService
-
- InstanceGroups *InstanceGroupsService
-
- InstanceTemplates *InstanceTemplatesService
-
- Instances *InstancesService
-
- Licenses *LicensesService
-
- MachineTypes *MachineTypesService
-
- Networks *NetworksService
-
- Projects *ProjectsService
-
- RegionOperations *RegionOperationsService
-
- Regions *RegionsService
-
- Routes *RoutesService
-
- Snapshots *SnapshotsService
-
- SslCertificates *SslCertificatesService
-
- TargetHttpProxies *TargetHttpProxiesService
-
- TargetHttpsProxies *TargetHttpsProxiesService
-
- TargetInstances *TargetInstancesService
-
- TargetPools *TargetPoolsService
-
- TargetVpnGateways *TargetVpnGatewaysService
-
- UrlMaps *UrlMapsService
-
- VpnTunnels *VpnTunnelsService
-
- ZoneOperations *ZoneOperationsService
-
- Zones *ZonesService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewAddressesService(s *Service) *AddressesService {
- rs := &AddressesService{s: s}
- return rs
-}
-
-type AddressesService struct {
- s *Service
-}
-
-func NewAutoscalersService(s *Service) *AutoscalersService {
- rs := &AutoscalersService{s: s}
- return rs
-}
-
-type AutoscalersService struct {
- s *Service
-}
-
-func NewBackendServicesService(s *Service) *BackendServicesService {
- rs := &BackendServicesService{s: s}
- return rs
-}
-
-type BackendServicesService struct {
- s *Service
-}
-
-func NewDiskTypesService(s *Service) *DiskTypesService {
- rs := &DiskTypesService{s: s}
- return rs
-}
-
-type DiskTypesService struct {
- s *Service
-}
-
-func NewDisksService(s *Service) *DisksService {
- rs := &DisksService{s: s}
- return rs
-}
-
-type DisksService struct {
- s *Service
-}
-
-func NewFirewallsService(s *Service) *FirewallsService {
- rs := &FirewallsService{s: s}
- return rs
-}
-
-type FirewallsService struct {
- s *Service
-}
-
-func NewForwardingRulesService(s *Service) *ForwardingRulesService {
- rs := &ForwardingRulesService{s: s}
- return rs
-}
-
-type ForwardingRulesService struct {
- s *Service
-}
-
-func NewGlobalAddressesService(s *Service) *GlobalAddressesService {
- rs := &GlobalAddressesService{s: s}
- return rs
-}
-
-type GlobalAddressesService struct {
- s *Service
-}
-
-func NewGlobalForwardingRulesService(s *Service) *GlobalForwardingRulesService {
- rs := &GlobalForwardingRulesService{s: s}
- return rs
-}
-
-type GlobalForwardingRulesService struct {
- s *Service
-}
-
-func NewGlobalOperationsService(s *Service) *GlobalOperationsService {
- rs := &GlobalOperationsService{s: s}
- return rs
-}
-
-type GlobalOperationsService struct {
- s *Service
-}
-
-func NewHttpHealthChecksService(s *Service) *HttpHealthChecksService {
- rs := &HttpHealthChecksService{s: s}
- return rs
-}
-
-type HttpHealthChecksService struct {
- s *Service
-}
-
-func NewHttpsHealthChecksService(s *Service) *HttpsHealthChecksService {
- rs := &HttpsHealthChecksService{s: s}
- return rs
-}
-
-type HttpsHealthChecksService struct {
- s *Service
-}
-
-func NewImagesService(s *Service) *ImagesService {
- rs := &ImagesService{s: s}
- return rs
-}
-
-type ImagesService struct {
- s *Service
-}
-
-func NewInstanceGroupManagersService(s *Service) *InstanceGroupManagersService {
- rs := &InstanceGroupManagersService{s: s}
- return rs
-}
-
-type InstanceGroupManagersService struct {
- s *Service
-}
-
-func NewInstanceGroupsService(s *Service) *InstanceGroupsService {
- rs := &InstanceGroupsService{s: s}
- return rs
-}
-
-type InstanceGroupsService struct {
- s *Service
-}
-
-func NewInstanceTemplatesService(s *Service) *InstanceTemplatesService {
- rs := &InstanceTemplatesService{s: s}
- return rs
-}
-
-type InstanceTemplatesService struct {
- s *Service
-}
-
-func NewInstancesService(s *Service) *InstancesService {
- rs := &InstancesService{s: s}
- return rs
-}
-
-type InstancesService struct {
- s *Service
-}
-
-func NewLicensesService(s *Service) *LicensesService {
- rs := &LicensesService{s: s}
- return rs
-}
-
-type LicensesService struct {
- s *Service
-}
-
-func NewMachineTypesService(s *Service) *MachineTypesService {
- rs := &MachineTypesService{s: s}
- return rs
-}
-
-type MachineTypesService struct {
- s *Service
-}
-
-func NewNetworksService(s *Service) *NetworksService {
- rs := &NetworksService{s: s}
- return rs
-}
-
-type NetworksService struct {
- s *Service
-}
-
-func NewProjectsService(s *Service) *ProjectsService {
- rs := &ProjectsService{s: s}
- return rs
-}
-
-type ProjectsService struct {
- s *Service
-}
-
-func NewRegionOperationsService(s *Service) *RegionOperationsService {
- rs := &RegionOperationsService{s: s}
- return rs
-}
-
-type RegionOperationsService struct {
- s *Service
-}
-
-func NewRegionsService(s *Service) *RegionsService {
- rs := &RegionsService{s: s}
- return rs
-}
-
-type RegionsService struct {
- s *Service
-}
-
-func NewRoutesService(s *Service) *RoutesService {
- rs := &RoutesService{s: s}
- return rs
-}
-
-type RoutesService struct {
- s *Service
-}
-
-func NewSnapshotsService(s *Service) *SnapshotsService {
- rs := &SnapshotsService{s: s}
- return rs
-}
-
-type SnapshotsService struct {
- s *Service
-}
-
-func NewSslCertificatesService(s *Service) *SslCertificatesService {
- rs := &SslCertificatesService{s: s}
- return rs
-}
-
-type SslCertificatesService struct {
- s *Service
-}
-
-func NewTargetHttpProxiesService(s *Service) *TargetHttpProxiesService {
- rs := &TargetHttpProxiesService{s: s}
- return rs
-}
-
-type TargetHttpProxiesService struct {
- s *Service
-}
-
-func NewTargetHttpsProxiesService(s *Service) *TargetHttpsProxiesService {
- rs := &TargetHttpsProxiesService{s: s}
- return rs
-}
-
-type TargetHttpsProxiesService struct {
- s *Service
-}
-
-func NewTargetInstancesService(s *Service) *TargetInstancesService {
- rs := &TargetInstancesService{s: s}
- return rs
-}
-
-type TargetInstancesService struct {
- s *Service
-}
-
-func NewTargetPoolsService(s *Service) *TargetPoolsService {
- rs := &TargetPoolsService{s: s}
- return rs
-}
-
-type TargetPoolsService struct {
- s *Service
-}
-
-func NewTargetVpnGatewaysService(s *Service) *TargetVpnGatewaysService {
- rs := &TargetVpnGatewaysService{s: s}
- return rs
-}
-
-type TargetVpnGatewaysService struct {
- s *Service
-}
-
-func NewUrlMapsService(s *Service) *UrlMapsService {
- rs := &UrlMapsService{s: s}
- return rs
-}
-
-type UrlMapsService struct {
- s *Service
-}
-
-func NewVpnTunnelsService(s *Service) *VpnTunnelsService {
- rs := &VpnTunnelsService{s: s}
- return rs
-}
-
-type VpnTunnelsService struct {
- s *Service
-}
-
-func NewZoneOperationsService(s *Service) *ZoneOperationsService {
- rs := &ZoneOperationsService{s: s}
- return rs
-}
-
-type ZoneOperationsService struct {
- s *Service
-}
-
-func NewZonesService(s *Service) *ZonesService {
- rs := &ZonesService{s: s}
- return rs
-}
-
-type ZonesService struct {
- s *Service
-}
-
-// AccessConfig: An access configuration attached to an instance's
-// network interface.
-type AccessConfig struct {
- // Kind: [Output Only] Type of the resource. Always compute#accessConfig
- // for access configs.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this access configuration.
- Name string `json:"name,omitempty"`
-
- // NatIP: An external IP address associated with this instance. Specify
- // an unused static external IP address available to the project or
- // leave this field undefined to use an IP from a shared ephemeral IP
- // address pool. If you specify a static external IP address, it must
- // live in the same region as the zone of the instance.
- NatIP string `json:"natIP,omitempty"`
-
- // Type: The type of configuration. The default and only option is
- // ONE_TO_ONE_NAT.
- //
- // Possible values:
- // "ONE_TO_ONE_NAT" (default)
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccessConfig) MarshalJSON() ([]byte, error) {
- type noMethod AccessConfig
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Address: A reserved address resource.
-type Address struct {
- // Address: The static external IP address represented by this resource.
- Address string `json:"address,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always compute#address for
- // addresses.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // Region: [Output Only] URL of the region where the regional address
- // resides. This field is not applicable to global addresses.
- Region string `json:"region,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Status: [Output Only] The status of the address, which can be either
- // IN_USE or RESERVED. An address that is RESERVED is currently reserved
- // and available to use. An IN_USE address is currently being used by
- // another resource and is not available.
- //
- // Possible values:
- // "IN_USE"
- // "RESERVED"
- Status string `json:"status,omitempty"`
-
- // Users: [Output Only] The URLs of the resources that are using this
- // address.
- Users []string `json:"users,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Address") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Address) MarshalJSON() ([]byte, error) {
- type noMethod Address
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AddressAggregatedList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A map of scoped address lists.
- Items map[string]AddressesScopedList `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always
- // compute#addressAggregatedList for aggregated lists of addresses.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AddressAggregatedList) MarshalJSON() ([]byte, error) {
- type noMethod AddressAggregatedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AddressList: Contains a list of address resources.
-type AddressList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of Address resources.
- Items []*Address `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#addressList for
- // lists of addresses.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AddressList) MarshalJSON() ([]byte, error) {
- type noMethod AddressList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AddressesScopedList struct {
- // Addresses: [Output Only] List of addresses contained in this scope.
- Addresses []*Address `json:"addresses,omitempty"`
-
- // Warning: [Output Only] Informational warning which replaces the list
- // of addresses when the list is empty.
- Warning *AddressesScopedListWarning `json:"warning,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Addresses") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AddressesScopedList) MarshalJSON() ([]byte, error) {
- type noMethod AddressesScopedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AddressesScopedListWarning: [Output Only] Informational warning which
-// replaces the list of addresses when the list is empty.
-type AddressesScopedListWarning struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*AddressesScopedListWarningData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AddressesScopedListWarning) MarshalJSON() ([]byte, error) {
- type noMethod AddressesScopedListWarning
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AddressesScopedListWarningData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AddressesScopedListWarningData) MarshalJSON() ([]byte, error) {
- type noMethod AddressesScopedListWarningData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AttachedDisk: An instance-attached disk resource.
-type AttachedDisk struct {
- // AutoDelete: Specifies whether the disk will be auto-deleted when the
- // instance is deleted (but not when the disk is detached from the
- // instance).
- AutoDelete bool `json:"autoDelete,omitempty"`
-
- // Boot: Indicates that this is a boot disk. The virtual machine will
- // use the first partition of the disk for its root filesystem.
- Boot bool `json:"boot,omitempty"`
-
- // DeviceName: Specifies a unique device name of your choice that is
- // reflected into the /dev/disk/by-id/google-* tree of a Linux operating
- // system running within the instance. This name can be used to
- // reference the device for mounting, resizing, and so on, from within
- // the instance.
- //
- // If not specified, the server chooses a default device name to apply
- // to this disk, in the form persistent-disks-x, where x is a number
- // assigned by Google Compute Engine. This field is only applicable for
- // persistent disks.
- DeviceName string `json:"deviceName,omitempty"`
-
- // DiskEncryptionKey: Encrypts or decrypts a disk using a
- // customer-supplied encryption key.
- //
- // If you are creating a new disk, this field encrypts the disk using a
- // customer-supplied encryption key. If you are attaching an existing
- // disk that is already encrypted, this field decrypts the disk using
- // the customer-supplied encryption key.
- //
- // If you encrypt a new disk using a customer-supplied encryption key,
- // you must provide the same key again when attempting to use this
- // resource at a later time (e.g. to create a snapshot or image from the
- // disk or to attach the disk to a virtual machine).
- //
- // If no customer-supplied encryption key is provided at creation, then
- // the disk will be encrypted using an automatically generated key and
- // you do not need to provide a key to use the disk later.
- DiskEncryptionKey *CustomerEncryptionKey `json:"diskEncryptionKey,omitempty"`
-
- // Index: Assigns a zero-based index to this disk, where 0 is reserved
- // for the boot disk. For example, if you have many disks attached to an
- // instance, each disk would have a unique index number. If not
- // specified, the server will choose an appropriate value.
- Index int64 `json:"index,omitempty"`
-
- // InitializeParams: [Input Only] Specifies the parameters for a new
- // disk that will be created alongside the new instance. Use
- // initialization parameters to create boot disks or local SSDs attached
- // to the new instance.
- //
- // This property is mutually exclusive with the source property; you can
- // only define one or the other, but not both.
- InitializeParams *AttachedDiskInitializeParams `json:"initializeParams,omitempty"`
-
- // Interface: Specifies the disk interface to use for attaching this
- // disk, either SCSI or NVME. The default is SCSI. For performance
- // characteristics of SCSI over NVMe, see Local SSD performance.
- //
- // Possible values:
- // "NVME"
- // "SCSI"
- Interface string `json:"interface,omitempty"`
-
- // Kind: [Output Only] Type of the resource. Always compute#attachedDisk
- // for attached disks.
- Kind string `json:"kind,omitempty"`
-
- // Licenses: [Output Only] Any valid publicly visible licenses.
- Licenses []string `json:"licenses,omitempty"`
-
- // Mode: The mode in which to attach this disk, either READ_WRITE or
- // READ_ONLY. If not specified, the default is to attach the disk in
- // READ_WRITE mode.
- //
- // Possible values:
- // "READ_ONLY"
- // "READ_WRITE"
- Mode string `json:"mode,omitempty"`
-
- // Source: Specifies a valid partial or full URL to an existing
- // Persistent Disk resource. This field is only applicable for
- // persistent disks.
- Source string `json:"source,omitempty"`
-
- // Type: Specifies the type of the disk, either SCRATCH or PERSISTENT.
- // If not specified, the default is PERSISTENT.
- //
- // Possible values:
- // "PERSISTENT"
- // "SCRATCH"
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AutoDelete") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AttachedDisk) MarshalJSON() ([]byte, error) {
- type noMethod AttachedDisk
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AttachedDiskInitializeParams: [Input Only] Specifies the parameters
-// for a new disk that will be created alongside the new instance. Use
-// initialization parameters to create boot disks or local SSDs attached
-// to the new instance.
-//
-// This property is mutually exclusive with the source property; you can
-// only define one or the other, but not both.
-type AttachedDiskInitializeParams struct {
- // DiskName: Specifies the disk name. If not specified, the default is
- // to use the name of the instance.
- DiskName string `json:"diskName,omitempty"`
-
- // DiskSizeGb: Specifies the size of the disk in base-2 GB.
- DiskSizeGb int64 `json:"diskSizeGb,omitempty,string"`
-
- // DiskStorageType: Storage type of the disk.
- //
- // Possible values:
- // "HDD"
- // "SSD"
- DiskStorageType string `json:"diskStorageType,omitempty"`
-
- // DiskType: Specifies the disk type to use to create the instance. If
- // not specified, the default is pd-standard, specified using the full
- // URL. For
- // example:
- //
- // https://www.googleapis.com/compute/v1/projects/project/zones
- // /zone/diskTypes/pd-standard
- //
- // Other values include pd-ssd and local-ssd. If you define this field,
- // you can provide either the full or partial URL. For example, the
- // following are valid values:
- // -
- // https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
- // - projects/project/zones/zone/diskTypes/diskType
- // - zones/zone/diskTypes/diskType
- DiskType string `json:"diskType,omitempty"`
-
- // SourceImage: A source image used to create the disk. You can provide
- // a private (custom) image, and Compute Engine will use the
- // corresponding image from your project. For
- // example:
- //
- // global/images/my-private-image
- //
- // Or you can provide an image from a publicly-available project. For
- // example, to use a Debian image from the debian-cloud project, make
- // sure to include the project in the
- // URL:
- //
- // projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
- //
- // where vYYYYMMDD is the image version. The fully-qualified URL will
- // also work in both cases.
- SourceImage string `json:"sourceImage,omitempty"`
-
- // SourceImageEncryptionKey: The customer-supplied encryption key of the
- // source image. This key is required if the source image is protected
- // by a customer-supplied encryption key.
- //
- // If the incorrect key is provided, the operation will fail.
- SourceImageEncryptionKey *CustomerEncryptionKey `json:"sourceImageEncryptionKey,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DiskName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AttachedDiskInitializeParams) MarshalJSON() ([]byte, error) {
- type noMethod AttachedDiskInitializeParams
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Autoscaler struct {
- // AutoscalingPolicy: Autoscaling configuration.
- AutoscalingPolicy *AutoscalingPolicy `json:"autoscalingPolicy,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: Type of the resource.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource. Provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Target: URL of Instance Group Manager or Replica Pool which will be
- // controlled by Autoscaler.
- Target string `json:"target,omitempty"`
-
- // Zone: [Output Only] URL of the zone where the instance group resides.
- Zone string `json:"zone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AutoscalingPolicy")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Autoscaler) MarshalJSON() ([]byte, error) {
- type noMethod Autoscaler
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AutoscalerAggregatedList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A map of scoped autoscaler lists.
- Items map[string]AutoscalersScopedList `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AutoscalerAggregatedList) MarshalJSON() ([]byte, error) {
- type noMethod AutoscalerAggregatedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AutoscalerList: Contains a list of persistent autoscaler resources.
-type AutoscalerList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A list of Autoscaler resources.
- Items []*Autoscaler `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AutoscalerList) MarshalJSON() ([]byte, error) {
- type noMethod AutoscalerList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AutoscalersScopedList struct {
- // Autoscalers: List of autoscalers contained in this scope.
- Autoscalers []*Autoscaler `json:"autoscalers,omitempty"`
-
- // Warning: Informational warning which replaces the list of autoscalers
- // when the list is empty.
- Warning *AutoscalersScopedListWarning `json:"warning,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Autoscalers") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AutoscalersScopedList) MarshalJSON() ([]byte, error) {
- type noMethod AutoscalersScopedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AutoscalersScopedListWarning: Informational warning which replaces
-// the list of autoscalers when the list is empty.
-type AutoscalersScopedListWarning struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*AutoscalersScopedListWarningData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AutoscalersScopedListWarning) MarshalJSON() ([]byte, error) {
- type noMethod AutoscalersScopedListWarning
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AutoscalersScopedListWarningData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AutoscalersScopedListWarningData) MarshalJSON() ([]byte, error) {
- type noMethod AutoscalersScopedListWarningData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AutoscalingPolicy: Cloud Autoscaler policy.
-type AutoscalingPolicy struct {
- // CoolDownPeriodSec: The number of seconds that the Autoscaler should
- // wait between two succeeding changes to the number of virtual
- // machines. You should define an interval that is at least as long as
- // the initialization time of a virtual machine and the time it may take
- // for replica pool to create the virtual machine. The default is 60
- // seconds.
- CoolDownPeriodSec int64 `json:"coolDownPeriodSec,omitempty"`
-
- // CpuUtilization: TODO(jbartosik): Add support for scaling based on
- // muliple utilization metrics (take max recommendation). Exactly one
- // utilization policy should be provided. Configuration parameters of
- // CPU based autoscaling policy.
- CpuUtilization *AutoscalingPolicyCpuUtilization `json:"cpuUtilization,omitempty"`
-
- // CustomMetricUtilizations: Configuration parameters of autoscaling
- // based on custom metric.
- CustomMetricUtilizations []*AutoscalingPolicyCustomMetricUtilization `json:"customMetricUtilizations,omitempty"`
-
- // LoadBalancingUtilization: Configuration parameters of autoscaling
- // based on load balancer.
- LoadBalancingUtilization *AutoscalingPolicyLoadBalancingUtilization `json:"loadBalancingUtilization,omitempty"`
-
- // MaxNumReplicas: The maximum number of replicas that the Autoscaler
- // can scale up to. This field is required for config to be effective.
- // Maximum number of replicas should be not lower than minimal number of
- // replicas. Absolute limit for this value is defined in Autoscaler
- // backend.
- MaxNumReplicas int64 `json:"maxNumReplicas,omitempty"`
-
- // MinNumReplicas: The minimum number of replicas that the Autoscaler
- // can scale down to. Can't be less than 0. If not provided Autoscaler
- // will choose default value depending on maximal number of replicas.
- MinNumReplicas int64 `json:"minNumReplicas,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CoolDownPeriodSec")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AutoscalingPolicy) MarshalJSON() ([]byte, error) {
- type noMethod AutoscalingPolicy
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AutoscalingPolicyCpuUtilization: CPU utilization policy.
-type AutoscalingPolicyCpuUtilization struct {
- // UtilizationTarget: The target utilization that the Autoscaler should
- // maintain. It is represented as a fraction of used cores. For example:
- // 6 cores used in 8-core VM are represented here as 0.75. Must be a
- // float value between (0, 1]. If not defined, the default is 0.8.
- UtilizationTarget float64 `json:"utilizationTarget,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "UtilizationTarget")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AutoscalingPolicyCpuUtilization) MarshalJSON() ([]byte, error) {
- type noMethod AutoscalingPolicyCpuUtilization
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AutoscalingPolicyCustomMetricUtilization: Custom utilization metric
-// policy.
-type AutoscalingPolicyCustomMetricUtilization struct {
- // Metric: Identifier of the metric. It should be a Cloud Monitoring
- // metric. The metric can not have negative values. The metric should be
- // an utilization metric (increasing number of VMs handling requests x
- // times should reduce average value of the metric roughly x times). For
- // example you could use:
- // compute.googleapis.com/instance/network/received_bytes_count.
- Metric string `json:"metric,omitempty"`
-
- // UtilizationTarget: Target value of the metric which Autoscaler should
- // maintain. Must be a positive value.
- UtilizationTarget float64 `json:"utilizationTarget,omitempty"`
-
- // UtilizationTargetType: Defines type in which utilization_target is
- // expressed.
- //
- // Possible values:
- // "DELTA_PER_MINUTE"
- // "DELTA_PER_SECOND"
- // "GAUGE"
- UtilizationTargetType string `json:"utilizationTargetType,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Metric") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AutoscalingPolicyCustomMetricUtilization) MarshalJSON() ([]byte, error) {
- type noMethod AutoscalingPolicyCustomMetricUtilization
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AutoscalingPolicyLoadBalancingUtilization: Load balancing utilization
-// policy.
-type AutoscalingPolicyLoadBalancingUtilization struct {
- // UtilizationTarget: Fraction of backend capacity utilization (set in
- // HTTP load balancing configuration) that Autoscaler should maintain.
- // Must be a positive float value. If not defined, the default is 0.8.
- // For example if your maxRatePerInstance capacity (in HTTP Load
- // Balancing configuration) is set at 10 and you would like to keep
- // number of instances such that each instance receives 7 QPS on
- // average, set this to 0.7.
- UtilizationTarget float64 `json:"utilizationTarget,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "UtilizationTarget")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AutoscalingPolicyLoadBalancingUtilization) MarshalJSON() ([]byte, error) {
- type noMethod AutoscalingPolicyLoadBalancingUtilization
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Backend: Message containing information of one individual backend.
-type Backend struct {
- // BalancingMode: Specifies the balancing mode for this backend. The
- // default is UTILIZATION but available values are UTILIZATION and RATE.
- //
- // Possible values:
- // "RATE"
- // "UTILIZATION"
- BalancingMode string `json:"balancingMode,omitempty"`
-
- // CapacityScaler: A multiplier applied to the group's maximum servicing
- // capacity (either UTILIZATION or RATE). Default value is 1, which
- // means the group will serve up to 100% of its configured CPU or RPS
- // (depending on balancingMode). A setting of 0 means the group is
- // completely drained, offering 0% of its available CPU or RPS. Valid
- // range is [0.0,1.0].
- CapacityScaler float64 `json:"capacityScaler,omitempty"`
-
- // Description: An optional textual description of the resource.
- // Provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Group: The fully-qualified URL of a zonal Instance Group resource.
- // This instance group defines the list of instances that serve traffic.
- // Member virtual machine instances from each instance group must live
- // in the same zone as the instance group itself. No two backends in a
- // backend service are allowed to use same Instance Group
- // resource.
- //
- // Note that you must specify an Instance Group resource using the
- // fully-qualified URL, rather than a partial URL.
- Group string `json:"group,omitempty"`
-
- // MaxRate: The max RPS of the group. Can be used with either balancing
- // mode, but required if RATE mode. For RATE mode, either maxRate or
- // maxRatePerInstance must be set.
- MaxRate int64 `json:"maxRate,omitempty"`
-
- // MaxRatePerInstance: The max RPS that a single backed instance can
- // handle. This is used to calculate the capacity of the group. Can be
- // used in either balancing mode. For RATE mode, either maxRate or
- // maxRatePerInstance must be set.
- MaxRatePerInstance float64 `json:"maxRatePerInstance,omitempty"`
-
- // MaxUtilization: Used when balancingMode is UTILIZATION. This ratio
- // defines the CPU utilization target for the group. The default is 0.8.
- // Valid range is [0.0, 1.0].
- MaxUtilization float64 `json:"maxUtilization,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BalancingMode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Backend) MarshalJSON() ([]byte, error) {
- type noMethod Backend
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// BackendService: A BackendService resource. This resource defines a
-// group of backend virtual machines together with their serving
-// capacity.
-type BackendService struct {
- // Backends: The list of backends that serve this BackendService.
- Backends []*Backend `json:"backends,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource.
- // Provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Fingerprint: Fingerprint of this resource. A hash of the contents
- // stored in this object. This field is used in optimistic locking. This
- // field will be ignored when inserting a BackendService. An up-to-date
- // fingerprint must be provided in order to update the BackendService.
- Fingerprint string `json:"fingerprint,omitempty"`
-
- // HealthChecks: The list of URLs to the HttpHealthCheck resource for
- // health checking this BackendService. Currently at most one health
- // check can be specified, and a health check is required.
- HealthChecks []string `json:"healthChecks,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of resource. Always compute#backendService
- // for backend services.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource. Provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // Port: Deprecated in favor of port name. The TCP port to connect on
- // the backend. The default value is 80.
- Port int64 `json:"port,omitempty"`
-
- // PortName: Name of backend port. The same name should appear in the
- // resource views referenced by this service. Required.
- PortName string `json:"portName,omitempty"`
-
- // Possible values:
- // "HTTP"
- // "HTTPS"
- Protocol string `json:"protocol,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // TimeoutSec: How many seconds to wait for the backend before
- // considering it a failed request. Default is 30 seconds.
- TimeoutSec int64 `json:"timeoutSec,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Backends") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BackendService) MarshalJSON() ([]byte, error) {
- type noMethod BackendService
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type BackendServiceGroupHealth struct {
- HealthStatus []*HealthStatus `json:"healthStatus,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always
- // compute#backendServiceGroupHealth for the health of backend services.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "HealthStatus") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BackendServiceGroupHealth) MarshalJSON() ([]byte, error) {
- type noMethod BackendServiceGroupHealth
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// BackendServiceList: Contains a list of BackendService resources.
-type BackendServiceList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A list of BackendService resources.
- Items []*BackendService `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always
- // compute#backendServiceList for lists of backend services.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BackendServiceList) MarshalJSON() ([]byte, error) {
- type noMethod BackendServiceList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CustomerEncryptionKey: Represents a customer-supplied encryption key
-type CustomerEncryptionKey struct {
- // RawKey: Specifies a 256-bit customer-supplied encryption key, encoded
- // in base64 to either encrypt or decrypt this resource.
- RawKey string `json:"rawKey,omitempty"`
-
- // RsaEncryptedKey: Specifies a base64 encoded, RSA-wrapped 2048-bit
- // customer-supplied encryption key to either encrypt or decrypt this
- // resource.
- //
- // The key must meet the following requirements before you can provide
- // it to Compute Engine:
- // - The key is wrapped using a RSA public key certificate provided by
- // Google.
- // - After being wrapped, the key must be encoded in base64 encoding.
- // Get the RSA public key certificate provided by Google
- // at:
- // https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingre
- // ss.pem
- RsaEncryptedKey string `json:"rsaEncryptedKey,omitempty"`
-
- // Sha256: [Output only] The base64 encoded SHA-256 hash of the
- // customer-supplied encryption key that protects this resource.
- Sha256 string `json:"sha256,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "RawKey") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomerEncryptionKey) MarshalJSON() ([]byte, error) {
- type noMethod CustomerEncryptionKey
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DeprecationStatus: Deprecation status for a public resource.
-type DeprecationStatus struct {
- // Deleted: An optional RFC3339 timestamp on or after which the
- // deprecation state of this resource will be changed to DELETED.
- Deleted string `json:"deleted,omitempty"`
-
- // Deprecated: An optional RFC3339 timestamp on or after which the
- // deprecation state of this resource will be changed to DEPRECATED.
- Deprecated string `json:"deprecated,omitempty"`
-
- // Obsolete: An optional RFC3339 timestamp on or after which the
- // deprecation state of this resource will be changed to OBSOLETE.
- Obsolete string `json:"obsolete,omitempty"`
-
- // Replacement: The URL of the suggested replacement for a deprecated
- // resource. The suggested replacement resource must be the same kind of
- // resource as the deprecated resource.
- Replacement string `json:"replacement,omitempty"`
-
- // State: The deprecation state of this resource. This can be
- // DEPRECATED, OBSOLETE, or DELETED. Operations which create a new
- // resource using a DEPRECATED resource will return successfully, but
- // with a warning indicating the deprecated resource and recommending
- // its replacement. Operations which use OBSOLETE or DELETED resources
- // will be rejected and result in an error.
- //
- // Possible values:
- // "DELETED"
- // "DEPRECATED"
- // "OBSOLETE"
- State string `json:"state,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Deleted") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DeprecationStatus) MarshalJSON() ([]byte, error) {
- type noMethod DeprecationStatus
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Disk: A Disk resource.
-type Disk struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // DiskEncryptionKey: Encrypts the disk using a customer-supplied
- // encryption key.
- //
- // If you encrypt the disk using a customer-supplied encryption key, and
- // you want to use the disk later (e.g. to create a disk snapshot or an
- // image, or to attach the disk to a virtual machine), you must provide
- // the same key in your request. If you provide an incorrect key, or no
- // key, the operation will fail.
- //
- // Customer-supplied encryption keys do not protect access to metadata
- // of the disk.
- //
- // If no customer-supplied encryption key is provided at creation, then
- // the disk will be encrypted using an automatically generated key and
- // you do not need to provide a key to use the disk later.
- DiskEncryptionKey *CustomerEncryptionKey `json:"diskEncryptionKey,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always compute#disk for
- // disks.
- Kind string `json:"kind,omitempty"`
-
- // LastAttachTimestamp: [Output Only] Last attach timestamp in RFC3339
- // text format.
- LastAttachTimestamp string `json:"lastAttachTimestamp,omitempty"`
-
- // LastDetachTimestamp: [Output Only] Last detach timestamp in RFC3339
- // text format.
- LastDetachTimestamp string `json:"lastDetachTimestamp,omitempty"`
-
- // Licenses: Any applicable publicly visible licenses.
- Licenses []string `json:"licenses,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // Options: Internal use only.
- Options string `json:"options,omitempty"`
-
- // SelfLink: [Output Only] Server-defined fully-qualified URL for this
- // resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // SizeGb: Size of the persistent disk, specified in GB. You can specify
- // this field when creating a persistent disk using the sourceImage or
- // sourceSnapshot parameter, or specify it alone to create an empty
- // persistent disk.
- //
- // If you specify this field along with sourceImage or sourceSnapshot,
- // the value of sizeGb must not be less than the size of the sourceImage
- // or the size of the snapshot.
- SizeGb int64 `json:"sizeGb,omitempty,string"`
-
- // SourceImage: The source image used to create this disk. If the source
- // image is deleted from the system, this field will not be set, even if
- // an image with the same name has been re-created.
- //
- // When creating a disk, you can provide a private (custom) image using
- // the following input, and Compute Engine will use the corresponding
- // image from your project. For example:
- //
- // global/images/my-private-image
- //
- // Or you can provide an image from a publicly-available project. For
- // example, to use a Debian image from the debian-cloud project, make
- // sure to include the project in the
- // URL:
- //
- // projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
- //
- // where vYYYYMMDD is the image version. The fully-qualified URL will
- // also work in both cases.
- SourceImage string `json:"sourceImage,omitempty"`
-
- // SourceImageEncryptionKey: The customer-supplied encryption key of the
- // source image. This key is required if the source image is protected
- // by a customer-supplied encryption key.
- //
- // If the incorrect key is provided, the operation will fail.
- SourceImageEncryptionKey *CustomerEncryptionKey `json:"sourceImageEncryptionKey,omitempty"`
-
- // SourceImageId: The ID value of the image used to create this disk.
- // This value identifies the exact image that was used to create this
- // persistent disk. For example, if you created the persistent disk from
- // an image that was later deleted and recreated under the same name,
- // the source image ID would identify the exact version of the image
- // that was used.
- SourceImageId string `json:"sourceImageId,omitempty"`
-
- // SourceSnapshot: The source snapshot used to create this disk. You can
- // provide this as a partial or full URL to the resource. For example,
- // the following are valid values:
- // -
- // https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
- // - projects/project/global/snapshots/snapshot
- // - global/snapshots/snapshot
- SourceSnapshot string `json:"sourceSnapshot,omitempty"`
-
- // SourceSnapshotEncryptionKey: The customer-supplied encryption key of
- // the source snapshot. This key is required if the source snapshot is
- // protected by a customer-supplied encryption key.
- //
- // If the incorrect key is provided, the operation will fail.
- SourceSnapshotEncryptionKey *CustomerEncryptionKey `json:"sourceSnapshotEncryptionKey,omitempty"`
-
- // SourceSnapshotId: [Output Only] The unique ID of the snapshot used to
- // create this disk. This value identifies the exact snapshot that was
- // used to create this persistent disk. For example, if you created the
- // persistent disk from a snapshot that was later deleted and recreated
- // under the same name, the source snapshot ID would identify the exact
- // version of the snapshot that was used.
- SourceSnapshotId string `json:"sourceSnapshotId,omitempty"`
-
- // Status: [Output Only] The status of disk creation. Applicable
- // statuses includes: CREATING, FAILED, READY, RESTORING.
- //
- // Possible values:
- // "CREATING"
- // "FAILED"
- // "READY"
- // "RESTORING"
- Status string `json:"status,omitempty"`
-
- // StorageType: [Deprecated] Storage type of the persistent disk.
- //
- // Possible values:
- // "HDD"
- // "SSD"
- StorageType string `json:"storageType,omitempty"`
-
- // Type: URL of the disk type resource describing which disk type to use
- // to create the disk; provided by the client when the disk is created.
- Type string `json:"type,omitempty"`
-
- // Users: Links to the users of the disk (attached instances) in form:
- // project/zones/zone/instances/instance
- Users []string `json:"users,omitempty"`
-
- // Zone: [Output Only] URL of the zone where the disk resides.
- Zone string `json:"zone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Disk) MarshalJSON() ([]byte, error) {
- type noMethod Disk
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DiskAggregatedList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A map of scoped disk lists.
- Items map[string]DisksScopedList `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always
- // compute#diskAggregatedList for aggregated lists of persistent disks.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DiskAggregatedList) MarshalJSON() ([]byte, error) {
- type noMethod DiskAggregatedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DiskList: A list of Disk resources.
-type DiskList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of persistent disks.
- Items []*Disk `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#diskList for
- // lists of disks.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DiskList) MarshalJSON() ([]byte, error) {
- type noMethod DiskList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DiskType: A disk type resource.
-type DiskType struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // DefaultDiskSizeGb: [Output Only] Server-defined default disk size in
- // GB.
- DefaultDiskSizeGb int64 `json:"defaultDiskSizeGb,omitempty,string"`
-
- // Deprecated: [Output Only] The deprecation status associated with this
- // disk type.
- Deprecated *DeprecationStatus `json:"deprecated,omitempty"`
-
- // Description: [Output Only] An optional textual description of the
- // resource.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always compute#diskType for
- // disk types.
- Kind string `json:"kind,omitempty"`
-
- // Name: [Output Only] Name of the resource.
- Name string `json:"name,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ValidDiskSize: [Output Only] An optional textual description of the
- // valid disk size, such as "10GB-10TB".
- ValidDiskSize string `json:"validDiskSize,omitempty"`
-
- // Zone: [Output Only] URL of the zone where the disk type resides.
- Zone string `json:"zone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DiskType) MarshalJSON() ([]byte, error) {
- type noMethod DiskType
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DiskTypeAggregatedList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A map of scoped disk type lists.
- Items map[string]DiskTypesScopedList `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always
- // compute#diskTypeAggregatedList.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DiskTypeAggregatedList) MarshalJSON() ([]byte, error) {
- type noMethod DiskTypeAggregatedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DiskTypeList: Contains a list of disk type resources.
-type DiskTypeList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of Disk Type resources.
- Items []*DiskType `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#diskTypeList for
- // disk types.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DiskTypeList) MarshalJSON() ([]byte, error) {
- type noMethod DiskTypeList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DiskTypesScopedList struct {
- // DiskTypes: [Output Only] List of disk types contained in this scope.
- DiskTypes []*DiskType `json:"diskTypes,omitempty"`
-
- // Warning: [Output Only] Informational warning which replaces the list
- // of disk types when the list is empty.
- Warning *DiskTypesScopedListWarning `json:"warning,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DiskTypes") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DiskTypesScopedList) MarshalJSON() ([]byte, error) {
- type noMethod DiskTypesScopedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DiskTypesScopedListWarning: [Output Only] Informational warning which
-// replaces the list of disk types when the list is empty.
-type DiskTypesScopedListWarning struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*DiskTypesScopedListWarningData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DiskTypesScopedListWarning) MarshalJSON() ([]byte, error) {
- type noMethod DiskTypesScopedListWarning
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DiskTypesScopedListWarningData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DiskTypesScopedListWarningData) MarshalJSON() ([]byte, error) {
- type noMethod DiskTypesScopedListWarningData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DisksScopedList struct {
- // Disks: [Output Only] List of disks contained in this scope.
- Disks []*Disk `json:"disks,omitempty"`
-
- // Warning: [Output Only] Informational warning which replaces the list
- // of disks when the list is empty.
- Warning *DisksScopedListWarning `json:"warning,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Disks") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DisksScopedList) MarshalJSON() ([]byte, error) {
- type noMethod DisksScopedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DisksScopedListWarning: [Output Only] Informational warning which
-// replaces the list of disks when the list is empty.
-type DisksScopedListWarning struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*DisksScopedListWarningData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DisksScopedListWarning) MarshalJSON() ([]byte, error) {
- type noMethod DisksScopedListWarning
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DisksScopedListWarningData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DisksScopedListWarningData) MarshalJSON() ([]byte, error) {
- type noMethod DisksScopedListWarningData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Firewall: A Firewall resource.
-type Firewall struct {
- // Allowed: The list of rules specified by this firewall. Each rule
- // specifies a protocol and port-range tuple that describes a permitted
- // connection.
- Allowed []*FirewallAllowed `json:"allowed,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Ony] Type of the resource. Always compute#firewall for
- // firewall rules.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // Network: URL of the network resource for this firewall rule. This
- // field is required for creating an instance but optional when creating
- // a firewall rule. If not specified when creating a firewall rule, the
- // default network is used:
- // global/networks/default
- // If you choose to specify this property, you can specify the network
- // as a full or partial URL. For example, the following are all valid
- // URLs:
- // -
- // https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
- // - projects/myproject/global/networks/my-network
- // - global/networks/default
- Network string `json:"network,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // SourceRanges: The IP address blocks that this rule applies to,
- // expressed in CIDR format. One or both of sourceRanges and sourceTags
- // may be set.
- //
- // If both properties are set, an inbound connection is allowed if the
- // range matches the sourceRanges OR the tag of the source matches the
- // sourceTags property. The connection does not need to match both
- // properties.
- SourceRanges []string `json:"sourceRanges,omitempty"`
-
- // SourceTags: A list of instance tags which this rule applies to. One
- // or both of sourceRanges and sourceTags may be set.
- //
- // If both properties are set, an inbound connection is allowed if the
- // range matches the sourceRanges OR the tag of the source matches the
- // sourceTags property. The connection does not need to match both
- // properties.
- SourceTags []string `json:"sourceTags,omitempty"`
-
- // TargetTags: A list of instance tags indicating sets of instances
- // located in the network that may make network connections as specified
- // in allowed[]. If no targetTags are specified, the firewall rule
- // applies to all instances on the specified network.
- TargetTags []string `json:"targetTags,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Allowed") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Firewall) MarshalJSON() ([]byte, error) {
- type noMethod Firewall
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type FirewallAllowed struct {
- // IPProtocol: The IP protocol that is allowed for this rule. The
- // protocol type is required when creating a firewall. This value can
- // either be one of the following well known protocol strings (tcp, udp,
- // icmp, esp, ah, sctp), or the IP protocol number.
- IPProtocol string `json:"IPProtocol,omitempty"`
-
- // Ports: An optional list of ports which are allowed. This field is
- // only applicable for UDP or TCP protocol. Each entry must be either an
- // integer or a range. If not specified, connections through any port
- // are allowed
- //
- // Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
- Ports []string `json:"ports,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "IPProtocol") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FirewallAllowed) MarshalJSON() ([]byte, error) {
- type noMethod FirewallAllowed
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FirewallList: Contains a list of Firewall resources.
-type FirewallList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of Firewall resources.
- Items []*Firewall `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#firewallList for
- // lists of firewalls.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FirewallList) MarshalJSON() ([]byte, error) {
- type noMethod FirewallList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ForwardingRule: A ForwardingRule resource. A ForwardingRule resource
-// specifies which pool of target virtual machines to forward a packet
-// to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
-type ForwardingRule struct {
- // IPAddress: Value of the reserved IP address that this forwarding rule
- // is serving on behalf of. For global forwarding rules, the address
- // must be a global IP; for regional forwarding rules, the address must
- // live in the same region as the forwarding rule. If left empty
- // (default value), an ephemeral IP from the same scope (global or
- // regional) will be assigned.
- IPAddress string `json:"IPAddress,omitempty"`
-
- // IPProtocol: The IP protocol to which this rule applies. Valid options
- // are TCP, UDP, ESP, AH or SCTP.
- //
- // Possible values:
- // "AH"
- // "ESP"
- // "SCTP"
- // "TCP"
- // "UDP"
- IPProtocol string `json:"IPProtocol,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always
- // compute#forwardingRule.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // PortRange: Applicable only when IPProtocol is TCP, UDP, or SCTP, only
- // packets addressed to ports in the specified range will be forwarded
- // to target. Forwarding rules with the same `[IPAddress, IPProtocol]`
- // pair must have disjoint port ranges.
- PortRange string `json:"portRange,omitempty"`
-
- // Region: [Output Only] URL of the region where the regional forwarding
- // rule resides. This field is not applicable to global forwarding
- // rules.
- Region string `json:"region,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Target: The URL of the target resource to receive the matched
- // traffic. For regional forwarding rules, this target must live in the
- // same region as the forwarding rule. For global forwarding rules, this
- // target must be a global TargetHttpProxy or TargetHttpsProxy resource.
- Target string `json:"target,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "IPAddress") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ForwardingRule) MarshalJSON() ([]byte, error) {
- type noMethod ForwardingRule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ForwardingRuleAggregatedList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A map of scoped forwarding rule lists.
- Items map[string]ForwardingRulesScopedList `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ForwardingRuleAggregatedList) MarshalJSON() ([]byte, error) {
- type noMethod ForwardingRuleAggregatedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ForwardingRuleList: Contains a list of ForwardingRule resources.
-type ForwardingRuleList struct {
- // Id: [Output Only] Unique identifier for the resource. Set by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A list of ForwardingRule resources.
- Items []*ForwardingRule `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ForwardingRuleList) MarshalJSON() ([]byte, error) {
- type noMethod ForwardingRuleList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ForwardingRulesScopedList struct {
- // ForwardingRules: List of forwarding rules contained in this scope.
- ForwardingRules []*ForwardingRule `json:"forwardingRules,omitempty"`
-
- // Warning: Informational warning which replaces the list of forwarding
- // rules when the list is empty.
- Warning *ForwardingRulesScopedListWarning `json:"warning,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ForwardingRules") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ForwardingRulesScopedList) MarshalJSON() ([]byte, error) {
- type noMethod ForwardingRulesScopedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ForwardingRulesScopedListWarning: Informational warning which
-// replaces the list of forwarding rules when the list is empty.
-type ForwardingRulesScopedListWarning struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*ForwardingRulesScopedListWarningData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ForwardingRulesScopedListWarning) MarshalJSON() ([]byte, error) {
- type noMethod ForwardingRulesScopedListWarning
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ForwardingRulesScopedListWarningData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ForwardingRulesScopedListWarningData) MarshalJSON() ([]byte, error) {
- type noMethod ForwardingRulesScopedListWarningData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type HealthCheckReference struct {
- HealthCheck string `json:"healthCheck,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "HealthCheck") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *HealthCheckReference) MarshalJSON() ([]byte, error) {
- type noMethod HealthCheckReference
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type HealthStatus struct {
- // HealthState: Health state of the instance.
- //
- // Possible values:
- // "HEALTHY"
- // "UNHEALTHY"
- HealthState string `json:"healthState,omitempty"`
-
- // Instance: URL of the instance resource.
- Instance string `json:"instance,omitempty"`
-
- // IpAddress: The IP address represented by this resource.
- IpAddress string `json:"ipAddress,omitempty"`
-
- // Port: The port on the instance.
- Port int64 `json:"port,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "HealthState") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *HealthStatus) MarshalJSON() ([]byte, error) {
- type noMethod HealthStatus
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// HostRule: UrlMaps A host-matching rule for a URL. If matched, will
-// use the named PathMatcher to select the BackendService.
-type HostRule struct {
- // Description: An optional textual description.
- Description string `json:"description,omitempty"`
-
- // Hosts: The list of host patterns to match. They must be valid
- // hostnames, except * will match any string of ([a-z0-9-.]*). In that
- // case, * must be the first character and must be followed in the
- // pattern by either - or ..
- Hosts []string `json:"hosts,omitempty"`
-
- // PathMatcher: The name of the PathMatcher to use to match the path
- // portion of the URL if the hostRule matches the URL's host portion.
- PathMatcher string `json:"pathMatcher,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Description") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *HostRule) MarshalJSON() ([]byte, error) {
- type noMethod HostRule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// HttpHealthCheck: An HttpHealthCheck resource. This resource defines a
-// template for how individual instances should be checked for health,
-// via HTTP.
-type HttpHealthCheck struct {
- // CheckIntervalSec: How often (in seconds) to send a health check. The
- // default value is 5 seconds.
- CheckIntervalSec int64 `json:"checkIntervalSec,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // HealthyThreshold: A so-far unhealthy instance will be marked healthy
- // after this many consecutive successes. The default value is 2.
- HealthyThreshold int64 `json:"healthyThreshold,omitempty"`
-
- // Host: The value of the host header in the HTTP health check request.
- // If left empty (default value), the public IP on behalf of which this
- // health check is performed will be used.
- Host string `json:"host,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: Type of the resource.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource. Provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // Port: The TCP port number for the HTTP health check request. The
- // default value is 80.
- Port int64 `json:"port,omitempty"`
-
- // RequestPath: The request path of the HTTP health check request. The
- // default value is "/".
- RequestPath string `json:"requestPath,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // TimeoutSec: How long (in seconds) to wait before claiming failure.
- // The default value is 5 seconds. It is invalid for timeoutSec to have
- // greater value than checkIntervalSec.
- TimeoutSec int64 `json:"timeoutSec,omitempty"`
-
- // UnhealthyThreshold: A so-far healthy instance will be marked
- // unhealthy after this many consecutive failures. The default value is
- // 2.
- UnhealthyThreshold int64 `json:"unhealthyThreshold,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CheckIntervalSec") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *HttpHealthCheck) MarshalJSON() ([]byte, error) {
- type noMethod HttpHealthCheck
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// HttpHealthCheckList: Contains a list of HttpHealthCheck resources.
-type HttpHealthCheckList struct {
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A list of HttpHealthCheck resources.
- Items []*HttpHealthCheck `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *HttpHealthCheckList) MarshalJSON() ([]byte, error) {
- type noMethod HttpHealthCheckList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// HttpsHealthCheck: An HttpsHealthCheck resource. This resource defines
-// a template for how individual instances should be checked for health,
-// via HTTPS.
-type HttpsHealthCheck struct {
- // CheckIntervalSec: How often (in seconds) to send a health check. The
- // default value is 5 seconds.
- CheckIntervalSec int64 `json:"checkIntervalSec,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // HealthyThreshold: A so-far unhealthy instance will be marked healthy
- // after this many consecutive successes. The default value is 2.
- HealthyThreshold int64 `json:"healthyThreshold,omitempty"`
-
- // Host: The value of the host header in the HTTPS health check request.
- // If left empty (default value), the public IP on behalf of which this
- // health check is performed will be used.
- Host string `json:"host,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: Type of the resource.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource. Provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // Port: The TCP port number for the HTTPS health check request. The
- // default value is 443.
- Port int64 `json:"port,omitempty"`
-
- // RequestPath: The request path of the HTTPS health check request. The
- // default value is "/".
- RequestPath string `json:"requestPath,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // TimeoutSec: How long (in seconds) to wait before claiming failure.
- // The default value is 5 seconds. It is invalid for timeoutSec to have
- // a greater value than checkIntervalSec.
- TimeoutSec int64 `json:"timeoutSec,omitempty"`
-
- // UnhealthyThreshold: A so-far healthy instance will be marked
- // unhealthy after this many consecutive failures. The default value is
- // 2.
- UnhealthyThreshold int64 `json:"unhealthyThreshold,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CheckIntervalSec") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *HttpsHealthCheck) MarshalJSON() ([]byte, error) {
- type noMethod HttpsHealthCheck
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// HttpsHealthCheckList: Contains a list of HttpsHealthCheck resources.
-type HttpsHealthCheckList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A list of HttpsHealthCheck resources.
- Items []*HttpsHealthCheck `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *HttpsHealthCheckList) MarshalJSON() ([]byte, error) {
- type noMethod HttpsHealthCheckList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Image: An Image resource.
-type Image struct {
- // ArchiveSizeBytes: Size of the image tar.gz archive stored in Google
- // Cloud Storage (in bytes).
- ArchiveSizeBytes int64 `json:"archiveSizeBytes,omitempty,string"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Deprecated: The deprecation status associated with this image.
- Deprecated *DeprecationStatus `json:"deprecated,omitempty"`
-
- // Description: Textual description of the resource; provided by the
- // client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // DiskSizeGb: Size of the image when restored onto a persistent disk
- // (in GB).
- DiskSizeGb int64 `json:"diskSizeGb,omitempty,string"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // ImageEncryptionKey: Encrypts the image using a customer-supplied
- // encryption key.
- //
- // If you encrypt an image using a customer-supplied encryption key, and
- // you want to use the image later (e.g. to create a disk from the
- // image), you must provide the same key used encrypt the image in your
- // future request. If you provide an incorrect key, or no key, the
- // operation will fail.
- //
- // Customer-supplied encryption keys do not protect access to metadata
- // of the disk.
- //
- // If no customer-supplied encryption key is provided at creation, then
- // the disk will be encrypted using an automatically generated key and
- // you do not need to provide a key to use the image later.
- ImageEncryptionKey *CustomerEncryptionKey `json:"imageEncryptionKey,omitempty"`
-
- // Kind: [Output Only] Type of the resource. Always compute#image for
- // images.
- Kind string `json:"kind,omitempty"`
-
- // Licenses: Any applicable publicly visible licenses.
- Licenses []string `json:"licenses,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // RawDisk: The parameters of the raw disk image.
- RawDisk *ImageRawDisk `json:"rawDisk,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // SourceDisk: URL of the The source disk used to create this image.
- // This can be a full or valid partial URL. You must provide either this
- // property or the rawDisk.source property but not both to create an
- // image. For example, the following are valid values:
- // -
- // https://www.googleapis.com/compute/v1/projects/project/zones/zone/disk/disk
- // - projects/project/zones/zone/disk/disk
- // - zones/zone/disks/disk
- SourceDisk string `json:"sourceDisk,omitempty"`
-
- // SourceDiskEncryptionKey: Specifies the customer-supplied encryption
- // key of the source disk. This key is required if the source disk is
- // protected by a customer-supplied encryption key.
- //
- // If the incorrect key is provided the operation will fail.
- SourceDiskEncryptionKey *CustomerEncryptionKey `json:"sourceDiskEncryptionKey,omitempty"`
-
- // SourceDiskId: The ID value of the disk used to create this image.
- // This value may be used to determine whether the image was taken from
- // the current or a previous instance of a given disk name.
- SourceDiskId string `json:"sourceDiskId,omitempty"`
-
- // SourceType: The type of the image used to create this disk. The
- // default and only value is RAW
- //
- // Possible values:
- // "RAW" (default)
- SourceType string `json:"sourceType,omitempty"`
-
- // Status: [Output Only] The status of the image. An image can be used
- // to create other resources, such as instances, only after the image
- // has been successfully created and the status is set to READY.
- // Possible values are FAILED, PENDING, or READY.
- //
- // Possible values:
- // "FAILED"
- // "PENDING"
- // "READY"
- Status string `json:"status,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ArchiveSizeBytes") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Image) MarshalJSON() ([]byte, error) {
- type noMethod Image
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ImageRawDisk: The parameters of the raw disk image.
-type ImageRawDisk struct {
- // ContainerType: The format used to encode and transmit the block
- // device, which should be TAR. This is just a container and
- // transmission format and not a runtime format. Provided by the client
- // when the disk image is created.
- //
- // Possible values:
- // "TAR"
- ContainerType string `json:"containerType,omitempty"`
-
- // Sha1Checksum: An optional SHA1 checksum of the disk image before
- // unpackaging; provided by the client when the disk image is created.
- Sha1Checksum string `json:"sha1Checksum,omitempty"`
-
- // Source: The full Google Cloud Storage URL where the disk image is
- // stored. You must provide either this property or the sourceDisk
- // property but not both.
- Source string `json:"source,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ContainerType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ImageRawDisk) MarshalJSON() ([]byte, error) {
- type noMethod ImageRawDisk
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ImageList: Contains a list of Image resources.
-type ImageList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of Image resources.
- Items []*Image `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ImageList) MarshalJSON() ([]byte, error) {
- type noMethod ImageList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Instance: An Instance resource.
-type Instance struct {
- // CanIpForward: Allows this instance to send and receive packets with
- // non-matching destination or source IPs. This is required if you plan
- // to use this instance to forward routes. For more information, see
- // Enabling IP Forwarding.
- CanIpForward bool `json:"canIpForward,omitempty"`
-
- // CpuPlatform: [Output Only] The CPU platform used by this instance.
- CpuPlatform string `json:"cpuPlatform,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Disks: Array of disks associated with this instance. Persistent disks
- // must be created before you can assign them.
- Disks []*AttachedDisk `json:"disks,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always compute#instance for
- // instances.
- Kind string `json:"kind,omitempty"`
-
- // LabelFingerprint: A fingerprint for this request, which is
- // essentially a hash of the metadata's contents and used for optimistic
- // locking. The fingerprint is initially generated by Compute Engine and
- // changes after every request to modify or update metadata. You must
- // always provide an up-to-date fingerprint hash in order to update or
- // change metadata.
- //
- // To see the latest fingerprint, make get() request to the instance.
- LabelFingerprint string `json:"labelFingerprint,omitempty"`
-
- // Labels: Labels to apply to this instance. These can be later modified
- // by the setLabels method. Each label key & value must comply with
- // RFC1035. Label values may be empty.
- Labels map[string]string `json:"labels,omitempty"`
-
- // MachineType: Full or partial URL of the machine type resource to use
- // for this instance. This is provided by the client when the instance
- // is created. For example, the following is a valid partial
- // url:
- //
- // zones/zone/machineTypes/machine-type
- MachineType string `json:"machineType,omitempty"`
-
- // Metadata: The metadata key/value pairs assigned to this instance.
- // This includes custom metadata and predefined keys.
- Metadata *Metadata `json:"metadata,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // NetworkInterfaces: An array of configurations for this interface.
- // This specifies how this interface is configured to interact with
- // other network services, such as connecting to the internet.
- NetworkInterfaces []*NetworkInterface `json:"networkInterfaces,omitempty"`
-
- // Scheduling: Scheduling options for this instance.
- Scheduling *Scheduling `json:"scheduling,omitempty"`
-
- // SelfLink: [Output Only] Server defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServiceAccounts: A list of service accounts, with their specified
- // scopes, authorized for this instance. Service accounts generate
- // access tokens that can be accessed through the metadata server and
- // used to authenticate applications on the instance. See Authenticating
- // from Google Compute Engine for more information.
- ServiceAccounts []*ServiceAccount `json:"serviceAccounts,omitempty"`
-
- // Status: [Output Only] The status of the instance. One of the
- // following values: PROVISIONING, STAGING, RUNNING, STOPPING, and
- // TERMINATED.
- //
- // Possible values:
- // "PROVISIONING"
- // "RUNNING"
- // "STAGING"
- // "STOPPED"
- // "STOPPING"
- // "SUSPENDED"
- // "SUSPENDING"
- // "TERMINATED"
- Status string `json:"status,omitempty"`
-
- // StatusMessage: [Output Only] An optional, human-readable explanation
- // of the status.
- StatusMessage string `json:"statusMessage,omitempty"`
-
- // Tags: A list of tags to appy to this instance. Tags are used to
- // identify valid sources or targets for network firewalls and are
- // specified by the client during instance creation. The tags can be
- // later modified by the setTags method. Each tag within the list must
- // comply with RFC1035.
- Tags *Tags `json:"tags,omitempty"`
-
- // Zone: [Output Only] URL of the zone where the instance resides.
- Zone string `json:"zone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CanIpForward") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Instance) MarshalJSON() ([]byte, error) {
- type noMethod Instance
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceAggregatedList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A map of scoped instance lists.
- Items map[string]InstancesScopedList `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always
- // compute#instanceAggregatedList for aggregated lists of Instance
- // resources.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceAggregatedList) MarshalJSON() ([]byte, error) {
- type noMethod InstanceAggregatedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroup struct {
- // CreationTimestamp: [Output Only] The creation timestamp for this
- // instance group in RFC3339 text format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional text description for the instance group.
- Description string `json:"description,omitempty"`
-
- // Fingerprint: [Output Only] The fingerprint of the named ports. The
- // system uses this fingerprint to detect conflicts when multiple users
- // change the named ports concurrently.
- Fingerprint string `json:"fingerprint,omitempty"`
-
- // Id: [Output Only] A unique identifier for this resource type. The
- // server generates this identifier.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] The resource type, which is always
- // compute#instanceGroup for instance groups.
- Kind string `json:"kind,omitempty"`
-
- // Name: The name of the instance group. The name must be 1-63
- // characters long, and comply with RFC1035.
- Name string `json:"name,omitempty"`
-
- // NamedPorts: Assigns a name to a port number. For example: {name:
- // "http", port: 80}
- //
- // This allows the system to reference ports by the assigned name
- // instead of a port number. Named ports can also contain multiple
- // ports. For example: [{name: "http", port: 80},{name: "http", port:
- // 8080}]
- //
- // Named ports apply to all instances in this instance group.
- NamedPorts []*NamedPort `json:"namedPorts,omitempty"`
-
- // Network: [Output Only] The URL of the network to which all instances
- // in the instance group belong.
- Network string `json:"network,omitempty"`
-
- // SelfLink: [Output Only] The URL for this instance group. The server
- // generates this URL.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Size: [Output Only] The total number of instances in the instance
- // group.
- Size int64 `json:"size,omitempty"`
-
- // Zone: [Output Only] The URL of the zone where the instance group is
- // located.
- Zone string `json:"zone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroup) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroup
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupAggregatedList struct {
- // Id: [Output Only] A unique identifier for this aggregated list of
- // instance groups. The server generates this identifier.
- Id string `json:"id,omitempty"`
-
- // Items: A map of scoped instance group lists.
- Items map[string]InstanceGroupsScopedList `json:"items,omitempty"`
-
- // Kind: [Output Only] The resource type, which is always
- // compute#instanceGroupAggregatedList for aggregated lists of instance
- // groups.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token that is used to continue a
- // truncated list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] The URL for this resource type. The server
- // generates this URL.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupAggregatedList) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupAggregatedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// InstanceGroupList: A list of InstanceGroup resources.
-type InstanceGroupList struct {
- // Id: [Output Only] A unique identifier for this list of instance
- // groups. The server generates this identifier.
- Id string `json:"id,omitempty"`
-
- // Items: A list of instance groups.
- Items []*InstanceGroup `json:"items,omitempty"`
-
- // Kind: [Output Only] The resource type, which is always
- // compute#instanceGroupList for instance group lists.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token that is used to continue a
- // truncated list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] The URL for this resource type. The server
- // generates this URL.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupList) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// InstanceGroupManager: InstanceGroupManagers
-//
-// Next available tag: 19
-type InstanceGroupManager struct {
- // AutoHealingPolicies: The autohealing policy for this managed instance
- // group. You can specify only one value.
- AutoHealingPolicies []*InstanceGroupManagerAutoHealingPolicy `json:"autoHealingPolicies,omitempty"`
-
- // BaseInstanceName: The base instance name to use for instances in this
- // group. The value must be 1-58 characters long. Instances are named by
- // appending a hyphen and a random four-character string to the base
- // instance name. The base instance name must comply with RFC1035.
- BaseInstanceName string `json:"baseInstanceName,omitempty"`
-
- // CreationTimestamp: [Output Only] The creation timestamp for this
- // managed instance group in RFC3339 text format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // CurrentActions: [Output Only] The list of instance actions and the
- // number of instances in this managed instance group that are scheduled
- // for each of those actions.
- CurrentActions *InstanceGroupManagerActionsSummary `json:"currentActions,omitempty"`
-
- // Description: An optional text description for the managed instance
- // group.
- Description string `json:"description,omitempty"`
-
- // Fingerprint: [Output Only] The fingerprint of the target pools
- // information. You can use this optional field for optimistic locking
- // when you update the target pool entries.
- Fingerprint string `json:"fingerprint,omitempty"`
-
- // Id: [Output Only] A unique identifier for this resource type. The
- // server generates this identifier.
- Id uint64 `json:"id,omitempty,string"`
-
- // InstanceGroup: [Output Only] The URL of the Instance Group resource.
- InstanceGroup string `json:"instanceGroup,omitempty"`
-
- // InstanceTemplate: The URL of the instance template that is specified
- // for this managed instance group. The group uses this template to
- // create all new instances in the managed instance group.
- InstanceTemplate string `json:"instanceTemplate,omitempty"`
-
- // Kind: [Output Only] The resource type, which is always
- // compute#instanceGroupManager for managed instance groups.
- Kind string `json:"kind,omitempty"`
-
- // Name: The name of the managed instance group. The name must be 1-63
- // characters long, and comply with RFC1035.
- Name string `json:"name,omitempty"`
-
- // SelfLink: [Output Only] The URL for this managed instance group. The
- // server defines this URL.
- SelfLink string `json:"selfLink,omitempty"`
-
- // TargetPools: The URLs for all TargetPool resources to which instances
- // in the instanceGroup field are added. The target pools automatically
- // apply to all of the instances in the managed instance group.
- TargetPools []string `json:"targetPools,omitempty"`
-
- // TargetSize: The target number of running instances for this managed
- // instance group. Deleting or abandoning instances reduces this number.
- // Resizing the group changes this number.
- TargetSize int64 `json:"targetSize,omitempty"`
-
- // Zone: The name of the zone where the managed instance group is
- // located.
- Zone string `json:"zone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AutoHealingPolicies")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupManager) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupManager
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupManagerActionsSummary struct {
- // Abandoning: [Output Only] The total number of instances in the
- // managed instance group that are scheduled to be abandoned. Abandoning
- // an instance removes it from the managed instance group without
- // deleting it.
- Abandoning int64 `json:"abandoning,omitempty"`
-
- // Creating: [Output Only] The number of instances in the managed
- // instance group that are scheduled to be created or are currently
- // being created.
- Creating int64 `json:"creating,omitempty"`
-
- // Deleting: [Output Only] The number of instances in the managed
- // instance group that are scheduled to be deleted or are currently
- // being deleted.
- Deleting int64 `json:"deleting,omitempty"`
-
- // None: [Output Only] The number of instances in the managed instance
- // group that are running and have no scheduled actions.
- None int64 `json:"none,omitempty"`
-
- // Recreating: [Output Only] The number of instances in the managed
- // instance group that are scheduled to be recreated or are currently
- // being being recreated. Recreating an instance deletes the existing
- // root persistent disk and creates a new disk from the image that is
- // defined in the instance template.
- Recreating int64 `json:"recreating,omitempty"`
-
- // Refreshing: [Output Only] The number of instances in the managed
- // instance group that are being reconfigured with properties that do
- // not require a restart or a recreate action. For example, setting or
- // removing target pools for the instance.
- Refreshing int64 `json:"refreshing,omitempty"`
-
- // Restarting: [Output Only] The number of instances in the managed
- // instance group that are scheduled to be restarted or are currently
- // being restarted.
- Restarting int64 `json:"restarting,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Abandoning") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupManagerActionsSummary) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupManagerActionsSummary
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupManagerAggregatedList struct {
- // Id: [Output Only] A unique identifier for this aggregated list of
- // managed instance groups. The server generates this identifier.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A map of filtered managed instance group lists.
- Items map[string]InstanceGroupManagersScopedList `json:"items,omitempty"`
-
- // Kind: [Output Only] The resource type, which is always
- // compute#instanceGroupManagerAggregatedList for an aggregated list of
- // managed instance groups.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token that is used to continue a
- // truncated list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] The URL for this resource type. The server
- // generates this URL.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupManagerAggregatedList) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupManagerAggregatedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupManagerAutoHealingPolicy struct {
- // ActionType: The action to perform when an instance in this group
- // becomes unhealthy. Possible values are RECREATE or RESTART. RECREATE
- // replaces an unhealthy instance using the same name and instance
- // template as the unhealthy instance. RESTART performs a soft restart
- // on an instance. If the instance cannot reboot, the instance performs
- // a hard restart.
- //
- // Possible values:
- // "RECREATE"
- // "RESTART"
- ActionType string `json:"actionType,omitempty"`
-
- // HealthCheck: The URL for the HealthCheck that signals autohealing.
- HealthCheck string `json:"healthCheck,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ActionType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupManagerAutoHealingPolicy) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupManagerAutoHealingPolicy
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// InstanceGroupManagerList: [Output Only] A list of managed instance
-// groups.
-type InstanceGroupManagerList struct {
- // Id: [Output Only] A unique identifier for this resource type. The
- // server generates this identifier.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of managed instance groups.
- Items []*InstanceGroupManager `json:"items,omitempty"`
-
- // Kind: [Output Only] The resource type, which is always
- // compute#instanceGroupManagerList for a list of managed instance
- // groups.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token that is used to continue a
- // truncated list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] The URL for this resource type. The server
- // generates this URL.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupManagerList) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupManagerList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupManagersAbandonInstancesRequest struct {
- // Instances: The URL for one or more instances to abandon from the
- // managed instance group.
- Instances []string `json:"instances,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Instances") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupManagersAbandonInstancesRequest) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupManagersAbandonInstancesRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupManagersDeleteInstancesRequest struct {
- // Instances: The list of instances to delete from this managed instance
- // group. Specify one or more instance URLs.
- Instances []string `json:"instances,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Instances") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupManagersDeleteInstancesRequest) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupManagersDeleteInstancesRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupManagersListManagedInstancesResponse struct {
- // ManagedInstances: [Output Only] The list of instances in the managed
- // instance group.
- ManagedInstances []*ManagedInstance `json:"managedInstances,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ManagedInstances") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupManagersListManagedInstancesResponse) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupManagersListManagedInstancesResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupManagersRecreateInstancesRequest struct {
- // Instances: The URL for one or more instances to recreate.
- Instances []string `json:"instances,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Instances") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupManagersRecreateInstancesRequest) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupManagersRecreateInstancesRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupManagersScopedList struct {
- // InstanceGroupManagers: [Output Only] The list of managed instance
- // groups that are contained in the specified project and zone.
- InstanceGroupManagers []*InstanceGroupManager `json:"instanceGroupManagers,omitempty"`
-
- // Warning: [Output Only] The warning that replaces the list of managed
- // instance groups when the list is empty.
- Warning *InstanceGroupManagersScopedListWarning `json:"warning,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "InstanceGroupManagers") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupManagersScopedList) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupManagersScopedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// InstanceGroupManagersScopedListWarning: [Output Only] The warning
-// that replaces the list of managed instance groups when the list is
-// empty.
-type InstanceGroupManagersScopedListWarning struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*InstanceGroupManagersScopedListWarningData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupManagersScopedListWarning) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupManagersScopedListWarning
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupManagersScopedListWarningData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupManagersScopedListWarningData) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupManagersScopedListWarningData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupManagersSetAutoHealingRequest struct {
- AutoHealingPolicies []*InstanceGroupManagerAutoHealingPolicy `json:"autoHealingPolicies,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AutoHealingPolicies")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupManagersSetAutoHealingRequest) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupManagersSetAutoHealingRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupManagersSetInstanceTemplateRequest struct {
- // InstanceTemplate: The URL of the instance template that is specified
- // for this managed instance group. The group uses this template to
- // create all new instances in the managed instance group.
- InstanceTemplate string `json:"instanceTemplate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "InstanceTemplate") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupManagersSetInstanceTemplateRequest) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupManagersSetInstanceTemplateRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupManagersSetTargetPoolsRequest struct {
- // Fingerprint: The fingerprint of the target pools information. Use
- // this optional property to prevent conflicts when multiple users
- // change the target pools settings concurrently. Obtain the fingerprint
- // with the instanceGroupManagers.get method. Then, include the
- // fingerprint in your request to ensure that you do not overwrite
- // changes that were applied from another concurrent request.
- Fingerprint string `json:"fingerprint,omitempty"`
-
- // TargetPools: The list of target pool URLs that instances in this
- // managed instance group belong to. The managed instance group applies
- // these target pools to all of the instances in the group. Existing
- // instances and new instances in the group all receive these target
- // pool settings.
- TargetPools []string `json:"targetPools,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Fingerprint") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupManagersSetTargetPoolsRequest) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupManagersSetTargetPoolsRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupsAddInstancesRequest struct {
- // Instances: The list of instances to add to the instance group.
- Instances []*InstanceReference `json:"instances,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Instances") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupsAddInstancesRequest) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupsAddInstancesRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupsListInstances struct {
- // Id: [Output Only] A unique identifier for this list of instance
- // groups. The server generates this identifier.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of instances and any named ports that are
- // assigned to those instances.
- Items []*InstanceWithNamedPorts `json:"items,omitempty"`
-
- // Kind: [Output Only] The resource type, which is always
- // compute#instanceGroupsListInstances for lists of instance groups.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token that is used to continue a
- // truncated list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] The URL for this list of instance groups. The
- // server generates this URL.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupsListInstances) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupsListInstances
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupsListInstancesRequest struct {
- // InstanceState: A filter for the state of the instances in the
- // instance group. Valid options are ALL or RUNNING. If you do not
- // specify this parameter the list includes all instances regardless of
- // their state.
- //
- // Possible values:
- // "ALL"
- // "RUNNING"
- InstanceState string `json:"instanceState,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "InstanceState") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupsListInstancesRequest) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupsListInstancesRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupsRemoveInstancesRequest struct {
- // Instances: The list of instances to remove from the instance group.
- Instances []*InstanceReference `json:"instances,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Instances") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupsRemoveInstancesRequest) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupsRemoveInstancesRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupsScopedList struct {
- // InstanceGroups: [Output Only] The list of instance groups that are
- // contained in this scope.
- InstanceGroups []*InstanceGroup `json:"instanceGroups,omitempty"`
-
- // Warning: [Output Only] An informational warning that replaces the
- // list of instance groups when the list is empty.
- Warning *InstanceGroupsScopedListWarning `json:"warning,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "InstanceGroups") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupsScopedList) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupsScopedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// InstanceGroupsScopedListWarning: [Output Only] An informational
-// warning that replaces the list of instance groups when the list is
-// empty.
-type InstanceGroupsScopedListWarning struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*InstanceGroupsScopedListWarningData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupsScopedListWarning) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupsScopedListWarning
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupsScopedListWarningData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupsScopedListWarningData) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupsScopedListWarningData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupsSetNamedPortsRequest struct {
- // Fingerprint: The fingerprint of the named ports information for this
- // instance group. Use this optional property to prevent conflicts when
- // multiple users change the named ports settings concurrently. Obtain
- // the fingerprint with the instanceGroups.get method. Then, include the
- // fingerprint in your request to ensure that you do not overwrite
- // changes that were applied from another concurrent request.
- Fingerprint string `json:"fingerprint,omitempty"`
-
- // NamedPorts: The list of named ports to set for this instance group.
- NamedPorts []*NamedPort `json:"namedPorts,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Fingerprint") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupsSetNamedPortsRequest) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupsSetNamedPortsRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// InstanceList: Contains a list of instance resources.
-type InstanceList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of Instance resources.
- Items []*Instance `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#instanceList for
- // lists of Instance resources.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceList) MarshalJSON() ([]byte, error) {
- type noMethod InstanceList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceProperties struct {
- // CanIpForward: Enables instances created based on this template to
- // send packets with source IP addresses other than their own and
- // receive packets with destination IP addresses other than their own.
- // If these instances will be used as an IP gateway or it will be set as
- // the next-hop in a Route resource, specify true. If unsure, leave this
- // set to false. See the canIpForward documentation for more
- // information.
- CanIpForward bool `json:"canIpForward,omitempty"`
-
- // Description: An optional text description for the instances that are
- // created from this instance template.
- Description string `json:"description,omitempty"`
-
- // Disks: An array of disks that are associated with the instances that
- // are created from this template.
- Disks []*AttachedDisk `json:"disks,omitempty"`
-
- // MachineType: The machine type to use for instances that are created
- // from this template.
- MachineType string `json:"machineType,omitempty"`
-
- // Metadata: The metadata key/value pairs to assign to instances that
- // are created from this template. These pairs can consist of custom
- // metadata or predefined keys. See Project and instance metadata for
- // more information.
- Metadata *Metadata `json:"metadata,omitempty"`
-
- // NetworkInterfaces: An array of network access configurations for this
- // interface.
- NetworkInterfaces []*NetworkInterface `json:"networkInterfaces,omitempty"`
-
- // Scheduling: Specifies the scheduling options for the instances that
- // are created from this template.
- Scheduling *Scheduling `json:"scheduling,omitempty"`
-
- // ServiceAccounts: A list of service accounts with specified scopes.
- // Access tokens for these service accounts are available to the
- // instances that are created from this template. Use metadata queries
- // to obtain the access tokens for these instances.
- ServiceAccounts []*ServiceAccount `json:"serviceAccounts,omitempty"`
-
- // Tags: A list of tags to apply to the instances that are created from
- // this template. The tags identify valid sources or targets for network
- // firewalls. The setTags method can modify this list of tags. Each tag
- // within the list must comply with RFC1035.
- Tags *Tags `json:"tags,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CanIpForward") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceProperties) MarshalJSON() ([]byte, error) {
- type noMethod InstanceProperties
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceReference struct {
- // Instance: The URL for a specific instance.
- Instance string `json:"instance,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Instance") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceReference) MarshalJSON() ([]byte, error) {
- type noMethod InstanceReference
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// InstanceTemplate: An Instance Template resource.
-type InstanceTemplate struct {
- // CreationTimestamp: [Output Only] The creation timestamp for this
- // instance template in RFC3339 text format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional text description for the instance template.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] A unique identifier for this instance template. The
- // server defines this identifier.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] The resource type, which is always
- // compute#instanceTemplate for instance templates.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // Properties: The instance properties for this instance template.
- Properties *InstanceProperties `json:"properties,omitempty"`
-
- // SelfLink: [Output Only] The URL for this instance template. The
- // server defines this URL.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceTemplate) MarshalJSON() ([]byte, error) {
- type noMethod InstanceTemplate
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// InstanceTemplateList: A list of instance templates.
-type InstanceTemplateList struct {
- // Id: [Output Only] A unique identifier for this instance template. The
- // server defines this identifier.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] list of InstanceTemplate resources.
- Items []*InstanceTemplate `json:"items,omitempty"`
-
- // Kind: [Output Only] The resource type, which is always
- // compute#instanceTemplatesListResponse for instance template lists.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token that is used to continue a
- // truncated list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] The URL for this instance template list. The
- // server defines this URL.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceTemplateList) MarshalJSON() ([]byte, error) {
- type noMethod InstanceTemplateList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceWithNamedPorts struct {
- // Instance: [Output Only] The URL of the instance.
- Instance string `json:"instance,omitempty"`
-
- // NamedPorts: [Output Only] The named ports that belong to this
- // instance group.
- NamedPorts []*NamedPort `json:"namedPorts,omitempty"`
-
- // Status: [Output Only] The status of the instance.
- //
- // Possible values:
- // "PROVISIONING"
- // "RUNNING"
- // "STAGING"
- // "STOPPED"
- // "STOPPING"
- // "SUSPENDED"
- // "SUSPENDING"
- // "TERMINATED"
- Status string `json:"status,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Instance") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceWithNamedPorts) MarshalJSON() ([]byte, error) {
- type noMethod InstanceWithNamedPorts
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstancesScopedList struct {
- // Instances: [Output Only] List of instances contained in this scope.
- Instances []*Instance `json:"instances,omitempty"`
-
- // Warning: [Output Only] Informational warning which replaces the list
- // of instances when the list is empty.
- Warning *InstancesScopedListWarning `json:"warning,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Instances") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstancesScopedList) MarshalJSON() ([]byte, error) {
- type noMethod InstancesScopedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// InstancesScopedListWarning: [Output Only] Informational warning which
-// replaces the list of instances when the list is empty.
-type InstancesScopedListWarning struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*InstancesScopedListWarningData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstancesScopedListWarning) MarshalJSON() ([]byte, error) {
- type noMethod InstancesScopedListWarning
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstancesScopedListWarningData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstancesScopedListWarningData) MarshalJSON() ([]byte, error) {
- type noMethod InstancesScopedListWarningData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstancesSetLabelsRequest struct {
- LabelFingerprint string `json:"labelFingerprint,omitempty"`
-
- Labels map[string]string `json:"labels,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "LabelFingerprint") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstancesSetLabelsRequest) MarshalJSON() ([]byte, error) {
- type noMethod InstancesSetLabelsRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstancesSetMachineTypeRequest struct {
- // MachineType: Full or partial URL of the machine type resource. See
- // Instance.machine_type.
- MachineType string `json:"machineType,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "MachineType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstancesSetMachineTypeRequest) MarshalJSON() ([]byte, error) {
- type noMethod InstancesSetMachineTypeRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// License: A license resource.
-type License struct {
- // ChargesUseFee: If true, the customer will be charged license fee for
- // running software that contains this license on an instance.
- ChargesUseFee bool `json:"chargesUseFee,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#license for
- // licenses.
- Kind string `json:"kind,omitempty"`
-
- // Name: [Output Only] Name of the resource. The name is 1-63 characters
- // long and complies with RFC1035.
- Name string `json:"name,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ChargesUseFee") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *License) MarshalJSON() ([]byte, error) {
- type noMethod License
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MachineType: A Machine Type resource.
-type MachineType struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Deprecated: [Output Only] The deprecation status associated with this
- // machine type.
- Deprecated *DeprecationStatus `json:"deprecated,omitempty"`
-
- // Description: [Output Only] An optional textual description of the
- // resource.
- Description string `json:"description,omitempty"`
-
- // GuestCpus: [Output Only] The tumber of CPUs exposed to the instance.
- GuestCpus int64 `json:"guestCpus,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: Type of the resource.
- Kind string `json:"kind,omitempty"`
-
- // MaximumPersistentDisks: [Output Only] Maximum persistent disks
- // allowed.
- MaximumPersistentDisks int64 `json:"maximumPersistentDisks,omitempty"`
-
- // MaximumPersistentDisksSizeGb: [Output Only] Maximum total persistent
- // disks size (GB) allowed.
- MaximumPersistentDisksSizeGb int64 `json:"maximumPersistentDisksSizeGb,omitempty,string"`
-
- // MemoryMb: [Output Only] The amount of physical memory available to
- // the instance, defined in MB.
- MemoryMb int64 `json:"memoryMb,omitempty"`
-
- // Name: [Output Only] Name of the resource.
- Name string `json:"name,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Zone: [Output Only] The name of the zone where the machine type
- // resides, such as us-central1-a.
- Zone string `json:"zone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MachineType) MarshalJSON() ([]byte, error) {
- type noMethod MachineType
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type MachineTypeAggregatedList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A map of scoped machine type lists.
- Items map[string]MachineTypesScopedList `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always
- // compute#machineTypeAggregatedList for aggregated lists of machine
- // types.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MachineTypeAggregatedList) MarshalJSON() ([]byte, error) {
- type noMethod MachineTypeAggregatedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MachineTypeList: Contains a list of Machine Type resources.
-type MachineTypeList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of Machine Type resources.
- Items []*MachineType `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#machineTypeList
- // for lists of machine types.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MachineTypeList) MarshalJSON() ([]byte, error) {
- type noMethod MachineTypeList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type MachineTypesScopedList struct {
- // MachineTypes: [Output Only] List of machine types contained in this
- // scope.
- MachineTypes []*MachineType `json:"machineTypes,omitempty"`
-
- // Warning: [Output Only] An informational warning that appears when the
- // machine types list is empty.
- Warning *MachineTypesScopedListWarning `json:"warning,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "MachineTypes") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MachineTypesScopedList) MarshalJSON() ([]byte, error) {
- type noMethod MachineTypesScopedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MachineTypesScopedListWarning: [Output Only] An informational warning
-// that appears when the machine types list is empty.
-type MachineTypesScopedListWarning struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*MachineTypesScopedListWarningData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MachineTypesScopedListWarning) MarshalJSON() ([]byte, error) {
- type noMethod MachineTypesScopedListWarning
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type MachineTypesScopedListWarningData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MachineTypesScopedListWarningData) MarshalJSON() ([]byte, error) {
- type noMethod MachineTypesScopedListWarningData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ManagedInstance struct {
- // CurrentAction: [Output Only] The current action that the managed
- // instance group has scheduled for the instance. Possible values:
- // - NONE The instance is running, and the managed instance group does
- // not have any scheduled actions for this instance.
- // - CREATING The managed instance group is creating this instance.
- // - RECREATING The managed instance group is recreating this instance.
- //
- // - DELETING The managed instance group is permanently deleting this
- // instance.
- // - ABANDONING The managed instance group is abandoning this instance.
- // The instance will be removed from the instance group and from any
- // target pools that are associated with this group.
- // - RESTARTING The managed instance group is restarting the instance.
- //
- // - REFRESHING The managed instance group is applying configuration
- // changes to the instance without stopping it. For example, the group
- // can update the target pool list for an instance without stopping that
- // instance.
- //
- // Possible values:
- // "ABANDONING"
- // "CREATING"
- // "DELETING"
- // "NONE"
- // "RECREATING"
- // "REFRESHING"
- // "RESTARTING"
- CurrentAction string `json:"currentAction,omitempty"`
-
- // Id: [Output only] The unique identifier for this resource. This field
- // is empty when instance does not exist.
- Id uint64 `json:"id,omitempty,string"`
-
- // Instance: [Output Only] The URL of the instance. The URL can exist
- // even if the instance has not yet been created.
- Instance string `json:"instance,omitempty"`
-
- // InstanceStatus: [Output Only] The status of the instance. This field
- // is empty when the instance does not exist.
- //
- // Possible values:
- // "PROVISIONING"
- // "RUNNING"
- // "STAGING"
- // "STOPPED"
- // "STOPPING"
- // "SUSPENDED"
- // "SUSPENDING"
- // "TERMINATED"
- InstanceStatus string `json:"instanceStatus,omitempty"`
-
- // LastAttempt: [Output Only] Information about the last attempt to
- // create or delete the instance.
- LastAttempt *ManagedInstanceLastAttempt `json:"lastAttempt,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CurrentAction") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ManagedInstance) MarshalJSON() ([]byte, error) {
- type noMethod ManagedInstance
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ManagedInstanceLastAttempt struct {
- // Errors: [Output Only] Encountered errors during the last attempt to
- // create or delete the instance.
- Errors *ManagedInstanceLastAttemptErrors `json:"errors,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Errors") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ManagedInstanceLastAttempt) MarshalJSON() ([]byte, error) {
- type noMethod ManagedInstanceLastAttempt
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ManagedInstanceLastAttemptErrors: [Output Only] Encountered errors
-// during the last attempt to create or delete the instance.
-type ManagedInstanceLastAttemptErrors struct {
- // Errors: [Output Only] The array of errors encountered while
- // processing this operation.
- Errors []*ManagedInstanceLastAttemptErrorsErrors `json:"errors,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Errors") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ManagedInstanceLastAttemptErrors) MarshalJSON() ([]byte, error) {
- type noMethod ManagedInstanceLastAttemptErrors
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ManagedInstanceLastAttemptErrorsErrors struct {
- // Code: [Output Only] The error type identifier for this error.
- Code string `json:"code,omitempty"`
-
- // Location: [Output Only] Indicates the field in the request which
- // caused the error. This property is optional.
- Location string `json:"location,omitempty"`
-
- // Message: [Output Only] An optional, human-readable error message.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ManagedInstanceLastAttemptErrorsErrors) MarshalJSON() ([]byte, error) {
- type noMethod ManagedInstanceLastAttemptErrorsErrors
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Metadata: A metadata key/value entry.
-type Metadata struct {
- // Fingerprint: Specifies a fingerprint for this request, which is
- // essentially a hash of the metadata's contents and used for optimistic
- // locking. The fingerprint is initially generated by Compute Engine and
- // changes after every request to modify or update metadata. You must
- // always provide an up-to-date fingerprint hash in order to update or
- // change metadata.
- Fingerprint string `json:"fingerprint,omitempty"`
-
- // Items: Array of key/value pairs. The total size of all keys and
- // values must be less than 512 KB.
- Items []*MetadataItems `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of the resource. Always compute#metadata for
- // metadata.
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Fingerprint") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Metadata) MarshalJSON() ([]byte, error) {
- type noMethod Metadata
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type MetadataItems struct {
- // Key: Key for the metadata entry. Keys must conform to the following
- // regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is
- // reflected as part of a URL in the metadata server. Additionally, to
- // avoid ambiguity, keys must not conflict with any other metadata keys
- // for the project.
- Key string `json:"key,omitempty"`
-
- // Value: Value for the metadata entry. These are free-form strings, and
- // only have meaning as interpreted by the image running in the
- // instance. The only restriction placed on values is that their size
- // must be less than or equal to 32768 bytes.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MetadataItems) MarshalJSON() ([]byte, error) {
- type noMethod MetadataItems
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// NamedPort: The named port. For example: .
-type NamedPort struct {
- // Name: The name for this named port. The name must be 1-63 characters
- // long, and comply with RFC1035.
- Name string `json:"name,omitempty"`
-
- // Port: The port number, which can be a value between 1 and 65535.
- Port int64 `json:"port,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Name") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *NamedPort) MarshalJSON() ([]byte, error) {
- type noMethod NamedPort
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Network: A network resource.
-type Network struct {
- // IPv4Range: The range of internal addresses that are legal on this
- // network. This range is a CIDR specification, for example:
- // 192.168.0.0/16. Provided by the client when the network is created.
- IPv4Range string `json:"IPv4Range,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource.
- // Provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // GatewayIPv4: A gateway address for default routing to other networks.
- // This value is read only and is selected by the Google Compute Engine,
- // typically as the first usable address in the IPv4Range.
- GatewayIPv4 string `json:"gatewayIPv4,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always compute#network for
- // networks.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource. Provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "IPv4Range") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Network) MarshalJSON() ([]byte, error) {
- type noMethod Network
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// NetworkInterface: A network interface resource attached to an
-// instance.
-type NetworkInterface struct {
- // AccessConfigs: An array of configurations for this interface.
- // Currently, ONE_TO_ONE_NAT is the only access config supported. If
- // there are no accessConfigs specified, then this instance will have no
- // external internet access.
- AccessConfigs []*AccessConfig `json:"accessConfigs,omitempty"`
-
- // Name: [Output Only] The name of the network interface, generated by
- // the server. For network devices, these are eth0, eth1, etc.
- Name string `json:"name,omitempty"`
-
- // Network: URL of the network resource for this instance. This is
- // required for creating an instance but optional when creating a
- // firewall rule. If not specified when creating a firewall rule, the
- // default network is used:
- //
- // global/networks/default
- //
- // If you specify this property, you can specify the network as a full
- // or partial URL. For example, the following are all valid URLs:
- // -
- // https://www.googleapis.com/compute/v1/projects/project/global/networks/network
- // - projects/project/global/networks/network
- // - global/networks/default
- Network string `json:"network,omitempty"`
-
- // NetworkIP: [Output Only] An optional IPV4 internal network address
- // assigned to the instance for this network interface.
- NetworkIP string `json:"networkIP,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AccessConfigs") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *NetworkInterface) MarshalJSON() ([]byte, error) {
- type noMethod NetworkInterface
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// NetworkList: Contains a list of Network resources.
-type NetworkList struct {
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of Network resources.
- Items []*Network `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#networkList for
- // lists of networks.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource .
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *NetworkList) MarshalJSON() ([]byte, error) {
- type noMethod NetworkList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Operation: An Operation resource, used to manage asynchronous API
-// requests.
-type Operation struct {
- // ClientOperationId: [Output Only] An optional identifier specified by
- // the client when the mutation was initiated. Must be unique for all
- // Operation resources in the project.
- ClientOperationId string `json:"clientOperationId,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // EndTime: [Output Only] The time that this operation was completed.
- // This is in RFC3339 text format.
- EndTime string `json:"endTime,omitempty"`
-
- // Error: [Output Only] If errors are generated during processing of the
- // operation, this field will be populated.
- Error *OperationError `json:"error,omitempty"`
-
- // HttpErrorMessage: [Output Only] If the operation fails, this field
- // contains the HTTP error message that was returned, such as NOT FOUND.
- HttpErrorMessage string `json:"httpErrorMessage,omitempty"`
-
- // HttpErrorStatusCode: [Output Only] If the operation fails, this field
- // contains the HTTP error message that was returned, such as 404.
- HttpErrorStatusCode int64 `json:"httpErrorStatusCode,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // InsertTime: [Output Only] The time that this operation was requested.
- // This is in RFC3339 text format.
- InsertTime string `json:"insertTime,omitempty"`
-
- // Kind: [Output Only] Type of the resource. Always compute#operation
- // for Operation resources.
- Kind string `json:"kind,omitempty"`
-
- // Name: [Output Only] Name of the resource.
- Name string `json:"name,omitempty"`
-
- // OperationType: [Output Only] Type of the operation, such as insert,
- // compute.instanceGroups.update, or compute.instanceGroups.delete.
- OperationType string `json:"operationType,omitempty"`
-
- // Progress: [Output Only] An optional progress indicator that ranges
- // from 0 to 100. There is no requirement that this be linear or support
- // any granularity of operations. This should not be used to guess at
- // when the operation will be complete. This number should monotonically
- // increase as the operation progresses.
- Progress int64 `json:"progress,omitempty"`
-
- // Region: [Output Only] URL of the region where the operation resides.
- // Only applicable for regional resources.
- Region string `json:"region,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // StartTime: [Output Only] The time that this operation was started by
- // the server. This is in RFC3339 text format.
- StartTime string `json:"startTime,omitempty"`
-
- // Status: [Output Only] Status of the operation. Can be one of the
- // following: PENDING, RUNNING, or DONE.
- //
- // Possible values:
- // "DONE"
- // "PENDING"
- // "RUNNING"
- Status string `json:"status,omitempty"`
-
- // StatusMessage: [Output Only] An optional textual description of the
- // current status of the operation.
- StatusMessage string `json:"statusMessage,omitempty"`
-
- // TargetId: [Output Only] Unique target ID which identifies a
- // particular incarnation of the target.
- TargetId uint64 `json:"targetId,omitempty,string"`
-
- // TargetLink: [Output Only] URL of the resource the operation is
- // mutating.
- TargetLink string `json:"targetLink,omitempty"`
-
- // User: [Output Only] User who requested the operation, for example:
- // user@example.com.
- User string `json:"user,omitempty"`
-
- // Warnings: [Output Only] If warning messages are generated during
- // processing of the operation, this field will be populated.
- Warnings []*OperationWarnings `json:"warnings,omitempty"`
-
- // Zone: [Output Only] URL of the zone where the operation resides.
- Zone string `json:"zone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ClientOperationId")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Operation) MarshalJSON() ([]byte, error) {
- type noMethod Operation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperationError: [Output Only] If errors are generated during
-// processing of the operation, this field will be populated.
-type OperationError struct {
- // Errors: [Output Only] The array of errors encountered while
- // processing this operation.
- Errors []*OperationErrorErrors `json:"errors,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Errors") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationError) MarshalJSON() ([]byte, error) {
- type noMethod OperationError
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationErrorErrors struct {
- // Code: [Output Only] The error type identifier for this error.
- Code string `json:"code,omitempty"`
-
- // Location: [Output Only] Indicates the field in the request which
- // caused the error. This property is optional.
- Location string `json:"location,omitempty"`
-
- // Message: [Output Only] An optional, human-readable error message.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationErrorErrors) MarshalJSON() ([]byte, error) {
- type noMethod OperationErrorErrors
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationWarnings struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*OperationWarningsData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationWarnings) MarshalJSON() ([]byte, error) {
- type noMethod OperationWarnings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationWarningsData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationWarningsData) MarshalJSON() ([]byte, error) {
- type noMethod OperationWarningsData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationAggregatedList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A map of scoped operation lists.
- Items map[string]OperationsScopedList `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always
- // compute#operationAggregatedList for aggregated lists of operations.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationAggregatedList) MarshalJSON() ([]byte, error) {
- type noMethod OperationAggregatedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperationList: Contains a list of Operation resources.
-type OperationList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] The Operation resources.
- Items []*Operation `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#operations for
- // Operations resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncate.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationList) MarshalJSON() ([]byte, error) {
- type noMethod OperationList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationsScopedList struct {
- // Operations: [Output Only] List of operations contained in this scope.
- Operations []*Operation `json:"operations,omitempty"`
-
- // Warning: [Output Only] Informational warning which replaces the list
- // of operations when the list is empty.
- Warning *OperationsScopedListWarning `json:"warning,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Operations") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationsScopedList) MarshalJSON() ([]byte, error) {
- type noMethod OperationsScopedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperationsScopedListWarning: [Output Only] Informational warning
-// which replaces the list of operations when the list is empty.
-type OperationsScopedListWarning struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*OperationsScopedListWarningData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationsScopedListWarning) MarshalJSON() ([]byte, error) {
- type noMethod OperationsScopedListWarning
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationsScopedListWarningData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationsScopedListWarningData) MarshalJSON() ([]byte, error) {
- type noMethod OperationsScopedListWarningData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PathMatcher: A matcher for the path portion of the URL. The
-// BackendService from the longest-matched rule will serve the URL. If
-// no rule was matched, the default service will be used.
-type PathMatcher struct {
- // DefaultService: The URL to the BackendService resource. This will be
- // used if none of the 'pathRules' defined by this PathMatcher is met by
- // the URL's path portion.
- DefaultService string `json:"defaultService,omitempty"`
-
- // Description: An optional textual description of the resource.
- Description string `json:"description,omitempty"`
-
- // Name: The name to which this PathMatcher is referred by the HostRule.
- Name string `json:"name,omitempty"`
-
- // PathRules: The list of path rules.
- PathRules []*PathRule `json:"pathRules,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DefaultService") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PathMatcher) MarshalJSON() ([]byte, error) {
- type noMethod PathMatcher
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PathRule: A path-matching rule for a URL. If matched, will use the
-// specified BackendService to handle the traffic arriving at this URL.
-type PathRule struct {
- // Paths: The list of path patterns to match. Each must start with / and
- // the only place a * is allowed is at the end following a /. The string
- // fed to the path matcher does not include any text after the first ?
- // or #, and those chars are not allowed here.
- Paths []string `json:"paths,omitempty"`
-
- // Service: The URL of the BackendService resource if this rule is
- // matched.
- Service string `json:"service,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Paths") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PathRule) MarshalJSON() ([]byte, error) {
- type noMethod PathRule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Project: A Project resource. Projects can only be created in the
-// Google Developers Console. Unless marked otherwise, values can only
-// be modified in the console.
-type Project struct {
- // CommonInstanceMetadata: Metadata key/value pairs available to all
- // instances contained in this project. See Custom metadata for more
- // information.
- CommonInstanceMetadata *Metadata `json:"commonInstanceMetadata,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource.
- Description string `json:"description,omitempty"`
-
- // EnabledFeatures: Restricted features enabled for use on this project.
- EnabledFeatures []string `json:"enabledFeatures,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always compute#project for
- // projects.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource.
- Name string `json:"name,omitempty"`
-
- // Quotas: [Output Only] Quotas assigned to this project.
- Quotas []*Quota `json:"quotas,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // UsageExportLocation: The location in Cloud Storage and naming method
- // of the daily usage report.
- UsageExportLocation *UsageExportLocation `json:"usageExportLocation,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "CommonInstanceMetadata") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Project) MarshalJSON() ([]byte, error) {
- type noMethod Project
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Quota: A quotas entry.
-type Quota struct {
- // Limit: [Output Only] Quota limit for this metric.
- Limit float64 `json:"limit,omitempty"`
-
- // Metric: [Output Only] Name of the quota metric.
- //
- // Possible values:
- // "BACKEND_SERVICES"
- // "CPUS"
- // "DISKS_TOTAL_GB"
- // "FIREWALLS"
- // "FORWARDING_RULES"
- // "HEALTH_CHECKS"
- // "IMAGES"
- // "INSTANCES"
- // "INSTANCE_GROUPS"
- // "INSTANCE_GROUP_MANAGERS"
- // "INSTANCE_TEMPLATES"
- // "IN_USE_ADDRESSES"
- // "LOCAL_SSD_TOTAL_GB"
- // "NETWORKS"
- // "ROUTES"
- // "SNAPSHOTS"
- // "SSD_TOTAL_GB"
- // "STATIC_ADDRESSES"
- // "TARGET_HTTP_PROXIES"
- // "TARGET_INSTANCES"
- // "TARGET_POOLS"
- // "TARGET_VPN_GATEWAYS"
- // "URL_MAPS"
- // "VPN_TUNNELS"
- Metric string `json:"metric,omitempty"`
-
- // Usage: [Output Only] Current usage of this metric.
- Usage float64 `json:"usage,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Limit") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Quota) MarshalJSON() ([]byte, error) {
- type noMethod Quota
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Region: Region resource.
-type Region struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Deprecated: [Output Only] The deprecation status associated with this
- // region.
- Deprecated *DeprecationStatus `json:"deprecated,omitempty"`
-
- // Description: [Output Only] Textual description of the resource.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server .
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always compute#region for
- // regions.
- Kind string `json:"kind,omitempty"`
-
- // Name: [Output Only] Name of the resource.
- Name string `json:"name,omitempty"`
-
- // Quotas: [Output Only] Quotas assigned to this region.
- Quotas []*Quota `json:"quotas,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Status: [Output Only] Status of the region, either UP or DOWN.
- //
- // Possible values:
- // "DOWN"
- // "UP"
- Status string `json:"status,omitempty"`
-
- // Zones: [Output Only] A list of zones available in this region, in the
- // form of resource URLs.
- Zones []string `json:"zones,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Region) MarshalJSON() ([]byte, error) {
- type noMethod Region
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// RegionList: Contains a list of region resources.
-type RegionList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of Region resources.
- Items []*Region `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#regionList for
- // lists of regions.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RegionList) MarshalJSON() ([]byte, error) {
- type noMethod RegionList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ResourceGroupReference struct {
- // Group: A URI referencing one of the resource views listed in the
- // backend service.
- Group string `json:"group,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Group") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ResourceGroupReference) MarshalJSON() ([]byte, error) {
- type noMethod ResourceGroupReference
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Route: The route resource. A Route is a rule that specifies how
-// certain packets should be handled by the virtual network. Routes are
-// associated with instances by tag and the set of Routes for a
-// particular instance is called its routing table. For each packet
-// leaving a instance, the system searches that instance's routing table
-// for a single best matching Route. Routes match packets by destination
-// IP address, preferring smaller or more specific ranges over larger
-// ones. If there is a tie, the system selects the Route with the
-// smallest priority value. If there is still a tie, it uses the layer
-// three and four packet headers to select just one of the remaining
-// matching Routes. The packet is then forwarded as specified by the
-// nextHop field of the winning Route -- either to another instance
-// destination, a instance gateway or a Google Compute Engien-operated
-// gateway. Packets that do not match any Route in the sending
-// instance's routing table are dropped.
-type Route struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource.
- // Provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // DestRange: The destination range of outgoing packets that this route
- // applies to.
- DestRange string `json:"destRange,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of this resource. Always compute#routes for
- // Route resources.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // Network: Fully-qualified URL of the network that this route applies
- // to.
- Network string `json:"network,omitempty"`
-
- // NextHopGateway: The URL to a gateway that should handle matching
- // packets. Currently, this is only the internet gateway:
- // projects//global/gateways/default-internet-gateway
- NextHopGateway string `json:"nextHopGateway,omitempty"`
-
- // NextHopInstance: The fully-qualified URL to an instance that should
- // handle matching packets. For
- // example:
- // https://www.googleapis.com/compute/v1/projects/project/zones/
- // zone/instances/
- NextHopInstance string `json:"nextHopInstance,omitempty"`
-
- // NextHopIp: The network IP address of an instance that should handle
- // matching packets.
- NextHopIp string `json:"nextHopIp,omitempty"`
-
- // NextHopNetwork: The URL of the local network if it should handle
- // matching packets.
- NextHopNetwork string `json:"nextHopNetwork,omitempty"`
-
- // NextHopVpnTunnel: The URL to a VpnTunnel that should handle matching
- // packets.
- NextHopVpnTunnel string `json:"nextHopVpnTunnel,omitempty"`
-
- // Priority: Breaks ties between Routes of equal specificity. Routes
- // with smaller values win when tied with routes with larger values.
- // Default value is 1000. A valid range is between 0 and 65535.
- Priority int64 `json:"priority,omitempty"`
-
- // SelfLink: [Output Only] Server-defined fully-qualified URL for this
- // resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Tags: A list of instance tags to which this route applies.
- Tags []string `json:"tags,omitempty"`
-
- // Warnings: [Output Only] If potential misconfigurations are detected
- // for this route, this field will be populated with warning messages.
- Warnings []*RouteWarnings `json:"warnings,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Route) MarshalJSON() ([]byte, error) {
- type noMethod Route
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type RouteWarnings struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*RouteWarningsData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RouteWarnings) MarshalJSON() ([]byte, error) {
- type noMethod RouteWarnings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type RouteWarningsData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RouteWarningsData) MarshalJSON() ([]byte, error) {
- type noMethod RouteWarningsData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// RouteList: Contains a list of route resources.
-type RouteList struct {
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A list of Route resources.
- Items []*Route `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RouteList) MarshalJSON() ([]byte, error) {
- type noMethod RouteList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Scheduling: Sets the scheduling options for an Instance.
-type Scheduling struct {
- // AutomaticRestart: Specifies whether the instance should be
- // automatically restarted if it is terminated by Compute Engine (not
- // terminated by a user). You can only set the automatic restart option
- // for standard instances. Preemptible instances cannot be automatically
- // restarted.
- AutomaticRestart bool `json:"automaticRestart,omitempty"`
-
- // OnHostMaintenance: Defines the maintenance behavior for this
- // instance. For standard instances, the default behavior is MIGRATE.
- // For preemptible instances, the default and only possible behavior is
- // TERMINATE. For more information, see Setting maintenance behavior.
- //
- // Possible values:
- // "MIGRATE"
- // "TERMINATE"
- OnHostMaintenance string `json:"onHostMaintenance,omitempty"`
-
- // Preemptible: Whether the instance is preemptible.
- Preemptible bool `json:"preemptible,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AutomaticRestart") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Scheduling) MarshalJSON() ([]byte, error) {
- type noMethod Scheduling
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SerialPortOutput: An instance's serial console output.
-type SerialPortOutput struct {
- // Contents: [Output Only] The contents of the console output.
- Contents string `json:"contents,omitempty"`
-
- // Kind: [Output Only] Type of the resource. Always
- // compute#serialPortOutput for serial port output.
- Kind string `json:"kind,omitempty"`
-
- // SelfLink: [Output Only] Server defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Contents") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SerialPortOutput) MarshalJSON() ([]byte, error) {
- type noMethod SerialPortOutput
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ServiceAccount: A service account.
-type ServiceAccount struct {
- // Email: Email address of the service account.
- Email string `json:"email,omitempty"`
-
- // Scopes: The list of scopes to be made available for this service
- // account.
- Scopes []string `json:"scopes,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Email") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ServiceAccount) MarshalJSON() ([]byte, error) {
- type noMethod ServiceAccount
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Snapshot: A persistent disk snapshot resource.
-type Snapshot struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // DiskSizeGb: [Output Only] Size of the snapshot, specified in GB.
- DiskSizeGb int64 `json:"diskSizeGb,omitempty,string"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always compute#snapshot for
- // Snapshot resources.
- Kind string `json:"kind,omitempty"`
-
- // Licenses: Public visible licenses.
- Licenses []string `json:"licenses,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // SnapshotEncryptionKey: Encrypts the snapshot using a
- // customer-supplied encryption key.
- //
- // If you encrypt a snapshot using a customer-supplied encryption key,
- // and you want to use the snapshot later (e.g. to create a disk from
- // the snapshot), you must provide the same key used encrypt the
- // snapshot in your future request. If you provide an incorrect key, or
- // no key, the request will fail.
- //
- // Customer-supplied encryption keys do not protect access to metadata
- // of the disk.
- //
- // If no customer-supplied encryption key is provided at creation, then
- // the disk will be encrypted using an automatically generated key and
- // you do not need to provide a key to use the snapshot later.
- SnapshotEncryptionKey *CustomerEncryptionKey `json:"snapshotEncryptionKey,omitempty"`
-
- // SourceDisk: The source disk used to create this snapshot.
- SourceDisk string `json:"sourceDisk,omitempty"`
-
- // SourceDiskEncryptionKey: Specifies the customer-supplied encryption
- // key of the source disk. This key is required if the source disk is
- // protected by a customer-supplied encryption key.
- //
- // If the incorrect key is provided, the request will fail.
- SourceDiskEncryptionKey *CustomerEncryptionKey `json:"sourceDiskEncryptionKey,omitempty"`
-
- // SourceDiskId: [Output Only] The ID value of the disk used to create
- // this snapshot. This value may be used to determine whether the
- // snapshot was taken from the current or a previous instance of a given
- // disk name.
- SourceDiskId string `json:"sourceDiskId,omitempty"`
-
- // Status: [Output Only] The status of the snapshot.
- //
- // Possible values:
- // "CREATING"
- // "DELETING"
- // "FAILED"
- // "READY"
- // "UPLOADING"
- Status string `json:"status,omitempty"`
-
- // StorageBytes: [Output Only] A size of the the storage used by the
- // snapshot. As snapshots share storage, this number is expected to
- // change with snapshot creation/deletion.
- StorageBytes int64 `json:"storageBytes,omitempty,string"`
-
- // StorageBytesStatus: [Output Only] An indicator whether storageBytes
- // is in a stable state or it is being adjusted as a result of shared
- // storage reallocation.
- //
- // Possible values:
- // "UPDATING"
- // "UP_TO_DATE"
- StorageBytesStatus string `json:"storageBytesStatus,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Snapshot) MarshalJSON() ([]byte, error) {
- type noMethod Snapshot
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SnapshotList: Contains a list of Snapshot resources.
-type SnapshotList struct {
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A list of Snapshot resources.
- Items []*Snapshot `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SnapshotList) MarshalJSON() ([]byte, error) {
- type noMethod SnapshotList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SslCertificate: An SslCertificate resource. This resource provides a
-// mechanism to upload an SSL key and certificate to global HTTPS
-// loadbalancer to serve secure connections.
-type SslCertificate struct {
- // Certificate: A local certificate file. The certificate must be in PEM
- // format. The certificate chain must be no greater than 5 certs long.
- // The chain must include at least one intermediate cert.
- Certificate string `json:"certificate,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource.
- // Provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always
- // compute#sslCertificate for SSL certificates.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource. Provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // PrivateKey: A write-only private key in PEM format. Only insert RPCs
- // will include this field.
- PrivateKey string `json:"privateKey,omitempty"`
-
- // SelfLink: [Output only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Certificate") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SslCertificate) MarshalJSON() ([]byte, error) {
- type noMethod SslCertificate
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SslCertificateList: Contains a list of SslCertificate resources.
-type SslCertificateList struct {
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A list of SslCertificate resources.
- Items []*SslCertificate `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SslCertificateList) MarshalJSON() ([]byte, error) {
- type noMethod SslCertificateList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Tags: A set of instance tags.
-type Tags struct {
- // Fingerprint: Specifies a fingerprint for this request, which is
- // essentially a hash of the metadata's contents and used for optimistic
- // locking. The fingerprint is initially generated by Compute Engine and
- // changes after every request to modify or update metadata. You must
- // always provide an up-to-date fingerprint hash in order to update or
- // change metadata.
- //
- // To see the latest fingerprint, make get() request to the instance.
- Fingerprint string `json:"fingerprint,omitempty"`
-
- // Items: An array of tags. Each tag must be 1-63 characters long, and
- // comply with RFC1035.
- Items []string `json:"items,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Fingerprint") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Tags) MarshalJSON() ([]byte, error) {
- type noMethod Tags
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetHttpProxy: A TargetHttpProxy resource. This resource defines an
-// HTTP proxy.
-type TargetHttpProxy struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of resource. Always compute#operation for
- // Operation resources.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // UrlMap: URL to the UrlMap resource that defines the mapping from URL
- // to the BackendService.
- UrlMap string `json:"urlMap,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetHttpProxy) MarshalJSON() ([]byte, error) {
- type noMethod TargetHttpProxy
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetHttpProxyList: A list of TargetHttpProxy resources.
-type TargetHttpProxyList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A list of TargetHttpProxy resources.
- Items []*TargetHttpProxy `json:"items,omitempty"`
-
- // Kind: Type of resource. Always compute#targetHttpProxyList for lists
- // of Target HTTP proxies.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetHttpProxyList) MarshalJSON() ([]byte, error) {
- type noMethod TargetHttpProxyList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetHttpsProxiesSetSslCertificatesRequest struct {
- // SslCertificates: New set of URLs to SslCertificate resources to
- // associate with this TargetHttpProxy. Currently exactly one ssl
- // certificate must be specified.
- SslCertificates []string `json:"sslCertificates,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "SslCertificates") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetHttpsProxiesSetSslCertificatesRequest) MarshalJSON() ([]byte, error) {
- type noMethod TargetHttpsProxiesSetSslCertificatesRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetHttpsProxy: A TargetHttpsProxy resource. This resource defines
-// an HTTPS proxy.
-type TargetHttpsProxy struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource.
- // Provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: Type of the resource.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource. Provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // SslCertificates: URLs to SslCertificate resources that are used to
- // authenticate connections to Backends. Currently exactly one SSL
- // certificate must be specified.
- SslCertificates []string `json:"sslCertificates,omitempty"`
-
- // UrlMap: URL to the UrlMap resource that defines the mapping from URL
- // to the BackendService.
- UrlMap string `json:"urlMap,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetHttpsProxy) MarshalJSON() ([]byte, error) {
- type noMethod TargetHttpsProxy
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetHttpsProxyList: Contains a list of TargetHttpsProxy resources.
-type TargetHttpsProxyList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A list of TargetHttpsProxy resources.
- Items []*TargetHttpsProxy `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetHttpsProxyList) MarshalJSON() ([]byte, error) {
- type noMethod TargetHttpsProxyList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetInstance: A TargetInstance resource. This resource defines an
-// endpoint instance that terminates traffic of certain protocols.
-type TargetInstance struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Instance: The URL to the instance that terminates the relevant
- // traffic.
- Instance string `json:"instance,omitempty"`
-
- // Kind: Type of the resource.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource. Provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // NatPolicy: NAT option controlling how IPs are NAT'ed to the instance.
- // Currently only NO_NAT (default value) is supported.
- //
- // Possible values:
- // "NO_NAT"
- NatPolicy string `json:"natPolicy,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Zone: [Output Only] URL of the zone where the target instance
- // resides.
- Zone string `json:"zone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetInstance) MarshalJSON() ([]byte, error) {
- type noMethod TargetInstance
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetInstanceAggregatedList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A map of scoped target instance lists.
- Items map[string]TargetInstancesScopedList `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetInstanceAggregatedList) MarshalJSON() ([]byte, error) {
- type noMethod TargetInstanceAggregatedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetInstanceList: Contains a list of TargetInstance resources.
-type TargetInstanceList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A list of TargetInstance resources.
- Items []*TargetInstance `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetInstanceList) MarshalJSON() ([]byte, error) {
- type noMethod TargetInstanceList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetInstancesScopedList struct {
- // TargetInstances: List of target instances contained in this scope.
- TargetInstances []*TargetInstance `json:"targetInstances,omitempty"`
-
- // Warning: Informational warning which replaces the list of addresses
- // when the list is empty.
- Warning *TargetInstancesScopedListWarning `json:"warning,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "TargetInstances") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetInstancesScopedList) MarshalJSON() ([]byte, error) {
- type noMethod TargetInstancesScopedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetInstancesScopedListWarning: Informational warning which
-// replaces the list of addresses when the list is empty.
-type TargetInstancesScopedListWarning struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*TargetInstancesScopedListWarningData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetInstancesScopedListWarning) MarshalJSON() ([]byte, error) {
- type noMethod TargetInstancesScopedListWarning
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetInstancesScopedListWarningData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetInstancesScopedListWarningData) MarshalJSON() ([]byte, error) {
- type noMethod TargetInstancesScopedListWarningData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetPool: A TargetPool resource. This resource defines a pool of
-// instances, associated HttpHealthCheck resources, and the fallback
-// TargetPool.
-type TargetPool struct {
- // BackupPool: This field is applicable only when the containing target
- // pool is serving a forwarding rule as the primary pool, and its
- // failoverRatio field is properly set to a value between [0,
- // 1].
- //
- // backupPool and failoverRatio together define the fallback behavior of
- // the primary target pool: if the ratio of the healthy instances in the
- // primary pool is at or below failoverRatio, traffic arriving at the
- // load-balanced IP will be directed to the backup pool.
- //
- // In case where failoverRatio and backupPool are not set, or all the
- // instances in the backup pool are unhealthy, the traffic will be
- // directed back to the primary pool in the "force" mode, where traffic
- // will be spread to the healthy instances with the best effort, or to
- // all instances when no instance is healthy.
- BackupPool string `json:"backupPool,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // FailoverRatio: This field is applicable only when the containing
- // target pool is serving a forwarding rule as the primary pool (i.e.,
- // not as a backup pool to some other target pool). The value of the
- // field must be in [0, 1].
- //
- // If set, backupPool must also be set. They together define the
- // fallback behavior of the primary target pool: if the ratio of the
- // healthy instances in the primary pool is at or below this number,
- // traffic arriving at the load-balanced IP will be directed to the
- // backup pool.
- //
- // In case where failoverRatio is not set or all the instances in the
- // backup pool are unhealthy, the traffic will be directed back to the
- // primary pool in the "force" mode, where traffic will be spread to the
- // healthy instances with the best effort, or to all instances when no
- // instance is healthy.
- FailoverRatio float64 `json:"failoverRatio,omitempty"`
-
- // HealthChecks: A list of URLs to the HttpHealthCheck resource. A
- // member instance in this pool is considered healthy if and only if all
- // specified health checks pass. An empty list means all member
- // instances will be considered healthy at all times.
- HealthChecks []string `json:"healthChecks,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Instances: A list of resource URLs to the member virtual machines
- // serving this pool. They must live in zones contained in the same
- // region as this pool.
- Instances []string `json:"instances,omitempty"`
-
- // Kind: Type of the resource.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource. Provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // Region: [Output Only] URL of the region where the target pool
- // resides.
- Region string `json:"region,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // SessionAffinity: Sesssion affinity option, must be one of the
- // following values:
- // NONE: Connections from the same client IP may go to any instance in
- // the pool.
- // CLIENT_IP: Connections from the same client IP will go to the same
- // instance in the pool while that instance remains
- // healthy.
- // CLIENT_IP_PROTO: Connections from the same client IP with the same IP
- // protocol will go to the same instance in the pool while that instance
- // remains healthy.
- //
- // Possible values:
- // "CLIENT_IP"
- // "CLIENT_IP_PROTO"
- // "NONE"
- SessionAffinity string `json:"sessionAffinity,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "BackupPool") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetPool) MarshalJSON() ([]byte, error) {
- type noMethod TargetPool
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetPoolAggregatedList struct {
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A map of scoped target pool lists.
- Items map[string]TargetPoolsScopedList `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetPoolAggregatedList) MarshalJSON() ([]byte, error) {
- type noMethod TargetPoolAggregatedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetPoolInstanceHealth struct {
- HealthStatus []*HealthStatus `json:"healthStatus,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "HealthStatus") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetPoolInstanceHealth) MarshalJSON() ([]byte, error) {
- type noMethod TargetPoolInstanceHealth
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetPoolList: Contains a list of TargetPool resources.
-type TargetPoolList struct {
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A list of TargetPool resources.
- Items []*TargetPool `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetPoolList) MarshalJSON() ([]byte, error) {
- type noMethod TargetPoolList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetPoolsAddHealthCheckRequest struct {
- // HealthChecks: Health check URLs to be added to targetPool.
- HealthChecks []*HealthCheckReference `json:"healthChecks,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "HealthChecks") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetPoolsAddHealthCheckRequest) MarshalJSON() ([]byte, error) {
- type noMethod TargetPoolsAddHealthCheckRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetPoolsAddInstanceRequest struct {
- // Instances: URLs of the instances to be added to targetPool.
- Instances []*InstanceReference `json:"instances,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Instances") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetPoolsAddInstanceRequest) MarshalJSON() ([]byte, error) {
- type noMethod TargetPoolsAddInstanceRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetPoolsRemoveHealthCheckRequest struct {
- // HealthChecks: Health check URLs to be removed from targetPool.
- HealthChecks []*HealthCheckReference `json:"healthChecks,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "HealthChecks") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetPoolsRemoveHealthCheckRequest) MarshalJSON() ([]byte, error) {
- type noMethod TargetPoolsRemoveHealthCheckRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetPoolsRemoveInstanceRequest struct {
- // Instances: URLs of the instances to be removed from targetPool.
- Instances []*InstanceReference `json:"instances,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Instances") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetPoolsRemoveInstanceRequest) MarshalJSON() ([]byte, error) {
- type noMethod TargetPoolsRemoveInstanceRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetPoolsScopedList struct {
- // TargetPools: List of target pools contained in this scope.
- TargetPools []*TargetPool `json:"targetPools,omitempty"`
-
- // Warning: Informational warning which replaces the list of addresses
- // when the list is empty.
- Warning *TargetPoolsScopedListWarning `json:"warning,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "TargetPools") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetPoolsScopedList) MarshalJSON() ([]byte, error) {
- type noMethod TargetPoolsScopedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetPoolsScopedListWarning: Informational warning which replaces
-// the list of addresses when the list is empty.
-type TargetPoolsScopedListWarning struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*TargetPoolsScopedListWarningData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetPoolsScopedListWarning) MarshalJSON() ([]byte, error) {
- type noMethod TargetPoolsScopedListWarning
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetPoolsScopedListWarningData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetPoolsScopedListWarningData) MarshalJSON() ([]byte, error) {
- type noMethod TargetPoolsScopedListWarningData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetReference struct {
- Target string `json:"target,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Target") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetReference) MarshalJSON() ([]byte, error) {
- type noMethod TargetReference
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetVpnGateway struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource.
- // Provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // ForwardingRules: [Output Only] A list of URLs to the ForwardingRule
- // resources. ForwardingRules are created using
- // compute.forwardingRules.insert and associated to a VPN gateway.
- ForwardingRules []string `json:"forwardingRules,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of resource. Always compute#targetVpnGateway
- // for target VPN gateways.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // Network: URL of the network to which this VPN gateway is attached.
- // Provided by the client when the VPN gateway is created.
- Network string `json:"network,omitempty"`
-
- // Region: [Output Only] URL of the region where the target VPN gateway
- // resides.
- Region string `json:"region,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Status: [Output Only] The status of the VPN gateway.
- //
- // Possible values:
- // "CREATING"
- // "DELETING"
- // "FAILED"
- // "READY"
- Status string `json:"status,omitempty"`
-
- // Tunnels: [Output Only] A list of URLs to VpnTunnel resources.
- // VpnTunnels are created using compute.vpntunnels.insert and associated
- // to a VPN gateway.
- Tunnels []string `json:"tunnels,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetVpnGateway) MarshalJSON() ([]byte, error) {
- type noMethod TargetVpnGateway
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetVpnGatewayAggregatedList struct {
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A map of scoped target vpn gateway lists.
- Items map[string]TargetVpnGatewaysScopedList `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#targetVpnGateway
- // for target VPN gateways.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetVpnGatewayAggregatedList) MarshalJSON() ([]byte, error) {
- type noMethod TargetVpnGatewayAggregatedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetVpnGatewayList: Contains a list of TargetVpnGateway resources.
-type TargetVpnGatewayList struct {
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of TargetVpnGateway resources.
- Items []*TargetVpnGateway `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#targetVpnGateway
- // for target VPN gateways.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetVpnGatewayList) MarshalJSON() ([]byte, error) {
- type noMethod TargetVpnGatewayList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetVpnGatewaysScopedList struct {
- // TargetVpnGateways: [Output Only] List of target vpn gateways
- // contained in this scope.
- TargetVpnGateways []*TargetVpnGateway `json:"targetVpnGateways,omitempty"`
-
- // Warning: [Output Only] Informational warning which replaces the list
- // of addresses when the list is empty.
- Warning *TargetVpnGatewaysScopedListWarning `json:"warning,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "TargetVpnGateways")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetVpnGatewaysScopedList) MarshalJSON() ([]byte, error) {
- type noMethod TargetVpnGatewaysScopedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetVpnGatewaysScopedListWarning: [Output Only] Informational
-// warning which replaces the list of addresses when the list is empty.
-type TargetVpnGatewaysScopedListWarning struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*TargetVpnGatewaysScopedListWarningData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetVpnGatewaysScopedListWarning) MarshalJSON() ([]byte, error) {
- type noMethod TargetVpnGatewaysScopedListWarning
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetVpnGatewaysScopedListWarningData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetVpnGatewaysScopedListWarningData) MarshalJSON() ([]byte, error) {
- type noMethod TargetVpnGatewaysScopedListWarningData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TestFailure struct {
- ActualService string `json:"actualService,omitempty"`
-
- ExpectedService string `json:"expectedService,omitempty"`
-
- Host string `json:"host,omitempty"`
-
- Path string `json:"path,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ActualService") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TestFailure) MarshalJSON() ([]byte, error) {
- type noMethod TestFailure
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UrlMap: A UrlMap resource. This resource defines the mapping from URL
-// to the BackendService resource, based on the "longest-match" of the
-// URL's host and path.
-type UrlMap struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // DefaultService: The URL of the BackendService resource if none of the
- // hostRules match.
- DefaultService string `json:"defaultService,omitempty"`
-
- // Description: An optional textual description of the resource.
- // Provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Fingerprint: Fingerprint of this resource. A hash of the contents
- // stored in this object. This field is used in optimistic locking. This
- // field will be ignored when inserting a UrlMap. An up-to-date
- // fingerprint must be provided in order to update the UrlMap.
- Fingerprint string `json:"fingerprint,omitempty"`
-
- // HostRules: The list of HostRules to use against the URL.
- HostRules []*HostRule `json:"hostRules,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource. Set by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: Type of the resource.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource. Provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // PathMatchers: The list of named PathMatchers to use against the URL.
- PathMatchers []*PathMatcher `json:"pathMatchers,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Tests: The list of expected URL mappings. Request to update this
- // UrlMap will succeed only all of the test cases pass.
- Tests []*UrlMapTest `json:"tests,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlMap) MarshalJSON() ([]byte, error) {
- type noMethod UrlMap
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UrlMapList: Contains a list of UrlMap resources.
-type UrlMapList struct {
- // Id: [Output Only] Unique identifier for the resource. Set by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A list of UrlMap resources.
- Items []*UrlMap `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlMapList) MarshalJSON() ([]byte, error) {
- type noMethod UrlMapList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UrlMapReference struct {
- UrlMap string `json:"urlMap,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "UrlMap") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlMapReference) MarshalJSON() ([]byte, error) {
- type noMethod UrlMapReference
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UrlMapTest: Message for the expected URL mappings.
-type UrlMapTest struct {
- // Description: Description of this test case.
- Description string `json:"description,omitempty"`
-
- // Host: Host portion of the URL.
- Host string `json:"host,omitempty"`
-
- // Path: Path portion of the URL.
- Path string `json:"path,omitempty"`
-
- // Service: Expected BackendService resource the given URL should be
- // mapped to.
- Service string `json:"service,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Description") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlMapTest) MarshalJSON() ([]byte, error) {
- type noMethod UrlMapTest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UrlMapValidationResult: Message representing the validation result
-// for a UrlMap.
-type UrlMapValidationResult struct {
- LoadErrors []string `json:"loadErrors,omitempty"`
-
- // LoadSucceeded: Whether the given UrlMap can be successfully loaded.
- // If false, 'loadErrors' indicates the reasons.
- LoadSucceeded bool `json:"loadSucceeded,omitempty"`
-
- TestFailures []*TestFailure `json:"testFailures,omitempty"`
-
- // TestPassed: If successfully loaded, this field indicates whether the
- // test passed. If false, 'testFailures's indicate the reason of
- // failure.
- TestPassed bool `json:"testPassed,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "LoadErrors") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlMapValidationResult) MarshalJSON() ([]byte, error) {
- type noMethod UrlMapValidationResult
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UrlMapsValidateRequest struct {
- // Resource: Content of the UrlMap to be validated.
- Resource *UrlMap `json:"resource,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Resource") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlMapsValidateRequest) MarshalJSON() ([]byte, error) {
- type noMethod UrlMapsValidateRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UrlMapsValidateResponse struct {
- Result *UrlMapValidationResult `json:"result,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Result") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlMapsValidateResponse) MarshalJSON() ([]byte, error) {
- type noMethod UrlMapsValidateResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UsageExportLocation: The location in Cloud Storage and naming method
-// of the daily usage report. Contains bucket_name and report_name
-// prefix.
-type UsageExportLocation struct {
- // BucketName: The name of an existing bucket in Cloud Storage where the
- // usage report object is stored. The Google Service Account is granted
- // write access to this bucket. This is just the bucket name, with no
- // gs:// or https://storage.googleapis.com/ in front of it.
- BucketName string `json:"bucketName,omitempty"`
-
- // ReportNamePrefix: An optional prefix for the name of the usage report
- // object stored in bucketName. If not supplied, defaults to usage. The
- // report is stored as a CSV file named
- // report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the
- // usage according to Pacific Time. If you supply a prefix, it should
- // conform to Cloud Storage object naming conventions.
- ReportNamePrefix string `json:"reportNamePrefix,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BucketName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UsageExportLocation) MarshalJSON() ([]byte, error) {
- type noMethod UsageExportLocation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type VpnTunnel struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource.
- // Provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // DetailedStatus: [Output Only] Detailed status message for the VPN
- // tunnel.
- DetailedStatus string `json:"detailedStatus,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // IkeVersion: IKE protocol version to use when establishing the VPN
- // tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2.
- // Default version is 2.
- IkeVersion int64 `json:"ikeVersion,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#vpnTunnel for
- // VPN tunnels.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // PeerIp: IP address of the peer VPN gateway.
- PeerIp string `json:"peerIp,omitempty"`
-
- // Region: [Output Only] URL of the region where the VPN tunnel resides.
- Region string `json:"region,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // SharedSecret: Shared secret used to set the secure session between
- // the GCE VPN gateway and the peer VPN gateway.
- SharedSecret string `json:"sharedSecret,omitempty"`
-
- // SharedSecretHash: Hash of the shared secret.
- SharedSecretHash string `json:"sharedSecretHash,omitempty"`
-
- // Status: [Output Only] The status of the VPN tunnel.
- //
- // Possible values:
- // "AUTHORIZATION_ERROR"
- // "DEPROVISIONING"
- // "ESTABLISHED"
- // "FAILED"
- // "FIRST_HANDSHAKE"
- // "NEGOTIATION_FAILURE"
- // "NETWORK_ERROR"
- // "NO_INCOMING_PACKETS"
- // "PROVISIONING"
- // "REJECTED"
- // "WAITING_FOR_FULL_CONFIG"
- Status string `json:"status,omitempty"`
-
- // TargetVpnGateway: URL of the VPN gateway to which this VPN tunnel is
- // associated. Provided by the client when the VPN tunnel is created.
- TargetVpnGateway string `json:"targetVpnGateway,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VpnTunnel) MarshalJSON() ([]byte, error) {
- type noMethod VpnTunnel
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type VpnTunnelAggregatedList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A map of scoped vpn tunnel lists.
- Items map[string]VpnTunnelsScopedList `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#vpnTunnel for
- // VPN tunnels.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VpnTunnelAggregatedList) MarshalJSON() ([]byte, error) {
- type noMethod VpnTunnelAggregatedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// VpnTunnelList: Contains a list of VpnTunnel resources.
-type VpnTunnelList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of VpnTunnel resources.
- Items []*VpnTunnel `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#vpnTunnel for
- // VPN tunnels.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VpnTunnelList) MarshalJSON() ([]byte, error) {
- type noMethod VpnTunnelList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type VpnTunnelsScopedList struct {
- // VpnTunnels: List of vpn tunnels contained in this scope.
- VpnTunnels []*VpnTunnel `json:"vpnTunnels,omitempty"`
-
- // Warning: Informational warning which replaces the list of addresses
- // when the list is empty.
- Warning *VpnTunnelsScopedListWarning `json:"warning,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "VpnTunnels") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VpnTunnelsScopedList) MarshalJSON() ([]byte, error) {
- type noMethod VpnTunnelsScopedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// VpnTunnelsScopedListWarning: Informational warning which replaces the
-// list of addresses when the list is empty.
-type VpnTunnelsScopedListWarning struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*VpnTunnelsScopedListWarningData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VpnTunnelsScopedListWarning) MarshalJSON() ([]byte, error) {
- type noMethod VpnTunnelsScopedListWarning
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type VpnTunnelsScopedListWarningData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VpnTunnelsScopedListWarningData) MarshalJSON() ([]byte, error) {
- type noMethod VpnTunnelsScopedListWarningData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Zone: A Zone resource.
-type Zone struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Deprecated: [Output Only] The deprecation status associated with this
- // zone.
- Deprecated *DeprecationStatus `json:"deprecated,omitempty"`
-
- // Description: [Output Only] Textual description of the resource.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always kind#zone for zones.
- Kind string `json:"kind,omitempty"`
-
- // MaintenanceWindows: [Output Only] Any scheduled maintenance windows
- // for this zone. When the zone is in a maintenance window, all
- // resources which reside in the zone will be unavailable. For more
- // information, see Maintenance Windows
- MaintenanceWindows []*ZoneMaintenanceWindows `json:"maintenanceWindows,omitempty"`
-
- // Name: [Output Only] Name of the resource.
- Name string `json:"name,omitempty"`
-
- // Region: [Output Only] Full URL reference to the region which hosts
- // the zone.
- Region string `json:"region,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Status: [Output Only] Status of the zone, either UP or DOWN.
- //
- // Possible values:
- // "DOWN"
- // "UP"
- Status string `json:"status,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Zone) MarshalJSON() ([]byte, error) {
- type noMethod Zone
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ZoneMaintenanceWindows struct {
- // BeginTime: [Output Only] Starting time of the maintenance window, in
- // RFC3339 format.
- BeginTime string `json:"beginTime,omitempty"`
-
- // Description: [Output Only] Textual description of the maintenance
- // window.
- Description string `json:"description,omitempty"`
-
- // EndTime: [Output Only] Ending time of the maintenance window, in
- // RFC3339 format.
- EndTime string `json:"endTime,omitempty"`
-
- // Name: [Output Only] Name of the maintenance window.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BeginTime") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ZoneMaintenanceWindows) MarshalJSON() ([]byte, error) {
- type noMethod ZoneMaintenanceWindows
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ZoneList: Contains a list of zone resources.
-type ZoneList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of Zone resources.
- Items []*Zone `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ZoneList) MarshalJSON() ([]byte, error) {
- type noMethod ZoneList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "compute.addresses.aggregatedList":
-
-type AddressesAggregatedListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AggregatedList: Retrieves the list of addresses grouped by scope.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/addresses/aggregatedList
-func (r *AddressesService) AggregatedList(project string) *AddressesAggregatedListCall {
- c := &AddressesAggregatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *AddressesAggregatedListCall) Filter(filter string) *AddressesAggregatedListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *AddressesAggregatedListCall) MaxResults(maxResults int64) *AddressesAggregatedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *AddressesAggregatedListCall) OrderBy(orderBy string) *AddressesAggregatedListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *AddressesAggregatedListCall) PageToken(pageToken string) *AddressesAggregatedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AddressesAggregatedListCall) Fields(s ...googleapi.Field) *AddressesAggregatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AddressesAggregatedListCall) IfNoneMatch(entityTag string) *AddressesAggregatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AddressesAggregatedListCall) Context(ctx context.Context) *AddressesAggregatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AddressesAggregatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/aggregated/addresses")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.addresses.aggregatedList" call.
-// Exactly one of *AddressAggregatedList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AddressAggregatedList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AddressesAggregatedListCall) Do() (*AddressAggregatedList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AddressAggregatedList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of addresses grouped by scope.",
- // "httpMethod": "GET",
- // "id": "compute.addresses.aggregatedList",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/aggregated/addresses",
- // "response": {
- // "$ref": "AddressAggregatedList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.addresses.delete":
-
-type AddressesDeleteCall struct {
- s *Service
- project string
- region string
- address string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified address resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/addresses/delete
-func (r *AddressesService) Delete(project string, region string, address string) *AddressesDeleteCall {
- c := &AddressesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.address = address
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AddressesDeleteCall) Fields(s ...googleapi.Field) *AddressesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AddressesDeleteCall) Context(ctx context.Context) *AddressesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AddressesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/addresses/{address}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "address": c.address,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.addresses.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AddressesDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified address resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.addresses.delete",
- // "parameterOrder": [
- // "project",
- // "region",
- // "address"
- // ],
- // "parameters": {
- // "address": {
- // "description": "Name of the address resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "The name of the region for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/addresses/{address}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.addresses.get":
-
-type AddressesGetCall struct {
- s *Service
- project string
- region string
- address string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified address resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/addresses/get
-func (r *AddressesService) Get(project string, region string, address string) *AddressesGetCall {
- c := &AddressesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.address = address
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AddressesGetCall) Fields(s ...googleapi.Field) *AddressesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AddressesGetCall) IfNoneMatch(entityTag string) *AddressesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AddressesGetCall) Context(ctx context.Context) *AddressesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AddressesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/addresses/{address}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "address": c.address,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.addresses.get" call.
-// Exactly one of *Address or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Address.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AddressesGetCall) Do() (*Address, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Address{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified address resource.",
- // "httpMethod": "GET",
- // "id": "compute.addresses.get",
- // "parameterOrder": [
- // "project",
- // "region",
- // "address"
- // ],
- // "parameters": {
- // "address": {
- // "description": "Name of the address resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "The name of the region for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/addresses/{address}",
- // "response": {
- // "$ref": "Address"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.addresses.insert":
-
-type AddressesInsertCall struct {
- s *Service
- project string
- region string
- address *Address
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates an address resource in the specified project using
-// the data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/addresses/insert
-func (r *AddressesService) Insert(project string, region string, address *Address) *AddressesInsertCall {
- c := &AddressesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.address = address
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AddressesInsertCall) Fields(s ...googleapi.Field) *AddressesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AddressesInsertCall) Context(ctx context.Context) *AddressesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AddressesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.address)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/addresses")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.addresses.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AddressesInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates an address resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.addresses.insert",
- // "parameterOrder": [
- // "project",
- // "region"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "The name of the region for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/addresses",
- // "request": {
- // "$ref": "Address"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.addresses.list":
-
-type AddressesListCall struct {
- s *Service
- project string
- region string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of address resources contained within the
-// specified region.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/addresses/list
-func (r *AddressesService) List(project string, region string) *AddressesListCall {
- c := &AddressesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *AddressesListCall) Filter(filter string) *AddressesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *AddressesListCall) MaxResults(maxResults int64) *AddressesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *AddressesListCall) OrderBy(orderBy string) *AddressesListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *AddressesListCall) PageToken(pageToken string) *AddressesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AddressesListCall) Fields(s ...googleapi.Field) *AddressesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AddressesListCall) IfNoneMatch(entityTag string) *AddressesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AddressesListCall) Context(ctx context.Context) *AddressesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AddressesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/addresses")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.addresses.list" call.
-// Exactly one of *AddressList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AddressList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AddressesListCall) Do() (*AddressList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AddressList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of address resources contained within the specified region.",
- // "httpMethod": "GET",
- // "id": "compute.addresses.list",
- // "parameterOrder": [
- // "project",
- // "region"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "The name of the region for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/addresses",
- // "response": {
- // "$ref": "AddressList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.autoscalers.aggregatedList":
-
-type AutoscalersAggregatedListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AggregatedList: Retrieves the list of autoscalers grouped by scope.
-func (r *AutoscalersService) AggregatedList(project string) *AutoscalersAggregatedListCall {
- c := &AutoscalersAggregatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *AutoscalersAggregatedListCall) Filter(filter string) *AutoscalersAggregatedListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *AutoscalersAggregatedListCall) MaxResults(maxResults int64) *AutoscalersAggregatedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *AutoscalersAggregatedListCall) OrderBy(orderBy string) *AutoscalersAggregatedListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *AutoscalersAggregatedListCall) PageToken(pageToken string) *AutoscalersAggregatedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AutoscalersAggregatedListCall) Fields(s ...googleapi.Field) *AutoscalersAggregatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AutoscalersAggregatedListCall) IfNoneMatch(entityTag string) *AutoscalersAggregatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AutoscalersAggregatedListCall) Context(ctx context.Context) *AutoscalersAggregatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AutoscalersAggregatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/aggregated/autoscalers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.autoscalers.aggregatedList" call.
-// Exactly one of *AutoscalerAggregatedList or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *AutoscalerAggregatedList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AutoscalersAggregatedListCall) Do() (*AutoscalerAggregatedList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AutoscalerAggregatedList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of autoscalers grouped by scope.",
- // "httpMethod": "GET",
- // "id": "compute.autoscalers.aggregatedList",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/aggregated/autoscalers",
- // "response": {
- // "$ref": "AutoscalerAggregatedList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.autoscalers.delete":
-
-type AutoscalersDeleteCall struct {
- s *Service
- project string
- zone string
- autoscaler string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified autoscaler resource.
-func (r *AutoscalersService) Delete(project string, zone string, autoscaler string) *AutoscalersDeleteCall {
- c := &AutoscalersDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.autoscaler = autoscaler
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AutoscalersDeleteCall) Fields(s ...googleapi.Field) *AutoscalersDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AutoscalersDeleteCall) Context(ctx context.Context) *AutoscalersDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AutoscalersDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/autoscalers/{autoscaler}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "autoscaler": c.autoscaler,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.autoscalers.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AutoscalersDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified autoscaler resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.autoscalers.delete",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "autoscaler"
- // ],
- // "parameters": {
- // "autoscaler": {
- // "description": "Name of the persistent autoscaler resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/autoscalers/{autoscaler}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.autoscalers.get":
-
-type AutoscalersGetCall struct {
- s *Service
- project string
- zone string
- autoscaler string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified autoscaler resource.
-func (r *AutoscalersService) Get(project string, zone string, autoscaler string) *AutoscalersGetCall {
- c := &AutoscalersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.autoscaler = autoscaler
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AutoscalersGetCall) Fields(s ...googleapi.Field) *AutoscalersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AutoscalersGetCall) IfNoneMatch(entityTag string) *AutoscalersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AutoscalersGetCall) Context(ctx context.Context) *AutoscalersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AutoscalersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/autoscalers/{autoscaler}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "autoscaler": c.autoscaler,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.autoscalers.get" call.
-// Exactly one of *Autoscaler or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Autoscaler.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AutoscalersGetCall) Do() (*Autoscaler, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Autoscaler{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified autoscaler resource.",
- // "httpMethod": "GET",
- // "id": "compute.autoscalers.get",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "autoscaler"
- // ],
- // "parameters": {
- // "autoscaler": {
- // "description": "Name of the persistent autoscaler resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/autoscalers/{autoscaler}",
- // "response": {
- // "$ref": "Autoscaler"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.autoscalers.insert":
-
-type AutoscalersInsertCall struct {
- s *Service
- project string
- zone string
- autoscaler *Autoscaler
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates an autoscaler resource in the specified project using
-// the data included in the request.
-func (r *AutoscalersService) Insert(project string, zone string, autoscaler *Autoscaler) *AutoscalersInsertCall {
- c := &AutoscalersInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.autoscaler = autoscaler
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AutoscalersInsertCall) Fields(s ...googleapi.Field) *AutoscalersInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AutoscalersInsertCall) Context(ctx context.Context) *AutoscalersInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AutoscalersInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.autoscaler)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/autoscalers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.autoscalers.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AutoscalersInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates an autoscaler resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.autoscalers.insert",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/autoscalers",
- // "request": {
- // "$ref": "Autoscaler"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.autoscalers.list":
-
-type AutoscalersListCall struct {
- s *Service
- project string
- zone string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of autoscaler resources contained within the
-// specified zone.
-func (r *AutoscalersService) List(project string, zone string) *AutoscalersListCall {
- c := &AutoscalersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *AutoscalersListCall) Filter(filter string) *AutoscalersListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *AutoscalersListCall) MaxResults(maxResults int64) *AutoscalersListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *AutoscalersListCall) OrderBy(orderBy string) *AutoscalersListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *AutoscalersListCall) PageToken(pageToken string) *AutoscalersListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AutoscalersListCall) Fields(s ...googleapi.Field) *AutoscalersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AutoscalersListCall) IfNoneMatch(entityTag string) *AutoscalersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AutoscalersListCall) Context(ctx context.Context) *AutoscalersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AutoscalersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/autoscalers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.autoscalers.list" call.
-// Exactly one of *AutoscalerList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AutoscalerList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AutoscalersListCall) Do() (*AutoscalerList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AutoscalerList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of autoscaler resources contained within the specified zone.",
- // "httpMethod": "GET",
- // "id": "compute.autoscalers.list",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/autoscalers",
- // "response": {
- // "$ref": "AutoscalerList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.autoscalers.patch":
-
-type AutoscalersPatchCall struct {
- s *Service
- project string
- zone string
- autoscaler string
- autoscaler2 *Autoscaler
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an autoscaler resource in the specified project using
-// the data included in the request. This method supports patch
-// semantics.
-func (r *AutoscalersService) Patch(project string, zone string, autoscaler string, autoscaler2 *Autoscaler) *AutoscalersPatchCall {
- c := &AutoscalersPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.autoscaler = autoscaler
- c.autoscaler2 = autoscaler2
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AutoscalersPatchCall) Fields(s ...googleapi.Field) *AutoscalersPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AutoscalersPatchCall) Context(ctx context.Context) *AutoscalersPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AutoscalersPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.autoscaler2)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("autoscaler", fmt.Sprintf("%v", c.autoscaler))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/autoscalers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.autoscalers.patch" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AutoscalersPatchCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an autoscaler resource in the specified project using the data included in the request. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "compute.autoscalers.patch",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "autoscaler"
- // ],
- // "parameters": {
- // "autoscaler": {
- // "description": "Name of the autoscaler resource to update.",
- // "location": "query",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/autoscalers",
- // "request": {
- // "$ref": "Autoscaler"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.autoscalers.update":
-
-type AutoscalersUpdateCall struct {
- s *Service
- project string
- zone string
- autoscaler *Autoscaler
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an autoscaler resource in the specified project using
-// the data included in the request.
-func (r *AutoscalersService) Update(project string, zone string, autoscaler *Autoscaler) *AutoscalersUpdateCall {
- c := &AutoscalersUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.autoscaler = autoscaler
- return c
-}
-
-// Autoscaler sets the optional parameter "autoscaler": Name of the
-// autoscaler resource to update.
-func (c *AutoscalersUpdateCall) Autoscaler(autoscaler string) *AutoscalersUpdateCall {
- c.opt_["autoscaler"] = autoscaler
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AutoscalersUpdateCall) Fields(s ...googleapi.Field) *AutoscalersUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AutoscalersUpdateCall) Context(ctx context.Context) *AutoscalersUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AutoscalersUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.autoscaler)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["autoscaler"]; ok {
- params.Set("autoscaler", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/autoscalers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.autoscalers.update" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AutoscalersUpdateCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an autoscaler resource in the specified project using the data included in the request.",
- // "httpMethod": "PUT",
- // "id": "compute.autoscalers.update",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "autoscaler": {
- // "description": "Name of the autoscaler resource to update.",
- // "location": "query",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/autoscalers",
- // "request": {
- // "$ref": "Autoscaler"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.backendServices.delete":
-
-type BackendServicesDeleteCall struct {
- s *Service
- project string
- backendService string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified BackendService resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/backendServices/delete
-func (r *BackendServicesService) Delete(project string, backendService string) *BackendServicesDeleteCall {
- c := &BackendServicesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.backendService = backendService
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BackendServicesDeleteCall) Fields(s ...googleapi.Field) *BackendServicesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BackendServicesDeleteCall) Context(ctx context.Context) *BackendServicesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BackendServicesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/backendServices/{backendService}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "backendService": c.backendService,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.backendServices.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *BackendServicesDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified BackendService resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.backendServices.delete",
- // "parameterOrder": [
- // "project",
- // "backendService"
- // ],
- // "parameters": {
- // "backendService": {
- // "description": "Name of the BackendService resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/backendServices/{backendService}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.backendServices.get":
-
-type BackendServicesGetCall struct {
- s *Service
- project string
- backendService string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified BackendService resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/backendServices/get
-func (r *BackendServicesService) Get(project string, backendService string) *BackendServicesGetCall {
- c := &BackendServicesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.backendService = backendService
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BackendServicesGetCall) Fields(s ...googleapi.Field) *BackendServicesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *BackendServicesGetCall) IfNoneMatch(entityTag string) *BackendServicesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BackendServicesGetCall) Context(ctx context.Context) *BackendServicesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BackendServicesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/backendServices/{backendService}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "backendService": c.backendService,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.backendServices.get" call.
-// Exactly one of *BackendService or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *BackendService.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *BackendServicesGetCall) Do() (*BackendService, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &BackendService{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified BackendService resource.",
- // "httpMethod": "GET",
- // "id": "compute.backendServices.get",
- // "parameterOrder": [
- // "project",
- // "backendService"
- // ],
- // "parameters": {
- // "backendService": {
- // "description": "Name of the BackendService resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/backendServices/{backendService}",
- // "response": {
- // "$ref": "BackendService"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.backendServices.getHealth":
-
-type BackendServicesGetHealthCall struct {
- s *Service
- project string
- backendService string
- resourcegroupreference *ResourceGroupReference
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetHealth: Gets the most recent health check results for this
-// BackendService.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/backendServices/getHealth
-func (r *BackendServicesService) GetHealth(project string, backendService string, resourcegroupreference *ResourceGroupReference) *BackendServicesGetHealthCall {
- c := &BackendServicesGetHealthCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.backendService = backendService
- c.resourcegroupreference = resourcegroupreference
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BackendServicesGetHealthCall) Fields(s ...googleapi.Field) *BackendServicesGetHealthCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BackendServicesGetHealthCall) Context(ctx context.Context) *BackendServicesGetHealthCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BackendServicesGetHealthCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.resourcegroupreference)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/backendServices/{backendService}/getHealth")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "backendService": c.backendService,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.backendServices.getHealth" call.
-// Exactly one of *BackendServiceGroupHealth or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *BackendServiceGroupHealth.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *BackendServicesGetHealthCall) Do() (*BackendServiceGroupHealth, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &BackendServiceGroupHealth{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the most recent health check results for this BackendService.",
- // "httpMethod": "POST",
- // "id": "compute.backendServices.getHealth",
- // "parameterOrder": [
- // "project",
- // "backendService"
- // ],
- // "parameters": {
- // "backendService": {
- // "description": "Name of the BackendService resource to which the queried instance belongs.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/backendServices/{backendService}/getHealth",
- // "request": {
- // "$ref": "ResourceGroupReference"
- // },
- // "response": {
- // "$ref": "BackendServiceGroupHealth"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.backendServices.insert":
-
-type BackendServicesInsertCall struct {
- s *Service
- project string
- backendservice *BackendService
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a BackendService resource in the specified project
-// using the data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/backendServices/insert
-func (r *BackendServicesService) Insert(project string, backendservice *BackendService) *BackendServicesInsertCall {
- c := &BackendServicesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.backendservice = backendservice
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BackendServicesInsertCall) Fields(s ...googleapi.Field) *BackendServicesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BackendServicesInsertCall) Context(ctx context.Context) *BackendServicesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BackendServicesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.backendservice)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/backendServices")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.backendServices.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *BackendServicesInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a BackendService resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.backendServices.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/backendServices",
- // "request": {
- // "$ref": "BackendService"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.backendServices.list":
-
-type BackendServicesListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of BackendService resources available to the
-// specified project.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/backendServices/list
-func (r *BackendServicesService) List(project string) *BackendServicesListCall {
- c := &BackendServicesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *BackendServicesListCall) Filter(filter string) *BackendServicesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *BackendServicesListCall) MaxResults(maxResults int64) *BackendServicesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *BackendServicesListCall) OrderBy(orderBy string) *BackendServicesListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *BackendServicesListCall) PageToken(pageToken string) *BackendServicesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BackendServicesListCall) Fields(s ...googleapi.Field) *BackendServicesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *BackendServicesListCall) IfNoneMatch(entityTag string) *BackendServicesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BackendServicesListCall) Context(ctx context.Context) *BackendServicesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BackendServicesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/backendServices")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.backendServices.list" call.
-// Exactly one of *BackendServiceList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *BackendServiceList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *BackendServicesListCall) Do() (*BackendServiceList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &BackendServiceList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of BackendService resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.backendServices.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/backendServices",
- // "response": {
- // "$ref": "BackendServiceList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.backendServices.patch":
-
-type BackendServicesPatchCall struct {
- s *Service
- project string
- backendService string
- backendservice *BackendService
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Update the entire content of the BackendService resource. This
-// method supports patch semantics.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/backendServices/patch
-func (r *BackendServicesService) Patch(project string, backendService string, backendservice *BackendService) *BackendServicesPatchCall {
- c := &BackendServicesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.backendService = backendService
- c.backendservice = backendservice
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BackendServicesPatchCall) Fields(s ...googleapi.Field) *BackendServicesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BackendServicesPatchCall) Context(ctx context.Context) *BackendServicesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BackendServicesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.backendservice)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/backendServices/{backendService}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "backendService": c.backendService,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.backendServices.patch" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *BackendServicesPatchCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update the entire content of the BackendService resource. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "compute.backendServices.patch",
- // "parameterOrder": [
- // "project",
- // "backendService"
- // ],
- // "parameters": {
- // "backendService": {
- // "description": "Name of the BackendService resource to update.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/backendServices/{backendService}",
- // "request": {
- // "$ref": "BackendService"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.backendServices.update":
-
-type BackendServicesUpdateCall struct {
- s *Service
- project string
- backendService string
- backendservice *BackendService
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Update the entire content of the BackendService resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/backendServices/update
-func (r *BackendServicesService) Update(project string, backendService string, backendservice *BackendService) *BackendServicesUpdateCall {
- c := &BackendServicesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.backendService = backendService
- c.backendservice = backendservice
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BackendServicesUpdateCall) Fields(s ...googleapi.Field) *BackendServicesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BackendServicesUpdateCall) Context(ctx context.Context) *BackendServicesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BackendServicesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.backendservice)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/backendServices/{backendService}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "backendService": c.backendService,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.backendServices.update" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *BackendServicesUpdateCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update the entire content of the BackendService resource.",
- // "httpMethod": "PUT",
- // "id": "compute.backendServices.update",
- // "parameterOrder": [
- // "project",
- // "backendService"
- // ],
- // "parameters": {
- // "backendService": {
- // "description": "Name of the BackendService resource to update.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/backendServices/{backendService}",
- // "request": {
- // "$ref": "BackendService"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.diskTypes.aggregatedList":
-
-type DiskTypesAggregatedListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AggregatedList: Retrieves the list of disk type resources grouped by
-// scope.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/diskTypes/aggregatedList
-func (r *DiskTypesService) AggregatedList(project string) *DiskTypesAggregatedListCall {
- c := &DiskTypesAggregatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *DiskTypesAggregatedListCall) Filter(filter string) *DiskTypesAggregatedListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *DiskTypesAggregatedListCall) MaxResults(maxResults int64) *DiskTypesAggregatedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *DiskTypesAggregatedListCall) OrderBy(orderBy string) *DiskTypesAggregatedListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *DiskTypesAggregatedListCall) PageToken(pageToken string) *DiskTypesAggregatedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DiskTypesAggregatedListCall) Fields(s ...googleapi.Field) *DiskTypesAggregatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DiskTypesAggregatedListCall) IfNoneMatch(entityTag string) *DiskTypesAggregatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DiskTypesAggregatedListCall) Context(ctx context.Context) *DiskTypesAggregatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DiskTypesAggregatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/aggregated/diskTypes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.diskTypes.aggregatedList" call.
-// Exactly one of *DiskTypeAggregatedList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *DiskTypeAggregatedList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DiskTypesAggregatedListCall) Do() (*DiskTypeAggregatedList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DiskTypeAggregatedList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of disk type resources grouped by scope.",
- // "httpMethod": "GET",
- // "id": "compute.diskTypes.aggregatedList",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/aggregated/diskTypes",
- // "response": {
- // "$ref": "DiskTypeAggregatedList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.diskTypes.get":
-
-type DiskTypesGetCall struct {
- s *Service
- project string
- zone string
- diskType string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified disk type resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/diskTypes/get
-func (r *DiskTypesService) Get(project string, zone string, diskType string) *DiskTypesGetCall {
- c := &DiskTypesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.diskType = diskType
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DiskTypesGetCall) Fields(s ...googleapi.Field) *DiskTypesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DiskTypesGetCall) IfNoneMatch(entityTag string) *DiskTypesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DiskTypesGetCall) Context(ctx context.Context) *DiskTypesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DiskTypesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/diskTypes/{diskType}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "diskType": c.diskType,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.diskTypes.get" call.
-// Exactly one of *DiskType or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *DiskType.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DiskTypesGetCall) Do() (*DiskType, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DiskType{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified disk type resource.",
- // "httpMethod": "GET",
- // "id": "compute.diskTypes.get",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "diskType"
- // ],
- // "parameters": {
- // "diskType": {
- // "description": "Name of the disk type resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/diskTypes/{diskType}",
- // "response": {
- // "$ref": "DiskType"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.diskTypes.list":
-
-type DiskTypesListCall struct {
- s *Service
- project string
- zone string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of disk type resources available to the
-// specified project.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/diskTypes/list
-func (r *DiskTypesService) List(project string, zone string) *DiskTypesListCall {
- c := &DiskTypesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *DiskTypesListCall) Filter(filter string) *DiskTypesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *DiskTypesListCall) MaxResults(maxResults int64) *DiskTypesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *DiskTypesListCall) OrderBy(orderBy string) *DiskTypesListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *DiskTypesListCall) PageToken(pageToken string) *DiskTypesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DiskTypesListCall) Fields(s ...googleapi.Field) *DiskTypesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DiskTypesListCall) IfNoneMatch(entityTag string) *DiskTypesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DiskTypesListCall) Context(ctx context.Context) *DiskTypesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DiskTypesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/diskTypes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.diskTypes.list" call.
-// Exactly one of *DiskTypeList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *DiskTypeList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DiskTypesListCall) Do() (*DiskTypeList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DiskTypeList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of disk type resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.diskTypes.list",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/diskTypes",
- // "response": {
- // "$ref": "DiskTypeList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.disks.aggregatedList":
-
-type DisksAggregatedListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AggregatedList: Retrieves the list of disks grouped by scope.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/disks/aggregatedList
-func (r *DisksService) AggregatedList(project string) *DisksAggregatedListCall {
- c := &DisksAggregatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *DisksAggregatedListCall) Filter(filter string) *DisksAggregatedListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *DisksAggregatedListCall) MaxResults(maxResults int64) *DisksAggregatedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *DisksAggregatedListCall) OrderBy(orderBy string) *DisksAggregatedListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *DisksAggregatedListCall) PageToken(pageToken string) *DisksAggregatedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DisksAggregatedListCall) Fields(s ...googleapi.Field) *DisksAggregatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DisksAggregatedListCall) IfNoneMatch(entityTag string) *DisksAggregatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DisksAggregatedListCall) Context(ctx context.Context) *DisksAggregatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DisksAggregatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/aggregated/disks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.disks.aggregatedList" call.
-// Exactly one of *DiskAggregatedList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *DiskAggregatedList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DisksAggregatedListCall) Do() (*DiskAggregatedList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DiskAggregatedList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of disks grouped by scope.",
- // "httpMethod": "GET",
- // "id": "compute.disks.aggregatedList",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/aggregated/disks",
- // "response": {
- // "$ref": "DiskAggregatedList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.disks.createSnapshot":
-
-type DisksCreateSnapshotCall struct {
- s *Service
- project string
- zone string
- disk string
- snapshot *Snapshot
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// CreateSnapshot: Creates a snapshot of this disk.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/disks/createSnapshot
-func (r *DisksService) CreateSnapshot(project string, zone string, disk string, snapshot *Snapshot) *DisksCreateSnapshotCall {
- c := &DisksCreateSnapshotCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.disk = disk
- c.snapshot = snapshot
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DisksCreateSnapshotCall) Fields(s ...googleapi.Field) *DisksCreateSnapshotCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DisksCreateSnapshotCall) Context(ctx context.Context) *DisksCreateSnapshotCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DisksCreateSnapshotCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.snapshot)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/disks/{disk}/createSnapshot")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "disk": c.disk,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.disks.createSnapshot" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DisksCreateSnapshotCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a snapshot of this disk.",
- // "httpMethod": "POST",
- // "id": "compute.disks.createSnapshot",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "disk"
- // ],
- // "parameters": {
- // "disk": {
- // "description": "Name of the persistent disk to snapshot.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/disks/{disk}/createSnapshot",
- // "request": {
- // "$ref": "Snapshot"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.disks.delete":
-
-type DisksDeleteCall struct {
- s *Service
- project string
- zone string
- disk string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified persistent disk. Deleting a disk
-// removes its data permanently and is irreversible. However, deleting a
-// disk does not delete any snapshots previously made from the disk. You
-// must separately delete snapshots.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/disks/delete
-func (r *DisksService) Delete(project string, zone string, disk string) *DisksDeleteCall {
- c := &DisksDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.disk = disk
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DisksDeleteCall) Fields(s ...googleapi.Field) *DisksDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DisksDeleteCall) Context(ctx context.Context) *DisksDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DisksDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/disks/{disk}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "disk": c.disk,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.disks.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DisksDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.",
- // "httpMethod": "DELETE",
- // "id": "compute.disks.delete",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "disk"
- // ],
- // "parameters": {
- // "disk": {
- // "description": "Name of the persistent disk to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/disks/{disk}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.disks.get":
-
-type DisksGetCall struct {
- s *Service
- project string
- zone string
- disk string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns a specified persistent disk.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/disks/get
-func (r *DisksService) Get(project string, zone string, disk string) *DisksGetCall {
- c := &DisksGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.disk = disk
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DisksGetCall) Fields(s ...googleapi.Field) *DisksGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DisksGetCall) IfNoneMatch(entityTag string) *DisksGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DisksGetCall) Context(ctx context.Context) *DisksGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DisksGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/disks/{disk}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "disk": c.disk,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.disks.get" call.
-// Exactly one of *Disk or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Disk.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *DisksGetCall) Do() (*Disk, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Disk{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns a specified persistent disk.",
- // "httpMethod": "GET",
- // "id": "compute.disks.get",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "disk"
- // ],
- // "parameters": {
- // "disk": {
- // "description": "Name of the persistent disk to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/disks/{disk}",
- // "response": {
- // "$ref": "Disk"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.disks.insert":
-
-type DisksInsertCall struct {
- s *Service
- project string
- zone string
- disk *Disk
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a persistent disk in the specified project using the
-// data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/disks/insert
-func (r *DisksService) Insert(project string, zone string, disk *Disk) *DisksInsertCall {
- c := &DisksInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.disk = disk
- return c
-}
-
-// SourceImage sets the optional parameter "sourceImage": Source image
-// to restore onto a disk.
-func (c *DisksInsertCall) SourceImage(sourceImage string) *DisksInsertCall {
- c.opt_["sourceImage"] = sourceImage
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DisksInsertCall) Fields(s ...googleapi.Field) *DisksInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DisksInsertCall) Context(ctx context.Context) *DisksInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DisksInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.disk)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["sourceImage"]; ok {
- params.Set("sourceImage", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/disks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.disks.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DisksInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a persistent disk in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.disks.insert",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "sourceImage": {
- // "description": "Optional. Source image to restore onto a disk.",
- // "location": "query",
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/disks",
- // "request": {
- // "$ref": "Disk"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.disks.list":
-
-type DisksListCall struct {
- s *Service
- project string
- zone string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of persistent disks contained within the
-// specified zone.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/disks/list
-func (r *DisksService) List(project string, zone string) *DisksListCall {
- c := &DisksListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *DisksListCall) Filter(filter string) *DisksListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *DisksListCall) MaxResults(maxResults int64) *DisksListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *DisksListCall) OrderBy(orderBy string) *DisksListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *DisksListCall) PageToken(pageToken string) *DisksListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DisksListCall) Fields(s ...googleapi.Field) *DisksListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DisksListCall) IfNoneMatch(entityTag string) *DisksListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DisksListCall) Context(ctx context.Context) *DisksListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DisksListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/disks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.disks.list" call.
-// Exactly one of *DiskList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *DiskList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DisksListCall) Do() (*DiskList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DiskList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of persistent disks contained within the specified zone.",
- // "httpMethod": "GET",
- // "id": "compute.disks.list",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/disks",
- // "response": {
- // "$ref": "DiskList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.firewalls.delete":
-
-type FirewallsDeleteCall struct {
- s *Service
- project string
- firewall string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified firewall resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/firewalls/delete
-func (r *FirewallsService) Delete(project string, firewall string) *FirewallsDeleteCall {
- c := &FirewallsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.firewall = firewall
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FirewallsDeleteCall) Fields(s ...googleapi.Field) *FirewallsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FirewallsDeleteCall) Context(ctx context.Context) *FirewallsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FirewallsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/firewalls/{firewall}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "firewall": c.firewall,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.firewalls.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *FirewallsDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified firewall resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.firewalls.delete",
- // "parameterOrder": [
- // "project",
- // "firewall"
- // ],
- // "parameters": {
- // "firewall": {
- // "description": "Name of the firewall resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/firewalls/{firewall}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.firewalls.get":
-
-type FirewallsGetCall struct {
- s *Service
- project string
- firewall string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified firewall resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/firewalls/get
-func (r *FirewallsService) Get(project string, firewall string) *FirewallsGetCall {
- c := &FirewallsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.firewall = firewall
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FirewallsGetCall) Fields(s ...googleapi.Field) *FirewallsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *FirewallsGetCall) IfNoneMatch(entityTag string) *FirewallsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FirewallsGetCall) Context(ctx context.Context) *FirewallsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FirewallsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/firewalls/{firewall}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "firewall": c.firewall,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.firewalls.get" call.
-// Exactly one of *Firewall or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Firewall.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *FirewallsGetCall) Do() (*Firewall, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Firewall{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified firewall resource.",
- // "httpMethod": "GET",
- // "id": "compute.firewalls.get",
- // "parameterOrder": [
- // "project",
- // "firewall"
- // ],
- // "parameters": {
- // "firewall": {
- // "description": "Name of the firewall resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/firewalls/{firewall}",
- // "response": {
- // "$ref": "Firewall"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.firewalls.insert":
-
-type FirewallsInsertCall struct {
- s *Service
- project string
- firewall *Firewall
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a firewall resource in the specified project using
-// the data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/firewalls/insert
-func (r *FirewallsService) Insert(project string, firewall *Firewall) *FirewallsInsertCall {
- c := &FirewallsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.firewall = firewall
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FirewallsInsertCall) Fields(s ...googleapi.Field) *FirewallsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FirewallsInsertCall) Context(ctx context.Context) *FirewallsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FirewallsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.firewall)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/firewalls")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.firewalls.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *FirewallsInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a firewall resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.firewalls.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/firewalls",
- // "request": {
- // "$ref": "Firewall"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.firewalls.list":
-
-type FirewallsListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of firewall resources available to the
-// specified project.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/firewalls/list
-func (r *FirewallsService) List(project string) *FirewallsListCall {
- c := &FirewallsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *FirewallsListCall) Filter(filter string) *FirewallsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *FirewallsListCall) MaxResults(maxResults int64) *FirewallsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *FirewallsListCall) OrderBy(orderBy string) *FirewallsListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *FirewallsListCall) PageToken(pageToken string) *FirewallsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FirewallsListCall) Fields(s ...googleapi.Field) *FirewallsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *FirewallsListCall) IfNoneMatch(entityTag string) *FirewallsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FirewallsListCall) Context(ctx context.Context) *FirewallsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FirewallsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/firewalls")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.firewalls.list" call.
-// Exactly one of *FirewallList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *FirewallList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *FirewallsListCall) Do() (*FirewallList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FirewallList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of firewall resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.firewalls.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/firewalls",
- // "response": {
- // "$ref": "FirewallList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.firewalls.patch":
-
-type FirewallsPatchCall struct {
- s *Service
- project string
- firewall string
- firewall2 *Firewall
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates the specified firewall resource with the data included
-// in the request. This method supports patch semantics.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/firewalls/patch
-func (r *FirewallsService) Patch(project string, firewall string, firewall2 *Firewall) *FirewallsPatchCall {
- c := &FirewallsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.firewall = firewall
- c.firewall2 = firewall2
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FirewallsPatchCall) Fields(s ...googleapi.Field) *FirewallsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FirewallsPatchCall) Context(ctx context.Context) *FirewallsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FirewallsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.firewall2)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/firewalls/{firewall}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "firewall": c.firewall,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.firewalls.patch" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *FirewallsPatchCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates the specified firewall resource with the data included in the request. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "compute.firewalls.patch",
- // "parameterOrder": [
- // "project",
- // "firewall"
- // ],
- // "parameters": {
- // "firewall": {
- // "description": "Name of the firewall resource to update.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/firewalls/{firewall}",
- // "request": {
- // "$ref": "Firewall"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.firewalls.update":
-
-type FirewallsUpdateCall struct {
- s *Service
- project string
- firewall string
- firewall2 *Firewall
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates the specified firewall resource with the data
-// included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/firewalls/update
-func (r *FirewallsService) Update(project string, firewall string, firewall2 *Firewall) *FirewallsUpdateCall {
- c := &FirewallsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.firewall = firewall
- c.firewall2 = firewall2
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FirewallsUpdateCall) Fields(s ...googleapi.Field) *FirewallsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FirewallsUpdateCall) Context(ctx context.Context) *FirewallsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FirewallsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.firewall2)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/firewalls/{firewall}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "firewall": c.firewall,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.firewalls.update" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *FirewallsUpdateCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates the specified firewall resource with the data included in the request.",
- // "httpMethod": "PUT",
- // "id": "compute.firewalls.update",
- // "parameterOrder": [
- // "project",
- // "firewall"
- // ],
- // "parameters": {
- // "firewall": {
- // "description": "Name of the firewall resource to update.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/firewalls/{firewall}",
- // "request": {
- // "$ref": "Firewall"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.forwardingRules.aggregatedList":
-
-type ForwardingRulesAggregatedListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AggregatedList: Retrieves the list of forwarding rules grouped by
-// scope.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/forwardingRules/aggregatedList
-func (r *ForwardingRulesService) AggregatedList(project string) *ForwardingRulesAggregatedListCall {
- c := &ForwardingRulesAggregatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *ForwardingRulesAggregatedListCall) Filter(filter string) *ForwardingRulesAggregatedListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *ForwardingRulesAggregatedListCall) MaxResults(maxResults int64) *ForwardingRulesAggregatedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *ForwardingRulesAggregatedListCall) OrderBy(orderBy string) *ForwardingRulesAggregatedListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *ForwardingRulesAggregatedListCall) PageToken(pageToken string) *ForwardingRulesAggregatedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ForwardingRulesAggregatedListCall) Fields(s ...googleapi.Field) *ForwardingRulesAggregatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ForwardingRulesAggregatedListCall) IfNoneMatch(entityTag string) *ForwardingRulesAggregatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ForwardingRulesAggregatedListCall) Context(ctx context.Context) *ForwardingRulesAggregatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ForwardingRulesAggregatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/aggregated/forwardingRules")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.forwardingRules.aggregatedList" call.
-// Exactly one of *ForwardingRuleAggregatedList or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *ForwardingRuleAggregatedList.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ForwardingRulesAggregatedListCall) Do() (*ForwardingRuleAggregatedList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ForwardingRuleAggregatedList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of forwarding rules grouped by scope.",
- // "httpMethod": "GET",
- // "id": "compute.forwardingRules.aggregatedList",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/aggregated/forwardingRules",
- // "response": {
- // "$ref": "ForwardingRuleAggregatedList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.forwardingRules.delete":
-
-type ForwardingRulesDeleteCall struct {
- s *Service
- project string
- region string
- forwardingRule string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified ForwardingRule resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/forwardingRules/delete
-func (r *ForwardingRulesService) Delete(project string, region string, forwardingRule string) *ForwardingRulesDeleteCall {
- c := &ForwardingRulesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.forwardingRule = forwardingRule
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ForwardingRulesDeleteCall) Fields(s ...googleapi.Field) *ForwardingRulesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ForwardingRulesDeleteCall) Context(ctx context.Context) *ForwardingRulesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ForwardingRulesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/forwardingRules/{forwardingRule}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "forwardingRule": c.forwardingRule,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.forwardingRules.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ForwardingRulesDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified ForwardingRule resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.forwardingRules.delete",
- // "parameterOrder": [
- // "project",
- // "region",
- // "forwardingRule"
- // ],
- // "parameters": {
- // "forwardingRule": {
- // "description": "Name of the ForwardingRule resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/forwardingRules/{forwardingRule}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.forwardingRules.get":
-
-type ForwardingRulesGetCall struct {
- s *Service
- project string
- region string
- forwardingRule string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified ForwardingRule resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/forwardingRules/get
-func (r *ForwardingRulesService) Get(project string, region string, forwardingRule string) *ForwardingRulesGetCall {
- c := &ForwardingRulesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.forwardingRule = forwardingRule
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ForwardingRulesGetCall) Fields(s ...googleapi.Field) *ForwardingRulesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ForwardingRulesGetCall) IfNoneMatch(entityTag string) *ForwardingRulesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ForwardingRulesGetCall) Context(ctx context.Context) *ForwardingRulesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ForwardingRulesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/forwardingRules/{forwardingRule}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "forwardingRule": c.forwardingRule,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.forwardingRules.get" call.
-// Exactly one of *ForwardingRule or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ForwardingRule.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ForwardingRulesGetCall) Do() (*ForwardingRule, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ForwardingRule{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified ForwardingRule resource.",
- // "httpMethod": "GET",
- // "id": "compute.forwardingRules.get",
- // "parameterOrder": [
- // "project",
- // "region",
- // "forwardingRule"
- // ],
- // "parameters": {
- // "forwardingRule": {
- // "description": "Name of the ForwardingRule resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/forwardingRules/{forwardingRule}",
- // "response": {
- // "$ref": "ForwardingRule"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.forwardingRules.insert":
-
-type ForwardingRulesInsertCall struct {
- s *Service
- project string
- region string
- forwardingrule *ForwardingRule
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a ForwardingRule resource in the specified project
-// and region using the data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/forwardingRules/insert
-func (r *ForwardingRulesService) Insert(project string, region string, forwardingrule *ForwardingRule) *ForwardingRulesInsertCall {
- c := &ForwardingRulesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.forwardingrule = forwardingrule
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ForwardingRulesInsertCall) Fields(s ...googleapi.Field) *ForwardingRulesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ForwardingRulesInsertCall) Context(ctx context.Context) *ForwardingRulesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ForwardingRulesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.forwardingrule)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/forwardingRules")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.forwardingRules.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ForwardingRulesInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a ForwardingRule resource in the specified project and region using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.forwardingRules.insert",
- // "parameterOrder": [
- // "project",
- // "region"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/forwardingRules",
- // "request": {
- // "$ref": "ForwardingRule"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.forwardingRules.list":
-
-type ForwardingRulesListCall struct {
- s *Service
- project string
- region string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of ForwardingRule resources available to the
-// specified project and region.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/forwardingRules/list
-func (r *ForwardingRulesService) List(project string, region string) *ForwardingRulesListCall {
- c := &ForwardingRulesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *ForwardingRulesListCall) Filter(filter string) *ForwardingRulesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *ForwardingRulesListCall) MaxResults(maxResults int64) *ForwardingRulesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *ForwardingRulesListCall) OrderBy(orderBy string) *ForwardingRulesListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *ForwardingRulesListCall) PageToken(pageToken string) *ForwardingRulesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ForwardingRulesListCall) Fields(s ...googleapi.Field) *ForwardingRulesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ForwardingRulesListCall) IfNoneMatch(entityTag string) *ForwardingRulesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ForwardingRulesListCall) Context(ctx context.Context) *ForwardingRulesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ForwardingRulesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/forwardingRules")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.forwardingRules.list" call.
-// Exactly one of *ForwardingRuleList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ForwardingRuleList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ForwardingRulesListCall) Do() (*ForwardingRuleList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ForwardingRuleList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of ForwardingRule resources available to the specified project and region.",
- // "httpMethod": "GET",
- // "id": "compute.forwardingRules.list",
- // "parameterOrder": [
- // "project",
- // "region"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/forwardingRules",
- // "response": {
- // "$ref": "ForwardingRuleList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.forwardingRules.setTarget":
-
-type ForwardingRulesSetTargetCall struct {
- s *Service
- project string
- region string
- forwardingRule string
- targetreference *TargetReference
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetTarget: Changes target url for forwarding rule.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/forwardingRules/setTarget
-func (r *ForwardingRulesService) SetTarget(project string, region string, forwardingRule string, targetreference *TargetReference) *ForwardingRulesSetTargetCall {
- c := &ForwardingRulesSetTargetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.forwardingRule = forwardingRule
- c.targetreference = targetreference
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ForwardingRulesSetTargetCall) Fields(s ...googleapi.Field) *ForwardingRulesSetTargetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ForwardingRulesSetTargetCall) Context(ctx context.Context) *ForwardingRulesSetTargetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ForwardingRulesSetTargetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.targetreference)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "forwardingRule": c.forwardingRule,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.forwardingRules.setTarget" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ForwardingRulesSetTargetCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Changes target url for forwarding rule.",
- // "httpMethod": "POST",
- // "id": "compute.forwardingRules.setTarget",
- // "parameterOrder": [
- // "project",
- // "region",
- // "forwardingRule"
- // ],
- // "parameters": {
- // "forwardingRule": {
- // "description": "Name of the ForwardingRule resource in which target is to be set.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget",
- // "request": {
- // "$ref": "TargetReference"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.globalAddresses.delete":
-
-type GlobalAddressesDeleteCall struct {
- s *Service
- project string
- address string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified address resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/globalAddresses/delete
-func (r *GlobalAddressesService) Delete(project string, address string) *GlobalAddressesDeleteCall {
- c := &GlobalAddressesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.address = address
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalAddressesDeleteCall) Fields(s ...googleapi.Field) *GlobalAddressesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalAddressesDeleteCall) Context(ctx context.Context) *GlobalAddressesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalAddressesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/addresses/{address}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "address": c.address,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.globalAddresses.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GlobalAddressesDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified address resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.globalAddresses.delete",
- // "parameterOrder": [
- // "project",
- // "address"
- // ],
- // "parameters": {
- // "address": {
- // "description": "Name of the address resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/addresses/{address}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.globalAddresses.get":
-
-type GlobalAddressesGetCall struct {
- s *Service
- project string
- address string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified address resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/globalAddresses/get
-func (r *GlobalAddressesService) Get(project string, address string) *GlobalAddressesGetCall {
- c := &GlobalAddressesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.address = address
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalAddressesGetCall) Fields(s ...googleapi.Field) *GlobalAddressesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GlobalAddressesGetCall) IfNoneMatch(entityTag string) *GlobalAddressesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalAddressesGetCall) Context(ctx context.Context) *GlobalAddressesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalAddressesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/addresses/{address}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "address": c.address,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.globalAddresses.get" call.
-// Exactly one of *Address or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Address.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *GlobalAddressesGetCall) Do() (*Address, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Address{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified address resource.",
- // "httpMethod": "GET",
- // "id": "compute.globalAddresses.get",
- // "parameterOrder": [
- // "project",
- // "address"
- // ],
- // "parameters": {
- // "address": {
- // "description": "Name of the address resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/addresses/{address}",
- // "response": {
- // "$ref": "Address"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.globalAddresses.insert":
-
-type GlobalAddressesInsertCall struct {
- s *Service
- project string
- address *Address
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates an address resource in the specified project using
-// the data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/globalAddresses/insert
-func (r *GlobalAddressesService) Insert(project string, address *Address) *GlobalAddressesInsertCall {
- c := &GlobalAddressesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.address = address
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalAddressesInsertCall) Fields(s ...googleapi.Field) *GlobalAddressesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalAddressesInsertCall) Context(ctx context.Context) *GlobalAddressesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalAddressesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.address)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/addresses")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.globalAddresses.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GlobalAddressesInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates an address resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.globalAddresses.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/addresses",
- // "request": {
- // "$ref": "Address"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.globalAddresses.list":
-
-type GlobalAddressesListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of global address resources.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/globalAddresses/list
-func (r *GlobalAddressesService) List(project string) *GlobalAddressesListCall {
- c := &GlobalAddressesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *GlobalAddressesListCall) Filter(filter string) *GlobalAddressesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *GlobalAddressesListCall) MaxResults(maxResults int64) *GlobalAddressesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *GlobalAddressesListCall) OrderBy(orderBy string) *GlobalAddressesListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *GlobalAddressesListCall) PageToken(pageToken string) *GlobalAddressesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalAddressesListCall) Fields(s ...googleapi.Field) *GlobalAddressesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GlobalAddressesListCall) IfNoneMatch(entityTag string) *GlobalAddressesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalAddressesListCall) Context(ctx context.Context) *GlobalAddressesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalAddressesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/addresses")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.globalAddresses.list" call.
-// Exactly one of *AddressList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AddressList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GlobalAddressesListCall) Do() (*AddressList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AddressList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of global address resources.",
- // "httpMethod": "GET",
- // "id": "compute.globalAddresses.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/addresses",
- // "response": {
- // "$ref": "AddressList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.globalForwardingRules.delete":
-
-type GlobalForwardingRulesDeleteCall struct {
- s *Service
- project string
- forwardingRule string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified ForwardingRule resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/globalForwardingRules/delete
-func (r *GlobalForwardingRulesService) Delete(project string, forwardingRule string) *GlobalForwardingRulesDeleteCall {
- c := &GlobalForwardingRulesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.forwardingRule = forwardingRule
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalForwardingRulesDeleteCall) Fields(s ...googleapi.Field) *GlobalForwardingRulesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalForwardingRulesDeleteCall) Context(ctx context.Context) *GlobalForwardingRulesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalForwardingRulesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/forwardingRules/{forwardingRule}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "forwardingRule": c.forwardingRule,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.globalForwardingRules.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GlobalForwardingRulesDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified ForwardingRule resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.globalForwardingRules.delete",
- // "parameterOrder": [
- // "project",
- // "forwardingRule"
- // ],
- // "parameters": {
- // "forwardingRule": {
- // "description": "Name of the ForwardingRule resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/forwardingRules/{forwardingRule}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.globalForwardingRules.get":
-
-type GlobalForwardingRulesGetCall struct {
- s *Service
- project string
- forwardingRule string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified ForwardingRule resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/globalForwardingRules/get
-func (r *GlobalForwardingRulesService) Get(project string, forwardingRule string) *GlobalForwardingRulesGetCall {
- c := &GlobalForwardingRulesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.forwardingRule = forwardingRule
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalForwardingRulesGetCall) Fields(s ...googleapi.Field) *GlobalForwardingRulesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GlobalForwardingRulesGetCall) IfNoneMatch(entityTag string) *GlobalForwardingRulesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalForwardingRulesGetCall) Context(ctx context.Context) *GlobalForwardingRulesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalForwardingRulesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/forwardingRules/{forwardingRule}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "forwardingRule": c.forwardingRule,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.globalForwardingRules.get" call.
-// Exactly one of *ForwardingRule or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ForwardingRule.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *GlobalForwardingRulesGetCall) Do() (*ForwardingRule, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ForwardingRule{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified ForwardingRule resource.",
- // "httpMethod": "GET",
- // "id": "compute.globalForwardingRules.get",
- // "parameterOrder": [
- // "project",
- // "forwardingRule"
- // ],
- // "parameters": {
- // "forwardingRule": {
- // "description": "Name of the ForwardingRule resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/forwardingRules/{forwardingRule}",
- // "response": {
- // "$ref": "ForwardingRule"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.globalForwardingRules.insert":
-
-type GlobalForwardingRulesInsertCall struct {
- s *Service
- project string
- forwardingrule *ForwardingRule
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a ForwardingRule resource in the specified project
-// and region using the data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/globalForwardingRules/insert
-func (r *GlobalForwardingRulesService) Insert(project string, forwardingrule *ForwardingRule) *GlobalForwardingRulesInsertCall {
- c := &GlobalForwardingRulesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.forwardingrule = forwardingrule
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalForwardingRulesInsertCall) Fields(s ...googleapi.Field) *GlobalForwardingRulesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalForwardingRulesInsertCall) Context(ctx context.Context) *GlobalForwardingRulesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalForwardingRulesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.forwardingrule)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/forwardingRules")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.globalForwardingRules.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GlobalForwardingRulesInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a ForwardingRule resource in the specified project and region using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.globalForwardingRules.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/forwardingRules",
- // "request": {
- // "$ref": "ForwardingRule"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.globalForwardingRules.list":
-
-type GlobalForwardingRulesListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of ForwardingRule resources available to the
-// specified project.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/globalForwardingRules/list
-func (r *GlobalForwardingRulesService) List(project string) *GlobalForwardingRulesListCall {
- c := &GlobalForwardingRulesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *GlobalForwardingRulesListCall) Filter(filter string) *GlobalForwardingRulesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *GlobalForwardingRulesListCall) MaxResults(maxResults int64) *GlobalForwardingRulesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *GlobalForwardingRulesListCall) OrderBy(orderBy string) *GlobalForwardingRulesListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *GlobalForwardingRulesListCall) PageToken(pageToken string) *GlobalForwardingRulesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalForwardingRulesListCall) Fields(s ...googleapi.Field) *GlobalForwardingRulesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GlobalForwardingRulesListCall) IfNoneMatch(entityTag string) *GlobalForwardingRulesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalForwardingRulesListCall) Context(ctx context.Context) *GlobalForwardingRulesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalForwardingRulesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/forwardingRules")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.globalForwardingRules.list" call.
-// Exactly one of *ForwardingRuleList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ForwardingRuleList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *GlobalForwardingRulesListCall) Do() (*ForwardingRuleList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ForwardingRuleList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of ForwardingRule resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.globalForwardingRules.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/forwardingRules",
- // "response": {
- // "$ref": "ForwardingRuleList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.globalForwardingRules.setTarget":
-
-type GlobalForwardingRulesSetTargetCall struct {
- s *Service
- project string
- forwardingRule string
- targetreference *TargetReference
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetTarget: Changes target url for forwarding rule.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/globalForwardingRules/setTarget
-func (r *GlobalForwardingRulesService) SetTarget(project string, forwardingRule string, targetreference *TargetReference) *GlobalForwardingRulesSetTargetCall {
- c := &GlobalForwardingRulesSetTargetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.forwardingRule = forwardingRule
- c.targetreference = targetreference
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalForwardingRulesSetTargetCall) Fields(s ...googleapi.Field) *GlobalForwardingRulesSetTargetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalForwardingRulesSetTargetCall) Context(ctx context.Context) *GlobalForwardingRulesSetTargetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalForwardingRulesSetTargetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.targetreference)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/forwardingRules/{forwardingRule}/setTarget")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "forwardingRule": c.forwardingRule,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.globalForwardingRules.setTarget" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GlobalForwardingRulesSetTargetCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Changes target url for forwarding rule.",
- // "httpMethod": "POST",
- // "id": "compute.globalForwardingRules.setTarget",
- // "parameterOrder": [
- // "project",
- // "forwardingRule"
- // ],
- // "parameters": {
- // "forwardingRule": {
- // "description": "Name of the ForwardingRule resource in which target is to be set.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/forwardingRules/{forwardingRule}/setTarget",
- // "request": {
- // "$ref": "TargetReference"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.globalOperations.aggregatedList":
-
-type GlobalOperationsAggregatedListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AggregatedList: Retrieves the list of all operations grouped by
-// scope.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/globalOperations/aggregatedList
-func (r *GlobalOperationsService) AggregatedList(project string) *GlobalOperationsAggregatedListCall {
- c := &GlobalOperationsAggregatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *GlobalOperationsAggregatedListCall) Filter(filter string) *GlobalOperationsAggregatedListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *GlobalOperationsAggregatedListCall) MaxResults(maxResults int64) *GlobalOperationsAggregatedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *GlobalOperationsAggregatedListCall) OrderBy(orderBy string) *GlobalOperationsAggregatedListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *GlobalOperationsAggregatedListCall) PageToken(pageToken string) *GlobalOperationsAggregatedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalOperationsAggregatedListCall) Fields(s ...googleapi.Field) *GlobalOperationsAggregatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GlobalOperationsAggregatedListCall) IfNoneMatch(entityTag string) *GlobalOperationsAggregatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalOperationsAggregatedListCall) Context(ctx context.Context) *GlobalOperationsAggregatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalOperationsAggregatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/aggregated/operations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.globalOperations.aggregatedList" call.
-// Exactly one of *OperationAggregatedList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *OperationAggregatedList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *GlobalOperationsAggregatedListCall) Do() (*OperationAggregatedList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OperationAggregatedList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of all operations grouped by scope.",
- // "httpMethod": "GET",
- // "id": "compute.globalOperations.aggregatedList",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/aggregated/operations",
- // "response": {
- // "$ref": "OperationAggregatedList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.globalOperations.delete":
-
-type GlobalOperationsDeleteCall struct {
- s *Service
- project string
- operation string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified Operations resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/globalOperations/delete
-func (r *GlobalOperationsService) Delete(project string, operation string) *GlobalOperationsDeleteCall {
- c := &GlobalOperationsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.operation = operation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalOperationsDeleteCall) Fields(s ...googleapi.Field) *GlobalOperationsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalOperationsDeleteCall) Context(ctx context.Context) *GlobalOperationsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalOperationsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/operations/{operation}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "operation": c.operation,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.globalOperations.delete" call.
-func (c *GlobalOperationsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes the specified Operations resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.globalOperations.delete",
- // "parameterOrder": [
- // "project",
- // "operation"
- // ],
- // "parameters": {
- // "operation": {
- // "description": "Name of the Operations resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/operations/{operation}",
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.globalOperations.get":
-
-type GlobalOperationsGetCall struct {
- s *Service
- project string
- operation string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves the specified Operations resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/globalOperations/get
-func (r *GlobalOperationsService) Get(project string, operation string) *GlobalOperationsGetCall {
- c := &GlobalOperationsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.operation = operation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalOperationsGetCall) Fields(s ...googleapi.Field) *GlobalOperationsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GlobalOperationsGetCall) IfNoneMatch(entityTag string) *GlobalOperationsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalOperationsGetCall) Context(ctx context.Context) *GlobalOperationsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalOperationsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/operations/{operation}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "operation": c.operation,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.globalOperations.get" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GlobalOperationsGetCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the specified Operations resource.",
- // "httpMethod": "GET",
- // "id": "compute.globalOperations.get",
- // "parameterOrder": [
- // "project",
- // "operation"
- // ],
- // "parameters": {
- // "operation": {
- // "description": "Name of the Operations resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/operations/{operation}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.globalOperations.list":
-
-type GlobalOperationsListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of Operation resources contained within the
-// specified project.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/globalOperations/list
-func (r *GlobalOperationsService) List(project string) *GlobalOperationsListCall {
- c := &GlobalOperationsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *GlobalOperationsListCall) Filter(filter string) *GlobalOperationsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *GlobalOperationsListCall) MaxResults(maxResults int64) *GlobalOperationsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *GlobalOperationsListCall) OrderBy(orderBy string) *GlobalOperationsListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *GlobalOperationsListCall) PageToken(pageToken string) *GlobalOperationsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalOperationsListCall) Fields(s ...googleapi.Field) *GlobalOperationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GlobalOperationsListCall) IfNoneMatch(entityTag string) *GlobalOperationsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalOperationsListCall) Context(ctx context.Context) *GlobalOperationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalOperationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/operations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.globalOperations.list" call.
-// Exactly one of *OperationList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *OperationList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *GlobalOperationsListCall) Do() (*OperationList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OperationList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of Operation resources contained within the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.globalOperations.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/operations",
- // "response": {
- // "$ref": "OperationList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.httpHealthChecks.delete":
-
-type HttpHealthChecksDeleteCall struct {
- s *Service
- project string
- httpHealthCheck string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified HttpHealthCheck resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/httpHealthChecks/delete
-func (r *HttpHealthChecksService) Delete(project string, httpHealthCheck string) *HttpHealthChecksDeleteCall {
- c := &HttpHealthChecksDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.httpHealthCheck = httpHealthCheck
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *HttpHealthChecksDeleteCall) Fields(s ...googleapi.Field) *HttpHealthChecksDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *HttpHealthChecksDeleteCall) Context(ctx context.Context) *HttpHealthChecksDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *HttpHealthChecksDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/httpHealthChecks/{httpHealthCheck}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "httpHealthCheck": c.httpHealthCheck,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.httpHealthChecks.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *HttpHealthChecksDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified HttpHealthCheck resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.httpHealthChecks.delete",
- // "parameterOrder": [
- // "project",
- // "httpHealthCheck"
- // ],
- // "parameters": {
- // "httpHealthCheck": {
- // "description": "Name of the HttpHealthCheck resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/httpHealthChecks/{httpHealthCheck}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.httpHealthChecks.get":
-
-type HttpHealthChecksGetCall struct {
- s *Service
- project string
- httpHealthCheck string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified HttpHealthCheck resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/httpHealthChecks/get
-func (r *HttpHealthChecksService) Get(project string, httpHealthCheck string) *HttpHealthChecksGetCall {
- c := &HttpHealthChecksGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.httpHealthCheck = httpHealthCheck
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *HttpHealthChecksGetCall) Fields(s ...googleapi.Field) *HttpHealthChecksGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *HttpHealthChecksGetCall) IfNoneMatch(entityTag string) *HttpHealthChecksGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *HttpHealthChecksGetCall) Context(ctx context.Context) *HttpHealthChecksGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *HttpHealthChecksGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/httpHealthChecks/{httpHealthCheck}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "httpHealthCheck": c.httpHealthCheck,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.httpHealthChecks.get" call.
-// Exactly one of *HttpHealthCheck or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *HttpHealthCheck.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *HttpHealthChecksGetCall) Do() (*HttpHealthCheck, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &HttpHealthCheck{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified HttpHealthCheck resource.",
- // "httpMethod": "GET",
- // "id": "compute.httpHealthChecks.get",
- // "parameterOrder": [
- // "project",
- // "httpHealthCheck"
- // ],
- // "parameters": {
- // "httpHealthCheck": {
- // "description": "Name of the HttpHealthCheck resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/httpHealthChecks/{httpHealthCheck}",
- // "response": {
- // "$ref": "HttpHealthCheck"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.httpHealthChecks.insert":
-
-type HttpHealthChecksInsertCall struct {
- s *Service
- project string
- httphealthcheck *HttpHealthCheck
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a HttpHealthCheck resource in the specified project
-// using the data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/httpHealthChecks/insert
-func (r *HttpHealthChecksService) Insert(project string, httphealthcheck *HttpHealthCheck) *HttpHealthChecksInsertCall {
- c := &HttpHealthChecksInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.httphealthcheck = httphealthcheck
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *HttpHealthChecksInsertCall) Fields(s ...googleapi.Field) *HttpHealthChecksInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *HttpHealthChecksInsertCall) Context(ctx context.Context) *HttpHealthChecksInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *HttpHealthChecksInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.httphealthcheck)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/httpHealthChecks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.httpHealthChecks.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *HttpHealthChecksInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a HttpHealthCheck resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.httpHealthChecks.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/httpHealthChecks",
- // "request": {
- // "$ref": "HttpHealthCheck"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.httpHealthChecks.list":
-
-type HttpHealthChecksListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of HttpHealthCheck resources available to
-// the specified project.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/httpHealthChecks/list
-func (r *HttpHealthChecksService) List(project string) *HttpHealthChecksListCall {
- c := &HttpHealthChecksListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *HttpHealthChecksListCall) Filter(filter string) *HttpHealthChecksListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *HttpHealthChecksListCall) MaxResults(maxResults int64) *HttpHealthChecksListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *HttpHealthChecksListCall) OrderBy(orderBy string) *HttpHealthChecksListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *HttpHealthChecksListCall) PageToken(pageToken string) *HttpHealthChecksListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *HttpHealthChecksListCall) Fields(s ...googleapi.Field) *HttpHealthChecksListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *HttpHealthChecksListCall) IfNoneMatch(entityTag string) *HttpHealthChecksListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *HttpHealthChecksListCall) Context(ctx context.Context) *HttpHealthChecksListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *HttpHealthChecksListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/httpHealthChecks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.httpHealthChecks.list" call.
-// Exactly one of *HttpHealthCheckList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *HttpHealthCheckList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *HttpHealthChecksListCall) Do() (*HttpHealthCheckList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &HttpHealthCheckList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of HttpHealthCheck resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.httpHealthChecks.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/httpHealthChecks",
- // "response": {
- // "$ref": "HttpHealthCheckList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.httpHealthChecks.patch":
-
-type HttpHealthChecksPatchCall struct {
- s *Service
- project string
- httpHealthCheck string
- httphealthcheck *HttpHealthCheck
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates a HttpHealthCheck resource in the specified project
-// using the data included in the request. This method supports patch
-// semantics.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/httpHealthChecks/patch
-func (r *HttpHealthChecksService) Patch(project string, httpHealthCheck string, httphealthcheck *HttpHealthCheck) *HttpHealthChecksPatchCall {
- c := &HttpHealthChecksPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.httpHealthCheck = httpHealthCheck
- c.httphealthcheck = httphealthcheck
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *HttpHealthChecksPatchCall) Fields(s ...googleapi.Field) *HttpHealthChecksPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *HttpHealthChecksPatchCall) Context(ctx context.Context) *HttpHealthChecksPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *HttpHealthChecksPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.httphealthcheck)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/httpHealthChecks/{httpHealthCheck}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "httpHealthCheck": c.httpHealthCheck,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.httpHealthChecks.patch" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *HttpHealthChecksPatchCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "compute.httpHealthChecks.patch",
- // "parameterOrder": [
- // "project",
- // "httpHealthCheck"
- // ],
- // "parameters": {
- // "httpHealthCheck": {
- // "description": "Name of the HttpHealthCheck resource to update.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/httpHealthChecks/{httpHealthCheck}",
- // "request": {
- // "$ref": "HttpHealthCheck"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.httpHealthChecks.update":
-
-type HttpHealthChecksUpdateCall struct {
- s *Service
- project string
- httpHealthCheck string
- httphealthcheck *HttpHealthCheck
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates a HttpHealthCheck resource in the specified project
-// using the data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/httpHealthChecks/update
-func (r *HttpHealthChecksService) Update(project string, httpHealthCheck string, httphealthcheck *HttpHealthCheck) *HttpHealthChecksUpdateCall {
- c := &HttpHealthChecksUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.httpHealthCheck = httpHealthCheck
- c.httphealthcheck = httphealthcheck
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *HttpHealthChecksUpdateCall) Fields(s ...googleapi.Field) *HttpHealthChecksUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *HttpHealthChecksUpdateCall) Context(ctx context.Context) *HttpHealthChecksUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *HttpHealthChecksUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.httphealthcheck)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/httpHealthChecks/{httpHealthCheck}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "httpHealthCheck": c.httpHealthCheck,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.httpHealthChecks.update" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *HttpHealthChecksUpdateCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a HttpHealthCheck resource in the specified project using the data included in the request.",
- // "httpMethod": "PUT",
- // "id": "compute.httpHealthChecks.update",
- // "parameterOrder": [
- // "project",
- // "httpHealthCheck"
- // ],
- // "parameters": {
- // "httpHealthCheck": {
- // "description": "Name of the HttpHealthCheck resource to update.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/httpHealthChecks/{httpHealthCheck}",
- // "request": {
- // "$ref": "HttpHealthCheck"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.httpsHealthChecks.delete":
-
-type HttpsHealthChecksDeleteCall struct {
- s *Service
- project string
- httpsHealthCheck string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified HttpsHealthCheck resource.
-func (r *HttpsHealthChecksService) Delete(project string, httpsHealthCheck string) *HttpsHealthChecksDeleteCall {
- c := &HttpsHealthChecksDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.httpsHealthCheck = httpsHealthCheck
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *HttpsHealthChecksDeleteCall) Fields(s ...googleapi.Field) *HttpsHealthChecksDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *HttpsHealthChecksDeleteCall) Context(ctx context.Context) *HttpsHealthChecksDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *HttpsHealthChecksDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/httpsHealthChecks/{httpsHealthCheck}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "httpsHealthCheck": c.httpsHealthCheck,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.httpsHealthChecks.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *HttpsHealthChecksDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified HttpsHealthCheck resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.httpsHealthChecks.delete",
- // "parameterOrder": [
- // "project",
- // "httpsHealthCheck"
- // ],
- // "parameters": {
- // "httpsHealthCheck": {
- // "description": "Name of the HttpsHealthCheck resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.httpsHealthChecks.get":
-
-type HttpsHealthChecksGetCall struct {
- s *Service
- project string
- httpsHealthCheck string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified HttpsHealthCheck resource.
-func (r *HttpsHealthChecksService) Get(project string, httpsHealthCheck string) *HttpsHealthChecksGetCall {
- c := &HttpsHealthChecksGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.httpsHealthCheck = httpsHealthCheck
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *HttpsHealthChecksGetCall) Fields(s ...googleapi.Field) *HttpsHealthChecksGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *HttpsHealthChecksGetCall) IfNoneMatch(entityTag string) *HttpsHealthChecksGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *HttpsHealthChecksGetCall) Context(ctx context.Context) *HttpsHealthChecksGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *HttpsHealthChecksGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/httpsHealthChecks/{httpsHealthCheck}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "httpsHealthCheck": c.httpsHealthCheck,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.httpsHealthChecks.get" call.
-// Exactly one of *HttpsHealthCheck or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *HttpsHealthCheck.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *HttpsHealthChecksGetCall) Do() (*HttpsHealthCheck, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &HttpsHealthCheck{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified HttpsHealthCheck resource.",
- // "httpMethod": "GET",
- // "id": "compute.httpsHealthChecks.get",
- // "parameterOrder": [
- // "project",
- // "httpsHealthCheck"
- // ],
- // "parameters": {
- // "httpsHealthCheck": {
- // "description": "Name of the HttpsHealthCheck resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}",
- // "response": {
- // "$ref": "HttpsHealthCheck"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.httpsHealthChecks.insert":
-
-type HttpsHealthChecksInsertCall struct {
- s *Service
- project string
- httpshealthcheck *HttpsHealthCheck
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a HttpsHealthCheck resource in the specified project
-// using the data included in the request.
-func (r *HttpsHealthChecksService) Insert(project string, httpshealthcheck *HttpsHealthCheck) *HttpsHealthChecksInsertCall {
- c := &HttpsHealthChecksInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.httpshealthcheck = httpshealthcheck
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *HttpsHealthChecksInsertCall) Fields(s ...googleapi.Field) *HttpsHealthChecksInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *HttpsHealthChecksInsertCall) Context(ctx context.Context) *HttpsHealthChecksInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *HttpsHealthChecksInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.httpshealthcheck)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/httpsHealthChecks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.httpsHealthChecks.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *HttpsHealthChecksInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a HttpsHealthCheck resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.httpsHealthChecks.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/httpsHealthChecks",
- // "request": {
- // "$ref": "HttpsHealthCheck"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.httpsHealthChecks.list":
-
-type HttpsHealthChecksListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of HttpsHealthCheck resources available to
-// the specified project.
-func (r *HttpsHealthChecksService) List(project string) *HttpsHealthChecksListCall {
- c := &HttpsHealthChecksListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *HttpsHealthChecksListCall) Filter(filter string) *HttpsHealthChecksListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *HttpsHealthChecksListCall) MaxResults(maxResults int64) *HttpsHealthChecksListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *HttpsHealthChecksListCall) OrderBy(orderBy string) *HttpsHealthChecksListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *HttpsHealthChecksListCall) PageToken(pageToken string) *HttpsHealthChecksListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *HttpsHealthChecksListCall) Fields(s ...googleapi.Field) *HttpsHealthChecksListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *HttpsHealthChecksListCall) IfNoneMatch(entityTag string) *HttpsHealthChecksListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *HttpsHealthChecksListCall) Context(ctx context.Context) *HttpsHealthChecksListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *HttpsHealthChecksListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/httpsHealthChecks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.httpsHealthChecks.list" call.
-// Exactly one of *HttpsHealthCheckList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *HttpsHealthCheckList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *HttpsHealthChecksListCall) Do() (*HttpsHealthCheckList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &HttpsHealthCheckList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of HttpsHealthCheck resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.httpsHealthChecks.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/httpsHealthChecks",
- // "response": {
- // "$ref": "HttpsHealthCheckList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.httpsHealthChecks.patch":
-
-type HttpsHealthChecksPatchCall struct {
- s *Service
- project string
- httpsHealthCheck string
- httpshealthcheck *HttpsHealthCheck
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates a HttpsHealthCheck resource in the specified project
-// using the data included in the request. This method supports patch
-// semantics.
-func (r *HttpsHealthChecksService) Patch(project string, httpsHealthCheck string, httpshealthcheck *HttpsHealthCheck) *HttpsHealthChecksPatchCall {
- c := &HttpsHealthChecksPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.httpsHealthCheck = httpsHealthCheck
- c.httpshealthcheck = httpshealthcheck
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *HttpsHealthChecksPatchCall) Fields(s ...googleapi.Field) *HttpsHealthChecksPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *HttpsHealthChecksPatchCall) Context(ctx context.Context) *HttpsHealthChecksPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *HttpsHealthChecksPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.httpshealthcheck)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/httpsHealthChecks/{httpsHealthCheck}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "httpsHealthCheck": c.httpsHealthCheck,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.httpsHealthChecks.patch" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *HttpsHealthChecksPatchCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "compute.httpsHealthChecks.patch",
- // "parameterOrder": [
- // "project",
- // "httpsHealthCheck"
- // ],
- // "parameters": {
- // "httpsHealthCheck": {
- // "description": "Name of the HttpsHealthCheck resource to update.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}",
- // "request": {
- // "$ref": "HttpsHealthCheck"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.httpsHealthChecks.update":
-
-type HttpsHealthChecksUpdateCall struct {
- s *Service
- project string
- httpsHealthCheck string
- httpshealthcheck *HttpsHealthCheck
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates a HttpsHealthCheck resource in the specified project
-// using the data included in the request.
-func (r *HttpsHealthChecksService) Update(project string, httpsHealthCheck string, httpshealthcheck *HttpsHealthCheck) *HttpsHealthChecksUpdateCall {
- c := &HttpsHealthChecksUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.httpsHealthCheck = httpsHealthCheck
- c.httpshealthcheck = httpshealthcheck
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *HttpsHealthChecksUpdateCall) Fields(s ...googleapi.Field) *HttpsHealthChecksUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *HttpsHealthChecksUpdateCall) Context(ctx context.Context) *HttpsHealthChecksUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *HttpsHealthChecksUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.httpshealthcheck)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/httpsHealthChecks/{httpsHealthCheck}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "httpsHealthCheck": c.httpsHealthCheck,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.httpsHealthChecks.update" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *HttpsHealthChecksUpdateCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a HttpsHealthCheck resource in the specified project using the data included in the request.",
- // "httpMethod": "PUT",
- // "id": "compute.httpsHealthChecks.update",
- // "parameterOrder": [
- // "project",
- // "httpsHealthCheck"
- // ],
- // "parameters": {
- // "httpsHealthCheck": {
- // "description": "Name of the HttpsHealthCheck resource to update.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}",
- // "request": {
- // "$ref": "HttpsHealthCheck"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.images.delete":
-
-type ImagesDeleteCall struct {
- s *Service
- project string
- image string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified image resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/images/delete
-func (r *ImagesService) Delete(project string, image string) *ImagesDeleteCall {
- c := &ImagesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.image = image
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ImagesDeleteCall) Fields(s ...googleapi.Field) *ImagesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ImagesDeleteCall) Context(ctx context.Context) *ImagesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ImagesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/images/{image}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "image": c.image,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.images.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ImagesDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified image resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.images.delete",
- // "parameterOrder": [
- // "project",
- // "image"
- // ],
- // "parameters": {
- // "image": {
- // "description": "Name of the image resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/images/{image}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.images.deprecate":
-
-type ImagesDeprecateCall struct {
- s *Service
- project string
- image string
- deprecationstatus *DeprecationStatus
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Deprecate: Sets the deprecation status of an image.
-//
-// If an empty request body is given, clears the deprecation status
-// instead.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/images/deprecate
-func (r *ImagesService) Deprecate(project string, image string, deprecationstatus *DeprecationStatus) *ImagesDeprecateCall {
- c := &ImagesDeprecateCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.image = image
- c.deprecationstatus = deprecationstatus
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ImagesDeprecateCall) Fields(s ...googleapi.Field) *ImagesDeprecateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ImagesDeprecateCall) Context(ctx context.Context) *ImagesDeprecateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ImagesDeprecateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.deprecationstatus)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/images/{image}/deprecate")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "image": c.image,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.images.deprecate" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ImagesDeprecateCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sets the deprecation status of an image.\n\nIf an empty request body is given, clears the deprecation status instead.",
- // "httpMethod": "POST",
- // "id": "compute.images.deprecate",
- // "parameterOrder": [
- // "project",
- // "image"
- // ],
- // "parameters": {
- // "image": {
- // "description": "Image name.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/images/{image}/deprecate",
- // "request": {
- // "$ref": "DeprecationStatus"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.images.get":
-
-type ImagesGetCall struct {
- s *Service
- project string
- image string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified image resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/images/get
-func (r *ImagesService) Get(project string, image string) *ImagesGetCall {
- c := &ImagesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.image = image
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ImagesGetCall) Fields(s ...googleapi.Field) *ImagesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ImagesGetCall) IfNoneMatch(entityTag string) *ImagesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ImagesGetCall) Context(ctx context.Context) *ImagesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ImagesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/images/{image}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "image": c.image,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.images.get" call.
-// Exactly one of *Image or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Image.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ImagesGetCall) Do() (*Image, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Image{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified image resource.",
- // "httpMethod": "GET",
- // "id": "compute.images.get",
- // "parameterOrder": [
- // "project",
- // "image"
- // ],
- // "parameters": {
- // "image": {
- // "description": "Name of the image resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/images/{image}",
- // "response": {
- // "$ref": "Image"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.images.insert":
-
-type ImagesInsertCall struct {
- s *Service
- project string
- image *Image
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates an image resource in the specified project using the
-// data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/images/insert
-func (r *ImagesService) Insert(project string, image *Image) *ImagesInsertCall {
- c := &ImagesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.image = image
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ImagesInsertCall) Fields(s ...googleapi.Field) *ImagesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ImagesInsertCall) Context(ctx context.Context) *ImagesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ImagesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.image)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/images")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.images.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ImagesInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates an image resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.images.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/images",
- // "request": {
- // "$ref": "Image"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/devstorage.full_control",
- // "https://www.googleapis.com/auth/devstorage.read_only",
- // "https://www.googleapis.com/auth/devstorage.read_write"
- // ]
- // }
-
-}
-
-// method id "compute.images.list":
-
-type ImagesListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of private images available to the specified
-// project. Private images are images you create that belong to your
-// project. This method does not get any images that belong to other
-// projects, including publicly-available images, like Debian 7. If you
-// want to get a list of publicly-available images, use this method to
-// make a request to the respective image project, such as debian-cloud
-// or windows-cloud.
-//
-// See Accessing images for more information.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/images/list
-func (r *ImagesService) List(project string) *ImagesListCall {
- c := &ImagesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *ImagesListCall) Filter(filter string) *ImagesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *ImagesListCall) MaxResults(maxResults int64) *ImagesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *ImagesListCall) OrderBy(orderBy string) *ImagesListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *ImagesListCall) PageToken(pageToken string) *ImagesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ImagesListCall) Fields(s ...googleapi.Field) *ImagesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ImagesListCall) IfNoneMatch(entityTag string) *ImagesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ImagesListCall) Context(ctx context.Context) *ImagesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ImagesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/images")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.images.list" call.
-// Exactly one of *ImageList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ImageList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ImagesListCall) Do() (*ImageList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ImageList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 7. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.\n\nSee Accessing images for more information.",
- // "httpMethod": "GET",
- // "id": "compute.images.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/images",
- // "response": {
- // "$ref": "ImageList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroupManagers.abandonInstances":
-
-type InstanceGroupManagersAbandonInstancesCall struct {
- s *Service
- project string
- zone string
- instanceGroupManager string
- instancegroupmanagersabandoninstancesrequest *InstanceGroupManagersAbandonInstancesRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AbandonInstances: Schedules a group action to remove the specified
-// instances from the managed instance group. Abandoning an instance
-// does not delete the instance, but it does remove the instance from
-// any target pools that are applied by the managed instance group. This
-// method reduces the targetSize of the managed instance group by the
-// number of instances that you abandon. This operation is marked as
-// DONE when the action is scheduled even if the instances have not yet
-// been removed from the group. You must separately verify the status of
-// the abandoning action with the listmanagedinstances method.
-func (r *InstanceGroupManagersService) AbandonInstances(project string, zone string, instanceGroupManager string, instancegroupmanagersabandoninstancesrequest *InstanceGroupManagersAbandonInstancesRequest) *InstanceGroupManagersAbandonInstancesCall {
- c := &InstanceGroupManagersAbandonInstancesCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroupManager = instanceGroupManager
- c.instancegroupmanagersabandoninstancesrequest = instancegroupmanagersabandoninstancesrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupManagersAbandonInstancesCall) Fields(s ...googleapi.Field) *InstanceGroupManagersAbandonInstancesCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupManagersAbandonInstancesCall) Context(ctx context.Context) *InstanceGroupManagersAbandonInstancesCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupManagersAbandonInstancesCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancegroupmanagersabandoninstancesrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroupManager": c.instanceGroupManager,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroupManagers.abandonInstances" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceGroupManagersAbandonInstancesCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.",
- // "httpMethod": "POST",
- // "id": "compute.instanceGroupManagers.abandonInstances",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroupManager"
- // ],
- // "parameters": {
- // "instanceGroupManager": {
- // "description": "The name of the managed instance group.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the managed instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances",
- // "request": {
- // "$ref": "InstanceGroupManagersAbandonInstancesRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroupManagers.aggregatedList":
-
-type InstanceGroupManagersAggregatedListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AggregatedList: Retrieves the list of managed instance groups and
-// groups them by zone.
-func (r *InstanceGroupManagersService) AggregatedList(project string) *InstanceGroupManagersAggregatedListCall {
- c := &InstanceGroupManagersAggregatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *InstanceGroupManagersAggregatedListCall) Filter(filter string) *InstanceGroupManagersAggregatedListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *InstanceGroupManagersAggregatedListCall) MaxResults(maxResults int64) *InstanceGroupManagersAggregatedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *InstanceGroupManagersAggregatedListCall) OrderBy(orderBy string) *InstanceGroupManagersAggregatedListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *InstanceGroupManagersAggregatedListCall) PageToken(pageToken string) *InstanceGroupManagersAggregatedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupManagersAggregatedListCall) Fields(s ...googleapi.Field) *InstanceGroupManagersAggregatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InstanceGroupManagersAggregatedListCall) IfNoneMatch(entityTag string) *InstanceGroupManagersAggregatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupManagersAggregatedListCall) Context(ctx context.Context) *InstanceGroupManagersAggregatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupManagersAggregatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/aggregated/instanceGroupManagers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroupManagers.aggregatedList" call.
-// Exactly one of *InstanceGroupManagerAggregatedList or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *InstanceGroupManagerAggregatedList.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *InstanceGroupManagersAggregatedListCall) Do() (*InstanceGroupManagerAggregatedList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InstanceGroupManagerAggregatedList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of managed instance groups and groups them by zone.",
- // "httpMethod": "GET",
- // "id": "compute.instanceGroupManagers.aggregatedList",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/aggregated/instanceGroupManagers",
- // "response": {
- // "$ref": "InstanceGroupManagerAggregatedList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroupManagers.delete":
-
-type InstanceGroupManagersDeleteCall struct {
- s *Service
- project string
- zone string
- instanceGroupManager string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified managed instance group and all of the
-// instances in that group.
-func (r *InstanceGroupManagersService) Delete(project string, zone string, instanceGroupManager string) *InstanceGroupManagersDeleteCall {
- c := &InstanceGroupManagersDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroupManager = instanceGroupManager
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupManagersDeleteCall) Fields(s ...googleapi.Field) *InstanceGroupManagersDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupManagersDeleteCall) Context(ctx context.Context) *InstanceGroupManagersDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupManagersDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroupManager": c.instanceGroupManager,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroupManagers.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceGroupManagersDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified managed instance group and all of the instances in that group.",
- // "httpMethod": "DELETE",
- // "id": "compute.instanceGroupManagers.delete",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroupManager"
- // ],
- // "parameters": {
- // "instanceGroupManager": {
- // "description": "The name of the managed instance group to delete.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the managed instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroupManagers.deleteInstances":
-
-type InstanceGroupManagersDeleteInstancesCall struct {
- s *Service
- project string
- zone string
- instanceGroupManager string
- instancegroupmanagersdeleteinstancesrequest *InstanceGroupManagersDeleteInstancesRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// DeleteInstances: Schedules a group action to delete the specified
-// instances in the managed instance group. The instances are also
-// removed from any target pools of which they were a member. This
-// method reduces the targetSize of the managed instance group by the
-// number of instances that you delete. This operation is marked as DONE
-// when the action is scheduled even if the instances are still being
-// deleted. You must separately verify the status of the deleting action
-// with the listmanagedinstances method.
-func (r *InstanceGroupManagersService) DeleteInstances(project string, zone string, instanceGroupManager string, instancegroupmanagersdeleteinstancesrequest *InstanceGroupManagersDeleteInstancesRequest) *InstanceGroupManagersDeleteInstancesCall {
- c := &InstanceGroupManagersDeleteInstancesCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroupManager = instanceGroupManager
- c.instancegroupmanagersdeleteinstancesrequest = instancegroupmanagersdeleteinstancesrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupManagersDeleteInstancesCall) Fields(s ...googleapi.Field) *InstanceGroupManagersDeleteInstancesCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupManagersDeleteInstancesCall) Context(ctx context.Context) *InstanceGroupManagersDeleteInstancesCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupManagersDeleteInstancesCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancegroupmanagersdeleteinstancesrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroupManager": c.instanceGroupManager,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroupManagers.deleteInstances" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceGroupManagersDeleteInstancesCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.",
- // "httpMethod": "POST",
- // "id": "compute.instanceGroupManagers.deleteInstances",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroupManager"
- // ],
- // "parameters": {
- // "instanceGroupManager": {
- // "description": "The name of the managed instance group.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the managed instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances",
- // "request": {
- // "$ref": "InstanceGroupManagersDeleteInstancesRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroupManagers.get":
-
-type InstanceGroupManagersGetCall struct {
- s *Service
- project string
- zone string
- instanceGroupManager string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns all of the details about the specified managed instance
-// group.
-func (r *InstanceGroupManagersService) Get(project string, zone string, instanceGroupManager string) *InstanceGroupManagersGetCall {
- c := &InstanceGroupManagersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroupManager = instanceGroupManager
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupManagersGetCall) Fields(s ...googleapi.Field) *InstanceGroupManagersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InstanceGroupManagersGetCall) IfNoneMatch(entityTag string) *InstanceGroupManagersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupManagersGetCall) Context(ctx context.Context) *InstanceGroupManagersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupManagersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroupManager": c.instanceGroupManager,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroupManagers.get" call.
-// Exactly one of *InstanceGroupManager or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *InstanceGroupManager.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InstanceGroupManagersGetCall) Do() (*InstanceGroupManager, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InstanceGroupManager{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns all of the details about the specified managed instance group.",
- // "httpMethod": "GET",
- // "id": "compute.instanceGroupManagers.get",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroupManager"
- // ],
- // "parameters": {
- // "instanceGroupManager": {
- // "description": "The name of the managed instance group.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the managed instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}",
- // "response": {
- // "$ref": "InstanceGroupManager"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroupManagers.insert":
-
-type InstanceGroupManagersInsertCall struct {
- s *Service
- project string
- zone string
- instancegroupmanager *InstanceGroupManager
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a managed instance group using the information that
-// you specify in the request. After the group is created, it schedules
-// an action to create instances in the group using the specified
-// instance template. This operation is marked as DONE when the group is
-// created even if the instances in the group have not yet been created.
-// You must separately verify the status of the individual instances
-// with the listmanagedinstances method.
-func (r *InstanceGroupManagersService) Insert(project string, zone string, instancegroupmanager *InstanceGroupManager) *InstanceGroupManagersInsertCall {
- c := &InstanceGroupManagersInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instancegroupmanager = instancegroupmanager
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupManagersInsertCall) Fields(s ...googleapi.Field) *InstanceGroupManagersInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupManagersInsertCall) Context(ctx context.Context) *InstanceGroupManagersInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupManagersInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancegroupmanager)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroupManagers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroupManagers.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceGroupManagersInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.",
- // "httpMethod": "POST",
- // "id": "compute.instanceGroupManagers.insert",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where you want to create the managed instance group.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroupManagers",
- // "request": {
- // "$ref": "InstanceGroupManager"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroupManagers.list":
-
-type InstanceGroupManagersListCall struct {
- s *Service
- project string
- zone string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of managed instance groups that are contained
-// within the specified project and zone.
-func (r *InstanceGroupManagersService) List(project string, zone string) *InstanceGroupManagersListCall {
- c := &InstanceGroupManagersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *InstanceGroupManagersListCall) Filter(filter string) *InstanceGroupManagersListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *InstanceGroupManagersListCall) MaxResults(maxResults int64) *InstanceGroupManagersListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *InstanceGroupManagersListCall) OrderBy(orderBy string) *InstanceGroupManagersListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *InstanceGroupManagersListCall) PageToken(pageToken string) *InstanceGroupManagersListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupManagersListCall) Fields(s ...googleapi.Field) *InstanceGroupManagersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InstanceGroupManagersListCall) IfNoneMatch(entityTag string) *InstanceGroupManagersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupManagersListCall) Context(ctx context.Context) *InstanceGroupManagersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupManagersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroupManagers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroupManagers.list" call.
-// Exactly one of *InstanceGroupManagerList or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *InstanceGroupManagerList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InstanceGroupManagersListCall) Do() (*InstanceGroupManagerList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InstanceGroupManagerList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of managed instance groups that are contained within the specified project and zone.",
- // "httpMethod": "GET",
- // "id": "compute.instanceGroupManagers.list",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the managed instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroupManagers",
- // "response": {
- // "$ref": "InstanceGroupManagerList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroupManagers.listManagedInstances":
-
-type InstanceGroupManagersListManagedInstancesCall struct {
- s *Service
- project string
- zone string
- instanceGroupManager string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// ListManagedInstances: Lists all of the instances in the managed
-// instance group. Each instance in the list has a currentAction, which
-// indicates the action that the managed instance group is performing on
-// the instance. For example, if the group is still creating an
-// instance, the currentAction is CREATING. If a previous action failed,
-// the list displays the errors for that failed action.
-func (r *InstanceGroupManagersService) ListManagedInstances(project string, zone string, instanceGroupManager string) *InstanceGroupManagersListManagedInstancesCall {
- c := &InstanceGroupManagersListManagedInstancesCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroupManager = instanceGroupManager
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupManagersListManagedInstancesCall) Fields(s ...googleapi.Field) *InstanceGroupManagersListManagedInstancesCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupManagersListManagedInstancesCall) Context(ctx context.Context) *InstanceGroupManagersListManagedInstancesCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupManagersListManagedInstancesCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroupManager": c.instanceGroupManager,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroupManagers.listManagedInstances" call.
-// Exactly one of *InstanceGroupManagersListManagedInstancesResponse or
-// error will be non-nil. Any non-2xx status code is an error. Response
-// headers are in either
-// *InstanceGroupManagersListManagedInstancesResponse.ServerResponse.Head
-// er or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *InstanceGroupManagersListManagedInstancesCall) Do() (*InstanceGroupManagersListManagedInstancesResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InstanceGroupManagersListManagedInstancesResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action.",
- // "httpMethod": "POST",
- // "id": "compute.instanceGroupManagers.listManagedInstances",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroupManager"
- // ],
- // "parameters": {
- // "instanceGroupManager": {
- // "description": "The name of the managed instance group.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the managed instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances",
- // "response": {
- // "$ref": "InstanceGroupManagersListManagedInstancesResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroupManagers.recreateInstances":
-
-type InstanceGroupManagersRecreateInstancesCall struct {
- s *Service
- project string
- zone string
- instanceGroupManager string
- instancegroupmanagersrecreateinstancesrequest *InstanceGroupManagersRecreateInstancesRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// RecreateInstances: Schedules a group action to recreate the specified
-// instances in the managed instance group. The instances are deleted
-// and recreated using the current instance template for the managed
-// instance group. This operation is marked as DONE when the action is
-// scheduled even if the instances have not yet been recreated. You must
-// separately verify the status of the recreating action with the
-// listmanagedinstances method.
-func (r *InstanceGroupManagersService) RecreateInstances(project string, zone string, instanceGroupManager string, instancegroupmanagersrecreateinstancesrequest *InstanceGroupManagersRecreateInstancesRequest) *InstanceGroupManagersRecreateInstancesCall {
- c := &InstanceGroupManagersRecreateInstancesCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroupManager = instanceGroupManager
- c.instancegroupmanagersrecreateinstancesrequest = instancegroupmanagersrecreateinstancesrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupManagersRecreateInstancesCall) Fields(s ...googleapi.Field) *InstanceGroupManagersRecreateInstancesCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupManagersRecreateInstancesCall) Context(ctx context.Context) *InstanceGroupManagersRecreateInstancesCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupManagersRecreateInstancesCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancegroupmanagersrecreateinstancesrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroupManager": c.instanceGroupManager,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroupManagers.recreateInstances" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceGroupManagersRecreateInstancesCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.",
- // "httpMethod": "POST",
- // "id": "compute.instanceGroupManagers.recreateInstances",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroupManager"
- // ],
- // "parameters": {
- // "instanceGroupManager": {
- // "description": "The name of the managed instance group.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the managed instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances",
- // "request": {
- // "$ref": "InstanceGroupManagersRecreateInstancesRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroupManagers.resize":
-
-type InstanceGroupManagersResizeCall struct {
- s *Service
- project string
- zone string
- instanceGroupManager string
- size int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Resize: Resizes the managed instance group. If you increase the size,
-// the group creates new instances using the current instance template.
-// If you decrease the size, the group deletes instances. The resize
-// operation is marked DONE when the resize actions are scheduled even
-// if the group has not yet added or deleted any instances. You must
-// separately verify the status of the creating or deleting actions with
-// the listmanagedinstances method.
-func (r *InstanceGroupManagersService) Resize(project string, zone string, instanceGroupManager string, size int64) *InstanceGroupManagersResizeCall {
- c := &InstanceGroupManagersResizeCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroupManager = instanceGroupManager
- c.size = size
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupManagersResizeCall) Fields(s ...googleapi.Field) *InstanceGroupManagersResizeCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupManagersResizeCall) Context(ctx context.Context) *InstanceGroupManagersResizeCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupManagersResizeCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("size", fmt.Sprintf("%v", c.size))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroupManager": c.instanceGroupManager,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroupManagers.resize" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceGroupManagersResizeCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.",
- // "httpMethod": "POST",
- // "id": "compute.instanceGroupManagers.resize",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroupManager",
- // "size"
- // ],
- // "parameters": {
- // "instanceGroupManager": {
- // "description": "The name of the managed instance group.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "size": {
- // "description": "The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter.",
- // "format": "int32",
- // "location": "query",
- // "required": true,
- // "type": "integer"
- // },
- // "zone": {
- // "description": "The name of the zone where the managed instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroupManagers.setAutoHealingPolicies":
-
-type InstanceGroupManagersSetAutoHealingPoliciesCall struct {
- s *Service
- project string
- zone string
- instanceGroupManager string
- instancegroupmanagerssetautohealingrequest *InstanceGroupManagersSetAutoHealingRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetAutoHealingPolicies: Modifies the autohealing policy.
-func (r *InstanceGroupManagersService) SetAutoHealingPolicies(project string, zone string, instanceGroupManager string, instancegroupmanagerssetautohealingrequest *InstanceGroupManagersSetAutoHealingRequest) *InstanceGroupManagersSetAutoHealingPoliciesCall {
- c := &InstanceGroupManagersSetAutoHealingPoliciesCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroupManager = instanceGroupManager
- c.instancegroupmanagerssetautohealingrequest = instancegroupmanagerssetautohealingrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupManagersSetAutoHealingPoliciesCall) Fields(s ...googleapi.Field) *InstanceGroupManagersSetAutoHealingPoliciesCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupManagersSetAutoHealingPoliciesCall) Context(ctx context.Context) *InstanceGroupManagersSetAutoHealingPoliciesCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupManagersSetAutoHealingPoliciesCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancegroupmanagerssetautohealingrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setAutoHealingPolicies")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroupManager": c.instanceGroupManager,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroupManagers.setAutoHealingPolicies" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceGroupManagersSetAutoHealingPoliciesCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Modifies the autohealing policy.",
- // "httpMethod": "POST",
- // "id": "compute.instanceGroupManagers.setAutoHealingPolicies",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroupManager"
- // ],
- // "parameters": {
- // "instanceGroupManager": {
- // "description": "The name of the instance group manager.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The URL of the zone where the managed instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setAutoHealingPolicies",
- // "request": {
- // "$ref": "InstanceGroupManagersSetAutoHealingRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroupManagers.setInstanceTemplate":
-
-type InstanceGroupManagersSetInstanceTemplateCall struct {
- s *Service
- project string
- zone string
- instanceGroupManager string
- instancegroupmanagerssetinstancetemplaterequest *InstanceGroupManagersSetInstanceTemplateRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetInstanceTemplate: Specifies the instance template to use when
-// creating new instances in this group. The templates for existing
-// instances in the group do not change unless you recreate them.
-func (r *InstanceGroupManagersService) SetInstanceTemplate(project string, zone string, instanceGroupManager string, instancegroupmanagerssetinstancetemplaterequest *InstanceGroupManagersSetInstanceTemplateRequest) *InstanceGroupManagersSetInstanceTemplateCall {
- c := &InstanceGroupManagersSetInstanceTemplateCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroupManager = instanceGroupManager
- c.instancegroupmanagerssetinstancetemplaterequest = instancegroupmanagerssetinstancetemplaterequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupManagersSetInstanceTemplateCall) Fields(s ...googleapi.Field) *InstanceGroupManagersSetInstanceTemplateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupManagersSetInstanceTemplateCall) Context(ctx context.Context) *InstanceGroupManagersSetInstanceTemplateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupManagersSetInstanceTemplateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancegroupmanagerssetinstancetemplaterequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroupManager": c.instanceGroupManager,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroupManagers.setInstanceTemplate" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceGroupManagersSetInstanceTemplateCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.",
- // "httpMethod": "POST",
- // "id": "compute.instanceGroupManagers.setInstanceTemplate",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroupManager"
- // ],
- // "parameters": {
- // "instanceGroupManager": {
- // "description": "The name of the managed instance group.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the managed instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate",
- // "request": {
- // "$ref": "InstanceGroupManagersSetInstanceTemplateRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroupManagers.setTargetPools":
-
-type InstanceGroupManagersSetTargetPoolsCall struct {
- s *Service
- project string
- zone string
- instanceGroupManager string
- instancegroupmanagerssettargetpoolsrequest *InstanceGroupManagersSetTargetPoolsRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetTargetPools: Modifies the target pools to which all instances in
-// this managed instance group are assigned. The target pools
-// automatically apply to all of the instances in the managed instance
-// group. This operation is marked DONE when you make the request even
-// if the instances have not yet been added to their target pools. The
-// change might take some time to apply to all of the instances in the
-// group depending on the size of the group.
-func (r *InstanceGroupManagersService) SetTargetPools(project string, zone string, instanceGroupManager string, instancegroupmanagerssettargetpoolsrequest *InstanceGroupManagersSetTargetPoolsRequest) *InstanceGroupManagersSetTargetPoolsCall {
- c := &InstanceGroupManagersSetTargetPoolsCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroupManager = instanceGroupManager
- c.instancegroupmanagerssettargetpoolsrequest = instancegroupmanagerssettargetpoolsrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupManagersSetTargetPoolsCall) Fields(s ...googleapi.Field) *InstanceGroupManagersSetTargetPoolsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupManagersSetTargetPoolsCall) Context(ctx context.Context) *InstanceGroupManagersSetTargetPoolsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupManagersSetTargetPoolsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancegroupmanagerssettargetpoolsrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroupManager": c.instanceGroupManager,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroupManagers.setTargetPools" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceGroupManagersSetTargetPoolsCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.",
- // "httpMethod": "POST",
- // "id": "compute.instanceGroupManagers.setTargetPools",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroupManager"
- // ],
- // "parameters": {
- // "instanceGroupManager": {
- // "description": "The name of the managed instance group.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the managed instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools",
- // "request": {
- // "$ref": "InstanceGroupManagersSetTargetPoolsRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroups.addInstances":
-
-type InstanceGroupsAddInstancesCall struct {
- s *Service
- project string
- zone string
- instanceGroup string
- instancegroupsaddinstancesrequest *InstanceGroupsAddInstancesRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AddInstances: Adds a list of instances to the specified instance
-// group. All of the instances in the instance group must be in the same
-// network/subnetwork. TODO: Change to comment to state "if IG is load
-// balanced."
-func (r *InstanceGroupsService) AddInstances(project string, zone string, instanceGroup string, instancegroupsaddinstancesrequest *InstanceGroupsAddInstancesRequest) *InstanceGroupsAddInstancesCall {
- c := &InstanceGroupsAddInstancesCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroup = instanceGroup
- c.instancegroupsaddinstancesrequest = instancegroupsaddinstancesrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupsAddInstancesCall) Fields(s ...googleapi.Field) *InstanceGroupsAddInstancesCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupsAddInstancesCall) Context(ctx context.Context) *InstanceGroupsAddInstancesCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupsAddInstancesCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancegroupsaddinstancesrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroup": c.instanceGroup,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroups.addInstances" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceGroupsAddInstancesCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. TODO: Change to comment to state \"if IG is load balanced.\"",
- // "httpMethod": "POST",
- // "id": "compute.instanceGroups.addInstances",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroup"
- // ],
- // "parameters": {
- // "instanceGroup": {
- // "description": "The name of the instance group where you are adding instances.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances",
- // "request": {
- // "$ref": "InstanceGroupsAddInstancesRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroups.aggregatedList":
-
-type InstanceGroupsAggregatedListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AggregatedList: Retrieves the list of instance groups and sorts them
-// by zone.
-func (r *InstanceGroupsService) AggregatedList(project string) *InstanceGroupsAggregatedListCall {
- c := &InstanceGroupsAggregatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *InstanceGroupsAggregatedListCall) Filter(filter string) *InstanceGroupsAggregatedListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *InstanceGroupsAggregatedListCall) MaxResults(maxResults int64) *InstanceGroupsAggregatedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *InstanceGroupsAggregatedListCall) OrderBy(orderBy string) *InstanceGroupsAggregatedListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *InstanceGroupsAggregatedListCall) PageToken(pageToken string) *InstanceGroupsAggregatedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupsAggregatedListCall) Fields(s ...googleapi.Field) *InstanceGroupsAggregatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InstanceGroupsAggregatedListCall) IfNoneMatch(entityTag string) *InstanceGroupsAggregatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupsAggregatedListCall) Context(ctx context.Context) *InstanceGroupsAggregatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupsAggregatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/aggregated/instanceGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroups.aggregatedList" call.
-// Exactly one of *InstanceGroupAggregatedList or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *InstanceGroupAggregatedList.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InstanceGroupsAggregatedListCall) Do() (*InstanceGroupAggregatedList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InstanceGroupAggregatedList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of instance groups and sorts them by zone.",
- // "httpMethod": "GET",
- // "id": "compute.instanceGroups.aggregatedList",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/aggregated/instanceGroups",
- // "response": {
- // "$ref": "InstanceGroupAggregatedList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroups.delete":
-
-type InstanceGroupsDeleteCall struct {
- s *Service
- project string
- zone string
- instanceGroup string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified instance group. The instances in the
-// group are not deleted.
-func (r *InstanceGroupsService) Delete(project string, zone string, instanceGroup string) *InstanceGroupsDeleteCall {
- c := &InstanceGroupsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroup = instanceGroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupsDeleteCall) Fields(s ...googleapi.Field) *InstanceGroupsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupsDeleteCall) Context(ctx context.Context) *InstanceGroupsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroups/{instanceGroup}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroup": c.instanceGroup,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroups.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceGroupsDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified instance group. The instances in the group are not deleted.",
- // "httpMethod": "DELETE",
- // "id": "compute.instanceGroups.delete",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroup"
- // ],
- // "parameters": {
- // "instanceGroup": {
- // "description": "The name of the instance group to delete.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroups.get":
-
-type InstanceGroupsGetCall struct {
- s *Service
- project string
- zone string
- instanceGroup string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified instance group resource.
-func (r *InstanceGroupsService) Get(project string, zone string, instanceGroup string) *InstanceGroupsGetCall {
- c := &InstanceGroupsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroup = instanceGroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupsGetCall) Fields(s ...googleapi.Field) *InstanceGroupsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InstanceGroupsGetCall) IfNoneMatch(entityTag string) *InstanceGroupsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupsGetCall) Context(ctx context.Context) *InstanceGroupsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroups/{instanceGroup}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroup": c.instanceGroup,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroups.get" call.
-// Exactly one of *InstanceGroup or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *InstanceGroup.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InstanceGroupsGetCall) Do() (*InstanceGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InstanceGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified instance group resource.",
- // "httpMethod": "GET",
- // "id": "compute.instanceGroups.get",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroup"
- // ],
- // "parameters": {
- // "instanceGroup": {
- // "description": "The name of the instance group.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}",
- // "response": {
- // "$ref": "InstanceGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroups.insert":
-
-type InstanceGroupsInsertCall struct {
- s *Service
- project string
- zone string
- instancegroup *InstanceGroup
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates an instance group in the specified project using the
-// parameters that are included in the request.
-func (r *InstanceGroupsService) Insert(project string, zone string, instancegroup *InstanceGroup) *InstanceGroupsInsertCall {
- c := &InstanceGroupsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instancegroup = instancegroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupsInsertCall) Fields(s ...googleapi.Field) *InstanceGroupsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupsInsertCall) Context(ctx context.Context) *InstanceGroupsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancegroup)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroups.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceGroupsInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates an instance group in the specified project using the parameters that are included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.instanceGroups.insert",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where you want to create the instance group.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroups",
- // "request": {
- // "$ref": "InstanceGroup"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroups.list":
-
-type InstanceGroupsListCall struct {
- s *Service
- project string
- zone string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of instance groups that are located in the
-// specified project and zone.
-func (r *InstanceGroupsService) List(project string, zone string) *InstanceGroupsListCall {
- c := &InstanceGroupsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *InstanceGroupsListCall) Filter(filter string) *InstanceGroupsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *InstanceGroupsListCall) MaxResults(maxResults int64) *InstanceGroupsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *InstanceGroupsListCall) OrderBy(orderBy string) *InstanceGroupsListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *InstanceGroupsListCall) PageToken(pageToken string) *InstanceGroupsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupsListCall) Fields(s ...googleapi.Field) *InstanceGroupsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InstanceGroupsListCall) IfNoneMatch(entityTag string) *InstanceGroupsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupsListCall) Context(ctx context.Context) *InstanceGroupsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroups.list" call.
-// Exactly one of *InstanceGroupList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *InstanceGroupList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InstanceGroupsListCall) Do() (*InstanceGroupList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InstanceGroupList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of instance groups that are located in the specified project and zone.",
- // "httpMethod": "GET",
- // "id": "compute.instanceGroups.list",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroups",
- // "response": {
- // "$ref": "InstanceGroupList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroups.listInstances":
-
-type InstanceGroupsListInstancesCall struct {
- s *Service
- project string
- zone string
- instanceGroup string
- instancegroupslistinstancesrequest *InstanceGroupsListInstancesRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// ListInstances: Lists the instances in the specified instance group.
-func (r *InstanceGroupsService) ListInstances(project string, zone string, instanceGroup string, instancegroupslistinstancesrequest *InstanceGroupsListInstancesRequest) *InstanceGroupsListInstancesCall {
- c := &InstanceGroupsListInstancesCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroup = instanceGroup
- c.instancegroupslistinstancesrequest = instancegroupslistinstancesrequest
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *InstanceGroupsListInstancesCall) Filter(filter string) *InstanceGroupsListInstancesCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *InstanceGroupsListInstancesCall) MaxResults(maxResults int64) *InstanceGroupsListInstancesCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *InstanceGroupsListInstancesCall) OrderBy(orderBy string) *InstanceGroupsListInstancesCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *InstanceGroupsListInstancesCall) PageToken(pageToken string) *InstanceGroupsListInstancesCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupsListInstancesCall) Fields(s ...googleapi.Field) *InstanceGroupsListInstancesCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupsListInstancesCall) Context(ctx context.Context) *InstanceGroupsListInstancesCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupsListInstancesCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancegroupslistinstancesrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroup": c.instanceGroup,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroups.listInstances" call.
-// Exactly one of *InstanceGroupsListInstances or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *InstanceGroupsListInstances.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InstanceGroupsListInstancesCall) Do() (*InstanceGroupsListInstances, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InstanceGroupsListInstances{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists the instances in the specified instance group.",
- // "httpMethod": "POST",
- // "id": "compute.instanceGroups.listInstances",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroup"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "instanceGroup": {
- // "description": "The name of the instance group from which you want to generate a list of included instances.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances",
- // "request": {
- // "$ref": "InstanceGroupsListInstancesRequest"
- // },
- // "response": {
- // "$ref": "InstanceGroupsListInstances"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroups.removeInstances":
-
-type InstanceGroupsRemoveInstancesCall struct {
- s *Service
- project string
- zone string
- instanceGroup string
- instancegroupsremoveinstancesrequest *InstanceGroupsRemoveInstancesRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// RemoveInstances: Removes one or more instances from the specified
-// instance group, but does not delete those instances.
-func (r *InstanceGroupsService) RemoveInstances(project string, zone string, instanceGroup string, instancegroupsremoveinstancesrequest *InstanceGroupsRemoveInstancesRequest) *InstanceGroupsRemoveInstancesCall {
- c := &InstanceGroupsRemoveInstancesCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroup = instanceGroup
- c.instancegroupsremoveinstancesrequest = instancegroupsremoveinstancesrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupsRemoveInstancesCall) Fields(s ...googleapi.Field) *InstanceGroupsRemoveInstancesCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupsRemoveInstancesCall) Context(ctx context.Context) *InstanceGroupsRemoveInstancesCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupsRemoveInstancesCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancegroupsremoveinstancesrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroup": c.instanceGroup,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroups.removeInstances" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceGroupsRemoveInstancesCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Removes one or more instances from the specified instance group, but does not delete those instances.",
- // "httpMethod": "POST",
- // "id": "compute.instanceGroups.removeInstances",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroup"
- // ],
- // "parameters": {
- // "instanceGroup": {
- // "description": "The name of the instance group where the specified instances will be removed.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances",
- // "request": {
- // "$ref": "InstanceGroupsRemoveInstancesRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroups.setNamedPorts":
-
-type InstanceGroupsSetNamedPortsCall struct {
- s *Service
- project string
- zone string
- instanceGroup string
- instancegroupssetnamedportsrequest *InstanceGroupsSetNamedPortsRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetNamedPorts: Sets the named ports for the specified instance group.
-func (r *InstanceGroupsService) SetNamedPorts(project string, zone string, instanceGroup string, instancegroupssetnamedportsrequest *InstanceGroupsSetNamedPortsRequest) *InstanceGroupsSetNamedPortsCall {
- c := &InstanceGroupsSetNamedPortsCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroup = instanceGroup
- c.instancegroupssetnamedportsrequest = instancegroupssetnamedportsrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupsSetNamedPortsCall) Fields(s ...googleapi.Field) *InstanceGroupsSetNamedPortsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupsSetNamedPortsCall) Context(ctx context.Context) *InstanceGroupsSetNamedPortsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupsSetNamedPortsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancegroupssetnamedportsrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroup": c.instanceGroup,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroups.setNamedPorts" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceGroupsSetNamedPortsCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sets the named ports for the specified instance group.",
- // "httpMethod": "POST",
- // "id": "compute.instanceGroups.setNamedPorts",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroup"
- // ],
- // "parameters": {
- // "instanceGroup": {
- // "description": "The name of the instance group where the named ports are updated.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts",
- // "request": {
- // "$ref": "InstanceGroupsSetNamedPortsRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceTemplates.delete":
-
-type InstanceTemplatesDeleteCall struct {
- s *Service
- project string
- instanceTemplate string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified instance template.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instanceTemplates/delete
-func (r *InstanceTemplatesService) Delete(project string, instanceTemplate string) *InstanceTemplatesDeleteCall {
- c := &InstanceTemplatesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.instanceTemplate = instanceTemplate
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceTemplatesDeleteCall) Fields(s ...googleapi.Field) *InstanceTemplatesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceTemplatesDeleteCall) Context(ctx context.Context) *InstanceTemplatesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceTemplatesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/instanceTemplates/{instanceTemplate}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "instanceTemplate": c.instanceTemplate,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceTemplates.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceTemplatesDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified instance template.",
- // "httpMethod": "DELETE",
- // "id": "compute.instanceTemplates.delete",
- // "parameterOrder": [
- // "project",
- // "instanceTemplate"
- // ],
- // "parameters": {
- // "instanceTemplate": {
- // "description": "The name of the instance template to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/instanceTemplates/{instanceTemplate}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceTemplates.get":
-
-type InstanceTemplatesGetCall struct {
- s *Service
- project string
- instanceTemplate string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified instance template resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instanceTemplates/get
-func (r *InstanceTemplatesService) Get(project string, instanceTemplate string) *InstanceTemplatesGetCall {
- c := &InstanceTemplatesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.instanceTemplate = instanceTemplate
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceTemplatesGetCall) Fields(s ...googleapi.Field) *InstanceTemplatesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InstanceTemplatesGetCall) IfNoneMatch(entityTag string) *InstanceTemplatesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceTemplatesGetCall) Context(ctx context.Context) *InstanceTemplatesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceTemplatesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/instanceTemplates/{instanceTemplate}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "instanceTemplate": c.instanceTemplate,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceTemplates.get" call.
-// Exactly one of *InstanceTemplate or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *InstanceTemplate.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InstanceTemplatesGetCall) Do() (*InstanceTemplate, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InstanceTemplate{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified instance template resource.",
- // "httpMethod": "GET",
- // "id": "compute.instanceTemplates.get",
- // "parameterOrder": [
- // "project",
- // "instanceTemplate"
- // ],
- // "parameters": {
- // "instanceTemplate": {
- // "description": "The name of the instance template.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/instanceTemplates/{instanceTemplate}",
- // "response": {
- // "$ref": "InstanceTemplate"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instanceTemplates.insert":
-
-type InstanceTemplatesInsertCall struct {
- s *Service
- project string
- instancetemplate *InstanceTemplate
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates an instance template in the specified project using
-// the data that is included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instanceTemplates/insert
-func (r *InstanceTemplatesService) Insert(project string, instancetemplate *InstanceTemplate) *InstanceTemplatesInsertCall {
- c := &InstanceTemplatesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.instancetemplate = instancetemplate
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceTemplatesInsertCall) Fields(s ...googleapi.Field) *InstanceTemplatesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceTemplatesInsertCall) Context(ctx context.Context) *InstanceTemplatesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceTemplatesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancetemplate)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/instanceTemplates")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceTemplates.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceTemplatesInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates an instance template in the specified project using the data that is included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.instanceTemplates.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/instanceTemplates",
- // "request": {
- // "$ref": "InstanceTemplate"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceTemplates.list":
-
-type InstanceTemplatesListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of instance templates that are contained
-// within the specified project and zone.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instanceTemplates/list
-func (r *InstanceTemplatesService) List(project string) *InstanceTemplatesListCall {
- c := &InstanceTemplatesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *InstanceTemplatesListCall) Filter(filter string) *InstanceTemplatesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *InstanceTemplatesListCall) MaxResults(maxResults int64) *InstanceTemplatesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *InstanceTemplatesListCall) OrderBy(orderBy string) *InstanceTemplatesListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *InstanceTemplatesListCall) PageToken(pageToken string) *InstanceTemplatesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceTemplatesListCall) Fields(s ...googleapi.Field) *InstanceTemplatesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InstanceTemplatesListCall) IfNoneMatch(entityTag string) *InstanceTemplatesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceTemplatesListCall) Context(ctx context.Context) *InstanceTemplatesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceTemplatesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/instanceTemplates")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceTemplates.list" call.
-// Exactly one of *InstanceTemplateList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *InstanceTemplateList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InstanceTemplatesListCall) Do() (*InstanceTemplateList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InstanceTemplateList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of instance templates that are contained within the specified project and zone.",
- // "httpMethod": "GET",
- // "id": "compute.instanceTemplates.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/instanceTemplates",
- // "response": {
- // "$ref": "InstanceTemplateList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instances.addAccessConfig":
-
-type InstancesAddAccessConfigCall struct {
- s *Service
- project string
- zone string
- instance string
- networkInterface string
- accessconfig *AccessConfig
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AddAccessConfig: Adds an access config to an instance's network
-// interface.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/addAccessConfig
-func (r *InstancesService) AddAccessConfig(project string, zone string, instance string, networkInterface string, accessconfig *AccessConfig) *InstancesAddAccessConfigCall {
- c := &InstancesAddAccessConfigCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- c.networkInterface = networkInterface
- c.accessconfig = accessconfig
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesAddAccessConfigCall) Fields(s ...googleapi.Field) *InstancesAddAccessConfigCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesAddAccessConfigCall) Context(ctx context.Context) *InstancesAddAccessConfigCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesAddAccessConfigCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.accessconfig)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("networkInterface", fmt.Sprintf("%v", c.networkInterface))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}/addAccessConfig")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.addAccessConfig" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesAddAccessConfigCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Adds an access config to an instance's network interface.",
- // "httpMethod": "POST",
- // "id": "compute.instances.addAccessConfig",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance",
- // "networkInterface"
- // ],
- // "parameters": {
- // "instance": {
- // "description": "The instance name for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "networkInterface": {
- // "description": "The name of the network interface to add to this instance.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}/addAccessConfig",
- // "request": {
- // "$ref": "AccessConfig"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instances.aggregatedList":
-
-type InstancesAggregatedListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AggregatedList: Retrieves aggregated list of instance resources.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/aggregatedList
-func (r *InstancesService) AggregatedList(project string) *InstancesAggregatedListCall {
- c := &InstancesAggregatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *InstancesAggregatedListCall) Filter(filter string) *InstancesAggregatedListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *InstancesAggregatedListCall) MaxResults(maxResults int64) *InstancesAggregatedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *InstancesAggregatedListCall) OrderBy(orderBy string) *InstancesAggregatedListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *InstancesAggregatedListCall) PageToken(pageToken string) *InstancesAggregatedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesAggregatedListCall) Fields(s ...googleapi.Field) *InstancesAggregatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InstancesAggregatedListCall) IfNoneMatch(entityTag string) *InstancesAggregatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesAggregatedListCall) Context(ctx context.Context) *InstancesAggregatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesAggregatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/aggregated/instances")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.aggregatedList" call.
-// Exactly one of *InstanceAggregatedList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *InstanceAggregatedList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InstancesAggregatedListCall) Do() (*InstanceAggregatedList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InstanceAggregatedList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves aggregated list of instance resources.",
- // "httpMethod": "GET",
- // "id": "compute.instances.aggregatedList",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/aggregated/instances",
- // "response": {
- // "$ref": "InstanceAggregatedList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instances.attachDisk":
-
-type InstancesAttachDiskCall struct {
- s *Service
- project string
- zone string
- instance string
- attacheddisk *AttachedDisk
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AttachDisk: Attaches a Disk resource to an instance.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/attachDisk
-func (r *InstancesService) AttachDisk(project string, zone string, instance string, attacheddisk *AttachedDisk) *InstancesAttachDiskCall {
- c := &InstancesAttachDiskCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- c.attacheddisk = attacheddisk
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesAttachDiskCall) Fields(s ...googleapi.Field) *InstancesAttachDiskCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesAttachDiskCall) Context(ctx context.Context) *InstancesAttachDiskCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesAttachDiskCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.attacheddisk)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}/attachDisk")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.attachDisk" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesAttachDiskCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Attaches a Disk resource to an instance.",
- // "httpMethod": "POST",
- // "id": "compute.instances.attachDisk",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance"
- // ],
- // "parameters": {
- // "instance": {
- // "description": "Instance name.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}/attachDisk",
- // "request": {
- // "$ref": "AttachedDisk"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instances.delete":
-
-type InstancesDeleteCall struct {
- s *Service
- project string
- zone string
- instance string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified Instance resource. For more
-// information, see Shutting down an instance.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/delete
-func (r *InstancesService) Delete(project string, zone string, instance string) *InstancesDeleteCall {
- c := &InstancesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesDeleteCall) Fields(s ...googleapi.Field) *InstancesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesDeleteCall) Context(ctx context.Context) *InstancesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified Instance resource. For more information, see Shutting down an instance.",
- // "httpMethod": "DELETE",
- // "id": "compute.instances.delete",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance"
- // ],
- // "parameters": {
- // "instance": {
- // "description": "Name of the instance resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instances.deleteAccessConfig":
-
-type InstancesDeleteAccessConfigCall struct {
- s *Service
- project string
- zone string
- instance string
- accessConfig string
- networkInterface string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// DeleteAccessConfig: Deletes an access config from an instance's
-// network interface.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/deleteAccessConfig
-func (r *InstancesService) DeleteAccessConfig(project string, zone string, instance string, accessConfig string, networkInterface string) *InstancesDeleteAccessConfigCall {
- c := &InstancesDeleteAccessConfigCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- c.accessConfig = accessConfig
- c.networkInterface = networkInterface
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesDeleteAccessConfigCall) Fields(s ...googleapi.Field) *InstancesDeleteAccessConfigCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesDeleteAccessConfigCall) Context(ctx context.Context) *InstancesDeleteAccessConfigCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesDeleteAccessConfigCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("accessConfig", fmt.Sprintf("%v", c.accessConfig))
- params.Set("networkInterface", fmt.Sprintf("%v", c.networkInterface))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}/deleteAccessConfig")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.deleteAccessConfig" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesDeleteAccessConfigCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes an access config from an instance's network interface.",
- // "httpMethod": "POST",
- // "id": "compute.instances.deleteAccessConfig",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance",
- // "accessConfig",
- // "networkInterface"
- // ],
- // "parameters": {
- // "accessConfig": {
- // "description": "The name of the access config to delete.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "instance": {
- // "description": "The instance name for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "networkInterface": {
- // "description": "The name of the network interface.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}/deleteAccessConfig",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instances.detachDisk":
-
-type InstancesDetachDiskCall struct {
- s *Service
- project string
- zone string
- instance string
- deviceName string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// DetachDisk: Detaches a disk from an instance.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/detachDisk
-func (r *InstancesService) DetachDisk(project string, zone string, instance string, deviceName string) *InstancesDetachDiskCall {
- c := &InstancesDetachDiskCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- c.deviceName = deviceName
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesDetachDiskCall) Fields(s ...googleapi.Field) *InstancesDetachDiskCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesDetachDiskCall) Context(ctx context.Context) *InstancesDetachDiskCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesDetachDiskCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("deviceName", fmt.Sprintf("%v", c.deviceName))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}/detachDisk")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.detachDisk" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesDetachDiskCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Detaches a disk from an instance.",
- // "httpMethod": "POST",
- // "id": "compute.instances.detachDisk",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance",
- // "deviceName"
- // ],
- // "parameters": {
- // "deviceName": {
- // "description": "Disk device name to detach.",
- // "location": "query",
- // "pattern": "\\w[\\w.-]{0,254}",
- // "required": true,
- // "type": "string"
- // },
- // "instance": {
- // "description": "Instance name.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}/detachDisk",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instances.get":
-
-type InstancesGetCall struct {
- s *Service
- project string
- zone string
- instance string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified instance resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/get
-func (r *InstancesService) Get(project string, zone string, instance string) *InstancesGetCall {
- c := &InstancesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesGetCall) Fields(s ...googleapi.Field) *InstancesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InstancesGetCall) IfNoneMatch(entityTag string) *InstancesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesGetCall) Context(ctx context.Context) *InstancesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.get" call.
-// Exactly one of *Instance or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Instance.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesGetCall) Do() (*Instance, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Instance{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified instance resource.",
- // "httpMethod": "GET",
- // "id": "compute.instances.get",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance"
- // ],
- // "parameters": {
- // "instance": {
- // "description": "Name of the instance resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}",
- // "response": {
- // "$ref": "Instance"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instances.getSerialPortOutput":
-
-type InstancesGetSerialPortOutputCall struct {
- s *Service
- project string
- zone string
- instance string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetSerialPortOutput: Returns the specified instance's serial port
-// output.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/getSerialPortOutput
-func (r *InstancesService) GetSerialPortOutput(project string, zone string, instance string) *InstancesGetSerialPortOutputCall {
- c := &InstancesGetSerialPortOutputCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- return c
-}
-
-// Port sets the optional parameter "port": Specifies which COM or
-// serial port to retrieve data from.
-func (c *InstancesGetSerialPortOutputCall) Port(port int64) *InstancesGetSerialPortOutputCall {
- c.opt_["port"] = port
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesGetSerialPortOutputCall) Fields(s ...googleapi.Field) *InstancesGetSerialPortOutputCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InstancesGetSerialPortOutputCall) IfNoneMatch(entityTag string) *InstancesGetSerialPortOutputCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesGetSerialPortOutputCall) Context(ctx context.Context) *InstancesGetSerialPortOutputCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesGetSerialPortOutputCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["port"]; ok {
- params.Set("port", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}/serialPort")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.getSerialPortOutput" call.
-// Exactly one of *SerialPortOutput or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *SerialPortOutput.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InstancesGetSerialPortOutputCall) Do() (*SerialPortOutput, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SerialPortOutput{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified instance's serial port output.",
- // "httpMethod": "GET",
- // "id": "compute.instances.getSerialPortOutput",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance"
- // ],
- // "parameters": {
- // "instance": {
- // "description": "Name of the instance scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "port": {
- // "default": "1",
- // "description": "Specifies which COM or serial port to retrieve data from.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "4",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}/serialPort",
- // "response": {
- // "$ref": "SerialPortOutput"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instances.insert":
-
-type InstancesInsertCall struct {
- s *Service
- project string
- zone string
- instance *Instance
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates an instance resource in the specified project using
-// the data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/insert
-func (r *InstancesService) Insert(project string, zone string, instance *Instance) *InstancesInsertCall {
- c := &InstancesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesInsertCall) Fields(s ...googleapi.Field) *InstancesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesInsertCall) Context(ctx context.Context) *InstancesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instance)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates an instance resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.instances.insert",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances",
- // "request": {
- // "$ref": "Instance"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instances.list":
-
-type InstancesListCall struct {
- s *Service
- project string
- zone string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of instance resources contained within the
-// specified zone.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/list
-func (r *InstancesService) List(project string, zone string) *InstancesListCall {
- c := &InstancesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *InstancesListCall) Filter(filter string) *InstancesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *InstancesListCall) MaxResults(maxResults int64) *InstancesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *InstancesListCall) OrderBy(orderBy string) *InstancesListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *InstancesListCall) PageToken(pageToken string) *InstancesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesListCall) Fields(s ...googleapi.Field) *InstancesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InstancesListCall) IfNoneMatch(entityTag string) *InstancesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesListCall) Context(ctx context.Context) *InstancesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.list" call.
-// Exactly one of *InstanceList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *InstanceList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesListCall) Do() (*InstanceList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InstanceList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of instance resources contained within the specified zone.",
- // "httpMethod": "GET",
- // "id": "compute.instances.list",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances",
- // "response": {
- // "$ref": "InstanceList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instances.reset":
-
-type InstancesResetCall struct {
- s *Service
- project string
- zone string
- instance string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Reset: Performs a hard reset on the instance.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/reset
-func (r *InstancesService) Reset(project string, zone string, instance string) *InstancesResetCall {
- c := &InstancesResetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesResetCall) Fields(s ...googleapi.Field) *InstancesResetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesResetCall) Context(ctx context.Context) *InstancesResetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesResetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}/reset")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.reset" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesResetCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Performs a hard reset on the instance.",
- // "httpMethod": "POST",
- // "id": "compute.instances.reset",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance"
- // ],
- // "parameters": {
- // "instance": {
- // "description": "Name of the instance scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}/reset",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instances.setDiskAutoDelete":
-
-type InstancesSetDiskAutoDeleteCall struct {
- s *Service
- project string
- zone string
- instance string
- autoDelete bool
- deviceName string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetDiskAutoDelete: Sets the auto-delete flag for a disk attached to
-// an instance.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/setDiskAutoDelete
-func (r *InstancesService) SetDiskAutoDelete(project string, zone string, instance string, autoDelete bool, deviceName string) *InstancesSetDiskAutoDeleteCall {
- c := &InstancesSetDiskAutoDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- c.autoDelete = autoDelete
- c.deviceName = deviceName
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesSetDiskAutoDeleteCall) Fields(s ...googleapi.Field) *InstancesSetDiskAutoDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesSetDiskAutoDeleteCall) Context(ctx context.Context) *InstancesSetDiskAutoDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesSetDiskAutoDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("autoDelete", fmt.Sprintf("%v", c.autoDelete))
- params.Set("deviceName", fmt.Sprintf("%v", c.deviceName))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.setDiskAutoDelete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesSetDiskAutoDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sets the auto-delete flag for a disk attached to an instance.",
- // "httpMethod": "POST",
- // "id": "compute.instances.setDiskAutoDelete",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance",
- // "autoDelete",
- // "deviceName"
- // ],
- // "parameters": {
- // "autoDelete": {
- // "description": "Whether to auto-delete the disk when the instance is deleted.",
- // "location": "query",
- // "required": true,
- // "type": "boolean"
- // },
- // "deviceName": {
- // "description": "The device name of the disk to modify.",
- // "location": "query",
- // "pattern": "\\w[\\w.-]{0,254}",
- // "required": true,
- // "type": "string"
- // },
- // "instance": {
- // "description": "The instance name.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instances.setLabels":
-
-type InstancesSetLabelsCall struct {
- s *Service
- project string
- zone string
- instance string
- instancessetlabelsrequest *InstancesSetLabelsRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetLabels: Sets labels for the specified instance to the data
-// included in the request.
-func (r *InstancesService) SetLabels(project string, zone string, instance string, instancessetlabelsrequest *InstancesSetLabelsRequest) *InstancesSetLabelsCall {
- c := &InstancesSetLabelsCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- c.instancessetlabelsrequest = instancessetlabelsrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesSetLabelsCall) Fields(s ...googleapi.Field) *InstancesSetLabelsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesSetLabelsCall) Context(ctx context.Context) *InstancesSetLabelsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesSetLabelsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancessetlabelsrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}/setLabels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.setLabels" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesSetLabelsCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sets labels for the specified instance to the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.instances.setLabels",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance"
- // ],
- // "parameters": {
- // "instance": {
- // "description": "Name of the instance scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}/setLabels",
- // "request": {
- // "$ref": "InstancesSetLabelsRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instances.setMachineType":
-
-type InstancesSetMachineTypeCall struct {
- s *Service
- project string
- zone string
- instance string
- instancessetmachinetyperequest *InstancesSetMachineTypeRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetMachineType: Sets machine type for the specified instances to the
-// data included in the request.
-func (r *InstancesService) SetMachineType(project string, zone string, instance string, instancessetmachinetyperequest *InstancesSetMachineTypeRequest) *InstancesSetMachineTypeCall {
- c := &InstancesSetMachineTypeCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- c.instancessetmachinetyperequest = instancessetmachinetyperequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesSetMachineTypeCall) Fields(s ...googleapi.Field) *InstancesSetMachineTypeCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesSetMachineTypeCall) Context(ctx context.Context) *InstancesSetMachineTypeCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesSetMachineTypeCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancessetmachinetyperequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}/setMachineType")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.setMachineType" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesSetMachineTypeCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sets machine type for the specified instances to the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.instances.setMachineType",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance"
- // ],
- // "parameters": {
- // "instance": {
- // "description": "Name of the instance scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}/setMachineType",
- // "request": {
- // "$ref": "InstancesSetMachineTypeRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instances.setMetadata":
-
-type InstancesSetMetadataCall struct {
- s *Service
- project string
- zone string
- instance string
- metadata *Metadata
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetMetadata: Sets metadata for the specified instance to the data
-// included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/setMetadata
-func (r *InstancesService) SetMetadata(project string, zone string, instance string, metadata *Metadata) *InstancesSetMetadataCall {
- c := &InstancesSetMetadataCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- c.metadata = metadata
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesSetMetadataCall) Fields(s ...googleapi.Field) *InstancesSetMetadataCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesSetMetadataCall) Context(ctx context.Context) *InstancesSetMetadataCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesSetMetadataCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.metadata)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}/setMetadata")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.setMetadata" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesSetMetadataCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sets metadata for the specified instance to the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.instances.setMetadata",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance"
- // ],
- // "parameters": {
- // "instance": {
- // "description": "Name of the instance scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}/setMetadata",
- // "request": {
- // "$ref": "Metadata"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instances.setScheduling":
-
-type InstancesSetSchedulingCall struct {
- s *Service
- project string
- zone string
- instance string
- scheduling *Scheduling
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetScheduling: Sets an instance's scheduling options.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/setScheduling
-func (r *InstancesService) SetScheduling(project string, zone string, instance string, scheduling *Scheduling) *InstancesSetSchedulingCall {
- c := &InstancesSetSchedulingCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- c.scheduling = scheduling
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesSetSchedulingCall) Fields(s ...googleapi.Field) *InstancesSetSchedulingCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesSetSchedulingCall) Context(ctx context.Context) *InstancesSetSchedulingCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesSetSchedulingCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.scheduling)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}/setScheduling")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.setScheduling" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesSetSchedulingCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sets an instance's scheduling options.",
- // "httpMethod": "POST",
- // "id": "compute.instances.setScheduling",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance"
- // ],
- // "parameters": {
- // "instance": {
- // "description": "Instance name.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}/setScheduling",
- // "request": {
- // "$ref": "Scheduling"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instances.setTags":
-
-type InstancesSetTagsCall struct {
- s *Service
- project string
- zone string
- instance string
- tags *Tags
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetTags: Sets tags for the specified instance to the data included in
-// the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/setTags
-func (r *InstancesService) SetTags(project string, zone string, instance string, tags *Tags) *InstancesSetTagsCall {
- c := &InstancesSetTagsCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- c.tags = tags
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesSetTagsCall) Fields(s ...googleapi.Field) *InstancesSetTagsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesSetTagsCall) Context(ctx context.Context) *InstancesSetTagsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesSetTagsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.tags)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}/setTags")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.setTags" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesSetTagsCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sets tags for the specified instance to the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.instances.setTags",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance"
- // ],
- // "parameters": {
- // "instance": {
- // "description": "Name of the instance scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}/setTags",
- // "request": {
- // "$ref": "Tags"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instances.start":
-
-type InstancesStartCall struct {
- s *Service
- project string
- zone string
- instance string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Start: This method starts an instance that was stopped using the
-// using the instances().stop method. For more information, see Restart
-// an instance.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/start
-func (r *InstancesService) Start(project string, zone string, instance string) *InstancesStartCall {
- c := &InstancesStartCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesStartCall) Fields(s ...googleapi.Field) *InstancesStartCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesStartCall) Context(ctx context.Context) *InstancesStartCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesStartCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}/start")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.start" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesStartCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "This method starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.",
- // "httpMethod": "POST",
- // "id": "compute.instances.start",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance"
- // ],
- // "parameters": {
- // "instance": {
- // "description": "Name of the instance resource to start.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}/start",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instances.stop":
-
-type InstancesStopCall struct {
- s *Service
- project string
- zone string
- instance string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Stop: This method stops a running instance, shutting it down cleanly,
-// and allows you to restart the instance at a later time. Stopped
-// instances do not incur per-minute, virtual machine usage charges
-// while they are stopped, but any resources that the virtual machine is
-// using, such as persistent disks and static IP addresses,will continue
-// to be charged until they are deleted. For more information, see
-// Stopping an instance.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/stop
-func (r *InstancesService) Stop(project string, zone string, instance string) *InstancesStopCall {
- c := &InstancesStopCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesStopCall) Fields(s ...googleapi.Field) *InstancesStopCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesStopCall) Context(ctx context.Context) *InstancesStopCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesStopCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}/stop")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.stop" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesStopCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "This method stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses,will continue to be charged until they are deleted. For more information, see Stopping an instance.",
- // "httpMethod": "POST",
- // "id": "compute.instances.stop",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance"
- // ],
- // "parameters": {
- // "instance": {
- // "description": "Name of the instance resource to stop.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}/stop",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.licenses.get":
-
-type LicensesGetCall struct {
- s *Service
- project string
- license string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified license resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/licenses/get
-func (r *LicensesService) Get(project string, license string) *LicensesGetCall {
- c := &LicensesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.license = license
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LicensesGetCall) Fields(s ...googleapi.Field) *LicensesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *LicensesGetCall) IfNoneMatch(entityTag string) *LicensesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LicensesGetCall) Context(ctx context.Context) *LicensesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LicensesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/licenses/{license}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "license": c.license,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.licenses.get" call.
-// Exactly one of *License or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *License.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *LicensesGetCall) Do() (*License, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &License{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified license resource.",
- // "httpMethod": "GET",
- // "id": "compute.licenses.get",
- // "parameterOrder": [
- // "project",
- // "license"
- // ],
- // "parameters": {
- // "license": {
- // "description": "Name of the license resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/licenses/{license}",
- // "response": {
- // "$ref": "License"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.machineTypes.aggregatedList":
-
-type MachineTypesAggregatedListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AggregatedList: Retrieves the list of machine type resources grouped
-// by scope.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/machineTypes/aggregatedList
-func (r *MachineTypesService) AggregatedList(project string) *MachineTypesAggregatedListCall {
- c := &MachineTypesAggregatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *MachineTypesAggregatedListCall) Filter(filter string) *MachineTypesAggregatedListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *MachineTypesAggregatedListCall) MaxResults(maxResults int64) *MachineTypesAggregatedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *MachineTypesAggregatedListCall) OrderBy(orderBy string) *MachineTypesAggregatedListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *MachineTypesAggregatedListCall) PageToken(pageToken string) *MachineTypesAggregatedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MachineTypesAggregatedListCall) Fields(s ...googleapi.Field) *MachineTypesAggregatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MachineTypesAggregatedListCall) IfNoneMatch(entityTag string) *MachineTypesAggregatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MachineTypesAggregatedListCall) Context(ctx context.Context) *MachineTypesAggregatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MachineTypesAggregatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/aggregated/machineTypes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.machineTypes.aggregatedList" call.
-// Exactly one of *MachineTypeAggregatedList or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *MachineTypeAggregatedList.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MachineTypesAggregatedListCall) Do() (*MachineTypeAggregatedList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &MachineTypeAggregatedList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of machine type resources grouped by scope.",
- // "httpMethod": "GET",
- // "id": "compute.machineTypes.aggregatedList",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/aggregated/machineTypes",
- // "response": {
- // "$ref": "MachineTypeAggregatedList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.machineTypes.get":
-
-type MachineTypesGetCall struct {
- s *Service
- project string
- zone string
- machineType string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified machine type resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/machineTypes/get
-func (r *MachineTypesService) Get(project string, zone string, machineType string) *MachineTypesGetCall {
- c := &MachineTypesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.machineType = machineType
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MachineTypesGetCall) Fields(s ...googleapi.Field) *MachineTypesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MachineTypesGetCall) IfNoneMatch(entityTag string) *MachineTypesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MachineTypesGetCall) Context(ctx context.Context) *MachineTypesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MachineTypesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/machineTypes/{machineType}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "machineType": c.machineType,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.machineTypes.get" call.
-// Exactly one of *MachineType or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *MachineType.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *MachineTypesGetCall) Do() (*MachineType, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &MachineType{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified machine type resource.",
- // "httpMethod": "GET",
- // "id": "compute.machineTypes.get",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "machineType"
- // ],
- // "parameters": {
- // "machineType": {
- // "description": "Name of the machine type resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/machineTypes/{machineType}",
- // "response": {
- // "$ref": "MachineType"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.machineTypes.list":
-
-type MachineTypesListCall struct {
- s *Service
- project string
- zone string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of machine type resources available to the
-// specified project.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/machineTypes/list
-func (r *MachineTypesService) List(project string, zone string) *MachineTypesListCall {
- c := &MachineTypesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *MachineTypesListCall) Filter(filter string) *MachineTypesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *MachineTypesListCall) MaxResults(maxResults int64) *MachineTypesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *MachineTypesListCall) OrderBy(orderBy string) *MachineTypesListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *MachineTypesListCall) PageToken(pageToken string) *MachineTypesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MachineTypesListCall) Fields(s ...googleapi.Field) *MachineTypesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MachineTypesListCall) IfNoneMatch(entityTag string) *MachineTypesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MachineTypesListCall) Context(ctx context.Context) *MachineTypesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MachineTypesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/machineTypes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.machineTypes.list" call.
-// Exactly one of *MachineTypeList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *MachineTypeList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MachineTypesListCall) Do() (*MachineTypeList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &MachineTypeList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of machine type resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.machineTypes.list",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/machineTypes",
- // "response": {
- // "$ref": "MachineTypeList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.networks.delete":
-
-type NetworksDeleteCall struct {
- s *Service
- project string
- network string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified network resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/networks/delete
-func (r *NetworksService) Delete(project string, network string) *NetworksDeleteCall {
- c := &NetworksDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.network = network
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *NetworksDeleteCall) Fields(s ...googleapi.Field) *NetworksDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *NetworksDeleteCall) Context(ctx context.Context) *NetworksDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *NetworksDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/networks/{network}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "network": c.network,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.networks.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *NetworksDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified network resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.networks.delete",
- // "parameterOrder": [
- // "project",
- // "network"
- // ],
- // "parameters": {
- // "network": {
- // "description": "Name of the network resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/networks/{network}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.networks.get":
-
-type NetworksGetCall struct {
- s *Service
- project string
- network string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified network resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/networks/get
-func (r *NetworksService) Get(project string, network string) *NetworksGetCall {
- c := &NetworksGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.network = network
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *NetworksGetCall) Fields(s ...googleapi.Field) *NetworksGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *NetworksGetCall) IfNoneMatch(entityTag string) *NetworksGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *NetworksGetCall) Context(ctx context.Context) *NetworksGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *NetworksGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/networks/{network}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "network": c.network,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.networks.get" call.
-// Exactly one of *Network or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Network.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *NetworksGetCall) Do() (*Network, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Network{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified network resource.",
- // "httpMethod": "GET",
- // "id": "compute.networks.get",
- // "parameterOrder": [
- // "project",
- // "network"
- // ],
- // "parameters": {
- // "network": {
- // "description": "Name of the network resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/networks/{network}",
- // "response": {
- // "$ref": "Network"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.networks.insert":
-
-type NetworksInsertCall struct {
- s *Service
- project string
- network *Network
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a network resource in the specified project using the
-// data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/networks/insert
-func (r *NetworksService) Insert(project string, network *Network) *NetworksInsertCall {
- c := &NetworksInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.network = network
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *NetworksInsertCall) Fields(s ...googleapi.Field) *NetworksInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *NetworksInsertCall) Context(ctx context.Context) *NetworksInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *NetworksInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.network)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/networks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.networks.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *NetworksInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a network resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.networks.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/networks",
- // "request": {
- // "$ref": "Network"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.networks.list":
-
-type NetworksListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of network resources available to the
-// specified project.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/networks/list
-func (r *NetworksService) List(project string) *NetworksListCall {
- c := &NetworksListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *NetworksListCall) Filter(filter string) *NetworksListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *NetworksListCall) MaxResults(maxResults int64) *NetworksListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *NetworksListCall) OrderBy(orderBy string) *NetworksListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *NetworksListCall) PageToken(pageToken string) *NetworksListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *NetworksListCall) Fields(s ...googleapi.Field) *NetworksListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *NetworksListCall) IfNoneMatch(entityTag string) *NetworksListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *NetworksListCall) Context(ctx context.Context) *NetworksListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *NetworksListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/networks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.networks.list" call.
-// Exactly one of *NetworkList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *NetworkList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *NetworksListCall) Do() (*NetworkList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &NetworkList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of network resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.networks.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/networks",
- // "response": {
- // "$ref": "NetworkList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.projects.get":
-
-type ProjectsGetCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified project resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/projects/get
-func (r *ProjectsService) Get(project string) *ProjectsGetCall {
- c := &ProjectsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsGetCall) Fields(s ...googleapi.Field) *ProjectsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ProjectsGetCall) IfNoneMatch(entityTag string) *ProjectsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsGetCall) Context(ctx context.Context) *ProjectsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.projects.get" call.
-// Exactly one of *Project or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Project.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ProjectsGetCall) Do() (*Project, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Project{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified project resource.",
- // "httpMethod": "GET",
- // "id": "compute.projects.get",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}",
- // "response": {
- // "$ref": "Project"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.projects.setCommonInstanceMetadata":
-
-type ProjectsSetCommonInstanceMetadataCall struct {
- s *Service
- project string
- metadata *Metadata
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetCommonInstanceMetadata: Sets metadata common to all instances
-// within the specified project using the data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/projects/setCommonInstanceMetadata
-func (r *ProjectsService) SetCommonInstanceMetadata(project string, metadata *Metadata) *ProjectsSetCommonInstanceMetadataCall {
- c := &ProjectsSetCommonInstanceMetadataCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.metadata = metadata
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsSetCommonInstanceMetadataCall) Fields(s ...googleapi.Field) *ProjectsSetCommonInstanceMetadataCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsSetCommonInstanceMetadataCall) Context(ctx context.Context) *ProjectsSetCommonInstanceMetadataCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsSetCommonInstanceMetadataCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.metadata)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/setCommonInstanceMetadata")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.projects.setCommonInstanceMetadata" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ProjectsSetCommonInstanceMetadataCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sets metadata common to all instances within the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.projects.setCommonInstanceMetadata",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/setCommonInstanceMetadata",
- // "request": {
- // "$ref": "Metadata"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.projects.setUsageExportBucket":
-
-type ProjectsSetUsageExportBucketCall struct {
- s *Service
- project string
- usageexportlocation *UsageExportLocation
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetUsageExportBucket: Enables the usage export feature and sets the
-// usage export bucket where reports are stored. If you provide an empty
-// request body using this method, the usage export feature will be
-// disabled.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/projects/setUsageExportBucket
-func (r *ProjectsService) SetUsageExportBucket(project string, usageexportlocation *UsageExportLocation) *ProjectsSetUsageExportBucketCall {
- c := &ProjectsSetUsageExportBucketCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.usageexportlocation = usageexportlocation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsSetUsageExportBucketCall) Fields(s ...googleapi.Field) *ProjectsSetUsageExportBucketCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsSetUsageExportBucketCall) Context(ctx context.Context) *ProjectsSetUsageExportBucketCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsSetUsageExportBucketCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.usageexportlocation)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/setUsageExportBucket")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.projects.setUsageExportBucket" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ProjectsSetUsageExportBucketCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.",
- // "httpMethod": "POST",
- // "id": "compute.projects.setUsageExportBucket",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/setUsageExportBucket",
- // "request": {
- // "$ref": "UsageExportLocation"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/devstorage.full_control",
- // "https://www.googleapis.com/auth/devstorage.read_only",
- // "https://www.googleapis.com/auth/devstorage.read_write"
- // ]
- // }
-
-}
-
-// method id "compute.projects.setUsageExportCloudStorageBucket":
-
-type ProjectsSetUsageExportCloudStorageBucketCall struct {
- s *Service
- project string
- usageexportlocation *UsageExportLocation
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetUsageExportCloudStorageBucket: [Deprecated] Use
-// setUsageExportBucket instead.
-func (r *ProjectsService) SetUsageExportCloudStorageBucket(project string, usageexportlocation *UsageExportLocation) *ProjectsSetUsageExportCloudStorageBucketCall {
- c := &ProjectsSetUsageExportCloudStorageBucketCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.usageexportlocation = usageexportlocation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsSetUsageExportCloudStorageBucketCall) Fields(s ...googleapi.Field) *ProjectsSetUsageExportCloudStorageBucketCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsSetUsageExportCloudStorageBucketCall) Context(ctx context.Context) *ProjectsSetUsageExportCloudStorageBucketCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsSetUsageExportCloudStorageBucketCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.usageexportlocation)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/setUsageExportCloudStorageBucket")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.projects.setUsageExportCloudStorageBucket" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ProjectsSetUsageExportCloudStorageBucketCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "[Deprecated] Use setUsageExportBucket instead.",
- // "httpMethod": "POST",
- // "id": "compute.projects.setUsageExportCloudStorageBucket",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/setUsageExportCloudStorageBucket",
- // "request": {
- // "$ref": "UsageExportLocation"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/devstorage.full_control",
- // "https://www.googleapis.com/auth/devstorage.read_only",
- // "https://www.googleapis.com/auth/devstorage.read_write"
- // ]
- // }
-
-}
-
-// method id "compute.regionOperations.delete":
-
-type RegionOperationsDeleteCall struct {
- s *Service
- project string
- region string
- operation string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified region-specific Operations resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/regionOperations/delete
-func (r *RegionOperationsService) Delete(project string, region string, operation string) *RegionOperationsDeleteCall {
- c := &RegionOperationsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.operation = operation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RegionOperationsDeleteCall) Fields(s ...googleapi.Field) *RegionOperationsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RegionOperationsDeleteCall) Context(ctx context.Context) *RegionOperationsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RegionOperationsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/operations/{operation}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "operation": c.operation,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.regionOperations.delete" call.
-func (c *RegionOperationsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes the specified region-specific Operations resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.regionOperations.delete",
- // "parameterOrder": [
- // "project",
- // "region",
- // "operation"
- // ],
- // "parameters": {
- // "operation": {
- // "description": "Name of the Operations resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/operations/{operation}",
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.regionOperations.get":
-
-type RegionOperationsGetCall struct {
- s *Service
- project string
- region string
- operation string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves the specified region-specific Operations resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/regionOperations/get
-func (r *RegionOperationsService) Get(project string, region string, operation string) *RegionOperationsGetCall {
- c := &RegionOperationsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.operation = operation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RegionOperationsGetCall) Fields(s ...googleapi.Field) *RegionOperationsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *RegionOperationsGetCall) IfNoneMatch(entityTag string) *RegionOperationsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RegionOperationsGetCall) Context(ctx context.Context) *RegionOperationsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RegionOperationsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/operations/{operation}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "operation": c.operation,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.regionOperations.get" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *RegionOperationsGetCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the specified region-specific Operations resource.",
- // "httpMethod": "GET",
- // "id": "compute.regionOperations.get",
- // "parameterOrder": [
- // "project",
- // "region",
- // "operation"
- // ],
- // "parameters": {
- // "operation": {
- // "description": "Name of the Operations resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the zone scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/operations/{operation}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.regionOperations.list":
-
-type RegionOperationsListCall struct {
- s *Service
- project string
- region string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of Operation resources contained within the
-// specified region.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/regionOperations/list
-func (r *RegionOperationsService) List(project string, region string) *RegionOperationsListCall {
- c := &RegionOperationsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *RegionOperationsListCall) Filter(filter string) *RegionOperationsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *RegionOperationsListCall) MaxResults(maxResults int64) *RegionOperationsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *RegionOperationsListCall) OrderBy(orderBy string) *RegionOperationsListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *RegionOperationsListCall) PageToken(pageToken string) *RegionOperationsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RegionOperationsListCall) Fields(s ...googleapi.Field) *RegionOperationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *RegionOperationsListCall) IfNoneMatch(entityTag string) *RegionOperationsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RegionOperationsListCall) Context(ctx context.Context) *RegionOperationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RegionOperationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/operations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.regionOperations.list" call.
-// Exactly one of *OperationList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *OperationList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *RegionOperationsListCall) Do() (*OperationList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OperationList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of Operation resources contained within the specified region.",
- // "httpMethod": "GET",
- // "id": "compute.regionOperations.list",
- // "parameterOrder": [
- // "project",
- // "region"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/operations",
- // "response": {
- // "$ref": "OperationList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.regions.get":
-
-type RegionsGetCall struct {
- s *Service
- project string
- region string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified region resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/regions/get
-func (r *RegionsService) Get(project string, region string) *RegionsGetCall {
- c := &RegionsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RegionsGetCall) Fields(s ...googleapi.Field) *RegionsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *RegionsGetCall) IfNoneMatch(entityTag string) *RegionsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RegionsGetCall) Context(ctx context.Context) *RegionsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RegionsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.regions.get" call.
-// Exactly one of *Region or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Region.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *RegionsGetCall) Do() (*Region, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Region{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified region resource.",
- // "httpMethod": "GET",
- // "id": "compute.regions.get",
- // "parameterOrder": [
- // "project",
- // "region"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}",
- // "response": {
- // "$ref": "Region"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.regions.list":
-
-type RegionsListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of region resources available to the
-// specified project.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/regions/list
-func (r *RegionsService) List(project string) *RegionsListCall {
- c := &RegionsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *RegionsListCall) Filter(filter string) *RegionsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *RegionsListCall) MaxResults(maxResults int64) *RegionsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *RegionsListCall) OrderBy(orderBy string) *RegionsListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *RegionsListCall) PageToken(pageToken string) *RegionsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RegionsListCall) Fields(s ...googleapi.Field) *RegionsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *RegionsListCall) IfNoneMatch(entityTag string) *RegionsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RegionsListCall) Context(ctx context.Context) *RegionsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RegionsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.regions.list" call.
-// Exactly one of *RegionList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *RegionList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *RegionsListCall) Do() (*RegionList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &RegionList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of region resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.regions.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions",
- // "response": {
- // "$ref": "RegionList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.routes.delete":
-
-type RoutesDeleteCall struct {
- s *Service
- project string
- route string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified route resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/routes/delete
-func (r *RoutesService) Delete(project string, route string) *RoutesDeleteCall {
- c := &RoutesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.route = route
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RoutesDeleteCall) Fields(s ...googleapi.Field) *RoutesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RoutesDeleteCall) Context(ctx context.Context) *RoutesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RoutesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/routes/{route}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "route": c.route,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.routes.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *RoutesDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified route resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.routes.delete",
- // "parameterOrder": [
- // "project",
- // "route"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "route": {
- // "description": "Name of the route resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/routes/{route}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.routes.get":
-
-type RoutesGetCall struct {
- s *Service
- project string
- route string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified route resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/routes/get
-func (r *RoutesService) Get(project string, route string) *RoutesGetCall {
- c := &RoutesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.route = route
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RoutesGetCall) Fields(s ...googleapi.Field) *RoutesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *RoutesGetCall) IfNoneMatch(entityTag string) *RoutesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RoutesGetCall) Context(ctx context.Context) *RoutesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RoutesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/routes/{route}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "route": c.route,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.routes.get" call.
-// Exactly one of *Route or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Route.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *RoutesGetCall) Do() (*Route, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Route{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified route resource.",
- // "httpMethod": "GET",
- // "id": "compute.routes.get",
- // "parameterOrder": [
- // "project",
- // "route"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "route": {
- // "description": "Name of the route resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/routes/{route}",
- // "response": {
- // "$ref": "Route"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.routes.insert":
-
-type RoutesInsertCall struct {
- s *Service
- project string
- route *Route
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a route resource in the specified project using the
-// data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/routes/insert
-func (r *RoutesService) Insert(project string, route *Route) *RoutesInsertCall {
- c := &RoutesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.route = route
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RoutesInsertCall) Fields(s ...googleapi.Field) *RoutesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RoutesInsertCall) Context(ctx context.Context) *RoutesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RoutesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.route)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/routes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.routes.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *RoutesInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a route resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.routes.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/routes",
- // "request": {
- // "$ref": "Route"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.routes.list":
-
-type RoutesListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of route resources available to the
-// specified project.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/routes/list
-func (r *RoutesService) List(project string) *RoutesListCall {
- c := &RoutesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *RoutesListCall) Filter(filter string) *RoutesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *RoutesListCall) MaxResults(maxResults int64) *RoutesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *RoutesListCall) OrderBy(orderBy string) *RoutesListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *RoutesListCall) PageToken(pageToken string) *RoutesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RoutesListCall) Fields(s ...googleapi.Field) *RoutesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *RoutesListCall) IfNoneMatch(entityTag string) *RoutesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RoutesListCall) Context(ctx context.Context) *RoutesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RoutesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/routes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.routes.list" call.
-// Exactly one of *RouteList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *RouteList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *RoutesListCall) Do() (*RouteList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &RouteList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of route resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.routes.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/routes",
- // "response": {
- // "$ref": "RouteList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.snapshots.delete":
-
-type SnapshotsDeleteCall struct {
- s *Service
- project string
- snapshot string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified Snapshot resource. Keep in mind that
-// deleting a single snapshot might not necessarily delete all the data
-// on that snapshot. If any data on the snapshot that is marked for
-// deletion is needed for subsequent snapshots, the data will be moved
-// to the next corresponding snapshot.
-//
-// For more information, see Deleting snaphots.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/snapshots/delete
-func (r *SnapshotsService) Delete(project string, snapshot string) *SnapshotsDeleteCall {
- c := &SnapshotsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.snapshot = snapshot
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SnapshotsDeleteCall) Fields(s ...googleapi.Field) *SnapshotsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SnapshotsDeleteCall) Context(ctx context.Context) *SnapshotsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SnapshotsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/snapshots/{snapshot}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "snapshot": c.snapshot,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.snapshots.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *SnapshotsDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.\n\nFor more information, see Deleting snaphots.",
- // "httpMethod": "DELETE",
- // "id": "compute.snapshots.delete",
- // "parameterOrder": [
- // "project",
- // "snapshot"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "snapshot": {
- // "description": "Name of the Snapshot resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/snapshots/{snapshot}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.snapshots.get":
-
-type SnapshotsGetCall struct {
- s *Service
- project string
- snapshot string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified Snapshot resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/snapshots/get
-func (r *SnapshotsService) Get(project string, snapshot string) *SnapshotsGetCall {
- c := &SnapshotsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.snapshot = snapshot
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SnapshotsGetCall) Fields(s ...googleapi.Field) *SnapshotsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SnapshotsGetCall) IfNoneMatch(entityTag string) *SnapshotsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SnapshotsGetCall) Context(ctx context.Context) *SnapshotsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SnapshotsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/snapshots/{snapshot}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "snapshot": c.snapshot,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.snapshots.get" call.
-// Exactly one of *Snapshot or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Snapshot.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *SnapshotsGetCall) Do() (*Snapshot, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Snapshot{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified Snapshot resource.",
- // "httpMethod": "GET",
- // "id": "compute.snapshots.get",
- // "parameterOrder": [
- // "project",
- // "snapshot"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "snapshot": {
- // "description": "Name of the Snapshot resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/snapshots/{snapshot}",
- // "response": {
- // "$ref": "Snapshot"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.snapshots.list":
-
-type SnapshotsListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of Snapshot resources contained within the
-// specified project.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/snapshots/list
-func (r *SnapshotsService) List(project string) *SnapshotsListCall {
- c := &SnapshotsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *SnapshotsListCall) Filter(filter string) *SnapshotsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *SnapshotsListCall) MaxResults(maxResults int64) *SnapshotsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *SnapshotsListCall) OrderBy(orderBy string) *SnapshotsListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *SnapshotsListCall) PageToken(pageToken string) *SnapshotsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SnapshotsListCall) Fields(s ...googleapi.Field) *SnapshotsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SnapshotsListCall) IfNoneMatch(entityTag string) *SnapshotsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SnapshotsListCall) Context(ctx context.Context) *SnapshotsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SnapshotsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/snapshots")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.snapshots.list" call.
-// Exactly one of *SnapshotList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *SnapshotList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *SnapshotsListCall) Do() (*SnapshotList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SnapshotList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of Snapshot resources contained within the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.snapshots.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/snapshots",
- // "response": {
- // "$ref": "SnapshotList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.sslCertificates.delete":
-
-type SslCertificatesDeleteCall struct {
- s *Service
- project string
- sslCertificate string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified SslCertificate resource.
-func (r *SslCertificatesService) Delete(project string, sslCertificate string) *SslCertificatesDeleteCall {
- c := &SslCertificatesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.sslCertificate = sslCertificate
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SslCertificatesDeleteCall) Fields(s ...googleapi.Field) *SslCertificatesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SslCertificatesDeleteCall) Context(ctx context.Context) *SslCertificatesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SslCertificatesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/sslCertificates/{sslCertificate}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "sslCertificate": c.sslCertificate,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.sslCertificates.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *SslCertificatesDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified SslCertificate resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.sslCertificates.delete",
- // "parameterOrder": [
- // "project",
- // "sslCertificate"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "sslCertificate": {
- // "description": "Name of the SslCertificate resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/sslCertificates/{sslCertificate}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.sslCertificates.get":
-
-type SslCertificatesGetCall struct {
- s *Service
- project string
- sslCertificate string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified SslCertificate resource.
-func (r *SslCertificatesService) Get(project string, sslCertificate string) *SslCertificatesGetCall {
- c := &SslCertificatesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.sslCertificate = sslCertificate
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SslCertificatesGetCall) Fields(s ...googleapi.Field) *SslCertificatesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SslCertificatesGetCall) IfNoneMatch(entityTag string) *SslCertificatesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SslCertificatesGetCall) Context(ctx context.Context) *SslCertificatesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SslCertificatesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/sslCertificates/{sslCertificate}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "sslCertificate": c.sslCertificate,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.sslCertificates.get" call.
-// Exactly one of *SslCertificate or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *SslCertificate.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *SslCertificatesGetCall) Do() (*SslCertificate, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SslCertificate{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified SslCertificate resource.",
- // "httpMethod": "GET",
- // "id": "compute.sslCertificates.get",
- // "parameterOrder": [
- // "project",
- // "sslCertificate"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "sslCertificate": {
- // "description": "Name of the SslCertificate resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/sslCertificates/{sslCertificate}",
- // "response": {
- // "$ref": "SslCertificate"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.sslCertificates.insert":
-
-type SslCertificatesInsertCall struct {
- s *Service
- project string
- sslcertificate *SslCertificate
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a SslCertificate resource in the specified project
-// using the data included in the request.
-func (r *SslCertificatesService) Insert(project string, sslcertificate *SslCertificate) *SslCertificatesInsertCall {
- c := &SslCertificatesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.sslcertificate = sslcertificate
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SslCertificatesInsertCall) Fields(s ...googleapi.Field) *SslCertificatesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SslCertificatesInsertCall) Context(ctx context.Context) *SslCertificatesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SslCertificatesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.sslcertificate)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/sslCertificates")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.sslCertificates.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *SslCertificatesInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a SslCertificate resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.sslCertificates.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/sslCertificates",
- // "request": {
- // "$ref": "SslCertificate"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.sslCertificates.list":
-
-type SslCertificatesListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of SslCertificate resources available to the
-// specified project.
-func (r *SslCertificatesService) List(project string) *SslCertificatesListCall {
- c := &SslCertificatesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *SslCertificatesListCall) Filter(filter string) *SslCertificatesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *SslCertificatesListCall) MaxResults(maxResults int64) *SslCertificatesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *SslCertificatesListCall) OrderBy(orderBy string) *SslCertificatesListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *SslCertificatesListCall) PageToken(pageToken string) *SslCertificatesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SslCertificatesListCall) Fields(s ...googleapi.Field) *SslCertificatesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SslCertificatesListCall) IfNoneMatch(entityTag string) *SslCertificatesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SslCertificatesListCall) Context(ctx context.Context) *SslCertificatesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SslCertificatesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/sslCertificates")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.sslCertificates.list" call.
-// Exactly one of *SslCertificateList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *SslCertificateList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *SslCertificatesListCall) Do() (*SslCertificateList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SslCertificateList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of SslCertificate resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.sslCertificates.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/sslCertificates",
- // "response": {
- // "$ref": "SslCertificateList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.targetHttpProxies.delete":
-
-type TargetHttpProxiesDeleteCall struct {
- s *Service
- project string
- targetHttpProxy string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified TargetHttpProxy resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetHttpProxies/delete
-func (r *TargetHttpProxiesService) Delete(project string, targetHttpProxy string) *TargetHttpProxiesDeleteCall {
- c := &TargetHttpProxiesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.targetHttpProxy = targetHttpProxy
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetHttpProxiesDeleteCall) Fields(s ...googleapi.Field) *TargetHttpProxiesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetHttpProxiesDeleteCall) Context(ctx context.Context) *TargetHttpProxiesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetHttpProxiesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/targetHttpProxies/{targetHttpProxy}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "targetHttpProxy": c.targetHttpProxy,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetHttpProxies.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetHttpProxiesDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified TargetHttpProxy resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.targetHttpProxies.delete",
- // "parameterOrder": [
- // "project",
- // "targetHttpProxy"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "targetHttpProxy": {
- // "description": "Name of the TargetHttpProxy resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/targetHttpProxies/{targetHttpProxy}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetHttpProxies.get":
-
-type TargetHttpProxiesGetCall struct {
- s *Service
- project string
- targetHttpProxy string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified TargetHttpProxy resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetHttpProxies/get
-func (r *TargetHttpProxiesService) Get(project string, targetHttpProxy string) *TargetHttpProxiesGetCall {
- c := &TargetHttpProxiesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.targetHttpProxy = targetHttpProxy
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetHttpProxiesGetCall) Fields(s ...googleapi.Field) *TargetHttpProxiesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TargetHttpProxiesGetCall) IfNoneMatch(entityTag string) *TargetHttpProxiesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetHttpProxiesGetCall) Context(ctx context.Context) *TargetHttpProxiesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetHttpProxiesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/targetHttpProxies/{targetHttpProxy}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "targetHttpProxy": c.targetHttpProxy,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetHttpProxies.get" call.
-// Exactly one of *TargetHttpProxy or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *TargetHttpProxy.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TargetHttpProxiesGetCall) Do() (*TargetHttpProxy, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetHttpProxy{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified TargetHttpProxy resource.",
- // "httpMethod": "GET",
- // "id": "compute.targetHttpProxies.get",
- // "parameterOrder": [
- // "project",
- // "targetHttpProxy"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "targetHttpProxy": {
- // "description": "Name of the TargetHttpProxy resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/targetHttpProxies/{targetHttpProxy}",
- // "response": {
- // "$ref": "TargetHttpProxy"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.targetHttpProxies.insert":
-
-type TargetHttpProxiesInsertCall struct {
- s *Service
- project string
- targethttpproxy *TargetHttpProxy
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a TargetHttpProxy resource in the specified project
-// using the data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetHttpProxies/insert
-func (r *TargetHttpProxiesService) Insert(project string, targethttpproxy *TargetHttpProxy) *TargetHttpProxiesInsertCall {
- c := &TargetHttpProxiesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.targethttpproxy = targethttpproxy
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetHttpProxiesInsertCall) Fields(s ...googleapi.Field) *TargetHttpProxiesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetHttpProxiesInsertCall) Context(ctx context.Context) *TargetHttpProxiesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetHttpProxiesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.targethttpproxy)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/targetHttpProxies")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetHttpProxies.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetHttpProxiesInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a TargetHttpProxy resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.targetHttpProxies.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/targetHttpProxies",
- // "request": {
- // "$ref": "TargetHttpProxy"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetHttpProxies.list":
-
-type TargetHttpProxiesListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of TargetHttpProxy resources available to
-// the specified project.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetHttpProxies/list
-func (r *TargetHttpProxiesService) List(project string) *TargetHttpProxiesListCall {
- c := &TargetHttpProxiesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *TargetHttpProxiesListCall) Filter(filter string) *TargetHttpProxiesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *TargetHttpProxiesListCall) MaxResults(maxResults int64) *TargetHttpProxiesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *TargetHttpProxiesListCall) OrderBy(orderBy string) *TargetHttpProxiesListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *TargetHttpProxiesListCall) PageToken(pageToken string) *TargetHttpProxiesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetHttpProxiesListCall) Fields(s ...googleapi.Field) *TargetHttpProxiesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TargetHttpProxiesListCall) IfNoneMatch(entityTag string) *TargetHttpProxiesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetHttpProxiesListCall) Context(ctx context.Context) *TargetHttpProxiesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetHttpProxiesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/targetHttpProxies")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetHttpProxies.list" call.
-// Exactly one of *TargetHttpProxyList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *TargetHttpProxyList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TargetHttpProxiesListCall) Do() (*TargetHttpProxyList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetHttpProxyList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of TargetHttpProxy resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.targetHttpProxies.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/targetHttpProxies",
- // "response": {
- // "$ref": "TargetHttpProxyList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.targetHttpProxies.setUrlMap":
-
-type TargetHttpProxiesSetUrlMapCall struct {
- s *Service
- project string
- targetHttpProxy string
- urlmapreference *UrlMapReference
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetUrlMap: Changes the URL map for TargetHttpProxy.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetHttpProxies/setUrlMap
-func (r *TargetHttpProxiesService) SetUrlMap(project string, targetHttpProxy string, urlmapreference *UrlMapReference) *TargetHttpProxiesSetUrlMapCall {
- c := &TargetHttpProxiesSetUrlMapCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.targetHttpProxy = targetHttpProxy
- c.urlmapreference = urlmapreference
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetHttpProxiesSetUrlMapCall) Fields(s ...googleapi.Field) *TargetHttpProxiesSetUrlMapCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetHttpProxiesSetUrlMapCall) Context(ctx context.Context) *TargetHttpProxiesSetUrlMapCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetHttpProxiesSetUrlMapCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.urlmapreference)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "targetHttpProxy": c.targetHttpProxy,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetHttpProxies.setUrlMap" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetHttpProxiesSetUrlMapCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Changes the URL map for TargetHttpProxy.",
- // "httpMethod": "POST",
- // "id": "compute.targetHttpProxies.setUrlMap",
- // "parameterOrder": [
- // "project",
- // "targetHttpProxy"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "targetHttpProxy": {
- // "description": "Name of the TargetHttpProxy resource whose URL map is to be set.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap",
- // "request": {
- // "$ref": "UrlMapReference"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetHttpsProxies.delete":
-
-type TargetHttpsProxiesDeleteCall struct {
- s *Service
- project string
- targetHttpsProxy string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified TargetHttpsProxy resource.
-func (r *TargetHttpsProxiesService) Delete(project string, targetHttpsProxy string) *TargetHttpsProxiesDeleteCall {
- c := &TargetHttpsProxiesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.targetHttpsProxy = targetHttpsProxy
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetHttpsProxiesDeleteCall) Fields(s ...googleapi.Field) *TargetHttpsProxiesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetHttpsProxiesDeleteCall) Context(ctx context.Context) *TargetHttpsProxiesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetHttpsProxiesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/targetHttpsProxies/{targetHttpsProxy}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "targetHttpsProxy": c.targetHttpsProxy,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetHttpsProxies.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetHttpsProxiesDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified TargetHttpsProxy resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.targetHttpsProxies.delete",
- // "parameterOrder": [
- // "project",
- // "targetHttpsProxy"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "targetHttpsProxy": {
- // "description": "Name of the TargetHttpsProxy resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/targetHttpsProxies/{targetHttpsProxy}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetHttpsProxies.get":
-
-type TargetHttpsProxiesGetCall struct {
- s *Service
- project string
- targetHttpsProxy string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified TargetHttpsProxy resource.
-func (r *TargetHttpsProxiesService) Get(project string, targetHttpsProxy string) *TargetHttpsProxiesGetCall {
- c := &TargetHttpsProxiesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.targetHttpsProxy = targetHttpsProxy
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetHttpsProxiesGetCall) Fields(s ...googleapi.Field) *TargetHttpsProxiesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TargetHttpsProxiesGetCall) IfNoneMatch(entityTag string) *TargetHttpsProxiesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetHttpsProxiesGetCall) Context(ctx context.Context) *TargetHttpsProxiesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetHttpsProxiesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/targetHttpsProxies/{targetHttpsProxy}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "targetHttpsProxy": c.targetHttpsProxy,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetHttpsProxies.get" call.
-// Exactly one of *TargetHttpsProxy or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *TargetHttpsProxy.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TargetHttpsProxiesGetCall) Do() (*TargetHttpsProxy, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetHttpsProxy{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified TargetHttpsProxy resource.",
- // "httpMethod": "GET",
- // "id": "compute.targetHttpsProxies.get",
- // "parameterOrder": [
- // "project",
- // "targetHttpsProxy"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "targetHttpsProxy": {
- // "description": "Name of the TargetHttpsProxy resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/targetHttpsProxies/{targetHttpsProxy}",
- // "response": {
- // "$ref": "TargetHttpsProxy"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.targetHttpsProxies.insert":
-
-type TargetHttpsProxiesInsertCall struct {
- s *Service
- project string
- targethttpsproxy *TargetHttpsProxy
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a TargetHttpsProxy resource in the specified project
-// using the data included in the request.
-func (r *TargetHttpsProxiesService) Insert(project string, targethttpsproxy *TargetHttpsProxy) *TargetHttpsProxiesInsertCall {
- c := &TargetHttpsProxiesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.targethttpsproxy = targethttpsproxy
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetHttpsProxiesInsertCall) Fields(s ...googleapi.Field) *TargetHttpsProxiesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetHttpsProxiesInsertCall) Context(ctx context.Context) *TargetHttpsProxiesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetHttpsProxiesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.targethttpsproxy)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/targetHttpsProxies")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetHttpsProxies.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetHttpsProxiesInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a TargetHttpsProxy resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.targetHttpsProxies.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/targetHttpsProxies",
- // "request": {
- // "$ref": "TargetHttpsProxy"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetHttpsProxies.list":
-
-type TargetHttpsProxiesListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of TargetHttpsProxy resources available to
-// the specified project.
-func (r *TargetHttpsProxiesService) List(project string) *TargetHttpsProxiesListCall {
- c := &TargetHttpsProxiesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *TargetHttpsProxiesListCall) Filter(filter string) *TargetHttpsProxiesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *TargetHttpsProxiesListCall) MaxResults(maxResults int64) *TargetHttpsProxiesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *TargetHttpsProxiesListCall) OrderBy(orderBy string) *TargetHttpsProxiesListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *TargetHttpsProxiesListCall) PageToken(pageToken string) *TargetHttpsProxiesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetHttpsProxiesListCall) Fields(s ...googleapi.Field) *TargetHttpsProxiesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TargetHttpsProxiesListCall) IfNoneMatch(entityTag string) *TargetHttpsProxiesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetHttpsProxiesListCall) Context(ctx context.Context) *TargetHttpsProxiesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetHttpsProxiesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/targetHttpsProxies")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetHttpsProxies.list" call.
-// Exactly one of *TargetHttpsProxyList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *TargetHttpsProxyList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TargetHttpsProxiesListCall) Do() (*TargetHttpsProxyList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetHttpsProxyList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of TargetHttpsProxy resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.targetHttpsProxies.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/targetHttpsProxies",
- // "response": {
- // "$ref": "TargetHttpsProxyList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.targetHttpsProxies.setSslCertificates":
-
-type TargetHttpsProxiesSetSslCertificatesCall struct {
- s *Service
- project string
- targetHttpsProxy string
- targethttpsproxiessetsslcertificatesrequest *TargetHttpsProxiesSetSslCertificatesRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetSslCertificates: Replaces SslCertificates for TargetHttpsProxy.
-func (r *TargetHttpsProxiesService) SetSslCertificates(project string, targetHttpsProxy string, targethttpsproxiessetsslcertificatesrequest *TargetHttpsProxiesSetSslCertificatesRequest) *TargetHttpsProxiesSetSslCertificatesCall {
- c := &TargetHttpsProxiesSetSslCertificatesCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.targetHttpsProxy = targetHttpsProxy
- c.targethttpsproxiessetsslcertificatesrequest = targethttpsproxiessetsslcertificatesrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetHttpsProxiesSetSslCertificatesCall) Fields(s ...googleapi.Field) *TargetHttpsProxiesSetSslCertificatesCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetHttpsProxiesSetSslCertificatesCall) Context(ctx context.Context) *TargetHttpsProxiesSetSslCertificatesCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetHttpsProxiesSetSslCertificatesCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.targethttpsproxiessetsslcertificatesrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "targetHttpsProxy": c.targetHttpsProxy,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetHttpsProxies.setSslCertificates" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetHttpsProxiesSetSslCertificatesCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Replaces SslCertificates for TargetHttpsProxy.",
- // "httpMethod": "POST",
- // "id": "compute.targetHttpsProxies.setSslCertificates",
- // "parameterOrder": [
- // "project",
- // "targetHttpsProxy"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "targetHttpsProxy": {
- // "description": "Name of the TargetHttpsProxy resource whose URL map is to be set.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates",
- // "request": {
- // "$ref": "TargetHttpsProxiesSetSslCertificatesRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetHttpsProxies.setUrlMap":
-
-type TargetHttpsProxiesSetUrlMapCall struct {
- s *Service
- project string
- targetHttpsProxy string
- urlmapreference *UrlMapReference
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetUrlMap: Changes the URL map for TargetHttpsProxy.
-func (r *TargetHttpsProxiesService) SetUrlMap(project string, targetHttpsProxy string, urlmapreference *UrlMapReference) *TargetHttpsProxiesSetUrlMapCall {
- c := &TargetHttpsProxiesSetUrlMapCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.targetHttpsProxy = targetHttpsProxy
- c.urlmapreference = urlmapreference
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetHttpsProxiesSetUrlMapCall) Fields(s ...googleapi.Field) *TargetHttpsProxiesSetUrlMapCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetHttpsProxiesSetUrlMapCall) Context(ctx context.Context) *TargetHttpsProxiesSetUrlMapCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetHttpsProxiesSetUrlMapCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.urlmapreference)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "targetHttpsProxy": c.targetHttpsProxy,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetHttpsProxies.setUrlMap" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetHttpsProxiesSetUrlMapCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Changes the URL map for TargetHttpsProxy.",
- // "httpMethod": "POST",
- // "id": "compute.targetHttpsProxies.setUrlMap",
- // "parameterOrder": [
- // "project",
- // "targetHttpsProxy"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "targetHttpsProxy": {
- // "description": "Name of the TargetHttpsProxy resource whose URL map is to be set.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap",
- // "request": {
- // "$ref": "UrlMapReference"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetInstances.aggregatedList":
-
-type TargetInstancesAggregatedListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AggregatedList: Retrieves the list of target instances grouped by
-// scope.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetInstances/aggregatedList
-func (r *TargetInstancesService) AggregatedList(project string) *TargetInstancesAggregatedListCall {
- c := &TargetInstancesAggregatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *TargetInstancesAggregatedListCall) Filter(filter string) *TargetInstancesAggregatedListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *TargetInstancesAggregatedListCall) MaxResults(maxResults int64) *TargetInstancesAggregatedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *TargetInstancesAggregatedListCall) OrderBy(orderBy string) *TargetInstancesAggregatedListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *TargetInstancesAggregatedListCall) PageToken(pageToken string) *TargetInstancesAggregatedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetInstancesAggregatedListCall) Fields(s ...googleapi.Field) *TargetInstancesAggregatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TargetInstancesAggregatedListCall) IfNoneMatch(entityTag string) *TargetInstancesAggregatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetInstancesAggregatedListCall) Context(ctx context.Context) *TargetInstancesAggregatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetInstancesAggregatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/aggregated/targetInstances")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetInstances.aggregatedList" call.
-// Exactly one of *TargetInstanceAggregatedList or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *TargetInstanceAggregatedList.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TargetInstancesAggregatedListCall) Do() (*TargetInstanceAggregatedList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetInstanceAggregatedList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of target instances grouped by scope.",
- // "httpMethod": "GET",
- // "id": "compute.targetInstances.aggregatedList",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/aggregated/targetInstances",
- // "response": {
- // "$ref": "TargetInstanceAggregatedList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.targetInstances.delete":
-
-type TargetInstancesDeleteCall struct {
- s *Service
- project string
- zone string
- targetInstance string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified TargetInstance resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetInstances/delete
-func (r *TargetInstancesService) Delete(project string, zone string, targetInstance string) *TargetInstancesDeleteCall {
- c := &TargetInstancesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.targetInstance = targetInstance
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetInstancesDeleteCall) Fields(s ...googleapi.Field) *TargetInstancesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetInstancesDeleteCall) Context(ctx context.Context) *TargetInstancesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetInstancesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/targetInstances/{targetInstance}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "targetInstance": c.targetInstance,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetInstances.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetInstancesDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified TargetInstance resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.targetInstances.delete",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "targetInstance"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "targetInstance": {
- // "description": "Name of the TargetInstance resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/targetInstances/{targetInstance}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetInstances.get":
-
-type TargetInstancesGetCall struct {
- s *Service
- project string
- zone string
- targetInstance string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified TargetInstance resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetInstances/get
-func (r *TargetInstancesService) Get(project string, zone string, targetInstance string) *TargetInstancesGetCall {
- c := &TargetInstancesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.targetInstance = targetInstance
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetInstancesGetCall) Fields(s ...googleapi.Field) *TargetInstancesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TargetInstancesGetCall) IfNoneMatch(entityTag string) *TargetInstancesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetInstancesGetCall) Context(ctx context.Context) *TargetInstancesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetInstancesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/targetInstances/{targetInstance}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "targetInstance": c.targetInstance,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetInstances.get" call.
-// Exactly one of *TargetInstance or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *TargetInstance.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TargetInstancesGetCall) Do() (*TargetInstance, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetInstance{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified TargetInstance resource.",
- // "httpMethod": "GET",
- // "id": "compute.targetInstances.get",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "targetInstance"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "targetInstance": {
- // "description": "Name of the TargetInstance resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/targetInstances/{targetInstance}",
- // "response": {
- // "$ref": "TargetInstance"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.targetInstances.insert":
-
-type TargetInstancesInsertCall struct {
- s *Service
- project string
- zone string
- targetinstance *TargetInstance
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a TargetInstance resource in the specified project
-// and zone using the data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetInstances/insert
-func (r *TargetInstancesService) Insert(project string, zone string, targetinstance *TargetInstance) *TargetInstancesInsertCall {
- c := &TargetInstancesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.targetinstance = targetinstance
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetInstancesInsertCall) Fields(s ...googleapi.Field) *TargetInstancesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetInstancesInsertCall) Context(ctx context.Context) *TargetInstancesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetInstancesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.targetinstance)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/targetInstances")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetInstances.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetInstancesInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a TargetInstance resource in the specified project and zone using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.targetInstances.insert",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/targetInstances",
- // "request": {
- // "$ref": "TargetInstance"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetInstances.list":
-
-type TargetInstancesListCall struct {
- s *Service
- project string
- zone string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of TargetInstance resources available to the
-// specified project and zone.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetInstances/list
-func (r *TargetInstancesService) List(project string, zone string) *TargetInstancesListCall {
- c := &TargetInstancesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *TargetInstancesListCall) Filter(filter string) *TargetInstancesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *TargetInstancesListCall) MaxResults(maxResults int64) *TargetInstancesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *TargetInstancesListCall) OrderBy(orderBy string) *TargetInstancesListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *TargetInstancesListCall) PageToken(pageToken string) *TargetInstancesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetInstancesListCall) Fields(s ...googleapi.Field) *TargetInstancesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TargetInstancesListCall) IfNoneMatch(entityTag string) *TargetInstancesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetInstancesListCall) Context(ctx context.Context) *TargetInstancesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetInstancesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/targetInstances")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetInstances.list" call.
-// Exactly one of *TargetInstanceList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *TargetInstanceList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TargetInstancesListCall) Do() (*TargetInstanceList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetInstanceList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of TargetInstance resources available to the specified project and zone.",
- // "httpMethod": "GET",
- // "id": "compute.targetInstances.list",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/targetInstances",
- // "response": {
- // "$ref": "TargetInstanceList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.targetPools.addHealthCheck":
-
-type TargetPoolsAddHealthCheckCall struct {
- s *Service
- project string
- region string
- targetPool string
- targetpoolsaddhealthcheckrequest *TargetPoolsAddHealthCheckRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AddHealthCheck: Adds health check URL to targetPool.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetPools/addHealthCheck
-func (r *TargetPoolsService) AddHealthCheck(project string, region string, targetPool string, targetpoolsaddhealthcheckrequest *TargetPoolsAddHealthCheckRequest) *TargetPoolsAddHealthCheckCall {
- c := &TargetPoolsAddHealthCheckCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.targetPool = targetPool
- c.targetpoolsaddhealthcheckrequest = targetpoolsaddhealthcheckrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetPoolsAddHealthCheckCall) Fields(s ...googleapi.Field) *TargetPoolsAddHealthCheckCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetPoolsAddHealthCheckCall) Context(ctx context.Context) *TargetPoolsAddHealthCheckCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetPoolsAddHealthCheckCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.targetpoolsaddhealthcheckrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "targetPool": c.targetPool,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetPools.addHealthCheck" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetPoolsAddHealthCheckCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Adds health check URL to targetPool.",
- // "httpMethod": "POST",
- // "id": "compute.targetPools.addHealthCheck",
- // "parameterOrder": [
- // "project",
- // "region",
- // "targetPool"
- // ],
- // "parameters": {
- // "project": {
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "targetPool": {
- // "description": "Name of the TargetPool resource to which health_check_url is to be added.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck",
- // "request": {
- // "$ref": "TargetPoolsAddHealthCheckRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetPools.addInstance":
-
-type TargetPoolsAddInstanceCall struct {
- s *Service
- project string
- region string
- targetPool string
- targetpoolsaddinstancerequest *TargetPoolsAddInstanceRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AddInstance: Adds instance url to targetPool.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetPools/addInstance
-func (r *TargetPoolsService) AddInstance(project string, region string, targetPool string, targetpoolsaddinstancerequest *TargetPoolsAddInstanceRequest) *TargetPoolsAddInstanceCall {
- c := &TargetPoolsAddInstanceCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.targetPool = targetPool
- c.targetpoolsaddinstancerequest = targetpoolsaddinstancerequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetPoolsAddInstanceCall) Fields(s ...googleapi.Field) *TargetPoolsAddInstanceCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetPoolsAddInstanceCall) Context(ctx context.Context) *TargetPoolsAddInstanceCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetPoolsAddInstanceCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.targetpoolsaddinstancerequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/targetPools/{targetPool}/addInstance")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "targetPool": c.targetPool,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetPools.addInstance" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetPoolsAddInstanceCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Adds instance url to targetPool.",
- // "httpMethod": "POST",
- // "id": "compute.targetPools.addInstance",
- // "parameterOrder": [
- // "project",
- // "region",
- // "targetPool"
- // ],
- // "parameters": {
- // "project": {
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "targetPool": {
- // "description": "Name of the TargetPool resource to which instance_url is to be added.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/targetPools/{targetPool}/addInstance",
- // "request": {
- // "$ref": "TargetPoolsAddInstanceRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetPools.aggregatedList":
-
-type TargetPoolsAggregatedListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AggregatedList: Retrieves the list of target pools grouped by scope.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetPools/aggregatedList
-func (r *TargetPoolsService) AggregatedList(project string) *TargetPoolsAggregatedListCall {
- c := &TargetPoolsAggregatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *TargetPoolsAggregatedListCall) Filter(filter string) *TargetPoolsAggregatedListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *TargetPoolsAggregatedListCall) MaxResults(maxResults int64) *TargetPoolsAggregatedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *TargetPoolsAggregatedListCall) OrderBy(orderBy string) *TargetPoolsAggregatedListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *TargetPoolsAggregatedListCall) PageToken(pageToken string) *TargetPoolsAggregatedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetPoolsAggregatedListCall) Fields(s ...googleapi.Field) *TargetPoolsAggregatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TargetPoolsAggregatedListCall) IfNoneMatch(entityTag string) *TargetPoolsAggregatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetPoolsAggregatedListCall) Context(ctx context.Context) *TargetPoolsAggregatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetPoolsAggregatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/aggregated/targetPools")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetPools.aggregatedList" call.
-// Exactly one of *TargetPoolAggregatedList or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *TargetPoolAggregatedList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TargetPoolsAggregatedListCall) Do() (*TargetPoolAggregatedList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetPoolAggregatedList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of target pools grouped by scope.",
- // "httpMethod": "GET",
- // "id": "compute.targetPools.aggregatedList",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/aggregated/targetPools",
- // "response": {
- // "$ref": "TargetPoolAggregatedList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.targetPools.delete":
-
-type TargetPoolsDeleteCall struct {
- s *Service
- project string
- region string
- targetPool string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified TargetPool resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetPools/delete
-func (r *TargetPoolsService) Delete(project string, region string, targetPool string) *TargetPoolsDeleteCall {
- c := &TargetPoolsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.targetPool = targetPool
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetPoolsDeleteCall) Fields(s ...googleapi.Field) *TargetPoolsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetPoolsDeleteCall) Context(ctx context.Context) *TargetPoolsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetPoolsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/targetPools/{targetPool}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "targetPool": c.targetPool,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetPools.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetPoolsDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified TargetPool resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.targetPools.delete",
- // "parameterOrder": [
- // "project",
- // "region",
- // "targetPool"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "targetPool": {
- // "description": "Name of the TargetPool resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/targetPools/{targetPool}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetPools.get":
-
-type TargetPoolsGetCall struct {
- s *Service
- project string
- region string
- targetPool string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified TargetPool resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetPools/get
-func (r *TargetPoolsService) Get(project string, region string, targetPool string) *TargetPoolsGetCall {
- c := &TargetPoolsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.targetPool = targetPool
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetPoolsGetCall) Fields(s ...googleapi.Field) *TargetPoolsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TargetPoolsGetCall) IfNoneMatch(entityTag string) *TargetPoolsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetPoolsGetCall) Context(ctx context.Context) *TargetPoolsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetPoolsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/targetPools/{targetPool}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "targetPool": c.targetPool,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetPools.get" call.
-// Exactly one of *TargetPool or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *TargetPool.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetPoolsGetCall) Do() (*TargetPool, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetPool{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified TargetPool resource.",
- // "httpMethod": "GET",
- // "id": "compute.targetPools.get",
- // "parameterOrder": [
- // "project",
- // "region",
- // "targetPool"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "targetPool": {
- // "description": "Name of the TargetPool resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/targetPools/{targetPool}",
- // "response": {
- // "$ref": "TargetPool"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.targetPools.getHealth":
-
-type TargetPoolsGetHealthCall struct {
- s *Service
- project string
- region string
- targetPool string
- instancereference *InstanceReference
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetHealth: Gets the most recent health check results for each IP for
-// the given instance that is referenced by given TargetPool.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetPools/getHealth
-func (r *TargetPoolsService) GetHealth(project string, region string, targetPool string, instancereference *InstanceReference) *TargetPoolsGetHealthCall {
- c := &TargetPoolsGetHealthCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.targetPool = targetPool
- c.instancereference = instancereference
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetPoolsGetHealthCall) Fields(s ...googleapi.Field) *TargetPoolsGetHealthCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetPoolsGetHealthCall) Context(ctx context.Context) *TargetPoolsGetHealthCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetPoolsGetHealthCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancereference)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/targetPools/{targetPool}/getHealth")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "targetPool": c.targetPool,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetPools.getHealth" call.
-// Exactly one of *TargetPoolInstanceHealth or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *TargetPoolInstanceHealth.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TargetPoolsGetHealthCall) Do() (*TargetPoolInstanceHealth, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetPoolInstanceHealth{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the most recent health check results for each IP for the given instance that is referenced by given TargetPool.",
- // "httpMethod": "POST",
- // "id": "compute.targetPools.getHealth",
- // "parameterOrder": [
- // "project",
- // "region",
- // "targetPool"
- // ],
- // "parameters": {
- // "project": {
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "targetPool": {
- // "description": "Name of the TargetPool resource to which the queried instance belongs.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/targetPools/{targetPool}/getHealth",
- // "request": {
- // "$ref": "InstanceReference"
- // },
- // "response": {
- // "$ref": "TargetPoolInstanceHealth"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.targetPools.insert":
-
-type TargetPoolsInsertCall struct {
- s *Service
- project string
- region string
- targetpool *TargetPool
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a TargetPool resource in the specified project and
-// region using the data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetPools/insert
-func (r *TargetPoolsService) Insert(project string, region string, targetpool *TargetPool) *TargetPoolsInsertCall {
- c := &TargetPoolsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.targetpool = targetpool
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetPoolsInsertCall) Fields(s ...googleapi.Field) *TargetPoolsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetPoolsInsertCall) Context(ctx context.Context) *TargetPoolsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetPoolsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.targetpool)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/targetPools")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetPools.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetPoolsInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a TargetPool resource in the specified project and region using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.targetPools.insert",
- // "parameterOrder": [
- // "project",
- // "region"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/targetPools",
- // "request": {
- // "$ref": "TargetPool"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetPools.list":
-
-type TargetPoolsListCall struct {
- s *Service
- project string
- region string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of TargetPool resources available to the
-// specified project and region.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetPools/list
-func (r *TargetPoolsService) List(project string, region string) *TargetPoolsListCall {
- c := &TargetPoolsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *TargetPoolsListCall) Filter(filter string) *TargetPoolsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *TargetPoolsListCall) MaxResults(maxResults int64) *TargetPoolsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *TargetPoolsListCall) OrderBy(orderBy string) *TargetPoolsListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *TargetPoolsListCall) PageToken(pageToken string) *TargetPoolsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetPoolsListCall) Fields(s ...googleapi.Field) *TargetPoolsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TargetPoolsListCall) IfNoneMatch(entityTag string) *TargetPoolsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetPoolsListCall) Context(ctx context.Context) *TargetPoolsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetPoolsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/targetPools")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetPools.list" call.
-// Exactly one of *TargetPoolList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *TargetPoolList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TargetPoolsListCall) Do() (*TargetPoolList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetPoolList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of TargetPool resources available to the specified project and region.",
- // "httpMethod": "GET",
- // "id": "compute.targetPools.list",
- // "parameterOrder": [
- // "project",
- // "region"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/targetPools",
- // "response": {
- // "$ref": "TargetPoolList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.targetPools.removeHealthCheck":
-
-type TargetPoolsRemoveHealthCheckCall struct {
- s *Service
- project string
- region string
- targetPool string
- targetpoolsremovehealthcheckrequest *TargetPoolsRemoveHealthCheckRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// RemoveHealthCheck: Removes health check URL from targetPool.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetPools/removeHealthCheck
-func (r *TargetPoolsService) RemoveHealthCheck(project string, region string, targetPool string, targetpoolsremovehealthcheckrequest *TargetPoolsRemoveHealthCheckRequest) *TargetPoolsRemoveHealthCheckCall {
- c := &TargetPoolsRemoveHealthCheckCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.targetPool = targetPool
- c.targetpoolsremovehealthcheckrequest = targetpoolsremovehealthcheckrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetPoolsRemoveHealthCheckCall) Fields(s ...googleapi.Field) *TargetPoolsRemoveHealthCheckCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetPoolsRemoveHealthCheckCall) Context(ctx context.Context) *TargetPoolsRemoveHealthCheckCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetPoolsRemoveHealthCheckCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.targetpoolsremovehealthcheckrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "targetPool": c.targetPool,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetPools.removeHealthCheck" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetPoolsRemoveHealthCheckCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Removes health check URL from targetPool.",
- // "httpMethod": "POST",
- // "id": "compute.targetPools.removeHealthCheck",
- // "parameterOrder": [
- // "project",
- // "region",
- // "targetPool"
- // ],
- // "parameters": {
- // "project": {
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "targetPool": {
- // "description": "Name of the TargetPool resource to which health_check_url is to be removed.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck",
- // "request": {
- // "$ref": "TargetPoolsRemoveHealthCheckRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetPools.removeInstance":
-
-type TargetPoolsRemoveInstanceCall struct {
- s *Service
- project string
- region string
- targetPool string
- targetpoolsremoveinstancerequest *TargetPoolsRemoveInstanceRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// RemoveInstance: Removes instance URL from targetPool.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetPools/removeInstance
-func (r *TargetPoolsService) RemoveInstance(project string, region string, targetPool string, targetpoolsremoveinstancerequest *TargetPoolsRemoveInstanceRequest) *TargetPoolsRemoveInstanceCall {
- c := &TargetPoolsRemoveInstanceCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.targetPool = targetPool
- c.targetpoolsremoveinstancerequest = targetpoolsremoveinstancerequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetPoolsRemoveInstanceCall) Fields(s ...googleapi.Field) *TargetPoolsRemoveInstanceCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetPoolsRemoveInstanceCall) Context(ctx context.Context) *TargetPoolsRemoveInstanceCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetPoolsRemoveInstanceCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.targetpoolsremoveinstancerequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/targetPools/{targetPool}/removeInstance")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "targetPool": c.targetPool,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetPools.removeInstance" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetPoolsRemoveInstanceCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Removes instance URL from targetPool.",
- // "httpMethod": "POST",
- // "id": "compute.targetPools.removeInstance",
- // "parameterOrder": [
- // "project",
- // "region",
- // "targetPool"
- // ],
- // "parameters": {
- // "project": {
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "targetPool": {
- // "description": "Name of the TargetPool resource to which instance_url is to be removed.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/targetPools/{targetPool}/removeInstance",
- // "request": {
- // "$ref": "TargetPoolsRemoveInstanceRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetPools.setBackup":
-
-type TargetPoolsSetBackupCall struct {
- s *Service
- project string
- region string
- targetPool string
- targetreference *TargetReference
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetBackup: Changes backup pool configurations.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetPools/setBackup
-func (r *TargetPoolsService) SetBackup(project string, region string, targetPool string, targetreference *TargetReference) *TargetPoolsSetBackupCall {
- c := &TargetPoolsSetBackupCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.targetPool = targetPool
- c.targetreference = targetreference
- return c
-}
-
-// FailoverRatio sets the optional parameter "failoverRatio": New
-// failoverRatio value for the containing target pool.
-func (c *TargetPoolsSetBackupCall) FailoverRatio(failoverRatio float64) *TargetPoolsSetBackupCall {
- c.opt_["failoverRatio"] = failoverRatio
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetPoolsSetBackupCall) Fields(s ...googleapi.Field) *TargetPoolsSetBackupCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetPoolsSetBackupCall) Context(ctx context.Context) *TargetPoolsSetBackupCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetPoolsSetBackupCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.targetreference)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["failoverRatio"]; ok {
- params.Set("failoverRatio", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/targetPools/{targetPool}/setBackup")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "targetPool": c.targetPool,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetPools.setBackup" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetPoolsSetBackupCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Changes backup pool configurations.",
- // "httpMethod": "POST",
- // "id": "compute.targetPools.setBackup",
- // "parameterOrder": [
- // "project",
- // "region",
- // "targetPool"
- // ],
- // "parameters": {
- // "failoverRatio": {
- // "description": "New failoverRatio value for the containing target pool.",
- // "format": "float",
- // "location": "query",
- // "type": "number"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "targetPool": {
- // "description": "Name of the TargetPool resource for which the backup is to be set.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/targetPools/{targetPool}/setBackup",
- // "request": {
- // "$ref": "TargetReference"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetVpnGateways.aggregatedList":
-
-type TargetVpnGatewaysAggregatedListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AggregatedList: Retrieves the list of target VPN gateways grouped by
-// scope.
-func (r *TargetVpnGatewaysService) AggregatedList(project string) *TargetVpnGatewaysAggregatedListCall {
- c := &TargetVpnGatewaysAggregatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *TargetVpnGatewaysAggregatedListCall) Filter(filter string) *TargetVpnGatewaysAggregatedListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *TargetVpnGatewaysAggregatedListCall) MaxResults(maxResults int64) *TargetVpnGatewaysAggregatedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *TargetVpnGatewaysAggregatedListCall) OrderBy(orderBy string) *TargetVpnGatewaysAggregatedListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *TargetVpnGatewaysAggregatedListCall) PageToken(pageToken string) *TargetVpnGatewaysAggregatedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetVpnGatewaysAggregatedListCall) Fields(s ...googleapi.Field) *TargetVpnGatewaysAggregatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TargetVpnGatewaysAggregatedListCall) IfNoneMatch(entityTag string) *TargetVpnGatewaysAggregatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetVpnGatewaysAggregatedListCall) Context(ctx context.Context) *TargetVpnGatewaysAggregatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetVpnGatewaysAggregatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/aggregated/targetVpnGateways")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetVpnGateways.aggregatedList" call.
-// Exactly one of *TargetVpnGatewayAggregatedList or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *TargetVpnGatewayAggregatedList.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TargetVpnGatewaysAggregatedListCall) Do() (*TargetVpnGatewayAggregatedList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetVpnGatewayAggregatedList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of target VPN gateways grouped by scope.",
- // "httpMethod": "GET",
- // "id": "compute.targetVpnGateways.aggregatedList",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/aggregated/targetVpnGateways",
- // "response": {
- // "$ref": "TargetVpnGatewayAggregatedList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.targetVpnGateways.delete":
-
-type TargetVpnGatewaysDeleteCall struct {
- s *Service
- project string
- region string
- targetVpnGateway string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified TargetVpnGateway resource.
-func (r *TargetVpnGatewaysService) Delete(project string, region string, targetVpnGateway string) *TargetVpnGatewaysDeleteCall {
- c := &TargetVpnGatewaysDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.targetVpnGateway = targetVpnGateway
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetVpnGatewaysDeleteCall) Fields(s ...googleapi.Field) *TargetVpnGatewaysDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetVpnGatewaysDeleteCall) Context(ctx context.Context) *TargetVpnGatewaysDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetVpnGatewaysDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "targetVpnGateway": c.targetVpnGateway,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetVpnGateways.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetVpnGatewaysDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified TargetVpnGateway resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.targetVpnGateways.delete",
- // "parameterOrder": [
- // "project",
- // "region",
- // "targetVpnGateway"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "The name of the region for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "targetVpnGateway": {
- // "description": "Name of the TargetVpnGateway resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetVpnGateways.get":
-
-type TargetVpnGatewaysGetCall struct {
- s *Service
- project string
- region string
- targetVpnGateway string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified TargetVpnGateway resource.
-func (r *TargetVpnGatewaysService) Get(project string, region string, targetVpnGateway string) *TargetVpnGatewaysGetCall {
- c := &TargetVpnGatewaysGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.targetVpnGateway = targetVpnGateway
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetVpnGatewaysGetCall) Fields(s ...googleapi.Field) *TargetVpnGatewaysGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TargetVpnGatewaysGetCall) IfNoneMatch(entityTag string) *TargetVpnGatewaysGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetVpnGatewaysGetCall) Context(ctx context.Context) *TargetVpnGatewaysGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetVpnGatewaysGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "targetVpnGateway": c.targetVpnGateway,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetVpnGateways.get" call.
-// Exactly one of *TargetVpnGateway or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *TargetVpnGateway.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TargetVpnGatewaysGetCall) Do() (*TargetVpnGateway, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetVpnGateway{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified TargetVpnGateway resource.",
- // "httpMethod": "GET",
- // "id": "compute.targetVpnGateways.get",
- // "parameterOrder": [
- // "project",
- // "region",
- // "targetVpnGateway"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "The name of the region for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "targetVpnGateway": {
- // "description": "Name of the TargetVpnGateway resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}",
- // "response": {
- // "$ref": "TargetVpnGateway"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.targetVpnGateways.insert":
-
-type TargetVpnGatewaysInsertCall struct {
- s *Service
- project string
- region string
- targetvpngateway *TargetVpnGateway
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a TargetVpnGateway resource in the specified project
-// and region using the data included in the request.
-func (r *TargetVpnGatewaysService) Insert(project string, region string, targetvpngateway *TargetVpnGateway) *TargetVpnGatewaysInsertCall {
- c := &TargetVpnGatewaysInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.targetvpngateway = targetvpngateway
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetVpnGatewaysInsertCall) Fields(s ...googleapi.Field) *TargetVpnGatewaysInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetVpnGatewaysInsertCall) Context(ctx context.Context) *TargetVpnGatewaysInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetVpnGatewaysInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.targetvpngateway)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/targetVpnGateways")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetVpnGateways.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetVpnGatewaysInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a TargetVpnGateway resource in the specified project and region using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.targetVpnGateways.insert",
- // "parameterOrder": [
- // "project",
- // "region"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "The name of the region for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/targetVpnGateways",
- // "request": {
- // "$ref": "TargetVpnGateway"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetVpnGateways.list":
-
-type TargetVpnGatewaysListCall struct {
- s *Service
- project string
- region string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of TargetVpnGateway resources available to
-// the specified project and region.
-func (r *TargetVpnGatewaysService) List(project string, region string) *TargetVpnGatewaysListCall {
- c := &TargetVpnGatewaysListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *TargetVpnGatewaysListCall) Filter(filter string) *TargetVpnGatewaysListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *TargetVpnGatewaysListCall) MaxResults(maxResults int64) *TargetVpnGatewaysListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *TargetVpnGatewaysListCall) OrderBy(orderBy string) *TargetVpnGatewaysListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *TargetVpnGatewaysListCall) PageToken(pageToken string) *TargetVpnGatewaysListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetVpnGatewaysListCall) Fields(s ...googleapi.Field) *TargetVpnGatewaysListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TargetVpnGatewaysListCall) IfNoneMatch(entityTag string) *TargetVpnGatewaysListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetVpnGatewaysListCall) Context(ctx context.Context) *TargetVpnGatewaysListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetVpnGatewaysListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/targetVpnGateways")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetVpnGateways.list" call.
-// Exactly one of *TargetVpnGatewayList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *TargetVpnGatewayList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TargetVpnGatewaysListCall) Do() (*TargetVpnGatewayList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetVpnGatewayList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of TargetVpnGateway resources available to the specified project and region.",
- // "httpMethod": "GET",
- // "id": "compute.targetVpnGateways.list",
- // "parameterOrder": [
- // "project",
- // "region"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "The name of the region for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/targetVpnGateways",
- // "response": {
- // "$ref": "TargetVpnGatewayList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.urlMaps.delete":
-
-type UrlMapsDeleteCall struct {
- s *Service
- project string
- urlMap string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified UrlMap resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/urlMaps/delete
-func (r *UrlMapsService) Delete(project string, urlMap string) *UrlMapsDeleteCall {
- c := &UrlMapsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.urlMap = urlMap
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UrlMapsDeleteCall) Fields(s ...googleapi.Field) *UrlMapsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UrlMapsDeleteCall) Context(ctx context.Context) *UrlMapsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UrlMapsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/urlMaps/{urlMap}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "urlMap": c.urlMap,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.urlMaps.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UrlMapsDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified UrlMap resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.urlMaps.delete",
- // "parameterOrder": [
- // "project",
- // "urlMap"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "urlMap": {
- // "description": "Name of the UrlMap resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/urlMaps/{urlMap}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.urlMaps.get":
-
-type UrlMapsGetCall struct {
- s *Service
- project string
- urlMap string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified UrlMap resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/urlMaps/get
-func (r *UrlMapsService) Get(project string, urlMap string) *UrlMapsGetCall {
- c := &UrlMapsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.urlMap = urlMap
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UrlMapsGetCall) Fields(s ...googleapi.Field) *UrlMapsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UrlMapsGetCall) IfNoneMatch(entityTag string) *UrlMapsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UrlMapsGetCall) Context(ctx context.Context) *UrlMapsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UrlMapsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/urlMaps/{urlMap}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "urlMap": c.urlMap,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.urlMaps.get" call.
-// Exactly one of *UrlMap or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *UrlMap.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *UrlMapsGetCall) Do() (*UrlMap, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UrlMap{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified UrlMap resource.",
- // "httpMethod": "GET",
- // "id": "compute.urlMaps.get",
- // "parameterOrder": [
- // "project",
- // "urlMap"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "urlMap": {
- // "description": "Name of the UrlMap resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/urlMaps/{urlMap}",
- // "response": {
- // "$ref": "UrlMap"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.urlMaps.insert":
-
-type UrlMapsInsertCall struct {
- s *Service
- project string
- urlmap *UrlMap
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a UrlMap resource in the specified project using the
-// data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/urlMaps/insert
-func (r *UrlMapsService) Insert(project string, urlmap *UrlMap) *UrlMapsInsertCall {
- c := &UrlMapsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.urlmap = urlmap
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UrlMapsInsertCall) Fields(s ...googleapi.Field) *UrlMapsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UrlMapsInsertCall) Context(ctx context.Context) *UrlMapsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UrlMapsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.urlmap)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/urlMaps")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.urlMaps.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UrlMapsInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a UrlMap resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.urlMaps.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/urlMaps",
- // "request": {
- // "$ref": "UrlMap"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.urlMaps.list":
-
-type UrlMapsListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of UrlMap resources available to the
-// specified project.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/urlMaps/list
-func (r *UrlMapsService) List(project string) *UrlMapsListCall {
- c := &UrlMapsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *UrlMapsListCall) Filter(filter string) *UrlMapsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *UrlMapsListCall) MaxResults(maxResults int64) *UrlMapsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *UrlMapsListCall) OrderBy(orderBy string) *UrlMapsListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *UrlMapsListCall) PageToken(pageToken string) *UrlMapsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UrlMapsListCall) Fields(s ...googleapi.Field) *UrlMapsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UrlMapsListCall) IfNoneMatch(entityTag string) *UrlMapsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UrlMapsListCall) Context(ctx context.Context) *UrlMapsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UrlMapsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/urlMaps")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.urlMaps.list" call.
-// Exactly one of *UrlMapList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UrlMapList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UrlMapsListCall) Do() (*UrlMapList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UrlMapList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of UrlMap resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.urlMaps.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/urlMaps",
- // "response": {
- // "$ref": "UrlMapList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.urlMaps.patch":
-
-type UrlMapsPatchCall struct {
- s *Service
- project string
- urlMap string
- urlmap *UrlMap
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Update the entire content of the UrlMap resource. This method
-// supports patch semantics.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/urlMaps/patch
-func (r *UrlMapsService) Patch(project string, urlMap string, urlmap *UrlMap) *UrlMapsPatchCall {
- c := &UrlMapsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.urlMap = urlMap
- c.urlmap = urlmap
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UrlMapsPatchCall) Fields(s ...googleapi.Field) *UrlMapsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UrlMapsPatchCall) Context(ctx context.Context) *UrlMapsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UrlMapsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.urlmap)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/urlMaps/{urlMap}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "urlMap": c.urlMap,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.urlMaps.patch" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UrlMapsPatchCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update the entire content of the UrlMap resource. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "compute.urlMaps.patch",
- // "parameterOrder": [
- // "project",
- // "urlMap"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "urlMap": {
- // "description": "Name of the UrlMap resource to update.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/urlMaps/{urlMap}",
- // "request": {
- // "$ref": "UrlMap"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.urlMaps.update":
-
-type UrlMapsUpdateCall struct {
- s *Service
- project string
- urlMap string
- urlmap *UrlMap
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Update the entire content of the UrlMap resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/urlMaps/update
-func (r *UrlMapsService) Update(project string, urlMap string, urlmap *UrlMap) *UrlMapsUpdateCall {
- c := &UrlMapsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.urlMap = urlMap
- c.urlmap = urlmap
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UrlMapsUpdateCall) Fields(s ...googleapi.Field) *UrlMapsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UrlMapsUpdateCall) Context(ctx context.Context) *UrlMapsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UrlMapsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.urlmap)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/urlMaps/{urlMap}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "urlMap": c.urlMap,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.urlMaps.update" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UrlMapsUpdateCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update the entire content of the UrlMap resource.",
- // "httpMethod": "PUT",
- // "id": "compute.urlMaps.update",
- // "parameterOrder": [
- // "project",
- // "urlMap"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "urlMap": {
- // "description": "Name of the UrlMap resource to update.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/urlMaps/{urlMap}",
- // "request": {
- // "$ref": "UrlMap"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.urlMaps.validate":
-
-type UrlMapsValidateCall struct {
- s *Service
- project string
- urlMap string
- urlmapsvalidaterequest *UrlMapsValidateRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Validate: Run static validation for the UrlMap. In particular, the
-// tests of the provided UrlMap will be run. Calling this method does
-// NOT create the UrlMap.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/urlMaps/validate
-func (r *UrlMapsService) Validate(project string, urlMap string, urlmapsvalidaterequest *UrlMapsValidateRequest) *UrlMapsValidateCall {
- c := &UrlMapsValidateCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.urlMap = urlMap
- c.urlmapsvalidaterequest = urlmapsvalidaterequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UrlMapsValidateCall) Fields(s ...googleapi.Field) *UrlMapsValidateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UrlMapsValidateCall) Context(ctx context.Context) *UrlMapsValidateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UrlMapsValidateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.urlmapsvalidaterequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/urlMaps/{urlMap}/validate")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "urlMap": c.urlMap,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.urlMaps.validate" call.
-// Exactly one of *UrlMapsValidateResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *UrlMapsValidateResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *UrlMapsValidateCall) Do() (*UrlMapsValidateResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UrlMapsValidateResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Run static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.",
- // "httpMethod": "POST",
- // "id": "compute.urlMaps.validate",
- // "parameterOrder": [
- // "project",
- // "urlMap"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "urlMap": {
- // "description": "Name of the UrlMap resource to be validated as.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/urlMaps/{urlMap}/validate",
- // "request": {
- // "$ref": "UrlMapsValidateRequest"
- // },
- // "response": {
- // "$ref": "UrlMapsValidateResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.vpnTunnels.aggregatedList":
-
-type VpnTunnelsAggregatedListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AggregatedList: Retrieves the list of VPN tunnels grouped by scope.
-func (r *VpnTunnelsService) AggregatedList(project string) *VpnTunnelsAggregatedListCall {
- c := &VpnTunnelsAggregatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *VpnTunnelsAggregatedListCall) Filter(filter string) *VpnTunnelsAggregatedListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *VpnTunnelsAggregatedListCall) MaxResults(maxResults int64) *VpnTunnelsAggregatedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *VpnTunnelsAggregatedListCall) OrderBy(orderBy string) *VpnTunnelsAggregatedListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *VpnTunnelsAggregatedListCall) PageToken(pageToken string) *VpnTunnelsAggregatedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *VpnTunnelsAggregatedListCall) Fields(s ...googleapi.Field) *VpnTunnelsAggregatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *VpnTunnelsAggregatedListCall) IfNoneMatch(entityTag string) *VpnTunnelsAggregatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *VpnTunnelsAggregatedListCall) Context(ctx context.Context) *VpnTunnelsAggregatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *VpnTunnelsAggregatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/aggregated/vpnTunnels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.vpnTunnels.aggregatedList" call.
-// Exactly one of *VpnTunnelAggregatedList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *VpnTunnelAggregatedList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *VpnTunnelsAggregatedListCall) Do() (*VpnTunnelAggregatedList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &VpnTunnelAggregatedList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of VPN tunnels grouped by scope.",
- // "httpMethod": "GET",
- // "id": "compute.vpnTunnels.aggregatedList",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/aggregated/vpnTunnels",
- // "response": {
- // "$ref": "VpnTunnelAggregatedList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.vpnTunnels.delete":
-
-type VpnTunnelsDeleteCall struct {
- s *Service
- project string
- region string
- vpnTunnel string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified VpnTunnel resource.
-func (r *VpnTunnelsService) Delete(project string, region string, vpnTunnel string) *VpnTunnelsDeleteCall {
- c := &VpnTunnelsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.vpnTunnel = vpnTunnel
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *VpnTunnelsDeleteCall) Fields(s ...googleapi.Field) *VpnTunnelsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *VpnTunnelsDeleteCall) Context(ctx context.Context) *VpnTunnelsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *VpnTunnelsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/vpnTunnels/{vpnTunnel}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "vpnTunnel": c.vpnTunnel,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.vpnTunnels.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *VpnTunnelsDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified VpnTunnel resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.vpnTunnels.delete",
- // "parameterOrder": [
- // "project",
- // "region",
- // "vpnTunnel"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "The name of the region for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "vpnTunnel": {
- // "description": "Name of the VpnTunnel resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/vpnTunnels/{vpnTunnel}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.vpnTunnels.get":
-
-type VpnTunnelsGetCall struct {
- s *Service
- project string
- region string
- vpnTunnel string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified VpnTunnel resource.
-func (r *VpnTunnelsService) Get(project string, region string, vpnTunnel string) *VpnTunnelsGetCall {
- c := &VpnTunnelsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.vpnTunnel = vpnTunnel
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *VpnTunnelsGetCall) Fields(s ...googleapi.Field) *VpnTunnelsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *VpnTunnelsGetCall) IfNoneMatch(entityTag string) *VpnTunnelsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *VpnTunnelsGetCall) Context(ctx context.Context) *VpnTunnelsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *VpnTunnelsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/vpnTunnels/{vpnTunnel}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "vpnTunnel": c.vpnTunnel,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.vpnTunnels.get" call.
-// Exactly one of *VpnTunnel or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *VpnTunnel.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *VpnTunnelsGetCall) Do() (*VpnTunnel, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &VpnTunnel{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified VpnTunnel resource.",
- // "httpMethod": "GET",
- // "id": "compute.vpnTunnels.get",
- // "parameterOrder": [
- // "project",
- // "region",
- // "vpnTunnel"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "The name of the region for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "vpnTunnel": {
- // "description": "Name of the VpnTunnel resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/vpnTunnels/{vpnTunnel}",
- // "response": {
- // "$ref": "VpnTunnel"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.vpnTunnels.insert":
-
-type VpnTunnelsInsertCall struct {
- s *Service
- project string
- region string
- vpntunnel *VpnTunnel
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a VpnTunnel resource in the specified project and
-// region using the data included in the request.
-func (r *VpnTunnelsService) Insert(project string, region string, vpntunnel *VpnTunnel) *VpnTunnelsInsertCall {
- c := &VpnTunnelsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.vpntunnel = vpntunnel
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *VpnTunnelsInsertCall) Fields(s ...googleapi.Field) *VpnTunnelsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *VpnTunnelsInsertCall) Context(ctx context.Context) *VpnTunnelsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *VpnTunnelsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.vpntunnel)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/vpnTunnels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.vpnTunnels.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *VpnTunnelsInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a VpnTunnel resource in the specified project and region using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.vpnTunnels.insert",
- // "parameterOrder": [
- // "project",
- // "region"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "The name of the region for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/vpnTunnels",
- // "request": {
- // "$ref": "VpnTunnel"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.vpnTunnels.list":
-
-type VpnTunnelsListCall struct {
- s *Service
- project string
- region string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of VpnTunnel resources contained in the
-// specified project and region.
-func (r *VpnTunnelsService) List(project string, region string) *VpnTunnelsListCall {
- c := &VpnTunnelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *VpnTunnelsListCall) Filter(filter string) *VpnTunnelsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *VpnTunnelsListCall) MaxResults(maxResults int64) *VpnTunnelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *VpnTunnelsListCall) OrderBy(orderBy string) *VpnTunnelsListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *VpnTunnelsListCall) PageToken(pageToken string) *VpnTunnelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *VpnTunnelsListCall) Fields(s ...googleapi.Field) *VpnTunnelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *VpnTunnelsListCall) IfNoneMatch(entityTag string) *VpnTunnelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *VpnTunnelsListCall) Context(ctx context.Context) *VpnTunnelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *VpnTunnelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/vpnTunnels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.vpnTunnels.list" call.
-// Exactly one of *VpnTunnelList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *VpnTunnelList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *VpnTunnelsListCall) Do() (*VpnTunnelList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &VpnTunnelList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of VpnTunnel resources contained in the specified project and region.",
- // "httpMethod": "GET",
- // "id": "compute.vpnTunnels.list",
- // "parameterOrder": [
- // "project",
- // "region"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "The name of the region for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/vpnTunnels",
- // "response": {
- // "$ref": "VpnTunnelList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.zoneOperations.delete":
-
-type ZoneOperationsDeleteCall struct {
- s *Service
- project string
- zone string
- operation string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified zone-specific Operations resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/zoneOperations/delete
-func (r *ZoneOperationsService) Delete(project string, zone string, operation string) *ZoneOperationsDeleteCall {
- c := &ZoneOperationsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.operation = operation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ZoneOperationsDeleteCall) Fields(s ...googleapi.Field) *ZoneOperationsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ZoneOperationsDeleteCall) Context(ctx context.Context) *ZoneOperationsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ZoneOperationsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/operations/{operation}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "operation": c.operation,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.zoneOperations.delete" call.
-func (c *ZoneOperationsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes the specified zone-specific Operations resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.zoneOperations.delete",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "operation"
- // ],
- // "parameters": {
- // "operation": {
- // "description": "Name of the Operations resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/operations/{operation}",
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.zoneOperations.get":
-
-type ZoneOperationsGetCall struct {
- s *Service
- project string
- zone string
- operation string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves the specified zone-specific Operations resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/zoneOperations/get
-func (r *ZoneOperationsService) Get(project string, zone string, operation string) *ZoneOperationsGetCall {
- c := &ZoneOperationsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.operation = operation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ZoneOperationsGetCall) Fields(s ...googleapi.Field) *ZoneOperationsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ZoneOperationsGetCall) IfNoneMatch(entityTag string) *ZoneOperationsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ZoneOperationsGetCall) Context(ctx context.Context) *ZoneOperationsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ZoneOperationsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/operations/{operation}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "operation": c.operation,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.zoneOperations.get" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ZoneOperationsGetCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the specified zone-specific Operations resource.",
- // "httpMethod": "GET",
- // "id": "compute.zoneOperations.get",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "operation"
- // ],
- // "parameters": {
- // "operation": {
- // "description": "Name of the Operations resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/operations/{operation}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.zoneOperations.list":
-
-type ZoneOperationsListCall struct {
- s *Service
- project string
- zone string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of Operation resources contained within the
-// specified zone.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/zoneOperations/list
-func (r *ZoneOperationsService) List(project string, zone string) *ZoneOperationsListCall {
- c := &ZoneOperationsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *ZoneOperationsListCall) Filter(filter string) *ZoneOperationsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *ZoneOperationsListCall) MaxResults(maxResults int64) *ZoneOperationsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *ZoneOperationsListCall) OrderBy(orderBy string) *ZoneOperationsListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *ZoneOperationsListCall) PageToken(pageToken string) *ZoneOperationsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ZoneOperationsListCall) Fields(s ...googleapi.Field) *ZoneOperationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ZoneOperationsListCall) IfNoneMatch(entityTag string) *ZoneOperationsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ZoneOperationsListCall) Context(ctx context.Context) *ZoneOperationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ZoneOperationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/operations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.zoneOperations.list" call.
-// Exactly one of *OperationList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *OperationList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ZoneOperationsListCall) Do() (*OperationList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OperationList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of Operation resources contained within the specified zone.",
- // "httpMethod": "GET",
- // "id": "compute.zoneOperations.list",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/operations",
- // "response": {
- // "$ref": "OperationList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.zones.get":
-
-type ZonesGetCall struct {
- s *Service
- project string
- zone string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified zone resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/zones/get
-func (r *ZonesService) Get(project string, zone string) *ZonesGetCall {
- c := &ZonesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ZonesGetCall) Fields(s ...googleapi.Field) *ZonesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ZonesGetCall) IfNoneMatch(entityTag string) *ZonesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ZonesGetCall) Context(ctx context.Context) *ZonesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ZonesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.zones.get" call.
-// Exactly one of *Zone or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Zone.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *ZonesGetCall) Do() (*Zone, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Zone{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified zone resource.",
- // "httpMethod": "GET",
- // "id": "compute.zones.get",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}",
- // "response": {
- // "$ref": "Zone"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.zones.list":
-
-type ZonesListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of zone resources available to the specified
-// project.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/zones/list
-func (r *ZonesService) List(project string) *ZonesListCall {
- c := &ZonesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *ZonesListCall) Filter(filter string) *ZonesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *ZonesListCall) MaxResults(maxResults int64) *ZonesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": Sorts list results by
-// a certain order. By default, results are returned in alphanumerical
-// order based on the resource name.
-//
-// You can also sort results in descending order based on the creation
-// timestamp using orderBy="creationTimestamp desc". This sorts results
-// based on the creationTimestamp field in reverse chronological order
-// (newest result first). Use this to sort resources like operations so
-// that the newest operation is returned first.
-//
-// Currently, only sorting by name or creationTimestamp desc is
-// supported.
-func (c *ZonesListCall) OrderBy(orderBy string) *ZonesListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *ZonesListCall) PageToken(pageToken string) *ZonesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ZonesListCall) Fields(s ...googleapi.Field) *ZonesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ZonesListCall) IfNoneMatch(entityTag string) *ZonesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ZonesListCall) Context(ctx context.Context) *ZonesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ZonesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.zones.list" call.
-// Exactly one of *ZoneList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *ZoneList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ZonesListCall) Do() (*ZoneList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ZoneList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of zone resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.zones.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "orderBy": {
- // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones",
- // "response": {
- // "$ref": "ZoneList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/compute/v1/compute-api.json b/vendor/google.golang.org/api/compute/v1/compute-api.json
deleted file mode 100644
index 9b2e56d6..00000000
--- a/vendor/google.golang.org/api/compute/v1/compute-api.json
+++ /dev/null
@@ -1,13950 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/K2YWeNBEH2yOCjdgDssBGJY_KU4\"",
- "discoveryVersion": "v1",
- "id": "compute:v1",
- "name": "compute",
- "version": "v1",
- "revision": "20151015",
- "title": "Compute Engine API",
- "description": "API for the Google Compute Engine service.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/compute_engine-16.png",
- "x32": "https://www.google.com/images/icons/product/compute_engine-32.png"
- },
- "documentationLink": "https://developers.google.com/compute/docs/reference/latest/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/compute/v1/projects/",
- "basePath": "/compute/v1/projects/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "compute/v1/projects/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/compute": {
- "description": "View and manage your Google Compute Engine resources"
- },
- "https://www.googleapis.com/auth/compute.readonly": {
- "description": "View your Google Compute Engine resources"
- },
- "https://www.googleapis.com/auth/devstorage.full_control": {
- "description": "Manage your data and permissions in Google Cloud Storage"
- },
- "https://www.googleapis.com/auth/devstorage.read_only": {
- "description": "View your data in Google Cloud Storage"
- },
- "https://www.googleapis.com/auth/devstorage.read_write": {
- "description": "Manage your data in Google Cloud Storage"
- }
- }
- }
- },
- "schemas": {
- "AccessConfig": {
- "id": "AccessConfig",
- "type": "object",
- "description": "An access configuration attached to an instance's network interface.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#accessConfig for access configs.",
- "default": "compute#accessConfig"
- },
- "name": {
- "type": "string",
- "description": "Name of this access configuration."
- },
- "natIP": {
- "type": "string",
- "description": "An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance."
- },
- "type": {
- "type": "string",
- "description": "The type of configuration. The default and only option is ONE_TO_ONE_NAT.",
- "default": "ONE_TO_ONE_NAT",
- "enum": [
- "ONE_TO_ONE_NAT"
- ],
- "enumDescriptions": [
- ""
- ]
- }
- }
- },
- "Address": {
- "id": "Address",
- "type": "object",
- "description": "A reserved address resource.",
- "properties": {
- "address": {
- "type": "string",
- "description": "The static external IP address represented by this resource."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#address for addresses.",
- "default": "compute#address"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.addresses.insert"
- ]
- }
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "status": {
- "type": "string",
- "description": "[Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.",
- "enum": [
- "IN_USE",
- "RESERVED"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "users": {
- "type": "array",
- "description": "[Output Only] The URLs of the resources that are using this address.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "AddressAggregatedList": {
- "id": "AddressAggregatedList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "object",
- "description": "[Output Only] A map of scoped address lists.",
- "additionalProperties": {
- "$ref": "AddressesScopedList",
- "description": "[Output Only] Name of the scope containing this set of addresses."
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses.",
- "default": "compute#addressAggregatedList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "AddressList": {
- "id": "AddressList",
- "type": "object",
- "description": "Contains a list of address resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of Address resources.",
- "items": {
- "$ref": "Address"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#addressList for lists of addresses.",
- "default": "compute#addressList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- }
- }
- },
- "AddressesScopedList": {
- "id": "AddressesScopedList",
- "type": "object",
- "properties": {
- "addresses": {
- "type": "array",
- "description": "[Output Only] List of addresses contained in this scope.",
- "items": {
- "$ref": "Address"
- }
- },
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning which replaces the list of addresses when the list is empty.",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- },
- "AttachedDisk": {
- "id": "AttachedDisk",
- "type": "object",
- "description": "An instance-attached disk resource.",
- "properties": {
- "autoDelete": {
- "type": "boolean",
- "description": "Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance)."
- },
- "boot": {
- "type": "boolean",
- "description": "Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem."
- },
- "deviceName": {
- "type": "string",
- "description": "Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.\n\nIf not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks."
- },
- "index": {
- "type": "integer",
- "description": "Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.",
- "format": "int32"
- },
- "initializeParams": {
- "$ref": "AttachedDiskInitializeParams",
- "description": "[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.\n\nThis property is mutually exclusive with the source property; you can only define one or the other, but not both."
- },
- "interface": {
- "type": "string",
- "description": "Specifies the disk interface to use for attaching this disk, either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.",
- "enum": [
- "NVME",
- "SCSI"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.",
- "default": "compute#attachedDisk"
- },
- "licenses": {
- "type": "array",
- "description": "[Output Only] Any valid publicly visible licenses.",
- "items": {
- "type": "string"
- }
- },
- "mode": {
- "type": "string",
- "description": "The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.",
- "enum": [
- "READ_ONLY",
- "READ_WRITE"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "source": {
- "type": "string",
- "description": "Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks."
- },
- "type": {
- "type": "string",
- "description": "Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.",
- "enum": [
- "PERSISTENT",
- "SCRATCH"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "annotations": {
- "required": [
- "compute.instances.insert"
- ]
- }
- }
- }
- },
- "AttachedDiskInitializeParams": {
- "id": "AttachedDiskInitializeParams",
- "type": "object",
- "description": "[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.\n\nThis property is mutually exclusive with the source property; you can only define one or the other, but not both.",
- "properties": {
- "diskName": {
- "type": "string",
- "description": "Specifies the disk name. If not specified, the default is to use the name of the instance."
- },
- "diskSizeGb": {
- "type": "string",
- "description": "Specifies the size of the disk in base-2 GB.",
- "format": "int64"
- },
- "diskType": {
- "type": "string",
- "description": "Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:\n\nhttps://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard \n\nOther values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType \n- projects/project/zones/zone/diskTypes/diskType \n- zones/zone/diskTypes/diskType"
- },
- "sourceImage": {
- "type": "string",
- "description": "A source image used to create the disk. You can provide a private (custom) image, and Compute Engine will use the corresponding image from your project. For example:\n\nglobal/images/my-private-image \n\nOr you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:\n\nprojects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD \n\nwhere vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases."
- }
- }
- },
- "Autoscaler": {
- "id": "Autoscaler",
- "type": "object",
- "properties": {
- "autoscalingPolicy": {
- "$ref": "AutoscalingPolicy",
- "description": "Autoscaling configuration."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource.",
- "default": "compute#autoscaler"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.instanceGroups.insert"
- ]
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "target": {
- "type": "string",
- "description": "URL of Instance Group Manager or Replica Pool which will be controlled by Autoscaler."
- },
- "zone": {
- "type": "string",
- "description": "[Output Only] URL of the zone where the instance group resides."
- }
- }
- },
- "AutoscalerAggregatedList": {
- "id": "AutoscalerAggregatedList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "object",
- "description": "A map of scoped autoscaler lists.",
- "additionalProperties": {
- "$ref": "AutoscalersScopedList",
- "description": "Name of the scope containing this set of autoscalers."
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#autoscalerAggregatedList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "AutoscalerList": {
- "id": "AutoscalerList",
- "type": "object",
- "description": "Contains a list of persistent autoscaler resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "A list of Autoscaler resources.",
- "items": {
- "$ref": "Autoscaler"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#autoscalerList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "AutoscalersScopedList": {
- "id": "AutoscalersScopedList",
- "type": "object",
- "properties": {
- "autoscalers": {
- "type": "array",
- "description": "List of autoscalers contained in this scope.",
- "items": {
- "$ref": "Autoscaler"
- }
- },
- "warning": {
- "type": "object",
- "description": "Informational warning which replaces the list of autoscalers when the list is empty.",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- },
- "AutoscalingPolicy": {
- "id": "AutoscalingPolicy",
- "type": "object",
- "description": "Cloud Autoscaler policy.",
- "properties": {
- "coolDownPeriodSec": {
- "type": "integer",
- "description": "The number of seconds that the Autoscaler should wait between two succeeding changes to the number of virtual machines. You should define an interval that is at least as long as the initialization time of a virtual machine and the time it may take for replica pool to create the virtual machine. The default is 60 seconds.",
- "format": "int32"
- },
- "cpuUtilization": {
- "$ref": "AutoscalingPolicyCpuUtilization",
- "description": "TODO(jbartosik): Add support for scaling based on muliple utilization metrics (take max recommendation). Exactly one utilization policy should be provided. Configuration parameters of CPU based autoscaling policy."
- },
- "customMetricUtilizations": {
- "type": "array",
- "description": "Configuration parameters of autoscaling based on custom metric.",
- "items": {
- "$ref": "AutoscalingPolicyCustomMetricUtilization"
- }
- },
- "loadBalancingUtilization": {
- "$ref": "AutoscalingPolicyLoadBalancingUtilization",
- "description": "Configuration parameters of autoscaling based on load balancer."
- },
- "maxNumReplicas": {
- "type": "integer",
- "description": "The maximum number of replicas that the Autoscaler can scale up to. This field is required for config to be effective. Maximum number of replicas should be not lower than minimal number of replicas. Absolute limit for this value is defined in Autoscaler backend.",
- "format": "int32"
- },
- "minNumReplicas": {
- "type": "integer",
- "description": "The minimum number of replicas that the Autoscaler can scale down to. Can't be less than 0. If not provided Autoscaler will choose default value depending on maximal number of replicas.",
- "format": "int32"
- }
- }
- },
- "AutoscalingPolicyCpuUtilization": {
- "id": "AutoscalingPolicyCpuUtilization",
- "type": "object",
- "description": "CPU utilization policy.",
- "properties": {
- "utilizationTarget": {
- "type": "number",
- "description": "The target utilization that the Autoscaler should maintain. It is represented as a fraction of used cores. For example: 6 cores used in 8-core VM are represented here as 0.75. Must be a float value between (0, 1]. If not defined, the default is 0.8.",
- "format": "double"
- }
- }
- },
- "AutoscalingPolicyCustomMetricUtilization": {
- "id": "AutoscalingPolicyCustomMetricUtilization",
- "type": "object",
- "description": "Custom utilization metric policy.",
- "properties": {
- "metric": {
- "type": "string",
- "description": "Identifier of the metric. It should be a Cloud Monitoring metric. The metric can not have negative values. The metric should be an utilization metric (increasing number of VMs handling requests x times should reduce average value of the metric roughly x times). For example you could use: compute.googleapis.com/instance/network/received_bytes_count."
- },
- "utilizationTarget": {
- "type": "number",
- "description": "Target value of the metric which Autoscaler should maintain. Must be a positive value.",
- "format": "double"
- },
- "utilizationTargetType": {
- "type": "string",
- "description": "Defines type in which utilization_target is expressed.",
- "enum": [
- "DELTA_PER_MINUTE",
- "DELTA_PER_SECOND",
- "GAUGE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- }
- }
- },
- "AutoscalingPolicyLoadBalancingUtilization": {
- "id": "AutoscalingPolicyLoadBalancingUtilization",
- "type": "object",
- "description": "Load balancing utilization policy.",
- "properties": {
- "utilizationTarget": {
- "type": "number",
- "description": "Fraction of backend capacity utilization (set in HTTP load balancing configuration) that Autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8. For example if your maxRatePerInstance capacity (in HTTP Load Balancing configuration) is set at 10 and you would like to keep number of instances such that each instance receives 7 QPS on average, set this to 0.7.",
- "format": "double"
- }
- }
- },
- "Backend": {
- "id": "Backend",
- "type": "object",
- "description": "Message containing information of one individual backend.",
- "properties": {
- "balancingMode": {
- "type": "string",
- "description": "Specifies the balancing mode for this backend. The default is UTILIZATION but available values are UTILIZATION and RATE.",
- "enum": [
- "RATE",
- "UTILIZATION"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "capacityScaler": {
- "type": "number",
- "description": "A multiplier applied to the group's maximum servicing capacity (either UTILIZATION or RATE). Default value is 1, which means the group will serve up to 100% of its configured CPU or RPS (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available CPU or RPS. Valid range is [0.0,1.0].",
- "format": "float"
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource. Provided by the client when the resource is created."
- },
- "group": {
- "type": "string",
- "description": "The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.\n\nNote that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL."
- },
- "maxRate": {
- "type": "integer",
- "description": "The max RPS of the group. Can be used with either balancing mode, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.",
- "format": "int32"
- },
- "maxRatePerInstance": {
- "type": "number",
- "description": "The max RPS that a single backed instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.",
- "format": "float"
- },
- "maxUtilization": {
- "type": "number",
- "description": "Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].",
- "format": "float"
- }
- }
- },
- "BackendService": {
- "id": "BackendService",
- "type": "object",
- "description": "A BackendService resource. This resource defines a group of backend virtual machines together with their serving capacity.",
- "properties": {
- "backends": {
- "type": "array",
- "description": "The list of backends that serve this BackendService.",
- "items": {
- "$ref": "Backend"
- }
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource. Provided by the client when the resource is created."
- },
- "fingerprint": {
- "type": "string",
- "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.",
- "format": "byte"
- },
- "healthChecks": {
- "type": "array",
- "description": "The list of URLs to the HttpHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#backendService for backend services.",
- "default": "compute#backendService"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "port": {
- "type": "integer",
- "description": "Deprecated in favor of port name. The TCP port to connect on the backend. The default value is 80.",
- "format": "int32"
- },
- "portName": {
- "type": "string",
- "description": "Name of backend port. The same name should appear in the resource views referenced by this service. Required."
- },
- "protocol": {
- "type": "string",
- "enum": [
- "HTTP",
- "HTTPS"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "timeoutSec": {
- "type": "integer",
- "description": "How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.",
- "format": "int32"
- }
- }
- },
- "BackendServiceGroupHealth": {
- "id": "BackendServiceGroupHealth",
- "type": "object",
- "properties": {
- "healthStatus": {
- "type": "array",
- "items": {
- "$ref": "HealthStatus"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services.",
- "default": "compute#backendServiceGroupHealth"
- }
- }
- },
- "BackendServiceList": {
- "id": "BackendServiceList",
- "type": "object",
- "description": "Contains a list of BackendService resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "A list of BackendService resources.",
- "items": {
- "$ref": "BackendService"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#backendServiceList for lists of backend services.",
- "default": "compute#backendServiceList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "DeprecationStatus": {
- "id": "DeprecationStatus",
- "type": "object",
- "description": "Deprecation status for a public resource.",
- "properties": {
- "deleted": {
- "type": "string",
- "description": "An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED."
- },
- "deprecated": {
- "type": "string",
- "description": "An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED."
- },
- "obsolete": {
- "type": "string",
- "description": "An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE."
- },
- "replacement": {
- "type": "string",
- "description": "The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource."
- },
- "state": {
- "type": "string",
- "description": "The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.",
- "enum": [
- "DELETED",
- "DEPRECATED",
- "OBSOLETE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- }
- }
- },
- "Disk": {
- "id": "Disk",
- "type": "object",
- "description": "A Disk resource.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#disk for disks.",
- "default": "compute#disk"
- },
- "lastAttachTimestamp": {
- "type": "string",
- "description": "[Output Only] Last attach timestamp in RFC3339 text format."
- },
- "lastDetachTimestamp": {
- "type": "string",
- "description": "[Output Only] Last detach timestamp in RFC3339 text format."
- },
- "licenses": {
- "type": "array",
- "description": "Any applicable publicly visible licenses.",
- "items": {
- "type": "string"
- }
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.disks.insert"
- ]
- }
- },
- "options": {
- "type": "string",
- "description": "Internal use only."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined fully-qualified URL for this resource."
- },
- "sizeGb": {
- "type": "string",
- "description": "Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.\n\nIf you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.",
- "format": "int64"
- },
- "sourceImage": {
- "type": "string",
- "description": "The source image used to create this disk. If the source image is deleted from the system, this field will not be set, even if an image with the same name has been re-created.\n\nWhen creating a disk, you can provide a private (custom) image using the following input, and Compute Engine will use the corresponding image from your project. For example:\n\nglobal/images/my-private-image \n\nOr you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:\n\nprojects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD \n\nwhere vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases."
- },
- "sourceImageId": {
- "type": "string",
- "description": "The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used."
- },
- "sourceSnapshot": {
- "type": "string",
- "description": "The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: \n- https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot \n- projects/project/global/snapshots/snapshot \n- global/snapshots/snapshot"
- },
- "sourceSnapshotId": {
- "type": "string",
- "description": "[Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used."
- },
- "status": {
- "type": "string",
- "description": "[Output Only] The status of disk creation. Applicable statuses includes: CREATING, FAILED, READY, RESTORING.",
- "enum": [
- "CREATING",
- "FAILED",
- "READY",
- "RESTORING"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- },
- "type": {
- "type": "string",
- "description": "URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created."
- },
- "users": {
- "type": "array",
- "description": "Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance",
- "items": {
- "type": "string"
- }
- },
- "zone": {
- "type": "string",
- "description": "[Output Only] URL of the zone where the disk resides."
- }
- }
- },
- "DiskAggregatedList": {
- "id": "DiskAggregatedList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "object",
- "description": "[Output Only] A map of scoped disk lists.",
- "additionalProperties": {
- "$ref": "DisksScopedList",
- "description": "[Output Only] Name of the scope containing this set of disks."
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#diskAggregatedList for aggregated lists of persistent disks.",
- "default": "compute#diskAggregatedList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "DiskList": {
- "id": "DiskList",
- "type": "object",
- "description": "A list of Disk resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of persistent disks.",
- "items": {
- "$ref": "Disk"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#diskList for lists of disks.",
- "default": "compute#diskList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "DiskMoveRequest": {
- "id": "DiskMoveRequest",
- "type": "object",
- "properties": {
- "destinationZone": {
- "type": "string",
- "description": "The URL of the destination zone to move the disk to. This can be a full or partial URL. For example, the following are all valid URLs to a zone: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone \n- projects/project/zones/zone \n- zones/zone"
- },
- "targetDisk": {
- "type": "string",
- "description": "The URL of the target disk to move. This can be a full or partial URL. For example, the following are all valid URLs to a disk: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk \n- projects/project/zones/zone/disks/disk \n- zones/zone/disks/disk"
- }
- }
- },
- "DiskType": {
- "id": "DiskType",
- "type": "object",
- "description": "A disk type resource.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "defaultDiskSizeGb": {
- "type": "string",
- "description": "[Output Only] Server-defined default disk size in GB.",
- "format": "int64"
- },
- "deprecated": {
- "$ref": "DeprecationStatus",
- "description": "[Output Only] The deprecation status associated with this disk type."
- },
- "description": {
- "type": "string",
- "description": "[Output Only] An optional textual description of the resource."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#diskType for disk types.",
- "default": "compute#diskType"
- },
- "name": {
- "type": "string",
- "description": "[Output Only] Name of the resource.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "validDiskSize": {
- "type": "string",
- "description": "[Output Only] An optional textual description of the valid disk size, such as \"10GB-10TB\"."
- },
- "zone": {
- "type": "string",
- "description": "[Output Only] URL of the zone where the disk type resides."
- }
- }
- },
- "DiskTypeAggregatedList": {
- "id": "DiskTypeAggregatedList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "object",
- "description": "[Output Only] A map of scoped disk type lists.",
- "additionalProperties": {
- "$ref": "DiskTypesScopedList",
- "description": "[Output Only] Name of the scope containing this set of disk types."
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#diskTypeAggregatedList.",
- "default": "compute#diskTypeAggregatedList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "DiskTypeList": {
- "id": "DiskTypeList",
- "type": "object",
- "description": "Contains a list of disk type resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of Disk Type resources.",
- "items": {
- "$ref": "DiskType"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#diskTypeList for disk types.",
- "default": "compute#diskTypeList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "DiskTypesScopedList": {
- "id": "DiskTypesScopedList",
- "type": "object",
- "properties": {
- "diskTypes": {
- "type": "array",
- "description": "[Output Only] List of disk types contained in this scope.",
- "items": {
- "$ref": "DiskType"
- }
- },
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning which replaces the list of disk types when the list is empty.",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- },
- "DisksScopedList": {
- "id": "DisksScopedList",
- "type": "object",
- "properties": {
- "disks": {
- "type": "array",
- "description": "[Output Only] List of disks contained in this scope.",
- "items": {
- "$ref": "Disk"
- }
- },
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning which replaces the list of disks when the list is empty.",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- },
- "Firewall": {
- "id": "Firewall",
- "type": "object",
- "description": "A Firewall resource.",
- "properties": {
- "allowed": {
- "type": "array",
- "description": "The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.",
- "items": {
- "type": "object",
- "properties": {
- "IPProtocol": {
- "type": "string",
- "description": "The IP protocol that is allowed for this rule. The protocol type is required when creating a firewall. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number."
- },
- "ports": {
- "type": "array",
- "description": "An optional list of ports which are allowed. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, connections through any port are allowed\n\nExample inputs include: [\"22\"], [\"80\",\"443\"], and [\"12345-12349\"].",
- "items": {
- "type": "string"
- }
- }
- }
- }
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Ony] Type of the resource. Always compute#firewall for firewall rules.",
- "default": "compute#firewall"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.firewalls.insert",
- "compute.firewalls.patch"
- ]
- }
- },
- "network": {
- "type": "string",
- "description": "URL of the network resource for this firewall rule. This field is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:\nglobal/networks/default\nIf you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: \n- https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network \n- projects/myproject/global/networks/my-network \n- global/networks/default"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "sourceRanges": {
- "type": "array",
- "description": "The IP address blocks that this rule applies to, expressed in CIDR format. One or both of sourceRanges and sourceTags may be set.\n\nIf both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.",
- "items": {
- "type": "string"
- }
- },
- "sourceTags": {
- "type": "array",
- "description": "A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set.\n\nIf both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.",
- "items": {
- "type": "string"
- }
- },
- "targetTags": {
- "type": "array",
- "description": "A list of instance tags indicating sets of instances located in the network that may make network connections as specified in allowed[]. If no targetTags are specified, the firewall rule applies to all instances on the specified network.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "FirewallList": {
- "id": "FirewallList",
- "type": "object",
- "description": "Contains a list of Firewall resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of Firewall resources.",
- "items": {
- "$ref": "Firewall"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#firewallList for lists of firewalls.",
- "default": "compute#firewallList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "ForwardingRule": {
- "id": "ForwardingRule",
- "type": "object",
- "description": "A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.",
- "properties": {
- "IPAddress": {
- "type": "string",
- "description": "Value of the reserved IP address that this forwarding rule is serving on behalf of. For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. If left empty (default value), an ephemeral IP from the same scope (global or regional) will be assigned."
- },
- "IPProtocol": {
- "type": "string",
- "description": "The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH or SCTP.",
- "enum": [
- "AH",
- "ESP",
- "SCTP",
- "TCP",
- "UDP"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#forwardingRule.",
- "default": "compute#forwardingRule"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "portRange": {
- "type": "string",
- "description": "Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same `[IPAddress, IPProtocol]` pair must have disjoint port ranges."
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "target": {
- "type": "string",
- "description": "The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource."
- }
- }
- },
- "ForwardingRuleAggregatedList": {
- "id": "ForwardingRuleAggregatedList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "object",
- "description": "A map of scoped forwarding rule lists.",
- "additionalProperties": {
- "$ref": "ForwardingRulesScopedList",
- "description": "Name of the scope containing this set of addresses."
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#forwardingRuleAggregatedList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "ForwardingRuleList": {
- "id": "ForwardingRuleList",
- "type": "object",
- "description": "Contains a list of ForwardingRule resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Set by the server."
- },
- "items": {
- "type": "array",
- "description": "A list of ForwardingRule resources.",
- "items": {
- "$ref": "ForwardingRule"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#forwardingRuleList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "ForwardingRulesScopedList": {
- "id": "ForwardingRulesScopedList",
- "type": "object",
- "properties": {
- "forwardingRules": {
- "type": "array",
- "description": "List of forwarding rules contained in this scope.",
- "items": {
- "$ref": "ForwardingRule"
- }
- },
- "warning": {
- "type": "object",
- "description": "Informational warning which replaces the list of forwarding rules when the list is empty.",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- },
- "HealthCheckReference": {
- "id": "HealthCheckReference",
- "type": "object",
- "properties": {
- "healthCheck": {
- "type": "string"
- }
- }
- },
- "HealthStatus": {
- "id": "HealthStatus",
- "type": "object",
- "properties": {
- "healthState": {
- "type": "string",
- "description": "Health state of the instance.",
- "enum": [
- "HEALTHY",
- "UNHEALTHY"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "instance": {
- "type": "string",
- "description": "URL of the instance resource."
- },
- "ipAddress": {
- "type": "string",
- "description": "The IP address represented by this resource."
- },
- "port": {
- "type": "integer",
- "description": "The port on the instance.",
- "format": "int32"
- }
- }
- },
- "HostRule": {
- "id": "HostRule",
- "type": "object",
- "description": "UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.",
- "properties": {
- "description": {
- "type": "string",
- "description": "An optional textual description."
- },
- "hosts": {
- "type": "array",
- "description": "The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..",
- "items": {
- "type": "string"
- }
- },
- "pathMatcher": {
- "type": "string",
- "description": "The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion."
- }
- }
- },
- "HttpHealthCheck": {
- "id": "HttpHealthCheck",
- "type": "object",
- "description": "An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.",
- "properties": {
- "checkIntervalSec": {
- "type": "integer",
- "description": "How often (in seconds) to send a health check. The default value is 5 seconds.",
- "format": "int32"
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "healthyThreshold": {
- "type": "integer",
- "description": "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.",
- "format": "int32"
- },
- "host": {
- "type": "string",
- "description": "The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource.",
- "default": "compute#httpHealthCheck"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "port": {
- "type": "integer",
- "description": "The TCP port number for the HTTP health check request. The default value is 80.",
- "format": "int32"
- },
- "requestPath": {
- "type": "string",
- "description": "The request path of the HTTP health check request. The default value is \"/\"."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "timeoutSec": {
- "type": "integer",
- "description": "How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.",
- "format": "int32"
- },
- "unhealthyThreshold": {
- "type": "integer",
- "description": "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.",
- "format": "int32"
- }
- }
- },
- "HttpHealthCheckList": {
- "id": "HttpHealthCheckList",
- "type": "object",
- "description": "Contains a list of HttpHealthCheck resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server."
- },
- "items": {
- "type": "array",
- "description": "A list of HttpHealthCheck resources.",
- "items": {
- "$ref": "HttpHealthCheck"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#httpHealthCheckList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "HttpsHealthCheck": {
- "id": "HttpsHealthCheck",
- "type": "object",
- "description": "An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.",
- "properties": {
- "checkIntervalSec": {
- "type": "integer",
- "description": "How often (in seconds) to send a health check. The default value is 5 seconds.",
- "format": "int32"
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "healthyThreshold": {
- "type": "integer",
- "description": "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.",
- "format": "int32"
- },
- "host": {
- "type": "string",
- "description": "The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource.",
- "default": "compute#httpsHealthCheck"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "port": {
- "type": "integer",
- "description": "The TCP port number for the HTTPS health check request. The default value is 443.",
- "format": "int32"
- },
- "requestPath": {
- "type": "string",
- "description": "The request path of the HTTPS health check request. The default value is \"/\"."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "timeoutSec": {
- "type": "integer",
- "description": "How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.",
- "format": "int32"
- },
- "unhealthyThreshold": {
- "type": "integer",
- "description": "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.",
- "format": "int32"
- }
- }
- },
- "HttpsHealthCheckList": {
- "id": "HttpsHealthCheckList",
- "type": "object",
- "description": "Contains a list of HttpsHealthCheck resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "A list of HttpsHealthCheck resources.",
- "items": {
- "$ref": "HttpsHealthCheck"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#httpsHealthCheckList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "Image": {
- "id": "Image",
- "type": "object",
- "description": "An Image resource.",
- "properties": {
- "archiveSizeBytes": {
- "type": "string",
- "description": "Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).",
- "format": "int64"
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "deprecated": {
- "$ref": "DeprecationStatus",
- "description": "The deprecation status associated with this image."
- },
- "description": {
- "type": "string",
- "description": "Textual description of the resource; provided by the client when the resource is created."
- },
- "diskSizeGb": {
- "type": "string",
- "description": "Size of the image when restored onto a persistent disk (in GB).",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#image for images.",
- "default": "compute#image"
- },
- "licenses": {
- "type": "array",
- "description": "Any applicable publicly visible licenses.",
- "items": {
- "type": "string"
- }
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.images.insert"
- ]
- }
- },
- "rawDisk": {
- "type": "object",
- "description": "The parameters of the raw disk image.",
- "properties": {
- "containerType": {
- "type": "string",
- "description": "The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.",
- "enum": [
- "TAR"
- ],
- "enumDescriptions": [
- ""
- ]
- },
- "sha1Checksum": {
- "type": "string",
- "description": "An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.",
- "pattern": "[a-f0-9]{40}"
- },
- "source": {
- "type": "string",
- "description": "The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both.",
- "annotations": {
- "required": [
- "compute.images.insert"
- ]
- }
- }
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "sourceDisk": {
- "type": "string",
- "description": "URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone/disk/disk \n- projects/project/zones/zone/disk/disk \n- zones/zone/disks/disk"
- },
- "sourceDiskId": {
- "type": "string",
- "description": "The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name."
- },
- "sourceType": {
- "type": "string",
- "description": "The type of the image used to create this disk. The default and only value is RAW",
- "default": "RAW",
- "enum": [
- "RAW"
- ],
- "enumDescriptions": [
- ""
- ]
- },
- "status": {
- "type": "string",
- "description": "[Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.",
- "enum": [
- "FAILED",
- "PENDING",
- "READY"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- }
- }
- },
- "ImageList": {
- "id": "ImageList",
- "type": "object",
- "description": "Contains a list of Image resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of Image resources.",
- "items": {
- "$ref": "Image"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#imageList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "Instance": {
- "id": "Instance",
- "type": "object",
- "description": "An Instance resource.",
- "properties": {
- "canIpForward": {
- "type": "boolean",
- "description": "Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding."
- },
- "cpuPlatform": {
- "type": "string",
- "description": "[Output Only] The CPU platform used by this instance."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "disks": {
- "type": "array",
- "description": "Array of disks associated with this instance. Persistent disks must be created before you can assign them.",
- "items": {
- "$ref": "AttachedDisk"
- }
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#instance for instances.",
- "default": "compute#instance"
- },
- "machineType": {
- "type": "string",
- "description": "Full or partial URL of the machine type resource to use for this instance. This is provided by the client when the instance is created. For example, the following is a valid partial url:\n\nzones/zone/machineTypes/machine-type",
- "annotations": {
- "required": [
- "compute.instances.insert"
- ]
- }
- },
- "metadata": {
- "$ref": "Metadata",
- "description": "The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys."
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash."
- },
- "networkInterfaces": {
- "type": "array",
- "description": "An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet.",
- "items": {
- "$ref": "NetworkInterface"
- }
- },
- "scheduling": {
- "$ref": "Scheduling",
- "description": "Scheduling options for this instance."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server defined URL for this resource."
- },
- "serviceAccounts": {
- "type": "array",
- "description": "A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Authenticating from Google Compute Engine for more information.",
- "items": {
- "$ref": "ServiceAccount"
- }
- },
- "status": {
- "type": "string",
- "description": "[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, and TERMINATED.",
- "enum": [
- "PROVISIONING",
- "RUNNING",
- "STAGING",
- "STOPPED",
- "STOPPING",
- "SUSPENDED",
- "SUSPENDING",
- "TERMINATED"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "statusMessage": {
- "type": "string",
- "description": "[Output Only] An optional, human-readable explanation of the status."
- },
- "tags": {
- "$ref": "Tags",
- "description": "A list of tags to appy to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035."
- },
- "zone": {
- "type": "string",
- "description": "[Output Only] URL of the zone where the instance resides."
- }
- }
- },
- "InstanceAggregatedList": {
- "id": "InstanceAggregatedList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "object",
- "description": "[Output Only] A map of scoped instance lists.",
- "additionalProperties": {
- "$ref": "InstancesScopedList",
- "description": "Name of the scope containing this set of instances."
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.",
- "default": "compute#instanceAggregatedList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server defined URL for this resource."
- }
- }
- },
- "InstanceGroup": {
- "id": "InstanceGroup",
- "type": "object",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] The creation timestamp for this instance group in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional text description for the instance group."
- },
- "fingerprint": {
- "type": "string",
- "description": "[Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.",
- "format": "byte"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] A unique identifier for this resource type. The server generates this identifier.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] The resource type, which is always compute#instanceGroup for instance groups.",
- "default": "compute#instanceGroup"
- },
- "name": {
- "type": "string",
- "description": "The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.instanceGroupManagers.insert"
- ]
- }
- },
- "namedPorts": {
- "type": "array",
- "description": "Assigns a name to a port number. For example: {name: \"http\", port: 80}\n\nThis allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: \"http\", port: 80},{name: \"http\", port: 8080}] \n\nNamed ports apply to all instances in this instance group.",
- "items": {
- "$ref": "NamedPort"
- }
- },
- "network": {
- "type": "string",
- "description": "[Output Only] The URL of the network to which all instances in the instance group belong."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] The URL for this instance group. The server generates this URL."
- },
- "size": {
- "type": "integer",
- "description": "[Output Only] The total number of instances in the instance group.",
- "format": "int32"
- },
- "zone": {
- "type": "string",
- "description": "[Output Only] The URL of the zone where the instance group is located."
- }
- }
- },
- "InstanceGroupAggregatedList": {
- "id": "InstanceGroupAggregatedList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] A unique identifier for this aggregated list of instance groups. The server generates this identifier."
- },
- "items": {
- "type": "object",
- "description": "A map of scoped instance group lists.",
- "additionalProperties": {
- "$ref": "InstanceGroupsScopedList",
- "description": "The name of the scope that contains this set of instance groups."
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups.",
- "default": "compute#instanceGroupAggregatedList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token that is used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] The URL for this resource type. The server generates this URL."
- }
- }
- },
- "InstanceGroupList": {
- "id": "InstanceGroupList",
- "type": "object",
- "description": "A list of InstanceGroup resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] A unique identifier for this list of instance groups. The server generates this identifier."
- },
- "items": {
- "type": "array",
- "description": "A list of instance groups.",
- "items": {
- "$ref": "InstanceGroup"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] The resource type, which is always compute#instanceGroupList for instance group lists.",
- "default": "compute#instanceGroupList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token that is used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] The URL for this resource type. The server generates this URL."
- }
- }
- },
- "InstanceGroupManager": {
- "id": "InstanceGroupManager",
- "type": "object",
- "description": "InstanceGroupManagers\n\nNext available tag: 19",
- "properties": {
- "baseInstanceName": {
- "type": "string",
- "description": "The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.",
- "pattern": "[a-z][-a-z0-9]{0,57}",
- "annotations": {
- "required": [
- "compute.instanceGroupManagers.insert"
- ]
- }
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] The creation timestamp for this managed instance group in RFC3339 text format."
- },
- "currentActions": {
- "$ref": "InstanceGroupManagerActionsSummary",
- "description": "[Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions."
- },
- "description": {
- "type": "string",
- "description": "An optional text description for the managed instance group."
- },
- "fingerprint": {
- "type": "string",
- "description": "[Output Only] The fingerprint of the target pools information. You can use this optional field for optimistic locking when you update the target pool entries.",
- "format": "byte"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] A unique identifier for this resource type. The server generates this identifier.",
- "format": "uint64"
- },
- "instanceGroup": {
- "type": "string",
- "description": "[Output Only] The URL of the Instance Group resource."
- },
- "instanceTemplate": {
- "type": "string",
- "description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.",
- "annotations": {
- "required": [
- "compute.instanceGroupManagers.insert"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.",
- "default": "compute#instanceGroupManager"
- },
- "name": {
- "type": "string",
- "description": "The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.instanceGroupManagers.insert"
- ]
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] The URL for this managed instance group. The server defines this URL."
- },
- "targetPools": {
- "type": "array",
- "description": "The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.",
- "items": {
- "type": "string"
- }
- },
- "targetSize": {
- "type": "integer",
- "description": "The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.",
- "format": "int32",
- "annotations": {
- "required": [
- "compute.instanceGroupManagers.insert"
- ]
- }
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the managed instance group is located."
- }
- }
- },
- "InstanceGroupManagerActionsSummary": {
- "id": "InstanceGroupManagerActionsSummary",
- "type": "object",
- "properties": {
- "abandoning": {
- "type": "integer",
- "description": "[Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.",
- "format": "int32"
- },
- "creating": {
- "type": "integer",
- "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created.",
- "format": "int32"
- },
- "deleting": {
- "type": "integer",
- "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.",
- "format": "int32"
- },
- "none": {
- "type": "integer",
- "description": "[Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.",
- "format": "int32"
- },
- "recreating": {
- "type": "integer",
- "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.",
- "format": "int32"
- },
- "refreshing": {
- "type": "integer",
- "description": "[Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.",
- "format": "int32"
- },
- "restarting": {
- "type": "integer",
- "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.",
- "format": "int32"
- }
- }
- },
- "InstanceGroupManagerAggregatedList": {
- "id": "InstanceGroupManagerAggregatedList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] A unique identifier for this aggregated list of managed instance groups. The server generates this identifier."
- },
- "items": {
- "type": "object",
- "description": "[Output Only] A map of filtered managed instance group lists.",
- "additionalProperties": {
- "$ref": "InstanceGroupManagersScopedList",
- "description": "[Output Only] The name of the scope that contains this set of managed instance groups."
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups.",
- "default": "compute#instanceGroupManagerAggregatedList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token that is used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] The URL for this resource type. The server generates this URL."
- }
- }
- },
- "InstanceGroupManagerList": {
- "id": "InstanceGroupManagerList",
- "type": "object",
- "description": "[Output Only] A list of managed instance groups.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] A unique identifier for this resource type. The server generates this identifier."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of managed instance groups.",
- "items": {
- "$ref": "InstanceGroupManager"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups.",
- "default": "compute#instanceGroupManagerList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token that is used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] The URL for this resource type. The server generates this URL."
- }
- }
- },
- "InstanceGroupManagersAbandonInstancesRequest": {
- "id": "InstanceGroupManagersAbandonInstancesRequest",
- "type": "object",
- "properties": {
- "instances": {
- "type": "array",
- "description": "The URL for one or more instances to abandon from the managed instance group.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "InstanceGroupManagersDeleteInstancesRequest": {
- "id": "InstanceGroupManagersDeleteInstancesRequest",
- "type": "object",
- "properties": {
- "instances": {
- "type": "array",
- "description": "The list of instances to delete from this managed instance group. Specify one or more instance URLs.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "InstanceGroupManagersListManagedInstancesResponse": {
- "id": "InstanceGroupManagersListManagedInstancesResponse",
- "type": "object",
- "properties": {
- "managedInstances": {
- "type": "array",
- "description": "[Output Only] The list of instances in the managed instance group.",
- "items": {
- "$ref": "ManagedInstance"
- }
- }
- }
- },
- "InstanceGroupManagersRecreateInstancesRequest": {
- "id": "InstanceGroupManagersRecreateInstancesRequest",
- "type": "object",
- "properties": {
- "instances": {
- "type": "array",
- "description": "The URL for one or more instances to recreate.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "InstanceGroupManagersScopedList": {
- "id": "InstanceGroupManagersScopedList",
- "type": "object",
- "properties": {
- "instanceGroupManagers": {
- "type": "array",
- "description": "[Output Only] The list of managed instance groups that are contained in the specified project and zone.",
- "items": {
- "$ref": "InstanceGroupManager"
- }
- },
- "warning": {
- "type": "object",
- "description": "[Output Only] The warning that replaces the list of managed instance groups when the list is empty.",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- },
- "InstanceGroupManagersSetInstanceTemplateRequest": {
- "id": "InstanceGroupManagersSetInstanceTemplateRequest",
- "type": "object",
- "properties": {
- "instanceTemplate": {
- "type": "string",
- "description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group."
- }
- }
- },
- "InstanceGroupManagersSetTargetPoolsRequest": {
- "id": "InstanceGroupManagersSetTargetPoolsRequest",
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string",
- "description": "The fingerprint of the target pools information. Use this optional property to prevent conflicts when multiple users change the target pools settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.",
- "format": "byte"
- },
- "targetPools": {
- "type": "array",
- "description": "The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "InstanceGroupsAddInstancesRequest": {
- "id": "InstanceGroupsAddInstancesRequest",
- "type": "object",
- "properties": {
- "instances": {
- "type": "array",
- "description": "The list of instances to add to the instance group.",
- "items": {
- "$ref": "InstanceReference"
- }
- }
- }
- },
- "InstanceGroupsListInstances": {
- "id": "InstanceGroupsListInstances",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] A unique identifier for this list of instance groups. The server generates this identifier."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of instances and any named ports that are assigned to those instances.",
- "items": {
- "$ref": "InstanceWithNamedPorts"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] The resource type, which is always compute#instanceGroupsListInstances for lists of instance groups.",
- "default": "compute#instanceGroupsListInstances"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token that is used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] The URL for this list of instance groups. The server generates this URL."
- }
- }
- },
- "InstanceGroupsListInstancesRequest": {
- "id": "InstanceGroupsListInstancesRequest",
- "type": "object",
- "properties": {
- "instanceState": {
- "type": "string",
- "description": "A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state.",
- "enum": [
- "ALL",
- "RUNNING"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- }
- }
- },
- "InstanceGroupsRemoveInstancesRequest": {
- "id": "InstanceGroupsRemoveInstancesRequest",
- "type": "object",
- "properties": {
- "instances": {
- "type": "array",
- "description": "The list of instances to remove from the instance group.",
- "items": {
- "$ref": "InstanceReference"
- }
- }
- }
- },
- "InstanceGroupsScopedList": {
- "id": "InstanceGroupsScopedList",
- "type": "object",
- "properties": {
- "instanceGroups": {
- "type": "array",
- "description": "[Output Only] The list of instance groups that are contained in this scope.",
- "items": {
- "$ref": "InstanceGroup"
- }
- },
- "warning": {
- "type": "object",
- "description": "[Output Only] An informational warning that replaces the list of instance groups when the list is empty.",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- },
- "InstanceGroupsSetNamedPortsRequest": {
- "id": "InstanceGroupsSetNamedPortsRequest",
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string",
- "description": "The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.",
- "format": "byte"
- },
- "namedPorts": {
- "type": "array",
- "description": "The list of named ports to set for this instance group.",
- "items": {
- "$ref": "NamedPort"
- }
- }
- }
- },
- "InstanceList": {
- "id": "InstanceList",
- "type": "object",
- "description": "Contains a list of instance resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of Instance resources.",
- "items": {
- "$ref": "Instance"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.",
- "default": "compute#instanceList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server defined URL for this resource."
- }
- }
- },
- "InstanceMoveRequest": {
- "id": "InstanceMoveRequest",
- "type": "object",
- "properties": {
- "destinationZone": {
- "type": "string",
- "description": "The URL of the destination zone to move the instance to. This can be a full or partial URL. For example, the following are all valid URLs to a zone: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone \n- projects/project/zones/zone \n- zones/zone"
- },
- "targetInstance": {
- "type": "string",
- "description": "The URL of the target instance to move. This can be a full or partial URL. For example, the following are all valid URLs to an instance: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance \n- projects/project/zones/zone/instances/instance \n- zones/zone/instances/instance"
- }
- }
- },
- "InstanceProperties": {
- "id": "InstanceProperties",
- "type": "object",
- "description": "",
- "properties": {
- "canIpForward": {
- "type": "boolean",
- "description": "Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the canIpForward documentation for more information."
- },
- "description": {
- "type": "string",
- "description": "An optional text description for the instances that are created from this instance template."
- },
- "disks": {
- "type": "array",
- "description": "An array of disks that are associated with the instances that are created from this template.",
- "items": {
- "$ref": "AttachedDisk"
- }
- },
- "machineType": {
- "type": "string",
- "description": "The machine type to use for instances that are created from this template.",
- "annotations": {
- "required": [
- "compute.instanceTemplates.insert"
- ]
- }
- },
- "metadata": {
- "$ref": "Metadata",
- "description": "The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information."
- },
- "networkInterfaces": {
- "type": "array",
- "description": "An array of network access configurations for this interface.",
- "items": {
- "$ref": "NetworkInterface"
- }
- },
- "scheduling": {
- "$ref": "Scheduling",
- "description": "Specifies the scheduling options for the instances that are created from this template."
- },
- "serviceAccounts": {
- "type": "array",
- "description": "A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances.",
- "items": {
- "$ref": "ServiceAccount"
- }
- },
- "tags": {
- "$ref": "Tags",
- "description": "A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035."
- }
- }
- },
- "InstanceReference": {
- "id": "InstanceReference",
- "type": "object",
- "properties": {
- "instance": {
- "type": "string",
- "description": "The URL for a specific instance."
- }
- }
- },
- "InstanceTemplate": {
- "id": "InstanceTemplate",
- "type": "object",
- "description": "An Instance Template resource.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] The creation timestamp for this instance template in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional text description for the instance template."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] A unique identifier for this instance template. The server defines this identifier.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] The resource type, which is always compute#instanceTemplate for instance templates.",
- "default": "compute#instanceTemplate"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.instanceTemplates.insert"
- ]
- }
- },
- "properties": {
- "$ref": "InstanceProperties",
- "description": "The instance properties for this instance template."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] The URL for this instance template. The server defines this URL."
- }
- }
- },
- "InstanceTemplateList": {
- "id": "InstanceTemplateList",
- "type": "object",
- "description": "A list of instance templates.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] A unique identifier for this instance template. The server defines this identifier."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] list of InstanceTemplate resources.",
- "items": {
- "$ref": "InstanceTemplate"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists.",
- "default": "compute#instanceTemplateList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token that is used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] The URL for this instance template list. The server defines this URL."
- }
- }
- },
- "InstanceWithNamedPorts": {
- "id": "InstanceWithNamedPorts",
- "type": "object",
- "properties": {
- "instance": {
- "type": "string",
- "description": "[Output Only] The URL of the instance."
- },
- "namedPorts": {
- "type": "array",
- "description": "[Output Only] The named ports that belong to this instance group.",
- "items": {
- "$ref": "NamedPort"
- }
- },
- "status": {
- "type": "string",
- "description": "[Output Only] The status of the instance.",
- "enum": [
- "PROVISIONING",
- "RUNNING",
- "STAGING",
- "STOPPED",
- "STOPPING",
- "SUSPENDED",
- "SUSPENDING",
- "TERMINATED"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- }
- },
- "InstancesScopedList": {
- "id": "InstancesScopedList",
- "type": "object",
- "properties": {
- "instances": {
- "type": "array",
- "description": "[Output Only] List of instances contained in this scope.",
- "items": {
- "$ref": "Instance"
- }
- },
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning which replaces the list of instances when the list is empty.",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- },
- "License": {
- "id": "License",
- "type": "object",
- "description": "A license resource.",
- "properties": {
- "chargesUseFee": {
- "type": "boolean",
- "description": "If true, the customer will be charged license fee for running software that contains this license on an instance."
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#license for licenses.",
- "default": "compute#license"
- },
- "name": {
- "type": "string",
- "description": "[Output Only] Name of the resource. The name is 1-63 characters long and complies with RFC1035.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.images.insert"
- ]
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- }
- }
- },
- "MachineType": {
- "id": "MachineType",
- "type": "object",
- "description": "A Machine Type resource.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "deprecated": {
- "$ref": "DeprecationStatus",
- "description": "[Output Only] The deprecation status associated with this machine type."
- },
- "description": {
- "type": "string",
- "description": "[Output Only] An optional textual description of the resource."
- },
- "guestCpus": {
- "type": "integer",
- "description": "[Output Only] The tumber of CPUs exposed to the instance.",
- "format": "int32"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "imageSpaceGb": {
- "type": "integer",
- "description": "[Deprecated] This property is deprecated and will never be populated with any relevant values.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource.",
- "default": "compute#machineType"
- },
- "maximumPersistentDisks": {
- "type": "integer",
- "description": "[Output Only] Maximum persistent disks allowed.",
- "format": "int32"
- },
- "maximumPersistentDisksSizeGb": {
- "type": "string",
- "description": "[Output Only] Maximum total persistent disks size (GB) allowed.",
- "format": "int64"
- },
- "memoryMb": {
- "type": "integer",
- "description": "[Output Only] The amount of physical memory available to the instance, defined in MB.",
- "format": "int32"
- },
- "name": {
- "type": "string",
- "description": "[Output Only] Name of the resource.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "scratchDisks": {
- "type": "array",
- "description": "[Output Only] List of extended scratch disks assigned to the instance.",
- "items": {
- "type": "object",
- "properties": {
- "diskGb": {
- "type": "integer",
- "description": "Size of the scratch disk, defined in GB.",
- "format": "int32"
- }
- }
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "zone": {
- "type": "string",
- "description": "[Output Only] The name of the zone where the machine type resides, such as us-central1-a."
- }
- }
- },
- "MachineTypeAggregatedList": {
- "id": "MachineTypeAggregatedList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "object",
- "description": "[Output Only] A map of scoped machine type lists.",
- "additionalProperties": {
- "$ref": "MachineTypesScopedList",
- "description": "[Output Only] Name of the scope containing this set of machine types."
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types.",
- "default": "compute#machineTypeAggregatedList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "MachineTypeList": {
- "id": "MachineTypeList",
- "type": "object",
- "description": "Contains a list of Machine Type resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of Machine Type resources.",
- "items": {
- "$ref": "MachineType"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#machineTypeList for lists of machine types.",
- "default": "compute#machineTypeList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "MachineTypesScopedList": {
- "id": "MachineTypesScopedList",
- "type": "object",
- "properties": {
- "machineTypes": {
- "type": "array",
- "description": "[Output Only] List of machine types contained in this scope.",
- "items": {
- "$ref": "MachineType"
- }
- },
- "warning": {
- "type": "object",
- "description": "[Output Only] An informational warning that appears when the machine types list is empty.",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- },
- "ManagedInstance": {
- "id": "ManagedInstance",
- "type": "object",
- "properties": {
- "currentAction": {
- "type": "string",
- "description": "[Output Only] The current action that the managed instance group has scheduled for the instance. Possible values: \n- NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance. \n- CREATING The managed instance group is creating this instance. \n- RECREATING The managed instance group is recreating this instance. \n- DELETING The managed instance group is permanently deleting this instance. \n- ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group. \n- RESTARTING The managed instance group is restarting the instance. \n- REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.",
- "enum": [
- "ABANDONING",
- "CREATING",
- "DELETING",
- "NONE",
- "RECREATING",
- "REFRESHING",
- "RESTARTING"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "id": {
- "type": "string",
- "description": "[Output only] The unique identifier for this resource. This field is empty when instance does not exist.",
- "format": "uint64"
- },
- "instance": {
- "type": "string",
- "description": "[Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created."
- },
- "instanceStatus": {
- "type": "string",
- "description": "[Output Only] The status of the instance. This field is empty when the instance does not exist.",
- "enum": [
- "PROVISIONING",
- "RUNNING",
- "STAGING",
- "STOPPED",
- "STOPPING",
- "SUSPENDED",
- "SUSPENDING",
- "TERMINATED"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "lastAttempt": {
- "$ref": "ManagedInstanceLastAttempt",
- "description": "[Output Only] Information about the last attempt to create or delete the instance."
- }
- }
- },
- "ManagedInstanceLastAttempt": {
- "id": "ManagedInstanceLastAttempt",
- "type": "object",
- "properties": {
- "errors": {
- "type": "object",
- "description": "[Output Only] Encountered errors during the last attempt to create or delete the instance.",
- "properties": {
- "errors": {
- "type": "array",
- "description": "[Output Only] The array of errors encountered while processing this operation.",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The error type identifier for this error."
- },
- "location": {
- "type": "string",
- "description": "[Output Only] Indicates the field in the request which caused the error. This property is optional."
- },
- "message": {
- "type": "string",
- "description": "[Output Only] An optional, human-readable error message."
- }
- }
- }
- }
- }
- }
- }
- },
- "Metadata": {
- "id": "Metadata",
- "type": "object",
- "description": "A metadata key/value entry.",
- "properties": {
- "fingerprint": {
- "type": "string",
- "description": "Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.",
- "format": "byte"
- },
- "items": {
- "type": "array",
- "description": "Array of key/value pairs. The total size of all keys and values must be less than 512 KB.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.",
- "pattern": "[a-zA-Z0-9-_]{1,128}",
- "annotations": {
- "required": [
- "compute.instances.insert",
- "compute.projects.setCommonInstanceMetadata"
- ]
- }
- },
- "value": {
- "type": "string",
- "description": "Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.",
- "annotations": {
- "required": [
- "compute.instances.insert",
- "compute.projects.setCommonInstanceMetadata"
- ]
- }
- }
- }
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#metadata for metadata.",
- "default": "compute#metadata"
- }
- }
- },
- "NamedPort": {
- "id": "NamedPort",
- "type": "object",
- "description": "The named port. For example: .",
- "properties": {
- "name": {
- "type": "string",
- "description": "The name for this named port. The name must be 1-63 characters long, and comply with RFC1035."
- },
- "port": {
- "type": "integer",
- "description": "The port number, which can be a value between 1 and 65535.",
- "format": "int32"
- }
- }
- },
- "Network": {
- "id": "Network",
- "type": "object",
- "description": "A network resource.",
- "properties": {
- "IPv4Range": {
- "type": "string",
- "description": "The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.",
- "pattern": "[0-9]{1,3}(?:\\.[0-9]{1,3}){3}/[0-9]{1,2}"
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource. Provided by the client when the resource is created."
- },
- "gatewayIPv4": {
- "type": "string",
- "description": "A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.",
- "pattern": "[0-9]{1,3}(?:\\.[0-9]{1,3}){3}"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#network for networks.",
- "default": "compute#network"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.networks.insert"
- ]
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- }
- }
- },
- "NetworkInterface": {
- "id": "NetworkInterface",
- "type": "object",
- "description": "A network interface resource attached to an instance.",
- "properties": {
- "accessConfigs": {
- "type": "array",
- "description": "An array of configurations for this interface. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.",
- "items": {
- "$ref": "AccessConfig"
- }
- },
- "name": {
- "type": "string",
- "description": "[Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc."
- },
- "network": {
- "type": "string",
- "description": "URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:\n\nglobal/networks/default \n\nIf you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: \n- https://www.googleapis.com/compute/v1/projects/project/global/networks/network \n- projects/project/global/networks/network \n- global/networks/default",
- "annotations": {
- "required": [
- "compute.instances.insert"
- ]
- }
- },
- "networkIP": {
- "type": "string",
- "description": "[Output Only] An optional IPV4 internal network address assigned to the instance for this network interface."
- }
- }
- },
- "NetworkList": {
- "id": "NetworkList",
- "type": "object",
- "description": "Contains a list of Network resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of Network resources.",
- "items": {
- "$ref": "Network"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#networkList for lists of networks.",
- "default": "compute#networkList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource ."
- }
- }
- },
- "Operation": {
- "id": "Operation",
- "type": "object",
- "description": "An Operation resource, used to manage asynchronous API requests.",
- "properties": {
- "clientOperationId": {
- "type": "string",
- "description": "[Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "endTime": {
- "type": "string",
- "description": "[Output Only] The time that this operation was completed. This is in RFC3339 text format."
- },
- "error": {
- "type": "object",
- "description": "[Output Only] If errors are generated during processing of the operation, this field will be populated.",
- "properties": {
- "errors": {
- "type": "array",
- "description": "[Output Only] The array of errors encountered while processing this operation.",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The error type identifier for this error."
- },
- "location": {
- "type": "string",
- "description": "[Output Only] Indicates the field in the request which caused the error. This property is optional."
- },
- "message": {
- "type": "string",
- "description": "[Output Only] An optional, human-readable error message."
- }
- }
- }
- }
- }
- },
- "httpErrorMessage": {
- "type": "string",
- "description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND."
- },
- "httpErrorStatusCode": {
- "type": "integer",
- "description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.",
- "format": "int32"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "insertTime": {
- "type": "string",
- "description": "[Output Only] The time that this operation was requested. This is in RFC3339 text format."
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#operation for Operation resources.",
- "default": "compute#operation"
- },
- "name": {
- "type": "string",
- "description": "[Output Only] Name of the resource."
- },
- "operationType": {
- "type": "string",
- "description": "[Output Only] Type of the operation, such as insert, compute.instanceGroups.update, or compute.instanceGroups.delete."
- },
- "progress": {
- "type": "integer",
- "description": "[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.",
- "format": "int32"
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the operation resides. Only applicable for regional resources."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "startTime": {
- "type": "string",
- "description": "[Output Only] The time that this operation was started by the server. This is in RFC3339 text format."
- },
- "status": {
- "type": "string",
- "description": "[Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.",
- "enum": [
- "DONE",
- "PENDING",
- "RUNNING"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "statusMessage": {
- "type": "string",
- "description": "[Output Only] An optional textual description of the current status of the operation."
- },
- "targetId": {
- "type": "string",
- "description": "[Output Only] Unique target ID which identifies a particular incarnation of the target.",
- "format": "uint64"
- },
- "targetLink": {
- "type": "string",
- "description": "[Output Only] URL of the resource the operation is mutating."
- },
- "user": {
- "type": "string",
- "description": "[Output Only] User who requested the operation, for example: user@example.com."
- },
- "warnings": {
- "type": "array",
- "description": "[Output Only] If warning messages are generated during processing of the operation, this field will be populated.",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- },
- "zone": {
- "type": "string",
- "description": "[Output Only] URL of the zone where the operation resides."
- }
- }
- },
- "OperationAggregatedList": {
- "id": "OperationAggregatedList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "object",
- "description": "[Output Only] A map of scoped operation lists.",
- "additionalProperties": {
- "$ref": "OperationsScopedList",
- "description": "[Output Only] Name of the scope containing this set of operations."
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#operationAggregatedList for aggregated lists of operations.",
- "default": "compute#operationAggregatedList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "OperationList": {
- "id": "OperationList",
- "type": "object",
- "description": "Contains a list of Operation resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] The Operation resources.",
- "items": {
- "$ref": "Operation"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#operations for Operations resource.",
- "default": "compute#operationList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncate."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "OperationsScopedList": {
- "id": "OperationsScopedList",
- "type": "object",
- "properties": {
- "operations": {
- "type": "array",
- "description": "[Output Only] List of operations contained in this scope.",
- "items": {
- "$ref": "Operation"
- }
- },
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning which replaces the list of operations when the list is empty.",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- },
- "PathMatcher": {
- "id": "PathMatcher",
- "type": "object",
- "description": "A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.",
- "properties": {
- "defaultService": {
- "type": "string",
- "description": "The URL to the BackendService resource. This will be used if none of the 'pathRules' defined by this PathMatcher is met by the URL's path portion."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource."
- },
- "name": {
- "type": "string",
- "description": "The name to which this PathMatcher is referred by the HostRule."
- },
- "pathRules": {
- "type": "array",
- "description": "The list of path rules.",
- "items": {
- "$ref": "PathRule"
- }
- }
- }
- },
- "PathRule": {
- "id": "PathRule",
- "type": "object",
- "description": "A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.",
- "properties": {
- "paths": {
- "type": "array",
- "description": "The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.",
- "items": {
- "type": "string"
- }
- },
- "service": {
- "type": "string",
- "description": "The URL of the BackendService resource if this rule is matched."
- }
- }
- },
- "Project": {
- "id": "Project",
- "type": "object",
- "description": "A Project resource. Projects can only be created in the Google Developers Console. Unless marked otherwise, values can only be modified in the console.",
- "properties": {
- "commonInstanceMetadata": {
- "$ref": "Metadata",
- "description": "Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource."
- },
- "enabledFeatures": {
- "type": "array",
- "description": "Restricted features enabled for use on this project.",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#project for projects.",
- "default": "compute#project"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource."
- },
- "quotas": {
- "type": "array",
- "description": "[Output Only] Quotas assigned to this project.",
- "items": {
- "$ref": "Quota"
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "usageExportLocation": {
- "$ref": "UsageExportLocation",
- "description": "The location in Cloud Storage and naming method of the daily usage report."
- }
- }
- },
- "Quota": {
- "id": "Quota",
- "type": "object",
- "description": "A quotas entry.",
- "properties": {
- "limit": {
- "type": "number",
- "description": "[Output Only] Quota limit for this metric.",
- "format": "double"
- },
- "metric": {
- "type": "string",
- "description": "[Output Only] Name of the quota metric.",
- "enum": [
- "BACKEND_SERVICES",
- "CPUS",
- "DISKS_TOTAL_GB",
- "FIREWALLS",
- "FORWARDING_RULES",
- "HEALTH_CHECKS",
- "IMAGES",
- "INSTANCES",
- "INSTANCE_GROUPS",
- "INSTANCE_GROUP_MANAGERS",
- "INSTANCE_TEMPLATES",
- "IN_USE_ADDRESSES",
- "LOCAL_SSD_TOTAL_GB",
- "NETWORKS",
- "ROUTES",
- "SNAPSHOTS",
- "SSD_TOTAL_GB",
- "STATIC_ADDRESSES",
- "TARGET_HTTP_PROXIES",
- "TARGET_INSTANCES",
- "TARGET_POOLS",
- "TARGET_VPN_GATEWAYS",
- "URL_MAPS",
- "VPN_TUNNELS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "usage": {
- "type": "number",
- "description": "[Output Only] Current usage of this metric.",
- "format": "double"
- }
- }
- },
- "Region": {
- "id": "Region",
- "type": "object",
- "description": "Region resource.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "deprecated": {
- "$ref": "DeprecationStatus",
- "description": "[Output Only] The deprecation status associated with this region."
- },
- "description": {
- "type": "string",
- "description": "[Output Only] Textual description of the resource."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server .",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#region for regions.",
- "default": "compute#region"
- },
- "name": {
- "type": "string",
- "description": "[Output Only] Name of the resource."
- },
- "quotas": {
- "type": "array",
- "description": "[Output Only] Quotas assigned to this region.",
- "items": {
- "$ref": "Quota"
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "status": {
- "type": "string",
- "description": "[Output Only] Status of the region, either UP or DOWN.",
- "enum": [
- "DOWN",
- "UP"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "zones": {
- "type": "array",
- "description": "[Output Only] A list of zones available in this region, in the form of resource URLs.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "RegionList": {
- "id": "RegionList",
- "type": "object",
- "description": "Contains a list of region resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of Region resources.",
- "items": {
- "$ref": "Region"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#regionList for lists of regions.",
- "default": "compute#regionList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "ResourceGroupReference": {
- "id": "ResourceGroupReference",
- "type": "object",
- "properties": {
- "group": {
- "type": "string",
- "description": "A URI referencing one of the resource views listed in the backend service."
- }
- }
- },
- "Route": {
- "id": "Route",
- "type": "object",
- "description": "The route resource. A Route is a rule that specifies how certain packets should be handled by the virtual network. Routes are associated with instances by tag and the set of Routes for a particular instance is called its routing table. For each packet leaving a instance, the system searches that instance's routing table for a single best matching Route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the Route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching Routes. The packet is then forwarded as specified by the nextHop field of the winning Route -- either to another instance destination, a instance gateway or a Google Compute Engien-operated gateway. Packets that do not match any Route in the sending instance's routing table are dropped.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource. Provided by the client when the resource is created."
- },
- "destRange": {
- "type": "string",
- "description": "The destination range of outgoing packets that this route applies to.",
- "annotations": {
- "required": [
- "compute.routes.insert"
- ]
- }
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of this resource. Always compute#routes for Route resources.",
- "default": "compute#route"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.routes.insert"
- ]
- }
- },
- "network": {
- "type": "string",
- "description": "Fully-qualified URL of the network that this route applies to.",
- "annotations": {
- "required": [
- "compute.routes.insert"
- ]
- }
- },
- "nextHopGateway": {
- "type": "string",
- "description": "The URL to a gateway that should handle matching packets. Currently, this is only the internet gateway: projects/\u003cproject-id\u003e/global/gateways/default-internet-gateway"
- },
- "nextHopInstance": {
- "type": "string",
- "description": "The fully-qualified URL to an instance that should handle matching packets. For example:\nhttps://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/"
- },
- "nextHopIp": {
- "type": "string",
- "description": "The network IP address of an instance that should handle matching packets."
- },
- "nextHopNetwork": {
- "type": "string",
- "description": "The URL of the local network if it should handle matching packets."
- },
- "nextHopVpnTunnel": {
- "type": "string",
- "description": "The URL to a VpnTunnel that should handle matching packets."
- },
- "priority": {
- "type": "integer",
- "description": "Breaks ties between Routes of equal specificity. Routes with smaller values win when tied with routes with larger values. Default value is 1000. A valid range is between 0 and 65535.",
- "format": "uint32",
- "annotations": {
- "required": [
- "compute.routes.insert"
- ]
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined fully-qualified URL for this resource."
- },
- "tags": {
- "type": "array",
- "description": "A list of instance tags to which this route applies.",
- "items": {
- "type": "string"
- },
- "annotations": {
- "required": [
- "compute.routes.insert"
- ]
- }
- },
- "warnings": {
- "type": "array",
- "description": "[Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- }
- },
- "RouteList": {
- "id": "RouteList",
- "type": "object",
- "description": "Contains a list of route resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server."
- },
- "items": {
- "type": "array",
- "description": "A list of Route resources.",
- "items": {
- "$ref": "Route"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#routeList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "Scheduling": {
- "id": "Scheduling",
- "type": "object",
- "description": "Sets the scheduling options for an Instance.",
- "properties": {
- "automaticRestart": {
- "type": "boolean",
- "description": "Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted."
- },
- "onHostMaintenance": {
- "type": "string",
- "description": "Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting maintenance behavior.",
- "enum": [
- "MIGRATE",
- "TERMINATE"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "preemptible": {
- "type": "boolean",
- "description": "Whether the instance is preemptible."
- }
- }
- },
- "SerialPortOutput": {
- "id": "SerialPortOutput",
- "type": "object",
- "description": "An instance's serial console output.",
- "properties": {
- "contents": {
- "type": "string",
- "description": "[Output Only] The contents of the console output."
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.",
- "default": "compute#serialPortOutput"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server defined URL for the resource."
- }
- }
- },
- "ServiceAccount": {
- "id": "ServiceAccount",
- "type": "object",
- "description": "A service account.",
- "properties": {
- "email": {
- "type": "string",
- "description": "Email address of the service account."
- },
- "scopes": {
- "type": "array",
- "description": "The list of scopes to be made available for this service account.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "Snapshot": {
- "id": "Snapshot",
- "type": "object",
- "description": "A persistent disk snapshot resource.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "diskSizeGb": {
- "type": "string",
- "description": "[Output Only] Size of the snapshot, specified in GB.",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.",
- "default": "compute#snapshot"
- },
- "licenses": {
- "type": "array",
- "description": "Public visible licenses.",
- "items": {
- "type": "string"
- }
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "sourceDisk": {
- "type": "string",
- "description": "The source disk used to create this snapshot."
- },
- "sourceDiskId": {
- "type": "string",
- "description": "[Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name."
- },
- "status": {
- "type": "string",
- "description": "[Output Only] The status of the snapshot.",
- "enum": [
- "CREATING",
- "DELETING",
- "FAILED",
- "READY",
- "UPLOADING"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "storageBytes": {
- "type": "string",
- "description": "[Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.",
- "format": "int64"
- },
- "storageBytesStatus": {
- "type": "string",
- "description": "[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation.",
- "enum": [
- "UPDATING",
- "UP_TO_DATE"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- }
- }
- },
- "SnapshotList": {
- "id": "SnapshotList",
- "type": "object",
- "description": "Contains a list of Snapshot resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server."
- },
- "items": {
- "type": "array",
- "description": "A list of Snapshot resources.",
- "items": {
- "$ref": "Snapshot"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#snapshotList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "SslCertificate": {
- "id": "SslCertificate",
- "type": "object",
- "description": "An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to global HTTPS loadbalancer to serve secure connections.",
- "properties": {
- "certificate": {
- "type": "string",
- "description": "A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource. Provided by the client when the resource is created."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.",
- "default": "compute#sslCertificate"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "privateKey": {
- "type": "string",
- "description": "A write-only private key in PEM format. Only insert RPCs will include this field."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output only] Server-defined URL for the resource."
- }
- }
- },
- "SslCertificateList": {
- "id": "SslCertificateList",
- "type": "object",
- "description": "Contains a list of SslCertificate resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server."
- },
- "items": {
- "type": "array",
- "description": "A list of SslCertificate resources.",
- "items": {
- "$ref": "SslCertificate"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#sslCertificateList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "Tags": {
- "id": "Tags",
- "type": "object",
- "description": "A set of instance tags.",
- "properties": {
- "fingerprint": {
- "type": "string",
- "description": "Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.\n\nTo see the latest fingerprint, make get() request to the instance.",
- "format": "byte"
- },
- "items": {
- "type": "array",
- "description": "An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "TargetHttpProxy": {
- "id": "TargetHttpProxy",
- "type": "object",
- "description": "A TargetHttpProxy resource. This resource defines an HTTP proxy.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#operation for Operation resources.",
- "default": "compute#targetHttpProxy"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "urlMap": {
- "type": "string",
- "description": "URL to the UrlMap resource that defines the mapping from URL to the BackendService."
- }
- }
- },
- "TargetHttpProxyList": {
- "id": "TargetHttpProxyList",
- "type": "object",
- "description": "A list of TargetHttpProxy resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "A list of TargetHttpProxy resources.",
- "items": {
- "$ref": "TargetHttpProxy"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource. Always compute#targetHttpProxyList for lists of Target HTTP proxies.",
- "default": "compute#targetHttpProxyList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "TargetHttpsProxiesSetSslCertificatesRequest": {
- "id": "TargetHttpsProxiesSetSslCertificatesRequest",
- "type": "object",
- "properties": {
- "sslCertificates": {
- "type": "array",
- "description": "New set of URLs to SslCertificate resources to associate with this TargetHttpProxy. Currently exactly one ssl certificate must be specified.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "TargetHttpsProxy": {
- "id": "TargetHttpsProxy",
- "type": "object",
- "description": "A TargetHttpsProxy resource. This resource defines an HTTPS proxy.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource. Provided by the client when the resource is created."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource.",
- "default": "compute#targetHttpsProxy"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "sslCertificates": {
- "type": "array",
- "description": "URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified.",
- "items": {
- "type": "string"
- }
- },
- "urlMap": {
- "type": "string",
- "description": "URL to the UrlMap resource that defines the mapping from URL to the BackendService."
- }
- }
- },
- "TargetHttpsProxyList": {
- "id": "TargetHttpsProxyList",
- "type": "object",
- "description": "Contains a list of TargetHttpsProxy resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "A list of TargetHttpsProxy resources.",
- "items": {
- "$ref": "TargetHttpsProxy"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#targetHttpsProxyList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "TargetInstance": {
- "id": "TargetInstance",
- "type": "object",
- "description": "A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "instance": {
- "type": "string",
- "description": "The URL to the instance that terminates the relevant traffic."
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource.",
- "default": "compute#targetInstance"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "natPolicy": {
- "type": "string",
- "description": "NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.",
- "enum": [
- "NO_NAT"
- ],
- "enumDescriptions": [
- ""
- ]
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "zone": {
- "type": "string",
- "description": "[Output Only] URL of the zone where the target instance resides."
- }
- }
- },
- "TargetInstanceAggregatedList": {
- "id": "TargetInstanceAggregatedList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "object",
- "description": "A map of scoped target instance lists.",
- "additionalProperties": {
- "$ref": "TargetInstancesScopedList",
- "description": "Name of the scope containing this set of target instances."
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#targetInstanceAggregatedList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "TargetInstanceList": {
- "id": "TargetInstanceList",
- "type": "object",
- "description": "Contains a list of TargetInstance resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "A list of TargetInstance resources.",
- "items": {
- "$ref": "TargetInstance"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#targetInstanceList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "TargetInstancesScopedList": {
- "id": "TargetInstancesScopedList",
- "type": "object",
- "properties": {
- "targetInstances": {
- "type": "array",
- "description": "List of target instances contained in this scope.",
- "items": {
- "$ref": "TargetInstance"
- }
- },
- "warning": {
- "type": "object",
- "description": "Informational warning which replaces the list of addresses when the list is empty.",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- },
- "TargetPool": {
- "id": "TargetPool",
- "type": "object",
- "description": "A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback TargetPool.",
- "properties": {
- "backupPool": {
- "type": "string",
- "description": "This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].\n\nbackupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.\n\nIn case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the \"force\" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource; provided by the client when the resource is created."
- },
- "failoverRatio": {
- "type": "number",
- "description": "This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].\n\nIf set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.\n\nIn case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the \"force\" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.",
- "format": "float"
- },
- "healthChecks": {
- "type": "array",
- "description": "A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "instances": {
- "type": "array",
- "description": "A list of resource URLs to the member virtual machines serving this pool. They must live in zones contained in the same region as this pool.",
- "items": {
- "type": "string"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource.",
- "default": "compute#targetPool"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the target pool resides."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "sessionAffinity": {
- "type": "string",
- "description": "Sesssion affinity option, must be one of the following values:\nNONE: Connections from the same client IP may go to any instance in the pool.\nCLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.\nCLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.",
- "enum": [
- "CLIENT_IP",
- "CLIENT_IP_PROTO",
- "NONE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- }
- }
- },
- "TargetPoolAggregatedList": {
- "id": "TargetPoolAggregatedList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server."
- },
- "items": {
- "type": "object",
- "description": "A map of scoped target pool lists.",
- "additionalProperties": {
- "$ref": "TargetPoolsScopedList",
- "description": "Name of the scope containing this set of target pools."
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#targetPoolAggregatedList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "TargetPoolInstanceHealth": {
- "id": "TargetPoolInstanceHealth",
- "type": "object",
- "properties": {
- "healthStatus": {
- "type": "array",
- "items": {
- "$ref": "HealthStatus"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#targetPoolInstanceHealth"
- }
- }
- },
- "TargetPoolList": {
- "id": "TargetPoolList",
- "type": "object",
- "description": "Contains a list of TargetPool resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server."
- },
- "items": {
- "type": "array",
- "description": "A list of TargetPool resources.",
- "items": {
- "$ref": "TargetPool"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#targetPoolList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "TargetPoolsAddHealthCheckRequest": {
- "id": "TargetPoolsAddHealthCheckRequest",
- "type": "object",
- "properties": {
- "healthChecks": {
- "type": "array",
- "description": "Health check URLs to be added to targetPool.",
- "items": {
- "$ref": "HealthCheckReference"
- }
- }
- }
- },
- "TargetPoolsAddInstanceRequest": {
- "id": "TargetPoolsAddInstanceRequest",
- "type": "object",
- "properties": {
- "instances": {
- "type": "array",
- "description": "URLs of the instances to be added to targetPool.",
- "items": {
- "$ref": "InstanceReference"
- }
- }
- }
- },
- "TargetPoolsRemoveHealthCheckRequest": {
- "id": "TargetPoolsRemoveHealthCheckRequest",
- "type": "object",
- "properties": {
- "healthChecks": {
- "type": "array",
- "description": "Health check URLs to be removed from targetPool.",
- "items": {
- "$ref": "HealthCheckReference"
- }
- }
- }
- },
- "TargetPoolsRemoveInstanceRequest": {
- "id": "TargetPoolsRemoveInstanceRequest",
- "type": "object",
- "properties": {
- "instances": {
- "type": "array",
- "description": "URLs of the instances to be removed from targetPool.",
- "items": {
- "$ref": "InstanceReference"
- }
- }
- }
- },
- "TargetPoolsScopedList": {
- "id": "TargetPoolsScopedList",
- "type": "object",
- "properties": {
- "targetPools": {
- "type": "array",
- "description": "List of target pools contained in this scope.",
- "items": {
- "$ref": "TargetPool"
- }
- },
- "warning": {
- "type": "object",
- "description": "Informational warning which replaces the list of addresses when the list is empty.",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- },
- "TargetReference": {
- "id": "TargetReference",
- "type": "object",
- "properties": {
- "target": {
- "type": "string"
- }
- }
- },
- "TargetVpnGateway": {
- "id": "TargetVpnGateway",
- "type": "object",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource. Provided by the client when the resource is created."
- },
- "forwardingRules": {
- "type": "array",
- "description": "[Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.",
- "default": "compute#targetVpnGateway"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.targetVpnGateways.insert"
- ]
- }
- },
- "network": {
- "type": "string",
- "description": "URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.",
- "annotations": {
- "required": [
- "compute.targetVpnGateways.insert"
- ]
- }
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the target VPN gateway resides."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "status": {
- "type": "string",
- "description": "[Output Only] The status of the VPN gateway.",
- "enum": [
- "CREATING",
- "DELETING",
- "FAILED",
- "READY"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- },
- "tunnels": {
- "type": "array",
- "description": "[Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert and associated to a VPN gateway.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "TargetVpnGatewayAggregatedList": {
- "id": "TargetVpnGatewayAggregatedList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server."
- },
- "items": {
- "type": "object",
- "description": "A map of scoped target vpn gateway lists.",
- "additionalProperties": {
- "$ref": "TargetVpnGatewaysScopedList",
- "description": "[Output Only] Name of the scope containing this set of target vpn gateways."
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.",
- "default": "compute#targetVpnGatewayAggregatedList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- }
- }
- },
- "TargetVpnGatewayList": {
- "id": "TargetVpnGatewayList",
- "type": "object",
- "description": "Contains a list of TargetVpnGateway resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of TargetVpnGateway resources.",
- "items": {
- "$ref": "TargetVpnGateway"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.",
- "default": "compute#targetVpnGatewayList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- }
- }
- },
- "TargetVpnGatewaysScopedList": {
- "id": "TargetVpnGatewaysScopedList",
- "type": "object",
- "properties": {
- "targetVpnGateways": {
- "type": "array",
- "description": "[Output Only] List of target vpn gateways contained in this scope.",
- "items": {
- "$ref": "TargetVpnGateway"
- }
- },
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning which replaces the list of addresses when the list is empty.",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- },
- "TestFailure": {
- "id": "TestFailure",
- "type": "object",
- "properties": {
- "actualService": {
- "type": "string"
- },
- "expectedService": {
- "type": "string"
- },
- "host": {
- "type": "string"
- },
- "path": {
- "type": "string"
- }
- }
- },
- "UrlMap": {
- "id": "UrlMap",
- "type": "object",
- "description": "A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the \"longest-match\" of the URL's host and path.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "defaultService": {
- "type": "string",
- "description": "The URL of the BackendService resource if none of the hostRules match."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource. Provided by the client when the resource is created."
- },
- "fingerprint": {
- "type": "string",
- "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.",
- "format": "byte"
- },
- "hostRules": {
- "type": "array",
- "description": "The list of HostRules to use against the URL.",
- "items": {
- "$ref": "HostRule"
- }
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Set by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource.",
- "default": "compute#urlMap"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "pathMatchers": {
- "type": "array",
- "description": "The list of named PathMatchers to use against the URL.",
- "items": {
- "$ref": "PathMatcher"
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "tests": {
- "type": "array",
- "description": "The list of expected URL mappings. Request to update this UrlMap will succeed only all of the test cases pass.",
- "items": {
- "$ref": "UrlMapTest"
- }
- }
- }
- },
- "UrlMapList": {
- "id": "UrlMapList",
- "type": "object",
- "description": "Contains a list of UrlMap resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Set by the server."
- },
- "items": {
- "type": "array",
- "description": "A list of UrlMap resources.",
- "items": {
- "$ref": "UrlMap"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#urlMapList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "UrlMapReference": {
- "id": "UrlMapReference",
- "type": "object",
- "properties": {
- "urlMap": {
- "type": "string"
- }
- }
- },
- "UrlMapTest": {
- "id": "UrlMapTest",
- "type": "object",
- "description": "Message for the expected URL mappings.",
- "properties": {
- "description": {
- "type": "string",
- "description": "Description of this test case."
- },
- "host": {
- "type": "string",
- "description": "Host portion of the URL."
- },
- "path": {
- "type": "string",
- "description": "Path portion of the URL."
- },
- "service": {
- "type": "string",
- "description": "Expected BackendService resource the given URL should be mapped to."
- }
- }
- },
- "UrlMapValidationResult": {
- "id": "UrlMapValidationResult",
- "type": "object",
- "description": "Message representing the validation result for a UrlMap.",
- "properties": {
- "loadErrors": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "loadSucceeded": {
- "type": "boolean",
- "description": "Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons."
- },
- "testFailures": {
- "type": "array",
- "items": {
- "$ref": "TestFailure"
- }
- },
- "testPassed": {
- "type": "boolean",
- "description": "If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure."
- }
- }
- },
- "UrlMapsValidateRequest": {
- "id": "UrlMapsValidateRequest",
- "type": "object",
- "properties": {
- "resource": {
- "$ref": "UrlMap",
- "description": "Content of the UrlMap to be validated."
- }
- }
- },
- "UrlMapsValidateResponse": {
- "id": "UrlMapsValidateResponse",
- "type": "object",
- "properties": {
- "result": {
- "$ref": "UrlMapValidationResult"
- }
- }
- },
- "UsageExportLocation": {
- "id": "UsageExportLocation",
- "type": "object",
- "description": "The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix.",
- "properties": {
- "bucketName": {
- "type": "string",
- "description": "The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This is just the bucket name, with no gs:// or https://storage.googleapis.com/ in front of it."
- },
- "reportNamePrefix": {
- "type": "string",
- "description": "An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions."
- }
- }
- },
- "VpnTunnel": {
- "id": "VpnTunnel",
- "type": "object",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional textual description of the resource. Provided by the client when the resource is created."
- },
- "detailedStatus": {
- "type": "string",
- "description": "[Output Only] Detailed status message for the VPN tunnel."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource. Defined by the server.",
- "format": "uint64"
- },
- "ikeVersion": {
- "type": "integer",
- "description": "IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.",
- "format": "int32"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.",
- "default": "compute#vpnTunnel"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.vpnTunnels.insert"
- ]
- }
- },
- "peerIp": {
- "type": "string",
- "description": "IP address of the peer VPN gateway."
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the VPN tunnel resides."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "sharedSecret": {
- "type": "string",
- "description": "Shared secret used to set the secure session between the GCE VPN gateway and the peer VPN gateway."
- },
- "sharedSecretHash": {
- "type": "string",
- "description": "Hash of the shared secret."
- },
- "status": {
- "type": "string",
- "description": "[Output Only] The status of the VPN tunnel.",
- "enum": [
- "AUTHORIZATION_ERROR",
- "DEPROVISIONING",
- "ESTABLISHED",
- "FAILED",
- "FIRST_HANDSHAKE",
- "NEGOTIATION_FAILURE",
- "NETWORK_ERROR",
- "NO_INCOMING_PACKETS",
- "PROVISIONING",
- "REJECTED",
- "WAITING_FOR_FULL_CONFIG"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "targetVpnGateway": {
- "type": "string",
- "description": "URL of the VPN gateway to which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.",
- "annotations": {
- "required": [
- "compute.vpnTunnels.insert"
- ]
- }
- }
- }
- },
- "VpnTunnelAggregatedList": {
- "id": "VpnTunnelAggregatedList",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "object",
- "description": "[Output Only] A map of scoped vpn tunnel lists.",
- "additionalProperties": {
- "$ref": "VpnTunnelsScopedList",
- "description": "Name of the scope containing this set of vpn tunnels."
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.",
- "default": "compute#vpnTunnelAggregatedList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "VpnTunnelList": {
- "id": "VpnTunnelList",
- "type": "object",
- "description": "Contains a list of VpnTunnel resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of VpnTunnel resources.",
- "items": {
- "$ref": "VpnTunnel"
- }
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.",
- "default": "compute#vpnTunnelList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- }
- }
- },
- "VpnTunnelsScopedList": {
- "id": "VpnTunnelsScopedList",
- "type": "object",
- "properties": {
- "vpnTunnels": {
- "type": "array",
- "description": "List of vpn tunnels contained in this scope.",
- "items": {
- "$ref": "VpnTunnel"
- }
- },
- "warning": {
- "type": "object",
- "description": "Informational warning which replaces the list of addresses when the list is empty.",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning.",
- "enum": [
- "DEPRECATED_RESOURCE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "INJECTED_KERNELS_DEPRECATED",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_NOT_DELETED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- },
- "Zone": {
- "id": "Zone",
- "type": "object",
- "description": "A Zone resource.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "deprecated": {
- "$ref": "DeprecationStatus",
- "description": "[Output Only] The deprecation status associated with this zone."
- },
- "description": {
- "type": "string",
- "description": "[Output Only] Textual description of the resource."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always kind#zone for zones.",
- "default": "compute#zone"
- },
- "maintenanceWindows": {
- "type": "array",
- "description": "[Output Only] Any scheduled maintenance windows for this zone. When the zone is in a maintenance window, all resources which reside in the zone will be unavailable. For more information, see Maintenance Windows",
- "items": {
- "type": "object",
- "properties": {
- "beginTime": {
- "type": "string",
- "description": "[Output Only] Starting time of the maintenance window, in RFC3339 format."
- },
- "description": {
- "type": "string",
- "description": "[Output Only] Textual description of the maintenance window."
- },
- "endTime": {
- "type": "string",
- "description": "[Output Only] Ending time of the maintenance window, in RFC3339 format."
- },
- "name": {
- "type": "string",
- "description": "[Output Only] Name of the maintenance window."
- }
- }
- }
- },
- "name": {
- "type": "string",
- "description": "[Output Only] Name of the resource."
- },
- "region": {
- "type": "string",
- "description": "[Output Only] Full URL reference to the region which hosts the zone."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "status": {
- "type": "string",
- "description": "[Output Only] Status of the zone, either UP or DOWN.",
- "enum": [
- "DOWN",
- "UP"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- }
- }
- },
- "ZoneList": {
- "id": "ZoneList",
- "type": "object",
- "description": "Contains a list of zone resources.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "array",
- "description": "[Output Only] A list of Zone resources.",
- "items": {
- "$ref": "Zone"
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#zoneList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- }
- },
- "resources": {
- "addresses": {
- "methods": {
- "aggregatedList": {
- "id": "compute.addresses.aggregatedList",
- "path": "{project}/aggregated/addresses",
- "httpMethod": "GET",
- "description": "Retrieves the list of addresses grouped by scope.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "AddressAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "delete": {
- "id": "compute.addresses.delete",
- "path": "{project}/regions/{region}/addresses/{address}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified address resource.",
- "parameters": {
- "address": {
- "type": "string",
- "description": "Name of the address resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "The name of the region for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "address"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.addresses.get",
- "path": "{project}/regions/{region}/addresses/{address}",
- "httpMethod": "GET",
- "description": "Returns the specified address resource.",
- "parameters": {
- "address": {
- "type": "string",
- "description": "Name of the address resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "The name of the region for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "address"
- ],
- "response": {
- "$ref": "Address"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.addresses.insert",
- "path": "{project}/regions/{region}/addresses",
- "httpMethod": "POST",
- "description": "Creates an address resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "The name of the region for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "request": {
- "$ref": "Address"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.addresses.list",
- "path": "{project}/regions/{region}/addresses",
- "httpMethod": "GET",
- "description": "Retrieves the list of address resources contained within the specified region.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "The name of the region for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "response": {
- "$ref": "AddressList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "autoscalers": {
- "methods": {
- "aggregatedList": {
- "id": "compute.autoscalers.aggregatedList",
- "path": "{project}/aggregated/autoscalers",
- "httpMethod": "GET",
- "description": "Retrieves the list of autoscalers grouped by scope.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "AutoscalerAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "delete": {
- "id": "compute.autoscalers.delete",
- "path": "{project}/zones/{zone}/autoscalers/{autoscaler}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified autoscaler resource.",
- "parameters": {
- "autoscaler": {
- "type": "string",
- "description": "Name of the persistent autoscaler resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "autoscaler"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.autoscalers.get",
- "path": "{project}/zones/{zone}/autoscalers/{autoscaler}",
- "httpMethod": "GET",
- "description": "Returns the specified autoscaler resource.",
- "parameters": {
- "autoscaler": {
- "type": "string",
- "description": "Name of the persistent autoscaler resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "autoscaler"
- ],
- "response": {
- "$ref": "Autoscaler"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.autoscalers.insert",
- "path": "{project}/zones/{zone}/autoscalers",
- "httpMethod": "POST",
- "description": "Creates an autoscaler resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "request": {
- "$ref": "Autoscaler"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.autoscalers.list",
- "path": "{project}/zones/{zone}/autoscalers",
- "httpMethod": "GET",
- "description": "Retrieves the list of autoscaler resources contained within the specified zone.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "response": {
- "$ref": "AutoscalerList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "patch": {
- "id": "compute.autoscalers.patch",
- "path": "{project}/zones/{zone}/autoscalers",
- "httpMethod": "PATCH",
- "description": "Updates an autoscaler resource in the specified project using the data included in the request. This method supports patch semantics.",
- "parameters": {
- "autoscaler": {
- "type": "string",
- "description": "Name of the autoscaler resource to update.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "autoscaler"
- ],
- "request": {
- "$ref": "Autoscaler"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "update": {
- "id": "compute.autoscalers.update",
- "path": "{project}/zones/{zone}/autoscalers",
- "httpMethod": "PUT",
- "description": "Updates an autoscaler resource in the specified project using the data included in the request.",
- "parameters": {
- "autoscaler": {
- "type": "string",
- "description": "Name of the autoscaler resource to update.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "request": {
- "$ref": "Autoscaler"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "backendServices": {
- "methods": {
- "delete": {
- "id": "compute.backendServices.delete",
- "path": "{project}/global/backendServices/{backendService}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified BackendService resource.",
- "parameters": {
- "backendService": {
- "type": "string",
- "description": "Name of the BackendService resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "backendService"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.backendServices.get",
- "path": "{project}/global/backendServices/{backendService}",
- "httpMethod": "GET",
- "description": "Returns the specified BackendService resource.",
- "parameters": {
- "backendService": {
- "type": "string",
- "description": "Name of the BackendService resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "backendService"
- ],
- "response": {
- "$ref": "BackendService"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "getHealth": {
- "id": "compute.backendServices.getHealth",
- "path": "{project}/global/backendServices/{backendService}/getHealth",
- "httpMethod": "POST",
- "description": "Gets the most recent health check results for this BackendService.",
- "parameters": {
- "backendService": {
- "type": "string",
- "description": "Name of the BackendService resource to which the queried instance belongs.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "backendService"
- ],
- "request": {
- "$ref": "ResourceGroupReference"
- },
- "response": {
- "$ref": "BackendServiceGroupHealth"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.backendServices.insert",
- "path": "{project}/global/backendServices",
- "httpMethod": "POST",
- "description": "Creates a BackendService resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "BackendService"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.backendServices.list",
- "path": "{project}/global/backendServices",
- "httpMethod": "GET",
- "description": "Retrieves the list of BackendService resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "BackendServiceList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "patch": {
- "id": "compute.backendServices.patch",
- "path": "{project}/global/backendServices/{backendService}",
- "httpMethod": "PATCH",
- "description": "Update the entire content of the BackendService resource. This method supports patch semantics.",
- "parameters": {
- "backendService": {
- "type": "string",
- "description": "Name of the BackendService resource to update.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "backendService"
- ],
- "request": {
- "$ref": "BackendService"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "update": {
- "id": "compute.backendServices.update",
- "path": "{project}/global/backendServices/{backendService}",
- "httpMethod": "PUT",
- "description": "Update the entire content of the BackendService resource.",
- "parameters": {
- "backendService": {
- "type": "string",
- "description": "Name of the BackendService resource to update.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "backendService"
- ],
- "request": {
- "$ref": "BackendService"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "diskTypes": {
- "methods": {
- "aggregatedList": {
- "id": "compute.diskTypes.aggregatedList",
- "path": "{project}/aggregated/diskTypes",
- "httpMethod": "GET",
- "description": "Retrieves the list of disk type resources grouped by scope.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "DiskTypeAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "get": {
- "id": "compute.diskTypes.get",
- "path": "{project}/zones/{zone}/diskTypes/{diskType}",
- "httpMethod": "GET",
- "description": "Returns the specified disk type resource.",
- "parameters": {
- "diskType": {
- "type": "string",
- "description": "Name of the disk type resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "diskType"
- ],
- "response": {
- "$ref": "DiskType"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "list": {
- "id": "compute.diskTypes.list",
- "path": "{project}/zones/{zone}/diskTypes",
- "httpMethod": "GET",
- "description": "Retrieves the list of disk type resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "response": {
- "$ref": "DiskTypeList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "disks": {
- "methods": {
- "aggregatedList": {
- "id": "compute.disks.aggregatedList",
- "path": "{project}/aggregated/disks",
- "httpMethod": "GET",
- "description": "Retrieves the list of disks grouped by scope.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "DiskAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "createSnapshot": {
- "id": "compute.disks.createSnapshot",
- "path": "{project}/zones/{zone}/disks/{disk}/createSnapshot",
- "httpMethod": "POST",
- "description": "Creates a snapshot of this disk.",
- "parameters": {
- "disk": {
- "type": "string",
- "description": "Name of the persistent disk to snapshot.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "disk"
- ],
- "request": {
- "$ref": "Snapshot"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "delete": {
- "id": "compute.disks.delete",
- "path": "{project}/zones/{zone}/disks/{disk}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.",
- "parameters": {
- "disk": {
- "type": "string",
- "description": "Name of the persistent disk to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "disk"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.disks.get",
- "path": "{project}/zones/{zone}/disks/{disk}",
- "httpMethod": "GET",
- "description": "Returns a specified persistent disk.",
- "parameters": {
- "disk": {
- "type": "string",
- "description": "Name of the persistent disk to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "disk"
- ],
- "response": {
- "$ref": "Disk"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.disks.insert",
- "path": "{project}/zones/{zone}/disks",
- "httpMethod": "POST",
- "description": "Creates a persistent disk in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "sourceImage": {
- "type": "string",
- "description": "Optional. Source image to restore onto a disk.",
- "location": "query"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "request": {
- "$ref": "Disk"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.disks.list",
- "path": "{project}/zones/{zone}/disks",
- "httpMethod": "GET",
- "description": "Retrieves the list of persistent disks contained within the specified zone.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "response": {
- "$ref": "DiskList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "firewalls": {
- "methods": {
- "delete": {
- "id": "compute.firewalls.delete",
- "path": "{project}/global/firewalls/{firewall}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified firewall resource.",
- "parameters": {
- "firewall": {
- "type": "string",
- "description": "Name of the firewall resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "firewall"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.firewalls.get",
- "path": "{project}/global/firewalls/{firewall}",
- "httpMethod": "GET",
- "description": "Returns the specified firewall resource.",
- "parameters": {
- "firewall": {
- "type": "string",
- "description": "Name of the firewall resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "firewall"
- ],
- "response": {
- "$ref": "Firewall"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.firewalls.insert",
- "path": "{project}/global/firewalls",
- "httpMethod": "POST",
- "description": "Creates a firewall resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "Firewall"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.firewalls.list",
- "path": "{project}/global/firewalls",
- "httpMethod": "GET",
- "description": "Retrieves the list of firewall resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "FirewallList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "patch": {
- "id": "compute.firewalls.patch",
- "path": "{project}/global/firewalls/{firewall}",
- "httpMethod": "PATCH",
- "description": "Updates the specified firewall resource with the data included in the request. This method supports patch semantics.",
- "parameters": {
- "firewall": {
- "type": "string",
- "description": "Name of the firewall resource to update.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "firewall"
- ],
- "request": {
- "$ref": "Firewall"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "update": {
- "id": "compute.firewalls.update",
- "path": "{project}/global/firewalls/{firewall}",
- "httpMethod": "PUT",
- "description": "Updates the specified firewall resource with the data included in the request.",
- "parameters": {
- "firewall": {
- "type": "string",
- "description": "Name of the firewall resource to update.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "firewall"
- ],
- "request": {
- "$ref": "Firewall"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "forwardingRules": {
- "methods": {
- "aggregatedList": {
- "id": "compute.forwardingRules.aggregatedList",
- "path": "{project}/aggregated/forwardingRules",
- "httpMethod": "GET",
- "description": "Retrieves the list of forwarding rules grouped by scope.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "ForwardingRuleAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "delete": {
- "id": "compute.forwardingRules.delete",
- "path": "{project}/regions/{region}/forwardingRules/{forwardingRule}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified ForwardingRule resource.",
- "parameters": {
- "forwardingRule": {
- "type": "string",
- "description": "Name of the ForwardingRule resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "forwardingRule"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.forwardingRules.get",
- "path": "{project}/regions/{region}/forwardingRules/{forwardingRule}",
- "httpMethod": "GET",
- "description": "Returns the specified ForwardingRule resource.",
- "parameters": {
- "forwardingRule": {
- "type": "string",
- "description": "Name of the ForwardingRule resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "forwardingRule"
- ],
- "response": {
- "$ref": "ForwardingRule"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.forwardingRules.insert",
- "path": "{project}/regions/{region}/forwardingRules",
- "httpMethod": "POST",
- "description": "Creates a ForwardingRule resource in the specified project and region using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "request": {
- "$ref": "ForwardingRule"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.forwardingRules.list",
- "path": "{project}/regions/{region}/forwardingRules",
- "httpMethod": "GET",
- "description": "Retrieves the list of ForwardingRule resources available to the specified project and region.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "response": {
- "$ref": "ForwardingRuleList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "setTarget": {
- "id": "compute.forwardingRules.setTarget",
- "path": "{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget",
- "httpMethod": "POST",
- "description": "Changes target url for forwarding rule.",
- "parameters": {
- "forwardingRule": {
- "type": "string",
- "description": "Name of the ForwardingRule resource in which target is to be set.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "forwardingRule"
- ],
- "request": {
- "$ref": "TargetReference"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "globalAddresses": {
- "methods": {
- "delete": {
- "id": "compute.globalAddresses.delete",
- "path": "{project}/global/addresses/{address}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified address resource.",
- "parameters": {
- "address": {
- "type": "string",
- "description": "Name of the address resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "address"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.globalAddresses.get",
- "path": "{project}/global/addresses/{address}",
- "httpMethod": "GET",
- "description": "Returns the specified address resource.",
- "parameters": {
- "address": {
- "type": "string",
- "description": "Name of the address resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "address"
- ],
- "response": {
- "$ref": "Address"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.globalAddresses.insert",
- "path": "{project}/global/addresses",
- "httpMethod": "POST",
- "description": "Creates an address resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "Address"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.globalAddresses.list",
- "path": "{project}/global/addresses",
- "httpMethod": "GET",
- "description": "Retrieves the list of global address resources.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "AddressList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "globalForwardingRules": {
- "methods": {
- "delete": {
- "id": "compute.globalForwardingRules.delete",
- "path": "{project}/global/forwardingRules/{forwardingRule}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified ForwardingRule resource.",
- "parameters": {
- "forwardingRule": {
- "type": "string",
- "description": "Name of the ForwardingRule resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "forwardingRule"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.globalForwardingRules.get",
- "path": "{project}/global/forwardingRules/{forwardingRule}",
- "httpMethod": "GET",
- "description": "Returns the specified ForwardingRule resource.",
- "parameters": {
- "forwardingRule": {
- "type": "string",
- "description": "Name of the ForwardingRule resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "forwardingRule"
- ],
- "response": {
- "$ref": "ForwardingRule"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.globalForwardingRules.insert",
- "path": "{project}/global/forwardingRules",
- "httpMethod": "POST",
- "description": "Creates a ForwardingRule resource in the specified project and region using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "ForwardingRule"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.globalForwardingRules.list",
- "path": "{project}/global/forwardingRules",
- "httpMethod": "GET",
- "description": "Retrieves the list of ForwardingRule resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "ForwardingRuleList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "setTarget": {
- "id": "compute.globalForwardingRules.setTarget",
- "path": "{project}/global/forwardingRules/{forwardingRule}/setTarget",
- "httpMethod": "POST",
- "description": "Changes target url for forwarding rule.",
- "parameters": {
- "forwardingRule": {
- "type": "string",
- "description": "Name of the ForwardingRule resource in which target is to be set.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "forwardingRule"
- ],
- "request": {
- "$ref": "TargetReference"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "globalOperations": {
- "methods": {
- "aggregatedList": {
- "id": "compute.globalOperations.aggregatedList",
- "path": "{project}/aggregated/operations",
- "httpMethod": "GET",
- "description": "Retrieves the list of all operations grouped by scope.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "OperationAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "delete": {
- "id": "compute.globalOperations.delete",
- "path": "{project}/global/operations/{operation}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified Operations resource.",
- "parameters": {
- "operation": {
- "type": "string",
- "description": "Name of the Operations resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "operation"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.globalOperations.get",
- "path": "{project}/global/operations/{operation}",
- "httpMethod": "GET",
- "description": "Retrieves the specified Operations resource.",
- "parameters": {
- "operation": {
- "type": "string",
- "description": "Name of the Operations resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "operation"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "list": {
- "id": "compute.globalOperations.list",
- "path": "{project}/global/operations",
- "httpMethod": "GET",
- "description": "Retrieves the list of Operation resources contained within the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "OperationList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "httpHealthChecks": {
- "methods": {
- "delete": {
- "id": "compute.httpHealthChecks.delete",
- "path": "{project}/global/httpHealthChecks/{httpHealthCheck}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified HttpHealthCheck resource.",
- "parameters": {
- "httpHealthCheck": {
- "type": "string",
- "description": "Name of the HttpHealthCheck resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "httpHealthCheck"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.httpHealthChecks.get",
- "path": "{project}/global/httpHealthChecks/{httpHealthCheck}",
- "httpMethod": "GET",
- "description": "Returns the specified HttpHealthCheck resource.",
- "parameters": {
- "httpHealthCheck": {
- "type": "string",
- "description": "Name of the HttpHealthCheck resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "httpHealthCheck"
- ],
- "response": {
- "$ref": "HttpHealthCheck"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.httpHealthChecks.insert",
- "path": "{project}/global/httpHealthChecks",
- "httpMethod": "POST",
- "description": "Creates a HttpHealthCheck resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "HttpHealthCheck"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.httpHealthChecks.list",
- "path": "{project}/global/httpHealthChecks",
- "httpMethod": "GET",
- "description": "Retrieves the list of HttpHealthCheck resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "HttpHealthCheckList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "patch": {
- "id": "compute.httpHealthChecks.patch",
- "path": "{project}/global/httpHealthChecks/{httpHealthCheck}",
- "httpMethod": "PATCH",
- "description": "Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.",
- "parameters": {
- "httpHealthCheck": {
- "type": "string",
- "description": "Name of the HttpHealthCheck resource to update.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "httpHealthCheck"
- ],
- "request": {
- "$ref": "HttpHealthCheck"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "update": {
- "id": "compute.httpHealthChecks.update",
- "path": "{project}/global/httpHealthChecks/{httpHealthCheck}",
- "httpMethod": "PUT",
- "description": "Updates a HttpHealthCheck resource in the specified project using the data included in the request.",
- "parameters": {
- "httpHealthCheck": {
- "type": "string",
- "description": "Name of the HttpHealthCheck resource to update.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "httpHealthCheck"
- ],
- "request": {
- "$ref": "HttpHealthCheck"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "httpsHealthChecks": {
- "methods": {
- "delete": {
- "id": "compute.httpsHealthChecks.delete",
- "path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified HttpsHealthCheck resource.",
- "parameters": {
- "httpsHealthCheck": {
- "type": "string",
- "description": "Name of the HttpsHealthCheck resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "httpsHealthCheck"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.httpsHealthChecks.get",
- "path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}",
- "httpMethod": "GET",
- "description": "Returns the specified HttpsHealthCheck resource.",
- "parameters": {
- "httpsHealthCheck": {
- "type": "string",
- "description": "Name of the HttpsHealthCheck resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "httpsHealthCheck"
- ],
- "response": {
- "$ref": "HttpsHealthCheck"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.httpsHealthChecks.insert",
- "path": "{project}/global/httpsHealthChecks",
- "httpMethod": "POST",
- "description": "Creates a HttpsHealthCheck resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "HttpsHealthCheck"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.httpsHealthChecks.list",
- "path": "{project}/global/httpsHealthChecks",
- "httpMethod": "GET",
- "description": "Retrieves the list of HttpsHealthCheck resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "HttpsHealthCheckList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "patch": {
- "id": "compute.httpsHealthChecks.patch",
- "path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}",
- "httpMethod": "PATCH",
- "description": "Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.",
- "parameters": {
- "httpsHealthCheck": {
- "type": "string",
- "description": "Name of the HttpsHealthCheck resource to update.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "httpsHealthCheck"
- ],
- "request": {
- "$ref": "HttpsHealthCheck"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "update": {
- "id": "compute.httpsHealthChecks.update",
- "path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}",
- "httpMethod": "PUT",
- "description": "Updates a HttpsHealthCheck resource in the specified project using the data included in the request.",
- "parameters": {
- "httpsHealthCheck": {
- "type": "string",
- "description": "Name of the HttpsHealthCheck resource to update.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "httpsHealthCheck"
- ],
- "request": {
- "$ref": "HttpsHealthCheck"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "images": {
- "methods": {
- "delete": {
- "id": "compute.images.delete",
- "path": "{project}/global/images/{image}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified image resource.",
- "parameters": {
- "image": {
- "type": "string",
- "description": "Name of the image resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "image"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "deprecate": {
- "id": "compute.images.deprecate",
- "path": "{project}/global/images/{image}/deprecate",
- "httpMethod": "POST",
- "description": "Sets the deprecation status of an image.\n\nIf an empty request body is given, clears the deprecation status instead.",
- "parameters": {
- "image": {
- "type": "string",
- "description": "Image name.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "image"
- ],
- "request": {
- "$ref": "DeprecationStatus"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.images.get",
- "path": "{project}/global/images/{image}",
- "httpMethod": "GET",
- "description": "Returns the specified image resource.",
- "parameters": {
- "image": {
- "type": "string",
- "description": "Name of the image resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "image"
- ],
- "response": {
- "$ref": "Image"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.images.insert",
- "path": "{project}/global/images",
- "httpMethod": "POST",
- "description": "Creates an image resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "Image"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/devstorage.full_control",
- "https://www.googleapis.com/auth/devstorage.read_only",
- "https://www.googleapis.com/auth/devstorage.read_write"
- ]
- },
- "list": {
- "id": "compute.images.list",
- "path": "{project}/global/images",
- "httpMethod": "GET",
- "description": "Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 7. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.\n\nSee Accessing images for more information.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "ImageList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "instanceGroupManagers": {
- "methods": {
- "abandonInstances": {
- "id": "compute.instanceGroupManagers.abandonInstances",
- "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances",
- "httpMethod": "POST",
- "description": "Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.",
- "parameters": {
- "instanceGroupManager": {
- "type": "string",
- "description": "The name of the managed instance group.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the managed instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
- ],
- "request": {
- "$ref": "InstanceGroupManagersAbandonInstancesRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "aggregatedList": {
- "id": "compute.instanceGroupManagers.aggregatedList",
- "path": "{project}/aggregated/instanceGroupManagers",
- "httpMethod": "GET",
- "description": "Retrieves the list of managed instance groups and groups them by zone.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "InstanceGroupManagerAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "delete": {
- "id": "compute.instanceGroupManagers.delete",
- "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified managed instance group and all of the instances in that group.",
- "parameters": {
- "instanceGroupManager": {
- "type": "string",
- "description": "The name of the managed instance group to delete.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the managed instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "deleteInstances": {
- "id": "compute.instanceGroupManagers.deleteInstances",
- "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances",
- "httpMethod": "POST",
- "description": "Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.",
- "parameters": {
- "instanceGroupManager": {
- "type": "string",
- "description": "The name of the managed instance group.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the managed instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
- ],
- "request": {
- "$ref": "InstanceGroupManagersDeleteInstancesRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.instanceGroupManagers.get",
- "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}",
- "httpMethod": "GET",
- "description": "Returns all of the details about the specified managed instance group.",
- "parameters": {
- "instanceGroupManager": {
- "type": "string",
- "description": "The name of the managed instance group.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the managed instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
- ],
- "response": {
- "$ref": "InstanceGroupManager"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.instanceGroupManagers.insert",
- "path": "{project}/zones/{zone}/instanceGroupManagers",
- "httpMethod": "POST",
- "description": "Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where you want to create the managed instance group.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "request": {
- "$ref": "InstanceGroupManager"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.instanceGroupManagers.list",
- "path": "{project}/zones/{zone}/instanceGroupManagers",
- "httpMethod": "GET",
- "description": "Retrieves a list of managed instance groups that are contained within the specified project and zone.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the managed instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "response": {
- "$ref": "InstanceGroupManagerList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "listManagedInstances": {
- "id": "compute.instanceGroupManagers.listManagedInstances",
- "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances",
- "httpMethod": "POST",
- "description": "Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action.",
- "parameters": {
- "instanceGroupManager": {
- "type": "string",
- "description": "The name of the managed instance group.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the managed instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
- ],
- "response": {
- "$ref": "InstanceGroupManagersListManagedInstancesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "recreateInstances": {
- "id": "compute.instanceGroupManagers.recreateInstances",
- "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances",
- "httpMethod": "POST",
- "description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.",
- "parameters": {
- "instanceGroupManager": {
- "type": "string",
- "description": "The name of the managed instance group.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the managed instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
- ],
- "request": {
- "$ref": "InstanceGroupManagersRecreateInstancesRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "resize": {
- "id": "compute.instanceGroupManagers.resize",
- "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize",
- "httpMethod": "POST",
- "description": "Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.",
- "parameters": {
- "instanceGroupManager": {
- "type": "string",
- "description": "The name of the managed instance group.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "size": {
- "type": "integer",
- "description": "The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter.",
- "required": true,
- "format": "int32",
- "location": "query"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the managed instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager",
- "size"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "setInstanceTemplate": {
- "id": "compute.instanceGroupManagers.setInstanceTemplate",
- "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate",
- "httpMethod": "POST",
- "description": "Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.",
- "parameters": {
- "instanceGroupManager": {
- "type": "string",
- "description": "The name of the managed instance group.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the managed instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
- ],
- "request": {
- "$ref": "InstanceGroupManagersSetInstanceTemplateRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "setTargetPools": {
- "id": "compute.instanceGroupManagers.setTargetPools",
- "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools",
- "httpMethod": "POST",
- "description": "Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.",
- "parameters": {
- "instanceGroupManager": {
- "type": "string",
- "description": "The name of the managed instance group.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the managed instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
- ],
- "request": {
- "$ref": "InstanceGroupManagersSetTargetPoolsRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "instanceGroups": {
- "methods": {
- "addInstances": {
- "id": "compute.instanceGroups.addInstances",
- "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances",
- "httpMethod": "POST",
- "description": "Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. TODO: Change to comment to state \"if IG is load balanced.\"",
- "parameters": {
- "instanceGroup": {
- "type": "string",
- "description": "The name of the instance group where you are adding instances.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroup"
- ],
- "request": {
- "$ref": "InstanceGroupsAddInstancesRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "aggregatedList": {
- "id": "compute.instanceGroups.aggregatedList",
- "path": "{project}/aggregated/instanceGroups",
- "httpMethod": "GET",
- "description": "Retrieves the list of instance groups and sorts them by zone.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "InstanceGroupAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "delete": {
- "id": "compute.instanceGroups.delete",
- "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified instance group. The instances in the group are not deleted.",
- "parameters": {
- "instanceGroup": {
- "type": "string",
- "description": "The name of the instance group to delete.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroup"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.instanceGroups.get",
- "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}",
- "httpMethod": "GET",
- "description": "Returns the specified instance group resource.",
- "parameters": {
- "instanceGroup": {
- "type": "string",
- "description": "The name of the instance group.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroup"
- ],
- "response": {
- "$ref": "InstanceGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.instanceGroups.insert",
- "path": "{project}/zones/{zone}/instanceGroups",
- "httpMethod": "POST",
- "description": "Creates an instance group in the specified project using the parameters that are included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where you want to create the instance group.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "request": {
- "$ref": "InstanceGroup"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.instanceGroups.list",
- "path": "{project}/zones/{zone}/instanceGroups",
- "httpMethod": "GET",
- "description": "Retrieves the list of instance groups that are located in the specified project and zone.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "response": {
- "$ref": "InstanceGroupList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "listInstances": {
- "id": "compute.instanceGroups.listInstances",
- "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances",
- "httpMethod": "POST",
- "description": "Lists the instances in the specified instance group.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "instanceGroup": {
- "type": "string",
- "description": "The name of the instance group from which you want to generate a list of included instances.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroup"
- ],
- "request": {
- "$ref": "InstanceGroupsListInstancesRequest"
- },
- "response": {
- "$ref": "InstanceGroupsListInstances"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "removeInstances": {
- "id": "compute.instanceGroups.removeInstances",
- "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances",
- "httpMethod": "POST",
- "description": "Removes one or more instances from the specified instance group, but does not delete those instances.",
- "parameters": {
- "instanceGroup": {
- "type": "string",
- "description": "The name of the instance group where the specified instances will be removed.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroup"
- ],
- "request": {
- "$ref": "InstanceGroupsRemoveInstancesRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "setNamedPorts": {
- "id": "compute.instanceGroups.setNamedPorts",
- "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts",
- "httpMethod": "POST",
- "description": "Sets the named ports for the specified instance group.",
- "parameters": {
- "instanceGroup": {
- "type": "string",
- "description": "The name of the instance group where the named ports are updated.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone where the instance group is located.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroup"
- ],
- "request": {
- "$ref": "InstanceGroupsSetNamedPortsRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "instanceTemplates": {
- "methods": {
- "delete": {
- "id": "compute.instanceTemplates.delete",
- "path": "{project}/global/instanceTemplates/{instanceTemplate}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified instance template.",
- "parameters": {
- "instanceTemplate": {
- "type": "string",
- "description": "The name of the instance template to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "instanceTemplate"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.instanceTemplates.get",
- "path": "{project}/global/instanceTemplates/{instanceTemplate}",
- "httpMethod": "GET",
- "description": "Returns the specified instance template resource.",
- "parameters": {
- "instanceTemplate": {
- "type": "string",
- "description": "The name of the instance template.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "instanceTemplate"
- ],
- "response": {
- "$ref": "InstanceTemplate"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.instanceTemplates.insert",
- "path": "{project}/global/instanceTemplates",
- "httpMethod": "POST",
- "description": "Creates an instance template in the specified project using the data that is included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "InstanceTemplate"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.instanceTemplates.list",
- "path": "{project}/global/instanceTemplates",
- "httpMethod": "GET",
- "description": "Retrieves a list of instance templates that are contained within the specified project and zone.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "InstanceTemplateList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "instances": {
- "methods": {
- "addAccessConfig": {
- "id": "compute.instances.addAccessConfig",
- "path": "{project}/zones/{zone}/instances/{instance}/addAccessConfig",
- "httpMethod": "POST",
- "description": "Adds an access config to an instance's network interface.",
- "parameters": {
- "instance": {
- "type": "string",
- "description": "The instance name for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "networkInterface": {
- "type": "string",
- "description": "The name of the network interface to add to this instance.",
- "required": true,
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance",
- "networkInterface"
- ],
- "request": {
- "$ref": "AccessConfig"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "aggregatedList": {
- "id": "compute.instances.aggregatedList",
- "path": "{project}/aggregated/instances",
- "httpMethod": "GET",
- "description": "Retrieves aggregated list of instance resources.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "InstanceAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "attachDisk": {
- "id": "compute.instances.attachDisk",
- "path": "{project}/zones/{zone}/instances/{instance}/attachDisk",
- "httpMethod": "POST",
- "description": "Attaches a Disk resource to an instance.",
- "parameters": {
- "instance": {
- "type": "string",
- "description": "Instance name.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "request": {
- "$ref": "AttachedDisk"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "delete": {
- "id": "compute.instances.delete",
- "path": "{project}/zones/{zone}/instances/{instance}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified Instance resource. For more information, see Shutting down an instance.",
- "parameters": {
- "instance": {
- "type": "string",
- "description": "Name of the instance resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "deleteAccessConfig": {
- "id": "compute.instances.deleteAccessConfig",
- "path": "{project}/zones/{zone}/instances/{instance}/deleteAccessConfig",
- "httpMethod": "POST",
- "description": "Deletes an access config from an instance's network interface.",
- "parameters": {
- "accessConfig": {
- "type": "string",
- "description": "The name of the access config to delete.",
- "required": true,
- "location": "query"
- },
- "instance": {
- "type": "string",
- "description": "The instance name for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "networkInterface": {
- "type": "string",
- "description": "The name of the network interface.",
- "required": true,
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance",
- "accessConfig",
- "networkInterface"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "detachDisk": {
- "id": "compute.instances.detachDisk",
- "path": "{project}/zones/{zone}/instances/{instance}/detachDisk",
- "httpMethod": "POST",
- "description": "Detaches a disk from an instance.",
- "parameters": {
- "deviceName": {
- "type": "string",
- "description": "Disk device name to detach.",
- "required": true,
- "pattern": "\\w[\\w.-]{0,254}",
- "location": "query"
- },
- "instance": {
- "type": "string",
- "description": "Instance name.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance",
- "deviceName"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.instances.get",
- "path": "{project}/zones/{zone}/instances/{instance}",
- "httpMethod": "GET",
- "description": "Returns the specified instance resource.",
- "parameters": {
- "instance": {
- "type": "string",
- "description": "Name of the instance resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "response": {
- "$ref": "Instance"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "getSerialPortOutput": {
- "id": "compute.instances.getSerialPortOutput",
- "path": "{project}/zones/{zone}/instances/{instance}/serialPort",
- "httpMethod": "GET",
- "description": "Returns the specified instance's serial port output.",
- "parameters": {
- "instance": {
- "type": "string",
- "description": "Name of the instance scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "port": {
- "type": "integer",
- "description": "Specifies which COM or serial port to retrieve data from.",
- "default": "1",
- "format": "int32",
- "minimum": "1",
- "maximum": "4",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "response": {
- "$ref": "SerialPortOutput"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.instances.insert",
- "path": "{project}/zones/{zone}/instances",
- "httpMethod": "POST",
- "description": "Creates an instance resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "request": {
- "$ref": "Instance"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.instances.list",
- "path": "{project}/zones/{zone}/instances",
- "httpMethod": "GET",
- "description": "Retrieves the list of instance resources contained within the specified zone.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "response": {
- "$ref": "InstanceList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "reset": {
- "id": "compute.instances.reset",
- "path": "{project}/zones/{zone}/instances/{instance}/reset",
- "httpMethod": "POST",
- "description": "Performs a hard reset on the instance.",
- "parameters": {
- "instance": {
- "type": "string",
- "description": "Name of the instance scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "setDiskAutoDelete": {
- "id": "compute.instances.setDiskAutoDelete",
- "path": "{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete",
- "httpMethod": "POST",
- "description": "Sets the auto-delete flag for a disk attached to an instance.",
- "parameters": {
- "autoDelete": {
- "type": "boolean",
- "description": "Whether to auto-delete the disk when the instance is deleted.",
- "required": true,
- "location": "query"
- },
- "deviceName": {
- "type": "string",
- "description": "The device name of the disk to modify.",
- "required": true,
- "pattern": "\\w[\\w.-]{0,254}",
- "location": "query"
- },
- "instance": {
- "type": "string",
- "description": "The instance name.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance",
- "autoDelete",
- "deviceName"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "setMetadata": {
- "id": "compute.instances.setMetadata",
- "path": "{project}/zones/{zone}/instances/{instance}/setMetadata",
- "httpMethod": "POST",
- "description": "Sets metadata for the specified instance to the data included in the request.",
- "parameters": {
- "instance": {
- "type": "string",
- "description": "Name of the instance scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "request": {
- "$ref": "Metadata"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "setScheduling": {
- "id": "compute.instances.setScheduling",
- "path": "{project}/zones/{zone}/instances/{instance}/setScheduling",
- "httpMethod": "POST",
- "description": "Sets an instance's scheduling options.",
- "parameters": {
- "instance": {
- "type": "string",
- "description": "Instance name.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "request": {
- "$ref": "Scheduling"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "setTags": {
- "id": "compute.instances.setTags",
- "path": "{project}/zones/{zone}/instances/{instance}/setTags",
- "httpMethod": "POST",
- "description": "Sets tags for the specified instance to the data included in the request.",
- "parameters": {
- "instance": {
- "type": "string",
- "description": "Name of the instance scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "request": {
- "$ref": "Tags"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "start": {
- "id": "compute.instances.start",
- "path": "{project}/zones/{zone}/instances/{instance}/start",
- "httpMethod": "POST",
- "description": "This method starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.",
- "parameters": {
- "instance": {
- "type": "string",
- "description": "Name of the instance resource to start.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "stop": {
- "id": "compute.instances.stop",
- "path": "{project}/zones/{zone}/instances/{instance}/stop",
- "httpMethod": "POST",
- "description": "This method stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses,will continue to be charged until they are deleted. For more information, see Stopping an instance.",
- "parameters": {
- "instance": {
- "type": "string",
- "description": "Name of the instance resource to stop.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "licenses": {
- "methods": {
- "get": {
- "id": "compute.licenses.get",
- "path": "{project}/global/licenses/{license}",
- "httpMethod": "GET",
- "description": "Returns the specified license resource.",
- "parameters": {
- "license": {
- "type": "string",
- "description": "Name of the license resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "license"
- ],
- "response": {
- "$ref": "License"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "machineTypes": {
- "methods": {
- "aggregatedList": {
- "id": "compute.machineTypes.aggregatedList",
- "path": "{project}/aggregated/machineTypes",
- "httpMethod": "GET",
- "description": "Retrieves the list of machine type resources grouped by scope.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "MachineTypeAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "get": {
- "id": "compute.machineTypes.get",
- "path": "{project}/zones/{zone}/machineTypes/{machineType}",
- "httpMethod": "GET",
- "description": "Returns the specified machine type resource.",
- "parameters": {
- "machineType": {
- "type": "string",
- "description": "Name of the machine type resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "machineType"
- ],
- "response": {
- "$ref": "MachineType"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "list": {
- "id": "compute.machineTypes.list",
- "path": "{project}/zones/{zone}/machineTypes",
- "httpMethod": "GET",
- "description": "Retrieves the list of machine type resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "response": {
- "$ref": "MachineTypeList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "networks": {
- "methods": {
- "delete": {
- "id": "compute.networks.delete",
- "path": "{project}/global/networks/{network}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified network resource.",
- "parameters": {
- "network": {
- "type": "string",
- "description": "Name of the network resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "network"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.networks.get",
- "path": "{project}/global/networks/{network}",
- "httpMethod": "GET",
- "description": "Returns the specified network resource.",
- "parameters": {
- "network": {
- "type": "string",
- "description": "Name of the network resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "network"
- ],
- "response": {
- "$ref": "Network"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.networks.insert",
- "path": "{project}/global/networks",
- "httpMethod": "POST",
- "description": "Creates a network resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "Network"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.networks.list",
- "path": "{project}/global/networks",
- "httpMethod": "GET",
- "description": "Retrieves the list of network resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "NetworkList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "projects": {
- "methods": {
- "get": {
- "id": "compute.projects.get",
- "path": "{project}",
- "httpMethod": "GET",
- "description": "Returns the specified project resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "Project"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "moveDisk": {
- "id": "compute.projects.moveDisk",
- "path": "{project}/moveDisk",
- "httpMethod": "POST",
- "description": "Moves a persistent disk from one zone to another.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "DiskMoveRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "moveInstance": {
- "id": "compute.projects.moveInstance",
- "path": "{project}/moveInstance",
- "httpMethod": "POST",
- "description": "Moves an instance and its attached persistent disks from one zone to another.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "InstanceMoveRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "setCommonInstanceMetadata": {
- "id": "compute.projects.setCommonInstanceMetadata",
- "path": "{project}/setCommonInstanceMetadata",
- "httpMethod": "POST",
- "description": "Sets metadata common to all instances within the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "Metadata"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "setUsageExportBucket": {
- "id": "compute.projects.setUsageExportBucket",
- "path": "{project}/setUsageExportBucket",
- "httpMethod": "POST",
- "description": "Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "UsageExportLocation"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/devstorage.full_control",
- "https://www.googleapis.com/auth/devstorage.read_only",
- "https://www.googleapis.com/auth/devstorage.read_write"
- ]
- }
- }
- },
- "regionOperations": {
- "methods": {
- "delete": {
- "id": "compute.regionOperations.delete",
- "path": "{project}/regions/{region}/operations/{operation}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified region-specific Operations resource.",
- "parameters": {
- "operation": {
- "type": "string",
- "description": "Name of the Operations resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "operation"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.regionOperations.get",
- "path": "{project}/regions/{region}/operations/{operation}",
- "httpMethod": "GET",
- "description": "Retrieves the specified region-specific Operations resource.",
- "parameters": {
- "operation": {
- "type": "string",
- "description": "Name of the Operations resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "operation"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "list": {
- "id": "compute.regionOperations.list",
- "path": "{project}/regions/{region}/operations",
- "httpMethod": "GET",
- "description": "Retrieves the list of Operation resources contained within the specified region.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "response": {
- "$ref": "OperationList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "regions": {
- "methods": {
- "get": {
- "id": "compute.regions.get",
- "path": "{project}/regions/{region}",
- "httpMethod": "GET",
- "description": "Returns the specified region resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "response": {
- "$ref": "Region"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "list": {
- "id": "compute.regions.list",
- "path": "{project}/regions",
- "httpMethod": "GET",
- "description": "Retrieves the list of region resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "RegionList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "routes": {
- "methods": {
- "delete": {
- "id": "compute.routes.delete",
- "path": "{project}/global/routes/{route}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified route resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "route": {
- "type": "string",
- "description": "Name of the route resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "route"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.routes.get",
- "path": "{project}/global/routes/{route}",
- "httpMethod": "GET",
- "description": "Returns the specified route resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "route": {
- "type": "string",
- "description": "Name of the route resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "route"
- ],
- "response": {
- "$ref": "Route"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.routes.insert",
- "path": "{project}/global/routes",
- "httpMethod": "POST",
- "description": "Creates a route resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "Route"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.routes.list",
- "path": "{project}/global/routes",
- "httpMethod": "GET",
- "description": "Retrieves the list of route resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "RouteList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "snapshots": {
- "methods": {
- "delete": {
- "id": "compute.snapshots.delete",
- "path": "{project}/global/snapshots/{snapshot}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.\n\nFor more information, see Deleting snaphots.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "snapshot": {
- "type": "string",
- "description": "Name of the Snapshot resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "snapshot"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.snapshots.get",
- "path": "{project}/global/snapshots/{snapshot}",
- "httpMethod": "GET",
- "description": "Returns the specified Snapshot resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "snapshot": {
- "type": "string",
- "description": "Name of the Snapshot resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "snapshot"
- ],
- "response": {
- "$ref": "Snapshot"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "list": {
- "id": "compute.snapshots.list",
- "path": "{project}/global/snapshots",
- "httpMethod": "GET",
- "description": "Retrieves the list of Snapshot resources contained within the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "SnapshotList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "sslCertificates": {
- "methods": {
- "delete": {
- "id": "compute.sslCertificates.delete",
- "path": "{project}/global/sslCertificates/{sslCertificate}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified SslCertificate resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "sslCertificate": {
- "type": "string",
- "description": "Name of the SslCertificate resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "sslCertificate"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.sslCertificates.get",
- "path": "{project}/global/sslCertificates/{sslCertificate}",
- "httpMethod": "GET",
- "description": "Returns the specified SslCertificate resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "sslCertificate": {
- "type": "string",
- "description": "Name of the SslCertificate resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "sslCertificate"
- ],
- "response": {
- "$ref": "SslCertificate"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.sslCertificates.insert",
- "path": "{project}/global/sslCertificates",
- "httpMethod": "POST",
- "description": "Creates a SslCertificate resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "SslCertificate"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.sslCertificates.list",
- "path": "{project}/global/sslCertificates",
- "httpMethod": "GET",
- "description": "Retrieves the list of SslCertificate resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "SslCertificateList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "targetHttpProxies": {
- "methods": {
- "delete": {
- "id": "compute.targetHttpProxies.delete",
- "path": "{project}/global/targetHttpProxies/{targetHttpProxy}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified TargetHttpProxy resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "targetHttpProxy": {
- "type": "string",
- "description": "Name of the TargetHttpProxy resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "targetHttpProxy"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.targetHttpProxies.get",
- "path": "{project}/global/targetHttpProxies/{targetHttpProxy}",
- "httpMethod": "GET",
- "description": "Returns the specified TargetHttpProxy resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "targetHttpProxy": {
- "type": "string",
- "description": "Name of the TargetHttpProxy resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "targetHttpProxy"
- ],
- "response": {
- "$ref": "TargetHttpProxy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.targetHttpProxies.insert",
- "path": "{project}/global/targetHttpProxies",
- "httpMethod": "POST",
- "description": "Creates a TargetHttpProxy resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "TargetHttpProxy"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.targetHttpProxies.list",
- "path": "{project}/global/targetHttpProxies",
- "httpMethod": "GET",
- "description": "Retrieves the list of TargetHttpProxy resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "TargetHttpProxyList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "setUrlMap": {
- "id": "compute.targetHttpProxies.setUrlMap",
- "path": "{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap",
- "httpMethod": "POST",
- "description": "Changes the URL map for TargetHttpProxy.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "targetHttpProxy": {
- "type": "string",
- "description": "Name of the TargetHttpProxy resource whose URL map is to be set.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "targetHttpProxy"
- ],
- "request": {
- "$ref": "UrlMapReference"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "targetHttpsProxies": {
- "methods": {
- "delete": {
- "id": "compute.targetHttpsProxies.delete",
- "path": "{project}/global/targetHttpsProxies/{targetHttpsProxy}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified TargetHttpsProxy resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "targetHttpsProxy": {
- "type": "string",
- "description": "Name of the TargetHttpsProxy resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "targetHttpsProxy"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.targetHttpsProxies.get",
- "path": "{project}/global/targetHttpsProxies/{targetHttpsProxy}",
- "httpMethod": "GET",
- "description": "Returns the specified TargetHttpsProxy resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "targetHttpsProxy": {
- "type": "string",
- "description": "Name of the TargetHttpsProxy resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "targetHttpsProxy"
- ],
- "response": {
- "$ref": "TargetHttpsProxy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.targetHttpsProxies.insert",
- "path": "{project}/global/targetHttpsProxies",
- "httpMethod": "POST",
- "description": "Creates a TargetHttpsProxy resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "TargetHttpsProxy"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.targetHttpsProxies.list",
- "path": "{project}/global/targetHttpsProxies",
- "httpMethod": "GET",
- "description": "Retrieves the list of TargetHttpsProxy resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "TargetHttpsProxyList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "setSslCertificates": {
- "id": "compute.targetHttpsProxies.setSslCertificates",
- "path": "{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates",
- "httpMethod": "POST",
- "description": "Replaces SslCertificates for TargetHttpsProxy.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "targetHttpsProxy": {
- "type": "string",
- "description": "Name of the TargetHttpsProxy resource whose URL map is to be set.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "targetHttpsProxy"
- ],
- "request": {
- "$ref": "TargetHttpsProxiesSetSslCertificatesRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "setUrlMap": {
- "id": "compute.targetHttpsProxies.setUrlMap",
- "path": "{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap",
- "httpMethod": "POST",
- "description": "Changes the URL map for TargetHttpsProxy.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "targetHttpsProxy": {
- "type": "string",
- "description": "Name of the TargetHttpsProxy resource whose URL map is to be set.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "targetHttpsProxy"
- ],
- "request": {
- "$ref": "UrlMapReference"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "targetInstances": {
- "methods": {
- "aggregatedList": {
- "id": "compute.targetInstances.aggregatedList",
- "path": "{project}/aggregated/targetInstances",
- "httpMethod": "GET",
- "description": "Retrieves the list of target instances grouped by scope.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "TargetInstanceAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "delete": {
- "id": "compute.targetInstances.delete",
- "path": "{project}/zones/{zone}/targetInstances/{targetInstance}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified TargetInstance resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "targetInstance": {
- "type": "string",
- "description": "Name of the TargetInstance resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "targetInstance"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.targetInstances.get",
- "path": "{project}/zones/{zone}/targetInstances/{targetInstance}",
- "httpMethod": "GET",
- "description": "Returns the specified TargetInstance resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "targetInstance": {
- "type": "string",
- "description": "Name of the TargetInstance resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "targetInstance"
- ],
- "response": {
- "$ref": "TargetInstance"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.targetInstances.insert",
- "path": "{project}/zones/{zone}/targetInstances",
- "httpMethod": "POST",
- "description": "Creates a TargetInstance resource in the specified project and zone using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "request": {
- "$ref": "TargetInstance"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.targetInstances.list",
- "path": "{project}/zones/{zone}/targetInstances",
- "httpMethod": "GET",
- "description": "Retrieves the list of TargetInstance resources available to the specified project and zone.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "response": {
- "$ref": "TargetInstanceList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "targetPools": {
- "methods": {
- "addHealthCheck": {
- "id": "compute.targetPools.addHealthCheck",
- "path": "{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck",
- "httpMethod": "POST",
- "description": "Adds health check URL to targetPool.",
- "parameters": {
- "project": {
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "targetPool": {
- "type": "string",
- "description": "Name of the TargetPool resource to which health_check_url is to be added.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "targetPool"
- ],
- "request": {
- "$ref": "TargetPoolsAddHealthCheckRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "addInstance": {
- "id": "compute.targetPools.addInstance",
- "path": "{project}/regions/{region}/targetPools/{targetPool}/addInstance",
- "httpMethod": "POST",
- "description": "Adds instance url to targetPool.",
- "parameters": {
- "project": {
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "targetPool": {
- "type": "string",
- "description": "Name of the TargetPool resource to which instance_url is to be added.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "targetPool"
- ],
- "request": {
- "$ref": "TargetPoolsAddInstanceRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "aggregatedList": {
- "id": "compute.targetPools.aggregatedList",
- "path": "{project}/aggregated/targetPools",
- "httpMethod": "GET",
- "description": "Retrieves the list of target pools grouped by scope.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "TargetPoolAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "delete": {
- "id": "compute.targetPools.delete",
- "path": "{project}/regions/{region}/targetPools/{targetPool}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified TargetPool resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "targetPool": {
- "type": "string",
- "description": "Name of the TargetPool resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "targetPool"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.targetPools.get",
- "path": "{project}/regions/{region}/targetPools/{targetPool}",
- "httpMethod": "GET",
- "description": "Returns the specified TargetPool resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "targetPool": {
- "type": "string",
- "description": "Name of the TargetPool resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "targetPool"
- ],
- "response": {
- "$ref": "TargetPool"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "getHealth": {
- "id": "compute.targetPools.getHealth",
- "path": "{project}/regions/{region}/targetPools/{targetPool}/getHealth",
- "httpMethod": "POST",
- "description": "Gets the most recent health check results for each IP for the given instance that is referenced by given TargetPool.",
- "parameters": {
- "project": {
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "targetPool": {
- "type": "string",
- "description": "Name of the TargetPool resource to which the queried instance belongs.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "targetPool"
- ],
- "request": {
- "$ref": "InstanceReference"
- },
- "response": {
- "$ref": "TargetPoolInstanceHealth"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.targetPools.insert",
- "path": "{project}/regions/{region}/targetPools",
- "httpMethod": "POST",
- "description": "Creates a TargetPool resource in the specified project and region using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "request": {
- "$ref": "TargetPool"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.targetPools.list",
- "path": "{project}/regions/{region}/targetPools",
- "httpMethod": "GET",
- "description": "Retrieves the list of TargetPool resources available to the specified project and region.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "response": {
- "$ref": "TargetPoolList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "removeHealthCheck": {
- "id": "compute.targetPools.removeHealthCheck",
- "path": "{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck",
- "httpMethod": "POST",
- "description": "Removes health check URL from targetPool.",
- "parameters": {
- "project": {
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "targetPool": {
- "type": "string",
- "description": "Name of the TargetPool resource to which health_check_url is to be removed.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "targetPool"
- ],
- "request": {
- "$ref": "TargetPoolsRemoveHealthCheckRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "removeInstance": {
- "id": "compute.targetPools.removeInstance",
- "path": "{project}/regions/{region}/targetPools/{targetPool}/removeInstance",
- "httpMethod": "POST",
- "description": "Removes instance URL from targetPool.",
- "parameters": {
- "project": {
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "targetPool": {
- "type": "string",
- "description": "Name of the TargetPool resource to which instance_url is to be removed.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "targetPool"
- ],
- "request": {
- "$ref": "TargetPoolsRemoveInstanceRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "setBackup": {
- "id": "compute.targetPools.setBackup",
- "path": "{project}/regions/{region}/targetPools/{targetPool}/setBackup",
- "httpMethod": "POST",
- "description": "Changes backup pool configurations.",
- "parameters": {
- "failoverRatio": {
- "type": "number",
- "description": "New failoverRatio value for the containing target pool.",
- "format": "float",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "targetPool": {
- "type": "string",
- "description": "Name of the TargetPool resource for which the backup is to be set.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "targetPool"
- ],
- "request": {
- "$ref": "TargetReference"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "targetVpnGateways": {
- "methods": {
- "aggregatedList": {
- "id": "compute.targetVpnGateways.aggregatedList",
- "path": "{project}/aggregated/targetVpnGateways",
- "httpMethod": "GET",
- "description": "Retrieves the list of target VPN gateways grouped by scope.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "TargetVpnGatewayAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "delete": {
- "id": "compute.targetVpnGateways.delete",
- "path": "{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified TargetVpnGateway resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "The name of the region for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "targetVpnGateway": {
- "type": "string",
- "description": "Name of the TargetVpnGateway resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "targetVpnGateway"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.targetVpnGateways.get",
- "path": "{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}",
- "httpMethod": "GET",
- "description": "Returns the specified TargetVpnGateway resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "The name of the region for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "targetVpnGateway": {
- "type": "string",
- "description": "Name of the TargetVpnGateway resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "targetVpnGateway"
- ],
- "response": {
- "$ref": "TargetVpnGateway"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.targetVpnGateways.insert",
- "path": "{project}/regions/{region}/targetVpnGateways",
- "httpMethod": "POST",
- "description": "Creates a TargetVpnGateway resource in the specified project and region using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "The name of the region for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "request": {
- "$ref": "TargetVpnGateway"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.targetVpnGateways.list",
- "path": "{project}/regions/{region}/targetVpnGateways",
- "httpMethod": "GET",
- "description": "Retrieves the list of TargetVpnGateway resources available to the specified project and region.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "The name of the region for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "response": {
- "$ref": "TargetVpnGatewayList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "urlMaps": {
- "methods": {
- "delete": {
- "id": "compute.urlMaps.delete",
- "path": "{project}/global/urlMaps/{urlMap}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified UrlMap resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "urlMap": {
- "type": "string",
- "description": "Name of the UrlMap resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "urlMap"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.urlMaps.get",
- "path": "{project}/global/urlMaps/{urlMap}",
- "httpMethod": "GET",
- "description": "Returns the specified UrlMap resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "urlMap": {
- "type": "string",
- "description": "Name of the UrlMap resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "urlMap"
- ],
- "response": {
- "$ref": "UrlMap"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.urlMaps.insert",
- "path": "{project}/global/urlMaps",
- "httpMethod": "POST",
- "description": "Creates a UrlMap resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "UrlMap"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.urlMaps.list",
- "path": "{project}/global/urlMaps",
- "httpMethod": "GET",
- "description": "Retrieves the list of UrlMap resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "UrlMapList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "patch": {
- "id": "compute.urlMaps.patch",
- "path": "{project}/global/urlMaps/{urlMap}",
- "httpMethod": "PATCH",
- "description": "Update the entire content of the UrlMap resource. This method supports patch semantics.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "urlMap": {
- "type": "string",
- "description": "Name of the UrlMap resource to update.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "urlMap"
- ],
- "request": {
- "$ref": "UrlMap"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "update": {
- "id": "compute.urlMaps.update",
- "path": "{project}/global/urlMaps/{urlMap}",
- "httpMethod": "PUT",
- "description": "Update the entire content of the UrlMap resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "urlMap": {
- "type": "string",
- "description": "Name of the UrlMap resource to update.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "urlMap"
- ],
- "request": {
- "$ref": "UrlMap"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "validate": {
- "id": "compute.urlMaps.validate",
- "path": "{project}/global/urlMaps/{urlMap}/validate",
- "httpMethod": "POST",
- "description": "Run static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "urlMap": {
- "type": "string",
- "description": "Name of the UrlMap resource to be validated as.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "urlMap"
- ],
- "request": {
- "$ref": "UrlMapsValidateRequest"
- },
- "response": {
- "$ref": "UrlMapsValidateResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "vpnTunnels": {
- "methods": {
- "aggregatedList": {
- "id": "compute.vpnTunnels.aggregatedList",
- "path": "{project}/aggregated/vpnTunnels",
- "httpMethod": "GET",
- "description": "Retrieves the list of VPN tunnels grouped by scope.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "VpnTunnelAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "delete": {
- "id": "compute.vpnTunnels.delete",
- "path": "{project}/regions/{region}/vpnTunnels/{vpnTunnel}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified VpnTunnel resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "The name of the region for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "vpnTunnel": {
- "type": "string",
- "description": "Name of the VpnTunnel resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "vpnTunnel"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.vpnTunnels.get",
- "path": "{project}/regions/{region}/vpnTunnels/{vpnTunnel}",
- "httpMethod": "GET",
- "description": "Returns the specified VpnTunnel resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "The name of the region for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "vpnTunnel": {
- "type": "string",
- "description": "Name of the VpnTunnel resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "vpnTunnel"
- ],
- "response": {
- "$ref": "VpnTunnel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "id": "compute.vpnTunnels.insert",
- "path": "{project}/regions/{region}/vpnTunnels",
- "httpMethod": "POST",
- "description": "Creates a VpnTunnel resource in the specified project and region using the data included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "The name of the region for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "request": {
- "$ref": "VpnTunnel"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "list": {
- "id": "compute.vpnTunnels.list",
- "path": "{project}/regions/{region}/vpnTunnels",
- "httpMethod": "GET",
- "description": "Retrieves the list of VpnTunnel resources contained in the specified project and region.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "type": "string",
- "description": "The name of the region for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "response": {
- "$ref": "VpnTunnelList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "zoneOperations": {
- "methods": {
- "delete": {
- "id": "compute.zoneOperations.delete",
- "path": "{project}/zones/{zone}/operations/{operation}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified zone-specific Operations resource.",
- "parameters": {
- "operation": {
- "type": "string",
- "description": "Name of the Operations resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "operation"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "id": "compute.zoneOperations.get",
- "path": "{project}/zones/{zone}/operations/{operation}",
- "httpMethod": "GET",
- "description": "Retrieves the specified zone-specific Operations resource.",
- "parameters": {
- "operation": {
- "type": "string",
- "description": "Name of the Operations resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "operation"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "list": {
- "id": "compute.zoneOperations.list",
- "path": "{project}/zones/{zone}/operations",
- "httpMethod": "GET",
- "description": "Retrieves the list of Operation resources contained within the specified zone.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "response": {
- "$ref": "OperationList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- },
- "zones": {
- "methods": {
- "get": {
- "id": "compute.zones.get",
- "path": "{project}/zones/{zone}",
- "httpMethod": "GET",
- "description": "Returns the specified zone resource.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "response": {
- "$ref": "Zone"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "list": {
- "id": "compute.zones.list",
- "path": "{project}/zones",
- "httpMethod": "GET",
- "description": "Retrieves the list of zone resources available to the specified project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "ZoneList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/compute/v1/compute-gen.go b/vendor/google.golang.org/api/compute/v1/compute-gen.go
deleted file mode 100644
index 55e1fdfe..00000000
--- a/vendor/google.golang.org/api/compute/v1/compute-gen.go
+++ /dev/null
@@ -1,37418 +0,0 @@
-// Package compute provides access to the Compute Engine API.
-//
-// See https://developers.google.com/compute/docs/reference/latest/
-//
-// Usage example:
-//
-// import "google.golang.org/api/compute/v1"
-// ...
-// computeService, err := compute.New(oauthHttpClient)
-package compute // import "google.golang.org/api/compute/v1"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "compute:v1"
-const apiName = "compute"
-const apiVersion = "v1"
-const basePath = "https://www.googleapis.com/compute/v1/projects/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your data across Google Cloud Platform services
- CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
-
- // View and manage your Google Compute Engine resources
- ComputeScope = "https://www.googleapis.com/auth/compute"
-
- // View your Google Compute Engine resources
- ComputeReadonlyScope = "https://www.googleapis.com/auth/compute.readonly"
-
- // Manage your data and permissions in Google Cloud Storage
- DevstorageFullControlScope = "https://www.googleapis.com/auth/devstorage.full_control"
-
- // View your data in Google Cloud Storage
- DevstorageReadOnlyScope = "https://www.googleapis.com/auth/devstorage.read_only"
-
- // Manage your data in Google Cloud Storage
- DevstorageReadWriteScope = "https://www.googleapis.com/auth/devstorage.read_write"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Addresses = NewAddressesService(s)
- s.Autoscalers = NewAutoscalersService(s)
- s.BackendServices = NewBackendServicesService(s)
- s.DiskTypes = NewDiskTypesService(s)
- s.Disks = NewDisksService(s)
- s.Firewalls = NewFirewallsService(s)
- s.ForwardingRules = NewForwardingRulesService(s)
- s.GlobalAddresses = NewGlobalAddressesService(s)
- s.GlobalForwardingRules = NewGlobalForwardingRulesService(s)
- s.GlobalOperations = NewGlobalOperationsService(s)
- s.HttpHealthChecks = NewHttpHealthChecksService(s)
- s.HttpsHealthChecks = NewHttpsHealthChecksService(s)
- s.Images = NewImagesService(s)
- s.InstanceGroupManagers = NewInstanceGroupManagersService(s)
- s.InstanceGroups = NewInstanceGroupsService(s)
- s.InstanceTemplates = NewInstanceTemplatesService(s)
- s.Instances = NewInstancesService(s)
- s.Licenses = NewLicensesService(s)
- s.MachineTypes = NewMachineTypesService(s)
- s.Networks = NewNetworksService(s)
- s.Projects = NewProjectsService(s)
- s.RegionOperations = NewRegionOperationsService(s)
- s.Regions = NewRegionsService(s)
- s.Routes = NewRoutesService(s)
- s.Snapshots = NewSnapshotsService(s)
- s.SslCertificates = NewSslCertificatesService(s)
- s.TargetHttpProxies = NewTargetHttpProxiesService(s)
- s.TargetHttpsProxies = NewTargetHttpsProxiesService(s)
- s.TargetInstances = NewTargetInstancesService(s)
- s.TargetPools = NewTargetPoolsService(s)
- s.TargetVpnGateways = NewTargetVpnGatewaysService(s)
- s.UrlMaps = NewUrlMapsService(s)
- s.VpnTunnels = NewVpnTunnelsService(s)
- s.ZoneOperations = NewZoneOperationsService(s)
- s.Zones = NewZonesService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Addresses *AddressesService
-
- Autoscalers *AutoscalersService
-
- BackendServices *BackendServicesService
-
- DiskTypes *DiskTypesService
-
- Disks *DisksService
-
- Firewalls *FirewallsService
-
- ForwardingRules *ForwardingRulesService
-
- GlobalAddresses *GlobalAddressesService
-
- GlobalForwardingRules *GlobalForwardingRulesService
-
- GlobalOperations *GlobalOperationsService
-
- HttpHealthChecks *HttpHealthChecksService
-
- HttpsHealthChecks *HttpsHealthChecksService
-
- Images *ImagesService
-
- InstanceGroupManagers *InstanceGroupManagersService
-
- InstanceGroups *InstanceGroupsService
-
- InstanceTemplates *InstanceTemplatesService
-
- Instances *InstancesService
-
- Licenses *LicensesService
-
- MachineTypes *MachineTypesService
-
- Networks *NetworksService
-
- Projects *ProjectsService
-
- RegionOperations *RegionOperationsService
-
- Regions *RegionsService
-
- Routes *RoutesService
-
- Snapshots *SnapshotsService
-
- SslCertificates *SslCertificatesService
-
- TargetHttpProxies *TargetHttpProxiesService
-
- TargetHttpsProxies *TargetHttpsProxiesService
-
- TargetInstances *TargetInstancesService
-
- TargetPools *TargetPoolsService
-
- TargetVpnGateways *TargetVpnGatewaysService
-
- UrlMaps *UrlMapsService
-
- VpnTunnels *VpnTunnelsService
-
- ZoneOperations *ZoneOperationsService
-
- Zones *ZonesService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewAddressesService(s *Service) *AddressesService {
- rs := &AddressesService{s: s}
- return rs
-}
-
-type AddressesService struct {
- s *Service
-}
-
-func NewAutoscalersService(s *Service) *AutoscalersService {
- rs := &AutoscalersService{s: s}
- return rs
-}
-
-type AutoscalersService struct {
- s *Service
-}
-
-func NewBackendServicesService(s *Service) *BackendServicesService {
- rs := &BackendServicesService{s: s}
- return rs
-}
-
-type BackendServicesService struct {
- s *Service
-}
-
-func NewDiskTypesService(s *Service) *DiskTypesService {
- rs := &DiskTypesService{s: s}
- return rs
-}
-
-type DiskTypesService struct {
- s *Service
-}
-
-func NewDisksService(s *Service) *DisksService {
- rs := &DisksService{s: s}
- return rs
-}
-
-type DisksService struct {
- s *Service
-}
-
-func NewFirewallsService(s *Service) *FirewallsService {
- rs := &FirewallsService{s: s}
- return rs
-}
-
-type FirewallsService struct {
- s *Service
-}
-
-func NewForwardingRulesService(s *Service) *ForwardingRulesService {
- rs := &ForwardingRulesService{s: s}
- return rs
-}
-
-type ForwardingRulesService struct {
- s *Service
-}
-
-func NewGlobalAddressesService(s *Service) *GlobalAddressesService {
- rs := &GlobalAddressesService{s: s}
- return rs
-}
-
-type GlobalAddressesService struct {
- s *Service
-}
-
-func NewGlobalForwardingRulesService(s *Service) *GlobalForwardingRulesService {
- rs := &GlobalForwardingRulesService{s: s}
- return rs
-}
-
-type GlobalForwardingRulesService struct {
- s *Service
-}
-
-func NewGlobalOperationsService(s *Service) *GlobalOperationsService {
- rs := &GlobalOperationsService{s: s}
- return rs
-}
-
-type GlobalOperationsService struct {
- s *Service
-}
-
-func NewHttpHealthChecksService(s *Service) *HttpHealthChecksService {
- rs := &HttpHealthChecksService{s: s}
- return rs
-}
-
-type HttpHealthChecksService struct {
- s *Service
-}
-
-func NewHttpsHealthChecksService(s *Service) *HttpsHealthChecksService {
- rs := &HttpsHealthChecksService{s: s}
- return rs
-}
-
-type HttpsHealthChecksService struct {
- s *Service
-}
-
-func NewImagesService(s *Service) *ImagesService {
- rs := &ImagesService{s: s}
- return rs
-}
-
-type ImagesService struct {
- s *Service
-}
-
-func NewInstanceGroupManagersService(s *Service) *InstanceGroupManagersService {
- rs := &InstanceGroupManagersService{s: s}
- return rs
-}
-
-type InstanceGroupManagersService struct {
- s *Service
-}
-
-func NewInstanceGroupsService(s *Service) *InstanceGroupsService {
- rs := &InstanceGroupsService{s: s}
- return rs
-}
-
-type InstanceGroupsService struct {
- s *Service
-}
-
-func NewInstanceTemplatesService(s *Service) *InstanceTemplatesService {
- rs := &InstanceTemplatesService{s: s}
- return rs
-}
-
-type InstanceTemplatesService struct {
- s *Service
-}
-
-func NewInstancesService(s *Service) *InstancesService {
- rs := &InstancesService{s: s}
- return rs
-}
-
-type InstancesService struct {
- s *Service
-}
-
-func NewLicensesService(s *Service) *LicensesService {
- rs := &LicensesService{s: s}
- return rs
-}
-
-type LicensesService struct {
- s *Service
-}
-
-func NewMachineTypesService(s *Service) *MachineTypesService {
- rs := &MachineTypesService{s: s}
- return rs
-}
-
-type MachineTypesService struct {
- s *Service
-}
-
-func NewNetworksService(s *Service) *NetworksService {
- rs := &NetworksService{s: s}
- return rs
-}
-
-type NetworksService struct {
- s *Service
-}
-
-func NewProjectsService(s *Service) *ProjectsService {
- rs := &ProjectsService{s: s}
- return rs
-}
-
-type ProjectsService struct {
- s *Service
-}
-
-func NewRegionOperationsService(s *Service) *RegionOperationsService {
- rs := &RegionOperationsService{s: s}
- return rs
-}
-
-type RegionOperationsService struct {
- s *Service
-}
-
-func NewRegionsService(s *Service) *RegionsService {
- rs := &RegionsService{s: s}
- return rs
-}
-
-type RegionsService struct {
- s *Service
-}
-
-func NewRoutesService(s *Service) *RoutesService {
- rs := &RoutesService{s: s}
- return rs
-}
-
-type RoutesService struct {
- s *Service
-}
-
-func NewSnapshotsService(s *Service) *SnapshotsService {
- rs := &SnapshotsService{s: s}
- return rs
-}
-
-type SnapshotsService struct {
- s *Service
-}
-
-func NewSslCertificatesService(s *Service) *SslCertificatesService {
- rs := &SslCertificatesService{s: s}
- return rs
-}
-
-type SslCertificatesService struct {
- s *Service
-}
-
-func NewTargetHttpProxiesService(s *Service) *TargetHttpProxiesService {
- rs := &TargetHttpProxiesService{s: s}
- return rs
-}
-
-type TargetHttpProxiesService struct {
- s *Service
-}
-
-func NewTargetHttpsProxiesService(s *Service) *TargetHttpsProxiesService {
- rs := &TargetHttpsProxiesService{s: s}
- return rs
-}
-
-type TargetHttpsProxiesService struct {
- s *Service
-}
-
-func NewTargetInstancesService(s *Service) *TargetInstancesService {
- rs := &TargetInstancesService{s: s}
- return rs
-}
-
-type TargetInstancesService struct {
- s *Service
-}
-
-func NewTargetPoolsService(s *Service) *TargetPoolsService {
- rs := &TargetPoolsService{s: s}
- return rs
-}
-
-type TargetPoolsService struct {
- s *Service
-}
-
-func NewTargetVpnGatewaysService(s *Service) *TargetVpnGatewaysService {
- rs := &TargetVpnGatewaysService{s: s}
- return rs
-}
-
-type TargetVpnGatewaysService struct {
- s *Service
-}
-
-func NewUrlMapsService(s *Service) *UrlMapsService {
- rs := &UrlMapsService{s: s}
- return rs
-}
-
-type UrlMapsService struct {
- s *Service
-}
-
-func NewVpnTunnelsService(s *Service) *VpnTunnelsService {
- rs := &VpnTunnelsService{s: s}
- return rs
-}
-
-type VpnTunnelsService struct {
- s *Service
-}
-
-func NewZoneOperationsService(s *Service) *ZoneOperationsService {
- rs := &ZoneOperationsService{s: s}
- return rs
-}
-
-type ZoneOperationsService struct {
- s *Service
-}
-
-func NewZonesService(s *Service) *ZonesService {
- rs := &ZonesService{s: s}
- return rs
-}
-
-type ZonesService struct {
- s *Service
-}
-
-// AccessConfig: An access configuration attached to an instance's
-// network interface.
-type AccessConfig struct {
- // Kind: [Output Only] Type of the resource. Always compute#accessConfig
- // for access configs.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this access configuration.
- Name string `json:"name,omitempty"`
-
- // NatIP: An external IP address associated with this instance. Specify
- // an unused static external IP address available to the project or
- // leave this field undefined to use an IP from a shared ephemeral IP
- // address pool. If you specify a static external IP address, it must
- // live in the same region as the zone of the instance.
- NatIP string `json:"natIP,omitempty"`
-
- // Type: The type of configuration. The default and only option is
- // ONE_TO_ONE_NAT.
- //
- // Possible values:
- // "ONE_TO_ONE_NAT" (default)
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccessConfig) MarshalJSON() ([]byte, error) {
- type noMethod AccessConfig
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Address: A reserved address resource.
-type Address struct {
- // Address: The static external IP address represented by this resource.
- Address string `json:"address,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always compute#address for
- // addresses.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // Region: [Output Only] URL of the region where the regional address
- // resides. This field is not applicable to global addresses.
- Region string `json:"region,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Status: [Output Only] The status of the address, which can be either
- // IN_USE or RESERVED. An address that is RESERVED is currently reserved
- // and available to use. An IN_USE address is currently being used by
- // another resource and is not available.
- //
- // Possible values:
- // "IN_USE"
- // "RESERVED"
- Status string `json:"status,omitempty"`
-
- // Users: [Output Only] The URLs of the resources that are using this
- // address.
- Users []string `json:"users,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Address") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Address) MarshalJSON() ([]byte, error) {
- type noMethod Address
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AddressAggregatedList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A map of scoped address lists.
- Items map[string]AddressesScopedList `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always
- // compute#addressAggregatedList for aggregated lists of addresses.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AddressAggregatedList) MarshalJSON() ([]byte, error) {
- type noMethod AddressAggregatedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AddressList: Contains a list of address resources.
-type AddressList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of Address resources.
- Items []*Address `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#addressList for
- // lists of addresses.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AddressList) MarshalJSON() ([]byte, error) {
- type noMethod AddressList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AddressesScopedList struct {
- // Addresses: [Output Only] List of addresses contained in this scope.
- Addresses []*Address `json:"addresses,omitempty"`
-
- // Warning: [Output Only] Informational warning which replaces the list
- // of addresses when the list is empty.
- Warning *AddressesScopedListWarning `json:"warning,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Addresses") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AddressesScopedList) MarshalJSON() ([]byte, error) {
- type noMethod AddressesScopedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AddressesScopedListWarning: [Output Only] Informational warning which
-// replaces the list of addresses when the list is empty.
-type AddressesScopedListWarning struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*AddressesScopedListWarningData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AddressesScopedListWarning) MarshalJSON() ([]byte, error) {
- type noMethod AddressesScopedListWarning
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AddressesScopedListWarningData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AddressesScopedListWarningData) MarshalJSON() ([]byte, error) {
- type noMethod AddressesScopedListWarningData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AttachedDisk: An instance-attached disk resource.
-type AttachedDisk struct {
- // AutoDelete: Specifies whether the disk will be auto-deleted when the
- // instance is deleted (but not when the disk is detached from the
- // instance).
- AutoDelete bool `json:"autoDelete,omitempty"`
-
- // Boot: Indicates that this is a boot disk. The virtual machine will
- // use the first partition of the disk for its root filesystem.
- Boot bool `json:"boot,omitempty"`
-
- // DeviceName: Specifies a unique device name of your choice that is
- // reflected into the /dev/disk/by-id/google-* tree of a Linux operating
- // system running within the instance. This name can be used to
- // reference the device for mounting, resizing, and so on, from within
- // the instance.
- //
- // If not specified, the server chooses a default device name to apply
- // to this disk, in the form persistent-disks-x, where x is a number
- // assigned by Google Compute Engine. This field is only applicable for
- // persistent disks.
- DeviceName string `json:"deviceName,omitempty"`
-
- // Index: Assigns a zero-based index to this disk, where 0 is reserved
- // for the boot disk. For example, if you have many disks attached to an
- // instance, each disk would have a unique index number. If not
- // specified, the server will choose an appropriate value.
- Index int64 `json:"index,omitempty"`
-
- // InitializeParams: [Input Only] Specifies the parameters for a new
- // disk that will be created alongside the new instance. Use
- // initialization parameters to create boot disks or local SSDs attached
- // to the new instance.
- //
- // This property is mutually exclusive with the source property; you can
- // only define one or the other, but not both.
- InitializeParams *AttachedDiskInitializeParams `json:"initializeParams,omitempty"`
-
- // Interface: Specifies the disk interface to use for attaching this
- // disk, either SCSI or NVME. The default is SCSI. For performance
- // characteristics of SCSI over NVMe, see Local SSD performance.
- //
- // Possible values:
- // "NVME"
- // "SCSI"
- Interface string `json:"interface,omitempty"`
-
- // Kind: [Output Only] Type of the resource. Always compute#attachedDisk
- // for attached disks.
- Kind string `json:"kind,omitempty"`
-
- // Licenses: [Output Only] Any valid publicly visible licenses.
- Licenses []string `json:"licenses,omitempty"`
-
- // Mode: The mode in which to attach this disk, either READ_WRITE or
- // READ_ONLY. If not specified, the default is to attach the disk in
- // READ_WRITE mode.
- //
- // Possible values:
- // "READ_ONLY"
- // "READ_WRITE"
- Mode string `json:"mode,omitempty"`
-
- // Source: Specifies a valid partial or full URL to an existing
- // Persistent Disk resource. This field is only applicable for
- // persistent disks.
- Source string `json:"source,omitempty"`
-
- // Type: Specifies the type of the disk, either SCRATCH or PERSISTENT.
- // If not specified, the default is PERSISTENT.
- //
- // Possible values:
- // "PERSISTENT"
- // "SCRATCH"
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AutoDelete") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AttachedDisk) MarshalJSON() ([]byte, error) {
- type noMethod AttachedDisk
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AttachedDiskInitializeParams: [Input Only] Specifies the parameters
-// for a new disk that will be created alongside the new instance. Use
-// initialization parameters to create boot disks or local SSDs attached
-// to the new instance.
-//
-// This property is mutually exclusive with the source property; you can
-// only define one or the other, but not both.
-type AttachedDiskInitializeParams struct {
- // DiskName: Specifies the disk name. If not specified, the default is
- // to use the name of the instance.
- DiskName string `json:"diskName,omitempty"`
-
- // DiskSizeGb: Specifies the size of the disk in base-2 GB.
- DiskSizeGb int64 `json:"diskSizeGb,omitempty,string"`
-
- // DiskType: Specifies the disk type to use to create the instance. If
- // not specified, the default is pd-standard, specified using the full
- // URL. For
- // example:
- //
- // https://www.googleapis.com/compute/v1/projects/project/zones
- // /zone/diskTypes/pd-standard
- //
- // Other values include pd-ssd and local-ssd. If you define this field,
- // you can provide either the full or partial URL. For example, the
- // following are valid values:
- // -
- // https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
- // - projects/project/zones/zone/diskTypes/diskType
- // - zones/zone/diskTypes/diskType
- DiskType string `json:"diskType,omitempty"`
-
- // SourceImage: A source image used to create the disk. You can provide
- // a private (custom) image, and Compute Engine will use the
- // corresponding image from your project. For
- // example:
- //
- // global/images/my-private-image
- //
- // Or you can provide an image from a publicly-available project. For
- // example, to use a Debian image from the debian-cloud project, make
- // sure to include the project in the
- // URL:
- //
- // projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
- //
- // where vYYYYMMDD is the image version. The fully-qualified URL will
- // also work in both cases.
- SourceImage string `json:"sourceImage,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DiskName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AttachedDiskInitializeParams) MarshalJSON() ([]byte, error) {
- type noMethod AttachedDiskInitializeParams
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Autoscaler struct {
- // AutoscalingPolicy: Autoscaling configuration.
- AutoscalingPolicy *AutoscalingPolicy `json:"autoscalingPolicy,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: Type of the resource.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource. Provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Target: URL of Instance Group Manager or Replica Pool which will be
- // controlled by Autoscaler.
- Target string `json:"target,omitempty"`
-
- // Zone: [Output Only] URL of the zone where the instance group resides.
- Zone string `json:"zone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AutoscalingPolicy")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Autoscaler) MarshalJSON() ([]byte, error) {
- type noMethod Autoscaler
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AutoscalerAggregatedList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A map of scoped autoscaler lists.
- Items map[string]AutoscalersScopedList `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AutoscalerAggregatedList) MarshalJSON() ([]byte, error) {
- type noMethod AutoscalerAggregatedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AutoscalerList: Contains a list of persistent autoscaler resources.
-type AutoscalerList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A list of Autoscaler resources.
- Items []*Autoscaler `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AutoscalerList) MarshalJSON() ([]byte, error) {
- type noMethod AutoscalerList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AutoscalersScopedList struct {
- // Autoscalers: List of autoscalers contained in this scope.
- Autoscalers []*Autoscaler `json:"autoscalers,omitempty"`
-
- // Warning: Informational warning which replaces the list of autoscalers
- // when the list is empty.
- Warning *AutoscalersScopedListWarning `json:"warning,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Autoscalers") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AutoscalersScopedList) MarshalJSON() ([]byte, error) {
- type noMethod AutoscalersScopedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AutoscalersScopedListWarning: Informational warning which replaces
-// the list of autoscalers when the list is empty.
-type AutoscalersScopedListWarning struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*AutoscalersScopedListWarningData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AutoscalersScopedListWarning) MarshalJSON() ([]byte, error) {
- type noMethod AutoscalersScopedListWarning
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AutoscalersScopedListWarningData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AutoscalersScopedListWarningData) MarshalJSON() ([]byte, error) {
- type noMethod AutoscalersScopedListWarningData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AutoscalingPolicy: Cloud Autoscaler policy.
-type AutoscalingPolicy struct {
- // CoolDownPeriodSec: The number of seconds that the Autoscaler should
- // wait between two succeeding changes to the number of virtual
- // machines. You should define an interval that is at least as long as
- // the initialization time of a virtual machine and the time it may take
- // for replica pool to create the virtual machine. The default is 60
- // seconds.
- CoolDownPeriodSec int64 `json:"coolDownPeriodSec,omitempty"`
-
- // CpuUtilization: TODO(jbartosik): Add support for scaling based on
- // muliple utilization metrics (take max recommendation). Exactly one
- // utilization policy should be provided. Configuration parameters of
- // CPU based autoscaling policy.
- CpuUtilization *AutoscalingPolicyCpuUtilization `json:"cpuUtilization,omitempty"`
-
- // CustomMetricUtilizations: Configuration parameters of autoscaling
- // based on custom metric.
- CustomMetricUtilizations []*AutoscalingPolicyCustomMetricUtilization `json:"customMetricUtilizations,omitempty"`
-
- // LoadBalancingUtilization: Configuration parameters of autoscaling
- // based on load balancer.
- LoadBalancingUtilization *AutoscalingPolicyLoadBalancingUtilization `json:"loadBalancingUtilization,omitempty"`
-
- // MaxNumReplicas: The maximum number of replicas that the Autoscaler
- // can scale up to. This field is required for config to be effective.
- // Maximum number of replicas should be not lower than minimal number of
- // replicas. Absolute limit for this value is defined in Autoscaler
- // backend.
- MaxNumReplicas int64 `json:"maxNumReplicas,omitempty"`
-
- // MinNumReplicas: The minimum number of replicas that the Autoscaler
- // can scale down to. Can't be less than 0. If not provided Autoscaler
- // will choose default value depending on maximal number of replicas.
- MinNumReplicas int64 `json:"minNumReplicas,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CoolDownPeriodSec")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AutoscalingPolicy) MarshalJSON() ([]byte, error) {
- type noMethod AutoscalingPolicy
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AutoscalingPolicyCpuUtilization: CPU utilization policy.
-type AutoscalingPolicyCpuUtilization struct {
- // UtilizationTarget: The target utilization that the Autoscaler should
- // maintain. It is represented as a fraction of used cores. For example:
- // 6 cores used in 8-core VM are represented here as 0.75. Must be a
- // float value between (0, 1]. If not defined, the default is 0.8.
- UtilizationTarget float64 `json:"utilizationTarget,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "UtilizationTarget")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AutoscalingPolicyCpuUtilization) MarshalJSON() ([]byte, error) {
- type noMethod AutoscalingPolicyCpuUtilization
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AutoscalingPolicyCustomMetricUtilization: Custom utilization metric
-// policy.
-type AutoscalingPolicyCustomMetricUtilization struct {
- // Metric: Identifier of the metric. It should be a Cloud Monitoring
- // metric. The metric can not have negative values. The metric should be
- // an utilization metric (increasing number of VMs handling requests x
- // times should reduce average value of the metric roughly x times). For
- // example you could use:
- // compute.googleapis.com/instance/network/received_bytes_count.
- Metric string `json:"metric,omitempty"`
-
- // UtilizationTarget: Target value of the metric which Autoscaler should
- // maintain. Must be a positive value.
- UtilizationTarget float64 `json:"utilizationTarget,omitempty"`
-
- // UtilizationTargetType: Defines type in which utilization_target is
- // expressed.
- //
- // Possible values:
- // "DELTA_PER_MINUTE"
- // "DELTA_PER_SECOND"
- // "GAUGE"
- UtilizationTargetType string `json:"utilizationTargetType,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Metric") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AutoscalingPolicyCustomMetricUtilization) MarshalJSON() ([]byte, error) {
- type noMethod AutoscalingPolicyCustomMetricUtilization
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AutoscalingPolicyLoadBalancingUtilization: Load balancing utilization
-// policy.
-type AutoscalingPolicyLoadBalancingUtilization struct {
- // UtilizationTarget: Fraction of backend capacity utilization (set in
- // HTTP load balancing configuration) that Autoscaler should maintain.
- // Must be a positive float value. If not defined, the default is 0.8.
- // For example if your maxRatePerInstance capacity (in HTTP Load
- // Balancing configuration) is set at 10 and you would like to keep
- // number of instances such that each instance receives 7 QPS on
- // average, set this to 0.7.
- UtilizationTarget float64 `json:"utilizationTarget,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "UtilizationTarget")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AutoscalingPolicyLoadBalancingUtilization) MarshalJSON() ([]byte, error) {
- type noMethod AutoscalingPolicyLoadBalancingUtilization
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Backend: Message containing information of one individual backend.
-type Backend struct {
- // BalancingMode: Specifies the balancing mode for this backend. The
- // default is UTILIZATION but available values are UTILIZATION and RATE.
- //
- // Possible values:
- // "RATE"
- // "UTILIZATION"
- BalancingMode string `json:"balancingMode,omitempty"`
-
- // CapacityScaler: A multiplier applied to the group's maximum servicing
- // capacity (either UTILIZATION or RATE). Default value is 1, which
- // means the group will serve up to 100% of its configured CPU or RPS
- // (depending on balancingMode). A setting of 0 means the group is
- // completely drained, offering 0% of its available CPU or RPS. Valid
- // range is [0.0,1.0].
- CapacityScaler float64 `json:"capacityScaler,omitempty"`
-
- // Description: An optional textual description of the resource.
- // Provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Group: The fully-qualified URL of a zonal Instance Group resource.
- // This instance group defines the list of instances that serve traffic.
- // Member virtual machine instances from each instance group must live
- // in the same zone as the instance group itself. No two backends in a
- // backend service are allowed to use same Instance Group
- // resource.
- //
- // Note that you must specify an Instance Group resource using the
- // fully-qualified URL, rather than a partial URL.
- Group string `json:"group,omitempty"`
-
- // MaxRate: The max RPS of the group. Can be used with either balancing
- // mode, but required if RATE mode. For RATE mode, either maxRate or
- // maxRatePerInstance must be set.
- MaxRate int64 `json:"maxRate,omitempty"`
-
- // MaxRatePerInstance: The max RPS that a single backed instance can
- // handle. This is used to calculate the capacity of the group. Can be
- // used in either balancing mode. For RATE mode, either maxRate or
- // maxRatePerInstance must be set.
- MaxRatePerInstance float64 `json:"maxRatePerInstance,omitempty"`
-
- // MaxUtilization: Used when balancingMode is UTILIZATION. This ratio
- // defines the CPU utilization target for the group. The default is 0.8.
- // Valid range is [0.0, 1.0].
- MaxUtilization float64 `json:"maxUtilization,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BalancingMode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Backend) MarshalJSON() ([]byte, error) {
- type noMethod Backend
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// BackendService: A BackendService resource. This resource defines a
-// group of backend virtual machines together with their serving
-// capacity.
-type BackendService struct {
- // Backends: The list of backends that serve this BackendService.
- Backends []*Backend `json:"backends,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource.
- // Provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Fingerprint: Fingerprint of this resource. A hash of the contents
- // stored in this object. This field is used in optimistic locking. This
- // field will be ignored when inserting a BackendService. An up-to-date
- // fingerprint must be provided in order to update the BackendService.
- Fingerprint string `json:"fingerprint,omitempty"`
-
- // HealthChecks: The list of URLs to the HttpHealthCheck resource for
- // health checking this BackendService. Currently at most one health
- // check can be specified, and a health check is required.
- HealthChecks []string `json:"healthChecks,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of resource. Always compute#backendService
- // for backend services.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource. Provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // Port: Deprecated in favor of port name. The TCP port to connect on
- // the backend. The default value is 80.
- Port int64 `json:"port,omitempty"`
-
- // PortName: Name of backend port. The same name should appear in the
- // resource views referenced by this service. Required.
- PortName string `json:"portName,omitempty"`
-
- // Possible values:
- // "HTTP"
- // "HTTPS"
- Protocol string `json:"protocol,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // TimeoutSec: How many seconds to wait for the backend before
- // considering it a failed request. Default is 30 seconds.
- TimeoutSec int64 `json:"timeoutSec,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Backends") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BackendService) MarshalJSON() ([]byte, error) {
- type noMethod BackendService
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type BackendServiceGroupHealth struct {
- HealthStatus []*HealthStatus `json:"healthStatus,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always
- // compute#backendServiceGroupHealth for the health of backend services.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "HealthStatus") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BackendServiceGroupHealth) MarshalJSON() ([]byte, error) {
- type noMethod BackendServiceGroupHealth
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// BackendServiceList: Contains a list of BackendService resources.
-type BackendServiceList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A list of BackendService resources.
- Items []*BackendService `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always
- // compute#backendServiceList for lists of backend services.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BackendServiceList) MarshalJSON() ([]byte, error) {
- type noMethod BackendServiceList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DeprecationStatus: Deprecation status for a public resource.
-type DeprecationStatus struct {
- // Deleted: An optional RFC3339 timestamp on or after which the
- // deprecation state of this resource will be changed to DELETED.
- Deleted string `json:"deleted,omitempty"`
-
- // Deprecated: An optional RFC3339 timestamp on or after which the
- // deprecation state of this resource will be changed to DEPRECATED.
- Deprecated string `json:"deprecated,omitempty"`
-
- // Obsolete: An optional RFC3339 timestamp on or after which the
- // deprecation state of this resource will be changed to OBSOLETE.
- Obsolete string `json:"obsolete,omitempty"`
-
- // Replacement: The URL of the suggested replacement for a deprecated
- // resource. The suggested replacement resource must be the same kind of
- // resource as the deprecated resource.
- Replacement string `json:"replacement,omitempty"`
-
- // State: The deprecation state of this resource. This can be
- // DEPRECATED, OBSOLETE, or DELETED. Operations which create a new
- // resource using a DEPRECATED resource will return successfully, but
- // with a warning indicating the deprecated resource and recommending
- // its replacement. Operations which use OBSOLETE or DELETED resources
- // will be rejected and result in an error.
- //
- // Possible values:
- // "DELETED"
- // "DEPRECATED"
- // "OBSOLETE"
- State string `json:"state,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Deleted") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DeprecationStatus) MarshalJSON() ([]byte, error) {
- type noMethod DeprecationStatus
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Disk: A Disk resource.
-type Disk struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always compute#disk for
- // disks.
- Kind string `json:"kind,omitempty"`
-
- // LastAttachTimestamp: [Output Only] Last attach timestamp in RFC3339
- // text format.
- LastAttachTimestamp string `json:"lastAttachTimestamp,omitempty"`
-
- // LastDetachTimestamp: [Output Only] Last detach timestamp in RFC3339
- // text format.
- LastDetachTimestamp string `json:"lastDetachTimestamp,omitempty"`
-
- // Licenses: Any applicable publicly visible licenses.
- Licenses []string `json:"licenses,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // Options: Internal use only.
- Options string `json:"options,omitempty"`
-
- // SelfLink: [Output Only] Server-defined fully-qualified URL for this
- // resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // SizeGb: Size of the persistent disk, specified in GB. You can specify
- // this field when creating a persistent disk using the sourceImage or
- // sourceSnapshot parameter, or specify it alone to create an empty
- // persistent disk.
- //
- // If you specify this field along with sourceImage or sourceSnapshot,
- // the value of sizeGb must not be less than the size of the sourceImage
- // or the size of the snapshot.
- SizeGb int64 `json:"sizeGb,omitempty,string"`
-
- // SourceImage: The source image used to create this disk. If the source
- // image is deleted from the system, this field will not be set, even if
- // an image with the same name has been re-created.
- //
- // When creating a disk, you can provide a private (custom) image using
- // the following input, and Compute Engine will use the corresponding
- // image from your project. For example:
- //
- // global/images/my-private-image
- //
- // Or you can provide an image from a publicly-available project. For
- // example, to use a Debian image from the debian-cloud project, make
- // sure to include the project in the
- // URL:
- //
- // projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
- //
- // where vYYYYMMDD is the image version. The fully-qualified URL will
- // also work in both cases.
- SourceImage string `json:"sourceImage,omitempty"`
-
- // SourceImageId: The ID value of the image used to create this disk.
- // This value identifies the exact image that was used to create this
- // persistent disk. For example, if you created the persistent disk from
- // an image that was later deleted and recreated under the same name,
- // the source image ID would identify the exact version of the image
- // that was used.
- SourceImageId string `json:"sourceImageId,omitempty"`
-
- // SourceSnapshot: The source snapshot used to create this disk. You can
- // provide this as a partial or full URL to the resource. For example,
- // the following are valid values:
- // -
- // https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
- // - projects/project/global/snapshots/snapshot
- // - global/snapshots/snapshot
- SourceSnapshot string `json:"sourceSnapshot,omitempty"`
-
- // SourceSnapshotId: [Output Only] The unique ID of the snapshot used to
- // create this disk. This value identifies the exact snapshot that was
- // used to create this persistent disk. For example, if you created the
- // persistent disk from a snapshot that was later deleted and recreated
- // under the same name, the source snapshot ID would identify the exact
- // version of the snapshot that was used.
- SourceSnapshotId string `json:"sourceSnapshotId,omitempty"`
-
- // Status: [Output Only] The status of disk creation. Applicable
- // statuses includes: CREATING, FAILED, READY, RESTORING.
- //
- // Possible values:
- // "CREATING"
- // "FAILED"
- // "READY"
- // "RESTORING"
- Status string `json:"status,omitempty"`
-
- // Type: URL of the disk type resource describing which disk type to use
- // to create the disk; provided by the client when the disk is created.
- Type string `json:"type,omitempty"`
-
- // Users: Links to the users of the disk (attached instances) in form:
- // project/zones/zone/instances/instance
- Users []string `json:"users,omitempty"`
-
- // Zone: [Output Only] URL of the zone where the disk resides.
- Zone string `json:"zone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Disk) MarshalJSON() ([]byte, error) {
- type noMethod Disk
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DiskAggregatedList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A map of scoped disk lists.
- Items map[string]DisksScopedList `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always
- // compute#diskAggregatedList for aggregated lists of persistent disks.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DiskAggregatedList) MarshalJSON() ([]byte, error) {
- type noMethod DiskAggregatedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DiskList: A list of Disk resources.
-type DiskList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of persistent disks.
- Items []*Disk `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#diskList for
- // lists of disks.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DiskList) MarshalJSON() ([]byte, error) {
- type noMethod DiskList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DiskMoveRequest struct {
- // DestinationZone: The URL of the destination zone to move the disk to.
- // This can be a full or partial URL. For example, the following are all
- // valid URLs to a zone:
- // - https://www.googleapis.com/compute/v1/projects/project/zones/zone
- //
- // - projects/project/zones/zone
- // - zones/zone
- DestinationZone string `json:"destinationZone,omitempty"`
-
- // TargetDisk: The URL of the target disk to move. This can be a full or
- // partial URL. For example, the following are all valid URLs to a disk:
- //
- // -
- // https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
- // - projects/project/zones/zone/disks/disk
- // - zones/zone/disks/disk
- TargetDisk string `json:"targetDisk,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DestinationZone") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DiskMoveRequest) MarshalJSON() ([]byte, error) {
- type noMethod DiskMoveRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DiskType: A disk type resource.
-type DiskType struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // DefaultDiskSizeGb: [Output Only] Server-defined default disk size in
- // GB.
- DefaultDiskSizeGb int64 `json:"defaultDiskSizeGb,omitempty,string"`
-
- // Deprecated: [Output Only] The deprecation status associated with this
- // disk type.
- Deprecated *DeprecationStatus `json:"deprecated,omitempty"`
-
- // Description: [Output Only] An optional textual description of the
- // resource.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always compute#diskType for
- // disk types.
- Kind string `json:"kind,omitempty"`
-
- // Name: [Output Only] Name of the resource.
- Name string `json:"name,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ValidDiskSize: [Output Only] An optional textual description of the
- // valid disk size, such as "10GB-10TB".
- ValidDiskSize string `json:"validDiskSize,omitempty"`
-
- // Zone: [Output Only] URL of the zone where the disk type resides.
- Zone string `json:"zone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DiskType) MarshalJSON() ([]byte, error) {
- type noMethod DiskType
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DiskTypeAggregatedList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A map of scoped disk type lists.
- Items map[string]DiskTypesScopedList `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always
- // compute#diskTypeAggregatedList.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DiskTypeAggregatedList) MarshalJSON() ([]byte, error) {
- type noMethod DiskTypeAggregatedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DiskTypeList: Contains a list of disk type resources.
-type DiskTypeList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of Disk Type resources.
- Items []*DiskType `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#diskTypeList for
- // disk types.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DiskTypeList) MarshalJSON() ([]byte, error) {
- type noMethod DiskTypeList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DiskTypesScopedList struct {
- // DiskTypes: [Output Only] List of disk types contained in this scope.
- DiskTypes []*DiskType `json:"diskTypes,omitempty"`
-
- // Warning: [Output Only] Informational warning which replaces the list
- // of disk types when the list is empty.
- Warning *DiskTypesScopedListWarning `json:"warning,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DiskTypes") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DiskTypesScopedList) MarshalJSON() ([]byte, error) {
- type noMethod DiskTypesScopedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DiskTypesScopedListWarning: [Output Only] Informational warning which
-// replaces the list of disk types when the list is empty.
-type DiskTypesScopedListWarning struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*DiskTypesScopedListWarningData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DiskTypesScopedListWarning) MarshalJSON() ([]byte, error) {
- type noMethod DiskTypesScopedListWarning
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DiskTypesScopedListWarningData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DiskTypesScopedListWarningData) MarshalJSON() ([]byte, error) {
- type noMethod DiskTypesScopedListWarningData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DisksScopedList struct {
- // Disks: [Output Only] List of disks contained in this scope.
- Disks []*Disk `json:"disks,omitempty"`
-
- // Warning: [Output Only] Informational warning which replaces the list
- // of disks when the list is empty.
- Warning *DisksScopedListWarning `json:"warning,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Disks") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DisksScopedList) MarshalJSON() ([]byte, error) {
- type noMethod DisksScopedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DisksScopedListWarning: [Output Only] Informational warning which
-// replaces the list of disks when the list is empty.
-type DisksScopedListWarning struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*DisksScopedListWarningData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DisksScopedListWarning) MarshalJSON() ([]byte, error) {
- type noMethod DisksScopedListWarning
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DisksScopedListWarningData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DisksScopedListWarningData) MarshalJSON() ([]byte, error) {
- type noMethod DisksScopedListWarningData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Firewall: A Firewall resource.
-type Firewall struct {
- // Allowed: The list of rules specified by this firewall. Each rule
- // specifies a protocol and port-range tuple that describes a permitted
- // connection.
- Allowed []*FirewallAllowed `json:"allowed,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Ony] Type of the resource. Always compute#firewall for
- // firewall rules.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // Network: URL of the network resource for this firewall rule. This
- // field is required for creating an instance but optional when creating
- // a firewall rule. If not specified when creating a firewall rule, the
- // default network is used:
- // global/networks/default
- // If you choose to specify this property, you can specify the network
- // as a full or partial URL. For example, the following are all valid
- // URLs:
- // -
- // https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
- // - projects/myproject/global/networks/my-network
- // - global/networks/default
- Network string `json:"network,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // SourceRanges: The IP address blocks that this rule applies to,
- // expressed in CIDR format. One or both of sourceRanges and sourceTags
- // may be set.
- //
- // If both properties are set, an inbound connection is allowed if the
- // range matches the sourceRanges OR the tag of the source matches the
- // sourceTags property. The connection does not need to match both
- // properties.
- SourceRanges []string `json:"sourceRanges,omitempty"`
-
- // SourceTags: A list of instance tags which this rule applies to. One
- // or both of sourceRanges and sourceTags may be set.
- //
- // If both properties are set, an inbound connection is allowed if the
- // range matches the sourceRanges OR the tag of the source matches the
- // sourceTags property. The connection does not need to match both
- // properties.
- SourceTags []string `json:"sourceTags,omitempty"`
-
- // TargetTags: A list of instance tags indicating sets of instances
- // located in the network that may make network connections as specified
- // in allowed[]. If no targetTags are specified, the firewall rule
- // applies to all instances on the specified network.
- TargetTags []string `json:"targetTags,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Allowed") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Firewall) MarshalJSON() ([]byte, error) {
- type noMethod Firewall
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type FirewallAllowed struct {
- // IPProtocol: The IP protocol that is allowed for this rule. The
- // protocol type is required when creating a firewall. This value can
- // either be one of the following well known protocol strings (tcp, udp,
- // icmp, esp, ah, sctp), or the IP protocol number.
- IPProtocol string `json:"IPProtocol,omitempty"`
-
- // Ports: An optional list of ports which are allowed. This field is
- // only applicable for UDP or TCP protocol. Each entry must be either an
- // integer or a range. If not specified, connections through any port
- // are allowed
- //
- // Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
- Ports []string `json:"ports,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "IPProtocol") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FirewallAllowed) MarshalJSON() ([]byte, error) {
- type noMethod FirewallAllowed
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FirewallList: Contains a list of Firewall resources.
-type FirewallList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of Firewall resources.
- Items []*Firewall `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#firewallList for
- // lists of firewalls.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FirewallList) MarshalJSON() ([]byte, error) {
- type noMethod FirewallList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ForwardingRule: A ForwardingRule resource. A ForwardingRule resource
-// specifies which pool of target virtual machines to forward a packet
-// to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
-type ForwardingRule struct {
- // IPAddress: Value of the reserved IP address that this forwarding rule
- // is serving on behalf of. For global forwarding rules, the address
- // must be a global IP; for regional forwarding rules, the address must
- // live in the same region as the forwarding rule. If left empty
- // (default value), an ephemeral IP from the same scope (global or
- // regional) will be assigned.
- IPAddress string `json:"IPAddress,omitempty"`
-
- // IPProtocol: The IP protocol to which this rule applies. Valid options
- // are TCP, UDP, ESP, AH or SCTP.
- //
- // Possible values:
- // "AH"
- // "ESP"
- // "SCTP"
- // "TCP"
- // "UDP"
- IPProtocol string `json:"IPProtocol,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always
- // compute#forwardingRule.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // PortRange: Applicable only when IPProtocol is TCP, UDP, or SCTP, only
- // packets addressed to ports in the specified range will be forwarded
- // to target. Forwarding rules with the same `[IPAddress, IPProtocol]`
- // pair must have disjoint port ranges.
- PortRange string `json:"portRange,omitempty"`
-
- // Region: [Output Only] URL of the region where the regional forwarding
- // rule resides. This field is not applicable to global forwarding
- // rules.
- Region string `json:"region,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Target: The URL of the target resource to receive the matched
- // traffic. For regional forwarding rules, this target must live in the
- // same region as the forwarding rule. For global forwarding rules, this
- // target must be a global TargetHttpProxy or TargetHttpsProxy resource.
- Target string `json:"target,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "IPAddress") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ForwardingRule) MarshalJSON() ([]byte, error) {
- type noMethod ForwardingRule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ForwardingRuleAggregatedList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A map of scoped forwarding rule lists.
- Items map[string]ForwardingRulesScopedList `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ForwardingRuleAggregatedList) MarshalJSON() ([]byte, error) {
- type noMethod ForwardingRuleAggregatedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ForwardingRuleList: Contains a list of ForwardingRule resources.
-type ForwardingRuleList struct {
- // Id: [Output Only] Unique identifier for the resource. Set by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A list of ForwardingRule resources.
- Items []*ForwardingRule `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ForwardingRuleList) MarshalJSON() ([]byte, error) {
- type noMethod ForwardingRuleList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ForwardingRulesScopedList struct {
- // ForwardingRules: List of forwarding rules contained in this scope.
- ForwardingRules []*ForwardingRule `json:"forwardingRules,omitempty"`
-
- // Warning: Informational warning which replaces the list of forwarding
- // rules when the list is empty.
- Warning *ForwardingRulesScopedListWarning `json:"warning,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ForwardingRules") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ForwardingRulesScopedList) MarshalJSON() ([]byte, error) {
- type noMethod ForwardingRulesScopedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ForwardingRulesScopedListWarning: Informational warning which
-// replaces the list of forwarding rules when the list is empty.
-type ForwardingRulesScopedListWarning struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*ForwardingRulesScopedListWarningData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ForwardingRulesScopedListWarning) MarshalJSON() ([]byte, error) {
- type noMethod ForwardingRulesScopedListWarning
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ForwardingRulesScopedListWarningData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ForwardingRulesScopedListWarningData) MarshalJSON() ([]byte, error) {
- type noMethod ForwardingRulesScopedListWarningData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type HealthCheckReference struct {
- HealthCheck string `json:"healthCheck,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "HealthCheck") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *HealthCheckReference) MarshalJSON() ([]byte, error) {
- type noMethod HealthCheckReference
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type HealthStatus struct {
- // HealthState: Health state of the instance.
- //
- // Possible values:
- // "HEALTHY"
- // "UNHEALTHY"
- HealthState string `json:"healthState,omitempty"`
-
- // Instance: URL of the instance resource.
- Instance string `json:"instance,omitempty"`
-
- // IpAddress: The IP address represented by this resource.
- IpAddress string `json:"ipAddress,omitempty"`
-
- // Port: The port on the instance.
- Port int64 `json:"port,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "HealthState") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *HealthStatus) MarshalJSON() ([]byte, error) {
- type noMethod HealthStatus
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// HostRule: UrlMaps A host-matching rule for a URL. If matched, will
-// use the named PathMatcher to select the BackendService.
-type HostRule struct {
- // Description: An optional textual description.
- Description string `json:"description,omitempty"`
-
- // Hosts: The list of host patterns to match. They must be valid
- // hostnames, except * will match any string of ([a-z0-9-.]*). In that
- // case, * must be the first character and must be followed in the
- // pattern by either - or ..
- Hosts []string `json:"hosts,omitempty"`
-
- // PathMatcher: The name of the PathMatcher to use to match the path
- // portion of the URL if the hostRule matches the URL's host portion.
- PathMatcher string `json:"pathMatcher,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Description") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *HostRule) MarshalJSON() ([]byte, error) {
- type noMethod HostRule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// HttpHealthCheck: An HttpHealthCheck resource. This resource defines a
-// template for how individual instances should be checked for health,
-// via HTTP.
-type HttpHealthCheck struct {
- // CheckIntervalSec: How often (in seconds) to send a health check. The
- // default value is 5 seconds.
- CheckIntervalSec int64 `json:"checkIntervalSec,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // HealthyThreshold: A so-far unhealthy instance will be marked healthy
- // after this many consecutive successes. The default value is 2.
- HealthyThreshold int64 `json:"healthyThreshold,omitempty"`
-
- // Host: The value of the host header in the HTTP health check request.
- // If left empty (default value), the public IP on behalf of which this
- // health check is performed will be used.
- Host string `json:"host,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: Type of the resource.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource. Provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // Port: The TCP port number for the HTTP health check request. The
- // default value is 80.
- Port int64 `json:"port,omitempty"`
-
- // RequestPath: The request path of the HTTP health check request. The
- // default value is "/".
- RequestPath string `json:"requestPath,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // TimeoutSec: How long (in seconds) to wait before claiming failure.
- // The default value is 5 seconds. It is invalid for timeoutSec to have
- // greater value than checkIntervalSec.
- TimeoutSec int64 `json:"timeoutSec,omitempty"`
-
- // UnhealthyThreshold: A so-far healthy instance will be marked
- // unhealthy after this many consecutive failures. The default value is
- // 2.
- UnhealthyThreshold int64 `json:"unhealthyThreshold,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CheckIntervalSec") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *HttpHealthCheck) MarshalJSON() ([]byte, error) {
- type noMethod HttpHealthCheck
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// HttpHealthCheckList: Contains a list of HttpHealthCheck resources.
-type HttpHealthCheckList struct {
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A list of HttpHealthCheck resources.
- Items []*HttpHealthCheck `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *HttpHealthCheckList) MarshalJSON() ([]byte, error) {
- type noMethod HttpHealthCheckList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// HttpsHealthCheck: An HttpsHealthCheck resource. This resource defines
-// a template for how individual instances should be checked for health,
-// via HTTPS.
-type HttpsHealthCheck struct {
- // CheckIntervalSec: How often (in seconds) to send a health check. The
- // default value is 5 seconds.
- CheckIntervalSec int64 `json:"checkIntervalSec,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // HealthyThreshold: A so-far unhealthy instance will be marked healthy
- // after this many consecutive successes. The default value is 2.
- HealthyThreshold int64 `json:"healthyThreshold,omitempty"`
-
- // Host: The value of the host header in the HTTPS health check request.
- // If left empty (default value), the public IP on behalf of which this
- // health check is performed will be used.
- Host string `json:"host,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: Type of the resource.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource. Provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // Port: The TCP port number for the HTTPS health check request. The
- // default value is 443.
- Port int64 `json:"port,omitempty"`
-
- // RequestPath: The request path of the HTTPS health check request. The
- // default value is "/".
- RequestPath string `json:"requestPath,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // TimeoutSec: How long (in seconds) to wait before claiming failure.
- // The default value is 5 seconds. It is invalid for timeoutSec to have
- // a greater value than checkIntervalSec.
- TimeoutSec int64 `json:"timeoutSec,omitempty"`
-
- // UnhealthyThreshold: A so-far healthy instance will be marked
- // unhealthy after this many consecutive failures. The default value is
- // 2.
- UnhealthyThreshold int64 `json:"unhealthyThreshold,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CheckIntervalSec") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *HttpsHealthCheck) MarshalJSON() ([]byte, error) {
- type noMethod HttpsHealthCheck
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// HttpsHealthCheckList: Contains a list of HttpsHealthCheck resources.
-type HttpsHealthCheckList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A list of HttpsHealthCheck resources.
- Items []*HttpsHealthCheck `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *HttpsHealthCheckList) MarshalJSON() ([]byte, error) {
- type noMethod HttpsHealthCheckList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Image: An Image resource.
-type Image struct {
- // ArchiveSizeBytes: Size of the image tar.gz archive stored in Google
- // Cloud Storage (in bytes).
- ArchiveSizeBytes int64 `json:"archiveSizeBytes,omitempty,string"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Deprecated: The deprecation status associated with this image.
- Deprecated *DeprecationStatus `json:"deprecated,omitempty"`
-
- // Description: Textual description of the resource; provided by the
- // client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // DiskSizeGb: Size of the image when restored onto a persistent disk
- // (in GB).
- DiskSizeGb int64 `json:"diskSizeGb,omitempty,string"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always compute#image for
- // images.
- Kind string `json:"kind,omitempty"`
-
- // Licenses: Any applicable publicly visible licenses.
- Licenses []string `json:"licenses,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // RawDisk: The parameters of the raw disk image.
- RawDisk *ImageRawDisk `json:"rawDisk,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // SourceDisk: URL of the The source disk used to create this image.
- // This can be a full or valid partial URL. You must provide either this
- // property or the rawDisk.source property but not both to create an
- // image. For example, the following are valid values:
- // -
- // https://www.googleapis.com/compute/v1/projects/project/zones/zone/disk/disk
- // - projects/project/zones/zone/disk/disk
- // - zones/zone/disks/disk
- SourceDisk string `json:"sourceDisk,omitempty"`
-
- // SourceDiskId: The ID value of the disk used to create this image.
- // This value may be used to determine whether the image was taken from
- // the current or a previous instance of a given disk name.
- SourceDiskId string `json:"sourceDiskId,omitempty"`
-
- // SourceType: The type of the image used to create this disk. The
- // default and only value is RAW
- //
- // Possible values:
- // "RAW" (default)
- SourceType string `json:"sourceType,omitempty"`
-
- // Status: [Output Only] The status of the image. An image can be used
- // to create other resources, such as instances, only after the image
- // has been successfully created and the status is set to READY.
- // Possible values are FAILED, PENDING, or READY.
- //
- // Possible values:
- // "FAILED"
- // "PENDING"
- // "READY"
- Status string `json:"status,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ArchiveSizeBytes") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Image) MarshalJSON() ([]byte, error) {
- type noMethod Image
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ImageRawDisk: The parameters of the raw disk image.
-type ImageRawDisk struct {
- // ContainerType: The format used to encode and transmit the block
- // device, which should be TAR. This is just a container and
- // transmission format and not a runtime format. Provided by the client
- // when the disk image is created.
- //
- // Possible values:
- // "TAR"
- ContainerType string `json:"containerType,omitempty"`
-
- // Sha1Checksum: An optional SHA1 checksum of the disk image before
- // unpackaging; provided by the client when the disk image is created.
- Sha1Checksum string `json:"sha1Checksum,omitempty"`
-
- // Source: The full Google Cloud Storage URL where the disk image is
- // stored. You must provide either this property or the sourceDisk
- // property but not both.
- Source string `json:"source,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ContainerType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ImageRawDisk) MarshalJSON() ([]byte, error) {
- type noMethod ImageRawDisk
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ImageList: Contains a list of Image resources.
-type ImageList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of Image resources.
- Items []*Image `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ImageList) MarshalJSON() ([]byte, error) {
- type noMethod ImageList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Instance: An Instance resource.
-type Instance struct {
- // CanIpForward: Allows this instance to send and receive packets with
- // non-matching destination or source IPs. This is required if you plan
- // to use this instance to forward routes. For more information, see
- // Enabling IP Forwarding.
- CanIpForward bool `json:"canIpForward,omitempty"`
-
- // CpuPlatform: [Output Only] The CPU platform used by this instance.
- CpuPlatform string `json:"cpuPlatform,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Disks: Array of disks associated with this instance. Persistent disks
- // must be created before you can assign them.
- Disks []*AttachedDisk `json:"disks,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always compute#instance for
- // instances.
- Kind string `json:"kind,omitempty"`
-
- // MachineType: Full or partial URL of the machine type resource to use
- // for this instance. This is provided by the client when the instance
- // is created. For example, the following is a valid partial
- // url:
- //
- // zones/zone/machineTypes/machine-type
- MachineType string `json:"machineType,omitempty"`
-
- // Metadata: The metadata key/value pairs assigned to this instance.
- // This includes custom metadata and predefined keys.
- Metadata *Metadata `json:"metadata,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // NetworkInterfaces: An array of configurations for this interface.
- // This specifies how this interface is configured to interact with
- // other network services, such as connecting to the internet.
- NetworkInterfaces []*NetworkInterface `json:"networkInterfaces,omitempty"`
-
- // Scheduling: Scheduling options for this instance.
- Scheduling *Scheduling `json:"scheduling,omitempty"`
-
- // SelfLink: [Output Only] Server defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServiceAccounts: A list of service accounts, with their specified
- // scopes, authorized for this instance. Service accounts generate
- // access tokens that can be accessed through the metadata server and
- // used to authenticate applications on the instance. See Authenticating
- // from Google Compute Engine for more information.
- ServiceAccounts []*ServiceAccount `json:"serviceAccounts,omitempty"`
-
- // Status: [Output Only] The status of the instance. One of the
- // following values: PROVISIONING, STAGING, RUNNING, STOPPING, and
- // TERMINATED.
- //
- // Possible values:
- // "PROVISIONING"
- // "RUNNING"
- // "STAGING"
- // "STOPPED"
- // "STOPPING"
- // "SUSPENDED"
- // "SUSPENDING"
- // "TERMINATED"
- Status string `json:"status,omitempty"`
-
- // StatusMessage: [Output Only] An optional, human-readable explanation
- // of the status.
- StatusMessage string `json:"statusMessage,omitempty"`
-
- // Tags: A list of tags to appy to this instance. Tags are used to
- // identify valid sources or targets for network firewalls and are
- // specified by the client during instance creation. The tags can be
- // later modified by the setTags method. Each tag within the list must
- // comply with RFC1035.
- Tags *Tags `json:"tags,omitempty"`
-
- // Zone: [Output Only] URL of the zone where the instance resides.
- Zone string `json:"zone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CanIpForward") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Instance) MarshalJSON() ([]byte, error) {
- type noMethod Instance
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceAggregatedList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A map of scoped instance lists.
- Items map[string]InstancesScopedList `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always
- // compute#instanceAggregatedList for aggregated lists of Instance
- // resources.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceAggregatedList) MarshalJSON() ([]byte, error) {
- type noMethod InstanceAggregatedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroup struct {
- // CreationTimestamp: [Output Only] The creation timestamp for this
- // instance group in RFC3339 text format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional text description for the instance group.
- Description string `json:"description,omitempty"`
-
- // Fingerprint: [Output Only] The fingerprint of the named ports. The
- // system uses this fingerprint to detect conflicts when multiple users
- // change the named ports concurrently.
- Fingerprint string `json:"fingerprint,omitempty"`
-
- // Id: [Output Only] A unique identifier for this resource type. The
- // server generates this identifier.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] The resource type, which is always
- // compute#instanceGroup for instance groups.
- Kind string `json:"kind,omitempty"`
-
- // Name: The name of the instance group. The name must be 1-63
- // characters long, and comply with RFC1035.
- Name string `json:"name,omitempty"`
-
- // NamedPorts: Assigns a name to a port number. For example: {name:
- // "http", port: 80}
- //
- // This allows the system to reference ports by the assigned name
- // instead of a port number. Named ports can also contain multiple
- // ports. For example: [{name: "http", port: 80},{name: "http", port:
- // 8080}]
- //
- // Named ports apply to all instances in this instance group.
- NamedPorts []*NamedPort `json:"namedPorts,omitempty"`
-
- // Network: [Output Only] The URL of the network to which all instances
- // in the instance group belong.
- Network string `json:"network,omitempty"`
-
- // SelfLink: [Output Only] The URL for this instance group. The server
- // generates this URL.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Size: [Output Only] The total number of instances in the instance
- // group.
- Size int64 `json:"size,omitempty"`
-
- // Zone: [Output Only] The URL of the zone where the instance group is
- // located.
- Zone string `json:"zone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroup) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroup
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupAggregatedList struct {
- // Id: [Output Only] A unique identifier for this aggregated list of
- // instance groups. The server generates this identifier.
- Id string `json:"id,omitempty"`
-
- // Items: A map of scoped instance group lists.
- Items map[string]InstanceGroupsScopedList `json:"items,omitempty"`
-
- // Kind: [Output Only] The resource type, which is always
- // compute#instanceGroupAggregatedList for aggregated lists of instance
- // groups.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token that is used to continue a
- // truncated list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] The URL for this resource type. The server
- // generates this URL.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupAggregatedList) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupAggregatedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// InstanceGroupList: A list of InstanceGroup resources.
-type InstanceGroupList struct {
- // Id: [Output Only] A unique identifier for this list of instance
- // groups. The server generates this identifier.
- Id string `json:"id,omitempty"`
-
- // Items: A list of instance groups.
- Items []*InstanceGroup `json:"items,omitempty"`
-
- // Kind: [Output Only] The resource type, which is always
- // compute#instanceGroupList for instance group lists.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token that is used to continue a
- // truncated list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] The URL for this resource type. The server
- // generates this URL.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupList) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// InstanceGroupManager: InstanceGroupManagers
-//
-// Next available tag: 19
-type InstanceGroupManager struct {
- // BaseInstanceName: The base instance name to use for instances in this
- // group. The value must be 1-58 characters long. Instances are named by
- // appending a hyphen and a random four-character string to the base
- // instance name. The base instance name must comply with RFC1035.
- BaseInstanceName string `json:"baseInstanceName,omitempty"`
-
- // CreationTimestamp: [Output Only] The creation timestamp for this
- // managed instance group in RFC3339 text format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // CurrentActions: [Output Only] The list of instance actions and the
- // number of instances in this managed instance group that are scheduled
- // for each of those actions.
- CurrentActions *InstanceGroupManagerActionsSummary `json:"currentActions,omitempty"`
-
- // Description: An optional text description for the managed instance
- // group.
- Description string `json:"description,omitempty"`
-
- // Fingerprint: [Output Only] The fingerprint of the target pools
- // information. You can use this optional field for optimistic locking
- // when you update the target pool entries.
- Fingerprint string `json:"fingerprint,omitempty"`
-
- // Id: [Output Only] A unique identifier for this resource type. The
- // server generates this identifier.
- Id uint64 `json:"id,omitempty,string"`
-
- // InstanceGroup: [Output Only] The URL of the Instance Group resource.
- InstanceGroup string `json:"instanceGroup,omitempty"`
-
- // InstanceTemplate: The URL of the instance template that is specified
- // for this managed instance group. The group uses this template to
- // create all new instances in the managed instance group.
- InstanceTemplate string `json:"instanceTemplate,omitempty"`
-
- // Kind: [Output Only] The resource type, which is always
- // compute#instanceGroupManager for managed instance groups.
- Kind string `json:"kind,omitempty"`
-
- // Name: The name of the managed instance group. The name must be 1-63
- // characters long, and comply with RFC1035.
- Name string `json:"name,omitempty"`
-
- // SelfLink: [Output Only] The URL for this managed instance group. The
- // server defines this URL.
- SelfLink string `json:"selfLink,omitempty"`
-
- // TargetPools: The URLs for all TargetPool resources to which instances
- // in the instanceGroup field are added. The target pools automatically
- // apply to all of the instances in the managed instance group.
- TargetPools []string `json:"targetPools,omitempty"`
-
- // TargetSize: The target number of running instances for this managed
- // instance group. Deleting or abandoning instances reduces this number.
- // Resizing the group changes this number.
- TargetSize int64 `json:"targetSize,omitempty"`
-
- // Zone: The name of the zone where the managed instance group is
- // located.
- Zone string `json:"zone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "BaseInstanceName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupManager) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupManager
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupManagerActionsSummary struct {
- // Abandoning: [Output Only] The total number of instances in the
- // managed instance group that are scheduled to be abandoned. Abandoning
- // an instance removes it from the managed instance group without
- // deleting it.
- Abandoning int64 `json:"abandoning,omitempty"`
-
- // Creating: [Output Only] The number of instances in the managed
- // instance group that are scheduled to be created or are currently
- // being created.
- Creating int64 `json:"creating,omitempty"`
-
- // Deleting: [Output Only] The number of instances in the managed
- // instance group that are scheduled to be deleted or are currently
- // being deleted.
- Deleting int64 `json:"deleting,omitempty"`
-
- // None: [Output Only] The number of instances in the managed instance
- // group that are running and have no scheduled actions.
- None int64 `json:"none,omitempty"`
-
- // Recreating: [Output Only] The number of instances in the managed
- // instance group that are scheduled to be recreated or are currently
- // being being recreated. Recreating an instance deletes the existing
- // root persistent disk and creates a new disk from the image that is
- // defined in the instance template.
- Recreating int64 `json:"recreating,omitempty"`
-
- // Refreshing: [Output Only] The number of instances in the managed
- // instance group that are being reconfigured with properties that do
- // not require a restart or a recreate action. For example, setting or
- // removing target pools for the instance.
- Refreshing int64 `json:"refreshing,omitempty"`
-
- // Restarting: [Output Only] The number of instances in the managed
- // instance group that are scheduled to be restarted or are currently
- // being restarted.
- Restarting int64 `json:"restarting,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Abandoning") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupManagerActionsSummary) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupManagerActionsSummary
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupManagerAggregatedList struct {
- // Id: [Output Only] A unique identifier for this aggregated list of
- // managed instance groups. The server generates this identifier.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A map of filtered managed instance group lists.
- Items map[string]InstanceGroupManagersScopedList `json:"items,omitempty"`
-
- // Kind: [Output Only] The resource type, which is always
- // compute#instanceGroupManagerAggregatedList for an aggregated list of
- // managed instance groups.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token that is used to continue a
- // truncated list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] The URL for this resource type. The server
- // generates this URL.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupManagerAggregatedList) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupManagerAggregatedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// InstanceGroupManagerList: [Output Only] A list of managed instance
-// groups.
-type InstanceGroupManagerList struct {
- // Id: [Output Only] A unique identifier for this resource type. The
- // server generates this identifier.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of managed instance groups.
- Items []*InstanceGroupManager `json:"items,omitempty"`
-
- // Kind: [Output Only] The resource type, which is always
- // compute#instanceGroupManagerList for a list of managed instance
- // groups.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token that is used to continue a
- // truncated list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] The URL for this resource type. The server
- // generates this URL.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupManagerList) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupManagerList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupManagersAbandonInstancesRequest struct {
- // Instances: The URL for one or more instances to abandon from the
- // managed instance group.
- Instances []string `json:"instances,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Instances") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupManagersAbandonInstancesRequest) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupManagersAbandonInstancesRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupManagersDeleteInstancesRequest struct {
- // Instances: The list of instances to delete from this managed instance
- // group. Specify one or more instance URLs.
- Instances []string `json:"instances,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Instances") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupManagersDeleteInstancesRequest) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupManagersDeleteInstancesRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupManagersListManagedInstancesResponse struct {
- // ManagedInstances: [Output Only] The list of instances in the managed
- // instance group.
- ManagedInstances []*ManagedInstance `json:"managedInstances,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ManagedInstances") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupManagersListManagedInstancesResponse) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupManagersListManagedInstancesResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupManagersRecreateInstancesRequest struct {
- // Instances: The URL for one or more instances to recreate.
- Instances []string `json:"instances,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Instances") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupManagersRecreateInstancesRequest) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupManagersRecreateInstancesRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupManagersScopedList struct {
- // InstanceGroupManagers: [Output Only] The list of managed instance
- // groups that are contained in the specified project and zone.
- InstanceGroupManagers []*InstanceGroupManager `json:"instanceGroupManagers,omitempty"`
-
- // Warning: [Output Only] The warning that replaces the list of managed
- // instance groups when the list is empty.
- Warning *InstanceGroupManagersScopedListWarning `json:"warning,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "InstanceGroupManagers") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupManagersScopedList) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupManagersScopedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// InstanceGroupManagersScopedListWarning: [Output Only] The warning
-// that replaces the list of managed instance groups when the list is
-// empty.
-type InstanceGroupManagersScopedListWarning struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*InstanceGroupManagersScopedListWarningData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupManagersScopedListWarning) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupManagersScopedListWarning
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupManagersScopedListWarningData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupManagersScopedListWarningData) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupManagersScopedListWarningData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupManagersSetInstanceTemplateRequest struct {
- // InstanceTemplate: The URL of the instance template that is specified
- // for this managed instance group. The group uses this template to
- // create all new instances in the managed instance group.
- InstanceTemplate string `json:"instanceTemplate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "InstanceTemplate") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupManagersSetInstanceTemplateRequest) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupManagersSetInstanceTemplateRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupManagersSetTargetPoolsRequest struct {
- // Fingerprint: The fingerprint of the target pools information. Use
- // this optional property to prevent conflicts when multiple users
- // change the target pools settings concurrently. Obtain the fingerprint
- // with the instanceGroupManagers.get method. Then, include the
- // fingerprint in your request to ensure that you do not overwrite
- // changes that were applied from another concurrent request.
- Fingerprint string `json:"fingerprint,omitempty"`
-
- // TargetPools: The list of target pool URLs that instances in this
- // managed instance group belong to. The managed instance group applies
- // these target pools to all of the instances in the group. Existing
- // instances and new instances in the group all receive these target
- // pool settings.
- TargetPools []string `json:"targetPools,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Fingerprint") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupManagersSetTargetPoolsRequest) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupManagersSetTargetPoolsRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupsAddInstancesRequest struct {
- // Instances: The list of instances to add to the instance group.
- Instances []*InstanceReference `json:"instances,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Instances") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupsAddInstancesRequest) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupsAddInstancesRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupsListInstances struct {
- // Id: [Output Only] A unique identifier for this list of instance
- // groups. The server generates this identifier.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of instances and any named ports that are
- // assigned to those instances.
- Items []*InstanceWithNamedPorts `json:"items,omitempty"`
-
- // Kind: [Output Only] The resource type, which is always
- // compute#instanceGroupsListInstances for lists of instance groups.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token that is used to continue a
- // truncated list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] The URL for this list of instance groups. The
- // server generates this URL.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupsListInstances) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupsListInstances
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupsListInstancesRequest struct {
- // InstanceState: A filter for the state of the instances in the
- // instance group. Valid options are ALL or RUNNING. If you do not
- // specify this parameter the list includes all instances regardless of
- // their state.
- //
- // Possible values:
- // "ALL"
- // "RUNNING"
- InstanceState string `json:"instanceState,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "InstanceState") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupsListInstancesRequest) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupsListInstancesRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupsRemoveInstancesRequest struct {
- // Instances: The list of instances to remove from the instance group.
- Instances []*InstanceReference `json:"instances,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Instances") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupsRemoveInstancesRequest) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupsRemoveInstancesRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupsScopedList struct {
- // InstanceGroups: [Output Only] The list of instance groups that are
- // contained in this scope.
- InstanceGroups []*InstanceGroup `json:"instanceGroups,omitempty"`
-
- // Warning: [Output Only] An informational warning that replaces the
- // list of instance groups when the list is empty.
- Warning *InstanceGroupsScopedListWarning `json:"warning,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "InstanceGroups") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupsScopedList) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupsScopedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// InstanceGroupsScopedListWarning: [Output Only] An informational
-// warning that replaces the list of instance groups when the list is
-// empty.
-type InstanceGroupsScopedListWarning struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*InstanceGroupsScopedListWarningData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupsScopedListWarning) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupsScopedListWarning
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupsScopedListWarningData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupsScopedListWarningData) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupsScopedListWarningData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceGroupsSetNamedPortsRequest struct {
- // Fingerprint: The fingerprint of the named ports information for this
- // instance group. Use this optional property to prevent conflicts when
- // multiple users change the named ports settings concurrently. Obtain
- // the fingerprint with the instanceGroups.get method. Then, include the
- // fingerprint in your request to ensure that you do not overwrite
- // changes that were applied from another concurrent request.
- Fingerprint string `json:"fingerprint,omitempty"`
-
- // NamedPorts: The list of named ports to set for this instance group.
- NamedPorts []*NamedPort `json:"namedPorts,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Fingerprint") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceGroupsSetNamedPortsRequest) MarshalJSON() ([]byte, error) {
- type noMethod InstanceGroupsSetNamedPortsRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// InstanceList: Contains a list of instance resources.
-type InstanceList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of Instance resources.
- Items []*Instance `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#instanceList for
- // lists of Instance resources.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceList) MarshalJSON() ([]byte, error) {
- type noMethod InstanceList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceMoveRequest struct {
- // DestinationZone: The URL of the destination zone to move the instance
- // to. This can be a full or partial URL. For example, the following are
- // all valid URLs to a zone:
- // - https://www.googleapis.com/compute/v1/projects/project/zones/zone
- //
- // - projects/project/zones/zone
- // - zones/zone
- DestinationZone string `json:"destinationZone,omitempty"`
-
- // TargetInstance: The URL of the target instance to move. This can be a
- // full or partial URL. For example, the following are all valid URLs to
- // an instance:
- // -
- // https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
- // - projects/project/zones/zone/instances/instance
- // - zones/zone/instances/instance
- TargetInstance string `json:"targetInstance,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DestinationZone") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceMoveRequest) MarshalJSON() ([]byte, error) {
- type noMethod InstanceMoveRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceProperties struct {
- // CanIpForward: Enables instances created based on this template to
- // send packets with source IP addresses other than their own and
- // receive packets with destination IP addresses other than their own.
- // If these instances will be used as an IP gateway or it will be set as
- // the next-hop in a Route resource, specify true. If unsure, leave this
- // set to false. See the canIpForward documentation for more
- // information.
- CanIpForward bool `json:"canIpForward,omitempty"`
-
- // Description: An optional text description for the instances that are
- // created from this instance template.
- Description string `json:"description,omitempty"`
-
- // Disks: An array of disks that are associated with the instances that
- // are created from this template.
- Disks []*AttachedDisk `json:"disks,omitempty"`
-
- // MachineType: The machine type to use for instances that are created
- // from this template.
- MachineType string `json:"machineType,omitempty"`
-
- // Metadata: The metadata key/value pairs to assign to instances that
- // are created from this template. These pairs can consist of custom
- // metadata or predefined keys. See Project and instance metadata for
- // more information.
- Metadata *Metadata `json:"metadata,omitempty"`
-
- // NetworkInterfaces: An array of network access configurations for this
- // interface.
- NetworkInterfaces []*NetworkInterface `json:"networkInterfaces,omitempty"`
-
- // Scheduling: Specifies the scheduling options for the instances that
- // are created from this template.
- Scheduling *Scheduling `json:"scheduling,omitempty"`
-
- // ServiceAccounts: A list of service accounts with specified scopes.
- // Access tokens for these service accounts are available to the
- // instances that are created from this template. Use metadata queries
- // to obtain the access tokens for these instances.
- ServiceAccounts []*ServiceAccount `json:"serviceAccounts,omitempty"`
-
- // Tags: A list of tags to apply to the instances that are created from
- // this template. The tags identify valid sources or targets for network
- // firewalls. The setTags method can modify this list of tags. Each tag
- // within the list must comply with RFC1035.
- Tags *Tags `json:"tags,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CanIpForward") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceProperties) MarshalJSON() ([]byte, error) {
- type noMethod InstanceProperties
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceReference struct {
- // Instance: The URL for a specific instance.
- Instance string `json:"instance,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Instance") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceReference) MarshalJSON() ([]byte, error) {
- type noMethod InstanceReference
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// InstanceTemplate: An Instance Template resource.
-type InstanceTemplate struct {
- // CreationTimestamp: [Output Only] The creation timestamp for this
- // instance template in RFC3339 text format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional text description for the instance template.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] A unique identifier for this instance template. The
- // server defines this identifier.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] The resource type, which is always
- // compute#instanceTemplate for instance templates.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // Properties: The instance properties for this instance template.
- Properties *InstanceProperties `json:"properties,omitempty"`
-
- // SelfLink: [Output Only] The URL for this instance template. The
- // server defines this URL.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceTemplate) MarshalJSON() ([]byte, error) {
- type noMethod InstanceTemplate
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// InstanceTemplateList: A list of instance templates.
-type InstanceTemplateList struct {
- // Id: [Output Only] A unique identifier for this instance template. The
- // server defines this identifier.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] list of InstanceTemplate resources.
- Items []*InstanceTemplate `json:"items,omitempty"`
-
- // Kind: [Output Only] The resource type, which is always
- // compute#instanceTemplatesListResponse for instance template lists.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token that is used to continue a
- // truncated list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] The URL for this instance template list. The
- // server defines this URL.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceTemplateList) MarshalJSON() ([]byte, error) {
- type noMethod InstanceTemplateList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstanceWithNamedPorts struct {
- // Instance: [Output Only] The URL of the instance.
- Instance string `json:"instance,omitempty"`
-
- // NamedPorts: [Output Only] The named ports that belong to this
- // instance group.
- NamedPorts []*NamedPort `json:"namedPorts,omitempty"`
-
- // Status: [Output Only] The status of the instance.
- //
- // Possible values:
- // "PROVISIONING"
- // "RUNNING"
- // "STAGING"
- // "STOPPED"
- // "STOPPING"
- // "SUSPENDED"
- // "SUSPENDING"
- // "TERMINATED"
- Status string `json:"status,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Instance") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstanceWithNamedPorts) MarshalJSON() ([]byte, error) {
- type noMethod InstanceWithNamedPorts
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstancesScopedList struct {
- // Instances: [Output Only] List of instances contained in this scope.
- Instances []*Instance `json:"instances,omitempty"`
-
- // Warning: [Output Only] Informational warning which replaces the list
- // of instances when the list is empty.
- Warning *InstancesScopedListWarning `json:"warning,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Instances") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstancesScopedList) MarshalJSON() ([]byte, error) {
- type noMethod InstancesScopedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// InstancesScopedListWarning: [Output Only] Informational warning which
-// replaces the list of instances when the list is empty.
-type InstancesScopedListWarning struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*InstancesScopedListWarningData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstancesScopedListWarning) MarshalJSON() ([]byte, error) {
- type noMethod InstancesScopedListWarning
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstancesScopedListWarningData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstancesScopedListWarningData) MarshalJSON() ([]byte, error) {
- type noMethod InstancesScopedListWarningData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// License: A license resource.
-type License struct {
- // ChargesUseFee: If true, the customer will be charged license fee for
- // running software that contains this license on an instance.
- ChargesUseFee bool `json:"chargesUseFee,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#license for
- // licenses.
- Kind string `json:"kind,omitempty"`
-
- // Name: [Output Only] Name of the resource. The name is 1-63 characters
- // long and complies with RFC1035.
- Name string `json:"name,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ChargesUseFee") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *License) MarshalJSON() ([]byte, error) {
- type noMethod License
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MachineType: A Machine Type resource.
-type MachineType struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Deprecated: [Output Only] The deprecation status associated with this
- // machine type.
- Deprecated *DeprecationStatus `json:"deprecated,omitempty"`
-
- // Description: [Output Only] An optional textual description of the
- // resource.
- Description string `json:"description,omitempty"`
-
- // GuestCpus: [Output Only] The tumber of CPUs exposed to the instance.
- GuestCpus int64 `json:"guestCpus,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // ImageSpaceGb: [Deprecated] This property is deprecated and will never
- // be populated with any relevant values.
- ImageSpaceGb int64 `json:"imageSpaceGb,omitempty"`
-
- // Kind: Type of the resource.
- Kind string `json:"kind,omitempty"`
-
- // MaximumPersistentDisks: [Output Only] Maximum persistent disks
- // allowed.
- MaximumPersistentDisks int64 `json:"maximumPersistentDisks,omitempty"`
-
- // MaximumPersistentDisksSizeGb: [Output Only] Maximum total persistent
- // disks size (GB) allowed.
- MaximumPersistentDisksSizeGb int64 `json:"maximumPersistentDisksSizeGb,omitempty,string"`
-
- // MemoryMb: [Output Only] The amount of physical memory available to
- // the instance, defined in MB.
- MemoryMb int64 `json:"memoryMb,omitempty"`
-
- // Name: [Output Only] Name of the resource.
- Name string `json:"name,omitempty"`
-
- // ScratchDisks: [Output Only] List of extended scratch disks assigned
- // to the instance.
- ScratchDisks []*MachineTypeScratchDisks `json:"scratchDisks,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Zone: [Output Only] The name of the zone where the machine type
- // resides, such as us-central1-a.
- Zone string `json:"zone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MachineType) MarshalJSON() ([]byte, error) {
- type noMethod MachineType
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type MachineTypeScratchDisks struct {
- // DiskGb: Size of the scratch disk, defined in GB.
- DiskGb int64 `json:"diskGb,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DiskGb") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MachineTypeScratchDisks) MarshalJSON() ([]byte, error) {
- type noMethod MachineTypeScratchDisks
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type MachineTypeAggregatedList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A map of scoped machine type lists.
- Items map[string]MachineTypesScopedList `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always
- // compute#machineTypeAggregatedList for aggregated lists of machine
- // types.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MachineTypeAggregatedList) MarshalJSON() ([]byte, error) {
- type noMethod MachineTypeAggregatedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MachineTypeList: Contains a list of Machine Type resources.
-type MachineTypeList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of Machine Type resources.
- Items []*MachineType `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#machineTypeList
- // for lists of machine types.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MachineTypeList) MarshalJSON() ([]byte, error) {
- type noMethod MachineTypeList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type MachineTypesScopedList struct {
- // MachineTypes: [Output Only] List of machine types contained in this
- // scope.
- MachineTypes []*MachineType `json:"machineTypes,omitempty"`
-
- // Warning: [Output Only] An informational warning that appears when the
- // machine types list is empty.
- Warning *MachineTypesScopedListWarning `json:"warning,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "MachineTypes") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MachineTypesScopedList) MarshalJSON() ([]byte, error) {
- type noMethod MachineTypesScopedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MachineTypesScopedListWarning: [Output Only] An informational warning
-// that appears when the machine types list is empty.
-type MachineTypesScopedListWarning struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*MachineTypesScopedListWarningData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MachineTypesScopedListWarning) MarshalJSON() ([]byte, error) {
- type noMethod MachineTypesScopedListWarning
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type MachineTypesScopedListWarningData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MachineTypesScopedListWarningData) MarshalJSON() ([]byte, error) {
- type noMethod MachineTypesScopedListWarningData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ManagedInstance struct {
- // CurrentAction: [Output Only] The current action that the managed
- // instance group has scheduled for the instance. Possible values:
- // - NONE The instance is running, and the managed instance group does
- // not have any scheduled actions for this instance.
- // - CREATING The managed instance group is creating this instance.
- // - RECREATING The managed instance group is recreating this instance.
- //
- // - DELETING The managed instance group is permanently deleting this
- // instance.
- // - ABANDONING The managed instance group is abandoning this instance.
- // The instance will be removed from the instance group and from any
- // target pools that are associated with this group.
- // - RESTARTING The managed instance group is restarting the instance.
- //
- // - REFRESHING The managed instance group is applying configuration
- // changes to the instance without stopping it. For example, the group
- // can update the target pool list for an instance without stopping that
- // instance.
- //
- // Possible values:
- // "ABANDONING"
- // "CREATING"
- // "DELETING"
- // "NONE"
- // "RECREATING"
- // "REFRESHING"
- // "RESTARTING"
- CurrentAction string `json:"currentAction,omitempty"`
-
- // Id: [Output only] The unique identifier for this resource. This field
- // is empty when instance does not exist.
- Id uint64 `json:"id,omitempty,string"`
-
- // Instance: [Output Only] The URL of the instance. The URL can exist
- // even if the instance has not yet been created.
- Instance string `json:"instance,omitempty"`
-
- // InstanceStatus: [Output Only] The status of the instance. This field
- // is empty when the instance does not exist.
- //
- // Possible values:
- // "PROVISIONING"
- // "RUNNING"
- // "STAGING"
- // "STOPPED"
- // "STOPPING"
- // "SUSPENDED"
- // "SUSPENDING"
- // "TERMINATED"
- InstanceStatus string `json:"instanceStatus,omitempty"`
-
- // LastAttempt: [Output Only] Information about the last attempt to
- // create or delete the instance.
- LastAttempt *ManagedInstanceLastAttempt `json:"lastAttempt,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CurrentAction") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ManagedInstance) MarshalJSON() ([]byte, error) {
- type noMethod ManagedInstance
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ManagedInstanceLastAttempt struct {
- // Errors: [Output Only] Encountered errors during the last attempt to
- // create or delete the instance.
- Errors *ManagedInstanceLastAttemptErrors `json:"errors,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Errors") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ManagedInstanceLastAttempt) MarshalJSON() ([]byte, error) {
- type noMethod ManagedInstanceLastAttempt
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ManagedInstanceLastAttemptErrors: [Output Only] Encountered errors
-// during the last attempt to create or delete the instance.
-type ManagedInstanceLastAttemptErrors struct {
- // Errors: [Output Only] The array of errors encountered while
- // processing this operation.
- Errors []*ManagedInstanceLastAttemptErrorsErrors `json:"errors,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Errors") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ManagedInstanceLastAttemptErrors) MarshalJSON() ([]byte, error) {
- type noMethod ManagedInstanceLastAttemptErrors
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ManagedInstanceLastAttemptErrorsErrors struct {
- // Code: [Output Only] The error type identifier for this error.
- Code string `json:"code,omitempty"`
-
- // Location: [Output Only] Indicates the field in the request which
- // caused the error. This property is optional.
- Location string `json:"location,omitempty"`
-
- // Message: [Output Only] An optional, human-readable error message.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ManagedInstanceLastAttemptErrorsErrors) MarshalJSON() ([]byte, error) {
- type noMethod ManagedInstanceLastAttemptErrorsErrors
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Metadata: A metadata key/value entry.
-type Metadata struct {
- // Fingerprint: Specifies a fingerprint for this request, which is
- // essentially a hash of the metadata's contents and used for optimistic
- // locking. The fingerprint is initially generated by Compute Engine and
- // changes after every request to modify or update metadata. You must
- // always provide an up-to-date fingerprint hash in order to update or
- // change metadata.
- Fingerprint string `json:"fingerprint,omitempty"`
-
- // Items: Array of key/value pairs. The total size of all keys and
- // values must be less than 512 KB.
- Items []*MetadataItems `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of the resource. Always compute#metadata for
- // metadata.
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Fingerprint") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Metadata) MarshalJSON() ([]byte, error) {
- type noMethod Metadata
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type MetadataItems struct {
- // Key: Key for the metadata entry. Keys must conform to the following
- // regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is
- // reflected as part of a URL in the metadata server. Additionally, to
- // avoid ambiguity, keys must not conflict with any other metadata keys
- // for the project.
- Key string `json:"key,omitempty"`
-
- // Value: Value for the metadata entry. These are free-form strings, and
- // only have meaning as interpreted by the image running in the
- // instance. The only restriction placed on values is that their size
- // must be less than or equal to 32768 bytes.
- Value *string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MetadataItems) MarshalJSON() ([]byte, error) {
- type noMethod MetadataItems
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// NamedPort: The named port. For example: .
-type NamedPort struct {
- // Name: The name for this named port. The name must be 1-63 characters
- // long, and comply with RFC1035.
- Name string `json:"name,omitempty"`
-
- // Port: The port number, which can be a value between 1 and 65535.
- Port int64 `json:"port,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Name") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *NamedPort) MarshalJSON() ([]byte, error) {
- type noMethod NamedPort
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Network: A network resource.
-type Network struct {
- // IPv4Range: The range of internal addresses that are legal on this
- // network. This range is a CIDR specification, for example:
- // 192.168.0.0/16. Provided by the client when the network is created.
- IPv4Range string `json:"IPv4Range,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource.
- // Provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // GatewayIPv4: A gateway address for default routing to other networks.
- // This value is read only and is selected by the Google Compute Engine,
- // typically as the first usable address in the IPv4Range.
- GatewayIPv4 string `json:"gatewayIPv4,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always compute#network for
- // networks.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource. Provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "IPv4Range") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Network) MarshalJSON() ([]byte, error) {
- type noMethod Network
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// NetworkInterface: A network interface resource attached to an
-// instance.
-type NetworkInterface struct {
- // AccessConfigs: An array of configurations for this interface.
- // Currently, ONE_TO_ONE_NAT is the only access config supported. If
- // there are no accessConfigs specified, then this instance will have no
- // external internet access.
- AccessConfigs []*AccessConfig `json:"accessConfigs,omitempty"`
-
- // Name: [Output Only] The name of the network interface, generated by
- // the server. For network devices, these are eth0, eth1, etc.
- Name string `json:"name,omitempty"`
-
- // Network: URL of the network resource for this instance. This is
- // required for creating an instance but optional when creating a
- // firewall rule. If not specified when creating a firewall rule, the
- // default network is used:
- //
- // global/networks/default
- //
- // If you specify this property, you can specify the network as a full
- // or partial URL. For example, the following are all valid URLs:
- // -
- // https://www.googleapis.com/compute/v1/projects/project/global/networks/network
- // - projects/project/global/networks/network
- // - global/networks/default
- Network string `json:"network,omitempty"`
-
- // NetworkIP: [Output Only] An optional IPV4 internal network address
- // assigned to the instance for this network interface.
- NetworkIP string `json:"networkIP,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AccessConfigs") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *NetworkInterface) MarshalJSON() ([]byte, error) {
- type noMethod NetworkInterface
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// NetworkList: Contains a list of Network resources.
-type NetworkList struct {
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of Network resources.
- Items []*Network `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#networkList for
- // lists of networks.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource .
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *NetworkList) MarshalJSON() ([]byte, error) {
- type noMethod NetworkList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Operation: An Operation resource, used to manage asynchronous API
-// requests.
-type Operation struct {
- // ClientOperationId: [Output Only] An optional identifier specified by
- // the client when the mutation was initiated. Must be unique for all
- // Operation resources in the project.
- ClientOperationId string `json:"clientOperationId,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // EndTime: [Output Only] The time that this operation was completed.
- // This is in RFC3339 text format.
- EndTime string `json:"endTime,omitempty"`
-
- // Error: [Output Only] If errors are generated during processing of the
- // operation, this field will be populated.
- Error *OperationError `json:"error,omitempty"`
-
- // HttpErrorMessage: [Output Only] If the operation fails, this field
- // contains the HTTP error message that was returned, such as NOT FOUND.
- HttpErrorMessage string `json:"httpErrorMessage,omitempty"`
-
- // HttpErrorStatusCode: [Output Only] If the operation fails, this field
- // contains the HTTP error message that was returned, such as 404.
- HttpErrorStatusCode int64 `json:"httpErrorStatusCode,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // InsertTime: [Output Only] The time that this operation was requested.
- // This is in RFC3339 text format.
- InsertTime string `json:"insertTime,omitempty"`
-
- // Kind: [Output Only] Type of the resource. Always compute#operation
- // for Operation resources.
- Kind string `json:"kind,omitempty"`
-
- // Name: [Output Only] Name of the resource.
- Name string `json:"name,omitempty"`
-
- // OperationType: [Output Only] Type of the operation, such as insert,
- // compute.instanceGroups.update, or compute.instanceGroups.delete.
- OperationType string `json:"operationType,omitempty"`
-
- // Progress: [Output Only] An optional progress indicator that ranges
- // from 0 to 100. There is no requirement that this be linear or support
- // any granularity of operations. This should not be used to guess at
- // when the operation will be complete. This number should monotonically
- // increase as the operation progresses.
- Progress int64 `json:"progress,omitempty"`
-
- // Region: [Output Only] URL of the region where the operation resides.
- // Only applicable for regional resources.
- Region string `json:"region,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // StartTime: [Output Only] The time that this operation was started by
- // the server. This is in RFC3339 text format.
- StartTime string `json:"startTime,omitempty"`
-
- // Status: [Output Only] Status of the operation. Can be one of the
- // following: PENDING, RUNNING, or DONE.
- //
- // Possible values:
- // "DONE"
- // "PENDING"
- // "RUNNING"
- Status string `json:"status,omitempty"`
-
- // StatusMessage: [Output Only] An optional textual description of the
- // current status of the operation.
- StatusMessage string `json:"statusMessage,omitempty"`
-
- // TargetId: [Output Only] Unique target ID which identifies a
- // particular incarnation of the target.
- TargetId uint64 `json:"targetId,omitempty,string"`
-
- // TargetLink: [Output Only] URL of the resource the operation is
- // mutating.
- TargetLink string `json:"targetLink,omitempty"`
-
- // User: [Output Only] User who requested the operation, for example:
- // user@example.com.
- User string `json:"user,omitempty"`
-
- // Warnings: [Output Only] If warning messages are generated during
- // processing of the operation, this field will be populated.
- Warnings []*OperationWarnings `json:"warnings,omitempty"`
-
- // Zone: [Output Only] URL of the zone where the operation resides.
- Zone string `json:"zone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ClientOperationId")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Operation) MarshalJSON() ([]byte, error) {
- type noMethod Operation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperationError: [Output Only] If errors are generated during
-// processing of the operation, this field will be populated.
-type OperationError struct {
- // Errors: [Output Only] The array of errors encountered while
- // processing this operation.
- Errors []*OperationErrorErrors `json:"errors,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Errors") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationError) MarshalJSON() ([]byte, error) {
- type noMethod OperationError
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationErrorErrors struct {
- // Code: [Output Only] The error type identifier for this error.
- Code string `json:"code,omitempty"`
-
- // Location: [Output Only] Indicates the field in the request which
- // caused the error. This property is optional.
- Location string `json:"location,omitempty"`
-
- // Message: [Output Only] An optional, human-readable error message.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationErrorErrors) MarshalJSON() ([]byte, error) {
- type noMethod OperationErrorErrors
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationWarnings struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*OperationWarningsData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationWarnings) MarshalJSON() ([]byte, error) {
- type noMethod OperationWarnings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationWarningsData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationWarningsData) MarshalJSON() ([]byte, error) {
- type noMethod OperationWarningsData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationAggregatedList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A map of scoped operation lists.
- Items map[string]OperationsScopedList `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always
- // compute#operationAggregatedList for aggregated lists of operations.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationAggregatedList) MarshalJSON() ([]byte, error) {
- type noMethod OperationAggregatedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperationList: Contains a list of Operation resources.
-type OperationList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] The Operation resources.
- Items []*Operation `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#operations for
- // Operations resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncate.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationList) MarshalJSON() ([]byte, error) {
- type noMethod OperationList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationsScopedList struct {
- // Operations: [Output Only] List of operations contained in this scope.
- Operations []*Operation `json:"operations,omitempty"`
-
- // Warning: [Output Only] Informational warning which replaces the list
- // of operations when the list is empty.
- Warning *OperationsScopedListWarning `json:"warning,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Operations") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationsScopedList) MarshalJSON() ([]byte, error) {
- type noMethod OperationsScopedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperationsScopedListWarning: [Output Only] Informational warning
-// which replaces the list of operations when the list is empty.
-type OperationsScopedListWarning struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*OperationsScopedListWarningData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationsScopedListWarning) MarshalJSON() ([]byte, error) {
- type noMethod OperationsScopedListWarning
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationsScopedListWarningData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationsScopedListWarningData) MarshalJSON() ([]byte, error) {
- type noMethod OperationsScopedListWarningData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PathMatcher: A matcher for the path portion of the URL. The
-// BackendService from the longest-matched rule will serve the URL. If
-// no rule was matched, the default service will be used.
-type PathMatcher struct {
- // DefaultService: The URL to the BackendService resource. This will be
- // used if none of the 'pathRules' defined by this PathMatcher is met by
- // the URL's path portion.
- DefaultService string `json:"defaultService,omitempty"`
-
- // Description: An optional textual description of the resource.
- Description string `json:"description,omitempty"`
-
- // Name: The name to which this PathMatcher is referred by the HostRule.
- Name string `json:"name,omitempty"`
-
- // PathRules: The list of path rules.
- PathRules []*PathRule `json:"pathRules,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DefaultService") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PathMatcher) MarshalJSON() ([]byte, error) {
- type noMethod PathMatcher
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PathRule: A path-matching rule for a URL. If matched, will use the
-// specified BackendService to handle the traffic arriving at this URL.
-type PathRule struct {
- // Paths: The list of path patterns to match. Each must start with / and
- // the only place a * is allowed is at the end following a /. The string
- // fed to the path matcher does not include any text after the first ?
- // or #, and those chars are not allowed here.
- Paths []string `json:"paths,omitempty"`
-
- // Service: The URL of the BackendService resource if this rule is
- // matched.
- Service string `json:"service,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Paths") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PathRule) MarshalJSON() ([]byte, error) {
- type noMethod PathRule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Project: A Project resource. Projects can only be created in the
-// Google Developers Console. Unless marked otherwise, values can only
-// be modified in the console.
-type Project struct {
- // CommonInstanceMetadata: Metadata key/value pairs available to all
- // instances contained in this project. See Custom metadata for more
- // information.
- CommonInstanceMetadata *Metadata `json:"commonInstanceMetadata,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource.
- Description string `json:"description,omitempty"`
-
- // EnabledFeatures: Restricted features enabled for use on this project.
- EnabledFeatures []string `json:"enabledFeatures,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always compute#project for
- // projects.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource.
- Name string `json:"name,omitempty"`
-
- // Quotas: [Output Only] Quotas assigned to this project.
- Quotas []*Quota `json:"quotas,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // UsageExportLocation: The location in Cloud Storage and naming method
- // of the daily usage report.
- UsageExportLocation *UsageExportLocation `json:"usageExportLocation,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "CommonInstanceMetadata") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Project) MarshalJSON() ([]byte, error) {
- type noMethod Project
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Quota: A quotas entry.
-type Quota struct {
- // Limit: [Output Only] Quota limit for this metric.
- Limit float64 `json:"limit,omitempty"`
-
- // Metric: [Output Only] Name of the quota metric.
- //
- // Possible values:
- // "BACKEND_SERVICES"
- // "CPUS"
- // "DISKS_TOTAL_GB"
- // "FIREWALLS"
- // "FORWARDING_RULES"
- // "HEALTH_CHECKS"
- // "IMAGES"
- // "INSTANCES"
- // "INSTANCE_GROUPS"
- // "INSTANCE_GROUP_MANAGERS"
- // "INSTANCE_TEMPLATES"
- // "IN_USE_ADDRESSES"
- // "LOCAL_SSD_TOTAL_GB"
- // "NETWORKS"
- // "ROUTES"
- // "SNAPSHOTS"
- // "SSD_TOTAL_GB"
- // "STATIC_ADDRESSES"
- // "TARGET_HTTP_PROXIES"
- // "TARGET_INSTANCES"
- // "TARGET_POOLS"
- // "TARGET_VPN_GATEWAYS"
- // "URL_MAPS"
- // "VPN_TUNNELS"
- Metric string `json:"metric,omitempty"`
-
- // Usage: [Output Only] Current usage of this metric.
- Usage float64 `json:"usage,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Limit") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Quota) MarshalJSON() ([]byte, error) {
- type noMethod Quota
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Region: Region resource.
-type Region struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Deprecated: [Output Only] The deprecation status associated with this
- // region.
- Deprecated *DeprecationStatus `json:"deprecated,omitempty"`
-
- // Description: [Output Only] Textual description of the resource.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server .
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always compute#region for
- // regions.
- Kind string `json:"kind,omitempty"`
-
- // Name: [Output Only] Name of the resource.
- Name string `json:"name,omitempty"`
-
- // Quotas: [Output Only] Quotas assigned to this region.
- Quotas []*Quota `json:"quotas,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Status: [Output Only] Status of the region, either UP or DOWN.
- //
- // Possible values:
- // "DOWN"
- // "UP"
- Status string `json:"status,omitempty"`
-
- // Zones: [Output Only] A list of zones available in this region, in the
- // form of resource URLs.
- Zones []string `json:"zones,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Region) MarshalJSON() ([]byte, error) {
- type noMethod Region
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// RegionList: Contains a list of region resources.
-type RegionList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of Region resources.
- Items []*Region `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#regionList for
- // lists of regions.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RegionList) MarshalJSON() ([]byte, error) {
- type noMethod RegionList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ResourceGroupReference struct {
- // Group: A URI referencing one of the resource views listed in the
- // backend service.
- Group string `json:"group,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Group") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ResourceGroupReference) MarshalJSON() ([]byte, error) {
- type noMethod ResourceGroupReference
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Route: The route resource. A Route is a rule that specifies how
-// certain packets should be handled by the virtual network. Routes are
-// associated with instances by tag and the set of Routes for a
-// particular instance is called its routing table. For each packet
-// leaving a instance, the system searches that instance's routing table
-// for a single best matching Route. Routes match packets by destination
-// IP address, preferring smaller or more specific ranges over larger
-// ones. If there is a tie, the system selects the Route with the
-// smallest priority value. If there is still a tie, it uses the layer
-// three and four packet headers to select just one of the remaining
-// matching Routes. The packet is then forwarded as specified by the
-// nextHop field of the winning Route -- either to another instance
-// destination, a instance gateway or a Google Compute Engien-operated
-// gateway. Packets that do not match any Route in the sending
-// instance's routing table are dropped.
-type Route struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource.
- // Provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // DestRange: The destination range of outgoing packets that this route
- // applies to.
- DestRange string `json:"destRange,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of this resource. Always compute#routes for
- // Route resources.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // Network: Fully-qualified URL of the network that this route applies
- // to.
- Network string `json:"network,omitempty"`
-
- // NextHopGateway: The URL to a gateway that should handle matching
- // packets. Currently, this is only the internet gateway:
- // projects//global/gateways/default-internet-gateway
- NextHopGateway string `json:"nextHopGateway,omitempty"`
-
- // NextHopInstance: The fully-qualified URL to an instance that should
- // handle matching packets. For
- // example:
- // https://www.googleapis.com/compute/v1/projects/project/zones/
- // zone/instances/
- NextHopInstance string `json:"nextHopInstance,omitempty"`
-
- // NextHopIp: The network IP address of an instance that should handle
- // matching packets.
- NextHopIp string `json:"nextHopIp,omitempty"`
-
- // NextHopNetwork: The URL of the local network if it should handle
- // matching packets.
- NextHopNetwork string `json:"nextHopNetwork,omitempty"`
-
- // NextHopVpnTunnel: The URL to a VpnTunnel that should handle matching
- // packets.
- NextHopVpnTunnel string `json:"nextHopVpnTunnel,omitempty"`
-
- // Priority: Breaks ties between Routes of equal specificity. Routes
- // with smaller values win when tied with routes with larger values.
- // Default value is 1000. A valid range is between 0 and 65535.
- Priority int64 `json:"priority,omitempty"`
-
- // SelfLink: [Output Only] Server-defined fully-qualified URL for this
- // resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Tags: A list of instance tags to which this route applies.
- Tags []string `json:"tags,omitempty"`
-
- // Warnings: [Output Only] If potential misconfigurations are detected
- // for this route, this field will be populated with warning messages.
- Warnings []*RouteWarnings `json:"warnings,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Route) MarshalJSON() ([]byte, error) {
- type noMethod Route
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type RouteWarnings struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*RouteWarningsData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RouteWarnings) MarshalJSON() ([]byte, error) {
- type noMethod RouteWarnings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type RouteWarningsData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RouteWarningsData) MarshalJSON() ([]byte, error) {
- type noMethod RouteWarningsData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// RouteList: Contains a list of route resources.
-type RouteList struct {
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A list of Route resources.
- Items []*Route `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RouteList) MarshalJSON() ([]byte, error) {
- type noMethod RouteList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Scheduling: Sets the scheduling options for an Instance.
-type Scheduling struct {
- // AutomaticRestart: Specifies whether the instance should be
- // automatically restarted if it is terminated by Compute Engine (not
- // terminated by a user). You can only set the automatic restart option
- // for standard instances. Preemptible instances cannot be automatically
- // restarted.
- AutomaticRestart bool `json:"automaticRestart,omitempty"`
-
- // OnHostMaintenance: Defines the maintenance behavior for this
- // instance. For standard instances, the default behavior is MIGRATE.
- // For preemptible instances, the default and only possible behavior is
- // TERMINATE. For more information, see Setting maintenance behavior.
- //
- // Possible values:
- // "MIGRATE"
- // "TERMINATE"
- OnHostMaintenance string `json:"onHostMaintenance,omitempty"`
-
- // Preemptible: Whether the instance is preemptible.
- Preemptible bool `json:"preemptible,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AutomaticRestart") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Scheduling) MarshalJSON() ([]byte, error) {
- type noMethod Scheduling
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SerialPortOutput: An instance's serial console output.
-type SerialPortOutput struct {
- // Contents: [Output Only] The contents of the console output.
- Contents string `json:"contents,omitempty"`
-
- // Kind: [Output Only] Type of the resource. Always
- // compute#serialPortOutput for serial port output.
- Kind string `json:"kind,omitempty"`
-
- // SelfLink: [Output Only] Server defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Contents") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SerialPortOutput) MarshalJSON() ([]byte, error) {
- type noMethod SerialPortOutput
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ServiceAccount: A service account.
-type ServiceAccount struct {
- // Email: Email address of the service account.
- Email string `json:"email,omitempty"`
-
- // Scopes: The list of scopes to be made available for this service
- // account.
- Scopes []string `json:"scopes,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Email") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ServiceAccount) MarshalJSON() ([]byte, error) {
- type noMethod ServiceAccount
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Snapshot: A persistent disk snapshot resource.
-type Snapshot struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // DiskSizeGb: [Output Only] Size of the snapshot, specified in GB.
- DiskSizeGb int64 `json:"diskSizeGb,omitempty,string"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always compute#snapshot for
- // Snapshot resources.
- Kind string `json:"kind,omitempty"`
-
- // Licenses: Public visible licenses.
- Licenses []string `json:"licenses,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // SourceDisk: The source disk used to create this snapshot.
- SourceDisk string `json:"sourceDisk,omitempty"`
-
- // SourceDiskId: [Output Only] The ID value of the disk used to create
- // this snapshot. This value may be used to determine whether the
- // snapshot was taken from the current or a previous instance of a given
- // disk name.
- SourceDiskId string `json:"sourceDiskId,omitempty"`
-
- // Status: [Output Only] The status of the snapshot.
- //
- // Possible values:
- // "CREATING"
- // "DELETING"
- // "FAILED"
- // "READY"
- // "UPLOADING"
- Status string `json:"status,omitempty"`
-
- // StorageBytes: [Output Only] A size of the the storage used by the
- // snapshot. As snapshots share storage, this number is expected to
- // change with snapshot creation/deletion.
- StorageBytes int64 `json:"storageBytes,omitempty,string"`
-
- // StorageBytesStatus: [Output Only] An indicator whether storageBytes
- // is in a stable state or it is being adjusted as a result of shared
- // storage reallocation.
- //
- // Possible values:
- // "UPDATING"
- // "UP_TO_DATE"
- StorageBytesStatus string `json:"storageBytesStatus,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Snapshot) MarshalJSON() ([]byte, error) {
- type noMethod Snapshot
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SnapshotList: Contains a list of Snapshot resources.
-type SnapshotList struct {
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A list of Snapshot resources.
- Items []*Snapshot `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SnapshotList) MarshalJSON() ([]byte, error) {
- type noMethod SnapshotList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SslCertificate: An SslCertificate resource. This resource provides a
-// mechanism to upload an SSL key and certificate to global HTTPS
-// loadbalancer to serve secure connections.
-type SslCertificate struct {
- // Certificate: A local certificate file. The certificate must be in PEM
- // format. The certificate chain must be no greater than 5 certs long.
- // The chain must include at least one intermediate cert.
- Certificate string `json:"certificate,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource.
- // Provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always
- // compute#sslCertificate for SSL certificates.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource. Provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // PrivateKey: A write-only private key in PEM format. Only insert RPCs
- // will include this field.
- PrivateKey string `json:"privateKey,omitempty"`
-
- // SelfLink: [Output only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Certificate") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SslCertificate) MarshalJSON() ([]byte, error) {
- type noMethod SslCertificate
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SslCertificateList: Contains a list of SslCertificate resources.
-type SslCertificateList struct {
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A list of SslCertificate resources.
- Items []*SslCertificate `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SslCertificateList) MarshalJSON() ([]byte, error) {
- type noMethod SslCertificateList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Tags: A set of instance tags.
-type Tags struct {
- // Fingerprint: Specifies a fingerprint for this request, which is
- // essentially a hash of the metadata's contents and used for optimistic
- // locking. The fingerprint is initially generated by Compute Engine and
- // changes after every request to modify or update metadata. You must
- // always provide an up-to-date fingerprint hash in order to update or
- // change metadata.
- //
- // To see the latest fingerprint, make get() request to the instance.
- Fingerprint string `json:"fingerprint,omitempty"`
-
- // Items: An array of tags. Each tag must be 1-63 characters long, and
- // comply with RFC1035.
- Items []string `json:"items,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Fingerprint") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Tags) MarshalJSON() ([]byte, error) {
- type noMethod Tags
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetHttpProxy: A TargetHttpProxy resource. This resource defines an
-// HTTP proxy.
-type TargetHttpProxy struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of resource. Always compute#operation for
- // Operation resources.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // UrlMap: URL to the UrlMap resource that defines the mapping from URL
- // to the BackendService.
- UrlMap string `json:"urlMap,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetHttpProxy) MarshalJSON() ([]byte, error) {
- type noMethod TargetHttpProxy
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetHttpProxyList: A list of TargetHttpProxy resources.
-type TargetHttpProxyList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A list of TargetHttpProxy resources.
- Items []*TargetHttpProxy `json:"items,omitempty"`
-
- // Kind: Type of resource. Always compute#targetHttpProxyList for lists
- // of Target HTTP proxies.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetHttpProxyList) MarshalJSON() ([]byte, error) {
- type noMethod TargetHttpProxyList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetHttpsProxiesSetSslCertificatesRequest struct {
- // SslCertificates: New set of URLs to SslCertificate resources to
- // associate with this TargetHttpProxy. Currently exactly one ssl
- // certificate must be specified.
- SslCertificates []string `json:"sslCertificates,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "SslCertificates") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetHttpsProxiesSetSslCertificatesRequest) MarshalJSON() ([]byte, error) {
- type noMethod TargetHttpsProxiesSetSslCertificatesRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetHttpsProxy: A TargetHttpsProxy resource. This resource defines
-// an HTTPS proxy.
-type TargetHttpsProxy struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource.
- // Provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: Type of the resource.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource. Provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // SslCertificates: URLs to SslCertificate resources that are used to
- // authenticate connections to Backends. Currently exactly one SSL
- // certificate must be specified.
- SslCertificates []string `json:"sslCertificates,omitempty"`
-
- // UrlMap: URL to the UrlMap resource that defines the mapping from URL
- // to the BackendService.
- UrlMap string `json:"urlMap,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetHttpsProxy) MarshalJSON() ([]byte, error) {
- type noMethod TargetHttpsProxy
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetHttpsProxyList: Contains a list of TargetHttpsProxy resources.
-type TargetHttpsProxyList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A list of TargetHttpsProxy resources.
- Items []*TargetHttpsProxy `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetHttpsProxyList) MarshalJSON() ([]byte, error) {
- type noMethod TargetHttpsProxyList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetInstance: A TargetInstance resource. This resource defines an
-// endpoint instance that terminates traffic of certain protocols.
-type TargetInstance struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Instance: The URL to the instance that terminates the relevant
- // traffic.
- Instance string `json:"instance,omitempty"`
-
- // Kind: Type of the resource.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource. Provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // NatPolicy: NAT option controlling how IPs are NAT'ed to the instance.
- // Currently only NO_NAT (default value) is supported.
- //
- // Possible values:
- // "NO_NAT"
- NatPolicy string `json:"natPolicy,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Zone: [Output Only] URL of the zone where the target instance
- // resides.
- Zone string `json:"zone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetInstance) MarshalJSON() ([]byte, error) {
- type noMethod TargetInstance
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetInstanceAggregatedList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A map of scoped target instance lists.
- Items map[string]TargetInstancesScopedList `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetInstanceAggregatedList) MarshalJSON() ([]byte, error) {
- type noMethod TargetInstanceAggregatedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetInstanceList: Contains a list of TargetInstance resources.
-type TargetInstanceList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A list of TargetInstance resources.
- Items []*TargetInstance `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetInstanceList) MarshalJSON() ([]byte, error) {
- type noMethod TargetInstanceList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetInstancesScopedList struct {
- // TargetInstances: List of target instances contained in this scope.
- TargetInstances []*TargetInstance `json:"targetInstances,omitempty"`
-
- // Warning: Informational warning which replaces the list of addresses
- // when the list is empty.
- Warning *TargetInstancesScopedListWarning `json:"warning,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "TargetInstances") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetInstancesScopedList) MarshalJSON() ([]byte, error) {
- type noMethod TargetInstancesScopedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetInstancesScopedListWarning: Informational warning which
-// replaces the list of addresses when the list is empty.
-type TargetInstancesScopedListWarning struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*TargetInstancesScopedListWarningData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetInstancesScopedListWarning) MarshalJSON() ([]byte, error) {
- type noMethod TargetInstancesScopedListWarning
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetInstancesScopedListWarningData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetInstancesScopedListWarningData) MarshalJSON() ([]byte, error) {
- type noMethod TargetInstancesScopedListWarningData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetPool: A TargetPool resource. This resource defines a pool of
-// instances, associated HttpHealthCheck resources, and the fallback
-// TargetPool.
-type TargetPool struct {
- // BackupPool: This field is applicable only when the containing target
- // pool is serving a forwarding rule as the primary pool, and its
- // failoverRatio field is properly set to a value between [0,
- // 1].
- //
- // backupPool and failoverRatio together define the fallback behavior of
- // the primary target pool: if the ratio of the healthy instances in the
- // primary pool is at or below failoverRatio, traffic arriving at the
- // load-balanced IP will be directed to the backup pool.
- //
- // In case where failoverRatio and backupPool are not set, or all the
- // instances in the backup pool are unhealthy, the traffic will be
- // directed back to the primary pool in the "force" mode, where traffic
- // will be spread to the healthy instances with the best effort, or to
- // all instances when no instance is healthy.
- BackupPool string `json:"backupPool,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource;
- // provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // FailoverRatio: This field is applicable only when the containing
- // target pool is serving a forwarding rule as the primary pool (i.e.,
- // not as a backup pool to some other target pool). The value of the
- // field must be in [0, 1].
- //
- // If set, backupPool must also be set. They together define the
- // fallback behavior of the primary target pool: if the ratio of the
- // healthy instances in the primary pool is at or below this number,
- // traffic arriving at the load-balanced IP will be directed to the
- // backup pool.
- //
- // In case where failoverRatio is not set or all the instances in the
- // backup pool are unhealthy, the traffic will be directed back to the
- // primary pool in the "force" mode, where traffic will be spread to the
- // healthy instances with the best effort, or to all instances when no
- // instance is healthy.
- FailoverRatio float64 `json:"failoverRatio,omitempty"`
-
- // HealthChecks: A list of URLs to the HttpHealthCheck resource. A
- // member instance in this pool is considered healthy if and only if all
- // specified health checks pass. An empty list means all member
- // instances will be considered healthy at all times.
- HealthChecks []string `json:"healthChecks,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Instances: A list of resource URLs to the member virtual machines
- // serving this pool. They must live in zones contained in the same
- // region as this pool.
- Instances []string `json:"instances,omitempty"`
-
- // Kind: Type of the resource.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource. Provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // Region: [Output Only] URL of the region where the target pool
- // resides.
- Region string `json:"region,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // SessionAffinity: Sesssion affinity option, must be one of the
- // following values:
- // NONE: Connections from the same client IP may go to any instance in
- // the pool.
- // CLIENT_IP: Connections from the same client IP will go to the same
- // instance in the pool while that instance remains
- // healthy.
- // CLIENT_IP_PROTO: Connections from the same client IP with the same IP
- // protocol will go to the same instance in the pool while that instance
- // remains healthy.
- //
- // Possible values:
- // "CLIENT_IP"
- // "CLIENT_IP_PROTO"
- // "NONE"
- SessionAffinity string `json:"sessionAffinity,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "BackupPool") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetPool) MarshalJSON() ([]byte, error) {
- type noMethod TargetPool
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetPoolAggregatedList struct {
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A map of scoped target pool lists.
- Items map[string]TargetPoolsScopedList `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetPoolAggregatedList) MarshalJSON() ([]byte, error) {
- type noMethod TargetPoolAggregatedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetPoolInstanceHealth struct {
- HealthStatus []*HealthStatus `json:"healthStatus,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "HealthStatus") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetPoolInstanceHealth) MarshalJSON() ([]byte, error) {
- type noMethod TargetPoolInstanceHealth
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetPoolList: Contains a list of TargetPool resources.
-type TargetPoolList struct {
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A list of TargetPool resources.
- Items []*TargetPool `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetPoolList) MarshalJSON() ([]byte, error) {
- type noMethod TargetPoolList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetPoolsAddHealthCheckRequest struct {
- // HealthChecks: Health check URLs to be added to targetPool.
- HealthChecks []*HealthCheckReference `json:"healthChecks,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "HealthChecks") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetPoolsAddHealthCheckRequest) MarshalJSON() ([]byte, error) {
- type noMethod TargetPoolsAddHealthCheckRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetPoolsAddInstanceRequest struct {
- // Instances: URLs of the instances to be added to targetPool.
- Instances []*InstanceReference `json:"instances,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Instances") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetPoolsAddInstanceRequest) MarshalJSON() ([]byte, error) {
- type noMethod TargetPoolsAddInstanceRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetPoolsRemoveHealthCheckRequest struct {
- // HealthChecks: Health check URLs to be removed from targetPool.
- HealthChecks []*HealthCheckReference `json:"healthChecks,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "HealthChecks") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetPoolsRemoveHealthCheckRequest) MarshalJSON() ([]byte, error) {
- type noMethod TargetPoolsRemoveHealthCheckRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetPoolsRemoveInstanceRequest struct {
- // Instances: URLs of the instances to be removed from targetPool.
- Instances []*InstanceReference `json:"instances,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Instances") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetPoolsRemoveInstanceRequest) MarshalJSON() ([]byte, error) {
- type noMethod TargetPoolsRemoveInstanceRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetPoolsScopedList struct {
- // TargetPools: List of target pools contained in this scope.
- TargetPools []*TargetPool `json:"targetPools,omitempty"`
-
- // Warning: Informational warning which replaces the list of addresses
- // when the list is empty.
- Warning *TargetPoolsScopedListWarning `json:"warning,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "TargetPools") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetPoolsScopedList) MarshalJSON() ([]byte, error) {
- type noMethod TargetPoolsScopedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetPoolsScopedListWarning: Informational warning which replaces
-// the list of addresses when the list is empty.
-type TargetPoolsScopedListWarning struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*TargetPoolsScopedListWarningData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetPoolsScopedListWarning) MarshalJSON() ([]byte, error) {
- type noMethod TargetPoolsScopedListWarning
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetPoolsScopedListWarningData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetPoolsScopedListWarningData) MarshalJSON() ([]byte, error) {
- type noMethod TargetPoolsScopedListWarningData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetReference struct {
- Target string `json:"target,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Target") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetReference) MarshalJSON() ([]byte, error) {
- type noMethod TargetReference
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetVpnGateway struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource.
- // Provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // ForwardingRules: [Output Only] A list of URLs to the ForwardingRule
- // resources. ForwardingRules are created using
- // compute.forwardingRules.insert and associated to a VPN gateway.
- ForwardingRules []string `json:"forwardingRules,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of resource. Always compute#targetVpnGateway
- // for target VPN gateways.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // Network: URL of the network to which this VPN gateway is attached.
- // Provided by the client when the VPN gateway is created.
- Network string `json:"network,omitempty"`
-
- // Region: [Output Only] URL of the region where the target VPN gateway
- // resides.
- Region string `json:"region,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Status: [Output Only] The status of the VPN gateway.
- //
- // Possible values:
- // "CREATING"
- // "DELETING"
- // "FAILED"
- // "READY"
- Status string `json:"status,omitempty"`
-
- // Tunnels: [Output Only] A list of URLs to VpnTunnel resources.
- // VpnTunnels are created using compute.vpntunnels.insert and associated
- // to a VPN gateway.
- Tunnels []string `json:"tunnels,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetVpnGateway) MarshalJSON() ([]byte, error) {
- type noMethod TargetVpnGateway
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetVpnGatewayAggregatedList struct {
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A map of scoped target vpn gateway lists.
- Items map[string]TargetVpnGatewaysScopedList `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#targetVpnGateway
- // for target VPN gateways.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetVpnGatewayAggregatedList) MarshalJSON() ([]byte, error) {
- type noMethod TargetVpnGatewayAggregatedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetVpnGatewayList: Contains a list of TargetVpnGateway resources.
-type TargetVpnGatewayList struct {
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of TargetVpnGateway resources.
- Items []*TargetVpnGateway `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#targetVpnGateway
- // for target VPN gateways.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetVpnGatewayList) MarshalJSON() ([]byte, error) {
- type noMethod TargetVpnGatewayList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetVpnGatewaysScopedList struct {
- // TargetVpnGateways: [Output Only] List of target vpn gateways
- // contained in this scope.
- TargetVpnGateways []*TargetVpnGateway `json:"targetVpnGateways,omitempty"`
-
- // Warning: [Output Only] Informational warning which replaces the list
- // of addresses when the list is empty.
- Warning *TargetVpnGatewaysScopedListWarning `json:"warning,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "TargetVpnGateways")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetVpnGatewaysScopedList) MarshalJSON() ([]byte, error) {
- type noMethod TargetVpnGatewaysScopedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetVpnGatewaysScopedListWarning: [Output Only] Informational
-// warning which replaces the list of addresses when the list is empty.
-type TargetVpnGatewaysScopedListWarning struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*TargetVpnGatewaysScopedListWarningData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetVpnGatewaysScopedListWarning) MarshalJSON() ([]byte, error) {
- type noMethod TargetVpnGatewaysScopedListWarning
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetVpnGatewaysScopedListWarningData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetVpnGatewaysScopedListWarningData) MarshalJSON() ([]byte, error) {
- type noMethod TargetVpnGatewaysScopedListWarningData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TestFailure struct {
- ActualService string `json:"actualService,omitempty"`
-
- ExpectedService string `json:"expectedService,omitempty"`
-
- Host string `json:"host,omitempty"`
-
- Path string `json:"path,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ActualService") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TestFailure) MarshalJSON() ([]byte, error) {
- type noMethod TestFailure
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UrlMap: A UrlMap resource. This resource defines the mapping from URL
-// to the BackendService resource, based on the "longest-match" of the
-// URL's host and path.
-type UrlMap struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // DefaultService: The URL of the BackendService resource if none of the
- // hostRules match.
- DefaultService string `json:"defaultService,omitempty"`
-
- // Description: An optional textual description of the resource.
- // Provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // Fingerprint: Fingerprint of this resource. A hash of the contents
- // stored in this object. This field is used in optimistic locking. This
- // field will be ignored when inserting a UrlMap. An up-to-date
- // fingerprint must be provided in order to update the UrlMap.
- Fingerprint string `json:"fingerprint,omitempty"`
-
- // HostRules: The list of HostRules to use against the URL.
- HostRules []*HostRule `json:"hostRules,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource. Set by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: Type of the resource.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource. Provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // PathMatchers: The list of named PathMatchers to use against the URL.
- PathMatchers []*PathMatcher `json:"pathMatchers,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Tests: The list of expected URL mappings. Request to update this
- // UrlMap will succeed only all of the test cases pass.
- Tests []*UrlMapTest `json:"tests,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlMap) MarshalJSON() ([]byte, error) {
- type noMethod UrlMap
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UrlMapList: Contains a list of UrlMap resources.
-type UrlMapList struct {
- // Id: [Output Only] Unique identifier for the resource. Set by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: A list of UrlMap resources.
- Items []*UrlMap `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlMapList) MarshalJSON() ([]byte, error) {
- type noMethod UrlMapList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UrlMapReference struct {
- UrlMap string `json:"urlMap,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "UrlMap") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlMapReference) MarshalJSON() ([]byte, error) {
- type noMethod UrlMapReference
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UrlMapTest: Message for the expected URL mappings.
-type UrlMapTest struct {
- // Description: Description of this test case.
- Description string `json:"description,omitempty"`
-
- // Host: Host portion of the URL.
- Host string `json:"host,omitempty"`
-
- // Path: Path portion of the URL.
- Path string `json:"path,omitempty"`
-
- // Service: Expected BackendService resource the given URL should be
- // mapped to.
- Service string `json:"service,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Description") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlMapTest) MarshalJSON() ([]byte, error) {
- type noMethod UrlMapTest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UrlMapValidationResult: Message representing the validation result
-// for a UrlMap.
-type UrlMapValidationResult struct {
- LoadErrors []string `json:"loadErrors,omitempty"`
-
- // LoadSucceeded: Whether the given UrlMap can be successfully loaded.
- // If false, 'loadErrors' indicates the reasons.
- LoadSucceeded bool `json:"loadSucceeded,omitempty"`
-
- TestFailures []*TestFailure `json:"testFailures,omitempty"`
-
- // TestPassed: If successfully loaded, this field indicates whether the
- // test passed. If false, 'testFailures's indicate the reason of
- // failure.
- TestPassed bool `json:"testPassed,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "LoadErrors") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlMapValidationResult) MarshalJSON() ([]byte, error) {
- type noMethod UrlMapValidationResult
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UrlMapsValidateRequest struct {
- // Resource: Content of the UrlMap to be validated.
- Resource *UrlMap `json:"resource,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Resource") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlMapsValidateRequest) MarshalJSON() ([]byte, error) {
- type noMethod UrlMapsValidateRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type UrlMapsValidateResponse struct {
- Result *UrlMapValidationResult `json:"result,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Result") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UrlMapsValidateResponse) MarshalJSON() ([]byte, error) {
- type noMethod UrlMapsValidateResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UsageExportLocation: The location in Cloud Storage and naming method
-// of the daily usage report. Contains bucket_name and report_name
-// prefix.
-type UsageExportLocation struct {
- // BucketName: The name of an existing bucket in Cloud Storage where the
- // usage report object is stored. The Google Service Account is granted
- // write access to this bucket. This is just the bucket name, with no
- // gs:// or https://storage.googleapis.com/ in front of it.
- BucketName string `json:"bucketName,omitempty"`
-
- // ReportNamePrefix: An optional prefix for the name of the usage report
- // object stored in bucketName. If not supplied, defaults to usage. The
- // report is stored as a CSV file named
- // report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the
- // usage according to Pacific Time. If you supply a prefix, it should
- // conform to Cloud Storage object naming conventions.
- ReportNamePrefix string `json:"reportNamePrefix,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BucketName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UsageExportLocation) MarshalJSON() ([]byte, error) {
- type noMethod UsageExportLocation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type VpnTunnel struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional textual description of the resource.
- // Provided by the client when the resource is created.
- Description string `json:"description,omitempty"`
-
- // DetailedStatus: [Output Only] Detailed status message for the VPN
- // tunnel.
- DetailedStatus string `json:"detailedStatus,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource. Defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // IkeVersion: IKE protocol version to use when establishing the VPN
- // tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2.
- // Default version is 2.
- IkeVersion int64 `json:"ikeVersion,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#vpnTunnel for
- // VPN tunnels.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // PeerIp: IP address of the peer VPN gateway.
- PeerIp string `json:"peerIp,omitempty"`
-
- // Region: [Output Only] URL of the region where the VPN tunnel resides.
- Region string `json:"region,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // SharedSecret: Shared secret used to set the secure session between
- // the GCE VPN gateway and the peer VPN gateway.
- SharedSecret string `json:"sharedSecret,omitempty"`
-
- // SharedSecretHash: Hash of the shared secret.
- SharedSecretHash string `json:"sharedSecretHash,omitempty"`
-
- // Status: [Output Only] The status of the VPN tunnel.
- //
- // Possible values:
- // "AUTHORIZATION_ERROR"
- // "DEPROVISIONING"
- // "ESTABLISHED"
- // "FAILED"
- // "FIRST_HANDSHAKE"
- // "NEGOTIATION_FAILURE"
- // "NETWORK_ERROR"
- // "NO_INCOMING_PACKETS"
- // "PROVISIONING"
- // "REJECTED"
- // "WAITING_FOR_FULL_CONFIG"
- Status string `json:"status,omitempty"`
-
- // TargetVpnGateway: URL of the VPN gateway to which this VPN tunnel is
- // associated. Provided by the client when the VPN tunnel is created.
- TargetVpnGateway string `json:"targetVpnGateway,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VpnTunnel) MarshalJSON() ([]byte, error) {
- type noMethod VpnTunnel
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type VpnTunnelAggregatedList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A map of scoped vpn tunnel lists.
- Items map[string]VpnTunnelsScopedList `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#vpnTunnel for
- // VPN tunnels.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VpnTunnelAggregatedList) MarshalJSON() ([]byte, error) {
- type noMethod VpnTunnelAggregatedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// VpnTunnelList: Contains a list of VpnTunnel resources.
-type VpnTunnelList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of VpnTunnel resources.
- Items []*VpnTunnel `json:"items,omitempty"`
-
- // Kind: [Output Only] Type of resource. Always compute#vpnTunnel for
- // VPN tunnels.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VpnTunnelList) MarshalJSON() ([]byte, error) {
- type noMethod VpnTunnelList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type VpnTunnelsScopedList struct {
- // VpnTunnels: List of vpn tunnels contained in this scope.
- VpnTunnels []*VpnTunnel `json:"vpnTunnels,omitempty"`
-
- // Warning: Informational warning which replaces the list of addresses
- // when the list is empty.
- Warning *VpnTunnelsScopedListWarning `json:"warning,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "VpnTunnels") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VpnTunnelsScopedList) MarshalJSON() ([]byte, error) {
- type noMethod VpnTunnelsScopedList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// VpnTunnelsScopedListWarning: Informational warning which replaces the
-// list of addresses when the list is empty.
-type VpnTunnelsScopedListWarning struct {
- // Code: [Output Only] The warning type identifier for this warning.
- //
- // Possible values:
- // "DEPRECATED_RESOURCE_USED"
- // "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"
- // "INJECTED_KERNELS_DEPRECATED"
- // "NEXT_HOP_ADDRESS_NOT_ASSIGNED"
- // "NEXT_HOP_CANNOT_IP_FORWARD"
- // "NEXT_HOP_INSTANCE_NOT_FOUND"
- // "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"
- // "NEXT_HOP_NOT_RUNNING"
- // "NOT_CRITICAL_ERROR"
- // "NO_RESULTS_ON_PAGE"
- // "REQUIRED_TOS_AGREEMENT"
- // "RESOURCE_NOT_DELETED"
- // "SINGLE_INSTANCE_PROPERTY_TEMPLATE"
- // "UNREACHABLE"
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*VpnTunnelsScopedListWarningData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VpnTunnelsScopedListWarning) MarshalJSON() ([]byte, error) {
- type noMethod VpnTunnelsScopedListWarning
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type VpnTunnelsScopedListWarningData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *VpnTunnelsScopedListWarningData) MarshalJSON() ([]byte, error) {
- type noMethod VpnTunnelsScopedListWarningData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Zone: A Zone resource.
-type Zone struct {
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Deprecated: [Output Only] The deprecation status associated with this
- // zone.
- Deprecated *DeprecationStatus `json:"deprecated,omitempty"`
-
- // Description: [Output Only] Textual description of the resource.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: [Output Only] Type of the resource. Always kind#zone for zones.
- Kind string `json:"kind,omitempty"`
-
- // MaintenanceWindows: [Output Only] Any scheduled maintenance windows
- // for this zone. When the zone is in a maintenance window, all
- // resources which reside in the zone will be unavailable. For more
- // information, see Maintenance Windows
- MaintenanceWindows []*ZoneMaintenanceWindows `json:"maintenanceWindows,omitempty"`
-
- // Name: [Output Only] Name of the resource.
- Name string `json:"name,omitempty"`
-
- // Region: [Output Only] Full URL reference to the region which hosts
- // the zone.
- Region string `json:"region,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Status: [Output Only] Status of the zone, either UP or DOWN.
- //
- // Possible values:
- // "DOWN"
- // "UP"
- Status string `json:"status,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Zone) MarshalJSON() ([]byte, error) {
- type noMethod Zone
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ZoneMaintenanceWindows struct {
- // BeginTime: [Output Only] Starting time of the maintenance window, in
- // RFC3339 format.
- BeginTime string `json:"beginTime,omitempty"`
-
- // Description: [Output Only] Textual description of the maintenance
- // window.
- Description string `json:"description,omitempty"`
-
- // EndTime: [Output Only] Ending time of the maintenance window, in
- // RFC3339 format.
- EndTime string `json:"endTime,omitempty"`
-
- // Name: [Output Only] Name of the maintenance window.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BeginTime") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ZoneMaintenanceWindows) MarshalJSON() ([]byte, error) {
- type noMethod ZoneMaintenanceWindows
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ZoneList: Contains a list of zone resources.
-type ZoneList struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id string `json:"id,omitempty"`
-
- // Items: [Output Only] A list of Zone resources.
- Items []*Zone `json:"items,omitempty"`
-
- // Kind: Type of resource.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for this resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ZoneList) MarshalJSON() ([]byte, error) {
- type noMethod ZoneList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "compute.addresses.aggregatedList":
-
-type AddressesAggregatedListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AggregatedList: Retrieves the list of addresses grouped by scope.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/addresses/aggregatedList
-func (r *AddressesService) AggregatedList(project string) *AddressesAggregatedListCall {
- c := &AddressesAggregatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *AddressesAggregatedListCall) Filter(filter string) *AddressesAggregatedListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *AddressesAggregatedListCall) MaxResults(maxResults int64) *AddressesAggregatedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *AddressesAggregatedListCall) PageToken(pageToken string) *AddressesAggregatedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AddressesAggregatedListCall) Fields(s ...googleapi.Field) *AddressesAggregatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AddressesAggregatedListCall) IfNoneMatch(entityTag string) *AddressesAggregatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AddressesAggregatedListCall) Context(ctx context.Context) *AddressesAggregatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AddressesAggregatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/aggregated/addresses")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.addresses.aggregatedList" call.
-// Exactly one of *AddressAggregatedList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AddressAggregatedList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AddressesAggregatedListCall) Do() (*AddressAggregatedList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AddressAggregatedList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of addresses grouped by scope.",
- // "httpMethod": "GET",
- // "id": "compute.addresses.aggregatedList",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/aggregated/addresses",
- // "response": {
- // "$ref": "AddressAggregatedList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.addresses.delete":
-
-type AddressesDeleteCall struct {
- s *Service
- project string
- region string
- address string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified address resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/addresses/delete
-func (r *AddressesService) Delete(project string, region string, address string) *AddressesDeleteCall {
- c := &AddressesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.address = address
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AddressesDeleteCall) Fields(s ...googleapi.Field) *AddressesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AddressesDeleteCall) Context(ctx context.Context) *AddressesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AddressesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/addresses/{address}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "address": c.address,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.addresses.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AddressesDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified address resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.addresses.delete",
- // "parameterOrder": [
- // "project",
- // "region",
- // "address"
- // ],
- // "parameters": {
- // "address": {
- // "description": "Name of the address resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "The name of the region for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/addresses/{address}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.addresses.get":
-
-type AddressesGetCall struct {
- s *Service
- project string
- region string
- address string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified address resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/addresses/get
-func (r *AddressesService) Get(project string, region string, address string) *AddressesGetCall {
- c := &AddressesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.address = address
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AddressesGetCall) Fields(s ...googleapi.Field) *AddressesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AddressesGetCall) IfNoneMatch(entityTag string) *AddressesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AddressesGetCall) Context(ctx context.Context) *AddressesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AddressesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/addresses/{address}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "address": c.address,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.addresses.get" call.
-// Exactly one of *Address or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Address.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AddressesGetCall) Do() (*Address, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Address{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified address resource.",
- // "httpMethod": "GET",
- // "id": "compute.addresses.get",
- // "parameterOrder": [
- // "project",
- // "region",
- // "address"
- // ],
- // "parameters": {
- // "address": {
- // "description": "Name of the address resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "The name of the region for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/addresses/{address}",
- // "response": {
- // "$ref": "Address"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.addresses.insert":
-
-type AddressesInsertCall struct {
- s *Service
- project string
- region string
- address *Address
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates an address resource in the specified project using
-// the data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/addresses/insert
-func (r *AddressesService) Insert(project string, region string, address *Address) *AddressesInsertCall {
- c := &AddressesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.address = address
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AddressesInsertCall) Fields(s ...googleapi.Field) *AddressesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AddressesInsertCall) Context(ctx context.Context) *AddressesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AddressesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.address)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/addresses")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.addresses.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AddressesInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates an address resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.addresses.insert",
- // "parameterOrder": [
- // "project",
- // "region"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "The name of the region for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/addresses",
- // "request": {
- // "$ref": "Address"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.addresses.list":
-
-type AddressesListCall struct {
- s *Service
- project string
- region string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of address resources contained within the
-// specified region.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/addresses/list
-func (r *AddressesService) List(project string, region string) *AddressesListCall {
- c := &AddressesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *AddressesListCall) Filter(filter string) *AddressesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *AddressesListCall) MaxResults(maxResults int64) *AddressesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *AddressesListCall) PageToken(pageToken string) *AddressesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AddressesListCall) Fields(s ...googleapi.Field) *AddressesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AddressesListCall) IfNoneMatch(entityTag string) *AddressesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AddressesListCall) Context(ctx context.Context) *AddressesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AddressesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/addresses")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.addresses.list" call.
-// Exactly one of *AddressList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AddressList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AddressesListCall) Do() (*AddressList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AddressList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of address resources contained within the specified region.",
- // "httpMethod": "GET",
- // "id": "compute.addresses.list",
- // "parameterOrder": [
- // "project",
- // "region"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "The name of the region for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/addresses",
- // "response": {
- // "$ref": "AddressList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.autoscalers.aggregatedList":
-
-type AutoscalersAggregatedListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AggregatedList: Retrieves the list of autoscalers grouped by scope.
-func (r *AutoscalersService) AggregatedList(project string) *AutoscalersAggregatedListCall {
- c := &AutoscalersAggregatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *AutoscalersAggregatedListCall) Filter(filter string) *AutoscalersAggregatedListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *AutoscalersAggregatedListCall) MaxResults(maxResults int64) *AutoscalersAggregatedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *AutoscalersAggregatedListCall) PageToken(pageToken string) *AutoscalersAggregatedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AutoscalersAggregatedListCall) Fields(s ...googleapi.Field) *AutoscalersAggregatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AutoscalersAggregatedListCall) IfNoneMatch(entityTag string) *AutoscalersAggregatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AutoscalersAggregatedListCall) Context(ctx context.Context) *AutoscalersAggregatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AutoscalersAggregatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/aggregated/autoscalers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.autoscalers.aggregatedList" call.
-// Exactly one of *AutoscalerAggregatedList or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *AutoscalerAggregatedList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AutoscalersAggregatedListCall) Do() (*AutoscalerAggregatedList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AutoscalerAggregatedList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of autoscalers grouped by scope.",
- // "httpMethod": "GET",
- // "id": "compute.autoscalers.aggregatedList",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/aggregated/autoscalers",
- // "response": {
- // "$ref": "AutoscalerAggregatedList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.autoscalers.delete":
-
-type AutoscalersDeleteCall struct {
- s *Service
- project string
- zone string
- autoscaler string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified autoscaler resource.
-func (r *AutoscalersService) Delete(project string, zone string, autoscaler string) *AutoscalersDeleteCall {
- c := &AutoscalersDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.autoscaler = autoscaler
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AutoscalersDeleteCall) Fields(s ...googleapi.Field) *AutoscalersDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AutoscalersDeleteCall) Context(ctx context.Context) *AutoscalersDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AutoscalersDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/autoscalers/{autoscaler}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "autoscaler": c.autoscaler,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.autoscalers.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AutoscalersDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified autoscaler resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.autoscalers.delete",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "autoscaler"
- // ],
- // "parameters": {
- // "autoscaler": {
- // "description": "Name of the persistent autoscaler resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/autoscalers/{autoscaler}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.autoscalers.get":
-
-type AutoscalersGetCall struct {
- s *Service
- project string
- zone string
- autoscaler string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified autoscaler resource.
-func (r *AutoscalersService) Get(project string, zone string, autoscaler string) *AutoscalersGetCall {
- c := &AutoscalersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.autoscaler = autoscaler
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AutoscalersGetCall) Fields(s ...googleapi.Field) *AutoscalersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AutoscalersGetCall) IfNoneMatch(entityTag string) *AutoscalersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AutoscalersGetCall) Context(ctx context.Context) *AutoscalersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AutoscalersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/autoscalers/{autoscaler}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "autoscaler": c.autoscaler,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.autoscalers.get" call.
-// Exactly one of *Autoscaler or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Autoscaler.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AutoscalersGetCall) Do() (*Autoscaler, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Autoscaler{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified autoscaler resource.",
- // "httpMethod": "GET",
- // "id": "compute.autoscalers.get",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "autoscaler"
- // ],
- // "parameters": {
- // "autoscaler": {
- // "description": "Name of the persistent autoscaler resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/autoscalers/{autoscaler}",
- // "response": {
- // "$ref": "Autoscaler"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.autoscalers.insert":
-
-type AutoscalersInsertCall struct {
- s *Service
- project string
- zone string
- autoscaler *Autoscaler
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates an autoscaler resource in the specified project using
-// the data included in the request.
-func (r *AutoscalersService) Insert(project string, zone string, autoscaler *Autoscaler) *AutoscalersInsertCall {
- c := &AutoscalersInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.autoscaler = autoscaler
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AutoscalersInsertCall) Fields(s ...googleapi.Field) *AutoscalersInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AutoscalersInsertCall) Context(ctx context.Context) *AutoscalersInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AutoscalersInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.autoscaler)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/autoscalers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.autoscalers.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AutoscalersInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates an autoscaler resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.autoscalers.insert",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/autoscalers",
- // "request": {
- // "$ref": "Autoscaler"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.autoscalers.list":
-
-type AutoscalersListCall struct {
- s *Service
- project string
- zone string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of autoscaler resources contained within the
-// specified zone.
-func (r *AutoscalersService) List(project string, zone string) *AutoscalersListCall {
- c := &AutoscalersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *AutoscalersListCall) Filter(filter string) *AutoscalersListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *AutoscalersListCall) MaxResults(maxResults int64) *AutoscalersListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *AutoscalersListCall) PageToken(pageToken string) *AutoscalersListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AutoscalersListCall) Fields(s ...googleapi.Field) *AutoscalersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AutoscalersListCall) IfNoneMatch(entityTag string) *AutoscalersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AutoscalersListCall) Context(ctx context.Context) *AutoscalersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AutoscalersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/autoscalers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.autoscalers.list" call.
-// Exactly one of *AutoscalerList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AutoscalerList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AutoscalersListCall) Do() (*AutoscalerList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AutoscalerList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of autoscaler resources contained within the specified zone.",
- // "httpMethod": "GET",
- // "id": "compute.autoscalers.list",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/autoscalers",
- // "response": {
- // "$ref": "AutoscalerList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.autoscalers.patch":
-
-type AutoscalersPatchCall struct {
- s *Service
- project string
- zone string
- autoscaler string
- autoscaler2 *Autoscaler
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an autoscaler resource in the specified project using
-// the data included in the request. This method supports patch
-// semantics.
-func (r *AutoscalersService) Patch(project string, zone string, autoscaler string, autoscaler2 *Autoscaler) *AutoscalersPatchCall {
- c := &AutoscalersPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.autoscaler = autoscaler
- c.autoscaler2 = autoscaler2
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AutoscalersPatchCall) Fields(s ...googleapi.Field) *AutoscalersPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AutoscalersPatchCall) Context(ctx context.Context) *AutoscalersPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AutoscalersPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.autoscaler2)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("autoscaler", fmt.Sprintf("%v", c.autoscaler))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/autoscalers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.autoscalers.patch" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AutoscalersPatchCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an autoscaler resource in the specified project using the data included in the request. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "compute.autoscalers.patch",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "autoscaler"
- // ],
- // "parameters": {
- // "autoscaler": {
- // "description": "Name of the autoscaler resource to update.",
- // "location": "query",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/autoscalers",
- // "request": {
- // "$ref": "Autoscaler"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.autoscalers.update":
-
-type AutoscalersUpdateCall struct {
- s *Service
- project string
- zone string
- autoscaler *Autoscaler
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an autoscaler resource in the specified project using
-// the data included in the request.
-func (r *AutoscalersService) Update(project string, zone string, autoscaler *Autoscaler) *AutoscalersUpdateCall {
- c := &AutoscalersUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.autoscaler = autoscaler
- return c
-}
-
-// Autoscaler sets the optional parameter "autoscaler": Name of the
-// autoscaler resource to update.
-func (c *AutoscalersUpdateCall) Autoscaler(autoscaler string) *AutoscalersUpdateCall {
- c.opt_["autoscaler"] = autoscaler
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AutoscalersUpdateCall) Fields(s ...googleapi.Field) *AutoscalersUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AutoscalersUpdateCall) Context(ctx context.Context) *AutoscalersUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AutoscalersUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.autoscaler)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["autoscaler"]; ok {
- params.Set("autoscaler", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/autoscalers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.autoscalers.update" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AutoscalersUpdateCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an autoscaler resource in the specified project using the data included in the request.",
- // "httpMethod": "PUT",
- // "id": "compute.autoscalers.update",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "autoscaler": {
- // "description": "Name of the autoscaler resource to update.",
- // "location": "query",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/autoscalers",
- // "request": {
- // "$ref": "Autoscaler"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.backendServices.delete":
-
-type BackendServicesDeleteCall struct {
- s *Service
- project string
- backendService string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified BackendService resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/backendServices/delete
-func (r *BackendServicesService) Delete(project string, backendService string) *BackendServicesDeleteCall {
- c := &BackendServicesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.backendService = backendService
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BackendServicesDeleteCall) Fields(s ...googleapi.Field) *BackendServicesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BackendServicesDeleteCall) Context(ctx context.Context) *BackendServicesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BackendServicesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/backendServices/{backendService}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "backendService": c.backendService,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.backendServices.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *BackendServicesDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified BackendService resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.backendServices.delete",
- // "parameterOrder": [
- // "project",
- // "backendService"
- // ],
- // "parameters": {
- // "backendService": {
- // "description": "Name of the BackendService resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/backendServices/{backendService}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.backendServices.get":
-
-type BackendServicesGetCall struct {
- s *Service
- project string
- backendService string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified BackendService resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/backendServices/get
-func (r *BackendServicesService) Get(project string, backendService string) *BackendServicesGetCall {
- c := &BackendServicesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.backendService = backendService
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BackendServicesGetCall) Fields(s ...googleapi.Field) *BackendServicesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *BackendServicesGetCall) IfNoneMatch(entityTag string) *BackendServicesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BackendServicesGetCall) Context(ctx context.Context) *BackendServicesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BackendServicesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/backendServices/{backendService}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "backendService": c.backendService,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.backendServices.get" call.
-// Exactly one of *BackendService or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *BackendService.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *BackendServicesGetCall) Do() (*BackendService, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &BackendService{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified BackendService resource.",
- // "httpMethod": "GET",
- // "id": "compute.backendServices.get",
- // "parameterOrder": [
- // "project",
- // "backendService"
- // ],
- // "parameters": {
- // "backendService": {
- // "description": "Name of the BackendService resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/backendServices/{backendService}",
- // "response": {
- // "$ref": "BackendService"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.backendServices.getHealth":
-
-type BackendServicesGetHealthCall struct {
- s *Service
- project string
- backendService string
- resourcegroupreference *ResourceGroupReference
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetHealth: Gets the most recent health check results for this
-// BackendService.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/backendServices/getHealth
-func (r *BackendServicesService) GetHealth(project string, backendService string, resourcegroupreference *ResourceGroupReference) *BackendServicesGetHealthCall {
- c := &BackendServicesGetHealthCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.backendService = backendService
- c.resourcegroupreference = resourcegroupreference
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BackendServicesGetHealthCall) Fields(s ...googleapi.Field) *BackendServicesGetHealthCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BackendServicesGetHealthCall) Context(ctx context.Context) *BackendServicesGetHealthCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BackendServicesGetHealthCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.resourcegroupreference)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/backendServices/{backendService}/getHealth")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "backendService": c.backendService,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.backendServices.getHealth" call.
-// Exactly one of *BackendServiceGroupHealth or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *BackendServiceGroupHealth.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *BackendServicesGetHealthCall) Do() (*BackendServiceGroupHealth, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &BackendServiceGroupHealth{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the most recent health check results for this BackendService.",
- // "httpMethod": "POST",
- // "id": "compute.backendServices.getHealth",
- // "parameterOrder": [
- // "project",
- // "backendService"
- // ],
- // "parameters": {
- // "backendService": {
- // "description": "Name of the BackendService resource to which the queried instance belongs.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/backendServices/{backendService}/getHealth",
- // "request": {
- // "$ref": "ResourceGroupReference"
- // },
- // "response": {
- // "$ref": "BackendServiceGroupHealth"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.backendServices.insert":
-
-type BackendServicesInsertCall struct {
- s *Service
- project string
- backendservice *BackendService
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a BackendService resource in the specified project
-// using the data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/backendServices/insert
-func (r *BackendServicesService) Insert(project string, backendservice *BackendService) *BackendServicesInsertCall {
- c := &BackendServicesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.backendservice = backendservice
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BackendServicesInsertCall) Fields(s ...googleapi.Field) *BackendServicesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BackendServicesInsertCall) Context(ctx context.Context) *BackendServicesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BackendServicesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.backendservice)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/backendServices")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.backendServices.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *BackendServicesInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a BackendService resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.backendServices.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/backendServices",
- // "request": {
- // "$ref": "BackendService"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.backendServices.list":
-
-type BackendServicesListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of BackendService resources available to the
-// specified project.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/backendServices/list
-func (r *BackendServicesService) List(project string) *BackendServicesListCall {
- c := &BackendServicesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *BackendServicesListCall) Filter(filter string) *BackendServicesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *BackendServicesListCall) MaxResults(maxResults int64) *BackendServicesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *BackendServicesListCall) PageToken(pageToken string) *BackendServicesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BackendServicesListCall) Fields(s ...googleapi.Field) *BackendServicesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *BackendServicesListCall) IfNoneMatch(entityTag string) *BackendServicesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BackendServicesListCall) Context(ctx context.Context) *BackendServicesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BackendServicesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/backendServices")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.backendServices.list" call.
-// Exactly one of *BackendServiceList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *BackendServiceList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *BackendServicesListCall) Do() (*BackendServiceList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &BackendServiceList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of BackendService resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.backendServices.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/backendServices",
- // "response": {
- // "$ref": "BackendServiceList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.backendServices.patch":
-
-type BackendServicesPatchCall struct {
- s *Service
- project string
- backendService string
- backendservice *BackendService
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Update the entire content of the BackendService resource. This
-// method supports patch semantics.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/backendServices/patch
-func (r *BackendServicesService) Patch(project string, backendService string, backendservice *BackendService) *BackendServicesPatchCall {
- c := &BackendServicesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.backendService = backendService
- c.backendservice = backendservice
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BackendServicesPatchCall) Fields(s ...googleapi.Field) *BackendServicesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BackendServicesPatchCall) Context(ctx context.Context) *BackendServicesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BackendServicesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.backendservice)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/backendServices/{backendService}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "backendService": c.backendService,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.backendServices.patch" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *BackendServicesPatchCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update the entire content of the BackendService resource. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "compute.backendServices.patch",
- // "parameterOrder": [
- // "project",
- // "backendService"
- // ],
- // "parameters": {
- // "backendService": {
- // "description": "Name of the BackendService resource to update.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/backendServices/{backendService}",
- // "request": {
- // "$ref": "BackendService"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.backendServices.update":
-
-type BackendServicesUpdateCall struct {
- s *Service
- project string
- backendService string
- backendservice *BackendService
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Update the entire content of the BackendService resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/backendServices/update
-func (r *BackendServicesService) Update(project string, backendService string, backendservice *BackendService) *BackendServicesUpdateCall {
- c := &BackendServicesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.backendService = backendService
- c.backendservice = backendservice
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BackendServicesUpdateCall) Fields(s ...googleapi.Field) *BackendServicesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BackendServicesUpdateCall) Context(ctx context.Context) *BackendServicesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BackendServicesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.backendservice)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/backendServices/{backendService}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "backendService": c.backendService,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.backendServices.update" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *BackendServicesUpdateCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update the entire content of the BackendService resource.",
- // "httpMethod": "PUT",
- // "id": "compute.backendServices.update",
- // "parameterOrder": [
- // "project",
- // "backendService"
- // ],
- // "parameters": {
- // "backendService": {
- // "description": "Name of the BackendService resource to update.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/backendServices/{backendService}",
- // "request": {
- // "$ref": "BackendService"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.diskTypes.aggregatedList":
-
-type DiskTypesAggregatedListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AggregatedList: Retrieves the list of disk type resources grouped by
-// scope.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/diskTypes/aggregatedList
-func (r *DiskTypesService) AggregatedList(project string) *DiskTypesAggregatedListCall {
- c := &DiskTypesAggregatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *DiskTypesAggregatedListCall) Filter(filter string) *DiskTypesAggregatedListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *DiskTypesAggregatedListCall) MaxResults(maxResults int64) *DiskTypesAggregatedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *DiskTypesAggregatedListCall) PageToken(pageToken string) *DiskTypesAggregatedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DiskTypesAggregatedListCall) Fields(s ...googleapi.Field) *DiskTypesAggregatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DiskTypesAggregatedListCall) IfNoneMatch(entityTag string) *DiskTypesAggregatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DiskTypesAggregatedListCall) Context(ctx context.Context) *DiskTypesAggregatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DiskTypesAggregatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/aggregated/diskTypes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.diskTypes.aggregatedList" call.
-// Exactly one of *DiskTypeAggregatedList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *DiskTypeAggregatedList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DiskTypesAggregatedListCall) Do() (*DiskTypeAggregatedList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DiskTypeAggregatedList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of disk type resources grouped by scope.",
- // "httpMethod": "GET",
- // "id": "compute.diskTypes.aggregatedList",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/aggregated/diskTypes",
- // "response": {
- // "$ref": "DiskTypeAggregatedList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.diskTypes.get":
-
-type DiskTypesGetCall struct {
- s *Service
- project string
- zone string
- diskType string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified disk type resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/diskTypes/get
-func (r *DiskTypesService) Get(project string, zone string, diskType string) *DiskTypesGetCall {
- c := &DiskTypesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.diskType = diskType
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DiskTypesGetCall) Fields(s ...googleapi.Field) *DiskTypesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DiskTypesGetCall) IfNoneMatch(entityTag string) *DiskTypesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DiskTypesGetCall) Context(ctx context.Context) *DiskTypesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DiskTypesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/diskTypes/{diskType}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "diskType": c.diskType,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.diskTypes.get" call.
-// Exactly one of *DiskType or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *DiskType.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DiskTypesGetCall) Do() (*DiskType, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DiskType{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified disk type resource.",
- // "httpMethod": "GET",
- // "id": "compute.diskTypes.get",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "diskType"
- // ],
- // "parameters": {
- // "diskType": {
- // "description": "Name of the disk type resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/diskTypes/{diskType}",
- // "response": {
- // "$ref": "DiskType"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.diskTypes.list":
-
-type DiskTypesListCall struct {
- s *Service
- project string
- zone string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of disk type resources available to the
-// specified project.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/diskTypes/list
-func (r *DiskTypesService) List(project string, zone string) *DiskTypesListCall {
- c := &DiskTypesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *DiskTypesListCall) Filter(filter string) *DiskTypesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *DiskTypesListCall) MaxResults(maxResults int64) *DiskTypesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *DiskTypesListCall) PageToken(pageToken string) *DiskTypesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DiskTypesListCall) Fields(s ...googleapi.Field) *DiskTypesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DiskTypesListCall) IfNoneMatch(entityTag string) *DiskTypesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DiskTypesListCall) Context(ctx context.Context) *DiskTypesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DiskTypesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/diskTypes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.diskTypes.list" call.
-// Exactly one of *DiskTypeList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *DiskTypeList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DiskTypesListCall) Do() (*DiskTypeList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DiskTypeList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of disk type resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.diskTypes.list",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/diskTypes",
- // "response": {
- // "$ref": "DiskTypeList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.disks.aggregatedList":
-
-type DisksAggregatedListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AggregatedList: Retrieves the list of disks grouped by scope.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/disks/aggregatedList
-func (r *DisksService) AggregatedList(project string) *DisksAggregatedListCall {
- c := &DisksAggregatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *DisksAggregatedListCall) Filter(filter string) *DisksAggregatedListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *DisksAggregatedListCall) MaxResults(maxResults int64) *DisksAggregatedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *DisksAggregatedListCall) PageToken(pageToken string) *DisksAggregatedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DisksAggregatedListCall) Fields(s ...googleapi.Field) *DisksAggregatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DisksAggregatedListCall) IfNoneMatch(entityTag string) *DisksAggregatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DisksAggregatedListCall) Context(ctx context.Context) *DisksAggregatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DisksAggregatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/aggregated/disks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.disks.aggregatedList" call.
-// Exactly one of *DiskAggregatedList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *DiskAggregatedList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DisksAggregatedListCall) Do() (*DiskAggregatedList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DiskAggregatedList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of disks grouped by scope.",
- // "httpMethod": "GET",
- // "id": "compute.disks.aggregatedList",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/aggregated/disks",
- // "response": {
- // "$ref": "DiskAggregatedList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.disks.createSnapshot":
-
-type DisksCreateSnapshotCall struct {
- s *Service
- project string
- zone string
- disk string
- snapshot *Snapshot
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// CreateSnapshot: Creates a snapshot of this disk.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/disks/createSnapshot
-func (r *DisksService) CreateSnapshot(project string, zone string, disk string, snapshot *Snapshot) *DisksCreateSnapshotCall {
- c := &DisksCreateSnapshotCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.disk = disk
- c.snapshot = snapshot
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DisksCreateSnapshotCall) Fields(s ...googleapi.Field) *DisksCreateSnapshotCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DisksCreateSnapshotCall) Context(ctx context.Context) *DisksCreateSnapshotCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DisksCreateSnapshotCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.snapshot)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/disks/{disk}/createSnapshot")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "disk": c.disk,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.disks.createSnapshot" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DisksCreateSnapshotCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a snapshot of this disk.",
- // "httpMethod": "POST",
- // "id": "compute.disks.createSnapshot",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "disk"
- // ],
- // "parameters": {
- // "disk": {
- // "description": "Name of the persistent disk to snapshot.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/disks/{disk}/createSnapshot",
- // "request": {
- // "$ref": "Snapshot"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.disks.delete":
-
-type DisksDeleteCall struct {
- s *Service
- project string
- zone string
- disk string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified persistent disk. Deleting a disk
-// removes its data permanently and is irreversible. However, deleting a
-// disk does not delete any snapshots previously made from the disk. You
-// must separately delete snapshots.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/disks/delete
-func (r *DisksService) Delete(project string, zone string, disk string) *DisksDeleteCall {
- c := &DisksDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.disk = disk
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DisksDeleteCall) Fields(s ...googleapi.Field) *DisksDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DisksDeleteCall) Context(ctx context.Context) *DisksDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DisksDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/disks/{disk}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "disk": c.disk,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.disks.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DisksDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.",
- // "httpMethod": "DELETE",
- // "id": "compute.disks.delete",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "disk"
- // ],
- // "parameters": {
- // "disk": {
- // "description": "Name of the persistent disk to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/disks/{disk}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.disks.get":
-
-type DisksGetCall struct {
- s *Service
- project string
- zone string
- disk string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns a specified persistent disk.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/disks/get
-func (r *DisksService) Get(project string, zone string, disk string) *DisksGetCall {
- c := &DisksGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.disk = disk
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DisksGetCall) Fields(s ...googleapi.Field) *DisksGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DisksGetCall) IfNoneMatch(entityTag string) *DisksGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DisksGetCall) Context(ctx context.Context) *DisksGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DisksGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/disks/{disk}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "disk": c.disk,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.disks.get" call.
-// Exactly one of *Disk or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Disk.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *DisksGetCall) Do() (*Disk, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Disk{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns a specified persistent disk.",
- // "httpMethod": "GET",
- // "id": "compute.disks.get",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "disk"
- // ],
- // "parameters": {
- // "disk": {
- // "description": "Name of the persistent disk to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/disks/{disk}",
- // "response": {
- // "$ref": "Disk"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.disks.insert":
-
-type DisksInsertCall struct {
- s *Service
- project string
- zone string
- disk *Disk
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a persistent disk in the specified project using the
-// data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/disks/insert
-func (r *DisksService) Insert(project string, zone string, disk *Disk) *DisksInsertCall {
- c := &DisksInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.disk = disk
- return c
-}
-
-// SourceImage sets the optional parameter "sourceImage": Source image
-// to restore onto a disk.
-func (c *DisksInsertCall) SourceImage(sourceImage string) *DisksInsertCall {
- c.opt_["sourceImage"] = sourceImage
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DisksInsertCall) Fields(s ...googleapi.Field) *DisksInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DisksInsertCall) Context(ctx context.Context) *DisksInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DisksInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.disk)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["sourceImage"]; ok {
- params.Set("sourceImage", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/disks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.disks.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DisksInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a persistent disk in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.disks.insert",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "sourceImage": {
- // "description": "Optional. Source image to restore onto a disk.",
- // "location": "query",
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/disks",
- // "request": {
- // "$ref": "Disk"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.disks.list":
-
-type DisksListCall struct {
- s *Service
- project string
- zone string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of persistent disks contained within the
-// specified zone.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/disks/list
-func (r *DisksService) List(project string, zone string) *DisksListCall {
- c := &DisksListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *DisksListCall) Filter(filter string) *DisksListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *DisksListCall) MaxResults(maxResults int64) *DisksListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *DisksListCall) PageToken(pageToken string) *DisksListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DisksListCall) Fields(s ...googleapi.Field) *DisksListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DisksListCall) IfNoneMatch(entityTag string) *DisksListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DisksListCall) Context(ctx context.Context) *DisksListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DisksListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/disks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.disks.list" call.
-// Exactly one of *DiskList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *DiskList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DisksListCall) Do() (*DiskList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DiskList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of persistent disks contained within the specified zone.",
- // "httpMethod": "GET",
- // "id": "compute.disks.list",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/disks",
- // "response": {
- // "$ref": "DiskList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.firewalls.delete":
-
-type FirewallsDeleteCall struct {
- s *Service
- project string
- firewall string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified firewall resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/firewalls/delete
-func (r *FirewallsService) Delete(project string, firewall string) *FirewallsDeleteCall {
- c := &FirewallsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.firewall = firewall
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FirewallsDeleteCall) Fields(s ...googleapi.Field) *FirewallsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FirewallsDeleteCall) Context(ctx context.Context) *FirewallsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FirewallsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/firewalls/{firewall}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "firewall": c.firewall,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.firewalls.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *FirewallsDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified firewall resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.firewalls.delete",
- // "parameterOrder": [
- // "project",
- // "firewall"
- // ],
- // "parameters": {
- // "firewall": {
- // "description": "Name of the firewall resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/firewalls/{firewall}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.firewalls.get":
-
-type FirewallsGetCall struct {
- s *Service
- project string
- firewall string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified firewall resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/firewalls/get
-func (r *FirewallsService) Get(project string, firewall string) *FirewallsGetCall {
- c := &FirewallsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.firewall = firewall
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FirewallsGetCall) Fields(s ...googleapi.Field) *FirewallsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *FirewallsGetCall) IfNoneMatch(entityTag string) *FirewallsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FirewallsGetCall) Context(ctx context.Context) *FirewallsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FirewallsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/firewalls/{firewall}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "firewall": c.firewall,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.firewalls.get" call.
-// Exactly one of *Firewall or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Firewall.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *FirewallsGetCall) Do() (*Firewall, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Firewall{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified firewall resource.",
- // "httpMethod": "GET",
- // "id": "compute.firewalls.get",
- // "parameterOrder": [
- // "project",
- // "firewall"
- // ],
- // "parameters": {
- // "firewall": {
- // "description": "Name of the firewall resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/firewalls/{firewall}",
- // "response": {
- // "$ref": "Firewall"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.firewalls.insert":
-
-type FirewallsInsertCall struct {
- s *Service
- project string
- firewall *Firewall
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a firewall resource in the specified project using
-// the data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/firewalls/insert
-func (r *FirewallsService) Insert(project string, firewall *Firewall) *FirewallsInsertCall {
- c := &FirewallsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.firewall = firewall
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FirewallsInsertCall) Fields(s ...googleapi.Field) *FirewallsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FirewallsInsertCall) Context(ctx context.Context) *FirewallsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FirewallsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.firewall)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/firewalls")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.firewalls.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *FirewallsInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a firewall resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.firewalls.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/firewalls",
- // "request": {
- // "$ref": "Firewall"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.firewalls.list":
-
-type FirewallsListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of firewall resources available to the
-// specified project.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/firewalls/list
-func (r *FirewallsService) List(project string) *FirewallsListCall {
- c := &FirewallsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *FirewallsListCall) Filter(filter string) *FirewallsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *FirewallsListCall) MaxResults(maxResults int64) *FirewallsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *FirewallsListCall) PageToken(pageToken string) *FirewallsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FirewallsListCall) Fields(s ...googleapi.Field) *FirewallsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *FirewallsListCall) IfNoneMatch(entityTag string) *FirewallsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FirewallsListCall) Context(ctx context.Context) *FirewallsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FirewallsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/firewalls")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.firewalls.list" call.
-// Exactly one of *FirewallList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *FirewallList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *FirewallsListCall) Do() (*FirewallList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FirewallList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of firewall resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.firewalls.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/firewalls",
- // "response": {
- // "$ref": "FirewallList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.firewalls.patch":
-
-type FirewallsPatchCall struct {
- s *Service
- project string
- firewall string
- firewall2 *Firewall
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates the specified firewall resource with the data included
-// in the request. This method supports patch semantics.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/firewalls/patch
-func (r *FirewallsService) Patch(project string, firewall string, firewall2 *Firewall) *FirewallsPatchCall {
- c := &FirewallsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.firewall = firewall
- c.firewall2 = firewall2
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FirewallsPatchCall) Fields(s ...googleapi.Field) *FirewallsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FirewallsPatchCall) Context(ctx context.Context) *FirewallsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FirewallsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.firewall2)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/firewalls/{firewall}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "firewall": c.firewall,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.firewalls.patch" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *FirewallsPatchCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates the specified firewall resource with the data included in the request. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "compute.firewalls.patch",
- // "parameterOrder": [
- // "project",
- // "firewall"
- // ],
- // "parameters": {
- // "firewall": {
- // "description": "Name of the firewall resource to update.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/firewalls/{firewall}",
- // "request": {
- // "$ref": "Firewall"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.firewalls.update":
-
-type FirewallsUpdateCall struct {
- s *Service
- project string
- firewall string
- firewall2 *Firewall
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates the specified firewall resource with the data
-// included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/firewalls/update
-func (r *FirewallsService) Update(project string, firewall string, firewall2 *Firewall) *FirewallsUpdateCall {
- c := &FirewallsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.firewall = firewall
- c.firewall2 = firewall2
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FirewallsUpdateCall) Fields(s ...googleapi.Field) *FirewallsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FirewallsUpdateCall) Context(ctx context.Context) *FirewallsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FirewallsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.firewall2)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/firewalls/{firewall}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "firewall": c.firewall,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.firewalls.update" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *FirewallsUpdateCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates the specified firewall resource with the data included in the request.",
- // "httpMethod": "PUT",
- // "id": "compute.firewalls.update",
- // "parameterOrder": [
- // "project",
- // "firewall"
- // ],
- // "parameters": {
- // "firewall": {
- // "description": "Name of the firewall resource to update.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/firewalls/{firewall}",
- // "request": {
- // "$ref": "Firewall"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.forwardingRules.aggregatedList":
-
-type ForwardingRulesAggregatedListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AggregatedList: Retrieves the list of forwarding rules grouped by
-// scope.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/forwardingRules/aggregatedList
-func (r *ForwardingRulesService) AggregatedList(project string) *ForwardingRulesAggregatedListCall {
- c := &ForwardingRulesAggregatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *ForwardingRulesAggregatedListCall) Filter(filter string) *ForwardingRulesAggregatedListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *ForwardingRulesAggregatedListCall) MaxResults(maxResults int64) *ForwardingRulesAggregatedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *ForwardingRulesAggregatedListCall) PageToken(pageToken string) *ForwardingRulesAggregatedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ForwardingRulesAggregatedListCall) Fields(s ...googleapi.Field) *ForwardingRulesAggregatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ForwardingRulesAggregatedListCall) IfNoneMatch(entityTag string) *ForwardingRulesAggregatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ForwardingRulesAggregatedListCall) Context(ctx context.Context) *ForwardingRulesAggregatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ForwardingRulesAggregatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/aggregated/forwardingRules")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.forwardingRules.aggregatedList" call.
-// Exactly one of *ForwardingRuleAggregatedList or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *ForwardingRuleAggregatedList.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ForwardingRulesAggregatedListCall) Do() (*ForwardingRuleAggregatedList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ForwardingRuleAggregatedList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of forwarding rules grouped by scope.",
- // "httpMethod": "GET",
- // "id": "compute.forwardingRules.aggregatedList",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/aggregated/forwardingRules",
- // "response": {
- // "$ref": "ForwardingRuleAggregatedList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.forwardingRules.delete":
-
-type ForwardingRulesDeleteCall struct {
- s *Service
- project string
- region string
- forwardingRule string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified ForwardingRule resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/forwardingRules/delete
-func (r *ForwardingRulesService) Delete(project string, region string, forwardingRule string) *ForwardingRulesDeleteCall {
- c := &ForwardingRulesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.forwardingRule = forwardingRule
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ForwardingRulesDeleteCall) Fields(s ...googleapi.Field) *ForwardingRulesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ForwardingRulesDeleteCall) Context(ctx context.Context) *ForwardingRulesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ForwardingRulesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/forwardingRules/{forwardingRule}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "forwardingRule": c.forwardingRule,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.forwardingRules.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ForwardingRulesDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified ForwardingRule resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.forwardingRules.delete",
- // "parameterOrder": [
- // "project",
- // "region",
- // "forwardingRule"
- // ],
- // "parameters": {
- // "forwardingRule": {
- // "description": "Name of the ForwardingRule resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/forwardingRules/{forwardingRule}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.forwardingRules.get":
-
-type ForwardingRulesGetCall struct {
- s *Service
- project string
- region string
- forwardingRule string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified ForwardingRule resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/forwardingRules/get
-func (r *ForwardingRulesService) Get(project string, region string, forwardingRule string) *ForwardingRulesGetCall {
- c := &ForwardingRulesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.forwardingRule = forwardingRule
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ForwardingRulesGetCall) Fields(s ...googleapi.Field) *ForwardingRulesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ForwardingRulesGetCall) IfNoneMatch(entityTag string) *ForwardingRulesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ForwardingRulesGetCall) Context(ctx context.Context) *ForwardingRulesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ForwardingRulesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/forwardingRules/{forwardingRule}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "forwardingRule": c.forwardingRule,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.forwardingRules.get" call.
-// Exactly one of *ForwardingRule or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ForwardingRule.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ForwardingRulesGetCall) Do() (*ForwardingRule, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ForwardingRule{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified ForwardingRule resource.",
- // "httpMethod": "GET",
- // "id": "compute.forwardingRules.get",
- // "parameterOrder": [
- // "project",
- // "region",
- // "forwardingRule"
- // ],
- // "parameters": {
- // "forwardingRule": {
- // "description": "Name of the ForwardingRule resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/forwardingRules/{forwardingRule}",
- // "response": {
- // "$ref": "ForwardingRule"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.forwardingRules.insert":
-
-type ForwardingRulesInsertCall struct {
- s *Service
- project string
- region string
- forwardingrule *ForwardingRule
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a ForwardingRule resource in the specified project
-// and region using the data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/forwardingRules/insert
-func (r *ForwardingRulesService) Insert(project string, region string, forwardingrule *ForwardingRule) *ForwardingRulesInsertCall {
- c := &ForwardingRulesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.forwardingrule = forwardingrule
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ForwardingRulesInsertCall) Fields(s ...googleapi.Field) *ForwardingRulesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ForwardingRulesInsertCall) Context(ctx context.Context) *ForwardingRulesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ForwardingRulesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.forwardingrule)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/forwardingRules")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.forwardingRules.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ForwardingRulesInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a ForwardingRule resource in the specified project and region using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.forwardingRules.insert",
- // "parameterOrder": [
- // "project",
- // "region"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/forwardingRules",
- // "request": {
- // "$ref": "ForwardingRule"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.forwardingRules.list":
-
-type ForwardingRulesListCall struct {
- s *Service
- project string
- region string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of ForwardingRule resources available to the
-// specified project and region.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/forwardingRules/list
-func (r *ForwardingRulesService) List(project string, region string) *ForwardingRulesListCall {
- c := &ForwardingRulesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *ForwardingRulesListCall) Filter(filter string) *ForwardingRulesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *ForwardingRulesListCall) MaxResults(maxResults int64) *ForwardingRulesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *ForwardingRulesListCall) PageToken(pageToken string) *ForwardingRulesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ForwardingRulesListCall) Fields(s ...googleapi.Field) *ForwardingRulesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ForwardingRulesListCall) IfNoneMatch(entityTag string) *ForwardingRulesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ForwardingRulesListCall) Context(ctx context.Context) *ForwardingRulesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ForwardingRulesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/forwardingRules")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.forwardingRules.list" call.
-// Exactly one of *ForwardingRuleList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ForwardingRuleList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ForwardingRulesListCall) Do() (*ForwardingRuleList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ForwardingRuleList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of ForwardingRule resources available to the specified project and region.",
- // "httpMethod": "GET",
- // "id": "compute.forwardingRules.list",
- // "parameterOrder": [
- // "project",
- // "region"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/forwardingRules",
- // "response": {
- // "$ref": "ForwardingRuleList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.forwardingRules.setTarget":
-
-type ForwardingRulesSetTargetCall struct {
- s *Service
- project string
- region string
- forwardingRule string
- targetreference *TargetReference
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetTarget: Changes target url for forwarding rule.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/forwardingRules/setTarget
-func (r *ForwardingRulesService) SetTarget(project string, region string, forwardingRule string, targetreference *TargetReference) *ForwardingRulesSetTargetCall {
- c := &ForwardingRulesSetTargetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.forwardingRule = forwardingRule
- c.targetreference = targetreference
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ForwardingRulesSetTargetCall) Fields(s ...googleapi.Field) *ForwardingRulesSetTargetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ForwardingRulesSetTargetCall) Context(ctx context.Context) *ForwardingRulesSetTargetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ForwardingRulesSetTargetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.targetreference)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "forwardingRule": c.forwardingRule,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.forwardingRules.setTarget" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ForwardingRulesSetTargetCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Changes target url for forwarding rule.",
- // "httpMethod": "POST",
- // "id": "compute.forwardingRules.setTarget",
- // "parameterOrder": [
- // "project",
- // "region",
- // "forwardingRule"
- // ],
- // "parameters": {
- // "forwardingRule": {
- // "description": "Name of the ForwardingRule resource in which target is to be set.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget",
- // "request": {
- // "$ref": "TargetReference"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.globalAddresses.delete":
-
-type GlobalAddressesDeleteCall struct {
- s *Service
- project string
- address string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified address resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/globalAddresses/delete
-func (r *GlobalAddressesService) Delete(project string, address string) *GlobalAddressesDeleteCall {
- c := &GlobalAddressesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.address = address
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalAddressesDeleteCall) Fields(s ...googleapi.Field) *GlobalAddressesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalAddressesDeleteCall) Context(ctx context.Context) *GlobalAddressesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalAddressesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/addresses/{address}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "address": c.address,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.globalAddresses.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GlobalAddressesDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified address resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.globalAddresses.delete",
- // "parameterOrder": [
- // "project",
- // "address"
- // ],
- // "parameters": {
- // "address": {
- // "description": "Name of the address resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/addresses/{address}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.globalAddresses.get":
-
-type GlobalAddressesGetCall struct {
- s *Service
- project string
- address string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified address resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/globalAddresses/get
-func (r *GlobalAddressesService) Get(project string, address string) *GlobalAddressesGetCall {
- c := &GlobalAddressesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.address = address
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalAddressesGetCall) Fields(s ...googleapi.Field) *GlobalAddressesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GlobalAddressesGetCall) IfNoneMatch(entityTag string) *GlobalAddressesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalAddressesGetCall) Context(ctx context.Context) *GlobalAddressesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalAddressesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/addresses/{address}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "address": c.address,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.globalAddresses.get" call.
-// Exactly one of *Address or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Address.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *GlobalAddressesGetCall) Do() (*Address, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Address{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified address resource.",
- // "httpMethod": "GET",
- // "id": "compute.globalAddresses.get",
- // "parameterOrder": [
- // "project",
- // "address"
- // ],
- // "parameters": {
- // "address": {
- // "description": "Name of the address resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/addresses/{address}",
- // "response": {
- // "$ref": "Address"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.globalAddresses.insert":
-
-type GlobalAddressesInsertCall struct {
- s *Service
- project string
- address *Address
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates an address resource in the specified project using
-// the data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/globalAddresses/insert
-func (r *GlobalAddressesService) Insert(project string, address *Address) *GlobalAddressesInsertCall {
- c := &GlobalAddressesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.address = address
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalAddressesInsertCall) Fields(s ...googleapi.Field) *GlobalAddressesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalAddressesInsertCall) Context(ctx context.Context) *GlobalAddressesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalAddressesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.address)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/addresses")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.globalAddresses.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GlobalAddressesInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates an address resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.globalAddresses.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/addresses",
- // "request": {
- // "$ref": "Address"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.globalAddresses.list":
-
-type GlobalAddressesListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of global address resources.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/globalAddresses/list
-func (r *GlobalAddressesService) List(project string) *GlobalAddressesListCall {
- c := &GlobalAddressesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *GlobalAddressesListCall) Filter(filter string) *GlobalAddressesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *GlobalAddressesListCall) MaxResults(maxResults int64) *GlobalAddressesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *GlobalAddressesListCall) PageToken(pageToken string) *GlobalAddressesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalAddressesListCall) Fields(s ...googleapi.Field) *GlobalAddressesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GlobalAddressesListCall) IfNoneMatch(entityTag string) *GlobalAddressesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalAddressesListCall) Context(ctx context.Context) *GlobalAddressesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalAddressesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/addresses")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.globalAddresses.list" call.
-// Exactly one of *AddressList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AddressList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GlobalAddressesListCall) Do() (*AddressList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AddressList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of global address resources.",
- // "httpMethod": "GET",
- // "id": "compute.globalAddresses.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/addresses",
- // "response": {
- // "$ref": "AddressList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.globalForwardingRules.delete":
-
-type GlobalForwardingRulesDeleteCall struct {
- s *Service
- project string
- forwardingRule string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified ForwardingRule resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/globalForwardingRules/delete
-func (r *GlobalForwardingRulesService) Delete(project string, forwardingRule string) *GlobalForwardingRulesDeleteCall {
- c := &GlobalForwardingRulesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.forwardingRule = forwardingRule
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalForwardingRulesDeleteCall) Fields(s ...googleapi.Field) *GlobalForwardingRulesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalForwardingRulesDeleteCall) Context(ctx context.Context) *GlobalForwardingRulesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalForwardingRulesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/forwardingRules/{forwardingRule}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "forwardingRule": c.forwardingRule,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.globalForwardingRules.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GlobalForwardingRulesDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified ForwardingRule resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.globalForwardingRules.delete",
- // "parameterOrder": [
- // "project",
- // "forwardingRule"
- // ],
- // "parameters": {
- // "forwardingRule": {
- // "description": "Name of the ForwardingRule resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/forwardingRules/{forwardingRule}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.globalForwardingRules.get":
-
-type GlobalForwardingRulesGetCall struct {
- s *Service
- project string
- forwardingRule string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified ForwardingRule resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/globalForwardingRules/get
-func (r *GlobalForwardingRulesService) Get(project string, forwardingRule string) *GlobalForwardingRulesGetCall {
- c := &GlobalForwardingRulesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.forwardingRule = forwardingRule
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalForwardingRulesGetCall) Fields(s ...googleapi.Field) *GlobalForwardingRulesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GlobalForwardingRulesGetCall) IfNoneMatch(entityTag string) *GlobalForwardingRulesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalForwardingRulesGetCall) Context(ctx context.Context) *GlobalForwardingRulesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalForwardingRulesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/forwardingRules/{forwardingRule}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "forwardingRule": c.forwardingRule,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.globalForwardingRules.get" call.
-// Exactly one of *ForwardingRule or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ForwardingRule.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *GlobalForwardingRulesGetCall) Do() (*ForwardingRule, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ForwardingRule{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified ForwardingRule resource.",
- // "httpMethod": "GET",
- // "id": "compute.globalForwardingRules.get",
- // "parameterOrder": [
- // "project",
- // "forwardingRule"
- // ],
- // "parameters": {
- // "forwardingRule": {
- // "description": "Name of the ForwardingRule resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/forwardingRules/{forwardingRule}",
- // "response": {
- // "$ref": "ForwardingRule"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.globalForwardingRules.insert":
-
-type GlobalForwardingRulesInsertCall struct {
- s *Service
- project string
- forwardingrule *ForwardingRule
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a ForwardingRule resource in the specified project
-// and region using the data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/globalForwardingRules/insert
-func (r *GlobalForwardingRulesService) Insert(project string, forwardingrule *ForwardingRule) *GlobalForwardingRulesInsertCall {
- c := &GlobalForwardingRulesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.forwardingrule = forwardingrule
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalForwardingRulesInsertCall) Fields(s ...googleapi.Field) *GlobalForwardingRulesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalForwardingRulesInsertCall) Context(ctx context.Context) *GlobalForwardingRulesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalForwardingRulesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.forwardingrule)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/forwardingRules")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.globalForwardingRules.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GlobalForwardingRulesInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a ForwardingRule resource in the specified project and region using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.globalForwardingRules.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/forwardingRules",
- // "request": {
- // "$ref": "ForwardingRule"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.globalForwardingRules.list":
-
-type GlobalForwardingRulesListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of ForwardingRule resources available to the
-// specified project.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/globalForwardingRules/list
-func (r *GlobalForwardingRulesService) List(project string) *GlobalForwardingRulesListCall {
- c := &GlobalForwardingRulesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *GlobalForwardingRulesListCall) Filter(filter string) *GlobalForwardingRulesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *GlobalForwardingRulesListCall) MaxResults(maxResults int64) *GlobalForwardingRulesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *GlobalForwardingRulesListCall) PageToken(pageToken string) *GlobalForwardingRulesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalForwardingRulesListCall) Fields(s ...googleapi.Field) *GlobalForwardingRulesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GlobalForwardingRulesListCall) IfNoneMatch(entityTag string) *GlobalForwardingRulesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalForwardingRulesListCall) Context(ctx context.Context) *GlobalForwardingRulesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalForwardingRulesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/forwardingRules")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.globalForwardingRules.list" call.
-// Exactly one of *ForwardingRuleList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ForwardingRuleList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *GlobalForwardingRulesListCall) Do() (*ForwardingRuleList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ForwardingRuleList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of ForwardingRule resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.globalForwardingRules.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/forwardingRules",
- // "response": {
- // "$ref": "ForwardingRuleList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.globalForwardingRules.setTarget":
-
-type GlobalForwardingRulesSetTargetCall struct {
- s *Service
- project string
- forwardingRule string
- targetreference *TargetReference
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetTarget: Changes target url for forwarding rule.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/globalForwardingRules/setTarget
-func (r *GlobalForwardingRulesService) SetTarget(project string, forwardingRule string, targetreference *TargetReference) *GlobalForwardingRulesSetTargetCall {
- c := &GlobalForwardingRulesSetTargetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.forwardingRule = forwardingRule
- c.targetreference = targetreference
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalForwardingRulesSetTargetCall) Fields(s ...googleapi.Field) *GlobalForwardingRulesSetTargetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalForwardingRulesSetTargetCall) Context(ctx context.Context) *GlobalForwardingRulesSetTargetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalForwardingRulesSetTargetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.targetreference)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/forwardingRules/{forwardingRule}/setTarget")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "forwardingRule": c.forwardingRule,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.globalForwardingRules.setTarget" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GlobalForwardingRulesSetTargetCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Changes target url for forwarding rule.",
- // "httpMethod": "POST",
- // "id": "compute.globalForwardingRules.setTarget",
- // "parameterOrder": [
- // "project",
- // "forwardingRule"
- // ],
- // "parameters": {
- // "forwardingRule": {
- // "description": "Name of the ForwardingRule resource in which target is to be set.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/forwardingRules/{forwardingRule}/setTarget",
- // "request": {
- // "$ref": "TargetReference"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.globalOperations.aggregatedList":
-
-type GlobalOperationsAggregatedListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AggregatedList: Retrieves the list of all operations grouped by
-// scope.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/globalOperations/aggregatedList
-func (r *GlobalOperationsService) AggregatedList(project string) *GlobalOperationsAggregatedListCall {
- c := &GlobalOperationsAggregatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *GlobalOperationsAggregatedListCall) Filter(filter string) *GlobalOperationsAggregatedListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *GlobalOperationsAggregatedListCall) MaxResults(maxResults int64) *GlobalOperationsAggregatedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *GlobalOperationsAggregatedListCall) PageToken(pageToken string) *GlobalOperationsAggregatedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalOperationsAggregatedListCall) Fields(s ...googleapi.Field) *GlobalOperationsAggregatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GlobalOperationsAggregatedListCall) IfNoneMatch(entityTag string) *GlobalOperationsAggregatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalOperationsAggregatedListCall) Context(ctx context.Context) *GlobalOperationsAggregatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalOperationsAggregatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/aggregated/operations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.globalOperations.aggregatedList" call.
-// Exactly one of *OperationAggregatedList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *OperationAggregatedList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *GlobalOperationsAggregatedListCall) Do() (*OperationAggregatedList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OperationAggregatedList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of all operations grouped by scope.",
- // "httpMethod": "GET",
- // "id": "compute.globalOperations.aggregatedList",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/aggregated/operations",
- // "response": {
- // "$ref": "OperationAggregatedList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.globalOperations.delete":
-
-type GlobalOperationsDeleteCall struct {
- s *Service
- project string
- operation string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified Operations resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/globalOperations/delete
-func (r *GlobalOperationsService) Delete(project string, operation string) *GlobalOperationsDeleteCall {
- c := &GlobalOperationsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.operation = operation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalOperationsDeleteCall) Fields(s ...googleapi.Field) *GlobalOperationsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalOperationsDeleteCall) Context(ctx context.Context) *GlobalOperationsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalOperationsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/operations/{operation}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "operation": c.operation,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.globalOperations.delete" call.
-func (c *GlobalOperationsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes the specified Operations resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.globalOperations.delete",
- // "parameterOrder": [
- // "project",
- // "operation"
- // ],
- // "parameters": {
- // "operation": {
- // "description": "Name of the Operations resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/operations/{operation}",
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.globalOperations.get":
-
-type GlobalOperationsGetCall struct {
- s *Service
- project string
- operation string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves the specified Operations resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/globalOperations/get
-func (r *GlobalOperationsService) Get(project string, operation string) *GlobalOperationsGetCall {
- c := &GlobalOperationsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.operation = operation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalOperationsGetCall) Fields(s ...googleapi.Field) *GlobalOperationsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GlobalOperationsGetCall) IfNoneMatch(entityTag string) *GlobalOperationsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalOperationsGetCall) Context(ctx context.Context) *GlobalOperationsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalOperationsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/operations/{operation}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "operation": c.operation,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.globalOperations.get" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *GlobalOperationsGetCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the specified Operations resource.",
- // "httpMethod": "GET",
- // "id": "compute.globalOperations.get",
- // "parameterOrder": [
- // "project",
- // "operation"
- // ],
- // "parameters": {
- // "operation": {
- // "description": "Name of the Operations resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/operations/{operation}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.globalOperations.list":
-
-type GlobalOperationsListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of Operation resources contained within the
-// specified project.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/globalOperations/list
-func (r *GlobalOperationsService) List(project string) *GlobalOperationsListCall {
- c := &GlobalOperationsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *GlobalOperationsListCall) Filter(filter string) *GlobalOperationsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *GlobalOperationsListCall) MaxResults(maxResults int64) *GlobalOperationsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *GlobalOperationsListCall) PageToken(pageToken string) *GlobalOperationsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *GlobalOperationsListCall) Fields(s ...googleapi.Field) *GlobalOperationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *GlobalOperationsListCall) IfNoneMatch(entityTag string) *GlobalOperationsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *GlobalOperationsListCall) Context(ctx context.Context) *GlobalOperationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *GlobalOperationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/operations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.globalOperations.list" call.
-// Exactly one of *OperationList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *OperationList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *GlobalOperationsListCall) Do() (*OperationList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OperationList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of Operation resources contained within the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.globalOperations.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/operations",
- // "response": {
- // "$ref": "OperationList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.httpHealthChecks.delete":
-
-type HttpHealthChecksDeleteCall struct {
- s *Service
- project string
- httpHealthCheck string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified HttpHealthCheck resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/httpHealthChecks/delete
-func (r *HttpHealthChecksService) Delete(project string, httpHealthCheck string) *HttpHealthChecksDeleteCall {
- c := &HttpHealthChecksDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.httpHealthCheck = httpHealthCheck
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *HttpHealthChecksDeleteCall) Fields(s ...googleapi.Field) *HttpHealthChecksDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *HttpHealthChecksDeleteCall) Context(ctx context.Context) *HttpHealthChecksDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *HttpHealthChecksDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/httpHealthChecks/{httpHealthCheck}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "httpHealthCheck": c.httpHealthCheck,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.httpHealthChecks.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *HttpHealthChecksDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified HttpHealthCheck resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.httpHealthChecks.delete",
- // "parameterOrder": [
- // "project",
- // "httpHealthCheck"
- // ],
- // "parameters": {
- // "httpHealthCheck": {
- // "description": "Name of the HttpHealthCheck resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/httpHealthChecks/{httpHealthCheck}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.httpHealthChecks.get":
-
-type HttpHealthChecksGetCall struct {
- s *Service
- project string
- httpHealthCheck string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified HttpHealthCheck resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/httpHealthChecks/get
-func (r *HttpHealthChecksService) Get(project string, httpHealthCheck string) *HttpHealthChecksGetCall {
- c := &HttpHealthChecksGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.httpHealthCheck = httpHealthCheck
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *HttpHealthChecksGetCall) Fields(s ...googleapi.Field) *HttpHealthChecksGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *HttpHealthChecksGetCall) IfNoneMatch(entityTag string) *HttpHealthChecksGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *HttpHealthChecksGetCall) Context(ctx context.Context) *HttpHealthChecksGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *HttpHealthChecksGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/httpHealthChecks/{httpHealthCheck}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "httpHealthCheck": c.httpHealthCheck,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.httpHealthChecks.get" call.
-// Exactly one of *HttpHealthCheck or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *HttpHealthCheck.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *HttpHealthChecksGetCall) Do() (*HttpHealthCheck, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &HttpHealthCheck{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified HttpHealthCheck resource.",
- // "httpMethod": "GET",
- // "id": "compute.httpHealthChecks.get",
- // "parameterOrder": [
- // "project",
- // "httpHealthCheck"
- // ],
- // "parameters": {
- // "httpHealthCheck": {
- // "description": "Name of the HttpHealthCheck resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/httpHealthChecks/{httpHealthCheck}",
- // "response": {
- // "$ref": "HttpHealthCheck"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.httpHealthChecks.insert":
-
-type HttpHealthChecksInsertCall struct {
- s *Service
- project string
- httphealthcheck *HttpHealthCheck
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a HttpHealthCheck resource in the specified project
-// using the data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/httpHealthChecks/insert
-func (r *HttpHealthChecksService) Insert(project string, httphealthcheck *HttpHealthCheck) *HttpHealthChecksInsertCall {
- c := &HttpHealthChecksInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.httphealthcheck = httphealthcheck
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *HttpHealthChecksInsertCall) Fields(s ...googleapi.Field) *HttpHealthChecksInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *HttpHealthChecksInsertCall) Context(ctx context.Context) *HttpHealthChecksInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *HttpHealthChecksInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.httphealthcheck)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/httpHealthChecks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.httpHealthChecks.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *HttpHealthChecksInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a HttpHealthCheck resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.httpHealthChecks.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/httpHealthChecks",
- // "request": {
- // "$ref": "HttpHealthCheck"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.httpHealthChecks.list":
-
-type HttpHealthChecksListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of HttpHealthCheck resources available to
-// the specified project.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/httpHealthChecks/list
-func (r *HttpHealthChecksService) List(project string) *HttpHealthChecksListCall {
- c := &HttpHealthChecksListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *HttpHealthChecksListCall) Filter(filter string) *HttpHealthChecksListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *HttpHealthChecksListCall) MaxResults(maxResults int64) *HttpHealthChecksListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *HttpHealthChecksListCall) PageToken(pageToken string) *HttpHealthChecksListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *HttpHealthChecksListCall) Fields(s ...googleapi.Field) *HttpHealthChecksListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *HttpHealthChecksListCall) IfNoneMatch(entityTag string) *HttpHealthChecksListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *HttpHealthChecksListCall) Context(ctx context.Context) *HttpHealthChecksListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *HttpHealthChecksListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/httpHealthChecks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.httpHealthChecks.list" call.
-// Exactly one of *HttpHealthCheckList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *HttpHealthCheckList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *HttpHealthChecksListCall) Do() (*HttpHealthCheckList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &HttpHealthCheckList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of HttpHealthCheck resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.httpHealthChecks.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/httpHealthChecks",
- // "response": {
- // "$ref": "HttpHealthCheckList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.httpHealthChecks.patch":
-
-type HttpHealthChecksPatchCall struct {
- s *Service
- project string
- httpHealthCheck string
- httphealthcheck *HttpHealthCheck
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates a HttpHealthCheck resource in the specified project
-// using the data included in the request. This method supports patch
-// semantics.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/httpHealthChecks/patch
-func (r *HttpHealthChecksService) Patch(project string, httpHealthCheck string, httphealthcheck *HttpHealthCheck) *HttpHealthChecksPatchCall {
- c := &HttpHealthChecksPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.httpHealthCheck = httpHealthCheck
- c.httphealthcheck = httphealthcheck
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *HttpHealthChecksPatchCall) Fields(s ...googleapi.Field) *HttpHealthChecksPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *HttpHealthChecksPatchCall) Context(ctx context.Context) *HttpHealthChecksPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *HttpHealthChecksPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.httphealthcheck)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/httpHealthChecks/{httpHealthCheck}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "httpHealthCheck": c.httpHealthCheck,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.httpHealthChecks.patch" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *HttpHealthChecksPatchCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "compute.httpHealthChecks.patch",
- // "parameterOrder": [
- // "project",
- // "httpHealthCheck"
- // ],
- // "parameters": {
- // "httpHealthCheck": {
- // "description": "Name of the HttpHealthCheck resource to update.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/httpHealthChecks/{httpHealthCheck}",
- // "request": {
- // "$ref": "HttpHealthCheck"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.httpHealthChecks.update":
-
-type HttpHealthChecksUpdateCall struct {
- s *Service
- project string
- httpHealthCheck string
- httphealthcheck *HttpHealthCheck
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates a HttpHealthCheck resource in the specified project
-// using the data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/httpHealthChecks/update
-func (r *HttpHealthChecksService) Update(project string, httpHealthCheck string, httphealthcheck *HttpHealthCheck) *HttpHealthChecksUpdateCall {
- c := &HttpHealthChecksUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.httpHealthCheck = httpHealthCheck
- c.httphealthcheck = httphealthcheck
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *HttpHealthChecksUpdateCall) Fields(s ...googleapi.Field) *HttpHealthChecksUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *HttpHealthChecksUpdateCall) Context(ctx context.Context) *HttpHealthChecksUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *HttpHealthChecksUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.httphealthcheck)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/httpHealthChecks/{httpHealthCheck}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "httpHealthCheck": c.httpHealthCheck,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.httpHealthChecks.update" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *HttpHealthChecksUpdateCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a HttpHealthCheck resource in the specified project using the data included in the request.",
- // "httpMethod": "PUT",
- // "id": "compute.httpHealthChecks.update",
- // "parameterOrder": [
- // "project",
- // "httpHealthCheck"
- // ],
- // "parameters": {
- // "httpHealthCheck": {
- // "description": "Name of the HttpHealthCheck resource to update.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/httpHealthChecks/{httpHealthCheck}",
- // "request": {
- // "$ref": "HttpHealthCheck"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.httpsHealthChecks.delete":
-
-type HttpsHealthChecksDeleteCall struct {
- s *Service
- project string
- httpsHealthCheck string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified HttpsHealthCheck resource.
-func (r *HttpsHealthChecksService) Delete(project string, httpsHealthCheck string) *HttpsHealthChecksDeleteCall {
- c := &HttpsHealthChecksDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.httpsHealthCheck = httpsHealthCheck
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *HttpsHealthChecksDeleteCall) Fields(s ...googleapi.Field) *HttpsHealthChecksDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *HttpsHealthChecksDeleteCall) Context(ctx context.Context) *HttpsHealthChecksDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *HttpsHealthChecksDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/httpsHealthChecks/{httpsHealthCheck}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "httpsHealthCheck": c.httpsHealthCheck,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.httpsHealthChecks.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *HttpsHealthChecksDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified HttpsHealthCheck resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.httpsHealthChecks.delete",
- // "parameterOrder": [
- // "project",
- // "httpsHealthCheck"
- // ],
- // "parameters": {
- // "httpsHealthCheck": {
- // "description": "Name of the HttpsHealthCheck resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.httpsHealthChecks.get":
-
-type HttpsHealthChecksGetCall struct {
- s *Service
- project string
- httpsHealthCheck string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified HttpsHealthCheck resource.
-func (r *HttpsHealthChecksService) Get(project string, httpsHealthCheck string) *HttpsHealthChecksGetCall {
- c := &HttpsHealthChecksGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.httpsHealthCheck = httpsHealthCheck
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *HttpsHealthChecksGetCall) Fields(s ...googleapi.Field) *HttpsHealthChecksGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *HttpsHealthChecksGetCall) IfNoneMatch(entityTag string) *HttpsHealthChecksGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *HttpsHealthChecksGetCall) Context(ctx context.Context) *HttpsHealthChecksGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *HttpsHealthChecksGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/httpsHealthChecks/{httpsHealthCheck}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "httpsHealthCheck": c.httpsHealthCheck,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.httpsHealthChecks.get" call.
-// Exactly one of *HttpsHealthCheck or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *HttpsHealthCheck.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *HttpsHealthChecksGetCall) Do() (*HttpsHealthCheck, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &HttpsHealthCheck{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified HttpsHealthCheck resource.",
- // "httpMethod": "GET",
- // "id": "compute.httpsHealthChecks.get",
- // "parameterOrder": [
- // "project",
- // "httpsHealthCheck"
- // ],
- // "parameters": {
- // "httpsHealthCheck": {
- // "description": "Name of the HttpsHealthCheck resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}",
- // "response": {
- // "$ref": "HttpsHealthCheck"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.httpsHealthChecks.insert":
-
-type HttpsHealthChecksInsertCall struct {
- s *Service
- project string
- httpshealthcheck *HttpsHealthCheck
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a HttpsHealthCheck resource in the specified project
-// using the data included in the request.
-func (r *HttpsHealthChecksService) Insert(project string, httpshealthcheck *HttpsHealthCheck) *HttpsHealthChecksInsertCall {
- c := &HttpsHealthChecksInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.httpshealthcheck = httpshealthcheck
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *HttpsHealthChecksInsertCall) Fields(s ...googleapi.Field) *HttpsHealthChecksInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *HttpsHealthChecksInsertCall) Context(ctx context.Context) *HttpsHealthChecksInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *HttpsHealthChecksInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.httpshealthcheck)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/httpsHealthChecks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.httpsHealthChecks.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *HttpsHealthChecksInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a HttpsHealthCheck resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.httpsHealthChecks.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/httpsHealthChecks",
- // "request": {
- // "$ref": "HttpsHealthCheck"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.httpsHealthChecks.list":
-
-type HttpsHealthChecksListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of HttpsHealthCheck resources available to
-// the specified project.
-func (r *HttpsHealthChecksService) List(project string) *HttpsHealthChecksListCall {
- c := &HttpsHealthChecksListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *HttpsHealthChecksListCall) Filter(filter string) *HttpsHealthChecksListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *HttpsHealthChecksListCall) MaxResults(maxResults int64) *HttpsHealthChecksListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *HttpsHealthChecksListCall) PageToken(pageToken string) *HttpsHealthChecksListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *HttpsHealthChecksListCall) Fields(s ...googleapi.Field) *HttpsHealthChecksListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *HttpsHealthChecksListCall) IfNoneMatch(entityTag string) *HttpsHealthChecksListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *HttpsHealthChecksListCall) Context(ctx context.Context) *HttpsHealthChecksListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *HttpsHealthChecksListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/httpsHealthChecks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.httpsHealthChecks.list" call.
-// Exactly one of *HttpsHealthCheckList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *HttpsHealthCheckList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *HttpsHealthChecksListCall) Do() (*HttpsHealthCheckList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &HttpsHealthCheckList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of HttpsHealthCheck resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.httpsHealthChecks.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/httpsHealthChecks",
- // "response": {
- // "$ref": "HttpsHealthCheckList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.httpsHealthChecks.patch":
-
-type HttpsHealthChecksPatchCall struct {
- s *Service
- project string
- httpsHealthCheck string
- httpshealthcheck *HttpsHealthCheck
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates a HttpsHealthCheck resource in the specified project
-// using the data included in the request. This method supports patch
-// semantics.
-func (r *HttpsHealthChecksService) Patch(project string, httpsHealthCheck string, httpshealthcheck *HttpsHealthCheck) *HttpsHealthChecksPatchCall {
- c := &HttpsHealthChecksPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.httpsHealthCheck = httpsHealthCheck
- c.httpshealthcheck = httpshealthcheck
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *HttpsHealthChecksPatchCall) Fields(s ...googleapi.Field) *HttpsHealthChecksPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *HttpsHealthChecksPatchCall) Context(ctx context.Context) *HttpsHealthChecksPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *HttpsHealthChecksPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.httpshealthcheck)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/httpsHealthChecks/{httpsHealthCheck}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "httpsHealthCheck": c.httpsHealthCheck,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.httpsHealthChecks.patch" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *HttpsHealthChecksPatchCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "compute.httpsHealthChecks.patch",
- // "parameterOrder": [
- // "project",
- // "httpsHealthCheck"
- // ],
- // "parameters": {
- // "httpsHealthCheck": {
- // "description": "Name of the HttpsHealthCheck resource to update.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}",
- // "request": {
- // "$ref": "HttpsHealthCheck"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.httpsHealthChecks.update":
-
-type HttpsHealthChecksUpdateCall struct {
- s *Service
- project string
- httpsHealthCheck string
- httpshealthcheck *HttpsHealthCheck
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates a HttpsHealthCheck resource in the specified project
-// using the data included in the request.
-func (r *HttpsHealthChecksService) Update(project string, httpsHealthCheck string, httpshealthcheck *HttpsHealthCheck) *HttpsHealthChecksUpdateCall {
- c := &HttpsHealthChecksUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.httpsHealthCheck = httpsHealthCheck
- c.httpshealthcheck = httpshealthcheck
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *HttpsHealthChecksUpdateCall) Fields(s ...googleapi.Field) *HttpsHealthChecksUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *HttpsHealthChecksUpdateCall) Context(ctx context.Context) *HttpsHealthChecksUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *HttpsHealthChecksUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.httpshealthcheck)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/httpsHealthChecks/{httpsHealthCheck}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "httpsHealthCheck": c.httpsHealthCheck,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.httpsHealthChecks.update" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *HttpsHealthChecksUpdateCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a HttpsHealthCheck resource in the specified project using the data included in the request.",
- // "httpMethod": "PUT",
- // "id": "compute.httpsHealthChecks.update",
- // "parameterOrder": [
- // "project",
- // "httpsHealthCheck"
- // ],
- // "parameters": {
- // "httpsHealthCheck": {
- // "description": "Name of the HttpsHealthCheck resource to update.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}",
- // "request": {
- // "$ref": "HttpsHealthCheck"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.images.delete":
-
-type ImagesDeleteCall struct {
- s *Service
- project string
- image string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified image resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/images/delete
-func (r *ImagesService) Delete(project string, image string) *ImagesDeleteCall {
- c := &ImagesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.image = image
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ImagesDeleteCall) Fields(s ...googleapi.Field) *ImagesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ImagesDeleteCall) Context(ctx context.Context) *ImagesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ImagesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/images/{image}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "image": c.image,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.images.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ImagesDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified image resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.images.delete",
- // "parameterOrder": [
- // "project",
- // "image"
- // ],
- // "parameters": {
- // "image": {
- // "description": "Name of the image resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/images/{image}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.images.deprecate":
-
-type ImagesDeprecateCall struct {
- s *Service
- project string
- image string
- deprecationstatus *DeprecationStatus
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Deprecate: Sets the deprecation status of an image.
-//
-// If an empty request body is given, clears the deprecation status
-// instead.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/images/deprecate
-func (r *ImagesService) Deprecate(project string, image string, deprecationstatus *DeprecationStatus) *ImagesDeprecateCall {
- c := &ImagesDeprecateCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.image = image
- c.deprecationstatus = deprecationstatus
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ImagesDeprecateCall) Fields(s ...googleapi.Field) *ImagesDeprecateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ImagesDeprecateCall) Context(ctx context.Context) *ImagesDeprecateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ImagesDeprecateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.deprecationstatus)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/images/{image}/deprecate")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "image": c.image,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.images.deprecate" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ImagesDeprecateCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sets the deprecation status of an image.\n\nIf an empty request body is given, clears the deprecation status instead.",
- // "httpMethod": "POST",
- // "id": "compute.images.deprecate",
- // "parameterOrder": [
- // "project",
- // "image"
- // ],
- // "parameters": {
- // "image": {
- // "description": "Image name.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/images/{image}/deprecate",
- // "request": {
- // "$ref": "DeprecationStatus"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.images.get":
-
-type ImagesGetCall struct {
- s *Service
- project string
- image string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified image resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/images/get
-func (r *ImagesService) Get(project string, image string) *ImagesGetCall {
- c := &ImagesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.image = image
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ImagesGetCall) Fields(s ...googleapi.Field) *ImagesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ImagesGetCall) IfNoneMatch(entityTag string) *ImagesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ImagesGetCall) Context(ctx context.Context) *ImagesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ImagesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/images/{image}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "image": c.image,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.images.get" call.
-// Exactly one of *Image or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Image.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ImagesGetCall) Do() (*Image, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Image{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified image resource.",
- // "httpMethod": "GET",
- // "id": "compute.images.get",
- // "parameterOrder": [
- // "project",
- // "image"
- // ],
- // "parameters": {
- // "image": {
- // "description": "Name of the image resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/images/{image}",
- // "response": {
- // "$ref": "Image"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.images.insert":
-
-type ImagesInsertCall struct {
- s *Service
- project string
- image *Image
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates an image resource in the specified project using the
-// data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/images/insert
-func (r *ImagesService) Insert(project string, image *Image) *ImagesInsertCall {
- c := &ImagesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.image = image
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ImagesInsertCall) Fields(s ...googleapi.Field) *ImagesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ImagesInsertCall) Context(ctx context.Context) *ImagesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ImagesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.image)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/images")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.images.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ImagesInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates an image resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.images.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/images",
- // "request": {
- // "$ref": "Image"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/devstorage.full_control",
- // "https://www.googleapis.com/auth/devstorage.read_only",
- // "https://www.googleapis.com/auth/devstorage.read_write"
- // ]
- // }
-
-}
-
-// method id "compute.images.list":
-
-type ImagesListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of private images available to the specified
-// project. Private images are images you create that belong to your
-// project. This method does not get any images that belong to other
-// projects, including publicly-available images, like Debian 7. If you
-// want to get a list of publicly-available images, use this method to
-// make a request to the respective image project, such as debian-cloud
-// or windows-cloud.
-//
-// See Accessing images for more information.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/images/list
-func (r *ImagesService) List(project string) *ImagesListCall {
- c := &ImagesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *ImagesListCall) Filter(filter string) *ImagesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *ImagesListCall) MaxResults(maxResults int64) *ImagesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *ImagesListCall) PageToken(pageToken string) *ImagesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ImagesListCall) Fields(s ...googleapi.Field) *ImagesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ImagesListCall) IfNoneMatch(entityTag string) *ImagesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ImagesListCall) Context(ctx context.Context) *ImagesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ImagesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/images")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.images.list" call.
-// Exactly one of *ImageList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ImageList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ImagesListCall) Do() (*ImageList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ImageList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 7. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.\n\nSee Accessing images for more information.",
- // "httpMethod": "GET",
- // "id": "compute.images.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/images",
- // "response": {
- // "$ref": "ImageList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroupManagers.abandonInstances":
-
-type InstanceGroupManagersAbandonInstancesCall struct {
- s *Service
- project string
- zone string
- instanceGroupManager string
- instancegroupmanagersabandoninstancesrequest *InstanceGroupManagersAbandonInstancesRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AbandonInstances: Schedules a group action to remove the specified
-// instances from the managed instance group. Abandoning an instance
-// does not delete the instance, but it does remove the instance from
-// any target pools that are applied by the managed instance group. This
-// method reduces the targetSize of the managed instance group by the
-// number of instances that you abandon. This operation is marked as
-// DONE when the action is scheduled even if the instances have not yet
-// been removed from the group. You must separately verify the status of
-// the abandoning action with the listmanagedinstances method.
-func (r *InstanceGroupManagersService) AbandonInstances(project string, zone string, instanceGroupManager string, instancegroupmanagersabandoninstancesrequest *InstanceGroupManagersAbandonInstancesRequest) *InstanceGroupManagersAbandonInstancesCall {
- c := &InstanceGroupManagersAbandonInstancesCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroupManager = instanceGroupManager
- c.instancegroupmanagersabandoninstancesrequest = instancegroupmanagersabandoninstancesrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupManagersAbandonInstancesCall) Fields(s ...googleapi.Field) *InstanceGroupManagersAbandonInstancesCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupManagersAbandonInstancesCall) Context(ctx context.Context) *InstanceGroupManagersAbandonInstancesCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupManagersAbandonInstancesCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancegroupmanagersabandoninstancesrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroupManager": c.instanceGroupManager,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroupManagers.abandonInstances" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceGroupManagersAbandonInstancesCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.",
- // "httpMethod": "POST",
- // "id": "compute.instanceGroupManagers.abandonInstances",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroupManager"
- // ],
- // "parameters": {
- // "instanceGroupManager": {
- // "description": "The name of the managed instance group.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the managed instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances",
- // "request": {
- // "$ref": "InstanceGroupManagersAbandonInstancesRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroupManagers.aggregatedList":
-
-type InstanceGroupManagersAggregatedListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AggregatedList: Retrieves the list of managed instance groups and
-// groups them by zone.
-func (r *InstanceGroupManagersService) AggregatedList(project string) *InstanceGroupManagersAggregatedListCall {
- c := &InstanceGroupManagersAggregatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *InstanceGroupManagersAggregatedListCall) Filter(filter string) *InstanceGroupManagersAggregatedListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *InstanceGroupManagersAggregatedListCall) MaxResults(maxResults int64) *InstanceGroupManagersAggregatedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *InstanceGroupManagersAggregatedListCall) PageToken(pageToken string) *InstanceGroupManagersAggregatedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupManagersAggregatedListCall) Fields(s ...googleapi.Field) *InstanceGroupManagersAggregatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InstanceGroupManagersAggregatedListCall) IfNoneMatch(entityTag string) *InstanceGroupManagersAggregatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupManagersAggregatedListCall) Context(ctx context.Context) *InstanceGroupManagersAggregatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupManagersAggregatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/aggregated/instanceGroupManagers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroupManagers.aggregatedList" call.
-// Exactly one of *InstanceGroupManagerAggregatedList or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *InstanceGroupManagerAggregatedList.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *InstanceGroupManagersAggregatedListCall) Do() (*InstanceGroupManagerAggregatedList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InstanceGroupManagerAggregatedList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of managed instance groups and groups them by zone.",
- // "httpMethod": "GET",
- // "id": "compute.instanceGroupManagers.aggregatedList",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/aggregated/instanceGroupManagers",
- // "response": {
- // "$ref": "InstanceGroupManagerAggregatedList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroupManagers.delete":
-
-type InstanceGroupManagersDeleteCall struct {
- s *Service
- project string
- zone string
- instanceGroupManager string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified managed instance group and all of the
-// instances in that group.
-func (r *InstanceGroupManagersService) Delete(project string, zone string, instanceGroupManager string) *InstanceGroupManagersDeleteCall {
- c := &InstanceGroupManagersDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroupManager = instanceGroupManager
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupManagersDeleteCall) Fields(s ...googleapi.Field) *InstanceGroupManagersDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupManagersDeleteCall) Context(ctx context.Context) *InstanceGroupManagersDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupManagersDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroupManager": c.instanceGroupManager,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroupManagers.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceGroupManagersDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified managed instance group and all of the instances in that group.",
- // "httpMethod": "DELETE",
- // "id": "compute.instanceGroupManagers.delete",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroupManager"
- // ],
- // "parameters": {
- // "instanceGroupManager": {
- // "description": "The name of the managed instance group to delete.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the managed instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroupManagers.deleteInstances":
-
-type InstanceGroupManagersDeleteInstancesCall struct {
- s *Service
- project string
- zone string
- instanceGroupManager string
- instancegroupmanagersdeleteinstancesrequest *InstanceGroupManagersDeleteInstancesRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// DeleteInstances: Schedules a group action to delete the specified
-// instances in the managed instance group. The instances are also
-// removed from any target pools of which they were a member. This
-// method reduces the targetSize of the managed instance group by the
-// number of instances that you delete. This operation is marked as DONE
-// when the action is scheduled even if the instances are still being
-// deleted. You must separately verify the status of the deleting action
-// with the listmanagedinstances method.
-func (r *InstanceGroupManagersService) DeleteInstances(project string, zone string, instanceGroupManager string, instancegroupmanagersdeleteinstancesrequest *InstanceGroupManagersDeleteInstancesRequest) *InstanceGroupManagersDeleteInstancesCall {
- c := &InstanceGroupManagersDeleteInstancesCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroupManager = instanceGroupManager
- c.instancegroupmanagersdeleteinstancesrequest = instancegroupmanagersdeleteinstancesrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupManagersDeleteInstancesCall) Fields(s ...googleapi.Field) *InstanceGroupManagersDeleteInstancesCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupManagersDeleteInstancesCall) Context(ctx context.Context) *InstanceGroupManagersDeleteInstancesCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupManagersDeleteInstancesCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancegroupmanagersdeleteinstancesrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroupManager": c.instanceGroupManager,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroupManagers.deleteInstances" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceGroupManagersDeleteInstancesCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.",
- // "httpMethod": "POST",
- // "id": "compute.instanceGroupManagers.deleteInstances",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroupManager"
- // ],
- // "parameters": {
- // "instanceGroupManager": {
- // "description": "The name of the managed instance group.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the managed instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances",
- // "request": {
- // "$ref": "InstanceGroupManagersDeleteInstancesRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroupManagers.get":
-
-type InstanceGroupManagersGetCall struct {
- s *Service
- project string
- zone string
- instanceGroupManager string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns all of the details about the specified managed instance
-// group.
-func (r *InstanceGroupManagersService) Get(project string, zone string, instanceGroupManager string) *InstanceGroupManagersGetCall {
- c := &InstanceGroupManagersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroupManager = instanceGroupManager
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupManagersGetCall) Fields(s ...googleapi.Field) *InstanceGroupManagersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InstanceGroupManagersGetCall) IfNoneMatch(entityTag string) *InstanceGroupManagersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupManagersGetCall) Context(ctx context.Context) *InstanceGroupManagersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupManagersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroupManager": c.instanceGroupManager,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroupManagers.get" call.
-// Exactly one of *InstanceGroupManager or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *InstanceGroupManager.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InstanceGroupManagersGetCall) Do() (*InstanceGroupManager, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InstanceGroupManager{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns all of the details about the specified managed instance group.",
- // "httpMethod": "GET",
- // "id": "compute.instanceGroupManagers.get",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroupManager"
- // ],
- // "parameters": {
- // "instanceGroupManager": {
- // "description": "The name of the managed instance group.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the managed instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}",
- // "response": {
- // "$ref": "InstanceGroupManager"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroupManagers.insert":
-
-type InstanceGroupManagersInsertCall struct {
- s *Service
- project string
- zone string
- instancegroupmanager *InstanceGroupManager
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a managed instance group using the information that
-// you specify in the request. After the group is created, it schedules
-// an action to create instances in the group using the specified
-// instance template. This operation is marked as DONE when the group is
-// created even if the instances in the group have not yet been created.
-// You must separately verify the status of the individual instances
-// with the listmanagedinstances method.
-func (r *InstanceGroupManagersService) Insert(project string, zone string, instancegroupmanager *InstanceGroupManager) *InstanceGroupManagersInsertCall {
- c := &InstanceGroupManagersInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instancegroupmanager = instancegroupmanager
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupManagersInsertCall) Fields(s ...googleapi.Field) *InstanceGroupManagersInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupManagersInsertCall) Context(ctx context.Context) *InstanceGroupManagersInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupManagersInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancegroupmanager)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroupManagers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroupManagers.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceGroupManagersInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.",
- // "httpMethod": "POST",
- // "id": "compute.instanceGroupManagers.insert",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where you want to create the managed instance group.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroupManagers",
- // "request": {
- // "$ref": "InstanceGroupManager"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroupManagers.list":
-
-type InstanceGroupManagersListCall struct {
- s *Service
- project string
- zone string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of managed instance groups that are contained
-// within the specified project and zone.
-func (r *InstanceGroupManagersService) List(project string, zone string) *InstanceGroupManagersListCall {
- c := &InstanceGroupManagersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *InstanceGroupManagersListCall) Filter(filter string) *InstanceGroupManagersListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *InstanceGroupManagersListCall) MaxResults(maxResults int64) *InstanceGroupManagersListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *InstanceGroupManagersListCall) PageToken(pageToken string) *InstanceGroupManagersListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupManagersListCall) Fields(s ...googleapi.Field) *InstanceGroupManagersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InstanceGroupManagersListCall) IfNoneMatch(entityTag string) *InstanceGroupManagersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupManagersListCall) Context(ctx context.Context) *InstanceGroupManagersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupManagersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroupManagers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroupManagers.list" call.
-// Exactly one of *InstanceGroupManagerList or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *InstanceGroupManagerList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InstanceGroupManagersListCall) Do() (*InstanceGroupManagerList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InstanceGroupManagerList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of managed instance groups that are contained within the specified project and zone.",
- // "httpMethod": "GET",
- // "id": "compute.instanceGroupManagers.list",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the managed instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroupManagers",
- // "response": {
- // "$ref": "InstanceGroupManagerList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroupManagers.listManagedInstances":
-
-type InstanceGroupManagersListManagedInstancesCall struct {
- s *Service
- project string
- zone string
- instanceGroupManager string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// ListManagedInstances: Lists all of the instances in the managed
-// instance group. Each instance in the list has a currentAction, which
-// indicates the action that the managed instance group is performing on
-// the instance. For example, if the group is still creating an
-// instance, the currentAction is CREATING. If a previous action failed,
-// the list displays the errors for that failed action.
-func (r *InstanceGroupManagersService) ListManagedInstances(project string, zone string, instanceGroupManager string) *InstanceGroupManagersListManagedInstancesCall {
- c := &InstanceGroupManagersListManagedInstancesCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroupManager = instanceGroupManager
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupManagersListManagedInstancesCall) Fields(s ...googleapi.Field) *InstanceGroupManagersListManagedInstancesCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupManagersListManagedInstancesCall) Context(ctx context.Context) *InstanceGroupManagersListManagedInstancesCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupManagersListManagedInstancesCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroupManager": c.instanceGroupManager,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroupManagers.listManagedInstances" call.
-// Exactly one of *InstanceGroupManagersListManagedInstancesResponse or
-// error will be non-nil. Any non-2xx status code is an error. Response
-// headers are in either
-// *InstanceGroupManagersListManagedInstancesResponse.ServerResponse.Head
-// er or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *InstanceGroupManagersListManagedInstancesCall) Do() (*InstanceGroupManagersListManagedInstancesResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InstanceGroupManagersListManagedInstancesResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action.",
- // "httpMethod": "POST",
- // "id": "compute.instanceGroupManagers.listManagedInstances",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroupManager"
- // ],
- // "parameters": {
- // "instanceGroupManager": {
- // "description": "The name of the managed instance group.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the managed instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances",
- // "response": {
- // "$ref": "InstanceGroupManagersListManagedInstancesResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroupManagers.recreateInstances":
-
-type InstanceGroupManagersRecreateInstancesCall struct {
- s *Service
- project string
- zone string
- instanceGroupManager string
- instancegroupmanagersrecreateinstancesrequest *InstanceGroupManagersRecreateInstancesRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// RecreateInstances: Schedules a group action to recreate the specified
-// instances in the managed instance group. The instances are deleted
-// and recreated using the current instance template for the managed
-// instance group. This operation is marked as DONE when the action is
-// scheduled even if the instances have not yet been recreated. You must
-// separately verify the status of the recreating action with the
-// listmanagedinstances method.
-func (r *InstanceGroupManagersService) RecreateInstances(project string, zone string, instanceGroupManager string, instancegroupmanagersrecreateinstancesrequest *InstanceGroupManagersRecreateInstancesRequest) *InstanceGroupManagersRecreateInstancesCall {
- c := &InstanceGroupManagersRecreateInstancesCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroupManager = instanceGroupManager
- c.instancegroupmanagersrecreateinstancesrequest = instancegroupmanagersrecreateinstancesrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupManagersRecreateInstancesCall) Fields(s ...googleapi.Field) *InstanceGroupManagersRecreateInstancesCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupManagersRecreateInstancesCall) Context(ctx context.Context) *InstanceGroupManagersRecreateInstancesCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupManagersRecreateInstancesCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancegroupmanagersrecreateinstancesrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroupManager": c.instanceGroupManager,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroupManagers.recreateInstances" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceGroupManagersRecreateInstancesCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.",
- // "httpMethod": "POST",
- // "id": "compute.instanceGroupManagers.recreateInstances",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroupManager"
- // ],
- // "parameters": {
- // "instanceGroupManager": {
- // "description": "The name of the managed instance group.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the managed instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances",
- // "request": {
- // "$ref": "InstanceGroupManagersRecreateInstancesRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroupManagers.resize":
-
-type InstanceGroupManagersResizeCall struct {
- s *Service
- project string
- zone string
- instanceGroupManager string
- size int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Resize: Resizes the managed instance group. If you increase the size,
-// the group creates new instances using the current instance template.
-// If you decrease the size, the group deletes instances. The resize
-// operation is marked DONE when the resize actions are scheduled even
-// if the group has not yet added or deleted any instances. You must
-// separately verify the status of the creating or deleting actions with
-// the listmanagedinstances method.
-func (r *InstanceGroupManagersService) Resize(project string, zone string, instanceGroupManager string, size int64) *InstanceGroupManagersResizeCall {
- c := &InstanceGroupManagersResizeCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroupManager = instanceGroupManager
- c.size = size
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupManagersResizeCall) Fields(s ...googleapi.Field) *InstanceGroupManagersResizeCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupManagersResizeCall) Context(ctx context.Context) *InstanceGroupManagersResizeCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupManagersResizeCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("size", fmt.Sprintf("%v", c.size))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroupManager": c.instanceGroupManager,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroupManagers.resize" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceGroupManagersResizeCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.",
- // "httpMethod": "POST",
- // "id": "compute.instanceGroupManagers.resize",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroupManager",
- // "size"
- // ],
- // "parameters": {
- // "instanceGroupManager": {
- // "description": "The name of the managed instance group.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "size": {
- // "description": "The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter.",
- // "format": "int32",
- // "location": "query",
- // "required": true,
- // "type": "integer"
- // },
- // "zone": {
- // "description": "The name of the zone where the managed instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroupManagers.setInstanceTemplate":
-
-type InstanceGroupManagersSetInstanceTemplateCall struct {
- s *Service
- project string
- zone string
- instanceGroupManager string
- instancegroupmanagerssetinstancetemplaterequest *InstanceGroupManagersSetInstanceTemplateRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetInstanceTemplate: Specifies the instance template to use when
-// creating new instances in this group. The templates for existing
-// instances in the group do not change unless you recreate them.
-func (r *InstanceGroupManagersService) SetInstanceTemplate(project string, zone string, instanceGroupManager string, instancegroupmanagerssetinstancetemplaterequest *InstanceGroupManagersSetInstanceTemplateRequest) *InstanceGroupManagersSetInstanceTemplateCall {
- c := &InstanceGroupManagersSetInstanceTemplateCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroupManager = instanceGroupManager
- c.instancegroupmanagerssetinstancetemplaterequest = instancegroupmanagerssetinstancetemplaterequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupManagersSetInstanceTemplateCall) Fields(s ...googleapi.Field) *InstanceGroupManagersSetInstanceTemplateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupManagersSetInstanceTemplateCall) Context(ctx context.Context) *InstanceGroupManagersSetInstanceTemplateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupManagersSetInstanceTemplateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancegroupmanagerssetinstancetemplaterequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroupManager": c.instanceGroupManager,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroupManagers.setInstanceTemplate" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceGroupManagersSetInstanceTemplateCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.",
- // "httpMethod": "POST",
- // "id": "compute.instanceGroupManagers.setInstanceTemplate",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroupManager"
- // ],
- // "parameters": {
- // "instanceGroupManager": {
- // "description": "The name of the managed instance group.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the managed instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate",
- // "request": {
- // "$ref": "InstanceGroupManagersSetInstanceTemplateRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroupManagers.setTargetPools":
-
-type InstanceGroupManagersSetTargetPoolsCall struct {
- s *Service
- project string
- zone string
- instanceGroupManager string
- instancegroupmanagerssettargetpoolsrequest *InstanceGroupManagersSetTargetPoolsRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetTargetPools: Modifies the target pools to which all instances in
-// this managed instance group are assigned. The target pools
-// automatically apply to all of the instances in the managed instance
-// group. This operation is marked DONE when you make the request even
-// if the instances have not yet been added to their target pools. The
-// change might take some time to apply to all of the instances in the
-// group depending on the size of the group.
-func (r *InstanceGroupManagersService) SetTargetPools(project string, zone string, instanceGroupManager string, instancegroupmanagerssettargetpoolsrequest *InstanceGroupManagersSetTargetPoolsRequest) *InstanceGroupManagersSetTargetPoolsCall {
- c := &InstanceGroupManagersSetTargetPoolsCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroupManager = instanceGroupManager
- c.instancegroupmanagerssettargetpoolsrequest = instancegroupmanagerssettargetpoolsrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupManagersSetTargetPoolsCall) Fields(s ...googleapi.Field) *InstanceGroupManagersSetTargetPoolsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupManagersSetTargetPoolsCall) Context(ctx context.Context) *InstanceGroupManagersSetTargetPoolsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupManagersSetTargetPoolsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancegroupmanagerssettargetpoolsrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroupManager": c.instanceGroupManager,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroupManagers.setTargetPools" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceGroupManagersSetTargetPoolsCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.",
- // "httpMethod": "POST",
- // "id": "compute.instanceGroupManagers.setTargetPools",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroupManager"
- // ],
- // "parameters": {
- // "instanceGroupManager": {
- // "description": "The name of the managed instance group.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the managed instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools",
- // "request": {
- // "$ref": "InstanceGroupManagersSetTargetPoolsRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroups.addInstances":
-
-type InstanceGroupsAddInstancesCall struct {
- s *Service
- project string
- zone string
- instanceGroup string
- instancegroupsaddinstancesrequest *InstanceGroupsAddInstancesRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AddInstances: Adds a list of instances to the specified instance
-// group. All of the instances in the instance group must be in the same
-// network/subnetwork. TODO: Change to comment to state "if IG is load
-// balanced."
-func (r *InstanceGroupsService) AddInstances(project string, zone string, instanceGroup string, instancegroupsaddinstancesrequest *InstanceGroupsAddInstancesRequest) *InstanceGroupsAddInstancesCall {
- c := &InstanceGroupsAddInstancesCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroup = instanceGroup
- c.instancegroupsaddinstancesrequest = instancegroupsaddinstancesrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupsAddInstancesCall) Fields(s ...googleapi.Field) *InstanceGroupsAddInstancesCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupsAddInstancesCall) Context(ctx context.Context) *InstanceGroupsAddInstancesCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupsAddInstancesCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancegroupsaddinstancesrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroup": c.instanceGroup,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroups.addInstances" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceGroupsAddInstancesCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. TODO: Change to comment to state \"if IG is load balanced.\"",
- // "httpMethod": "POST",
- // "id": "compute.instanceGroups.addInstances",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroup"
- // ],
- // "parameters": {
- // "instanceGroup": {
- // "description": "The name of the instance group where you are adding instances.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances",
- // "request": {
- // "$ref": "InstanceGroupsAddInstancesRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroups.aggregatedList":
-
-type InstanceGroupsAggregatedListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AggregatedList: Retrieves the list of instance groups and sorts them
-// by zone.
-func (r *InstanceGroupsService) AggregatedList(project string) *InstanceGroupsAggregatedListCall {
- c := &InstanceGroupsAggregatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *InstanceGroupsAggregatedListCall) Filter(filter string) *InstanceGroupsAggregatedListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *InstanceGroupsAggregatedListCall) MaxResults(maxResults int64) *InstanceGroupsAggregatedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *InstanceGroupsAggregatedListCall) PageToken(pageToken string) *InstanceGroupsAggregatedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupsAggregatedListCall) Fields(s ...googleapi.Field) *InstanceGroupsAggregatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InstanceGroupsAggregatedListCall) IfNoneMatch(entityTag string) *InstanceGroupsAggregatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupsAggregatedListCall) Context(ctx context.Context) *InstanceGroupsAggregatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupsAggregatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/aggregated/instanceGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroups.aggregatedList" call.
-// Exactly one of *InstanceGroupAggregatedList or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *InstanceGroupAggregatedList.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InstanceGroupsAggregatedListCall) Do() (*InstanceGroupAggregatedList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InstanceGroupAggregatedList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of instance groups and sorts them by zone.",
- // "httpMethod": "GET",
- // "id": "compute.instanceGroups.aggregatedList",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/aggregated/instanceGroups",
- // "response": {
- // "$ref": "InstanceGroupAggregatedList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroups.delete":
-
-type InstanceGroupsDeleteCall struct {
- s *Service
- project string
- zone string
- instanceGroup string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified instance group. The instances in the
-// group are not deleted.
-func (r *InstanceGroupsService) Delete(project string, zone string, instanceGroup string) *InstanceGroupsDeleteCall {
- c := &InstanceGroupsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroup = instanceGroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupsDeleteCall) Fields(s ...googleapi.Field) *InstanceGroupsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupsDeleteCall) Context(ctx context.Context) *InstanceGroupsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroups/{instanceGroup}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroup": c.instanceGroup,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroups.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceGroupsDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified instance group. The instances in the group are not deleted.",
- // "httpMethod": "DELETE",
- // "id": "compute.instanceGroups.delete",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroup"
- // ],
- // "parameters": {
- // "instanceGroup": {
- // "description": "The name of the instance group to delete.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroups.get":
-
-type InstanceGroupsGetCall struct {
- s *Service
- project string
- zone string
- instanceGroup string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified instance group resource.
-func (r *InstanceGroupsService) Get(project string, zone string, instanceGroup string) *InstanceGroupsGetCall {
- c := &InstanceGroupsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroup = instanceGroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupsGetCall) Fields(s ...googleapi.Field) *InstanceGroupsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InstanceGroupsGetCall) IfNoneMatch(entityTag string) *InstanceGroupsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupsGetCall) Context(ctx context.Context) *InstanceGroupsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroups/{instanceGroup}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroup": c.instanceGroup,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroups.get" call.
-// Exactly one of *InstanceGroup or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *InstanceGroup.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InstanceGroupsGetCall) Do() (*InstanceGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InstanceGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified instance group resource.",
- // "httpMethod": "GET",
- // "id": "compute.instanceGroups.get",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroup"
- // ],
- // "parameters": {
- // "instanceGroup": {
- // "description": "The name of the instance group.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}",
- // "response": {
- // "$ref": "InstanceGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroups.insert":
-
-type InstanceGroupsInsertCall struct {
- s *Service
- project string
- zone string
- instancegroup *InstanceGroup
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates an instance group in the specified project using the
-// parameters that are included in the request.
-func (r *InstanceGroupsService) Insert(project string, zone string, instancegroup *InstanceGroup) *InstanceGroupsInsertCall {
- c := &InstanceGroupsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instancegroup = instancegroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupsInsertCall) Fields(s ...googleapi.Field) *InstanceGroupsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupsInsertCall) Context(ctx context.Context) *InstanceGroupsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancegroup)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroups.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceGroupsInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates an instance group in the specified project using the parameters that are included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.instanceGroups.insert",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where you want to create the instance group.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroups",
- // "request": {
- // "$ref": "InstanceGroup"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroups.list":
-
-type InstanceGroupsListCall struct {
- s *Service
- project string
- zone string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of instance groups that are located in the
-// specified project and zone.
-func (r *InstanceGroupsService) List(project string, zone string) *InstanceGroupsListCall {
- c := &InstanceGroupsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *InstanceGroupsListCall) Filter(filter string) *InstanceGroupsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *InstanceGroupsListCall) MaxResults(maxResults int64) *InstanceGroupsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *InstanceGroupsListCall) PageToken(pageToken string) *InstanceGroupsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupsListCall) Fields(s ...googleapi.Field) *InstanceGroupsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InstanceGroupsListCall) IfNoneMatch(entityTag string) *InstanceGroupsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupsListCall) Context(ctx context.Context) *InstanceGroupsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroups.list" call.
-// Exactly one of *InstanceGroupList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *InstanceGroupList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InstanceGroupsListCall) Do() (*InstanceGroupList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InstanceGroupList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of instance groups that are located in the specified project and zone.",
- // "httpMethod": "GET",
- // "id": "compute.instanceGroups.list",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroups",
- // "response": {
- // "$ref": "InstanceGroupList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroups.listInstances":
-
-type InstanceGroupsListInstancesCall struct {
- s *Service
- project string
- zone string
- instanceGroup string
- instancegroupslistinstancesrequest *InstanceGroupsListInstancesRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// ListInstances: Lists the instances in the specified instance group.
-func (r *InstanceGroupsService) ListInstances(project string, zone string, instanceGroup string, instancegroupslistinstancesrequest *InstanceGroupsListInstancesRequest) *InstanceGroupsListInstancesCall {
- c := &InstanceGroupsListInstancesCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroup = instanceGroup
- c.instancegroupslistinstancesrequest = instancegroupslistinstancesrequest
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *InstanceGroupsListInstancesCall) Filter(filter string) *InstanceGroupsListInstancesCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *InstanceGroupsListInstancesCall) MaxResults(maxResults int64) *InstanceGroupsListInstancesCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *InstanceGroupsListInstancesCall) PageToken(pageToken string) *InstanceGroupsListInstancesCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupsListInstancesCall) Fields(s ...googleapi.Field) *InstanceGroupsListInstancesCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupsListInstancesCall) Context(ctx context.Context) *InstanceGroupsListInstancesCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupsListInstancesCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancegroupslistinstancesrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroup": c.instanceGroup,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroups.listInstances" call.
-// Exactly one of *InstanceGroupsListInstances or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *InstanceGroupsListInstances.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InstanceGroupsListInstancesCall) Do() (*InstanceGroupsListInstances, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InstanceGroupsListInstances{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists the instances in the specified instance group.",
- // "httpMethod": "POST",
- // "id": "compute.instanceGroups.listInstances",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroup"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "instanceGroup": {
- // "description": "The name of the instance group from which you want to generate a list of included instances.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances",
- // "request": {
- // "$ref": "InstanceGroupsListInstancesRequest"
- // },
- // "response": {
- // "$ref": "InstanceGroupsListInstances"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroups.removeInstances":
-
-type InstanceGroupsRemoveInstancesCall struct {
- s *Service
- project string
- zone string
- instanceGroup string
- instancegroupsremoveinstancesrequest *InstanceGroupsRemoveInstancesRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// RemoveInstances: Removes one or more instances from the specified
-// instance group, but does not delete those instances.
-func (r *InstanceGroupsService) RemoveInstances(project string, zone string, instanceGroup string, instancegroupsremoveinstancesrequest *InstanceGroupsRemoveInstancesRequest) *InstanceGroupsRemoveInstancesCall {
- c := &InstanceGroupsRemoveInstancesCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroup = instanceGroup
- c.instancegroupsremoveinstancesrequest = instancegroupsremoveinstancesrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupsRemoveInstancesCall) Fields(s ...googleapi.Field) *InstanceGroupsRemoveInstancesCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupsRemoveInstancesCall) Context(ctx context.Context) *InstanceGroupsRemoveInstancesCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupsRemoveInstancesCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancegroupsremoveinstancesrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroup": c.instanceGroup,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroups.removeInstances" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceGroupsRemoveInstancesCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Removes one or more instances from the specified instance group, but does not delete those instances.",
- // "httpMethod": "POST",
- // "id": "compute.instanceGroups.removeInstances",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroup"
- // ],
- // "parameters": {
- // "instanceGroup": {
- // "description": "The name of the instance group where the specified instances will be removed.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances",
- // "request": {
- // "$ref": "InstanceGroupsRemoveInstancesRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceGroups.setNamedPorts":
-
-type InstanceGroupsSetNamedPortsCall struct {
- s *Service
- project string
- zone string
- instanceGroup string
- instancegroupssetnamedportsrequest *InstanceGroupsSetNamedPortsRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetNamedPorts: Sets the named ports for the specified instance group.
-func (r *InstanceGroupsService) SetNamedPorts(project string, zone string, instanceGroup string, instancegroupssetnamedportsrequest *InstanceGroupsSetNamedPortsRequest) *InstanceGroupsSetNamedPortsCall {
- c := &InstanceGroupsSetNamedPortsCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instanceGroup = instanceGroup
- c.instancegroupssetnamedportsrequest = instancegroupssetnamedportsrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceGroupsSetNamedPortsCall) Fields(s ...googleapi.Field) *InstanceGroupsSetNamedPortsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceGroupsSetNamedPortsCall) Context(ctx context.Context) *InstanceGroupsSetNamedPortsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceGroupsSetNamedPortsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancegroupssetnamedportsrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instanceGroup": c.instanceGroup,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceGroups.setNamedPorts" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceGroupsSetNamedPortsCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sets the named ports for the specified instance group.",
- // "httpMethod": "POST",
- // "id": "compute.instanceGroups.setNamedPorts",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instanceGroup"
- // ],
- // "parameters": {
- // "instanceGroup": {
- // "description": "The name of the instance group where the named ports are updated.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone where the instance group is located.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts",
- // "request": {
- // "$ref": "InstanceGroupsSetNamedPortsRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceTemplates.delete":
-
-type InstanceTemplatesDeleteCall struct {
- s *Service
- project string
- instanceTemplate string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified instance template.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instanceTemplates/delete
-func (r *InstanceTemplatesService) Delete(project string, instanceTemplate string) *InstanceTemplatesDeleteCall {
- c := &InstanceTemplatesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.instanceTemplate = instanceTemplate
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceTemplatesDeleteCall) Fields(s ...googleapi.Field) *InstanceTemplatesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceTemplatesDeleteCall) Context(ctx context.Context) *InstanceTemplatesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceTemplatesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/instanceTemplates/{instanceTemplate}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "instanceTemplate": c.instanceTemplate,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceTemplates.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceTemplatesDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified instance template.",
- // "httpMethod": "DELETE",
- // "id": "compute.instanceTemplates.delete",
- // "parameterOrder": [
- // "project",
- // "instanceTemplate"
- // ],
- // "parameters": {
- // "instanceTemplate": {
- // "description": "The name of the instance template to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/instanceTemplates/{instanceTemplate}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceTemplates.get":
-
-type InstanceTemplatesGetCall struct {
- s *Service
- project string
- instanceTemplate string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified instance template resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instanceTemplates/get
-func (r *InstanceTemplatesService) Get(project string, instanceTemplate string) *InstanceTemplatesGetCall {
- c := &InstanceTemplatesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.instanceTemplate = instanceTemplate
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceTemplatesGetCall) Fields(s ...googleapi.Field) *InstanceTemplatesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InstanceTemplatesGetCall) IfNoneMatch(entityTag string) *InstanceTemplatesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceTemplatesGetCall) Context(ctx context.Context) *InstanceTemplatesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceTemplatesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/instanceTemplates/{instanceTemplate}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "instanceTemplate": c.instanceTemplate,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceTemplates.get" call.
-// Exactly one of *InstanceTemplate or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *InstanceTemplate.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InstanceTemplatesGetCall) Do() (*InstanceTemplate, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InstanceTemplate{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified instance template resource.",
- // "httpMethod": "GET",
- // "id": "compute.instanceTemplates.get",
- // "parameterOrder": [
- // "project",
- // "instanceTemplate"
- // ],
- // "parameters": {
- // "instanceTemplate": {
- // "description": "The name of the instance template.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/instanceTemplates/{instanceTemplate}",
- // "response": {
- // "$ref": "InstanceTemplate"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instanceTemplates.insert":
-
-type InstanceTemplatesInsertCall struct {
- s *Service
- project string
- instancetemplate *InstanceTemplate
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates an instance template in the specified project using
-// the data that is included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instanceTemplates/insert
-func (r *InstanceTemplatesService) Insert(project string, instancetemplate *InstanceTemplate) *InstanceTemplatesInsertCall {
- c := &InstanceTemplatesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.instancetemplate = instancetemplate
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceTemplatesInsertCall) Fields(s ...googleapi.Field) *InstanceTemplatesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceTemplatesInsertCall) Context(ctx context.Context) *InstanceTemplatesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceTemplatesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancetemplate)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/instanceTemplates")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceTemplates.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstanceTemplatesInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates an instance template in the specified project using the data that is included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.instanceTemplates.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/instanceTemplates",
- // "request": {
- // "$ref": "InstanceTemplate"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instanceTemplates.list":
-
-type InstanceTemplatesListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of instance templates that are contained
-// within the specified project and zone.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instanceTemplates/list
-func (r *InstanceTemplatesService) List(project string) *InstanceTemplatesListCall {
- c := &InstanceTemplatesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *InstanceTemplatesListCall) Filter(filter string) *InstanceTemplatesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *InstanceTemplatesListCall) MaxResults(maxResults int64) *InstanceTemplatesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *InstanceTemplatesListCall) PageToken(pageToken string) *InstanceTemplatesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstanceTemplatesListCall) Fields(s ...googleapi.Field) *InstanceTemplatesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InstanceTemplatesListCall) IfNoneMatch(entityTag string) *InstanceTemplatesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstanceTemplatesListCall) Context(ctx context.Context) *InstanceTemplatesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstanceTemplatesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/instanceTemplates")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instanceTemplates.list" call.
-// Exactly one of *InstanceTemplateList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *InstanceTemplateList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InstanceTemplatesListCall) Do() (*InstanceTemplateList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InstanceTemplateList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of instance templates that are contained within the specified project and zone.",
- // "httpMethod": "GET",
- // "id": "compute.instanceTemplates.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/instanceTemplates",
- // "response": {
- // "$ref": "InstanceTemplateList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instances.addAccessConfig":
-
-type InstancesAddAccessConfigCall struct {
- s *Service
- project string
- zone string
- instance string
- networkInterface string
- accessconfig *AccessConfig
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AddAccessConfig: Adds an access config to an instance's network
-// interface.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/addAccessConfig
-func (r *InstancesService) AddAccessConfig(project string, zone string, instance string, networkInterface string, accessconfig *AccessConfig) *InstancesAddAccessConfigCall {
- c := &InstancesAddAccessConfigCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- c.networkInterface = networkInterface
- c.accessconfig = accessconfig
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesAddAccessConfigCall) Fields(s ...googleapi.Field) *InstancesAddAccessConfigCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesAddAccessConfigCall) Context(ctx context.Context) *InstancesAddAccessConfigCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesAddAccessConfigCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.accessconfig)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("networkInterface", fmt.Sprintf("%v", c.networkInterface))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}/addAccessConfig")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.addAccessConfig" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesAddAccessConfigCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Adds an access config to an instance's network interface.",
- // "httpMethod": "POST",
- // "id": "compute.instances.addAccessConfig",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance",
- // "networkInterface"
- // ],
- // "parameters": {
- // "instance": {
- // "description": "The instance name for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "networkInterface": {
- // "description": "The name of the network interface to add to this instance.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}/addAccessConfig",
- // "request": {
- // "$ref": "AccessConfig"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instances.aggregatedList":
-
-type InstancesAggregatedListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AggregatedList: Retrieves aggregated list of instance resources.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/aggregatedList
-func (r *InstancesService) AggregatedList(project string) *InstancesAggregatedListCall {
- c := &InstancesAggregatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *InstancesAggregatedListCall) Filter(filter string) *InstancesAggregatedListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *InstancesAggregatedListCall) MaxResults(maxResults int64) *InstancesAggregatedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *InstancesAggregatedListCall) PageToken(pageToken string) *InstancesAggregatedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesAggregatedListCall) Fields(s ...googleapi.Field) *InstancesAggregatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InstancesAggregatedListCall) IfNoneMatch(entityTag string) *InstancesAggregatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesAggregatedListCall) Context(ctx context.Context) *InstancesAggregatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesAggregatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/aggregated/instances")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.aggregatedList" call.
-// Exactly one of *InstanceAggregatedList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *InstanceAggregatedList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InstancesAggregatedListCall) Do() (*InstanceAggregatedList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InstanceAggregatedList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves aggregated list of instance resources.",
- // "httpMethod": "GET",
- // "id": "compute.instances.aggregatedList",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/aggregated/instances",
- // "response": {
- // "$ref": "InstanceAggregatedList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instances.attachDisk":
-
-type InstancesAttachDiskCall struct {
- s *Service
- project string
- zone string
- instance string
- attacheddisk *AttachedDisk
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AttachDisk: Attaches a Disk resource to an instance.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/attachDisk
-func (r *InstancesService) AttachDisk(project string, zone string, instance string, attacheddisk *AttachedDisk) *InstancesAttachDiskCall {
- c := &InstancesAttachDiskCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- c.attacheddisk = attacheddisk
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesAttachDiskCall) Fields(s ...googleapi.Field) *InstancesAttachDiskCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesAttachDiskCall) Context(ctx context.Context) *InstancesAttachDiskCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesAttachDiskCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.attacheddisk)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}/attachDisk")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.attachDisk" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesAttachDiskCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Attaches a Disk resource to an instance.",
- // "httpMethod": "POST",
- // "id": "compute.instances.attachDisk",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance"
- // ],
- // "parameters": {
- // "instance": {
- // "description": "Instance name.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}/attachDisk",
- // "request": {
- // "$ref": "AttachedDisk"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instances.delete":
-
-type InstancesDeleteCall struct {
- s *Service
- project string
- zone string
- instance string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified Instance resource. For more
-// information, see Shutting down an instance.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/delete
-func (r *InstancesService) Delete(project string, zone string, instance string) *InstancesDeleteCall {
- c := &InstancesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesDeleteCall) Fields(s ...googleapi.Field) *InstancesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesDeleteCall) Context(ctx context.Context) *InstancesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified Instance resource. For more information, see Shutting down an instance.",
- // "httpMethod": "DELETE",
- // "id": "compute.instances.delete",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance"
- // ],
- // "parameters": {
- // "instance": {
- // "description": "Name of the instance resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instances.deleteAccessConfig":
-
-type InstancesDeleteAccessConfigCall struct {
- s *Service
- project string
- zone string
- instance string
- accessConfig string
- networkInterface string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// DeleteAccessConfig: Deletes an access config from an instance's
-// network interface.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/deleteAccessConfig
-func (r *InstancesService) DeleteAccessConfig(project string, zone string, instance string, accessConfig string, networkInterface string) *InstancesDeleteAccessConfigCall {
- c := &InstancesDeleteAccessConfigCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- c.accessConfig = accessConfig
- c.networkInterface = networkInterface
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesDeleteAccessConfigCall) Fields(s ...googleapi.Field) *InstancesDeleteAccessConfigCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesDeleteAccessConfigCall) Context(ctx context.Context) *InstancesDeleteAccessConfigCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesDeleteAccessConfigCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("accessConfig", fmt.Sprintf("%v", c.accessConfig))
- params.Set("networkInterface", fmt.Sprintf("%v", c.networkInterface))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}/deleteAccessConfig")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.deleteAccessConfig" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesDeleteAccessConfigCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes an access config from an instance's network interface.",
- // "httpMethod": "POST",
- // "id": "compute.instances.deleteAccessConfig",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance",
- // "accessConfig",
- // "networkInterface"
- // ],
- // "parameters": {
- // "accessConfig": {
- // "description": "The name of the access config to delete.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "instance": {
- // "description": "The instance name for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "networkInterface": {
- // "description": "The name of the network interface.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}/deleteAccessConfig",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instances.detachDisk":
-
-type InstancesDetachDiskCall struct {
- s *Service
- project string
- zone string
- instance string
- deviceName string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// DetachDisk: Detaches a disk from an instance.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/detachDisk
-func (r *InstancesService) DetachDisk(project string, zone string, instance string, deviceName string) *InstancesDetachDiskCall {
- c := &InstancesDetachDiskCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- c.deviceName = deviceName
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesDetachDiskCall) Fields(s ...googleapi.Field) *InstancesDetachDiskCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesDetachDiskCall) Context(ctx context.Context) *InstancesDetachDiskCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesDetachDiskCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("deviceName", fmt.Sprintf("%v", c.deviceName))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}/detachDisk")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.detachDisk" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesDetachDiskCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Detaches a disk from an instance.",
- // "httpMethod": "POST",
- // "id": "compute.instances.detachDisk",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance",
- // "deviceName"
- // ],
- // "parameters": {
- // "deviceName": {
- // "description": "Disk device name to detach.",
- // "location": "query",
- // "pattern": "\\w[\\w.-]{0,254}",
- // "required": true,
- // "type": "string"
- // },
- // "instance": {
- // "description": "Instance name.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}/detachDisk",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instances.get":
-
-type InstancesGetCall struct {
- s *Service
- project string
- zone string
- instance string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified instance resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/get
-func (r *InstancesService) Get(project string, zone string, instance string) *InstancesGetCall {
- c := &InstancesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesGetCall) Fields(s ...googleapi.Field) *InstancesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InstancesGetCall) IfNoneMatch(entityTag string) *InstancesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesGetCall) Context(ctx context.Context) *InstancesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.get" call.
-// Exactly one of *Instance or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Instance.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesGetCall) Do() (*Instance, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Instance{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified instance resource.",
- // "httpMethod": "GET",
- // "id": "compute.instances.get",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance"
- // ],
- // "parameters": {
- // "instance": {
- // "description": "Name of the instance resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}",
- // "response": {
- // "$ref": "Instance"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instances.getSerialPortOutput":
-
-type InstancesGetSerialPortOutputCall struct {
- s *Service
- project string
- zone string
- instance string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetSerialPortOutput: Returns the specified instance's serial port
-// output.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/getSerialPortOutput
-func (r *InstancesService) GetSerialPortOutput(project string, zone string, instance string) *InstancesGetSerialPortOutputCall {
- c := &InstancesGetSerialPortOutputCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- return c
-}
-
-// Port sets the optional parameter "port": Specifies which COM or
-// serial port to retrieve data from.
-func (c *InstancesGetSerialPortOutputCall) Port(port int64) *InstancesGetSerialPortOutputCall {
- c.opt_["port"] = port
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesGetSerialPortOutputCall) Fields(s ...googleapi.Field) *InstancesGetSerialPortOutputCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InstancesGetSerialPortOutputCall) IfNoneMatch(entityTag string) *InstancesGetSerialPortOutputCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesGetSerialPortOutputCall) Context(ctx context.Context) *InstancesGetSerialPortOutputCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesGetSerialPortOutputCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["port"]; ok {
- params.Set("port", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}/serialPort")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.getSerialPortOutput" call.
-// Exactly one of *SerialPortOutput or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *SerialPortOutput.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InstancesGetSerialPortOutputCall) Do() (*SerialPortOutput, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SerialPortOutput{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified instance's serial port output.",
- // "httpMethod": "GET",
- // "id": "compute.instances.getSerialPortOutput",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance"
- // ],
- // "parameters": {
- // "instance": {
- // "description": "Name of the instance scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "port": {
- // "default": "1",
- // "description": "Specifies which COM or serial port to retrieve data from.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "4",
- // "minimum": "1",
- // "type": "integer"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}/serialPort",
- // "response": {
- // "$ref": "SerialPortOutput"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instances.insert":
-
-type InstancesInsertCall struct {
- s *Service
- project string
- zone string
- instance *Instance
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates an instance resource in the specified project using
-// the data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/insert
-func (r *InstancesService) Insert(project string, zone string, instance *Instance) *InstancesInsertCall {
- c := &InstancesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesInsertCall) Fields(s ...googleapi.Field) *InstancesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesInsertCall) Context(ctx context.Context) *InstancesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instance)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates an instance resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.instances.insert",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances",
- // "request": {
- // "$ref": "Instance"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instances.list":
-
-type InstancesListCall struct {
- s *Service
- project string
- zone string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of instance resources contained within the
-// specified zone.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/list
-func (r *InstancesService) List(project string, zone string) *InstancesListCall {
- c := &InstancesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *InstancesListCall) Filter(filter string) *InstancesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *InstancesListCall) MaxResults(maxResults int64) *InstancesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *InstancesListCall) PageToken(pageToken string) *InstancesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesListCall) Fields(s ...googleapi.Field) *InstancesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InstancesListCall) IfNoneMatch(entityTag string) *InstancesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesListCall) Context(ctx context.Context) *InstancesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.list" call.
-// Exactly one of *InstanceList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *InstanceList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesListCall) Do() (*InstanceList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InstanceList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of instance resources contained within the specified zone.",
- // "httpMethod": "GET",
- // "id": "compute.instances.list",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances",
- // "response": {
- // "$ref": "InstanceList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.instances.reset":
-
-type InstancesResetCall struct {
- s *Service
- project string
- zone string
- instance string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Reset: Performs a hard reset on the instance.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/reset
-func (r *InstancesService) Reset(project string, zone string, instance string) *InstancesResetCall {
- c := &InstancesResetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesResetCall) Fields(s ...googleapi.Field) *InstancesResetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesResetCall) Context(ctx context.Context) *InstancesResetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesResetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}/reset")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.reset" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesResetCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Performs a hard reset on the instance.",
- // "httpMethod": "POST",
- // "id": "compute.instances.reset",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance"
- // ],
- // "parameters": {
- // "instance": {
- // "description": "Name of the instance scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}/reset",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instances.setDiskAutoDelete":
-
-type InstancesSetDiskAutoDeleteCall struct {
- s *Service
- project string
- zone string
- instance string
- autoDelete bool
- deviceName string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetDiskAutoDelete: Sets the auto-delete flag for a disk attached to
-// an instance.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/setDiskAutoDelete
-func (r *InstancesService) SetDiskAutoDelete(project string, zone string, instance string, autoDelete bool, deviceName string) *InstancesSetDiskAutoDeleteCall {
- c := &InstancesSetDiskAutoDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- c.autoDelete = autoDelete
- c.deviceName = deviceName
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesSetDiskAutoDeleteCall) Fields(s ...googleapi.Field) *InstancesSetDiskAutoDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesSetDiskAutoDeleteCall) Context(ctx context.Context) *InstancesSetDiskAutoDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesSetDiskAutoDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("autoDelete", fmt.Sprintf("%v", c.autoDelete))
- params.Set("deviceName", fmt.Sprintf("%v", c.deviceName))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.setDiskAutoDelete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesSetDiskAutoDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sets the auto-delete flag for a disk attached to an instance.",
- // "httpMethod": "POST",
- // "id": "compute.instances.setDiskAutoDelete",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance",
- // "autoDelete",
- // "deviceName"
- // ],
- // "parameters": {
- // "autoDelete": {
- // "description": "Whether to auto-delete the disk when the instance is deleted.",
- // "location": "query",
- // "required": true,
- // "type": "boolean"
- // },
- // "deviceName": {
- // "description": "The device name of the disk to modify.",
- // "location": "query",
- // "pattern": "\\w[\\w.-]{0,254}",
- // "required": true,
- // "type": "string"
- // },
- // "instance": {
- // "description": "The instance name.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instances.setMetadata":
-
-type InstancesSetMetadataCall struct {
- s *Service
- project string
- zone string
- instance string
- metadata *Metadata
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetMetadata: Sets metadata for the specified instance to the data
-// included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/setMetadata
-func (r *InstancesService) SetMetadata(project string, zone string, instance string, metadata *Metadata) *InstancesSetMetadataCall {
- c := &InstancesSetMetadataCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- c.metadata = metadata
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesSetMetadataCall) Fields(s ...googleapi.Field) *InstancesSetMetadataCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesSetMetadataCall) Context(ctx context.Context) *InstancesSetMetadataCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesSetMetadataCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.metadata)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}/setMetadata")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.setMetadata" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesSetMetadataCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sets metadata for the specified instance to the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.instances.setMetadata",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance"
- // ],
- // "parameters": {
- // "instance": {
- // "description": "Name of the instance scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}/setMetadata",
- // "request": {
- // "$ref": "Metadata"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instances.setScheduling":
-
-type InstancesSetSchedulingCall struct {
- s *Service
- project string
- zone string
- instance string
- scheduling *Scheduling
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetScheduling: Sets an instance's scheduling options.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/setScheduling
-func (r *InstancesService) SetScheduling(project string, zone string, instance string, scheduling *Scheduling) *InstancesSetSchedulingCall {
- c := &InstancesSetSchedulingCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- c.scheduling = scheduling
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesSetSchedulingCall) Fields(s ...googleapi.Field) *InstancesSetSchedulingCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesSetSchedulingCall) Context(ctx context.Context) *InstancesSetSchedulingCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesSetSchedulingCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.scheduling)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}/setScheduling")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.setScheduling" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesSetSchedulingCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sets an instance's scheduling options.",
- // "httpMethod": "POST",
- // "id": "compute.instances.setScheduling",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance"
- // ],
- // "parameters": {
- // "instance": {
- // "description": "Instance name.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}/setScheduling",
- // "request": {
- // "$ref": "Scheduling"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instances.setTags":
-
-type InstancesSetTagsCall struct {
- s *Service
- project string
- zone string
- instance string
- tags *Tags
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetTags: Sets tags for the specified instance to the data included in
-// the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/setTags
-func (r *InstancesService) SetTags(project string, zone string, instance string, tags *Tags) *InstancesSetTagsCall {
- c := &InstancesSetTagsCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- c.tags = tags
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesSetTagsCall) Fields(s ...googleapi.Field) *InstancesSetTagsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesSetTagsCall) Context(ctx context.Context) *InstancesSetTagsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesSetTagsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.tags)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}/setTags")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.setTags" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesSetTagsCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sets tags for the specified instance to the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.instances.setTags",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance"
- // ],
- // "parameters": {
- // "instance": {
- // "description": "Name of the instance scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}/setTags",
- // "request": {
- // "$ref": "Tags"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instances.start":
-
-type InstancesStartCall struct {
- s *Service
- project string
- zone string
- instance string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Start: This method starts an instance that was stopped using the
-// using the instances().stop method. For more information, see Restart
-// an instance.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/start
-func (r *InstancesService) Start(project string, zone string, instance string) *InstancesStartCall {
- c := &InstancesStartCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesStartCall) Fields(s ...googleapi.Field) *InstancesStartCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesStartCall) Context(ctx context.Context) *InstancesStartCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesStartCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}/start")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.start" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesStartCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "This method starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.",
- // "httpMethod": "POST",
- // "id": "compute.instances.start",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance"
- // ],
- // "parameters": {
- // "instance": {
- // "description": "Name of the instance resource to start.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}/start",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.instances.stop":
-
-type InstancesStopCall struct {
- s *Service
- project string
- zone string
- instance string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Stop: This method stops a running instance, shutting it down cleanly,
-// and allows you to restart the instance at a later time. Stopped
-// instances do not incur per-minute, virtual machine usage charges
-// while they are stopped, but any resources that the virtual machine is
-// using, such as persistent disks and static IP addresses,will continue
-// to be charged until they are deleted. For more information, see
-// Stopping an instance.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/instances/stop
-func (r *InstancesService) Stop(project string, zone string, instance string) *InstancesStopCall {
- c := &InstancesStopCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.instance = instance
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InstancesStopCall) Fields(s ...googleapi.Field) *InstancesStopCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InstancesStopCall) Context(ctx context.Context) *InstancesStopCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InstancesStopCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}/stop")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "instance": c.instance,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.instances.stop" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *InstancesStopCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "This method stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses,will continue to be charged until they are deleted. For more information, see Stopping an instance.",
- // "httpMethod": "POST",
- // "id": "compute.instances.stop",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "instance"
- // ],
- // "parameters": {
- // "instance": {
- // "description": "Name of the instance resource to stop.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/instances/{instance}/stop",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.licenses.get":
-
-type LicensesGetCall struct {
- s *Service
- project string
- license string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified license resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/licenses/get
-func (r *LicensesService) Get(project string, license string) *LicensesGetCall {
- c := &LicensesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.license = license
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LicensesGetCall) Fields(s ...googleapi.Field) *LicensesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *LicensesGetCall) IfNoneMatch(entityTag string) *LicensesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LicensesGetCall) Context(ctx context.Context) *LicensesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LicensesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/licenses/{license}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "license": c.license,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.licenses.get" call.
-// Exactly one of *License or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *License.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *LicensesGetCall) Do() (*License, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &License{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified license resource.",
- // "httpMethod": "GET",
- // "id": "compute.licenses.get",
- // "parameterOrder": [
- // "project",
- // "license"
- // ],
- // "parameters": {
- // "license": {
- // "description": "Name of the license resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/licenses/{license}",
- // "response": {
- // "$ref": "License"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.machineTypes.aggregatedList":
-
-type MachineTypesAggregatedListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AggregatedList: Retrieves the list of machine type resources grouped
-// by scope.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/machineTypes/aggregatedList
-func (r *MachineTypesService) AggregatedList(project string) *MachineTypesAggregatedListCall {
- c := &MachineTypesAggregatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *MachineTypesAggregatedListCall) Filter(filter string) *MachineTypesAggregatedListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *MachineTypesAggregatedListCall) MaxResults(maxResults int64) *MachineTypesAggregatedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *MachineTypesAggregatedListCall) PageToken(pageToken string) *MachineTypesAggregatedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MachineTypesAggregatedListCall) Fields(s ...googleapi.Field) *MachineTypesAggregatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MachineTypesAggregatedListCall) IfNoneMatch(entityTag string) *MachineTypesAggregatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MachineTypesAggregatedListCall) Context(ctx context.Context) *MachineTypesAggregatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MachineTypesAggregatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/aggregated/machineTypes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.machineTypes.aggregatedList" call.
-// Exactly one of *MachineTypeAggregatedList or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *MachineTypeAggregatedList.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MachineTypesAggregatedListCall) Do() (*MachineTypeAggregatedList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &MachineTypeAggregatedList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of machine type resources grouped by scope.",
- // "httpMethod": "GET",
- // "id": "compute.machineTypes.aggregatedList",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/aggregated/machineTypes",
- // "response": {
- // "$ref": "MachineTypeAggregatedList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.machineTypes.get":
-
-type MachineTypesGetCall struct {
- s *Service
- project string
- zone string
- machineType string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified machine type resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/machineTypes/get
-func (r *MachineTypesService) Get(project string, zone string, machineType string) *MachineTypesGetCall {
- c := &MachineTypesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.machineType = machineType
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MachineTypesGetCall) Fields(s ...googleapi.Field) *MachineTypesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MachineTypesGetCall) IfNoneMatch(entityTag string) *MachineTypesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MachineTypesGetCall) Context(ctx context.Context) *MachineTypesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MachineTypesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/machineTypes/{machineType}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "machineType": c.machineType,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.machineTypes.get" call.
-// Exactly one of *MachineType or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *MachineType.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *MachineTypesGetCall) Do() (*MachineType, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &MachineType{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified machine type resource.",
- // "httpMethod": "GET",
- // "id": "compute.machineTypes.get",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "machineType"
- // ],
- // "parameters": {
- // "machineType": {
- // "description": "Name of the machine type resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/machineTypes/{machineType}",
- // "response": {
- // "$ref": "MachineType"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.machineTypes.list":
-
-type MachineTypesListCall struct {
- s *Service
- project string
- zone string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of machine type resources available to the
-// specified project.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/machineTypes/list
-func (r *MachineTypesService) List(project string, zone string) *MachineTypesListCall {
- c := &MachineTypesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *MachineTypesListCall) Filter(filter string) *MachineTypesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *MachineTypesListCall) MaxResults(maxResults int64) *MachineTypesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *MachineTypesListCall) PageToken(pageToken string) *MachineTypesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MachineTypesListCall) Fields(s ...googleapi.Field) *MachineTypesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MachineTypesListCall) IfNoneMatch(entityTag string) *MachineTypesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MachineTypesListCall) Context(ctx context.Context) *MachineTypesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MachineTypesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/machineTypes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.machineTypes.list" call.
-// Exactly one of *MachineTypeList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *MachineTypeList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MachineTypesListCall) Do() (*MachineTypeList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &MachineTypeList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of machine type resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.machineTypes.list",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the zone for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/machineTypes",
- // "response": {
- // "$ref": "MachineTypeList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.networks.delete":
-
-type NetworksDeleteCall struct {
- s *Service
- project string
- network string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified network resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/networks/delete
-func (r *NetworksService) Delete(project string, network string) *NetworksDeleteCall {
- c := &NetworksDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.network = network
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *NetworksDeleteCall) Fields(s ...googleapi.Field) *NetworksDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *NetworksDeleteCall) Context(ctx context.Context) *NetworksDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *NetworksDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/networks/{network}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "network": c.network,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.networks.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *NetworksDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified network resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.networks.delete",
- // "parameterOrder": [
- // "project",
- // "network"
- // ],
- // "parameters": {
- // "network": {
- // "description": "Name of the network resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/networks/{network}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.networks.get":
-
-type NetworksGetCall struct {
- s *Service
- project string
- network string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified network resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/networks/get
-func (r *NetworksService) Get(project string, network string) *NetworksGetCall {
- c := &NetworksGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.network = network
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *NetworksGetCall) Fields(s ...googleapi.Field) *NetworksGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *NetworksGetCall) IfNoneMatch(entityTag string) *NetworksGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *NetworksGetCall) Context(ctx context.Context) *NetworksGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *NetworksGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/networks/{network}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "network": c.network,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.networks.get" call.
-// Exactly one of *Network or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Network.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *NetworksGetCall) Do() (*Network, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Network{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified network resource.",
- // "httpMethod": "GET",
- // "id": "compute.networks.get",
- // "parameterOrder": [
- // "project",
- // "network"
- // ],
- // "parameters": {
- // "network": {
- // "description": "Name of the network resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/networks/{network}",
- // "response": {
- // "$ref": "Network"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.networks.insert":
-
-type NetworksInsertCall struct {
- s *Service
- project string
- network *Network
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a network resource in the specified project using the
-// data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/networks/insert
-func (r *NetworksService) Insert(project string, network *Network) *NetworksInsertCall {
- c := &NetworksInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.network = network
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *NetworksInsertCall) Fields(s ...googleapi.Field) *NetworksInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *NetworksInsertCall) Context(ctx context.Context) *NetworksInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *NetworksInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.network)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/networks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.networks.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *NetworksInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a network resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.networks.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/networks",
- // "request": {
- // "$ref": "Network"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.networks.list":
-
-type NetworksListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of network resources available to the
-// specified project.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/networks/list
-func (r *NetworksService) List(project string) *NetworksListCall {
- c := &NetworksListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *NetworksListCall) Filter(filter string) *NetworksListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *NetworksListCall) MaxResults(maxResults int64) *NetworksListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *NetworksListCall) PageToken(pageToken string) *NetworksListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *NetworksListCall) Fields(s ...googleapi.Field) *NetworksListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *NetworksListCall) IfNoneMatch(entityTag string) *NetworksListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *NetworksListCall) Context(ctx context.Context) *NetworksListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *NetworksListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/networks")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.networks.list" call.
-// Exactly one of *NetworkList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *NetworkList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *NetworksListCall) Do() (*NetworkList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &NetworkList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of network resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.networks.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/networks",
- // "response": {
- // "$ref": "NetworkList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.projects.get":
-
-type ProjectsGetCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified project resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/projects/get
-func (r *ProjectsService) Get(project string) *ProjectsGetCall {
- c := &ProjectsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsGetCall) Fields(s ...googleapi.Field) *ProjectsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ProjectsGetCall) IfNoneMatch(entityTag string) *ProjectsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsGetCall) Context(ctx context.Context) *ProjectsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.projects.get" call.
-// Exactly one of *Project or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Project.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ProjectsGetCall) Do() (*Project, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Project{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified project resource.",
- // "httpMethod": "GET",
- // "id": "compute.projects.get",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}",
- // "response": {
- // "$ref": "Project"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.projects.moveDisk":
-
-type ProjectsMoveDiskCall struct {
- s *Service
- project string
- diskmoverequest *DiskMoveRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// MoveDisk: Moves a persistent disk from one zone to another.
-func (r *ProjectsService) MoveDisk(project string, diskmoverequest *DiskMoveRequest) *ProjectsMoveDiskCall {
- c := &ProjectsMoveDiskCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.diskmoverequest = diskmoverequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsMoveDiskCall) Fields(s ...googleapi.Field) *ProjectsMoveDiskCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsMoveDiskCall) Context(ctx context.Context) *ProjectsMoveDiskCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsMoveDiskCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.diskmoverequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/moveDisk")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.projects.moveDisk" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ProjectsMoveDiskCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Moves a persistent disk from one zone to another.",
- // "httpMethod": "POST",
- // "id": "compute.projects.moveDisk",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/moveDisk",
- // "request": {
- // "$ref": "DiskMoveRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.projects.moveInstance":
-
-type ProjectsMoveInstanceCall struct {
- s *Service
- project string
- instancemoverequest *InstanceMoveRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// MoveInstance: Moves an instance and its attached persistent disks
-// from one zone to another.
-func (r *ProjectsService) MoveInstance(project string, instancemoverequest *InstanceMoveRequest) *ProjectsMoveInstanceCall {
- c := &ProjectsMoveInstanceCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.instancemoverequest = instancemoverequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsMoveInstanceCall) Fields(s ...googleapi.Field) *ProjectsMoveInstanceCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsMoveInstanceCall) Context(ctx context.Context) *ProjectsMoveInstanceCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsMoveInstanceCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancemoverequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/moveInstance")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.projects.moveInstance" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ProjectsMoveInstanceCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Moves an instance and its attached persistent disks from one zone to another.",
- // "httpMethod": "POST",
- // "id": "compute.projects.moveInstance",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/moveInstance",
- // "request": {
- // "$ref": "InstanceMoveRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.projects.setCommonInstanceMetadata":
-
-type ProjectsSetCommonInstanceMetadataCall struct {
- s *Service
- project string
- metadata *Metadata
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetCommonInstanceMetadata: Sets metadata common to all instances
-// within the specified project using the data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/projects/setCommonInstanceMetadata
-func (r *ProjectsService) SetCommonInstanceMetadata(project string, metadata *Metadata) *ProjectsSetCommonInstanceMetadataCall {
- c := &ProjectsSetCommonInstanceMetadataCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.metadata = metadata
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsSetCommonInstanceMetadataCall) Fields(s ...googleapi.Field) *ProjectsSetCommonInstanceMetadataCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsSetCommonInstanceMetadataCall) Context(ctx context.Context) *ProjectsSetCommonInstanceMetadataCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsSetCommonInstanceMetadataCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.metadata)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/setCommonInstanceMetadata")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.projects.setCommonInstanceMetadata" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ProjectsSetCommonInstanceMetadataCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sets metadata common to all instances within the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.projects.setCommonInstanceMetadata",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/setCommonInstanceMetadata",
- // "request": {
- // "$ref": "Metadata"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.projects.setUsageExportBucket":
-
-type ProjectsSetUsageExportBucketCall struct {
- s *Service
- project string
- usageexportlocation *UsageExportLocation
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetUsageExportBucket: Enables the usage export feature and sets the
-// usage export bucket where reports are stored. If you provide an empty
-// request body using this method, the usage export feature will be
-// disabled.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/projects/setUsageExportBucket
-func (r *ProjectsService) SetUsageExportBucket(project string, usageexportlocation *UsageExportLocation) *ProjectsSetUsageExportBucketCall {
- c := &ProjectsSetUsageExportBucketCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.usageexportlocation = usageexportlocation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsSetUsageExportBucketCall) Fields(s ...googleapi.Field) *ProjectsSetUsageExportBucketCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsSetUsageExportBucketCall) Context(ctx context.Context) *ProjectsSetUsageExportBucketCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsSetUsageExportBucketCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.usageexportlocation)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/setUsageExportBucket")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.projects.setUsageExportBucket" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ProjectsSetUsageExportBucketCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.",
- // "httpMethod": "POST",
- // "id": "compute.projects.setUsageExportBucket",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/setUsageExportBucket",
- // "request": {
- // "$ref": "UsageExportLocation"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/devstorage.full_control",
- // "https://www.googleapis.com/auth/devstorage.read_only",
- // "https://www.googleapis.com/auth/devstorage.read_write"
- // ]
- // }
-
-}
-
-// method id "compute.regionOperations.delete":
-
-type RegionOperationsDeleteCall struct {
- s *Service
- project string
- region string
- operation string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified region-specific Operations resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/regionOperations/delete
-func (r *RegionOperationsService) Delete(project string, region string, operation string) *RegionOperationsDeleteCall {
- c := &RegionOperationsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.operation = operation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RegionOperationsDeleteCall) Fields(s ...googleapi.Field) *RegionOperationsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RegionOperationsDeleteCall) Context(ctx context.Context) *RegionOperationsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RegionOperationsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/operations/{operation}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "operation": c.operation,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.regionOperations.delete" call.
-func (c *RegionOperationsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes the specified region-specific Operations resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.regionOperations.delete",
- // "parameterOrder": [
- // "project",
- // "region",
- // "operation"
- // ],
- // "parameters": {
- // "operation": {
- // "description": "Name of the Operations resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/operations/{operation}",
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.regionOperations.get":
-
-type RegionOperationsGetCall struct {
- s *Service
- project string
- region string
- operation string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves the specified region-specific Operations resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/regionOperations/get
-func (r *RegionOperationsService) Get(project string, region string, operation string) *RegionOperationsGetCall {
- c := &RegionOperationsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.operation = operation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RegionOperationsGetCall) Fields(s ...googleapi.Field) *RegionOperationsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *RegionOperationsGetCall) IfNoneMatch(entityTag string) *RegionOperationsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RegionOperationsGetCall) Context(ctx context.Context) *RegionOperationsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RegionOperationsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/operations/{operation}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "operation": c.operation,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.regionOperations.get" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *RegionOperationsGetCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the specified region-specific Operations resource.",
- // "httpMethod": "GET",
- // "id": "compute.regionOperations.get",
- // "parameterOrder": [
- // "project",
- // "region",
- // "operation"
- // ],
- // "parameters": {
- // "operation": {
- // "description": "Name of the Operations resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the zone scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/operations/{operation}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.regionOperations.list":
-
-type RegionOperationsListCall struct {
- s *Service
- project string
- region string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of Operation resources contained within the
-// specified region.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/regionOperations/list
-func (r *RegionOperationsService) List(project string, region string) *RegionOperationsListCall {
- c := &RegionOperationsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *RegionOperationsListCall) Filter(filter string) *RegionOperationsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *RegionOperationsListCall) MaxResults(maxResults int64) *RegionOperationsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *RegionOperationsListCall) PageToken(pageToken string) *RegionOperationsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RegionOperationsListCall) Fields(s ...googleapi.Field) *RegionOperationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *RegionOperationsListCall) IfNoneMatch(entityTag string) *RegionOperationsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RegionOperationsListCall) Context(ctx context.Context) *RegionOperationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RegionOperationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/operations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.regionOperations.list" call.
-// Exactly one of *OperationList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *OperationList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *RegionOperationsListCall) Do() (*OperationList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OperationList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of Operation resources contained within the specified region.",
- // "httpMethod": "GET",
- // "id": "compute.regionOperations.list",
- // "parameterOrder": [
- // "project",
- // "region"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/operations",
- // "response": {
- // "$ref": "OperationList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.regions.get":
-
-type RegionsGetCall struct {
- s *Service
- project string
- region string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified region resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/regions/get
-func (r *RegionsService) Get(project string, region string) *RegionsGetCall {
- c := &RegionsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RegionsGetCall) Fields(s ...googleapi.Field) *RegionsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *RegionsGetCall) IfNoneMatch(entityTag string) *RegionsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RegionsGetCall) Context(ctx context.Context) *RegionsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RegionsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.regions.get" call.
-// Exactly one of *Region or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Region.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *RegionsGetCall) Do() (*Region, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Region{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified region resource.",
- // "httpMethod": "GET",
- // "id": "compute.regions.get",
- // "parameterOrder": [
- // "project",
- // "region"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}",
- // "response": {
- // "$ref": "Region"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.regions.list":
-
-type RegionsListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of region resources available to the
-// specified project.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/regions/list
-func (r *RegionsService) List(project string) *RegionsListCall {
- c := &RegionsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *RegionsListCall) Filter(filter string) *RegionsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *RegionsListCall) MaxResults(maxResults int64) *RegionsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *RegionsListCall) PageToken(pageToken string) *RegionsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RegionsListCall) Fields(s ...googleapi.Field) *RegionsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *RegionsListCall) IfNoneMatch(entityTag string) *RegionsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RegionsListCall) Context(ctx context.Context) *RegionsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RegionsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.regions.list" call.
-// Exactly one of *RegionList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *RegionList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *RegionsListCall) Do() (*RegionList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &RegionList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of region resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.regions.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions",
- // "response": {
- // "$ref": "RegionList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.routes.delete":
-
-type RoutesDeleteCall struct {
- s *Service
- project string
- route string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified route resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/routes/delete
-func (r *RoutesService) Delete(project string, route string) *RoutesDeleteCall {
- c := &RoutesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.route = route
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RoutesDeleteCall) Fields(s ...googleapi.Field) *RoutesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RoutesDeleteCall) Context(ctx context.Context) *RoutesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RoutesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/routes/{route}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "route": c.route,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.routes.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *RoutesDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified route resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.routes.delete",
- // "parameterOrder": [
- // "project",
- // "route"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "route": {
- // "description": "Name of the route resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/routes/{route}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.routes.get":
-
-type RoutesGetCall struct {
- s *Service
- project string
- route string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified route resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/routes/get
-func (r *RoutesService) Get(project string, route string) *RoutesGetCall {
- c := &RoutesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.route = route
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RoutesGetCall) Fields(s ...googleapi.Field) *RoutesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *RoutesGetCall) IfNoneMatch(entityTag string) *RoutesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RoutesGetCall) Context(ctx context.Context) *RoutesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RoutesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/routes/{route}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "route": c.route,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.routes.get" call.
-// Exactly one of *Route or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Route.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *RoutesGetCall) Do() (*Route, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Route{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified route resource.",
- // "httpMethod": "GET",
- // "id": "compute.routes.get",
- // "parameterOrder": [
- // "project",
- // "route"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "route": {
- // "description": "Name of the route resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/routes/{route}",
- // "response": {
- // "$ref": "Route"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.routes.insert":
-
-type RoutesInsertCall struct {
- s *Service
- project string
- route *Route
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a route resource in the specified project using the
-// data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/routes/insert
-func (r *RoutesService) Insert(project string, route *Route) *RoutesInsertCall {
- c := &RoutesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.route = route
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RoutesInsertCall) Fields(s ...googleapi.Field) *RoutesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RoutesInsertCall) Context(ctx context.Context) *RoutesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RoutesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.route)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/routes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.routes.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *RoutesInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a route resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.routes.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/routes",
- // "request": {
- // "$ref": "Route"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.routes.list":
-
-type RoutesListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of route resources available to the
-// specified project.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/routes/list
-func (r *RoutesService) List(project string) *RoutesListCall {
- c := &RoutesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *RoutesListCall) Filter(filter string) *RoutesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *RoutesListCall) MaxResults(maxResults int64) *RoutesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *RoutesListCall) PageToken(pageToken string) *RoutesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RoutesListCall) Fields(s ...googleapi.Field) *RoutesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *RoutesListCall) IfNoneMatch(entityTag string) *RoutesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RoutesListCall) Context(ctx context.Context) *RoutesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RoutesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/routes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.routes.list" call.
-// Exactly one of *RouteList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *RouteList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *RoutesListCall) Do() (*RouteList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &RouteList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of route resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.routes.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/routes",
- // "response": {
- // "$ref": "RouteList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.snapshots.delete":
-
-type SnapshotsDeleteCall struct {
- s *Service
- project string
- snapshot string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified Snapshot resource. Keep in mind that
-// deleting a single snapshot might not necessarily delete all the data
-// on that snapshot. If any data on the snapshot that is marked for
-// deletion is needed for subsequent snapshots, the data will be moved
-// to the next corresponding snapshot.
-//
-// For more information, see Deleting snaphots.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/snapshots/delete
-func (r *SnapshotsService) Delete(project string, snapshot string) *SnapshotsDeleteCall {
- c := &SnapshotsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.snapshot = snapshot
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SnapshotsDeleteCall) Fields(s ...googleapi.Field) *SnapshotsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SnapshotsDeleteCall) Context(ctx context.Context) *SnapshotsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SnapshotsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/snapshots/{snapshot}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "snapshot": c.snapshot,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.snapshots.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *SnapshotsDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.\n\nFor more information, see Deleting snaphots.",
- // "httpMethod": "DELETE",
- // "id": "compute.snapshots.delete",
- // "parameterOrder": [
- // "project",
- // "snapshot"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "snapshot": {
- // "description": "Name of the Snapshot resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/snapshots/{snapshot}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.snapshots.get":
-
-type SnapshotsGetCall struct {
- s *Service
- project string
- snapshot string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified Snapshot resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/snapshots/get
-func (r *SnapshotsService) Get(project string, snapshot string) *SnapshotsGetCall {
- c := &SnapshotsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.snapshot = snapshot
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SnapshotsGetCall) Fields(s ...googleapi.Field) *SnapshotsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SnapshotsGetCall) IfNoneMatch(entityTag string) *SnapshotsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SnapshotsGetCall) Context(ctx context.Context) *SnapshotsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SnapshotsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/snapshots/{snapshot}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "snapshot": c.snapshot,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.snapshots.get" call.
-// Exactly one of *Snapshot or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Snapshot.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *SnapshotsGetCall) Do() (*Snapshot, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Snapshot{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified Snapshot resource.",
- // "httpMethod": "GET",
- // "id": "compute.snapshots.get",
- // "parameterOrder": [
- // "project",
- // "snapshot"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "snapshot": {
- // "description": "Name of the Snapshot resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/snapshots/{snapshot}",
- // "response": {
- // "$ref": "Snapshot"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.snapshots.list":
-
-type SnapshotsListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of Snapshot resources contained within the
-// specified project.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/snapshots/list
-func (r *SnapshotsService) List(project string) *SnapshotsListCall {
- c := &SnapshotsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *SnapshotsListCall) Filter(filter string) *SnapshotsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *SnapshotsListCall) MaxResults(maxResults int64) *SnapshotsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *SnapshotsListCall) PageToken(pageToken string) *SnapshotsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SnapshotsListCall) Fields(s ...googleapi.Field) *SnapshotsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SnapshotsListCall) IfNoneMatch(entityTag string) *SnapshotsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SnapshotsListCall) Context(ctx context.Context) *SnapshotsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SnapshotsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/snapshots")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.snapshots.list" call.
-// Exactly one of *SnapshotList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *SnapshotList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *SnapshotsListCall) Do() (*SnapshotList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SnapshotList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of Snapshot resources contained within the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.snapshots.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/snapshots",
- // "response": {
- // "$ref": "SnapshotList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.sslCertificates.delete":
-
-type SslCertificatesDeleteCall struct {
- s *Service
- project string
- sslCertificate string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified SslCertificate resource.
-func (r *SslCertificatesService) Delete(project string, sslCertificate string) *SslCertificatesDeleteCall {
- c := &SslCertificatesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.sslCertificate = sslCertificate
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SslCertificatesDeleteCall) Fields(s ...googleapi.Field) *SslCertificatesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SslCertificatesDeleteCall) Context(ctx context.Context) *SslCertificatesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SslCertificatesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/sslCertificates/{sslCertificate}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "sslCertificate": c.sslCertificate,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.sslCertificates.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *SslCertificatesDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified SslCertificate resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.sslCertificates.delete",
- // "parameterOrder": [
- // "project",
- // "sslCertificate"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "sslCertificate": {
- // "description": "Name of the SslCertificate resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/sslCertificates/{sslCertificate}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.sslCertificates.get":
-
-type SslCertificatesGetCall struct {
- s *Service
- project string
- sslCertificate string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified SslCertificate resource.
-func (r *SslCertificatesService) Get(project string, sslCertificate string) *SslCertificatesGetCall {
- c := &SslCertificatesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.sslCertificate = sslCertificate
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SslCertificatesGetCall) Fields(s ...googleapi.Field) *SslCertificatesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SslCertificatesGetCall) IfNoneMatch(entityTag string) *SslCertificatesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SslCertificatesGetCall) Context(ctx context.Context) *SslCertificatesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SslCertificatesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/sslCertificates/{sslCertificate}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "sslCertificate": c.sslCertificate,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.sslCertificates.get" call.
-// Exactly one of *SslCertificate or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *SslCertificate.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *SslCertificatesGetCall) Do() (*SslCertificate, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SslCertificate{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified SslCertificate resource.",
- // "httpMethod": "GET",
- // "id": "compute.sslCertificates.get",
- // "parameterOrder": [
- // "project",
- // "sslCertificate"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "sslCertificate": {
- // "description": "Name of the SslCertificate resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/sslCertificates/{sslCertificate}",
- // "response": {
- // "$ref": "SslCertificate"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.sslCertificates.insert":
-
-type SslCertificatesInsertCall struct {
- s *Service
- project string
- sslcertificate *SslCertificate
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a SslCertificate resource in the specified project
-// using the data included in the request.
-func (r *SslCertificatesService) Insert(project string, sslcertificate *SslCertificate) *SslCertificatesInsertCall {
- c := &SslCertificatesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.sslcertificate = sslcertificate
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SslCertificatesInsertCall) Fields(s ...googleapi.Field) *SslCertificatesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SslCertificatesInsertCall) Context(ctx context.Context) *SslCertificatesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SslCertificatesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.sslcertificate)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/sslCertificates")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.sslCertificates.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *SslCertificatesInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a SslCertificate resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.sslCertificates.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/sslCertificates",
- // "request": {
- // "$ref": "SslCertificate"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.sslCertificates.list":
-
-type SslCertificatesListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of SslCertificate resources available to the
-// specified project.
-func (r *SslCertificatesService) List(project string) *SslCertificatesListCall {
- c := &SslCertificatesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *SslCertificatesListCall) Filter(filter string) *SslCertificatesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *SslCertificatesListCall) MaxResults(maxResults int64) *SslCertificatesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *SslCertificatesListCall) PageToken(pageToken string) *SslCertificatesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SslCertificatesListCall) Fields(s ...googleapi.Field) *SslCertificatesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SslCertificatesListCall) IfNoneMatch(entityTag string) *SslCertificatesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SslCertificatesListCall) Context(ctx context.Context) *SslCertificatesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SslCertificatesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/sslCertificates")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.sslCertificates.list" call.
-// Exactly one of *SslCertificateList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *SslCertificateList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *SslCertificatesListCall) Do() (*SslCertificateList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SslCertificateList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of SslCertificate resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.sslCertificates.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/sslCertificates",
- // "response": {
- // "$ref": "SslCertificateList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.targetHttpProxies.delete":
-
-type TargetHttpProxiesDeleteCall struct {
- s *Service
- project string
- targetHttpProxy string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified TargetHttpProxy resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetHttpProxies/delete
-func (r *TargetHttpProxiesService) Delete(project string, targetHttpProxy string) *TargetHttpProxiesDeleteCall {
- c := &TargetHttpProxiesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.targetHttpProxy = targetHttpProxy
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetHttpProxiesDeleteCall) Fields(s ...googleapi.Field) *TargetHttpProxiesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetHttpProxiesDeleteCall) Context(ctx context.Context) *TargetHttpProxiesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetHttpProxiesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/targetHttpProxies/{targetHttpProxy}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "targetHttpProxy": c.targetHttpProxy,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetHttpProxies.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetHttpProxiesDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified TargetHttpProxy resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.targetHttpProxies.delete",
- // "parameterOrder": [
- // "project",
- // "targetHttpProxy"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "targetHttpProxy": {
- // "description": "Name of the TargetHttpProxy resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/targetHttpProxies/{targetHttpProxy}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetHttpProxies.get":
-
-type TargetHttpProxiesGetCall struct {
- s *Service
- project string
- targetHttpProxy string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified TargetHttpProxy resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetHttpProxies/get
-func (r *TargetHttpProxiesService) Get(project string, targetHttpProxy string) *TargetHttpProxiesGetCall {
- c := &TargetHttpProxiesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.targetHttpProxy = targetHttpProxy
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetHttpProxiesGetCall) Fields(s ...googleapi.Field) *TargetHttpProxiesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TargetHttpProxiesGetCall) IfNoneMatch(entityTag string) *TargetHttpProxiesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetHttpProxiesGetCall) Context(ctx context.Context) *TargetHttpProxiesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetHttpProxiesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/targetHttpProxies/{targetHttpProxy}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "targetHttpProxy": c.targetHttpProxy,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetHttpProxies.get" call.
-// Exactly one of *TargetHttpProxy or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *TargetHttpProxy.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TargetHttpProxiesGetCall) Do() (*TargetHttpProxy, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetHttpProxy{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified TargetHttpProxy resource.",
- // "httpMethod": "GET",
- // "id": "compute.targetHttpProxies.get",
- // "parameterOrder": [
- // "project",
- // "targetHttpProxy"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "targetHttpProxy": {
- // "description": "Name of the TargetHttpProxy resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/targetHttpProxies/{targetHttpProxy}",
- // "response": {
- // "$ref": "TargetHttpProxy"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.targetHttpProxies.insert":
-
-type TargetHttpProxiesInsertCall struct {
- s *Service
- project string
- targethttpproxy *TargetHttpProxy
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a TargetHttpProxy resource in the specified project
-// using the data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetHttpProxies/insert
-func (r *TargetHttpProxiesService) Insert(project string, targethttpproxy *TargetHttpProxy) *TargetHttpProxiesInsertCall {
- c := &TargetHttpProxiesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.targethttpproxy = targethttpproxy
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetHttpProxiesInsertCall) Fields(s ...googleapi.Field) *TargetHttpProxiesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetHttpProxiesInsertCall) Context(ctx context.Context) *TargetHttpProxiesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetHttpProxiesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.targethttpproxy)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/targetHttpProxies")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetHttpProxies.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetHttpProxiesInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a TargetHttpProxy resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.targetHttpProxies.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/targetHttpProxies",
- // "request": {
- // "$ref": "TargetHttpProxy"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetHttpProxies.list":
-
-type TargetHttpProxiesListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of TargetHttpProxy resources available to
-// the specified project.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetHttpProxies/list
-func (r *TargetHttpProxiesService) List(project string) *TargetHttpProxiesListCall {
- c := &TargetHttpProxiesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *TargetHttpProxiesListCall) Filter(filter string) *TargetHttpProxiesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *TargetHttpProxiesListCall) MaxResults(maxResults int64) *TargetHttpProxiesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *TargetHttpProxiesListCall) PageToken(pageToken string) *TargetHttpProxiesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetHttpProxiesListCall) Fields(s ...googleapi.Field) *TargetHttpProxiesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TargetHttpProxiesListCall) IfNoneMatch(entityTag string) *TargetHttpProxiesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetHttpProxiesListCall) Context(ctx context.Context) *TargetHttpProxiesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetHttpProxiesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/targetHttpProxies")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetHttpProxies.list" call.
-// Exactly one of *TargetHttpProxyList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *TargetHttpProxyList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TargetHttpProxiesListCall) Do() (*TargetHttpProxyList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetHttpProxyList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of TargetHttpProxy resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.targetHttpProxies.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/targetHttpProxies",
- // "response": {
- // "$ref": "TargetHttpProxyList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.targetHttpProxies.setUrlMap":
-
-type TargetHttpProxiesSetUrlMapCall struct {
- s *Service
- project string
- targetHttpProxy string
- urlmapreference *UrlMapReference
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetUrlMap: Changes the URL map for TargetHttpProxy.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetHttpProxies/setUrlMap
-func (r *TargetHttpProxiesService) SetUrlMap(project string, targetHttpProxy string, urlmapreference *UrlMapReference) *TargetHttpProxiesSetUrlMapCall {
- c := &TargetHttpProxiesSetUrlMapCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.targetHttpProxy = targetHttpProxy
- c.urlmapreference = urlmapreference
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetHttpProxiesSetUrlMapCall) Fields(s ...googleapi.Field) *TargetHttpProxiesSetUrlMapCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetHttpProxiesSetUrlMapCall) Context(ctx context.Context) *TargetHttpProxiesSetUrlMapCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetHttpProxiesSetUrlMapCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.urlmapreference)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "targetHttpProxy": c.targetHttpProxy,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetHttpProxies.setUrlMap" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetHttpProxiesSetUrlMapCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Changes the URL map for TargetHttpProxy.",
- // "httpMethod": "POST",
- // "id": "compute.targetHttpProxies.setUrlMap",
- // "parameterOrder": [
- // "project",
- // "targetHttpProxy"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "targetHttpProxy": {
- // "description": "Name of the TargetHttpProxy resource whose URL map is to be set.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap",
- // "request": {
- // "$ref": "UrlMapReference"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetHttpsProxies.delete":
-
-type TargetHttpsProxiesDeleteCall struct {
- s *Service
- project string
- targetHttpsProxy string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified TargetHttpsProxy resource.
-func (r *TargetHttpsProxiesService) Delete(project string, targetHttpsProxy string) *TargetHttpsProxiesDeleteCall {
- c := &TargetHttpsProxiesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.targetHttpsProxy = targetHttpsProxy
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetHttpsProxiesDeleteCall) Fields(s ...googleapi.Field) *TargetHttpsProxiesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetHttpsProxiesDeleteCall) Context(ctx context.Context) *TargetHttpsProxiesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetHttpsProxiesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/targetHttpsProxies/{targetHttpsProxy}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "targetHttpsProxy": c.targetHttpsProxy,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetHttpsProxies.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetHttpsProxiesDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified TargetHttpsProxy resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.targetHttpsProxies.delete",
- // "parameterOrder": [
- // "project",
- // "targetHttpsProxy"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "targetHttpsProxy": {
- // "description": "Name of the TargetHttpsProxy resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/targetHttpsProxies/{targetHttpsProxy}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetHttpsProxies.get":
-
-type TargetHttpsProxiesGetCall struct {
- s *Service
- project string
- targetHttpsProxy string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified TargetHttpsProxy resource.
-func (r *TargetHttpsProxiesService) Get(project string, targetHttpsProxy string) *TargetHttpsProxiesGetCall {
- c := &TargetHttpsProxiesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.targetHttpsProxy = targetHttpsProxy
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetHttpsProxiesGetCall) Fields(s ...googleapi.Field) *TargetHttpsProxiesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TargetHttpsProxiesGetCall) IfNoneMatch(entityTag string) *TargetHttpsProxiesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetHttpsProxiesGetCall) Context(ctx context.Context) *TargetHttpsProxiesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetHttpsProxiesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/targetHttpsProxies/{targetHttpsProxy}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "targetHttpsProxy": c.targetHttpsProxy,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetHttpsProxies.get" call.
-// Exactly one of *TargetHttpsProxy or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *TargetHttpsProxy.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TargetHttpsProxiesGetCall) Do() (*TargetHttpsProxy, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetHttpsProxy{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified TargetHttpsProxy resource.",
- // "httpMethod": "GET",
- // "id": "compute.targetHttpsProxies.get",
- // "parameterOrder": [
- // "project",
- // "targetHttpsProxy"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "targetHttpsProxy": {
- // "description": "Name of the TargetHttpsProxy resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/targetHttpsProxies/{targetHttpsProxy}",
- // "response": {
- // "$ref": "TargetHttpsProxy"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.targetHttpsProxies.insert":
-
-type TargetHttpsProxiesInsertCall struct {
- s *Service
- project string
- targethttpsproxy *TargetHttpsProxy
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a TargetHttpsProxy resource in the specified project
-// using the data included in the request.
-func (r *TargetHttpsProxiesService) Insert(project string, targethttpsproxy *TargetHttpsProxy) *TargetHttpsProxiesInsertCall {
- c := &TargetHttpsProxiesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.targethttpsproxy = targethttpsproxy
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetHttpsProxiesInsertCall) Fields(s ...googleapi.Field) *TargetHttpsProxiesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetHttpsProxiesInsertCall) Context(ctx context.Context) *TargetHttpsProxiesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetHttpsProxiesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.targethttpsproxy)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/targetHttpsProxies")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetHttpsProxies.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetHttpsProxiesInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a TargetHttpsProxy resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.targetHttpsProxies.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/targetHttpsProxies",
- // "request": {
- // "$ref": "TargetHttpsProxy"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetHttpsProxies.list":
-
-type TargetHttpsProxiesListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of TargetHttpsProxy resources available to
-// the specified project.
-func (r *TargetHttpsProxiesService) List(project string) *TargetHttpsProxiesListCall {
- c := &TargetHttpsProxiesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *TargetHttpsProxiesListCall) Filter(filter string) *TargetHttpsProxiesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *TargetHttpsProxiesListCall) MaxResults(maxResults int64) *TargetHttpsProxiesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *TargetHttpsProxiesListCall) PageToken(pageToken string) *TargetHttpsProxiesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetHttpsProxiesListCall) Fields(s ...googleapi.Field) *TargetHttpsProxiesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TargetHttpsProxiesListCall) IfNoneMatch(entityTag string) *TargetHttpsProxiesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetHttpsProxiesListCall) Context(ctx context.Context) *TargetHttpsProxiesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetHttpsProxiesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/targetHttpsProxies")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetHttpsProxies.list" call.
-// Exactly one of *TargetHttpsProxyList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *TargetHttpsProxyList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TargetHttpsProxiesListCall) Do() (*TargetHttpsProxyList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetHttpsProxyList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of TargetHttpsProxy resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.targetHttpsProxies.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/targetHttpsProxies",
- // "response": {
- // "$ref": "TargetHttpsProxyList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.targetHttpsProxies.setSslCertificates":
-
-type TargetHttpsProxiesSetSslCertificatesCall struct {
- s *Service
- project string
- targetHttpsProxy string
- targethttpsproxiessetsslcertificatesrequest *TargetHttpsProxiesSetSslCertificatesRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetSslCertificates: Replaces SslCertificates for TargetHttpsProxy.
-func (r *TargetHttpsProxiesService) SetSslCertificates(project string, targetHttpsProxy string, targethttpsproxiessetsslcertificatesrequest *TargetHttpsProxiesSetSslCertificatesRequest) *TargetHttpsProxiesSetSslCertificatesCall {
- c := &TargetHttpsProxiesSetSslCertificatesCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.targetHttpsProxy = targetHttpsProxy
- c.targethttpsproxiessetsslcertificatesrequest = targethttpsproxiessetsslcertificatesrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetHttpsProxiesSetSslCertificatesCall) Fields(s ...googleapi.Field) *TargetHttpsProxiesSetSslCertificatesCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetHttpsProxiesSetSslCertificatesCall) Context(ctx context.Context) *TargetHttpsProxiesSetSslCertificatesCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetHttpsProxiesSetSslCertificatesCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.targethttpsproxiessetsslcertificatesrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "targetHttpsProxy": c.targetHttpsProxy,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetHttpsProxies.setSslCertificates" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetHttpsProxiesSetSslCertificatesCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Replaces SslCertificates for TargetHttpsProxy.",
- // "httpMethod": "POST",
- // "id": "compute.targetHttpsProxies.setSslCertificates",
- // "parameterOrder": [
- // "project",
- // "targetHttpsProxy"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "targetHttpsProxy": {
- // "description": "Name of the TargetHttpsProxy resource whose URL map is to be set.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates",
- // "request": {
- // "$ref": "TargetHttpsProxiesSetSslCertificatesRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetHttpsProxies.setUrlMap":
-
-type TargetHttpsProxiesSetUrlMapCall struct {
- s *Service
- project string
- targetHttpsProxy string
- urlmapreference *UrlMapReference
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetUrlMap: Changes the URL map for TargetHttpsProxy.
-func (r *TargetHttpsProxiesService) SetUrlMap(project string, targetHttpsProxy string, urlmapreference *UrlMapReference) *TargetHttpsProxiesSetUrlMapCall {
- c := &TargetHttpsProxiesSetUrlMapCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.targetHttpsProxy = targetHttpsProxy
- c.urlmapreference = urlmapreference
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetHttpsProxiesSetUrlMapCall) Fields(s ...googleapi.Field) *TargetHttpsProxiesSetUrlMapCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetHttpsProxiesSetUrlMapCall) Context(ctx context.Context) *TargetHttpsProxiesSetUrlMapCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetHttpsProxiesSetUrlMapCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.urlmapreference)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "targetHttpsProxy": c.targetHttpsProxy,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetHttpsProxies.setUrlMap" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetHttpsProxiesSetUrlMapCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Changes the URL map for TargetHttpsProxy.",
- // "httpMethod": "POST",
- // "id": "compute.targetHttpsProxies.setUrlMap",
- // "parameterOrder": [
- // "project",
- // "targetHttpsProxy"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "targetHttpsProxy": {
- // "description": "Name of the TargetHttpsProxy resource whose URL map is to be set.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap",
- // "request": {
- // "$ref": "UrlMapReference"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetInstances.aggregatedList":
-
-type TargetInstancesAggregatedListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AggregatedList: Retrieves the list of target instances grouped by
-// scope.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetInstances/aggregatedList
-func (r *TargetInstancesService) AggregatedList(project string) *TargetInstancesAggregatedListCall {
- c := &TargetInstancesAggregatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *TargetInstancesAggregatedListCall) Filter(filter string) *TargetInstancesAggregatedListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *TargetInstancesAggregatedListCall) MaxResults(maxResults int64) *TargetInstancesAggregatedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *TargetInstancesAggregatedListCall) PageToken(pageToken string) *TargetInstancesAggregatedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetInstancesAggregatedListCall) Fields(s ...googleapi.Field) *TargetInstancesAggregatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TargetInstancesAggregatedListCall) IfNoneMatch(entityTag string) *TargetInstancesAggregatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetInstancesAggregatedListCall) Context(ctx context.Context) *TargetInstancesAggregatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetInstancesAggregatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/aggregated/targetInstances")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetInstances.aggregatedList" call.
-// Exactly one of *TargetInstanceAggregatedList or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *TargetInstanceAggregatedList.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TargetInstancesAggregatedListCall) Do() (*TargetInstanceAggregatedList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetInstanceAggregatedList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of target instances grouped by scope.",
- // "httpMethod": "GET",
- // "id": "compute.targetInstances.aggregatedList",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/aggregated/targetInstances",
- // "response": {
- // "$ref": "TargetInstanceAggregatedList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.targetInstances.delete":
-
-type TargetInstancesDeleteCall struct {
- s *Service
- project string
- zone string
- targetInstance string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified TargetInstance resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetInstances/delete
-func (r *TargetInstancesService) Delete(project string, zone string, targetInstance string) *TargetInstancesDeleteCall {
- c := &TargetInstancesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.targetInstance = targetInstance
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetInstancesDeleteCall) Fields(s ...googleapi.Field) *TargetInstancesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetInstancesDeleteCall) Context(ctx context.Context) *TargetInstancesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetInstancesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/targetInstances/{targetInstance}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "targetInstance": c.targetInstance,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetInstances.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetInstancesDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified TargetInstance resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.targetInstances.delete",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "targetInstance"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "targetInstance": {
- // "description": "Name of the TargetInstance resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/targetInstances/{targetInstance}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetInstances.get":
-
-type TargetInstancesGetCall struct {
- s *Service
- project string
- zone string
- targetInstance string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified TargetInstance resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetInstances/get
-func (r *TargetInstancesService) Get(project string, zone string, targetInstance string) *TargetInstancesGetCall {
- c := &TargetInstancesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.targetInstance = targetInstance
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetInstancesGetCall) Fields(s ...googleapi.Field) *TargetInstancesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TargetInstancesGetCall) IfNoneMatch(entityTag string) *TargetInstancesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetInstancesGetCall) Context(ctx context.Context) *TargetInstancesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetInstancesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/targetInstances/{targetInstance}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "targetInstance": c.targetInstance,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetInstances.get" call.
-// Exactly one of *TargetInstance or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *TargetInstance.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TargetInstancesGetCall) Do() (*TargetInstance, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetInstance{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified TargetInstance resource.",
- // "httpMethod": "GET",
- // "id": "compute.targetInstances.get",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "targetInstance"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "targetInstance": {
- // "description": "Name of the TargetInstance resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/targetInstances/{targetInstance}",
- // "response": {
- // "$ref": "TargetInstance"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.targetInstances.insert":
-
-type TargetInstancesInsertCall struct {
- s *Service
- project string
- zone string
- targetinstance *TargetInstance
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a TargetInstance resource in the specified project
-// and zone using the data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetInstances/insert
-func (r *TargetInstancesService) Insert(project string, zone string, targetinstance *TargetInstance) *TargetInstancesInsertCall {
- c := &TargetInstancesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.targetinstance = targetinstance
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetInstancesInsertCall) Fields(s ...googleapi.Field) *TargetInstancesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetInstancesInsertCall) Context(ctx context.Context) *TargetInstancesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetInstancesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.targetinstance)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/targetInstances")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetInstances.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetInstancesInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a TargetInstance resource in the specified project and zone using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.targetInstances.insert",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/targetInstances",
- // "request": {
- // "$ref": "TargetInstance"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetInstances.list":
-
-type TargetInstancesListCall struct {
- s *Service
- project string
- zone string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of TargetInstance resources available to the
-// specified project and zone.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetInstances/list
-func (r *TargetInstancesService) List(project string, zone string) *TargetInstancesListCall {
- c := &TargetInstancesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *TargetInstancesListCall) Filter(filter string) *TargetInstancesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *TargetInstancesListCall) MaxResults(maxResults int64) *TargetInstancesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *TargetInstancesListCall) PageToken(pageToken string) *TargetInstancesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetInstancesListCall) Fields(s ...googleapi.Field) *TargetInstancesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TargetInstancesListCall) IfNoneMatch(entityTag string) *TargetInstancesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetInstancesListCall) Context(ctx context.Context) *TargetInstancesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetInstancesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/targetInstances")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetInstances.list" call.
-// Exactly one of *TargetInstanceList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *TargetInstanceList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TargetInstancesListCall) Do() (*TargetInstanceList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetInstanceList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of TargetInstance resources available to the specified project and zone.",
- // "httpMethod": "GET",
- // "id": "compute.targetInstances.list",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/targetInstances",
- // "response": {
- // "$ref": "TargetInstanceList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.targetPools.addHealthCheck":
-
-type TargetPoolsAddHealthCheckCall struct {
- s *Service
- project string
- region string
- targetPool string
- targetpoolsaddhealthcheckrequest *TargetPoolsAddHealthCheckRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AddHealthCheck: Adds health check URL to targetPool.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetPools/addHealthCheck
-func (r *TargetPoolsService) AddHealthCheck(project string, region string, targetPool string, targetpoolsaddhealthcheckrequest *TargetPoolsAddHealthCheckRequest) *TargetPoolsAddHealthCheckCall {
- c := &TargetPoolsAddHealthCheckCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.targetPool = targetPool
- c.targetpoolsaddhealthcheckrequest = targetpoolsaddhealthcheckrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetPoolsAddHealthCheckCall) Fields(s ...googleapi.Field) *TargetPoolsAddHealthCheckCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetPoolsAddHealthCheckCall) Context(ctx context.Context) *TargetPoolsAddHealthCheckCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetPoolsAddHealthCheckCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.targetpoolsaddhealthcheckrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "targetPool": c.targetPool,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetPools.addHealthCheck" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetPoolsAddHealthCheckCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Adds health check URL to targetPool.",
- // "httpMethod": "POST",
- // "id": "compute.targetPools.addHealthCheck",
- // "parameterOrder": [
- // "project",
- // "region",
- // "targetPool"
- // ],
- // "parameters": {
- // "project": {
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "targetPool": {
- // "description": "Name of the TargetPool resource to which health_check_url is to be added.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck",
- // "request": {
- // "$ref": "TargetPoolsAddHealthCheckRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetPools.addInstance":
-
-type TargetPoolsAddInstanceCall struct {
- s *Service
- project string
- region string
- targetPool string
- targetpoolsaddinstancerequest *TargetPoolsAddInstanceRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AddInstance: Adds instance url to targetPool.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetPools/addInstance
-func (r *TargetPoolsService) AddInstance(project string, region string, targetPool string, targetpoolsaddinstancerequest *TargetPoolsAddInstanceRequest) *TargetPoolsAddInstanceCall {
- c := &TargetPoolsAddInstanceCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.targetPool = targetPool
- c.targetpoolsaddinstancerequest = targetpoolsaddinstancerequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetPoolsAddInstanceCall) Fields(s ...googleapi.Field) *TargetPoolsAddInstanceCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetPoolsAddInstanceCall) Context(ctx context.Context) *TargetPoolsAddInstanceCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetPoolsAddInstanceCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.targetpoolsaddinstancerequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/targetPools/{targetPool}/addInstance")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "targetPool": c.targetPool,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetPools.addInstance" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetPoolsAddInstanceCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Adds instance url to targetPool.",
- // "httpMethod": "POST",
- // "id": "compute.targetPools.addInstance",
- // "parameterOrder": [
- // "project",
- // "region",
- // "targetPool"
- // ],
- // "parameters": {
- // "project": {
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "targetPool": {
- // "description": "Name of the TargetPool resource to which instance_url is to be added.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/targetPools/{targetPool}/addInstance",
- // "request": {
- // "$ref": "TargetPoolsAddInstanceRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetPools.aggregatedList":
-
-type TargetPoolsAggregatedListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AggregatedList: Retrieves the list of target pools grouped by scope.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetPools/aggregatedList
-func (r *TargetPoolsService) AggregatedList(project string) *TargetPoolsAggregatedListCall {
- c := &TargetPoolsAggregatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *TargetPoolsAggregatedListCall) Filter(filter string) *TargetPoolsAggregatedListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *TargetPoolsAggregatedListCall) MaxResults(maxResults int64) *TargetPoolsAggregatedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *TargetPoolsAggregatedListCall) PageToken(pageToken string) *TargetPoolsAggregatedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetPoolsAggregatedListCall) Fields(s ...googleapi.Field) *TargetPoolsAggregatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TargetPoolsAggregatedListCall) IfNoneMatch(entityTag string) *TargetPoolsAggregatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetPoolsAggregatedListCall) Context(ctx context.Context) *TargetPoolsAggregatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetPoolsAggregatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/aggregated/targetPools")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetPools.aggregatedList" call.
-// Exactly one of *TargetPoolAggregatedList or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *TargetPoolAggregatedList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TargetPoolsAggregatedListCall) Do() (*TargetPoolAggregatedList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetPoolAggregatedList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of target pools grouped by scope.",
- // "httpMethod": "GET",
- // "id": "compute.targetPools.aggregatedList",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/aggregated/targetPools",
- // "response": {
- // "$ref": "TargetPoolAggregatedList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.targetPools.delete":
-
-type TargetPoolsDeleteCall struct {
- s *Service
- project string
- region string
- targetPool string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified TargetPool resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetPools/delete
-func (r *TargetPoolsService) Delete(project string, region string, targetPool string) *TargetPoolsDeleteCall {
- c := &TargetPoolsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.targetPool = targetPool
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetPoolsDeleteCall) Fields(s ...googleapi.Field) *TargetPoolsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetPoolsDeleteCall) Context(ctx context.Context) *TargetPoolsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetPoolsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/targetPools/{targetPool}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "targetPool": c.targetPool,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetPools.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetPoolsDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified TargetPool resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.targetPools.delete",
- // "parameterOrder": [
- // "project",
- // "region",
- // "targetPool"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "targetPool": {
- // "description": "Name of the TargetPool resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/targetPools/{targetPool}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetPools.get":
-
-type TargetPoolsGetCall struct {
- s *Service
- project string
- region string
- targetPool string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified TargetPool resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetPools/get
-func (r *TargetPoolsService) Get(project string, region string, targetPool string) *TargetPoolsGetCall {
- c := &TargetPoolsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.targetPool = targetPool
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetPoolsGetCall) Fields(s ...googleapi.Field) *TargetPoolsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TargetPoolsGetCall) IfNoneMatch(entityTag string) *TargetPoolsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetPoolsGetCall) Context(ctx context.Context) *TargetPoolsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetPoolsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/targetPools/{targetPool}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "targetPool": c.targetPool,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetPools.get" call.
-// Exactly one of *TargetPool or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *TargetPool.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetPoolsGetCall) Do() (*TargetPool, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetPool{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified TargetPool resource.",
- // "httpMethod": "GET",
- // "id": "compute.targetPools.get",
- // "parameterOrder": [
- // "project",
- // "region",
- // "targetPool"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "targetPool": {
- // "description": "Name of the TargetPool resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/targetPools/{targetPool}",
- // "response": {
- // "$ref": "TargetPool"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.targetPools.getHealth":
-
-type TargetPoolsGetHealthCall struct {
- s *Service
- project string
- region string
- targetPool string
- instancereference *InstanceReference
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetHealth: Gets the most recent health check results for each IP for
-// the given instance that is referenced by given TargetPool.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetPools/getHealth
-func (r *TargetPoolsService) GetHealth(project string, region string, targetPool string, instancereference *InstanceReference) *TargetPoolsGetHealthCall {
- c := &TargetPoolsGetHealthCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.targetPool = targetPool
- c.instancereference = instancereference
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetPoolsGetHealthCall) Fields(s ...googleapi.Field) *TargetPoolsGetHealthCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetPoolsGetHealthCall) Context(ctx context.Context) *TargetPoolsGetHealthCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetPoolsGetHealthCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancereference)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/targetPools/{targetPool}/getHealth")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "targetPool": c.targetPool,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetPools.getHealth" call.
-// Exactly one of *TargetPoolInstanceHealth or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *TargetPoolInstanceHealth.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TargetPoolsGetHealthCall) Do() (*TargetPoolInstanceHealth, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetPoolInstanceHealth{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the most recent health check results for each IP for the given instance that is referenced by given TargetPool.",
- // "httpMethod": "POST",
- // "id": "compute.targetPools.getHealth",
- // "parameterOrder": [
- // "project",
- // "region",
- // "targetPool"
- // ],
- // "parameters": {
- // "project": {
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "targetPool": {
- // "description": "Name of the TargetPool resource to which the queried instance belongs.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/targetPools/{targetPool}/getHealth",
- // "request": {
- // "$ref": "InstanceReference"
- // },
- // "response": {
- // "$ref": "TargetPoolInstanceHealth"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.targetPools.insert":
-
-type TargetPoolsInsertCall struct {
- s *Service
- project string
- region string
- targetpool *TargetPool
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a TargetPool resource in the specified project and
-// region using the data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetPools/insert
-func (r *TargetPoolsService) Insert(project string, region string, targetpool *TargetPool) *TargetPoolsInsertCall {
- c := &TargetPoolsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.targetpool = targetpool
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetPoolsInsertCall) Fields(s ...googleapi.Field) *TargetPoolsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetPoolsInsertCall) Context(ctx context.Context) *TargetPoolsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetPoolsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.targetpool)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/targetPools")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetPools.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetPoolsInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a TargetPool resource in the specified project and region using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.targetPools.insert",
- // "parameterOrder": [
- // "project",
- // "region"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/targetPools",
- // "request": {
- // "$ref": "TargetPool"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetPools.list":
-
-type TargetPoolsListCall struct {
- s *Service
- project string
- region string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of TargetPool resources available to the
-// specified project and region.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetPools/list
-func (r *TargetPoolsService) List(project string, region string) *TargetPoolsListCall {
- c := &TargetPoolsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *TargetPoolsListCall) Filter(filter string) *TargetPoolsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *TargetPoolsListCall) MaxResults(maxResults int64) *TargetPoolsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *TargetPoolsListCall) PageToken(pageToken string) *TargetPoolsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetPoolsListCall) Fields(s ...googleapi.Field) *TargetPoolsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TargetPoolsListCall) IfNoneMatch(entityTag string) *TargetPoolsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetPoolsListCall) Context(ctx context.Context) *TargetPoolsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetPoolsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/targetPools")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetPools.list" call.
-// Exactly one of *TargetPoolList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *TargetPoolList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TargetPoolsListCall) Do() (*TargetPoolList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetPoolList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of TargetPool resources available to the specified project and region.",
- // "httpMethod": "GET",
- // "id": "compute.targetPools.list",
- // "parameterOrder": [
- // "project",
- // "region"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/targetPools",
- // "response": {
- // "$ref": "TargetPoolList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.targetPools.removeHealthCheck":
-
-type TargetPoolsRemoveHealthCheckCall struct {
- s *Service
- project string
- region string
- targetPool string
- targetpoolsremovehealthcheckrequest *TargetPoolsRemoveHealthCheckRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// RemoveHealthCheck: Removes health check URL from targetPool.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetPools/removeHealthCheck
-func (r *TargetPoolsService) RemoveHealthCheck(project string, region string, targetPool string, targetpoolsremovehealthcheckrequest *TargetPoolsRemoveHealthCheckRequest) *TargetPoolsRemoveHealthCheckCall {
- c := &TargetPoolsRemoveHealthCheckCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.targetPool = targetPool
- c.targetpoolsremovehealthcheckrequest = targetpoolsremovehealthcheckrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetPoolsRemoveHealthCheckCall) Fields(s ...googleapi.Field) *TargetPoolsRemoveHealthCheckCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetPoolsRemoveHealthCheckCall) Context(ctx context.Context) *TargetPoolsRemoveHealthCheckCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetPoolsRemoveHealthCheckCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.targetpoolsremovehealthcheckrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "targetPool": c.targetPool,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetPools.removeHealthCheck" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetPoolsRemoveHealthCheckCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Removes health check URL from targetPool.",
- // "httpMethod": "POST",
- // "id": "compute.targetPools.removeHealthCheck",
- // "parameterOrder": [
- // "project",
- // "region",
- // "targetPool"
- // ],
- // "parameters": {
- // "project": {
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "targetPool": {
- // "description": "Name of the TargetPool resource to which health_check_url is to be removed.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck",
- // "request": {
- // "$ref": "TargetPoolsRemoveHealthCheckRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetPools.removeInstance":
-
-type TargetPoolsRemoveInstanceCall struct {
- s *Service
- project string
- region string
- targetPool string
- targetpoolsremoveinstancerequest *TargetPoolsRemoveInstanceRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// RemoveInstance: Removes instance URL from targetPool.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetPools/removeInstance
-func (r *TargetPoolsService) RemoveInstance(project string, region string, targetPool string, targetpoolsremoveinstancerequest *TargetPoolsRemoveInstanceRequest) *TargetPoolsRemoveInstanceCall {
- c := &TargetPoolsRemoveInstanceCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.targetPool = targetPool
- c.targetpoolsremoveinstancerequest = targetpoolsremoveinstancerequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetPoolsRemoveInstanceCall) Fields(s ...googleapi.Field) *TargetPoolsRemoveInstanceCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetPoolsRemoveInstanceCall) Context(ctx context.Context) *TargetPoolsRemoveInstanceCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetPoolsRemoveInstanceCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.targetpoolsremoveinstancerequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/targetPools/{targetPool}/removeInstance")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "targetPool": c.targetPool,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetPools.removeInstance" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetPoolsRemoveInstanceCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Removes instance URL from targetPool.",
- // "httpMethod": "POST",
- // "id": "compute.targetPools.removeInstance",
- // "parameterOrder": [
- // "project",
- // "region",
- // "targetPool"
- // ],
- // "parameters": {
- // "project": {
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "targetPool": {
- // "description": "Name of the TargetPool resource to which instance_url is to be removed.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/targetPools/{targetPool}/removeInstance",
- // "request": {
- // "$ref": "TargetPoolsRemoveInstanceRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetPools.setBackup":
-
-type TargetPoolsSetBackupCall struct {
- s *Service
- project string
- region string
- targetPool string
- targetreference *TargetReference
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// SetBackup: Changes backup pool configurations.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/targetPools/setBackup
-func (r *TargetPoolsService) SetBackup(project string, region string, targetPool string, targetreference *TargetReference) *TargetPoolsSetBackupCall {
- c := &TargetPoolsSetBackupCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.targetPool = targetPool
- c.targetreference = targetreference
- return c
-}
-
-// FailoverRatio sets the optional parameter "failoverRatio": New
-// failoverRatio value for the containing target pool.
-func (c *TargetPoolsSetBackupCall) FailoverRatio(failoverRatio float64) *TargetPoolsSetBackupCall {
- c.opt_["failoverRatio"] = failoverRatio
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetPoolsSetBackupCall) Fields(s ...googleapi.Field) *TargetPoolsSetBackupCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetPoolsSetBackupCall) Context(ctx context.Context) *TargetPoolsSetBackupCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetPoolsSetBackupCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.targetreference)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["failoverRatio"]; ok {
- params.Set("failoverRatio", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/targetPools/{targetPool}/setBackup")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "targetPool": c.targetPool,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetPools.setBackup" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetPoolsSetBackupCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Changes backup pool configurations.",
- // "httpMethod": "POST",
- // "id": "compute.targetPools.setBackup",
- // "parameterOrder": [
- // "project",
- // "region",
- // "targetPool"
- // ],
- // "parameters": {
- // "failoverRatio": {
- // "description": "New failoverRatio value for the containing target pool.",
- // "format": "float",
- // "location": "query",
- // "type": "number"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "Name of the region scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "targetPool": {
- // "description": "Name of the TargetPool resource for which the backup is to be set.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/targetPools/{targetPool}/setBackup",
- // "request": {
- // "$ref": "TargetReference"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetVpnGateways.aggregatedList":
-
-type TargetVpnGatewaysAggregatedListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AggregatedList: Retrieves the list of target VPN gateways grouped by
-// scope.
-func (r *TargetVpnGatewaysService) AggregatedList(project string) *TargetVpnGatewaysAggregatedListCall {
- c := &TargetVpnGatewaysAggregatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *TargetVpnGatewaysAggregatedListCall) Filter(filter string) *TargetVpnGatewaysAggregatedListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *TargetVpnGatewaysAggregatedListCall) MaxResults(maxResults int64) *TargetVpnGatewaysAggregatedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *TargetVpnGatewaysAggregatedListCall) PageToken(pageToken string) *TargetVpnGatewaysAggregatedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetVpnGatewaysAggregatedListCall) Fields(s ...googleapi.Field) *TargetVpnGatewaysAggregatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TargetVpnGatewaysAggregatedListCall) IfNoneMatch(entityTag string) *TargetVpnGatewaysAggregatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetVpnGatewaysAggregatedListCall) Context(ctx context.Context) *TargetVpnGatewaysAggregatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetVpnGatewaysAggregatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/aggregated/targetVpnGateways")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetVpnGateways.aggregatedList" call.
-// Exactly one of *TargetVpnGatewayAggregatedList or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *TargetVpnGatewayAggregatedList.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TargetVpnGatewaysAggregatedListCall) Do() (*TargetVpnGatewayAggregatedList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetVpnGatewayAggregatedList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of target VPN gateways grouped by scope.",
- // "httpMethod": "GET",
- // "id": "compute.targetVpnGateways.aggregatedList",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/aggregated/targetVpnGateways",
- // "response": {
- // "$ref": "TargetVpnGatewayAggregatedList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.targetVpnGateways.delete":
-
-type TargetVpnGatewaysDeleteCall struct {
- s *Service
- project string
- region string
- targetVpnGateway string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified TargetVpnGateway resource.
-func (r *TargetVpnGatewaysService) Delete(project string, region string, targetVpnGateway string) *TargetVpnGatewaysDeleteCall {
- c := &TargetVpnGatewaysDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.targetVpnGateway = targetVpnGateway
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetVpnGatewaysDeleteCall) Fields(s ...googleapi.Field) *TargetVpnGatewaysDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetVpnGatewaysDeleteCall) Context(ctx context.Context) *TargetVpnGatewaysDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetVpnGatewaysDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "targetVpnGateway": c.targetVpnGateway,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetVpnGateways.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetVpnGatewaysDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified TargetVpnGateway resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.targetVpnGateways.delete",
- // "parameterOrder": [
- // "project",
- // "region",
- // "targetVpnGateway"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "The name of the region for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "targetVpnGateway": {
- // "description": "Name of the TargetVpnGateway resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetVpnGateways.get":
-
-type TargetVpnGatewaysGetCall struct {
- s *Service
- project string
- region string
- targetVpnGateway string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified TargetVpnGateway resource.
-func (r *TargetVpnGatewaysService) Get(project string, region string, targetVpnGateway string) *TargetVpnGatewaysGetCall {
- c := &TargetVpnGatewaysGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.targetVpnGateway = targetVpnGateway
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetVpnGatewaysGetCall) Fields(s ...googleapi.Field) *TargetVpnGatewaysGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TargetVpnGatewaysGetCall) IfNoneMatch(entityTag string) *TargetVpnGatewaysGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetVpnGatewaysGetCall) Context(ctx context.Context) *TargetVpnGatewaysGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetVpnGatewaysGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "targetVpnGateway": c.targetVpnGateway,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetVpnGateways.get" call.
-// Exactly one of *TargetVpnGateway or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *TargetVpnGateway.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TargetVpnGatewaysGetCall) Do() (*TargetVpnGateway, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetVpnGateway{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified TargetVpnGateway resource.",
- // "httpMethod": "GET",
- // "id": "compute.targetVpnGateways.get",
- // "parameterOrder": [
- // "project",
- // "region",
- // "targetVpnGateway"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "The name of the region for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "targetVpnGateway": {
- // "description": "Name of the TargetVpnGateway resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}",
- // "response": {
- // "$ref": "TargetVpnGateway"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.targetVpnGateways.insert":
-
-type TargetVpnGatewaysInsertCall struct {
- s *Service
- project string
- region string
- targetvpngateway *TargetVpnGateway
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a TargetVpnGateway resource in the specified project
-// and region using the data included in the request.
-func (r *TargetVpnGatewaysService) Insert(project string, region string, targetvpngateway *TargetVpnGateway) *TargetVpnGatewaysInsertCall {
- c := &TargetVpnGatewaysInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.targetvpngateway = targetvpngateway
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetVpnGatewaysInsertCall) Fields(s ...googleapi.Field) *TargetVpnGatewaysInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetVpnGatewaysInsertCall) Context(ctx context.Context) *TargetVpnGatewaysInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetVpnGatewaysInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.targetvpngateway)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/targetVpnGateways")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetVpnGateways.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *TargetVpnGatewaysInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a TargetVpnGateway resource in the specified project and region using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.targetVpnGateways.insert",
- // "parameterOrder": [
- // "project",
- // "region"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "The name of the region for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/targetVpnGateways",
- // "request": {
- // "$ref": "TargetVpnGateway"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.targetVpnGateways.list":
-
-type TargetVpnGatewaysListCall struct {
- s *Service
- project string
- region string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of TargetVpnGateway resources available to
-// the specified project and region.
-func (r *TargetVpnGatewaysService) List(project string, region string) *TargetVpnGatewaysListCall {
- c := &TargetVpnGatewaysListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *TargetVpnGatewaysListCall) Filter(filter string) *TargetVpnGatewaysListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *TargetVpnGatewaysListCall) MaxResults(maxResults int64) *TargetVpnGatewaysListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *TargetVpnGatewaysListCall) PageToken(pageToken string) *TargetVpnGatewaysListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetVpnGatewaysListCall) Fields(s ...googleapi.Field) *TargetVpnGatewaysListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TargetVpnGatewaysListCall) IfNoneMatch(entityTag string) *TargetVpnGatewaysListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetVpnGatewaysListCall) Context(ctx context.Context) *TargetVpnGatewaysListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetVpnGatewaysListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/targetVpnGateways")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.targetVpnGateways.list" call.
-// Exactly one of *TargetVpnGatewayList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *TargetVpnGatewayList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TargetVpnGatewaysListCall) Do() (*TargetVpnGatewayList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetVpnGatewayList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of TargetVpnGateway resources available to the specified project and region.",
- // "httpMethod": "GET",
- // "id": "compute.targetVpnGateways.list",
- // "parameterOrder": [
- // "project",
- // "region"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "The name of the region for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/targetVpnGateways",
- // "response": {
- // "$ref": "TargetVpnGatewayList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.urlMaps.delete":
-
-type UrlMapsDeleteCall struct {
- s *Service
- project string
- urlMap string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified UrlMap resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/urlMaps/delete
-func (r *UrlMapsService) Delete(project string, urlMap string) *UrlMapsDeleteCall {
- c := &UrlMapsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.urlMap = urlMap
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UrlMapsDeleteCall) Fields(s ...googleapi.Field) *UrlMapsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UrlMapsDeleteCall) Context(ctx context.Context) *UrlMapsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UrlMapsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/urlMaps/{urlMap}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "urlMap": c.urlMap,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.urlMaps.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UrlMapsDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified UrlMap resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.urlMaps.delete",
- // "parameterOrder": [
- // "project",
- // "urlMap"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "urlMap": {
- // "description": "Name of the UrlMap resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/urlMaps/{urlMap}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.urlMaps.get":
-
-type UrlMapsGetCall struct {
- s *Service
- project string
- urlMap string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified UrlMap resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/urlMaps/get
-func (r *UrlMapsService) Get(project string, urlMap string) *UrlMapsGetCall {
- c := &UrlMapsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.urlMap = urlMap
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UrlMapsGetCall) Fields(s ...googleapi.Field) *UrlMapsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UrlMapsGetCall) IfNoneMatch(entityTag string) *UrlMapsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UrlMapsGetCall) Context(ctx context.Context) *UrlMapsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UrlMapsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/urlMaps/{urlMap}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "urlMap": c.urlMap,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.urlMaps.get" call.
-// Exactly one of *UrlMap or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *UrlMap.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *UrlMapsGetCall) Do() (*UrlMap, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UrlMap{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified UrlMap resource.",
- // "httpMethod": "GET",
- // "id": "compute.urlMaps.get",
- // "parameterOrder": [
- // "project",
- // "urlMap"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "urlMap": {
- // "description": "Name of the UrlMap resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/urlMaps/{urlMap}",
- // "response": {
- // "$ref": "UrlMap"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.urlMaps.insert":
-
-type UrlMapsInsertCall struct {
- s *Service
- project string
- urlmap *UrlMap
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a UrlMap resource in the specified project using the
-// data included in the request.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/urlMaps/insert
-func (r *UrlMapsService) Insert(project string, urlmap *UrlMap) *UrlMapsInsertCall {
- c := &UrlMapsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.urlmap = urlmap
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UrlMapsInsertCall) Fields(s ...googleapi.Field) *UrlMapsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UrlMapsInsertCall) Context(ctx context.Context) *UrlMapsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UrlMapsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.urlmap)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/urlMaps")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.urlMaps.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UrlMapsInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a UrlMap resource in the specified project using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.urlMaps.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/urlMaps",
- // "request": {
- // "$ref": "UrlMap"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.urlMaps.list":
-
-type UrlMapsListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of UrlMap resources available to the
-// specified project.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/urlMaps/list
-func (r *UrlMapsService) List(project string) *UrlMapsListCall {
- c := &UrlMapsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *UrlMapsListCall) Filter(filter string) *UrlMapsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *UrlMapsListCall) MaxResults(maxResults int64) *UrlMapsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *UrlMapsListCall) PageToken(pageToken string) *UrlMapsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UrlMapsListCall) Fields(s ...googleapi.Field) *UrlMapsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UrlMapsListCall) IfNoneMatch(entityTag string) *UrlMapsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UrlMapsListCall) Context(ctx context.Context) *UrlMapsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UrlMapsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/urlMaps")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.urlMaps.list" call.
-// Exactly one of *UrlMapList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UrlMapList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UrlMapsListCall) Do() (*UrlMapList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UrlMapList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of UrlMap resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.urlMaps.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/urlMaps",
- // "response": {
- // "$ref": "UrlMapList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.urlMaps.patch":
-
-type UrlMapsPatchCall struct {
- s *Service
- project string
- urlMap string
- urlmap *UrlMap
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Update the entire content of the UrlMap resource. This method
-// supports patch semantics.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/urlMaps/patch
-func (r *UrlMapsService) Patch(project string, urlMap string, urlmap *UrlMap) *UrlMapsPatchCall {
- c := &UrlMapsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.urlMap = urlMap
- c.urlmap = urlmap
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UrlMapsPatchCall) Fields(s ...googleapi.Field) *UrlMapsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UrlMapsPatchCall) Context(ctx context.Context) *UrlMapsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UrlMapsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.urlmap)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/urlMaps/{urlMap}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "urlMap": c.urlMap,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.urlMaps.patch" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UrlMapsPatchCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update the entire content of the UrlMap resource. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "compute.urlMaps.patch",
- // "parameterOrder": [
- // "project",
- // "urlMap"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "urlMap": {
- // "description": "Name of the UrlMap resource to update.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/urlMaps/{urlMap}",
- // "request": {
- // "$ref": "UrlMap"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.urlMaps.update":
-
-type UrlMapsUpdateCall struct {
- s *Service
- project string
- urlMap string
- urlmap *UrlMap
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Update the entire content of the UrlMap resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/urlMaps/update
-func (r *UrlMapsService) Update(project string, urlMap string, urlmap *UrlMap) *UrlMapsUpdateCall {
- c := &UrlMapsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.urlMap = urlMap
- c.urlmap = urlmap
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UrlMapsUpdateCall) Fields(s ...googleapi.Field) *UrlMapsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UrlMapsUpdateCall) Context(ctx context.Context) *UrlMapsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UrlMapsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.urlmap)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/urlMaps/{urlMap}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "urlMap": c.urlMap,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.urlMaps.update" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UrlMapsUpdateCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update the entire content of the UrlMap resource.",
- // "httpMethod": "PUT",
- // "id": "compute.urlMaps.update",
- // "parameterOrder": [
- // "project",
- // "urlMap"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "urlMap": {
- // "description": "Name of the UrlMap resource to update.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/urlMaps/{urlMap}",
- // "request": {
- // "$ref": "UrlMap"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.urlMaps.validate":
-
-type UrlMapsValidateCall struct {
- s *Service
- project string
- urlMap string
- urlmapsvalidaterequest *UrlMapsValidateRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Validate: Run static validation for the UrlMap. In particular, the
-// tests of the provided UrlMap will be run. Calling this method does
-// NOT create the UrlMap.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/urlMaps/validate
-func (r *UrlMapsService) Validate(project string, urlMap string, urlmapsvalidaterequest *UrlMapsValidateRequest) *UrlMapsValidateCall {
- c := &UrlMapsValidateCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.urlMap = urlMap
- c.urlmapsvalidaterequest = urlmapsvalidaterequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UrlMapsValidateCall) Fields(s ...googleapi.Field) *UrlMapsValidateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UrlMapsValidateCall) Context(ctx context.Context) *UrlMapsValidateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UrlMapsValidateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.urlmapsvalidaterequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/urlMaps/{urlMap}/validate")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "urlMap": c.urlMap,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.urlMaps.validate" call.
-// Exactly one of *UrlMapsValidateResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *UrlMapsValidateResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *UrlMapsValidateCall) Do() (*UrlMapsValidateResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UrlMapsValidateResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Run static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.",
- // "httpMethod": "POST",
- // "id": "compute.urlMaps.validate",
- // "parameterOrder": [
- // "project",
- // "urlMap"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Name of the project scoping this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "urlMap": {
- // "description": "Name of the UrlMap resource to be validated as.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/urlMaps/{urlMap}/validate",
- // "request": {
- // "$ref": "UrlMapsValidateRequest"
- // },
- // "response": {
- // "$ref": "UrlMapsValidateResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.vpnTunnels.aggregatedList":
-
-type VpnTunnelsAggregatedListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AggregatedList: Retrieves the list of VPN tunnels grouped by scope.
-func (r *VpnTunnelsService) AggregatedList(project string) *VpnTunnelsAggregatedListCall {
- c := &VpnTunnelsAggregatedListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *VpnTunnelsAggregatedListCall) Filter(filter string) *VpnTunnelsAggregatedListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *VpnTunnelsAggregatedListCall) MaxResults(maxResults int64) *VpnTunnelsAggregatedListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *VpnTunnelsAggregatedListCall) PageToken(pageToken string) *VpnTunnelsAggregatedListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *VpnTunnelsAggregatedListCall) Fields(s ...googleapi.Field) *VpnTunnelsAggregatedListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *VpnTunnelsAggregatedListCall) IfNoneMatch(entityTag string) *VpnTunnelsAggregatedListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *VpnTunnelsAggregatedListCall) Context(ctx context.Context) *VpnTunnelsAggregatedListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *VpnTunnelsAggregatedListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/aggregated/vpnTunnels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.vpnTunnels.aggregatedList" call.
-// Exactly one of *VpnTunnelAggregatedList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *VpnTunnelAggregatedList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *VpnTunnelsAggregatedListCall) Do() (*VpnTunnelAggregatedList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &VpnTunnelAggregatedList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of VPN tunnels grouped by scope.",
- // "httpMethod": "GET",
- // "id": "compute.vpnTunnels.aggregatedList",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/aggregated/vpnTunnels",
- // "response": {
- // "$ref": "VpnTunnelAggregatedList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.vpnTunnels.delete":
-
-type VpnTunnelsDeleteCall struct {
- s *Service
- project string
- region string
- vpnTunnel string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified VpnTunnel resource.
-func (r *VpnTunnelsService) Delete(project string, region string, vpnTunnel string) *VpnTunnelsDeleteCall {
- c := &VpnTunnelsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.vpnTunnel = vpnTunnel
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *VpnTunnelsDeleteCall) Fields(s ...googleapi.Field) *VpnTunnelsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *VpnTunnelsDeleteCall) Context(ctx context.Context) *VpnTunnelsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *VpnTunnelsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/vpnTunnels/{vpnTunnel}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "vpnTunnel": c.vpnTunnel,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.vpnTunnels.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *VpnTunnelsDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the specified VpnTunnel resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.vpnTunnels.delete",
- // "parameterOrder": [
- // "project",
- // "region",
- // "vpnTunnel"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "The name of the region for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "vpnTunnel": {
- // "description": "Name of the VpnTunnel resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/vpnTunnels/{vpnTunnel}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.vpnTunnels.get":
-
-type VpnTunnelsGetCall struct {
- s *Service
- project string
- region string
- vpnTunnel string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified VpnTunnel resource.
-func (r *VpnTunnelsService) Get(project string, region string, vpnTunnel string) *VpnTunnelsGetCall {
- c := &VpnTunnelsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.vpnTunnel = vpnTunnel
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *VpnTunnelsGetCall) Fields(s ...googleapi.Field) *VpnTunnelsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *VpnTunnelsGetCall) IfNoneMatch(entityTag string) *VpnTunnelsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *VpnTunnelsGetCall) Context(ctx context.Context) *VpnTunnelsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *VpnTunnelsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/vpnTunnels/{vpnTunnel}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- "vpnTunnel": c.vpnTunnel,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.vpnTunnels.get" call.
-// Exactly one of *VpnTunnel or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *VpnTunnel.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *VpnTunnelsGetCall) Do() (*VpnTunnel, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &VpnTunnel{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified VpnTunnel resource.",
- // "httpMethod": "GET",
- // "id": "compute.vpnTunnels.get",
- // "parameterOrder": [
- // "project",
- // "region",
- // "vpnTunnel"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "The name of the region for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "vpnTunnel": {
- // "description": "Name of the VpnTunnel resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/vpnTunnels/{vpnTunnel}",
- // "response": {
- // "$ref": "VpnTunnel"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.vpnTunnels.insert":
-
-type VpnTunnelsInsertCall struct {
- s *Service
- project string
- region string
- vpntunnel *VpnTunnel
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a VpnTunnel resource in the specified project and
-// region using the data included in the request.
-func (r *VpnTunnelsService) Insert(project string, region string, vpntunnel *VpnTunnel) *VpnTunnelsInsertCall {
- c := &VpnTunnelsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- c.vpntunnel = vpntunnel
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *VpnTunnelsInsertCall) Fields(s ...googleapi.Field) *VpnTunnelsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *VpnTunnelsInsertCall) Context(ctx context.Context) *VpnTunnelsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *VpnTunnelsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.vpntunnel)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/vpnTunnels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.vpnTunnels.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *VpnTunnelsInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a VpnTunnel resource in the specified project and region using the data included in the request.",
- // "httpMethod": "POST",
- // "id": "compute.vpnTunnels.insert",
- // "parameterOrder": [
- // "project",
- // "region"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "The name of the region for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/vpnTunnels",
- // "request": {
- // "$ref": "VpnTunnel"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.vpnTunnels.list":
-
-type VpnTunnelsListCall struct {
- s *Service
- project string
- region string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of VpnTunnel resources contained in the
-// specified project and region.
-func (r *VpnTunnelsService) List(project string, region string) *VpnTunnelsListCall {
- c := &VpnTunnelsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.region = region
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *VpnTunnelsListCall) Filter(filter string) *VpnTunnelsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *VpnTunnelsListCall) MaxResults(maxResults int64) *VpnTunnelsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *VpnTunnelsListCall) PageToken(pageToken string) *VpnTunnelsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *VpnTunnelsListCall) Fields(s ...googleapi.Field) *VpnTunnelsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *VpnTunnelsListCall) IfNoneMatch(entityTag string) *VpnTunnelsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *VpnTunnelsListCall) Context(ctx context.Context) *VpnTunnelsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *VpnTunnelsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/regions/{region}/vpnTunnels")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "region": c.region,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.vpnTunnels.list" call.
-// Exactly one of *VpnTunnelList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *VpnTunnelList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *VpnTunnelsListCall) Do() (*VpnTunnelList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &VpnTunnelList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of VpnTunnel resources contained in the specified project and region.",
- // "httpMethod": "GET",
- // "id": "compute.vpnTunnels.list",
- // "parameterOrder": [
- // "project",
- // "region"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "region": {
- // "description": "The name of the region for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/regions/{region}/vpnTunnels",
- // "response": {
- // "$ref": "VpnTunnelList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.zoneOperations.delete":
-
-type ZoneOperationsDeleteCall struct {
- s *Service
- project string
- zone string
- operation string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the specified zone-specific Operations resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/zoneOperations/delete
-func (r *ZoneOperationsService) Delete(project string, zone string, operation string) *ZoneOperationsDeleteCall {
- c := &ZoneOperationsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.operation = operation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ZoneOperationsDeleteCall) Fields(s ...googleapi.Field) *ZoneOperationsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ZoneOperationsDeleteCall) Context(ctx context.Context) *ZoneOperationsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ZoneOperationsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/operations/{operation}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "operation": c.operation,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.zoneOperations.delete" call.
-func (c *ZoneOperationsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes the specified zone-specific Operations resource.",
- // "httpMethod": "DELETE",
- // "id": "compute.zoneOperations.delete",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "operation"
- // ],
- // "parameters": {
- // "operation": {
- // "description": "Name of the Operations resource to delete.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/operations/{operation}",
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute"
- // ]
- // }
-
-}
-
-// method id "compute.zoneOperations.get":
-
-type ZoneOperationsGetCall struct {
- s *Service
- project string
- zone string
- operation string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves the specified zone-specific Operations resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/zoneOperations/get
-func (r *ZoneOperationsService) Get(project string, zone string, operation string) *ZoneOperationsGetCall {
- c := &ZoneOperationsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- c.operation = operation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ZoneOperationsGetCall) Fields(s ...googleapi.Field) *ZoneOperationsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ZoneOperationsGetCall) IfNoneMatch(entityTag string) *ZoneOperationsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ZoneOperationsGetCall) Context(ctx context.Context) *ZoneOperationsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ZoneOperationsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/operations/{operation}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- "operation": c.operation,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.zoneOperations.get" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ZoneOperationsGetCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the specified zone-specific Operations resource.",
- // "httpMethod": "GET",
- // "id": "compute.zoneOperations.get",
- // "parameterOrder": [
- // "project",
- // "zone",
- // "operation"
- // ],
- // "parameters": {
- // "operation": {
- // "description": "Name of the Operations resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/operations/{operation}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.zoneOperations.list":
-
-type ZoneOperationsListCall struct {
- s *Service
- project string
- zone string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of Operation resources contained within the
-// specified zone.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/zoneOperations/list
-func (r *ZoneOperationsService) List(project string, zone string) *ZoneOperationsListCall {
- c := &ZoneOperationsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *ZoneOperationsListCall) Filter(filter string) *ZoneOperationsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *ZoneOperationsListCall) MaxResults(maxResults int64) *ZoneOperationsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *ZoneOperationsListCall) PageToken(pageToken string) *ZoneOperationsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ZoneOperationsListCall) Fields(s ...googleapi.Field) *ZoneOperationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ZoneOperationsListCall) IfNoneMatch(entityTag string) *ZoneOperationsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ZoneOperationsListCall) Context(ctx context.Context) *ZoneOperationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ZoneOperationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/operations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.zoneOperations.list" call.
-// Exactly one of *OperationList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *OperationList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ZoneOperationsListCall) Do() (*OperationList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OperationList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of Operation resources contained within the specified zone.",
- // "httpMethod": "GET",
- // "id": "compute.zoneOperations.list",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone scoping this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}/operations",
- // "response": {
- // "$ref": "OperationList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.zones.get":
-
-type ZonesGetCall struct {
- s *Service
- project string
- zone string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Returns the specified zone resource.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/zones/get
-func (r *ZonesService) Get(project string, zone string) *ZonesGetCall {
- c := &ZonesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.zone = zone
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ZonesGetCall) Fields(s ...googleapi.Field) *ZonesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ZonesGetCall) IfNoneMatch(entityTag string) *ZonesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ZonesGetCall) Context(ctx context.Context) *ZonesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ZonesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.zones.get" call.
-// Exactly one of *Zone or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Zone.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *ZonesGetCall) Do() (*Zone, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Zone{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the specified zone resource.",
- // "httpMethod": "GET",
- // "id": "compute.zones.get",
- // "parameterOrder": [
- // "project",
- // "zone"
- // ],
- // "parameters": {
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "Name of the zone resource to return.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones/{zone}",
- // "response": {
- // "$ref": "Zone"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
-
-// method id "compute.zones.list":
-
-type ZonesListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of zone resources available to the specified
-// project.
-// For details, see https://cloud.google.com/compute/docs/reference/latest/zones/list
-func (r *ZonesService) List(project string) *ZonesListCall {
- c := &ZonesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *ZonesListCall) Filter(filter string) *ZonesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *ZonesListCall) MaxResults(maxResults int64) *ZonesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *ZonesListCall) PageToken(pageToken string) *ZonesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ZonesListCall) Fields(s ...googleapi.Field) *ZonesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ZonesListCall) IfNoneMatch(entityTag string) *ZonesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ZonesListCall) Context(ctx context.Context) *ZonesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ZonesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "compute.zones.list" call.
-// Exactly one of *ZoneList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *ZoneList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ZonesListCall) Do() (*ZoneList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ZoneList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of zone resources available to the specified project.",
- // "httpMethod": "GET",
- // "id": "compute.zones.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "Project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/zones",
- // "response": {
- // "$ref": "ZoneList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/compute",
- // "https://www.googleapis.com/auth/compute.readonly"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/container/v1/container-api.json b/vendor/google.golang.org/api/container/v1/container-api.json
deleted file mode 100644
index 9041b8cf..00000000
--- a/vendor/google.golang.org/api/container/v1/container-api.json
+++ /dev/null
@@ -1,690 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/FD4oCwspiZqN6eCjsBmxDzsj5B8\"",
- "discoveryVersion": "v1",
- "id": "container:v1",
- "name": "container",
- "version": "v1",
- "revision": "20150603",
- "title": "Google Container Engine API",
- "description": "The Google Container Engine API is used for building and managing container based applications, powered by the open source Kubernetes technology.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/container-engine/",
- "protocol": "rest",
- "baseUrl": "https://container.googleapis.com/",
- "basePath": "/",
- "rootUrl": "https://container.googleapis.com/",
- "servicePath": "",
- "batchPath": "batch",
- "parameters": {
- "access_token": {
- "type": "string",
- "description": "OAuth access token.",
- "location": "query"
- },
- "alt": {
- "type": "string",
- "description": "Data format for response.",
- "default": "json",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "bearer_token": {
- "type": "string",
- "description": "OAuth bearer token.",
- "location": "query"
- },
- "callback": {
- "type": "string",
- "description": "JSONP",
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "pp": {
- "type": "boolean",
- "description": "Pretty-print response.",
- "default": "true",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "location": "query"
- },
- "upload_protocol": {
- "type": "string",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "location": "query"
- },
- "uploadType": {
- "type": "string",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query"
- },
- "$.xgafv": {
- "type": "string",
- "description": "V1 error format.",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "schemas": {
- "ListClustersResponse": {
- "id": "ListClustersResponse",
- "type": "object",
- "description": "ListClustersResponse is the result of ListClustersRequest.",
- "properties": {
- "clusters": {
- "type": "array",
- "description": "A list of clusters in the project in the specified zone, or across all ones.",
- "items": {
- "$ref": "Cluster"
- }
- }
- }
- },
- "Cluster": {
- "id": "Cluster",
- "type": "object",
- "description": "A Google Container Engine cluster.",
- "properties": {
- "name": {
- "type": "string",
- "description": "The name of this cluster. The name must be unique within this project and zone, and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter."
- },
- "description": {
- "type": "string",
- "description": "An optional description of this cluster."
- },
- "initialNodeCount": {
- "type": "integer",
- "description": "The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](/compute/docs/resource-quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.",
- "format": "int32"
- },
- "nodeConfig": {
- "$ref": "NodeConfig",
- "description": "Parameters used in creating the cluster's nodes. See the descriptions of the child properties of `nodeConfig`. If unspecified, the defaults for all child properties are used."
- },
- "masterAuth": {
- "$ref": "MasterAuth",
- "description": "The authentication information for accessing the master."
- },
- "loggingService": {
- "type": "string",
- "description": "The logging service that the cluster should write logs to. Currently available options: * \"logging.googleapis.com\" - the Google Cloud Logging service * \"none\" - no logs will be exported from the cluster * \"\" - default value; the default is \"logging.googleapis.com\""
- },
- "monitoringService": {
- "type": "string",
- "description": "The monitoring service that the cluster should write metrics to. Currently available options: * \"monitoring.googleapis.com\" - the Google Cloud Monitoring service * \"none\" - no metrics will be exported from the cluster * \"\" - default value; the default is \"monitoring.googleapis.com\""
- },
- "network": {
- "type": "string",
- "description": "The name of the Google Compute Engine [network](/compute/docs/networking#networks_1) to which the cluster is connected. If left unspecified, the \"default\" network will be used."
- },
- "clusterIpv4Cidr": {
- "type": "string",
- "description": "The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output only] Server-defined URL for the resource."
- },
- "zone": {
- "type": "string",
- "description": "[Output only] The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides."
- },
- "endpoint": {
- "type": "string",
- "description": "[Output only] The IP address of this cluster's Kubernetes master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information."
- },
- "initialClusterVersion": {
- "type": "string",
- "description": "[Output only] The software version of Kubernetes master and kubelets used in the cluster when it was first created. The version can be upgraded over time."
- },
- "currentMasterVersion": {
- "type": "string",
- "description": "[Output only] The current software version of the master endpoint."
- },
- "currentNodeVersion": {
- "type": "string",
- "description": "[Output only] The current version of the node software components. If they are currently at different versions because they're in the process of being upgraded, this reflects the minimum version of any of them."
- },
- "createTime": {
- "type": "string",
- "description": "[Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format."
- },
- "status": {
- "type": "string",
- "description": "[Output only] The current status of this cluster.",
- "enum": [
- "STATUS_UNSPECIFIED",
- "PROVISIONING",
- "RUNNING",
- "RECONCILING",
- "STOPPING",
- "ERROR"
- ]
- },
- "statusMessage": {
- "type": "string",
- "description": "[Output only] Additional information about the current status of this cluster, if available."
- },
- "nodeIpv4CidrSize": {
- "type": "integer",
- "description": "[Output only] The size of the address space on each node for hosting containers. This is provisioned from within the container_ipv4_cidr range.",
- "format": "int32"
- },
- "servicesIpv4Cidr": {
- "type": "string",
- "description": "[Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last /16 from the container CIDR."
- },
- "instanceGroupUrls": {
- "type": "array",
- "description": "[Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this cluster.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "NodeConfig": {
- "id": "NodeConfig",
- "type": "object",
- "description": "Per-node parameters.",
- "properties": {
- "machineType": {
- "type": "string",
- "description": "The name of a Google Compute Engine [machine type](/compute/docs/machine-types) (e.g. `n1-standard-1`). If unspecified, the default machine type is `n1-standard-1`."
- },
- "diskSizeGb": {
- "type": "integer",
- "description": "Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.",
- "format": "int32"
- },
- "oauthScopes": {
- "type": "array",
- "description": "The set of Google API scopes to be made available on all of the node VMs under the \"default\" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with *gcr.io*. If unspecified, no scopes are added.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "MasterAuth": {
- "id": "MasterAuth",
- "type": "object",
- "description": "The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates.",
- "properties": {
- "username": {
- "type": "string",
- "description": "The username to use for HTTP basic authentication when accessing the Kubernetes master endpoint."
- },
- "password": {
- "type": "string",
- "description": "The password to use for HTTP basic authentication when accessing the Kubernetes master endpoint. Because the master endpoint is open to the internet, you should create a strong password."
- },
- "clusterCaCertificate": {
- "type": "string",
- "description": "[Output only] Base64 encoded public certificate that is the root of trust for the cluster."
- },
- "clientCertificate": {
- "type": "string",
- "description": "[Output only] Base64 encoded public certificate used by clients to authenticate to the cluster endpoint."
- },
- "clientKey": {
- "type": "string",
- "description": "[Output only] Base64 encoded private key used by clients to authenticate to the cluster endpoint."
- }
- }
- },
- "CreateClusterRequest": {
- "id": "CreateClusterRequest",
- "type": "object",
- "description": "CreateClusterRequest creates a cluster.",
- "properties": {
- "cluster": {
- "$ref": "Cluster",
- "description": "A [cluster resource](/container-engine/reference/rest/v1/projects.zones.clusters)"
- }
- }
- },
- "Operation": {
- "id": "Operation",
- "type": "object",
- "description": "Defines the operation resource. All fields are output only.",
- "properties": {
- "name": {
- "type": "string",
- "description": "The server-assigned ID for the operation."
- },
- "zone": {
- "type": "string",
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation is taking place."
- },
- "operationType": {
- "type": "string",
- "description": "The operation type.",
- "enum": [
- "TYPE_UNSPECIFIED",
- "CREATE_CLUSTER",
- "DELETE_CLUSTER",
- "UPGRADE_MASTER",
- "UPGRADE_NODES",
- "REPAIR_CLUSTER"
- ]
- },
- "status": {
- "type": "string",
- "description": "The current status of the operation.",
- "enum": [
- "STATUS_UNSPECIFIED",
- "PENDING",
- "RUNNING",
- "DONE"
- ]
- },
- "statusMessage": {
- "type": "string",
- "description": "If an error has occurred, a textual description of the error."
- },
- "selfLink": {
- "type": "string",
- "description": "Server-defined URL for the resource."
- },
- "targetLink": {
- "type": "string",
- "description": "Server-defined URL for the target of the operation."
- }
- }
- },
- "UpdateClusterRequest": {
- "id": "UpdateClusterRequest",
- "type": "object",
- "description": "UpdateClusterRequest updates a cluster.",
- "properties": {
- "update": {
- "$ref": "ClusterUpdate",
- "description": "A description of the update."
- }
- }
- },
- "ClusterUpdate": {
- "id": "ClusterUpdate",
- "type": "object",
- "description": "ClusterUpdate describes an update to the cluster.",
- "properties": {
- "desiredNodeVersion": {
- "type": "string",
- "description": "The Kubernetes version to change the nodes to (typically an upgrade). Use \"-\" to upgrade to the latest version supported by the server."
- }
- }
- },
- "ListOperationsResponse": {
- "id": "ListOperationsResponse",
- "type": "object",
- "description": "ListOperationsResponse is the result of ListOperationsRequest.",
- "properties": {
- "operations": {
- "type": "array",
- "description": "A list of operations in the project in the specified zone.",
- "items": {
- "$ref": "Operation"
- }
- }
- }
- },
- "ServerConfig": {
- "id": "ServerConfig",
- "type": "object",
- "description": "Container Engine Server configuration.",
- "properties": {
- "defaultClusterVersion": {
- "type": "string",
- "description": "What version this server deploys by default."
- },
- "validNodeVersions": {
- "type": "array",
- "description": "List of valid node upgrade target versions.",
- "items": {
- "type": "string"
- }
- }
- }
- }
- },
- "resources": {
- "projects": {
- "resources": {
- "zones": {
- "methods": {
- "getServerconfig": {
- "id": "container.projects.zones.getServerconfig",
- "path": "v1/projects/{projectId}/zones/{zone}/serverconfig",
- "httpMethod": "GET",
- "description": "Returns configuration info about the Container Engine service.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber).",
- "required": true,
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or \"-\" for all zones.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "response": {
- "$ref": "ServerConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- },
- "resources": {
- "clusters": {
- "methods": {
- "list": {
- "id": "container.projects.zones.clusters.list",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters",
- "httpMethod": "GET",
- "description": "Lists all clusters owned by a project in either the specified zone or all zones.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber).",
- "required": true,
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "response": {
- "$ref": "ListClustersResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "get": {
- "id": "container.projects.zones.clusters.get",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "httpMethod": "GET",
- "description": "Gets a specific cluster.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber).",
- "required": true,
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides.",
- "required": true,
- "location": "path"
- },
- "clusterId": {
- "type": "string",
- "description": "The name of the cluster to retrieve.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "response": {
- "$ref": "Cluster"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "create": {
- "id": "container.projects.zones.clusters.create",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters",
- "httpMethod": "POST",
- "description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances, plus a Kubernetes master endpoint. By default, the cluster is created in the project's [default network](/compute/docs/networking#networks_1). One firewall is added for the cluster. After cluster creation, the cluster creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range is being used by the cluster.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber).",
- "required": true,
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "request": {
- "$ref": "CreateClusterRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "update": {
- "id": "container.projects.zones.clusters.update",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "httpMethod": "PUT",
- "description": "Update settings of a specific cluster.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber).",
- "required": true,
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides.",
- "required": true,
- "location": "path"
- },
- "clusterId": {
- "type": "string",
- "description": "The name of the cluster to upgrade.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "request": {
- "$ref": "UpdateClusterRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "delete": {
- "id": "container.projects.zones.clusters.delete",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "httpMethod": "DELETE",
- "description": "Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber).",
- "required": true,
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides.",
- "required": true,
- "location": "path"
- },
- "clusterId": {
- "type": "string",
- "description": "The name of the cluster to delete.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- },
- "operations": {
- "methods": {
- "list": {
- "id": "container.projects.zones.operations.list",
- "path": "v1/projects/{projectId}/zones/{zone}/operations",
- "httpMethod": "GET",
- "description": "Lists all operations in a project in a specific zone or all zones.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber).",
- "required": true,
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or \"-\" for all zones.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "get": {
- "id": "container.projects.zones.operations.get",
- "path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}",
- "httpMethod": "GET",
- "description": "Gets the specified operation.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber).",
- "required": true,
- "location": "path"
- },
- "zone": {
- "type": "string",
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides.",
- "required": true,
- "location": "path"
- },
- "operationId": {
- "type": "string",
- "description": "The server-assigned `name` of the operation.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "operationId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- }
- }
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/container/v1/container-gen.go b/vendor/google.golang.org/api/container/v1/container-gen.go
deleted file mode 100644
index bb98f63e..00000000
--- a/vendor/google.golang.org/api/container/v1/container-gen.go
+++ /dev/null
@@ -1,1658 +0,0 @@
-// Package container provides access to the Google Container Engine API.
-//
-// See https://cloud.google.com/container-engine/
-//
-// Usage example:
-//
-// import "google.golang.org/api/container/v1"
-// ...
-// containerService, err := container.New(oauthHttpClient)
-package container // import "google.golang.org/api/container/v1"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "container:v1"
-const apiName = "container"
-const apiVersion = "v1"
-const basePath = "https://container.googleapis.com/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your data across Google Cloud Platform services
- CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Projects = NewProjectsService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Projects *ProjectsService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewProjectsService(s *Service) *ProjectsService {
- rs := &ProjectsService{s: s}
- rs.Zones = NewProjectsZonesService(s)
- return rs
-}
-
-type ProjectsService struct {
- s *Service
-
- Zones *ProjectsZonesService
-}
-
-func NewProjectsZonesService(s *Service) *ProjectsZonesService {
- rs := &ProjectsZonesService{s: s}
- rs.Clusters = NewProjectsZonesClustersService(s)
- rs.Operations = NewProjectsZonesOperationsService(s)
- return rs
-}
-
-type ProjectsZonesService struct {
- s *Service
-
- Clusters *ProjectsZonesClustersService
-
- Operations *ProjectsZonesOperationsService
-}
-
-func NewProjectsZonesClustersService(s *Service) *ProjectsZonesClustersService {
- rs := &ProjectsZonesClustersService{s: s}
- return rs
-}
-
-type ProjectsZonesClustersService struct {
- s *Service
-}
-
-func NewProjectsZonesOperationsService(s *Service) *ProjectsZonesOperationsService {
- rs := &ProjectsZonesOperationsService{s: s}
- return rs
-}
-
-type ProjectsZonesOperationsService struct {
- s *Service
-}
-
-// Cluster: A Google Container Engine cluster.
-type Cluster struct {
- // ClusterIpv4Cidr: The IP address range of the container pods in this
- // cluster, in
- // [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
- // notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically
- // chosen or specify a `/14` block in `10.0.0.0/8`.
- ClusterIpv4Cidr string `json:"clusterIpv4Cidr,omitempty"`
-
- // CreateTime: [Output only] The time the cluster was created, in
- // [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- CreateTime string `json:"createTime,omitempty"`
-
- // CurrentMasterVersion: [Output only] The current software version of
- // the master endpoint.
- CurrentMasterVersion string `json:"currentMasterVersion,omitempty"`
-
- // CurrentNodeVersion: [Output only] The current version of the node
- // software components. If they are currently at different versions
- // because they're in the process of being upgraded, this reflects the
- // minimum version of any of them.
- CurrentNodeVersion string `json:"currentNodeVersion,omitempty"`
-
- // Description: An optional description of this cluster.
- Description string `json:"description,omitempty"`
-
- // Endpoint: [Output only] The IP address of this cluster's Kubernetes
- // master endpoint. The endpoint can be accessed from the internet at
- // `https://username:password@endpoint/`. See the `masterAuth` property
- // of this resource for username and password information.
- Endpoint string `json:"endpoint,omitempty"`
-
- // InitialClusterVersion: [Output only] The software version of
- // Kubernetes master and kubelets used in the cluster when it was first
- // created. The version can be upgraded over time.
- InitialClusterVersion string `json:"initialClusterVersion,omitempty"`
-
- // InitialNodeCount: The number of nodes to create in this cluster. You
- // must ensure that your Compute Engine [resource
- // quota](/compute/docs/resource-quotas) is sufficient for this number
- // of instances. You must also have available firewall and routes quota.
- InitialNodeCount int64 `json:"initialNodeCount,omitempty"`
-
- // InstanceGroupUrls: [Output only] The resource URLs of [instance
- // groups](/compute/docs/instance-groups/) associated with this cluster.
- InstanceGroupUrls []string `json:"instanceGroupUrls,omitempty"`
-
- // LoggingService: The logging service that the cluster should write
- // logs to. Currently available options: * "logging.googleapis.com" -
- // the Google Cloud Logging service * "none" - no logs will be exported
- // from the cluster * "" - default value; the default is
- // "logging.googleapis.com"
- LoggingService string `json:"loggingService,omitempty"`
-
- // MasterAuth: The authentication information for accessing the master.
- MasterAuth *MasterAuth `json:"masterAuth,omitempty"`
-
- // MonitoringService: The monitoring service that the cluster should
- // write metrics to. Currently available options: *
- // "monitoring.googleapis.com" - the Google Cloud Monitoring service *
- // "none" - no metrics will be exported from the cluster * "" - default
- // value; the default is "monitoring.googleapis.com"
- MonitoringService string `json:"monitoringService,omitempty"`
-
- // Name: The name of this cluster. The name must be unique within this
- // project and zone, and can be up to 40 characters with the following
- // restrictions: * Lowercase letters, numbers, and hyphens only. * Must
- // start with a letter. * Must end with a number or a letter.
- Name string `json:"name,omitempty"`
-
- // Network: The name of the Google Compute Engine
- // [network](/compute/docs/networking#networks_1) to which the cluster
- // is connected. If left unspecified, the "default" network will be
- // used.
- Network string `json:"network,omitempty"`
-
- // NodeConfig: Parameters used in creating the cluster's nodes. See the
- // descriptions of the child properties of `nodeConfig`. If unspecified,
- // the defaults for all child properties are used.
- NodeConfig *NodeConfig `json:"nodeConfig,omitempty"`
-
- // NodeIpv4CidrSize: [Output only] The size of the address space on each
- // node for hosting containers. This is provisioned from within the
- // container_ipv4_cidr range.
- NodeIpv4CidrSize int64 `json:"nodeIpv4CidrSize,omitempty"`
-
- // SelfLink: [Output only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServicesIpv4Cidr: [Output only] The IP address range of the
- // Kubernetes services in this cluster, in
- // [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
- // notation (e.g. `1.2.3.4/29`). Service addresses are typically put in
- // the last /16 from the container CIDR.
- ServicesIpv4Cidr string `json:"servicesIpv4Cidr,omitempty"`
-
- // Status: [Output only] The current status of this cluster.
- //
- // Possible values:
- // "STATUS_UNSPECIFIED"
- // "PROVISIONING"
- // "RUNNING"
- // "RECONCILING"
- // "STOPPING"
- // "ERROR"
- Status string `json:"status,omitempty"`
-
- // StatusMessage: [Output only] Additional information about the current
- // status of this cluster, if available.
- StatusMessage string `json:"statusMessage,omitempty"`
-
- // Zone: [Output only] The name of the Google Compute Engine
- // [zone](/compute/docs/zones#available) in which the cluster resides.
- Zone string `json:"zone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ClusterIpv4Cidr") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Cluster) MarshalJSON() ([]byte, error) {
- type noMethod Cluster
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ClusterUpdate: ClusterUpdate describes an update to the cluster.
-type ClusterUpdate struct {
- // DesiredNodeVersion: The Kubernetes version to change the nodes to
- // (typically an upgrade). Use "-" to upgrade to the latest version
- // supported by the server.
- DesiredNodeVersion string `json:"desiredNodeVersion,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DesiredNodeVersion")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ClusterUpdate) MarshalJSON() ([]byte, error) {
- type noMethod ClusterUpdate
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreateClusterRequest: CreateClusterRequest creates a cluster.
-type CreateClusterRequest struct {
- // Cluster: A [cluster
- // resource](/container-engine/reference/rest/v1/projects.zones.clusters)
- Cluster *Cluster `json:"cluster,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Cluster") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreateClusterRequest) MarshalJSON() ([]byte, error) {
- type noMethod CreateClusterRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListClustersResponse: ListClustersResponse is the result of
-// ListClustersRequest.
-type ListClustersResponse struct {
- // Clusters: A list of clusters in the project in the specified zone, or
- // across all ones.
- Clusters []*Cluster `json:"clusters,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Clusters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListClustersResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListClustersResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListOperationsResponse: ListOperationsResponse is the result of
-// ListOperationsRequest.
-type ListOperationsResponse struct {
- // Operations: A list of operations in the project in the specified
- // zone.
- Operations []*Operation `json:"operations,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Operations") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListOperationsResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListOperationsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MasterAuth: The authentication information for accessing the master
-// endpoint. Authentication can be done using HTTP basic auth or using
-// client certificates.
-type MasterAuth struct {
- // ClientCertificate: [Output only] Base64 encoded public certificate
- // used by clients to authenticate to the cluster endpoint.
- ClientCertificate string `json:"clientCertificate,omitempty"`
-
- // ClientKey: [Output only] Base64 encoded private key used by clients
- // to authenticate to the cluster endpoint.
- ClientKey string `json:"clientKey,omitempty"`
-
- // ClusterCaCertificate: [Output only] Base64 encoded public certificate
- // that is the root of trust for the cluster.
- ClusterCaCertificate string `json:"clusterCaCertificate,omitempty"`
-
- // Password: The password to use for HTTP basic authentication when
- // accessing the Kubernetes master endpoint. Because the master endpoint
- // is open to the internet, you should create a strong password.
- Password string `json:"password,omitempty"`
-
- // Username: The username to use for HTTP basic authentication when
- // accessing the Kubernetes master endpoint.
- Username string `json:"username,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ClientCertificate")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MasterAuth) MarshalJSON() ([]byte, error) {
- type noMethod MasterAuth
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// NodeConfig: Per-node parameters.
-type NodeConfig struct {
- // DiskSizeGb: Size of the disk attached to each node, specified in GB.
- // The smallest allowed disk size is 10GB. If unspecified, the default
- // disk size is 100GB.
- DiskSizeGb int64 `json:"diskSizeGb,omitempty"`
-
- // MachineType: The name of a Google Compute Engine [machine
- // type](/compute/docs/machine-types) (e.g. `n1-standard-1`). If
- // unspecified, the default machine type is `n1-standard-1`.
- MachineType string `json:"machineType,omitempty"`
-
- // OauthScopes: The set of Google API scopes to be made available on all
- // of the node VMs under the "default" service account. The following
- // scopes are recommended, but not required, and by default are not
- // included: * `https://www.googleapis.com/auth/compute` is required for
- // mounting persistent storage on your nodes. *
- // `https://www.googleapis.com/auth/devstorage.read_only` is required
- // for communicating with *gcr.io*. If unspecified, no scopes are added.
- OauthScopes []string `json:"oauthScopes,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DiskSizeGb") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *NodeConfig) MarshalJSON() ([]byte, error) {
- type noMethod NodeConfig
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Operation: Defines the operation resource. All fields are output
-// only.
-type Operation struct {
- // Name: The server-assigned ID for the operation.
- Name string `json:"name,omitempty"`
-
- // OperationType: The operation type.
- //
- // Possible values:
- // "TYPE_UNSPECIFIED"
- // "CREATE_CLUSTER"
- // "DELETE_CLUSTER"
- // "UPGRADE_MASTER"
- // "UPGRADE_NODES"
- // "REPAIR_CLUSTER"
- OperationType string `json:"operationType,omitempty"`
-
- // SelfLink: Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Status: The current status of the operation.
- //
- // Possible values:
- // "STATUS_UNSPECIFIED"
- // "PENDING"
- // "RUNNING"
- // "DONE"
- Status string `json:"status,omitempty"`
-
- // StatusMessage: If an error has occurred, a textual description of the
- // error.
- StatusMessage string `json:"statusMessage,omitempty"`
-
- // TargetLink: Server-defined URL for the target of the operation.
- TargetLink string `json:"targetLink,omitempty"`
-
- // Zone: The name of the Google Compute Engine
- // [zone](/compute/docs/zones#available) in which the operation is
- // taking place.
- Zone string `json:"zone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Name") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Operation) MarshalJSON() ([]byte, error) {
- type noMethod Operation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ServerConfig: Container Engine Server configuration.
-type ServerConfig struct {
- // DefaultClusterVersion: What version this server deploys by default.
- DefaultClusterVersion string `json:"defaultClusterVersion,omitempty"`
-
- // ValidNodeVersions: List of valid node upgrade target versions.
- ValidNodeVersions []string `json:"validNodeVersions,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "DefaultClusterVersion") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ServerConfig) MarshalJSON() ([]byte, error) {
- type noMethod ServerConfig
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UpdateClusterRequest: UpdateClusterRequest updates a cluster.
-type UpdateClusterRequest struct {
- // Update: A description of the update.
- Update *ClusterUpdate `json:"update,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Update") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UpdateClusterRequest) MarshalJSON() ([]byte, error) {
- type noMethod UpdateClusterRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "container.projects.zones.getServerconfig":
-
-type ProjectsZonesGetServerconfigCall struct {
- s *Service
- projectId string
- zone string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetServerconfig: Returns configuration info about the Container
-// Engine service.
-func (r *ProjectsZonesService) GetServerconfig(projectId string, zone string) *ProjectsZonesGetServerconfigCall {
- c := &ProjectsZonesGetServerconfigCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.zone = zone
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsZonesGetServerconfigCall) Fields(s ...googleapi.Field) *ProjectsZonesGetServerconfigCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ProjectsZonesGetServerconfigCall) IfNoneMatch(entityTag string) *ProjectsZonesGetServerconfigCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsZonesGetServerconfigCall) Context(ctx context.Context) *ProjectsZonesGetServerconfigCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsZonesGetServerconfigCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/projects/{projectId}/zones/{zone}/serverconfig")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "container.projects.zones.getServerconfig" call.
-// Exactly one of *ServerConfig or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ServerConfig.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ProjectsZonesGetServerconfigCall) Do() (*ServerConfig, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ServerConfig{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns configuration info about the Container Engine service.",
- // "httpMethod": "GET",
- // "id": "container.projects.zones.getServerconfig",
- // "parameterOrder": [
- // "projectId",
- // "zone"
- // ],
- // "parameters": {
- // "projectId": {
- // "description": "The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber).",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or \"-\" for all zones.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1/projects/{projectId}/zones/{zone}/serverconfig",
- // "response": {
- // "$ref": "ServerConfig"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "container.projects.zones.clusters.create":
-
-type ProjectsZonesClustersCreateCall struct {
- s *Service
- projectId string
- zone string
- createclusterrequest *CreateClusterRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Create: Creates a cluster, consisting of the specified number and
-// type of Google Compute Engine instances, plus a Kubernetes master
-// endpoint. By default, the cluster is created in the project's
-// [default network](/compute/docs/networking#networks_1). One firewall
-// is added for the cluster. After cluster creation, the cluster creates
-// routes for each node to allow the containers on that node to
-// communicate with all other instances in the cluster. Finally, an
-// entry is added to the project's global metadata indicating which CIDR
-// range is being used by the cluster.
-func (r *ProjectsZonesClustersService) Create(projectId string, zone string, createclusterrequest *CreateClusterRequest) *ProjectsZonesClustersCreateCall {
- c := &ProjectsZonesClustersCreateCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.zone = zone
- c.createclusterrequest = createclusterrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsZonesClustersCreateCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersCreateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsZonesClustersCreateCall) Context(ctx context.Context) *ProjectsZonesClustersCreateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsZonesClustersCreateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.createclusterrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/projects/{projectId}/zones/{zone}/clusters")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "zone": c.zone,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "container.projects.zones.clusters.create" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ProjectsZonesClustersCreateCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances, plus a Kubernetes master endpoint. By default, the cluster is created in the project's [default network](/compute/docs/networking#networks_1). One firewall is added for the cluster. After cluster creation, the cluster creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range is being used by the cluster.",
- // "httpMethod": "POST",
- // "id": "container.projects.zones.clusters.create",
- // "parameterOrder": [
- // "projectId",
- // "zone"
- // ],
- // "parameters": {
- // "projectId": {
- // "description": "The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber).",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1/projects/{projectId}/zones/{zone}/clusters",
- // "request": {
- // "$ref": "CreateClusterRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "container.projects.zones.clusters.delete":
-
-type ProjectsZonesClustersDeleteCall struct {
- s *Service
- projectId string
- zone string
- clusterId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the cluster, including the Kubernetes endpoint and
-// all worker nodes. Firewalls and routes that were configured during
-// cluster creation are also deleted.
-func (r *ProjectsZonesClustersService) Delete(projectId string, zone string, clusterId string) *ProjectsZonesClustersDeleteCall {
- c := &ProjectsZonesClustersDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.zone = zone
- c.clusterId = clusterId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsZonesClustersDeleteCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsZonesClustersDeleteCall) Context(ctx context.Context) *ProjectsZonesClustersDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsZonesClustersDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "zone": c.zone,
- "clusterId": c.clusterId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "container.projects.zones.clusters.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ProjectsZonesClustersDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted.",
- // "httpMethod": "DELETE",
- // "id": "container.projects.zones.clusters.delete",
- // "parameterOrder": [
- // "projectId",
- // "zone",
- // "clusterId"
- // ],
- // "parameters": {
- // "clusterId": {
- // "description": "The name of the cluster to delete.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber).",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "container.projects.zones.clusters.get":
-
-type ProjectsZonesClustersGetCall struct {
- s *Service
- projectId string
- zone string
- clusterId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets a specific cluster.
-func (r *ProjectsZonesClustersService) Get(projectId string, zone string, clusterId string) *ProjectsZonesClustersGetCall {
- c := &ProjectsZonesClustersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.zone = zone
- c.clusterId = clusterId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsZonesClustersGetCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ProjectsZonesClustersGetCall) IfNoneMatch(entityTag string) *ProjectsZonesClustersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsZonesClustersGetCall) Context(ctx context.Context) *ProjectsZonesClustersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsZonesClustersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "zone": c.zone,
- "clusterId": c.clusterId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "container.projects.zones.clusters.get" call.
-// Exactly one of *Cluster or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Cluster.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ProjectsZonesClustersGetCall) Do() (*Cluster, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Cluster{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets a specific cluster.",
- // "httpMethod": "GET",
- // "id": "container.projects.zones.clusters.get",
- // "parameterOrder": [
- // "projectId",
- // "zone",
- // "clusterId"
- // ],
- // "parameters": {
- // "clusterId": {
- // "description": "The name of the cluster to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber).",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- // "response": {
- // "$ref": "Cluster"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "container.projects.zones.clusters.list":
-
-type ProjectsZonesClustersListCall struct {
- s *Service
- projectId string
- zone string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all clusters owned by a project in either the specified
-// zone or all zones.
-func (r *ProjectsZonesClustersService) List(projectId string, zone string) *ProjectsZonesClustersListCall {
- c := &ProjectsZonesClustersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.zone = zone
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsZonesClustersListCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ProjectsZonesClustersListCall) IfNoneMatch(entityTag string) *ProjectsZonesClustersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsZonesClustersListCall) Context(ctx context.Context) *ProjectsZonesClustersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsZonesClustersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/projects/{projectId}/zones/{zone}/clusters")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "container.projects.zones.clusters.list" call.
-// Exactly one of *ListClustersResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ListClustersResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ProjectsZonesClustersListCall) Do() (*ListClustersResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ListClustersResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all clusters owned by a project in either the specified zone or all zones.",
- // "httpMethod": "GET",
- // "id": "container.projects.zones.clusters.list",
- // "parameterOrder": [
- // "projectId",
- // "zone"
- // ],
- // "parameters": {
- // "projectId": {
- // "description": "The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber).",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1/projects/{projectId}/zones/{zone}/clusters",
- // "response": {
- // "$ref": "ListClustersResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "container.projects.zones.clusters.update":
-
-type ProjectsZonesClustersUpdateCall struct {
- s *Service
- projectId string
- zone string
- clusterId string
- updateclusterrequest *UpdateClusterRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Update settings of a specific cluster.
-func (r *ProjectsZonesClustersService) Update(projectId string, zone string, clusterId string, updateclusterrequest *UpdateClusterRequest) *ProjectsZonesClustersUpdateCall {
- c := &ProjectsZonesClustersUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.zone = zone
- c.clusterId = clusterId
- c.updateclusterrequest = updateclusterrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsZonesClustersUpdateCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsZonesClustersUpdateCall) Context(ctx context.Context) *ProjectsZonesClustersUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsZonesClustersUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.updateclusterrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "zone": c.zone,
- "clusterId": c.clusterId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "container.projects.zones.clusters.update" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ProjectsZonesClustersUpdateCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Update settings of a specific cluster.",
- // "httpMethod": "PUT",
- // "id": "container.projects.zones.clusters.update",
- // "parameterOrder": [
- // "projectId",
- // "zone",
- // "clusterId"
- // ],
- // "parameters": {
- // "clusterId": {
- // "description": "The name of the cluster to upgrade.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber).",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- // "request": {
- // "$ref": "UpdateClusterRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "container.projects.zones.operations.get":
-
-type ProjectsZonesOperationsGetCall struct {
- s *Service
- projectId string
- zone string
- operationId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets the specified operation.
-func (r *ProjectsZonesOperationsService) Get(projectId string, zone string, operationId string) *ProjectsZonesOperationsGetCall {
- c := &ProjectsZonesOperationsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.zone = zone
- c.operationId = operationId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsZonesOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsZonesOperationsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ProjectsZonesOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsZonesOperationsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsZonesOperationsGetCall) Context(ctx context.Context) *ProjectsZonesOperationsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsZonesOperationsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/projects/{projectId}/zones/{zone}/operations/{operationId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "zone": c.zone,
- "operationId": c.operationId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "container.projects.zones.operations.get" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ProjectsZonesOperationsGetCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the specified operation.",
- // "httpMethod": "GET",
- // "id": "container.projects.zones.operations.get",
- // "parameterOrder": [
- // "projectId",
- // "zone",
- // "operationId"
- // ],
- // "parameters": {
- // "operationId": {
- // "description": "The server-assigned `name` of the operation.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber).",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "container.projects.zones.operations.list":
-
-type ProjectsZonesOperationsListCall struct {
- s *Service
- projectId string
- zone string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all operations in a project in a specific zone or all
-// zones.
-func (r *ProjectsZonesOperationsService) List(projectId string, zone string) *ProjectsZonesOperationsListCall {
- c := &ProjectsZonesOperationsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.zone = zone
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsZonesOperationsListCall) Fields(s ...googleapi.Field) *ProjectsZonesOperationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ProjectsZonesOperationsListCall) IfNoneMatch(entityTag string) *ProjectsZonesOperationsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsZonesOperationsListCall) Context(ctx context.Context) *ProjectsZonesOperationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsZonesOperationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1/projects/{projectId}/zones/{zone}/operations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "zone": c.zone,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "container.projects.zones.operations.list" call.
-// Exactly one of *ListOperationsResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ListOperationsResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ProjectsZonesOperationsListCall) Do() (*ListOperationsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ListOperationsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all operations in a project in a specific zone or all zones.",
- // "httpMethod": "GET",
- // "id": "container.projects.zones.operations.list",
- // "parameterOrder": [
- // "projectId",
- // "zone"
- // ],
- // "parameters": {
- // "projectId": {
- // "description": "The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber).",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "zone": {
- // "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or \"-\" for all zones.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1/projects/{projectId}/zones/{zone}/operations",
- // "response": {
- // "$ref": "ListOperationsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/container/v1beta1/container-api.json b/vendor/google.golang.org/api/container/v1beta1/container-api.json
deleted file mode 100644
index 22cc348a..00000000
--- a/vendor/google.golang.org/api/container/v1beta1/container-api.json
+++ /dev/null
@@ -1,644 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/hfLmCQ4Ut9jPERvGmAwjUd46Fc8\"",
- "discoveryVersion": "v1",
- "id": "container:v1beta1",
- "name": "container",
- "version": "v1beta1",
- "revision": "20150728",
- "title": "Google Container Engine API",
- "description": "The Google Container Engine API is used for building and managing container based applications, powered by the open source Kubernetes technology.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/container-engine/docs/v1beta1/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/container/v1beta1/projects/",
- "basePath": "/container/v1beta1/projects/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "container/v1beta1/projects/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "schemas": {
- "Cluster": {
- "id": "Cluster",
- "type": "object",
- "properties": {
- "clusterApiVersion": {
- "type": "string",
- "description": "The API version of the Kubernetes master and kubelets running in this cluster. Leave blank to pick up the latest stable release, or specify a version of the form \"x.y.z\". The Google Container Engine release notes lists the currently supported versions. If an incorrect version is specified, the server returns an error listing the currently supported versions."
- },
- "containerIpv4Cidr": {
- "type": "string",
- "description": "The IP address range of the container pods in this cluster, in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output only] The time the cluster was created, in RFC3339 text format."
- },
- "description": {
- "type": "string",
- "description": "An optional description of this cluster."
- },
- "enableCloudLogging": {
- "type": "boolean",
- "description": "Whether logs from the cluster should be made available via the Google Cloud Logging service. This includes both logs from your applications running in the cluster as well as logs from the Kubernetes components themselves."
- },
- "enableCloudMonitoring": {
- "type": "boolean",
- "description": "Whether metrics from the cluster should be made available via the Google Cloud Monitoring service."
- },
- "endpoint": {
- "type": "string",
- "description": "[Output only] The IP address of this cluster's Kubernetes master. The endpoint can be accessed from the internet at https://username:password@endpoint/.\n\nSee the masterAuth property of this resource for username and password information."
- },
- "instanceGroupUrls": {
- "type": "array",
- "description": "[Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this cluster.",
- "items": {
- "type": "string"
- }
- },
- "masterAuth": {
- "$ref": "MasterAuth",
- "description": "The authentication information for accessing the master."
- },
- "name": {
- "type": "string",
- "description": "The name of this cluster. The name must be unique within this project and zone, and can be up to 40 characters with the following restrictions: \n- Lowercase letters, numbers, and hyphens only.\n- Must start with a letter.\n- Must end with a number or a letter."
- },
- "network": {
- "type": "string",
- "description": "The name of the Google Compute Engine network to which the cluster is connected."
- },
- "nodeConfig": {
- "$ref": "NodeConfig",
- "description": "The machine type and image to use for all nodes in this cluster. See the descriptions of the child properties of nodeConfig."
- },
- "nodeRoutingPrefixSize": {
- "type": "integer",
- "description": "[Output only] The size of the address space on each node for hosting containers.",
- "format": "int32"
- },
- "numNodes": {
- "type": "integer",
- "description": "The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances plus one (to include the master). You must also have available firewall and routes quota.",
- "format": "int32"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output only] Server-defined URL for the resource."
- },
- "servicesIpv4Cidr": {
- "type": "string",
- "description": "[Output only] The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29). Service addresses are typically put in the last /16 from the container CIDR."
- },
- "status": {
- "type": "string",
- "description": "[Output only] The current status of this cluster.",
- "enum": [
- "error",
- "provisioning",
- "running",
- "stopping"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- },
- "statusMessage": {
- "type": "string",
- "description": "[Output only] Additional information about the current status of this cluster, if available."
- },
- "zone": {
- "type": "string",
- "description": "[Output only] The name of the Google Compute Engine zone in which the cluster resides."
- }
- }
- },
- "CreateClusterRequest": {
- "id": "CreateClusterRequest",
- "type": "object",
- "properties": {
- "cluster": {
- "$ref": "Cluster",
- "description": "A cluster resource."
- }
- }
- },
- "ListAggregatedClustersResponse": {
- "id": "ListAggregatedClustersResponse",
- "type": "object",
- "properties": {
- "clusters": {
- "type": "array",
- "description": "A list of clusters in the project, across all zones.",
- "items": {
- "$ref": "Cluster"
- }
- }
- }
- },
- "ListAggregatedOperationsResponse": {
- "id": "ListAggregatedOperationsResponse",
- "type": "object",
- "properties": {
- "operations": {
- "type": "array",
- "description": "A list of operations in the project, across all zones.",
- "items": {
- "$ref": "Operation"
- }
- }
- }
- },
- "ListClustersResponse": {
- "id": "ListClustersResponse",
- "type": "object",
- "properties": {
- "clusters": {
- "type": "array",
- "description": "A list of clusters in the project in the specified zone.",
- "items": {
- "$ref": "Cluster"
- }
- }
- }
- },
- "ListOperationsResponse": {
- "id": "ListOperationsResponse",
- "type": "object",
- "properties": {
- "operations": {
- "type": "array",
- "description": "A list of operations in the project in the specified zone.",
- "items": {
- "$ref": "Operation"
- }
- }
- }
- },
- "MasterAuth": {
- "id": "MasterAuth",
- "type": "object",
- "description": "The authentication information for accessing the master. Authentication is either done using HTTP basic authentication or using a bearer token.",
- "properties": {
- "bearerToken": {
- "type": "string",
- "description": "The token used to authenticate API requests to the master. The token is to be included in an HTTP Authorization Header in all requests to the master endpoint. The format of the header is: \"Authorization: Bearer \"."
- },
- "clientCertificate": {
- "type": "string",
- "description": "[Output only] Base64 encoded public certificate used by clients to authenticate to the cluster endpoint."
- },
- "clientKey": {
- "type": "string",
- "description": "[Output only] Base64 encoded private key used by clients to authenticate to the cluster endpoint."
- },
- "clusterCaCertificate": {
- "type": "string",
- "description": "[Output only] Base64 encoded public certificate that is the root of trust for the cluster."
- },
- "password": {
- "type": "string",
- "description": "The password to use for HTTP basic authentication when accessing the Kubernetes master endpoint. Because the master endpoint is open to the internet, you should create a strong password."
- },
- "user": {
- "type": "string",
- "description": "The username to use for HTTP basic authentication when accessing the Kubernetes master endpoint."
- }
- }
- },
- "NodeConfig": {
- "id": "NodeConfig",
- "type": "object",
- "properties": {
- "machineType": {
- "type": "string",
- "description": "The name of a Google Compute Engine machine type (e.g. n1-standard-1).\n\nIf unspecified, the default machine type is n1-standard-1."
- },
- "serviceAccounts": {
- "type": "array",
- "description": "The optional list of ServiceAccounts, each with their specified scopes, to be made available on all of the node VMs. In addition to the service accounts and scopes specified, the \"default\" account will always be created with the following scopes to ensure the correct functioning of the cluster: \n- https://www.googleapis.com/auth/compute,\n- https://www.googleapis.com/auth/devstorage.read_only",
- "items": {
- "$ref": "ServiceAccount"
- }
- },
- "sourceImage": {
- "type": "string",
- "description": "The fully-specified name of a Google Compute Engine image. For example: https://www.googleapis.com/compute/v1/projects/debian-cloud/global/images/backports-debian-7-wheezy-vYYYYMMDD (where YYYMMDD is the version date).\n\nIf specifying an image, you are responsible for ensuring its compatibility with the Debian 7 backports image. We recommend leaving this field blank to accept the default backports-debian-7-wheezy value."
- }
- }
- },
- "Operation": {
- "id": "Operation",
- "type": "object",
- "description": "Defines the operation resource. All fields are output only.",
- "properties": {
- "errorMessage": {
- "type": "string",
- "description": "If an error has occurred, a textual description of the error."
- },
- "name": {
- "type": "string",
- "description": "The server-assigned ID for the operation."
- },
- "operationType": {
- "type": "string",
- "description": "The operation type.",
- "enum": [
- "createCluster",
- "deleteCluster"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "selfLink": {
- "type": "string",
- "description": "Server-defined URL for the resource."
- },
- "status": {
- "type": "string",
- "description": "The current status of the operation.",
- "enum": [
- "done",
- "pending",
- "running"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "target": {
- "type": "string",
- "description": "[Optional] The URL of the cluster resource that this operation is associated with."
- },
- "targetLink": {
- "type": "string",
- "description": "Server-defined URL for the target of the operation."
- },
- "zone": {
- "type": "string",
- "description": "The name of the Google Compute Engine zone in which the operation is taking place."
- }
- }
- },
- "ServiceAccount": {
- "id": "ServiceAccount",
- "type": "object",
- "description": "A Compute Engine service account.",
- "properties": {
- "email": {
- "type": "string",
- "description": "Email address of the service account."
- },
- "scopes": {
- "type": "array",
- "description": "The list of scopes to be made available for this service account.",
- "items": {
- "type": "string"
- }
- }
- }
- }
- },
- "resources": {
- "projects": {
- "resources": {
- "clusters": {
- "methods": {
- "list": {
- "id": "container.projects.clusters.list",
- "path": "{projectId}/clusters",
- "httpMethod": "GET",
- "description": "Lists all clusters owned by a project across all zones.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "The Google Developers Console project ID or project number.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "ListAggregatedClustersResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- },
- "operations": {
- "methods": {
- "list": {
- "id": "container.projects.operations.list",
- "path": "{projectId}/operations",
- "httpMethod": "GET",
- "description": "Lists all operations in a project, across all zones.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "The Google Developers Console project ID or project number.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "ListAggregatedOperationsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- },
- "zones": {
- "resources": {
- "clusters": {
- "methods": {
- "create": {
- "id": "container.projects.zones.clusters.create",
- "path": "{projectId}/zones/{zoneId}/clusters",
- "httpMethod": "POST",
- "description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances, plus a Kubernetes master instance.\n\nThe cluster is created in the project's default network.\n\nA firewall is added that allows traffic into port 443 on the master, which enables HTTPS. A firewall and a route is added for each node to allow the containers on that node to communicate with all other instances in the cluster.\n\nFinally, an entry is added to the project's global metadata indicating which CIDR range is being used by the cluster.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "The Google Developers Console project ID or project number.",
- "required": true,
- "location": "path"
- },
- "zoneId": {
- "type": "string",
- "description": "The name of the Google Compute Engine zone in which the cluster resides.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "zoneId"
- ],
- "request": {
- "$ref": "CreateClusterRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "delete": {
- "id": "container.projects.zones.clusters.delete",
- "path": "{projectId}/zones/{zoneId}/clusters/{clusterId}",
- "httpMethod": "DELETE",
- "description": "Deletes the cluster, including the Kubernetes master and all worker nodes.\n\nFirewalls and routes that were configured at cluster creation are also deleted.",
- "parameters": {
- "clusterId": {
- "type": "string",
- "description": "The name of the cluster to delete.",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "The Google Developers Console project ID or project number.",
- "required": true,
- "location": "path"
- },
- "zoneId": {
- "type": "string",
- "description": "The name of the Google Compute Engine zone in which the cluster resides.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "zoneId",
- "clusterId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "get": {
- "id": "container.projects.zones.clusters.get",
- "path": "{projectId}/zones/{zoneId}/clusters/{clusterId}",
- "httpMethod": "GET",
- "description": "Gets a specific cluster.",
- "parameters": {
- "clusterId": {
- "type": "string",
- "description": "The name of the cluster to retrieve.",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "The Google Developers Console project ID or project number.",
- "required": true,
- "location": "path"
- },
- "zoneId": {
- "type": "string",
- "description": "The name of the Google Compute Engine zone in which the cluster resides.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "zoneId",
- "clusterId"
- ],
- "response": {
- "$ref": "Cluster"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "list": {
- "id": "container.projects.zones.clusters.list",
- "path": "{projectId}/zones/{zoneId}/clusters",
- "httpMethod": "GET",
- "description": "Lists all clusters owned by a project in the specified zone.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "The Google Developers Console project ID or project number.",
- "required": true,
- "location": "path"
- },
- "zoneId": {
- "type": "string",
- "description": "The name of the Google Compute Engine zone in which the cluster resides.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "zoneId"
- ],
- "response": {
- "$ref": "ListClustersResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- },
- "operations": {
- "methods": {
- "get": {
- "id": "container.projects.zones.operations.get",
- "path": "{projectId}/zones/{zoneId}/operations/{operationId}",
- "httpMethod": "GET",
- "description": "Gets the specified operation.",
- "parameters": {
- "operationId": {
- "type": "string",
- "description": "The server-assigned name of the operation.",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "The Google Developers Console project ID or project number.",
- "required": true,
- "location": "path"
- },
- "zoneId": {
- "type": "string",
- "description": "The name of the Google Compute Engine zone in which the operation resides. This is always the same zone as the cluster with which the operation is associated.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "zoneId",
- "operationId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "list": {
- "id": "container.projects.zones.operations.list",
- "path": "{projectId}/zones/{zoneId}/operations",
- "httpMethod": "GET",
- "description": "Lists all operations in a project in a specific zone.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "The Google Developers Console project ID or project number.",
- "required": true,
- "location": "path"
- },
- "zoneId": {
- "type": "string",
- "description": "The name of the Google Compute Engine zone to return operations for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "zoneId"
- ],
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- }
- }
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/container/v1beta1/container-gen.go b/vendor/google.golang.org/api/container/v1beta1/container-gen.go
deleted file mode 100644
index 78e9a3c6..00000000
--- a/vendor/google.golang.org/api/container/v1beta1/container-gen.go
+++ /dev/null
@@ -1,1369 +0,0 @@
-// Package container provides access to the Google Container Engine API.
-//
-// See https://cloud.google.com/container-engine/docs/v1beta1/
-//
-// Usage example:
-//
-// import "google.golang.org/api/container/v1beta1"
-// ...
-// containerService, err := container.New(oauthHttpClient)
-package container
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-
-const apiId = "container:v1beta1"
-const apiName = "container"
-const apiVersion = "v1beta1"
-const basePath = "https://www.googleapis.com/container/v1beta1/projects/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your data across Google Cloud Platform services
- CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Projects = NewProjectsService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Projects *ProjectsService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewProjectsService(s *Service) *ProjectsService {
- rs := &ProjectsService{s: s}
- rs.Clusters = NewProjectsClustersService(s)
- rs.Operations = NewProjectsOperationsService(s)
- rs.Zones = NewProjectsZonesService(s)
- return rs
-}
-
-type ProjectsService struct {
- s *Service
-
- Clusters *ProjectsClustersService
-
- Operations *ProjectsOperationsService
-
- Zones *ProjectsZonesService
-}
-
-func NewProjectsClustersService(s *Service) *ProjectsClustersService {
- rs := &ProjectsClustersService{s: s}
- return rs
-}
-
-type ProjectsClustersService struct {
- s *Service
-}
-
-func NewProjectsOperationsService(s *Service) *ProjectsOperationsService {
- rs := &ProjectsOperationsService{s: s}
- return rs
-}
-
-type ProjectsOperationsService struct {
- s *Service
-}
-
-func NewProjectsZonesService(s *Service) *ProjectsZonesService {
- rs := &ProjectsZonesService{s: s}
- rs.Clusters = NewProjectsZonesClustersService(s)
- rs.Operations = NewProjectsZonesOperationsService(s)
- return rs
-}
-
-type ProjectsZonesService struct {
- s *Service
-
- Clusters *ProjectsZonesClustersService
-
- Operations *ProjectsZonesOperationsService
-}
-
-func NewProjectsZonesClustersService(s *Service) *ProjectsZonesClustersService {
- rs := &ProjectsZonesClustersService{s: s}
- return rs
-}
-
-type ProjectsZonesClustersService struct {
- s *Service
-}
-
-func NewProjectsZonesOperationsService(s *Service) *ProjectsZonesOperationsService {
- rs := &ProjectsZonesOperationsService{s: s}
- return rs
-}
-
-type ProjectsZonesOperationsService struct {
- s *Service
-}
-
-type Cluster struct {
- // ClusterApiVersion: The API version of the Kubernetes master and
- // kubelets running in this cluster. Leave blank to pick up the latest
- // stable release, or specify a version of the form "x.y.z". The Google
- // Container Engine release notes lists the currently supported
- // versions. If an incorrect version is specified, the server returns an
- // error listing the currently supported versions.
- ClusterApiVersion string `json:"clusterApiVersion,omitempty"`
-
- // ContainerIpv4Cidr: The IP address range of the container pods in this
- // cluster, in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have
- // one automatically chosen or specify a /14 block in 10.0.0.0/8.
- ContainerIpv4Cidr string `json:"containerIpv4Cidr,omitempty"`
-
- // CreationTimestamp: [Output only] The time the cluster was created, in
- // RFC3339 text format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // Description: An optional description of this cluster.
- Description string `json:"description,omitempty"`
-
- // EnableCloudLogging: Whether logs from the cluster should be made
- // available via the Google Cloud Logging service. This includes both
- // logs from your applications running in the cluster as well as logs
- // from the Kubernetes components themselves.
- EnableCloudLogging bool `json:"enableCloudLogging,omitempty"`
-
- // EnableCloudMonitoring: Whether metrics from the cluster should be
- // made available via the Google Cloud Monitoring service.
- EnableCloudMonitoring bool `json:"enableCloudMonitoring,omitempty"`
-
- // Endpoint: [Output only] The IP address of this cluster's Kubernetes
- // master. The endpoint can be accessed from the internet at
- // https://username:password@endpoint/.
- //
- // See the masterAuth property of this resource for username and
- // password information.
- Endpoint string `json:"endpoint,omitempty"`
-
- // InstanceGroupUrls: [Output only] The resource URLs of [instance
- // groups](/compute/docs/instance-groups/) associated with this cluster.
- InstanceGroupUrls []string `json:"instanceGroupUrls,omitempty"`
-
- // MasterAuth: The authentication information for accessing the master.
- MasterAuth *MasterAuth `json:"masterAuth,omitempty"`
-
- // Name: The name of this cluster. The name must be unique within this
- // project and zone, and can be up to 40 characters with the following
- // restrictions:
- // - Lowercase letters, numbers, and hyphens only.
- // - Must start with a letter.
- // - Must end with a number or a letter.
- Name string `json:"name,omitempty"`
-
- // Network: The name of the Google Compute Engine network to which the
- // cluster is connected.
- Network string `json:"network,omitempty"`
-
- // NodeConfig: The machine type and image to use for all nodes in this
- // cluster. See the descriptions of the child properties of nodeConfig.
- NodeConfig *NodeConfig `json:"nodeConfig,omitempty"`
-
- // NodeRoutingPrefixSize: [Output only] The size of the address space on
- // each node for hosting containers.
- NodeRoutingPrefixSize int64 `json:"nodeRoutingPrefixSize,omitempty"`
-
- // NumNodes: The number of nodes to create in this cluster. You must
- // ensure that your Compute Engine resource quota is sufficient for this
- // number of instances plus one (to include the master). You must also
- // have available firewall and routes quota.
- NumNodes int64 `json:"numNodes,omitempty"`
-
- // SelfLink: [Output only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServicesIpv4Cidr: [Output only] The IP address range of the
- // Kubernetes services in this cluster, in CIDR notation (e.g.
- // 1.2.3.4/29). Service addresses are typically put in the last /16 from
- // the container CIDR.
- ServicesIpv4Cidr string `json:"servicesIpv4Cidr,omitempty"`
-
- // Status: [Output only] The current status of this cluster.
- //
- // Possible values:
- // "error"
- // "provisioning"
- // "running"
- // "stopping"
- Status string `json:"status,omitempty"`
-
- // StatusMessage: [Output only] Additional information about the current
- // status of this cluster, if available.
- StatusMessage string `json:"statusMessage,omitempty"`
-
- // Zone: [Output only] The name of the Google Compute Engine zone in
- // which the cluster resides.
- Zone string `json:"zone,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ClusterApiVersion")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Cluster) MarshalJSON() ([]byte, error) {
- type noMethod Cluster
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CreateClusterRequest struct {
- // Cluster: A cluster resource.
- Cluster *Cluster `json:"cluster,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Cluster") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreateClusterRequest) MarshalJSON() ([]byte, error) {
- type noMethod CreateClusterRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ListAggregatedClustersResponse struct {
- // Clusters: A list of clusters in the project, across all zones.
- Clusters []*Cluster `json:"clusters,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Clusters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListAggregatedClustersResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListAggregatedClustersResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ListAggregatedOperationsResponse struct {
- // Operations: A list of operations in the project, across all zones.
- Operations []*Operation `json:"operations,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Operations") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListAggregatedOperationsResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListAggregatedOperationsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ListClustersResponse struct {
- // Clusters: A list of clusters in the project in the specified zone.
- Clusters []*Cluster `json:"clusters,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Clusters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListClustersResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListClustersResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ListOperationsResponse struct {
- // Operations: A list of operations in the project in the specified
- // zone.
- Operations []*Operation `json:"operations,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Operations") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListOperationsResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListOperationsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MasterAuth: The authentication information for accessing the master.
-// Authentication is either done using HTTP basic authentication or
-// using a bearer token.
-type MasterAuth struct {
- // BearerToken: The token used to authenticate API requests to the
- // master. The token is to be included in an HTTP Authorization Header
- // in all requests to the master endpoint. The format of the header is:
- // "Authorization: Bearer ".
- BearerToken string `json:"bearerToken,omitempty"`
-
- // ClientCertificate: [Output only] Base64 encoded public certificate
- // used by clients to authenticate to the cluster endpoint.
- ClientCertificate string `json:"clientCertificate,omitempty"`
-
- // ClientKey: [Output only] Base64 encoded private key used by clients
- // to authenticate to the cluster endpoint.
- ClientKey string `json:"clientKey,omitempty"`
-
- // ClusterCaCertificate: [Output only] Base64 encoded public certificate
- // that is the root of trust for the cluster.
- ClusterCaCertificate string `json:"clusterCaCertificate,omitempty"`
-
- // Password: The password to use for HTTP basic authentication when
- // accessing the Kubernetes master endpoint. Because the master endpoint
- // is open to the internet, you should create a strong password.
- Password string `json:"password,omitempty"`
-
- // User: The username to use for HTTP basic authentication when
- // accessing the Kubernetes master endpoint.
- User string `json:"user,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BearerToken") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MasterAuth) MarshalJSON() ([]byte, error) {
- type noMethod MasterAuth
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type NodeConfig struct {
- // MachineType: The name of a Google Compute Engine machine type (e.g.
- // n1-standard-1).
- //
- // If unspecified, the default machine type is n1-standard-1.
- MachineType string `json:"machineType,omitempty"`
-
- // ServiceAccounts: The optional list of ServiceAccounts, each with
- // their specified scopes, to be made available on all of the node VMs.
- // In addition to the service accounts and scopes specified, the
- // "default" account will always be created with the following scopes to
- // ensure the correct functioning of the cluster:
- // - https://www.googleapis.com/auth/compute,
- // - https://www.googleapis.com/auth/devstorage.read_only
- ServiceAccounts []*ServiceAccount `json:"serviceAccounts,omitempty"`
-
- // SourceImage: The fully-specified name of a Google Compute Engine
- // image. For example:
- // https://www.googleapis.com/compute/v1/projects/debian-cloud/global/images/backports-debian-7-wheezy-vYYYYMMDD (where YYYMMDD is the version date).
- //
- // If specifying an image, you are responsible for ensuring its
- // compatibility with the Debian 7 backports image. We recommend leaving
- // this field blank to accept the default backports-debian-7-wheezy
- // value.
- SourceImage string `json:"sourceImage,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "MachineType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *NodeConfig) MarshalJSON() ([]byte, error) {
- type noMethod NodeConfig
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Operation: Defines the operation resource. All fields are output
-// only.
-type Operation struct {
- // ErrorMessage: If an error has occurred, a textual description of the
- // error.
- ErrorMessage string `json:"errorMessage,omitempty"`
-
- // Name: The server-assigned ID for the operation.
- Name string `json:"name,omitempty"`
-
- // OperationType: The operation type.
- //
- // Possible values:
- // "createCluster"
- // "deleteCluster"
- OperationType string `json:"operationType,omitempty"`
-
- // SelfLink: Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // Status: The current status of the operation.
- //
- // Possible values:
- // "done"
- // "pending"
- // "running"
- Status string `json:"status,omitempty"`
-
- // Target: [Optional] The URL of the cluster resource that this
- // operation is associated with.
- Target string `json:"target,omitempty"`
-
- // TargetLink: Server-defined URL for the target of the operation.
- TargetLink string `json:"targetLink,omitempty"`
-
- // Zone: The name of the Google Compute Engine zone in which the
- // operation is taking place.
- Zone string `json:"zone,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ErrorMessage") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Operation) MarshalJSON() ([]byte, error) {
- type noMethod Operation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ServiceAccount: A Compute Engine service account.
-type ServiceAccount struct {
- // Email: Email address of the service account.
- Email string `json:"email,omitempty"`
-
- // Scopes: The list of scopes to be made available for this service
- // account.
- Scopes []string `json:"scopes,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Email") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ServiceAccount) MarshalJSON() ([]byte, error) {
- type noMethod ServiceAccount
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "container.projects.clusters.list":
-
-type ProjectsClustersListCall struct {
- s *Service
- projectId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all clusters owned by a project across all zones.
-func (r *ProjectsClustersService) List(projectId string) *ProjectsClustersListCall {
- c := &ProjectsClustersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsClustersListCall) Fields(s ...googleapi.Field) *ProjectsClustersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsClustersListCall) Context(ctx context.Context) *ProjectsClustersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsClustersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{projectId}/clusters")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-func (c *ProjectsClustersListCall) Do() (*ListAggregatedClustersResponse, error) {
- res, err := c.doRequest("json")
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- var ret *ListAggregatedClustersResponse
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all clusters owned by a project across all zones.",
- // "httpMethod": "GET",
- // "id": "container.projects.clusters.list",
- // "parameterOrder": [
- // "projectId"
- // ],
- // "parameters": {
- // "projectId": {
- // "description": "The Google Developers Console project ID or project number.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{projectId}/clusters",
- // "response": {
- // "$ref": "ListAggregatedClustersResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "container.projects.operations.list":
-
-type ProjectsOperationsListCall struct {
- s *Service
- projectId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all operations in a project, across all zones.
-func (r *ProjectsOperationsService) List(projectId string) *ProjectsOperationsListCall {
- c := &ProjectsOperationsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsOperationsListCall) Fields(s ...googleapi.Field) *ProjectsOperationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsOperationsListCall) Context(ctx context.Context) *ProjectsOperationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsOperationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{projectId}/operations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-func (c *ProjectsOperationsListCall) Do() (*ListAggregatedOperationsResponse, error) {
- res, err := c.doRequest("json")
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- var ret *ListAggregatedOperationsResponse
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all operations in a project, across all zones.",
- // "httpMethod": "GET",
- // "id": "container.projects.operations.list",
- // "parameterOrder": [
- // "projectId"
- // ],
- // "parameters": {
- // "projectId": {
- // "description": "The Google Developers Console project ID or project number.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{projectId}/operations",
- // "response": {
- // "$ref": "ListAggregatedOperationsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "container.projects.zones.clusters.create":
-
-type ProjectsZonesClustersCreateCall struct {
- s *Service
- projectId string
- zoneId string
- createclusterrequest *CreateClusterRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Create: Creates a cluster, consisting of the specified number and
-// type of Google Compute Engine instances, plus a Kubernetes master
-// instance.
-//
-// The cluster is created in the project's default network.
-//
-// A firewall is added that allows traffic into port 443 on the master,
-// which enables HTTPS. A firewall and a route is added for each node to
-// allow the containers on that node to communicate with all other
-// instances in the cluster.
-//
-// Finally, an entry is added to the project's global metadata
-// indicating which CIDR range is being used by the cluster.
-func (r *ProjectsZonesClustersService) Create(projectId string, zoneId string, createclusterrequest *CreateClusterRequest) *ProjectsZonesClustersCreateCall {
- c := &ProjectsZonesClustersCreateCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.zoneId = zoneId
- c.createclusterrequest = createclusterrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsZonesClustersCreateCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersCreateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsZonesClustersCreateCall) Context(ctx context.Context) *ProjectsZonesClustersCreateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsZonesClustersCreateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.createclusterrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{projectId}/zones/{zoneId}/clusters")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "zoneId": c.zoneId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-func (c *ProjectsZonesClustersCreateCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- var ret *Operation
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances, plus a Kubernetes master instance.\n\nThe cluster is created in the project's default network.\n\nA firewall is added that allows traffic into port 443 on the master, which enables HTTPS. A firewall and a route is added for each node to allow the containers on that node to communicate with all other instances in the cluster.\n\nFinally, an entry is added to the project's global metadata indicating which CIDR range is being used by the cluster.",
- // "httpMethod": "POST",
- // "id": "container.projects.zones.clusters.create",
- // "parameterOrder": [
- // "projectId",
- // "zoneId"
- // ],
- // "parameters": {
- // "projectId": {
- // "description": "The Google Developers Console project ID or project number.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "zoneId": {
- // "description": "The name of the Google Compute Engine zone in which the cluster resides.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{projectId}/zones/{zoneId}/clusters",
- // "request": {
- // "$ref": "CreateClusterRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "container.projects.zones.clusters.delete":
-
-type ProjectsZonesClustersDeleteCall struct {
- s *Service
- projectId string
- zoneId string
- clusterId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes the cluster, including the Kubernetes master and all
-// worker nodes.
-//
-// Firewalls and routes that were configured at cluster creation are
-// also deleted.
-func (r *ProjectsZonesClustersService) Delete(projectId string, zoneId string, clusterId string) *ProjectsZonesClustersDeleteCall {
- c := &ProjectsZonesClustersDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.zoneId = zoneId
- c.clusterId = clusterId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsZonesClustersDeleteCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsZonesClustersDeleteCall) Context(ctx context.Context) *ProjectsZonesClustersDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsZonesClustersDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{projectId}/zones/{zoneId}/clusters/{clusterId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "zoneId": c.zoneId,
- "clusterId": c.clusterId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-func (c *ProjectsZonesClustersDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- var ret *Operation
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes the cluster, including the Kubernetes master and all worker nodes.\n\nFirewalls and routes that were configured at cluster creation are also deleted.",
- // "httpMethod": "DELETE",
- // "id": "container.projects.zones.clusters.delete",
- // "parameterOrder": [
- // "projectId",
- // "zoneId",
- // "clusterId"
- // ],
- // "parameters": {
- // "clusterId": {
- // "description": "The name of the cluster to delete.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "The Google Developers Console project ID or project number.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "zoneId": {
- // "description": "The name of the Google Compute Engine zone in which the cluster resides.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{projectId}/zones/{zoneId}/clusters/{clusterId}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "container.projects.zones.clusters.get":
-
-type ProjectsZonesClustersGetCall struct {
- s *Service
- projectId string
- zoneId string
- clusterId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets a specific cluster.
-func (r *ProjectsZonesClustersService) Get(projectId string, zoneId string, clusterId string) *ProjectsZonesClustersGetCall {
- c := &ProjectsZonesClustersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.zoneId = zoneId
- c.clusterId = clusterId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsZonesClustersGetCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsZonesClustersGetCall) Context(ctx context.Context) *ProjectsZonesClustersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsZonesClustersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{projectId}/zones/{zoneId}/clusters/{clusterId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "zoneId": c.zoneId,
- "clusterId": c.clusterId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-func (c *ProjectsZonesClustersGetCall) Do() (*Cluster, error) {
- res, err := c.doRequest("json")
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- var ret *Cluster
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets a specific cluster.",
- // "httpMethod": "GET",
- // "id": "container.projects.zones.clusters.get",
- // "parameterOrder": [
- // "projectId",
- // "zoneId",
- // "clusterId"
- // ],
- // "parameters": {
- // "clusterId": {
- // "description": "The name of the cluster to retrieve.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "The Google Developers Console project ID or project number.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "zoneId": {
- // "description": "The name of the Google Compute Engine zone in which the cluster resides.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{projectId}/zones/{zoneId}/clusters/{clusterId}",
- // "response": {
- // "$ref": "Cluster"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "container.projects.zones.clusters.list":
-
-type ProjectsZonesClustersListCall struct {
- s *Service
- projectId string
- zoneId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all clusters owned by a project in the specified zone.
-func (r *ProjectsZonesClustersService) List(projectId string, zoneId string) *ProjectsZonesClustersListCall {
- c := &ProjectsZonesClustersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.zoneId = zoneId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsZonesClustersListCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsZonesClustersListCall) Context(ctx context.Context) *ProjectsZonesClustersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsZonesClustersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{projectId}/zones/{zoneId}/clusters")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "zoneId": c.zoneId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-func (c *ProjectsZonesClustersListCall) Do() (*ListClustersResponse, error) {
- res, err := c.doRequest("json")
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- var ret *ListClustersResponse
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all clusters owned by a project in the specified zone.",
- // "httpMethod": "GET",
- // "id": "container.projects.zones.clusters.list",
- // "parameterOrder": [
- // "projectId",
- // "zoneId"
- // ],
- // "parameters": {
- // "projectId": {
- // "description": "The Google Developers Console project ID or project number.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "zoneId": {
- // "description": "The name of the Google Compute Engine zone in which the cluster resides.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{projectId}/zones/{zoneId}/clusters",
- // "response": {
- // "$ref": "ListClustersResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "container.projects.zones.operations.get":
-
-type ProjectsZonesOperationsGetCall struct {
- s *Service
- projectId string
- zoneId string
- operationId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets the specified operation.
-func (r *ProjectsZonesOperationsService) Get(projectId string, zoneId string, operationId string) *ProjectsZonesOperationsGetCall {
- c := &ProjectsZonesOperationsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.zoneId = zoneId
- c.operationId = operationId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsZonesOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsZonesOperationsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsZonesOperationsGetCall) Context(ctx context.Context) *ProjectsZonesOperationsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsZonesOperationsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{projectId}/zones/{zoneId}/operations/{operationId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "zoneId": c.zoneId,
- "operationId": c.operationId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-func (c *ProjectsZonesOperationsGetCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- var ret *Operation
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the specified operation.",
- // "httpMethod": "GET",
- // "id": "container.projects.zones.operations.get",
- // "parameterOrder": [
- // "projectId",
- // "zoneId",
- // "operationId"
- // ],
- // "parameters": {
- // "operationId": {
- // "description": "The server-assigned name of the operation.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "The Google Developers Console project ID or project number.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "zoneId": {
- // "description": "The name of the Google Compute Engine zone in which the operation resides. This is always the same zone as the cluster with which the operation is associated.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{projectId}/zones/{zoneId}/operations/{operationId}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
-// method id "container.projects.zones.operations.list":
-
-type ProjectsZonesOperationsListCall struct {
- s *Service
- projectId string
- zoneId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all operations in a project in a specific zone.
-func (r *ProjectsZonesOperationsService) List(projectId string, zoneId string) *ProjectsZonesOperationsListCall {
- c := &ProjectsZonesOperationsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.zoneId = zoneId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsZonesOperationsListCall) Fields(s ...googleapi.Field) *ProjectsZonesOperationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsZonesOperationsListCall) Context(ctx context.Context) *ProjectsZonesOperationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsZonesOperationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{projectId}/zones/{zoneId}/operations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "zoneId": c.zoneId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-func (c *ProjectsZonesOperationsListCall) Do() (*ListOperationsResponse, error) {
- res, err := c.doRequest("json")
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- var ret *ListOperationsResponse
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all operations in a project in a specific zone.",
- // "httpMethod": "GET",
- // "id": "container.projects.zones.operations.list",
- // "parameterOrder": [
- // "projectId",
- // "zoneId"
- // ],
- // "parameters": {
- // "projectId": {
- // "description": "The Google Developers Console project ID or project number.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "zoneId": {
- // "description": "The name of the Google Compute Engine zone to return operations for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{projectId}/zones/{zoneId}/operations",
- // "response": {
- // "$ref": "ListOperationsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/content/v2/content-api.json b/vendor/google.golang.org/api/content/v2/content-api.json
deleted file mode 100644
index 04bbac22..00000000
--- a/vendor/google.golang.org/api/content/v2/content-api.json
+++ /dev/null
@@ -1,6047 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/qCLRcKBvpHXy_56JLKWSx1mf1Qs\"",
- "discoveryVersion": "v1",
- "id": "content:v2",
- "name": "content",
- "canonicalName": "Shopping Content",
- "version": "v2",
- "revision": "20150915",
- "title": "Content API for Shopping",
- "description": "Manage product items, inventory, and Merchant Center accounts for Google Shopping.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/shopping-content",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/content/v2/",
- "basePath": "/content/v2/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "content/v2/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/content": {
- "description": "Manage your product listings and accounts for Google Shopping"
- }
- }
- }
- },
- "schemas": {
- "Account": {
- "id": "Account",
- "type": "object",
- "description": "Account data.",
- "properties": {
- "adultContent": {
- "type": "boolean",
- "description": "Indicates whether the merchant sells adult content."
- },
- "adwordsLinks": {
- "type": "array",
- "description": "List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. To delete an active link or to cancel a link request, remove it from the list.",
- "items": {
- "$ref": "AccountAdwordsLink"
- }
- },
- "id": {
- "type": "string",
- "description": "Merchant Center account ID.",
- "format": "uint64",
- "annotations": {
- "required": [
- "content.accounts.update"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#account\".",
- "default": "content#account"
- },
- "name": {
- "type": "string",
- "description": "Display name for the account.",
- "annotations": {
- "required": [
- "content.accounts.insert",
- "content.accounts.update"
- ]
- }
- },
- "reviewsUrl": {
- "type": "string",
- "description": "URL for individual seller reviews, i.e., reviews for each child account."
- },
- "sellerId": {
- "type": "string",
- "description": "Client-specific, locally-unique, internal ID for the child account."
- },
- "users": {
- "type": "array",
- "description": "Users with access to the account. Every account (except for subaccounts) must have at least one admin user.",
- "items": {
- "$ref": "AccountUser"
- }
- },
- "websiteUrl": {
- "type": "string",
- "description": "The merchant's website."
- }
- }
- },
- "AccountAdwordsLink": {
- "id": "AccountAdwordsLink",
- "type": "object",
- "properties": {
- "adwordsId": {
- "type": "string",
- "description": "Customer ID of the AdWords account.",
- "format": "uint64"
- },
- "status": {
- "type": "string",
- "description": "Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending."
- }
- }
- },
- "AccountIdentifier": {
- "id": "AccountIdentifier",
- "type": "object",
- "properties": {
- "aggregatorId": {
- "type": "string",
- "description": "The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount).",
- "format": "uint64"
- },
- "merchantId": {
- "type": "string",
- "description": "The merchant account ID, set for individual accounts and subaccounts.",
- "format": "uint64"
- }
- }
- },
- "AccountShipping": {
- "id": "AccountShipping",
- "type": "object",
- "description": "The shipping settings of a merchant account.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The ID of the account to which these account shipping settings belong.",
- "format": "uint64",
- "annotations": {
- "required": [
- "content.accountshipping.update"
- ]
- }
- },
- "carrierRates": {
- "type": "array",
- "description": "Carrier-based shipping calculations.",
- "items": {
- "$ref": "AccountShippingCarrierRate"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountShipping\".",
- "default": "content#accountShipping"
- },
- "locationGroups": {
- "type": "array",
- "description": "Location groups for shipping.",
- "items": {
- "$ref": "AccountShippingLocationGroup"
- }
- },
- "rateTables": {
- "type": "array",
- "description": "Rate tables definitions.",
- "items": {
- "$ref": "AccountShippingRateTable"
- }
- },
- "services": {
- "type": "array",
- "description": "Shipping services describing shipping fees calculation.",
- "items": {
- "$ref": "AccountShippingShippingService"
- }
- }
- }
- },
- "AccountShippingCarrierRate": {
- "id": "AccountShippingCarrierRate",
- "type": "object",
- "description": "A carrier-calculated shipping rate.",
- "properties": {
- "carrier": {
- "type": "string",
- "description": "The carrier that is responsible for the shipping, such as \"UPS\", \"FedEx\", or \"USPS\".",
- "annotations": {
- "required": [
- "content.accountshipping.update"
- ]
- }
- },
- "carrierService": {
- "type": "string",
- "description": "The carrier service, such as \"Ground\" or \"2Day\".",
- "annotations": {
- "required": [
- "content.accountshipping.update"
- ]
- }
- },
- "modifierFlatRate": {
- "$ref": "Price",
- "description": "Additive shipping rate modifier."
- },
- "modifierPercent": {
- "type": "string",
- "description": "Multiplicative shipping rate modifier in percent. Represented as a floating point number without the percentage character."
- },
- "name": {
- "type": "string",
- "description": "The name of the carrier rate.",
- "annotations": {
- "required": [
- "content.accountshipping.update"
- ]
- }
- },
- "saleCountry": {
- "type": "string",
- "description": "The sale country for which this carrier rate is valid, represented as a CLDR territory code.",
- "annotations": {
- "required": [
- "content.accountshipping.update"
- ]
- }
- },
- "shippingOrigin": {
- "type": "string",
- "description": "Shipping origin represented as a postal code.",
- "annotations": {
- "required": [
- "content.accountshipping.update"
- ]
- }
- }
- }
- },
- "AccountShippingCondition": {
- "id": "AccountShippingCondition",
- "type": "object",
- "properties": {
- "deliveryLocationGroup": {
- "type": "string",
- "description": "Delivery location in terms of a location group name. A location group with this name must be specified among location groups."
- },
- "deliveryLocationId": {
- "type": "string",
- "description": "Delivery location in terms of a location ID. Can be used to represent administrative areas, smaller country subdivisions, or cities.",
- "format": "int64"
- },
- "deliveryPostalCode": {
- "type": "string",
- "description": "Delivery location in terms of a postal code."
- },
- "deliveryPostalCodeRange": {
- "$ref": "AccountShippingPostalCodeRange",
- "description": "Delivery location in terms of a postal code range."
- },
- "priceMax": {
- "$ref": "Price",
- "description": "Maximum shipping price. Forms an interval between the maximum of smaller prices (exclusive) and this price (inclusive)."
- },
- "shippingLabel": {
- "type": "string",
- "description": "Shipping label of the product. The products with the label are matched."
- },
- "weightMax": {
- "$ref": "Weight",
- "description": "Maximum shipping weight. Forms an interval between the maximum of smaller weight (exclusive) and this weight (inclusive)."
- }
- }
- },
- "AccountShippingLocationGroup": {
- "id": "AccountShippingLocationGroup",
- "type": "object",
- "description": "A user-defined locations group in a given country. All the locations of the group must be of the same type.",
- "properties": {
- "country": {
- "type": "string",
- "description": "The CLDR territory code of the country in which this location group is.",
- "annotations": {
- "required": [
- "content.accountshipping.update"
- ]
- }
- },
- "locationIds": {
- "type": "array",
- "description": "A location ID (also called criteria ID) representing administrative areas, smaller country subdivisions (counties), or cities.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "name": {
- "type": "string",
- "description": "The name of the location group.",
- "annotations": {
- "required": [
- "content.accountshipping.update"
- ]
- }
- },
- "postalCodeRanges": {
- "type": "array",
- "description": "A postal code range representing a city or a set of cities.",
- "items": {
- "$ref": "AccountShippingPostalCodeRange"
- }
- },
- "postalCodes": {
- "type": "array",
- "description": "A postal code representing a city or a set of cities. \n- A single postal code (e.g., 12345)\n- A postal code prefix followed by a star (e.g., 1234*)",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "AccountShippingPostalCodeRange": {
- "id": "AccountShippingPostalCodeRange",
- "type": "object",
- "description": "A postal code range, that can be either: \n- A range of postal codes (e.g., start=12340, end=12359)\n- A range of postal codes prefixes (e.g., start=1234* end=1235*). Prefixes must be of the same length (e.g., start=12* end=2* is invalid).",
- "properties": {
- "end": {
- "type": "string",
- "description": "The last (inclusive) postal code or prefix of the range.",
- "annotations": {
- "required": [
- "content.accountshipping.update"
- ]
- }
- },
- "start": {
- "type": "string",
- "description": "The first (inclusive) postal code or prefix of the range.",
- "annotations": {
- "required": [
- "content.accountshipping.update"
- ]
- }
- }
- }
- },
- "AccountShippingRateTable": {
- "id": "AccountShippingRateTable",
- "type": "object",
- "description": "A single or bi-dimensional table of shipping rates. Each dimension is defined in terms of consecutive price/weight ranges, delivery locations, or shipping labels.",
- "properties": {
- "content": {
- "type": "array",
- "description": "One-dimensional table cells define one condition along the same dimension. Bi-dimensional table cells use two dimensions with respectively M and N distinct values and must contain exactly M * N cells with distinct conditions (for each possible value pairs).",
- "items": {
- "$ref": "AccountShippingRateTableCell"
- }
- },
- "name": {
- "type": "string",
- "description": "The name of the rate table.",
- "annotations": {
- "required": [
- "content.accountshipping.update"
- ]
- }
- },
- "saleCountry": {
- "type": "string",
- "description": "The sale country for which this table is valid, represented as a CLDR territory code.",
- "annotations": {
- "required": [
- "content.accountshipping.update"
- ]
- }
- }
- }
- },
- "AccountShippingRateTableCell": {
- "id": "AccountShippingRateTableCell",
- "type": "object",
- "properties": {
- "condition": {
- "$ref": "AccountShippingCondition",
- "description": "Conditions for which the cell is valid. All cells in a table must use the same dimension or pair of dimensions among price, weight, shipping label or delivery location. If no condition is specified, the cell acts as a catch-all and matches all the elements that are not matched by other cells in this dimension."
- },
- "rate": {
- "$ref": "Price",
- "description": "The rate applicable if the cell conditions are matched.",
- "annotations": {
- "required": [
- "content.accountshipping.update"
- ]
- }
- }
- }
- },
- "AccountShippingShippingService": {
- "id": "AccountShippingShippingService",
- "type": "object",
- "description": "Shipping services provided in a country.",
- "properties": {
- "active": {
- "type": "boolean",
- "description": "Whether the shipping service is available."
- },
- "calculationMethod": {
- "$ref": "AccountShippingShippingServiceCalculationMethod",
- "description": "Calculation method for the \"simple\" case that needs no rules."
- },
- "costRuleTree": {
- "$ref": "AccountShippingShippingServiceCostRule",
- "description": "Decision tree for \"complicated\" shipping cost calculation."
- },
- "name": {
- "type": "string",
- "description": "The name of this shipping service.",
- "annotations": {
- "required": [
- "content.accountshipping.update"
- ]
- }
- },
- "saleCountry": {
- "type": "string",
- "description": "The CLDR territory code of the sale country for which this service can be used.",
- "annotations": {
- "required": [
- "content.accountshipping.update"
- ]
- }
- }
- }
- },
- "AccountShippingShippingServiceCalculationMethod": {
- "id": "AccountShippingShippingServiceCalculationMethod",
- "type": "object",
- "description": "Shipping cost calculation method. Exactly one of the field is set.",
- "properties": {
- "carrierRate": {
- "type": "string",
- "description": "Name of the carrier rate to use for the calculation."
- },
- "excluded": {
- "type": "boolean",
- "description": "Delivery is excluded. Valid only within cost rules tree."
- },
- "flatRate": {
- "$ref": "Price",
- "description": "Fixed price shipping, represented as a floating point number associated with a currency."
- },
- "percentageRate": {
- "type": "string",
- "description": "Percentage of the price, represented as a floating point number without the percentage character."
- },
- "rateTable": {
- "type": "string",
- "description": "Name of the rate table to use for the calculation."
- }
- }
- },
- "AccountShippingShippingServiceCostRule": {
- "id": "AccountShippingShippingServiceCostRule",
- "type": "object",
- "description": "Building block of the cost calculation decision tree. \n- The tree root should have no condition and no calculation method.\n- All the children must have a condition on the same dimension. The first child matching a condition is entered, therefore, price and weight conditions form contiguous intervals.\n- The last child of an element must have no condition and matches all elements not previously matched.\n- Children and calculation method are mutually exclusive, and exactly one of them must be defined; the root must only have children.",
- "properties": {
- "calculationMethod": {
- "$ref": "AccountShippingShippingServiceCalculationMethod",
- "description": "Final calculation method to be used only in leaf nodes."
- },
- "children": {
- "type": "array",
- "description": "Subsequent rules to be applied, only for inner nodes. The last child must not specify a condition and acts as a catch-all.",
- "items": {
- "$ref": "AccountShippingShippingServiceCostRule"
- }
- },
- "condition": {
- "$ref": "AccountShippingCondition",
- "description": "Condition for this rule to be applicable. If no condition is specified, the rule acts as a catch-all."
- }
- }
- },
- "AccountStatus": {
- "id": "AccountStatus",
- "type": "object",
- "description": "The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The ID of the account for which the status is reported."
- },
- "dataQualityIssues": {
- "type": "array",
- "description": "A list of data quality issues.",
- "items": {
- "$ref": "AccountStatusDataQualityIssue"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountStatus\".",
- "default": "content#accountStatus"
- }
- }
- },
- "AccountStatusDataQualityIssue": {
- "id": "AccountStatusDataQualityIssue",
- "type": "object",
- "properties": {
- "country": {
- "type": "string",
- "description": "Country for which this issue is reported."
- },
- "displayedValue": {
- "type": "string",
- "description": "Actual value displayed on the landing page."
- },
- "exampleItems": {
- "type": "array",
- "description": "Example items featuring the issue.",
- "items": {
- "$ref": "AccountStatusExampleItem"
- }
- },
- "id": {
- "type": "string",
- "description": "Issue identifier."
- },
- "lastChecked": {
- "type": "string",
- "description": "Last time the account was checked for this issue."
- },
- "numItems": {
- "type": "integer",
- "description": "Number of items in the account found to have the said issue.",
- "format": "uint32"
- },
- "severity": {
- "type": "string",
- "description": "Severity of the problem."
- },
- "submittedValue": {
- "type": "string",
- "description": "Submitted value that causes the issue."
- }
- }
- },
- "AccountStatusExampleItem": {
- "id": "AccountStatusExampleItem",
- "type": "object",
- "description": "An example of an item that has poor data quality. An item value on the landing page differs from what is submitted, or conflicts with a policy.",
- "properties": {
- "itemId": {
- "type": "string",
- "description": "Unique item ID as specified in the uploaded product data."
- },
- "link": {
- "type": "string",
- "description": "Landing page of the item."
- },
- "submittedValue": {
- "type": "string",
- "description": "The item value that was submitted."
- },
- "title": {
- "type": "string",
- "description": "Title of the item."
- },
- "valueOnLandingPage": {
- "type": "string",
- "description": "The actual value on the landing page."
- }
- }
- },
- "AccountTax": {
- "id": "AccountTax",
- "type": "object",
- "description": "The tax settings of a merchant account.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The ID of the account to which these account tax settings belong.",
- "format": "uint64",
- "annotations": {
- "required": [
- "content.accounttax.update"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountTax\".",
- "default": "content#accountTax"
- },
- "rules": {
- "type": "array",
- "description": "Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.",
- "items": {
- "$ref": "AccountTaxTaxRule"
- }
- }
- }
- },
- "AccountTaxTaxRule": {
- "id": "AccountTaxTaxRule",
- "type": "object",
- "description": "Tax calculation rule to apply in a state or province (USA only).",
- "properties": {
- "country": {
- "type": "string",
- "description": "Country code in which tax is applicable."
- },
- "locationId": {
- "type": "string",
- "description": "State (or province) is which the tax is applicable, described by its location id (also called criteria id).",
- "format": "uint64",
- "annotations": {
- "required": [
- "content.accounttax.update"
- ]
- }
- },
- "ratePercent": {
- "type": "string",
- "description": "Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative."
- },
- "shippingTaxed": {
- "type": "boolean",
- "description": "If true, shipping charges are also taxed."
- },
- "useGlobalRate": {
- "type": "boolean",
- "description": "Whether the tax rate is taken from a global tax table or specified explicitly."
- }
- }
- },
- "AccountUser": {
- "id": "AccountUser",
- "type": "object",
- "properties": {
- "admin": {
- "type": "boolean",
- "description": "Whether user is an admin."
- },
- "emailAddress": {
- "type": "string",
- "description": "User's email address."
- }
- }
- },
- "AccountsAuthInfoResponse": {
- "id": "AccountsAuthInfoResponse",
- "type": "object",
- "properties": {
- "accountIdentifiers": {
- "type": "array",
- "description": "The account identifiers corresponding to the authenticated user.\n- For an individual account: only the merchant ID is defined\n- For an aggregator: only the aggregator ID is defined\n- For a subaccount of an MCA: both the merchant ID and the aggregator ID are defined.",
- "items": {
- "$ref": "AccountIdentifier"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsAuthInfoResponse\".",
- "default": "content#accountsAuthInfoResponse"
- }
- }
- },
- "AccountsCustomBatchRequest": {
- "id": "AccountsCustomBatchRequest",
- "type": "object",
- "properties": {
- "entries": {
- "type": "array",
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "AccountsCustomBatchRequestEntry"
- }
- }
- }
- },
- "AccountsCustomBatchRequestEntry": {
- "id": "AccountsCustomBatchRequestEntry",
- "type": "object",
- "description": "A batch entry encoding a single non-batch accounts request.",
- "properties": {
- "account": {
- "$ref": "Account",
- "description": "The account to create or update. Only defined if the method is insert or update."
- },
- "accountId": {
- "type": "string",
- "description": "The ID of the account to get or delete. Only defined if the method is get or delete.",
- "format": "uint64"
- },
- "batchId": {
- "type": "integer",
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "format": "uint64"
- },
- "method": {
- "type": "string"
- }
- }
- },
- "AccountsCustomBatchResponse": {
- "id": "AccountsCustomBatchResponse",
- "type": "object",
- "properties": {
- "entries": {
- "type": "array",
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "AccountsCustomBatchResponseEntry"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsCustomBatchResponse\".",
- "default": "content#accountsCustomBatchResponse"
- }
- }
- },
- "AccountsCustomBatchResponseEntry": {
- "id": "AccountsCustomBatchResponseEntry",
- "type": "object",
- "description": "A batch entry encoding a single non-batch accounts response.",
- "properties": {
- "account": {
- "$ref": "Account",
- "description": "The retrieved, created, or updated account. Not defined if the method was delete."
- },
- "batchId": {
- "type": "integer",
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors defined if and only if the request failed."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsCustomBatchResponseEntry\".",
- "default": "content#accountsCustomBatchResponseEntry"
- }
- }
- },
- "AccountsListResponse": {
- "id": "AccountsListResponse",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsListResponse\".",
- "default": "content#accountsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "The token for the retrieval of the next page of accounts."
- },
- "resources": {
- "type": "array",
- "items": {
- "$ref": "Account"
- }
- }
- }
- },
- "AccountshippingCustomBatchRequest": {
- "id": "AccountshippingCustomBatchRequest",
- "type": "object",
- "properties": {
- "entries": {
- "type": "array",
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "AccountshippingCustomBatchRequestEntry"
- }
- }
- }
- },
- "AccountshippingCustomBatchRequestEntry": {
- "id": "AccountshippingCustomBatchRequestEntry",
- "type": "object",
- "description": "A batch entry encoding a single non-batch accountshipping request.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The ID of the account for which to get/update account shipping settings.",
- "format": "uint64"
- },
- "accountShipping": {
- "$ref": "AccountShipping",
- "description": "The account shipping settings to update. Only defined if the method is update."
- },
- "batchId": {
- "type": "integer",
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "format": "uint64"
- },
- "method": {
- "type": "string"
- }
- }
- },
- "AccountshippingCustomBatchResponse": {
- "id": "AccountshippingCustomBatchResponse",
- "type": "object",
- "properties": {
- "entries": {
- "type": "array",
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "AccountshippingCustomBatchResponseEntry"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountshippingCustomBatchResponse\".",
- "default": "content#accountshippingCustomBatchResponse"
- }
- }
- },
- "AccountshippingCustomBatchResponseEntry": {
- "id": "AccountshippingCustomBatchResponseEntry",
- "type": "object",
- "description": "A batch entry encoding a single non-batch accountshipping response.",
- "properties": {
- "accountShipping": {
- "$ref": "AccountShipping",
- "description": "The retrieved or updated account shipping settings."
- },
- "batchId": {
- "type": "integer",
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors defined if and only if the request failed."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountshippingCustomBatchResponseEntry\".",
- "default": "content#accountshippingCustomBatchResponseEntry"
- }
- }
- },
- "AccountshippingListResponse": {
- "id": "AccountshippingListResponse",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountshippingListResponse\".",
- "default": "content#accountshippingListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "The token for the retrieval of the next page of account shipping settings."
- },
- "resources": {
- "type": "array",
- "items": {
- "$ref": "AccountShipping"
- }
- }
- }
- },
- "AccountstatusesCustomBatchRequest": {
- "id": "AccountstatusesCustomBatchRequest",
- "type": "object",
- "properties": {
- "entries": {
- "type": "array",
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "AccountstatusesCustomBatchRequestEntry"
- }
- }
- }
- },
- "AccountstatusesCustomBatchRequestEntry": {
- "id": "AccountstatusesCustomBatchRequestEntry",
- "type": "object",
- "description": "A batch entry encoding a single non-batch accountstatuses request.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The ID of the (sub-)account whose status to get.",
- "format": "uint64"
- },
- "batchId": {
- "type": "integer",
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "format": "uint64"
- },
- "method": {
- "type": "string",
- "description": "The method (get)."
- }
- }
- },
- "AccountstatusesCustomBatchResponse": {
- "id": "AccountstatusesCustomBatchResponse",
- "type": "object",
- "properties": {
- "entries": {
- "type": "array",
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "AccountstatusesCustomBatchResponseEntry"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountstatusesCustomBatchResponse\".",
- "default": "content#accountstatusesCustomBatchResponse"
- }
- }
- },
- "AccountstatusesCustomBatchResponseEntry": {
- "id": "AccountstatusesCustomBatchResponseEntry",
- "type": "object",
- "description": "A batch entry encoding a single non-batch accountstatuses response.",
- "properties": {
- "accountStatus": {
- "$ref": "AccountStatus",
- "description": "The requested account status. Defined if and only if the request was successful."
- },
- "batchId": {
- "type": "integer",
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors defined if and only if the request failed."
- }
- }
- },
- "AccountstatusesListResponse": {
- "id": "AccountstatusesListResponse",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountstatusesListResponse\".",
- "default": "content#accountstatusesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "The token for the retrieval of the next page of account statuses."
- },
- "resources": {
- "type": "array",
- "items": {
- "$ref": "AccountStatus"
- }
- }
- }
- },
- "AccounttaxCustomBatchRequest": {
- "id": "AccounttaxCustomBatchRequest",
- "type": "object",
- "properties": {
- "entries": {
- "type": "array",
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "AccounttaxCustomBatchRequestEntry"
- }
- }
- }
- },
- "AccounttaxCustomBatchRequestEntry": {
- "id": "AccounttaxCustomBatchRequestEntry",
- "type": "object",
- "description": "A batch entry encoding a single non-batch accounttax request.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The ID of the account for which to get/update account tax settings.",
- "format": "uint64"
- },
- "accountTax": {
- "$ref": "AccountTax",
- "description": "The account tax settings to update. Only defined if the method is update."
- },
- "batchId": {
- "type": "integer",
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "format": "uint64"
- },
- "method": {
- "type": "string"
- }
- }
- },
- "AccounttaxCustomBatchResponse": {
- "id": "AccounttaxCustomBatchResponse",
- "type": "object",
- "properties": {
- "entries": {
- "type": "array",
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "AccounttaxCustomBatchResponseEntry"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accounttaxCustomBatchResponse\".",
- "default": "content#accounttaxCustomBatchResponse"
- }
- }
- },
- "AccounttaxCustomBatchResponseEntry": {
- "id": "AccounttaxCustomBatchResponseEntry",
- "type": "object",
- "description": "A batch entry encoding a single non-batch accounttax response.",
- "properties": {
- "accountTax": {
- "$ref": "AccountTax",
- "description": "The retrieved or updated account tax settings."
- },
- "batchId": {
- "type": "integer",
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors defined if and only if the request failed."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accounttaxCustomBatchResponseEntry\".",
- "default": "content#accounttaxCustomBatchResponseEntry"
- }
- }
- },
- "AccounttaxListResponse": {
- "id": "AccounttaxListResponse",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accounttaxListResponse\".",
- "default": "content#accounttaxListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "The token for the retrieval of the next page of account tax settings."
- },
- "resources": {
- "type": "array",
- "items": {
- "$ref": "AccountTax"
- }
- }
- }
- },
- "Datafeed": {
- "id": "Datafeed",
- "type": "object",
- "description": "Datafeed data.",
- "properties": {
- "attributeLanguage": {
- "type": "string",
- "description": "The two-letter ISO 639-1 language in which the attributes are defined in the data feed."
- },
- "contentLanguage": {
- "type": "string",
- "description": "The two-letter ISO 639-1 language of the items in the feed.",
- "annotations": {
- "required": [
- "content.datafeeds.insert"
- ]
- }
- },
- "contentType": {
- "type": "string",
- "description": "The type of data feed.",
- "annotations": {
- "required": [
- "content.datafeeds.insert",
- "content.datafeeds.update"
- ]
- }
- },
- "fetchSchedule": {
- "$ref": "DatafeedFetchSchedule",
- "description": "Fetch schedule for the feed file."
- },
- "fileName": {
- "type": "string",
- "description": "The filename of the feed. All feeds must have a unique file name.",
- "annotations": {
- "required": [
- "content.datafeeds.insert",
- "content.datafeeds.update"
- ]
- }
- },
- "format": {
- "$ref": "DatafeedFormat",
- "description": "Format of the feed file."
- },
- "id": {
- "type": "string",
- "description": "The ID of the data feed.",
- "format": "int64",
- "annotations": {
- "required": [
- "content.datafeeds.update"
- ]
- }
- },
- "intendedDestinations": {
- "type": "array",
- "description": "The list of intended destinations (corresponds to checked check boxes in Merchant Center).",
- "items": {
- "type": "string"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeed\".",
- "default": "content#datafeed"
- },
- "name": {
- "type": "string",
- "description": "A descriptive name of the data feed.",
- "annotations": {
- "required": [
- "content.datafeeds.insert"
- ]
- }
- },
- "targetCountry": {
- "type": "string",
- "description": "The country where the items in the feed will be included in the search index, represented as a CLDR territory code.",
- "annotations": {
- "required": [
- "content.datafeeds.insert",
- "content.datafeeds.update"
- ]
- }
- }
- }
- },
- "DatafeedFetchSchedule": {
- "id": "DatafeedFetchSchedule",
- "type": "object",
- "description": "The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required.",
- "properties": {
- "dayOfMonth": {
- "type": "integer",
- "description": "The day of the month the feed file should be fetched (1-31).",
- "format": "uint32"
- },
- "fetchUrl": {
- "type": "string",
- "description": "The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols."
- },
- "hour": {
- "type": "integer",
- "description": "The hour of the day the feed file should be fetched (0-24).",
- "format": "uint32"
- },
- "password": {
- "type": "string",
- "description": "An optional password for fetch_url."
- },
- "timeZone": {
- "type": "string",
- "description": "Time zone used for schedule. UTC by default. E.g., \"America/Los_Angeles\"."
- },
- "username": {
- "type": "string",
- "description": "An optional user name for fetch_url."
- },
- "weekday": {
- "type": "string",
- "description": "The day of the week the feed file should be fetched."
- }
- }
- },
- "DatafeedFormat": {
- "id": "DatafeedFormat",
- "type": "object",
- "properties": {
- "columnDelimiter": {
- "type": "string",
- "description": "Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds."
- },
- "fileEncoding": {
- "type": "string",
- "description": "Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected."
- },
- "quotingMode": {
- "type": "string",
- "description": "Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds."
- }
- }
- },
- "DatafeedStatus": {
- "id": "DatafeedStatus",
- "type": "object",
- "description": "The status of a datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished.",
- "properties": {
- "datafeedId": {
- "type": "string",
- "description": "The ID of the feed for which the status is reported.",
- "format": "uint64"
- },
- "errors": {
- "type": "array",
- "description": "The list of errors occurring in the feed.",
- "items": {
- "$ref": "DatafeedStatusError"
- }
- },
- "itemsTotal": {
- "type": "string",
- "description": "The number of items in the feed that were processed.",
- "format": "uint64"
- },
- "itemsValid": {
- "type": "string",
- "description": "The number of items in the feed that were valid.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedStatus\".",
- "default": "content#datafeedStatus"
- },
- "lastUploadDate": {
- "type": "string",
- "description": "The last date at which the feed was uploaded."
- },
- "processingStatus": {
- "type": "string",
- "description": "The processing status of the feed."
- },
- "warnings": {
- "type": "array",
- "description": "The list of errors occurring in the feed.",
- "items": {
- "$ref": "DatafeedStatusError"
- }
- }
- }
- },
- "DatafeedStatusError": {
- "id": "DatafeedStatusError",
- "type": "object",
- "description": "An error occurring in the feed, like \"invalid price\".",
- "properties": {
- "code": {
- "type": "string",
- "description": "The code of the error, e.g., \"validation/invalid_value\"."
- },
- "count": {
- "type": "string",
- "description": "The number of occurrences of the error in the feed.",
- "format": "uint64"
- },
- "examples": {
- "type": "array",
- "description": "A list of example occurrences of the error, grouped by product.",
- "items": {
- "$ref": "DatafeedStatusExample"
- }
- },
- "message": {
- "type": "string",
- "description": "The error message, e.g., \"Invalid price\"."
- }
- }
- },
- "DatafeedStatusExample": {
- "id": "DatafeedStatusExample",
- "type": "object",
- "description": "An example occurrence for a particular error.",
- "properties": {
- "itemId": {
- "type": "string",
- "description": "The ID of the example item."
- },
- "lineNumber": {
- "type": "string",
- "description": "Line number in the data feed where the example is found.",
- "format": "uint64"
- },
- "value": {
- "type": "string",
- "description": "The problematic value."
- }
- }
- },
- "DatafeedsCustomBatchRequest": {
- "id": "DatafeedsCustomBatchRequest",
- "type": "object",
- "properties": {
- "entries": {
- "type": "array",
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "DatafeedsCustomBatchRequestEntry"
- }
- }
- }
- },
- "DatafeedsCustomBatchRequestEntry": {
- "id": "DatafeedsCustomBatchRequestEntry",
- "type": "object",
- "description": "A batch entry encoding a single non-batch datafeeds request.",
- "properties": {
- "batchId": {
- "type": "integer",
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32"
- },
- "datafeed": {
- "$ref": "Datafeed",
- "description": "The data feed to insert."
- },
- "datafeedId": {
- "type": "string",
- "description": "The ID of the data feed to get or delete.",
- "format": "uint64"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "format": "uint64"
- },
- "method": {
- "type": "string"
- }
- }
- },
- "DatafeedsCustomBatchResponse": {
- "id": "DatafeedsCustomBatchResponse",
- "type": "object",
- "properties": {
- "entries": {
- "type": "array",
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "DatafeedsCustomBatchResponseEntry"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedsCustomBatchResponse\".",
- "default": "content#datafeedsCustomBatchResponse"
- }
- }
- },
- "DatafeedsCustomBatchResponseEntry": {
- "id": "DatafeedsCustomBatchResponseEntry",
- "type": "object",
- "description": "A batch entry encoding a single non-batch datafeeds response.",
- "properties": {
- "batchId": {
- "type": "integer",
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32"
- },
- "datafeed": {
- "$ref": "Datafeed",
- "description": "The requested data feed. Defined if and only if the request was successful."
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors defined if and only if the request failed."
- }
- }
- },
- "DatafeedsListResponse": {
- "id": "DatafeedsListResponse",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedsListResponse\".",
- "default": "content#datafeedsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "The token for the retrieval of the next page of datafeeds."
- },
- "resources": {
- "type": "array",
- "items": {
- "$ref": "Datafeed"
- }
- }
- }
- },
- "DatafeedstatusesCustomBatchRequest": {
- "id": "DatafeedstatusesCustomBatchRequest",
- "type": "object",
- "properties": {
- "entries": {
- "type": "array",
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "DatafeedstatusesCustomBatchRequestEntry"
- }
- }
- }
- },
- "DatafeedstatusesCustomBatchRequestEntry": {
- "id": "DatafeedstatusesCustomBatchRequestEntry",
- "type": "object",
- "description": "A batch entry encoding a single non-batch datafeedstatuses request.",
- "properties": {
- "batchId": {
- "type": "integer",
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32"
- },
- "datafeedId": {
- "type": "string",
- "description": "The ID of the data feed to get or delete.",
- "format": "uint64"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "format": "uint64"
- },
- "method": {
- "type": "string"
- }
- }
- },
- "DatafeedstatusesCustomBatchResponse": {
- "id": "DatafeedstatusesCustomBatchResponse",
- "type": "object",
- "properties": {
- "entries": {
- "type": "array",
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "DatafeedstatusesCustomBatchResponseEntry"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedstatusesCustomBatchResponse\".",
- "default": "content#datafeedstatusesCustomBatchResponse"
- }
- }
- },
- "DatafeedstatusesCustomBatchResponseEntry": {
- "id": "DatafeedstatusesCustomBatchResponseEntry",
- "type": "object",
- "description": "A batch entry encoding a single non-batch datafeedstatuses response.",
- "properties": {
- "batchId": {
- "type": "integer",
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32"
- },
- "datafeedStatus": {
- "$ref": "DatafeedStatus",
- "description": "The requested data feed status. Defined if and only if the request was successful."
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors defined if and only if the request failed."
- }
- }
- },
- "DatafeedstatusesListResponse": {
- "id": "DatafeedstatusesListResponse",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedstatusesListResponse\".",
- "default": "content#datafeedstatusesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "The token for the retrieval of the next page of datafeed statuses."
- },
- "resources": {
- "type": "array",
- "items": {
- "$ref": "DatafeedStatus"
- }
- }
- }
- },
- "Error": {
- "id": "Error",
- "type": "object",
- "description": "An error returned by the API.",
- "properties": {
- "domain": {
- "type": "string",
- "description": "The domain of the error."
- },
- "message": {
- "type": "string",
- "description": "A description of the error."
- },
- "reason": {
- "type": "string",
- "description": "The error code."
- }
- }
- },
- "Errors": {
- "id": "Errors",
- "type": "object",
- "description": "A list of errors returned by a failed batch entry.",
- "properties": {
- "code": {
- "type": "integer",
- "description": "The HTTP status of the first error in errors.",
- "format": "uint32"
- },
- "errors": {
- "type": "array",
- "description": "A list of errors.",
- "items": {
- "$ref": "Error"
- }
- },
- "message": {
- "type": "string",
- "description": "The message of the first error in errors."
- }
- }
- },
- "Inventory": {
- "id": "Inventory",
- "type": "object",
- "properties": {
- "availability": {
- "type": "string",
- "description": "The availability of the product."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#inventory\".",
- "default": "content#inventory"
- },
- "price": {
- "$ref": "Price",
- "description": "The price of the product."
- },
- "quantity": {
- "type": "integer",
- "description": "The quantity of the product. Must be equal to or greater than zero. Supported only for local products.",
- "format": "uint32"
- },
- "salePrice": {
- "$ref": "Price",
- "description": "The sale price of the product. Mandatory if sale_price_effective_date is defined."
- },
- "salePriceEffectiveDate": {
- "type": "string",
- "description": "A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided."
- },
- "sellOnGoogleQuantity": {
- "type": "integer",
- "description": "The quantity of the product that is reserved for sell-on-google ads. Supported only for online products.",
- "format": "uint32"
- }
- }
- },
- "InventoryCustomBatchRequest": {
- "id": "InventoryCustomBatchRequest",
- "type": "object",
- "properties": {
- "entries": {
- "type": "array",
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "InventoryCustomBatchRequestEntry"
- }
- }
- }
- },
- "InventoryCustomBatchRequestEntry": {
- "id": "InventoryCustomBatchRequestEntry",
- "type": "object",
- "description": "A batch entry encoding a single non-batch inventory request.",
- "properties": {
- "batchId": {
- "type": "integer",
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32"
- },
- "inventory": {
- "$ref": "Inventory",
- "description": "Price and availability of the product."
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "format": "uint64"
- },
- "productId": {
- "type": "string",
- "description": "The ID of the product for which to update price and availability."
- },
- "storeCode": {
- "type": "string",
- "description": "The code of the store for which to update price and availability. Use online to update price and availability of an online product."
- }
- }
- },
- "InventoryCustomBatchResponse": {
- "id": "InventoryCustomBatchResponse",
- "type": "object",
- "properties": {
- "entries": {
- "type": "array",
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "InventoryCustomBatchResponseEntry"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#inventoryCustomBatchResponse\".",
- "default": "content#inventoryCustomBatchResponse"
- }
- }
- },
- "InventoryCustomBatchResponseEntry": {
- "id": "InventoryCustomBatchResponseEntry",
- "type": "object",
- "description": "A batch entry encoding a single non-batch inventory response.",
- "properties": {
- "batchId": {
- "type": "integer",
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors defined if and only if the request failed."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#inventoryCustomBatchResponseEntry\".",
- "default": "content#inventoryCustomBatchResponseEntry"
- }
- }
- },
- "InventorySetRequest": {
- "id": "InventorySetRequest",
- "type": "object",
- "properties": {
- "availability": {
- "type": "string",
- "description": "The availability of the product."
- },
- "price": {
- "$ref": "Price",
- "description": "The price of the product."
- },
- "quantity": {
- "type": "integer",
- "description": "The quantity of the product. Must be equal to or greater than zero. Supported only for local products.",
- "format": "uint32"
- },
- "salePrice": {
- "$ref": "Price",
- "description": "The sale price of the product. Mandatory if sale_price_effective_date is defined."
- },
- "salePriceEffectiveDate": {
- "type": "string",
- "description": "A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided."
- },
- "sellOnGoogleQuantity": {
- "type": "integer",
- "description": "The quantity of the product that is reserved for sell-on-google ads. Supported only for online products.",
- "format": "uint32"
- }
- }
- },
- "InventorySetResponse": {
- "id": "InventorySetResponse",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#inventorySetResponse\".",
- "default": "content#inventorySetResponse"
- }
- }
- },
- "LoyaltyPoints": {
- "id": "LoyaltyPoints",
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters."
- },
- "pointsValue": {
- "type": "string",
- "description": "The retailer's loyalty points in absolute value.",
- "format": "int64"
- },
- "ratio": {
- "type": "number",
- "description": "The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0.",
- "format": "double"
- }
- }
- },
- "Order": {
- "id": "Order",
- "type": "object",
- "properties": {
- "acknowledged": {
- "type": "boolean",
- "description": "Whether the order was acknowledged."
- },
- "customer": {
- "$ref": "OrderCustomer",
- "description": "The details of the customer who placed the order."
- },
- "deliveryDetails": {
- "$ref": "OrderDeliveryDetails",
- "description": "The details for the delivery."
- },
- "id": {
- "type": "string",
- "description": "The REST id of the order. Globally unique."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#order\".",
- "default": "content#order"
- },
- "lineItems": {
- "type": "array",
- "description": "Line items that are ordered.",
- "items": {
- "$ref": "OrderLineItem"
- }
- },
- "merchantId": {
- "type": "string",
- "format": "uint64"
- },
- "merchantOrderId": {
- "type": "string",
- "description": "Merchant-provided id of the order."
- },
- "netAmount": {
- "$ref": "Price",
- "description": "The net amount for the order. For example, if an order was originally for a grand total of $100 and a refund was issued for $20, the net amount will be $80."
- },
- "paymentMethod": {
- "$ref": "OrderPaymentMethod",
- "description": "The details of the payment method."
- },
- "paymentStatus": {
- "type": "string",
- "description": "The status of the payment."
- },
- "placedDate": {
- "type": "string",
- "description": "The date when the order was placed, in ISO 8601 format."
- },
- "refunds": {
- "type": "array",
- "description": "Refunds for the order.",
- "items": {
- "$ref": "OrderRefund"
- }
- },
- "shipments": {
- "type": "array",
- "description": "Shipments of the order.",
- "items": {
- "$ref": "OrderShipment"
- }
- },
- "shippingCost": {
- "$ref": "Price",
- "description": "The total cost of shipping for all items."
- },
- "shippingCostTax": {
- "$ref": "Price",
- "description": "The tax for the total shipping cost."
- },
- "shippingOption": {
- "type": "string",
- "description": "The requested shipping option."
- },
- "status": {
- "type": "string",
- "description": "The status of the order."
- }
- }
- },
- "OrderAddress": {
- "id": "OrderAddress",
- "type": "object",
- "properties": {
- "country": {
- "type": "string",
- "description": "CLDR country code (e.g. \"US\")."
- },
- "fullAddress": {
- "type": "array",
- "description": "Strings representing the lines of the printed label for mailing the order, for example:\nJohn Smith\n1600 Amphitheatre Parkway\nMountain View, CA, 94043\nUnited States",
- "items": {
- "type": "string"
- }
- },
- "isPostOfficeBox": {
- "type": "boolean",
- "description": "Whether the address is a post office box."
- },
- "locality": {
- "type": "string",
- "description": "City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs)."
- },
- "postalCode": {
- "type": "string",
- "description": "Postal Code or ZIP (e.g. \"94043\")."
- },
- "recipientName": {
- "type": "string",
- "description": "Name of the recipient."
- },
- "region": {
- "type": "string",
- "description": "Top-level administrative subdivision of the country (e.g. \"CA\")."
- },
- "streetAddress": {
- "type": "array",
- "description": "Street-level part of the address.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "OrderCancellation": {
- "id": "OrderCancellation",
- "type": "object",
- "properties": {
- "actor": {
- "type": "string",
- "description": "The actor that created the cancellation."
- },
- "creationDate": {
- "type": "string",
- "description": "Date on which the cancellation has been created, in ISO 8601 format."
- },
- "quantity": {
- "type": "integer",
- "description": "The quantity that was canceled.",
- "format": "uint32"
- },
- "reason": {
- "type": "string",
- "description": "The reason for the cancellation."
- },
- "reasonText": {
- "type": "string",
- "description": "The explanation of the reason."
- }
- }
- },
- "OrderCustomer": {
- "id": "OrderCustomer",
- "type": "object",
- "properties": {
- "email": {
- "type": "string",
- "description": "Email address of the customer."
- },
- "explicitMarketingPreference": {
- "type": "boolean",
- "description": "If set, this indicates the user had a choice to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the Purchases on Google checkout flow."
- },
- "fullName": {
- "type": "string",
- "description": "Full name of the customer."
- }
- }
- },
- "OrderDeliveryDetails": {
- "id": "OrderDeliveryDetails",
- "type": "object",
- "properties": {
- "address": {
- "$ref": "OrderAddress",
- "description": "The delivery address"
- },
- "phoneNumber": {
- "type": "string",
- "description": "The phone number of the person receiving the delivery."
- }
- }
- },
- "OrderLineItem": {
- "id": "OrderLineItem",
- "type": "object",
- "properties": {
- "cancellations": {
- "type": "array",
- "description": "Cancellations of the line item.",
- "items": {
- "$ref": "OrderCancellation"
- }
- },
- "id": {
- "type": "string",
- "description": "The id of the line item."
- },
- "price": {
- "$ref": "Price",
- "description": "Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20."
- },
- "product": {
- "$ref": "OrderLineItemProduct",
- "description": "Product data from the time of the order placement."
- },
- "quantityCanceled": {
- "type": "integer",
- "description": "Number of items canceled.",
- "format": "uint32"
- },
- "quantityDelivered": {
- "type": "integer",
- "description": "Number of items delivered.",
- "format": "uint32"
- },
- "quantityOrdered": {
- "type": "integer",
- "description": "Number of items ordered.",
- "format": "uint32"
- },
- "quantityPending": {
- "type": "integer",
- "description": "Number of items pending.",
- "format": "uint32"
- },
- "quantityReturned": {
- "type": "integer",
- "description": "Number of items returned.",
- "format": "uint32"
- },
- "quantityShipped": {
- "type": "integer",
- "description": "Number of items shipped.",
- "format": "uint32"
- },
- "returnInfo": {
- "$ref": "OrderLineItemReturnInfo",
- "description": "Details of the return policy for the line item."
- },
- "returns": {
- "type": "array",
- "description": "Returns of the line item.",
- "items": {
- "$ref": "OrderReturn"
- }
- },
- "shippingDetails": {
- "$ref": "OrderLineItemShippingDetails",
- "description": "Details of the requested shipping for the line item."
- },
- "tax": {
- "$ref": "Price",
- "description": "Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4."
- }
- }
- },
- "OrderLineItemProduct": {
- "id": "OrderLineItemProduct",
- "type": "object",
- "properties": {
- "brand": {
- "type": "string",
- "description": "Brand of the item."
- },
- "channel": {
- "type": "string",
- "description": "The item's channel (online or local)."
- },
- "condition": {
- "type": "string",
- "description": "Condition or state of the item."
- },
- "contentLanguage": {
- "type": "string",
- "description": "The two-letter ISO 639-1 language code for the item."
- },
- "gtin": {
- "type": "string",
- "description": "Global Trade Item Number (GTIN) of the item."
- },
- "id": {
- "type": "string",
- "description": "The REST id of the product."
- },
- "imageLink": {
- "type": "string",
- "description": "URL of an image of the item."
- },
- "itemGroupId": {
- "type": "string",
- "description": "Shared identifier for all variants of the same product."
- },
- "mpn": {
- "type": "string",
- "description": "Manufacturer Part Number (MPN) of the item."
- },
- "offerId": {
- "type": "string",
- "description": "An identifier of the item."
- },
- "price": {
- "$ref": "Price",
- "description": "Price of the item."
- },
- "shownImage": {
- "type": "string",
- "description": "URL to the cached image shown to the user when order was placed."
- },
- "targetCountry": {
- "type": "string",
- "description": "The CLDR territory code of the target country of the product."
- },
- "title": {
- "type": "string",
- "description": "The title of the product."
- },
- "variantAttributes": {
- "type": "array",
- "description": "Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.",
- "items": {
- "$ref": "OrderLineItemProductVariantAttribute"
- }
- }
- }
- },
- "OrderLineItemProductVariantAttribute": {
- "id": "OrderLineItemProductVariantAttribute",
- "type": "object",
- "properties": {
- "dimension": {
- "type": "string",
- "description": "The dimension of the variant."
- },
- "value": {
- "type": "string",
- "description": "The value for the dimension."
- }
- }
- },
- "OrderLineItemReturnInfo": {
- "id": "OrderLineItemReturnInfo",
- "type": "object",
- "properties": {
- "daysToReturn": {
- "type": "integer",
- "description": "How many days later the item can be returned.",
- "format": "int32",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "isReturnable": {
- "type": "boolean",
- "description": "Whether the item is returnable.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "policyUrl": {
- "type": "string",
- "description": "URL of the item return policy.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- }
- }
- },
- "OrderLineItemShippingDetails": {
- "id": "OrderLineItemShippingDetails",
- "type": "object",
- "properties": {
- "deliverByDate": {
- "type": "string",
- "description": "The delivery by date, in ISO 8601 format.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "method": {
- "$ref": "OrderLineItemShippingDetailsMethod",
- "description": "Details of the shipping method.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "shipByDate": {
- "type": "string",
- "description": "The ship by date, in ISO 8601 format.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- }
- }
- },
- "OrderLineItemShippingDetailsMethod": {
- "id": "OrderLineItemShippingDetailsMethod",
- "type": "object",
- "properties": {
- "carrier": {
- "type": "string",
- "description": "The carrier for the shipping. Optional."
- },
- "maxDaysInTransit": {
- "type": "integer",
- "description": "Maximum transit time.",
- "format": "uint32",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "methodName": {
- "type": "string",
- "description": "The name of the shipping method.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "minDaysInTransit": {
- "type": "integer",
- "description": "Minimum transit time.",
- "format": "uint32",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- }
- }
- },
- "OrderPaymentMethod": {
- "id": "OrderPaymentMethod",
- "type": "object",
- "properties": {
- "billingAddress": {
- "$ref": "OrderAddress",
- "description": "The billing address."
- },
- "expirationMonth": {
- "type": "integer",
- "description": "The card expiration month (January = 1, February = 2 etc.).",
- "format": "int32"
- },
- "expirationYear": {
- "type": "integer",
- "description": "The card expiration year (4-digit, e.g. 2015).",
- "format": "int32"
- },
- "lastFourDigits": {
- "type": "string",
- "description": "The last four digits of the card number."
- },
- "phoneNumber": {
- "type": "string",
- "description": "The billing phone number."
- },
- "type": {
- "type": "string",
- "description": "The type of instrument (VISA, Mastercard, etc)."
- }
- }
- },
- "OrderRefund": {
- "id": "OrderRefund",
- "type": "object",
- "properties": {
- "actor": {
- "type": "string",
- "description": "The actor that created the refund."
- },
- "amount": {
- "$ref": "Price",
- "description": "The amount that is refunded."
- },
- "creationDate": {
- "type": "string",
- "description": "Date on which the item has been created, in ISO 8601 format."
- },
- "reason": {
- "type": "string",
- "description": "The reason for the refund."
- },
- "reasonText": {
- "type": "string",
- "description": "The explanation of the reason."
- }
- }
- },
- "OrderReturn": {
- "id": "OrderReturn",
- "type": "object",
- "properties": {
- "actor": {
- "type": "string",
- "description": "The actor that created the refund."
- },
- "creationDate": {
- "type": "string",
- "description": "Date on which the item has been created, in ISO 8601 format."
- },
- "quantity": {
- "type": "integer",
- "description": "Quantity that is returned.",
- "format": "uint32"
- },
- "reason": {
- "type": "string",
- "description": "The reason for the return."
- },
- "reasonText": {
- "type": "string",
- "description": "The explanation of the reason."
- }
- }
- },
- "OrderShipment": {
- "id": "OrderShipment",
- "type": "object",
- "properties": {
- "carrier": {
- "type": "string",
- "description": "The carrier handling the shipment."
- },
- "creationDate": {
- "type": "string",
- "description": "Date on which the shipment has been created, in ISO 8601 format."
- },
- "deliveryDate": {
- "type": "string",
- "description": "Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delievered"
- },
- "id": {
- "type": "string",
- "description": "The id of the shipment."
- },
- "lineItems": {
- "type": "array",
- "description": "The line items that are shipped.",
- "items": {
- "$ref": "OrderShipmentLineItemShipment"
- }
- },
- "status": {
- "type": "string",
- "description": "The status of the shipment."
- },
- "trackingId": {
- "type": "string",
- "description": "The tracking id for the shipment."
- }
- }
- },
- "OrderShipmentLineItemShipment": {
- "id": "OrderShipmentLineItemShipment",
- "type": "object",
- "properties": {
- "lineItemId": {
- "type": "string",
- "description": "The id of the line item that is shipped."
- },
- "quantity": {
- "type": "integer",
- "description": "The quantity that is shipped.",
- "format": "uint32"
- }
- }
- },
- "OrdersAcknowledgeRequest": {
- "id": "OrdersAcknowledgeRequest",
- "type": "object",
- "properties": {
- "operationId": {
- "type": "string",
- "description": "The ID of the operation. Unique across all operations for a given order."
- }
- }
- },
- "OrdersAcknowledgeResponse": {
- "id": "OrdersAcknowledgeResponse",
- "type": "object",
- "properties": {
- "executionStatus": {
- "type": "string",
- "description": "The status of the execution."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersAcknowledgeResponse\".",
- "default": "content#ordersAcknowledgeResponse"
- }
- }
- },
- "OrdersAdvanceTestOrderResponse": {
- "id": "OrdersAdvanceTestOrderResponse",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersAdvanceTestOrderResponse\".",
- "default": "content#ordersAdvanceTestOrderResponse"
- }
- }
- },
- "OrdersCancelLineItemRequest": {
- "id": "OrdersCancelLineItemRequest",
- "type": "object",
- "properties": {
- "lineItemId": {
- "type": "string",
- "description": "The ID of the line item to cancel."
- },
- "operationId": {
- "type": "string",
- "description": "The ID of the operation. Unique across all operations for a given order."
- },
- "quantity": {
- "type": "integer",
- "description": "The quantity to cancel.",
- "format": "uint32"
- },
- "reason": {
- "type": "string",
- "description": "The reason for the cancellation."
- },
- "reasonText": {
- "type": "string",
- "description": "The explanation of the reason."
- }
- }
- },
- "OrdersCancelLineItemResponse": {
- "id": "OrdersCancelLineItemResponse",
- "type": "object",
- "properties": {
- "executionStatus": {
- "type": "string",
- "description": "The status of the execution."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCancelLineItemResponse\".",
- "default": "content#ordersCancelLineItemResponse"
- }
- }
- },
- "OrdersCancelRequest": {
- "id": "OrdersCancelRequest",
- "type": "object",
- "properties": {
- "operationId": {
- "type": "string",
- "description": "The ID of the operation. Unique across all operations for a given order."
- },
- "reason": {
- "type": "string",
- "description": "The reason for the cancellation."
- },
- "reasonText": {
- "type": "string",
- "description": "The explanation of the reason."
- }
- }
- },
- "OrdersCancelResponse": {
- "id": "OrdersCancelResponse",
- "type": "object",
- "properties": {
- "executionStatus": {
- "type": "string",
- "description": "The status of the execution."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCancelResponse\".",
- "default": "content#ordersCancelResponse"
- }
- }
- },
- "OrdersCreateTestOrderRequest": {
- "id": "OrdersCreateTestOrderRequest",
- "type": "object",
- "properties": {
- "templateName": {
- "type": "string",
- "description": "The test order template to use. Specify as an alternative to testOrder as a shortcut for retrieving a template and then creating an order using that template."
- },
- "testOrder": {
- "$ref": "TestOrder",
- "description": "The test order to create."
- }
- }
- },
- "OrdersCreateTestOrderResponse": {
- "id": "OrdersCreateTestOrderResponse",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCreateTestOrderResponse\".",
- "default": "content#ordersCreateTestOrderResponse"
- },
- "orderId": {
- "type": "string",
- "description": "The ID of the newly created test order."
- }
- }
- },
- "OrdersCustomBatchRequest": {
- "id": "OrdersCustomBatchRequest",
- "type": "object",
- "properties": {
- "entries": {
- "type": "array",
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "OrdersCustomBatchRequestEntry"
- }
- }
- }
- },
- "OrdersCustomBatchRequestEntry": {
- "id": "OrdersCustomBatchRequestEntry",
- "type": "object",
- "properties": {
- "batchId": {
- "type": "integer",
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32"
- },
- "cancel": {
- "$ref": "OrdersCustomBatchRequestEntryCancel",
- "description": "Required for cancel method."
- },
- "cancelLineItem": {
- "$ref": "OrdersCustomBatchRequestEntryCancelLineItem",
- "description": "Required for cancelLineItem method."
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "format": "uint64"
- },
- "merchantOrderId": {
- "type": "string",
- "description": "The merchant order id. Required for updateMerchantOrderId and getByMerchantOrderId methods."
- },
- "method": {
- "type": "string",
- "description": "The method to apply."
- },
- "operationId": {
- "type": "string",
- "description": "The ID of the operation. Unique across all operations for a given order. Required for all methods beside get and getByMerchantOrderId."
- },
- "orderId": {
- "type": "string",
- "description": "The ID of the order. Required for all methods beside getByMerchantOrderId."
- },
- "refund": {
- "$ref": "OrdersCustomBatchRequestEntryRefund",
- "description": "Required for refund method."
- },
- "returnLineItem": {
- "$ref": "OrdersCustomBatchRequestEntryReturnLineItem",
- "description": "Required for returnLineItem method."
- },
- "shipLineItems": {
- "$ref": "OrdersCustomBatchRequestEntryShipLineItems",
- "description": "Required for shipLineItems method."
- },
- "updateShipment": {
- "$ref": "OrdersCustomBatchRequestEntryUpdateShipment",
- "description": "Required for updateShipment method."
- }
- }
- },
- "OrdersCustomBatchRequestEntryCancel": {
- "id": "OrdersCustomBatchRequestEntryCancel",
- "type": "object",
- "properties": {
- "reason": {
- "type": "string",
- "description": "The reason for the cancellation."
- },
- "reasonText": {
- "type": "string",
- "description": "The explanation of the reason."
- }
- }
- },
- "OrdersCustomBatchRequestEntryCancelLineItem": {
- "id": "OrdersCustomBatchRequestEntryCancelLineItem",
- "type": "object",
- "properties": {
- "lineItemId": {
- "type": "string",
- "description": "The ID of the line item to cancel."
- },
- "quantity": {
- "type": "integer",
- "description": "The quantity to cancel.",
- "format": "uint32"
- },
- "reason": {
- "type": "string",
- "description": "The reason for the cancellation."
- },
- "reasonText": {
- "type": "string",
- "description": "The explanation of the reason."
- }
- }
- },
- "OrdersCustomBatchRequestEntryRefund": {
- "id": "OrdersCustomBatchRequestEntryRefund",
- "type": "object",
- "properties": {
- "amount": {
- "$ref": "Price",
- "description": "The amount that is refunded."
- },
- "reason": {
- "type": "string",
- "description": "The reason for the refund."
- },
- "reasonText": {
- "type": "string",
- "description": "The explanation of the reason."
- }
- }
- },
- "OrdersCustomBatchRequestEntryReturnLineItem": {
- "id": "OrdersCustomBatchRequestEntryReturnLineItem",
- "type": "object",
- "properties": {
- "lineItemId": {
- "type": "string",
- "description": "The ID of the line item to return."
- },
- "quantity": {
- "type": "integer",
- "description": "The quantity to return.",
- "format": "uint32"
- },
- "reason": {
- "type": "string",
- "description": "The reason for the return."
- },
- "reasonText": {
- "type": "string",
- "description": "The explanation of the reason."
- }
- }
- },
- "OrdersCustomBatchRequestEntryShipLineItems": {
- "id": "OrdersCustomBatchRequestEntryShipLineItems",
- "type": "object",
- "properties": {
- "carrier": {
- "type": "string",
- "description": "The carrier handling the shipment."
- },
- "lineItems": {
- "type": "array",
- "description": "Line items to ship.",
- "items": {
- "$ref": "OrderShipmentLineItemShipment"
- }
- },
- "shipmentId": {
- "type": "string",
- "description": "The ID of the shipment."
- },
- "trackingId": {
- "type": "string",
- "description": "The tracking id for the shipment."
- }
- }
- },
- "OrdersCustomBatchRequestEntryUpdateShipment": {
- "id": "OrdersCustomBatchRequestEntryUpdateShipment",
- "type": "object",
- "properties": {
- "carrier": {
- "type": "string",
- "description": "The carrier handling the shipment. Not updated if missing."
- },
- "shipmentId": {
- "type": "string",
- "description": "The ID of the shipment."
- },
- "status": {
- "type": "string",
- "description": "New status for the shipment. Not updated if missing."
- },
- "trackingId": {
- "type": "string",
- "description": "The tracking id for the shipment. Not updated if missing."
- }
- }
- },
- "OrdersCustomBatchResponse": {
- "id": "OrdersCustomBatchResponse",
- "type": "object",
- "properties": {
- "entries": {
- "type": "array",
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "OrdersCustomBatchResponseEntry"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCustomBatchResponse\".",
- "default": "content#ordersCustomBatchResponse"
- }
- }
- },
- "OrdersCustomBatchResponseEntry": {
- "id": "OrdersCustomBatchResponseEntry",
- "type": "object",
- "properties": {
- "batchId": {
- "type": "integer",
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors defined if and only if the request failed."
- },
- "executionStatus": {
- "type": "string",
- "description": "The status of the execution. Only defined if the method is not get or getByMerchantOrderId and if the request was successful."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCustomBatchResponseEntry\".",
- "default": "content#ordersCustomBatchResponseEntry"
- },
- "order": {
- "$ref": "Order",
- "description": "The retrieved order. Only defined if the method is get and if the request was successful."
- }
- }
- },
- "OrdersGetByMerchantOrderIdResponse": {
- "id": "OrdersGetByMerchantOrderIdResponse",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersGetByMerchantOrderIdResponse\".",
- "default": "content#ordersGetByMerchantOrderIdResponse"
- },
- "order": {
- "$ref": "Order",
- "description": "The requested order."
- }
- }
- },
- "OrdersGetTestOrderTemplateResponse": {
- "id": "OrdersGetTestOrderTemplateResponse",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersGetTestOrderTemplateResponse\".",
- "default": "content#ordersGetTestOrderTemplateResponse"
- },
- "template": {
- "$ref": "TestOrder",
- "description": "The requested test order template."
- }
- }
- },
- "OrdersListResponse": {
- "id": "OrdersListResponse",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersListResponse\".",
- "default": "content#ordersListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "The token for the retrieval of the next page of orders."
- },
- "resources": {
- "type": "array",
- "items": {
- "$ref": "Order"
- }
- }
- }
- },
- "OrdersRefundRequest": {
- "id": "OrdersRefundRequest",
- "type": "object",
- "properties": {
- "amount": {
- "$ref": "Price",
- "description": "The amount that is refunded."
- },
- "operationId": {
- "type": "string",
- "description": "The ID of the operation. Unique across all operations for a given order."
- },
- "reason": {
- "type": "string",
- "description": "The reason for the refund."
- },
- "reasonText": {
- "type": "string",
- "description": "The explanation of the reason."
- }
- }
- },
- "OrdersRefundResponse": {
- "id": "OrdersRefundResponse",
- "type": "object",
- "properties": {
- "executionStatus": {
- "type": "string",
- "description": "The status of the execution."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersRefundResponse\".",
- "default": "content#ordersRefundResponse"
- }
- }
- },
- "OrdersReturnLineItemRequest": {
- "id": "OrdersReturnLineItemRequest",
- "type": "object",
- "properties": {
- "lineItemId": {
- "type": "string",
- "description": "The ID of the line item to return."
- },
- "operationId": {
- "type": "string",
- "description": "The ID of the operation. Unique across all operations for a given order."
- },
- "quantity": {
- "type": "integer",
- "description": "The quantity to return.",
- "format": "uint32"
- },
- "reason": {
- "type": "string",
- "description": "The reason for the return."
- },
- "reasonText": {
- "type": "string",
- "description": "The explanation of the reason."
- }
- }
- },
- "OrdersReturnLineItemResponse": {
- "id": "OrdersReturnLineItemResponse",
- "type": "object",
- "properties": {
- "executionStatus": {
- "type": "string",
- "description": "The status of the execution."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersReturnLineItemResponse\".",
- "default": "content#ordersReturnLineItemResponse"
- }
- }
- },
- "OrdersShipLineItemsRequest": {
- "id": "OrdersShipLineItemsRequest",
- "type": "object",
- "properties": {
- "carrier": {
- "type": "string",
- "description": "The carrier handling the shipment."
- },
- "lineItems": {
- "type": "array",
- "description": "Line items to ship.",
- "items": {
- "$ref": "OrderShipmentLineItemShipment"
- }
- },
- "operationId": {
- "type": "string",
- "description": "The ID of the operation. Unique across all operations for a given order."
- },
- "shipmentId": {
- "type": "string",
- "description": "The ID of the shipment."
- },
- "trackingId": {
- "type": "string",
- "description": "The tracking id for the shipment."
- }
- }
- },
- "OrdersShipLineItemsResponse": {
- "id": "OrdersShipLineItemsResponse",
- "type": "object",
- "properties": {
- "executionStatus": {
- "type": "string",
- "description": "The status of the execution."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersShipLineItemsResponse\".",
- "default": "content#ordersShipLineItemsResponse"
- }
- }
- },
- "OrdersUpdateMerchantOrderIdRequest": {
- "id": "OrdersUpdateMerchantOrderIdRequest",
- "type": "object",
- "properties": {
- "merchantOrderId": {
- "type": "string",
- "description": "The merchant order id to be assigned to the order. Must be unique per merchant."
- },
- "operationId": {
- "type": "string",
- "description": "The ID of the operation. Unique across all operations for a given order."
- }
- }
- },
- "OrdersUpdateMerchantOrderIdResponse": {
- "id": "OrdersUpdateMerchantOrderIdResponse",
- "type": "object",
- "properties": {
- "executionStatus": {
- "type": "string",
- "description": "The status of the execution."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersUpdateMerchantOrderIdResponse\".",
- "default": "content#ordersUpdateMerchantOrderIdResponse"
- }
- }
- },
- "OrdersUpdateShipmentRequest": {
- "id": "OrdersUpdateShipmentRequest",
- "type": "object",
- "properties": {
- "carrier": {
- "type": "string",
- "description": "The carrier handling the shipment. Not updated if missing."
- },
- "operationId": {
- "type": "string",
- "description": "The ID of the operation. Unique across all operations for a given order."
- },
- "shipmentId": {
- "type": "string",
- "description": "The ID of the shipment."
- },
- "status": {
- "type": "string",
- "description": "New status for the shipment. Not updated if missing."
- },
- "trackingId": {
- "type": "string",
- "description": "The tracking id for the shipment. Not updated if missing."
- }
- }
- },
- "OrdersUpdateShipmentResponse": {
- "id": "OrdersUpdateShipmentResponse",
- "type": "object",
- "properties": {
- "executionStatus": {
- "type": "string",
- "description": "The status of the execution."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersUpdateShipmentResponse\".",
- "default": "content#ordersUpdateShipmentResponse"
- }
- }
- },
- "Price": {
- "id": "Price",
- "type": "object",
- "properties": {
- "currency": {
- "type": "string",
- "description": "The currency of the price."
- },
- "value": {
- "type": "string",
- "description": "The price represented as a number."
- }
- }
- },
- "Product": {
- "id": "Product",
- "type": "object",
- "description": "Product data.",
- "properties": {
- "additionalImageLinks": {
- "type": "array",
- "description": "Additional URLs of images of the item.",
- "items": {
- "type": "string"
- }
- },
- "adult": {
- "type": "boolean",
- "description": "Set to true if the item is targeted towards adults."
- },
- "adwordsGrouping": {
- "type": "string",
- "description": "Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise."
- },
- "adwordsLabels": {
- "type": "array",
- "description": "Similar to adwords_grouping, but only works on CPC.",
- "items": {
- "type": "string"
- }
- },
- "adwordsRedirect": {
- "type": "string",
- "description": "Allows advertisers to override the item URL when the product is shown within the context of Product Ads."
- },
- "ageGroup": {
- "type": "string",
- "description": "Target age group of the item."
- },
- "aspects": {
- "type": "array",
- "description": "Specifies the intended aspects for the product.",
- "items": {
- "$ref": "ProductAspect"
- }
- },
- "availability": {
- "type": "string",
- "description": "Availability status of the item."
- },
- "availabilityDate": {
- "type": "string",
- "description": "The day a pre-ordered product becomes available for delivery, in ISO 8601 format."
- },
- "brand": {
- "type": "string",
- "description": "Brand of the item."
- },
- "channel": {
- "type": "string",
- "description": "The item's channel (online or local).",
- "annotations": {
- "required": [
- "content.products.insert"
- ]
- }
- },
- "color": {
- "type": "string",
- "description": "Color of the item."
- },
- "condition": {
- "type": "string",
- "description": "Condition or state of the item."
- },
- "contentLanguage": {
- "type": "string",
- "description": "The two-letter ISO 639-1 language code for the item.",
- "annotations": {
- "required": [
- "content.products.insert"
- ]
- }
- },
- "customAttributes": {
- "type": "array",
- "description": "A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (e.g., { \"name\": \"size type\", \"type\": \"text\", \"value\": \"regular\" }). This is useful for submitting attributes not explicitly exposed by the API.",
- "items": {
- "$ref": "ProductCustomAttribute"
- }
- },
- "customGroups": {
- "type": "array",
- "description": "A list of custom (merchant-provided) custom attribute groups.",
- "items": {
- "$ref": "ProductCustomGroup"
- }
- },
- "customLabel0": {
- "type": "string",
- "description": "Custom label 0 for custom grouping of items in a Shopping campaign."
- },
- "customLabel1": {
- "type": "string",
- "description": "Custom label 1 for custom grouping of items in a Shopping campaign."
- },
- "customLabel2": {
- "type": "string",
- "description": "Custom label 2 for custom grouping of items in a Shopping campaign."
- },
- "customLabel3": {
- "type": "string",
- "description": "Custom label 3 for custom grouping of items in a Shopping campaign."
- },
- "customLabel4": {
- "type": "string",
- "description": "Custom label 4 for custom grouping of items in a Shopping campaign."
- },
- "description": {
- "type": "string",
- "description": "Description of the item."
- },
- "destinations": {
- "type": "array",
- "description": "Specifies the intended destinations for the product.",
- "items": {
- "$ref": "ProductDestination"
- }
- },
- "displayAdsId": {
- "type": "string",
- "description": "An identifier for an item for dynamic remarketing campaigns."
- },
- "displayAdsLink": {
- "type": "string",
- "description": "URL directly to your item's landing page for dynamic remarketing campaigns."
- },
- "displayAdsSimilarIds": {
- "type": "array",
- "description": "Advertiser-specified recommendations.",
- "items": {
- "type": "string"
- }
- },
- "displayAdsTitle": {
- "type": "string",
- "description": "Title of an item for dynamic remarketing campaigns."
- },
- "displayAdsValue": {
- "type": "number",
- "description": "Offer margin for dynamic remarketing campaigns.",
- "format": "double"
- },
- "energyEfficiencyClass": {
- "type": "string",
- "description": "The energy efficiency class as defined in EU directive 2010/30/EU."
- },
- "expirationDate": {
- "type": "string",
- "description": "Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in productstatuses as googleExpirationDate and might be earlier if expirationDate is too far in the future."
- },
- "gender": {
- "type": "string",
- "description": "Target gender of the item."
- },
- "googleProductCategory": {
- "type": "string",
- "description": "Google's category of the item (see Google product taxonomy)."
- },
- "gtin": {
- "type": "string",
- "description": "Global Trade Item Number (GTIN) of the item."
- },
- "id": {
- "type": "string",
- "description": "The REST id of the product."
- },
- "identifierExists": {
- "type": "boolean",
- "description": "False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada."
- },
- "imageLink": {
- "type": "string",
- "description": "URL of an image of the item."
- },
- "installment": {
- "$ref": "ProductInstallment",
- "description": "Number and amount of installments to pay for an item. Brazil only."
- },
- "isBundle": {
- "type": "boolean",
- "description": "Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price."
- },
- "itemGroupId": {
- "type": "string",
- "description": "Shared identifier for all variants of the same product."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#product\".",
- "default": "content#product"
- },
- "link": {
- "type": "string",
- "description": "URL directly linking to your item's page on your website."
- },
- "loyaltyPoints": {
- "$ref": "LoyaltyPoints",
- "description": "Loyalty points that users receive after purchasing the item. Japan only."
- },
- "material": {
- "type": "string",
- "description": "The material of which the item is made."
- },
- "mobileLink": {
- "type": "string",
- "description": "Link to a mobile-optimized version of the landing page."
- },
- "mpn": {
- "type": "string",
- "description": "Manufacturer Part Number (MPN) of the item."
- },
- "multipack": {
- "type": "string",
- "description": "The number of identical products in a merchant-defined multipack.",
- "format": "int64"
- },
- "offerId": {
- "type": "string",
- "description": "An identifier of the item.",
- "annotations": {
- "required": [
- "content.products.insert"
- ]
- }
- },
- "onlineOnly": {
- "type": "boolean",
- "description": "Whether an item is available for purchase only online."
- },
- "pattern": {
- "type": "string",
- "description": "The item's pattern (e.g. polka dots)."
- },
- "price": {
- "$ref": "Price",
- "description": "Price of the item."
- },
- "productType": {
- "type": "string",
- "description": "Your category of the item (formatted as in product feeds specification)."
- },
- "salePrice": {
- "$ref": "Price",
- "description": "Advertised sale price of the item."
- },
- "salePriceEffectiveDate": {
- "type": "string",
- "description": "Date range during which the item is on sale (see product feed specifications)."
- },
- "sellOnGoogleQuantity": {
- "type": "string",
- "description": "The quantity of the product that is reserved for sell-on-google ads.",
- "format": "int64"
- },
- "shipping": {
- "type": "array",
- "description": "Shipping rules.",
- "items": {
- "$ref": "ProductShipping"
- }
- },
- "shippingHeight": {
- "$ref": "ProductShippingDimension",
- "description": "Height of the item for shipping."
- },
- "shippingLabel": {
- "type": "string",
- "description": "The shipping label of the product, used to group product in account-level shipping rules."
- },
- "shippingLength": {
- "$ref": "ProductShippingDimension",
- "description": "Length of the item for shipping."
- },
- "shippingWeight": {
- "$ref": "ProductShippingWeight",
- "description": "Weight of the item for shipping."
- },
- "shippingWidth": {
- "$ref": "ProductShippingDimension",
- "description": "Width of the item for shipping."
- },
- "sizeSystem": {
- "type": "string",
- "description": "System in which the size is specified. Recommended for apparel items."
- },
- "sizeType": {
- "type": "string",
- "description": "The cut of the item. Recommended for apparel items."
- },
- "sizes": {
- "type": "array",
- "description": "Size of the item.",
- "items": {
- "type": "string"
- }
- },
- "targetCountry": {
- "type": "string",
- "description": "The CLDR territory code for the item.",
- "annotations": {
- "required": [
- "content.products.insert"
- ]
- }
- },
- "taxes": {
- "type": "array",
- "description": "Tax information.",
- "items": {
- "$ref": "ProductTax"
- }
- },
- "title": {
- "type": "string",
- "description": "Title of the item."
- },
- "unitPricingBaseMeasure": {
- "$ref": "ProductUnitPricingBaseMeasure",
- "description": "The preference of the denominator of the unit price."
- },
- "unitPricingMeasure": {
- "$ref": "ProductUnitPricingMeasure",
- "description": "The measure and dimension of an item."
- },
- "validatedDestinations": {
- "type": "array",
- "description": "The read-only list of intended destinations which passed validation.",
- "items": {
- "type": "string"
- }
- },
- "warnings": {
- "type": "array",
- "description": "Read-only warnings.",
- "items": {
- "$ref": "Error"
- }
- }
- }
- },
- "ProductAspect": {
- "id": "ProductAspect",
- "type": "object",
- "properties": {
- "aspectName": {
- "type": "string",
- "description": "The name of the aspect."
- },
- "destinationName": {
- "type": "string",
- "description": "The name of the destination. Leave out to apply to all destinations."
- },
- "intention": {
- "type": "string",
- "description": "Whether the aspect is required, excluded or should be validated."
- }
- }
- },
- "ProductCustomAttribute": {
- "id": "ProductCustomAttribute",
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "The name of the attribute. Underscores will be replaced by spaces upon insertion."
- },
- "type": {
- "type": "string",
- "description": "The type of the attribute."
- },
- "unit": {
- "type": "string",
- "description": "Free-form unit of the attribute. Unit can only be used for values of type INT or FLOAT."
- },
- "value": {
- "type": "string",
- "description": "The value of the attribute."
- }
- }
- },
- "ProductCustomGroup": {
- "id": "ProductCustomGroup",
- "type": "object",
- "properties": {
- "attributes": {
- "type": "array",
- "description": "The sub-attributes.",
- "items": {
- "$ref": "ProductCustomAttribute"
- }
- },
- "name": {
- "type": "string",
- "description": "The name of the group. Underscores will be replaced by spaces upon insertion."
- }
- }
- },
- "ProductDestination": {
- "id": "ProductDestination",
- "type": "object",
- "properties": {
- "destinationName": {
- "type": "string",
- "description": "The name of the destination."
- },
- "intention": {
- "type": "string",
- "description": "Whether the destination is required, excluded or should be validated."
- }
- }
- },
- "ProductInstallment": {
- "id": "ProductInstallment",
- "type": "object",
- "properties": {
- "amount": {
- "$ref": "Price",
- "description": "The amount the buyer has to pay per month."
- },
- "months": {
- "type": "string",
- "description": "The number of installments the buyer has to pay.",
- "format": "int64"
- }
- }
- },
- "ProductShipping": {
- "id": "ProductShipping",
- "type": "object",
- "properties": {
- "country": {
- "type": "string",
- "description": "The CLDR territory code of the country to which an item will ship."
- },
- "locationGroupName": {
- "type": "string",
- "description": "The location where the shipping is applicable, represented by a location group name."
- },
- "locationId": {
- "type": "string",
- "description": "The numeric id of a location that the shipping rate applies to as defined in the AdWords API.",
- "format": "int64"
- },
- "postalCode": {
- "type": "string",
- "description": "The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length."
- },
- "price": {
- "$ref": "Price",
- "description": "Fixed shipping price, represented as a number."
- },
- "region": {
- "type": "string",
- "description": "The geographic region to which a shipping rate applies (e.g. zip code)."
- },
- "service": {
- "type": "string",
- "description": "A free-form description of the service class or delivery speed."
- }
- }
- },
- "ProductShippingDimension": {
- "id": "ProductShippingDimension",
- "type": "object",
- "properties": {
- "unit": {
- "type": "string",
- "description": "The unit of value.\n\nAcceptable values are: \n- \"cm\" \n- \"in\""
- },
- "value": {
- "type": "number",
- "description": "The dimension of the product used to calculate the shipping cost of the item.",
- "format": "double"
- }
- }
- },
- "ProductShippingWeight": {
- "id": "ProductShippingWeight",
- "type": "object",
- "properties": {
- "unit": {
- "type": "string",
- "description": "The unit of value."
- },
- "value": {
- "type": "number",
- "description": "The weight of the product used to calculate the shipping cost of the item.",
- "format": "double"
- }
- }
- },
- "ProductStatus": {
- "id": "ProductStatus",
- "type": "object",
- "description": "The status of a product, i.e., information about a product computed asynchronously by the data quality analysis.",
- "properties": {
- "creationDate": {
- "type": "string",
- "description": "Date on which the item has been created, in ISO 8601 format."
- },
- "dataQualityIssues": {
- "type": "array",
- "description": "A list of data quality issues associated with the product.",
- "items": {
- "$ref": "ProductStatusDataQualityIssue"
- }
- },
- "destinationStatuses": {
- "type": "array",
- "description": "The intended destinations for the product.",
- "items": {
- "$ref": "ProductStatusDestinationStatus"
- }
- },
- "googleExpirationDate": {
- "type": "string",
- "description": "Date on which the item expires in Google Shopping, in ISO 8601 format."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#productStatus\".",
- "default": "content#productStatus"
- },
- "lastUpdateDate": {
- "type": "string",
- "description": "Date on which the item has been last updated, in ISO 8601 format."
- },
- "link": {
- "type": "string",
- "description": "The link to the product."
- },
- "productId": {
- "type": "string",
- "description": "The id of the product for which status is reported."
- },
- "title": {
- "type": "string",
- "description": "The title of the product."
- }
- }
- },
- "ProductStatusDataQualityIssue": {
- "id": "ProductStatusDataQualityIssue",
- "type": "object",
- "properties": {
- "detail": {
- "type": "string",
- "description": "A more detailed error string."
- },
- "fetchStatus": {
- "type": "string",
- "description": "The fetch status for landing_page_errors."
- },
- "id": {
- "type": "string",
- "description": "The id of the data quality issue."
- },
- "location": {
- "type": "string",
- "description": "The attribute name that is relevant for the issue."
- },
- "severity": {
- "type": "string",
- "description": "The severity of the data quality issue."
- },
- "timestamp": {
- "type": "string",
- "description": "The time stamp of the data quality issue."
- },
- "valueOnLandingPage": {
- "type": "string",
- "description": "The value of that attribute that was found on the landing page"
- },
- "valueProvided": {
- "type": "string",
- "description": "The value the attribute had at time of evaluation."
- }
- }
- },
- "ProductStatusDestinationStatus": {
- "id": "ProductStatusDestinationStatus",
- "type": "object",
- "properties": {
- "approvalStatus": {
- "type": "string",
- "description": "The destination's approval status."
- },
- "destination": {
- "type": "string",
- "description": "The name of the destination"
- },
- "intention": {
- "type": "string",
- "description": "Whether the destination is required, excluded, selected by default or should be validated."
- }
- }
- },
- "ProductTax": {
- "id": "ProductTax",
- "type": "object",
- "properties": {
- "country": {
- "type": "string",
- "description": "The country within which the item is taxed, specified as a CLDR territory code."
- },
- "locationId": {
- "type": "string",
- "description": "The numeric id of a location that the tax rate applies to as defined in the AdWords API.",
- "format": "int64"
- },
- "postalCode": {
- "type": "string",
- "description": "The postal code range that the tax rate applies to, represented by a ZIP code, a ZIP code prefix using * wildcard, a range between two ZIP codes or two ZIP code prefixes of equal length. Examples: 94114, 94*, 94002-95460, 94*-95*."
- },
- "rate": {
- "type": "number",
- "description": "The percentage of tax rate that applies to the item price.",
- "format": "double"
- },
- "region": {
- "type": "string",
- "description": "The geographic region to which the tax rate applies."
- },
- "taxShip": {
- "type": "boolean",
- "description": "Set to true if tax is charged on shipping."
- }
- }
- },
- "ProductUnitPricingBaseMeasure": {
- "id": "ProductUnitPricingBaseMeasure",
- "type": "object",
- "properties": {
- "unit": {
- "type": "string",
- "description": "The unit of the denominator."
- },
- "value": {
- "type": "string",
- "description": "The denominator of the unit price.",
- "format": "int64"
- }
- }
- },
- "ProductUnitPricingMeasure": {
- "id": "ProductUnitPricingMeasure",
- "type": "object",
- "properties": {
- "unit": {
- "type": "string",
- "description": "The unit of the measure."
- },
- "value": {
- "type": "number",
- "description": "The measure of an item.",
- "format": "double"
- }
- }
- },
- "ProductsCustomBatchRequest": {
- "id": "ProductsCustomBatchRequest",
- "type": "object",
- "properties": {
- "entries": {
- "type": "array",
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "ProductsCustomBatchRequestEntry"
- }
- }
- }
- },
- "ProductsCustomBatchRequestEntry": {
- "id": "ProductsCustomBatchRequestEntry",
- "type": "object",
- "description": "A batch entry encoding a single non-batch products request.",
- "properties": {
- "batchId": {
- "type": "integer",
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "format": "uint64"
- },
- "method": {
- "type": "string"
- },
- "product": {
- "$ref": "Product",
- "description": "The product to insert. Only required if the method is insert."
- },
- "productId": {
- "type": "string",
- "description": "The ID of the product to get or delete. Only defined if the method is get or delete."
- }
- }
- },
- "ProductsCustomBatchResponse": {
- "id": "ProductsCustomBatchResponse",
- "type": "object",
- "properties": {
- "entries": {
- "type": "array",
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "ProductsCustomBatchResponseEntry"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#productsCustomBatchResponse\".",
- "default": "content#productsCustomBatchResponse"
- }
- }
- },
- "ProductsCustomBatchResponseEntry": {
- "id": "ProductsCustomBatchResponseEntry",
- "type": "object",
- "description": "A batch entry encoding a single non-batch products response.",
- "properties": {
- "batchId": {
- "type": "integer",
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors defined if and only if the request failed."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#productsCustomBatchResponseEntry\".",
- "default": "content#productsCustomBatchResponseEntry"
- },
- "product": {
- "$ref": "Product",
- "description": "The inserted product. Only defined if the method is insert and if the request was successful."
- }
- }
- },
- "ProductsListResponse": {
- "id": "ProductsListResponse",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#productsListResponse\".",
- "default": "content#productsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "The token for the retrieval of the next page of products."
- },
- "resources": {
- "type": "array",
- "items": {
- "$ref": "Product"
- }
- }
- }
- },
- "ProductstatusesCustomBatchRequest": {
- "id": "ProductstatusesCustomBatchRequest",
- "type": "object",
- "properties": {
- "entries": {
- "type": "array",
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "ProductstatusesCustomBatchRequestEntry"
- }
- }
- }
- },
- "ProductstatusesCustomBatchRequestEntry": {
- "id": "ProductstatusesCustomBatchRequestEntry",
- "type": "object",
- "description": "A batch entry encoding a single non-batch productstatuses request.",
- "properties": {
- "batchId": {
- "type": "integer",
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "format": "uint64"
- },
- "method": {
- "type": "string"
- },
- "productId": {
- "type": "string",
- "description": "The ID of the product whose status to get."
- }
- }
- },
- "ProductstatusesCustomBatchResponse": {
- "id": "ProductstatusesCustomBatchResponse",
- "type": "object",
- "properties": {
- "entries": {
- "type": "array",
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "ProductstatusesCustomBatchResponseEntry"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#productstatusesCustomBatchResponse\".",
- "default": "content#productstatusesCustomBatchResponse"
- }
- }
- },
- "ProductstatusesCustomBatchResponseEntry": {
- "id": "ProductstatusesCustomBatchResponseEntry",
- "type": "object",
- "description": "A batch entry encoding a single non-batch productstatuses response.",
- "properties": {
- "batchId": {
- "type": "integer",
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors, if the request failed."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#productstatusesCustomBatchResponseEntry\".",
- "default": "content#productstatusesCustomBatchResponseEntry"
- },
- "productStatus": {
- "$ref": "ProductStatus",
- "description": "The requested product status. Only defined if the request was successful."
- }
- }
- },
- "ProductstatusesListResponse": {
- "id": "ProductstatusesListResponse",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#productstatusesListResponse\".",
- "default": "content#productstatusesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "The token for the retrieval of the next page of products statuses."
- },
- "resources": {
- "type": "array",
- "items": {
- "$ref": "ProductStatus"
- }
- }
- }
- },
- "TestOrder": {
- "id": "TestOrder",
- "type": "object",
- "properties": {
- "customer": {
- "$ref": "TestOrderCustomer",
- "description": "The details of the customer who placed the order.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#testOrder\".",
- "default": "content#testOrder"
- },
- "lineItems": {
- "type": "array",
- "description": "Line items that are ordered. At least one line item must be provided.",
- "items": {
- "$ref": "TestOrderLineItem"
- },
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "paymentMethod": {
- "$ref": "TestOrderPaymentMethod",
- "description": "The details of the payment method."
- },
- "predefinedDeliveryAddress": {
- "type": "string",
- "description": "Identifier of one of the predefined delivery addresses for the delivery.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "shippingCost": {
- "$ref": "Price",
- "description": "The total cost of shipping for all items.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "shippingCostTax": {
- "$ref": "Price",
- "description": "The tax for the total shipping cost.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "shippingOption": {
- "type": "string",
- "description": "The requested shipping option.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- }
- }
- },
- "TestOrderCustomer": {
- "id": "TestOrderCustomer",
- "type": "object",
- "properties": {
- "email": {
- "type": "string",
- "description": "Email address of the customer.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "explicitMarketingPreference": {
- "type": "boolean",
- "description": "If set, this indicates the user had a choice to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the Purchases on Google checkout flow. Optional."
- },
- "fullName": {
- "type": "string",
- "description": "Full name of the customer."
- }
- }
- },
- "TestOrderLineItem": {
- "id": "TestOrderLineItem",
- "type": "object",
- "properties": {
- "product": {
- "$ref": "TestOrderLineItemProduct",
- "description": "Product data from the time of the order placement."
- },
- "quantityOrdered": {
- "type": "integer",
- "description": "Number of items ordered.",
- "format": "uint32",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "returnInfo": {
- "$ref": "OrderLineItemReturnInfo",
- "description": "Details of the return policy for the line item.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "shippingDetails": {
- "$ref": "OrderLineItemShippingDetails",
- "description": "Details of the requested shipping for the line item.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "unitTax": {
- "$ref": "Price",
- "description": "Unit tax for the line item.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- }
- }
- },
- "TestOrderLineItemProduct": {
- "id": "TestOrderLineItemProduct",
- "type": "object",
- "properties": {
- "brand": {
- "type": "string",
- "description": "Brand of the item.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "channel": {
- "type": "string",
- "description": "The item's channel.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "condition": {
- "type": "string",
- "description": "Condition or state of the item.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "contentLanguage": {
- "type": "string",
- "description": "The two-letter ISO 639-1 language code for the item.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "gtin": {
- "type": "string",
- "description": "Global Trade Item Number (GTIN) of the item. Optional."
- },
- "imageLink": {
- "type": "string",
- "description": "URL of an image of the item.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "itemGroupId": {
- "type": "string",
- "description": "Shared identifier for all variants of the same product. Optional."
- },
- "mpn": {
- "type": "string",
- "description": "Manufacturer Part Number (MPN) of the item. Optional."
- },
- "offerId": {
- "type": "string",
- "description": "An identifier of the item.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "price": {
- "$ref": "Price",
- "description": "The price for the product.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "targetCountry": {
- "type": "string",
- "description": "The CLDR territory code of the target country of the product.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "title": {
- "type": "string",
- "description": "The title of the product.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "variantAttributes": {
- "type": "array",
- "description": "Variant attributes for the item. Optional.",
- "items": {
- "$ref": "OrderLineItemProductVariantAttribute"
- }
- }
- }
- },
- "TestOrderPaymentMethod": {
- "id": "TestOrderPaymentMethod",
- "type": "object",
- "properties": {
- "expirationMonth": {
- "type": "integer",
- "description": "The card expiration month (January = 1, February = 2 etc.).",
- "format": "int32"
- },
- "expirationYear": {
- "type": "integer",
- "description": "The card expiration year (4-digit, e.g. 2015).",
- "format": "int32"
- },
- "lastFourDigits": {
- "type": "string",
- "description": "The last four digits of the card number."
- },
- "predefinedBillingAddress": {
- "type": "string",
- "description": "The billing address."
- },
- "type": {
- "type": "string",
- "description": "The type of instrument. Note that real orders might have different values than the four values accepted by createTestOrder."
- }
- }
- },
- "Weight": {
- "id": "Weight",
- "type": "object",
- "properties": {
- "unit": {
- "type": "string",
- "description": "The weight unit.",
- "annotations": {
- "required": [
- "content.accountshipping.update"
- ]
- }
- },
- "value": {
- "type": "string",
- "description": "The weight represented as a number.",
- "annotations": {
- "required": [
- "content.accountshipping.update"
- ]
- }
- }
- }
- }
- },
- "resources": {
- "accounts": {
- "methods": {
- "authinfo": {
- "id": "content.accounts.authinfo",
- "path": "accounts/authinfo",
- "httpMethod": "GET",
- "description": "Returns information about the authenticated user.",
- "response": {
- "$ref": "AccountsAuthInfoResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "custombatch": {
- "id": "content.accounts.custombatch",
- "path": "accounts/batch",
- "httpMethod": "POST",
- "description": "Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.",
- "parameters": {
- "dryRun": {
- "type": "boolean",
- "description": "Flag to run the request in dry-run mode.",
- "location": "query"
- }
- },
- "request": {
- "$ref": "AccountsCustomBatchRequest"
- },
- "response": {
- "$ref": "AccountsCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "delete": {
- "id": "content.accounts.delete",
- "path": "{merchantId}/accounts/{accountId}",
- "httpMethod": "DELETE",
- "description": "Deletes a Merchant Center sub-account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The ID of the account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "dryRun": {
- "type": "boolean",
- "description": "Flag to run the request in dry-run mode.",
- "location": "query"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "id": "content.accounts.get",
- "path": "{merchantId}/accounts/{accountId}",
- "httpMethod": "GET",
- "description": "Retrieves a Merchant Center account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The ID of the account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "insert": {
- "id": "content.accounts.insert",
- "path": "{merchantId}/accounts",
- "httpMethod": "POST",
- "description": "Creates a Merchant Center sub-account.",
- "parameters": {
- "dryRun": {
- "type": "boolean",
- "description": "Flag to run the request in dry-run mode.",
- "location": "query"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId"
- ],
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "id": "content.accounts.list",
- "path": "{merchantId}/accounts",
- "httpMethod": "GET",
- "description": "Lists the sub-accounts in your Merchant Center account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of accounts to return in the response, used for paging.",
- "format": "uint32",
- "location": "query"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "pageToken": {
- "type": "string",
- "description": "The token returned by the previous request.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "merchantId"
- ],
- "response": {
- "$ref": "AccountsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "patch": {
- "id": "content.accounts.patch",
- "path": "{merchantId}/accounts/{accountId}",
- "httpMethod": "PATCH",
- "description": "Updates a Merchant Center account. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The ID of the account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "dryRun": {
- "type": "boolean",
- "description": "Flag to run the request in dry-run mode.",
- "location": "query"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "update": {
- "id": "content.accounts.update",
- "path": "{merchantId}/accounts/{accountId}",
- "httpMethod": "PUT",
- "description": "Updates a Merchant Center account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The ID of the account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "dryRun": {
- "type": "boolean",
- "description": "Flag to run the request in dry-run mode.",
- "location": "query"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "accountshipping": {
- "methods": {
- "custombatch": {
- "id": "content.accountshipping.custombatch",
- "path": "accountshipping/batch",
- "httpMethod": "POST",
- "description": "Retrieves and updates the shipping settings of multiple accounts in a single request.",
- "parameters": {
- "dryRun": {
- "type": "boolean",
- "description": "Flag to run the request in dry-run mode.",
- "location": "query"
- }
- },
- "request": {
- "$ref": "AccountshippingCustomBatchRequest"
- },
- "response": {
- "$ref": "AccountshippingCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "id": "content.accountshipping.get",
- "path": "{merchantId}/accountshipping/{accountId}",
- "httpMethod": "GET",
- "description": "Retrieves the shipping settings of the account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The ID of the account for which to get/update account shipping settings.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "response": {
- "$ref": "AccountShipping"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "id": "content.accountshipping.list",
- "path": "{merchantId}/accountshipping",
- "httpMethod": "GET",
- "description": "Lists the shipping settings of the sub-accounts in your Merchant Center account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of shipping settings to return in the response, used for paging.",
- "format": "uint32",
- "location": "query"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "pageToken": {
- "type": "string",
- "description": "The token returned by the previous request.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "merchantId"
- ],
- "response": {
- "$ref": "AccountshippingListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "patch": {
- "id": "content.accountshipping.patch",
- "path": "{merchantId}/accountshipping/{accountId}",
- "httpMethod": "PATCH",
- "description": "Updates the shipping settings of the account. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The ID of the account for which to get/update account shipping settings.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "dryRun": {
- "type": "boolean",
- "description": "Flag to run the request in dry-run mode.",
- "location": "query"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "request": {
- "$ref": "AccountShipping"
- },
- "response": {
- "$ref": "AccountShipping"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "update": {
- "id": "content.accountshipping.update",
- "path": "{merchantId}/accountshipping/{accountId}",
- "httpMethod": "PUT",
- "description": "Updates the shipping settings of the account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The ID of the account for which to get/update account shipping settings.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "dryRun": {
- "type": "boolean",
- "description": "Flag to run the request in dry-run mode.",
- "location": "query"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "request": {
- "$ref": "AccountShipping"
- },
- "response": {
- "$ref": "AccountShipping"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "accountstatuses": {
- "methods": {
- "custombatch": {
- "id": "content.accountstatuses.custombatch",
- "path": "accountstatuses/batch",
- "httpMethod": "POST",
- "request": {
- "$ref": "AccountstatusesCustomBatchRequest"
- },
- "response": {
- "$ref": "AccountstatusesCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "id": "content.accountstatuses.get",
- "path": "{merchantId}/accountstatuses/{accountId}",
- "httpMethod": "GET",
- "description": "Retrieves the status of a Merchant Center account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The ID of the account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "response": {
- "$ref": "AccountStatus"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "id": "content.accountstatuses.list",
- "path": "{merchantId}/accountstatuses",
- "httpMethod": "GET",
- "description": "Lists the statuses of the sub-accounts in your Merchant Center account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of account statuses to return in the response, used for paging.",
- "format": "uint32",
- "location": "query"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "pageToken": {
- "type": "string",
- "description": "The token returned by the previous request.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "merchantId"
- ],
- "response": {
- "$ref": "AccountstatusesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "accounttax": {
- "methods": {
- "custombatch": {
- "id": "content.accounttax.custombatch",
- "path": "accounttax/batch",
- "httpMethod": "POST",
- "description": "Retrieves and updates tax settings of multiple accounts in a single request.",
- "parameters": {
- "dryRun": {
- "type": "boolean",
- "description": "Flag to run the request in dry-run mode.",
- "location": "query"
- }
- },
- "request": {
- "$ref": "AccounttaxCustomBatchRequest"
- },
- "response": {
- "$ref": "AccounttaxCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "id": "content.accounttax.get",
- "path": "{merchantId}/accounttax/{accountId}",
- "httpMethod": "GET",
- "description": "Retrieves the tax settings of the account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The ID of the account for which to get/update account tax settings.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "response": {
- "$ref": "AccountTax"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "id": "content.accounttax.list",
- "path": "{merchantId}/accounttax",
- "httpMethod": "GET",
- "description": "Lists the tax settings of the sub-accounts in your Merchant Center account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of tax settings to return in the response, used for paging.",
- "format": "uint32",
- "location": "query"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "pageToken": {
- "type": "string",
- "description": "The token returned by the previous request.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "merchantId"
- ],
- "response": {
- "$ref": "AccounttaxListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "patch": {
- "id": "content.accounttax.patch",
- "path": "{merchantId}/accounttax/{accountId}",
- "httpMethod": "PATCH",
- "description": "Updates the tax settings of the account. This method supports patch semantics.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The ID of the account for which to get/update account tax settings.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "dryRun": {
- "type": "boolean",
- "description": "Flag to run the request in dry-run mode.",
- "location": "query"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "request": {
- "$ref": "AccountTax"
- },
- "response": {
- "$ref": "AccountTax"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "update": {
- "id": "content.accounttax.update",
- "path": "{merchantId}/accounttax/{accountId}",
- "httpMethod": "PUT",
- "description": "Updates the tax settings of the account.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "The ID of the account for which to get/update account tax settings.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "dryRun": {
- "type": "boolean",
- "description": "Flag to run the request in dry-run mode.",
- "location": "query"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "request": {
- "$ref": "AccountTax"
- },
- "response": {
- "$ref": "AccountTax"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "datafeeds": {
- "methods": {
- "custombatch": {
- "id": "content.datafeeds.custombatch",
- "path": "datafeeds/batch",
- "httpMethod": "POST",
- "parameters": {
- "dryRun": {
- "type": "boolean",
- "description": "Flag to run the request in dry-run mode.",
- "location": "query"
- }
- },
- "request": {
- "$ref": "DatafeedsCustomBatchRequest"
- },
- "response": {
- "$ref": "DatafeedsCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "delete": {
- "id": "content.datafeeds.delete",
- "path": "{merchantId}/datafeeds/{datafeedId}",
- "httpMethod": "DELETE",
- "description": "Deletes a datafeed from your Merchant Center account.",
- "parameters": {
- "datafeedId": {
- "type": "string",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "dryRun": {
- "type": "boolean",
- "description": "Flag to run the request in dry-run mode.",
- "location": "query"
- },
- "merchantId": {
- "type": "string",
- "required": true,
- "format": "uint64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "datafeedId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "id": "content.datafeeds.get",
- "path": "{merchantId}/datafeeds/{datafeedId}",
- "httpMethod": "GET",
- "description": "Retrieves a datafeed from your Merchant Center account.",
- "parameters": {
- "datafeedId": {
- "type": "string",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "merchantId": {
- "type": "string",
- "required": true,
- "format": "uint64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "datafeedId"
- ],
- "response": {
- "$ref": "Datafeed"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "insert": {
- "id": "content.datafeeds.insert",
- "path": "{merchantId}/datafeeds",
- "httpMethod": "POST",
- "description": "Registers a datafeed with your Merchant Center account.",
- "parameters": {
- "dryRun": {
- "type": "boolean",
- "description": "Flag to run the request in dry-run mode.",
- "location": "query"
- },
- "merchantId": {
- "type": "string",
- "required": true,
- "format": "uint64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId"
- ],
- "request": {
- "$ref": "Datafeed"
- },
- "response": {
- "$ref": "Datafeed"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "id": "content.datafeeds.list",
- "path": "{merchantId}/datafeeds",
- "httpMethod": "GET",
- "description": "Lists the datafeeds in your Merchant Center account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of products to return in the response, used for paging.",
- "format": "uint32",
- "location": "query"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "pageToken": {
- "type": "string",
- "description": "The token returned by the previous request.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "merchantId"
- ],
- "response": {
- "$ref": "DatafeedsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "patch": {
- "id": "content.datafeeds.patch",
- "path": "{merchantId}/datafeeds/{datafeedId}",
- "httpMethod": "PATCH",
- "description": "Updates a datafeed of your Merchant Center account. This method supports patch semantics.",
- "parameters": {
- "datafeedId": {
- "type": "string",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "dryRun": {
- "type": "boolean",
- "description": "Flag to run the request in dry-run mode.",
- "location": "query"
- },
- "merchantId": {
- "type": "string",
- "required": true,
- "format": "uint64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "datafeedId"
- ],
- "request": {
- "$ref": "Datafeed"
- },
- "response": {
- "$ref": "Datafeed"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "update": {
- "id": "content.datafeeds.update",
- "path": "{merchantId}/datafeeds/{datafeedId}",
- "httpMethod": "PUT",
- "description": "Updates a datafeed of your Merchant Center account.",
- "parameters": {
- "datafeedId": {
- "type": "string",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "dryRun": {
- "type": "boolean",
- "description": "Flag to run the request in dry-run mode.",
- "location": "query"
- },
- "merchantId": {
- "type": "string",
- "required": true,
- "format": "uint64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "datafeedId"
- ],
- "request": {
- "$ref": "Datafeed"
- },
- "response": {
- "$ref": "Datafeed"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "datafeedstatuses": {
- "methods": {
- "custombatch": {
- "id": "content.datafeedstatuses.custombatch",
- "path": "datafeedstatuses/batch",
- "httpMethod": "POST",
- "request": {
- "$ref": "DatafeedstatusesCustomBatchRequest"
- },
- "response": {
- "$ref": "DatafeedstatusesCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "id": "content.datafeedstatuses.get",
- "path": "{merchantId}/datafeedstatuses/{datafeedId}",
- "httpMethod": "GET",
- "description": "Retrieves the status of a datafeed from your Merchant Center account.",
- "parameters": {
- "datafeedId": {
- "type": "string",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "merchantId": {
- "type": "string",
- "required": true,
- "format": "uint64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "datafeedId"
- ],
- "response": {
- "$ref": "DatafeedStatus"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "id": "content.datafeedstatuses.list",
- "path": "{merchantId}/datafeedstatuses",
- "httpMethod": "GET",
- "description": "Lists the statuses of the datafeeds in your Merchant Center account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of products to return in the response, used for paging.",
- "format": "uint32",
- "location": "query"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "pageToken": {
- "type": "string",
- "description": "The token returned by the previous request.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "merchantId"
- ],
- "response": {
- "$ref": "DatafeedstatusesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "inventory": {
- "methods": {
- "custombatch": {
- "id": "content.inventory.custombatch",
- "path": "inventory/batch",
- "httpMethod": "POST",
- "description": "Updates price and availability for multiple products or stores in a single request. This operation does not update the expiration date of the products.",
- "parameters": {
- "dryRun": {
- "type": "boolean",
- "description": "Flag to run the request in dry-run mode.",
- "location": "query"
- }
- },
- "request": {
- "$ref": "InventoryCustomBatchRequest"
- },
- "response": {
- "$ref": "InventoryCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "set": {
- "id": "content.inventory.set",
- "path": "{merchantId}/inventory/{storeCode}/products/{productId}",
- "httpMethod": "POST",
- "description": "Updates price and availability of a product in your Merchant Center account. This operation does not update the expiration date of the product.",
- "parameters": {
- "dryRun": {
- "type": "boolean",
- "description": "Flag to run the request in dry-run mode.",
- "location": "query"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "productId": {
- "type": "string",
- "description": "The ID of the product for which to update price and availability.",
- "required": true,
- "location": "path"
- },
- "storeCode": {
- "type": "string",
- "description": "The code of the store for which to update price and availability. Use online to update price and availability of an online product.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "storeCode",
- "productId"
- ],
- "request": {
- "$ref": "InventorySetRequest"
- },
- "response": {
- "$ref": "InventorySetResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "orders": {
- "methods": {
- "acknowledge": {
- "id": "content.orders.acknowledge",
- "path": "{merchantId}/orders/{orderId}/acknowledge",
- "httpMethod": "POST",
- "description": "Marks an order as acknowledged.",
- "parameters": {
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "orderId": {
- "type": "string",
- "description": "The ID of the order.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "request": {
- "$ref": "OrdersAcknowledgeRequest"
- },
- "response": {
- "$ref": "OrdersAcknowledgeResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "advancetestorder": {
- "id": "content.orders.advancetestorder",
- "path": "{merchantId}/testorders/{orderId}/advance",
- "httpMethod": "POST",
- "description": "Sandbox only. Moves a test order from state \"inProgress\" to state \"pendingShipment\".",
- "parameters": {
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "orderId": {
- "type": "string",
- "description": "The ID of the test order to modify.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "response": {
- "$ref": "OrdersAdvanceTestOrderResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "cancel": {
- "id": "content.orders.cancel",
- "path": "{merchantId}/orders/{orderId}/cancel",
- "httpMethod": "POST",
- "description": "Cancels all line items in an order.",
- "parameters": {
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "orderId": {
- "type": "string",
- "description": "The ID of the order to cancel.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "request": {
- "$ref": "OrdersCancelRequest"
- },
- "response": {
- "$ref": "OrdersCancelResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "cancellineitem": {
- "id": "content.orders.cancellineitem",
- "path": "{merchantId}/orders/{orderId}/cancelLineItem",
- "httpMethod": "POST",
- "description": "Cancels a line item.",
- "parameters": {
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "orderId": {
- "type": "string",
- "description": "The ID of the order.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "request": {
- "$ref": "OrdersCancelLineItemRequest"
- },
- "response": {
- "$ref": "OrdersCancelLineItemResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "createtestorder": {
- "id": "content.orders.createtestorder",
- "path": "{merchantId}/testorders",
- "httpMethod": "POST",
- "description": "Sandbox only. Creates a test order.",
- "parameters": {
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId"
- ],
- "request": {
- "$ref": "OrdersCreateTestOrderRequest"
- },
- "response": {
- "$ref": "OrdersCreateTestOrderResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "custombatch": {
- "id": "content.orders.custombatch",
- "path": "orders/batch",
- "httpMethod": "POST",
- "description": "Retrieves or modifies multiple orders in a single request.",
- "request": {
- "$ref": "OrdersCustomBatchRequest"
- },
- "response": {
- "$ref": "OrdersCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "id": "content.orders.get",
- "path": "{merchantId}/orders/{orderId}",
- "httpMethod": "GET",
- "description": "Retrieves an order from your Merchant Center account.",
- "parameters": {
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "orderId": {
- "type": "string",
- "description": "The ID of the order.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "response": {
- "$ref": "Order"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "getbymerchantorderid": {
- "id": "content.orders.getbymerchantorderid",
- "path": "{merchantId}/ordersbymerchantid/{merchantOrderId}",
- "httpMethod": "GET",
- "description": "Retrieves an order using merchant order id.",
- "parameters": {
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "merchantOrderId": {
- "type": "string",
- "description": "The merchant order id to be looked for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "merchantOrderId"
- ],
- "response": {
- "$ref": "OrdersGetByMerchantOrderIdResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "gettestordertemplate": {
- "id": "content.orders.gettestordertemplate",
- "path": "{merchantId}/testordertemplates/{templateName}",
- "httpMethod": "GET",
- "description": "Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.",
- "parameters": {
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "templateName": {
- "type": "string",
- "description": "The name of the template to retrieve.",
- "required": true,
- "enum": [
- "template1",
- "template2"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "templateName"
- ],
- "response": {
- "$ref": "OrdersGetTestOrderTemplateResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "id": "content.orders.list",
- "path": "{merchantId}/orders",
- "httpMethod": "GET",
- "description": "Lists the orders in your Merchant Center account.",
- "parameters": {
- "acknowledged": {
- "type": "boolean",
- "description": "Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged.\nWe recommend using this filter set to false, in conjunction with the acknowledge call, such that only un-acknowledged orders are returned.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.\nKnown issue: All List calls will return all Orders without limit regardless of the value of this field.",
- "format": "uint32",
- "location": "query"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "orderBy": {
- "type": "string",
- "description": "The ordering of the returned list. The only supported value are placedDate desc and placedDate asc for now, which returns orders sorted by placement date. \"placedDate desc\" stands for listing orders by placement date, from oldest to most recent. \"placedDate asc\" stands for listing orders by placement date, from most recent to oldest. In future releases we'll support other sorting criteria.",
- "enum": [
- "placedDate asc",
- "placedDate desc"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The token returned by the previous request.",
- "location": "query"
- },
- "placedDateEnd": {
- "type": "string",
- "description": "Obtains orders placed before this date (exclusively), in ISO 8601 format.",
- "location": "query"
- },
- "placedDateStart": {
- "type": "string",
- "description": "Obtains orders placed after this date (inclusively), in ISO 8601 format.",
- "location": "query"
- },
- "statuses": {
- "type": "string",
- "description": "Obtains orders that match any of the specified statuses. Multiple values can be specified with comma separation. Additionally, please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped , partiallyDelivered, delivered, partiallyReturned, returned, and canceled.",
- "enum": [
- "active",
- "canceled",
- "completed",
- "delivered",
- "inProgress",
- "partiallyDelivered",
- "partiallyReturned",
- "partiallyShipped",
- "pendingShipment",
- "returned",
- "shipped"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "merchantId"
- ],
- "response": {
- "$ref": "OrdersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "refund": {
- "id": "content.orders.refund",
- "path": "{merchantId}/orders/{orderId}/refund",
- "httpMethod": "POST",
- "description": "Refund a portion of the order, up to the full amount paid.",
- "parameters": {
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "orderId": {
- "type": "string",
- "description": "The ID of the order to refund.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "request": {
- "$ref": "OrdersRefundRequest"
- },
- "response": {
- "$ref": "OrdersRefundResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "returnlineitem": {
- "id": "content.orders.returnlineitem",
- "path": "{merchantId}/orders/{orderId}/returnLineItem",
- "httpMethod": "POST",
- "description": "Returns a line item.",
- "parameters": {
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "orderId": {
- "type": "string",
- "description": "The ID of the order.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "request": {
- "$ref": "OrdersReturnLineItemRequest"
- },
- "response": {
- "$ref": "OrdersReturnLineItemResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "shiplineitems": {
- "id": "content.orders.shiplineitems",
- "path": "{merchantId}/orders/{orderId}/shipLineItems",
- "httpMethod": "POST",
- "description": "Marks line item(s) as shipped.",
- "parameters": {
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "orderId": {
- "type": "string",
- "description": "The ID of the order.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "request": {
- "$ref": "OrdersShipLineItemsRequest"
- },
- "response": {
- "$ref": "OrdersShipLineItemsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "updatemerchantorderid": {
- "id": "content.orders.updatemerchantorderid",
- "path": "{merchantId}/orders/{orderId}/updateMerchantOrderId",
- "httpMethod": "POST",
- "description": "Updates the merchant order ID for a given order.",
- "parameters": {
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "orderId": {
- "type": "string",
- "description": "The ID of the order.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "request": {
- "$ref": "OrdersUpdateMerchantOrderIdRequest"
- },
- "response": {
- "$ref": "OrdersUpdateMerchantOrderIdResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "updateshipment": {
- "id": "content.orders.updateshipment",
- "path": "{merchantId}/orders/{orderId}/updateShipment",
- "httpMethod": "POST",
- "description": "Updates a shipment's status, carrier, and/or tracking ID.",
- "parameters": {
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "orderId": {
- "type": "string",
- "description": "The ID of the order.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "request": {
- "$ref": "OrdersUpdateShipmentRequest"
- },
- "response": {
- "$ref": "OrdersUpdateShipmentResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "products": {
- "methods": {
- "custombatch": {
- "id": "content.products.custombatch",
- "path": "products/batch",
- "httpMethod": "POST",
- "description": "Retrieves, inserts, and deletes multiple products in a single request.",
- "parameters": {
- "dryRun": {
- "type": "boolean",
- "description": "Flag to run the request in dry-run mode.",
- "location": "query"
- }
- },
- "request": {
- "$ref": "ProductsCustomBatchRequest"
- },
- "response": {
- "$ref": "ProductsCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "delete": {
- "id": "content.products.delete",
- "path": "{merchantId}/products/{productId}",
- "httpMethod": "DELETE",
- "description": "Deletes a product from your Merchant Center account.",
- "parameters": {
- "dryRun": {
- "type": "boolean",
- "description": "Flag to run the request in dry-run mode.",
- "location": "query"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "productId": {
- "type": "string",
- "description": "The ID of the product.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "productId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "id": "content.products.get",
- "path": "{merchantId}/products/{productId}",
- "httpMethod": "GET",
- "description": "Retrieves a product from your Merchant Center account.",
- "parameters": {
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "productId": {
- "type": "string",
- "description": "The ID of the product.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "productId"
- ],
- "response": {
- "$ref": "Product"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "insert": {
- "id": "content.products.insert",
- "path": "{merchantId}/products",
- "httpMethod": "POST",
- "description": "Uploads a product to your Merchant Center account.",
- "parameters": {
- "dryRun": {
- "type": "boolean",
- "description": "Flag to run the request in dry-run mode.",
- "location": "query"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId"
- ],
- "request": {
- "$ref": "Product"
- },
- "response": {
- "$ref": "Product"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "id": "content.products.list",
- "path": "{merchantId}/products",
- "httpMethod": "GET",
- "description": "Lists the products in your Merchant Center account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of products to return in the response, used for paging.",
- "format": "uint32",
- "location": "query"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "pageToken": {
- "type": "string",
- "description": "The token returned by the previous request.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "merchantId"
- ],
- "response": {
- "$ref": "ProductsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "productstatuses": {
- "methods": {
- "custombatch": {
- "id": "content.productstatuses.custombatch",
- "path": "productstatuses/batch",
- "httpMethod": "POST",
- "description": "Gets the statuses of multiple products in a single request.",
- "request": {
- "$ref": "ProductstatusesCustomBatchRequest"
- },
- "response": {
- "$ref": "ProductstatusesCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "id": "content.productstatuses.get",
- "path": "{merchantId}/productstatuses/{productId}",
- "httpMethod": "GET",
- "description": "Gets the status of a product from your Merchant Center account.",
- "parameters": {
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "productId": {
- "type": "string",
- "description": "The ID of the product.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "productId"
- ],
- "response": {
- "$ref": "ProductStatus"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "id": "content.productstatuses.list",
- "path": "{merchantId}/productstatuses",
- "httpMethod": "GET",
- "description": "Lists the statuses of the products in your Merchant Center account.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of product statuses to return in the response, used for paging.",
- "format": "uint32",
- "location": "query"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "pageToken": {
- "type": "string",
- "description": "The token returned by the previous request.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "merchantId"
- ],
- "response": {
- "$ref": "ProductstatusesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/content/v2/content-gen.go b/vendor/google.golang.org/api/content/v2/content-gen.go
deleted file mode 100644
index 3fba8101..00000000
--- a/vendor/google.golang.org/api/content/v2/content-gen.go
+++ /dev/null
@@ -1,12832 +0,0 @@
-// Package content provides access to the Content API for Shopping.
-//
-// See https://developers.google.com/shopping-content
-//
-// Usage example:
-//
-// import "google.golang.org/api/content/v2"
-// ...
-// contentService, err := content.New(oauthHttpClient)
-package content // import "google.golang.org/api/content/v2"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "content:v2"
-const apiName = "content"
-const apiVersion = "v2"
-const basePath = "https://www.googleapis.com/content/v2/"
-
-// OAuth2 scopes used by this API.
-const (
- // Manage your product listings and accounts for Google Shopping
- ContentScope = "https://www.googleapis.com/auth/content"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Accounts = NewAccountsService(s)
- s.Accountshipping = NewAccountshippingService(s)
- s.Accountstatuses = NewAccountstatusesService(s)
- s.Accounttax = NewAccounttaxService(s)
- s.Datafeeds = NewDatafeedsService(s)
- s.Datafeedstatuses = NewDatafeedstatusesService(s)
- s.Inventory = NewInventoryService(s)
- s.Orders = NewOrdersService(s)
- s.Products = NewProductsService(s)
- s.Productstatuses = NewProductstatusesService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Accounts *AccountsService
-
- Accountshipping *AccountshippingService
-
- Accountstatuses *AccountstatusesService
-
- Accounttax *AccounttaxService
-
- Datafeeds *DatafeedsService
-
- Datafeedstatuses *DatafeedstatusesService
-
- Inventory *InventoryService
-
- Orders *OrdersService
-
- Products *ProductsService
-
- Productstatuses *ProductstatusesService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewAccountsService(s *Service) *AccountsService {
- rs := &AccountsService{s: s}
- return rs
-}
-
-type AccountsService struct {
- s *Service
-}
-
-func NewAccountshippingService(s *Service) *AccountshippingService {
- rs := &AccountshippingService{s: s}
- return rs
-}
-
-type AccountshippingService struct {
- s *Service
-}
-
-func NewAccountstatusesService(s *Service) *AccountstatusesService {
- rs := &AccountstatusesService{s: s}
- return rs
-}
-
-type AccountstatusesService struct {
- s *Service
-}
-
-func NewAccounttaxService(s *Service) *AccounttaxService {
- rs := &AccounttaxService{s: s}
- return rs
-}
-
-type AccounttaxService struct {
- s *Service
-}
-
-func NewDatafeedsService(s *Service) *DatafeedsService {
- rs := &DatafeedsService{s: s}
- return rs
-}
-
-type DatafeedsService struct {
- s *Service
-}
-
-func NewDatafeedstatusesService(s *Service) *DatafeedstatusesService {
- rs := &DatafeedstatusesService{s: s}
- return rs
-}
-
-type DatafeedstatusesService struct {
- s *Service
-}
-
-func NewInventoryService(s *Service) *InventoryService {
- rs := &InventoryService{s: s}
- return rs
-}
-
-type InventoryService struct {
- s *Service
-}
-
-func NewOrdersService(s *Service) *OrdersService {
- rs := &OrdersService{s: s}
- return rs
-}
-
-type OrdersService struct {
- s *Service
-}
-
-func NewProductsService(s *Service) *ProductsService {
- rs := &ProductsService{s: s}
- return rs
-}
-
-type ProductsService struct {
- s *Service
-}
-
-func NewProductstatusesService(s *Service) *ProductstatusesService {
- rs := &ProductstatusesService{s: s}
- return rs
-}
-
-type ProductstatusesService struct {
- s *Service
-}
-
-// Account: Account data.
-type Account struct {
- // AdultContent: Indicates whether the merchant sells adult content.
- AdultContent bool `json:"adultContent,omitempty"`
-
- // AdwordsLinks: List of linked AdWords accounts, active or pending
- // approval. To create a new link request, add a new link with status
- // active to the list. It will remain is state pending until approved or
- // rejected in the AdWords interface. To delete an active link or to
- // cancel a link request, remove it from the list.
- AdwordsLinks []*AccountAdwordsLink `json:"adwordsLinks,omitempty"`
-
- // Id: Merchant Center account ID.
- Id uint64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#account".
- Kind string `json:"kind,omitempty"`
-
- // Name: Display name for the account.
- Name string `json:"name,omitempty"`
-
- // ReviewsUrl: URL for individual seller reviews, i.e., reviews for each
- // child account.
- ReviewsUrl string `json:"reviewsUrl,omitempty"`
-
- // SellerId: Client-specific, locally-unique, internal ID for the child
- // account.
- SellerId string `json:"sellerId,omitempty"`
-
- // Users: Users with access to the account. Every account (except for
- // subaccounts) must have at least one admin user.
- Users []*AccountUser `json:"users,omitempty"`
-
- // WebsiteUrl: The merchant's website.
- WebsiteUrl string `json:"websiteUrl,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AdultContent") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Account) MarshalJSON() ([]byte, error) {
- type noMethod Account
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AccountAdwordsLink struct {
- // AdwordsId: Customer ID of the AdWords account.
- AdwordsId uint64 `json:"adwordsId,omitempty,string"`
-
- // Status: Status of the link between this Merchant Center account and
- // the AdWords account. Upon retrieval, it represents the actual status
- // of the link and can be either active if it was approved in Google
- // AdWords or pending if it's pending approval. Upon insertion, it
- // represents the intended status of the link. Re-uploading a link with
- // status active when it's still pending or with status pending when
- // it's already active will have no effect: the status will remain
- // unchanged. Re-uploading a link with deprecated status inactive is
- // equivalent to not submitting the link at all and will delete the link
- // if it was active or cancel the link request if it was pending.
- Status string `json:"status,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AdwordsId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountAdwordsLink) MarshalJSON() ([]byte, error) {
- type noMethod AccountAdwordsLink
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AccountIdentifier struct {
- // AggregatorId: The aggregator ID, set for aggregators and subaccounts
- // (in that case, it represents the aggregator of the subaccount).
- AggregatorId uint64 `json:"aggregatorId,omitempty,string"`
-
- // MerchantId: The merchant account ID, set for individual accounts and
- // subaccounts.
- MerchantId uint64 `json:"merchantId,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "AggregatorId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountIdentifier) MarshalJSON() ([]byte, error) {
- type noMethod AccountIdentifier
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountShipping: The shipping settings of a merchant account.
-type AccountShipping struct {
- // AccountId: The ID of the account to which these account shipping
- // settings belong.
- AccountId uint64 `json:"accountId,omitempty,string"`
-
- // CarrierRates: Carrier-based shipping calculations.
- CarrierRates []*AccountShippingCarrierRate `json:"carrierRates,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#accountShipping".
- Kind string `json:"kind,omitempty"`
-
- // LocationGroups: Location groups for shipping.
- LocationGroups []*AccountShippingLocationGroup `json:"locationGroups,omitempty"`
-
- // RateTables: Rate tables definitions.
- RateTables []*AccountShippingRateTable `json:"rateTables,omitempty"`
-
- // Services: Shipping services describing shipping fees calculation.
- Services []*AccountShippingShippingService `json:"services,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountShipping) MarshalJSON() ([]byte, error) {
- type noMethod AccountShipping
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountShippingCarrierRate: A carrier-calculated shipping rate.
-type AccountShippingCarrierRate struct {
- // Carrier: The carrier that is responsible for the shipping, such as
- // "UPS", "FedEx", or "USPS".
- Carrier string `json:"carrier,omitempty"`
-
- // CarrierService: The carrier service, such as "Ground" or "2Day".
- CarrierService string `json:"carrierService,omitempty"`
-
- // ModifierFlatRate: Additive shipping rate modifier.
- ModifierFlatRate *Price `json:"modifierFlatRate,omitempty"`
-
- // ModifierPercent: Multiplicative shipping rate modifier in percent.
- // Represented as a floating point number without the percentage
- // character.
- ModifierPercent string `json:"modifierPercent,omitempty"`
-
- // Name: The name of the carrier rate.
- Name string `json:"name,omitempty"`
-
- // SaleCountry: The sale country for which this carrier rate is valid,
- // represented as a CLDR territory code.
- SaleCountry string `json:"saleCountry,omitempty"`
-
- // ShippingOrigin: Shipping origin represented as a postal code.
- ShippingOrigin string `json:"shippingOrigin,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Carrier") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountShippingCarrierRate) MarshalJSON() ([]byte, error) {
- type noMethod AccountShippingCarrierRate
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AccountShippingCondition struct {
- // DeliveryLocationGroup: Delivery location in terms of a location group
- // name. A location group with this name must be specified among
- // location groups.
- DeliveryLocationGroup string `json:"deliveryLocationGroup,omitempty"`
-
- // DeliveryLocationId: Delivery location in terms of a location ID. Can
- // be used to represent administrative areas, smaller country
- // subdivisions, or cities.
- DeliveryLocationId int64 `json:"deliveryLocationId,omitempty,string"`
-
- // DeliveryPostalCode: Delivery location in terms of a postal code.
- DeliveryPostalCode string `json:"deliveryPostalCode,omitempty"`
-
- // DeliveryPostalCodeRange: Delivery location in terms of a postal code
- // range.
- DeliveryPostalCodeRange *AccountShippingPostalCodeRange `json:"deliveryPostalCodeRange,omitempty"`
-
- // PriceMax: Maximum shipping price. Forms an interval between the
- // maximum of smaller prices (exclusive) and this price (inclusive).
- PriceMax *Price `json:"priceMax,omitempty"`
-
- // ShippingLabel: Shipping label of the product. The products with the
- // label are matched.
- ShippingLabel string `json:"shippingLabel,omitempty"`
-
- // WeightMax: Maximum shipping weight. Forms an interval between the
- // maximum of smaller weight (exclusive) and this weight (inclusive).
- WeightMax *Weight `json:"weightMax,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "DeliveryLocationGroup") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountShippingCondition) MarshalJSON() ([]byte, error) {
- type noMethod AccountShippingCondition
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountShippingLocationGroup: A user-defined locations group in a
-// given country. All the locations of the group must be of the same
-// type.
-type AccountShippingLocationGroup struct {
- // Country: The CLDR territory code of the country in which this
- // location group is.
- Country string `json:"country,omitempty"`
-
- // LocationIds: A location ID (also called criteria ID) representing
- // administrative areas, smaller country subdivisions (counties), or
- // cities.
- LocationIds googleapi.Int64s `json:"locationIds,omitempty"`
-
- // Name: The name of the location group.
- Name string `json:"name,omitempty"`
-
- // PostalCodeRanges: A postal code range representing a city or a set of
- // cities.
- PostalCodeRanges []*AccountShippingPostalCodeRange `json:"postalCodeRanges,omitempty"`
-
- // PostalCodes: A postal code representing a city or a set of cities.
- //
- // - A single postal code (e.g., 12345)
- // - A postal code prefix followed by a star (e.g., 1234*)
- PostalCodes []string `json:"postalCodes,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Country") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountShippingLocationGroup) MarshalJSON() ([]byte, error) {
- type noMethod AccountShippingLocationGroup
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountShippingPostalCodeRange: A postal code range, that can be
-// either:
-// - A range of postal codes (e.g., start=12340, end=12359)
-// - A range of postal codes prefixes (e.g., start=1234* end=1235*).
-// Prefixes must be of the same length (e.g., start=12* end=2* is
-// invalid).
-type AccountShippingPostalCodeRange struct {
- // End: The last (inclusive) postal code or prefix of the range.
- End string `json:"end,omitempty"`
-
- // Start: The first (inclusive) postal code or prefix of the range.
- Start string `json:"start,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "End") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountShippingPostalCodeRange) MarshalJSON() ([]byte, error) {
- type noMethod AccountShippingPostalCodeRange
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountShippingRateTable: A single or bi-dimensional table of
-// shipping rates. Each dimension is defined in terms of consecutive
-// price/weight ranges, delivery locations, or shipping labels.
-type AccountShippingRateTable struct {
- // Content: One-dimensional table cells define one condition along the
- // same dimension. Bi-dimensional table cells use two dimensions with
- // respectively M and N distinct values and must contain exactly M * N
- // cells with distinct conditions (for each possible value pairs).
- Content []*AccountShippingRateTableCell `json:"content,omitempty"`
-
- // Name: The name of the rate table.
- Name string `json:"name,omitempty"`
-
- // SaleCountry: The sale country for which this table is valid,
- // represented as a CLDR territory code.
- SaleCountry string `json:"saleCountry,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Content") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountShippingRateTable) MarshalJSON() ([]byte, error) {
- type noMethod AccountShippingRateTable
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AccountShippingRateTableCell struct {
- // Condition: Conditions for which the cell is valid. All cells in a
- // table must use the same dimension or pair of dimensions among price,
- // weight, shipping label or delivery location. If no condition is
- // specified, the cell acts as a catch-all and matches all the elements
- // that are not matched by other cells in this dimension.
- Condition *AccountShippingCondition `json:"condition,omitempty"`
-
- // Rate: The rate applicable if the cell conditions are matched.
- Rate *Price `json:"rate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Condition") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountShippingRateTableCell) MarshalJSON() ([]byte, error) {
- type noMethod AccountShippingRateTableCell
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountShippingShippingService: Shipping services provided in a
-// country.
-type AccountShippingShippingService struct {
- // Active: Whether the shipping service is available.
- Active bool `json:"active,omitempty"`
-
- // CalculationMethod: Calculation method for the "simple" case that
- // needs no rules.
- CalculationMethod *AccountShippingShippingServiceCalculationMethod `json:"calculationMethod,omitempty"`
-
- // CostRuleTree: Decision tree for "complicated" shipping cost
- // calculation.
- CostRuleTree *AccountShippingShippingServiceCostRule `json:"costRuleTree,omitempty"`
-
- // Name: The name of this shipping service.
- Name string `json:"name,omitempty"`
-
- // SaleCountry: The CLDR territory code of the sale country for which
- // this service can be used.
- SaleCountry string `json:"saleCountry,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Active") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountShippingShippingService) MarshalJSON() ([]byte, error) {
- type noMethod AccountShippingShippingService
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountShippingShippingServiceCalculationMethod: Shipping cost
-// calculation method. Exactly one of the field is set.
-type AccountShippingShippingServiceCalculationMethod struct {
- // CarrierRate: Name of the carrier rate to use for the calculation.
- CarrierRate string `json:"carrierRate,omitempty"`
-
- // Excluded: Delivery is excluded. Valid only within cost rules tree.
- Excluded bool `json:"excluded,omitempty"`
-
- // FlatRate: Fixed price shipping, represented as a floating point
- // number associated with a currency.
- FlatRate *Price `json:"flatRate,omitempty"`
-
- // PercentageRate: Percentage of the price, represented as a floating
- // point number without the percentage character.
- PercentageRate string `json:"percentageRate,omitempty"`
-
- // RateTable: Name of the rate table to use for the calculation.
- RateTable string `json:"rateTable,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CarrierRate") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountShippingShippingServiceCalculationMethod) MarshalJSON() ([]byte, error) {
- type noMethod AccountShippingShippingServiceCalculationMethod
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountShippingShippingServiceCostRule: Building block of the cost
-// calculation decision tree.
-// - The tree root should have no condition and no calculation method.
-// - All the children must have a condition on the same dimension. The
-// first child matching a condition is entered, therefore, price and
-// weight conditions form contiguous intervals.
-// - The last child of an element must have no condition and matches all
-// elements not previously matched.
-// - Children and calculation method are mutually exclusive, and exactly
-// one of them must be defined; the root must only have children.
-type AccountShippingShippingServiceCostRule struct {
- // CalculationMethod: Final calculation method to be used only in leaf
- // nodes.
- CalculationMethod *AccountShippingShippingServiceCalculationMethod `json:"calculationMethod,omitempty"`
-
- // Children: Subsequent rules to be applied, only for inner nodes. The
- // last child must not specify a condition and acts as a catch-all.
- Children []*AccountShippingShippingServiceCostRule `json:"children,omitempty"`
-
- // Condition: Condition for this rule to be applicable. If no condition
- // is specified, the rule acts as a catch-all.
- Condition *AccountShippingCondition `json:"condition,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CalculationMethod")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountShippingShippingServiceCostRule) MarshalJSON() ([]byte, error) {
- type noMethod AccountShippingShippingServiceCostRule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountStatus: The status of an account, i.e., information about its
-// products, which is computed offline and not returned immediately at
-// insertion time.
-type AccountStatus struct {
- // AccountId: The ID of the account for which the status is reported.
- AccountId string `json:"accountId,omitempty"`
-
- // DataQualityIssues: A list of data quality issues.
- DataQualityIssues []*AccountStatusDataQualityIssue `json:"dataQualityIssues,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#accountStatus".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountStatus) MarshalJSON() ([]byte, error) {
- type noMethod AccountStatus
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AccountStatusDataQualityIssue struct {
- // Country: Country for which this issue is reported.
- Country string `json:"country,omitempty"`
-
- // DisplayedValue: Actual value displayed on the landing page.
- DisplayedValue string `json:"displayedValue,omitempty"`
-
- // ExampleItems: Example items featuring the issue.
- ExampleItems []*AccountStatusExampleItem `json:"exampleItems,omitempty"`
-
- // Id: Issue identifier.
- Id string `json:"id,omitempty"`
-
- // LastChecked: Last time the account was checked for this issue.
- LastChecked string `json:"lastChecked,omitempty"`
-
- // NumItems: Number of items in the account found to have the said
- // issue.
- NumItems int64 `json:"numItems,omitempty"`
-
- // Severity: Severity of the problem.
- Severity string `json:"severity,omitempty"`
-
- // SubmittedValue: Submitted value that causes the issue.
- SubmittedValue string `json:"submittedValue,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Country") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountStatusDataQualityIssue) MarshalJSON() ([]byte, error) {
- type noMethod AccountStatusDataQualityIssue
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountStatusExampleItem: An example of an item that has poor data
-// quality. An item value on the landing page differs from what is
-// submitted, or conflicts with a policy.
-type AccountStatusExampleItem struct {
- // ItemId: Unique item ID as specified in the uploaded product data.
- ItemId string `json:"itemId,omitempty"`
-
- // Link: Landing page of the item.
- Link string `json:"link,omitempty"`
-
- // SubmittedValue: The item value that was submitted.
- SubmittedValue string `json:"submittedValue,omitempty"`
-
- // Title: Title of the item.
- Title string `json:"title,omitempty"`
-
- // ValueOnLandingPage: The actual value on the landing page.
- ValueOnLandingPage string `json:"valueOnLandingPage,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ItemId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountStatusExampleItem) MarshalJSON() ([]byte, error) {
- type noMethod AccountStatusExampleItem
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountTax: The tax settings of a merchant account.
-type AccountTax struct {
- // AccountId: The ID of the account to which these account tax settings
- // belong.
- AccountId uint64 `json:"accountId,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#accountTax".
- Kind string `json:"kind,omitempty"`
-
- // Rules: Tax rules. Updating the tax rules will enable US taxes (not
- // reversible). Defining no rules is equivalent to not charging tax at
- // all.
- Rules []*AccountTaxTaxRule `json:"rules,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountTax) MarshalJSON() ([]byte, error) {
- type noMethod AccountTax
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountTaxTaxRule: Tax calculation rule to apply in a state or
-// province (USA only).
-type AccountTaxTaxRule struct {
- // Country: Country code in which tax is applicable.
- Country string `json:"country,omitempty"`
-
- // LocationId: State (or province) is which the tax is applicable,
- // described by its location id (also called criteria id).
- LocationId uint64 `json:"locationId,omitempty,string"`
-
- // RatePercent: Explicit tax rate in percent, represented as a floating
- // point number without the percentage character. Must not be negative.
- RatePercent string `json:"ratePercent,omitempty"`
-
- // ShippingTaxed: If true, shipping charges are also taxed.
- ShippingTaxed bool `json:"shippingTaxed,omitempty"`
-
- // UseGlobalRate: Whether the tax rate is taken from a global tax table
- // or specified explicitly.
- UseGlobalRate bool `json:"useGlobalRate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Country") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountTaxTaxRule) MarshalJSON() ([]byte, error) {
- type noMethod AccountTaxTaxRule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AccountUser struct {
- // Admin: Whether user is an admin.
- Admin *bool `json:"admin,omitempty"`
-
- // EmailAddress: User's email address.
- EmailAddress string `json:"emailAddress,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Admin") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountUser) MarshalJSON() ([]byte, error) {
- type noMethod AccountUser
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AccountsAuthInfoResponse struct {
- // AccountIdentifiers: The account identifiers corresponding to the
- // authenticated user.
- // - For an individual account: only the merchant ID is defined
- // - For an aggregator: only the aggregator ID is defined
- // - For a subaccount of an MCA: both the merchant ID and the aggregator
- // ID are defined.
- AccountIdentifiers []*AccountIdentifier `json:"accountIdentifiers,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#accountsAuthInfoResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountIdentifiers")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountsAuthInfoResponse) MarshalJSON() ([]byte, error) {
- type noMethod AccountsAuthInfoResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AccountsCustomBatchRequest struct {
- // Entries: The request entries to be processed in the batch.
- Entries []*AccountsCustomBatchRequestEntry `json:"entries,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Entries") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountsCustomBatchRequest) MarshalJSON() ([]byte, error) {
- type noMethod AccountsCustomBatchRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountsCustomBatchRequestEntry: A batch entry encoding a single
-// non-batch accounts request.
-type AccountsCustomBatchRequestEntry struct {
- // Account: The account to create or update. Only defined if the method
- // is insert or update.
- Account *Account `json:"account,omitempty"`
-
- // AccountId: The ID of the account to get or delete. Only defined if
- // the method is get or delete.
- AccountId uint64 `json:"accountId,omitempty,string"`
-
- // BatchId: An entry ID, unique within the batch request.
- BatchId int64 `json:"batchId,omitempty"`
-
- // MerchantId: The ID of the managing account.
- MerchantId uint64 `json:"merchantId,omitempty,string"`
-
- Method string `json:"method,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Account") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountsCustomBatchRequestEntry) MarshalJSON() ([]byte, error) {
- type noMethod AccountsCustomBatchRequestEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AccountsCustomBatchResponse struct {
- // Entries: The result of the execution of the batch requests.
- Entries []*AccountsCustomBatchResponseEntry `json:"entries,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#accountsCustomBatchResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Entries") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountsCustomBatchResponse) MarshalJSON() ([]byte, error) {
- type noMethod AccountsCustomBatchResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountsCustomBatchResponseEntry: A batch entry encoding a single
-// non-batch accounts response.
-type AccountsCustomBatchResponseEntry struct {
- // Account: The retrieved, created, or updated account. Not defined if
- // the method was delete.
- Account *Account `json:"account,omitempty"`
-
- // BatchId: The ID of the request entry this entry responds to.
- BatchId int64 `json:"batchId,omitempty"`
-
- // Errors: A list of errors defined if and only if the request failed.
- Errors *Errors `json:"errors,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#accountsCustomBatchResponseEntry".
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Account") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountsCustomBatchResponseEntry) MarshalJSON() ([]byte, error) {
- type noMethod AccountsCustomBatchResponseEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AccountsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#accountsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: The token for the retrieval of the next page of
- // accounts.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- Resources []*Account `json:"resources,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod AccountsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AccountshippingCustomBatchRequest struct {
- // Entries: The request entries to be processed in the batch.
- Entries []*AccountshippingCustomBatchRequestEntry `json:"entries,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Entries") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountshippingCustomBatchRequest) MarshalJSON() ([]byte, error) {
- type noMethod AccountshippingCustomBatchRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountshippingCustomBatchRequestEntry: A batch entry encoding a
-// single non-batch accountshipping request.
-type AccountshippingCustomBatchRequestEntry struct {
- // AccountId: The ID of the account for which to get/update account
- // shipping settings.
- AccountId uint64 `json:"accountId,omitempty,string"`
-
- // AccountShipping: The account shipping settings to update. Only
- // defined if the method is update.
- AccountShipping *AccountShipping `json:"accountShipping,omitempty"`
-
- // BatchId: An entry ID, unique within the batch request.
- BatchId int64 `json:"batchId,omitempty"`
-
- // MerchantId: The ID of the managing account.
- MerchantId uint64 `json:"merchantId,omitempty,string"`
-
- Method string `json:"method,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountshippingCustomBatchRequestEntry) MarshalJSON() ([]byte, error) {
- type noMethod AccountshippingCustomBatchRequestEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AccountshippingCustomBatchResponse struct {
- // Entries: The result of the execution of the batch requests.
- Entries []*AccountshippingCustomBatchResponseEntry `json:"entries,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#accountshippingCustomBatchResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Entries") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountshippingCustomBatchResponse) MarshalJSON() ([]byte, error) {
- type noMethod AccountshippingCustomBatchResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountshippingCustomBatchResponseEntry: A batch entry encoding a
-// single non-batch accountshipping response.
-type AccountshippingCustomBatchResponseEntry struct {
- // AccountShipping: The retrieved or updated account shipping settings.
- AccountShipping *AccountShipping `json:"accountShipping,omitempty"`
-
- // BatchId: The ID of the request entry this entry responds to.
- BatchId int64 `json:"batchId,omitempty"`
-
- // Errors: A list of errors defined if and only if the request failed.
- Errors *Errors `json:"errors,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#accountshippingCustomBatchResponseEntry".
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AccountShipping") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountshippingCustomBatchResponseEntry) MarshalJSON() ([]byte, error) {
- type noMethod AccountshippingCustomBatchResponseEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AccountshippingListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#accountshippingListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: The token for the retrieval of the next page of
- // account shipping settings.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- Resources []*AccountShipping `json:"resources,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountshippingListResponse) MarshalJSON() ([]byte, error) {
- type noMethod AccountshippingListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AccountstatusesCustomBatchRequest struct {
- // Entries: The request entries to be processed in the batch.
- Entries []*AccountstatusesCustomBatchRequestEntry `json:"entries,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Entries") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountstatusesCustomBatchRequest) MarshalJSON() ([]byte, error) {
- type noMethod AccountstatusesCustomBatchRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountstatusesCustomBatchRequestEntry: A batch entry encoding a
-// single non-batch accountstatuses request.
-type AccountstatusesCustomBatchRequestEntry struct {
- // AccountId: The ID of the (sub-)account whose status to get.
- AccountId uint64 `json:"accountId,omitempty,string"`
-
- // BatchId: An entry ID, unique within the batch request.
- BatchId int64 `json:"batchId,omitempty"`
-
- // MerchantId: The ID of the managing account.
- MerchantId uint64 `json:"merchantId,omitempty,string"`
-
- // Method: The method (get).
- Method string `json:"method,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountstatusesCustomBatchRequestEntry) MarshalJSON() ([]byte, error) {
- type noMethod AccountstatusesCustomBatchRequestEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AccountstatusesCustomBatchResponse struct {
- // Entries: The result of the execution of the batch requests.
- Entries []*AccountstatusesCustomBatchResponseEntry `json:"entries,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#accountstatusesCustomBatchResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Entries") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountstatusesCustomBatchResponse) MarshalJSON() ([]byte, error) {
- type noMethod AccountstatusesCustomBatchResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountstatusesCustomBatchResponseEntry: A batch entry encoding a
-// single non-batch accountstatuses response.
-type AccountstatusesCustomBatchResponseEntry struct {
- // AccountStatus: The requested account status. Defined if and only if
- // the request was successful.
- AccountStatus *AccountStatus `json:"accountStatus,omitempty"`
-
- // BatchId: The ID of the request entry this entry responds to.
- BatchId int64 `json:"batchId,omitempty"`
-
- // Errors: A list of errors defined if and only if the request failed.
- Errors *Errors `json:"errors,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AccountStatus") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountstatusesCustomBatchResponseEntry) MarshalJSON() ([]byte, error) {
- type noMethod AccountstatusesCustomBatchResponseEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AccountstatusesListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#accountstatusesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: The token for the retrieval of the next page of
- // account statuses.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- Resources []*AccountStatus `json:"resources,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountstatusesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod AccountstatusesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AccounttaxCustomBatchRequest struct {
- // Entries: The request entries to be processed in the batch.
- Entries []*AccounttaxCustomBatchRequestEntry `json:"entries,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Entries") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccounttaxCustomBatchRequest) MarshalJSON() ([]byte, error) {
- type noMethod AccounttaxCustomBatchRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccounttaxCustomBatchRequestEntry: A batch entry encoding a single
-// non-batch accounttax request.
-type AccounttaxCustomBatchRequestEntry struct {
- // AccountId: The ID of the account for which to get/update account tax
- // settings.
- AccountId uint64 `json:"accountId,omitempty,string"`
-
- // AccountTax: The account tax settings to update. Only defined if the
- // method is update.
- AccountTax *AccountTax `json:"accountTax,omitempty"`
-
- // BatchId: An entry ID, unique within the batch request.
- BatchId int64 `json:"batchId,omitempty"`
-
- // MerchantId: The ID of the managing account.
- MerchantId uint64 `json:"merchantId,omitempty,string"`
-
- Method string `json:"method,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccounttaxCustomBatchRequestEntry) MarshalJSON() ([]byte, error) {
- type noMethod AccounttaxCustomBatchRequestEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AccounttaxCustomBatchResponse struct {
- // Entries: The result of the execution of the batch requests.
- Entries []*AccounttaxCustomBatchResponseEntry `json:"entries,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#accounttaxCustomBatchResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Entries") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccounttaxCustomBatchResponse) MarshalJSON() ([]byte, error) {
- type noMethod AccounttaxCustomBatchResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccounttaxCustomBatchResponseEntry: A batch entry encoding a single
-// non-batch accounttax response.
-type AccounttaxCustomBatchResponseEntry struct {
- // AccountTax: The retrieved or updated account tax settings.
- AccountTax *AccountTax `json:"accountTax,omitempty"`
-
- // BatchId: The ID of the request entry this entry responds to.
- BatchId int64 `json:"batchId,omitempty"`
-
- // Errors: A list of errors defined if and only if the request failed.
- Errors *Errors `json:"errors,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#accounttaxCustomBatchResponseEntry".
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AccountTax") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccounttaxCustomBatchResponseEntry) MarshalJSON() ([]byte, error) {
- type noMethod AccounttaxCustomBatchResponseEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AccounttaxListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#accounttaxListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: The token for the retrieval of the next page of
- // account tax settings.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- Resources []*AccountTax `json:"resources,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccounttaxListResponse) MarshalJSON() ([]byte, error) {
- type noMethod AccounttaxListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Datafeed: Datafeed data.
-type Datafeed struct {
- // AttributeLanguage: The two-letter ISO 639-1 language in which the
- // attributes are defined in the data feed.
- AttributeLanguage string `json:"attributeLanguage,omitempty"`
-
- // ContentLanguage: The two-letter ISO 639-1 language of the items in
- // the feed.
- ContentLanguage string `json:"contentLanguage,omitempty"`
-
- // ContentType: The type of data feed.
- ContentType string `json:"contentType,omitempty"`
-
- // FetchSchedule: Fetch schedule for the feed file.
- FetchSchedule *DatafeedFetchSchedule `json:"fetchSchedule,omitempty"`
-
- // FileName: The filename of the feed. All feeds must have a unique file
- // name.
- FileName string `json:"fileName,omitempty"`
-
- // Format: Format of the feed file.
- Format *DatafeedFormat `json:"format,omitempty"`
-
- // Id: The ID of the data feed.
- Id int64 `json:"id,omitempty,string"`
-
- // IntendedDestinations: The list of intended destinations (corresponds
- // to checked check boxes in Merchant Center).
- IntendedDestinations []string `json:"intendedDestinations,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#datafeed".
- Kind string `json:"kind,omitempty"`
-
- // Name: A descriptive name of the data feed.
- Name string `json:"name,omitempty"`
-
- // TargetCountry: The country where the items in the feed will be
- // included in the search index, represented as a CLDR territory code.
- TargetCountry string `json:"targetCountry,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AttributeLanguage")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Datafeed) MarshalJSON() ([]byte, error) {
- type noMethod Datafeed
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DatafeedFetchSchedule: The required fields vary based on the
-// frequency of fetching. For a monthly fetch schedule, day_of_month and
-// hour are required. For a weekly fetch schedule, weekday and hour are
-// required. For a daily fetch schedule, only hour is required.
-type DatafeedFetchSchedule struct {
- // DayOfMonth: The day of the month the feed file should be fetched
- // (1-31).
- DayOfMonth int64 `json:"dayOfMonth,omitempty"`
-
- // FetchUrl: The URL where the feed file can be fetched. Google Merchant
- // Center will support automatic scheduled uploads using the HTTP,
- // HTTPS, FTP, or SFTP protocols, so the value will need to be a valid
- // link using one of those four protocols.
- FetchUrl string `json:"fetchUrl,omitempty"`
-
- // Hour: The hour of the day the feed file should be fetched (0-24).
- Hour int64 `json:"hour,omitempty"`
-
- // Password: An optional password for fetch_url.
- Password string `json:"password,omitempty"`
-
- // TimeZone: Time zone used for schedule. UTC by default. E.g.,
- // "America/Los_Angeles".
- TimeZone string `json:"timeZone,omitempty"`
-
- // Username: An optional user name for fetch_url.
- Username string `json:"username,omitempty"`
-
- // Weekday: The day of the week the feed file should be fetched.
- Weekday string `json:"weekday,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DayOfMonth") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DatafeedFetchSchedule) MarshalJSON() ([]byte, error) {
- type noMethod DatafeedFetchSchedule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DatafeedFormat struct {
- // ColumnDelimiter: Delimiter for the separation of values in a
- // delimiter-separated values feed. If not specified, the delimiter will
- // be auto-detected. Ignored for non-DSV data feeds.
- ColumnDelimiter string `json:"columnDelimiter,omitempty"`
-
- // FileEncoding: Character encoding scheme of the data feed. If not
- // specified, the encoding will be auto-detected.
- FileEncoding string `json:"fileEncoding,omitempty"`
-
- // QuotingMode: Specifies how double quotes are interpreted. If not
- // specified, the mode will be auto-detected. Ignored for non-DSV data
- // feeds.
- QuotingMode string `json:"quotingMode,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ColumnDelimiter") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DatafeedFormat) MarshalJSON() ([]byte, error) {
- type noMethod DatafeedFormat
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DatafeedStatus: The status of a datafeed, i.e., the result of the
-// last retrieval of the datafeed computed asynchronously when the feed
-// processing is finished.
-type DatafeedStatus struct {
- // DatafeedId: The ID of the feed for which the status is reported.
- DatafeedId uint64 `json:"datafeedId,omitempty,string"`
-
- // Errors: The list of errors occurring in the feed.
- Errors []*DatafeedStatusError `json:"errors,omitempty"`
-
- // ItemsTotal: The number of items in the feed that were processed.
- ItemsTotal uint64 `json:"itemsTotal,omitempty,string"`
-
- // ItemsValid: The number of items in the feed that were valid.
- ItemsValid uint64 `json:"itemsValid,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#datafeedStatus".
- Kind string `json:"kind,omitempty"`
-
- // LastUploadDate: The last date at which the feed was uploaded.
- LastUploadDate string `json:"lastUploadDate,omitempty"`
-
- // ProcessingStatus: The processing status of the feed.
- ProcessingStatus string `json:"processingStatus,omitempty"`
-
- // Warnings: The list of errors occurring in the feed.
- Warnings []*DatafeedStatusError `json:"warnings,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "DatafeedId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DatafeedStatus) MarshalJSON() ([]byte, error) {
- type noMethod DatafeedStatus
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DatafeedStatusError: An error occurring in the feed, like "invalid
-// price".
-type DatafeedStatusError struct {
- // Code: The code of the error, e.g., "validation/invalid_value".
- Code string `json:"code,omitempty"`
-
- // Count: The number of occurrences of the error in the feed.
- Count uint64 `json:"count,omitempty,string"`
-
- // Examples: A list of example occurrences of the error, grouped by
- // product.
- Examples []*DatafeedStatusExample `json:"examples,omitempty"`
-
- // Message: The error message, e.g., "Invalid price".
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DatafeedStatusError) MarshalJSON() ([]byte, error) {
- type noMethod DatafeedStatusError
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DatafeedStatusExample: An example occurrence for a particular error.
-type DatafeedStatusExample struct {
- // ItemId: The ID of the example item.
- ItemId string `json:"itemId,omitempty"`
-
- // LineNumber: Line number in the data feed where the example is found.
- LineNumber uint64 `json:"lineNumber,omitempty,string"`
-
- // Value: The problematic value.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ItemId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DatafeedStatusExample) MarshalJSON() ([]byte, error) {
- type noMethod DatafeedStatusExample
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DatafeedsCustomBatchRequest struct {
- // Entries: The request entries to be processed in the batch.
- Entries []*DatafeedsCustomBatchRequestEntry `json:"entries,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Entries") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DatafeedsCustomBatchRequest) MarshalJSON() ([]byte, error) {
- type noMethod DatafeedsCustomBatchRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DatafeedsCustomBatchRequestEntry: A batch entry encoding a single
-// non-batch datafeeds request.
-type DatafeedsCustomBatchRequestEntry struct {
- // BatchId: An entry ID, unique within the batch request.
- BatchId int64 `json:"batchId,omitempty"`
-
- // Datafeed: The data feed to insert.
- Datafeed *Datafeed `json:"datafeed,omitempty"`
-
- // DatafeedId: The ID of the data feed to get or delete.
- DatafeedId uint64 `json:"datafeedId,omitempty,string"`
-
- // MerchantId: The ID of the managing account.
- MerchantId uint64 `json:"merchantId,omitempty,string"`
-
- Method string `json:"method,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BatchId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DatafeedsCustomBatchRequestEntry) MarshalJSON() ([]byte, error) {
- type noMethod DatafeedsCustomBatchRequestEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DatafeedsCustomBatchResponse struct {
- // Entries: The result of the execution of the batch requests.
- Entries []*DatafeedsCustomBatchResponseEntry `json:"entries,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#datafeedsCustomBatchResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Entries") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DatafeedsCustomBatchResponse) MarshalJSON() ([]byte, error) {
- type noMethod DatafeedsCustomBatchResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DatafeedsCustomBatchResponseEntry: A batch entry encoding a single
-// non-batch datafeeds response.
-type DatafeedsCustomBatchResponseEntry struct {
- // BatchId: The ID of the request entry this entry responds to.
- BatchId int64 `json:"batchId,omitempty"`
-
- // Datafeed: The requested data feed. Defined if and only if the request
- // was successful.
- Datafeed *Datafeed `json:"datafeed,omitempty"`
-
- // Errors: A list of errors defined if and only if the request failed.
- Errors *Errors `json:"errors,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BatchId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DatafeedsCustomBatchResponseEntry) MarshalJSON() ([]byte, error) {
- type noMethod DatafeedsCustomBatchResponseEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DatafeedsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#datafeedsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: The token for the retrieval of the next page of
- // datafeeds.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- Resources []*Datafeed `json:"resources,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DatafeedsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod DatafeedsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DatafeedstatusesCustomBatchRequest struct {
- // Entries: The request entries to be processed in the batch.
- Entries []*DatafeedstatusesCustomBatchRequestEntry `json:"entries,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Entries") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DatafeedstatusesCustomBatchRequest) MarshalJSON() ([]byte, error) {
- type noMethod DatafeedstatusesCustomBatchRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DatafeedstatusesCustomBatchRequestEntry: A batch entry encoding a
-// single non-batch datafeedstatuses request.
-type DatafeedstatusesCustomBatchRequestEntry struct {
- // BatchId: An entry ID, unique within the batch request.
- BatchId int64 `json:"batchId,omitempty"`
-
- // DatafeedId: The ID of the data feed to get or delete.
- DatafeedId uint64 `json:"datafeedId,omitempty,string"`
-
- // MerchantId: The ID of the managing account.
- MerchantId uint64 `json:"merchantId,omitempty,string"`
-
- Method string `json:"method,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BatchId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DatafeedstatusesCustomBatchRequestEntry) MarshalJSON() ([]byte, error) {
- type noMethod DatafeedstatusesCustomBatchRequestEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DatafeedstatusesCustomBatchResponse struct {
- // Entries: The result of the execution of the batch requests.
- Entries []*DatafeedstatusesCustomBatchResponseEntry `json:"entries,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#datafeedstatusesCustomBatchResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Entries") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DatafeedstatusesCustomBatchResponse) MarshalJSON() ([]byte, error) {
- type noMethod DatafeedstatusesCustomBatchResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DatafeedstatusesCustomBatchResponseEntry: A batch entry encoding a
-// single non-batch datafeedstatuses response.
-type DatafeedstatusesCustomBatchResponseEntry struct {
- // BatchId: The ID of the request entry this entry responds to.
- BatchId int64 `json:"batchId,omitempty"`
-
- // DatafeedStatus: The requested data feed status. Defined if and only
- // if the request was successful.
- DatafeedStatus *DatafeedStatus `json:"datafeedStatus,omitempty"`
-
- // Errors: A list of errors defined if and only if the request failed.
- Errors *Errors `json:"errors,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BatchId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DatafeedstatusesCustomBatchResponseEntry) MarshalJSON() ([]byte, error) {
- type noMethod DatafeedstatusesCustomBatchResponseEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DatafeedstatusesListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#datafeedstatusesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: The token for the retrieval of the next page of
- // datafeed statuses.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- Resources []*DatafeedStatus `json:"resources,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DatafeedstatusesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod DatafeedstatusesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Error: An error returned by the API.
-type Error struct {
- // Domain: The domain of the error.
- Domain string `json:"domain,omitempty"`
-
- // Message: A description of the error.
- Message string `json:"message,omitempty"`
-
- // Reason: The error code.
- Reason string `json:"reason,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Domain") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Error) MarshalJSON() ([]byte, error) {
- type noMethod Error
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Errors: A list of errors returned by a failed batch entry.
-type Errors struct {
- // Code: The HTTP status of the first error in errors.
- Code int64 `json:"code,omitempty"`
-
- // Errors: A list of errors.
- Errors []*Error `json:"errors,omitempty"`
-
- // Message: The message of the first error in errors.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Errors) MarshalJSON() ([]byte, error) {
- type noMethod Errors
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Inventory struct {
- // Availability: The availability of the product.
- Availability string `json:"availability,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#inventory".
- Kind string `json:"kind,omitempty"`
-
- // Price: The price of the product.
- Price *Price `json:"price,omitempty"`
-
- // Quantity: The quantity of the product. Must be equal to or greater
- // than zero. Supported only for local products.
- Quantity int64 `json:"quantity,omitempty"`
-
- // SalePrice: The sale price of the product. Mandatory if
- // sale_price_effective_date is defined.
- SalePrice *Price `json:"salePrice,omitempty"`
-
- // SalePriceEffectiveDate: A date range represented by a pair of ISO
- // 8601 dates separated by a space, comma, or slash. Both dates might be
- // specified as 'null' if undecided.
- SalePriceEffectiveDate string `json:"salePriceEffectiveDate,omitempty"`
-
- // SellOnGoogleQuantity: The quantity of the product that is reserved
- // for sell-on-google ads. Supported only for online products.
- SellOnGoogleQuantity int64 `json:"sellOnGoogleQuantity,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Availability") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Inventory) MarshalJSON() ([]byte, error) {
- type noMethod Inventory
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InventoryCustomBatchRequest struct {
- // Entries: The request entries to be processed in the batch.
- Entries []*InventoryCustomBatchRequestEntry `json:"entries,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Entries") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InventoryCustomBatchRequest) MarshalJSON() ([]byte, error) {
- type noMethod InventoryCustomBatchRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// InventoryCustomBatchRequestEntry: A batch entry encoding a single
-// non-batch inventory request.
-type InventoryCustomBatchRequestEntry struct {
- // BatchId: An entry ID, unique within the batch request.
- BatchId int64 `json:"batchId,omitempty"`
-
- // Inventory: Price and availability of the product.
- Inventory *Inventory `json:"inventory,omitempty"`
-
- // MerchantId: The ID of the managing account.
- MerchantId uint64 `json:"merchantId,omitempty,string"`
-
- // ProductId: The ID of the product for which to update price and
- // availability.
- ProductId string `json:"productId,omitempty"`
-
- // StoreCode: The code of the store for which to update price and
- // availability. Use online to update price and availability of an
- // online product.
- StoreCode string `json:"storeCode,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BatchId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InventoryCustomBatchRequestEntry) MarshalJSON() ([]byte, error) {
- type noMethod InventoryCustomBatchRequestEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InventoryCustomBatchResponse struct {
- // Entries: The result of the execution of the batch requests.
- Entries []*InventoryCustomBatchResponseEntry `json:"entries,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#inventoryCustomBatchResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Entries") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InventoryCustomBatchResponse) MarshalJSON() ([]byte, error) {
- type noMethod InventoryCustomBatchResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// InventoryCustomBatchResponseEntry: A batch entry encoding a single
-// non-batch inventory response.
-type InventoryCustomBatchResponseEntry struct {
- // BatchId: The ID of the request entry this entry responds to.
- BatchId int64 `json:"batchId,omitempty"`
-
- // Errors: A list of errors defined if and only if the request failed.
- Errors *Errors `json:"errors,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#inventoryCustomBatchResponseEntry".
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BatchId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InventoryCustomBatchResponseEntry) MarshalJSON() ([]byte, error) {
- type noMethod InventoryCustomBatchResponseEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InventorySetRequest struct {
- // Availability: The availability of the product.
- Availability string `json:"availability,omitempty"`
-
- // Price: The price of the product.
- Price *Price `json:"price,omitempty"`
-
- // Quantity: The quantity of the product. Must be equal to or greater
- // than zero. Supported only for local products.
- Quantity int64 `json:"quantity,omitempty"`
-
- // SalePrice: The sale price of the product. Mandatory if
- // sale_price_effective_date is defined.
- SalePrice *Price `json:"salePrice,omitempty"`
-
- // SalePriceEffectiveDate: A date range represented by a pair of ISO
- // 8601 dates separated by a space, comma, or slash. Both dates might be
- // specified as 'null' if undecided.
- SalePriceEffectiveDate string `json:"salePriceEffectiveDate,omitempty"`
-
- // SellOnGoogleQuantity: The quantity of the product that is reserved
- // for sell-on-google ads. Supported only for online products.
- SellOnGoogleQuantity int64 `json:"sellOnGoogleQuantity,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Availability") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InventorySetRequest) MarshalJSON() ([]byte, error) {
- type noMethod InventorySetRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InventorySetResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#inventorySetResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InventorySetResponse) MarshalJSON() ([]byte, error) {
- type noMethod InventorySetResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type LoyaltyPoints struct {
- // Name: Name of loyalty points program. It is recommended to limit the
- // name to 12 full-width characters or 24 Roman characters.
- Name string `json:"name,omitempty"`
-
- // PointsValue: The retailer's loyalty points in absolute value.
- PointsValue int64 `json:"pointsValue,omitempty,string"`
-
- // Ratio: The ratio of a point when converted to currency. Google
- // assumes currency based on Merchant Center settings. If ratio is left
- // out, it defaults to 1.0.
- Ratio float64 `json:"ratio,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Name") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LoyaltyPoints) MarshalJSON() ([]byte, error) {
- type noMethod LoyaltyPoints
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Order struct {
- // Acknowledged: Whether the order was acknowledged.
- Acknowledged bool `json:"acknowledged,omitempty"`
-
- // Customer: The details of the customer who placed the order.
- Customer *OrderCustomer `json:"customer,omitempty"`
-
- // DeliveryDetails: The details for the delivery.
- DeliveryDetails *OrderDeliveryDetails `json:"deliveryDetails,omitempty"`
-
- // Id: The REST id of the order. Globally unique.
- Id string `json:"id,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#order".
- Kind string `json:"kind,omitempty"`
-
- // LineItems: Line items that are ordered.
- LineItems []*OrderLineItem `json:"lineItems,omitempty"`
-
- MerchantId uint64 `json:"merchantId,omitempty,string"`
-
- // MerchantOrderId: Merchant-provided id of the order.
- MerchantOrderId string `json:"merchantOrderId,omitempty"`
-
- // NetAmount: The net amount for the order. For example, if an order was
- // originally for a grand total of $100 and a refund was issued for $20,
- // the net amount will be $80.
- NetAmount *Price `json:"netAmount,omitempty"`
-
- // PaymentMethod: The details of the payment method.
- PaymentMethod *OrderPaymentMethod `json:"paymentMethod,omitempty"`
-
- // PaymentStatus: The status of the payment.
- PaymentStatus string `json:"paymentStatus,omitempty"`
-
- // PlacedDate: The date when the order was placed, in ISO 8601 format.
- PlacedDate string `json:"placedDate,omitempty"`
-
- // Refunds: Refunds for the order.
- Refunds []*OrderRefund `json:"refunds,omitempty"`
-
- // Shipments: Shipments of the order.
- Shipments []*OrderShipment `json:"shipments,omitempty"`
-
- // ShippingCost: The total cost of shipping for all items.
- ShippingCost *Price `json:"shippingCost,omitempty"`
-
- // ShippingCostTax: The tax for the total shipping cost.
- ShippingCostTax *Price `json:"shippingCostTax,omitempty"`
-
- // ShippingOption: The requested shipping option.
- ShippingOption string `json:"shippingOption,omitempty"`
-
- // Status: The status of the order.
- Status string `json:"status,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Acknowledged") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Order) MarshalJSON() ([]byte, error) {
- type noMethod Order
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderAddress struct {
- // Country: CLDR country code (e.g. "US").
- Country string `json:"country,omitempty"`
-
- // FullAddress: Strings representing the lines of the printed label for
- // mailing the order, for example:
- // John Smith
- // 1600 Amphitheatre Parkway
- // Mountain View, CA, 94043
- // United States
- FullAddress []string `json:"fullAddress,omitempty"`
-
- // IsPostOfficeBox: Whether the address is a post office box.
- IsPostOfficeBox bool `json:"isPostOfficeBox,omitempty"`
-
- // Locality: City, town or commune. May also include dependent
- // localities or sublocalities (e.g. neighborhoods or suburbs).
- Locality string `json:"locality,omitempty"`
-
- // PostalCode: Postal Code or ZIP (e.g. "94043").
- PostalCode string `json:"postalCode,omitempty"`
-
- // RecipientName: Name of the recipient.
- RecipientName string `json:"recipientName,omitempty"`
-
- // Region: Top-level administrative subdivision of the country (e.g.
- // "CA").
- Region string `json:"region,omitempty"`
-
- // StreetAddress: Street-level part of the address.
- StreetAddress []string `json:"streetAddress,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Country") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderAddress) MarshalJSON() ([]byte, error) {
- type noMethod OrderAddress
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderCancellation struct {
- // Actor: The actor that created the cancellation.
- Actor string `json:"actor,omitempty"`
-
- // CreationDate: Date on which the cancellation has been created, in ISO
- // 8601 format.
- CreationDate string `json:"creationDate,omitempty"`
-
- // Quantity: The quantity that was canceled.
- Quantity int64 `json:"quantity,omitempty"`
-
- // Reason: The reason for the cancellation.
- Reason string `json:"reason,omitempty"`
-
- // ReasonText: The explanation of the reason.
- ReasonText string `json:"reasonText,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Actor") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderCancellation) MarshalJSON() ([]byte, error) {
- type noMethod OrderCancellation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderCustomer struct {
- // Email: Email address of the customer.
- Email string `json:"email,omitempty"`
-
- // ExplicitMarketingPreference: If set, this indicates the user had a
- // choice to opt in or out of providing marketing rights to the
- // merchant. If unset, this indicates the user has already made this
- // choice in a previous purchase, and was thus not shown the marketing
- // right opt in/out checkbox during the Purchases on Google checkout
- // flow.
- ExplicitMarketingPreference bool `json:"explicitMarketingPreference,omitempty"`
-
- // FullName: Full name of the customer.
- FullName string `json:"fullName,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Email") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderCustomer) MarshalJSON() ([]byte, error) {
- type noMethod OrderCustomer
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderDeliveryDetails struct {
- // Address: The delivery address
- Address *OrderAddress `json:"address,omitempty"`
-
- // PhoneNumber: The phone number of the person receiving the delivery.
- PhoneNumber string `json:"phoneNumber,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Address") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderDeliveryDetails) MarshalJSON() ([]byte, error) {
- type noMethod OrderDeliveryDetails
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderLineItem struct {
- // Cancellations: Cancellations of the line item.
- Cancellations []*OrderCancellation `json:"cancellations,omitempty"`
-
- // Id: The id of the line item.
- Id string `json:"id,omitempty"`
-
- // Price: Total price for the line item. For example, if two items for
- // $10 are purchased, the total price will be $20.
- Price *Price `json:"price,omitempty"`
-
- // Product: Product data from the time of the order placement.
- Product *OrderLineItemProduct `json:"product,omitempty"`
-
- // QuantityCanceled: Number of items canceled.
- QuantityCanceled int64 `json:"quantityCanceled,omitempty"`
-
- // QuantityDelivered: Number of items delivered.
- QuantityDelivered int64 `json:"quantityDelivered,omitempty"`
-
- // QuantityOrdered: Number of items ordered.
- QuantityOrdered int64 `json:"quantityOrdered,omitempty"`
-
- // QuantityPending: Number of items pending.
- QuantityPending int64 `json:"quantityPending,omitempty"`
-
- // QuantityReturned: Number of items returned.
- QuantityReturned int64 `json:"quantityReturned,omitempty"`
-
- // QuantityShipped: Number of items shipped.
- QuantityShipped int64 `json:"quantityShipped,omitempty"`
-
- // ReturnInfo: Details of the return policy for the line item.
- ReturnInfo *OrderLineItemReturnInfo `json:"returnInfo,omitempty"`
-
- // Returns: Returns of the line item.
- Returns []*OrderReturn `json:"returns,omitempty"`
-
- // ShippingDetails: Details of the requested shipping for the line item.
- ShippingDetails *OrderLineItemShippingDetails `json:"shippingDetails,omitempty"`
-
- // Tax: Total tax amount for the line item. For example, if two items
- // are purchased, and each have a cost tax of $2, the total tax amount
- // will be $4.
- Tax *Price `json:"tax,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Cancellations") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderLineItem) MarshalJSON() ([]byte, error) {
- type noMethod OrderLineItem
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderLineItemProduct struct {
- // Brand: Brand of the item.
- Brand string `json:"brand,omitempty"`
-
- // Channel: The item's channel (online or local).
- Channel string `json:"channel,omitempty"`
-
- // Condition: Condition or state of the item.
- Condition string `json:"condition,omitempty"`
-
- // ContentLanguage: The two-letter ISO 639-1 language code for the item.
- ContentLanguage string `json:"contentLanguage,omitempty"`
-
- // Gtin: Global Trade Item Number (GTIN) of the item.
- Gtin string `json:"gtin,omitempty"`
-
- // Id: The REST id of the product.
- Id string `json:"id,omitempty"`
-
- // ImageLink: URL of an image of the item.
- ImageLink string `json:"imageLink,omitempty"`
-
- // ItemGroupId: Shared identifier for all variants of the same product.
- ItemGroupId string `json:"itemGroupId,omitempty"`
-
- // Mpn: Manufacturer Part Number (MPN) of the item.
- Mpn string `json:"mpn,omitempty"`
-
- // OfferId: An identifier of the item.
- OfferId string `json:"offerId,omitempty"`
-
- // Price: Price of the item.
- Price *Price `json:"price,omitempty"`
-
- // ShownImage: URL to the cached image shown to the user when order was
- // placed.
- ShownImage string `json:"shownImage,omitempty"`
-
- // TargetCountry: The CLDR territory code of the target country of the
- // product.
- TargetCountry string `json:"targetCountry,omitempty"`
-
- // Title: The title of the product.
- Title string `json:"title,omitempty"`
-
- // VariantAttributes: Variant attributes for the item. These are
- // dimensions of the product, such as color, gender, material, pattern,
- // and size. You can find a comprehensive list of variant attributes
- // here.
- VariantAttributes []*OrderLineItemProductVariantAttribute `json:"variantAttributes,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Brand") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderLineItemProduct) MarshalJSON() ([]byte, error) {
- type noMethod OrderLineItemProduct
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderLineItemProductVariantAttribute struct {
- // Dimension: The dimension of the variant.
- Dimension string `json:"dimension,omitempty"`
-
- // Value: The value for the dimension.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Dimension") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderLineItemProductVariantAttribute) MarshalJSON() ([]byte, error) {
- type noMethod OrderLineItemProductVariantAttribute
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderLineItemReturnInfo struct {
- // DaysToReturn: How many days later the item can be returned.
- DaysToReturn int64 `json:"daysToReturn,omitempty"`
-
- // IsReturnable: Whether the item is returnable.
- IsReturnable bool `json:"isReturnable,omitempty"`
-
- // PolicyUrl: URL of the item return policy.
- PolicyUrl string `json:"policyUrl,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DaysToReturn") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderLineItemReturnInfo) MarshalJSON() ([]byte, error) {
- type noMethod OrderLineItemReturnInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderLineItemShippingDetails struct {
- // DeliverByDate: The delivery by date, in ISO 8601 format.
- DeliverByDate string `json:"deliverByDate,omitempty"`
-
- // Method: Details of the shipping method.
- Method *OrderLineItemShippingDetailsMethod `json:"method,omitempty"`
-
- // ShipByDate: The ship by date, in ISO 8601 format.
- ShipByDate string `json:"shipByDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DeliverByDate") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderLineItemShippingDetails) MarshalJSON() ([]byte, error) {
- type noMethod OrderLineItemShippingDetails
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderLineItemShippingDetailsMethod struct {
- // Carrier: The carrier for the shipping. Optional.
- Carrier string `json:"carrier,omitempty"`
-
- // MaxDaysInTransit: Maximum transit time.
- MaxDaysInTransit int64 `json:"maxDaysInTransit,omitempty"`
-
- // MethodName: The name of the shipping method.
- MethodName string `json:"methodName,omitempty"`
-
- // MinDaysInTransit: Minimum transit time.
- MinDaysInTransit int64 `json:"minDaysInTransit,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Carrier") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderLineItemShippingDetailsMethod) MarshalJSON() ([]byte, error) {
- type noMethod OrderLineItemShippingDetailsMethod
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderPaymentMethod struct {
- // BillingAddress: The billing address.
- BillingAddress *OrderAddress `json:"billingAddress,omitempty"`
-
- // ExpirationMonth: The card expiration month (January = 1, February = 2
- // etc.).
- ExpirationMonth int64 `json:"expirationMonth,omitempty"`
-
- // ExpirationYear: The card expiration year (4-digit, e.g. 2015).
- ExpirationYear int64 `json:"expirationYear,omitempty"`
-
- // LastFourDigits: The last four digits of the card number.
- LastFourDigits string `json:"lastFourDigits,omitempty"`
-
- // PhoneNumber: The billing phone number.
- PhoneNumber string `json:"phoneNumber,omitempty"`
-
- // Type: The type of instrument (VISA, Mastercard, etc).
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BillingAddress") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderPaymentMethod) MarshalJSON() ([]byte, error) {
- type noMethod OrderPaymentMethod
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderRefund struct {
- // Actor: The actor that created the refund.
- Actor string `json:"actor,omitempty"`
-
- // Amount: The amount that is refunded.
- Amount *Price `json:"amount,omitempty"`
-
- // CreationDate: Date on which the item has been created, in ISO 8601
- // format.
- CreationDate string `json:"creationDate,omitempty"`
-
- // Reason: The reason for the refund.
- Reason string `json:"reason,omitempty"`
-
- // ReasonText: The explanation of the reason.
- ReasonText string `json:"reasonText,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Actor") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderRefund) MarshalJSON() ([]byte, error) {
- type noMethod OrderRefund
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderReturn struct {
- // Actor: The actor that created the refund.
- Actor string `json:"actor,omitempty"`
-
- // CreationDate: Date on which the item has been created, in ISO 8601
- // format.
- CreationDate string `json:"creationDate,omitempty"`
-
- // Quantity: Quantity that is returned.
- Quantity int64 `json:"quantity,omitempty"`
-
- // Reason: The reason for the return.
- Reason string `json:"reason,omitempty"`
-
- // ReasonText: The explanation of the reason.
- ReasonText string `json:"reasonText,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Actor") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderReturn) MarshalJSON() ([]byte, error) {
- type noMethod OrderReturn
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderShipment struct {
- // Carrier: The carrier handling the shipment.
- Carrier string `json:"carrier,omitempty"`
-
- // CreationDate: Date on which the shipment has been created, in ISO
- // 8601 format.
- CreationDate string `json:"creationDate,omitempty"`
-
- // DeliveryDate: Date on which the shipment has been delivered, in ISO
- // 8601 format. Present only if status is delievered
- DeliveryDate string `json:"deliveryDate,omitempty"`
-
- // Id: The id of the shipment.
- Id string `json:"id,omitempty"`
-
- // LineItems: The line items that are shipped.
- LineItems []*OrderShipmentLineItemShipment `json:"lineItems,omitempty"`
-
- // Status: The status of the shipment.
- Status string `json:"status,omitempty"`
-
- // TrackingId: The tracking id for the shipment.
- TrackingId string `json:"trackingId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Carrier") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderShipment) MarshalJSON() ([]byte, error) {
- type noMethod OrderShipment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderShipmentLineItemShipment struct {
- // LineItemId: The id of the line item that is shipped.
- LineItemId string `json:"lineItemId,omitempty"`
-
- // Quantity: The quantity that is shipped.
- Quantity int64 `json:"quantity,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "LineItemId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderShipmentLineItemShipment) MarshalJSON() ([]byte, error) {
- type noMethod OrderShipmentLineItemShipment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersAcknowledgeRequest struct {
- // OperationId: The ID of the operation. Unique across all operations
- // for a given order.
- OperationId string `json:"operationId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "OperationId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersAcknowledgeRequest) MarshalJSON() ([]byte, error) {
- type noMethod OrdersAcknowledgeRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersAcknowledgeResponse struct {
- // ExecutionStatus: The status of the execution.
- ExecutionStatus string `json:"executionStatus,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersAcknowledgeResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ExecutionStatus") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersAcknowledgeResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersAcknowledgeResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersAdvanceTestOrderResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersAdvanceTestOrderResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersAdvanceTestOrderResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersAdvanceTestOrderResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCancelLineItemRequest struct {
- // LineItemId: The ID of the line item to cancel.
- LineItemId string `json:"lineItemId,omitempty"`
-
- // OperationId: The ID of the operation. Unique across all operations
- // for a given order.
- OperationId string `json:"operationId,omitempty"`
-
- // Quantity: The quantity to cancel.
- Quantity int64 `json:"quantity,omitempty"`
-
- // Reason: The reason for the cancellation.
- Reason string `json:"reason,omitempty"`
-
- // ReasonText: The explanation of the reason.
- ReasonText string `json:"reasonText,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "LineItemId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCancelLineItemRequest) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCancelLineItemRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCancelLineItemResponse struct {
- // ExecutionStatus: The status of the execution.
- ExecutionStatus string `json:"executionStatus,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersCancelLineItemResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ExecutionStatus") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCancelLineItemResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCancelLineItemResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCancelRequest struct {
- // OperationId: The ID of the operation. Unique across all operations
- // for a given order.
- OperationId string `json:"operationId,omitempty"`
-
- // Reason: The reason for the cancellation.
- Reason string `json:"reason,omitempty"`
-
- // ReasonText: The explanation of the reason.
- ReasonText string `json:"reasonText,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "OperationId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCancelRequest) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCancelRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCancelResponse struct {
- // ExecutionStatus: The status of the execution.
- ExecutionStatus string `json:"executionStatus,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersCancelResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ExecutionStatus") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCancelResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCancelResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCreateTestOrderRequest struct {
- // TemplateName: The test order template to use. Specify as an
- // alternative to testOrder as a shortcut for retrieving a template and
- // then creating an order using that template.
- TemplateName string `json:"templateName,omitempty"`
-
- // TestOrder: The test order to create.
- TestOrder *TestOrder `json:"testOrder,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "TemplateName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCreateTestOrderRequest) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCreateTestOrderRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCreateTestOrderResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersCreateTestOrderResponse".
- Kind string `json:"kind,omitempty"`
-
- // OrderId: The ID of the newly created test order.
- OrderId string `json:"orderId,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCreateTestOrderResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCreateTestOrderResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCustomBatchRequest struct {
- // Entries: The request entries to be processed in the batch.
- Entries []*OrdersCustomBatchRequestEntry `json:"entries,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Entries") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCustomBatchRequest) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCustomBatchRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCustomBatchRequestEntry struct {
- // BatchId: An entry ID, unique within the batch request.
- BatchId int64 `json:"batchId,omitempty"`
-
- // Cancel: Required for cancel method.
- Cancel *OrdersCustomBatchRequestEntryCancel `json:"cancel,omitempty"`
-
- // CancelLineItem: Required for cancelLineItem method.
- CancelLineItem *OrdersCustomBatchRequestEntryCancelLineItem `json:"cancelLineItem,omitempty"`
-
- // MerchantId: The ID of the managing account.
- MerchantId uint64 `json:"merchantId,omitempty,string"`
-
- // MerchantOrderId: The merchant order id. Required for
- // updateMerchantOrderId and getByMerchantOrderId methods.
- MerchantOrderId string `json:"merchantOrderId,omitempty"`
-
- // Method: The method to apply.
- Method string `json:"method,omitempty"`
-
- // OperationId: The ID of the operation. Unique across all operations
- // for a given order. Required for all methods beside get and
- // getByMerchantOrderId.
- OperationId string `json:"operationId,omitempty"`
-
- // OrderId: The ID of the order. Required for all methods beside
- // getByMerchantOrderId.
- OrderId string `json:"orderId,omitempty"`
-
- // Refund: Required for refund method.
- Refund *OrdersCustomBatchRequestEntryRefund `json:"refund,omitempty"`
-
- // ReturnLineItem: Required for returnLineItem method.
- ReturnLineItem *OrdersCustomBatchRequestEntryReturnLineItem `json:"returnLineItem,omitempty"`
-
- // ShipLineItems: Required for shipLineItems method.
- ShipLineItems *OrdersCustomBatchRequestEntryShipLineItems `json:"shipLineItems,omitempty"`
-
- // UpdateShipment: Required for updateShipment method.
- UpdateShipment *OrdersCustomBatchRequestEntryUpdateShipment `json:"updateShipment,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BatchId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCustomBatchRequestEntry) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCustomBatchRequestEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCustomBatchRequestEntryCancel struct {
- // Reason: The reason for the cancellation.
- Reason string `json:"reason,omitempty"`
-
- // ReasonText: The explanation of the reason.
- ReasonText string `json:"reasonText,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Reason") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCustomBatchRequestEntryCancel) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCustomBatchRequestEntryCancel
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCustomBatchRequestEntryCancelLineItem struct {
- // LineItemId: The ID of the line item to cancel.
- LineItemId string `json:"lineItemId,omitempty"`
-
- // Quantity: The quantity to cancel.
- Quantity int64 `json:"quantity,omitempty"`
-
- // Reason: The reason for the cancellation.
- Reason string `json:"reason,omitempty"`
-
- // ReasonText: The explanation of the reason.
- ReasonText string `json:"reasonText,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "LineItemId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCustomBatchRequestEntryCancelLineItem) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCustomBatchRequestEntryCancelLineItem
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCustomBatchRequestEntryRefund struct {
- // Amount: The amount that is refunded.
- Amount *Price `json:"amount,omitempty"`
-
- // Reason: The reason for the refund.
- Reason string `json:"reason,omitempty"`
-
- // ReasonText: The explanation of the reason.
- ReasonText string `json:"reasonText,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Amount") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCustomBatchRequestEntryRefund) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCustomBatchRequestEntryRefund
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCustomBatchRequestEntryReturnLineItem struct {
- // LineItemId: The ID of the line item to return.
- LineItemId string `json:"lineItemId,omitempty"`
-
- // Quantity: The quantity to return.
- Quantity int64 `json:"quantity,omitempty"`
-
- // Reason: The reason for the return.
- Reason string `json:"reason,omitempty"`
-
- // ReasonText: The explanation of the reason.
- ReasonText string `json:"reasonText,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "LineItemId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCustomBatchRequestEntryReturnLineItem) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCustomBatchRequestEntryReturnLineItem
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCustomBatchRequestEntryShipLineItems struct {
- // Carrier: The carrier handling the shipment.
- Carrier string `json:"carrier,omitempty"`
-
- // LineItems: Line items to ship.
- LineItems []*OrderShipmentLineItemShipment `json:"lineItems,omitempty"`
-
- // ShipmentId: The ID of the shipment.
- ShipmentId string `json:"shipmentId,omitempty"`
-
- // TrackingId: The tracking id for the shipment.
- TrackingId string `json:"trackingId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Carrier") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCustomBatchRequestEntryShipLineItems) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCustomBatchRequestEntryShipLineItems
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCustomBatchRequestEntryUpdateShipment struct {
- // Carrier: The carrier handling the shipment. Not updated if missing.
- Carrier string `json:"carrier,omitempty"`
-
- // ShipmentId: The ID of the shipment.
- ShipmentId string `json:"shipmentId,omitempty"`
-
- // Status: New status for the shipment. Not updated if missing.
- Status string `json:"status,omitempty"`
-
- // TrackingId: The tracking id for the shipment. Not updated if missing.
- TrackingId string `json:"trackingId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Carrier") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCustomBatchRequestEntryUpdateShipment) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCustomBatchRequestEntryUpdateShipment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCustomBatchResponse struct {
- // Entries: The result of the execution of the batch requests.
- Entries []*OrdersCustomBatchResponseEntry `json:"entries,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersCustomBatchResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Entries") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCustomBatchResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCustomBatchResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCustomBatchResponseEntry struct {
- // BatchId: The ID of the request entry this entry responds to.
- BatchId int64 `json:"batchId,omitempty"`
-
- // Errors: A list of errors defined if and only if the request failed.
- Errors *Errors `json:"errors,omitempty"`
-
- // ExecutionStatus: The status of the execution. Only defined if the
- // method is not get or getByMerchantOrderId and if the request was
- // successful.
- ExecutionStatus string `json:"executionStatus,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersCustomBatchResponseEntry".
- Kind string `json:"kind,omitempty"`
-
- // Order: The retrieved order. Only defined if the method is get and if
- // the request was successful.
- Order *Order `json:"order,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BatchId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCustomBatchResponseEntry) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCustomBatchResponseEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersGetByMerchantOrderIdResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersGetByMerchantOrderIdResponse".
- Kind string `json:"kind,omitempty"`
-
- // Order: The requested order.
- Order *Order `json:"order,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersGetByMerchantOrderIdResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersGetByMerchantOrderIdResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersGetTestOrderTemplateResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersGetTestOrderTemplateResponse".
- Kind string `json:"kind,omitempty"`
-
- // Template: The requested test order template.
- Template *TestOrder `json:"template,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersGetTestOrderTemplateResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersGetTestOrderTemplateResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: The token for the retrieval of the next page of
- // orders.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- Resources []*Order `json:"resources,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersListResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersRefundRequest struct {
- // Amount: The amount that is refunded.
- Amount *Price `json:"amount,omitempty"`
-
- // OperationId: The ID of the operation. Unique across all operations
- // for a given order.
- OperationId string `json:"operationId,omitempty"`
-
- // Reason: The reason for the refund.
- Reason string `json:"reason,omitempty"`
-
- // ReasonText: The explanation of the reason.
- ReasonText string `json:"reasonText,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Amount") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersRefundRequest) MarshalJSON() ([]byte, error) {
- type noMethod OrdersRefundRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersRefundResponse struct {
- // ExecutionStatus: The status of the execution.
- ExecutionStatus string `json:"executionStatus,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersRefundResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ExecutionStatus") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersRefundResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersRefundResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersReturnLineItemRequest struct {
- // LineItemId: The ID of the line item to return.
- LineItemId string `json:"lineItemId,omitempty"`
-
- // OperationId: The ID of the operation. Unique across all operations
- // for a given order.
- OperationId string `json:"operationId,omitempty"`
-
- // Quantity: The quantity to return.
- Quantity int64 `json:"quantity,omitempty"`
-
- // Reason: The reason for the return.
- Reason string `json:"reason,omitempty"`
-
- // ReasonText: The explanation of the reason.
- ReasonText string `json:"reasonText,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "LineItemId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersReturnLineItemRequest) MarshalJSON() ([]byte, error) {
- type noMethod OrdersReturnLineItemRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersReturnLineItemResponse struct {
- // ExecutionStatus: The status of the execution.
- ExecutionStatus string `json:"executionStatus,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersReturnLineItemResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ExecutionStatus") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersReturnLineItemResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersReturnLineItemResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersShipLineItemsRequest struct {
- // Carrier: The carrier handling the shipment.
- Carrier string `json:"carrier,omitempty"`
-
- // LineItems: Line items to ship.
- LineItems []*OrderShipmentLineItemShipment `json:"lineItems,omitempty"`
-
- // OperationId: The ID of the operation. Unique across all operations
- // for a given order.
- OperationId string `json:"operationId,omitempty"`
-
- // ShipmentId: The ID of the shipment.
- ShipmentId string `json:"shipmentId,omitempty"`
-
- // TrackingId: The tracking id for the shipment.
- TrackingId string `json:"trackingId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Carrier") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersShipLineItemsRequest) MarshalJSON() ([]byte, error) {
- type noMethod OrdersShipLineItemsRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersShipLineItemsResponse struct {
- // ExecutionStatus: The status of the execution.
- ExecutionStatus string `json:"executionStatus,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersShipLineItemsResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ExecutionStatus") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersShipLineItemsResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersShipLineItemsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersUpdateMerchantOrderIdRequest struct {
- // MerchantOrderId: The merchant order id to be assigned to the order.
- // Must be unique per merchant.
- MerchantOrderId string `json:"merchantOrderId,omitempty"`
-
- // OperationId: The ID of the operation. Unique across all operations
- // for a given order.
- OperationId string `json:"operationId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "MerchantOrderId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersUpdateMerchantOrderIdRequest) MarshalJSON() ([]byte, error) {
- type noMethod OrdersUpdateMerchantOrderIdRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersUpdateMerchantOrderIdResponse struct {
- // ExecutionStatus: The status of the execution.
- ExecutionStatus string `json:"executionStatus,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersUpdateMerchantOrderIdResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ExecutionStatus") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersUpdateMerchantOrderIdResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersUpdateMerchantOrderIdResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersUpdateShipmentRequest struct {
- // Carrier: The carrier handling the shipment. Not updated if missing.
- Carrier string `json:"carrier,omitempty"`
-
- // OperationId: The ID of the operation. Unique across all operations
- // for a given order.
- OperationId string `json:"operationId,omitempty"`
-
- // ShipmentId: The ID of the shipment.
- ShipmentId string `json:"shipmentId,omitempty"`
-
- // Status: New status for the shipment. Not updated if missing.
- Status string `json:"status,omitempty"`
-
- // TrackingId: The tracking id for the shipment. Not updated if missing.
- TrackingId string `json:"trackingId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Carrier") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersUpdateShipmentRequest) MarshalJSON() ([]byte, error) {
- type noMethod OrdersUpdateShipmentRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersUpdateShipmentResponse struct {
- // ExecutionStatus: The status of the execution.
- ExecutionStatus string `json:"executionStatus,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersUpdateShipmentResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ExecutionStatus") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersUpdateShipmentResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersUpdateShipmentResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Price struct {
- // Currency: The currency of the price.
- Currency string `json:"currency,omitempty"`
-
- // Value: The price represented as a number.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Currency") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Price) MarshalJSON() ([]byte, error) {
- type noMethod Price
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Product: Product data.
-type Product struct {
- // AdditionalImageLinks: Additional URLs of images of the item.
- AdditionalImageLinks []string `json:"additionalImageLinks,omitempty"`
-
- // Adult: Set to true if the item is targeted towards adults.
- Adult bool `json:"adult,omitempty"`
-
- // AdwordsGrouping: Used to group items in an arbitrary way. Only for
- // CPA%, discouraged otherwise.
- AdwordsGrouping string `json:"adwordsGrouping,omitempty"`
-
- // AdwordsLabels: Similar to adwords_grouping, but only works on CPC.
- AdwordsLabels []string `json:"adwordsLabels,omitempty"`
-
- // AdwordsRedirect: Allows advertisers to override the item URL when the
- // product is shown within the context of Product Ads.
- AdwordsRedirect string `json:"adwordsRedirect,omitempty"`
-
- // AgeGroup: Target age group of the item.
- AgeGroup string `json:"ageGroup,omitempty"`
-
- // Aspects: Specifies the intended aspects for the product.
- Aspects []*ProductAspect `json:"aspects,omitempty"`
-
- // Availability: Availability status of the item.
- Availability string `json:"availability,omitempty"`
-
- // AvailabilityDate: The day a pre-ordered product becomes available for
- // delivery, in ISO 8601 format.
- AvailabilityDate string `json:"availabilityDate,omitempty"`
-
- // Brand: Brand of the item.
- Brand string `json:"brand,omitempty"`
-
- // Channel: The item's channel (online or local).
- Channel string `json:"channel,omitempty"`
-
- // Color: Color of the item.
- Color string `json:"color,omitempty"`
-
- // Condition: Condition or state of the item.
- Condition string `json:"condition,omitempty"`
-
- // ContentLanguage: The two-letter ISO 639-1 language code for the item.
- ContentLanguage string `json:"contentLanguage,omitempty"`
-
- // CustomAttributes: A list of custom (merchant-provided) attributes. It
- // can also be used for submitting any attribute of the feed
- // specification in its generic form (e.g., { "name": "size type",
- // "type": "text", "value": "regular" }). This is useful for submitting
- // attributes not explicitly exposed by the API.
- CustomAttributes []*ProductCustomAttribute `json:"customAttributes,omitempty"`
-
- // CustomGroups: A list of custom (merchant-provided) custom attribute
- // groups.
- CustomGroups []*ProductCustomGroup `json:"customGroups,omitempty"`
-
- // CustomLabel0: Custom label 0 for custom grouping of items in a
- // Shopping campaign.
- CustomLabel0 string `json:"customLabel0,omitempty"`
-
- // CustomLabel1: Custom label 1 for custom grouping of items in a
- // Shopping campaign.
- CustomLabel1 string `json:"customLabel1,omitempty"`
-
- // CustomLabel2: Custom label 2 for custom grouping of items in a
- // Shopping campaign.
- CustomLabel2 string `json:"customLabel2,omitempty"`
-
- // CustomLabel3: Custom label 3 for custom grouping of items in a
- // Shopping campaign.
- CustomLabel3 string `json:"customLabel3,omitempty"`
-
- // CustomLabel4: Custom label 4 for custom grouping of items in a
- // Shopping campaign.
- CustomLabel4 string `json:"customLabel4,omitempty"`
-
- // Description: Description of the item.
- Description string `json:"description,omitempty"`
-
- // Destinations: Specifies the intended destinations for the product.
- Destinations []*ProductDestination `json:"destinations,omitempty"`
-
- // DisplayAdsId: An identifier for an item for dynamic remarketing
- // campaigns.
- DisplayAdsId string `json:"displayAdsId,omitempty"`
-
- // DisplayAdsLink: URL directly to your item's landing page for dynamic
- // remarketing campaigns.
- DisplayAdsLink string `json:"displayAdsLink,omitempty"`
-
- // DisplayAdsSimilarIds: Advertiser-specified recommendations.
- DisplayAdsSimilarIds []string `json:"displayAdsSimilarIds,omitempty"`
-
- // DisplayAdsTitle: Title of an item for dynamic remarketing campaigns.
- DisplayAdsTitle string `json:"displayAdsTitle,omitempty"`
-
- // DisplayAdsValue: Offer margin for dynamic remarketing campaigns.
- DisplayAdsValue float64 `json:"displayAdsValue,omitempty"`
-
- // EnergyEfficiencyClass: The energy efficiency class as defined in EU
- // directive 2010/30/EU.
- EnergyEfficiencyClass string `json:"energyEfficiencyClass,omitempty"`
-
- // ExpirationDate: Date on which the item should expire, as specified
- // upon insertion, in ISO 8601 format. The actual expiration date in
- // Google Shopping is exposed in productstatuses as googleExpirationDate
- // and might be earlier if expirationDate is too far in the future.
- ExpirationDate string `json:"expirationDate,omitempty"`
-
- // Gender: Target gender of the item.
- Gender string `json:"gender,omitempty"`
-
- // GoogleProductCategory: Google's category of the item (see Google
- // product taxonomy).
- GoogleProductCategory string `json:"googleProductCategory,omitempty"`
-
- // Gtin: Global Trade Item Number (GTIN) of the item.
- Gtin string `json:"gtin,omitempty"`
-
- // Id: The REST id of the product.
- Id string `json:"id,omitempty"`
-
- // IdentifierExists: False when the item does not have unique product
- // identifiers appropriate to its category, such as GTIN, MPN, and
- // brand. Required according to the Unique Product Identifier Rules for
- // all target countries except for Canada.
- IdentifierExists bool `json:"identifierExists,omitempty"`
-
- // ImageLink: URL of an image of the item.
- ImageLink string `json:"imageLink,omitempty"`
-
- // Installment: Number and amount of installments to pay for an item.
- // Brazil only.
- Installment *ProductInstallment `json:"installment,omitempty"`
-
- // IsBundle: Whether the item is a merchant-defined bundle. A bundle is
- // a custom grouping of different products sold by a merchant for a
- // single price.
- IsBundle bool `json:"isBundle,omitempty"`
-
- // ItemGroupId: Shared identifier for all variants of the same product.
- ItemGroupId string `json:"itemGroupId,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#product".
- Kind string `json:"kind,omitempty"`
-
- // Link: URL directly linking to your item's page on your website.
- Link string `json:"link,omitempty"`
-
- // LoyaltyPoints: Loyalty points that users receive after purchasing the
- // item. Japan only.
- LoyaltyPoints *LoyaltyPoints `json:"loyaltyPoints,omitempty"`
-
- // Material: The material of which the item is made.
- Material string `json:"material,omitempty"`
-
- // MobileLink: Link to a mobile-optimized version of the landing page.
- MobileLink string `json:"mobileLink,omitempty"`
-
- // Mpn: Manufacturer Part Number (MPN) of the item.
- Mpn string `json:"mpn,omitempty"`
-
- // Multipack: The number of identical products in a merchant-defined
- // multipack.
- Multipack int64 `json:"multipack,omitempty,string"`
-
- // OfferId: An identifier of the item.
- OfferId string `json:"offerId,omitempty"`
-
- // OnlineOnly: Whether an item is available for purchase only online.
- OnlineOnly bool `json:"onlineOnly,omitempty"`
-
- // Pattern: The item's pattern (e.g. polka dots).
- Pattern string `json:"pattern,omitempty"`
-
- // Price: Price of the item.
- Price *Price `json:"price,omitempty"`
-
- // ProductType: Your category of the item (formatted as in product feeds
- // specification).
- ProductType string `json:"productType,omitempty"`
-
- // SalePrice: Advertised sale price of the item.
- SalePrice *Price `json:"salePrice,omitempty"`
-
- // SalePriceEffectiveDate: Date range during which the item is on sale
- // (see product feed specifications).
- SalePriceEffectiveDate string `json:"salePriceEffectiveDate,omitempty"`
-
- // SellOnGoogleQuantity: The quantity of the product that is reserved
- // for sell-on-google ads.
- SellOnGoogleQuantity int64 `json:"sellOnGoogleQuantity,omitempty,string"`
-
- // Shipping: Shipping rules.
- Shipping []*ProductShipping `json:"shipping,omitempty"`
-
- // ShippingHeight: Height of the item for shipping.
- ShippingHeight *ProductShippingDimension `json:"shippingHeight,omitempty"`
-
- // ShippingLabel: The shipping label of the product, used to group
- // product in account-level shipping rules.
- ShippingLabel string `json:"shippingLabel,omitempty"`
-
- // ShippingLength: Length of the item for shipping.
- ShippingLength *ProductShippingDimension `json:"shippingLength,omitempty"`
-
- // ShippingWeight: Weight of the item for shipping.
- ShippingWeight *ProductShippingWeight `json:"shippingWeight,omitempty"`
-
- // ShippingWidth: Width of the item for shipping.
- ShippingWidth *ProductShippingDimension `json:"shippingWidth,omitempty"`
-
- // SizeSystem: System in which the size is specified. Recommended for
- // apparel items.
- SizeSystem string `json:"sizeSystem,omitempty"`
-
- // SizeType: The cut of the item. Recommended for apparel items.
- SizeType string `json:"sizeType,omitempty"`
-
- // Sizes: Size of the item.
- Sizes []string `json:"sizes,omitempty"`
-
- // TargetCountry: The CLDR territory code for the item.
- TargetCountry string `json:"targetCountry,omitempty"`
-
- // Taxes: Tax information.
- Taxes []*ProductTax `json:"taxes,omitempty"`
-
- // Title: Title of the item.
- Title string `json:"title,omitempty"`
-
- // UnitPricingBaseMeasure: The preference of the denominator of the unit
- // price.
- UnitPricingBaseMeasure *ProductUnitPricingBaseMeasure `json:"unitPricingBaseMeasure,omitempty"`
-
- // UnitPricingMeasure: The measure and dimension of an item.
- UnitPricingMeasure *ProductUnitPricingMeasure `json:"unitPricingMeasure,omitempty"`
-
- // ValidatedDestinations: The read-only list of intended destinations
- // which passed validation.
- ValidatedDestinations []string `json:"validatedDestinations,omitempty"`
-
- // Warnings: Read-only warnings.
- Warnings []*Error `json:"warnings,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "AdditionalImageLinks") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Product) MarshalJSON() ([]byte, error) {
- type noMethod Product
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ProductAspect struct {
- // AspectName: The name of the aspect.
- AspectName string `json:"aspectName,omitempty"`
-
- // DestinationName: The name of the destination. Leave out to apply to
- // all destinations.
- DestinationName string `json:"destinationName,omitempty"`
-
- // Intention: Whether the aspect is required, excluded or should be
- // validated.
- Intention string `json:"intention,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AspectName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductAspect) MarshalJSON() ([]byte, error) {
- type noMethod ProductAspect
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ProductCustomAttribute struct {
- // Name: The name of the attribute. Underscores will be replaced by
- // spaces upon insertion.
- Name string `json:"name,omitempty"`
-
- // Type: The type of the attribute.
- Type string `json:"type,omitempty"`
-
- // Unit: Free-form unit of the attribute. Unit can only be used for
- // values of type INT or FLOAT.
- Unit string `json:"unit,omitempty"`
-
- // Value: The value of the attribute.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Name") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductCustomAttribute) MarshalJSON() ([]byte, error) {
- type noMethod ProductCustomAttribute
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ProductCustomGroup struct {
- // Attributes: The sub-attributes.
- Attributes []*ProductCustomAttribute `json:"attributes,omitempty"`
-
- // Name: The name of the group. Underscores will be replaced by spaces
- // upon insertion.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Attributes") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductCustomGroup) MarshalJSON() ([]byte, error) {
- type noMethod ProductCustomGroup
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ProductDestination struct {
- // DestinationName: The name of the destination.
- DestinationName string `json:"destinationName,omitempty"`
-
- // Intention: Whether the destination is required, excluded or should be
- // validated.
- Intention string `json:"intention,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DestinationName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductDestination) MarshalJSON() ([]byte, error) {
- type noMethod ProductDestination
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ProductInstallment struct {
- // Amount: The amount the buyer has to pay per month.
- Amount *Price `json:"amount,omitempty"`
-
- // Months: The number of installments the buyer has to pay.
- Months int64 `json:"months,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "Amount") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductInstallment) MarshalJSON() ([]byte, error) {
- type noMethod ProductInstallment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ProductShipping struct {
- // Country: The CLDR territory code of the country to which an item will
- // ship.
- Country string `json:"country,omitempty"`
-
- // LocationGroupName: The location where the shipping is applicable,
- // represented by a location group name.
- LocationGroupName string `json:"locationGroupName,omitempty"`
-
- // LocationId: The numeric id of a location that the shipping rate
- // applies to as defined in the AdWords API.
- LocationId int64 `json:"locationId,omitempty,string"`
-
- // PostalCode: The postal code range that the shipping rate applies to,
- // represented by a postal code, a postal code prefix followed by a *
- // wildcard, a range between two postal codes or two postal code
- // prefixes of equal length.
- PostalCode string `json:"postalCode,omitempty"`
-
- // Price: Fixed shipping price, represented as a number.
- Price *Price `json:"price,omitempty"`
-
- // Region: The geographic region to which a shipping rate applies (e.g.
- // zip code).
- Region string `json:"region,omitempty"`
-
- // Service: A free-form description of the service class or delivery
- // speed.
- Service string `json:"service,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Country") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductShipping) MarshalJSON() ([]byte, error) {
- type noMethod ProductShipping
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ProductShippingDimension struct {
- // Unit: The unit of value.
- //
- // Acceptable values are:
- // - "cm"
- // - "in"
- Unit string `json:"unit,omitempty"`
-
- // Value: The dimension of the product used to calculate the shipping
- // cost of the item.
- Value float64 `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Unit") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductShippingDimension) MarshalJSON() ([]byte, error) {
- type noMethod ProductShippingDimension
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ProductShippingWeight struct {
- // Unit: The unit of value.
- Unit string `json:"unit,omitempty"`
-
- // Value: The weight of the product used to calculate the shipping cost
- // of the item.
- Value float64 `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Unit") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductShippingWeight) MarshalJSON() ([]byte, error) {
- type noMethod ProductShippingWeight
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ProductStatus: The status of a product, i.e., information about a
-// product computed asynchronously by the data quality analysis.
-type ProductStatus struct {
- // CreationDate: Date on which the item has been created, in ISO 8601
- // format.
- CreationDate string `json:"creationDate,omitempty"`
-
- // DataQualityIssues: A list of data quality issues associated with the
- // product.
- DataQualityIssues []*ProductStatusDataQualityIssue `json:"dataQualityIssues,omitempty"`
-
- // DestinationStatuses: The intended destinations for the product.
- DestinationStatuses []*ProductStatusDestinationStatus `json:"destinationStatuses,omitempty"`
-
- // GoogleExpirationDate: Date on which the item expires in Google
- // Shopping, in ISO 8601 format.
- GoogleExpirationDate string `json:"googleExpirationDate,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#productStatus".
- Kind string `json:"kind,omitempty"`
-
- // LastUpdateDate: Date on which the item has been last updated, in ISO
- // 8601 format.
- LastUpdateDate string `json:"lastUpdateDate,omitempty"`
-
- // Link: The link to the product.
- Link string `json:"link,omitempty"`
-
- // ProductId: The id of the product for which status is reported.
- ProductId string `json:"productId,omitempty"`
-
- // Title: The title of the product.
- Title string `json:"title,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationDate") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductStatus) MarshalJSON() ([]byte, error) {
- type noMethod ProductStatus
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ProductStatusDataQualityIssue struct {
- // Detail: A more detailed error string.
- Detail string `json:"detail,omitempty"`
-
- // FetchStatus: The fetch status for landing_page_errors.
- FetchStatus string `json:"fetchStatus,omitempty"`
-
- // Id: The id of the data quality issue.
- Id string `json:"id,omitempty"`
-
- // Location: The attribute name that is relevant for the issue.
- Location string `json:"location,omitempty"`
-
- // Severity: The severity of the data quality issue.
- Severity string `json:"severity,omitempty"`
-
- // Timestamp: The time stamp of the data quality issue.
- Timestamp string `json:"timestamp,omitempty"`
-
- // ValueOnLandingPage: The value of that attribute that was found on the
- // landing page
- ValueOnLandingPage string `json:"valueOnLandingPage,omitempty"`
-
- // ValueProvided: The value the attribute had at time of evaluation.
- ValueProvided string `json:"valueProvided,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Detail") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductStatusDataQualityIssue) MarshalJSON() ([]byte, error) {
- type noMethod ProductStatusDataQualityIssue
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ProductStatusDestinationStatus struct {
- // ApprovalStatus: The destination's approval status.
- ApprovalStatus string `json:"approvalStatus,omitempty"`
-
- // Destination: The name of the destination
- Destination string `json:"destination,omitempty"`
-
- // Intention: Whether the destination is required, excluded, selected by
- // default or should be validated.
- Intention string `json:"intention,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ApprovalStatus") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductStatusDestinationStatus) MarshalJSON() ([]byte, error) {
- type noMethod ProductStatusDestinationStatus
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ProductTax struct {
- // Country: The country within which the item is taxed, specified as a
- // CLDR territory code.
- Country string `json:"country,omitempty"`
-
- // LocationId: The numeric id of a location that the tax rate applies to
- // as defined in the AdWords API.
- LocationId int64 `json:"locationId,omitempty,string"`
-
- // PostalCode: The postal code range that the tax rate applies to,
- // represented by a ZIP code, a ZIP code prefix using * wildcard, a
- // range between two ZIP codes or two ZIP code prefixes of equal length.
- // Examples: 94114, 94*, 94002-95460, 94*-95*.
- PostalCode string `json:"postalCode,omitempty"`
-
- // Rate: The percentage of tax rate that applies to the item price.
- Rate float64 `json:"rate,omitempty"`
-
- // Region: The geographic region to which the tax rate applies.
- Region string `json:"region,omitempty"`
-
- // TaxShip: Set to true if tax is charged on shipping.
- TaxShip bool `json:"taxShip,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Country") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductTax) MarshalJSON() ([]byte, error) {
- type noMethod ProductTax
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ProductUnitPricingBaseMeasure struct {
- // Unit: The unit of the denominator.
- Unit string `json:"unit,omitempty"`
-
- // Value: The denominator of the unit price.
- Value int64 `json:"value,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "Unit") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductUnitPricingBaseMeasure) MarshalJSON() ([]byte, error) {
- type noMethod ProductUnitPricingBaseMeasure
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ProductUnitPricingMeasure struct {
- // Unit: The unit of the measure.
- Unit string `json:"unit,omitempty"`
-
- // Value: The measure of an item.
- Value float64 `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Unit") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductUnitPricingMeasure) MarshalJSON() ([]byte, error) {
- type noMethod ProductUnitPricingMeasure
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ProductsCustomBatchRequest struct {
- // Entries: The request entries to be processed in the batch.
- Entries []*ProductsCustomBatchRequestEntry `json:"entries,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Entries") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductsCustomBatchRequest) MarshalJSON() ([]byte, error) {
- type noMethod ProductsCustomBatchRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ProductsCustomBatchRequestEntry: A batch entry encoding a single
-// non-batch products request.
-type ProductsCustomBatchRequestEntry struct {
- // BatchId: An entry ID, unique within the batch request.
- BatchId int64 `json:"batchId,omitempty"`
-
- // MerchantId: The ID of the managing account.
- MerchantId uint64 `json:"merchantId,omitempty,string"`
-
- Method string `json:"method,omitempty"`
-
- // Product: The product to insert. Only required if the method is
- // insert.
- Product *Product `json:"product,omitempty"`
-
- // ProductId: The ID of the product to get or delete. Only defined if
- // the method is get or delete.
- ProductId string `json:"productId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BatchId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductsCustomBatchRequestEntry) MarshalJSON() ([]byte, error) {
- type noMethod ProductsCustomBatchRequestEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ProductsCustomBatchResponse struct {
- // Entries: The result of the execution of the batch requests.
- Entries []*ProductsCustomBatchResponseEntry `json:"entries,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#productsCustomBatchResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Entries") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductsCustomBatchResponse) MarshalJSON() ([]byte, error) {
- type noMethod ProductsCustomBatchResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ProductsCustomBatchResponseEntry: A batch entry encoding a single
-// non-batch products response.
-type ProductsCustomBatchResponseEntry struct {
- // BatchId: The ID of the request entry this entry responds to.
- BatchId int64 `json:"batchId,omitempty"`
-
- // Errors: A list of errors defined if and only if the request failed.
- Errors *Errors `json:"errors,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#productsCustomBatchResponseEntry".
- Kind string `json:"kind,omitempty"`
-
- // Product: The inserted product. Only defined if the method is insert
- // and if the request was successful.
- Product *Product `json:"product,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BatchId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductsCustomBatchResponseEntry) MarshalJSON() ([]byte, error) {
- type noMethod ProductsCustomBatchResponseEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ProductsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#productsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: The token for the retrieval of the next page of
- // products.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- Resources []*Product `json:"resources,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod ProductsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ProductstatusesCustomBatchRequest struct {
- // Entries: The request entries to be processed in the batch.
- Entries []*ProductstatusesCustomBatchRequestEntry `json:"entries,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Entries") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductstatusesCustomBatchRequest) MarshalJSON() ([]byte, error) {
- type noMethod ProductstatusesCustomBatchRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ProductstatusesCustomBatchRequestEntry: A batch entry encoding a
-// single non-batch productstatuses request.
-type ProductstatusesCustomBatchRequestEntry struct {
- // BatchId: An entry ID, unique within the batch request.
- BatchId int64 `json:"batchId,omitempty"`
-
- // MerchantId: The ID of the managing account.
- MerchantId uint64 `json:"merchantId,omitempty,string"`
-
- Method string `json:"method,omitempty"`
-
- // ProductId: The ID of the product whose status to get.
- ProductId string `json:"productId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BatchId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductstatusesCustomBatchRequestEntry) MarshalJSON() ([]byte, error) {
- type noMethod ProductstatusesCustomBatchRequestEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ProductstatusesCustomBatchResponse struct {
- // Entries: The result of the execution of the batch requests.
- Entries []*ProductstatusesCustomBatchResponseEntry `json:"entries,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#productstatusesCustomBatchResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Entries") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductstatusesCustomBatchResponse) MarshalJSON() ([]byte, error) {
- type noMethod ProductstatusesCustomBatchResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ProductstatusesCustomBatchResponseEntry: A batch entry encoding a
-// single non-batch productstatuses response.
-type ProductstatusesCustomBatchResponseEntry struct {
- // BatchId: The ID of the request entry this entry responds to.
- BatchId int64 `json:"batchId,omitempty"`
-
- // Errors: A list of errors, if the request failed.
- Errors *Errors `json:"errors,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#productstatusesCustomBatchResponseEntry".
- Kind string `json:"kind,omitempty"`
-
- // ProductStatus: The requested product status. Only defined if the
- // request was successful.
- ProductStatus *ProductStatus `json:"productStatus,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BatchId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductstatusesCustomBatchResponseEntry) MarshalJSON() ([]byte, error) {
- type noMethod ProductstatusesCustomBatchResponseEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ProductstatusesListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#productstatusesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: The token for the retrieval of the next page of
- // products statuses.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- Resources []*ProductStatus `json:"resources,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProductstatusesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod ProductstatusesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TestOrder struct {
- // Customer: The details of the customer who placed the order.
- Customer *TestOrderCustomer `json:"customer,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#testOrder".
- Kind string `json:"kind,omitempty"`
-
- // LineItems: Line items that are ordered. At least one line item must
- // be provided.
- LineItems []*TestOrderLineItem `json:"lineItems,omitempty"`
-
- // PaymentMethod: The details of the payment method.
- PaymentMethod *TestOrderPaymentMethod `json:"paymentMethod,omitempty"`
-
- // PredefinedDeliveryAddress: Identifier of one of the predefined
- // delivery addresses for the delivery.
- PredefinedDeliveryAddress string `json:"predefinedDeliveryAddress,omitempty"`
-
- // ShippingCost: The total cost of shipping for all items.
- ShippingCost *Price `json:"shippingCost,omitempty"`
-
- // ShippingCostTax: The tax for the total shipping cost.
- ShippingCostTax *Price `json:"shippingCostTax,omitempty"`
-
- // ShippingOption: The requested shipping option.
- ShippingOption string `json:"shippingOption,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Customer") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TestOrder) MarshalJSON() ([]byte, error) {
- type noMethod TestOrder
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TestOrderCustomer struct {
- // Email: Email address of the customer.
- Email string `json:"email,omitempty"`
-
- // ExplicitMarketingPreference: If set, this indicates the user had a
- // choice to opt in or out of providing marketing rights to the
- // merchant. If unset, this indicates the user has already made this
- // choice in a previous purchase, and was thus not shown the marketing
- // right opt in/out checkbox during the Purchases on Google checkout
- // flow. Optional.
- ExplicitMarketingPreference bool `json:"explicitMarketingPreference,omitempty"`
-
- // FullName: Full name of the customer.
- FullName string `json:"fullName,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Email") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TestOrderCustomer) MarshalJSON() ([]byte, error) {
- type noMethod TestOrderCustomer
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TestOrderLineItem struct {
- // Product: Product data from the time of the order placement.
- Product *TestOrderLineItemProduct `json:"product,omitempty"`
-
- // QuantityOrdered: Number of items ordered.
- QuantityOrdered int64 `json:"quantityOrdered,omitempty"`
-
- // ReturnInfo: Details of the return policy for the line item.
- ReturnInfo *OrderLineItemReturnInfo `json:"returnInfo,omitempty"`
-
- // ShippingDetails: Details of the requested shipping for the line item.
- ShippingDetails *OrderLineItemShippingDetails `json:"shippingDetails,omitempty"`
-
- // UnitTax: Unit tax for the line item.
- UnitTax *Price `json:"unitTax,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Product") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TestOrderLineItem) MarshalJSON() ([]byte, error) {
- type noMethod TestOrderLineItem
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TestOrderLineItemProduct struct {
- // Brand: Brand of the item.
- Brand string `json:"brand,omitempty"`
-
- // Channel: The item's channel.
- Channel string `json:"channel,omitempty"`
-
- // Condition: Condition or state of the item.
- Condition string `json:"condition,omitempty"`
-
- // ContentLanguage: The two-letter ISO 639-1 language code for the item.
- ContentLanguage string `json:"contentLanguage,omitempty"`
-
- // Gtin: Global Trade Item Number (GTIN) of the item. Optional.
- Gtin string `json:"gtin,omitempty"`
-
- // ImageLink: URL of an image of the item.
- ImageLink string `json:"imageLink,omitempty"`
-
- // ItemGroupId: Shared identifier for all variants of the same product.
- // Optional.
- ItemGroupId string `json:"itemGroupId,omitempty"`
-
- // Mpn: Manufacturer Part Number (MPN) of the item. Optional.
- Mpn string `json:"mpn,omitempty"`
-
- // OfferId: An identifier of the item.
- OfferId string `json:"offerId,omitempty"`
-
- // Price: The price for the product.
- Price *Price `json:"price,omitempty"`
-
- // TargetCountry: The CLDR territory code of the target country of the
- // product.
- TargetCountry string `json:"targetCountry,omitempty"`
-
- // Title: The title of the product.
- Title string `json:"title,omitempty"`
-
- // VariantAttributes: Variant attributes for the item. Optional.
- VariantAttributes []*OrderLineItemProductVariantAttribute `json:"variantAttributes,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Brand") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TestOrderLineItemProduct) MarshalJSON() ([]byte, error) {
- type noMethod TestOrderLineItemProduct
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TestOrderPaymentMethod struct {
- // ExpirationMonth: The card expiration month (January = 1, February = 2
- // etc.).
- ExpirationMonth int64 `json:"expirationMonth,omitempty"`
-
- // ExpirationYear: The card expiration year (4-digit, e.g. 2015).
- ExpirationYear int64 `json:"expirationYear,omitempty"`
-
- // LastFourDigits: The last four digits of the card number.
- LastFourDigits string `json:"lastFourDigits,omitempty"`
-
- // PredefinedBillingAddress: The billing address.
- PredefinedBillingAddress string `json:"predefinedBillingAddress,omitempty"`
-
- // Type: The type of instrument. Note that real orders might have
- // different values than the four values accepted by createTestOrder.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ExpirationMonth") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TestOrderPaymentMethod) MarshalJSON() ([]byte, error) {
- type noMethod TestOrderPaymentMethod
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Weight struct {
- // Unit: The weight unit.
- Unit string `json:"unit,omitempty"`
-
- // Value: The weight represented as a number.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Unit") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Weight) MarshalJSON() ([]byte, error) {
- type noMethod Weight
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "content.accounts.authinfo":
-
-type AccountsAuthinfoCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Authinfo: Returns information about the authenticated user.
-func (r *AccountsService) Authinfo() *AccountsAuthinfoCall {
- c := &AccountsAuthinfoCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsAuthinfoCall) Fields(s ...googleapi.Field) *AccountsAuthinfoCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsAuthinfoCall) IfNoneMatch(entityTag string) *AccountsAuthinfoCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsAuthinfoCall) Context(ctx context.Context) *AccountsAuthinfoCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsAuthinfoCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/authinfo")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.accounts.authinfo" call.
-// Exactly one of *AccountsAuthInfoResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *AccountsAuthInfoResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountsAuthinfoCall) Do() (*AccountsAuthInfoResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountsAuthInfoResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns information about the authenticated user.",
- // "httpMethod": "GET",
- // "id": "content.accounts.authinfo",
- // "path": "accounts/authinfo",
- // "response": {
- // "$ref": "AccountsAuthInfoResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.accounts.custombatch":
-
-type AccountsCustombatchCall struct {
- s *Service
- accountscustombatchrequest *AccountsCustomBatchRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Custombatch: Retrieves, inserts, updates, and deletes multiple
-// Merchant Center (sub-)accounts in a single request.
-func (r *AccountsService) Custombatch(accountscustombatchrequest *AccountsCustomBatchRequest) *AccountsCustombatchCall {
- c := &AccountsCustombatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountscustombatchrequest = accountscustombatchrequest
- return c
-}
-
-// DryRun sets the optional parameter "dryRun": Flag to run the request
-// in dry-run mode.
-func (c *AccountsCustombatchCall) DryRun(dryRun bool) *AccountsCustombatchCall {
- c.opt_["dryRun"] = dryRun
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsCustombatchCall) Fields(s ...googleapi.Field) *AccountsCustombatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsCustombatchCall) Context(ctx context.Context) *AccountsCustombatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsCustombatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.accountscustombatchrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["dryRun"]; ok {
- params.Set("dryRun", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/batch")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.accounts.custombatch" call.
-// Exactly one of *AccountsCustomBatchResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *AccountsCustomBatchResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountsCustombatchCall) Do() (*AccountsCustomBatchResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountsCustomBatchResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.",
- // "httpMethod": "POST",
- // "id": "content.accounts.custombatch",
- // "parameters": {
- // "dryRun": {
- // "description": "Flag to run the request in dry-run mode.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "accounts/batch",
- // "request": {
- // "$ref": "AccountsCustomBatchRequest"
- // },
- // "response": {
- // "$ref": "AccountsCustomBatchResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.accounts.delete":
-
-type AccountsDeleteCall struct {
- s *Service
- merchantId uint64
- accountId uint64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes a Merchant Center sub-account.
-func (r *AccountsService) Delete(merchantId uint64, accountId uint64) *AccountsDeleteCall {
- c := &AccountsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.accountId = accountId
- return c
-}
-
-// DryRun sets the optional parameter "dryRun": Flag to run the request
-// in dry-run mode.
-func (c *AccountsDeleteCall) DryRun(dryRun bool) *AccountsDeleteCall {
- c.opt_["dryRun"] = dryRun
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsDeleteCall) Fields(s ...googleapi.Field) *AccountsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsDeleteCall) Context(ctx context.Context) *AccountsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["dryRun"]; ok {
- params.Set("dryRun", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/accounts/{accountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "accountId": strconv.FormatUint(c.accountId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.accounts.delete" call.
-func (c *AccountsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes a Merchant Center sub-account.",
- // "httpMethod": "DELETE",
- // "id": "content.accounts.delete",
- // "parameterOrder": [
- // "merchantId",
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The ID of the account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "dryRun": {
- // "description": "Flag to run the request in dry-run mode.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/accounts/{accountId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.accounts.get":
-
-type AccountsGetCall struct {
- s *Service
- merchantId uint64
- accountId uint64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves a Merchant Center account.
-func (r *AccountsService) Get(merchantId uint64, accountId uint64) *AccountsGetCall {
- c := &AccountsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.accountId = accountId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsGetCall) Fields(s ...googleapi.Field) *AccountsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsGetCall) IfNoneMatch(entityTag string) *AccountsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsGetCall) Context(ctx context.Context) *AccountsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/accounts/{accountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "accountId": strconv.FormatUint(c.accountId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.accounts.get" call.
-// Exactly one of *Account or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Account.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsGetCall) Do() (*Account, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Account{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a Merchant Center account.",
- // "httpMethod": "GET",
- // "id": "content.accounts.get",
- // "parameterOrder": [
- // "merchantId",
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The ID of the account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/accounts/{accountId}",
- // "response": {
- // "$ref": "Account"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.accounts.insert":
-
-type AccountsInsertCall struct {
- s *Service
- merchantId uint64
- account *Account
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a Merchant Center sub-account.
-func (r *AccountsService) Insert(merchantId uint64, account *Account) *AccountsInsertCall {
- c := &AccountsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.account = account
- return c
-}
-
-// DryRun sets the optional parameter "dryRun": Flag to run the request
-// in dry-run mode.
-func (c *AccountsInsertCall) DryRun(dryRun bool) *AccountsInsertCall {
- c.opt_["dryRun"] = dryRun
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsInsertCall) Fields(s ...googleapi.Field) *AccountsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsInsertCall) Context(ctx context.Context) *AccountsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.account)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["dryRun"]; ok {
- params.Set("dryRun", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/accounts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.accounts.insert" call.
-// Exactly one of *Account or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Account.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsInsertCall) Do() (*Account, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Account{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a Merchant Center sub-account.",
- // "httpMethod": "POST",
- // "id": "content.accounts.insert",
- // "parameterOrder": [
- // "merchantId"
- // ],
- // "parameters": {
- // "dryRun": {
- // "description": "Flag to run the request in dry-run mode.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/accounts",
- // "request": {
- // "$ref": "Account"
- // },
- // "response": {
- // "$ref": "Account"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.accounts.list":
-
-type AccountsListCall struct {
- s *Service
- merchantId uint64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists the sub-accounts in your Merchant Center account.
-func (r *AccountsService) List(merchantId uint64) *AccountsListCall {
- c := &AccountsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of accounts to return in the response, used for paging.
-func (c *AccountsListCall) MaxResults(maxResults int64) *AccountsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The token returned
-// by the previous request.
-func (c *AccountsListCall) PageToken(pageToken string) *AccountsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsListCall) Fields(s ...googleapi.Field) *AccountsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsListCall) IfNoneMatch(entityTag string) *AccountsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsListCall) Context(ctx context.Context) *AccountsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/accounts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.accounts.list" call.
-// Exactly one of *AccountsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AccountsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountsListCall) Do() (*AccountsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists the sub-accounts in your Merchant Center account.",
- // "httpMethod": "GET",
- // "id": "content.accounts.list",
- // "parameterOrder": [
- // "merchantId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "The maximum number of accounts to return in the response, used for paging.",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "The token returned by the previous request.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/accounts",
- // "response": {
- // "$ref": "AccountsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.accounts.patch":
-
-type AccountsPatchCall struct {
- s *Service
- merchantId uint64
- accountId uint64
- account *Account
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates a Merchant Center account. This method supports patch
-// semantics.
-func (r *AccountsService) Patch(merchantId uint64, accountId uint64, account *Account) *AccountsPatchCall {
- c := &AccountsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.accountId = accountId
- c.account = account
- return c
-}
-
-// DryRun sets the optional parameter "dryRun": Flag to run the request
-// in dry-run mode.
-func (c *AccountsPatchCall) DryRun(dryRun bool) *AccountsPatchCall {
- c.opt_["dryRun"] = dryRun
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsPatchCall) Fields(s ...googleapi.Field) *AccountsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsPatchCall) Context(ctx context.Context) *AccountsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.account)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["dryRun"]; ok {
- params.Set("dryRun", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/accounts/{accountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "accountId": strconv.FormatUint(c.accountId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.accounts.patch" call.
-// Exactly one of *Account or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Account.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsPatchCall) Do() (*Account, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Account{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a Merchant Center account. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "content.accounts.patch",
- // "parameterOrder": [
- // "merchantId",
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The ID of the account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "dryRun": {
- // "description": "Flag to run the request in dry-run mode.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/accounts/{accountId}",
- // "request": {
- // "$ref": "Account"
- // },
- // "response": {
- // "$ref": "Account"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.accounts.update":
-
-type AccountsUpdateCall struct {
- s *Service
- merchantId uint64
- accountId uint64
- account *Account
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates a Merchant Center account.
-func (r *AccountsService) Update(merchantId uint64, accountId uint64, account *Account) *AccountsUpdateCall {
- c := &AccountsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.accountId = accountId
- c.account = account
- return c
-}
-
-// DryRun sets the optional parameter "dryRun": Flag to run the request
-// in dry-run mode.
-func (c *AccountsUpdateCall) DryRun(dryRun bool) *AccountsUpdateCall {
- c.opt_["dryRun"] = dryRun
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsUpdateCall) Fields(s ...googleapi.Field) *AccountsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsUpdateCall) Context(ctx context.Context) *AccountsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.account)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["dryRun"]; ok {
- params.Set("dryRun", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/accounts/{accountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "accountId": strconv.FormatUint(c.accountId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.accounts.update" call.
-// Exactly one of *Account or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Account.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsUpdateCall) Do() (*Account, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Account{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a Merchant Center account.",
- // "httpMethod": "PUT",
- // "id": "content.accounts.update",
- // "parameterOrder": [
- // "merchantId",
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The ID of the account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "dryRun": {
- // "description": "Flag to run the request in dry-run mode.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/accounts/{accountId}",
- // "request": {
- // "$ref": "Account"
- // },
- // "response": {
- // "$ref": "Account"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.accountshipping.custombatch":
-
-type AccountshippingCustombatchCall struct {
- s *Service
- accountshippingcustombatchrequest *AccountshippingCustomBatchRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Custombatch: Retrieves and updates the shipping settings of multiple
-// accounts in a single request.
-func (r *AccountshippingService) Custombatch(accountshippingcustombatchrequest *AccountshippingCustomBatchRequest) *AccountshippingCustombatchCall {
- c := &AccountshippingCustombatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountshippingcustombatchrequest = accountshippingcustombatchrequest
- return c
-}
-
-// DryRun sets the optional parameter "dryRun": Flag to run the request
-// in dry-run mode.
-func (c *AccountshippingCustombatchCall) DryRun(dryRun bool) *AccountshippingCustombatchCall {
- c.opt_["dryRun"] = dryRun
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountshippingCustombatchCall) Fields(s ...googleapi.Field) *AccountshippingCustombatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountshippingCustombatchCall) Context(ctx context.Context) *AccountshippingCustombatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountshippingCustombatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.accountshippingcustombatchrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["dryRun"]; ok {
- params.Set("dryRun", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accountshipping/batch")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.accountshipping.custombatch" call.
-// Exactly one of *AccountshippingCustomBatchResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *AccountshippingCustomBatchResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *AccountshippingCustombatchCall) Do() (*AccountshippingCustomBatchResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountshippingCustomBatchResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves and updates the shipping settings of multiple accounts in a single request.",
- // "httpMethod": "POST",
- // "id": "content.accountshipping.custombatch",
- // "parameters": {
- // "dryRun": {
- // "description": "Flag to run the request in dry-run mode.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "accountshipping/batch",
- // "request": {
- // "$ref": "AccountshippingCustomBatchRequest"
- // },
- // "response": {
- // "$ref": "AccountshippingCustomBatchResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.accountshipping.get":
-
-type AccountshippingGetCall struct {
- s *Service
- merchantId uint64
- accountId uint64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves the shipping settings of the account.
-func (r *AccountshippingService) Get(merchantId uint64, accountId uint64) *AccountshippingGetCall {
- c := &AccountshippingGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.accountId = accountId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountshippingGetCall) Fields(s ...googleapi.Field) *AccountshippingGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountshippingGetCall) IfNoneMatch(entityTag string) *AccountshippingGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountshippingGetCall) Context(ctx context.Context) *AccountshippingGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountshippingGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/accountshipping/{accountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "accountId": strconv.FormatUint(c.accountId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.accountshipping.get" call.
-// Exactly one of *AccountShipping or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AccountShipping.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountshippingGetCall) Do() (*AccountShipping, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountShipping{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the shipping settings of the account.",
- // "httpMethod": "GET",
- // "id": "content.accountshipping.get",
- // "parameterOrder": [
- // "merchantId",
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The ID of the account for which to get/update account shipping settings.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/accountshipping/{accountId}",
- // "response": {
- // "$ref": "AccountShipping"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.accountshipping.list":
-
-type AccountshippingListCall struct {
- s *Service
- merchantId uint64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists the shipping settings of the sub-accounts in your
-// Merchant Center account.
-func (r *AccountshippingService) List(merchantId uint64) *AccountshippingListCall {
- c := &AccountshippingListCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of shipping settings to return in the response, used for
-// paging.
-func (c *AccountshippingListCall) MaxResults(maxResults int64) *AccountshippingListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The token returned
-// by the previous request.
-func (c *AccountshippingListCall) PageToken(pageToken string) *AccountshippingListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountshippingListCall) Fields(s ...googleapi.Field) *AccountshippingListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountshippingListCall) IfNoneMatch(entityTag string) *AccountshippingListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountshippingListCall) Context(ctx context.Context) *AccountshippingListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountshippingListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/accountshipping")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.accountshipping.list" call.
-// Exactly one of *AccountshippingListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *AccountshippingListResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountshippingListCall) Do() (*AccountshippingListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountshippingListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists the shipping settings of the sub-accounts in your Merchant Center account.",
- // "httpMethod": "GET",
- // "id": "content.accountshipping.list",
- // "parameterOrder": [
- // "merchantId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "The maximum number of shipping settings to return in the response, used for paging.",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "The token returned by the previous request.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/accountshipping",
- // "response": {
- // "$ref": "AccountshippingListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.accountshipping.patch":
-
-type AccountshippingPatchCall struct {
- s *Service
- merchantId uint64
- accountId uint64
- accountshipping *AccountShipping
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates the shipping settings of the account. This method
-// supports patch semantics.
-func (r *AccountshippingService) Patch(merchantId uint64, accountId uint64, accountshipping *AccountShipping) *AccountshippingPatchCall {
- c := &AccountshippingPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.accountId = accountId
- c.accountshipping = accountshipping
- return c
-}
-
-// DryRun sets the optional parameter "dryRun": Flag to run the request
-// in dry-run mode.
-func (c *AccountshippingPatchCall) DryRun(dryRun bool) *AccountshippingPatchCall {
- c.opt_["dryRun"] = dryRun
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountshippingPatchCall) Fields(s ...googleapi.Field) *AccountshippingPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountshippingPatchCall) Context(ctx context.Context) *AccountshippingPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountshippingPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.accountshipping)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["dryRun"]; ok {
- params.Set("dryRun", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/accountshipping/{accountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "accountId": strconv.FormatUint(c.accountId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.accountshipping.patch" call.
-// Exactly one of *AccountShipping or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AccountShipping.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountshippingPatchCall) Do() (*AccountShipping, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountShipping{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates the shipping settings of the account. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "content.accountshipping.patch",
- // "parameterOrder": [
- // "merchantId",
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The ID of the account for which to get/update account shipping settings.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "dryRun": {
- // "description": "Flag to run the request in dry-run mode.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/accountshipping/{accountId}",
- // "request": {
- // "$ref": "AccountShipping"
- // },
- // "response": {
- // "$ref": "AccountShipping"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.accountshipping.update":
-
-type AccountshippingUpdateCall struct {
- s *Service
- merchantId uint64
- accountId uint64
- accountshipping *AccountShipping
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates the shipping settings of the account.
-func (r *AccountshippingService) Update(merchantId uint64, accountId uint64, accountshipping *AccountShipping) *AccountshippingUpdateCall {
- c := &AccountshippingUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.accountId = accountId
- c.accountshipping = accountshipping
- return c
-}
-
-// DryRun sets the optional parameter "dryRun": Flag to run the request
-// in dry-run mode.
-func (c *AccountshippingUpdateCall) DryRun(dryRun bool) *AccountshippingUpdateCall {
- c.opt_["dryRun"] = dryRun
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountshippingUpdateCall) Fields(s ...googleapi.Field) *AccountshippingUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountshippingUpdateCall) Context(ctx context.Context) *AccountshippingUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountshippingUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.accountshipping)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["dryRun"]; ok {
- params.Set("dryRun", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/accountshipping/{accountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "accountId": strconv.FormatUint(c.accountId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.accountshipping.update" call.
-// Exactly one of *AccountShipping or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AccountShipping.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountshippingUpdateCall) Do() (*AccountShipping, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountShipping{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates the shipping settings of the account.",
- // "httpMethod": "PUT",
- // "id": "content.accountshipping.update",
- // "parameterOrder": [
- // "merchantId",
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The ID of the account for which to get/update account shipping settings.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "dryRun": {
- // "description": "Flag to run the request in dry-run mode.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/accountshipping/{accountId}",
- // "request": {
- // "$ref": "AccountShipping"
- // },
- // "response": {
- // "$ref": "AccountShipping"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.accountstatuses.custombatch":
-
-type AccountstatusesCustombatchCall struct {
- s *Service
- accountstatusescustombatchrequest *AccountstatusesCustomBatchRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Custombatch:
-func (r *AccountstatusesService) Custombatch(accountstatusescustombatchrequest *AccountstatusesCustomBatchRequest) *AccountstatusesCustombatchCall {
- c := &AccountstatusesCustombatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.accountstatusescustombatchrequest = accountstatusescustombatchrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountstatusesCustombatchCall) Fields(s ...googleapi.Field) *AccountstatusesCustombatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountstatusesCustombatchCall) Context(ctx context.Context) *AccountstatusesCustombatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountstatusesCustombatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.accountstatusescustombatchrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accountstatuses/batch")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.accountstatuses.custombatch" call.
-// Exactly one of *AccountstatusesCustomBatchResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *AccountstatusesCustomBatchResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *AccountstatusesCustombatchCall) Do() (*AccountstatusesCustomBatchResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountstatusesCustomBatchResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "httpMethod": "POST",
- // "id": "content.accountstatuses.custombatch",
- // "path": "accountstatuses/batch",
- // "request": {
- // "$ref": "AccountstatusesCustomBatchRequest"
- // },
- // "response": {
- // "$ref": "AccountstatusesCustomBatchResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.accountstatuses.get":
-
-type AccountstatusesGetCall struct {
- s *Service
- merchantId uint64
- accountId uint64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves the status of a Merchant Center account.
-func (r *AccountstatusesService) Get(merchantId uint64, accountId uint64) *AccountstatusesGetCall {
- c := &AccountstatusesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.accountId = accountId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountstatusesGetCall) Fields(s ...googleapi.Field) *AccountstatusesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountstatusesGetCall) IfNoneMatch(entityTag string) *AccountstatusesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountstatusesGetCall) Context(ctx context.Context) *AccountstatusesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountstatusesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/accountstatuses/{accountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "accountId": strconv.FormatUint(c.accountId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.accountstatuses.get" call.
-// Exactly one of *AccountStatus or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AccountStatus.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountstatusesGetCall) Do() (*AccountStatus, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountStatus{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the status of a Merchant Center account.",
- // "httpMethod": "GET",
- // "id": "content.accountstatuses.get",
- // "parameterOrder": [
- // "merchantId",
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The ID of the account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/accountstatuses/{accountId}",
- // "response": {
- // "$ref": "AccountStatus"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.accountstatuses.list":
-
-type AccountstatusesListCall struct {
- s *Service
- merchantId uint64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists the statuses of the sub-accounts in your Merchant Center
-// account.
-func (r *AccountstatusesService) List(merchantId uint64) *AccountstatusesListCall {
- c := &AccountstatusesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of account statuses to return in the response, used for
-// paging.
-func (c *AccountstatusesListCall) MaxResults(maxResults int64) *AccountstatusesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The token returned
-// by the previous request.
-func (c *AccountstatusesListCall) PageToken(pageToken string) *AccountstatusesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountstatusesListCall) Fields(s ...googleapi.Field) *AccountstatusesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountstatusesListCall) IfNoneMatch(entityTag string) *AccountstatusesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountstatusesListCall) Context(ctx context.Context) *AccountstatusesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountstatusesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/accountstatuses")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.accountstatuses.list" call.
-// Exactly one of *AccountstatusesListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *AccountstatusesListResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountstatusesListCall) Do() (*AccountstatusesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountstatusesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists the statuses of the sub-accounts in your Merchant Center account.",
- // "httpMethod": "GET",
- // "id": "content.accountstatuses.list",
- // "parameterOrder": [
- // "merchantId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "The maximum number of account statuses to return in the response, used for paging.",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "The token returned by the previous request.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/accountstatuses",
- // "response": {
- // "$ref": "AccountstatusesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.accounttax.custombatch":
-
-type AccounttaxCustombatchCall struct {
- s *Service
- accounttaxcustombatchrequest *AccounttaxCustomBatchRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Custombatch: Retrieves and updates tax settings of multiple accounts
-// in a single request.
-func (r *AccounttaxService) Custombatch(accounttaxcustombatchrequest *AccounttaxCustomBatchRequest) *AccounttaxCustombatchCall {
- c := &AccounttaxCustombatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.accounttaxcustombatchrequest = accounttaxcustombatchrequest
- return c
-}
-
-// DryRun sets the optional parameter "dryRun": Flag to run the request
-// in dry-run mode.
-func (c *AccounttaxCustombatchCall) DryRun(dryRun bool) *AccounttaxCustombatchCall {
- c.opt_["dryRun"] = dryRun
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccounttaxCustombatchCall) Fields(s ...googleapi.Field) *AccounttaxCustombatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccounttaxCustombatchCall) Context(ctx context.Context) *AccounttaxCustombatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccounttaxCustombatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.accounttaxcustombatchrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["dryRun"]; ok {
- params.Set("dryRun", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "accounttax/batch")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.accounttax.custombatch" call.
-// Exactly one of *AccounttaxCustomBatchResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *AccounttaxCustomBatchResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccounttaxCustombatchCall) Do() (*AccounttaxCustomBatchResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccounttaxCustomBatchResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves and updates tax settings of multiple accounts in a single request.",
- // "httpMethod": "POST",
- // "id": "content.accounttax.custombatch",
- // "parameters": {
- // "dryRun": {
- // "description": "Flag to run the request in dry-run mode.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "accounttax/batch",
- // "request": {
- // "$ref": "AccounttaxCustomBatchRequest"
- // },
- // "response": {
- // "$ref": "AccounttaxCustomBatchResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.accounttax.get":
-
-type AccounttaxGetCall struct {
- s *Service
- merchantId uint64
- accountId uint64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves the tax settings of the account.
-func (r *AccounttaxService) Get(merchantId uint64, accountId uint64) *AccounttaxGetCall {
- c := &AccounttaxGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.accountId = accountId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccounttaxGetCall) Fields(s ...googleapi.Field) *AccounttaxGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccounttaxGetCall) IfNoneMatch(entityTag string) *AccounttaxGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccounttaxGetCall) Context(ctx context.Context) *AccounttaxGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccounttaxGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/accounttax/{accountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "accountId": strconv.FormatUint(c.accountId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.accounttax.get" call.
-// Exactly one of *AccountTax or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AccountTax.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccounttaxGetCall) Do() (*AccountTax, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountTax{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the tax settings of the account.",
- // "httpMethod": "GET",
- // "id": "content.accounttax.get",
- // "parameterOrder": [
- // "merchantId",
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The ID of the account for which to get/update account tax settings.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/accounttax/{accountId}",
- // "response": {
- // "$ref": "AccountTax"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.accounttax.list":
-
-type AccounttaxListCall struct {
- s *Service
- merchantId uint64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists the tax settings of the sub-accounts in your Merchant
-// Center account.
-func (r *AccounttaxService) List(merchantId uint64) *AccounttaxListCall {
- c := &AccounttaxListCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of tax settings to return in the response, used for paging.
-func (c *AccounttaxListCall) MaxResults(maxResults int64) *AccounttaxListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The token returned
-// by the previous request.
-func (c *AccounttaxListCall) PageToken(pageToken string) *AccounttaxListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccounttaxListCall) Fields(s ...googleapi.Field) *AccounttaxListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccounttaxListCall) IfNoneMatch(entityTag string) *AccounttaxListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccounttaxListCall) Context(ctx context.Context) *AccounttaxListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccounttaxListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/accounttax")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.accounttax.list" call.
-// Exactly one of *AccounttaxListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AccounttaxListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccounttaxListCall) Do() (*AccounttaxListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccounttaxListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists the tax settings of the sub-accounts in your Merchant Center account.",
- // "httpMethod": "GET",
- // "id": "content.accounttax.list",
- // "parameterOrder": [
- // "merchantId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "The maximum number of tax settings to return in the response, used for paging.",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "The token returned by the previous request.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/accounttax",
- // "response": {
- // "$ref": "AccounttaxListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.accounttax.patch":
-
-type AccounttaxPatchCall struct {
- s *Service
- merchantId uint64
- accountId uint64
- accounttax *AccountTax
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates the tax settings of the account. This method supports
-// patch semantics.
-func (r *AccounttaxService) Patch(merchantId uint64, accountId uint64, accounttax *AccountTax) *AccounttaxPatchCall {
- c := &AccounttaxPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.accountId = accountId
- c.accounttax = accounttax
- return c
-}
-
-// DryRun sets the optional parameter "dryRun": Flag to run the request
-// in dry-run mode.
-func (c *AccounttaxPatchCall) DryRun(dryRun bool) *AccounttaxPatchCall {
- c.opt_["dryRun"] = dryRun
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccounttaxPatchCall) Fields(s ...googleapi.Field) *AccounttaxPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccounttaxPatchCall) Context(ctx context.Context) *AccounttaxPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccounttaxPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.accounttax)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["dryRun"]; ok {
- params.Set("dryRun", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/accounttax/{accountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "accountId": strconv.FormatUint(c.accountId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.accounttax.patch" call.
-// Exactly one of *AccountTax or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AccountTax.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccounttaxPatchCall) Do() (*AccountTax, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountTax{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates the tax settings of the account. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "content.accounttax.patch",
- // "parameterOrder": [
- // "merchantId",
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The ID of the account for which to get/update account tax settings.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "dryRun": {
- // "description": "Flag to run the request in dry-run mode.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/accounttax/{accountId}",
- // "request": {
- // "$ref": "AccountTax"
- // },
- // "response": {
- // "$ref": "AccountTax"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.accounttax.update":
-
-type AccounttaxUpdateCall struct {
- s *Service
- merchantId uint64
- accountId uint64
- accounttax *AccountTax
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates the tax settings of the account.
-func (r *AccounttaxService) Update(merchantId uint64, accountId uint64, accounttax *AccountTax) *AccounttaxUpdateCall {
- c := &AccounttaxUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.accountId = accountId
- c.accounttax = accounttax
- return c
-}
-
-// DryRun sets the optional parameter "dryRun": Flag to run the request
-// in dry-run mode.
-func (c *AccounttaxUpdateCall) DryRun(dryRun bool) *AccounttaxUpdateCall {
- c.opt_["dryRun"] = dryRun
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccounttaxUpdateCall) Fields(s ...googleapi.Field) *AccounttaxUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccounttaxUpdateCall) Context(ctx context.Context) *AccounttaxUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccounttaxUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.accounttax)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["dryRun"]; ok {
- params.Set("dryRun", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/accounttax/{accountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "accountId": strconv.FormatUint(c.accountId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.accounttax.update" call.
-// Exactly one of *AccountTax or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AccountTax.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AccounttaxUpdateCall) Do() (*AccountTax, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountTax{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates the tax settings of the account.",
- // "httpMethod": "PUT",
- // "id": "content.accounttax.update",
- // "parameterOrder": [
- // "merchantId",
- // "accountId"
- // ],
- // "parameters": {
- // "accountId": {
- // "description": "The ID of the account for which to get/update account tax settings.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "dryRun": {
- // "description": "Flag to run the request in dry-run mode.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/accounttax/{accountId}",
- // "request": {
- // "$ref": "AccountTax"
- // },
- // "response": {
- // "$ref": "AccountTax"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.datafeeds.custombatch":
-
-type DatafeedsCustombatchCall struct {
- s *Service
- datafeedscustombatchrequest *DatafeedsCustomBatchRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Custombatch:
-func (r *DatafeedsService) Custombatch(datafeedscustombatchrequest *DatafeedsCustomBatchRequest) *DatafeedsCustombatchCall {
- c := &DatafeedsCustombatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.datafeedscustombatchrequest = datafeedscustombatchrequest
- return c
-}
-
-// DryRun sets the optional parameter "dryRun": Flag to run the request
-// in dry-run mode.
-func (c *DatafeedsCustombatchCall) DryRun(dryRun bool) *DatafeedsCustombatchCall {
- c.opt_["dryRun"] = dryRun
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatafeedsCustombatchCall) Fields(s ...googleapi.Field) *DatafeedsCustombatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatafeedsCustombatchCall) Context(ctx context.Context) *DatafeedsCustombatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatafeedsCustombatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.datafeedscustombatchrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["dryRun"]; ok {
- params.Set("dryRun", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "datafeeds/batch")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.datafeeds.custombatch" call.
-// Exactly one of *DatafeedsCustomBatchResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *DatafeedsCustomBatchResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DatafeedsCustombatchCall) Do() (*DatafeedsCustomBatchResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DatafeedsCustomBatchResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "httpMethod": "POST",
- // "id": "content.datafeeds.custombatch",
- // "parameters": {
- // "dryRun": {
- // "description": "Flag to run the request in dry-run mode.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "datafeeds/batch",
- // "request": {
- // "$ref": "DatafeedsCustomBatchRequest"
- // },
- // "response": {
- // "$ref": "DatafeedsCustomBatchResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.datafeeds.delete":
-
-type DatafeedsDeleteCall struct {
- s *Service
- merchantId uint64
- datafeedId uint64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes a datafeed from your Merchant Center account.
-func (r *DatafeedsService) Delete(merchantId uint64, datafeedId uint64) *DatafeedsDeleteCall {
- c := &DatafeedsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.datafeedId = datafeedId
- return c
-}
-
-// DryRun sets the optional parameter "dryRun": Flag to run the request
-// in dry-run mode.
-func (c *DatafeedsDeleteCall) DryRun(dryRun bool) *DatafeedsDeleteCall {
- c.opt_["dryRun"] = dryRun
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatafeedsDeleteCall) Fields(s ...googleapi.Field) *DatafeedsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatafeedsDeleteCall) Context(ctx context.Context) *DatafeedsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatafeedsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["dryRun"]; ok {
- params.Set("dryRun", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/datafeeds/{datafeedId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "datafeedId": strconv.FormatUint(c.datafeedId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.datafeeds.delete" call.
-func (c *DatafeedsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes a datafeed from your Merchant Center account.",
- // "httpMethod": "DELETE",
- // "id": "content.datafeeds.delete",
- // "parameterOrder": [
- // "merchantId",
- // "datafeedId"
- // ],
- // "parameters": {
- // "datafeedId": {
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "dryRun": {
- // "description": "Flag to run the request in dry-run mode.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "merchantId": {
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/datafeeds/{datafeedId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.datafeeds.get":
-
-type DatafeedsGetCall struct {
- s *Service
- merchantId uint64
- datafeedId uint64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves a datafeed from your Merchant Center account.
-func (r *DatafeedsService) Get(merchantId uint64, datafeedId uint64) *DatafeedsGetCall {
- c := &DatafeedsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.datafeedId = datafeedId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatafeedsGetCall) Fields(s ...googleapi.Field) *DatafeedsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DatafeedsGetCall) IfNoneMatch(entityTag string) *DatafeedsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatafeedsGetCall) Context(ctx context.Context) *DatafeedsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatafeedsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/datafeeds/{datafeedId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "datafeedId": strconv.FormatUint(c.datafeedId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.datafeeds.get" call.
-// Exactly one of *Datafeed or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Datafeed.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DatafeedsGetCall) Do() (*Datafeed, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Datafeed{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a datafeed from your Merchant Center account.",
- // "httpMethod": "GET",
- // "id": "content.datafeeds.get",
- // "parameterOrder": [
- // "merchantId",
- // "datafeedId"
- // ],
- // "parameters": {
- // "datafeedId": {
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "merchantId": {
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/datafeeds/{datafeedId}",
- // "response": {
- // "$ref": "Datafeed"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.datafeeds.insert":
-
-type DatafeedsInsertCall struct {
- s *Service
- merchantId uint64
- datafeed *Datafeed
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Registers a datafeed with your Merchant Center account.
-func (r *DatafeedsService) Insert(merchantId uint64, datafeed *Datafeed) *DatafeedsInsertCall {
- c := &DatafeedsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.datafeed = datafeed
- return c
-}
-
-// DryRun sets the optional parameter "dryRun": Flag to run the request
-// in dry-run mode.
-func (c *DatafeedsInsertCall) DryRun(dryRun bool) *DatafeedsInsertCall {
- c.opt_["dryRun"] = dryRun
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatafeedsInsertCall) Fields(s ...googleapi.Field) *DatafeedsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatafeedsInsertCall) Context(ctx context.Context) *DatafeedsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatafeedsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.datafeed)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["dryRun"]; ok {
- params.Set("dryRun", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/datafeeds")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.datafeeds.insert" call.
-// Exactly one of *Datafeed or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Datafeed.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DatafeedsInsertCall) Do() (*Datafeed, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Datafeed{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Registers a datafeed with your Merchant Center account.",
- // "httpMethod": "POST",
- // "id": "content.datafeeds.insert",
- // "parameterOrder": [
- // "merchantId"
- // ],
- // "parameters": {
- // "dryRun": {
- // "description": "Flag to run the request in dry-run mode.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "merchantId": {
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/datafeeds",
- // "request": {
- // "$ref": "Datafeed"
- // },
- // "response": {
- // "$ref": "Datafeed"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.datafeeds.list":
-
-type DatafeedsListCall struct {
- s *Service
- merchantId uint64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists the datafeeds in your Merchant Center account.
-func (r *DatafeedsService) List(merchantId uint64) *DatafeedsListCall {
- c := &DatafeedsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of products to return in the response, used for paging.
-func (c *DatafeedsListCall) MaxResults(maxResults int64) *DatafeedsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The token returned
-// by the previous request.
-func (c *DatafeedsListCall) PageToken(pageToken string) *DatafeedsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatafeedsListCall) Fields(s ...googleapi.Field) *DatafeedsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DatafeedsListCall) IfNoneMatch(entityTag string) *DatafeedsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatafeedsListCall) Context(ctx context.Context) *DatafeedsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatafeedsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/datafeeds")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.datafeeds.list" call.
-// Exactly one of *DatafeedsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *DatafeedsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DatafeedsListCall) Do() (*DatafeedsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DatafeedsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists the datafeeds in your Merchant Center account.",
- // "httpMethod": "GET",
- // "id": "content.datafeeds.list",
- // "parameterOrder": [
- // "merchantId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "The maximum number of products to return in the response, used for paging.",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "The token returned by the previous request.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/datafeeds",
- // "response": {
- // "$ref": "DatafeedsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.datafeeds.patch":
-
-type DatafeedsPatchCall struct {
- s *Service
- merchantId uint64
- datafeedId uint64
- datafeed *Datafeed
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates a datafeed of your Merchant Center account. This
-// method supports patch semantics.
-func (r *DatafeedsService) Patch(merchantId uint64, datafeedId uint64, datafeed *Datafeed) *DatafeedsPatchCall {
- c := &DatafeedsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.datafeedId = datafeedId
- c.datafeed = datafeed
- return c
-}
-
-// DryRun sets the optional parameter "dryRun": Flag to run the request
-// in dry-run mode.
-func (c *DatafeedsPatchCall) DryRun(dryRun bool) *DatafeedsPatchCall {
- c.opt_["dryRun"] = dryRun
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatafeedsPatchCall) Fields(s ...googleapi.Field) *DatafeedsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatafeedsPatchCall) Context(ctx context.Context) *DatafeedsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatafeedsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.datafeed)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["dryRun"]; ok {
- params.Set("dryRun", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/datafeeds/{datafeedId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "datafeedId": strconv.FormatUint(c.datafeedId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.datafeeds.patch" call.
-// Exactly one of *Datafeed or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Datafeed.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DatafeedsPatchCall) Do() (*Datafeed, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Datafeed{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a datafeed of your Merchant Center account. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "content.datafeeds.patch",
- // "parameterOrder": [
- // "merchantId",
- // "datafeedId"
- // ],
- // "parameters": {
- // "datafeedId": {
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "dryRun": {
- // "description": "Flag to run the request in dry-run mode.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "merchantId": {
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/datafeeds/{datafeedId}",
- // "request": {
- // "$ref": "Datafeed"
- // },
- // "response": {
- // "$ref": "Datafeed"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.datafeeds.update":
-
-type DatafeedsUpdateCall struct {
- s *Service
- merchantId uint64
- datafeedId uint64
- datafeed *Datafeed
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates a datafeed of your Merchant Center account.
-func (r *DatafeedsService) Update(merchantId uint64, datafeedId uint64, datafeed *Datafeed) *DatafeedsUpdateCall {
- c := &DatafeedsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.datafeedId = datafeedId
- c.datafeed = datafeed
- return c
-}
-
-// DryRun sets the optional parameter "dryRun": Flag to run the request
-// in dry-run mode.
-func (c *DatafeedsUpdateCall) DryRun(dryRun bool) *DatafeedsUpdateCall {
- c.opt_["dryRun"] = dryRun
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatafeedsUpdateCall) Fields(s ...googleapi.Field) *DatafeedsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatafeedsUpdateCall) Context(ctx context.Context) *DatafeedsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatafeedsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.datafeed)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["dryRun"]; ok {
- params.Set("dryRun", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/datafeeds/{datafeedId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "datafeedId": strconv.FormatUint(c.datafeedId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.datafeeds.update" call.
-// Exactly one of *Datafeed or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Datafeed.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DatafeedsUpdateCall) Do() (*Datafeed, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Datafeed{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a datafeed of your Merchant Center account.",
- // "httpMethod": "PUT",
- // "id": "content.datafeeds.update",
- // "parameterOrder": [
- // "merchantId",
- // "datafeedId"
- // ],
- // "parameters": {
- // "datafeedId": {
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "dryRun": {
- // "description": "Flag to run the request in dry-run mode.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "merchantId": {
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/datafeeds/{datafeedId}",
- // "request": {
- // "$ref": "Datafeed"
- // },
- // "response": {
- // "$ref": "Datafeed"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.datafeedstatuses.custombatch":
-
-type DatafeedstatusesCustombatchCall struct {
- s *Service
- datafeedstatusescustombatchrequest *DatafeedstatusesCustomBatchRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Custombatch:
-func (r *DatafeedstatusesService) Custombatch(datafeedstatusescustombatchrequest *DatafeedstatusesCustomBatchRequest) *DatafeedstatusesCustombatchCall {
- c := &DatafeedstatusesCustombatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.datafeedstatusescustombatchrequest = datafeedstatusescustombatchrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatafeedstatusesCustombatchCall) Fields(s ...googleapi.Field) *DatafeedstatusesCustombatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatafeedstatusesCustombatchCall) Context(ctx context.Context) *DatafeedstatusesCustombatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatafeedstatusesCustombatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.datafeedstatusescustombatchrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "datafeedstatuses/batch")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.datafeedstatuses.custombatch" call.
-// Exactly one of *DatafeedstatusesCustomBatchResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *DatafeedstatusesCustomBatchResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *DatafeedstatusesCustombatchCall) Do() (*DatafeedstatusesCustomBatchResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DatafeedstatusesCustomBatchResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "httpMethod": "POST",
- // "id": "content.datafeedstatuses.custombatch",
- // "path": "datafeedstatuses/batch",
- // "request": {
- // "$ref": "DatafeedstatusesCustomBatchRequest"
- // },
- // "response": {
- // "$ref": "DatafeedstatusesCustomBatchResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.datafeedstatuses.get":
-
-type DatafeedstatusesGetCall struct {
- s *Service
- merchantId uint64
- datafeedId uint64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves the status of a datafeed from your Merchant Center
-// account.
-func (r *DatafeedstatusesService) Get(merchantId uint64, datafeedId uint64) *DatafeedstatusesGetCall {
- c := &DatafeedstatusesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.datafeedId = datafeedId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatafeedstatusesGetCall) Fields(s ...googleapi.Field) *DatafeedstatusesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DatafeedstatusesGetCall) IfNoneMatch(entityTag string) *DatafeedstatusesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatafeedstatusesGetCall) Context(ctx context.Context) *DatafeedstatusesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatafeedstatusesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/datafeedstatuses/{datafeedId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "datafeedId": strconv.FormatUint(c.datafeedId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.datafeedstatuses.get" call.
-// Exactly one of *DatafeedStatus or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *DatafeedStatus.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DatafeedstatusesGetCall) Do() (*DatafeedStatus, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DatafeedStatus{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the status of a datafeed from your Merchant Center account.",
- // "httpMethod": "GET",
- // "id": "content.datafeedstatuses.get",
- // "parameterOrder": [
- // "merchantId",
- // "datafeedId"
- // ],
- // "parameters": {
- // "datafeedId": {
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "merchantId": {
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/datafeedstatuses/{datafeedId}",
- // "response": {
- // "$ref": "DatafeedStatus"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.datafeedstatuses.list":
-
-type DatafeedstatusesListCall struct {
- s *Service
- merchantId uint64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists the statuses of the datafeeds in your Merchant Center
-// account.
-func (r *DatafeedstatusesService) List(merchantId uint64) *DatafeedstatusesListCall {
- c := &DatafeedstatusesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of products to return in the response, used for paging.
-func (c *DatafeedstatusesListCall) MaxResults(maxResults int64) *DatafeedstatusesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The token returned
-// by the previous request.
-func (c *DatafeedstatusesListCall) PageToken(pageToken string) *DatafeedstatusesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatafeedstatusesListCall) Fields(s ...googleapi.Field) *DatafeedstatusesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DatafeedstatusesListCall) IfNoneMatch(entityTag string) *DatafeedstatusesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatafeedstatusesListCall) Context(ctx context.Context) *DatafeedstatusesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatafeedstatusesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/datafeedstatuses")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.datafeedstatuses.list" call.
-// Exactly one of *DatafeedstatusesListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *DatafeedstatusesListResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DatafeedstatusesListCall) Do() (*DatafeedstatusesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DatafeedstatusesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists the statuses of the datafeeds in your Merchant Center account.",
- // "httpMethod": "GET",
- // "id": "content.datafeedstatuses.list",
- // "parameterOrder": [
- // "merchantId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "The maximum number of products to return in the response, used for paging.",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "The token returned by the previous request.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/datafeedstatuses",
- // "response": {
- // "$ref": "DatafeedstatusesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.inventory.custombatch":
-
-type InventoryCustombatchCall struct {
- s *Service
- inventorycustombatchrequest *InventoryCustomBatchRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Custombatch: Updates price and availability for multiple products or
-// stores in a single request. This operation does not update the
-// expiration date of the products.
-func (r *InventoryService) Custombatch(inventorycustombatchrequest *InventoryCustomBatchRequest) *InventoryCustombatchCall {
- c := &InventoryCustombatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.inventorycustombatchrequest = inventorycustombatchrequest
- return c
-}
-
-// DryRun sets the optional parameter "dryRun": Flag to run the request
-// in dry-run mode.
-func (c *InventoryCustombatchCall) DryRun(dryRun bool) *InventoryCustombatchCall {
- c.opt_["dryRun"] = dryRun
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InventoryCustombatchCall) Fields(s ...googleapi.Field) *InventoryCustombatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InventoryCustombatchCall) Context(ctx context.Context) *InventoryCustombatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InventoryCustombatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.inventorycustombatchrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["dryRun"]; ok {
- params.Set("dryRun", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "inventory/batch")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.inventory.custombatch" call.
-// Exactly one of *InventoryCustomBatchResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *InventoryCustomBatchResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InventoryCustombatchCall) Do() (*InventoryCustomBatchResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InventoryCustomBatchResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates price and availability for multiple products or stores in a single request. This operation does not update the expiration date of the products.",
- // "httpMethod": "POST",
- // "id": "content.inventory.custombatch",
- // "parameters": {
- // "dryRun": {
- // "description": "Flag to run the request in dry-run mode.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "inventory/batch",
- // "request": {
- // "$ref": "InventoryCustomBatchRequest"
- // },
- // "response": {
- // "$ref": "InventoryCustomBatchResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.inventory.set":
-
-type InventorySetCall struct {
- s *Service
- merchantId uint64
- storeCode string
- productId string
- inventorysetrequest *InventorySetRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Set: Updates price and availability of a product in your Merchant
-// Center account. This operation does not update the expiration date of
-// the product.
-func (r *InventoryService) Set(merchantId uint64, storeCode string, productId string, inventorysetrequest *InventorySetRequest) *InventorySetCall {
- c := &InventorySetCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.storeCode = storeCode
- c.productId = productId
- c.inventorysetrequest = inventorysetrequest
- return c
-}
-
-// DryRun sets the optional parameter "dryRun": Flag to run the request
-// in dry-run mode.
-func (c *InventorySetCall) DryRun(dryRun bool) *InventorySetCall {
- c.opt_["dryRun"] = dryRun
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InventorySetCall) Fields(s ...googleapi.Field) *InventorySetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InventorySetCall) Context(ctx context.Context) *InventorySetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InventorySetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.inventorysetrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["dryRun"]; ok {
- params.Set("dryRun", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/inventory/{storeCode}/products/{productId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "storeCode": c.storeCode,
- "productId": c.productId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.inventory.set" call.
-// Exactly one of *InventorySetResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *InventorySetResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InventorySetCall) Do() (*InventorySetResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InventorySetResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates price and availability of a product in your Merchant Center account. This operation does not update the expiration date of the product.",
- // "httpMethod": "POST",
- // "id": "content.inventory.set",
- // "parameterOrder": [
- // "merchantId",
- // "storeCode",
- // "productId"
- // ],
- // "parameters": {
- // "dryRun": {
- // "description": "Flag to run the request in dry-run mode.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "productId": {
- // "description": "The ID of the product for which to update price and availability.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "storeCode": {
- // "description": "The code of the store for which to update price and availability. Use online to update price and availability of an online product.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/inventory/{storeCode}/products/{productId}",
- // "request": {
- // "$ref": "InventorySetRequest"
- // },
- // "response": {
- // "$ref": "InventorySetResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.acknowledge":
-
-type OrdersAcknowledgeCall struct {
- s *Service
- merchantId uint64
- orderId string
- ordersacknowledgerequest *OrdersAcknowledgeRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Acknowledge: Marks an order as acknowledged.
-func (r *OrdersService) Acknowledge(merchantId uint64, orderId string, ordersacknowledgerequest *OrdersAcknowledgeRequest) *OrdersAcknowledgeCall {
- c := &OrdersAcknowledgeCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.orderId = orderId
- c.ordersacknowledgerequest = ordersacknowledgerequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersAcknowledgeCall) Fields(s ...googleapi.Field) *OrdersAcknowledgeCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersAcknowledgeCall) Context(ctx context.Context) *OrdersAcknowledgeCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersAcknowledgeCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.ordersacknowledgerequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/orders/{orderId}/acknowledge")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "orderId": c.orderId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.acknowledge" call.
-// Exactly one of *OrdersAcknowledgeResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *OrdersAcknowledgeResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OrdersAcknowledgeCall) Do() (*OrdersAcknowledgeResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersAcknowledgeResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Marks an order as acknowledged.",
- // "httpMethod": "POST",
- // "id": "content.orders.acknowledge",
- // "parameterOrder": [
- // "merchantId",
- // "orderId"
- // ],
- // "parameters": {
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "orderId": {
- // "description": "The ID of the order.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/orders/{orderId}/acknowledge",
- // "request": {
- // "$ref": "OrdersAcknowledgeRequest"
- // },
- // "response": {
- // "$ref": "OrdersAcknowledgeResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.advancetestorder":
-
-type OrdersAdvancetestorderCall struct {
- s *Service
- merchantId uint64
- orderId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Advancetestorder: Sandbox only. Moves a test order from state
-// "inProgress" to state "pendingShipment".
-func (r *OrdersService) Advancetestorder(merchantId uint64, orderId string) *OrdersAdvancetestorderCall {
- c := &OrdersAdvancetestorderCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.orderId = orderId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersAdvancetestorderCall) Fields(s ...googleapi.Field) *OrdersAdvancetestorderCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersAdvancetestorderCall) Context(ctx context.Context) *OrdersAdvancetestorderCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersAdvancetestorderCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/testorders/{orderId}/advance")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "orderId": c.orderId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.advancetestorder" call.
-// Exactly one of *OrdersAdvanceTestOrderResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *OrdersAdvanceTestOrderResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OrdersAdvancetestorderCall) Do() (*OrdersAdvanceTestOrderResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersAdvanceTestOrderResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sandbox only. Moves a test order from state \"inProgress\" to state \"pendingShipment\".",
- // "httpMethod": "POST",
- // "id": "content.orders.advancetestorder",
- // "parameterOrder": [
- // "merchantId",
- // "orderId"
- // ],
- // "parameters": {
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "orderId": {
- // "description": "The ID of the test order to modify.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/testorders/{orderId}/advance",
- // "response": {
- // "$ref": "OrdersAdvanceTestOrderResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.cancel":
-
-type OrdersCancelCall struct {
- s *Service
- merchantId uint64
- orderId string
- orderscancelrequest *OrdersCancelRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Cancel: Cancels all line items in an order.
-func (r *OrdersService) Cancel(merchantId uint64, orderId string, orderscancelrequest *OrdersCancelRequest) *OrdersCancelCall {
- c := &OrdersCancelCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.orderId = orderId
- c.orderscancelrequest = orderscancelrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersCancelCall) Fields(s ...googleapi.Field) *OrdersCancelCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersCancelCall) Context(ctx context.Context) *OrdersCancelCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersCancelCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.orderscancelrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/orders/{orderId}/cancel")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "orderId": c.orderId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.cancel" call.
-// Exactly one of *OrdersCancelResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *OrdersCancelResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OrdersCancelCall) Do() (*OrdersCancelResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersCancelResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Cancels all line items in an order.",
- // "httpMethod": "POST",
- // "id": "content.orders.cancel",
- // "parameterOrder": [
- // "merchantId",
- // "orderId"
- // ],
- // "parameters": {
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "orderId": {
- // "description": "The ID of the order to cancel.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/orders/{orderId}/cancel",
- // "request": {
- // "$ref": "OrdersCancelRequest"
- // },
- // "response": {
- // "$ref": "OrdersCancelResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.cancellineitem":
-
-type OrdersCancellineitemCall struct {
- s *Service
- merchantId uint64
- orderId string
- orderscancellineitemrequest *OrdersCancelLineItemRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Cancellineitem: Cancels a line item.
-func (r *OrdersService) Cancellineitem(merchantId uint64, orderId string, orderscancellineitemrequest *OrdersCancelLineItemRequest) *OrdersCancellineitemCall {
- c := &OrdersCancellineitemCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.orderId = orderId
- c.orderscancellineitemrequest = orderscancellineitemrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersCancellineitemCall) Fields(s ...googleapi.Field) *OrdersCancellineitemCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersCancellineitemCall) Context(ctx context.Context) *OrdersCancellineitemCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersCancellineitemCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.orderscancellineitemrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/orders/{orderId}/cancelLineItem")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "orderId": c.orderId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.cancellineitem" call.
-// Exactly one of *OrdersCancelLineItemResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *OrdersCancelLineItemResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OrdersCancellineitemCall) Do() (*OrdersCancelLineItemResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersCancelLineItemResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Cancels a line item.",
- // "httpMethod": "POST",
- // "id": "content.orders.cancellineitem",
- // "parameterOrder": [
- // "merchantId",
- // "orderId"
- // ],
- // "parameters": {
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "orderId": {
- // "description": "The ID of the order.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/orders/{orderId}/cancelLineItem",
- // "request": {
- // "$ref": "OrdersCancelLineItemRequest"
- // },
- // "response": {
- // "$ref": "OrdersCancelLineItemResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.createtestorder":
-
-type OrdersCreatetestorderCall struct {
- s *Service
- merchantId uint64
- orderscreatetestorderrequest *OrdersCreateTestOrderRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Createtestorder: Sandbox only. Creates a test order.
-func (r *OrdersService) Createtestorder(merchantId uint64, orderscreatetestorderrequest *OrdersCreateTestOrderRequest) *OrdersCreatetestorderCall {
- c := &OrdersCreatetestorderCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.orderscreatetestorderrequest = orderscreatetestorderrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersCreatetestorderCall) Fields(s ...googleapi.Field) *OrdersCreatetestorderCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersCreatetestorderCall) Context(ctx context.Context) *OrdersCreatetestorderCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersCreatetestorderCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.orderscreatetestorderrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/testorders")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.createtestorder" call.
-// Exactly one of *OrdersCreateTestOrderResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *OrdersCreateTestOrderResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OrdersCreatetestorderCall) Do() (*OrdersCreateTestOrderResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersCreateTestOrderResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sandbox only. Creates a test order.",
- // "httpMethod": "POST",
- // "id": "content.orders.createtestorder",
- // "parameterOrder": [
- // "merchantId"
- // ],
- // "parameters": {
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/testorders",
- // "request": {
- // "$ref": "OrdersCreateTestOrderRequest"
- // },
- // "response": {
- // "$ref": "OrdersCreateTestOrderResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.custombatch":
-
-type OrdersCustombatchCall struct {
- s *Service
- orderscustombatchrequest *OrdersCustomBatchRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Custombatch: Retrieves or modifies multiple orders in a single
-// request.
-func (r *OrdersService) Custombatch(orderscustombatchrequest *OrdersCustomBatchRequest) *OrdersCustombatchCall {
- c := &OrdersCustombatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.orderscustombatchrequest = orderscustombatchrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersCustombatchCall) Fields(s ...googleapi.Field) *OrdersCustombatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersCustombatchCall) Context(ctx context.Context) *OrdersCustombatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersCustombatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.orderscustombatchrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "orders/batch")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.custombatch" call.
-// Exactly one of *OrdersCustomBatchResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *OrdersCustomBatchResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OrdersCustombatchCall) Do() (*OrdersCustomBatchResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersCustomBatchResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves or modifies multiple orders in a single request.",
- // "httpMethod": "POST",
- // "id": "content.orders.custombatch",
- // "path": "orders/batch",
- // "request": {
- // "$ref": "OrdersCustomBatchRequest"
- // },
- // "response": {
- // "$ref": "OrdersCustomBatchResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.get":
-
-type OrdersGetCall struct {
- s *Service
- merchantId uint64
- orderId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves an order from your Merchant Center account.
-func (r *OrdersService) Get(merchantId uint64, orderId string) *OrdersGetCall {
- c := &OrdersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.orderId = orderId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersGetCall) Fields(s ...googleapi.Field) *OrdersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OrdersGetCall) IfNoneMatch(entityTag string) *OrdersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersGetCall) Context(ctx context.Context) *OrdersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/orders/{orderId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "orderId": c.orderId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.get" call.
-// Exactly one of *Order or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Order.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *OrdersGetCall) Do() (*Order, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Order{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves an order from your Merchant Center account.",
- // "httpMethod": "GET",
- // "id": "content.orders.get",
- // "parameterOrder": [
- // "merchantId",
- // "orderId"
- // ],
- // "parameters": {
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "orderId": {
- // "description": "The ID of the order.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/orders/{orderId}",
- // "response": {
- // "$ref": "Order"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.getbymerchantorderid":
-
-type OrdersGetbymerchantorderidCall struct {
- s *Service
- merchantId uint64
- merchantOrderId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Getbymerchantorderid: Retrieves an order using merchant order id.
-func (r *OrdersService) Getbymerchantorderid(merchantId uint64, merchantOrderId string) *OrdersGetbymerchantorderidCall {
- c := &OrdersGetbymerchantorderidCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.merchantOrderId = merchantOrderId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersGetbymerchantorderidCall) Fields(s ...googleapi.Field) *OrdersGetbymerchantorderidCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OrdersGetbymerchantorderidCall) IfNoneMatch(entityTag string) *OrdersGetbymerchantorderidCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersGetbymerchantorderidCall) Context(ctx context.Context) *OrdersGetbymerchantorderidCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersGetbymerchantorderidCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/ordersbymerchantid/{merchantOrderId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "merchantOrderId": c.merchantOrderId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.getbymerchantorderid" call.
-// Exactly one of *OrdersGetByMerchantOrderIdResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *OrdersGetByMerchantOrderIdResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *OrdersGetbymerchantorderidCall) Do() (*OrdersGetByMerchantOrderIdResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersGetByMerchantOrderIdResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves an order using merchant order id.",
- // "httpMethod": "GET",
- // "id": "content.orders.getbymerchantorderid",
- // "parameterOrder": [
- // "merchantId",
- // "merchantOrderId"
- // ],
- // "parameters": {
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "merchantOrderId": {
- // "description": "The merchant order id to be looked for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/ordersbymerchantid/{merchantOrderId}",
- // "response": {
- // "$ref": "OrdersGetByMerchantOrderIdResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.gettestordertemplate":
-
-type OrdersGettestordertemplateCall struct {
- s *Service
- merchantId uint64
- templateName string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Gettestordertemplate: Sandbox only. Retrieves an order template that
-// can be used to quickly create a new order in sandbox.
-func (r *OrdersService) Gettestordertemplate(merchantId uint64, templateName string) *OrdersGettestordertemplateCall {
- c := &OrdersGettestordertemplateCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.templateName = templateName
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersGettestordertemplateCall) Fields(s ...googleapi.Field) *OrdersGettestordertemplateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OrdersGettestordertemplateCall) IfNoneMatch(entityTag string) *OrdersGettestordertemplateCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersGettestordertemplateCall) Context(ctx context.Context) *OrdersGettestordertemplateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersGettestordertemplateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/testordertemplates/{templateName}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "templateName": c.templateName,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.gettestordertemplate" call.
-// Exactly one of *OrdersGetTestOrderTemplateResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *OrdersGetTestOrderTemplateResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *OrdersGettestordertemplateCall) Do() (*OrdersGetTestOrderTemplateResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersGetTestOrderTemplateResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.",
- // "httpMethod": "GET",
- // "id": "content.orders.gettestordertemplate",
- // "parameterOrder": [
- // "merchantId",
- // "templateName"
- // ],
- // "parameters": {
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "templateName": {
- // "description": "The name of the template to retrieve.",
- // "enum": [
- // "template1",
- // "template2"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/testordertemplates/{templateName}",
- // "response": {
- // "$ref": "OrdersGetTestOrderTemplateResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.list":
-
-type OrdersListCall struct {
- s *Service
- merchantId uint64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists the orders in your Merchant Center account.
-func (r *OrdersService) List(merchantId uint64) *OrdersListCall {
- c := &OrdersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- return c
-}
-
-// Acknowledged sets the optional parameter "acknowledged": Obtains
-// orders that match the acknowledgement status. When set to true,
-// obtains orders that have been acknowledged. When false, obtains
-// orders that have not been acknowledged.
-// We recommend using this filter set to false, in conjunction with the
-// acknowledge call, such that only un-acknowledged orders are returned.
-func (c *OrdersListCall) Acknowledged(acknowledged bool) *OrdersListCall {
- c.opt_["acknowledged"] = acknowledged
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of orders to return in the response, used for paging. The
-// default value is 25 orders per page, and the maximum allowed value is
-// 250 orders per page.
-// Known issue: All List calls will return all Orders without limit
-// regardless of the value of this field.
-func (c *OrdersListCall) MaxResults(maxResults int64) *OrdersListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": The ordering of the
-// returned list. The only supported value are placedDate desc and
-// placedDate asc for now, which returns orders sorted by placement
-// date. "placedDate desc" stands for listing orders by placement date,
-// from oldest to most recent. "placedDate asc" stands for listing
-// orders by placement date, from most recent to oldest. In future
-// releases we'll support other sorting criteria.
-//
-// Possible values:
-// "placedDate asc"
-// "placedDate desc"
-func (c *OrdersListCall) OrderBy(orderBy string) *OrdersListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The token returned
-// by the previous request.
-func (c *OrdersListCall) PageToken(pageToken string) *OrdersListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// PlacedDateEnd sets the optional parameter "placedDateEnd": Obtains
-// orders placed before this date (exclusively), in ISO 8601 format.
-func (c *OrdersListCall) PlacedDateEnd(placedDateEnd string) *OrdersListCall {
- c.opt_["placedDateEnd"] = placedDateEnd
- return c
-}
-
-// PlacedDateStart sets the optional parameter "placedDateStart":
-// Obtains orders placed after this date (inclusively), in ISO 8601
-// format.
-func (c *OrdersListCall) PlacedDateStart(placedDateStart string) *OrdersListCall {
- c.opt_["placedDateStart"] = placedDateStart
- return c
-}
-
-// Statuses sets the optional parameter "statuses": Obtains orders that
-// match any of the specified statuses. Multiple values can be specified
-// with comma separation. Additionally, please note that active is a
-// shortcut for pendingShipment and partiallyShipped, and completed is a
-// shortcut for shipped , partiallyDelivered, delivered,
-// partiallyReturned, returned, and canceled.
-//
-// Possible values:
-// "active"
-// "canceled"
-// "completed"
-// "delivered"
-// "inProgress"
-// "partiallyDelivered"
-// "partiallyReturned"
-// "partiallyShipped"
-// "pendingShipment"
-// "returned"
-// "shipped"
-func (c *OrdersListCall) Statuses(statuses string) *OrdersListCall {
- c.opt_["statuses"] = statuses
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersListCall) Fields(s ...googleapi.Field) *OrdersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OrdersListCall) IfNoneMatch(entityTag string) *OrdersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersListCall) Context(ctx context.Context) *OrdersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["acknowledged"]; ok {
- params.Set("acknowledged", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["placedDateEnd"]; ok {
- params.Set("placedDateEnd", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["placedDateStart"]; ok {
- params.Set("placedDateStart", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["statuses"]; ok {
- params.Set("statuses", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/orders")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.list" call.
-// Exactly one of *OrdersListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *OrdersListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OrdersListCall) Do() (*OrdersListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists the orders in your Merchant Center account.",
- // "httpMethod": "GET",
- // "id": "content.orders.list",
- // "parameterOrder": [
- // "merchantId"
- // ],
- // "parameters": {
- // "acknowledged": {
- // "description": "Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged.\nWe recommend using this filter set to false, in conjunction with the acknowledge call, such that only un-acknowledged orders are returned.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.\nKnown issue: All List calls will return all Orders without limit regardless of the value of this field.",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "orderBy": {
- // "description": "The ordering of the returned list. The only supported value are placedDate desc and placedDate asc for now, which returns orders sorted by placement date. \"placedDate desc\" stands for listing orders by placement date, from oldest to most recent. \"placedDate asc\" stands for listing orders by placement date, from most recent to oldest. In future releases we'll support other sorting criteria.",
- // "enum": [
- // "placedDate asc",
- // "placedDate desc"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "The token returned by the previous request.",
- // "location": "query",
- // "type": "string"
- // },
- // "placedDateEnd": {
- // "description": "Obtains orders placed before this date (exclusively), in ISO 8601 format.",
- // "location": "query",
- // "type": "string"
- // },
- // "placedDateStart": {
- // "description": "Obtains orders placed after this date (inclusively), in ISO 8601 format.",
- // "location": "query",
- // "type": "string"
- // },
- // "statuses": {
- // "description": "Obtains orders that match any of the specified statuses. Multiple values can be specified with comma separation. Additionally, please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped , partiallyDelivered, delivered, partiallyReturned, returned, and canceled.",
- // "enum": [
- // "active",
- // "canceled",
- // "completed",
- // "delivered",
- // "inProgress",
- // "partiallyDelivered",
- // "partiallyReturned",
- // "partiallyShipped",
- // "pendingShipment",
- // "returned",
- // "shipped"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/orders",
- // "response": {
- // "$ref": "OrdersListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.refund":
-
-type OrdersRefundCall struct {
- s *Service
- merchantId uint64
- orderId string
- ordersrefundrequest *OrdersRefundRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Refund: Refund a portion of the order, up to the full amount paid.
-func (r *OrdersService) Refund(merchantId uint64, orderId string, ordersrefundrequest *OrdersRefundRequest) *OrdersRefundCall {
- c := &OrdersRefundCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.orderId = orderId
- c.ordersrefundrequest = ordersrefundrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersRefundCall) Fields(s ...googleapi.Field) *OrdersRefundCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersRefundCall) Context(ctx context.Context) *OrdersRefundCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersRefundCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.ordersrefundrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/orders/{orderId}/refund")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "orderId": c.orderId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.refund" call.
-// Exactly one of *OrdersRefundResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *OrdersRefundResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OrdersRefundCall) Do() (*OrdersRefundResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersRefundResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Refund a portion of the order, up to the full amount paid.",
- // "httpMethod": "POST",
- // "id": "content.orders.refund",
- // "parameterOrder": [
- // "merchantId",
- // "orderId"
- // ],
- // "parameters": {
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "orderId": {
- // "description": "The ID of the order to refund.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/orders/{orderId}/refund",
- // "request": {
- // "$ref": "OrdersRefundRequest"
- // },
- // "response": {
- // "$ref": "OrdersRefundResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.returnlineitem":
-
-type OrdersReturnlineitemCall struct {
- s *Service
- merchantId uint64
- orderId string
- ordersreturnlineitemrequest *OrdersReturnLineItemRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Returnlineitem: Returns a line item.
-func (r *OrdersService) Returnlineitem(merchantId uint64, orderId string, ordersreturnlineitemrequest *OrdersReturnLineItemRequest) *OrdersReturnlineitemCall {
- c := &OrdersReturnlineitemCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.orderId = orderId
- c.ordersreturnlineitemrequest = ordersreturnlineitemrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersReturnlineitemCall) Fields(s ...googleapi.Field) *OrdersReturnlineitemCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersReturnlineitemCall) Context(ctx context.Context) *OrdersReturnlineitemCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersReturnlineitemCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.ordersreturnlineitemrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/orders/{orderId}/returnLineItem")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "orderId": c.orderId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.returnlineitem" call.
-// Exactly one of *OrdersReturnLineItemResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *OrdersReturnLineItemResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OrdersReturnlineitemCall) Do() (*OrdersReturnLineItemResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersReturnLineItemResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns a line item.",
- // "httpMethod": "POST",
- // "id": "content.orders.returnlineitem",
- // "parameterOrder": [
- // "merchantId",
- // "orderId"
- // ],
- // "parameters": {
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "orderId": {
- // "description": "The ID of the order.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/orders/{orderId}/returnLineItem",
- // "request": {
- // "$ref": "OrdersReturnLineItemRequest"
- // },
- // "response": {
- // "$ref": "OrdersReturnLineItemResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.shiplineitems":
-
-type OrdersShiplineitemsCall struct {
- s *Service
- merchantId uint64
- orderId string
- ordersshiplineitemsrequest *OrdersShipLineItemsRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Shiplineitems: Marks line item(s) as shipped.
-func (r *OrdersService) Shiplineitems(merchantId uint64, orderId string, ordersshiplineitemsrequest *OrdersShipLineItemsRequest) *OrdersShiplineitemsCall {
- c := &OrdersShiplineitemsCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.orderId = orderId
- c.ordersshiplineitemsrequest = ordersshiplineitemsrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersShiplineitemsCall) Fields(s ...googleapi.Field) *OrdersShiplineitemsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersShiplineitemsCall) Context(ctx context.Context) *OrdersShiplineitemsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersShiplineitemsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.ordersshiplineitemsrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/orders/{orderId}/shipLineItems")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "orderId": c.orderId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.shiplineitems" call.
-// Exactly one of *OrdersShipLineItemsResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *OrdersShipLineItemsResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OrdersShiplineitemsCall) Do() (*OrdersShipLineItemsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersShipLineItemsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Marks line item(s) as shipped.",
- // "httpMethod": "POST",
- // "id": "content.orders.shiplineitems",
- // "parameterOrder": [
- // "merchantId",
- // "orderId"
- // ],
- // "parameters": {
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "orderId": {
- // "description": "The ID of the order.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/orders/{orderId}/shipLineItems",
- // "request": {
- // "$ref": "OrdersShipLineItemsRequest"
- // },
- // "response": {
- // "$ref": "OrdersShipLineItemsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.updatemerchantorderid":
-
-type OrdersUpdatemerchantorderidCall struct {
- s *Service
- merchantId uint64
- orderId string
- ordersupdatemerchantorderidrequest *OrdersUpdateMerchantOrderIdRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Updatemerchantorderid: Updates the merchant order ID for a given
-// order.
-func (r *OrdersService) Updatemerchantorderid(merchantId uint64, orderId string, ordersupdatemerchantorderidrequest *OrdersUpdateMerchantOrderIdRequest) *OrdersUpdatemerchantorderidCall {
- c := &OrdersUpdatemerchantorderidCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.orderId = orderId
- c.ordersupdatemerchantorderidrequest = ordersupdatemerchantorderidrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersUpdatemerchantorderidCall) Fields(s ...googleapi.Field) *OrdersUpdatemerchantorderidCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersUpdatemerchantorderidCall) Context(ctx context.Context) *OrdersUpdatemerchantorderidCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersUpdatemerchantorderidCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.ordersupdatemerchantorderidrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/orders/{orderId}/updateMerchantOrderId")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "orderId": c.orderId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.updatemerchantorderid" call.
-// Exactly one of *OrdersUpdateMerchantOrderIdResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *OrdersUpdateMerchantOrderIdResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *OrdersUpdatemerchantorderidCall) Do() (*OrdersUpdateMerchantOrderIdResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersUpdateMerchantOrderIdResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates the merchant order ID for a given order.",
- // "httpMethod": "POST",
- // "id": "content.orders.updatemerchantorderid",
- // "parameterOrder": [
- // "merchantId",
- // "orderId"
- // ],
- // "parameters": {
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "orderId": {
- // "description": "The ID of the order.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/orders/{orderId}/updateMerchantOrderId",
- // "request": {
- // "$ref": "OrdersUpdateMerchantOrderIdRequest"
- // },
- // "response": {
- // "$ref": "OrdersUpdateMerchantOrderIdResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.updateshipment":
-
-type OrdersUpdateshipmentCall struct {
- s *Service
- merchantId uint64
- orderId string
- ordersupdateshipmentrequest *OrdersUpdateShipmentRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Updateshipment: Updates a shipment's status, carrier, and/or tracking
-// ID.
-func (r *OrdersService) Updateshipment(merchantId uint64, orderId string, ordersupdateshipmentrequest *OrdersUpdateShipmentRequest) *OrdersUpdateshipmentCall {
- c := &OrdersUpdateshipmentCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.orderId = orderId
- c.ordersupdateshipmentrequest = ordersupdateshipmentrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersUpdateshipmentCall) Fields(s ...googleapi.Field) *OrdersUpdateshipmentCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersUpdateshipmentCall) Context(ctx context.Context) *OrdersUpdateshipmentCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersUpdateshipmentCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.ordersupdateshipmentrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/orders/{orderId}/updateShipment")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "orderId": c.orderId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.updateshipment" call.
-// Exactly one of *OrdersUpdateShipmentResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *OrdersUpdateShipmentResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OrdersUpdateshipmentCall) Do() (*OrdersUpdateShipmentResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersUpdateShipmentResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a shipment's status, carrier, and/or tracking ID.",
- // "httpMethod": "POST",
- // "id": "content.orders.updateshipment",
- // "parameterOrder": [
- // "merchantId",
- // "orderId"
- // ],
- // "parameters": {
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "orderId": {
- // "description": "The ID of the order.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/orders/{orderId}/updateShipment",
- // "request": {
- // "$ref": "OrdersUpdateShipmentRequest"
- // },
- // "response": {
- // "$ref": "OrdersUpdateShipmentResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.products.custombatch":
-
-type ProductsCustombatchCall struct {
- s *Service
- productscustombatchrequest *ProductsCustomBatchRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Custombatch: Retrieves, inserts, and deletes multiple products in a
-// single request.
-func (r *ProductsService) Custombatch(productscustombatchrequest *ProductsCustomBatchRequest) *ProductsCustombatchCall {
- c := &ProductsCustombatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.productscustombatchrequest = productscustombatchrequest
- return c
-}
-
-// DryRun sets the optional parameter "dryRun": Flag to run the request
-// in dry-run mode.
-func (c *ProductsCustombatchCall) DryRun(dryRun bool) *ProductsCustombatchCall {
- c.opt_["dryRun"] = dryRun
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProductsCustombatchCall) Fields(s ...googleapi.Field) *ProductsCustombatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProductsCustombatchCall) Context(ctx context.Context) *ProductsCustombatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProductsCustombatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.productscustombatchrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["dryRun"]; ok {
- params.Set("dryRun", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "products/batch")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.products.custombatch" call.
-// Exactly one of *ProductsCustomBatchResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *ProductsCustomBatchResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ProductsCustombatchCall) Do() (*ProductsCustomBatchResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ProductsCustomBatchResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves, inserts, and deletes multiple products in a single request.",
- // "httpMethod": "POST",
- // "id": "content.products.custombatch",
- // "parameters": {
- // "dryRun": {
- // "description": "Flag to run the request in dry-run mode.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "products/batch",
- // "request": {
- // "$ref": "ProductsCustomBatchRequest"
- // },
- // "response": {
- // "$ref": "ProductsCustomBatchResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.products.delete":
-
-type ProductsDeleteCall struct {
- s *Service
- merchantId uint64
- productId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes a product from your Merchant Center account.
-func (r *ProductsService) Delete(merchantId uint64, productId string) *ProductsDeleteCall {
- c := &ProductsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.productId = productId
- return c
-}
-
-// DryRun sets the optional parameter "dryRun": Flag to run the request
-// in dry-run mode.
-func (c *ProductsDeleteCall) DryRun(dryRun bool) *ProductsDeleteCall {
- c.opt_["dryRun"] = dryRun
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProductsDeleteCall) Fields(s ...googleapi.Field) *ProductsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProductsDeleteCall) Context(ctx context.Context) *ProductsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProductsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["dryRun"]; ok {
- params.Set("dryRun", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/products/{productId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "productId": c.productId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.products.delete" call.
-func (c *ProductsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes a product from your Merchant Center account.",
- // "httpMethod": "DELETE",
- // "id": "content.products.delete",
- // "parameterOrder": [
- // "merchantId",
- // "productId"
- // ],
- // "parameters": {
- // "dryRun": {
- // "description": "Flag to run the request in dry-run mode.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "productId": {
- // "description": "The ID of the product.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/products/{productId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.products.get":
-
-type ProductsGetCall struct {
- s *Service
- merchantId uint64
- productId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves a product from your Merchant Center account.
-func (r *ProductsService) Get(merchantId uint64, productId string) *ProductsGetCall {
- c := &ProductsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.productId = productId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProductsGetCall) Fields(s ...googleapi.Field) *ProductsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ProductsGetCall) IfNoneMatch(entityTag string) *ProductsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProductsGetCall) Context(ctx context.Context) *ProductsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProductsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/products/{productId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "productId": c.productId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.products.get" call.
-// Exactly one of *Product or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Product.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ProductsGetCall) Do() (*Product, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Product{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a product from your Merchant Center account.",
- // "httpMethod": "GET",
- // "id": "content.products.get",
- // "parameterOrder": [
- // "merchantId",
- // "productId"
- // ],
- // "parameters": {
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "productId": {
- // "description": "The ID of the product.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/products/{productId}",
- // "response": {
- // "$ref": "Product"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.products.insert":
-
-type ProductsInsertCall struct {
- s *Service
- merchantId uint64
- product *Product
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Uploads a product to your Merchant Center account.
-func (r *ProductsService) Insert(merchantId uint64, product *Product) *ProductsInsertCall {
- c := &ProductsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.product = product
- return c
-}
-
-// DryRun sets the optional parameter "dryRun": Flag to run the request
-// in dry-run mode.
-func (c *ProductsInsertCall) DryRun(dryRun bool) *ProductsInsertCall {
- c.opt_["dryRun"] = dryRun
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProductsInsertCall) Fields(s ...googleapi.Field) *ProductsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProductsInsertCall) Context(ctx context.Context) *ProductsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProductsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.product)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["dryRun"]; ok {
- params.Set("dryRun", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/products")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.products.insert" call.
-// Exactly one of *Product or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Product.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ProductsInsertCall) Do() (*Product, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Product{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Uploads a product to your Merchant Center account.",
- // "httpMethod": "POST",
- // "id": "content.products.insert",
- // "parameterOrder": [
- // "merchantId"
- // ],
- // "parameters": {
- // "dryRun": {
- // "description": "Flag to run the request in dry-run mode.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/products",
- // "request": {
- // "$ref": "Product"
- // },
- // "response": {
- // "$ref": "Product"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.products.list":
-
-type ProductsListCall struct {
- s *Service
- merchantId uint64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists the products in your Merchant Center account.
-func (r *ProductsService) List(merchantId uint64) *ProductsListCall {
- c := &ProductsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of products to return in the response, used for paging.
-func (c *ProductsListCall) MaxResults(maxResults int64) *ProductsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The token returned
-// by the previous request.
-func (c *ProductsListCall) PageToken(pageToken string) *ProductsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProductsListCall) Fields(s ...googleapi.Field) *ProductsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ProductsListCall) IfNoneMatch(entityTag string) *ProductsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProductsListCall) Context(ctx context.Context) *ProductsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProductsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/products")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.products.list" call.
-// Exactly one of *ProductsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ProductsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ProductsListCall) Do() (*ProductsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ProductsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists the products in your Merchant Center account.",
- // "httpMethod": "GET",
- // "id": "content.products.list",
- // "parameterOrder": [
- // "merchantId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "The maximum number of products to return in the response, used for paging.",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "The token returned by the previous request.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/products",
- // "response": {
- // "$ref": "ProductsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.productstatuses.custombatch":
-
-type ProductstatusesCustombatchCall struct {
- s *Service
- productstatusescustombatchrequest *ProductstatusesCustomBatchRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Custombatch: Gets the statuses of multiple products in a single
-// request.
-func (r *ProductstatusesService) Custombatch(productstatusescustombatchrequest *ProductstatusesCustomBatchRequest) *ProductstatusesCustombatchCall {
- c := &ProductstatusesCustombatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.productstatusescustombatchrequest = productstatusescustombatchrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProductstatusesCustombatchCall) Fields(s ...googleapi.Field) *ProductstatusesCustombatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProductstatusesCustombatchCall) Context(ctx context.Context) *ProductstatusesCustombatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProductstatusesCustombatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.productstatusescustombatchrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "productstatuses/batch")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.productstatuses.custombatch" call.
-// Exactly one of *ProductstatusesCustomBatchResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *ProductstatusesCustomBatchResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *ProductstatusesCustombatchCall) Do() (*ProductstatusesCustomBatchResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ProductstatusesCustomBatchResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the statuses of multiple products in a single request.",
- // "httpMethod": "POST",
- // "id": "content.productstatuses.custombatch",
- // "path": "productstatuses/batch",
- // "request": {
- // "$ref": "ProductstatusesCustomBatchRequest"
- // },
- // "response": {
- // "$ref": "ProductstatusesCustomBatchResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.productstatuses.get":
-
-type ProductstatusesGetCall struct {
- s *Service
- merchantId uint64
- productId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets the status of a product from your Merchant Center account.
-func (r *ProductstatusesService) Get(merchantId uint64, productId string) *ProductstatusesGetCall {
- c := &ProductstatusesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.productId = productId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProductstatusesGetCall) Fields(s ...googleapi.Field) *ProductstatusesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ProductstatusesGetCall) IfNoneMatch(entityTag string) *ProductstatusesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProductstatusesGetCall) Context(ctx context.Context) *ProductstatusesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProductstatusesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/productstatuses/{productId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "productId": c.productId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.productstatuses.get" call.
-// Exactly one of *ProductStatus or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ProductStatus.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ProductstatusesGetCall) Do() (*ProductStatus, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ProductStatus{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the status of a product from your Merchant Center account.",
- // "httpMethod": "GET",
- // "id": "content.productstatuses.get",
- // "parameterOrder": [
- // "merchantId",
- // "productId"
- // ],
- // "parameters": {
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "productId": {
- // "description": "The ID of the product.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/productstatuses/{productId}",
- // "response": {
- // "$ref": "ProductStatus"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.productstatuses.list":
-
-type ProductstatusesListCall struct {
- s *Service
- merchantId uint64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists the statuses of the products in your Merchant Center
-// account.
-func (r *ProductstatusesService) List(merchantId uint64) *ProductstatusesListCall {
- c := &ProductstatusesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of product statuses to return in the response, used for
-// paging.
-func (c *ProductstatusesListCall) MaxResults(maxResults int64) *ProductstatusesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The token returned
-// by the previous request.
-func (c *ProductstatusesListCall) PageToken(pageToken string) *ProductstatusesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProductstatusesListCall) Fields(s ...googleapi.Field) *ProductstatusesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ProductstatusesListCall) IfNoneMatch(entityTag string) *ProductstatusesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProductstatusesListCall) Context(ctx context.Context) *ProductstatusesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProductstatusesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/productstatuses")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.productstatuses.list" call.
-// Exactly one of *ProductstatusesListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *ProductstatusesListResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ProductstatusesListCall) Do() (*ProductstatusesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ProductstatusesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists the statuses of the products in your Merchant Center account.",
- // "httpMethod": "GET",
- // "id": "content.productstatuses.list",
- // "parameterOrder": [
- // "merchantId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "The maximum number of product statuses to return in the response, used for paging.",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "The token returned by the previous request.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/productstatuses",
- // "response": {
- // "$ref": "ProductstatusesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/content/v2sandbox/content-api.json b/vendor/google.golang.org/api/content/v2sandbox/content-api.json
deleted file mode 100644
index ff4cd9ca..00000000
--- a/vendor/google.golang.org/api/content/v2sandbox/content-api.json
+++ /dev/null
@@ -1,2175 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/tvcbcjhYGF5BJi8y8RNxRBdwomM\"",
- "discoveryVersion": "v1",
- "id": "content:v2sandbox",
- "name": "content",
- "canonicalName": "Shopping Content",
- "version": "v2sandbox",
- "revision": "20150915",
- "title": "Content API for Shopping",
- "description": "Manage product items, inventory, and Merchant Center accounts for Google Shopping.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/shopping-content",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/content/v2sandbox/",
- "basePath": "/content/v2sandbox/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "content/v2sandbox/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/content": {
- "description": "Manage your product listings and accounts for Google Shopping"
- }
- }
- }
- },
- "schemas": {
- "Error": {
- "id": "Error",
- "type": "object",
- "description": "An error returned by the API.",
- "properties": {
- "domain": {
- "type": "string",
- "description": "The domain of the error."
- },
- "message": {
- "type": "string",
- "description": "A description of the error."
- },
- "reason": {
- "type": "string",
- "description": "The error code."
- }
- }
- },
- "Errors": {
- "id": "Errors",
- "type": "object",
- "description": "A list of errors returned by a failed batch entry.",
- "properties": {
- "code": {
- "type": "integer",
- "description": "The HTTP status of the first error in errors.",
- "format": "uint32"
- },
- "errors": {
- "type": "array",
- "description": "A list of errors.",
- "items": {
- "$ref": "Error"
- }
- },
- "message": {
- "type": "string",
- "description": "The message of the first error in errors."
- }
- }
- },
- "Order": {
- "id": "Order",
- "type": "object",
- "properties": {
- "acknowledged": {
- "type": "boolean",
- "description": "Whether the order was acknowledged."
- },
- "customer": {
- "$ref": "OrderCustomer",
- "description": "The details of the customer who placed the order."
- },
- "deliveryDetails": {
- "$ref": "OrderDeliveryDetails",
- "description": "The details for the delivery."
- },
- "id": {
- "type": "string",
- "description": "The REST id of the order. Globally unique."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#order\".",
- "default": "content#order"
- },
- "lineItems": {
- "type": "array",
- "description": "Line items that are ordered.",
- "items": {
- "$ref": "OrderLineItem"
- }
- },
- "merchantId": {
- "type": "string",
- "format": "uint64"
- },
- "merchantOrderId": {
- "type": "string",
- "description": "Merchant-provided id of the order."
- },
- "netAmount": {
- "$ref": "Price",
- "description": "The net amount for the order. For example, if an order was originally for a grand total of $100 and a refund was issued for $20, the net amount will be $80."
- },
- "paymentMethod": {
- "$ref": "OrderPaymentMethod",
- "description": "The details of the payment method."
- },
- "paymentStatus": {
- "type": "string",
- "description": "The status of the payment."
- },
- "placedDate": {
- "type": "string",
- "description": "The date when the order was placed, in ISO 8601 format."
- },
- "refunds": {
- "type": "array",
- "description": "Refunds for the order.",
- "items": {
- "$ref": "OrderRefund"
- }
- },
- "shipments": {
- "type": "array",
- "description": "Shipments of the order.",
- "items": {
- "$ref": "OrderShipment"
- }
- },
- "shippingCost": {
- "$ref": "Price",
- "description": "The total cost of shipping for all items."
- },
- "shippingCostTax": {
- "$ref": "Price",
- "description": "The tax for the total shipping cost."
- },
- "shippingOption": {
- "type": "string",
- "description": "The requested shipping option."
- },
- "status": {
- "type": "string",
- "description": "The status of the order."
- }
- }
- },
- "OrderAddress": {
- "id": "OrderAddress",
- "type": "object",
- "properties": {
- "country": {
- "type": "string",
- "description": "CLDR country code (e.g. \"US\")."
- },
- "fullAddress": {
- "type": "array",
- "description": "Strings representing the lines of the printed label for mailing the order, for example:\nJohn Smith\n1600 Amphitheatre Parkway\nMountain View, CA, 94043\nUnited States",
- "items": {
- "type": "string"
- }
- },
- "isPostOfficeBox": {
- "type": "boolean",
- "description": "Whether the address is a post office box."
- },
- "locality": {
- "type": "string",
- "description": "City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs)."
- },
- "postalCode": {
- "type": "string",
- "description": "Postal Code or ZIP (e.g. \"94043\")."
- },
- "recipientName": {
- "type": "string",
- "description": "Name of the recipient."
- },
- "region": {
- "type": "string",
- "description": "Top-level administrative subdivision of the country (e.g. \"CA\")."
- },
- "streetAddress": {
- "type": "array",
- "description": "Street-level part of the address.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "OrderCancellation": {
- "id": "OrderCancellation",
- "type": "object",
- "properties": {
- "actor": {
- "type": "string",
- "description": "The actor that created the cancellation."
- },
- "creationDate": {
- "type": "string",
- "description": "Date on which the cancellation has been created, in ISO 8601 format."
- },
- "quantity": {
- "type": "integer",
- "description": "The quantity that was canceled.",
- "format": "uint32"
- },
- "reason": {
- "type": "string",
- "description": "The reason for the cancellation."
- },
- "reasonText": {
- "type": "string",
- "description": "The explanation of the reason."
- }
- }
- },
- "OrderCustomer": {
- "id": "OrderCustomer",
- "type": "object",
- "properties": {
- "email": {
- "type": "string",
- "description": "Email address of the customer."
- },
- "explicitMarketingPreference": {
- "type": "boolean",
- "description": "If set, this indicates the user had a choice to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the Purchases on Google checkout flow."
- },
- "fullName": {
- "type": "string",
- "description": "Full name of the customer."
- }
- }
- },
- "OrderDeliveryDetails": {
- "id": "OrderDeliveryDetails",
- "type": "object",
- "properties": {
- "address": {
- "$ref": "OrderAddress",
- "description": "The delivery address"
- },
- "phoneNumber": {
- "type": "string",
- "description": "The phone number of the person receiving the delivery."
- }
- }
- },
- "OrderLineItem": {
- "id": "OrderLineItem",
- "type": "object",
- "properties": {
- "cancellations": {
- "type": "array",
- "description": "Cancellations of the line item.",
- "items": {
- "$ref": "OrderCancellation"
- }
- },
- "id": {
- "type": "string",
- "description": "The id of the line item."
- },
- "price": {
- "$ref": "Price",
- "description": "Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20."
- },
- "product": {
- "$ref": "OrderLineItemProduct",
- "description": "Product data from the time of the order placement."
- },
- "quantityCanceled": {
- "type": "integer",
- "description": "Number of items canceled.",
- "format": "uint32"
- },
- "quantityDelivered": {
- "type": "integer",
- "description": "Number of items delivered.",
- "format": "uint32"
- },
- "quantityOrdered": {
- "type": "integer",
- "description": "Number of items ordered.",
- "format": "uint32"
- },
- "quantityPending": {
- "type": "integer",
- "description": "Number of items pending.",
- "format": "uint32"
- },
- "quantityReturned": {
- "type": "integer",
- "description": "Number of items returned.",
- "format": "uint32"
- },
- "quantityShipped": {
- "type": "integer",
- "description": "Number of items shipped.",
- "format": "uint32"
- },
- "returnInfo": {
- "$ref": "OrderLineItemReturnInfo",
- "description": "Details of the return policy for the line item."
- },
- "returns": {
- "type": "array",
- "description": "Returns of the line item.",
- "items": {
- "$ref": "OrderReturn"
- }
- },
- "shippingDetails": {
- "$ref": "OrderLineItemShippingDetails",
- "description": "Details of the requested shipping for the line item."
- },
- "tax": {
- "$ref": "Price",
- "description": "Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4."
- }
- }
- },
- "OrderLineItemProduct": {
- "id": "OrderLineItemProduct",
- "type": "object",
- "properties": {
- "brand": {
- "type": "string",
- "description": "Brand of the item."
- },
- "channel": {
- "type": "string",
- "description": "The item's channel (online or local)."
- },
- "condition": {
- "type": "string",
- "description": "Condition or state of the item."
- },
- "contentLanguage": {
- "type": "string",
- "description": "The two-letter ISO 639-1 language code for the item."
- },
- "gtin": {
- "type": "string",
- "description": "Global Trade Item Number (GTIN) of the item."
- },
- "id": {
- "type": "string",
- "description": "The REST id of the product."
- },
- "imageLink": {
- "type": "string",
- "description": "URL of an image of the item."
- },
- "itemGroupId": {
- "type": "string",
- "description": "Shared identifier for all variants of the same product."
- },
- "mpn": {
- "type": "string",
- "description": "Manufacturer Part Number (MPN) of the item."
- },
- "offerId": {
- "type": "string",
- "description": "An identifier of the item."
- },
- "price": {
- "$ref": "Price",
- "description": "Price of the item."
- },
- "shownImage": {
- "type": "string",
- "description": "URL to the cached image shown to the user when order was placed."
- },
- "targetCountry": {
- "type": "string",
- "description": "The CLDR territory code of the target country of the product."
- },
- "title": {
- "type": "string",
- "description": "The title of the product."
- },
- "variantAttributes": {
- "type": "array",
- "description": "Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.",
- "items": {
- "$ref": "OrderLineItemProductVariantAttribute"
- }
- }
- }
- },
- "OrderLineItemProductVariantAttribute": {
- "id": "OrderLineItemProductVariantAttribute",
- "type": "object",
- "properties": {
- "dimension": {
- "type": "string",
- "description": "The dimension of the variant."
- },
- "value": {
- "type": "string",
- "description": "The value for the dimension."
- }
- }
- },
- "OrderLineItemReturnInfo": {
- "id": "OrderLineItemReturnInfo",
- "type": "object",
- "properties": {
- "daysToReturn": {
- "type": "integer",
- "description": "How many days later the item can be returned.",
- "format": "int32",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "isReturnable": {
- "type": "boolean",
- "description": "Whether the item is returnable.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "policyUrl": {
- "type": "string",
- "description": "URL of the item return policy.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- }
- }
- },
- "OrderLineItemShippingDetails": {
- "id": "OrderLineItemShippingDetails",
- "type": "object",
- "properties": {
- "deliverByDate": {
- "type": "string",
- "description": "The delivery by date, in ISO 8601 format.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "method": {
- "$ref": "OrderLineItemShippingDetailsMethod",
- "description": "Details of the shipping method.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "shipByDate": {
- "type": "string",
- "description": "The ship by date, in ISO 8601 format.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- }
- }
- },
- "OrderLineItemShippingDetailsMethod": {
- "id": "OrderLineItemShippingDetailsMethod",
- "type": "object",
- "properties": {
- "carrier": {
- "type": "string",
- "description": "The carrier for the shipping. Optional."
- },
- "maxDaysInTransit": {
- "type": "integer",
- "description": "Maximum transit time.",
- "format": "uint32",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "methodName": {
- "type": "string",
- "description": "The name of the shipping method.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "minDaysInTransit": {
- "type": "integer",
- "description": "Minimum transit time.",
- "format": "uint32",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- }
- }
- },
- "OrderPaymentMethod": {
- "id": "OrderPaymentMethod",
- "type": "object",
- "properties": {
- "billingAddress": {
- "$ref": "OrderAddress",
- "description": "The billing address."
- },
- "expirationMonth": {
- "type": "integer",
- "description": "The card expiration month (January = 1, February = 2 etc.).",
- "format": "int32"
- },
- "expirationYear": {
- "type": "integer",
- "description": "The card expiration year (4-digit, e.g. 2015).",
- "format": "int32"
- },
- "lastFourDigits": {
- "type": "string",
- "description": "The last four digits of the card number."
- },
- "phoneNumber": {
- "type": "string",
- "description": "The billing phone number."
- },
- "type": {
- "type": "string",
- "description": "The type of instrument (VISA, Mastercard, etc)."
- }
- }
- },
- "OrderRefund": {
- "id": "OrderRefund",
- "type": "object",
- "properties": {
- "actor": {
- "type": "string",
- "description": "The actor that created the refund."
- },
- "amount": {
- "$ref": "Price",
- "description": "The amount that is refunded."
- },
- "creationDate": {
- "type": "string",
- "description": "Date on which the item has been created, in ISO 8601 format."
- },
- "reason": {
- "type": "string",
- "description": "The reason for the refund."
- },
- "reasonText": {
- "type": "string",
- "description": "The explanation of the reason."
- }
- }
- },
- "OrderReturn": {
- "id": "OrderReturn",
- "type": "object",
- "properties": {
- "actor": {
- "type": "string",
- "description": "The actor that created the refund."
- },
- "creationDate": {
- "type": "string",
- "description": "Date on which the item has been created, in ISO 8601 format."
- },
- "quantity": {
- "type": "integer",
- "description": "Quantity that is returned.",
- "format": "uint32"
- },
- "reason": {
- "type": "string",
- "description": "The reason for the return."
- },
- "reasonText": {
- "type": "string",
- "description": "The explanation of the reason."
- }
- }
- },
- "OrderShipment": {
- "id": "OrderShipment",
- "type": "object",
- "properties": {
- "carrier": {
- "type": "string",
- "description": "The carrier handling the shipment."
- },
- "creationDate": {
- "type": "string",
- "description": "Date on which the shipment has been created, in ISO 8601 format."
- },
- "deliveryDate": {
- "type": "string",
- "description": "Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delievered"
- },
- "id": {
- "type": "string",
- "description": "The id of the shipment."
- },
- "lineItems": {
- "type": "array",
- "description": "The line items that are shipped.",
- "items": {
- "$ref": "OrderShipmentLineItemShipment"
- }
- },
- "status": {
- "type": "string",
- "description": "The status of the shipment."
- },
- "trackingId": {
- "type": "string",
- "description": "The tracking id for the shipment."
- }
- }
- },
- "OrderShipmentLineItemShipment": {
- "id": "OrderShipmentLineItemShipment",
- "type": "object",
- "properties": {
- "lineItemId": {
- "type": "string",
- "description": "The id of the line item that is shipped."
- },
- "quantity": {
- "type": "integer",
- "description": "The quantity that is shipped.",
- "format": "uint32"
- }
- }
- },
- "OrdersAcknowledgeRequest": {
- "id": "OrdersAcknowledgeRequest",
- "type": "object",
- "properties": {
- "operationId": {
- "type": "string",
- "description": "The ID of the operation. Unique across all operations for a given order."
- }
- }
- },
- "OrdersAcknowledgeResponse": {
- "id": "OrdersAcknowledgeResponse",
- "type": "object",
- "properties": {
- "executionStatus": {
- "type": "string",
- "description": "The status of the execution."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersAcknowledgeResponse\".",
- "default": "content#ordersAcknowledgeResponse"
- }
- }
- },
- "OrdersAdvanceTestOrderResponse": {
- "id": "OrdersAdvanceTestOrderResponse",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersAdvanceTestOrderResponse\".",
- "default": "content#ordersAdvanceTestOrderResponse"
- }
- }
- },
- "OrdersCancelLineItemRequest": {
- "id": "OrdersCancelLineItemRequest",
- "type": "object",
- "properties": {
- "lineItemId": {
- "type": "string",
- "description": "The ID of the line item to cancel."
- },
- "operationId": {
- "type": "string",
- "description": "The ID of the operation. Unique across all operations for a given order."
- },
- "quantity": {
- "type": "integer",
- "description": "The quantity to cancel.",
- "format": "uint32"
- },
- "reason": {
- "type": "string",
- "description": "The reason for the cancellation."
- },
- "reasonText": {
- "type": "string",
- "description": "The explanation of the reason."
- }
- }
- },
- "OrdersCancelLineItemResponse": {
- "id": "OrdersCancelLineItemResponse",
- "type": "object",
- "properties": {
- "executionStatus": {
- "type": "string",
- "description": "The status of the execution."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCancelLineItemResponse\".",
- "default": "content#ordersCancelLineItemResponse"
- }
- }
- },
- "OrdersCancelRequest": {
- "id": "OrdersCancelRequest",
- "type": "object",
- "properties": {
- "operationId": {
- "type": "string",
- "description": "The ID of the operation. Unique across all operations for a given order."
- },
- "reason": {
- "type": "string",
- "description": "The reason for the cancellation."
- },
- "reasonText": {
- "type": "string",
- "description": "The explanation of the reason."
- }
- }
- },
- "OrdersCancelResponse": {
- "id": "OrdersCancelResponse",
- "type": "object",
- "properties": {
- "executionStatus": {
- "type": "string",
- "description": "The status of the execution."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCancelResponse\".",
- "default": "content#ordersCancelResponse"
- }
- }
- },
- "OrdersCreateTestOrderRequest": {
- "id": "OrdersCreateTestOrderRequest",
- "type": "object",
- "properties": {
- "templateName": {
- "type": "string",
- "description": "The test order template to use. Specify as an alternative to testOrder as a shortcut for retrieving a template and then creating an order using that template."
- },
- "testOrder": {
- "$ref": "TestOrder",
- "description": "The test order to create."
- }
- }
- },
- "OrdersCreateTestOrderResponse": {
- "id": "OrdersCreateTestOrderResponse",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCreateTestOrderResponse\".",
- "default": "content#ordersCreateTestOrderResponse"
- },
- "orderId": {
- "type": "string",
- "description": "The ID of the newly created test order."
- }
- }
- },
- "OrdersCustomBatchRequest": {
- "id": "OrdersCustomBatchRequest",
- "type": "object",
- "properties": {
- "entries": {
- "type": "array",
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "OrdersCustomBatchRequestEntry"
- }
- }
- }
- },
- "OrdersCustomBatchRequestEntry": {
- "id": "OrdersCustomBatchRequestEntry",
- "type": "object",
- "properties": {
- "batchId": {
- "type": "integer",
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32"
- },
- "cancel": {
- "$ref": "OrdersCustomBatchRequestEntryCancel",
- "description": "Required for cancel method."
- },
- "cancelLineItem": {
- "$ref": "OrdersCustomBatchRequestEntryCancelLineItem",
- "description": "Required for cancelLineItem method."
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "format": "uint64"
- },
- "merchantOrderId": {
- "type": "string",
- "description": "The merchant order id. Required for updateMerchantOrderId and getByMerchantOrderId methods."
- },
- "method": {
- "type": "string",
- "description": "The method to apply."
- },
- "operationId": {
- "type": "string",
- "description": "The ID of the operation. Unique across all operations for a given order. Required for all methods beside get and getByMerchantOrderId."
- },
- "orderId": {
- "type": "string",
- "description": "The ID of the order. Required for all methods beside getByMerchantOrderId."
- },
- "refund": {
- "$ref": "OrdersCustomBatchRequestEntryRefund",
- "description": "Required for refund method."
- },
- "returnLineItem": {
- "$ref": "OrdersCustomBatchRequestEntryReturnLineItem",
- "description": "Required for returnLineItem method."
- },
- "shipLineItems": {
- "$ref": "OrdersCustomBatchRequestEntryShipLineItems",
- "description": "Required for shipLineItems method."
- },
- "updateShipment": {
- "$ref": "OrdersCustomBatchRequestEntryUpdateShipment",
- "description": "Required for updateShipment method."
- }
- }
- },
- "OrdersCustomBatchRequestEntryCancel": {
- "id": "OrdersCustomBatchRequestEntryCancel",
- "type": "object",
- "properties": {
- "reason": {
- "type": "string",
- "description": "The reason for the cancellation."
- },
- "reasonText": {
- "type": "string",
- "description": "The explanation of the reason."
- }
- }
- },
- "OrdersCustomBatchRequestEntryCancelLineItem": {
- "id": "OrdersCustomBatchRequestEntryCancelLineItem",
- "type": "object",
- "properties": {
- "lineItemId": {
- "type": "string",
- "description": "The ID of the line item to cancel."
- },
- "quantity": {
- "type": "integer",
- "description": "The quantity to cancel.",
- "format": "uint32"
- },
- "reason": {
- "type": "string",
- "description": "The reason for the cancellation."
- },
- "reasonText": {
- "type": "string",
- "description": "The explanation of the reason."
- }
- }
- },
- "OrdersCustomBatchRequestEntryRefund": {
- "id": "OrdersCustomBatchRequestEntryRefund",
- "type": "object",
- "properties": {
- "amount": {
- "$ref": "Price",
- "description": "The amount that is refunded."
- },
- "reason": {
- "type": "string",
- "description": "The reason for the refund."
- },
- "reasonText": {
- "type": "string",
- "description": "The explanation of the reason."
- }
- }
- },
- "OrdersCustomBatchRequestEntryReturnLineItem": {
- "id": "OrdersCustomBatchRequestEntryReturnLineItem",
- "type": "object",
- "properties": {
- "lineItemId": {
- "type": "string",
- "description": "The ID of the line item to return."
- },
- "quantity": {
- "type": "integer",
- "description": "The quantity to return.",
- "format": "uint32"
- },
- "reason": {
- "type": "string",
- "description": "The reason for the return."
- },
- "reasonText": {
- "type": "string",
- "description": "The explanation of the reason."
- }
- }
- },
- "OrdersCustomBatchRequestEntryShipLineItems": {
- "id": "OrdersCustomBatchRequestEntryShipLineItems",
- "type": "object",
- "properties": {
- "carrier": {
- "type": "string",
- "description": "The carrier handling the shipment."
- },
- "lineItems": {
- "type": "array",
- "description": "Line items to ship.",
- "items": {
- "$ref": "OrderShipmentLineItemShipment"
- }
- },
- "shipmentId": {
- "type": "string",
- "description": "The ID of the shipment."
- },
- "trackingId": {
- "type": "string",
- "description": "The tracking id for the shipment."
- }
- }
- },
- "OrdersCustomBatchRequestEntryUpdateShipment": {
- "id": "OrdersCustomBatchRequestEntryUpdateShipment",
- "type": "object",
- "properties": {
- "carrier": {
- "type": "string",
- "description": "The carrier handling the shipment. Not updated if missing."
- },
- "shipmentId": {
- "type": "string",
- "description": "The ID of the shipment."
- },
- "status": {
- "type": "string",
- "description": "New status for the shipment. Not updated if missing."
- },
- "trackingId": {
- "type": "string",
- "description": "The tracking id for the shipment. Not updated if missing."
- }
- }
- },
- "OrdersCustomBatchResponse": {
- "id": "OrdersCustomBatchResponse",
- "type": "object",
- "properties": {
- "entries": {
- "type": "array",
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "OrdersCustomBatchResponseEntry"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCustomBatchResponse\".",
- "default": "content#ordersCustomBatchResponse"
- }
- }
- },
- "OrdersCustomBatchResponseEntry": {
- "id": "OrdersCustomBatchResponseEntry",
- "type": "object",
- "properties": {
- "batchId": {
- "type": "integer",
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors defined if and only if the request failed."
- },
- "executionStatus": {
- "type": "string",
- "description": "The status of the execution. Only defined if the method is not get or getByMerchantOrderId and if the request was successful."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCustomBatchResponseEntry\".",
- "default": "content#ordersCustomBatchResponseEntry"
- },
- "order": {
- "$ref": "Order",
- "description": "The retrieved order. Only defined if the method is get and if the request was successful."
- }
- }
- },
- "OrdersGetByMerchantOrderIdResponse": {
- "id": "OrdersGetByMerchantOrderIdResponse",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersGetByMerchantOrderIdResponse\".",
- "default": "content#ordersGetByMerchantOrderIdResponse"
- },
- "order": {
- "$ref": "Order",
- "description": "The requested order."
- }
- }
- },
- "OrdersGetTestOrderTemplateResponse": {
- "id": "OrdersGetTestOrderTemplateResponse",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersGetTestOrderTemplateResponse\".",
- "default": "content#ordersGetTestOrderTemplateResponse"
- },
- "template": {
- "$ref": "TestOrder",
- "description": "The requested test order template."
- }
- }
- },
- "OrdersListResponse": {
- "id": "OrdersListResponse",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersListResponse\".",
- "default": "content#ordersListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "The token for the retrieval of the next page of orders."
- },
- "resources": {
- "type": "array",
- "items": {
- "$ref": "Order"
- }
- }
- }
- },
- "OrdersRefundRequest": {
- "id": "OrdersRefundRequest",
- "type": "object",
- "properties": {
- "amount": {
- "$ref": "Price",
- "description": "The amount that is refunded."
- },
- "operationId": {
- "type": "string",
- "description": "The ID of the operation. Unique across all operations for a given order."
- },
- "reason": {
- "type": "string",
- "description": "The reason for the refund."
- },
- "reasonText": {
- "type": "string",
- "description": "The explanation of the reason."
- }
- }
- },
- "OrdersRefundResponse": {
- "id": "OrdersRefundResponse",
- "type": "object",
- "properties": {
- "executionStatus": {
- "type": "string",
- "description": "The status of the execution."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersRefundResponse\".",
- "default": "content#ordersRefundResponse"
- }
- }
- },
- "OrdersReturnLineItemRequest": {
- "id": "OrdersReturnLineItemRequest",
- "type": "object",
- "properties": {
- "lineItemId": {
- "type": "string",
- "description": "The ID of the line item to return."
- },
- "operationId": {
- "type": "string",
- "description": "The ID of the operation. Unique across all operations for a given order."
- },
- "quantity": {
- "type": "integer",
- "description": "The quantity to return.",
- "format": "uint32"
- },
- "reason": {
- "type": "string",
- "description": "The reason for the return."
- },
- "reasonText": {
- "type": "string",
- "description": "The explanation of the reason."
- }
- }
- },
- "OrdersReturnLineItemResponse": {
- "id": "OrdersReturnLineItemResponse",
- "type": "object",
- "properties": {
- "executionStatus": {
- "type": "string",
- "description": "The status of the execution."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersReturnLineItemResponse\".",
- "default": "content#ordersReturnLineItemResponse"
- }
- }
- },
- "OrdersShipLineItemsRequest": {
- "id": "OrdersShipLineItemsRequest",
- "type": "object",
- "properties": {
- "carrier": {
- "type": "string",
- "description": "The carrier handling the shipment."
- },
- "lineItems": {
- "type": "array",
- "description": "Line items to ship.",
- "items": {
- "$ref": "OrderShipmentLineItemShipment"
- }
- },
- "operationId": {
- "type": "string",
- "description": "The ID of the operation. Unique across all operations for a given order."
- },
- "shipmentId": {
- "type": "string",
- "description": "The ID of the shipment."
- },
- "trackingId": {
- "type": "string",
- "description": "The tracking id for the shipment."
- }
- }
- },
- "OrdersShipLineItemsResponse": {
- "id": "OrdersShipLineItemsResponse",
- "type": "object",
- "properties": {
- "executionStatus": {
- "type": "string",
- "description": "The status of the execution."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersShipLineItemsResponse\".",
- "default": "content#ordersShipLineItemsResponse"
- }
- }
- },
- "OrdersUpdateMerchantOrderIdRequest": {
- "id": "OrdersUpdateMerchantOrderIdRequest",
- "type": "object",
- "properties": {
- "merchantOrderId": {
- "type": "string",
- "description": "The merchant order id to be assigned to the order. Must be unique per merchant."
- },
- "operationId": {
- "type": "string",
- "description": "The ID of the operation. Unique across all operations for a given order."
- }
- }
- },
- "OrdersUpdateMerchantOrderIdResponse": {
- "id": "OrdersUpdateMerchantOrderIdResponse",
- "type": "object",
- "properties": {
- "executionStatus": {
- "type": "string",
- "description": "The status of the execution."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersUpdateMerchantOrderIdResponse\".",
- "default": "content#ordersUpdateMerchantOrderIdResponse"
- }
- }
- },
- "OrdersUpdateShipmentRequest": {
- "id": "OrdersUpdateShipmentRequest",
- "type": "object",
- "properties": {
- "carrier": {
- "type": "string",
- "description": "The carrier handling the shipment. Not updated if missing."
- },
- "operationId": {
- "type": "string",
- "description": "The ID of the operation. Unique across all operations for a given order."
- },
- "shipmentId": {
- "type": "string",
- "description": "The ID of the shipment."
- },
- "status": {
- "type": "string",
- "description": "New status for the shipment. Not updated if missing."
- },
- "trackingId": {
- "type": "string",
- "description": "The tracking id for the shipment. Not updated if missing."
- }
- }
- },
- "OrdersUpdateShipmentResponse": {
- "id": "OrdersUpdateShipmentResponse",
- "type": "object",
- "properties": {
- "executionStatus": {
- "type": "string",
- "description": "The status of the execution."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersUpdateShipmentResponse\".",
- "default": "content#ordersUpdateShipmentResponse"
- }
- }
- },
- "Price": {
- "id": "Price",
- "type": "object",
- "properties": {
- "currency": {
- "type": "string",
- "description": "The currency of the price."
- },
- "value": {
- "type": "string",
- "description": "The price represented as a number."
- }
- }
- },
- "TestOrder": {
- "id": "TestOrder",
- "type": "object",
- "properties": {
- "customer": {
- "$ref": "TestOrderCustomer",
- "description": "The details of the customer who placed the order.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"content#testOrder\".",
- "default": "content#testOrder"
- },
- "lineItems": {
- "type": "array",
- "description": "Line items that are ordered. At least one line item must be provided.",
- "items": {
- "$ref": "TestOrderLineItem"
- },
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "paymentMethod": {
- "$ref": "TestOrderPaymentMethod",
- "description": "The details of the payment method."
- },
- "predefinedDeliveryAddress": {
- "type": "string",
- "description": "Identifier of one of the predefined delivery addresses for the delivery.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "shippingCost": {
- "$ref": "Price",
- "description": "The total cost of shipping for all items.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "shippingCostTax": {
- "$ref": "Price",
- "description": "The tax for the total shipping cost.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "shippingOption": {
- "type": "string",
- "description": "The requested shipping option.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- }
- }
- },
- "TestOrderCustomer": {
- "id": "TestOrderCustomer",
- "type": "object",
- "properties": {
- "email": {
- "type": "string",
- "description": "Email address of the customer.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "explicitMarketingPreference": {
- "type": "boolean",
- "description": "If set, this indicates the user had a choice to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the Purchases on Google checkout flow. Optional."
- },
- "fullName": {
- "type": "string",
- "description": "Full name of the customer."
- }
- }
- },
- "TestOrderLineItem": {
- "id": "TestOrderLineItem",
- "type": "object",
- "properties": {
- "product": {
- "$ref": "TestOrderLineItemProduct",
- "description": "Product data from the time of the order placement."
- },
- "quantityOrdered": {
- "type": "integer",
- "description": "Number of items ordered.",
- "format": "uint32",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "returnInfo": {
- "$ref": "OrderLineItemReturnInfo",
- "description": "Details of the return policy for the line item.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "shippingDetails": {
- "$ref": "OrderLineItemShippingDetails",
- "description": "Details of the requested shipping for the line item.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "unitTax": {
- "$ref": "Price",
- "description": "Unit tax for the line item.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- }
- }
- },
- "TestOrderLineItemProduct": {
- "id": "TestOrderLineItemProduct",
- "type": "object",
- "properties": {
- "brand": {
- "type": "string",
- "description": "Brand of the item.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "channel": {
- "type": "string",
- "description": "The item's channel.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "condition": {
- "type": "string",
- "description": "Condition or state of the item.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "contentLanguage": {
- "type": "string",
- "description": "The two-letter ISO 639-1 language code for the item.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "gtin": {
- "type": "string",
- "description": "Global Trade Item Number (GTIN) of the item. Optional."
- },
- "imageLink": {
- "type": "string",
- "description": "URL of an image of the item.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "itemGroupId": {
- "type": "string",
- "description": "Shared identifier for all variants of the same product. Optional."
- },
- "mpn": {
- "type": "string",
- "description": "Manufacturer Part Number (MPN) of the item. Optional."
- },
- "offerId": {
- "type": "string",
- "description": "An identifier of the item.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "price": {
- "$ref": "Price",
- "description": "The price for the product.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "targetCountry": {
- "type": "string",
- "description": "The CLDR territory code of the target country of the product.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "title": {
- "type": "string",
- "description": "The title of the product.",
- "annotations": {
- "required": [
- "content.orders.createtestorder"
- ]
- }
- },
- "variantAttributes": {
- "type": "array",
- "description": "Variant attributes for the item. Optional.",
- "items": {
- "$ref": "OrderLineItemProductVariantAttribute"
- }
- }
- }
- },
- "TestOrderPaymentMethod": {
- "id": "TestOrderPaymentMethod",
- "type": "object",
- "properties": {
- "expirationMonth": {
- "type": "integer",
- "description": "The card expiration month (January = 1, February = 2 etc.).",
- "format": "int32"
- },
- "expirationYear": {
- "type": "integer",
- "description": "The card expiration year (4-digit, e.g. 2015).",
- "format": "int32"
- },
- "lastFourDigits": {
- "type": "string",
- "description": "The last four digits of the card number."
- },
- "predefinedBillingAddress": {
- "type": "string",
- "description": "The billing address."
- },
- "type": {
- "type": "string",
- "description": "The type of instrument. Note that real orders might have different values than the four values accepted by createTestOrder."
- }
- }
- }
- },
- "resources": {
- "orders": {
- "methods": {
- "acknowledge": {
- "id": "content.orders.acknowledge",
- "path": "{merchantId}/orders/{orderId}/acknowledge",
- "httpMethod": "POST",
- "description": "Marks an order as acknowledged.",
- "parameters": {
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "orderId": {
- "type": "string",
- "description": "The ID of the order.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "request": {
- "$ref": "OrdersAcknowledgeRequest"
- },
- "response": {
- "$ref": "OrdersAcknowledgeResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "advancetestorder": {
- "id": "content.orders.advancetestorder",
- "path": "{merchantId}/testorders/{orderId}/advance",
- "httpMethod": "POST",
- "description": "Sandbox only. Moves a test order from state \"inProgress\" to state \"pendingShipment\".",
- "parameters": {
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "orderId": {
- "type": "string",
- "description": "The ID of the test order to modify.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "response": {
- "$ref": "OrdersAdvanceTestOrderResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "cancel": {
- "id": "content.orders.cancel",
- "path": "{merchantId}/orders/{orderId}/cancel",
- "httpMethod": "POST",
- "description": "Cancels all line items in an order.",
- "parameters": {
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "orderId": {
- "type": "string",
- "description": "The ID of the order to cancel.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "request": {
- "$ref": "OrdersCancelRequest"
- },
- "response": {
- "$ref": "OrdersCancelResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "cancellineitem": {
- "id": "content.orders.cancellineitem",
- "path": "{merchantId}/orders/{orderId}/cancelLineItem",
- "httpMethod": "POST",
- "description": "Cancels a line item.",
- "parameters": {
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "orderId": {
- "type": "string",
- "description": "The ID of the order.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "request": {
- "$ref": "OrdersCancelLineItemRequest"
- },
- "response": {
- "$ref": "OrdersCancelLineItemResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "createtestorder": {
- "id": "content.orders.createtestorder",
- "path": "{merchantId}/testorders",
- "httpMethod": "POST",
- "description": "Sandbox only. Creates a test order.",
- "parameters": {
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId"
- ],
- "request": {
- "$ref": "OrdersCreateTestOrderRequest"
- },
- "response": {
- "$ref": "OrdersCreateTestOrderResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "custombatch": {
- "id": "content.orders.custombatch",
- "path": "orders/batch",
- "httpMethod": "POST",
- "description": "Retrieves or modifies multiple orders in a single request.",
- "request": {
- "$ref": "OrdersCustomBatchRequest"
- },
- "response": {
- "$ref": "OrdersCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "id": "content.orders.get",
- "path": "{merchantId}/orders/{orderId}",
- "httpMethod": "GET",
- "description": "Retrieves an order from your Merchant Center account.",
- "parameters": {
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "orderId": {
- "type": "string",
- "description": "The ID of the order.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "response": {
- "$ref": "Order"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "getbymerchantorderid": {
- "id": "content.orders.getbymerchantorderid",
- "path": "{merchantId}/ordersbymerchantid/{merchantOrderId}",
- "httpMethod": "GET",
- "description": "Retrieves an order using merchant order id.",
- "parameters": {
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "merchantOrderId": {
- "type": "string",
- "description": "The merchant order id to be looked for.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "merchantOrderId"
- ],
- "response": {
- "$ref": "OrdersGetByMerchantOrderIdResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "gettestordertemplate": {
- "id": "content.orders.gettestordertemplate",
- "path": "{merchantId}/testordertemplates/{templateName}",
- "httpMethod": "GET",
- "description": "Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.",
- "parameters": {
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "templateName": {
- "type": "string",
- "description": "The name of the template to retrieve.",
- "required": true,
- "enum": [
- "template1",
- "template2"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "templateName"
- ],
- "response": {
- "$ref": "OrdersGetTestOrderTemplateResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "id": "content.orders.list",
- "path": "{merchantId}/orders",
- "httpMethod": "GET",
- "description": "Lists the orders in your Merchant Center account.",
- "parameters": {
- "acknowledged": {
- "type": "boolean",
- "description": "Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged.\nWe recommend using this filter set to false, in conjunction with the acknowledge call, such that only un-acknowledged orders are returned.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.\nKnown issue: All List calls will return all Orders without limit regardless of the value of this field.",
- "format": "uint32",
- "location": "query"
- },
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "orderBy": {
- "type": "string",
- "description": "The ordering of the returned list. The only supported value are placedDate desc and placedDate asc for now, which returns orders sorted by placement date. \"placedDate desc\" stands for listing orders by placement date, from oldest to most recent. \"placedDate asc\" stands for listing orders by placement date, from most recent to oldest. In future releases we'll support other sorting criteria.",
- "enum": [
- "placedDate asc",
- "placedDate desc"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The token returned by the previous request.",
- "location": "query"
- },
- "placedDateEnd": {
- "type": "string",
- "description": "Obtains orders placed before this date (exclusively), in ISO 8601 format.",
- "location": "query"
- },
- "placedDateStart": {
- "type": "string",
- "description": "Obtains orders placed after this date (inclusively), in ISO 8601 format.",
- "location": "query"
- },
- "statuses": {
- "type": "string",
- "description": "Obtains orders that match any of the specified statuses. Multiple values can be specified with comma separation. Additionally, please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped , partiallyDelivered, delivered, partiallyReturned, returned, and canceled.",
- "enum": [
- "active",
- "canceled",
- "completed",
- "delivered",
- "inProgress",
- "partiallyDelivered",
- "partiallyReturned",
- "partiallyShipped",
- "pendingShipment",
- "returned",
- "shipped"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "merchantId"
- ],
- "response": {
- "$ref": "OrdersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "refund": {
- "id": "content.orders.refund",
- "path": "{merchantId}/orders/{orderId}/refund",
- "httpMethod": "POST",
- "description": "Refund a portion of the order, up to the full amount paid.",
- "parameters": {
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "orderId": {
- "type": "string",
- "description": "The ID of the order to refund.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "request": {
- "$ref": "OrdersRefundRequest"
- },
- "response": {
- "$ref": "OrdersRefundResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "returnlineitem": {
- "id": "content.orders.returnlineitem",
- "path": "{merchantId}/orders/{orderId}/returnLineItem",
- "httpMethod": "POST",
- "description": "Returns a line item.",
- "parameters": {
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "orderId": {
- "type": "string",
- "description": "The ID of the order.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "request": {
- "$ref": "OrdersReturnLineItemRequest"
- },
- "response": {
- "$ref": "OrdersReturnLineItemResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "shiplineitems": {
- "id": "content.orders.shiplineitems",
- "path": "{merchantId}/orders/{orderId}/shipLineItems",
- "httpMethod": "POST",
- "description": "Marks line item(s) as shipped.",
- "parameters": {
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "orderId": {
- "type": "string",
- "description": "The ID of the order.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "request": {
- "$ref": "OrdersShipLineItemsRequest"
- },
- "response": {
- "$ref": "OrdersShipLineItemsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "updatemerchantorderid": {
- "id": "content.orders.updatemerchantorderid",
- "path": "{merchantId}/orders/{orderId}/updateMerchantOrderId",
- "httpMethod": "POST",
- "description": "Updates the merchant order ID for a given order.",
- "parameters": {
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "orderId": {
- "type": "string",
- "description": "The ID of the order.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "request": {
- "$ref": "OrdersUpdateMerchantOrderIdRequest"
- },
- "response": {
- "$ref": "OrdersUpdateMerchantOrderIdResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "updateshipment": {
- "id": "content.orders.updateshipment",
- "path": "{merchantId}/orders/{orderId}/updateShipment",
- "httpMethod": "POST",
- "description": "Updates a shipment's status, carrier, and/or tracking ID.",
- "parameters": {
- "merchantId": {
- "type": "string",
- "description": "The ID of the managing account.",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "orderId": {
- "type": "string",
- "description": "The ID of the order.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "merchantId",
- "orderId"
- ],
- "request": {
- "$ref": "OrdersUpdateShipmentRequest"
- },
- "response": {
- "$ref": "OrdersUpdateShipmentResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/content/v2sandbox/content-gen.go b/vendor/google.golang.org/api/content/v2sandbox/content-gen.go
deleted file mode 100644
index 82fda329..00000000
--- a/vendor/google.golang.org/api/content/v2sandbox/content-gen.go
+++ /dev/null
@@ -1,4013 +0,0 @@
-// Package content provides access to the Content API for Shopping.
-//
-// See https://developers.google.com/shopping-content
-//
-// Usage example:
-//
-// import "google.golang.org/api/content/v2sandbox"
-// ...
-// contentService, err := content.New(oauthHttpClient)
-package content // import "google.golang.org/api/content/v2sandbox"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "content:v2sandbox"
-const apiName = "content"
-const apiVersion = "v2sandbox"
-const basePath = "https://www.googleapis.com/content/v2sandbox/"
-
-// OAuth2 scopes used by this API.
-const (
- // Manage your product listings and accounts for Google Shopping
- ContentScope = "https://www.googleapis.com/auth/content"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Orders = NewOrdersService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Orders *OrdersService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewOrdersService(s *Service) *OrdersService {
- rs := &OrdersService{s: s}
- return rs
-}
-
-type OrdersService struct {
- s *Service
-}
-
-// Error: An error returned by the API.
-type Error struct {
- // Domain: The domain of the error.
- Domain string `json:"domain,omitempty"`
-
- // Message: A description of the error.
- Message string `json:"message,omitempty"`
-
- // Reason: The error code.
- Reason string `json:"reason,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Domain") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Error) MarshalJSON() ([]byte, error) {
- type noMethod Error
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Errors: A list of errors returned by a failed batch entry.
-type Errors struct {
- // Code: The HTTP status of the first error in errors.
- Code int64 `json:"code,omitempty"`
-
- // Errors: A list of errors.
- Errors []*Error `json:"errors,omitempty"`
-
- // Message: The message of the first error in errors.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Errors) MarshalJSON() ([]byte, error) {
- type noMethod Errors
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Order struct {
- // Acknowledged: Whether the order was acknowledged.
- Acknowledged bool `json:"acknowledged,omitempty"`
-
- // Customer: The details of the customer who placed the order.
- Customer *OrderCustomer `json:"customer,omitempty"`
-
- // DeliveryDetails: The details for the delivery.
- DeliveryDetails *OrderDeliveryDetails `json:"deliveryDetails,omitempty"`
-
- // Id: The REST id of the order. Globally unique.
- Id string `json:"id,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#order".
- Kind string `json:"kind,omitempty"`
-
- // LineItems: Line items that are ordered.
- LineItems []*OrderLineItem `json:"lineItems,omitempty"`
-
- MerchantId uint64 `json:"merchantId,omitempty,string"`
-
- // MerchantOrderId: Merchant-provided id of the order.
- MerchantOrderId string `json:"merchantOrderId,omitempty"`
-
- // NetAmount: The net amount for the order. For example, if an order was
- // originally for a grand total of $100 and a refund was issued for $20,
- // the net amount will be $80.
- NetAmount *Price `json:"netAmount,omitempty"`
-
- // PaymentMethod: The details of the payment method.
- PaymentMethod *OrderPaymentMethod `json:"paymentMethod,omitempty"`
-
- // PaymentStatus: The status of the payment.
- PaymentStatus string `json:"paymentStatus,omitempty"`
-
- // PlacedDate: The date when the order was placed, in ISO 8601 format.
- PlacedDate string `json:"placedDate,omitempty"`
-
- // Refunds: Refunds for the order.
- Refunds []*OrderRefund `json:"refunds,omitempty"`
-
- // Shipments: Shipments of the order.
- Shipments []*OrderShipment `json:"shipments,omitempty"`
-
- // ShippingCost: The total cost of shipping for all items.
- ShippingCost *Price `json:"shippingCost,omitempty"`
-
- // ShippingCostTax: The tax for the total shipping cost.
- ShippingCostTax *Price `json:"shippingCostTax,omitempty"`
-
- // ShippingOption: The requested shipping option.
- ShippingOption string `json:"shippingOption,omitempty"`
-
- // Status: The status of the order.
- Status string `json:"status,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Acknowledged") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Order) MarshalJSON() ([]byte, error) {
- type noMethod Order
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderAddress struct {
- // Country: CLDR country code (e.g. "US").
- Country string `json:"country,omitempty"`
-
- // FullAddress: Strings representing the lines of the printed label for
- // mailing the order, for example:
- // John Smith
- // 1600 Amphitheatre Parkway
- // Mountain View, CA, 94043
- // United States
- FullAddress []string `json:"fullAddress,omitempty"`
-
- // IsPostOfficeBox: Whether the address is a post office box.
- IsPostOfficeBox bool `json:"isPostOfficeBox,omitempty"`
-
- // Locality: City, town or commune. May also include dependent
- // localities or sublocalities (e.g. neighborhoods or suburbs).
- Locality string `json:"locality,omitempty"`
-
- // PostalCode: Postal Code or ZIP (e.g. "94043").
- PostalCode string `json:"postalCode,omitempty"`
-
- // RecipientName: Name of the recipient.
- RecipientName string `json:"recipientName,omitempty"`
-
- // Region: Top-level administrative subdivision of the country (e.g.
- // "CA").
- Region string `json:"region,omitempty"`
-
- // StreetAddress: Street-level part of the address.
- StreetAddress []string `json:"streetAddress,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Country") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderAddress) MarshalJSON() ([]byte, error) {
- type noMethod OrderAddress
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderCancellation struct {
- // Actor: The actor that created the cancellation.
- Actor string `json:"actor,omitempty"`
-
- // CreationDate: Date on which the cancellation has been created, in ISO
- // 8601 format.
- CreationDate string `json:"creationDate,omitempty"`
-
- // Quantity: The quantity that was canceled.
- Quantity int64 `json:"quantity,omitempty"`
-
- // Reason: The reason for the cancellation.
- Reason string `json:"reason,omitempty"`
-
- // ReasonText: The explanation of the reason.
- ReasonText string `json:"reasonText,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Actor") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderCancellation) MarshalJSON() ([]byte, error) {
- type noMethod OrderCancellation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderCustomer struct {
- // Email: Email address of the customer.
- Email string `json:"email,omitempty"`
-
- // ExplicitMarketingPreference: If set, this indicates the user had a
- // choice to opt in or out of providing marketing rights to the
- // merchant. If unset, this indicates the user has already made this
- // choice in a previous purchase, and was thus not shown the marketing
- // right opt in/out checkbox during the Purchases on Google checkout
- // flow.
- ExplicitMarketingPreference bool `json:"explicitMarketingPreference,omitempty"`
-
- // FullName: Full name of the customer.
- FullName string `json:"fullName,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Email") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderCustomer) MarshalJSON() ([]byte, error) {
- type noMethod OrderCustomer
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderDeliveryDetails struct {
- // Address: The delivery address
- Address *OrderAddress `json:"address,omitempty"`
-
- // PhoneNumber: The phone number of the person receiving the delivery.
- PhoneNumber string `json:"phoneNumber,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Address") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderDeliveryDetails) MarshalJSON() ([]byte, error) {
- type noMethod OrderDeliveryDetails
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderLineItem struct {
- // Cancellations: Cancellations of the line item.
- Cancellations []*OrderCancellation `json:"cancellations,omitempty"`
-
- // Id: The id of the line item.
- Id string `json:"id,omitempty"`
-
- // Price: Total price for the line item. For example, if two items for
- // $10 are purchased, the total price will be $20.
- Price *Price `json:"price,omitempty"`
-
- // Product: Product data from the time of the order placement.
- Product *OrderLineItemProduct `json:"product,omitempty"`
-
- // QuantityCanceled: Number of items canceled.
- QuantityCanceled int64 `json:"quantityCanceled,omitempty"`
-
- // QuantityDelivered: Number of items delivered.
- QuantityDelivered int64 `json:"quantityDelivered,omitempty"`
-
- // QuantityOrdered: Number of items ordered.
- QuantityOrdered int64 `json:"quantityOrdered,omitempty"`
-
- // QuantityPending: Number of items pending.
- QuantityPending int64 `json:"quantityPending,omitempty"`
-
- // QuantityReturned: Number of items returned.
- QuantityReturned int64 `json:"quantityReturned,omitempty"`
-
- // QuantityShipped: Number of items shipped.
- QuantityShipped int64 `json:"quantityShipped,omitempty"`
-
- // ReturnInfo: Details of the return policy for the line item.
- ReturnInfo *OrderLineItemReturnInfo `json:"returnInfo,omitempty"`
-
- // Returns: Returns of the line item.
- Returns []*OrderReturn `json:"returns,omitempty"`
-
- // ShippingDetails: Details of the requested shipping for the line item.
- ShippingDetails *OrderLineItemShippingDetails `json:"shippingDetails,omitempty"`
-
- // Tax: Total tax amount for the line item. For example, if two items
- // are purchased, and each have a cost tax of $2, the total tax amount
- // will be $4.
- Tax *Price `json:"tax,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Cancellations") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderLineItem) MarshalJSON() ([]byte, error) {
- type noMethod OrderLineItem
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderLineItemProduct struct {
- // Brand: Brand of the item.
- Brand string `json:"brand,omitempty"`
-
- // Channel: The item's channel (online or local).
- Channel string `json:"channel,omitempty"`
-
- // Condition: Condition or state of the item.
- Condition string `json:"condition,omitempty"`
-
- // ContentLanguage: The two-letter ISO 639-1 language code for the item.
- ContentLanguage string `json:"contentLanguage,omitempty"`
-
- // Gtin: Global Trade Item Number (GTIN) of the item.
- Gtin string `json:"gtin,omitempty"`
-
- // Id: The REST id of the product.
- Id string `json:"id,omitempty"`
-
- // ImageLink: URL of an image of the item.
- ImageLink string `json:"imageLink,omitempty"`
-
- // ItemGroupId: Shared identifier for all variants of the same product.
- ItemGroupId string `json:"itemGroupId,omitempty"`
-
- // Mpn: Manufacturer Part Number (MPN) of the item.
- Mpn string `json:"mpn,omitempty"`
-
- // OfferId: An identifier of the item.
- OfferId string `json:"offerId,omitempty"`
-
- // Price: Price of the item.
- Price *Price `json:"price,omitempty"`
-
- // ShownImage: URL to the cached image shown to the user when order was
- // placed.
- ShownImage string `json:"shownImage,omitempty"`
-
- // TargetCountry: The CLDR territory code of the target country of the
- // product.
- TargetCountry string `json:"targetCountry,omitempty"`
-
- // Title: The title of the product.
- Title string `json:"title,omitempty"`
-
- // VariantAttributes: Variant attributes for the item. These are
- // dimensions of the product, such as color, gender, material, pattern,
- // and size. You can find a comprehensive list of variant attributes
- // here.
- VariantAttributes []*OrderLineItemProductVariantAttribute `json:"variantAttributes,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Brand") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderLineItemProduct) MarshalJSON() ([]byte, error) {
- type noMethod OrderLineItemProduct
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderLineItemProductVariantAttribute struct {
- // Dimension: The dimension of the variant.
- Dimension string `json:"dimension,omitempty"`
-
- // Value: The value for the dimension.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Dimension") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderLineItemProductVariantAttribute) MarshalJSON() ([]byte, error) {
- type noMethod OrderLineItemProductVariantAttribute
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderLineItemReturnInfo struct {
- // DaysToReturn: How many days later the item can be returned.
- DaysToReturn int64 `json:"daysToReturn,omitempty"`
-
- // IsReturnable: Whether the item is returnable.
- IsReturnable bool `json:"isReturnable,omitempty"`
-
- // PolicyUrl: URL of the item return policy.
- PolicyUrl string `json:"policyUrl,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DaysToReturn") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderLineItemReturnInfo) MarshalJSON() ([]byte, error) {
- type noMethod OrderLineItemReturnInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderLineItemShippingDetails struct {
- // DeliverByDate: The delivery by date, in ISO 8601 format.
- DeliverByDate string `json:"deliverByDate,omitempty"`
-
- // Method: Details of the shipping method.
- Method *OrderLineItemShippingDetailsMethod `json:"method,omitempty"`
-
- // ShipByDate: The ship by date, in ISO 8601 format.
- ShipByDate string `json:"shipByDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DeliverByDate") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderLineItemShippingDetails) MarshalJSON() ([]byte, error) {
- type noMethod OrderLineItemShippingDetails
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderLineItemShippingDetailsMethod struct {
- // Carrier: The carrier for the shipping. Optional.
- Carrier string `json:"carrier,omitempty"`
-
- // MaxDaysInTransit: Maximum transit time.
- MaxDaysInTransit int64 `json:"maxDaysInTransit,omitempty"`
-
- // MethodName: The name of the shipping method.
- MethodName string `json:"methodName,omitempty"`
-
- // MinDaysInTransit: Minimum transit time.
- MinDaysInTransit int64 `json:"minDaysInTransit,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Carrier") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderLineItemShippingDetailsMethod) MarshalJSON() ([]byte, error) {
- type noMethod OrderLineItemShippingDetailsMethod
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderPaymentMethod struct {
- // BillingAddress: The billing address.
- BillingAddress *OrderAddress `json:"billingAddress,omitempty"`
-
- // ExpirationMonth: The card expiration month (January = 1, February = 2
- // etc.).
- ExpirationMonth int64 `json:"expirationMonth,omitempty"`
-
- // ExpirationYear: The card expiration year (4-digit, e.g. 2015).
- ExpirationYear int64 `json:"expirationYear,omitempty"`
-
- // LastFourDigits: The last four digits of the card number.
- LastFourDigits string `json:"lastFourDigits,omitempty"`
-
- // PhoneNumber: The billing phone number.
- PhoneNumber string `json:"phoneNumber,omitempty"`
-
- // Type: The type of instrument (VISA, Mastercard, etc).
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BillingAddress") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderPaymentMethod) MarshalJSON() ([]byte, error) {
- type noMethod OrderPaymentMethod
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderRefund struct {
- // Actor: The actor that created the refund.
- Actor string `json:"actor,omitempty"`
-
- // Amount: The amount that is refunded.
- Amount *Price `json:"amount,omitempty"`
-
- // CreationDate: Date on which the item has been created, in ISO 8601
- // format.
- CreationDate string `json:"creationDate,omitempty"`
-
- // Reason: The reason for the refund.
- Reason string `json:"reason,omitempty"`
-
- // ReasonText: The explanation of the reason.
- ReasonText string `json:"reasonText,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Actor") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderRefund) MarshalJSON() ([]byte, error) {
- type noMethod OrderRefund
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderReturn struct {
- // Actor: The actor that created the refund.
- Actor string `json:"actor,omitempty"`
-
- // CreationDate: Date on which the item has been created, in ISO 8601
- // format.
- CreationDate string `json:"creationDate,omitempty"`
-
- // Quantity: Quantity that is returned.
- Quantity int64 `json:"quantity,omitempty"`
-
- // Reason: The reason for the return.
- Reason string `json:"reason,omitempty"`
-
- // ReasonText: The explanation of the reason.
- ReasonText string `json:"reasonText,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Actor") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderReturn) MarshalJSON() ([]byte, error) {
- type noMethod OrderReturn
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderShipment struct {
- // Carrier: The carrier handling the shipment.
- Carrier string `json:"carrier,omitempty"`
-
- // CreationDate: Date on which the shipment has been created, in ISO
- // 8601 format.
- CreationDate string `json:"creationDate,omitempty"`
-
- // DeliveryDate: Date on which the shipment has been delivered, in ISO
- // 8601 format. Present only if status is delievered
- DeliveryDate string `json:"deliveryDate,omitempty"`
-
- // Id: The id of the shipment.
- Id string `json:"id,omitempty"`
-
- // LineItems: The line items that are shipped.
- LineItems []*OrderShipmentLineItemShipment `json:"lineItems,omitempty"`
-
- // Status: The status of the shipment.
- Status string `json:"status,omitempty"`
-
- // TrackingId: The tracking id for the shipment.
- TrackingId string `json:"trackingId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Carrier") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderShipment) MarshalJSON() ([]byte, error) {
- type noMethod OrderShipment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrderShipmentLineItemShipment struct {
- // LineItemId: The id of the line item that is shipped.
- LineItemId string `json:"lineItemId,omitempty"`
-
- // Quantity: The quantity that is shipped.
- Quantity int64 `json:"quantity,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "LineItemId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderShipmentLineItemShipment) MarshalJSON() ([]byte, error) {
- type noMethod OrderShipmentLineItemShipment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersAcknowledgeRequest struct {
- // OperationId: The ID of the operation. Unique across all operations
- // for a given order.
- OperationId string `json:"operationId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "OperationId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersAcknowledgeRequest) MarshalJSON() ([]byte, error) {
- type noMethod OrdersAcknowledgeRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersAcknowledgeResponse struct {
- // ExecutionStatus: The status of the execution.
- ExecutionStatus string `json:"executionStatus,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersAcknowledgeResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ExecutionStatus") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersAcknowledgeResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersAcknowledgeResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersAdvanceTestOrderResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersAdvanceTestOrderResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersAdvanceTestOrderResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersAdvanceTestOrderResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCancelLineItemRequest struct {
- // LineItemId: The ID of the line item to cancel.
- LineItemId string `json:"lineItemId,omitempty"`
-
- // OperationId: The ID of the operation. Unique across all operations
- // for a given order.
- OperationId string `json:"operationId,omitempty"`
-
- // Quantity: The quantity to cancel.
- Quantity int64 `json:"quantity,omitempty"`
-
- // Reason: The reason for the cancellation.
- Reason string `json:"reason,omitempty"`
-
- // ReasonText: The explanation of the reason.
- ReasonText string `json:"reasonText,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "LineItemId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCancelLineItemRequest) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCancelLineItemRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCancelLineItemResponse struct {
- // ExecutionStatus: The status of the execution.
- ExecutionStatus string `json:"executionStatus,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersCancelLineItemResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ExecutionStatus") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCancelLineItemResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCancelLineItemResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCancelRequest struct {
- // OperationId: The ID of the operation. Unique across all operations
- // for a given order.
- OperationId string `json:"operationId,omitempty"`
-
- // Reason: The reason for the cancellation.
- Reason string `json:"reason,omitempty"`
-
- // ReasonText: The explanation of the reason.
- ReasonText string `json:"reasonText,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "OperationId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCancelRequest) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCancelRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCancelResponse struct {
- // ExecutionStatus: The status of the execution.
- ExecutionStatus string `json:"executionStatus,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersCancelResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ExecutionStatus") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCancelResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCancelResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCreateTestOrderRequest struct {
- // TemplateName: The test order template to use. Specify as an
- // alternative to testOrder as a shortcut for retrieving a template and
- // then creating an order using that template.
- TemplateName string `json:"templateName,omitempty"`
-
- // TestOrder: The test order to create.
- TestOrder *TestOrder `json:"testOrder,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "TemplateName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCreateTestOrderRequest) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCreateTestOrderRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCreateTestOrderResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersCreateTestOrderResponse".
- Kind string `json:"kind,omitempty"`
-
- // OrderId: The ID of the newly created test order.
- OrderId string `json:"orderId,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCreateTestOrderResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCreateTestOrderResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCustomBatchRequest struct {
- // Entries: The request entries to be processed in the batch.
- Entries []*OrdersCustomBatchRequestEntry `json:"entries,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Entries") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCustomBatchRequest) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCustomBatchRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCustomBatchRequestEntry struct {
- // BatchId: An entry ID, unique within the batch request.
- BatchId int64 `json:"batchId,omitempty"`
-
- // Cancel: Required for cancel method.
- Cancel *OrdersCustomBatchRequestEntryCancel `json:"cancel,omitempty"`
-
- // CancelLineItem: Required for cancelLineItem method.
- CancelLineItem *OrdersCustomBatchRequestEntryCancelLineItem `json:"cancelLineItem,omitempty"`
-
- // MerchantId: The ID of the managing account.
- MerchantId uint64 `json:"merchantId,omitempty,string"`
-
- // MerchantOrderId: The merchant order id. Required for
- // updateMerchantOrderId and getByMerchantOrderId methods.
- MerchantOrderId string `json:"merchantOrderId,omitempty"`
-
- // Method: The method to apply.
- Method string `json:"method,omitempty"`
-
- // OperationId: The ID of the operation. Unique across all operations
- // for a given order. Required for all methods beside get and
- // getByMerchantOrderId.
- OperationId string `json:"operationId,omitempty"`
-
- // OrderId: The ID of the order. Required for all methods beside
- // getByMerchantOrderId.
- OrderId string `json:"orderId,omitempty"`
-
- // Refund: Required for refund method.
- Refund *OrdersCustomBatchRequestEntryRefund `json:"refund,omitempty"`
-
- // ReturnLineItem: Required for returnLineItem method.
- ReturnLineItem *OrdersCustomBatchRequestEntryReturnLineItem `json:"returnLineItem,omitempty"`
-
- // ShipLineItems: Required for shipLineItems method.
- ShipLineItems *OrdersCustomBatchRequestEntryShipLineItems `json:"shipLineItems,omitempty"`
-
- // UpdateShipment: Required for updateShipment method.
- UpdateShipment *OrdersCustomBatchRequestEntryUpdateShipment `json:"updateShipment,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BatchId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCustomBatchRequestEntry) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCustomBatchRequestEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCustomBatchRequestEntryCancel struct {
- // Reason: The reason for the cancellation.
- Reason string `json:"reason,omitempty"`
-
- // ReasonText: The explanation of the reason.
- ReasonText string `json:"reasonText,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Reason") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCustomBatchRequestEntryCancel) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCustomBatchRequestEntryCancel
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCustomBatchRequestEntryCancelLineItem struct {
- // LineItemId: The ID of the line item to cancel.
- LineItemId string `json:"lineItemId,omitempty"`
-
- // Quantity: The quantity to cancel.
- Quantity int64 `json:"quantity,omitempty"`
-
- // Reason: The reason for the cancellation.
- Reason string `json:"reason,omitempty"`
-
- // ReasonText: The explanation of the reason.
- ReasonText string `json:"reasonText,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "LineItemId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCustomBatchRequestEntryCancelLineItem) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCustomBatchRequestEntryCancelLineItem
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCustomBatchRequestEntryRefund struct {
- // Amount: The amount that is refunded.
- Amount *Price `json:"amount,omitempty"`
-
- // Reason: The reason for the refund.
- Reason string `json:"reason,omitempty"`
-
- // ReasonText: The explanation of the reason.
- ReasonText string `json:"reasonText,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Amount") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCustomBatchRequestEntryRefund) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCustomBatchRequestEntryRefund
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCustomBatchRequestEntryReturnLineItem struct {
- // LineItemId: The ID of the line item to return.
- LineItemId string `json:"lineItemId,omitempty"`
-
- // Quantity: The quantity to return.
- Quantity int64 `json:"quantity,omitempty"`
-
- // Reason: The reason for the return.
- Reason string `json:"reason,omitempty"`
-
- // ReasonText: The explanation of the reason.
- ReasonText string `json:"reasonText,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "LineItemId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCustomBatchRequestEntryReturnLineItem) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCustomBatchRequestEntryReturnLineItem
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCustomBatchRequestEntryShipLineItems struct {
- // Carrier: The carrier handling the shipment.
- Carrier string `json:"carrier,omitempty"`
-
- // LineItems: Line items to ship.
- LineItems []*OrderShipmentLineItemShipment `json:"lineItems,omitempty"`
-
- // ShipmentId: The ID of the shipment.
- ShipmentId string `json:"shipmentId,omitempty"`
-
- // TrackingId: The tracking id for the shipment.
- TrackingId string `json:"trackingId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Carrier") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCustomBatchRequestEntryShipLineItems) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCustomBatchRequestEntryShipLineItems
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCustomBatchRequestEntryUpdateShipment struct {
- // Carrier: The carrier handling the shipment. Not updated if missing.
- Carrier string `json:"carrier,omitempty"`
-
- // ShipmentId: The ID of the shipment.
- ShipmentId string `json:"shipmentId,omitempty"`
-
- // Status: New status for the shipment. Not updated if missing.
- Status string `json:"status,omitempty"`
-
- // TrackingId: The tracking id for the shipment. Not updated if missing.
- TrackingId string `json:"trackingId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Carrier") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCustomBatchRequestEntryUpdateShipment) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCustomBatchRequestEntryUpdateShipment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCustomBatchResponse struct {
- // Entries: The result of the execution of the batch requests.
- Entries []*OrdersCustomBatchResponseEntry `json:"entries,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersCustomBatchResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Entries") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCustomBatchResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCustomBatchResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersCustomBatchResponseEntry struct {
- // BatchId: The ID of the request entry this entry responds to.
- BatchId int64 `json:"batchId,omitempty"`
-
- // Errors: A list of errors defined if and only if the request failed.
- Errors *Errors `json:"errors,omitempty"`
-
- // ExecutionStatus: The status of the execution. Only defined if the
- // method is not get or getByMerchantOrderId and if the request was
- // successful.
- ExecutionStatus string `json:"executionStatus,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersCustomBatchResponseEntry".
- Kind string `json:"kind,omitempty"`
-
- // Order: The retrieved order. Only defined if the method is get and if
- // the request was successful.
- Order *Order `json:"order,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BatchId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersCustomBatchResponseEntry) MarshalJSON() ([]byte, error) {
- type noMethod OrdersCustomBatchResponseEntry
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersGetByMerchantOrderIdResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersGetByMerchantOrderIdResponse".
- Kind string `json:"kind,omitempty"`
-
- // Order: The requested order.
- Order *Order `json:"order,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersGetByMerchantOrderIdResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersGetByMerchantOrderIdResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersGetTestOrderTemplateResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersGetTestOrderTemplateResponse".
- Kind string `json:"kind,omitempty"`
-
- // Template: The requested test order template.
- Template *TestOrder `json:"template,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersGetTestOrderTemplateResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersGetTestOrderTemplateResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: The token for the retrieval of the next page of
- // orders.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- Resources []*Order `json:"resources,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersListResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersRefundRequest struct {
- // Amount: The amount that is refunded.
- Amount *Price `json:"amount,omitempty"`
-
- // OperationId: The ID of the operation. Unique across all operations
- // for a given order.
- OperationId string `json:"operationId,omitempty"`
-
- // Reason: The reason for the refund.
- Reason string `json:"reason,omitempty"`
-
- // ReasonText: The explanation of the reason.
- ReasonText string `json:"reasonText,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Amount") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersRefundRequest) MarshalJSON() ([]byte, error) {
- type noMethod OrdersRefundRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersRefundResponse struct {
- // ExecutionStatus: The status of the execution.
- ExecutionStatus string `json:"executionStatus,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersRefundResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ExecutionStatus") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersRefundResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersRefundResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersReturnLineItemRequest struct {
- // LineItemId: The ID of the line item to return.
- LineItemId string `json:"lineItemId,omitempty"`
-
- // OperationId: The ID of the operation. Unique across all operations
- // for a given order.
- OperationId string `json:"operationId,omitempty"`
-
- // Quantity: The quantity to return.
- Quantity int64 `json:"quantity,omitempty"`
-
- // Reason: The reason for the return.
- Reason string `json:"reason,omitempty"`
-
- // ReasonText: The explanation of the reason.
- ReasonText string `json:"reasonText,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "LineItemId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersReturnLineItemRequest) MarshalJSON() ([]byte, error) {
- type noMethod OrdersReturnLineItemRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersReturnLineItemResponse struct {
- // ExecutionStatus: The status of the execution.
- ExecutionStatus string `json:"executionStatus,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersReturnLineItemResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ExecutionStatus") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersReturnLineItemResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersReturnLineItemResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersShipLineItemsRequest struct {
- // Carrier: The carrier handling the shipment.
- Carrier string `json:"carrier,omitempty"`
-
- // LineItems: Line items to ship.
- LineItems []*OrderShipmentLineItemShipment `json:"lineItems,omitempty"`
-
- // OperationId: The ID of the operation. Unique across all operations
- // for a given order.
- OperationId string `json:"operationId,omitempty"`
-
- // ShipmentId: The ID of the shipment.
- ShipmentId string `json:"shipmentId,omitempty"`
-
- // TrackingId: The tracking id for the shipment.
- TrackingId string `json:"trackingId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Carrier") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersShipLineItemsRequest) MarshalJSON() ([]byte, error) {
- type noMethod OrdersShipLineItemsRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersShipLineItemsResponse struct {
- // ExecutionStatus: The status of the execution.
- ExecutionStatus string `json:"executionStatus,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersShipLineItemsResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ExecutionStatus") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersShipLineItemsResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersShipLineItemsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersUpdateMerchantOrderIdRequest struct {
- // MerchantOrderId: The merchant order id to be assigned to the order.
- // Must be unique per merchant.
- MerchantOrderId string `json:"merchantOrderId,omitempty"`
-
- // OperationId: The ID of the operation. Unique across all operations
- // for a given order.
- OperationId string `json:"operationId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "MerchantOrderId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersUpdateMerchantOrderIdRequest) MarshalJSON() ([]byte, error) {
- type noMethod OrdersUpdateMerchantOrderIdRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersUpdateMerchantOrderIdResponse struct {
- // ExecutionStatus: The status of the execution.
- ExecutionStatus string `json:"executionStatus,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersUpdateMerchantOrderIdResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ExecutionStatus") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersUpdateMerchantOrderIdResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersUpdateMerchantOrderIdResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersUpdateShipmentRequest struct {
- // Carrier: The carrier handling the shipment. Not updated if missing.
- Carrier string `json:"carrier,omitempty"`
-
- // OperationId: The ID of the operation. Unique across all operations
- // for a given order.
- OperationId string `json:"operationId,omitempty"`
-
- // ShipmentId: The ID of the shipment.
- ShipmentId string `json:"shipmentId,omitempty"`
-
- // Status: New status for the shipment. Not updated if missing.
- Status string `json:"status,omitempty"`
-
- // TrackingId: The tracking id for the shipment. Not updated if missing.
- TrackingId string `json:"trackingId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Carrier") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersUpdateShipmentRequest) MarshalJSON() ([]byte, error) {
- type noMethod OrdersUpdateShipmentRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OrdersUpdateShipmentResponse struct {
- // ExecutionStatus: The status of the execution.
- ExecutionStatus string `json:"executionStatus,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#ordersUpdateShipmentResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ExecutionStatus") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersUpdateShipmentResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersUpdateShipmentResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Price struct {
- // Currency: The currency of the price.
- Currency string `json:"currency,omitempty"`
-
- // Value: The price represented as a number.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Currency") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Price) MarshalJSON() ([]byte, error) {
- type noMethod Price
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TestOrder struct {
- // Customer: The details of the customer who placed the order.
- Customer *TestOrderCustomer `json:"customer,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "content#testOrder".
- Kind string `json:"kind,omitempty"`
-
- // LineItems: Line items that are ordered. At least one line item must
- // be provided.
- LineItems []*TestOrderLineItem `json:"lineItems,omitempty"`
-
- // PaymentMethod: The details of the payment method.
- PaymentMethod *TestOrderPaymentMethod `json:"paymentMethod,omitempty"`
-
- // PredefinedDeliveryAddress: Identifier of one of the predefined
- // delivery addresses for the delivery.
- PredefinedDeliveryAddress string `json:"predefinedDeliveryAddress,omitempty"`
-
- // ShippingCost: The total cost of shipping for all items.
- ShippingCost *Price `json:"shippingCost,omitempty"`
-
- // ShippingCostTax: The tax for the total shipping cost.
- ShippingCostTax *Price `json:"shippingCostTax,omitempty"`
-
- // ShippingOption: The requested shipping option.
- ShippingOption string `json:"shippingOption,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Customer") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TestOrder) MarshalJSON() ([]byte, error) {
- type noMethod TestOrder
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TestOrderCustomer struct {
- // Email: Email address of the customer.
- Email string `json:"email,omitempty"`
-
- // ExplicitMarketingPreference: If set, this indicates the user had a
- // choice to opt in or out of providing marketing rights to the
- // merchant. If unset, this indicates the user has already made this
- // choice in a previous purchase, and was thus not shown the marketing
- // right opt in/out checkbox during the Purchases on Google checkout
- // flow. Optional.
- ExplicitMarketingPreference bool `json:"explicitMarketingPreference,omitempty"`
-
- // FullName: Full name of the customer.
- FullName string `json:"fullName,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Email") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TestOrderCustomer) MarshalJSON() ([]byte, error) {
- type noMethod TestOrderCustomer
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TestOrderLineItem struct {
- // Product: Product data from the time of the order placement.
- Product *TestOrderLineItemProduct `json:"product,omitempty"`
-
- // QuantityOrdered: Number of items ordered.
- QuantityOrdered int64 `json:"quantityOrdered,omitempty"`
-
- // ReturnInfo: Details of the return policy for the line item.
- ReturnInfo *OrderLineItemReturnInfo `json:"returnInfo,omitempty"`
-
- // ShippingDetails: Details of the requested shipping for the line item.
- ShippingDetails *OrderLineItemShippingDetails `json:"shippingDetails,omitempty"`
-
- // UnitTax: Unit tax for the line item.
- UnitTax *Price `json:"unitTax,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Product") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TestOrderLineItem) MarshalJSON() ([]byte, error) {
- type noMethod TestOrderLineItem
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TestOrderLineItemProduct struct {
- // Brand: Brand of the item.
- Brand string `json:"brand,omitempty"`
-
- // Channel: The item's channel.
- Channel string `json:"channel,omitempty"`
-
- // Condition: Condition or state of the item.
- Condition string `json:"condition,omitempty"`
-
- // ContentLanguage: The two-letter ISO 639-1 language code for the item.
- ContentLanguage string `json:"contentLanguage,omitempty"`
-
- // Gtin: Global Trade Item Number (GTIN) of the item. Optional.
- Gtin string `json:"gtin,omitempty"`
-
- // ImageLink: URL of an image of the item.
- ImageLink string `json:"imageLink,omitempty"`
-
- // ItemGroupId: Shared identifier for all variants of the same product.
- // Optional.
- ItemGroupId string `json:"itemGroupId,omitempty"`
-
- // Mpn: Manufacturer Part Number (MPN) of the item. Optional.
- Mpn string `json:"mpn,omitempty"`
-
- // OfferId: An identifier of the item.
- OfferId string `json:"offerId,omitempty"`
-
- // Price: The price for the product.
- Price *Price `json:"price,omitempty"`
-
- // TargetCountry: The CLDR territory code of the target country of the
- // product.
- TargetCountry string `json:"targetCountry,omitempty"`
-
- // Title: The title of the product.
- Title string `json:"title,omitempty"`
-
- // VariantAttributes: Variant attributes for the item. Optional.
- VariantAttributes []*OrderLineItemProductVariantAttribute `json:"variantAttributes,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Brand") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TestOrderLineItemProduct) MarshalJSON() ([]byte, error) {
- type noMethod TestOrderLineItemProduct
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TestOrderPaymentMethod struct {
- // ExpirationMonth: The card expiration month (January = 1, February = 2
- // etc.).
- ExpirationMonth int64 `json:"expirationMonth,omitempty"`
-
- // ExpirationYear: The card expiration year (4-digit, e.g. 2015).
- ExpirationYear int64 `json:"expirationYear,omitempty"`
-
- // LastFourDigits: The last four digits of the card number.
- LastFourDigits string `json:"lastFourDigits,omitempty"`
-
- // PredefinedBillingAddress: The billing address.
- PredefinedBillingAddress string `json:"predefinedBillingAddress,omitempty"`
-
- // Type: The type of instrument. Note that real orders might have
- // different values than the four values accepted by createTestOrder.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ExpirationMonth") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TestOrderPaymentMethod) MarshalJSON() ([]byte, error) {
- type noMethod TestOrderPaymentMethod
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "content.orders.acknowledge":
-
-type OrdersAcknowledgeCall struct {
- s *Service
- merchantId uint64
- orderId string
- ordersacknowledgerequest *OrdersAcknowledgeRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Acknowledge: Marks an order as acknowledged.
-func (r *OrdersService) Acknowledge(merchantId uint64, orderId string, ordersacknowledgerequest *OrdersAcknowledgeRequest) *OrdersAcknowledgeCall {
- c := &OrdersAcknowledgeCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.orderId = orderId
- c.ordersacknowledgerequest = ordersacknowledgerequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersAcknowledgeCall) Fields(s ...googleapi.Field) *OrdersAcknowledgeCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersAcknowledgeCall) Context(ctx context.Context) *OrdersAcknowledgeCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersAcknowledgeCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.ordersacknowledgerequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/orders/{orderId}/acknowledge")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "orderId": c.orderId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.acknowledge" call.
-// Exactly one of *OrdersAcknowledgeResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *OrdersAcknowledgeResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OrdersAcknowledgeCall) Do() (*OrdersAcknowledgeResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersAcknowledgeResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Marks an order as acknowledged.",
- // "httpMethod": "POST",
- // "id": "content.orders.acknowledge",
- // "parameterOrder": [
- // "merchantId",
- // "orderId"
- // ],
- // "parameters": {
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "orderId": {
- // "description": "The ID of the order.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/orders/{orderId}/acknowledge",
- // "request": {
- // "$ref": "OrdersAcknowledgeRequest"
- // },
- // "response": {
- // "$ref": "OrdersAcknowledgeResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.advancetestorder":
-
-type OrdersAdvancetestorderCall struct {
- s *Service
- merchantId uint64
- orderId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Advancetestorder: Sandbox only. Moves a test order from state
-// "inProgress" to state "pendingShipment".
-func (r *OrdersService) Advancetestorder(merchantId uint64, orderId string) *OrdersAdvancetestorderCall {
- c := &OrdersAdvancetestorderCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.orderId = orderId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersAdvancetestorderCall) Fields(s ...googleapi.Field) *OrdersAdvancetestorderCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersAdvancetestorderCall) Context(ctx context.Context) *OrdersAdvancetestorderCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersAdvancetestorderCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/testorders/{orderId}/advance")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "orderId": c.orderId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.advancetestorder" call.
-// Exactly one of *OrdersAdvanceTestOrderResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *OrdersAdvanceTestOrderResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OrdersAdvancetestorderCall) Do() (*OrdersAdvanceTestOrderResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersAdvanceTestOrderResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sandbox only. Moves a test order from state \"inProgress\" to state \"pendingShipment\".",
- // "httpMethod": "POST",
- // "id": "content.orders.advancetestorder",
- // "parameterOrder": [
- // "merchantId",
- // "orderId"
- // ],
- // "parameters": {
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "orderId": {
- // "description": "The ID of the test order to modify.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/testorders/{orderId}/advance",
- // "response": {
- // "$ref": "OrdersAdvanceTestOrderResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.cancel":
-
-type OrdersCancelCall struct {
- s *Service
- merchantId uint64
- orderId string
- orderscancelrequest *OrdersCancelRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Cancel: Cancels all line items in an order.
-func (r *OrdersService) Cancel(merchantId uint64, orderId string, orderscancelrequest *OrdersCancelRequest) *OrdersCancelCall {
- c := &OrdersCancelCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.orderId = orderId
- c.orderscancelrequest = orderscancelrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersCancelCall) Fields(s ...googleapi.Field) *OrdersCancelCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersCancelCall) Context(ctx context.Context) *OrdersCancelCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersCancelCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.orderscancelrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/orders/{orderId}/cancel")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "orderId": c.orderId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.cancel" call.
-// Exactly one of *OrdersCancelResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *OrdersCancelResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OrdersCancelCall) Do() (*OrdersCancelResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersCancelResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Cancels all line items in an order.",
- // "httpMethod": "POST",
- // "id": "content.orders.cancel",
- // "parameterOrder": [
- // "merchantId",
- // "orderId"
- // ],
- // "parameters": {
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "orderId": {
- // "description": "The ID of the order to cancel.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/orders/{orderId}/cancel",
- // "request": {
- // "$ref": "OrdersCancelRequest"
- // },
- // "response": {
- // "$ref": "OrdersCancelResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.cancellineitem":
-
-type OrdersCancellineitemCall struct {
- s *Service
- merchantId uint64
- orderId string
- orderscancellineitemrequest *OrdersCancelLineItemRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Cancellineitem: Cancels a line item.
-func (r *OrdersService) Cancellineitem(merchantId uint64, orderId string, orderscancellineitemrequest *OrdersCancelLineItemRequest) *OrdersCancellineitemCall {
- c := &OrdersCancellineitemCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.orderId = orderId
- c.orderscancellineitemrequest = orderscancellineitemrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersCancellineitemCall) Fields(s ...googleapi.Field) *OrdersCancellineitemCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersCancellineitemCall) Context(ctx context.Context) *OrdersCancellineitemCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersCancellineitemCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.orderscancellineitemrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/orders/{orderId}/cancelLineItem")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "orderId": c.orderId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.cancellineitem" call.
-// Exactly one of *OrdersCancelLineItemResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *OrdersCancelLineItemResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OrdersCancellineitemCall) Do() (*OrdersCancelLineItemResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersCancelLineItemResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Cancels a line item.",
- // "httpMethod": "POST",
- // "id": "content.orders.cancellineitem",
- // "parameterOrder": [
- // "merchantId",
- // "orderId"
- // ],
- // "parameters": {
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "orderId": {
- // "description": "The ID of the order.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/orders/{orderId}/cancelLineItem",
- // "request": {
- // "$ref": "OrdersCancelLineItemRequest"
- // },
- // "response": {
- // "$ref": "OrdersCancelLineItemResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.createtestorder":
-
-type OrdersCreatetestorderCall struct {
- s *Service
- merchantId uint64
- orderscreatetestorderrequest *OrdersCreateTestOrderRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Createtestorder: Sandbox only. Creates a test order.
-func (r *OrdersService) Createtestorder(merchantId uint64, orderscreatetestorderrequest *OrdersCreateTestOrderRequest) *OrdersCreatetestorderCall {
- c := &OrdersCreatetestorderCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.orderscreatetestorderrequest = orderscreatetestorderrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersCreatetestorderCall) Fields(s ...googleapi.Field) *OrdersCreatetestorderCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersCreatetestorderCall) Context(ctx context.Context) *OrdersCreatetestorderCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersCreatetestorderCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.orderscreatetestorderrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/testorders")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.createtestorder" call.
-// Exactly one of *OrdersCreateTestOrderResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *OrdersCreateTestOrderResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OrdersCreatetestorderCall) Do() (*OrdersCreateTestOrderResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersCreateTestOrderResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sandbox only. Creates a test order.",
- // "httpMethod": "POST",
- // "id": "content.orders.createtestorder",
- // "parameterOrder": [
- // "merchantId"
- // ],
- // "parameters": {
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/testorders",
- // "request": {
- // "$ref": "OrdersCreateTestOrderRequest"
- // },
- // "response": {
- // "$ref": "OrdersCreateTestOrderResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.custombatch":
-
-type OrdersCustombatchCall struct {
- s *Service
- orderscustombatchrequest *OrdersCustomBatchRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Custombatch: Retrieves or modifies multiple orders in a single
-// request.
-func (r *OrdersService) Custombatch(orderscustombatchrequest *OrdersCustomBatchRequest) *OrdersCustombatchCall {
- c := &OrdersCustombatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.orderscustombatchrequest = orderscustombatchrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersCustombatchCall) Fields(s ...googleapi.Field) *OrdersCustombatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersCustombatchCall) Context(ctx context.Context) *OrdersCustombatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersCustombatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.orderscustombatchrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "orders/batch")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.custombatch" call.
-// Exactly one of *OrdersCustomBatchResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *OrdersCustomBatchResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OrdersCustombatchCall) Do() (*OrdersCustomBatchResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersCustomBatchResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves or modifies multiple orders in a single request.",
- // "httpMethod": "POST",
- // "id": "content.orders.custombatch",
- // "path": "orders/batch",
- // "request": {
- // "$ref": "OrdersCustomBatchRequest"
- // },
- // "response": {
- // "$ref": "OrdersCustomBatchResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.get":
-
-type OrdersGetCall struct {
- s *Service
- merchantId uint64
- orderId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves an order from your Merchant Center account.
-func (r *OrdersService) Get(merchantId uint64, orderId string) *OrdersGetCall {
- c := &OrdersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.orderId = orderId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersGetCall) Fields(s ...googleapi.Field) *OrdersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OrdersGetCall) IfNoneMatch(entityTag string) *OrdersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersGetCall) Context(ctx context.Context) *OrdersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/orders/{orderId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "orderId": c.orderId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.get" call.
-// Exactly one of *Order or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Order.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *OrdersGetCall) Do() (*Order, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Order{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves an order from your Merchant Center account.",
- // "httpMethod": "GET",
- // "id": "content.orders.get",
- // "parameterOrder": [
- // "merchantId",
- // "orderId"
- // ],
- // "parameters": {
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "orderId": {
- // "description": "The ID of the order.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/orders/{orderId}",
- // "response": {
- // "$ref": "Order"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.getbymerchantorderid":
-
-type OrdersGetbymerchantorderidCall struct {
- s *Service
- merchantId uint64
- merchantOrderId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Getbymerchantorderid: Retrieves an order using merchant order id.
-func (r *OrdersService) Getbymerchantorderid(merchantId uint64, merchantOrderId string) *OrdersGetbymerchantorderidCall {
- c := &OrdersGetbymerchantorderidCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.merchantOrderId = merchantOrderId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersGetbymerchantorderidCall) Fields(s ...googleapi.Field) *OrdersGetbymerchantorderidCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OrdersGetbymerchantorderidCall) IfNoneMatch(entityTag string) *OrdersGetbymerchantorderidCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersGetbymerchantorderidCall) Context(ctx context.Context) *OrdersGetbymerchantorderidCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersGetbymerchantorderidCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/ordersbymerchantid/{merchantOrderId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "merchantOrderId": c.merchantOrderId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.getbymerchantorderid" call.
-// Exactly one of *OrdersGetByMerchantOrderIdResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *OrdersGetByMerchantOrderIdResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *OrdersGetbymerchantorderidCall) Do() (*OrdersGetByMerchantOrderIdResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersGetByMerchantOrderIdResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves an order using merchant order id.",
- // "httpMethod": "GET",
- // "id": "content.orders.getbymerchantorderid",
- // "parameterOrder": [
- // "merchantId",
- // "merchantOrderId"
- // ],
- // "parameters": {
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "merchantOrderId": {
- // "description": "The merchant order id to be looked for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/ordersbymerchantid/{merchantOrderId}",
- // "response": {
- // "$ref": "OrdersGetByMerchantOrderIdResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.gettestordertemplate":
-
-type OrdersGettestordertemplateCall struct {
- s *Service
- merchantId uint64
- templateName string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Gettestordertemplate: Sandbox only. Retrieves an order template that
-// can be used to quickly create a new order in sandbox.
-func (r *OrdersService) Gettestordertemplate(merchantId uint64, templateName string) *OrdersGettestordertemplateCall {
- c := &OrdersGettestordertemplateCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.templateName = templateName
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersGettestordertemplateCall) Fields(s ...googleapi.Field) *OrdersGettestordertemplateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OrdersGettestordertemplateCall) IfNoneMatch(entityTag string) *OrdersGettestordertemplateCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersGettestordertemplateCall) Context(ctx context.Context) *OrdersGettestordertemplateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersGettestordertemplateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/testordertemplates/{templateName}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "templateName": c.templateName,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.gettestordertemplate" call.
-// Exactly one of *OrdersGetTestOrderTemplateResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *OrdersGetTestOrderTemplateResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *OrdersGettestordertemplateCall) Do() (*OrdersGetTestOrderTemplateResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersGetTestOrderTemplateResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.",
- // "httpMethod": "GET",
- // "id": "content.orders.gettestordertemplate",
- // "parameterOrder": [
- // "merchantId",
- // "templateName"
- // ],
- // "parameters": {
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "templateName": {
- // "description": "The name of the template to retrieve.",
- // "enum": [
- // "template1",
- // "template2"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/testordertemplates/{templateName}",
- // "response": {
- // "$ref": "OrdersGetTestOrderTemplateResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.list":
-
-type OrdersListCall struct {
- s *Service
- merchantId uint64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists the orders in your Merchant Center account.
-func (r *OrdersService) List(merchantId uint64) *OrdersListCall {
- c := &OrdersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- return c
-}
-
-// Acknowledged sets the optional parameter "acknowledged": Obtains
-// orders that match the acknowledgement status. When set to true,
-// obtains orders that have been acknowledged. When false, obtains
-// orders that have not been acknowledged.
-// We recommend using this filter set to false, in conjunction with the
-// acknowledge call, such that only un-acknowledged orders are returned.
-func (c *OrdersListCall) Acknowledged(acknowledged bool) *OrdersListCall {
- c.opt_["acknowledged"] = acknowledged
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": The maximum
-// number of orders to return in the response, used for paging. The
-// default value is 25 orders per page, and the maximum allowed value is
-// 250 orders per page.
-// Known issue: All List calls will return all Orders without limit
-// regardless of the value of this field.
-func (c *OrdersListCall) MaxResults(maxResults int64) *OrdersListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderBy sets the optional parameter "orderBy": The ordering of the
-// returned list. The only supported value are placedDate desc and
-// placedDate asc for now, which returns orders sorted by placement
-// date. "placedDate desc" stands for listing orders by placement date,
-// from oldest to most recent. "placedDate asc" stands for listing
-// orders by placement date, from most recent to oldest. In future
-// releases we'll support other sorting criteria.
-//
-// Possible values:
-// "placedDate asc"
-// "placedDate desc"
-func (c *OrdersListCall) OrderBy(orderBy string) *OrdersListCall {
- c.opt_["orderBy"] = orderBy
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The token returned
-// by the previous request.
-func (c *OrdersListCall) PageToken(pageToken string) *OrdersListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// PlacedDateEnd sets the optional parameter "placedDateEnd": Obtains
-// orders placed before this date (exclusively), in ISO 8601 format.
-func (c *OrdersListCall) PlacedDateEnd(placedDateEnd string) *OrdersListCall {
- c.opt_["placedDateEnd"] = placedDateEnd
- return c
-}
-
-// PlacedDateStart sets the optional parameter "placedDateStart":
-// Obtains orders placed after this date (inclusively), in ISO 8601
-// format.
-func (c *OrdersListCall) PlacedDateStart(placedDateStart string) *OrdersListCall {
- c.opt_["placedDateStart"] = placedDateStart
- return c
-}
-
-// Statuses sets the optional parameter "statuses": Obtains orders that
-// match any of the specified statuses. Multiple values can be specified
-// with comma separation. Additionally, please note that active is a
-// shortcut for pendingShipment and partiallyShipped, and completed is a
-// shortcut for shipped , partiallyDelivered, delivered,
-// partiallyReturned, returned, and canceled.
-//
-// Possible values:
-// "active"
-// "canceled"
-// "completed"
-// "delivered"
-// "inProgress"
-// "partiallyDelivered"
-// "partiallyReturned"
-// "partiallyShipped"
-// "pendingShipment"
-// "returned"
-// "shipped"
-func (c *OrdersListCall) Statuses(statuses string) *OrdersListCall {
- c.opt_["statuses"] = statuses
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersListCall) Fields(s ...googleapi.Field) *OrdersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OrdersListCall) IfNoneMatch(entityTag string) *OrdersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersListCall) Context(ctx context.Context) *OrdersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["acknowledged"]; ok {
- params.Set("acknowledged", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderBy"]; ok {
- params.Set("orderBy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["placedDateEnd"]; ok {
- params.Set("placedDateEnd", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["placedDateStart"]; ok {
- params.Set("placedDateStart", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["statuses"]; ok {
- params.Set("statuses", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/orders")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.list" call.
-// Exactly one of *OrdersListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *OrdersListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OrdersListCall) Do() (*OrdersListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists the orders in your Merchant Center account.",
- // "httpMethod": "GET",
- // "id": "content.orders.list",
- // "parameterOrder": [
- // "merchantId"
- // ],
- // "parameters": {
- // "acknowledged": {
- // "description": "Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged.\nWe recommend using this filter set to false, in conjunction with the acknowledge call, such that only un-acknowledged orders are returned.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.\nKnown issue: All List calls will return all Orders without limit regardless of the value of this field.",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "orderBy": {
- // "description": "The ordering of the returned list. The only supported value are placedDate desc and placedDate asc for now, which returns orders sorted by placement date. \"placedDate desc\" stands for listing orders by placement date, from oldest to most recent. \"placedDate asc\" stands for listing orders by placement date, from most recent to oldest. In future releases we'll support other sorting criteria.",
- // "enum": [
- // "placedDate asc",
- // "placedDate desc"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "The token returned by the previous request.",
- // "location": "query",
- // "type": "string"
- // },
- // "placedDateEnd": {
- // "description": "Obtains orders placed before this date (exclusively), in ISO 8601 format.",
- // "location": "query",
- // "type": "string"
- // },
- // "placedDateStart": {
- // "description": "Obtains orders placed after this date (inclusively), in ISO 8601 format.",
- // "location": "query",
- // "type": "string"
- // },
- // "statuses": {
- // "description": "Obtains orders that match any of the specified statuses. Multiple values can be specified with comma separation. Additionally, please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped , partiallyDelivered, delivered, partiallyReturned, returned, and canceled.",
- // "enum": [
- // "active",
- // "canceled",
- // "completed",
- // "delivered",
- // "inProgress",
- // "partiallyDelivered",
- // "partiallyReturned",
- // "partiallyShipped",
- // "pendingShipment",
- // "returned",
- // "shipped"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/orders",
- // "response": {
- // "$ref": "OrdersListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.refund":
-
-type OrdersRefundCall struct {
- s *Service
- merchantId uint64
- orderId string
- ordersrefundrequest *OrdersRefundRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Refund: Refund a portion of the order, up to the full amount paid.
-func (r *OrdersService) Refund(merchantId uint64, orderId string, ordersrefundrequest *OrdersRefundRequest) *OrdersRefundCall {
- c := &OrdersRefundCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.orderId = orderId
- c.ordersrefundrequest = ordersrefundrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersRefundCall) Fields(s ...googleapi.Field) *OrdersRefundCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersRefundCall) Context(ctx context.Context) *OrdersRefundCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersRefundCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.ordersrefundrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/orders/{orderId}/refund")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "orderId": c.orderId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.refund" call.
-// Exactly one of *OrdersRefundResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *OrdersRefundResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OrdersRefundCall) Do() (*OrdersRefundResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersRefundResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Refund a portion of the order, up to the full amount paid.",
- // "httpMethod": "POST",
- // "id": "content.orders.refund",
- // "parameterOrder": [
- // "merchantId",
- // "orderId"
- // ],
- // "parameters": {
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "orderId": {
- // "description": "The ID of the order to refund.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/orders/{orderId}/refund",
- // "request": {
- // "$ref": "OrdersRefundRequest"
- // },
- // "response": {
- // "$ref": "OrdersRefundResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.returnlineitem":
-
-type OrdersReturnlineitemCall struct {
- s *Service
- merchantId uint64
- orderId string
- ordersreturnlineitemrequest *OrdersReturnLineItemRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Returnlineitem: Returns a line item.
-func (r *OrdersService) Returnlineitem(merchantId uint64, orderId string, ordersreturnlineitemrequest *OrdersReturnLineItemRequest) *OrdersReturnlineitemCall {
- c := &OrdersReturnlineitemCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.orderId = orderId
- c.ordersreturnlineitemrequest = ordersreturnlineitemrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersReturnlineitemCall) Fields(s ...googleapi.Field) *OrdersReturnlineitemCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersReturnlineitemCall) Context(ctx context.Context) *OrdersReturnlineitemCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersReturnlineitemCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.ordersreturnlineitemrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/orders/{orderId}/returnLineItem")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "orderId": c.orderId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.returnlineitem" call.
-// Exactly one of *OrdersReturnLineItemResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *OrdersReturnLineItemResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OrdersReturnlineitemCall) Do() (*OrdersReturnLineItemResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersReturnLineItemResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns a line item.",
- // "httpMethod": "POST",
- // "id": "content.orders.returnlineitem",
- // "parameterOrder": [
- // "merchantId",
- // "orderId"
- // ],
- // "parameters": {
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "orderId": {
- // "description": "The ID of the order.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/orders/{orderId}/returnLineItem",
- // "request": {
- // "$ref": "OrdersReturnLineItemRequest"
- // },
- // "response": {
- // "$ref": "OrdersReturnLineItemResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.shiplineitems":
-
-type OrdersShiplineitemsCall struct {
- s *Service
- merchantId uint64
- orderId string
- ordersshiplineitemsrequest *OrdersShipLineItemsRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Shiplineitems: Marks line item(s) as shipped.
-func (r *OrdersService) Shiplineitems(merchantId uint64, orderId string, ordersshiplineitemsrequest *OrdersShipLineItemsRequest) *OrdersShiplineitemsCall {
- c := &OrdersShiplineitemsCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.orderId = orderId
- c.ordersshiplineitemsrequest = ordersshiplineitemsrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersShiplineitemsCall) Fields(s ...googleapi.Field) *OrdersShiplineitemsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersShiplineitemsCall) Context(ctx context.Context) *OrdersShiplineitemsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersShiplineitemsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.ordersshiplineitemsrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/orders/{orderId}/shipLineItems")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "orderId": c.orderId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.shiplineitems" call.
-// Exactly one of *OrdersShipLineItemsResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *OrdersShipLineItemsResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OrdersShiplineitemsCall) Do() (*OrdersShipLineItemsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersShipLineItemsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Marks line item(s) as shipped.",
- // "httpMethod": "POST",
- // "id": "content.orders.shiplineitems",
- // "parameterOrder": [
- // "merchantId",
- // "orderId"
- // ],
- // "parameters": {
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "orderId": {
- // "description": "The ID of the order.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/orders/{orderId}/shipLineItems",
- // "request": {
- // "$ref": "OrdersShipLineItemsRequest"
- // },
- // "response": {
- // "$ref": "OrdersShipLineItemsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.updatemerchantorderid":
-
-type OrdersUpdatemerchantorderidCall struct {
- s *Service
- merchantId uint64
- orderId string
- ordersupdatemerchantorderidrequest *OrdersUpdateMerchantOrderIdRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Updatemerchantorderid: Updates the merchant order ID for a given
-// order.
-func (r *OrdersService) Updatemerchantorderid(merchantId uint64, orderId string, ordersupdatemerchantorderidrequest *OrdersUpdateMerchantOrderIdRequest) *OrdersUpdatemerchantorderidCall {
- c := &OrdersUpdatemerchantorderidCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.orderId = orderId
- c.ordersupdatemerchantorderidrequest = ordersupdatemerchantorderidrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersUpdatemerchantorderidCall) Fields(s ...googleapi.Field) *OrdersUpdatemerchantorderidCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersUpdatemerchantorderidCall) Context(ctx context.Context) *OrdersUpdatemerchantorderidCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersUpdatemerchantorderidCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.ordersupdatemerchantorderidrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/orders/{orderId}/updateMerchantOrderId")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "orderId": c.orderId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.updatemerchantorderid" call.
-// Exactly one of *OrdersUpdateMerchantOrderIdResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *OrdersUpdateMerchantOrderIdResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *OrdersUpdatemerchantorderidCall) Do() (*OrdersUpdateMerchantOrderIdResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersUpdateMerchantOrderIdResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates the merchant order ID for a given order.",
- // "httpMethod": "POST",
- // "id": "content.orders.updatemerchantorderid",
- // "parameterOrder": [
- // "merchantId",
- // "orderId"
- // ],
- // "parameters": {
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "orderId": {
- // "description": "The ID of the order.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/orders/{orderId}/updateMerchantOrderId",
- // "request": {
- // "$ref": "OrdersUpdateMerchantOrderIdRequest"
- // },
- // "response": {
- // "$ref": "OrdersUpdateMerchantOrderIdResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
-
-// method id "content.orders.updateshipment":
-
-type OrdersUpdateshipmentCall struct {
- s *Service
- merchantId uint64
- orderId string
- ordersupdateshipmentrequest *OrdersUpdateShipmentRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Updateshipment: Updates a shipment's status, carrier, and/or tracking
-// ID.
-func (r *OrdersService) Updateshipment(merchantId uint64, orderId string, ordersupdateshipmentrequest *OrdersUpdateShipmentRequest) *OrdersUpdateshipmentCall {
- c := &OrdersUpdateshipmentCall{s: r.s, opt_: make(map[string]interface{})}
- c.merchantId = merchantId
- c.orderId = orderId
- c.ordersupdateshipmentrequest = ordersupdateshipmentrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersUpdateshipmentCall) Fields(s ...googleapi.Field) *OrdersUpdateshipmentCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersUpdateshipmentCall) Context(ctx context.Context) *OrdersUpdateshipmentCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersUpdateshipmentCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.ordersupdateshipmentrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/orders/{orderId}/updateShipment")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "merchantId": strconv.FormatUint(c.merchantId, 10),
- "orderId": c.orderId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "content.orders.updateshipment" call.
-// Exactly one of *OrdersUpdateShipmentResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *OrdersUpdateShipmentResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OrdersUpdateshipmentCall) Do() (*OrdersUpdateShipmentResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersUpdateShipmentResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a shipment's status, carrier, and/or tracking ID.",
- // "httpMethod": "POST",
- // "id": "content.orders.updateshipment",
- // "parameterOrder": [
- // "merchantId",
- // "orderId"
- // ],
- // "parameters": {
- // "merchantId": {
- // "description": "The ID of the managing account.",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "orderId": {
- // "description": "The ID of the order.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{merchantId}/orders/{orderId}/updateShipment",
- // "request": {
- // "$ref": "OrdersUpdateShipmentRequest"
- // },
- // "response": {
- // "$ref": "OrdersUpdateShipmentResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/content"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/coordinate/v1/coordinate-api.json b/vendor/google.golang.org/api/coordinate/v1/coordinate-api.json
deleted file mode 100644
index d749cf9a..00000000
--- a/vendor/google.golang.org/api/coordinate/v1/coordinate-api.json
+++ /dev/null
@@ -1,1196 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/RNf67Qs-KGgGShWEZ1M0BbfJUQg\"",
- "discoveryVersion": "v1",
- "id": "coordinate:v1",
- "name": "coordinate",
- "version": "v1",
- "revision": "20150811",
- "title": "Google Maps Coordinate API",
- "description": "Lets you view and manage jobs in a Coordinate team.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/coordinate/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/coordinate/v1/",
- "basePath": "/coordinate/v1/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "coordinate/v1/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/coordinate": {
- "description": "View and manage your Google Maps Coordinate jobs"
- },
- "https://www.googleapis.com/auth/coordinate.readonly": {
- "description": "View your Google Coordinate jobs"
- }
- }
- }
- },
- "schemas": {
- "CustomField": {
- "id": "CustomField",
- "type": "object",
- "description": "Custom field.",
- "properties": {
- "customFieldId": {
- "type": "string",
- "description": "Custom field id.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies this object as a custom field.",
- "default": "coordinate#customField"
- },
- "value": {
- "type": "string",
- "description": "Custom field value."
- }
- }
- },
- "CustomFieldDef": {
- "id": "CustomFieldDef",
- "type": "object",
- "description": "Custom field definition.",
- "properties": {
- "enabled": {
- "type": "boolean",
- "description": "Whether the field is enabled."
- },
- "enumitems": {
- "type": "array",
- "description": "List of enum items for this custom field. Populated only if the field type is enum. Enum fields appear as 'lists' in the Coordinate web and mobile UI.",
- "items": {
- "$ref": "EnumItemDef"
- }
- },
- "id": {
- "type": "string",
- "description": "Custom field id.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies this object as a custom field definition.",
- "default": "coordinate#customFieldDef"
- },
- "name": {
- "type": "string",
- "description": "Custom field name."
- },
- "requiredForCheckout": {
- "type": "boolean",
- "description": "Whether the field is required for checkout."
- },
- "type": {
- "type": "string",
- "description": "Custom field type."
- }
- }
- },
- "CustomFieldDefListResponse": {
- "id": "CustomFieldDefListResponse",
- "type": "object",
- "description": "Collection of custom field definitions for a team.",
- "properties": {
- "items": {
- "type": "array",
- "description": "Collection of custom field definitions in a team.",
- "items": {
- "$ref": "CustomFieldDef"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies this object as a collection of custom field definitions in a team.",
- "default": "coordinate#customFieldDefList"
- }
- }
- },
- "CustomFields": {
- "id": "CustomFields",
- "type": "object",
- "description": "Collection of custom fields.",
- "properties": {
- "customField": {
- "type": "array",
- "description": "Collection of custom fields.",
- "items": {
- "$ref": "CustomField"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies this object as a collection of custom fields.",
- "default": "coordinate#customFields"
- }
- }
- },
- "EnumItemDef": {
- "id": "EnumItemDef",
- "type": "object",
- "description": "Enum Item definition.",
- "properties": {
- "active": {
- "type": "boolean",
- "description": "Whether the enum item is active. Jobs may contain inactive enum values; however, setting an enum to an inactive value when creating or updating a job will result in a 500 error."
- },
- "kind": {
- "type": "string",
- "description": "Identifies this object as an enum item definition.",
- "default": "coordinate#enumItemDef"
- },
- "value": {
- "type": "string",
- "description": "Custom field value."
- }
- }
- },
- "Job": {
- "id": "Job",
- "type": "object",
- "description": "A job.",
- "properties": {
- "id": {
- "type": "string",
- "description": "Job id.",
- "format": "uint64"
- },
- "jobChange": {
- "type": "array",
- "description": "List of job changes since it was created. The first change corresponds to the state of the job when it was created.",
- "items": {
- "$ref": "JobChange"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies this object as a job.",
- "default": "coordinate#job"
- },
- "state": {
- "$ref": "JobState",
- "description": "Current job state."
- }
- }
- },
- "JobChange": {
- "id": "JobChange",
- "type": "object",
- "description": "Change to a job. For example assigning the job to a different worker.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies this object as a job change.",
- "default": "coordinate#jobChange"
- },
- "state": {
- "$ref": "JobState",
- "description": "Change applied to the job. Only the fields that were changed are set."
- },
- "timestamp": {
- "type": "string",
- "description": "Time at which this change was applied.",
- "format": "uint64"
- }
- }
- },
- "JobListResponse": {
- "id": "JobListResponse",
- "type": "object",
- "description": "Response from a List Jobs request.",
- "properties": {
- "items": {
- "type": "array",
- "description": "Jobs in the collection.",
- "items": {
- "$ref": "Job"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies this object as a list of jobs.",
- "default": "coordinate#jobList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "A token to provide to get the next page of results."
- }
- }
- },
- "JobState": {
- "id": "JobState",
- "type": "object",
- "description": "Current state of a job.",
- "properties": {
- "assignee": {
- "type": "string",
- "description": "Email address of the assignee, or the string \"DELETED_USER\" if the account is no longer available."
- },
- "customFields": {
- "$ref": "CustomFields",
- "description": "Custom fields."
- },
- "customerName": {
- "type": "string",
- "description": "Customer name."
- },
- "customerPhoneNumber": {
- "type": "string",
- "description": "Customer phone number."
- },
- "kind": {
- "type": "string",
- "description": "Identifies this object as a job state.",
- "default": "coordinate#jobState"
- },
- "location": {
- "$ref": "Location",
- "description": "Job location."
- },
- "note": {
- "type": "array",
- "description": "Note added to the job.",
- "items": {
- "type": "string"
- }
- },
- "progress": {
- "type": "string",
- "description": "Job progress."
- },
- "title": {
- "type": "string",
- "description": "Job title."
- }
- }
- },
- "Location": {
- "id": "Location",
- "type": "object",
- "description": "Location of a job.",
- "properties": {
- "addressLine": {
- "type": "array",
- "description": "Address.",
- "items": {
- "type": "string"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies this object as a location.",
- "default": "coordinate#location"
- },
- "lat": {
- "type": "number",
- "description": "Latitude.",
- "format": "double"
- },
- "lng": {
- "type": "number",
- "description": "Longitude.",
- "format": "double"
- }
- }
- },
- "LocationListResponse": {
- "id": "LocationListResponse",
- "type": "object",
- "description": "Response from a List Locations request.",
- "properties": {
- "items": {
- "type": "array",
- "description": "Locations in the collection.",
- "items": {
- "$ref": "LocationRecord"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies this object as a list of locations.",
- "default": "coordinate#locationList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "A token to provide to get the next page of results."
- },
- "tokenPagination": {
- "$ref": "TokenPagination",
- "description": "Pagination information for token pagination."
- }
- }
- },
- "LocationRecord": {
- "id": "LocationRecord",
- "type": "object",
- "description": "Recorded location of a worker.",
- "properties": {
- "collectionTime": {
- "type": "string",
- "description": "The collection time in milliseconds since the epoch.",
- "format": "int64"
- },
- "confidenceRadius": {
- "type": "number",
- "description": "The location accuracy in meters. This is the radius of a 95% confidence interval around the location measurement.",
- "format": "double"
- },
- "kind": {
- "type": "string",
- "description": "Identifies this object as a location.",
- "default": "coordinate#locationRecord"
- },
- "latitude": {
- "type": "number",
- "description": "Latitude.",
- "format": "double"
- },
- "longitude": {
- "type": "number",
- "description": "Longitude.",
- "format": "double"
- }
- }
- },
- "Schedule": {
- "id": "Schedule",
- "type": "object",
- "description": "Job schedule.",
- "properties": {
- "allDay": {
- "type": "boolean",
- "description": "Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true."
- },
- "duration": {
- "type": "string",
- "description": "Job duration in milliseconds.",
- "format": "uint64"
- },
- "endTime": {
- "type": "string",
- "description": "Scheduled end time in milliseconds since epoch.",
- "format": "uint64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies this object as a job schedule.",
- "default": "coordinate#schedule"
- },
- "startTime": {
- "type": "string",
- "description": "Scheduled start time in milliseconds since epoch.",
- "format": "uint64"
- }
- }
- },
- "Team": {
- "id": "Team",
- "type": "object",
- "description": "A Coordinate team.",
- "properties": {
- "id": {
- "type": "string",
- "description": "Team id, as found in a coordinate team url e.g. https://coordinate.google.com/f/xyz where \"xyz\" is the team id."
- },
- "kind": {
- "type": "string",
- "description": "Identifies this object as a team.",
- "default": "coordinate#team"
- },
- "name": {
- "type": "string",
- "description": "Team name"
- }
- }
- },
- "TeamListResponse": {
- "id": "TeamListResponse",
- "type": "object",
- "description": "Response from a List Teams request.",
- "properties": {
- "items": {
- "type": "array",
- "description": "Teams in the collection.",
- "items": {
- "$ref": "Team"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies this object as a list of teams.",
- "default": "coordinate#teamList"
- }
- }
- },
- "TokenPagination": {
- "id": "TokenPagination",
- "type": "object",
- "description": "Pagination information.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies this object as pagination information.",
- "default": "coordinate#tokenPagination"
- },
- "nextPageToken": {
- "type": "string",
- "description": "A token to provide to get the next page of results."
- },
- "previousPageToken": {
- "type": "string",
- "description": "A token to provide to get the previous page of results."
- }
- }
- },
- "Worker": {
- "id": "Worker",
- "type": "object",
- "description": "A worker in a Coordinate team.",
- "properties": {
- "id": {
- "type": "string",
- "description": "Worker email address. If a worker has been deleted from your team, the email address will appear as DELETED_USER."
- },
- "kind": {
- "type": "string",
- "description": "Identifies this object as a worker.",
- "default": "coordinate#worker"
- }
- }
- },
- "WorkerListResponse": {
- "id": "WorkerListResponse",
- "type": "object",
- "description": "Response from a List Workers request.",
- "properties": {
- "items": {
- "type": "array",
- "description": "Workers in the collection.",
- "items": {
- "$ref": "Worker"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies this object as a list of workers.",
- "default": "coordinate#workerList"
- }
- }
- }
- },
- "resources": {
- "customFieldDef": {
- "methods": {
- "list": {
- "id": "coordinate.customFieldDef.list",
- "path": "teams/{teamId}/custom_fields",
- "httpMethod": "GET",
- "description": "Retrieves a list of custom field definitions for a team.",
- "parameters": {
- "teamId": {
- "type": "string",
- "description": "Team ID",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "teamId"
- ],
- "response": {
- "$ref": "CustomFieldDefListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/coordinate",
- "https://www.googleapis.com/auth/coordinate.readonly"
- ]
- }
- }
- },
- "jobs": {
- "methods": {
- "get": {
- "id": "coordinate.jobs.get",
- "path": "teams/{teamId}/jobs/{jobId}",
- "httpMethod": "GET",
- "description": "Retrieves a job, including all the changes made to the job.",
- "parameters": {
- "jobId": {
- "type": "string",
- "description": "Job number",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "teamId": {
- "type": "string",
- "description": "Team ID",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "teamId",
- "jobId"
- ],
- "response": {
- "$ref": "Job"
- },
- "scopes": [
- "https://www.googleapis.com/auth/coordinate",
- "https://www.googleapis.com/auth/coordinate.readonly"
- ]
- },
- "insert": {
- "id": "coordinate.jobs.insert",
- "path": "teams/{teamId}/jobs",
- "httpMethod": "POST",
- "description": "Inserts a new job. Only the state field of the job should be set.",
- "parameters": {
- "address": {
- "type": "string",
- "description": "Job address as newline (Unix) separated string",
- "required": true,
- "location": "query"
- },
- "assignee": {
- "type": "string",
- "description": "Assignee email address, or empty string to unassign.",
- "location": "query"
- },
- "customField": {
- "type": "string",
- "description": "Sets the value of custom fields. To set a custom field, pass the field id (from /team/teamId/custom_fields), a URL escaped '=' character, and the desired value as a parameter. For example, customField=12%3DAlice. Repeat the parameter for each custom field. Note that '=' cannot appear in the parameter value. Specifying an invalid, or inactive enum field will result in an error 500.",
- "repeated": true,
- "location": "query"
- },
- "customerName": {
- "type": "string",
- "description": "Customer name",
- "location": "query"
- },
- "customerPhoneNumber": {
- "type": "string",
- "description": "Customer phone number",
- "location": "query"
- },
- "lat": {
- "type": "number",
- "description": "The latitude coordinate of this job's location.",
- "required": true,
- "format": "double",
- "location": "query"
- },
- "lng": {
- "type": "number",
- "description": "The longitude coordinate of this job's location.",
- "required": true,
- "format": "double",
- "location": "query"
- },
- "note": {
- "type": "string",
- "description": "Job note as newline (Unix) separated string",
- "location": "query"
- },
- "teamId": {
- "type": "string",
- "description": "Team ID",
- "required": true,
- "location": "path"
- },
- "title": {
- "type": "string",
- "description": "Job title",
- "required": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "teamId",
- "address",
- "lat",
- "lng",
- "title"
- ],
- "request": {
- "$ref": "Job"
- },
- "response": {
- "$ref": "Job"
- },
- "scopes": [
- "https://www.googleapis.com/auth/coordinate"
- ]
- },
- "list": {
- "id": "coordinate.jobs.list",
- "path": "teams/{teamId}/jobs",
- "httpMethod": "GET",
- "description": "Retrieves jobs created or modified since the given timestamp.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return in one page.",
- "format": "uint32",
- "location": "query"
- },
- "minModifiedTimestampMs": {
- "type": "string",
- "description": "Minimum time a job was modified in milliseconds since epoch.",
- "format": "uint64",
- "location": "query"
- },
- "omitJobChanges": {
- "type": "boolean",
- "description": "Whether to omit detail job history information.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Continuation token",
- "location": "query"
- },
- "teamId": {
- "type": "string",
- "description": "Team ID",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "teamId"
- ],
- "response": {
- "$ref": "JobListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/coordinate",
- "https://www.googleapis.com/auth/coordinate.readonly"
- ]
- },
- "patch": {
- "id": "coordinate.jobs.patch",
- "path": "teams/{teamId}/jobs/{jobId}",
- "httpMethod": "PATCH",
- "description": "Updates a job. Fields that are set in the job state will be updated. This method supports patch semantics.",
- "parameters": {
- "address": {
- "type": "string",
- "description": "Job address as newline (Unix) separated string",
- "location": "query"
- },
- "assignee": {
- "type": "string",
- "description": "Assignee email address, or empty string to unassign.",
- "location": "query"
- },
- "customField": {
- "type": "string",
- "description": "Sets the value of custom fields. To set a custom field, pass the field id (from /team/teamId/custom_fields), a URL escaped '=' character, and the desired value as a parameter. For example, customField=12%3DAlice. Repeat the parameter for each custom field. Note that '=' cannot appear in the parameter value. Specifying an invalid, or inactive enum field will result in an error 500.",
- "repeated": true,
- "location": "query"
- },
- "customerName": {
- "type": "string",
- "description": "Customer name",
- "location": "query"
- },
- "customerPhoneNumber": {
- "type": "string",
- "description": "Customer phone number",
- "location": "query"
- },
- "jobId": {
- "type": "string",
- "description": "Job number",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "lat": {
- "type": "number",
- "description": "The latitude coordinate of this job's location.",
- "format": "double",
- "location": "query"
- },
- "lng": {
- "type": "number",
- "description": "The longitude coordinate of this job's location.",
- "format": "double",
- "location": "query"
- },
- "note": {
- "type": "string",
- "description": "Job note as newline (Unix) separated string",
- "location": "query"
- },
- "progress": {
- "type": "string",
- "description": "Job progress",
- "enum": [
- "COMPLETED",
- "IN_PROGRESS",
- "NOT_ACCEPTED",
- "NOT_STARTED",
- "OBSOLETE"
- ],
- "enumDescriptions": [
- "Completed",
- "In progress",
- "Not accepted",
- "Not started",
- "Obsolete"
- ],
- "location": "query"
- },
- "teamId": {
- "type": "string",
- "description": "Team ID",
- "required": true,
- "location": "path"
- },
- "title": {
- "type": "string",
- "description": "Job title",
- "location": "query"
- }
- },
- "parameterOrder": [
- "teamId",
- "jobId"
- ],
- "request": {
- "$ref": "Job"
- },
- "response": {
- "$ref": "Job"
- },
- "scopes": [
- "https://www.googleapis.com/auth/coordinate"
- ]
- },
- "update": {
- "id": "coordinate.jobs.update",
- "path": "teams/{teamId}/jobs/{jobId}",
- "httpMethod": "PUT",
- "description": "Updates a job. Fields that are set in the job state will be updated.",
- "parameters": {
- "address": {
- "type": "string",
- "description": "Job address as newline (Unix) separated string",
- "location": "query"
- },
- "assignee": {
- "type": "string",
- "description": "Assignee email address, or empty string to unassign.",
- "location": "query"
- },
- "customField": {
- "type": "string",
- "description": "Sets the value of custom fields. To set a custom field, pass the field id (from /team/teamId/custom_fields), a URL escaped '=' character, and the desired value as a parameter. For example, customField=12%3DAlice. Repeat the parameter for each custom field. Note that '=' cannot appear in the parameter value. Specifying an invalid, or inactive enum field will result in an error 500.",
- "repeated": true,
- "location": "query"
- },
- "customerName": {
- "type": "string",
- "description": "Customer name",
- "location": "query"
- },
- "customerPhoneNumber": {
- "type": "string",
- "description": "Customer phone number",
- "location": "query"
- },
- "jobId": {
- "type": "string",
- "description": "Job number",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "lat": {
- "type": "number",
- "description": "The latitude coordinate of this job's location.",
- "format": "double",
- "location": "query"
- },
- "lng": {
- "type": "number",
- "description": "The longitude coordinate of this job's location.",
- "format": "double",
- "location": "query"
- },
- "note": {
- "type": "string",
- "description": "Job note as newline (Unix) separated string",
- "location": "query"
- },
- "progress": {
- "type": "string",
- "description": "Job progress",
- "enum": [
- "COMPLETED",
- "IN_PROGRESS",
- "NOT_ACCEPTED",
- "NOT_STARTED",
- "OBSOLETE"
- ],
- "enumDescriptions": [
- "Completed",
- "In progress",
- "Not accepted",
- "Not started",
- "Obsolete"
- ],
- "location": "query"
- },
- "teamId": {
- "type": "string",
- "description": "Team ID",
- "required": true,
- "location": "path"
- },
- "title": {
- "type": "string",
- "description": "Job title",
- "location": "query"
- }
- },
- "parameterOrder": [
- "teamId",
- "jobId"
- ],
- "request": {
- "$ref": "Job"
- },
- "response": {
- "$ref": "Job"
- },
- "scopes": [
- "https://www.googleapis.com/auth/coordinate"
- ]
- }
- }
- },
- "location": {
- "methods": {
- "list": {
- "id": "coordinate.location.list",
- "path": "teams/{teamId}/workers/{workerEmail}/locations",
- "httpMethod": "GET",
- "description": "Retrieves a list of locations for a worker.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return in one page.",
- "format": "uint32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Continuation token",
- "location": "query"
- },
- "startTimestampMs": {
- "type": "string",
- "description": "Start timestamp in milliseconds since the epoch.",
- "required": true,
- "format": "uint64",
- "location": "query"
- },
- "teamId": {
- "type": "string",
- "description": "Team ID",
- "required": true,
- "location": "path"
- },
- "workerEmail": {
- "type": "string",
- "description": "Worker email address.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "teamId",
- "workerEmail",
- "startTimestampMs"
- ],
- "response": {
- "$ref": "LocationListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/coordinate",
- "https://www.googleapis.com/auth/coordinate.readonly"
- ]
- }
- }
- },
- "schedule": {
- "methods": {
- "get": {
- "id": "coordinate.schedule.get",
- "path": "teams/{teamId}/jobs/{jobId}/schedule",
- "httpMethod": "GET",
- "description": "Retrieves the schedule for a job.",
- "parameters": {
- "jobId": {
- "type": "string",
- "description": "Job number",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "teamId": {
- "type": "string",
- "description": "Team ID",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "teamId",
- "jobId"
- ],
- "response": {
- "$ref": "Schedule"
- },
- "scopes": [
- "https://www.googleapis.com/auth/coordinate",
- "https://www.googleapis.com/auth/coordinate.readonly"
- ]
- },
- "patch": {
- "id": "coordinate.schedule.patch",
- "path": "teams/{teamId}/jobs/{jobId}/schedule",
- "httpMethod": "PATCH",
- "description": "Replaces the schedule of a job with the provided schedule. This method supports patch semantics.",
- "parameters": {
- "allDay": {
- "type": "boolean",
- "description": "Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.",
- "location": "query"
- },
- "duration": {
- "type": "string",
- "description": "Job duration in milliseconds.",
- "format": "uint64",
- "location": "query"
- },
- "endTime": {
- "type": "string",
- "description": "Scheduled end time in milliseconds since epoch.",
- "format": "uint64",
- "location": "query"
- },
- "jobId": {
- "type": "string",
- "description": "Job number",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "startTime": {
- "type": "string",
- "description": "Scheduled start time in milliseconds since epoch.",
- "format": "uint64",
- "location": "query"
- },
- "teamId": {
- "type": "string",
- "description": "Team ID",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "teamId",
- "jobId"
- ],
- "request": {
- "$ref": "Schedule"
- },
- "response": {
- "$ref": "Schedule"
- },
- "scopes": [
- "https://www.googleapis.com/auth/coordinate"
- ]
- },
- "update": {
- "id": "coordinate.schedule.update",
- "path": "teams/{teamId}/jobs/{jobId}/schedule",
- "httpMethod": "PUT",
- "description": "Replaces the schedule of a job with the provided schedule.",
- "parameters": {
- "allDay": {
- "type": "boolean",
- "description": "Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.",
- "location": "query"
- },
- "duration": {
- "type": "string",
- "description": "Job duration in milliseconds.",
- "format": "uint64",
- "location": "query"
- },
- "endTime": {
- "type": "string",
- "description": "Scheduled end time in milliseconds since epoch.",
- "format": "uint64",
- "location": "query"
- },
- "jobId": {
- "type": "string",
- "description": "Job number",
- "required": true,
- "format": "uint64",
- "location": "path"
- },
- "startTime": {
- "type": "string",
- "description": "Scheduled start time in milliseconds since epoch.",
- "format": "uint64",
- "location": "query"
- },
- "teamId": {
- "type": "string",
- "description": "Team ID",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "teamId",
- "jobId"
- ],
- "request": {
- "$ref": "Schedule"
- },
- "response": {
- "$ref": "Schedule"
- },
- "scopes": [
- "https://www.googleapis.com/auth/coordinate"
- ]
- }
- }
- },
- "team": {
- "methods": {
- "list": {
- "id": "coordinate.team.list",
- "path": "teams",
- "httpMethod": "GET",
- "description": "Retrieves a list of teams for a user.",
- "parameters": {
- "admin": {
- "type": "boolean",
- "description": "Whether to include teams for which the user has the Admin role.",
- "location": "query"
- },
- "dispatcher": {
- "type": "boolean",
- "description": "Whether to include teams for which the user has the Dispatcher role.",
- "location": "query"
- },
- "worker": {
- "type": "boolean",
- "description": "Whether to include teams for which the user has the Worker role.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "TeamListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/coordinate",
- "https://www.googleapis.com/auth/coordinate.readonly"
- ]
- }
- }
- },
- "worker": {
- "methods": {
- "list": {
- "id": "coordinate.worker.list",
- "path": "teams/{teamId}/workers",
- "httpMethod": "GET",
- "description": "Retrieves a list of workers in a team.",
- "parameters": {
- "teamId": {
- "type": "string",
- "description": "Team ID",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "teamId"
- ],
- "response": {
- "$ref": "WorkerListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/coordinate",
- "https://www.googleapis.com/auth/coordinate.readonly"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/coordinate/v1/coordinate-gen.go b/vendor/google.golang.org/api/coordinate/v1/coordinate-gen.go
deleted file mode 100644
index f86c8335..00000000
--- a/vendor/google.golang.org/api/coordinate/v1/coordinate-gen.go
+++ /dev/null
@@ -1,3024 +0,0 @@
-// Package coordinate provides access to the Google Maps Coordinate API.
-//
-// See https://developers.google.com/coordinate/
-//
-// Usage example:
-//
-// import "google.golang.org/api/coordinate/v1"
-// ...
-// coordinateService, err := coordinate.New(oauthHttpClient)
-package coordinate // import "google.golang.org/api/coordinate/v1"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "coordinate:v1"
-const apiName = "coordinate"
-const apiVersion = "v1"
-const basePath = "https://www.googleapis.com/coordinate/v1/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your Google Maps Coordinate jobs
- CoordinateScope = "https://www.googleapis.com/auth/coordinate"
-
- // View your Google Coordinate jobs
- CoordinateReadonlyScope = "https://www.googleapis.com/auth/coordinate.readonly"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.CustomFieldDef = NewCustomFieldDefService(s)
- s.Jobs = NewJobsService(s)
- s.Location = NewLocationService(s)
- s.Schedule = NewScheduleService(s)
- s.Team = NewTeamService(s)
- s.Worker = NewWorkerService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- CustomFieldDef *CustomFieldDefService
-
- Jobs *JobsService
-
- Location *LocationService
-
- Schedule *ScheduleService
-
- Team *TeamService
-
- Worker *WorkerService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewCustomFieldDefService(s *Service) *CustomFieldDefService {
- rs := &CustomFieldDefService{s: s}
- return rs
-}
-
-type CustomFieldDefService struct {
- s *Service
-}
-
-func NewJobsService(s *Service) *JobsService {
- rs := &JobsService{s: s}
- return rs
-}
-
-type JobsService struct {
- s *Service
-}
-
-func NewLocationService(s *Service) *LocationService {
- rs := &LocationService{s: s}
- return rs
-}
-
-type LocationService struct {
- s *Service
-}
-
-func NewScheduleService(s *Service) *ScheduleService {
- rs := &ScheduleService{s: s}
- return rs
-}
-
-type ScheduleService struct {
- s *Service
-}
-
-func NewTeamService(s *Service) *TeamService {
- rs := &TeamService{s: s}
- return rs
-}
-
-type TeamService struct {
- s *Service
-}
-
-func NewWorkerService(s *Service) *WorkerService {
- rs := &WorkerService{s: s}
- return rs
-}
-
-type WorkerService struct {
- s *Service
-}
-
-// CustomField: Custom field.
-type CustomField struct {
- // CustomFieldId: Custom field id.
- CustomFieldId int64 `json:"customFieldId,omitempty,string"`
-
- // Kind: Identifies this object as a custom field.
- Kind string `json:"kind,omitempty"`
-
- // Value: Custom field value.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CustomFieldId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomField) MarshalJSON() ([]byte, error) {
- type noMethod CustomField
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CustomFieldDef: Custom field definition.
-type CustomFieldDef struct {
- // Enabled: Whether the field is enabled.
- Enabled bool `json:"enabled,omitempty"`
-
- // Enumitems: List of enum items for this custom field. Populated only
- // if the field type is enum. Enum fields appear as 'lists' in the
- // Coordinate web and mobile UI.
- Enumitems []*EnumItemDef `json:"enumitems,omitempty"`
-
- // Id: Custom field id.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies this object as a custom field definition.
- Kind string `json:"kind,omitempty"`
-
- // Name: Custom field name.
- Name string `json:"name,omitempty"`
-
- // RequiredForCheckout: Whether the field is required for checkout.
- RequiredForCheckout bool `json:"requiredForCheckout,omitempty"`
-
- // Type: Custom field type.
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Enabled") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomFieldDef) MarshalJSON() ([]byte, error) {
- type noMethod CustomFieldDef
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CustomFieldDefListResponse: Collection of custom field definitions
-// for a team.
-type CustomFieldDefListResponse struct {
- // Items: Collection of custom field definitions in a team.
- Items []*CustomFieldDef `json:"items,omitempty"`
-
- // Kind: Identifies this object as a collection of custom field
- // definitions in a team.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomFieldDefListResponse) MarshalJSON() ([]byte, error) {
- type noMethod CustomFieldDefListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CustomFields: Collection of custom fields.
-type CustomFields struct {
- // CustomField: Collection of custom fields.
- CustomField []*CustomField `json:"customField,omitempty"`
-
- // Kind: Identifies this object as a collection of custom fields.
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CustomField") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomFields) MarshalJSON() ([]byte, error) {
- type noMethod CustomFields
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// EnumItemDef: Enum Item definition.
-type EnumItemDef struct {
- // Active: Whether the enum item is active. Jobs may contain inactive
- // enum values; however, setting an enum to an inactive value when
- // creating or updating a job will result in a 500 error.
- Active bool `json:"active,omitempty"`
-
- // Kind: Identifies this object as an enum item definition.
- Kind string `json:"kind,omitempty"`
-
- // Value: Custom field value.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Active") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EnumItemDef) MarshalJSON() ([]byte, error) {
- type noMethod EnumItemDef
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Job: A job.
-type Job struct {
- // Id: Job id.
- Id uint64 `json:"id,omitempty,string"`
-
- // JobChange: List of job changes since it was created. The first change
- // corresponds to the state of the job when it was created.
- JobChange []*JobChange `json:"jobChange,omitempty"`
-
- // Kind: Identifies this object as a job.
- Kind string `json:"kind,omitempty"`
-
- // State: Current job state.
- State *JobState `json:"state,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Job) MarshalJSON() ([]byte, error) {
- type noMethod Job
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// JobChange: Change to a job. For example assigning the job to a
-// different worker.
-type JobChange struct {
- // Kind: Identifies this object as a job change.
- Kind string `json:"kind,omitempty"`
-
- // State: Change applied to the job. Only the fields that were changed
- // are set.
- State *JobState `json:"state,omitempty"`
-
- // Timestamp: Time at which this change was applied.
- Timestamp uint64 `json:"timestamp,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *JobChange) MarshalJSON() ([]byte, error) {
- type noMethod JobChange
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// JobListResponse: Response from a List Jobs request.
-type JobListResponse struct {
- // Items: Jobs in the collection.
- Items []*Job `json:"items,omitempty"`
-
- // Kind: Identifies this object as a list of jobs.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: A token to provide to get the next page of results.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *JobListResponse) MarshalJSON() ([]byte, error) {
- type noMethod JobListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// JobState: Current state of a job.
-type JobState struct {
- // Assignee: Email address of the assignee, or the string "DELETED_USER"
- // if the account is no longer available.
- Assignee string `json:"assignee,omitempty"`
-
- // CustomFields: Custom fields.
- CustomFields *CustomFields `json:"customFields,omitempty"`
-
- // CustomerName: Customer name.
- CustomerName string `json:"customerName,omitempty"`
-
- // CustomerPhoneNumber: Customer phone number.
- CustomerPhoneNumber string `json:"customerPhoneNumber,omitempty"`
-
- // Kind: Identifies this object as a job state.
- Kind string `json:"kind,omitempty"`
-
- // Location: Job location.
- Location *Location `json:"location,omitempty"`
-
- // Note: Note added to the job.
- Note []string `json:"note,omitempty"`
-
- // Progress: Job progress.
- Progress string `json:"progress,omitempty"`
-
- // Title: Job title.
- Title string `json:"title,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Assignee") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *JobState) MarshalJSON() ([]byte, error) {
- type noMethod JobState
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Location: Location of a job.
-type Location struct {
- // AddressLine: Address.
- AddressLine []string `json:"addressLine,omitempty"`
-
- // Kind: Identifies this object as a location.
- Kind string `json:"kind,omitempty"`
-
- // Lat: Latitude.
- Lat float64 `json:"lat,omitempty"`
-
- // Lng: Longitude.
- Lng float64 `json:"lng,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AddressLine") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Location) MarshalJSON() ([]byte, error) {
- type noMethod Location
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LocationListResponse: Response from a List Locations request.
-type LocationListResponse struct {
- // Items: Locations in the collection.
- Items []*LocationRecord `json:"items,omitempty"`
-
- // Kind: Identifies this object as a list of locations.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: A token to provide to get the next page of results.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // TokenPagination: Pagination information for token pagination.
- TokenPagination *TokenPagination `json:"tokenPagination,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LocationListResponse) MarshalJSON() ([]byte, error) {
- type noMethod LocationListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LocationRecord: Recorded location of a worker.
-type LocationRecord struct {
- // CollectionTime: The collection time in milliseconds since the epoch.
- CollectionTime int64 `json:"collectionTime,omitempty,string"`
-
- // ConfidenceRadius: The location accuracy in meters. This is the radius
- // of a 95% confidence interval around the location measurement.
- ConfidenceRadius float64 `json:"confidenceRadius,omitempty"`
-
- // Kind: Identifies this object as a location.
- Kind string `json:"kind,omitempty"`
-
- // Latitude: Latitude.
- Latitude float64 `json:"latitude,omitempty"`
-
- // Longitude: Longitude.
- Longitude float64 `json:"longitude,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CollectionTime") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LocationRecord) MarshalJSON() ([]byte, error) {
- type noMethod LocationRecord
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Schedule: Job schedule.
-type Schedule struct {
- // AllDay: Whether the job is scheduled for the whole day. Time of day
- // in start/end times is ignored if this is true.
- AllDay bool `json:"allDay,omitempty"`
-
- // Duration: Job duration in milliseconds.
- Duration uint64 `json:"duration,omitempty,string"`
-
- // EndTime: Scheduled end time in milliseconds since epoch.
- EndTime uint64 `json:"endTime,omitempty,string"`
-
- // Kind: Identifies this object as a job schedule.
- Kind string `json:"kind,omitempty"`
-
- // StartTime: Scheduled start time in milliseconds since epoch.
- StartTime uint64 `json:"startTime,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AllDay") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Schedule) MarshalJSON() ([]byte, error) {
- type noMethod Schedule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Team: A Coordinate team.
-type Team struct {
- // Id: Team id, as found in a coordinate team url e.g.
- // https://coordinate.google.com/f/xyz where "xyz" is the team id.
- Id string `json:"id,omitempty"`
-
- // Kind: Identifies this object as a team.
- Kind string `json:"kind,omitempty"`
-
- // Name: Team name
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Team) MarshalJSON() ([]byte, error) {
- type noMethod Team
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TeamListResponse: Response from a List Teams request.
-type TeamListResponse struct {
- // Items: Teams in the collection.
- Items []*Team `json:"items,omitempty"`
-
- // Kind: Identifies this object as a list of teams.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TeamListResponse) MarshalJSON() ([]byte, error) {
- type noMethod TeamListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TokenPagination: Pagination information.
-type TokenPagination struct {
- // Kind: Identifies this object as pagination information.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: A token to provide to get the next page of results.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // PreviousPageToken: A token to provide to get the previous page of
- // results.
- PreviousPageToken string `json:"previousPageToken,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TokenPagination) MarshalJSON() ([]byte, error) {
- type noMethod TokenPagination
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Worker: A worker in a Coordinate team.
-type Worker struct {
- // Id: Worker email address. If a worker has been deleted from your
- // team, the email address will appear as DELETED_USER.
- Id string `json:"id,omitempty"`
-
- // Kind: Identifies this object as a worker.
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Worker) MarshalJSON() ([]byte, error) {
- type noMethod Worker
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// WorkerListResponse: Response from a List Workers request.
-type WorkerListResponse struct {
- // Items: Workers in the collection.
- Items []*Worker `json:"items,omitempty"`
-
- // Kind: Identifies this object as a list of workers.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Items") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *WorkerListResponse) MarshalJSON() ([]byte, error) {
- type noMethod WorkerListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "coordinate.customFieldDef.list":
-
-type CustomFieldDefListCall struct {
- s *Service
- teamId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of custom field definitions for a team.
-func (r *CustomFieldDefService) List(teamId string) *CustomFieldDefListCall {
- c := &CustomFieldDefListCall{s: r.s, opt_: make(map[string]interface{})}
- c.teamId = teamId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CustomFieldDefListCall) Fields(s ...googleapi.Field) *CustomFieldDefListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CustomFieldDefListCall) IfNoneMatch(entityTag string) *CustomFieldDefListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CustomFieldDefListCall) Context(ctx context.Context) *CustomFieldDefListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CustomFieldDefListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "teams/{teamId}/custom_fields")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "teamId": c.teamId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "coordinate.customFieldDef.list" call.
-// Exactly one of *CustomFieldDefListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *CustomFieldDefListResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CustomFieldDefListCall) Do() (*CustomFieldDefListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CustomFieldDefListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of custom field definitions for a team.",
- // "httpMethod": "GET",
- // "id": "coordinate.customFieldDef.list",
- // "parameterOrder": [
- // "teamId"
- // ],
- // "parameters": {
- // "teamId": {
- // "description": "Team ID",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "teams/{teamId}/custom_fields",
- // "response": {
- // "$ref": "CustomFieldDefListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/coordinate",
- // "https://www.googleapis.com/auth/coordinate.readonly"
- // ]
- // }
-
-}
-
-// method id "coordinate.jobs.get":
-
-type JobsGetCall struct {
- s *Service
- teamId string
- jobId uint64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves a job, including all the changes made to the job.
-func (r *JobsService) Get(teamId string, jobId uint64) *JobsGetCall {
- c := &JobsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.teamId = teamId
- c.jobId = jobId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *JobsGetCall) Fields(s ...googleapi.Field) *JobsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *JobsGetCall) IfNoneMatch(entityTag string) *JobsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *JobsGetCall) Context(ctx context.Context) *JobsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *JobsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "teams/{teamId}/jobs/{jobId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "teamId": c.teamId,
- "jobId": strconv.FormatUint(c.jobId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "coordinate.jobs.get" call.
-// Exactly one of *Job or error will be non-nil. Any non-2xx status code
-// is an error. Response headers are in either
-// *Job.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *JobsGetCall) Do() (*Job, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Job{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a job, including all the changes made to the job.",
- // "httpMethod": "GET",
- // "id": "coordinate.jobs.get",
- // "parameterOrder": [
- // "teamId",
- // "jobId"
- // ],
- // "parameters": {
- // "jobId": {
- // "description": "Job number",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "teamId": {
- // "description": "Team ID",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "teams/{teamId}/jobs/{jobId}",
- // "response": {
- // "$ref": "Job"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/coordinate",
- // "https://www.googleapis.com/auth/coordinate.readonly"
- // ]
- // }
-
-}
-
-// method id "coordinate.jobs.insert":
-
-type JobsInsertCall struct {
- s *Service
- teamId string
- address string
- lat float64
- lng float64
- title string
- job *Job
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new job. Only the state field of the job should be
-// set.
-func (r *JobsService) Insert(teamId string, address string, lat float64, lng float64, title string, job *Job) *JobsInsertCall {
- c := &JobsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.teamId = teamId
- c.address = address
- c.lat = lat
- c.lng = lng
- c.title = title
- c.job = job
- return c
-}
-
-// Assignee sets the optional parameter "assignee": Assignee email
-// address, or empty string to unassign.
-func (c *JobsInsertCall) Assignee(assignee string) *JobsInsertCall {
- c.opt_["assignee"] = assignee
- return c
-}
-
-// CustomField sets the optional parameter "customField": Sets the value
-// of custom fields. To set a custom field, pass the field id (from
-// /team/teamId/custom_fields), a URL escaped '=' character, and the
-// desired value as a parameter. For example, customField=12%3DAlice.
-// Repeat the parameter for each custom field. Note that '=' cannot
-// appear in the parameter value. Specifying an invalid, or inactive
-// enum field will result in an error 500.
-func (c *JobsInsertCall) CustomField(customField string) *JobsInsertCall {
- c.opt_["customField"] = customField
- return c
-}
-
-// CustomerName sets the optional parameter "customerName": Customer
-// name
-func (c *JobsInsertCall) CustomerName(customerName string) *JobsInsertCall {
- c.opt_["customerName"] = customerName
- return c
-}
-
-// CustomerPhoneNumber sets the optional parameter
-// "customerPhoneNumber": Customer phone number
-func (c *JobsInsertCall) CustomerPhoneNumber(customerPhoneNumber string) *JobsInsertCall {
- c.opt_["customerPhoneNumber"] = customerPhoneNumber
- return c
-}
-
-// Note sets the optional parameter "note": Job note as newline (Unix)
-// separated string
-func (c *JobsInsertCall) Note(note string) *JobsInsertCall {
- c.opt_["note"] = note
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *JobsInsertCall) Fields(s ...googleapi.Field) *JobsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *JobsInsertCall) Context(ctx context.Context) *JobsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *JobsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.job)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("address", fmt.Sprintf("%v", c.address))
- params.Set("lat", fmt.Sprintf("%v", c.lat))
- params.Set("lng", fmt.Sprintf("%v", c.lng))
- params.Set("title", fmt.Sprintf("%v", c.title))
- if v, ok := c.opt_["assignee"]; ok {
- params.Set("assignee", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["customField"]; ok {
- params.Set("customField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["customerName"]; ok {
- params.Set("customerName", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["customerPhoneNumber"]; ok {
- params.Set("customerPhoneNumber", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["note"]; ok {
- params.Set("note", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "teams/{teamId}/jobs")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "teamId": c.teamId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "coordinate.jobs.insert" call.
-// Exactly one of *Job or error will be non-nil. Any non-2xx status code
-// is an error. Response headers are in either
-// *Job.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *JobsInsertCall) Do() (*Job, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Job{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new job. Only the state field of the job should be set.",
- // "httpMethod": "POST",
- // "id": "coordinate.jobs.insert",
- // "parameterOrder": [
- // "teamId",
- // "address",
- // "lat",
- // "lng",
- // "title"
- // ],
- // "parameters": {
- // "address": {
- // "description": "Job address as newline (Unix) separated string",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "assignee": {
- // "description": "Assignee email address, or empty string to unassign.",
- // "location": "query",
- // "type": "string"
- // },
- // "customField": {
- // "description": "Sets the value of custom fields. To set a custom field, pass the field id (from /team/teamId/custom_fields), a URL escaped '=' character, and the desired value as a parameter. For example, customField=12%3DAlice. Repeat the parameter for each custom field. Note that '=' cannot appear in the parameter value. Specifying an invalid, or inactive enum field will result in an error 500.",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "customerName": {
- // "description": "Customer name",
- // "location": "query",
- // "type": "string"
- // },
- // "customerPhoneNumber": {
- // "description": "Customer phone number",
- // "location": "query",
- // "type": "string"
- // },
- // "lat": {
- // "description": "The latitude coordinate of this job's location.",
- // "format": "double",
- // "location": "query",
- // "required": true,
- // "type": "number"
- // },
- // "lng": {
- // "description": "The longitude coordinate of this job's location.",
- // "format": "double",
- // "location": "query",
- // "required": true,
- // "type": "number"
- // },
- // "note": {
- // "description": "Job note as newline (Unix) separated string",
- // "location": "query",
- // "type": "string"
- // },
- // "teamId": {
- // "description": "Team ID",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "title": {
- // "description": "Job title",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "teams/{teamId}/jobs",
- // "request": {
- // "$ref": "Job"
- // },
- // "response": {
- // "$ref": "Job"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/coordinate"
- // ]
- // }
-
-}
-
-// method id "coordinate.jobs.list":
-
-type JobsListCall struct {
- s *Service
- teamId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves jobs created or modified since the given timestamp.
-func (r *JobsService) List(teamId string) *JobsListCall {
- c := &JobsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.teamId = teamId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return in one page.
-func (c *JobsListCall) MaxResults(maxResults int64) *JobsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// MinModifiedTimestampMs sets the optional parameter
-// "minModifiedTimestampMs": Minimum time a job was modified in
-// milliseconds since epoch.
-func (c *JobsListCall) MinModifiedTimestampMs(minModifiedTimestampMs uint64) *JobsListCall {
- c.opt_["minModifiedTimestampMs"] = minModifiedTimestampMs
- return c
-}
-
-// OmitJobChanges sets the optional parameter "omitJobChanges": Whether
-// to omit detail job history information.
-func (c *JobsListCall) OmitJobChanges(omitJobChanges bool) *JobsListCall {
- c.opt_["omitJobChanges"] = omitJobChanges
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Continuation token
-func (c *JobsListCall) PageToken(pageToken string) *JobsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *JobsListCall) Fields(s ...googleapi.Field) *JobsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *JobsListCall) IfNoneMatch(entityTag string) *JobsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *JobsListCall) Context(ctx context.Context) *JobsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *JobsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["minModifiedTimestampMs"]; ok {
- params.Set("minModifiedTimestampMs", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["omitJobChanges"]; ok {
- params.Set("omitJobChanges", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "teams/{teamId}/jobs")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "teamId": c.teamId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "coordinate.jobs.list" call.
-// Exactly one of *JobListResponse or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *JobListResponse.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *JobsListCall) Do() (*JobListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &JobListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves jobs created or modified since the given timestamp.",
- // "httpMethod": "GET",
- // "id": "coordinate.jobs.list",
- // "parameterOrder": [
- // "teamId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of results to return in one page.",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "minModifiedTimestampMs": {
- // "description": "Minimum time a job was modified in milliseconds since epoch.",
- // "format": "uint64",
- // "location": "query",
- // "type": "string"
- // },
- // "omitJobChanges": {
- // "description": "Whether to omit detail job history information.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "pageToken": {
- // "description": "Continuation token",
- // "location": "query",
- // "type": "string"
- // },
- // "teamId": {
- // "description": "Team ID",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "teams/{teamId}/jobs",
- // "response": {
- // "$ref": "JobListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/coordinate",
- // "https://www.googleapis.com/auth/coordinate.readonly"
- // ]
- // }
-
-}
-
-// method id "coordinate.jobs.patch":
-
-type JobsPatchCall struct {
- s *Service
- teamId string
- jobId uint64
- job *Job
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates a job. Fields that are set in the job state will be
-// updated. This method supports patch semantics.
-func (r *JobsService) Patch(teamId string, jobId uint64, job *Job) *JobsPatchCall {
- c := &JobsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.teamId = teamId
- c.jobId = jobId
- c.job = job
- return c
-}
-
-// Address sets the optional parameter "address": Job address as newline
-// (Unix) separated string
-func (c *JobsPatchCall) Address(address string) *JobsPatchCall {
- c.opt_["address"] = address
- return c
-}
-
-// Assignee sets the optional parameter "assignee": Assignee email
-// address, or empty string to unassign.
-func (c *JobsPatchCall) Assignee(assignee string) *JobsPatchCall {
- c.opt_["assignee"] = assignee
- return c
-}
-
-// CustomField sets the optional parameter "customField": Sets the value
-// of custom fields. To set a custom field, pass the field id (from
-// /team/teamId/custom_fields), a URL escaped '=' character, and the
-// desired value as a parameter. For example, customField=12%3DAlice.
-// Repeat the parameter for each custom field. Note that '=' cannot
-// appear in the parameter value. Specifying an invalid, or inactive
-// enum field will result in an error 500.
-func (c *JobsPatchCall) CustomField(customField string) *JobsPatchCall {
- c.opt_["customField"] = customField
- return c
-}
-
-// CustomerName sets the optional parameter "customerName": Customer
-// name
-func (c *JobsPatchCall) CustomerName(customerName string) *JobsPatchCall {
- c.opt_["customerName"] = customerName
- return c
-}
-
-// CustomerPhoneNumber sets the optional parameter
-// "customerPhoneNumber": Customer phone number
-func (c *JobsPatchCall) CustomerPhoneNumber(customerPhoneNumber string) *JobsPatchCall {
- c.opt_["customerPhoneNumber"] = customerPhoneNumber
- return c
-}
-
-// Lat sets the optional parameter "lat": The latitude coordinate of
-// this job's location.
-func (c *JobsPatchCall) Lat(lat float64) *JobsPatchCall {
- c.opt_["lat"] = lat
- return c
-}
-
-// Lng sets the optional parameter "lng": The longitude coordinate of
-// this job's location.
-func (c *JobsPatchCall) Lng(lng float64) *JobsPatchCall {
- c.opt_["lng"] = lng
- return c
-}
-
-// Note sets the optional parameter "note": Job note as newline (Unix)
-// separated string
-func (c *JobsPatchCall) Note(note string) *JobsPatchCall {
- c.opt_["note"] = note
- return c
-}
-
-// Progress sets the optional parameter "progress": Job progress
-//
-// Possible values:
-// "COMPLETED" - Completed
-// "IN_PROGRESS" - In progress
-// "NOT_ACCEPTED" - Not accepted
-// "NOT_STARTED" - Not started
-// "OBSOLETE" - Obsolete
-func (c *JobsPatchCall) Progress(progress string) *JobsPatchCall {
- c.opt_["progress"] = progress
- return c
-}
-
-// Title sets the optional parameter "title": Job title
-func (c *JobsPatchCall) Title(title string) *JobsPatchCall {
- c.opt_["title"] = title
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *JobsPatchCall) Fields(s ...googleapi.Field) *JobsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *JobsPatchCall) Context(ctx context.Context) *JobsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *JobsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.job)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["address"]; ok {
- params.Set("address", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["assignee"]; ok {
- params.Set("assignee", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["customField"]; ok {
- params.Set("customField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["customerName"]; ok {
- params.Set("customerName", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["customerPhoneNumber"]; ok {
- params.Set("customerPhoneNumber", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["lat"]; ok {
- params.Set("lat", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["lng"]; ok {
- params.Set("lng", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["note"]; ok {
- params.Set("note", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["progress"]; ok {
- params.Set("progress", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["title"]; ok {
- params.Set("title", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "teams/{teamId}/jobs/{jobId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "teamId": c.teamId,
- "jobId": strconv.FormatUint(c.jobId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "coordinate.jobs.patch" call.
-// Exactly one of *Job or error will be non-nil. Any non-2xx status code
-// is an error. Response headers are in either
-// *Job.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *JobsPatchCall) Do() (*Job, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Job{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a job. Fields that are set in the job state will be updated. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "coordinate.jobs.patch",
- // "parameterOrder": [
- // "teamId",
- // "jobId"
- // ],
- // "parameters": {
- // "address": {
- // "description": "Job address as newline (Unix) separated string",
- // "location": "query",
- // "type": "string"
- // },
- // "assignee": {
- // "description": "Assignee email address, or empty string to unassign.",
- // "location": "query",
- // "type": "string"
- // },
- // "customField": {
- // "description": "Sets the value of custom fields. To set a custom field, pass the field id (from /team/teamId/custom_fields), a URL escaped '=' character, and the desired value as a parameter. For example, customField=12%3DAlice. Repeat the parameter for each custom field. Note that '=' cannot appear in the parameter value. Specifying an invalid, or inactive enum field will result in an error 500.",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "customerName": {
- // "description": "Customer name",
- // "location": "query",
- // "type": "string"
- // },
- // "customerPhoneNumber": {
- // "description": "Customer phone number",
- // "location": "query",
- // "type": "string"
- // },
- // "jobId": {
- // "description": "Job number",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "lat": {
- // "description": "The latitude coordinate of this job's location.",
- // "format": "double",
- // "location": "query",
- // "type": "number"
- // },
- // "lng": {
- // "description": "The longitude coordinate of this job's location.",
- // "format": "double",
- // "location": "query",
- // "type": "number"
- // },
- // "note": {
- // "description": "Job note as newline (Unix) separated string",
- // "location": "query",
- // "type": "string"
- // },
- // "progress": {
- // "description": "Job progress",
- // "enum": [
- // "COMPLETED",
- // "IN_PROGRESS",
- // "NOT_ACCEPTED",
- // "NOT_STARTED",
- // "OBSOLETE"
- // ],
- // "enumDescriptions": [
- // "Completed",
- // "In progress",
- // "Not accepted",
- // "Not started",
- // "Obsolete"
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "teamId": {
- // "description": "Team ID",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "title": {
- // "description": "Job title",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "teams/{teamId}/jobs/{jobId}",
- // "request": {
- // "$ref": "Job"
- // },
- // "response": {
- // "$ref": "Job"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/coordinate"
- // ]
- // }
-
-}
-
-// method id "coordinate.jobs.update":
-
-type JobsUpdateCall struct {
- s *Service
- teamId string
- jobId uint64
- job *Job
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates a job. Fields that are set in the job state will be
-// updated.
-func (r *JobsService) Update(teamId string, jobId uint64, job *Job) *JobsUpdateCall {
- c := &JobsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.teamId = teamId
- c.jobId = jobId
- c.job = job
- return c
-}
-
-// Address sets the optional parameter "address": Job address as newline
-// (Unix) separated string
-func (c *JobsUpdateCall) Address(address string) *JobsUpdateCall {
- c.opt_["address"] = address
- return c
-}
-
-// Assignee sets the optional parameter "assignee": Assignee email
-// address, or empty string to unassign.
-func (c *JobsUpdateCall) Assignee(assignee string) *JobsUpdateCall {
- c.opt_["assignee"] = assignee
- return c
-}
-
-// CustomField sets the optional parameter "customField": Sets the value
-// of custom fields. To set a custom field, pass the field id (from
-// /team/teamId/custom_fields), a URL escaped '=' character, and the
-// desired value as a parameter. For example, customField=12%3DAlice.
-// Repeat the parameter for each custom field. Note that '=' cannot
-// appear in the parameter value. Specifying an invalid, or inactive
-// enum field will result in an error 500.
-func (c *JobsUpdateCall) CustomField(customField string) *JobsUpdateCall {
- c.opt_["customField"] = customField
- return c
-}
-
-// CustomerName sets the optional parameter "customerName": Customer
-// name
-func (c *JobsUpdateCall) CustomerName(customerName string) *JobsUpdateCall {
- c.opt_["customerName"] = customerName
- return c
-}
-
-// CustomerPhoneNumber sets the optional parameter
-// "customerPhoneNumber": Customer phone number
-func (c *JobsUpdateCall) CustomerPhoneNumber(customerPhoneNumber string) *JobsUpdateCall {
- c.opt_["customerPhoneNumber"] = customerPhoneNumber
- return c
-}
-
-// Lat sets the optional parameter "lat": The latitude coordinate of
-// this job's location.
-func (c *JobsUpdateCall) Lat(lat float64) *JobsUpdateCall {
- c.opt_["lat"] = lat
- return c
-}
-
-// Lng sets the optional parameter "lng": The longitude coordinate of
-// this job's location.
-func (c *JobsUpdateCall) Lng(lng float64) *JobsUpdateCall {
- c.opt_["lng"] = lng
- return c
-}
-
-// Note sets the optional parameter "note": Job note as newline (Unix)
-// separated string
-func (c *JobsUpdateCall) Note(note string) *JobsUpdateCall {
- c.opt_["note"] = note
- return c
-}
-
-// Progress sets the optional parameter "progress": Job progress
-//
-// Possible values:
-// "COMPLETED" - Completed
-// "IN_PROGRESS" - In progress
-// "NOT_ACCEPTED" - Not accepted
-// "NOT_STARTED" - Not started
-// "OBSOLETE" - Obsolete
-func (c *JobsUpdateCall) Progress(progress string) *JobsUpdateCall {
- c.opt_["progress"] = progress
- return c
-}
-
-// Title sets the optional parameter "title": Job title
-func (c *JobsUpdateCall) Title(title string) *JobsUpdateCall {
- c.opt_["title"] = title
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *JobsUpdateCall) Fields(s ...googleapi.Field) *JobsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *JobsUpdateCall) Context(ctx context.Context) *JobsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *JobsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.job)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["address"]; ok {
- params.Set("address", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["assignee"]; ok {
- params.Set("assignee", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["customField"]; ok {
- params.Set("customField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["customerName"]; ok {
- params.Set("customerName", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["customerPhoneNumber"]; ok {
- params.Set("customerPhoneNumber", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["lat"]; ok {
- params.Set("lat", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["lng"]; ok {
- params.Set("lng", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["note"]; ok {
- params.Set("note", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["progress"]; ok {
- params.Set("progress", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["title"]; ok {
- params.Set("title", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "teams/{teamId}/jobs/{jobId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "teamId": c.teamId,
- "jobId": strconv.FormatUint(c.jobId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "coordinate.jobs.update" call.
-// Exactly one of *Job or error will be non-nil. Any non-2xx status code
-// is an error. Response headers are in either
-// *Job.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *JobsUpdateCall) Do() (*Job, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Job{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a job. Fields that are set in the job state will be updated.",
- // "httpMethod": "PUT",
- // "id": "coordinate.jobs.update",
- // "parameterOrder": [
- // "teamId",
- // "jobId"
- // ],
- // "parameters": {
- // "address": {
- // "description": "Job address as newline (Unix) separated string",
- // "location": "query",
- // "type": "string"
- // },
- // "assignee": {
- // "description": "Assignee email address, or empty string to unassign.",
- // "location": "query",
- // "type": "string"
- // },
- // "customField": {
- // "description": "Sets the value of custom fields. To set a custom field, pass the field id (from /team/teamId/custom_fields), a URL escaped '=' character, and the desired value as a parameter. For example, customField=12%3DAlice. Repeat the parameter for each custom field. Note that '=' cannot appear in the parameter value. Specifying an invalid, or inactive enum field will result in an error 500.",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "customerName": {
- // "description": "Customer name",
- // "location": "query",
- // "type": "string"
- // },
- // "customerPhoneNumber": {
- // "description": "Customer phone number",
- // "location": "query",
- // "type": "string"
- // },
- // "jobId": {
- // "description": "Job number",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "lat": {
- // "description": "The latitude coordinate of this job's location.",
- // "format": "double",
- // "location": "query",
- // "type": "number"
- // },
- // "lng": {
- // "description": "The longitude coordinate of this job's location.",
- // "format": "double",
- // "location": "query",
- // "type": "number"
- // },
- // "note": {
- // "description": "Job note as newline (Unix) separated string",
- // "location": "query",
- // "type": "string"
- // },
- // "progress": {
- // "description": "Job progress",
- // "enum": [
- // "COMPLETED",
- // "IN_PROGRESS",
- // "NOT_ACCEPTED",
- // "NOT_STARTED",
- // "OBSOLETE"
- // ],
- // "enumDescriptions": [
- // "Completed",
- // "In progress",
- // "Not accepted",
- // "Not started",
- // "Obsolete"
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "teamId": {
- // "description": "Team ID",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "title": {
- // "description": "Job title",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "teams/{teamId}/jobs/{jobId}",
- // "request": {
- // "$ref": "Job"
- // },
- // "response": {
- // "$ref": "Job"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/coordinate"
- // ]
- // }
-
-}
-
-// method id "coordinate.location.list":
-
-type LocationListCall struct {
- s *Service
- teamId string
- workerEmail string
- startTimestampMs uint64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of locations for a worker.
-func (r *LocationService) List(teamId string, workerEmail string, startTimestampMs uint64) *LocationListCall {
- c := &LocationListCall{s: r.s, opt_: make(map[string]interface{})}
- c.teamId = teamId
- c.workerEmail = workerEmail
- c.startTimestampMs = startTimestampMs
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return in one page.
-func (c *LocationListCall) MaxResults(maxResults int64) *LocationListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Continuation token
-func (c *LocationListCall) PageToken(pageToken string) *LocationListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LocationListCall) Fields(s ...googleapi.Field) *LocationListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *LocationListCall) IfNoneMatch(entityTag string) *LocationListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LocationListCall) Context(ctx context.Context) *LocationListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LocationListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("startTimestampMs", fmt.Sprintf("%v", c.startTimestampMs))
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "teams/{teamId}/workers/{workerEmail}/locations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "teamId": c.teamId,
- "workerEmail": c.workerEmail,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "coordinate.location.list" call.
-// Exactly one of *LocationListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *LocationListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *LocationListCall) Do() (*LocationListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &LocationListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of locations for a worker.",
- // "httpMethod": "GET",
- // "id": "coordinate.location.list",
- // "parameterOrder": [
- // "teamId",
- // "workerEmail",
- // "startTimestampMs"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of results to return in one page.",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Continuation token",
- // "location": "query",
- // "type": "string"
- // },
- // "startTimestampMs": {
- // "description": "Start timestamp in milliseconds since the epoch.",
- // "format": "uint64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "teamId": {
- // "description": "Team ID",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "workerEmail": {
- // "description": "Worker email address.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "teams/{teamId}/workers/{workerEmail}/locations",
- // "response": {
- // "$ref": "LocationListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/coordinate",
- // "https://www.googleapis.com/auth/coordinate.readonly"
- // ]
- // }
-
-}
-
-// method id "coordinate.schedule.get":
-
-type ScheduleGetCall struct {
- s *Service
- teamId string
- jobId uint64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves the schedule for a job.
-func (r *ScheduleService) Get(teamId string, jobId uint64) *ScheduleGetCall {
- c := &ScheduleGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.teamId = teamId
- c.jobId = jobId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ScheduleGetCall) Fields(s ...googleapi.Field) *ScheduleGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ScheduleGetCall) IfNoneMatch(entityTag string) *ScheduleGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ScheduleGetCall) Context(ctx context.Context) *ScheduleGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ScheduleGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "teams/{teamId}/jobs/{jobId}/schedule")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "teamId": c.teamId,
- "jobId": strconv.FormatUint(c.jobId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "coordinate.schedule.get" call.
-// Exactly one of *Schedule or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Schedule.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ScheduleGetCall) Do() (*Schedule, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Schedule{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the schedule for a job.",
- // "httpMethod": "GET",
- // "id": "coordinate.schedule.get",
- // "parameterOrder": [
- // "teamId",
- // "jobId"
- // ],
- // "parameters": {
- // "jobId": {
- // "description": "Job number",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "teamId": {
- // "description": "Team ID",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "teams/{teamId}/jobs/{jobId}/schedule",
- // "response": {
- // "$ref": "Schedule"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/coordinate",
- // "https://www.googleapis.com/auth/coordinate.readonly"
- // ]
- // }
-
-}
-
-// method id "coordinate.schedule.patch":
-
-type SchedulePatchCall struct {
- s *Service
- teamId string
- jobId uint64
- schedule *Schedule
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Replaces the schedule of a job with the provided schedule.
-// This method supports patch semantics.
-func (r *ScheduleService) Patch(teamId string, jobId uint64, schedule *Schedule) *SchedulePatchCall {
- c := &SchedulePatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.teamId = teamId
- c.jobId = jobId
- c.schedule = schedule
- return c
-}
-
-// AllDay sets the optional parameter "allDay": Whether the job is
-// scheduled for the whole day. Time of day in start/end times is
-// ignored if this is true.
-func (c *SchedulePatchCall) AllDay(allDay bool) *SchedulePatchCall {
- c.opt_["allDay"] = allDay
- return c
-}
-
-// Duration sets the optional parameter "duration": Job duration in
-// milliseconds.
-func (c *SchedulePatchCall) Duration(duration uint64) *SchedulePatchCall {
- c.opt_["duration"] = duration
- return c
-}
-
-// EndTime sets the optional parameter "endTime": Scheduled end time in
-// milliseconds since epoch.
-func (c *SchedulePatchCall) EndTime(endTime uint64) *SchedulePatchCall {
- c.opt_["endTime"] = endTime
- return c
-}
-
-// StartTime sets the optional parameter "startTime": Scheduled start
-// time in milliseconds since epoch.
-func (c *SchedulePatchCall) StartTime(startTime uint64) *SchedulePatchCall {
- c.opt_["startTime"] = startTime
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SchedulePatchCall) Fields(s ...googleapi.Field) *SchedulePatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SchedulePatchCall) Context(ctx context.Context) *SchedulePatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SchedulePatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.schedule)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["allDay"]; ok {
- params.Set("allDay", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["duration"]; ok {
- params.Set("duration", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["endTime"]; ok {
- params.Set("endTime", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startTime"]; ok {
- params.Set("startTime", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "teams/{teamId}/jobs/{jobId}/schedule")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "teamId": c.teamId,
- "jobId": strconv.FormatUint(c.jobId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "coordinate.schedule.patch" call.
-// Exactly one of *Schedule or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Schedule.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *SchedulePatchCall) Do() (*Schedule, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Schedule{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Replaces the schedule of a job with the provided schedule. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "coordinate.schedule.patch",
- // "parameterOrder": [
- // "teamId",
- // "jobId"
- // ],
- // "parameters": {
- // "allDay": {
- // "description": "Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "duration": {
- // "description": "Job duration in milliseconds.",
- // "format": "uint64",
- // "location": "query",
- // "type": "string"
- // },
- // "endTime": {
- // "description": "Scheduled end time in milliseconds since epoch.",
- // "format": "uint64",
- // "location": "query",
- // "type": "string"
- // },
- // "jobId": {
- // "description": "Job number",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "startTime": {
- // "description": "Scheduled start time in milliseconds since epoch.",
- // "format": "uint64",
- // "location": "query",
- // "type": "string"
- // },
- // "teamId": {
- // "description": "Team ID",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "teams/{teamId}/jobs/{jobId}/schedule",
- // "request": {
- // "$ref": "Schedule"
- // },
- // "response": {
- // "$ref": "Schedule"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/coordinate"
- // ]
- // }
-
-}
-
-// method id "coordinate.schedule.update":
-
-type ScheduleUpdateCall struct {
- s *Service
- teamId string
- jobId uint64
- schedule *Schedule
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Replaces the schedule of a job with the provided schedule.
-func (r *ScheduleService) Update(teamId string, jobId uint64, schedule *Schedule) *ScheduleUpdateCall {
- c := &ScheduleUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.teamId = teamId
- c.jobId = jobId
- c.schedule = schedule
- return c
-}
-
-// AllDay sets the optional parameter "allDay": Whether the job is
-// scheduled for the whole day. Time of day in start/end times is
-// ignored if this is true.
-func (c *ScheduleUpdateCall) AllDay(allDay bool) *ScheduleUpdateCall {
- c.opt_["allDay"] = allDay
- return c
-}
-
-// Duration sets the optional parameter "duration": Job duration in
-// milliseconds.
-func (c *ScheduleUpdateCall) Duration(duration uint64) *ScheduleUpdateCall {
- c.opt_["duration"] = duration
- return c
-}
-
-// EndTime sets the optional parameter "endTime": Scheduled end time in
-// milliseconds since epoch.
-func (c *ScheduleUpdateCall) EndTime(endTime uint64) *ScheduleUpdateCall {
- c.opt_["endTime"] = endTime
- return c
-}
-
-// StartTime sets the optional parameter "startTime": Scheduled start
-// time in milliseconds since epoch.
-func (c *ScheduleUpdateCall) StartTime(startTime uint64) *ScheduleUpdateCall {
- c.opt_["startTime"] = startTime
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ScheduleUpdateCall) Fields(s ...googleapi.Field) *ScheduleUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ScheduleUpdateCall) Context(ctx context.Context) *ScheduleUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ScheduleUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.schedule)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["allDay"]; ok {
- params.Set("allDay", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["duration"]; ok {
- params.Set("duration", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["endTime"]; ok {
- params.Set("endTime", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startTime"]; ok {
- params.Set("startTime", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "teams/{teamId}/jobs/{jobId}/schedule")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "teamId": c.teamId,
- "jobId": strconv.FormatUint(c.jobId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "coordinate.schedule.update" call.
-// Exactly one of *Schedule or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Schedule.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ScheduleUpdateCall) Do() (*Schedule, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Schedule{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Replaces the schedule of a job with the provided schedule.",
- // "httpMethod": "PUT",
- // "id": "coordinate.schedule.update",
- // "parameterOrder": [
- // "teamId",
- // "jobId"
- // ],
- // "parameters": {
- // "allDay": {
- // "description": "Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "duration": {
- // "description": "Job duration in milliseconds.",
- // "format": "uint64",
- // "location": "query",
- // "type": "string"
- // },
- // "endTime": {
- // "description": "Scheduled end time in milliseconds since epoch.",
- // "format": "uint64",
- // "location": "query",
- // "type": "string"
- // },
- // "jobId": {
- // "description": "Job number",
- // "format": "uint64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "startTime": {
- // "description": "Scheduled start time in milliseconds since epoch.",
- // "format": "uint64",
- // "location": "query",
- // "type": "string"
- // },
- // "teamId": {
- // "description": "Team ID",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "teams/{teamId}/jobs/{jobId}/schedule",
- // "request": {
- // "$ref": "Schedule"
- // },
- // "response": {
- // "$ref": "Schedule"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/coordinate"
- // ]
- // }
-
-}
-
-// method id "coordinate.team.list":
-
-type TeamListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of teams for a user.
-func (r *TeamService) List() *TeamListCall {
- c := &TeamListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Admin sets the optional parameter "admin": Whether to include teams
-// for which the user has the Admin role.
-func (c *TeamListCall) Admin(admin bool) *TeamListCall {
- c.opt_["admin"] = admin
- return c
-}
-
-// Dispatcher sets the optional parameter "dispatcher": Whether to
-// include teams for which the user has the Dispatcher role.
-func (c *TeamListCall) Dispatcher(dispatcher bool) *TeamListCall {
- c.opt_["dispatcher"] = dispatcher
- return c
-}
-
-// Worker sets the optional parameter "worker": Whether to include teams
-// for which the user has the Worker role.
-func (c *TeamListCall) Worker(worker bool) *TeamListCall {
- c.opt_["worker"] = worker
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TeamListCall) Fields(s ...googleapi.Field) *TeamListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TeamListCall) IfNoneMatch(entityTag string) *TeamListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TeamListCall) Context(ctx context.Context) *TeamListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TeamListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["admin"]; ok {
- params.Set("admin", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["dispatcher"]; ok {
- params.Set("dispatcher", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["worker"]; ok {
- params.Set("worker", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "teams")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "coordinate.team.list" call.
-// Exactly one of *TeamListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *TeamListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TeamListCall) Do() (*TeamListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TeamListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of teams for a user.",
- // "httpMethod": "GET",
- // "id": "coordinate.team.list",
- // "parameters": {
- // "admin": {
- // "description": "Whether to include teams for which the user has the Admin role.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "dispatcher": {
- // "description": "Whether to include teams for which the user has the Dispatcher role.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "worker": {
- // "description": "Whether to include teams for which the user has the Worker role.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "teams",
- // "response": {
- // "$ref": "TeamListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/coordinate",
- // "https://www.googleapis.com/auth/coordinate.readonly"
- // ]
- // }
-
-}
-
-// method id "coordinate.worker.list":
-
-type WorkerListCall struct {
- s *Service
- teamId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of workers in a team.
-func (r *WorkerService) List(teamId string) *WorkerListCall {
- c := &WorkerListCall{s: r.s, opt_: make(map[string]interface{})}
- c.teamId = teamId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *WorkerListCall) Fields(s ...googleapi.Field) *WorkerListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *WorkerListCall) IfNoneMatch(entityTag string) *WorkerListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *WorkerListCall) Context(ctx context.Context) *WorkerListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *WorkerListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "teams/{teamId}/workers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "teamId": c.teamId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "coordinate.worker.list" call.
-// Exactly one of *WorkerListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *WorkerListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *WorkerListCall) Do() (*WorkerListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &WorkerListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of workers in a team.",
- // "httpMethod": "GET",
- // "id": "coordinate.worker.list",
- // "parameterOrder": [
- // "teamId"
- // ],
- // "parameters": {
- // "teamId": {
- // "description": "Team ID",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "teams/{teamId}/workers",
- // "response": {
- // "$ref": "WorkerListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/coordinate",
- // "https://www.googleapis.com/auth/coordinate.readonly"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/customsearch/v1/customsearch-api.json b/vendor/google.golang.org/api/customsearch/v1/customsearch-api.json
deleted file mode 100644
index ce5e279c..00000000
--- a/vendor/google.golang.org/api/customsearch/v1/customsearch-api.json
+++ /dev/null
@@ -1,814 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"FrPV2U6xXFUq8eRv_PO3IoAURkc/KsgpNVP8dzFmgPzAjDdH7uBJP_M\"",
- "discoveryVersion": "v1",
- "id": "customsearch:v1",
- "name": "customsearch",
- "version": "v1",
- "revision": "20131205",
- "title": "CustomSearch API",
- "description": "Lets you search over a website or collection of websites",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/custom-search/v1/using_rest",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/customsearch/",
- "basePath": "/customsearch/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "customsearch/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "atom",
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/atom+xml",
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "schemas": {
- "Context": {
- "id": "Context",
- "type": "object",
- "properties": {
- "facets": {
- "type": "array",
- "items": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "anchor": {
- "type": "string"
- },
- "label": {
- "type": "string"
- },
- "label_with_op": {
- "type": "string"
- }
- }
- }
- }
- },
- "title": {
- "type": "string"
- }
- }
- },
- "Promotion": {
- "id": "Promotion",
- "type": "object",
- "properties": {
- "bodyLines": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "htmlTitle": {
- "type": "string"
- },
- "link": {
- "type": "string"
- },
- "title": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- }
- },
- "displayLink": {
- "type": "string"
- },
- "htmlTitle": {
- "type": "string"
- },
- "image": {
- "type": "object",
- "properties": {
- "height": {
- "type": "integer",
- "format": "int32"
- },
- "source": {
- "type": "string"
- },
- "width": {
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "link": {
- "type": "string"
- },
- "title": {
- "type": "string"
- }
- }
- },
- "Query": {
- "id": "Query",
- "type": "object",
- "properties": {
- "count": {
- "type": "integer",
- "format": "int32"
- },
- "cr": {
- "type": "string"
- },
- "cref": {
- "type": "string"
- },
- "cx": {
- "type": "string"
- },
- "dateRestrict": {
- "type": "string"
- },
- "disableCnTwTranslation": {
- "type": "string"
- },
- "exactTerms": {
- "type": "string"
- },
- "excludeTerms": {
- "type": "string"
- },
- "fileType": {
- "type": "string"
- },
- "filter": {
- "type": "string"
- },
- "gl": {
- "type": "string"
- },
- "googleHost": {
- "type": "string"
- },
- "highRange": {
- "type": "string"
- },
- "hl": {
- "type": "string"
- },
- "hq": {
- "type": "string"
- },
- "imgColorType": {
- "type": "string"
- },
- "imgDominantColor": {
- "type": "string"
- },
- "imgSize": {
- "type": "string"
- },
- "imgType": {
- "type": "string"
- },
- "inputEncoding": {
- "type": "string"
- },
- "language": {
- "type": "string"
- },
- "linkSite": {
- "type": "string"
- },
- "lowRange": {
- "type": "string"
- },
- "orTerms": {
- "type": "string"
- },
- "outputEncoding": {
- "type": "string"
- },
- "relatedSite": {
- "type": "string"
- },
- "rights": {
- "type": "string"
- },
- "safe": {
- "type": "string"
- },
- "searchTerms": {
- "type": "string"
- },
- "searchType": {
- "type": "string"
- },
- "siteSearch": {
- "type": "string"
- },
- "siteSearchFilter": {
- "type": "string"
- },
- "sort": {
- "type": "string"
- },
- "startIndex": {
- "type": "integer",
- "format": "int32"
- },
- "startPage": {
- "type": "integer",
- "format": "int32"
- },
- "title": {
- "type": "string"
- },
- "totalResults": {
- "type": "string",
- "format": "int64"
- }
- }
- },
- "Result": {
- "id": "Result",
- "type": "object",
- "properties": {
- "cacheId": {
- "type": "string"
- },
- "displayLink": {
- "type": "string"
- },
- "fileFormat": {
- "type": "string"
- },
- "formattedUrl": {
- "type": "string"
- },
- "htmlFormattedUrl": {
- "type": "string"
- },
- "htmlSnippet": {
- "type": "string"
- },
- "htmlTitle": {
- "type": "string"
- },
- "image": {
- "type": "object",
- "properties": {
- "byteSize": {
- "type": "integer",
- "format": "int32"
- },
- "contextLink": {
- "type": "string"
- },
- "height": {
- "type": "integer",
- "format": "int32"
- },
- "thumbnailHeight": {
- "type": "integer",
- "format": "int32"
- },
- "thumbnailLink": {
- "type": "string"
- },
- "thumbnailWidth": {
- "type": "integer",
- "format": "int32"
- },
- "width": {
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "kind": {
- "type": "string",
- "default": "customsearch#result"
- },
- "labels": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "displayName": {
- "type": "string"
- },
- "label_with_op": {
- "type": "string"
- },
- "name": {
- "type": "string"
- }
- }
- }
- },
- "link": {
- "type": "string"
- },
- "mime": {
- "type": "string"
- },
- "pagemap": {
- "type": "object",
- "additionalProperties": {
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": {
- "type": "any"
- }
- }
- }
- },
- "snippet": {
- "type": "string"
- },
- "title": {
- "type": "string"
- }
- }
- },
- "Search": {
- "id": "Search",
- "type": "object",
- "properties": {
- "context": {
- "$ref": "Context"
- },
- "items": {
- "type": "array",
- "items": {
- "$ref": "Result"
- }
- },
- "kind": {
- "type": "string",
- "default": "customsearch#search"
- },
- "promotions": {
- "type": "array",
- "items": {
- "$ref": "Promotion"
- }
- },
- "queries": {
- "type": "object",
- "additionalProperties": {
- "type": "array",
- "items": {
- "$ref": "Query"
- }
- }
- },
- "searchInformation": {
- "type": "object",
- "properties": {
- "formattedSearchTime": {
- "type": "string"
- },
- "formattedTotalResults": {
- "type": "string"
- },
- "searchTime": {
- "type": "number",
- "format": "double"
- },
- "totalResults": {
- "type": "string",
- "format": "int64"
- }
- }
- },
- "spelling": {
- "type": "object",
- "properties": {
- "correctedQuery": {
- "type": "string"
- },
- "htmlCorrectedQuery": {
- "type": "string"
- }
- }
- },
- "url": {
- "type": "object",
- "properties": {
- "template": {
- "type": "string",
- "default": "https://www.googleapis.com/customsearch/v1?q={searchTerms}&num={count?}&start={startIndex?}&lr={language?}&safe={safe?}&cx={cx?}&cref={cref?}&sort={sort?}&filter={filter?}&gl={gl?}&cr={cr?}&googlehost={googleHost?}&c2coff={disableCnTwTranslation?}&hq={hq?}&hl={hl?}&siteSearch={siteSearch?}&siteSearchFilter={siteSearchFilter?}&exactTerms={exactTerms?}&excludeTerms={excludeTerms?}&linkSite={linkSite?}&orTerms={orTerms?}&relatedSite={relatedSite?}&dateRestrict={dateRestrict?}&lowRange={lowRange?}&highRange={highRange?}&searchType={searchType}&fileType={fileType?}&rights={rights?}&imgSize={imgSize?}&imgType={imgType?}&imgColorType={imgColorType?}&imgDominantColor={imgDominantColor?}&alt=json"
- },
- "type": {
- "type": "string",
- "default": "application/json"
- }
- }
- }
- }
- }
- },
- "resources": {
- "cse": {
- "methods": {
- "list": {
- "id": "search.cse.list",
- "path": "v1",
- "httpMethod": "GET",
- "description": "Returns metadata about the search performed, metadata about the custom search engine used for the search, and the search results.",
- "parameters": {
- "c2coff": {
- "type": "string",
- "description": "Turns off the translation between zh-CN and zh-TW.",
- "location": "query"
- },
- "cr": {
- "type": "string",
- "description": "Country restrict(s).",
- "location": "query"
- },
- "cref": {
- "type": "string",
- "description": "The URL of a linked custom search engine",
- "location": "query"
- },
- "cx": {
- "type": "string",
- "description": "The custom search engine ID to scope this search query",
- "location": "query"
- },
- "dateRestrict": {
- "type": "string",
- "description": "Specifies all search results are from a time period",
- "location": "query"
- },
- "exactTerms": {
- "type": "string",
- "description": "Identifies a phrase that all documents in the search results must contain",
- "location": "query"
- },
- "excludeTerms": {
- "type": "string",
- "description": "Identifies a word or phrase that should not appear in any documents in the search results",
- "location": "query"
- },
- "fileType": {
- "type": "string",
- "description": "Returns images of a specified type. Some of the allowed values are: bmp, gif, png, jpg, svg, pdf, ...",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "Controls turning on or off the duplicate content filter.",
- "enum": [
- "0",
- "1"
- ],
- "enumDescriptions": [
- "Turns off duplicate content filter.",
- "Turns on duplicate content filter."
- ],
- "location": "query"
- },
- "gl": {
- "type": "string",
- "description": "Geolocation of end user.",
- "location": "query"
- },
- "googlehost": {
- "type": "string",
- "description": "The local Google domain to use to perform the search.",
- "location": "query"
- },
- "highRange": {
- "type": "string",
- "description": "Creates a range in form as_nlo value..as_nhi value and attempts to append it to query",
- "location": "query"
- },
- "hl": {
- "type": "string",
- "description": "Sets the user interface language.",
- "location": "query"
- },
- "hq": {
- "type": "string",
- "description": "Appends the extra query terms to the query.",
- "location": "query"
- },
- "imgColorType": {
- "type": "string",
- "description": "Returns black and white, grayscale, or color images: mono, gray, and color.",
- "enum": [
- "color",
- "gray",
- "mono"
- ],
- "enumDescriptions": [
- "color",
- "gray",
- "mono"
- ],
- "location": "query"
- },
- "imgDominantColor": {
- "type": "string",
- "description": "Returns images of a specific dominant color: yellow, green, teal, blue, purple, pink, white, gray, black and brown.",
- "enum": [
- "black",
- "blue",
- "brown",
- "gray",
- "green",
- "pink",
- "purple",
- "teal",
- "white",
- "yellow"
- ],
- "enumDescriptions": [
- "black",
- "blue",
- "brown",
- "gray",
- "green",
- "pink",
- "purple",
- "teal",
- "white",
- "yellow"
- ],
- "location": "query"
- },
- "imgSize": {
- "type": "string",
- "description": "Returns images of a specified size, where size can be one of: icon, small, medium, large, xlarge, xxlarge, and huge.",
- "enum": [
- "huge",
- "icon",
- "large",
- "medium",
- "small",
- "xlarge",
- "xxlarge"
- ],
- "enumDescriptions": [
- "huge",
- "icon",
- "large",
- "medium",
- "small",
- "xlarge",
- "xxlarge"
- ],
- "location": "query"
- },
- "imgType": {
- "type": "string",
- "description": "Returns images of a type, which can be one of: clipart, face, lineart, news, and photo.",
- "enum": [
- "clipart",
- "face",
- "lineart",
- "news",
- "photo"
- ],
- "enumDescriptions": [
- "clipart",
- "face",
- "lineart",
- "news",
- "photo"
- ],
- "location": "query"
- },
- "linkSite": {
- "type": "string",
- "description": "Specifies that all search results should contain a link to a particular URL",
- "location": "query"
- },
- "lowRange": {
- "type": "string",
- "description": "Creates a range in form as_nlo value..as_nhi value and attempts to append it to query",
- "location": "query"
- },
- "lr": {
- "type": "string",
- "description": "The language restriction for the search results",
- "enum": [
- "lang_ar",
- "lang_bg",
- "lang_ca",
- "lang_cs",
- "lang_da",
- "lang_de",
- "lang_el",
- "lang_en",
- "lang_es",
- "lang_et",
- "lang_fi",
- "lang_fr",
- "lang_hr",
- "lang_hu",
- "lang_id",
- "lang_is",
- "lang_it",
- "lang_iw",
- "lang_ja",
- "lang_ko",
- "lang_lt",
- "lang_lv",
- "lang_nl",
- "lang_no",
- "lang_pl",
- "lang_pt",
- "lang_ro",
- "lang_ru",
- "lang_sk",
- "lang_sl",
- "lang_sr",
- "lang_sv",
- "lang_tr",
- "lang_zh-CN",
- "lang_zh-TW"
- ],
- "enumDescriptions": [
- "Arabic",
- "Bulgarian",
- "Catalan",
- "Czech",
- "Danish",
- "German",
- "Greek",
- "English",
- "Spanish",
- "Estonian",
- "Finnish",
- "French",
- "Croatian",
- "Hungarian",
- "Indonesian",
- "Icelandic",
- "Italian",
- "Hebrew",
- "Japanese",
- "Korean",
- "Lithuanian",
- "Latvian",
- "Dutch",
- "Norwegian",
- "Polish",
- "Portuguese",
- "Romanian",
- "Russian",
- "Slovak",
- "Slovenian",
- "Serbian",
- "Swedish",
- "Turkish",
- "Chinese (Simplified)",
- "Chinese (Traditional)"
- ],
- "location": "query"
- },
- "num": {
- "type": "integer",
- "description": "Number of search results to return",
- "default": "10",
- "format": "uint32",
- "location": "query"
- },
- "orTerms": {
- "type": "string",
- "description": "Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms",
- "location": "query"
- },
- "q": {
- "type": "string",
- "description": "Query",
- "required": true,
- "location": "query"
- },
- "relatedSite": {
- "type": "string",
- "description": "Specifies that all search results should be pages that are related to the specified URL",
- "location": "query"
- },
- "rights": {
- "type": "string",
- "description": "Filters based on licensing. Supported values include: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and combinations of these.",
- "location": "query"
- },
- "safe": {
- "type": "string",
- "description": "Search safety level",
- "default": "off",
- "enum": [
- "high",
- "medium",
- "off"
- ],
- "enumDescriptions": [
- "Enables highest level of safe search filtering.",
- "Enables moderate safe search filtering.",
- "Disables safe search filtering."
- ],
- "location": "query"
- },
- "searchType": {
- "type": "string",
- "description": "Specifies the search type: image.",
- "enum": [
- "image"
- ],
- "enumDescriptions": [
- "custom image search"
- ],
- "location": "query"
- },
- "siteSearch": {
- "type": "string",
- "description": "Specifies all search results should be pages from a given site",
- "location": "query"
- },
- "siteSearchFilter": {
- "type": "string",
- "description": "Controls whether to include or exclude results from the site named in the as_sitesearch parameter",
- "enum": [
- "e",
- "i"
- ],
- "enumDescriptions": [
- "exclude",
- "include"
- ],
- "location": "query"
- },
- "sort": {
- "type": "string",
- "description": "The sort expression to apply to the results",
- "location": "query"
- },
- "start": {
- "type": "integer",
- "description": "The index of the first result to return",
- "format": "uint32",
- "location": "query"
- }
- },
- "parameterOrder": [
- "q"
- ],
- "response": {
- "$ref": "Search"
- }
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/customsearch/v1/customsearch-gen.go b/vendor/google.golang.org/api/customsearch/v1/customsearch-gen.go
deleted file mode 100644
index be52fda6..00000000
--- a/vendor/google.golang.org/api/customsearch/v1/customsearch-gen.go
+++ /dev/null
@@ -1,1343 +0,0 @@
-// Package customsearch provides access to the CustomSearch API.
-//
-// See https://developers.google.com/custom-search/v1/using_rest
-//
-// Usage example:
-//
-// import "google.golang.org/api/customsearch/v1"
-// ...
-// customsearchService, err := customsearch.New(oauthHttpClient)
-package customsearch // import "google.golang.org/api/customsearch/v1"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "customsearch:v1"
-const apiName = "customsearch"
-const apiVersion = "v1"
-const basePath = "https://www.googleapis.com/customsearch/"
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Cse = NewCseService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Cse *CseService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewCseService(s *Service) *CseService {
- rs := &CseService{s: s}
- return rs
-}
-
-type CseService struct {
- s *Service
-}
-
-type Context struct {
- Facets [][]*ContextFacetsItem `json:"facets,omitempty"`
-
- Title string `json:"title,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Facets") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Context) MarshalJSON() ([]byte, error) {
- type noMethod Context
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ContextFacetsItem struct {
- Anchor string `json:"anchor,omitempty"`
-
- Label string `json:"label,omitempty"`
-
- LabelWithOp string `json:"label_with_op,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Anchor") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ContextFacetsItem) MarshalJSON() ([]byte, error) {
- type noMethod ContextFacetsItem
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Promotion struct {
- BodyLines []*PromotionBodyLines `json:"bodyLines,omitempty"`
-
- DisplayLink string `json:"displayLink,omitempty"`
-
- HtmlTitle string `json:"htmlTitle,omitempty"`
-
- Image *PromotionImage `json:"image,omitempty"`
-
- Link string `json:"link,omitempty"`
-
- Title string `json:"title,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BodyLines") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Promotion) MarshalJSON() ([]byte, error) {
- type noMethod Promotion
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type PromotionBodyLines struct {
- HtmlTitle string `json:"htmlTitle,omitempty"`
-
- Link string `json:"link,omitempty"`
-
- Title string `json:"title,omitempty"`
-
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "HtmlTitle") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PromotionBodyLines) MarshalJSON() ([]byte, error) {
- type noMethod PromotionBodyLines
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type PromotionImage struct {
- Height int64 `json:"height,omitempty"`
-
- Source string `json:"source,omitempty"`
-
- Width int64 `json:"width,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Height") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PromotionImage) MarshalJSON() ([]byte, error) {
- type noMethod PromotionImage
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Query struct {
- Count int64 `json:"count,omitempty"`
-
- Cr string `json:"cr,omitempty"`
-
- Cref string `json:"cref,omitempty"`
-
- Cx string `json:"cx,omitempty"`
-
- DateRestrict string `json:"dateRestrict,omitempty"`
-
- DisableCnTwTranslation string `json:"disableCnTwTranslation,omitempty"`
-
- ExactTerms string `json:"exactTerms,omitempty"`
-
- ExcludeTerms string `json:"excludeTerms,omitempty"`
-
- FileType string `json:"fileType,omitempty"`
-
- Filter string `json:"filter,omitempty"`
-
- Gl string `json:"gl,omitempty"`
-
- GoogleHost string `json:"googleHost,omitempty"`
-
- HighRange string `json:"highRange,omitempty"`
-
- Hl string `json:"hl,omitempty"`
-
- Hq string `json:"hq,omitempty"`
-
- ImgColorType string `json:"imgColorType,omitempty"`
-
- ImgDominantColor string `json:"imgDominantColor,omitempty"`
-
- ImgSize string `json:"imgSize,omitempty"`
-
- ImgType string `json:"imgType,omitempty"`
-
- InputEncoding string `json:"inputEncoding,omitempty"`
-
- Language string `json:"language,omitempty"`
-
- LinkSite string `json:"linkSite,omitempty"`
-
- LowRange string `json:"lowRange,omitempty"`
-
- OrTerms string `json:"orTerms,omitempty"`
-
- OutputEncoding string `json:"outputEncoding,omitempty"`
-
- RelatedSite string `json:"relatedSite,omitempty"`
-
- Rights string `json:"rights,omitempty"`
-
- Safe string `json:"safe,omitempty"`
-
- SearchTerms string `json:"searchTerms,omitempty"`
-
- SearchType string `json:"searchType,omitempty"`
-
- SiteSearch string `json:"siteSearch,omitempty"`
-
- SiteSearchFilter string `json:"siteSearchFilter,omitempty"`
-
- Sort string `json:"sort,omitempty"`
-
- StartIndex int64 `json:"startIndex,omitempty"`
-
- StartPage int64 `json:"startPage,omitempty"`
-
- Title string `json:"title,omitempty"`
-
- TotalResults int64 `json:"totalResults,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "Count") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Query) MarshalJSON() ([]byte, error) {
- type noMethod Query
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Result struct {
- CacheId string `json:"cacheId,omitempty"`
-
- DisplayLink string `json:"displayLink,omitempty"`
-
- FileFormat string `json:"fileFormat,omitempty"`
-
- FormattedUrl string `json:"formattedUrl,omitempty"`
-
- HtmlFormattedUrl string `json:"htmlFormattedUrl,omitempty"`
-
- HtmlSnippet string `json:"htmlSnippet,omitempty"`
-
- HtmlTitle string `json:"htmlTitle,omitempty"`
-
- Image *ResultImage `json:"image,omitempty"`
-
- Kind string `json:"kind,omitempty"`
-
- Labels []*ResultLabels `json:"labels,omitempty"`
-
- Link string `json:"link,omitempty"`
-
- Mime string `json:"mime,omitempty"`
-
- Pagemap *ResultPagemap `json:"pagemap,omitempty"`
-
- Snippet string `json:"snippet,omitempty"`
-
- Title string `json:"title,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CacheId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Result) MarshalJSON() ([]byte, error) {
- type noMethod Result
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ResultImage struct {
- ByteSize int64 `json:"byteSize,omitempty"`
-
- ContextLink string `json:"contextLink,omitempty"`
-
- Height int64 `json:"height,omitempty"`
-
- ThumbnailHeight int64 `json:"thumbnailHeight,omitempty"`
-
- ThumbnailLink string `json:"thumbnailLink,omitempty"`
-
- ThumbnailWidth int64 `json:"thumbnailWidth,omitempty"`
-
- Width int64 `json:"width,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ByteSize") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ResultImage) MarshalJSON() ([]byte, error) {
- type noMethod ResultImage
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ResultLabels struct {
- DisplayName string `json:"displayName,omitempty"`
-
- LabelWithOp string `json:"label_with_op,omitempty"`
-
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DisplayName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ResultLabels) MarshalJSON() ([]byte, error) {
- type noMethod ResultLabels
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ResultPagemap struct {
-}
-
-type Search struct {
- Context *Context `json:"context,omitempty"`
-
- Items []*Result `json:"items,omitempty"`
-
- Kind string `json:"kind,omitempty"`
-
- Promotions []*Promotion `json:"promotions,omitempty"`
-
- Queries map[string][]Query `json:"queries,omitempty"`
-
- SearchInformation *SearchSearchInformation `json:"searchInformation,omitempty"`
-
- Spelling *SearchSpelling `json:"spelling,omitempty"`
-
- Url *SearchUrl `json:"url,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Context") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Search) MarshalJSON() ([]byte, error) {
- type noMethod Search
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type SearchSearchInformation struct {
- FormattedSearchTime string `json:"formattedSearchTime,omitempty"`
-
- FormattedTotalResults string `json:"formattedTotalResults,omitempty"`
-
- SearchTime float64 `json:"searchTime,omitempty"`
-
- TotalResults int64 `json:"totalResults,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "FormattedSearchTime")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SearchSearchInformation) MarshalJSON() ([]byte, error) {
- type noMethod SearchSearchInformation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type SearchSpelling struct {
- CorrectedQuery string `json:"correctedQuery,omitempty"`
-
- HtmlCorrectedQuery string `json:"htmlCorrectedQuery,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CorrectedQuery") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SearchSpelling) MarshalJSON() ([]byte, error) {
- type noMethod SearchSpelling
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type SearchUrl struct {
- Template string `json:"template,omitempty"`
-
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Template") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SearchUrl) MarshalJSON() ([]byte, error) {
- type noMethod SearchUrl
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "search.cse.list":
-
-type CseListCall struct {
- s *Service
- q string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Returns metadata about the search performed, metadata about the
-// custom search engine used for the search, and the search results.
-func (r *CseService) List(q string) *CseListCall {
- c := &CseListCall{s: r.s, opt_: make(map[string]interface{})}
- c.q = q
- return c
-}
-
-// C2coff sets the optional parameter "c2coff": Turns off the
-// translation between zh-CN and zh-TW.
-func (c *CseListCall) C2coff(c2coff string) *CseListCall {
- c.opt_["c2coff"] = c2coff
- return c
-}
-
-// Cr sets the optional parameter "cr": Country restrict(s).
-func (c *CseListCall) Cr(cr string) *CseListCall {
- c.opt_["cr"] = cr
- return c
-}
-
-// Cref sets the optional parameter "cref": The URL of a linked custom
-// search engine
-func (c *CseListCall) Cref(cref string) *CseListCall {
- c.opt_["cref"] = cref
- return c
-}
-
-// Cx sets the optional parameter "cx": The custom search engine ID to
-// scope this search query
-func (c *CseListCall) Cx(cx string) *CseListCall {
- c.opt_["cx"] = cx
- return c
-}
-
-// DateRestrict sets the optional parameter "dateRestrict": Specifies
-// all search results are from a time period
-func (c *CseListCall) DateRestrict(dateRestrict string) *CseListCall {
- c.opt_["dateRestrict"] = dateRestrict
- return c
-}
-
-// ExactTerms sets the optional parameter "exactTerms": Identifies a
-// phrase that all documents in the search results must contain
-func (c *CseListCall) ExactTerms(exactTerms string) *CseListCall {
- c.opt_["exactTerms"] = exactTerms
- return c
-}
-
-// ExcludeTerms sets the optional parameter "excludeTerms": Identifies a
-// word or phrase that should not appear in any documents in the search
-// results
-func (c *CseListCall) ExcludeTerms(excludeTerms string) *CseListCall {
- c.opt_["excludeTerms"] = excludeTerms
- return c
-}
-
-// FileType sets the optional parameter "fileType": Returns images of a
-// specified type. Some of the allowed values are: bmp, gif, png, jpg,
-// svg, pdf, ...
-func (c *CseListCall) FileType(fileType string) *CseListCall {
- c.opt_["fileType"] = fileType
- return c
-}
-
-// Filter sets the optional parameter "filter": Controls turning on or
-// off the duplicate content filter.
-//
-// Possible values:
-// "0" - Turns off duplicate content filter.
-// "1" - Turns on duplicate content filter.
-func (c *CseListCall) Filter(filter string) *CseListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// Gl sets the optional parameter "gl": Geolocation of end user.
-func (c *CseListCall) Gl(gl string) *CseListCall {
- c.opt_["gl"] = gl
- return c
-}
-
-// Googlehost sets the optional parameter "googlehost": The local Google
-// domain to use to perform the search.
-func (c *CseListCall) Googlehost(googlehost string) *CseListCall {
- c.opt_["googlehost"] = googlehost
- return c
-}
-
-// HighRange sets the optional parameter "highRange": Creates a range in
-// form as_nlo value..as_nhi value and attempts to append it to query
-func (c *CseListCall) HighRange(highRange string) *CseListCall {
- c.opt_["highRange"] = highRange
- return c
-}
-
-// Hl sets the optional parameter "hl": Sets the user interface
-// language.
-func (c *CseListCall) Hl(hl string) *CseListCall {
- c.opt_["hl"] = hl
- return c
-}
-
-// Hq sets the optional parameter "hq": Appends the extra query terms to
-// the query.
-func (c *CseListCall) Hq(hq string) *CseListCall {
- c.opt_["hq"] = hq
- return c
-}
-
-// ImgColorType sets the optional parameter "imgColorType": Returns
-// black and white, grayscale, or color images: mono, gray, and color.
-//
-// Possible values:
-// "color" - color
-// "gray" - gray
-// "mono" - mono
-func (c *CseListCall) ImgColorType(imgColorType string) *CseListCall {
- c.opt_["imgColorType"] = imgColorType
- return c
-}
-
-// ImgDominantColor sets the optional parameter "imgDominantColor":
-// Returns images of a specific dominant color: yellow, green, teal,
-// blue, purple, pink, white, gray, black and brown.
-//
-// Possible values:
-// "black" - black
-// "blue" - blue
-// "brown" - brown
-// "gray" - gray
-// "green" - green
-// "pink" - pink
-// "purple" - purple
-// "teal" - teal
-// "white" - white
-// "yellow" - yellow
-func (c *CseListCall) ImgDominantColor(imgDominantColor string) *CseListCall {
- c.opt_["imgDominantColor"] = imgDominantColor
- return c
-}
-
-// ImgSize sets the optional parameter "imgSize": Returns images of a
-// specified size, where size can be one of: icon, small, medium, large,
-// xlarge, xxlarge, and huge.
-//
-// Possible values:
-// "huge" - huge
-// "icon" - icon
-// "large" - large
-// "medium" - medium
-// "small" - small
-// "xlarge" - xlarge
-// "xxlarge" - xxlarge
-func (c *CseListCall) ImgSize(imgSize string) *CseListCall {
- c.opt_["imgSize"] = imgSize
- return c
-}
-
-// ImgType sets the optional parameter "imgType": Returns images of a
-// type, which can be one of: clipart, face, lineart, news, and photo.
-//
-// Possible values:
-// "clipart" - clipart
-// "face" - face
-// "lineart" - lineart
-// "news" - news
-// "photo" - photo
-func (c *CseListCall) ImgType(imgType string) *CseListCall {
- c.opt_["imgType"] = imgType
- return c
-}
-
-// LinkSite sets the optional parameter "linkSite": Specifies that all
-// search results should contain a link to a particular URL
-func (c *CseListCall) LinkSite(linkSite string) *CseListCall {
- c.opt_["linkSite"] = linkSite
- return c
-}
-
-// LowRange sets the optional parameter "lowRange": Creates a range in
-// form as_nlo value..as_nhi value and attempts to append it to query
-func (c *CseListCall) LowRange(lowRange string) *CseListCall {
- c.opt_["lowRange"] = lowRange
- return c
-}
-
-// Lr sets the optional parameter "lr": The language restriction for the
-// search results
-//
-// Possible values:
-// "lang_ar" - Arabic
-// "lang_bg" - Bulgarian
-// "lang_ca" - Catalan
-// "lang_cs" - Czech
-// "lang_da" - Danish
-// "lang_de" - German
-// "lang_el" - Greek
-// "lang_en" - English
-// "lang_es" - Spanish
-// "lang_et" - Estonian
-// "lang_fi" - Finnish
-// "lang_fr" - French
-// "lang_hr" - Croatian
-// "lang_hu" - Hungarian
-// "lang_id" - Indonesian
-// "lang_is" - Icelandic
-// "lang_it" - Italian
-// "lang_iw" - Hebrew
-// "lang_ja" - Japanese
-// "lang_ko" - Korean
-// "lang_lt" - Lithuanian
-// "lang_lv" - Latvian
-// "lang_nl" - Dutch
-// "lang_no" - Norwegian
-// "lang_pl" - Polish
-// "lang_pt" - Portuguese
-// "lang_ro" - Romanian
-// "lang_ru" - Russian
-// "lang_sk" - Slovak
-// "lang_sl" - Slovenian
-// "lang_sr" - Serbian
-// "lang_sv" - Swedish
-// "lang_tr" - Turkish
-// "lang_zh-CN" - Chinese (Simplified)
-// "lang_zh-TW" - Chinese (Traditional)
-func (c *CseListCall) Lr(lr string) *CseListCall {
- c.opt_["lr"] = lr
- return c
-}
-
-// Num sets the optional parameter "num": Number of search results to
-// return
-func (c *CseListCall) Num(num int64) *CseListCall {
- c.opt_["num"] = num
- return c
-}
-
-// OrTerms sets the optional parameter "orTerms": Provides additional
-// search terms to check for in a document, where each document in the
-// search results must contain at least one of the additional search
-// terms
-func (c *CseListCall) OrTerms(orTerms string) *CseListCall {
- c.opt_["orTerms"] = orTerms
- return c
-}
-
-// RelatedSite sets the optional parameter "relatedSite": Specifies that
-// all search results should be pages that are related to the specified
-// URL
-func (c *CseListCall) RelatedSite(relatedSite string) *CseListCall {
- c.opt_["relatedSite"] = relatedSite
- return c
-}
-
-// Rights sets the optional parameter "rights": Filters based on
-// licensing. Supported values include: cc_publicdomain, cc_attribute,
-// cc_sharealike, cc_noncommercial, cc_nonderived and combinations of
-// these.
-func (c *CseListCall) Rights(rights string) *CseListCall {
- c.opt_["rights"] = rights
- return c
-}
-
-// Safe sets the optional parameter "safe": Search safety level
-//
-// Possible values:
-// "high" - Enables highest level of safe search filtering.
-// "medium" - Enables moderate safe search filtering.
-// "off" (default) - Disables safe search filtering.
-func (c *CseListCall) Safe(safe string) *CseListCall {
- c.opt_["safe"] = safe
- return c
-}
-
-// SearchType sets the optional parameter "searchType": Specifies the
-// search type: image.
-//
-// Possible values:
-// "image" - custom image search
-func (c *CseListCall) SearchType(searchType string) *CseListCall {
- c.opt_["searchType"] = searchType
- return c
-}
-
-// SiteSearch sets the optional parameter "siteSearch": Specifies all
-// search results should be pages from a given site
-func (c *CseListCall) SiteSearch(siteSearch string) *CseListCall {
- c.opt_["siteSearch"] = siteSearch
- return c
-}
-
-// SiteSearchFilter sets the optional parameter "siteSearchFilter":
-// Controls whether to include or exclude results from the site named in
-// the as_sitesearch parameter
-//
-// Possible values:
-// "e" - exclude
-// "i" - include
-func (c *CseListCall) SiteSearchFilter(siteSearchFilter string) *CseListCall {
- c.opt_["siteSearchFilter"] = siteSearchFilter
- return c
-}
-
-// Sort sets the optional parameter "sort": The sort expression to apply
-// to the results
-func (c *CseListCall) Sort(sort string) *CseListCall {
- c.opt_["sort"] = sort
- return c
-}
-
-// Start sets the optional parameter "start": The index of the first
-// result to return
-func (c *CseListCall) Start(start int64) *CseListCall {
- c.opt_["start"] = start
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CseListCall) Fields(s ...googleapi.Field) *CseListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CseListCall) IfNoneMatch(entityTag string) *CseListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CseListCall) Context(ctx context.Context) *CseListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CseListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("q", fmt.Sprintf("%v", c.q))
- if v, ok := c.opt_["c2coff"]; ok {
- params.Set("c2coff", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["cr"]; ok {
- params.Set("cr", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["cref"]; ok {
- params.Set("cref", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["cx"]; ok {
- params.Set("cx", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["dateRestrict"]; ok {
- params.Set("dateRestrict", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["exactTerms"]; ok {
- params.Set("exactTerms", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["excludeTerms"]; ok {
- params.Set("excludeTerms", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fileType"]; ok {
- params.Set("fileType", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["gl"]; ok {
- params.Set("gl", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["googlehost"]; ok {
- params.Set("googlehost", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["highRange"]; ok {
- params.Set("highRange", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["hl"]; ok {
- params.Set("hl", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["hq"]; ok {
- params.Set("hq", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["imgColorType"]; ok {
- params.Set("imgColorType", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["imgDominantColor"]; ok {
- params.Set("imgDominantColor", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["imgSize"]; ok {
- params.Set("imgSize", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["imgType"]; ok {
- params.Set("imgType", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["linkSite"]; ok {
- params.Set("linkSite", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["lowRange"]; ok {
- params.Set("lowRange", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["lr"]; ok {
- params.Set("lr", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["num"]; ok {
- params.Set("num", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orTerms"]; ok {
- params.Set("orTerms", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["relatedSite"]; ok {
- params.Set("relatedSite", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["rights"]; ok {
- params.Set("rights", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["safe"]; ok {
- params.Set("safe", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchType"]; ok {
- params.Set("searchType", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["siteSearch"]; ok {
- params.Set("siteSearch", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["siteSearchFilter"]; ok {
- params.Set("siteSearchFilter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sort"]; ok {
- params.Set("sort", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["start"]; ok {
- params.Set("start", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "search.cse.list" call.
-// Exactly one of *Search or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Search.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *CseListCall) Do() (*Search, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Search{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns metadata about the search performed, metadata about the custom search engine used for the search, and the search results.",
- // "httpMethod": "GET",
- // "id": "search.cse.list",
- // "parameterOrder": [
- // "q"
- // ],
- // "parameters": {
- // "c2coff": {
- // "description": "Turns off the translation between zh-CN and zh-TW.",
- // "location": "query",
- // "type": "string"
- // },
- // "cr": {
- // "description": "Country restrict(s).",
- // "location": "query",
- // "type": "string"
- // },
- // "cref": {
- // "description": "The URL of a linked custom search engine",
- // "location": "query",
- // "type": "string"
- // },
- // "cx": {
- // "description": "The custom search engine ID to scope this search query",
- // "location": "query",
- // "type": "string"
- // },
- // "dateRestrict": {
- // "description": "Specifies all search results are from a time period",
- // "location": "query",
- // "type": "string"
- // },
- // "exactTerms": {
- // "description": "Identifies a phrase that all documents in the search results must contain",
- // "location": "query",
- // "type": "string"
- // },
- // "excludeTerms": {
- // "description": "Identifies a word or phrase that should not appear in any documents in the search results",
- // "location": "query",
- // "type": "string"
- // },
- // "fileType": {
- // "description": "Returns images of a specified type. Some of the allowed values are: bmp, gif, png, jpg, svg, pdf, ...",
- // "location": "query",
- // "type": "string"
- // },
- // "filter": {
- // "description": "Controls turning on or off the duplicate content filter.",
- // "enum": [
- // "0",
- // "1"
- // ],
- // "enumDescriptions": [
- // "Turns off duplicate content filter.",
- // "Turns on duplicate content filter."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "gl": {
- // "description": "Geolocation of end user.",
- // "location": "query",
- // "type": "string"
- // },
- // "googlehost": {
- // "description": "The local Google domain to use to perform the search.",
- // "location": "query",
- // "type": "string"
- // },
- // "highRange": {
- // "description": "Creates a range in form as_nlo value..as_nhi value and attempts to append it to query",
- // "location": "query",
- // "type": "string"
- // },
- // "hl": {
- // "description": "Sets the user interface language.",
- // "location": "query",
- // "type": "string"
- // },
- // "hq": {
- // "description": "Appends the extra query terms to the query.",
- // "location": "query",
- // "type": "string"
- // },
- // "imgColorType": {
- // "description": "Returns black and white, grayscale, or color images: mono, gray, and color.",
- // "enum": [
- // "color",
- // "gray",
- // "mono"
- // ],
- // "enumDescriptions": [
- // "color",
- // "gray",
- // "mono"
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "imgDominantColor": {
- // "description": "Returns images of a specific dominant color: yellow, green, teal, blue, purple, pink, white, gray, black and brown.",
- // "enum": [
- // "black",
- // "blue",
- // "brown",
- // "gray",
- // "green",
- // "pink",
- // "purple",
- // "teal",
- // "white",
- // "yellow"
- // ],
- // "enumDescriptions": [
- // "black",
- // "blue",
- // "brown",
- // "gray",
- // "green",
- // "pink",
- // "purple",
- // "teal",
- // "white",
- // "yellow"
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "imgSize": {
- // "description": "Returns images of a specified size, where size can be one of: icon, small, medium, large, xlarge, xxlarge, and huge.",
- // "enum": [
- // "huge",
- // "icon",
- // "large",
- // "medium",
- // "small",
- // "xlarge",
- // "xxlarge"
- // ],
- // "enumDescriptions": [
- // "huge",
- // "icon",
- // "large",
- // "medium",
- // "small",
- // "xlarge",
- // "xxlarge"
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "imgType": {
- // "description": "Returns images of a type, which can be one of: clipart, face, lineart, news, and photo.",
- // "enum": [
- // "clipart",
- // "face",
- // "lineart",
- // "news",
- // "photo"
- // ],
- // "enumDescriptions": [
- // "clipart",
- // "face",
- // "lineart",
- // "news",
- // "photo"
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "linkSite": {
- // "description": "Specifies that all search results should contain a link to a particular URL",
- // "location": "query",
- // "type": "string"
- // },
- // "lowRange": {
- // "description": "Creates a range in form as_nlo value..as_nhi value and attempts to append it to query",
- // "location": "query",
- // "type": "string"
- // },
- // "lr": {
- // "description": "The language restriction for the search results",
- // "enum": [
- // "lang_ar",
- // "lang_bg",
- // "lang_ca",
- // "lang_cs",
- // "lang_da",
- // "lang_de",
- // "lang_el",
- // "lang_en",
- // "lang_es",
- // "lang_et",
- // "lang_fi",
- // "lang_fr",
- // "lang_hr",
- // "lang_hu",
- // "lang_id",
- // "lang_is",
- // "lang_it",
- // "lang_iw",
- // "lang_ja",
- // "lang_ko",
- // "lang_lt",
- // "lang_lv",
- // "lang_nl",
- // "lang_no",
- // "lang_pl",
- // "lang_pt",
- // "lang_ro",
- // "lang_ru",
- // "lang_sk",
- // "lang_sl",
- // "lang_sr",
- // "lang_sv",
- // "lang_tr",
- // "lang_zh-CN",
- // "lang_zh-TW"
- // ],
- // "enumDescriptions": [
- // "Arabic",
- // "Bulgarian",
- // "Catalan",
- // "Czech",
- // "Danish",
- // "German",
- // "Greek",
- // "English",
- // "Spanish",
- // "Estonian",
- // "Finnish",
- // "French",
- // "Croatian",
- // "Hungarian",
- // "Indonesian",
- // "Icelandic",
- // "Italian",
- // "Hebrew",
- // "Japanese",
- // "Korean",
- // "Lithuanian",
- // "Latvian",
- // "Dutch",
- // "Norwegian",
- // "Polish",
- // "Portuguese",
- // "Romanian",
- // "Russian",
- // "Slovak",
- // "Slovenian",
- // "Serbian",
- // "Swedish",
- // "Turkish",
- // "Chinese (Simplified)",
- // "Chinese (Traditional)"
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "num": {
- // "default": "10",
- // "description": "Number of search results to return",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // },
- // "orTerms": {
- // "description": "Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms",
- // "location": "query",
- // "type": "string"
- // },
- // "q": {
- // "description": "Query",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "relatedSite": {
- // "description": "Specifies that all search results should be pages that are related to the specified URL",
- // "location": "query",
- // "type": "string"
- // },
- // "rights": {
- // "description": "Filters based on licensing. Supported values include: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and combinations of these.",
- // "location": "query",
- // "type": "string"
- // },
- // "safe": {
- // "default": "off",
- // "description": "Search safety level",
- // "enum": [
- // "high",
- // "medium",
- // "off"
- // ],
- // "enumDescriptions": [
- // "Enables highest level of safe search filtering.",
- // "Enables moderate safe search filtering.",
- // "Disables safe search filtering."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "searchType": {
- // "description": "Specifies the search type: image.",
- // "enum": [
- // "image"
- // ],
- // "enumDescriptions": [
- // "custom image search"
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "siteSearch": {
- // "description": "Specifies all search results should be pages from a given site",
- // "location": "query",
- // "type": "string"
- // },
- // "siteSearchFilter": {
- // "description": "Controls whether to include or exclude results from the site named in the as_sitesearch parameter",
- // "enum": [
- // "e",
- // "i"
- // ],
- // "enumDescriptions": [
- // "exclude",
- // "include"
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sort": {
- // "description": "The sort expression to apply to the results",
- // "location": "query",
- // "type": "string"
- // },
- // "start": {
- // "description": "The index of the first result to return",
- // "format": "uint32",
- // "location": "query",
- // "type": "integer"
- // }
- // },
- // "path": "v1",
- // "response": {
- // "$ref": "Search"
- // }
- // }
-
-}
diff --git a/vendor/google.golang.org/api/dataflow/v1b3/dataflow-api.json b/vendor/google.golang.org/api/dataflow/v1b3/dataflow-api.json
deleted file mode 100644
index 91f6b998..00000000
--- a/vendor/google.golang.org/api/dataflow/v1b3/dataflow-api.json
+++ /dev/null
@@ -1,2368 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/5KuD_AhxWtT--XElMYogfy5V-SU\"",
- "discoveryVersion": "v1",
- "id": "dataflow:v1b3",
- "name": "dataflow",
- "version": "v1b3",
- "revision": "20150401",
- "title": "Google Dataflow API",
- "description": "Google Dataflow API.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/dataflow",
- "protocol": "rest",
- "baseUrl": "https://dataflow.googleapis.com/",
- "basePath": "/",
- "rootUrl": "https://dataflow.googleapis.com/",
- "servicePath": "",
- "batchPath": "batch",
- "parameters": {
- "access_token": {
- "type": "string",
- "description": "OAuth access token.",
- "location": "query"
- },
- "alt": {
- "type": "string",
- "description": "Data format for response.",
- "default": "json",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "bearer_token": {
- "type": "string",
- "description": "OAuth bearer token.",
- "location": "query"
- },
- "callback": {
- "type": "string",
- "description": "JSONP",
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "pp": {
- "type": "boolean",
- "description": "Pretty-print response.",
- "default": "true",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "location": "query"
- },
- "upload_protocol": {
- "type": "string",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "location": "query"
- },
- "uploadType": {
- "type": "string",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query"
- },
- "$.xgafv": {
- "type": "string",
- "description": "V1 error format.",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/userinfo.email": {
- "description": "View your email address"
- }
- }
- }
- },
- "schemas": {
- "Job": {
- "id": "Job",
- "type": "object",
- "description": "Defines a job to be run by the Dataflow service.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The unique ID of this job. This field is set by the Dataflow service when the Job is created, and is immutable for the life of the Job."
- },
- "projectId": {
- "type": "string",
- "description": "The project which owns the job."
- },
- "name": {
- "type": "string",
- "description": "The user-specified Dataflow job name. Only one Job with a given name may exist in a project at any given time. If a caller attempts to create a Job with the same name as an already-existing Job, the attempt will return the existing Job. The name must match the regular expression [a-z]([-a-z0-9]{0,38}[a-z0-9])?"
- },
- "type": {
- "type": "string",
- "description": "The type of dataflow job.",
- "enum": [
- "JOB_TYPE_UNKNOWN",
- "JOB_TYPE_BATCH",
- "JOB_TYPE_STREAMING"
- ]
- },
- "environment": {
- "$ref": "Environment",
- "description": "Environment for the job."
- },
- "steps": {
- "type": "array",
- "description": "The top-level steps that constitute the entire job.",
- "items": {
- "$ref": "Step"
- }
- },
- "currentState": {
- "type": "string",
- "description": "The current state of the job. Jobs are created in the JOB_STATE_STOPPED state unless otherwise specified. A job in the JOB_STATE_RUNNING state may asynchronously enter a terminal state. Once a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Dataflow service; callers cannot mutate it.",
- "enum": [
- "JOB_STATE_UNKNOWN",
- "JOB_STATE_STOPPED",
- "JOB_STATE_RUNNING",
- "JOB_STATE_DONE",
- "JOB_STATE_FAILED",
- "JOB_STATE_CANCELLED",
- "JOB_STATE_UPDATED"
- ]
- },
- "currentStateTime": {
- "type": "string",
- "description": "The timestamp associated with the current state."
- },
- "requestedState": {
- "type": "string",
- "description": "The job's requested state. UpdateJob may be used to switch between the JOB_STATE_STOPPED and JOB_STATE_RUNNING states, by setting requested_state. UpdateJob may also be used to directly set a job's requested state to JOB_STATE_CANCELLED or JOB_STATE_DONE, irrevocably terminating the job if it has not already reached a terminal state.",
- "enum": [
- "JOB_STATE_UNKNOWN",
- "JOB_STATE_STOPPED",
- "JOB_STATE_RUNNING",
- "JOB_STATE_DONE",
- "JOB_STATE_FAILED",
- "JOB_STATE_CANCELLED",
- "JOB_STATE_UPDATED"
- ]
- },
- "executionInfo": {
- "$ref": "JobExecutionInfo",
- "description": "Information about how the Dataflow service will actually run the job."
- },
- "createTime": {
- "type": "string",
- "description": "Timestamp when job was initially created. Immutable, set by the Dataflow service."
- },
- "replaceJobId": {
- "type": "string",
- "description": "If this job is an update of an existing job, this field will be the ID of the job it replaced. When sending a CreateJobRequest, you can update a job by specifying it here. The job named here will be stopped, and its intermediate state transferred to this job."
- },
- "transformNameMapping": {
- "type": "object",
- "description": "Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.",
- "additionalProperties": {
- "type": "string"
- }
- },
- "clientRequestId": {
- "type": "string",
- "description": "Client's unique identifier of the job, re-used by SDK across retried attempts. If this field is set, the service will ensure its uniqueness. That is, the request to create a job will fail if the service has knowledge of a previously submitted job with the same client's id and job name. The caller may, for example, use this field to ensure idempotence of job creation across retried attempts to create a job. By default, the field is empty and, in that case, the service ignores it."
- },
- "replacedByJobId": {
- "type": "string",
- "description": "If another job is an update of this job (and thus, this job is in JOB_STATE_UPDATED), this field will contain the ID of that job."
- }
- }
- },
- "Environment": {
- "id": "Environment",
- "type": "object",
- "description": "Describes the environment in which a Dataflow Job runs.",
- "properties": {
- "tempStoragePrefix": {
- "type": "string",
- "description": "The prefix of the resources the system should use for temporary storage. The system will append the suffix \"/temp-{JOBNAME} to this resource prefix, where {JOBNAME} is the value of the job_name field. The resulting bucket and object prefix is used as the prefix of the resources used to store temporary data needed during the job execution. NOTE: This will override the value in taskrunner_settings. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}"
- },
- "clusterManagerApiService": {
- "type": "string",
- "description": "The type of cluster manager API to use. If unknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. \"compute.googleapis.com\"."
- },
- "experiments": {
- "type": "array",
- "description": "The list of experiments to enable.",
- "items": {
- "type": "string"
- }
- },
- "workerPools": {
- "type": "array",
- "description": "Worker pools. At least one \"harness\" worker pool must be specified in order for the job to have workers.",
- "items": {
- "$ref": "WorkerPool"
- }
- },
- "userAgent": {
- "type": "object",
- "description": "A description of the process that generated the request.",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- }
- },
- "version": {
- "type": "object",
- "description": "A structure describing which components and their versions of the service are required in order to run the job.",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- }
- },
- "dataset": {
- "type": "string",
- "description": "The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset}"
- },
- "sdkPipelineOptions": {
- "type": "object",
- "description": "The Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way.",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- }
- },
- "internalExperiments": {
- "type": "object",
- "description": "Experimental settings.",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @ype with type URL."
- }
- }
- }
- },
- "WorkerPool": {
- "id": "WorkerPool",
- "type": "object",
- "description": "Describes one particular pool of Dataflow workers to be instantiated by the Dataflow service in order to perform the computations required by a job. Note that a workflow job may use multiple pools, in order to match the various computational requirements of the various stages of the job.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "The kind of the worker pool; currently only 'harness' and 'shuffle' are supported."
- },
- "numWorkers": {
- "type": "integer",
- "description": "Number of Google Compute Engine workers in this pool needed to execute the job. If zero or unspecified, the service will attempt to choose a reasonable default.",
- "format": "int32"
- },
- "packages": {
- "type": "array",
- "description": "Packages to be installed on workers.",
- "items": {
- "$ref": "Package"
- }
- },
- "defaultPackageSet": {
- "type": "string",
- "description": "The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language.",
- "enum": [
- "DEFAULT_PACKAGE_SET_UNKNOWN",
- "DEFAULT_PACKAGE_SET_NONE",
- "DEFAULT_PACKAGE_SET_JAVA",
- "DEFAULT_PACKAGE_SET_PYTHON"
- ]
- },
- "machineType": {
- "type": "string",
- "description": "Machine type (e.g. \"n1-standard-1\"). If empty or unspecified, the service will attempt to choose a reasonable default."
- },
- "teardownPolicy": {
- "type": "string",
- "description": "Sets the policy for determining when to turndown worker pool. Allowed values are: TEARDOWN_ALWAYS, TEARDOWN_ON_SUCCESS, and TEARDOWN_NEVER. TEARDOWN_ALWAYS means workers are always torn down regardless of whether the job succeeds. TEARDOWN_ON_SUCCESS means workers are torn down if the job succeeds. TEARDOWN_NEVER means the workers are never torn down. If the workers are not torn down by the service, they will continue to run and use Google Compute Engine VM resources in the user's project until they are explicitly terminated by the user. Because of this, Google recommends using the TEARDOWN_ALWAYS policy except for small, manually supervised test jobs. If unknown or unspecified, the service will attempt to choose a reasonable default.",
- "enum": [
- "TEARDOWN_POLICY_UNKNOWN",
- "TEARDOWN_ALWAYS",
- "TEARDOWN_ON_SUCCESS",
- "TEARDOWN_NEVER"
- ]
- },
- "diskSizeGb": {
- "type": "integer",
- "description": "Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.",
- "format": "int32"
- },
- "diskType": {
- "type": "string",
- "description": "Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default."
- },
- "diskSourceImage": {
- "type": "string",
- "description": "Fully qualified source image for disks."
- },
- "zone": {
- "type": "string",
- "description": "Zone to run the worker pools in (e.g. \"us-central1-b\"). If empty or unspecified, the service will attempt to choose a reasonable default."
- },
- "taskrunnerSettings": {
- "$ref": "TaskRunnerSettings",
- "description": "Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field."
- },
- "onHostMaintenance": {
- "type": "string",
- "description": "The action to take on host maintenance, as defined by the Google Compute Engine API."
- },
- "dataDisks": {
- "type": "array",
- "description": "Data disks that are used by a VM in this workflow.",
- "items": {
- "$ref": "Disk"
- }
- },
- "metadata": {
- "type": "object",
- "description": "Metadata to set on the Google Compute Engine VMs.",
- "additionalProperties": {
- "type": "string"
- }
- },
- "autoscalingSettings": {
- "$ref": "AutoscalingSettings",
- "description": "Settings for autoscaling of this WorkerPool."
- },
- "poolArgs": {
- "type": "object",
- "description": "Extra arguments for this worker pool.",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @ype with type URL."
- }
- },
- "network": {
- "type": "string",
- "description": "Network to which VMs will be assigned. If empty or unspecified, the service will use the network \"default\"."
- }
- }
- },
- "Package": {
- "id": "Package",
- "type": "object",
- "description": "Packages that need to be installed in order for a worker to run the steps of the Dataflow job which will be assigned to its worker pool. This is the mechanism by which the SDK causes code to be loaded onto the workers. For example, the Dataflow Java SDK might use this to install jars containing the user's code and all of the various dependencies (libraries, data files, etc) required in order for that code to run.",
- "properties": {
- "name": {
- "type": "string",
- "description": "The name of the package."
- },
- "location": {
- "type": "string",
- "description": "The resource to read the package from. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket} bucket.storage.googleapis.com/"
- }
- }
- },
- "TaskRunnerSettings": {
- "id": "TaskRunnerSettings",
- "type": "object",
- "description": "Taskrunner configuration settings.",
- "properties": {
- "taskUser": {
- "type": "string",
- "description": "The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. \"root\"."
- },
- "taskGroup": {
- "type": "string",
- "description": "The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. \"wheel\"."
- },
- "oauthScopes": {
- "type": "array",
- "description": "OAuth2 scopes to be requested by the taskrunner in order to access the dataflow API.",
- "items": {
- "type": "string"
- }
- },
- "baseUrl": {
- "type": "string",
- "description": "The base URL for the taskrunner to use when accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, \"Relative Uniform Resource Locators\". If not specified, the default value is \"http://www.googleapis.com/\""
- },
- "dataflowApiVersion": {
- "type": "string",
- "description": "API version of endpoint, e.g. \"v1b3\""
- },
- "parallelWorkerSettings": {
- "$ref": "WorkerSettings",
- "description": "Settings to pass to the parallel worker harness."
- },
- "baseTaskDir": {
- "type": "string",
- "description": "Location on the worker for task-specific subdirectories."
- },
- "continueOnException": {
- "type": "boolean",
- "description": "Do we continue taskrunner if an exception is hit?"
- },
- "logToSerialconsole": {
- "type": "boolean",
- "description": "Send taskrunner log into to Google Compute Engine VM serial console?"
- },
- "alsologtostderr": {
- "type": "boolean",
- "description": "Also send taskrunner log info to stderr?"
- },
- "logUploadLocation": {
- "type": "string",
- "description": "Indicates where to put logs. If this is not specified, the logs will not be uploaded. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}"
- },
- "logDir": {
- "type": "string",
- "description": "Directory on the VM to store logs."
- },
- "tempStoragePrefix": {
- "type": "string",
- "description": "The prefix of the resources the taskrunner should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}"
- },
- "harnessCommand": {
- "type": "string",
- "description": "Command to launch the worker harness."
- },
- "workflowFileName": {
- "type": "string",
- "description": "Store the workflow in this file."
- },
- "commandlinesFileName": {
- "type": "string",
- "description": "Store preprocessing commands in this file."
- },
- "vmId": {
- "type": "string",
- "description": "ID string of VM."
- },
- "languageHint": {
- "type": "string",
- "description": "Suggested backend language."
- },
- "streamingWorkerMainClass": {
- "type": "string",
- "description": "Streaming worker main class name."
- }
- }
- },
- "WorkerSettings": {
- "id": "WorkerSettings",
- "type": "object",
- "description": "Provides data to pass through to the worker harness.",
- "properties": {
- "baseUrl": {
- "type": "string",
- "description": "The base URL for accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, \"Relative Uniform Resource Locators\". If not specified, the default value is \"http://www.googleapis.com/\""
- },
- "reportingEnabled": {
- "type": "boolean",
- "description": "Send work progress updates to service."
- },
- "servicePath": {
- "type": "string",
- "description": "The Dataflow service path relative to the root URL, for example, \"dataflow/v1b3/projects\"."
- },
- "shuffleServicePath": {
- "type": "string",
- "description": "The Shuffle service path relative to the root URL, for example, \"shuffle/v1beta1\"."
- },
- "workerId": {
- "type": "string",
- "description": "ID of the worker running this pipeline."
- },
- "tempStoragePrefix": {
- "type": "string",
- "description": "The prefix of the resources the system should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}"
- }
- }
- },
- "Disk": {
- "id": "Disk",
- "type": "object",
- "description": "Describes the data disk used by a workflow job.",
- "properties": {
- "sizeGb": {
- "type": "integer",
- "description": "Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default.",
- "format": "int32"
- },
- "diskType": {
- "type": "string",
- "description": "Disk storage type, as defined by Google Compute Engine. This must be a disk type appropriate to the project and zone in which the workers will run. If unknown or unspecified, the service will attempt to choose a reasonable default. For example, the standard persistent disk type is a resource name typically ending in \"pd-standard\". If SSD persistent disks are available, the resource name typically ends with \"pd-ssd\". The actual valid values are defined the Google Compute Engine API, not by the Dataflow API; consult the Google Compute Engine documentation for more information about determining the set of available disk types for a particular project and zone. Google Compute Engine Disk types are local to a particular project in a particular zone, and so the resource name will typically look something like this: compute.googleapis.com/projects/\n/zones//diskTypes/pd-standard"
- },
- "mountPoint": {
- "type": "string",
- "description": "Directory in a VM where disk is mounted."
- }
- }
- },
- "AutoscalingSettings": {
- "id": "AutoscalingSettings",
- "type": "object",
- "description": "Settings for WorkerPool autoscaling.",
- "properties": {
- "algorithm": {
- "type": "string",
- "description": "The algorithm to use for autoscaling.",
- "enum": [
- "AUTOSCALING_ALGORITHM_UNKNOWN",
- "AUTOSCALING_ALGORITHM_NONE",
- "AUTOSCALING_ALGORITHM_BASIC"
- ]
- },
- "maxNumWorkers": {
- "type": "integer",
- "description": "The maximum number of workers to cap scaling at.",
- "format": "int32"
- }
- }
- },
- "Step": {
- "id": "Step",
- "type": "object",
- "description": "Defines a particular step within a Dataflow job. A job consists of multiple steps, each of which performs some specific operation as part of the overall job. Data is typically passed from one step to another as part of the job. Here's an example of a sequence of steps which together implement a Map-Reduce job: * Read a collection of data from some source, parsing the collection's elements. * Validate the elements. * Apply a user-defined function to map each element to some value and extract an element-specific key value. * Group elements with the same key into a single element with that key, transforming a multiply-keyed collection into a uniquely-keyed collection. * Write the elements out to some data sink. (Note that the Dataflow service may be used to run many different types of jobs, not just Map-Reduce).",
- "properties": {
- "kind": {
- "type": "string",
- "description": "The kind of step in the dataflow Job."
- },
- "name": {
- "type": "string",
- "description": "Name identifying the step. This must be unique for each step with respect to all other steps in the dataflow Job."
- },
- "properties": {
- "type": "object",
- "description": "Named properties associated with the step. Each kind of predefined step has its own required set of properties.",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- }
- }
- }
- },
- "JobExecutionInfo": {
- "id": "JobExecutionInfo",
- "type": "object",
- "description": "Additional information about how a Dataflow job will be executed which isn’t contained in the submitted job.",
- "properties": {
- "stages": {
- "type": "object",
- "description": "A mapping from each stage to the information about that stage.",
- "additionalProperties": {
- "$ref": "JobExecutionStageInfo"
- }
- }
- }
- },
- "JobExecutionStageInfo": {
- "id": "JobExecutionStageInfo",
- "type": "object",
- "description": "Contains information about how a particular [google.dataflow.v1beta3.Step][google.dataflow.v1beta3.Step] will be executed.",
- "properties": {
- "stepName": {
- "type": "array",
- "description": "The steps associated with the execution stage. Note that stages may have several steps, and that a given step might be run by more than one stage.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "ListJobsResponse": {
- "id": "ListJobsResponse",
- "type": "object",
- "description": "Response to a request to list Dataflow jobs. This may be a partial response, depending on the page size in the ListJobsRequest.",
- "properties": {
- "jobs": {
- "type": "array",
- "description": "A subset of the requested job information.",
- "items": {
- "$ref": "Job"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "Set if there may be more results than fit in this response."
- }
- }
- },
- "ListJobMessagesResponse": {
- "id": "ListJobMessagesResponse",
- "type": "object",
- "description": "Response to a request to list job messages.",
- "properties": {
- "jobMessages": {
- "type": "array",
- "description": "Messages in ascending timestamp order.",
- "items": {
- "$ref": "JobMessage"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "The token to obtain the next page of results if there are more."
- }
- }
- },
- "JobMessage": {
- "id": "JobMessage",
- "type": "object",
- "description": "A particular message pertaining to a Dataflow job.",
- "properties": {
- "id": {
- "type": "string",
- "description": "Identifies the message. This is automatically generated by the service; the caller should treat it as an opaque string."
- },
- "time": {
- "type": "string",
- "description": "The timestamp of the message."
- },
- "messageText": {
- "type": "string",
- "description": "The text of the message."
- },
- "messageImportance": {
- "type": "string",
- "description": "Importance level of the message.",
- "enum": [
- "JOB_MESSAGE_IMPORTANCE_UNKNOWN",
- "JOB_MESSAGE_DEBUG",
- "JOB_MESSAGE_DETAILED",
- "JOB_MESSAGE_BASIC",
- "JOB_MESSAGE_WARNING",
- "JOB_MESSAGE_ERROR"
- ]
- }
- }
- },
- "JobMetrics": {
- "id": "JobMetrics",
- "type": "object",
- "description": "JobMetrics contains a collection of metrics descibing the detailed progress of a Dataflow job. Metrics correspond to user-defined and system-defined metrics in the job. This resource captures only the most recent values of each metric; time-series data can be queried for them (under the same metric names) from Cloud Monitoring.",
- "properties": {
- "metricTime": {
- "type": "string",
- "description": "Timestamp as of which metric values are current."
- },
- "metrics": {
- "type": "array",
- "description": "All metrics for this job.",
- "items": {
- "$ref": "MetricUpdate"
- }
- }
- }
- },
- "MetricUpdate": {
- "id": "MetricUpdate",
- "type": "object",
- "description": "Describes the state of a metric.",
- "properties": {
- "name": {
- "$ref": "MetricStructuredName",
- "description": "Name of the metric."
- },
- "kind": {
- "type": "string",
- "description": "Metric aggregation kind. The possible metric aggregation kinds are \"Sum\", \"Max\", \"Min\", \"Mean\", \"Set\", \"And\", and \"Or\". The specified aggregation kind is case-insensitive. If omitted, this is not an aggregated value but instead a single metric sample value."
- },
- "cumulative": {
- "type": "boolean",
- "description": "True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this metric is reported as a delta that is not associated with any WorkItem."
- },
- "scalar": {
- "type": "any",
- "description": "Worker-computed aggregate value for aggregation kinds \"Sum\", \"Max\", \"Min\", \"And\", and \"Or\". The possible value types are Long, Double, and Boolean."
- },
- "meanSum": {
- "type": "any",
- "description": "Worker-computed aggregate value for the \"Mean\" aggregation kind. This holds the sum of the aggregated values and is used in combination with mean_count below to obtain the actual mean aggregate value. The only possible value types are Long and Double."
- },
- "meanCount": {
- "type": "any",
- "description": "Worker-computed aggregate value for the \"Mean\" aggregation kind. This holds the count of the aggregated values and is used in combination with mean_sum above to obtain the actual mean aggregate value. The only possible value type is Long."
- },
- "set": {
- "type": "any",
- "description": "Worker-computed aggregate value for the \"Set\" aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, or String, according to the metric's type. All Values in the list must be of the same type."
- },
- "internal": {
- "type": "any",
- "description": "Worker-computed aggregate value for internal use by the Dataflow service."
- },
- "updateTime": {
- "type": "string",
- "description": "Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API."
- }
- }
- },
- "MetricStructuredName": {
- "id": "MetricStructuredName",
- "type": "object",
- "description": "Identifies a metric, by describing the source which generated the metric.",
- "properties": {
- "origin": {
- "type": "string",
- "description": "Origin (namespace) of metric name. May be blank for user-define metrics; will be \"dataflow\" for metrics defined by the Dataflow service or SDK."
- },
- "name": {
- "type": "string",
- "description": "Worker-defined metric name."
- },
- "context": {
- "type": "object",
- "description": "Zero or more labeled fields which identify the part of the job this metric is associated with, such as the name of a step or collection. For example, built-in counters associated with steps will have context['step'] = . Counters associated with PCollections in the SDK will have context['pcollection'] =\n.",
- "additionalProperties": {
- "type": "string"
- }
- }
- }
- },
- "ReportWorkItemStatusRequest": {
- "id": "ReportWorkItemStatusRequest",
- "type": "object",
- "description": "Request to report the status of WorkItems.",
- "properties": {
- "workerId": {
- "type": "string",
- "description": "The ID of the worker reporting the WorkItem status. If this does not match the ID of the worker which the Dataflow service believes currently has the lease on the WorkItem, the report will be dropped (with an error response)."
- },
- "workItemStatuses": {
- "type": "array",
- "description": "The order is unimportant, except that the order of the WorkItemServiceState messages in the ReportWorkItemStatusResponse corresponds to the order of WorkItemStatus messages here.",
- "items": {
- "$ref": "WorkItemStatus"
- }
- },
- "currentWorkerTime": {
- "type": "string",
- "description": "The current timestamp at the worker."
- }
- }
- },
- "WorkItemStatus": {
- "id": "WorkItemStatus",
- "type": "object",
- "description": "Conveys a worker's progress through the work described by a WorkItem.",
- "properties": {
- "workItemId": {
- "type": "string",
- "description": "Identifies the WorkItem."
- },
- "reportIndex": {
- "type": "string",
- "description": "The report index. When a WorkItem is leased, the lease will contain an initial report index. When a WorkItem's status is reported to the system, the report should be sent with that report index, and the response will contain the index the worker should use for the next report. Reports received with unexpected index values will be rejected by the service. In order to preserve idempotency, the worker should not alter the contents of a report, even if the worker must submit the same report multiple times before getting back a response. The worker should not submit a subsequent report until the response for the previous report had been received from the service.",
- "format": "int64"
- },
- "requestedLeaseDuration": {
- "type": "string",
- "description": "Amount of time the worker requests for its lease."
- },
- "completed": {
- "type": "boolean",
- "description": "True if the WorkItem was completed (successfully or unsuccessfully)."
- },
- "errors": {
- "type": "array",
- "description": "Specifies errors which occurred during processing. If errors are provided, and completed = true, then the WorkItem is considered to have failed.",
- "items": {
- "$ref": "Status"
- }
- },
- "metricUpdates": {
- "type": "array",
- "description": "Worker output metrics (counters) for this WorkItem.",
- "items": {
- "$ref": "MetricUpdate"
- }
- },
- "progress": {
- "$ref": "ApproximateProgress",
- "description": "The WorkItem's approximate progress."
- },
- "stopPosition": {
- "$ref": "Position",
- "description": "A worker may split an active map task in two parts, \"primary\" and \"residual\", continuing to process the primary part and returning the residual part into the pool of available work. This event is called a \"dynamic split\" and is critical to the dynamic work rebalancing feature. The two obtained sub-tasks are called \"parts\" of the split. The parts, if concatenated, must represent the same input as would be read by the current task if the split did not happen. The exact way in which the original task is decomposed into the two parts is specified either as a position demarcating them (stop_position), or explicitly as two DerivedSources, if this task consumes a user-defined source type (dynamic_source_split). The \"current\" task is adjusted as a result of the split: after a task with range [A, B) sends a stop_position update at C, its range is considered to be [A, C), e.g.: * Progress should be interpreted relative to the new range, e.g. \"75% completed\" means \"75% of [A, C) completed\" * The worker should interpret proposed_stop_position relative to the new range, e.g. \"split at 68%\" should be interpreted as \"split at 68% of [A, C)\". * If the worker chooses to split again using stop_position, only stop_positions in [A, C) will be accepted. * Etc. dynamic_source_split has similar semantics: e.g., if a task with source S splits using dynamic_source_split into {P, R} (where P and R must be together equivalent to S), then subsequent progress and proposed_stop_position should be interpreted relative to P, and in a potential subsequent dynamic_source_split into {P', R'}, P' and R' must be together equivalent to P, etc."
- },
- "dynamicSourceSplit": {
- "$ref": "DynamicSourceSplit",
- "description": "See documentation of stop_position."
- },
- "sourceOperationResponse": {
- "$ref": "SourceOperationResponse",
- "description": "If the work item represented a SourceOperationRequest, and the work is completed, contains the result of the operation."
- },
- "sourceFork": {
- "$ref": "SourceFork",
- "description": "DEPRECATED in favor of dynamic_source_split."
- }
- }
- },
- "Status": {
- "id": "Status",
- "type": "object",
- "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.",
- "properties": {
- "code": {
- "type": "integer",
- "description": "The status code, which should be an enum value of [google.rpc.Code][].",
- "format": "int32"
- },
- "message": {
- "type": "string",
- "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client."
- },
- "details": {
- "type": "array",
- "description": "A list of messages that carry the error details. There will be a common set of message types for APIs to use.",
- "items": {
- "type": "object",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @ype with type URL."
- }
- }
- }
- }
- },
- "ApproximateProgress": {
- "id": "ApproximateProgress",
- "type": "object",
- "description": "A progress measurement of a WorkItem by a worker.",
- "properties": {
- "position": {
- "$ref": "Position",
- "description": "A Position within the work to represent a progress."
- },
- "percentComplete": {
- "type": "number",
- "description": "Completion as percentage of the work, from 0.0 (beginning, nothing complete), to 1.0 (end of the work range, entire WorkItem complete).",
- "format": "float"
- },
- "remainingTime": {
- "type": "string",
- "description": "Completion as an estimated time remaining."
- }
- }
- },
- "Position": {
- "id": "Position",
- "type": "object",
- "description": "Position defines a position within a collection of data. The value can be either the end position, a key (used with ordered collections), a byte offset, or a record index.",
- "properties": {
- "end": {
- "type": "boolean",
- "description": "Position is past all other positions. Also useful for the end position of an unbounded range."
- },
- "key": {
- "type": "string",
- "description": "Position is a string key, ordered lexicographically."
- },
- "byteOffset": {
- "type": "string",
- "description": "Position is a byte offset.",
- "format": "int64"
- },
- "recordIndex": {
- "type": "string",
- "description": "Position is a record index.",
- "format": "int64"
- },
- "shufflePosition": {
- "type": "string",
- "description": "CloudPosition is a base64 encoded BatchShufflePosition (with FIXED sharding)."
- },
- "concatPosition": {
- "$ref": "ConcatPosition",
- "description": "CloudPosition is a concat position."
- }
- }
- },
- "ConcatPosition": {
- "id": "ConcatPosition",
- "type": "object",
- "description": "A position that encapsulates an inner position and an index for the inner position. A ConcatPosition can be used by a reader of a source that encapsulates a set of other sources.",
- "properties": {
- "index": {
- "type": "integer",
- "description": "Index of the inner source.",
- "format": "int32"
- },
- "position": {
- "$ref": "Position",
- "description": "Position within the inner source."
- }
- }
- },
- "DynamicSourceSplit": {
- "id": "DynamicSourceSplit",
- "type": "object",
- "description": "When a task splits using WorkItemStatus.dynamic_source_split, this message describes the two parts of the split relative to the description of the current task's input.",
- "properties": {
- "primary": {
- "$ref": "DerivedSource",
- "description": "Primary part (continued to be processed by worker). Specified relative to the previously-current source. Becomes current."
- },
- "residual": {
- "$ref": "DerivedSource",
- "description": "Residual part (returned to the pool of work). Specified relative to the previously-current source."
- }
- }
- },
- "DerivedSource": {
- "id": "DerivedSource",
- "type": "object",
- "description": "Specification of one of the bundles produced as a result of splitting a Source (e.g. when executing a SourceSplitRequest, or when splitting an active task using WorkItemStatus.dynamic_source_split), relative to the source being split.",
- "properties": {
- "source": {
- "$ref": "Source",
- "description": "Specification of the source."
- },
- "derivationMode": {
- "type": "string",
- "description": "What source to base the produced source on (if any).",
- "enum": [
- "SOURCE_DERIVATION_MODE_UNKNOWN",
- "SOURCE_DERIVATION_MODE_INDEPENDENT",
- "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT",
- "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT"
- ]
- }
- }
- },
- "Source": {
- "id": "Source",
- "type": "object",
- "description": "A source that records can be read and decoded from.",
- "properties": {
- "spec": {
- "type": "object",
- "description": "The source to read from, plus its parameters.",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- }
- },
- "codec": {
- "type": "object",
- "description": "The codec to use to decode data read from the source.",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- }
- },
- "baseSpecs": {
- "type": "array",
- "description": "While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs).",
- "items": {
- "type": "object",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- }
- }
- },
- "metadata": {
- "$ref": "SourceMetadata",
- "description": "Optionally, metadata for this source can be supplied right away, avoiding a SourceGetMetadataOperation roundtrip (see SourceOperationRequest). This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated."
- },
- "doesNotNeedSplitting": {
- "type": "boolean",
- "description": "Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated."
- }
- }
- },
- "SourceMetadata": {
- "id": "SourceMetadata",
- "type": "object",
- "description": "Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc.",
- "properties": {
- "producesSortedKeys": {
- "type": "boolean",
- "description": "Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order."
- },
- "infinite": {
- "type": "boolean",
- "description": "Specifies that the size of this source is known to be infinite (this is a streaming source)."
- },
- "estimatedSizeBytes": {
- "type": "string",
- "description": "An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader.",
- "format": "int64"
- }
- }
- },
- "SourceOperationResponse": {
- "id": "SourceOperationResponse",
- "type": "object",
- "description": "The result of a SourceOperationRequest, specified in ReportWorkItemStatusRequest.source_operation when the work item is completed.",
- "properties": {
- "split": {
- "$ref": "SourceSplitResponse",
- "description": "A response to a request to split a source."
- },
- "getMetadata": {
- "$ref": "SourceGetMetadataResponse",
- "description": "A response to a request to get metadata about a source."
- }
- }
- },
- "SourceSplitResponse": {
- "id": "SourceSplitResponse",
- "type": "object",
- "description": "The response to a SourceSplitRequest.",
- "properties": {
- "outcome": {
- "type": "string",
- "description": "Indicates whether splitting happened and produced a list of bundles. If this is USE_CURRENT_SOURCE_AS_IS, the current source should be processed \"as is\" without splitting. \"bundles\" is ignored in this case. If this is SPLITTING_HAPPENED, then \"bundles\" contains a list of bundles into which the source was split.",
- "enum": [
- "SOURCE_SPLIT_OUTCOME_UNKNOWN",
- "SOURCE_SPLIT_OUTCOME_USE_CURRENT",
- "SOURCE_SPLIT_OUTCOME_SPLITTING_HAPPENED"
- ]
- },
- "bundles": {
- "type": "array",
- "description": "If outcome is SPLITTING_HAPPENED, then this is a list of bundles into which the source was split. Otherwise this field is ignored. This list can be empty, which means the source represents an empty input.",
- "items": {
- "$ref": "DerivedSource"
- }
- },
- "shards": {
- "type": "array",
- "description": "DEPRECATED in favor of bundles.",
- "items": {
- "$ref": "SourceSplitShard"
- }
- }
- }
- },
- "SourceSplitShard": {
- "id": "SourceSplitShard",
- "type": "object",
- "description": "DEPRECATED in favor of DerivedSource.",
- "properties": {
- "source": {
- "$ref": "Source",
- "description": "DEPRECATED"
- },
- "derivationMode": {
- "type": "string",
- "description": "DEPRECATED",
- "enum": [
- "SOURCE_DERIVATION_MODE_UNKNOWN",
- "SOURCE_DERIVATION_MODE_INDEPENDENT",
- "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT",
- "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT"
- ]
- }
- }
- },
- "SourceGetMetadataResponse": {
- "id": "SourceGetMetadataResponse",
- "type": "object",
- "description": "The result of a SourceGetMetadataOperation.",
- "properties": {
- "metadata": {
- "$ref": "SourceMetadata",
- "description": "The computed metadata."
- }
- }
- },
- "SourceFork": {
- "id": "SourceFork",
- "type": "object",
- "description": "DEPRECATED in favor of DynamicSourceSplit.",
- "properties": {
- "primary": {
- "$ref": "SourceSplitShard",
- "description": "DEPRECATED"
- },
- "residual": {
- "$ref": "SourceSplitShard",
- "description": "DEPRECATED"
- },
- "primarySource": {
- "$ref": "DerivedSource",
- "description": "DEPRECATED"
- },
- "residualSource": {
- "$ref": "DerivedSource",
- "description": "DEPRECATED"
- }
- }
- },
- "ReportWorkItemStatusResponse": {
- "id": "ReportWorkItemStatusResponse",
- "type": "object",
- "description": "Response from a request to report the status of WorkItems.",
- "properties": {
- "workItemServiceStates": {
- "type": "array",
- "description": "A set of messages indicating the service-side state for each WorkItem whose status was reported, in the same order as the WorkItemStatus messages in the ReportWorkItemStatusRequest which resulting in this response.",
- "items": {
- "$ref": "WorkItemServiceState"
- }
- }
- }
- },
- "WorkItemServiceState": {
- "id": "WorkItemServiceState",
- "type": "object",
- "description": "The Dataflow service's idea of the current state of a WorkItem being processed by a worker.",
- "properties": {
- "suggestedStopPoint": {
- "$ref": "ApproximateProgress",
- "description": "The progress point in the WorkItem where the Dataflow service suggests that the worker truncate the task."
- },
- "leaseExpireTime": {
- "type": "string",
- "description": "Time at which the current lease will expire."
- },
- "reportStatusInterval": {
- "type": "string",
- "description": "New recommended reporting interval."
- },
- "harnessData": {
- "type": "object",
- "description": "Other data returned by the service, specific to the particular worker harness.",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- }
- },
- "nextReportIndex": {
- "type": "string",
- "description": "The index value to use for the next report sent by the worker. Note: If the report call fails for whatever reason, the worker should reuse this index for subsequent report attempts.",
- "format": "int64"
- },
- "suggestedStopPosition": {
- "$ref": "Position",
- "description": "Obsolete, always empty."
- }
- }
- },
- "LeaseWorkItemRequest": {
- "id": "LeaseWorkItemRequest",
- "type": "object",
- "description": "Request to lease WorkItems.",
- "properties": {
- "workItemTypes": {
- "type": "array",
- "description": "Filter for WorkItem type.",
- "items": {
- "type": "string"
- }
- },
- "workerCapabilities": {
- "type": "array",
- "description": "Worker capabilities. WorkItems might be limited to workers with specific capabilities.",
- "items": {
- "type": "string"
- }
- },
- "requestedLeaseDuration": {
- "type": "string",
- "description": "The initial lease period."
- },
- "currentWorkerTime": {
- "type": "string",
- "description": "The current timestamp at the worker."
- },
- "workerId": {
- "type": "string",
- "description": "Identifies the worker leasing work -- typically the ID of the virtual machine running the worker."
- }
- }
- },
- "LeaseWorkItemResponse": {
- "id": "LeaseWorkItemResponse",
- "type": "object",
- "description": "Response to a request to lease WorkItems.",
- "properties": {
- "workItems": {
- "type": "array",
- "description": "A list of the leased WorkItems.",
- "items": {
- "$ref": "WorkItem"
- }
- }
- }
- },
- "WorkItem": {
- "id": "WorkItem",
- "type": "object",
- "description": "WorkItem represents basic information about a WorkItem to be executed in the cloud.",
- "properties": {
- "id": {
- "type": "string",
- "description": "Identifies this WorkItem.",
- "format": "int64"
- },
- "projectId": {
- "type": "string",
- "description": "Identifies the cloud project this WorkItem belongs to."
- },
- "jobId": {
- "type": "string",
- "description": "Identifies the workflow job this WorkItem belongs to."
- },
- "packages": {
- "type": "array",
- "description": "Any required packages that need to be fetched in order to execute this WorkItem.",
- "items": {
- "$ref": "Package"
- }
- },
- "mapTask": {
- "$ref": "MapTask",
- "description": "Additional information for MapTask WorkItems."
- },
- "seqMapTask": {
- "$ref": "SeqMapTask",
- "description": "Additional information for SeqMapTask WorkItems."
- },
- "shellTask": {
- "$ref": "ShellTask",
- "description": "Additional information for ShellTask WorkItems."
- },
- "streamingSetupTask": {
- "$ref": "StreamingSetupTask",
- "description": "Additional information for StreamingSetupTask WorkItems."
- },
- "sourceOperationTask": {
- "$ref": "SourceOperationRequest",
- "description": "Additional information for source operation WorkItems."
- },
- "streamingComputationTask": {
- "$ref": "StreamingComputationTask",
- "description": "Additional information for StreamingComputationTask WorkItems."
- },
- "reportStatusInterval": {
- "type": "string",
- "description": "Recommended reporting interval."
- },
- "leaseExpireTime": {
- "type": "string",
- "description": "Time when the lease on this [Work][] will expire."
- },
- "configuration": {
- "type": "string",
- "description": "Work item-specific configuration as an opaque blob."
- },
- "initialReportIndex": {
- "type": "string",
- "description": "The initial index to use when reporting the status of the WorkItem.",
- "format": "int64"
- }
- }
- },
- "MapTask": {
- "id": "MapTask",
- "type": "object",
- "description": "MapTask consists of an ordered set of instructions, each of which describes one particular low-level operation for the worker to perform in order to accomplish the MapTask's WorkItem. Each instruction must appear in the list before any instructions which depends on its output.",
- "properties": {
- "instructions": {
- "type": "array",
- "description": "The instructions in the MapTask.",
- "items": {
- "$ref": "ParallelInstruction"
- }
- },
- "systemName": {
- "type": "string",
- "description": "System-defined name of this MapTask. Unique across the workflow."
- },
- "stageName": {
- "type": "string",
- "description": "System-defined name of the stage containing this MapTask. Unique across the workflow."
- }
- }
- },
- "ParallelInstruction": {
- "id": "ParallelInstruction",
- "type": "object",
- "description": "Describes a particular operation comprising a MapTask.",
- "properties": {
- "systemName": {
- "type": "string",
- "description": "System-defined name of this operation. Unique across the workflow."
- },
- "name": {
- "type": "string",
- "description": "User-provided name of this operation."
- },
- "read": {
- "$ref": "ReadInstruction",
- "description": "Additional information for Read instructions."
- },
- "write": {
- "$ref": "WriteInstruction",
- "description": "Additional information for Write instructions."
- },
- "parDo": {
- "$ref": "ParDoInstruction",
- "description": "Additional information for ParDo instructions."
- },
- "partialGroupByKey": {
- "$ref": "PartialGroupByKeyInstruction",
- "description": "Additional information for PartialGroupByKey instructions."
- },
- "flatten": {
- "$ref": "FlattenInstruction",
- "description": "Additional information for Flatten instructions."
- },
- "outputs": {
- "type": "array",
- "description": "Describes the outputs of the instruction.",
- "items": {
- "$ref": "InstructionOutput"
- }
- }
- }
- },
- "ReadInstruction": {
- "id": "ReadInstruction",
- "type": "object",
- "description": "An instruction that reads records. Takes no inputs, produces one output.",
- "properties": {
- "source": {
- "$ref": "Source",
- "description": "The source to read from."
- }
- }
- },
- "WriteInstruction": {
- "id": "WriteInstruction",
- "type": "object",
- "description": "An instruction that writes records. Takes one input, produces no outputs.",
- "properties": {
- "input": {
- "$ref": "InstructionInput",
- "description": "The input."
- },
- "sink": {
- "$ref": "Sink",
- "description": "The sink to write to."
- }
- }
- },
- "InstructionInput": {
- "id": "InstructionInput",
- "type": "object",
- "description": "An input of an instruction, as a reference to an output of a producer instruction.",
- "properties": {
- "producerInstructionIndex": {
- "type": "integer",
- "description": "The index (origin zero) of the parallel instruction that produces the output to be consumed by this input. This index is relative to the list of instructions in this input's instruction's containing MapTask.",
- "format": "int32"
- },
- "outputNum": {
- "type": "integer",
- "description": "The output index (origin zero) within the producer.",
- "format": "int32"
- }
- }
- },
- "Sink": {
- "id": "Sink",
- "type": "object",
- "description": "A sink that records can be encoded and written to.",
- "properties": {
- "spec": {
- "type": "object",
- "description": "The sink to write to, plus its parameters.",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- }
- },
- "codec": {
- "type": "object",
- "description": "The codec to use to encode data written to the sink.",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- }
- }
- }
- },
- "ParDoInstruction": {
- "id": "ParDoInstruction",
- "type": "object",
- "description": "An instruction that does a ParDo operation. Takes one main input and zero or more side inputs, and produces zero or more outputs. Runs user code.",
- "properties": {
- "input": {
- "$ref": "InstructionInput",
- "description": "The input."
- },
- "sideInputs": {
- "type": "array",
- "description": "Zero or more side inputs.",
- "items": {
- "$ref": "SideInputInfo"
- }
- },
- "userFn": {
- "type": "object",
- "description": "The user function to invoke.",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- }
- },
- "numOutputs": {
- "type": "integer",
- "description": "The number of outputs.",
- "format": "int32"
- },
- "multiOutputInfos": {
- "type": "array",
- "description": "Information about each of the outputs, if user_fn is a MultiDoFn.",
- "items": {
- "$ref": "MultiOutputInfo"
- }
- }
- }
- },
- "SideInputInfo": {
- "id": "SideInputInfo",
- "type": "object",
- "description": "Information about a side input of a DoFn or an input of a SeqDoFn.",
- "properties": {
- "sources": {
- "type": "array",
- "description": "The source(s) to read element(s) from to get the value of this side input. If more than one source, then the elements are taken from the sources, in the specified order if order matters. At least one source is required.",
- "items": {
- "$ref": "Source"
- }
- },
- "kind": {
- "type": "object",
- "description": "How to interpret the source element(s) as a side input value.",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- }
- },
- "tag": {
- "type": "string",
- "description": "The id of the tag the user code will access this side input by; this should correspond to the tag of some MultiOutputInfo."
- }
- }
- },
- "MultiOutputInfo": {
- "id": "MultiOutputInfo",
- "type": "object",
- "description": "Information about an output of a multi-output DoFn.",
- "properties": {
- "tag": {
- "type": "string",
- "description": "The id of the tag the user code will emit to this output by; this should correspond to the tag of some SideInputInfo."
- }
- }
- },
- "PartialGroupByKeyInstruction": {
- "id": "PartialGroupByKeyInstruction",
- "type": "object",
- "description": "An instruction that does a partial group-by-key. One input and one output.",
- "properties": {
- "input": {
- "$ref": "InstructionInput",
- "description": "Describes the input to the partial group-by-key instruction."
- },
- "inputElementCodec": {
- "type": "object",
- "description": "The codec to use for interpreting an element in the input PTable.",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- }
- },
- "valueCombiningFn": {
- "type": "object",
- "description": "The value combining function to invoke.",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- }
- }
- }
- },
- "FlattenInstruction": {
- "id": "FlattenInstruction",
- "type": "object",
- "description": "An instruction that copies its inputs (zero or more) to its (single) output.",
- "properties": {
- "inputs": {
- "type": "array",
- "description": "Describes the inputs to the flatten instruction.",
- "items": {
- "$ref": "InstructionInput"
- }
- }
- }
- },
- "InstructionOutput": {
- "id": "InstructionOutput",
- "type": "object",
- "description": "An output of an instruction.",
- "properties": {
- "name": {
- "type": "string",
- "description": "The user-provided name of this output."
- },
- "systemName": {
- "type": "string",
- "description": "System-defined name of this output. Unique across the workflow."
- },
- "codec": {
- "type": "object",
- "description": "The codec to use to encode data being written via this output.",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- }
- }
- }
- },
- "SeqMapTask": {
- "id": "SeqMapTask",
- "type": "object",
- "description": "Describes a particular function to invoke.",
- "properties": {
- "inputs": {
- "type": "array",
- "description": "Information about each of the inputs.",
- "items": {
- "$ref": "SideInputInfo"
- }
- },
- "userFn": {
- "type": "object",
- "description": "The user function to invoke.",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- }
- },
- "outputInfos": {
- "type": "array",
- "description": "Information about each of the outputs.",
- "items": {
- "$ref": "SeqMapTaskOutputInfo"
- }
- },
- "name": {
- "type": "string",
- "description": "The user-provided name of the SeqDo operation."
- },
- "systemName": {
- "type": "string",
- "description": "System-defined name of the SeqDo operation. Unique across the workflow."
- },
- "stageName": {
- "type": "string",
- "description": "System-defined name of the stage containing the SeqDo operation. Unique across the workflow."
- }
- }
- },
- "SeqMapTaskOutputInfo": {
- "id": "SeqMapTaskOutputInfo",
- "type": "object",
- "description": "Information about an output of a SeqMapTask.",
- "properties": {
- "tag": {
- "type": "string",
- "description": "The id of the TupleTag the user code will tag the output value by."
- },
- "sink": {
- "$ref": "Sink",
- "description": "The sink to write the output value to."
- }
- }
- },
- "ShellTask": {
- "id": "ShellTask",
- "type": "object",
- "description": "A task which consists of a shell command for the worker to execute.",
- "properties": {
- "command": {
- "type": "string",
- "description": "The shell command to run."
- },
- "exitCode": {
- "type": "integer",
- "description": "Exit code for the task.",
- "format": "int32"
- }
- }
- },
- "StreamingSetupTask": {
- "id": "StreamingSetupTask",
- "type": "object",
- "description": "A task which initializes part of a streaming Dataflow job.",
- "properties": {
- "receiveWorkPort": {
- "type": "integer",
- "description": "The TCP port on which the worker should listen for messages from other streaming computation workers.",
- "format": "int32"
- },
- "workerHarnessPort": {
- "type": "integer",
- "description": "The TCP port used by the worker to communicate with the Dataflow worker harness.",
- "format": "int32"
- },
- "streamingComputationTopology": {
- "$ref": "TopologyConfig",
- "description": "The global topology of the streaming Dataflow job."
- }
- }
- },
- "TopologyConfig": {
- "id": "TopologyConfig",
- "type": "object",
- "description": "Global topology of the streaming Dataflow job, including all computations and their sharded locations.",
- "properties": {
- "computations": {
- "type": "array",
- "description": "The computations associated with a streaming Dataflow job.",
- "items": {
- "$ref": "ComputationTopology"
- }
- },
- "dataDiskAssignments": {
- "type": "array",
- "description": "The disks assigned to a streaming Dataflow job.",
- "items": {
- "$ref": "DataDiskAssignment"
- }
- },
- "userStageToComputationNameMap": {
- "type": "object",
- "description": "Maps user stage names to stable computation names.",
- "additionalProperties": {
- "type": "string"
- }
- }
- }
- },
- "ComputationTopology": {
- "id": "ComputationTopology",
- "type": "object",
- "description": "All configuration data for a particular Computation.",
- "properties": {
- "systemStageName": {
- "type": "string",
- "description": "The system stage name."
- },
- "computationId": {
- "type": "string",
- "description": "The ID of the computation."
- },
- "userStageName": {
- "type": "string",
- "description": "The user stage name."
- },
- "keyRanges": {
- "type": "array",
- "description": "The key ranges processed by the computation.",
- "items": {
- "$ref": "KeyRangeLocation"
- }
- },
- "inputs": {
- "type": "array",
- "description": "The inputs to the computation.",
- "items": {
- "$ref": "StreamLocation"
- }
- },
- "outputs": {
- "type": "array",
- "description": "The outputs from the computation.",
- "items": {
- "$ref": "StreamLocation"
- }
- },
- "stateFamilies": {
- "type": "array",
- "description": "The state family values.",
- "items": {
- "$ref": "StateFamilyConfig"
- }
- }
- }
- },
- "KeyRangeLocation": {
- "id": "KeyRangeLocation",
- "type": "object",
- "description": "Location information for a specific key-range of a sharded computation. Currently we only support UTF-8 character splits to simplify encoding into JSON.",
- "properties": {
- "start": {
- "type": "string",
- "description": "The start (inclusive) of the key range."
- },
- "end": {
- "type": "string",
- "description": "The end (exclusive) of the key range."
- },
- "deliveryEndpoint": {
- "type": "string",
- "description": "The physical location of this range assignment to be used for streaming computation cross-worker message delivery."
- },
- "persistentDirectory": {
- "type": "string",
- "description": "The location of the persistent state for this range, as a persistent directory in the worker local filesystem."
- },
- "dataDisk": {
- "type": "string",
- "description": "The name of the data disk where data for this range is stored. This name is local to the Google Cloud Platform project and uniquely identifies the disk within that project, for example \"myproject-1014-104817-4c2-harness-0-disk-1\"."
- }
- }
- },
- "StreamLocation": {
- "id": "StreamLocation",
- "type": "object",
- "description": "Describes a stream of data, either as input to be processed or as output of a streaming Dataflow job.",
- "properties": {
- "streamingStageLocation": {
- "$ref": "StreamingStageLocation",
- "description": "The stream is part of another computation within the current streaming Dataflow job."
- },
- "pubsubLocation": {
- "$ref": "PubsubLocation",
- "description": "The stream is a pubsub stream."
- },
- "sideInputLocation": {
- "$ref": "StreamingSideInputLocation",
- "description": "The stream is a streaming side input."
- },
- "customSourceLocation": {
- "$ref": "CustomSourceLocation",
- "description": "The stream is a custom source."
- }
- }
- },
- "StreamingStageLocation": {
- "id": "StreamingStageLocation",
- "type": "object",
- "description": "Identifies the location of a streaming computation stage, for stage-to-stage communication.",
- "properties": {
- "streamId": {
- "type": "string",
- "description": "Identifies the particular stream within the streaming Dataflow job."
- }
- }
- },
- "PubsubLocation": {
- "id": "PubsubLocation",
- "type": "object",
- "description": "Identifies a pubsub location to use for transferring data into or out of a streaming Dataflow job.",
- "properties": {
- "topic": {
- "type": "string",
- "description": "A pubsub topic, in the form of \"pubsub.googleapis.com/topics/\n/\""
- },
- "subscription": {
- "type": "string",
- "description": "A pubsub subscription, in the form of \"pubsub.googleapis.com/subscriptions/\n/\""
- },
- "timestampLabel": {
- "type": "string",
- "description": "If set, contains a pubsub label from which to extract record timestamps. If left empty, record timestamps will be generated upon arrival."
- },
- "idLabel": {
- "type": "string",
- "description": "If set, contains a pubsub label from which to extract record ids. If left empty, record deduplication will be strictly best effort."
- },
- "dropLateData": {
- "type": "boolean",
- "description": "Indicates whether the pipeline allows late-arriving data."
- },
- "trackingSubscription": {
- "type": "string",
- "description": "If set, specifies the pubsub subscription that will be used for tracking custom time timestamps for watermark estimation."
- }
- }
- },
- "StreamingSideInputLocation": {
- "id": "StreamingSideInputLocation",
- "type": "object",
- "description": "Identifies the location of a streaming side input.",
- "properties": {
- "tag": {
- "type": "string",
- "description": "Identifies the particular side input within the streaming Dataflow job."
- },
- "stateFamily": {
- "type": "string",
- "description": "Identifies the state family where this side input is stored."
- }
- }
- },
- "CustomSourceLocation": {
- "id": "CustomSourceLocation",
- "type": "object",
- "description": "Identifies the location of a custom souce.",
- "properties": {
- "stateful": {
- "type": "boolean",
- "description": "Whether this source is stateful."
- }
- }
- },
- "StateFamilyConfig": {
- "id": "StateFamilyConfig",
- "type": "object",
- "description": "State family configuration.",
- "properties": {
- "stateFamily": {
- "type": "string",
- "description": "The state family value."
- },
- "isRead": {
- "type": "boolean",
- "description": "If true, this family corresponds to a read operation."
- }
- }
- },
- "DataDiskAssignment": {
- "id": "DataDiskAssignment",
- "type": "object",
- "description": "Data disk assignment for a given VM instance.",
- "properties": {
- "vmInstance": {
- "type": "string",
- "description": "VM instance name the data disks mounted to, for example \"myproject-1014-104817-4c2-harness-0\"."
- },
- "dataDisks": {
- "type": "array",
- "description": "Mounted data disks. The order is important a data disk's 0-based index in this list defines which persistent directory the disk is mounted to, for example the list of { \"myproject-1014-104817-4c2-harness-0-disk-0\" }, { \"myproject-1014-104817-4c2-harness-0-disk-1\" }.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "SourceOperationRequest": {
- "id": "SourceOperationRequest",
- "type": "object",
- "description": "A work item that represents the different operations that can be performed on a user-defined Source specification.",
- "properties": {
- "split": {
- "$ref": "SourceSplitRequest",
- "description": "Information about a request to split a source."
- },
- "getMetadata": {
- "$ref": "SourceGetMetadataRequest",
- "description": "Information about a request to get metadata about a source."
- }
- }
- },
- "SourceSplitRequest": {
- "id": "SourceSplitRequest",
- "type": "object",
- "description": "Represents the operation to split a high-level Source specification into bundles (parts for parallel processing). At a high level, splitting of a source into bundles happens as follows: SourceSplitRequest is applied to the source. If it returns SOURCE_SPLIT_OUTCOME_USE_CURRENT, no further splitting happens and the source is used \"as is\". Otherwise, splitting is applied recursively to each produced DerivedSource. As an optimization, for any Source, if its does_not_need_splitting is true, the framework assumes that splitting this source would return SOURCE_SPLIT_OUTCOME_USE_CURRENT, and doesn't initiate a SourceSplitRequest. This applies both to the initial source being split and to bundles produced from it.",
- "properties": {
- "source": {
- "$ref": "Source",
- "description": "Specification of the source to be split."
- },
- "options": {
- "$ref": "SourceSplitOptions",
- "description": "Hints for tuning the splitting process."
- }
- }
- },
- "SourceSplitOptions": {
- "id": "SourceSplitOptions",
- "type": "object",
- "description": "Hints for splitting a Source into bundles (parts for parallel processing) using SourceSplitRequest.",
- "properties": {
- "desiredBundleSizeBytes": {
- "type": "string",
- "description": "The source should be split into a set of bundles where the estimated size of each is approximately this many bytes.",
- "format": "int64"
- },
- "desiredShardSizeBytes": {
- "type": "string",
- "description": "DEPRECATED in favor of desired_bundle_size_bytes.",
- "format": "int64"
- }
- }
- },
- "SourceGetMetadataRequest": {
- "id": "SourceGetMetadataRequest",
- "type": "object",
- "description": "A request to compute the SourceMetadata of a Source.",
- "properties": {
- "source": {
- "$ref": "Source",
- "description": "Specification of the source whose metadata should be computed."
- }
- }
- },
- "StreamingComputationTask": {
- "id": "StreamingComputationTask",
- "type": "object",
- "description": "A task which describes what action should be performed for the specified streaming computation ranges.",
- "properties": {
- "taskType": {
- "type": "string",
- "description": "A type of streaming computation task.",
- "enum": [
- "STREAMING_COMPUTATION_TASK_UNKNOWN",
- "STREAMING_COMPUTATION_TASK_STOP",
- "STREAMING_COMPUTATION_TASK_START"
- ]
- },
- "dataDisks": {
- "type": "array",
- "description": "Describes the set of data disks this task should apply to.",
- "items": {
- "$ref": "MountedDataDisk"
- }
- },
- "computationRanges": {
- "type": "array",
- "description": "Contains ranges of a streaming computation this task should apply to.",
- "items": {
- "$ref": "StreamingComputationRanges"
- }
- }
- }
- },
- "MountedDataDisk": {
- "id": "MountedDataDisk",
- "type": "object",
- "description": "Describes mounted data disk.",
- "properties": {
- "dataDisk": {
- "type": "string",
- "description": "The name of the data disk. This name is local to the Google Cloud Platform project and uniquely identifies the disk within that project, for example \"myproject-1014-104817-4c2-harness-0-disk-1\"."
- }
- }
- },
- "StreamingComputationRanges": {
- "id": "StreamingComputationRanges",
- "type": "object",
- "description": "Describes full or partial data disk assignment information of the computation ranges.",
- "properties": {
- "computationId": {
- "type": "string",
- "description": "The ID of the computation."
- },
- "rangeAssignments": {
- "type": "array",
- "description": "Data disk assignments for ranges from this computation.",
- "items": {
- "$ref": "KeyRangeDataDiskAssignment"
- }
- }
- }
- },
- "KeyRangeDataDiskAssignment": {
- "id": "KeyRangeDataDiskAssignment",
- "type": "object",
- "description": "Data disk assignment information for a specific key-range of a sharded computation. Currently we only support UTF-8 character splits to simplify encoding into JSON.",
- "properties": {
- "start": {
- "type": "string",
- "description": "The start (inclusive) of the key range."
- },
- "end": {
- "type": "string",
- "description": "The end (exclusive) of the key range."
- },
- "dataDisk": {
- "type": "string",
- "description": "The name of the data disk where data for this range is stored. This name is local to the Google Cloud Platform project and uniquely identifies the disk within that project, for example \"myproject-1014-104817-4c2-harness-0-disk-1\"."
- }
- }
- }
- },
- "resources": {
- "projects": {
- "resources": {
- "jobs": {
- "methods": {
- "create": {
- "id": "dataflow.projects.jobs.create",
- "path": "v1b3/projects/{projectId}/jobs",
- "httpMethod": "POST",
- "description": "Creates a dataflow job.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "The project which owns the job.",
- "required": true,
- "location": "path"
- },
- "view": {
- "type": "string",
- "description": "Level of information requested in response.",
- "enum": [
- "JOB_VIEW_UNKNOWN",
- "JOB_VIEW_SUMMARY",
- "JOB_VIEW_ALL"
- ],
- "location": "query"
- },
- "replaceJobId": {
- "type": "string",
- "description": "DEPRECATED. This field is now on the Job message.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "projectId"
- ],
- "request": {
- "$ref": "Job"
- },
- "response": {
- "$ref": "Job"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/userinfo.email"
- ]
- },
- "get": {
- "id": "dataflow.projects.jobs.get",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}",
- "httpMethod": "GET",
- "description": "Gets the state of the specified dataflow job.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "The project which owns the job.",
- "required": true,
- "location": "path"
- },
- "jobId": {
- "type": "string",
- "description": "Identifies a single job.",
- "required": true,
- "location": "path"
- },
- "view": {
- "type": "string",
- "description": "Level of information requested in response.",
- "enum": [
- "JOB_VIEW_UNKNOWN",
- "JOB_VIEW_SUMMARY",
- "JOB_VIEW_ALL"
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "response": {
- "$ref": "Job"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/userinfo.email"
- ]
- },
- "update": {
- "id": "dataflow.projects.jobs.update",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}",
- "httpMethod": "PUT",
- "description": "Updates the state of an existing dataflow job.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "The project which owns the job.",
- "required": true,
- "location": "path"
- },
- "jobId": {
- "type": "string",
- "description": "Identifies a single job.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "request": {
- "$ref": "Job"
- },
- "response": {
- "$ref": "Job"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/userinfo.email"
- ]
- },
- "list": {
- "id": "dataflow.projects.jobs.list",
- "path": "v1b3/projects/{projectId}/jobs",
- "httpMethod": "GET",
- "description": "List the jobs of a project",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "The project which owns the jobs.",
- "required": true,
- "location": "path"
- },
- "view": {
- "type": "string",
- "description": "Level of information requested in response. Default is SUMMARY.",
- "enum": [
- "JOB_VIEW_UNKNOWN",
- "JOB_VIEW_SUMMARY",
- "JOB_VIEW_ALL"
- ],
- "location": "query"
- },
- "pageSize": {
- "type": "integer",
- "description": "If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Set this to the 'next_page_token' field of a previous response to request additional results in a long list.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "ListJobsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/userinfo.email"
- ]
- },
- "getMetrics": {
- "id": "dataflow.projects.jobs.getMetrics",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/metrics",
- "httpMethod": "GET",
- "description": "Request the job status.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "A project id.",
- "required": true,
- "location": "path"
- },
- "jobId": {
- "type": "string",
- "description": "The job to get messages for.",
- "required": true,
- "location": "path"
- },
- "startTime": {
- "type": "string",
- "description": "Return only metric data that has changed since this time. Default is to return all information about all metrics for the job.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "response": {
- "$ref": "JobMetrics"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/userinfo.email"
- ]
- }
- },
- "resources": {
- "messages": {
- "methods": {
- "list": {
- "id": "dataflow.projects.jobs.messages.list",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/messages",
- "httpMethod": "GET",
- "description": "Request the job status.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "A project id.",
- "required": true,
- "location": "path"
- },
- "jobId": {
- "type": "string",
- "description": "The job to get messages about.",
- "required": true,
- "location": "path"
- },
- "minimumImportance": {
- "type": "string",
- "description": "Filter to only get messages with importance \u003e= level",
- "enum": [
- "JOB_MESSAGE_IMPORTANCE_UNKNOWN",
- "JOB_MESSAGE_DEBUG",
- "JOB_MESSAGE_DETAILED",
- "JOB_MESSAGE_BASIC",
- "JOB_MESSAGE_WARNING",
- "JOB_MESSAGE_ERROR"
- ],
- "location": "query"
- },
- "pageSize": {
- "type": "integer",
- "description": "If specified, determines the maximum number of messages to return. If unspecified, the service may choose an appropriate default, or may return an arbitrarily large number of results.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "If supplied, this should be the value of next_page_token returned by an earlier call. This will cause the next page of results to be returned.",
- "location": "query"
- },
- "startTime": {
- "type": "string",
- "description": "If specified, return only messages with timestamps \u003e= start_time. The default is the job creation time (i.e. beginning of messages).",
- "location": "query"
- },
- "endTime": {
- "type": "string",
- "description": "Return only messages with timestamps \u003c end_time. The default is now (i.e. return up to the latest messages available).",
- "location": "query"
- }
- },
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "response": {
- "$ref": "ListJobMessagesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/userinfo.email"
- ]
- }
- }
- },
- "workItems": {
- "methods": {
- "reportStatus": {
- "id": "dataflow.projects.jobs.workItems.reportStatus",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus",
- "httpMethod": "POST",
- "description": "Reports the status of dataflow WorkItems leased by a worker.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "The project which owns the WorkItem's job.",
- "required": true,
- "location": "path"
- },
- "jobId": {
- "type": "string",
- "description": "The job which the WorkItem is part of.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "request": {
- "$ref": "ReportWorkItemStatusRequest"
- },
- "response": {
- "$ref": "ReportWorkItemStatusResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/userinfo.email"
- ]
- },
- "lease": {
- "id": "dataflow.projects.jobs.workItems.lease",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease",
- "httpMethod": "POST",
- "description": "Leases a dataflow WorkItem to run.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "Identifies the project this worker belongs to.",
- "required": true,
- "location": "path"
- },
- "jobId": {
- "type": "string",
- "description": "Identifies the workflow job this worker belongs to.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "request": {
- "$ref": "LeaseWorkItemRequest"
- },
- "response": {
- "$ref": "LeaseWorkItemResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/userinfo.email"
- ]
- }
- }
- }
- }
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/dataflow/v1b3/dataflow-gen.go b/vendor/google.golang.org/api/dataflow/v1b3/dataflow-gen.go
deleted file mode 100644
index 8743d19e..00000000
--- a/vendor/google.golang.org/api/dataflow/v1b3/dataflow-gen.go
+++ /dev/null
@@ -1,4050 +0,0 @@
-// Package dataflow provides access to the Google Dataflow API.
-//
-// See https://cloud.google.com/dataflow
-//
-// Usage example:
-//
-// import "google.golang.org/api/dataflow/v1b3"
-// ...
-// dataflowService, err := dataflow.New(oauthHttpClient)
-package dataflow // import "google.golang.org/api/dataflow/v1b3"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "dataflow:v1b3"
-const apiName = "dataflow"
-const apiVersion = "v1b3"
-const basePath = "https://dataflow.googleapis.com/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your data across Google Cloud Platform services
- CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
-
- // View your email address
- UserinfoEmailScope = "https://www.googleapis.com/auth/userinfo.email"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Projects = NewProjectsService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Projects *ProjectsService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewProjectsService(s *Service) *ProjectsService {
- rs := &ProjectsService{s: s}
- rs.Jobs = NewProjectsJobsService(s)
- return rs
-}
-
-type ProjectsService struct {
- s *Service
-
- Jobs *ProjectsJobsService
-}
-
-func NewProjectsJobsService(s *Service) *ProjectsJobsService {
- rs := &ProjectsJobsService{s: s}
- rs.Messages = NewProjectsJobsMessagesService(s)
- rs.WorkItems = NewProjectsJobsWorkItemsService(s)
- return rs
-}
-
-type ProjectsJobsService struct {
- s *Service
-
- Messages *ProjectsJobsMessagesService
-
- WorkItems *ProjectsJobsWorkItemsService
-}
-
-func NewProjectsJobsMessagesService(s *Service) *ProjectsJobsMessagesService {
- rs := &ProjectsJobsMessagesService{s: s}
- return rs
-}
-
-type ProjectsJobsMessagesService struct {
- s *Service
-}
-
-func NewProjectsJobsWorkItemsService(s *Service) *ProjectsJobsWorkItemsService {
- rs := &ProjectsJobsWorkItemsService{s: s}
- return rs
-}
-
-type ProjectsJobsWorkItemsService struct {
- s *Service
-}
-
-// ApproximateProgress: A progress measurement of a WorkItem by a
-// worker.
-type ApproximateProgress struct {
- // PercentComplete: Completion as percentage of the work, from 0.0
- // (beginning, nothing complete), to 1.0 (end of the work range, entire
- // WorkItem complete).
- PercentComplete float64 `json:"percentComplete,omitempty"`
-
- // Position: A Position within the work to represent a progress.
- Position *Position `json:"position,omitempty"`
-
- // RemainingTime: Completion as an estimated time remaining.
- RemainingTime string `json:"remainingTime,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "PercentComplete") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ApproximateProgress) MarshalJSON() ([]byte, error) {
- type noMethod ApproximateProgress
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AutoscalingSettings: Settings for WorkerPool autoscaling.
-type AutoscalingSettings struct {
- // Algorithm: The algorithm to use for autoscaling.
- //
- // Possible values:
- // "AUTOSCALING_ALGORITHM_UNKNOWN"
- // "AUTOSCALING_ALGORITHM_NONE"
- // "AUTOSCALING_ALGORITHM_BASIC"
- Algorithm string `json:"algorithm,omitempty"`
-
- // MaxNumWorkers: The maximum number of workers to cap scaling at.
- MaxNumWorkers int64 `json:"maxNumWorkers,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Algorithm") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AutoscalingSettings) MarshalJSON() ([]byte, error) {
- type noMethod AutoscalingSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ComputationTopology: All configuration data for a particular
-// Computation.
-type ComputationTopology struct {
- // ComputationId: The ID of the computation.
- ComputationId string `json:"computationId,omitempty"`
-
- // Inputs: The inputs to the computation.
- Inputs []*StreamLocation `json:"inputs,omitempty"`
-
- // KeyRanges: The key ranges processed by the computation.
- KeyRanges []*KeyRangeLocation `json:"keyRanges,omitempty"`
-
- // Outputs: The outputs from the computation.
- Outputs []*StreamLocation `json:"outputs,omitempty"`
-
- // StateFamilies: The state family values.
- StateFamilies []*StateFamilyConfig `json:"stateFamilies,omitempty"`
-
- // SystemStageName: The system stage name.
- SystemStageName string `json:"systemStageName,omitempty"`
-
- // UserStageName: The user stage name.
- UserStageName string `json:"userStageName,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ComputationId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ComputationTopology) MarshalJSON() ([]byte, error) {
- type noMethod ComputationTopology
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ConcatPosition: A position that encapsulates an inner position and an
-// index for the inner position. A ConcatPosition can be used by a
-// reader of a source that encapsulates a set of other sources.
-type ConcatPosition struct {
- // Index: Index of the inner source.
- Index int64 `json:"index,omitempty"`
-
- // Position: Position within the inner source.
- Position *Position `json:"position,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Index") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ConcatPosition) MarshalJSON() ([]byte, error) {
- type noMethod ConcatPosition
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CustomSourceLocation: Identifies the location of a custom souce.
-type CustomSourceLocation struct {
- // Stateful: Whether this source is stateful.
- Stateful bool `json:"stateful,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Stateful") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomSourceLocation) MarshalJSON() ([]byte, error) {
- type noMethod CustomSourceLocation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DataDiskAssignment: Data disk assignment for a given VM instance.
-type DataDiskAssignment struct {
- // DataDisks: Mounted data disks. The order is important a data disk's
- // 0-based index in this list defines which persistent directory the
- // disk is mounted to, for example the list of {
- // "myproject-1014-104817-4c2-harness-0-disk-0" }, {
- // "myproject-1014-104817-4c2-harness-0-disk-1" }.
- DataDisks []string `json:"dataDisks,omitempty"`
-
- // VmInstance: VM instance name the data disks mounted to, for example
- // "myproject-1014-104817-4c2-harness-0".
- VmInstance string `json:"vmInstance,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DataDisks") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DataDiskAssignment) MarshalJSON() ([]byte, error) {
- type noMethod DataDiskAssignment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DerivedSource: Specification of one of the bundles produced as a
-// result of splitting a Source (e.g. when executing a
-// SourceSplitRequest, or when splitting an active task using
-// WorkItemStatus.dynamic_source_split), relative to the source being
-// split.
-type DerivedSource struct {
- // DerivationMode: What source to base the produced source on (if any).
- //
- // Possible values:
- // "SOURCE_DERIVATION_MODE_UNKNOWN"
- // "SOURCE_DERIVATION_MODE_INDEPENDENT"
- // "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT"
- // "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT"
- DerivationMode string `json:"derivationMode,omitempty"`
-
- // Source: Specification of the source.
- Source *Source `json:"source,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DerivationMode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DerivedSource) MarshalJSON() ([]byte, error) {
- type noMethod DerivedSource
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Disk: Describes the data disk used by a workflow job.
-type Disk struct {
- // DiskType: Disk storage type, as defined by Google Compute Engine.
- // This must be a disk type appropriate to the project and zone in which
- // the workers will run. If unknown or unspecified, the service will
- // attempt to choose a reasonable default. For example, the standard
- // persistent disk type is a resource name typically ending in
- // "pd-standard". If SSD persistent disks are available, the resource
- // name typically ends with "pd-ssd". The actual valid values are
- // defined the Google Compute Engine API, not by the Dataflow API;
- // consult the Google Compute Engine documentation for more information
- // about determining the set of available disk types for a particular
- // project and zone. Google Compute Engine Disk types are local to a
- // particular project in a particular zone, and so the resource name
- // will typically look something like this:
- // compute.googleapis.com/projects/
- // /zones//diskTypes/pd-standard
- DiskType string `json:"diskType,omitempty"`
-
- // MountPoint: Directory in a VM where disk is mounted.
- MountPoint string `json:"mountPoint,omitempty"`
-
- // SizeGb: Size of disk in GB. If zero or unspecified, the service will
- // attempt to choose a reasonable default.
- SizeGb int64 `json:"sizeGb,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DiskType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Disk) MarshalJSON() ([]byte, error) {
- type noMethod Disk
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DynamicSourceSplit: When a task splits using
-// WorkItemStatus.dynamic_source_split, this message describes the two
-// parts of the split relative to the description of the current task's
-// input.
-type DynamicSourceSplit struct {
- // Primary: Primary part (continued to be processed by worker).
- // Specified relative to the previously-current source. Becomes current.
- Primary *DerivedSource `json:"primary,omitempty"`
-
- // Residual: Residual part (returned to the pool of work). Specified
- // relative to the previously-current source.
- Residual *DerivedSource `json:"residual,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Primary") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DynamicSourceSplit) MarshalJSON() ([]byte, error) {
- type noMethod DynamicSourceSplit
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Environment: Describes the environment in which a Dataflow Job runs.
-type Environment struct {
- // ClusterManagerApiService: The type of cluster manager API to use. If
- // unknown or unspecified, the service will attempt to choose a
- // reasonable default. This should be in the form of the API service
- // name, e.g. "compute.googleapis.com".
- ClusterManagerApiService string `json:"clusterManagerApiService,omitempty"`
-
- // Dataset: The dataset for the current project where various workflow
- // related tables are stored. The supported resource type is: Google
- // BigQuery: bigquery.googleapis.com/{dataset}
- Dataset string `json:"dataset,omitempty"`
-
- // Experiments: The list of experiments to enable.
- Experiments []string `json:"experiments,omitempty"`
-
- // InternalExperiments: Experimental settings.
- InternalExperiments EnvironmentInternalExperiments `json:"internalExperiments,omitempty"`
-
- // SdkPipelineOptions: The Dataflow SDK pipeline options specified by
- // the user. These options are passed through the service and are used
- // to recreate the SDK pipeline options on the worker in a language
- // agnostic and platform independent way.
- SdkPipelineOptions EnvironmentSdkPipelineOptions `json:"sdkPipelineOptions,omitempty"`
-
- // TempStoragePrefix: The prefix of the resources the system should use
- // for temporary storage. The system will append the suffix
- // "/temp-{JOBNAME} to this resource prefix, where {JOBNAME} is the
- // value of the job_name field. The resulting bucket and object prefix
- // is used as the prefix of the resources used to store temporary data
- // needed during the job execution. NOTE: This will override the value
- // in taskrunner_settings. The supported resource type is: Google Cloud
- // Storage: storage.googleapis.com/{bucket}/{object}
- // bucket.storage.googleapis.com/{object}
- TempStoragePrefix string `json:"tempStoragePrefix,omitempty"`
-
- // UserAgent: A description of the process that generated the request.
- UserAgent EnvironmentUserAgent `json:"userAgent,omitempty"`
-
- // Version: A structure describing which components and their versions
- // of the service are required in order to run the job.
- Version EnvironmentVersion `json:"version,omitempty"`
-
- // WorkerPools: Worker pools. At least one "harness" worker pool must be
- // specified in order for the job to have workers.
- WorkerPools []*WorkerPool `json:"workerPools,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "ClusterManagerApiService") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Environment) MarshalJSON() ([]byte, error) {
- type noMethod Environment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type EnvironmentInternalExperiments interface{}
-
-type EnvironmentSdkPipelineOptions interface{}
-
-type EnvironmentUserAgent interface{}
-
-type EnvironmentVersion interface{}
-
-// FlattenInstruction: An instruction that copies its inputs (zero or
-// more) to its (single) output.
-type FlattenInstruction struct {
- // Inputs: Describes the inputs to the flatten instruction.
- Inputs []*InstructionInput `json:"inputs,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Inputs") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FlattenInstruction) MarshalJSON() ([]byte, error) {
- type noMethod FlattenInstruction
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// InstructionInput: An input of an instruction, as a reference to an
-// output of a producer instruction.
-type InstructionInput struct {
- // OutputNum: The output index (origin zero) within the producer.
- OutputNum int64 `json:"outputNum,omitempty"`
-
- // ProducerInstructionIndex: The index (origin zero) of the parallel
- // instruction that produces the output to be consumed by this input.
- // This index is relative to the list of instructions in this input's
- // instruction's containing MapTask.
- ProducerInstructionIndex int64 `json:"producerInstructionIndex,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "OutputNum") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstructionInput) MarshalJSON() ([]byte, error) {
- type noMethod InstructionInput
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// InstructionOutput: An output of an instruction.
-type InstructionOutput struct {
- // Codec: The codec to use to encode data being written via this output.
- Codec InstructionOutputCodec `json:"codec,omitempty"`
-
- // Name: The user-provided name of this output.
- Name string `json:"name,omitempty"`
-
- // SystemName: System-defined name of this output. Unique across the
- // workflow.
- SystemName string `json:"systemName,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Codec") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InstructionOutput) MarshalJSON() ([]byte, error) {
- type noMethod InstructionOutput
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type InstructionOutputCodec interface{}
-
-// Job: Defines a job to be run by the Dataflow service.
-type Job struct {
- // ClientRequestId: Client's unique identifier of the job, re-used by
- // SDK across retried attempts. If this field is set, the service will
- // ensure its uniqueness. That is, the request to create a job will fail
- // if the service has knowledge of a previously submitted job with the
- // same client's id and job name. The caller may, for example, use this
- // field to ensure idempotence of job creation across retried attempts
- // to create a job. By default, the field is empty and, in that case,
- // the service ignores it.
- ClientRequestId string `json:"clientRequestId,omitempty"`
-
- // CreateTime: Timestamp when job was initially created. Immutable, set
- // by the Dataflow service.
- CreateTime string `json:"createTime,omitempty"`
-
- // CurrentState: The current state of the job. Jobs are created in the
- // JOB_STATE_STOPPED state unless otherwise specified. A job in the
- // JOB_STATE_RUNNING state may asynchronously enter a terminal state.
- // Once a job has reached a terminal state, no further state updates may
- // be made. This field may be mutated by the Dataflow service; callers
- // cannot mutate it.
- //
- // Possible values:
- // "JOB_STATE_UNKNOWN"
- // "JOB_STATE_STOPPED"
- // "JOB_STATE_RUNNING"
- // "JOB_STATE_DONE"
- // "JOB_STATE_FAILED"
- // "JOB_STATE_CANCELLED"
- // "JOB_STATE_UPDATED"
- CurrentState string `json:"currentState,omitempty"`
-
- // CurrentStateTime: The timestamp associated with the current state.
- CurrentStateTime string `json:"currentStateTime,omitempty"`
-
- // Environment: Environment for the job.
- Environment *Environment `json:"environment,omitempty"`
-
- // ExecutionInfo: Information about how the Dataflow service will
- // actually run the job.
- ExecutionInfo *JobExecutionInfo `json:"executionInfo,omitempty"`
-
- // Id: The unique ID of this job. This field is set by the Dataflow
- // service when the Job is created, and is immutable for the life of the
- // Job.
- Id string `json:"id,omitempty"`
-
- // Name: The user-specified Dataflow job name. Only one Job with a given
- // name may exist in a project at any given time. If a caller attempts
- // to create a Job with the same name as an already-existing Job, the
- // attempt will return the existing Job. The name must match the regular
- // expression [a-z]([-a-z0-9]{0,38}[a-z0-9])?
- Name string `json:"name,omitempty"`
-
- // ProjectId: The project which owns the job.
- ProjectId string `json:"projectId,omitempty"`
-
- // ReplaceJobId: If this job is an update of an existing job, this field
- // will be the ID of the job it replaced. When sending a
- // CreateJobRequest, you can update a job by specifying it here. The job
- // named here will be stopped, and its intermediate state transferred to
- // this job.
- ReplaceJobId string `json:"replaceJobId,omitempty"`
-
- // ReplacedByJobId: If another job is an update of this job (and thus,
- // this job is in JOB_STATE_UPDATED), this field will contain the ID of
- // that job.
- ReplacedByJobId string `json:"replacedByJobId,omitempty"`
-
- // RequestedState: The job's requested state. UpdateJob may be used to
- // switch between the JOB_STATE_STOPPED and JOB_STATE_RUNNING states, by
- // setting requested_state. UpdateJob may also be used to directly set a
- // job's requested state to JOB_STATE_CANCELLED or JOB_STATE_DONE,
- // irrevocably terminating the job if it has not already reached a
- // terminal state.
- //
- // Possible values:
- // "JOB_STATE_UNKNOWN"
- // "JOB_STATE_STOPPED"
- // "JOB_STATE_RUNNING"
- // "JOB_STATE_DONE"
- // "JOB_STATE_FAILED"
- // "JOB_STATE_CANCELLED"
- // "JOB_STATE_UPDATED"
- RequestedState string `json:"requestedState,omitempty"`
-
- // Steps: The top-level steps that constitute the entire job.
- Steps []*Step `json:"steps,omitempty"`
-
- // TransformNameMapping: Map of transform name prefixes of the job to be
- // replaced to the corresponding name prefixes of the new job.
- TransformNameMapping map[string]string `json:"transformNameMapping,omitempty"`
-
- // Type: The type of dataflow job.
- //
- // Possible values:
- // "JOB_TYPE_UNKNOWN"
- // "JOB_TYPE_BATCH"
- // "JOB_TYPE_STREAMING"
- Type string `json:"type,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ClientRequestId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Job) MarshalJSON() ([]byte, error) {
- type noMethod Job
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// JobExecutionInfo: Additional information about how a Dataflow job
-// will be executed which isn’t contained in the submitted job.
-type JobExecutionInfo struct {
- // Stages: A mapping from each stage to the information about that
- // stage.
- Stages map[string]JobExecutionStageInfo `json:"stages,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Stages") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *JobExecutionInfo) MarshalJSON() ([]byte, error) {
- type noMethod JobExecutionInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// JobExecutionStageInfo: Contains information about how a particular
-// [google.dataflow.v1beta3.Step][google.dataflow.v1beta3.Step] will be
-// executed.
-type JobExecutionStageInfo struct {
- // StepName: The steps associated with the execution stage. Note that
- // stages may have several steps, and that a given step might be run by
- // more than one stage.
- StepName []string `json:"stepName,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "StepName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *JobExecutionStageInfo) MarshalJSON() ([]byte, error) {
- type noMethod JobExecutionStageInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// JobMessage: A particular message pertaining to a Dataflow job.
-type JobMessage struct {
- // Id: Identifies the message. This is automatically generated by the
- // service; the caller should treat it as an opaque string.
- Id string `json:"id,omitempty"`
-
- // MessageImportance: Importance level of the message.
- //
- // Possible values:
- // "JOB_MESSAGE_IMPORTANCE_UNKNOWN"
- // "JOB_MESSAGE_DEBUG"
- // "JOB_MESSAGE_DETAILED"
- // "JOB_MESSAGE_BASIC"
- // "JOB_MESSAGE_WARNING"
- // "JOB_MESSAGE_ERROR"
- MessageImportance string `json:"messageImportance,omitempty"`
-
- // MessageText: The text of the message.
- MessageText string `json:"messageText,omitempty"`
-
- // Time: The timestamp of the message.
- Time string `json:"time,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *JobMessage) MarshalJSON() ([]byte, error) {
- type noMethod JobMessage
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// JobMetrics: JobMetrics contains a collection of metrics descibing the
-// detailed progress of a Dataflow job. Metrics correspond to
-// user-defined and system-defined metrics in the job. This resource
-// captures only the most recent values of each metric; time-series data
-// can be queried for them (under the same metric names) from Cloud
-// Monitoring.
-type JobMetrics struct {
- // MetricTime: Timestamp as of which metric values are current.
- MetricTime string `json:"metricTime,omitempty"`
-
- // Metrics: All metrics for this job.
- Metrics []*MetricUpdate `json:"metrics,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "MetricTime") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *JobMetrics) MarshalJSON() ([]byte, error) {
- type noMethod JobMetrics
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// KeyRangeDataDiskAssignment: Data disk assignment information for a
-// specific key-range of a sharded computation. Currently we only
-// support UTF-8 character splits to simplify encoding into JSON.
-type KeyRangeDataDiskAssignment struct {
- // DataDisk: The name of the data disk where data for this range is
- // stored. This name is local to the Google Cloud Platform project and
- // uniquely identifies the disk within that project, for example
- // "myproject-1014-104817-4c2-harness-0-disk-1".
- DataDisk string `json:"dataDisk,omitempty"`
-
- // End: The end (exclusive) of the key range.
- End string `json:"end,omitempty"`
-
- // Start: The start (inclusive) of the key range.
- Start string `json:"start,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DataDisk") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *KeyRangeDataDiskAssignment) MarshalJSON() ([]byte, error) {
- type noMethod KeyRangeDataDiskAssignment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// KeyRangeLocation: Location information for a specific key-range of a
-// sharded computation. Currently we only support UTF-8 character splits
-// to simplify encoding into JSON.
-type KeyRangeLocation struct {
- // DataDisk: The name of the data disk where data for this range is
- // stored. This name is local to the Google Cloud Platform project and
- // uniquely identifies the disk within that project, for example
- // "myproject-1014-104817-4c2-harness-0-disk-1".
- DataDisk string `json:"dataDisk,omitempty"`
-
- // DeliveryEndpoint: The physical location of this range assignment to
- // be used for streaming computation cross-worker message delivery.
- DeliveryEndpoint string `json:"deliveryEndpoint,omitempty"`
-
- // End: The end (exclusive) of the key range.
- End string `json:"end,omitempty"`
-
- // PersistentDirectory: The location of the persistent state for this
- // range, as a persistent directory in the worker local filesystem.
- PersistentDirectory string `json:"persistentDirectory,omitempty"`
-
- // Start: The start (inclusive) of the key range.
- Start string `json:"start,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DataDisk") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *KeyRangeLocation) MarshalJSON() ([]byte, error) {
- type noMethod KeyRangeLocation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LeaseWorkItemRequest: Request to lease WorkItems.
-type LeaseWorkItemRequest struct {
- // CurrentWorkerTime: The current timestamp at the worker.
- CurrentWorkerTime string `json:"currentWorkerTime,omitempty"`
-
- // RequestedLeaseDuration: The initial lease period.
- RequestedLeaseDuration string `json:"requestedLeaseDuration,omitempty"`
-
- // WorkItemTypes: Filter for WorkItem type.
- WorkItemTypes []string `json:"workItemTypes,omitempty"`
-
- // WorkerCapabilities: Worker capabilities. WorkItems might be limited
- // to workers with specific capabilities.
- WorkerCapabilities []string `json:"workerCapabilities,omitempty"`
-
- // WorkerId: Identifies the worker leasing work -- typically the ID of
- // the virtual machine running the worker.
- WorkerId string `json:"workerId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CurrentWorkerTime")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LeaseWorkItemRequest) MarshalJSON() ([]byte, error) {
- type noMethod LeaseWorkItemRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LeaseWorkItemResponse: Response to a request to lease WorkItems.
-type LeaseWorkItemResponse struct {
- // WorkItems: A list of the leased WorkItems.
- WorkItems []*WorkItem `json:"workItems,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "WorkItems") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LeaseWorkItemResponse) MarshalJSON() ([]byte, error) {
- type noMethod LeaseWorkItemResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListJobMessagesResponse: Response to a request to list job messages.
-type ListJobMessagesResponse struct {
- // JobMessages: Messages in ascending timestamp order.
- JobMessages []*JobMessage `json:"jobMessages,omitempty"`
-
- // NextPageToken: The token to obtain the next page of results if there
- // are more.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "JobMessages") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListJobMessagesResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListJobMessagesResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListJobsResponse: Response to a request to list Dataflow jobs. This
-// may be a partial response, depending on the page size in the
-// ListJobsRequest.
-type ListJobsResponse struct {
- // Jobs: A subset of the requested job information.
- Jobs []*Job `json:"jobs,omitempty"`
-
- // NextPageToken: Set if there may be more results than fit in this
- // response.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Jobs") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListJobsResponse) MarshalJSON() ([]byte, error) {
- type noMethod ListJobsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MapTask: MapTask consists of an ordered set of instructions, each of
-// which describes one particular low-level operation for the worker to
-// perform in order to accomplish the MapTask's WorkItem. Each
-// instruction must appear in the list before any instructions which
-// depends on its output.
-type MapTask struct {
- // Instructions: The instructions in the MapTask.
- Instructions []*ParallelInstruction `json:"instructions,omitempty"`
-
- // StageName: System-defined name of the stage containing this MapTask.
- // Unique across the workflow.
- StageName string `json:"stageName,omitempty"`
-
- // SystemName: System-defined name of this MapTask. Unique across the
- // workflow.
- SystemName string `json:"systemName,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Instructions") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MapTask) MarshalJSON() ([]byte, error) {
- type noMethod MapTask
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MetricStructuredName: Identifies a metric, by describing the source
-// which generated the metric.
-type MetricStructuredName struct {
- // Context: Zero or more labeled fields which identify the part of the
- // job this metric is associated with, such as the name of a step or
- // collection. For example, built-in counters associated with steps will
- // have context['step'] = . Counters associated with PCollections in the
- // SDK will have context['pcollection'] =
- // .
- Context map[string]string `json:"context,omitempty"`
-
- // Name: Worker-defined metric name.
- Name string `json:"name,omitempty"`
-
- // Origin: Origin (namespace) of metric name. May be blank for
- // user-define metrics; will be "dataflow" for metrics defined by the
- // Dataflow service or SDK.
- Origin string `json:"origin,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Context") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MetricStructuredName) MarshalJSON() ([]byte, error) {
- type noMethod MetricStructuredName
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MetricUpdate: Describes the state of a metric.
-type MetricUpdate struct {
- // Cumulative: True if this metric is reported as the total cumulative
- // aggregate value accumulated since the worker started working on this
- // WorkItem. By default this is false, indicating that this metric is
- // reported as a delta that is not associated with any WorkItem.
- Cumulative bool `json:"cumulative,omitempty"`
-
- // Internal: Worker-computed aggregate value for internal use by the
- // Dataflow service.
- Internal interface{} `json:"internal,omitempty"`
-
- // Kind: Metric aggregation kind. The possible metric aggregation kinds
- // are "Sum", "Max", "Min", "Mean", "Set", "And", and "Or". The
- // specified aggregation kind is case-insensitive. If omitted, this is
- // not an aggregated value but instead a single metric sample value.
- Kind string `json:"kind,omitempty"`
-
- // MeanCount: Worker-computed aggregate value for the "Mean" aggregation
- // kind. This holds the count of the aggregated values and is used in
- // combination with mean_sum above to obtain the actual mean aggregate
- // value. The only possible value type is Long.
- MeanCount interface{} `json:"meanCount,omitempty"`
-
- // MeanSum: Worker-computed aggregate value for the "Mean" aggregation
- // kind. This holds the sum of the aggregated values and is used in
- // combination with mean_count below to obtain the actual mean aggregate
- // value. The only possible value types are Long and Double.
- MeanSum interface{} `json:"meanSum,omitempty"`
-
- // Name: Name of the metric.
- Name *MetricStructuredName `json:"name,omitempty"`
-
- // Scalar: Worker-computed aggregate value for aggregation kinds "Sum",
- // "Max", "Min", "And", and "Or". The possible value types are Long,
- // Double, and Boolean.
- Scalar interface{} `json:"scalar,omitempty"`
-
- // Set: Worker-computed aggregate value for the "Set" aggregation kind.
- // The only possible value type is a list of Values whose type can be
- // Long, Double, or String, according to the metric's type. All Values
- // in the list must be of the same type.
- Set interface{} `json:"set,omitempty"`
-
- // UpdateTime: Timestamp associated with the metric value. Optional when
- // workers are reporting work progress; it will be filled in responses
- // from the metrics API.
- UpdateTime string `json:"updateTime,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Cumulative") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MetricUpdate) MarshalJSON() ([]byte, error) {
- type noMethod MetricUpdate
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MountedDataDisk: Describes mounted data disk.
-type MountedDataDisk struct {
- // DataDisk: The name of the data disk. This name is local to the Google
- // Cloud Platform project and uniquely identifies the disk within that
- // project, for example "myproject-1014-104817-4c2-harness-0-disk-1".
- DataDisk string `json:"dataDisk,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DataDisk") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MountedDataDisk) MarshalJSON() ([]byte, error) {
- type noMethod MountedDataDisk
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MultiOutputInfo: Information about an output of a multi-output DoFn.
-type MultiOutputInfo struct {
- // Tag: The id of the tag the user code will emit to this output by;
- // this should correspond to the tag of some SideInputInfo.
- Tag string `json:"tag,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Tag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MultiOutputInfo) MarshalJSON() ([]byte, error) {
- type noMethod MultiOutputInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Package: Packages that need to be installed in order for a worker to
-// run the steps of the Dataflow job which will be assigned to its
-// worker pool. This is the mechanism by which the SDK causes code to be
-// loaded onto the workers. For example, the Dataflow Java SDK might use
-// this to install jars containing the user's code and all of the
-// various dependencies (libraries, data files, etc) required in order
-// for that code to run.
-type Package struct {
- // Location: The resource to read the package from. The supported
- // resource type is: Google Cloud Storage:
- // storage.googleapis.com/{bucket} bucket.storage.googleapis.com/
- Location string `json:"location,omitempty"`
-
- // Name: The name of the package.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Location") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Package) MarshalJSON() ([]byte, error) {
- type noMethod Package
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ParDoInstruction: An instruction that does a ParDo operation. Takes
-// one main input and zero or more side inputs, and produces zero or
-// more outputs. Runs user code.
-type ParDoInstruction struct {
- // Input: The input.
- Input *InstructionInput `json:"input,omitempty"`
-
- // MultiOutputInfos: Information about each of the outputs, if user_fn
- // is a MultiDoFn.
- MultiOutputInfos []*MultiOutputInfo `json:"multiOutputInfos,omitempty"`
-
- // NumOutputs: The number of outputs.
- NumOutputs int64 `json:"numOutputs,omitempty"`
-
- // SideInputs: Zero or more side inputs.
- SideInputs []*SideInputInfo `json:"sideInputs,omitempty"`
-
- // UserFn: The user function to invoke.
- UserFn ParDoInstructionUserFn `json:"userFn,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Input") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ParDoInstruction) MarshalJSON() ([]byte, error) {
- type noMethod ParDoInstruction
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ParDoInstructionUserFn interface{}
-
-// ParallelInstruction: Describes a particular operation comprising a
-// MapTask.
-type ParallelInstruction struct {
- // Flatten: Additional information for Flatten instructions.
- Flatten *FlattenInstruction `json:"flatten,omitempty"`
-
- // Name: User-provided name of this operation.
- Name string `json:"name,omitempty"`
-
- // Outputs: Describes the outputs of the instruction.
- Outputs []*InstructionOutput `json:"outputs,omitempty"`
-
- // ParDo: Additional information for ParDo instructions.
- ParDo *ParDoInstruction `json:"parDo,omitempty"`
-
- // PartialGroupByKey: Additional information for PartialGroupByKey
- // instructions.
- PartialGroupByKey *PartialGroupByKeyInstruction `json:"partialGroupByKey,omitempty"`
-
- // Read: Additional information for Read instructions.
- Read *ReadInstruction `json:"read,omitempty"`
-
- // SystemName: System-defined name of this operation. Unique across the
- // workflow.
- SystemName string `json:"systemName,omitempty"`
-
- // Write: Additional information for Write instructions.
- Write *WriteInstruction `json:"write,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Flatten") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ParallelInstruction) MarshalJSON() ([]byte, error) {
- type noMethod ParallelInstruction
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PartialGroupByKeyInstruction: An instruction that does a partial
-// group-by-key. One input and one output.
-type PartialGroupByKeyInstruction struct {
- // Input: Describes the input to the partial group-by-key instruction.
- Input *InstructionInput `json:"input,omitempty"`
-
- // InputElementCodec: The codec to use for interpreting an element in
- // the input PTable.
- InputElementCodec PartialGroupByKeyInstructionInputElementCodec `json:"inputElementCodec,omitempty"`
-
- // ValueCombiningFn: The value combining function to invoke.
- ValueCombiningFn PartialGroupByKeyInstructionValueCombiningFn `json:"valueCombiningFn,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Input") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PartialGroupByKeyInstruction) MarshalJSON() ([]byte, error) {
- type noMethod PartialGroupByKeyInstruction
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type PartialGroupByKeyInstructionInputElementCodec interface{}
-
-type PartialGroupByKeyInstructionValueCombiningFn interface{}
-
-// Position: Position defines a position within a collection of data.
-// The value can be either the end position, a key (used with ordered
-// collections), a byte offset, or a record index.
-type Position struct {
- // ByteOffset: Position is a byte offset.
- ByteOffset int64 `json:"byteOffset,omitempty,string"`
-
- // ConcatPosition: CloudPosition is a concat position.
- ConcatPosition *ConcatPosition `json:"concatPosition,omitempty"`
-
- // End: Position is past all other positions. Also useful for the end
- // position of an unbounded range.
- End bool `json:"end,omitempty"`
-
- // Key: Position is a string key, ordered lexicographically.
- Key string `json:"key,omitempty"`
-
- // RecordIndex: Position is a record index.
- RecordIndex int64 `json:"recordIndex,omitempty,string"`
-
- // ShufflePosition: CloudPosition is a base64 encoded
- // BatchShufflePosition (with FIXED sharding).
- ShufflePosition string `json:"shufflePosition,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ByteOffset") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Position) MarshalJSON() ([]byte, error) {
- type noMethod Position
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PubsubLocation: Identifies a pubsub location to use for transferring
-// data into or out of a streaming Dataflow job.
-type PubsubLocation struct {
- // DropLateData: Indicates whether the pipeline allows late-arriving
- // data.
- DropLateData bool `json:"dropLateData,omitempty"`
-
- // IdLabel: If set, contains a pubsub label from which to extract record
- // ids. If left empty, record deduplication will be strictly best
- // effort.
- IdLabel string `json:"idLabel,omitempty"`
-
- // Subscription: A pubsub subscription, in the form of
- // "pubsub.googleapis.com/subscriptions/
- // /"
- Subscription string `json:"subscription,omitempty"`
-
- // TimestampLabel: If set, contains a pubsub label from which to extract
- // record timestamps. If left empty, record timestamps will be generated
- // upon arrival.
- TimestampLabel string `json:"timestampLabel,omitempty"`
-
- // Topic: A pubsub topic, in the form of
- // "pubsub.googleapis.com/topics/
- // /"
- Topic string `json:"topic,omitempty"`
-
- // TrackingSubscription: If set, specifies the pubsub subscription that
- // will be used for tracking custom time timestamps for watermark
- // estimation.
- TrackingSubscription string `json:"trackingSubscription,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DropLateData") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PubsubLocation) MarshalJSON() ([]byte, error) {
- type noMethod PubsubLocation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReadInstruction: An instruction that reads records. Takes no inputs,
-// produces one output.
-type ReadInstruction struct {
- // Source: The source to read from.
- Source *Source `json:"source,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Source") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReadInstruction) MarshalJSON() ([]byte, error) {
- type noMethod ReadInstruction
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportWorkItemStatusRequest: Request to report the status of
-// WorkItems.
-type ReportWorkItemStatusRequest struct {
- // CurrentWorkerTime: The current timestamp at the worker.
- CurrentWorkerTime string `json:"currentWorkerTime,omitempty"`
-
- // WorkItemStatuses: The order is unimportant, except that the order of
- // the WorkItemServiceState messages in the ReportWorkItemStatusResponse
- // corresponds to the order of WorkItemStatus messages here.
- WorkItemStatuses []*WorkItemStatus `json:"workItemStatuses,omitempty"`
-
- // WorkerId: The ID of the worker reporting the WorkItem status. If this
- // does not match the ID of the worker which the Dataflow service
- // believes currently has the lease on the WorkItem, the report will be
- // dropped (with an error response).
- WorkerId string `json:"workerId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CurrentWorkerTime")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportWorkItemStatusRequest) MarshalJSON() ([]byte, error) {
- type noMethod ReportWorkItemStatusRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportWorkItemStatusResponse: Response from a request to report the
-// status of WorkItems.
-type ReportWorkItemStatusResponse struct {
- // WorkItemServiceStates: A set of messages indicating the service-side
- // state for each WorkItem whose status was reported, in the same order
- // as the WorkItemStatus messages in the ReportWorkItemStatusRequest
- // which resulting in this response.
- WorkItemServiceStates []*WorkItemServiceState `json:"workItemServiceStates,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "WorkItemServiceStates") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportWorkItemStatusResponse) MarshalJSON() ([]byte, error) {
- type noMethod ReportWorkItemStatusResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SeqMapTask: Describes a particular function to invoke.
-type SeqMapTask struct {
- // Inputs: Information about each of the inputs.
- Inputs []*SideInputInfo `json:"inputs,omitempty"`
-
- // Name: The user-provided name of the SeqDo operation.
- Name string `json:"name,omitempty"`
-
- // OutputInfos: Information about each of the outputs.
- OutputInfos []*SeqMapTaskOutputInfo `json:"outputInfos,omitempty"`
-
- // StageName: System-defined name of the stage containing the SeqDo
- // operation. Unique across the workflow.
- StageName string `json:"stageName,omitempty"`
-
- // SystemName: System-defined name of the SeqDo operation. Unique across
- // the workflow.
- SystemName string `json:"systemName,omitempty"`
-
- // UserFn: The user function to invoke.
- UserFn SeqMapTaskUserFn `json:"userFn,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Inputs") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SeqMapTask) MarshalJSON() ([]byte, error) {
- type noMethod SeqMapTask
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type SeqMapTaskUserFn interface{}
-
-// SeqMapTaskOutputInfo: Information about an output of a SeqMapTask.
-type SeqMapTaskOutputInfo struct {
- // Sink: The sink to write the output value to.
- Sink *Sink `json:"sink,omitempty"`
-
- // Tag: The id of the TupleTag the user code will tag the output value
- // by.
- Tag string `json:"tag,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Sink") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SeqMapTaskOutputInfo) MarshalJSON() ([]byte, error) {
- type noMethod SeqMapTaskOutputInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ShellTask: A task which consists of a shell command for the worker to
-// execute.
-type ShellTask struct {
- // Command: The shell command to run.
- Command string `json:"command,omitempty"`
-
- // ExitCode: Exit code for the task.
- ExitCode int64 `json:"exitCode,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Command") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ShellTask) MarshalJSON() ([]byte, error) {
- type noMethod ShellTask
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SideInputInfo: Information about a side input of a DoFn or an input
-// of a SeqDoFn.
-type SideInputInfo struct {
- // Kind: How to interpret the source element(s) as a side input value.
- Kind SideInputInfoKind `json:"kind,omitempty"`
-
- // Sources: The source(s) to read element(s) from to get the value of
- // this side input. If more than one source, then the elements are taken
- // from the sources, in the specified order if order matters. At least
- // one source is required.
- Sources []*Source `json:"sources,omitempty"`
-
- // Tag: The id of the tag the user code will access this side input by;
- // this should correspond to the tag of some MultiOutputInfo.
- Tag string `json:"tag,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SideInputInfo) MarshalJSON() ([]byte, error) {
- type noMethod SideInputInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type SideInputInfoKind interface{}
-
-// Sink: A sink that records can be encoded and written to.
-type Sink struct {
- // Codec: The codec to use to encode data written to the sink.
- Codec SinkCodec `json:"codec,omitempty"`
-
- // Spec: The sink to write to, plus its parameters.
- Spec SinkSpec `json:"spec,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Codec") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Sink) MarshalJSON() ([]byte, error) {
- type noMethod Sink
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type SinkCodec interface{}
-
-type SinkSpec interface{}
-
-// Source: A source that records can be read and decoded from.
-type Source struct {
- // BaseSpecs: While splitting, sources may specify the produced bundles
- // as differences against another source, in order to save backend-side
- // memory and allow bigger jobs. For details, see SourceSplitRequest. To
- // support this use case, the full set of parameters of the source is
- // logically obtained by taking the latest explicitly specified value of
- // each parameter in the order: base_specs (later items win), spec
- // (overrides anything in base_specs).
- BaseSpecs []SourceBaseSpecs `json:"baseSpecs,omitempty"`
-
- // Codec: The codec to use to decode data read from the source.
- Codec SourceCodec `json:"codec,omitempty"`
-
- // DoesNotNeedSplitting: Setting this value to true hints to the
- // framework that the source doesn't need splitting, and using
- // SourceSplitRequest on it would yield
- // SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this
- // to true when splitting a single file into a set of byte ranges of
- // appropriate size, and set this to false when splitting a filepattern
- // into individual files. However, for efficiency, a file splitter may
- // decide to produce file subranges directly from the filepattern to
- // avoid a splitting round-trip. See SourceSplitRequest for an overview
- // of the splitting process. This field is meaningful only in the Source
- // objects populated by the user (e.g. when filling in a DerivedSource).
- // Source objects supplied by the framework to the user don't have this
- // field populated.
- DoesNotNeedSplitting bool `json:"doesNotNeedSplitting,omitempty"`
-
- // Metadata: Optionally, metadata for this source can be supplied right
- // away, avoiding a SourceGetMetadataOperation roundtrip (see
- // SourceOperationRequest). This field is meaningful only in the Source
- // objects populated by the user (e.g. when filling in a DerivedSource).
- // Source objects supplied by the framework to the user don't have this
- // field populated.
- Metadata *SourceMetadata `json:"metadata,omitempty"`
-
- // Spec: The source to read from, plus its parameters.
- Spec SourceSpec `json:"spec,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BaseSpecs") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Source) MarshalJSON() ([]byte, error) {
- type noMethod Source
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type SourceBaseSpecs interface{}
-
-type SourceCodec interface{}
-
-type SourceSpec interface{}
-
-// SourceFork: DEPRECATED in favor of DynamicSourceSplit.
-type SourceFork struct {
- // Primary: DEPRECATED
- Primary *SourceSplitShard `json:"primary,omitempty"`
-
- // PrimarySource: DEPRECATED
- PrimarySource *DerivedSource `json:"primarySource,omitempty"`
-
- // Residual: DEPRECATED
- Residual *SourceSplitShard `json:"residual,omitempty"`
-
- // ResidualSource: DEPRECATED
- ResidualSource *DerivedSource `json:"residualSource,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Primary") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SourceFork) MarshalJSON() ([]byte, error) {
- type noMethod SourceFork
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SourceGetMetadataRequest: A request to compute the SourceMetadata of
-// a Source.
-type SourceGetMetadataRequest struct {
- // Source: Specification of the source whose metadata should be
- // computed.
- Source *Source `json:"source,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Source") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SourceGetMetadataRequest) MarshalJSON() ([]byte, error) {
- type noMethod SourceGetMetadataRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SourceGetMetadataResponse: The result of a
-// SourceGetMetadataOperation.
-type SourceGetMetadataResponse struct {
- // Metadata: The computed metadata.
- Metadata *SourceMetadata `json:"metadata,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Metadata") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SourceGetMetadataResponse) MarshalJSON() ([]byte, error) {
- type noMethod SourceGetMetadataResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SourceMetadata: Metadata about a Source useful for automatically
-// optimizing and tuning the pipeline, etc.
-type SourceMetadata struct {
- // EstimatedSizeBytes: An estimate of the total size (in bytes) of the
- // data that would be read from this source. This estimate is in terms
- // of external storage size, before any decompression or other
- // processing done by the reader.
- EstimatedSizeBytes int64 `json:"estimatedSizeBytes,omitempty,string"`
-
- // Infinite: Specifies that the size of this source is known to be
- // infinite (this is a streaming source).
- Infinite bool `json:"infinite,omitempty"`
-
- // ProducesSortedKeys: Whether this source is known to produce key/value
- // pairs with the (encoded) keys in lexicographically sorted order.
- ProducesSortedKeys bool `json:"producesSortedKeys,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "EstimatedSizeBytes")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SourceMetadata) MarshalJSON() ([]byte, error) {
- type noMethod SourceMetadata
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SourceOperationRequest: A work item that represents the different
-// operations that can be performed on a user-defined Source
-// specification.
-type SourceOperationRequest struct {
- // GetMetadata: Information about a request to get metadata about a
- // source.
- GetMetadata *SourceGetMetadataRequest `json:"getMetadata,omitempty"`
-
- // Split: Information about a request to split a source.
- Split *SourceSplitRequest `json:"split,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "GetMetadata") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SourceOperationRequest) MarshalJSON() ([]byte, error) {
- type noMethod SourceOperationRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SourceOperationResponse: The result of a SourceOperationRequest,
-// specified in ReportWorkItemStatusRequest.source_operation when the
-// work item is completed.
-type SourceOperationResponse struct {
- // GetMetadata: A response to a request to get metadata about a source.
- GetMetadata *SourceGetMetadataResponse `json:"getMetadata,omitempty"`
-
- // Split: A response to a request to split a source.
- Split *SourceSplitResponse `json:"split,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "GetMetadata") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SourceOperationResponse) MarshalJSON() ([]byte, error) {
- type noMethod SourceOperationResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SourceSplitOptions: Hints for splitting a Source into bundles (parts
-// for parallel processing) using SourceSplitRequest.
-type SourceSplitOptions struct {
- // DesiredBundleSizeBytes: The source should be split into a set of
- // bundles where the estimated size of each is approximately this many
- // bytes.
- DesiredBundleSizeBytes int64 `json:"desiredBundleSizeBytes,omitempty,string"`
-
- // DesiredShardSizeBytes: DEPRECATED in favor of
- // desired_bundle_size_bytes.
- DesiredShardSizeBytes int64 `json:"desiredShardSizeBytes,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g.
- // "DesiredBundleSizeBytes") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SourceSplitOptions) MarshalJSON() ([]byte, error) {
- type noMethod SourceSplitOptions
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SourceSplitRequest: Represents the operation to split a high-level
-// Source specification into bundles (parts for parallel processing). At
-// a high level, splitting of a source into bundles happens as follows:
-// SourceSplitRequest is applied to the source. If it returns
-// SOURCE_SPLIT_OUTCOME_USE_CURRENT, no further splitting happens and
-// the source is used "as is". Otherwise, splitting is applied
-// recursively to each produced DerivedSource. As an optimization, for
-// any Source, if its does_not_need_splitting is true, the framework
-// assumes that splitting this source would return
-// SOURCE_SPLIT_OUTCOME_USE_CURRENT, and doesn't initiate a
-// SourceSplitRequest. This applies both to the initial source being
-// split and to bundles produced from it.
-type SourceSplitRequest struct {
- // Options: Hints for tuning the splitting process.
- Options *SourceSplitOptions `json:"options,omitempty"`
-
- // Source: Specification of the source to be split.
- Source *Source `json:"source,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Options") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SourceSplitRequest) MarshalJSON() ([]byte, error) {
- type noMethod SourceSplitRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SourceSplitResponse: The response to a SourceSplitRequest.
-type SourceSplitResponse struct {
- // Bundles: If outcome is SPLITTING_HAPPENED, then this is a list of
- // bundles into which the source was split. Otherwise this field is
- // ignored. This list can be empty, which means the source represents an
- // empty input.
- Bundles []*DerivedSource `json:"bundles,omitempty"`
-
- // Outcome: Indicates whether splitting happened and produced a list of
- // bundles. If this is USE_CURRENT_SOURCE_AS_IS, the current source
- // should be processed "as is" without splitting. "bundles" is ignored
- // in this case. If this is SPLITTING_HAPPENED, then "bundles" contains
- // a list of bundles into which the source was split.
- //
- // Possible values:
- // "SOURCE_SPLIT_OUTCOME_UNKNOWN"
- // "SOURCE_SPLIT_OUTCOME_USE_CURRENT"
- // "SOURCE_SPLIT_OUTCOME_SPLITTING_HAPPENED"
- Outcome string `json:"outcome,omitempty"`
-
- // Shards: DEPRECATED in favor of bundles.
- Shards []*SourceSplitShard `json:"shards,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Bundles") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SourceSplitResponse) MarshalJSON() ([]byte, error) {
- type noMethod SourceSplitResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SourceSplitShard: DEPRECATED in favor of DerivedSource.
-type SourceSplitShard struct {
- // DerivationMode: DEPRECATED
- //
- // Possible values:
- // "SOURCE_DERIVATION_MODE_UNKNOWN"
- // "SOURCE_DERIVATION_MODE_INDEPENDENT"
- // "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT"
- // "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT"
- DerivationMode string `json:"derivationMode,omitempty"`
-
- // Source: DEPRECATED
- Source *Source `json:"source,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DerivationMode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SourceSplitShard) MarshalJSON() ([]byte, error) {
- type noMethod SourceSplitShard
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// StateFamilyConfig: State family configuration.
-type StateFamilyConfig struct {
- // IsRead: If true, this family corresponds to a read operation.
- IsRead bool `json:"isRead,omitempty"`
-
- // StateFamily: The state family value.
- StateFamily string `json:"stateFamily,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "IsRead") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *StateFamilyConfig) MarshalJSON() ([]byte, error) {
- type noMethod StateFamilyConfig
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Status: The `Status` type defines a logical error model that is
-// suitable for different programming environments, including REST APIs
-// and RPC APIs. It is used by [gRPC](https://github.com/grpc). The
-// error model is designed to be: - Simple to use and understand for
-// most users - Flexible enough to meet unexpected needs # Overview The
-// `Status` message contains three pieces of data: error code, error
-// message, and error details. The error code should be an enum value of
-// [google.rpc.Code][], but it may accept additional error codes if
-// needed. The error message should be a developer-facing English
-// message that helps developers *understand* and *resolve* the error.
-// If a localized user-facing error message is needed, put the localized
-// message in the error details or localize it in the client. The
-// optional error details may contain arbitrary information about the
-// error. There is a predefined set of error detail types in the package
-// `google.rpc` which can be used for common error conditions. #
-// Language mapping The `Status` message is the logical representation
-// of the error model, but it is not necessarily the actual wire format.
-// When the `Status` message is exposed in different client libraries
-// and different wire protocols, it can be mapped differently. For
-// example, it will likely be mapped to some exceptions in Java, but
-// more likely mapped to some error codes in C. # Other uses The error
-// model and the `Status` message can be used in a variety of
-// environments, either with or without APIs, to provide a consistent
-// developer experience across different environments. Example uses of
-// this error model include: - Partial errors. If a service needs to
-// return partial errors to the client, it may embed the `Status` in the
-// normal response to indicate the partial errors. - Workflow errors. A
-// typical workflow has multiple steps. Each step may have a `Status`
-// message for error reporting purpose. - Batch operations. If a client
-// uses batch request and batch response, the `Status` message should be
-// used directly inside batch response, one for each error sub-response.
-// - Asynchronous operations. If an API call embeds asynchronous
-// operation results in its response, the status of those operations
-// should be represented directly using the `Status` message. - Logging.
-// If some API errors are stored in logs, the message `Status` could be
-// used directly after any stripping needed for security/privacy
-// reasons.
-type Status struct {
- // Code: The status code, which should be an enum value of
- // [google.rpc.Code][].
- Code int64 `json:"code,omitempty"`
-
- // Details: A list of messages that carry the error details. There will
- // be a common set of message types for APIs to use.
- Details []StatusDetails `json:"details,omitempty"`
-
- // Message: A developer-facing error message, which should be in
- // English. Any user-facing error message should be localized and sent
- // in the [google.rpc.Status.details][google.rpc.Status.details] field,
- // or localized by the client.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Status) MarshalJSON() ([]byte, error) {
- type noMethod Status
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type StatusDetails interface{}
-
-// Step: Defines a particular step within a Dataflow job. A job consists
-// of multiple steps, each of which performs some specific operation as
-// part of the overall job. Data is typically passed from one step to
-// another as part of the job. Here's an example of a sequence of steps
-// which together implement a Map-Reduce job: * Read a collection of
-// data from some source, parsing the collection's elements. * Validate
-// the elements. * Apply a user-defined function to map each element to
-// some value and extract an element-specific key value. * Group
-// elements with the same key into a single element with that key,
-// transforming a multiply-keyed collection into a uniquely-keyed
-// collection. * Write the elements out to some data sink. (Note that
-// the Dataflow service may be used to run many different types of jobs,
-// not just Map-Reduce).
-type Step struct {
- // Kind: The kind of step in the dataflow Job.
- Kind string `json:"kind,omitempty"`
-
- // Name: Name identifying the step. This must be unique for each step
- // with respect to all other steps in the dataflow Job.
- Name string `json:"name,omitempty"`
-
- // Properties: Named properties associated with the step. Each kind of
- // predefined step has its own required set of properties.
- Properties StepProperties `json:"properties,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Step) MarshalJSON() ([]byte, error) {
- type noMethod Step
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type StepProperties interface{}
-
-// StreamLocation: Describes a stream of data, either as input to be
-// processed or as output of a streaming Dataflow job.
-type StreamLocation struct {
- // CustomSourceLocation: The stream is a custom source.
- CustomSourceLocation *CustomSourceLocation `json:"customSourceLocation,omitempty"`
-
- // PubsubLocation: The stream is a pubsub stream.
- PubsubLocation *PubsubLocation `json:"pubsubLocation,omitempty"`
-
- // SideInputLocation: The stream is a streaming side input.
- SideInputLocation *StreamingSideInputLocation `json:"sideInputLocation,omitempty"`
-
- // StreamingStageLocation: The stream is part of another computation
- // within the current streaming Dataflow job.
- StreamingStageLocation *StreamingStageLocation `json:"streamingStageLocation,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "CustomSourceLocation") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *StreamLocation) MarshalJSON() ([]byte, error) {
- type noMethod StreamLocation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// StreamingComputationRanges: Describes full or partial data disk
-// assignment information of the computation ranges.
-type StreamingComputationRanges struct {
- // ComputationId: The ID of the computation.
- ComputationId string `json:"computationId,omitempty"`
-
- // RangeAssignments: Data disk assignments for ranges from this
- // computation.
- RangeAssignments []*KeyRangeDataDiskAssignment `json:"rangeAssignments,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ComputationId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *StreamingComputationRanges) MarshalJSON() ([]byte, error) {
- type noMethod StreamingComputationRanges
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// StreamingComputationTask: A task which describes what action should
-// be performed for the specified streaming computation ranges.
-type StreamingComputationTask struct {
- // ComputationRanges: Contains ranges of a streaming computation this
- // task should apply to.
- ComputationRanges []*StreamingComputationRanges `json:"computationRanges,omitempty"`
-
- // DataDisks: Describes the set of data disks this task should apply to.
- DataDisks []*MountedDataDisk `json:"dataDisks,omitempty"`
-
- // TaskType: A type of streaming computation task.
- //
- // Possible values:
- // "STREAMING_COMPUTATION_TASK_UNKNOWN"
- // "STREAMING_COMPUTATION_TASK_STOP"
- // "STREAMING_COMPUTATION_TASK_START"
- TaskType string `json:"taskType,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ComputationRanges")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *StreamingComputationTask) MarshalJSON() ([]byte, error) {
- type noMethod StreamingComputationTask
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// StreamingSetupTask: A task which initializes part of a streaming
-// Dataflow job.
-type StreamingSetupTask struct {
- // ReceiveWorkPort: The TCP port on which the worker should listen for
- // messages from other streaming computation workers.
- ReceiveWorkPort int64 `json:"receiveWorkPort,omitempty"`
-
- // StreamingComputationTopology: The global topology of the streaming
- // Dataflow job.
- StreamingComputationTopology *TopologyConfig `json:"streamingComputationTopology,omitempty"`
-
- // WorkerHarnessPort: The TCP port used by the worker to communicate
- // with the Dataflow worker harness.
- WorkerHarnessPort int64 `json:"workerHarnessPort,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ReceiveWorkPort") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *StreamingSetupTask) MarshalJSON() ([]byte, error) {
- type noMethod StreamingSetupTask
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// StreamingSideInputLocation: Identifies the location of a streaming
-// side input.
-type StreamingSideInputLocation struct {
- // StateFamily: Identifies the state family where this side input is
- // stored.
- StateFamily string `json:"stateFamily,omitempty"`
-
- // Tag: Identifies the particular side input within the streaming
- // Dataflow job.
- Tag string `json:"tag,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "StateFamily") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *StreamingSideInputLocation) MarshalJSON() ([]byte, error) {
- type noMethod StreamingSideInputLocation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// StreamingStageLocation: Identifies the location of a streaming
-// computation stage, for stage-to-stage communication.
-type StreamingStageLocation struct {
- // StreamId: Identifies the particular stream within the streaming
- // Dataflow job.
- StreamId string `json:"streamId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "StreamId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *StreamingStageLocation) MarshalJSON() ([]byte, error) {
- type noMethod StreamingStageLocation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TaskRunnerSettings: Taskrunner configuration settings.
-type TaskRunnerSettings struct {
- // Alsologtostderr: Also send taskrunner log info to stderr?
- Alsologtostderr bool `json:"alsologtostderr,omitempty"`
-
- // BaseTaskDir: Location on the worker for task-specific subdirectories.
- BaseTaskDir string `json:"baseTaskDir,omitempty"`
-
- // BaseUrl: The base URL for the taskrunner to use when accessing Google
- // Cloud APIs. When workers access Google Cloud APIs, they logically do
- // so via relative URLs. If this field is specified, it supplies the
- // base URL to use for resolving these relative URLs. The normative
- // algorithm used is defined by RFC 1808, "Relative Uniform Resource
- // Locators". If not specified, the default value is
- // "http://www.googleapis.com/"
- BaseUrl string `json:"baseUrl,omitempty"`
-
- // CommandlinesFileName: Store preprocessing commands in this file.
- CommandlinesFileName string `json:"commandlinesFileName,omitempty"`
-
- // ContinueOnException: Do we continue taskrunner if an exception is
- // hit?
- ContinueOnException bool `json:"continueOnException,omitempty"`
-
- // DataflowApiVersion: API version of endpoint, e.g. "v1b3"
- DataflowApiVersion string `json:"dataflowApiVersion,omitempty"`
-
- // HarnessCommand: Command to launch the worker harness.
- HarnessCommand string `json:"harnessCommand,omitempty"`
-
- // LanguageHint: Suggested backend language.
- LanguageHint string `json:"languageHint,omitempty"`
-
- // LogDir: Directory on the VM to store logs.
- LogDir string `json:"logDir,omitempty"`
-
- // LogToSerialconsole: Send taskrunner log into to Google Compute Engine
- // VM serial console?
- LogToSerialconsole bool `json:"logToSerialconsole,omitempty"`
-
- // LogUploadLocation: Indicates where to put logs. If this is not
- // specified, the logs will not be uploaded. The supported resource type
- // is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object}
- // bucket.storage.googleapis.com/{object}
- LogUploadLocation string `json:"logUploadLocation,omitempty"`
-
- // OauthScopes: OAuth2 scopes to be requested by the taskrunner in order
- // to access the dataflow API.
- OauthScopes []string `json:"oauthScopes,omitempty"`
-
- // ParallelWorkerSettings: Settings to pass to the parallel worker
- // harness.
- ParallelWorkerSettings *WorkerSettings `json:"parallelWorkerSettings,omitempty"`
-
- // StreamingWorkerMainClass: Streaming worker main class name.
- StreamingWorkerMainClass string `json:"streamingWorkerMainClass,omitempty"`
-
- // TaskGroup: The UNIX group ID on the worker VM to use for tasks
- // launched by taskrunner; e.g. "wheel".
- TaskGroup string `json:"taskGroup,omitempty"`
-
- // TaskUser: The UNIX user ID on the worker VM to use for tasks launched
- // by taskrunner; e.g. "root".
- TaskUser string `json:"taskUser,omitempty"`
-
- // TempStoragePrefix: The prefix of the resources the taskrunner should
- // use for temporary storage. The supported resource type is: Google
- // Cloud Storage: storage.googleapis.com/{bucket}/{object}
- // bucket.storage.googleapis.com/{object}
- TempStoragePrefix string `json:"tempStoragePrefix,omitempty"`
-
- // VmId: ID string of VM.
- VmId string `json:"vmId,omitempty"`
-
- // WorkflowFileName: Store the workflow in this file.
- WorkflowFileName string `json:"workflowFileName,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Alsologtostderr") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TaskRunnerSettings) MarshalJSON() ([]byte, error) {
- type noMethod TaskRunnerSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TopologyConfig: Global topology of the streaming Dataflow job,
-// including all computations and their sharded locations.
-type TopologyConfig struct {
- // Computations: The computations associated with a streaming Dataflow
- // job.
- Computations []*ComputationTopology `json:"computations,omitempty"`
-
- // DataDiskAssignments: The disks assigned to a streaming Dataflow job.
- DataDiskAssignments []*DataDiskAssignment `json:"dataDiskAssignments,omitempty"`
-
- // UserStageToComputationNameMap: Maps user stage names to stable
- // computation names.
- UserStageToComputationNameMap map[string]string `json:"userStageToComputationNameMap,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Computations") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TopologyConfig) MarshalJSON() ([]byte, error) {
- type noMethod TopologyConfig
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// WorkItem: WorkItem represents basic information about a WorkItem to
-// be executed in the cloud.
-type WorkItem struct {
- // Configuration: Work item-specific configuration as an opaque blob.
- Configuration string `json:"configuration,omitempty"`
-
- // Id: Identifies this WorkItem.
- Id int64 `json:"id,omitempty,string"`
-
- // InitialReportIndex: The initial index to use when reporting the
- // status of the WorkItem.
- InitialReportIndex int64 `json:"initialReportIndex,omitempty,string"`
-
- // JobId: Identifies the workflow job this WorkItem belongs to.
- JobId string `json:"jobId,omitempty"`
-
- // LeaseExpireTime: Time when the lease on this [Work][] will expire.
- LeaseExpireTime string `json:"leaseExpireTime,omitempty"`
-
- // MapTask: Additional information for MapTask WorkItems.
- MapTask *MapTask `json:"mapTask,omitempty"`
-
- // Packages: Any required packages that need to be fetched in order to
- // execute this WorkItem.
- Packages []*Package `json:"packages,omitempty"`
-
- // ProjectId: Identifies the cloud project this WorkItem belongs to.
- ProjectId string `json:"projectId,omitempty"`
-
- // ReportStatusInterval: Recommended reporting interval.
- ReportStatusInterval string `json:"reportStatusInterval,omitempty"`
-
- // SeqMapTask: Additional information for SeqMapTask WorkItems.
- SeqMapTask *SeqMapTask `json:"seqMapTask,omitempty"`
-
- // ShellTask: Additional information for ShellTask WorkItems.
- ShellTask *ShellTask `json:"shellTask,omitempty"`
-
- // SourceOperationTask: Additional information for source operation
- // WorkItems.
- SourceOperationTask *SourceOperationRequest `json:"sourceOperationTask,omitempty"`
-
- // StreamingComputationTask: Additional information for
- // StreamingComputationTask WorkItems.
- StreamingComputationTask *StreamingComputationTask `json:"streamingComputationTask,omitempty"`
-
- // StreamingSetupTask: Additional information for StreamingSetupTask
- // WorkItems.
- StreamingSetupTask *StreamingSetupTask `json:"streamingSetupTask,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Configuration") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *WorkItem) MarshalJSON() ([]byte, error) {
- type noMethod WorkItem
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// WorkItemServiceState: The Dataflow service's idea of the current
-// state of a WorkItem being processed by a worker.
-type WorkItemServiceState struct {
- // HarnessData: Other data returned by the service, specific to the
- // particular worker harness.
- HarnessData WorkItemServiceStateHarnessData `json:"harnessData,omitempty"`
-
- // LeaseExpireTime: Time at which the current lease will expire.
- LeaseExpireTime string `json:"leaseExpireTime,omitempty"`
-
- // NextReportIndex: The index value to use for the next report sent by
- // the worker. Note: If the report call fails for whatever reason, the
- // worker should reuse this index for subsequent report attempts.
- NextReportIndex int64 `json:"nextReportIndex,omitempty,string"`
-
- // ReportStatusInterval: New recommended reporting interval.
- ReportStatusInterval string `json:"reportStatusInterval,omitempty"`
-
- // SuggestedStopPoint: The progress point in the WorkItem where the
- // Dataflow service suggests that the worker truncate the task.
- SuggestedStopPoint *ApproximateProgress `json:"suggestedStopPoint,omitempty"`
-
- // SuggestedStopPosition: Obsolete, always empty.
- SuggestedStopPosition *Position `json:"suggestedStopPosition,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "HarnessData") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *WorkItemServiceState) MarshalJSON() ([]byte, error) {
- type noMethod WorkItemServiceState
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type WorkItemServiceStateHarnessData interface{}
-
-// WorkItemStatus: Conveys a worker's progress through the work
-// described by a WorkItem.
-type WorkItemStatus struct {
- // Completed: True if the WorkItem was completed (successfully or
- // unsuccessfully).
- Completed bool `json:"completed,omitempty"`
-
- // DynamicSourceSplit: See documentation of stop_position.
- DynamicSourceSplit *DynamicSourceSplit `json:"dynamicSourceSplit,omitempty"`
-
- // Errors: Specifies errors which occurred during processing. If errors
- // are provided, and completed = true, then the WorkItem is considered
- // to have failed.
- Errors []*Status `json:"errors,omitempty"`
-
- // MetricUpdates: Worker output metrics (counters) for this WorkItem.
- MetricUpdates []*MetricUpdate `json:"metricUpdates,omitempty"`
-
- // Progress: The WorkItem's approximate progress.
- Progress *ApproximateProgress `json:"progress,omitempty"`
-
- // ReportIndex: The report index. When a WorkItem is leased, the lease
- // will contain an initial report index. When a WorkItem's status is
- // reported to the system, the report should be sent with that report
- // index, and the response will contain the index the worker should use
- // for the next report. Reports received with unexpected index values
- // will be rejected by the service. In order to preserve idempotency,
- // the worker should not alter the contents of a report, even if the
- // worker must submit the same report multiple times before getting back
- // a response. The worker should not submit a subsequent report until
- // the response for the previous report had been received from the
- // service.
- ReportIndex int64 `json:"reportIndex,omitempty,string"`
-
- // RequestedLeaseDuration: Amount of time the worker requests for its
- // lease.
- RequestedLeaseDuration string `json:"requestedLeaseDuration,omitempty"`
-
- // SourceFork: DEPRECATED in favor of dynamic_source_split.
- SourceFork *SourceFork `json:"sourceFork,omitempty"`
-
- // SourceOperationResponse: If the work item represented a
- // SourceOperationRequest, and the work is completed, contains the
- // result of the operation.
- SourceOperationResponse *SourceOperationResponse `json:"sourceOperationResponse,omitempty"`
-
- // StopPosition: A worker may split an active map task in two parts,
- // "primary" and "residual", continuing to process the primary part and
- // returning the residual part into the pool of available work. This
- // event is called a "dynamic split" and is critical to the dynamic work
- // rebalancing feature. The two obtained sub-tasks are called "parts" of
- // the split. The parts, if concatenated, must represent the same input
- // as would be read by the current task if the split did not happen. The
- // exact way in which the original task is decomposed into the two parts
- // is specified either as a position demarcating them (stop_position),
- // or explicitly as two DerivedSources, if this task consumes a
- // user-defined source type (dynamic_source_split). The "current" task
- // is adjusted as a result of the split: after a task with range [A, B)
- // sends a stop_position update at C, its range is considered to be [A,
- // C), e.g.: * Progress should be interpreted relative to the new range,
- // e.g. "75% completed" means "75% of [A, C) completed" * The worker
- // should interpret proposed_stop_position relative to the new range,
- // e.g. "split at 68%" should be interpreted as "split at 68% of [A,
- // C)". * If the worker chooses to split again using stop_position, only
- // stop_positions in [A, C) will be accepted. * Etc.
- // dynamic_source_split has similar semantics: e.g., if a task with
- // source S splits using dynamic_source_split into {P, R} (where P and R
- // must be together equivalent to S), then subsequent progress and
- // proposed_stop_position should be interpreted relative to P, and in a
- // potential subsequent dynamic_source_split into {P', R'}, P' and R'
- // must be together equivalent to P, etc.
- StopPosition *Position `json:"stopPosition,omitempty"`
-
- // WorkItemId: Identifies the WorkItem.
- WorkItemId string `json:"workItemId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Completed") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *WorkItemStatus) MarshalJSON() ([]byte, error) {
- type noMethod WorkItemStatus
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// WorkerPool: Describes one particular pool of Dataflow workers to be
-// instantiated by the Dataflow service in order to perform the
-// computations required by a job. Note that a workflow job may use
-// multiple pools, in order to match the various computational
-// requirements of the various stages of the job.
-type WorkerPool struct {
- // AutoscalingSettings: Settings for autoscaling of this WorkerPool.
- AutoscalingSettings *AutoscalingSettings `json:"autoscalingSettings,omitempty"`
-
- // DataDisks: Data disks that are used by a VM in this workflow.
- DataDisks []*Disk `json:"dataDisks,omitempty"`
-
- // DefaultPackageSet: The default package set to install. This allows
- // the service to select a default set of packages which are useful to
- // worker harnesses written in a particular language.
- //
- // Possible values:
- // "DEFAULT_PACKAGE_SET_UNKNOWN"
- // "DEFAULT_PACKAGE_SET_NONE"
- // "DEFAULT_PACKAGE_SET_JAVA"
- // "DEFAULT_PACKAGE_SET_PYTHON"
- DefaultPackageSet string `json:"defaultPackageSet,omitempty"`
-
- // DiskSizeGb: Size of root disk for VMs, in GB. If zero or unspecified,
- // the service will attempt to choose a reasonable default.
- DiskSizeGb int64 `json:"diskSizeGb,omitempty"`
-
- // DiskSourceImage: Fully qualified source image for disks.
- DiskSourceImage string `json:"diskSourceImage,omitempty"`
-
- // DiskType: Type of root disk for VMs. If empty or unspecified, the
- // service will attempt to choose a reasonable default.
- DiskType string `json:"diskType,omitempty"`
-
- // Kind: The kind of the worker pool; currently only 'harness' and
- // 'shuffle' are supported.
- Kind string `json:"kind,omitempty"`
-
- // MachineType: Machine type (e.g. "n1-standard-1"). If empty or
- // unspecified, the service will attempt to choose a reasonable default.
- MachineType string `json:"machineType,omitempty"`
-
- // Metadata: Metadata to set on the Google Compute Engine VMs.
- Metadata map[string]string `json:"metadata,omitempty"`
-
- // Network: Network to which VMs will be assigned. If empty or
- // unspecified, the service will use the network "default".
- Network string `json:"network,omitempty"`
-
- // NumWorkers: Number of Google Compute Engine workers in this pool
- // needed to execute the job. If zero or unspecified, the service will
- // attempt to choose a reasonable default.
- NumWorkers int64 `json:"numWorkers,omitempty"`
-
- // OnHostMaintenance: The action to take on host maintenance, as defined
- // by the Google Compute Engine API.
- OnHostMaintenance string `json:"onHostMaintenance,omitempty"`
-
- // Packages: Packages to be installed on workers.
- Packages []*Package `json:"packages,omitempty"`
-
- // PoolArgs: Extra arguments for this worker pool.
- PoolArgs WorkerPoolPoolArgs `json:"poolArgs,omitempty"`
-
- // TaskrunnerSettings: Settings passed through to Google Compute Engine
- // workers when using the standard Dataflow task runner. Users should
- // ignore this field.
- TaskrunnerSettings *TaskRunnerSettings `json:"taskrunnerSettings,omitempty"`
-
- // TeardownPolicy: Sets the policy for determining when to turndown
- // worker pool. Allowed values are: TEARDOWN_ALWAYS,
- // TEARDOWN_ON_SUCCESS, and TEARDOWN_NEVER. TEARDOWN_ALWAYS means
- // workers are always torn down regardless of whether the job succeeds.
- // TEARDOWN_ON_SUCCESS means workers are torn down if the job succeeds.
- // TEARDOWN_NEVER means the workers are never torn down. If the workers
- // are not torn down by the service, they will continue to run and use
- // Google Compute Engine VM resources in the user's project until they
- // are explicitly terminated by the user. Because of this, Google
- // recommends using the TEARDOWN_ALWAYS policy except for small,
- // manually supervised test jobs. If unknown or unspecified, the service
- // will attempt to choose a reasonable default.
- //
- // Possible values:
- // "TEARDOWN_POLICY_UNKNOWN"
- // "TEARDOWN_ALWAYS"
- // "TEARDOWN_ON_SUCCESS"
- // "TEARDOWN_NEVER"
- TeardownPolicy string `json:"teardownPolicy,omitempty"`
-
- // Zone: Zone to run the worker pools in (e.g. "us-central1-b"). If
- // empty or unspecified, the service will attempt to choose a reasonable
- // default.
- Zone string `json:"zone,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AutoscalingSettings")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *WorkerPool) MarshalJSON() ([]byte, error) {
- type noMethod WorkerPool
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type WorkerPoolPoolArgs interface{}
-
-// WorkerSettings: Provides data to pass through to the worker harness.
-type WorkerSettings struct {
- // BaseUrl: The base URL for accessing Google Cloud APIs. When workers
- // access Google Cloud APIs, they logically do so via relative URLs. If
- // this field is specified, it supplies the base URL to use for
- // resolving these relative URLs. The normative algorithm used is
- // defined by RFC 1808, "Relative Uniform Resource Locators". If not
- // specified, the default value is "http://www.googleapis.com/"
- BaseUrl string `json:"baseUrl,omitempty"`
-
- // ReportingEnabled: Send work progress updates to service.
- ReportingEnabled bool `json:"reportingEnabled,omitempty"`
-
- // ServicePath: The Dataflow service path relative to the root URL, for
- // example, "dataflow/v1b3/projects".
- ServicePath string `json:"servicePath,omitempty"`
-
- // ShuffleServicePath: The Shuffle service path relative to the root
- // URL, for example, "shuffle/v1beta1".
- ShuffleServicePath string `json:"shuffleServicePath,omitempty"`
-
- // TempStoragePrefix: The prefix of the resources the system should use
- // for temporary storage. The supported resource type is: Google Cloud
- // Storage: storage.googleapis.com/{bucket}/{object}
- // bucket.storage.googleapis.com/{object}
- TempStoragePrefix string `json:"tempStoragePrefix,omitempty"`
-
- // WorkerId: ID of the worker running this pipeline.
- WorkerId string `json:"workerId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BaseUrl") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *WorkerSettings) MarshalJSON() ([]byte, error) {
- type noMethod WorkerSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// WriteInstruction: An instruction that writes records. Takes one
-// input, produces no outputs.
-type WriteInstruction struct {
- // Input: The input.
- Input *InstructionInput `json:"input,omitempty"`
-
- // Sink: The sink to write to.
- Sink *Sink `json:"sink,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Input") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *WriteInstruction) MarshalJSON() ([]byte, error) {
- type noMethod WriteInstruction
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "dataflow.projects.jobs.create":
-
-type ProjectsJobsCreateCall struct {
- s *Service
- projectId string
- job *Job
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Create: Creates a dataflow job.
-func (r *ProjectsJobsService) Create(projectId string, job *Job) *ProjectsJobsCreateCall {
- c := &ProjectsJobsCreateCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.job = job
- return c
-}
-
-// ReplaceJobId sets the optional parameter "replaceJobId": DEPRECATED.
-// This field is now on the Job message.
-func (c *ProjectsJobsCreateCall) ReplaceJobId(replaceJobId string) *ProjectsJobsCreateCall {
- c.opt_["replaceJobId"] = replaceJobId
- return c
-}
-
-// View sets the optional parameter "view": Level of information
-// requested in response.
-//
-// Possible values:
-// "JOB_VIEW_UNKNOWN"
-// "JOB_VIEW_SUMMARY"
-// "JOB_VIEW_ALL"
-func (c *ProjectsJobsCreateCall) View(view string) *ProjectsJobsCreateCall {
- c.opt_["view"] = view
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsJobsCreateCall) Fields(s ...googleapi.Field) *ProjectsJobsCreateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsJobsCreateCall) Context(ctx context.Context) *ProjectsJobsCreateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsJobsCreateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.job)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["replaceJobId"]; ok {
- params.Set("replaceJobId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["view"]; ok {
- params.Set("view", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1b3/projects/{projectId}/jobs")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dataflow.projects.jobs.create" call.
-// Exactly one of *Job or error will be non-nil. Any non-2xx status code
-// is an error. Response headers are in either
-// *Job.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *ProjectsJobsCreateCall) Do() (*Job, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Job{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a dataflow job.",
- // "httpMethod": "POST",
- // "id": "dataflow.projects.jobs.create",
- // "parameterOrder": [
- // "projectId"
- // ],
- // "parameters": {
- // "projectId": {
- // "description": "The project which owns the job.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "replaceJobId": {
- // "description": "DEPRECATED. This field is now on the Job message.",
- // "location": "query",
- // "type": "string"
- // },
- // "view": {
- // "description": "Level of information requested in response.",
- // "enum": [
- // "JOB_VIEW_UNKNOWN",
- // "JOB_VIEW_SUMMARY",
- // "JOB_VIEW_ALL"
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "v1b3/projects/{projectId}/jobs",
- // "request": {
- // "$ref": "Job"
- // },
- // "response": {
- // "$ref": "Job"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/userinfo.email"
- // ]
- // }
-
-}
-
-// method id "dataflow.projects.jobs.get":
-
-type ProjectsJobsGetCall struct {
- s *Service
- projectId string
- jobId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets the state of the specified dataflow job.
-func (r *ProjectsJobsService) Get(projectId string, jobId string) *ProjectsJobsGetCall {
- c := &ProjectsJobsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.jobId = jobId
- return c
-}
-
-// View sets the optional parameter "view": Level of information
-// requested in response.
-//
-// Possible values:
-// "JOB_VIEW_UNKNOWN"
-// "JOB_VIEW_SUMMARY"
-// "JOB_VIEW_ALL"
-func (c *ProjectsJobsGetCall) View(view string) *ProjectsJobsGetCall {
- c.opt_["view"] = view
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsJobsGetCall) Fields(s ...googleapi.Field) *ProjectsJobsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ProjectsJobsGetCall) IfNoneMatch(entityTag string) *ProjectsJobsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsJobsGetCall) Context(ctx context.Context) *ProjectsJobsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsJobsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["view"]; ok {
- params.Set("view", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1b3/projects/{projectId}/jobs/{jobId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "jobId": c.jobId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dataflow.projects.jobs.get" call.
-// Exactly one of *Job or error will be non-nil. Any non-2xx status code
-// is an error. Response headers are in either
-// *Job.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *ProjectsJobsGetCall) Do() (*Job, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Job{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the state of the specified dataflow job.",
- // "httpMethod": "GET",
- // "id": "dataflow.projects.jobs.get",
- // "parameterOrder": [
- // "projectId",
- // "jobId"
- // ],
- // "parameters": {
- // "jobId": {
- // "description": "Identifies a single job.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "The project which owns the job.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "view": {
- // "description": "Level of information requested in response.",
- // "enum": [
- // "JOB_VIEW_UNKNOWN",
- // "JOB_VIEW_SUMMARY",
- // "JOB_VIEW_ALL"
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "v1b3/projects/{projectId}/jobs/{jobId}",
- // "response": {
- // "$ref": "Job"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/userinfo.email"
- // ]
- // }
-
-}
-
-// method id "dataflow.projects.jobs.getMetrics":
-
-type ProjectsJobsGetMetricsCall struct {
- s *Service
- projectId string
- jobId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// GetMetrics: Request the job status.
-func (r *ProjectsJobsService) GetMetrics(projectId string, jobId string) *ProjectsJobsGetMetricsCall {
- c := &ProjectsJobsGetMetricsCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.jobId = jobId
- return c
-}
-
-// StartTime sets the optional parameter "startTime": Return only metric
-// data that has changed since this time. Default is to return all
-// information about all metrics for the job.
-func (c *ProjectsJobsGetMetricsCall) StartTime(startTime string) *ProjectsJobsGetMetricsCall {
- c.opt_["startTime"] = startTime
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsJobsGetMetricsCall) Fields(s ...googleapi.Field) *ProjectsJobsGetMetricsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ProjectsJobsGetMetricsCall) IfNoneMatch(entityTag string) *ProjectsJobsGetMetricsCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsJobsGetMetricsCall) Context(ctx context.Context) *ProjectsJobsGetMetricsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsJobsGetMetricsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["startTime"]; ok {
- params.Set("startTime", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1b3/projects/{projectId}/jobs/{jobId}/metrics")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "jobId": c.jobId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dataflow.projects.jobs.getMetrics" call.
-// Exactly one of *JobMetrics or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *JobMetrics.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ProjectsJobsGetMetricsCall) Do() (*JobMetrics, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &JobMetrics{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Request the job status.",
- // "httpMethod": "GET",
- // "id": "dataflow.projects.jobs.getMetrics",
- // "parameterOrder": [
- // "projectId",
- // "jobId"
- // ],
- // "parameters": {
- // "jobId": {
- // "description": "The job to get messages for.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "A project id.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "startTime": {
- // "description": "Return only metric data that has changed since this time. Default is to return all information about all metrics for the job.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "v1b3/projects/{projectId}/jobs/{jobId}/metrics",
- // "response": {
- // "$ref": "JobMetrics"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/userinfo.email"
- // ]
- // }
-
-}
-
-// method id "dataflow.projects.jobs.list":
-
-type ProjectsJobsListCall struct {
- s *Service
- projectId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: List the jobs of a project
-func (r *ProjectsJobsService) List(projectId string) *ProjectsJobsListCall {
- c := &ProjectsJobsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- return c
-}
-
-// PageSize sets the optional parameter "pageSize": If there are many
-// jobs, limit response to at most this many. The actual number of jobs
-// returned will be the lesser of max_responses and an unspecified
-// server-defined limit.
-func (c *ProjectsJobsListCall) PageSize(pageSize int64) *ProjectsJobsListCall {
- c.opt_["pageSize"] = pageSize
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Set this to the
-// 'next_page_token' field of a previous response to request additional
-// results in a long list.
-func (c *ProjectsJobsListCall) PageToken(pageToken string) *ProjectsJobsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// View sets the optional parameter "view": Level of information
-// requested in response. Default is SUMMARY.
-//
-// Possible values:
-// "JOB_VIEW_UNKNOWN"
-// "JOB_VIEW_SUMMARY"
-// "JOB_VIEW_ALL"
-func (c *ProjectsJobsListCall) View(view string) *ProjectsJobsListCall {
- c.opt_["view"] = view
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsJobsListCall) Fields(s ...googleapi.Field) *ProjectsJobsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ProjectsJobsListCall) IfNoneMatch(entityTag string) *ProjectsJobsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsJobsListCall) Context(ctx context.Context) *ProjectsJobsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsJobsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["pageSize"]; ok {
- params.Set("pageSize", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["view"]; ok {
- params.Set("view", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1b3/projects/{projectId}/jobs")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dataflow.projects.jobs.list" call.
-// Exactly one of *ListJobsResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ListJobsResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ProjectsJobsListCall) Do() (*ListJobsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ListJobsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "List the jobs of a project",
- // "httpMethod": "GET",
- // "id": "dataflow.projects.jobs.list",
- // "parameterOrder": [
- // "projectId"
- // ],
- // "parameters": {
- // "pageSize": {
- // "description": "If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Set this to the 'next_page_token' field of a previous response to request additional results in a long list.",
- // "location": "query",
- // "type": "string"
- // },
- // "projectId": {
- // "description": "The project which owns the jobs.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "view": {
- // "description": "Level of information requested in response. Default is SUMMARY.",
- // "enum": [
- // "JOB_VIEW_UNKNOWN",
- // "JOB_VIEW_SUMMARY",
- // "JOB_VIEW_ALL"
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "v1b3/projects/{projectId}/jobs",
- // "response": {
- // "$ref": "ListJobsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/userinfo.email"
- // ]
- // }
-
-}
-
-// method id "dataflow.projects.jobs.update":
-
-type ProjectsJobsUpdateCall struct {
- s *Service
- projectId string
- jobId string
- job *Job
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates the state of an existing dataflow job.
-func (r *ProjectsJobsService) Update(projectId string, jobId string, job *Job) *ProjectsJobsUpdateCall {
- c := &ProjectsJobsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.jobId = jobId
- c.job = job
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsJobsUpdateCall) Fields(s ...googleapi.Field) *ProjectsJobsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsJobsUpdateCall) Context(ctx context.Context) *ProjectsJobsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsJobsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.job)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1b3/projects/{projectId}/jobs/{jobId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "jobId": c.jobId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dataflow.projects.jobs.update" call.
-// Exactly one of *Job or error will be non-nil. Any non-2xx status code
-// is an error. Response headers are in either
-// *Job.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *ProjectsJobsUpdateCall) Do() (*Job, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Job{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates the state of an existing dataflow job.",
- // "httpMethod": "PUT",
- // "id": "dataflow.projects.jobs.update",
- // "parameterOrder": [
- // "projectId",
- // "jobId"
- // ],
- // "parameters": {
- // "jobId": {
- // "description": "Identifies a single job.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "The project which owns the job.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1b3/projects/{projectId}/jobs/{jobId}",
- // "request": {
- // "$ref": "Job"
- // },
- // "response": {
- // "$ref": "Job"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/userinfo.email"
- // ]
- // }
-
-}
-
-// method id "dataflow.projects.jobs.messages.list":
-
-type ProjectsJobsMessagesListCall struct {
- s *Service
- projectId string
- jobId string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Request the job status.
-func (r *ProjectsJobsMessagesService) List(projectId string, jobId string) *ProjectsJobsMessagesListCall {
- c := &ProjectsJobsMessagesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.jobId = jobId
- return c
-}
-
-// EndTime sets the optional parameter "endTime": Return only messages
-// with timestamps < end_time. The default is now (i.e. return up to the
-// latest messages available).
-func (c *ProjectsJobsMessagesListCall) EndTime(endTime string) *ProjectsJobsMessagesListCall {
- c.opt_["endTime"] = endTime
- return c
-}
-
-// MinimumImportance sets the optional parameter "minimumImportance":
-// Filter to only get messages with importance >= level
-//
-// Possible values:
-// "JOB_MESSAGE_IMPORTANCE_UNKNOWN"
-// "JOB_MESSAGE_DEBUG"
-// "JOB_MESSAGE_DETAILED"
-// "JOB_MESSAGE_BASIC"
-// "JOB_MESSAGE_WARNING"
-// "JOB_MESSAGE_ERROR"
-func (c *ProjectsJobsMessagesListCall) MinimumImportance(minimumImportance string) *ProjectsJobsMessagesListCall {
- c.opt_["minimumImportance"] = minimumImportance
- return c
-}
-
-// PageSize sets the optional parameter "pageSize": If specified,
-// determines the maximum number of messages to return. If unspecified,
-// the service may choose an appropriate default, or may return an
-// arbitrarily large number of results.
-func (c *ProjectsJobsMessagesListCall) PageSize(pageSize int64) *ProjectsJobsMessagesListCall {
- c.opt_["pageSize"] = pageSize
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": If supplied, this
-// should be the value of next_page_token returned by an earlier call.
-// This will cause the next page of results to be returned.
-func (c *ProjectsJobsMessagesListCall) PageToken(pageToken string) *ProjectsJobsMessagesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// StartTime sets the optional parameter "startTime": If specified,
-// return only messages with timestamps >= start_time. The default is
-// the job creation time (i.e. beginning of messages).
-func (c *ProjectsJobsMessagesListCall) StartTime(startTime string) *ProjectsJobsMessagesListCall {
- c.opt_["startTime"] = startTime
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsJobsMessagesListCall) Fields(s ...googleapi.Field) *ProjectsJobsMessagesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ProjectsJobsMessagesListCall) IfNoneMatch(entityTag string) *ProjectsJobsMessagesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsJobsMessagesListCall) Context(ctx context.Context) *ProjectsJobsMessagesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsJobsMessagesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["endTime"]; ok {
- params.Set("endTime", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["minimumImportance"]; ok {
- params.Set("minimumImportance", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageSize"]; ok {
- params.Set("pageSize", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["startTime"]; ok {
- params.Set("startTime", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1b3/projects/{projectId}/jobs/{jobId}/messages")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "jobId": c.jobId,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dataflow.projects.jobs.messages.list" call.
-// Exactly one of *ListJobMessagesResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ListJobMessagesResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ProjectsJobsMessagesListCall) Do() (*ListJobMessagesResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ListJobMessagesResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Request the job status.",
- // "httpMethod": "GET",
- // "id": "dataflow.projects.jobs.messages.list",
- // "parameterOrder": [
- // "projectId",
- // "jobId"
- // ],
- // "parameters": {
- // "endTime": {
- // "description": "Return only messages with timestamps \u003c end_time. The default is now (i.e. return up to the latest messages available).",
- // "location": "query",
- // "type": "string"
- // },
- // "jobId": {
- // "description": "The job to get messages about.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "minimumImportance": {
- // "description": "Filter to only get messages with importance \u003e= level",
- // "enum": [
- // "JOB_MESSAGE_IMPORTANCE_UNKNOWN",
- // "JOB_MESSAGE_DEBUG",
- // "JOB_MESSAGE_DETAILED",
- // "JOB_MESSAGE_BASIC",
- // "JOB_MESSAGE_WARNING",
- // "JOB_MESSAGE_ERROR"
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "pageSize": {
- // "description": "If specified, determines the maximum number of messages to return. If unspecified, the service may choose an appropriate default, or may return an arbitrarily large number of results.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "If supplied, this should be the value of next_page_token returned by an earlier call. This will cause the next page of results to be returned.",
- // "location": "query",
- // "type": "string"
- // },
- // "projectId": {
- // "description": "A project id.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "startTime": {
- // "description": "If specified, return only messages with timestamps \u003e= start_time. The default is the job creation time (i.e. beginning of messages).",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "v1b3/projects/{projectId}/jobs/{jobId}/messages",
- // "response": {
- // "$ref": "ListJobMessagesResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/userinfo.email"
- // ]
- // }
-
-}
-
-// method id "dataflow.projects.jobs.workItems.lease":
-
-type ProjectsJobsWorkItemsLeaseCall struct {
- s *Service
- projectId string
- jobId string
- leaseworkitemrequest *LeaseWorkItemRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Lease: Leases a dataflow WorkItem to run.
-func (r *ProjectsJobsWorkItemsService) Lease(projectId string, jobId string, leaseworkitemrequest *LeaseWorkItemRequest) *ProjectsJobsWorkItemsLeaseCall {
- c := &ProjectsJobsWorkItemsLeaseCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.jobId = jobId
- c.leaseworkitemrequest = leaseworkitemrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsJobsWorkItemsLeaseCall) Fields(s ...googleapi.Field) *ProjectsJobsWorkItemsLeaseCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsJobsWorkItemsLeaseCall) Context(ctx context.Context) *ProjectsJobsWorkItemsLeaseCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsJobsWorkItemsLeaseCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.leaseworkitemrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "jobId": c.jobId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dataflow.projects.jobs.workItems.lease" call.
-// Exactly one of *LeaseWorkItemResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *LeaseWorkItemResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ProjectsJobsWorkItemsLeaseCall) Do() (*LeaseWorkItemResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &LeaseWorkItemResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Leases a dataflow WorkItem to run.",
- // "httpMethod": "POST",
- // "id": "dataflow.projects.jobs.workItems.lease",
- // "parameterOrder": [
- // "projectId",
- // "jobId"
- // ],
- // "parameters": {
- // "jobId": {
- // "description": "Identifies the workflow job this worker belongs to.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "Identifies the project this worker belongs to.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease",
- // "request": {
- // "$ref": "LeaseWorkItemRequest"
- // },
- // "response": {
- // "$ref": "LeaseWorkItemResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/userinfo.email"
- // ]
- // }
-
-}
-
-// method id "dataflow.projects.jobs.workItems.reportStatus":
-
-type ProjectsJobsWorkItemsReportStatusCall struct {
- s *Service
- projectId string
- jobId string
- reportworkitemstatusrequest *ReportWorkItemStatusRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// ReportStatus: Reports the status of dataflow WorkItems leased by a
-// worker.
-func (r *ProjectsJobsWorkItemsService) ReportStatus(projectId string, jobId string, reportworkitemstatusrequest *ReportWorkItemStatusRequest) *ProjectsJobsWorkItemsReportStatusCall {
- c := &ProjectsJobsWorkItemsReportStatusCall{s: r.s, opt_: make(map[string]interface{})}
- c.projectId = projectId
- c.jobId = jobId
- c.reportworkitemstatusrequest = reportworkitemstatusrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsJobsWorkItemsReportStatusCall) Fields(s ...googleapi.Field) *ProjectsJobsWorkItemsReportStatusCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsJobsWorkItemsReportStatusCall) Context(ctx context.Context) *ProjectsJobsWorkItemsReportStatusCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsJobsWorkItemsReportStatusCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.reportworkitemstatusrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "projectId": c.projectId,
- "jobId": c.jobId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dataflow.projects.jobs.workItems.reportStatus" call.
-// Exactly one of *ReportWorkItemStatusResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *ReportWorkItemStatusResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ProjectsJobsWorkItemsReportStatusCall) Do() (*ReportWorkItemStatusResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ReportWorkItemStatusResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Reports the status of dataflow WorkItems leased by a worker.",
- // "httpMethod": "POST",
- // "id": "dataflow.projects.jobs.workItems.reportStatus",
- // "parameterOrder": [
- // "projectId",
- // "jobId"
- // ],
- // "parameters": {
- // "jobId": {
- // "description": "The job which the WorkItem is part of.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "The project which owns the WorkItem's job.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus",
- // "request": {
- // "$ref": "ReportWorkItemStatusRequest"
- // },
- // "response": {
- // "$ref": "ReportWorkItemStatusResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/userinfo.email"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/datastore/v1beta1/datastore-api.json b/vendor/google.golang.org/api/datastore/v1beta1/datastore-api.json
deleted file mode 100644
index 1ba259d1..00000000
--- a/vendor/google.golang.org/api/datastore/v1beta1/datastore-api.json
+++ /dev/null
@@ -1,988 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/fIJ3DBpWQxusVwOa-ZxrsUl27A4\"",
- "discoveryVersion": "v1",
- "id": "datastore:v1beta1",
- "name": "datastore",
- "version": "v1beta1",
- "revision": "20150402",
- "title": "Google Cloud Datastore API",
- "description": "API for accessing Google Cloud Datastore.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/datastore/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/datastore/v1beta1/datasets/",
- "basePath": "/datastore/v1beta1/datasets/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "datastore/v1beta1/datasets/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "proto",
- "enum": [
- "json",
- "proto"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/datastore": {
- "description": "View and manage your Google Cloud Datastore data"
- },
- "https://www.googleapis.com/auth/userinfo.email": {
- "description": "View your email address"
- }
- }
- }
- },
- "schemas": {
- "AllocateIdsRequest": {
- "id": "AllocateIdsRequest",
- "type": "object",
- "properties": {
- "keys": {
- "type": "array",
- "description": "A list of keys with incomplete key paths to allocate IDs for. No key may be reserved/read-only.",
- "items": {
- "$ref": "Key"
- }
- }
- }
- },
- "AllocateIdsResponse": {
- "id": "AllocateIdsResponse",
- "type": "object",
- "properties": {
- "header": {
- "$ref": "ResponseHeader"
- },
- "keys": {
- "type": "array",
- "description": "The keys specified in the request (in the same order), each with its key path completed with a newly allocated ID.",
- "items": {
- "$ref": "Key"
- }
- }
- }
- },
- "BeginTransactionRequest": {
- "id": "BeginTransactionRequest",
- "type": "object",
- "properties": {
- "isolationLevel": {
- "type": "string",
- "description": "The transaction isolation level. Either snapshot or serializable. The default isolation level is snapshot isolation, which means that another transaction may not concurrently modify the data that is modified by this transaction. Optionally, a transaction can request to be made serializable which means that another transaction cannot concurrently modify the data that is read or modified by this transaction."
- }
- }
- },
- "BeginTransactionResponse": {
- "id": "BeginTransactionResponse",
- "type": "object",
- "properties": {
- "header": {
- "$ref": "ResponseHeader"
- },
- "transaction": {
- "type": "string",
- "description": "The transaction identifier (always present).",
- "format": "byte"
- }
- }
- },
- "BlindWriteRequest": {
- "id": "BlindWriteRequest",
- "type": "object",
- "properties": {
- "mutation": {
- "$ref": "Mutation",
- "description": "The mutation to perform."
- }
- }
- },
- "BlindWriteResponse": {
- "id": "BlindWriteResponse",
- "type": "object",
- "properties": {
- "header": {
- "$ref": "ResponseHeader"
- },
- "mutationResult": {
- "$ref": "MutationResult",
- "description": "The result of performing the mutation (always present)."
- }
- }
- },
- "CommitRequest": {
- "id": "CommitRequest",
- "type": "object",
- "properties": {
- "ignoreReadOnly": {
- "type": "boolean"
- },
- "mutation": {
- "$ref": "Mutation",
- "description": "The mutation to perform. Optional."
- },
- "transaction": {
- "type": "string",
- "description": "The transaction identifier, returned by a call to beginTransaction. Must be set when mode is TRANSACTIONAL.",
- "format": "byte"
- }
- }
- },
- "CommitResponse": {
- "id": "CommitResponse",
- "type": "object",
- "properties": {
- "header": {
- "$ref": "ResponseHeader"
- },
- "mutationResult": {
- "$ref": "MutationResult",
- "description": "The result of performing the mutation (if any)."
- }
- }
- },
- "CompositeFilter": {
- "id": "CompositeFilter",
- "type": "object",
- "description": "A filter that merges the multiple other filters using the given operation.",
- "properties": {
- "filters": {
- "type": "array",
- "description": "The list of filters to combine. Must contain at least one filter.",
- "items": {
- "$ref": "Filter"
- }
- },
- "operator": {
- "type": "string",
- "description": "The operator for combining multiple filters. Only \"and\" is currently supported."
- }
- }
- },
- "Entity": {
- "id": "Entity",
- "type": "object",
- "description": "An entity.",
- "properties": {
- "key": {
- "$ref": "Key",
- "description": "The entity's key.\n\nAn entity must have a key, unless otherwise documented (for example, an entity in Value.entityValue may have no key). An entity's kind is its key's path's last element's kind, or null if it has no key."
- },
- "properties": {
- "type": "object",
- "description": "The entity's properties.",
- "additionalProperties": {
- "$ref": "Property",
- "description": "The name of the property. A property name matching regex \"__.*__\" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. Cannot be \"\"."
- }
- }
- }
- },
- "EntityResult": {
- "id": "EntityResult",
- "type": "object",
- "description": "The result of fetching an entity from the datastore.",
- "properties": {
- "entity": {
- "$ref": "Entity",
- "description": "The resulting entity."
- }
- }
- },
- "Filter": {
- "id": "Filter",
- "type": "object",
- "description": "A holder for any type of filter. Exactly one field should be specified.",
- "properties": {
- "compositeFilter": {
- "$ref": "CompositeFilter",
- "description": "A composite filter."
- },
- "propertyFilter": {
- "$ref": "PropertyFilter",
- "description": "A filter on a property."
- }
- }
- },
- "GqlQuery": {
- "id": "GqlQuery",
- "type": "object",
- "description": "A GQL query.",
- "properties": {
- "allowLiteral": {
- "type": "boolean",
- "description": "When false, the query string must not contain a literal."
- },
- "nameArgs": {
- "type": "array",
- "description": "A named argument must set field GqlQueryArg.name. No two named arguments may have the same name. For each non-reserved named binding site in the query string, there must be a named argument with that name, but not necessarily the inverse.",
- "items": {
- "$ref": "GqlQueryArg"
- }
- },
- "numberArgs": {
- "type": "array",
- "description": "Numbered binding site @1 references the first numbered argument, effectively using 1-based indexing, rather than the usual 0. A numbered argument must NOT set field GqlQueryArg.name. For each binding site numbered i in query_string, there must be an ith numbered argument. The inverse must also be true.",
- "items": {
- "$ref": "GqlQueryArg"
- }
- },
- "queryString": {
- "type": "string",
- "description": "The query string."
- }
- }
- },
- "GqlQueryArg": {
- "id": "GqlQueryArg",
- "type": "object",
- "description": "A binding argument for a GQL query.",
- "properties": {
- "cursor": {
- "type": "string",
- "format": "byte"
- },
- "name": {
- "type": "string",
- "description": "Must match regex \"[A-Za-z_$][A-Za-z_$0-9]*\". Must not match regex \"__.*__\". Must not be \"\"."
- },
- "value": {
- "$ref": "Value"
- }
- }
- },
- "Key": {
- "id": "Key",
- "type": "object",
- "description": "A unique identifier for an entity.",
- "properties": {
- "partitionId": {
- "$ref": "PartitionId",
- "description": "Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition."
- },
- "path": {
- "type": "array",
- "description": "The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.",
- "items": {
- "$ref": "KeyPathElement"
- }
- }
- }
- },
- "KeyPathElement": {
- "id": "KeyPathElement",
- "type": "object",
- "description": "A (kind, ID/name) pair used to construct a key path.\n\nAt most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "The kind of the entity. A kind matching regex \"__.*__\" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be \"\"."
- },
- "name": {
- "type": "string",
- "description": "The name of the entity. A name matching regex \"__.*__\" is reserved/read-only. A name must not be more than 500 characters. Cannot be \"\"."
- }
- }
- },
- "KindExpression": {
- "id": "KindExpression",
- "type": "object",
- "description": "A representation of a kind.",
- "properties": {
- "name": {
- "type": "string",
- "description": "The name of the kind."
- }
- }
- },
- "LookupRequest": {
- "id": "LookupRequest",
- "type": "object",
- "properties": {
- "keys": {
- "type": "array",
- "description": "Keys of entities to look up from the datastore.",
- "items": {
- "$ref": "Key"
- }
- },
- "readOptions": {
- "$ref": "ReadOptions",
- "description": "Options for this lookup request. Optional."
- }
- }
- },
- "LookupResponse": {
- "id": "LookupResponse",
- "type": "object",
- "properties": {
- "deferred": {
- "type": "array",
- "description": "A list of keys that were not looked up due to resource constraints.",
- "items": {
- "$ref": "Key"
- }
- },
- "found": {
- "type": "array",
- "description": "Entities found.",
- "items": {
- "$ref": "EntityResult"
- }
- },
- "header": {
- "$ref": "ResponseHeader"
- },
- "missing": {
- "type": "array",
- "description": "Entities not found, with only the key populated.",
- "items": {
- "$ref": "EntityResult"
- }
- }
- }
- },
- "Mutation": {
- "id": "Mutation",
- "type": "object",
- "description": "A set of changes to apply.",
- "properties": {
- "delete": {
- "type": "array",
- "description": "Keys of entities to delete. Each key must have a complete key path and must not be reserved/read-only.",
- "items": {
- "$ref": "Key"
- }
- },
- "force": {
- "type": "boolean",
- "description": "Ignore a user specified read-only period. Optional."
- },
- "insert": {
- "type": "array",
- "description": "Entities to insert. Each inserted entity's key must have a complete path and must not be reserved/read-only.",
- "items": {
- "$ref": "Entity"
- }
- },
- "insertAutoId": {
- "type": "array",
- "description": "Insert entities with a newly allocated ID. Each inserted entity's key must omit the final identifier in its path and must not be reserved/read-only.",
- "items": {
- "$ref": "Entity"
- }
- },
- "update": {
- "type": "array",
- "description": "Entities to update. Each updated entity's key must have a complete path and must not be reserved/read-only.",
- "items": {
- "$ref": "Entity"
- }
- },
- "upsert": {
- "type": "array",
- "description": "Entities to upsert. Each upserted entity's key must have a complete path and must not be reserved/read-only.",
- "items": {
- "$ref": "Entity"
- }
- }
- }
- },
- "MutationResult": {
- "id": "MutationResult",
- "type": "object",
- "properties": {
- "indexUpdates": {
- "type": "integer",
- "description": "Number of index writes.",
- "format": "int32"
- },
- "insertAutoIdKeys": {
- "type": "array",
- "description": "Keys for insertAutoId entities. One per entity from the request, in the same order.",
- "items": {
- "$ref": "Key"
- }
- }
- }
- },
- "PartitionId": {
- "id": "PartitionId",
- "type": "object",
- "description": "An identifier for a particular subset of entities.\n\nEntities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.",
- "properties": {
- "datasetId": {
- "type": "string",
- "description": "The dataset ID."
- },
- "namespace": {
- "type": "string",
- "description": "The namespace."
- }
- }
- },
- "Property": {
- "id": "Property",
- "type": "object",
- "description": "An entity property.",
- "properties": {
- "multi": {
- "type": "boolean",
- "description": "If this property contains a list of values. Input values may explicitly set multi to false, but otherwise false is always represented by omitting multi."
- },
- "values": {
- "type": "array",
- "description": "The value(s) of the property. When multi is false there is always exactly one value. When multi is true there are always one or more values. Each value can have only one value property populated. For example, you cannot have a values list of { values: [ { integerValue: 22, stringValue: \"a\" } ] }, but you can have { multi: true, values: [ { integerValue: 22 }, { stringValue: \"a\" } ] }.",
- "items": {
- "$ref": "Value"
- }
- }
- }
- },
- "PropertyExpression": {
- "id": "PropertyExpression",
- "type": "object",
- "description": "A representation of a property in a projection.",
- "properties": {
- "aggregationFunction": {
- "type": "string",
- "description": "The aggregation function to apply to the property. Optional. Can only be used when grouping by at least one property. Must then be set on all properties in the projection that are not being grouped by. Aggregation functions: first selects the first result as determined by the query's order."
- },
- "property": {
- "$ref": "PropertyReference",
- "description": "The property to project."
- }
- }
- },
- "PropertyFilter": {
- "id": "PropertyFilter",
- "type": "object",
- "description": "A filter on a specific property.",
- "properties": {
- "operator": {
- "type": "string",
- "description": "The operator to filter by. One of lessThan, lessThanOrEqual, greaterThan, greaterThanOrEqual, equal, or hasAncestor."
- },
- "property": {
- "$ref": "PropertyReference",
- "description": "The property to filter by."
- },
- "value": {
- "$ref": "Value",
- "description": "The value to compare the property to."
- }
- }
- },
- "PropertyOrder": {
- "id": "PropertyOrder",
- "type": "object",
- "description": "The desired order for a specific property.",
- "properties": {
- "direction": {
- "type": "string",
- "description": "The direction to order by. One of ascending or descending. Optional, defaults to ascending."
- },
- "property": {
- "$ref": "PropertyReference",
- "description": "The property to order by."
- }
- }
- },
- "PropertyReference": {
- "id": "PropertyReference",
- "type": "object",
- "description": "A reference to a property relative to the kind expressions.",
- "properties": {
- "name": {
- "type": "string",
- "description": "The name of the property."
- }
- }
- },
- "Query": {
- "id": "Query",
- "type": "object",
- "description": "A query.",
- "properties": {
- "endCursor": {
- "type": "string",
- "description": "An ending point for the query results. Optional. Query cursors are returned in query result batches.",
- "format": "byte"
- },
- "filter": {
- "$ref": "Filter",
- "description": "The filter to apply (optional)."
- },
- "groupBy": {
- "type": "array",
- "description": "The properties to group by (if empty, no grouping is applied to the result set).",
- "items": {
- "$ref": "PropertyReference"
- }
- },
- "kinds": {
- "type": "array",
- "description": "The kinds to query (if empty, returns entities from all kinds).",
- "items": {
- "$ref": "KindExpression"
- }
- },
- "limit": {
- "type": "integer",
- "description": "The maximum number of results to return. Applies after all other constraints. Optional.",
- "format": "int32"
- },
- "offset": {
- "type": "integer",
- "description": "The number of results to skip. Applies before limit, but after all other constraints (optional, defaults to 0).",
- "format": "int32"
- },
- "order": {
- "type": "array",
- "description": "The order to apply to the query results (if empty, order is unspecified).",
- "items": {
- "$ref": "PropertyOrder"
- }
- },
- "projection": {
- "type": "array",
- "description": "The projection to return. If not set the entire entity is returned.",
- "items": {
- "$ref": "PropertyExpression"
- }
- },
- "startCursor": {
- "type": "string",
- "description": "A starting point for the query results. Optional. Query cursors are returned in query result batches.",
- "format": "byte"
- }
- }
- },
- "QueryResultBatch": {
- "id": "QueryResultBatch",
- "type": "object",
- "description": "A batch of results produced by a query.",
- "properties": {
- "endCursor": {
- "type": "string",
- "description": "A cursor that points to the position after the last result in the batch. May be absent. TODO(arfuller): Once all plans produce cursors update documentation here.",
- "format": "byte"
- },
- "entityResultType": {
- "type": "string",
- "description": "The result type for every entity in entityResults. full for full entities, projection for entities with only projected properties, keyOnly for entities with only a key."
- },
- "entityResults": {
- "type": "array",
- "description": "The results for this batch.",
- "items": {
- "$ref": "EntityResult"
- }
- },
- "moreResults": {
- "type": "string",
- "description": "The state of the query after the current batch. One of notFinished, moreResultsAfterLimit, noMoreResults."
- },
- "skippedResults": {
- "type": "integer",
- "description": "The number of results skipped because of Query.offset.",
- "format": "int32"
- }
- }
- },
- "ReadOptions": {
- "id": "ReadOptions",
- "type": "object",
- "properties": {
- "readConsistency": {
- "type": "string",
- "description": "The read consistency to use. One of default, strong, or eventual. Cannot be set when transaction is set. Lookup and ancestor queries default to strong, global queries default to eventual and cannot be set to strong. Optional. Default is default."
- },
- "transaction": {
- "type": "string",
- "description": "The transaction to use. Optional.",
- "format": "byte"
- }
- }
- },
- "ResponseHeader": {
- "id": "ResponseHeader",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"datastore#responseHeader\".",
- "default": "datastore#responseHeader"
- }
- }
- },
- "RollbackRequest": {
- "id": "RollbackRequest",
- "type": "object",
- "properties": {
- "transaction": {
- "type": "string",
- "description": "The transaction identifier, returned by a call to beginTransaction.",
- "format": "byte"
- }
- }
- },
- "RollbackResponse": {
- "id": "RollbackResponse",
- "type": "object",
- "properties": {
- "header": {
- "$ref": "ResponseHeader"
- }
- }
- },
- "RunQueryRequest": {
- "id": "RunQueryRequest",
- "type": "object",
- "properties": {
- "gqlQuery": {
- "$ref": "GqlQuery",
- "description": "The GQL query to run. Either this field or field query must be set, but not both."
- },
- "partitionId": {
- "$ref": "PartitionId",
- "description": "Entities are partitioned into subsets, identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID, but all other partition IDs in RunQueryRequest are normalized with this partition ID as the context partition ID."
- },
- "query": {
- "$ref": "Query",
- "description": "The query to run. Either this field or field gql_query must be set, but not both."
- },
- "readOptions": {
- "$ref": "ReadOptions",
- "description": "The options for this query."
- }
- }
- },
- "RunQueryResponse": {
- "id": "RunQueryResponse",
- "type": "object",
- "properties": {
- "batch": {
- "$ref": "QueryResultBatch",
- "description": "A batch of query results (always present)."
- },
- "header": {
- "$ref": "ResponseHeader"
- }
- }
- },
- "Value": {
- "id": "Value",
- "type": "object",
- "description": "A message that can hold any of the supported value types and associated metadata.",
- "properties": {
- "blobKeyValue": {
- "type": "string",
- "description": "A blob key value."
- },
- "blobValue": {
- "type": "string",
- "description": "A blob value. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.",
- "format": "byte"
- },
- "booleanValue": {
- "type": "boolean",
- "description": "A boolean value."
- },
- "dateTimeValue": {
- "type": "string",
- "description": "A timestamp value.",
- "format": "date-time"
- },
- "doubleValue": {
- "type": "number",
- "description": "A double value.",
- "format": "double"
- },
- "entityValue": {
- "$ref": "Entity",
- "description": "An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key."
- },
- "indexed": {
- "type": "boolean",
- "description": "If the value should be indexed.\n\nThe indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true."
- },
- "integerValue": {
- "type": "string",
- "description": "An integer value.",
- "format": "int64"
- },
- "keyValue": {
- "$ref": "Key",
- "description": "A key value."
- },
- "meaning": {
- "type": "integer",
- "description": "The meaning field is reserved and should not be used.",
- "format": "int32"
- },
- "stringValue": {
- "type": "string",
- "description": "A UTF-8 encoded string value. When indexed is true, may have at most 500 characters."
- }
- }
- }
- },
- "resources": {
- "datasets": {
- "methods": {
- "allocateIds": {
- "id": "datastore.datasets.allocateIds",
- "path": "{datasetId}/allocateIds",
- "httpMethod": "POST",
- "description": "Allocate IDs for incomplete keys (useful for referencing an entity before it is inserted).",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Identifies the dataset.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "datasetId"
- ],
- "request": {
- "$ref": "AllocateIdsRequest"
- },
- "response": {
- "$ref": "AllocateIdsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore",
- "https://www.googleapis.com/auth/userinfo.email"
- ]
- },
- "beginTransaction": {
- "id": "datastore.datasets.beginTransaction",
- "path": "{datasetId}/beginTransaction",
- "httpMethod": "POST",
- "description": "Begin a new transaction.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Identifies the dataset.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "datasetId"
- ],
- "request": {
- "$ref": "BeginTransactionRequest"
- },
- "response": {
- "$ref": "BeginTransactionResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore",
- "https://www.googleapis.com/auth/userinfo.email"
- ]
- },
- "blindWrite": {
- "id": "datastore.datasets.blindWrite",
- "path": "{datasetId}/blindWrite",
- "httpMethod": "POST",
- "description": "Create, delete or modify some entities outside a transaction.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Identifies the dataset.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "datasetId"
- ],
- "request": {
- "$ref": "BlindWriteRequest"
- },
- "response": {
- "$ref": "BlindWriteResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore",
- "https://www.googleapis.com/auth/userinfo.email"
- ]
- },
- "commit": {
- "id": "datastore.datasets.commit",
- "path": "{datasetId}/commit",
- "httpMethod": "POST",
- "description": "Commit a transaction, optionally creating, deleting or modifying some entities.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Identifies the dataset.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "datasetId"
- ],
- "request": {
- "$ref": "CommitRequest"
- },
- "response": {
- "$ref": "CommitResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore",
- "https://www.googleapis.com/auth/userinfo.email"
- ]
- },
- "lookup": {
- "id": "datastore.datasets.lookup",
- "path": "{datasetId}/lookup",
- "httpMethod": "POST",
- "description": "Look up some entities by key.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Identifies the dataset.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "datasetId"
- ],
- "request": {
- "$ref": "LookupRequest"
- },
- "response": {
- "$ref": "LookupResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore",
- "https://www.googleapis.com/auth/userinfo.email"
- ]
- },
- "rollback": {
- "id": "datastore.datasets.rollback",
- "path": "{datasetId}/rollback",
- "httpMethod": "POST",
- "description": "Roll back a transaction.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Identifies the dataset.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "datasetId"
- ],
- "request": {
- "$ref": "RollbackRequest"
- },
- "response": {
- "$ref": "RollbackResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore",
- "https://www.googleapis.com/auth/userinfo.email"
- ]
- },
- "runQuery": {
- "id": "datastore.datasets.runQuery",
- "path": "{datasetId}/runQuery",
- "httpMethod": "POST",
- "description": "Query for entities.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Identifies the dataset.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "datasetId"
- ],
- "request": {
- "$ref": "RunQueryRequest"
- },
- "response": {
- "$ref": "RunQueryResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore",
- "https://www.googleapis.com/auth/userinfo.email"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/datastore/v1beta1/datastore-gen.go b/vendor/google.golang.org/api/datastore/v1beta1/datastore-gen.go
deleted file mode 100644
index 38956b6e..00000000
--- a/vendor/google.golang.org/api/datastore/v1beta1/datastore-gen.go
+++ /dev/null
@@ -1,1990 +0,0 @@
-// Package datastore provides access to the Google Cloud Datastore API.
-//
-// See https://developers.google.com/datastore/
-//
-// Usage example:
-//
-// import "google.golang.org/api/datastore/v1beta1"
-// ...
-// datastoreService, err := datastore.New(oauthHttpClient)
-package datastore // import "google.golang.org/api/datastore/v1beta1"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "datastore:v1beta1"
-const apiName = "datastore"
-const apiVersion = "v1beta1"
-const basePath = "https://www.googleapis.com/datastore/v1beta1/datasets/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your data across Google Cloud Platform services
- CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
-
- // View and manage your Google Cloud Datastore data
- DatastoreScope = "https://www.googleapis.com/auth/datastore"
-
- // View your email address
- UserinfoEmailScope = "https://www.googleapis.com/auth/userinfo.email"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Datasets = NewDatasetsService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Datasets *DatasetsService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewDatasetsService(s *Service) *DatasetsService {
- rs := &DatasetsService{s: s}
- return rs
-}
-
-type DatasetsService struct {
- s *Service
-}
-
-type AllocateIdsRequest struct {
- // Keys: A list of keys with incomplete key paths to allocate IDs for.
- // No key may be reserved/read-only.
- Keys []*Key `json:"keys,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Keys") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AllocateIdsRequest) MarshalJSON() ([]byte, error) {
- type noMethod AllocateIdsRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AllocateIdsResponse struct {
- Header *ResponseHeader `json:"header,omitempty"`
-
- // Keys: The keys specified in the request (in the same order), each
- // with its key path completed with a newly allocated ID.
- Keys []*Key `json:"keys,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Header") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AllocateIdsResponse) MarshalJSON() ([]byte, error) {
- type noMethod AllocateIdsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type BeginTransactionRequest struct {
- // IsolationLevel: The transaction isolation level. Either snapshot or
- // serializable. The default isolation level is snapshot isolation,
- // which means that another transaction may not concurrently modify the
- // data that is modified by this transaction. Optionally, a transaction
- // can request to be made serializable which means that another
- // transaction cannot concurrently modify the data that is read or
- // modified by this transaction.
- IsolationLevel string `json:"isolationLevel,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "IsolationLevel") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BeginTransactionRequest) MarshalJSON() ([]byte, error) {
- type noMethod BeginTransactionRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type BeginTransactionResponse struct {
- Header *ResponseHeader `json:"header,omitempty"`
-
- // Transaction: The transaction identifier (always present).
- Transaction string `json:"transaction,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Header") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BeginTransactionResponse) MarshalJSON() ([]byte, error) {
- type noMethod BeginTransactionResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type BlindWriteRequest struct {
- // Mutation: The mutation to perform.
- Mutation *Mutation `json:"mutation,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Mutation") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BlindWriteRequest) MarshalJSON() ([]byte, error) {
- type noMethod BlindWriteRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type BlindWriteResponse struct {
- Header *ResponseHeader `json:"header,omitempty"`
-
- // MutationResult: The result of performing the mutation (always
- // present).
- MutationResult *MutationResult `json:"mutationResult,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Header") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BlindWriteResponse) MarshalJSON() ([]byte, error) {
- type noMethod BlindWriteResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CommitRequest struct {
- IgnoreReadOnly bool `json:"ignoreReadOnly,omitempty"`
-
- // Mutation: The mutation to perform. Optional.
- Mutation *Mutation `json:"mutation,omitempty"`
-
- // Transaction: The transaction identifier, returned by a call to
- // beginTransaction. Must be set when mode is TRANSACTIONAL.
- Transaction string `json:"transaction,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "IgnoreReadOnly") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CommitRequest) MarshalJSON() ([]byte, error) {
- type noMethod CommitRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CommitResponse struct {
- Header *ResponseHeader `json:"header,omitempty"`
-
- // MutationResult: The result of performing the mutation (if any).
- MutationResult *MutationResult `json:"mutationResult,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Header") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CommitResponse) MarshalJSON() ([]byte, error) {
- type noMethod CommitResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CompositeFilter: A filter that merges the multiple other filters
-// using the given operation.
-type CompositeFilter struct {
- // Filters: The list of filters to combine. Must contain at least one
- // filter.
- Filters []*Filter `json:"filters,omitempty"`
-
- // Operator: The operator for combining multiple filters. Only "and" is
- // currently supported.
- Operator string `json:"operator,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Filters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CompositeFilter) MarshalJSON() ([]byte, error) {
- type noMethod CompositeFilter
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Entity: An entity.
-type Entity struct {
- // Key: The entity's key.
- //
- // An entity must have a key, unless otherwise documented (for example,
- // an entity in Value.entityValue may have no key). An entity's kind is
- // its key's path's last element's kind, or null if it has no key.
- Key *Key `json:"key,omitempty"`
-
- // Properties: The entity's properties.
- Properties map[string]Property `json:"properties,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Entity) MarshalJSON() ([]byte, error) {
- type noMethod Entity
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// EntityResult: The result of fetching an entity from the datastore.
-type EntityResult struct {
- // Entity: The resulting entity.
- Entity *Entity `json:"entity,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Entity") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EntityResult) MarshalJSON() ([]byte, error) {
- type noMethod EntityResult
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Filter: A holder for any type of filter. Exactly one field should be
-// specified.
-type Filter struct {
- // CompositeFilter: A composite filter.
- CompositeFilter *CompositeFilter `json:"compositeFilter,omitempty"`
-
- // PropertyFilter: A filter on a property.
- PropertyFilter *PropertyFilter `json:"propertyFilter,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CompositeFilter") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Filter) MarshalJSON() ([]byte, error) {
- type noMethod Filter
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// GqlQuery: A GQL query.
-type GqlQuery struct {
- // AllowLiteral: When false, the query string must not contain a
- // literal.
- AllowLiteral bool `json:"allowLiteral,omitempty"`
-
- // NameArgs: A named argument must set field GqlQueryArg.name. No two
- // named arguments may have the same name. For each non-reserved named
- // binding site in the query string, there must be a named argument with
- // that name, but not necessarily the inverse.
- NameArgs []*GqlQueryArg `json:"nameArgs,omitempty"`
-
- // NumberArgs: Numbered binding site @1 references the first numbered
- // argument, effectively using 1-based indexing, rather than the usual
- // 0. A numbered argument must NOT set field GqlQueryArg.name. For each
- // binding site numbered i in query_string, there must be an ith
- // numbered argument. The inverse must also be true.
- NumberArgs []*GqlQueryArg `json:"numberArgs,omitempty"`
-
- // QueryString: The query string.
- QueryString string `json:"queryString,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AllowLiteral") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GqlQuery) MarshalJSON() ([]byte, error) {
- type noMethod GqlQuery
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// GqlQueryArg: A binding argument for a GQL query.
-type GqlQueryArg struct {
- Cursor string `json:"cursor,omitempty"`
-
- // Name: Must match regex "[A-Za-z_$][A-Za-z_$0-9]*". Must not match
- // regex "__.*__". Must not be "".
- Name string `json:"name,omitempty"`
-
- Value *Value `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Cursor") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GqlQueryArg) MarshalJSON() ([]byte, error) {
- type noMethod GqlQueryArg
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Key: A unique identifier for an entity.
-type Key struct {
- // PartitionId: Entities are partitioned into subsets, currently
- // identified by a dataset (usually implicitly specified by the project)
- // and namespace ID. Queries are scoped to a single partition.
- PartitionId *PartitionId `json:"partitionId,omitempty"`
-
- // Path: The entity path. An entity path consists of one or more
- // elements composed of a kind and a string or numerical identifier,
- // which identify entities. The first element identifies a root entity,
- // the second element identifies a child of the root entity, the third
- // element a child of the second entity, and so forth. The entities
- // identified by all prefixes of the path are called the element's
- // ancestors. An entity path is always fully complete: ALL of the
- // entity's ancestors are required to be in the path along with the
- // entity identifier itself. The only exception is that in some
- // documented cases, the identifier in the last path element (for the
- // entity) itself may be omitted. A path can never be empty. The path
- // can have at most 100 elements.
- Path []*KeyPathElement `json:"path,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "PartitionId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Key) MarshalJSON() ([]byte, error) {
- type noMethod Key
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// KeyPathElement: A (kind, ID/name) pair used to construct a key
-// path.
-//
-// At most one of name or ID may be set. If either is set, the element
-// is complete. If neither is set, the element is incomplete.
-type KeyPathElement struct {
- // Id: The ID of the entity. Never equal to zero. Values less than zero
- // are discouraged and will not be supported in the future.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: The kind of the entity. A kind matching regex "__.*__" is
- // reserved/read-only. A kind must not contain more than 500 characters.
- // Cannot be "".
- Kind string `json:"kind,omitempty"`
-
- // Name: The name of the entity. A name matching regex "__.*__" is
- // reserved/read-only. A name must not be more than 500 characters.
- // Cannot be "".
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *KeyPathElement) MarshalJSON() ([]byte, error) {
- type noMethod KeyPathElement
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// KindExpression: A representation of a kind.
-type KindExpression struct {
- // Name: The name of the kind.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Name") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *KindExpression) MarshalJSON() ([]byte, error) {
- type noMethod KindExpression
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type LookupRequest struct {
- // Keys: Keys of entities to look up from the datastore.
- Keys []*Key `json:"keys,omitempty"`
-
- // ReadOptions: Options for this lookup request. Optional.
- ReadOptions *ReadOptions `json:"readOptions,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Keys") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LookupRequest) MarshalJSON() ([]byte, error) {
- type noMethod LookupRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type LookupResponse struct {
- // Deferred: A list of keys that were not looked up due to resource
- // constraints.
- Deferred []*Key `json:"deferred,omitempty"`
-
- // Found: Entities found.
- Found []*EntityResult `json:"found,omitempty"`
-
- Header *ResponseHeader `json:"header,omitempty"`
-
- // Missing: Entities not found, with only the key populated.
- Missing []*EntityResult `json:"missing,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Deferred") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LookupResponse) MarshalJSON() ([]byte, error) {
- type noMethod LookupResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Mutation: A set of changes to apply.
-type Mutation struct {
- // Delete: Keys of entities to delete. Each key must have a complete key
- // path and must not be reserved/read-only.
- Delete []*Key `json:"delete,omitempty"`
-
- // Force: Ignore a user specified read-only period. Optional.
- Force bool `json:"force,omitempty"`
-
- // Insert: Entities to insert. Each inserted entity's key must have a
- // complete path and must not be reserved/read-only.
- Insert []*Entity `json:"insert,omitempty"`
-
- // InsertAutoId: Insert entities with a newly allocated ID. Each
- // inserted entity's key must omit the final identifier in its path and
- // must not be reserved/read-only.
- InsertAutoId []*Entity `json:"insertAutoId,omitempty"`
-
- // Update: Entities to update. Each updated entity's key must have a
- // complete path and must not be reserved/read-only.
- Update []*Entity `json:"update,omitempty"`
-
- // Upsert: Entities to upsert. Each upserted entity's key must have a
- // complete path and must not be reserved/read-only.
- Upsert []*Entity `json:"upsert,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Delete") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Mutation) MarshalJSON() ([]byte, error) {
- type noMethod Mutation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type MutationResult struct {
- // IndexUpdates: Number of index writes.
- IndexUpdates int64 `json:"indexUpdates,omitempty"`
-
- // InsertAutoIdKeys: Keys for insertAutoId entities. One per entity from
- // the request, in the same order.
- InsertAutoIdKeys []*Key `json:"insertAutoIdKeys,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "IndexUpdates") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MutationResult) MarshalJSON() ([]byte, error) {
- type noMethod MutationResult
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PartitionId: An identifier for a particular subset of
-// entities.
-//
-// Entities are partitioned into various subsets, each used by different
-// datasets and different namespaces within a dataset and so forth.
-type PartitionId struct {
- // DatasetId: The dataset ID.
- DatasetId string `json:"datasetId,omitempty"`
-
- // Namespace: The namespace.
- Namespace string `json:"namespace,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DatasetId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PartitionId) MarshalJSON() ([]byte, error) {
- type noMethod PartitionId
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Property: An entity property.
-type Property struct {
- // Multi: If this property contains a list of values. Input values may
- // explicitly set multi to false, but otherwise false is always
- // represented by omitting multi.
- Multi bool `json:"multi,omitempty"`
-
- // Values: The value(s) of the property. When multi is false there is
- // always exactly one value. When multi is true there are always one or
- // more values. Each value can have only one value property populated.
- // For example, you cannot have a values list of { values: [ {
- // integerValue: 22, stringValue: "a" } ] }, but you can have { multi:
- // true, values: [ { integerValue: 22 }, { stringValue: "a" } ] }.
- Values []*Value `json:"values,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Multi") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Property) MarshalJSON() ([]byte, error) {
- type noMethod Property
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PropertyExpression: A representation of a property in a projection.
-type PropertyExpression struct {
- // AggregationFunction: The aggregation function to apply to the
- // property. Optional. Can only be used when grouping by at least one
- // property. Must then be set on all properties in the projection that
- // are not being grouped by. Aggregation functions: first selects the
- // first result as determined by the query's order.
- AggregationFunction string `json:"aggregationFunction,omitempty"`
-
- // Property: The property to project.
- Property *PropertyReference `json:"property,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AggregationFunction")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PropertyExpression) MarshalJSON() ([]byte, error) {
- type noMethod PropertyExpression
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PropertyFilter: A filter on a specific property.
-type PropertyFilter struct {
- // Operator: The operator to filter by. One of lessThan,
- // lessThanOrEqual, greaterThan, greaterThanOrEqual, equal, or
- // hasAncestor.
- Operator string `json:"operator,omitempty"`
-
- // Property: The property to filter by.
- Property *PropertyReference `json:"property,omitempty"`
-
- // Value: The value to compare the property to.
- Value *Value `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Operator") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PropertyFilter) MarshalJSON() ([]byte, error) {
- type noMethod PropertyFilter
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PropertyOrder: The desired order for a specific property.
-type PropertyOrder struct {
- // Direction: The direction to order by. One of ascending or descending.
- // Optional, defaults to ascending.
- Direction string `json:"direction,omitempty"`
-
- // Property: The property to order by.
- Property *PropertyReference `json:"property,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Direction") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PropertyOrder) MarshalJSON() ([]byte, error) {
- type noMethod PropertyOrder
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PropertyReference: A reference to a property relative to the kind
-// expressions.
-type PropertyReference struct {
- // Name: The name of the property.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Name") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PropertyReference) MarshalJSON() ([]byte, error) {
- type noMethod PropertyReference
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Query: A query.
-type Query struct {
- // EndCursor: An ending point for the query results. Optional. Query
- // cursors are returned in query result batches.
- EndCursor string `json:"endCursor,omitempty"`
-
- // Filter: The filter to apply (optional).
- Filter *Filter `json:"filter,omitempty"`
-
- // GroupBy: The properties to group by (if empty, no grouping is applied
- // to the result set).
- GroupBy []*PropertyReference `json:"groupBy,omitempty"`
-
- // Kinds: The kinds to query (if empty, returns entities from all
- // kinds).
- Kinds []*KindExpression `json:"kinds,omitempty"`
-
- // Limit: The maximum number of results to return. Applies after all
- // other constraints. Optional.
- Limit int64 `json:"limit,omitempty"`
-
- // Offset: The number of results to skip. Applies before limit, but
- // after all other constraints (optional, defaults to 0).
- Offset int64 `json:"offset,omitempty"`
-
- // Order: The order to apply to the query results (if empty, order is
- // unspecified).
- Order []*PropertyOrder `json:"order,omitempty"`
-
- // Projection: The projection to return. If not set the entire entity is
- // returned.
- Projection []*PropertyExpression `json:"projection,omitempty"`
-
- // StartCursor: A starting point for the query results. Optional. Query
- // cursors are returned in query result batches.
- StartCursor string `json:"startCursor,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "EndCursor") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Query) MarshalJSON() ([]byte, error) {
- type noMethod Query
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// QueryResultBatch: A batch of results produced by a query.
-type QueryResultBatch struct {
- // EndCursor: A cursor that points to the position after the last result
- // in the batch. May be absent. TODO(arfuller): Once all plans produce
- // cursors update documentation here.
- EndCursor string `json:"endCursor,omitempty"`
-
- // EntityResultType: The result type for every entity in entityResults.
- // full for full entities, projection for entities with only projected
- // properties, keyOnly for entities with only a key.
- EntityResultType string `json:"entityResultType,omitempty"`
-
- // EntityResults: The results for this batch.
- EntityResults []*EntityResult `json:"entityResults,omitempty"`
-
- // MoreResults: The state of the query after the current batch. One of
- // notFinished, moreResultsAfterLimit, noMoreResults.
- MoreResults string `json:"moreResults,omitempty"`
-
- // SkippedResults: The number of results skipped because of
- // Query.offset.
- SkippedResults int64 `json:"skippedResults,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "EndCursor") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *QueryResultBatch) MarshalJSON() ([]byte, error) {
- type noMethod QueryResultBatch
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ReadOptions struct {
- // ReadConsistency: The read consistency to use. One of default, strong,
- // or eventual. Cannot be set when transaction is set. Lookup and
- // ancestor queries default to strong, global queries default to
- // eventual and cannot be set to strong. Optional. Default is default.
- ReadConsistency string `json:"readConsistency,omitempty"`
-
- // Transaction: The transaction to use. Optional.
- Transaction string `json:"transaction,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ReadConsistency") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReadOptions) MarshalJSON() ([]byte, error) {
- type noMethod ReadOptions
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ResponseHeader struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "datastore#responseHeader".
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ResponseHeader) MarshalJSON() ([]byte, error) {
- type noMethod ResponseHeader
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type RollbackRequest struct {
- // Transaction: The transaction identifier, returned by a call to
- // beginTransaction.
- Transaction string `json:"transaction,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Transaction") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RollbackRequest) MarshalJSON() ([]byte, error) {
- type noMethod RollbackRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type RollbackResponse struct {
- Header *ResponseHeader `json:"header,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Header") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RollbackResponse) MarshalJSON() ([]byte, error) {
- type noMethod RollbackResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type RunQueryRequest struct {
- // GqlQuery: The GQL query to run. Either this field or field query must
- // be set, but not both.
- GqlQuery *GqlQuery `json:"gqlQuery,omitempty"`
-
- // PartitionId: Entities are partitioned into subsets, identified by a
- // dataset (usually implicitly specified by the project) and namespace
- // ID. Queries are scoped to a single partition. This partition ID is
- // normalized with the standard default context partition ID, but all
- // other partition IDs in RunQueryRequest are normalized with this
- // partition ID as the context partition ID.
- PartitionId *PartitionId `json:"partitionId,omitempty"`
-
- // Query: The query to run. Either this field or field gql_query must be
- // set, but not both.
- Query *Query `json:"query,omitempty"`
-
- // ReadOptions: The options for this query.
- ReadOptions *ReadOptions `json:"readOptions,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "GqlQuery") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RunQueryRequest) MarshalJSON() ([]byte, error) {
- type noMethod RunQueryRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type RunQueryResponse struct {
- // Batch: A batch of query results (always present).
- Batch *QueryResultBatch `json:"batch,omitempty"`
-
- Header *ResponseHeader `json:"header,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Batch") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RunQueryResponse) MarshalJSON() ([]byte, error) {
- type noMethod RunQueryResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Value: A message that can hold any of the supported value types and
-// associated metadata.
-type Value struct {
- // BlobKeyValue: A blob key value.
- BlobKeyValue string `json:"blobKeyValue,omitempty"`
-
- // BlobValue: A blob value. May be a maximum of 1,000,000 bytes. When
- // indexed is true, may have at most 500 bytes.
- BlobValue string `json:"blobValue,omitempty"`
-
- // BooleanValue: A boolean value.
- BooleanValue bool `json:"booleanValue,omitempty"`
-
- // DateTimeValue: A timestamp value.
- DateTimeValue string `json:"dateTimeValue,omitempty"`
-
- // DoubleValue: A double value.
- DoubleValue float64 `json:"doubleValue,omitempty"`
-
- // EntityValue: An entity value. May have no key. May have a key with an
- // incomplete key path. May have a reserved/read-only key.
- EntityValue *Entity `json:"entityValue,omitempty"`
-
- // Indexed: If the value should be indexed.
- //
- // The indexed property may be set for a null value. When indexed is
- // true, stringValue is limited to 500 characters and the blob value is
- // limited to 500 bytes. Input values by default have indexed set to
- // true; however, you can explicitly set indexed to true if you want.
- // (An output value never has indexed explicitly set to true.) If a
- // value is itself an entity, it cannot have indexed set to true.
- Indexed bool `json:"indexed,omitempty"`
-
- // IntegerValue: An integer value.
- IntegerValue int64 `json:"integerValue,omitempty,string"`
-
- // KeyValue: A key value.
- KeyValue *Key `json:"keyValue,omitempty"`
-
- // Meaning: The meaning field is reserved and should not be used.
- Meaning int64 `json:"meaning,omitempty"`
-
- // StringValue: A UTF-8 encoded string value. When indexed is true, may
- // have at most 500 characters.
- StringValue string `json:"stringValue,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BlobKeyValue") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Value) MarshalJSON() ([]byte, error) {
- type noMethod Value
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "datastore.datasets.allocateIds":
-
-type DatasetsAllocateIdsCall struct {
- s *Service
- datasetId string
- allocateidsrequest *AllocateIdsRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AllocateIds: Allocate IDs for incomplete keys (useful for referencing
-// an entity before it is inserted).
-func (r *DatasetsService) AllocateIds(datasetId string, allocateidsrequest *AllocateIdsRequest) *DatasetsAllocateIdsCall {
- c := &DatasetsAllocateIdsCall{s: r.s, opt_: make(map[string]interface{})}
- c.datasetId = datasetId
- c.allocateidsrequest = allocateidsrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatasetsAllocateIdsCall) Fields(s ...googleapi.Field) *DatasetsAllocateIdsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatasetsAllocateIdsCall) Context(ctx context.Context) *DatasetsAllocateIdsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatasetsAllocateIdsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.allocateidsrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{datasetId}/allocateIds")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "datasetId": c.datasetId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "datastore.datasets.allocateIds" call.
-// Exactly one of *AllocateIdsResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AllocateIdsResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DatasetsAllocateIdsCall) Do() (*AllocateIdsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AllocateIdsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Allocate IDs for incomplete keys (useful for referencing an entity before it is inserted).",
- // "httpMethod": "POST",
- // "id": "datastore.datasets.allocateIds",
- // "parameterOrder": [
- // "datasetId"
- // ],
- // "parameters": {
- // "datasetId": {
- // "description": "Identifies the dataset.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{datasetId}/allocateIds",
- // "request": {
- // "$ref": "AllocateIdsRequest"
- // },
- // "response": {
- // "$ref": "AllocateIdsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/datastore",
- // "https://www.googleapis.com/auth/userinfo.email"
- // ]
- // }
-
-}
-
-// method id "datastore.datasets.beginTransaction":
-
-type DatasetsBeginTransactionCall struct {
- s *Service
- datasetId string
- begintransactionrequest *BeginTransactionRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// BeginTransaction: Begin a new transaction.
-func (r *DatasetsService) BeginTransaction(datasetId string, begintransactionrequest *BeginTransactionRequest) *DatasetsBeginTransactionCall {
- c := &DatasetsBeginTransactionCall{s: r.s, opt_: make(map[string]interface{})}
- c.datasetId = datasetId
- c.begintransactionrequest = begintransactionrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatasetsBeginTransactionCall) Fields(s ...googleapi.Field) *DatasetsBeginTransactionCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatasetsBeginTransactionCall) Context(ctx context.Context) *DatasetsBeginTransactionCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatasetsBeginTransactionCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.begintransactionrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{datasetId}/beginTransaction")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "datasetId": c.datasetId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "datastore.datasets.beginTransaction" call.
-// Exactly one of *BeginTransactionResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *BeginTransactionResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DatasetsBeginTransactionCall) Do() (*BeginTransactionResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &BeginTransactionResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Begin a new transaction.",
- // "httpMethod": "POST",
- // "id": "datastore.datasets.beginTransaction",
- // "parameterOrder": [
- // "datasetId"
- // ],
- // "parameters": {
- // "datasetId": {
- // "description": "Identifies the dataset.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{datasetId}/beginTransaction",
- // "request": {
- // "$ref": "BeginTransactionRequest"
- // },
- // "response": {
- // "$ref": "BeginTransactionResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/datastore",
- // "https://www.googleapis.com/auth/userinfo.email"
- // ]
- // }
-
-}
-
-// method id "datastore.datasets.blindWrite":
-
-type DatasetsBlindWriteCall struct {
- s *Service
- datasetId string
- blindwriterequest *BlindWriteRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// BlindWrite: Create, delete or modify some entities outside a
-// transaction.
-func (r *DatasetsService) BlindWrite(datasetId string, blindwriterequest *BlindWriteRequest) *DatasetsBlindWriteCall {
- c := &DatasetsBlindWriteCall{s: r.s, opt_: make(map[string]interface{})}
- c.datasetId = datasetId
- c.blindwriterequest = blindwriterequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatasetsBlindWriteCall) Fields(s ...googleapi.Field) *DatasetsBlindWriteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatasetsBlindWriteCall) Context(ctx context.Context) *DatasetsBlindWriteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatasetsBlindWriteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.blindwriterequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{datasetId}/blindWrite")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "datasetId": c.datasetId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "datastore.datasets.blindWrite" call.
-// Exactly one of *BlindWriteResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *BlindWriteResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DatasetsBlindWriteCall) Do() (*BlindWriteResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &BlindWriteResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Create, delete or modify some entities outside a transaction.",
- // "httpMethod": "POST",
- // "id": "datastore.datasets.blindWrite",
- // "parameterOrder": [
- // "datasetId"
- // ],
- // "parameters": {
- // "datasetId": {
- // "description": "Identifies the dataset.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{datasetId}/blindWrite",
- // "request": {
- // "$ref": "BlindWriteRequest"
- // },
- // "response": {
- // "$ref": "BlindWriteResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/datastore",
- // "https://www.googleapis.com/auth/userinfo.email"
- // ]
- // }
-
-}
-
-// method id "datastore.datasets.commit":
-
-type DatasetsCommitCall struct {
- s *Service
- datasetId string
- commitrequest *CommitRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Commit: Commit a transaction, optionally creating, deleting or
-// modifying some entities.
-func (r *DatasetsService) Commit(datasetId string, commitrequest *CommitRequest) *DatasetsCommitCall {
- c := &DatasetsCommitCall{s: r.s, opt_: make(map[string]interface{})}
- c.datasetId = datasetId
- c.commitrequest = commitrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatasetsCommitCall) Fields(s ...googleapi.Field) *DatasetsCommitCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatasetsCommitCall) Context(ctx context.Context) *DatasetsCommitCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatasetsCommitCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.commitrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{datasetId}/commit")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "datasetId": c.datasetId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "datastore.datasets.commit" call.
-// Exactly one of *CommitResponse or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CommitResponse.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DatasetsCommitCall) Do() (*CommitResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CommitResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Commit a transaction, optionally creating, deleting or modifying some entities.",
- // "httpMethod": "POST",
- // "id": "datastore.datasets.commit",
- // "parameterOrder": [
- // "datasetId"
- // ],
- // "parameters": {
- // "datasetId": {
- // "description": "Identifies the dataset.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{datasetId}/commit",
- // "request": {
- // "$ref": "CommitRequest"
- // },
- // "response": {
- // "$ref": "CommitResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/datastore",
- // "https://www.googleapis.com/auth/userinfo.email"
- // ]
- // }
-
-}
-
-// method id "datastore.datasets.lookup":
-
-type DatasetsLookupCall struct {
- s *Service
- datasetId string
- lookuprequest *LookupRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Lookup: Look up some entities by key.
-func (r *DatasetsService) Lookup(datasetId string, lookuprequest *LookupRequest) *DatasetsLookupCall {
- c := &DatasetsLookupCall{s: r.s, opt_: make(map[string]interface{})}
- c.datasetId = datasetId
- c.lookuprequest = lookuprequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatasetsLookupCall) Fields(s ...googleapi.Field) *DatasetsLookupCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatasetsLookupCall) Context(ctx context.Context) *DatasetsLookupCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatasetsLookupCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.lookuprequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{datasetId}/lookup")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "datasetId": c.datasetId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "datastore.datasets.lookup" call.
-// Exactly one of *LookupResponse or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *LookupResponse.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DatasetsLookupCall) Do() (*LookupResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &LookupResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Look up some entities by key.",
- // "httpMethod": "POST",
- // "id": "datastore.datasets.lookup",
- // "parameterOrder": [
- // "datasetId"
- // ],
- // "parameters": {
- // "datasetId": {
- // "description": "Identifies the dataset.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{datasetId}/lookup",
- // "request": {
- // "$ref": "LookupRequest"
- // },
- // "response": {
- // "$ref": "LookupResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/datastore",
- // "https://www.googleapis.com/auth/userinfo.email"
- // ]
- // }
-
-}
-
-// method id "datastore.datasets.rollback":
-
-type DatasetsRollbackCall struct {
- s *Service
- datasetId string
- rollbackrequest *RollbackRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Rollback: Roll back a transaction.
-func (r *DatasetsService) Rollback(datasetId string, rollbackrequest *RollbackRequest) *DatasetsRollbackCall {
- c := &DatasetsRollbackCall{s: r.s, opt_: make(map[string]interface{})}
- c.datasetId = datasetId
- c.rollbackrequest = rollbackrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatasetsRollbackCall) Fields(s ...googleapi.Field) *DatasetsRollbackCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatasetsRollbackCall) Context(ctx context.Context) *DatasetsRollbackCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatasetsRollbackCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.rollbackrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{datasetId}/rollback")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "datasetId": c.datasetId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "datastore.datasets.rollback" call.
-// Exactly one of *RollbackResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *RollbackResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DatasetsRollbackCall) Do() (*RollbackResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &RollbackResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Roll back a transaction.",
- // "httpMethod": "POST",
- // "id": "datastore.datasets.rollback",
- // "parameterOrder": [
- // "datasetId"
- // ],
- // "parameters": {
- // "datasetId": {
- // "description": "Identifies the dataset.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{datasetId}/rollback",
- // "request": {
- // "$ref": "RollbackRequest"
- // },
- // "response": {
- // "$ref": "RollbackResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/datastore",
- // "https://www.googleapis.com/auth/userinfo.email"
- // ]
- // }
-
-}
-
-// method id "datastore.datasets.runQuery":
-
-type DatasetsRunQueryCall struct {
- s *Service
- datasetId string
- runqueryrequest *RunQueryRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// RunQuery: Query for entities.
-func (r *DatasetsService) RunQuery(datasetId string, runqueryrequest *RunQueryRequest) *DatasetsRunQueryCall {
- c := &DatasetsRunQueryCall{s: r.s, opt_: make(map[string]interface{})}
- c.datasetId = datasetId
- c.runqueryrequest = runqueryrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatasetsRunQueryCall) Fields(s ...googleapi.Field) *DatasetsRunQueryCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatasetsRunQueryCall) Context(ctx context.Context) *DatasetsRunQueryCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatasetsRunQueryCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.runqueryrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{datasetId}/runQuery")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "datasetId": c.datasetId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "datastore.datasets.runQuery" call.
-// Exactly one of *RunQueryResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *RunQueryResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DatasetsRunQueryCall) Do() (*RunQueryResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &RunQueryResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Query for entities.",
- // "httpMethod": "POST",
- // "id": "datastore.datasets.runQuery",
- // "parameterOrder": [
- // "datasetId"
- // ],
- // "parameters": {
- // "datasetId": {
- // "description": "Identifies the dataset.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{datasetId}/runQuery",
- // "request": {
- // "$ref": "RunQueryRequest"
- // },
- // "response": {
- // "$ref": "RunQueryResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/datastore",
- // "https://www.googleapis.com/auth/userinfo.email"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/datastore/v1beta2/datastore-api.json b/vendor/google.golang.org/api/datastore/v1beta2/datastore-api.json
deleted file mode 100644
index 55388fe5..00000000
--- a/vendor/google.golang.org/api/datastore/v1beta2/datastore-api.json
+++ /dev/null
@@ -1,1075 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/JTCpJ6erGSGSQjeOlJBcixKgvo8\"",
- "discoveryVersion": "v1",
- "id": "datastore:v1beta2",
- "name": "datastore",
- "version": "v1beta2",
- "revision": "20150402",
- "title": "Google Cloud Datastore API",
- "description": "API for accessing Google Cloud Datastore.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/datastore/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/datastore/v1beta2/datasets/",
- "basePath": "/datastore/v1beta2/datasets/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "datastore/v1beta2/datasets/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "proto",
- "enum": [
- "json",
- "proto"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/datastore": {
- "description": "View and manage your Google Cloud Datastore data"
- },
- "https://www.googleapis.com/auth/userinfo.email": {
- "description": "View your email address"
- }
- }
- }
- },
- "schemas": {
- "AllocateIdsRequest": {
- "id": "AllocateIdsRequest",
- "type": "object",
- "properties": {
- "keys": {
- "type": "array",
- "description": "A list of keys with incomplete key paths to allocate IDs for. No key may be reserved/read-only.",
- "items": {
- "$ref": "Key"
- }
- }
- }
- },
- "AllocateIdsResponse": {
- "id": "AllocateIdsResponse",
- "type": "object",
- "properties": {
- "header": {
- "$ref": "ResponseHeader"
- },
- "keys": {
- "type": "array",
- "description": "The keys specified in the request (in the same order), each with its key path completed with a newly allocated ID.",
- "items": {
- "$ref": "Key"
- }
- }
- }
- },
- "BeginTransactionRequest": {
- "id": "BeginTransactionRequest",
- "type": "object",
- "properties": {
- "isolationLevel": {
- "type": "string",
- "description": "The transaction isolation level. Either snapshot or serializable. The default isolation level is snapshot isolation, which means that another transaction may not concurrently modify the data that is modified by this transaction. Optionally, a transaction can request to be made serializable which means that another transaction cannot concurrently modify the data that is read or modified by this transaction.",
- "enum": [
- "SERIALIZABLE",
- "SNAPSHOT"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- }
- }
- },
- "BeginTransactionResponse": {
- "id": "BeginTransactionResponse",
- "type": "object",
- "properties": {
- "header": {
- "$ref": "ResponseHeader"
- },
- "transaction": {
- "type": "string",
- "description": "The transaction identifier (always present).",
- "format": "byte"
- }
- }
- },
- "CommitRequest": {
- "id": "CommitRequest",
- "type": "object",
- "properties": {
- "ignoreReadOnly": {
- "type": "boolean"
- },
- "mode": {
- "type": "string",
- "description": "The type of commit to perform. Either TRANSACTIONAL or NON_TRANSACTIONAL.",
- "enum": [
- "NON_TRANSACTIONAL",
- "TRANSACTIONAL"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "mutation": {
- "$ref": "Mutation",
- "description": "The mutation to perform. Optional."
- },
- "transaction": {
- "type": "string",
- "description": "The transaction identifier, returned by a call to beginTransaction. Must be set when mode is TRANSACTIONAL.",
- "format": "byte"
- }
- }
- },
- "CommitResponse": {
- "id": "CommitResponse",
- "type": "object",
- "properties": {
- "header": {
- "$ref": "ResponseHeader"
- },
- "mutationResult": {
- "$ref": "MutationResult",
- "description": "The result of performing the mutation (if any)."
- }
- }
- },
- "CompositeFilter": {
- "id": "CompositeFilter",
- "type": "object",
- "description": "A filter that merges the multiple other filters using the given operation.",
- "properties": {
- "filters": {
- "type": "array",
- "description": "The list of filters to combine. Must contain at least one filter.",
- "items": {
- "$ref": "Filter"
- }
- },
- "operator": {
- "type": "string",
- "description": "The operator for combining multiple filters. Only \"and\" is currently supported.",
- "enum": [
- "AND"
- ],
- "enumDescriptions": [
- ""
- ]
- }
- }
- },
- "Entity": {
- "id": "Entity",
- "type": "object",
- "description": "An entity.",
- "properties": {
- "key": {
- "$ref": "Key",
- "description": "The entity's key.\n\nAn entity must have a key, unless otherwise documented (for example, an entity in Value.entityValue may have no key). An entity's kind is its key's path's last element's kind, or null if it has no key."
- },
- "properties": {
- "type": "object",
- "description": "The entity's properties.",
- "additionalProperties": {
- "$ref": "Property",
- "description": "The name of the property. A property name matching regex \"__.*__\" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. Cannot be \"\"."
- }
- }
- }
- },
- "EntityResult": {
- "id": "EntityResult",
- "type": "object",
- "description": "The result of fetching an entity from the datastore.",
- "properties": {
- "entity": {
- "$ref": "Entity",
- "description": "The resulting entity."
- }
- }
- },
- "Filter": {
- "id": "Filter",
- "type": "object",
- "description": "A holder for any type of filter. Exactly one field should be specified.",
- "properties": {
- "compositeFilter": {
- "$ref": "CompositeFilter",
- "description": "A composite filter."
- },
- "propertyFilter": {
- "$ref": "PropertyFilter",
- "description": "A filter on a property."
- }
- }
- },
- "GqlQuery": {
- "id": "GqlQuery",
- "type": "object",
- "description": "A GQL query.",
- "properties": {
- "allowLiteral": {
- "type": "boolean",
- "description": "When false, the query string must not contain a literal."
- },
- "nameArgs": {
- "type": "array",
- "description": "A named argument must set field GqlQueryArg.name. No two named arguments may have the same name. For each non-reserved named binding site in the query string, there must be a named argument with that name, but not necessarily the inverse.",
- "items": {
- "$ref": "GqlQueryArg"
- }
- },
- "numberArgs": {
- "type": "array",
- "description": "Numbered binding site @1 references the first numbered argument, effectively using 1-based indexing, rather than the usual 0. A numbered argument must NOT set field GqlQueryArg.name. For each binding site numbered i in query_string, there must be an ith numbered argument. The inverse must also be true.",
- "items": {
- "$ref": "GqlQueryArg"
- }
- },
- "queryString": {
- "type": "string",
- "description": "The query string."
- }
- }
- },
- "GqlQueryArg": {
- "id": "GqlQueryArg",
- "type": "object",
- "description": "A binding argument for a GQL query.",
- "properties": {
- "cursor": {
- "type": "string",
- "format": "byte"
- },
- "name": {
- "type": "string",
- "description": "Must match regex \"[A-Za-z_$][A-Za-z_$0-9]*\". Must not match regex \"__.*__\". Must not be \"\"."
- },
- "value": {
- "$ref": "Value"
- }
- }
- },
- "Key": {
- "id": "Key",
- "type": "object",
- "description": "A unique identifier for an entity.",
- "properties": {
- "partitionId": {
- "$ref": "PartitionId",
- "description": "Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition."
- },
- "path": {
- "type": "array",
- "description": "The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.",
- "items": {
- "$ref": "KeyPathElement"
- }
- }
- }
- },
- "KeyPathElement": {
- "id": "KeyPathElement",
- "type": "object",
- "description": "A (kind, ID/name) pair used to construct a key path.\n\nAt most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "The kind of the entity. A kind matching regex \"__.*__\" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be \"\"."
- },
- "name": {
- "type": "string",
- "description": "The name of the entity. A name matching regex \"__.*__\" is reserved/read-only. A name must not be more than 500 characters. Cannot be \"\"."
- }
- }
- },
- "KindExpression": {
- "id": "KindExpression",
- "type": "object",
- "description": "A representation of a kind.",
- "properties": {
- "name": {
- "type": "string",
- "description": "The name of the kind."
- }
- }
- },
- "LookupRequest": {
- "id": "LookupRequest",
- "type": "object",
- "properties": {
- "keys": {
- "type": "array",
- "description": "Keys of entities to look up from the datastore.",
- "items": {
- "$ref": "Key"
- }
- },
- "readOptions": {
- "$ref": "ReadOptions",
- "description": "Options for this lookup request. Optional."
- }
- }
- },
- "LookupResponse": {
- "id": "LookupResponse",
- "type": "object",
- "properties": {
- "deferred": {
- "type": "array",
- "description": "A list of keys that were not looked up due to resource constraints.",
- "items": {
- "$ref": "Key"
- }
- },
- "found": {
- "type": "array",
- "description": "Entities found.",
- "items": {
- "$ref": "EntityResult"
- }
- },
- "header": {
- "$ref": "ResponseHeader"
- },
- "missing": {
- "type": "array",
- "description": "Entities not found, with only the key populated.",
- "items": {
- "$ref": "EntityResult"
- }
- }
- }
- },
- "Mutation": {
- "id": "Mutation",
- "type": "object",
- "description": "A set of changes to apply.",
- "properties": {
- "delete": {
- "type": "array",
- "description": "Keys of entities to delete. Each key must have a complete key path and must not be reserved/read-only.",
- "items": {
- "$ref": "Key"
- }
- },
- "force": {
- "type": "boolean",
- "description": "Ignore a user specified read-only period. Optional."
- },
- "insert": {
- "type": "array",
- "description": "Entities to insert. Each inserted entity's key must have a complete path and must not be reserved/read-only.",
- "items": {
- "$ref": "Entity"
- }
- },
- "insertAutoId": {
- "type": "array",
- "description": "Insert entities with a newly allocated ID. Each inserted entity's key must omit the final identifier in its path and must not be reserved/read-only.",
- "items": {
- "$ref": "Entity"
- }
- },
- "update": {
- "type": "array",
- "description": "Entities to update. Each updated entity's key must have a complete path and must not be reserved/read-only.",
- "items": {
- "$ref": "Entity"
- }
- },
- "upsert": {
- "type": "array",
- "description": "Entities to upsert. Each upserted entity's key must have a complete path and must not be reserved/read-only.",
- "items": {
- "$ref": "Entity"
- }
- }
- }
- },
- "MutationResult": {
- "id": "MutationResult",
- "type": "object",
- "properties": {
- "indexUpdates": {
- "type": "integer",
- "description": "Number of index writes.",
- "format": "int32"
- },
- "insertAutoIdKeys": {
- "type": "array",
- "description": "Keys for insertAutoId entities. One per entity from the request, in the same order.",
- "items": {
- "$ref": "Key"
- }
- }
- }
- },
- "PartitionId": {
- "id": "PartitionId",
- "type": "object",
- "description": "An identifier for a particular subset of entities.\n\nEntities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.",
- "properties": {
- "datasetId": {
- "type": "string",
- "description": "The dataset ID."
- },
- "namespace": {
- "type": "string",
- "description": "The namespace."
- }
- }
- },
- "Property": {
- "id": "Property",
- "type": "object",
- "description": "An entity property.",
- "properties": {
- "blobKeyValue": {
- "type": "string",
- "description": "A blob key value."
- },
- "blobValue": {
- "type": "string",
- "description": "A blob value. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.",
- "format": "byte"
- },
- "booleanValue": {
- "type": "boolean",
- "description": "A boolean value."
- },
- "dateTimeValue": {
- "type": "string",
- "description": "A timestamp value.",
- "format": "date-time"
- },
- "doubleValue": {
- "type": "number",
- "description": "A double value.",
- "format": "double"
- },
- "entityValue": {
- "$ref": "Entity",
- "description": "An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key."
- },
- "indexed": {
- "type": "boolean",
- "description": "If the value should be indexed.\n\nThe indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true."
- },
- "integerValue": {
- "type": "string",
- "description": "An integer value.",
- "format": "int64"
- },
- "keyValue": {
- "$ref": "Key",
- "description": "A key value."
- },
- "listValue": {
- "type": "array",
- "description": "A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.",
- "items": {
- "$ref": "Value"
- }
- },
- "meaning": {
- "type": "integer",
- "description": "The meaning field is reserved and should not be used.",
- "format": "int32"
- },
- "stringValue": {
- "type": "string",
- "description": "A UTF-8 encoded string value. When indexed is true, may have at most 500 characters."
- }
- }
- },
- "PropertyExpression": {
- "id": "PropertyExpression",
- "type": "object",
- "description": "A representation of a property in a projection.",
- "properties": {
- "aggregationFunction": {
- "type": "string",
- "description": "The aggregation function to apply to the property. Optional. Can only be used when grouping by at least one property. Must then be set on all properties in the projection that are not being grouped by. Aggregation functions: first selects the first result as determined by the query's order.",
- "enum": [
- "FIRST"
- ],
- "enumDescriptions": [
- ""
- ]
- },
- "property": {
- "$ref": "PropertyReference",
- "description": "The property to project."
- }
- }
- },
- "PropertyFilter": {
- "id": "PropertyFilter",
- "type": "object",
- "description": "A filter on a specific property.",
- "properties": {
- "operator": {
- "type": "string",
- "description": "The operator to filter by. One of lessThan, lessThanOrEqual, greaterThan, greaterThanOrEqual, equal, or hasAncestor.",
- "enum": [
- "EQUAL",
- "GREATER_THAN",
- "GREATER_THAN_OR_EQUAL",
- "HAS_ANCESTOR",
- "LESS_THAN",
- "LESS_THAN_OR_EQUAL"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "property": {
- "$ref": "PropertyReference",
- "description": "The property to filter by."
- },
- "value": {
- "$ref": "Value",
- "description": "The value to compare the property to."
- }
- }
- },
- "PropertyOrder": {
- "id": "PropertyOrder",
- "type": "object",
- "description": "The desired order for a specific property.",
- "properties": {
- "direction": {
- "type": "string",
- "description": "The direction to order by. One of ascending or descending. Optional, defaults to ascending.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "property": {
- "$ref": "PropertyReference",
- "description": "The property to order by."
- }
- }
- },
- "PropertyReference": {
- "id": "PropertyReference",
- "type": "object",
- "description": "A reference to a property relative to the kind expressions.",
- "properties": {
- "name": {
- "type": "string",
- "description": "The name of the property."
- }
- }
- },
- "Query": {
- "id": "Query",
- "type": "object",
- "description": "A query.",
- "properties": {
- "endCursor": {
- "type": "string",
- "description": "An ending point for the query results. Optional. Query cursors are returned in query result batches.",
- "format": "byte"
- },
- "filter": {
- "$ref": "Filter",
- "description": "The filter to apply (optional)."
- },
- "groupBy": {
- "type": "array",
- "description": "The properties to group by (if empty, no grouping is applied to the result set).",
- "items": {
- "$ref": "PropertyReference"
- }
- },
- "kinds": {
- "type": "array",
- "description": "The kinds to query (if empty, returns entities from all kinds).",
- "items": {
- "$ref": "KindExpression"
- }
- },
- "limit": {
- "type": "integer",
- "description": "The maximum number of results to return. Applies after all other constraints. Optional.",
- "format": "int32"
- },
- "offset": {
- "type": "integer",
- "description": "The number of results to skip. Applies before limit, but after all other constraints (optional, defaults to 0).",
- "format": "int32"
- },
- "order": {
- "type": "array",
- "description": "The order to apply to the query results (if empty, order is unspecified).",
- "items": {
- "$ref": "PropertyOrder"
- }
- },
- "projection": {
- "type": "array",
- "description": "The projection to return. If not set the entire entity is returned.",
- "items": {
- "$ref": "PropertyExpression"
- }
- },
- "startCursor": {
- "type": "string",
- "description": "A starting point for the query results. Optional. Query cursors are returned in query result batches.",
- "format": "byte"
- }
- }
- },
- "QueryResultBatch": {
- "id": "QueryResultBatch",
- "type": "object",
- "description": "A batch of results produced by a query.",
- "properties": {
- "endCursor": {
- "type": "string",
- "description": "A cursor that points to the position after the last result in the batch. May be absent. TODO(arfuller): Once all plans produce cursors update documentation here.",
- "format": "byte"
- },
- "entityResultType": {
- "type": "string",
- "description": "The result type for every entity in entityResults. full for full entities, projection for entities with only projected properties, keyOnly for entities with only a key.",
- "enum": [
- "FULL",
- "KEY_ONLY",
- "PROJECTION"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "entityResults": {
- "type": "array",
- "description": "The results for this batch.",
- "items": {
- "$ref": "EntityResult"
- }
- },
- "moreResults": {
- "type": "string",
- "description": "The state of the query after the current batch. One of notFinished, moreResultsAfterLimit, noMoreResults.",
- "enum": [
- "MORE_RESULTS_AFTER_LIMIT",
- "NOT_FINISHED",
- "NO_MORE_RESULTS"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "skippedResults": {
- "type": "integer",
- "description": "The number of results skipped because of Query.offset.",
- "format": "int32"
- }
- }
- },
- "ReadOptions": {
- "id": "ReadOptions",
- "type": "object",
- "properties": {
- "readConsistency": {
- "type": "string",
- "description": "The read consistency to use. One of default, strong, or eventual. Cannot be set when transaction is set. Lookup and ancestor queries default to strong, global queries default to eventual and cannot be set to strong. Optional. Default is default.",
- "enum": [
- "DEFAULT",
- "EVENTUAL",
- "STRONG"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "transaction": {
- "type": "string",
- "description": "The transaction to use. Optional.",
- "format": "byte"
- }
- }
- },
- "ResponseHeader": {
- "id": "ResponseHeader",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"datastore#responseHeader\".",
- "default": "datastore#responseHeader"
- }
- }
- },
- "RollbackRequest": {
- "id": "RollbackRequest",
- "type": "object",
- "properties": {
- "transaction": {
- "type": "string",
- "description": "The transaction identifier, returned by a call to beginTransaction.",
- "format": "byte"
- }
- }
- },
- "RollbackResponse": {
- "id": "RollbackResponse",
- "type": "object",
- "properties": {
- "header": {
- "$ref": "ResponseHeader"
- }
- }
- },
- "RunQueryRequest": {
- "id": "RunQueryRequest",
- "type": "object",
- "properties": {
- "gqlQuery": {
- "$ref": "GqlQuery",
- "description": "The GQL query to run. Either this field or field query must be set, but not both."
- },
- "partitionId": {
- "$ref": "PartitionId",
- "description": "Entities are partitioned into subsets, identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID, but all other partition IDs in RunQueryRequest are normalized with this partition ID as the context partition ID."
- },
- "query": {
- "$ref": "Query",
- "description": "The query to run. Either this field or field gql_query must be set, but not both."
- },
- "readOptions": {
- "$ref": "ReadOptions",
- "description": "The options for this query."
- }
- }
- },
- "RunQueryResponse": {
- "id": "RunQueryResponse",
- "type": "object",
- "properties": {
- "batch": {
- "$ref": "QueryResultBatch",
- "description": "A batch of query results (always present)."
- },
- "header": {
- "$ref": "ResponseHeader"
- }
- }
- },
- "Value": {
- "id": "Value",
- "type": "object",
- "description": "A message that can hold any of the supported value types and associated metadata.",
- "properties": {
- "blobKeyValue": {
- "type": "string",
- "description": "A blob key value."
- },
- "blobValue": {
- "type": "string",
- "description": "A blob value. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.",
- "format": "byte"
- },
- "booleanValue": {
- "type": "boolean",
- "description": "A boolean value."
- },
- "dateTimeValue": {
- "type": "string",
- "description": "A timestamp value.",
- "format": "date-time"
- },
- "doubleValue": {
- "type": "number",
- "description": "A double value.",
- "format": "double"
- },
- "entityValue": {
- "$ref": "Entity",
- "description": "An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key."
- },
- "indexed": {
- "type": "boolean",
- "description": "If the value should be indexed.\n\nThe indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true."
- },
- "integerValue": {
- "type": "string",
- "description": "An integer value.",
- "format": "int64"
- },
- "keyValue": {
- "$ref": "Key",
- "description": "A key value."
- },
- "listValue": {
- "type": "array",
- "description": "A list value. Cannot contain another list value. A Value instance that sets field list_value must not set field meaning or field indexed.",
- "items": {
- "$ref": "Value"
- }
- },
- "meaning": {
- "type": "integer",
- "description": "The meaning field is reserved and should not be used.",
- "format": "int32"
- },
- "stringValue": {
- "type": "string",
- "description": "A UTF-8 encoded string value. When indexed is true, may have at most 500 characters."
- }
- }
- }
- },
- "resources": {
- "datasets": {
- "methods": {
- "allocateIds": {
- "id": "datastore.datasets.allocateIds",
- "path": "{datasetId}/allocateIds",
- "httpMethod": "POST",
- "description": "Allocate IDs for incomplete keys (useful for referencing an entity before it is inserted).",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Identifies the dataset.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "datasetId"
- ],
- "request": {
- "$ref": "AllocateIdsRequest"
- },
- "response": {
- "$ref": "AllocateIdsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore",
- "https://www.googleapis.com/auth/userinfo.email"
- ]
- },
- "beginTransaction": {
- "id": "datastore.datasets.beginTransaction",
- "path": "{datasetId}/beginTransaction",
- "httpMethod": "POST",
- "description": "Begin a new transaction.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Identifies the dataset.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "datasetId"
- ],
- "request": {
- "$ref": "BeginTransactionRequest"
- },
- "response": {
- "$ref": "BeginTransactionResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore",
- "https://www.googleapis.com/auth/userinfo.email"
- ]
- },
- "commit": {
- "id": "datastore.datasets.commit",
- "path": "{datasetId}/commit",
- "httpMethod": "POST",
- "description": "Commit a transaction, optionally creating, deleting or modifying some entities.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Identifies the dataset.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "datasetId"
- ],
- "request": {
- "$ref": "CommitRequest"
- },
- "response": {
- "$ref": "CommitResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore",
- "https://www.googleapis.com/auth/userinfo.email"
- ]
- },
- "lookup": {
- "id": "datastore.datasets.lookup",
- "path": "{datasetId}/lookup",
- "httpMethod": "POST",
- "description": "Look up some entities by key.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Identifies the dataset.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "datasetId"
- ],
- "request": {
- "$ref": "LookupRequest"
- },
- "response": {
- "$ref": "LookupResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore",
- "https://www.googleapis.com/auth/userinfo.email"
- ]
- },
- "rollback": {
- "id": "datastore.datasets.rollback",
- "path": "{datasetId}/rollback",
- "httpMethod": "POST",
- "description": "Roll back a transaction.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Identifies the dataset.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "datasetId"
- ],
- "request": {
- "$ref": "RollbackRequest"
- },
- "response": {
- "$ref": "RollbackResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore",
- "https://www.googleapis.com/auth/userinfo.email"
- ]
- },
- "runQuery": {
- "id": "datastore.datasets.runQuery",
- "path": "{datasetId}/runQuery",
- "httpMethod": "POST",
- "description": "Query for entities.",
- "parameters": {
- "datasetId": {
- "type": "string",
- "description": "Identifies the dataset.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "datasetId"
- ],
- "request": {
- "$ref": "RunQueryRequest"
- },
- "response": {
- "$ref": "RunQueryResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore",
- "https://www.googleapis.com/auth/userinfo.email"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/datastore/v1beta2/datastore-gen.go b/vendor/google.golang.org/api/datastore/v1beta2/datastore-gen.go
deleted file mode 100644
index af4ce191..00000000
--- a/vendor/google.golang.org/api/datastore/v1beta2/datastore-gen.go
+++ /dev/null
@@ -1,1903 +0,0 @@
-// Package datastore provides access to the Google Cloud Datastore API.
-//
-// See https://developers.google.com/datastore/
-//
-// Usage example:
-//
-// import "google.golang.org/api/datastore/v1beta2"
-// ...
-// datastoreService, err := datastore.New(oauthHttpClient)
-package datastore // import "google.golang.org/api/datastore/v1beta2"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "datastore:v1beta2"
-const apiName = "datastore"
-const apiVersion = "v1beta2"
-const basePath = "https://www.googleapis.com/datastore/v1beta2/datasets/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your data across Google Cloud Platform services
- CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
-
- // View and manage your Google Cloud Datastore data
- DatastoreScope = "https://www.googleapis.com/auth/datastore"
-
- // View your email address
- UserinfoEmailScope = "https://www.googleapis.com/auth/userinfo.email"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Datasets = NewDatasetsService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Datasets *DatasetsService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewDatasetsService(s *Service) *DatasetsService {
- rs := &DatasetsService{s: s}
- return rs
-}
-
-type DatasetsService struct {
- s *Service
-}
-
-type AllocateIdsRequest struct {
- // Keys: A list of keys with incomplete key paths to allocate IDs for.
- // No key may be reserved/read-only.
- Keys []*Key `json:"keys,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Keys") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AllocateIdsRequest) MarshalJSON() ([]byte, error) {
- type noMethod AllocateIdsRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type AllocateIdsResponse struct {
- Header *ResponseHeader `json:"header,omitempty"`
-
- // Keys: The keys specified in the request (in the same order), each
- // with its key path completed with a newly allocated ID.
- Keys []*Key `json:"keys,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Header") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AllocateIdsResponse) MarshalJSON() ([]byte, error) {
- type noMethod AllocateIdsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type BeginTransactionRequest struct {
- // IsolationLevel: The transaction isolation level. Either snapshot or
- // serializable. The default isolation level is snapshot isolation,
- // which means that another transaction may not concurrently modify the
- // data that is modified by this transaction. Optionally, a transaction
- // can request to be made serializable which means that another
- // transaction cannot concurrently modify the data that is read or
- // modified by this transaction.
- //
- // Possible values:
- // "SERIALIZABLE"
- // "SNAPSHOT"
- IsolationLevel string `json:"isolationLevel,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "IsolationLevel") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BeginTransactionRequest) MarshalJSON() ([]byte, error) {
- type noMethod BeginTransactionRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type BeginTransactionResponse struct {
- Header *ResponseHeader `json:"header,omitempty"`
-
- // Transaction: The transaction identifier (always present).
- Transaction string `json:"transaction,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Header") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BeginTransactionResponse) MarshalJSON() ([]byte, error) {
- type noMethod BeginTransactionResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CommitRequest struct {
- IgnoreReadOnly bool `json:"ignoreReadOnly,omitempty"`
-
- // Mode: The type of commit to perform. Either TRANSACTIONAL or
- // NON_TRANSACTIONAL.
- //
- // Possible values:
- // "NON_TRANSACTIONAL"
- // "TRANSACTIONAL"
- Mode string `json:"mode,omitempty"`
-
- // Mutation: The mutation to perform. Optional.
- Mutation *Mutation `json:"mutation,omitempty"`
-
- // Transaction: The transaction identifier, returned by a call to
- // beginTransaction. Must be set when mode is TRANSACTIONAL.
- Transaction string `json:"transaction,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "IgnoreReadOnly") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CommitRequest) MarshalJSON() ([]byte, error) {
- type noMethod CommitRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type CommitResponse struct {
- Header *ResponseHeader `json:"header,omitempty"`
-
- // MutationResult: The result of performing the mutation (if any).
- MutationResult *MutationResult `json:"mutationResult,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Header") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CommitResponse) MarshalJSON() ([]byte, error) {
- type noMethod CommitResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CompositeFilter: A filter that merges the multiple other filters
-// using the given operation.
-type CompositeFilter struct {
- // Filters: The list of filters to combine. Must contain at least one
- // filter.
- Filters []*Filter `json:"filters,omitempty"`
-
- // Operator: The operator for combining multiple filters. Only "and" is
- // currently supported.
- //
- // Possible values:
- // "AND"
- Operator string `json:"operator,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Filters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CompositeFilter) MarshalJSON() ([]byte, error) {
- type noMethod CompositeFilter
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Entity: An entity.
-type Entity struct {
- // Key: The entity's key.
- //
- // An entity must have a key, unless otherwise documented (for example,
- // an entity in Value.entityValue may have no key). An entity's kind is
- // its key's path's last element's kind, or null if it has no key.
- Key *Key `json:"key,omitempty"`
-
- // Properties: The entity's properties.
- Properties map[string]Property `json:"properties,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Entity) MarshalJSON() ([]byte, error) {
- type noMethod Entity
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// EntityResult: The result of fetching an entity from the datastore.
-type EntityResult struct {
- // Entity: The resulting entity.
- Entity *Entity `json:"entity,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Entity") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EntityResult) MarshalJSON() ([]byte, error) {
- type noMethod EntityResult
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Filter: A holder for any type of filter. Exactly one field should be
-// specified.
-type Filter struct {
- // CompositeFilter: A composite filter.
- CompositeFilter *CompositeFilter `json:"compositeFilter,omitempty"`
-
- // PropertyFilter: A filter on a property.
- PropertyFilter *PropertyFilter `json:"propertyFilter,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CompositeFilter") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Filter) MarshalJSON() ([]byte, error) {
- type noMethod Filter
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// GqlQuery: A GQL query.
-type GqlQuery struct {
- // AllowLiteral: When false, the query string must not contain a
- // literal.
- AllowLiteral bool `json:"allowLiteral,omitempty"`
-
- // NameArgs: A named argument must set field GqlQueryArg.name. No two
- // named arguments may have the same name. For each non-reserved named
- // binding site in the query string, there must be a named argument with
- // that name, but not necessarily the inverse.
- NameArgs []*GqlQueryArg `json:"nameArgs,omitempty"`
-
- // NumberArgs: Numbered binding site @1 references the first numbered
- // argument, effectively using 1-based indexing, rather than the usual
- // 0. A numbered argument must NOT set field GqlQueryArg.name. For each
- // binding site numbered i in query_string, there must be an ith
- // numbered argument. The inverse must also be true.
- NumberArgs []*GqlQueryArg `json:"numberArgs,omitempty"`
-
- // QueryString: The query string.
- QueryString string `json:"queryString,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AllowLiteral") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GqlQuery) MarshalJSON() ([]byte, error) {
- type noMethod GqlQuery
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// GqlQueryArg: A binding argument for a GQL query.
-type GqlQueryArg struct {
- Cursor string `json:"cursor,omitempty"`
-
- // Name: Must match regex "[A-Za-z_$][A-Za-z_$0-9]*". Must not match
- // regex "__.*__". Must not be "".
- Name string `json:"name,omitempty"`
-
- Value *Value `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Cursor") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GqlQueryArg) MarshalJSON() ([]byte, error) {
- type noMethod GqlQueryArg
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Key: A unique identifier for an entity.
-type Key struct {
- // PartitionId: Entities are partitioned into subsets, currently
- // identified by a dataset (usually implicitly specified by the project)
- // and namespace ID. Queries are scoped to a single partition.
- PartitionId *PartitionId `json:"partitionId,omitempty"`
-
- // Path: The entity path. An entity path consists of one or more
- // elements composed of a kind and a string or numerical identifier,
- // which identify entities. The first element identifies a root entity,
- // the second element identifies a child of the root entity, the third
- // element a child of the second entity, and so forth. The entities
- // identified by all prefixes of the path are called the element's
- // ancestors. An entity path is always fully complete: ALL of the
- // entity's ancestors are required to be in the path along with the
- // entity identifier itself. The only exception is that in some
- // documented cases, the identifier in the last path element (for the
- // entity) itself may be omitted. A path can never be empty. The path
- // can have at most 100 elements.
- Path []*KeyPathElement `json:"path,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "PartitionId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Key) MarshalJSON() ([]byte, error) {
- type noMethod Key
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// KeyPathElement: A (kind, ID/name) pair used to construct a key
-// path.
-//
-// At most one of name or ID may be set. If either is set, the element
-// is complete. If neither is set, the element is incomplete.
-type KeyPathElement struct {
- // Id: The ID of the entity. Never equal to zero. Values less than zero
- // are discouraged and will not be supported in the future.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: The kind of the entity. A kind matching regex "__.*__" is
- // reserved/read-only. A kind must not contain more than 500 characters.
- // Cannot be "".
- Kind string `json:"kind,omitempty"`
-
- // Name: The name of the entity. A name matching regex "__.*__" is
- // reserved/read-only. A name must not be more than 500 characters.
- // Cannot be "".
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *KeyPathElement) MarshalJSON() ([]byte, error) {
- type noMethod KeyPathElement
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// KindExpression: A representation of a kind.
-type KindExpression struct {
- // Name: The name of the kind.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Name") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *KindExpression) MarshalJSON() ([]byte, error) {
- type noMethod KindExpression
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type LookupRequest struct {
- // Keys: Keys of entities to look up from the datastore.
- Keys []*Key `json:"keys,omitempty"`
-
- // ReadOptions: Options for this lookup request. Optional.
- ReadOptions *ReadOptions `json:"readOptions,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Keys") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LookupRequest) MarshalJSON() ([]byte, error) {
- type noMethod LookupRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type LookupResponse struct {
- // Deferred: A list of keys that were not looked up due to resource
- // constraints.
- Deferred []*Key `json:"deferred,omitempty"`
-
- // Found: Entities found.
- Found []*EntityResult `json:"found,omitempty"`
-
- Header *ResponseHeader `json:"header,omitempty"`
-
- // Missing: Entities not found, with only the key populated.
- Missing []*EntityResult `json:"missing,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Deferred") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LookupResponse) MarshalJSON() ([]byte, error) {
- type noMethod LookupResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Mutation: A set of changes to apply.
-type Mutation struct {
- // Delete: Keys of entities to delete. Each key must have a complete key
- // path and must not be reserved/read-only.
- Delete []*Key `json:"delete,omitempty"`
-
- // Force: Ignore a user specified read-only period. Optional.
- Force bool `json:"force,omitempty"`
-
- // Insert: Entities to insert. Each inserted entity's key must have a
- // complete path and must not be reserved/read-only.
- Insert []*Entity `json:"insert,omitempty"`
-
- // InsertAutoId: Insert entities with a newly allocated ID. Each
- // inserted entity's key must omit the final identifier in its path and
- // must not be reserved/read-only.
- InsertAutoId []*Entity `json:"insertAutoId,omitempty"`
-
- // Update: Entities to update. Each updated entity's key must have a
- // complete path and must not be reserved/read-only.
- Update []*Entity `json:"update,omitempty"`
-
- // Upsert: Entities to upsert. Each upserted entity's key must have a
- // complete path and must not be reserved/read-only.
- Upsert []*Entity `json:"upsert,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Delete") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Mutation) MarshalJSON() ([]byte, error) {
- type noMethod Mutation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type MutationResult struct {
- // IndexUpdates: Number of index writes.
- IndexUpdates int64 `json:"indexUpdates,omitempty"`
-
- // InsertAutoIdKeys: Keys for insertAutoId entities. One per entity from
- // the request, in the same order.
- InsertAutoIdKeys []*Key `json:"insertAutoIdKeys,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "IndexUpdates") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MutationResult) MarshalJSON() ([]byte, error) {
- type noMethod MutationResult
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PartitionId: An identifier for a particular subset of
-// entities.
-//
-// Entities are partitioned into various subsets, each used by different
-// datasets and different namespaces within a dataset and so forth.
-type PartitionId struct {
- // DatasetId: The dataset ID.
- DatasetId string `json:"datasetId,omitempty"`
-
- // Namespace: The namespace.
- Namespace string `json:"namespace,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DatasetId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PartitionId) MarshalJSON() ([]byte, error) {
- type noMethod PartitionId
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Property: An entity property.
-type Property struct {
- // BlobKeyValue: A blob key value.
- BlobKeyValue *string `json:"blobKeyValue,omitempty"`
-
- // BlobValue: A blob value. May be a maximum of 1,000,000 bytes. When
- // indexed is true, may have at most 500 bytes.
- BlobValue *string `json:"blobValue,omitempty"`
-
- // BooleanValue: A boolean value.
- BooleanValue *bool `json:"booleanValue,omitempty"`
-
- // DateTimeValue: A timestamp value.
- DateTimeValue *string `json:"dateTimeValue,omitempty"`
-
- // DoubleValue: A double value.
- DoubleValue *float64 `json:"doubleValue,omitempty"`
-
- // EntityValue: An entity value. May have no key. May have a key with an
- // incomplete key path. May have a reserved/read-only key.
- EntityValue *Entity `json:"entityValue,omitempty"`
-
- // Indexed: If the value should be indexed.
- //
- // The indexed property may be set for a null value. When indexed is
- // true, stringValue is limited to 500 characters and the blob value is
- // limited to 500 bytes. Input values by default have indexed set to
- // true; however, you can explicitly set indexed to true if you want.
- // (An output value never has indexed explicitly set to true.) If a
- // value is itself an entity, it cannot have indexed set to true.
- Indexed *bool `json:"indexed,omitempty"`
-
- // IntegerValue: An integer value.
- IntegerValue *int64 `json:"integerValue,omitempty,string"`
-
- // KeyValue: A key value.
- KeyValue *Key `json:"keyValue,omitempty"`
-
- // ListValue: A list value. Cannot contain another list value. A Value
- // instance that sets field list_value must not set field meaning or
- // field indexed.
- ListValue []*Value `json:"listValue,omitempty"`
-
- // Meaning: The meaning field is reserved and should not be used.
- Meaning int64 `json:"meaning,omitempty"`
-
- // StringValue: A UTF-8 encoded string value. When indexed is true, may
- // have at most 500 characters.
- StringValue *string `json:"stringValue,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BlobKeyValue") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Property) MarshalJSON() ([]byte, error) {
- type noMethod Property
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PropertyExpression: A representation of a property in a projection.
-type PropertyExpression struct {
- // AggregationFunction: The aggregation function to apply to the
- // property. Optional. Can only be used when grouping by at least one
- // property. Must then be set on all properties in the projection that
- // are not being grouped by. Aggregation functions: first selects the
- // first result as determined by the query's order.
- //
- // Possible values:
- // "FIRST"
- AggregationFunction string `json:"aggregationFunction,omitempty"`
-
- // Property: The property to project.
- Property *PropertyReference `json:"property,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AggregationFunction")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PropertyExpression) MarshalJSON() ([]byte, error) {
- type noMethod PropertyExpression
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PropertyFilter: A filter on a specific property.
-type PropertyFilter struct {
- // Operator: The operator to filter by. One of lessThan,
- // lessThanOrEqual, greaterThan, greaterThanOrEqual, equal, or
- // hasAncestor.
- //
- // Possible values:
- // "EQUAL"
- // "GREATER_THAN"
- // "GREATER_THAN_OR_EQUAL"
- // "HAS_ANCESTOR"
- // "LESS_THAN"
- // "LESS_THAN_OR_EQUAL"
- Operator string `json:"operator,omitempty"`
-
- // Property: The property to filter by.
- Property *PropertyReference `json:"property,omitempty"`
-
- // Value: The value to compare the property to.
- Value *Value `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Operator") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PropertyFilter) MarshalJSON() ([]byte, error) {
- type noMethod PropertyFilter
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PropertyOrder: The desired order for a specific property.
-type PropertyOrder struct {
- // Direction: The direction to order by. One of ascending or descending.
- // Optional, defaults to ascending.
- //
- // Possible values:
- // "ASCENDING"
- // "DESCENDING"
- Direction string `json:"direction,omitempty"`
-
- // Property: The property to order by.
- Property *PropertyReference `json:"property,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Direction") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PropertyOrder) MarshalJSON() ([]byte, error) {
- type noMethod PropertyOrder
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PropertyReference: A reference to a property relative to the kind
-// expressions.
-type PropertyReference struct {
- // Name: The name of the property.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Name") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PropertyReference) MarshalJSON() ([]byte, error) {
- type noMethod PropertyReference
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Query: A query.
-type Query struct {
- // EndCursor: An ending point for the query results. Optional. Query
- // cursors are returned in query result batches.
- EndCursor string `json:"endCursor,omitempty"`
-
- // Filter: The filter to apply (optional).
- Filter *Filter `json:"filter,omitempty"`
-
- // GroupBy: The properties to group by (if empty, no grouping is applied
- // to the result set).
- GroupBy []*PropertyReference `json:"groupBy,omitempty"`
-
- // Kinds: The kinds to query (if empty, returns entities from all
- // kinds).
- Kinds []*KindExpression `json:"kinds,omitempty"`
-
- // Limit: The maximum number of results to return. Applies after all
- // other constraints. Optional.
- Limit int64 `json:"limit,omitempty"`
-
- // Offset: The number of results to skip. Applies before limit, but
- // after all other constraints (optional, defaults to 0).
- Offset int64 `json:"offset,omitempty"`
-
- // Order: The order to apply to the query results (if empty, order is
- // unspecified).
- Order []*PropertyOrder `json:"order,omitempty"`
-
- // Projection: The projection to return. If not set the entire entity is
- // returned.
- Projection []*PropertyExpression `json:"projection,omitempty"`
-
- // StartCursor: A starting point for the query results. Optional. Query
- // cursors are returned in query result batches.
- StartCursor string `json:"startCursor,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "EndCursor") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Query) MarshalJSON() ([]byte, error) {
- type noMethod Query
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// QueryResultBatch: A batch of results produced by a query.
-type QueryResultBatch struct {
- // EndCursor: A cursor that points to the position after the last result
- // in the batch. May be absent. TODO(arfuller): Once all plans produce
- // cursors update documentation here.
- EndCursor string `json:"endCursor,omitempty"`
-
- // EntityResultType: The result type for every entity in entityResults.
- // full for full entities, projection for entities with only projected
- // properties, keyOnly for entities with only a key.
- //
- // Possible values:
- // "FULL"
- // "KEY_ONLY"
- // "PROJECTION"
- EntityResultType string `json:"entityResultType,omitempty"`
-
- // EntityResults: The results for this batch.
- EntityResults []*EntityResult `json:"entityResults,omitempty"`
-
- // MoreResults: The state of the query after the current batch. One of
- // notFinished, moreResultsAfterLimit, noMoreResults.
- //
- // Possible values:
- // "MORE_RESULTS_AFTER_LIMIT"
- // "NOT_FINISHED"
- // "NO_MORE_RESULTS"
- MoreResults string `json:"moreResults,omitempty"`
-
- // SkippedResults: The number of results skipped because of
- // Query.offset.
- SkippedResults int64 `json:"skippedResults,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "EndCursor") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *QueryResultBatch) MarshalJSON() ([]byte, error) {
- type noMethod QueryResultBatch
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ReadOptions struct {
- // ReadConsistency: The read consistency to use. One of default, strong,
- // or eventual. Cannot be set when transaction is set. Lookup and
- // ancestor queries default to strong, global queries default to
- // eventual and cannot be set to strong. Optional. Default is default.
- //
- // Possible values:
- // "DEFAULT"
- // "EVENTUAL"
- // "STRONG"
- ReadConsistency string `json:"readConsistency,omitempty"`
-
- // Transaction: The transaction to use. Optional.
- Transaction string `json:"transaction,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ReadConsistency") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReadOptions) MarshalJSON() ([]byte, error) {
- type noMethod ReadOptions
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ResponseHeader struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "datastore#responseHeader".
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ResponseHeader) MarshalJSON() ([]byte, error) {
- type noMethod ResponseHeader
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type RollbackRequest struct {
- // Transaction: The transaction identifier, returned by a call to
- // beginTransaction.
- Transaction string `json:"transaction,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Transaction") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RollbackRequest) MarshalJSON() ([]byte, error) {
- type noMethod RollbackRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type RollbackResponse struct {
- Header *ResponseHeader `json:"header,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Header") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RollbackResponse) MarshalJSON() ([]byte, error) {
- type noMethod RollbackResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type RunQueryRequest struct {
- // GqlQuery: The GQL query to run. Either this field or field query must
- // be set, but not both.
- GqlQuery *GqlQuery `json:"gqlQuery,omitempty"`
-
- // PartitionId: Entities are partitioned into subsets, identified by a
- // dataset (usually implicitly specified by the project) and namespace
- // ID. Queries are scoped to a single partition. This partition ID is
- // normalized with the standard default context partition ID, but all
- // other partition IDs in RunQueryRequest are normalized with this
- // partition ID as the context partition ID.
- PartitionId *PartitionId `json:"partitionId,omitempty"`
-
- // Query: The query to run. Either this field or field gql_query must be
- // set, but not both.
- Query *Query `json:"query,omitempty"`
-
- // ReadOptions: The options for this query.
- ReadOptions *ReadOptions `json:"readOptions,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "GqlQuery") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RunQueryRequest) MarshalJSON() ([]byte, error) {
- type noMethod RunQueryRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type RunQueryResponse struct {
- // Batch: A batch of query results (always present).
- Batch *QueryResultBatch `json:"batch,omitempty"`
-
- Header *ResponseHeader `json:"header,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Batch") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RunQueryResponse) MarshalJSON() ([]byte, error) {
- type noMethod RunQueryResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Value: A message that can hold any of the supported value types and
-// associated metadata.
-type Value struct {
- // BlobKeyValue: A blob key value.
- BlobKeyValue string `json:"blobKeyValue,omitempty"`
-
- // BlobValue: A blob value. May be a maximum of 1,000,000 bytes. When
- // indexed is true, may have at most 500 bytes.
- BlobValue string `json:"blobValue,omitempty"`
-
- // BooleanValue: A boolean value.
- BooleanValue bool `json:"booleanValue,omitempty"`
-
- // DateTimeValue: A timestamp value.
- DateTimeValue string `json:"dateTimeValue,omitempty"`
-
- // DoubleValue: A double value.
- DoubleValue float64 `json:"doubleValue,omitempty"`
-
- // EntityValue: An entity value. May have no key. May have a key with an
- // incomplete key path. May have a reserved/read-only key.
- EntityValue *Entity `json:"entityValue,omitempty"`
-
- // Indexed: If the value should be indexed.
- //
- // The indexed property may be set for a null value. When indexed is
- // true, stringValue is limited to 500 characters and the blob value is
- // limited to 500 bytes. Input values by default have indexed set to
- // true; however, you can explicitly set indexed to true if you want.
- // (An output value never has indexed explicitly set to true.) If a
- // value is itself an entity, it cannot have indexed set to true.
- Indexed bool `json:"indexed,omitempty"`
-
- // IntegerValue: An integer value.
- IntegerValue int64 `json:"integerValue,omitempty,string"`
-
- // KeyValue: A key value.
- KeyValue *Key `json:"keyValue,omitempty"`
-
- // ListValue: A list value. Cannot contain another list value. A Value
- // instance that sets field list_value must not set field meaning or
- // field indexed.
- ListValue []*Value `json:"listValue,omitempty"`
-
- // Meaning: The meaning field is reserved and should not be used.
- Meaning int64 `json:"meaning,omitempty"`
-
- // StringValue: A UTF-8 encoded string value. When indexed is true, may
- // have at most 500 characters.
- StringValue string `json:"stringValue,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BlobKeyValue") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Value) MarshalJSON() ([]byte, error) {
- type noMethod Value
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "datastore.datasets.allocateIds":
-
-type DatasetsAllocateIdsCall struct {
- s *Service
- datasetId string
- allocateidsrequest *AllocateIdsRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// AllocateIds: Allocate IDs for incomplete keys (useful for referencing
-// an entity before it is inserted).
-func (r *DatasetsService) AllocateIds(datasetId string, allocateidsrequest *AllocateIdsRequest) *DatasetsAllocateIdsCall {
- c := &DatasetsAllocateIdsCall{s: r.s, opt_: make(map[string]interface{})}
- c.datasetId = datasetId
- c.allocateidsrequest = allocateidsrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatasetsAllocateIdsCall) Fields(s ...googleapi.Field) *DatasetsAllocateIdsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatasetsAllocateIdsCall) Context(ctx context.Context) *DatasetsAllocateIdsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatasetsAllocateIdsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.allocateidsrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{datasetId}/allocateIds")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "datasetId": c.datasetId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "datastore.datasets.allocateIds" call.
-// Exactly one of *AllocateIdsResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AllocateIdsResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DatasetsAllocateIdsCall) Do() (*AllocateIdsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AllocateIdsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Allocate IDs for incomplete keys (useful for referencing an entity before it is inserted).",
- // "httpMethod": "POST",
- // "id": "datastore.datasets.allocateIds",
- // "parameterOrder": [
- // "datasetId"
- // ],
- // "parameters": {
- // "datasetId": {
- // "description": "Identifies the dataset.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{datasetId}/allocateIds",
- // "request": {
- // "$ref": "AllocateIdsRequest"
- // },
- // "response": {
- // "$ref": "AllocateIdsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/datastore",
- // "https://www.googleapis.com/auth/userinfo.email"
- // ]
- // }
-
-}
-
-// method id "datastore.datasets.beginTransaction":
-
-type DatasetsBeginTransactionCall struct {
- s *Service
- datasetId string
- begintransactionrequest *BeginTransactionRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// BeginTransaction: Begin a new transaction.
-func (r *DatasetsService) BeginTransaction(datasetId string, begintransactionrequest *BeginTransactionRequest) *DatasetsBeginTransactionCall {
- c := &DatasetsBeginTransactionCall{s: r.s, opt_: make(map[string]interface{})}
- c.datasetId = datasetId
- c.begintransactionrequest = begintransactionrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatasetsBeginTransactionCall) Fields(s ...googleapi.Field) *DatasetsBeginTransactionCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatasetsBeginTransactionCall) Context(ctx context.Context) *DatasetsBeginTransactionCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatasetsBeginTransactionCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.begintransactionrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{datasetId}/beginTransaction")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "datasetId": c.datasetId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "datastore.datasets.beginTransaction" call.
-// Exactly one of *BeginTransactionResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *BeginTransactionResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DatasetsBeginTransactionCall) Do() (*BeginTransactionResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &BeginTransactionResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Begin a new transaction.",
- // "httpMethod": "POST",
- // "id": "datastore.datasets.beginTransaction",
- // "parameterOrder": [
- // "datasetId"
- // ],
- // "parameters": {
- // "datasetId": {
- // "description": "Identifies the dataset.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{datasetId}/beginTransaction",
- // "request": {
- // "$ref": "BeginTransactionRequest"
- // },
- // "response": {
- // "$ref": "BeginTransactionResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/datastore",
- // "https://www.googleapis.com/auth/userinfo.email"
- // ]
- // }
-
-}
-
-// method id "datastore.datasets.commit":
-
-type DatasetsCommitCall struct {
- s *Service
- datasetId string
- commitrequest *CommitRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Commit: Commit a transaction, optionally creating, deleting or
-// modifying some entities.
-func (r *DatasetsService) Commit(datasetId string, commitrequest *CommitRequest) *DatasetsCommitCall {
- c := &DatasetsCommitCall{s: r.s, opt_: make(map[string]interface{})}
- c.datasetId = datasetId
- c.commitrequest = commitrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatasetsCommitCall) Fields(s ...googleapi.Field) *DatasetsCommitCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatasetsCommitCall) Context(ctx context.Context) *DatasetsCommitCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatasetsCommitCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.commitrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{datasetId}/commit")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "datasetId": c.datasetId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "datastore.datasets.commit" call.
-// Exactly one of *CommitResponse or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CommitResponse.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DatasetsCommitCall) Do() (*CommitResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CommitResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Commit a transaction, optionally creating, deleting or modifying some entities.",
- // "httpMethod": "POST",
- // "id": "datastore.datasets.commit",
- // "parameterOrder": [
- // "datasetId"
- // ],
- // "parameters": {
- // "datasetId": {
- // "description": "Identifies the dataset.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{datasetId}/commit",
- // "request": {
- // "$ref": "CommitRequest"
- // },
- // "response": {
- // "$ref": "CommitResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/datastore",
- // "https://www.googleapis.com/auth/userinfo.email"
- // ]
- // }
-
-}
-
-// method id "datastore.datasets.lookup":
-
-type DatasetsLookupCall struct {
- s *Service
- datasetId string
- lookuprequest *LookupRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Lookup: Look up some entities by key.
-func (r *DatasetsService) Lookup(datasetId string, lookuprequest *LookupRequest) *DatasetsLookupCall {
- c := &DatasetsLookupCall{s: r.s, opt_: make(map[string]interface{})}
- c.datasetId = datasetId
- c.lookuprequest = lookuprequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatasetsLookupCall) Fields(s ...googleapi.Field) *DatasetsLookupCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatasetsLookupCall) Context(ctx context.Context) *DatasetsLookupCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatasetsLookupCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.lookuprequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{datasetId}/lookup")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "datasetId": c.datasetId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "datastore.datasets.lookup" call.
-// Exactly one of *LookupResponse or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *LookupResponse.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DatasetsLookupCall) Do() (*LookupResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &LookupResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Look up some entities by key.",
- // "httpMethod": "POST",
- // "id": "datastore.datasets.lookup",
- // "parameterOrder": [
- // "datasetId"
- // ],
- // "parameters": {
- // "datasetId": {
- // "description": "Identifies the dataset.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{datasetId}/lookup",
- // "request": {
- // "$ref": "LookupRequest"
- // },
- // "response": {
- // "$ref": "LookupResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/datastore",
- // "https://www.googleapis.com/auth/userinfo.email"
- // ]
- // }
-
-}
-
-// method id "datastore.datasets.rollback":
-
-type DatasetsRollbackCall struct {
- s *Service
- datasetId string
- rollbackrequest *RollbackRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Rollback: Roll back a transaction.
-func (r *DatasetsService) Rollback(datasetId string, rollbackrequest *RollbackRequest) *DatasetsRollbackCall {
- c := &DatasetsRollbackCall{s: r.s, opt_: make(map[string]interface{})}
- c.datasetId = datasetId
- c.rollbackrequest = rollbackrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatasetsRollbackCall) Fields(s ...googleapi.Field) *DatasetsRollbackCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatasetsRollbackCall) Context(ctx context.Context) *DatasetsRollbackCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatasetsRollbackCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.rollbackrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{datasetId}/rollback")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "datasetId": c.datasetId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "datastore.datasets.rollback" call.
-// Exactly one of *RollbackResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *RollbackResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DatasetsRollbackCall) Do() (*RollbackResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &RollbackResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Roll back a transaction.",
- // "httpMethod": "POST",
- // "id": "datastore.datasets.rollback",
- // "parameterOrder": [
- // "datasetId"
- // ],
- // "parameters": {
- // "datasetId": {
- // "description": "Identifies the dataset.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{datasetId}/rollback",
- // "request": {
- // "$ref": "RollbackRequest"
- // },
- // "response": {
- // "$ref": "RollbackResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/datastore",
- // "https://www.googleapis.com/auth/userinfo.email"
- // ]
- // }
-
-}
-
-// method id "datastore.datasets.runQuery":
-
-type DatasetsRunQueryCall struct {
- s *Service
- datasetId string
- runqueryrequest *RunQueryRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// RunQuery: Query for entities.
-func (r *DatasetsService) RunQuery(datasetId string, runqueryrequest *RunQueryRequest) *DatasetsRunQueryCall {
- c := &DatasetsRunQueryCall{s: r.s, opt_: make(map[string]interface{})}
- c.datasetId = datasetId
- c.runqueryrequest = runqueryrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DatasetsRunQueryCall) Fields(s ...googleapi.Field) *DatasetsRunQueryCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DatasetsRunQueryCall) Context(ctx context.Context) *DatasetsRunQueryCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DatasetsRunQueryCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.runqueryrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{datasetId}/runQuery")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "datasetId": c.datasetId,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "datastore.datasets.runQuery" call.
-// Exactly one of *RunQueryResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *RunQueryResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DatasetsRunQueryCall) Do() (*RunQueryResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &RunQueryResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Query for entities.",
- // "httpMethod": "POST",
- // "id": "datastore.datasets.runQuery",
- // "parameterOrder": [
- // "datasetId"
- // ],
- // "parameters": {
- // "datasetId": {
- // "description": "Identifies the dataset.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{datasetId}/runQuery",
- // "request": {
- // "$ref": "RunQueryRequest"
- // },
- // "response": {
- // "$ref": "RunQueryResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/datastore",
- // "https://www.googleapis.com/auth/userinfo.email"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/deploymentmanager/v2/deploymentmanager-api.json b/vendor/google.golang.org/api/deploymentmanager/v2/deploymentmanager-api.json
deleted file mode 100644
index 22f7433c..00000000
--- a/vendor/google.golang.org/api/deploymentmanager/v2/deploymentmanager-api.json
+++ /dev/null
@@ -1,1394 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/3wCGcnGwi3iQywGP6Ncdo6mexyQ\"",
- "discoveryVersion": "v1",
- "id": "deploymentmanager:v2",
- "name": "deploymentmanager",
- "canonicalName": "Deployment Manager",
- "version": "v2",
- "revision": "20150831",
- "title": "Google Cloud Deployment Manager API",
- "description": "The Deployment Manager API allows users to declaratively configure, deploy and run complex solutions on the Google Cloud Platform.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/deployment-manager/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/deploymentmanager/v2/projects/",
- "basePath": "/deploymentmanager/v2/projects/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "deploymentmanager/v2/projects/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/ndev.cloudman": {
- "description": "View and manage your Google Cloud Platform management resources and deployment status information"
- },
- "https://www.googleapis.com/auth/ndev.cloudman.readonly": {
- "description": "View your Google Cloud Platform management resources and deployment status information"
- }
- }
- }
- },
- "schemas": {
- "ConfigFile": {
- "id": "ConfigFile",
- "type": "object",
- "description": "",
- "properties": {
- "content": {
- "type": "string",
- "description": "The contents of the file."
- }
- }
- },
- "Deployment": {
- "id": "Deployment",
- "type": "object",
- "description": "",
- "properties": {
- "description": {
- "type": "string",
- "description": "An optional user-provided description of the deployment."
- },
- "fingerprint": {
- "type": "string",
- "description": "Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.\n\nThe fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.",
- "format": "byte"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "insertTime": {
- "type": "string",
- "description": "[Output Only] Timestamp when the deployment was created, in RFC3339 text format ."
- },
- "manifest": {
- "type": "string",
- "description": "[Output Only] URL of the manifest representing the last manifest that was successfully deployed."
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash."
- },
- "operation": {
- "$ref": "Operation",
- "description": "[Output Only] The Operation that most recently ran, or is currently running, on this deployment."
- },
- "target": {
- "$ref": "TargetConfiguration",
- "description": "[Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates."
- },
- "update": {
- "$ref": "DeploymentUpdate",
- "description": "[Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here."
- }
- }
- },
- "DeploymentUpdate": {
- "id": "DeploymentUpdate",
- "type": "object",
- "description": "",
- "properties": {
- "manifest": {
- "type": "string",
- "description": "[Output Only] URL of the manifest representing the update configuration of this deployment."
- }
- }
- },
- "DeploymentsCancelPreviewRequest": {
- "id": "DeploymentsCancelPreviewRequest",
- "type": "object",
- "description": "",
- "properties": {
- "fingerprint": {
- "type": "string",
- "description": "Specifies a fingerprint for cancelPreview() requests. A fingerprint is a randomly generated value that must be provided in cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to cancel a preview, this would prevent one of the requests).\n\nThe fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request to a deployment.",
- "format": "byte"
- }
- }
- },
- "DeploymentsListResponse": {
- "id": "DeploymentsListResponse",
- "type": "object",
- "description": "A response containing a partial list of deployments and a page token used to build the next request if the request has been truncated.",
- "properties": {
- "deployments": {
- "type": "array",
- "description": "[Output Only] The deployments contained in this response.",
- "items": {
- "$ref": "Deployment"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- }
- }
- },
- "DeploymentsStopRequest": {
- "id": "DeploymentsStopRequest",
- "type": "object",
- "description": "",
- "properties": {
- "fingerprint": {
- "type": "string",
- "description": "Specifies a fingerprint for stop() requests. A fingerprint is a randomly generated value that must be provided in stop() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to stop an ongoing update request, this would prevent a collision).\n\nThe fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request to a deployment.",
- "format": "byte"
- }
- }
- },
- "ImportFile": {
- "id": "ImportFile",
- "type": "object",
- "description": "",
- "properties": {
- "content": {
- "type": "string",
- "description": "The contents of the file."
- },
- "name": {
- "type": "string",
- "description": "The name of the file."
- }
- }
- },
- "Manifest": {
- "id": "Manifest",
- "type": "object",
- "description": "",
- "properties": {
- "config": {
- "$ref": "ConfigFile",
- "description": "[Output Only] The YAML configuration for this manifest."
- },
- "expandedConfig": {
- "type": "string",
- "description": "[Output Only] The fully-expanded configuration file, including any templates and references."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "imports": {
- "type": "array",
- "description": "[Output Only] The imported files for this manifest.",
- "items": {
- "$ref": "ImportFile"
- }
- },
- "insertTime": {
- "type": "string",
- "description": "[Output Only] Timestamp when the manifest was created, in RFC3339 text format."
- },
- "layout": {
- "type": "string",
- "description": "[Output Only] The YAML layout for this manifest."
- },
- "name": {
- "type": "string",
- "description": "[Output Only] The name of the manifest."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Self link for the manifest."
- }
- }
- },
- "ManifestsListResponse": {
- "id": "ManifestsListResponse",
- "type": "object",
- "description": "A response containing a partial list of manifests and a page token used to build the next request if the request has been truncated.",
- "properties": {
- "manifests": {
- "type": "array",
- "description": "[Output Only] Manifests contained in this list response.",
- "items": {
- "$ref": "Manifest"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- }
- }
- },
- "Operation": {
- "id": "Operation",
- "type": "object",
- "description": "An Operation resource, used to manage asynchronous API requests.",
- "properties": {
- "clientOperationId": {
- "type": "string",
- "description": "[Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "endTime": {
- "type": "string",
- "description": "[Output Only] The time that this operation was completed. This is in RFC3339 text format."
- },
- "error": {
- "type": "object",
- "description": "[Output Only] If errors are generated during processing of the operation, this field will be populated.",
- "properties": {
- "errors": {
- "type": "array",
- "description": "[Output Only] The array of errors encountered while processing this operation.",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The error type identifier for this error."
- },
- "location": {
- "type": "string",
- "description": "[Output Only] Indicates the field in the request which caused the error. This property is optional."
- },
- "message": {
- "type": "string",
- "description": "[Output Only] An optional, human-readable error message."
- }
- }
- }
- }
- }
- },
- "httpErrorMessage": {
- "type": "string",
- "description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND."
- },
- "httpErrorStatusCode": {
- "type": "integer",
- "description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.",
- "format": "int32"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "insertTime": {
- "type": "string",
- "description": "[Output Only] The time that this operation was requested. This is in RFC3339 text format."
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#Operation for Operation resources.",
- "default": "deploymentmanager#operation"
- },
- "name": {
- "type": "string",
- "description": "[Output Only] Name of the resource."
- },
- "operationType": {
- "type": "string",
- "description": "[Output Only] Type of the operation, such as insert, update, and delete."
- },
- "progress": {
- "type": "integer",
- "description": "[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.",
- "format": "int32"
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the operation resides. Only applicable for regional resources."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "startTime": {
- "type": "string",
- "description": "[Output Only] The time that this operation was started by the server. This is in RFC3339 text format."
- },
- "status": {
- "type": "string",
- "description": "[Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE."
- },
- "statusMessage": {
- "type": "string",
- "description": "[Output Only] An optional textual description of the current status of the operation."
- },
- "targetId": {
- "type": "string",
- "description": "[Output Only] Unique target ID which identifies a particular incarnation of the target.",
- "format": "uint64"
- },
- "targetLink": {
- "type": "string",
- "description": "[Output Only] URL of the resource the operation is mutating."
- },
- "user": {
- "type": "string",
- "description": "[Output Only] User who requested the operation, for example: user@example.com."
- },
- "warnings": {
- "type": "array",
- "description": "[Output Only] If warning messages are generated during processing of the operation, this field will be populated.",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning."
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- },
- "zone": {
- "type": "string",
- "description": "[Output Only] URL of the zone where the operation resides."
- }
- }
- },
- "OperationsListResponse": {
- "id": "OperationsListResponse",
- "type": "object",
- "description": "A response containing a partial list of operations and a page token used to build the next request if the request has been truncated.",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "operations": {
- "type": "array",
- "description": "[Output Only] Operations contained in this list response.",
- "items": {
- "$ref": "Operation"
- }
- }
- }
- },
- "Resource": {
- "id": "Resource",
- "type": "object",
- "description": "",
- "properties": {
- "finalProperties": {
- "type": "string",
- "description": "[Output Only] The evaluated properties of the resource with references expanded. Returned as serialized YAML."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "insertTime": {
- "type": "string",
- "description": "[Output Only] Timestamp when the resource was created or acquired, in RFC3339 text format ."
- },
- "manifest": {
- "type": "string",
- "description": "[Output Only] URL of the manifest representing the current configuration of this resource."
- },
- "name": {
- "type": "string",
- "description": "[Output Only] The name of the resource as it appears in the YAML config."
- },
- "properties": {
- "type": "string",
- "description": "[Output Only] The current properties of the resource before any references have been filled in. Returned as serialized YAML."
- },
- "type": {
- "type": "string",
- "description": "[Output Only] The type of the resource, for example compute.v1.instance, or replicaPools.v1beta2.instanceGroupManager."
- },
- "update": {
- "$ref": "ResourceUpdate",
- "description": "[Output Only] If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here."
- },
- "updateTime": {
- "type": "string",
- "description": "[Output Only] Timestamp when the resource was updated, in RFC3339 text format ."
- },
- "url": {
- "type": "string",
- "description": "[Output Only] The URL of the actual resource."
- },
- "warnings": {
- "type": "array",
- "description": "[Output Only] If warning messages are generated during processing of this resource, this field will be populated.",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning."
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- }
- },
- "ResourceUpdate": {
- "id": "ResourceUpdate",
- "type": "object",
- "description": "",
- "properties": {
- "error": {
- "type": "object",
- "description": "[Output Only] If errors are generated during update of the resource, this field will be populated.",
- "properties": {
- "errors": {
- "type": "array",
- "description": "[Output Only] The array of errors encountered while processing this operation.",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The error type identifier for this error."
- },
- "location": {
- "type": "string",
- "description": "[Output Only] Indicates the field in the request which caused the error. This property is optional."
- },
- "message": {
- "type": "string",
- "description": "[Output Only] An optional, human-readable error message."
- }
- }
- }
- }
- }
- },
- "finalProperties": {
- "type": "string",
- "description": "[Output Only] The expanded properties of the resource with reference values expanded. Returned as serialized YAML."
- },
- "intent": {
- "type": "string",
- "description": "[Output Only] The intent of the resource: PREVIEW, UPDATE, or CANCEL."
- },
- "manifest": {
- "type": "string",
- "description": "[Output Only] URL of the manifest representing the update configuration of this resource."
- },
- "properties": {
- "type": "string",
- "description": "[Output Only] The set of updated properties for this resource, before references are expanded. Returned as serialized YAML."
- },
- "state": {
- "type": "string",
- "description": "[Output Only] The state of the resource."
- },
- "warnings": {
- "type": "array",
- "description": "[Output Only] If warning messages are generated during processing of this resource, this field will be populated.",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning."
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- }
- }
- },
- "ResourcesListResponse": {
- "id": "ResourcesListResponse",
- "type": "object",
- "description": "A response containing a partial list of resources and a page token used to build the next request if the request has been truncated.",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "A token used to continue a truncated list request."
- },
- "resources": {
- "type": "array",
- "description": "Resources contained in this list response.",
- "items": {
- "$ref": "Resource"
- }
- }
- }
- },
- "TargetConfiguration": {
- "id": "TargetConfiguration",
- "type": "object",
- "description": "",
- "properties": {
- "config": {
- "$ref": "ConfigFile",
- "description": "The configuration to use for this deployment."
- },
- "imports": {
- "type": "array",
- "description": "Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.",
- "items": {
- "$ref": "ImportFile"
- }
- }
- }
- },
- "Type": {
- "id": "Type",
- "type": "object",
- "description": "A resource type supported by Deployment Manager.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "insertTime": {
- "type": "string",
- "description": "[Output Only] Timestamp when the type was created, in RFC3339 text format."
- },
- "name": {
- "type": "string",
- "description": "Name of the type."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Self link for the type."
- }
- }
- },
- "TypesListResponse": {
- "id": "TypesListResponse",
- "type": "object",
- "description": "A response that returns all Types supported by Deployment Manager",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "A token used to continue a truncated list request."
- },
- "types": {
- "type": "array",
- "description": "[Output Only] A list of resource types supported by Deployment Manager.",
- "items": {
- "$ref": "Type"
- }
- }
- }
- }
- },
- "resources": {
- "deployments": {
- "methods": {
- "cancelPreview": {
- "id": "deploymentmanager.deployments.cancelPreview",
- "path": "{project}/global/deployments/{deployment}/cancelPreview",
- "httpMethod": "POST",
- "description": "Cancels and removes the preview currently associated with the deployment.",
- "parameters": {
- "deployment": {
- "type": "string",
- "description": "The name of the deployment for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "deployment"
- ],
- "request": {
- "$ref": "DeploymentsCancelPreviewRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/ndev.cloudman"
- ]
- },
- "delete": {
- "id": "deploymentmanager.deployments.delete",
- "path": "{project}/global/deployments/{deployment}",
- "httpMethod": "DELETE",
- "description": "Deletes a deployment and all of the resources in the deployment.",
- "parameters": {
- "deployment": {
- "type": "string",
- "description": "The name of the deployment for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "deployment"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/ndev.cloudman"
- ]
- },
- "get": {
- "id": "deploymentmanager.deployments.get",
- "path": "{project}/global/deployments/{deployment}",
- "httpMethod": "GET",
- "description": "Gets information about a specific deployment.",
- "parameters": {
- "deployment": {
- "type": "string",
- "description": "The name of the deployment for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "deployment"
- ],
- "response": {
- "$ref": "Deployment"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/ndev.cloudman",
- "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- ]
- },
- "insert": {
- "id": "deploymentmanager.deployments.insert",
- "path": "{project}/global/deployments",
- "httpMethod": "POST",
- "description": "Creates a deployment and all of the resources described by the deployment manifest.",
- "parameters": {
- "preview": {
- "type": "boolean",
- "description": "If set to true, creates a deployment and creates \"shell\" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. After previewing a deployment, you can deploy your resources by making a request with the update() method or you can use the cancelPreview() method to cancel the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "Deployment"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/ndev.cloudman"
- ]
- },
- "list": {
- "id": "deploymentmanager.deployments.list",
- "path": "{project}/global/deployments",
- "httpMethod": "GET",
- "description": "Lists all deployments for a given project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "DeploymentsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/ndev.cloudman",
- "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- ]
- },
- "patch": {
- "id": "deploymentmanager.deployments.patch",
- "path": "{project}/global/deployments/{deployment}",
- "httpMethod": "PATCH",
- "description": "Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics.",
- "parameters": {
- "createPolicy": {
- "type": "string",
- "description": "Sets the policy to use for creating new resources.",
- "default": "CREATE_OR_ACQUIRE",
- "enum": [
- "ACQUIRE",
- "CREATE_OR_ACQUIRE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "deletePolicy": {
- "type": "string",
- "description": "Sets the policy to use for deleting resources.",
- "default": "DELETE",
- "enum": [
- "ABANDON",
- "DELETE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "deployment": {
- "type": "string",
- "description": "The name of the deployment for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "preview": {
- "type": "boolean",
- "description": "If set to true, updates the deployment and creates and updates the \"shell\" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment looks like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.",
- "default": "false",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "deployment"
- ],
- "request": {
- "$ref": "Deployment"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/ndev.cloudman"
- ]
- },
- "stop": {
- "id": "deploymentmanager.deployments.stop",
- "path": "{project}/global/deployments/{deployment}/stop",
- "httpMethod": "POST",
- "description": "Stops an ongoing operation. This does not roll back any work that has already been completed, but prevents any new work from being started.",
- "parameters": {
- "deployment": {
- "type": "string",
- "description": "The name of the deployment for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "deployment"
- ],
- "request": {
- "$ref": "DeploymentsStopRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/ndev.cloudman"
- ]
- },
- "update": {
- "id": "deploymentmanager.deployments.update",
- "path": "{project}/global/deployments/{deployment}",
- "httpMethod": "PUT",
- "description": "Updates a deployment and all of the resources described by the deployment manifest.",
- "parameters": {
- "createPolicy": {
- "type": "string",
- "description": "Sets the policy to use for creating new resources.",
- "default": "CREATE_OR_ACQUIRE",
- "enum": [
- "ACQUIRE",
- "CREATE_OR_ACQUIRE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "deletePolicy": {
- "type": "string",
- "description": "Sets the policy to use for deleting resources.",
- "default": "DELETE",
- "enum": [
- "ABANDON",
- "DELETE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "deployment": {
- "type": "string",
- "description": "The name of the deployment for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "preview": {
- "type": "boolean",
- "description": "If set to true, updates the deployment and creates and updates the \"shell\" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment looks like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.",
- "default": "false",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "deployment"
- ],
- "request": {
- "$ref": "Deployment"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/ndev.cloudman"
- ]
- }
- }
- },
- "manifests": {
- "methods": {
- "get": {
- "id": "deploymentmanager.manifests.get",
- "path": "{project}/global/deployments/{deployment}/manifests/{manifest}",
- "httpMethod": "GET",
- "description": "Gets information about a specific manifest.",
- "parameters": {
- "deployment": {
- "type": "string",
- "description": "The name of the deployment for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "manifest": {
- "type": "string",
- "description": "The name of the manifest for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "deployment",
- "manifest"
- ],
- "response": {
- "$ref": "Manifest"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/ndev.cloudman",
- "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- ]
- },
- "list": {
- "id": "deploymentmanager.manifests.list",
- "path": "{project}/global/deployments/{deployment}/manifests",
- "httpMethod": "GET",
- "description": "Lists all manifests for a given deployment.",
- "parameters": {
- "deployment": {
- "type": "string",
- "description": "The name of the deployment for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "deployment"
- ],
- "response": {
- "$ref": "ManifestsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/ndev.cloudman",
- "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- ]
- }
- }
- },
- "operations": {
- "methods": {
- "get": {
- "id": "deploymentmanager.operations.get",
- "path": "{project}/global/operations/{operation}",
- "httpMethod": "GET",
- "description": "Gets information about a specific operation.",
- "parameters": {
- "operation": {
- "type": "string",
- "description": "The name of the operation for this request.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "operation"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/ndev.cloudman",
- "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- ]
- },
- "list": {
- "id": "deploymentmanager.operations.list",
- "path": "{project}/global/operations",
- "httpMethod": "GET",
- "description": "Lists all operations for a project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "OperationsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/ndev.cloudman",
- "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- ]
- }
- }
- },
- "resources": {
- "methods": {
- "get": {
- "id": "deploymentmanager.resources.get",
- "path": "{project}/global/deployments/{deployment}/resources/{resource}",
- "httpMethod": "GET",
- "description": "Gets information about a single resource.",
- "parameters": {
- "deployment": {
- "type": "string",
- "description": "The name of the deployment for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "resource": {
- "type": "string",
- "description": "The name of the resource for this request.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "deployment",
- "resource"
- ],
- "response": {
- "$ref": "Resource"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/ndev.cloudman",
- "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- ]
- },
- "list": {
- "id": "deploymentmanager.resources.list",
- "path": "{project}/global/deployments/{deployment}/resources",
- "httpMethod": "GET",
- "description": "Lists all resources in a given deployment.",
- "parameters": {
- "deployment": {
- "type": "string",
- "description": "The name of the deployment for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "deployment"
- ],
- "response": {
- "$ref": "ResourcesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/ndev.cloudman",
- "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- ]
- }
- }
- },
- "types": {
- "methods": {
- "list": {
- "id": "deploymentmanager.types.list",
- "path": "{project}/global/types",
- "httpMethod": "GET",
- "description": "Lists all resource types for Deployment Manager.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "TypesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/ndev.cloudman",
- "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/deploymentmanager/v2/deploymentmanager-gen.go b/vendor/google.golang.org/api/deploymentmanager/v2/deploymentmanager-gen.go
deleted file mode 100644
index 5e905586..00000000
--- a/vendor/google.golang.org/api/deploymentmanager/v2/deploymentmanager-gen.go
+++ /dev/null
@@ -1,3610 +0,0 @@
-// Package deploymentmanager provides access to the Google Cloud Deployment Manager API.
-//
-// See https://cloud.google.com/deployment-manager/
-//
-// Usage example:
-//
-// import "google.golang.org/api/deploymentmanager/v2"
-// ...
-// deploymentmanagerService, err := deploymentmanager.New(oauthHttpClient)
-package deploymentmanager // import "google.golang.org/api/deploymentmanager/v2"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "deploymentmanager:v2"
-const apiName = "deploymentmanager"
-const apiVersion = "v2"
-const basePath = "https://www.googleapis.com/deploymentmanager/v2/projects/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your data across Google Cloud Platform services
- CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
-
- // View your data across Google Cloud Platform services
- CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"
-
- // View and manage your Google Cloud Platform management resources and
- // deployment status information
- NdevCloudmanScope = "https://www.googleapis.com/auth/ndev.cloudman"
-
- // View your Google Cloud Platform management resources and deployment
- // status information
- NdevCloudmanReadonlyScope = "https://www.googleapis.com/auth/ndev.cloudman.readonly"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Deployments = NewDeploymentsService(s)
- s.Manifests = NewManifestsService(s)
- s.Operations = NewOperationsService(s)
- s.Resources = NewResourcesService(s)
- s.Types = NewTypesService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Deployments *DeploymentsService
-
- Manifests *ManifestsService
-
- Operations *OperationsService
-
- Resources *ResourcesService
-
- Types *TypesService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewDeploymentsService(s *Service) *DeploymentsService {
- rs := &DeploymentsService{s: s}
- return rs
-}
-
-type DeploymentsService struct {
- s *Service
-}
-
-func NewManifestsService(s *Service) *ManifestsService {
- rs := &ManifestsService{s: s}
- return rs
-}
-
-type ManifestsService struct {
- s *Service
-}
-
-func NewOperationsService(s *Service) *OperationsService {
- rs := &OperationsService{s: s}
- return rs
-}
-
-type OperationsService struct {
- s *Service
-}
-
-func NewResourcesService(s *Service) *ResourcesService {
- rs := &ResourcesService{s: s}
- return rs
-}
-
-type ResourcesService struct {
- s *Service
-}
-
-func NewTypesService(s *Service) *TypesService {
- rs := &TypesService{s: s}
- return rs
-}
-
-type TypesService struct {
- s *Service
-}
-
-type ConfigFile struct {
- // Content: The contents of the file.
- Content string `json:"content,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Content") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ConfigFile) MarshalJSON() ([]byte, error) {
- type noMethod ConfigFile
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Deployment struct {
- // Description: An optional user-provided description of the deployment.
- Description string `json:"description,omitempty"`
-
- // Fingerprint: Provides a fingerprint to use in requests to modify a
- // deployment, such as update(), stop(), and cancelPreview() requests. A
- // fingerprint is a randomly generated value that must be provided with
- // update(), stop(), and cancelPreview() requests to perform optimistic
- // locking. This ensures optimistic concurrency so that only one request
- // happens at a time.
- //
- // The fingerprint is initially generated by Deployment Manager and
- // changes after every request to modify data. To get the latest
- // fingerprint value, perform a get() request to a deployment.
- Fingerprint string `json:"fingerprint,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // InsertTime: [Output Only] Timestamp when the deployment was created,
- // in RFC3339 text format .
- InsertTime string `json:"insertTime,omitempty"`
-
- // Manifest: [Output Only] URL of the manifest representing the last
- // manifest that was successfully deployed.
- Manifest string `json:"manifest,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // Operation: [Output Only] The Operation that most recently ran, or is
- // currently running, on this deployment.
- Operation *Operation `json:"operation,omitempty"`
-
- // Target: [Input Only] The parameters that define your deployment,
- // including the deployment configuration and relevant templates.
- Target *TargetConfiguration `json:"target,omitempty"`
-
- // Update: [Output Only] If Deployment Manager is currently updating or
- // previewing an update to this deployment, the updated configuration
- // appears here.
- Update *DeploymentUpdate `json:"update,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Description") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Deployment) MarshalJSON() ([]byte, error) {
- type noMethod Deployment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DeploymentUpdate struct {
- // Manifest: [Output Only] URL of the manifest representing the update
- // configuration of this deployment.
- Manifest string `json:"manifest,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Manifest") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DeploymentUpdate) MarshalJSON() ([]byte, error) {
- type noMethod DeploymentUpdate
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DeploymentsCancelPreviewRequest struct {
- // Fingerprint: Specifies a fingerprint for cancelPreview() requests. A
- // fingerprint is a randomly generated value that must be provided in
- // cancelPreview() requests to perform optimistic locking. This ensures
- // optimistic concurrency so that the deployment does not have
- // conflicting requests (e.g. if someone attempts to make a new update
- // request while another user attempts to cancel a preview, this would
- // prevent one of the requests).
- //
- // The fingerprint is initially generated by Deployment Manager and
- // changes after every request to modify a deployment. To get the latest
- // fingerprint value, perform a get() request to a deployment.
- Fingerprint string `json:"fingerprint,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Fingerprint") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DeploymentsCancelPreviewRequest) MarshalJSON() ([]byte, error) {
- type noMethod DeploymentsCancelPreviewRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DeploymentsListResponse: A response containing a partial list of
-// deployments and a page token used to build the next request if the
-// request has been truncated.
-type DeploymentsListResponse struct {
- // Deployments: [Output Only] The deployments contained in this
- // response.
- Deployments []*Deployment `json:"deployments,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Deployments") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DeploymentsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod DeploymentsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DeploymentsStopRequest struct {
- // Fingerprint: Specifies a fingerprint for stop() requests. A
- // fingerprint is a randomly generated value that must be provided in
- // stop() requests to perform optimistic locking. This ensures
- // optimistic concurrency so that the deployment does not have
- // conflicting requests (e.g. if someone attempts to make a new update
- // request while another user attempts to stop an ongoing update
- // request, this would prevent a collision).
- //
- // The fingerprint is initially generated by Deployment Manager and
- // changes after every request to modify a deployment. To get the latest
- // fingerprint value, perform a get() request to a deployment.
- Fingerprint string `json:"fingerprint,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Fingerprint") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DeploymentsStopRequest) MarshalJSON() ([]byte, error) {
- type noMethod DeploymentsStopRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ImportFile struct {
- // Content: The contents of the file.
- Content string `json:"content,omitempty"`
-
- // Name: The name of the file.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Content") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ImportFile) MarshalJSON() ([]byte, error) {
- type noMethod ImportFile
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Manifest struct {
- // Config: [Output Only] The YAML configuration for this manifest.
- Config *ConfigFile `json:"config,omitempty"`
-
- // ExpandedConfig: [Output Only] The fully-expanded configuration file,
- // including any templates and references.
- ExpandedConfig string `json:"expandedConfig,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Imports: [Output Only] The imported files for this manifest.
- Imports []*ImportFile `json:"imports,omitempty"`
-
- // InsertTime: [Output Only] Timestamp when the manifest was created, in
- // RFC3339 text format.
- InsertTime string `json:"insertTime,omitempty"`
-
- // Layout: [Output Only] The YAML layout for this manifest.
- Layout string `json:"layout,omitempty"`
-
- // Name: [Output Only] The name of the manifest.
- Name string `json:"name,omitempty"`
-
- // SelfLink: [Output Only] Self link for the manifest.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Config") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Manifest) MarshalJSON() ([]byte, error) {
- type noMethod Manifest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ManifestsListResponse: A response containing a partial list of
-// manifests and a page token used to build the next request if the
-// request has been truncated.
-type ManifestsListResponse struct {
- // Manifests: [Output Only] Manifests contained in this list response.
- Manifests []*Manifest `json:"manifests,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Manifests") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ManifestsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod ManifestsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Operation: An Operation resource, used to manage asynchronous API
-// requests.
-type Operation struct {
- // ClientOperationId: [Output Only] An optional identifier specified by
- // the client when the mutation was initiated. Must be unique for all
- // Operation resources in the project.
- ClientOperationId string `json:"clientOperationId,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // EndTime: [Output Only] The time that this operation was completed.
- // This is in RFC3339 text format.
- EndTime string `json:"endTime,omitempty"`
-
- // Error: [Output Only] If errors are generated during processing of the
- // operation, this field will be populated.
- Error *OperationError `json:"error,omitempty"`
-
- // HttpErrorMessage: [Output Only] If the operation fails, this field
- // contains the HTTP error message that was returned, such as NOT FOUND.
- HttpErrorMessage string `json:"httpErrorMessage,omitempty"`
-
- // HttpErrorStatusCode: [Output Only] If the operation fails, this field
- // contains the HTTP error message that was returned, such as 404.
- HttpErrorStatusCode int64 `json:"httpErrorStatusCode,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // InsertTime: [Output Only] The time that this operation was requested.
- // This is in RFC3339 text format.
- InsertTime string `json:"insertTime,omitempty"`
-
- // Kind: [Output Only] Type of the resource. Always compute#Operation
- // for Operation resources.
- Kind string `json:"kind,omitempty"`
-
- // Name: [Output Only] Name of the resource.
- Name string `json:"name,omitempty"`
-
- // OperationType: [Output Only] Type of the operation, such as insert,
- // update, and delete.
- OperationType string `json:"operationType,omitempty"`
-
- // Progress: [Output Only] An optional progress indicator that ranges
- // from 0 to 100. There is no requirement that this be linear or support
- // any granularity of operations. This should not be used to guess at
- // when the operation will be complete. This number should monotonically
- // increase as the operation progresses.
- Progress int64 `json:"progress,omitempty"`
-
- // Region: [Output Only] URL of the region where the operation resides.
- // Only applicable for regional resources.
- Region string `json:"region,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // StartTime: [Output Only] The time that this operation was started by
- // the server. This is in RFC3339 text format.
- StartTime string `json:"startTime,omitempty"`
-
- // Status: [Output Only] Status of the operation. Can be one of the
- // following: PENDING, RUNNING, or DONE.
- Status string `json:"status,omitempty"`
-
- // StatusMessage: [Output Only] An optional textual description of the
- // current status of the operation.
- StatusMessage string `json:"statusMessage,omitempty"`
-
- // TargetId: [Output Only] Unique target ID which identifies a
- // particular incarnation of the target.
- TargetId uint64 `json:"targetId,omitempty,string"`
-
- // TargetLink: [Output Only] URL of the resource the operation is
- // mutating.
- TargetLink string `json:"targetLink,omitempty"`
-
- // User: [Output Only] User who requested the operation, for example:
- // user@example.com.
- User string `json:"user,omitempty"`
-
- // Warnings: [Output Only] If warning messages are generated during
- // processing of the operation, this field will be populated.
- Warnings []*OperationWarnings `json:"warnings,omitempty"`
-
- // Zone: [Output Only] URL of the zone where the operation resides.
- Zone string `json:"zone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ClientOperationId")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Operation) MarshalJSON() ([]byte, error) {
- type noMethod Operation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperationError: [Output Only] If errors are generated during
-// processing of the operation, this field will be populated.
-type OperationError struct {
- // Errors: [Output Only] The array of errors encountered while
- // processing this operation.
- Errors []*OperationErrorErrors `json:"errors,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Errors") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationError) MarshalJSON() ([]byte, error) {
- type noMethod OperationError
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationErrorErrors struct {
- // Code: [Output Only] The error type identifier for this error.
- Code string `json:"code,omitempty"`
-
- // Location: [Output Only] Indicates the field in the request which
- // caused the error. This property is optional.
- Location string `json:"location,omitempty"`
-
- // Message: [Output Only] An optional, human-readable error message.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationErrorErrors) MarshalJSON() ([]byte, error) {
- type noMethod OperationErrorErrors
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationWarnings struct {
- // Code: [Output Only] The warning type identifier for this warning.
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*OperationWarningsData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationWarnings) MarshalJSON() ([]byte, error) {
- type noMethod OperationWarnings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationWarningsData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationWarningsData) MarshalJSON() ([]byte, error) {
- type noMethod OperationWarningsData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperationsListResponse: A response containing a partial list of
-// operations and a page token used to build the next request if the
-// request has been truncated.
-type OperationsListResponse struct {
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Operations: [Output Only] Operations contained in this list response.
- Operations []*Operation `json:"operations,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "NextPageToken") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod OperationsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Resource struct {
- // FinalProperties: [Output Only] The evaluated properties of the
- // resource with references expanded. Returned as serialized YAML.
- FinalProperties string `json:"finalProperties,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // InsertTime: [Output Only] Timestamp when the resource was created or
- // acquired, in RFC3339 text format .
- InsertTime string `json:"insertTime,omitempty"`
-
- // Manifest: [Output Only] URL of the manifest representing the current
- // configuration of this resource.
- Manifest string `json:"manifest,omitempty"`
-
- // Name: [Output Only] The name of the resource as it appears in the
- // YAML config.
- Name string `json:"name,omitempty"`
-
- // Properties: [Output Only] The current properties of the resource
- // before any references have been filled in. Returned as serialized
- // YAML.
- Properties string `json:"properties,omitempty"`
-
- // Type: [Output Only] The type of the resource, for example
- // compute.v1.instance, or replicaPools.v1beta2.instanceGroupManager.
- Type string `json:"type,omitempty"`
-
- // Update: [Output Only] If Deployment Manager is currently updating or
- // previewing an update to this resource, the updated configuration
- // appears here.
- Update *ResourceUpdate `json:"update,omitempty"`
-
- // UpdateTime: [Output Only] Timestamp when the resource was updated, in
- // RFC3339 text format .
- UpdateTime string `json:"updateTime,omitempty"`
-
- // Url: [Output Only] The URL of the actual resource.
- Url string `json:"url,omitempty"`
-
- // Warnings: [Output Only] If warning messages are generated during
- // processing of this resource, this field will be populated.
- Warnings []*ResourceWarnings `json:"warnings,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "FinalProperties") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Resource) MarshalJSON() ([]byte, error) {
- type noMethod Resource
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ResourceWarnings struct {
- // Code: [Output Only] The warning type identifier for this warning.
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*ResourceWarningsData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ResourceWarnings) MarshalJSON() ([]byte, error) {
- type noMethod ResourceWarnings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ResourceWarningsData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ResourceWarningsData) MarshalJSON() ([]byte, error) {
- type noMethod ResourceWarningsData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ResourceUpdate struct {
- // Error: [Output Only] If errors are generated during update of the
- // resource, this field will be populated.
- Error *ResourceUpdateError `json:"error,omitempty"`
-
- // FinalProperties: [Output Only] The expanded properties of the
- // resource with reference values expanded. Returned as serialized YAML.
- FinalProperties string `json:"finalProperties,omitempty"`
-
- // Intent: [Output Only] The intent of the resource: PREVIEW, UPDATE, or
- // CANCEL.
- Intent string `json:"intent,omitempty"`
-
- // Manifest: [Output Only] URL of the manifest representing the update
- // configuration of this resource.
- Manifest string `json:"manifest,omitempty"`
-
- // Properties: [Output Only] The set of updated properties for this
- // resource, before references are expanded. Returned as serialized
- // YAML.
- Properties string `json:"properties,omitempty"`
-
- // State: [Output Only] The state of the resource.
- State string `json:"state,omitempty"`
-
- // Warnings: [Output Only] If warning messages are generated during
- // processing of this resource, this field will be populated.
- Warnings []*ResourceUpdateWarnings `json:"warnings,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Error") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ResourceUpdate) MarshalJSON() ([]byte, error) {
- type noMethod ResourceUpdate
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ResourceUpdateError: [Output Only] If errors are generated during
-// update of the resource, this field will be populated.
-type ResourceUpdateError struct {
- // Errors: [Output Only] The array of errors encountered while
- // processing this operation.
- Errors []*ResourceUpdateErrorErrors `json:"errors,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Errors") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ResourceUpdateError) MarshalJSON() ([]byte, error) {
- type noMethod ResourceUpdateError
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ResourceUpdateErrorErrors struct {
- // Code: [Output Only] The error type identifier for this error.
- Code string `json:"code,omitempty"`
-
- // Location: [Output Only] Indicates the field in the request which
- // caused the error. This property is optional.
- Location string `json:"location,omitempty"`
-
- // Message: [Output Only] An optional, human-readable error message.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ResourceUpdateErrorErrors) MarshalJSON() ([]byte, error) {
- type noMethod ResourceUpdateErrorErrors
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ResourceUpdateWarnings struct {
- // Code: [Output Only] The warning type identifier for this warning.
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*ResourceUpdateWarningsData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ResourceUpdateWarnings) MarshalJSON() ([]byte, error) {
- type noMethod ResourceUpdateWarnings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ResourceUpdateWarningsData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ResourceUpdateWarningsData) MarshalJSON() ([]byte, error) {
- type noMethod ResourceUpdateWarningsData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ResourcesListResponse: A response containing a partial list of
-// resources and a page token used to build the next request if the
-// request has been truncated.
-type ResourcesListResponse struct {
- // NextPageToken: A token used to continue a truncated list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Resources: Resources contained in this list response.
- Resources []*Resource `json:"resources,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "NextPageToken") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ResourcesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod ResourcesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetConfiguration struct {
- // Config: The configuration to use for this deployment.
- Config *ConfigFile `json:"config,omitempty"`
-
- // Imports: Specifies any files to import for this configuration. This
- // can be used to import templates or other files. For example, you
- // might import a text file in order to use the file in a template.
- Imports []*ImportFile `json:"imports,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Config") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetConfiguration) MarshalJSON() ([]byte, error) {
- type noMethod TargetConfiguration
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Type: A resource type supported by Deployment Manager.
-type Type struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // InsertTime: [Output Only] Timestamp when the type was created, in
- // RFC3339 text format.
- InsertTime string `json:"insertTime,omitempty"`
-
- // Name: Name of the type.
- Name string `json:"name,omitempty"`
-
- // SelfLink: [Output Only] Self link for the type.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Type) MarshalJSON() ([]byte, error) {
- type noMethod Type
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TypesListResponse: A response that returns all Types supported by
-// Deployment Manager
-type TypesListResponse struct {
- // NextPageToken: A token used to continue a truncated list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Types: [Output Only] A list of resource types supported by Deployment
- // Manager.
- Types []*Type `json:"types,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "NextPageToken") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TypesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod TypesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "deploymentmanager.deployments.cancelPreview":
-
-type DeploymentsCancelPreviewCall struct {
- s *Service
- project string
- deployment string
- deploymentscancelpreviewrequest *DeploymentsCancelPreviewRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// CancelPreview: Cancels and removes the preview currently associated
-// with the deployment.
-func (r *DeploymentsService) CancelPreview(project string, deployment string, deploymentscancelpreviewrequest *DeploymentsCancelPreviewRequest) *DeploymentsCancelPreviewCall {
- c := &DeploymentsCancelPreviewCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.deployment = deployment
- c.deploymentscancelpreviewrequest = deploymentscancelpreviewrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DeploymentsCancelPreviewCall) Fields(s ...googleapi.Field) *DeploymentsCancelPreviewCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DeploymentsCancelPreviewCall) Context(ctx context.Context) *DeploymentsCancelPreviewCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DeploymentsCancelPreviewCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.deploymentscancelpreviewrequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments/{deployment}/cancelPreview")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "deployment": c.deployment,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.deployments.cancelPreview" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DeploymentsCancelPreviewCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Cancels and removes the preview currently associated with the deployment.",
- // "httpMethod": "POST",
- // "id": "deploymentmanager.deployments.cancelPreview",
- // "parameterOrder": [
- // "project",
- // "deployment"
- // ],
- // "parameters": {
- // "deployment": {
- // "description": "The name of the deployment for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments/{deployment}/cancelPreview",
- // "request": {
- // "$ref": "DeploymentsCancelPreviewRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/ndev.cloudman"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.deployments.delete":
-
-type DeploymentsDeleteCall struct {
- s *Service
- project string
- deployment string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes a deployment and all of the resources in the
-// deployment.
-func (r *DeploymentsService) Delete(project string, deployment string) *DeploymentsDeleteCall {
- c := &DeploymentsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.deployment = deployment
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DeploymentsDeleteCall) Fields(s ...googleapi.Field) *DeploymentsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DeploymentsDeleteCall) Context(ctx context.Context) *DeploymentsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DeploymentsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments/{deployment}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "deployment": c.deployment,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.deployments.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DeploymentsDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes a deployment and all of the resources in the deployment.",
- // "httpMethod": "DELETE",
- // "id": "deploymentmanager.deployments.delete",
- // "parameterOrder": [
- // "project",
- // "deployment"
- // ],
- // "parameters": {
- // "deployment": {
- // "description": "The name of the deployment for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments/{deployment}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/ndev.cloudman"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.deployments.get":
-
-type DeploymentsGetCall struct {
- s *Service
- project string
- deployment string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets information about a specific deployment.
-func (r *DeploymentsService) Get(project string, deployment string) *DeploymentsGetCall {
- c := &DeploymentsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.deployment = deployment
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DeploymentsGetCall) Fields(s ...googleapi.Field) *DeploymentsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DeploymentsGetCall) IfNoneMatch(entityTag string) *DeploymentsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DeploymentsGetCall) Context(ctx context.Context) *DeploymentsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DeploymentsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments/{deployment}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "deployment": c.deployment,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.deployments.get" call.
-// Exactly one of *Deployment or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Deployment.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DeploymentsGetCall) Do() (*Deployment, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Deployment{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets information about a specific deployment.",
- // "httpMethod": "GET",
- // "id": "deploymentmanager.deployments.get",
- // "parameterOrder": [
- // "project",
- // "deployment"
- // ],
- // "parameters": {
- // "deployment": {
- // "description": "The name of the deployment for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments/{deployment}",
- // "response": {
- // "$ref": "Deployment"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/ndev.cloudman",
- // "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.deployments.insert":
-
-type DeploymentsInsertCall struct {
- s *Service
- project string
- deployment *Deployment
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a deployment and all of the resources described by
-// the deployment manifest.
-func (r *DeploymentsService) Insert(project string, deployment *Deployment) *DeploymentsInsertCall {
- c := &DeploymentsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.deployment = deployment
- return c
-}
-
-// Preview sets the optional parameter "preview": If set to true,
-// creates a deployment and creates "shell" resources but does not
-// actually instantiate these resources. This allows you to preview what
-// your deployment looks like. After previewing a deployment, you can
-// deploy your resources by making a request with the update() method or
-// you can use the cancelPreview() method to cancel the preview
-// altogether. Note that the deployment will still exist after you
-// cancel the preview and you must separately delete this deployment if
-// you want to remove it.
-func (c *DeploymentsInsertCall) Preview(preview bool) *DeploymentsInsertCall {
- c.opt_["preview"] = preview
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DeploymentsInsertCall) Fields(s ...googleapi.Field) *DeploymentsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DeploymentsInsertCall) Context(ctx context.Context) *DeploymentsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DeploymentsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.deployment)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["preview"]; ok {
- params.Set("preview", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.deployments.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DeploymentsInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a deployment and all of the resources described by the deployment manifest.",
- // "httpMethod": "POST",
- // "id": "deploymentmanager.deployments.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "preview": {
- // "description": "If set to true, creates a deployment and creates \"shell\" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. After previewing a deployment, you can deploy your resources by making a request with the update() method or you can use the cancelPreview() method to cancel the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments",
- // "request": {
- // "$ref": "Deployment"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/ndev.cloudman"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.deployments.list":
-
-type DeploymentsListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all deployments for a given project.
-func (r *DeploymentsService) List(project string) *DeploymentsListCall {
- c := &DeploymentsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *DeploymentsListCall) Filter(filter string) *DeploymentsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *DeploymentsListCall) MaxResults(maxResults int64) *DeploymentsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *DeploymentsListCall) PageToken(pageToken string) *DeploymentsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DeploymentsListCall) Fields(s ...googleapi.Field) *DeploymentsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DeploymentsListCall) IfNoneMatch(entityTag string) *DeploymentsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DeploymentsListCall) Context(ctx context.Context) *DeploymentsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DeploymentsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.deployments.list" call.
-// Exactly one of *DeploymentsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *DeploymentsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DeploymentsListCall) Do() (*DeploymentsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DeploymentsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all deployments for a given project.",
- // "httpMethod": "GET",
- // "id": "deploymentmanager.deployments.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments",
- // "response": {
- // "$ref": "DeploymentsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/ndev.cloudman",
- // "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.deployments.patch":
-
-type DeploymentsPatchCall struct {
- s *Service
- project string
- deployment string
- deployment2 *Deployment
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates a deployment and all of the resources described by the
-// deployment manifest. This method supports patch semantics.
-func (r *DeploymentsService) Patch(project string, deployment string, deployment2 *Deployment) *DeploymentsPatchCall {
- c := &DeploymentsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.deployment = deployment
- c.deployment2 = deployment2
- return c
-}
-
-// CreatePolicy sets the optional parameter "createPolicy": Sets the
-// policy to use for creating new resources.
-//
-// Possible values:
-// "ACQUIRE"
-// "CREATE_OR_ACQUIRE" (default)
-func (c *DeploymentsPatchCall) CreatePolicy(createPolicy string) *DeploymentsPatchCall {
- c.opt_["createPolicy"] = createPolicy
- return c
-}
-
-// DeletePolicy sets the optional parameter "deletePolicy": Sets the
-// policy to use for deleting resources.
-//
-// Possible values:
-// "ABANDON"
-// "DELETE" (default)
-func (c *DeploymentsPatchCall) DeletePolicy(deletePolicy string) *DeploymentsPatchCall {
- c.opt_["deletePolicy"] = deletePolicy
- return c
-}
-
-// Preview sets the optional parameter "preview": If set to true,
-// updates the deployment and creates and updates the "shell" resources
-// but does not actually alter or instantiate these resources. This
-// allows you to preview what your deployment looks like. You can use
-// this intent to preview how an update would affect your deployment.
-// You must provide a target.config with a configuration if this is set
-// to true. After previewing a deployment, you can deploy your resources
-// by making a request with the update() or you can cancelPreview() to
-// remove the preview altogether. Note that the deployment will still
-// exist after you cancel the preview and you must separately delete
-// this deployment if you want to remove it.
-func (c *DeploymentsPatchCall) Preview(preview bool) *DeploymentsPatchCall {
- c.opt_["preview"] = preview
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DeploymentsPatchCall) Fields(s ...googleapi.Field) *DeploymentsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DeploymentsPatchCall) Context(ctx context.Context) *DeploymentsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DeploymentsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.deployment2)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["createPolicy"]; ok {
- params.Set("createPolicy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["deletePolicy"]; ok {
- params.Set("deletePolicy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["preview"]; ok {
- params.Set("preview", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments/{deployment}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "deployment": c.deployment,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.deployments.patch" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DeploymentsPatchCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "deploymentmanager.deployments.patch",
- // "parameterOrder": [
- // "project",
- // "deployment"
- // ],
- // "parameters": {
- // "createPolicy": {
- // "default": "CREATE_OR_ACQUIRE",
- // "description": "Sets the policy to use for creating new resources.",
- // "enum": [
- // "ACQUIRE",
- // "CREATE_OR_ACQUIRE"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "deletePolicy": {
- // "default": "DELETE",
- // "description": "Sets the policy to use for deleting resources.",
- // "enum": [
- // "ABANDON",
- // "DELETE"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "deployment": {
- // "description": "The name of the deployment for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "preview": {
- // "default": "false",
- // "description": "If set to true, updates the deployment and creates and updates the \"shell\" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment looks like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments/{deployment}",
- // "request": {
- // "$ref": "Deployment"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/ndev.cloudman"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.deployments.stop":
-
-type DeploymentsStopCall struct {
- s *Service
- project string
- deployment string
- deploymentsstoprequest *DeploymentsStopRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Stop: Stops an ongoing operation. This does not roll back any work
-// that has already been completed, but prevents any new work from being
-// started.
-func (r *DeploymentsService) Stop(project string, deployment string, deploymentsstoprequest *DeploymentsStopRequest) *DeploymentsStopCall {
- c := &DeploymentsStopCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.deployment = deployment
- c.deploymentsstoprequest = deploymentsstoprequest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DeploymentsStopCall) Fields(s ...googleapi.Field) *DeploymentsStopCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DeploymentsStopCall) Context(ctx context.Context) *DeploymentsStopCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DeploymentsStopCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.deploymentsstoprequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments/{deployment}/stop")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "deployment": c.deployment,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.deployments.stop" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DeploymentsStopCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Stops an ongoing operation. This does not roll back any work that has already been completed, but prevents any new work from being started.",
- // "httpMethod": "POST",
- // "id": "deploymentmanager.deployments.stop",
- // "parameterOrder": [
- // "project",
- // "deployment"
- // ],
- // "parameters": {
- // "deployment": {
- // "description": "The name of the deployment for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments/{deployment}/stop",
- // "request": {
- // "$ref": "DeploymentsStopRequest"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/ndev.cloudman"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.deployments.update":
-
-type DeploymentsUpdateCall struct {
- s *Service
- project string
- deployment string
- deployment2 *Deployment
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates a deployment and all of the resources described by
-// the deployment manifest.
-func (r *DeploymentsService) Update(project string, deployment string, deployment2 *Deployment) *DeploymentsUpdateCall {
- c := &DeploymentsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.deployment = deployment
- c.deployment2 = deployment2
- return c
-}
-
-// CreatePolicy sets the optional parameter "createPolicy": Sets the
-// policy to use for creating new resources.
-//
-// Possible values:
-// "ACQUIRE"
-// "CREATE_OR_ACQUIRE" (default)
-func (c *DeploymentsUpdateCall) CreatePolicy(createPolicy string) *DeploymentsUpdateCall {
- c.opt_["createPolicy"] = createPolicy
- return c
-}
-
-// DeletePolicy sets the optional parameter "deletePolicy": Sets the
-// policy to use for deleting resources.
-//
-// Possible values:
-// "ABANDON"
-// "DELETE" (default)
-func (c *DeploymentsUpdateCall) DeletePolicy(deletePolicy string) *DeploymentsUpdateCall {
- c.opt_["deletePolicy"] = deletePolicy
- return c
-}
-
-// Preview sets the optional parameter "preview": If set to true,
-// updates the deployment and creates and updates the "shell" resources
-// but does not actually alter or instantiate these resources. This
-// allows you to preview what your deployment looks like. You can use
-// this intent to preview how an update would affect your deployment.
-// You must provide a target.config with a configuration if this is set
-// to true. After previewing a deployment, you can deploy your resources
-// by making a request with the update() or you can cancelPreview() to
-// remove the preview altogether. Note that the deployment will still
-// exist after you cancel the preview and you must separately delete
-// this deployment if you want to remove it.
-func (c *DeploymentsUpdateCall) Preview(preview bool) *DeploymentsUpdateCall {
- c.opt_["preview"] = preview
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DeploymentsUpdateCall) Fields(s ...googleapi.Field) *DeploymentsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DeploymentsUpdateCall) Context(ctx context.Context) *DeploymentsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DeploymentsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.deployment2)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["createPolicy"]; ok {
- params.Set("createPolicy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["deletePolicy"]; ok {
- params.Set("deletePolicy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["preview"]; ok {
- params.Set("preview", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments/{deployment}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "deployment": c.deployment,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.deployments.update" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DeploymentsUpdateCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a deployment and all of the resources described by the deployment manifest.",
- // "httpMethod": "PUT",
- // "id": "deploymentmanager.deployments.update",
- // "parameterOrder": [
- // "project",
- // "deployment"
- // ],
- // "parameters": {
- // "createPolicy": {
- // "default": "CREATE_OR_ACQUIRE",
- // "description": "Sets the policy to use for creating new resources.",
- // "enum": [
- // "ACQUIRE",
- // "CREATE_OR_ACQUIRE"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "deletePolicy": {
- // "default": "DELETE",
- // "description": "Sets the policy to use for deleting resources.",
- // "enum": [
- // "ABANDON",
- // "DELETE"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "deployment": {
- // "description": "The name of the deployment for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "preview": {
- // "default": "false",
- // "description": "If set to true, updates the deployment and creates and updates the \"shell\" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment looks like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments/{deployment}",
- // "request": {
- // "$ref": "Deployment"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/ndev.cloudman"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.manifests.get":
-
-type ManifestsGetCall struct {
- s *Service
- project string
- deployment string
- manifest string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets information about a specific manifest.
-func (r *ManifestsService) Get(project string, deployment string, manifest string) *ManifestsGetCall {
- c := &ManifestsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.deployment = deployment
- c.manifest = manifest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManifestsGetCall) Fields(s ...googleapi.Field) *ManifestsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManifestsGetCall) IfNoneMatch(entityTag string) *ManifestsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManifestsGetCall) Context(ctx context.Context) *ManifestsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManifestsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments/{deployment}/manifests/{manifest}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "deployment": c.deployment,
- "manifest": c.manifest,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.manifests.get" call.
-// Exactly one of *Manifest or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Manifest.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ManifestsGetCall) Do() (*Manifest, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Manifest{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets information about a specific manifest.",
- // "httpMethod": "GET",
- // "id": "deploymentmanager.manifests.get",
- // "parameterOrder": [
- // "project",
- // "deployment",
- // "manifest"
- // ],
- // "parameters": {
- // "deployment": {
- // "description": "The name of the deployment for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "manifest": {
- // "description": "The name of the manifest for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments/{deployment}/manifests/{manifest}",
- // "response": {
- // "$ref": "Manifest"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/ndev.cloudman",
- // "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.manifests.list":
-
-type ManifestsListCall struct {
- s *Service
- project string
- deployment string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all manifests for a given deployment.
-func (r *ManifestsService) List(project string, deployment string) *ManifestsListCall {
- c := &ManifestsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.deployment = deployment
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *ManifestsListCall) Filter(filter string) *ManifestsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *ManifestsListCall) MaxResults(maxResults int64) *ManifestsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *ManifestsListCall) PageToken(pageToken string) *ManifestsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManifestsListCall) Fields(s ...googleapi.Field) *ManifestsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManifestsListCall) IfNoneMatch(entityTag string) *ManifestsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManifestsListCall) Context(ctx context.Context) *ManifestsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManifestsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments/{deployment}/manifests")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "deployment": c.deployment,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.manifests.list" call.
-// Exactly one of *ManifestsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ManifestsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManifestsListCall) Do() (*ManifestsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ManifestsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all manifests for a given deployment.",
- // "httpMethod": "GET",
- // "id": "deploymentmanager.manifests.list",
- // "parameterOrder": [
- // "project",
- // "deployment"
- // ],
- // "parameters": {
- // "deployment": {
- // "description": "The name of the deployment for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments/{deployment}/manifests",
- // "response": {
- // "$ref": "ManifestsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/ndev.cloudman",
- // "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.operations.get":
-
-type OperationsGetCall struct {
- s *Service
- project string
- operation string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets information about a specific operation.
-func (r *OperationsService) Get(project string, operation string) *OperationsGetCall {
- c := &OperationsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.operation = operation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OperationsGetCall) Fields(s ...googleapi.Field) *OperationsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OperationsGetCall) Context(ctx context.Context) *OperationsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OperationsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/operations/{operation}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "operation": c.operation,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.operations.get" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *OperationsGetCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets information about a specific operation.",
- // "httpMethod": "GET",
- // "id": "deploymentmanager.operations.get",
- // "parameterOrder": [
- // "project",
- // "operation"
- // ],
- // "parameters": {
- // "operation": {
- // "description": "The name of the operation for this request.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/operations/{operation}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/ndev.cloudman",
- // "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.operations.list":
-
-type OperationsListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all operations for a project.
-func (r *OperationsService) List(project string) *OperationsListCall {
- c := &OperationsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *OperationsListCall) Filter(filter string) *OperationsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *OperationsListCall) MaxResults(maxResults int64) *OperationsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OperationsListCall) Fields(s ...googleapi.Field) *OperationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OperationsListCall) IfNoneMatch(entityTag string) *OperationsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OperationsListCall) Context(ctx context.Context) *OperationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OperationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/operations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.operations.list" call.
-// Exactly one of *OperationsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *OperationsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OperationsListCall) Do() (*OperationsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OperationsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all operations for a project.",
- // "httpMethod": "GET",
- // "id": "deploymentmanager.operations.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/operations",
- // "response": {
- // "$ref": "OperationsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/ndev.cloudman",
- // "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.resources.get":
-
-type ResourcesGetCall struct {
- s *Service
- project string
- deployment string
- resource string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets information about a single resource.
-func (r *ResourcesService) Get(project string, deployment string, resource string) *ResourcesGetCall {
- c := &ResourcesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.deployment = deployment
- c.resource = resource
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ResourcesGetCall) Fields(s ...googleapi.Field) *ResourcesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ResourcesGetCall) IfNoneMatch(entityTag string) *ResourcesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ResourcesGetCall) Context(ctx context.Context) *ResourcesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ResourcesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments/{deployment}/resources/{resource}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "deployment": c.deployment,
- "resource": c.resource,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.resources.get" call.
-// Exactly one of *Resource or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Resource.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ResourcesGetCall) Do() (*Resource, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Resource{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets information about a single resource.",
- // "httpMethod": "GET",
- // "id": "deploymentmanager.resources.get",
- // "parameterOrder": [
- // "project",
- // "deployment",
- // "resource"
- // ],
- // "parameters": {
- // "deployment": {
- // "description": "The name of the deployment for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "resource": {
- // "description": "The name of the resource for this request.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments/{deployment}/resources/{resource}",
- // "response": {
- // "$ref": "Resource"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/ndev.cloudman",
- // "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.resources.list":
-
-type ResourcesListCall struct {
- s *Service
- project string
- deployment string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all resources in a given deployment.
-func (r *ResourcesService) List(project string, deployment string) *ResourcesListCall {
- c := &ResourcesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.deployment = deployment
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *ResourcesListCall) Filter(filter string) *ResourcesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *ResourcesListCall) MaxResults(maxResults int64) *ResourcesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *ResourcesListCall) PageToken(pageToken string) *ResourcesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ResourcesListCall) Fields(s ...googleapi.Field) *ResourcesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ResourcesListCall) IfNoneMatch(entityTag string) *ResourcesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ResourcesListCall) Context(ctx context.Context) *ResourcesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ResourcesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments/{deployment}/resources")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "deployment": c.deployment,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.resources.list" call.
-// Exactly one of *ResourcesListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ResourcesListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ResourcesListCall) Do() (*ResourcesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ResourcesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all resources in a given deployment.",
- // "httpMethod": "GET",
- // "id": "deploymentmanager.resources.list",
- // "parameterOrder": [
- // "project",
- // "deployment"
- // ],
- // "parameters": {
- // "deployment": {
- // "description": "The name of the deployment for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments/{deployment}/resources",
- // "response": {
- // "$ref": "ResourcesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/ndev.cloudman",
- // "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.types.list":
-
-type TypesListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all resource types for Deployment Manager.
-func (r *TypesService) List(project string) *TypesListCall {
- c := &TypesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *TypesListCall) Filter(filter string) *TypesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *TypesListCall) MaxResults(maxResults int64) *TypesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *TypesListCall) PageToken(pageToken string) *TypesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TypesListCall) Fields(s ...googleapi.Field) *TypesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TypesListCall) IfNoneMatch(entityTag string) *TypesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TypesListCall) Context(ctx context.Context) *TypesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TypesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/types")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.types.list" call.
-// Exactly one of *TypesListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *TypesListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TypesListCall) Do() (*TypesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TypesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all resource types for Deployment Manager.",
- // "httpMethod": "GET",
- // "id": "deploymentmanager.types.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/types",
- // "response": {
- // "$ref": "TypesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/ndev.cloudman",
- // "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/deploymentmanager/v2beta1/deploymentmanager-api.json b/vendor/google.golang.org/api/deploymentmanager/v2beta1/deploymentmanager-api.json
deleted file mode 100644
index 127d9fea..00000000
--- a/vendor/google.golang.org/api/deploymentmanager/v2beta1/deploymentmanager-api.json
+++ /dev/null
@@ -1,883 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/u5FQM4I03EZTfBK_pxzZ11vNzAs\"",
- "discoveryVersion": "v1",
- "id": "deploymentmanager:v2beta1",
- "name": "deploymentmanager",
- "version": "v2beta1",
- "revision": "20150831",
- "title": "Google Cloud Deployment Manager API",
- "description": "The Deployment Manager API allows users to declaratively configure, deploy and run complex solutions on the Google Cloud Platform.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/deployment-manager/",
- "labels": [
- "limited_availability"
- ],
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/deploymentmanager/v2beta1/projects/",
- "basePath": "/deploymentmanager/v2beta1/projects/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "deploymentmanager/v2beta1/projects/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/ndev.cloudman": {
- "description": "View and manage your Google Cloud Platform management resources and deployment status information"
- },
- "https://www.googleapis.com/auth/ndev.cloudman.readonly": {
- "description": "View your Google Cloud Platform management resources and deployment status information"
- }
- }
- }
- },
- "schemas": {
- "Deployment": {
- "id": "Deployment",
- "type": "object",
- "description": "Next available tag: 8",
- "properties": {
- "description": {
- "type": "string",
- "description": "! An optional user-provided description of the deployment."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "manifest": {
- "type": "string",
- "description": "! [Output Only] URL of the manifest representing the full configuration ! of this deployment."
- },
- "name": {
- "type": "string",
- "description": "! The name of the deployment, which must be unique within the project."
- },
- "targetConfig": {
- "type": "string",
- "description": "! [Input Only] The YAML configuration to use in processing this deployment. ! ! When you create a deployment, the server creates a new manifest with the ! given YAML configuration and sets the `manifest` property to the URL of ! the manifest resource."
- }
- }
- },
- "DeploymentsListResponse": {
- "id": "DeploymentsListResponse",
- "type": "object",
- "description": "! A response containing a partial list of deployments and a page token used ! to build the next request if the request has been truncated. Next available tag: 4",
- "properties": {
- "deployments": {
- "type": "array",
- "description": "! The deployments contained in this response.",
- "items": {
- "$ref": "Deployment"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "! A token used to continue a truncated list request."
- }
- }
- },
- "Manifest": {
- "id": "Manifest",
- "type": "object",
- "description": "Next available tag: 10",
- "properties": {
- "config": {
- "type": "string",
- "description": "v2beta1: YAML with config - described above v2beta2: YAML + templates. ! The YAML configuration for this manifest."
- },
- "evaluatedConfig": {
- "type": "string",
- "description": "! [Output Only] The fully-expanded configuration file, including any ! templates and references."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "name": {
- "type": "string",
- "description": "! [Output Only] The name of the manifest."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Self link for the manifest."
- }
- }
- },
- "ManifestsListResponse": {
- "id": "ManifestsListResponse",
- "type": "object",
- "description": "! A response containing a partial list of manifests and a page token used ! to build the next request if the request has been truncated. Next available tag: 4",
- "properties": {
- "manifests": {
- "type": "array",
- "description": "! Manifests contained in this list response.",
- "items": {
- "$ref": "Manifest"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "! A token used to continue a truncated list request."
- }
- }
- },
- "Operation": {
- "id": "Operation",
- "type": "object",
- "description": "! An operation resource, used to manage asynchronous API requests. Next available tag: 24",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "! [Output Only] Creation timestamp in RFC3339 text format."
- },
- "endTime": {
- "type": "string",
- "description": "! [Output Only] The time that this operation was completed. This is in ! RFC3339 format."
- },
- "error": {
- "type": "object",
- "description": "! [Output Only] If errors occurred during processing of this operation, ! this field will be populated.",
- "properties": {
- "errors": {
- "type": "array",
- "description": "! The array of errors encountered while processing this operation.",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "! The error type identifier for this error."
- },
- "location": {
- "type": "string",
- "description": "! Indicates the field in the request which caused the error. ! This property is optional."
- },
- "message": {
- "type": "string",
- "description": "! An optional, human-readable error message."
- }
- }
- }
- }
- }
- },
- "httpErrorMessage": {
- "type": "string",
- "description": "! [Output Only] If operation fails, the HTTP error message returned, ! e.g. NOT FOUND."
- },
- "httpErrorStatusCode": {
- "type": "integer",
- "description": "! [Output Only] If operation fails, the HTTP error status code returned, ! e.g. 404.",
- "format": "int32"
- },
- "id": {
- "type": "string",
- "description": "! [Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "insertTime": {
- "type": "string",
- "description": "! [Output Only] The time that this operation was requested. ! This is in RFC 3339 format."
- },
- "name": {
- "type": "string",
- "description": "! [Output Only] Name of the operation."
- },
- "operationType": {
- "type": "string",
- "description": "! [Output Only] Type of the operation. Examples include \"insert\", or ! \"delete\""
- },
- "progress": {
- "type": "integer",
- "description": "! [Output Only] An optional progress indicator that ranges from 0 to 100. ! There is no requirement that this be linear or support any granularity ! of operations. This should not be used to guess at when the operation will ! be complete. This number should be monotonically increasing as the ! operation progresses.",
- "format": "int32"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Self link for the manifest."
- },
- "startTime": {
- "type": "string",
- "description": "! [Output Only] The time that this operation was started by the server. ! This is in RFC 3339 format."
- },
- "status": {
- "type": "string",
- "description": "! [Output Only] Status of the operation. Can be one of the following: ! \"PENDING\", \"RUNNING\", or \"DONE\"."
- },
- "statusMessage": {
- "type": "string",
- "description": "! [Output Only] An optional textual description of the current status of ! the operation."
- },
- "targetId": {
- "type": "string",
- "description": "! [Output Only] Unique target id which identifies a particular ! incarnation of the target.",
- "format": "uint64"
- },
- "targetLink": {
- "type": "string",
- "description": "! [Output Only] URL of the resource the operation is mutating."
- },
- "user": {
- "type": "string",
- "description": "! [Output Only] User who requested the operation, for example ! \"user@example.com\""
- },
- "warnings": {
- "type": "array",
- "description": "! [Output Only] If warning messages generated during processing of this ! operation, this field will be populated.",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "any",
- "description": "! The warning type identifier for this warning."
- },
- "data": {
- "type": "array",
- "description": "! Metadata for this warning in 'key: value' format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "! A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "! A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "! Optional human-readable details for this warning."
- }
- }
- }
- }
- }
- },
- "OperationsListResponse": {
- "id": "OperationsListResponse",
- "type": "object",
- "description": "! A response containing a partial list of operations and a page token used ! to build the next request if the request has been truncated. Next available tag: 4",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "! A token used to continue a truncated list request."
- },
- "operations": {
- "type": "array",
- "description": "! Operations contained in this list response.",
- "items": {
- "$ref": "Operation"
- }
- }
- }
- },
- "Resource": {
- "id": "Resource",
- "type": "object",
- "description": "Next available tag: 12",
- "properties": {
- "errors": {
- "type": "array",
- "description": "! [Output Only] A list of any errors that occurred during deployment.",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "intent": {
- "type": "string",
- "description": "! [Output Only] The intended state of the resource."
- },
- "manifest": {
- "type": "string",
- "description": "! [Output Only] URL of the manifest representing the current configuration ! of this resource."
- },
- "name": {
- "type": "string",
- "description": "! [Output Only] The name of the resource as it appears in the YAML config."
- },
- "state": {
- "type": "string",
- "description": "! [Output Only] The state of the resource."
- },
- "type": {
- "type": "string",
- "description": "! [Output Only] The type of the resource, for example ! ?compute.v1.instance?, or ?replicaPools.v1beta2.instanceGroupManager?"
- },
- "url": {
- "type": "string",
- "description": "! [Output Only] The URL of the actual resource."
- }
- }
- },
- "ResourcesListResponse": {
- "id": "ResourcesListResponse",
- "type": "object",
- "description": "! A response containing a partial list of resources and a page token used ! to build the next request if the request has been truncated. Next available tag: 4",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "! A token used to continue a truncated list request."
- },
- "resources": {
- "type": "array",
- "description": "! Resources contained in this list response.",
- "items": {
- "$ref": "Resource"
- }
- }
- }
- },
- "Type": {
- "id": "Type",
- "type": "object",
- "description": "! A type supported by Deployment Manager. Next available tag: 4",
- "properties": {
- "name": {
- "type": "string",
- "description": "! Name of the type."
- }
- }
- },
- "TypesListResponse": {
- "id": "TypesListResponse",
- "type": "object",
- "description": "! A response that returns all Types supported by Deployment Manager Next available tag: 3",
- "properties": {
- "types": {
- "type": "array",
- "description": "! Types supported by Deployment Manager",
- "items": {
- "$ref": "Type"
- }
- }
- }
- }
- },
- "resources": {
- "deployments": {
- "methods": {
- "delete": {
- "id": "deploymentmanager.deployments.delete",
- "path": "{project}/global/deployments/{deployment}",
- "httpMethod": "DELETE",
- "description": "! Deletes a deployment and all of the resources in the deployment.",
- "parameters": {
- "deployment": {
- "type": "string",
- "description": "! The name of the deployment for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "! The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "deployment"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/ndev.cloudman"
- ]
- },
- "get": {
- "id": "deploymentmanager.deployments.get",
- "path": "{project}/global/deployments/{deployment}",
- "httpMethod": "GET",
- "description": "! Gets information about a specific deployment.",
- "parameters": {
- "deployment": {
- "type": "string",
- "description": "! The name of the deployment for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "! The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "deployment"
- ],
- "response": {
- "$ref": "Deployment"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/ndev.cloudman",
- "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- ]
- },
- "insert": {
- "id": "deploymentmanager.deployments.insert",
- "path": "{project}/global/deployments",
- "httpMethod": "POST",
- "description": "! Creates a deployment and all of the resources described by the ! deployment manifest.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "! The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "Deployment"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/ndev.cloudman"
- ]
- },
- "list": {
- "id": "deploymentmanager.deployments.list",
- "path": "{project}/global/deployments",
- "httpMethod": "GET",
- "description": "! Lists all deployments for a given project.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "! Maximum count of results to be returned. ! Acceptable values are 0 to 100, inclusive. (Default: 50)",
- "default": "50",
- "format": "int32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "! Specifies a nextPageToken returned by a previous list request. This ! token can be used to request the next page of results from a previous ! list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "! The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "DeploymentsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/ndev.cloudman",
- "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- ]
- }
- }
- },
- "manifests": {
- "methods": {
- "get": {
- "id": "deploymentmanager.manifests.get",
- "path": "{project}/global/deployments/{deployment}/manifests/{manifest}",
- "httpMethod": "GET",
- "description": "! Gets information about a specific manifest.",
- "parameters": {
- "deployment": {
- "type": "string",
- "description": "! The name of the deployment for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "manifest": {
- "type": "string",
- "description": "! The name of the manifest for this request.",
- "required": true,
- "pattern": "[-a-z0-9]{1,61}",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "! The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "deployment",
- "manifest"
- ],
- "response": {
- "$ref": "Manifest"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/ndev.cloudman",
- "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- ]
- },
- "list": {
- "id": "deploymentmanager.manifests.list",
- "path": "{project}/global/deployments/{deployment}/manifests",
- "httpMethod": "GET",
- "description": "! Lists all manifests for a given deployment.",
- "parameters": {
- "deployment": {
- "type": "string",
- "description": "! The name of the deployment for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "! Maximum count of results to be returned. ! Acceptable values are 0 to 100, inclusive. (Default: 50)",
- "default": "50",
- "format": "int32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "! Specifies a nextPageToken returned by a previous list request. This ! token can be used to request the next page of results from a previous ! list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "! The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "deployment"
- ],
- "response": {
- "$ref": "ManifestsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/ndev.cloudman",
- "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- ]
- }
- }
- },
- "operations": {
- "methods": {
- "get": {
- "id": "deploymentmanager.operations.get",
- "path": "{project}/global/operations/{operation}",
- "httpMethod": "GET",
- "description": "! Gets information about a specific Operation.",
- "parameters": {
- "operation": {
- "type": "string",
- "description": "! The name of the operation for this request.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "! The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "operation"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/ndev.cloudman",
- "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- ]
- },
- "list": {
- "id": "deploymentmanager.operations.list",
- "path": "{project}/global/operations",
- "httpMethod": "GET",
- "description": "! Lists all Operations for a project.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "! Maximum count of results to be returned. ! Acceptable values are 0 to 100, inclusive. (Default: 50)",
- "default": "50",
- "format": "int32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "! Specifies a nextPageToken returned by a previous list request. This ! token can be used to request the next page of results from a previous ! list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "! The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "OperationsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/ndev.cloudman",
- "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- ]
- }
- }
- },
- "resources": {
- "methods": {
- "get": {
- "id": "deploymentmanager.resources.get",
- "path": "{project}/global/deployments/{deployment}/resources/{resource}",
- "httpMethod": "GET",
- "description": "! Gets information about a single resource.",
- "parameters": {
- "deployment": {
- "type": "string",
- "description": "! The name of the deployment for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "! The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "resource": {
- "type": "string",
- "description": "! The name of the resource for this request.",
- "required": true,
- "pattern": "[-a-z0-9]{1,61}",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "deployment",
- "resource"
- ],
- "response": {
- "$ref": "Resource"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/ndev.cloudman",
- "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- ]
- },
- "list": {
- "id": "deploymentmanager.resources.list",
- "path": "{project}/global/deployments/{deployment}/resources",
- "httpMethod": "GET",
- "description": "! Lists all resources in a given deployment.",
- "parameters": {
- "deployment": {
- "type": "string",
- "description": "! The name of the deployment for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "! Maximum count of results to be returned. ! Acceptable values are 0 to 100, inclusive. (Default: 50)",
- "default": "50",
- "format": "int32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "! Specifies a nextPageToken returned by a previous list request. This ! token can be used to request the next page of results from a previous ! list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "! The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "deployment"
- ],
- "response": {
- "$ref": "ResourcesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/ndev.cloudman",
- "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- ]
- }
- }
- },
- "types": {
- "methods": {
- "list": {
- "id": "deploymentmanager.types.list",
- "path": "{project}/global/types",
- "httpMethod": "GET",
- "description": "! Lists all Types for Deployment Manager.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "! Maximum count of results to be returned. ! Acceptable values are 0 to 100, inclusive. (Default: 50)",
- "default": "50",
- "format": "int32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "! Specifies a nextPageToken returned by a previous list request. This ! token can be used to request the next page of results from a previous ! list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "! The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "TypesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/ndev.cloudman",
- "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/deploymentmanager/v2beta1/deploymentmanager-gen.go b/vendor/google.golang.org/api/deploymentmanager/v2beta1/deploymentmanager-gen.go
deleted file mode 100644
index 6437a7ce..00000000
--- a/vendor/google.golang.org/api/deploymentmanager/v2beta1/deploymentmanager-gen.go
+++ /dev/null
@@ -1,2323 +0,0 @@
-// Package deploymentmanager provides access to the Google Cloud Deployment Manager API.
-//
-// See https://developers.google.com/deployment-manager/
-//
-// Usage example:
-//
-// import "google.golang.org/api/deploymentmanager/v2beta1"
-// ...
-// deploymentmanagerService, err := deploymentmanager.New(oauthHttpClient)
-package deploymentmanager // import "google.golang.org/api/deploymentmanager/v2beta1"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "deploymentmanager:v2beta1"
-const apiName = "deploymentmanager"
-const apiVersion = "v2beta1"
-const basePath = "https://www.googleapis.com/deploymentmanager/v2beta1/projects/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your data across Google Cloud Platform services
- CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
-
- // View your data across Google Cloud Platform services
- CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"
-
- // View and manage your Google Cloud Platform management resources and
- // deployment status information
- NdevCloudmanScope = "https://www.googleapis.com/auth/ndev.cloudman"
-
- // View your Google Cloud Platform management resources and deployment
- // status information
- NdevCloudmanReadonlyScope = "https://www.googleapis.com/auth/ndev.cloudman.readonly"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Deployments = NewDeploymentsService(s)
- s.Manifests = NewManifestsService(s)
- s.Operations = NewOperationsService(s)
- s.Resources = NewResourcesService(s)
- s.Types = NewTypesService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Deployments *DeploymentsService
-
- Manifests *ManifestsService
-
- Operations *OperationsService
-
- Resources *ResourcesService
-
- Types *TypesService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewDeploymentsService(s *Service) *DeploymentsService {
- rs := &DeploymentsService{s: s}
- return rs
-}
-
-type DeploymentsService struct {
- s *Service
-}
-
-func NewManifestsService(s *Service) *ManifestsService {
- rs := &ManifestsService{s: s}
- return rs
-}
-
-type ManifestsService struct {
- s *Service
-}
-
-func NewOperationsService(s *Service) *OperationsService {
- rs := &OperationsService{s: s}
- return rs
-}
-
-type OperationsService struct {
- s *Service
-}
-
-func NewResourcesService(s *Service) *ResourcesService {
- rs := &ResourcesService{s: s}
- return rs
-}
-
-type ResourcesService struct {
- s *Service
-}
-
-func NewTypesService(s *Service) *TypesService {
- rs := &TypesService{s: s}
- return rs
-}
-
-type TypesService struct {
- s *Service
-}
-
-// Deployment: Next available tag: 8
-type Deployment struct {
- // Description: ! An optional user-provided description of the
- // deployment.
- Description string `json:"description,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Manifest: ! [Output Only] URL of the manifest representing the full
- // configuration ! of this deployment.
- Manifest string `json:"manifest,omitempty"`
-
- // Name: ! The name of the deployment, which must be unique within the
- // project.
- Name string `json:"name,omitempty"`
-
- // TargetConfig: ! [Input Only] The YAML configuration to use in
- // processing this deployment. ! ! When you create a deployment, the
- // server creates a new manifest with the ! given YAML configuration and
- // sets the `manifest` property to the URL of ! the manifest resource.
- TargetConfig string `json:"targetConfig,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Description") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Deployment) MarshalJSON() ([]byte, error) {
- type noMethod Deployment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DeploymentsListResponse: ! A response containing a partial list of
-// deployments and a page token used ! to build the next request if the
-// request has been truncated. Next available tag: 4
-type DeploymentsListResponse struct {
- // Deployments: ! The deployments contained in this response.
- Deployments []*Deployment `json:"deployments,omitempty"`
-
- // NextPageToken: ! A token used to continue a truncated list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Deployments") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DeploymentsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod DeploymentsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Manifest: Next available tag: 10
-type Manifest struct {
- // Config: v2beta1: YAML with config - described above v2beta2: YAML +
- // templates. ! The YAML configuration for this manifest.
- Config string `json:"config,omitempty"`
-
- // EvaluatedConfig: ! [Output Only] The fully-expanded configuration
- // file, including any ! templates and references.
- EvaluatedConfig string `json:"evaluatedConfig,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Name: ! [Output Only] The name of the manifest.
- Name string `json:"name,omitempty"`
-
- // SelfLink: [Output Only] Self link for the manifest.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Config") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Manifest) MarshalJSON() ([]byte, error) {
- type noMethod Manifest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ManifestsListResponse: ! A response containing a partial list of
-// manifests and a page token used ! to build the next request if the
-// request has been truncated. Next available tag: 4
-type ManifestsListResponse struct {
- // Manifests: ! Manifests contained in this list response.
- Manifests []*Manifest `json:"manifests,omitempty"`
-
- // NextPageToken: ! A token used to continue a truncated list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Manifests") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ManifestsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod ManifestsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Operation: ! An operation resource, used to manage asynchronous API
-// requests. Next available tag: 24
-type Operation struct {
- // CreationTimestamp: ! [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // EndTime: ! [Output Only] The time that this operation was completed.
- // This is in ! RFC3339 format.
- EndTime string `json:"endTime,omitempty"`
-
- // Error: ! [Output Only] If errors occurred during processing of this
- // operation, ! this field will be populated.
- Error *OperationError `json:"error,omitempty"`
-
- // HttpErrorMessage: ! [Output Only] If operation fails, the HTTP error
- // message returned, ! e.g. NOT FOUND.
- HttpErrorMessage string `json:"httpErrorMessage,omitempty"`
-
- // HttpErrorStatusCode: ! [Output Only] If operation fails, the HTTP
- // error status code returned, ! e.g. 404.
- HttpErrorStatusCode int64 `json:"httpErrorStatusCode,omitempty"`
-
- // Id: ! [Output Only] Unique identifier for the resource; defined by
- // the server.
- Id uint64 `json:"id,omitempty,string"`
-
- // InsertTime: ! [Output Only] The time that this operation was
- // requested. ! This is in RFC 3339 format.
- InsertTime string `json:"insertTime,omitempty"`
-
- // Name: ! [Output Only] Name of the operation.
- Name string `json:"name,omitempty"`
-
- // OperationType: ! [Output Only] Type of the operation. Examples
- // include "insert", or ! "delete"
- OperationType string `json:"operationType,omitempty"`
-
- // Progress: ! [Output Only] An optional progress indicator that ranges
- // from 0 to 100. ! There is no requirement that this be linear or
- // support any granularity ! of operations. This should not be used to
- // guess at when the operation will ! be complete. This number should be
- // monotonically increasing as the ! operation progresses.
- Progress int64 `json:"progress,omitempty"`
-
- // SelfLink: [Output Only] Self link for the manifest.
- SelfLink string `json:"selfLink,omitempty"`
-
- // StartTime: ! [Output Only] The time that this operation was started
- // by the server. ! This is in RFC 3339 format.
- StartTime string `json:"startTime,omitempty"`
-
- // Status: ! [Output Only] Status of the operation. Can be one of the
- // following: ! "PENDING", "RUNNING", or "DONE".
- Status string `json:"status,omitempty"`
-
- // StatusMessage: ! [Output Only] An optional textual description of the
- // current status of ! the operation.
- StatusMessage string `json:"statusMessage,omitempty"`
-
- // TargetId: ! [Output Only] Unique target id which identifies a
- // particular ! incarnation of the target.
- TargetId uint64 `json:"targetId,omitempty,string"`
-
- // TargetLink: ! [Output Only] URL of the resource the operation is
- // mutating.
- TargetLink string `json:"targetLink,omitempty"`
-
- // User: ! [Output Only] User who requested the operation, for example !
- // "user@example.com"
- User string `json:"user,omitempty"`
-
- // Warnings: ! [Output Only] If warning messages generated during
- // processing of this ! operation, this field will be populated.
- Warnings []*OperationWarnings `json:"warnings,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Operation) MarshalJSON() ([]byte, error) {
- type noMethod Operation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperationError: ! [Output Only] If errors occurred during processing
-// of this operation, ! this field will be populated.
-type OperationError struct {
- // Errors: ! The array of errors encountered while processing this
- // operation.
- Errors []*OperationErrorErrors `json:"errors,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Errors") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationError) MarshalJSON() ([]byte, error) {
- type noMethod OperationError
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationErrorErrors struct {
- // Code: ! The error type identifier for this error.
- Code string `json:"code,omitempty"`
-
- // Location: ! Indicates the field in the request which caused the
- // error. ! This property is optional.
- Location string `json:"location,omitempty"`
-
- // Message: ! An optional, human-readable error message.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationErrorErrors) MarshalJSON() ([]byte, error) {
- type noMethod OperationErrorErrors
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationWarnings struct {
- // Code: ! The warning type identifier for this warning.
- Code interface{} `json:"code,omitempty"`
-
- // Data: ! Metadata for this warning in 'key: value' format.
- Data []*OperationWarningsData `json:"data,omitempty"`
-
- // Message: ! Optional human-readable details for this warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationWarnings) MarshalJSON() ([]byte, error) {
- type noMethod OperationWarnings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationWarningsData struct {
- // Key: ! A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: ! A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationWarningsData) MarshalJSON() ([]byte, error) {
- type noMethod OperationWarningsData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperationsListResponse: ! A response containing a partial list of
-// operations and a page token used ! to build the next request if the
-// request has been truncated. Next available tag: 4
-type OperationsListResponse struct {
- // NextPageToken: ! A token used to continue a truncated list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Operations: ! Operations contained in this list response.
- Operations []*Operation `json:"operations,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "NextPageToken") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod OperationsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Resource: Next available tag: 12
-type Resource struct {
- // Errors: ! [Output Only] A list of any errors that occurred during
- // deployment.
- Errors []string `json:"errors,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Intent: ! [Output Only] The intended state of the resource.
- Intent string `json:"intent,omitempty"`
-
- // Manifest: ! [Output Only] URL of the manifest representing the
- // current configuration ! of this resource.
- Manifest string `json:"manifest,omitempty"`
-
- // Name: ! [Output Only] The name of the resource as it appears in the
- // YAML config.
- Name string `json:"name,omitempty"`
-
- // State: ! [Output Only] The state of the resource.
- State string `json:"state,omitempty"`
-
- // Type: ! [Output Only] The type of the resource, for example !
- // ?compute.v1.instance?, or ?replicaPools.v1beta2.instanceGroupManager?
- Type string `json:"type,omitempty"`
-
- // Url: ! [Output Only] The URL of the actual resource.
- Url string `json:"url,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Errors") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Resource) MarshalJSON() ([]byte, error) {
- type noMethod Resource
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ResourcesListResponse: ! A response containing a partial list of
-// resources and a page token used ! to build the next request if the
-// request has been truncated. Next available tag: 4
-type ResourcesListResponse struct {
- // NextPageToken: ! A token used to continue a truncated list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Resources: ! Resources contained in this list response.
- Resources []*Resource `json:"resources,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "NextPageToken") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ResourcesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod ResourcesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Type: ! A type supported by Deployment Manager. Next available tag: 4
-type Type struct {
- // Name: ! Name of the type.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Name") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Type) MarshalJSON() ([]byte, error) {
- type noMethod Type
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TypesListResponse: ! A response that returns all Types supported by
-// Deployment Manager Next available tag: 3
-type TypesListResponse struct {
- // Types: ! Types supported by Deployment Manager
- Types []*Type `json:"types,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Types") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TypesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod TypesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "deploymentmanager.deployments.delete":
-
-type DeploymentsDeleteCall struct {
- s *Service
- project string
- deployment string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: ! Deletes a deployment and all of the resources in the
-// deployment.
-func (r *DeploymentsService) Delete(project string, deployment string) *DeploymentsDeleteCall {
- c := &DeploymentsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.deployment = deployment
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DeploymentsDeleteCall) Fields(s ...googleapi.Field) *DeploymentsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DeploymentsDeleteCall) Context(ctx context.Context) *DeploymentsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DeploymentsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments/{deployment}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "deployment": c.deployment,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.deployments.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DeploymentsDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "! Deletes a deployment and all of the resources in the deployment.",
- // "httpMethod": "DELETE",
- // "id": "deploymentmanager.deployments.delete",
- // "parameterOrder": [
- // "project",
- // "deployment"
- // ],
- // "parameters": {
- // "deployment": {
- // "description": "! The name of the deployment for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "! The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments/{deployment}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/ndev.cloudman"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.deployments.get":
-
-type DeploymentsGetCall struct {
- s *Service
- project string
- deployment string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: ! Gets information about a specific deployment.
-func (r *DeploymentsService) Get(project string, deployment string) *DeploymentsGetCall {
- c := &DeploymentsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.deployment = deployment
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DeploymentsGetCall) Fields(s ...googleapi.Field) *DeploymentsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DeploymentsGetCall) IfNoneMatch(entityTag string) *DeploymentsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DeploymentsGetCall) Context(ctx context.Context) *DeploymentsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DeploymentsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments/{deployment}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "deployment": c.deployment,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.deployments.get" call.
-// Exactly one of *Deployment or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Deployment.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DeploymentsGetCall) Do() (*Deployment, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Deployment{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "! Gets information about a specific deployment.",
- // "httpMethod": "GET",
- // "id": "deploymentmanager.deployments.get",
- // "parameterOrder": [
- // "project",
- // "deployment"
- // ],
- // "parameters": {
- // "deployment": {
- // "description": "! The name of the deployment for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "! The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments/{deployment}",
- // "response": {
- // "$ref": "Deployment"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/ndev.cloudman",
- // "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.deployments.insert":
-
-type DeploymentsInsertCall struct {
- s *Service
- project string
- deployment *Deployment
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: ! Creates a deployment and all of the resources described by
-// the ! deployment manifest.
-func (r *DeploymentsService) Insert(project string, deployment *Deployment) *DeploymentsInsertCall {
- c := &DeploymentsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.deployment = deployment
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DeploymentsInsertCall) Fields(s ...googleapi.Field) *DeploymentsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DeploymentsInsertCall) Context(ctx context.Context) *DeploymentsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DeploymentsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.deployment)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.deployments.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DeploymentsInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "! Creates a deployment and all of the resources described by the ! deployment manifest.",
- // "httpMethod": "POST",
- // "id": "deploymentmanager.deployments.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "! The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments",
- // "request": {
- // "$ref": "Deployment"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/ndev.cloudman"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.deployments.list":
-
-type DeploymentsListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: ! Lists all deployments for a given project.
-func (r *DeploymentsService) List(project string) *DeploymentsListCall {
- c := &DeploymentsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": ! Maximum count
-// of results to be returned. ! Acceptable values are 0 to 100,
-// inclusive. (Default: 50)
-func (c *DeploymentsListCall) MaxResults(maxResults int64) *DeploymentsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": ! Specifies a
-// nextPageToken returned by a previous list request. This ! token can
-// be used to request the next page of results from a previous ! list
-// request.
-func (c *DeploymentsListCall) PageToken(pageToken string) *DeploymentsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DeploymentsListCall) Fields(s ...googleapi.Field) *DeploymentsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DeploymentsListCall) IfNoneMatch(entityTag string) *DeploymentsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DeploymentsListCall) Context(ctx context.Context) *DeploymentsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DeploymentsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.deployments.list" call.
-// Exactly one of *DeploymentsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *DeploymentsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DeploymentsListCall) Do() (*DeploymentsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DeploymentsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "! Lists all deployments for a given project.",
- // "httpMethod": "GET",
- // "id": "deploymentmanager.deployments.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "maxResults": {
- // "default": "50",
- // "description": "! Maximum count of results to be returned. ! Acceptable values are 0 to 100, inclusive. (Default: 50)",
- // "format": "int32",
- // "location": "query",
- // "maximum": "100",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "! Specifies a nextPageToken returned by a previous list request. This ! token can be used to request the next page of results from a previous ! list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "! The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments",
- // "response": {
- // "$ref": "DeploymentsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/ndev.cloudman",
- // "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.manifests.get":
-
-type ManifestsGetCall struct {
- s *Service
- project string
- deployment string
- manifest string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: ! Gets information about a specific manifest.
-func (r *ManifestsService) Get(project string, deployment string, manifest string) *ManifestsGetCall {
- c := &ManifestsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.deployment = deployment
- c.manifest = manifest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManifestsGetCall) Fields(s ...googleapi.Field) *ManifestsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManifestsGetCall) IfNoneMatch(entityTag string) *ManifestsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManifestsGetCall) Context(ctx context.Context) *ManifestsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManifestsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments/{deployment}/manifests/{manifest}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "deployment": c.deployment,
- "manifest": c.manifest,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.manifests.get" call.
-// Exactly one of *Manifest or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Manifest.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ManifestsGetCall) Do() (*Manifest, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Manifest{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "! Gets information about a specific manifest.",
- // "httpMethod": "GET",
- // "id": "deploymentmanager.manifests.get",
- // "parameterOrder": [
- // "project",
- // "deployment",
- // "manifest"
- // ],
- // "parameters": {
- // "deployment": {
- // "description": "! The name of the deployment for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "manifest": {
- // "description": "! The name of the manifest for this request.",
- // "location": "path",
- // "pattern": "[-a-z0-9]{1,61}",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "! The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments/{deployment}/manifests/{manifest}",
- // "response": {
- // "$ref": "Manifest"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/ndev.cloudman",
- // "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.manifests.list":
-
-type ManifestsListCall struct {
- s *Service
- project string
- deployment string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: ! Lists all manifests for a given deployment.
-func (r *ManifestsService) List(project string, deployment string) *ManifestsListCall {
- c := &ManifestsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.deployment = deployment
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": ! Maximum count
-// of results to be returned. ! Acceptable values are 0 to 100,
-// inclusive. (Default: 50)
-func (c *ManifestsListCall) MaxResults(maxResults int64) *ManifestsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": ! Specifies a
-// nextPageToken returned by a previous list request. This ! token can
-// be used to request the next page of results from a previous ! list
-// request.
-func (c *ManifestsListCall) PageToken(pageToken string) *ManifestsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManifestsListCall) Fields(s ...googleapi.Field) *ManifestsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManifestsListCall) IfNoneMatch(entityTag string) *ManifestsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManifestsListCall) Context(ctx context.Context) *ManifestsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManifestsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments/{deployment}/manifests")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "deployment": c.deployment,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.manifests.list" call.
-// Exactly one of *ManifestsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ManifestsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManifestsListCall) Do() (*ManifestsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ManifestsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "! Lists all manifests for a given deployment.",
- // "httpMethod": "GET",
- // "id": "deploymentmanager.manifests.list",
- // "parameterOrder": [
- // "project",
- // "deployment"
- // ],
- // "parameters": {
- // "deployment": {
- // "description": "! The name of the deployment for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "50",
- // "description": "! Maximum count of results to be returned. ! Acceptable values are 0 to 100, inclusive. (Default: 50)",
- // "format": "int32",
- // "location": "query",
- // "maximum": "100",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "! Specifies a nextPageToken returned by a previous list request. This ! token can be used to request the next page of results from a previous ! list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "! The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments/{deployment}/manifests",
- // "response": {
- // "$ref": "ManifestsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/ndev.cloudman",
- // "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.operations.get":
-
-type OperationsGetCall struct {
- s *Service
- project string
- operation string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: ! Gets information about a specific Operation.
-func (r *OperationsService) Get(project string, operation string) *OperationsGetCall {
- c := &OperationsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.operation = operation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OperationsGetCall) Fields(s ...googleapi.Field) *OperationsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OperationsGetCall) Context(ctx context.Context) *OperationsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OperationsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/operations/{operation}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "operation": c.operation,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.operations.get" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *OperationsGetCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "! Gets information about a specific Operation.",
- // "httpMethod": "GET",
- // "id": "deploymentmanager.operations.get",
- // "parameterOrder": [
- // "project",
- // "operation"
- // ],
- // "parameters": {
- // "operation": {
- // "description": "! The name of the operation for this request.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "! The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/operations/{operation}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/ndev.cloudman",
- // "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.operations.list":
-
-type OperationsListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: ! Lists all Operations for a project.
-func (r *OperationsService) List(project string) *OperationsListCall {
- c := &OperationsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": ! Maximum count
-// of results to be returned. ! Acceptable values are 0 to 100,
-// inclusive. (Default: 50)
-func (c *OperationsListCall) MaxResults(maxResults int64) *OperationsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": ! Specifies a
-// nextPageToken returned by a previous list request. This ! token can
-// be used to request the next page of results from a previous ! list
-// request.
-func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OperationsListCall) Fields(s ...googleapi.Field) *OperationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OperationsListCall) IfNoneMatch(entityTag string) *OperationsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OperationsListCall) Context(ctx context.Context) *OperationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OperationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/operations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.operations.list" call.
-// Exactly one of *OperationsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *OperationsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OperationsListCall) Do() (*OperationsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OperationsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "! Lists all Operations for a project.",
- // "httpMethod": "GET",
- // "id": "deploymentmanager.operations.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "maxResults": {
- // "default": "50",
- // "description": "! Maximum count of results to be returned. ! Acceptable values are 0 to 100, inclusive. (Default: 50)",
- // "format": "int32",
- // "location": "query",
- // "maximum": "100",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "! Specifies a nextPageToken returned by a previous list request. This ! token can be used to request the next page of results from a previous ! list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "! The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/operations",
- // "response": {
- // "$ref": "OperationsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/ndev.cloudman",
- // "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.resources.get":
-
-type ResourcesGetCall struct {
- s *Service
- project string
- deployment string
- resource string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: ! Gets information about a single resource.
-func (r *ResourcesService) Get(project string, deployment string, resource string) *ResourcesGetCall {
- c := &ResourcesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.deployment = deployment
- c.resource = resource
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ResourcesGetCall) Fields(s ...googleapi.Field) *ResourcesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ResourcesGetCall) IfNoneMatch(entityTag string) *ResourcesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ResourcesGetCall) Context(ctx context.Context) *ResourcesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ResourcesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments/{deployment}/resources/{resource}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "deployment": c.deployment,
- "resource": c.resource,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.resources.get" call.
-// Exactly one of *Resource or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Resource.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ResourcesGetCall) Do() (*Resource, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Resource{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "! Gets information about a single resource.",
- // "httpMethod": "GET",
- // "id": "deploymentmanager.resources.get",
- // "parameterOrder": [
- // "project",
- // "deployment",
- // "resource"
- // ],
- // "parameters": {
- // "deployment": {
- // "description": "! The name of the deployment for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "! The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "resource": {
- // "description": "! The name of the resource for this request.",
- // "location": "path",
- // "pattern": "[-a-z0-9]{1,61}",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments/{deployment}/resources/{resource}",
- // "response": {
- // "$ref": "Resource"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/ndev.cloudman",
- // "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.resources.list":
-
-type ResourcesListCall struct {
- s *Service
- project string
- deployment string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: ! Lists all resources in a given deployment.
-func (r *ResourcesService) List(project string, deployment string) *ResourcesListCall {
- c := &ResourcesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.deployment = deployment
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": ! Maximum count
-// of results to be returned. ! Acceptable values are 0 to 100,
-// inclusive. (Default: 50)
-func (c *ResourcesListCall) MaxResults(maxResults int64) *ResourcesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": ! Specifies a
-// nextPageToken returned by a previous list request. This ! token can
-// be used to request the next page of results from a previous ! list
-// request.
-func (c *ResourcesListCall) PageToken(pageToken string) *ResourcesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ResourcesListCall) Fields(s ...googleapi.Field) *ResourcesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ResourcesListCall) IfNoneMatch(entityTag string) *ResourcesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ResourcesListCall) Context(ctx context.Context) *ResourcesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ResourcesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments/{deployment}/resources")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "deployment": c.deployment,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.resources.list" call.
-// Exactly one of *ResourcesListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ResourcesListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ResourcesListCall) Do() (*ResourcesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ResourcesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "! Lists all resources in a given deployment.",
- // "httpMethod": "GET",
- // "id": "deploymentmanager.resources.list",
- // "parameterOrder": [
- // "project",
- // "deployment"
- // ],
- // "parameters": {
- // "deployment": {
- // "description": "! The name of the deployment for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "50",
- // "description": "! Maximum count of results to be returned. ! Acceptable values are 0 to 100, inclusive. (Default: 50)",
- // "format": "int32",
- // "location": "query",
- // "maximum": "100",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "! Specifies a nextPageToken returned by a previous list request. This ! token can be used to request the next page of results from a previous ! list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "! The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments/{deployment}/resources",
- // "response": {
- // "$ref": "ResourcesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/ndev.cloudman",
- // "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.types.list":
-
-type TypesListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: ! Lists all Types for Deployment Manager.
-func (r *TypesService) List(project string) *TypesListCall {
- c := &TypesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": ! Maximum count
-// of results to be returned. ! Acceptable values are 0 to 100,
-// inclusive. (Default: 50)
-func (c *TypesListCall) MaxResults(maxResults int64) *TypesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": ! Specifies a
-// nextPageToken returned by a previous list request. This ! token can
-// be used to request the next page of results from a previous ! list
-// request.
-func (c *TypesListCall) PageToken(pageToken string) *TypesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TypesListCall) Fields(s ...googleapi.Field) *TypesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TypesListCall) IfNoneMatch(entityTag string) *TypesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TypesListCall) Context(ctx context.Context) *TypesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TypesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/types")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.types.list" call.
-// Exactly one of *TypesListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *TypesListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TypesListCall) Do() (*TypesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TypesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "! Lists all Types for Deployment Manager.",
- // "httpMethod": "GET",
- // "id": "deploymentmanager.types.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "maxResults": {
- // "default": "50",
- // "description": "! Maximum count of results to be returned. ! Acceptable values are 0 to 100, inclusive. (Default: 50)",
- // "format": "int32",
- // "location": "query",
- // "maximum": "100",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "! Specifies a nextPageToken returned by a previous list request. This ! token can be used to request the next page of results from a previous ! list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "! The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/types",
- // "response": {
- // "$ref": "TypesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/ndev.cloudman",
- // "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/deploymentmanager/v2beta2/deploymentmanager-api.json b/vendor/google.golang.org/api/deploymentmanager/v2beta2/deploymentmanager-api.json
deleted file mode 100644
index 21724519..00000000
--- a/vendor/google.golang.org/api/deploymentmanager/v2beta2/deploymentmanager-api.json
+++ /dev/null
@@ -1,1225 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/L3qYQaCmypSCqWoWq866HN97aNc\"",
- "discoveryVersion": "v1",
- "id": "deploymentmanager:v2beta2",
- "name": "deploymentmanager",
- "canonicalName": "Deployment Manager",
- "version": "v2beta2",
- "revision": "20150831",
- "title": "Google Cloud Deployment Manager API",
- "description": "The Deployment Manager API allows users to declaratively configure, deploy and run complex solutions on the Google Cloud Platform.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/deployment-manager/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/deploymentmanager/v2beta2/projects/",
- "basePath": "/deploymentmanager/v2beta2/projects/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "deploymentmanager/v2beta2/projects/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/ndev.cloudman": {
- "description": "View and manage your Google Cloud Platform management resources and deployment status information"
- },
- "https://www.googleapis.com/auth/ndev.cloudman.readonly": {
- "description": "View your Google Cloud Platform management resources and deployment status information"
- }
- }
- }
- },
- "schemas": {
- "Deployment": {
- "id": "Deployment",
- "type": "object",
- "description": "",
- "properties": {
- "description": {
- "type": "string",
- "description": "An optional user-provided description of the deployment."
- },
- "fingerprint": {
- "type": "string",
- "description": "Specifies a fingerprint for update() requests. A fingerprint is a randomly generated value that must be provided in update() requests to perform optimistic locking. This ensures optimistic concurrency so that only one update can be performed at a time. The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.",
- "format": "byte"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "insertTime": {
- "type": "string",
- "description": "[Output Only] Timestamp when the deployment was created, in RFC3339 text format ."
- },
- "intent": {
- "type": "string",
- "description": "[Input Only] Specifies how Deployment Manager should apply this template. Possible options are PREVIEW, UPDATE, and CANCEL.\n\nPREVIEW creates a deployment and creates \"shell\" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. You can use this intent to preview updates to deployments or preview new deployments. You must provide a target.config with a configuration for this intent. After previewing a deployment, you can deploy your resources by making a request with the UPDATE intent or you can CANCEL the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.\n\nUPDATE performs an update to the underlying resources in a deployment. If you provide a populated target.config field with this request, Deployment Manager uses that configuration to perform an update. If you had previewed this update beforehand, and do not supply a target.config or provide an empty target.config, Deployment Manager uses the last previewed configuration.\n\nCANCEL cancels an update that is in PREVIEW or UPDATE but does not undo any changes already made."
- },
- "manifest": {
- "type": "string",
- "description": "[Output Only] URL of the manifest representing the last manifest that was successfully deployed."
- },
- "name": {
- "type": "string",
- "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash."
- },
- "state": {
- "type": "string",
- "description": "[Output Only] The current state of the deployment. This can be DEPLOYED, DEPLOYMENT_FAILED, PREVIEWING, UPDATING, and CANCELING."
- },
- "target": {
- "$ref": "TargetConfiguration",
- "description": "[Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates."
- },
- "update": {
- "$ref": "DeploymentUpdate",
- "description": "[Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here."
- },
- "updateTime": {
- "type": "string",
- "description": "[Output Only] Timestamp when the deployment was updated, in RFC3339 text format ."
- }
- }
- },
- "DeploymentUpdate": {
- "id": "DeploymentUpdate",
- "type": "object",
- "description": "",
- "properties": {
- "errors": {
- "type": "array",
- "description": "[Output Only] List of all errors encountered while trying to enact the update.",
- "items": {
- "type": "string"
- }
- },
- "manifest": {
- "type": "string",
- "description": "[Output Only] URL of the manifest representing the update configuration of this deployment."
- }
- }
- },
- "DeploymentsListResponse": {
- "id": "DeploymentsListResponse",
- "type": "object",
- "description": "A response containing a partial list of deployments and a page token used to build the next request if the request has been truncated.",
- "properties": {
- "deployments": {
- "type": "array",
- "description": "[Output Only] The deployments contained in this response.",
- "items": {
- "$ref": "Deployment"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- }
- }
- },
- "ImportFile": {
- "id": "ImportFile",
- "type": "object",
- "description": "",
- "properties": {
- "content": {
- "type": "string",
- "description": "The contents of the file."
- },
- "name": {
- "type": "string",
- "description": "The name of the file."
- }
- }
- },
- "Manifest": {
- "id": "Manifest",
- "type": "object",
- "description": "",
- "properties": {
- "config": {
- "type": "string",
- "description": "[Output Only] The YAML configuration for this manifest."
- },
- "evaluatedConfig": {
- "type": "string",
- "description": "[Output Only] The fully-expanded configuration file, including any templates and references."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "imports": {
- "type": "array",
- "description": "[Output Only] The imported files for this manifest.",
- "items": {
- "$ref": "ImportFile"
- }
- },
- "insertTime": {
- "type": "string",
- "description": "[Output Only] Timestamp when the manifest was created, in RFC3339 text format."
- },
- "layout": {
- "type": "string",
- "description": "[Output Only] The YAML layout for this manifest."
- },
- "name": {
- "type": "string",
- "description": "[Output Only] The name of the manifest."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Self link for the manifest."
- }
- }
- },
- "ManifestsListResponse": {
- "id": "ManifestsListResponse",
- "type": "object",
- "description": "A response containing a partial list of manifests and a page token used to build the next request if the request has been truncated.",
- "properties": {
- "manifests": {
- "type": "array",
- "description": "[Output Only] Manifests contained in this list response.",
- "items": {
- "$ref": "Manifest"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- }
- }
- },
- "Operation": {
- "id": "Operation",
- "type": "object",
- "description": "An Operation resource, used to manage asynchronous API requests.",
- "properties": {
- "clientOperationId": {
- "type": "string",
- "description": "[Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "endTime": {
- "type": "string",
- "description": "[Output Only] The time that this operation was completed. This is in RFC3339 text format."
- },
- "error": {
- "type": "object",
- "description": "[Output Only] If errors are generated during processing of the operation, this field will be populated.",
- "properties": {
- "errors": {
- "type": "array",
- "description": "[Output Only] The array of errors encountered while processing this operation.",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The error type identifier for this error."
- },
- "location": {
- "type": "string",
- "description": "[Output Only] Indicates the field in the request which caused the error. This property is optional."
- },
- "message": {
- "type": "string",
- "description": "[Output Only] An optional, human-readable error message."
- }
- }
- }
- }
- }
- },
- "httpErrorMessage": {
- "type": "string",
- "description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND."
- },
- "httpErrorStatusCode": {
- "type": "integer",
- "description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.",
- "format": "int32"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "insertTime": {
- "type": "string",
- "description": "[Output Only] The time that this operation was requested. This is in RFC3339 text format."
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#Operation for Operation resources.",
- "default": "deploymentmanager#operation"
- },
- "name": {
- "type": "string",
- "description": "[Output Only] Name of the resource."
- },
- "operationType": {
- "type": "string",
- "description": "[Output Only] Type of the operation, such as insert, update, and delete."
- },
- "progress": {
- "type": "integer",
- "description": "[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.",
- "format": "int32"
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the operation resides. Only applicable for regional resources."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "startTime": {
- "type": "string",
- "description": "[Output Only] The time that this operation was started by the server. This is in RFC3339 text format."
- },
- "status": {
- "type": "string",
- "description": "[Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE."
- },
- "statusMessage": {
- "type": "string",
- "description": "[Output Only] An optional textual description of the current status of the operation."
- },
- "targetId": {
- "type": "string",
- "description": "[Output Only] Unique target ID which identifies a particular incarnation of the target.",
- "format": "uint64"
- },
- "targetLink": {
- "type": "string",
- "description": "[Output Only] URL of the resource the operation is mutating."
- },
- "user": {
- "type": "string",
- "description": "[Output Only] User who requested the operation, for example: user@example.com."
- },
- "warnings": {
- "type": "array",
- "description": "[Output Only] If warning messages are generated during processing of the operation, this field will be populated.",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "description": "[Output Only] The warning type identifier for this warning."
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata for this warning in key: value format.",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key for the warning data."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] Optional human-readable details for this warning."
- }
- }
- }
- },
- "zone": {
- "type": "string",
- "description": "[Output Only] URL of the zone where the operation resides."
- }
- }
- },
- "OperationsListResponse": {
- "id": "OperationsListResponse",
- "type": "object",
- "description": "A response containing a partial list of operations and a page token used to build the next request if the request has been truncated.",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] A token used to continue a truncated list request."
- },
- "operations": {
- "type": "array",
- "description": "[Output Only] Operations contained in this list response.",
- "items": {
- "$ref": "Operation"
- }
- }
- }
- },
- "Resource": {
- "id": "Resource",
- "type": "object",
- "description": "",
- "properties": {
- "finalProperties": {
- "type": "string",
- "description": "[Output Only] The evaluated properties of the resource with references expanded. Returned as serialized YAML."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "insertTime": {
- "type": "string",
- "description": "[Output Only] Timestamp when the resource was created or acquired, in RFC3339 text format ."
- },
- "manifest": {
- "type": "string",
- "description": "[Output Only] URL of the manifest representing the current configuration of this resource."
- },
- "name": {
- "type": "string",
- "description": "[Output Only] The name of the resource as it appears in the YAML config."
- },
- "properties": {
- "type": "string",
- "description": "[Output Only] The current properties of the resource before any references have been filled in. Returned as serialized YAML."
- },
- "type": {
- "type": "string",
- "description": "[Output Only] The type of the resource, for example compute.v1.instance, or replicaPools.v1beta2.instanceGroupManager."
- },
- "update": {
- "$ref": "ResourceUpdate",
- "description": "[Output Only] If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here."
- },
- "updateTime": {
- "type": "string",
- "description": "[Output Only] Timestamp when the resource was updated, in RFC3339 text format ."
- },
- "url": {
- "type": "string",
- "description": "[Output Only] The URL of the actual resource."
- }
- }
- },
- "ResourceUpdate": {
- "id": "ResourceUpdate",
- "type": "object",
- "description": "",
- "properties": {
- "errors": {
- "type": "array",
- "description": "[Output Only] List of all errors encountered while trying to enact update.intent.",
- "items": {
- "type": "string"
- }
- },
- "finalProperties": {
- "type": "string",
- "description": "[Output Only] The expanded properties of the resource with reference values expanded. Returned as serialized YAML."
- },
- "intent": {
- "type": "string",
- "description": "[Output Only] The intent of the resource: PREVIEW, UPDATE, or CANCEL."
- },
- "manifest": {
- "type": "string",
- "description": "[Output Only] URL of the manifest representing the update configuration of this resource."
- },
- "properties": {
- "type": "string",
- "description": "[Output Only] The set of updated properties for this resource, before references are expanded. Returned as serialized YAML."
- },
- "state": {
- "type": "string",
- "description": "[Output Only] The state of the resource."
- }
- }
- },
- "ResourcesListResponse": {
- "id": "ResourcesListResponse",
- "type": "object",
- "description": "A response containing a partial list of resources and a page token used to build the next request if the request has been truncated.",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "A token used to continue a truncated list request."
- },
- "resources": {
- "type": "array",
- "description": "Resources contained in this list response.",
- "items": {
- "$ref": "Resource"
- }
- }
- }
- },
- "TargetConfiguration": {
- "id": "TargetConfiguration",
- "type": "object",
- "description": "",
- "properties": {
- "config": {
- "type": "string",
- "description": "The configuration to use for this deployment."
- },
- "imports": {
- "type": "array",
- "description": "Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.",
- "items": {
- "$ref": "ImportFile"
- }
- }
- }
- },
- "Type": {
- "id": "Type",
- "type": "object",
- "description": "A resource type supported by Deployment Manager.",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "format": "uint64"
- },
- "insertTime": {
- "type": "string",
- "description": "[Output Only] Timestamp when the type was created, in RFC3339 text format."
- },
- "name": {
- "type": "string",
- "description": "Name of the type."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Self link for the type."
- }
- }
- },
- "TypesListResponse": {
- "id": "TypesListResponse",
- "type": "object",
- "description": "A response that returns all Types supported by Deployment Manager",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "A token used to continue a truncated list request."
- },
- "types": {
- "type": "array",
- "description": "[Output Only] A list of resource types supported by Deployment Manager.",
- "items": {
- "$ref": "Type"
- }
- }
- }
- }
- },
- "resources": {
- "deployments": {
- "methods": {
- "delete": {
- "id": "deploymentmanager.deployments.delete",
- "path": "{project}/global/deployments/{deployment}",
- "httpMethod": "DELETE",
- "description": "Deletes a deployment and all of the resources in the deployment.",
- "parameters": {
- "deployment": {
- "type": "string",
- "description": "The name of the deployment for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "deployment"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/ndev.cloudman"
- ]
- },
- "get": {
- "id": "deploymentmanager.deployments.get",
- "path": "{project}/global/deployments/{deployment}",
- "httpMethod": "GET",
- "description": "Gets information about a specific deployment.",
- "parameters": {
- "deployment": {
- "type": "string",
- "description": "The name of the deployment for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "deployment"
- ],
- "response": {
- "$ref": "Deployment"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/ndev.cloudman",
- "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- ]
- },
- "insert": {
- "id": "deploymentmanager.deployments.insert",
- "path": "{project}/global/deployments",
- "httpMethod": "POST",
- "description": "Creates a deployment and all of the resources described by the deployment manifest.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "Deployment"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/ndev.cloudman"
- ]
- },
- "list": {
- "id": "deploymentmanager.deployments.list",
- "path": "{project}/global/deployments",
- "httpMethod": "GET",
- "description": "Lists all deployments for a given project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "DeploymentsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/ndev.cloudman",
- "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- ]
- },
- "patch": {
- "id": "deploymentmanager.deployments.patch",
- "path": "{project}/global/deployments/{deployment}",
- "httpMethod": "PATCH",
- "description": "Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics.",
- "parameters": {
- "createPolicy": {
- "type": "string",
- "description": "Sets the policy to use for creating new resources.",
- "default": "CREATE_OR_ACQUIRE",
- "enum": [
- "ACQUIRE",
- "CREATE_OR_ACQUIRE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "deletePolicy": {
- "type": "string",
- "description": "Sets the policy to use for deleting resources.",
- "default": "DELETE",
- "enum": [
- "ABANDON",
- "DELETE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "deployment": {
- "type": "string",
- "description": "The name of the deployment for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "updatePolicy": {
- "type": "string",
- "description": "Sets the policy to use for updating resources.",
- "default": "PATCH",
- "enum": [
- "PATCH",
- "UPDATE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "project",
- "deployment"
- ],
- "request": {
- "$ref": "Deployment"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/ndev.cloudman"
- ]
- },
- "update": {
- "id": "deploymentmanager.deployments.update",
- "path": "{project}/global/deployments/{deployment}",
- "httpMethod": "PUT",
- "description": "Updates a deployment and all of the resources described by the deployment manifest.",
- "parameters": {
- "createPolicy": {
- "type": "string",
- "description": "Sets the policy to use for creating new resources.",
- "default": "CREATE_OR_ACQUIRE",
- "enum": [
- "ACQUIRE",
- "CREATE_OR_ACQUIRE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "deletePolicy": {
- "type": "string",
- "description": "Sets the policy to use for deleting resources.",
- "default": "DELETE",
- "enum": [
- "ABANDON",
- "DELETE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "deployment": {
- "type": "string",
- "description": "The name of the deployment for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "updatePolicy": {
- "type": "string",
- "description": "Sets the policy to use for updating resources.",
- "default": "PATCH",
- "enum": [
- "PATCH",
- "UPDATE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "project",
- "deployment"
- ],
- "request": {
- "$ref": "Deployment"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/ndev.cloudman"
- ]
- }
- }
- },
- "manifests": {
- "methods": {
- "get": {
- "id": "deploymentmanager.manifests.get",
- "path": "{project}/global/deployments/{deployment}/manifests/{manifest}",
- "httpMethod": "GET",
- "description": "Gets information about a specific manifest.",
- "parameters": {
- "deployment": {
- "type": "string",
- "description": "The name of the deployment for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "manifest": {
- "type": "string",
- "description": "The name of the manifest for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "deployment",
- "manifest"
- ],
- "response": {
- "$ref": "Manifest"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/ndev.cloudman",
- "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- ]
- },
- "list": {
- "id": "deploymentmanager.manifests.list",
- "path": "{project}/global/deployments/{deployment}/manifests",
- "httpMethod": "GET",
- "description": "Lists all manifests for a given deployment.",
- "parameters": {
- "deployment": {
- "type": "string",
- "description": "The name of the deployment for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "deployment"
- ],
- "response": {
- "$ref": "ManifestsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/ndev.cloudman",
- "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- ]
- }
- }
- },
- "operations": {
- "methods": {
- "get": {
- "id": "deploymentmanager.operations.get",
- "path": "{project}/global/operations/{operation}",
- "httpMethod": "GET",
- "description": "Gets information about a specific operation.",
- "parameters": {
- "operation": {
- "type": "string",
- "description": "The name of the operation for this request.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "operation"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/ndev.cloudman",
- "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- ]
- },
- "list": {
- "id": "deploymentmanager.operations.list",
- "path": "{project}/global/operations",
- "httpMethod": "GET",
- "description": "Lists all operations for a project.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "OperationsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/ndev.cloudman",
- "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- ]
- }
- }
- },
- "resources": {
- "methods": {
- "get": {
- "id": "deploymentmanager.resources.get",
- "path": "{project}/global/deployments/{deployment}/resources/{resource}",
- "httpMethod": "GET",
- "description": "Gets information about a single resource.",
- "parameters": {
- "deployment": {
- "type": "string",
- "description": "The name of the deployment for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "resource": {
- "type": "string",
- "description": "The name of the resource for this request.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "deployment",
- "resource"
- ],
- "response": {
- "$ref": "Resource"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/ndev.cloudman",
- "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- ]
- },
- "list": {
- "id": "deploymentmanager.resources.list",
- "path": "{project}/global/deployments/{deployment}/resources",
- "httpMethod": "GET",
- "description": "Lists all resources in a given deployment.",
- "parameters": {
- "deployment": {
- "type": "string",
- "description": "The name of the deployment for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "deployment"
- ],
- "response": {
- "$ref": "ResourcesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/ndev.cloudman",
- "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- ]
- }
- }
- },
- "types": {
- "methods": {
- "list": {
- "id": "deploymentmanager.types.list",
- "path": "{project}/global/types",
- "httpMethod": "GET",
- "description": "Lists all resource types for Deployment Manager.",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum count of results to be returned.",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "maximum": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "The project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "TypesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/ndev.cloudman",
- "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/deploymentmanager/v2beta2/deploymentmanager-gen.go b/vendor/google.golang.org/api/deploymentmanager/v2beta2/deploymentmanager-gen.go
deleted file mode 100644
index 5f50fcf1..00000000
--- a/vendor/google.golang.org/api/deploymentmanager/v2beta2/deploymentmanager-gen.go
+++ /dev/null
@@ -1,3119 +0,0 @@
-// Package deploymentmanager provides access to the Google Cloud Deployment Manager API.
-//
-// See https://developers.google.com/deployment-manager/
-//
-// Usage example:
-//
-// import "google.golang.org/api/deploymentmanager/v2beta2"
-// ...
-// deploymentmanagerService, err := deploymentmanager.New(oauthHttpClient)
-package deploymentmanager // import "google.golang.org/api/deploymentmanager/v2beta2"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "deploymentmanager:v2beta2"
-const apiName = "deploymentmanager"
-const apiVersion = "v2beta2"
-const basePath = "https://www.googleapis.com/deploymentmanager/v2beta2/projects/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage your data across Google Cloud Platform services
- CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
-
- // View your data across Google Cloud Platform services
- CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"
-
- // View and manage your Google Cloud Platform management resources and
- // deployment status information
- NdevCloudmanScope = "https://www.googleapis.com/auth/ndev.cloudman"
-
- // View your Google Cloud Platform management resources and deployment
- // status information
- NdevCloudmanReadonlyScope = "https://www.googleapis.com/auth/ndev.cloudman.readonly"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.Deployments = NewDeploymentsService(s)
- s.Manifests = NewManifestsService(s)
- s.Operations = NewOperationsService(s)
- s.Resources = NewResourcesService(s)
- s.Types = NewTypesService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- Deployments *DeploymentsService
-
- Manifests *ManifestsService
-
- Operations *OperationsService
-
- Resources *ResourcesService
-
- Types *TypesService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewDeploymentsService(s *Service) *DeploymentsService {
- rs := &DeploymentsService{s: s}
- return rs
-}
-
-type DeploymentsService struct {
- s *Service
-}
-
-func NewManifestsService(s *Service) *ManifestsService {
- rs := &ManifestsService{s: s}
- return rs
-}
-
-type ManifestsService struct {
- s *Service
-}
-
-func NewOperationsService(s *Service) *OperationsService {
- rs := &OperationsService{s: s}
- return rs
-}
-
-type OperationsService struct {
- s *Service
-}
-
-func NewResourcesService(s *Service) *ResourcesService {
- rs := &ResourcesService{s: s}
- return rs
-}
-
-type ResourcesService struct {
- s *Service
-}
-
-func NewTypesService(s *Service) *TypesService {
- rs := &TypesService{s: s}
- return rs
-}
-
-type TypesService struct {
- s *Service
-}
-
-type Deployment struct {
- // Description: An optional user-provided description of the deployment.
- Description string `json:"description,omitempty"`
-
- // Fingerprint: Specifies a fingerprint for update() requests. A
- // fingerprint is a randomly generated value that must be provided in
- // update() requests to perform optimistic locking. This ensures
- // optimistic concurrency so that only one update can be performed at a
- // time. The fingerprint is initially generated by Deployment Manager
- // and changes after every request to modify data. To get the latest
- // fingerprint value, perform a get() request to a deployment.
- Fingerprint string `json:"fingerprint,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // InsertTime: [Output Only] Timestamp when the deployment was created,
- // in RFC3339 text format .
- InsertTime string `json:"insertTime,omitempty"`
-
- // Intent: [Input Only] Specifies how Deployment Manager should apply
- // this template. Possible options are PREVIEW, UPDATE, and
- // CANCEL.
- //
- // PREVIEW creates a deployment and creates "shell" resources but does
- // not actually instantiate these resources. This allows you to preview
- // what your deployment looks like. You can use this intent to preview
- // updates to deployments or preview new deployments. You must provide a
- // target.config with a configuration for this intent. After previewing
- // a deployment, you can deploy your resources by making a request with
- // the UPDATE intent or you can CANCEL the preview altogether. Note that
- // the deployment will still exist after you cancel the preview and you
- // must separately delete this deployment if you want to remove
- // it.
- //
- // UPDATE performs an update to the underlying resources in a
- // deployment. If you provide a populated target.config field with this
- // request, Deployment Manager uses that configuration to perform an
- // update. If you had previewed this update beforehand, and do not
- // supply a target.config or provide an empty target.config, Deployment
- // Manager uses the last previewed configuration.
- //
- // CANCEL cancels an update that is in PREVIEW or UPDATE but does not
- // undo any changes already made.
- Intent string `json:"intent,omitempty"`
-
- // Manifest: [Output Only] URL of the manifest representing the last
- // manifest that was successfully deployed.
- Manifest string `json:"manifest,omitempty"`
-
- // Name: Name of the resource; provided by the client when the resource
- // is created. The name must be 1-63 characters long, and comply with
- // RFC1035. Specifically, the name must be 1-63 characters long and
- // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
- // the first character must be a lowercase letter, and all following
- // characters must be a dash, lowercase letter, or digit, except the
- // last character, which cannot be a dash.
- Name string `json:"name,omitempty"`
-
- // State: [Output Only] The current state of the deployment. This can be
- // DEPLOYED, DEPLOYMENT_FAILED, PREVIEWING, UPDATING, and CANCELING.
- State string `json:"state,omitempty"`
-
- // Target: [Input Only] The parameters that define your deployment,
- // including the deployment configuration and relevant templates.
- Target *TargetConfiguration `json:"target,omitempty"`
-
- // Update: [Output Only] If Deployment Manager is currently updating or
- // previewing an update to this deployment, the updated configuration
- // appears here.
- Update *DeploymentUpdate `json:"update,omitempty"`
-
- // UpdateTime: [Output Only] Timestamp when the deployment was updated,
- // in RFC3339 text format .
- UpdateTime string `json:"updateTime,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Description") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Deployment) MarshalJSON() ([]byte, error) {
- type noMethod Deployment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type DeploymentUpdate struct {
- // Errors: [Output Only] List of all errors encountered while trying to
- // enact the update.
- Errors []string `json:"errors,omitempty"`
-
- // Manifest: [Output Only] URL of the manifest representing the update
- // configuration of this deployment.
- Manifest string `json:"manifest,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Errors") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DeploymentUpdate) MarshalJSON() ([]byte, error) {
- type noMethod DeploymentUpdate
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DeploymentsListResponse: A response containing a partial list of
-// deployments and a page token used to build the next request if the
-// request has been truncated.
-type DeploymentsListResponse struct {
- // Deployments: [Output Only] The deployments contained in this
- // response.
- Deployments []*Deployment `json:"deployments,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Deployments") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DeploymentsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod DeploymentsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ImportFile struct {
- // Content: The contents of the file.
- Content string `json:"content,omitempty"`
-
- // Name: The name of the file.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Content") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ImportFile) MarshalJSON() ([]byte, error) {
- type noMethod ImportFile
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Manifest struct {
- // Config: [Output Only] The YAML configuration for this manifest.
- Config string `json:"config,omitempty"`
-
- // EvaluatedConfig: [Output Only] The fully-expanded configuration file,
- // including any templates and references.
- EvaluatedConfig string `json:"evaluatedConfig,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // Imports: [Output Only] The imported files for this manifest.
- Imports []*ImportFile `json:"imports,omitempty"`
-
- // InsertTime: [Output Only] Timestamp when the manifest was created, in
- // RFC3339 text format.
- InsertTime string `json:"insertTime,omitempty"`
-
- // Layout: [Output Only] The YAML layout for this manifest.
- Layout string `json:"layout,omitempty"`
-
- // Name: [Output Only] The name of the manifest.
- Name string `json:"name,omitempty"`
-
- // SelfLink: [Output Only] Self link for the manifest.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Config") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Manifest) MarshalJSON() ([]byte, error) {
- type noMethod Manifest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ManifestsListResponse: A response containing a partial list of
-// manifests and a page token used to build the next request if the
-// request has been truncated.
-type ManifestsListResponse struct {
- // Manifests: [Output Only] Manifests contained in this list response.
- Manifests []*Manifest `json:"manifests,omitempty"`
-
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Manifests") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ManifestsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod ManifestsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Operation: An Operation resource, used to manage asynchronous API
-// requests.
-type Operation struct {
- // ClientOperationId: [Output Only] An optional identifier specified by
- // the client when the mutation was initiated. Must be unique for all
- // Operation resources in the project.
- ClientOperationId string `json:"clientOperationId,omitempty"`
-
- // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
- // format.
- CreationTimestamp string `json:"creationTimestamp,omitempty"`
-
- // EndTime: [Output Only] The time that this operation was completed.
- // This is in RFC3339 text format.
- EndTime string `json:"endTime,omitempty"`
-
- // Error: [Output Only] If errors are generated during processing of the
- // operation, this field will be populated.
- Error *OperationError `json:"error,omitempty"`
-
- // HttpErrorMessage: [Output Only] If the operation fails, this field
- // contains the HTTP error message that was returned, such as NOT FOUND.
- HttpErrorMessage string `json:"httpErrorMessage,omitempty"`
-
- // HttpErrorStatusCode: [Output Only] If the operation fails, this field
- // contains the HTTP error message that was returned, such as 404.
- HttpErrorStatusCode int64 `json:"httpErrorStatusCode,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // InsertTime: [Output Only] The time that this operation was requested.
- // This is in RFC3339 text format.
- InsertTime string `json:"insertTime,omitempty"`
-
- // Kind: [Output Only] Type of the resource. Always compute#Operation
- // for Operation resources.
- Kind string `json:"kind,omitempty"`
-
- // Name: [Output Only] Name of the resource.
- Name string `json:"name,omitempty"`
-
- // OperationType: [Output Only] Type of the operation, such as insert,
- // update, and delete.
- OperationType string `json:"operationType,omitempty"`
-
- // Progress: [Output Only] An optional progress indicator that ranges
- // from 0 to 100. There is no requirement that this be linear or support
- // any granularity of operations. This should not be used to guess at
- // when the operation will be complete. This number should monotonically
- // increase as the operation progresses.
- Progress int64 `json:"progress,omitempty"`
-
- // Region: [Output Only] URL of the region where the operation resides.
- // Only applicable for regional resources.
- Region string `json:"region,omitempty"`
-
- // SelfLink: [Output Only] Server-defined URL for the resource.
- SelfLink string `json:"selfLink,omitempty"`
-
- // StartTime: [Output Only] The time that this operation was started by
- // the server. This is in RFC3339 text format.
- StartTime string `json:"startTime,omitempty"`
-
- // Status: [Output Only] Status of the operation. Can be one of the
- // following: PENDING, RUNNING, or DONE.
- Status string `json:"status,omitempty"`
-
- // StatusMessage: [Output Only] An optional textual description of the
- // current status of the operation.
- StatusMessage string `json:"statusMessage,omitempty"`
-
- // TargetId: [Output Only] Unique target ID which identifies a
- // particular incarnation of the target.
- TargetId uint64 `json:"targetId,omitempty,string"`
-
- // TargetLink: [Output Only] URL of the resource the operation is
- // mutating.
- TargetLink string `json:"targetLink,omitempty"`
-
- // User: [Output Only] User who requested the operation, for example:
- // user@example.com.
- User string `json:"user,omitempty"`
-
- // Warnings: [Output Only] If warning messages are generated during
- // processing of the operation, this field will be populated.
- Warnings []*OperationWarnings `json:"warnings,omitempty"`
-
- // Zone: [Output Only] URL of the zone where the operation resides.
- Zone string `json:"zone,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ClientOperationId")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Operation) MarshalJSON() ([]byte, error) {
- type noMethod Operation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperationError: [Output Only] If errors are generated during
-// processing of the operation, this field will be populated.
-type OperationError struct {
- // Errors: [Output Only] The array of errors encountered while
- // processing this operation.
- Errors []*OperationErrorErrors `json:"errors,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Errors") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationError) MarshalJSON() ([]byte, error) {
- type noMethod OperationError
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationErrorErrors struct {
- // Code: [Output Only] The error type identifier for this error.
- Code string `json:"code,omitempty"`
-
- // Location: [Output Only] Indicates the field in the request which
- // caused the error. This property is optional.
- Location string `json:"location,omitempty"`
-
- // Message: [Output Only] An optional, human-readable error message.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationErrorErrors) MarshalJSON() ([]byte, error) {
- type noMethod OperationErrorErrors
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationWarnings struct {
- // Code: [Output Only] The warning type identifier for this warning.
- Code string `json:"code,omitempty"`
-
- // Data: [Output Only] Metadata for this warning in key: value format.
- Data []*OperationWarningsData `json:"data,omitempty"`
-
- // Message: [Output Only] Optional human-readable details for this
- // warning.
- Message string `json:"message,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationWarnings) MarshalJSON() ([]byte, error) {
- type noMethod OperationWarnings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type OperationWarningsData struct {
- // Key: [Output Only] A key for the warning data.
- Key string `json:"key,omitempty"`
-
- // Value: [Output Only] A warning data value corresponding to the key.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationWarningsData) MarshalJSON() ([]byte, error) {
- type noMethod OperationWarningsData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperationsListResponse: A response containing a partial list of
-// operations and a page token used to build the next request if the
-// request has been truncated.
-type OperationsListResponse struct {
- // NextPageToken: [Output Only] A token used to continue a truncated
- // list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Operations: [Output Only] Operations contained in this list response.
- Operations []*Operation `json:"operations,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "NextPageToken") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperationsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod OperationsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type Resource struct {
- // FinalProperties: [Output Only] The evaluated properties of the
- // resource with references expanded. Returned as serialized YAML.
- FinalProperties string `json:"finalProperties,omitempty"`
-
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // InsertTime: [Output Only] Timestamp when the resource was created or
- // acquired, in RFC3339 text format .
- InsertTime string `json:"insertTime,omitempty"`
-
- // Manifest: [Output Only] URL of the manifest representing the current
- // configuration of this resource.
- Manifest string `json:"manifest,omitempty"`
-
- // Name: [Output Only] The name of the resource as it appears in the
- // YAML config.
- Name string `json:"name,omitempty"`
-
- // Properties: [Output Only] The current properties of the resource
- // before any references have been filled in. Returned as serialized
- // YAML.
- Properties string `json:"properties,omitempty"`
-
- // Type: [Output Only] The type of the resource, for example
- // compute.v1.instance, or replicaPools.v1beta2.instanceGroupManager.
- Type string `json:"type,omitempty"`
-
- // Update: [Output Only] If Deployment Manager is currently updating or
- // previewing an update to this resource, the updated configuration
- // appears here.
- Update *ResourceUpdate `json:"update,omitempty"`
-
- // UpdateTime: [Output Only] Timestamp when the resource was updated, in
- // RFC3339 text format .
- UpdateTime string `json:"updateTime,omitempty"`
-
- // Url: [Output Only] The URL of the actual resource.
- Url string `json:"url,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "FinalProperties") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Resource) MarshalJSON() ([]byte, error) {
- type noMethod Resource
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type ResourceUpdate struct {
- // Errors: [Output Only] List of all errors encountered while trying to
- // enact update.intent.
- Errors []string `json:"errors,omitempty"`
-
- // FinalProperties: [Output Only] The expanded properties of the
- // resource with reference values expanded. Returned as serialized YAML.
- FinalProperties string `json:"finalProperties,omitempty"`
-
- // Intent: [Output Only] The intent of the resource: PREVIEW, UPDATE, or
- // CANCEL.
- Intent string `json:"intent,omitempty"`
-
- // Manifest: [Output Only] URL of the manifest representing the update
- // configuration of this resource.
- Manifest string `json:"manifest,omitempty"`
-
- // Properties: [Output Only] The set of updated properties for this
- // resource, before references are expanded. Returned as serialized
- // YAML.
- Properties string `json:"properties,omitempty"`
-
- // State: [Output Only] The state of the resource.
- State string `json:"state,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Errors") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ResourceUpdate) MarshalJSON() ([]byte, error) {
- type noMethod ResourceUpdate
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ResourcesListResponse: A response containing a partial list of
-// resources and a page token used to build the next request if the
-// request has been truncated.
-type ResourcesListResponse struct {
- // NextPageToken: A token used to continue a truncated list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Resources: Resources contained in this list response.
- Resources []*Resource `json:"resources,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "NextPageToken") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ResourcesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod ResourcesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-type TargetConfiguration struct {
- // Config: The configuration to use for this deployment.
- Config string `json:"config,omitempty"`
-
- // Imports: Specifies any files to import for this configuration. This
- // can be used to import templates or other files. For example, you
- // might import a text file in order to use the file in a template.
- Imports []*ImportFile `json:"imports,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Config") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetConfiguration) MarshalJSON() ([]byte, error) {
- type noMethod TargetConfiguration
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Type: A resource type supported by Deployment Manager.
-type Type struct {
- // Id: [Output Only] Unique identifier for the resource; defined by the
- // server.
- Id uint64 `json:"id,omitempty,string"`
-
- // InsertTime: [Output Only] Timestamp when the type was created, in
- // RFC3339 text format.
- InsertTime string `json:"insertTime,omitempty"`
-
- // Name: Name of the type.
- Name string `json:"name,omitempty"`
-
- // SelfLink: [Output Only] Self link for the type.
- SelfLink string `json:"selfLink,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Type) MarshalJSON() ([]byte, error) {
- type noMethod Type
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TypesListResponse: A response that returns all Types supported by
-// Deployment Manager
-type TypesListResponse struct {
- // NextPageToken: A token used to continue a truncated list request.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Types: [Output Only] A list of resource types supported by Deployment
- // Manager.
- Types []*Type `json:"types,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "NextPageToken") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TypesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod TypesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "deploymentmanager.deployments.delete":
-
-type DeploymentsDeleteCall struct {
- s *Service
- project string
- deployment string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes a deployment and all of the resources in the
-// deployment.
-func (r *DeploymentsService) Delete(project string, deployment string) *DeploymentsDeleteCall {
- c := &DeploymentsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.deployment = deployment
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DeploymentsDeleteCall) Fields(s ...googleapi.Field) *DeploymentsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DeploymentsDeleteCall) Context(ctx context.Context) *DeploymentsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DeploymentsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments/{deployment}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "deployment": c.deployment,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.deployments.delete" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DeploymentsDeleteCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Deletes a deployment and all of the resources in the deployment.",
- // "httpMethod": "DELETE",
- // "id": "deploymentmanager.deployments.delete",
- // "parameterOrder": [
- // "project",
- // "deployment"
- // ],
- // "parameters": {
- // "deployment": {
- // "description": "The name of the deployment for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments/{deployment}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/ndev.cloudman"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.deployments.get":
-
-type DeploymentsGetCall struct {
- s *Service
- project string
- deployment string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets information about a specific deployment.
-func (r *DeploymentsService) Get(project string, deployment string) *DeploymentsGetCall {
- c := &DeploymentsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.deployment = deployment
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DeploymentsGetCall) Fields(s ...googleapi.Field) *DeploymentsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DeploymentsGetCall) IfNoneMatch(entityTag string) *DeploymentsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DeploymentsGetCall) Context(ctx context.Context) *DeploymentsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DeploymentsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments/{deployment}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "deployment": c.deployment,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.deployments.get" call.
-// Exactly one of *Deployment or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Deployment.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DeploymentsGetCall) Do() (*Deployment, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Deployment{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets information about a specific deployment.",
- // "httpMethod": "GET",
- // "id": "deploymentmanager.deployments.get",
- // "parameterOrder": [
- // "project",
- // "deployment"
- // ],
- // "parameters": {
- // "deployment": {
- // "description": "The name of the deployment for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments/{deployment}",
- // "response": {
- // "$ref": "Deployment"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/ndev.cloudman",
- // "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.deployments.insert":
-
-type DeploymentsInsertCall struct {
- s *Service
- project string
- deployment *Deployment
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a deployment and all of the resources described by
-// the deployment manifest.
-func (r *DeploymentsService) Insert(project string, deployment *Deployment) *DeploymentsInsertCall {
- c := &DeploymentsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.deployment = deployment
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DeploymentsInsertCall) Fields(s ...googleapi.Field) *DeploymentsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DeploymentsInsertCall) Context(ctx context.Context) *DeploymentsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DeploymentsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.deployment)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.deployments.insert" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DeploymentsInsertCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a deployment and all of the resources described by the deployment manifest.",
- // "httpMethod": "POST",
- // "id": "deploymentmanager.deployments.insert",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments",
- // "request": {
- // "$ref": "Deployment"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/ndev.cloudman"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.deployments.list":
-
-type DeploymentsListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all deployments for a given project.
-func (r *DeploymentsService) List(project string) *DeploymentsListCall {
- c := &DeploymentsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *DeploymentsListCall) Filter(filter string) *DeploymentsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *DeploymentsListCall) MaxResults(maxResults int64) *DeploymentsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *DeploymentsListCall) PageToken(pageToken string) *DeploymentsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DeploymentsListCall) Fields(s ...googleapi.Field) *DeploymentsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DeploymentsListCall) IfNoneMatch(entityTag string) *DeploymentsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DeploymentsListCall) Context(ctx context.Context) *DeploymentsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DeploymentsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.deployments.list" call.
-// Exactly one of *DeploymentsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *DeploymentsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DeploymentsListCall) Do() (*DeploymentsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DeploymentsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all deployments for a given project.",
- // "httpMethod": "GET",
- // "id": "deploymentmanager.deployments.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments",
- // "response": {
- // "$ref": "DeploymentsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/ndev.cloudman",
- // "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.deployments.patch":
-
-type DeploymentsPatchCall struct {
- s *Service
- project string
- deployment string
- deployment2 *Deployment
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates a deployment and all of the resources described by the
-// deployment manifest. This method supports patch semantics.
-func (r *DeploymentsService) Patch(project string, deployment string, deployment2 *Deployment) *DeploymentsPatchCall {
- c := &DeploymentsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.deployment = deployment
- c.deployment2 = deployment2
- return c
-}
-
-// CreatePolicy sets the optional parameter "createPolicy": Sets the
-// policy to use for creating new resources.
-//
-// Possible values:
-// "ACQUIRE"
-// "CREATE_OR_ACQUIRE" (default)
-func (c *DeploymentsPatchCall) CreatePolicy(createPolicy string) *DeploymentsPatchCall {
- c.opt_["createPolicy"] = createPolicy
- return c
-}
-
-// DeletePolicy sets the optional parameter "deletePolicy": Sets the
-// policy to use for deleting resources.
-//
-// Possible values:
-// "ABANDON"
-// "DELETE" (default)
-func (c *DeploymentsPatchCall) DeletePolicy(deletePolicy string) *DeploymentsPatchCall {
- c.opt_["deletePolicy"] = deletePolicy
- return c
-}
-
-// UpdatePolicy sets the optional parameter "updatePolicy": Sets the
-// policy to use for updating resources.
-//
-// Possible values:
-// "PATCH" (default)
-// "UPDATE"
-func (c *DeploymentsPatchCall) UpdatePolicy(updatePolicy string) *DeploymentsPatchCall {
- c.opt_["updatePolicy"] = updatePolicy
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DeploymentsPatchCall) Fields(s ...googleapi.Field) *DeploymentsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DeploymentsPatchCall) Context(ctx context.Context) *DeploymentsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DeploymentsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.deployment2)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["createPolicy"]; ok {
- params.Set("createPolicy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["deletePolicy"]; ok {
- params.Set("deletePolicy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["updatePolicy"]; ok {
- params.Set("updatePolicy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments/{deployment}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "deployment": c.deployment,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.deployments.patch" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DeploymentsPatchCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "deploymentmanager.deployments.patch",
- // "parameterOrder": [
- // "project",
- // "deployment"
- // ],
- // "parameters": {
- // "createPolicy": {
- // "default": "CREATE_OR_ACQUIRE",
- // "description": "Sets the policy to use for creating new resources.",
- // "enum": [
- // "ACQUIRE",
- // "CREATE_OR_ACQUIRE"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "deletePolicy": {
- // "default": "DELETE",
- // "description": "Sets the policy to use for deleting resources.",
- // "enum": [
- // "ABANDON",
- // "DELETE"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "deployment": {
- // "description": "The name of the deployment for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "updatePolicy": {
- // "default": "PATCH",
- // "description": "Sets the policy to use for updating resources.",
- // "enum": [
- // "PATCH",
- // "UPDATE"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments/{deployment}",
- // "request": {
- // "$ref": "Deployment"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/ndev.cloudman"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.deployments.update":
-
-type DeploymentsUpdateCall struct {
- s *Service
- project string
- deployment string
- deployment2 *Deployment
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates a deployment and all of the resources described by
-// the deployment manifest.
-func (r *DeploymentsService) Update(project string, deployment string, deployment2 *Deployment) *DeploymentsUpdateCall {
- c := &DeploymentsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.deployment = deployment
- c.deployment2 = deployment2
- return c
-}
-
-// CreatePolicy sets the optional parameter "createPolicy": Sets the
-// policy to use for creating new resources.
-//
-// Possible values:
-// "ACQUIRE"
-// "CREATE_OR_ACQUIRE" (default)
-func (c *DeploymentsUpdateCall) CreatePolicy(createPolicy string) *DeploymentsUpdateCall {
- c.opt_["createPolicy"] = createPolicy
- return c
-}
-
-// DeletePolicy sets the optional parameter "deletePolicy": Sets the
-// policy to use for deleting resources.
-//
-// Possible values:
-// "ABANDON"
-// "DELETE" (default)
-func (c *DeploymentsUpdateCall) DeletePolicy(deletePolicy string) *DeploymentsUpdateCall {
- c.opt_["deletePolicy"] = deletePolicy
- return c
-}
-
-// UpdatePolicy sets the optional parameter "updatePolicy": Sets the
-// policy to use for updating resources.
-//
-// Possible values:
-// "PATCH" (default)
-// "UPDATE"
-func (c *DeploymentsUpdateCall) UpdatePolicy(updatePolicy string) *DeploymentsUpdateCall {
- c.opt_["updatePolicy"] = updatePolicy
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DeploymentsUpdateCall) Fields(s ...googleapi.Field) *DeploymentsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DeploymentsUpdateCall) Context(ctx context.Context) *DeploymentsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DeploymentsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.deployment2)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["createPolicy"]; ok {
- params.Set("createPolicy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["deletePolicy"]; ok {
- params.Set("deletePolicy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["updatePolicy"]; ok {
- params.Set("updatePolicy", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments/{deployment}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "deployment": c.deployment,
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.deployments.update" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *DeploymentsUpdateCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a deployment and all of the resources described by the deployment manifest.",
- // "httpMethod": "PUT",
- // "id": "deploymentmanager.deployments.update",
- // "parameterOrder": [
- // "project",
- // "deployment"
- // ],
- // "parameters": {
- // "createPolicy": {
- // "default": "CREATE_OR_ACQUIRE",
- // "description": "Sets the policy to use for creating new resources.",
- // "enum": [
- // "ACQUIRE",
- // "CREATE_OR_ACQUIRE"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "deletePolicy": {
- // "default": "DELETE",
- // "description": "Sets the policy to use for deleting resources.",
- // "enum": [
- // "ABANDON",
- // "DELETE"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "deployment": {
- // "description": "The name of the deployment for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "updatePolicy": {
- // "default": "PATCH",
- // "description": "Sets the policy to use for updating resources.",
- // "enum": [
- // "PATCH",
- // "UPDATE"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments/{deployment}",
- // "request": {
- // "$ref": "Deployment"
- // },
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/ndev.cloudman"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.manifests.get":
-
-type ManifestsGetCall struct {
- s *Service
- project string
- deployment string
- manifest string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets information about a specific manifest.
-func (r *ManifestsService) Get(project string, deployment string, manifest string) *ManifestsGetCall {
- c := &ManifestsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.deployment = deployment
- c.manifest = manifest
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManifestsGetCall) Fields(s ...googleapi.Field) *ManifestsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManifestsGetCall) IfNoneMatch(entityTag string) *ManifestsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManifestsGetCall) Context(ctx context.Context) *ManifestsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManifestsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments/{deployment}/manifests/{manifest}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "deployment": c.deployment,
- "manifest": c.manifest,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.manifests.get" call.
-// Exactly one of *Manifest or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Manifest.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ManifestsGetCall) Do() (*Manifest, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Manifest{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets information about a specific manifest.",
- // "httpMethod": "GET",
- // "id": "deploymentmanager.manifests.get",
- // "parameterOrder": [
- // "project",
- // "deployment",
- // "manifest"
- // ],
- // "parameters": {
- // "deployment": {
- // "description": "The name of the deployment for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "manifest": {
- // "description": "The name of the manifest for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments/{deployment}/manifests/{manifest}",
- // "response": {
- // "$ref": "Manifest"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/ndev.cloudman",
- // "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.manifests.list":
-
-type ManifestsListCall struct {
- s *Service
- project string
- deployment string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all manifests for a given deployment.
-func (r *ManifestsService) List(project string, deployment string) *ManifestsListCall {
- c := &ManifestsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.deployment = deployment
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *ManifestsListCall) Filter(filter string) *ManifestsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *ManifestsListCall) MaxResults(maxResults int64) *ManifestsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *ManifestsListCall) PageToken(pageToken string) *ManifestsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ManifestsListCall) Fields(s ...googleapi.Field) *ManifestsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ManifestsListCall) IfNoneMatch(entityTag string) *ManifestsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ManifestsListCall) Context(ctx context.Context) *ManifestsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ManifestsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments/{deployment}/manifests")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "deployment": c.deployment,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.manifests.list" call.
-// Exactly one of *ManifestsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ManifestsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ManifestsListCall) Do() (*ManifestsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ManifestsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all manifests for a given deployment.",
- // "httpMethod": "GET",
- // "id": "deploymentmanager.manifests.list",
- // "parameterOrder": [
- // "project",
- // "deployment"
- // ],
- // "parameters": {
- // "deployment": {
- // "description": "The name of the deployment for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments/{deployment}/manifests",
- // "response": {
- // "$ref": "ManifestsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/ndev.cloudman",
- // "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.operations.get":
-
-type OperationsGetCall struct {
- s *Service
- project string
- operation string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets information about a specific operation.
-func (r *OperationsService) Get(project string, operation string) *OperationsGetCall {
- c := &OperationsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.operation = operation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OperationsGetCall) Fields(s ...googleapi.Field) *OperationsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OperationsGetCall) Context(ctx context.Context) *OperationsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OperationsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/operations/{operation}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "operation": c.operation,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.operations.get" call.
-// Exactly one of *Operation or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Operation.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *OperationsGetCall) Do() (*Operation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Operation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets information about a specific operation.",
- // "httpMethod": "GET",
- // "id": "deploymentmanager.operations.get",
- // "parameterOrder": [
- // "project",
- // "operation"
- // ],
- // "parameters": {
- // "operation": {
- // "description": "The name of the operation for this request.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/operations/{operation}",
- // "response": {
- // "$ref": "Operation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/ndev.cloudman",
- // "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.operations.list":
-
-type OperationsListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all operations for a project.
-func (r *OperationsService) List(project string) *OperationsListCall {
- c := &OperationsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *OperationsListCall) Filter(filter string) *OperationsListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *OperationsListCall) MaxResults(maxResults int64) *OperationsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OperationsListCall) Fields(s ...googleapi.Field) *OperationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OperationsListCall) IfNoneMatch(entityTag string) *OperationsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OperationsListCall) Context(ctx context.Context) *OperationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OperationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/operations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.operations.list" call.
-// Exactly one of *OperationsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *OperationsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OperationsListCall) Do() (*OperationsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OperationsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all operations for a project.",
- // "httpMethod": "GET",
- // "id": "deploymentmanager.operations.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/operations",
- // "response": {
- // "$ref": "OperationsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/ndev.cloudman",
- // "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.resources.get":
-
-type ResourcesGetCall struct {
- s *Service
- project string
- deployment string
- resource string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets information about a single resource.
-func (r *ResourcesService) Get(project string, deployment string, resource string) *ResourcesGetCall {
- c := &ResourcesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.deployment = deployment
- c.resource = resource
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ResourcesGetCall) Fields(s ...googleapi.Field) *ResourcesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ResourcesGetCall) IfNoneMatch(entityTag string) *ResourcesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ResourcesGetCall) Context(ctx context.Context) *ResourcesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ResourcesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments/{deployment}/resources/{resource}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "deployment": c.deployment,
- "resource": c.resource,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.resources.get" call.
-// Exactly one of *Resource or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Resource.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ResourcesGetCall) Do() (*Resource, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Resource{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets information about a single resource.",
- // "httpMethod": "GET",
- // "id": "deploymentmanager.resources.get",
- // "parameterOrder": [
- // "project",
- // "deployment",
- // "resource"
- // ],
- // "parameters": {
- // "deployment": {
- // "description": "The name of the deployment for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // },
- // "resource": {
- // "description": "The name of the resource for this request.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments/{deployment}/resources/{resource}",
- // "response": {
- // "$ref": "Resource"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/ndev.cloudman",
- // "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.resources.list":
-
-type ResourcesListCall struct {
- s *Service
- project string
- deployment string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all resources in a given deployment.
-func (r *ResourcesService) List(project string, deployment string) *ResourcesListCall {
- c := &ResourcesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- c.deployment = deployment
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *ResourcesListCall) Filter(filter string) *ResourcesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *ResourcesListCall) MaxResults(maxResults int64) *ResourcesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *ResourcesListCall) PageToken(pageToken string) *ResourcesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ResourcesListCall) Fields(s ...googleapi.Field) *ResourcesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ResourcesListCall) IfNoneMatch(entityTag string) *ResourcesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ResourcesListCall) Context(ctx context.Context) *ResourcesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ResourcesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/deployments/{deployment}/resources")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- "deployment": c.deployment,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.resources.list" call.
-// Exactly one of *ResourcesListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ResourcesListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ResourcesListCall) Do() (*ResourcesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ResourcesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all resources in a given deployment.",
- // "httpMethod": "GET",
- // "id": "deploymentmanager.resources.list",
- // "parameterOrder": [
- // "project",
- // "deployment"
- // ],
- // "parameters": {
- // "deployment": {
- // "description": "The name of the deployment for this request.",
- // "location": "path",
- // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- // "required": true,
- // "type": "string"
- // },
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/deployments/{deployment}/resources",
- // "response": {
- // "$ref": "ResourcesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/ndev.cloudman",
- // "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- // ]
- // }
-
-}
-
-// method id "deploymentmanager.types.list":
-
-type TypesListCall struct {
- s *Service
- project string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists all resource types for Deployment Manager.
-func (r *TypesService) List(project string) *TypesListCall {
- c := &TypesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.project = project
- return c
-}
-
-// Filter sets the optional parameter "filter": Sets a filter expression
-// for filtering listed resources, in the form filter={expression}. Your
-// {expression} must be in the format: FIELD_NAME COMPARISON_STRING
-// LITERAL_STRING.
-//
-// The FIELD_NAME is the name of the field you want to compare. Only
-// atomic field types are supported (string, number, boolean). The
-// COMPARISON_STRING must be either eq (equals) or ne (not equals). The
-// LITERAL_STRING is the string value to filter to. The literal value
-// must be valid for the type of field (string, number, boolean). For
-// string fields, the literal value is interpreted as a regular
-// expression using RE2 syntax. The literal value must match the entire
-// field.
-//
-// For example, filter=name ne example-instance.
-func (c *TypesListCall) Filter(filter string) *TypesListCall {
- c.opt_["filter"] = filter
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum count of
-// results to be returned.
-func (c *TypesListCall) MaxResults(maxResults int64) *TypesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Specifies a page
-// token to use. Use this parameter if you want to list the next page of
-// results. Set pageToken to the nextPageToken returned by a previous
-// list request.
-func (c *TypesListCall) PageToken(pageToken string) *TypesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TypesListCall) Fields(s ...googleapi.Field) *TypesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TypesListCall) IfNoneMatch(entityTag string) *TypesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TypesListCall) Context(ctx context.Context) *TypesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TypesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["filter"]; ok {
- params.Set("filter", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/types")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "project": c.project,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "deploymentmanager.types.list" call.
-// Exactly one of *TypesListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *TypesListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TypesListCall) Do() (*TypesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TypesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists all resource types for Deployment Manager.",
- // "httpMethod": "GET",
- // "id": "deploymentmanager.types.list",
- // "parameterOrder": [
- // "project"
- // ],
- // "parameters": {
- // "filter": {
- // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.\n\nThe FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, filter=name ne example-instance.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "default": "500",
- // "description": "Maximum count of results to be returned.",
- // "format": "uint32",
- // "location": "query",
- // "maximum": "500",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
- // "location": "query",
- // "type": "string"
- // },
- // "project": {
- // "description": "The project ID for this request.",
- // "location": "path",
- // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "{project}/global/types",
- // "response": {
- // "$ref": "TypesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/cloud-platform.read-only",
- // "https://www.googleapis.com/auth/ndev.cloudman",
- // "https://www.googleapis.com/auth/ndev.cloudman.readonly"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/dfareporting/v1.1/dfareporting-api.json b/vendor/google.golang.org/api/dfareporting/v1.1/dfareporting-api.json
deleted file mode 100644
index aef7061d..00000000
--- a/vendor/google.golang.org/api/dfareporting/v1.1/dfareporting-api.json
+++ /dev/null
@@ -1,1521 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/iNITuzieMjdA01fjEwPpxFw5muo\"",
- "discoveryVersion": "v1",
- "id": "dfareporting:v1.1",
- "name": "dfareporting",
- "version": "v1.1",
- "revision": "20141112",
- "title": "DFA Reporting API",
- "description": "Lets you create, run and download reports.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/doubleclick-advertisers/reporting/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/dfareporting/v1.1/",
- "basePath": "/dfareporting/v1.1/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "dfareporting/v1.1/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/dfareporting": {
- "description": "View and manage DoubleClick for Advertisers reports"
- }
- }
- }
- },
- "schemas": {
- "Activities": {
- "id": "Activities",
- "type": "object",
- "description": "Represents an activity group.",
- "properties": {
- "filters": {
- "type": "array",
- "description": "List of activity filters. The dimension values need to be all either of type \"dfa:activity\" or \"dfa:activityGroup\".",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#activities.",
- "default": "dfareporting#activities"
- },
- "metricNames": {
- "type": "array",
- "description": "List of names of floodlight activity metrics.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "CustomRichMediaEvents": {
- "id": "CustomRichMediaEvents",
- "type": "object",
- "description": "Represents a Custom Rich Media Events group.",
- "properties": {
- "filteredEventIds": {
- "type": "array",
- "description": "List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#customRichMediaEvents.",
- "default": "dfareporting#customRichMediaEvents"
- }
- }
- },
- "DateRange": {
- "id": "DateRange",
- "type": "object",
- "description": "Represents a date range.",
- "properties": {
- "endDate": {
- "type": "string",
- "description": "The end date of the date range, inclusive. A string of the format: \"yyyy-MM-dd\".",
- "format": "date"
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#dateRange.",
- "default": "dfareporting#dateRange"
- },
- "relativeDateRange": {
- "type": "string",
- "description": "The date range relative to the date of when the report is run, one of: \n- \"TODAY\" \n- \"YESTERDAY\" \n- \"WEEK_TO_DATE\" \n- \"MONTH_TO_DATE\" \n- \"QUARTER_TO_DATE\" \n- \"YEAR_TO_DATE\" \n- \"PREVIOUS_WEEK\" \n- \"PREVIOUS_MONTH\" \n- \"PREVIOUS_QUARTER\" \n- \"PREVIOUS_YEAR\" \n- \"LAST_7_DAYS\" \n- \"LAST_30_DAYS\" \n- \"LAST_90_DAYS\" \n- \"LAST_365_DAYS\" \n- \"LAST_24_MONTHS\""
- },
- "startDate": {
- "type": "string",
- "description": "The start date of the date range, inclusive. A string of the format: \"yyyy-MM-dd\".",
- "format": "date"
- }
- }
- },
- "DimensionFilter": {
- "id": "DimensionFilter",
- "type": "object",
- "description": "Represents a dimension filter.",
- "properties": {
- "dimensionName": {
- "type": "string",
- "description": "The name of the dimension to filter."
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#dimensionFilter.",
- "default": "dfareporting#dimensionFilter"
- },
- "value": {
- "type": "string",
- "description": "The value of the dimension to filter."
- }
- }
- },
- "DimensionValue": {
- "id": "DimensionValue",
- "type": "object",
- "description": "Represents a DimensionValue resource.",
- "properties": {
- "dimensionName": {
- "type": "string",
- "description": "The name of the dimension."
- },
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "id": {
- "type": "string",
- "description": "The ID associated with the value if available."
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#dimensionValue.",
- "default": "dfareporting#dimensionValue"
- },
- "value": {
- "type": "string",
- "description": "The value of the dimension."
- }
- }
- },
- "DimensionValueList": {
- "id": "DimensionValueList",
- "type": "object",
- "description": "Represents the list of DimensionValue resources.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The dimension values returned in this response.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of list this is, in this case dfareporting#dimensionValueList.",
- "default": "dfareporting#dimensionValueList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted."
- }
- }
- },
- "DimensionValueRequest": {
- "id": "DimensionValueRequest",
- "type": "object",
- "description": "Represents a DimensionValuesRequest.",
- "properties": {
- "dimensionName": {
- "type": "string",
- "description": "The name of the dimension for which values should be requested."
- },
- "endDate": {
- "type": "string",
- "description": "The end date of the date range for which to retrieve dimension values. A string of the format: \"yyyy-MM-dd\".",
- "format": "date"
- },
- "filters": {
- "type": "array",
- "description": "The list of filters by which to filter values. The filters are ANDed.",
- "items": {
- "$ref": "DimensionFilter"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of request this is, in this case dfareporting#dimensionValueRequest.",
- "default": "dfareporting#dimensionValueRequest"
- },
- "startDate": {
- "type": "string",
- "description": "The start date of the date range for which to retrieve dimension values. A string of the format: \"yyyy-MM-dd\".",
- "format": "date"
- }
- }
- },
- "File": {
- "id": "File",
- "type": "object",
- "description": "Represents a File resource. A File contains the meta-data for a report run. It shows the status of the run and holds the urls to the generated report data if the run is finished and the status is \"REPORT_AVAILABLE\".",
- "properties": {
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range for which the file has report data. The date range will always be the absolute date range for which the report is run."
- },
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "fileName": {
- "type": "string",
- "description": "The file name of the file."
- },
- "format": {
- "type": "string",
- "description": "The output format of the report. Only available once the file is available."
- },
- "id": {
- "type": "string",
- "description": "The unique ID of this report file.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#file.",
- "default": "dfareporting#file"
- },
- "lastModifiedTime": {
- "type": "string",
- "description": "The timestamp in milliseconds since epoch when this file was last modified.",
- "format": "int64"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report this file was generated from.",
- "format": "int64"
- },
- "status": {
- "type": "string",
- "description": "The status of the report file, one of: \n- \"PROCESSING\" \n- \"REPORT_AVAILABLE\" \n- \"FAILED\" \n- \"CANCELLED\""
- },
- "urls": {
- "type": "object",
- "description": "The urls where the completed report file can be downloaded.",
- "properties": {
- "apiUrl": {
- "type": "string",
- "description": "The url for downloading the report data through the API."
- },
- "browserUrl": {
- "type": "string",
- "description": "The url for downloading the report data through a browser."
- }
- }
- }
- }
- },
- "FileList": {
- "id": "FileList",
- "type": "object",
- "description": "Represents the list of File resources.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The files returned in this response.",
- "items": {
- "$ref": "File"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of list this is, in this case dfareporting#fileList.",
- "default": "dfareporting#fileList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through files. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted."
- }
- }
- },
- "Recipient": {
- "id": "Recipient",
- "type": "object",
- "description": "Represents a recipient.",
- "properties": {
- "deliveryType": {
- "type": "string",
- "description": "The delivery type for the recipient, one of: \n- \"ATTACHMENT\" \n- \"LINK\"",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "email": {
- "type": "string",
- "description": "The email address of the recipient.",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#recipient.",
- "default": "dfareporting#recipient"
- }
- }
- },
- "Report": {
- "id": "Report",
- "type": "object",
- "description": "Represents a Report resource.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The account ID to which this report belongs.",
- "format": "int64",
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- }
- },
- "activeGrpCriteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"ACTIVE_GRP\".",
- "properties": {
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimensionFilters": {
- "type": "array",
- "description": "The list of filters on which dimensions are filtered.\nFilters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.\nA valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "criteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"STANDARD\".",
- "properties": {
- "activities": {
- "$ref": "Activities",
- "description": "Activity group."
- },
- "customRichMediaEvents": {
- "$ref": "CustomRichMediaEvents",
- "description": "Custom Rich Media Events group."
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range for which this report should be run."
- },
- "dimensionFilters": {
- "type": "array",
- "description": "The list of filters on which dimensions are filtered.\nFilters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "The list of standard dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "crossDimensionReachCriteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"CROSS_DIMENSION_REACH\".",
- "properties": {
- "breakdown": {
- "type": "array",
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimension": {
- "type": "string",
- "description": "The dimension option, one of: \n- \"ADVERTISER\" \n- \"CAMPAIGN\" \n- \"SITE_BY_ADVERTISER\" \n- \"SITE_BY_CAMPAIGN\""
- },
- "dimensionFilters": {
- "type": "array",
- "description": "The list of filters on which dimensions are filtered.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "overlapMetricNames": {
- "type": "array",
- "description": "The list of names of overlap metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "pivoted": {
- "type": "boolean",
- "description": "Whether the report is pivoted or not. Defaults to true."
- }
- }
- },
- "delivery": {
- "type": "object",
- "description": "The report's email delivery settings.",
- "properties": {
- "emailOwner": {
- "type": "boolean",
- "description": "Whether the report should be emailed to the report owner."
- },
- "emailOwnerDeliveryType": {
- "type": "string",
- "description": "The type of delivery for the owner to receive, if enabled. One of: \n- \"ATTACHMENT\" \n- \"LINK\""
- },
- "message": {
- "type": "string",
- "description": "The message to be sent with each email."
- },
- "recipients": {
- "type": "array",
- "description": "The list of recipients to which to email the report.",
- "items": {
- "$ref": "Recipient"
- }
- }
- }
- },
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "fileName": {
- "type": "string",
- "description": "The file name used when generating report files for this report."
- },
- "floodlightCriteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"FLOODLIGHT\".",
- "properties": {
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimensionFilters": {
- "type": "array",
- "description": "The list of filters on which dimensions are filtered.\nFilters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "floodlightConfigId": {
- "$ref": "DimensionValue",
- "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "reportProperties": {
- "type": "object",
- "description": "The properties of the report.",
- "properties": {
- "includeAttributedIPConversions": {
- "type": "boolean",
- "description": "Include conversions that have no cookie, but do have an exposure path."
- },
- "includeUnattributedCookieConversions": {
- "type": "boolean",
- "description": "Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window."
- },
- "includeUnattributedIPConversions": {
- "type": "boolean",
- "description": "Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion."
- }
- }
- }
- }
- },
- "format": {
- "type": "string",
- "description": "The output format of the report, one of: \n- \"CSV\" \n- \"EXCEL\" If not specified, default format is \"CSV\". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. \"CSV\" will then be the fallback format."
- },
- "id": {
- "type": "string",
- "description": "The unique ID identifying this report resource.",
- "format": "int64",
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#report.",
- "default": "dfareporting#report"
- },
- "lastModifiedTime": {
- "type": "string",
- "description": "The timestamp (in milliseconds since epoch) of when this report was last modified.",
- "format": "uint64",
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- }
- },
- "name": {
- "type": "string",
- "description": "The name of the report.",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "ownerProfileId": {
- "type": "string",
- "description": "The user profile id of the owner of this report.",
- "format": "int64",
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- }
- },
- "pathToConversionCriteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"PATH_TO_CONVERSION\".",
- "properties": {
- "activityFilters": {
- "type": "array",
- "description": "The list of 'dfa:activity' values to filter on.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "conversionDimensions": {
- "type": "array",
- "description": "The list of conversion dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "customFloodlightVariables": {
- "type": "array",
- "description": "The list of custom floodlight variables the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "floodlightConfigId": {
- "$ref": "DimensionValue",
- "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "perInteractionDimensions": {
- "type": "array",
- "description": "The list of per interaction dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "reportProperties": {
- "type": "object",
- "description": "The properties of the report.",
- "properties": {
- "clicksLookbackWindow": {
- "type": "integer",
- "description": "DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.",
- "format": "int32"
- },
- "impressionsLookbackWindow": {
- "type": "integer",
- "description": "DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.",
- "format": "int32"
- },
- "includeAttributedIPConversions": {
- "type": "boolean",
- "description": "Include conversions that have no cookie, but do have an exposure path."
- },
- "includeUnattributedCookieConversions": {
- "type": "boolean",
- "description": "Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window."
- },
- "includeUnattributedIPConversions": {
- "type": "boolean",
- "description": "Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion."
- },
- "maximumClickInteractions": {
- "type": "integer",
- "description": "The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.",
- "format": "int32"
- },
- "maximumImpressionInteractions": {
- "type": "integer",
- "description": "The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.",
- "format": "int32"
- },
- "maximumInteractionGap": {
- "type": "integer",
- "description": "The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.",
- "format": "int32"
- },
- "pivotOnInteractionPath": {
- "type": "boolean",
- "description": "Enable pivoting on interaction path."
- }
- }
- }
- }
- },
- "reachCriteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"REACH\".",
- "properties": {
- "activities": {
- "$ref": "Activities",
- "description": "Activity group."
- },
- "customRichMediaEvents": {
- "$ref": "CustomRichMediaEvents",
- "description": "Custom Rich Media Events group."
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimensionFilters": {
- "type": "array",
- "description": "The list of filters on which dimensions are filtered.\nFilters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "reachByFrequencyMetricNames": {
- "type": "array",
- "description": "The list of names of Reach By Frequency metrics the report should include.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "schedule": {
- "type": "object",
- "description": "The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not \"TODAY\".",
- "properties": {
- "active": {
- "type": "boolean",
- "description": "Whether the schedule is active or not. Must be set to either true or false.",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "every": {
- "type": "integer",
- "description": "Defines every how many days, weeks or months the report should be run. Needs to be set when \"repeats\" is either \"DAILY\", \"WEEKLY\" or \"MONTHLY\".",
- "format": "int32"
- },
- "expirationDate": {
- "type": "string",
- "description": "The expiration date when the scheduled report stops running.",
- "format": "date",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "repeats": {
- "type": "string",
- "description": "The interval for which the report is repeated, one of: \n- \"DAILY\", also requires field \"every\" to be set. \n- \"WEEKLY\", also requires fields \"every\" and \"repeatsOnWeekDays\" to be set. \n- \"TWICE_A_MONTH\" \n- \"MONTHLY\", also requires fields \"every\" and \"runsOnDayOfMonth\" to be set. \n- \"QUARTERLY\" \n- \"YEARLY\"",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "repeatsOnWeekDays": {
- "type": "array",
- "description": "List of week days \"WEEKLY\" on which scheduled reports should run.",
- "items": {
- "type": "string"
- }
- },
- "runsOnDayOfMonth": {
- "type": "string",
- "description": "Enum to define for \"MONTHLY\" scheduled reports whether reports should be repeated on the same day of the month as \"startDate\" or the same day of the week of the month. Possible values are: \n- DAY_OF_MONTH \n- WEEK_OF_MONTH \nExample: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), \"DAY_OF_MONTH\" would run subsequent reports on the 2nd of every Month, and \"WEEK_OF_MONTH\" would run subsequent reports on the first Monday of the month."
- },
- "startDate": {
- "type": "string",
- "description": "Start date of date range for which scheduled reports should be run.",
- "format": "date",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- }
- }
- },
- "subAccountId": {
- "type": "string",
- "description": "The subbaccount ID to which this report belongs if applicable.",
- "format": "int64"
- },
- "type": {
- "type": "string",
- "description": "The type of the report, one of: \n- STANDARD \n- REACH \n- ACTIVE_GRP \n- PATH_TO_CONVERSION \n- FLOODLIGHT \n- CROSS_DIMENSION_REACH",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- }
- }
- },
- "ReportList": {
- "id": "ReportList",
- "type": "object",
- "description": "Represents the list of reports.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The reports returned in this response.",
- "items": {
- "$ref": "Report"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of list this is, in this case dfareporting#reportList.",
- "default": "dfareporting#reportList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through reports. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted."
- }
- }
- },
- "SortedDimension": {
- "id": "SortedDimension",
- "type": "object",
- "description": "Represents a sorted dimension.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#sortedDimension.",
- "default": "dfareporting#sortedDimension"
- },
- "name": {
- "type": "string",
- "description": "The name of the dimension."
- },
- "sortOrder": {
- "type": "string",
- "description": "An optional sort order for the dimension column, one of: \n- \"ASCENDING\" \n- \"DESCENDING\""
- }
- }
- },
- "UserProfile": {
- "id": "UserProfile",
- "type": "object",
- "description": "Represents a UserProfile resource.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The account ID to which this profile belongs.",
- "format": "int64"
- },
- "accountName": {
- "type": "string",
- "description": "The account name this profile belongs to."
- },
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#userProfile.",
- "default": "dfareporting#userProfile"
- },
- "profileId": {
- "type": "string",
- "description": "The unique ID of the user profile.",
- "format": "int64"
- },
- "subAccountId": {
- "type": "string",
- "description": "The sub account ID this profile belongs to if applicable.",
- "format": "int64"
- },
- "subAccountName": {
- "type": "string",
- "description": "The sub account name this profile belongs to if applicable."
- },
- "userName": {
- "type": "string",
- "description": "The user name."
- }
- }
- },
- "UserProfileList": {
- "id": "UserProfileList",
- "type": "object",
- "description": "Represents the list of user profiles.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The user profiles returned in this response.",
- "items": {
- "$ref": "UserProfile"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of list this is, in this case dfareporting#userProfileList.",
- "default": "dfareporting#userProfileList"
- }
- }
- }
- },
- "resources": {
- "dimensionValues": {
- "methods": {
- "query": {
- "id": "dfareporting.dimensionValues.query",
- "path": "userprofiles/{profileId}/dimensionvalues/query",
- "httpMethod": "POST",
- "description": "Retrieves list of report dimension values for a list of filters.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "DimensionValueRequest"
- },
- "response": {
- "$ref": "DimensionValueList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- },
- "files": {
- "methods": {
- "list": {
- "id": "dfareporting.files.list",
- "path": "userprofiles/{profileId}/files",
- "httpMethod": "GET",
- "description": "Lists files for a user profile.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "sortField": {
- "type": "string",
- "description": "The field by which to sort the list.",
- "default": "LAST_MODIFIED_TIME",
- "enum": [
- "ID",
- "LAST_MODIFIED_TIME"
- ],
- "enumDescriptions": [
- "Sort by file ID.",
- "Sort by 'lastmodifiedAt' field."
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is 'DESCENDING'.",
- "default": "DESCENDING",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "FileList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- },
- "reports": {
- "methods": {
- "delete": {
- "id": "dfareporting.reports.delete",
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "DELETE",
- "description": "Deletes a report by its ID.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "get": {
- "id": "dfareporting.reports.get",
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "GET",
- "description": "Retrieves a report by its ID.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "insert": {
- "id": "dfareporting.reports.insert",
- "path": "userprofiles/{profileId}/reports",
- "httpMethod": "POST",
- "description": "Creates a report.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "list": {
- "id": "dfareporting.reports.list",
- "path": "userprofiles/{profileId}/reports",
- "httpMethod": "GET",
- "description": "Retrieves list of reports.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "sortField": {
- "type": "string",
- "description": "The field by which to sort the list.",
- "default": "LAST_MODIFIED_TIME",
- "enum": [
- "ID",
- "LAST_MODIFIED_TIME",
- "NAME"
- ],
- "enumDescriptions": [
- "Sort by report ID.",
- "Sort by 'lastModifiedTime' field.",
- "Sort by name of reports."
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is 'DESCENDING'.",
- "default": "DESCENDING",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "ReportList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "patch": {
- "id": "dfareporting.reports.patch",
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "PATCH",
- "description": "Updates a report. This method supports patch semantics.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "run": {
- "id": "dfareporting.reports.run",
- "path": "userprofiles/{profileId}/reports/{reportId}/run",
- "httpMethod": "POST",
- "description": "Runs a report.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "synchronous": {
- "type": "boolean",
- "description": "If set and true, tries to run the report synchronously.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "response": {
- "$ref": "File"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "update": {
- "id": "dfareporting.reports.update",
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "PUT",
- "description": "Updates a report.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- },
- "resources": {
- "files": {
- "methods": {
- "get": {
- "id": "dfareporting.reports.files.get",
- "path": "userprofiles/{profileId}/reports/{reportId}/files/{fileId}",
- "httpMethod": "GET",
- "description": "Retrieves a report file.",
- "parameters": {
- "fileId": {
- "type": "string",
- "description": "The ID of the report file.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId",
- "fileId"
- ],
- "response": {
- "$ref": "File"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "list": {
- "id": "dfareporting.reports.files.list",
- "path": "userprofiles/{profileId}/reports/{reportId}/files",
- "httpMethod": "GET",
- "description": "Lists files for a report.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the parent report.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "sortField": {
- "type": "string",
- "description": "The field by which to sort the list.",
- "default": "LAST_MODIFIED_TIME",
- "enum": [
- "ID",
- "LAST_MODIFIED_TIME"
- ],
- "enumDescriptions": [
- "Sort by file ID.",
- "Sort by 'lastmodifiedAt' field."
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is 'DESCENDING'.",
- "default": "DESCENDING",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "response": {
- "$ref": "FileList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- }
- }
- },
- "userProfiles": {
- "methods": {
- "get": {
- "id": "dfareporting.userProfiles.get",
- "path": "userprofiles/{profileId}",
- "httpMethod": "GET",
- "description": "Gets one user profile by ID.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "UserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "list": {
- "id": "dfareporting.userProfiles.list",
- "path": "userprofiles",
- "httpMethod": "GET",
- "description": "Retrieves list of user profiles for a user.",
- "response": {
- "$ref": "UserProfileList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/dfareporting/v1.1/dfareporting-gen.go b/vendor/google.golang.org/api/dfareporting/v1.1/dfareporting-gen.go
deleted file mode 100644
index 11a7d5c7..00000000
--- a/vendor/google.golang.org/api/dfareporting/v1.1/dfareporting-gen.go
+++ /dev/null
@@ -1,3197 +0,0 @@
-// Package dfareporting provides access to the DFA Reporting API.
-//
-// See https://developers.google.com/doubleclick-advertisers/reporting/
-//
-// Usage example:
-//
-// import "google.golang.org/api/dfareporting/v1.1"
-// ...
-// dfareportingService, err := dfareporting.New(oauthHttpClient)
-package dfareporting // import "google.golang.org/api/dfareporting/v1.1"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "dfareporting:v1.1"
-const apiName = "dfareporting"
-const apiVersion = "v1.1"
-const basePath = "https://www.googleapis.com/dfareporting/v1.1/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage DoubleClick for Advertisers reports
- DfareportingScope = "https://www.googleapis.com/auth/dfareporting"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.DimensionValues = NewDimensionValuesService(s)
- s.Files = NewFilesService(s)
- s.Reports = NewReportsService(s)
- s.UserProfiles = NewUserProfilesService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- DimensionValues *DimensionValuesService
-
- Files *FilesService
-
- Reports *ReportsService
-
- UserProfiles *UserProfilesService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewDimensionValuesService(s *Service) *DimensionValuesService {
- rs := &DimensionValuesService{s: s}
- return rs
-}
-
-type DimensionValuesService struct {
- s *Service
-}
-
-func NewFilesService(s *Service) *FilesService {
- rs := &FilesService{s: s}
- return rs
-}
-
-type FilesService struct {
- s *Service
-}
-
-func NewReportsService(s *Service) *ReportsService {
- rs := &ReportsService{s: s}
- rs.Files = NewReportsFilesService(s)
- return rs
-}
-
-type ReportsService struct {
- s *Service
-
- Files *ReportsFilesService
-}
-
-func NewReportsFilesService(s *Service) *ReportsFilesService {
- rs := &ReportsFilesService{s: s}
- return rs
-}
-
-type ReportsFilesService struct {
- s *Service
-}
-
-func NewUserProfilesService(s *Service) *UserProfilesService {
- rs := &UserProfilesService{s: s}
- return rs
-}
-
-type UserProfilesService struct {
- s *Service
-}
-
-// Activities: Represents an activity group.
-type Activities struct {
- // Filters: List of activity filters. The dimension values need to be
- // all either of type "dfa:activity" or "dfa:activityGroup".
- Filters []*DimensionValue `json:"filters,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#activities.
- Kind string `json:"kind,omitempty"`
-
- // MetricNames: List of names of floodlight activity metrics.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Filters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Activities) MarshalJSON() ([]byte, error) {
- type noMethod Activities
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CustomRichMediaEvents: Represents a Custom Rich Media Events group.
-type CustomRichMediaEvents struct {
- // FilteredEventIds: List of custom rich media event IDs. Dimension
- // values must be all of type dfa:richMediaEventTypeIdAndName.
- FilteredEventIds []*DimensionValue `json:"filteredEventIds,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#customRichMediaEvents.
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "FilteredEventIds") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomRichMediaEvents) MarshalJSON() ([]byte, error) {
- type noMethod CustomRichMediaEvents
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DateRange: Represents a date range.
-type DateRange struct {
- // EndDate: The end date of the date range, inclusive. A string of the
- // format: "yyyy-MM-dd".
- EndDate string `json:"endDate,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#dateRange.
- Kind string `json:"kind,omitempty"`
-
- // RelativeDateRange: The date range relative to the date of when the
- // report is run, one of:
- // - "TODAY"
- // - "YESTERDAY"
- // - "WEEK_TO_DATE"
- // - "MONTH_TO_DATE"
- // - "QUARTER_TO_DATE"
- // - "YEAR_TO_DATE"
- // - "PREVIOUS_WEEK"
- // - "PREVIOUS_MONTH"
- // - "PREVIOUS_QUARTER"
- // - "PREVIOUS_YEAR"
- // - "LAST_7_DAYS"
- // - "LAST_30_DAYS"
- // - "LAST_90_DAYS"
- // - "LAST_365_DAYS"
- // - "LAST_24_MONTHS"
- RelativeDateRange string `json:"relativeDateRange,omitempty"`
-
- // StartDate: The start date of the date range, inclusive. A string of
- // the format: "yyyy-MM-dd".
- StartDate string `json:"startDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "EndDate") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DateRange) MarshalJSON() ([]byte, error) {
- type noMethod DateRange
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DimensionFilter: Represents a dimension filter.
-type DimensionFilter struct {
- // DimensionName: The name of the dimension to filter.
- DimensionName string `json:"dimensionName,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#dimensionFilter.
- Kind string `json:"kind,omitempty"`
-
- // Value: The value of the dimension to filter.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DimensionFilter) MarshalJSON() ([]byte, error) {
- type noMethod DimensionFilter
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DimensionValue: Represents a DimensionValue resource.
-type DimensionValue struct {
- // DimensionName: The name of the dimension.
- DimensionName string `json:"dimensionName,omitempty"`
-
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Id: The ID associated with the value if available.
- Id string `json:"id,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#dimensionValue.
- Kind string `json:"kind,omitempty"`
-
- // Value: The value of the dimension.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DimensionValue) MarshalJSON() ([]byte, error) {
- type noMethod DimensionValue
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DimensionValueList: Represents the list of DimensionValue resources.
-type DimensionValueList struct {
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The dimension values returned in this response.
- Items []*DimensionValue `json:"items,omitempty"`
-
- // Kind: The kind of list this is, in this case
- // dfareporting#dimensionValueList.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through dimension
- // values. To retrieve the next page of results, set the next request's
- // "pageToken" to the value of this field. The page token is only valid
- // for a limited amount of time and should not be persisted.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DimensionValueList) MarshalJSON() ([]byte, error) {
- type noMethod DimensionValueList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DimensionValueRequest: Represents a DimensionValuesRequest.
-type DimensionValueRequest struct {
- // DimensionName: The name of the dimension for which values should be
- // requested.
- DimensionName string `json:"dimensionName,omitempty"`
-
- // EndDate: The end date of the date range for which to retrieve
- // dimension values. A string of the format: "yyyy-MM-dd".
- EndDate string `json:"endDate,omitempty"`
-
- // Filters: The list of filters by which to filter values. The filters
- // are ANDed.
- Filters []*DimensionFilter `json:"filters,omitempty"`
-
- // Kind: The kind of request this is, in this case
- // dfareporting#dimensionValueRequest.
- Kind string `json:"kind,omitempty"`
-
- // StartDate: The start date of the date range for which to retrieve
- // dimension values. A string of the format: "yyyy-MM-dd".
- StartDate string `json:"startDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DimensionValueRequest) MarshalJSON() ([]byte, error) {
- type noMethod DimensionValueRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// File: Represents a File resource. A File contains the meta-data for a
-// report run. It shows the status of the run and holds the urls to the
-// generated report data if the run is finished and the status is
-// "REPORT_AVAILABLE".
-type File struct {
- // DateRange: The date range for which the file has report data. The
- // date range will always be the absolute date range for which the
- // report is run.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // FileName: The file name of the file.
- FileName string `json:"fileName,omitempty"`
-
- // Format: The output format of the report. Only available once the file
- // is available.
- Format string `json:"format,omitempty"`
-
- // Id: The unique ID of this report file.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: The kind of resource this is, in this case dfareporting#file.
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedTime: The timestamp in milliseconds since epoch when this
- // file was last modified.
- LastModifiedTime int64 `json:"lastModifiedTime,omitempty,string"`
-
- // ReportId: The ID of the report this file was generated from.
- ReportId int64 `json:"reportId,omitempty,string"`
-
- // Status: The status of the report file, one of:
- // - "PROCESSING"
- // - "REPORT_AVAILABLE"
- // - "FAILED"
- // - "CANCELLED"
- Status string `json:"status,omitempty"`
-
- // Urls: The urls where the completed report file can be downloaded.
- Urls *FileUrls `json:"urls,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "DateRange") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *File) MarshalJSON() ([]byte, error) {
- type noMethod File
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FileUrls: The urls where the completed report file can be downloaded.
-type FileUrls struct {
- // ApiUrl: The url for downloading the report data through the API.
- ApiUrl string `json:"apiUrl,omitempty"`
-
- // BrowserUrl: The url for downloading the report data through a
- // browser.
- BrowserUrl string `json:"browserUrl,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ApiUrl") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FileUrls) MarshalJSON() ([]byte, error) {
- type noMethod FileUrls
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FileList: Represents the list of File resources.
-type FileList struct {
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The files returned in this response.
- Items []*File `json:"items,omitempty"`
-
- // Kind: The kind of list this is, in this case dfareporting#fileList.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through files. To
- // retrieve the next page of results, set the next request's "pageToken"
- // to the value of this field. The page token is only valid for a
- // limited amount of time and should not be persisted.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FileList) MarshalJSON() ([]byte, error) {
- type noMethod FileList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Recipient: Represents a recipient.
-type Recipient struct {
- // DeliveryType: The delivery type for the recipient, one of:
- // - "ATTACHMENT"
- // - "LINK"
- DeliveryType string `json:"deliveryType,omitempty"`
-
- // Email: The email address of the recipient.
- Email string `json:"email,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#recipient.
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DeliveryType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Recipient) MarshalJSON() ([]byte, error) {
- type noMethod Recipient
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Report: Represents a Report resource.
-type Report struct {
- // AccountId: The account ID to which this report belongs.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // ActiveGrpCriteria: The report criteria for a report of type
- // "ACTIVE_GRP".
- ActiveGrpCriteria *ReportActiveGrpCriteria `json:"activeGrpCriteria,omitempty"`
-
- // Criteria: The report criteria for a report of type "STANDARD".
- Criteria *ReportCriteria `json:"criteria,omitempty"`
-
- // CrossDimensionReachCriteria: The report criteria for a report of type
- // "CROSS_DIMENSION_REACH".
- CrossDimensionReachCriteria *ReportCrossDimensionReachCriteria `json:"crossDimensionReachCriteria,omitempty"`
-
- // Delivery: The report's email delivery settings.
- Delivery *ReportDelivery `json:"delivery,omitempty"`
-
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // FileName: The file name used when generating report files for this
- // report.
- FileName string `json:"fileName,omitempty"`
-
- // FloodlightCriteria: The report criteria for a report of type
- // "FLOODLIGHT".
- FloodlightCriteria *ReportFloodlightCriteria `json:"floodlightCriteria,omitempty"`
-
- // Format: The output format of the report, one of:
- // - "CSV"
- // - "EXCEL" If not specified, default format is "CSV". Note that the
- // actual format in the completed report file might differ if for
- // instance the report's size exceeds the format's capabilities. "CSV"
- // will then be the fallback format.
- Format string `json:"format,omitempty"`
-
- // Id: The unique ID identifying this report resource.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: The kind of resource this is, in this case dfareporting#report.
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedTime: The timestamp (in milliseconds since epoch) of when
- // this report was last modified.
- LastModifiedTime uint64 `json:"lastModifiedTime,omitempty,string"`
-
- // Name: The name of the report.
- Name string `json:"name,omitempty"`
-
- // OwnerProfileId: The user profile id of the owner of this report.
- OwnerProfileId int64 `json:"ownerProfileId,omitempty,string"`
-
- // PathToConversionCriteria: The report criteria for a report of type
- // "PATH_TO_CONVERSION".
- PathToConversionCriteria *ReportPathToConversionCriteria `json:"pathToConversionCriteria,omitempty"`
-
- // ReachCriteria: The report criteria for a report of type "REACH".
- ReachCriteria *ReportReachCriteria `json:"reachCriteria,omitempty"`
-
- // Schedule: The report's schedule. Can only be set if the report's
- // 'dateRange' is a relative date range and the relative date range is
- // not "TODAY".
- Schedule *ReportSchedule `json:"schedule,omitempty"`
-
- // SubAccountId: The subbaccount ID to which this report belongs if
- // applicable.
- SubAccountId int64 `json:"subAccountId,omitempty,string"`
-
- // Type: The type of the report, one of:
- // - STANDARD
- // - REACH
- // - ACTIVE_GRP
- // - PATH_TO_CONVERSION
- // - FLOODLIGHT
- // - CROSS_DIMENSION_REACH
- Type string `json:"type,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Report) MarshalJSON() ([]byte, error) {
- type noMethod Report
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportActiveGrpCriteria: The report criteria for a report of type
-// "ACTIVE_GRP".
-type ReportActiveGrpCriteria struct {
- // DateRange: The date range this report should be run for.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // DimensionFilters: The list of filters on which dimensions are
- // filtered.
- // Filters for different dimensions are ANDed, filters for the same
- // dimension are grouped together and ORed.
- // A valid active GRP report needs to have exactly one DimensionValue
- // for the United States in addition to any advertiser or campaign
- // dimension values.
- DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`
-
- // Dimensions: The list of dimensions the report should include.
- Dimensions []*SortedDimension `json:"dimensions,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DateRange") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportActiveGrpCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportActiveGrpCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportCriteria: The report criteria for a report of type "STANDARD".
-type ReportCriteria struct {
- // Activities: Activity group.
- Activities *Activities `json:"activities,omitempty"`
-
- // CustomRichMediaEvents: Custom Rich Media Events group.
- CustomRichMediaEvents *CustomRichMediaEvents `json:"customRichMediaEvents,omitempty"`
-
- // DateRange: The date range for which this report should be run.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // DimensionFilters: The list of filters on which dimensions are
- // filtered.
- // Filters for different dimensions are ANDed, filters for the same
- // dimension are grouped together and ORed.
- DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`
-
- // Dimensions: The list of standard dimensions the report should
- // include.
- Dimensions []*SortedDimension `json:"dimensions,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Activities") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportCrossDimensionReachCriteria: The report criteria for a report
-// of type "CROSS_DIMENSION_REACH".
-type ReportCrossDimensionReachCriteria struct {
- // Breakdown: The list of dimensions the report should include.
- Breakdown []*SortedDimension `json:"breakdown,omitempty"`
-
- // DateRange: The date range this report should be run for.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // Dimension: The dimension option, one of:
- // - "ADVERTISER"
- // - "CAMPAIGN"
- // - "SITE_BY_ADVERTISER"
- // - "SITE_BY_CAMPAIGN"
- Dimension string `json:"dimension,omitempty"`
-
- // DimensionFilters: The list of filters on which dimensions are
- // filtered.
- DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // OverlapMetricNames: The list of names of overlap metrics the report
- // should include.
- OverlapMetricNames []string `json:"overlapMetricNames,omitempty"`
-
- // Pivoted: Whether the report is pivoted or not. Defaults to true.
- Pivoted bool `json:"pivoted,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Breakdown") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportCrossDimensionReachCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportCrossDimensionReachCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportDelivery: The report's email delivery settings.
-type ReportDelivery struct {
- // EmailOwner: Whether the report should be emailed to the report owner.
- EmailOwner bool `json:"emailOwner,omitempty"`
-
- // EmailOwnerDeliveryType: The type of delivery for the owner to
- // receive, if enabled. One of:
- // - "ATTACHMENT"
- // - "LINK"
- EmailOwnerDeliveryType string `json:"emailOwnerDeliveryType,omitempty"`
-
- // Message: The message to be sent with each email.
- Message string `json:"message,omitempty"`
-
- // Recipients: The list of recipients to which to email the report.
- Recipients []*Recipient `json:"recipients,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "EmailOwner") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportDelivery) MarshalJSON() ([]byte, error) {
- type noMethod ReportDelivery
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportFloodlightCriteria: The report criteria for a report of type
-// "FLOODLIGHT".
-type ReportFloodlightCriteria struct {
- // DateRange: The date range this report should be run for.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // DimensionFilters: The list of filters on which dimensions are
- // filtered.
- // Filters for different dimensions are ANDed, filters for the same
- // dimension are grouped together and ORed.
- DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`
-
- // Dimensions: The list of dimensions the report should include.
- Dimensions []*SortedDimension `json:"dimensions,omitempty"`
-
- // FloodlightConfigId: The floodlight ID for which to show data in this
- // report. All advertisers associated with that ID will automatically be
- // added. The dimension of the value needs to be
- // 'dfa:floodlightConfigId'.
- FloodlightConfigId *DimensionValue `json:"floodlightConfigId,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ReportProperties: The properties of the report.
- ReportProperties *ReportFloodlightCriteriaReportProperties `json:"reportProperties,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DateRange") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportFloodlightCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportFloodlightCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportFloodlightCriteriaReportProperties: The properties of the
-// report.
-type ReportFloodlightCriteriaReportProperties struct {
- // IncludeAttributedIPConversions: Include conversions that have no
- // cookie, but do have an exposure path.
- IncludeAttributedIPConversions bool `json:"includeAttributedIPConversions,omitempty"`
-
- // IncludeUnattributedCookieConversions: Include conversions of users
- // with a DoubleClick cookie but without an exposure. That means the
- // user did not click or see an ad from the advertiser within the
- // Floodlight group, or that the interaction happened outside the
- // lookback window.
- IncludeUnattributedCookieConversions bool `json:"includeUnattributedCookieConversions,omitempty"`
-
- // IncludeUnattributedIPConversions: Include conversions that have no
- // associated cookies and no exposures. It’s therefore impossible to
- // know how the user was exposed to your ads during the lookback window
- // prior to a conversion.
- IncludeUnattributedIPConversions bool `json:"includeUnattributedIPConversions,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "IncludeAttributedIPConversions") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportFloodlightCriteriaReportProperties) MarshalJSON() ([]byte, error) {
- type noMethod ReportFloodlightCriteriaReportProperties
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportPathToConversionCriteria: The report criteria for a report of
-// type "PATH_TO_CONVERSION".
-type ReportPathToConversionCriteria struct {
- // ActivityFilters: The list of 'dfa:activity' values to filter on.
- ActivityFilters []*DimensionValue `json:"activityFilters,omitempty"`
-
- // ConversionDimensions: The list of conversion dimensions the report
- // should include.
- ConversionDimensions []*SortedDimension `json:"conversionDimensions,omitempty"`
-
- // CustomFloodlightVariables: The list of custom floodlight variables
- // the report should include.
- CustomFloodlightVariables []*SortedDimension `json:"customFloodlightVariables,omitempty"`
-
- // DateRange: The date range this report should be run for.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // FloodlightConfigId: The floodlight ID for which to show data in this
- // report. All advertisers associated with that ID will automatically be
- // added. The dimension of the value needs to be
- // 'dfa:floodlightConfigId'.
- FloodlightConfigId *DimensionValue `json:"floodlightConfigId,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // PerInteractionDimensions: The list of per interaction dimensions the
- // report should include.
- PerInteractionDimensions []*SortedDimension `json:"perInteractionDimensions,omitempty"`
-
- // ReportProperties: The properties of the report.
- ReportProperties *ReportPathToConversionCriteriaReportProperties `json:"reportProperties,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ActivityFilters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportPathToConversionCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportPathToConversionCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportPathToConversionCriteriaReportProperties: The properties of the
-// report.
-type ReportPathToConversionCriteriaReportProperties struct {
- // ClicksLookbackWindow: DFA checks to see if a click interaction
- // occurred within the specified period of time before a conversion. By
- // default the value is pulled from Floodlight or you can manually enter
- // a custom value. Valid values: 1-90.
- ClicksLookbackWindow int64 `json:"clicksLookbackWindow,omitempty"`
-
- // ImpressionsLookbackWindow: DFA checks to see if an impression
- // interaction occurred within the specified period of time before a
- // conversion. By default the value is pulled from Floodlight or you can
- // manually enter a custom value. Valid values: 1-90.
- ImpressionsLookbackWindow int64 `json:"impressionsLookbackWindow,omitempty"`
-
- // IncludeAttributedIPConversions: Include conversions that have no
- // cookie, but do have an exposure path.
- IncludeAttributedIPConversions bool `json:"includeAttributedIPConversions,omitempty"`
-
- // IncludeUnattributedCookieConversions: Include conversions of users
- // with a DoubleClick cookie but without an exposure. That means the
- // user did not click or see an ad from the advertiser within the
- // Floodlight group, or that the interaction happened outside the
- // lookback window.
- IncludeUnattributedCookieConversions bool `json:"includeUnattributedCookieConversions,omitempty"`
-
- // IncludeUnattributedIPConversions: Include conversions that have no
- // associated cookies and no exposures. It’s therefore impossible to
- // know how the user was exposed to your ads during the lookback window
- // prior to a conversion.
- IncludeUnattributedIPConversions bool `json:"includeUnattributedIPConversions,omitempty"`
-
- // MaximumClickInteractions: The maximum number of click interactions to
- // include in the report. Advertisers currently paying for E2C reports
- // get up to 200 (100 clicks, 100 impressions). If another advertiser in
- // your network is paying for E2C, you can have up to 5 total exposures
- // per report.
- MaximumClickInteractions int64 `json:"maximumClickInteractions,omitempty"`
-
- // MaximumImpressionInteractions: The maximum number of click
- // interactions to include in the report. Advertisers currently paying
- // for E2C reports get up to 200 (100 clicks, 100 impressions). If
- // another advertiser in your network is paying for E2C, you can have up
- // to 5 total exposures per report.
- MaximumImpressionInteractions int64 `json:"maximumImpressionInteractions,omitempty"`
-
- // MaximumInteractionGap: The maximum amount of time that can take place
- // between interactions (clicks or impressions) by the same user. Valid
- // values: 1-90.
- MaximumInteractionGap int64 `json:"maximumInteractionGap,omitempty"`
-
- // PivotOnInteractionPath: Enable pivoting on interaction path.
- PivotOnInteractionPath bool `json:"pivotOnInteractionPath,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "ClicksLookbackWindow") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportPathToConversionCriteriaReportProperties) MarshalJSON() ([]byte, error) {
- type noMethod ReportPathToConversionCriteriaReportProperties
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportReachCriteria: The report criteria for a report of type
-// "REACH".
-type ReportReachCriteria struct {
- // Activities: Activity group.
- Activities *Activities `json:"activities,omitempty"`
-
- // CustomRichMediaEvents: Custom Rich Media Events group.
- CustomRichMediaEvents *CustomRichMediaEvents `json:"customRichMediaEvents,omitempty"`
-
- // DateRange: The date range this report should be run for.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // DimensionFilters: The list of filters on which dimensions are
- // filtered.
- // Filters for different dimensions are ANDed, filters for the same
- // dimension are grouped together and ORed.
- DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`
-
- // Dimensions: The list of dimensions the report should include.
- Dimensions []*SortedDimension `json:"dimensions,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ReachByFrequencyMetricNames: The list of names of Reach By Frequency
- // metrics the report should include.
- ReachByFrequencyMetricNames []string `json:"reachByFrequencyMetricNames,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Activities") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportReachCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportReachCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportSchedule: The report's schedule. Can only be set if the
-// report's 'dateRange' is a relative date range and the relative date
-// range is not "TODAY".
-type ReportSchedule struct {
- // Active: Whether the schedule is active or not. Must be set to either
- // true or false.
- Active bool `json:"active,omitempty"`
-
- // Every: Defines every how many days, weeks or months the report should
- // be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or
- // "MONTHLY".
- Every int64 `json:"every,omitempty"`
-
- // ExpirationDate: The expiration date when the scheduled report stops
- // running.
- ExpirationDate string `json:"expirationDate,omitempty"`
-
- // Repeats: The interval for which the report is repeated, one of:
- // - "DAILY", also requires field "every" to be set.
- // - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to
- // be set.
- // - "TWICE_A_MONTH"
- // - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to
- // be set.
- // - "QUARTERLY"
- // - "YEARLY"
- Repeats string `json:"repeats,omitempty"`
-
- // RepeatsOnWeekDays: List of week days "WEEKLY" on which scheduled
- // reports should run.
- RepeatsOnWeekDays []string `json:"repeatsOnWeekDays,omitempty"`
-
- // RunsOnDayOfMonth: Enum to define for "MONTHLY" scheduled reports
- // whether reports should be repeated on the same day of the month as
- // "startDate" or the same day of the week of the month. Possible values
- // are:
- // - DAY_OF_MONTH
- // - WEEK_OF_MONTH
- // Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02),
- // "DAY_OF_MONTH" would run subsequent reports on the 2nd of every
- // Month, and "WEEK_OF_MONTH" would run subsequent reports on the first
- // Monday of the month.
- RunsOnDayOfMonth string `json:"runsOnDayOfMonth,omitempty"`
-
- // StartDate: Start date of date range for which scheduled reports
- // should be run.
- StartDate string `json:"startDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Active") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportSchedule) MarshalJSON() ([]byte, error) {
- type noMethod ReportSchedule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportList: Represents the list of reports.
-type ReportList struct {
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The reports returned in this response.
- Items []*Report `json:"items,omitempty"`
-
- // Kind: The kind of list this is, in this case dfareporting#reportList.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through reports. To
- // retrieve the next page of results, set the next request's "pageToken"
- // to the value of this field. The page token is only valid for a
- // limited amount of time and should not be persisted.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportList) MarshalJSON() ([]byte, error) {
- type noMethod ReportList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SortedDimension: Represents a sorted dimension.
-type SortedDimension struct {
- // Kind: The kind of resource this is, in this case
- // dfareporting#sortedDimension.
- Kind string `json:"kind,omitempty"`
-
- // Name: The name of the dimension.
- Name string `json:"name,omitempty"`
-
- // SortOrder: An optional sort order for the dimension column, one of:
- //
- // - "ASCENDING"
- // - "DESCENDING"
- SortOrder string `json:"sortOrder,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SortedDimension) MarshalJSON() ([]byte, error) {
- type noMethod SortedDimension
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserProfile: Represents a UserProfile resource.
-type UserProfile struct {
- // AccountId: The account ID to which this profile belongs.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AccountName: The account name this profile belongs to.
- AccountName string `json:"accountName,omitempty"`
-
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#userProfile.
- Kind string `json:"kind,omitempty"`
-
- // ProfileId: The unique ID of the user profile.
- ProfileId int64 `json:"profileId,omitempty,string"`
-
- // SubAccountId: The sub account ID this profile belongs to if
- // applicable.
- SubAccountId int64 `json:"subAccountId,omitempty,string"`
-
- // SubAccountName: The sub account name this profile belongs to if
- // applicable.
- SubAccountName string `json:"subAccountName,omitempty"`
-
- // UserName: The user name.
- UserName string `json:"userName,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserProfile) MarshalJSON() ([]byte, error) {
- type noMethod UserProfile
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserProfileList: Represents the list of user profiles.
-type UserProfileList struct {
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The user profiles returned in this response.
- Items []*UserProfile `json:"items,omitempty"`
-
- // Kind: The kind of list this is, in this case
- // dfareporting#userProfileList.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserProfileList) MarshalJSON() ([]byte, error) {
- type noMethod UserProfileList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "dfareporting.dimensionValues.query":
-
-type DimensionValuesQueryCall struct {
- s *Service
- profileId int64
- dimensionvaluerequest *DimensionValueRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Query: Retrieves list of report dimension values for a list of
-// filters.
-func (r *DimensionValuesService) Query(profileId int64, dimensionvaluerequest *DimensionValueRequest) *DimensionValuesQueryCall {
- c := &DimensionValuesQueryCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.dimensionvaluerequest = dimensionvaluerequest
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *DimensionValuesQueryCall) MaxResults(maxResults int64) *DimensionValuesQueryCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous result page.
-func (c *DimensionValuesQueryCall) PageToken(pageToken string) *DimensionValuesQueryCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DimensionValuesQueryCall) Fields(s ...googleapi.Field) *DimensionValuesQueryCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DimensionValuesQueryCall) Context(ctx context.Context) *DimensionValuesQueryCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DimensionValuesQueryCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.dimensionvaluerequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/dimensionvalues/query")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.dimensionValues.query" call.
-// Exactly one of *DimensionValueList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *DimensionValueList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DimensionValuesQueryCall) Do() (*DimensionValueList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DimensionValueList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves list of report dimension values for a list of filters.",
- // "httpMethod": "POST",
- // "id": "dfareporting.dimensionValues.query",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "100",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/dimensionvalues/query",
- // "request": {
- // "$ref": "DimensionValueRequest"
- // },
- // "response": {
- // "$ref": "DimensionValueList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.files.list":
-
-type FilesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists files for a user profile.
-func (r *FilesService) List(profileId int64) *FilesListCall {
- c := &FilesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *FilesListCall) MaxResults(maxResults int64) *FilesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous result page.
-func (c *FilesListCall) PageToken(pageToken string) *FilesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SortField sets the optional parameter "sortField": The field by which
-// to sort the list.
-//
-// Possible values:
-// "ID" - Sort by file ID.
-// "LAST_MODIFIED_TIME" (default) - Sort by 'lastmodifiedAt' field.
-func (c *FilesListCall) SortField(sortField string) *FilesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is 'DESCENDING'.
-//
-// Possible values:
-// "ASCENDING" - Ascending order.
-// "DESCENDING" (default) - Descending order.
-func (c *FilesListCall) SortOrder(sortOrder string) *FilesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FilesListCall) Fields(s ...googleapi.Field) *FilesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *FilesListCall) IfNoneMatch(entityTag string) *FilesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FilesListCall) Context(ctx context.Context) *FilesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FilesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/files")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.files.list" call.
-// Exactly one of *FileList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *FileList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *FilesListCall) Do() (*FileList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FileList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists files for a user profile.",
- // "httpMethod": "GET",
- // "id": "dfareporting.files.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "sortField": {
- // "default": "LAST_MODIFIED_TIME",
- // "description": "The field by which to sort the list.",
- // "enum": [
- // "ID",
- // "LAST_MODIFIED_TIME"
- // ],
- // "enumDescriptions": [
- // "Sort by file ID.",
- // "Sort by 'lastmodifiedAt' field."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "default": "DESCENDING",
- // "description": "Order of sorted results, default is 'DESCENDING'.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "Ascending order.",
- // "Descending order."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/files",
- // "response": {
- // "$ref": "FileList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.delete":
-
-type ReportsDeleteCall struct {
- s *Service
- profileId int64
- reportId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes a report by its ID.
-func (r *ReportsService) Delete(profileId int64, reportId int64) *ReportsDeleteCall {
- c := &ReportsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsDeleteCall) Fields(s ...googleapi.Field) *ReportsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsDeleteCall) Context(ctx context.Context) *ReportsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.delete" call.
-func (c *ReportsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes a report by its ID.",
- // "httpMethod": "DELETE",
- // "id": "dfareporting.reports.delete",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.get":
-
-type ReportsGetCall struct {
- s *Service
- profileId int64
- reportId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves a report by its ID.
-func (r *ReportsService) Get(profileId int64, reportId int64) *ReportsGetCall {
- c := &ReportsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsGetCall) Fields(s ...googleapi.Field) *ReportsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsGetCall) IfNoneMatch(entityTag string) *ReportsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsGetCall) Context(ctx context.Context) *ReportsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.get" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsGetCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a report by its ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.reports.get",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}",
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.insert":
-
-type ReportsInsertCall struct {
- s *Service
- profileId int64
- report *Report
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a report.
-func (r *ReportsService) Insert(profileId int64, report *Report) *ReportsInsertCall {
- c := &ReportsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.report = report
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsInsertCall) Fields(s ...googleapi.Field) *ReportsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsInsertCall) Context(ctx context.Context) *ReportsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.report)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.insert" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsInsertCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a report.",
- // "httpMethod": "POST",
- // "id": "dfareporting.reports.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports",
- // "request": {
- // "$ref": "Report"
- // },
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.list":
-
-type ReportsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves list of reports.
-func (r *ReportsService) List(profileId int64) *ReportsListCall {
- c := &ReportsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *ReportsListCall) MaxResults(maxResults int64) *ReportsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous result page.
-func (c *ReportsListCall) PageToken(pageToken string) *ReportsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SortField sets the optional parameter "sortField": The field by which
-// to sort the list.
-//
-// Possible values:
-// "ID" - Sort by report ID.
-// "LAST_MODIFIED_TIME" (default) - Sort by 'lastModifiedTime' field.
-// "NAME" - Sort by name of reports.
-func (c *ReportsListCall) SortField(sortField string) *ReportsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is 'DESCENDING'.
-//
-// Possible values:
-// "ASCENDING" - Ascending order.
-// "DESCENDING" (default) - Descending order.
-func (c *ReportsListCall) SortOrder(sortOrder string) *ReportsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsListCall) Fields(s ...googleapi.Field) *ReportsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsListCall) IfNoneMatch(entityTag string) *ReportsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsListCall) Context(ctx context.Context) *ReportsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.list" call.
-// Exactly one of *ReportList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ReportList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ReportsListCall) Do() (*ReportList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ReportList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves list of reports.",
- // "httpMethod": "GET",
- // "id": "dfareporting.reports.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "sortField": {
- // "default": "LAST_MODIFIED_TIME",
- // "description": "The field by which to sort the list.",
- // "enum": [
- // "ID",
- // "LAST_MODIFIED_TIME",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "Sort by report ID.",
- // "Sort by 'lastModifiedTime' field.",
- // "Sort by name of reports."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "default": "DESCENDING",
- // "description": "Order of sorted results, default is 'DESCENDING'.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "Ascending order.",
- // "Descending order."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports",
- // "response": {
- // "$ref": "ReportList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.patch":
-
-type ReportsPatchCall struct {
- s *Service
- profileId int64
- reportId int64
- report *Report
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates a report. This method supports patch semantics.
-func (r *ReportsService) Patch(profileId int64, reportId int64, report *Report) *ReportsPatchCall {
- c := &ReportsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- c.report = report
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsPatchCall) Fields(s ...googleapi.Field) *ReportsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsPatchCall) Context(ctx context.Context) *ReportsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.report)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.patch" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsPatchCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a report. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.reports.patch",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}",
- // "request": {
- // "$ref": "Report"
- // },
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.run":
-
-type ReportsRunCall struct {
- s *Service
- profileId int64
- reportId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Run: Runs a report.
-func (r *ReportsService) Run(profileId int64, reportId int64) *ReportsRunCall {
- c := &ReportsRunCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- return c
-}
-
-// Synchronous sets the optional parameter "synchronous": If set and
-// true, tries to run the report synchronously.
-func (c *ReportsRunCall) Synchronous(synchronous bool) *ReportsRunCall {
- c.opt_["synchronous"] = synchronous
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsRunCall) Fields(s ...googleapi.Field) *ReportsRunCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsRunCall) Context(ctx context.Context) *ReportsRunCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsRunCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["synchronous"]; ok {
- params.Set("synchronous", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}/run")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.run" call.
-// Exactly one of *File or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *File.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *ReportsRunCall) Do() (*File, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &File{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Runs a report.",
- // "httpMethod": "POST",
- // "id": "dfareporting.reports.run",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "synchronous": {
- // "description": "If set and true, tries to run the report synchronously.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}/run",
- // "response": {
- // "$ref": "File"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.update":
-
-type ReportsUpdateCall struct {
- s *Service
- profileId int64
- reportId int64
- report *Report
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates a report.
-func (r *ReportsService) Update(profileId int64, reportId int64, report *Report) *ReportsUpdateCall {
- c := &ReportsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- c.report = report
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsUpdateCall) Fields(s ...googleapi.Field) *ReportsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsUpdateCall) Context(ctx context.Context) *ReportsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.report)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.update" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsUpdateCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a report.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.reports.update",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}",
- // "request": {
- // "$ref": "Report"
- // },
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.files.get":
-
-type ReportsFilesGetCall struct {
- s *Service
- profileId int64
- reportId int64
- fileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves a report file.
-func (r *ReportsFilesService) Get(profileId int64, reportId int64, fileId int64) *ReportsFilesGetCall {
- c := &ReportsFilesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- c.fileId = fileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsFilesGetCall) Fields(s ...googleapi.Field) *ReportsFilesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsFilesGetCall) IfNoneMatch(entityTag string) *ReportsFilesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsFilesGetCall) Context(ctx context.Context) *ReportsFilesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsFilesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}/files/{fileId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- "fileId": strconv.FormatInt(c.fileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.files.get" call.
-// Exactly one of *File or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *File.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *ReportsFilesGetCall) Do() (*File, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &File{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a report file.",
- // "httpMethod": "GET",
- // "id": "dfareporting.reports.files.get",
- // "parameterOrder": [
- // "profileId",
- // "reportId",
- // "fileId"
- // ],
- // "parameters": {
- // "fileId": {
- // "description": "The ID of the report file.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}/files/{fileId}",
- // "response": {
- // "$ref": "File"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.files.list":
-
-type ReportsFilesListCall struct {
- s *Service
- profileId int64
- reportId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists files for a report.
-func (r *ReportsFilesService) List(profileId int64, reportId int64) *ReportsFilesListCall {
- c := &ReportsFilesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *ReportsFilesListCall) MaxResults(maxResults int64) *ReportsFilesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous result page.
-func (c *ReportsFilesListCall) PageToken(pageToken string) *ReportsFilesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SortField sets the optional parameter "sortField": The field by which
-// to sort the list.
-//
-// Possible values:
-// "ID" - Sort by file ID.
-// "LAST_MODIFIED_TIME" (default) - Sort by 'lastmodifiedAt' field.
-func (c *ReportsFilesListCall) SortField(sortField string) *ReportsFilesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is 'DESCENDING'.
-//
-// Possible values:
-// "ASCENDING" - Ascending order.
-// "DESCENDING" (default) - Descending order.
-func (c *ReportsFilesListCall) SortOrder(sortOrder string) *ReportsFilesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsFilesListCall) Fields(s ...googleapi.Field) *ReportsFilesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsFilesListCall) IfNoneMatch(entityTag string) *ReportsFilesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsFilesListCall) Context(ctx context.Context) *ReportsFilesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsFilesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}/files")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.files.list" call.
-// Exactly one of *FileList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *FileList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ReportsFilesListCall) Do() (*FileList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FileList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists files for a report.",
- // "httpMethod": "GET",
- // "id": "dfareporting.reports.files.list",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the parent report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "sortField": {
- // "default": "LAST_MODIFIED_TIME",
- // "description": "The field by which to sort the list.",
- // "enum": [
- // "ID",
- // "LAST_MODIFIED_TIME"
- // ],
- // "enumDescriptions": [
- // "Sort by file ID.",
- // "Sort by 'lastmodifiedAt' field."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "default": "DESCENDING",
- // "description": "Order of sorted results, default is 'DESCENDING'.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "Ascending order.",
- // "Descending order."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}/files",
- // "response": {
- // "$ref": "FileList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userProfiles.get":
-
-type UserProfilesGetCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one user profile by ID.
-func (r *UserProfilesService) Get(profileId int64) *UserProfilesGetCall {
- c := &UserProfilesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserProfilesGetCall) Fields(s ...googleapi.Field) *UserProfilesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UserProfilesGetCall) IfNoneMatch(entityTag string) *UserProfilesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserProfilesGetCall) Context(ctx context.Context) *UserProfilesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserProfilesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userProfiles.get" call.
-// Exactly one of *UserProfile or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UserProfile.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UserProfilesGetCall) Do() (*UserProfile, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserProfile{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one user profile by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.userProfiles.get",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}",
- // "response": {
- // "$ref": "UserProfile"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userProfiles.list":
-
-type UserProfilesListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves list of user profiles for a user.
-func (r *UserProfilesService) List() *UserProfilesListCall {
- c := &UserProfilesListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserProfilesListCall) Fields(s ...googleapi.Field) *UserProfilesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UserProfilesListCall) IfNoneMatch(entityTag string) *UserProfilesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserProfilesListCall) Context(ctx context.Context) *UserProfilesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserProfilesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userProfiles.list" call.
-// Exactly one of *UserProfileList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UserProfileList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *UserProfilesListCall) Do() (*UserProfileList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserProfileList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves list of user profiles for a user.",
- // "httpMethod": "GET",
- // "id": "dfareporting.userProfiles.list",
- // "path": "userprofiles",
- // "response": {
- // "$ref": "UserProfileList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/dfareporting/v1.2/dfareporting-api.json b/vendor/google.golang.org/api/dfareporting/v1.2/dfareporting-api.json
deleted file mode 100644
index f1e7eec4..00000000
--- a/vendor/google.golang.org/api/dfareporting/v1.2/dfareporting-api.json
+++ /dev/null
@@ -1,1589 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/rEBgz8kDYnXeo29fy2HTElYO_nc\"",
- "discoveryVersion": "v1",
- "id": "dfareporting:v1.2",
- "name": "dfareporting",
- "version": "v1.2",
- "revision": "20141112",
- "title": "DFA Reporting API",
- "description": "Lets you create, run and download reports.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/doubleclick-advertisers/reporting/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/dfareporting/v1.2/",
- "basePath": "/dfareporting/v1.2/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "dfareporting/v1.2/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/dfareporting": {
- "description": "View and manage DoubleClick for Advertisers reports"
- }
- }
- }
- },
- "schemas": {
- "Activities": {
- "id": "Activities",
- "type": "object",
- "description": "Represents an activity group.",
- "properties": {
- "filters": {
- "type": "array",
- "description": "List of activity filters. The dimension values need to be all either of type \"dfa:activity\" or \"dfa:activityGroup\".",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#activities.",
- "default": "dfareporting#activities"
- },
- "metricNames": {
- "type": "array",
- "description": "List of names of floodlight activity metrics.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "CustomRichMediaEvents": {
- "id": "CustomRichMediaEvents",
- "type": "object",
- "description": "Represents a Custom Rich Media Events group.",
- "properties": {
- "filteredEventIds": {
- "type": "array",
- "description": "List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#customRichMediaEvents.",
- "default": "dfareporting#customRichMediaEvents"
- }
- }
- },
- "DateRange": {
- "id": "DateRange",
- "type": "object",
- "description": "Represents a date range.",
- "properties": {
- "endDate": {
- "type": "string",
- "description": "The end date of the date range, inclusive. A string of the format: \"yyyy-MM-dd\".",
- "format": "date"
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#dateRange.",
- "default": "dfareporting#dateRange"
- },
- "relativeDateRange": {
- "type": "string",
- "description": "The date range relative to the date of when the report is run, one of: \n- \"TODAY\" \n- \"YESTERDAY\" \n- \"WEEK_TO_DATE\" \n- \"MONTH_TO_DATE\" \n- \"QUARTER_TO_DATE\" \n- \"YEAR_TO_DATE\" \n- \"PREVIOUS_WEEK\" \n- \"PREVIOUS_MONTH\" \n- \"PREVIOUS_QUARTER\" \n- \"PREVIOUS_YEAR\" \n- \"LAST_7_DAYS\" \n- \"LAST_30_DAYS\" \n- \"LAST_90_DAYS\" \n- \"LAST_365_DAYS\" \n- \"LAST_24_MONTHS\""
- },
- "startDate": {
- "type": "string",
- "description": "The start date of the date range, inclusive. A string of the format: \"yyyy-MM-dd\".",
- "format": "date"
- }
- }
- },
- "DimensionFilter": {
- "id": "DimensionFilter",
- "type": "object",
- "description": "Represents a dimension filter.",
- "properties": {
- "dimensionName": {
- "type": "string",
- "description": "The name of the dimension to filter."
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#dimensionFilter.",
- "default": "dfareporting#dimensionFilter"
- },
- "value": {
- "type": "string",
- "description": "The value of the dimension to filter."
- }
- }
- },
- "DimensionValue": {
- "id": "DimensionValue",
- "type": "object",
- "description": "Represents a DimensionValue resource.",
- "properties": {
- "dimensionName": {
- "type": "string",
- "description": "The name of the dimension."
- },
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "id": {
- "type": "string",
- "description": "The ID associated with the value if available."
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#dimensionValue.",
- "default": "dfareporting#dimensionValue"
- },
- "matchType": {
- "type": "string",
- "description": "Determines how the 'value' field is matched when filtering. One of: \n- EXACT (default if not specified) \n- CONTAINS \n- BEGINS_WITH \n- WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT."
- },
- "value": {
- "type": "string",
- "description": "The value of the dimension."
- }
- }
- },
- "DimensionValueList": {
- "id": "DimensionValueList",
- "type": "object",
- "description": "Represents the list of DimensionValue resources.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The dimension values returned in this response.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of list this is, in this case dfareporting#dimensionValueList.",
- "default": "dfareporting#dimensionValueList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted."
- }
- }
- },
- "DimensionValueRequest": {
- "id": "DimensionValueRequest",
- "type": "object",
- "description": "Represents a DimensionValuesRequest.",
- "properties": {
- "dimensionName": {
- "type": "string",
- "description": "The name of the dimension for which values should be requested."
- },
- "endDate": {
- "type": "string",
- "description": "The end date of the date range for which to retrieve dimension values. A string of the format: \"yyyy-MM-dd\".",
- "format": "date"
- },
- "filters": {
- "type": "array",
- "description": "The list of filters by which to filter values. The filters are ANDed.",
- "items": {
- "$ref": "DimensionFilter"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of request this is, in this case dfareporting#dimensionValueRequest.",
- "default": "dfareporting#dimensionValueRequest"
- },
- "startDate": {
- "type": "string",
- "description": "The start date of the date range for which to retrieve dimension values. A string of the format: \"yyyy-MM-dd\".",
- "format": "date"
- }
- }
- },
- "File": {
- "id": "File",
- "type": "object",
- "description": "Represents a File resource. A File contains the meta-data for a report run. It shows the status of the run and holds the urls to the generated report data if the run is finished and the status is \"REPORT_AVAILABLE\".",
- "properties": {
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range for which the file has report data. The date range will always be the absolute date range for which the report is run."
- },
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "fileName": {
- "type": "string",
- "description": "The file name of the file."
- },
- "format": {
- "type": "string",
- "description": "The output format of the report. Only available once the file is available."
- },
- "id": {
- "type": "string",
- "description": "The unique ID of this report file.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#file.",
- "default": "dfareporting#file"
- },
- "lastModifiedTime": {
- "type": "string",
- "description": "The timestamp in milliseconds since epoch when this file was last modified.",
- "format": "int64"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report this file was generated from.",
- "format": "int64"
- },
- "status": {
- "type": "string",
- "description": "The status of the report file, one of: \n- \"PROCESSING\" \n- \"REPORT_AVAILABLE\" \n- \"FAILED\" \n- \"CANCELLED\""
- },
- "urls": {
- "type": "object",
- "description": "The urls where the completed report file can be downloaded.",
- "properties": {
- "apiUrl": {
- "type": "string",
- "description": "The url for downloading the report data through the API."
- },
- "browserUrl": {
- "type": "string",
- "description": "The url for downloading the report data through a browser."
- }
- }
- }
- }
- },
- "FileList": {
- "id": "FileList",
- "type": "object",
- "description": "Represents the list of File resources.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The files returned in this response.",
- "items": {
- "$ref": "File"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of list this is, in this case dfareporting#fileList.",
- "default": "dfareporting#fileList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through files. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted."
- }
- }
- },
- "Recipient": {
- "id": "Recipient",
- "type": "object",
- "description": "Represents a recipient.",
- "properties": {
- "deliveryType": {
- "type": "string",
- "description": "The delivery type for the recipient, one of: \n- \"ATTACHMENT\" \n- \"LINK\"",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "email": {
- "type": "string",
- "description": "The email address of the recipient.",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#recipient.",
- "default": "dfareporting#recipient"
- }
- }
- },
- "Report": {
- "id": "Report",
- "type": "object",
- "description": "Represents a Report resource.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The account ID to which this report belongs.",
- "format": "int64",
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- }
- },
- "activeGrpCriteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"ACTIVE_GRP\".",
- "properties": {
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimensionFilters": {
- "type": "array",
- "description": "The list of filters on which dimensions are filtered.\nFilters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.\nA valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "criteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"STANDARD\".",
- "properties": {
- "activities": {
- "$ref": "Activities",
- "description": "Activity group."
- },
- "customRichMediaEvents": {
- "$ref": "CustomRichMediaEvents",
- "description": "Custom Rich Media Events group."
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range for which this report should be run."
- },
- "dimensionFilters": {
- "type": "array",
- "description": "The list of filters on which dimensions are filtered.\nFilters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "The list of standard dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "crossDimensionReachCriteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"CROSS_DIMENSION_REACH\".",
- "properties": {
- "breakdown": {
- "type": "array",
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimension": {
- "type": "string",
- "description": "The dimension option, one of: \n- \"ADVERTISER\" \n- \"CAMPAIGN\" \n- \"SITE_BY_ADVERTISER\" \n- \"SITE_BY_CAMPAIGN\""
- },
- "dimensionFilters": {
- "type": "array",
- "description": "The list of filters on which dimensions are filtered.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "overlapMetricNames": {
- "type": "array",
- "description": "The list of names of overlap metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "pivoted": {
- "type": "boolean",
- "description": "Whether the report is pivoted or not. Defaults to true."
- }
- }
- },
- "delivery": {
- "type": "object",
- "description": "The report's email delivery settings.",
- "properties": {
- "emailOwner": {
- "type": "boolean",
- "description": "Whether the report should be emailed to the report owner."
- },
- "emailOwnerDeliveryType": {
- "type": "string",
- "description": "The type of delivery for the owner to receive, if enabled. One of: \n- \"ATTACHMENT\" \n- \"LINK\""
- },
- "message": {
- "type": "string",
- "description": "The message to be sent with each email."
- },
- "recipients": {
- "type": "array",
- "description": "The list of recipients to which to email the report.",
- "items": {
- "$ref": "Recipient"
- }
- }
- }
- },
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "fileName": {
- "type": "string",
- "description": "The file name used when generating report files for this report."
- },
- "floodlightCriteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"FLOODLIGHT\".",
- "properties": {
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimensionFilters": {
- "type": "array",
- "description": "The list of filters on which dimensions are filtered.\nFilters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "floodlightConfigId": {
- "$ref": "DimensionValue",
- "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "reportProperties": {
- "type": "object",
- "description": "The properties of the report.",
- "properties": {
- "includeAttributedIPConversions": {
- "type": "boolean",
- "description": "Include conversions that have no cookie, but do have an exposure path."
- },
- "includeUnattributedCookieConversions": {
- "type": "boolean",
- "description": "Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window."
- },
- "includeUnattributedIPConversions": {
- "type": "boolean",
- "description": "Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion."
- }
- }
- }
- }
- },
- "format": {
- "type": "string",
- "description": "The output format of the report, one of: \n- \"CSV\" \n- \"EXCEL\" If not specified, default format is \"CSV\". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. \"CSV\" will then be the fallback format."
- },
- "id": {
- "type": "string",
- "description": "The unique ID identifying this report resource.",
- "format": "int64",
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#report.",
- "default": "dfareporting#report"
- },
- "lastModifiedTime": {
- "type": "string",
- "description": "The timestamp (in milliseconds since epoch) of when this report was last modified.",
- "format": "uint64",
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- }
- },
- "name": {
- "type": "string",
- "description": "The name of the report.",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "ownerProfileId": {
- "type": "string",
- "description": "The user profile id of the owner of this report.",
- "format": "int64",
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- }
- },
- "pathToConversionCriteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"PATH_TO_CONVERSION\".",
- "properties": {
- "activityFilters": {
- "type": "array",
- "description": "The list of 'dfa:activity' values to filter on.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "conversionDimensions": {
- "type": "array",
- "description": "The list of conversion dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "customFloodlightVariables": {
- "type": "array",
- "description": "The list of custom floodlight variables the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "floodlightConfigId": {
- "$ref": "DimensionValue",
- "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "perInteractionDimensions": {
- "type": "array",
- "description": "The list of per interaction dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "reportProperties": {
- "type": "object",
- "description": "The properties of the report.",
- "properties": {
- "clicksLookbackWindow": {
- "type": "integer",
- "description": "DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.",
- "format": "int32"
- },
- "impressionsLookbackWindow": {
- "type": "integer",
- "description": "DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.",
- "format": "int32"
- },
- "includeAttributedIPConversions": {
- "type": "boolean",
- "description": "Include conversions that have no cookie, but do have an exposure path."
- },
- "includeUnattributedCookieConversions": {
- "type": "boolean",
- "description": "Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window."
- },
- "includeUnattributedIPConversions": {
- "type": "boolean",
- "description": "Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion."
- },
- "maximumClickInteractions": {
- "type": "integer",
- "description": "The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.",
- "format": "int32"
- },
- "maximumImpressionInteractions": {
- "type": "integer",
- "description": "The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.",
- "format": "int32"
- },
- "maximumInteractionGap": {
- "type": "integer",
- "description": "The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.",
- "format": "int32"
- },
- "pivotOnInteractionPath": {
- "type": "boolean",
- "description": "Enable pivoting on interaction path."
- }
- }
- }
- }
- },
- "reachCriteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"REACH\".",
- "properties": {
- "activities": {
- "$ref": "Activities",
- "description": "Activity group."
- },
- "customRichMediaEvents": {
- "$ref": "CustomRichMediaEvents",
- "description": "Custom Rich Media Events group."
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimensionFilters": {
- "type": "array",
- "description": "The list of filters on which dimensions are filtered.\nFilters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "reachByFrequencyMetricNames": {
- "type": "array",
- "description": "The list of names of Reach By Frequency metrics the report should include.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "schedule": {
- "type": "object",
- "description": "The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not \"TODAY\".",
- "properties": {
- "active": {
- "type": "boolean",
- "description": "Whether the schedule is active or not. Must be set to either true or false.",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "every": {
- "type": "integer",
- "description": "Defines every how many days, weeks or months the report should be run. Needs to be set when \"repeats\" is either \"DAILY\", \"WEEKLY\" or \"MONTHLY\".",
- "format": "int32"
- },
- "expirationDate": {
- "type": "string",
- "description": "The expiration date when the scheduled report stops running.",
- "format": "date",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "repeats": {
- "type": "string",
- "description": "The interval for which the report is repeated, one of: \n- \"DAILY\", also requires field \"every\" to be set. \n- \"WEEKLY\", also requires fields \"every\" and \"repeatsOnWeekDays\" to be set. \n- \"TWICE_A_MONTH\" \n- \"MONTHLY\", also requires fields \"every\" and \"runsOnDayOfMonth\" to be set. \n- \"QUARTERLY\" \n- \"YEARLY\"",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "repeatsOnWeekDays": {
- "type": "array",
- "description": "List of week days \"WEEKLY\" on which scheduled reports should run.",
- "items": {
- "type": "string"
- }
- },
- "runsOnDayOfMonth": {
- "type": "string",
- "description": "Enum to define for \"MONTHLY\" scheduled reports whether reports should be repeated on the same day of the month as \"startDate\" or the same day of the week of the month. Possible values are: \n- DAY_OF_MONTH \n- WEEK_OF_MONTH \nExample: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), \"DAY_OF_MONTH\" would run subsequent reports on the 2nd of every Month, and \"WEEK_OF_MONTH\" would run subsequent reports on the first Monday of the month."
- },
- "startDate": {
- "type": "string",
- "description": "Start date of date range for which scheduled reports should be run.",
- "format": "date",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- }
- }
- },
- "subAccountId": {
- "type": "string",
- "description": "The subbaccount ID to which this report belongs if applicable.",
- "format": "int64"
- },
- "type": {
- "type": "string",
- "description": "The type of the report, one of: \n- STANDARD \n- REACH \n- ACTIVE_GRP \n- PATH_TO_CONVERSION \n- FLOODLIGHT \n- CROSS_DIMENSION_REACH",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- }
- }
- },
- "ReportList": {
- "id": "ReportList",
- "type": "object",
- "description": "Represents the list of reports.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The reports returned in this response.",
- "items": {
- "$ref": "Report"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of list this is, in this case dfareporting#reportList.",
- "default": "dfareporting#reportList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through reports. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted."
- }
- }
- },
- "SortedDimension": {
- "id": "SortedDimension",
- "type": "object",
- "description": "Represents a sorted dimension.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#sortedDimension.",
- "default": "dfareporting#sortedDimension"
- },
- "name": {
- "type": "string",
- "description": "The name of the dimension."
- },
- "sortOrder": {
- "type": "string",
- "description": "An optional sort order for the dimension column, one of: \n- \"ASCENDING\" \n- \"DESCENDING\""
- }
- }
- },
- "UserProfile": {
- "id": "UserProfile",
- "type": "object",
- "description": "Represents a UserProfile resource.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The account ID to which this profile belongs.",
- "format": "int64"
- },
- "accountName": {
- "type": "string",
- "description": "The account name this profile belongs to."
- },
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#userProfile.",
- "default": "dfareporting#userProfile"
- },
- "profileId": {
- "type": "string",
- "description": "The unique ID of the user profile.",
- "format": "int64"
- },
- "subAccountId": {
- "type": "string",
- "description": "The sub account ID this profile belongs to if applicable.",
- "format": "int64"
- },
- "subAccountName": {
- "type": "string",
- "description": "The sub account name this profile belongs to if applicable."
- },
- "userName": {
- "type": "string",
- "description": "The user name."
- }
- }
- },
- "UserProfileList": {
- "id": "UserProfileList",
- "type": "object",
- "description": "Represents the list of user profiles.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The user profiles returned in this response.",
- "items": {
- "$ref": "UserProfile"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of list this is, in this case dfareporting#userProfileList.",
- "default": "dfareporting#userProfileList"
- }
- }
- }
- },
- "resources": {
- "dimensionValues": {
- "methods": {
- "query": {
- "id": "dfareporting.dimensionValues.query",
- "path": "userprofiles/{profileId}/dimensionvalues/query",
- "httpMethod": "POST",
- "description": "Retrieves list of report dimension values for a list of filters.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "DimensionValueRequest"
- },
- "response": {
- "$ref": "DimensionValueList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- },
- "files": {
- "methods": {
- "get": {
- "id": "dfareporting.files.get",
- "path": "reports/{reportId}/files/{fileId}",
- "httpMethod": "GET",
- "description": "Retrieves a report file by its report ID and file ID.",
- "parameters": {
- "fileId": {
- "type": "string",
- "description": "The ID of the report file.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "reportId",
- "fileId"
- ],
- "response": {
- "$ref": "File"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ],
- "supportsMediaDownload": true
- },
- "list": {
- "id": "dfareporting.files.list",
- "path": "userprofiles/{profileId}/files",
- "httpMethod": "GET",
- "description": "Lists files for a user profile.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "scope": {
- "type": "string",
- "description": "The scope that defines which results are returned, default is 'MINE'.",
- "default": "MINE",
- "enum": [
- "ALL",
- "MINE",
- "SHARED_WITH_ME"
- ],
- "enumDescriptions": [
- "All files in account.",
- "My files.",
- "Files shared with me."
- ],
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "The field by which to sort the list.",
- "default": "LAST_MODIFIED_TIME",
- "enum": [
- "ID",
- "LAST_MODIFIED_TIME"
- ],
- "enumDescriptions": [
- "Sort by file ID.",
- "Sort by 'lastmodifiedAt' field."
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is 'DESCENDING'.",
- "default": "DESCENDING",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "FileList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- },
- "reports": {
- "methods": {
- "delete": {
- "id": "dfareporting.reports.delete",
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "DELETE",
- "description": "Deletes a report by its ID.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "get": {
- "id": "dfareporting.reports.get",
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "GET",
- "description": "Retrieves a report by its ID.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "insert": {
- "id": "dfareporting.reports.insert",
- "path": "userprofiles/{profileId}/reports",
- "httpMethod": "POST",
- "description": "Creates a report.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "list": {
- "id": "dfareporting.reports.list",
- "path": "userprofiles/{profileId}/reports",
- "httpMethod": "GET",
- "description": "Retrieves list of reports.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "scope": {
- "type": "string",
- "description": "The scope that defines which results are returned, default is 'MINE'.",
- "default": "MINE",
- "enum": [
- "ALL",
- "MINE"
- ],
- "enumDescriptions": [
- "All reports in account.",
- "My reports."
- ],
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "The field by which to sort the list.",
- "default": "LAST_MODIFIED_TIME",
- "enum": [
- "ID",
- "LAST_MODIFIED_TIME",
- "NAME"
- ],
- "enumDescriptions": [
- "Sort by report ID.",
- "Sort by 'lastModifiedTime' field.",
- "Sort by name of reports."
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is 'DESCENDING'.",
- "default": "DESCENDING",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "ReportList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "patch": {
- "id": "dfareporting.reports.patch",
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "PATCH",
- "description": "Updates a report. This method supports patch semantics.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "run": {
- "id": "dfareporting.reports.run",
- "path": "userprofiles/{profileId}/reports/{reportId}/run",
- "httpMethod": "POST",
- "description": "Runs a report.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "synchronous": {
- "type": "boolean",
- "description": "If set and true, tries to run the report synchronously.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "response": {
- "$ref": "File"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "update": {
- "id": "dfareporting.reports.update",
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "PUT",
- "description": "Updates a report.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- },
- "resources": {
- "files": {
- "methods": {
- "get": {
- "id": "dfareporting.reports.files.get",
- "path": "userprofiles/{profileId}/reports/{reportId}/files/{fileId}",
- "httpMethod": "GET",
- "description": "Retrieves a report file.",
- "parameters": {
- "fileId": {
- "type": "string",
- "description": "The ID of the report file.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId",
- "fileId"
- ],
- "response": {
- "$ref": "File"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ],
- "supportsMediaDownload": true
- },
- "list": {
- "id": "dfareporting.reports.files.list",
- "path": "userprofiles/{profileId}/reports/{reportId}/files",
- "httpMethod": "GET",
- "description": "Lists files for a report.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the parent report.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "sortField": {
- "type": "string",
- "description": "The field by which to sort the list.",
- "default": "LAST_MODIFIED_TIME",
- "enum": [
- "ID",
- "LAST_MODIFIED_TIME"
- ],
- "enumDescriptions": [
- "Sort by file ID.",
- "Sort by 'lastmodifiedAt' field."
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is 'DESCENDING'.",
- "default": "DESCENDING",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "response": {
- "$ref": "FileList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- }
- }
- },
- "userProfiles": {
- "methods": {
- "get": {
- "id": "dfareporting.userProfiles.get",
- "path": "userprofiles/{profileId}",
- "httpMethod": "GET",
- "description": "Gets one user profile by ID.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "UserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "list": {
- "id": "dfareporting.userProfiles.list",
- "path": "userprofiles",
- "httpMethod": "GET",
- "description": "Retrieves list of user profiles for a user.",
- "response": {
- "$ref": "UserProfileList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/dfareporting/v1.2/dfareporting-gen.go b/vendor/google.golang.org/api/dfareporting/v1.2/dfareporting-gen.go
deleted file mode 100644
index a73ad0d6..00000000
--- a/vendor/google.golang.org/api/dfareporting/v1.2/dfareporting-gen.go
+++ /dev/null
@@ -1,3437 +0,0 @@
-// Package dfareporting provides access to the DFA Reporting API.
-//
-// See https://developers.google.com/doubleclick-advertisers/reporting/
-//
-// Usage example:
-//
-// import "google.golang.org/api/dfareporting/v1.2"
-// ...
-// dfareportingService, err := dfareporting.New(oauthHttpClient)
-package dfareporting // import "google.golang.org/api/dfareporting/v1.2"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "dfareporting:v1.2"
-const apiName = "dfareporting"
-const apiVersion = "v1.2"
-const basePath = "https://www.googleapis.com/dfareporting/v1.2/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage DoubleClick for Advertisers reports
- DfareportingScope = "https://www.googleapis.com/auth/dfareporting"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.DimensionValues = NewDimensionValuesService(s)
- s.Files = NewFilesService(s)
- s.Reports = NewReportsService(s)
- s.UserProfiles = NewUserProfilesService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- DimensionValues *DimensionValuesService
-
- Files *FilesService
-
- Reports *ReportsService
-
- UserProfiles *UserProfilesService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewDimensionValuesService(s *Service) *DimensionValuesService {
- rs := &DimensionValuesService{s: s}
- return rs
-}
-
-type DimensionValuesService struct {
- s *Service
-}
-
-func NewFilesService(s *Service) *FilesService {
- rs := &FilesService{s: s}
- return rs
-}
-
-type FilesService struct {
- s *Service
-}
-
-func NewReportsService(s *Service) *ReportsService {
- rs := &ReportsService{s: s}
- rs.Files = NewReportsFilesService(s)
- return rs
-}
-
-type ReportsService struct {
- s *Service
-
- Files *ReportsFilesService
-}
-
-func NewReportsFilesService(s *Service) *ReportsFilesService {
- rs := &ReportsFilesService{s: s}
- return rs
-}
-
-type ReportsFilesService struct {
- s *Service
-}
-
-func NewUserProfilesService(s *Service) *UserProfilesService {
- rs := &UserProfilesService{s: s}
- return rs
-}
-
-type UserProfilesService struct {
- s *Service
-}
-
-// Activities: Represents an activity group.
-type Activities struct {
- // Filters: List of activity filters. The dimension values need to be
- // all either of type "dfa:activity" or "dfa:activityGroup".
- Filters []*DimensionValue `json:"filters,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#activities.
- Kind string `json:"kind,omitempty"`
-
- // MetricNames: List of names of floodlight activity metrics.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Filters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Activities) MarshalJSON() ([]byte, error) {
- type noMethod Activities
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CustomRichMediaEvents: Represents a Custom Rich Media Events group.
-type CustomRichMediaEvents struct {
- // FilteredEventIds: List of custom rich media event IDs. Dimension
- // values must be all of type dfa:richMediaEventTypeIdAndName.
- FilteredEventIds []*DimensionValue `json:"filteredEventIds,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#customRichMediaEvents.
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "FilteredEventIds") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomRichMediaEvents) MarshalJSON() ([]byte, error) {
- type noMethod CustomRichMediaEvents
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DateRange: Represents a date range.
-type DateRange struct {
- // EndDate: The end date of the date range, inclusive. A string of the
- // format: "yyyy-MM-dd".
- EndDate string `json:"endDate,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#dateRange.
- Kind string `json:"kind,omitempty"`
-
- // RelativeDateRange: The date range relative to the date of when the
- // report is run, one of:
- // - "TODAY"
- // - "YESTERDAY"
- // - "WEEK_TO_DATE"
- // - "MONTH_TO_DATE"
- // - "QUARTER_TO_DATE"
- // - "YEAR_TO_DATE"
- // - "PREVIOUS_WEEK"
- // - "PREVIOUS_MONTH"
- // - "PREVIOUS_QUARTER"
- // - "PREVIOUS_YEAR"
- // - "LAST_7_DAYS"
- // - "LAST_30_DAYS"
- // - "LAST_90_DAYS"
- // - "LAST_365_DAYS"
- // - "LAST_24_MONTHS"
- RelativeDateRange string `json:"relativeDateRange,omitempty"`
-
- // StartDate: The start date of the date range, inclusive. A string of
- // the format: "yyyy-MM-dd".
- StartDate string `json:"startDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "EndDate") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DateRange) MarshalJSON() ([]byte, error) {
- type noMethod DateRange
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DimensionFilter: Represents a dimension filter.
-type DimensionFilter struct {
- // DimensionName: The name of the dimension to filter.
- DimensionName string `json:"dimensionName,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#dimensionFilter.
- Kind string `json:"kind,omitempty"`
-
- // Value: The value of the dimension to filter.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DimensionFilter) MarshalJSON() ([]byte, error) {
- type noMethod DimensionFilter
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DimensionValue: Represents a DimensionValue resource.
-type DimensionValue struct {
- // DimensionName: The name of the dimension.
- DimensionName string `json:"dimensionName,omitempty"`
-
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Id: The ID associated with the value if available.
- Id string `json:"id,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#dimensionValue.
- Kind string `json:"kind,omitempty"`
-
- // MatchType: Determines how the 'value' field is matched when
- // filtering. One of:
- // - EXACT (default if not specified)
- // - CONTAINS
- // - BEGINS_WITH
- // - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable
- // length character sequences, it can be escaped with a backslash.)
- // Note, only paid search dimensions ('dfa:paidSearch*') allow a
- // matchType other than EXACT.
- MatchType string `json:"matchType,omitempty"`
-
- // Value: The value of the dimension.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DimensionValue) MarshalJSON() ([]byte, error) {
- type noMethod DimensionValue
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DimensionValueList: Represents the list of DimensionValue resources.
-type DimensionValueList struct {
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The dimension values returned in this response.
- Items []*DimensionValue `json:"items,omitempty"`
-
- // Kind: The kind of list this is, in this case
- // dfareporting#dimensionValueList.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through dimension
- // values. To retrieve the next page of results, set the next request's
- // "pageToken" to the value of this field. The page token is only valid
- // for a limited amount of time and should not be persisted.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DimensionValueList) MarshalJSON() ([]byte, error) {
- type noMethod DimensionValueList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DimensionValueRequest: Represents a DimensionValuesRequest.
-type DimensionValueRequest struct {
- // DimensionName: The name of the dimension for which values should be
- // requested.
- DimensionName string `json:"dimensionName,omitempty"`
-
- // EndDate: The end date of the date range for which to retrieve
- // dimension values. A string of the format: "yyyy-MM-dd".
- EndDate string `json:"endDate,omitempty"`
-
- // Filters: The list of filters by which to filter values. The filters
- // are ANDed.
- Filters []*DimensionFilter `json:"filters,omitempty"`
-
- // Kind: The kind of request this is, in this case
- // dfareporting#dimensionValueRequest.
- Kind string `json:"kind,omitempty"`
-
- // StartDate: The start date of the date range for which to retrieve
- // dimension values. A string of the format: "yyyy-MM-dd".
- StartDate string `json:"startDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DimensionValueRequest) MarshalJSON() ([]byte, error) {
- type noMethod DimensionValueRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// File: Represents a File resource. A File contains the meta-data for a
-// report run. It shows the status of the run and holds the urls to the
-// generated report data if the run is finished and the status is
-// "REPORT_AVAILABLE".
-type File struct {
- // DateRange: The date range for which the file has report data. The
- // date range will always be the absolute date range for which the
- // report is run.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // FileName: The file name of the file.
- FileName string `json:"fileName,omitempty"`
-
- // Format: The output format of the report. Only available once the file
- // is available.
- Format string `json:"format,omitempty"`
-
- // Id: The unique ID of this report file.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: The kind of resource this is, in this case dfareporting#file.
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedTime: The timestamp in milliseconds since epoch when this
- // file was last modified.
- LastModifiedTime int64 `json:"lastModifiedTime,omitempty,string"`
-
- // ReportId: The ID of the report this file was generated from.
- ReportId int64 `json:"reportId,omitempty,string"`
-
- // Status: The status of the report file, one of:
- // - "PROCESSING"
- // - "REPORT_AVAILABLE"
- // - "FAILED"
- // - "CANCELLED"
- Status string `json:"status,omitempty"`
-
- // Urls: The urls where the completed report file can be downloaded.
- Urls *FileUrls `json:"urls,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "DateRange") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *File) MarshalJSON() ([]byte, error) {
- type noMethod File
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FileUrls: The urls where the completed report file can be downloaded.
-type FileUrls struct {
- // ApiUrl: The url for downloading the report data through the API.
- ApiUrl string `json:"apiUrl,omitempty"`
-
- // BrowserUrl: The url for downloading the report data through a
- // browser.
- BrowserUrl string `json:"browserUrl,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ApiUrl") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FileUrls) MarshalJSON() ([]byte, error) {
- type noMethod FileUrls
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FileList: Represents the list of File resources.
-type FileList struct {
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The files returned in this response.
- Items []*File `json:"items,omitempty"`
-
- // Kind: The kind of list this is, in this case dfareporting#fileList.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through files. To
- // retrieve the next page of results, set the next request's "pageToken"
- // to the value of this field. The page token is only valid for a
- // limited amount of time and should not be persisted.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FileList) MarshalJSON() ([]byte, error) {
- type noMethod FileList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Recipient: Represents a recipient.
-type Recipient struct {
- // DeliveryType: The delivery type for the recipient, one of:
- // - "ATTACHMENT"
- // - "LINK"
- DeliveryType string `json:"deliveryType,omitempty"`
-
- // Email: The email address of the recipient.
- Email string `json:"email,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#recipient.
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DeliveryType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Recipient) MarshalJSON() ([]byte, error) {
- type noMethod Recipient
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Report: Represents a Report resource.
-type Report struct {
- // AccountId: The account ID to which this report belongs.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // ActiveGrpCriteria: The report criteria for a report of type
- // "ACTIVE_GRP".
- ActiveGrpCriteria *ReportActiveGrpCriteria `json:"activeGrpCriteria,omitempty"`
-
- // Criteria: The report criteria for a report of type "STANDARD".
- Criteria *ReportCriteria `json:"criteria,omitempty"`
-
- // CrossDimensionReachCriteria: The report criteria for a report of type
- // "CROSS_DIMENSION_REACH".
- CrossDimensionReachCriteria *ReportCrossDimensionReachCriteria `json:"crossDimensionReachCriteria,omitempty"`
-
- // Delivery: The report's email delivery settings.
- Delivery *ReportDelivery `json:"delivery,omitempty"`
-
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // FileName: The file name used when generating report files for this
- // report.
- FileName string `json:"fileName,omitempty"`
-
- // FloodlightCriteria: The report criteria for a report of type
- // "FLOODLIGHT".
- FloodlightCriteria *ReportFloodlightCriteria `json:"floodlightCriteria,omitempty"`
-
- // Format: The output format of the report, one of:
- // - "CSV"
- // - "EXCEL" If not specified, default format is "CSV". Note that the
- // actual format in the completed report file might differ if for
- // instance the report's size exceeds the format's capabilities. "CSV"
- // will then be the fallback format.
- Format string `json:"format,omitempty"`
-
- // Id: The unique ID identifying this report resource.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: The kind of resource this is, in this case dfareporting#report.
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedTime: The timestamp (in milliseconds since epoch) of when
- // this report was last modified.
- LastModifiedTime uint64 `json:"lastModifiedTime,omitempty,string"`
-
- // Name: The name of the report.
- Name string `json:"name,omitempty"`
-
- // OwnerProfileId: The user profile id of the owner of this report.
- OwnerProfileId int64 `json:"ownerProfileId,omitempty,string"`
-
- // PathToConversionCriteria: The report criteria for a report of type
- // "PATH_TO_CONVERSION".
- PathToConversionCriteria *ReportPathToConversionCriteria `json:"pathToConversionCriteria,omitempty"`
-
- // ReachCriteria: The report criteria for a report of type "REACH".
- ReachCriteria *ReportReachCriteria `json:"reachCriteria,omitempty"`
-
- // Schedule: The report's schedule. Can only be set if the report's
- // 'dateRange' is a relative date range and the relative date range is
- // not "TODAY".
- Schedule *ReportSchedule `json:"schedule,omitempty"`
-
- // SubAccountId: The subbaccount ID to which this report belongs if
- // applicable.
- SubAccountId int64 `json:"subAccountId,omitempty,string"`
-
- // Type: The type of the report, one of:
- // - STANDARD
- // - REACH
- // - ACTIVE_GRP
- // - PATH_TO_CONVERSION
- // - FLOODLIGHT
- // - CROSS_DIMENSION_REACH
- Type string `json:"type,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Report) MarshalJSON() ([]byte, error) {
- type noMethod Report
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportActiveGrpCriteria: The report criteria for a report of type
-// "ACTIVE_GRP".
-type ReportActiveGrpCriteria struct {
- // DateRange: The date range this report should be run for.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // DimensionFilters: The list of filters on which dimensions are
- // filtered.
- // Filters for different dimensions are ANDed, filters for the same
- // dimension are grouped together and ORed.
- // A valid active GRP report needs to have exactly one DimensionValue
- // for the United States in addition to any advertiser or campaign
- // dimension values.
- DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`
-
- // Dimensions: The list of dimensions the report should include.
- Dimensions []*SortedDimension `json:"dimensions,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DateRange") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportActiveGrpCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportActiveGrpCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportCriteria: The report criteria for a report of type "STANDARD".
-type ReportCriteria struct {
- // Activities: Activity group.
- Activities *Activities `json:"activities,omitempty"`
-
- // CustomRichMediaEvents: Custom Rich Media Events group.
- CustomRichMediaEvents *CustomRichMediaEvents `json:"customRichMediaEvents,omitempty"`
-
- // DateRange: The date range for which this report should be run.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // DimensionFilters: The list of filters on which dimensions are
- // filtered.
- // Filters for different dimensions are ANDed, filters for the same
- // dimension are grouped together and ORed.
- DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`
-
- // Dimensions: The list of standard dimensions the report should
- // include.
- Dimensions []*SortedDimension `json:"dimensions,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Activities") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportCrossDimensionReachCriteria: The report criteria for a report
-// of type "CROSS_DIMENSION_REACH".
-type ReportCrossDimensionReachCriteria struct {
- // Breakdown: The list of dimensions the report should include.
- Breakdown []*SortedDimension `json:"breakdown,omitempty"`
-
- // DateRange: The date range this report should be run for.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // Dimension: The dimension option, one of:
- // - "ADVERTISER"
- // - "CAMPAIGN"
- // - "SITE_BY_ADVERTISER"
- // - "SITE_BY_CAMPAIGN"
- Dimension string `json:"dimension,omitempty"`
-
- // DimensionFilters: The list of filters on which dimensions are
- // filtered.
- DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // OverlapMetricNames: The list of names of overlap metrics the report
- // should include.
- OverlapMetricNames []string `json:"overlapMetricNames,omitempty"`
-
- // Pivoted: Whether the report is pivoted or not. Defaults to true.
- Pivoted bool `json:"pivoted,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Breakdown") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportCrossDimensionReachCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportCrossDimensionReachCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportDelivery: The report's email delivery settings.
-type ReportDelivery struct {
- // EmailOwner: Whether the report should be emailed to the report owner.
- EmailOwner bool `json:"emailOwner,omitempty"`
-
- // EmailOwnerDeliveryType: The type of delivery for the owner to
- // receive, if enabled. One of:
- // - "ATTACHMENT"
- // - "LINK"
- EmailOwnerDeliveryType string `json:"emailOwnerDeliveryType,omitempty"`
-
- // Message: The message to be sent with each email.
- Message string `json:"message,omitempty"`
-
- // Recipients: The list of recipients to which to email the report.
- Recipients []*Recipient `json:"recipients,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "EmailOwner") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportDelivery) MarshalJSON() ([]byte, error) {
- type noMethod ReportDelivery
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportFloodlightCriteria: The report criteria for a report of type
-// "FLOODLIGHT".
-type ReportFloodlightCriteria struct {
- // DateRange: The date range this report should be run for.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // DimensionFilters: The list of filters on which dimensions are
- // filtered.
- // Filters for different dimensions are ANDed, filters for the same
- // dimension are grouped together and ORed.
- DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`
-
- // Dimensions: The list of dimensions the report should include.
- Dimensions []*SortedDimension `json:"dimensions,omitempty"`
-
- // FloodlightConfigId: The floodlight ID for which to show data in this
- // report. All advertisers associated with that ID will automatically be
- // added. The dimension of the value needs to be
- // 'dfa:floodlightConfigId'.
- FloodlightConfigId *DimensionValue `json:"floodlightConfigId,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ReportProperties: The properties of the report.
- ReportProperties *ReportFloodlightCriteriaReportProperties `json:"reportProperties,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DateRange") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportFloodlightCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportFloodlightCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportFloodlightCriteriaReportProperties: The properties of the
-// report.
-type ReportFloodlightCriteriaReportProperties struct {
- // IncludeAttributedIPConversions: Include conversions that have no
- // cookie, but do have an exposure path.
- IncludeAttributedIPConversions bool `json:"includeAttributedIPConversions,omitempty"`
-
- // IncludeUnattributedCookieConversions: Include conversions of users
- // with a DoubleClick cookie but without an exposure. That means the
- // user did not click or see an ad from the advertiser within the
- // Floodlight group, or that the interaction happened outside the
- // lookback window.
- IncludeUnattributedCookieConversions bool `json:"includeUnattributedCookieConversions,omitempty"`
-
- // IncludeUnattributedIPConversions: Include conversions that have no
- // associated cookies and no exposures. It’s therefore impossible to
- // know how the user was exposed to your ads during the lookback window
- // prior to a conversion.
- IncludeUnattributedIPConversions bool `json:"includeUnattributedIPConversions,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "IncludeAttributedIPConversions") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportFloodlightCriteriaReportProperties) MarshalJSON() ([]byte, error) {
- type noMethod ReportFloodlightCriteriaReportProperties
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportPathToConversionCriteria: The report criteria for a report of
-// type "PATH_TO_CONVERSION".
-type ReportPathToConversionCriteria struct {
- // ActivityFilters: The list of 'dfa:activity' values to filter on.
- ActivityFilters []*DimensionValue `json:"activityFilters,omitempty"`
-
- // ConversionDimensions: The list of conversion dimensions the report
- // should include.
- ConversionDimensions []*SortedDimension `json:"conversionDimensions,omitempty"`
-
- // CustomFloodlightVariables: The list of custom floodlight variables
- // the report should include.
- CustomFloodlightVariables []*SortedDimension `json:"customFloodlightVariables,omitempty"`
-
- // DateRange: The date range this report should be run for.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // FloodlightConfigId: The floodlight ID for which to show data in this
- // report. All advertisers associated with that ID will automatically be
- // added. The dimension of the value needs to be
- // 'dfa:floodlightConfigId'.
- FloodlightConfigId *DimensionValue `json:"floodlightConfigId,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // PerInteractionDimensions: The list of per interaction dimensions the
- // report should include.
- PerInteractionDimensions []*SortedDimension `json:"perInteractionDimensions,omitempty"`
-
- // ReportProperties: The properties of the report.
- ReportProperties *ReportPathToConversionCriteriaReportProperties `json:"reportProperties,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ActivityFilters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportPathToConversionCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportPathToConversionCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportPathToConversionCriteriaReportProperties: The properties of the
-// report.
-type ReportPathToConversionCriteriaReportProperties struct {
- // ClicksLookbackWindow: DFA checks to see if a click interaction
- // occurred within the specified period of time before a conversion. By
- // default the value is pulled from Floodlight or you can manually enter
- // a custom value. Valid values: 1-90.
- ClicksLookbackWindow int64 `json:"clicksLookbackWindow,omitempty"`
-
- // ImpressionsLookbackWindow: DFA checks to see if an impression
- // interaction occurred within the specified period of time before a
- // conversion. By default the value is pulled from Floodlight or you can
- // manually enter a custom value. Valid values: 1-90.
- ImpressionsLookbackWindow int64 `json:"impressionsLookbackWindow,omitempty"`
-
- // IncludeAttributedIPConversions: Include conversions that have no
- // cookie, but do have an exposure path.
- IncludeAttributedIPConversions bool `json:"includeAttributedIPConversions,omitempty"`
-
- // IncludeUnattributedCookieConversions: Include conversions of users
- // with a DoubleClick cookie but without an exposure. That means the
- // user did not click or see an ad from the advertiser within the
- // Floodlight group, or that the interaction happened outside the
- // lookback window.
- IncludeUnattributedCookieConversions bool `json:"includeUnattributedCookieConversions,omitempty"`
-
- // IncludeUnattributedIPConversions: Include conversions that have no
- // associated cookies and no exposures. It’s therefore impossible to
- // know how the user was exposed to your ads during the lookback window
- // prior to a conversion.
- IncludeUnattributedIPConversions bool `json:"includeUnattributedIPConversions,omitempty"`
-
- // MaximumClickInteractions: The maximum number of click interactions to
- // include in the report. Advertisers currently paying for E2C reports
- // get up to 200 (100 clicks, 100 impressions). If another advertiser in
- // your network is paying for E2C, you can have up to 5 total exposures
- // per report.
- MaximumClickInteractions int64 `json:"maximumClickInteractions,omitempty"`
-
- // MaximumImpressionInteractions: The maximum number of click
- // interactions to include in the report. Advertisers currently paying
- // for E2C reports get up to 200 (100 clicks, 100 impressions). If
- // another advertiser in your network is paying for E2C, you can have up
- // to 5 total exposures per report.
- MaximumImpressionInteractions int64 `json:"maximumImpressionInteractions,omitempty"`
-
- // MaximumInteractionGap: The maximum amount of time that can take place
- // between interactions (clicks or impressions) by the same user. Valid
- // values: 1-90.
- MaximumInteractionGap int64 `json:"maximumInteractionGap,omitempty"`
-
- // PivotOnInteractionPath: Enable pivoting on interaction path.
- PivotOnInteractionPath bool `json:"pivotOnInteractionPath,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "ClicksLookbackWindow") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportPathToConversionCriteriaReportProperties) MarshalJSON() ([]byte, error) {
- type noMethod ReportPathToConversionCriteriaReportProperties
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportReachCriteria: The report criteria for a report of type
-// "REACH".
-type ReportReachCriteria struct {
- // Activities: Activity group.
- Activities *Activities `json:"activities,omitempty"`
-
- // CustomRichMediaEvents: Custom Rich Media Events group.
- CustomRichMediaEvents *CustomRichMediaEvents `json:"customRichMediaEvents,omitempty"`
-
- // DateRange: The date range this report should be run for.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // DimensionFilters: The list of filters on which dimensions are
- // filtered.
- // Filters for different dimensions are ANDed, filters for the same
- // dimension are grouped together and ORed.
- DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`
-
- // Dimensions: The list of dimensions the report should include.
- Dimensions []*SortedDimension `json:"dimensions,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ReachByFrequencyMetricNames: The list of names of Reach By Frequency
- // metrics the report should include.
- ReachByFrequencyMetricNames []string `json:"reachByFrequencyMetricNames,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Activities") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportReachCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportReachCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportSchedule: The report's schedule. Can only be set if the
-// report's 'dateRange' is a relative date range and the relative date
-// range is not "TODAY".
-type ReportSchedule struct {
- // Active: Whether the schedule is active or not. Must be set to either
- // true or false.
- Active bool `json:"active,omitempty"`
-
- // Every: Defines every how many days, weeks or months the report should
- // be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or
- // "MONTHLY".
- Every int64 `json:"every,omitempty"`
-
- // ExpirationDate: The expiration date when the scheduled report stops
- // running.
- ExpirationDate string `json:"expirationDate,omitempty"`
-
- // Repeats: The interval for which the report is repeated, one of:
- // - "DAILY", also requires field "every" to be set.
- // - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to
- // be set.
- // - "TWICE_A_MONTH"
- // - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to
- // be set.
- // - "QUARTERLY"
- // - "YEARLY"
- Repeats string `json:"repeats,omitempty"`
-
- // RepeatsOnWeekDays: List of week days "WEEKLY" on which scheduled
- // reports should run.
- RepeatsOnWeekDays []string `json:"repeatsOnWeekDays,omitempty"`
-
- // RunsOnDayOfMonth: Enum to define for "MONTHLY" scheduled reports
- // whether reports should be repeated on the same day of the month as
- // "startDate" or the same day of the week of the month. Possible values
- // are:
- // - DAY_OF_MONTH
- // - WEEK_OF_MONTH
- // Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02),
- // "DAY_OF_MONTH" would run subsequent reports on the 2nd of every
- // Month, and "WEEK_OF_MONTH" would run subsequent reports on the first
- // Monday of the month.
- RunsOnDayOfMonth string `json:"runsOnDayOfMonth,omitempty"`
-
- // StartDate: Start date of date range for which scheduled reports
- // should be run.
- StartDate string `json:"startDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Active") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportSchedule) MarshalJSON() ([]byte, error) {
- type noMethod ReportSchedule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportList: Represents the list of reports.
-type ReportList struct {
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The reports returned in this response.
- Items []*Report `json:"items,omitempty"`
-
- // Kind: The kind of list this is, in this case dfareporting#reportList.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through reports. To
- // retrieve the next page of results, set the next request's "pageToken"
- // to the value of this field. The page token is only valid for a
- // limited amount of time and should not be persisted.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportList) MarshalJSON() ([]byte, error) {
- type noMethod ReportList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SortedDimension: Represents a sorted dimension.
-type SortedDimension struct {
- // Kind: The kind of resource this is, in this case
- // dfareporting#sortedDimension.
- Kind string `json:"kind,omitempty"`
-
- // Name: The name of the dimension.
- Name string `json:"name,omitempty"`
-
- // SortOrder: An optional sort order for the dimension column, one of:
- //
- // - "ASCENDING"
- // - "DESCENDING"
- SortOrder string `json:"sortOrder,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SortedDimension) MarshalJSON() ([]byte, error) {
- type noMethod SortedDimension
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserProfile: Represents a UserProfile resource.
-type UserProfile struct {
- // AccountId: The account ID to which this profile belongs.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AccountName: The account name this profile belongs to.
- AccountName string `json:"accountName,omitempty"`
-
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#userProfile.
- Kind string `json:"kind,omitempty"`
-
- // ProfileId: The unique ID of the user profile.
- ProfileId int64 `json:"profileId,omitempty,string"`
-
- // SubAccountId: The sub account ID this profile belongs to if
- // applicable.
- SubAccountId int64 `json:"subAccountId,omitempty,string"`
-
- // SubAccountName: The sub account name this profile belongs to if
- // applicable.
- SubAccountName string `json:"subAccountName,omitempty"`
-
- // UserName: The user name.
- UserName string `json:"userName,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserProfile) MarshalJSON() ([]byte, error) {
- type noMethod UserProfile
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserProfileList: Represents the list of user profiles.
-type UserProfileList struct {
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The user profiles returned in this response.
- Items []*UserProfile `json:"items,omitempty"`
-
- // Kind: The kind of list this is, in this case
- // dfareporting#userProfileList.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserProfileList) MarshalJSON() ([]byte, error) {
- type noMethod UserProfileList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "dfareporting.dimensionValues.query":
-
-type DimensionValuesQueryCall struct {
- s *Service
- profileId int64
- dimensionvaluerequest *DimensionValueRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Query: Retrieves list of report dimension values for a list of
-// filters.
-func (r *DimensionValuesService) Query(profileId int64, dimensionvaluerequest *DimensionValueRequest) *DimensionValuesQueryCall {
- c := &DimensionValuesQueryCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.dimensionvaluerequest = dimensionvaluerequest
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *DimensionValuesQueryCall) MaxResults(maxResults int64) *DimensionValuesQueryCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous result page.
-func (c *DimensionValuesQueryCall) PageToken(pageToken string) *DimensionValuesQueryCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DimensionValuesQueryCall) Fields(s ...googleapi.Field) *DimensionValuesQueryCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DimensionValuesQueryCall) Context(ctx context.Context) *DimensionValuesQueryCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DimensionValuesQueryCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.dimensionvaluerequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/dimensionvalues/query")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.dimensionValues.query" call.
-// Exactly one of *DimensionValueList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *DimensionValueList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DimensionValuesQueryCall) Do() (*DimensionValueList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DimensionValueList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves list of report dimension values for a list of filters.",
- // "httpMethod": "POST",
- // "id": "dfareporting.dimensionValues.query",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "100",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/dimensionvalues/query",
- // "request": {
- // "$ref": "DimensionValueRequest"
- // },
- // "response": {
- // "$ref": "DimensionValueList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.files.get":
-
-type FilesGetCall struct {
- s *Service
- reportId int64
- fileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves a report file by its report ID and file ID.
-func (r *FilesService) Get(reportId int64, fileId int64) *FilesGetCall {
- c := &FilesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.reportId = reportId
- c.fileId = fileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FilesGetCall) Fields(s ...googleapi.Field) *FilesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *FilesGetCall) IfNoneMatch(entityTag string) *FilesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do and Download methods.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FilesGetCall) Context(ctx context.Context) *FilesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FilesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "reports/{reportId}/files/{fileId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "reportId": strconv.FormatInt(c.reportId, 10),
- "fileId": strconv.FormatInt(c.fileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Download fetches the API endpoint's "media" value, instead of the normal
-// API response value. If the returned error is nil, the Response is guaranteed to
-// have a 2xx status code. Callers must close the Response.Body as usual.
-func (c *FilesGetCall) Download() (*http.Response, error) {
- res, err := c.doRequest("media")
- if err != nil {
- return nil, err
- }
- if err := googleapi.CheckMediaResponse(res); err != nil {
- res.Body.Close()
- return nil, err
- }
- return res, nil
-}
-
-// Do executes the "dfareporting.files.get" call.
-// Exactly one of *File or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *File.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *FilesGetCall) Do() (*File, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &File{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a report file by its report ID and file ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.files.get",
- // "parameterOrder": [
- // "reportId",
- // "fileId"
- // ],
- // "parameters": {
- // "fileId": {
- // "description": "The ID of the report file.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "reports/{reportId}/files/{fileId}",
- // "response": {
- // "$ref": "File"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ],
- // "supportsMediaDownload": true
- // }
-
-}
-
-// method id "dfareporting.files.list":
-
-type FilesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists files for a user profile.
-func (r *FilesService) List(profileId int64) *FilesListCall {
- c := &FilesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *FilesListCall) MaxResults(maxResults int64) *FilesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous result page.
-func (c *FilesListCall) PageToken(pageToken string) *FilesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Scope sets the optional parameter "scope": The scope that defines
-// which results are returned, default is 'MINE'.
-//
-// Possible values:
-// "ALL" - All files in account.
-// "MINE" (default) - My files.
-// "SHARED_WITH_ME" - Files shared with me.
-func (c *FilesListCall) Scope(scope string) *FilesListCall {
- c.opt_["scope"] = scope
- return c
-}
-
-// SortField sets the optional parameter "sortField": The field by which
-// to sort the list.
-//
-// Possible values:
-// "ID" - Sort by file ID.
-// "LAST_MODIFIED_TIME" (default) - Sort by 'lastmodifiedAt' field.
-func (c *FilesListCall) SortField(sortField string) *FilesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is 'DESCENDING'.
-//
-// Possible values:
-// "ASCENDING" - Ascending order.
-// "DESCENDING" (default) - Descending order.
-func (c *FilesListCall) SortOrder(sortOrder string) *FilesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FilesListCall) Fields(s ...googleapi.Field) *FilesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *FilesListCall) IfNoneMatch(entityTag string) *FilesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FilesListCall) Context(ctx context.Context) *FilesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FilesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["scope"]; ok {
- params.Set("scope", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/files")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.files.list" call.
-// Exactly one of *FileList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *FileList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *FilesListCall) Do() (*FileList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FileList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists files for a user profile.",
- // "httpMethod": "GET",
- // "id": "dfareporting.files.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "scope": {
- // "default": "MINE",
- // "description": "The scope that defines which results are returned, default is 'MINE'.",
- // "enum": [
- // "ALL",
- // "MINE",
- // "SHARED_WITH_ME"
- // ],
- // "enumDescriptions": [
- // "All files in account.",
- // "My files.",
- // "Files shared with me."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "default": "LAST_MODIFIED_TIME",
- // "description": "The field by which to sort the list.",
- // "enum": [
- // "ID",
- // "LAST_MODIFIED_TIME"
- // ],
- // "enumDescriptions": [
- // "Sort by file ID.",
- // "Sort by 'lastmodifiedAt' field."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "default": "DESCENDING",
- // "description": "Order of sorted results, default is 'DESCENDING'.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "Ascending order.",
- // "Descending order."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/files",
- // "response": {
- // "$ref": "FileList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.delete":
-
-type ReportsDeleteCall struct {
- s *Service
- profileId int64
- reportId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes a report by its ID.
-func (r *ReportsService) Delete(profileId int64, reportId int64) *ReportsDeleteCall {
- c := &ReportsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsDeleteCall) Fields(s ...googleapi.Field) *ReportsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsDeleteCall) Context(ctx context.Context) *ReportsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.delete" call.
-func (c *ReportsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes a report by its ID.",
- // "httpMethod": "DELETE",
- // "id": "dfareporting.reports.delete",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.get":
-
-type ReportsGetCall struct {
- s *Service
- profileId int64
- reportId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves a report by its ID.
-func (r *ReportsService) Get(profileId int64, reportId int64) *ReportsGetCall {
- c := &ReportsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsGetCall) Fields(s ...googleapi.Field) *ReportsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsGetCall) IfNoneMatch(entityTag string) *ReportsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsGetCall) Context(ctx context.Context) *ReportsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.get" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsGetCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a report by its ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.reports.get",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}",
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.insert":
-
-type ReportsInsertCall struct {
- s *Service
- profileId int64
- report *Report
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a report.
-func (r *ReportsService) Insert(profileId int64, report *Report) *ReportsInsertCall {
- c := &ReportsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.report = report
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsInsertCall) Fields(s ...googleapi.Field) *ReportsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsInsertCall) Context(ctx context.Context) *ReportsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.report)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.insert" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsInsertCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a report.",
- // "httpMethod": "POST",
- // "id": "dfareporting.reports.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports",
- // "request": {
- // "$ref": "Report"
- // },
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.list":
-
-type ReportsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves list of reports.
-func (r *ReportsService) List(profileId int64) *ReportsListCall {
- c := &ReportsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *ReportsListCall) MaxResults(maxResults int64) *ReportsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous result page.
-func (c *ReportsListCall) PageToken(pageToken string) *ReportsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Scope sets the optional parameter "scope": The scope that defines
-// which results are returned, default is 'MINE'.
-//
-// Possible values:
-// "ALL" - All reports in account.
-// "MINE" (default) - My reports.
-func (c *ReportsListCall) Scope(scope string) *ReportsListCall {
- c.opt_["scope"] = scope
- return c
-}
-
-// SortField sets the optional parameter "sortField": The field by which
-// to sort the list.
-//
-// Possible values:
-// "ID" - Sort by report ID.
-// "LAST_MODIFIED_TIME" (default) - Sort by 'lastModifiedTime' field.
-// "NAME" - Sort by name of reports.
-func (c *ReportsListCall) SortField(sortField string) *ReportsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is 'DESCENDING'.
-//
-// Possible values:
-// "ASCENDING" - Ascending order.
-// "DESCENDING" (default) - Descending order.
-func (c *ReportsListCall) SortOrder(sortOrder string) *ReportsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsListCall) Fields(s ...googleapi.Field) *ReportsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsListCall) IfNoneMatch(entityTag string) *ReportsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsListCall) Context(ctx context.Context) *ReportsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["scope"]; ok {
- params.Set("scope", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.list" call.
-// Exactly one of *ReportList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ReportList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ReportsListCall) Do() (*ReportList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ReportList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves list of reports.",
- // "httpMethod": "GET",
- // "id": "dfareporting.reports.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "scope": {
- // "default": "MINE",
- // "description": "The scope that defines which results are returned, default is 'MINE'.",
- // "enum": [
- // "ALL",
- // "MINE"
- // ],
- // "enumDescriptions": [
- // "All reports in account.",
- // "My reports."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "default": "LAST_MODIFIED_TIME",
- // "description": "The field by which to sort the list.",
- // "enum": [
- // "ID",
- // "LAST_MODIFIED_TIME",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "Sort by report ID.",
- // "Sort by 'lastModifiedTime' field.",
- // "Sort by name of reports."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "default": "DESCENDING",
- // "description": "Order of sorted results, default is 'DESCENDING'.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "Ascending order.",
- // "Descending order."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports",
- // "response": {
- // "$ref": "ReportList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.patch":
-
-type ReportsPatchCall struct {
- s *Service
- profileId int64
- reportId int64
- report *Report
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates a report. This method supports patch semantics.
-func (r *ReportsService) Patch(profileId int64, reportId int64, report *Report) *ReportsPatchCall {
- c := &ReportsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- c.report = report
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsPatchCall) Fields(s ...googleapi.Field) *ReportsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsPatchCall) Context(ctx context.Context) *ReportsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.report)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.patch" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsPatchCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a report. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.reports.patch",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}",
- // "request": {
- // "$ref": "Report"
- // },
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.run":
-
-type ReportsRunCall struct {
- s *Service
- profileId int64
- reportId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Run: Runs a report.
-func (r *ReportsService) Run(profileId int64, reportId int64) *ReportsRunCall {
- c := &ReportsRunCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- return c
-}
-
-// Synchronous sets the optional parameter "synchronous": If set and
-// true, tries to run the report synchronously.
-func (c *ReportsRunCall) Synchronous(synchronous bool) *ReportsRunCall {
- c.opt_["synchronous"] = synchronous
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsRunCall) Fields(s ...googleapi.Field) *ReportsRunCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsRunCall) Context(ctx context.Context) *ReportsRunCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsRunCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["synchronous"]; ok {
- params.Set("synchronous", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}/run")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.run" call.
-// Exactly one of *File or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *File.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *ReportsRunCall) Do() (*File, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &File{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Runs a report.",
- // "httpMethod": "POST",
- // "id": "dfareporting.reports.run",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "synchronous": {
- // "description": "If set and true, tries to run the report synchronously.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}/run",
- // "response": {
- // "$ref": "File"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.update":
-
-type ReportsUpdateCall struct {
- s *Service
- profileId int64
- reportId int64
- report *Report
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates a report.
-func (r *ReportsService) Update(profileId int64, reportId int64, report *Report) *ReportsUpdateCall {
- c := &ReportsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- c.report = report
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsUpdateCall) Fields(s ...googleapi.Field) *ReportsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsUpdateCall) Context(ctx context.Context) *ReportsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.report)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.update" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsUpdateCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a report.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.reports.update",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}",
- // "request": {
- // "$ref": "Report"
- // },
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.files.get":
-
-type ReportsFilesGetCall struct {
- s *Service
- profileId int64
- reportId int64
- fileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves a report file.
-func (r *ReportsFilesService) Get(profileId int64, reportId int64, fileId int64) *ReportsFilesGetCall {
- c := &ReportsFilesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- c.fileId = fileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsFilesGetCall) Fields(s ...googleapi.Field) *ReportsFilesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsFilesGetCall) IfNoneMatch(entityTag string) *ReportsFilesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do and Download methods.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsFilesGetCall) Context(ctx context.Context) *ReportsFilesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsFilesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}/files/{fileId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- "fileId": strconv.FormatInt(c.fileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Download fetches the API endpoint's "media" value, instead of the normal
-// API response value. If the returned error is nil, the Response is guaranteed to
-// have a 2xx status code. Callers must close the Response.Body as usual.
-func (c *ReportsFilesGetCall) Download() (*http.Response, error) {
- res, err := c.doRequest("media")
- if err != nil {
- return nil, err
- }
- if err := googleapi.CheckMediaResponse(res); err != nil {
- res.Body.Close()
- return nil, err
- }
- return res, nil
-}
-
-// Do executes the "dfareporting.reports.files.get" call.
-// Exactly one of *File or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *File.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *ReportsFilesGetCall) Do() (*File, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &File{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a report file.",
- // "httpMethod": "GET",
- // "id": "dfareporting.reports.files.get",
- // "parameterOrder": [
- // "profileId",
- // "reportId",
- // "fileId"
- // ],
- // "parameters": {
- // "fileId": {
- // "description": "The ID of the report file.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}/files/{fileId}",
- // "response": {
- // "$ref": "File"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ],
- // "supportsMediaDownload": true
- // }
-
-}
-
-// method id "dfareporting.reports.files.list":
-
-type ReportsFilesListCall struct {
- s *Service
- profileId int64
- reportId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists files for a report.
-func (r *ReportsFilesService) List(profileId int64, reportId int64) *ReportsFilesListCall {
- c := &ReportsFilesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *ReportsFilesListCall) MaxResults(maxResults int64) *ReportsFilesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous result page.
-func (c *ReportsFilesListCall) PageToken(pageToken string) *ReportsFilesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SortField sets the optional parameter "sortField": The field by which
-// to sort the list.
-//
-// Possible values:
-// "ID" - Sort by file ID.
-// "LAST_MODIFIED_TIME" (default) - Sort by 'lastmodifiedAt' field.
-func (c *ReportsFilesListCall) SortField(sortField string) *ReportsFilesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is 'DESCENDING'.
-//
-// Possible values:
-// "ASCENDING" - Ascending order.
-// "DESCENDING" (default) - Descending order.
-func (c *ReportsFilesListCall) SortOrder(sortOrder string) *ReportsFilesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsFilesListCall) Fields(s ...googleapi.Field) *ReportsFilesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsFilesListCall) IfNoneMatch(entityTag string) *ReportsFilesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsFilesListCall) Context(ctx context.Context) *ReportsFilesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsFilesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}/files")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.files.list" call.
-// Exactly one of *FileList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *FileList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ReportsFilesListCall) Do() (*FileList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FileList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists files for a report.",
- // "httpMethod": "GET",
- // "id": "dfareporting.reports.files.list",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the parent report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "sortField": {
- // "default": "LAST_MODIFIED_TIME",
- // "description": "The field by which to sort the list.",
- // "enum": [
- // "ID",
- // "LAST_MODIFIED_TIME"
- // ],
- // "enumDescriptions": [
- // "Sort by file ID.",
- // "Sort by 'lastmodifiedAt' field."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "default": "DESCENDING",
- // "description": "Order of sorted results, default is 'DESCENDING'.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "Ascending order.",
- // "Descending order."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}/files",
- // "response": {
- // "$ref": "FileList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userProfiles.get":
-
-type UserProfilesGetCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one user profile by ID.
-func (r *UserProfilesService) Get(profileId int64) *UserProfilesGetCall {
- c := &UserProfilesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserProfilesGetCall) Fields(s ...googleapi.Field) *UserProfilesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UserProfilesGetCall) IfNoneMatch(entityTag string) *UserProfilesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserProfilesGetCall) Context(ctx context.Context) *UserProfilesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserProfilesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userProfiles.get" call.
-// Exactly one of *UserProfile or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UserProfile.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UserProfilesGetCall) Do() (*UserProfile, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserProfile{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one user profile by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.userProfiles.get",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}",
- // "response": {
- // "$ref": "UserProfile"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userProfiles.list":
-
-type UserProfilesListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves list of user profiles for a user.
-func (r *UserProfilesService) List() *UserProfilesListCall {
- c := &UserProfilesListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserProfilesListCall) Fields(s ...googleapi.Field) *UserProfilesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UserProfilesListCall) IfNoneMatch(entityTag string) *UserProfilesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserProfilesListCall) Context(ctx context.Context) *UserProfilesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserProfilesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userProfiles.list" call.
-// Exactly one of *UserProfileList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UserProfileList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *UserProfilesListCall) Do() (*UserProfileList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserProfileList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves list of user profiles for a user.",
- // "httpMethod": "GET",
- // "id": "dfareporting.userProfiles.list",
- // "path": "userprofiles",
- // "response": {
- // "$ref": "UserProfileList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/dfareporting/v1.3/dfareporting-api.json b/vendor/google.golang.org/api/dfareporting/v1.3/dfareporting-api.json
deleted file mode 100644
index f155481d..00000000
--- a/vendor/google.golang.org/api/dfareporting/v1.3/dfareporting-api.json
+++ /dev/null
@@ -1,1913 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/_NHVgXxsnh4iZLUQivabzFT84as\"",
- "discoveryVersion": "v1",
- "id": "dfareporting:v1.3",
- "name": "dfareporting",
- "version": "v1.3",
- "revision": "20141112",
- "title": "DFA Reporting API",
- "description": "Lets you create, run and download reports.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/doubleclick-advertisers/reporting/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/dfareporting/v1.3/",
- "basePath": "/dfareporting/v1.3/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "dfareporting/v1.3/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/dfareporting": {
- "description": "View and manage DoubleClick for Advertisers reports"
- }
- }
- }
- },
- "schemas": {
- "Activities": {
- "id": "Activities",
- "type": "object",
- "description": "Represents an activity group.",
- "properties": {
- "filters": {
- "type": "array",
- "description": "List of activity filters. The dimension values need to be all either of type \"dfa:activity\" or \"dfa:activityGroup\".",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#activities.",
- "default": "dfareporting#activities"
- },
- "metricNames": {
- "type": "array",
- "description": "List of names of floodlight activity metrics.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "CompatibleFields": {
- "id": "CompatibleFields",
- "type": "object",
- "description": "Represents a response to the queryCompatibleFields method.",
- "properties": {
- "crossDimensionReachReportCompatibleFields": {
- "$ref": "CrossDimensionReachReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"CROSS_DIMENSION_REACH\"."
- },
- "floodlightReportCompatibleFields": {
- "$ref": "FloodlightReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"FLOODLIGHT\"."
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#compatibleFields.",
- "default": "dfareporting#compatibleFields"
- },
- "pathToConversionReportCompatibleFields": {
- "$ref": "PathToConversionReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"PATH_TO_CONVERSION\"."
- },
- "reachReportCompatibleFields": {
- "$ref": "ReachReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"REACH\"."
- },
- "reportCompatibleFields": {
- "$ref": "ReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"STANDARD\"."
- }
- }
- },
- "CrossDimensionReachReportCompatibleFields": {
- "id": "CrossDimensionReachReportCompatibleFields",
- "type": "object",
- "description": "Represents fields that are compatible to be selected for a report of type \"CROSS_DIMENSION_REACH\".",
- "properties": {
- "breakdown": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"breakdown\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "dimensionFilters": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields.",
- "default": "dfareporting#crossDimensionReachReportCompatibleFields"
- },
- "metrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- },
- "overlapMetrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected in the \"overlapMetricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- }
- }
- },
- "CustomRichMediaEvents": {
- "id": "CustomRichMediaEvents",
- "type": "object",
- "description": "Represents a Custom Rich Media Events group.",
- "properties": {
- "filteredEventIds": {
- "type": "array",
- "description": "List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#customRichMediaEvents.",
- "default": "dfareporting#customRichMediaEvents"
- }
- }
- },
- "DateRange": {
- "id": "DateRange",
- "type": "object",
- "description": "Represents a date range.",
- "properties": {
- "endDate": {
- "type": "string",
- "description": "The end date of the date range, inclusive. A string of the format: \"yyyy-MM-dd\".",
- "format": "date"
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#dateRange.",
- "default": "dfareporting#dateRange"
- },
- "relativeDateRange": {
- "type": "string",
- "description": "The date range relative to the date of when the report is run, one of: \n- \"TODAY\" \n- \"YESTERDAY\" \n- \"WEEK_TO_DATE\" \n- \"MONTH_TO_DATE\" \n- \"QUARTER_TO_DATE\" \n- \"YEAR_TO_DATE\" \n- \"PREVIOUS_WEEK\" \n- \"PREVIOUS_MONTH\" \n- \"PREVIOUS_QUARTER\" \n- \"PREVIOUS_YEAR\" \n- \"LAST_7_DAYS\" \n- \"LAST_30_DAYS\" \n- \"LAST_90_DAYS\" \n- \"LAST_365_DAYS\" \n- \"LAST_24_MONTHS\""
- },
- "startDate": {
- "type": "string",
- "description": "The start date of the date range, inclusive. A string of the format: \"yyyy-MM-dd\".",
- "format": "date"
- }
- }
- },
- "Dimension": {
- "id": "Dimension",
- "type": "object",
- "description": "Represents a dimension.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#dimension.",
- "default": "dfareporting#dimension"
- },
- "name": {
- "type": "string",
- "description": "The dimension name, e.g. dfa:advertiser"
- }
- }
- },
- "DimensionFilter": {
- "id": "DimensionFilter",
- "type": "object",
- "description": "Represents a dimension filter.",
- "properties": {
- "dimensionName": {
- "type": "string",
- "description": "The name of the dimension to filter."
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#dimensionFilter.",
- "default": "dfareporting#dimensionFilter"
- },
- "value": {
- "type": "string",
- "description": "The value of the dimension to filter."
- }
- }
- },
- "DimensionValue": {
- "id": "DimensionValue",
- "type": "object",
- "description": "Represents a DimensionValue resource.",
- "properties": {
- "dimensionName": {
- "type": "string",
- "description": "The name of the dimension."
- },
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "id": {
- "type": "string",
- "description": "The ID associated with the value if available."
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#dimensionValue.",
- "default": "dfareporting#dimensionValue"
- },
- "matchType": {
- "type": "string",
- "description": "Determines how the 'value' field is matched when filtering. One of: \n- EXACT (default if not specified) \n- CONTAINS \n- BEGINS_WITH \n- WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT."
- },
- "value": {
- "type": "string",
- "description": "The value of the dimension."
- }
- }
- },
- "DimensionValueList": {
- "id": "DimensionValueList",
- "type": "object",
- "description": "Represents the list of DimensionValue resources.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The dimension values returned in this response.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of list this is, in this case dfareporting#dimensionValueList.",
- "default": "dfareporting#dimensionValueList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted."
- }
- }
- },
- "DimensionValueRequest": {
- "id": "DimensionValueRequest",
- "type": "object",
- "description": "Represents a DimensionValuesRequest.",
- "properties": {
- "dimensionName": {
- "type": "string",
- "description": "The name of the dimension for which values should be requested.",
- "annotations": {
- "required": [
- "dfareporting.dimensionValues.query"
- ]
- }
- },
- "endDate": {
- "type": "string",
- "description": "The end date of the date range for which to retrieve dimension values. A string of the format: \"yyyy-MM-dd\".",
- "format": "date",
- "annotations": {
- "required": [
- "dfareporting.dimensionValues.query"
- ]
- }
- },
- "filters": {
- "type": "array",
- "description": "The list of filters by which to filter values. The filters are ANDed.",
- "items": {
- "$ref": "DimensionFilter"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of request this is, in this case dfareporting#dimensionValueRequest.",
- "default": "dfareporting#dimensionValueRequest"
- },
- "startDate": {
- "type": "string",
- "description": "The start date of the date range for which to retrieve dimension values. A string of the format: \"yyyy-MM-dd\".",
- "format": "date",
- "annotations": {
- "required": [
- "dfareporting.dimensionValues.query"
- ]
- }
- }
- }
- },
- "File": {
- "id": "File",
- "type": "object",
- "description": "Represents a File resource. A File contains the meta-data for a report run. It shows the status of the run and holds the urls to the generated report data if the run is finished and the status is \"REPORT_AVAILABLE\".",
- "properties": {
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range for which the file has report data. The date range will always be the absolute date range for which the report is run."
- },
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "fileName": {
- "type": "string",
- "description": "The file name of the file."
- },
- "format": {
- "type": "string",
- "description": "The output format of the report. Only available once the file is available."
- },
- "id": {
- "type": "string",
- "description": "The unique ID of this report file.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#file.",
- "default": "dfareporting#file"
- },
- "lastModifiedTime": {
- "type": "string",
- "description": "The timestamp in milliseconds since epoch when this file was last modified.",
- "format": "int64"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report this file was generated from.",
- "format": "int64"
- },
- "status": {
- "type": "string",
- "description": "The status of the report file, one of: \n- \"PROCESSING\" \n- \"REPORT_AVAILABLE\" \n- \"FAILED\" \n- \"CANCELLED\""
- },
- "urls": {
- "type": "object",
- "description": "The urls where the completed report file can be downloaded.",
- "properties": {
- "apiUrl": {
- "type": "string",
- "description": "The url for downloading the report data through the API."
- },
- "browserUrl": {
- "type": "string",
- "description": "The url for downloading the report data through a browser."
- }
- }
- }
- }
- },
- "FileList": {
- "id": "FileList",
- "type": "object",
- "description": "Represents the list of File resources.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The files returned in this response.",
- "items": {
- "$ref": "File"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of list this is, in this case dfareporting#fileList.",
- "default": "dfareporting#fileList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through files. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted."
- }
- }
- },
- "FloodlightReportCompatibleFields": {
- "id": "FloodlightReportCompatibleFields",
- "type": "object",
- "description": "Represents fields that are compatible to be selected for a report of type \"FlOODLIGHT\".",
- "properties": {
- "dimensionFilters": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields.",
- "default": "dfareporting#floodlightReportCompatibleFields"
- },
- "metrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- }
- }
- },
- "Metric": {
- "id": "Metric",
- "type": "object",
- "description": "Represents a metric.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#metric.",
- "default": "dfareporting#metric"
- },
- "name": {
- "type": "string",
- "description": "The metric name, e.g. dfa:impressions"
- }
- }
- },
- "PathToConversionReportCompatibleFields": {
- "id": "PathToConversionReportCompatibleFields",
- "type": "object",
- "description": "Represents fields that are compatible to be selected for a report of type \"PATH_TO_CONVERSION\".",
- "properties": {
- "conversionDimensions": {
- "type": "array",
- "description": "Conversion dimensions which are compatible to be selected in the \"conversionDimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "customFloodlightVariables": {
- "type": "array",
- "description": "Custom floodlight variables which are compatible to be selected in the \"customFloodlightVariables\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields.",
- "default": "dfareporting#pathToConversionReportCompatibleFields"
- },
- "metrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- },
- "perInteractionDimensions": {
- "type": "array",
- "description": "Per-interaction dimensions which are compatible to be selected in the \"perInteractionDimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- }
- }
- },
- "ReachReportCompatibleFields": {
- "id": "ReachReportCompatibleFields",
- "type": "object",
- "description": "Represents fields that are compatible to be selected for a report of type \"REACH\".",
- "properties": {
- "dimensionFilters": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#reachReportCompatibleFields.",
- "default": "dfareporting#reachReportCompatibleFields"
- },
- "metrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- },
- "pivotedActivityMetrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected as activity metrics to pivot on in the \"activities\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- },
- "reachByFrequencyMetrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected in the \"reachByFrequencyMetricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- }
- }
- },
- "Recipient": {
- "id": "Recipient",
- "type": "object",
- "description": "Represents a recipient.",
- "properties": {
- "deliveryType": {
- "type": "string",
- "description": "The delivery type for the recipient, one of: \n- \"ATTACHMENT\" \n- \"LINK\"",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "email": {
- "type": "string",
- "description": "The email address of the recipient.",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#recipient.",
- "default": "dfareporting#recipient"
- }
- }
- },
- "Report": {
- "id": "Report",
- "type": "object",
- "description": "Represents a Report resource.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The account ID to which this report belongs.",
- "format": "int64",
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- }
- },
- "activeGrpCriteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"ACTIVE_GRP\".",
- "properties": {
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimensionFilters": {
- "type": "array",
- "description": "The list of filters on which dimensions are filtered.\nFilters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.\nA valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "criteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"STANDARD\".",
- "properties": {
- "activities": {
- "$ref": "Activities",
- "description": "Activity group."
- },
- "customRichMediaEvents": {
- "$ref": "CustomRichMediaEvents",
- "description": "Custom Rich Media Events group."
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range for which this report should be run."
- },
- "dimensionFilters": {
- "type": "array",
- "description": "The list of filters on which dimensions are filtered.\nFilters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "The list of standard dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "crossDimensionReachCriteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"CROSS_DIMENSION_REACH\".",
- "properties": {
- "breakdown": {
- "type": "array",
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimension": {
- "type": "string",
- "description": "The dimension option, one of: \n- \"ADVERTISER\" \n- \"CAMPAIGN\" \n- \"SITE_BY_ADVERTISER\" \n- \"SITE_BY_CAMPAIGN\""
- },
- "dimensionFilters": {
- "type": "array",
- "description": "The list of filters on which dimensions are filtered.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "overlapMetricNames": {
- "type": "array",
- "description": "The list of names of overlap metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "pivoted": {
- "type": "boolean",
- "description": "Whether the report is pivoted or not. Defaults to true."
- }
- }
- },
- "delivery": {
- "type": "object",
- "description": "The report's email delivery settings.",
- "properties": {
- "emailOwner": {
- "type": "boolean",
- "description": "Whether the report should be emailed to the report owner."
- },
- "emailOwnerDeliveryType": {
- "type": "string",
- "description": "The type of delivery for the owner to receive, if enabled. One of: \n- \"ATTACHMENT\" \n- \"LINK\""
- },
- "message": {
- "type": "string",
- "description": "The message to be sent with each email."
- },
- "recipients": {
- "type": "array",
- "description": "The list of recipients to which to email the report.",
- "items": {
- "$ref": "Recipient"
- }
- }
- }
- },
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "fileName": {
- "type": "string",
- "description": "The file name used when generating report files for this report."
- },
- "floodlightCriteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"FLOODLIGHT\".",
- "properties": {
- "customRichMediaEvents": {
- "type": "array",
- "description": "The list of custom rich media events to include.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimensionFilters": {
- "type": "array",
- "description": "The list of filters on which dimensions are filtered.\nFilters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "floodlightConfigId": {
- "$ref": "DimensionValue",
- "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "reportProperties": {
- "type": "object",
- "description": "The properties of the report.",
- "properties": {
- "includeAttributedIPConversions": {
- "type": "boolean",
- "description": "Include conversions that have no cookie, but do have an exposure path."
- },
- "includeUnattributedCookieConversions": {
- "type": "boolean",
- "description": "Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window."
- },
- "includeUnattributedIPConversions": {
- "type": "boolean",
- "description": "Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion."
- }
- }
- }
- }
- },
- "format": {
- "type": "string",
- "description": "The output format of the report, one of: \n- \"CSV\" \n- \"EXCEL\" If not specified, default format is \"CSV\". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. \"CSV\" will then be the fallback format."
- },
- "id": {
- "type": "string",
- "description": "The unique ID identifying this report resource.",
- "format": "int64",
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#report.",
- "default": "dfareporting#report"
- },
- "lastModifiedTime": {
- "type": "string",
- "description": "The timestamp (in milliseconds since epoch) of when this report was last modified.",
- "format": "uint64",
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- }
- },
- "name": {
- "type": "string",
- "description": "The name of the report.",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "ownerProfileId": {
- "type": "string",
- "description": "The user profile id of the owner of this report.",
- "format": "int64",
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- }
- },
- "pathToConversionCriteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"PATH_TO_CONVERSION\".",
- "properties": {
- "activityFilters": {
- "type": "array",
- "description": "The list of 'dfa:activity' values to filter on.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "conversionDimensions": {
- "type": "array",
- "description": "The list of conversion dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "customFloodlightVariables": {
- "type": "array",
- "description": "The list of custom floodlight variables the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "customRichMediaEvents": {
- "type": "array",
- "description": "The list of custom rich media events to include.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "floodlightConfigId": {
- "$ref": "DimensionValue",
- "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "perInteractionDimensions": {
- "type": "array",
- "description": "The list of per interaction dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "reportProperties": {
- "type": "object",
- "description": "The properties of the report.",
- "properties": {
- "clicksLookbackWindow": {
- "type": "integer",
- "description": "DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.",
- "format": "int32"
- },
- "impressionsLookbackWindow": {
- "type": "integer",
- "description": "DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.",
- "format": "int32"
- },
- "includeAttributedIPConversions": {
- "type": "boolean",
- "description": "Deprecated: has no effect."
- },
- "includeUnattributedCookieConversions": {
- "type": "boolean",
- "description": "Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window."
- },
- "includeUnattributedIPConversions": {
- "type": "boolean",
- "description": "Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion."
- },
- "maximumClickInteractions": {
- "type": "integer",
- "description": "The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.",
- "format": "int32"
- },
- "maximumImpressionInteractions": {
- "type": "integer",
- "description": "The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.",
- "format": "int32"
- },
- "maximumInteractionGap": {
- "type": "integer",
- "description": "The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.",
- "format": "int32"
- },
- "pivotOnInteractionPath": {
- "type": "boolean",
- "description": "Enable pivoting on interaction path."
- }
- }
- }
- }
- },
- "reachCriteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"REACH\".",
- "properties": {
- "activities": {
- "$ref": "Activities",
- "description": "Activity group."
- },
- "customRichMediaEvents": {
- "$ref": "CustomRichMediaEvents",
- "description": "Custom Rich Media Events group."
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimensionFilters": {
- "type": "array",
- "description": "The list of filters on which dimensions are filtered.\nFilters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "reachByFrequencyMetricNames": {
- "type": "array",
- "description": "The list of names of Reach By Frequency metrics the report should include.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "schedule": {
- "type": "object",
- "description": "The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not \"TODAY\".",
- "properties": {
- "active": {
- "type": "boolean",
- "description": "Whether the schedule is active or not. Must be set to either true or false.",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "every": {
- "type": "integer",
- "description": "Defines every how many days, weeks or months the report should be run. Needs to be set when \"repeats\" is either \"DAILY\", \"WEEKLY\" or \"MONTHLY\".",
- "format": "int32"
- },
- "expirationDate": {
- "type": "string",
- "description": "The expiration date when the scheduled report stops running.",
- "format": "date",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "repeats": {
- "type": "string",
- "description": "The interval for which the report is repeated, one of: \n- \"DAILY\", also requires field \"every\" to be set. \n- \"WEEKLY\", also requires fields \"every\" and \"repeatsOnWeekDays\" to be set. \n- \"TWICE_A_MONTH\" \n- \"MONTHLY\", also requires fields \"every\" and \"runsOnDayOfMonth\" to be set. \n- \"QUARTERLY\" \n- \"YEARLY\"",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "repeatsOnWeekDays": {
- "type": "array",
- "description": "List of week days \"WEEKLY\" on which scheduled reports should run.",
- "items": {
- "type": "string"
- }
- },
- "runsOnDayOfMonth": {
- "type": "string",
- "description": "Enum to define for \"MONTHLY\" scheduled reports whether reports should be repeated on the same day of the month as \"startDate\" or the same day of the week of the month. Possible values are: \n- DAY_OF_MONTH \n- WEEK_OF_MONTH \nExample: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), \"DAY_OF_MONTH\" would run subsequent reports on the 2nd of every Month, and \"WEEK_OF_MONTH\" would run subsequent reports on the first Monday of the month."
- },
- "startDate": {
- "type": "string",
- "description": "Start date of date range for which scheduled reports should be run.",
- "format": "date",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- }
- }
- },
- "subAccountId": {
- "type": "string",
- "description": "The subbaccount ID to which this report belongs if applicable.",
- "format": "int64"
- },
- "type": {
- "type": "string",
- "description": "The type of the report, one of: \n- STANDARD \n- REACH \n- ACTIVE_GRP \n- PATH_TO_CONVERSION \n- FLOODLIGHT \n- CROSS_DIMENSION_REACH",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- }
- }
- },
- "ReportCompatibleFields": {
- "id": "ReportCompatibleFields",
- "type": "object",
- "description": "Represents fields that are compatible to be selected for a report of type \"STANDARD\".",
- "properties": {
- "dimensionFilters": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#reportCompatibleFields.",
- "default": "dfareporting#reportCompatibleFields"
- },
- "metrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- },
- "pivotedActivityMetrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected as activity metrics to pivot on in the \"activities\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- }
- }
- },
- "ReportList": {
- "id": "ReportList",
- "type": "object",
- "description": "Represents the list of reports.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The reports returned in this response.",
- "items": {
- "$ref": "Report"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of list this is, in this case dfareporting#reportList.",
- "default": "dfareporting#reportList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through reports. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted."
- }
- }
- },
- "SortedDimension": {
- "id": "SortedDimension",
- "type": "object",
- "description": "Represents a sorted dimension.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#sortedDimension.",
- "default": "dfareporting#sortedDimension"
- },
- "name": {
- "type": "string",
- "description": "The name of the dimension."
- },
- "sortOrder": {
- "type": "string",
- "description": "An optional sort order for the dimension column, one of: \n- \"ASCENDING\" \n- \"DESCENDING\""
- }
- }
- },
- "UserProfile": {
- "id": "UserProfile",
- "type": "object",
- "description": "Represents a UserProfile resource.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The account ID to which this profile belongs.",
- "format": "int64"
- },
- "accountName": {
- "type": "string",
- "description": "The account name this profile belongs to."
- },
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#userProfile.",
- "default": "dfareporting#userProfile"
- },
- "profileId": {
- "type": "string",
- "description": "The unique ID of the user profile.",
- "format": "int64"
- },
- "subAccountId": {
- "type": "string",
- "description": "The sub account ID this profile belongs to if applicable.",
- "format": "int64"
- },
- "subAccountName": {
- "type": "string",
- "description": "The sub account name this profile belongs to if applicable."
- },
- "userName": {
- "type": "string",
- "description": "The user name."
- }
- }
- },
- "UserProfileList": {
- "id": "UserProfileList",
- "type": "object",
- "description": "Represents the list of user profiles.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The user profiles returned in this response.",
- "items": {
- "$ref": "UserProfile"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of list this is, in this case dfareporting#userProfileList.",
- "default": "dfareporting#userProfileList"
- }
- }
- }
- },
- "resources": {
- "dimensionValues": {
- "methods": {
- "query": {
- "id": "dfareporting.dimensionValues.query",
- "path": "userprofiles/{profileId}/dimensionvalues/query",
- "httpMethod": "POST",
- "description": "Retrieves list of report dimension values for a list of filters.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "DimensionValueRequest"
- },
- "response": {
- "$ref": "DimensionValueList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- },
- "files": {
- "methods": {
- "get": {
- "id": "dfareporting.files.get",
- "path": "reports/{reportId}/files/{fileId}",
- "httpMethod": "GET",
- "description": "Retrieves a report file by its report ID and file ID.",
- "parameters": {
- "fileId": {
- "type": "string",
- "description": "The ID of the report file.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "reportId",
- "fileId"
- ],
- "response": {
- "$ref": "File"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ],
- "supportsMediaDownload": true
- },
- "list": {
- "id": "dfareporting.files.list",
- "path": "userprofiles/{profileId}/files",
- "httpMethod": "GET",
- "description": "Lists files for a user profile.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "scope": {
- "type": "string",
- "description": "The scope that defines which results are returned, default is 'MINE'.",
- "default": "MINE",
- "enum": [
- "ALL",
- "MINE",
- "SHARED_WITH_ME"
- ],
- "enumDescriptions": [
- "All files in account.",
- "My files.",
- "Files shared with me."
- ],
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "The field by which to sort the list.",
- "default": "LAST_MODIFIED_TIME",
- "enum": [
- "ID",
- "LAST_MODIFIED_TIME"
- ],
- "enumDescriptions": [
- "Sort by file ID.",
- "Sort by 'lastmodifiedAt' field."
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is 'DESCENDING'.",
- "default": "DESCENDING",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "FileList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- },
- "reports": {
- "methods": {
- "delete": {
- "id": "dfareporting.reports.delete",
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "DELETE",
- "description": "Deletes a report by its ID.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "get": {
- "id": "dfareporting.reports.get",
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "GET",
- "description": "Retrieves a report by its ID.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "insert": {
- "id": "dfareporting.reports.insert",
- "path": "userprofiles/{profileId}/reports",
- "httpMethod": "POST",
- "description": "Creates a report.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "list": {
- "id": "dfareporting.reports.list",
- "path": "userprofiles/{profileId}/reports",
- "httpMethod": "GET",
- "description": "Retrieves list of reports.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "scope": {
- "type": "string",
- "description": "The scope that defines which results are returned, default is 'MINE'.",
- "default": "MINE",
- "enum": [
- "ALL",
- "MINE"
- ],
- "enumDescriptions": [
- "All reports in account.",
- "My reports."
- ],
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "The field by which to sort the list.",
- "default": "LAST_MODIFIED_TIME",
- "enum": [
- "ID",
- "LAST_MODIFIED_TIME",
- "NAME"
- ],
- "enumDescriptions": [
- "Sort by report ID.",
- "Sort by 'lastModifiedTime' field.",
- "Sort by name of reports."
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is 'DESCENDING'.",
- "default": "DESCENDING",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "ReportList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "patch": {
- "id": "dfareporting.reports.patch",
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "PATCH",
- "description": "Updates a report. This method supports patch semantics.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "run": {
- "id": "dfareporting.reports.run",
- "path": "userprofiles/{profileId}/reports/{reportId}/run",
- "httpMethod": "POST",
- "description": "Runs a report.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "synchronous": {
- "type": "boolean",
- "description": "If set and true, tries to run the report synchronously.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "response": {
- "$ref": "File"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "update": {
- "id": "dfareporting.reports.update",
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "PUT",
- "description": "Updates a report.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- },
- "resources": {
- "compatibleFields": {
- "methods": {
- "query": {
- "id": "dfareporting.reports.compatibleFields.query",
- "path": "userprofiles/{profileId}/reports/compatiblefields/query",
- "httpMethod": "POST",
- "description": "Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "CompatibleFields"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- },
- "files": {
- "methods": {
- "get": {
- "id": "dfareporting.reports.files.get",
- "path": "userprofiles/{profileId}/reports/{reportId}/files/{fileId}",
- "httpMethod": "GET",
- "description": "Retrieves a report file.",
- "parameters": {
- "fileId": {
- "type": "string",
- "description": "The ID of the report file.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId",
- "fileId"
- ],
- "response": {
- "$ref": "File"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ],
- "supportsMediaDownload": true
- },
- "list": {
- "id": "dfareporting.reports.files.list",
- "path": "userprofiles/{profileId}/reports/{reportId}/files",
- "httpMethod": "GET",
- "description": "Lists files for a report.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the parent report.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "sortField": {
- "type": "string",
- "description": "The field by which to sort the list.",
- "default": "LAST_MODIFIED_TIME",
- "enum": [
- "ID",
- "LAST_MODIFIED_TIME"
- ],
- "enumDescriptions": [
- "Sort by file ID.",
- "Sort by 'lastmodifiedAt' field."
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is 'DESCENDING'.",
- "default": "DESCENDING",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "response": {
- "$ref": "FileList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- }
- }
- },
- "userProfiles": {
- "methods": {
- "get": {
- "id": "dfareporting.userProfiles.get",
- "path": "userprofiles/{profileId}",
- "httpMethod": "GET",
- "description": "Gets one user profile by ID.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "UserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "list": {
- "id": "dfareporting.userProfiles.list",
- "path": "userprofiles",
- "httpMethod": "GET",
- "description": "Retrieves list of user profiles for a user.",
- "response": {
- "$ref": "UserProfileList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/dfareporting/v1.3/dfareporting-gen.go b/vendor/google.golang.org/api/dfareporting/v1.3/dfareporting-gen.go
deleted file mode 100644
index 3910be93..00000000
--- a/vendor/google.golang.org/api/dfareporting/v1.3/dfareporting-gen.go
+++ /dev/null
@@ -1,3875 +0,0 @@
-// Package dfareporting provides access to the DFA Reporting API.
-//
-// See https://developers.google.com/doubleclick-advertisers/reporting/
-//
-// Usage example:
-//
-// import "google.golang.org/api/dfareporting/v1.3"
-// ...
-// dfareportingService, err := dfareporting.New(oauthHttpClient)
-package dfareporting // import "google.golang.org/api/dfareporting/v1.3"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "dfareporting:v1.3"
-const apiName = "dfareporting"
-const apiVersion = "v1.3"
-const basePath = "https://www.googleapis.com/dfareporting/v1.3/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage DoubleClick for Advertisers reports
- DfareportingScope = "https://www.googleapis.com/auth/dfareporting"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.DimensionValues = NewDimensionValuesService(s)
- s.Files = NewFilesService(s)
- s.Reports = NewReportsService(s)
- s.UserProfiles = NewUserProfilesService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- DimensionValues *DimensionValuesService
-
- Files *FilesService
-
- Reports *ReportsService
-
- UserProfiles *UserProfilesService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewDimensionValuesService(s *Service) *DimensionValuesService {
- rs := &DimensionValuesService{s: s}
- return rs
-}
-
-type DimensionValuesService struct {
- s *Service
-}
-
-func NewFilesService(s *Service) *FilesService {
- rs := &FilesService{s: s}
- return rs
-}
-
-type FilesService struct {
- s *Service
-}
-
-func NewReportsService(s *Service) *ReportsService {
- rs := &ReportsService{s: s}
- rs.CompatibleFields = NewReportsCompatibleFieldsService(s)
- rs.Files = NewReportsFilesService(s)
- return rs
-}
-
-type ReportsService struct {
- s *Service
-
- CompatibleFields *ReportsCompatibleFieldsService
-
- Files *ReportsFilesService
-}
-
-func NewReportsCompatibleFieldsService(s *Service) *ReportsCompatibleFieldsService {
- rs := &ReportsCompatibleFieldsService{s: s}
- return rs
-}
-
-type ReportsCompatibleFieldsService struct {
- s *Service
-}
-
-func NewReportsFilesService(s *Service) *ReportsFilesService {
- rs := &ReportsFilesService{s: s}
- return rs
-}
-
-type ReportsFilesService struct {
- s *Service
-}
-
-func NewUserProfilesService(s *Service) *UserProfilesService {
- rs := &UserProfilesService{s: s}
- return rs
-}
-
-type UserProfilesService struct {
- s *Service
-}
-
-// Activities: Represents an activity group.
-type Activities struct {
- // Filters: List of activity filters. The dimension values need to be
- // all either of type "dfa:activity" or "dfa:activityGroup".
- Filters []*DimensionValue `json:"filters,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#activities.
- Kind string `json:"kind,omitempty"`
-
- // MetricNames: List of names of floodlight activity metrics.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Filters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Activities) MarshalJSON() ([]byte, error) {
- type noMethod Activities
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CompatibleFields: Represents a response to the queryCompatibleFields
-// method.
-type CompatibleFields struct {
- // CrossDimensionReachReportCompatibleFields: Contains items that are
- // compatible to be selected for a report of type
- // "CROSS_DIMENSION_REACH".
- CrossDimensionReachReportCompatibleFields *CrossDimensionReachReportCompatibleFields `json:"crossDimensionReachReportCompatibleFields,omitempty"`
-
- // FloodlightReportCompatibleFields: Contains items that are compatible
- // to be selected for a report of type "FLOODLIGHT".
- FloodlightReportCompatibleFields *FloodlightReportCompatibleFields `json:"floodlightReportCompatibleFields,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#compatibleFields.
- Kind string `json:"kind,omitempty"`
-
- // PathToConversionReportCompatibleFields: Contains items that are
- // compatible to be selected for a report of type "PATH_TO_CONVERSION".
- PathToConversionReportCompatibleFields *PathToConversionReportCompatibleFields `json:"pathToConversionReportCompatibleFields,omitempty"`
-
- // ReachReportCompatibleFields: Contains items that are compatible to be
- // selected for a report of type "REACH".
- ReachReportCompatibleFields *ReachReportCompatibleFields `json:"reachReportCompatibleFields,omitempty"`
-
- // ReportCompatibleFields: Contains items that are compatible to be
- // selected for a report of type "STANDARD".
- ReportCompatibleFields *ReportCompatibleFields `json:"reportCompatibleFields,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "CrossDimensionReachReportCompatibleFields") to unconditionally
- // include in API requests. By default, fields with empty values are
- // omitted from API requests. However, any non-pointer, non-interface
- // field appearing in ForceSendFields will be sent to the server
- // regardless of whether the field is empty or not. This may be used to
- // include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CompatibleFields) MarshalJSON() ([]byte, error) {
- type noMethod CompatibleFields
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CrossDimensionReachReportCompatibleFields: Represents fields that are
-// compatible to be selected for a report of type
-// "CROSS_DIMENSION_REACH".
-type CrossDimensionReachReportCompatibleFields struct {
- // Breakdown: Dimensions which are compatible to be selected in the
- // "breakdown" section of the report.
- Breakdown []*Dimension `json:"breakdown,omitempty"`
-
- // DimensionFilters: Dimensions which are compatible to be selected in
- // the "dimensionFilters" section of the report.
- DimensionFilters []*Dimension `json:"dimensionFilters,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#crossDimensionReachReportCompatibleFields.
- Kind string `json:"kind,omitempty"`
-
- // Metrics: Metrics which are compatible to be selected in the
- // "metricNames" section of the report.
- Metrics []*Metric `json:"metrics,omitempty"`
-
- // OverlapMetrics: Metrics which are compatible to be selected in the
- // "overlapMetricNames" section of the report.
- OverlapMetrics []*Metric `json:"overlapMetrics,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Breakdown") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CrossDimensionReachReportCompatibleFields) MarshalJSON() ([]byte, error) {
- type noMethod CrossDimensionReachReportCompatibleFields
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CustomRichMediaEvents: Represents a Custom Rich Media Events group.
-type CustomRichMediaEvents struct {
- // FilteredEventIds: List of custom rich media event IDs. Dimension
- // values must be all of type dfa:richMediaEventTypeIdAndName.
- FilteredEventIds []*DimensionValue `json:"filteredEventIds,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#customRichMediaEvents.
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "FilteredEventIds") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomRichMediaEvents) MarshalJSON() ([]byte, error) {
- type noMethod CustomRichMediaEvents
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DateRange: Represents a date range.
-type DateRange struct {
- // EndDate: The end date of the date range, inclusive. A string of the
- // format: "yyyy-MM-dd".
- EndDate string `json:"endDate,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#dateRange.
- Kind string `json:"kind,omitempty"`
-
- // RelativeDateRange: The date range relative to the date of when the
- // report is run, one of:
- // - "TODAY"
- // - "YESTERDAY"
- // - "WEEK_TO_DATE"
- // - "MONTH_TO_DATE"
- // - "QUARTER_TO_DATE"
- // - "YEAR_TO_DATE"
- // - "PREVIOUS_WEEK"
- // - "PREVIOUS_MONTH"
- // - "PREVIOUS_QUARTER"
- // - "PREVIOUS_YEAR"
- // - "LAST_7_DAYS"
- // - "LAST_30_DAYS"
- // - "LAST_90_DAYS"
- // - "LAST_365_DAYS"
- // - "LAST_24_MONTHS"
- RelativeDateRange string `json:"relativeDateRange,omitempty"`
-
- // StartDate: The start date of the date range, inclusive. A string of
- // the format: "yyyy-MM-dd".
- StartDate string `json:"startDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "EndDate") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DateRange) MarshalJSON() ([]byte, error) {
- type noMethod DateRange
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Dimension: Represents a dimension.
-type Dimension struct {
- // Kind: The kind of resource this is, in this case
- // dfareporting#dimension.
- Kind string `json:"kind,omitempty"`
-
- // Name: The dimension name, e.g. dfa:advertiser
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Dimension) MarshalJSON() ([]byte, error) {
- type noMethod Dimension
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DimensionFilter: Represents a dimension filter.
-type DimensionFilter struct {
- // DimensionName: The name of the dimension to filter.
- DimensionName string `json:"dimensionName,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#dimensionFilter.
- Kind string `json:"kind,omitempty"`
-
- // Value: The value of the dimension to filter.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DimensionFilter) MarshalJSON() ([]byte, error) {
- type noMethod DimensionFilter
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DimensionValue: Represents a DimensionValue resource.
-type DimensionValue struct {
- // DimensionName: The name of the dimension.
- DimensionName string `json:"dimensionName,omitempty"`
-
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Id: The ID associated with the value if available.
- Id string `json:"id,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#dimensionValue.
- Kind string `json:"kind,omitempty"`
-
- // MatchType: Determines how the 'value' field is matched when
- // filtering. One of:
- // - EXACT (default if not specified)
- // - CONTAINS
- // - BEGINS_WITH
- // - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable
- // length character sequences, it can be escaped with a backslash.)
- // Note, only paid search dimensions ('dfa:paidSearch*') allow a
- // matchType other than EXACT.
- MatchType string `json:"matchType,omitempty"`
-
- // Value: The value of the dimension.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DimensionValue) MarshalJSON() ([]byte, error) {
- type noMethod DimensionValue
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DimensionValueList: Represents the list of DimensionValue resources.
-type DimensionValueList struct {
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The dimension values returned in this response.
- Items []*DimensionValue `json:"items,omitempty"`
-
- // Kind: The kind of list this is, in this case
- // dfareporting#dimensionValueList.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through dimension
- // values. To retrieve the next page of results, set the next request's
- // "pageToken" to the value of this field. The page token is only valid
- // for a limited amount of time and should not be persisted.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DimensionValueList) MarshalJSON() ([]byte, error) {
- type noMethod DimensionValueList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DimensionValueRequest: Represents a DimensionValuesRequest.
-type DimensionValueRequest struct {
- // DimensionName: The name of the dimension for which values should be
- // requested.
- DimensionName string `json:"dimensionName,omitempty"`
-
- // EndDate: The end date of the date range for which to retrieve
- // dimension values. A string of the format: "yyyy-MM-dd".
- EndDate string `json:"endDate,omitempty"`
-
- // Filters: The list of filters by which to filter values. The filters
- // are ANDed.
- Filters []*DimensionFilter `json:"filters,omitempty"`
-
- // Kind: The kind of request this is, in this case
- // dfareporting#dimensionValueRequest.
- Kind string `json:"kind,omitempty"`
-
- // StartDate: The start date of the date range for which to retrieve
- // dimension values. A string of the format: "yyyy-MM-dd".
- StartDate string `json:"startDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DimensionValueRequest) MarshalJSON() ([]byte, error) {
- type noMethod DimensionValueRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// File: Represents a File resource. A File contains the meta-data for a
-// report run. It shows the status of the run and holds the urls to the
-// generated report data if the run is finished and the status is
-// "REPORT_AVAILABLE".
-type File struct {
- // DateRange: The date range for which the file has report data. The
- // date range will always be the absolute date range for which the
- // report is run.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // FileName: The file name of the file.
- FileName string `json:"fileName,omitempty"`
-
- // Format: The output format of the report. Only available once the file
- // is available.
- Format string `json:"format,omitempty"`
-
- // Id: The unique ID of this report file.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: The kind of resource this is, in this case dfareporting#file.
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedTime: The timestamp in milliseconds since epoch when this
- // file was last modified.
- LastModifiedTime int64 `json:"lastModifiedTime,omitempty,string"`
-
- // ReportId: The ID of the report this file was generated from.
- ReportId int64 `json:"reportId,omitempty,string"`
-
- // Status: The status of the report file, one of:
- // - "PROCESSING"
- // - "REPORT_AVAILABLE"
- // - "FAILED"
- // - "CANCELLED"
- Status string `json:"status,omitempty"`
-
- // Urls: The urls where the completed report file can be downloaded.
- Urls *FileUrls `json:"urls,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "DateRange") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *File) MarshalJSON() ([]byte, error) {
- type noMethod File
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FileUrls: The urls where the completed report file can be downloaded.
-type FileUrls struct {
- // ApiUrl: The url for downloading the report data through the API.
- ApiUrl string `json:"apiUrl,omitempty"`
-
- // BrowserUrl: The url for downloading the report data through a
- // browser.
- BrowserUrl string `json:"browserUrl,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ApiUrl") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FileUrls) MarshalJSON() ([]byte, error) {
- type noMethod FileUrls
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FileList: Represents the list of File resources.
-type FileList struct {
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The files returned in this response.
- Items []*File `json:"items,omitempty"`
-
- // Kind: The kind of list this is, in this case dfareporting#fileList.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through files. To
- // retrieve the next page of results, set the next request's "pageToken"
- // to the value of this field. The page token is only valid for a
- // limited amount of time and should not be persisted.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FileList) MarshalJSON() ([]byte, error) {
- type noMethod FileList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightReportCompatibleFields: Represents fields that are
-// compatible to be selected for a report of type "FlOODLIGHT".
-type FloodlightReportCompatibleFields struct {
- // DimensionFilters: Dimensions which are compatible to be selected in
- // the "dimensionFilters" section of the report.
- DimensionFilters []*Dimension `json:"dimensionFilters,omitempty"`
-
- // Dimensions: Dimensions which are compatible to be selected in the
- // "dimensions" section of the report.
- Dimensions []*Dimension `json:"dimensions,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#floodlightReportCompatibleFields.
- Kind string `json:"kind,omitempty"`
-
- // Metrics: Metrics which are compatible to be selected in the
- // "metricNames" section of the report.
- Metrics []*Metric `json:"metrics,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionFilters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightReportCompatibleFields) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightReportCompatibleFields
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Metric: Represents a metric.
-type Metric struct {
- // Kind: The kind of resource this is, in this case dfareporting#metric.
- Kind string `json:"kind,omitempty"`
-
- // Name: The metric name, e.g. dfa:impressions
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Metric) MarshalJSON() ([]byte, error) {
- type noMethod Metric
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PathToConversionReportCompatibleFields: Represents fields that are
-// compatible to be selected for a report of type "PATH_TO_CONVERSION".
-type PathToConversionReportCompatibleFields struct {
- // ConversionDimensions: Conversion dimensions which are compatible to
- // be selected in the "conversionDimensions" section of the report.
- ConversionDimensions []*Dimension `json:"conversionDimensions,omitempty"`
-
- // CustomFloodlightVariables: Custom floodlight variables which are
- // compatible to be selected in the "customFloodlightVariables" section
- // of the report.
- CustomFloodlightVariables []*Dimension `json:"customFloodlightVariables,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#pathToConversionReportCompatibleFields.
- Kind string `json:"kind,omitempty"`
-
- // Metrics: Metrics which are compatible to be selected in the
- // "metricNames" section of the report.
- Metrics []*Metric `json:"metrics,omitempty"`
-
- // PerInteractionDimensions: Per-interaction dimensions which are
- // compatible to be selected in the "perInteractionDimensions" section
- // of the report.
- PerInteractionDimensions []*Dimension `json:"perInteractionDimensions,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "ConversionDimensions") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PathToConversionReportCompatibleFields) MarshalJSON() ([]byte, error) {
- type noMethod PathToConversionReportCompatibleFields
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReachReportCompatibleFields: Represents fields that are compatible to
-// be selected for a report of type "REACH".
-type ReachReportCompatibleFields struct {
- // DimensionFilters: Dimensions which are compatible to be selected in
- // the "dimensionFilters" section of the report.
- DimensionFilters []*Dimension `json:"dimensionFilters,omitempty"`
-
- // Dimensions: Dimensions which are compatible to be selected in the
- // "dimensions" section of the report.
- Dimensions []*Dimension `json:"dimensions,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#reachReportCompatibleFields.
- Kind string `json:"kind,omitempty"`
-
- // Metrics: Metrics which are compatible to be selected in the
- // "metricNames" section of the report.
- Metrics []*Metric `json:"metrics,omitempty"`
-
- // PivotedActivityMetrics: Metrics which are compatible to be selected
- // as activity metrics to pivot on in the "activities" section of the
- // report.
- PivotedActivityMetrics []*Metric `json:"pivotedActivityMetrics,omitempty"`
-
- // ReachByFrequencyMetrics: Metrics which are compatible to be selected
- // in the "reachByFrequencyMetricNames" section of the report.
- ReachByFrequencyMetrics []*Metric `json:"reachByFrequencyMetrics,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionFilters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReachReportCompatibleFields) MarshalJSON() ([]byte, error) {
- type noMethod ReachReportCompatibleFields
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Recipient: Represents a recipient.
-type Recipient struct {
- // DeliveryType: The delivery type for the recipient, one of:
- // - "ATTACHMENT"
- // - "LINK"
- DeliveryType string `json:"deliveryType,omitempty"`
-
- // Email: The email address of the recipient.
- Email string `json:"email,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#recipient.
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DeliveryType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Recipient) MarshalJSON() ([]byte, error) {
- type noMethod Recipient
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Report: Represents a Report resource.
-type Report struct {
- // AccountId: The account ID to which this report belongs.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // ActiveGrpCriteria: The report criteria for a report of type
- // "ACTIVE_GRP".
- ActiveGrpCriteria *ReportActiveGrpCriteria `json:"activeGrpCriteria,omitempty"`
-
- // Criteria: The report criteria for a report of type "STANDARD".
- Criteria *ReportCriteria `json:"criteria,omitempty"`
-
- // CrossDimensionReachCriteria: The report criteria for a report of type
- // "CROSS_DIMENSION_REACH".
- CrossDimensionReachCriteria *ReportCrossDimensionReachCriteria `json:"crossDimensionReachCriteria,omitempty"`
-
- // Delivery: The report's email delivery settings.
- Delivery *ReportDelivery `json:"delivery,omitempty"`
-
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // FileName: The file name used when generating report files for this
- // report.
- FileName string `json:"fileName,omitempty"`
-
- // FloodlightCriteria: The report criteria for a report of type
- // "FLOODLIGHT".
- FloodlightCriteria *ReportFloodlightCriteria `json:"floodlightCriteria,omitempty"`
-
- // Format: The output format of the report, one of:
- // - "CSV"
- // - "EXCEL" If not specified, default format is "CSV". Note that the
- // actual format in the completed report file might differ if for
- // instance the report's size exceeds the format's capabilities. "CSV"
- // will then be the fallback format.
- Format string `json:"format,omitempty"`
-
- // Id: The unique ID identifying this report resource.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: The kind of resource this is, in this case dfareporting#report.
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedTime: The timestamp (in milliseconds since epoch) of when
- // this report was last modified.
- LastModifiedTime uint64 `json:"lastModifiedTime,omitempty,string"`
-
- // Name: The name of the report.
- Name string `json:"name,omitempty"`
-
- // OwnerProfileId: The user profile id of the owner of this report.
- OwnerProfileId int64 `json:"ownerProfileId,omitempty,string"`
-
- // PathToConversionCriteria: The report criteria for a report of type
- // "PATH_TO_CONVERSION".
- PathToConversionCriteria *ReportPathToConversionCriteria `json:"pathToConversionCriteria,omitempty"`
-
- // ReachCriteria: The report criteria for a report of type "REACH".
- ReachCriteria *ReportReachCriteria `json:"reachCriteria,omitempty"`
-
- // Schedule: The report's schedule. Can only be set if the report's
- // 'dateRange' is a relative date range and the relative date range is
- // not "TODAY".
- Schedule *ReportSchedule `json:"schedule,omitempty"`
-
- // SubAccountId: The subbaccount ID to which this report belongs if
- // applicable.
- SubAccountId int64 `json:"subAccountId,omitempty,string"`
-
- // Type: The type of the report, one of:
- // - STANDARD
- // - REACH
- // - ACTIVE_GRP
- // - PATH_TO_CONVERSION
- // - FLOODLIGHT
- // - CROSS_DIMENSION_REACH
- Type string `json:"type,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Report) MarshalJSON() ([]byte, error) {
- type noMethod Report
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportActiveGrpCriteria: The report criteria for a report of type
-// "ACTIVE_GRP".
-type ReportActiveGrpCriteria struct {
- // DateRange: The date range this report should be run for.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // DimensionFilters: The list of filters on which dimensions are
- // filtered.
- // Filters for different dimensions are ANDed, filters for the same
- // dimension are grouped together and ORed.
- // A valid active GRP report needs to have exactly one DimensionValue
- // for the United States in addition to any advertiser or campaign
- // dimension values.
- DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`
-
- // Dimensions: The list of dimensions the report should include.
- Dimensions []*SortedDimension `json:"dimensions,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DateRange") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportActiveGrpCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportActiveGrpCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportCriteria: The report criteria for a report of type "STANDARD".
-type ReportCriteria struct {
- // Activities: Activity group.
- Activities *Activities `json:"activities,omitempty"`
-
- // CustomRichMediaEvents: Custom Rich Media Events group.
- CustomRichMediaEvents *CustomRichMediaEvents `json:"customRichMediaEvents,omitempty"`
-
- // DateRange: The date range for which this report should be run.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // DimensionFilters: The list of filters on which dimensions are
- // filtered.
- // Filters for different dimensions are ANDed, filters for the same
- // dimension are grouped together and ORed.
- DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`
-
- // Dimensions: The list of standard dimensions the report should
- // include.
- Dimensions []*SortedDimension `json:"dimensions,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Activities") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportCrossDimensionReachCriteria: The report criteria for a report
-// of type "CROSS_DIMENSION_REACH".
-type ReportCrossDimensionReachCriteria struct {
- // Breakdown: The list of dimensions the report should include.
- Breakdown []*SortedDimension `json:"breakdown,omitempty"`
-
- // DateRange: The date range this report should be run for.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // Dimension: The dimension option, one of:
- // - "ADVERTISER"
- // - "CAMPAIGN"
- // - "SITE_BY_ADVERTISER"
- // - "SITE_BY_CAMPAIGN"
- Dimension string `json:"dimension,omitempty"`
-
- // DimensionFilters: The list of filters on which dimensions are
- // filtered.
- DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // OverlapMetricNames: The list of names of overlap metrics the report
- // should include.
- OverlapMetricNames []string `json:"overlapMetricNames,omitempty"`
-
- // Pivoted: Whether the report is pivoted or not. Defaults to true.
- Pivoted bool `json:"pivoted,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Breakdown") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportCrossDimensionReachCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportCrossDimensionReachCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportDelivery: The report's email delivery settings.
-type ReportDelivery struct {
- // EmailOwner: Whether the report should be emailed to the report owner.
- EmailOwner bool `json:"emailOwner,omitempty"`
-
- // EmailOwnerDeliveryType: The type of delivery for the owner to
- // receive, if enabled. One of:
- // - "ATTACHMENT"
- // - "LINK"
- EmailOwnerDeliveryType string `json:"emailOwnerDeliveryType,omitempty"`
-
- // Message: The message to be sent with each email.
- Message string `json:"message,omitempty"`
-
- // Recipients: The list of recipients to which to email the report.
- Recipients []*Recipient `json:"recipients,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "EmailOwner") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportDelivery) MarshalJSON() ([]byte, error) {
- type noMethod ReportDelivery
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportFloodlightCriteria: The report criteria for a report of type
-// "FLOODLIGHT".
-type ReportFloodlightCriteria struct {
- // CustomRichMediaEvents: The list of custom rich media events to
- // include.
- CustomRichMediaEvents []*DimensionValue `json:"customRichMediaEvents,omitempty"`
-
- // DateRange: The date range this report should be run for.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // DimensionFilters: The list of filters on which dimensions are
- // filtered.
- // Filters for different dimensions are ANDed, filters for the same
- // dimension are grouped together and ORed.
- DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`
-
- // Dimensions: The list of dimensions the report should include.
- Dimensions []*SortedDimension `json:"dimensions,omitempty"`
-
- // FloodlightConfigId: The floodlight ID for which to show data in this
- // report. All advertisers associated with that ID will automatically be
- // added. The dimension of the value needs to be
- // 'dfa:floodlightConfigId'.
- FloodlightConfigId *DimensionValue `json:"floodlightConfigId,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ReportProperties: The properties of the report.
- ReportProperties *ReportFloodlightCriteriaReportProperties `json:"reportProperties,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "CustomRichMediaEvents") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportFloodlightCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportFloodlightCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportFloodlightCriteriaReportProperties: The properties of the
-// report.
-type ReportFloodlightCriteriaReportProperties struct {
- // IncludeAttributedIPConversions: Include conversions that have no
- // cookie, but do have an exposure path.
- IncludeAttributedIPConversions bool `json:"includeAttributedIPConversions,omitempty"`
-
- // IncludeUnattributedCookieConversions: Include conversions of users
- // with a DoubleClick cookie but without an exposure. That means the
- // user did not click or see an ad from the advertiser within the
- // Floodlight group, or that the interaction happened outside the
- // lookback window.
- IncludeUnattributedCookieConversions bool `json:"includeUnattributedCookieConversions,omitempty"`
-
- // IncludeUnattributedIPConversions: Include conversions that have no
- // associated cookies and no exposures. It’s therefore impossible to
- // know how the user was exposed to your ads during the lookback window
- // prior to a conversion.
- IncludeUnattributedIPConversions bool `json:"includeUnattributedIPConversions,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "IncludeAttributedIPConversions") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportFloodlightCriteriaReportProperties) MarshalJSON() ([]byte, error) {
- type noMethod ReportFloodlightCriteriaReportProperties
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportPathToConversionCriteria: The report criteria for a report of
-// type "PATH_TO_CONVERSION".
-type ReportPathToConversionCriteria struct {
- // ActivityFilters: The list of 'dfa:activity' values to filter on.
- ActivityFilters []*DimensionValue `json:"activityFilters,omitempty"`
-
- // ConversionDimensions: The list of conversion dimensions the report
- // should include.
- ConversionDimensions []*SortedDimension `json:"conversionDimensions,omitempty"`
-
- // CustomFloodlightVariables: The list of custom floodlight variables
- // the report should include.
- CustomFloodlightVariables []*SortedDimension `json:"customFloodlightVariables,omitempty"`
-
- // CustomRichMediaEvents: The list of custom rich media events to
- // include.
- CustomRichMediaEvents []*DimensionValue `json:"customRichMediaEvents,omitempty"`
-
- // DateRange: The date range this report should be run for.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // FloodlightConfigId: The floodlight ID for which to show data in this
- // report. All advertisers associated with that ID will automatically be
- // added. The dimension of the value needs to be
- // 'dfa:floodlightConfigId'.
- FloodlightConfigId *DimensionValue `json:"floodlightConfigId,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // PerInteractionDimensions: The list of per interaction dimensions the
- // report should include.
- PerInteractionDimensions []*SortedDimension `json:"perInteractionDimensions,omitempty"`
-
- // ReportProperties: The properties of the report.
- ReportProperties *ReportPathToConversionCriteriaReportProperties `json:"reportProperties,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ActivityFilters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportPathToConversionCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportPathToConversionCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportPathToConversionCriteriaReportProperties: The properties of the
-// report.
-type ReportPathToConversionCriteriaReportProperties struct {
- // ClicksLookbackWindow: DFA checks to see if a click interaction
- // occurred within the specified period of time before a conversion. By
- // default the value is pulled from Floodlight or you can manually enter
- // a custom value. Valid values: 1-90.
- ClicksLookbackWindow int64 `json:"clicksLookbackWindow,omitempty"`
-
- // ImpressionsLookbackWindow: DFA checks to see if an impression
- // interaction occurred within the specified period of time before a
- // conversion. By default the value is pulled from Floodlight or you can
- // manually enter a custom value. Valid values: 1-90.
- ImpressionsLookbackWindow int64 `json:"impressionsLookbackWindow,omitempty"`
-
- // IncludeAttributedIPConversions: Deprecated: has no effect.
- IncludeAttributedIPConversions bool `json:"includeAttributedIPConversions,omitempty"`
-
- // IncludeUnattributedCookieConversions: Include conversions of users
- // with a DoubleClick cookie but without an exposure. That means the
- // user did not click or see an ad from the advertiser within the
- // Floodlight group, or that the interaction happened outside the
- // lookback window.
- IncludeUnattributedCookieConversions bool `json:"includeUnattributedCookieConversions,omitempty"`
-
- // IncludeUnattributedIPConversions: Include conversions that have no
- // associated cookies and no exposures. It’s therefore impossible to
- // know how the user was exposed to your ads during the lookback window
- // prior to a conversion.
- IncludeUnattributedIPConversions bool `json:"includeUnattributedIPConversions,omitempty"`
-
- // MaximumClickInteractions: The maximum number of click interactions to
- // include in the report. Advertisers currently paying for E2C reports
- // get up to 200 (100 clicks, 100 impressions). If another advertiser in
- // your network is paying for E2C, you can have up to 5 total exposures
- // per report.
- MaximumClickInteractions int64 `json:"maximumClickInteractions,omitempty"`
-
- // MaximumImpressionInteractions: The maximum number of click
- // interactions to include in the report. Advertisers currently paying
- // for E2C reports get up to 200 (100 clicks, 100 impressions). If
- // another advertiser in your network is paying for E2C, you can have up
- // to 5 total exposures per report.
- MaximumImpressionInteractions int64 `json:"maximumImpressionInteractions,omitempty"`
-
- // MaximumInteractionGap: The maximum amount of time that can take place
- // between interactions (clicks or impressions) by the same user. Valid
- // values: 1-90.
- MaximumInteractionGap int64 `json:"maximumInteractionGap,omitempty"`
-
- // PivotOnInteractionPath: Enable pivoting on interaction path.
- PivotOnInteractionPath bool `json:"pivotOnInteractionPath,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "ClicksLookbackWindow") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportPathToConversionCriteriaReportProperties) MarshalJSON() ([]byte, error) {
- type noMethod ReportPathToConversionCriteriaReportProperties
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportReachCriteria: The report criteria for a report of type
-// "REACH".
-type ReportReachCriteria struct {
- // Activities: Activity group.
- Activities *Activities `json:"activities,omitempty"`
-
- // CustomRichMediaEvents: Custom Rich Media Events group.
- CustomRichMediaEvents *CustomRichMediaEvents `json:"customRichMediaEvents,omitempty"`
-
- // DateRange: The date range this report should be run for.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // DimensionFilters: The list of filters on which dimensions are
- // filtered.
- // Filters for different dimensions are ANDed, filters for the same
- // dimension are grouped together and ORed.
- DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`
-
- // Dimensions: The list of dimensions the report should include.
- Dimensions []*SortedDimension `json:"dimensions,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ReachByFrequencyMetricNames: The list of names of Reach By Frequency
- // metrics the report should include.
- ReachByFrequencyMetricNames []string `json:"reachByFrequencyMetricNames,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Activities") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportReachCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportReachCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportSchedule: The report's schedule. Can only be set if the
-// report's 'dateRange' is a relative date range and the relative date
-// range is not "TODAY".
-type ReportSchedule struct {
- // Active: Whether the schedule is active or not. Must be set to either
- // true or false.
- Active bool `json:"active,omitempty"`
-
- // Every: Defines every how many days, weeks or months the report should
- // be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or
- // "MONTHLY".
- Every int64 `json:"every,omitempty"`
-
- // ExpirationDate: The expiration date when the scheduled report stops
- // running.
- ExpirationDate string `json:"expirationDate,omitempty"`
-
- // Repeats: The interval for which the report is repeated, one of:
- // - "DAILY", also requires field "every" to be set.
- // - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to
- // be set.
- // - "TWICE_A_MONTH"
- // - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to
- // be set.
- // - "QUARTERLY"
- // - "YEARLY"
- Repeats string `json:"repeats,omitempty"`
-
- // RepeatsOnWeekDays: List of week days "WEEKLY" on which scheduled
- // reports should run.
- RepeatsOnWeekDays []string `json:"repeatsOnWeekDays,omitempty"`
-
- // RunsOnDayOfMonth: Enum to define for "MONTHLY" scheduled reports
- // whether reports should be repeated on the same day of the month as
- // "startDate" or the same day of the week of the month. Possible values
- // are:
- // - DAY_OF_MONTH
- // - WEEK_OF_MONTH
- // Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02),
- // "DAY_OF_MONTH" would run subsequent reports on the 2nd of every
- // Month, and "WEEK_OF_MONTH" would run subsequent reports on the first
- // Monday of the month.
- RunsOnDayOfMonth string `json:"runsOnDayOfMonth,omitempty"`
-
- // StartDate: Start date of date range for which scheduled reports
- // should be run.
- StartDate string `json:"startDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Active") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportSchedule) MarshalJSON() ([]byte, error) {
- type noMethod ReportSchedule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportCompatibleFields: Represents fields that are compatible to be
-// selected for a report of type "STANDARD".
-type ReportCompatibleFields struct {
- // DimensionFilters: Dimensions which are compatible to be selected in
- // the "dimensionFilters" section of the report.
- DimensionFilters []*Dimension `json:"dimensionFilters,omitempty"`
-
- // Dimensions: Dimensions which are compatible to be selected in the
- // "dimensions" section of the report.
- Dimensions []*Dimension `json:"dimensions,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#reportCompatibleFields.
- Kind string `json:"kind,omitempty"`
-
- // Metrics: Metrics which are compatible to be selected in the
- // "metricNames" section of the report.
- Metrics []*Metric `json:"metrics,omitempty"`
-
- // PivotedActivityMetrics: Metrics which are compatible to be selected
- // as activity metrics to pivot on in the "activities" section of the
- // report.
- PivotedActivityMetrics []*Metric `json:"pivotedActivityMetrics,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionFilters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportCompatibleFields) MarshalJSON() ([]byte, error) {
- type noMethod ReportCompatibleFields
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportList: Represents the list of reports.
-type ReportList struct {
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The reports returned in this response.
- Items []*Report `json:"items,omitempty"`
-
- // Kind: The kind of list this is, in this case dfareporting#reportList.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through reports. To
- // retrieve the next page of results, set the next request's "pageToken"
- // to the value of this field. The page token is only valid for a
- // limited amount of time and should not be persisted.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportList) MarshalJSON() ([]byte, error) {
- type noMethod ReportList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SortedDimension: Represents a sorted dimension.
-type SortedDimension struct {
- // Kind: The kind of resource this is, in this case
- // dfareporting#sortedDimension.
- Kind string `json:"kind,omitempty"`
-
- // Name: The name of the dimension.
- Name string `json:"name,omitempty"`
-
- // SortOrder: An optional sort order for the dimension column, one of:
- //
- // - "ASCENDING"
- // - "DESCENDING"
- SortOrder string `json:"sortOrder,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SortedDimension) MarshalJSON() ([]byte, error) {
- type noMethod SortedDimension
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserProfile: Represents a UserProfile resource.
-type UserProfile struct {
- // AccountId: The account ID to which this profile belongs.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AccountName: The account name this profile belongs to.
- AccountName string `json:"accountName,omitempty"`
-
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#userProfile.
- Kind string `json:"kind,omitempty"`
-
- // ProfileId: The unique ID of the user profile.
- ProfileId int64 `json:"profileId,omitempty,string"`
-
- // SubAccountId: The sub account ID this profile belongs to if
- // applicable.
- SubAccountId int64 `json:"subAccountId,omitempty,string"`
-
- // SubAccountName: The sub account name this profile belongs to if
- // applicable.
- SubAccountName string `json:"subAccountName,omitempty"`
-
- // UserName: The user name.
- UserName string `json:"userName,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserProfile) MarshalJSON() ([]byte, error) {
- type noMethod UserProfile
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserProfileList: Represents the list of user profiles.
-type UserProfileList struct {
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The user profiles returned in this response.
- Items []*UserProfile `json:"items,omitempty"`
-
- // Kind: The kind of list this is, in this case
- // dfareporting#userProfileList.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserProfileList) MarshalJSON() ([]byte, error) {
- type noMethod UserProfileList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "dfareporting.dimensionValues.query":
-
-type DimensionValuesQueryCall struct {
- s *Service
- profileId int64
- dimensionvaluerequest *DimensionValueRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Query: Retrieves list of report dimension values for a list of
-// filters.
-func (r *DimensionValuesService) Query(profileId int64, dimensionvaluerequest *DimensionValueRequest) *DimensionValuesQueryCall {
- c := &DimensionValuesQueryCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.dimensionvaluerequest = dimensionvaluerequest
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *DimensionValuesQueryCall) MaxResults(maxResults int64) *DimensionValuesQueryCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous result page.
-func (c *DimensionValuesQueryCall) PageToken(pageToken string) *DimensionValuesQueryCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DimensionValuesQueryCall) Fields(s ...googleapi.Field) *DimensionValuesQueryCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DimensionValuesQueryCall) Context(ctx context.Context) *DimensionValuesQueryCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DimensionValuesQueryCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.dimensionvaluerequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/dimensionvalues/query")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.dimensionValues.query" call.
-// Exactly one of *DimensionValueList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *DimensionValueList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DimensionValuesQueryCall) Do() (*DimensionValueList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DimensionValueList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves list of report dimension values for a list of filters.",
- // "httpMethod": "POST",
- // "id": "dfareporting.dimensionValues.query",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "100",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/dimensionvalues/query",
- // "request": {
- // "$ref": "DimensionValueRequest"
- // },
- // "response": {
- // "$ref": "DimensionValueList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.files.get":
-
-type FilesGetCall struct {
- s *Service
- reportId int64
- fileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves a report file by its report ID and file ID.
-func (r *FilesService) Get(reportId int64, fileId int64) *FilesGetCall {
- c := &FilesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.reportId = reportId
- c.fileId = fileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FilesGetCall) Fields(s ...googleapi.Field) *FilesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *FilesGetCall) IfNoneMatch(entityTag string) *FilesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do and Download methods.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FilesGetCall) Context(ctx context.Context) *FilesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FilesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "reports/{reportId}/files/{fileId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "reportId": strconv.FormatInt(c.reportId, 10),
- "fileId": strconv.FormatInt(c.fileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Download fetches the API endpoint's "media" value, instead of the normal
-// API response value. If the returned error is nil, the Response is guaranteed to
-// have a 2xx status code. Callers must close the Response.Body as usual.
-func (c *FilesGetCall) Download() (*http.Response, error) {
- res, err := c.doRequest("media")
- if err != nil {
- return nil, err
- }
- if err := googleapi.CheckMediaResponse(res); err != nil {
- res.Body.Close()
- return nil, err
- }
- return res, nil
-}
-
-// Do executes the "dfareporting.files.get" call.
-// Exactly one of *File or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *File.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *FilesGetCall) Do() (*File, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &File{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a report file by its report ID and file ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.files.get",
- // "parameterOrder": [
- // "reportId",
- // "fileId"
- // ],
- // "parameters": {
- // "fileId": {
- // "description": "The ID of the report file.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "reports/{reportId}/files/{fileId}",
- // "response": {
- // "$ref": "File"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ],
- // "supportsMediaDownload": true
- // }
-
-}
-
-// method id "dfareporting.files.list":
-
-type FilesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists files for a user profile.
-func (r *FilesService) List(profileId int64) *FilesListCall {
- c := &FilesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *FilesListCall) MaxResults(maxResults int64) *FilesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous result page.
-func (c *FilesListCall) PageToken(pageToken string) *FilesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Scope sets the optional parameter "scope": The scope that defines
-// which results are returned, default is 'MINE'.
-//
-// Possible values:
-// "ALL" - All files in account.
-// "MINE" (default) - My files.
-// "SHARED_WITH_ME" - Files shared with me.
-func (c *FilesListCall) Scope(scope string) *FilesListCall {
- c.opt_["scope"] = scope
- return c
-}
-
-// SortField sets the optional parameter "sortField": The field by which
-// to sort the list.
-//
-// Possible values:
-// "ID" - Sort by file ID.
-// "LAST_MODIFIED_TIME" (default) - Sort by 'lastmodifiedAt' field.
-func (c *FilesListCall) SortField(sortField string) *FilesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is 'DESCENDING'.
-//
-// Possible values:
-// "ASCENDING" - Ascending order.
-// "DESCENDING" (default) - Descending order.
-func (c *FilesListCall) SortOrder(sortOrder string) *FilesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FilesListCall) Fields(s ...googleapi.Field) *FilesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *FilesListCall) IfNoneMatch(entityTag string) *FilesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FilesListCall) Context(ctx context.Context) *FilesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FilesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["scope"]; ok {
- params.Set("scope", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/files")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.files.list" call.
-// Exactly one of *FileList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *FileList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *FilesListCall) Do() (*FileList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FileList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists files for a user profile.",
- // "httpMethod": "GET",
- // "id": "dfareporting.files.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "scope": {
- // "default": "MINE",
- // "description": "The scope that defines which results are returned, default is 'MINE'.",
- // "enum": [
- // "ALL",
- // "MINE",
- // "SHARED_WITH_ME"
- // ],
- // "enumDescriptions": [
- // "All files in account.",
- // "My files.",
- // "Files shared with me."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "default": "LAST_MODIFIED_TIME",
- // "description": "The field by which to sort the list.",
- // "enum": [
- // "ID",
- // "LAST_MODIFIED_TIME"
- // ],
- // "enumDescriptions": [
- // "Sort by file ID.",
- // "Sort by 'lastmodifiedAt' field."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "default": "DESCENDING",
- // "description": "Order of sorted results, default is 'DESCENDING'.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "Ascending order.",
- // "Descending order."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/files",
- // "response": {
- // "$ref": "FileList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.delete":
-
-type ReportsDeleteCall struct {
- s *Service
- profileId int64
- reportId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes a report by its ID.
-func (r *ReportsService) Delete(profileId int64, reportId int64) *ReportsDeleteCall {
- c := &ReportsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsDeleteCall) Fields(s ...googleapi.Field) *ReportsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsDeleteCall) Context(ctx context.Context) *ReportsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.delete" call.
-func (c *ReportsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes a report by its ID.",
- // "httpMethod": "DELETE",
- // "id": "dfareporting.reports.delete",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.get":
-
-type ReportsGetCall struct {
- s *Service
- profileId int64
- reportId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves a report by its ID.
-func (r *ReportsService) Get(profileId int64, reportId int64) *ReportsGetCall {
- c := &ReportsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsGetCall) Fields(s ...googleapi.Field) *ReportsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsGetCall) IfNoneMatch(entityTag string) *ReportsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsGetCall) Context(ctx context.Context) *ReportsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.get" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsGetCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a report by its ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.reports.get",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}",
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.insert":
-
-type ReportsInsertCall struct {
- s *Service
- profileId int64
- report *Report
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a report.
-func (r *ReportsService) Insert(profileId int64, report *Report) *ReportsInsertCall {
- c := &ReportsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.report = report
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsInsertCall) Fields(s ...googleapi.Field) *ReportsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsInsertCall) Context(ctx context.Context) *ReportsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.report)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.insert" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsInsertCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a report.",
- // "httpMethod": "POST",
- // "id": "dfareporting.reports.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports",
- // "request": {
- // "$ref": "Report"
- // },
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.list":
-
-type ReportsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves list of reports.
-func (r *ReportsService) List(profileId int64) *ReportsListCall {
- c := &ReportsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *ReportsListCall) MaxResults(maxResults int64) *ReportsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous result page.
-func (c *ReportsListCall) PageToken(pageToken string) *ReportsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Scope sets the optional parameter "scope": The scope that defines
-// which results are returned, default is 'MINE'.
-//
-// Possible values:
-// "ALL" - All reports in account.
-// "MINE" (default) - My reports.
-func (c *ReportsListCall) Scope(scope string) *ReportsListCall {
- c.opt_["scope"] = scope
- return c
-}
-
-// SortField sets the optional parameter "sortField": The field by which
-// to sort the list.
-//
-// Possible values:
-// "ID" - Sort by report ID.
-// "LAST_MODIFIED_TIME" (default) - Sort by 'lastModifiedTime' field.
-// "NAME" - Sort by name of reports.
-func (c *ReportsListCall) SortField(sortField string) *ReportsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is 'DESCENDING'.
-//
-// Possible values:
-// "ASCENDING" - Ascending order.
-// "DESCENDING" (default) - Descending order.
-func (c *ReportsListCall) SortOrder(sortOrder string) *ReportsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsListCall) Fields(s ...googleapi.Field) *ReportsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsListCall) IfNoneMatch(entityTag string) *ReportsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsListCall) Context(ctx context.Context) *ReportsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["scope"]; ok {
- params.Set("scope", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.list" call.
-// Exactly one of *ReportList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ReportList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ReportsListCall) Do() (*ReportList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ReportList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves list of reports.",
- // "httpMethod": "GET",
- // "id": "dfareporting.reports.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "scope": {
- // "default": "MINE",
- // "description": "The scope that defines which results are returned, default is 'MINE'.",
- // "enum": [
- // "ALL",
- // "MINE"
- // ],
- // "enumDescriptions": [
- // "All reports in account.",
- // "My reports."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "default": "LAST_MODIFIED_TIME",
- // "description": "The field by which to sort the list.",
- // "enum": [
- // "ID",
- // "LAST_MODIFIED_TIME",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "Sort by report ID.",
- // "Sort by 'lastModifiedTime' field.",
- // "Sort by name of reports."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "default": "DESCENDING",
- // "description": "Order of sorted results, default is 'DESCENDING'.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "Ascending order.",
- // "Descending order."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports",
- // "response": {
- // "$ref": "ReportList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.patch":
-
-type ReportsPatchCall struct {
- s *Service
- profileId int64
- reportId int64
- report *Report
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates a report. This method supports patch semantics.
-func (r *ReportsService) Patch(profileId int64, reportId int64, report *Report) *ReportsPatchCall {
- c := &ReportsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- c.report = report
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsPatchCall) Fields(s ...googleapi.Field) *ReportsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsPatchCall) Context(ctx context.Context) *ReportsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.report)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.patch" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsPatchCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a report. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.reports.patch",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}",
- // "request": {
- // "$ref": "Report"
- // },
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.run":
-
-type ReportsRunCall struct {
- s *Service
- profileId int64
- reportId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Run: Runs a report.
-func (r *ReportsService) Run(profileId int64, reportId int64) *ReportsRunCall {
- c := &ReportsRunCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- return c
-}
-
-// Synchronous sets the optional parameter "synchronous": If set and
-// true, tries to run the report synchronously.
-func (c *ReportsRunCall) Synchronous(synchronous bool) *ReportsRunCall {
- c.opt_["synchronous"] = synchronous
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsRunCall) Fields(s ...googleapi.Field) *ReportsRunCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsRunCall) Context(ctx context.Context) *ReportsRunCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsRunCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["synchronous"]; ok {
- params.Set("synchronous", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}/run")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.run" call.
-// Exactly one of *File or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *File.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *ReportsRunCall) Do() (*File, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &File{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Runs a report.",
- // "httpMethod": "POST",
- // "id": "dfareporting.reports.run",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "synchronous": {
- // "description": "If set and true, tries to run the report synchronously.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}/run",
- // "response": {
- // "$ref": "File"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.update":
-
-type ReportsUpdateCall struct {
- s *Service
- profileId int64
- reportId int64
- report *Report
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates a report.
-func (r *ReportsService) Update(profileId int64, reportId int64, report *Report) *ReportsUpdateCall {
- c := &ReportsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- c.report = report
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsUpdateCall) Fields(s ...googleapi.Field) *ReportsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsUpdateCall) Context(ctx context.Context) *ReportsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.report)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.update" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsUpdateCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a report.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.reports.update",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}",
- // "request": {
- // "$ref": "Report"
- // },
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.compatibleFields.query":
-
-type ReportsCompatibleFieldsQueryCall struct {
- s *Service
- profileId int64
- report *Report
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Query: Returns the fields that are compatible to be selected in the
-// respective sections of a report criteria, given the fields already
-// selected in the input report and user permissions.
-func (r *ReportsCompatibleFieldsService) Query(profileId int64, report *Report) *ReportsCompatibleFieldsQueryCall {
- c := &ReportsCompatibleFieldsQueryCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.report = report
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsCompatibleFieldsQueryCall) Fields(s ...googleapi.Field) *ReportsCompatibleFieldsQueryCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsCompatibleFieldsQueryCall) Context(ctx context.Context) *ReportsCompatibleFieldsQueryCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsCompatibleFieldsQueryCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.report)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/compatiblefields/query")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.compatibleFields.query" call.
-// Exactly one of *CompatibleFields or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CompatibleFields.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ReportsCompatibleFieldsQueryCall) Do() (*CompatibleFields, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CompatibleFields{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.",
- // "httpMethod": "POST",
- // "id": "dfareporting.reports.compatibleFields.query",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/compatiblefields/query",
- // "request": {
- // "$ref": "Report"
- // },
- // "response": {
- // "$ref": "CompatibleFields"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.files.get":
-
-type ReportsFilesGetCall struct {
- s *Service
- profileId int64
- reportId int64
- fileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves a report file.
-func (r *ReportsFilesService) Get(profileId int64, reportId int64, fileId int64) *ReportsFilesGetCall {
- c := &ReportsFilesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- c.fileId = fileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsFilesGetCall) Fields(s ...googleapi.Field) *ReportsFilesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsFilesGetCall) IfNoneMatch(entityTag string) *ReportsFilesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do and Download methods.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsFilesGetCall) Context(ctx context.Context) *ReportsFilesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsFilesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}/files/{fileId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- "fileId": strconv.FormatInt(c.fileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Download fetches the API endpoint's "media" value, instead of the normal
-// API response value. If the returned error is nil, the Response is guaranteed to
-// have a 2xx status code. Callers must close the Response.Body as usual.
-func (c *ReportsFilesGetCall) Download() (*http.Response, error) {
- res, err := c.doRequest("media")
- if err != nil {
- return nil, err
- }
- if err := googleapi.CheckMediaResponse(res); err != nil {
- res.Body.Close()
- return nil, err
- }
- return res, nil
-}
-
-// Do executes the "dfareporting.reports.files.get" call.
-// Exactly one of *File or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *File.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *ReportsFilesGetCall) Do() (*File, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &File{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a report file.",
- // "httpMethod": "GET",
- // "id": "dfareporting.reports.files.get",
- // "parameterOrder": [
- // "profileId",
- // "reportId",
- // "fileId"
- // ],
- // "parameters": {
- // "fileId": {
- // "description": "The ID of the report file.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}/files/{fileId}",
- // "response": {
- // "$ref": "File"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ],
- // "supportsMediaDownload": true
- // }
-
-}
-
-// method id "dfareporting.reports.files.list":
-
-type ReportsFilesListCall struct {
- s *Service
- profileId int64
- reportId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists files for a report.
-func (r *ReportsFilesService) List(profileId int64, reportId int64) *ReportsFilesListCall {
- c := &ReportsFilesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *ReportsFilesListCall) MaxResults(maxResults int64) *ReportsFilesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous result page.
-func (c *ReportsFilesListCall) PageToken(pageToken string) *ReportsFilesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SortField sets the optional parameter "sortField": The field by which
-// to sort the list.
-//
-// Possible values:
-// "ID" - Sort by file ID.
-// "LAST_MODIFIED_TIME" (default) - Sort by 'lastmodifiedAt' field.
-func (c *ReportsFilesListCall) SortField(sortField string) *ReportsFilesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is 'DESCENDING'.
-//
-// Possible values:
-// "ASCENDING" - Ascending order.
-// "DESCENDING" (default) - Descending order.
-func (c *ReportsFilesListCall) SortOrder(sortOrder string) *ReportsFilesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsFilesListCall) Fields(s ...googleapi.Field) *ReportsFilesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsFilesListCall) IfNoneMatch(entityTag string) *ReportsFilesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsFilesListCall) Context(ctx context.Context) *ReportsFilesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsFilesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}/files")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.files.list" call.
-// Exactly one of *FileList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *FileList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ReportsFilesListCall) Do() (*FileList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FileList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists files for a report.",
- // "httpMethod": "GET",
- // "id": "dfareporting.reports.files.list",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the parent report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "sortField": {
- // "default": "LAST_MODIFIED_TIME",
- // "description": "The field by which to sort the list.",
- // "enum": [
- // "ID",
- // "LAST_MODIFIED_TIME"
- // ],
- // "enumDescriptions": [
- // "Sort by file ID.",
- // "Sort by 'lastmodifiedAt' field."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "default": "DESCENDING",
- // "description": "Order of sorted results, default is 'DESCENDING'.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "Ascending order.",
- // "Descending order."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}/files",
- // "response": {
- // "$ref": "FileList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userProfiles.get":
-
-type UserProfilesGetCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one user profile by ID.
-func (r *UserProfilesService) Get(profileId int64) *UserProfilesGetCall {
- c := &UserProfilesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserProfilesGetCall) Fields(s ...googleapi.Field) *UserProfilesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UserProfilesGetCall) IfNoneMatch(entityTag string) *UserProfilesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserProfilesGetCall) Context(ctx context.Context) *UserProfilesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserProfilesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userProfiles.get" call.
-// Exactly one of *UserProfile or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UserProfile.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UserProfilesGetCall) Do() (*UserProfile, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserProfile{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one user profile by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.userProfiles.get",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}",
- // "response": {
- // "$ref": "UserProfile"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userProfiles.list":
-
-type UserProfilesListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves list of user profiles for a user.
-func (r *UserProfilesService) List() *UserProfilesListCall {
- c := &UserProfilesListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserProfilesListCall) Fields(s ...googleapi.Field) *UserProfilesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UserProfilesListCall) IfNoneMatch(entityTag string) *UserProfilesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserProfilesListCall) Context(ctx context.Context) *UserProfilesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserProfilesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userProfiles.list" call.
-// Exactly one of *UserProfileList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UserProfileList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *UserProfilesListCall) Do() (*UserProfileList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserProfileList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves list of user profiles for a user.",
- // "httpMethod": "GET",
- // "id": "dfareporting.userProfiles.list",
- // "path": "userprofiles",
- // "response": {
- // "$ref": "UserProfileList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/dfareporting/v1/dfareporting-api.json b/vendor/google.golang.org/api/dfareporting/v1/dfareporting-api.json
deleted file mode 100644
index 1956f0e9..00000000
--- a/vendor/google.golang.org/api/dfareporting/v1/dfareporting-api.json
+++ /dev/null
@@ -1,1172 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/MbpeaEJOniwFpvXZcTkgWQ9h6fo\"",
- "discoveryVersion": "v1",
- "id": "dfareporting:v1",
- "name": "dfareporting",
- "version": "v1",
- "revision": "20141112",
- "title": "DFA Reporting API",
- "description": "Lets you create, run and download reports.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/doubleclick-advertisers/reporting/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/dfareporting/v1/",
- "basePath": "/dfareporting/v1/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "dfareporting/v1/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/dfareporting": {
- "description": "View and manage DoubleClick for Advertisers reports"
- }
- }
- }
- },
- "schemas": {
- "DimensionFilter": {
- "id": "DimensionFilter",
- "type": "object",
- "description": "Represents a dimension filter.",
- "properties": {
- "dimensionName": {
- "type": "string",
- "description": "The name of the dimension to filter."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case dfareporting#dimensionFilter.",
- "default": "dfareporting#dimensionFilter"
- },
- "value": {
- "type": "string",
- "description": "The value of the dimension to filter for."
- }
- }
- },
- "DimensionValue": {
- "id": "DimensionValue",
- "type": "object",
- "description": "Represents a DimensionValue resource.",
- "properties": {
- "dimensionName": {
- "type": "string",
- "description": "Name of the dimension."
- },
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "id": {
- "type": "string",
- "description": "The ID associated with the value if available."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case dfareporting#dimensionValue.",
- "default": "dfareporting#dimensionValue"
- },
- "value": {
- "type": "string",
- "description": "The value of the dimension."
- }
- }
- },
- "DimensionValueList": {
- "id": "DimensionValueList",
- "type": "object",
- "description": "Represents the list of DimensionValue resources.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The dimension values returned in this response.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case dfareporting#dimensionValueList.",
- "default": "dfareporting#dimensionValueList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted."
- }
- }
- },
- "DimensionValueRequest": {
- "id": "DimensionValueRequest",
- "type": "object",
- "description": "Represents a DimensionValuesRequest.",
- "properties": {
- "dimensionName": {
- "type": "string",
- "description": "The name of the dimension values should be requested for."
- },
- "endDate": {
- "type": "string",
- "description": "The end date of the date range for which to retrieve dimension values. A string of the format: \"yyyy-MM-dd\".",
- "format": "date"
- },
- "filters": {
- "type": "array",
- "description": "List of filters to filter values by. The filters are ANDed.",
- "items": {
- "$ref": "DimensionFilter"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of request this is, in this case dfareporting#dimensionValueRequest.",
- "default": "dfareporting#dimensionValueRequest"
- },
- "startDate": {
- "type": "string",
- "description": "The start date of the date range for which to retrieve dimension values. A string of the format: \"yyyy-MM-dd\".",
- "format": "date"
- }
- }
- },
- "File": {
- "id": "File",
- "type": "object",
- "description": "Represents a File resource. A File contains the meta-data for a report run. It shows the status of the run and holds the urls to the generated report data if the run is finished and the status is \"REPORT_AVAILABLE\".",
- "properties": {
- "dateRange": {
- "type": "object",
- "description": "The date range for which the file has report data.",
- "properties": {
- "endDate": {
- "type": "string",
- "description": "The end date of the date range, inclusive. A string of the format: \"yyyy-MM-dd\".",
- "format": "date"
- },
- "startDate": {
- "type": "string",
- "description": "The start date of the date range, inclusive. A string of the format: \"yyyy-MM-dd\".",
- "format": "date"
- }
- }
- },
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "fileName": {
- "type": "string",
- "description": "The file name of the file."
- },
- "id": {
- "type": "string",
- "description": "The unique ID of this report file.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case dfareporting#file.",
- "default": "dfareporting#file"
- },
- "lastModifiedTime": {
- "type": "string",
- "description": "The timestamp in milliseconds since epoch when this file was last modified.",
- "format": "int64"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report this file was generated from.",
- "format": "int64"
- },
- "status": {
- "type": "string",
- "description": "The status of the report file, one of: \n- \"PROCESSING\" \n- \"REPORT_AVAILABLE\" \n- \"FAILED\" \n- \"CANCELLED\""
- },
- "urls": {
- "type": "object",
- "description": "The urls where the completed report file can be downloaded.",
- "properties": {
- "csv": {
- "type": "object",
- "description": "Urls for generated CSV data.",
- "properties": {
- "apiUrl": {
- "type": "string",
- "description": "The url for downloading the report data through the API."
- },
- "browserUrl": {
- "type": "string",
- "description": "The url for downloading the report data through a browser."
- }
- }
- }
- }
- }
- }
- },
- "FileList": {
- "id": "FileList",
- "type": "object",
- "description": "Represents the list of File resources.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The files returned in this response.",
- "items": {
- "$ref": "File"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case dfareporting#fileList.",
- "default": "dfareporting#fileList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through files. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted."
- }
- }
- },
- "Report": {
- "id": "Report",
- "type": "object",
- "description": "Represents a Report resource.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The account id this report belongs to.",
- "format": "int64",
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- }
- },
- "criteria": {
- "type": "object",
- "description": "The report criteria.",
- "properties": {
- "activities": {
- "type": "object",
- "description": "Activity group.",
- "properties": {
- "filters": {
- "type": "array",
- "description": "List of activity filters. The dimension values need to be all either of type \"dfa:activity\" or \"dfa:activityGroup\".",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "metricNames": {
- "type": "array",
- "description": "List of names of floodlight activity metrics.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "customRichMediaEvents": {
- "type": "object",
- "description": "Custom Rich Media Events group.",
- "properties": {
- "filteredEventIds": {
- "type": "array",
- "description": "List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.",
- "items": {
- "$ref": "DimensionValue"
- }
- }
- }
- },
- "dateRange": {
- "type": "object",
- "description": "The date range this report should be run for.",
- "properties": {
- "endDate": {
- "type": "string",
- "description": "The end date of the date range, inclusive. A string of the format: \"yyyy-MM-dd\".",
- "format": "date"
- },
- "relativeDateRange": {
- "type": "string",
- "description": "The date range relative to the date of when the report is run, one of: \n- \"TODAY\" \n- \"YESTERDAY\" \n- \"WEEK_TO_DATE\" \n- \"MONTH_TO_DATE\" \n- \"QUARTER_TO_DATE\" \n- \"YEAR_TO_DATE\" \n- \"PREVIOUS_WEEK\" \n- \"PREVIOUS_MONTH\" \n- \"PREVIOUS_QUARTER\" \n- \"PREVIOUS_YEAR\" \n- \"LAST_7_DAYS\" \n- \"LAST_30_DAYS\" \n- \"LAST_90_DAYS\" \n- \"LAST_365_DAYS\" \n- \"LAST_24_MONTHS\""
- },
- "startDate": {
- "type": "string",
- "description": "The start date of the date range, inclusive. A string of the format: \"yyyy-MM-dd\".",
- "format": "date"
- }
- }
- },
- "dimensionFilters": {
- "type": "array",
- "description": "The list of filters dimensions are filtered on.\nFilters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "fileName": {
- "type": "string",
- "description": "The file name used when generating report files for this report."
- },
- "id": {
- "type": "string",
- "description": "The unique ID identifying this report resource.",
- "format": "int64",
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case dfareporting#report.",
- "default": "dfareporting#report"
- },
- "lastModifiedTime": {
- "type": "string",
- "description": "The timestamp (in milliseconds since epoch) of when this report was last modified.",
- "format": "uint64",
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- }
- },
- "name": {
- "type": "string",
- "description": "The name of the report.",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "ownerProfileId": {
- "type": "string",
- "description": "The user profile id of the owner of this report.",
- "format": "int64",
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- }
- },
- "schedule": {
- "type": "object",
- "description": "The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not \"TODAY\".",
- "properties": {
- "active": {
- "type": "boolean",
- "description": "Whether the schedule is active or not. Must be set to either true or false.",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "every": {
- "type": "integer",
- "description": "Defines every how many days, weeks or months the report should be run. Needs to be set when \"repeats\" is either \"DAILY\", \"WEEKLY\" or \"MONTHLY\".",
- "format": "int32"
- },
- "expirationDate": {
- "type": "string",
- "description": "The expiration date when the scheduled report stops running.",
- "format": "date",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "repeats": {
- "type": "string",
- "description": "The interval the report is repeated for, one of: \n- \"DAILY\", also requires field \"every\" to be set. \n- \"WEEKLY\", also requires fields \"every\" and \"repeatsOnWeekDays\" to be set. \n- \"TWICE_A_MONTH\" \n- \"MONTHLY\", also requires fields \"every\" and \"runsOnDayOfMonth\" to be set. \n- \"QUARTERLY\" \n- \"YEARLY\"",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "repeatsOnWeekDays": {
- "type": "array",
- "description": "List of week days \"WEEKLY\" scheduled reports should run on.",
- "items": {
- "type": "string"
- }
- },
- "runsOnDayOfMonth": {
- "type": "string",
- "description": "Enum to define for \"MONTHLY\" scheduled reports whether reports should be repeated on the same day of the month as \"startDate\" or the same day of the week of the month. Possible values are: \n- DAY_OF_MONTH \n- WEEK_OF_MONTH \nExample: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), \"DAY_OF_MONTH\" would run subsequent reports on the 2nd of every Month, and \"WEEK_OF_MONTH\" would run subsequent reports on the first Monday of the month."
- },
- "startDate": {
- "type": "string",
- "description": "Start date of date range for which scheduled reports should be run.",
- "format": "date",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- }
- }
- },
- "subAccountId": {
- "type": "string",
- "description": "The subbaccount id this report belongs to if applicable.",
- "format": "int64"
- },
- "type": {
- "type": "string",
- "description": "The type of the report, currently only \"STANDARD\" is supported.",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- }
- }
- },
- "ReportList": {
- "id": "ReportList",
- "type": "object",
- "description": "Represents the list of reports.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The reports returned in this response.",
- "items": {
- "$ref": "Report"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case dfareporting#reportList.",
- "default": "dfareporting#reportList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through reports. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted."
- }
- }
- },
- "SortedDimension": {
- "id": "SortedDimension",
- "type": "object",
- "description": "Represents a sorted dimension.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case dfareporting#sortedDimension.",
- "default": "dfareporting#sortedDimension"
- },
- "name": {
- "type": "string",
- "description": "The name of the dimension."
- },
- "sortOrder": {
- "type": "string",
- "description": "An optional sort order for the dimension column, one of: \n- \"ASCENDING\" \n- \"DESCENDING\""
- }
- }
- },
- "UserProfile": {
- "id": "UserProfile",
- "type": "object",
- "description": "Represents a UserProfile resource.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The account ID this profile belongs to.",
- "format": "int64"
- },
- "accountName": {
- "type": "string",
- "description": "The account name this profile belongs to."
- },
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "kind": {
- "type": "string",
- "description": "Kind of resource this is, in this case dfareporting#userProfile.",
- "default": "dfareporting#userProfile"
- },
- "profileId": {
- "type": "string",
- "description": "The unique ID of the user profile.",
- "format": "int64"
- },
- "subAccountId": {
- "type": "string",
- "description": "The sub account ID this profile belongs to if applicable.",
- "format": "int64"
- },
- "subAccountName": {
- "type": "string",
- "description": "The sub account name this profile belongs to if applicable."
- },
- "userName": {
- "type": "string",
- "description": "The user name."
- }
- }
- },
- "UserProfileList": {
- "id": "UserProfileList",
- "type": "object",
- "description": "Represents the list of user profiles.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The user profiles returned in this response.",
- "items": {
- "$ref": "UserProfile"
- }
- },
- "kind": {
- "type": "string",
- "description": "Kind of list this is, in this case dfareporting#userProfileList.",
- "default": "dfareporting#userProfileList"
- }
- }
- }
- },
- "resources": {
- "dimensionValues": {
- "methods": {
- "query": {
- "id": "dfareporting.dimensionValues.query",
- "path": "userprofiles/{profileId}/dimensionvalues/query",
- "httpMethod": "POST",
- "description": "Retrieves list of report dimension values for a list of filters.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA user profile id.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "DimensionValueRequest"
- },
- "response": {
- "$ref": "DimensionValueList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- },
- "files": {
- "methods": {
- "list": {
- "id": "dfareporting.files.list",
- "path": "userprofiles/{profileId}/files",
- "httpMethod": "GET",
- "description": "Lists files for a user profile.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA profile id.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "sortField": {
- "type": "string",
- "description": "The field to sort the list by.",
- "default": "LAST_MODIFIED_TIME",
- "enum": [
- "ID",
- "LAST_MODIFIED_TIME"
- ],
- "enumDescriptions": [
- "Sort by file id.",
- "Sort by 'lastmodifiedAt' field."
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is 'DESCENDING'.",
- "default": "DESCENDING",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "FileList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- },
- "reports": {
- "methods": {
- "delete": {
- "id": "dfareporting.reports.delete",
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "DELETE",
- "description": "Deletes a report by its id.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile id.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The id of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "get": {
- "id": "dfareporting.reports.get",
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "GET",
- "description": "Retrieves a report by its id.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile id.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The id of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "insert": {
- "id": "dfareporting.reports.insert",
- "path": "userprofiles/{profileId}/reports",
- "httpMethod": "POST",
- "description": "Creates a report.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile id.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "list": {
- "id": "dfareporting.reports.list",
- "path": "userprofiles/{profileId}/reports",
- "httpMethod": "GET",
- "description": "Retrieves list of reports.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA user profile id.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "sortField": {
- "type": "string",
- "description": "The field to sort the list by.",
- "default": "LAST_MODIFIED_TIME",
- "enum": [
- "ID",
- "LAST_MODIFIED_TIME",
- "NAME"
- ],
- "enumDescriptions": [
- "Sort by report id.",
- "Sort by 'lastModifiedTime' field.",
- "Sort by display name of reports."
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is 'DESCENDING'.",
- "default": "DESCENDING",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "ReportList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "patch": {
- "id": "dfareporting.reports.patch",
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "PATCH",
- "description": "Updates a report. This method supports patch semantics.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile id.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The id of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "run": {
- "id": "dfareporting.reports.run",
- "path": "userprofiles/{profileId}/reports/{reportId}/run",
- "httpMethod": "POST",
- "description": "Runs a report.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA profile id.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The id of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "synchronous": {
- "type": "boolean",
- "description": "If set and true, tries to run the report synchronously.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "response": {
- "$ref": "File"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "update": {
- "id": "dfareporting.reports.update",
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "PUT",
- "description": "Updates a report.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile id.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The id of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- },
- "resources": {
- "files": {
- "methods": {
- "get": {
- "id": "dfareporting.reports.files.get",
- "path": "userprofiles/{profileId}/reports/{reportId}/files/{fileId}",
- "httpMethod": "GET",
- "description": "Retrieves a report file.",
- "parameters": {
- "fileId": {
- "type": "string",
- "description": "The id of the report file.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA profile id.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The id of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId",
- "fileId"
- ],
- "response": {
- "$ref": "File"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "list": {
- "id": "dfareporting.reports.files.list",
- "path": "userprofiles/{profileId}/reports/{reportId}/files",
- "httpMethod": "GET",
- "description": "Lists files for a report.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA profile id.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The id of the parent report.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "sortField": {
- "type": "string",
- "description": "The field to sort the list by.",
- "default": "LAST_MODIFIED_TIME",
- "enum": [
- "ID",
- "LAST_MODIFIED_TIME"
- ],
- "enumDescriptions": [
- "Sort by file id.",
- "Sort by 'lastmodifiedAt' field."
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is 'DESCENDING'.",
- "default": "DESCENDING",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "response": {
- "$ref": "FileList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- }
- }
- },
- "userProfiles": {
- "methods": {
- "get": {
- "id": "dfareporting.userProfiles.get",
- "path": "userprofiles/{profileId}",
- "httpMethod": "GET",
- "description": "Gets one user profile by id.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The user profile id.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "UserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "list": {
- "id": "dfareporting.userProfiles.list",
- "path": "userprofiles",
- "httpMethod": "GET",
- "description": "Retrieves list of user profiles for a user.",
- "response": {
- "$ref": "UserProfileList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/dfareporting/v1/dfareporting-gen.go b/vendor/google.golang.org/api/dfareporting/v1/dfareporting-gen.go
deleted file mode 100644
index 54884a67..00000000
--- a/vendor/google.golang.org/api/dfareporting/v1/dfareporting-gen.go
+++ /dev/null
@@ -1,2806 +0,0 @@
-// Package dfareporting provides access to the DFA Reporting API.
-//
-// See https://developers.google.com/doubleclick-advertisers/reporting/
-//
-// Usage example:
-//
-// import "google.golang.org/api/dfareporting/v1"
-// ...
-// dfareportingService, err := dfareporting.New(oauthHttpClient)
-package dfareporting // import "google.golang.org/api/dfareporting/v1"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "dfareporting:v1"
-const apiName = "dfareporting"
-const apiVersion = "v1"
-const basePath = "https://www.googleapis.com/dfareporting/v1/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage DoubleClick for Advertisers reports
- DfareportingScope = "https://www.googleapis.com/auth/dfareporting"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.DimensionValues = NewDimensionValuesService(s)
- s.Files = NewFilesService(s)
- s.Reports = NewReportsService(s)
- s.UserProfiles = NewUserProfilesService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- DimensionValues *DimensionValuesService
-
- Files *FilesService
-
- Reports *ReportsService
-
- UserProfiles *UserProfilesService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewDimensionValuesService(s *Service) *DimensionValuesService {
- rs := &DimensionValuesService{s: s}
- return rs
-}
-
-type DimensionValuesService struct {
- s *Service
-}
-
-func NewFilesService(s *Service) *FilesService {
- rs := &FilesService{s: s}
- return rs
-}
-
-type FilesService struct {
- s *Service
-}
-
-func NewReportsService(s *Service) *ReportsService {
- rs := &ReportsService{s: s}
- rs.Files = NewReportsFilesService(s)
- return rs
-}
-
-type ReportsService struct {
- s *Service
-
- Files *ReportsFilesService
-}
-
-func NewReportsFilesService(s *Service) *ReportsFilesService {
- rs := &ReportsFilesService{s: s}
- return rs
-}
-
-type ReportsFilesService struct {
- s *Service
-}
-
-func NewUserProfilesService(s *Service) *UserProfilesService {
- rs := &UserProfilesService{s: s}
- return rs
-}
-
-type UserProfilesService struct {
- s *Service
-}
-
-// DimensionFilter: Represents a dimension filter.
-type DimensionFilter struct {
- // DimensionName: The name of the dimension to filter.
- DimensionName string `json:"dimensionName,omitempty"`
-
- // Kind: Kind of resource this is, in this case
- // dfareporting#dimensionFilter.
- Kind string `json:"kind,omitempty"`
-
- // Value: The value of the dimension to filter for.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DimensionFilter) MarshalJSON() ([]byte, error) {
- type noMethod DimensionFilter
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DimensionValue: Represents a DimensionValue resource.
-type DimensionValue struct {
- // DimensionName: Name of the dimension.
- DimensionName string `json:"dimensionName,omitempty"`
-
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Id: The ID associated with the value if available.
- Id string `json:"id,omitempty"`
-
- // Kind: Kind of resource this is, in this case
- // dfareporting#dimensionValue.
- Kind string `json:"kind,omitempty"`
-
- // Value: The value of the dimension.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DimensionValue) MarshalJSON() ([]byte, error) {
- type noMethod DimensionValue
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DimensionValueList: Represents the list of DimensionValue resources.
-type DimensionValueList struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The dimension values returned in this response.
- Items []*DimensionValue `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case
- // dfareporting#dimensionValueList.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through dimension
- // values. To retrieve the next page of results, set the next request's
- // "pageToken" to the value of this field. The page token is only valid
- // for a limited amount of time and should not be persisted.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DimensionValueList) MarshalJSON() ([]byte, error) {
- type noMethod DimensionValueList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DimensionValueRequest: Represents a DimensionValuesRequest.
-type DimensionValueRequest struct {
- // DimensionName: The name of the dimension values should be requested
- // for.
- DimensionName string `json:"dimensionName,omitempty"`
-
- // EndDate: The end date of the date range for which to retrieve
- // dimension values. A string of the format: "yyyy-MM-dd".
- EndDate string `json:"endDate,omitempty"`
-
- // Filters: List of filters to filter values by. The filters are ANDed.
- Filters []*DimensionFilter `json:"filters,omitempty"`
-
- // Kind: Kind of request this is, in this case
- // dfareporting#dimensionValueRequest.
- Kind string `json:"kind,omitempty"`
-
- // StartDate: The start date of the date range for which to retrieve
- // dimension values. A string of the format: "yyyy-MM-dd".
- StartDate string `json:"startDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DimensionValueRequest) MarshalJSON() ([]byte, error) {
- type noMethod DimensionValueRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// File: Represents a File resource. A File contains the meta-data for a
-// report run. It shows the status of the run and holds the urls to the
-// generated report data if the run is finished and the status is
-// "REPORT_AVAILABLE".
-type File struct {
- // DateRange: The date range for which the file has report data.
- DateRange *FileDateRange `json:"dateRange,omitempty"`
-
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // FileName: The file name of the file.
- FileName string `json:"fileName,omitempty"`
-
- // Id: The unique ID of this report file.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Kind of resource this is, in this case dfareporting#file.
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedTime: The timestamp in milliseconds since epoch when this
- // file was last modified.
- LastModifiedTime int64 `json:"lastModifiedTime,omitempty,string"`
-
- // ReportId: The ID of the report this file was generated from.
- ReportId int64 `json:"reportId,omitempty,string"`
-
- // Status: The status of the report file, one of:
- // - "PROCESSING"
- // - "REPORT_AVAILABLE"
- // - "FAILED"
- // - "CANCELLED"
- Status string `json:"status,omitempty"`
-
- // Urls: The urls where the completed report file can be downloaded.
- Urls *FileUrls `json:"urls,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "DateRange") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *File) MarshalJSON() ([]byte, error) {
- type noMethod File
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FileDateRange: The date range for which the file has report data.
-type FileDateRange struct {
- // EndDate: The end date of the date range, inclusive. A string of the
- // format: "yyyy-MM-dd".
- EndDate string `json:"endDate,omitempty"`
-
- // StartDate: The start date of the date range, inclusive. A string of
- // the format: "yyyy-MM-dd".
- StartDate string `json:"startDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "EndDate") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FileDateRange) MarshalJSON() ([]byte, error) {
- type noMethod FileDateRange
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FileUrls: The urls where the completed report file can be downloaded.
-type FileUrls struct {
- // Csv: Urls for generated CSV data.
- Csv *FileUrlsCsv `json:"csv,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Csv") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FileUrls) MarshalJSON() ([]byte, error) {
- type noMethod FileUrls
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FileUrlsCsv: Urls for generated CSV data.
-type FileUrlsCsv struct {
- // ApiUrl: The url for downloading the report data through the API.
- ApiUrl string `json:"apiUrl,omitempty"`
-
- // BrowserUrl: The url for downloading the report data through a
- // browser.
- BrowserUrl string `json:"browserUrl,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ApiUrl") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FileUrlsCsv) MarshalJSON() ([]byte, error) {
- type noMethod FileUrlsCsv
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FileList: Represents the list of File resources.
-type FileList struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The files returned in this response.
- Items []*File `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case dfareporting#fileList.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through files. To
- // retrieve the next page of results, set the next request's "pageToken"
- // to the value of this field. The page token is only valid for a
- // limited amount of time and should not be persisted.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FileList) MarshalJSON() ([]byte, error) {
- type noMethod FileList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Report: Represents a Report resource.
-type Report struct {
- // AccountId: The account id this report belongs to.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Criteria: The report criteria.
- Criteria *ReportCriteria `json:"criteria,omitempty"`
-
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // FileName: The file name used when generating report files for this
- // report.
- FileName string `json:"fileName,omitempty"`
-
- // Id: The unique ID identifying this report resource.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Kind of resource this is, in this case dfareporting#report.
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedTime: The timestamp (in milliseconds since epoch) of when
- // this report was last modified.
- LastModifiedTime uint64 `json:"lastModifiedTime,omitempty,string"`
-
- // Name: The name of the report.
- Name string `json:"name,omitempty"`
-
- // OwnerProfileId: The user profile id of the owner of this report.
- OwnerProfileId int64 `json:"ownerProfileId,omitempty,string"`
-
- // Schedule: The report's schedule. Can only be set if the report's
- // 'dateRange' is a relative date range and the relative date range is
- // not "TODAY".
- Schedule *ReportSchedule `json:"schedule,omitempty"`
-
- // SubAccountId: The subbaccount id this report belongs to if
- // applicable.
- SubAccountId int64 `json:"subAccountId,omitempty,string"`
-
- // Type: The type of the report, currently only "STANDARD" is supported.
- Type string `json:"type,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Report) MarshalJSON() ([]byte, error) {
- type noMethod Report
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportCriteria: The report criteria.
-type ReportCriteria struct {
- // Activities: Activity group.
- Activities *ReportCriteriaActivities `json:"activities,omitempty"`
-
- // CustomRichMediaEvents: Custom Rich Media Events group.
- CustomRichMediaEvents *ReportCriteriaCustomRichMediaEvents `json:"customRichMediaEvents,omitempty"`
-
- // DateRange: The date range this report should be run for.
- DateRange *ReportCriteriaDateRange `json:"dateRange,omitempty"`
-
- // DimensionFilters: The list of filters dimensions are filtered
- // on.
- // Filters for different dimensions are ANDed, filters for the same
- // dimension are grouped together and ORed.
- DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`
-
- // Dimensions: The list of dimensions the report should include.
- Dimensions []*SortedDimension `json:"dimensions,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Activities") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportCriteriaActivities: Activity group.
-type ReportCriteriaActivities struct {
- // Filters: List of activity filters. The dimension values need to be
- // all either of type "dfa:activity" or "dfa:activityGroup".
- Filters []*DimensionValue `json:"filters,omitempty"`
-
- // MetricNames: List of names of floodlight activity metrics.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Filters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportCriteriaActivities) MarshalJSON() ([]byte, error) {
- type noMethod ReportCriteriaActivities
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportCriteriaCustomRichMediaEvents: Custom Rich Media Events group.
-type ReportCriteriaCustomRichMediaEvents struct {
- // FilteredEventIds: List of custom rich media event IDs. Dimension
- // values must be all of type dfa:richMediaEventTypeIdAndName.
- FilteredEventIds []*DimensionValue `json:"filteredEventIds,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "FilteredEventIds") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportCriteriaCustomRichMediaEvents) MarshalJSON() ([]byte, error) {
- type noMethod ReportCriteriaCustomRichMediaEvents
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportCriteriaDateRange: The date range this report should be run
-// for.
-type ReportCriteriaDateRange struct {
- // EndDate: The end date of the date range, inclusive. A string of the
- // format: "yyyy-MM-dd".
- EndDate string `json:"endDate,omitempty"`
-
- // RelativeDateRange: The date range relative to the date of when the
- // report is run, one of:
- // - "TODAY"
- // - "YESTERDAY"
- // - "WEEK_TO_DATE"
- // - "MONTH_TO_DATE"
- // - "QUARTER_TO_DATE"
- // - "YEAR_TO_DATE"
- // - "PREVIOUS_WEEK"
- // - "PREVIOUS_MONTH"
- // - "PREVIOUS_QUARTER"
- // - "PREVIOUS_YEAR"
- // - "LAST_7_DAYS"
- // - "LAST_30_DAYS"
- // - "LAST_90_DAYS"
- // - "LAST_365_DAYS"
- // - "LAST_24_MONTHS"
- RelativeDateRange string `json:"relativeDateRange,omitempty"`
-
- // StartDate: The start date of the date range, inclusive. A string of
- // the format: "yyyy-MM-dd".
- StartDate string `json:"startDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "EndDate") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportCriteriaDateRange) MarshalJSON() ([]byte, error) {
- type noMethod ReportCriteriaDateRange
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportSchedule: The report's schedule. Can only be set if the
-// report's 'dateRange' is a relative date range and the relative date
-// range is not "TODAY".
-type ReportSchedule struct {
- // Active: Whether the schedule is active or not. Must be set to either
- // true or false.
- Active bool `json:"active,omitempty"`
-
- // Every: Defines every how many days, weeks or months the report should
- // be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or
- // "MONTHLY".
- Every int64 `json:"every,omitempty"`
-
- // ExpirationDate: The expiration date when the scheduled report stops
- // running.
- ExpirationDate string `json:"expirationDate,omitempty"`
-
- // Repeats: The interval the report is repeated for, one of:
- // - "DAILY", also requires field "every" to be set.
- // - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to
- // be set.
- // - "TWICE_A_MONTH"
- // - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to
- // be set.
- // - "QUARTERLY"
- // - "YEARLY"
- Repeats string `json:"repeats,omitempty"`
-
- // RepeatsOnWeekDays: List of week days "WEEKLY" scheduled reports
- // should run on.
- RepeatsOnWeekDays []string `json:"repeatsOnWeekDays,omitempty"`
-
- // RunsOnDayOfMonth: Enum to define for "MONTHLY" scheduled reports
- // whether reports should be repeated on the same day of the month as
- // "startDate" or the same day of the week of the month. Possible values
- // are:
- // - DAY_OF_MONTH
- // - WEEK_OF_MONTH
- // Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02),
- // "DAY_OF_MONTH" would run subsequent reports on the 2nd of every
- // Month, and "WEEK_OF_MONTH" would run subsequent reports on the first
- // Monday of the month.
- RunsOnDayOfMonth string `json:"runsOnDayOfMonth,omitempty"`
-
- // StartDate: Start date of date range for which scheduled reports
- // should be run.
- StartDate string `json:"startDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Active") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportSchedule) MarshalJSON() ([]byte, error) {
- type noMethod ReportSchedule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportList: Represents the list of reports.
-type ReportList struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The reports returned in this response.
- Items []*Report `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case dfareporting#reportList.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through reports. To
- // retrieve the next page of results, set the next request's "pageToken"
- // to the value of this field. The page token is only valid for a
- // limited amount of time and should not be persisted.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportList) MarshalJSON() ([]byte, error) {
- type noMethod ReportList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SortedDimension: Represents a sorted dimension.
-type SortedDimension struct {
- // Kind: Kind of resource this is, in this case
- // dfareporting#sortedDimension.
- Kind string `json:"kind,omitempty"`
-
- // Name: The name of the dimension.
- Name string `json:"name,omitempty"`
-
- // SortOrder: An optional sort order for the dimension column, one of:
- //
- // - "ASCENDING"
- // - "DESCENDING"
- SortOrder string `json:"sortOrder,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SortedDimension) MarshalJSON() ([]byte, error) {
- type noMethod SortedDimension
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserProfile: Represents a UserProfile resource.
-type UserProfile struct {
- // AccountId: The account ID this profile belongs to.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AccountName: The account name this profile belongs to.
- AccountName string `json:"accountName,omitempty"`
-
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Kind: Kind of resource this is, in this case
- // dfareporting#userProfile.
- Kind string `json:"kind,omitempty"`
-
- // ProfileId: The unique ID of the user profile.
- ProfileId int64 `json:"profileId,omitempty,string"`
-
- // SubAccountId: The sub account ID this profile belongs to if
- // applicable.
- SubAccountId int64 `json:"subAccountId,omitempty,string"`
-
- // SubAccountName: The sub account name this profile belongs to if
- // applicable.
- SubAccountName string `json:"subAccountName,omitempty"`
-
- // UserName: The user name.
- UserName string `json:"userName,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserProfile) MarshalJSON() ([]byte, error) {
- type noMethod UserProfile
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserProfileList: Represents the list of user profiles.
-type UserProfileList struct {
- // Etag: ETag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The user profiles returned in this response.
- Items []*UserProfile `json:"items,omitempty"`
-
- // Kind: Kind of list this is, in this case
- // dfareporting#userProfileList.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserProfileList) MarshalJSON() ([]byte, error) {
- type noMethod UserProfileList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "dfareporting.dimensionValues.query":
-
-type DimensionValuesQueryCall struct {
- s *Service
- profileId int64
- dimensionvaluerequest *DimensionValueRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Query: Retrieves list of report dimension values for a list of
-// filters.
-func (r *DimensionValuesService) Query(profileId int64, dimensionvaluerequest *DimensionValueRequest) *DimensionValuesQueryCall {
- c := &DimensionValuesQueryCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.dimensionvaluerequest = dimensionvaluerequest
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *DimensionValuesQueryCall) MaxResults(maxResults int64) *DimensionValuesQueryCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous result page.
-func (c *DimensionValuesQueryCall) PageToken(pageToken string) *DimensionValuesQueryCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DimensionValuesQueryCall) Fields(s ...googleapi.Field) *DimensionValuesQueryCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DimensionValuesQueryCall) Context(ctx context.Context) *DimensionValuesQueryCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DimensionValuesQueryCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.dimensionvaluerequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/dimensionvalues/query")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.dimensionValues.query" call.
-// Exactly one of *DimensionValueList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *DimensionValueList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DimensionValuesQueryCall) Do() (*DimensionValueList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DimensionValueList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves list of report dimension values for a list of filters.",
- // "httpMethod": "POST",
- // "id": "dfareporting.dimensionValues.query",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "100",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA user profile id.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/dimensionvalues/query",
- // "request": {
- // "$ref": "DimensionValueRequest"
- // },
- // "response": {
- // "$ref": "DimensionValueList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.files.list":
-
-type FilesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists files for a user profile.
-func (r *FilesService) List(profileId int64) *FilesListCall {
- c := &FilesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *FilesListCall) MaxResults(maxResults int64) *FilesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous result page.
-func (c *FilesListCall) PageToken(pageToken string) *FilesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SortField sets the optional parameter "sortField": The field to sort
-// the list by.
-//
-// Possible values:
-// "ID" - Sort by file id.
-// "LAST_MODIFIED_TIME" (default) - Sort by 'lastmodifiedAt' field.
-func (c *FilesListCall) SortField(sortField string) *FilesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is 'DESCENDING'.
-//
-// Possible values:
-// "ASCENDING" - Ascending order.
-// "DESCENDING" (default) - Descending order.
-func (c *FilesListCall) SortOrder(sortOrder string) *FilesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FilesListCall) Fields(s ...googleapi.Field) *FilesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *FilesListCall) IfNoneMatch(entityTag string) *FilesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FilesListCall) Context(ctx context.Context) *FilesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FilesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/files")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.files.list" call.
-// Exactly one of *FileList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *FileList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *FilesListCall) Do() (*FileList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FileList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists files for a user profile.",
- // "httpMethod": "GET",
- // "id": "dfareporting.files.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA profile id.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "sortField": {
- // "default": "LAST_MODIFIED_TIME",
- // "description": "The field to sort the list by.",
- // "enum": [
- // "ID",
- // "LAST_MODIFIED_TIME"
- // ],
- // "enumDescriptions": [
- // "Sort by file id.",
- // "Sort by 'lastmodifiedAt' field."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "default": "DESCENDING",
- // "description": "Order of sorted results, default is 'DESCENDING'.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "Ascending order.",
- // "Descending order."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/files",
- // "response": {
- // "$ref": "FileList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.delete":
-
-type ReportsDeleteCall struct {
- s *Service
- profileId int64
- reportId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes a report by its id.
-func (r *ReportsService) Delete(profileId int64, reportId int64) *ReportsDeleteCall {
- c := &ReportsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsDeleteCall) Fields(s ...googleapi.Field) *ReportsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsDeleteCall) Context(ctx context.Context) *ReportsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.delete" call.
-func (c *ReportsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes a report by its id.",
- // "httpMethod": "DELETE",
- // "id": "dfareporting.reports.delete",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile id.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The id of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.get":
-
-type ReportsGetCall struct {
- s *Service
- profileId int64
- reportId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves a report by its id.
-func (r *ReportsService) Get(profileId int64, reportId int64) *ReportsGetCall {
- c := &ReportsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsGetCall) Fields(s ...googleapi.Field) *ReportsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsGetCall) IfNoneMatch(entityTag string) *ReportsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsGetCall) Context(ctx context.Context) *ReportsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.get" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsGetCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a report by its id.",
- // "httpMethod": "GET",
- // "id": "dfareporting.reports.get",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile id.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The id of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}",
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.insert":
-
-type ReportsInsertCall struct {
- s *Service
- profileId int64
- report *Report
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a report.
-func (r *ReportsService) Insert(profileId int64, report *Report) *ReportsInsertCall {
- c := &ReportsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.report = report
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsInsertCall) Fields(s ...googleapi.Field) *ReportsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsInsertCall) Context(ctx context.Context) *ReportsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.report)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.insert" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsInsertCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a report.",
- // "httpMethod": "POST",
- // "id": "dfareporting.reports.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile id.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports",
- // "request": {
- // "$ref": "Report"
- // },
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.list":
-
-type ReportsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves list of reports.
-func (r *ReportsService) List(profileId int64) *ReportsListCall {
- c := &ReportsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *ReportsListCall) MaxResults(maxResults int64) *ReportsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous result page.
-func (c *ReportsListCall) PageToken(pageToken string) *ReportsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SortField sets the optional parameter "sortField": The field to sort
-// the list by.
-//
-// Possible values:
-// "ID" - Sort by report id.
-// "LAST_MODIFIED_TIME" (default) - Sort by 'lastModifiedTime' field.
-// "NAME" - Sort by display name of reports.
-func (c *ReportsListCall) SortField(sortField string) *ReportsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is 'DESCENDING'.
-//
-// Possible values:
-// "ASCENDING" - Ascending order.
-// "DESCENDING" (default) - Descending order.
-func (c *ReportsListCall) SortOrder(sortOrder string) *ReportsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsListCall) Fields(s ...googleapi.Field) *ReportsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsListCall) IfNoneMatch(entityTag string) *ReportsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsListCall) Context(ctx context.Context) *ReportsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.list" call.
-// Exactly one of *ReportList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ReportList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ReportsListCall) Do() (*ReportList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ReportList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves list of reports.",
- // "httpMethod": "GET",
- // "id": "dfareporting.reports.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA user profile id.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "sortField": {
- // "default": "LAST_MODIFIED_TIME",
- // "description": "The field to sort the list by.",
- // "enum": [
- // "ID",
- // "LAST_MODIFIED_TIME",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "Sort by report id.",
- // "Sort by 'lastModifiedTime' field.",
- // "Sort by display name of reports."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "default": "DESCENDING",
- // "description": "Order of sorted results, default is 'DESCENDING'.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "Ascending order.",
- // "Descending order."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports",
- // "response": {
- // "$ref": "ReportList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.patch":
-
-type ReportsPatchCall struct {
- s *Service
- profileId int64
- reportId int64
- report *Report
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates a report. This method supports patch semantics.
-func (r *ReportsService) Patch(profileId int64, reportId int64, report *Report) *ReportsPatchCall {
- c := &ReportsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- c.report = report
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsPatchCall) Fields(s ...googleapi.Field) *ReportsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsPatchCall) Context(ctx context.Context) *ReportsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.report)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.patch" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsPatchCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a report. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.reports.patch",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile id.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The id of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}",
- // "request": {
- // "$ref": "Report"
- // },
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.run":
-
-type ReportsRunCall struct {
- s *Service
- profileId int64
- reportId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Run: Runs a report.
-func (r *ReportsService) Run(profileId int64, reportId int64) *ReportsRunCall {
- c := &ReportsRunCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- return c
-}
-
-// Synchronous sets the optional parameter "synchronous": If set and
-// true, tries to run the report synchronously.
-func (c *ReportsRunCall) Synchronous(synchronous bool) *ReportsRunCall {
- c.opt_["synchronous"] = synchronous
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsRunCall) Fields(s ...googleapi.Field) *ReportsRunCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsRunCall) Context(ctx context.Context) *ReportsRunCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsRunCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["synchronous"]; ok {
- params.Set("synchronous", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}/run")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.run" call.
-// Exactly one of *File or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *File.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *ReportsRunCall) Do() (*File, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &File{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Runs a report.",
- // "httpMethod": "POST",
- // "id": "dfareporting.reports.run",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA profile id.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The id of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "synchronous": {
- // "description": "If set and true, tries to run the report synchronously.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}/run",
- // "response": {
- // "$ref": "File"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.update":
-
-type ReportsUpdateCall struct {
- s *Service
- profileId int64
- reportId int64
- report *Report
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates a report.
-func (r *ReportsService) Update(profileId int64, reportId int64, report *Report) *ReportsUpdateCall {
- c := &ReportsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- c.report = report
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsUpdateCall) Fields(s ...googleapi.Field) *ReportsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsUpdateCall) Context(ctx context.Context) *ReportsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.report)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.update" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsUpdateCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a report.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.reports.update",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile id.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The id of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}",
- // "request": {
- // "$ref": "Report"
- // },
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.files.get":
-
-type ReportsFilesGetCall struct {
- s *Service
- profileId int64
- reportId int64
- fileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves a report file.
-func (r *ReportsFilesService) Get(profileId int64, reportId int64, fileId int64) *ReportsFilesGetCall {
- c := &ReportsFilesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- c.fileId = fileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsFilesGetCall) Fields(s ...googleapi.Field) *ReportsFilesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsFilesGetCall) IfNoneMatch(entityTag string) *ReportsFilesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsFilesGetCall) Context(ctx context.Context) *ReportsFilesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsFilesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}/files/{fileId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- "fileId": strconv.FormatInt(c.fileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.files.get" call.
-// Exactly one of *File or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *File.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *ReportsFilesGetCall) Do() (*File, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &File{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a report file.",
- // "httpMethod": "GET",
- // "id": "dfareporting.reports.files.get",
- // "parameterOrder": [
- // "profileId",
- // "reportId",
- // "fileId"
- // ],
- // "parameters": {
- // "fileId": {
- // "description": "The id of the report file.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA profile id.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The id of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}/files/{fileId}",
- // "response": {
- // "$ref": "File"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.files.list":
-
-type ReportsFilesListCall struct {
- s *Service
- profileId int64
- reportId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists files for a report.
-func (r *ReportsFilesService) List(profileId int64, reportId int64) *ReportsFilesListCall {
- c := &ReportsFilesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *ReportsFilesListCall) MaxResults(maxResults int64) *ReportsFilesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous result page.
-func (c *ReportsFilesListCall) PageToken(pageToken string) *ReportsFilesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SortField sets the optional parameter "sortField": The field to sort
-// the list by.
-//
-// Possible values:
-// "ID" - Sort by file id.
-// "LAST_MODIFIED_TIME" (default) - Sort by 'lastmodifiedAt' field.
-func (c *ReportsFilesListCall) SortField(sortField string) *ReportsFilesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is 'DESCENDING'.
-//
-// Possible values:
-// "ASCENDING" - Ascending order.
-// "DESCENDING" (default) - Descending order.
-func (c *ReportsFilesListCall) SortOrder(sortOrder string) *ReportsFilesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsFilesListCall) Fields(s ...googleapi.Field) *ReportsFilesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsFilesListCall) IfNoneMatch(entityTag string) *ReportsFilesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsFilesListCall) Context(ctx context.Context) *ReportsFilesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsFilesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}/files")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.files.list" call.
-// Exactly one of *FileList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *FileList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ReportsFilesListCall) Do() (*FileList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FileList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists files for a report.",
- // "httpMethod": "GET",
- // "id": "dfareporting.reports.files.list",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA profile id.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The id of the parent report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "sortField": {
- // "default": "LAST_MODIFIED_TIME",
- // "description": "The field to sort the list by.",
- // "enum": [
- // "ID",
- // "LAST_MODIFIED_TIME"
- // ],
- // "enumDescriptions": [
- // "Sort by file id.",
- // "Sort by 'lastmodifiedAt' field."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "default": "DESCENDING",
- // "description": "Order of sorted results, default is 'DESCENDING'.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "Ascending order.",
- // "Descending order."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}/files",
- // "response": {
- // "$ref": "FileList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userProfiles.get":
-
-type UserProfilesGetCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one user profile by id.
-func (r *UserProfilesService) Get(profileId int64) *UserProfilesGetCall {
- c := &UserProfilesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserProfilesGetCall) Fields(s ...googleapi.Field) *UserProfilesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UserProfilesGetCall) IfNoneMatch(entityTag string) *UserProfilesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserProfilesGetCall) Context(ctx context.Context) *UserProfilesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserProfilesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userProfiles.get" call.
-// Exactly one of *UserProfile or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UserProfile.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UserProfilesGetCall) Do() (*UserProfile, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserProfile{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one user profile by id.",
- // "httpMethod": "GET",
- // "id": "dfareporting.userProfiles.get",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The user profile id.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}",
- // "response": {
- // "$ref": "UserProfile"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userProfiles.list":
-
-type UserProfilesListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves list of user profiles for a user.
-func (r *UserProfilesService) List() *UserProfilesListCall {
- c := &UserProfilesListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserProfilesListCall) Fields(s ...googleapi.Field) *UserProfilesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UserProfilesListCall) IfNoneMatch(entityTag string) *UserProfilesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserProfilesListCall) Context(ctx context.Context) *UserProfilesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserProfilesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userProfiles.list" call.
-// Exactly one of *UserProfileList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UserProfileList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *UserProfilesListCall) Do() (*UserProfileList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserProfileList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves list of user profiles for a user.",
- // "httpMethod": "GET",
- // "id": "dfareporting.userProfiles.list",
- // "path": "userprofiles",
- // "response": {
- // "$ref": "UserProfileList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/dfareporting/v2.0/dfareporting-api.json b/vendor/google.golang.org/api/dfareporting/v2.0/dfareporting-api.json
deleted file mode 100644
index 90e9bb97..00000000
--- a/vendor/google.golang.org/api/dfareporting/v2.0/dfareporting-api.json
+++ /dev/null
@@ -1,15333 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/hsqpr9X90U7kI0NDFJRw_wW8z3w\"",
- "discoveryVersion": "v1",
- "id": "dfareporting:v2.0",
- "name": "dfareporting",
- "version": "v2.0",
- "revision": "20150717",
- "title": "DCM/DFA Reporting And Trafficking API",
- "description": "Manage your DoubleClick Campaign Manager ad campaigns and reports.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/doubleclick-advertisers/reporting/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/dfareporting/v2.0/",
- "basePath": "/dfareporting/v2.0/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "dfareporting/v2.0/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/dfareporting": {
- "description": "View and manage DoubleClick for Advertisers reports"
- },
- "https://www.googleapis.com/auth/dfatrafficking": {
- "description": "View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns"
- }
- }
- }
- },
- "schemas": {
- "Account": {
- "id": "Account",
- "type": "object",
- "description": "Contains properties of a DCM account.",
- "properties": {
- "accountPermissionIds": {
- "type": "array",
- "description": "Account permissions assigned to this account.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "accountProfile": {
- "type": "string",
- "description": "Profile for this account. This is a read-only field that can be left blank.",
- "enum": [
- "ACCOUNT_PROFILE_BASIC",
- "ACCOUNT_PROFILE_STANDARD"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "active": {
- "type": "boolean",
- "description": "Whether this account is active."
- },
- "activeAdsLimitTier": {
- "type": "string",
- "description": "Maximum number of active ads allowed for this account.",
- "enum": [
- "ACTIVE_ADS_TIER_100K",
- "ACTIVE_ADS_TIER_200K",
- "ACTIVE_ADS_TIER_300K",
- "ACTIVE_ADS_TIER_40K",
- "ACTIVE_ADS_TIER_75K"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "activeViewOptOut": {
- "type": "boolean",
- "description": "Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions."
- },
- "availablePermissionIds": {
- "type": "array",
- "description": "User role permissions available to the user roles of this account.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "comscoreVceEnabled": {
- "type": "boolean",
- "description": "Whether campaigns created in this account will be enabled for comScore vCE by default."
- },
- "countryId": {
- "type": "string",
- "description": "ID of the country associated with this account.",
- "format": "int64"
- },
- "currencyId": {
- "type": "string",
- "description": "ID of currency associated with this account. This is a required field.\nAcceptable values are: \n- \"1\" for USD \n- \"2\" for GBP \n- \"3\" for ESP \n- \"4\" for SEK \n- \"5\" for CAD \n- \"6\" for JPY \n- \"7\" for DEM \n- \"8\" for AUD \n- \"9\" for FRF \n- \"10\" for ITL \n- \"11\" for DKK \n- \"12\" for NOK \n- \"13\" for FIM \n- \"14\" for ZAR \n- \"15\" for IEP \n- \"16\" for NLG \n- \"17\" for EUR \n- \"18\" for KRW \n- \"19\" for TWD \n- \"20\" for SGD \n- \"21\" for CNY \n- \"22\" for HKD \n- \"23\" for NZD \n- \"24\" for MYR \n- \"25\" for BRL \n- \"26\" for PTE \n- \"27\" for MXP \n- \"28\" for CLP \n- \"29\" for TRY \n- \"30\" for ARS \n- \"31\" for PEN \n- \"32\" for ILS \n- \"33\" for CHF \n- \"34\" for VEF \n- \"35\" for COP \n- \"36\" for GTQ",
- "format": "int64"
- },
- "defaultCreativeSizeId": {
- "type": "string",
- "description": "Default placement dimensions for this account.",
- "format": "int64"
- },
- "description": {
- "type": "string",
- "description": "Description of this account."
- },
- "id": {
- "type": "string",
- "description": "ID of this account. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#account\".",
- "default": "dfareporting#account"
- },
- "locale": {
- "type": "string",
- "description": "Locale of this account.\nAcceptable values are: \n- \"cs\" (Czech) \n- \"de\" (German) \n- \"en\" (English) \n- \"en-GB\" (English United Kingdom) \n- \"es\" (Spanish) \n- \"fr\" (French) \n- \"it\" (Italian) \n- \"ja\" (Japanese) \n- \"ko\" (Korean) \n- \"pl\" (Polish) \n- \"pt-BR\" (Portuguese Brazil) \n- \"ru\" (Russian) \n- \"sv\" (Swedish) \n- \"tr\" (Turkish) \n- \"zh-CN\" (Chinese Simplified) \n- \"zh-TW\" (Chinese Traditional)"
- },
- "maximumImageSize": {
- "type": "string",
- "description": "Maximum image size allowed for this account.",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "Name of this account. This is a required field, and must be less than 128 characters long and be globally unique."
- },
- "nielsenOcrEnabled": {
- "type": "boolean",
- "description": "Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default."
- },
- "reportsConfiguration": {
- "$ref": "ReportsConfiguration",
- "description": "Reporting configuration of this account."
- },
- "teaserSizeLimit": {
- "type": "string",
- "description": "File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.",
- "format": "int64"
- }
- }
- },
- "AccountActiveAdSummary": {
- "id": "AccountActiveAdSummary",
- "type": "object",
- "description": "Gets a summary of active ads in an account.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "ID of the account.",
- "format": "int64"
- },
- "activeAds": {
- "type": "string",
- "description": "Ads that have been activated for the account",
- "format": "int64"
- },
- "activeAdsLimitTier": {
- "type": "string",
- "description": "Maximum number of active ads allowed for the account.",
- "enum": [
- "ACTIVE_ADS_TIER_100K",
- "ACTIVE_ADS_TIER_200K",
- "ACTIVE_ADS_TIER_300K",
- "ACTIVE_ADS_TIER_40K",
- "ACTIVE_ADS_TIER_75K"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "availableAds": {
- "type": "string",
- "description": "Ads that can be activated for the account.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountActiveAdSummary\".",
- "default": "dfareporting#accountActiveAdSummary"
- }
- }
- },
- "AccountPermission": {
- "id": "AccountPermission",
- "type": "object",
- "description": "AccountPermissions contains information about a particular account permission. Some features of DCM require an account permission to be present in the account.",
- "properties": {
- "accountProfiles": {
- "type": "array",
- "description": "Account profiles associated with this account permission.\n\nPossible values are:\n- \"ACCOUNT_PROFILE_BASIC\"\n- \"ACCOUNT_PROFILE_STANDARD\"",
- "items": {
- "type": "string",
- "enum": [
- "ACCOUNT_PROFILE_BASIC",
- "ACCOUNT_PROFILE_STANDARD"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- }
- },
- "id": {
- "type": "string",
- "description": "ID of this account permission.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermission\".",
- "default": "dfareporting#accountPermission"
- },
- "level": {
- "type": "string",
- "description": "Administrative level required to enable this account permission.",
- "enum": [
- "ADMINISTRATOR",
- "USER"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "name": {
- "type": "string",
- "description": "Name of this account permission."
- },
- "permissionGroupId": {
- "type": "string",
- "description": "Permission group of this account permission.",
- "format": "int64"
- }
- }
- },
- "AccountPermissionGroup": {
- "id": "AccountPermissionGroup",
- "type": "object",
- "description": "AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.",
- "properties": {
- "id": {
- "type": "string",
- "description": "ID of this account permission group.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionGroup\".",
- "default": "dfareporting#accountPermissionGroup"
- },
- "name": {
- "type": "string",
- "description": "Name of this account permission group."
- }
- }
- },
- "AccountPermissionGroupsListResponse": {
- "id": "AccountPermissionGroupsListResponse",
- "type": "object",
- "description": "Account Permission Group List Response",
- "properties": {
- "accountPermissionGroups": {
- "type": "array",
- "description": "Account permission group collection.",
- "items": {
- "$ref": "AccountPermissionGroup"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionGroupsListResponse\".",
- "default": "dfareporting#accountPermissionGroupsListResponse"
- }
- }
- },
- "AccountPermissionsListResponse": {
- "id": "AccountPermissionsListResponse",
- "type": "object",
- "description": "Account Permission List Response",
- "properties": {
- "accountPermissions": {
- "type": "array",
- "description": "Account permission collection.",
- "items": {
- "$ref": "AccountPermission"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionsListResponse\".",
- "default": "dfareporting#accountPermissionsListResponse"
- }
- }
- },
- "AccountUserProfile": {
- "id": "AccountUserProfile",
- "type": "object",
- "description": "AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of the user profile. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "active": {
- "type": "boolean",
- "description": "Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable."
- },
- "advertiserFilter": {
- "$ref": "ObjectFilter",
- "description": "Filter that describes which advertisers are visible to the user profile."
- },
- "campaignFilter": {
- "$ref": "ObjectFilter",
- "description": "Filter that describes which campaigns are visible to the user profile."
- },
- "comments": {
- "type": "string",
- "description": "Comments for this user profile."
- },
- "email": {
- "type": "string",
- "description": "Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion."
- },
- "id": {
- "type": "string",
- "description": "ID of the user profile. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountUserProfile\".",
- "default": "dfareporting#accountUserProfile"
- },
- "locale": {
- "type": "string",
- "description": "Locale of the user profile. This is a required field.\nAcceptable values are: \n- \"cs\" (Czech) \n- \"de\" (German) \n- \"en\" (English) \n- \"en-GB\" (English United Kingdom) \n- \"es\" (Spanish) \n- \"fr\" (French) \n- \"it\" (Italian) \n- \"ja\" (Japanese) \n- \"ko\" (Korean) \n- \"pl\" (Polish) \n- \"pt-BR\" (Portuguese Brazil)\n- \"ru\" (Russian) \n- \"sv\" (Swedish) \n- \"tr\" (Turkish) \n- \"zh-CN\" (Chinese Simplified) \n- \"zh-TW\" (Chinese Traditional)"
- },
- "name": {
- "type": "string",
- "description": "Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: \"&;\"#%,\"."
- },
- "siteFilter": {
- "$ref": "ObjectFilter",
- "description": "Filter that describes which sites are visible to the user profile."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of the user profile. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "traffickerType": {
- "type": "string",
- "description": "Trafficker type of this user profile.",
- "enum": [
- "EXTERNAL_TRAFFICKER",
- "INTERNAL_NON_TRAFFICKER",
- "INTERNAL_TRAFFICKER"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "userAccessType": {
- "type": "string",
- "description": "User type of the user profile. This is a read-only field that can be left blank.",
- "enum": [
- "INTERNAL_ADMINISTRATOR",
- "NORMAL_USER",
- "SUPER_USER"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "userRoleFilter": {
- "$ref": "ObjectFilter",
- "description": "Filter that describes which user roles are visible to the user profile."
- },
- "userRoleId": {
- "type": "string",
- "description": "User role ID of the user profile. This is a required field.",
- "format": "int64"
- }
- }
- },
- "AccountUserProfilesListResponse": {
- "id": "AccountUserProfilesListResponse",
- "type": "object",
- "description": "Account User Profile List Response",
- "properties": {
- "accountUserProfiles": {
- "type": "array",
- "description": "Account user profile collection.",
- "items": {
- "$ref": "AccountUserProfile"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountUserProfilesListResponse\".",
- "default": "dfareporting#accountUserProfilesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "AccountsListResponse": {
- "id": "AccountsListResponse",
- "type": "object",
- "description": "Account List Response",
- "properties": {
- "accounts": {
- "type": "array",
- "description": "Account collection.",
- "items": {
- "$ref": "Account"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountsListResponse\".",
- "default": "dfareporting#accountsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "Activities": {
- "id": "Activities",
- "type": "object",
- "description": "Represents an activity group.",
- "properties": {
- "filters": {
- "type": "array",
- "description": "List of activity filters. The dimension values need to be all either of type \"dfa:activity\" or \"dfa:activityGroup\".",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#activities.",
- "default": "dfareporting#activities"
- },
- "metricNames": {
- "type": "array",
- "description": "List of names of floodlight activity metrics.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "Ad": {
- "id": "Ad",
- "type": "object",
- "description": "Contains properties of a DCM ad.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this ad. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "active": {
- "type": "boolean",
- "description": "Whether this ad is active."
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this ad. This is a required field on insertion.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "archived": {
- "type": "boolean",
- "description": "Whether this ad is archived."
- },
- "audienceSegmentId": {
- "type": "string",
- "description": "Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.",
- "format": "int64"
- },
- "campaignId": {
- "type": "string",
- "description": "Campaign ID of this ad. This is a required field on insertion.",
- "format": "int64"
- },
- "campaignIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
- },
- "clickThroughUrl": {
- "$ref": "ClickThroughUrl",
- "description": "Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER."
- },
- "clickThroughUrlSuffixProperties": {
- "$ref": "ClickThroughUrlSuffixProperties",
- "description": "Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative."
- },
- "comments": {
- "type": "string",
- "description": "Comments for this ad."
- },
- "compatibility": {
- "type": "string",
- "description": "Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.",
- "enum": [
- "APP",
- "APP_INTERSTITIAL",
- "IN_STREAM_VIDEO",
- "WEB",
- "WEB_INTERSTITIAL"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "createInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the creation of this ad.This is a read-only field."
- },
- "creativeGroupAssignments": {
- "type": "array",
- "description": "Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.",
- "items": {
- "$ref": "CreativeGroupAssignment"
- }
- },
- "creativeRotation": {
- "$ref": "CreativeRotation",
- "description": "Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment."
- },
- "dayPartTargeting": {
- "$ref": "DayPartTargeting",
- "description": "Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD."
- },
- "defaultClickThroughEventTagProperties": {
- "$ref": "DefaultClickThroughEventTagProperties",
- "description": "Default click-through event tag properties for this ad."
- },
- "deliverySchedule": {
- "$ref": "DeliverySchedule",
- "description": "Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD."
- },
- "dynamicClickTracker": {
- "type": "boolean",
- "description": "Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert."
- },
- "endTime": {
- "type": "string",
- "description": "Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.",
- "format": "date-time"
- },
- "eventTagOverrides": {
- "type": "array",
- "description": "Event tag overrides for this ad.",
- "items": {
- "$ref": "EventTagOverride"
- }
- },
- "geoTargeting": {
- "$ref": "GeoTargeting",
- "description": "Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD."
- },
- "id": {
- "type": "string",
- "description": "ID of this ad. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this ad. This is a read-only, auto-generated field."
- },
- "keyValueTargetingExpression": {
- "$ref": "KeyValueTargetingExpression",
- "description": "Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#ad\".",
- "default": "dfareporting#ad"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this ad. This is a read-only field."
- },
- "name": {
- "type": "string",
- "description": "Name of this ad. This is a required field and must be less than 256 characters long."
- },
- "placementAssignments": {
- "type": "array",
- "description": "Placement assignments for this ad.",
- "items": {
- "$ref": "PlacementAssignment"
- }
- },
- "remarketing_list_expression": {
- "$ref": "ListTargetingExpression",
- "description": "Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad."
- },
- "size": {
- "$ref": "Size",
- "description": "Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD."
- },
- "sslCompliant": {
- "type": "boolean",
- "description": "Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated."
- },
- "sslRequired": {
- "type": "boolean",
- "description": "Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated."
- },
- "startTime": {
- "type": "string",
- "description": "Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.",
- "format": "date-time"
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this ad. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "technologyTargeting": {
- "$ref": "TechnologyTargeting",
- "description": "Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD."
- },
- "type": {
- "type": "string",
- "description": "Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).",
- "enum": [
- "AD_SERVING_CLICK_TRACKER",
- "AD_SERVING_DEFAULT_AD",
- "AD_SERVING_STANDARD_AD",
- "AD_SERVING_TRACKING"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- }
- }
- },
- "AdsListResponse": {
- "id": "AdsListResponse",
- "type": "object",
- "description": "Ad List Response",
- "properties": {
- "ads": {
- "type": "array",
- "description": "Ad collection.",
- "items": {
- "$ref": "Ad"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#adsListResponse\".",
- "default": "dfareporting#adsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "Advertiser": {
- "id": "Advertiser",
- "type": "object",
- "description": "Contains properties of a DCM advertiser.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this advertiser.This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "advertiserGroupId": {
- "type": "string",
- "description": "ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.",
- "format": "int64"
- },
- "clickThroughUrlSuffix": {
- "type": "string",
- "description": "Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long."
- },
- "defaultClickThroughEventTagId": {
- "type": "string",
- "description": "ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.",
- "format": "int64"
- },
- "defaultEmail": {
- "type": "string",
- "description": "Default email address used in sender field for tag emails."
- },
- "floodlightConfigurationId": {
- "type": "string",
- "description": "Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: \n- This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. \n- This advertiser's original floodlight configuration is not already shared with another advertiser.",
- "format": "int64"
- },
- "floodlightConfigurationIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field."
- },
- "id": {
- "type": "string",
- "description": "ID of this advertiser. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this advertiser. This is a read-only, auto-generated field."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiser\".",
- "default": "dfareporting#advertiser"
- },
- "name": {
- "type": "string",
- "description": "Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account."
- },
- "status": {
- "type": "string",
- "description": "Status of this advertiser.",
- "enum": [
- "APPROVED",
- "ON_HOLD"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this advertiser.This is a read-only field that can be left blank.",
- "format": "int64"
- }
- }
- },
- "AdvertiserGroup": {
- "id": "AdvertiserGroup",
- "type": "object",
- "description": "Groups advertisers together so that reports can be generated for the entire group at once.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this advertiser group. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "ID of this advertiser group. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserGroup\".",
- "default": "dfareporting#advertiserGroup"
- },
- "name": {
- "type": "string",
- "description": "Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account."
- }
- }
- },
- "AdvertiserGroupsListResponse": {
- "id": "AdvertiserGroupsListResponse",
- "type": "object",
- "description": "Advertiser Group List Response",
- "properties": {
- "advertiserGroups": {
- "type": "array",
- "description": "Advertiser group collection.",
- "items": {
- "$ref": "AdvertiserGroup"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserGroupsListResponse\".",
- "default": "dfareporting#advertiserGroupsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "AdvertisersListResponse": {
- "id": "AdvertisersListResponse",
- "type": "object",
- "description": "Advertiser List Response",
- "properties": {
- "advertisers": {
- "type": "array",
- "description": "Advertiser collection.",
- "items": {
- "$ref": "Advertiser"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertisersListResponse\".",
- "default": "dfareporting#advertisersListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "AudienceSegment": {
- "id": "AudienceSegment",
- "type": "object",
- "description": "Audience Segment.",
- "properties": {
- "allocation": {
- "type": "integer",
- "description": "Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.",
- "format": "int32"
- },
- "id": {
- "type": "string",
- "description": "ID of this audience segment. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "Name of this audience segment. This is a required field and must be less than 65 characters long."
- }
- }
- },
- "AudienceSegmentGroup": {
- "id": "AudienceSegmentGroup",
- "type": "object",
- "description": "Audience Segment Group.",
- "properties": {
- "audienceSegments": {
- "type": "array",
- "description": "Audience segments assigned to this group. The number of segments must be between 2 and 100.",
- "items": {
- "$ref": "AudienceSegment"
- }
- },
- "id": {
- "type": "string",
- "description": "ID of this audience segment group. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "Name of this audience segment group. This is a required field and must be less than 65 characters long."
- }
- }
- },
- "Browser": {
- "id": "Browser",
- "type": "object",
- "description": "Contains information about a browser that can be targeted by ads.",
- "properties": {
- "browserVersionId": {
- "type": "string",
- "description": "ID referring to this grouping of browser and version numbers. This is the ID used for targeting.",
- "format": "int64"
- },
- "dartId": {
- "type": "string",
- "description": "DART ID of this browser. This is the ID used when generating reports.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#browser\".",
- "default": "dfareporting#browser"
- },
- "majorVersion": {
- "type": "string",
- "description": "Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is."
- },
- "minorVersion": {
- "type": "string",
- "description": "Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is."
- },
- "name": {
- "type": "string",
- "description": "Name of this browser."
- }
- }
- },
- "BrowsersListResponse": {
- "id": "BrowsersListResponse",
- "type": "object",
- "description": "Browser List Response",
- "properties": {
- "browsers": {
- "type": "array",
- "description": "Browser collection.",
- "items": {
- "$ref": "Browser"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#browsersListResponse\".",
- "default": "dfareporting#browsersListResponse"
- }
- }
- },
- "Campaign": {
- "id": "Campaign",
- "type": "object",
- "description": "Contains properties of a DCM campaign.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this campaign. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "additionalCreativeOptimizationConfigurations": {
- "type": "array",
- "description": "Additional creative optimization configurations for the campaign.",
- "items": {
- "$ref": "CreativeOptimizationConfiguration"
- }
- },
- "advertiserGroupId": {
- "type": "string",
- "description": "Advertiser group ID of the associated advertiser.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this campaign. This is a required field.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field."
- },
- "archived": {
- "type": "boolean",
- "description": "Whether this campaign has been archived."
- },
- "audienceSegmentGroups": {
- "type": "array",
- "description": "Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.",
- "items": {
- "$ref": "AudienceSegmentGroup"
- }
- },
- "billingInvoiceCode": {
- "type": "string",
- "description": "Billing invoice code included in the DCM client billing invoices associated with the campaign."
- },
- "clickThroughUrlSuffixProperties": {
- "$ref": "ClickThroughUrlSuffixProperties",
- "description": "Click-through URL suffix override properties for this campaign."
- },
- "comment": {
- "type": "string",
- "description": "Arbitrary comments about this campaign. Must be less than 256 characters long."
- },
- "comscoreVceEnabled": {
- "type": "boolean",
- "description": "Whether comScore vCE reports are enabled for this campaign."
- },
- "createInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the creation of this campaign. This is a read-only field."
- },
- "creativeGroupIds": {
- "type": "array",
- "description": "List of creative group IDs that are assigned to the campaign.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "creativeOptimizationConfiguration": {
- "$ref": "CreativeOptimizationConfiguration",
- "description": "Creative optimization configuration for the campaign."
- },
- "defaultClickThroughEventTagProperties": {
- "$ref": "DefaultClickThroughEventTagProperties",
- "description": "Click-through event tag ID override properties for this campaign."
- },
- "endDate": {
- "type": "string",
- "description": "Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.",
- "format": "date"
- },
- "eventTagOverrides": {
- "type": "array",
- "description": "Overrides that can be used to activate or deactivate advertiser event tags.",
- "items": {
- "$ref": "EventTagOverride"
- }
- },
- "externalId": {
- "type": "string",
- "description": "External ID for this campaign."
- },
- "id": {
- "type": "string",
- "description": "ID of this campaign. This is a read-only auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this campaign. This is a read-only, auto-generated field."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaign\".",
- "default": "dfareporting#campaign"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this campaign. This is a read-only field."
- },
- "lookbackConfiguration": {
- "$ref": "LookbackConfiguration",
- "description": "Lookback window settings for the campaign."
- },
- "name": {
- "type": "string",
- "description": "Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser."
- },
- "nielsenOcrEnabled": {
- "type": "boolean",
- "description": "Whether Nielsen reports are enabled for this campaign."
- },
- "startDate": {
- "type": "string",
- "description": "Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.",
- "format": "date"
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this campaign. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "traffickerEmails": {
- "type": "array",
- "description": "Campaign trafficker contact emails.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "CampaignCreativeAssociation": {
- "id": "CampaignCreativeAssociation",
- "type": "object",
- "description": "Identifies a creative which has been associated with a given campaign.",
- "properties": {
- "creativeId": {
- "type": "string",
- "description": "ID of the creative associated with the campaign. This is a required field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignCreativeAssociation\".",
- "default": "dfareporting#campaignCreativeAssociation"
- }
- }
- },
- "CampaignCreativeAssociationsListResponse": {
- "id": "CampaignCreativeAssociationsListResponse",
- "type": "object",
- "description": "Campaign Creative Association List Response",
- "properties": {
- "campaignCreativeAssociations": {
- "type": "array",
- "description": "Campaign creative association collection",
- "items": {
- "$ref": "CampaignCreativeAssociation"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignCreativeAssociationsListResponse\".",
- "default": "dfareporting#campaignCreativeAssociationsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "CampaignsListResponse": {
- "id": "CampaignsListResponse",
- "type": "object",
- "description": "Campaign List Response",
- "properties": {
- "campaigns": {
- "type": "array",
- "description": "Campaign collection.",
- "items": {
- "$ref": "Campaign"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignsListResponse\".",
- "default": "dfareporting#campaignsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "ChangeLog": {
- "id": "ChangeLog",
- "type": "object",
- "description": "Describes a change that a user has made to a resource.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of the modified object.",
- "format": "int64"
- },
- "action": {
- "type": "string",
- "description": "Action which caused the change."
- },
- "changeTime": {
- "type": "string",
- "description": "Time when the object was modified.",
- "format": "date-time"
- },
- "fieldName": {
- "type": "string",
- "description": "Field name of the object which changed."
- },
- "id": {
- "type": "string",
- "description": "ID of this change log.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#changeLog\".",
- "default": "dfareporting#changeLog"
- },
- "newValue": {
- "type": "string",
- "description": "New value of the object field."
- },
- "objectId": {
- "type": "string",
- "description": "ID of the object of this change log. The object could be a campaign, placement, ad, or other type.",
- "format": "int64"
- },
- "objectType": {
- "type": "string",
- "description": "Object type of the change log."
- },
- "oldValue": {
- "type": "string",
- "description": "Old value of the object field."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of the modified object.",
- "format": "int64"
- },
- "transactionId": {
- "type": "string",
- "description": "Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId.",
- "format": "int64"
- },
- "userProfileId": {
- "type": "string",
- "description": "ID of the user who modified the object.",
- "format": "int64"
- },
- "userProfileName": {
- "type": "string",
- "description": "User profile name of the user who modified the object."
- }
- }
- },
- "ChangeLogsListResponse": {
- "id": "ChangeLogsListResponse",
- "type": "object",
- "description": "Change Log List Response",
- "properties": {
- "changeLogs": {
- "type": "array",
- "description": "Change log collection.",
- "items": {
- "$ref": "ChangeLog"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#changeLogsListResponse\".",
- "default": "dfareporting#changeLogsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "CitiesListResponse": {
- "id": "CitiesListResponse",
- "type": "object",
- "description": "City List Response",
- "properties": {
- "cities": {
- "type": "array",
- "description": "City collection.",
- "items": {
- "$ref": "City"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#citiesListResponse\".",
- "default": "dfareporting#citiesListResponse"
- }
- }
- },
- "City": {
- "id": "City",
- "type": "object",
- "description": "Contains information about a city that can be targeted by ads.",
- "properties": {
- "countryCode": {
- "type": "string",
- "description": "Country code of the country to which this city belongs."
- },
- "countryDartId": {
- "type": "string",
- "description": "DART ID of the country to which this city belongs.",
- "format": "int64"
- },
- "dartId": {
- "type": "string",
- "description": "DART ID of this city. This is the ID used for targeting and generating reports.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#city\".",
- "default": "dfareporting#city"
- },
- "metroCode": {
- "type": "string",
- "description": "Metro region code of the metro region (DMA) to which this city belongs."
- },
- "metroDmaId": {
- "type": "string",
- "description": "ID of the metro region (DMA) to which this city belongs.",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "Name of this city."
- },
- "regionCode": {
- "type": "string",
- "description": "Region code of the region to which this city belongs."
- },
- "regionDartId": {
- "type": "string",
- "description": "DART ID of the region to which this city belongs.",
- "format": "int64"
- }
- }
- },
- "ClickTag": {
- "id": "ClickTag",
- "type": "object",
- "description": "Creative Click Tag.",
- "properties": {
- "eventName": {
- "type": "string",
- "description": "Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives."
- },
- "name": {
- "type": "string",
- "description": "Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field."
- },
- "value": {
- "type": "string",
- "description": "Parameter value for the specified click tag. This field contains a click-through url."
- }
- }
- },
- "ClickThroughUrl": {
- "id": "ClickThroughUrl",
- "type": "object",
- "description": "Click-through URL",
- "properties": {
- "customClickThroughUrl": {
- "type": "string",
- "description": "Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset."
- },
- "defaultLandingPage": {
- "type": "boolean",
- "description": "Whether the campaign default landing page is used."
- },
- "landingPageId": {
- "type": "string",
- "description": "ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.",
- "format": "int64"
- }
- }
- },
- "ClickThroughUrlSuffixProperties": {
- "id": "ClickThroughUrlSuffixProperties",
- "type": "object",
- "description": "Click Through URL Suffix settings.",
- "properties": {
- "clickThroughUrlSuffix": {
- "type": "string",
- "description": "Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long."
- },
- "overrideInheritedSuffix": {
- "type": "boolean",
- "description": "Whether this entity should override the inherited click-through URL suffix with its own defined value."
- }
- }
- },
- "CompanionClickThroughOverride": {
- "id": "CompanionClickThroughOverride",
- "type": "object",
- "description": "Companion Click-through override.",
- "properties": {
- "clickThroughUrl": {
- "$ref": "ClickThroughUrl",
- "description": "Click-through URL of this companion click-through override."
- },
- "creativeId": {
- "type": "string",
- "description": "ID of the creative for this companion click-through override.",
- "format": "int64"
- }
- }
- },
- "CompatibleFields": {
- "id": "CompatibleFields",
- "type": "object",
- "description": "Represents a response to the queryCompatibleFields method.",
- "properties": {
- "crossDimensionReachReportCompatibleFields": {
- "$ref": "CrossDimensionReachReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"CROSS_DIMENSION_REACH\"."
- },
- "floodlightReportCompatibleFields": {
- "$ref": "FloodlightReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"FLOODLIGHT\"."
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#compatibleFields.",
- "default": "dfareporting#compatibleFields"
- },
- "pathToConversionReportCompatibleFields": {
- "$ref": "PathToConversionReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"PATH_TO_CONVERSION\"."
- },
- "reachReportCompatibleFields": {
- "$ref": "ReachReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"REACH\"."
- },
- "reportCompatibleFields": {
- "$ref": "ReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"STANDARD\"."
- }
- }
- },
- "ConnectionType": {
- "id": "ConnectionType",
- "type": "object",
- "description": "Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.",
- "properties": {
- "id": {
- "type": "string",
- "description": "ID of this connection type.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#connectionType\".",
- "default": "dfareporting#connectionType"
- },
- "name": {
- "type": "string",
- "description": "Name of this connection type."
- }
- }
- },
- "ConnectionTypesListResponse": {
- "id": "ConnectionTypesListResponse",
- "type": "object",
- "description": "Connection Type List Response",
- "properties": {
- "connectionTypes": {
- "type": "array",
- "description": "Collection of connection types such as broadband and mobile.",
- "items": {
- "$ref": "ConnectionType"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#connectionTypesListResponse\".",
- "default": "dfareporting#connectionTypesListResponse"
- }
- }
- },
- "ContentCategoriesListResponse": {
- "id": "ContentCategoriesListResponse",
- "type": "object",
- "description": "Content Category List Response",
- "properties": {
- "contentCategories": {
- "type": "array",
- "description": "Content category collection.",
- "items": {
- "$ref": "ContentCategory"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#contentCategoriesListResponse\".",
- "default": "dfareporting#contentCategoriesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "ContentCategory": {
- "id": "ContentCategory",
- "type": "object",
- "description": "Organizes placements according to the contents of their associated webpages.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this content category. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "description": {
- "type": "string",
- "description": "Description of this content category."
- },
- "id": {
- "type": "string",
- "description": "ID of this content category. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#contentCategory\".",
- "default": "dfareporting#contentCategory"
- },
- "name": {
- "type": "string",
- "description": "Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account."
- }
- }
- },
- "CountriesListResponse": {
- "id": "CountriesListResponse",
- "type": "object",
- "description": "Country List Response",
- "properties": {
- "countries": {
- "type": "array",
- "description": "Country collection.",
- "items": {
- "$ref": "Country"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#countriesListResponse\".",
- "default": "dfareporting#countriesListResponse"
- }
- }
- },
- "Country": {
- "id": "Country",
- "type": "object",
- "description": "Contains information about a country that can be targeted by ads.",
- "properties": {
- "countryCode": {
- "type": "string",
- "description": "Country code."
- },
- "dartId": {
- "type": "string",
- "description": "DART ID of this country. This is the ID used for targeting and generating reports.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#country\".",
- "default": "dfareporting#country"
- },
- "name": {
- "type": "string",
- "description": "Name of this country."
- },
- "sslEnabled": {
- "type": "boolean",
- "description": "Whether ad serving supports secure servers in this country."
- }
- }
- },
- "Creative": {
- "id": "Creative",
- "type": "object",
- "description": "Contains properties of a Creative.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.",
- "format": "int64"
- },
- "active": {
- "type": "boolean",
- "description": "Whether the creative is active. Applicable to all creative types."
- },
- "adParameters": {
- "type": "string",
- "description": "Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID."
- },
- "adTagKeys": {
- "type": "array",
- "description": "Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "items": {
- "type": "string"
- }
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this creative. This is a required field. Applicable to all creative types.",
- "format": "int64"
- },
- "allowScriptAccess": {
- "type": "boolean",
- "description": "Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE."
- },
- "archived": {
- "type": "boolean",
- "description": "Whether the creative is archived. Applicable to all creative types."
- },
- "artworkType": {
- "type": "string",
- "description": "Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "enum": [
- "ARTWORK_TYPE_FLASH",
- "ARTWORK_TYPE_HTML5",
- "ARTWORK_TYPE_MIXED"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "authoringTool": {
- "type": "string",
- "description": "Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.",
- "enum": [
- "NINJA",
- "SWIFFY"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "auto_advance_images": {
- "type": "boolean",
- "description": "Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE."
- },
- "backgroundColor": {
- "type": "string",
- "description": "The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE."
- },
- "backupImageClickThroughUrl": {
- "type": "string",
- "description": "Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER."
- },
- "backupImageFeatures": {
- "type": "array",
- "description": "List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.",
- "items": {
- "type": "string",
- "enum": [
- "APPLICATION_CACHE",
- "AUDIO",
- "CANVAS",
- "CANVAS_TEXT",
- "CSS_ANIMATIONS",
- "CSS_BACKGROUND_SIZE",
- "CSS_BORDER_IMAGE",
- "CSS_BORDER_RADIUS",
- "CSS_BOX_SHADOW",
- "CSS_COLUMNS",
- "CSS_FLEX_BOX",
- "CSS_FONT_FACE",
- "CSS_GENERATED_CONTENT",
- "CSS_GRADIENTS",
- "CSS_HSLA",
- "CSS_MULTIPLE_BGS",
- "CSS_OPACITY",
- "CSS_REFLECTIONS",
- "CSS_RGBA",
- "CSS_TEXT_SHADOW",
- "CSS_TRANSFORMS",
- "CSS_TRANSFORMS3D",
- "CSS_TRANSITIONS",
- "DRAG_AND_DROP",
- "GEO_LOCATION",
- "HASH_CHANGE",
- "HISTORY",
- "INDEXED_DB",
- "INLINE_SVG",
- "INPUT_ATTR_AUTOCOMPLETE",
- "INPUT_ATTR_AUTOFOCUS",
- "INPUT_ATTR_LIST",
- "INPUT_ATTR_MAX",
- "INPUT_ATTR_MIN",
- "INPUT_ATTR_MULTIPLE",
- "INPUT_ATTR_PATTERN",
- "INPUT_ATTR_PLACEHOLDER",
- "INPUT_ATTR_REQUIRED",
- "INPUT_ATTR_STEP",
- "INPUT_TYPE_COLOR",
- "INPUT_TYPE_DATE",
- "INPUT_TYPE_DATETIME",
- "INPUT_TYPE_DATETIME_LOCAL",
- "INPUT_TYPE_EMAIL",
- "INPUT_TYPE_MONTH",
- "INPUT_TYPE_NUMBER",
- "INPUT_TYPE_RANGE",
- "INPUT_TYPE_SEARCH",
- "INPUT_TYPE_TEL",
- "INPUT_TYPE_TIME",
- "INPUT_TYPE_URL",
- "INPUT_TYPE_WEEK",
- "LOCAL_STORAGE",
- "POST_MESSAGE",
- "SESSION_STORAGE",
- "SMIL",
- "SVG_CLIP_PATHS",
- "SVG_FE_IMAGE",
- "SVG_FILTERS",
- "SVG_HREF",
- "TOUCH",
- "VIDEO",
- "WEBGL",
- "WEB_SOCKETS",
- "WEB_SQL_DATABASE",
- "WEB_WORKERS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- },
- "backupImageReportingLabel": {
- "type": "string",
- "description": "Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER."
- },
- "backupImageTargetWindow": {
- "$ref": "TargetWindow",
- "description": "Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER."
- },
- "clickTags": {
- "type": "array",
- "description": "Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.",
- "items": {
- "$ref": "ClickTag"
- }
- },
- "commercialId": {
- "type": "string",
- "description": "Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
- },
- "companionCreatives": {
- "type": "array",
- "description": "List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "compatibility": {
- "type": "array",
- "description": "Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.\n\nAcceptable values are:\n- \"APP\"\n- \"APP_INTERSTITIAL\"\n- \"IN_STREAM_VIDEO\"\n- \"WEB\"\n- \"WEB_INTERSTITIAL\"",
- "items": {
- "type": "string",
- "enum": [
- "APP",
- "APP_INTERSTITIAL",
- "IN_STREAM_VIDEO",
- "WEB",
- "WEB_INTERSTITIAL"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- }
- },
- "counterCustomEvents": {
- "type": "array",
- "description": "List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "items": {
- "$ref": "CreativeCustomEvent"
- }
- },
- "creativeAssets": {
- "type": "array",
- "description": "Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT",
- "items": {
- "$ref": "CreativeAsset"
- }
- },
- "creativeFieldAssignments": {
- "type": "array",
- "description": "Creative field assignments for this creative. Applicable to all creative types.",
- "items": {
- "$ref": "CreativeFieldAssignment"
- }
- },
- "customKeyValues": {
- "type": "array",
- "description": "Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "items": {
- "type": "string"
- }
- },
- "exitCustomEvents": {
- "type": "array",
- "description": "List of exit events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "items": {
- "$ref": "CreativeCustomEvent"
- }
- },
- "fsCommand": {
- "$ref": "FsCommand",
- "description": "OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE."
- },
- "htmlCode": {
- "type": "string",
- "description": "HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA."
- },
- "htmlCodeLocked": {
- "type": "boolean",
- "description": "Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER."
- },
- "id": {
- "type": "string",
- "description": "ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creative\".",
- "default": "dfareporting#creative"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Creative last modification information. This is a read-only field. Applicable to all creative types."
- },
- "latestTraffickedCreativeId": {
- "type": "string",
- "description": "Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types."
- },
- "overrideCss": {
- "type": "string",
- "description": "Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA."
- },
- "redirectUrl": {
- "type": "string",
- "description": "URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT"
- },
- "renderingId": {
- "type": "string",
- "description": "ID of current rendering version. This is a read-only field. Applicable to all creative types.",
- "format": "int64"
- },
- "renderingIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types."
- },
- "requiredFlashPluginVersion": {
- "type": "string",
- "description": "The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID."
- },
- "requiredFlashVersion": {
- "type": "integer",
- "description": "The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.",
- "format": "int32"
- },
- "size": {
- "$ref": "Size",
- "description": "Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA."
- },
- "skippable": {
- "type": "boolean",
- "description": "Whether the user can choose to skip the creative. Applicable to the following creative types: INSTREAM_VIDEO."
- },
- "sslCompliant": {
- "type": "boolean",
- "description": "Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types."
- },
- "studioAdvertiserId": {
- "type": "string",
- "description": "Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "format": "int64"
- },
- "studioCreativeId": {
- "type": "string",
- "description": "Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "format": "int64"
- },
- "studioTraffickedCreativeId": {
- "type": "string",
- "description": "Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "format": "int64"
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.",
- "format": "int64"
- },
- "thirdPartyBackupImageImpressionsUrl": {
- "type": "string",
- "description": "Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA"
- },
- "thirdPartyRichMediaImpressionsUrl": {
- "type": "string",
- "description": "Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA"
- },
- "thirdPartyUrls": {
- "type": "array",
- "description": "Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.",
- "items": {
- "$ref": "ThirdPartyTrackingUrl"
- }
- },
- "timerCustomEvents": {
- "type": "array",
- "description": "List of timer events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "items": {
- "$ref": "CreativeCustomEvent"
- }
- },
- "totalFileSize": {
- "type": "string",
- "description": "Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "format": "int64"
- },
- "type": {
- "type": "string",
- "description": "Type of this creative.This is a required field. Applicable to all creative types.",
- "enum": [
- "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO",
- "CUSTOM_INPAGE",
- "CUSTOM_INTERSTITIAL",
- "ENHANCED_BANNER",
- "ENHANCED_IMAGE",
- "FLASH_INPAGE",
- "HTML5_BANNER",
- "IMAGE",
- "INSTREAM_VIDEO",
- "INTERNAL_REDIRECT",
- "INTERSTITIAL_INTERNAL_REDIRECT",
- "REDIRECT",
- "RICH_MEDIA_EXPANDING",
- "RICH_MEDIA_IM_EXPAND",
- "RICH_MEDIA_INPAGE",
- "RICH_MEDIA_INPAGE_FLOATING",
- "RICH_MEDIA_INTERSTITIAL_FLOAT",
- "RICH_MEDIA_MOBILE_IN_APP",
- "RICH_MEDIA_MULTI_FLOATING",
- "RICH_MEDIA_PEEL_DOWN",
- "TRACKING_TEXT",
- "VAST_REDIRECT",
- "VPAID_LINEAR",
- "VPAID_NON_LINEAR"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "version": {
- "type": "integer",
- "description": "The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.",
- "format": "int32"
- },
- "videoDescription": {
- "type": "string",
- "description": "Description of the video ad. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
- },
- "videoDuration": {
- "type": "number",
- "description": "Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.",
- "format": "float"
- }
- }
- },
- "CreativeAsset": {
- "id": "CreativeAsset",
- "type": "object",
- "description": "Creative Asset.",
- "properties": {
- "actionScript3": {
- "type": "boolean",
- "description": "Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER."
- },
- "active": {
- "type": "boolean",
- "description": "Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
- },
- "alignment": {
- "type": "string",
- "description": "Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.",
- "enum": [
- "ALIGNMENT_BOTTOM",
- "ALIGNMENT_LEFT",
- "ALIGNMENT_RIGHT",
- "ALIGNMENT_TOP"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- },
- "artworkType": {
- "type": "string",
- "description": "Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "ARTWORK_TYPE_FLASH",
- "ARTWORK_TYPE_HTML5",
- "ARTWORK_TYPE_MIXED"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "assetIdentifier": {
- "$ref": "CreativeAssetId",
- "description": "Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT."
- },
- "backupImageExit": {
- "$ref": "CreativeCustomEvent",
- "description": "Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA."
- },
- "bitRate": {
- "type": "integer",
- "description": "Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.",
- "format": "int32"
- },
- "childAssetType": {
- "type": "string",
- "description": "Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.",
- "enum": [
- "CHILD_ASSET_TYPE_DATA",
- "CHILD_ASSET_TYPE_FLASH",
- "CHILD_ASSET_TYPE_IMAGE",
- "CHILD_ASSET_TYPE_VIDEO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- },
- "collapsedSize": {
- "$ref": "Size",
- "description": "Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN."
- },
- "customStartTimeValue": {
- "type": "integer",
- "description": "Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.",
- "format": "int32"
- },
- "detectedFeatures": {
- "type": "array",
- "description": "List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.",
- "items": {
- "type": "string",
- "enum": [
- "APPLICATION_CACHE",
- "AUDIO",
- "CANVAS",
- "CANVAS_TEXT",
- "CSS_ANIMATIONS",
- "CSS_BACKGROUND_SIZE",
- "CSS_BORDER_IMAGE",
- "CSS_BORDER_RADIUS",
- "CSS_BOX_SHADOW",
- "CSS_COLUMNS",
- "CSS_FLEX_BOX",
- "CSS_FONT_FACE",
- "CSS_GENERATED_CONTENT",
- "CSS_GRADIENTS",
- "CSS_HSLA",
- "CSS_MULTIPLE_BGS",
- "CSS_OPACITY",
- "CSS_REFLECTIONS",
- "CSS_RGBA",
- "CSS_TEXT_SHADOW",
- "CSS_TRANSFORMS",
- "CSS_TRANSFORMS3D",
- "CSS_TRANSITIONS",
- "DRAG_AND_DROP",
- "GEO_LOCATION",
- "HASH_CHANGE",
- "HISTORY",
- "INDEXED_DB",
- "INLINE_SVG",
- "INPUT_ATTR_AUTOCOMPLETE",
- "INPUT_ATTR_AUTOFOCUS",
- "INPUT_ATTR_LIST",
- "INPUT_ATTR_MAX",
- "INPUT_ATTR_MIN",
- "INPUT_ATTR_MULTIPLE",
- "INPUT_ATTR_PATTERN",
- "INPUT_ATTR_PLACEHOLDER",
- "INPUT_ATTR_REQUIRED",
- "INPUT_ATTR_STEP",
- "INPUT_TYPE_COLOR",
- "INPUT_TYPE_DATE",
- "INPUT_TYPE_DATETIME",
- "INPUT_TYPE_DATETIME_LOCAL",
- "INPUT_TYPE_EMAIL",
- "INPUT_TYPE_MONTH",
- "INPUT_TYPE_NUMBER",
- "INPUT_TYPE_RANGE",
- "INPUT_TYPE_SEARCH",
- "INPUT_TYPE_TEL",
- "INPUT_TYPE_TIME",
- "INPUT_TYPE_URL",
- "INPUT_TYPE_WEEK",
- "LOCAL_STORAGE",
- "POST_MESSAGE",
- "SESSION_STORAGE",
- "SMIL",
- "SVG_CLIP_PATHS",
- "SVG_FE_IMAGE",
- "SVG_FILTERS",
- "SVG_HREF",
- "TOUCH",
- "VIDEO",
- "WEBGL",
- "WEB_SOCKETS",
- "WEB_SQL_DATABASE",
- "WEB_WORKERS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- },
- "displayType": {
- "type": "string",
- "description": "Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "ASSET_DISPLAY_TYPE_EXPANDING",
- "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH",
- "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH_EXPANDING",
- "ASSET_DISPLAY_TYPE_FLOATING",
- "ASSET_DISPLAY_TYPE_INPAGE",
- "ASSET_DISPLAY_TYPE_OVERLAY",
- "ASSET_DISPLAY_TYPE_PEEL_DOWN",
- "ASSET_DISPLAY_TYPE_VPAID_LINEAR",
- "ASSET_DISPLAY_TYPE_VPAID_NON_LINEAR"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "duration": {
- "type": "integer",
- "description": "Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.",
- "format": "int32"
- },
- "durationType": {
- "type": "string",
- "description": "Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "ASSET_DURATION_TYPE_AUTO",
- "ASSET_DURATION_TYPE_CUSTOM",
- "ASSET_DURATION_TYPE_NONE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "expandedDimension": {
- "$ref": "Size",
- "description": "Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
- },
- "fileSize": {
- "type": "string",
- "description": "File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.",
- "format": "int64"
- },
- "flashVersion": {
- "type": "integer",
- "description": "Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.",
- "format": "int32"
- },
- "hideFlashObjects": {
- "type": "boolean",
- "description": "Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA."
- },
- "hideSelectionBoxes": {
- "type": "boolean",
- "description": "Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA."
- },
- "horizontallyLocked": {
- "type": "boolean",
- "description": "Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA."
- },
- "id": {
- "type": "string",
- "description": "Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.",
- "format": "int64"
- },
- "mimeType": {
- "type": "string",
- "description": "Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
- },
- "offset": {
- "$ref": "OffsetPosition",
- "description": "Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN."
- },
- "originalBackup": {
- "type": "boolean",
- "description": "Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA."
- },
- "position": {
- "$ref": "OffsetPosition",
- "description": "Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA."
- },
- "positionLeftUnit": {
- "type": "string",
- "description": "Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "OFFSET_UNIT_PERCENT",
- "OFFSET_UNIT_PIXEL",
- "OFFSET_UNIT_PIXEL_FROM_CENTER"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "positionTopUnit": {
- "type": "string",
- "description": "Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "OFFSET_UNIT_PERCENT",
- "OFFSET_UNIT_PIXEL",
- "OFFSET_UNIT_PIXEL_FROM_CENTER"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "progressiveServingUrl": {
- "type": "string",
- "description": "Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
- },
- "pushdown": {
- "type": "boolean",
- "description": "Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height."
- },
- "pushdownDuration": {
- "type": "number",
- "description": "Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.",
- "format": "float"
- },
- "role": {
- "type": "string",
- "description": "Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.\nPRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.\nBACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.\nADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.\nOTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.\nPARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.\nTRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.\nALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.\nFor VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.",
- "enum": [
- "ADDITIONAL_FLASH",
- "ADDITIONAL_IMAGE",
- "ALTERNATE_VIDEO",
- "BACKUP_IMAGE",
- "OTHER",
- "PARENT_VIDEO",
- "PRIMARY",
- "TRANSCODED_VIDEO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "size": {
- "$ref": "Size",
- "description": "Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA."
- },
- "sslCompliant": {
- "type": "boolean",
- "description": "Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT."
- },
- "startTimeType": {
- "type": "string",
- "description": "Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "ASSET_START_TIME_TYPE_CUSTOM",
- "ASSET_START_TIME_TYPE_NONE"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "streamingServingUrl": {
- "type": "string",
- "description": "Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
- },
- "transparency": {
- "type": "boolean",
- "description": "Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets."
- },
- "verticallyLocked": {
- "type": "boolean",
- "description": "Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA."
- },
- "videoDuration": {
- "type": "number",
- "description": "Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.",
- "format": "float"
- },
- "windowMode": {
- "type": "string",
- "description": "Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.",
- "enum": [
- "OPAQUE",
- "TRANSPARENT",
- "WINDOW"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "zIndex": {
- "type": "integer",
- "description": "zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.",
- "format": "int32"
- },
- "zipFilename": {
- "type": "string",
- "description": "File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER."
- },
- "zipFilesize": {
- "type": "string",
- "description": "Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER."
- }
- }
- },
- "CreativeAssetId": {
- "id": "CreativeAssetId",
- "type": "object",
- "description": "Creative Asset ID.",
- "properties": {
- "name": {
- "type": "string",
- "description": "Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: \".-_ \". Spaces are allowed."
- },
- "type": {
- "type": "string",
- "description": "Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.",
- "enum": [
- "FLASH",
- "HTML",
- "HTML_IMAGE",
- "IMAGE",
- "VIDEO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- }
- }
- },
- "CreativeAssetMetadata": {
- "id": "CreativeAssetMetadata",
- "type": "object",
- "description": "CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.",
- "properties": {
- "assetIdentifier": {
- "$ref": "CreativeAssetId",
- "description": "ID of the creative asset. This is a required field."
- },
- "clickTags": {
- "type": "array",
- "description": "List of detected click tags for assets. This is a read-only auto-generated field.",
- "items": {
- "$ref": "ClickTag"
- }
- },
- "detectedFeatures": {
- "type": "array",
- "description": "List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.",
- "items": {
- "type": "string",
- "enum": [
- "APPLICATION_CACHE",
- "AUDIO",
- "CANVAS",
- "CANVAS_TEXT",
- "CSS_ANIMATIONS",
- "CSS_BACKGROUND_SIZE",
- "CSS_BORDER_IMAGE",
- "CSS_BORDER_RADIUS",
- "CSS_BOX_SHADOW",
- "CSS_COLUMNS",
- "CSS_FLEX_BOX",
- "CSS_FONT_FACE",
- "CSS_GENERATED_CONTENT",
- "CSS_GRADIENTS",
- "CSS_HSLA",
- "CSS_MULTIPLE_BGS",
- "CSS_OPACITY",
- "CSS_REFLECTIONS",
- "CSS_RGBA",
- "CSS_TEXT_SHADOW",
- "CSS_TRANSFORMS",
- "CSS_TRANSFORMS3D",
- "CSS_TRANSITIONS",
- "DRAG_AND_DROP",
- "GEO_LOCATION",
- "HASH_CHANGE",
- "HISTORY",
- "INDEXED_DB",
- "INLINE_SVG",
- "INPUT_ATTR_AUTOCOMPLETE",
- "INPUT_ATTR_AUTOFOCUS",
- "INPUT_ATTR_LIST",
- "INPUT_ATTR_MAX",
- "INPUT_ATTR_MIN",
- "INPUT_ATTR_MULTIPLE",
- "INPUT_ATTR_PATTERN",
- "INPUT_ATTR_PLACEHOLDER",
- "INPUT_ATTR_REQUIRED",
- "INPUT_ATTR_STEP",
- "INPUT_TYPE_COLOR",
- "INPUT_TYPE_DATE",
- "INPUT_TYPE_DATETIME",
- "INPUT_TYPE_DATETIME_LOCAL",
- "INPUT_TYPE_EMAIL",
- "INPUT_TYPE_MONTH",
- "INPUT_TYPE_NUMBER",
- "INPUT_TYPE_RANGE",
- "INPUT_TYPE_SEARCH",
- "INPUT_TYPE_TEL",
- "INPUT_TYPE_TIME",
- "INPUT_TYPE_URL",
- "INPUT_TYPE_WEEK",
- "LOCAL_STORAGE",
- "POST_MESSAGE",
- "SESSION_STORAGE",
- "SMIL",
- "SVG_CLIP_PATHS",
- "SVG_FE_IMAGE",
- "SVG_FILTERS",
- "SVG_HREF",
- "TOUCH",
- "VIDEO",
- "WEBGL",
- "WEB_SOCKETS",
- "WEB_SQL_DATABASE",
- "WEB_WORKERS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeAssetMetadata\".",
- "default": "dfareporting#creativeAssetMetadata"
- },
- "warnedValidationRules": {
- "type": "array",
- "description": "Rules validated during code generation that generated a warning. This is a read-only, auto-generated field.\n\nPossible values are:\n- \"CLICK_TAG_NON_TOP_LEVEL\"\n- \"CLICK_TAG_MISSING\"\n- \"CLICK_TAG_MORE_THAN_ONE\"\n- \"CLICK_TAG_INVALID\"\n- \"ORPHANED_ASSET\"\n- \"PRIMARY_HTML_MISSING\"\n- \"EXTERNAL_FILE_REFERENCED\"\n- \"MRAID_REFERENCED\"\n- \"ADMOB_REFERENCED\"\n- \"FILE_TYPE_INVALID\"\n- \"ZIP_INVALID\"\n- \"LINKED_FILE_NOT_FOUND\"\n- \"MAX_FLASH_VERSION_11\"\n- \"NOT_SSL_COMPLIANT\"\n- \"FILE_DETAIL_EMPTY\"\n- \"ASSET_INVALID\"\n- \"GWD_PROPERTIES_INVALID\"\n- \"ENABLER_UNSUPPORTED_METHOD_DCM\"\n- \"ASSET_FORMAT_UNSUPPORTED_DCM\"\n- \"COMPONENT_UNSUPPORTED_DCM\"\n- \"HTML5_FEATURE_UNSUPPORTED' \"",
- "items": {
- "type": "string",
- "enum": [
- "ADMOB_REFERENCED",
- "ASSET_FORMAT_UNSUPPORTED_DCM",
- "ASSET_INVALID",
- "CLICK_TAG_INVALID",
- "CLICK_TAG_MISSING",
- "CLICK_TAG_MORE_THAN_ONE",
- "CLICK_TAG_NON_TOP_LEVEL",
- "COMPONENT_UNSUPPORTED_DCM",
- "ENABLER_UNSUPPORTED_METHOD_DCM",
- "EXTERNAL_FILE_REFERENCED",
- "FILE_DETAIL_EMPTY",
- "FILE_TYPE_INVALID",
- "GWD_PROPERTIES_INVALID",
- "HTML5_FEATURE_UNSUPPORTED",
- "LINKED_FILE_NOT_FOUND",
- "MAX_FLASH_VERSION_11",
- "MRAID_REFERENCED",
- "NOT_SSL_COMPLIANT",
- "ORPHANED_ASSET",
- "PRIMARY_HTML_MISSING",
- "ZIP_INVALID"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- }
- }
- },
- "CreativeAssignment": {
- "id": "CreativeAssignment",
- "type": "object",
- "description": "Creative Assignment.",
- "properties": {
- "active": {
- "type": "boolean",
- "description": "Whether this creative assignment is active. When true, the creative will be included in the ad's rotation."
- },
- "applyEventTags": {
- "type": "boolean",
- "description": "Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO."
- },
- "clickThroughUrl": {
- "$ref": "ClickThroughUrl",
- "description": "Click-through URL of the creative assignment."
- },
- "companionCreativeOverrides": {
- "type": "array",
- "description": "Companion creative overrides for this creative assignment. Applicable to video ads.",
- "items": {
- "$ref": "CompanionClickThroughOverride"
- }
- },
- "creativeGroupAssignments": {
- "type": "array",
- "description": "Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.",
- "items": {
- "$ref": "CreativeGroupAssignment"
- }
- },
- "creativeId": {
- "type": "string",
- "description": "ID of the creative to be assigned. This is a required field.",
- "format": "int64"
- },
- "creativeIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the creative. This is a read-only, auto-generated field."
- },
- "endTime": {
- "type": "string",
- "description": "Date and time that the assigned creative should stop serving. Must be later than the start time.",
- "format": "date-time"
- },
- "richMediaExitOverrides": {
- "type": "array",
- "description": "Rich media exit overrides for this creative assignment.\nApplicable when the creative type is any of the following: \n- RICH_MEDIA_INPAGE\n- RICH_MEDIA_INPAGE_FLOATING\n- RICH_MEDIA_IM_EXPAND\n- RICH_MEDIA_EXPANDING\n- RICH_MEDIA_INTERSTITIAL_FLOAT\n- RICH_MEDIA_MOBILE_IN_APP\n- RICH_MEDIA_MULTI_FLOATING\n- RICH_MEDIA_PEEL_DOWN\n- ADVANCED_BANNER\n- VPAID_LINEAR\n- VPAID_NON_LINEAR",
- "items": {
- "$ref": "RichMediaExitOverride"
- }
- },
- "sequence": {
- "type": "integer",
- "description": "Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.",
- "format": "int32"
- },
- "sslCompliant": {
- "type": "boolean",
- "description": "Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated."
- },
- "startTime": {
- "type": "string",
- "description": "Date and time that the assigned creative should start serving.",
- "format": "date-time"
- },
- "weight": {
- "type": "integer",
- "description": "Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.",
- "format": "int32"
- }
- }
- },
- "CreativeCustomEvent": {
- "id": "CreativeCustomEvent",
- "type": "object",
- "description": "Creative Custom Event.",
- "properties": {
- "active": {
- "type": "boolean",
- "description": "Whether the event is active."
- },
- "advertiserCustomEventName": {
- "type": "string",
- "description": "User-entered name for the event."
- },
- "advertiserCustomEventType": {
- "type": "string",
- "description": "Type of the event. This is a read-only field.",
- "enum": [
- "ADVERTISER_EVENT_COUNTER",
- "ADVERTISER_EVENT_EXIT",
- "ADVERTISER_EVENT_TIMER"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "artworkLabel": {
- "type": "string",
- "description": "Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion."
- },
- "artworkType": {
- "type": "string",
- "description": "Artwork type used by the creative.This is a read-only field.",
- "enum": [
- "ARTWORK_TYPE_FLASH",
- "ARTWORK_TYPE_HTML5",
- "ARTWORK_TYPE_MIXED"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "exitUrl": {
- "type": "string",
- "description": "Exit URL of the event. This field is used only for exit events."
- },
- "id": {
- "type": "string",
- "description": "ID of this event. This is a required field and should not be modified after insertion.",
- "format": "int64"
- },
- "popupWindowProperties": {
- "$ref": "PopupWindowProperties",
- "description": "Properties for rich media popup windows. This field is used only for exit events."
- },
- "targetType": {
- "type": "string",
- "description": "Target type used by the event.",
- "enum": [
- "TARGET_BLANK",
- "TARGET_PARENT",
- "TARGET_POPUP",
- "TARGET_SELF",
- "TARGET_TOP"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "videoReportingId": {
- "type": "string",
- "description": "Reporting ID, used to differentiate multiple videos in a single creative."
- }
- }
- },
- "CreativeField": {
- "id": "CreativeField",
- "type": "object",
- "description": "Contains properties of a creative field.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this creative field. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this creative field. This is a required field on insertion.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "id": {
- "type": "string",
- "description": "ID of this creative field. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeField\".",
- "default": "dfareporting#creativeField"
- },
- "name": {
- "type": "string",
- "description": "Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this creative field. This is a read-only field that can be left blank.",
- "format": "int64"
- }
- }
- },
- "CreativeFieldAssignment": {
- "id": "CreativeFieldAssignment",
- "type": "object",
- "description": "Creative Field Assignment.",
- "properties": {
- "creativeFieldId": {
- "type": "string",
- "description": "ID of the creative field.",
- "format": "int64"
- },
- "creativeFieldValueId": {
- "type": "string",
- "description": "ID of the creative field value.",
- "format": "int64"
- }
- }
- },
- "CreativeFieldValue": {
- "id": "CreativeFieldValue",
- "type": "object",
- "description": "Contains properties of a creative field value.",
- "properties": {
- "id": {
- "type": "string",
- "description": "ID of this creative field value. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldValue\".",
- "default": "dfareporting#creativeFieldValue"
- },
- "value": {
- "type": "string",
- "description": "Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field."
- }
- }
- },
- "CreativeFieldValuesListResponse": {
- "id": "CreativeFieldValuesListResponse",
- "type": "object",
- "description": "Creative Field Value List Response",
- "properties": {
- "creativeFieldValues": {
- "type": "array",
- "description": "Creative field value collection.",
- "items": {
- "$ref": "CreativeFieldValue"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldValuesListResponse\".",
- "default": "dfareporting#creativeFieldValuesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "CreativeFieldsListResponse": {
- "id": "CreativeFieldsListResponse",
- "type": "object",
- "description": "Creative Field List Response",
- "properties": {
- "creativeFields": {
- "type": "array",
- "description": "Creative field collection.",
- "items": {
- "$ref": "CreativeField"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldsListResponse\".",
- "default": "dfareporting#creativeFieldsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "CreativeGroup": {
- "id": "CreativeGroup",
- "type": "object",
- "description": "Contains properties of a creative group.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this creative group. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this creative group. This is a required field on insertion.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "groupNumber": {
- "type": "integer",
- "description": "Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.\nAcceptable values are: \n- 1\n- 2",
- "format": "int32"
- },
- "id": {
- "type": "string",
- "description": "ID of this creative group. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeGroup\".",
- "default": "dfareporting#creativeGroup"
- },
- "name": {
- "type": "string",
- "description": "Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this creative group. This is a read-only field that can be left blank.",
- "format": "int64"
- }
- }
- },
- "CreativeGroupAssignment": {
- "id": "CreativeGroupAssignment",
- "type": "object",
- "description": "Creative Group Assignment.",
- "properties": {
- "creativeGroupId": {
- "type": "string",
- "description": "ID of the creative group to be assigned.",
- "format": "int64"
- },
- "creativeGroupNumber": {
- "type": "string",
- "description": "Creative group number of the creative group assignment.",
- "enum": [
- "CREATIVE_GROUP_ONE",
- "CREATIVE_GROUP_TWO"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- }
- }
- },
- "CreativeGroupsListResponse": {
- "id": "CreativeGroupsListResponse",
- "type": "object",
- "description": "Creative Group List Response",
- "properties": {
- "creativeGroups": {
- "type": "array",
- "description": "Creative group collection.",
- "items": {
- "$ref": "CreativeGroup"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeGroupsListResponse\".",
- "default": "dfareporting#creativeGroupsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "CreativeOptimizationConfiguration": {
- "id": "CreativeOptimizationConfiguration",
- "type": "object",
- "description": "Creative optimization settings.",
- "properties": {
- "id": {
- "type": "string",
- "description": "ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "Name of this creative optimization config. This is a required field and must be less than 129 characters long."
- },
- "optimizationActivitys": {
- "type": "array",
- "description": "List of optimization activities associated with this configuration.",
- "items": {
- "$ref": "OptimizationActivity"
- }
- },
- "optimizationModel": {
- "type": "string",
- "description": "Optimization model for this configuration.",
- "enum": [
- "CLICK",
- "POST_CLICK",
- "POST_CLICK_AND_IMPRESSION",
- "POST_IMPRESSION"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- }
- }
- },
- "CreativeRotation": {
- "id": "CreativeRotation",
- "type": "object",
- "description": "Creative Rotation.",
- "properties": {
- "creativeAssignments": {
- "type": "array",
- "description": "Creative assignments in this creative rotation.",
- "items": {
- "$ref": "CreativeAssignment"
- }
- },
- "creativeOptimizationConfigurationId": {
- "type": "string",
- "description": "Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.",
- "format": "int64"
- },
- "type": {
- "type": "string",
- "description": "Type of creative rotation. Can be used to specify whether to use sequential or random rotation.",
- "enum": [
- "CREATIVE_ROTATION_TYPE_RANDOM",
- "CREATIVE_ROTATION_TYPE_SEQUENTIAL"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "weightCalculationStrategy": {
- "type": "string",
- "description": "Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.",
- "enum": [
- "WEIGHT_STRATEGY_CUSTOM",
- "WEIGHT_STRATEGY_EQUAL",
- "WEIGHT_STRATEGY_HIGHEST_CTR",
- "WEIGHT_STRATEGY_OPTIMIZED"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- }
- }
- },
- "CreativeSettings": {
- "id": "CreativeSettings",
- "type": "object",
- "description": "Creative Settings",
- "properties": {
- "iFrameFooter": {
- "type": "string",
- "description": "Header text for iFrames for this site. Must be less than or equal to 2000 characters long."
- },
- "iFrameHeader": {
- "type": "string",
- "description": "Header text for iFrames for this site. Must be less than or equal to 2000 characters long."
- }
- }
- },
- "CreativesListResponse": {
- "id": "CreativesListResponse",
- "type": "object",
- "description": "Creative List Response",
- "properties": {
- "creatives": {
- "type": "array",
- "description": "Creative collection.",
- "items": {
- "$ref": "Creative"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativesListResponse\".",
- "default": "dfareporting#creativesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "CrossDimensionReachReportCompatibleFields": {
- "id": "CrossDimensionReachReportCompatibleFields",
- "type": "object",
- "description": "Represents fields that are compatible to be selected for a report of type \"CROSS_DIMENSION_REACH\".",
- "properties": {
- "breakdown": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"breakdown\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "dimensionFilters": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields.",
- "default": "dfareporting#crossDimensionReachReportCompatibleFields"
- },
- "metrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- },
- "overlapMetrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected in the \"overlapMetricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- }
- }
- },
- "CustomRichMediaEvents": {
- "id": "CustomRichMediaEvents",
- "type": "object",
- "description": "Represents a Custom Rich Media Events group.",
- "properties": {
- "filteredEventIds": {
- "type": "array",
- "description": "List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#customRichMediaEvents.",
- "default": "dfareporting#customRichMediaEvents"
- }
- }
- },
- "DateRange": {
- "id": "DateRange",
- "type": "object",
- "description": "Represents a date range.",
- "properties": {
- "endDate": {
- "type": "string",
- "description": "The end date of the date range, inclusive. A string of the format: \"yyyy-MM-dd\".",
- "format": "date"
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#dateRange.",
- "default": "dfareporting#dateRange"
- },
- "relativeDateRange": {
- "type": "string",
- "description": "The date range relative to the date of when the report is run.",
- "enum": [
- "LAST_24_MONTHS",
- "LAST_30_DAYS",
- "LAST_365_DAYS",
- "LAST_7_DAYS",
- "LAST_90_DAYS",
- "MONTH_TO_DATE",
- "PREVIOUS_MONTH",
- "PREVIOUS_QUARTER",
- "PREVIOUS_WEEK",
- "PREVIOUS_YEAR",
- "QUARTER_TO_DATE",
- "TODAY",
- "WEEK_TO_DATE",
- "YEAR_TO_DATE",
- "YESTERDAY"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "startDate": {
- "type": "string",
- "description": "The start date of the date range, inclusive. A string of the format: \"yyyy-MM-dd\".",
- "format": "date"
- }
- }
- },
- "DayPartTargeting": {
- "id": "DayPartTargeting",
- "type": "object",
- "description": "Day Part Targeting.",
- "properties": {
- "daysOfWeek": {
- "type": "array",
- "description": "Days of the week when the ad will serve.\n\nAcceptable values are:\n- \"SUNDAY\"\n- \"MONDAY\"\n- \"TUESDAY\"\n- \"WEDNESDAY\"\n- \"THURSDAY\"\n- \"FRIDAY\"\n- \"SATURDAY\"",
- "items": {
- "type": "string",
- "enum": [
- "FRIDAY",
- "MONDAY",
- "SATURDAY",
- "SUNDAY",
- "THURSDAY",
- "TUESDAY",
- "WEDNESDAY"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- },
- "hoursOfDay": {
- "type": "array",
- "description": "Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "userLocalTime": {
- "type": "boolean",
- "description": "Whether or not to use the user's local time. If false, the America/New York time zone applies."
- }
- }
- },
- "DefaultClickThroughEventTagProperties": {
- "id": "DefaultClickThroughEventTagProperties",
- "type": "object",
- "description": "Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further.",
- "properties": {
- "defaultClickThroughEventTagId": {
- "type": "string",
- "description": "ID of the click-through event tag to apply to all ads in this entity's scope.",
- "format": "int64"
- },
- "overrideInheritedEventTag": {
- "type": "boolean",
- "description": "Whether this entity should override the inherited default click-through event tag with its own defined value."
- }
- }
- },
- "DeliverySchedule": {
- "id": "DeliverySchedule",
- "type": "object",
- "description": "Delivery Schedule.",
- "properties": {
- "frequencyCap": {
- "$ref": "FrequencyCap",
- "description": "Limit on the number of times an individual user can be served the ad within a specified period of time."
- },
- "hardCutoff": {
- "type": "boolean",
- "description": "Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals."
- },
- "impressionRatio": {
- "type": "string",
- "description": "Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.",
- "format": "int64"
- },
- "priority": {
- "type": "string",
- "description": "Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.",
- "enum": [
- "AD_PRIORITY_01",
- "AD_PRIORITY_02",
- "AD_PRIORITY_03",
- "AD_PRIORITY_04",
- "AD_PRIORITY_05",
- "AD_PRIORITY_06",
- "AD_PRIORITY_07",
- "AD_PRIORITY_08",
- "AD_PRIORITY_09",
- "AD_PRIORITY_10",
- "AD_PRIORITY_11",
- "AD_PRIORITY_12",
- "AD_PRIORITY_13",
- "AD_PRIORITY_14",
- "AD_PRIORITY_15",
- "AD_PRIORITY_16"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- }
- },
- "DfpSettings": {
- "id": "DfpSettings",
- "type": "object",
- "description": "DFP Settings",
- "properties": {
- "dfp_network_code": {
- "type": "string",
- "description": "DFP network code for this directory site."
- },
- "dfp_network_name": {
- "type": "string",
- "description": "DFP network name for this directory site."
- },
- "programmaticPlacementAccepted": {
- "type": "boolean",
- "description": "Whether this directory site accepts programmatic placements."
- },
- "pubPaidPlacementAccepted": {
- "type": "boolean",
- "description": "Whether this directory site accepts publisher-paid tags."
- },
- "publisherPortalOnly": {
- "type": "boolean",
- "description": "Whether this directory site is available only via DoubleClick Publisher Portal."
- }
- }
- },
- "Dimension": {
- "id": "Dimension",
- "type": "object",
- "description": "Represents a dimension.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#dimension.",
- "default": "dfareporting#dimension"
- },
- "name": {
- "type": "string",
- "description": "The dimension name, e.g. dfa:advertiser"
- }
- }
- },
- "DimensionFilter": {
- "id": "DimensionFilter",
- "type": "object",
- "description": "Represents a dimension filter.",
- "properties": {
- "dimensionName": {
- "type": "string",
- "description": "The name of the dimension to filter."
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#dimensionFilter.",
- "default": "dfareporting#dimensionFilter"
- },
- "value": {
- "type": "string",
- "description": "The value of the dimension to filter."
- }
- }
- },
- "DimensionValue": {
- "id": "DimensionValue",
- "type": "object",
- "description": "Represents a DimensionValue resource.",
- "properties": {
- "dimensionName": {
- "type": "string",
- "description": "The name of the dimension."
- },
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "id": {
- "type": "string",
- "description": "The ID associated with the value if available."
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#dimensionValue.",
- "default": "dfareporting#dimensionValue"
- },
- "matchType": {
- "type": "string",
- "description": "Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.",
- "enum": [
- "BEGINS_WITH",
- "CONTAINS",
- "EXACT",
- "WILDCARD_EXPRESSION"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- },
- "value": {
- "type": "string",
- "description": "The value of the dimension."
- }
- }
- },
- "DimensionValueList": {
- "id": "DimensionValueList",
- "type": "object",
- "description": "Represents the list of DimensionValue resources.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The dimension values returned in this response.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of list this is, in this case dfareporting#dimensionValueList.",
- "default": "dfareporting#dimensionValueList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted."
- }
- }
- },
- "DimensionValueRequest": {
- "id": "DimensionValueRequest",
- "type": "object",
- "description": "Represents a DimensionValuesRequest.",
- "properties": {
- "dimensionName": {
- "type": "string",
- "description": "The name of the dimension for which values should be requested.",
- "annotations": {
- "required": [
- "dfareporting.dimensionValues.query"
- ]
- }
- },
- "endDate": {
- "type": "string",
- "description": "The end date of the date range for which to retrieve dimension values. A string of the format \"yyyy-MM-dd\".",
- "format": "date",
- "annotations": {
- "required": [
- "dfareporting.dimensionValues.query"
- ]
- }
- },
- "filters": {
- "type": "array",
- "description": "The list of filters by which to filter values. The filters are ANDed.",
- "items": {
- "$ref": "DimensionFilter"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of request this is, in this case dfareporting#dimensionValueRequest.",
- "default": "dfareporting#dimensionValueRequest"
- },
- "startDate": {
- "type": "string",
- "description": "The start date of the date range for which to retrieve dimension values. A string of the format \"yyyy-MM-dd\".",
- "format": "date",
- "annotations": {
- "required": [
- "dfareporting.dimensionValues.query"
- ]
- }
- }
- }
- },
- "DirectorySite": {
- "id": "DirectorySite",
- "type": "object",
- "description": "DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.",
- "properties": {
- "active": {
- "type": "boolean",
- "description": "Whether this directory site is active."
- },
- "contactAssignments": {
- "type": "array",
- "description": "Directory site contacts.",
- "items": {
- "$ref": "DirectorySiteContactAssignment"
- }
- },
- "countryId": {
- "type": "string",
- "description": "Country ID of this directory site.",
- "format": "int64"
- },
- "currencyId": {
- "type": "string",
- "description": "Currency ID of this directory site.\nPossible values are: \n- \"1\" for USD \n- \"2\" for GBP \n- \"3\" for ESP \n- \"4\" for SEK \n- \"5\" for CAD \n- \"6\" for JPY \n- \"7\" for DEM \n- \"8\" for AUD \n- \"9\" for FRF \n- \"10\" for ITL \n- \"11\" for DKK \n- \"12\" for NOK \n- \"13\" for FIM \n- \"14\" for ZAR \n- \"15\" for IEP \n- \"16\" for NLG \n- \"17\" for EUR \n- \"18\" for KRW \n- \"19\" for TWD \n- \"20\" for SGD \n- \"21\" for CNY \n- \"22\" for HKD \n- \"23\" for NZD \n- \"24\" for MYR \n- \"25\" for BRL \n- \"26\" for PTE \n- \"27\" for MXP \n- \"28\" for CLP \n- \"29\" for TRY \n- \"30\" for ARS \n- \"31\" for PEN \n- \"32\" for ILS \n- \"33\" for CHF \n- \"34\" for VEF \n- \"35\" for COP \n- \"36\" for GTQ",
- "format": "int64"
- },
- "description": {
- "type": "string",
- "description": "Description of this directory site."
- },
- "id": {
- "type": "string",
- "description": "ID of this directory site. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this directory site. This is a read-only, auto-generated field."
- },
- "inpageTagFormats": {
- "type": "array",
- "description": "Tag types for regular placements.\n\nAcceptable values are:\n- \"STANDARD\"\n- \"IFRAME_JAVASCRIPT_INPAGE\"\n- \"INTERNAL_REDIRECT_INPAGE\"\n- \"JAVASCRIPT_INPAGE\"",
- "items": {
- "type": "string",
- "enum": [
- "IFRAME_JAVASCRIPT_INPAGE",
- "INTERNAL_REDIRECT_INPAGE",
- "JAVASCRIPT_INPAGE",
- "STANDARD"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- }
- },
- "interstitialTagFormats": {
- "type": "array",
- "description": "Tag types for interstitial placements.\n\nAcceptable values are:\n- \"IFRAME_JAVASCRIPT_INTERSTITIAL\"\n- \"INTERNAL_REDIRECT_INTERSTITIAL\"\n- \"JAVASCRIPT_INTERSTITIAL\"",
- "items": {
- "type": "string",
- "enum": [
- "IFRAME_JAVASCRIPT_INTERSTITIAL",
- "INTERNAL_REDIRECT_INTERSTITIAL",
- "JAVASCRIPT_INTERSTITIAL"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySite\".",
- "default": "dfareporting#directorySite"
- },
- "name": {
- "type": "string",
- "description": "Name of this directory site."
- },
- "parentId": {
- "type": "string",
- "description": "Parent directory site ID.",
- "format": "int64"
- },
- "settings": {
- "$ref": "DirectorySiteSettings",
- "description": "Directory site settings."
- },
- "url": {
- "type": "string",
- "description": "URL of this directory site."
- }
- }
- },
- "DirectorySiteContact": {
- "id": "DirectorySiteContact",
- "type": "object",
- "description": "Contains properties of a Site Directory contact.",
- "properties": {
- "email": {
- "type": "string",
- "description": "Email address of this directory site contact."
- },
- "firstName": {
- "type": "string",
- "description": "First name of this directory site contact."
- },
- "id": {
- "type": "string",
- "description": "ID of this directory site contact. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySiteContact\".",
- "default": "dfareporting#directorySiteContact"
- },
- "lastName": {
- "type": "string",
- "description": "Last name of this directory site contact."
- },
- "role": {
- "type": "string",
- "description": "Directory site contact role.",
- "enum": [
- "ADMIN",
- "EDIT",
- "VIEW"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "type": {
- "type": "string",
- "description": "Directory site contact type.",
- "enum": [
- "BILLING",
- "OTHER",
- "SALES",
- "TECHNICAL"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- }
- }
- },
- "DirectorySiteContactAssignment": {
- "id": "DirectorySiteContactAssignment",
- "type": "object",
- "description": "Directory Site Contact Assignment",
- "properties": {
- "contactId": {
- "type": "string",
- "description": "ID of this directory site contact. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "visibility": {
- "type": "string",
- "description": "Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.",
- "enum": [
- "PRIVATE",
- "PUBLIC"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- }
- }
- },
- "DirectorySiteContactsListResponse": {
- "id": "DirectorySiteContactsListResponse",
- "type": "object",
- "description": "Directory Site Contact List Response",
- "properties": {
- "directorySiteContacts": {
- "type": "array",
- "description": "Directory site contact collection",
- "items": {
- "$ref": "DirectorySiteContact"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySiteContactsListResponse\".",
- "default": "dfareporting#directorySiteContactsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "DirectorySiteSettings": {
- "id": "DirectorySiteSettings",
- "type": "object",
- "description": "Directory Site Settings",
- "properties": {
- "activeViewOptOut": {
- "type": "boolean",
- "description": "Whether this directory site has disabled active view creatives."
- },
- "dfp_settings": {
- "$ref": "DfpSettings",
- "description": "Directory site DFP settings."
- },
- "instream_video_placement_accepted": {
- "type": "boolean",
- "description": "Whether this site accepts in-stream video ads."
- },
- "interstitialPlacementAccepted": {
- "type": "boolean",
- "description": "Whether this site accepts interstitial ads."
- },
- "nielsenOcrOptOut": {
- "type": "boolean",
- "description": "Whether this directory site has disabled Nielsen OCR reach ratings."
- },
- "verificationTagOptOut": {
- "type": "boolean",
- "description": "Whether this directory site has disabled generation of Verification ins tags."
- },
- "videoActiveViewOptOut": {
- "type": "boolean",
- "description": "Whether this directory site has disabled active view for in-stream video creatives."
- }
- }
- },
- "DirectorySitesListResponse": {
- "id": "DirectorySitesListResponse",
- "type": "object",
- "description": "Directory Site List Response",
- "properties": {
- "directorySites": {
- "type": "array",
- "description": "Directory site collection.",
- "items": {
- "$ref": "DirectorySite"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySitesListResponse\".",
- "default": "dfareporting#directorySitesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "EventTag": {
- "id": "EventTag",
- "type": "object",
- "description": "Contains properties of an event tag.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this event tag. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this event tag. This field or the campaignId field is required on insertion.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "campaignId": {
- "type": "string",
- "description": "Campaign ID of this event tag. This field or the advertiserId field is required on insertion.",
- "format": "int64"
- },
- "campaignIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
- },
- "enabledByDefault": {
- "type": "boolean",
- "description": "Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads."
- },
- "id": {
- "type": "string",
- "description": "ID of this event tag. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#eventTag\".",
- "default": "dfareporting#eventTag"
- },
- "name": {
- "type": "string",
- "description": "Name of this event tag. This is a required field and must be less than 256 characters long."
- },
- "siteFilterType": {
- "type": "string",
- "description": "Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.",
- "enum": [
- "BLACKLIST",
- "WHITELIST"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "siteIds": {
- "type": "array",
- "description": "Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "sslCompliant": {
- "type": "boolean",
- "description": "Whether this tag is SSL-compliant or not. This is a read-only field."
- },
- "status": {
- "type": "string",
- "description": "Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.",
- "enum": [
- "DISABLED",
- "ENABLED"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this event tag. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "type": {
- "type": "string",
- "description": "Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.",
- "enum": [
- "CLICK_THROUGH_EVENT_TAG",
- "IMPRESSION_IMAGE_EVENT_TAG",
- "IMPRESSION_JAVASCRIPT_EVENT_TAG"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "url": {
- "type": "string",
- "description": "Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion."
- },
- "urlEscapeLevels": {
- "type": "integer",
- "description": "Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.",
- "format": "int32"
- }
- }
- },
- "EventTagOverride": {
- "id": "EventTagOverride",
- "type": "object",
- "description": "Event tag override information.",
- "properties": {
- "enabled": {
- "type": "boolean",
- "description": "Whether this override is enabled."
- },
- "id": {
- "type": "string",
- "description": "ID of this event tag override. This is a read-only, auto-generated field.",
- "format": "int64"
- }
- }
- },
- "EventTagsListResponse": {
- "id": "EventTagsListResponse",
- "type": "object",
- "description": "Event Tag List Response",
- "properties": {
- "eventTags": {
- "type": "array",
- "description": "Event tag collection.",
- "items": {
- "$ref": "EventTag"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#eventTagsListResponse\".",
- "default": "dfareporting#eventTagsListResponse"
- }
- }
- },
- "File": {
- "id": "File",
- "type": "object",
- "description": "Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is \"REPORT_AVAILABLE\".",
- "properties": {
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range for which the file has report data. The date range will always be the absolute date range for which the report is run."
- },
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "fileName": {
- "type": "string",
- "description": "The filename of the file."
- },
- "format": {
- "type": "string",
- "description": "The output format of the report. Only available once the file is available.",
- "enum": [
- "CSV",
- "EXCEL"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "id": {
- "type": "string",
- "description": "The unique ID of this report file.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#file.",
- "default": "dfareporting#file"
- },
- "lastModifiedTime": {
- "type": "string",
- "description": "The timestamp in milliseconds since epoch when this file was last modified.",
- "format": "int64"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report this file was generated from.",
- "format": "int64"
- },
- "status": {
- "type": "string",
- "description": "The status of the report file.",
- "enum": [
- "CANCELLED",
- "FAILED",
- "PROCESSING",
- "REPORT_AVAILABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- },
- "urls": {
- "type": "object",
- "description": "The URLs where the completed report file can be downloaded.",
- "properties": {
- "apiUrl": {
- "type": "string",
- "description": "The URL for downloading the report data through the API."
- },
- "browserUrl": {
- "type": "string",
- "description": "The URL for downloading the report data through a browser."
- }
- }
- }
- }
- },
- "FileList": {
- "id": "FileList",
- "type": "object",
- "description": "Represents the list of File resources.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The files returned in this response.",
- "items": {
- "$ref": "File"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of list this is, in this case dfareporting#fileList.",
- "default": "dfareporting#fileList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through files. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted."
- }
- }
- },
- "FloodlightActivitiesGenerateTagResponse": {
- "id": "FloodlightActivitiesGenerateTagResponse",
- "type": "object",
- "description": "Floodlight Activity GenerateTag Response",
- "properties": {
- "floodlightActivityTag": {
- "type": "string",
- "description": "Generated tag for this floodlight activity."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivitiesGenerateTagResponse\".",
- "default": "dfareporting#floodlightActivitiesGenerateTagResponse"
- }
- }
- },
- "FloodlightActivitiesListResponse": {
- "id": "FloodlightActivitiesListResponse",
- "type": "object",
- "description": "Floodlight Activity List Response",
- "properties": {
- "floodlightActivities": {
- "type": "array",
- "description": "Floodlight activity collection.",
- "items": {
- "$ref": "FloodlightActivity"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivitiesListResponse\".",
- "default": "dfareporting#floodlightActivitiesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "FloodlightActivity": {
- "id": "FloodlightActivity",
- "type": "object",
- "description": "Contains properties of a Floodlight activity.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this floodlight activity. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "cacheBustingType": {
- "type": "string",
- "description": "Code type used for cache busting in the generated tag.",
- "enum": [
- "ACTIVE_SERVER_PAGE",
- "COLD_FUSION",
- "JAVASCRIPT",
- "JSP",
- "PHP"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "countingMethod": {
- "type": "string",
- "description": "Counting method for conversions for this floodlight activity. This is a required field.",
- "enum": [
- "ITEMS_SOLD_COUNTING",
- "SESSION_COUNTING",
- "STANDARD_COUNTING",
- "TRANSACTIONS_COUNTING",
- "UNIQUE_COUNTING"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "defaultTags": {
- "type": "array",
- "description": "Dynamic floodlight tags.",
- "items": {
- "$ref": "FloodlightActivityDynamicTag"
- }
- },
- "expectedUrl": {
- "type": "string",
- "description": "URL where this tag will be deployed. If specified, must be less than 256 characters long."
- },
- "floodlightActivityGroupId": {
- "type": "string",
- "description": "Floodlight activity group ID of this floodlight activity. This is a required field.",
- "format": "int64"
- },
- "floodlightActivityGroupName": {
- "type": "string",
- "description": "Name of the associated floodlight activity group. This is a read-only field."
- },
- "floodlightActivityGroupTagString": {
- "type": "string",
- "description": "Tag string of the associated floodlight activity group. This is a read-only field."
- },
- "floodlightActivityGroupType": {
- "type": "string",
- "description": "Type of the associated floodlight activity group. This is a read-only field.",
- "enum": [
- "COUNTER",
- "SALE"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "floodlightConfigurationId": {
- "type": "string",
- "description": "Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.",
- "format": "int64"
- },
- "floodlightConfigurationIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field."
- },
- "hidden": {
- "type": "boolean",
- "description": "Whether this activity is archived."
- },
- "id": {
- "type": "string",
- "description": "ID of this floodlight activity. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field."
- },
- "imageTagEnabled": {
- "type": "boolean",
- "description": "Whether the image tag is enabled for this activity."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivity\".",
- "default": "dfareporting#floodlightActivity"
- },
- "name": {
- "type": "string",
- "description": "Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes."
- },
- "notes": {
- "type": "string",
- "description": "General notes or implementation instructions for the tag."
- },
- "publisherTags": {
- "type": "array",
- "description": "Publisher dynamic floodlight tags.",
- "items": {
- "$ref": "FloodlightActivityPublisherDynamicTag"
- }
- },
- "secure": {
- "type": "boolean",
- "description": "Whether this tag should use SSL."
- },
- "sslCompliant": {
- "type": "boolean",
- "description": "Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags."
- },
- "sslRequired": {
- "type": "boolean",
- "description": "Whether this floodlight activity must be SSL-compliant."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "tagFormat": {
- "type": "string",
- "description": "Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.",
- "enum": [
- "HTML",
- "XHTML"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "tagString": {
- "type": "string",
- "description": "Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion."
- },
- "userDefinedVariableTypes": {
- "type": "array",
- "description": "List of the user-defined variables used by this conversion tag. These map to the \"u[1-20]=\" in the tags. Each of these can have a user defined type.\nAcceptable values are:\n- \"U1\"\n- \"U2\"\n- \"U3\"\n- \"U4\"\n- \"U5\"\n- \"U6\"\n- \"U7\"\n- \"U8\"\n- \"U9\"\n- \"U10\"\n- \"U11\"\n- \"U12\"\n- \"U13\"\n- \"U14\"\n- \"U15\"\n- \"U16\"\n- \"U17\"\n- \"U18\"\n- \"U19\"\n- \"U20\"",
- "items": {
- "type": "string",
- "enum": [
- "U1",
- "U10",
- "U11",
- "U12",
- "U13",
- "U14",
- "U15",
- "U16",
- "U17",
- "U18",
- "U19",
- "U2",
- "U20",
- "U3",
- "U4",
- "U5",
- "U6",
- "U7",
- "U8",
- "U9"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- }
- }
- },
- "FloodlightActivityDynamicTag": {
- "id": "FloodlightActivityDynamicTag",
- "type": "object",
- "description": "Dynamic Tag",
- "properties": {
- "id": {
- "type": "string",
- "description": "ID of this dynamic tag. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "Name of this tag."
- },
- "tag": {
- "type": "string",
- "description": "Tag code."
- }
- }
- },
- "FloodlightActivityGroup": {
- "id": "FloodlightActivityGroup",
- "type": "object",
- "description": "Contains properties of a Floodlight activity group.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this floodlight activity group. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "floodlightConfigurationId": {
- "type": "string",
- "description": "Floodlight configuration ID of this floodlight activity group. This is a required field.",
- "format": "int64"
- },
- "floodlightConfigurationIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field."
- },
- "id": {
- "type": "string",
- "description": "ID of this floodlight activity group. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivityGroup\".",
- "default": "dfareporting#floodlightActivityGroup"
- },
- "name": {
- "type": "string",
- "description": "Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "tagString": {
- "type": "string",
- "description": "Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion."
- },
- "type": {
- "type": "string",
- "description": "Type of the floodlight activity group. This is a required field that is read-only after insertion.",
- "enum": [
- "COUNTER",
- "SALE"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- }
- }
- },
- "FloodlightActivityGroupsListResponse": {
- "id": "FloodlightActivityGroupsListResponse",
- "type": "object",
- "description": "Floodlight Activity Group List Response",
- "properties": {
- "floodlightActivityGroups": {
- "type": "array",
- "description": "Floodlight activity group collection.",
- "items": {
- "$ref": "FloodlightActivityGroup"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivityGroupsListResponse\".",
- "default": "dfareporting#floodlightActivityGroupsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "FloodlightActivityPublisherDynamicTag": {
- "id": "FloodlightActivityPublisherDynamicTag",
- "type": "object",
- "description": "Publisher Dynamic Tag",
- "properties": {
- "clickThrough": {
- "type": "boolean",
- "description": "Whether this tag is applicable only for click-throughs."
- },
- "directorySiteId": {
- "type": "string",
- "description": "Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.",
- "format": "int64"
- },
- "dynamicTag": {
- "$ref": "FloodlightActivityDynamicTag",
- "description": "Dynamic floodlight tag."
- },
- "siteId": {
- "type": "string",
- "description": "Site ID of this dynamic tag.",
- "format": "int64"
- },
- "siteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field."
- },
- "viewThrough": {
- "type": "boolean",
- "description": "Whether this tag is applicable only for view-throughs."
- }
- }
- },
- "FloodlightConfiguration": {
- "id": "FloodlightConfiguration",
- "type": "object",
- "description": "Contains properties of a Floodlight configuration.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this floodlight configuration. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of the parent advertiser of this floodlight configuration.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "analyticsDataSharingEnabled": {
- "type": "boolean",
- "description": "Whether advertiser data is shared with Google Analytics."
- },
- "exposureToConversionEnabled": {
- "type": "boolean",
- "description": "Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting."
- },
- "firstDayOfWeek": {
- "type": "string",
- "description": "Day that will be counted as the first day of the week in reports. This is a required field.",
- "enum": [
- "MONDAY",
- "SUNDAY"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "id": {
- "type": "string",
- "description": "ID of this floodlight configuration. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightConfiguration\".",
- "default": "dfareporting#floodlightConfiguration"
- },
- "lookbackConfiguration": {
- "$ref": "LookbackConfiguration",
- "description": "Lookback window settings for this floodlight configuration."
- },
- "naturalSearchConversionAttributionOption": {
- "type": "string",
- "description": "Types of attribution options for natural search conversions.",
- "enum": [
- "EXCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION",
- "INCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION",
- "INCLUDE_NATURAL_SEARCH_TIERED_CONVERSION_ATTRIBUTION"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "omnitureSettings": {
- "$ref": "OmnitureSettings",
- "description": "Settings for DCM Omniture integration."
- },
- "sslRequired": {
- "type": "boolean",
- "description": "Whether floodlight activities owned by this configuration are required to be SSL-compliant."
- },
- "standardVariableTypes": {
- "type": "array",
- "description": "List of standard variables enabled for this configuration.\n\nAcceptable values are:\n- \"ORD\"\n- \"NUM\"",
- "items": {
- "type": "string",
- "enum": [
- "NUM",
- "ORD",
- "TRAN",
- "U"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- }
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "tagSettings": {
- "$ref": "TagSettings",
- "description": "Configuration settings for dynamic and image floodlight tags."
- },
- "userDefinedVariableConfigurations": {
- "type": "array",
- "description": "List of user defined variables enabled for this configuration.",
- "items": {
- "$ref": "UserDefinedVariableConfiguration"
- }
- }
- }
- },
- "FloodlightConfigurationsListResponse": {
- "id": "FloodlightConfigurationsListResponse",
- "type": "object",
- "description": "Floodlight Configuration List Response",
- "properties": {
- "floodlightConfigurations": {
- "type": "array",
- "description": "Floodlight configuration collection.",
- "items": {
- "$ref": "FloodlightConfiguration"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightConfigurationsListResponse\".",
- "default": "dfareporting#floodlightConfigurationsListResponse"
- }
- }
- },
- "FloodlightReportCompatibleFields": {
- "id": "FloodlightReportCompatibleFields",
- "type": "object",
- "description": "Represents fields that are compatible to be selected for a report of type \"FlOODLIGHT\".",
- "properties": {
- "dimensionFilters": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields.",
- "default": "dfareporting#floodlightReportCompatibleFields"
- },
- "metrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- }
- }
- },
- "FrequencyCap": {
- "id": "FrequencyCap",
- "type": "object",
- "description": "Frequency Cap.",
- "properties": {
- "duration": {
- "type": "string",
- "description": "Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.",
- "format": "int64"
- },
- "impressions": {
- "type": "string",
- "description": "Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.",
- "format": "int64"
- }
- }
- },
- "FsCommand": {
- "id": "FsCommand",
- "type": "object",
- "description": "FsCommand.",
- "properties": {
- "left": {
- "type": "integer",
- "description": "Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.",
- "format": "int32"
- },
- "positionOption": {
- "type": "string",
- "description": "Position in the browser where the window will open.",
- "enum": [
- "CENTERED",
- "DISTANCE_FROM_TOP_LEFT_CORNER"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "top": {
- "type": "integer",
- "description": "Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.",
- "format": "int32"
- },
- "windowHeight": {
- "type": "integer",
- "description": "Height of the window.",
- "format": "int32"
- },
- "windowWidth": {
- "type": "integer",
- "description": "Width of the window.",
- "format": "int32"
- }
- }
- },
- "GeoTargeting": {
- "id": "GeoTargeting",
- "type": "object",
- "description": "Geographical Targeting.",
- "properties": {
- "cities": {
- "type": "array",
- "description": "Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.",
- "items": {
- "$ref": "City"
- }
- },
- "countries": {
- "type": "array",
- "description": "Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.",
- "items": {
- "$ref": "Country"
- }
- },
- "excludeCountries": {
- "type": "boolean",
- "description": "Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad."
- },
- "metros": {
- "type": "array",
- "description": "Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.",
- "items": {
- "$ref": "Metro"
- }
- },
- "postalCodes": {
- "type": "array",
- "description": "Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.",
- "items": {
- "$ref": "PostalCode"
- }
- },
- "regions": {
- "type": "array",
- "description": "Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.",
- "items": {
- "$ref": "Region"
- }
- }
- }
- },
- "KeyValueTargetingExpression": {
- "id": "KeyValueTargetingExpression",
- "type": "object",
- "description": "Key Value Targeting Expression.",
- "properties": {
- "expression": {
- "type": "string",
- "description": "Keyword expression being targeted by the ad."
- }
- }
- },
- "LandingPage": {
- "id": "LandingPage",
- "type": "object",
- "description": "Contains information about where a user's browser is taken after the user clicks an ad.",
- "properties": {
- "default": {
- "type": "boolean",
- "description": "Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign."
- },
- "id": {
- "type": "string",
- "description": "ID of this landing page. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#landingPage\".",
- "default": "dfareporting#landingPage"
- },
- "name": {
- "type": "string",
- "description": "Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign."
- },
- "url": {
- "type": "string",
- "description": "URL of this landing page. This is a required field."
- }
- }
- },
- "LandingPagesListResponse": {
- "id": "LandingPagesListResponse",
- "type": "object",
- "description": "Landing Page List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#landingPagesListResponse\".",
- "default": "dfareporting#landingPagesListResponse"
- },
- "landingPages": {
- "type": "array",
- "description": "Landing page collection",
- "items": {
- "$ref": "LandingPage"
- }
- }
- }
- },
- "LastModifiedInfo": {
- "id": "LastModifiedInfo",
- "type": "object",
- "description": "Modification timestamp.",
- "properties": {
- "time": {
- "type": "string",
- "description": "Timestamp of the last change in milliseconds since epoch.",
- "format": "int64"
- }
- }
- },
- "ListTargetingExpression": {
- "id": "ListTargetingExpression",
- "type": "object",
- "description": "Remarketing List Targeting Expression.",
- "properties": {
- "expression": {
- "type": "string",
- "description": "Expression describing which lists are being targeted by the ad."
- }
- }
- },
- "LookbackConfiguration": {
- "id": "LookbackConfiguration",
- "type": "object",
- "description": "Lookback configuration settings.",
- "properties": {
- "clickDuration": {
- "type": "integer",
- "description": "Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.",
- "format": "int32"
- },
- "postImpressionActivitiesDuration": {
- "type": "integer",
- "description": "Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.",
- "format": "int32"
- }
- }
- },
- "Metric": {
- "id": "Metric",
- "type": "object",
- "description": "Represents a metric.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#metric.",
- "default": "dfareporting#metric"
- },
- "name": {
- "type": "string",
- "description": "The metric name, e.g. dfa:impressions"
- }
- }
- },
- "Metro": {
- "id": "Metro",
- "type": "object",
- "description": "Contains information about a metro region that can be targeted by ads.",
- "properties": {
- "countryCode": {
- "type": "string",
- "description": "Country code of the country to which this metro region belongs."
- },
- "countryDartId": {
- "type": "string",
- "description": "DART ID of the country to which this metro region belongs.",
- "format": "int64"
- },
- "dartId": {
- "type": "string",
- "description": "DART ID of this metro region.",
- "format": "int64"
- },
- "dmaId": {
- "type": "string",
- "description": "DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#metro\".",
- "default": "dfareporting#metro"
- },
- "metroCode": {
- "type": "string",
- "description": "Metro code of this metro region. This is equivalent to dma_id."
- },
- "name": {
- "type": "string",
- "description": "Name of this metro region."
- }
- }
- },
- "MetrosListResponse": {
- "id": "MetrosListResponse",
- "type": "object",
- "description": "Metro List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#metrosListResponse\".",
- "default": "dfareporting#metrosListResponse"
- },
- "metros": {
- "type": "array",
- "description": "Metro collection.",
- "items": {
- "$ref": "Metro"
- }
- }
- }
- },
- "MobileCarrier": {
- "id": "MobileCarrier",
- "type": "object",
- "description": "Contains information about a mobile carrier that can be targeted by ads.",
- "properties": {
- "countryCode": {
- "type": "string",
- "description": "Country code of the country to which this mobile carrier belongs."
- },
- "countryDartId": {
- "type": "string",
- "description": "DART ID of the country to which this mobile carrier belongs.",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "ID of this mobile carrier.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileCarrier\".",
- "default": "dfareporting#mobileCarrier"
- },
- "name": {
- "type": "string",
- "description": "Name of this mobile carrier."
- }
- }
- },
- "MobileCarriersListResponse": {
- "id": "MobileCarriersListResponse",
- "type": "object",
- "description": "Mobile Carrier List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileCarriersListResponse\".",
- "default": "dfareporting#mobileCarriersListResponse"
- },
- "mobileCarriers": {
- "type": "array",
- "description": "Mobile carrier collection.",
- "items": {
- "$ref": "MobileCarrier"
- }
- }
- }
- },
- "ObjectFilter": {
- "id": "ObjectFilter",
- "type": "object",
- "description": "Object Filter.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#objectFilter\".",
- "default": "dfareporting#objectFilter"
- },
- "objectIds": {
- "type": "array",
- "description": "Applicable when status is ASSIGNED. The user has access to objects with these object IDs.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "status": {
- "type": "string",
- "description": "Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.",
- "enum": [
- "ALL",
- "ASSIGNED",
- "NONE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- }
- }
- },
- "OffsetPosition": {
- "id": "OffsetPosition",
- "type": "object",
- "description": "Offset Position.",
- "properties": {
- "left": {
- "type": "integer",
- "description": "Offset distance from left side of an asset or a window.",
- "format": "int32"
- },
- "top": {
- "type": "integer",
- "description": "Offset distance from top side of an asset or a window.",
- "format": "int32"
- }
- }
- },
- "OmnitureSettings": {
- "id": "OmnitureSettings",
- "type": "object",
- "description": "Omniture Integration Settings.",
- "properties": {
- "omnitureCostDataEnabled": {
- "type": "boolean",
- "description": "Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true."
- },
- "omnitureIntegrationEnabled": {
- "type": "boolean",
- "description": "Whether Omniture integration is enabled. This property can be enabled only when the \"Advanced Ad Serving\" account setting is enabled."
- }
- }
- },
- "OperatingSystem": {
- "id": "OperatingSystem",
- "type": "object",
- "description": "Contains information about an operating system that can be targeted by ads.",
- "properties": {
- "dartId": {
- "type": "string",
- "description": "DART ID of this operating system. This is the ID used for targeting.",
- "format": "int64"
- },
- "desktop": {
- "type": "boolean",
- "description": "Whether this operating system is for desktop."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystem\".",
- "default": "dfareporting#operatingSystem"
- },
- "mobile": {
- "type": "boolean",
- "description": "Whether this operating system is for mobile."
- },
- "name": {
- "type": "string",
- "description": "Name of this operating system."
- }
- }
- },
- "OperatingSystemVersion": {
- "id": "OperatingSystemVersion",
- "type": "object",
- "description": "Contains information about a particular version of an operating system that can be targeted by ads.",
- "properties": {
- "id": {
- "type": "string",
- "description": "ID of this operating system version.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemVersion\".",
- "default": "dfareporting#operatingSystemVersion"
- },
- "majorVersion": {
- "type": "string",
- "description": "Major version (leftmost number) of this operating system version."
- },
- "minorVersion": {
- "type": "string",
- "description": "Minor version (number after the first dot) of this operating system version."
- },
- "name": {
- "type": "string",
- "description": "Name of this operating system version."
- },
- "operatingSystem": {
- "$ref": "OperatingSystem",
- "description": "Operating system of this operating system version."
- }
- }
- },
- "OperatingSystemVersionsListResponse": {
- "id": "OperatingSystemVersionsListResponse",
- "type": "object",
- "description": "Operating System Version List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemVersionsListResponse\".",
- "default": "dfareporting#operatingSystemVersionsListResponse"
- },
- "operatingSystemVersions": {
- "type": "array",
- "description": "Operating system version collection.",
- "items": {
- "$ref": "OperatingSystemVersion"
- }
- }
- }
- },
- "OperatingSystemsListResponse": {
- "id": "OperatingSystemsListResponse",
- "type": "object",
- "description": "Operating System List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemsListResponse\".",
- "default": "dfareporting#operatingSystemsListResponse"
- },
- "operatingSystems": {
- "type": "array",
- "description": "Operating system collection.",
- "items": {
- "$ref": "OperatingSystem"
- }
- }
- }
- },
- "OptimizationActivity": {
- "id": "OptimizationActivity",
- "type": "object",
- "description": "Creative optimization activity.",
- "properties": {
- "floodlightActivityId": {
- "type": "string",
- "description": "Floodlight activity ID of this optimization activity. This is a required field.",
- "format": "int64"
- },
- "floodlightActivityIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field."
- },
- "weight": {
- "type": "integer",
- "description": "Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.",
- "format": "int32"
- }
- }
- },
- "PathToConversionReportCompatibleFields": {
- "id": "PathToConversionReportCompatibleFields",
- "type": "object",
- "description": "Represents fields that are compatible to be selected for a report of type \"PATH_TO_CONVERSION\".",
- "properties": {
- "conversionDimensions": {
- "type": "array",
- "description": "Conversion dimensions which are compatible to be selected in the \"conversionDimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "customFloodlightVariables": {
- "type": "array",
- "description": "Custom floodlight variables which are compatible to be selected in the \"customFloodlightVariables\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields.",
- "default": "dfareporting#pathToConversionReportCompatibleFields"
- },
- "metrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- },
- "perInteractionDimensions": {
- "type": "array",
- "description": "Per-interaction dimensions which are compatible to be selected in the \"perInteractionDimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- }
- }
- },
- "Placement": {
- "id": "Placement",
- "type": "object",
- "description": "Contains properties of a placement.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this placement. This field can be left blank.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this placement. This field can be left blank.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "archived": {
- "type": "boolean",
- "description": "Whether this placement is archived."
- },
- "campaignId": {
- "type": "string",
- "description": "Campaign ID of this placement. This field is a required field on insertion.",
- "format": "int64"
- },
- "campaignIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
- },
- "comment": {
- "type": "string",
- "description": "Comments for this placement."
- },
- "compatibility": {
- "type": "string",
- "description": "Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.",
- "enum": [
- "APP",
- "APP_INTERSTITIAL",
- "IN_STREAM_VIDEO",
- "WEB",
- "WEB_INTERSTITIAL"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "contentCategoryId": {
- "type": "string",
- "description": "ID of the content category assigned to this placement.",
- "format": "int64"
- },
- "createInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the creation of this placement. This is a read-only field."
- },
- "directorySiteId": {
- "type": "string",
- "description": "Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.",
- "format": "int64"
- },
- "directorySiteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field."
- },
- "externalId": {
- "type": "string",
- "description": "External ID for this placement."
- },
- "id": {
- "type": "string",
- "description": "ID of this placement. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this placement. This is a read-only, auto-generated field."
- },
- "keyName": {
- "type": "string",
- "description": "Key name of this placement. This is a read-only, auto-generated field."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placement\".",
- "default": "dfareporting#placement"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this placement. This is a read-only field."
- },
- "lookbackConfiguration": {
- "$ref": "LookbackConfiguration",
- "description": "Lookback window settings for this placement."
- },
- "name": {
- "type": "string",
- "description": "Name of this placement.This is a required field and must be less than 256 characters long."
- },
- "paymentApproved": {
- "type": "boolean",
- "description": "Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements."
- },
- "paymentSource": {
- "type": "string",
- "description": "Payment source for this placement. This is a required field that is read-only after insertion.",
- "enum": [
- "PLACEMENT_AGENCY_PAID",
- "PLACEMENT_PUBLISHER_PAID"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "placementGroupId": {
- "type": "string",
- "description": "ID of this placement's group, if applicable.",
- "format": "int64"
- },
- "placementGroupIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the placement group. This is a read-only, auto-generated field."
- },
- "placementStrategyId": {
- "type": "string",
- "description": "ID of the placement strategy assigned to this placement.",
- "format": "int64"
- },
- "pricingSchedule": {
- "$ref": "PricingSchedule",
- "description": "Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType."
- },
- "primary": {
- "type": "boolean",
- "description": "Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement."
- },
- "publisherUpdateInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the last publisher update. This is a read-only field."
- },
- "siteId": {
- "type": "string",
- "description": "Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.",
- "format": "int64"
- },
- "siteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field."
- },
- "size": {
- "$ref": "Size",
- "description": "Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion."
- },
- "sslRequired": {
- "type": "boolean",
- "description": "Whether creatives assigned to this placement must be SSL-compliant."
- },
- "status": {
- "type": "string",
- "description": "Third-party placement status.",
- "enum": [
- "ACKNOWLEDGE_ACCEPTANCE",
- "ACKNOWLEDGE_REJECTION",
- "DRAFT",
- "PAYMENT_ACCEPTED",
- "PAYMENT_REJECTED",
- "PENDING_REVIEW"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this placement. This field can be left blank.",
- "format": "int64"
- },
- "tagFormats": {
- "type": "array",
- "description": "Tag formats to generate for this placement. This field is required on insertion.\nAcceptable values are:\n- \"PLACEMENT_TAG_STANDARD\"\n- \"PLACEMENT_TAG_IFRAME_JAVASCRIPT\"\n- \"PLACEMENT_TAG_IFRAME_ILAYER\"\n- \"PLACEMENT_TAG_INTERNAL_REDIRECT\"\n- \"PLACEMENT_TAG_JAVASCRIPT\"\n- \"PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT\"\n- \"PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT\"\n- \"PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT\"\n- \"PLACEMENT_TAG_CLICK_COMMANDS\"\n- \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH\"\n- \"PLACEMENT_TAG_TRACKING\"\n- \"PLACEMENT_TAG_TRACKING_IFRAME\"\n- \"PLACEMENT_TAG_TRACKING_JAVASCRIPT\"",
- "items": {
- "type": "string",
- "enum": [
- "PLACEMENT_TAG_CLICK_COMMANDS",
- "PLACEMENT_TAG_IFRAME_ILAYER",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
- "PLACEMENT_TAG_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_JAVASCRIPT",
- "PLACEMENT_TAG_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_STANDARD",
- "PLACEMENT_TAG_TRACKING",
- "PLACEMENT_TAG_TRACKING_IFRAME",
- "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- },
- "tagSetting": {
- "$ref": "TagSetting",
- "description": "Tag settings for this placement."
- }
- }
- },
- "PlacementAssignment": {
- "id": "PlacementAssignment",
- "type": "object",
- "description": "Placement Assignment.",
- "properties": {
- "active": {
- "type": "boolean",
- "description": "Whether this placement assignment is active. When true, the placement will be included in the ad's rotation."
- },
- "placementId": {
- "type": "string",
- "description": "ID of the placement to be assigned. This is a required field.",
- "format": "int64"
- },
- "placementIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the placement. This is a read-only, auto-generated field."
- },
- "sslRequired": {
- "type": "boolean",
- "description": "Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated."
- }
- }
- },
- "PlacementGroup": {
- "id": "PlacementGroup",
- "type": "object",
- "description": "Contains properties of a package or roadblock.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this placement group. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this placement group. This is a required field on insertion.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "archived": {
- "type": "boolean",
- "description": "Whether this placement group is archived."
- },
- "campaignId": {
- "type": "string",
- "description": "Campaign ID of this placement group. This field is required on insertion.",
- "format": "int64"
- },
- "campaignIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
- },
- "childPlacementIds": {
- "type": "array",
- "description": "IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "comment": {
- "type": "string",
- "description": "Comments for this placement group."
- },
- "contentCategoryId": {
- "type": "string",
- "description": "ID of the content category assigned to this placement group.",
- "format": "int64"
- },
- "createInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the creation of this placement group. This is a read-only field."
- },
- "directorySiteId": {
- "type": "string",
- "description": "Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.",
- "format": "int64"
- },
- "directorySiteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field."
- },
- "externalId": {
- "type": "string",
- "description": "External ID for this placement."
- },
- "id": {
- "type": "string",
- "description": "ID of this placement group. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this placement group. This is a read-only, auto-generated field."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementGroup\".",
- "default": "dfareporting#placementGroup"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this placement group. This is a read-only field."
- },
- "name": {
- "type": "string",
- "description": "Name of this placement group. This is a required field and must be less than 256 characters long."
- },
- "placementGroupType": {
- "type": "string",
- "description": "Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.",
- "enum": [
- "PLACEMENT_PACKAGE",
- "PLACEMENT_ROADBLOCK"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "placementStrategyId": {
- "type": "string",
- "description": "ID of the placement strategy assigned to this placement group.",
- "format": "int64"
- },
- "pricingSchedule": {
- "$ref": "PricingSchedule",
- "description": "Pricing schedule of this placement group. This field is required on insertion."
- },
- "primaryPlacementId": {
- "type": "string",
- "description": "ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.",
- "format": "int64"
- },
- "primaryPlacementIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the primary placement. This is a read-only, auto-generated field."
- },
- "programmaticSetting": {
- "$ref": "ProgrammaticSetting",
- "description": "Settings for a programmatic placement."
- },
- "siteId": {
- "type": "string",
- "description": "Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.",
- "format": "int64"
- },
- "siteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this placement group. This is a read-only field that can be left blank.",
- "format": "int64"
- }
- }
- },
- "PlacementGroupsListResponse": {
- "id": "PlacementGroupsListResponse",
- "type": "object",
- "description": "Placement Group List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementGroupsListResponse\".",
- "default": "dfareporting#placementGroupsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- },
- "placementGroups": {
- "type": "array",
- "description": "Placement group collection.",
- "items": {
- "$ref": "PlacementGroup"
- }
- }
- }
- },
- "PlacementStrategiesListResponse": {
- "id": "PlacementStrategiesListResponse",
- "type": "object",
- "description": "Placement Strategy List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementStrategiesListResponse\".",
- "default": "dfareporting#placementStrategiesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- },
- "placementStrategies": {
- "type": "array",
- "description": "Placement strategy collection.",
- "items": {
- "$ref": "PlacementStrategy"
- }
- }
- }
- },
- "PlacementStrategy": {
- "id": "PlacementStrategy",
- "type": "object",
- "description": "Contains properties of a placement strategy.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this placement strategy.This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "ID of this placement strategy. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementStrategy\".",
- "default": "dfareporting#placementStrategy"
- },
- "name": {
- "type": "string",
- "description": "Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account."
- }
- }
- },
- "PlacementTag": {
- "id": "PlacementTag",
- "type": "object",
- "description": "Placement Tag",
- "properties": {
- "placementId": {
- "type": "string",
- "description": "Placement ID",
- "format": "int64"
- },
- "tagDatas": {
- "type": "array",
- "description": "Tags generated for this placement.",
- "items": {
- "$ref": "TagData"
- }
- }
- }
- },
- "PlacementsGenerateTagsResponse": {
- "id": "PlacementsGenerateTagsResponse",
- "type": "object",
- "description": "Placement GenerateTags Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementsGenerateTagsResponse\".",
- "default": "dfareporting#placementsGenerateTagsResponse"
- },
- "placementTags": {
- "type": "array",
- "description": "Set of generated tags for the specified placements.",
- "items": {
- "$ref": "PlacementTag"
- }
- }
- }
- },
- "PlacementsListResponse": {
- "id": "PlacementsListResponse",
- "type": "object",
- "description": "Placement List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementsListResponse\".",
- "default": "dfareporting#placementsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- },
- "placements": {
- "type": "array",
- "description": "Placement collection.",
- "items": {
- "$ref": "Placement"
- }
- }
- }
- },
- "PlatformType": {
- "id": "PlatformType",
- "type": "object",
- "description": "Contains information about a platform type that can be targeted by ads.",
- "properties": {
- "id": {
- "type": "string",
- "description": "ID of this platform type.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#platformType\".",
- "default": "dfareporting#platformType"
- },
- "name": {
- "type": "string",
- "description": "Name of this platform type."
- }
- }
- },
- "PlatformTypesListResponse": {
- "id": "PlatformTypesListResponse",
- "type": "object",
- "description": "Platform Type List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#platformTypesListResponse\".",
- "default": "dfareporting#platformTypesListResponse"
- },
- "platformTypes": {
- "type": "array",
- "description": "Platform type collection.",
- "items": {
- "$ref": "PlatformType"
- }
- }
- }
- },
- "PopupWindowProperties": {
- "id": "PopupWindowProperties",
- "type": "object",
- "description": "Popup Window Properties.",
- "properties": {
- "dimension": {
- "$ref": "Size",
- "description": "Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID"
- },
- "offset": {
- "$ref": "OffsetPosition",
- "description": "Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES."
- },
- "positionType": {
- "type": "string",
- "description": "Popup window position either centered or at specific coordinate.",
- "enum": [
- "CENTER",
- "COORDINATES"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "showAddressBar": {
- "type": "boolean",
- "description": "Whether to display the browser address bar."
- },
- "showMenuBar": {
- "type": "boolean",
- "description": "Whether to display the browser menu bar."
- },
- "showScrollBar": {
- "type": "boolean",
- "description": "Whether to display the browser scroll bar."
- },
- "showStatusBar": {
- "type": "boolean",
- "description": "Whether to display the browser status bar."
- },
- "showToolBar": {
- "type": "boolean",
- "description": "Whether to display the browser tool bar."
- },
- "title": {
- "type": "string",
- "description": "Title of popup window."
- }
- }
- },
- "PostalCode": {
- "id": "PostalCode",
- "type": "object",
- "description": "Contains information about a postal code that can be targeted by ads.",
- "properties": {
- "countryCode": {
- "type": "string",
- "description": "Country code of the country to which this postal code belongs."
- },
- "countryDartId": {
- "type": "string",
- "description": "DART ID of the country to which this postal code belongs.",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "ID of this postal code."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#postalCode\".",
- "default": "dfareporting#postalCode"
- }
- }
- },
- "PostalCodesListResponse": {
- "id": "PostalCodesListResponse",
- "type": "object",
- "description": "Postal Code List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#postalCodesListResponse\".",
- "default": "dfareporting#postalCodesListResponse"
- },
- "postalCodes": {
- "type": "array",
- "description": "Postal code collection.",
- "items": {
- "$ref": "PostalCode"
- }
- }
- }
- },
- "PricingSchedule": {
- "id": "PricingSchedule",
- "type": "object",
- "description": "Pricing Schedule",
- "properties": {
- "capCostOption": {
- "type": "string",
- "description": "Placement cap cost option.",
- "enum": [
- "CAP_COST_CUMULATIVE",
- "CAP_COST_MONTHLY",
- "CAP_COST_NONE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "disregardOverdelivery": {
- "type": "boolean",
- "description": "Whether cap costs are ignored by ad serving."
- },
- "endDate": {
- "type": "string",
- "description": "Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.",
- "format": "date"
- },
- "flighted": {
- "type": "boolean",
- "description": "Whether this placement is flighted. If true, pricing periods will be computed automatically."
- },
- "floodlightActivityId": {
- "type": "string",
- "description": "Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.",
- "format": "int64"
- },
- "pricingPeriods": {
- "type": "array",
- "description": "Pricing periods for this placement.",
- "items": {
- "$ref": "PricingSchedulePricingPeriod"
- }
- },
- "pricingType": {
- "type": "string",
- "description": "Placement pricing type. This field is required on insertion.",
- "enum": [
- "PRICING_TYPE_CPA",
- "PRICING_TYPE_CPC",
- "PRICING_TYPE_CPM",
- "PRICING_TYPE_FLAT_RATE_CLICKS",
- "PRICING_TYPE_FLAT_RATE_IMPRESSIONS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "startDate": {
- "type": "string",
- "description": "Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.",
- "format": "date"
- },
- "testingStartDate": {
- "type": "string",
- "description": "Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.",
- "format": "date"
- }
- }
- },
- "PricingSchedulePricingPeriod": {
- "id": "PricingSchedulePricingPeriod",
- "type": "object",
- "description": "Pricing Period",
- "properties": {
- "endDate": {
- "type": "string",
- "description": "Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.",
- "format": "date"
- },
- "pricingComment": {
- "type": "string",
- "description": "Comments for this pricing period."
- },
- "rateOrCostNanos": {
- "type": "string",
- "description": "Rate or cost of this pricing period.",
- "format": "int64"
- },
- "startDate": {
- "type": "string",
- "description": "Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.",
- "format": "date"
- },
- "units": {
- "type": "string",
- "description": "Units of this pricing period.",
- "format": "int64"
- }
- }
- },
- "ProgrammaticSetting": {
- "id": "ProgrammaticSetting",
- "type": "object",
- "description": "Programmatic Setting",
- "properties": {
- "adxDealIds": {
- "type": "array",
- "description": "Adx deal IDs assigned to the placement.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "insertionOrderId": {
- "type": "string",
- "description": "Insertion order ID."
- },
- "insertionOrderIdStatus": {
- "type": "boolean",
- "description": "Whether insertion order ID has been placed in DFP. This is a read-only field."
- },
- "mediaCostNanos": {
- "type": "string",
- "description": "Media cost for the programmatic placement.",
- "format": "int64"
- },
- "programmatic": {
- "type": "boolean",
- "description": "Whether programmatic is enabled."
- },
- "traffickerEmails": {
- "type": "array",
- "description": "Trafficker emails assigned to the placement.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "ReachReportCompatibleFields": {
- "id": "ReachReportCompatibleFields",
- "type": "object",
- "description": "Represents fields that are compatible to be selected for a report of type \"REACH\".",
- "properties": {
- "dimensionFilters": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#reachReportCompatibleFields.",
- "default": "dfareporting#reachReportCompatibleFields"
- },
- "metrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- },
- "pivotedActivityMetrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected as activity metrics to pivot on in the \"activities\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- },
- "reachByFrequencyMetrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected in the \"reachByFrequencyMetricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- }
- }
- },
- "Recipient": {
- "id": "Recipient",
- "type": "object",
- "description": "Represents a recipient.",
- "properties": {
- "deliveryType": {
- "type": "string",
- "description": "The delivery type for the recipient.",
- "enum": [
- "ATTACHMENT",
- "LINK"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "email": {
- "type": "string",
- "description": "The email address of the recipient.",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#recipient.",
- "default": "dfareporting#recipient"
- }
- }
- },
- "Region": {
- "id": "Region",
- "type": "object",
- "description": "Contains information about a region that can be targeted by ads.",
- "properties": {
- "countryCode": {
- "type": "string",
- "description": "Country code of the country to which this region belongs."
- },
- "countryDartId": {
- "type": "string",
- "description": "DART ID of the country to which this region belongs.",
- "format": "int64"
- },
- "dartId": {
- "type": "string",
- "description": "DART ID of this region.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#region\".",
- "default": "dfareporting#region"
- },
- "name": {
- "type": "string",
- "description": "Name of this region."
- },
- "regionCode": {
- "type": "string",
- "description": "Region code."
- }
- }
- },
- "RegionsListResponse": {
- "id": "RegionsListResponse",
- "type": "object",
- "description": "Region List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#regionsListResponse\".",
- "default": "dfareporting#regionsListResponse"
- },
- "regions": {
- "type": "array",
- "description": "Region collection.",
- "items": {
- "$ref": "Region"
- }
- }
- }
- },
- "Report": {
- "id": "Report",
- "type": "object",
- "description": "Represents a Report resource.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The account ID to which this report belongs.",
- "format": "int64",
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- }
- },
- "criteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"STANDARD\".",
- "properties": {
- "activities": {
- "$ref": "Activities",
- "description": "Activity group."
- },
- "customRichMediaEvents": {
- "$ref": "CustomRichMediaEvents",
- "description": "Custom Rich Media Events group."
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range for which this report should be run."
- },
- "dimensionFilters": {
- "type": "array",
- "description": "The list of filters on which dimensions are filtered.\nFilters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "The list of standard dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "crossDimensionReachCriteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"CROSS_DIMENSION_REACH\".",
- "properties": {
- "breakdown": {
- "type": "array",
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimension": {
- "type": "string",
- "description": "The dimension option.",
- "enum": [
- "ADVERTISER",
- "CAMPAIGN",
- "SITE_BY_ADVERTISER",
- "SITE_BY_CAMPAIGN"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- },
- "dimensionFilters": {
- "type": "array",
- "description": "The list of filters on which dimensions are filtered.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "overlapMetricNames": {
- "type": "array",
- "description": "The list of names of overlap metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "pivoted": {
- "type": "boolean",
- "description": "Whether the report is pivoted or not. Defaults to true."
- }
- }
- },
- "delivery": {
- "type": "object",
- "description": "The report's email delivery settings.",
- "properties": {
- "emailOwner": {
- "type": "boolean",
- "description": "Whether the report should be emailed to the report owner."
- },
- "emailOwnerDeliveryType": {
- "type": "string",
- "description": "The type of delivery for the owner to receive, if enabled.",
- "enum": [
- "ATTACHMENT",
- "LINK"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "message": {
- "type": "string",
- "description": "The message to be sent with each email."
- },
- "recipients": {
- "type": "array",
- "description": "The list of recipients to which to email the report.",
- "items": {
- "$ref": "Recipient"
- }
- }
- }
- },
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "fileName": {
- "type": "string",
- "description": "The filename used when generating report files for this report."
- },
- "floodlightCriteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"FLOODLIGHT\".",
- "properties": {
- "customRichMediaEvents": {
- "type": "array",
- "description": "The list of custom rich media events to include.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimensionFilters": {
- "type": "array",
- "description": "The list of filters on which dimensions are filtered.\nFilters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "floodlightConfigId": {
- "$ref": "DimensionValue",
- "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "reportProperties": {
- "type": "object",
- "description": "The properties of the report.",
- "properties": {
- "includeAttributedIPConversions": {
- "type": "boolean",
- "description": "Include conversions that have no cookie, but do have an exposure path."
- },
- "includeUnattributedCookieConversions": {
- "type": "boolean",
- "description": "Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window."
- },
- "includeUnattributedIPConversions": {
- "type": "boolean",
- "description": "Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion."
- }
- }
- }
- }
- },
- "format": {
- "type": "string",
- "description": "The output format of the report. If not specified, default format is \"CSV\". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. \"CSV\" will then be the fallback format.",
- "enum": [
- "CSV",
- "EXCEL"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "id": {
- "type": "string",
- "description": "The unique ID identifying this report resource.",
- "format": "int64",
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#report.",
- "default": "dfareporting#report"
- },
- "lastModifiedTime": {
- "type": "string",
- "description": "The timestamp (in milliseconds since epoch) of when this report was last modified.",
- "format": "uint64",
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- }
- },
- "name": {
- "type": "string",
- "description": "The name of the report.",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "ownerProfileId": {
- "type": "string",
- "description": "The user profile id of the owner of this report.",
- "format": "int64",
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- }
- },
- "pathToConversionCriteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"PATH_TO_CONVERSION\".",
- "properties": {
- "activityFilters": {
- "type": "array",
- "description": "The list of 'dfa:activity' values to filter on.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "conversionDimensions": {
- "type": "array",
- "description": "The list of conversion dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "customFloodlightVariables": {
- "type": "array",
- "description": "The list of custom floodlight variables the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "customRichMediaEvents": {
- "type": "array",
- "description": "The list of custom rich media events to include.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "floodlightConfigId": {
- "$ref": "DimensionValue",
- "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "perInteractionDimensions": {
- "type": "array",
- "description": "The list of per interaction dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "reportProperties": {
- "type": "object",
- "description": "The properties of the report.",
- "properties": {
- "clicksLookbackWindow": {
- "type": "integer",
- "description": "DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.",
- "format": "int32"
- },
- "impressionsLookbackWindow": {
- "type": "integer",
- "description": "DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.",
- "format": "int32"
- },
- "includeAttributedIPConversions": {
- "type": "boolean",
- "description": "Deprecated: has no effect."
- },
- "includeUnattributedCookieConversions": {
- "type": "boolean",
- "description": "Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window."
- },
- "includeUnattributedIPConversions": {
- "type": "boolean",
- "description": "Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion."
- },
- "maximumClickInteractions": {
- "type": "integer",
- "description": "The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.",
- "format": "int32"
- },
- "maximumImpressionInteractions": {
- "type": "integer",
- "description": "The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.",
- "format": "int32"
- },
- "maximumInteractionGap": {
- "type": "integer",
- "description": "The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.",
- "format": "int32"
- },
- "pivotOnInteractionPath": {
- "type": "boolean",
- "description": "Enable pivoting on interaction path."
- }
- }
- }
- }
- },
- "reachCriteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"REACH\".",
- "properties": {
- "activities": {
- "$ref": "Activities",
- "description": "Activity group."
- },
- "customRichMediaEvents": {
- "$ref": "CustomRichMediaEvents",
- "description": "Custom Rich Media Events group."
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimensionFilters": {
- "type": "array",
- "description": "The list of filters on which dimensions are filtered.\nFilters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "enableAllDimensionCombinations": {
- "type": "boolean",
- "description": "Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months."
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "reachByFrequencyMetricNames": {
- "type": "array",
- "description": "The list of names of Reach By Frequency metrics the report should include.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "schedule": {
- "type": "object",
- "description": "The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not \"TODAY\".",
- "properties": {
- "active": {
- "type": "boolean",
- "description": "Whether the schedule is active or not. Must be set to either true or false.",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "every": {
- "type": "integer",
- "description": "Defines every how many days, weeks or months the report should be run. Needs to be set when \"repeats\" is either \"DAILY\", \"WEEKLY\" or \"MONTHLY\".",
- "format": "int32"
- },
- "expirationDate": {
- "type": "string",
- "description": "The expiration date when the scheduled report stops running.",
- "format": "date",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "repeats": {
- "type": "string",
- "description": "The interval for which the report is repeated. Note: \n- \"DAILY\" also requires field \"every\" to be set. \n- \"WEEKLY\" also requires fields \"every\" and \"repeatsOnWeekDays\" to be set. \n- \"MONTHLY\" also requires fields \"every\" and \"runsOnDayOfMonth\" to be set.",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "repeatsOnWeekDays": {
- "type": "array",
- "description": "List of week days \"WEEKLY\" on which scheduled reports should run.",
- "items": {
- "type": "string",
- "enum": [
- "FRIDAY",
- "MONDAY",
- "SATURDAY",
- "SUNDAY",
- "THURSDAY",
- "TUESDAY",
- "WEDNESDAY"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- },
- "runsOnDayOfMonth": {
- "type": "string",
- "description": "Enum to define for \"MONTHLY\" scheduled reports whether reports should be repeated on the same day of the month as \"startDate\" or the same day of the week of the month.\nExample: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), \"DAY_OF_MONTH\" would run subsequent reports on the 2nd of every Month, and \"WEEK_OF_MONTH\" would run subsequent reports on the first Monday of the month.",
- "enum": [
- "DAY_OF_MONTH",
- "WEEK_OF_MONTH"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "startDate": {
- "type": "string",
- "description": "Start date of date range for which scheduled reports should be run.",
- "format": "date",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- }
- }
- },
- "subAccountId": {
- "type": "string",
- "description": "The subaccount ID to which this report belongs if applicable.",
- "format": "int64"
- },
- "type": {
- "type": "string",
- "description": "The type of the report.",
- "enum": [
- "CROSS_DIMENSION_REACH",
- "FLOODLIGHT",
- "PATH_TO_CONVERSION",
- "REACH",
- "STANDARD"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- }
- }
- },
- "ReportCompatibleFields": {
- "id": "ReportCompatibleFields",
- "type": "object",
- "description": "Represents fields that are compatible to be selected for a report of type \"STANDARD\".",
- "properties": {
- "dimensionFilters": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#reportCompatibleFields.",
- "default": "dfareporting#reportCompatibleFields"
- },
- "metrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- },
- "pivotedActivityMetrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected as activity metrics to pivot on in the \"activities\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- }
- }
- },
- "ReportList": {
- "id": "ReportList",
- "type": "object",
- "description": "Represents the list of reports.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The reports returned in this response.",
- "items": {
- "$ref": "Report"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of list this is, in this case dfareporting#reportList.",
- "default": "dfareporting#reportList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through reports. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted."
- }
- }
- },
- "ReportsConfiguration": {
- "id": "ReportsConfiguration",
- "type": "object",
- "description": "Reporting Configuration",
- "properties": {
- "exposureToConversionEnabled": {
- "type": "boolean",
- "description": "Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting."
- },
- "lookbackConfiguration": {
- "$ref": "LookbackConfiguration",
- "description": "Default lookback windows for new advertisers in this account."
- },
- "reportGenerationTimeZoneId": {
- "type": "string",
- "description": "Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.\nAcceptable values are:\n\n- \"1\" for \"America/New_York\" \n- \"2\" for \"Europe/London\" \n- \"3\" for \"Europe/Paris\" \n- \"4\" for \"Africa/Johannesburg\" \n- \"5\" for \"Asia/Jerusalem\" \n- \"6\" for \"Asia/Shanghai\" \n- \"7\" for \"Asia/Hong_Kong\" \n- \"8\" for \"Asia/Tokyo\" \n- \"9\" for \"Australia/Sydney\" \n- \"10\" for \"Asia/Dubai\" \n- \"11\" for \"America/Los_Angeles\" \n- \"12\" for \"Pacific/Auckland\" \n- \"13\" for \"America/Sao_Paulo\"",
- "format": "int64"
- }
- }
- },
- "RichMediaExitOverride": {
- "id": "RichMediaExitOverride",
- "type": "object",
- "description": "Rich Media Exit Override.",
- "properties": {
- "customExitUrl": {
- "type": "string",
- "description": "Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true."
- },
- "exitId": {
- "type": "string",
- "description": "ID for the override to refer to a specific exit in the creative.",
- "format": "int64"
- },
- "useCustomExitUrl": {
- "type": "boolean",
- "description": "Whether to use the custom exit URL."
- }
- }
- },
- "Site": {
- "id": "Site",
- "type": "object",
- "description": "Contains properties of a site.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this site. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "approved": {
- "type": "boolean",
- "description": "Whether this site is approved."
- },
- "directorySiteId": {
- "type": "string",
- "description": "Directory site associated with this site. This is a required field that is read-only after insertion.",
- "format": "int64"
- },
- "directorySiteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field."
- },
- "id": {
- "type": "string",
- "description": "ID of this site. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this site. This is a read-only, auto-generated field."
- },
- "keyName": {
- "type": "string",
- "description": "Key name of this site. This is a read-only, auto-generated field."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#site\".",
- "default": "dfareporting#site"
- },
- "name": {
- "type": "string",
- "description": "Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account."
- },
- "siteContacts": {
- "type": "array",
- "description": "Site contacts.",
- "items": {
- "$ref": "SiteContact"
- }
- },
- "siteSettings": {
- "$ref": "SiteSettings",
- "description": "Site-wide settings."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this site. This is a read-only field that can be left blank.",
- "format": "int64"
- }
- }
- },
- "SiteContact": {
- "id": "SiteContact",
- "type": "object",
- "description": "Site Contact",
- "properties": {
- "contactType": {
- "type": "string",
- "description": "Site contact type.",
- "enum": [
- "SALES_PERSON",
- "TRAFFICKER"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "email": {
- "type": "string",
- "description": "Email address of this site contact. This is a required field."
- },
- "firstName": {
- "type": "string",
- "description": "First name of this site contact."
- },
- "id": {
- "type": "string",
- "description": "ID of this site contact. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "lastName": {
- "type": "string",
- "description": "Last name of this site contact."
- }
- }
- },
- "SiteSettings": {
- "id": "SiteSettings",
- "type": "object",
- "description": "Site Settings",
- "properties": {
- "activeViewOptOut": {
- "type": "boolean",
- "description": "Whether active view creatives are disabled for this site."
- },
- "creativeSettings": {
- "$ref": "CreativeSettings",
- "description": "Site-wide creative settings."
- },
- "disableBrandSafeAds": {
- "type": "boolean",
- "description": "Whether brand safe ads are disabled for this site."
- },
- "disableNewCookie": {
- "type": "boolean",
- "description": "Whether new cookies are disabled for this site."
- },
- "lookbackConfiguration": {
- "$ref": "LookbackConfiguration",
- "description": "Lookback window settings for this site."
- },
- "tagSetting": {
- "$ref": "TagSetting",
- "description": "Configuration settings for dynamic and image floodlight tags."
- }
- }
- },
- "SitesListResponse": {
- "id": "SitesListResponse",
- "type": "object",
- "description": "Site List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#sitesListResponse\".",
- "default": "dfareporting#sitesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- },
- "sites": {
- "type": "array",
- "description": "Site collection.",
- "items": {
- "$ref": "Site"
- }
- }
- }
- },
- "Size": {
- "id": "Size",
- "type": "object",
- "description": "Represents the dimensions of ads, placements, creatives, or creative assets.",
- "properties": {
- "height": {
- "type": "integer",
- "description": "Height of this size.",
- "format": "int32"
- },
- "iab": {
- "type": "boolean",
- "description": "IAB standard size. This is a read-only, auto-generated field."
- },
- "id": {
- "type": "string",
- "description": "ID of this size. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#size\".",
- "default": "dfareporting#size"
- },
- "width": {
- "type": "integer",
- "description": "Width of this size.",
- "format": "int32"
- }
- }
- },
- "SizesListResponse": {
- "id": "SizesListResponse",
- "type": "object",
- "description": "Size List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#sizesListResponse\".",
- "default": "dfareporting#sizesListResponse"
- },
- "sizes": {
- "type": "array",
- "description": "Size collection.",
- "items": {
- "$ref": "Size"
- }
- }
- }
- },
- "SortedDimension": {
- "id": "SortedDimension",
- "type": "object",
- "description": "Represents a sorted dimension.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#sortedDimension.",
- "default": "dfareporting#sortedDimension"
- },
- "name": {
- "type": "string",
- "description": "The name of the dimension."
- },
- "sortOrder": {
- "type": "string",
- "description": "An optional sort order for the dimension column.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- }
- }
- },
- "Subaccount": {
- "id": "Subaccount",
- "type": "object",
- "description": "Contains properties of a DCM subaccount.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "ID of the account that contains this subaccount. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "availablePermissionIds": {
- "type": "array",
- "description": "IDs of the available user role permissions for this subaccount.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "id": {
- "type": "string",
- "description": "ID of this subaccount. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#subaccount\".",
- "default": "dfareporting#subaccount"
- },
- "name": {
- "type": "string",
- "description": "Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account."
- }
- }
- },
- "SubaccountsListResponse": {
- "id": "SubaccountsListResponse",
- "type": "object",
- "description": "Subaccount List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#subaccountsListResponse\".",
- "default": "dfareporting#subaccountsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- },
- "subaccounts": {
- "type": "array",
- "description": "Subaccount collection.",
- "items": {
- "$ref": "Subaccount"
- }
- }
- }
- },
- "TagData": {
- "id": "TagData",
- "type": "object",
- "description": "Placement Tag Data",
- "properties": {
- "adId": {
- "type": "string",
- "description": "Ad associated with this placement tag.",
- "format": "int64"
- },
- "clickTag": {
- "type": "string",
- "description": "Tag string to record a click."
- },
- "creativeId": {
- "type": "string",
- "description": "Creative associated with this placement tag.",
- "format": "int64"
- },
- "format": {
- "type": "string",
- "description": "TagData tag format of this tag.",
- "enum": [
- "PLACEMENT_TAG_CLICK_COMMANDS",
- "PLACEMENT_TAG_IFRAME_ILAYER",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
- "PLACEMENT_TAG_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_JAVASCRIPT",
- "PLACEMENT_TAG_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_STANDARD",
- "PLACEMENT_TAG_TRACKING",
- "PLACEMENT_TAG_TRACKING_IFRAME",
- "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "impressionTag": {
- "type": "string",
- "description": "Tag string for serving an ad."
- }
- }
- },
- "TagSetting": {
- "id": "TagSetting",
- "type": "object",
- "description": "Tag Settings",
- "properties": {
- "additionalKeyValues": {
- "type": "string",
- "description": "Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field."
- },
- "includeClickThroughUrls": {
- "type": "boolean",
- "description": "Whether static landing page URLs should be included in the tags. This setting applies only to placements."
- },
- "includeClickTracking": {
- "type": "boolean",
- "description": "Whether click-tracking string should be included in the tags."
- },
- "keywordOption": {
- "type": "string",
- "description": "Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.",
- "enum": [
- "GENERATE_SEPARATE_TAG_FOR_EACH_KEYWORD",
- "IGNORE",
- "PLACEHOLDER_WITH_LIST_OF_KEYWORDS"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- }
- }
- },
- "TagSettings": {
- "id": "TagSettings",
- "type": "object",
- "description": "Dynamic and Image Tag Settings.",
- "properties": {
- "dynamicTagEnabled": {
- "type": "boolean",
- "description": "Whether dynamic floodlight tags are enabled."
- },
- "imageTagEnabled": {
- "type": "boolean",
- "description": "Whether image tags are enabled."
- }
- }
- },
- "TargetWindow": {
- "id": "TargetWindow",
- "type": "object",
- "description": "Target Window.",
- "properties": {
- "customHtml": {
- "type": "string",
- "description": "User-entered value."
- },
- "targetWindowOption": {
- "type": "string",
- "description": "Type of browser window for which the backup image of the flash creative can be displayed.",
- "enum": [
- "CURRENT_WINDOW",
- "CUSTOM",
- "NEW_WINDOW"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- }
- }
- },
- "TechnologyTargeting": {
- "id": "TechnologyTargeting",
- "type": "object",
- "description": "Technology Targeting.",
- "properties": {
- "browsers": {
- "type": "array",
- "description": "Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.",
- "items": {
- "$ref": "Browser"
- }
- },
- "connectionTypes": {
- "type": "array",
- "description": "Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.",
- "items": {
- "$ref": "ConnectionType"
- }
- },
- "mobileCarriers": {
- "type": "array",
- "description": "Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.",
- "items": {
- "$ref": "MobileCarrier"
- }
- },
- "operatingSystemVersions": {
- "type": "array",
- "description": "Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.",
- "items": {
- "$ref": "OperatingSystemVersion"
- }
- },
- "operatingSystems": {
- "type": "array",
- "description": "Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.",
- "items": {
- "$ref": "OperatingSystem"
- }
- },
- "platformTypes": {
- "type": "array",
- "description": "Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.",
- "items": {
- "$ref": "PlatformType"
- }
- }
- }
- },
- "ThirdPartyTrackingUrl": {
- "id": "ThirdPartyTrackingUrl",
- "type": "object",
- "description": "Third-party Tracking URL.",
- "properties": {
- "thirdPartyUrlType": {
- "type": "string",
- "description": "Third-party URL type for in-stream video creatives.",
- "enum": [
- "CLICK_TRACKING",
- "IMPRESSION",
- "RICH_MEDIA_BACKUP_IMPRESSION",
- "RICH_MEDIA_IMPRESSION",
- "RICH_MEDIA_RM_IMPRESSION",
- "SURVEY",
- "VIDEO_COMPLETE",
- "VIDEO_CUSTOM",
- "VIDEO_FIRST_QUARTILE",
- "VIDEO_FULLSCREEN",
- "VIDEO_MIDPOINT",
- "VIDEO_MUTE",
- "VIDEO_PAUSE",
- "VIDEO_REWIND",
- "VIDEO_START",
- "VIDEO_STOP",
- "VIDEO_THIRD_QUARTILE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "url": {
- "type": "string",
- "description": "URL for the specified third-party URL type."
- }
- }
- },
- "UserDefinedVariableConfiguration": {
- "id": "UserDefinedVariableConfiguration",
- "type": "object",
- "description": "User Defined Variable configuration.",
- "properties": {
- "dataType": {
- "type": "string",
- "description": "Data type for the variable. This is a required field.",
- "enum": [
- "NUMBER",
- "STRING"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "reportName": {
- "type": "string",
- "description": "User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: \"\"\u003c\u003e\"."
- },
- "variableType": {
- "type": "string",
- "description": "Variable name in the tag. This is a required field.",
- "enum": [
- "U1",
- "U10",
- "U11",
- "U12",
- "U13",
- "U14",
- "U15",
- "U16",
- "U17",
- "U18",
- "U19",
- "U2",
- "U20",
- "U3",
- "U4",
- "U5",
- "U6",
- "U7",
- "U8",
- "U9"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- }
- },
- "UserProfile": {
- "id": "UserProfile",
- "type": "object",
- "description": "Represents a UserProfile resource.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The account ID to which this profile belongs.",
- "format": "int64"
- },
- "accountName": {
- "type": "string",
- "description": "The account name this profile belongs to."
- },
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#userProfile.",
- "default": "dfareporting#userProfile"
- },
- "profileId": {
- "type": "string",
- "description": "The unique ID of the user profile.",
- "format": "int64"
- },
- "subAccountId": {
- "type": "string",
- "description": "The sub account ID this profile belongs to if applicable.",
- "format": "int64"
- },
- "subAccountName": {
- "type": "string",
- "description": "The sub account name this profile belongs to if applicable."
- },
- "userName": {
- "type": "string",
- "description": "The user name."
- }
- }
- },
- "UserProfileList": {
- "id": "UserProfileList",
- "type": "object",
- "description": "Represents the list of user profiles.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The user profiles returned in this response.",
- "items": {
- "$ref": "UserProfile"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of list this is, in this case dfareporting#userProfileList.",
- "default": "dfareporting#userProfileList"
- }
- }
- },
- "UserRole": {
- "id": "UserRole",
- "type": "object",
- "description": "Contains properties of auser role, which is used to manage user access.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this user role. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "defaultUserRole": {
- "type": "boolean",
- "description": "Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions."
- },
- "id": {
- "type": "string",
- "description": "ID of this user role. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRole\".",
- "default": "dfareporting#userRole"
- },
- "name": {
- "type": "string",
- "description": "Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account."
- },
- "parentUserRoleId": {
- "type": "string",
- "description": "ID of the user role that this user role is based on or copied from. This is a required field.",
- "format": "int64"
- },
- "permissions": {
- "type": "array",
- "description": "List of permissions associated with this user role.",
- "items": {
- "$ref": "UserRolePermission"
- }
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this user role. This is a read-only field that can be left blank.",
- "format": "int64"
- }
- }
- },
- "UserRolePermission": {
- "id": "UserRolePermission",
- "type": "object",
- "description": "Contains properties of a user role permission.",
- "properties": {
- "availability": {
- "type": "string",
- "description": "Levels of availability for a user role permission.",
- "enum": [
- "ACCOUNT_ALWAYS",
- "ACCOUNT_BY_DEFAULT",
- "NOT_AVAILABLE_BY_DEFAULT",
- "SUBACCOUNT_AND_ACCOUNT_ALWAYS",
- "SUBACCOUNT_AND_ACCOUNT_BY_DEFAULT"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "id": {
- "type": "string",
- "description": "ID of this user role permission.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermission\".",
- "default": "dfareporting#userRolePermission"
- },
- "name": {
- "type": "string",
- "description": "Name of this user role permission."
- },
- "permissionGroupId": {
- "type": "string",
- "description": "ID of the permission group that this user role permission belongs to.",
- "format": "int64"
- }
- }
- },
- "UserRolePermissionGroup": {
- "id": "UserRolePermissionGroup",
- "type": "object",
- "description": "Represents a grouping of related user role permissions.",
- "properties": {
- "id": {
- "type": "string",
- "description": "ID of this user role permission.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionGroup\".",
- "default": "dfareporting#userRolePermissionGroup"
- },
- "name": {
- "type": "string",
- "description": "Name of this user role permission group."
- }
- }
- },
- "UserRolePermissionGroupsListResponse": {
- "id": "UserRolePermissionGroupsListResponse",
- "type": "object",
- "description": "User Role Permission Group List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionGroupsListResponse\".",
- "default": "dfareporting#userRolePermissionGroupsListResponse"
- },
- "userRolePermissionGroups": {
- "type": "array",
- "description": "User role permission group collection.",
- "items": {
- "$ref": "UserRolePermissionGroup"
- }
- }
- }
- },
- "UserRolePermissionsListResponse": {
- "id": "UserRolePermissionsListResponse",
- "type": "object",
- "description": "User Role Permission List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionsListResponse\".",
- "default": "dfareporting#userRolePermissionsListResponse"
- },
- "userRolePermissions": {
- "type": "array",
- "description": "User role permission collection.",
- "items": {
- "$ref": "UserRolePermission"
- }
- }
- }
- },
- "UserRolesListResponse": {
- "id": "UserRolesListResponse",
- "type": "object",
- "description": "User Role List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolesListResponse\".",
- "default": "dfareporting#userRolesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- },
- "userRoles": {
- "type": "array",
- "description": "User role collection.",
- "items": {
- "$ref": "UserRole"
- }
- }
- }
- }
- },
- "resources": {
- "accountActiveAdSummaries": {
- "methods": {
- "get": {
- "id": "dfareporting.accountActiveAdSummaries.get",
- "path": "userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}",
- "httpMethod": "GET",
- "description": "Gets the account's active ad summary by account ID.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "summaryAccountId": {
- "type": "string",
- "description": "Account ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "summaryAccountId"
- ],
- "response": {
- "$ref": "AccountActiveAdSummary"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "accountPermissionGroups": {
- "methods": {
- "get": {
- "id": "dfareporting.accountPermissionGroups.get",
- "path": "userprofiles/{profileId}/accountPermissionGroups/{id}",
- "httpMethod": "GET",
- "description": "Gets one account permission group by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Account permission group ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "AccountPermissionGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.accountPermissionGroups.list",
- "path": "userprofiles/{profileId}/accountPermissionGroups",
- "httpMethod": "GET",
- "description": "Retrieves the list of account permission groups.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "AccountPermissionGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "accountPermissions": {
- "methods": {
- "get": {
- "id": "dfareporting.accountPermissions.get",
- "path": "userprofiles/{profileId}/accountPermissions/{id}",
- "httpMethod": "GET",
- "description": "Gets one account permission by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Account permission ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "AccountPermission"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.accountPermissions.list",
- "path": "userprofiles/{profileId}/accountPermissions",
- "httpMethod": "GET",
- "description": "Retrieves the list of account permissions.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "AccountPermissionsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "accountUserProfiles": {
- "methods": {
- "get": {
- "id": "dfareporting.accountUserProfiles.get",
- "path": "userprofiles/{profileId}/accountUserProfiles/{id}",
- "httpMethod": "GET",
- "description": "Gets one account user profile by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "User profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "AccountUserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.accountUserProfiles.list",
- "path": "userprofiles/{profileId}/accountUserProfiles",
- "httpMethod": "GET",
- "description": "Retrieves a list of account user profiles, possibly filtered.",
- "parameters": {
- "active": {
- "type": "boolean",
- "description": "Select only active user profiles.",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only user profiles with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, \"user profile*2015\" will return objects with names like \"user profile June 2015\", \"user profile April 2015\", or simply \"user profile 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"user profile\" will match objects with name \"my user profile\", \"user profile 2015\", or simply \"user profile\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "subaccountId": {
- "type": "string",
- "description": "Select only user profiles with the specified subaccount ID.",
- "format": "int64",
- "location": "query"
- },
- "userRoleId": {
- "type": "string",
- "description": "Select only user profiles with the specified user role ID.",
- "format": "int64",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "AccountUserProfilesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.accountUserProfiles.patch",
- "path": "userprofiles/{profileId}/accountUserProfiles",
- "httpMethod": "PATCH",
- "description": "Updates an existing account user profile. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "User profile ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "AccountUserProfile"
- },
- "response": {
- "$ref": "AccountUserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.accountUserProfiles.update",
- "path": "userprofiles/{profileId}/accountUserProfiles",
- "httpMethod": "PUT",
- "description": "Updates an existing account user profile.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "AccountUserProfile"
- },
- "response": {
- "$ref": "AccountUserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "accounts": {
- "methods": {
- "get": {
- "id": "dfareporting.accounts.get",
- "path": "userprofiles/{profileId}/accounts/{id}",
- "httpMethod": "GET",
- "description": "Gets one account by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Account ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.accounts.list",
- "path": "userprofiles/{profileId}/accounts",
- "httpMethod": "GET",
- "description": "Retrieves the list of accounts, possibly filtered.",
- "parameters": {
- "active": {
- "type": "boolean",
- "description": "Select only active accounts. Don't set this field to select both active and non-active accounts.",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only accounts with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"account*2015\" will return objects with names like \"account June 2015\", \"account April 2015\", or simply \"account 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"account\" will match objects with name \"my account\", \"account 2015\", or simply \"account\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "AccountsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.accounts.patch",
- "path": "userprofiles/{profileId}/accounts",
- "httpMethod": "PATCH",
- "description": "Updates an existing account. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Account ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.accounts.update",
- "path": "userprofiles/{profileId}/accounts",
- "httpMethod": "PUT",
- "description": "Updates an existing account.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "ads": {
- "methods": {
- "get": {
- "id": "dfareporting.ads.get",
- "path": "userprofiles/{profileId}/ads/{id}",
- "httpMethod": "GET",
- "description": "Gets one ad by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Ad ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Ad"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.ads.insert",
- "path": "userprofiles/{profileId}/ads",
- "httpMethod": "POST",
- "description": "Inserts a new ad.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Ad"
- },
- "response": {
- "$ref": "Ad"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.ads.list",
- "path": "userprofiles/{profileId}/ads",
- "httpMethod": "GET",
- "description": "Retrieves a list of ads, possibly filtered.",
- "parameters": {
- "active": {
- "type": "boolean",
- "description": "Select only active ads.",
- "location": "query"
- },
- "advertiserId": {
- "type": "string",
- "description": "Select only ads with this advertiser ID.",
- "format": "int64",
- "location": "query"
- },
- "archived": {
- "type": "boolean",
- "description": "Select only archived ads.",
- "location": "query"
- },
- "audienceSegmentIds": {
- "type": "string",
- "description": "Select only ads with these audience segment IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "campaignIds": {
- "type": "string",
- "description": "Select only ads with these campaign IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "compatibility": {
- "type": "string",
- "description": "Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.",
- "enum": [
- "APP",
- "APP_INTERSTITIAL",
- "IN_STREAM_VIDEO",
- "WEB",
- "WEB_INTERSTITIAL"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query"
- },
- "creativeIds": {
- "type": "string",
- "description": "Select only ads with these creative IDs assigned.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "creativeOptimizationConfigurationIds": {
- "type": "string",
- "description": "Select only ads with these creative optimization configuration IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "creativeType": {
- "type": "string",
- "description": "Select only ads with the specified creativeType.",
- "enum": [
- "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO",
- "CUSTOM_INPAGE",
- "CUSTOM_INTERSTITIAL",
- "ENHANCED_BANNER",
- "ENHANCED_IMAGE",
- "FLASH_INPAGE",
- "HTML5_BANNER",
- "IMAGE",
- "INSTREAM_VIDEO",
- "INTERNAL_REDIRECT",
- "INTERSTITIAL_INTERNAL_REDIRECT",
- "REDIRECT",
- "RICH_MEDIA_EXPANDING",
- "RICH_MEDIA_IM_EXPAND",
- "RICH_MEDIA_INPAGE",
- "RICH_MEDIA_INPAGE_FLOATING",
- "RICH_MEDIA_INTERSTITIAL_FLOAT",
- "RICH_MEDIA_MOBILE_IN_APP",
- "RICH_MEDIA_MULTI_FLOATING",
- "RICH_MEDIA_PEEL_DOWN",
- "TRACKING_TEXT",
- "VAST_REDIRECT",
- "VPAID_LINEAR",
- "VPAID_NON_LINEAR"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query"
- },
- "dynamicClickTracker": {
- "type": "boolean",
- "description": "Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only ads with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "landingPageIds": {
- "type": "string",
- "description": "Select only ads with these landing page IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "overriddenEventTagId": {
- "type": "string",
- "description": "Select only ads with this event tag override ID.",
- "format": "int64",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "placementIds": {
- "type": "string",
- "description": "Select only ads with these placement IDs assigned.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "remarketingListIds": {
- "type": "string",
- "description": "Select only ads whose list targeting expression use these remarketing list IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"ad*2015\" will return objects with names like \"ad June 2015\", \"ad April 2015\", or simply \"ad 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"ad\" will match objects with name \"my ad\", \"ad 2015\", or simply \"ad\".",
- "location": "query"
- },
- "sizeIds": {
- "type": "string",
- "description": "Select only ads with these size IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sslCompliant": {
- "type": "boolean",
- "description": "Select only ads that are SSL-compliant.",
- "location": "query"
- },
- "sslRequired": {
- "type": "boolean",
- "description": "Select only ads that require SSL.",
- "location": "query"
- },
- "type": {
- "type": "string",
- "description": "Select only ads with these types.",
- "enum": [
- "AD_SERVING_CLICK_TRACKER",
- "AD_SERVING_DEFAULT_AD",
- "AD_SERVING_STANDARD_AD",
- "AD_SERVING_TRACKING"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "AdsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.ads.patch",
- "path": "userprofiles/{profileId}/ads",
- "httpMethod": "PATCH",
- "description": "Updates an existing ad. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Ad ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "Ad"
- },
- "response": {
- "$ref": "Ad"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.ads.update",
- "path": "userprofiles/{profileId}/ads",
- "httpMethod": "PUT",
- "description": "Updates an existing ad.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Ad"
- },
- "response": {
- "$ref": "Ad"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "advertiserGroups": {
- "methods": {
- "delete": {
- "id": "dfareporting.advertiserGroups.delete",
- "path": "userprofiles/{profileId}/advertiserGroups/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing advertiser group.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Advertiser group ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.advertiserGroups.get",
- "path": "userprofiles/{profileId}/advertiserGroups/{id}",
- "httpMethod": "GET",
- "description": "Gets one advertiser group by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Advertiser group ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "AdvertiserGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.advertiserGroups.insert",
- "path": "userprofiles/{profileId}/advertiserGroups",
- "httpMethod": "POST",
- "description": "Inserts a new advertiser group.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "AdvertiserGroup"
- },
- "response": {
- "$ref": "AdvertiserGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.advertiserGroups.list",
- "path": "userprofiles/{profileId}/advertiserGroups",
- "httpMethod": "GET",
- "description": "Retrieves a list of advertiser groups, possibly filtered.",
- "parameters": {
- "ids": {
- "type": "string",
- "description": "Select only advertiser groups with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"advertiser*2015\" will return objects with names like \"advertiser group June 2015\", \"advertiser group April 2015\", or simply \"advertiser group 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"advertisergroup\" will match objects with name \"my advertisergroup\", \"advertisergroup 2015\", or simply \"advertisergroup\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "AdvertiserGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.advertiserGroups.patch",
- "path": "userprofiles/{profileId}/advertiserGroups",
- "httpMethod": "PATCH",
- "description": "Updates an existing advertiser group. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Advertiser group ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "AdvertiserGroup"
- },
- "response": {
- "$ref": "AdvertiserGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.advertiserGroups.update",
- "path": "userprofiles/{profileId}/advertiserGroups",
- "httpMethod": "PUT",
- "description": "Updates an existing advertiser group.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "AdvertiserGroup"
- },
- "response": {
- "$ref": "AdvertiserGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "advertisers": {
- "methods": {
- "get": {
- "id": "dfareporting.advertisers.get",
- "path": "userprofiles/{profileId}/advertisers/{id}",
- "httpMethod": "GET",
- "description": "Gets one advertiser by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Advertiser ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Advertiser"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.advertisers.insert",
- "path": "userprofiles/{profileId}/advertisers",
- "httpMethod": "POST",
- "description": "Inserts a new advertiser.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Advertiser"
- },
- "response": {
- "$ref": "Advertiser"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.advertisers.list",
- "path": "userprofiles/{profileId}/advertisers",
- "httpMethod": "GET",
- "description": "Retrieves a list of advertisers, possibly filtered.",
- "parameters": {
- "advertiserGroupIds": {
- "type": "string",
- "description": "Select only advertisers with these advertiser group IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "floodlightConfigurationIds": {
- "type": "string",
- "description": "Select only advertisers with these floodlight configuration IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only advertisers with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "includeAdvertisersWithoutGroupsOnly": {
- "type": "boolean",
- "description": "Select only advertisers which do not belong to any advertiser group.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "onlyParent": {
- "type": "boolean",
- "description": "Select only advertisers which use another advertiser's floodlight configuration.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"advertiser*2015\" will return objects with names like \"advertiser June 2015\", \"advertiser April 2015\", or simply \"advertiser 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"advertiser\" will match objects with name \"my advertiser\", \"advertiser 2015\", or simply \"advertiser\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "status": {
- "type": "string",
- "description": "Select only advertisers with the specified status.",
- "enum": [
- "APPROVED",
- "ON_HOLD"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "subaccountId": {
- "type": "string",
- "description": "Select only advertisers with these subaccount IDs.",
- "format": "int64",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "AdvertisersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.advertisers.patch",
- "path": "userprofiles/{profileId}/advertisers",
- "httpMethod": "PATCH",
- "description": "Updates an existing advertiser. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Advertiser ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "Advertiser"
- },
- "response": {
- "$ref": "Advertiser"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.advertisers.update",
- "path": "userprofiles/{profileId}/advertisers",
- "httpMethod": "PUT",
- "description": "Updates an existing advertiser.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Advertiser"
- },
- "response": {
- "$ref": "Advertiser"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "browsers": {
- "methods": {
- "list": {
- "id": "dfareporting.browsers.list",
- "path": "userprofiles/{profileId}/browsers",
- "httpMethod": "GET",
- "description": "Retrieves a list of browsers.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "BrowsersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "campaignCreativeAssociations": {
- "methods": {
- "insert": {
- "id": "dfareporting.campaignCreativeAssociations.insert",
- "path": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
- "httpMethod": "POST",
- "description": "Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.",
- "parameters": {
- "campaignId": {
- "type": "string",
- "description": "Campaign ID in this association.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "campaignId"
- ],
- "request": {
- "$ref": "CampaignCreativeAssociation"
- },
- "response": {
- "$ref": "CampaignCreativeAssociation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.campaignCreativeAssociations.list",
- "path": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
- "httpMethod": "GET",
- "description": "Retrieves the list of creative IDs associated with the specified campaign.",
- "parameters": {
- "campaignId": {
- "type": "string",
- "description": "Campaign ID in this association.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "campaignId"
- ],
- "response": {
- "$ref": "CampaignCreativeAssociationsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "campaigns": {
- "methods": {
- "get": {
- "id": "dfareporting.campaigns.get",
- "path": "userprofiles/{profileId}/campaigns/{id}",
- "httpMethod": "GET",
- "description": "Gets one campaign by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Campaign ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Campaign"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.campaigns.insert",
- "path": "userprofiles/{profileId}/campaigns",
- "httpMethod": "POST",
- "description": "Inserts a new campaign.",
- "parameters": {
- "defaultLandingPageName": {
- "type": "string",
- "description": "Default landing page name for this new campaign. Must be less than 256 characters long.",
- "required": true,
- "location": "query"
- },
- "defaultLandingPageUrl": {
- "type": "string",
- "description": "Default landing page URL for this new campaign.",
- "required": true,
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "defaultLandingPageName",
- "defaultLandingPageUrl"
- ],
- "request": {
- "$ref": "Campaign"
- },
- "response": {
- "$ref": "Campaign"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.campaigns.list",
- "path": "userprofiles/{profileId}/campaigns",
- "httpMethod": "GET",
- "description": "Retrieves a list of campaigns, possibly filtered.",
- "parameters": {
- "advertiserGroupIds": {
- "type": "string",
- "description": "Select only campaigns whose advertisers belong to these advertiser groups.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "advertiserIds": {
- "type": "string",
- "description": "Select only campaigns that belong to these advertisers.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "archived": {
- "type": "boolean",
- "description": "Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.",
- "location": "query"
- },
- "atLeastOneOptimizationActivity": {
- "type": "boolean",
- "description": "Select only campaigns that have at least one optimization activity.",
- "location": "query"
- },
- "excludedIds": {
- "type": "string",
- "description": "Exclude campaigns with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only campaigns with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "overriddenEventTagId": {
- "type": "string",
- "description": "Select only campaigns that have overridden this event tag ID.",
- "format": "int64",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, \"campaign*2015\" will return campaigns with names like \"campaign June 2015\", \"campaign April 2015\", or simply \"campaign 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"campaign\" will match campaigns with name \"my campaign\", \"campaign 2015\", or simply \"campaign\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "subaccountId": {
- "type": "string",
- "description": "Select only campaigns that belong to this subaccount.",
- "format": "int64",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "CampaignsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.campaigns.patch",
- "path": "userprofiles/{profileId}/campaigns",
- "httpMethod": "PATCH",
- "description": "Updates an existing campaign. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Campaign ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "Campaign"
- },
- "response": {
- "$ref": "Campaign"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.campaigns.update",
- "path": "userprofiles/{profileId}/campaigns",
- "httpMethod": "PUT",
- "description": "Updates an existing campaign.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Campaign"
- },
- "response": {
- "$ref": "Campaign"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "changeLogs": {
- "methods": {
- "get": {
- "id": "dfareporting.changeLogs.get",
- "path": "userprofiles/{profileId}/changeLogs/{id}",
- "httpMethod": "GET",
- "description": "Gets one change log by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Change log ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "ChangeLog"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.changeLogs.list",
- "path": "userprofiles/{profileId}/changeLogs",
- "httpMethod": "GET",
- "description": "Retrieves a list of change logs.",
- "parameters": {
- "action": {
- "type": "string",
- "description": "Select only change logs with the specified action.",
- "enum": [
- "ACTION_ADD",
- "ACTION_ASSIGN",
- "ACTION_ASSOCIATE",
- "ACTION_CREATE",
- "ACTION_DELETE",
- "ACTION_DISABLE",
- "ACTION_EMAIL_TAGS",
- "ACTION_ENABLE",
- "ACTION_LINK",
- "ACTION_MARK_AS_DEFAULT",
- "ACTION_PUSH",
- "ACTION_REMOVE",
- "ACTION_SEND",
- "ACTION_SHARE",
- "ACTION_UNASSIGN",
- "ACTION_UNLINK",
- "ACTION_UPDATE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only change logs with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxChangeTime": {
- "type": "string",
- "description": "Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is \"2015-07-18T22:54:00-04:00\". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "minChangeTime": {
- "type": "string",
- "description": "Select only change logs whose change time is before the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is \"2015-07-18T22:54:00-04:00\". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.",
- "location": "query"
- },
- "objectIds": {
- "type": "string",
- "description": "Select only change logs with these object IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "objectType": {
- "type": "string",
- "description": "Select only change logs with the specified object type.",
- "enum": [
- "OBJECT_ACCOUNT",
- "OBJECT_ACCOUNT_BILLING_FEATURE",
- "OBJECT_AD",
- "OBJECT_ADVERTISER",
- "OBJECT_ADVERTISER_GROUP",
- "OBJECT_BILLING_ACCOUNT_GROUP",
- "OBJECT_BILLING_FEATURE",
- "OBJECT_BILLING_MINIMUM_FEE",
- "OBJECT_BILLING_PROFILE",
- "OBJECT_CAMPAIGN",
- "OBJECT_CONTENT_CATEGORY",
- "OBJECT_CREATIVE",
- "OBJECT_CREATIVE_ASSET",
- "OBJECT_CREATIVE_BUNDLE",
- "OBJECT_CREATIVE_FIELD",
- "OBJECT_CREATIVE_GROUP",
- "OBJECT_DFA_SITE",
- "OBJECT_EVENT_TAG",
- "OBJECT_FLOODLIGHT_ACTIVITY_GROUP",
- "OBJECT_FLOODLIGHT_ACTVITY",
- "OBJECT_FLOODLIGHT_CONFIGURATION",
- "OBJECT_INSTREAM_CREATIVE",
- "OBJECT_LANDING_PAGE",
- "OBJECT_MEDIA_ORDER",
- "OBJECT_PLACEMENT",
- "OBJECT_PLACEMENT_STRATEGY",
- "OBJECT_PROVIDED_LIST_CLIENT",
- "OBJECT_RATE_CARD",
- "OBJECT_REMARKETING_LIST",
- "OBJECT_RICHMEDIA_CREATIVE",
- "OBJECT_SD_SITE",
- "OBJECT_SIZE",
- "OBJECT_SUBACCOUNT",
- "OBJECT_USER_PROFILE",
- "OBJECT_USER_PROFILE_FILTER",
- "OBJECT_USER_ROLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Select only change logs whose object ID, user name, old or new values match the search string.",
- "location": "query"
- },
- "userProfileIds": {
- "type": "string",
- "description": "Select only change logs with these user profile IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "ChangeLogsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "cities": {
- "methods": {
- "list": {
- "id": "dfareporting.cities.list",
- "path": "userprofiles/{profileId}/cities",
- "httpMethod": "GET",
- "description": "Retrieves a list of cities, possibly filtered.",
- "parameters": {
- "countryDartIds": {
- "type": "string",
- "description": "Select only cities from these countries.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "dartIds": {
- "type": "string",
- "description": "Select only cities with these DART IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "namePrefix": {
- "type": "string",
- "description": "Select only cities with names starting with this prefix.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "regionDartIds": {
- "type": "string",
- "description": "Select only cities from these regions.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "CitiesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "connectionTypes": {
- "methods": {
- "list": {
- "id": "dfareporting.connectionTypes.list",
- "path": "userprofiles/{profileId}/connectionTypes",
- "httpMethod": "GET",
- "description": "Retrieves a list of connection types.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "ConnectionTypesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "contentCategories": {
- "methods": {
- "delete": {
- "id": "dfareporting.contentCategories.delete",
- "path": "userprofiles/{profileId}/contentCategories/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing content category.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Content category ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.contentCategories.get",
- "path": "userprofiles/{profileId}/contentCategories/{id}",
- "httpMethod": "GET",
- "description": "Gets one content category by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Content category ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "ContentCategory"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.contentCategories.insert",
- "path": "userprofiles/{profileId}/contentCategories",
- "httpMethod": "POST",
- "description": "Inserts a new content category.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "ContentCategory"
- },
- "response": {
- "$ref": "ContentCategory"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.contentCategories.list",
- "path": "userprofiles/{profileId}/contentCategories",
- "httpMethod": "GET",
- "description": "Retrieves a list of content categories, possibly filtered.",
- "parameters": {
- "ids": {
- "type": "string",
- "description": "Select only content categories with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"contentcategory*2015\" will return objects with names like \"contentcategory June 2015\", \"contentcategory April 2015\", or simply \"contentcategory 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"contentcategory\" will match objects with name \"my contentcategory\", \"contentcategory 2015\", or simply \"contentcategory\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "ContentCategoriesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.contentCategories.patch",
- "path": "userprofiles/{profileId}/contentCategories",
- "httpMethod": "PATCH",
- "description": "Updates an existing content category. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Content category ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "ContentCategory"
- },
- "response": {
- "$ref": "ContentCategory"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.contentCategories.update",
- "path": "userprofiles/{profileId}/contentCategories",
- "httpMethod": "PUT",
- "description": "Updates an existing content category.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "ContentCategory"
- },
- "response": {
- "$ref": "ContentCategory"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "countries": {
- "methods": {
- "get": {
- "id": "dfareporting.countries.get",
- "path": "userprofiles/{profileId}/countries/{dartId}",
- "httpMethod": "GET",
- "description": "Gets one country by ID.",
- "parameters": {
- "dartId": {
- "type": "string",
- "description": "Country DART ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "dartId"
- ],
- "response": {
- "$ref": "Country"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.countries.list",
- "path": "userprofiles/{profileId}/countries",
- "httpMethod": "GET",
- "description": "Retrieves a list of countries.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "CountriesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "creativeAssets": {
- "methods": {
- "insert": {
- "id": "dfareporting.creativeAssets.insert",
- "path": "userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets",
- "httpMethod": "POST",
- "description": "Inserts a new creative asset.",
- "parameters": {
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this creative. This is a required field.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "advertiserId"
- ],
- "request": {
- "$ref": "CreativeAssetMetadata"
- },
- "response": {
- "$ref": "CreativeAssetMetadata"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ],
- "supportsMediaUpload": true,
- "mediaUpload": {
- "accept": [
- "*/*"
- ],
- "maxSize": "100MB",
- "protocols": {
- "simple": {
- "multipart": true,
- "path": "/upload/dfareporting/v2.0/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets"
- },
- "resumable": {
- "multipart": true,
- "path": "/resumable/upload/dfareporting/v2.0/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets"
- }
- }
- }
- }
- }
- },
- "creativeFieldValues": {
- "methods": {
- "delete": {
- "id": "dfareporting.creativeFieldValues.delete",
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing creative field value.",
- "parameters": {
- "creativeFieldId": {
- "type": "string",
- "description": "Creative field ID for this creative field value.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "id": {
- "type": "string",
- "description": "Creative Field Value ID",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "creativeFieldId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.creativeFieldValues.get",
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
- "httpMethod": "GET",
- "description": "Gets one creative field value by ID.",
- "parameters": {
- "creativeFieldId": {
- "type": "string",
- "description": "Creative field ID for this creative field value.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "id": {
- "type": "string",
- "description": "Creative Field Value ID",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "creativeFieldId",
- "id"
- ],
- "response": {
- "$ref": "CreativeFieldValue"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.creativeFieldValues.insert",
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- "httpMethod": "POST",
- "description": "Inserts a new creative field value.",
- "parameters": {
- "creativeFieldId": {
- "type": "string",
- "description": "Creative field ID for this creative field value.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "creativeFieldId"
- ],
- "request": {
- "$ref": "CreativeFieldValue"
- },
- "response": {
- "$ref": "CreativeFieldValue"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.creativeFieldValues.list",
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- "httpMethod": "GET",
- "description": "Retrieves a list of creative field values, possibly filtered.",
- "parameters": {
- "creativeFieldId": {
- "type": "string",
- "description": "Creative field ID for this creative field value.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "ids": {
- "type": "string",
- "description": "Select only creative field values with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "VALUE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "creativeFieldId"
- ],
- "response": {
- "$ref": "CreativeFieldValuesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.creativeFieldValues.patch",
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- "httpMethod": "PATCH",
- "description": "Updates an existing creative field value. This method supports patch semantics.",
- "parameters": {
- "creativeFieldId": {
- "type": "string",
- "description": "Creative field ID for this creative field value.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "id": {
- "type": "string",
- "description": "Creative Field Value ID",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "creativeFieldId",
- "id"
- ],
- "request": {
- "$ref": "CreativeFieldValue"
- },
- "response": {
- "$ref": "CreativeFieldValue"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.creativeFieldValues.update",
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- "httpMethod": "PUT",
- "description": "Updates an existing creative field value.",
- "parameters": {
- "creativeFieldId": {
- "type": "string",
- "description": "Creative field ID for this creative field value.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "creativeFieldId"
- ],
- "request": {
- "$ref": "CreativeFieldValue"
- },
- "response": {
- "$ref": "CreativeFieldValue"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "creativeFields": {
- "methods": {
- "delete": {
- "id": "dfareporting.creativeFields.delete",
- "path": "userprofiles/{profileId}/creativeFields/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing creative field.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Creative Field ID",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.creativeFields.get",
- "path": "userprofiles/{profileId}/creativeFields/{id}",
- "httpMethod": "GET",
- "description": "Gets one creative field by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Creative Field ID",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "CreativeField"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.creativeFields.insert",
- "path": "userprofiles/{profileId}/creativeFields",
- "httpMethod": "POST",
- "description": "Inserts a new creative field.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "CreativeField"
- },
- "response": {
- "$ref": "CreativeField"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.creativeFields.list",
- "path": "userprofiles/{profileId}/creativeFields",
- "httpMethod": "GET",
- "description": "Retrieves a list of creative fields, possibly filtered.",
- "parameters": {
- "advertiserIds": {
- "type": "string",
- "description": "Select only creative fields that belong to these advertisers.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only creative fields with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, \"creativefield*2015\" will return creative fields with names like \"creativefield June 2015\", \"creativefield April 2015\", or simply \"creativefield 2015\". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of \"creativefield\" will match creative fields with the name \"my creativefield\", \"creativefield 2015\", or simply \"creativefield\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "CreativeFieldsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.creativeFields.patch",
- "path": "userprofiles/{profileId}/creativeFields",
- "httpMethod": "PATCH",
- "description": "Updates an existing creative field. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Creative Field ID",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "CreativeField"
- },
- "response": {
- "$ref": "CreativeField"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.creativeFields.update",
- "path": "userprofiles/{profileId}/creativeFields",
- "httpMethod": "PUT",
- "description": "Updates an existing creative field.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "CreativeField"
- },
- "response": {
- "$ref": "CreativeField"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "creativeGroups": {
- "methods": {
- "get": {
- "id": "dfareporting.creativeGroups.get",
- "path": "userprofiles/{profileId}/creativeGroups/{id}",
- "httpMethod": "GET",
- "description": "Gets one creative group by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Creative group ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "CreativeGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.creativeGroups.insert",
- "path": "userprofiles/{profileId}/creativeGroups",
- "httpMethod": "POST",
- "description": "Inserts a new creative group.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "CreativeGroup"
- },
- "response": {
- "$ref": "CreativeGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.creativeGroups.list",
- "path": "userprofiles/{profileId}/creativeGroups",
- "httpMethod": "GET",
- "description": "Retrieves a list of creative groups, possibly filtered.",
- "parameters": {
- "advertiserIds": {
- "type": "string",
- "description": "Select only creative groups that belong to these advertisers.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "groupNumber": {
- "type": "integer",
- "description": "Select only creative groups that belong to this subgroup.",
- "format": "int32",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only creative groups with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, \"creativegroup*2015\" will return creative groups with names like \"creativegroup June 2015\", \"creativegroup April 2015\", or simply \"creativegroup 2015\". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of \"creativegroup\" will match creative groups with the name \"my creativegroup\", \"creativegroup 2015\", or simply \"creativegroup\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "CreativeGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.creativeGroups.patch",
- "path": "userprofiles/{profileId}/creativeGroups",
- "httpMethod": "PATCH",
- "description": "Updates an existing creative group. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Creative group ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "CreativeGroup"
- },
- "response": {
- "$ref": "CreativeGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.creativeGroups.update",
- "path": "userprofiles/{profileId}/creativeGroups",
- "httpMethod": "PUT",
- "description": "Updates an existing creative group.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "CreativeGroup"
- },
- "response": {
- "$ref": "CreativeGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "creatives": {
- "methods": {
- "get": {
- "id": "dfareporting.creatives.get",
- "path": "userprofiles/{profileId}/creatives/{id}",
- "httpMethod": "GET",
- "description": "Gets one creative by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Creative ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.creatives.insert",
- "path": "userprofiles/{profileId}/creatives",
- "httpMethod": "POST",
- "description": "Inserts a new creative.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.creatives.list",
- "path": "userprofiles/{profileId}/creatives",
- "httpMethod": "GET",
- "description": "Retrieves a list of creatives, possibly filtered.",
- "parameters": {
- "active": {
- "type": "boolean",
- "description": "Select only active creatives. Leave blank to select active and inactive creatives.",
- "location": "query"
- },
- "advertiserId": {
- "type": "string",
- "description": "Select only creatives with this advertiser ID.",
- "format": "int64",
- "location": "query"
- },
- "archived": {
- "type": "boolean",
- "description": "Select only archived creatives. Leave blank to select archived and unarchived creatives.",
- "location": "query"
- },
- "campaignId": {
- "type": "string",
- "description": "Select only creatives with this campaign ID.",
- "format": "int64",
- "location": "query"
- },
- "companionCreativeIds": {
- "type": "string",
- "description": "Select only in-stream video creatives with these companion IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "creativeFieldIds": {
- "type": "string",
- "description": "Select only creatives with these creative field IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only creatives with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "renderingIds": {
- "type": "string",
- "description": "Select only creatives with these rendering IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"creative*2015\" will return objects with names like \"creative June 2015\", \"creative April 2015\", or simply \"creative 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"creative\" will match objects with name \"my creative\", \"creative 2015\", or simply \"creative\".",
- "location": "query"
- },
- "sizeIds": {
- "type": "string",
- "description": "Select only creatives with these size IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "studioCreativeId": {
- "type": "string",
- "description": "Select only creatives corresponding to this Studio creative ID.",
- "format": "int64",
- "location": "query"
- },
- "types": {
- "type": "string",
- "description": "Select only creatives with these creative types.",
- "enum": [
- "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO",
- "CUSTOM_INPAGE",
- "CUSTOM_INTERSTITIAL",
- "ENHANCED_BANNER",
- "ENHANCED_IMAGE",
- "FLASH_INPAGE",
- "HTML5_BANNER",
- "IMAGE",
- "INSTREAM_VIDEO",
- "INTERNAL_REDIRECT",
- "INTERSTITIAL_INTERNAL_REDIRECT",
- "REDIRECT",
- "RICH_MEDIA_EXPANDING",
- "RICH_MEDIA_IM_EXPAND",
- "RICH_MEDIA_INPAGE",
- "RICH_MEDIA_INPAGE_FLOATING",
- "RICH_MEDIA_INTERSTITIAL_FLOAT",
- "RICH_MEDIA_MOBILE_IN_APP",
- "RICH_MEDIA_MULTI_FLOATING",
- "RICH_MEDIA_PEEL_DOWN",
- "TRACKING_TEXT",
- "VAST_REDIRECT",
- "VPAID_LINEAR",
- "VPAID_NON_LINEAR"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "CreativesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.creatives.patch",
- "path": "userprofiles/{profileId}/creatives",
- "httpMethod": "PATCH",
- "description": "Updates an existing creative. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Creative ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.creatives.update",
- "path": "userprofiles/{profileId}/creatives",
- "httpMethod": "PUT",
- "description": "Updates an existing creative.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "dimensionValues": {
- "methods": {
- "query": {
- "id": "dfareporting.dimensionValues.query",
- "path": "userprofiles/{profileId}/dimensionvalues/query",
- "httpMethod": "POST",
- "description": "Retrieves list of report dimension values for a list of filters.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "DimensionValueRequest"
- },
- "response": {
- "$ref": "DimensionValueList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- },
- "directorySiteContacts": {
- "methods": {
- "get": {
- "id": "dfareporting.directorySiteContacts.get",
- "path": "userprofiles/{profileId}/directorySiteContacts/{id}",
- "httpMethod": "GET",
- "description": "Gets one directory site contact by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Directory site contact ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "DirectorySiteContact"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.directorySiteContacts.list",
- "path": "userprofiles/{profileId}/directorySiteContacts",
- "httpMethod": "GET",
- "description": "Retrieves a list of directory site contacts, possibly filtered.",
- "parameters": {
- "directorySiteIds": {
- "type": "string",
- "description": "Select only directory site contacts with these directory site IDs. This is a required field.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only directory site contacts with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, \"directory site contact*2015\" will return objects with names like \"directory site contact June 2015\", \"directory site contact April 2015\", or simply \"directory site contact 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"directory site contact\" will match objects with name \"my directory site contact\", \"directory site contact 2015\", or simply \"directory site contact\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "DirectorySiteContactsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "directorySites": {
- "methods": {
- "get": {
- "id": "dfareporting.directorySites.get",
- "path": "userprofiles/{profileId}/directorySites/{id}",
- "httpMethod": "GET",
- "description": "Gets one directory site by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Directory site ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "DirectorySite"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.directorySites.list",
- "path": "userprofiles/{profileId}/directorySites",
- "httpMethod": "GET",
- "description": "Retrieves a list of directory sites, possibly filtered.",
- "parameters": {
- "acceptsInStreamVideoPlacements": {
- "type": "boolean",
- "description": "This search filter is no longer supported and will have no effect on the results returned.",
- "location": "query"
- },
- "acceptsInterstitialPlacements": {
- "type": "boolean",
- "description": "This search filter is no longer supported and will have no effect on the results returned.",
- "location": "query"
- },
- "acceptsPublisherPaidPlacements": {
- "type": "boolean",
- "description": "Select only directory sites that accept publisher paid placements. This field can be left blank.",
- "location": "query"
- },
- "active": {
- "type": "boolean",
- "description": "Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.",
- "location": "query"
- },
- "countryId": {
- "type": "string",
- "description": "Select only directory sites with this country ID.",
- "format": "int64",
- "location": "query"
- },
- "dfp_network_code": {
- "type": "string",
- "description": "Select only directory sites with this DFP network code.",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only directory sites with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "parentId": {
- "type": "string",
- "description": "Select only directory sites with this parent ID.",
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, \"directory site*2015\" will return objects with names like \"directory site June 2015\", \"directory site April 2015\", or simply \"directory site 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"directory site\" will match objects with name \"my directory site\", \"directory site 2015\" or simply, \"directory site\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "DirectorySitesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "eventTags": {
- "methods": {
- "delete": {
- "id": "dfareporting.eventTags.delete",
- "path": "userprofiles/{profileId}/eventTags/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing event tag.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Event tag ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.eventTags.get",
- "path": "userprofiles/{profileId}/eventTags/{id}",
- "httpMethod": "GET",
- "description": "Gets one event tag by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Event tag ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "EventTag"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.eventTags.insert",
- "path": "userprofiles/{profileId}/eventTags",
- "httpMethod": "POST",
- "description": "Inserts a new event tag.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "EventTag"
- },
- "response": {
- "$ref": "EventTag"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.eventTags.list",
- "path": "userprofiles/{profileId}/eventTags",
- "httpMethod": "GET",
- "description": "Retrieves a list of event tags, possibly filtered.",
- "parameters": {
- "adId": {
- "type": "string",
- "description": "Select only event tags that belong to this ad.",
- "format": "int64",
- "location": "query"
- },
- "advertiserId": {
- "type": "string",
- "description": "Select only event tags that belong to this advertiser.",
- "format": "int64",
- "location": "query"
- },
- "campaignId": {
- "type": "string",
- "description": "Select only event tags that belong to this campaign.",
- "format": "int64",
- "location": "query"
- },
- "definitionsOnly": {
- "type": "boolean",
- "description": "Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.",
- "location": "query"
- },
- "enabled": {
- "type": "boolean",
- "description": "Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.",
- "location": "query"
- },
- "eventTagTypes": {
- "type": "string",
- "description": "Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking.",
- "enum": [
- "CLICK_THROUGH_EVENT_TAG",
- "IMPRESSION_IMAGE_EVENT_TAG",
- "IMPRESSION_JAVASCRIPT_EVENT_TAG"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only event tags with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"eventtag*2015\" will return objects with names like \"eventtag June 2015\", \"eventtag April 2015\", or simply \"eventtag 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"eventtag\" will match objects with name \"my eventtag\", \"eventtag 2015\", or simply \"eventtag\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "EventTagsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.eventTags.patch",
- "path": "userprofiles/{profileId}/eventTags",
- "httpMethod": "PATCH",
- "description": "Updates an existing event tag. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Event tag ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "EventTag"
- },
- "response": {
- "$ref": "EventTag"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.eventTags.update",
- "path": "userprofiles/{profileId}/eventTags",
- "httpMethod": "PUT",
- "description": "Updates an existing event tag.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "EventTag"
- },
- "response": {
- "$ref": "EventTag"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "files": {
- "methods": {
- "get": {
- "id": "dfareporting.files.get",
- "path": "reports/{reportId}/files/{fileId}",
- "httpMethod": "GET",
- "description": "Retrieves a report file by its report ID and file ID.",
- "parameters": {
- "fileId": {
- "type": "string",
- "description": "The ID of the report file.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "reportId",
- "fileId"
- ],
- "response": {
- "$ref": "File"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ],
- "supportsMediaDownload": true
- },
- "list": {
- "id": "dfareporting.files.list",
- "path": "userprofiles/{profileId}/files",
- "httpMethod": "GET",
- "description": "Lists files for a user profile.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "scope": {
- "type": "string",
- "description": "The scope that defines which results are returned, default is 'MINE'.",
- "default": "MINE",
- "enum": [
- "ALL",
- "MINE",
- "SHARED_WITH_ME"
- ],
- "enumDescriptions": [
- "All files in account.",
- "My files.",
- "Files shared with me."
- ],
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "The field by which to sort the list.",
- "default": "LAST_MODIFIED_TIME",
- "enum": [
- "ID",
- "LAST_MODIFIED_TIME"
- ],
- "enumDescriptions": [
- "Sort by file ID.",
- "Sort by 'lastmodifiedAt' field."
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is 'DESCENDING'.",
- "default": "DESCENDING",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "FileList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- },
- "floodlightActivities": {
- "methods": {
- "delete": {
- "id": "dfareporting.floodlightActivities.delete",
- "path": "userprofiles/{profileId}/floodlightActivities/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing floodlight activity.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Floodlight activity ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "generatetag": {
- "id": "dfareporting.floodlightActivities.generatetag",
- "path": "userprofiles/{profileId}/floodlightActivities/generatetag",
- "httpMethod": "POST",
- "description": "Generates a tag for a floodlight activity.",
- "parameters": {
- "floodlightActivityId": {
- "type": "string",
- "description": "Floodlight activity ID for which we want to generate a tag.",
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "FloodlightActivitiesGenerateTagResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.floodlightActivities.get",
- "path": "userprofiles/{profileId}/floodlightActivities/{id}",
- "httpMethod": "GET",
- "description": "Gets one floodlight activity by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Floodlight activity ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "FloodlightActivity"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.floodlightActivities.insert",
- "path": "userprofiles/{profileId}/floodlightActivities",
- "httpMethod": "POST",
- "description": "Inserts a new floodlight activity.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "FloodlightActivity"
- },
- "response": {
- "$ref": "FloodlightActivity"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.floodlightActivities.list",
- "path": "userprofiles/{profileId}/floodlightActivities",
- "httpMethod": "GET",
- "description": "Retrieves a list of floodlight activities, possibly filtered.",
- "parameters": {
- "advertiserId": {
- "type": "string",
- "description": "Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "location": "query"
- },
- "floodlightActivityGroupIds": {
- "type": "string",
- "description": "Select only floodlight activities with the specified floodlight activity group IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "floodlightActivityGroupName": {
- "type": "string",
- "description": "Select only floodlight activities with the specified floodlight activity group name.",
- "location": "query"
- },
- "floodlightActivityGroupTagString": {
- "type": "string",
- "description": "Select only floodlight activities with the specified floodlight activity group tag string.",
- "location": "query"
- },
- "floodlightActivityGroupType": {
- "type": "string",
- "description": "Select only floodlight activities with the specified floodlight activity group type.",
- "enum": [
- "COUNTER",
- "SALE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "floodlightConfigurationId": {
- "type": "string",
- "description": "Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"floodlightactivity*2015\" will return objects with names like \"floodlightactivity June 2015\", \"floodlightactivity April 2015\", or simply \"floodlightactivity 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"floodlightactivity\" will match objects with name \"my floodlightactivity activity\", \"floodlightactivity 2015\", or simply \"floodlightactivity\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "tagString": {
- "type": "string",
- "description": "Select only floodlight activities with the specified tag string.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "FloodlightActivitiesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.floodlightActivities.patch",
- "path": "userprofiles/{profileId}/floodlightActivities",
- "httpMethod": "PATCH",
- "description": "Updates an existing floodlight activity. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Floodlight activity ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "FloodlightActivity"
- },
- "response": {
- "$ref": "FloodlightActivity"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.floodlightActivities.update",
- "path": "userprofiles/{profileId}/floodlightActivities",
- "httpMethod": "PUT",
- "description": "Updates an existing floodlight activity.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "FloodlightActivity"
- },
- "response": {
- "$ref": "FloodlightActivity"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "floodlightActivityGroups": {
- "methods": {
- "delete": {
- "id": "dfareporting.floodlightActivityGroups.delete",
- "path": "userprofiles/{profileId}/floodlightActivityGroups/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing floodlight activity group.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Floodlight activity Group ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.floodlightActivityGroups.get",
- "path": "userprofiles/{profileId}/floodlightActivityGroups/{id}",
- "httpMethod": "GET",
- "description": "Gets one floodlight activity group by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Floodlight activity Group ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "FloodlightActivityGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.floodlightActivityGroups.insert",
- "path": "userprofiles/{profileId}/floodlightActivityGroups",
- "httpMethod": "POST",
- "description": "Inserts a new floodlight activity group.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "FloodlightActivityGroup"
- },
- "response": {
- "$ref": "FloodlightActivityGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.floodlightActivityGroups.list",
- "path": "userprofiles/{profileId}/floodlightActivityGroups",
- "httpMethod": "GET",
- "description": "Retrieves a list of floodlight activity groups, possibly filtered.",
- "parameters": {
- "advertiserId": {
- "type": "string",
- "description": "Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "location": "query"
- },
- "floodlightConfigurationId": {
- "type": "string",
- "description": "Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"floodlightactivitygroup*2015\" will return objects with names like \"floodlightactivitygroup June 2015\", \"floodlightactivitygroup April 2015\", or simply \"floodlightactivitygroup 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"floodlightactivitygroup\" will match objects with name \"my floodlightactivitygroup activity\", \"floodlightactivitygroup 2015\", or simply \"floodlightactivitygroup\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "type": {
- "type": "string",
- "description": "Select only floodlight activity groups with the specified floodlight activity group type.",
- "enum": [
- "COUNTER",
- "SALE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "FloodlightActivityGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.floodlightActivityGroups.patch",
- "path": "userprofiles/{profileId}/floodlightActivityGroups",
- "httpMethod": "PATCH",
- "description": "Updates an existing floodlight activity group. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Floodlight activity Group ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "FloodlightActivityGroup"
- },
- "response": {
- "$ref": "FloodlightActivityGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.floodlightActivityGroups.update",
- "path": "userprofiles/{profileId}/floodlightActivityGroups",
- "httpMethod": "PUT",
- "description": "Updates an existing floodlight activity group.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "FloodlightActivityGroup"
- },
- "response": {
- "$ref": "FloodlightActivityGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "floodlightConfigurations": {
- "methods": {
- "get": {
- "id": "dfareporting.floodlightConfigurations.get",
- "path": "userprofiles/{profileId}/floodlightConfigurations/{id}",
- "httpMethod": "GET",
- "description": "Gets one floodlight configuration by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Floodlight configuration ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "FloodlightConfiguration"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.floodlightConfigurations.list",
- "path": "userprofiles/{profileId}/floodlightConfigurations",
- "httpMethod": "GET",
- "description": "Retrieves a list of floodlight configurations, possibly filtered.",
- "parameters": {
- "ids": {
- "type": "string",
- "description": "Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "FloodlightConfigurationsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.floodlightConfigurations.patch",
- "path": "userprofiles/{profileId}/floodlightConfigurations",
- "httpMethod": "PATCH",
- "description": "Updates an existing floodlight configuration. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Floodlight configuration ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "FloodlightConfiguration"
- },
- "response": {
- "$ref": "FloodlightConfiguration"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.floodlightConfigurations.update",
- "path": "userprofiles/{profileId}/floodlightConfigurations",
- "httpMethod": "PUT",
- "description": "Updates an existing floodlight configuration.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "FloodlightConfiguration"
- },
- "response": {
- "$ref": "FloodlightConfiguration"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "landingPages": {
- "methods": {
- "delete": {
- "id": "dfareporting.landingPages.delete",
- "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing campaign landing page.",
- "parameters": {
- "campaignId": {
- "type": "string",
- "description": "Landing page campaign ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "id": {
- "type": "string",
- "description": "Landing page ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "campaignId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.landingPages.get",
- "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages/{id}",
- "httpMethod": "GET",
- "description": "Gets one campaign landing page by ID.",
- "parameters": {
- "campaignId": {
- "type": "string",
- "description": "Landing page campaign ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "id": {
- "type": "string",
- "description": "Landing page ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "campaignId",
- "id"
- ],
- "response": {
- "$ref": "LandingPage"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.landingPages.insert",
- "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages",
- "httpMethod": "POST",
- "description": "Inserts a new landing page for the specified campaign.",
- "parameters": {
- "campaignId": {
- "type": "string",
- "description": "Landing page campaign ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "campaignId"
- ],
- "request": {
- "$ref": "LandingPage"
- },
- "response": {
- "$ref": "LandingPage"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.landingPages.list",
- "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages",
- "httpMethod": "GET",
- "description": "Retrieves the list of landing pages for the specified campaign.",
- "parameters": {
- "campaignId": {
- "type": "string",
- "description": "Landing page campaign ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "campaignId"
- ],
- "response": {
- "$ref": "LandingPagesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.landingPages.patch",
- "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages",
- "httpMethod": "PATCH",
- "description": "Updates an existing campaign landing page. This method supports patch semantics.",
- "parameters": {
- "campaignId": {
- "type": "string",
- "description": "Landing page campaign ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "id": {
- "type": "string",
- "description": "Landing page ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "campaignId",
- "id"
- ],
- "request": {
- "$ref": "LandingPage"
- },
- "response": {
- "$ref": "LandingPage"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.landingPages.update",
- "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages",
- "httpMethod": "PUT",
- "description": "Updates an existing campaign landing page.",
- "parameters": {
- "campaignId": {
- "type": "string",
- "description": "Landing page campaign ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "campaignId"
- ],
- "request": {
- "$ref": "LandingPage"
- },
- "response": {
- "$ref": "LandingPage"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "metros": {
- "methods": {
- "list": {
- "id": "dfareporting.metros.list",
- "path": "userprofiles/{profileId}/metros",
- "httpMethod": "GET",
- "description": "Retrieves a list of metros.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "MetrosListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "mobileCarriers": {
- "methods": {
- "list": {
- "id": "dfareporting.mobileCarriers.list",
- "path": "userprofiles/{profileId}/mobileCarriers",
- "httpMethod": "GET",
- "description": "Retrieves a list of mobile carriers.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "MobileCarriersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "operatingSystemVersions": {
- "methods": {
- "list": {
- "id": "dfareporting.operatingSystemVersions.list",
- "path": "userprofiles/{profileId}/operatingSystemVersions",
- "httpMethod": "GET",
- "description": "Retrieves a list of operating system versions.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "OperatingSystemVersionsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "operatingSystems": {
- "methods": {
- "list": {
- "id": "dfareporting.operatingSystems.list",
- "path": "userprofiles/{profileId}/operatingSystems",
- "httpMethod": "GET",
- "description": "Retrieves a list of operating systems.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "OperatingSystemsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "placementGroups": {
- "methods": {
- "get": {
- "id": "dfareporting.placementGroups.get",
- "path": "userprofiles/{profileId}/placementGroups/{id}",
- "httpMethod": "GET",
- "description": "Gets one placement group by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Placement group ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "PlacementGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.placementGroups.insert",
- "path": "userprofiles/{profileId}/placementGroups",
- "httpMethod": "POST",
- "description": "Inserts a new placement group.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "PlacementGroup"
- },
- "response": {
- "$ref": "PlacementGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.placementGroups.list",
- "path": "userprofiles/{profileId}/placementGroups",
- "httpMethod": "GET",
- "description": "Retrieves a list of placement groups, possibly filtered.",
- "parameters": {
- "advertiserIds": {
- "type": "string",
- "description": "Select only placement groups that belong to these advertisers.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "archived": {
- "type": "boolean",
- "description": "Select only archived placements. Don't set this field to select both archived and non-archived placements.",
- "location": "query"
- },
- "campaignIds": {
- "type": "string",
- "description": "Select only placement groups that belong to these campaigns.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "contentCategoryIds": {
- "type": "string",
- "description": "Select only placement groups that are associated with these content categories.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "directorySiteIds": {
- "type": "string",
- "description": "Select only placement groups that are associated with these directory sites.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only placement groups with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "placementGroupType": {
- "type": "string",
- "description": "Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.",
- "enum": [
- "PLACEMENT_PACKAGE",
- "PLACEMENT_ROADBLOCK"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "placementStrategyIds": {
- "type": "string",
- "description": "Select only placement groups that are associated with these placement strategies.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "pricingTypes": {
- "type": "string",
- "description": "Select only placement groups with these pricing types.",
- "enum": [
- "PRICING_TYPE_CPA",
- "PRICING_TYPE_CPC",
- "PRICING_TYPE_CPM",
- "PRICING_TYPE_FLAT_RATE_CLICKS",
- "PRICING_TYPE_FLAT_RATE_IMPRESSIONS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, \"placement*2015\" will return placement groups with names like \"placement group June 2015\", \"placement group May 2015\", or simply \"placements 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placementgroup\" will match placement groups with name \"my placementgroup\", \"placementgroup 2015\", or simply \"placementgroup\".",
- "location": "query"
- },
- "siteIds": {
- "type": "string",
- "description": "Select only placement groups that are associated with these sites.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "PlacementGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.placementGroups.patch",
- "path": "userprofiles/{profileId}/placementGroups",
- "httpMethod": "PATCH",
- "description": "Updates an existing placement group. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Placement group ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "PlacementGroup"
- },
- "response": {
- "$ref": "PlacementGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.placementGroups.update",
- "path": "userprofiles/{profileId}/placementGroups",
- "httpMethod": "PUT",
- "description": "Updates an existing placement group.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "PlacementGroup"
- },
- "response": {
- "$ref": "PlacementGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "placementStrategies": {
- "methods": {
- "delete": {
- "id": "dfareporting.placementStrategies.delete",
- "path": "userprofiles/{profileId}/placementStrategies/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing placement strategy.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Placement strategy ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.placementStrategies.get",
- "path": "userprofiles/{profileId}/placementStrategies/{id}",
- "httpMethod": "GET",
- "description": "Gets one placement strategy by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Placement strategy ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "PlacementStrategy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.placementStrategies.insert",
- "path": "userprofiles/{profileId}/placementStrategies",
- "httpMethod": "POST",
- "description": "Inserts a new placement strategy.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "PlacementStrategy"
- },
- "response": {
- "$ref": "PlacementStrategy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.placementStrategies.list",
- "path": "userprofiles/{profileId}/placementStrategies",
- "httpMethod": "GET",
- "description": "Retrieves a list of placement strategies, possibly filtered.",
- "parameters": {
- "ids": {
- "type": "string",
- "description": "Select only placement strategies with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"placementstrategy*2015\" will return objects with names like \"placementstrategy June 2015\", \"placementstrategy April 2015\", or simply \"placementstrategy 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placementstrategy\" will match objects with name \"my placementstrategy\", \"placementstrategy 2015\", or simply \"placementstrategy\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "PlacementStrategiesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.placementStrategies.patch",
- "path": "userprofiles/{profileId}/placementStrategies",
- "httpMethod": "PATCH",
- "description": "Updates an existing placement strategy. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Placement strategy ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "PlacementStrategy"
- },
- "response": {
- "$ref": "PlacementStrategy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.placementStrategies.update",
- "path": "userprofiles/{profileId}/placementStrategies",
- "httpMethod": "PUT",
- "description": "Updates an existing placement strategy.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "PlacementStrategy"
- },
- "response": {
- "$ref": "PlacementStrategy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "placements": {
- "methods": {
- "generatetags": {
- "id": "dfareporting.placements.generatetags",
- "path": "userprofiles/{profileId}/placements/generatetags",
- "httpMethod": "POST",
- "description": "Generates tags for a placement.",
- "parameters": {
- "campaignId": {
- "type": "string",
- "description": "Generate placements belonging to this campaign. This is a required field.",
- "format": "int64",
- "location": "query"
- },
- "placementIds": {
- "type": "string",
- "description": "Generate tags for these placements.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "tagFormats": {
- "type": "string",
- "description": "Tag formats to generate for these placements.",
- "enum": [
- "PLACEMENT_TAG_CLICK_COMMANDS",
- "PLACEMENT_TAG_IFRAME_ILAYER",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
- "PLACEMENT_TAG_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_JAVASCRIPT",
- "PLACEMENT_TAG_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_STANDARD",
- "PLACEMENT_TAG_TRACKING",
- "PLACEMENT_TAG_TRACKING_IFRAME",
- "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "PlacementsGenerateTagsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.placements.get",
- "path": "userprofiles/{profileId}/placements/{id}",
- "httpMethod": "GET",
- "description": "Gets one placement by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Placement ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Placement"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.placements.insert",
- "path": "userprofiles/{profileId}/placements",
- "httpMethod": "POST",
- "description": "Inserts a new placement.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Placement"
- },
- "response": {
- "$ref": "Placement"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.placements.list",
- "path": "userprofiles/{profileId}/placements",
- "httpMethod": "GET",
- "description": "Retrieves a list of placements, possibly filtered.",
- "parameters": {
- "advertiserIds": {
- "type": "string",
- "description": "Select only placements that belong to these advertisers.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "archived": {
- "type": "boolean",
- "description": "Select only archived placements. Don't set this field to select both archived and non-archived placements.",
- "location": "query"
- },
- "campaignIds": {
- "type": "string",
- "description": "Select only placements that belong to these campaigns.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "compatibilities": {
- "type": "string",
- "description": "Select only placements that are associated with these compatibilities. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.",
- "enum": [
- "APP",
- "APP_INTERSTITIAL",
- "IN_STREAM_VIDEO",
- "WEB",
- "WEB_INTERSTITIAL"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- },
- "contentCategoryIds": {
- "type": "string",
- "description": "Select only placements that are associated with these content categories.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "directorySiteIds": {
- "type": "string",
- "description": "Select only placements that are associated with these directory sites.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "groupIds": {
- "type": "string",
- "description": "Select only placements that belong to these placement groups.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only placements with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "paymentSource": {
- "type": "string",
- "description": "Select only placements with this payment source.",
- "enum": [
- "PLACEMENT_AGENCY_PAID",
- "PLACEMENT_PUBLISHER_PAID"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "placementStrategyIds": {
- "type": "string",
- "description": "Select only placements that are associated with these placement strategies.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "pricingTypes": {
- "type": "string",
- "description": "Select only placements with these pricing types.",
- "enum": [
- "PRICING_TYPE_CPA",
- "PRICING_TYPE_CPC",
- "PRICING_TYPE_CPM",
- "PRICING_TYPE_FLAT_RATE_CLICKS",
- "PRICING_TYPE_FLAT_RATE_IMPRESSIONS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, \"placement*2015\" will return placements with names like \"placement June 2015\", \"placement May 2015\", or simply \"placements 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placement\" will match placements with name \"my placement\", \"placement 2015\", or simply \"placement\".",
- "location": "query"
- },
- "siteIds": {
- "type": "string",
- "description": "Select only placements that are associated with these sites.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "sizeIds": {
- "type": "string",
- "description": "Select only placements that are associated with these sizes.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "PlacementsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.placements.patch",
- "path": "userprofiles/{profileId}/placements",
- "httpMethod": "PATCH",
- "description": "Updates an existing placement. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Placement ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "Placement"
- },
- "response": {
- "$ref": "Placement"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.placements.update",
- "path": "userprofiles/{profileId}/placements",
- "httpMethod": "PUT",
- "description": "Updates an existing placement.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Placement"
- },
- "response": {
- "$ref": "Placement"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "platformTypes": {
- "methods": {
- "list": {
- "id": "dfareporting.platformTypes.list",
- "path": "userprofiles/{profileId}/platformTypes",
- "httpMethod": "GET",
- "description": "Retrieves a list of platform types.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "PlatformTypesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "postalCodes": {
- "methods": {
- "list": {
- "id": "dfareporting.postalCodes.list",
- "path": "userprofiles/{profileId}/postalCodes",
- "httpMethod": "GET",
- "description": "Retrieves a list of postal codes.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "PostalCodesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "regions": {
- "methods": {
- "list": {
- "id": "dfareporting.regions.list",
- "path": "userprofiles/{profileId}/regions",
- "httpMethod": "GET",
- "description": "Retrieves a list of regions.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "RegionsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "reports": {
- "methods": {
- "delete": {
- "id": "dfareporting.reports.delete",
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "DELETE",
- "description": "Deletes a report by its ID.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "get": {
- "id": "dfareporting.reports.get",
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "GET",
- "description": "Retrieves a report by its ID.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "insert": {
- "id": "dfareporting.reports.insert",
- "path": "userprofiles/{profileId}/reports",
- "httpMethod": "POST",
- "description": "Creates a report.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "list": {
- "id": "dfareporting.reports.list",
- "path": "userprofiles/{profileId}/reports",
- "httpMethod": "GET",
- "description": "Retrieves list of reports.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "scope": {
- "type": "string",
- "description": "The scope that defines which results are returned, default is 'MINE'.",
- "default": "MINE",
- "enum": [
- "ALL",
- "MINE"
- ],
- "enumDescriptions": [
- "All reports in account.",
- "My reports."
- ],
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "The field by which to sort the list.",
- "default": "LAST_MODIFIED_TIME",
- "enum": [
- "ID",
- "LAST_MODIFIED_TIME",
- "NAME"
- ],
- "enumDescriptions": [
- "Sort by report ID.",
- "Sort by 'lastModifiedTime' field.",
- "Sort by name of reports."
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is 'DESCENDING'.",
- "default": "DESCENDING",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "ReportList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "patch": {
- "id": "dfareporting.reports.patch",
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "PATCH",
- "description": "Updates a report. This method supports patch semantics.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "run": {
- "id": "dfareporting.reports.run",
- "path": "userprofiles/{profileId}/reports/{reportId}/run",
- "httpMethod": "POST",
- "description": "Runs a report.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "synchronous": {
- "type": "boolean",
- "description": "If set and true, tries to run the report synchronously.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "response": {
- "$ref": "File"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "update": {
- "id": "dfareporting.reports.update",
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "PUT",
- "description": "Updates a report.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- },
- "resources": {
- "compatibleFields": {
- "methods": {
- "query": {
- "id": "dfareporting.reports.compatibleFields.query",
- "path": "userprofiles/{profileId}/reports/compatiblefields/query",
- "httpMethod": "POST",
- "description": "Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "CompatibleFields"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- },
- "files": {
- "methods": {
- "get": {
- "id": "dfareporting.reports.files.get",
- "path": "userprofiles/{profileId}/reports/{reportId}/files/{fileId}",
- "httpMethod": "GET",
- "description": "Retrieves a report file.",
- "parameters": {
- "fileId": {
- "type": "string",
- "description": "The ID of the report file.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId",
- "fileId"
- ],
- "response": {
- "$ref": "File"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ],
- "supportsMediaDownload": true
- },
- "list": {
- "id": "dfareporting.reports.files.list",
- "path": "userprofiles/{profileId}/reports/{reportId}/files",
- "httpMethod": "GET",
- "description": "Lists files for a report.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the parent report.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "sortField": {
- "type": "string",
- "description": "The field by which to sort the list.",
- "default": "LAST_MODIFIED_TIME",
- "enum": [
- "ID",
- "LAST_MODIFIED_TIME"
- ],
- "enumDescriptions": [
- "Sort by file ID.",
- "Sort by 'lastmodifiedAt' field."
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is 'DESCENDING'.",
- "default": "DESCENDING",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "response": {
- "$ref": "FileList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- }
- }
- },
- "sites": {
- "methods": {
- "get": {
- "id": "dfareporting.sites.get",
- "path": "userprofiles/{profileId}/sites/{id}",
- "httpMethod": "GET",
- "description": "Gets one site by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Site ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Site"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.sites.insert",
- "path": "userprofiles/{profileId}/sites",
- "httpMethod": "POST",
- "description": "Inserts a new site.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Site"
- },
- "response": {
- "$ref": "Site"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.sites.list",
- "path": "userprofiles/{profileId}/sites",
- "httpMethod": "GET",
- "description": "Retrieves a list of sites, possibly filtered.",
- "parameters": {
- "acceptsInStreamVideoPlacements": {
- "type": "boolean",
- "description": "This search filter is no longer supported and will have no effect on the results returned.",
- "location": "query"
- },
- "acceptsInterstitialPlacements": {
- "type": "boolean",
- "description": "This search filter is no longer supported and will have no effect on the results returned.",
- "location": "query"
- },
- "acceptsPublisherPaidPlacements": {
- "type": "boolean",
- "description": "Select only sites that accept publisher paid placements.",
- "location": "query"
- },
- "adWordsSite": {
- "type": "boolean",
- "description": "Select only AdWords sites.",
- "location": "query"
- },
- "approved": {
- "type": "boolean",
- "description": "Select only approved sites.",
- "location": "query"
- },
- "campaignIds": {
- "type": "string",
- "description": "Select only sites with these campaign IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "directorySiteIds": {
- "type": "string",
- "description": "Select only sites with these directory site IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only sites with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, \"site*2015\" will return objects with names like \"site June 2015\", \"site April 2015\", or simply \"site 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"site\" will match objects with name \"my site\", \"site 2015\", or simply \"site\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "subaccountId": {
- "type": "string",
- "description": "Select only sites with this subaccount ID.",
- "format": "int64",
- "location": "query"
- },
- "unmappedSite": {
- "type": "boolean",
- "description": "Select only sites that have not been mapped to a directory site.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "SitesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.sites.patch",
- "path": "userprofiles/{profileId}/sites",
- "httpMethod": "PATCH",
- "description": "Updates an existing site. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Site ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "Site"
- },
- "response": {
- "$ref": "Site"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.sites.update",
- "path": "userprofiles/{profileId}/sites",
- "httpMethod": "PUT",
- "description": "Updates an existing site.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Site"
- },
- "response": {
- "$ref": "Site"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "sizes": {
- "methods": {
- "get": {
- "id": "dfareporting.sizes.get",
- "path": "userprofiles/{profileId}/sizes/{id}",
- "httpMethod": "GET",
- "description": "Gets one size by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Size ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Size"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.sizes.insert",
- "path": "userprofiles/{profileId}/sizes",
- "httpMethod": "POST",
- "description": "Inserts a new size.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Size"
- },
- "response": {
- "$ref": "Size"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.sizes.list",
- "path": "userprofiles/{profileId}/sizes",
- "httpMethod": "GET",
- "description": "Retrieves a list of sizes, possibly filtered.",
- "parameters": {
- "height": {
- "type": "integer",
- "description": "Select only sizes with this height.",
- "format": "int32",
- "location": "query"
- },
- "iabStandard": {
- "type": "boolean",
- "description": "Select only IAB standard sizes.",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only sizes with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "width": {
- "type": "integer",
- "description": "Select only sizes with this width.",
- "format": "int32",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "SizesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "subaccounts": {
- "methods": {
- "get": {
- "id": "dfareporting.subaccounts.get",
- "path": "userprofiles/{profileId}/subaccounts/{id}",
- "httpMethod": "GET",
- "description": "Gets one subaccount by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Subaccount ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Subaccount"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.subaccounts.insert",
- "path": "userprofiles/{profileId}/subaccounts",
- "httpMethod": "POST",
- "description": "Inserts a new subaccount.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Subaccount"
- },
- "response": {
- "$ref": "Subaccount"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.subaccounts.list",
- "path": "userprofiles/{profileId}/subaccounts",
- "httpMethod": "GET",
- "description": "Gets a list of subaccounts, possibly filtered.",
- "parameters": {
- "ids": {
- "type": "string",
- "description": "Select only subaccounts with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"subaccount*2015\" will return objects with names like \"subaccount June 2015\", \"subaccount April 2015\", or simply \"subaccount 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"subaccount\" will match objects with name \"my subaccount\", \"subaccount 2015\", or simply \"subaccount\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "SubaccountsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.subaccounts.patch",
- "path": "userprofiles/{profileId}/subaccounts",
- "httpMethod": "PATCH",
- "description": "Updates an existing subaccount. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Subaccount ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "Subaccount"
- },
- "response": {
- "$ref": "Subaccount"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.subaccounts.update",
- "path": "userprofiles/{profileId}/subaccounts",
- "httpMethod": "PUT",
- "description": "Updates an existing subaccount.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Subaccount"
- },
- "response": {
- "$ref": "Subaccount"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "userProfiles": {
- "methods": {
- "get": {
- "id": "dfareporting.userProfiles.get",
- "path": "userprofiles/{profileId}",
- "httpMethod": "GET",
- "description": "Gets one user profile by ID.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "UserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting",
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.userProfiles.list",
- "path": "userprofiles",
- "httpMethod": "GET",
- "description": "Retrieves list of user profiles for a user.",
- "response": {
- "$ref": "UserProfileList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting",
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "userRolePermissionGroups": {
- "methods": {
- "get": {
- "id": "dfareporting.userRolePermissionGroups.get",
- "path": "userprofiles/{profileId}/userRolePermissionGroups/{id}",
- "httpMethod": "GET",
- "description": "Gets one user role permission group by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "User role permission group ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "UserRolePermissionGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.userRolePermissionGroups.list",
- "path": "userprofiles/{profileId}/userRolePermissionGroups",
- "httpMethod": "GET",
- "description": "Gets a list of all supported user role permission groups.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "UserRolePermissionGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "userRolePermissions": {
- "methods": {
- "get": {
- "id": "dfareporting.userRolePermissions.get",
- "path": "userprofiles/{profileId}/userRolePermissions/{id}",
- "httpMethod": "GET",
- "description": "Gets one user role permission by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "User role permission ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "UserRolePermission"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.userRolePermissions.list",
- "path": "userprofiles/{profileId}/userRolePermissions",
- "httpMethod": "GET",
- "description": "Gets a list of user role permissions, possibly filtered.",
- "parameters": {
- "ids": {
- "type": "string",
- "description": "Select only user role permissions with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "UserRolePermissionsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "userRoles": {
- "methods": {
- "delete": {
- "id": "dfareporting.userRoles.delete",
- "path": "userprofiles/{profileId}/userRoles/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing user role.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "User role ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.userRoles.get",
- "path": "userprofiles/{profileId}/userRoles/{id}",
- "httpMethod": "GET",
- "description": "Gets one user role by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "User role ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "UserRole"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.userRoles.insert",
- "path": "userprofiles/{profileId}/userRoles",
- "httpMethod": "POST",
- "description": "Inserts a new user role.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "UserRole"
- },
- "response": {
- "$ref": "UserRole"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.userRoles.list",
- "path": "userprofiles/{profileId}/userRoles",
- "httpMethod": "GET",
- "description": "Retrieves a list of user roles, possibly filtered.",
- "parameters": {
- "accountUserRoleOnly": {
- "type": "boolean",
- "description": "Select only account level user roles not associated with any specific subaccount.",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only user roles with the specified IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"userrole*2015\" will return objects with names like \"userrole June 2015\", \"userrole April 2015\", or simply \"userrole 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"userrole\" will match objects with name \"my userrole\", \"userrole 2015\", or simply \"userrole\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "subaccountId": {
- "type": "string",
- "description": "Select only user roles that belong to this subaccount.",
- "format": "int64",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "UserRolesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.userRoles.patch",
- "path": "userprofiles/{profileId}/userRoles",
- "httpMethod": "PATCH",
- "description": "Updates an existing user role. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "User role ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "UserRole"
- },
- "response": {
- "$ref": "UserRole"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.userRoles.update",
- "path": "userprofiles/{profileId}/userRoles",
- "httpMethod": "PUT",
- "description": "Updates an existing user role.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "UserRole"
- },
- "response": {
- "$ref": "UserRole"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/dfareporting/v2.0/dfareporting-gen.go b/vendor/google.golang.org/api/dfareporting/v2.0/dfareporting-gen.go
deleted file mode 100644
index f1bdda55..00000000
--- a/vendor/google.golang.org/api/dfareporting/v2.0/dfareporting-gen.go
+++ /dev/null
@@ -1,36804 +0,0 @@
-// Package dfareporting provides access to the DCM/DFA Reporting And Trafficking API.
-//
-// See https://developers.google.com/doubleclick-advertisers/reporting/
-//
-// Usage example:
-//
-// import "google.golang.org/api/dfareporting/v2.0"
-// ...
-// dfareportingService, err := dfareporting.New(oauthHttpClient)
-package dfareporting // import "google.golang.org/api/dfareporting/v2.0"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "dfareporting:v2.0"
-const apiName = "dfareporting"
-const apiVersion = "v2.0"
-const basePath = "https://www.googleapis.com/dfareporting/v2.0/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage DoubleClick for Advertisers reports
- DfareportingScope = "https://www.googleapis.com/auth/dfareporting"
-
- // View and manage your DoubleClick Campaign Manager's (DCM) display ad
- // campaigns
- DfatraffickingScope = "https://www.googleapis.com/auth/dfatrafficking"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.AccountActiveAdSummaries = NewAccountActiveAdSummariesService(s)
- s.AccountPermissionGroups = NewAccountPermissionGroupsService(s)
- s.AccountPermissions = NewAccountPermissionsService(s)
- s.AccountUserProfiles = NewAccountUserProfilesService(s)
- s.Accounts = NewAccountsService(s)
- s.Ads = NewAdsService(s)
- s.AdvertiserGroups = NewAdvertiserGroupsService(s)
- s.Advertisers = NewAdvertisersService(s)
- s.Browsers = NewBrowsersService(s)
- s.CampaignCreativeAssociations = NewCampaignCreativeAssociationsService(s)
- s.Campaigns = NewCampaignsService(s)
- s.ChangeLogs = NewChangeLogsService(s)
- s.Cities = NewCitiesService(s)
- s.ConnectionTypes = NewConnectionTypesService(s)
- s.ContentCategories = NewContentCategoriesService(s)
- s.Countries = NewCountriesService(s)
- s.CreativeAssets = NewCreativeAssetsService(s)
- s.CreativeFieldValues = NewCreativeFieldValuesService(s)
- s.CreativeFields = NewCreativeFieldsService(s)
- s.CreativeGroups = NewCreativeGroupsService(s)
- s.Creatives = NewCreativesService(s)
- s.DimensionValues = NewDimensionValuesService(s)
- s.DirectorySiteContacts = NewDirectorySiteContactsService(s)
- s.DirectorySites = NewDirectorySitesService(s)
- s.EventTags = NewEventTagsService(s)
- s.Files = NewFilesService(s)
- s.FloodlightActivities = NewFloodlightActivitiesService(s)
- s.FloodlightActivityGroups = NewFloodlightActivityGroupsService(s)
- s.FloodlightConfigurations = NewFloodlightConfigurationsService(s)
- s.LandingPages = NewLandingPagesService(s)
- s.Metros = NewMetrosService(s)
- s.MobileCarriers = NewMobileCarriersService(s)
- s.OperatingSystemVersions = NewOperatingSystemVersionsService(s)
- s.OperatingSystems = NewOperatingSystemsService(s)
- s.PlacementGroups = NewPlacementGroupsService(s)
- s.PlacementStrategies = NewPlacementStrategiesService(s)
- s.Placements = NewPlacementsService(s)
- s.PlatformTypes = NewPlatformTypesService(s)
- s.PostalCodes = NewPostalCodesService(s)
- s.Regions = NewRegionsService(s)
- s.Reports = NewReportsService(s)
- s.Sites = NewSitesService(s)
- s.Sizes = NewSizesService(s)
- s.Subaccounts = NewSubaccountsService(s)
- s.UserProfiles = NewUserProfilesService(s)
- s.UserRolePermissionGroups = NewUserRolePermissionGroupsService(s)
- s.UserRolePermissions = NewUserRolePermissionsService(s)
- s.UserRoles = NewUserRolesService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- AccountActiveAdSummaries *AccountActiveAdSummariesService
-
- AccountPermissionGroups *AccountPermissionGroupsService
-
- AccountPermissions *AccountPermissionsService
-
- AccountUserProfiles *AccountUserProfilesService
-
- Accounts *AccountsService
-
- Ads *AdsService
-
- AdvertiserGroups *AdvertiserGroupsService
-
- Advertisers *AdvertisersService
-
- Browsers *BrowsersService
-
- CampaignCreativeAssociations *CampaignCreativeAssociationsService
-
- Campaigns *CampaignsService
-
- ChangeLogs *ChangeLogsService
-
- Cities *CitiesService
-
- ConnectionTypes *ConnectionTypesService
-
- ContentCategories *ContentCategoriesService
-
- Countries *CountriesService
-
- CreativeAssets *CreativeAssetsService
-
- CreativeFieldValues *CreativeFieldValuesService
-
- CreativeFields *CreativeFieldsService
-
- CreativeGroups *CreativeGroupsService
-
- Creatives *CreativesService
-
- DimensionValues *DimensionValuesService
-
- DirectorySiteContacts *DirectorySiteContactsService
-
- DirectorySites *DirectorySitesService
-
- EventTags *EventTagsService
-
- Files *FilesService
-
- FloodlightActivities *FloodlightActivitiesService
-
- FloodlightActivityGroups *FloodlightActivityGroupsService
-
- FloodlightConfigurations *FloodlightConfigurationsService
-
- LandingPages *LandingPagesService
-
- Metros *MetrosService
-
- MobileCarriers *MobileCarriersService
-
- OperatingSystemVersions *OperatingSystemVersionsService
-
- OperatingSystems *OperatingSystemsService
-
- PlacementGroups *PlacementGroupsService
-
- PlacementStrategies *PlacementStrategiesService
-
- Placements *PlacementsService
-
- PlatformTypes *PlatformTypesService
-
- PostalCodes *PostalCodesService
-
- Regions *RegionsService
-
- Reports *ReportsService
-
- Sites *SitesService
-
- Sizes *SizesService
-
- Subaccounts *SubaccountsService
-
- UserProfiles *UserProfilesService
-
- UserRolePermissionGroups *UserRolePermissionGroupsService
-
- UserRolePermissions *UserRolePermissionsService
-
- UserRoles *UserRolesService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewAccountActiveAdSummariesService(s *Service) *AccountActiveAdSummariesService {
- rs := &AccountActiveAdSummariesService{s: s}
- return rs
-}
-
-type AccountActiveAdSummariesService struct {
- s *Service
-}
-
-func NewAccountPermissionGroupsService(s *Service) *AccountPermissionGroupsService {
- rs := &AccountPermissionGroupsService{s: s}
- return rs
-}
-
-type AccountPermissionGroupsService struct {
- s *Service
-}
-
-func NewAccountPermissionsService(s *Service) *AccountPermissionsService {
- rs := &AccountPermissionsService{s: s}
- return rs
-}
-
-type AccountPermissionsService struct {
- s *Service
-}
-
-func NewAccountUserProfilesService(s *Service) *AccountUserProfilesService {
- rs := &AccountUserProfilesService{s: s}
- return rs
-}
-
-type AccountUserProfilesService struct {
- s *Service
-}
-
-func NewAccountsService(s *Service) *AccountsService {
- rs := &AccountsService{s: s}
- return rs
-}
-
-type AccountsService struct {
- s *Service
-}
-
-func NewAdsService(s *Service) *AdsService {
- rs := &AdsService{s: s}
- return rs
-}
-
-type AdsService struct {
- s *Service
-}
-
-func NewAdvertiserGroupsService(s *Service) *AdvertiserGroupsService {
- rs := &AdvertiserGroupsService{s: s}
- return rs
-}
-
-type AdvertiserGroupsService struct {
- s *Service
-}
-
-func NewAdvertisersService(s *Service) *AdvertisersService {
- rs := &AdvertisersService{s: s}
- return rs
-}
-
-type AdvertisersService struct {
- s *Service
-}
-
-func NewBrowsersService(s *Service) *BrowsersService {
- rs := &BrowsersService{s: s}
- return rs
-}
-
-type BrowsersService struct {
- s *Service
-}
-
-func NewCampaignCreativeAssociationsService(s *Service) *CampaignCreativeAssociationsService {
- rs := &CampaignCreativeAssociationsService{s: s}
- return rs
-}
-
-type CampaignCreativeAssociationsService struct {
- s *Service
-}
-
-func NewCampaignsService(s *Service) *CampaignsService {
- rs := &CampaignsService{s: s}
- return rs
-}
-
-type CampaignsService struct {
- s *Service
-}
-
-func NewChangeLogsService(s *Service) *ChangeLogsService {
- rs := &ChangeLogsService{s: s}
- return rs
-}
-
-type ChangeLogsService struct {
- s *Service
-}
-
-func NewCitiesService(s *Service) *CitiesService {
- rs := &CitiesService{s: s}
- return rs
-}
-
-type CitiesService struct {
- s *Service
-}
-
-func NewConnectionTypesService(s *Service) *ConnectionTypesService {
- rs := &ConnectionTypesService{s: s}
- return rs
-}
-
-type ConnectionTypesService struct {
- s *Service
-}
-
-func NewContentCategoriesService(s *Service) *ContentCategoriesService {
- rs := &ContentCategoriesService{s: s}
- return rs
-}
-
-type ContentCategoriesService struct {
- s *Service
-}
-
-func NewCountriesService(s *Service) *CountriesService {
- rs := &CountriesService{s: s}
- return rs
-}
-
-type CountriesService struct {
- s *Service
-}
-
-func NewCreativeAssetsService(s *Service) *CreativeAssetsService {
- rs := &CreativeAssetsService{s: s}
- return rs
-}
-
-type CreativeAssetsService struct {
- s *Service
-}
-
-func NewCreativeFieldValuesService(s *Service) *CreativeFieldValuesService {
- rs := &CreativeFieldValuesService{s: s}
- return rs
-}
-
-type CreativeFieldValuesService struct {
- s *Service
-}
-
-func NewCreativeFieldsService(s *Service) *CreativeFieldsService {
- rs := &CreativeFieldsService{s: s}
- return rs
-}
-
-type CreativeFieldsService struct {
- s *Service
-}
-
-func NewCreativeGroupsService(s *Service) *CreativeGroupsService {
- rs := &CreativeGroupsService{s: s}
- return rs
-}
-
-type CreativeGroupsService struct {
- s *Service
-}
-
-func NewCreativesService(s *Service) *CreativesService {
- rs := &CreativesService{s: s}
- return rs
-}
-
-type CreativesService struct {
- s *Service
-}
-
-func NewDimensionValuesService(s *Service) *DimensionValuesService {
- rs := &DimensionValuesService{s: s}
- return rs
-}
-
-type DimensionValuesService struct {
- s *Service
-}
-
-func NewDirectorySiteContactsService(s *Service) *DirectorySiteContactsService {
- rs := &DirectorySiteContactsService{s: s}
- return rs
-}
-
-type DirectorySiteContactsService struct {
- s *Service
-}
-
-func NewDirectorySitesService(s *Service) *DirectorySitesService {
- rs := &DirectorySitesService{s: s}
- return rs
-}
-
-type DirectorySitesService struct {
- s *Service
-}
-
-func NewEventTagsService(s *Service) *EventTagsService {
- rs := &EventTagsService{s: s}
- return rs
-}
-
-type EventTagsService struct {
- s *Service
-}
-
-func NewFilesService(s *Service) *FilesService {
- rs := &FilesService{s: s}
- return rs
-}
-
-type FilesService struct {
- s *Service
-}
-
-func NewFloodlightActivitiesService(s *Service) *FloodlightActivitiesService {
- rs := &FloodlightActivitiesService{s: s}
- return rs
-}
-
-type FloodlightActivitiesService struct {
- s *Service
-}
-
-func NewFloodlightActivityGroupsService(s *Service) *FloodlightActivityGroupsService {
- rs := &FloodlightActivityGroupsService{s: s}
- return rs
-}
-
-type FloodlightActivityGroupsService struct {
- s *Service
-}
-
-func NewFloodlightConfigurationsService(s *Service) *FloodlightConfigurationsService {
- rs := &FloodlightConfigurationsService{s: s}
- return rs
-}
-
-type FloodlightConfigurationsService struct {
- s *Service
-}
-
-func NewLandingPagesService(s *Service) *LandingPagesService {
- rs := &LandingPagesService{s: s}
- return rs
-}
-
-type LandingPagesService struct {
- s *Service
-}
-
-func NewMetrosService(s *Service) *MetrosService {
- rs := &MetrosService{s: s}
- return rs
-}
-
-type MetrosService struct {
- s *Service
-}
-
-func NewMobileCarriersService(s *Service) *MobileCarriersService {
- rs := &MobileCarriersService{s: s}
- return rs
-}
-
-type MobileCarriersService struct {
- s *Service
-}
-
-func NewOperatingSystemVersionsService(s *Service) *OperatingSystemVersionsService {
- rs := &OperatingSystemVersionsService{s: s}
- return rs
-}
-
-type OperatingSystemVersionsService struct {
- s *Service
-}
-
-func NewOperatingSystemsService(s *Service) *OperatingSystemsService {
- rs := &OperatingSystemsService{s: s}
- return rs
-}
-
-type OperatingSystemsService struct {
- s *Service
-}
-
-func NewPlacementGroupsService(s *Service) *PlacementGroupsService {
- rs := &PlacementGroupsService{s: s}
- return rs
-}
-
-type PlacementGroupsService struct {
- s *Service
-}
-
-func NewPlacementStrategiesService(s *Service) *PlacementStrategiesService {
- rs := &PlacementStrategiesService{s: s}
- return rs
-}
-
-type PlacementStrategiesService struct {
- s *Service
-}
-
-func NewPlacementsService(s *Service) *PlacementsService {
- rs := &PlacementsService{s: s}
- return rs
-}
-
-type PlacementsService struct {
- s *Service
-}
-
-func NewPlatformTypesService(s *Service) *PlatformTypesService {
- rs := &PlatformTypesService{s: s}
- return rs
-}
-
-type PlatformTypesService struct {
- s *Service
-}
-
-func NewPostalCodesService(s *Service) *PostalCodesService {
- rs := &PostalCodesService{s: s}
- return rs
-}
-
-type PostalCodesService struct {
- s *Service
-}
-
-func NewRegionsService(s *Service) *RegionsService {
- rs := &RegionsService{s: s}
- return rs
-}
-
-type RegionsService struct {
- s *Service
-}
-
-func NewReportsService(s *Service) *ReportsService {
- rs := &ReportsService{s: s}
- rs.CompatibleFields = NewReportsCompatibleFieldsService(s)
- rs.Files = NewReportsFilesService(s)
- return rs
-}
-
-type ReportsService struct {
- s *Service
-
- CompatibleFields *ReportsCompatibleFieldsService
-
- Files *ReportsFilesService
-}
-
-func NewReportsCompatibleFieldsService(s *Service) *ReportsCompatibleFieldsService {
- rs := &ReportsCompatibleFieldsService{s: s}
- return rs
-}
-
-type ReportsCompatibleFieldsService struct {
- s *Service
-}
-
-func NewReportsFilesService(s *Service) *ReportsFilesService {
- rs := &ReportsFilesService{s: s}
- return rs
-}
-
-type ReportsFilesService struct {
- s *Service
-}
-
-func NewSitesService(s *Service) *SitesService {
- rs := &SitesService{s: s}
- return rs
-}
-
-type SitesService struct {
- s *Service
-}
-
-func NewSizesService(s *Service) *SizesService {
- rs := &SizesService{s: s}
- return rs
-}
-
-type SizesService struct {
- s *Service
-}
-
-func NewSubaccountsService(s *Service) *SubaccountsService {
- rs := &SubaccountsService{s: s}
- return rs
-}
-
-type SubaccountsService struct {
- s *Service
-}
-
-func NewUserProfilesService(s *Service) *UserProfilesService {
- rs := &UserProfilesService{s: s}
- return rs
-}
-
-type UserProfilesService struct {
- s *Service
-}
-
-func NewUserRolePermissionGroupsService(s *Service) *UserRolePermissionGroupsService {
- rs := &UserRolePermissionGroupsService{s: s}
- return rs
-}
-
-type UserRolePermissionGroupsService struct {
- s *Service
-}
-
-func NewUserRolePermissionsService(s *Service) *UserRolePermissionsService {
- rs := &UserRolePermissionsService{s: s}
- return rs
-}
-
-type UserRolePermissionsService struct {
- s *Service
-}
-
-func NewUserRolesService(s *Service) *UserRolesService {
- rs := &UserRolesService{s: s}
- return rs
-}
-
-type UserRolesService struct {
- s *Service
-}
-
-// Account: Contains properties of a DCM account.
-type Account struct {
- // AccountPermissionIds: Account permissions assigned to this account.
- AccountPermissionIds googleapi.Int64s `json:"accountPermissionIds,omitempty"`
-
- // AccountProfile: Profile for this account. This is a read-only field
- // that can be left blank.
- //
- // Possible values:
- // "ACCOUNT_PROFILE_BASIC"
- // "ACCOUNT_PROFILE_STANDARD"
- AccountProfile string `json:"accountProfile,omitempty"`
-
- // Active: Whether this account is active.
- Active bool `json:"active,omitempty"`
-
- // ActiveAdsLimitTier: Maximum number of active ads allowed for this
- // account.
- //
- // Possible values:
- // "ACTIVE_ADS_TIER_100K"
- // "ACTIVE_ADS_TIER_200K"
- // "ACTIVE_ADS_TIER_300K"
- // "ACTIVE_ADS_TIER_40K"
- // "ACTIVE_ADS_TIER_75K"
- ActiveAdsLimitTier string `json:"activeAdsLimitTier,omitempty"`
-
- // ActiveViewOptOut: Whether to serve creatives with Active View tags.
- // If disabled, viewability data will not be available for any
- // impressions.
- ActiveViewOptOut bool `json:"activeViewOptOut,omitempty"`
-
- // AvailablePermissionIds: User role permissions available to the user
- // roles of this account.
- AvailablePermissionIds googleapi.Int64s `json:"availablePermissionIds,omitempty"`
-
- // ComscoreVceEnabled: Whether campaigns created in this account will be
- // enabled for comScore vCE by default.
- ComscoreVceEnabled bool `json:"comscoreVceEnabled,omitempty"`
-
- // CountryId: ID of the country associated with this account.
- CountryId int64 `json:"countryId,omitempty,string"`
-
- // CurrencyId: ID of currency associated with this account. This is a
- // required field.
- // Acceptable values are:
- // - "1" for USD
- // - "2" for GBP
- // - "3" for ESP
- // - "4" for SEK
- // - "5" for CAD
- // - "6" for JPY
- // - "7" for DEM
- // - "8" for AUD
- // - "9" for FRF
- // - "10" for ITL
- // - "11" for DKK
- // - "12" for NOK
- // - "13" for FIM
- // - "14" for ZAR
- // - "15" for IEP
- // - "16" for NLG
- // - "17" for EUR
- // - "18" for KRW
- // - "19" for TWD
- // - "20" for SGD
- // - "21" for CNY
- // - "22" for HKD
- // - "23" for NZD
- // - "24" for MYR
- // - "25" for BRL
- // - "26" for PTE
- // - "27" for MXP
- // - "28" for CLP
- // - "29" for TRY
- // - "30" for ARS
- // - "31" for PEN
- // - "32" for ILS
- // - "33" for CHF
- // - "34" for VEF
- // - "35" for COP
- // - "36" for GTQ
- CurrencyId int64 `json:"currencyId,omitempty,string"`
-
- // DefaultCreativeSizeId: Default placement dimensions for this account.
- DefaultCreativeSizeId int64 `json:"defaultCreativeSizeId,omitempty,string"`
-
- // Description: Description of this account.
- Description string `json:"description,omitempty"`
-
- // Id: ID of this account. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#account".
- Kind string `json:"kind,omitempty"`
-
- // Locale: Locale of this account.
- // Acceptable values are:
- // - "cs" (Czech)
- // - "de" (German)
- // - "en" (English)
- // - "en-GB" (English United Kingdom)
- // - "es" (Spanish)
- // - "fr" (French)
- // - "it" (Italian)
- // - "ja" (Japanese)
- // - "ko" (Korean)
- // - "pl" (Polish)
- // - "pt-BR" (Portuguese Brazil)
- // - "ru" (Russian)
- // - "sv" (Swedish)
- // - "tr" (Turkish)
- // - "zh-CN" (Chinese Simplified)
- // - "zh-TW" (Chinese Traditional)
- Locale string `json:"locale,omitempty"`
-
- // MaximumImageSize: Maximum image size allowed for this account.
- MaximumImageSize int64 `json:"maximumImageSize,omitempty,string"`
-
- // Name: Name of this account. This is a required field, and must be
- // less than 128 characters long and be globally unique.
- Name string `json:"name,omitempty"`
-
- // NielsenOcrEnabled: Whether campaigns created in this account will be
- // enabled for Nielsen OCR reach ratings by default.
- NielsenOcrEnabled bool `json:"nielsenOcrEnabled,omitempty"`
-
- // ReportsConfiguration: Reporting configuration of this account.
- ReportsConfiguration *ReportsConfiguration `json:"reportsConfiguration,omitempty"`
-
- // TeaserSizeLimit: File size limit in kilobytes of Rich Media teaser
- // creatives. Must be between 1 and 10240.
- TeaserSizeLimit int64 `json:"teaserSizeLimit,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "AccountPermissionIds") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Account) MarshalJSON() ([]byte, error) {
- type noMethod Account
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountActiveAdSummary: Gets a summary of active ads in an account.
-type AccountActiveAdSummary struct {
- // AccountId: ID of the account.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // ActiveAds: Ads that have been activated for the account
- ActiveAds int64 `json:"activeAds,omitempty,string"`
-
- // ActiveAdsLimitTier: Maximum number of active ads allowed for the
- // account.
- //
- // Possible values:
- // "ACTIVE_ADS_TIER_100K"
- // "ACTIVE_ADS_TIER_200K"
- // "ACTIVE_ADS_TIER_300K"
- // "ACTIVE_ADS_TIER_40K"
- // "ACTIVE_ADS_TIER_75K"
- ActiveAdsLimitTier string `json:"activeAdsLimitTier,omitempty"`
-
- // AvailableAds: Ads that can be activated for the account.
- AvailableAds int64 `json:"availableAds,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#accountActiveAdSummary".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountActiveAdSummary) MarshalJSON() ([]byte, error) {
- type noMethod AccountActiveAdSummary
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountPermission: AccountPermissions contains information about a
-// particular account permission. Some features of DCM require an
-// account permission to be present in the account.
-type AccountPermission struct {
- // AccountProfiles: Account profiles associated with this account
- // permission.
- //
- // Possible values are:
- // - "ACCOUNT_PROFILE_BASIC"
- // - "ACCOUNT_PROFILE_STANDARD"
- //
- // Possible values:
- // "ACCOUNT_PROFILE_BASIC"
- // "ACCOUNT_PROFILE_STANDARD"
- AccountProfiles []string `json:"accountProfiles,omitempty"`
-
- // Id: ID of this account permission.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#accountPermission".
- Kind string `json:"kind,omitempty"`
-
- // Level: Administrative level required to enable this account
- // permission.
- //
- // Possible values:
- // "ADMINISTRATOR"
- // "USER"
- Level string `json:"level,omitempty"`
-
- // Name: Name of this account permission.
- Name string `json:"name,omitempty"`
-
- // PermissionGroupId: Permission group of this account permission.
- PermissionGroupId int64 `json:"permissionGroupId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountProfiles") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountPermission) MarshalJSON() ([]byte, error) {
- type noMethod AccountPermission
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountPermissionGroup: AccountPermissionGroups contains a mapping of
-// permission group IDs to names. A permission group is a grouping of
-// account permissions.
-type AccountPermissionGroup struct {
- // Id: ID of this account permission group.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#accountPermissionGroup".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this account permission group.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountPermissionGroup) MarshalJSON() ([]byte, error) {
- type noMethod AccountPermissionGroup
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountPermissionGroupsListResponse: Account Permission Group List
-// Response
-type AccountPermissionGroupsListResponse struct {
- // AccountPermissionGroups: Account permission group collection.
- AccountPermissionGroups []*AccountPermissionGroup `json:"accountPermissionGroups,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#accountPermissionGroupsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "AccountPermissionGroups") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountPermissionGroupsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod AccountPermissionGroupsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountPermissionsListResponse: Account Permission List Response
-type AccountPermissionsListResponse struct {
- // AccountPermissions: Account permission collection.
- AccountPermissions []*AccountPermission `json:"accountPermissions,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#accountPermissionsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountPermissions")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountPermissionsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod AccountPermissionsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountUserProfile: AccountUserProfiles contains properties of a DCM
-// user profile. This resource is specifically for managing user
-// profiles, whereas UserProfiles is for accessing the API.
-type AccountUserProfile struct {
- // AccountId: Account ID of the user profile. This is a read-only field
- // that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Active: Whether this user profile is active. This defaults to false,
- // and must be set true on insert for the user profile to be usable.
- Active bool `json:"active,omitempty"`
-
- // AdvertiserFilter: Filter that describes which advertisers are visible
- // to the user profile.
- AdvertiserFilter *ObjectFilter `json:"advertiserFilter,omitempty"`
-
- // CampaignFilter: Filter that describes which campaigns are visible to
- // the user profile.
- CampaignFilter *ObjectFilter `json:"campaignFilter,omitempty"`
-
- // Comments: Comments for this user profile.
- Comments string `json:"comments,omitempty"`
-
- // Email: Email of the user profile. The email addresss must be linked
- // to a Google Account. This field is required on insertion and is
- // read-only after insertion.
- Email string `json:"email,omitempty"`
-
- // Id: ID of the user profile. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#accountUserProfile".
- Kind string `json:"kind,omitempty"`
-
- // Locale: Locale of the user profile. This is a required
- // field.
- // Acceptable values are:
- // - "cs" (Czech)
- // - "de" (German)
- // - "en" (English)
- // - "en-GB" (English United Kingdom)
- // - "es" (Spanish)
- // - "fr" (French)
- // - "it" (Italian)
- // - "ja" (Japanese)
- // - "ko" (Korean)
- // - "pl" (Polish)
- // - "pt-BR" (Portuguese Brazil)
- // - "ru" (Russian)
- // - "sv" (Swedish)
- // - "tr" (Turkish)
- // - "zh-CN" (Chinese Simplified)
- // - "zh-TW" (Chinese Traditional)
- Locale string `json:"locale,omitempty"`
-
- // Name: Name of the user profile. This is a required field. Must be
- // less than 64 characters long, must be globally unique, and cannot
- // contain whitespace or any of the following characters: "&;"#%,".
- Name string `json:"name,omitempty"`
-
- // SiteFilter: Filter that describes which sites are visible to the user
- // profile.
- SiteFilter *ObjectFilter `json:"siteFilter,omitempty"`
-
- // SubaccountId: Subaccount ID of the user profile. This is a read-only
- // field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // TraffickerType: Trafficker type of this user profile.
- //
- // Possible values:
- // "EXTERNAL_TRAFFICKER"
- // "INTERNAL_NON_TRAFFICKER"
- // "INTERNAL_TRAFFICKER"
- TraffickerType string `json:"traffickerType,omitempty"`
-
- // UserAccessType: User type of the user profile. This is a read-only
- // field that can be left blank.
- //
- // Possible values:
- // "INTERNAL_ADMINISTRATOR"
- // "NORMAL_USER"
- // "SUPER_USER"
- UserAccessType string `json:"userAccessType,omitempty"`
-
- // UserRoleFilter: Filter that describes which user roles are visible to
- // the user profile.
- UserRoleFilter *ObjectFilter `json:"userRoleFilter,omitempty"`
-
- // UserRoleId: User role ID of the user profile. This is a required
- // field.
- UserRoleId int64 `json:"userRoleId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountUserProfile) MarshalJSON() ([]byte, error) {
- type noMethod AccountUserProfile
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountUserProfilesListResponse: Account User Profile List Response
-type AccountUserProfilesListResponse struct {
- // AccountUserProfiles: Account user profile collection.
- AccountUserProfiles []*AccountUserProfile `json:"accountUserProfiles,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#accountUserProfilesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountUserProfiles")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountUserProfilesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod AccountUserProfilesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountsListResponse: Account List Response
-type AccountsListResponse struct {
- // Accounts: Account collection.
- Accounts []*Account `json:"accounts,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#accountsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Accounts") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod AccountsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Activities: Represents an activity group.
-type Activities struct {
- // Filters: List of activity filters. The dimension values need to be
- // all either of type "dfa:activity" or "dfa:activityGroup".
- Filters []*DimensionValue `json:"filters,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#activities.
- Kind string `json:"kind,omitempty"`
-
- // MetricNames: List of names of floodlight activity metrics.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Filters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Activities) MarshalJSON() ([]byte, error) {
- type noMethod Activities
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Ad: Contains properties of a DCM ad.
-type Ad struct {
- // AccountId: Account ID of this ad. This is a read-only field that can
- // be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Active: Whether this ad is active.
- Active bool `json:"active,omitempty"`
-
- // AdvertiserId: Advertiser ID of this ad. This is a required field on
- // insertion.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // Archived: Whether this ad is archived.
- Archived bool `json:"archived,omitempty"`
-
- // AudienceSegmentId: Audience segment ID that is being targeted for
- // this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- AudienceSegmentId int64 `json:"audienceSegmentId,omitempty,string"`
-
- // CampaignId: Campaign ID of this ad. This is a required field on
- // insertion.
- CampaignId int64 `json:"campaignId,omitempty,string"`
-
- // CampaignIdDimensionValue: Dimension value for the ID of the campaign.
- // This is a read-only, auto-generated field.
- CampaignIdDimensionValue *DimensionValue `json:"campaignIdDimensionValue,omitempty"`
-
- // ClickThroughUrl: Click-through URL for this ad. This is a required
- // field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
- ClickThroughUrl *ClickThroughUrl `json:"clickThroughUrl,omitempty"`
-
- // ClickThroughUrlSuffixProperties: Click-through URL suffix properties
- // for this ad. Applies to the URL in the ad or (if overriding ad
- // properties) the URL in the creative.
- ClickThroughUrlSuffixProperties *ClickThroughUrlSuffixProperties `json:"clickThroughUrlSuffixProperties,omitempty"`
-
- // Comments: Comments for this ad.
- Comments string `json:"comments,omitempty"`
-
- // Compatibility: Compatibility of this ad. Applicable when type is
- // AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering
- // either on desktop or on mobile devices for regular or interstitial
- // ads, respectively. APP and APP_INTERSTITIAL are for rendering in
- // mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video
- // ads developed with the VAST standard.
- //
- // Possible values:
- // "APP"
- // "APP_INTERSTITIAL"
- // "IN_STREAM_VIDEO"
- // "WEB"
- // "WEB_INTERSTITIAL"
- Compatibility string `json:"compatibility,omitempty"`
-
- // CreateInfo: Information about the creation of this ad.This is a
- // read-only field.
- CreateInfo *LastModifiedInfo `json:"createInfo,omitempty"`
-
- // CreativeGroupAssignments: Creative group assignments for this ad.
- // Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment
- // per creative group number is allowed for a maximum of two
- // assignments.
- CreativeGroupAssignments []*CreativeGroupAssignment `json:"creativeGroupAssignments,omitempty"`
-
- // CreativeRotation: Creative rotation for this ad. Applicable when type
- // is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or
- // AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field
- // should have exactly one creativeAssignment.
- CreativeRotation *CreativeRotation `json:"creativeRotation,omitempty"`
-
- // DayPartTargeting: Time and day targeting information for this ad.
- // Applicable when type is AD_SERVING_STANDARD_AD.
- DayPartTargeting *DayPartTargeting `json:"dayPartTargeting,omitempty"`
-
- // DefaultClickThroughEventTagProperties: Default click-through event
- // tag properties for this ad.
- DefaultClickThroughEventTagProperties *DefaultClickThroughEventTagProperties `json:"defaultClickThroughEventTagProperties,omitempty"`
-
- // DeliverySchedule: Delivery schedule information for this ad.
- // Applicable when type is AD_SERVING_STANDARD_AD or
- // AD_SERVING_TRACKING. This field along with subfields priority and
- // impressionRatio are required on insertion when type is
- // AD_SERVING_STANDARD_AD.
- DeliverySchedule *DeliverySchedule `json:"deliverySchedule,omitempty"`
-
- // DynamicClickTracker: Whether this ad is a dynamic click tracker.
- // Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required
- // field on insert, and is read-only after insert.
- DynamicClickTracker bool `json:"dynamicClickTracker,omitempty"`
-
- // EndTime: Date and time that this ad should stop serving. Must be
- // later than the start time. This is a required field on insertion.
- EndTime string `json:"endTime,omitempty"`
-
- // EventTagOverrides: Event tag overrides for this ad.
- EventTagOverrides []*EventTagOverride `json:"eventTagOverrides,omitempty"`
-
- // GeoTargeting: Geographical targeting information for this
- // ad.Applicable when type is AD_SERVING_STANDARD_AD.
- GeoTargeting *GeoTargeting `json:"geoTargeting,omitempty"`
-
- // Id: ID of this ad. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this ad. This is a
- // read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // KeyValueTargetingExpression: Key-value targeting information for this
- // ad. Applicable when type is AD_SERVING_STANDARD_AD.
- KeyValueTargetingExpression *KeyValueTargetingExpression `json:"keyValueTargetingExpression,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#ad".
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedInfo: Information about the most recent modification of
- // this ad. This is a read-only field.
- LastModifiedInfo *LastModifiedInfo `json:"lastModifiedInfo,omitempty"`
-
- // Name: Name of this ad. This is a required field and must be less than
- // 256 characters long.
- Name string `json:"name,omitempty"`
-
- // PlacementAssignments: Placement assignments for this ad.
- PlacementAssignments []*PlacementAssignment `json:"placementAssignments,omitempty"`
-
- // RemarketingListExpression: Applicable when type is
- // AD_SERVING_STANDARD_AD. Remarketing list targeting expression for
- // this ad.
- RemarketingListExpression *ListTargetingExpression `json:"remarketing_list_expression,omitempty"`
-
- // Size: Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
- Size *Size `json:"size,omitempty"`
-
- // SslCompliant: Whether this ad is ssl compliant. This is a read-only
- // field that is auto-generated when the ad is inserted or updated.
- SslCompliant bool `json:"sslCompliant,omitempty"`
-
- // SslRequired: Whether this ad requires ssl. This is a read-only field
- // that is auto-generated when the ad is inserted or updated.
- SslRequired bool `json:"sslRequired,omitempty"`
-
- // StartTime: Date and time that this ad should start serving. If
- // creating an ad, this field must be a time in the future. This is a
- // required field on insertion.
- StartTime string `json:"startTime,omitempty"`
-
- // SubaccountId: Subaccount ID of this ad. This is a read-only field
- // that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // TechnologyTargeting: Technology platform targeting information for
- // this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- TechnologyTargeting *TechnologyTargeting `json:"technologyTargeting,omitempty"`
-
- // Type: Type of ad. This is a required field on insertion. Note that
- // default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see
- // Creative resource).
- //
- // Possible values:
- // "AD_SERVING_CLICK_TRACKER"
- // "AD_SERVING_DEFAULT_AD"
- // "AD_SERVING_STANDARD_AD"
- // "AD_SERVING_TRACKING"
- Type string `json:"type,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Ad) MarshalJSON() ([]byte, error) {
- type noMethod Ad
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdsListResponse: Ad List Response
-type AdsListResponse struct {
- // Ads: Ad collection.
- Ads []*Ad `json:"ads,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#adsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Ads") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod AdsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Advertiser: Contains properties of a DCM advertiser.
-type Advertiser struct {
- // AccountId: Account ID of this advertiser.This is a read-only field
- // that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserGroupId: ID of the advertiser group this advertiser belongs
- // to. You can group advertisers for reporting purposes, allowing you to
- // see aggregated information for all advertisers in each group.
- AdvertiserGroupId int64 `json:"advertiserGroupId,omitempty,string"`
-
- // ClickThroughUrlSuffix: Suffix added to click-through URL of ad
- // creative associations under this advertiser. Must be less than 129
- // characters long.
- ClickThroughUrlSuffix string `json:"clickThroughUrlSuffix,omitempty"`
-
- // DefaultClickThroughEventTagId: ID of the click-through event tag to
- // apply by default to the landing pages of this advertiser's campaigns.
- DefaultClickThroughEventTagId int64 `json:"defaultClickThroughEventTagId,omitempty,string"`
-
- // DefaultEmail: Default email address used in sender field for tag
- // emails.
- DefaultEmail string `json:"defaultEmail,omitempty"`
-
- // FloodlightConfigurationId: Floodlight configuration ID of this
- // advertiser. The floodlight configuration ID will be created
- // automatically, so on insert this field should be left blank. This
- // field can be set to another advertiser's floodlight configuration ID
- // in order to share that advertiser's floodlight configuration with
- // this advertiser, so long as:
- // - This advertiser's original floodlight configuration is not already
- // associated with floodlight activities or floodlight activity groups.
- //
- // - This advertiser's original floodlight configuration is not already
- // shared with another advertiser.
- FloodlightConfigurationId int64 `json:"floodlightConfigurationId,omitempty,string"`
-
- // FloodlightConfigurationIdDimensionValue: Dimension value for the ID
- // of the floodlight configuration. This is a read-only, auto-generated
- // field.
- FloodlightConfigurationIdDimensionValue *DimensionValue `json:"floodlightConfigurationIdDimensionValue,omitempty"`
-
- // Id: ID of this advertiser. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this advertiser. This
- // is a read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#advertiser".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this advertiser. This is a required field and must be
- // less than 256 characters long and unique among advertisers of the
- // same account.
- Name string `json:"name,omitempty"`
-
- // Status: Status of this advertiser.
- //
- // Possible values:
- // "APPROVED"
- // "ON_HOLD"
- Status string `json:"status,omitempty"`
-
- // SubaccountId: Subaccount ID of this advertiser.This is a read-only
- // field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Advertiser) MarshalJSON() ([]byte, error) {
- type noMethod Advertiser
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdvertiserGroup: Groups advertisers together so that reports can be
-// generated for the entire group at once.
-type AdvertiserGroup struct {
- // AccountId: Account ID of this advertiser group. This is a read-only
- // field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Id: ID of this advertiser group. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#advertiserGroup".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this advertiser group. This is a required field and
- // must be less than 256 characters long and unique among advertiser
- // groups of the same account.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdvertiserGroup) MarshalJSON() ([]byte, error) {
- type noMethod AdvertiserGroup
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdvertiserGroupsListResponse: Advertiser Group List Response
-type AdvertiserGroupsListResponse struct {
- // AdvertiserGroups: Advertiser group collection.
- AdvertiserGroups []*AdvertiserGroup `json:"advertiserGroups,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#advertiserGroupsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AdvertiserGroups") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdvertiserGroupsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod AdvertiserGroupsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdvertisersListResponse: Advertiser List Response
-type AdvertisersListResponse struct {
- // Advertisers: Advertiser collection.
- Advertisers []*Advertiser `json:"advertisers,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#advertisersListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Advertisers") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdvertisersListResponse) MarshalJSON() ([]byte, error) {
- type noMethod AdvertisersListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AudienceSegment: Audience Segment.
-type AudienceSegment struct {
- // Allocation: Weight allocated to this segment. Must be between 1 and
- // 1000. The weight assigned will be understood in proportion to the
- // weights assigned to other segments in the same segment group.
- Allocation int64 `json:"allocation,omitempty"`
-
- // Id: ID of this audience segment. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // Name: Name of this audience segment. This is a required field and
- // must be less than 65 characters long.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Allocation") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AudienceSegment) MarshalJSON() ([]byte, error) {
- type noMethod AudienceSegment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AudienceSegmentGroup: Audience Segment Group.
-type AudienceSegmentGroup struct {
- // AudienceSegments: Audience segments assigned to this group. The
- // number of segments must be between 2 and 100.
- AudienceSegments []*AudienceSegment `json:"audienceSegments,omitempty"`
-
- // Id: ID of this audience segment group. This is a read-only,
- // auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Name: Name of this audience segment group. This is a required field
- // and must be less than 65 characters long.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AudienceSegments") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AudienceSegmentGroup) MarshalJSON() ([]byte, error) {
- type noMethod AudienceSegmentGroup
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Browser: Contains information about a browser that can be targeted by
-// ads.
-type Browser struct {
- // BrowserVersionId: ID referring to this grouping of browser and
- // version numbers. This is the ID used for targeting.
- BrowserVersionId int64 `json:"browserVersionId,omitempty,string"`
-
- // DartId: DART ID of this browser. This is the ID used when generating
- // reports.
- DartId int64 `json:"dartId,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#browser".
- Kind string `json:"kind,omitempty"`
-
- // MajorVersion: Major version number (leftmost number) of this browser.
- // For example, for Chrome 5.0.376.86 beta, this field should be set to
- // 5. An asterisk (*) may be used to target any version number, and a
- // question mark (?) may be used to target cases where the version
- // number cannot be identified. For example, Chrome *.* targets any
- // version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets
- // Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad
- // server knows the browser is Firefox but can't tell which version it
- // is.
- MajorVersion string `json:"majorVersion,omitempty"`
-
- // MinorVersion: Minor version number (number after first dot on left)
- // of this browser. For example, for Chrome 5.0.375.86 beta, this field
- // should be set to 0. An asterisk (*) may be used to target any version
- // number, and a question mark (?) may be used to target cases where the
- // version number cannot be identified. For example, Chrome *.* targets
- // any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets
- // Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad
- // server knows the browser is Firefox but can't tell which version it
- // is.
- MinorVersion string `json:"minorVersion,omitempty"`
-
- // Name: Name of this browser.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BrowserVersionId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Browser) MarshalJSON() ([]byte, error) {
- type noMethod Browser
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// BrowsersListResponse: Browser List Response
-type BrowsersListResponse struct {
- // Browsers: Browser collection.
- Browsers []*Browser `json:"browsers,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#browsersListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Browsers") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BrowsersListResponse) MarshalJSON() ([]byte, error) {
- type noMethod BrowsersListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Campaign: Contains properties of a DCM campaign.
-type Campaign struct {
- // AccountId: Account ID of this campaign. This is a read-only field
- // that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdditionalCreativeOptimizationConfigurations: Additional creative
- // optimization configurations for the campaign.
- AdditionalCreativeOptimizationConfigurations []*CreativeOptimizationConfiguration `json:"additionalCreativeOptimizationConfigurations,omitempty"`
-
- // AdvertiserGroupId: Advertiser group ID of the associated advertiser.
- AdvertiserGroupId int64 `json:"advertiserGroupId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this campaign. This is a required
- // field.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the advertiser ID of
- // this campaign. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // Archived: Whether this campaign has been archived.
- Archived bool `json:"archived,omitempty"`
-
- // AudienceSegmentGroups: Audience segment groups assigned to this
- // campaign. Cannot have more than 300 segment groups.
- AudienceSegmentGroups []*AudienceSegmentGroup `json:"audienceSegmentGroups,omitempty"`
-
- // BillingInvoiceCode: Billing invoice code included in the DCM client
- // billing invoices associated with the campaign.
- BillingInvoiceCode string `json:"billingInvoiceCode,omitempty"`
-
- // ClickThroughUrlSuffixProperties: Click-through URL suffix override
- // properties for this campaign.
- ClickThroughUrlSuffixProperties *ClickThroughUrlSuffixProperties `json:"clickThroughUrlSuffixProperties,omitempty"`
-
- // Comment: Arbitrary comments about this campaign. Must be less than
- // 256 characters long.
- Comment string `json:"comment,omitempty"`
-
- // ComscoreVceEnabled: Whether comScore vCE reports are enabled for this
- // campaign.
- ComscoreVceEnabled bool `json:"comscoreVceEnabled,omitempty"`
-
- // CreateInfo: Information about the creation of this campaign. This is
- // a read-only field.
- CreateInfo *LastModifiedInfo `json:"createInfo,omitempty"`
-
- // CreativeGroupIds: List of creative group IDs that are assigned to the
- // campaign.
- CreativeGroupIds googleapi.Int64s `json:"creativeGroupIds,omitempty"`
-
- // CreativeOptimizationConfiguration: Creative optimization
- // configuration for the campaign.
- CreativeOptimizationConfiguration *CreativeOptimizationConfiguration `json:"creativeOptimizationConfiguration,omitempty"`
-
- // DefaultClickThroughEventTagProperties: Click-through event tag ID
- // override properties for this campaign.
- DefaultClickThroughEventTagProperties *DefaultClickThroughEventTagProperties `json:"defaultClickThroughEventTagProperties,omitempty"`
-
- // EndDate: Date on which the campaign will stop running. On insert, the
- // end date must be today or a future date. The end date must be later
- // than or be the same as the start date. If, for example, you set
- // 6/25/2015 as both the start and end dates, the effective campaign run
- // date is just that day only, 6/25/2015. The hours, minutes, and
- // seconds of the end date should not be set, as doing so will result in
- // an error. This is a required field.
- EndDate string `json:"endDate,omitempty"`
-
- // EventTagOverrides: Overrides that can be used to activate or
- // deactivate advertiser event tags.
- EventTagOverrides []*EventTagOverride `json:"eventTagOverrides,omitempty"`
-
- // ExternalId: External ID for this campaign.
- ExternalId string `json:"externalId,omitempty"`
-
- // Id: ID of this campaign. This is a read-only auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this campaign. This
- // is a read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#campaign".
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedInfo: Information about the most recent modification of
- // this campaign. This is a read-only field.
- LastModifiedInfo *LastModifiedInfo `json:"lastModifiedInfo,omitempty"`
-
- // LookbackConfiguration: Lookback window settings for the campaign.
- LookbackConfiguration *LookbackConfiguration `json:"lookbackConfiguration,omitempty"`
-
- // Name: Name of this campaign. This is a required field and must be
- // less than 256 characters long and unique among campaigns of the same
- // advertiser.
- Name string `json:"name,omitempty"`
-
- // NielsenOcrEnabled: Whether Nielsen reports are enabled for this
- // campaign.
- NielsenOcrEnabled bool `json:"nielsenOcrEnabled,omitempty"`
-
- // StartDate: Date on which the campaign starts running. The start date
- // can be any date. The hours, minutes, and seconds of the start date
- // should not be set, as doing so will result in an error. This is a
- // required field.
- StartDate string `json:"startDate,omitempty"`
-
- // SubaccountId: Subaccount ID of this campaign. This is a read-only
- // field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // TraffickerEmails: Campaign trafficker contact emails.
- TraffickerEmails []string `json:"traffickerEmails,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Campaign) MarshalJSON() ([]byte, error) {
- type noMethod Campaign
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CampaignCreativeAssociation: Identifies a creative which has been
-// associated with a given campaign.
-type CampaignCreativeAssociation struct {
- // CreativeId: ID of the creative associated with the campaign. This is
- // a required field.
- CreativeId int64 `json:"creativeId,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#campaignCreativeAssociation".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreativeId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CampaignCreativeAssociation) MarshalJSON() ([]byte, error) {
- type noMethod CampaignCreativeAssociation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CampaignCreativeAssociationsListResponse: Campaign Creative
-// Association List Response
-type CampaignCreativeAssociationsListResponse struct {
- // CampaignCreativeAssociations: Campaign creative association
- // collection
- CampaignCreativeAssociations []*CampaignCreativeAssociation `json:"campaignCreativeAssociations,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#campaignCreativeAssociationsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "CampaignCreativeAssociations") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CampaignCreativeAssociationsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod CampaignCreativeAssociationsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CampaignsListResponse: Campaign List Response
-type CampaignsListResponse struct {
- // Campaigns: Campaign collection.
- Campaigns []*Campaign `json:"campaigns,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#campaignsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Campaigns") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CampaignsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod CampaignsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ChangeLog: Describes a change that a user has made to a resource.
-type ChangeLog struct {
- // AccountId: Account ID of the modified object.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Action: Action which caused the change.
- Action string `json:"action,omitempty"`
-
- // ChangeTime: Time when the object was modified.
- ChangeTime string `json:"changeTime,omitempty"`
-
- // FieldName: Field name of the object which changed.
- FieldName string `json:"fieldName,omitempty"`
-
- // Id: ID of this change log.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#changeLog".
- Kind string `json:"kind,omitempty"`
-
- // NewValue: New value of the object field.
- NewValue string `json:"newValue,omitempty"`
-
- // ObjectId: ID of the object of this change log. The object could be a
- // campaign, placement, ad, or other type.
- ObjectId int64 `json:"objectId,omitempty,string"`
-
- // ObjectType: Object type of the change log.
- ObjectType string `json:"objectType,omitempty"`
-
- // OldValue: Old value of the object field.
- OldValue string `json:"oldValue,omitempty"`
-
- // SubaccountId: Subaccount ID of the modified object.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // TransactionId: Transaction ID of this change log. When a single API
- // call results in many changes, each change will have a separate ID in
- // the change log but will share the same transactionId.
- TransactionId int64 `json:"transactionId,omitempty,string"`
-
- // UserProfileId: ID of the user who modified the object.
- UserProfileId int64 `json:"userProfileId,omitempty,string"`
-
- // UserProfileName: User profile name of the user who modified the
- // object.
- UserProfileName string `json:"userProfileName,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ChangeLog) MarshalJSON() ([]byte, error) {
- type noMethod ChangeLog
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ChangeLogsListResponse: Change Log List Response
-type ChangeLogsListResponse struct {
- // ChangeLogs: Change log collection.
- ChangeLogs []*ChangeLog `json:"changeLogs,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#changeLogsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ChangeLogs") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ChangeLogsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod ChangeLogsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CitiesListResponse: City List Response
-type CitiesListResponse struct {
- // Cities: City collection.
- Cities []*City `json:"cities,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#citiesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Cities") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CitiesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod CitiesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// City: Contains information about a city that can be targeted by ads.
-type City struct {
- // CountryCode: Country code of the country to which this city belongs.
- CountryCode string `json:"countryCode,omitempty"`
-
- // CountryDartId: DART ID of the country to which this city belongs.
- CountryDartId int64 `json:"countryDartId,omitempty,string"`
-
- // DartId: DART ID of this city. This is the ID used for targeting and
- // generating reports.
- DartId int64 `json:"dartId,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#city".
- Kind string `json:"kind,omitempty"`
-
- // MetroCode: Metro region code of the metro region (DMA) to which this
- // city belongs.
- MetroCode string `json:"metroCode,omitempty"`
-
- // MetroDmaId: ID of the metro region (DMA) to which this city belongs.
- MetroDmaId int64 `json:"metroDmaId,omitempty,string"`
-
- // Name: Name of this city.
- Name string `json:"name,omitempty"`
-
- // RegionCode: Region code of the region to which this city belongs.
- RegionCode string `json:"regionCode,omitempty"`
-
- // RegionDartId: DART ID of the region to which this city belongs.
- RegionDartId int64 `json:"regionDartId,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "CountryCode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *City) MarshalJSON() ([]byte, error) {
- type noMethod City
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ClickTag: Creative Click Tag.
-type ClickTag struct {
- // EventName: Advertiser event name associated with the click tag. This
- // field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER
- // creatives.
- EventName string `json:"eventName,omitempty"`
-
- // Name: Parameter name for the specified click tag. For ENHANCED_IMAGE
- // creative assets, this field must match the value of the creative
- // asset's creativeAssetId.name field.
- Name string `json:"name,omitempty"`
-
- // Value: Parameter value for the specified click tag. This field
- // contains a click-through url.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "EventName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ClickTag) MarshalJSON() ([]byte, error) {
- type noMethod ClickTag
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ClickThroughUrl: Click-through URL
-type ClickThroughUrl struct {
- // CustomClickThroughUrl: Custom click-through URL. Applicable if the
- // defaultLandingPage field is set to false and the landingPageId field
- // is left unset.
- CustomClickThroughUrl string `json:"customClickThroughUrl,omitempty"`
-
- // DefaultLandingPage: Whether the campaign default landing page is
- // used.
- DefaultLandingPage bool `json:"defaultLandingPage,omitempty"`
-
- // LandingPageId: ID of the landing page for the click-through URL.
- // Applicable if the defaultLandingPage field is set to false.
- LandingPageId int64 `json:"landingPageId,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g.
- // "CustomClickThroughUrl") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ClickThroughUrl) MarshalJSON() ([]byte, error) {
- type noMethod ClickThroughUrl
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ClickThroughUrlSuffixProperties: Click Through URL Suffix settings.
-type ClickThroughUrlSuffixProperties struct {
- // ClickThroughUrlSuffix: Click-through URL suffix to apply to all ads
- // in this entity's scope. Must be less than 128 characters long.
- ClickThroughUrlSuffix string `json:"clickThroughUrlSuffix,omitempty"`
-
- // OverrideInheritedSuffix: Whether this entity should override the
- // inherited click-through URL suffix with its own defined value.
- OverrideInheritedSuffix bool `json:"overrideInheritedSuffix,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "ClickThroughUrlSuffix") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ClickThroughUrlSuffixProperties) MarshalJSON() ([]byte, error) {
- type noMethod ClickThroughUrlSuffixProperties
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CompanionClickThroughOverride: Companion Click-through override.
-type CompanionClickThroughOverride struct {
- // ClickThroughUrl: Click-through URL of this companion click-through
- // override.
- ClickThroughUrl *ClickThroughUrl `json:"clickThroughUrl,omitempty"`
-
- // CreativeId: ID of the creative for this companion click-through
- // override.
- CreativeId int64 `json:"creativeId,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "ClickThroughUrl") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CompanionClickThroughOverride) MarshalJSON() ([]byte, error) {
- type noMethod CompanionClickThroughOverride
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CompatibleFields: Represents a response to the queryCompatibleFields
-// method.
-type CompatibleFields struct {
- // CrossDimensionReachReportCompatibleFields: Contains items that are
- // compatible to be selected for a report of type
- // "CROSS_DIMENSION_REACH".
- CrossDimensionReachReportCompatibleFields *CrossDimensionReachReportCompatibleFields `json:"crossDimensionReachReportCompatibleFields,omitempty"`
-
- // FloodlightReportCompatibleFields: Contains items that are compatible
- // to be selected for a report of type "FLOODLIGHT".
- FloodlightReportCompatibleFields *FloodlightReportCompatibleFields `json:"floodlightReportCompatibleFields,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#compatibleFields.
- Kind string `json:"kind,omitempty"`
-
- // PathToConversionReportCompatibleFields: Contains items that are
- // compatible to be selected for a report of type "PATH_TO_CONVERSION".
- PathToConversionReportCompatibleFields *PathToConversionReportCompatibleFields `json:"pathToConversionReportCompatibleFields,omitempty"`
-
- // ReachReportCompatibleFields: Contains items that are compatible to be
- // selected for a report of type "REACH".
- ReachReportCompatibleFields *ReachReportCompatibleFields `json:"reachReportCompatibleFields,omitempty"`
-
- // ReportCompatibleFields: Contains items that are compatible to be
- // selected for a report of type "STANDARD".
- ReportCompatibleFields *ReportCompatibleFields `json:"reportCompatibleFields,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "CrossDimensionReachReportCompatibleFields") to unconditionally
- // include in API requests. By default, fields with empty values are
- // omitted from API requests. However, any non-pointer, non-interface
- // field appearing in ForceSendFields will be sent to the server
- // regardless of whether the field is empty or not. This may be used to
- // include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CompatibleFields) MarshalJSON() ([]byte, error) {
- type noMethod CompatibleFields
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ConnectionType: Contains information about an internet connection
-// type that can be targeted by ads. Clients can use the connection type
-// to target mobile vs. broadband users.
-type ConnectionType struct {
- // Id: ID of this connection type.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#connectionType".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this connection type.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ConnectionType) MarshalJSON() ([]byte, error) {
- type noMethod ConnectionType
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ConnectionTypesListResponse: Connection Type List Response
-type ConnectionTypesListResponse struct {
- // ConnectionTypes: Collection of connection types such as broadband and
- // mobile.
- ConnectionTypes []*ConnectionType `json:"connectionTypes,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#connectionTypesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ConnectionTypes") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ConnectionTypesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod ConnectionTypesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ContentCategoriesListResponse: Content Category List Response
-type ContentCategoriesListResponse struct {
- // ContentCategories: Content category collection.
- ContentCategories []*ContentCategory `json:"contentCategories,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#contentCategoriesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ContentCategories")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ContentCategoriesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod ContentCategoriesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ContentCategory: Organizes placements according to the contents of
-// their associated webpages.
-type ContentCategory struct {
- // AccountId: Account ID of this content category. This is a read-only
- // field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Description: Description of this content category.
- Description string `json:"description,omitempty"`
-
- // Id: ID of this content category. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#contentCategory".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this content category. This is a required field and
- // must be less than 256 characters long and unique among content
- // categories of the same account.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ContentCategory) MarshalJSON() ([]byte, error) {
- type noMethod ContentCategory
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CountriesListResponse: Country List Response
-type CountriesListResponse struct {
- // Countries: Country collection.
- Countries []*Country `json:"countries,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#countriesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Countries") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CountriesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod CountriesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Country: Contains information about a country that can be targeted by
-// ads.
-type Country struct {
- // CountryCode: Country code.
- CountryCode string `json:"countryCode,omitempty"`
-
- // DartId: DART ID of this country. This is the ID used for targeting
- // and generating reports.
- DartId int64 `json:"dartId,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#country".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this country.
- Name string `json:"name,omitempty"`
-
- // SslEnabled: Whether ad serving supports secure servers in this
- // country.
- SslEnabled bool `json:"sslEnabled,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CountryCode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Country) MarshalJSON() ([]byte, error) {
- type noMethod Country
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Creative: Contains properties of a Creative.
-type Creative struct {
- // AccountId: Account ID of this creative. This field, if left unset,
- // will be auto-generated for both insert and update operations.
- // Applicable to all creative types.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Active: Whether the creative is active. Applicable to all creative
- // types.
- Active bool `json:"active,omitempty"`
-
- // AdParameters: Ad parameters user for VPAID creative. This is a
- // read-only field. Applicable to the following creative types: all
- // VPAID.
- AdParameters string `json:"adParameters,omitempty"`
-
- // AdTagKeys: Keywords for a Rich Media creative. Keywords let you
- // customize the creative settings of a Rich Media ad running on your
- // site without having to contact the advertiser. You can use keywords
- // to dynamically change the look or functionality of a creative.
- // Applicable to the following creative types: all RICH_MEDIA, and all
- // VPAID.
- AdTagKeys []string `json:"adTagKeys,omitempty"`
-
- // AdvertiserId: Advertiser ID of this creative. This is a required
- // field. Applicable to all creative types.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AllowScriptAccess: Whether script access is allowed for this
- // creative. This is a read-only and deprecated field which will
- // automatically be set to true on update. Applicable to the following
- // creative types: FLASH_INPAGE.
- AllowScriptAccess bool `json:"allowScriptAccess,omitempty"`
-
- // Archived: Whether the creative is archived. Applicable to all
- // creative types.
- Archived bool `json:"archived,omitempty"`
-
- // ArtworkType: Type of artwork used for the creative. This is a
- // read-only field. Applicable to the following creative types: all
- // RICH_MEDIA, and all VPAID.
- //
- // Possible values:
- // "ARTWORK_TYPE_FLASH"
- // "ARTWORK_TYPE_HTML5"
- // "ARTWORK_TYPE_MIXED"
- ArtworkType string `json:"artworkType,omitempty"`
-
- // AuthoringTool: Authoring tool for HTML5 banner creatives. This is a
- // read-only field. Applicable to the following creative types:
- // HTML5_BANNER.
- //
- // Possible values:
- // "NINJA"
- // "SWIFFY"
- AuthoringTool string `json:"authoringTool,omitempty"`
-
- // AutoAdvanceImages: Whether images are automatically advanced for
- // enhanced image creatives. Applicable to the following creative types:
- // ENHANCED_IMAGE.
- AutoAdvanceImages bool `json:"auto_advance_images,omitempty"`
-
- // BackgroundColor: The 6-character HTML color code, beginning with #,
- // for the background of the window area where the Flash file is
- // displayed. Default is white. Applicable to the following creative
- // types: FLASH_INPAGE.
- BackgroundColor string `json:"backgroundColor,omitempty"`
-
- // BackupImageClickThroughUrl: Click-through URL for backup image.
- // Applicable to the following creative types: ENHANCED_BANNER,
- // FLASH_INPAGE, and HTML5_BANNER.
- BackupImageClickThroughUrl string `json:"backupImageClickThroughUrl,omitempty"`
-
- // BackupImageFeatures: List of feature dependencies that will cause a
- // backup image to be served if the browser that serves the ad does not
- // support them. Feature dependencies are features that a browser must
- // be able to support in order to render your HTML5 creative asset
- // correctly. This field is initially auto-generated to contain all
- // features detected by DCM for all the assets of this creative and can
- // then be modified by the client. To reset this field, copy over all
- // the creativeAssets' detected features. Applicable to the following
- // creative types: ENHANCED_BANNER and HTML5_BANNER.
- //
- // Possible values:
- // "APPLICATION_CACHE"
- // "AUDIO"
- // "CANVAS"
- // "CANVAS_TEXT"
- // "CSS_ANIMATIONS"
- // "CSS_BACKGROUND_SIZE"
- // "CSS_BORDER_IMAGE"
- // "CSS_BORDER_RADIUS"
- // "CSS_BOX_SHADOW"
- // "CSS_COLUMNS"
- // "CSS_FLEX_BOX"
- // "CSS_FONT_FACE"
- // "CSS_GENERATED_CONTENT"
- // "CSS_GRADIENTS"
- // "CSS_HSLA"
- // "CSS_MULTIPLE_BGS"
- // "CSS_OPACITY"
- // "CSS_REFLECTIONS"
- // "CSS_RGBA"
- // "CSS_TEXT_SHADOW"
- // "CSS_TRANSFORMS"
- // "CSS_TRANSFORMS3D"
- // "CSS_TRANSITIONS"
- // "DRAG_AND_DROP"
- // "GEO_LOCATION"
- // "HASH_CHANGE"
- // "HISTORY"
- // "INDEXED_DB"
- // "INLINE_SVG"
- // "INPUT_ATTR_AUTOCOMPLETE"
- // "INPUT_ATTR_AUTOFOCUS"
- // "INPUT_ATTR_LIST"
- // "INPUT_ATTR_MAX"
- // "INPUT_ATTR_MIN"
- // "INPUT_ATTR_MULTIPLE"
- // "INPUT_ATTR_PATTERN"
- // "INPUT_ATTR_PLACEHOLDER"
- // "INPUT_ATTR_REQUIRED"
- // "INPUT_ATTR_STEP"
- // "INPUT_TYPE_COLOR"
- // "INPUT_TYPE_DATE"
- // "INPUT_TYPE_DATETIME"
- // "INPUT_TYPE_DATETIME_LOCAL"
- // "INPUT_TYPE_EMAIL"
- // "INPUT_TYPE_MONTH"
- // "INPUT_TYPE_NUMBER"
- // "INPUT_TYPE_RANGE"
- // "INPUT_TYPE_SEARCH"
- // "INPUT_TYPE_TEL"
- // "INPUT_TYPE_TIME"
- // "INPUT_TYPE_URL"
- // "INPUT_TYPE_WEEK"
- // "LOCAL_STORAGE"
- // "POST_MESSAGE"
- // "SESSION_STORAGE"
- // "SMIL"
- // "SVG_CLIP_PATHS"
- // "SVG_FE_IMAGE"
- // "SVG_FILTERS"
- // "SVG_HREF"
- // "TOUCH"
- // "VIDEO"
- // "WEBGL"
- // "WEB_SOCKETS"
- // "WEB_SQL_DATABASE"
- // "WEB_WORKERS"
- BackupImageFeatures []string `json:"backupImageFeatures,omitempty"`
-
- // BackupImageReportingLabel: Reporting label used for HTML5 banner
- // backup image. Applicable to the following creative types:
- // ENHANCED_BANNER.
- BackupImageReportingLabel string `json:"backupImageReportingLabel,omitempty"`
-
- // BackupImageTargetWindow: Target window for backup image. Applicable
- // to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and
- // HTML5_BANNER.
- BackupImageTargetWindow *TargetWindow `json:"backupImageTargetWindow,omitempty"`
-
- // ClickTags: Click tags of the creative. For ENHANCED_BANNER,
- // FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of
- // detected click tags for the assets associated with this creative.
- // After creating a flash asset, detected click tags will be returned in
- // the creativeAssetMetadata. When inserting the creative, populate the
- // creative clickTags field using the creativeAssetMetadata.clickTags
- // field. For ENHANCED_IMAGE creatives, there should be exactly one
- // entry in this list for each image creative asset. A click tag is
- // matched with a corresponding creative asset by matching the
- // clickTag.name field with the creativeAsset.assetIdentifier.name
- // field. Applicable to the following creative types: ENHANCED_BANNER,
- // ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
- ClickTags []*ClickTag `json:"clickTags,omitempty"`
-
- // CommercialId: Industry standard ID assigned to creative for reach and
- // frequency. Applicable to the following creative types: INSTREAM_VIDEO
- // and all VPAID.
- CommercialId string `json:"commercialId,omitempty"`
-
- // CompanionCreatives: List of companion creatives assigned to an
- // in-Stream videocreative. Acceptable values include IDs of existing
- // flash and image creatives. Applicable to the following creative
- // types: INSTREAM_VIDEO and all VPAID.
- CompanionCreatives googleapi.Int64s `json:"companionCreatives,omitempty"`
-
- // Compatibility: Compatibilities associated with this creative. This is
- // a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either
- // on desktop or on mobile devices for regular or interstitial ads,
- // respectively. APP and APP_INTERSTITIAL are for rendering in mobile
- // apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads
- // developed with the VAST standard. Applicable to all creative
- // types.
- //
- // Acceptable values are:
- // - "APP"
- // - "APP_INTERSTITIAL"
- // - "IN_STREAM_VIDEO"
- // - "WEB"
- // - "WEB_INTERSTITIAL"
- //
- // Possible values:
- // "APP"
- // "APP_INTERSTITIAL"
- // "IN_STREAM_VIDEO"
- // "WEB"
- // "WEB_INTERSTITIAL"
- Compatibility []string `json:"compatibility,omitempty"`
-
- // CounterCustomEvents: List of counter events configured for the
- // creative. Applicable to the following creative types: all RICH_MEDIA,
- // and all VPAID.
- CounterCustomEvents []*CreativeCustomEvent `json:"counterCustomEvents,omitempty"`
-
- // CreativeAssets: Assets associated with a creative. Applicable to all
- // but the following creative types: INTERNAL_REDIRECT,
- // INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- CreativeAssets []*CreativeAsset `json:"creativeAssets,omitempty"`
-
- // CreativeFieldAssignments: Creative field assignments for this
- // creative. Applicable to all creative types.
- CreativeFieldAssignments []*CreativeFieldAssignment `json:"creativeFieldAssignments,omitempty"`
-
- // CustomKeyValues: Custom key-values for a Rich Media creative.
- // Key-values let you customize the creative settings of a Rich Media ad
- // running on your site without having to contact the advertiser. You
- // can use key-values to dynamically change the look or functionality of
- // a creative. Applicable to the following creative types: all
- // RICH_MEDIA, and all VPAID.
- CustomKeyValues []string `json:"customKeyValues,omitempty"`
-
- // ExitCustomEvents: List of exit events configured for the creative.
- // Applicable to the following creative types: all RICH_MEDIA, and all
- // VPAID.
- ExitCustomEvents []*CreativeCustomEvent `json:"exitCustomEvents,omitempty"`
-
- // FsCommand: OpenWindow FSCommand of this creative. This lets the SWF
- // file communicate with either Flash Player or the program hosting
- // Flash Player, such as a web browser. This is only triggered if
- // allowScriptAccess field is true. Applicable to the following creative
- // types: FLASH_INPAGE.
- FsCommand *FsCommand `json:"fsCommand,omitempty"`
-
- // HtmlCode: HTML code for the creative. This is a required field when
- // applicable. This field is ignored if htmlCodeLocked is false.
- // Applicable to the following creative types: all CUSTOM, FLASH_INPAGE,
- // and HTML5_BANNER, and all RICH_MEDIA.
- HtmlCode string `json:"htmlCode,omitempty"`
-
- // HtmlCodeLocked: Whether HTML code is DCM-generated or manually
- // entered. Set to true to ignore changes to htmlCode. Applicable to the
- // following creative types: FLASH_INPAGE and HTML5_BANNER.
- HtmlCodeLocked bool `json:"htmlCodeLocked,omitempty"`
-
- // Id: ID of this creative. This is a read-only, auto-generated field.
- // Applicable to all creative types.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this creative. This
- // is a read-only field. Applicable to all creative types.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#creative".
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedInfo: Creative last modification information. This is a
- // read-only field. Applicable to all creative types.
- LastModifiedInfo *LastModifiedInfo `json:"lastModifiedInfo,omitempty"`
-
- // LatestTraffickedCreativeId: Latest Studio trafficked creative ID
- // associated with rich media and VPAID creatives. This is a read-only
- // field. Applicable to the following creative types: all RICH_MEDIA,
- // and all VPAID.
- LatestTraffickedCreativeId int64 `json:"latestTraffickedCreativeId,omitempty,string"`
-
- // Name: Name of the creative. This is a required field and must be less
- // than 256 characters long. Applicable to all creative types.
- Name string `json:"name,omitempty"`
-
- // OverrideCss: Override CSS value for rich media creatives. Applicable
- // to the following creative types: all RICH_MEDIA.
- OverrideCss string `json:"overrideCss,omitempty"`
-
- // RedirectUrl: URL of hosted image or another ad tag. This is a
- // required field when applicable. Applicable to the following creative
- // types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and
- // REDIRECT
- RedirectUrl string `json:"redirectUrl,omitempty"`
-
- // RenderingId: ID of current rendering version. This is a read-only
- // field. Applicable to all creative types.
- RenderingId int64 `json:"renderingId,omitempty,string"`
-
- // RenderingIdDimensionValue: Dimension value for the rendering ID of
- // this creative. This is a read-only field. Applicable to all creative
- // types.
- RenderingIdDimensionValue *DimensionValue `json:"renderingIdDimensionValue,omitempty"`
-
- // RequiredFlashPluginVersion: The minimum required Flash plugin version
- // for this creative. For example, 11.2.202.235. This is a read-only
- // field. Applicable to the following creative types: all RICH_MEDIA,
- // and all VPAID.
- RequiredFlashPluginVersion string `json:"requiredFlashPluginVersion,omitempty"`
-
- // RequiredFlashVersion: The internal Flash version for this creative as
- // calculated by DoubleClick Studio. This is a read-only field.
- // Applicable to the following creative types: FLASH_INPAGE,
- // ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- RequiredFlashVersion int64 `json:"requiredFlashVersion,omitempty"`
-
- // Size: Size associated with this creative. When inserting or updating
- // a creative either the size ID field or size width and height fields
- // can be used. This is a required field when applicable; however for
- // IMAGE and FLASH_INPAGE creatives, if left blank, this field will be
- // automatically set using the actual size of the associated image
- // assets. Applicable to the following creative types: ENHANCED_BANNER,
- // ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all
- // RICH_MEDIA.
- Size *Size `json:"size,omitempty"`
-
- // Skippable: Whether the user can choose to skip the creative.
- // Applicable to the following creative types: INSTREAM_VIDEO.
- Skippable bool `json:"skippable,omitempty"`
-
- // SslCompliant: Whether the creative is SSL-compliant. This is a
- // read-only field. Applicable to all creative types.
- SslCompliant bool `json:"sslCompliant,omitempty"`
-
- // StudioAdvertiserId: Studio advertiser ID associated with rich media
- // and VPAID creatives. This is a read-only field. Applicable to the
- // following creative types: all RICH_MEDIA, and all VPAID.
- StudioAdvertiserId int64 `json:"studioAdvertiserId,omitempty,string"`
-
- // StudioCreativeId: Studio creative ID associated with rich media and
- // VPAID creatives. This is a read-only field. Applicable to the
- // following creative types: all RICH_MEDIA, and all VPAID.
- StudioCreativeId int64 `json:"studioCreativeId,omitempty,string"`
-
- // StudioTraffickedCreativeId: Studio trafficked creative ID associated
- // with rich media and VPAID creatives. This is a read-only field.
- // Applicable to the following creative types: all RICH_MEDIA, and all
- // VPAID.
- StudioTraffickedCreativeId int64 `json:"studioTraffickedCreativeId,omitempty,string"`
-
- // SubaccountId: Subaccount ID of this creative. This field, if left
- // unset, will be auto-generated for both insert and update operations.
- // Applicable to all creative types.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // ThirdPartyBackupImageImpressionsUrl: Third-party URL used to record
- // backup image impressions. Applicable to the following creative types:
- // all RICH_MEDIA
- ThirdPartyBackupImageImpressionsUrl string `json:"thirdPartyBackupImageImpressionsUrl,omitempty"`
-
- // ThirdPartyRichMediaImpressionsUrl: Third-party URL used to record
- // rich media impressions. Applicable to the following creative types:
- // all RICH_MEDIA
- ThirdPartyRichMediaImpressionsUrl string `json:"thirdPartyRichMediaImpressionsUrl,omitempty"`
-
- // ThirdPartyUrls: Third-party URLs for tracking in-stream video
- // creative events. Applicable to the following creative types:
- // INSTREAM_VIDEO and all VPAID.
- ThirdPartyUrls []*ThirdPartyTrackingUrl `json:"thirdPartyUrls,omitempty"`
-
- // TimerCustomEvents: List of timer events configured for the creative.
- // Applicable to the following creative types: all RICH_MEDIA, and all
- // VPAID.
- TimerCustomEvents []*CreativeCustomEvent `json:"timerCustomEvents,omitempty"`
-
- // TotalFileSize: Combined size of all creative assets. This is a
- // read-only field. Applicable to the following creative types: all
- // RICH_MEDIA, and all VPAID.
- TotalFileSize int64 `json:"totalFileSize,omitempty,string"`
-
- // Type: Type of this creative.This is a required field. Applicable to
- // all creative types.
- //
- // Possible values:
- // "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO"
- // "CUSTOM_INPAGE"
- // "CUSTOM_INTERSTITIAL"
- // "ENHANCED_BANNER"
- // "ENHANCED_IMAGE"
- // "FLASH_INPAGE"
- // "HTML5_BANNER"
- // "IMAGE"
- // "INSTREAM_VIDEO"
- // "INTERNAL_REDIRECT"
- // "INTERSTITIAL_INTERNAL_REDIRECT"
- // "REDIRECT"
- // "RICH_MEDIA_EXPANDING"
- // "RICH_MEDIA_IM_EXPAND"
- // "RICH_MEDIA_INPAGE"
- // "RICH_MEDIA_INPAGE_FLOATING"
- // "RICH_MEDIA_INTERSTITIAL_FLOAT"
- // "RICH_MEDIA_MOBILE_IN_APP"
- // "RICH_MEDIA_MULTI_FLOATING"
- // "RICH_MEDIA_PEEL_DOWN"
- // "TRACKING_TEXT"
- // "VAST_REDIRECT"
- // "VPAID_LINEAR"
- // "VPAID_NON_LINEAR"
- Type string `json:"type,omitempty"`
-
- // Version: The version number helps you keep track of multiple versions
- // of your creative in your reports. The version number will always be
- // auto-generated during insert operations to start at 1. For tracking
- // creatives the version cannot be incremented and will always remain at
- // 1. For all other creative types the version can be incremented only
- // by 1 during update operations. In addition, the version will be
- // automatically incremented by 1 when undergoing Rich Media creative
- // merging. Applicable to all creative types.
- Version int64 `json:"version,omitempty"`
-
- // VideoDescription: Description of the video ad. Applicable to the
- // following creative types: INSTREAM_VIDEO and all VPAID.
- VideoDescription string `json:"videoDescription,omitempty"`
-
- // VideoDuration: Creative video duration in seconds. This is a
- // read-only field. Applicable to the following creative types:
- // INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
- VideoDuration float64 `json:"videoDuration,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Creative) MarshalJSON() ([]byte, error) {
- type noMethod Creative
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeAsset: Creative Asset.
-type CreativeAsset struct {
- // ActionScript3: Whether ActionScript3 is enabled for the flash asset.
- // This is a read-only field. Applicable to the following creative
- // types: FLASH_INPAGE and ENHANCED_BANNER.
- ActionScript3 bool `json:"actionScript3,omitempty"`
-
- // Active: Whether the video asset is active. This is a read-only field
- // for VPAID_NON_LINEAR assets. Applicable to the following creative
- // types: INSTREAM_VIDEO and all VPAID.
- Active bool `json:"active,omitempty"`
-
- // Alignment: Possible alignments for an asset. This is a read-only
- // field. Applicable to the following creative types:
- // RICH_MEDIA_MULTI_FLOATING.
- //
- // Possible values:
- // "ALIGNMENT_BOTTOM"
- // "ALIGNMENT_LEFT"
- // "ALIGNMENT_RIGHT"
- // "ALIGNMENT_TOP"
- Alignment string `json:"alignment,omitempty"`
-
- // ArtworkType: Artwork type of rich media creative. This is a read-only
- // field. Applicable to the following creative types: all RICH_MEDIA.
- //
- // Possible values:
- // "ARTWORK_TYPE_FLASH"
- // "ARTWORK_TYPE_HTML5"
- // "ARTWORK_TYPE_MIXED"
- ArtworkType string `json:"artworkType,omitempty"`
-
- // AssetIdentifier: Identifier of this asset. This is the same
- // identifier returned during creative asset insert operation. This is a
- // required field. Applicable to all but the following creative types:
- // all REDIRECT and TRACKING_TEXT.
- AssetIdentifier *CreativeAssetId `json:"assetIdentifier,omitempty"`
-
- // BackupImageExit: Exit event configured for the backup image.
- // Applicable to the following creative types: all RICH_MEDIA.
- BackupImageExit *CreativeCustomEvent `json:"backupImageExit,omitempty"`
-
- // BitRate: Detected bit-rate for video asset. This is a read-only
- // field. Applicable to the following creative types: INSTREAM_VIDEO and
- // all VPAID.
- BitRate int64 `json:"bitRate,omitempty"`
-
- // ChildAssetType: Rich media child asset type. This is a read-only
- // field. Applicable to the following creative types: all VPAID.
- //
- // Possible values:
- // "CHILD_ASSET_TYPE_DATA"
- // "CHILD_ASSET_TYPE_FLASH"
- // "CHILD_ASSET_TYPE_IMAGE"
- // "CHILD_ASSET_TYPE_VIDEO"
- ChildAssetType string `json:"childAssetType,omitempty"`
-
- // CollapsedSize: Size of an asset when collapsed. This is a read-only
- // field. Applicable to the following creative types: all RICH_MEDIA and
- // all VPAID. Additionally, applicable to assets whose displayType is
- // ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- CollapsedSize *Size `json:"collapsedSize,omitempty"`
-
- // CustomStartTimeValue: Custom start time in seconds for making the
- // asset visible. Applicable to the following creative types: all
- // RICH_MEDIA.
- CustomStartTimeValue int64 `json:"customStartTimeValue,omitempty"`
-
- // DetectedFeatures: List of feature dependencies for the creative asset
- // that are detected by DCM. Feature dependencies are features that a
- // browser must be able to support in order to render your HTML5
- // creative correctly. This is a read-only, auto-generated field.
- // Applicable to the following creative types: ENHANCED_BANNER and
- // HTML5_BANNER.
- //
- // Possible values:
- // "APPLICATION_CACHE"
- // "AUDIO"
- // "CANVAS"
- // "CANVAS_TEXT"
- // "CSS_ANIMATIONS"
- // "CSS_BACKGROUND_SIZE"
- // "CSS_BORDER_IMAGE"
- // "CSS_BORDER_RADIUS"
- // "CSS_BOX_SHADOW"
- // "CSS_COLUMNS"
- // "CSS_FLEX_BOX"
- // "CSS_FONT_FACE"
- // "CSS_GENERATED_CONTENT"
- // "CSS_GRADIENTS"
- // "CSS_HSLA"
- // "CSS_MULTIPLE_BGS"
- // "CSS_OPACITY"
- // "CSS_REFLECTIONS"
- // "CSS_RGBA"
- // "CSS_TEXT_SHADOW"
- // "CSS_TRANSFORMS"
- // "CSS_TRANSFORMS3D"
- // "CSS_TRANSITIONS"
- // "DRAG_AND_DROP"
- // "GEO_LOCATION"
- // "HASH_CHANGE"
- // "HISTORY"
- // "INDEXED_DB"
- // "INLINE_SVG"
- // "INPUT_ATTR_AUTOCOMPLETE"
- // "INPUT_ATTR_AUTOFOCUS"
- // "INPUT_ATTR_LIST"
- // "INPUT_ATTR_MAX"
- // "INPUT_ATTR_MIN"
- // "INPUT_ATTR_MULTIPLE"
- // "INPUT_ATTR_PATTERN"
- // "INPUT_ATTR_PLACEHOLDER"
- // "INPUT_ATTR_REQUIRED"
- // "INPUT_ATTR_STEP"
- // "INPUT_TYPE_COLOR"
- // "INPUT_TYPE_DATE"
- // "INPUT_TYPE_DATETIME"
- // "INPUT_TYPE_DATETIME_LOCAL"
- // "INPUT_TYPE_EMAIL"
- // "INPUT_TYPE_MONTH"
- // "INPUT_TYPE_NUMBER"
- // "INPUT_TYPE_RANGE"
- // "INPUT_TYPE_SEARCH"
- // "INPUT_TYPE_TEL"
- // "INPUT_TYPE_TIME"
- // "INPUT_TYPE_URL"
- // "INPUT_TYPE_WEEK"
- // "LOCAL_STORAGE"
- // "POST_MESSAGE"
- // "SESSION_STORAGE"
- // "SMIL"
- // "SVG_CLIP_PATHS"
- // "SVG_FE_IMAGE"
- // "SVG_FILTERS"
- // "SVG_HREF"
- // "TOUCH"
- // "VIDEO"
- // "WEBGL"
- // "WEB_SOCKETS"
- // "WEB_SQL_DATABASE"
- // "WEB_WORKERS"
- DetectedFeatures []string `json:"detectedFeatures,omitempty"`
-
- // DisplayType: Type of rich media asset. This is a read-only field.
- // Applicable to the following creative types: all RICH_MEDIA.
- //
- // Possible values:
- // "ASSET_DISPLAY_TYPE_EXPANDING"
- // "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH"
- // "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH_EXPANDING"
- // "ASSET_DISPLAY_TYPE_FLOATING"
- // "ASSET_DISPLAY_TYPE_INPAGE"
- // "ASSET_DISPLAY_TYPE_OVERLAY"
- // "ASSET_DISPLAY_TYPE_PEEL_DOWN"
- // "ASSET_DISPLAY_TYPE_VPAID_LINEAR"
- // "ASSET_DISPLAY_TYPE_VPAID_NON_LINEAR"
- DisplayType string `json:"displayType,omitempty"`
-
- // Duration: Duration in seconds for which an asset will be displayed.
- // Applicable to the following creative types: INSTREAM_VIDEO and
- // VPAID_LINEAR.
- Duration int64 `json:"duration,omitempty"`
-
- // DurationType: Duration type for which an asset will be displayed.
- // Applicable to the following creative types: all RICH_MEDIA.
- //
- // Possible values:
- // "ASSET_DURATION_TYPE_AUTO"
- // "ASSET_DURATION_TYPE_CUSTOM"
- // "ASSET_DURATION_TYPE_NONE"
- DurationType string `json:"durationType,omitempty"`
-
- // ExpandedDimension: Detected expanded dimension for video asset. This
- // is a read-only field. Applicable to the following creative types:
- // INSTREAM_VIDEO and all VPAID.
- ExpandedDimension *Size `json:"expandedDimension,omitempty"`
-
- // FileSize: File size associated with this creative asset. This is a
- // read-only field. Applicable to all but the following creative types:
- // all REDIRECT and TRACKING_TEXT.
- FileSize int64 `json:"fileSize,omitempty,string"`
-
- // FlashVersion: Flash version of the asset. This is a read-only field.
- // Applicable to the following creative types: FLASH_INPAGE,
- // ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- FlashVersion int64 `json:"flashVersion,omitempty"`
-
- // HideFlashObjects: Whether to hide Flash objects flag for an asset.
- // Applicable to the following creative types: all RICH_MEDIA.
- HideFlashObjects bool `json:"hideFlashObjects,omitempty"`
-
- // HideSelectionBoxes: Whether to hide selection boxes flag for an
- // asset. Applicable to the following creative types: all RICH_MEDIA.
- HideSelectionBoxes bool `json:"hideSelectionBoxes,omitempty"`
-
- // HorizontallyLocked: Whether the asset is horizontally locked. This is
- // a read-only field. Applicable to the following creative types: all
- // RICH_MEDIA.
- HorizontallyLocked bool `json:"horizontallyLocked,omitempty"`
-
- // Id: Numeric ID of this creative asset. This is a required field and
- // should not be modified. Applicable to all but the following creative
- // types: all REDIRECT and TRACKING_TEXT.
- Id int64 `json:"id,omitempty,string"`
-
- // MimeType: Detected MIME type for video asset. This is a read-only
- // field. Applicable to the following creative types: INSTREAM_VIDEO and
- // all VPAID.
- MimeType string `json:"mimeType,omitempty"`
-
- // Offset: Offset position for an asset in collapsed mode. This is a
- // read-only field. Applicable to the following creative types: all
- // RICH_MEDIA and all VPAID. Additionally, only applicable to assets
- // whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or
- // ASSET_DISPLAY_TYPE_PEEL_DOWN.
- Offset *OffsetPosition `json:"offset,omitempty"`
-
- // OriginalBackup: Whether the backup asset is original or changed by
- // the user in DCM. Applicable to the following creative types: all
- // RICH_MEDIA.
- OriginalBackup bool `json:"originalBackup,omitempty"`
-
- // Position: Offset position for an asset. Applicable to the following
- // creative types: all RICH_MEDIA.
- Position *OffsetPosition `json:"position,omitempty"`
-
- // PositionLeftUnit: Offset left unit for an asset. This is a read-only
- // field. Applicable to the following creative types: all RICH_MEDIA.
- //
- // Possible values:
- // "OFFSET_UNIT_PERCENT"
- // "OFFSET_UNIT_PIXEL"
- // "OFFSET_UNIT_PIXEL_FROM_CENTER"
- PositionLeftUnit string `json:"positionLeftUnit,omitempty"`
-
- // PositionTopUnit: Offset top unit for an asset. This is a read-only
- // field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY.
- // Applicable to the following creative types: all RICH_MEDIA.
- //
- // Possible values:
- // "OFFSET_UNIT_PERCENT"
- // "OFFSET_UNIT_PIXEL"
- // "OFFSET_UNIT_PIXEL_FROM_CENTER"
- PositionTopUnit string `json:"positionTopUnit,omitempty"`
-
- // ProgressiveServingUrl: Progressive URL for video asset. This is a
- // read-only field. Applicable to the following creative types:
- // INSTREAM_VIDEO and all VPAID.
- ProgressiveServingUrl string `json:"progressiveServingUrl,omitempty"`
-
- // Pushdown: Whether the asset pushes down other content. Applicable to
- // the following creative types: all RICH_MEDIA. Additionally, only
- // applicable when the asset offsets are 0, the collapsedSize.width
- // matches size.width, and the collapsedSize.height is less than
- // size.height.
- Pushdown bool `json:"pushdown,omitempty"`
-
- // PushdownDuration: Pushdown duration in seconds for an asset. Must be
- // between 0 and 9.99. Applicable to the following creative types: all
- // RICH_MEDIA.Additionally, only applicable when the asset pushdown
- // field is true, the offsets are 0, the collapsedSize.width matches
- // size.width, and the collapsedSize.height is less than size.height.
- PushdownDuration float64 `json:"pushdownDuration,omitempty"`
-
- // Role: Role of the asset in relation to creative. Applicable to all
- // but the following creative types: all REDIRECT and TRACKING_TEXT.
- // This is a required field.
- // PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER,
- // IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple
- // primary assets), and all VPAID creatives.
- // BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER,
- // all RICH_MEDIA, and all VPAID creatives.
- // ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE
- // creatives.
- // OTHER refers to assets from sources other than DCM, such as Studio
- // uploaded assets, applicable to all RICH_MEDIA and all VPAID
- // creatives.
- // PARENT_VIDEO refers to videos uploaded by the user in DCM and is
- // applicable to INSTREAM_VIDEO and VPAID_LINEAR
- // creatives.
- // TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO
- // assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR
- // creatives.
- // ALTERNATE_VIDEO refers to the DCM representation of child asset
- // videos from Studio, and is applicable to VPAID_LINEAR creatives.
- // These cannot be added or removed within DCM.
- // For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and
- // ALTERNATE_VIDEO assets that are marked active serve as backup in case
- // the VPAID creative cannot be served. Only PARENT_VIDEO assets can be
- // added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
- //
- // Possible values:
- // "ADDITIONAL_FLASH"
- // "ADDITIONAL_IMAGE"
- // "ALTERNATE_VIDEO"
- // "BACKUP_IMAGE"
- // "OTHER"
- // "PARENT_VIDEO"
- // "PRIMARY"
- // "TRANSCODED_VIDEO"
- Role string `json:"role,omitempty"`
-
- // Size: Size associated with this creative asset. This is a required
- // field when applicable; however for IMAGE and FLASH_INPAGE creatives,
- // if left blank, this field will be automatically set using the actual
- // size of the associated image asset. Applicable to the following
- // creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE,
- // HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- Size *Size `json:"size,omitempty"`
-
- // SslCompliant: Whether the asset is SSL-compliant. This is a read-only
- // field. Applicable to all but the following creative types: all
- // REDIRECT and TRACKING_TEXT.
- SslCompliant bool `json:"sslCompliant,omitempty"`
-
- // StartTimeType: Initial wait time type before making the asset
- // visible. Applicable to the following creative types: all RICH_MEDIA.
- //
- // Possible values:
- // "ASSET_START_TIME_TYPE_CUSTOM"
- // "ASSET_START_TIME_TYPE_NONE"
- StartTimeType string `json:"startTimeType,omitempty"`
-
- // StreamingServingUrl: Streaming URL for video asset. This is a
- // read-only field. Applicable to the following creative types:
- // INSTREAM_VIDEO and all VPAID.
- StreamingServingUrl string `json:"streamingServingUrl,omitempty"`
-
- // Transparency: Whether the asset is transparent. Applicable to the
- // following creative types: all RICH_MEDIA. Additionally, only
- // applicable to HTML5 assets.
- Transparency bool `json:"transparency,omitempty"`
-
- // VerticallyLocked: Whether the asset is vertically locked. This is a
- // read-only field. Applicable to the following creative types: all
- // RICH_MEDIA.
- VerticallyLocked bool `json:"verticallyLocked,omitempty"`
-
- // VideoDuration: Detected video duration for video asset. This is a
- // read-only field. Applicable to the following creative types:
- // INSTREAM_VIDEO and all VPAID.
- VideoDuration float64 `json:"videoDuration,omitempty"`
-
- // WindowMode: Window mode options for flash assets. Applicable to the
- // following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING,
- // RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and
- // RICH_MEDIA_INPAGE_FLOATING.
- //
- // Possible values:
- // "OPAQUE"
- // "TRANSPARENT"
- // "WINDOW"
- WindowMode string `json:"windowMode,omitempty"`
-
- // ZIndex: zIndex value of an asset. This is a read-only field.
- // Applicable to the following creative types: all
- // RICH_MEDIA.Additionally, only applicable to assets whose displayType
- // is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or
- // ASSET_DISPLAY_TYPE_OVERLAY.
- ZIndex int64 `json:"zIndex,omitempty"`
-
- // ZipFilename: File name of zip file. This is a read-only field.
- // Applicable to the following creative types: HTML5_BANNER.
- ZipFilename string `json:"zipFilename,omitempty"`
-
- // ZipFilesize: Size of zip file. This is a read-only field. Applicable
- // to the following creative types: HTML5_BANNER.
- ZipFilesize string `json:"zipFilesize,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ActionScript3") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeAsset) MarshalJSON() ([]byte, error) {
- type noMethod CreativeAsset
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeAssetId: Creative Asset ID.
-type CreativeAssetId struct {
- // Name: Name of the creative asset. This is a required field while
- // inserting an asset. After insertion, this assetIdentifier is used to
- // identify the uploaded asset. Characters in the name must be
- // alphanumeric or one of the following: ".-_ ". Spaces are allowed.
- Name string `json:"name,omitempty"`
-
- // Type: Type of asset to upload. This is a required field. IMAGE is
- // solely used for IMAGE creatives. Other image assets should use
- // HTML_IMAGE.
- //
- // Possible values:
- // "FLASH"
- // "HTML"
- // "HTML_IMAGE"
- // "IMAGE"
- // "VIDEO"
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Name") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeAssetId) MarshalJSON() ([]byte, error) {
- type noMethod CreativeAssetId
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeAssetMetadata: CreativeAssets contains properties of a
-// creative asset file which will be uploaded or has already been
-// uploaded. Refer to the creative sample code for how to upload assets
-// and insert a creative.
-type CreativeAssetMetadata struct {
- // AssetIdentifier: ID of the creative asset. This is a required field.
- AssetIdentifier *CreativeAssetId `json:"assetIdentifier,omitempty"`
-
- // ClickTags: List of detected click tags for assets. This is a
- // read-only auto-generated field.
- ClickTags []*ClickTag `json:"clickTags,omitempty"`
-
- // DetectedFeatures: List of feature dependencies for the creative asset
- // that are detected by DCM. Feature dependencies are features that a
- // browser must be able to support in order to render your HTML5
- // creative correctly. This is a read-only, auto-generated field.
- //
- // Possible values:
- // "APPLICATION_CACHE"
- // "AUDIO"
- // "CANVAS"
- // "CANVAS_TEXT"
- // "CSS_ANIMATIONS"
- // "CSS_BACKGROUND_SIZE"
- // "CSS_BORDER_IMAGE"
- // "CSS_BORDER_RADIUS"
- // "CSS_BOX_SHADOW"
- // "CSS_COLUMNS"
- // "CSS_FLEX_BOX"
- // "CSS_FONT_FACE"
- // "CSS_GENERATED_CONTENT"
- // "CSS_GRADIENTS"
- // "CSS_HSLA"
- // "CSS_MULTIPLE_BGS"
- // "CSS_OPACITY"
- // "CSS_REFLECTIONS"
- // "CSS_RGBA"
- // "CSS_TEXT_SHADOW"
- // "CSS_TRANSFORMS"
- // "CSS_TRANSFORMS3D"
- // "CSS_TRANSITIONS"
- // "DRAG_AND_DROP"
- // "GEO_LOCATION"
- // "HASH_CHANGE"
- // "HISTORY"
- // "INDEXED_DB"
- // "INLINE_SVG"
- // "INPUT_ATTR_AUTOCOMPLETE"
- // "INPUT_ATTR_AUTOFOCUS"
- // "INPUT_ATTR_LIST"
- // "INPUT_ATTR_MAX"
- // "INPUT_ATTR_MIN"
- // "INPUT_ATTR_MULTIPLE"
- // "INPUT_ATTR_PATTERN"
- // "INPUT_ATTR_PLACEHOLDER"
- // "INPUT_ATTR_REQUIRED"
- // "INPUT_ATTR_STEP"
- // "INPUT_TYPE_COLOR"
- // "INPUT_TYPE_DATE"
- // "INPUT_TYPE_DATETIME"
- // "INPUT_TYPE_DATETIME_LOCAL"
- // "INPUT_TYPE_EMAIL"
- // "INPUT_TYPE_MONTH"
- // "INPUT_TYPE_NUMBER"
- // "INPUT_TYPE_RANGE"
- // "INPUT_TYPE_SEARCH"
- // "INPUT_TYPE_TEL"
- // "INPUT_TYPE_TIME"
- // "INPUT_TYPE_URL"
- // "INPUT_TYPE_WEEK"
- // "LOCAL_STORAGE"
- // "POST_MESSAGE"
- // "SESSION_STORAGE"
- // "SMIL"
- // "SVG_CLIP_PATHS"
- // "SVG_FE_IMAGE"
- // "SVG_FILTERS"
- // "SVG_HREF"
- // "TOUCH"
- // "VIDEO"
- // "WEBGL"
- // "WEB_SOCKETS"
- // "WEB_SQL_DATABASE"
- // "WEB_WORKERS"
- DetectedFeatures []string `json:"detectedFeatures,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#creativeAssetMetadata".
- Kind string `json:"kind,omitempty"`
-
- // WarnedValidationRules: Rules validated during code generation that
- // generated a warning. This is a read-only, auto-generated
- // field.
- //
- // Possible values are:
- // - "CLICK_TAG_NON_TOP_LEVEL"
- // - "CLICK_TAG_MISSING"
- // - "CLICK_TAG_MORE_THAN_ONE"
- // - "CLICK_TAG_INVALID"
- // - "ORPHANED_ASSET"
- // - "PRIMARY_HTML_MISSING"
- // - "EXTERNAL_FILE_REFERENCED"
- // - "MRAID_REFERENCED"
- // - "ADMOB_REFERENCED"
- // - "FILE_TYPE_INVALID"
- // - "ZIP_INVALID"
- // - "LINKED_FILE_NOT_FOUND"
- // - "MAX_FLASH_VERSION_11"
- // - "NOT_SSL_COMPLIANT"
- // - "FILE_DETAIL_EMPTY"
- // - "ASSET_INVALID"
- // - "GWD_PROPERTIES_INVALID"
- // - "ENABLER_UNSUPPORTED_METHOD_DCM"
- // - "ASSET_FORMAT_UNSUPPORTED_DCM"
- // - "COMPONENT_UNSUPPORTED_DCM"
- // - "HTML5_FEATURE_UNSUPPORTED' "
- //
- // Possible values:
- // "ADMOB_REFERENCED"
- // "ASSET_FORMAT_UNSUPPORTED_DCM"
- // "ASSET_INVALID"
- // "CLICK_TAG_INVALID"
- // "CLICK_TAG_MISSING"
- // "CLICK_TAG_MORE_THAN_ONE"
- // "CLICK_TAG_NON_TOP_LEVEL"
- // "COMPONENT_UNSUPPORTED_DCM"
- // "ENABLER_UNSUPPORTED_METHOD_DCM"
- // "EXTERNAL_FILE_REFERENCED"
- // "FILE_DETAIL_EMPTY"
- // "FILE_TYPE_INVALID"
- // "GWD_PROPERTIES_INVALID"
- // "HTML5_FEATURE_UNSUPPORTED"
- // "LINKED_FILE_NOT_FOUND"
- // "MAX_FLASH_VERSION_11"
- // "MRAID_REFERENCED"
- // "NOT_SSL_COMPLIANT"
- // "ORPHANED_ASSET"
- // "PRIMARY_HTML_MISSING"
- // "ZIP_INVALID"
- WarnedValidationRules []string `json:"warnedValidationRules,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AssetIdentifier") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeAssetMetadata) MarshalJSON() ([]byte, error) {
- type noMethod CreativeAssetMetadata
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeAssignment: Creative Assignment.
-type CreativeAssignment struct {
- // Active: Whether this creative assignment is active. When true, the
- // creative will be included in the ad's rotation.
- Active bool `json:"active,omitempty"`
-
- // ApplyEventTags: Whether applicable event tags should fire when this
- // creative assignment is rendered. If this value is unset when the ad
- // is inserted or updated, it will default to true for all creative
- // types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT,
- // and INSTREAM_VIDEO.
- ApplyEventTags bool `json:"applyEventTags,omitempty"`
-
- // ClickThroughUrl: Click-through URL of the creative assignment.
- ClickThroughUrl *ClickThroughUrl `json:"clickThroughUrl,omitempty"`
-
- // CompanionCreativeOverrides: Companion creative overrides for this
- // creative assignment. Applicable to video ads.
- CompanionCreativeOverrides []*CompanionClickThroughOverride `json:"companionCreativeOverrides,omitempty"`
-
- // CreativeGroupAssignments: Creative group assignments for this
- // creative assignment. Only one assignment per creative group number is
- // allowed for a maximum of two assignments.
- CreativeGroupAssignments []*CreativeGroupAssignment `json:"creativeGroupAssignments,omitempty"`
-
- // CreativeId: ID of the creative to be assigned. This is a required
- // field.
- CreativeId int64 `json:"creativeId,omitempty,string"`
-
- // CreativeIdDimensionValue: Dimension value for the ID of the creative.
- // This is a read-only, auto-generated field.
- CreativeIdDimensionValue *DimensionValue `json:"creativeIdDimensionValue,omitempty"`
-
- // EndTime: Date and time that the assigned creative should stop
- // serving. Must be later than the start time.
- EndTime string `json:"endTime,omitempty"`
-
- // RichMediaExitOverrides: Rich media exit overrides for this creative
- // assignment.
- // Applicable when the creative type is any of the following:
- // - RICH_MEDIA_INPAGE
- // - RICH_MEDIA_INPAGE_FLOATING
- // - RICH_MEDIA_IM_EXPAND
- // - RICH_MEDIA_EXPANDING
- // - RICH_MEDIA_INTERSTITIAL_FLOAT
- // - RICH_MEDIA_MOBILE_IN_APP
- // - RICH_MEDIA_MULTI_FLOATING
- // - RICH_MEDIA_PEEL_DOWN
- // - ADVANCED_BANNER
- // - VPAID_LINEAR
- // - VPAID_NON_LINEAR
- RichMediaExitOverrides []*RichMediaExitOverride `json:"richMediaExitOverrides,omitempty"`
-
- // Sequence: Sequence number of the creative assignment, applicable when
- // the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
- Sequence int64 `json:"sequence,omitempty"`
-
- // SslCompliant: Whether the creative to be assigned is SSL-compliant.
- // This is a read-only field that is auto-generated when the ad is
- // inserted or updated.
- SslCompliant bool `json:"sslCompliant,omitempty"`
-
- // StartTime: Date and time that the assigned creative should start
- // serving.
- StartTime string `json:"startTime,omitempty"`
-
- // Weight: Weight of the creative assignment, applicable when the
- // rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
- Weight int64 `json:"weight,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Active") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeAssignment) MarshalJSON() ([]byte, error) {
- type noMethod CreativeAssignment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeCustomEvent: Creative Custom Event.
-type CreativeCustomEvent struct {
- // Active: Whether the event is active.
- Active bool `json:"active,omitempty"`
-
- // AdvertiserCustomEventName: User-entered name for the event.
- AdvertiserCustomEventName string `json:"advertiserCustomEventName,omitempty"`
-
- // AdvertiserCustomEventType: Type of the event. This is a read-only
- // field.
- //
- // Possible values:
- // "ADVERTISER_EVENT_COUNTER"
- // "ADVERTISER_EVENT_EXIT"
- // "ADVERTISER_EVENT_TIMER"
- AdvertiserCustomEventType string `json:"advertiserCustomEventType,omitempty"`
-
- // ArtworkLabel: Artwork label column, used to link events in DCM back
- // to events in Studio. This is a required field and should not be
- // modified after insertion.
- ArtworkLabel string `json:"artworkLabel,omitempty"`
-
- // ArtworkType: Artwork type used by the creative.This is a read-only
- // field.
- //
- // Possible values:
- // "ARTWORK_TYPE_FLASH"
- // "ARTWORK_TYPE_HTML5"
- // "ARTWORK_TYPE_MIXED"
- ArtworkType string `json:"artworkType,omitempty"`
-
- // ExitUrl: Exit URL of the event. This field is used only for exit
- // events.
- ExitUrl string `json:"exitUrl,omitempty"`
-
- // Id: ID of this event. This is a required field and should not be
- // modified after insertion.
- Id int64 `json:"id,omitempty,string"`
-
- // PopupWindowProperties: Properties for rich media popup windows. This
- // field is used only for exit events.
- PopupWindowProperties *PopupWindowProperties `json:"popupWindowProperties,omitempty"`
-
- // TargetType: Target type used by the event.
- //
- // Possible values:
- // "TARGET_BLANK"
- // "TARGET_PARENT"
- // "TARGET_POPUP"
- // "TARGET_SELF"
- // "TARGET_TOP"
- TargetType string `json:"targetType,omitempty"`
-
- // VideoReportingId: Reporting ID, used to differentiate multiple videos
- // in a single creative.
- VideoReportingId string `json:"videoReportingId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Active") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeCustomEvent) MarshalJSON() ([]byte, error) {
- type noMethod CreativeCustomEvent
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeField: Contains properties of a creative field.
-type CreativeField struct {
- // AccountId: Account ID of this creative field. This is a read-only
- // field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this creative field. This is a
- // required field on insertion.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // Id: ID of this creative field. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#creativeField".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this creative field. This is a required field and must
- // be less than 256 characters long and unique among creative fields of
- // the same advertiser.
- Name string `json:"name,omitempty"`
-
- // SubaccountId: Subaccount ID of this creative field. This is a
- // read-only field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeField) MarshalJSON() ([]byte, error) {
- type noMethod CreativeField
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeFieldAssignment: Creative Field Assignment.
-type CreativeFieldAssignment struct {
- // CreativeFieldId: ID of the creative field.
- CreativeFieldId int64 `json:"creativeFieldId,omitempty,string"`
-
- // CreativeFieldValueId: ID of the creative field value.
- CreativeFieldValueId int64 `json:"creativeFieldValueId,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "CreativeFieldId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeFieldAssignment) MarshalJSON() ([]byte, error) {
- type noMethod CreativeFieldAssignment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeFieldValue: Contains properties of a creative field value.
-type CreativeFieldValue struct {
- // Id: ID of this creative field value. This is a read-only,
- // auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#creativeFieldValue".
- Kind string `json:"kind,omitempty"`
-
- // Value: Value of this creative field value. It needs to be less than
- // 256 characters in length and unique per creative field.
- Value string `json:"value,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeFieldValue) MarshalJSON() ([]byte, error) {
- type noMethod CreativeFieldValue
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeFieldValuesListResponse: Creative Field Value List Response
-type CreativeFieldValuesListResponse struct {
- // CreativeFieldValues: Creative field value collection.
- CreativeFieldValues []*CreativeFieldValue `json:"creativeFieldValues,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#creativeFieldValuesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreativeFieldValues")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeFieldValuesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod CreativeFieldValuesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeFieldsListResponse: Creative Field List Response
-type CreativeFieldsListResponse struct {
- // CreativeFields: Creative field collection.
- CreativeFields []*CreativeField `json:"creativeFields,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#creativeFieldsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreativeFields") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeFieldsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod CreativeFieldsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeGroup: Contains properties of a creative group.
-type CreativeGroup struct {
- // AccountId: Account ID of this creative group. This is a read-only
- // field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this creative group. This is a
- // required field on insertion.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // GroupNumber: Subgroup of the creative group. Assign your creative
- // groups to one of the following subgroups in order to filter or manage
- // them more easily. This field is required on insertion and is
- // read-only after insertion.
- // Acceptable values are:
- // - 1
- // - 2
- GroupNumber int64 `json:"groupNumber,omitempty"`
-
- // Id: ID of this creative group. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#creativeGroup".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this creative group. This is a required field and must
- // be less than 256 characters long and unique among creative groups of
- // the same advertiser.
- Name string `json:"name,omitempty"`
-
- // SubaccountId: Subaccount ID of this creative group. This is a
- // read-only field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeGroup) MarshalJSON() ([]byte, error) {
- type noMethod CreativeGroup
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeGroupAssignment: Creative Group Assignment.
-type CreativeGroupAssignment struct {
- // CreativeGroupId: ID of the creative group to be assigned.
- CreativeGroupId int64 `json:"creativeGroupId,omitempty,string"`
-
- // CreativeGroupNumber: Creative group number of the creative group
- // assignment.
- //
- // Possible values:
- // "CREATIVE_GROUP_ONE"
- // "CREATIVE_GROUP_TWO"
- CreativeGroupNumber string `json:"creativeGroupNumber,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CreativeGroupId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeGroupAssignment) MarshalJSON() ([]byte, error) {
- type noMethod CreativeGroupAssignment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeGroupsListResponse: Creative Group List Response
-type CreativeGroupsListResponse struct {
- // CreativeGroups: Creative group collection.
- CreativeGroups []*CreativeGroup `json:"creativeGroups,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#creativeGroupsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreativeGroups") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeGroupsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod CreativeGroupsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeOptimizationConfiguration: Creative optimization settings.
-type CreativeOptimizationConfiguration struct {
- // Id: ID of this creative optimization config. This field is
- // auto-generated when the campaign is inserted or updated. It can be
- // null for existing campaigns.
- Id int64 `json:"id,omitempty,string"`
-
- // Name: Name of this creative optimization config. This is a required
- // field and must be less than 129 characters long.
- Name string `json:"name,omitempty"`
-
- // OptimizationActivitys: List of optimization activities associated
- // with this configuration.
- OptimizationActivitys []*OptimizationActivity `json:"optimizationActivitys,omitempty"`
-
- // OptimizationModel: Optimization model for this configuration.
- //
- // Possible values:
- // "CLICK"
- // "POST_CLICK"
- // "POST_CLICK_AND_IMPRESSION"
- // "POST_IMPRESSION"
- OptimizationModel string `json:"optimizationModel,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeOptimizationConfiguration) MarshalJSON() ([]byte, error) {
- type noMethod CreativeOptimizationConfiguration
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeRotation: Creative Rotation.
-type CreativeRotation struct {
- // CreativeAssignments: Creative assignments in this creative rotation.
- CreativeAssignments []*CreativeAssignment `json:"creativeAssignments,omitempty"`
-
- // CreativeOptimizationConfigurationId: Creative optimization
- // configuration that is used by this ad. It should refer to one of the
- // existing optimization configurations in the ad's campaign. If it is
- // unset or set to 0, then the campaign's default optimization
- // configuration will be used for this ad.
- CreativeOptimizationConfigurationId int64 `json:"creativeOptimizationConfigurationId,omitempty,string"`
-
- // Type: Type of creative rotation. Can be used to specify whether to
- // use sequential or random rotation.
- //
- // Possible values:
- // "CREATIVE_ROTATION_TYPE_RANDOM"
- // "CREATIVE_ROTATION_TYPE_SEQUENTIAL"
- Type string `json:"type,omitempty"`
-
- // WeightCalculationStrategy: Strategy for calculating weights. Used
- // with CREATIVE_ROTATION_TYPE_RANDOM.
- //
- // Possible values:
- // "WEIGHT_STRATEGY_CUSTOM"
- // "WEIGHT_STRATEGY_EQUAL"
- // "WEIGHT_STRATEGY_HIGHEST_CTR"
- // "WEIGHT_STRATEGY_OPTIMIZED"
- WeightCalculationStrategy string `json:"weightCalculationStrategy,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CreativeAssignments")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeRotation) MarshalJSON() ([]byte, error) {
- type noMethod CreativeRotation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeSettings: Creative Settings
-type CreativeSettings struct {
- // IFrameFooter: Header text for iFrames for this site. Must be less
- // than or equal to 2000 characters long.
- IFrameFooter string `json:"iFrameFooter,omitempty"`
-
- // IFrameHeader: Header text for iFrames for this site. Must be less
- // than or equal to 2000 characters long.
- IFrameHeader string `json:"iFrameHeader,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "IFrameFooter") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeSettings) MarshalJSON() ([]byte, error) {
- type noMethod CreativeSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativesListResponse: Creative List Response
-type CreativesListResponse struct {
- // Creatives: Creative collection.
- Creatives []*Creative `json:"creatives,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#creativesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Creatives") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod CreativesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CrossDimensionReachReportCompatibleFields: Represents fields that are
-// compatible to be selected for a report of type
-// "CROSS_DIMENSION_REACH".
-type CrossDimensionReachReportCompatibleFields struct {
- // Breakdown: Dimensions which are compatible to be selected in the
- // "breakdown" section of the report.
- Breakdown []*Dimension `json:"breakdown,omitempty"`
-
- // DimensionFilters: Dimensions which are compatible to be selected in
- // the "dimensionFilters" section of the report.
- DimensionFilters []*Dimension `json:"dimensionFilters,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#crossDimensionReachReportCompatibleFields.
- Kind string `json:"kind,omitempty"`
-
- // Metrics: Metrics which are compatible to be selected in the
- // "metricNames" section of the report.
- Metrics []*Metric `json:"metrics,omitempty"`
-
- // OverlapMetrics: Metrics which are compatible to be selected in the
- // "overlapMetricNames" section of the report.
- OverlapMetrics []*Metric `json:"overlapMetrics,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Breakdown") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CrossDimensionReachReportCompatibleFields) MarshalJSON() ([]byte, error) {
- type noMethod CrossDimensionReachReportCompatibleFields
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CustomRichMediaEvents: Represents a Custom Rich Media Events group.
-type CustomRichMediaEvents struct {
- // FilteredEventIds: List of custom rich media event IDs. Dimension
- // values must be all of type dfa:richMediaEventTypeIdAndName.
- FilteredEventIds []*DimensionValue `json:"filteredEventIds,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#customRichMediaEvents.
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "FilteredEventIds") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomRichMediaEvents) MarshalJSON() ([]byte, error) {
- type noMethod CustomRichMediaEvents
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DateRange: Represents a date range.
-type DateRange struct {
- // EndDate: The end date of the date range, inclusive. A string of the
- // format: "yyyy-MM-dd".
- EndDate string `json:"endDate,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#dateRange.
- Kind string `json:"kind,omitempty"`
-
- // RelativeDateRange: The date range relative to the date of when the
- // report is run.
- //
- // Possible values:
- // "LAST_24_MONTHS"
- // "LAST_30_DAYS"
- // "LAST_365_DAYS"
- // "LAST_7_DAYS"
- // "LAST_90_DAYS"
- // "MONTH_TO_DATE"
- // "PREVIOUS_MONTH"
- // "PREVIOUS_QUARTER"
- // "PREVIOUS_WEEK"
- // "PREVIOUS_YEAR"
- // "QUARTER_TO_DATE"
- // "TODAY"
- // "WEEK_TO_DATE"
- // "YEAR_TO_DATE"
- // "YESTERDAY"
- RelativeDateRange string `json:"relativeDateRange,omitempty"`
-
- // StartDate: The start date of the date range, inclusive. A string of
- // the format: "yyyy-MM-dd".
- StartDate string `json:"startDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "EndDate") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DateRange) MarshalJSON() ([]byte, error) {
- type noMethod DateRange
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DayPartTargeting: Day Part Targeting.
-type DayPartTargeting struct {
- // DaysOfWeek: Days of the week when the ad will serve.
- //
- // Acceptable values are:
- // - "SUNDAY"
- // - "MONDAY"
- // - "TUESDAY"
- // - "WEDNESDAY"
- // - "THURSDAY"
- // - "FRIDAY"
- // - "SATURDAY"
- //
- // Possible values:
- // "FRIDAY"
- // "MONDAY"
- // "SATURDAY"
- // "SUNDAY"
- // "THURSDAY"
- // "TUESDAY"
- // "WEDNESDAY"
- DaysOfWeek []string `json:"daysOfWeek,omitempty"`
-
- // HoursOfDay: Hours of the day when the ad will serve. Must be an
- // integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM,
- // and 23 is 11 PM to midnight. Can be specified with days of week, in
- // which case the ad would serve during these hours on the specified
- // days. For example, if Monday, Wednesday, Friday are the days of week
- // specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the
- // ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
- HoursOfDay []int64 `json:"hoursOfDay,omitempty"`
-
- // UserLocalTime: Whether or not to use the user's local time. If false,
- // the America/New York time zone applies.
- UserLocalTime bool `json:"userLocalTime,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DaysOfWeek") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DayPartTargeting) MarshalJSON() ([]byte, error) {
- type noMethod DayPartTargeting
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DefaultClickThroughEventTagProperties: Properties of inheriting and
-// overriding the default click-through event tag. A campaign may
-// override the event tag defined at the advertiser level, and an ad may
-// also override the campaign's setting further.
-type DefaultClickThroughEventTagProperties struct {
- // DefaultClickThroughEventTagId: ID of the click-through event tag to
- // apply to all ads in this entity's scope.
- DefaultClickThroughEventTagId int64 `json:"defaultClickThroughEventTagId,omitempty,string"`
-
- // OverrideInheritedEventTag: Whether this entity should override the
- // inherited default click-through event tag with its own defined value.
- OverrideInheritedEventTag bool `json:"overrideInheritedEventTag,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "DefaultClickThroughEventTagId") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DefaultClickThroughEventTagProperties) MarshalJSON() ([]byte, error) {
- type noMethod DefaultClickThroughEventTagProperties
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DeliverySchedule: Delivery Schedule.
-type DeliverySchedule struct {
- // FrequencyCap: Limit on the number of times an individual user can be
- // served the ad within a specified period of time.
- FrequencyCap *FrequencyCap `json:"frequencyCap,omitempty"`
-
- // HardCutoff: Whether or not hard cutoff is enabled. If true, the ad
- // will not serve after the end date and time. Otherwise the ad will
- // continue to be served until it has reached its delivery goals.
- HardCutoff bool `json:"hardCutoff,omitempty"`
-
- // ImpressionRatio: Impression ratio for this ad. This ratio determines
- // how often each ad is served relative to the others. For example, if
- // ad A has an impression ratio of 1 and ad B has an impression ratio of
- // 3, then DCM will serve ad B three times as often as ad A. Must be
- // between 1 and 10.
- ImpressionRatio int64 `json:"impressionRatio,omitempty,string"`
-
- // Priority: Serving priority of an ad, with respect to other ads. The
- // lower the priority number, the greater the priority with which it is
- // served.
- //
- // Possible values:
- // "AD_PRIORITY_01"
- // "AD_PRIORITY_02"
- // "AD_PRIORITY_03"
- // "AD_PRIORITY_04"
- // "AD_PRIORITY_05"
- // "AD_PRIORITY_06"
- // "AD_PRIORITY_07"
- // "AD_PRIORITY_08"
- // "AD_PRIORITY_09"
- // "AD_PRIORITY_10"
- // "AD_PRIORITY_11"
- // "AD_PRIORITY_12"
- // "AD_PRIORITY_13"
- // "AD_PRIORITY_14"
- // "AD_PRIORITY_15"
- // "AD_PRIORITY_16"
- Priority string `json:"priority,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "FrequencyCap") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DeliverySchedule) MarshalJSON() ([]byte, error) {
- type noMethod DeliverySchedule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DfpSettings: DFP Settings
-type DfpSettings struct {
- // DfpNetworkCode: DFP network code for this directory site.
- DfpNetworkCode string `json:"dfp_network_code,omitempty"`
-
- // DfpNetworkName: DFP network name for this directory site.
- DfpNetworkName string `json:"dfp_network_name,omitempty"`
-
- // ProgrammaticPlacementAccepted: Whether this directory site accepts
- // programmatic placements.
- ProgrammaticPlacementAccepted bool `json:"programmaticPlacementAccepted,omitempty"`
-
- // PubPaidPlacementAccepted: Whether this directory site accepts
- // publisher-paid tags.
- PubPaidPlacementAccepted bool `json:"pubPaidPlacementAccepted,omitempty"`
-
- // PublisherPortalOnly: Whether this directory site is available only
- // via DoubleClick Publisher Portal.
- PublisherPortalOnly bool `json:"publisherPortalOnly,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DfpNetworkCode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DfpSettings) MarshalJSON() ([]byte, error) {
- type noMethod DfpSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Dimension: Represents a dimension.
-type Dimension struct {
- // Kind: The kind of resource this is, in this case
- // dfareporting#dimension.
- Kind string `json:"kind,omitempty"`
-
- // Name: The dimension name, e.g. dfa:advertiser
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Dimension) MarshalJSON() ([]byte, error) {
- type noMethod Dimension
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DimensionFilter: Represents a dimension filter.
-type DimensionFilter struct {
- // DimensionName: The name of the dimension to filter.
- DimensionName string `json:"dimensionName,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#dimensionFilter.
- Kind string `json:"kind,omitempty"`
-
- // Value: The value of the dimension to filter.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DimensionFilter) MarshalJSON() ([]byte, error) {
- type noMethod DimensionFilter
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DimensionValue: Represents a DimensionValue resource.
-type DimensionValue struct {
- // DimensionName: The name of the dimension.
- DimensionName string `json:"dimensionName,omitempty"`
-
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Id: The ID associated with the value if available.
- Id string `json:"id,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#dimensionValue.
- Kind string `json:"kind,omitempty"`
-
- // MatchType: Determines how the 'value' field is matched when
- // filtering. If not specified, defaults to EXACT. If set to
- // WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable
- // length character sequences, and it can be escaped with a backslash.
- // Note, only paid search dimensions ('dfa:paidSearch*') allow a
- // matchType other than EXACT.
- //
- // Possible values:
- // "BEGINS_WITH"
- // "CONTAINS"
- // "EXACT"
- // "WILDCARD_EXPRESSION"
- MatchType string `json:"matchType,omitempty"`
-
- // Value: The value of the dimension.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DimensionValue) MarshalJSON() ([]byte, error) {
- type noMethod DimensionValue
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DimensionValueList: Represents the list of DimensionValue resources.
-type DimensionValueList struct {
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The dimension values returned in this response.
- Items []*DimensionValue `json:"items,omitempty"`
-
- // Kind: The kind of list this is, in this case
- // dfareporting#dimensionValueList.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through dimension
- // values. To retrieve the next page of results, set the next request's
- // "pageToken" to the value of this field. The page token is only valid
- // for a limited amount of time and should not be persisted.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DimensionValueList) MarshalJSON() ([]byte, error) {
- type noMethod DimensionValueList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DimensionValueRequest: Represents a DimensionValuesRequest.
-type DimensionValueRequest struct {
- // DimensionName: The name of the dimension for which values should be
- // requested.
- DimensionName string `json:"dimensionName,omitempty"`
-
- // EndDate: The end date of the date range for which to retrieve
- // dimension values. A string of the format "yyyy-MM-dd".
- EndDate string `json:"endDate,omitempty"`
-
- // Filters: The list of filters by which to filter values. The filters
- // are ANDed.
- Filters []*DimensionFilter `json:"filters,omitempty"`
-
- // Kind: The kind of request this is, in this case
- // dfareporting#dimensionValueRequest.
- Kind string `json:"kind,omitempty"`
-
- // StartDate: The start date of the date range for which to retrieve
- // dimension values. A string of the format "yyyy-MM-dd".
- StartDate string `json:"startDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DimensionValueRequest) MarshalJSON() ([]byte, error) {
- type noMethod DimensionValueRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DirectorySite: DirectorySites contains properties of a website from
-// the Site Directory. Sites need to be added to an account via the
-// Sites resource before they can be assigned to a placement.
-type DirectorySite struct {
- // Active: Whether this directory site is active.
- Active bool `json:"active,omitempty"`
-
- // ContactAssignments: Directory site contacts.
- ContactAssignments []*DirectorySiteContactAssignment `json:"contactAssignments,omitempty"`
-
- // CountryId: Country ID of this directory site.
- CountryId int64 `json:"countryId,omitempty,string"`
-
- // CurrencyId: Currency ID of this directory site.
- // Possible values are:
- // - "1" for USD
- // - "2" for GBP
- // - "3" for ESP
- // - "4" for SEK
- // - "5" for CAD
- // - "6" for JPY
- // - "7" for DEM
- // - "8" for AUD
- // - "9" for FRF
- // - "10" for ITL
- // - "11" for DKK
- // - "12" for NOK
- // - "13" for FIM
- // - "14" for ZAR
- // - "15" for IEP
- // - "16" for NLG
- // - "17" for EUR
- // - "18" for KRW
- // - "19" for TWD
- // - "20" for SGD
- // - "21" for CNY
- // - "22" for HKD
- // - "23" for NZD
- // - "24" for MYR
- // - "25" for BRL
- // - "26" for PTE
- // - "27" for MXP
- // - "28" for CLP
- // - "29" for TRY
- // - "30" for ARS
- // - "31" for PEN
- // - "32" for ILS
- // - "33" for CHF
- // - "34" for VEF
- // - "35" for COP
- // - "36" for GTQ
- CurrencyId int64 `json:"currencyId,omitempty,string"`
-
- // Description: Description of this directory site.
- Description string `json:"description,omitempty"`
-
- // Id: ID of this directory site. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this directory site.
- // This is a read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // InpageTagFormats: Tag types for regular placements.
- //
- // Acceptable values are:
- // - "STANDARD"
- // - "IFRAME_JAVASCRIPT_INPAGE"
- // - "INTERNAL_REDIRECT_INPAGE"
- // - "JAVASCRIPT_INPAGE"
- //
- // Possible values:
- // "IFRAME_JAVASCRIPT_INPAGE"
- // "INTERNAL_REDIRECT_INPAGE"
- // "JAVASCRIPT_INPAGE"
- // "STANDARD"
- InpageTagFormats []string `json:"inpageTagFormats,omitempty"`
-
- // InterstitialTagFormats: Tag types for interstitial
- // placements.
- //
- // Acceptable values are:
- // - "IFRAME_JAVASCRIPT_INTERSTITIAL"
- // - "INTERNAL_REDIRECT_INTERSTITIAL"
- // - "JAVASCRIPT_INTERSTITIAL"
- //
- // Possible values:
- // "IFRAME_JAVASCRIPT_INTERSTITIAL"
- // "INTERNAL_REDIRECT_INTERSTITIAL"
- // "JAVASCRIPT_INTERSTITIAL"
- InterstitialTagFormats []string `json:"interstitialTagFormats,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#directorySite".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this directory site.
- Name string `json:"name,omitempty"`
-
- // ParentId: Parent directory site ID.
- ParentId int64 `json:"parentId,omitempty,string"`
-
- // Settings: Directory site settings.
- Settings *DirectorySiteSettings `json:"settings,omitempty"`
-
- // Url: URL of this directory site.
- Url string `json:"url,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Active") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DirectorySite) MarshalJSON() ([]byte, error) {
- type noMethod DirectorySite
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DirectorySiteContact: Contains properties of a Site Directory
-// contact.
-type DirectorySiteContact struct {
- // Email: Email address of this directory site contact.
- Email string `json:"email,omitempty"`
-
- // FirstName: First name of this directory site contact.
- FirstName string `json:"firstName,omitempty"`
-
- // Id: ID of this directory site contact. This is a read-only,
- // auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#directorySiteContact".
- Kind string `json:"kind,omitempty"`
-
- // LastName: Last name of this directory site contact.
- LastName string `json:"lastName,omitempty"`
-
- // Role: Directory site contact role.
- //
- // Possible values:
- // "ADMIN"
- // "EDIT"
- // "VIEW"
- Role string `json:"role,omitempty"`
-
- // Type: Directory site contact type.
- //
- // Possible values:
- // "BILLING"
- // "OTHER"
- // "SALES"
- // "TECHNICAL"
- Type string `json:"type,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Email") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DirectorySiteContact) MarshalJSON() ([]byte, error) {
- type noMethod DirectorySiteContact
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DirectorySiteContactAssignment: Directory Site Contact Assignment
-type DirectorySiteContactAssignment struct {
- // ContactId: ID of this directory site contact. This is a read-only,
- // auto-generated field.
- ContactId int64 `json:"contactId,omitempty,string"`
-
- // Visibility: Visibility of this directory site contact assignment.
- // When set to PUBLIC this contact assignment is visible to all account
- // and agency users; when set to PRIVATE it is visible only to the site.
- //
- // Possible values:
- // "PRIVATE"
- // "PUBLIC"
- Visibility string `json:"visibility,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ContactId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DirectorySiteContactAssignment) MarshalJSON() ([]byte, error) {
- type noMethod DirectorySiteContactAssignment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DirectorySiteContactsListResponse: Directory Site Contact List
-// Response
-type DirectorySiteContactsListResponse struct {
- // DirectorySiteContacts: Directory site contact collection
- DirectorySiteContacts []*DirectorySiteContact `json:"directorySiteContacts,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#directorySiteContactsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "DirectorySiteContacts") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DirectorySiteContactsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod DirectorySiteContactsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DirectorySiteSettings: Directory Site Settings
-type DirectorySiteSettings struct {
- // ActiveViewOptOut: Whether this directory site has disabled active
- // view creatives.
- ActiveViewOptOut bool `json:"activeViewOptOut,omitempty"`
-
- // DfpSettings: Directory site DFP settings.
- DfpSettings *DfpSettings `json:"dfp_settings,omitempty"`
-
- // InstreamVideoPlacementAccepted: Whether this site accepts in-stream
- // video ads.
- InstreamVideoPlacementAccepted bool `json:"instream_video_placement_accepted,omitempty"`
-
- // InterstitialPlacementAccepted: Whether this site accepts interstitial
- // ads.
- InterstitialPlacementAccepted bool `json:"interstitialPlacementAccepted,omitempty"`
-
- // NielsenOcrOptOut: Whether this directory site has disabled Nielsen
- // OCR reach ratings.
- NielsenOcrOptOut bool `json:"nielsenOcrOptOut,omitempty"`
-
- // VerificationTagOptOut: Whether this directory site has disabled
- // generation of Verification ins tags.
- VerificationTagOptOut bool `json:"verificationTagOptOut,omitempty"`
-
- // VideoActiveViewOptOut: Whether this directory site has disabled
- // active view for in-stream video creatives.
- VideoActiveViewOptOut bool `json:"videoActiveViewOptOut,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ActiveViewOptOut") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DirectorySiteSettings) MarshalJSON() ([]byte, error) {
- type noMethod DirectorySiteSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DirectorySitesListResponse: Directory Site List Response
-type DirectorySitesListResponse struct {
- // DirectorySites: Directory site collection.
- DirectorySites []*DirectorySite `json:"directorySites,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#directorySitesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "DirectorySites") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DirectorySitesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod DirectorySitesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// EventTag: Contains properties of an event tag.
-type EventTag struct {
- // AccountId: Account ID of this event tag. This is a read-only field
- // that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this event tag. This field or the
- // campaignId field is required on insertion.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // CampaignId: Campaign ID of this event tag. This field or the
- // advertiserId field is required on insertion.
- CampaignId int64 `json:"campaignId,omitempty,string"`
-
- // CampaignIdDimensionValue: Dimension value for the ID of the campaign.
- // This is a read-only, auto-generated field.
- CampaignIdDimensionValue *DimensionValue `json:"campaignIdDimensionValue,omitempty"`
-
- // EnabledByDefault: Whether this event tag should be automatically
- // enabled for all of the advertiser's campaigns and ads.
- EnabledByDefault bool `json:"enabledByDefault,omitempty"`
-
- // Id: ID of this event tag. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#eventTag".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this event tag. This is a required field and must be
- // less than 256 characters long.
- Name string `json:"name,omitempty"`
-
- // SiteFilterType: Site filter type for this event tag. If no type is
- // specified then the event tag will be applied to all sites.
- //
- // Possible values:
- // "BLACKLIST"
- // "WHITELIST"
- SiteFilterType string `json:"siteFilterType,omitempty"`
-
- // SiteIds: Filter list of site IDs associated with this event tag. The
- // siteFilterType determines whether this is a whitelist or blacklist
- // filter.
- SiteIds googleapi.Int64s `json:"siteIds,omitempty"`
-
- // SslCompliant: Whether this tag is SSL-compliant or not. This is a
- // read-only field.
- SslCompliant bool `json:"sslCompliant,omitempty"`
-
- // Status: Status of this event tag. Must be ENABLED for this event tag
- // to fire. This is a required field.
- //
- // Possible values:
- // "DISABLED"
- // "ENABLED"
- Status string `json:"status,omitempty"`
-
- // SubaccountId: Subaccount ID of this event tag. This is a read-only
- // field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // Type: Event tag type. Can be used to specify whether to use a
- // third-party pixel, a third-party JavaScript URL, or a third-party
- // click-through URL for either impression or click tracking. This is a
- // required field.
- //
- // Possible values:
- // "CLICK_THROUGH_EVENT_TAG"
- // "IMPRESSION_IMAGE_EVENT_TAG"
- // "IMPRESSION_JAVASCRIPT_EVENT_TAG"
- Type string `json:"type,omitempty"`
-
- // Url: Payload URL for this event tag. The URL on a click-through event
- // tag should have a landing page URL appended to the end of it. This
- // field is required on insertion.
- Url string `json:"url,omitempty"`
-
- // UrlEscapeLevels: Number of times the landing page URL should be
- // URL-escaped before being appended to the click-through event tag URL.
- // Only applies to click-through event tags as specified by the event
- // tag type.
- UrlEscapeLevels int64 `json:"urlEscapeLevels,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EventTag) MarshalJSON() ([]byte, error) {
- type noMethod EventTag
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// EventTagOverride: Event tag override information.
-type EventTagOverride struct {
- // Enabled: Whether this override is enabled.
- Enabled bool `json:"enabled,omitempty"`
-
- // Id: ID of this event tag override. This is a read-only,
- // auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "Enabled") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EventTagOverride) MarshalJSON() ([]byte, error) {
- type noMethod EventTagOverride
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// EventTagsListResponse: Event Tag List Response
-type EventTagsListResponse struct {
- // EventTags: Event tag collection.
- EventTags []*EventTag `json:"eventTags,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#eventTagsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "EventTags") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EventTagsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod EventTagsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// File: Represents a File resource. A file contains the metadata for a
-// report run. It shows the status of the run and holds the URLs to the
-// generated report data if the run is finished and the status is
-// "REPORT_AVAILABLE".
-type File struct {
- // DateRange: The date range for which the file has report data. The
- // date range will always be the absolute date range for which the
- // report is run.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // FileName: The filename of the file.
- FileName string `json:"fileName,omitempty"`
-
- // Format: The output format of the report. Only available once the file
- // is available.
- //
- // Possible values:
- // "CSV"
- // "EXCEL"
- Format string `json:"format,omitempty"`
-
- // Id: The unique ID of this report file.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: The kind of resource this is, in this case dfareporting#file.
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedTime: The timestamp in milliseconds since epoch when this
- // file was last modified.
- LastModifiedTime int64 `json:"lastModifiedTime,omitempty,string"`
-
- // ReportId: The ID of the report this file was generated from.
- ReportId int64 `json:"reportId,omitempty,string"`
-
- // Status: The status of the report file.
- //
- // Possible values:
- // "CANCELLED"
- // "FAILED"
- // "PROCESSING"
- // "REPORT_AVAILABLE"
- Status string `json:"status,omitempty"`
-
- // Urls: The URLs where the completed report file can be downloaded.
- Urls *FileUrls `json:"urls,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "DateRange") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *File) MarshalJSON() ([]byte, error) {
- type noMethod File
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FileUrls: The URLs where the completed report file can be downloaded.
-type FileUrls struct {
- // ApiUrl: The URL for downloading the report data through the API.
- ApiUrl string `json:"apiUrl,omitempty"`
-
- // BrowserUrl: The URL for downloading the report data through a
- // browser.
- BrowserUrl string `json:"browserUrl,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ApiUrl") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FileUrls) MarshalJSON() ([]byte, error) {
- type noMethod FileUrls
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FileList: Represents the list of File resources.
-type FileList struct {
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The files returned in this response.
- Items []*File `json:"items,omitempty"`
-
- // Kind: The kind of list this is, in this case dfareporting#fileList.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through files. To
- // retrieve the next page of results, set the next request's "pageToken"
- // to the value of this field. The page token is only valid for a
- // limited amount of time and should not be persisted.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FileList) MarshalJSON() ([]byte, error) {
- type noMethod FileList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightActivitiesGenerateTagResponse: Floodlight Activity
-// GenerateTag Response
-type FloodlightActivitiesGenerateTagResponse struct {
- // FloodlightActivityTag: Generated tag for this floodlight activity.
- FloodlightActivityTag string `json:"floodlightActivityTag,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#floodlightActivitiesGenerateTagResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "FloodlightActivityTag") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightActivitiesGenerateTagResponse) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightActivitiesGenerateTagResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightActivitiesListResponse: Floodlight Activity List Response
-type FloodlightActivitiesListResponse struct {
- // FloodlightActivities: Floodlight activity collection.
- FloodlightActivities []*FloodlightActivity `json:"floodlightActivities,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#floodlightActivitiesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "FloodlightActivities") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightActivitiesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightActivitiesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightActivity: Contains properties of a Floodlight activity.
-type FloodlightActivity struct {
- // AccountId: Account ID of this floodlight activity. This is a
- // read-only field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this floodlight activity. If this
- // field is left blank, the value will be copied over either from the
- // activity group's advertiser or the existing activity's advertiser.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // CacheBustingType: Code type used for cache busting in the generated
- // tag.
- //
- // Possible values:
- // "ACTIVE_SERVER_PAGE"
- // "COLD_FUSION"
- // "JAVASCRIPT"
- // "JSP"
- // "PHP"
- CacheBustingType string `json:"cacheBustingType,omitempty"`
-
- // CountingMethod: Counting method for conversions for this floodlight
- // activity. This is a required field.
- //
- // Possible values:
- // "ITEMS_SOLD_COUNTING"
- // "SESSION_COUNTING"
- // "STANDARD_COUNTING"
- // "TRANSACTIONS_COUNTING"
- // "UNIQUE_COUNTING"
- CountingMethod string `json:"countingMethod,omitempty"`
-
- // DefaultTags: Dynamic floodlight tags.
- DefaultTags []*FloodlightActivityDynamicTag `json:"defaultTags,omitempty"`
-
- // ExpectedUrl: URL where this tag will be deployed. If specified, must
- // be less than 256 characters long.
- ExpectedUrl string `json:"expectedUrl,omitempty"`
-
- // FloodlightActivityGroupId: Floodlight activity group ID of this
- // floodlight activity. This is a required field.
- FloodlightActivityGroupId int64 `json:"floodlightActivityGroupId,omitempty,string"`
-
- // FloodlightActivityGroupName: Name of the associated floodlight
- // activity group. This is a read-only field.
- FloodlightActivityGroupName string `json:"floodlightActivityGroupName,omitempty"`
-
- // FloodlightActivityGroupTagString: Tag string of the associated
- // floodlight activity group. This is a read-only field.
- FloodlightActivityGroupTagString string `json:"floodlightActivityGroupTagString,omitempty"`
-
- // FloodlightActivityGroupType: Type of the associated floodlight
- // activity group. This is a read-only field.
- //
- // Possible values:
- // "COUNTER"
- // "SALE"
- FloodlightActivityGroupType string `json:"floodlightActivityGroupType,omitempty"`
-
- // FloodlightConfigurationId: Floodlight configuration ID of this
- // floodlight activity. If this field is left blank, the value will be
- // copied over either from the activity group's floodlight configuration
- // or from the existing activity's floodlight configuration.
- FloodlightConfigurationId int64 `json:"floodlightConfigurationId,omitempty,string"`
-
- // FloodlightConfigurationIdDimensionValue: Dimension value for the ID
- // of the floodlight configuration. This is a read-only, auto-generated
- // field.
- FloodlightConfigurationIdDimensionValue *DimensionValue `json:"floodlightConfigurationIdDimensionValue,omitempty"`
-
- // Hidden: Whether this activity is archived.
- Hidden bool `json:"hidden,omitempty"`
-
- // Id: ID of this floodlight activity. This is a read-only,
- // auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this floodlight
- // activity. This is a read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // ImageTagEnabled: Whether the image tag is enabled for this activity.
- ImageTagEnabled bool `json:"imageTagEnabled,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#floodlightActivity".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this floodlight activity. This is a required field.
- // Must be less than 129 characters long and cannot contain quotes.
- Name string `json:"name,omitempty"`
-
- // Notes: General notes or implementation instructions for the tag.
- Notes string `json:"notes,omitempty"`
-
- // PublisherTags: Publisher dynamic floodlight tags.
- PublisherTags []*FloodlightActivityPublisherDynamicTag `json:"publisherTags,omitempty"`
-
- // Secure: Whether this tag should use SSL.
- Secure bool `json:"secure,omitempty"`
-
- // SslCompliant: Whether the floodlight activity is SSL-compliant. This
- // is a read-only field, its value detected by the system from the
- // floodlight tags.
- SslCompliant bool `json:"sslCompliant,omitempty"`
-
- // SslRequired: Whether this floodlight activity must be SSL-compliant.
- SslRequired bool `json:"sslRequired,omitempty"`
-
- // SubaccountId: Subaccount ID of this floodlight activity. This is a
- // read-only field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // TagFormat: Tag format type for the floodlight activity. If left
- // blank, the tag format will default to HTML.
- //
- // Possible values:
- // "HTML"
- // "XHTML"
- TagFormat string `json:"tagFormat,omitempty"`
-
- // TagString: Value of the cat= paramter in the floodlight tag, which
- // the ad servers use to identify the activity. This is optional: if
- // empty, a new tag string will be generated for you. This string must
- // be 1 to 8 characters long, with valid characters being
- // [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among
- // activities of the same activity group. This field is read-only after
- // insertion.
- TagString string `json:"tagString,omitempty"`
-
- // UserDefinedVariableTypes: List of the user-defined variables used by
- // this conversion tag. These map to the "u[1-20]=" in the tags. Each of
- // these can have a user defined type.
- // Acceptable values are:
- // - "U1"
- // - "U2"
- // - "U3"
- // - "U4"
- // - "U5"
- // - "U6"
- // - "U7"
- // - "U8"
- // - "U9"
- // - "U10"
- // - "U11"
- // - "U12"
- // - "U13"
- // - "U14"
- // - "U15"
- // - "U16"
- // - "U17"
- // - "U18"
- // - "U19"
- // - "U20"
- //
- // Possible values:
- // "U1"
- // "U10"
- // "U11"
- // "U12"
- // "U13"
- // "U14"
- // "U15"
- // "U16"
- // "U17"
- // "U18"
- // "U19"
- // "U2"
- // "U20"
- // "U3"
- // "U4"
- // "U5"
- // "U6"
- // "U7"
- // "U8"
- // "U9"
- UserDefinedVariableTypes []string `json:"userDefinedVariableTypes,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightActivity) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightActivity
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightActivityDynamicTag: Dynamic Tag
-type FloodlightActivityDynamicTag struct {
- // Id: ID of this dynamic tag. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // Name: Name of this tag.
- Name string `json:"name,omitempty"`
-
- // Tag: Tag code.
- Tag string `json:"tag,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightActivityDynamicTag) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightActivityDynamicTag
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightActivityGroup: Contains properties of a Floodlight activity
-// group.
-type FloodlightActivityGroup struct {
- // AccountId: Account ID of this floodlight activity group. This is a
- // read-only field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this floodlight activity group. If
- // this field is left blank, the value will be copied over either from
- // the floodlight configuration's advertiser or from the existing
- // activity group's advertiser.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // FloodlightConfigurationId: Floodlight configuration ID of this
- // floodlight activity group. This is a required field.
- FloodlightConfigurationId int64 `json:"floodlightConfigurationId,omitempty,string"`
-
- // FloodlightConfigurationIdDimensionValue: Dimension value for the ID
- // of the floodlight configuration. This is a read-only, auto-generated
- // field.
- FloodlightConfigurationIdDimensionValue *DimensionValue `json:"floodlightConfigurationIdDimensionValue,omitempty"`
-
- // Id: ID of this floodlight activity group. This is a read-only,
- // auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this floodlight
- // activity group. This is a read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#floodlightActivityGroup".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this floodlight activity group. This is a required
- // field. Must be less than 65 characters long and cannot contain
- // quotes.
- Name string `json:"name,omitempty"`
-
- // SubaccountId: Subaccount ID of this floodlight activity group. This
- // is a read-only field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // TagString: Value of the type= parameter in the floodlight tag, which
- // the ad servers use to identify the activity group that the activity
- // belongs to. This is optional: if empty, a new tag string will be
- // generated for you. This string must be 1 to 8 characters long, with
- // valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must
- // also be unique among activity groups of the same floodlight
- // configuration. This field is read-only after insertion.
- TagString string `json:"tagString,omitempty"`
-
- // Type: Type of the floodlight activity group. This is a required field
- // that is read-only after insertion.
- //
- // Possible values:
- // "COUNTER"
- // "SALE"
- Type string `json:"type,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightActivityGroup) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightActivityGroup
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightActivityGroupsListResponse: Floodlight Activity Group List
-// Response
-type FloodlightActivityGroupsListResponse struct {
- // FloodlightActivityGroups: Floodlight activity group collection.
- FloodlightActivityGroups []*FloodlightActivityGroup `json:"floodlightActivityGroups,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#floodlightActivityGroupsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "FloodlightActivityGroups") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightActivityGroupsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightActivityGroupsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightActivityPublisherDynamicTag: Publisher Dynamic Tag
-type FloodlightActivityPublisherDynamicTag struct {
- // ClickThrough: Whether this tag is applicable only for click-throughs.
- ClickThrough bool `json:"clickThrough,omitempty"`
-
- // DirectorySiteId: Directory site ID of this dynamic tag. This is a
- // write-only field that can be used as an alternative to the siteId
- // field. When this resource is retrieved, only the siteId field will be
- // populated.
- DirectorySiteId int64 `json:"directorySiteId,omitempty,string"`
-
- // DynamicTag: Dynamic floodlight tag.
- DynamicTag *FloodlightActivityDynamicTag `json:"dynamicTag,omitempty"`
-
- // SiteId: Site ID of this dynamic tag.
- SiteId int64 `json:"siteId,omitempty,string"`
-
- // SiteIdDimensionValue: Dimension value for the ID of the site. This is
- // a read-only, auto-generated field.
- SiteIdDimensionValue *DimensionValue `json:"siteIdDimensionValue,omitempty"`
-
- // ViewThrough: Whether this tag is applicable only for view-throughs.
- ViewThrough bool `json:"viewThrough,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ClickThrough") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightActivityPublisherDynamicTag) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightActivityPublisherDynamicTag
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightConfiguration: Contains properties of a Floodlight
-// configuration.
-type FloodlightConfiguration struct {
- // AccountId: Account ID of this floodlight configuration. This is a
- // read-only field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of the parent advertiser of this
- // floodlight configuration.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // AnalyticsDataSharingEnabled: Whether advertiser data is shared with
- // Google Analytics.
- AnalyticsDataSharingEnabled bool `json:"analyticsDataSharingEnabled,omitempty"`
-
- // ExposureToConversionEnabled: Whether the exposure-to-conversion
- // report is enabled. This report shows detailed pathway information on
- // up to 10 of the most recent ad exposures seen by a user before
- // converting.
- ExposureToConversionEnabled bool `json:"exposureToConversionEnabled,omitempty"`
-
- // FirstDayOfWeek: Day that will be counted as the first day of the week
- // in reports. This is a required field.
- //
- // Possible values:
- // "MONDAY"
- // "SUNDAY"
- FirstDayOfWeek string `json:"firstDayOfWeek,omitempty"`
-
- // Id: ID of this floodlight configuration. This is a read-only,
- // auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this floodlight
- // configuration. This is a read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#floodlightConfiguration".
- Kind string `json:"kind,omitempty"`
-
- // LookbackConfiguration: Lookback window settings for this floodlight
- // configuration.
- LookbackConfiguration *LookbackConfiguration `json:"lookbackConfiguration,omitempty"`
-
- // NaturalSearchConversionAttributionOption: Types of attribution
- // options for natural search conversions.
- //
- // Possible values:
- // "EXCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION"
- // "INCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION"
- // "INCLUDE_NATURAL_SEARCH_TIERED_CONVERSION_ATTRIBUTION"
- NaturalSearchConversionAttributionOption string `json:"naturalSearchConversionAttributionOption,omitempty"`
-
- // OmnitureSettings: Settings for DCM Omniture integration.
- OmnitureSettings *OmnitureSettings `json:"omnitureSettings,omitempty"`
-
- // SslRequired: Whether floodlight activities owned by this
- // configuration are required to be SSL-compliant.
- SslRequired bool `json:"sslRequired,omitempty"`
-
- // StandardVariableTypes: List of standard variables enabled for this
- // configuration.
- //
- // Acceptable values are:
- // - "ORD"
- // - "NUM"
- //
- // Possible values:
- // "NUM"
- // "ORD"
- // "TRAN"
- // "U"
- StandardVariableTypes []string `json:"standardVariableTypes,omitempty"`
-
- // SubaccountId: Subaccount ID of this floodlight configuration. This is
- // a read-only field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // TagSettings: Configuration settings for dynamic and image floodlight
- // tags.
- TagSettings *TagSettings `json:"tagSettings,omitempty"`
-
- // UserDefinedVariableConfigurations: List of user defined variables
- // enabled for this configuration.
- UserDefinedVariableConfigurations []*UserDefinedVariableConfiguration `json:"userDefinedVariableConfigurations,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightConfiguration) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightConfiguration
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightConfigurationsListResponse: Floodlight Configuration List
-// Response
-type FloodlightConfigurationsListResponse struct {
- // FloodlightConfigurations: Floodlight configuration collection.
- FloodlightConfigurations []*FloodlightConfiguration `json:"floodlightConfigurations,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#floodlightConfigurationsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "FloodlightConfigurations") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightConfigurationsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightConfigurationsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightReportCompatibleFields: Represents fields that are
-// compatible to be selected for a report of type "FlOODLIGHT".
-type FloodlightReportCompatibleFields struct {
- // DimensionFilters: Dimensions which are compatible to be selected in
- // the "dimensionFilters" section of the report.
- DimensionFilters []*Dimension `json:"dimensionFilters,omitempty"`
-
- // Dimensions: Dimensions which are compatible to be selected in the
- // "dimensions" section of the report.
- Dimensions []*Dimension `json:"dimensions,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#floodlightReportCompatibleFields.
- Kind string `json:"kind,omitempty"`
-
- // Metrics: Metrics which are compatible to be selected in the
- // "metricNames" section of the report.
- Metrics []*Metric `json:"metrics,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionFilters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightReportCompatibleFields) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightReportCompatibleFields
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FrequencyCap: Frequency Cap.
-type FrequencyCap struct {
- // Duration: Duration of time, in seconds, for this frequency cap. The
- // maximum duration is 90 days in seconds, or 7,776,000.
- Duration int64 `json:"duration,omitempty,string"`
-
- // Impressions: Number of times an individual user can be served the ad
- // within the specified duration. The maximum allowed is 15.
- Impressions int64 `json:"impressions,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "Duration") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FrequencyCap) MarshalJSON() ([]byte, error) {
- type noMethod FrequencyCap
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FsCommand: FsCommand.
-type FsCommand struct {
- // Left: Distance from the left of the browser.Applicable when
- // positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- Left int64 `json:"left,omitempty"`
-
- // PositionOption: Position in the browser where the window will open.
- //
- // Possible values:
- // "CENTERED"
- // "DISTANCE_FROM_TOP_LEFT_CORNER"
- PositionOption string `json:"positionOption,omitempty"`
-
- // Top: Distance from the top of the browser. Applicable when
- // positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- Top int64 `json:"top,omitempty"`
-
- // WindowHeight: Height of the window.
- WindowHeight int64 `json:"windowHeight,omitempty"`
-
- // WindowWidth: Width of the window.
- WindowWidth int64 `json:"windowWidth,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Left") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FsCommand) MarshalJSON() ([]byte, error) {
- type noMethod FsCommand
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// GeoTargeting: Geographical Targeting.
-type GeoTargeting struct {
- // Cities: Cities to be targeted. For each city only dartId is required.
- // The other fields are populated automatically when the ad is inserted
- // or updated. If targeting a city, do not target or exclude the country
- // of the city, and do not target the metro or region of the city.
- Cities []*City `json:"cities,omitempty"`
-
- // Countries: Countries to be targeted or excluded from targeting,
- // depending on the setting of the excludeCountries field. For each
- // country only dartId is required. The other fields are populated
- // automatically when the ad is inserted or updated. If targeting or
- // excluding a country, do not target regions, cities, metros, or postal
- // codes in the same country.
- Countries []*Country `json:"countries,omitempty"`
-
- // ExcludeCountries: Whether or not to exclude the countries in the
- // countries field from targeting. If false, the countries field refers
- // to countries which will be targeted by the ad.
- ExcludeCountries bool `json:"excludeCountries,omitempty"`
-
- // Metros: Metros to be targeted. For each metro only dmaId is required.
- // The other fields are populated automatically when the ad is inserted
- // or updated. If targeting a metro, do not target or exclude the
- // country of the metro.
- Metros []*Metro `json:"metros,omitempty"`
-
- // PostalCodes: Postal codes to be targeted. For each postal code only
- // id is required. The other fields are populated automatically when the
- // ad is inserted or updated. If targeting a postal code, do not target
- // or exclude the country of the postal code.
- PostalCodes []*PostalCode `json:"postalCodes,omitempty"`
-
- // Regions: Regions to be targeted. For each region only dartId is
- // required. The other fields are populated automatically when the ad is
- // inserted or updated. If targeting a region, do not target or exclude
- // the country of the region.
- Regions []*Region `json:"regions,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Cities") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GeoTargeting) MarshalJSON() ([]byte, error) {
- type noMethod GeoTargeting
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// KeyValueTargetingExpression: Key Value Targeting Expression.
-type KeyValueTargetingExpression struct {
- // Expression: Keyword expression being targeted by the ad.
- Expression string `json:"expression,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Expression") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *KeyValueTargetingExpression) MarshalJSON() ([]byte, error) {
- type noMethod KeyValueTargetingExpression
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LandingPage: Contains information about where a user's browser is
-// taken after the user clicks an ad.
-type LandingPage struct {
- // Default: Whether or not this landing page will be assigned to any ads
- // or creatives that do not have a landing page assigned explicitly.
- // Only one default landing page is allowed per campaign.
- Default bool `json:"default,omitempty"`
-
- // Id: ID of this landing page. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#landingPage".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this landing page. This is a required field. It must be
- // less than 256 characters long, and must be unique among landing pages
- // of the same campaign.
- Name string `json:"name,omitempty"`
-
- // Url: URL of this landing page. This is a required field.
- Url string `json:"url,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Default") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LandingPage) MarshalJSON() ([]byte, error) {
- type noMethod LandingPage
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LandingPagesListResponse: Landing Page List Response
-type LandingPagesListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#landingPagesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // LandingPages: Landing page collection
- LandingPages []*LandingPage `json:"landingPages,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LandingPagesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod LandingPagesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LastModifiedInfo: Modification timestamp.
-type LastModifiedInfo struct {
- // Time: Timestamp of the last change in milliseconds since epoch.
- Time int64 `json:"time,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "Time") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LastModifiedInfo) MarshalJSON() ([]byte, error) {
- type noMethod LastModifiedInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListTargetingExpression: Remarketing List Targeting Expression.
-type ListTargetingExpression struct {
- // Expression: Expression describing which lists are being targeted by
- // the ad.
- Expression string `json:"expression,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Expression") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListTargetingExpression) MarshalJSON() ([]byte, error) {
- type noMethod ListTargetingExpression
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LookbackConfiguration: Lookback configuration settings.
-type LookbackConfiguration struct {
- // ClickDuration: Lookback window, in days, from the last time a given
- // user clicked on one of your ads. If you enter 0, clicks will not be
- // considered as triggering events for floodlight tracking. If you leave
- // this field blank, the default value for your account will be used.
- ClickDuration int64 `json:"clickDuration,omitempty"`
-
- // PostImpressionActivitiesDuration: Lookback window, in days, from the
- // last time a given user viewed one of your ads. If you enter 0,
- // impressions will not be considered as triggering events for
- // floodlight tracking. If you leave this field blank, the default value
- // for your account will be used.
- PostImpressionActivitiesDuration int64 `json:"postImpressionActivitiesDuration,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ClickDuration") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LookbackConfiguration) MarshalJSON() ([]byte, error) {
- type noMethod LookbackConfiguration
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Metric: Represents a metric.
-type Metric struct {
- // Kind: The kind of resource this is, in this case dfareporting#metric.
- Kind string `json:"kind,omitempty"`
-
- // Name: The metric name, e.g. dfa:impressions
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Metric) MarshalJSON() ([]byte, error) {
- type noMethod Metric
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Metro: Contains information about a metro region that can be targeted
-// by ads.
-type Metro struct {
- // CountryCode: Country code of the country to which this metro region
- // belongs.
- CountryCode string `json:"countryCode,omitempty"`
-
- // CountryDartId: DART ID of the country to which this metro region
- // belongs.
- CountryDartId int64 `json:"countryDartId,omitempty,string"`
-
- // DartId: DART ID of this metro region.
- DartId int64 `json:"dartId,omitempty,string"`
-
- // DmaId: DMA ID of this metro region. This is the ID used for targeting
- // and generating reports, and is equivalent to metro_code.
- DmaId int64 `json:"dmaId,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#metro".
- Kind string `json:"kind,omitempty"`
-
- // MetroCode: Metro code of this metro region. This is equivalent to
- // dma_id.
- MetroCode string `json:"metroCode,omitempty"`
-
- // Name: Name of this metro region.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CountryCode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Metro) MarshalJSON() ([]byte, error) {
- type noMethod Metro
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MetrosListResponse: Metro List Response
-type MetrosListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#metrosListResponse".
- Kind string `json:"kind,omitempty"`
-
- // Metros: Metro collection.
- Metros []*Metro `json:"metros,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MetrosListResponse) MarshalJSON() ([]byte, error) {
- type noMethod MetrosListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MobileCarrier: Contains information about a mobile carrier that can
-// be targeted by ads.
-type MobileCarrier struct {
- // CountryCode: Country code of the country to which this mobile carrier
- // belongs.
- CountryCode string `json:"countryCode,omitempty"`
-
- // CountryDartId: DART ID of the country to which this mobile carrier
- // belongs.
- CountryDartId int64 `json:"countryDartId,omitempty,string"`
-
- // Id: ID of this mobile carrier.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#mobileCarrier".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this mobile carrier.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CountryCode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MobileCarrier) MarshalJSON() ([]byte, error) {
- type noMethod MobileCarrier
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MobileCarriersListResponse: Mobile Carrier List Response
-type MobileCarriersListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#mobileCarriersListResponse".
- Kind string `json:"kind,omitempty"`
-
- // MobileCarriers: Mobile carrier collection.
- MobileCarriers []*MobileCarrier `json:"mobileCarriers,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MobileCarriersListResponse) MarshalJSON() ([]byte, error) {
- type noMethod MobileCarriersListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ObjectFilter: Object Filter.
-type ObjectFilter struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#objectFilter".
- Kind string `json:"kind,omitempty"`
-
- // ObjectIds: Applicable when status is ASSIGNED. The user has access to
- // objects with these object IDs.
- ObjectIds googleapi.Int64s `json:"objectIds,omitempty"`
-
- // Status: Status of the filter. NONE means the user has access to none
- // of the objects. ALL means the user has access to all objects.
- // ASSIGNED means the user has access to the objects with IDs in the
- // objectIds list.
- //
- // Possible values:
- // "ALL"
- // "ASSIGNED"
- // "NONE"
- Status string `json:"status,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ObjectFilter) MarshalJSON() ([]byte, error) {
- type noMethod ObjectFilter
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OffsetPosition: Offset Position.
-type OffsetPosition struct {
- // Left: Offset distance from left side of an asset or a window.
- Left int64 `json:"left,omitempty"`
-
- // Top: Offset distance from top side of an asset or a window.
- Top int64 `json:"top,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Left") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OffsetPosition) MarshalJSON() ([]byte, error) {
- type noMethod OffsetPosition
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OmnitureSettings: Omniture Integration Settings.
-type OmnitureSettings struct {
- // OmnitureCostDataEnabled: Whether placement cost data will be sent to
- // Omniture. This property can be enabled only if
- // omnitureIntegrationEnabled is true.
- OmnitureCostDataEnabled bool `json:"omnitureCostDataEnabled,omitempty"`
-
- // OmnitureIntegrationEnabled: Whether Omniture integration is enabled.
- // This property can be enabled only when the "Advanced Ad Serving"
- // account setting is enabled.
- OmnitureIntegrationEnabled bool `json:"omnitureIntegrationEnabled,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "OmnitureCostDataEnabled") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OmnitureSettings) MarshalJSON() ([]byte, error) {
- type noMethod OmnitureSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperatingSystem: Contains information about an operating system that
-// can be targeted by ads.
-type OperatingSystem struct {
- // DartId: DART ID of this operating system. This is the ID used for
- // targeting.
- DartId int64 `json:"dartId,omitempty,string"`
-
- // Desktop: Whether this operating system is for desktop.
- Desktop bool `json:"desktop,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#operatingSystem".
- Kind string `json:"kind,omitempty"`
-
- // Mobile: Whether this operating system is for mobile.
- Mobile bool `json:"mobile,omitempty"`
-
- // Name: Name of this operating system.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DartId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperatingSystem) MarshalJSON() ([]byte, error) {
- type noMethod OperatingSystem
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperatingSystemVersion: Contains information about a particular
-// version of an operating system that can be targeted by ads.
-type OperatingSystemVersion struct {
- // Id: ID of this operating system version.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#operatingSystemVersion".
- Kind string `json:"kind,omitempty"`
-
- // MajorVersion: Major version (leftmost number) of this operating
- // system version.
- MajorVersion string `json:"majorVersion,omitempty"`
-
- // MinorVersion: Minor version (number after the first dot) of this
- // operating system version.
- MinorVersion string `json:"minorVersion,omitempty"`
-
- // Name: Name of this operating system version.
- Name string `json:"name,omitempty"`
-
- // OperatingSystem: Operating system of this operating system version.
- OperatingSystem *OperatingSystem `json:"operatingSystem,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperatingSystemVersion) MarshalJSON() ([]byte, error) {
- type noMethod OperatingSystemVersion
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperatingSystemVersionsListResponse: Operating System Version List
-// Response
-type OperatingSystemVersionsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#operatingSystemVersionsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // OperatingSystemVersions: Operating system version collection.
- OperatingSystemVersions []*OperatingSystemVersion `json:"operatingSystemVersions,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperatingSystemVersionsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod OperatingSystemVersionsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperatingSystemsListResponse: Operating System List Response
-type OperatingSystemsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#operatingSystemsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // OperatingSystems: Operating system collection.
- OperatingSystems []*OperatingSystem `json:"operatingSystems,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperatingSystemsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod OperatingSystemsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OptimizationActivity: Creative optimization activity.
-type OptimizationActivity struct {
- // FloodlightActivityId: Floodlight activity ID of this optimization
- // activity. This is a required field.
- FloodlightActivityId int64 `json:"floodlightActivityId,omitempty,string"`
-
- // FloodlightActivityIdDimensionValue: Dimension value for the ID of the
- // floodlight activity. This is a read-only, auto-generated field.
- FloodlightActivityIdDimensionValue *DimensionValue `json:"floodlightActivityIdDimensionValue,omitempty"`
-
- // Weight: Weight associated with this optimization. Must be greater
- // than 1. The weight assigned will be understood in proportion to the
- // weights assigned to the other optimization activities.
- Weight int64 `json:"weight,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "FloodlightActivityId") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OptimizationActivity) MarshalJSON() ([]byte, error) {
- type noMethod OptimizationActivity
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PathToConversionReportCompatibleFields: Represents fields that are
-// compatible to be selected for a report of type "PATH_TO_CONVERSION".
-type PathToConversionReportCompatibleFields struct {
- // ConversionDimensions: Conversion dimensions which are compatible to
- // be selected in the "conversionDimensions" section of the report.
- ConversionDimensions []*Dimension `json:"conversionDimensions,omitempty"`
-
- // CustomFloodlightVariables: Custom floodlight variables which are
- // compatible to be selected in the "customFloodlightVariables" section
- // of the report.
- CustomFloodlightVariables []*Dimension `json:"customFloodlightVariables,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#pathToConversionReportCompatibleFields.
- Kind string `json:"kind,omitempty"`
-
- // Metrics: Metrics which are compatible to be selected in the
- // "metricNames" section of the report.
- Metrics []*Metric `json:"metrics,omitempty"`
-
- // PerInteractionDimensions: Per-interaction dimensions which are
- // compatible to be selected in the "perInteractionDimensions" section
- // of the report.
- PerInteractionDimensions []*Dimension `json:"perInteractionDimensions,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "ConversionDimensions") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PathToConversionReportCompatibleFields) MarshalJSON() ([]byte, error) {
- type noMethod PathToConversionReportCompatibleFields
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Placement: Contains properties of a placement.
-type Placement struct {
- // AccountId: Account ID of this placement. This field can be left
- // blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this placement. This field can be left
- // blank.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // Archived: Whether this placement is archived.
- Archived bool `json:"archived,omitempty"`
-
- // CampaignId: Campaign ID of this placement. This field is a required
- // field on insertion.
- CampaignId int64 `json:"campaignId,omitempty,string"`
-
- // CampaignIdDimensionValue: Dimension value for the ID of the campaign.
- // This is a read-only, auto-generated field.
- CampaignIdDimensionValue *DimensionValue `json:"campaignIdDimensionValue,omitempty"`
-
- // Comment: Comments for this placement.
- Comment string `json:"comment,omitempty"`
-
- // Compatibility: Placement compatibility. WEB and WEB_INTERSTITIAL
- // refer to rendering either on desktop or on mobile devices for regular
- // or interstitial ads, respectively. APP and APP_INTERSTITIAL are for
- // rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in
- // in-stream video ads developed with the VAST standard. This field is
- // required on insertion.
- //
- // Possible values:
- // "APP"
- // "APP_INTERSTITIAL"
- // "IN_STREAM_VIDEO"
- // "WEB"
- // "WEB_INTERSTITIAL"
- Compatibility string `json:"compatibility,omitempty"`
-
- // ContentCategoryId: ID of the content category assigned to this
- // placement.
- ContentCategoryId int64 `json:"contentCategoryId,omitempty,string"`
-
- // CreateInfo: Information about the creation of this placement. This is
- // a read-only field.
- CreateInfo *LastModifiedInfo `json:"createInfo,omitempty"`
-
- // DirectorySiteId: Directory site ID of this placement. On insert, you
- // must set either this field or the siteId field to specify the site
- // associated with this placement. This is a required field that is
- // read-only after insertion.
- DirectorySiteId int64 `json:"directorySiteId,omitempty,string"`
-
- // DirectorySiteIdDimensionValue: Dimension value for the ID of the
- // directory site. This is a read-only, auto-generated field.
- DirectorySiteIdDimensionValue *DimensionValue `json:"directorySiteIdDimensionValue,omitempty"`
-
- // ExternalId: External ID for this placement.
- ExternalId string `json:"externalId,omitempty"`
-
- // Id: ID of this placement. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this placement. This
- // is a read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // KeyName: Key name of this placement. This is a read-only,
- // auto-generated field.
- KeyName string `json:"keyName,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#placement".
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedInfo: Information about the most recent modification of
- // this placement. This is a read-only field.
- LastModifiedInfo *LastModifiedInfo `json:"lastModifiedInfo,omitempty"`
-
- // LookbackConfiguration: Lookback window settings for this placement.
- LookbackConfiguration *LookbackConfiguration `json:"lookbackConfiguration,omitempty"`
-
- // Name: Name of this placement.This is a required field and must be
- // less than 256 characters long.
- Name string `json:"name,omitempty"`
-
- // PaymentApproved: Whether payment was approved for this placement.
- // This is a read-only field relevant only to publisher-paid placements.
- PaymentApproved bool `json:"paymentApproved,omitempty"`
-
- // PaymentSource: Payment source for this placement. This is a required
- // field that is read-only after insertion.
- //
- // Possible values:
- // "PLACEMENT_AGENCY_PAID"
- // "PLACEMENT_PUBLISHER_PAID"
- PaymentSource string `json:"paymentSource,omitempty"`
-
- // PlacementGroupId: ID of this placement's group, if applicable.
- PlacementGroupId int64 `json:"placementGroupId,omitempty,string"`
-
- // PlacementGroupIdDimensionValue: Dimension value for the ID of the
- // placement group. This is a read-only, auto-generated field.
- PlacementGroupIdDimensionValue *DimensionValue `json:"placementGroupIdDimensionValue,omitempty"`
-
- // PlacementStrategyId: ID of the placement strategy assigned to this
- // placement.
- PlacementStrategyId int64 `json:"placementStrategyId,omitempty,string"`
-
- // PricingSchedule: Pricing schedule of this placement. This field is
- // required on insertion, specifically subfields startDate, endDate and
- // pricingType.
- PricingSchedule *PricingSchedule `json:"pricingSchedule,omitempty"`
-
- // Primary: Whether this placement is the primary placement of a
- // roadblock (placement group). You cannot change this field from true
- // to false. Setting this field to true will automatically set the
- // primary field on the original primary placement of the roadblock to
- // false, and it will automatically set the roadblock's
- // primaryPlacementId field to the ID of this placement.
- Primary bool `json:"primary,omitempty"`
-
- // PublisherUpdateInfo: Information about the last publisher update.
- // This is a read-only field.
- PublisherUpdateInfo *LastModifiedInfo `json:"publisherUpdateInfo,omitempty"`
-
- // SiteId: Site ID associated with this placement. On insert, you must
- // set either this field or the directorySiteId field to specify the
- // site associated with this placement. This is a required field that is
- // read-only after insertion.
- SiteId int64 `json:"siteId,omitempty,string"`
-
- // SiteIdDimensionValue: Dimension value for the ID of the site. This is
- // a read-only, auto-generated field.
- SiteIdDimensionValue *DimensionValue `json:"siteIdDimensionValue,omitempty"`
-
- // Size: Size associated with this placement. When inserting or updating
- // a placement, only the size ID field is used. This field is required
- // on insertion.
- Size *Size `json:"size,omitempty"`
-
- // SslRequired: Whether creatives assigned to this placement must be
- // SSL-compliant.
- SslRequired bool `json:"sslRequired,omitempty"`
-
- // Status: Third-party placement status.
- //
- // Possible values:
- // "ACKNOWLEDGE_ACCEPTANCE"
- // "ACKNOWLEDGE_REJECTION"
- // "DRAFT"
- // "PAYMENT_ACCEPTED"
- // "PAYMENT_REJECTED"
- // "PENDING_REVIEW"
- Status string `json:"status,omitempty"`
-
- // SubaccountId: Subaccount ID of this placement. This field can be left
- // blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // TagFormats: Tag formats to generate for this placement. This field is
- // required on insertion.
- // Acceptable values are:
- // - "PLACEMENT_TAG_STANDARD"
- // - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
- // - "PLACEMENT_TAG_IFRAME_ILAYER"
- // - "PLACEMENT_TAG_INTERNAL_REDIRECT"
- // - "PLACEMENT_TAG_JAVASCRIPT"
- // - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
- // - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
- // - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
- // - "PLACEMENT_TAG_CLICK_COMMANDS"
- // - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
- // - "PLACEMENT_TAG_TRACKING"
- // - "PLACEMENT_TAG_TRACKING_IFRAME"
- // - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- //
- // Possible values:
- // "PLACEMENT_TAG_CLICK_COMMANDS"
- // "PLACEMENT_TAG_IFRAME_ILAYER"
- // "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
- // "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY"
- // "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
- // "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3"
- // "PLACEMENT_TAG_INTERNAL_REDIRECT"
- // "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
- // "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY"
- // "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
- // "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
- // "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY"
- // "PLACEMENT_TAG_JAVASCRIPT"
- // "PLACEMENT_TAG_JAVASCRIPT_LEGACY"
- // "PLACEMENT_TAG_STANDARD"
- // "PLACEMENT_TAG_TRACKING"
- // "PLACEMENT_TAG_TRACKING_IFRAME"
- // "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- TagFormats []string `json:"tagFormats,omitempty"`
-
- // TagSetting: Tag settings for this placement.
- TagSetting *TagSetting `json:"tagSetting,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Placement) MarshalJSON() ([]byte, error) {
- type noMethod Placement
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlacementAssignment: Placement Assignment.
-type PlacementAssignment struct {
- // Active: Whether this placement assignment is active. When true, the
- // placement will be included in the ad's rotation.
- Active bool `json:"active,omitempty"`
-
- // PlacementId: ID of the placement to be assigned. This is a required
- // field.
- PlacementId int64 `json:"placementId,omitempty,string"`
-
- // PlacementIdDimensionValue: Dimension value for the ID of the
- // placement. This is a read-only, auto-generated field.
- PlacementIdDimensionValue *DimensionValue `json:"placementIdDimensionValue,omitempty"`
-
- // SslRequired: Whether the placement to be assigned requires SSL. This
- // is a read-only field that is auto-generated when the ad is inserted
- // or updated.
- SslRequired bool `json:"sslRequired,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Active") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlacementAssignment) MarshalJSON() ([]byte, error) {
- type noMethod PlacementAssignment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlacementGroup: Contains properties of a package or roadblock.
-type PlacementGroup struct {
- // AccountId: Account ID of this placement group. This is a read-only
- // field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this placement group. This is a
- // required field on insertion.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // Archived: Whether this placement group is archived.
- Archived bool `json:"archived,omitempty"`
-
- // CampaignId: Campaign ID of this placement group. This field is
- // required on insertion.
- CampaignId int64 `json:"campaignId,omitempty,string"`
-
- // CampaignIdDimensionValue: Dimension value for the ID of the campaign.
- // This is a read-only, auto-generated field.
- CampaignIdDimensionValue *DimensionValue `json:"campaignIdDimensionValue,omitempty"`
-
- // ChildPlacementIds: IDs of placements which are assigned to this
- // placement group. This is a read-only, auto-generated field.
- ChildPlacementIds googleapi.Int64s `json:"childPlacementIds,omitempty"`
-
- // Comment: Comments for this placement group.
- Comment string `json:"comment,omitempty"`
-
- // ContentCategoryId: ID of the content category assigned to this
- // placement group.
- ContentCategoryId int64 `json:"contentCategoryId,omitempty,string"`
-
- // CreateInfo: Information about the creation of this placement group.
- // This is a read-only field.
- CreateInfo *LastModifiedInfo `json:"createInfo,omitempty"`
-
- // DirectorySiteId: Directory site ID associated with this placement
- // group. On insert, you must set either this field or the site_id field
- // to specify the site associated with this placement group. This is a
- // required field that is read-only after insertion.
- DirectorySiteId int64 `json:"directorySiteId,omitempty,string"`
-
- // DirectorySiteIdDimensionValue: Dimension value for the ID of the
- // directory site. This is a read-only, auto-generated field.
- DirectorySiteIdDimensionValue *DimensionValue `json:"directorySiteIdDimensionValue,omitempty"`
-
- // ExternalId: External ID for this placement.
- ExternalId string `json:"externalId,omitempty"`
-
- // Id: ID of this placement group. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this placement group.
- // This is a read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#placementGroup".
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedInfo: Information about the most recent modification of
- // this placement group. This is a read-only field.
- LastModifiedInfo *LastModifiedInfo `json:"lastModifiedInfo,omitempty"`
-
- // Name: Name of this placement group. This is a required field and must
- // be less than 256 characters long.
- Name string `json:"name,omitempty"`
-
- // PlacementGroupType: Type of this placement group. A package is a
- // simple group of placements that acts as a single pricing point for a
- // group of tags. A roadblock is a group of placements that not only
- // acts as a single pricing point, but also assumes that all the tags in
- // it will be served at the same time. A roadblock requires one of its
- // assigned placements to be marked as primary for reporting. This field
- // is required on insertion.
- //
- // Possible values:
- // "PLACEMENT_PACKAGE"
- // "PLACEMENT_ROADBLOCK"
- PlacementGroupType string `json:"placementGroupType,omitempty"`
-
- // PlacementStrategyId: ID of the placement strategy assigned to this
- // placement group.
- PlacementStrategyId int64 `json:"placementStrategyId,omitempty,string"`
-
- // PricingSchedule: Pricing schedule of this placement group. This field
- // is required on insertion.
- PricingSchedule *PricingSchedule `json:"pricingSchedule,omitempty"`
-
- // PrimaryPlacementId: ID of the primary placement, used to calculate
- // the media cost of a roadblock (placement group). Modifying this field
- // will automatically modify the primary field on all affected roadblock
- // child placements.
- PrimaryPlacementId int64 `json:"primaryPlacementId,omitempty,string"`
-
- // PrimaryPlacementIdDimensionValue: Dimension value for the ID of the
- // primary placement. This is a read-only, auto-generated field.
- PrimaryPlacementIdDimensionValue *DimensionValue `json:"primaryPlacementIdDimensionValue,omitempty"`
-
- // ProgrammaticSetting: Settings for a programmatic placement.
- ProgrammaticSetting *ProgrammaticSetting `json:"programmaticSetting,omitempty"`
-
- // SiteId: Site ID associated with this placement group. On insert, you
- // must set either this field or the directorySiteId field to specify
- // the site associated with this placement group. This is a required
- // field that is read-only after insertion.
- SiteId int64 `json:"siteId,omitempty,string"`
-
- // SiteIdDimensionValue: Dimension value for the ID of the site. This is
- // a read-only, auto-generated field.
- SiteIdDimensionValue *DimensionValue `json:"siteIdDimensionValue,omitempty"`
-
- // SubaccountId: Subaccount ID of this placement group. This is a
- // read-only field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlacementGroup) MarshalJSON() ([]byte, error) {
- type noMethod PlacementGroup
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlacementGroupsListResponse: Placement Group List Response
-type PlacementGroupsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#placementGroupsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // PlacementGroups: Placement group collection.
- PlacementGroups []*PlacementGroup `json:"placementGroups,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlacementGroupsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod PlacementGroupsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlacementStrategiesListResponse: Placement Strategy List Response
-type PlacementStrategiesListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#placementStrategiesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // PlacementStrategies: Placement strategy collection.
- PlacementStrategies []*PlacementStrategy `json:"placementStrategies,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlacementStrategiesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod PlacementStrategiesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlacementStrategy: Contains properties of a placement strategy.
-type PlacementStrategy struct {
- // AccountId: Account ID of this placement strategy.This is a read-only
- // field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Id: ID of this placement strategy. This is a read-only,
- // auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#placementStrategy".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this placement strategy. This is a required field. It
- // must be less than 256 characters long and unique among placement
- // strategies of the same account.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlacementStrategy) MarshalJSON() ([]byte, error) {
- type noMethod PlacementStrategy
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlacementTag: Placement Tag
-type PlacementTag struct {
- // PlacementId: Placement ID
- PlacementId int64 `json:"placementId,omitempty,string"`
-
- // TagDatas: Tags generated for this placement.
- TagDatas []*TagData `json:"tagDatas,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "PlacementId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlacementTag) MarshalJSON() ([]byte, error) {
- type noMethod PlacementTag
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlacementsGenerateTagsResponse: Placement GenerateTags Response
-type PlacementsGenerateTagsResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#placementsGenerateTagsResponse".
- Kind string `json:"kind,omitempty"`
-
- // PlacementTags: Set of generated tags for the specified placements.
- PlacementTags []*PlacementTag `json:"placementTags,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlacementsGenerateTagsResponse) MarshalJSON() ([]byte, error) {
- type noMethod PlacementsGenerateTagsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlacementsListResponse: Placement List Response
-type PlacementsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#placementsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Placements: Placement collection.
- Placements []*Placement `json:"placements,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlacementsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod PlacementsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlatformType: Contains information about a platform type that can be
-// targeted by ads.
-type PlatformType struct {
- // Id: ID of this platform type.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#platformType".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this platform type.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlatformType) MarshalJSON() ([]byte, error) {
- type noMethod PlatformType
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlatformTypesListResponse: Platform Type List Response
-type PlatformTypesListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#platformTypesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // PlatformTypes: Platform type collection.
- PlatformTypes []*PlatformType `json:"platformTypes,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlatformTypesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod PlatformTypesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PopupWindowProperties: Popup Window Properties.
-type PopupWindowProperties struct {
- // Dimension: Popup dimension for a creative. This is a read-only field.
- // Applicable to the following creative types: all RICH_MEDIA and all
- // VPAID
- Dimension *Size `json:"dimension,omitempty"`
-
- // Offset: Upper-left corner coordinates of the popup window. Applicable
- // if positionType is COORDINATES.
- Offset *OffsetPosition `json:"offset,omitempty"`
-
- // PositionType: Popup window position either centered or at specific
- // coordinate.
- //
- // Possible values:
- // "CENTER"
- // "COORDINATES"
- PositionType string `json:"positionType,omitempty"`
-
- // ShowAddressBar: Whether to display the browser address bar.
- ShowAddressBar bool `json:"showAddressBar,omitempty"`
-
- // ShowMenuBar: Whether to display the browser menu bar.
- ShowMenuBar bool `json:"showMenuBar,omitempty"`
-
- // ShowScrollBar: Whether to display the browser scroll bar.
- ShowScrollBar bool `json:"showScrollBar,omitempty"`
-
- // ShowStatusBar: Whether to display the browser status bar.
- ShowStatusBar bool `json:"showStatusBar,omitempty"`
-
- // ShowToolBar: Whether to display the browser tool bar.
- ShowToolBar bool `json:"showToolBar,omitempty"`
-
- // Title: Title of popup window.
- Title string `json:"title,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Dimension") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PopupWindowProperties) MarshalJSON() ([]byte, error) {
- type noMethod PopupWindowProperties
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PostalCode: Contains information about a postal code that can be
-// targeted by ads.
-type PostalCode struct {
- // CountryCode: Country code of the country to which this postal code
- // belongs.
- CountryCode string `json:"countryCode,omitempty"`
-
- // CountryDartId: DART ID of the country to which this postal code
- // belongs.
- CountryDartId int64 `json:"countryDartId,omitempty,string"`
-
- // Id: ID of this postal code.
- Id string `json:"id,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#postalCode".
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CountryCode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PostalCode) MarshalJSON() ([]byte, error) {
- type noMethod PostalCode
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PostalCodesListResponse: Postal Code List Response
-type PostalCodesListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#postalCodesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // PostalCodes: Postal code collection.
- PostalCodes []*PostalCode `json:"postalCodes,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PostalCodesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod PostalCodesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PricingSchedule: Pricing Schedule
-type PricingSchedule struct {
- // CapCostOption: Placement cap cost option.
- //
- // Possible values:
- // "CAP_COST_CUMULATIVE"
- // "CAP_COST_MONTHLY"
- // "CAP_COST_NONE"
- CapCostOption string `json:"capCostOption,omitempty"`
-
- // DisregardOverdelivery: Whether cap costs are ignored by ad serving.
- DisregardOverdelivery bool `json:"disregardOverdelivery,omitempty"`
-
- // EndDate: Placement end date. This date must be later than, or the
- // same day as, the placement start date, but not later than the
- // campaign end date. If, for example, you set 6/25/2015 as both the
- // start and end dates, the effective placement date is just that day
- // only, 6/25/2015. The hours, minutes, and seconds of the end date
- // should not be set, as doing so will result in an error. This field is
- // required on insertion.
- EndDate string `json:"endDate,omitempty"`
-
- // Flighted: Whether this placement is flighted. If true, pricing
- // periods will be computed automatically.
- Flighted bool `json:"flighted,omitempty"`
-
- // FloodlightActivityId: Floodlight activity ID associated with this
- // placement. This field should be set when placement pricing type is
- // set to PRICING_TYPE_CPA.
- FloodlightActivityId int64 `json:"floodlightActivityId,omitempty,string"`
-
- // PricingPeriods: Pricing periods for this placement.
- PricingPeriods []*PricingSchedulePricingPeriod `json:"pricingPeriods,omitempty"`
-
- // PricingType: Placement pricing type. This field is required on
- // insertion.
- //
- // Possible values:
- // "PRICING_TYPE_CPA"
- // "PRICING_TYPE_CPC"
- // "PRICING_TYPE_CPM"
- // "PRICING_TYPE_FLAT_RATE_CLICKS"
- // "PRICING_TYPE_FLAT_RATE_IMPRESSIONS"
- PricingType string `json:"pricingType,omitempty"`
-
- // StartDate: Placement start date. This date must be later than, or the
- // same day as, the campaign start date. The hours, minutes, and seconds
- // of the start date should not be set, as doing so will result in an
- // error. This field is required on insertion.
- StartDate string `json:"startDate,omitempty"`
-
- // TestingStartDate: Testing start date of this placement. The hours,
- // minutes, and seconds of the start date should not be set, as doing so
- // will result in an error.
- TestingStartDate string `json:"testingStartDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CapCostOption") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PricingSchedule) MarshalJSON() ([]byte, error) {
- type noMethod PricingSchedule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PricingSchedulePricingPeriod: Pricing Period
-type PricingSchedulePricingPeriod struct {
- // EndDate: Pricing period end date. This date must be later than, or
- // the same day as, the pricing period start date, but not later than
- // the placement end date. The period end date can be the same date as
- // the period start date. If, for example, you set 6/25/2015 as both the
- // start and end dates, the effective pricing period date is just that
- // day only, 6/25/2015. The hours, minutes, and seconds of the end date
- // should not be set, as doing so will result in an error.
- EndDate string `json:"endDate,omitempty"`
-
- // PricingComment: Comments for this pricing period.
- PricingComment string `json:"pricingComment,omitempty"`
-
- // RateOrCostNanos: Rate or cost of this pricing period.
- RateOrCostNanos int64 `json:"rateOrCostNanos,omitempty,string"`
-
- // StartDate: Pricing period start date. This date must be later than,
- // or the same day as, the placement start date. The hours, minutes, and
- // seconds of the start date should not be set, as doing so will result
- // in an error.
- StartDate string `json:"startDate,omitempty"`
-
- // Units: Units of this pricing period.
- Units int64 `json:"units,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "EndDate") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PricingSchedulePricingPeriod) MarshalJSON() ([]byte, error) {
- type noMethod PricingSchedulePricingPeriod
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ProgrammaticSetting: Programmatic Setting
-type ProgrammaticSetting struct {
- // AdxDealIds: Adx deal IDs assigned to the placement.
- AdxDealIds googleapi.Int64s `json:"adxDealIds,omitempty"`
-
- // InsertionOrderId: Insertion order ID.
- InsertionOrderId string `json:"insertionOrderId,omitempty"`
-
- // InsertionOrderIdStatus: Whether insertion order ID has been placed in
- // DFP. This is a read-only field.
- InsertionOrderIdStatus bool `json:"insertionOrderIdStatus,omitempty"`
-
- // MediaCostNanos: Media cost for the programmatic placement.
- MediaCostNanos int64 `json:"mediaCostNanos,omitempty,string"`
-
- // Programmatic: Whether programmatic is enabled.
- Programmatic bool `json:"programmatic,omitempty"`
-
- // TraffickerEmails: Trafficker emails assigned to the placement.
- TraffickerEmails []string `json:"traffickerEmails,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AdxDealIds") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProgrammaticSetting) MarshalJSON() ([]byte, error) {
- type noMethod ProgrammaticSetting
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReachReportCompatibleFields: Represents fields that are compatible to
-// be selected for a report of type "REACH".
-type ReachReportCompatibleFields struct {
- // DimensionFilters: Dimensions which are compatible to be selected in
- // the "dimensionFilters" section of the report.
- DimensionFilters []*Dimension `json:"dimensionFilters,omitempty"`
-
- // Dimensions: Dimensions which are compatible to be selected in the
- // "dimensions" section of the report.
- Dimensions []*Dimension `json:"dimensions,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#reachReportCompatibleFields.
- Kind string `json:"kind,omitempty"`
-
- // Metrics: Metrics which are compatible to be selected in the
- // "metricNames" section of the report.
- Metrics []*Metric `json:"metrics,omitempty"`
-
- // PivotedActivityMetrics: Metrics which are compatible to be selected
- // as activity metrics to pivot on in the "activities" section of the
- // report.
- PivotedActivityMetrics []*Metric `json:"pivotedActivityMetrics,omitempty"`
-
- // ReachByFrequencyMetrics: Metrics which are compatible to be selected
- // in the "reachByFrequencyMetricNames" section of the report.
- ReachByFrequencyMetrics []*Metric `json:"reachByFrequencyMetrics,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionFilters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReachReportCompatibleFields) MarshalJSON() ([]byte, error) {
- type noMethod ReachReportCompatibleFields
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Recipient: Represents a recipient.
-type Recipient struct {
- // DeliveryType: The delivery type for the recipient.
- //
- // Possible values:
- // "ATTACHMENT"
- // "LINK"
- DeliveryType string `json:"deliveryType,omitempty"`
-
- // Email: The email address of the recipient.
- Email string `json:"email,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#recipient.
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DeliveryType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Recipient) MarshalJSON() ([]byte, error) {
- type noMethod Recipient
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Region: Contains information about a region that can be targeted by
-// ads.
-type Region struct {
- // CountryCode: Country code of the country to which this region
- // belongs.
- CountryCode string `json:"countryCode,omitempty"`
-
- // CountryDartId: DART ID of the country to which this region belongs.
- CountryDartId int64 `json:"countryDartId,omitempty,string"`
-
- // DartId: DART ID of this region.
- DartId int64 `json:"dartId,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#region".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this region.
- Name string `json:"name,omitempty"`
-
- // RegionCode: Region code.
- RegionCode string `json:"regionCode,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CountryCode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Region) MarshalJSON() ([]byte, error) {
- type noMethod Region
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// RegionsListResponse: Region List Response
-type RegionsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#regionsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // Regions: Region collection.
- Regions []*Region `json:"regions,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RegionsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod RegionsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Report: Represents a Report resource.
-type Report struct {
- // AccountId: The account ID to which this report belongs.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Criteria: The report criteria for a report of type "STANDARD".
- Criteria *ReportCriteria `json:"criteria,omitempty"`
-
- // CrossDimensionReachCriteria: The report criteria for a report of type
- // "CROSS_DIMENSION_REACH".
- CrossDimensionReachCriteria *ReportCrossDimensionReachCriteria `json:"crossDimensionReachCriteria,omitempty"`
-
- // Delivery: The report's email delivery settings.
- Delivery *ReportDelivery `json:"delivery,omitempty"`
-
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // FileName: The filename used when generating report files for this
- // report.
- FileName string `json:"fileName,omitempty"`
-
- // FloodlightCriteria: The report criteria for a report of type
- // "FLOODLIGHT".
- FloodlightCriteria *ReportFloodlightCriteria `json:"floodlightCriteria,omitempty"`
-
- // Format: The output format of the report. If not specified, default
- // format is "CSV". Note that the actual format in the completed report
- // file might differ if for instance the report's size exceeds the
- // format's capabilities. "CSV" will then be the fallback format.
- //
- // Possible values:
- // "CSV"
- // "EXCEL"
- Format string `json:"format,omitempty"`
-
- // Id: The unique ID identifying this report resource.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: The kind of resource this is, in this case dfareporting#report.
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedTime: The timestamp (in milliseconds since epoch) of when
- // this report was last modified.
- LastModifiedTime uint64 `json:"lastModifiedTime,omitempty,string"`
-
- // Name: The name of the report.
- Name string `json:"name,omitempty"`
-
- // OwnerProfileId: The user profile id of the owner of this report.
- OwnerProfileId int64 `json:"ownerProfileId,omitempty,string"`
-
- // PathToConversionCriteria: The report criteria for a report of type
- // "PATH_TO_CONVERSION".
- PathToConversionCriteria *ReportPathToConversionCriteria `json:"pathToConversionCriteria,omitempty"`
-
- // ReachCriteria: The report criteria for a report of type "REACH".
- ReachCriteria *ReportReachCriteria `json:"reachCriteria,omitempty"`
-
- // Schedule: The report's schedule. Can only be set if the report's
- // 'dateRange' is a relative date range and the relative date range is
- // not "TODAY".
- Schedule *ReportSchedule `json:"schedule,omitempty"`
-
- // SubAccountId: The subaccount ID to which this report belongs if
- // applicable.
- SubAccountId int64 `json:"subAccountId,omitempty,string"`
-
- // Type: The type of the report.
- //
- // Possible values:
- // "CROSS_DIMENSION_REACH"
- // "FLOODLIGHT"
- // "PATH_TO_CONVERSION"
- // "REACH"
- // "STANDARD"
- Type string `json:"type,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Report) MarshalJSON() ([]byte, error) {
- type noMethod Report
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportCriteria: The report criteria for a report of type "STANDARD".
-type ReportCriteria struct {
- // Activities: Activity group.
- Activities *Activities `json:"activities,omitempty"`
-
- // CustomRichMediaEvents: Custom Rich Media Events group.
- CustomRichMediaEvents *CustomRichMediaEvents `json:"customRichMediaEvents,omitempty"`
-
- // DateRange: The date range for which this report should be run.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // DimensionFilters: The list of filters on which dimensions are
- // filtered.
- // Filters for different dimensions are ANDed, filters for the same
- // dimension are grouped together and ORed.
- DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`
-
- // Dimensions: The list of standard dimensions the report should
- // include.
- Dimensions []*SortedDimension `json:"dimensions,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Activities") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportCrossDimensionReachCriteria: The report criteria for a report
-// of type "CROSS_DIMENSION_REACH".
-type ReportCrossDimensionReachCriteria struct {
- // Breakdown: The list of dimensions the report should include.
- Breakdown []*SortedDimension `json:"breakdown,omitempty"`
-
- // DateRange: The date range this report should be run for.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // Dimension: The dimension option.
- //
- // Possible values:
- // "ADVERTISER"
- // "CAMPAIGN"
- // "SITE_BY_ADVERTISER"
- // "SITE_BY_CAMPAIGN"
- Dimension string `json:"dimension,omitempty"`
-
- // DimensionFilters: The list of filters on which dimensions are
- // filtered.
- DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // OverlapMetricNames: The list of names of overlap metrics the report
- // should include.
- OverlapMetricNames []string `json:"overlapMetricNames,omitempty"`
-
- // Pivoted: Whether the report is pivoted or not. Defaults to true.
- Pivoted bool `json:"pivoted,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Breakdown") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportCrossDimensionReachCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportCrossDimensionReachCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportDelivery: The report's email delivery settings.
-type ReportDelivery struct {
- // EmailOwner: Whether the report should be emailed to the report owner.
- EmailOwner bool `json:"emailOwner,omitempty"`
-
- // EmailOwnerDeliveryType: The type of delivery for the owner to
- // receive, if enabled.
- //
- // Possible values:
- // "ATTACHMENT"
- // "LINK"
- EmailOwnerDeliveryType string `json:"emailOwnerDeliveryType,omitempty"`
-
- // Message: The message to be sent with each email.
- Message string `json:"message,omitempty"`
-
- // Recipients: The list of recipients to which to email the report.
- Recipients []*Recipient `json:"recipients,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "EmailOwner") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportDelivery) MarshalJSON() ([]byte, error) {
- type noMethod ReportDelivery
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportFloodlightCriteria: The report criteria for a report of type
-// "FLOODLIGHT".
-type ReportFloodlightCriteria struct {
- // CustomRichMediaEvents: The list of custom rich media events to
- // include.
- CustomRichMediaEvents []*DimensionValue `json:"customRichMediaEvents,omitempty"`
-
- // DateRange: The date range this report should be run for.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // DimensionFilters: The list of filters on which dimensions are
- // filtered.
- // Filters for different dimensions are ANDed, filters for the same
- // dimension are grouped together and ORed.
- DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`
-
- // Dimensions: The list of dimensions the report should include.
- Dimensions []*SortedDimension `json:"dimensions,omitempty"`
-
- // FloodlightConfigId: The floodlight ID for which to show data in this
- // report. All advertisers associated with that ID will automatically be
- // added. The dimension of the value needs to be
- // 'dfa:floodlightConfigId'.
- FloodlightConfigId *DimensionValue `json:"floodlightConfigId,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ReportProperties: The properties of the report.
- ReportProperties *ReportFloodlightCriteriaReportProperties `json:"reportProperties,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "CustomRichMediaEvents") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportFloodlightCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportFloodlightCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportFloodlightCriteriaReportProperties: The properties of the
-// report.
-type ReportFloodlightCriteriaReportProperties struct {
- // IncludeAttributedIPConversions: Include conversions that have no
- // cookie, but do have an exposure path.
- IncludeAttributedIPConversions bool `json:"includeAttributedIPConversions,omitempty"`
-
- // IncludeUnattributedCookieConversions: Include conversions of users
- // with a DoubleClick cookie but without an exposure. That means the
- // user did not click or see an ad from the advertiser within the
- // Floodlight group, or that the interaction happened outside the
- // lookback window.
- IncludeUnattributedCookieConversions bool `json:"includeUnattributedCookieConversions,omitempty"`
-
- // IncludeUnattributedIPConversions: Include conversions that have no
- // associated cookies and no exposures. It’s therefore impossible to
- // know how the user was exposed to your ads during the lookback window
- // prior to a conversion.
- IncludeUnattributedIPConversions bool `json:"includeUnattributedIPConversions,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "IncludeAttributedIPConversions") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportFloodlightCriteriaReportProperties) MarshalJSON() ([]byte, error) {
- type noMethod ReportFloodlightCriteriaReportProperties
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportPathToConversionCriteria: The report criteria for a report of
-// type "PATH_TO_CONVERSION".
-type ReportPathToConversionCriteria struct {
- // ActivityFilters: The list of 'dfa:activity' values to filter on.
- ActivityFilters []*DimensionValue `json:"activityFilters,omitempty"`
-
- // ConversionDimensions: The list of conversion dimensions the report
- // should include.
- ConversionDimensions []*SortedDimension `json:"conversionDimensions,omitempty"`
-
- // CustomFloodlightVariables: The list of custom floodlight variables
- // the report should include.
- CustomFloodlightVariables []*SortedDimension `json:"customFloodlightVariables,omitempty"`
-
- // CustomRichMediaEvents: The list of custom rich media events to
- // include.
- CustomRichMediaEvents []*DimensionValue `json:"customRichMediaEvents,omitempty"`
-
- // DateRange: The date range this report should be run for.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // FloodlightConfigId: The floodlight ID for which to show data in this
- // report. All advertisers associated with that ID will automatically be
- // added. The dimension of the value needs to be
- // 'dfa:floodlightConfigId'.
- FloodlightConfigId *DimensionValue `json:"floodlightConfigId,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // PerInteractionDimensions: The list of per interaction dimensions the
- // report should include.
- PerInteractionDimensions []*SortedDimension `json:"perInteractionDimensions,omitempty"`
-
- // ReportProperties: The properties of the report.
- ReportProperties *ReportPathToConversionCriteriaReportProperties `json:"reportProperties,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ActivityFilters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportPathToConversionCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportPathToConversionCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportPathToConversionCriteriaReportProperties: The properties of the
-// report.
-type ReportPathToConversionCriteriaReportProperties struct {
- // ClicksLookbackWindow: DFA checks to see if a click interaction
- // occurred within the specified period of time before a conversion. By
- // default the value is pulled from Floodlight or you can manually enter
- // a custom value. Valid values: 1-90.
- ClicksLookbackWindow int64 `json:"clicksLookbackWindow,omitempty"`
-
- // ImpressionsLookbackWindow: DFA checks to see if an impression
- // interaction occurred within the specified period of time before a
- // conversion. By default the value is pulled from Floodlight or you can
- // manually enter a custom value. Valid values: 1-90.
- ImpressionsLookbackWindow int64 `json:"impressionsLookbackWindow,omitempty"`
-
- // IncludeAttributedIPConversions: Deprecated: has no effect.
- IncludeAttributedIPConversions bool `json:"includeAttributedIPConversions,omitempty"`
-
- // IncludeUnattributedCookieConversions: Include conversions of users
- // with a DoubleClick cookie but without an exposure. That means the
- // user did not click or see an ad from the advertiser within the
- // Floodlight group, or that the interaction happened outside the
- // lookback window.
- IncludeUnattributedCookieConversions bool `json:"includeUnattributedCookieConversions,omitempty"`
-
- // IncludeUnattributedIPConversions: Include conversions that have no
- // associated cookies and no exposures. It’s therefore impossible to
- // know how the user was exposed to your ads during the lookback window
- // prior to a conversion.
- IncludeUnattributedIPConversions bool `json:"includeUnattributedIPConversions,omitempty"`
-
- // MaximumClickInteractions: The maximum number of click interactions to
- // include in the report. Advertisers currently paying for E2C reports
- // get up to 200 (100 clicks, 100 impressions). If another advertiser in
- // your network is paying for E2C, you can have up to 5 total exposures
- // per report.
- MaximumClickInteractions int64 `json:"maximumClickInteractions,omitempty"`
-
- // MaximumImpressionInteractions: The maximum number of click
- // interactions to include in the report. Advertisers currently paying
- // for E2C reports get up to 200 (100 clicks, 100 impressions). If
- // another advertiser in your network is paying for E2C, you can have up
- // to 5 total exposures per report.
- MaximumImpressionInteractions int64 `json:"maximumImpressionInteractions,omitempty"`
-
- // MaximumInteractionGap: The maximum amount of time that can take place
- // between interactions (clicks or impressions) by the same user. Valid
- // values: 1-90.
- MaximumInteractionGap int64 `json:"maximumInteractionGap,omitempty"`
-
- // PivotOnInteractionPath: Enable pivoting on interaction path.
- PivotOnInteractionPath bool `json:"pivotOnInteractionPath,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "ClicksLookbackWindow") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportPathToConversionCriteriaReportProperties) MarshalJSON() ([]byte, error) {
- type noMethod ReportPathToConversionCriteriaReportProperties
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportReachCriteria: The report criteria for a report of type
-// "REACH".
-type ReportReachCriteria struct {
- // Activities: Activity group.
- Activities *Activities `json:"activities,omitempty"`
-
- // CustomRichMediaEvents: Custom Rich Media Events group.
- CustomRichMediaEvents *CustomRichMediaEvents `json:"customRichMediaEvents,omitempty"`
-
- // DateRange: The date range this report should be run for.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // DimensionFilters: The list of filters on which dimensions are
- // filtered.
- // Filters for different dimensions are ANDed, filters for the same
- // dimension are grouped together and ORed.
- DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`
-
- // Dimensions: The list of dimensions the report should include.
- Dimensions []*SortedDimension `json:"dimensions,omitempty"`
-
- // EnableAllDimensionCombinations: Whether to enable all reach dimension
- // combinations in the report. Defaults to false. If enabled, the date
- // range of the report should be within the last three months.
- EnableAllDimensionCombinations bool `json:"enableAllDimensionCombinations,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ReachByFrequencyMetricNames: The list of names of Reach By Frequency
- // metrics the report should include.
- ReachByFrequencyMetricNames []string `json:"reachByFrequencyMetricNames,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Activities") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportReachCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportReachCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportSchedule: The report's schedule. Can only be set if the
-// report's 'dateRange' is a relative date range and the relative date
-// range is not "TODAY".
-type ReportSchedule struct {
- // Active: Whether the schedule is active or not. Must be set to either
- // true or false.
- Active bool `json:"active,omitempty"`
-
- // Every: Defines every how many days, weeks or months the report should
- // be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or
- // "MONTHLY".
- Every int64 `json:"every,omitempty"`
-
- // ExpirationDate: The expiration date when the scheduled report stops
- // running.
- ExpirationDate string `json:"expirationDate,omitempty"`
-
- // Repeats: The interval for which the report is repeated. Note:
- // - "DAILY" also requires field "every" to be set.
- // - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be
- // set.
- // - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be
- // set.
- Repeats string `json:"repeats,omitempty"`
-
- // RepeatsOnWeekDays: List of week days "WEEKLY" on which scheduled
- // reports should run.
- //
- // Possible values:
- // "FRIDAY"
- // "MONDAY"
- // "SATURDAY"
- // "SUNDAY"
- // "THURSDAY"
- // "TUESDAY"
- // "WEDNESDAY"
- RepeatsOnWeekDays []string `json:"repeatsOnWeekDays,omitempty"`
-
- // RunsOnDayOfMonth: Enum to define for "MONTHLY" scheduled reports
- // whether reports should be repeated on the same day of the month as
- // "startDate" or the same day of the week of the month.
- // Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02),
- // "DAY_OF_MONTH" would run subsequent reports on the 2nd of every
- // Month, and "WEEK_OF_MONTH" would run subsequent reports on the first
- // Monday of the month.
- //
- // Possible values:
- // "DAY_OF_MONTH"
- // "WEEK_OF_MONTH"
- RunsOnDayOfMonth string `json:"runsOnDayOfMonth,omitempty"`
-
- // StartDate: Start date of date range for which scheduled reports
- // should be run.
- StartDate string `json:"startDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Active") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportSchedule) MarshalJSON() ([]byte, error) {
- type noMethod ReportSchedule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportCompatibleFields: Represents fields that are compatible to be
-// selected for a report of type "STANDARD".
-type ReportCompatibleFields struct {
- // DimensionFilters: Dimensions which are compatible to be selected in
- // the "dimensionFilters" section of the report.
- DimensionFilters []*Dimension `json:"dimensionFilters,omitempty"`
-
- // Dimensions: Dimensions which are compatible to be selected in the
- // "dimensions" section of the report.
- Dimensions []*Dimension `json:"dimensions,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#reportCompatibleFields.
- Kind string `json:"kind,omitempty"`
-
- // Metrics: Metrics which are compatible to be selected in the
- // "metricNames" section of the report.
- Metrics []*Metric `json:"metrics,omitempty"`
-
- // PivotedActivityMetrics: Metrics which are compatible to be selected
- // as activity metrics to pivot on in the "activities" section of the
- // report.
- PivotedActivityMetrics []*Metric `json:"pivotedActivityMetrics,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionFilters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportCompatibleFields) MarshalJSON() ([]byte, error) {
- type noMethod ReportCompatibleFields
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportList: Represents the list of reports.
-type ReportList struct {
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The reports returned in this response.
- Items []*Report `json:"items,omitempty"`
-
- // Kind: The kind of list this is, in this case dfareporting#reportList.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through reports. To
- // retrieve the next page of results, set the next request's "pageToken"
- // to the value of this field. The page token is only valid for a
- // limited amount of time and should not be persisted.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportList) MarshalJSON() ([]byte, error) {
- type noMethod ReportList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportsConfiguration: Reporting Configuration
-type ReportsConfiguration struct {
- // ExposureToConversionEnabled: Whether the exposure to conversion
- // report is enabled. This report shows detailed pathway information on
- // up to 10 of the most recent ad exposures seen by a user before
- // converting.
- ExposureToConversionEnabled bool `json:"exposureToConversionEnabled,omitempty"`
-
- // LookbackConfiguration: Default lookback windows for new advertisers
- // in this account.
- LookbackConfiguration *LookbackConfiguration `json:"lookbackConfiguration,omitempty"`
-
- // ReportGenerationTimeZoneId: Report generation time zone ID of this
- // account. This is a required field that can only be changed by a
- // superuser.
- // Acceptable values are:
- //
- // - "1" for "America/New_York"
- // - "2" for "Europe/London"
- // - "3" for "Europe/Paris"
- // - "4" for "Africa/Johannesburg"
- // - "5" for "Asia/Jerusalem"
- // - "6" for "Asia/Shanghai"
- // - "7" for "Asia/Hong_Kong"
- // - "8" for "Asia/Tokyo"
- // - "9" for "Australia/Sydney"
- // - "10" for "Asia/Dubai"
- // - "11" for "America/Los_Angeles"
- // - "12" for "Pacific/Auckland"
- // - "13" for "America/Sao_Paulo"
- ReportGenerationTimeZoneId int64 `json:"reportGenerationTimeZoneId,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g.
- // "ExposureToConversionEnabled") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportsConfiguration) MarshalJSON() ([]byte, error) {
- type noMethod ReportsConfiguration
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// RichMediaExitOverride: Rich Media Exit Override.
-type RichMediaExitOverride struct {
- // CustomExitUrl: Click-through URL to override the default exit URL.
- // Applicable if the useCustomExitUrl field is set to true.
- CustomExitUrl string `json:"customExitUrl,omitempty"`
-
- // ExitId: ID for the override to refer to a specific exit in the
- // creative.
- ExitId int64 `json:"exitId,omitempty,string"`
-
- // UseCustomExitUrl: Whether to use the custom exit URL.
- UseCustomExitUrl bool `json:"useCustomExitUrl,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CustomExitUrl") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RichMediaExitOverride) MarshalJSON() ([]byte, error) {
- type noMethod RichMediaExitOverride
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Site: Contains properties of a site.
-type Site struct {
- // AccountId: Account ID of this site. This is a read-only field that
- // can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Approved: Whether this site is approved.
- Approved bool `json:"approved,omitempty"`
-
- // DirectorySiteId: Directory site associated with this site. This is a
- // required field that is read-only after insertion.
- DirectorySiteId int64 `json:"directorySiteId,omitempty,string"`
-
- // DirectorySiteIdDimensionValue: Dimension value for the ID of the
- // directory site. This is a read-only, auto-generated field.
- DirectorySiteIdDimensionValue *DimensionValue `json:"directorySiteIdDimensionValue,omitempty"`
-
- // Id: ID of this site. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this site. This is a
- // read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // KeyName: Key name of this site. This is a read-only, auto-generated
- // field.
- KeyName string `json:"keyName,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#site".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this site.This is a required field. Must be less than
- // 128 characters long. If this site is under a subaccount, the name
- // must be unique among sites of the same subaccount. Otherwise, this
- // site is a top-level site, and the name must be unique among top-level
- // sites of the same account.
- Name string `json:"name,omitempty"`
-
- // SiteContacts: Site contacts.
- SiteContacts []*SiteContact `json:"siteContacts,omitempty"`
-
- // SiteSettings: Site-wide settings.
- SiteSettings *SiteSettings `json:"siteSettings,omitempty"`
-
- // SubaccountId: Subaccount ID of this site. This is a read-only field
- // that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Site) MarshalJSON() ([]byte, error) {
- type noMethod Site
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SiteContact: Site Contact
-type SiteContact struct {
- // ContactType: Site contact type.
- //
- // Possible values:
- // "SALES_PERSON"
- // "TRAFFICKER"
- ContactType string `json:"contactType,omitempty"`
-
- // Email: Email address of this site contact. This is a required field.
- Email string `json:"email,omitempty"`
-
- // FirstName: First name of this site contact.
- FirstName string `json:"firstName,omitempty"`
-
- // Id: ID of this site contact. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // LastName: Last name of this site contact.
- LastName string `json:"lastName,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ContactType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SiteContact) MarshalJSON() ([]byte, error) {
- type noMethod SiteContact
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SiteSettings: Site Settings
-type SiteSettings struct {
- // ActiveViewOptOut: Whether active view creatives are disabled for this
- // site.
- ActiveViewOptOut bool `json:"activeViewOptOut,omitempty"`
-
- // CreativeSettings: Site-wide creative settings.
- CreativeSettings *CreativeSettings `json:"creativeSettings,omitempty"`
-
- // DisableBrandSafeAds: Whether brand safe ads are disabled for this
- // site.
- DisableBrandSafeAds bool `json:"disableBrandSafeAds,omitempty"`
-
- // DisableNewCookie: Whether new cookies are disabled for this site.
- DisableNewCookie bool `json:"disableNewCookie,omitempty"`
-
- // LookbackConfiguration: Lookback window settings for this site.
- LookbackConfiguration *LookbackConfiguration `json:"lookbackConfiguration,omitempty"`
-
- // TagSetting: Configuration settings for dynamic and image floodlight
- // tags.
- TagSetting *TagSetting `json:"tagSetting,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ActiveViewOptOut") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SiteSettings) MarshalJSON() ([]byte, error) {
- type noMethod SiteSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SitesListResponse: Site List Response
-type SitesListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#sitesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Sites: Site collection.
- Sites []*Site `json:"sites,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SitesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod SitesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Size: Represents the dimensions of ads, placements, creatives, or
-// creative assets.
-type Size struct {
- // Height: Height of this size.
- Height int64 `json:"height,omitempty"`
-
- // Iab: IAB standard size. This is a read-only, auto-generated field.
- Iab bool `json:"iab,omitempty"`
-
- // Id: ID of this size. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#size".
- Kind string `json:"kind,omitempty"`
-
- // Width: Width of this size.
- Width int64 `json:"width,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Height") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Size) MarshalJSON() ([]byte, error) {
- type noMethod Size
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SizesListResponse: Size List Response
-type SizesListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#sizesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // Sizes: Size collection.
- Sizes []*Size `json:"sizes,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SizesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod SizesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SortedDimension: Represents a sorted dimension.
-type SortedDimension struct {
- // Kind: The kind of resource this is, in this case
- // dfareporting#sortedDimension.
- Kind string `json:"kind,omitempty"`
-
- // Name: The name of the dimension.
- Name string `json:"name,omitempty"`
-
- // SortOrder: An optional sort order for the dimension column.
- //
- // Possible values:
- // "ASCENDING"
- // "DESCENDING"
- SortOrder string `json:"sortOrder,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SortedDimension) MarshalJSON() ([]byte, error) {
- type noMethod SortedDimension
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Subaccount: Contains properties of a DCM subaccount.
-type Subaccount struct {
- // AccountId: ID of the account that contains this subaccount. This is a
- // read-only field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AvailablePermissionIds: IDs of the available user role permissions
- // for this subaccount.
- AvailablePermissionIds googleapi.Int64s `json:"availablePermissionIds,omitempty"`
-
- // Id: ID of this subaccount. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#subaccount".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this subaccount. This is a required field. Must be less
- // than 128 characters long and be unique among subaccounts of the same
- // account.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Subaccount) MarshalJSON() ([]byte, error) {
- type noMethod Subaccount
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SubaccountsListResponse: Subaccount List Response
-type SubaccountsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#subaccountsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Subaccounts: Subaccount collection.
- Subaccounts []*Subaccount `json:"subaccounts,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SubaccountsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod SubaccountsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TagData: Placement Tag Data
-type TagData struct {
- // AdId: Ad associated with this placement tag.
- AdId int64 `json:"adId,omitempty,string"`
-
- // ClickTag: Tag string to record a click.
- ClickTag string `json:"clickTag,omitempty"`
-
- // CreativeId: Creative associated with this placement tag.
- CreativeId int64 `json:"creativeId,omitempty,string"`
-
- // Format: TagData tag format of this tag.
- //
- // Possible values:
- // "PLACEMENT_TAG_CLICK_COMMANDS"
- // "PLACEMENT_TAG_IFRAME_ILAYER"
- // "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
- // "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY"
- // "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
- // "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3"
- // "PLACEMENT_TAG_INTERNAL_REDIRECT"
- // "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
- // "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY"
- // "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
- // "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
- // "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY"
- // "PLACEMENT_TAG_JAVASCRIPT"
- // "PLACEMENT_TAG_JAVASCRIPT_LEGACY"
- // "PLACEMENT_TAG_STANDARD"
- // "PLACEMENT_TAG_TRACKING"
- // "PLACEMENT_TAG_TRACKING_IFRAME"
- // "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- Format string `json:"format,omitempty"`
-
- // ImpressionTag: Tag string for serving an ad.
- ImpressionTag string `json:"impressionTag,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AdId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TagData) MarshalJSON() ([]byte, error) {
- type noMethod TagData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TagSetting: Tag Settings
-type TagSetting struct {
- // AdditionalKeyValues: Additional key-values to be included in tags.
- // Each key-value pair must be of the form key=value, and pairs must be
- // separated by a semicolon (;). Keys and values must not contain
- // commas. For example, id=2;color=red is a valid value for this field.
- AdditionalKeyValues string `json:"additionalKeyValues,omitempty"`
-
- // IncludeClickThroughUrls: Whether static landing page URLs should be
- // included in the tags. This setting applies only to placements.
- IncludeClickThroughUrls bool `json:"includeClickThroughUrls,omitempty"`
-
- // IncludeClickTracking: Whether click-tracking string should be
- // included in the tags.
- IncludeClickTracking bool `json:"includeClickTracking,omitempty"`
-
- // KeywordOption: Option specifying how keywords are embedded in ad
- // tags. This setting can be used to specify whether keyword
- // placeholders are inserted in placement tags for this site. Publishers
- // can then add keywords to those placeholders.
- //
- // Possible values:
- // "GENERATE_SEPARATE_TAG_FOR_EACH_KEYWORD"
- // "IGNORE"
- // "PLACEHOLDER_WITH_LIST_OF_KEYWORDS"
- KeywordOption string `json:"keywordOption,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AdditionalKeyValues")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TagSetting) MarshalJSON() ([]byte, error) {
- type noMethod TagSetting
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TagSettings: Dynamic and Image Tag Settings.
-type TagSettings struct {
- // DynamicTagEnabled: Whether dynamic floodlight tags are enabled.
- DynamicTagEnabled bool `json:"dynamicTagEnabled,omitempty"`
-
- // ImageTagEnabled: Whether image tags are enabled.
- ImageTagEnabled bool `json:"imageTagEnabled,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DynamicTagEnabled")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TagSettings) MarshalJSON() ([]byte, error) {
- type noMethod TagSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetWindow: Target Window.
-type TargetWindow struct {
- // CustomHtml: User-entered value.
- CustomHtml string `json:"customHtml,omitempty"`
-
- // TargetWindowOption: Type of browser window for which the backup image
- // of the flash creative can be displayed.
- //
- // Possible values:
- // "CURRENT_WINDOW"
- // "CUSTOM"
- // "NEW_WINDOW"
- TargetWindowOption string `json:"targetWindowOption,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CustomHtml") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetWindow) MarshalJSON() ([]byte, error) {
- type noMethod TargetWindow
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TechnologyTargeting: Technology Targeting.
-type TechnologyTargeting struct {
- // Browsers: Browsers that this ad targets. For each browser either set
- // browserVersionId or dartId along with the version numbers. If both
- // are specified, only browserVersionId will be used.The other fields
- // are populated automatically when the ad is inserted or updated.
- Browsers []*Browser `json:"browsers,omitempty"`
-
- // ConnectionTypes: Connection types that this ad targets. For each
- // connection type only id is required.The other fields are populated
- // automatically when the ad is inserted or updated.
- ConnectionTypes []*ConnectionType `json:"connectionTypes,omitempty"`
-
- // MobileCarriers: Mobile carriers that this ad targets. For each mobile
- // carrier only id is required, and the other fields are populated
- // automatically when the ad is inserted or updated. If targeting a
- // mobile carrier, do not set targeting for any zip codes.
- MobileCarriers []*MobileCarrier `json:"mobileCarriers,omitempty"`
-
- // OperatingSystemVersions: Operating system versions that this ad
- // targets. To target all versions, use operatingSystems. For each
- // operating system version, only id is required. The other fields are
- // populated automatically when the ad is inserted or updated. If
- // targeting an operating system version, do not set targeting for the
- // corresponding operating system in operatingSystems.
- OperatingSystemVersions []*OperatingSystemVersion `json:"operatingSystemVersions,omitempty"`
-
- // OperatingSystems: Operating systems that this ad targets. To target
- // specific versions, use operatingSystemVersions. For each operating
- // system only dartId is required. The other fields are populated
- // automatically when the ad is inserted or updated. If targeting an
- // operating system, do not set targeting for operating system versions
- // for the same operating system.
- OperatingSystems []*OperatingSystem `json:"operatingSystems,omitempty"`
-
- // PlatformTypes: Platform types that this ad targets. For example,
- // desktop, mobile, or tablet. For each platform type, only id is
- // required, and the other fields are populated automatically when the
- // ad is inserted or updated.
- PlatformTypes []*PlatformType `json:"platformTypes,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Browsers") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TechnologyTargeting) MarshalJSON() ([]byte, error) {
- type noMethod TechnologyTargeting
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ThirdPartyTrackingUrl: Third-party Tracking URL.
-type ThirdPartyTrackingUrl struct {
- // ThirdPartyUrlType: Third-party URL type for in-stream video
- // creatives.
- //
- // Possible values:
- // "CLICK_TRACKING"
- // "IMPRESSION"
- // "RICH_MEDIA_BACKUP_IMPRESSION"
- // "RICH_MEDIA_IMPRESSION"
- // "RICH_MEDIA_RM_IMPRESSION"
- // "SURVEY"
- // "VIDEO_COMPLETE"
- // "VIDEO_CUSTOM"
- // "VIDEO_FIRST_QUARTILE"
- // "VIDEO_FULLSCREEN"
- // "VIDEO_MIDPOINT"
- // "VIDEO_MUTE"
- // "VIDEO_PAUSE"
- // "VIDEO_REWIND"
- // "VIDEO_START"
- // "VIDEO_STOP"
- // "VIDEO_THIRD_QUARTILE"
- ThirdPartyUrlType string `json:"thirdPartyUrlType,omitempty"`
-
- // Url: URL for the specified third-party URL type.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ThirdPartyUrlType")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ThirdPartyTrackingUrl) MarshalJSON() ([]byte, error) {
- type noMethod ThirdPartyTrackingUrl
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserDefinedVariableConfiguration: User Defined Variable
-// configuration.
-type UserDefinedVariableConfiguration struct {
- // DataType: Data type for the variable. This is a required field.
- //
- // Possible values:
- // "NUMBER"
- // "STRING"
- DataType string `json:"dataType,omitempty"`
-
- // ReportName: User-friendly name for the variable which will appear in
- // reports. This is a required field, must be less than 64 characters
- // long, and cannot contain the following characters: ""<>".
- ReportName string `json:"reportName,omitempty"`
-
- // VariableType: Variable name in the tag. This is a required field.
- //
- // Possible values:
- // "U1"
- // "U10"
- // "U11"
- // "U12"
- // "U13"
- // "U14"
- // "U15"
- // "U16"
- // "U17"
- // "U18"
- // "U19"
- // "U2"
- // "U20"
- // "U3"
- // "U4"
- // "U5"
- // "U6"
- // "U7"
- // "U8"
- // "U9"
- VariableType string `json:"variableType,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DataType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserDefinedVariableConfiguration) MarshalJSON() ([]byte, error) {
- type noMethod UserDefinedVariableConfiguration
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserProfile: Represents a UserProfile resource.
-type UserProfile struct {
- // AccountId: The account ID to which this profile belongs.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AccountName: The account name this profile belongs to.
- AccountName string `json:"accountName,omitempty"`
-
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#userProfile.
- Kind string `json:"kind,omitempty"`
-
- // ProfileId: The unique ID of the user profile.
- ProfileId int64 `json:"profileId,omitempty,string"`
-
- // SubAccountId: The sub account ID this profile belongs to if
- // applicable.
- SubAccountId int64 `json:"subAccountId,omitempty,string"`
-
- // SubAccountName: The sub account name this profile belongs to if
- // applicable.
- SubAccountName string `json:"subAccountName,omitempty"`
-
- // UserName: The user name.
- UserName string `json:"userName,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserProfile) MarshalJSON() ([]byte, error) {
- type noMethod UserProfile
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserProfileList: Represents the list of user profiles.
-type UserProfileList struct {
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The user profiles returned in this response.
- Items []*UserProfile `json:"items,omitempty"`
-
- // Kind: The kind of list this is, in this case
- // dfareporting#userProfileList.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserProfileList) MarshalJSON() ([]byte, error) {
- type noMethod UserProfileList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserRole: Contains properties of auser role, which is used to manage
-// user access.
-type UserRole struct {
- // AccountId: Account ID of this user role. This is a read-only field
- // that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // DefaultUserRole: Whether this is a default user role. Default user
- // roles are created by the system for the account/subaccount and cannot
- // be modified or deleted. Each default user role comes with a basic set
- // of preassigned permissions.
- DefaultUserRole bool `json:"defaultUserRole,omitempty"`
-
- // Id: ID of this user role. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#userRole".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this user role. This is a required field. Must be less
- // than 256 characters long. If this user role is under a subaccount,
- // the name must be unique among sites of the same subaccount.
- // Otherwise, this user role is a top-level user role, and the name must
- // be unique among top-level user roles of the same account.
- Name string `json:"name,omitempty"`
-
- // ParentUserRoleId: ID of the user role that this user role is based on
- // or copied from. This is a required field.
- ParentUserRoleId int64 `json:"parentUserRoleId,omitempty,string"`
-
- // Permissions: List of permissions associated with this user role.
- Permissions []*UserRolePermission `json:"permissions,omitempty"`
-
- // SubaccountId: Subaccount ID of this user role. This is a read-only
- // field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserRole) MarshalJSON() ([]byte, error) {
- type noMethod UserRole
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserRolePermission: Contains properties of a user role permission.
-type UserRolePermission struct {
- // Availability: Levels of availability for a user role permission.
- //
- // Possible values:
- // "ACCOUNT_ALWAYS"
- // "ACCOUNT_BY_DEFAULT"
- // "NOT_AVAILABLE_BY_DEFAULT"
- // "SUBACCOUNT_AND_ACCOUNT_ALWAYS"
- // "SUBACCOUNT_AND_ACCOUNT_BY_DEFAULT"
- Availability string `json:"availability,omitempty"`
-
- // Id: ID of this user role permission.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#userRolePermission".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this user role permission.
- Name string `json:"name,omitempty"`
-
- // PermissionGroupId: ID of the permission group that this user role
- // permission belongs to.
- PermissionGroupId int64 `json:"permissionGroupId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Availability") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserRolePermission) MarshalJSON() ([]byte, error) {
- type noMethod UserRolePermission
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserRolePermissionGroup: Represents a grouping of related user role
-// permissions.
-type UserRolePermissionGroup struct {
- // Id: ID of this user role permission.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#userRolePermissionGroup".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this user role permission group.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserRolePermissionGroup) MarshalJSON() ([]byte, error) {
- type noMethod UserRolePermissionGroup
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserRolePermissionGroupsListResponse: User Role Permission Group List
-// Response
-type UserRolePermissionGroupsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#userRolePermissionGroupsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // UserRolePermissionGroups: User role permission group collection.
- UserRolePermissionGroups []*UserRolePermissionGroup `json:"userRolePermissionGroups,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserRolePermissionGroupsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod UserRolePermissionGroupsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserRolePermissionsListResponse: User Role Permission List Response
-type UserRolePermissionsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#userRolePermissionsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // UserRolePermissions: User role permission collection.
- UserRolePermissions []*UserRolePermission `json:"userRolePermissions,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserRolePermissionsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod UserRolePermissionsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserRolesListResponse: User Role List Response
-type UserRolesListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#userRolesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // UserRoles: User role collection.
- UserRoles []*UserRole `json:"userRoles,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserRolesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod UserRolesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "dfareporting.accountActiveAdSummaries.get":
-
-type AccountActiveAdSummariesGetCall struct {
- s *Service
- profileId int64
- summaryAccountId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets the account's active ad summary by account ID.
-func (r *AccountActiveAdSummariesService) Get(profileId int64, summaryAccountId int64) *AccountActiveAdSummariesGetCall {
- c := &AccountActiveAdSummariesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.summaryAccountId = summaryAccountId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountActiveAdSummariesGetCall) Fields(s ...googleapi.Field) *AccountActiveAdSummariesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountActiveAdSummariesGetCall) IfNoneMatch(entityTag string) *AccountActiveAdSummariesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountActiveAdSummariesGetCall) Context(ctx context.Context) *AccountActiveAdSummariesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountActiveAdSummariesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "summaryAccountId": strconv.FormatInt(c.summaryAccountId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.accountActiveAdSummaries.get" call.
-// Exactly one of *AccountActiveAdSummary or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AccountActiveAdSummary.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountActiveAdSummariesGetCall) Do() (*AccountActiveAdSummary, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountActiveAdSummary{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the account's active ad summary by account ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.accountActiveAdSummaries.get",
- // "parameterOrder": [
- // "profileId",
- // "summaryAccountId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "summaryAccountId": {
- // "description": "Account ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}",
- // "response": {
- // "$ref": "AccountActiveAdSummary"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.accountPermissionGroups.get":
-
-type AccountPermissionGroupsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one account permission group by ID.
-func (r *AccountPermissionGroupsService) Get(profileId int64, id int64) *AccountPermissionGroupsGetCall {
- c := &AccountPermissionGroupsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountPermissionGroupsGetCall) Fields(s ...googleapi.Field) *AccountPermissionGroupsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountPermissionGroupsGetCall) IfNoneMatch(entityTag string) *AccountPermissionGroupsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountPermissionGroupsGetCall) Context(ctx context.Context) *AccountPermissionGroupsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountPermissionGroupsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/accountPermissionGroups/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.accountPermissionGroups.get" call.
-// Exactly one of *AccountPermissionGroup or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AccountPermissionGroup.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountPermissionGroupsGetCall) Do() (*AccountPermissionGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountPermissionGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one account permission group by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.accountPermissionGroups.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Account permission group ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/accountPermissionGroups/{id}",
- // "response": {
- // "$ref": "AccountPermissionGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.accountPermissionGroups.list":
-
-type AccountPermissionGroupsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of account permission groups.
-func (r *AccountPermissionGroupsService) List(profileId int64) *AccountPermissionGroupsListCall {
- c := &AccountPermissionGroupsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountPermissionGroupsListCall) Fields(s ...googleapi.Field) *AccountPermissionGroupsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountPermissionGroupsListCall) IfNoneMatch(entityTag string) *AccountPermissionGroupsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountPermissionGroupsListCall) Context(ctx context.Context) *AccountPermissionGroupsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountPermissionGroupsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/accountPermissionGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.accountPermissionGroups.list" call.
-// Exactly one of *AccountPermissionGroupsListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *AccountPermissionGroupsListResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *AccountPermissionGroupsListCall) Do() (*AccountPermissionGroupsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountPermissionGroupsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of account permission groups.",
- // "httpMethod": "GET",
- // "id": "dfareporting.accountPermissionGroups.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/accountPermissionGroups",
- // "response": {
- // "$ref": "AccountPermissionGroupsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.accountPermissions.get":
-
-type AccountPermissionsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one account permission by ID.
-func (r *AccountPermissionsService) Get(profileId int64, id int64) *AccountPermissionsGetCall {
- c := &AccountPermissionsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountPermissionsGetCall) Fields(s ...googleapi.Field) *AccountPermissionsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountPermissionsGetCall) IfNoneMatch(entityTag string) *AccountPermissionsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountPermissionsGetCall) Context(ctx context.Context) *AccountPermissionsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountPermissionsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/accountPermissions/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.accountPermissions.get" call.
-// Exactly one of *AccountPermission or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AccountPermission.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountPermissionsGetCall) Do() (*AccountPermission, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountPermission{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one account permission by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.accountPermissions.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Account permission ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/accountPermissions/{id}",
- // "response": {
- // "$ref": "AccountPermission"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.accountPermissions.list":
-
-type AccountPermissionsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of account permissions.
-func (r *AccountPermissionsService) List(profileId int64) *AccountPermissionsListCall {
- c := &AccountPermissionsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountPermissionsListCall) Fields(s ...googleapi.Field) *AccountPermissionsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountPermissionsListCall) IfNoneMatch(entityTag string) *AccountPermissionsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountPermissionsListCall) Context(ctx context.Context) *AccountPermissionsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountPermissionsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/accountPermissions")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.accountPermissions.list" call.
-// Exactly one of *AccountPermissionsListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *AccountPermissionsListResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountPermissionsListCall) Do() (*AccountPermissionsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountPermissionsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of account permissions.",
- // "httpMethod": "GET",
- // "id": "dfareporting.accountPermissions.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/accountPermissions",
- // "response": {
- // "$ref": "AccountPermissionsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.accountUserProfiles.get":
-
-type AccountUserProfilesGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one account user profile by ID.
-func (r *AccountUserProfilesService) Get(profileId int64, id int64) *AccountUserProfilesGetCall {
- c := &AccountUserProfilesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountUserProfilesGetCall) Fields(s ...googleapi.Field) *AccountUserProfilesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountUserProfilesGetCall) IfNoneMatch(entityTag string) *AccountUserProfilesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountUserProfilesGetCall) Context(ctx context.Context) *AccountUserProfilesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountUserProfilesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/accountUserProfiles/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.accountUserProfiles.get" call.
-// Exactly one of *AccountUserProfile or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AccountUserProfile.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountUserProfilesGetCall) Do() (*AccountUserProfile, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountUserProfile{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one account user profile by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.accountUserProfiles.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "User profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/accountUserProfiles/{id}",
- // "response": {
- // "$ref": "AccountUserProfile"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.accountUserProfiles.list":
-
-type AccountUserProfilesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of account user profiles, possibly filtered.
-func (r *AccountUserProfilesService) List(profileId int64) *AccountUserProfilesListCall {
- c := &AccountUserProfilesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Active sets the optional parameter "active": Select only active user
-// profiles.
-func (c *AccountUserProfilesListCall) Active(active bool) *AccountUserProfilesListCall {
- c.opt_["active"] = active
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only user profiles with
-// these IDs.
-func (c *AccountUserProfilesListCall) Ids(ids int64) *AccountUserProfilesListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *AccountUserProfilesListCall) MaxResults(maxResults int64) *AccountUserProfilesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *AccountUserProfilesListCall) PageToken(pageToken string) *AccountUserProfilesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name, ID or email. Wildcards (*) are
-// allowed. For example, "user profile*2015" will return objects with
-// names like "user profile June 2015", "user profile April 2015", or
-// simply "user profile 2015". Most of the searches also add wildcards
-// implicitly at the start and the end of the search string. For
-// example, a search string of "user profile" will match objects with
-// name "my user profile", "user profile 2015", or simply "user
-// profile".
-func (c *AccountUserProfilesListCall) SearchString(searchString string) *AccountUserProfilesListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *AccountUserProfilesListCall) SortField(sortField string) *AccountUserProfilesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *AccountUserProfilesListCall) SortOrder(sortOrder string) *AccountUserProfilesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// SubaccountId sets the optional parameter "subaccountId": Select only
-// user profiles with the specified subaccount ID.
-func (c *AccountUserProfilesListCall) SubaccountId(subaccountId int64) *AccountUserProfilesListCall {
- c.opt_["subaccountId"] = subaccountId
- return c
-}
-
-// UserRoleId sets the optional parameter "userRoleId": Select only user
-// profiles with the specified user role ID.
-func (c *AccountUserProfilesListCall) UserRoleId(userRoleId int64) *AccountUserProfilesListCall {
- c.opt_["userRoleId"] = userRoleId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountUserProfilesListCall) Fields(s ...googleapi.Field) *AccountUserProfilesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountUserProfilesListCall) IfNoneMatch(entityTag string) *AccountUserProfilesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountUserProfilesListCall) Context(ctx context.Context) *AccountUserProfilesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountUserProfilesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["active"]; ok {
- params.Set("active", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["subaccountId"]; ok {
- params.Set("subaccountId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["userRoleId"]; ok {
- params.Set("userRoleId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/accountUserProfiles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.accountUserProfiles.list" call.
-// Exactly one of *AccountUserProfilesListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *AccountUserProfilesListResponse.ServerResponse.Header or (if
-// a response was returned at all) in error.(*googleapi.Error).Header.
-// Use googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountUserProfilesListCall) Do() (*AccountUserProfilesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountUserProfilesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of account user profiles, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.accountUserProfiles.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "active": {
- // "description": "Select only active user profiles.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "ids": {
- // "description": "Select only user profiles with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, \"user profile*2015\" will return objects with names like \"user profile June 2015\", \"user profile April 2015\", or simply \"user profile 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"user profile\" will match objects with name \"my user profile\", \"user profile 2015\", or simply \"user profile\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "subaccountId": {
- // "description": "Select only user profiles with the specified subaccount ID.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "userRoleId": {
- // "description": "Select only user profiles with the specified user role ID.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/accountUserProfiles",
- // "response": {
- // "$ref": "AccountUserProfilesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.accountUserProfiles.patch":
-
-type AccountUserProfilesPatchCall struct {
- s *Service
- profileId int64
- id int64
- accountuserprofile *AccountUserProfile
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing account user profile. This method supports
-// patch semantics.
-func (r *AccountUserProfilesService) Patch(profileId int64, id int64, accountuserprofile *AccountUserProfile) *AccountUserProfilesPatchCall {
- c := &AccountUserProfilesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.accountuserprofile = accountuserprofile
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountUserProfilesPatchCall) Fields(s ...googleapi.Field) *AccountUserProfilesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountUserProfilesPatchCall) Context(ctx context.Context) *AccountUserProfilesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountUserProfilesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.accountuserprofile)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/accountUserProfiles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.accountUserProfiles.patch" call.
-// Exactly one of *AccountUserProfile or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AccountUserProfile.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountUserProfilesPatchCall) Do() (*AccountUserProfile, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountUserProfile{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing account user profile. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.accountUserProfiles.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "User profile ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/accountUserProfiles",
- // "request": {
- // "$ref": "AccountUserProfile"
- // },
- // "response": {
- // "$ref": "AccountUserProfile"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.accountUserProfiles.update":
-
-type AccountUserProfilesUpdateCall struct {
- s *Service
- profileId int64
- accountuserprofile *AccountUserProfile
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing account user profile.
-func (r *AccountUserProfilesService) Update(profileId int64, accountuserprofile *AccountUserProfile) *AccountUserProfilesUpdateCall {
- c := &AccountUserProfilesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.accountuserprofile = accountuserprofile
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountUserProfilesUpdateCall) Fields(s ...googleapi.Field) *AccountUserProfilesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountUserProfilesUpdateCall) Context(ctx context.Context) *AccountUserProfilesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountUserProfilesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.accountuserprofile)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/accountUserProfiles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.accountUserProfiles.update" call.
-// Exactly one of *AccountUserProfile or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AccountUserProfile.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountUserProfilesUpdateCall) Do() (*AccountUserProfile, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountUserProfile{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing account user profile.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.accountUserProfiles.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/accountUserProfiles",
- // "request": {
- // "$ref": "AccountUserProfile"
- // },
- // "response": {
- // "$ref": "AccountUserProfile"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.accounts.get":
-
-type AccountsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one account by ID.
-func (r *AccountsService) Get(profileId int64, id int64) *AccountsGetCall {
- c := &AccountsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsGetCall) Fields(s ...googleapi.Field) *AccountsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsGetCall) IfNoneMatch(entityTag string) *AccountsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsGetCall) Context(ctx context.Context) *AccountsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/accounts/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.accounts.get" call.
-// Exactly one of *Account or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Account.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsGetCall) Do() (*Account, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Account{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one account by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.accounts.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Account ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/accounts/{id}",
- // "response": {
- // "$ref": "Account"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.accounts.list":
-
-type AccountsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of accounts, possibly filtered.
-func (r *AccountsService) List(profileId int64) *AccountsListCall {
- c := &AccountsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Active sets the optional parameter "active": Select only active
-// accounts. Don't set this field to select both active and non-active
-// accounts.
-func (c *AccountsListCall) Active(active bool) *AccountsListCall {
- c.opt_["active"] = active
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only accounts with
-// these IDs.
-func (c *AccountsListCall) Ids(ids int64) *AccountsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *AccountsListCall) MaxResults(maxResults int64) *AccountsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *AccountsListCall) PageToken(pageToken string) *AccountsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name or ID. Wildcards (*) are allowed. For
-// example, "account*2015" will return objects with names like "account
-// June 2015", "account April 2015", or simply "account 2015". Most of
-// the searches also add wildcards implicitly at the start and the end
-// of the search string. For example, a search string of "account" will
-// match objects with name "my account", "account 2015", or simply
-// "account".
-func (c *AccountsListCall) SearchString(searchString string) *AccountsListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *AccountsListCall) SortField(sortField string) *AccountsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *AccountsListCall) SortOrder(sortOrder string) *AccountsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsListCall) Fields(s ...googleapi.Field) *AccountsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsListCall) IfNoneMatch(entityTag string) *AccountsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsListCall) Context(ctx context.Context) *AccountsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["active"]; ok {
- params.Set("active", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/accounts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.accounts.list" call.
-// Exactly one of *AccountsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AccountsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountsListCall) Do() (*AccountsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of accounts, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.accounts.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "active": {
- // "description": "Select only active accounts. Don't set this field to select both active and non-active accounts.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "ids": {
- // "description": "Select only accounts with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"account*2015\" will return objects with names like \"account June 2015\", \"account April 2015\", or simply \"account 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"account\" will match objects with name \"my account\", \"account 2015\", or simply \"account\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/accounts",
- // "response": {
- // "$ref": "AccountsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.accounts.patch":
-
-type AccountsPatchCall struct {
- s *Service
- profileId int64
- id int64
- account *Account
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing account. This method supports patch
-// semantics.
-func (r *AccountsService) Patch(profileId int64, id int64, account *Account) *AccountsPatchCall {
- c := &AccountsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.account = account
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsPatchCall) Fields(s ...googleapi.Field) *AccountsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsPatchCall) Context(ctx context.Context) *AccountsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.account)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/accounts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.accounts.patch" call.
-// Exactly one of *Account or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Account.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsPatchCall) Do() (*Account, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Account{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing account. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.accounts.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Account ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/accounts",
- // "request": {
- // "$ref": "Account"
- // },
- // "response": {
- // "$ref": "Account"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.accounts.update":
-
-type AccountsUpdateCall struct {
- s *Service
- profileId int64
- account *Account
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing account.
-func (r *AccountsService) Update(profileId int64, account *Account) *AccountsUpdateCall {
- c := &AccountsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.account = account
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsUpdateCall) Fields(s ...googleapi.Field) *AccountsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsUpdateCall) Context(ctx context.Context) *AccountsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.account)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/accounts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.accounts.update" call.
-// Exactly one of *Account or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Account.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsUpdateCall) Do() (*Account, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Account{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing account.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.accounts.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/accounts",
- // "request": {
- // "$ref": "Account"
- // },
- // "response": {
- // "$ref": "Account"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.ads.get":
-
-type AdsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one ad by ID.
-func (r *AdsService) Get(profileId int64, id int64) *AdsGetCall {
- c := &AdsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdsGetCall) Fields(s ...googleapi.Field) *AdsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdsGetCall) IfNoneMatch(entityTag string) *AdsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdsGetCall) Context(ctx context.Context) *AdsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/ads/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.ads.get" call.
-// Exactly one of *Ad or error will be non-nil. Any non-2xx status code
-// is an error. Response headers are in either *Ad.ServerResponse.Header
-// or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *AdsGetCall) Do() (*Ad, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Ad{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one ad by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.ads.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Ad ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/ads/{id}",
- // "response": {
- // "$ref": "Ad"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.ads.insert":
-
-type AdsInsertCall struct {
- s *Service
- profileId int64
- ad *Ad
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new ad.
-func (r *AdsService) Insert(profileId int64, ad *Ad) *AdsInsertCall {
- c := &AdsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.ad = ad
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdsInsertCall) Fields(s ...googleapi.Field) *AdsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdsInsertCall) Context(ctx context.Context) *AdsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.ad)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/ads")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.ads.insert" call.
-// Exactly one of *Ad or error will be non-nil. Any non-2xx status code
-// is an error. Response headers are in either *Ad.ServerResponse.Header
-// or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *AdsInsertCall) Do() (*Ad, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Ad{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new ad.",
- // "httpMethod": "POST",
- // "id": "dfareporting.ads.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/ads",
- // "request": {
- // "$ref": "Ad"
- // },
- // "response": {
- // "$ref": "Ad"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.ads.list":
-
-type AdsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of ads, possibly filtered.
-func (r *AdsService) List(profileId int64) *AdsListCall {
- c := &AdsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Active sets the optional parameter "active": Select only active ads.
-func (c *AdsListCall) Active(active bool) *AdsListCall {
- c.opt_["active"] = active
- return c
-}
-
-// AdvertiserId sets the optional parameter "advertiserId": Select only
-// ads with this advertiser ID.
-func (c *AdsListCall) AdvertiserId(advertiserId int64) *AdsListCall {
- c.opt_["advertiserId"] = advertiserId
- return c
-}
-
-// Archived sets the optional parameter "archived": Select only archived
-// ads.
-func (c *AdsListCall) Archived(archived bool) *AdsListCall {
- c.opt_["archived"] = archived
- return c
-}
-
-// AudienceSegmentIds sets the optional parameter "audienceSegmentIds":
-// Select only ads with these audience segment IDs.
-func (c *AdsListCall) AudienceSegmentIds(audienceSegmentIds int64) *AdsListCall {
- c.opt_["audienceSegmentIds"] = audienceSegmentIds
- return c
-}
-
-// CampaignIds sets the optional parameter "campaignIds": Select only
-// ads with these campaign IDs.
-func (c *AdsListCall) CampaignIds(campaignIds int64) *AdsListCall {
- c.opt_["campaignIds"] = campaignIds
- return c
-}
-
-// Compatibility sets the optional parameter "compatibility": Select
-// default ads with the specified compatibility. Applicable when type is
-// AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering
-// either on desktop or on mobile devices for regular or interstitial
-// ads, respectively. APP and APP_INTERSTITIAL are for rendering in
-// mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video
-// ads developed with the VAST standard.
-//
-// Possible values:
-// "APP"
-// "APP_INTERSTITIAL"
-// "IN_STREAM_VIDEO"
-// "WEB"
-// "WEB_INTERSTITIAL"
-func (c *AdsListCall) Compatibility(compatibility string) *AdsListCall {
- c.opt_["compatibility"] = compatibility
- return c
-}
-
-// CreativeIds sets the optional parameter "creativeIds": Select only
-// ads with these creative IDs assigned.
-func (c *AdsListCall) CreativeIds(creativeIds int64) *AdsListCall {
- c.opt_["creativeIds"] = creativeIds
- return c
-}
-
-// CreativeOptimizationConfigurationIds sets the optional parameter
-// "creativeOptimizationConfigurationIds": Select only ads with these
-// creative optimization configuration IDs.
-func (c *AdsListCall) CreativeOptimizationConfigurationIds(creativeOptimizationConfigurationIds int64) *AdsListCall {
- c.opt_["creativeOptimizationConfigurationIds"] = creativeOptimizationConfigurationIds
- return c
-}
-
-// CreativeType sets the optional parameter "creativeType": Select only
-// ads with the specified creativeType.
-//
-// Possible values:
-// "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO"
-// "CUSTOM_INPAGE"
-// "CUSTOM_INTERSTITIAL"
-// "ENHANCED_BANNER"
-// "ENHANCED_IMAGE"
-// "FLASH_INPAGE"
-// "HTML5_BANNER"
-// "IMAGE"
-// "INSTREAM_VIDEO"
-// "INTERNAL_REDIRECT"
-// "INTERSTITIAL_INTERNAL_REDIRECT"
-// "REDIRECT"
-// "RICH_MEDIA_EXPANDING"
-// "RICH_MEDIA_IM_EXPAND"
-// "RICH_MEDIA_INPAGE"
-// "RICH_MEDIA_INPAGE_FLOATING"
-// "RICH_MEDIA_INTERSTITIAL_FLOAT"
-// "RICH_MEDIA_MOBILE_IN_APP"
-// "RICH_MEDIA_MULTI_FLOATING"
-// "RICH_MEDIA_PEEL_DOWN"
-// "TRACKING_TEXT"
-// "VAST_REDIRECT"
-// "VPAID_LINEAR"
-// "VPAID_NON_LINEAR"
-func (c *AdsListCall) CreativeType(creativeType string) *AdsListCall {
- c.opt_["creativeType"] = creativeType
- return c
-}
-
-// DynamicClickTracker sets the optional parameter
-// "dynamicClickTracker": Select only dynamic click trackers. Applicable
-// when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click
-// trackers. If false, select static click trackers. Leave unset to
-// select both.
-func (c *AdsListCall) DynamicClickTracker(dynamicClickTracker bool) *AdsListCall {
- c.opt_["dynamicClickTracker"] = dynamicClickTracker
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only ads with these
-// IDs.
-func (c *AdsListCall) Ids(ids int64) *AdsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// LandingPageIds sets the optional parameter "landingPageIds": Select
-// only ads with these landing page IDs.
-func (c *AdsListCall) LandingPageIds(landingPageIds int64) *AdsListCall {
- c.opt_["landingPageIds"] = landingPageIds
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *AdsListCall) MaxResults(maxResults int64) *AdsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OverriddenEventTagId sets the optional parameter
-// "overriddenEventTagId": Select only ads with this event tag override
-// ID.
-func (c *AdsListCall) OverriddenEventTagId(overriddenEventTagId int64) *AdsListCall {
- c.opt_["overriddenEventTagId"] = overriddenEventTagId
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *AdsListCall) PageToken(pageToken string) *AdsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// PlacementIds sets the optional parameter "placementIds": Select only
-// ads with these placement IDs assigned.
-func (c *AdsListCall) PlacementIds(placementIds int64) *AdsListCall {
- c.opt_["placementIds"] = placementIds
- return c
-}
-
-// RemarketingListIds sets the optional parameter "remarketingListIds":
-// Select only ads whose list targeting expression use these remarketing
-// list IDs.
-func (c *AdsListCall) RemarketingListIds(remarketingListIds int64) *AdsListCall {
- c.opt_["remarketingListIds"] = remarketingListIds
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name or ID. Wildcards (*) are allowed. For
-// example, "ad*2015" will return objects with names like "ad June
-// 2015", "ad April 2015", or simply "ad 2015". Most of the searches
-// also add wildcards implicitly at the start and the end of the search
-// string. For example, a search string of "ad" will match objects with
-// name "my ad", "ad 2015", or simply "ad".
-func (c *AdsListCall) SearchString(searchString string) *AdsListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SizeIds sets the optional parameter "sizeIds": Select only ads with
-// these size IDs.
-func (c *AdsListCall) SizeIds(sizeIds int64) *AdsListCall {
- c.opt_["sizeIds"] = sizeIds
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *AdsListCall) SortField(sortField string) *AdsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *AdsListCall) SortOrder(sortOrder string) *AdsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// SslCompliant sets the optional parameter "sslCompliant": Select only
-// ads that are SSL-compliant.
-func (c *AdsListCall) SslCompliant(sslCompliant bool) *AdsListCall {
- c.opt_["sslCompliant"] = sslCompliant
- return c
-}
-
-// SslRequired sets the optional parameter "sslRequired": Select only
-// ads that require SSL.
-func (c *AdsListCall) SslRequired(sslRequired bool) *AdsListCall {
- c.opt_["sslRequired"] = sslRequired
- return c
-}
-
-// Type sets the optional parameter "type": Select only ads with these
-// types.
-//
-// Possible values:
-// "AD_SERVING_CLICK_TRACKER"
-// "AD_SERVING_DEFAULT_AD"
-// "AD_SERVING_STANDARD_AD"
-// "AD_SERVING_TRACKING"
-func (c *AdsListCall) Type(type_ string) *AdsListCall {
- c.opt_["type"] = type_
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdsListCall) Fields(s ...googleapi.Field) *AdsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdsListCall) IfNoneMatch(entityTag string) *AdsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdsListCall) Context(ctx context.Context) *AdsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["active"]; ok {
- params.Set("active", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["advertiserId"]; ok {
- params.Set("advertiserId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["archived"]; ok {
- params.Set("archived", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["audienceSegmentIds"]; ok {
- params.Set("audienceSegmentIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["campaignIds"]; ok {
- params.Set("campaignIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["compatibility"]; ok {
- params.Set("compatibility", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["creativeIds"]; ok {
- params.Set("creativeIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["creativeOptimizationConfigurationIds"]; ok {
- params.Set("creativeOptimizationConfigurationIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["creativeType"]; ok {
- params.Set("creativeType", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["dynamicClickTracker"]; ok {
- params.Set("dynamicClickTracker", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["landingPageIds"]; ok {
- params.Set("landingPageIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["overriddenEventTagId"]; ok {
- params.Set("overriddenEventTagId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["placementIds"]; ok {
- params.Set("placementIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["remarketingListIds"]; ok {
- params.Set("remarketingListIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sizeIds"]; ok {
- params.Set("sizeIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sslCompliant"]; ok {
- params.Set("sslCompliant", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sslRequired"]; ok {
- params.Set("sslRequired", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["type"]; ok {
- params.Set("type", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/ads")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.ads.list" call.
-// Exactly one of *AdsListResponse or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AdsListResponse.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AdsListCall) Do() (*AdsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of ads, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.ads.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "active": {
- // "description": "Select only active ads.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "advertiserId": {
- // "description": "Select only ads with this advertiser ID.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "archived": {
- // "description": "Select only archived ads.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "audienceSegmentIds": {
- // "description": "Select only ads with these audience segment IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "campaignIds": {
- // "description": "Select only ads with these campaign IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "compatibility": {
- // "description": "Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.",
- // "enum": [
- // "APP",
- // "APP_INTERSTITIAL",
- // "IN_STREAM_VIDEO",
- // "WEB",
- // "WEB_INTERSTITIAL"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "creativeIds": {
- // "description": "Select only ads with these creative IDs assigned.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "creativeOptimizationConfigurationIds": {
- // "description": "Select only ads with these creative optimization configuration IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "creativeType": {
- // "description": "Select only ads with the specified creativeType.",
- // "enum": [
- // "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO",
- // "CUSTOM_INPAGE",
- // "CUSTOM_INTERSTITIAL",
- // "ENHANCED_BANNER",
- // "ENHANCED_IMAGE",
- // "FLASH_INPAGE",
- // "HTML5_BANNER",
- // "IMAGE",
- // "INSTREAM_VIDEO",
- // "INTERNAL_REDIRECT",
- // "INTERSTITIAL_INTERNAL_REDIRECT",
- // "REDIRECT",
- // "RICH_MEDIA_EXPANDING",
- // "RICH_MEDIA_IM_EXPAND",
- // "RICH_MEDIA_INPAGE",
- // "RICH_MEDIA_INPAGE_FLOATING",
- // "RICH_MEDIA_INTERSTITIAL_FLOAT",
- // "RICH_MEDIA_MOBILE_IN_APP",
- // "RICH_MEDIA_MULTI_FLOATING",
- // "RICH_MEDIA_PEEL_DOWN",
- // "TRACKING_TEXT",
- // "VAST_REDIRECT",
- // "VPAID_LINEAR",
- // "VPAID_NON_LINEAR"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "dynamicClickTracker": {
- // "description": "Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "ids": {
- // "description": "Select only ads with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "landingPageIds": {
- // "description": "Select only ads with these landing page IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "overriddenEventTagId": {
- // "description": "Select only ads with this event tag override ID.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "placementIds": {
- // "description": "Select only ads with these placement IDs assigned.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "remarketingListIds": {
- // "description": "Select only ads whose list targeting expression use these remarketing list IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"ad*2015\" will return objects with names like \"ad June 2015\", \"ad April 2015\", or simply \"ad 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"ad\" will match objects with name \"my ad\", \"ad 2015\", or simply \"ad\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sizeIds": {
- // "description": "Select only ads with these size IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sslCompliant": {
- // "description": "Select only ads that are SSL-compliant.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "sslRequired": {
- // "description": "Select only ads that require SSL.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "type": {
- // "description": "Select only ads with these types.",
- // "enum": [
- // "AD_SERVING_CLICK_TRACKER",
- // "AD_SERVING_DEFAULT_AD",
- // "AD_SERVING_STANDARD_AD",
- // "AD_SERVING_TRACKING"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/ads",
- // "response": {
- // "$ref": "AdsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.ads.patch":
-
-type AdsPatchCall struct {
- s *Service
- profileId int64
- id int64
- ad *Ad
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing ad. This method supports patch semantics.
-func (r *AdsService) Patch(profileId int64, id int64, ad *Ad) *AdsPatchCall {
- c := &AdsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.ad = ad
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdsPatchCall) Fields(s ...googleapi.Field) *AdsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdsPatchCall) Context(ctx context.Context) *AdsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.ad)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/ads")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.ads.patch" call.
-// Exactly one of *Ad or error will be non-nil. Any non-2xx status code
-// is an error. Response headers are in either *Ad.ServerResponse.Header
-// or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *AdsPatchCall) Do() (*Ad, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Ad{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing ad. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.ads.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Ad ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/ads",
- // "request": {
- // "$ref": "Ad"
- // },
- // "response": {
- // "$ref": "Ad"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.ads.update":
-
-type AdsUpdateCall struct {
- s *Service
- profileId int64
- ad *Ad
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing ad.
-func (r *AdsService) Update(profileId int64, ad *Ad) *AdsUpdateCall {
- c := &AdsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.ad = ad
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdsUpdateCall) Fields(s ...googleapi.Field) *AdsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdsUpdateCall) Context(ctx context.Context) *AdsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.ad)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/ads")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.ads.update" call.
-// Exactly one of *Ad or error will be non-nil. Any non-2xx status code
-// is an error. Response headers are in either *Ad.ServerResponse.Header
-// or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *AdsUpdateCall) Do() (*Ad, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Ad{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing ad.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.ads.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/ads",
- // "request": {
- // "$ref": "Ad"
- // },
- // "response": {
- // "$ref": "Ad"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.advertiserGroups.delete":
-
-type AdvertiserGroupsDeleteCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an existing advertiser group.
-func (r *AdvertiserGroupsService) Delete(profileId int64, id int64) *AdvertiserGroupsDeleteCall {
- c := &AdvertiserGroupsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdvertiserGroupsDeleteCall) Fields(s ...googleapi.Field) *AdvertiserGroupsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdvertiserGroupsDeleteCall) Context(ctx context.Context) *AdvertiserGroupsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdvertiserGroupsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/advertiserGroups/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.advertiserGroups.delete" call.
-func (c *AdvertiserGroupsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes an existing advertiser group.",
- // "httpMethod": "DELETE",
- // "id": "dfareporting.advertiserGroups.delete",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Advertiser group ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/advertiserGroups/{id}",
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.advertiserGroups.get":
-
-type AdvertiserGroupsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one advertiser group by ID.
-func (r *AdvertiserGroupsService) Get(profileId int64, id int64) *AdvertiserGroupsGetCall {
- c := &AdvertiserGroupsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdvertiserGroupsGetCall) Fields(s ...googleapi.Field) *AdvertiserGroupsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdvertiserGroupsGetCall) IfNoneMatch(entityTag string) *AdvertiserGroupsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdvertiserGroupsGetCall) Context(ctx context.Context) *AdvertiserGroupsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdvertiserGroupsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/advertiserGroups/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.advertiserGroups.get" call.
-// Exactly one of *AdvertiserGroup or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AdvertiserGroup.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AdvertiserGroupsGetCall) Do() (*AdvertiserGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdvertiserGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one advertiser group by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.advertiserGroups.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Advertiser group ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/advertiserGroups/{id}",
- // "response": {
- // "$ref": "AdvertiserGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.advertiserGroups.insert":
-
-type AdvertiserGroupsInsertCall struct {
- s *Service
- profileId int64
- advertisergroup *AdvertiserGroup
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new advertiser group.
-func (r *AdvertiserGroupsService) Insert(profileId int64, advertisergroup *AdvertiserGroup) *AdvertiserGroupsInsertCall {
- c := &AdvertiserGroupsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.advertisergroup = advertisergroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdvertiserGroupsInsertCall) Fields(s ...googleapi.Field) *AdvertiserGroupsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdvertiserGroupsInsertCall) Context(ctx context.Context) *AdvertiserGroupsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdvertiserGroupsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.advertisergroup)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/advertiserGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.advertiserGroups.insert" call.
-// Exactly one of *AdvertiserGroup or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AdvertiserGroup.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AdvertiserGroupsInsertCall) Do() (*AdvertiserGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdvertiserGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new advertiser group.",
- // "httpMethod": "POST",
- // "id": "dfareporting.advertiserGroups.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/advertiserGroups",
- // "request": {
- // "$ref": "AdvertiserGroup"
- // },
- // "response": {
- // "$ref": "AdvertiserGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.advertiserGroups.list":
-
-type AdvertiserGroupsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of advertiser groups, possibly filtered.
-func (r *AdvertiserGroupsService) List(profileId int64) *AdvertiserGroupsListCall {
- c := &AdvertiserGroupsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only advertiser groups
-// with these IDs.
-func (c *AdvertiserGroupsListCall) Ids(ids int64) *AdvertiserGroupsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *AdvertiserGroupsListCall) MaxResults(maxResults int64) *AdvertiserGroupsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *AdvertiserGroupsListCall) PageToken(pageToken string) *AdvertiserGroupsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name or ID. Wildcards (*) are allowed. For
-// example, "advertiser*2015" will return objects with names like
-// "advertiser group June 2015", "advertiser group April 2015", or
-// simply "advertiser group 2015". Most of the searches also add
-// wildcards implicitly at the start and the end of the search string.
-// For example, a search string of "advertisergroup" will match objects
-// with name "my advertisergroup", "advertisergroup 2015", or simply
-// "advertisergroup".
-func (c *AdvertiserGroupsListCall) SearchString(searchString string) *AdvertiserGroupsListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *AdvertiserGroupsListCall) SortField(sortField string) *AdvertiserGroupsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *AdvertiserGroupsListCall) SortOrder(sortOrder string) *AdvertiserGroupsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdvertiserGroupsListCall) Fields(s ...googleapi.Field) *AdvertiserGroupsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdvertiserGroupsListCall) IfNoneMatch(entityTag string) *AdvertiserGroupsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdvertiserGroupsListCall) Context(ctx context.Context) *AdvertiserGroupsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdvertiserGroupsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/advertiserGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.advertiserGroups.list" call.
-// Exactly one of *AdvertiserGroupsListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *AdvertiserGroupsListResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AdvertiserGroupsListCall) Do() (*AdvertiserGroupsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdvertiserGroupsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of advertiser groups, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.advertiserGroups.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "ids": {
- // "description": "Select only advertiser groups with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"advertiser*2015\" will return objects with names like \"advertiser group June 2015\", \"advertiser group April 2015\", or simply \"advertiser group 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"advertisergroup\" will match objects with name \"my advertisergroup\", \"advertisergroup 2015\", or simply \"advertisergroup\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/advertiserGroups",
- // "response": {
- // "$ref": "AdvertiserGroupsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.advertiserGroups.patch":
-
-type AdvertiserGroupsPatchCall struct {
- s *Service
- profileId int64
- id int64
- advertisergroup *AdvertiserGroup
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing advertiser group. This method supports
-// patch semantics.
-func (r *AdvertiserGroupsService) Patch(profileId int64, id int64, advertisergroup *AdvertiserGroup) *AdvertiserGroupsPatchCall {
- c := &AdvertiserGroupsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.advertisergroup = advertisergroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdvertiserGroupsPatchCall) Fields(s ...googleapi.Field) *AdvertiserGroupsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdvertiserGroupsPatchCall) Context(ctx context.Context) *AdvertiserGroupsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdvertiserGroupsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.advertisergroup)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/advertiserGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.advertiserGroups.patch" call.
-// Exactly one of *AdvertiserGroup or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AdvertiserGroup.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AdvertiserGroupsPatchCall) Do() (*AdvertiserGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdvertiserGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing advertiser group. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.advertiserGroups.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Advertiser group ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/advertiserGroups",
- // "request": {
- // "$ref": "AdvertiserGroup"
- // },
- // "response": {
- // "$ref": "AdvertiserGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.advertiserGroups.update":
-
-type AdvertiserGroupsUpdateCall struct {
- s *Service
- profileId int64
- advertisergroup *AdvertiserGroup
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing advertiser group.
-func (r *AdvertiserGroupsService) Update(profileId int64, advertisergroup *AdvertiserGroup) *AdvertiserGroupsUpdateCall {
- c := &AdvertiserGroupsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.advertisergroup = advertisergroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdvertiserGroupsUpdateCall) Fields(s ...googleapi.Field) *AdvertiserGroupsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdvertiserGroupsUpdateCall) Context(ctx context.Context) *AdvertiserGroupsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdvertiserGroupsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.advertisergroup)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/advertiserGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.advertiserGroups.update" call.
-// Exactly one of *AdvertiserGroup or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AdvertiserGroup.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AdvertiserGroupsUpdateCall) Do() (*AdvertiserGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdvertiserGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing advertiser group.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.advertiserGroups.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/advertiserGroups",
- // "request": {
- // "$ref": "AdvertiserGroup"
- // },
- // "response": {
- // "$ref": "AdvertiserGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.advertisers.get":
-
-type AdvertisersGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one advertiser by ID.
-func (r *AdvertisersService) Get(profileId int64, id int64) *AdvertisersGetCall {
- c := &AdvertisersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdvertisersGetCall) Fields(s ...googleapi.Field) *AdvertisersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdvertisersGetCall) IfNoneMatch(entityTag string) *AdvertisersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdvertisersGetCall) Context(ctx context.Context) *AdvertisersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdvertisersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/advertisers/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.advertisers.get" call.
-// Exactly one of *Advertiser or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Advertiser.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AdvertisersGetCall) Do() (*Advertiser, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Advertiser{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one advertiser by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.advertisers.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Advertiser ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/advertisers/{id}",
- // "response": {
- // "$ref": "Advertiser"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.advertisers.insert":
-
-type AdvertisersInsertCall struct {
- s *Service
- profileId int64
- advertiser *Advertiser
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new advertiser.
-func (r *AdvertisersService) Insert(profileId int64, advertiser *Advertiser) *AdvertisersInsertCall {
- c := &AdvertisersInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.advertiser = advertiser
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdvertisersInsertCall) Fields(s ...googleapi.Field) *AdvertisersInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdvertisersInsertCall) Context(ctx context.Context) *AdvertisersInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdvertisersInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.advertiser)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/advertisers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.advertisers.insert" call.
-// Exactly one of *Advertiser or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Advertiser.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AdvertisersInsertCall) Do() (*Advertiser, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Advertiser{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new advertiser.",
- // "httpMethod": "POST",
- // "id": "dfareporting.advertisers.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/advertisers",
- // "request": {
- // "$ref": "Advertiser"
- // },
- // "response": {
- // "$ref": "Advertiser"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.advertisers.list":
-
-type AdvertisersListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of advertisers, possibly filtered.
-func (r *AdvertisersService) List(profileId int64) *AdvertisersListCall {
- c := &AdvertisersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// AdvertiserGroupIds sets the optional parameter "advertiserGroupIds":
-// Select only advertisers with these advertiser group IDs.
-func (c *AdvertisersListCall) AdvertiserGroupIds(advertiserGroupIds int64) *AdvertisersListCall {
- c.opt_["advertiserGroupIds"] = advertiserGroupIds
- return c
-}
-
-// FloodlightConfigurationIds sets the optional parameter
-// "floodlightConfigurationIds": Select only advertisers with these
-// floodlight configuration IDs.
-func (c *AdvertisersListCall) FloodlightConfigurationIds(floodlightConfigurationIds int64) *AdvertisersListCall {
- c.opt_["floodlightConfigurationIds"] = floodlightConfigurationIds
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only advertisers with
-// these IDs.
-func (c *AdvertisersListCall) Ids(ids int64) *AdvertisersListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// IncludeAdvertisersWithoutGroupsOnly sets the optional parameter
-// "includeAdvertisersWithoutGroupsOnly": Select only advertisers which
-// do not belong to any advertiser group.
-func (c *AdvertisersListCall) IncludeAdvertisersWithoutGroupsOnly(includeAdvertisersWithoutGroupsOnly bool) *AdvertisersListCall {
- c.opt_["includeAdvertisersWithoutGroupsOnly"] = includeAdvertisersWithoutGroupsOnly
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *AdvertisersListCall) MaxResults(maxResults int64) *AdvertisersListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OnlyParent sets the optional parameter "onlyParent": Select only
-// advertisers which use another advertiser's floodlight configuration.
-func (c *AdvertisersListCall) OnlyParent(onlyParent bool) *AdvertisersListCall {
- c.opt_["onlyParent"] = onlyParent
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *AdvertisersListCall) PageToken(pageToken string) *AdvertisersListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name or ID. Wildcards (*) are allowed. For
-// example, "advertiser*2015" will return objects with names like
-// "advertiser June 2015", "advertiser April 2015", or simply
-// "advertiser 2015". Most of the searches also add wildcards implicitly
-// at the start and the end of the search string. For example, a search
-// string of "advertiser" will match objects with name "my advertiser",
-// "advertiser 2015", or simply "advertiser".
-func (c *AdvertisersListCall) SearchString(searchString string) *AdvertisersListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *AdvertisersListCall) SortField(sortField string) *AdvertisersListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *AdvertisersListCall) SortOrder(sortOrder string) *AdvertisersListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Status sets the optional parameter "status": Select only advertisers
-// with the specified status.
-//
-// Possible values:
-// "APPROVED"
-// "ON_HOLD"
-func (c *AdvertisersListCall) Status(status string) *AdvertisersListCall {
- c.opt_["status"] = status
- return c
-}
-
-// SubaccountId sets the optional parameter "subaccountId": Select only
-// advertisers with these subaccount IDs.
-func (c *AdvertisersListCall) SubaccountId(subaccountId int64) *AdvertisersListCall {
- c.opt_["subaccountId"] = subaccountId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdvertisersListCall) Fields(s ...googleapi.Field) *AdvertisersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdvertisersListCall) IfNoneMatch(entityTag string) *AdvertisersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdvertisersListCall) Context(ctx context.Context) *AdvertisersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdvertisersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["advertiserGroupIds"]; ok {
- params.Set("advertiserGroupIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["floodlightConfigurationIds"]; ok {
- params.Set("floodlightConfigurationIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["includeAdvertisersWithoutGroupsOnly"]; ok {
- params.Set("includeAdvertisersWithoutGroupsOnly", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["onlyParent"]; ok {
- params.Set("onlyParent", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["status"]; ok {
- params.Set("status", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["subaccountId"]; ok {
- params.Set("subaccountId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/advertisers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.advertisers.list" call.
-// Exactly one of *AdvertisersListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AdvertisersListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AdvertisersListCall) Do() (*AdvertisersListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdvertisersListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of advertisers, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.advertisers.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "advertiserGroupIds": {
- // "description": "Select only advertisers with these advertiser group IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "floodlightConfigurationIds": {
- // "description": "Select only advertisers with these floodlight configuration IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only advertisers with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "includeAdvertisersWithoutGroupsOnly": {
- // "description": "Select only advertisers which do not belong to any advertiser group.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "onlyParent": {
- // "description": "Select only advertisers which use another advertiser's floodlight configuration.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"advertiser*2015\" will return objects with names like \"advertiser June 2015\", \"advertiser April 2015\", or simply \"advertiser 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"advertiser\" will match objects with name \"my advertiser\", \"advertiser 2015\", or simply \"advertiser\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "status": {
- // "description": "Select only advertisers with the specified status.",
- // "enum": [
- // "APPROVED",
- // "ON_HOLD"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "subaccountId": {
- // "description": "Select only advertisers with these subaccount IDs.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/advertisers",
- // "response": {
- // "$ref": "AdvertisersListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.advertisers.patch":
-
-type AdvertisersPatchCall struct {
- s *Service
- profileId int64
- id int64
- advertiser *Advertiser
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing advertiser. This method supports patch
-// semantics.
-func (r *AdvertisersService) Patch(profileId int64, id int64, advertiser *Advertiser) *AdvertisersPatchCall {
- c := &AdvertisersPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.advertiser = advertiser
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdvertisersPatchCall) Fields(s ...googleapi.Field) *AdvertisersPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdvertisersPatchCall) Context(ctx context.Context) *AdvertisersPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdvertisersPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.advertiser)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/advertisers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.advertisers.patch" call.
-// Exactly one of *Advertiser or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Advertiser.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AdvertisersPatchCall) Do() (*Advertiser, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Advertiser{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing advertiser. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.advertisers.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Advertiser ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/advertisers",
- // "request": {
- // "$ref": "Advertiser"
- // },
- // "response": {
- // "$ref": "Advertiser"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.advertisers.update":
-
-type AdvertisersUpdateCall struct {
- s *Service
- profileId int64
- advertiser *Advertiser
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing advertiser.
-func (r *AdvertisersService) Update(profileId int64, advertiser *Advertiser) *AdvertisersUpdateCall {
- c := &AdvertisersUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.advertiser = advertiser
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdvertisersUpdateCall) Fields(s ...googleapi.Field) *AdvertisersUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdvertisersUpdateCall) Context(ctx context.Context) *AdvertisersUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdvertisersUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.advertiser)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/advertisers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.advertisers.update" call.
-// Exactly one of *Advertiser or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Advertiser.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AdvertisersUpdateCall) Do() (*Advertiser, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Advertiser{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing advertiser.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.advertisers.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/advertisers",
- // "request": {
- // "$ref": "Advertiser"
- // },
- // "response": {
- // "$ref": "Advertiser"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.browsers.list":
-
-type BrowsersListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of browsers.
-func (r *BrowsersService) List(profileId int64) *BrowsersListCall {
- c := &BrowsersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BrowsersListCall) Fields(s ...googleapi.Field) *BrowsersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *BrowsersListCall) IfNoneMatch(entityTag string) *BrowsersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BrowsersListCall) Context(ctx context.Context) *BrowsersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BrowsersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/browsers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.browsers.list" call.
-// Exactly one of *BrowsersListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *BrowsersListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *BrowsersListCall) Do() (*BrowsersListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &BrowsersListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of browsers.",
- // "httpMethod": "GET",
- // "id": "dfareporting.browsers.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/browsers",
- // "response": {
- // "$ref": "BrowsersListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.campaignCreativeAssociations.insert":
-
-type CampaignCreativeAssociationsInsertCall struct {
- s *Service
- profileId int64
- campaignId int64
- campaigncreativeassociation *CampaignCreativeAssociation
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Associates a creative with the specified campaign. This
-// method creates a default ad with dimensions matching the creative in
-// the campaign if such a default ad does not exist already.
-func (r *CampaignCreativeAssociationsService) Insert(profileId int64, campaignId int64, campaigncreativeassociation *CampaignCreativeAssociation) *CampaignCreativeAssociationsInsertCall {
- c := &CampaignCreativeAssociationsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.campaignId = campaignId
- c.campaigncreativeassociation = campaigncreativeassociation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CampaignCreativeAssociationsInsertCall) Fields(s ...googleapi.Field) *CampaignCreativeAssociationsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CampaignCreativeAssociationsInsertCall) Context(ctx context.Context) *CampaignCreativeAssociationsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CampaignCreativeAssociationsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.campaigncreativeassociation)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "campaignId": strconv.FormatInt(c.campaignId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.campaignCreativeAssociations.insert" call.
-// Exactly one of *CampaignCreativeAssociation or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *CampaignCreativeAssociation.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CampaignCreativeAssociationsInsertCall) Do() (*CampaignCreativeAssociation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CampaignCreativeAssociation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.",
- // "httpMethod": "POST",
- // "id": "dfareporting.campaignCreativeAssociations.insert",
- // "parameterOrder": [
- // "profileId",
- // "campaignId"
- // ],
- // "parameters": {
- // "campaignId": {
- // "description": "Campaign ID in this association.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
- // "request": {
- // "$ref": "CampaignCreativeAssociation"
- // },
- // "response": {
- // "$ref": "CampaignCreativeAssociation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.campaignCreativeAssociations.list":
-
-type CampaignCreativeAssociationsListCall struct {
- s *Service
- profileId int64
- campaignId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of creative IDs associated with the
-// specified campaign.
-func (r *CampaignCreativeAssociationsService) List(profileId int64, campaignId int64) *CampaignCreativeAssociationsListCall {
- c := &CampaignCreativeAssociationsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.campaignId = campaignId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *CampaignCreativeAssociationsListCall) MaxResults(maxResults int64) *CampaignCreativeAssociationsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *CampaignCreativeAssociationsListCall) PageToken(pageToken string) *CampaignCreativeAssociationsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *CampaignCreativeAssociationsListCall) SortOrder(sortOrder string) *CampaignCreativeAssociationsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CampaignCreativeAssociationsListCall) Fields(s ...googleapi.Field) *CampaignCreativeAssociationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CampaignCreativeAssociationsListCall) IfNoneMatch(entityTag string) *CampaignCreativeAssociationsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CampaignCreativeAssociationsListCall) Context(ctx context.Context) *CampaignCreativeAssociationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CampaignCreativeAssociationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "campaignId": strconv.FormatInt(c.campaignId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.campaignCreativeAssociations.list" call.
-// Exactly one of *CampaignCreativeAssociationsListResponse or error
-// will be non-nil. Any non-2xx status code is an error. Response
-// headers are in either
-// *CampaignCreativeAssociationsListResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *CampaignCreativeAssociationsListCall) Do() (*CampaignCreativeAssociationsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CampaignCreativeAssociationsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of creative IDs associated with the specified campaign.",
- // "httpMethod": "GET",
- // "id": "dfareporting.campaignCreativeAssociations.list",
- // "parameterOrder": [
- // "profileId",
- // "campaignId"
- // ],
- // "parameters": {
- // "campaignId": {
- // "description": "Campaign ID in this association.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
- // "response": {
- // "$ref": "CampaignCreativeAssociationsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.campaigns.get":
-
-type CampaignsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one campaign by ID.
-func (r *CampaignsService) Get(profileId int64, id int64) *CampaignsGetCall {
- c := &CampaignsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CampaignsGetCall) Fields(s ...googleapi.Field) *CampaignsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CampaignsGetCall) IfNoneMatch(entityTag string) *CampaignsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CampaignsGetCall) Context(ctx context.Context) *CampaignsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CampaignsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/campaigns/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.campaigns.get" call.
-// Exactly one of *Campaign or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Campaign.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CampaignsGetCall) Do() (*Campaign, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Campaign{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one campaign by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.campaigns.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Campaign ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/campaigns/{id}",
- // "response": {
- // "$ref": "Campaign"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.campaigns.insert":
-
-type CampaignsInsertCall struct {
- s *Service
- profileId int64
- defaultLandingPageName string
- defaultLandingPageUrl string
- campaign *Campaign
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new campaign.
-func (r *CampaignsService) Insert(profileId int64, defaultLandingPageName string, defaultLandingPageUrl string, campaign *Campaign) *CampaignsInsertCall {
- c := &CampaignsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.defaultLandingPageName = defaultLandingPageName
- c.defaultLandingPageUrl = defaultLandingPageUrl
- c.campaign = campaign
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CampaignsInsertCall) Fields(s ...googleapi.Field) *CampaignsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CampaignsInsertCall) Context(ctx context.Context) *CampaignsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CampaignsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.campaign)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("defaultLandingPageName", fmt.Sprintf("%v", c.defaultLandingPageName))
- params.Set("defaultLandingPageUrl", fmt.Sprintf("%v", c.defaultLandingPageUrl))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/campaigns")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.campaigns.insert" call.
-// Exactly one of *Campaign or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Campaign.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CampaignsInsertCall) Do() (*Campaign, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Campaign{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new campaign.",
- // "httpMethod": "POST",
- // "id": "dfareporting.campaigns.insert",
- // "parameterOrder": [
- // "profileId",
- // "defaultLandingPageName",
- // "defaultLandingPageUrl"
- // ],
- // "parameters": {
- // "defaultLandingPageName": {
- // "description": "Default landing page name for this new campaign. Must be less than 256 characters long.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "defaultLandingPageUrl": {
- // "description": "Default landing page URL for this new campaign.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/campaigns",
- // "request": {
- // "$ref": "Campaign"
- // },
- // "response": {
- // "$ref": "Campaign"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.campaigns.list":
-
-type CampaignsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of campaigns, possibly filtered.
-func (r *CampaignsService) List(profileId int64) *CampaignsListCall {
- c := &CampaignsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// AdvertiserGroupIds sets the optional parameter "advertiserGroupIds":
-// Select only campaigns whose advertisers belong to these advertiser
-// groups.
-func (c *CampaignsListCall) AdvertiserGroupIds(advertiserGroupIds int64) *CampaignsListCall {
- c.opt_["advertiserGroupIds"] = advertiserGroupIds
- return c
-}
-
-// AdvertiserIds sets the optional parameter "advertiserIds": Select
-// only campaigns that belong to these advertisers.
-func (c *CampaignsListCall) AdvertiserIds(advertiserIds int64) *CampaignsListCall {
- c.opt_["advertiserIds"] = advertiserIds
- return c
-}
-
-// Archived sets the optional parameter "archived": Select only archived
-// campaigns. Don't set this field to select both archived and
-// non-archived campaigns.
-func (c *CampaignsListCall) Archived(archived bool) *CampaignsListCall {
- c.opt_["archived"] = archived
- return c
-}
-
-// AtLeastOneOptimizationActivity sets the optional parameter
-// "atLeastOneOptimizationActivity": Select only campaigns that have at
-// least one optimization activity.
-func (c *CampaignsListCall) AtLeastOneOptimizationActivity(atLeastOneOptimizationActivity bool) *CampaignsListCall {
- c.opt_["atLeastOneOptimizationActivity"] = atLeastOneOptimizationActivity
- return c
-}
-
-// ExcludedIds sets the optional parameter "excludedIds": Exclude
-// campaigns with these IDs.
-func (c *CampaignsListCall) ExcludedIds(excludedIds int64) *CampaignsListCall {
- c.opt_["excludedIds"] = excludedIds
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only campaigns with
-// these IDs.
-func (c *CampaignsListCall) Ids(ids int64) *CampaignsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *CampaignsListCall) MaxResults(maxResults int64) *CampaignsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OverriddenEventTagId sets the optional parameter
-// "overriddenEventTagId": Select only campaigns that have overridden
-// this event tag ID.
-func (c *CampaignsListCall) OverriddenEventTagId(overriddenEventTagId int64) *CampaignsListCall {
- c.opt_["overriddenEventTagId"] = overriddenEventTagId
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *CampaignsListCall) PageToken(pageToken string) *CampaignsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for campaigns by name or ID. Wildcards (*) are allowed. For
-// example, "campaign*2015" will return campaigns with names like
-// "campaign June 2015", "campaign April 2015", or simply "campaign
-// 2015". Most of the searches also add wildcards implicitly at the
-// start and the end of the search string. For example, a search string
-// of "campaign" will match campaigns with name "my campaign", "campaign
-// 2015", or simply "campaign".
-func (c *CampaignsListCall) SearchString(searchString string) *CampaignsListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *CampaignsListCall) SortField(sortField string) *CampaignsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *CampaignsListCall) SortOrder(sortOrder string) *CampaignsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// SubaccountId sets the optional parameter "subaccountId": Select only
-// campaigns that belong to this subaccount.
-func (c *CampaignsListCall) SubaccountId(subaccountId int64) *CampaignsListCall {
- c.opt_["subaccountId"] = subaccountId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CampaignsListCall) Fields(s ...googleapi.Field) *CampaignsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CampaignsListCall) IfNoneMatch(entityTag string) *CampaignsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CampaignsListCall) Context(ctx context.Context) *CampaignsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CampaignsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["advertiserGroupIds"]; ok {
- params.Set("advertiserGroupIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["advertiserIds"]; ok {
- params.Set("advertiserIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["archived"]; ok {
- params.Set("archived", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["atLeastOneOptimizationActivity"]; ok {
- params.Set("atLeastOneOptimizationActivity", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["excludedIds"]; ok {
- params.Set("excludedIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["overriddenEventTagId"]; ok {
- params.Set("overriddenEventTagId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["subaccountId"]; ok {
- params.Set("subaccountId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/campaigns")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.campaigns.list" call.
-// Exactly one of *CampaignsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CampaignsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CampaignsListCall) Do() (*CampaignsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CampaignsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of campaigns, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.campaigns.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "advertiserGroupIds": {
- // "description": "Select only campaigns whose advertisers belong to these advertiser groups.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "advertiserIds": {
- // "description": "Select only campaigns that belong to these advertisers.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "archived": {
- // "description": "Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "atLeastOneOptimizationActivity": {
- // "description": "Select only campaigns that have at least one optimization activity.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "excludedIds": {
- // "description": "Exclude campaigns with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only campaigns with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "overriddenEventTagId": {
- // "description": "Select only campaigns that have overridden this event tag ID.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, \"campaign*2015\" will return campaigns with names like \"campaign June 2015\", \"campaign April 2015\", or simply \"campaign 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"campaign\" will match campaigns with name \"my campaign\", \"campaign 2015\", or simply \"campaign\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "subaccountId": {
- // "description": "Select only campaigns that belong to this subaccount.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/campaigns",
- // "response": {
- // "$ref": "CampaignsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.campaigns.patch":
-
-type CampaignsPatchCall struct {
- s *Service
- profileId int64
- id int64
- campaign *Campaign
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing campaign. This method supports patch
-// semantics.
-func (r *CampaignsService) Patch(profileId int64, id int64, campaign *Campaign) *CampaignsPatchCall {
- c := &CampaignsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.campaign = campaign
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CampaignsPatchCall) Fields(s ...googleapi.Field) *CampaignsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CampaignsPatchCall) Context(ctx context.Context) *CampaignsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CampaignsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.campaign)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/campaigns")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.campaigns.patch" call.
-// Exactly one of *Campaign or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Campaign.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CampaignsPatchCall) Do() (*Campaign, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Campaign{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing campaign. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.campaigns.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Campaign ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/campaigns",
- // "request": {
- // "$ref": "Campaign"
- // },
- // "response": {
- // "$ref": "Campaign"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.campaigns.update":
-
-type CampaignsUpdateCall struct {
- s *Service
- profileId int64
- campaign *Campaign
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing campaign.
-func (r *CampaignsService) Update(profileId int64, campaign *Campaign) *CampaignsUpdateCall {
- c := &CampaignsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.campaign = campaign
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CampaignsUpdateCall) Fields(s ...googleapi.Field) *CampaignsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CampaignsUpdateCall) Context(ctx context.Context) *CampaignsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CampaignsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.campaign)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/campaigns")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.campaigns.update" call.
-// Exactly one of *Campaign or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Campaign.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CampaignsUpdateCall) Do() (*Campaign, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Campaign{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing campaign.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.campaigns.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/campaigns",
- // "request": {
- // "$ref": "Campaign"
- // },
- // "response": {
- // "$ref": "Campaign"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.changeLogs.get":
-
-type ChangeLogsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one change log by ID.
-func (r *ChangeLogsService) Get(profileId int64, id int64) *ChangeLogsGetCall {
- c := &ChangeLogsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ChangeLogsGetCall) Fields(s ...googleapi.Field) *ChangeLogsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ChangeLogsGetCall) IfNoneMatch(entityTag string) *ChangeLogsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ChangeLogsGetCall) Context(ctx context.Context) *ChangeLogsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ChangeLogsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/changeLogs/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.changeLogs.get" call.
-// Exactly one of *ChangeLog or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ChangeLog.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ChangeLogsGetCall) Do() (*ChangeLog, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ChangeLog{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one change log by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.changeLogs.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Change log ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/changeLogs/{id}",
- // "response": {
- // "$ref": "ChangeLog"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.changeLogs.list":
-
-type ChangeLogsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of change logs.
-func (r *ChangeLogsService) List(profileId int64) *ChangeLogsListCall {
- c := &ChangeLogsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Action sets the optional parameter "action": Select only change logs
-// with the specified action.
-//
-// Possible values:
-// "ACTION_ADD"
-// "ACTION_ASSIGN"
-// "ACTION_ASSOCIATE"
-// "ACTION_CREATE"
-// "ACTION_DELETE"
-// "ACTION_DISABLE"
-// "ACTION_EMAIL_TAGS"
-// "ACTION_ENABLE"
-// "ACTION_LINK"
-// "ACTION_MARK_AS_DEFAULT"
-// "ACTION_PUSH"
-// "ACTION_REMOVE"
-// "ACTION_SEND"
-// "ACTION_SHARE"
-// "ACTION_UNASSIGN"
-// "ACTION_UNLINK"
-// "ACTION_UPDATE"
-func (c *ChangeLogsListCall) Action(action string) *ChangeLogsListCall {
- c.opt_["action"] = action
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only change logs with
-// these IDs.
-func (c *ChangeLogsListCall) Ids(ids int64) *ChangeLogsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxChangeTime sets the optional parameter "maxChangeTime": Select
-// only change logs whose change time is before the specified
-// maxChangeTime.The time should be formatted as an RFC3339 date/time
-// string. For example, for 10:54 PM on July 18th, 2015, in the
-// America/New York time zone, the format is
-// "2015-07-18T22:54:00-04:00". In other words, the year, month, day,
-// the letter T, the hour (24-hour clock system), minute, second, and
-// then the time zone offset.
-func (c *ChangeLogsListCall) MaxChangeTime(maxChangeTime string) *ChangeLogsListCall {
- c.opt_["maxChangeTime"] = maxChangeTime
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *ChangeLogsListCall) MaxResults(maxResults int64) *ChangeLogsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// MinChangeTime sets the optional parameter "minChangeTime": Select
-// only change logs whose change time is before the specified
-// minChangeTime.The time should be formatted as an RFC3339 date/time
-// string. For example, for 10:54 PM on July 18th, 2015, in the
-// America/New York time zone, the format is
-// "2015-07-18T22:54:00-04:00". In other words, the year, month, day,
-// the letter T, the hour (24-hour clock system), minute, second, and
-// then the time zone offset.
-func (c *ChangeLogsListCall) MinChangeTime(minChangeTime string) *ChangeLogsListCall {
- c.opt_["minChangeTime"] = minChangeTime
- return c
-}
-
-// ObjectIds sets the optional parameter "objectIds": Select only change
-// logs with these object IDs.
-func (c *ChangeLogsListCall) ObjectIds(objectIds int64) *ChangeLogsListCall {
- c.opt_["objectIds"] = objectIds
- return c
-}
-
-// ObjectType sets the optional parameter "objectType": Select only
-// change logs with the specified object type.
-//
-// Possible values:
-// "OBJECT_ACCOUNT"
-// "OBJECT_ACCOUNT_BILLING_FEATURE"
-// "OBJECT_AD"
-// "OBJECT_ADVERTISER"
-// "OBJECT_ADVERTISER_GROUP"
-// "OBJECT_BILLING_ACCOUNT_GROUP"
-// "OBJECT_BILLING_FEATURE"
-// "OBJECT_BILLING_MINIMUM_FEE"
-// "OBJECT_BILLING_PROFILE"
-// "OBJECT_CAMPAIGN"
-// "OBJECT_CONTENT_CATEGORY"
-// "OBJECT_CREATIVE"
-// "OBJECT_CREATIVE_ASSET"
-// "OBJECT_CREATIVE_BUNDLE"
-// "OBJECT_CREATIVE_FIELD"
-// "OBJECT_CREATIVE_GROUP"
-// "OBJECT_DFA_SITE"
-// "OBJECT_EVENT_TAG"
-// "OBJECT_FLOODLIGHT_ACTIVITY_GROUP"
-// "OBJECT_FLOODLIGHT_ACTVITY"
-// "OBJECT_FLOODLIGHT_CONFIGURATION"
-// "OBJECT_INSTREAM_CREATIVE"
-// "OBJECT_LANDING_PAGE"
-// "OBJECT_MEDIA_ORDER"
-// "OBJECT_PLACEMENT"
-// "OBJECT_PLACEMENT_STRATEGY"
-// "OBJECT_PROVIDED_LIST_CLIENT"
-// "OBJECT_RATE_CARD"
-// "OBJECT_REMARKETING_LIST"
-// "OBJECT_RICHMEDIA_CREATIVE"
-// "OBJECT_SD_SITE"
-// "OBJECT_SIZE"
-// "OBJECT_SUBACCOUNT"
-// "OBJECT_USER_PROFILE"
-// "OBJECT_USER_PROFILE_FILTER"
-// "OBJECT_USER_ROLE"
-func (c *ChangeLogsListCall) ObjectType(objectType string) *ChangeLogsListCall {
- c.opt_["objectType"] = objectType
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *ChangeLogsListCall) PageToken(pageToken string) *ChangeLogsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Select only
-// change logs whose object ID, user name, old or new values match the
-// search string.
-func (c *ChangeLogsListCall) SearchString(searchString string) *ChangeLogsListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// UserProfileIds sets the optional parameter "userProfileIds": Select
-// only change logs with these user profile IDs.
-func (c *ChangeLogsListCall) UserProfileIds(userProfileIds int64) *ChangeLogsListCall {
- c.opt_["userProfileIds"] = userProfileIds
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ChangeLogsListCall) Fields(s ...googleapi.Field) *ChangeLogsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ChangeLogsListCall) IfNoneMatch(entityTag string) *ChangeLogsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ChangeLogsListCall) Context(ctx context.Context) *ChangeLogsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ChangeLogsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["action"]; ok {
- params.Set("action", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxChangeTime"]; ok {
- params.Set("maxChangeTime", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["minChangeTime"]; ok {
- params.Set("minChangeTime", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["objectIds"]; ok {
- params.Set("objectIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["objectType"]; ok {
- params.Set("objectType", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["userProfileIds"]; ok {
- params.Set("userProfileIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/changeLogs")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.changeLogs.list" call.
-// Exactly one of *ChangeLogsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ChangeLogsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ChangeLogsListCall) Do() (*ChangeLogsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ChangeLogsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of change logs.",
- // "httpMethod": "GET",
- // "id": "dfareporting.changeLogs.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "action": {
- // "description": "Select only change logs with the specified action.",
- // "enum": [
- // "ACTION_ADD",
- // "ACTION_ASSIGN",
- // "ACTION_ASSOCIATE",
- // "ACTION_CREATE",
- // "ACTION_DELETE",
- // "ACTION_DISABLE",
- // "ACTION_EMAIL_TAGS",
- // "ACTION_ENABLE",
- // "ACTION_LINK",
- // "ACTION_MARK_AS_DEFAULT",
- // "ACTION_PUSH",
- // "ACTION_REMOVE",
- // "ACTION_SEND",
- // "ACTION_SHARE",
- // "ACTION_UNASSIGN",
- // "ACTION_UNLINK",
- // "ACTION_UPDATE"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only change logs with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxChangeTime": {
- // "description": "Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is \"2015-07-18T22:54:00-04:00\". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "minChangeTime": {
- // "description": "Select only change logs whose change time is before the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is \"2015-07-18T22:54:00-04:00\". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.",
- // "location": "query",
- // "type": "string"
- // },
- // "objectIds": {
- // "description": "Select only change logs with these object IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "objectType": {
- // "description": "Select only change logs with the specified object type.",
- // "enum": [
- // "OBJECT_ACCOUNT",
- // "OBJECT_ACCOUNT_BILLING_FEATURE",
- // "OBJECT_AD",
- // "OBJECT_ADVERTISER",
- // "OBJECT_ADVERTISER_GROUP",
- // "OBJECT_BILLING_ACCOUNT_GROUP",
- // "OBJECT_BILLING_FEATURE",
- // "OBJECT_BILLING_MINIMUM_FEE",
- // "OBJECT_BILLING_PROFILE",
- // "OBJECT_CAMPAIGN",
- // "OBJECT_CONTENT_CATEGORY",
- // "OBJECT_CREATIVE",
- // "OBJECT_CREATIVE_ASSET",
- // "OBJECT_CREATIVE_BUNDLE",
- // "OBJECT_CREATIVE_FIELD",
- // "OBJECT_CREATIVE_GROUP",
- // "OBJECT_DFA_SITE",
- // "OBJECT_EVENT_TAG",
- // "OBJECT_FLOODLIGHT_ACTIVITY_GROUP",
- // "OBJECT_FLOODLIGHT_ACTVITY",
- // "OBJECT_FLOODLIGHT_CONFIGURATION",
- // "OBJECT_INSTREAM_CREATIVE",
- // "OBJECT_LANDING_PAGE",
- // "OBJECT_MEDIA_ORDER",
- // "OBJECT_PLACEMENT",
- // "OBJECT_PLACEMENT_STRATEGY",
- // "OBJECT_PROVIDED_LIST_CLIENT",
- // "OBJECT_RATE_CARD",
- // "OBJECT_REMARKETING_LIST",
- // "OBJECT_RICHMEDIA_CREATIVE",
- // "OBJECT_SD_SITE",
- // "OBJECT_SIZE",
- // "OBJECT_SUBACCOUNT",
- // "OBJECT_USER_PROFILE",
- // "OBJECT_USER_PROFILE_FILTER",
- // "OBJECT_USER_ROLE"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Select only change logs whose object ID, user name, old or new values match the search string.",
- // "location": "query",
- // "type": "string"
- // },
- // "userProfileIds": {
- // "description": "Select only change logs with these user profile IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/changeLogs",
- // "response": {
- // "$ref": "ChangeLogsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.cities.list":
-
-type CitiesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of cities, possibly filtered.
-func (r *CitiesService) List(profileId int64) *CitiesListCall {
- c := &CitiesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// CountryDartIds sets the optional parameter "countryDartIds": Select
-// only cities from these countries.
-func (c *CitiesListCall) CountryDartIds(countryDartIds int64) *CitiesListCall {
- c.opt_["countryDartIds"] = countryDartIds
- return c
-}
-
-// DartIds sets the optional parameter "dartIds": Select only cities
-// with these DART IDs.
-func (c *CitiesListCall) DartIds(dartIds int64) *CitiesListCall {
- c.opt_["dartIds"] = dartIds
- return c
-}
-
-// NamePrefix sets the optional parameter "namePrefix": Select only
-// cities with names starting with this prefix.
-func (c *CitiesListCall) NamePrefix(namePrefix string) *CitiesListCall {
- c.opt_["namePrefix"] = namePrefix
- return c
-}
-
-// RegionDartIds sets the optional parameter "regionDartIds": Select
-// only cities from these regions.
-func (c *CitiesListCall) RegionDartIds(regionDartIds int64) *CitiesListCall {
- c.opt_["regionDartIds"] = regionDartIds
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CitiesListCall) Fields(s ...googleapi.Field) *CitiesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CitiesListCall) IfNoneMatch(entityTag string) *CitiesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CitiesListCall) Context(ctx context.Context) *CitiesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CitiesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["countryDartIds"]; ok {
- params.Set("countryDartIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["dartIds"]; ok {
- params.Set("dartIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["namePrefix"]; ok {
- params.Set("namePrefix", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["regionDartIds"]; ok {
- params.Set("regionDartIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/cities")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.cities.list" call.
-// Exactly one of *CitiesListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CitiesListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CitiesListCall) Do() (*CitiesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CitiesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of cities, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.cities.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "countryDartIds": {
- // "description": "Select only cities from these countries.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "dartIds": {
- // "description": "Select only cities with these DART IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "namePrefix": {
- // "description": "Select only cities with names starting with this prefix.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "regionDartIds": {
- // "description": "Select only cities from these regions.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/cities",
- // "response": {
- // "$ref": "CitiesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.connectionTypes.list":
-
-type ConnectionTypesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of connection types.
-func (r *ConnectionTypesService) List(profileId int64) *ConnectionTypesListCall {
- c := &ConnectionTypesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ConnectionTypesListCall) Fields(s ...googleapi.Field) *ConnectionTypesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ConnectionTypesListCall) IfNoneMatch(entityTag string) *ConnectionTypesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ConnectionTypesListCall) Context(ctx context.Context) *ConnectionTypesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ConnectionTypesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/connectionTypes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.connectionTypes.list" call.
-// Exactly one of *ConnectionTypesListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *ConnectionTypesListResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ConnectionTypesListCall) Do() (*ConnectionTypesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ConnectionTypesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of connection types.",
- // "httpMethod": "GET",
- // "id": "dfareporting.connectionTypes.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/connectionTypes",
- // "response": {
- // "$ref": "ConnectionTypesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.contentCategories.delete":
-
-type ContentCategoriesDeleteCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an existing content category.
-func (r *ContentCategoriesService) Delete(profileId int64, id int64) *ContentCategoriesDeleteCall {
- c := &ContentCategoriesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ContentCategoriesDeleteCall) Fields(s ...googleapi.Field) *ContentCategoriesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ContentCategoriesDeleteCall) Context(ctx context.Context) *ContentCategoriesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ContentCategoriesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/contentCategories/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.contentCategories.delete" call.
-func (c *ContentCategoriesDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes an existing content category.",
- // "httpMethod": "DELETE",
- // "id": "dfareporting.contentCategories.delete",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Content category ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/contentCategories/{id}",
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.contentCategories.get":
-
-type ContentCategoriesGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one content category by ID.
-func (r *ContentCategoriesService) Get(profileId int64, id int64) *ContentCategoriesGetCall {
- c := &ContentCategoriesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ContentCategoriesGetCall) Fields(s ...googleapi.Field) *ContentCategoriesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ContentCategoriesGetCall) IfNoneMatch(entityTag string) *ContentCategoriesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ContentCategoriesGetCall) Context(ctx context.Context) *ContentCategoriesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ContentCategoriesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/contentCategories/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.contentCategories.get" call.
-// Exactly one of *ContentCategory or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ContentCategory.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ContentCategoriesGetCall) Do() (*ContentCategory, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ContentCategory{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one content category by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.contentCategories.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Content category ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/contentCategories/{id}",
- // "response": {
- // "$ref": "ContentCategory"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.contentCategories.insert":
-
-type ContentCategoriesInsertCall struct {
- s *Service
- profileId int64
- contentcategory *ContentCategory
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new content category.
-func (r *ContentCategoriesService) Insert(profileId int64, contentcategory *ContentCategory) *ContentCategoriesInsertCall {
- c := &ContentCategoriesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.contentcategory = contentcategory
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ContentCategoriesInsertCall) Fields(s ...googleapi.Field) *ContentCategoriesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ContentCategoriesInsertCall) Context(ctx context.Context) *ContentCategoriesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ContentCategoriesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.contentcategory)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/contentCategories")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.contentCategories.insert" call.
-// Exactly one of *ContentCategory or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ContentCategory.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ContentCategoriesInsertCall) Do() (*ContentCategory, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ContentCategory{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new content category.",
- // "httpMethod": "POST",
- // "id": "dfareporting.contentCategories.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/contentCategories",
- // "request": {
- // "$ref": "ContentCategory"
- // },
- // "response": {
- // "$ref": "ContentCategory"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.contentCategories.list":
-
-type ContentCategoriesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of content categories, possibly filtered.
-func (r *ContentCategoriesService) List(profileId int64) *ContentCategoriesListCall {
- c := &ContentCategoriesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only content categories
-// with these IDs.
-func (c *ContentCategoriesListCall) Ids(ids int64) *ContentCategoriesListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *ContentCategoriesListCall) MaxResults(maxResults int64) *ContentCategoriesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *ContentCategoriesListCall) PageToken(pageToken string) *ContentCategoriesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name or ID. Wildcards (*) are allowed. For
-// example, "contentcategory*2015" will return objects with names like
-// "contentcategory June 2015", "contentcategory April 2015", or simply
-// "contentcategory 2015". Most of the searches also add wildcards
-// implicitly at the start and the end of the search string. For
-// example, a search string of "contentcategory" will match objects with
-// name "my contentcategory", "contentcategory 2015", or simply
-// "contentcategory".
-func (c *ContentCategoriesListCall) SearchString(searchString string) *ContentCategoriesListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *ContentCategoriesListCall) SortField(sortField string) *ContentCategoriesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *ContentCategoriesListCall) SortOrder(sortOrder string) *ContentCategoriesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ContentCategoriesListCall) Fields(s ...googleapi.Field) *ContentCategoriesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ContentCategoriesListCall) IfNoneMatch(entityTag string) *ContentCategoriesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ContentCategoriesListCall) Context(ctx context.Context) *ContentCategoriesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ContentCategoriesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/contentCategories")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.contentCategories.list" call.
-// Exactly one of *ContentCategoriesListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *ContentCategoriesListResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ContentCategoriesListCall) Do() (*ContentCategoriesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ContentCategoriesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of content categories, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.contentCategories.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "ids": {
- // "description": "Select only content categories with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"contentcategory*2015\" will return objects with names like \"contentcategory June 2015\", \"contentcategory April 2015\", or simply \"contentcategory 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"contentcategory\" will match objects with name \"my contentcategory\", \"contentcategory 2015\", or simply \"contentcategory\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/contentCategories",
- // "response": {
- // "$ref": "ContentCategoriesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.contentCategories.patch":
-
-type ContentCategoriesPatchCall struct {
- s *Service
- profileId int64
- id int64
- contentcategory *ContentCategory
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing content category. This method supports
-// patch semantics.
-func (r *ContentCategoriesService) Patch(profileId int64, id int64, contentcategory *ContentCategory) *ContentCategoriesPatchCall {
- c := &ContentCategoriesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.contentcategory = contentcategory
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ContentCategoriesPatchCall) Fields(s ...googleapi.Field) *ContentCategoriesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ContentCategoriesPatchCall) Context(ctx context.Context) *ContentCategoriesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ContentCategoriesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.contentcategory)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/contentCategories")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.contentCategories.patch" call.
-// Exactly one of *ContentCategory or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ContentCategory.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ContentCategoriesPatchCall) Do() (*ContentCategory, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ContentCategory{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing content category. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.contentCategories.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Content category ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/contentCategories",
- // "request": {
- // "$ref": "ContentCategory"
- // },
- // "response": {
- // "$ref": "ContentCategory"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.contentCategories.update":
-
-type ContentCategoriesUpdateCall struct {
- s *Service
- profileId int64
- contentcategory *ContentCategory
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing content category.
-func (r *ContentCategoriesService) Update(profileId int64, contentcategory *ContentCategory) *ContentCategoriesUpdateCall {
- c := &ContentCategoriesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.contentcategory = contentcategory
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ContentCategoriesUpdateCall) Fields(s ...googleapi.Field) *ContentCategoriesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ContentCategoriesUpdateCall) Context(ctx context.Context) *ContentCategoriesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ContentCategoriesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.contentcategory)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/contentCategories")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.contentCategories.update" call.
-// Exactly one of *ContentCategory or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ContentCategory.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ContentCategoriesUpdateCall) Do() (*ContentCategory, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ContentCategory{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing content category.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.contentCategories.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/contentCategories",
- // "request": {
- // "$ref": "ContentCategory"
- // },
- // "response": {
- // "$ref": "ContentCategory"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.countries.get":
-
-type CountriesGetCall struct {
- s *Service
- profileId int64
- dartId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one country by ID.
-func (r *CountriesService) Get(profileId int64, dartId int64) *CountriesGetCall {
- c := &CountriesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.dartId = dartId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CountriesGetCall) Fields(s ...googleapi.Field) *CountriesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CountriesGetCall) IfNoneMatch(entityTag string) *CountriesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CountriesGetCall) Context(ctx context.Context) *CountriesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CountriesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/countries/{dartId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "dartId": strconv.FormatInt(c.dartId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.countries.get" call.
-// Exactly one of *Country or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Country.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *CountriesGetCall) Do() (*Country, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Country{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one country by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.countries.get",
- // "parameterOrder": [
- // "profileId",
- // "dartId"
- // ],
- // "parameters": {
- // "dartId": {
- // "description": "Country DART ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/countries/{dartId}",
- // "response": {
- // "$ref": "Country"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.countries.list":
-
-type CountriesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of countries.
-func (r *CountriesService) List(profileId int64) *CountriesListCall {
- c := &CountriesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CountriesListCall) Fields(s ...googleapi.Field) *CountriesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CountriesListCall) IfNoneMatch(entityTag string) *CountriesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CountriesListCall) Context(ctx context.Context) *CountriesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CountriesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/countries")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.countries.list" call.
-// Exactly one of *CountriesListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CountriesListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CountriesListCall) Do() (*CountriesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CountriesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of countries.",
- // "httpMethod": "GET",
- // "id": "dfareporting.countries.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/countries",
- // "response": {
- // "$ref": "CountriesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeAssets.insert":
-
-type CreativeAssetsInsertCall struct {
- s *Service
- profileId int64
- advertiserId int64
- creativeassetmetadata *CreativeAssetMetadata
- opt_ map[string]interface{}
- media_ io.Reader
- resumable_ googleapi.SizeReaderAt
- mediaType_ string
- protocol_ string
- ctx_ context.Context
-}
-
-// Insert: Inserts a new creative asset.
-func (r *CreativeAssetsService) Insert(profileId int64, advertiserId int64, creativeassetmetadata *CreativeAssetMetadata) *CreativeAssetsInsertCall {
- c := &CreativeAssetsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.advertiserId = advertiserId
- c.creativeassetmetadata = creativeassetmetadata
- return c
-}
-
-// Media specifies the media to upload in a single chunk.
-// At most one of Media and ResumableMedia may be set.
-func (c *CreativeAssetsInsertCall) Media(r io.Reader) *CreativeAssetsInsertCall {
- c.media_ = r
- c.protocol_ = "multipart"
- return c
-}
-
-// ResumableMedia specifies the media to upload in chunks and can be canceled with ctx.
-// At most one of Media and ResumableMedia may be set.
-// mediaType identifies the MIME media type of the upload, such as "image/png".
-// If mediaType is "", it will be auto-detected.
-// The provided ctx will supersede any context previously provided to
-// the Context method.
-func (c *CreativeAssetsInsertCall) ResumableMedia(ctx context.Context, r io.ReaderAt, size int64, mediaType string) *CreativeAssetsInsertCall {
- c.ctx_ = ctx
- c.resumable_ = io.NewSectionReader(r, 0, size)
- c.mediaType_ = mediaType
- c.protocol_ = "resumable"
- return c
-}
-
-// ProgressUpdater provides a callback function that will be called after every chunk.
-// It should be a low-latency function in order to not slow down the upload operation.
-// This should only be called when using ResumableMedia (as opposed to Media).
-func (c *CreativeAssetsInsertCall) ProgressUpdater(pu googleapi.ProgressUpdater) *CreativeAssetsInsertCall {
- c.opt_["progressUpdater"] = pu
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeAssetsInsertCall) Fields(s ...googleapi.Field) *CreativeAssetsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-// This context will supersede any context previously provided to
-// the ResumableMedia method.
-func (c *CreativeAssetsInsertCall) Context(ctx context.Context) *CreativeAssetsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeAssetsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creativeassetmetadata)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets")
- if c.media_ != nil || c.resumable_ != nil {
- urls = strings.Replace(urls, "https://www.googleapis.com/", "https://www.googleapis.com/upload/", 1)
- params.Set("uploadType", c.protocol_)
- }
- urls += "?" + params.Encode()
- if c.protocol_ != "resumable" {
- var cancel func()
- cancel, _ = googleapi.ConditionallyIncludeMedia(c.media_, &body, &ctype)
- if cancel != nil {
- defer cancel()
- }
- }
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "advertiserId": strconv.FormatInt(c.advertiserId, 10),
- })
- if c.protocol_ == "resumable" {
- if c.mediaType_ == "" {
- c.mediaType_ = googleapi.DetectMediaType(c.resumable_)
- }
- req.Header.Set("X-Upload-Content-Type", c.mediaType_)
- req.Header.Set("Content-Type", "application/json; charset=utf-8")
- } else {
- req.Header.Set("Content-Type", ctype)
- }
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeAssets.insert" call.
-// Exactly one of *CreativeAssetMetadata or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CreativeAssetMetadata.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeAssetsInsertCall) Do() (*CreativeAssetMetadata, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- var progressUpdater_ googleapi.ProgressUpdater
- if v, ok := c.opt_["progressUpdater"]; ok {
- if pu, ok := v.(googleapi.ProgressUpdater); ok {
- progressUpdater_ = pu
- }
- }
- if c.protocol_ == "resumable" {
- loc := res.Header.Get("Location")
- rx := &googleapi.ResumableUpload{
- Client: c.s.client,
- UserAgent: c.s.userAgent(),
- URI: loc,
- Media: c.resumable_,
- MediaType: c.mediaType_,
- ContentLength: c.resumable_.Size(),
- Callback: progressUpdater_,
- }
- res, err = rx.Upload(c.ctx_)
- if err != nil {
- return nil, err
- }
- defer res.Body.Close()
- }
- ret := &CreativeAssetMetadata{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new creative asset.",
- // "httpMethod": "POST",
- // "id": "dfareporting.creativeAssets.insert",
- // "mediaUpload": {
- // "accept": [
- // "*/*"
- // ],
- // "maxSize": "100MB",
- // "protocols": {
- // "resumable": {
- // "multipart": true,
- // "path": "/resumable/upload/dfareporting/v2.0/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets"
- // },
- // "simple": {
- // "multipart": true,
- // "path": "/upload/dfareporting/v2.0/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets"
- // }
- // }
- // },
- // "parameterOrder": [
- // "profileId",
- // "advertiserId"
- // ],
- // "parameters": {
- // "advertiserId": {
- // "description": "Advertiser ID of this creative. This is a required field.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets",
- // "request": {
- // "$ref": "CreativeAssetMetadata"
- // },
- // "response": {
- // "$ref": "CreativeAssetMetadata"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ],
- // "supportsMediaUpload": true
- // }
-
-}
-
-// method id "dfareporting.creativeFieldValues.delete":
-
-type CreativeFieldValuesDeleteCall struct {
- s *Service
- profileId int64
- creativeFieldId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an existing creative field value.
-func (r *CreativeFieldValuesService) Delete(profileId int64, creativeFieldId int64, id int64) *CreativeFieldValuesDeleteCall {
- c := &CreativeFieldValuesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.creativeFieldId = creativeFieldId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeFieldValuesDeleteCall) Fields(s ...googleapi.Field) *CreativeFieldValuesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeFieldValuesDeleteCall) Context(ctx context.Context) *CreativeFieldValuesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeFieldValuesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "creativeFieldId": strconv.FormatInt(c.creativeFieldId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeFieldValues.delete" call.
-func (c *CreativeFieldValuesDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes an existing creative field value.",
- // "httpMethod": "DELETE",
- // "id": "dfareporting.creativeFieldValues.delete",
- // "parameterOrder": [
- // "profileId",
- // "creativeFieldId",
- // "id"
- // ],
- // "parameters": {
- // "creativeFieldId": {
- // "description": "Creative field ID for this creative field value.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "id": {
- // "description": "Creative Field Value ID",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeFieldValues.get":
-
-type CreativeFieldValuesGetCall struct {
- s *Service
- profileId int64
- creativeFieldId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one creative field value by ID.
-func (r *CreativeFieldValuesService) Get(profileId int64, creativeFieldId int64, id int64) *CreativeFieldValuesGetCall {
- c := &CreativeFieldValuesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.creativeFieldId = creativeFieldId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeFieldValuesGetCall) Fields(s ...googleapi.Field) *CreativeFieldValuesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CreativeFieldValuesGetCall) IfNoneMatch(entityTag string) *CreativeFieldValuesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeFieldValuesGetCall) Context(ctx context.Context) *CreativeFieldValuesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeFieldValuesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "creativeFieldId": strconv.FormatInt(c.creativeFieldId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeFieldValues.get" call.
-// Exactly one of *CreativeFieldValue or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CreativeFieldValue.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeFieldValuesGetCall) Do() (*CreativeFieldValue, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeFieldValue{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one creative field value by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.creativeFieldValues.get",
- // "parameterOrder": [
- // "profileId",
- // "creativeFieldId",
- // "id"
- // ],
- // "parameters": {
- // "creativeFieldId": {
- // "description": "Creative field ID for this creative field value.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "id": {
- // "description": "Creative Field Value ID",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
- // "response": {
- // "$ref": "CreativeFieldValue"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeFieldValues.insert":
-
-type CreativeFieldValuesInsertCall struct {
- s *Service
- profileId int64
- creativeFieldId int64
- creativefieldvalue *CreativeFieldValue
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new creative field value.
-func (r *CreativeFieldValuesService) Insert(profileId int64, creativeFieldId int64, creativefieldvalue *CreativeFieldValue) *CreativeFieldValuesInsertCall {
- c := &CreativeFieldValuesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.creativeFieldId = creativeFieldId
- c.creativefieldvalue = creativefieldvalue
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeFieldValuesInsertCall) Fields(s ...googleapi.Field) *CreativeFieldValuesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeFieldValuesInsertCall) Context(ctx context.Context) *CreativeFieldValuesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeFieldValuesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creativefieldvalue)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "creativeFieldId": strconv.FormatInt(c.creativeFieldId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeFieldValues.insert" call.
-// Exactly one of *CreativeFieldValue or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CreativeFieldValue.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeFieldValuesInsertCall) Do() (*CreativeFieldValue, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeFieldValue{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new creative field value.",
- // "httpMethod": "POST",
- // "id": "dfareporting.creativeFieldValues.insert",
- // "parameterOrder": [
- // "profileId",
- // "creativeFieldId"
- // ],
- // "parameters": {
- // "creativeFieldId": {
- // "description": "Creative field ID for this creative field value.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- // "request": {
- // "$ref": "CreativeFieldValue"
- // },
- // "response": {
- // "$ref": "CreativeFieldValue"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeFieldValues.list":
-
-type CreativeFieldValuesListCall struct {
- s *Service
- profileId int64
- creativeFieldId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of creative field values, possibly filtered.
-func (r *CreativeFieldValuesService) List(profileId int64, creativeFieldId int64) *CreativeFieldValuesListCall {
- c := &CreativeFieldValuesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.creativeFieldId = creativeFieldId
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only creative field
-// values with these IDs.
-func (c *CreativeFieldValuesListCall) Ids(ids int64) *CreativeFieldValuesListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *CreativeFieldValuesListCall) MaxResults(maxResults int64) *CreativeFieldValuesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *CreativeFieldValuesListCall) PageToken(pageToken string) *CreativeFieldValuesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for creative field values by their values. Wildcards (e.g.
-// *) are not allowed.
-func (c *CreativeFieldValuesListCall) SearchString(searchString string) *CreativeFieldValuesListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "VALUE"
-func (c *CreativeFieldValuesListCall) SortField(sortField string) *CreativeFieldValuesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *CreativeFieldValuesListCall) SortOrder(sortOrder string) *CreativeFieldValuesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeFieldValuesListCall) Fields(s ...googleapi.Field) *CreativeFieldValuesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CreativeFieldValuesListCall) IfNoneMatch(entityTag string) *CreativeFieldValuesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeFieldValuesListCall) Context(ctx context.Context) *CreativeFieldValuesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeFieldValuesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "creativeFieldId": strconv.FormatInt(c.creativeFieldId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeFieldValues.list" call.
-// Exactly one of *CreativeFieldValuesListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *CreativeFieldValuesListResponse.ServerResponse.Header or (if
-// a response was returned at all) in error.(*googleapi.Error).Header.
-// Use googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeFieldValuesListCall) Do() (*CreativeFieldValuesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeFieldValuesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of creative field values, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.creativeFieldValues.list",
- // "parameterOrder": [
- // "profileId",
- // "creativeFieldId"
- // ],
- // "parameters": {
- // "creativeFieldId": {
- // "description": "Creative field ID for this creative field value.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only creative field values with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "VALUE"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- // "response": {
- // "$ref": "CreativeFieldValuesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeFieldValues.patch":
-
-type CreativeFieldValuesPatchCall struct {
- s *Service
- profileId int64
- creativeFieldId int64
- id int64
- creativefieldvalue *CreativeFieldValue
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing creative field value. This method supports
-// patch semantics.
-func (r *CreativeFieldValuesService) Patch(profileId int64, creativeFieldId int64, id int64, creativefieldvalue *CreativeFieldValue) *CreativeFieldValuesPatchCall {
- c := &CreativeFieldValuesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.creativeFieldId = creativeFieldId
- c.id = id
- c.creativefieldvalue = creativefieldvalue
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeFieldValuesPatchCall) Fields(s ...googleapi.Field) *CreativeFieldValuesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeFieldValuesPatchCall) Context(ctx context.Context) *CreativeFieldValuesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeFieldValuesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creativefieldvalue)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "creativeFieldId": strconv.FormatInt(c.creativeFieldId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeFieldValues.patch" call.
-// Exactly one of *CreativeFieldValue or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CreativeFieldValue.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeFieldValuesPatchCall) Do() (*CreativeFieldValue, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeFieldValue{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing creative field value. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.creativeFieldValues.patch",
- // "parameterOrder": [
- // "profileId",
- // "creativeFieldId",
- // "id"
- // ],
- // "parameters": {
- // "creativeFieldId": {
- // "description": "Creative field ID for this creative field value.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "id": {
- // "description": "Creative Field Value ID",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- // "request": {
- // "$ref": "CreativeFieldValue"
- // },
- // "response": {
- // "$ref": "CreativeFieldValue"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeFieldValues.update":
-
-type CreativeFieldValuesUpdateCall struct {
- s *Service
- profileId int64
- creativeFieldId int64
- creativefieldvalue *CreativeFieldValue
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing creative field value.
-func (r *CreativeFieldValuesService) Update(profileId int64, creativeFieldId int64, creativefieldvalue *CreativeFieldValue) *CreativeFieldValuesUpdateCall {
- c := &CreativeFieldValuesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.creativeFieldId = creativeFieldId
- c.creativefieldvalue = creativefieldvalue
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeFieldValuesUpdateCall) Fields(s ...googleapi.Field) *CreativeFieldValuesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeFieldValuesUpdateCall) Context(ctx context.Context) *CreativeFieldValuesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeFieldValuesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creativefieldvalue)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "creativeFieldId": strconv.FormatInt(c.creativeFieldId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeFieldValues.update" call.
-// Exactly one of *CreativeFieldValue or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CreativeFieldValue.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeFieldValuesUpdateCall) Do() (*CreativeFieldValue, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeFieldValue{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing creative field value.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.creativeFieldValues.update",
- // "parameterOrder": [
- // "profileId",
- // "creativeFieldId"
- // ],
- // "parameters": {
- // "creativeFieldId": {
- // "description": "Creative field ID for this creative field value.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- // "request": {
- // "$ref": "CreativeFieldValue"
- // },
- // "response": {
- // "$ref": "CreativeFieldValue"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeFields.delete":
-
-type CreativeFieldsDeleteCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an existing creative field.
-func (r *CreativeFieldsService) Delete(profileId int64, id int64) *CreativeFieldsDeleteCall {
- c := &CreativeFieldsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeFieldsDeleteCall) Fields(s ...googleapi.Field) *CreativeFieldsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeFieldsDeleteCall) Context(ctx context.Context) *CreativeFieldsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeFieldsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeFields/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeFields.delete" call.
-func (c *CreativeFieldsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes an existing creative field.",
- // "httpMethod": "DELETE",
- // "id": "dfareporting.creativeFields.delete",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Creative Field ID",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeFields/{id}",
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeFields.get":
-
-type CreativeFieldsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one creative field by ID.
-func (r *CreativeFieldsService) Get(profileId int64, id int64) *CreativeFieldsGetCall {
- c := &CreativeFieldsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeFieldsGetCall) Fields(s ...googleapi.Field) *CreativeFieldsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CreativeFieldsGetCall) IfNoneMatch(entityTag string) *CreativeFieldsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeFieldsGetCall) Context(ctx context.Context) *CreativeFieldsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeFieldsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeFields/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeFields.get" call.
-// Exactly one of *CreativeField or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CreativeField.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeFieldsGetCall) Do() (*CreativeField, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeField{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one creative field by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.creativeFields.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Creative Field ID",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeFields/{id}",
- // "response": {
- // "$ref": "CreativeField"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeFields.insert":
-
-type CreativeFieldsInsertCall struct {
- s *Service
- profileId int64
- creativefield *CreativeField
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new creative field.
-func (r *CreativeFieldsService) Insert(profileId int64, creativefield *CreativeField) *CreativeFieldsInsertCall {
- c := &CreativeFieldsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.creativefield = creativefield
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeFieldsInsertCall) Fields(s ...googleapi.Field) *CreativeFieldsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeFieldsInsertCall) Context(ctx context.Context) *CreativeFieldsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeFieldsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creativefield)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeFields")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeFields.insert" call.
-// Exactly one of *CreativeField or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CreativeField.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeFieldsInsertCall) Do() (*CreativeField, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeField{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new creative field.",
- // "httpMethod": "POST",
- // "id": "dfareporting.creativeFields.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeFields",
- // "request": {
- // "$ref": "CreativeField"
- // },
- // "response": {
- // "$ref": "CreativeField"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeFields.list":
-
-type CreativeFieldsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of creative fields, possibly filtered.
-func (r *CreativeFieldsService) List(profileId int64) *CreativeFieldsListCall {
- c := &CreativeFieldsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// AdvertiserIds sets the optional parameter "advertiserIds": Select
-// only creative fields that belong to these advertisers.
-func (c *CreativeFieldsListCall) AdvertiserIds(advertiserIds int64) *CreativeFieldsListCall {
- c.opt_["advertiserIds"] = advertiserIds
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only creative fields
-// with these IDs.
-func (c *CreativeFieldsListCall) Ids(ids int64) *CreativeFieldsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *CreativeFieldsListCall) MaxResults(maxResults int64) *CreativeFieldsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *CreativeFieldsListCall) PageToken(pageToken string) *CreativeFieldsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for creative fields by name or ID. Wildcards (*) are
-// allowed. For example, "creativefield*2015" will return creative
-// fields with names like "creativefield June 2015", "creativefield
-// April 2015", or simply "creativefield 2015". Most of the searches
-// also add wild-cards implicitly at the start and the end of the search
-// string. For example, a search string of "creativefield" will match
-// creative fields with the name "my creativefield", "creativefield
-// 2015", or simply "creativefield".
-func (c *CreativeFieldsListCall) SearchString(searchString string) *CreativeFieldsListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *CreativeFieldsListCall) SortField(sortField string) *CreativeFieldsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *CreativeFieldsListCall) SortOrder(sortOrder string) *CreativeFieldsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeFieldsListCall) Fields(s ...googleapi.Field) *CreativeFieldsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CreativeFieldsListCall) IfNoneMatch(entityTag string) *CreativeFieldsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeFieldsListCall) Context(ctx context.Context) *CreativeFieldsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeFieldsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["advertiserIds"]; ok {
- params.Set("advertiserIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeFields")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeFields.list" call.
-// Exactly one of *CreativeFieldsListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *CreativeFieldsListResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeFieldsListCall) Do() (*CreativeFieldsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeFieldsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of creative fields, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.creativeFields.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "advertiserIds": {
- // "description": "Select only creative fields that belong to these advertisers.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only creative fields with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, \"creativefield*2015\" will return creative fields with names like \"creativefield June 2015\", \"creativefield April 2015\", or simply \"creativefield 2015\". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of \"creativefield\" will match creative fields with the name \"my creativefield\", \"creativefield 2015\", or simply \"creativefield\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeFields",
- // "response": {
- // "$ref": "CreativeFieldsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeFields.patch":
-
-type CreativeFieldsPatchCall struct {
- s *Service
- profileId int64
- id int64
- creativefield *CreativeField
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing creative field. This method supports patch
-// semantics.
-func (r *CreativeFieldsService) Patch(profileId int64, id int64, creativefield *CreativeField) *CreativeFieldsPatchCall {
- c := &CreativeFieldsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.creativefield = creativefield
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeFieldsPatchCall) Fields(s ...googleapi.Field) *CreativeFieldsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeFieldsPatchCall) Context(ctx context.Context) *CreativeFieldsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeFieldsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creativefield)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeFields")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeFields.patch" call.
-// Exactly one of *CreativeField or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CreativeField.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeFieldsPatchCall) Do() (*CreativeField, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeField{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing creative field. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.creativeFields.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Creative Field ID",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeFields",
- // "request": {
- // "$ref": "CreativeField"
- // },
- // "response": {
- // "$ref": "CreativeField"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeFields.update":
-
-type CreativeFieldsUpdateCall struct {
- s *Service
- profileId int64
- creativefield *CreativeField
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing creative field.
-func (r *CreativeFieldsService) Update(profileId int64, creativefield *CreativeField) *CreativeFieldsUpdateCall {
- c := &CreativeFieldsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.creativefield = creativefield
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeFieldsUpdateCall) Fields(s ...googleapi.Field) *CreativeFieldsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeFieldsUpdateCall) Context(ctx context.Context) *CreativeFieldsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeFieldsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creativefield)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeFields")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeFields.update" call.
-// Exactly one of *CreativeField or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CreativeField.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeFieldsUpdateCall) Do() (*CreativeField, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeField{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing creative field.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.creativeFields.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeFields",
- // "request": {
- // "$ref": "CreativeField"
- // },
- // "response": {
- // "$ref": "CreativeField"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeGroups.get":
-
-type CreativeGroupsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one creative group by ID.
-func (r *CreativeGroupsService) Get(profileId int64, id int64) *CreativeGroupsGetCall {
- c := &CreativeGroupsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeGroupsGetCall) Fields(s ...googleapi.Field) *CreativeGroupsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CreativeGroupsGetCall) IfNoneMatch(entityTag string) *CreativeGroupsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeGroupsGetCall) Context(ctx context.Context) *CreativeGroupsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeGroupsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeGroups/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeGroups.get" call.
-// Exactly one of *CreativeGroup or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CreativeGroup.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeGroupsGetCall) Do() (*CreativeGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one creative group by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.creativeGroups.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Creative group ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeGroups/{id}",
- // "response": {
- // "$ref": "CreativeGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeGroups.insert":
-
-type CreativeGroupsInsertCall struct {
- s *Service
- profileId int64
- creativegroup *CreativeGroup
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new creative group.
-func (r *CreativeGroupsService) Insert(profileId int64, creativegroup *CreativeGroup) *CreativeGroupsInsertCall {
- c := &CreativeGroupsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.creativegroup = creativegroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeGroupsInsertCall) Fields(s ...googleapi.Field) *CreativeGroupsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeGroupsInsertCall) Context(ctx context.Context) *CreativeGroupsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeGroupsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creativegroup)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeGroups.insert" call.
-// Exactly one of *CreativeGroup or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CreativeGroup.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeGroupsInsertCall) Do() (*CreativeGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new creative group.",
- // "httpMethod": "POST",
- // "id": "dfareporting.creativeGroups.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeGroups",
- // "request": {
- // "$ref": "CreativeGroup"
- // },
- // "response": {
- // "$ref": "CreativeGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeGroups.list":
-
-type CreativeGroupsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of creative groups, possibly filtered.
-func (r *CreativeGroupsService) List(profileId int64) *CreativeGroupsListCall {
- c := &CreativeGroupsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// AdvertiserIds sets the optional parameter "advertiserIds": Select
-// only creative groups that belong to these advertisers.
-func (c *CreativeGroupsListCall) AdvertiserIds(advertiserIds int64) *CreativeGroupsListCall {
- c.opt_["advertiserIds"] = advertiserIds
- return c
-}
-
-// GroupNumber sets the optional parameter "groupNumber": Select only
-// creative groups that belong to this subgroup.
-func (c *CreativeGroupsListCall) GroupNumber(groupNumber int64) *CreativeGroupsListCall {
- c.opt_["groupNumber"] = groupNumber
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only creative groups
-// with these IDs.
-func (c *CreativeGroupsListCall) Ids(ids int64) *CreativeGroupsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *CreativeGroupsListCall) MaxResults(maxResults int64) *CreativeGroupsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *CreativeGroupsListCall) PageToken(pageToken string) *CreativeGroupsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for creative groups by name or ID. Wildcards (*) are
-// allowed. For example, "creativegroup*2015" will return creative
-// groups with names like "creativegroup June 2015", "creativegroup
-// April 2015", or simply "creativegroup 2015". Most of the searches
-// also add wild-cards implicitly at the start and the end of the search
-// string. For example, a search string of "creativegroup" will match
-// creative groups with the name "my creativegroup", "creativegroup
-// 2015", or simply "creativegroup".
-func (c *CreativeGroupsListCall) SearchString(searchString string) *CreativeGroupsListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *CreativeGroupsListCall) SortField(sortField string) *CreativeGroupsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *CreativeGroupsListCall) SortOrder(sortOrder string) *CreativeGroupsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeGroupsListCall) Fields(s ...googleapi.Field) *CreativeGroupsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CreativeGroupsListCall) IfNoneMatch(entityTag string) *CreativeGroupsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeGroupsListCall) Context(ctx context.Context) *CreativeGroupsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeGroupsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["advertiserIds"]; ok {
- params.Set("advertiserIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["groupNumber"]; ok {
- params.Set("groupNumber", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeGroups.list" call.
-// Exactly one of *CreativeGroupsListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *CreativeGroupsListResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeGroupsListCall) Do() (*CreativeGroupsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeGroupsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of creative groups, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.creativeGroups.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "advertiserIds": {
- // "description": "Select only creative groups that belong to these advertisers.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "groupNumber": {
- // "description": "Select only creative groups that belong to this subgroup.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "ids": {
- // "description": "Select only creative groups with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, \"creativegroup*2015\" will return creative groups with names like \"creativegroup June 2015\", \"creativegroup April 2015\", or simply \"creativegroup 2015\". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of \"creativegroup\" will match creative groups with the name \"my creativegroup\", \"creativegroup 2015\", or simply \"creativegroup\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeGroups",
- // "response": {
- // "$ref": "CreativeGroupsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeGroups.patch":
-
-type CreativeGroupsPatchCall struct {
- s *Service
- profileId int64
- id int64
- creativegroup *CreativeGroup
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing creative group. This method supports patch
-// semantics.
-func (r *CreativeGroupsService) Patch(profileId int64, id int64, creativegroup *CreativeGroup) *CreativeGroupsPatchCall {
- c := &CreativeGroupsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.creativegroup = creativegroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeGroupsPatchCall) Fields(s ...googleapi.Field) *CreativeGroupsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeGroupsPatchCall) Context(ctx context.Context) *CreativeGroupsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeGroupsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creativegroup)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeGroups.patch" call.
-// Exactly one of *CreativeGroup or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CreativeGroup.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeGroupsPatchCall) Do() (*CreativeGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing creative group. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.creativeGroups.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Creative group ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeGroups",
- // "request": {
- // "$ref": "CreativeGroup"
- // },
- // "response": {
- // "$ref": "CreativeGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeGroups.update":
-
-type CreativeGroupsUpdateCall struct {
- s *Service
- profileId int64
- creativegroup *CreativeGroup
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing creative group.
-func (r *CreativeGroupsService) Update(profileId int64, creativegroup *CreativeGroup) *CreativeGroupsUpdateCall {
- c := &CreativeGroupsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.creativegroup = creativegroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeGroupsUpdateCall) Fields(s ...googleapi.Field) *CreativeGroupsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeGroupsUpdateCall) Context(ctx context.Context) *CreativeGroupsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeGroupsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creativegroup)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeGroups.update" call.
-// Exactly one of *CreativeGroup or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CreativeGroup.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeGroupsUpdateCall) Do() (*CreativeGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing creative group.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.creativeGroups.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeGroups",
- // "request": {
- // "$ref": "CreativeGroup"
- // },
- // "response": {
- // "$ref": "CreativeGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creatives.get":
-
-type CreativesGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one creative by ID.
-func (r *CreativesService) Get(profileId int64, id int64) *CreativesGetCall {
- c := &CreativesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativesGetCall) Fields(s ...googleapi.Field) *CreativesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CreativesGetCall) IfNoneMatch(entityTag string) *CreativesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativesGetCall) Context(ctx context.Context) *CreativesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creatives/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creatives.get" call.
-// Exactly one of *Creative or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Creative.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CreativesGetCall) Do() (*Creative, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Creative{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one creative by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.creatives.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Creative ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creatives/{id}",
- // "response": {
- // "$ref": "Creative"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creatives.insert":
-
-type CreativesInsertCall struct {
- s *Service
- profileId int64
- creative *Creative
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new creative.
-func (r *CreativesService) Insert(profileId int64, creative *Creative) *CreativesInsertCall {
- c := &CreativesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.creative = creative
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativesInsertCall) Fields(s ...googleapi.Field) *CreativesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativesInsertCall) Context(ctx context.Context) *CreativesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creative)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creatives")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creatives.insert" call.
-// Exactly one of *Creative or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Creative.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CreativesInsertCall) Do() (*Creative, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Creative{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new creative.",
- // "httpMethod": "POST",
- // "id": "dfareporting.creatives.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creatives",
- // "request": {
- // "$ref": "Creative"
- // },
- // "response": {
- // "$ref": "Creative"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creatives.list":
-
-type CreativesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of creatives, possibly filtered.
-func (r *CreativesService) List(profileId int64) *CreativesListCall {
- c := &CreativesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Active sets the optional parameter "active": Select only active
-// creatives. Leave blank to select active and inactive creatives.
-func (c *CreativesListCall) Active(active bool) *CreativesListCall {
- c.opt_["active"] = active
- return c
-}
-
-// AdvertiserId sets the optional parameter "advertiserId": Select only
-// creatives with this advertiser ID.
-func (c *CreativesListCall) AdvertiserId(advertiserId int64) *CreativesListCall {
- c.opt_["advertiserId"] = advertiserId
- return c
-}
-
-// Archived sets the optional parameter "archived": Select only archived
-// creatives. Leave blank to select archived and unarchived creatives.
-func (c *CreativesListCall) Archived(archived bool) *CreativesListCall {
- c.opt_["archived"] = archived
- return c
-}
-
-// CampaignId sets the optional parameter "campaignId": Select only
-// creatives with this campaign ID.
-func (c *CreativesListCall) CampaignId(campaignId int64) *CreativesListCall {
- c.opt_["campaignId"] = campaignId
- return c
-}
-
-// CompanionCreativeIds sets the optional parameter
-// "companionCreativeIds": Select only in-stream video creatives with
-// these companion IDs.
-func (c *CreativesListCall) CompanionCreativeIds(companionCreativeIds int64) *CreativesListCall {
- c.opt_["companionCreativeIds"] = companionCreativeIds
- return c
-}
-
-// CreativeFieldIds sets the optional parameter "creativeFieldIds":
-// Select only creatives with these creative field IDs.
-func (c *CreativesListCall) CreativeFieldIds(creativeFieldIds int64) *CreativesListCall {
- c.opt_["creativeFieldIds"] = creativeFieldIds
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only creatives with
-// these IDs.
-func (c *CreativesListCall) Ids(ids int64) *CreativesListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *CreativesListCall) MaxResults(maxResults int64) *CreativesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *CreativesListCall) PageToken(pageToken string) *CreativesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// RenderingIds sets the optional parameter "renderingIds": Select only
-// creatives with these rendering IDs.
-func (c *CreativesListCall) RenderingIds(renderingIds int64) *CreativesListCall {
- c.opt_["renderingIds"] = renderingIds
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name or ID. Wildcards (*) are allowed. For
-// example, "creative*2015" will return objects with names like
-// "creative June 2015", "creative April 2015", or simply "creative
-// 2015". Most of the searches also add wildcards implicitly at the
-// start and the end of the search string. For example, a search string
-// of "creative" will match objects with name "my creative", "creative
-// 2015", or simply "creative".
-func (c *CreativesListCall) SearchString(searchString string) *CreativesListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SizeIds sets the optional parameter "sizeIds": Select only creatives
-// with these size IDs.
-func (c *CreativesListCall) SizeIds(sizeIds int64) *CreativesListCall {
- c.opt_["sizeIds"] = sizeIds
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *CreativesListCall) SortField(sortField string) *CreativesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *CreativesListCall) SortOrder(sortOrder string) *CreativesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// StudioCreativeId sets the optional parameter "studioCreativeId":
-// Select only creatives corresponding to this Studio creative ID.
-func (c *CreativesListCall) StudioCreativeId(studioCreativeId int64) *CreativesListCall {
- c.opt_["studioCreativeId"] = studioCreativeId
- return c
-}
-
-// Types sets the optional parameter "types": Select only creatives with
-// these creative types.
-//
-// Possible values:
-// "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO"
-// "CUSTOM_INPAGE"
-// "CUSTOM_INTERSTITIAL"
-// "ENHANCED_BANNER"
-// "ENHANCED_IMAGE"
-// "FLASH_INPAGE"
-// "HTML5_BANNER"
-// "IMAGE"
-// "INSTREAM_VIDEO"
-// "INTERNAL_REDIRECT"
-// "INTERSTITIAL_INTERNAL_REDIRECT"
-// "REDIRECT"
-// "RICH_MEDIA_EXPANDING"
-// "RICH_MEDIA_IM_EXPAND"
-// "RICH_MEDIA_INPAGE"
-// "RICH_MEDIA_INPAGE_FLOATING"
-// "RICH_MEDIA_INTERSTITIAL_FLOAT"
-// "RICH_MEDIA_MOBILE_IN_APP"
-// "RICH_MEDIA_MULTI_FLOATING"
-// "RICH_MEDIA_PEEL_DOWN"
-// "TRACKING_TEXT"
-// "VAST_REDIRECT"
-// "VPAID_LINEAR"
-// "VPAID_NON_LINEAR"
-func (c *CreativesListCall) Types(types string) *CreativesListCall {
- c.opt_["types"] = types
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativesListCall) Fields(s ...googleapi.Field) *CreativesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CreativesListCall) IfNoneMatch(entityTag string) *CreativesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativesListCall) Context(ctx context.Context) *CreativesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["active"]; ok {
- params.Set("active", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["advertiserId"]; ok {
- params.Set("advertiserId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["archived"]; ok {
- params.Set("archived", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["campaignId"]; ok {
- params.Set("campaignId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["companionCreativeIds"]; ok {
- params.Set("companionCreativeIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["creativeFieldIds"]; ok {
- params.Set("creativeFieldIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["renderingIds"]; ok {
- params.Set("renderingIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sizeIds"]; ok {
- params.Set("sizeIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["studioCreativeId"]; ok {
- params.Set("studioCreativeId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["types"]; ok {
- params.Set("types", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creatives")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creatives.list" call.
-// Exactly one of *CreativesListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CreativesListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativesListCall) Do() (*CreativesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of creatives, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.creatives.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "active": {
- // "description": "Select only active creatives. Leave blank to select active and inactive creatives.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "advertiserId": {
- // "description": "Select only creatives with this advertiser ID.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "archived": {
- // "description": "Select only archived creatives. Leave blank to select archived and unarchived creatives.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "campaignId": {
- // "description": "Select only creatives with this campaign ID.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "companionCreativeIds": {
- // "description": "Select only in-stream video creatives with these companion IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "creativeFieldIds": {
- // "description": "Select only creatives with these creative field IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only creatives with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "renderingIds": {
- // "description": "Select only creatives with these rendering IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"creative*2015\" will return objects with names like \"creative June 2015\", \"creative April 2015\", or simply \"creative 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"creative\" will match objects with name \"my creative\", \"creative 2015\", or simply \"creative\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sizeIds": {
- // "description": "Select only creatives with these size IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "studioCreativeId": {
- // "description": "Select only creatives corresponding to this Studio creative ID.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "types": {
- // "description": "Select only creatives with these creative types.",
- // "enum": [
- // "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO",
- // "CUSTOM_INPAGE",
- // "CUSTOM_INTERSTITIAL",
- // "ENHANCED_BANNER",
- // "ENHANCED_IMAGE",
- // "FLASH_INPAGE",
- // "HTML5_BANNER",
- // "IMAGE",
- // "INSTREAM_VIDEO",
- // "INTERNAL_REDIRECT",
- // "INTERSTITIAL_INTERNAL_REDIRECT",
- // "REDIRECT",
- // "RICH_MEDIA_EXPANDING",
- // "RICH_MEDIA_IM_EXPAND",
- // "RICH_MEDIA_INPAGE",
- // "RICH_MEDIA_INPAGE_FLOATING",
- // "RICH_MEDIA_INTERSTITIAL_FLOAT",
- // "RICH_MEDIA_MOBILE_IN_APP",
- // "RICH_MEDIA_MULTI_FLOATING",
- // "RICH_MEDIA_PEEL_DOWN",
- // "TRACKING_TEXT",
- // "VAST_REDIRECT",
- // "VPAID_LINEAR",
- // "VPAID_NON_LINEAR"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creatives",
- // "response": {
- // "$ref": "CreativesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creatives.patch":
-
-type CreativesPatchCall struct {
- s *Service
- profileId int64
- id int64
- creative *Creative
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing creative. This method supports patch
-// semantics.
-func (r *CreativesService) Patch(profileId int64, id int64, creative *Creative) *CreativesPatchCall {
- c := &CreativesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.creative = creative
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativesPatchCall) Fields(s ...googleapi.Field) *CreativesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativesPatchCall) Context(ctx context.Context) *CreativesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creative)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creatives")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creatives.patch" call.
-// Exactly one of *Creative or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Creative.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CreativesPatchCall) Do() (*Creative, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Creative{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing creative. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.creatives.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Creative ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creatives",
- // "request": {
- // "$ref": "Creative"
- // },
- // "response": {
- // "$ref": "Creative"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creatives.update":
-
-type CreativesUpdateCall struct {
- s *Service
- profileId int64
- creative *Creative
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing creative.
-func (r *CreativesService) Update(profileId int64, creative *Creative) *CreativesUpdateCall {
- c := &CreativesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.creative = creative
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativesUpdateCall) Fields(s ...googleapi.Field) *CreativesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativesUpdateCall) Context(ctx context.Context) *CreativesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creative)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creatives")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creatives.update" call.
-// Exactly one of *Creative or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Creative.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CreativesUpdateCall) Do() (*Creative, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Creative{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing creative.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.creatives.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creatives",
- // "request": {
- // "$ref": "Creative"
- // },
- // "response": {
- // "$ref": "Creative"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.dimensionValues.query":
-
-type DimensionValuesQueryCall struct {
- s *Service
- profileId int64
- dimensionvaluerequest *DimensionValueRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Query: Retrieves list of report dimension values for a list of
-// filters.
-func (r *DimensionValuesService) Query(profileId int64, dimensionvaluerequest *DimensionValueRequest) *DimensionValuesQueryCall {
- c := &DimensionValuesQueryCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.dimensionvaluerequest = dimensionvaluerequest
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *DimensionValuesQueryCall) MaxResults(maxResults int64) *DimensionValuesQueryCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous result page.
-func (c *DimensionValuesQueryCall) PageToken(pageToken string) *DimensionValuesQueryCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DimensionValuesQueryCall) Fields(s ...googleapi.Field) *DimensionValuesQueryCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DimensionValuesQueryCall) Context(ctx context.Context) *DimensionValuesQueryCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DimensionValuesQueryCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.dimensionvaluerequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/dimensionvalues/query")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.dimensionValues.query" call.
-// Exactly one of *DimensionValueList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *DimensionValueList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DimensionValuesQueryCall) Do() (*DimensionValueList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DimensionValueList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves list of report dimension values for a list of filters.",
- // "httpMethod": "POST",
- // "id": "dfareporting.dimensionValues.query",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "100",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/dimensionvalues/query",
- // "request": {
- // "$ref": "DimensionValueRequest"
- // },
- // "response": {
- // "$ref": "DimensionValueList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.directorySiteContacts.get":
-
-type DirectorySiteContactsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one directory site contact by ID.
-func (r *DirectorySiteContactsService) Get(profileId int64, id int64) *DirectorySiteContactsGetCall {
- c := &DirectorySiteContactsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DirectorySiteContactsGetCall) Fields(s ...googleapi.Field) *DirectorySiteContactsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DirectorySiteContactsGetCall) IfNoneMatch(entityTag string) *DirectorySiteContactsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DirectorySiteContactsGetCall) Context(ctx context.Context) *DirectorySiteContactsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DirectorySiteContactsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/directorySiteContacts/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.directorySiteContacts.get" call.
-// Exactly one of *DirectorySiteContact or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *DirectorySiteContact.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DirectorySiteContactsGetCall) Do() (*DirectorySiteContact, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DirectorySiteContact{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one directory site contact by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.directorySiteContacts.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Directory site contact ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/directorySiteContacts/{id}",
- // "response": {
- // "$ref": "DirectorySiteContact"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.directorySiteContacts.list":
-
-type DirectorySiteContactsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of directory site contacts, possibly filtered.
-func (r *DirectorySiteContactsService) List(profileId int64) *DirectorySiteContactsListCall {
- c := &DirectorySiteContactsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// DirectorySiteIds sets the optional parameter "directorySiteIds":
-// Select only directory site contacts with these directory site IDs.
-// This is a required field.
-func (c *DirectorySiteContactsListCall) DirectorySiteIds(directorySiteIds int64) *DirectorySiteContactsListCall {
- c.opt_["directorySiteIds"] = directorySiteIds
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only directory site
-// contacts with these IDs.
-func (c *DirectorySiteContactsListCall) Ids(ids int64) *DirectorySiteContactsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *DirectorySiteContactsListCall) MaxResults(maxResults int64) *DirectorySiteContactsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *DirectorySiteContactsListCall) PageToken(pageToken string) *DirectorySiteContactsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name, ID or email. Wildcards (*) are
-// allowed. For example, "directory site contact*2015" will return
-// objects with names like "directory site contact June 2015",
-// "directory site contact April 2015", or simply "directory site
-// contact 2015". Most of the searches also add wildcards implicitly at
-// the start and the end of the search string. For example, a search
-// string of "directory site contact" will match objects with name "my
-// directory site contact", "directory site contact 2015", or simply
-// "directory site contact".
-func (c *DirectorySiteContactsListCall) SearchString(searchString string) *DirectorySiteContactsListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *DirectorySiteContactsListCall) SortField(sortField string) *DirectorySiteContactsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *DirectorySiteContactsListCall) SortOrder(sortOrder string) *DirectorySiteContactsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DirectorySiteContactsListCall) Fields(s ...googleapi.Field) *DirectorySiteContactsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DirectorySiteContactsListCall) IfNoneMatch(entityTag string) *DirectorySiteContactsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DirectorySiteContactsListCall) Context(ctx context.Context) *DirectorySiteContactsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DirectorySiteContactsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["directorySiteIds"]; ok {
- params.Set("directorySiteIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/directorySiteContacts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.directorySiteContacts.list" call.
-// Exactly one of *DirectorySiteContactsListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *DirectorySiteContactsListResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *DirectorySiteContactsListCall) Do() (*DirectorySiteContactsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DirectorySiteContactsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of directory site contacts, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.directorySiteContacts.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "directorySiteIds": {
- // "description": "Select only directory site contacts with these directory site IDs. This is a required field.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only directory site contacts with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, \"directory site contact*2015\" will return objects with names like \"directory site contact June 2015\", \"directory site contact April 2015\", or simply \"directory site contact 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"directory site contact\" will match objects with name \"my directory site contact\", \"directory site contact 2015\", or simply \"directory site contact\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/directorySiteContacts",
- // "response": {
- // "$ref": "DirectorySiteContactsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.directorySites.get":
-
-type DirectorySitesGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one directory site by ID.
-func (r *DirectorySitesService) Get(profileId int64, id int64) *DirectorySitesGetCall {
- c := &DirectorySitesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DirectorySitesGetCall) Fields(s ...googleapi.Field) *DirectorySitesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DirectorySitesGetCall) IfNoneMatch(entityTag string) *DirectorySitesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DirectorySitesGetCall) Context(ctx context.Context) *DirectorySitesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DirectorySitesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/directorySites/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.directorySites.get" call.
-// Exactly one of *DirectorySite or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *DirectorySite.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DirectorySitesGetCall) Do() (*DirectorySite, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DirectorySite{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one directory site by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.directorySites.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Directory site ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/directorySites/{id}",
- // "response": {
- // "$ref": "DirectorySite"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.directorySites.list":
-
-type DirectorySitesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of directory sites, possibly filtered.
-func (r *DirectorySitesService) List(profileId int64) *DirectorySitesListCall {
- c := &DirectorySitesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// AcceptsInStreamVideoPlacements sets the optional parameter
-// "acceptsInStreamVideoPlacements": This search filter is no longer
-// supported and will have no effect on the results returned.
-func (c *DirectorySitesListCall) AcceptsInStreamVideoPlacements(acceptsInStreamVideoPlacements bool) *DirectorySitesListCall {
- c.opt_["acceptsInStreamVideoPlacements"] = acceptsInStreamVideoPlacements
- return c
-}
-
-// AcceptsInterstitialPlacements sets the optional parameter
-// "acceptsInterstitialPlacements": This search filter is no longer
-// supported and will have no effect on the results returned.
-func (c *DirectorySitesListCall) AcceptsInterstitialPlacements(acceptsInterstitialPlacements bool) *DirectorySitesListCall {
- c.opt_["acceptsInterstitialPlacements"] = acceptsInterstitialPlacements
- return c
-}
-
-// AcceptsPublisherPaidPlacements sets the optional parameter
-// "acceptsPublisherPaidPlacements": Select only directory sites that
-// accept publisher paid placements. This field can be left blank.
-func (c *DirectorySitesListCall) AcceptsPublisherPaidPlacements(acceptsPublisherPaidPlacements bool) *DirectorySitesListCall {
- c.opt_["acceptsPublisherPaidPlacements"] = acceptsPublisherPaidPlacements
- return c
-}
-
-// Active sets the optional parameter "active": Select only active
-// directory sites. Leave blank to retrieve both active and inactive
-// directory sites.
-func (c *DirectorySitesListCall) Active(active bool) *DirectorySitesListCall {
- c.opt_["active"] = active
- return c
-}
-
-// CountryId sets the optional parameter "countryId": Select only
-// directory sites with this country ID.
-func (c *DirectorySitesListCall) CountryId(countryId int64) *DirectorySitesListCall {
- c.opt_["countryId"] = countryId
- return c
-}
-
-// DfpNetworkCode sets the optional parameter "dfp_network_code": Select
-// only directory sites with this DFP network code.
-func (c *DirectorySitesListCall) DfpNetworkCode(dfpNetworkCode string) *DirectorySitesListCall {
- c.opt_["dfp_network_code"] = dfpNetworkCode
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only directory sites
-// with these IDs.
-func (c *DirectorySitesListCall) Ids(ids int64) *DirectorySitesListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *DirectorySitesListCall) MaxResults(maxResults int64) *DirectorySitesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *DirectorySitesListCall) PageToken(pageToken string) *DirectorySitesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// ParentId sets the optional parameter "parentId": Select only
-// directory sites with this parent ID.
-func (c *DirectorySitesListCall) ParentId(parentId int64) *DirectorySitesListCall {
- c.opt_["parentId"] = parentId
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name, ID or URL. Wildcards (*) are allowed.
-// For example, "directory site*2015" will return objects with names
-// like "directory site June 2015", "directory site April 2015", or
-// simply "directory site 2015". Most of the searches also add wildcards
-// implicitly at the start and the end of the search string. For
-// example, a search string of "directory site" will match objects with
-// name "my directory site", "directory site 2015" or simply, "directory
-// site".
-func (c *DirectorySitesListCall) SearchString(searchString string) *DirectorySitesListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *DirectorySitesListCall) SortField(sortField string) *DirectorySitesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *DirectorySitesListCall) SortOrder(sortOrder string) *DirectorySitesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DirectorySitesListCall) Fields(s ...googleapi.Field) *DirectorySitesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DirectorySitesListCall) IfNoneMatch(entityTag string) *DirectorySitesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DirectorySitesListCall) Context(ctx context.Context) *DirectorySitesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DirectorySitesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["acceptsInStreamVideoPlacements"]; ok {
- params.Set("acceptsInStreamVideoPlacements", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["acceptsInterstitialPlacements"]; ok {
- params.Set("acceptsInterstitialPlacements", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["acceptsPublisherPaidPlacements"]; ok {
- params.Set("acceptsPublisherPaidPlacements", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["active"]; ok {
- params.Set("active", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["countryId"]; ok {
- params.Set("countryId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["dfp_network_code"]; ok {
- params.Set("dfp_network_code", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["parentId"]; ok {
- params.Set("parentId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/directorySites")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.directorySites.list" call.
-// Exactly one of *DirectorySitesListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *DirectorySitesListResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DirectorySitesListCall) Do() (*DirectorySitesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DirectorySitesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of directory sites, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.directorySites.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "acceptsInStreamVideoPlacements": {
- // "description": "This search filter is no longer supported and will have no effect on the results returned.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "acceptsInterstitialPlacements": {
- // "description": "This search filter is no longer supported and will have no effect on the results returned.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "acceptsPublisherPaidPlacements": {
- // "description": "Select only directory sites that accept publisher paid placements. This field can be left blank.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "active": {
- // "description": "Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "countryId": {
- // "description": "Select only directory sites with this country ID.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "dfp_network_code": {
- // "description": "Select only directory sites with this DFP network code.",
- // "location": "query",
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only directory sites with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "parentId": {
- // "description": "Select only directory sites with this parent ID.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, \"directory site*2015\" will return objects with names like \"directory site June 2015\", \"directory site April 2015\", or simply \"directory site 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"directory site\" will match objects with name \"my directory site\", \"directory site 2015\" or simply, \"directory site\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/directorySites",
- // "response": {
- // "$ref": "DirectorySitesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.eventTags.delete":
-
-type EventTagsDeleteCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an existing event tag.
-func (r *EventTagsService) Delete(profileId int64, id int64) *EventTagsDeleteCall {
- c := &EventTagsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EventTagsDeleteCall) Fields(s ...googleapi.Field) *EventTagsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EventTagsDeleteCall) Context(ctx context.Context) *EventTagsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EventTagsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/eventTags/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.eventTags.delete" call.
-func (c *EventTagsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes an existing event tag.",
- // "httpMethod": "DELETE",
- // "id": "dfareporting.eventTags.delete",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Event tag ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/eventTags/{id}",
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.eventTags.get":
-
-type EventTagsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one event tag by ID.
-func (r *EventTagsService) Get(profileId int64, id int64) *EventTagsGetCall {
- c := &EventTagsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EventTagsGetCall) Fields(s ...googleapi.Field) *EventTagsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *EventTagsGetCall) IfNoneMatch(entityTag string) *EventTagsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EventTagsGetCall) Context(ctx context.Context) *EventTagsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EventTagsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/eventTags/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.eventTags.get" call.
-// Exactly one of *EventTag or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *EventTag.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *EventTagsGetCall) Do() (*EventTag, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EventTag{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one event tag by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.eventTags.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Event tag ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/eventTags/{id}",
- // "response": {
- // "$ref": "EventTag"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.eventTags.insert":
-
-type EventTagsInsertCall struct {
- s *Service
- profileId int64
- eventtag *EventTag
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new event tag.
-func (r *EventTagsService) Insert(profileId int64, eventtag *EventTag) *EventTagsInsertCall {
- c := &EventTagsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.eventtag = eventtag
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EventTagsInsertCall) Fields(s ...googleapi.Field) *EventTagsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EventTagsInsertCall) Context(ctx context.Context) *EventTagsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EventTagsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.eventtag)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/eventTags")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.eventTags.insert" call.
-// Exactly one of *EventTag or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *EventTag.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *EventTagsInsertCall) Do() (*EventTag, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EventTag{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new event tag.",
- // "httpMethod": "POST",
- // "id": "dfareporting.eventTags.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/eventTags",
- // "request": {
- // "$ref": "EventTag"
- // },
- // "response": {
- // "$ref": "EventTag"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.eventTags.list":
-
-type EventTagsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of event tags, possibly filtered.
-func (r *EventTagsService) List(profileId int64) *EventTagsListCall {
- c := &EventTagsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// AdId sets the optional parameter "adId": Select only event tags that
-// belong to this ad.
-func (c *EventTagsListCall) AdId(adId int64) *EventTagsListCall {
- c.opt_["adId"] = adId
- return c
-}
-
-// AdvertiserId sets the optional parameter "advertiserId": Select only
-// event tags that belong to this advertiser.
-func (c *EventTagsListCall) AdvertiserId(advertiserId int64) *EventTagsListCall {
- c.opt_["advertiserId"] = advertiserId
- return c
-}
-
-// CampaignId sets the optional parameter "campaignId": Select only
-// event tags that belong to this campaign.
-func (c *EventTagsListCall) CampaignId(campaignId int64) *EventTagsListCall {
- c.opt_["campaignId"] = campaignId
- return c
-}
-
-// DefinitionsOnly sets the optional parameter "definitionsOnly":
-// Examine only the specified campaign or advertiser's event tags for
-// matching selector criteria. When set to false, the parent advertiser
-// and parent campaign of the specified ad or campaign is examined as
-// well. In addition, when set to false, the status field is examined as
-// well, along with the enabledByDefault field. This parameter can not
-// be set to true when adId is specified as ads do not define their own
-// even tags.
-func (c *EventTagsListCall) DefinitionsOnly(definitionsOnly bool) *EventTagsListCall {
- c.opt_["definitionsOnly"] = definitionsOnly
- return c
-}
-
-// Enabled sets the optional parameter "enabled": Select only enabled
-// event tags. What is considered enabled or disabled depends on the
-// definitionsOnly parameter. When definitionsOnly is set to true, only
-// the specified advertiser or campaign's event tags' enabledByDefault
-// field is examined. When definitionsOnly is set to false, the
-// specified ad or specified campaign's parent advertiser's or parent
-// campaign's event tags' enabledByDefault and status fields are
-// examined as well.
-func (c *EventTagsListCall) Enabled(enabled bool) *EventTagsListCall {
- c.opt_["enabled"] = enabled
- return c
-}
-
-// EventTagTypes sets the optional parameter "eventTagTypes": Select
-// only event tags with the specified event tag types. Event tag types
-// can be used to specify whether to use a third-party pixel, a
-// third-party JavaScript URL, or a third-party click-through URL for
-// either impression or click tracking.
-//
-// Possible values:
-// "CLICK_THROUGH_EVENT_TAG"
-// "IMPRESSION_IMAGE_EVENT_TAG"
-// "IMPRESSION_JAVASCRIPT_EVENT_TAG"
-func (c *EventTagsListCall) EventTagTypes(eventTagTypes string) *EventTagsListCall {
- c.opt_["eventTagTypes"] = eventTagTypes
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only event tags with
-// these IDs.
-func (c *EventTagsListCall) Ids(ids int64) *EventTagsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name or ID. Wildcards (*) are allowed. For
-// example, "eventtag*2015" will return objects with names like
-// "eventtag June 2015", "eventtag April 2015", or simply "eventtag
-// 2015". Most of the searches also add wildcards implicitly at the
-// start and the end of the search string. For example, a search string
-// of "eventtag" will match objects with name "my eventtag", "eventtag
-// 2015", or simply "eventtag".
-func (c *EventTagsListCall) SearchString(searchString string) *EventTagsListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *EventTagsListCall) SortField(sortField string) *EventTagsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *EventTagsListCall) SortOrder(sortOrder string) *EventTagsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EventTagsListCall) Fields(s ...googleapi.Field) *EventTagsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *EventTagsListCall) IfNoneMatch(entityTag string) *EventTagsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EventTagsListCall) Context(ctx context.Context) *EventTagsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EventTagsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["adId"]; ok {
- params.Set("adId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["advertiserId"]; ok {
- params.Set("advertiserId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["campaignId"]; ok {
- params.Set("campaignId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["definitionsOnly"]; ok {
- params.Set("definitionsOnly", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["enabled"]; ok {
- params.Set("enabled", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["eventTagTypes"]; ok {
- params.Set("eventTagTypes", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/eventTags")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.eventTags.list" call.
-// Exactly one of *EventTagsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *EventTagsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *EventTagsListCall) Do() (*EventTagsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EventTagsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of event tags, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.eventTags.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "adId": {
- // "description": "Select only event tags that belong to this ad.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "advertiserId": {
- // "description": "Select only event tags that belong to this advertiser.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "campaignId": {
- // "description": "Select only event tags that belong to this campaign.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "definitionsOnly": {
- // "description": "Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "enabled": {
- // "description": "Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "eventTagTypes": {
- // "description": "Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking.",
- // "enum": [
- // "CLICK_THROUGH_EVENT_TAG",
- // "IMPRESSION_IMAGE_EVENT_TAG",
- // "IMPRESSION_JAVASCRIPT_EVENT_TAG"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only event tags with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"eventtag*2015\" will return objects with names like \"eventtag June 2015\", \"eventtag April 2015\", or simply \"eventtag 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"eventtag\" will match objects with name \"my eventtag\", \"eventtag 2015\", or simply \"eventtag\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/eventTags",
- // "response": {
- // "$ref": "EventTagsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.eventTags.patch":
-
-type EventTagsPatchCall struct {
- s *Service
- profileId int64
- id int64
- eventtag *EventTag
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing event tag. This method supports patch
-// semantics.
-func (r *EventTagsService) Patch(profileId int64, id int64, eventtag *EventTag) *EventTagsPatchCall {
- c := &EventTagsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.eventtag = eventtag
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EventTagsPatchCall) Fields(s ...googleapi.Field) *EventTagsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EventTagsPatchCall) Context(ctx context.Context) *EventTagsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EventTagsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.eventtag)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/eventTags")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.eventTags.patch" call.
-// Exactly one of *EventTag or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *EventTag.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *EventTagsPatchCall) Do() (*EventTag, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EventTag{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing event tag. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.eventTags.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Event tag ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/eventTags",
- // "request": {
- // "$ref": "EventTag"
- // },
- // "response": {
- // "$ref": "EventTag"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.eventTags.update":
-
-type EventTagsUpdateCall struct {
- s *Service
- profileId int64
- eventtag *EventTag
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing event tag.
-func (r *EventTagsService) Update(profileId int64, eventtag *EventTag) *EventTagsUpdateCall {
- c := &EventTagsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.eventtag = eventtag
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EventTagsUpdateCall) Fields(s ...googleapi.Field) *EventTagsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EventTagsUpdateCall) Context(ctx context.Context) *EventTagsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EventTagsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.eventtag)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/eventTags")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.eventTags.update" call.
-// Exactly one of *EventTag or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *EventTag.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *EventTagsUpdateCall) Do() (*EventTag, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EventTag{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing event tag.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.eventTags.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/eventTags",
- // "request": {
- // "$ref": "EventTag"
- // },
- // "response": {
- // "$ref": "EventTag"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.files.get":
-
-type FilesGetCall struct {
- s *Service
- reportId int64
- fileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves a report file by its report ID and file ID.
-func (r *FilesService) Get(reportId int64, fileId int64) *FilesGetCall {
- c := &FilesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.reportId = reportId
- c.fileId = fileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FilesGetCall) Fields(s ...googleapi.Field) *FilesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *FilesGetCall) IfNoneMatch(entityTag string) *FilesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do and Download methods.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FilesGetCall) Context(ctx context.Context) *FilesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FilesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "reports/{reportId}/files/{fileId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "reportId": strconv.FormatInt(c.reportId, 10),
- "fileId": strconv.FormatInt(c.fileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Download fetches the API endpoint's "media" value, instead of the normal
-// API response value. If the returned error is nil, the Response is guaranteed to
-// have a 2xx status code. Callers must close the Response.Body as usual.
-func (c *FilesGetCall) Download() (*http.Response, error) {
- res, err := c.doRequest("media")
- if err != nil {
- return nil, err
- }
- if err := googleapi.CheckMediaResponse(res); err != nil {
- res.Body.Close()
- return nil, err
- }
- return res, nil
-}
-
-// Do executes the "dfareporting.files.get" call.
-// Exactly one of *File or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *File.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *FilesGetCall) Do() (*File, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &File{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a report file by its report ID and file ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.files.get",
- // "parameterOrder": [
- // "reportId",
- // "fileId"
- // ],
- // "parameters": {
- // "fileId": {
- // "description": "The ID of the report file.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "reports/{reportId}/files/{fileId}",
- // "response": {
- // "$ref": "File"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ],
- // "supportsMediaDownload": true
- // }
-
-}
-
-// method id "dfareporting.files.list":
-
-type FilesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists files for a user profile.
-func (r *FilesService) List(profileId int64) *FilesListCall {
- c := &FilesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *FilesListCall) MaxResults(maxResults int64) *FilesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous result page.
-func (c *FilesListCall) PageToken(pageToken string) *FilesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Scope sets the optional parameter "scope": The scope that defines
-// which results are returned, default is 'MINE'.
-//
-// Possible values:
-// "ALL" - All files in account.
-// "MINE" (default) - My files.
-// "SHARED_WITH_ME" - Files shared with me.
-func (c *FilesListCall) Scope(scope string) *FilesListCall {
- c.opt_["scope"] = scope
- return c
-}
-
-// SortField sets the optional parameter "sortField": The field by which
-// to sort the list.
-//
-// Possible values:
-// "ID" - Sort by file ID.
-// "LAST_MODIFIED_TIME" (default) - Sort by 'lastmodifiedAt' field.
-func (c *FilesListCall) SortField(sortField string) *FilesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is 'DESCENDING'.
-//
-// Possible values:
-// "ASCENDING" - Ascending order.
-// "DESCENDING" (default) - Descending order.
-func (c *FilesListCall) SortOrder(sortOrder string) *FilesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FilesListCall) Fields(s ...googleapi.Field) *FilesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *FilesListCall) IfNoneMatch(entityTag string) *FilesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FilesListCall) Context(ctx context.Context) *FilesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FilesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["scope"]; ok {
- params.Set("scope", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/files")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.files.list" call.
-// Exactly one of *FileList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *FileList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *FilesListCall) Do() (*FileList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FileList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists files for a user profile.",
- // "httpMethod": "GET",
- // "id": "dfareporting.files.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "scope": {
- // "default": "MINE",
- // "description": "The scope that defines which results are returned, default is 'MINE'.",
- // "enum": [
- // "ALL",
- // "MINE",
- // "SHARED_WITH_ME"
- // ],
- // "enumDescriptions": [
- // "All files in account.",
- // "My files.",
- // "Files shared with me."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "default": "LAST_MODIFIED_TIME",
- // "description": "The field by which to sort the list.",
- // "enum": [
- // "ID",
- // "LAST_MODIFIED_TIME"
- // ],
- // "enumDescriptions": [
- // "Sort by file ID.",
- // "Sort by 'lastmodifiedAt' field."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "default": "DESCENDING",
- // "description": "Order of sorted results, default is 'DESCENDING'.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "Ascending order.",
- // "Descending order."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/files",
- // "response": {
- // "$ref": "FileList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightActivities.delete":
-
-type FloodlightActivitiesDeleteCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an existing floodlight activity.
-func (r *FloodlightActivitiesService) Delete(profileId int64, id int64) *FloodlightActivitiesDeleteCall {
- c := &FloodlightActivitiesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightActivitiesDeleteCall) Fields(s ...googleapi.Field) *FloodlightActivitiesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightActivitiesDeleteCall) Context(ctx context.Context) *FloodlightActivitiesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightActivitiesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightActivities/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightActivities.delete" call.
-func (c *FloodlightActivitiesDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes an existing floodlight activity.",
- // "httpMethod": "DELETE",
- // "id": "dfareporting.floodlightActivities.delete",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Floodlight activity ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightActivities/{id}",
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightActivities.generatetag":
-
-type FloodlightActivitiesGeneratetagCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Generatetag: Generates a tag for a floodlight activity.
-func (r *FloodlightActivitiesService) Generatetag(profileId int64) *FloodlightActivitiesGeneratetagCall {
- c := &FloodlightActivitiesGeneratetagCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// FloodlightActivityId sets the optional parameter
-// "floodlightActivityId": Floodlight activity ID for which we want to
-// generate a tag.
-func (c *FloodlightActivitiesGeneratetagCall) FloodlightActivityId(floodlightActivityId int64) *FloodlightActivitiesGeneratetagCall {
- c.opt_["floodlightActivityId"] = floodlightActivityId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightActivitiesGeneratetagCall) Fields(s ...googleapi.Field) *FloodlightActivitiesGeneratetagCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightActivitiesGeneratetagCall) Context(ctx context.Context) *FloodlightActivitiesGeneratetagCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightActivitiesGeneratetagCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["floodlightActivityId"]; ok {
- params.Set("floodlightActivityId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightActivities/generatetag")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightActivities.generatetag" call.
-// Exactly one of *FloodlightActivitiesGenerateTagResponse or error will
-// be non-nil. Any non-2xx status code is an error. Response headers are
-// in either
-// *FloodlightActivitiesGenerateTagResponse.ServerResponse.Header or (if
-// a response was returned at all) in error.(*googleapi.Error).Header.
-// Use googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *FloodlightActivitiesGeneratetagCall) Do() (*FloodlightActivitiesGenerateTagResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightActivitiesGenerateTagResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Generates a tag for a floodlight activity.",
- // "httpMethod": "POST",
- // "id": "dfareporting.floodlightActivities.generatetag",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "floodlightActivityId": {
- // "description": "Floodlight activity ID for which we want to generate a tag.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightActivities/generatetag",
- // "response": {
- // "$ref": "FloodlightActivitiesGenerateTagResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightActivities.get":
-
-type FloodlightActivitiesGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one floodlight activity by ID.
-func (r *FloodlightActivitiesService) Get(profileId int64, id int64) *FloodlightActivitiesGetCall {
- c := &FloodlightActivitiesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightActivitiesGetCall) Fields(s ...googleapi.Field) *FloodlightActivitiesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *FloodlightActivitiesGetCall) IfNoneMatch(entityTag string) *FloodlightActivitiesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightActivitiesGetCall) Context(ctx context.Context) *FloodlightActivitiesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightActivitiesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightActivities/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightActivities.get" call.
-// Exactly one of *FloodlightActivity or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *FloodlightActivity.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *FloodlightActivitiesGetCall) Do() (*FloodlightActivity, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightActivity{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one floodlight activity by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.floodlightActivities.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Floodlight activity ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightActivities/{id}",
- // "response": {
- // "$ref": "FloodlightActivity"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightActivities.insert":
-
-type FloodlightActivitiesInsertCall struct {
- s *Service
- profileId int64
- floodlightactivity *FloodlightActivity
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new floodlight activity.
-func (r *FloodlightActivitiesService) Insert(profileId int64, floodlightactivity *FloodlightActivity) *FloodlightActivitiesInsertCall {
- c := &FloodlightActivitiesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.floodlightactivity = floodlightactivity
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightActivitiesInsertCall) Fields(s ...googleapi.Field) *FloodlightActivitiesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightActivitiesInsertCall) Context(ctx context.Context) *FloodlightActivitiesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightActivitiesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.floodlightactivity)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightActivities")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightActivities.insert" call.
-// Exactly one of *FloodlightActivity or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *FloodlightActivity.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *FloodlightActivitiesInsertCall) Do() (*FloodlightActivity, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightActivity{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new floodlight activity.",
- // "httpMethod": "POST",
- // "id": "dfareporting.floodlightActivities.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightActivities",
- // "request": {
- // "$ref": "FloodlightActivity"
- // },
- // "response": {
- // "$ref": "FloodlightActivity"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightActivities.list":
-
-type FloodlightActivitiesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of floodlight activities, possibly filtered.
-func (r *FloodlightActivitiesService) List(profileId int64) *FloodlightActivitiesListCall {
- c := &FloodlightActivitiesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// AdvertiserId sets the optional parameter "advertiserId": Select only
-// floodlight activities for the specified advertiser ID. Must specify
-// either ids, advertiserId, or floodlightConfigurationId for a
-// non-empty result.
-func (c *FloodlightActivitiesListCall) AdvertiserId(advertiserId int64) *FloodlightActivitiesListCall {
- c.opt_["advertiserId"] = advertiserId
- return c
-}
-
-// FloodlightActivityGroupIds sets the optional parameter
-// "floodlightActivityGroupIds": Select only floodlight activities with
-// the specified floodlight activity group IDs.
-func (c *FloodlightActivitiesListCall) FloodlightActivityGroupIds(floodlightActivityGroupIds int64) *FloodlightActivitiesListCall {
- c.opt_["floodlightActivityGroupIds"] = floodlightActivityGroupIds
- return c
-}
-
-// FloodlightActivityGroupName sets the optional parameter
-// "floodlightActivityGroupName": Select only floodlight activities with
-// the specified floodlight activity group name.
-func (c *FloodlightActivitiesListCall) FloodlightActivityGroupName(floodlightActivityGroupName string) *FloodlightActivitiesListCall {
- c.opt_["floodlightActivityGroupName"] = floodlightActivityGroupName
- return c
-}
-
-// FloodlightActivityGroupTagString sets the optional parameter
-// "floodlightActivityGroupTagString": Select only floodlight activities
-// with the specified floodlight activity group tag string.
-func (c *FloodlightActivitiesListCall) FloodlightActivityGroupTagString(floodlightActivityGroupTagString string) *FloodlightActivitiesListCall {
- c.opt_["floodlightActivityGroupTagString"] = floodlightActivityGroupTagString
- return c
-}
-
-// FloodlightActivityGroupType sets the optional parameter
-// "floodlightActivityGroupType": Select only floodlight activities with
-// the specified floodlight activity group type.
-//
-// Possible values:
-// "COUNTER"
-// "SALE"
-func (c *FloodlightActivitiesListCall) FloodlightActivityGroupType(floodlightActivityGroupType string) *FloodlightActivitiesListCall {
- c.opt_["floodlightActivityGroupType"] = floodlightActivityGroupType
- return c
-}
-
-// FloodlightConfigurationId sets the optional parameter
-// "floodlightConfigurationId": Select only floodlight activities for
-// the specified floodlight configuration ID. Must specify either ids,
-// advertiserId, or floodlightConfigurationId for a non-empty result.
-func (c *FloodlightActivitiesListCall) FloodlightConfigurationId(floodlightConfigurationId int64) *FloodlightActivitiesListCall {
- c.opt_["floodlightConfigurationId"] = floodlightConfigurationId
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only floodlight
-// activities with the specified IDs. Must specify either ids,
-// advertiserId, or floodlightConfigurationId for a non-empty result.
-func (c *FloodlightActivitiesListCall) Ids(ids int64) *FloodlightActivitiesListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *FloodlightActivitiesListCall) MaxResults(maxResults int64) *FloodlightActivitiesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *FloodlightActivitiesListCall) PageToken(pageToken string) *FloodlightActivitiesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name or ID. Wildcards (*) are allowed. For
-// example, "floodlightactivity*2015" will return objects with names
-// like "floodlightactivity June 2015", "floodlightactivity April 2015",
-// or simply "floodlightactivity 2015". Most of the searches also add
-// wildcards implicitly at the start and the end of the search string.
-// For example, a search string of "floodlightactivity" will match
-// objects with name "my floodlightactivity activity",
-// "floodlightactivity 2015", or simply "floodlightactivity".
-func (c *FloodlightActivitiesListCall) SearchString(searchString string) *FloodlightActivitiesListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *FloodlightActivitiesListCall) SortField(sortField string) *FloodlightActivitiesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *FloodlightActivitiesListCall) SortOrder(sortOrder string) *FloodlightActivitiesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// TagString sets the optional parameter "tagString": Select only
-// floodlight activities with the specified tag string.
-func (c *FloodlightActivitiesListCall) TagString(tagString string) *FloodlightActivitiesListCall {
- c.opt_["tagString"] = tagString
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightActivitiesListCall) Fields(s ...googleapi.Field) *FloodlightActivitiesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *FloodlightActivitiesListCall) IfNoneMatch(entityTag string) *FloodlightActivitiesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightActivitiesListCall) Context(ctx context.Context) *FloodlightActivitiesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightActivitiesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["advertiserId"]; ok {
- params.Set("advertiserId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["floodlightActivityGroupIds"]; ok {
- params.Set("floodlightActivityGroupIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["floodlightActivityGroupName"]; ok {
- params.Set("floodlightActivityGroupName", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["floodlightActivityGroupTagString"]; ok {
- params.Set("floodlightActivityGroupTagString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["floodlightActivityGroupType"]; ok {
- params.Set("floodlightActivityGroupType", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["floodlightConfigurationId"]; ok {
- params.Set("floodlightConfigurationId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["tagString"]; ok {
- params.Set("tagString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightActivities")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightActivities.list" call.
-// Exactly one of *FloodlightActivitiesListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *FloodlightActivitiesListResponse.ServerResponse.Header or (if
-// a response was returned at all) in error.(*googleapi.Error).Header.
-// Use googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *FloodlightActivitiesListCall) Do() (*FloodlightActivitiesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightActivitiesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of floodlight activities, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.floodlightActivities.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "advertiserId": {
- // "description": "Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "floodlightActivityGroupIds": {
- // "description": "Select only floodlight activities with the specified floodlight activity group IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "floodlightActivityGroupName": {
- // "description": "Select only floodlight activities with the specified floodlight activity group name.",
- // "location": "query",
- // "type": "string"
- // },
- // "floodlightActivityGroupTagString": {
- // "description": "Select only floodlight activities with the specified floodlight activity group tag string.",
- // "location": "query",
- // "type": "string"
- // },
- // "floodlightActivityGroupType": {
- // "description": "Select only floodlight activities with the specified floodlight activity group type.",
- // "enum": [
- // "COUNTER",
- // "SALE"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "floodlightConfigurationId": {
- // "description": "Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"floodlightactivity*2015\" will return objects with names like \"floodlightactivity June 2015\", \"floodlightactivity April 2015\", or simply \"floodlightactivity 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"floodlightactivity\" will match objects with name \"my floodlightactivity activity\", \"floodlightactivity 2015\", or simply \"floodlightactivity\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "tagString": {
- // "description": "Select only floodlight activities with the specified tag string.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightActivities",
- // "response": {
- // "$ref": "FloodlightActivitiesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightActivities.patch":
-
-type FloodlightActivitiesPatchCall struct {
- s *Service
- profileId int64
- id int64
- floodlightactivity *FloodlightActivity
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing floodlight activity. This method supports
-// patch semantics.
-func (r *FloodlightActivitiesService) Patch(profileId int64, id int64, floodlightactivity *FloodlightActivity) *FloodlightActivitiesPatchCall {
- c := &FloodlightActivitiesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.floodlightactivity = floodlightactivity
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightActivitiesPatchCall) Fields(s ...googleapi.Field) *FloodlightActivitiesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightActivitiesPatchCall) Context(ctx context.Context) *FloodlightActivitiesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightActivitiesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.floodlightactivity)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightActivities")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightActivities.patch" call.
-// Exactly one of *FloodlightActivity or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *FloodlightActivity.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *FloodlightActivitiesPatchCall) Do() (*FloodlightActivity, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightActivity{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing floodlight activity. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.floodlightActivities.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Floodlight activity ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightActivities",
- // "request": {
- // "$ref": "FloodlightActivity"
- // },
- // "response": {
- // "$ref": "FloodlightActivity"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightActivities.update":
-
-type FloodlightActivitiesUpdateCall struct {
- s *Service
- profileId int64
- floodlightactivity *FloodlightActivity
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing floodlight activity.
-func (r *FloodlightActivitiesService) Update(profileId int64, floodlightactivity *FloodlightActivity) *FloodlightActivitiesUpdateCall {
- c := &FloodlightActivitiesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.floodlightactivity = floodlightactivity
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightActivitiesUpdateCall) Fields(s ...googleapi.Field) *FloodlightActivitiesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightActivitiesUpdateCall) Context(ctx context.Context) *FloodlightActivitiesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightActivitiesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.floodlightactivity)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightActivities")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightActivities.update" call.
-// Exactly one of *FloodlightActivity or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *FloodlightActivity.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *FloodlightActivitiesUpdateCall) Do() (*FloodlightActivity, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightActivity{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing floodlight activity.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.floodlightActivities.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightActivities",
- // "request": {
- // "$ref": "FloodlightActivity"
- // },
- // "response": {
- // "$ref": "FloodlightActivity"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightActivityGroups.delete":
-
-type FloodlightActivityGroupsDeleteCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an existing floodlight activity group.
-func (r *FloodlightActivityGroupsService) Delete(profileId int64, id int64) *FloodlightActivityGroupsDeleteCall {
- c := &FloodlightActivityGroupsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightActivityGroupsDeleteCall) Fields(s ...googleapi.Field) *FloodlightActivityGroupsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightActivityGroupsDeleteCall) Context(ctx context.Context) *FloodlightActivityGroupsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightActivityGroupsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightActivityGroups/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightActivityGroups.delete" call.
-func (c *FloodlightActivityGroupsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes an existing floodlight activity group.",
- // "httpMethod": "DELETE",
- // "id": "dfareporting.floodlightActivityGroups.delete",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Floodlight activity Group ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightActivityGroups/{id}",
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightActivityGroups.get":
-
-type FloodlightActivityGroupsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one floodlight activity group by ID.
-func (r *FloodlightActivityGroupsService) Get(profileId int64, id int64) *FloodlightActivityGroupsGetCall {
- c := &FloodlightActivityGroupsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightActivityGroupsGetCall) Fields(s ...googleapi.Field) *FloodlightActivityGroupsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *FloodlightActivityGroupsGetCall) IfNoneMatch(entityTag string) *FloodlightActivityGroupsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightActivityGroupsGetCall) Context(ctx context.Context) *FloodlightActivityGroupsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightActivityGroupsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightActivityGroups/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightActivityGroups.get" call.
-// Exactly one of *FloodlightActivityGroup or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *FloodlightActivityGroup.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *FloodlightActivityGroupsGetCall) Do() (*FloodlightActivityGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightActivityGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one floodlight activity group by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.floodlightActivityGroups.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Floodlight activity Group ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightActivityGroups/{id}",
- // "response": {
- // "$ref": "FloodlightActivityGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightActivityGroups.insert":
-
-type FloodlightActivityGroupsInsertCall struct {
- s *Service
- profileId int64
- floodlightactivitygroup *FloodlightActivityGroup
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new floodlight activity group.
-func (r *FloodlightActivityGroupsService) Insert(profileId int64, floodlightactivitygroup *FloodlightActivityGroup) *FloodlightActivityGroupsInsertCall {
- c := &FloodlightActivityGroupsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.floodlightactivitygroup = floodlightactivitygroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightActivityGroupsInsertCall) Fields(s ...googleapi.Field) *FloodlightActivityGroupsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightActivityGroupsInsertCall) Context(ctx context.Context) *FloodlightActivityGroupsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightActivityGroupsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.floodlightactivitygroup)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightActivityGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightActivityGroups.insert" call.
-// Exactly one of *FloodlightActivityGroup or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *FloodlightActivityGroup.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *FloodlightActivityGroupsInsertCall) Do() (*FloodlightActivityGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightActivityGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new floodlight activity group.",
- // "httpMethod": "POST",
- // "id": "dfareporting.floodlightActivityGroups.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightActivityGroups",
- // "request": {
- // "$ref": "FloodlightActivityGroup"
- // },
- // "response": {
- // "$ref": "FloodlightActivityGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightActivityGroups.list":
-
-type FloodlightActivityGroupsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of floodlight activity groups, possibly
-// filtered.
-func (r *FloodlightActivityGroupsService) List(profileId int64) *FloodlightActivityGroupsListCall {
- c := &FloodlightActivityGroupsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// AdvertiserId sets the optional parameter "advertiserId": Select only
-// floodlight activity groups with the specified advertiser ID. Must
-// specify either advertiserId or floodlightConfigurationId for a
-// non-empty result.
-func (c *FloodlightActivityGroupsListCall) AdvertiserId(advertiserId int64) *FloodlightActivityGroupsListCall {
- c.opt_["advertiserId"] = advertiserId
- return c
-}
-
-// FloodlightConfigurationId sets the optional parameter
-// "floodlightConfigurationId": Select only floodlight activity groups
-// with the specified floodlight configuration ID. Must specify either
-// advertiserId, or floodlightConfigurationId for a non-empty result.
-func (c *FloodlightActivityGroupsListCall) FloodlightConfigurationId(floodlightConfigurationId int64) *FloodlightActivityGroupsListCall {
- c.opt_["floodlightConfigurationId"] = floodlightConfigurationId
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only floodlight
-// activity groups with the specified IDs. Must specify either
-// advertiserId or floodlightConfigurationId for a non-empty result.
-func (c *FloodlightActivityGroupsListCall) Ids(ids int64) *FloodlightActivityGroupsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *FloodlightActivityGroupsListCall) MaxResults(maxResults int64) *FloodlightActivityGroupsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *FloodlightActivityGroupsListCall) PageToken(pageToken string) *FloodlightActivityGroupsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name or ID. Wildcards (*) are allowed. For
-// example, "floodlightactivitygroup*2015" will return objects with
-// names like "floodlightactivitygroup June 2015",
-// "floodlightactivitygroup April 2015", or simply
-// "floodlightactivitygroup 2015". Most of the searches also add
-// wildcards implicitly at the start and the end of the search string.
-// For example, a search string of "floodlightactivitygroup" will match
-// objects with name "my floodlightactivitygroup activity",
-// "floodlightactivitygroup 2015", or simply "floodlightactivitygroup".
-func (c *FloodlightActivityGroupsListCall) SearchString(searchString string) *FloodlightActivityGroupsListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *FloodlightActivityGroupsListCall) SortField(sortField string) *FloodlightActivityGroupsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *FloodlightActivityGroupsListCall) SortOrder(sortOrder string) *FloodlightActivityGroupsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Type sets the optional parameter "type": Select only floodlight
-// activity groups with the specified floodlight activity group type.
-//
-// Possible values:
-// "COUNTER"
-// "SALE"
-func (c *FloodlightActivityGroupsListCall) Type(type_ string) *FloodlightActivityGroupsListCall {
- c.opt_["type"] = type_
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightActivityGroupsListCall) Fields(s ...googleapi.Field) *FloodlightActivityGroupsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *FloodlightActivityGroupsListCall) IfNoneMatch(entityTag string) *FloodlightActivityGroupsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightActivityGroupsListCall) Context(ctx context.Context) *FloodlightActivityGroupsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightActivityGroupsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["advertiserId"]; ok {
- params.Set("advertiserId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["floodlightConfigurationId"]; ok {
- params.Set("floodlightConfigurationId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["type"]; ok {
- params.Set("type", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightActivityGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightActivityGroups.list" call.
-// Exactly one of *FloodlightActivityGroupsListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *FloodlightActivityGroupsListResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *FloodlightActivityGroupsListCall) Do() (*FloodlightActivityGroupsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightActivityGroupsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of floodlight activity groups, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.floodlightActivityGroups.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "advertiserId": {
- // "description": "Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "floodlightConfigurationId": {
- // "description": "Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"floodlightactivitygroup*2015\" will return objects with names like \"floodlightactivitygroup June 2015\", \"floodlightactivitygroup April 2015\", or simply \"floodlightactivitygroup 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"floodlightactivitygroup\" will match objects with name \"my floodlightactivitygroup activity\", \"floodlightactivitygroup 2015\", or simply \"floodlightactivitygroup\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "type": {
- // "description": "Select only floodlight activity groups with the specified floodlight activity group type.",
- // "enum": [
- // "COUNTER",
- // "SALE"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightActivityGroups",
- // "response": {
- // "$ref": "FloodlightActivityGroupsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightActivityGroups.patch":
-
-type FloodlightActivityGroupsPatchCall struct {
- s *Service
- profileId int64
- id int64
- floodlightactivitygroup *FloodlightActivityGroup
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing floodlight activity group. This method
-// supports patch semantics.
-func (r *FloodlightActivityGroupsService) Patch(profileId int64, id int64, floodlightactivitygroup *FloodlightActivityGroup) *FloodlightActivityGroupsPatchCall {
- c := &FloodlightActivityGroupsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.floodlightactivitygroup = floodlightactivitygroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightActivityGroupsPatchCall) Fields(s ...googleapi.Field) *FloodlightActivityGroupsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightActivityGroupsPatchCall) Context(ctx context.Context) *FloodlightActivityGroupsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightActivityGroupsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.floodlightactivitygroup)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightActivityGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightActivityGroups.patch" call.
-// Exactly one of *FloodlightActivityGroup or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *FloodlightActivityGroup.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *FloodlightActivityGroupsPatchCall) Do() (*FloodlightActivityGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightActivityGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing floodlight activity group. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.floodlightActivityGroups.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Floodlight activity Group ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightActivityGroups",
- // "request": {
- // "$ref": "FloodlightActivityGroup"
- // },
- // "response": {
- // "$ref": "FloodlightActivityGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightActivityGroups.update":
-
-type FloodlightActivityGroupsUpdateCall struct {
- s *Service
- profileId int64
- floodlightactivitygroup *FloodlightActivityGroup
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing floodlight activity group.
-func (r *FloodlightActivityGroupsService) Update(profileId int64, floodlightactivitygroup *FloodlightActivityGroup) *FloodlightActivityGroupsUpdateCall {
- c := &FloodlightActivityGroupsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.floodlightactivitygroup = floodlightactivitygroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightActivityGroupsUpdateCall) Fields(s ...googleapi.Field) *FloodlightActivityGroupsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightActivityGroupsUpdateCall) Context(ctx context.Context) *FloodlightActivityGroupsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightActivityGroupsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.floodlightactivitygroup)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightActivityGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightActivityGroups.update" call.
-// Exactly one of *FloodlightActivityGroup or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *FloodlightActivityGroup.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *FloodlightActivityGroupsUpdateCall) Do() (*FloodlightActivityGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightActivityGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing floodlight activity group.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.floodlightActivityGroups.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightActivityGroups",
- // "request": {
- // "$ref": "FloodlightActivityGroup"
- // },
- // "response": {
- // "$ref": "FloodlightActivityGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightConfigurations.get":
-
-type FloodlightConfigurationsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one floodlight configuration by ID.
-func (r *FloodlightConfigurationsService) Get(profileId int64, id int64) *FloodlightConfigurationsGetCall {
- c := &FloodlightConfigurationsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightConfigurationsGetCall) Fields(s ...googleapi.Field) *FloodlightConfigurationsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *FloodlightConfigurationsGetCall) IfNoneMatch(entityTag string) *FloodlightConfigurationsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightConfigurationsGetCall) Context(ctx context.Context) *FloodlightConfigurationsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightConfigurationsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightConfigurations/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightConfigurations.get" call.
-// Exactly one of *FloodlightConfiguration or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *FloodlightConfiguration.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *FloodlightConfigurationsGetCall) Do() (*FloodlightConfiguration, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightConfiguration{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one floodlight configuration by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.floodlightConfigurations.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Floodlight configuration ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightConfigurations/{id}",
- // "response": {
- // "$ref": "FloodlightConfiguration"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightConfigurations.list":
-
-type FloodlightConfigurationsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of floodlight configurations, possibly
-// filtered.
-func (r *FloodlightConfigurationsService) List(profileId int64) *FloodlightConfigurationsListCall {
- c := &FloodlightConfigurationsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Ids sets the optional parameter "ids": Set of IDs of floodlight
-// configurations to retrieve. Required field; otherwise an empty list
-// will be returned.
-func (c *FloodlightConfigurationsListCall) Ids(ids int64) *FloodlightConfigurationsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightConfigurationsListCall) Fields(s ...googleapi.Field) *FloodlightConfigurationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *FloodlightConfigurationsListCall) IfNoneMatch(entityTag string) *FloodlightConfigurationsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightConfigurationsListCall) Context(ctx context.Context) *FloodlightConfigurationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightConfigurationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightConfigurations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightConfigurations.list" call.
-// Exactly one of *FloodlightConfigurationsListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *FloodlightConfigurationsListResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *FloodlightConfigurationsListCall) Do() (*FloodlightConfigurationsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightConfigurationsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of floodlight configurations, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.floodlightConfigurations.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "ids": {
- // "description": "Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightConfigurations",
- // "response": {
- // "$ref": "FloodlightConfigurationsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightConfigurations.patch":
-
-type FloodlightConfigurationsPatchCall struct {
- s *Service
- profileId int64
- id int64
- floodlightconfiguration *FloodlightConfiguration
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing floodlight configuration. This method
-// supports patch semantics.
-func (r *FloodlightConfigurationsService) Patch(profileId int64, id int64, floodlightconfiguration *FloodlightConfiguration) *FloodlightConfigurationsPatchCall {
- c := &FloodlightConfigurationsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.floodlightconfiguration = floodlightconfiguration
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightConfigurationsPatchCall) Fields(s ...googleapi.Field) *FloodlightConfigurationsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightConfigurationsPatchCall) Context(ctx context.Context) *FloodlightConfigurationsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightConfigurationsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.floodlightconfiguration)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightConfigurations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightConfigurations.patch" call.
-// Exactly one of *FloodlightConfiguration or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *FloodlightConfiguration.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *FloodlightConfigurationsPatchCall) Do() (*FloodlightConfiguration, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightConfiguration{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing floodlight configuration. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.floodlightConfigurations.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Floodlight configuration ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightConfigurations",
- // "request": {
- // "$ref": "FloodlightConfiguration"
- // },
- // "response": {
- // "$ref": "FloodlightConfiguration"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightConfigurations.update":
-
-type FloodlightConfigurationsUpdateCall struct {
- s *Service
- profileId int64
- floodlightconfiguration *FloodlightConfiguration
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing floodlight configuration.
-func (r *FloodlightConfigurationsService) Update(profileId int64, floodlightconfiguration *FloodlightConfiguration) *FloodlightConfigurationsUpdateCall {
- c := &FloodlightConfigurationsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.floodlightconfiguration = floodlightconfiguration
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightConfigurationsUpdateCall) Fields(s ...googleapi.Field) *FloodlightConfigurationsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightConfigurationsUpdateCall) Context(ctx context.Context) *FloodlightConfigurationsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightConfigurationsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.floodlightconfiguration)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightConfigurations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightConfigurations.update" call.
-// Exactly one of *FloodlightConfiguration or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *FloodlightConfiguration.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *FloodlightConfigurationsUpdateCall) Do() (*FloodlightConfiguration, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightConfiguration{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing floodlight configuration.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.floodlightConfigurations.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightConfigurations",
- // "request": {
- // "$ref": "FloodlightConfiguration"
- // },
- // "response": {
- // "$ref": "FloodlightConfiguration"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.landingPages.delete":
-
-type LandingPagesDeleteCall struct {
- s *Service
- profileId int64
- campaignId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an existing campaign landing page.
-func (r *LandingPagesService) Delete(profileId int64, campaignId int64, id int64) *LandingPagesDeleteCall {
- c := &LandingPagesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.campaignId = campaignId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LandingPagesDeleteCall) Fields(s ...googleapi.Field) *LandingPagesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LandingPagesDeleteCall) Context(ctx context.Context) *LandingPagesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LandingPagesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/campaigns/{campaignId}/landingPages/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "campaignId": strconv.FormatInt(c.campaignId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.landingPages.delete" call.
-func (c *LandingPagesDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes an existing campaign landing page.",
- // "httpMethod": "DELETE",
- // "id": "dfareporting.landingPages.delete",
- // "parameterOrder": [
- // "profileId",
- // "campaignId",
- // "id"
- // ],
- // "parameters": {
- // "campaignId": {
- // "description": "Landing page campaign ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "id": {
- // "description": "Landing page ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages/{id}",
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.landingPages.get":
-
-type LandingPagesGetCall struct {
- s *Service
- profileId int64
- campaignId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one campaign landing page by ID.
-func (r *LandingPagesService) Get(profileId int64, campaignId int64, id int64) *LandingPagesGetCall {
- c := &LandingPagesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.campaignId = campaignId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LandingPagesGetCall) Fields(s ...googleapi.Field) *LandingPagesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *LandingPagesGetCall) IfNoneMatch(entityTag string) *LandingPagesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LandingPagesGetCall) Context(ctx context.Context) *LandingPagesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LandingPagesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/campaigns/{campaignId}/landingPages/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "campaignId": strconv.FormatInt(c.campaignId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.landingPages.get" call.
-// Exactly one of *LandingPage or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *LandingPage.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *LandingPagesGetCall) Do() (*LandingPage, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &LandingPage{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one campaign landing page by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.landingPages.get",
- // "parameterOrder": [
- // "profileId",
- // "campaignId",
- // "id"
- // ],
- // "parameters": {
- // "campaignId": {
- // "description": "Landing page campaign ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "id": {
- // "description": "Landing page ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages/{id}",
- // "response": {
- // "$ref": "LandingPage"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.landingPages.insert":
-
-type LandingPagesInsertCall struct {
- s *Service
- profileId int64
- campaignId int64
- landingpage *LandingPage
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new landing page for the specified campaign.
-func (r *LandingPagesService) Insert(profileId int64, campaignId int64, landingpage *LandingPage) *LandingPagesInsertCall {
- c := &LandingPagesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.campaignId = campaignId
- c.landingpage = landingpage
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LandingPagesInsertCall) Fields(s ...googleapi.Field) *LandingPagesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LandingPagesInsertCall) Context(ctx context.Context) *LandingPagesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LandingPagesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.landingpage)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/campaigns/{campaignId}/landingPages")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "campaignId": strconv.FormatInt(c.campaignId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.landingPages.insert" call.
-// Exactly one of *LandingPage or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *LandingPage.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *LandingPagesInsertCall) Do() (*LandingPage, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &LandingPage{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new landing page for the specified campaign.",
- // "httpMethod": "POST",
- // "id": "dfareporting.landingPages.insert",
- // "parameterOrder": [
- // "profileId",
- // "campaignId"
- // ],
- // "parameters": {
- // "campaignId": {
- // "description": "Landing page campaign ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages",
- // "request": {
- // "$ref": "LandingPage"
- // },
- // "response": {
- // "$ref": "LandingPage"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.landingPages.list":
-
-type LandingPagesListCall struct {
- s *Service
- profileId int64
- campaignId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of landing pages for the specified campaign.
-func (r *LandingPagesService) List(profileId int64, campaignId int64) *LandingPagesListCall {
- c := &LandingPagesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.campaignId = campaignId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LandingPagesListCall) Fields(s ...googleapi.Field) *LandingPagesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *LandingPagesListCall) IfNoneMatch(entityTag string) *LandingPagesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LandingPagesListCall) Context(ctx context.Context) *LandingPagesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LandingPagesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/campaigns/{campaignId}/landingPages")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "campaignId": strconv.FormatInt(c.campaignId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.landingPages.list" call.
-// Exactly one of *LandingPagesListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *LandingPagesListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *LandingPagesListCall) Do() (*LandingPagesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &LandingPagesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of landing pages for the specified campaign.",
- // "httpMethod": "GET",
- // "id": "dfareporting.landingPages.list",
- // "parameterOrder": [
- // "profileId",
- // "campaignId"
- // ],
- // "parameters": {
- // "campaignId": {
- // "description": "Landing page campaign ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages",
- // "response": {
- // "$ref": "LandingPagesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.landingPages.patch":
-
-type LandingPagesPatchCall struct {
- s *Service
- profileId int64
- campaignId int64
- id int64
- landingpage *LandingPage
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing campaign landing page. This method
-// supports patch semantics.
-func (r *LandingPagesService) Patch(profileId int64, campaignId int64, id int64, landingpage *LandingPage) *LandingPagesPatchCall {
- c := &LandingPagesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.campaignId = campaignId
- c.id = id
- c.landingpage = landingpage
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LandingPagesPatchCall) Fields(s ...googleapi.Field) *LandingPagesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LandingPagesPatchCall) Context(ctx context.Context) *LandingPagesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LandingPagesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.landingpage)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/campaigns/{campaignId}/landingPages")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "campaignId": strconv.FormatInt(c.campaignId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.landingPages.patch" call.
-// Exactly one of *LandingPage or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *LandingPage.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *LandingPagesPatchCall) Do() (*LandingPage, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &LandingPage{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing campaign landing page. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.landingPages.patch",
- // "parameterOrder": [
- // "profileId",
- // "campaignId",
- // "id"
- // ],
- // "parameters": {
- // "campaignId": {
- // "description": "Landing page campaign ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "id": {
- // "description": "Landing page ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages",
- // "request": {
- // "$ref": "LandingPage"
- // },
- // "response": {
- // "$ref": "LandingPage"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.landingPages.update":
-
-type LandingPagesUpdateCall struct {
- s *Service
- profileId int64
- campaignId int64
- landingpage *LandingPage
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing campaign landing page.
-func (r *LandingPagesService) Update(profileId int64, campaignId int64, landingpage *LandingPage) *LandingPagesUpdateCall {
- c := &LandingPagesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.campaignId = campaignId
- c.landingpage = landingpage
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LandingPagesUpdateCall) Fields(s ...googleapi.Field) *LandingPagesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LandingPagesUpdateCall) Context(ctx context.Context) *LandingPagesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LandingPagesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.landingpage)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/campaigns/{campaignId}/landingPages")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "campaignId": strconv.FormatInt(c.campaignId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.landingPages.update" call.
-// Exactly one of *LandingPage or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *LandingPage.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *LandingPagesUpdateCall) Do() (*LandingPage, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &LandingPage{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing campaign landing page.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.landingPages.update",
- // "parameterOrder": [
- // "profileId",
- // "campaignId"
- // ],
- // "parameters": {
- // "campaignId": {
- // "description": "Landing page campaign ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages",
- // "request": {
- // "$ref": "LandingPage"
- // },
- // "response": {
- // "$ref": "LandingPage"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.metros.list":
-
-type MetrosListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of metros.
-func (r *MetrosService) List(profileId int64) *MetrosListCall {
- c := &MetrosListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MetrosListCall) Fields(s ...googleapi.Field) *MetrosListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MetrosListCall) IfNoneMatch(entityTag string) *MetrosListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MetrosListCall) Context(ctx context.Context) *MetrosListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MetrosListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/metros")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.metros.list" call.
-// Exactly one of *MetrosListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *MetrosListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MetrosListCall) Do() (*MetrosListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &MetrosListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of metros.",
- // "httpMethod": "GET",
- // "id": "dfareporting.metros.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/metros",
- // "response": {
- // "$ref": "MetrosListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.mobileCarriers.list":
-
-type MobileCarriersListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of mobile carriers.
-func (r *MobileCarriersService) List(profileId int64) *MobileCarriersListCall {
- c := &MobileCarriersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MobileCarriersListCall) Fields(s ...googleapi.Field) *MobileCarriersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MobileCarriersListCall) IfNoneMatch(entityTag string) *MobileCarriersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MobileCarriersListCall) Context(ctx context.Context) *MobileCarriersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MobileCarriersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/mobileCarriers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.mobileCarriers.list" call.
-// Exactly one of *MobileCarriersListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *MobileCarriersListResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MobileCarriersListCall) Do() (*MobileCarriersListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &MobileCarriersListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of mobile carriers.",
- // "httpMethod": "GET",
- // "id": "dfareporting.mobileCarriers.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/mobileCarriers",
- // "response": {
- // "$ref": "MobileCarriersListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.operatingSystemVersions.list":
-
-type OperatingSystemVersionsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of operating system versions.
-func (r *OperatingSystemVersionsService) List(profileId int64) *OperatingSystemVersionsListCall {
- c := &OperatingSystemVersionsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OperatingSystemVersionsListCall) Fields(s ...googleapi.Field) *OperatingSystemVersionsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OperatingSystemVersionsListCall) IfNoneMatch(entityTag string) *OperatingSystemVersionsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OperatingSystemVersionsListCall) Context(ctx context.Context) *OperatingSystemVersionsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OperatingSystemVersionsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/operatingSystemVersions")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.operatingSystemVersions.list" call.
-// Exactly one of *OperatingSystemVersionsListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *OperatingSystemVersionsListResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *OperatingSystemVersionsListCall) Do() (*OperatingSystemVersionsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OperatingSystemVersionsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of operating system versions.",
- // "httpMethod": "GET",
- // "id": "dfareporting.operatingSystemVersions.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/operatingSystemVersions",
- // "response": {
- // "$ref": "OperatingSystemVersionsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.operatingSystems.list":
-
-type OperatingSystemsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of operating systems.
-func (r *OperatingSystemsService) List(profileId int64) *OperatingSystemsListCall {
- c := &OperatingSystemsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OperatingSystemsListCall) Fields(s ...googleapi.Field) *OperatingSystemsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OperatingSystemsListCall) IfNoneMatch(entityTag string) *OperatingSystemsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OperatingSystemsListCall) Context(ctx context.Context) *OperatingSystemsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OperatingSystemsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/operatingSystems")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.operatingSystems.list" call.
-// Exactly one of *OperatingSystemsListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *OperatingSystemsListResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OperatingSystemsListCall) Do() (*OperatingSystemsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OperatingSystemsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of operating systems.",
- // "httpMethod": "GET",
- // "id": "dfareporting.operatingSystems.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/operatingSystems",
- // "response": {
- // "$ref": "OperatingSystemsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placementGroups.get":
-
-type PlacementGroupsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one placement group by ID.
-func (r *PlacementGroupsService) Get(profileId int64, id int64) *PlacementGroupsGetCall {
- c := &PlacementGroupsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementGroupsGetCall) Fields(s ...googleapi.Field) *PlacementGroupsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PlacementGroupsGetCall) IfNoneMatch(entityTag string) *PlacementGroupsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementGroupsGetCall) Context(ctx context.Context) *PlacementGroupsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementGroupsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placementGroups/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placementGroups.get" call.
-// Exactly one of *PlacementGroup or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *PlacementGroup.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PlacementGroupsGetCall) Do() (*PlacementGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PlacementGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one placement group by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.placementGroups.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Placement group ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placementGroups/{id}",
- // "response": {
- // "$ref": "PlacementGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placementGroups.insert":
-
-type PlacementGroupsInsertCall struct {
- s *Service
- profileId int64
- placementgroup *PlacementGroup
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new placement group.
-func (r *PlacementGroupsService) Insert(profileId int64, placementgroup *PlacementGroup) *PlacementGroupsInsertCall {
- c := &PlacementGroupsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.placementgroup = placementgroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementGroupsInsertCall) Fields(s ...googleapi.Field) *PlacementGroupsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementGroupsInsertCall) Context(ctx context.Context) *PlacementGroupsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementGroupsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.placementgroup)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placementGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placementGroups.insert" call.
-// Exactly one of *PlacementGroup or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *PlacementGroup.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PlacementGroupsInsertCall) Do() (*PlacementGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PlacementGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new placement group.",
- // "httpMethod": "POST",
- // "id": "dfareporting.placementGroups.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placementGroups",
- // "request": {
- // "$ref": "PlacementGroup"
- // },
- // "response": {
- // "$ref": "PlacementGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placementGroups.list":
-
-type PlacementGroupsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of placement groups, possibly filtered.
-func (r *PlacementGroupsService) List(profileId int64) *PlacementGroupsListCall {
- c := &PlacementGroupsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// AdvertiserIds sets the optional parameter "advertiserIds": Select
-// only placement groups that belong to these advertisers.
-func (c *PlacementGroupsListCall) AdvertiserIds(advertiserIds int64) *PlacementGroupsListCall {
- c.opt_["advertiserIds"] = advertiserIds
- return c
-}
-
-// Archived sets the optional parameter "archived": Select only archived
-// placements. Don't set this field to select both archived and
-// non-archived placements.
-func (c *PlacementGroupsListCall) Archived(archived bool) *PlacementGroupsListCall {
- c.opt_["archived"] = archived
- return c
-}
-
-// CampaignIds sets the optional parameter "campaignIds": Select only
-// placement groups that belong to these campaigns.
-func (c *PlacementGroupsListCall) CampaignIds(campaignIds int64) *PlacementGroupsListCall {
- c.opt_["campaignIds"] = campaignIds
- return c
-}
-
-// ContentCategoryIds sets the optional parameter "contentCategoryIds":
-// Select only placement groups that are associated with these content
-// categories.
-func (c *PlacementGroupsListCall) ContentCategoryIds(contentCategoryIds int64) *PlacementGroupsListCall {
- c.opt_["contentCategoryIds"] = contentCategoryIds
- return c
-}
-
-// DirectorySiteIds sets the optional parameter "directorySiteIds":
-// Select only placement groups that are associated with these directory
-// sites.
-func (c *PlacementGroupsListCall) DirectorySiteIds(directorySiteIds int64) *PlacementGroupsListCall {
- c.opt_["directorySiteIds"] = directorySiteIds
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only placement groups
-// with these IDs.
-func (c *PlacementGroupsListCall) Ids(ids int64) *PlacementGroupsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *PlacementGroupsListCall) MaxResults(maxResults int64) *PlacementGroupsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *PlacementGroupsListCall) PageToken(pageToken string) *PlacementGroupsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// PlacementGroupType sets the optional parameter "placementGroupType":
-// Select only placement groups belonging with this group type. A
-// package is a simple group of placements that acts as a single pricing
-// point for a group of tags. A roadblock is a group of placements that
-// not only acts as a single pricing point but also assumes that all the
-// tags in it will be served at the same time. A roadblock requires one
-// of its assigned placements to be marked as primary for reporting.
-//
-// Possible values:
-// "PLACEMENT_PACKAGE"
-// "PLACEMENT_ROADBLOCK"
-func (c *PlacementGroupsListCall) PlacementGroupType(placementGroupType string) *PlacementGroupsListCall {
- c.opt_["placementGroupType"] = placementGroupType
- return c
-}
-
-// PlacementStrategyIds sets the optional parameter
-// "placementStrategyIds": Select only placement groups that are
-// associated with these placement strategies.
-func (c *PlacementGroupsListCall) PlacementStrategyIds(placementStrategyIds int64) *PlacementGroupsListCall {
- c.opt_["placementStrategyIds"] = placementStrategyIds
- return c
-}
-
-// PricingTypes sets the optional parameter "pricingTypes": Select only
-// placement groups with these pricing types.
-//
-// Possible values:
-// "PRICING_TYPE_CPA"
-// "PRICING_TYPE_CPC"
-// "PRICING_TYPE_CPM"
-// "PRICING_TYPE_FLAT_RATE_CLICKS"
-// "PRICING_TYPE_FLAT_RATE_IMPRESSIONS"
-func (c *PlacementGroupsListCall) PricingTypes(pricingTypes string) *PlacementGroupsListCall {
- c.opt_["pricingTypes"] = pricingTypes
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for placement groups by name or ID. Wildcards (*) are
-// allowed. For example, "placement*2015" will return placement groups
-// with names like "placement group June 2015", "placement group May
-// 2015", or simply "placements 2015". Most of the searches also add
-// wildcards implicitly at the start and the end of the search string.
-// For example, a search string of "placementgroup" will match placement
-// groups with name "my placementgroup", "placementgroup 2015", or
-// simply "placementgroup".
-func (c *PlacementGroupsListCall) SearchString(searchString string) *PlacementGroupsListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SiteIds sets the optional parameter "siteIds": Select only placement
-// groups that are associated with these sites.
-func (c *PlacementGroupsListCall) SiteIds(siteIds int64) *PlacementGroupsListCall {
- c.opt_["siteIds"] = siteIds
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *PlacementGroupsListCall) SortField(sortField string) *PlacementGroupsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *PlacementGroupsListCall) SortOrder(sortOrder string) *PlacementGroupsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementGroupsListCall) Fields(s ...googleapi.Field) *PlacementGroupsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PlacementGroupsListCall) IfNoneMatch(entityTag string) *PlacementGroupsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementGroupsListCall) Context(ctx context.Context) *PlacementGroupsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementGroupsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["advertiserIds"]; ok {
- params.Set("advertiserIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["archived"]; ok {
- params.Set("archived", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["campaignIds"]; ok {
- params.Set("campaignIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["contentCategoryIds"]; ok {
- params.Set("contentCategoryIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["directorySiteIds"]; ok {
- params.Set("directorySiteIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["placementGroupType"]; ok {
- params.Set("placementGroupType", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["placementStrategyIds"]; ok {
- params.Set("placementStrategyIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pricingTypes"]; ok {
- params.Set("pricingTypes", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["siteIds"]; ok {
- params.Set("siteIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placementGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placementGroups.list" call.
-// Exactly one of *PlacementGroupsListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *PlacementGroupsListResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PlacementGroupsListCall) Do() (*PlacementGroupsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PlacementGroupsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of placement groups, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.placementGroups.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "advertiserIds": {
- // "description": "Select only placement groups that belong to these advertisers.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "archived": {
- // "description": "Select only archived placements. Don't set this field to select both archived and non-archived placements.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "campaignIds": {
- // "description": "Select only placement groups that belong to these campaigns.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "contentCategoryIds": {
- // "description": "Select only placement groups that are associated with these content categories.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "directorySiteIds": {
- // "description": "Select only placement groups that are associated with these directory sites.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only placement groups with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "placementGroupType": {
- // "description": "Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.",
- // "enum": [
- // "PLACEMENT_PACKAGE",
- // "PLACEMENT_ROADBLOCK"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "placementStrategyIds": {
- // "description": "Select only placement groups that are associated with these placement strategies.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "pricingTypes": {
- // "description": "Select only placement groups with these pricing types.",
- // "enum": [
- // "PRICING_TYPE_CPA",
- // "PRICING_TYPE_CPC",
- // "PRICING_TYPE_CPM",
- // "PRICING_TYPE_FLAT_RATE_CLICKS",
- // "PRICING_TYPE_FLAT_RATE_IMPRESSIONS"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, \"placement*2015\" will return placement groups with names like \"placement group June 2015\", \"placement group May 2015\", or simply \"placements 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placementgroup\" will match placement groups with name \"my placementgroup\", \"placementgroup 2015\", or simply \"placementgroup\".",
- // "location": "query",
- // "type": "string"
- // },
- // "siteIds": {
- // "description": "Select only placement groups that are associated with these sites.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placementGroups",
- // "response": {
- // "$ref": "PlacementGroupsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placementGroups.patch":
-
-type PlacementGroupsPatchCall struct {
- s *Service
- profileId int64
- id int64
- placementgroup *PlacementGroup
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing placement group. This method supports
-// patch semantics.
-func (r *PlacementGroupsService) Patch(profileId int64, id int64, placementgroup *PlacementGroup) *PlacementGroupsPatchCall {
- c := &PlacementGroupsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.placementgroup = placementgroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementGroupsPatchCall) Fields(s ...googleapi.Field) *PlacementGroupsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementGroupsPatchCall) Context(ctx context.Context) *PlacementGroupsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementGroupsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.placementgroup)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placementGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placementGroups.patch" call.
-// Exactly one of *PlacementGroup or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *PlacementGroup.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PlacementGroupsPatchCall) Do() (*PlacementGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PlacementGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing placement group. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.placementGroups.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Placement group ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placementGroups",
- // "request": {
- // "$ref": "PlacementGroup"
- // },
- // "response": {
- // "$ref": "PlacementGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placementGroups.update":
-
-type PlacementGroupsUpdateCall struct {
- s *Service
- profileId int64
- placementgroup *PlacementGroup
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing placement group.
-func (r *PlacementGroupsService) Update(profileId int64, placementgroup *PlacementGroup) *PlacementGroupsUpdateCall {
- c := &PlacementGroupsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.placementgroup = placementgroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementGroupsUpdateCall) Fields(s ...googleapi.Field) *PlacementGroupsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementGroupsUpdateCall) Context(ctx context.Context) *PlacementGroupsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementGroupsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.placementgroup)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placementGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placementGroups.update" call.
-// Exactly one of *PlacementGroup or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *PlacementGroup.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PlacementGroupsUpdateCall) Do() (*PlacementGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PlacementGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing placement group.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.placementGroups.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placementGroups",
- // "request": {
- // "$ref": "PlacementGroup"
- // },
- // "response": {
- // "$ref": "PlacementGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placementStrategies.delete":
-
-type PlacementStrategiesDeleteCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an existing placement strategy.
-func (r *PlacementStrategiesService) Delete(profileId int64, id int64) *PlacementStrategiesDeleteCall {
- c := &PlacementStrategiesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementStrategiesDeleteCall) Fields(s ...googleapi.Field) *PlacementStrategiesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementStrategiesDeleteCall) Context(ctx context.Context) *PlacementStrategiesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementStrategiesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placementStrategies/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placementStrategies.delete" call.
-func (c *PlacementStrategiesDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes an existing placement strategy.",
- // "httpMethod": "DELETE",
- // "id": "dfareporting.placementStrategies.delete",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Placement strategy ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placementStrategies/{id}",
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placementStrategies.get":
-
-type PlacementStrategiesGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one placement strategy by ID.
-func (r *PlacementStrategiesService) Get(profileId int64, id int64) *PlacementStrategiesGetCall {
- c := &PlacementStrategiesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementStrategiesGetCall) Fields(s ...googleapi.Field) *PlacementStrategiesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PlacementStrategiesGetCall) IfNoneMatch(entityTag string) *PlacementStrategiesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementStrategiesGetCall) Context(ctx context.Context) *PlacementStrategiesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementStrategiesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placementStrategies/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placementStrategies.get" call.
-// Exactly one of *PlacementStrategy or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *PlacementStrategy.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PlacementStrategiesGetCall) Do() (*PlacementStrategy, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PlacementStrategy{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one placement strategy by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.placementStrategies.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Placement strategy ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placementStrategies/{id}",
- // "response": {
- // "$ref": "PlacementStrategy"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placementStrategies.insert":
-
-type PlacementStrategiesInsertCall struct {
- s *Service
- profileId int64
- placementstrategy *PlacementStrategy
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new placement strategy.
-func (r *PlacementStrategiesService) Insert(profileId int64, placementstrategy *PlacementStrategy) *PlacementStrategiesInsertCall {
- c := &PlacementStrategiesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.placementstrategy = placementstrategy
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementStrategiesInsertCall) Fields(s ...googleapi.Field) *PlacementStrategiesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementStrategiesInsertCall) Context(ctx context.Context) *PlacementStrategiesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementStrategiesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.placementstrategy)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placementStrategies")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placementStrategies.insert" call.
-// Exactly one of *PlacementStrategy or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *PlacementStrategy.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PlacementStrategiesInsertCall) Do() (*PlacementStrategy, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PlacementStrategy{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new placement strategy.",
- // "httpMethod": "POST",
- // "id": "dfareporting.placementStrategies.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placementStrategies",
- // "request": {
- // "$ref": "PlacementStrategy"
- // },
- // "response": {
- // "$ref": "PlacementStrategy"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placementStrategies.list":
-
-type PlacementStrategiesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of placement strategies, possibly filtered.
-func (r *PlacementStrategiesService) List(profileId int64) *PlacementStrategiesListCall {
- c := &PlacementStrategiesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only placement
-// strategies with these IDs.
-func (c *PlacementStrategiesListCall) Ids(ids int64) *PlacementStrategiesListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *PlacementStrategiesListCall) MaxResults(maxResults int64) *PlacementStrategiesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *PlacementStrategiesListCall) PageToken(pageToken string) *PlacementStrategiesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name or ID. Wildcards (*) are allowed. For
-// example, "placementstrategy*2015" will return objects with names like
-// "placementstrategy June 2015", "placementstrategy April 2015", or
-// simply "placementstrategy 2015". Most of the searches also add
-// wildcards implicitly at the start and the end of the search string.
-// For example, a search string of "placementstrategy" will match
-// objects with name "my placementstrategy", "placementstrategy 2015",
-// or simply "placementstrategy".
-func (c *PlacementStrategiesListCall) SearchString(searchString string) *PlacementStrategiesListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *PlacementStrategiesListCall) SortField(sortField string) *PlacementStrategiesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *PlacementStrategiesListCall) SortOrder(sortOrder string) *PlacementStrategiesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementStrategiesListCall) Fields(s ...googleapi.Field) *PlacementStrategiesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PlacementStrategiesListCall) IfNoneMatch(entityTag string) *PlacementStrategiesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementStrategiesListCall) Context(ctx context.Context) *PlacementStrategiesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementStrategiesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placementStrategies")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placementStrategies.list" call.
-// Exactly one of *PlacementStrategiesListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *PlacementStrategiesListResponse.ServerResponse.Header or (if
-// a response was returned at all) in error.(*googleapi.Error).Header.
-// Use googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PlacementStrategiesListCall) Do() (*PlacementStrategiesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PlacementStrategiesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of placement strategies, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.placementStrategies.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "ids": {
- // "description": "Select only placement strategies with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"placementstrategy*2015\" will return objects with names like \"placementstrategy June 2015\", \"placementstrategy April 2015\", or simply \"placementstrategy 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placementstrategy\" will match objects with name \"my placementstrategy\", \"placementstrategy 2015\", or simply \"placementstrategy\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placementStrategies",
- // "response": {
- // "$ref": "PlacementStrategiesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placementStrategies.patch":
-
-type PlacementStrategiesPatchCall struct {
- s *Service
- profileId int64
- id int64
- placementstrategy *PlacementStrategy
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing placement strategy. This method supports
-// patch semantics.
-func (r *PlacementStrategiesService) Patch(profileId int64, id int64, placementstrategy *PlacementStrategy) *PlacementStrategiesPatchCall {
- c := &PlacementStrategiesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.placementstrategy = placementstrategy
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementStrategiesPatchCall) Fields(s ...googleapi.Field) *PlacementStrategiesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementStrategiesPatchCall) Context(ctx context.Context) *PlacementStrategiesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementStrategiesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.placementstrategy)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placementStrategies")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placementStrategies.patch" call.
-// Exactly one of *PlacementStrategy or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *PlacementStrategy.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PlacementStrategiesPatchCall) Do() (*PlacementStrategy, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PlacementStrategy{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing placement strategy. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.placementStrategies.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Placement strategy ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placementStrategies",
- // "request": {
- // "$ref": "PlacementStrategy"
- // },
- // "response": {
- // "$ref": "PlacementStrategy"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placementStrategies.update":
-
-type PlacementStrategiesUpdateCall struct {
- s *Service
- profileId int64
- placementstrategy *PlacementStrategy
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing placement strategy.
-func (r *PlacementStrategiesService) Update(profileId int64, placementstrategy *PlacementStrategy) *PlacementStrategiesUpdateCall {
- c := &PlacementStrategiesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.placementstrategy = placementstrategy
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementStrategiesUpdateCall) Fields(s ...googleapi.Field) *PlacementStrategiesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementStrategiesUpdateCall) Context(ctx context.Context) *PlacementStrategiesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementStrategiesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.placementstrategy)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placementStrategies")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placementStrategies.update" call.
-// Exactly one of *PlacementStrategy or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *PlacementStrategy.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PlacementStrategiesUpdateCall) Do() (*PlacementStrategy, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PlacementStrategy{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing placement strategy.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.placementStrategies.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placementStrategies",
- // "request": {
- // "$ref": "PlacementStrategy"
- // },
- // "response": {
- // "$ref": "PlacementStrategy"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placements.generatetags":
-
-type PlacementsGeneratetagsCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Generatetags: Generates tags for a placement.
-func (r *PlacementsService) Generatetags(profileId int64) *PlacementsGeneratetagsCall {
- c := &PlacementsGeneratetagsCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// CampaignId sets the optional parameter "campaignId": Generate
-// placements belonging to this campaign. This is a required field.
-func (c *PlacementsGeneratetagsCall) CampaignId(campaignId int64) *PlacementsGeneratetagsCall {
- c.opt_["campaignId"] = campaignId
- return c
-}
-
-// PlacementIds sets the optional parameter "placementIds": Generate
-// tags for these placements.
-func (c *PlacementsGeneratetagsCall) PlacementIds(placementIds int64) *PlacementsGeneratetagsCall {
- c.opt_["placementIds"] = placementIds
- return c
-}
-
-// TagFormats sets the optional parameter "tagFormats": Tag formats to
-// generate for these placements.
-//
-// Possible values:
-// "PLACEMENT_TAG_CLICK_COMMANDS"
-// "PLACEMENT_TAG_IFRAME_ILAYER"
-// "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
-// "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY"
-// "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
-// "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3"
-// "PLACEMENT_TAG_INTERNAL_REDIRECT"
-// "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
-// "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY"
-// "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
-// "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
-// "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY"
-// "PLACEMENT_TAG_JAVASCRIPT"
-// "PLACEMENT_TAG_JAVASCRIPT_LEGACY"
-// "PLACEMENT_TAG_STANDARD"
-// "PLACEMENT_TAG_TRACKING"
-// "PLACEMENT_TAG_TRACKING_IFRAME"
-// "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
-func (c *PlacementsGeneratetagsCall) TagFormats(tagFormats string) *PlacementsGeneratetagsCall {
- c.opt_["tagFormats"] = tagFormats
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementsGeneratetagsCall) Fields(s ...googleapi.Field) *PlacementsGeneratetagsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementsGeneratetagsCall) Context(ctx context.Context) *PlacementsGeneratetagsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementsGeneratetagsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["campaignId"]; ok {
- params.Set("campaignId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["placementIds"]; ok {
- params.Set("placementIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["tagFormats"]; ok {
- params.Set("tagFormats", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placements/generatetags")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placements.generatetags" call.
-// Exactly one of *PlacementsGenerateTagsResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *PlacementsGenerateTagsResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PlacementsGeneratetagsCall) Do() (*PlacementsGenerateTagsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PlacementsGenerateTagsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Generates tags for a placement.",
- // "httpMethod": "POST",
- // "id": "dfareporting.placements.generatetags",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "campaignId": {
- // "description": "Generate placements belonging to this campaign. This is a required field.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "placementIds": {
- // "description": "Generate tags for these placements.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "tagFormats": {
- // "description": "Tag formats to generate for these placements.",
- // "enum": [
- // "PLACEMENT_TAG_CLICK_COMMANDS",
- // "PLACEMENT_TAG_IFRAME_ILAYER",
- // "PLACEMENT_TAG_IFRAME_JAVASCRIPT",
- // "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
- // "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
- // "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
- // "PLACEMENT_TAG_INTERNAL_REDIRECT",
- // "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
- // "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
- // "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
- // "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
- // "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
- // "PLACEMENT_TAG_JAVASCRIPT",
- // "PLACEMENT_TAG_JAVASCRIPT_LEGACY",
- // "PLACEMENT_TAG_STANDARD",
- // "PLACEMENT_TAG_TRACKING",
- // "PLACEMENT_TAG_TRACKING_IFRAME",
- // "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placements/generatetags",
- // "response": {
- // "$ref": "PlacementsGenerateTagsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placements.get":
-
-type PlacementsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one placement by ID.
-func (r *PlacementsService) Get(profileId int64, id int64) *PlacementsGetCall {
- c := &PlacementsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementsGetCall) Fields(s ...googleapi.Field) *PlacementsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PlacementsGetCall) IfNoneMatch(entityTag string) *PlacementsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementsGetCall) Context(ctx context.Context) *PlacementsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placements/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placements.get" call.
-// Exactly one of *Placement or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Placement.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *PlacementsGetCall) Do() (*Placement, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Placement{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one placement by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.placements.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Placement ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placements/{id}",
- // "response": {
- // "$ref": "Placement"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placements.insert":
-
-type PlacementsInsertCall struct {
- s *Service
- profileId int64
- placement *Placement
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new placement.
-func (r *PlacementsService) Insert(profileId int64, placement *Placement) *PlacementsInsertCall {
- c := &PlacementsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.placement = placement
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementsInsertCall) Fields(s ...googleapi.Field) *PlacementsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementsInsertCall) Context(ctx context.Context) *PlacementsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.placement)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placements")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placements.insert" call.
-// Exactly one of *Placement or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Placement.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *PlacementsInsertCall) Do() (*Placement, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Placement{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new placement.",
- // "httpMethod": "POST",
- // "id": "dfareporting.placements.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placements",
- // "request": {
- // "$ref": "Placement"
- // },
- // "response": {
- // "$ref": "Placement"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placements.list":
-
-type PlacementsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of placements, possibly filtered.
-func (r *PlacementsService) List(profileId int64) *PlacementsListCall {
- c := &PlacementsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// AdvertiserIds sets the optional parameter "advertiserIds": Select
-// only placements that belong to these advertisers.
-func (c *PlacementsListCall) AdvertiserIds(advertiserIds int64) *PlacementsListCall {
- c.opt_["advertiserIds"] = advertiserIds
- return c
-}
-
-// Archived sets the optional parameter "archived": Select only archived
-// placements. Don't set this field to select both archived and
-// non-archived placements.
-func (c *PlacementsListCall) Archived(archived bool) *PlacementsListCall {
- c.opt_["archived"] = archived
- return c
-}
-
-// CampaignIds sets the optional parameter "campaignIds": Select only
-// placements that belong to these campaigns.
-func (c *PlacementsListCall) CampaignIds(campaignIds int64) *PlacementsListCall {
- c.opt_["campaignIds"] = campaignIds
- return c
-}
-
-// Compatibilities sets the optional parameter "compatibilities": Select
-// only placements that are associated with these compatibilities. WEB
-// and WEB_INTERSTITIAL refer to rendering either on desktop or on
-// mobile devices for regular or interstitial ads respectively. APP and
-// APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO
-// refers to rendering in in-stream video ads developed with the VAST
-// standard.
-//
-// Possible values:
-// "APP"
-// "APP_INTERSTITIAL"
-// "IN_STREAM_VIDEO"
-// "WEB"
-// "WEB_INTERSTITIAL"
-func (c *PlacementsListCall) Compatibilities(compatibilities string) *PlacementsListCall {
- c.opt_["compatibilities"] = compatibilities
- return c
-}
-
-// ContentCategoryIds sets the optional parameter "contentCategoryIds":
-// Select only placements that are associated with these content
-// categories.
-func (c *PlacementsListCall) ContentCategoryIds(contentCategoryIds int64) *PlacementsListCall {
- c.opt_["contentCategoryIds"] = contentCategoryIds
- return c
-}
-
-// DirectorySiteIds sets the optional parameter "directorySiteIds":
-// Select only placements that are associated with these directory
-// sites.
-func (c *PlacementsListCall) DirectorySiteIds(directorySiteIds int64) *PlacementsListCall {
- c.opt_["directorySiteIds"] = directorySiteIds
- return c
-}
-
-// GroupIds sets the optional parameter "groupIds": Select only
-// placements that belong to these placement groups.
-func (c *PlacementsListCall) GroupIds(groupIds int64) *PlacementsListCall {
- c.opt_["groupIds"] = groupIds
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only placements with
-// these IDs.
-func (c *PlacementsListCall) Ids(ids int64) *PlacementsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *PlacementsListCall) MaxResults(maxResults int64) *PlacementsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *PlacementsListCall) PageToken(pageToken string) *PlacementsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// PaymentSource sets the optional parameter "paymentSource": Select
-// only placements with this payment source.
-//
-// Possible values:
-// "PLACEMENT_AGENCY_PAID"
-// "PLACEMENT_PUBLISHER_PAID"
-func (c *PlacementsListCall) PaymentSource(paymentSource string) *PlacementsListCall {
- c.opt_["paymentSource"] = paymentSource
- return c
-}
-
-// PlacementStrategyIds sets the optional parameter
-// "placementStrategyIds": Select only placements that are associated
-// with these placement strategies.
-func (c *PlacementsListCall) PlacementStrategyIds(placementStrategyIds int64) *PlacementsListCall {
- c.opt_["placementStrategyIds"] = placementStrategyIds
- return c
-}
-
-// PricingTypes sets the optional parameter "pricingTypes": Select only
-// placements with these pricing types.
-//
-// Possible values:
-// "PRICING_TYPE_CPA"
-// "PRICING_TYPE_CPC"
-// "PRICING_TYPE_CPM"
-// "PRICING_TYPE_FLAT_RATE_CLICKS"
-// "PRICING_TYPE_FLAT_RATE_IMPRESSIONS"
-func (c *PlacementsListCall) PricingTypes(pricingTypes string) *PlacementsListCall {
- c.opt_["pricingTypes"] = pricingTypes
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for placements by name or ID. Wildcards (*) are allowed.
-// For example, "placement*2015" will return placements with names like
-// "placement June 2015", "placement May 2015", or simply "placements
-// 2015". Most of the searches also add wildcards implicitly at the
-// start and the end of the search string. For example, a search string
-// of "placement" will match placements with name "my placement",
-// "placement 2015", or simply "placement".
-func (c *PlacementsListCall) SearchString(searchString string) *PlacementsListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SiteIds sets the optional parameter "siteIds": Select only placements
-// that are associated with these sites.
-func (c *PlacementsListCall) SiteIds(siteIds int64) *PlacementsListCall {
- c.opt_["siteIds"] = siteIds
- return c
-}
-
-// SizeIds sets the optional parameter "sizeIds": Select only placements
-// that are associated with these sizes.
-func (c *PlacementsListCall) SizeIds(sizeIds int64) *PlacementsListCall {
- c.opt_["sizeIds"] = sizeIds
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *PlacementsListCall) SortField(sortField string) *PlacementsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *PlacementsListCall) SortOrder(sortOrder string) *PlacementsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementsListCall) Fields(s ...googleapi.Field) *PlacementsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PlacementsListCall) IfNoneMatch(entityTag string) *PlacementsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementsListCall) Context(ctx context.Context) *PlacementsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["advertiserIds"]; ok {
- params.Set("advertiserIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["archived"]; ok {
- params.Set("archived", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["campaignIds"]; ok {
- params.Set("campaignIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["compatibilities"]; ok {
- params.Set("compatibilities", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["contentCategoryIds"]; ok {
- params.Set("contentCategoryIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["directorySiteIds"]; ok {
- params.Set("directorySiteIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["groupIds"]; ok {
- params.Set("groupIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["paymentSource"]; ok {
- params.Set("paymentSource", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["placementStrategyIds"]; ok {
- params.Set("placementStrategyIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pricingTypes"]; ok {
- params.Set("pricingTypes", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["siteIds"]; ok {
- params.Set("siteIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sizeIds"]; ok {
- params.Set("sizeIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placements")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placements.list" call.
-// Exactly one of *PlacementsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *PlacementsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PlacementsListCall) Do() (*PlacementsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PlacementsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of placements, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.placements.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "advertiserIds": {
- // "description": "Select only placements that belong to these advertisers.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "archived": {
- // "description": "Select only archived placements. Don't set this field to select both archived and non-archived placements.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "campaignIds": {
- // "description": "Select only placements that belong to these campaigns.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "compatibilities": {
- // "description": "Select only placements that are associated with these compatibilities. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.",
- // "enum": [
- // "APP",
- // "APP_INTERSTITIAL",
- // "IN_STREAM_VIDEO",
- // "WEB",
- // "WEB_INTERSTITIAL"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "contentCategoryIds": {
- // "description": "Select only placements that are associated with these content categories.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "directorySiteIds": {
- // "description": "Select only placements that are associated with these directory sites.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "groupIds": {
- // "description": "Select only placements that belong to these placement groups.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only placements with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "paymentSource": {
- // "description": "Select only placements with this payment source.",
- // "enum": [
- // "PLACEMENT_AGENCY_PAID",
- // "PLACEMENT_PUBLISHER_PAID"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "placementStrategyIds": {
- // "description": "Select only placements that are associated with these placement strategies.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "pricingTypes": {
- // "description": "Select only placements with these pricing types.",
- // "enum": [
- // "PRICING_TYPE_CPA",
- // "PRICING_TYPE_CPC",
- // "PRICING_TYPE_CPM",
- // "PRICING_TYPE_FLAT_RATE_CLICKS",
- // "PRICING_TYPE_FLAT_RATE_IMPRESSIONS"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, \"placement*2015\" will return placements with names like \"placement June 2015\", \"placement May 2015\", or simply \"placements 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placement\" will match placements with name \"my placement\", \"placement 2015\", or simply \"placement\".",
- // "location": "query",
- // "type": "string"
- // },
- // "siteIds": {
- // "description": "Select only placements that are associated with these sites.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "sizeIds": {
- // "description": "Select only placements that are associated with these sizes.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placements",
- // "response": {
- // "$ref": "PlacementsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placements.patch":
-
-type PlacementsPatchCall struct {
- s *Service
- profileId int64
- id int64
- placement *Placement
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing placement. This method supports patch
-// semantics.
-func (r *PlacementsService) Patch(profileId int64, id int64, placement *Placement) *PlacementsPatchCall {
- c := &PlacementsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.placement = placement
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementsPatchCall) Fields(s ...googleapi.Field) *PlacementsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementsPatchCall) Context(ctx context.Context) *PlacementsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.placement)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placements")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placements.patch" call.
-// Exactly one of *Placement or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Placement.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *PlacementsPatchCall) Do() (*Placement, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Placement{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing placement. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.placements.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Placement ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placements",
- // "request": {
- // "$ref": "Placement"
- // },
- // "response": {
- // "$ref": "Placement"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placements.update":
-
-type PlacementsUpdateCall struct {
- s *Service
- profileId int64
- placement *Placement
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing placement.
-func (r *PlacementsService) Update(profileId int64, placement *Placement) *PlacementsUpdateCall {
- c := &PlacementsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.placement = placement
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementsUpdateCall) Fields(s ...googleapi.Field) *PlacementsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementsUpdateCall) Context(ctx context.Context) *PlacementsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.placement)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placements")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placements.update" call.
-// Exactly one of *Placement or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Placement.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *PlacementsUpdateCall) Do() (*Placement, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Placement{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing placement.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.placements.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placements",
- // "request": {
- // "$ref": "Placement"
- // },
- // "response": {
- // "$ref": "Placement"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.platformTypes.list":
-
-type PlatformTypesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of platform types.
-func (r *PlatformTypesService) List(profileId int64) *PlatformTypesListCall {
- c := &PlatformTypesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlatformTypesListCall) Fields(s ...googleapi.Field) *PlatformTypesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PlatformTypesListCall) IfNoneMatch(entityTag string) *PlatformTypesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlatformTypesListCall) Context(ctx context.Context) *PlatformTypesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlatformTypesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/platformTypes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.platformTypes.list" call.
-// Exactly one of *PlatformTypesListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *PlatformTypesListResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PlatformTypesListCall) Do() (*PlatformTypesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PlatformTypesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of platform types.",
- // "httpMethod": "GET",
- // "id": "dfareporting.platformTypes.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/platformTypes",
- // "response": {
- // "$ref": "PlatformTypesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.postalCodes.list":
-
-type PostalCodesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of postal codes.
-func (r *PostalCodesService) List(profileId int64) *PostalCodesListCall {
- c := &PostalCodesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PostalCodesListCall) Fields(s ...googleapi.Field) *PostalCodesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PostalCodesListCall) IfNoneMatch(entityTag string) *PostalCodesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PostalCodesListCall) Context(ctx context.Context) *PostalCodesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PostalCodesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/postalCodes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.postalCodes.list" call.
-// Exactly one of *PostalCodesListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *PostalCodesListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PostalCodesListCall) Do() (*PostalCodesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PostalCodesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of postal codes.",
- // "httpMethod": "GET",
- // "id": "dfareporting.postalCodes.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/postalCodes",
- // "response": {
- // "$ref": "PostalCodesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.regions.list":
-
-type RegionsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of regions.
-func (r *RegionsService) List(profileId int64) *RegionsListCall {
- c := &RegionsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RegionsListCall) Fields(s ...googleapi.Field) *RegionsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *RegionsListCall) IfNoneMatch(entityTag string) *RegionsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RegionsListCall) Context(ctx context.Context) *RegionsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RegionsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/regions")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.regions.list" call.
-// Exactly one of *RegionsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *RegionsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *RegionsListCall) Do() (*RegionsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &RegionsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of regions.",
- // "httpMethod": "GET",
- // "id": "dfareporting.regions.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/regions",
- // "response": {
- // "$ref": "RegionsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.delete":
-
-type ReportsDeleteCall struct {
- s *Service
- profileId int64
- reportId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes a report by its ID.
-func (r *ReportsService) Delete(profileId int64, reportId int64) *ReportsDeleteCall {
- c := &ReportsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsDeleteCall) Fields(s ...googleapi.Field) *ReportsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsDeleteCall) Context(ctx context.Context) *ReportsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.delete" call.
-func (c *ReportsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes a report by its ID.",
- // "httpMethod": "DELETE",
- // "id": "dfareporting.reports.delete",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.get":
-
-type ReportsGetCall struct {
- s *Service
- profileId int64
- reportId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves a report by its ID.
-func (r *ReportsService) Get(profileId int64, reportId int64) *ReportsGetCall {
- c := &ReportsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsGetCall) Fields(s ...googleapi.Field) *ReportsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsGetCall) IfNoneMatch(entityTag string) *ReportsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsGetCall) Context(ctx context.Context) *ReportsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.get" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsGetCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a report by its ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.reports.get",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}",
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.insert":
-
-type ReportsInsertCall struct {
- s *Service
- profileId int64
- report *Report
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a report.
-func (r *ReportsService) Insert(profileId int64, report *Report) *ReportsInsertCall {
- c := &ReportsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.report = report
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsInsertCall) Fields(s ...googleapi.Field) *ReportsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsInsertCall) Context(ctx context.Context) *ReportsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.report)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.insert" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsInsertCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a report.",
- // "httpMethod": "POST",
- // "id": "dfareporting.reports.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports",
- // "request": {
- // "$ref": "Report"
- // },
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.list":
-
-type ReportsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves list of reports.
-func (r *ReportsService) List(profileId int64) *ReportsListCall {
- c := &ReportsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *ReportsListCall) MaxResults(maxResults int64) *ReportsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous result page.
-func (c *ReportsListCall) PageToken(pageToken string) *ReportsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Scope sets the optional parameter "scope": The scope that defines
-// which results are returned, default is 'MINE'.
-//
-// Possible values:
-// "ALL" - All reports in account.
-// "MINE" (default) - My reports.
-func (c *ReportsListCall) Scope(scope string) *ReportsListCall {
- c.opt_["scope"] = scope
- return c
-}
-
-// SortField sets the optional parameter "sortField": The field by which
-// to sort the list.
-//
-// Possible values:
-// "ID" - Sort by report ID.
-// "LAST_MODIFIED_TIME" (default) - Sort by 'lastModifiedTime' field.
-// "NAME" - Sort by name of reports.
-func (c *ReportsListCall) SortField(sortField string) *ReportsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is 'DESCENDING'.
-//
-// Possible values:
-// "ASCENDING" - Ascending order.
-// "DESCENDING" (default) - Descending order.
-func (c *ReportsListCall) SortOrder(sortOrder string) *ReportsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsListCall) Fields(s ...googleapi.Field) *ReportsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsListCall) IfNoneMatch(entityTag string) *ReportsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsListCall) Context(ctx context.Context) *ReportsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["scope"]; ok {
- params.Set("scope", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.list" call.
-// Exactly one of *ReportList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ReportList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ReportsListCall) Do() (*ReportList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ReportList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves list of reports.",
- // "httpMethod": "GET",
- // "id": "dfareporting.reports.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "scope": {
- // "default": "MINE",
- // "description": "The scope that defines which results are returned, default is 'MINE'.",
- // "enum": [
- // "ALL",
- // "MINE"
- // ],
- // "enumDescriptions": [
- // "All reports in account.",
- // "My reports."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "default": "LAST_MODIFIED_TIME",
- // "description": "The field by which to sort the list.",
- // "enum": [
- // "ID",
- // "LAST_MODIFIED_TIME",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "Sort by report ID.",
- // "Sort by 'lastModifiedTime' field.",
- // "Sort by name of reports."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "default": "DESCENDING",
- // "description": "Order of sorted results, default is 'DESCENDING'.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "Ascending order.",
- // "Descending order."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports",
- // "response": {
- // "$ref": "ReportList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.patch":
-
-type ReportsPatchCall struct {
- s *Service
- profileId int64
- reportId int64
- report *Report
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates a report. This method supports patch semantics.
-func (r *ReportsService) Patch(profileId int64, reportId int64, report *Report) *ReportsPatchCall {
- c := &ReportsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- c.report = report
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsPatchCall) Fields(s ...googleapi.Field) *ReportsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsPatchCall) Context(ctx context.Context) *ReportsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.report)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.patch" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsPatchCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a report. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.reports.patch",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}",
- // "request": {
- // "$ref": "Report"
- // },
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.run":
-
-type ReportsRunCall struct {
- s *Service
- profileId int64
- reportId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Run: Runs a report.
-func (r *ReportsService) Run(profileId int64, reportId int64) *ReportsRunCall {
- c := &ReportsRunCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- return c
-}
-
-// Synchronous sets the optional parameter "synchronous": If set and
-// true, tries to run the report synchronously.
-func (c *ReportsRunCall) Synchronous(synchronous bool) *ReportsRunCall {
- c.opt_["synchronous"] = synchronous
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsRunCall) Fields(s ...googleapi.Field) *ReportsRunCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsRunCall) Context(ctx context.Context) *ReportsRunCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsRunCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["synchronous"]; ok {
- params.Set("synchronous", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}/run")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.run" call.
-// Exactly one of *File or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *File.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *ReportsRunCall) Do() (*File, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &File{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Runs a report.",
- // "httpMethod": "POST",
- // "id": "dfareporting.reports.run",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "synchronous": {
- // "description": "If set and true, tries to run the report synchronously.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}/run",
- // "response": {
- // "$ref": "File"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.update":
-
-type ReportsUpdateCall struct {
- s *Service
- profileId int64
- reportId int64
- report *Report
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates a report.
-func (r *ReportsService) Update(profileId int64, reportId int64, report *Report) *ReportsUpdateCall {
- c := &ReportsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- c.report = report
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsUpdateCall) Fields(s ...googleapi.Field) *ReportsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsUpdateCall) Context(ctx context.Context) *ReportsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.report)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.update" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsUpdateCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a report.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.reports.update",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}",
- // "request": {
- // "$ref": "Report"
- // },
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.compatibleFields.query":
-
-type ReportsCompatibleFieldsQueryCall struct {
- s *Service
- profileId int64
- report *Report
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Query: Returns the fields that are compatible to be selected in the
-// respective sections of a report criteria, given the fields already
-// selected in the input report and user permissions.
-func (r *ReportsCompatibleFieldsService) Query(profileId int64, report *Report) *ReportsCompatibleFieldsQueryCall {
- c := &ReportsCompatibleFieldsQueryCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.report = report
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsCompatibleFieldsQueryCall) Fields(s ...googleapi.Field) *ReportsCompatibleFieldsQueryCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsCompatibleFieldsQueryCall) Context(ctx context.Context) *ReportsCompatibleFieldsQueryCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsCompatibleFieldsQueryCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.report)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/compatiblefields/query")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.compatibleFields.query" call.
-// Exactly one of *CompatibleFields or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CompatibleFields.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ReportsCompatibleFieldsQueryCall) Do() (*CompatibleFields, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CompatibleFields{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.",
- // "httpMethod": "POST",
- // "id": "dfareporting.reports.compatibleFields.query",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/compatiblefields/query",
- // "request": {
- // "$ref": "Report"
- // },
- // "response": {
- // "$ref": "CompatibleFields"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.files.get":
-
-type ReportsFilesGetCall struct {
- s *Service
- profileId int64
- reportId int64
- fileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves a report file.
-func (r *ReportsFilesService) Get(profileId int64, reportId int64, fileId int64) *ReportsFilesGetCall {
- c := &ReportsFilesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- c.fileId = fileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsFilesGetCall) Fields(s ...googleapi.Field) *ReportsFilesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsFilesGetCall) IfNoneMatch(entityTag string) *ReportsFilesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do and Download methods.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsFilesGetCall) Context(ctx context.Context) *ReportsFilesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsFilesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}/files/{fileId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- "fileId": strconv.FormatInt(c.fileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Download fetches the API endpoint's "media" value, instead of the normal
-// API response value. If the returned error is nil, the Response is guaranteed to
-// have a 2xx status code. Callers must close the Response.Body as usual.
-func (c *ReportsFilesGetCall) Download() (*http.Response, error) {
- res, err := c.doRequest("media")
- if err != nil {
- return nil, err
- }
- if err := googleapi.CheckMediaResponse(res); err != nil {
- res.Body.Close()
- return nil, err
- }
- return res, nil
-}
-
-// Do executes the "dfareporting.reports.files.get" call.
-// Exactly one of *File or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *File.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *ReportsFilesGetCall) Do() (*File, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &File{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a report file.",
- // "httpMethod": "GET",
- // "id": "dfareporting.reports.files.get",
- // "parameterOrder": [
- // "profileId",
- // "reportId",
- // "fileId"
- // ],
- // "parameters": {
- // "fileId": {
- // "description": "The ID of the report file.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}/files/{fileId}",
- // "response": {
- // "$ref": "File"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ],
- // "supportsMediaDownload": true
- // }
-
-}
-
-// method id "dfareporting.reports.files.list":
-
-type ReportsFilesListCall struct {
- s *Service
- profileId int64
- reportId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists files for a report.
-func (r *ReportsFilesService) List(profileId int64, reportId int64) *ReportsFilesListCall {
- c := &ReportsFilesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *ReportsFilesListCall) MaxResults(maxResults int64) *ReportsFilesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous result page.
-func (c *ReportsFilesListCall) PageToken(pageToken string) *ReportsFilesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SortField sets the optional parameter "sortField": The field by which
-// to sort the list.
-//
-// Possible values:
-// "ID" - Sort by file ID.
-// "LAST_MODIFIED_TIME" (default) - Sort by 'lastmodifiedAt' field.
-func (c *ReportsFilesListCall) SortField(sortField string) *ReportsFilesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is 'DESCENDING'.
-//
-// Possible values:
-// "ASCENDING" - Ascending order.
-// "DESCENDING" (default) - Descending order.
-func (c *ReportsFilesListCall) SortOrder(sortOrder string) *ReportsFilesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsFilesListCall) Fields(s ...googleapi.Field) *ReportsFilesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsFilesListCall) IfNoneMatch(entityTag string) *ReportsFilesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsFilesListCall) Context(ctx context.Context) *ReportsFilesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsFilesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}/files")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.files.list" call.
-// Exactly one of *FileList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *FileList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ReportsFilesListCall) Do() (*FileList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FileList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists files for a report.",
- // "httpMethod": "GET",
- // "id": "dfareporting.reports.files.list",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the parent report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "sortField": {
- // "default": "LAST_MODIFIED_TIME",
- // "description": "The field by which to sort the list.",
- // "enum": [
- // "ID",
- // "LAST_MODIFIED_TIME"
- // ],
- // "enumDescriptions": [
- // "Sort by file ID.",
- // "Sort by 'lastmodifiedAt' field."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "default": "DESCENDING",
- // "description": "Order of sorted results, default is 'DESCENDING'.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "Ascending order.",
- // "Descending order."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}/files",
- // "response": {
- // "$ref": "FileList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.sites.get":
-
-type SitesGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one site by ID.
-func (r *SitesService) Get(profileId int64, id int64) *SitesGetCall {
- c := &SitesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SitesGetCall) Fields(s ...googleapi.Field) *SitesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SitesGetCall) IfNoneMatch(entityTag string) *SitesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SitesGetCall) Context(ctx context.Context) *SitesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SitesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/sites/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.sites.get" call.
-// Exactly one of *Site or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Site.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *SitesGetCall) Do() (*Site, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Site{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one site by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.sites.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Site ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/sites/{id}",
- // "response": {
- // "$ref": "Site"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.sites.insert":
-
-type SitesInsertCall struct {
- s *Service
- profileId int64
- site *Site
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new site.
-func (r *SitesService) Insert(profileId int64, site *Site) *SitesInsertCall {
- c := &SitesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.site = site
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SitesInsertCall) Fields(s ...googleapi.Field) *SitesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SitesInsertCall) Context(ctx context.Context) *SitesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SitesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.site)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/sites")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.sites.insert" call.
-// Exactly one of *Site or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Site.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *SitesInsertCall) Do() (*Site, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Site{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new site.",
- // "httpMethod": "POST",
- // "id": "dfareporting.sites.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/sites",
- // "request": {
- // "$ref": "Site"
- // },
- // "response": {
- // "$ref": "Site"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.sites.list":
-
-type SitesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of sites, possibly filtered.
-func (r *SitesService) List(profileId int64) *SitesListCall {
- c := &SitesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// AcceptsInStreamVideoPlacements sets the optional parameter
-// "acceptsInStreamVideoPlacements": This search filter is no longer
-// supported and will have no effect on the results returned.
-func (c *SitesListCall) AcceptsInStreamVideoPlacements(acceptsInStreamVideoPlacements bool) *SitesListCall {
- c.opt_["acceptsInStreamVideoPlacements"] = acceptsInStreamVideoPlacements
- return c
-}
-
-// AcceptsInterstitialPlacements sets the optional parameter
-// "acceptsInterstitialPlacements": This search filter is no longer
-// supported and will have no effect on the results returned.
-func (c *SitesListCall) AcceptsInterstitialPlacements(acceptsInterstitialPlacements bool) *SitesListCall {
- c.opt_["acceptsInterstitialPlacements"] = acceptsInterstitialPlacements
- return c
-}
-
-// AcceptsPublisherPaidPlacements sets the optional parameter
-// "acceptsPublisherPaidPlacements": Select only sites that accept
-// publisher paid placements.
-func (c *SitesListCall) AcceptsPublisherPaidPlacements(acceptsPublisherPaidPlacements bool) *SitesListCall {
- c.opt_["acceptsPublisherPaidPlacements"] = acceptsPublisherPaidPlacements
- return c
-}
-
-// AdWordsSite sets the optional parameter "adWordsSite": Select only
-// AdWords sites.
-func (c *SitesListCall) AdWordsSite(adWordsSite bool) *SitesListCall {
- c.opt_["adWordsSite"] = adWordsSite
- return c
-}
-
-// Approved sets the optional parameter "approved": Select only approved
-// sites.
-func (c *SitesListCall) Approved(approved bool) *SitesListCall {
- c.opt_["approved"] = approved
- return c
-}
-
-// CampaignIds sets the optional parameter "campaignIds": Select only
-// sites with these campaign IDs.
-func (c *SitesListCall) CampaignIds(campaignIds int64) *SitesListCall {
- c.opt_["campaignIds"] = campaignIds
- return c
-}
-
-// DirectorySiteIds sets the optional parameter "directorySiteIds":
-// Select only sites with these directory site IDs.
-func (c *SitesListCall) DirectorySiteIds(directorySiteIds int64) *SitesListCall {
- c.opt_["directorySiteIds"] = directorySiteIds
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only sites with these
-// IDs.
-func (c *SitesListCall) Ids(ids int64) *SitesListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *SitesListCall) MaxResults(maxResults int64) *SitesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *SitesListCall) PageToken(pageToken string) *SitesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name, ID or keyName. Wildcards (*) are
-// allowed. For example, "site*2015" will return objects with names like
-// "site June 2015", "site April 2015", or simply "site 2015". Most of
-// the searches also add wildcards implicitly at the start and the end
-// of the search string. For example, a search string of "site" will
-// match objects with name "my site", "site 2015", or simply "site".
-func (c *SitesListCall) SearchString(searchString string) *SitesListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *SitesListCall) SortField(sortField string) *SitesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *SitesListCall) SortOrder(sortOrder string) *SitesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// SubaccountId sets the optional parameter "subaccountId": Select only
-// sites with this subaccount ID.
-func (c *SitesListCall) SubaccountId(subaccountId int64) *SitesListCall {
- c.opt_["subaccountId"] = subaccountId
- return c
-}
-
-// UnmappedSite sets the optional parameter "unmappedSite": Select only
-// sites that have not been mapped to a directory site.
-func (c *SitesListCall) UnmappedSite(unmappedSite bool) *SitesListCall {
- c.opt_["unmappedSite"] = unmappedSite
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SitesListCall) Fields(s ...googleapi.Field) *SitesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SitesListCall) IfNoneMatch(entityTag string) *SitesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SitesListCall) Context(ctx context.Context) *SitesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SitesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["acceptsInStreamVideoPlacements"]; ok {
- params.Set("acceptsInStreamVideoPlacements", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["acceptsInterstitialPlacements"]; ok {
- params.Set("acceptsInterstitialPlacements", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["acceptsPublisherPaidPlacements"]; ok {
- params.Set("acceptsPublisherPaidPlacements", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["adWordsSite"]; ok {
- params.Set("adWordsSite", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["approved"]; ok {
- params.Set("approved", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["campaignIds"]; ok {
- params.Set("campaignIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["directorySiteIds"]; ok {
- params.Set("directorySiteIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["subaccountId"]; ok {
- params.Set("subaccountId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["unmappedSite"]; ok {
- params.Set("unmappedSite", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/sites")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.sites.list" call.
-// Exactly one of *SitesListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *SitesListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *SitesListCall) Do() (*SitesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SitesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of sites, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.sites.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "acceptsInStreamVideoPlacements": {
- // "description": "This search filter is no longer supported and will have no effect on the results returned.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "acceptsInterstitialPlacements": {
- // "description": "This search filter is no longer supported and will have no effect on the results returned.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "acceptsPublisherPaidPlacements": {
- // "description": "Select only sites that accept publisher paid placements.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "adWordsSite": {
- // "description": "Select only AdWords sites.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "approved": {
- // "description": "Select only approved sites.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "campaignIds": {
- // "description": "Select only sites with these campaign IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "directorySiteIds": {
- // "description": "Select only sites with these directory site IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only sites with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, \"site*2015\" will return objects with names like \"site June 2015\", \"site April 2015\", or simply \"site 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"site\" will match objects with name \"my site\", \"site 2015\", or simply \"site\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "subaccountId": {
- // "description": "Select only sites with this subaccount ID.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "unmappedSite": {
- // "description": "Select only sites that have not been mapped to a directory site.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "userprofiles/{profileId}/sites",
- // "response": {
- // "$ref": "SitesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.sites.patch":
-
-type SitesPatchCall struct {
- s *Service
- profileId int64
- id int64
- site *Site
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing site. This method supports patch
-// semantics.
-func (r *SitesService) Patch(profileId int64, id int64, site *Site) *SitesPatchCall {
- c := &SitesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.site = site
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SitesPatchCall) Fields(s ...googleapi.Field) *SitesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SitesPatchCall) Context(ctx context.Context) *SitesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SitesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.site)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/sites")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.sites.patch" call.
-// Exactly one of *Site or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Site.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *SitesPatchCall) Do() (*Site, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Site{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing site. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.sites.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Site ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/sites",
- // "request": {
- // "$ref": "Site"
- // },
- // "response": {
- // "$ref": "Site"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.sites.update":
-
-type SitesUpdateCall struct {
- s *Service
- profileId int64
- site *Site
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing site.
-func (r *SitesService) Update(profileId int64, site *Site) *SitesUpdateCall {
- c := &SitesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.site = site
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SitesUpdateCall) Fields(s ...googleapi.Field) *SitesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SitesUpdateCall) Context(ctx context.Context) *SitesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SitesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.site)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/sites")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.sites.update" call.
-// Exactly one of *Site or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Site.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *SitesUpdateCall) Do() (*Site, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Site{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing site.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.sites.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/sites",
- // "request": {
- // "$ref": "Site"
- // },
- // "response": {
- // "$ref": "Site"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.sizes.get":
-
-type SizesGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one size by ID.
-func (r *SizesService) Get(profileId int64, id int64) *SizesGetCall {
- c := &SizesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SizesGetCall) Fields(s ...googleapi.Field) *SizesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SizesGetCall) IfNoneMatch(entityTag string) *SizesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SizesGetCall) Context(ctx context.Context) *SizesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SizesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/sizes/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.sizes.get" call.
-// Exactly one of *Size or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Size.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *SizesGetCall) Do() (*Size, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Size{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one size by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.sizes.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Size ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/sizes/{id}",
- // "response": {
- // "$ref": "Size"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.sizes.insert":
-
-type SizesInsertCall struct {
- s *Service
- profileId int64
- size *Size
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new size.
-func (r *SizesService) Insert(profileId int64, size *Size) *SizesInsertCall {
- c := &SizesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.size = size
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SizesInsertCall) Fields(s ...googleapi.Field) *SizesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SizesInsertCall) Context(ctx context.Context) *SizesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SizesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.size)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/sizes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.sizes.insert" call.
-// Exactly one of *Size or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Size.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *SizesInsertCall) Do() (*Size, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Size{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new size.",
- // "httpMethod": "POST",
- // "id": "dfareporting.sizes.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/sizes",
- // "request": {
- // "$ref": "Size"
- // },
- // "response": {
- // "$ref": "Size"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.sizes.list":
-
-type SizesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of sizes, possibly filtered.
-func (r *SizesService) List(profileId int64) *SizesListCall {
- c := &SizesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Height sets the optional parameter "height": Select only sizes with
-// this height.
-func (c *SizesListCall) Height(height int64) *SizesListCall {
- c.opt_["height"] = height
- return c
-}
-
-// IabStandard sets the optional parameter "iabStandard": Select only
-// IAB standard sizes.
-func (c *SizesListCall) IabStandard(iabStandard bool) *SizesListCall {
- c.opt_["iabStandard"] = iabStandard
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only sizes with these
-// IDs.
-func (c *SizesListCall) Ids(ids int64) *SizesListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// Width sets the optional parameter "width": Select only sizes with
-// this width.
-func (c *SizesListCall) Width(width int64) *SizesListCall {
- c.opt_["width"] = width
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SizesListCall) Fields(s ...googleapi.Field) *SizesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SizesListCall) IfNoneMatch(entityTag string) *SizesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SizesListCall) Context(ctx context.Context) *SizesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SizesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["height"]; ok {
- params.Set("height", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["iabStandard"]; ok {
- params.Set("iabStandard", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["width"]; ok {
- params.Set("width", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/sizes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.sizes.list" call.
-// Exactly one of *SizesListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *SizesListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *SizesListCall) Do() (*SizesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SizesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of sizes, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.sizes.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "height": {
- // "description": "Select only sizes with this height.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "iabStandard": {
- // "description": "Select only IAB standard sizes.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "ids": {
- // "description": "Select only sizes with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "width": {
- // "description": "Select only sizes with this width.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // }
- // },
- // "path": "userprofiles/{profileId}/sizes",
- // "response": {
- // "$ref": "SizesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.subaccounts.get":
-
-type SubaccountsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one subaccount by ID.
-func (r *SubaccountsService) Get(profileId int64, id int64) *SubaccountsGetCall {
- c := &SubaccountsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SubaccountsGetCall) Fields(s ...googleapi.Field) *SubaccountsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SubaccountsGetCall) IfNoneMatch(entityTag string) *SubaccountsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SubaccountsGetCall) Context(ctx context.Context) *SubaccountsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SubaccountsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/subaccounts/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.subaccounts.get" call.
-// Exactly one of *Subaccount or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Subaccount.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *SubaccountsGetCall) Do() (*Subaccount, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Subaccount{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one subaccount by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.subaccounts.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Subaccount ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/subaccounts/{id}",
- // "response": {
- // "$ref": "Subaccount"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.subaccounts.insert":
-
-type SubaccountsInsertCall struct {
- s *Service
- profileId int64
- subaccount *Subaccount
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new subaccount.
-func (r *SubaccountsService) Insert(profileId int64, subaccount *Subaccount) *SubaccountsInsertCall {
- c := &SubaccountsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.subaccount = subaccount
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SubaccountsInsertCall) Fields(s ...googleapi.Field) *SubaccountsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SubaccountsInsertCall) Context(ctx context.Context) *SubaccountsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SubaccountsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.subaccount)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/subaccounts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.subaccounts.insert" call.
-// Exactly one of *Subaccount or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Subaccount.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *SubaccountsInsertCall) Do() (*Subaccount, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Subaccount{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new subaccount.",
- // "httpMethod": "POST",
- // "id": "dfareporting.subaccounts.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/subaccounts",
- // "request": {
- // "$ref": "Subaccount"
- // },
- // "response": {
- // "$ref": "Subaccount"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.subaccounts.list":
-
-type SubaccountsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Gets a list of subaccounts, possibly filtered.
-func (r *SubaccountsService) List(profileId int64) *SubaccountsListCall {
- c := &SubaccountsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only subaccounts with
-// these IDs.
-func (c *SubaccountsListCall) Ids(ids int64) *SubaccountsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *SubaccountsListCall) MaxResults(maxResults int64) *SubaccountsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *SubaccountsListCall) PageToken(pageToken string) *SubaccountsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name or ID. Wildcards (*) are allowed. For
-// example, "subaccount*2015" will return objects with names like
-// "subaccount June 2015", "subaccount April 2015", or simply
-// "subaccount 2015". Most of the searches also add wildcards implicitly
-// at the start and the end of the search string. For example, a search
-// string of "subaccount" will match objects with name "my subaccount",
-// "subaccount 2015", or simply "subaccount".
-func (c *SubaccountsListCall) SearchString(searchString string) *SubaccountsListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *SubaccountsListCall) SortField(sortField string) *SubaccountsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *SubaccountsListCall) SortOrder(sortOrder string) *SubaccountsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SubaccountsListCall) Fields(s ...googleapi.Field) *SubaccountsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SubaccountsListCall) IfNoneMatch(entityTag string) *SubaccountsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SubaccountsListCall) Context(ctx context.Context) *SubaccountsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SubaccountsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/subaccounts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.subaccounts.list" call.
-// Exactly one of *SubaccountsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *SubaccountsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *SubaccountsListCall) Do() (*SubaccountsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SubaccountsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets a list of subaccounts, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.subaccounts.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "ids": {
- // "description": "Select only subaccounts with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"subaccount*2015\" will return objects with names like \"subaccount June 2015\", \"subaccount April 2015\", or simply \"subaccount 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"subaccount\" will match objects with name \"my subaccount\", \"subaccount 2015\", or simply \"subaccount\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/subaccounts",
- // "response": {
- // "$ref": "SubaccountsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.subaccounts.patch":
-
-type SubaccountsPatchCall struct {
- s *Service
- profileId int64
- id int64
- subaccount *Subaccount
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing subaccount. This method supports patch
-// semantics.
-func (r *SubaccountsService) Patch(profileId int64, id int64, subaccount *Subaccount) *SubaccountsPatchCall {
- c := &SubaccountsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.subaccount = subaccount
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SubaccountsPatchCall) Fields(s ...googleapi.Field) *SubaccountsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SubaccountsPatchCall) Context(ctx context.Context) *SubaccountsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SubaccountsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.subaccount)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/subaccounts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.subaccounts.patch" call.
-// Exactly one of *Subaccount or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Subaccount.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *SubaccountsPatchCall) Do() (*Subaccount, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Subaccount{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing subaccount. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.subaccounts.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Subaccount ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/subaccounts",
- // "request": {
- // "$ref": "Subaccount"
- // },
- // "response": {
- // "$ref": "Subaccount"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.subaccounts.update":
-
-type SubaccountsUpdateCall struct {
- s *Service
- profileId int64
- subaccount *Subaccount
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing subaccount.
-func (r *SubaccountsService) Update(profileId int64, subaccount *Subaccount) *SubaccountsUpdateCall {
- c := &SubaccountsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.subaccount = subaccount
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SubaccountsUpdateCall) Fields(s ...googleapi.Field) *SubaccountsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SubaccountsUpdateCall) Context(ctx context.Context) *SubaccountsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SubaccountsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.subaccount)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/subaccounts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.subaccounts.update" call.
-// Exactly one of *Subaccount or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Subaccount.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *SubaccountsUpdateCall) Do() (*Subaccount, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Subaccount{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing subaccount.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.subaccounts.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/subaccounts",
- // "request": {
- // "$ref": "Subaccount"
- // },
- // "response": {
- // "$ref": "Subaccount"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userProfiles.get":
-
-type UserProfilesGetCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one user profile by ID.
-func (r *UserProfilesService) Get(profileId int64) *UserProfilesGetCall {
- c := &UserProfilesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserProfilesGetCall) Fields(s ...googleapi.Field) *UserProfilesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UserProfilesGetCall) IfNoneMatch(entityTag string) *UserProfilesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserProfilesGetCall) Context(ctx context.Context) *UserProfilesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserProfilesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userProfiles.get" call.
-// Exactly one of *UserProfile or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UserProfile.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UserProfilesGetCall) Do() (*UserProfile, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserProfile{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one user profile by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.userProfiles.get",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}",
- // "response": {
- // "$ref": "UserProfile"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting",
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userProfiles.list":
-
-type UserProfilesListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves list of user profiles for a user.
-func (r *UserProfilesService) List() *UserProfilesListCall {
- c := &UserProfilesListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserProfilesListCall) Fields(s ...googleapi.Field) *UserProfilesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UserProfilesListCall) IfNoneMatch(entityTag string) *UserProfilesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserProfilesListCall) Context(ctx context.Context) *UserProfilesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserProfilesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userProfiles.list" call.
-// Exactly one of *UserProfileList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UserProfileList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *UserProfilesListCall) Do() (*UserProfileList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserProfileList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves list of user profiles for a user.",
- // "httpMethod": "GET",
- // "id": "dfareporting.userProfiles.list",
- // "path": "userprofiles",
- // "response": {
- // "$ref": "UserProfileList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting",
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userRolePermissionGroups.get":
-
-type UserRolePermissionGroupsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one user role permission group by ID.
-func (r *UserRolePermissionGroupsService) Get(profileId int64, id int64) *UserRolePermissionGroupsGetCall {
- c := &UserRolePermissionGroupsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserRolePermissionGroupsGetCall) Fields(s ...googleapi.Field) *UserRolePermissionGroupsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UserRolePermissionGroupsGetCall) IfNoneMatch(entityTag string) *UserRolePermissionGroupsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserRolePermissionGroupsGetCall) Context(ctx context.Context) *UserRolePermissionGroupsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserRolePermissionGroupsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/userRolePermissionGroups/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userRolePermissionGroups.get" call.
-// Exactly one of *UserRolePermissionGroup or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *UserRolePermissionGroup.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *UserRolePermissionGroupsGetCall) Do() (*UserRolePermissionGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserRolePermissionGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one user role permission group by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.userRolePermissionGroups.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "User role permission group ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/userRolePermissionGroups/{id}",
- // "response": {
- // "$ref": "UserRolePermissionGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userRolePermissionGroups.list":
-
-type UserRolePermissionGroupsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Gets a list of all supported user role permission groups.
-func (r *UserRolePermissionGroupsService) List(profileId int64) *UserRolePermissionGroupsListCall {
- c := &UserRolePermissionGroupsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserRolePermissionGroupsListCall) Fields(s ...googleapi.Field) *UserRolePermissionGroupsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UserRolePermissionGroupsListCall) IfNoneMatch(entityTag string) *UserRolePermissionGroupsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserRolePermissionGroupsListCall) Context(ctx context.Context) *UserRolePermissionGroupsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserRolePermissionGroupsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/userRolePermissionGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userRolePermissionGroups.list" call.
-// Exactly one of *UserRolePermissionGroupsListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *UserRolePermissionGroupsListResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *UserRolePermissionGroupsListCall) Do() (*UserRolePermissionGroupsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserRolePermissionGroupsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets a list of all supported user role permission groups.",
- // "httpMethod": "GET",
- // "id": "dfareporting.userRolePermissionGroups.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/userRolePermissionGroups",
- // "response": {
- // "$ref": "UserRolePermissionGroupsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userRolePermissions.get":
-
-type UserRolePermissionsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one user role permission by ID.
-func (r *UserRolePermissionsService) Get(profileId int64, id int64) *UserRolePermissionsGetCall {
- c := &UserRolePermissionsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserRolePermissionsGetCall) Fields(s ...googleapi.Field) *UserRolePermissionsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UserRolePermissionsGetCall) IfNoneMatch(entityTag string) *UserRolePermissionsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserRolePermissionsGetCall) Context(ctx context.Context) *UserRolePermissionsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserRolePermissionsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/userRolePermissions/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userRolePermissions.get" call.
-// Exactly one of *UserRolePermission or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *UserRolePermission.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *UserRolePermissionsGetCall) Do() (*UserRolePermission, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserRolePermission{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one user role permission by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.userRolePermissions.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "User role permission ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/userRolePermissions/{id}",
- // "response": {
- // "$ref": "UserRolePermission"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userRolePermissions.list":
-
-type UserRolePermissionsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Gets a list of user role permissions, possibly filtered.
-func (r *UserRolePermissionsService) List(profileId int64) *UserRolePermissionsListCall {
- c := &UserRolePermissionsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only user role
-// permissions with these IDs.
-func (c *UserRolePermissionsListCall) Ids(ids int64) *UserRolePermissionsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserRolePermissionsListCall) Fields(s ...googleapi.Field) *UserRolePermissionsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UserRolePermissionsListCall) IfNoneMatch(entityTag string) *UserRolePermissionsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserRolePermissionsListCall) Context(ctx context.Context) *UserRolePermissionsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserRolePermissionsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/userRolePermissions")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userRolePermissions.list" call.
-// Exactly one of *UserRolePermissionsListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *UserRolePermissionsListResponse.ServerResponse.Header or (if
-// a response was returned at all) in error.(*googleapi.Error).Header.
-// Use googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *UserRolePermissionsListCall) Do() (*UserRolePermissionsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserRolePermissionsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets a list of user role permissions, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.userRolePermissions.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "ids": {
- // "description": "Select only user role permissions with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/userRolePermissions",
- // "response": {
- // "$ref": "UserRolePermissionsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userRoles.delete":
-
-type UserRolesDeleteCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an existing user role.
-func (r *UserRolesService) Delete(profileId int64, id int64) *UserRolesDeleteCall {
- c := &UserRolesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserRolesDeleteCall) Fields(s ...googleapi.Field) *UserRolesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserRolesDeleteCall) Context(ctx context.Context) *UserRolesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserRolesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/userRoles/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userRoles.delete" call.
-func (c *UserRolesDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes an existing user role.",
- // "httpMethod": "DELETE",
- // "id": "dfareporting.userRoles.delete",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "User role ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/userRoles/{id}",
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userRoles.get":
-
-type UserRolesGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one user role by ID.
-func (r *UserRolesService) Get(profileId int64, id int64) *UserRolesGetCall {
- c := &UserRolesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserRolesGetCall) Fields(s ...googleapi.Field) *UserRolesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UserRolesGetCall) IfNoneMatch(entityTag string) *UserRolesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserRolesGetCall) Context(ctx context.Context) *UserRolesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserRolesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/userRoles/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userRoles.get" call.
-// Exactly one of *UserRole or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *UserRole.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UserRolesGetCall) Do() (*UserRole, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserRole{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one user role by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.userRoles.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "User role ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/userRoles/{id}",
- // "response": {
- // "$ref": "UserRole"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userRoles.insert":
-
-type UserRolesInsertCall struct {
- s *Service
- profileId int64
- userrole *UserRole
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new user role.
-func (r *UserRolesService) Insert(profileId int64, userrole *UserRole) *UserRolesInsertCall {
- c := &UserRolesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.userrole = userrole
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserRolesInsertCall) Fields(s ...googleapi.Field) *UserRolesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserRolesInsertCall) Context(ctx context.Context) *UserRolesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserRolesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.userrole)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/userRoles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userRoles.insert" call.
-// Exactly one of *UserRole or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *UserRole.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UserRolesInsertCall) Do() (*UserRole, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserRole{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new user role.",
- // "httpMethod": "POST",
- // "id": "dfareporting.userRoles.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/userRoles",
- // "request": {
- // "$ref": "UserRole"
- // },
- // "response": {
- // "$ref": "UserRole"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userRoles.list":
-
-type UserRolesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of user roles, possibly filtered.
-func (r *UserRolesService) List(profileId int64) *UserRolesListCall {
- c := &UserRolesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// AccountUserRoleOnly sets the optional parameter
-// "accountUserRoleOnly": Select only account level user roles not
-// associated with any specific subaccount.
-func (c *UserRolesListCall) AccountUserRoleOnly(accountUserRoleOnly bool) *UserRolesListCall {
- c.opt_["accountUserRoleOnly"] = accountUserRoleOnly
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only user roles with
-// the specified IDs.
-func (c *UserRolesListCall) Ids(ids int64) *UserRolesListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *UserRolesListCall) MaxResults(maxResults int64) *UserRolesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *UserRolesListCall) PageToken(pageToken string) *UserRolesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name or ID. Wildcards (*) are allowed. For
-// example, "userrole*2015" will return objects with names like
-// "userrole June 2015", "userrole April 2015", or simply "userrole
-// 2015". Most of the searches also add wildcards implicitly at the
-// start and the end of the search string. For example, a search string
-// of "userrole" will match objects with name "my userrole", "userrole
-// 2015", or simply "userrole".
-func (c *UserRolesListCall) SearchString(searchString string) *UserRolesListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *UserRolesListCall) SortField(sortField string) *UserRolesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *UserRolesListCall) SortOrder(sortOrder string) *UserRolesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// SubaccountId sets the optional parameter "subaccountId": Select only
-// user roles that belong to this subaccount.
-func (c *UserRolesListCall) SubaccountId(subaccountId int64) *UserRolesListCall {
- c.opt_["subaccountId"] = subaccountId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserRolesListCall) Fields(s ...googleapi.Field) *UserRolesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UserRolesListCall) IfNoneMatch(entityTag string) *UserRolesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserRolesListCall) Context(ctx context.Context) *UserRolesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserRolesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["accountUserRoleOnly"]; ok {
- params.Set("accountUserRoleOnly", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["subaccountId"]; ok {
- params.Set("subaccountId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/userRoles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userRoles.list" call.
-// Exactly one of *UserRolesListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *UserRolesListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *UserRolesListCall) Do() (*UserRolesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserRolesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of user roles, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.userRoles.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "accountUserRoleOnly": {
- // "description": "Select only account level user roles not associated with any specific subaccount.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "ids": {
- // "description": "Select only user roles with the specified IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"userrole*2015\" will return objects with names like \"userrole June 2015\", \"userrole April 2015\", or simply \"userrole 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"userrole\" will match objects with name \"my userrole\", \"userrole 2015\", or simply \"userrole\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "subaccountId": {
- // "description": "Select only user roles that belong to this subaccount.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/userRoles",
- // "response": {
- // "$ref": "UserRolesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userRoles.patch":
-
-type UserRolesPatchCall struct {
- s *Service
- profileId int64
- id int64
- userrole *UserRole
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing user role. This method supports patch
-// semantics.
-func (r *UserRolesService) Patch(profileId int64, id int64, userrole *UserRole) *UserRolesPatchCall {
- c := &UserRolesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.userrole = userrole
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserRolesPatchCall) Fields(s ...googleapi.Field) *UserRolesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserRolesPatchCall) Context(ctx context.Context) *UserRolesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserRolesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.userrole)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/userRoles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userRoles.patch" call.
-// Exactly one of *UserRole or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *UserRole.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UserRolesPatchCall) Do() (*UserRole, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserRole{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing user role. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.userRoles.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "User role ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/userRoles",
- // "request": {
- // "$ref": "UserRole"
- // },
- // "response": {
- // "$ref": "UserRole"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userRoles.update":
-
-type UserRolesUpdateCall struct {
- s *Service
- profileId int64
- userrole *UserRole
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing user role.
-func (r *UserRolesService) Update(profileId int64, userrole *UserRole) *UserRolesUpdateCall {
- c := &UserRolesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.userrole = userrole
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserRolesUpdateCall) Fields(s ...googleapi.Field) *UserRolesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserRolesUpdateCall) Context(ctx context.Context) *UserRolesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserRolesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.userrole)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/userRoles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userRoles.update" call.
-// Exactly one of *UserRole or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *UserRole.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UserRolesUpdateCall) Do() (*UserRole, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserRole{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing user role.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.userRoles.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/userRoles",
- // "request": {
- // "$ref": "UserRole"
- // },
- // "response": {
- // "$ref": "UserRole"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/dfareporting/v2.1/dfareporting-api.json b/vendor/google.golang.org/api/dfareporting/v2.1/dfareporting-api.json
deleted file mode 100644
index 346a1a32..00000000
--- a/vendor/google.golang.org/api/dfareporting/v2.1/dfareporting-api.json
+++ /dev/null
@@ -1,17625 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/xZQxxa_Tb2iO1EIpR9uJ-M5uVs4\"",
- "discoveryVersion": "v1",
- "id": "dfareporting:v2.1",
- "name": "dfareporting",
- "version": "v2.1",
- "revision": "20150717",
- "title": "DCM/DFA Reporting And Trafficking API",
- "description": "Manage your DoubleClick Campaign Manager ad campaigns and reports.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/doubleclick-advertisers/reporting/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/dfareporting/v2.1/",
- "basePath": "/dfareporting/v2.1/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "dfareporting/v2.1/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/dfareporting": {
- "description": "View and manage DoubleClick for Advertisers reports"
- },
- "https://www.googleapis.com/auth/dfatrafficking": {
- "description": "View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns"
- }
- }
- }
- },
- "schemas": {
- "Account": {
- "id": "Account",
- "type": "object",
- "description": "Contains properties of a DCM account.",
- "properties": {
- "accountPermissionIds": {
- "type": "array",
- "description": "Account permissions assigned to this account.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "accountProfile": {
- "type": "string",
- "description": "Profile for this account. This is a read-only field that can be left blank.",
- "enum": [
- "ACCOUNT_PROFILE_BASIC",
- "ACCOUNT_PROFILE_STANDARD"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "active": {
- "type": "boolean",
- "description": "Whether this account is active."
- },
- "activeAdsLimitTier": {
- "type": "string",
- "description": "Maximum number of active ads allowed for this account.",
- "enum": [
- "ACTIVE_ADS_TIER_100K",
- "ACTIVE_ADS_TIER_200K",
- "ACTIVE_ADS_TIER_300K",
- "ACTIVE_ADS_TIER_40K",
- "ACTIVE_ADS_TIER_75K"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "activeViewOptOut": {
- "type": "boolean",
- "description": "Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions."
- },
- "availablePermissionIds": {
- "type": "array",
- "description": "User role permissions available to the user roles of this account.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "comscoreVceEnabled": {
- "type": "boolean",
- "description": "Whether campaigns created in this account will be enabled for comScore vCE by default."
- },
- "countryId": {
- "type": "string",
- "description": "ID of the country associated with this account.",
- "format": "int64"
- },
- "currencyId": {
- "type": "string",
- "description": "ID of currency associated with this account. This is a required field.\nAcceptable values are: \n- \"1\" for USD \n- \"2\" for GBP \n- \"3\" for ESP \n- \"4\" for SEK \n- \"5\" for CAD \n- \"6\" for JPY \n- \"7\" for DEM \n- \"8\" for AUD \n- \"9\" for FRF \n- \"10\" for ITL \n- \"11\" for DKK \n- \"12\" for NOK \n- \"13\" for FIM \n- \"14\" for ZAR \n- \"15\" for IEP \n- \"16\" for NLG \n- \"17\" for EUR \n- \"18\" for KRW \n- \"19\" for TWD \n- \"20\" for SGD \n- \"21\" for CNY \n- \"22\" for HKD \n- \"23\" for NZD \n- \"24\" for MYR \n- \"25\" for BRL \n- \"26\" for PTE \n- \"27\" for MXP \n- \"28\" for CLP \n- \"29\" for TRY \n- \"30\" for ARS \n- \"31\" for PEN \n- \"32\" for ILS \n- \"33\" for CHF \n- \"34\" for VEF \n- \"35\" for COP \n- \"36\" for GTQ",
- "format": "int64"
- },
- "defaultCreativeSizeId": {
- "type": "string",
- "description": "Default placement dimensions for this account.",
- "format": "int64"
- },
- "description": {
- "type": "string",
- "description": "Description of this account."
- },
- "id": {
- "type": "string",
- "description": "ID of this account. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#account\".",
- "default": "dfareporting#account"
- },
- "locale": {
- "type": "string",
- "description": "Locale of this account.\nAcceptable values are: \n- \"cs\" (Czech) \n- \"de\" (German) \n- \"en\" (English) \n- \"en-GB\" (English United Kingdom) \n- \"es\" (Spanish) \n- \"fr\" (French) \n- \"it\" (Italian) \n- \"ja\" (Japanese) \n- \"ko\" (Korean) \n- \"pl\" (Polish) \n- \"pt-BR\" (Portuguese Brazil) \n- \"ru\" (Russian) \n- \"sv\" (Swedish) \n- \"tr\" (Turkish) \n- \"zh-CN\" (Chinese Simplified) \n- \"zh-TW\" (Chinese Traditional)"
- },
- "maximumImageSize": {
- "type": "string",
- "description": "Maximum image size allowed for this account.",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "Name of this account. This is a required field, and must be less than 128 characters long and be globally unique."
- },
- "nielsenOcrEnabled": {
- "type": "boolean",
- "description": "Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default."
- },
- "reportsConfiguration": {
- "$ref": "ReportsConfiguration",
- "description": "Reporting configuration of this account."
- },
- "teaserSizeLimit": {
- "type": "string",
- "description": "File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.",
- "format": "int64"
- }
- }
- },
- "AccountActiveAdSummary": {
- "id": "AccountActiveAdSummary",
- "type": "object",
- "description": "Gets a summary of active ads in an account.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "ID of the account.",
- "format": "int64"
- },
- "activeAds": {
- "type": "string",
- "description": "Ads that have been activated for the account",
- "format": "int64"
- },
- "activeAdsLimitTier": {
- "type": "string",
- "description": "Maximum number of active ads allowed for the account.",
- "enum": [
- "ACTIVE_ADS_TIER_100K",
- "ACTIVE_ADS_TIER_200K",
- "ACTIVE_ADS_TIER_300K",
- "ACTIVE_ADS_TIER_40K",
- "ACTIVE_ADS_TIER_75K"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "availableAds": {
- "type": "string",
- "description": "Ads that can be activated for the account.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountActiveAdSummary\".",
- "default": "dfareporting#accountActiveAdSummary"
- }
- }
- },
- "AccountPermission": {
- "id": "AccountPermission",
- "type": "object",
- "description": "AccountPermissions contains information about a particular account permission. Some features of DCM require an account permission to be present in the account.",
- "properties": {
- "accountProfiles": {
- "type": "array",
- "description": "Account profiles associated with this account permission.\n\nPossible values are:\n- \"ACCOUNT_PROFILE_BASIC\"\n- \"ACCOUNT_PROFILE_STANDARD\"",
- "items": {
- "type": "string",
- "enum": [
- "ACCOUNT_PROFILE_BASIC",
- "ACCOUNT_PROFILE_STANDARD"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- }
- },
- "id": {
- "type": "string",
- "description": "ID of this account permission.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermission\".",
- "default": "dfareporting#accountPermission"
- },
- "level": {
- "type": "string",
- "description": "Administrative level required to enable this account permission.",
- "enum": [
- "ADMINISTRATOR",
- "USER"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "name": {
- "type": "string",
- "description": "Name of this account permission."
- },
- "permissionGroupId": {
- "type": "string",
- "description": "Permission group of this account permission.",
- "format": "int64"
- }
- }
- },
- "AccountPermissionGroup": {
- "id": "AccountPermissionGroup",
- "type": "object",
- "description": "AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.",
- "properties": {
- "id": {
- "type": "string",
- "description": "ID of this account permission group.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionGroup\".",
- "default": "dfareporting#accountPermissionGroup"
- },
- "name": {
- "type": "string",
- "description": "Name of this account permission group."
- }
- }
- },
- "AccountPermissionGroupsListResponse": {
- "id": "AccountPermissionGroupsListResponse",
- "type": "object",
- "description": "Account Permission Group List Response",
- "properties": {
- "accountPermissionGroups": {
- "type": "array",
- "description": "Account permission group collection.",
- "items": {
- "$ref": "AccountPermissionGroup"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionGroupsListResponse\".",
- "default": "dfareporting#accountPermissionGroupsListResponse"
- }
- }
- },
- "AccountPermissionsListResponse": {
- "id": "AccountPermissionsListResponse",
- "type": "object",
- "description": "Account Permission List Response",
- "properties": {
- "accountPermissions": {
- "type": "array",
- "description": "Account permission collection.",
- "items": {
- "$ref": "AccountPermission"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionsListResponse\".",
- "default": "dfareporting#accountPermissionsListResponse"
- }
- }
- },
- "AccountUserProfile": {
- "id": "AccountUserProfile",
- "type": "object",
- "description": "AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of the user profile. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "active": {
- "type": "boolean",
- "description": "Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable."
- },
- "advertiserFilter": {
- "$ref": "ObjectFilter",
- "description": "Filter that describes which advertisers are visible to the user profile."
- },
- "campaignFilter": {
- "$ref": "ObjectFilter",
- "description": "Filter that describes which campaigns are visible to the user profile."
- },
- "comments": {
- "type": "string",
- "description": "Comments for this user profile."
- },
- "email": {
- "type": "string",
- "description": "Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion."
- },
- "id": {
- "type": "string",
- "description": "ID of the user profile. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountUserProfile\".",
- "default": "dfareporting#accountUserProfile"
- },
- "locale": {
- "type": "string",
- "description": "Locale of the user profile. This is a required field.\nAcceptable values are: \n- \"cs\" (Czech) \n- \"de\" (German) \n- \"en\" (English) \n- \"en-GB\" (English United Kingdom) \n- \"es\" (Spanish) \n- \"fr\" (French) \n- \"it\" (Italian) \n- \"ja\" (Japanese) \n- \"ko\" (Korean) \n- \"pl\" (Polish) \n- \"pt-BR\" (Portuguese Brazil)\n- \"ru\" (Russian) \n- \"sv\" (Swedish) \n- \"tr\" (Turkish) \n- \"zh-CN\" (Chinese Simplified) \n- \"zh-TW\" (Chinese Traditional)"
- },
- "name": {
- "type": "string",
- "description": "Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: \"&;\"#%,\"."
- },
- "siteFilter": {
- "$ref": "ObjectFilter",
- "description": "Filter that describes which sites are visible to the user profile."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of the user profile. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "traffickerType": {
- "type": "string",
- "description": "Trafficker type of this user profile.",
- "enum": [
- "EXTERNAL_TRAFFICKER",
- "INTERNAL_NON_TRAFFICKER",
- "INTERNAL_TRAFFICKER"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "userAccessType": {
- "type": "string",
- "description": "User type of the user profile. This is a read-only field that can be left blank.",
- "enum": [
- "INTERNAL_ADMINISTRATOR",
- "NORMAL_USER",
- "SUPER_USER"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "userRoleFilter": {
- "$ref": "ObjectFilter",
- "description": "Filter that describes which user roles are visible to the user profile."
- },
- "userRoleId": {
- "type": "string",
- "description": "User role ID of the user profile. This is a required field.",
- "format": "int64"
- }
- }
- },
- "AccountUserProfilesListResponse": {
- "id": "AccountUserProfilesListResponse",
- "type": "object",
- "description": "Account User Profile List Response",
- "properties": {
- "accountUserProfiles": {
- "type": "array",
- "description": "Account user profile collection.",
- "items": {
- "$ref": "AccountUserProfile"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountUserProfilesListResponse\".",
- "default": "dfareporting#accountUserProfilesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "AccountsListResponse": {
- "id": "AccountsListResponse",
- "type": "object",
- "description": "Account List Response",
- "properties": {
- "accounts": {
- "type": "array",
- "description": "Account collection.",
- "items": {
- "$ref": "Account"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountsListResponse\".",
- "default": "dfareporting#accountsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "Activities": {
- "id": "Activities",
- "type": "object",
- "description": "Represents an activity group.",
- "properties": {
- "filters": {
- "type": "array",
- "description": "List of activity filters. The dimension values need to be all either of type \"dfa:activity\" or \"dfa:activityGroup\".",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#activities.",
- "default": "dfareporting#activities"
- },
- "metricNames": {
- "type": "array",
- "description": "List of names of floodlight activity metrics.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "Ad": {
- "id": "Ad",
- "type": "object",
- "description": "Contains properties of a DCM ad.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this ad. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "active": {
- "type": "boolean",
- "description": "Whether this ad is active."
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this ad. This is a required field on insertion.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "archived": {
- "type": "boolean",
- "description": "Whether this ad is archived."
- },
- "audienceSegmentId": {
- "type": "string",
- "description": "Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.",
- "format": "int64"
- },
- "campaignId": {
- "type": "string",
- "description": "Campaign ID of this ad. This is a required field on insertion.",
- "format": "int64"
- },
- "campaignIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
- },
- "clickThroughUrl": {
- "$ref": "ClickThroughUrl",
- "description": "Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER."
- },
- "clickThroughUrlSuffixProperties": {
- "$ref": "ClickThroughUrlSuffixProperties",
- "description": "Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative."
- },
- "comments": {
- "type": "string",
- "description": "Comments for this ad."
- },
- "compatibility": {
- "type": "string",
- "description": "Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.",
- "enum": [
- "APP",
- "APP_INTERSTITIAL",
- "IN_STREAM_VIDEO",
- "WEB",
- "WEB_INTERSTITIAL"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "createInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the creation of this ad.This is a read-only field."
- },
- "creativeGroupAssignments": {
- "type": "array",
- "description": "Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.",
- "items": {
- "$ref": "CreativeGroupAssignment"
- }
- },
- "creativeRotation": {
- "$ref": "CreativeRotation",
- "description": "Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment."
- },
- "dayPartTargeting": {
- "$ref": "DayPartTargeting",
- "description": "Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD."
- },
- "defaultClickThroughEventTagProperties": {
- "$ref": "DefaultClickThroughEventTagProperties",
- "description": "Default click-through event tag properties for this ad."
- },
- "deliverySchedule": {
- "$ref": "DeliverySchedule",
- "description": "Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD."
- },
- "dynamicClickTracker": {
- "type": "boolean",
- "description": "Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert."
- },
- "endTime": {
- "type": "string",
- "description": "Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.",
- "format": "date-time"
- },
- "eventTagOverrides": {
- "type": "array",
- "description": "Event tag overrides for this ad.",
- "items": {
- "$ref": "EventTagOverride"
- }
- },
- "geoTargeting": {
- "$ref": "GeoTargeting",
- "description": "Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD."
- },
- "id": {
- "type": "string",
- "description": "ID of this ad. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this ad. This is a read-only, auto-generated field."
- },
- "keyValueTargetingExpression": {
- "$ref": "KeyValueTargetingExpression",
- "description": "Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#ad\".",
- "default": "dfareporting#ad"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this ad. This is a read-only field."
- },
- "name": {
- "type": "string",
- "description": "Name of this ad. This is a required field and must be less than 256 characters long."
- },
- "placementAssignments": {
- "type": "array",
- "description": "Placement assignments for this ad.",
- "items": {
- "$ref": "PlacementAssignment"
- }
- },
- "remarketing_list_expression": {
- "$ref": "ListTargetingExpression",
- "description": "Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad."
- },
- "size": {
- "$ref": "Size",
- "description": "Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD."
- },
- "sslCompliant": {
- "type": "boolean",
- "description": "Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated."
- },
- "sslRequired": {
- "type": "boolean",
- "description": "Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated."
- },
- "startTime": {
- "type": "string",
- "description": "Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.",
- "format": "date-time"
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this ad. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "technologyTargeting": {
- "$ref": "TechnologyTargeting",
- "description": "Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD."
- },
- "type": {
- "type": "string",
- "description": "Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).",
- "enum": [
- "AD_SERVING_CLICK_TRACKER",
- "AD_SERVING_DEFAULT_AD",
- "AD_SERVING_STANDARD_AD",
- "AD_SERVING_TRACKING"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- }
- }
- },
- "AdSlot": {
- "id": "AdSlot",
- "type": "object",
- "description": "Ad Slot",
- "properties": {
- "comment": {
- "type": "string",
- "description": "Comment for this ad slot."
- },
- "compatibility": {
- "type": "string",
- "description": "Ad slot compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.",
- "enum": [
- "PLANNING_RENDERING_ENVIRONMENT_TYPE_APP",
- "PLANNING_RENDERING_ENVIRONMENT_TYPE_APP_INTERSTITIAL",
- "PLANNING_RENDERING_ENVIRONMENT_TYPE_IN_STREAM_VIDEO",
- "PLANNING_RENDERING_ENVIRONMENT_TYPE_WEB",
- "PLANNING_RENDERING_ENVIRONMENT_TYPE_WEB_INTERSTITIAL"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "height": {
- "type": "string",
- "description": "Height of this ad slot.",
- "format": "int64"
- },
- "linkedPlacementId": {
- "type": "string",
- "description": "ID of the placement from an external platform that is linked to this ad slot.",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "Name of this ad slot."
- },
- "paymentSourceType": {
- "type": "string",
- "description": "Payment source type of this ad slot.",
- "enum": [
- "PLANNING_PAYMENT_SOURCE_TYPE_AGENCY_PAID",
- "PLANNING_PAYMENT_SOURCE_TYPE_PUBLISHER_PAID"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "primary": {
- "type": "boolean",
- "description": "Primary ad slot of a roadblock inventory item."
- },
- "width": {
- "type": "string",
- "description": "Width of this ad slot.",
- "format": "int64"
- }
- }
- },
- "AdsListResponse": {
- "id": "AdsListResponse",
- "type": "object",
- "description": "Ad List Response",
- "properties": {
- "ads": {
- "type": "array",
- "description": "Ad collection.",
- "items": {
- "$ref": "Ad"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#adsListResponse\".",
- "default": "dfareporting#adsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "Advertiser": {
- "id": "Advertiser",
- "type": "object",
- "description": "Contains properties of a DCM advertiser.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this advertiser.This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "advertiserGroupId": {
- "type": "string",
- "description": "ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.",
- "format": "int64"
- },
- "clickThroughUrlSuffix": {
- "type": "string",
- "description": "Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long."
- },
- "defaultClickThroughEventTagId": {
- "type": "string",
- "description": "ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.",
- "format": "int64"
- },
- "defaultEmail": {
- "type": "string",
- "description": "Default email address used in sender field for tag emails."
- },
- "floodlightConfigurationId": {
- "type": "string",
- "description": "Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: \n- This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. \n- This advertiser's original floodlight configuration is not already shared with another advertiser.",
- "format": "int64"
- },
- "floodlightConfigurationIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field."
- },
- "id": {
- "type": "string",
- "description": "ID of this advertiser. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this advertiser. This is a read-only, auto-generated field."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiser\".",
- "default": "dfareporting#advertiser"
- },
- "name": {
- "type": "string",
- "description": "Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account."
- },
- "originalFloodlightConfigurationId": {
- "type": "string",
- "description": "Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.",
- "format": "int64"
- },
- "status": {
- "type": "string",
- "description": "Status of this advertiser.",
- "enum": [
- "APPROVED",
- "ON_HOLD"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this advertiser.This is a read-only field that can be left blank.",
- "format": "int64"
- }
- }
- },
- "AdvertiserGroup": {
- "id": "AdvertiserGroup",
- "type": "object",
- "description": "Groups advertisers together so that reports can be generated for the entire group at once.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this advertiser group. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "ID of this advertiser group. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserGroup\".",
- "default": "dfareporting#advertiserGroup"
- },
- "name": {
- "type": "string",
- "description": "Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account."
- }
- }
- },
- "AdvertiserGroupsListResponse": {
- "id": "AdvertiserGroupsListResponse",
- "type": "object",
- "description": "Advertiser Group List Response",
- "properties": {
- "advertiserGroups": {
- "type": "array",
- "description": "Advertiser group collection.",
- "items": {
- "$ref": "AdvertiserGroup"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserGroupsListResponse\".",
- "default": "dfareporting#advertiserGroupsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "AdvertisersListResponse": {
- "id": "AdvertisersListResponse",
- "type": "object",
- "description": "Advertiser List Response",
- "properties": {
- "advertisers": {
- "type": "array",
- "description": "Advertiser collection.",
- "items": {
- "$ref": "Advertiser"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertisersListResponse\".",
- "default": "dfareporting#advertisersListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "AudienceSegment": {
- "id": "AudienceSegment",
- "type": "object",
- "description": "Audience Segment.",
- "properties": {
- "allocation": {
- "type": "integer",
- "description": "Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.",
- "format": "int32"
- },
- "id": {
- "type": "string",
- "description": "ID of this audience segment. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "Name of this audience segment. This is a required field and must be less than 65 characters long."
- }
- }
- },
- "AudienceSegmentGroup": {
- "id": "AudienceSegmentGroup",
- "type": "object",
- "description": "Audience Segment Group.",
- "properties": {
- "audienceSegments": {
- "type": "array",
- "description": "Audience segments assigned to this group. The number of segments must be between 2 and 100.",
- "items": {
- "$ref": "AudienceSegment"
- }
- },
- "id": {
- "type": "string",
- "description": "ID of this audience segment group. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "Name of this audience segment group. This is a required field and must be less than 65 characters long."
- }
- }
- },
- "Browser": {
- "id": "Browser",
- "type": "object",
- "description": "Contains information about a browser that can be targeted by ads.",
- "properties": {
- "browserVersionId": {
- "type": "string",
- "description": "ID referring to this grouping of browser and version numbers. This is the ID used for targeting.",
- "format": "int64"
- },
- "dartId": {
- "type": "string",
- "description": "DART ID of this browser. This is the ID used when generating reports.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#browser\".",
- "default": "dfareporting#browser"
- },
- "majorVersion": {
- "type": "string",
- "description": "Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is."
- },
- "minorVersion": {
- "type": "string",
- "description": "Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is."
- },
- "name": {
- "type": "string",
- "description": "Name of this browser."
- }
- }
- },
- "BrowsersListResponse": {
- "id": "BrowsersListResponse",
- "type": "object",
- "description": "Browser List Response",
- "properties": {
- "browsers": {
- "type": "array",
- "description": "Browser collection.",
- "items": {
- "$ref": "Browser"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#browsersListResponse\".",
- "default": "dfareporting#browsersListResponse"
- }
- }
- },
- "Campaign": {
- "id": "Campaign",
- "type": "object",
- "description": "Contains properties of a DCM campaign.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this campaign. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "additionalCreativeOptimizationConfigurations": {
- "type": "array",
- "description": "Additional creative optimization configurations for the campaign.",
- "items": {
- "$ref": "CreativeOptimizationConfiguration"
- }
- },
- "advertiserGroupId": {
- "type": "string",
- "description": "Advertiser group ID of the associated advertiser.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this campaign. This is a required field.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field."
- },
- "archived": {
- "type": "boolean",
- "description": "Whether this campaign has been archived."
- },
- "audienceSegmentGroups": {
- "type": "array",
- "description": "Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.",
- "items": {
- "$ref": "AudienceSegmentGroup"
- }
- },
- "billingInvoiceCode": {
- "type": "string",
- "description": "Billing invoice code included in the DCM client billing invoices associated with the campaign."
- },
- "clickThroughUrlSuffixProperties": {
- "$ref": "ClickThroughUrlSuffixProperties",
- "description": "Click-through URL suffix override properties for this campaign."
- },
- "comment": {
- "type": "string",
- "description": "Arbitrary comments about this campaign. Must be less than 256 characters long."
- },
- "comscoreVceEnabled": {
- "type": "boolean",
- "description": "Whether comScore vCE reports are enabled for this campaign."
- },
- "createInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the creation of this campaign. This is a read-only field."
- },
- "creativeGroupIds": {
- "type": "array",
- "description": "List of creative group IDs that are assigned to the campaign.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "creativeOptimizationConfiguration": {
- "$ref": "CreativeOptimizationConfiguration",
- "description": "Creative optimization configuration for the campaign."
- },
- "defaultClickThroughEventTagProperties": {
- "$ref": "DefaultClickThroughEventTagProperties",
- "description": "Click-through event tag ID override properties for this campaign."
- },
- "endDate": {
- "type": "string",
- "description": "Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.",
- "format": "date"
- },
- "eventTagOverrides": {
- "type": "array",
- "description": "Overrides that can be used to activate or deactivate advertiser event tags.",
- "items": {
- "$ref": "EventTagOverride"
- }
- },
- "externalId": {
- "type": "string",
- "description": "External ID for this campaign."
- },
- "id": {
- "type": "string",
- "description": "ID of this campaign. This is a read-only auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this campaign. This is a read-only, auto-generated field."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaign\".",
- "default": "dfareporting#campaign"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this campaign. This is a read-only field."
- },
- "lookbackConfiguration": {
- "$ref": "LookbackConfiguration",
- "description": "Lookback window settings for the campaign."
- },
- "name": {
- "type": "string",
- "description": "Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser."
- },
- "nielsenOcrEnabled": {
- "type": "boolean",
- "description": "Whether Nielsen reports are enabled for this campaign."
- },
- "startDate": {
- "type": "string",
- "description": "Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.",
- "format": "date"
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this campaign. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "traffickerEmails": {
- "type": "array",
- "description": "Campaign trafficker contact emails.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "CampaignCreativeAssociation": {
- "id": "CampaignCreativeAssociation",
- "type": "object",
- "description": "Identifies a creative which has been associated with a given campaign.",
- "properties": {
- "creativeId": {
- "type": "string",
- "description": "ID of the creative associated with the campaign. This is a required field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignCreativeAssociation\".",
- "default": "dfareporting#campaignCreativeAssociation"
- }
- }
- },
- "CampaignCreativeAssociationsListResponse": {
- "id": "CampaignCreativeAssociationsListResponse",
- "type": "object",
- "description": "Campaign Creative Association List Response",
- "properties": {
- "campaignCreativeAssociations": {
- "type": "array",
- "description": "Campaign creative association collection",
- "items": {
- "$ref": "CampaignCreativeAssociation"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignCreativeAssociationsListResponse\".",
- "default": "dfareporting#campaignCreativeAssociationsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "CampaignsListResponse": {
- "id": "CampaignsListResponse",
- "type": "object",
- "description": "Campaign List Response",
- "properties": {
- "campaigns": {
- "type": "array",
- "description": "Campaign collection.",
- "items": {
- "$ref": "Campaign"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignsListResponse\".",
- "default": "dfareporting#campaignsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "ChangeLog": {
- "id": "ChangeLog",
- "type": "object",
- "description": "Describes a change that a user has made to a resource.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of the modified object.",
- "format": "int64"
- },
- "action": {
- "type": "string",
- "description": "Action which caused the change."
- },
- "changeTime": {
- "type": "string",
- "description": "Time when the object was modified.",
- "format": "date-time"
- },
- "fieldName": {
- "type": "string",
- "description": "Field name of the object which changed."
- },
- "id": {
- "type": "string",
- "description": "ID of this change log.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#changeLog\".",
- "default": "dfareporting#changeLog"
- },
- "newValue": {
- "type": "string",
- "description": "New value of the object field."
- },
- "objectId": {
- "type": "string",
- "description": "ID of the object of this change log. The object could be a campaign, placement, ad, or other type.",
- "format": "int64"
- },
- "objectType": {
- "type": "string",
- "description": "Object type of the change log."
- },
- "oldValue": {
- "type": "string",
- "description": "Old value of the object field."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of the modified object.",
- "format": "int64"
- },
- "transactionId": {
- "type": "string",
- "description": "Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId.",
- "format": "int64"
- },
- "userProfileId": {
- "type": "string",
- "description": "ID of the user who modified the object.",
- "format": "int64"
- },
- "userProfileName": {
- "type": "string",
- "description": "User profile name of the user who modified the object."
- }
- }
- },
- "ChangeLogsListResponse": {
- "id": "ChangeLogsListResponse",
- "type": "object",
- "description": "Change Log List Response",
- "properties": {
- "changeLogs": {
- "type": "array",
- "description": "Change log collection.",
- "items": {
- "$ref": "ChangeLog"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#changeLogsListResponse\".",
- "default": "dfareporting#changeLogsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "CitiesListResponse": {
- "id": "CitiesListResponse",
- "type": "object",
- "description": "City List Response",
- "properties": {
- "cities": {
- "type": "array",
- "description": "City collection.",
- "items": {
- "$ref": "City"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#citiesListResponse\".",
- "default": "dfareporting#citiesListResponse"
- }
- }
- },
- "City": {
- "id": "City",
- "type": "object",
- "description": "Contains information about a city that can be targeted by ads.",
- "properties": {
- "countryCode": {
- "type": "string",
- "description": "Country code of the country to which this city belongs."
- },
- "countryDartId": {
- "type": "string",
- "description": "DART ID of the country to which this city belongs.",
- "format": "int64"
- },
- "dartId": {
- "type": "string",
- "description": "DART ID of this city. This is the ID used for targeting and generating reports.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#city\".",
- "default": "dfareporting#city"
- },
- "metroCode": {
- "type": "string",
- "description": "Metro region code of the metro region (DMA) to which this city belongs."
- },
- "metroDmaId": {
- "type": "string",
- "description": "ID of the metro region (DMA) to which this city belongs.",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "Name of this city."
- },
- "regionCode": {
- "type": "string",
- "description": "Region code of the region to which this city belongs."
- },
- "regionDartId": {
- "type": "string",
- "description": "DART ID of the region to which this city belongs.",
- "format": "int64"
- }
- }
- },
- "ClickTag": {
- "id": "ClickTag",
- "type": "object",
- "description": "Creative Click Tag.",
- "properties": {
- "eventName": {
- "type": "string",
- "description": "Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives."
- },
- "name": {
- "type": "string",
- "description": "Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field."
- },
- "value": {
- "type": "string",
- "description": "Parameter value for the specified click tag. This field contains a click-through url."
- }
- }
- },
- "ClickThroughUrl": {
- "id": "ClickThroughUrl",
- "type": "object",
- "description": "Click-through URL",
- "properties": {
- "customClickThroughUrl": {
- "type": "string",
- "description": "Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset."
- },
- "defaultLandingPage": {
- "type": "boolean",
- "description": "Whether the campaign default landing page is used."
- },
- "landingPageId": {
- "type": "string",
- "description": "ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.",
- "format": "int64"
- }
- }
- },
- "ClickThroughUrlSuffixProperties": {
- "id": "ClickThroughUrlSuffixProperties",
- "type": "object",
- "description": "Click Through URL Suffix settings.",
- "properties": {
- "clickThroughUrlSuffix": {
- "type": "string",
- "description": "Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long."
- },
- "overrideInheritedSuffix": {
- "type": "boolean",
- "description": "Whether this entity should override the inherited click-through URL suffix with its own defined value."
- }
- }
- },
- "CompanionClickThroughOverride": {
- "id": "CompanionClickThroughOverride",
- "type": "object",
- "description": "Companion Click-through override.",
- "properties": {
- "clickThroughUrl": {
- "$ref": "ClickThroughUrl",
- "description": "Click-through URL of this companion click-through override."
- },
- "creativeId": {
- "type": "string",
- "description": "ID of the creative for this companion click-through override.",
- "format": "int64"
- }
- }
- },
- "CompatibleFields": {
- "id": "CompatibleFields",
- "type": "object",
- "description": "Represents a response to the queryCompatibleFields method.",
- "properties": {
- "crossDimensionReachReportCompatibleFields": {
- "$ref": "CrossDimensionReachReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"CROSS_DIMENSION_REACH\"."
- },
- "floodlightReportCompatibleFields": {
- "$ref": "FloodlightReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"FLOODLIGHT\"."
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#compatibleFields.",
- "default": "dfareporting#compatibleFields"
- },
- "pathToConversionReportCompatibleFields": {
- "$ref": "PathToConversionReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"PATH_TO_CONVERSION\"."
- },
- "reachReportCompatibleFields": {
- "$ref": "ReachReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"REACH\"."
- },
- "reportCompatibleFields": {
- "$ref": "ReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"STANDARD\"."
- }
- }
- },
- "ConnectionType": {
- "id": "ConnectionType",
- "type": "object",
- "description": "Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.",
- "properties": {
- "id": {
- "type": "string",
- "description": "ID of this connection type.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#connectionType\".",
- "default": "dfareporting#connectionType"
- },
- "name": {
- "type": "string",
- "description": "Name of this connection type."
- }
- }
- },
- "ConnectionTypesListResponse": {
- "id": "ConnectionTypesListResponse",
- "type": "object",
- "description": "Connection Type List Response",
- "properties": {
- "connectionTypes": {
- "type": "array",
- "description": "Collection of connection types such as broadband and mobile.",
- "items": {
- "$ref": "ConnectionType"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#connectionTypesListResponse\".",
- "default": "dfareporting#connectionTypesListResponse"
- }
- }
- },
- "ContentCategoriesListResponse": {
- "id": "ContentCategoriesListResponse",
- "type": "object",
- "description": "Content Category List Response",
- "properties": {
- "contentCategories": {
- "type": "array",
- "description": "Content category collection.",
- "items": {
- "$ref": "ContentCategory"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#contentCategoriesListResponse\".",
- "default": "dfareporting#contentCategoriesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "ContentCategory": {
- "id": "ContentCategory",
- "type": "object",
- "description": "Organizes placements according to the contents of their associated webpages.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this content category. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "ID of this content category. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#contentCategory\".",
- "default": "dfareporting#contentCategory"
- },
- "name": {
- "type": "string",
- "description": "Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account."
- }
- }
- },
- "CountriesListResponse": {
- "id": "CountriesListResponse",
- "type": "object",
- "description": "Country List Response",
- "properties": {
- "countries": {
- "type": "array",
- "description": "Country collection.",
- "items": {
- "$ref": "Country"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#countriesListResponse\".",
- "default": "dfareporting#countriesListResponse"
- }
- }
- },
- "Country": {
- "id": "Country",
- "type": "object",
- "description": "Contains information about a country that can be targeted by ads.",
- "properties": {
- "countryCode": {
- "type": "string",
- "description": "Country code."
- },
- "dartId": {
- "type": "string",
- "description": "DART ID of this country. This is the ID used for targeting and generating reports.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#country\".",
- "default": "dfareporting#country"
- },
- "name": {
- "type": "string",
- "description": "Name of this country."
- },
- "sslEnabled": {
- "type": "boolean",
- "description": "Whether ad serving supports secure servers in this country."
- }
- }
- },
- "Creative": {
- "id": "Creative",
- "type": "object",
- "description": "Contains properties of a Creative.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.",
- "format": "int64"
- },
- "active": {
- "type": "boolean",
- "description": "Whether the creative is active. Applicable to all creative types."
- },
- "adParameters": {
- "type": "string",
- "description": "Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID."
- },
- "adTagKeys": {
- "type": "array",
- "description": "Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "items": {
- "type": "string"
- }
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this creative. This is a required field. Applicable to all creative types.",
- "format": "int64"
- },
- "allowScriptAccess": {
- "type": "boolean",
- "description": "Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE."
- },
- "archived": {
- "type": "boolean",
- "description": "Whether the creative is archived. Applicable to all creative types."
- },
- "artworkType": {
- "type": "string",
- "description": "Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "enum": [
- "ARTWORK_TYPE_FLASH",
- "ARTWORK_TYPE_HTML5",
- "ARTWORK_TYPE_MIXED"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "authoringTool": {
- "type": "string",
- "description": "Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.",
- "enum": [
- "NINJA",
- "SWIFFY"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "auto_advance_images": {
- "type": "boolean",
- "description": "Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE."
- },
- "backgroundColor": {
- "type": "string",
- "description": "The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE."
- },
- "backupImageClickThroughUrl": {
- "type": "string",
- "description": "Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER."
- },
- "backupImageFeatures": {
- "type": "array",
- "description": "List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.",
- "items": {
- "type": "string",
- "enum": [
- "APPLICATION_CACHE",
- "AUDIO",
- "CANVAS",
- "CANVAS_TEXT",
- "CSS_ANIMATIONS",
- "CSS_BACKGROUND_SIZE",
- "CSS_BORDER_IMAGE",
- "CSS_BORDER_RADIUS",
- "CSS_BOX_SHADOW",
- "CSS_COLUMNS",
- "CSS_FLEX_BOX",
- "CSS_FONT_FACE",
- "CSS_GENERATED_CONTENT",
- "CSS_GRADIENTS",
- "CSS_HSLA",
- "CSS_MULTIPLE_BGS",
- "CSS_OPACITY",
- "CSS_REFLECTIONS",
- "CSS_RGBA",
- "CSS_TEXT_SHADOW",
- "CSS_TRANSFORMS",
- "CSS_TRANSFORMS3D",
- "CSS_TRANSITIONS",
- "DRAG_AND_DROP",
- "GEO_LOCATION",
- "HASH_CHANGE",
- "HISTORY",
- "INDEXED_DB",
- "INLINE_SVG",
- "INPUT_ATTR_AUTOCOMPLETE",
- "INPUT_ATTR_AUTOFOCUS",
- "INPUT_ATTR_LIST",
- "INPUT_ATTR_MAX",
- "INPUT_ATTR_MIN",
- "INPUT_ATTR_MULTIPLE",
- "INPUT_ATTR_PATTERN",
- "INPUT_ATTR_PLACEHOLDER",
- "INPUT_ATTR_REQUIRED",
- "INPUT_ATTR_STEP",
- "INPUT_TYPE_COLOR",
- "INPUT_TYPE_DATE",
- "INPUT_TYPE_DATETIME",
- "INPUT_TYPE_DATETIME_LOCAL",
- "INPUT_TYPE_EMAIL",
- "INPUT_TYPE_MONTH",
- "INPUT_TYPE_NUMBER",
- "INPUT_TYPE_RANGE",
- "INPUT_TYPE_SEARCH",
- "INPUT_TYPE_TEL",
- "INPUT_TYPE_TIME",
- "INPUT_TYPE_URL",
- "INPUT_TYPE_WEEK",
- "LOCAL_STORAGE",
- "POST_MESSAGE",
- "SESSION_STORAGE",
- "SMIL",
- "SVG_CLIP_PATHS",
- "SVG_FE_IMAGE",
- "SVG_FILTERS",
- "SVG_HREF",
- "TOUCH",
- "VIDEO",
- "WEBGL",
- "WEB_SOCKETS",
- "WEB_SQL_DATABASE",
- "WEB_WORKERS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- },
- "backupImageReportingLabel": {
- "type": "string",
- "description": "Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER."
- },
- "backupImageTargetWindow": {
- "$ref": "TargetWindow",
- "description": "Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER."
- },
- "clickTags": {
- "type": "array",
- "description": "Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.",
- "items": {
- "$ref": "ClickTag"
- }
- },
- "commercialId": {
- "type": "string",
- "description": "Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
- },
- "companionCreatives": {
- "type": "array",
- "description": "List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "compatibility": {
- "type": "array",
- "description": "Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.\n\nAcceptable values are:\n- \"APP\"\n- \"APP_INTERSTITIAL\"\n- \"IN_STREAM_VIDEO\"\n- \"WEB\"\n- \"WEB_INTERSTITIAL\"",
- "items": {
- "type": "string",
- "enum": [
- "APP",
- "APP_INTERSTITIAL",
- "IN_STREAM_VIDEO",
- "WEB",
- "WEB_INTERSTITIAL"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- }
- },
- "convertFlashToHtml5": {
- "type": "boolean",
- "description": "Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE."
- },
- "counterCustomEvents": {
- "type": "array",
- "description": "List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "items": {
- "$ref": "CreativeCustomEvent"
- }
- },
- "creativeAssets": {
- "type": "array",
- "description": "Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT",
- "items": {
- "$ref": "CreativeAsset"
- }
- },
- "creativeFieldAssignments": {
- "type": "array",
- "description": "Creative field assignments for this creative. Applicable to all creative types.",
- "items": {
- "$ref": "CreativeFieldAssignment"
- }
- },
- "customKeyValues": {
- "type": "array",
- "description": "Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "items": {
- "type": "string"
- }
- },
- "exitCustomEvents": {
- "type": "array",
- "description": "List of exit events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "items": {
- "$ref": "CreativeCustomEvent"
- }
- },
- "fsCommand": {
- "$ref": "FsCommand",
- "description": "OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE."
- },
- "htmlCode": {
- "type": "string",
- "description": "HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA."
- },
- "htmlCodeLocked": {
- "type": "boolean",
- "description": "Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER."
- },
- "id": {
- "type": "string",
- "description": "ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creative\".",
- "default": "dfareporting#creative"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Creative last modification information. This is a read-only field. Applicable to all creative types."
- },
- "latestTraffickedCreativeId": {
- "type": "string",
- "description": "Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types."
- },
- "overrideCss": {
- "type": "string",
- "description": "Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA."
- },
- "redirectUrl": {
- "type": "string",
- "description": "URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT"
- },
- "renderingId": {
- "type": "string",
- "description": "ID of current rendering version. This is a read-only field. Applicable to all creative types.",
- "format": "int64"
- },
- "renderingIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types."
- },
- "requiredFlashPluginVersion": {
- "type": "string",
- "description": "The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID."
- },
- "requiredFlashVersion": {
- "type": "integer",
- "description": "The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.",
- "format": "int32"
- },
- "size": {
- "$ref": "Size",
- "description": "Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA."
- },
- "skippable": {
- "type": "boolean",
- "description": "Whether the user can choose to skip the creative. Applicable to the following creative types: INSTREAM_VIDEO."
- },
- "sslCompliant": {
- "type": "boolean",
- "description": "Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types."
- },
- "studioAdvertiserId": {
- "type": "string",
- "description": "Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "format": "int64"
- },
- "studioCreativeId": {
- "type": "string",
- "description": "Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "format": "int64"
- },
- "studioTraffickedCreativeId": {
- "type": "string",
- "description": "Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "format": "int64"
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.",
- "format": "int64"
- },
- "thirdPartyBackupImageImpressionsUrl": {
- "type": "string",
- "description": "Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA"
- },
- "thirdPartyRichMediaImpressionsUrl": {
- "type": "string",
- "description": "Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA"
- },
- "thirdPartyUrls": {
- "type": "array",
- "description": "Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.",
- "items": {
- "$ref": "ThirdPartyTrackingUrl"
- }
- },
- "timerCustomEvents": {
- "type": "array",
- "description": "List of timer events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "items": {
- "$ref": "CreativeCustomEvent"
- }
- },
- "totalFileSize": {
- "type": "string",
- "description": "Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "format": "int64"
- },
- "type": {
- "type": "string",
- "description": "Type of this creative.This is a required field. Applicable to all creative types.",
- "enum": [
- "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO",
- "CUSTOM_INPAGE",
- "CUSTOM_INTERSTITIAL",
- "ENHANCED_BANNER",
- "ENHANCED_IMAGE",
- "FLASH_INPAGE",
- "HTML5_BANNER",
- "IMAGE",
- "INSTREAM_VIDEO",
- "INTERNAL_REDIRECT",
- "INTERSTITIAL_INTERNAL_REDIRECT",
- "REDIRECT",
- "RICH_MEDIA_EXPANDING",
- "RICH_MEDIA_IM_EXPAND",
- "RICH_MEDIA_INPAGE",
- "RICH_MEDIA_INPAGE_FLOATING",
- "RICH_MEDIA_INTERSTITIAL_FLOAT",
- "RICH_MEDIA_MOBILE_IN_APP",
- "RICH_MEDIA_MULTI_FLOATING",
- "RICH_MEDIA_PEEL_DOWN",
- "TRACKING_TEXT",
- "VAST_REDIRECT",
- "VPAID_LINEAR",
- "VPAID_NON_LINEAR"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "version": {
- "type": "integer",
- "description": "The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.",
- "format": "int32"
- },
- "videoDescription": {
- "type": "string",
- "description": "Description of the video ad. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
- },
- "videoDuration": {
- "type": "number",
- "description": "Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.",
- "format": "float"
- }
- }
- },
- "CreativeAsset": {
- "id": "CreativeAsset",
- "type": "object",
- "description": "Creative Asset.",
- "properties": {
- "actionScript3": {
- "type": "boolean",
- "description": "Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER."
- },
- "active": {
- "type": "boolean",
- "description": "Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
- },
- "alignment": {
- "type": "string",
- "description": "Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.",
- "enum": [
- "ALIGNMENT_BOTTOM",
- "ALIGNMENT_LEFT",
- "ALIGNMENT_RIGHT",
- "ALIGNMENT_TOP"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- },
- "artworkType": {
- "type": "string",
- "description": "Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "ARTWORK_TYPE_FLASH",
- "ARTWORK_TYPE_HTML5",
- "ARTWORK_TYPE_MIXED"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "assetIdentifier": {
- "$ref": "CreativeAssetId",
- "description": "Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT."
- },
- "backupImageExit": {
- "$ref": "CreativeCustomEvent",
- "description": "Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA."
- },
- "bitRate": {
- "type": "integer",
- "description": "Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.",
- "format": "int32"
- },
- "childAssetType": {
- "type": "string",
- "description": "Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.",
- "enum": [
- "CHILD_ASSET_TYPE_DATA",
- "CHILD_ASSET_TYPE_FLASH",
- "CHILD_ASSET_TYPE_IMAGE",
- "CHILD_ASSET_TYPE_VIDEO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- },
- "collapsedSize": {
- "$ref": "Size",
- "description": "Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN."
- },
- "customStartTimeValue": {
- "type": "integer",
- "description": "Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.",
- "format": "int32"
- },
- "detectedFeatures": {
- "type": "array",
- "description": "List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.",
- "items": {
- "type": "string",
- "enum": [
- "APPLICATION_CACHE",
- "AUDIO",
- "CANVAS",
- "CANVAS_TEXT",
- "CSS_ANIMATIONS",
- "CSS_BACKGROUND_SIZE",
- "CSS_BORDER_IMAGE",
- "CSS_BORDER_RADIUS",
- "CSS_BOX_SHADOW",
- "CSS_COLUMNS",
- "CSS_FLEX_BOX",
- "CSS_FONT_FACE",
- "CSS_GENERATED_CONTENT",
- "CSS_GRADIENTS",
- "CSS_HSLA",
- "CSS_MULTIPLE_BGS",
- "CSS_OPACITY",
- "CSS_REFLECTIONS",
- "CSS_RGBA",
- "CSS_TEXT_SHADOW",
- "CSS_TRANSFORMS",
- "CSS_TRANSFORMS3D",
- "CSS_TRANSITIONS",
- "DRAG_AND_DROP",
- "GEO_LOCATION",
- "HASH_CHANGE",
- "HISTORY",
- "INDEXED_DB",
- "INLINE_SVG",
- "INPUT_ATTR_AUTOCOMPLETE",
- "INPUT_ATTR_AUTOFOCUS",
- "INPUT_ATTR_LIST",
- "INPUT_ATTR_MAX",
- "INPUT_ATTR_MIN",
- "INPUT_ATTR_MULTIPLE",
- "INPUT_ATTR_PATTERN",
- "INPUT_ATTR_PLACEHOLDER",
- "INPUT_ATTR_REQUIRED",
- "INPUT_ATTR_STEP",
- "INPUT_TYPE_COLOR",
- "INPUT_TYPE_DATE",
- "INPUT_TYPE_DATETIME",
- "INPUT_TYPE_DATETIME_LOCAL",
- "INPUT_TYPE_EMAIL",
- "INPUT_TYPE_MONTH",
- "INPUT_TYPE_NUMBER",
- "INPUT_TYPE_RANGE",
- "INPUT_TYPE_SEARCH",
- "INPUT_TYPE_TEL",
- "INPUT_TYPE_TIME",
- "INPUT_TYPE_URL",
- "INPUT_TYPE_WEEK",
- "LOCAL_STORAGE",
- "POST_MESSAGE",
- "SESSION_STORAGE",
- "SMIL",
- "SVG_CLIP_PATHS",
- "SVG_FE_IMAGE",
- "SVG_FILTERS",
- "SVG_HREF",
- "TOUCH",
- "VIDEO",
- "WEBGL",
- "WEB_SOCKETS",
- "WEB_SQL_DATABASE",
- "WEB_WORKERS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- },
- "displayType": {
- "type": "string",
- "description": "Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "ASSET_DISPLAY_TYPE_EXPANDING",
- "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH",
- "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH_EXPANDING",
- "ASSET_DISPLAY_TYPE_FLOATING",
- "ASSET_DISPLAY_TYPE_INPAGE",
- "ASSET_DISPLAY_TYPE_OVERLAY",
- "ASSET_DISPLAY_TYPE_PEEL_DOWN",
- "ASSET_DISPLAY_TYPE_VPAID_LINEAR",
- "ASSET_DISPLAY_TYPE_VPAID_NON_LINEAR"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "duration": {
- "type": "integer",
- "description": "Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.",
- "format": "int32"
- },
- "durationType": {
- "type": "string",
- "description": "Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "ASSET_DURATION_TYPE_AUTO",
- "ASSET_DURATION_TYPE_CUSTOM",
- "ASSET_DURATION_TYPE_NONE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "expandedDimension": {
- "$ref": "Size",
- "description": "Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
- },
- "fileSize": {
- "type": "string",
- "description": "File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.",
- "format": "int64"
- },
- "flashVersion": {
- "type": "integer",
- "description": "Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.",
- "format": "int32"
- },
- "hideFlashObjects": {
- "type": "boolean",
- "description": "Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA."
- },
- "hideSelectionBoxes": {
- "type": "boolean",
- "description": "Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA."
- },
- "horizontallyLocked": {
- "type": "boolean",
- "description": "Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA."
- },
- "id": {
- "type": "string",
- "description": "Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.",
- "format": "int64"
- },
- "mimeType": {
- "type": "string",
- "description": "Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
- },
- "offset": {
- "$ref": "OffsetPosition",
- "description": "Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN."
- },
- "originalBackup": {
- "type": "boolean",
- "description": "Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA."
- },
- "position": {
- "$ref": "OffsetPosition",
- "description": "Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA."
- },
- "positionLeftUnit": {
- "type": "string",
- "description": "Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "OFFSET_UNIT_PERCENT",
- "OFFSET_UNIT_PIXEL",
- "OFFSET_UNIT_PIXEL_FROM_CENTER"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "positionTopUnit": {
- "type": "string",
- "description": "Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "OFFSET_UNIT_PERCENT",
- "OFFSET_UNIT_PIXEL",
- "OFFSET_UNIT_PIXEL_FROM_CENTER"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "progressiveServingUrl": {
- "type": "string",
- "description": "Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
- },
- "pushdown": {
- "type": "boolean",
- "description": "Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height."
- },
- "pushdownDuration": {
- "type": "number",
- "description": "Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.",
- "format": "float"
- },
- "role": {
- "type": "string",
- "description": "Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.\nPRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.\nBACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.\nADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.\nOTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.\nPARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.\nTRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.\nALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.\nFor VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.",
- "enum": [
- "ADDITIONAL_FLASH",
- "ADDITIONAL_IMAGE",
- "ALTERNATE_VIDEO",
- "BACKUP_IMAGE",
- "OTHER",
- "PARENT_VIDEO",
- "PRIMARY",
- "TRANSCODED_VIDEO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "size": {
- "$ref": "Size",
- "description": "Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA."
- },
- "sslCompliant": {
- "type": "boolean",
- "description": "Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT."
- },
- "startTimeType": {
- "type": "string",
- "description": "Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "ASSET_START_TIME_TYPE_CUSTOM",
- "ASSET_START_TIME_TYPE_NONE"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "streamingServingUrl": {
- "type": "string",
- "description": "Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
- },
- "transparency": {
- "type": "boolean",
- "description": "Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets."
- },
- "verticallyLocked": {
- "type": "boolean",
- "description": "Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA."
- },
- "videoDuration": {
- "type": "number",
- "description": "Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.",
- "format": "float"
- },
- "windowMode": {
- "type": "string",
- "description": "Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.",
- "enum": [
- "OPAQUE",
- "TRANSPARENT",
- "WINDOW"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "zIndex": {
- "type": "integer",
- "description": "zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.",
- "format": "int32"
- },
- "zipFilename": {
- "type": "string",
- "description": "File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER."
- },
- "zipFilesize": {
- "type": "string",
- "description": "Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER."
- }
- }
- },
- "CreativeAssetId": {
- "id": "CreativeAssetId",
- "type": "object",
- "description": "Creative Asset ID.",
- "properties": {
- "name": {
- "type": "string",
- "description": "Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: \".-_ \". Spaces are allowed."
- },
- "type": {
- "type": "string",
- "description": "Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.",
- "enum": [
- "FLASH",
- "HTML",
- "HTML_IMAGE",
- "IMAGE",
- "VIDEO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- }
- }
- },
- "CreativeAssetMetadata": {
- "id": "CreativeAssetMetadata",
- "type": "object",
- "description": "CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.",
- "properties": {
- "assetIdentifier": {
- "$ref": "CreativeAssetId",
- "description": "ID of the creative asset. This is a required field."
- },
- "clickTags": {
- "type": "array",
- "description": "List of detected click tags for assets. This is a read-only auto-generated field.",
- "items": {
- "$ref": "ClickTag"
- }
- },
- "detectedFeatures": {
- "type": "array",
- "description": "List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.",
- "items": {
- "type": "string",
- "enum": [
- "APPLICATION_CACHE",
- "AUDIO",
- "CANVAS",
- "CANVAS_TEXT",
- "CSS_ANIMATIONS",
- "CSS_BACKGROUND_SIZE",
- "CSS_BORDER_IMAGE",
- "CSS_BORDER_RADIUS",
- "CSS_BOX_SHADOW",
- "CSS_COLUMNS",
- "CSS_FLEX_BOX",
- "CSS_FONT_FACE",
- "CSS_GENERATED_CONTENT",
- "CSS_GRADIENTS",
- "CSS_HSLA",
- "CSS_MULTIPLE_BGS",
- "CSS_OPACITY",
- "CSS_REFLECTIONS",
- "CSS_RGBA",
- "CSS_TEXT_SHADOW",
- "CSS_TRANSFORMS",
- "CSS_TRANSFORMS3D",
- "CSS_TRANSITIONS",
- "DRAG_AND_DROP",
- "GEO_LOCATION",
- "HASH_CHANGE",
- "HISTORY",
- "INDEXED_DB",
- "INLINE_SVG",
- "INPUT_ATTR_AUTOCOMPLETE",
- "INPUT_ATTR_AUTOFOCUS",
- "INPUT_ATTR_LIST",
- "INPUT_ATTR_MAX",
- "INPUT_ATTR_MIN",
- "INPUT_ATTR_MULTIPLE",
- "INPUT_ATTR_PATTERN",
- "INPUT_ATTR_PLACEHOLDER",
- "INPUT_ATTR_REQUIRED",
- "INPUT_ATTR_STEP",
- "INPUT_TYPE_COLOR",
- "INPUT_TYPE_DATE",
- "INPUT_TYPE_DATETIME",
- "INPUT_TYPE_DATETIME_LOCAL",
- "INPUT_TYPE_EMAIL",
- "INPUT_TYPE_MONTH",
- "INPUT_TYPE_NUMBER",
- "INPUT_TYPE_RANGE",
- "INPUT_TYPE_SEARCH",
- "INPUT_TYPE_TEL",
- "INPUT_TYPE_TIME",
- "INPUT_TYPE_URL",
- "INPUT_TYPE_WEEK",
- "LOCAL_STORAGE",
- "POST_MESSAGE",
- "SESSION_STORAGE",
- "SMIL",
- "SVG_CLIP_PATHS",
- "SVG_FE_IMAGE",
- "SVG_FILTERS",
- "SVG_HREF",
- "TOUCH",
- "VIDEO",
- "WEBGL",
- "WEB_SOCKETS",
- "WEB_SQL_DATABASE",
- "WEB_WORKERS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeAssetMetadata\".",
- "default": "dfareporting#creativeAssetMetadata"
- },
- "warnedValidationRules": {
- "type": "array",
- "description": "Rules validated during code generation that generated a warning. This is a read-only, auto-generated field.\n\nPossible values are:\n- \"CLICK_TAG_NON_TOP_LEVEL\"\n- \"CLICK_TAG_MISSING\"\n- \"CLICK_TAG_MORE_THAN_ONE\"\n- \"CLICK_TAG_INVALID\"\n- \"ORPHANED_ASSET\"\n- \"PRIMARY_HTML_MISSING\"\n- \"EXTERNAL_FILE_REFERENCED\"\n- \"MRAID_REFERENCED\"\n- \"ADMOB_REFERENCED\"\n- \"FILE_TYPE_INVALID\"\n- \"ZIP_INVALID\"\n- \"LINKED_FILE_NOT_FOUND\"\n- \"MAX_FLASH_VERSION_11\"\n- \"NOT_SSL_COMPLIANT\"\n- \"FILE_DETAIL_EMPTY\"\n- \"ASSET_INVALID\"\n- \"GWD_PROPERTIES_INVALID\"\n- \"ENABLER_UNSUPPORTED_METHOD_DCM\"\n- \"ASSET_FORMAT_UNSUPPORTED_DCM\"\n- \"COMPONENT_UNSUPPORTED_DCM\"\n- \"HTML5_FEATURE_UNSUPPORTED' \"",
- "items": {
- "type": "string",
- "enum": [
- "ADMOB_REFERENCED",
- "ASSET_FORMAT_UNSUPPORTED_DCM",
- "ASSET_INVALID",
- "CLICK_TAG_INVALID",
- "CLICK_TAG_MISSING",
- "CLICK_TAG_MORE_THAN_ONE",
- "CLICK_TAG_NON_TOP_LEVEL",
- "COMPONENT_UNSUPPORTED_DCM",
- "ENABLER_UNSUPPORTED_METHOD_DCM",
- "EXTERNAL_FILE_REFERENCED",
- "FILE_DETAIL_EMPTY",
- "FILE_TYPE_INVALID",
- "GWD_PROPERTIES_INVALID",
- "HTML5_FEATURE_UNSUPPORTED",
- "LINKED_FILE_NOT_FOUND",
- "MAX_FLASH_VERSION_11",
- "MRAID_REFERENCED",
- "NOT_SSL_COMPLIANT",
- "ORPHANED_ASSET",
- "PRIMARY_HTML_MISSING",
- "ZIP_INVALID"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- }
- }
- },
- "CreativeAssignment": {
- "id": "CreativeAssignment",
- "type": "object",
- "description": "Creative Assignment.",
- "properties": {
- "active": {
- "type": "boolean",
- "description": "Whether this creative assignment is active. When true, the creative will be included in the ad's rotation."
- },
- "applyEventTags": {
- "type": "boolean",
- "description": "Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO."
- },
- "clickThroughUrl": {
- "$ref": "ClickThroughUrl",
- "description": "Click-through URL of the creative assignment."
- },
- "companionCreativeOverrides": {
- "type": "array",
- "description": "Companion creative overrides for this creative assignment. Applicable to video ads.",
- "items": {
- "$ref": "CompanionClickThroughOverride"
- }
- },
- "creativeGroupAssignments": {
- "type": "array",
- "description": "Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.",
- "items": {
- "$ref": "CreativeGroupAssignment"
- }
- },
- "creativeId": {
- "type": "string",
- "description": "ID of the creative to be assigned. This is a required field.",
- "format": "int64"
- },
- "creativeIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the creative. This is a read-only, auto-generated field."
- },
- "endTime": {
- "type": "string",
- "description": "Date and time that the assigned creative should stop serving. Must be later than the start time.",
- "format": "date-time"
- },
- "richMediaExitOverrides": {
- "type": "array",
- "description": "Rich media exit overrides for this creative assignment.\nApplicable when the creative type is any of the following: \n- RICH_MEDIA_INPAGE\n- RICH_MEDIA_INPAGE_FLOATING\n- RICH_MEDIA_IM_EXPAND\n- RICH_MEDIA_EXPANDING\n- RICH_MEDIA_INTERSTITIAL_FLOAT\n- RICH_MEDIA_MOBILE_IN_APP\n- RICH_MEDIA_MULTI_FLOATING\n- RICH_MEDIA_PEEL_DOWN\n- ADVANCED_BANNER\n- VPAID_LINEAR\n- VPAID_NON_LINEAR",
- "items": {
- "$ref": "RichMediaExitOverride"
- }
- },
- "sequence": {
- "type": "integer",
- "description": "Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.",
- "format": "int32"
- },
- "sslCompliant": {
- "type": "boolean",
- "description": "Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated."
- },
- "startTime": {
- "type": "string",
- "description": "Date and time that the assigned creative should start serving.",
- "format": "date-time"
- },
- "weight": {
- "type": "integer",
- "description": "Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.",
- "format": "int32"
- }
- }
- },
- "CreativeCustomEvent": {
- "id": "CreativeCustomEvent",
- "type": "object",
- "description": "Creative Custom Event.",
- "properties": {
- "active": {
- "type": "boolean",
- "description": "Whether the event is active."
- },
- "advertiserCustomEventName": {
- "type": "string",
- "description": "User-entered name for the event."
- },
- "advertiserCustomEventType": {
- "type": "string",
- "description": "Type of the event. This is a read-only field.",
- "enum": [
- "ADVERTISER_EVENT_COUNTER",
- "ADVERTISER_EVENT_EXIT",
- "ADVERTISER_EVENT_TIMER"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "artworkLabel": {
- "type": "string",
- "description": "Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion."
- },
- "artworkType": {
- "type": "string",
- "description": "Artwork type used by the creative.This is a read-only field.",
- "enum": [
- "ARTWORK_TYPE_FLASH",
- "ARTWORK_TYPE_HTML5",
- "ARTWORK_TYPE_MIXED"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "exitUrl": {
- "type": "string",
- "description": "Exit URL of the event. This field is used only for exit events."
- },
- "id": {
- "type": "string",
- "description": "ID of this event. This is a required field and should not be modified after insertion.",
- "format": "int64"
- },
- "popupWindowProperties": {
- "$ref": "PopupWindowProperties",
- "description": "Properties for rich media popup windows. This field is used only for exit events."
- },
- "targetType": {
- "type": "string",
- "description": "Target type used by the event.",
- "enum": [
- "TARGET_BLANK",
- "TARGET_PARENT",
- "TARGET_POPUP",
- "TARGET_SELF",
- "TARGET_TOP"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "videoReportingId": {
- "type": "string",
- "description": "Reporting ID, used to differentiate multiple videos in a single creative."
- }
- }
- },
- "CreativeField": {
- "id": "CreativeField",
- "type": "object",
- "description": "Contains properties of a creative field.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this creative field. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this creative field. This is a required field on insertion.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "id": {
- "type": "string",
- "description": "ID of this creative field. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeField\".",
- "default": "dfareporting#creativeField"
- },
- "name": {
- "type": "string",
- "description": "Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this creative field. This is a read-only field that can be left blank.",
- "format": "int64"
- }
- }
- },
- "CreativeFieldAssignment": {
- "id": "CreativeFieldAssignment",
- "type": "object",
- "description": "Creative Field Assignment.",
- "properties": {
- "creativeFieldId": {
- "type": "string",
- "description": "ID of the creative field.",
- "format": "int64"
- },
- "creativeFieldValueId": {
- "type": "string",
- "description": "ID of the creative field value.",
- "format": "int64"
- }
- }
- },
- "CreativeFieldValue": {
- "id": "CreativeFieldValue",
- "type": "object",
- "description": "Contains properties of a creative field value.",
- "properties": {
- "id": {
- "type": "string",
- "description": "ID of this creative field value. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldValue\".",
- "default": "dfareporting#creativeFieldValue"
- },
- "value": {
- "type": "string",
- "description": "Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field."
- }
- }
- },
- "CreativeFieldValuesListResponse": {
- "id": "CreativeFieldValuesListResponse",
- "type": "object",
- "description": "Creative Field Value List Response",
- "properties": {
- "creativeFieldValues": {
- "type": "array",
- "description": "Creative field value collection.",
- "items": {
- "$ref": "CreativeFieldValue"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldValuesListResponse\".",
- "default": "dfareporting#creativeFieldValuesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "CreativeFieldsListResponse": {
- "id": "CreativeFieldsListResponse",
- "type": "object",
- "description": "Creative Field List Response",
- "properties": {
- "creativeFields": {
- "type": "array",
- "description": "Creative field collection.",
- "items": {
- "$ref": "CreativeField"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldsListResponse\".",
- "default": "dfareporting#creativeFieldsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "CreativeGroup": {
- "id": "CreativeGroup",
- "type": "object",
- "description": "Contains properties of a creative group.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this creative group. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this creative group. This is a required field on insertion.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "groupNumber": {
- "type": "integer",
- "description": "Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.\nAcceptable values are: \n- 1\n- 2",
- "format": "int32"
- },
- "id": {
- "type": "string",
- "description": "ID of this creative group. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeGroup\".",
- "default": "dfareporting#creativeGroup"
- },
- "name": {
- "type": "string",
- "description": "Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this creative group. This is a read-only field that can be left blank.",
- "format": "int64"
- }
- }
- },
- "CreativeGroupAssignment": {
- "id": "CreativeGroupAssignment",
- "type": "object",
- "description": "Creative Group Assignment.",
- "properties": {
- "creativeGroupId": {
- "type": "string",
- "description": "ID of the creative group to be assigned.",
- "format": "int64"
- },
- "creativeGroupNumber": {
- "type": "string",
- "description": "Creative group number of the creative group assignment.",
- "enum": [
- "CREATIVE_GROUP_ONE",
- "CREATIVE_GROUP_TWO"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- }
- }
- },
- "CreativeGroupsListResponse": {
- "id": "CreativeGroupsListResponse",
- "type": "object",
- "description": "Creative Group List Response",
- "properties": {
- "creativeGroups": {
- "type": "array",
- "description": "Creative group collection.",
- "items": {
- "$ref": "CreativeGroup"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeGroupsListResponse\".",
- "default": "dfareporting#creativeGroupsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "CreativeOptimizationConfiguration": {
- "id": "CreativeOptimizationConfiguration",
- "type": "object",
- "description": "Creative optimization settings.",
- "properties": {
- "id": {
- "type": "string",
- "description": "ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "Name of this creative optimization config. This is a required field and must be less than 129 characters long."
- },
- "optimizationActivitys": {
- "type": "array",
- "description": "List of optimization activities associated with this configuration.",
- "items": {
- "$ref": "OptimizationActivity"
- }
- },
- "optimizationModel": {
- "type": "string",
- "description": "Optimization model for this configuration.",
- "enum": [
- "CLICK",
- "POST_CLICK",
- "POST_CLICK_AND_IMPRESSION",
- "POST_IMPRESSION"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- }
- }
- },
- "CreativeRotation": {
- "id": "CreativeRotation",
- "type": "object",
- "description": "Creative Rotation.",
- "properties": {
- "creativeAssignments": {
- "type": "array",
- "description": "Creative assignments in this creative rotation.",
- "items": {
- "$ref": "CreativeAssignment"
- }
- },
- "creativeOptimizationConfigurationId": {
- "type": "string",
- "description": "Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.",
- "format": "int64"
- },
- "type": {
- "type": "string",
- "description": "Type of creative rotation. Can be used to specify whether to use sequential or random rotation.",
- "enum": [
- "CREATIVE_ROTATION_TYPE_RANDOM",
- "CREATIVE_ROTATION_TYPE_SEQUENTIAL"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "weightCalculationStrategy": {
- "type": "string",
- "description": "Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.",
- "enum": [
- "WEIGHT_STRATEGY_CUSTOM",
- "WEIGHT_STRATEGY_EQUAL",
- "WEIGHT_STRATEGY_HIGHEST_CTR",
- "WEIGHT_STRATEGY_OPTIMIZED"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- }
- }
- },
- "CreativeSettings": {
- "id": "CreativeSettings",
- "type": "object",
- "description": "Creative Settings",
- "properties": {
- "iFrameFooter": {
- "type": "string",
- "description": "Header text for iFrames for this site. Must be less than or equal to 2000 characters long."
- },
- "iFrameHeader": {
- "type": "string",
- "description": "Header text for iFrames for this site. Must be less than or equal to 2000 characters long."
- }
- }
- },
- "CreativesListResponse": {
- "id": "CreativesListResponse",
- "type": "object",
- "description": "Creative List Response",
- "properties": {
- "creatives": {
- "type": "array",
- "description": "Creative collection.",
- "items": {
- "$ref": "Creative"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativesListResponse\".",
- "default": "dfareporting#creativesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "CrossDimensionReachReportCompatibleFields": {
- "id": "CrossDimensionReachReportCompatibleFields",
- "type": "object",
- "description": "Represents fields that are compatible to be selected for a report of type \"CROSS_DIMENSION_REACH\".",
- "properties": {
- "breakdown": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"breakdown\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "dimensionFilters": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields.",
- "default": "dfareporting#crossDimensionReachReportCompatibleFields"
- },
- "metrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- },
- "overlapMetrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected in the \"overlapMetricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- }
- }
- },
- "CustomRichMediaEvents": {
- "id": "CustomRichMediaEvents",
- "type": "object",
- "description": "Represents a Custom Rich Media Events group.",
- "properties": {
- "filteredEventIds": {
- "type": "array",
- "description": "List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#customRichMediaEvents.",
- "default": "dfareporting#customRichMediaEvents"
- }
- }
- },
- "DateRange": {
- "id": "DateRange",
- "type": "object",
- "description": "Represents a date range.",
- "properties": {
- "endDate": {
- "type": "string",
- "description": "The end date of the date range, inclusive. A string of the format: \"yyyy-MM-dd\".",
- "format": "date"
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#dateRange.",
- "default": "dfareporting#dateRange"
- },
- "relativeDateRange": {
- "type": "string",
- "description": "The date range relative to the date of when the report is run.",
- "enum": [
- "LAST_24_MONTHS",
- "LAST_30_DAYS",
- "LAST_365_DAYS",
- "LAST_7_DAYS",
- "LAST_90_DAYS",
- "MONTH_TO_DATE",
- "PREVIOUS_MONTH",
- "PREVIOUS_QUARTER",
- "PREVIOUS_WEEK",
- "PREVIOUS_YEAR",
- "QUARTER_TO_DATE",
- "TODAY",
- "WEEK_TO_DATE",
- "YEAR_TO_DATE",
- "YESTERDAY"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "startDate": {
- "type": "string",
- "description": "The start date of the date range, inclusive. A string of the format: \"yyyy-MM-dd\".",
- "format": "date"
- }
- }
- },
- "DayPartTargeting": {
- "id": "DayPartTargeting",
- "type": "object",
- "description": "Day Part Targeting.",
- "properties": {
- "daysOfWeek": {
- "type": "array",
- "description": "Days of the week when the ad will serve.\n\nAcceptable values are:\n- \"SUNDAY\"\n- \"MONDAY\"\n- \"TUESDAY\"\n- \"WEDNESDAY\"\n- \"THURSDAY\"\n- \"FRIDAY\"\n- \"SATURDAY\"",
- "items": {
- "type": "string",
- "enum": [
- "FRIDAY",
- "MONDAY",
- "SATURDAY",
- "SUNDAY",
- "THURSDAY",
- "TUESDAY",
- "WEDNESDAY"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- },
- "hoursOfDay": {
- "type": "array",
- "description": "Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "userLocalTime": {
- "type": "boolean",
- "description": "Whether or not to use the user's local time. If false, the America/New York time zone applies."
- }
- }
- },
- "DefaultClickThroughEventTagProperties": {
- "id": "DefaultClickThroughEventTagProperties",
- "type": "object",
- "description": "Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further.",
- "properties": {
- "defaultClickThroughEventTagId": {
- "type": "string",
- "description": "ID of the click-through event tag to apply to all ads in this entity's scope.",
- "format": "int64"
- },
- "overrideInheritedEventTag": {
- "type": "boolean",
- "description": "Whether this entity should override the inherited default click-through event tag with its own defined value."
- }
- }
- },
- "DeliverySchedule": {
- "id": "DeliverySchedule",
- "type": "object",
- "description": "Delivery Schedule.",
- "properties": {
- "frequencyCap": {
- "$ref": "FrequencyCap",
- "description": "Limit on the number of times an individual user can be served the ad within a specified period of time."
- },
- "hardCutoff": {
- "type": "boolean",
- "description": "Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals."
- },
- "impressionRatio": {
- "type": "string",
- "description": "Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.",
- "format": "int64"
- },
- "priority": {
- "type": "string",
- "description": "Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.",
- "enum": [
- "AD_PRIORITY_01",
- "AD_PRIORITY_02",
- "AD_PRIORITY_03",
- "AD_PRIORITY_04",
- "AD_PRIORITY_05",
- "AD_PRIORITY_06",
- "AD_PRIORITY_07",
- "AD_PRIORITY_08",
- "AD_PRIORITY_09",
- "AD_PRIORITY_10",
- "AD_PRIORITY_11",
- "AD_PRIORITY_12",
- "AD_PRIORITY_13",
- "AD_PRIORITY_14",
- "AD_PRIORITY_15",
- "AD_PRIORITY_16"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- }
- },
- "DfpSettings": {
- "id": "DfpSettings",
- "type": "object",
- "description": "DFP Settings",
- "properties": {
- "dfp_network_code": {
- "type": "string",
- "description": "DFP network code for this directory site."
- },
- "dfp_network_name": {
- "type": "string",
- "description": "DFP network name for this directory site."
- },
- "programmaticPlacementAccepted": {
- "type": "boolean",
- "description": "Whether this directory site accepts programmatic placements."
- },
- "pubPaidPlacementAccepted": {
- "type": "boolean",
- "description": "Whether this directory site accepts publisher-paid tags."
- },
- "publisherPortalOnly": {
- "type": "boolean",
- "description": "Whether this directory site is available only via DoubleClick Publisher Portal."
- }
- }
- },
- "Dimension": {
- "id": "Dimension",
- "type": "object",
- "description": "Represents a dimension.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#dimension.",
- "default": "dfareporting#dimension"
- },
- "name": {
- "type": "string",
- "description": "The dimension name, e.g. dfa:advertiser"
- }
- }
- },
- "DimensionFilter": {
- "id": "DimensionFilter",
- "type": "object",
- "description": "Represents a dimension filter.",
- "properties": {
- "dimensionName": {
- "type": "string",
- "description": "The name of the dimension to filter."
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#dimensionFilter.",
- "default": "dfareporting#dimensionFilter"
- },
- "value": {
- "type": "string",
- "description": "The value of the dimension to filter."
- }
- }
- },
- "DimensionValue": {
- "id": "DimensionValue",
- "type": "object",
- "description": "Represents a DimensionValue resource.",
- "properties": {
- "dimensionName": {
- "type": "string",
- "description": "The name of the dimension."
- },
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "id": {
- "type": "string",
- "description": "The ID associated with the value if available."
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#dimensionValue.",
- "default": "dfareporting#dimensionValue"
- },
- "matchType": {
- "type": "string",
- "description": "Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.",
- "enum": [
- "BEGINS_WITH",
- "CONTAINS",
- "EXACT",
- "WILDCARD_EXPRESSION"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- },
- "value": {
- "type": "string",
- "description": "The value of the dimension."
- }
- }
- },
- "DimensionValueList": {
- "id": "DimensionValueList",
- "type": "object",
- "description": "Represents the list of DimensionValue resources.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The dimension values returned in this response.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of list this is, in this case dfareporting#dimensionValueList.",
- "default": "dfareporting#dimensionValueList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted."
- }
- }
- },
- "DimensionValueRequest": {
- "id": "DimensionValueRequest",
- "type": "object",
- "description": "Represents a DimensionValuesRequest.",
- "properties": {
- "dimensionName": {
- "type": "string",
- "description": "The name of the dimension for which values should be requested.",
- "annotations": {
- "required": [
- "dfareporting.dimensionValues.query"
- ]
- }
- },
- "endDate": {
- "type": "string",
- "description": "The end date of the date range for which to retrieve dimension values. A string of the format \"yyyy-MM-dd\".",
- "format": "date",
- "annotations": {
- "required": [
- "dfareporting.dimensionValues.query"
- ]
- }
- },
- "filters": {
- "type": "array",
- "description": "The list of filters by which to filter values. The filters are ANDed.",
- "items": {
- "$ref": "DimensionFilter"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of request this is, in this case dfareporting#dimensionValueRequest.",
- "default": "dfareporting#dimensionValueRequest"
- },
- "startDate": {
- "type": "string",
- "description": "The start date of the date range for which to retrieve dimension values. A string of the format \"yyyy-MM-dd\".",
- "format": "date",
- "annotations": {
- "required": [
- "dfareporting.dimensionValues.query"
- ]
- }
- }
- }
- },
- "DirectorySite": {
- "id": "DirectorySite",
- "type": "object",
- "description": "DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.",
- "properties": {
- "active": {
- "type": "boolean",
- "description": "Whether this directory site is active."
- },
- "contactAssignments": {
- "type": "array",
- "description": "Directory site contacts.",
- "items": {
- "$ref": "DirectorySiteContactAssignment"
- }
- },
- "countryId": {
- "type": "string",
- "description": "Country ID of this directory site.",
- "format": "int64"
- },
- "currencyId": {
- "type": "string",
- "description": "Currency ID of this directory site.\nPossible values are: \n- \"1\" for USD \n- \"2\" for GBP \n- \"3\" for ESP \n- \"4\" for SEK \n- \"5\" for CAD \n- \"6\" for JPY \n- \"7\" for DEM \n- \"8\" for AUD \n- \"9\" for FRF \n- \"10\" for ITL \n- \"11\" for DKK \n- \"12\" for NOK \n- \"13\" for FIM \n- \"14\" for ZAR \n- \"15\" for IEP \n- \"16\" for NLG \n- \"17\" for EUR \n- \"18\" for KRW \n- \"19\" for TWD \n- \"20\" for SGD \n- \"21\" for CNY \n- \"22\" for HKD \n- \"23\" for NZD \n- \"24\" for MYR \n- \"25\" for BRL \n- \"26\" for PTE \n- \"27\" for MXP \n- \"28\" for CLP \n- \"29\" for TRY \n- \"30\" for ARS \n- \"31\" for PEN \n- \"32\" for ILS \n- \"33\" for CHF \n- \"34\" for VEF \n- \"35\" for COP \n- \"36\" for GTQ",
- "format": "int64"
- },
- "description": {
- "type": "string",
- "description": "Description of this directory site."
- },
- "id": {
- "type": "string",
- "description": "ID of this directory site. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this directory site. This is a read-only, auto-generated field."
- },
- "inpageTagFormats": {
- "type": "array",
- "description": "Tag types for regular placements.\n\nAcceptable values are:\n- \"STANDARD\"\n- \"IFRAME_JAVASCRIPT_INPAGE\"\n- \"INTERNAL_REDIRECT_INPAGE\"\n- \"JAVASCRIPT_INPAGE\"",
- "items": {
- "type": "string",
- "enum": [
- "IFRAME_JAVASCRIPT_INPAGE",
- "INTERNAL_REDIRECT_INPAGE",
- "JAVASCRIPT_INPAGE",
- "STANDARD"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- }
- },
- "interstitialTagFormats": {
- "type": "array",
- "description": "Tag types for interstitial placements.\n\nAcceptable values are:\n- \"IFRAME_JAVASCRIPT_INTERSTITIAL\"\n- \"INTERNAL_REDIRECT_INTERSTITIAL\"\n- \"JAVASCRIPT_INTERSTITIAL\"",
- "items": {
- "type": "string",
- "enum": [
- "IFRAME_JAVASCRIPT_INTERSTITIAL",
- "INTERNAL_REDIRECT_INTERSTITIAL",
- "JAVASCRIPT_INTERSTITIAL"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySite\".",
- "default": "dfareporting#directorySite"
- },
- "name": {
- "type": "string",
- "description": "Name of this directory site."
- },
- "parentId": {
- "type": "string",
- "description": "Parent directory site ID.",
- "format": "int64"
- },
- "settings": {
- "$ref": "DirectorySiteSettings",
- "description": "Directory site settings."
- },
- "url": {
- "type": "string",
- "description": "URL of this directory site."
- }
- }
- },
- "DirectorySiteContact": {
- "id": "DirectorySiteContact",
- "type": "object",
- "description": "Contains properties of a Site Directory contact.",
- "properties": {
- "address": {
- "type": "string",
- "description": "Address of this directory site contact."
- },
- "email": {
- "type": "string",
- "description": "Email address of this directory site contact."
- },
- "firstName": {
- "type": "string",
- "description": "First name of this directory site contact."
- },
- "id": {
- "type": "string",
- "description": "ID of this directory site contact. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySiteContact\".",
- "default": "dfareporting#directorySiteContact"
- },
- "lastName": {
- "type": "string",
- "description": "Last name of this directory site contact."
- },
- "phone": {
- "type": "string",
- "description": "Phone number of this directory site contact."
- },
- "role": {
- "type": "string",
- "description": "Directory site contact role.",
- "enum": [
- "ADMIN",
- "EDIT",
- "VIEW"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "title": {
- "type": "string",
- "description": "Title or designation of this directory site contact."
- },
- "type": {
- "type": "string",
- "description": "Directory site contact type.",
- "enum": [
- "BILLING",
- "OTHER",
- "SALES",
- "TECHNICAL"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- }
- }
- },
- "DirectorySiteContactAssignment": {
- "id": "DirectorySiteContactAssignment",
- "type": "object",
- "description": "Directory Site Contact Assignment",
- "properties": {
- "contactId": {
- "type": "string",
- "description": "ID of this directory site contact. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "visibility": {
- "type": "string",
- "description": "Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.",
- "enum": [
- "PRIVATE",
- "PUBLIC"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- }
- }
- },
- "DirectorySiteContactsListResponse": {
- "id": "DirectorySiteContactsListResponse",
- "type": "object",
- "description": "Directory Site Contact List Response",
- "properties": {
- "directorySiteContacts": {
- "type": "array",
- "description": "Directory site contact collection",
- "items": {
- "$ref": "DirectorySiteContact"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySiteContactsListResponse\".",
- "default": "dfareporting#directorySiteContactsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "DirectorySiteSettings": {
- "id": "DirectorySiteSettings",
- "type": "object",
- "description": "Directory Site Settings",
- "properties": {
- "activeViewOptOut": {
- "type": "boolean",
- "description": "Whether this directory site has disabled active view creatives."
- },
- "dfp_settings": {
- "$ref": "DfpSettings",
- "description": "Directory site DFP settings."
- },
- "instream_video_placement_accepted": {
- "type": "boolean",
- "description": "Whether this site accepts in-stream video ads."
- },
- "interstitialPlacementAccepted": {
- "type": "boolean",
- "description": "Whether this site accepts interstitial ads."
- },
- "nielsenOcrOptOut": {
- "type": "boolean",
- "description": "Whether this directory site has disabled Nielsen OCR reach ratings."
- },
- "verificationTagOptOut": {
- "type": "boolean",
- "description": "Whether this directory site has disabled generation of Verification ins tags."
- },
- "videoActiveViewOptOut": {
- "type": "boolean",
- "description": "Whether this directory site has disabled active view for in-stream video creatives."
- }
- }
- },
- "DirectorySitesListResponse": {
- "id": "DirectorySitesListResponse",
- "type": "object",
- "description": "Directory Site List Response",
- "properties": {
- "directorySites": {
- "type": "array",
- "description": "Directory site collection.",
- "items": {
- "$ref": "DirectorySite"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySitesListResponse\".",
- "default": "dfareporting#directorySitesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "EventTag": {
- "id": "EventTag",
- "type": "object",
- "description": "Contains properties of an event tag.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this event tag. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this event tag. This field or the campaignId field is required on insertion.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "campaignId": {
- "type": "string",
- "description": "Campaign ID of this event tag. This field or the advertiserId field is required on insertion.",
- "format": "int64"
- },
- "campaignIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
- },
- "enabledByDefault": {
- "type": "boolean",
- "description": "Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads."
- },
- "id": {
- "type": "string",
- "description": "ID of this event tag. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#eventTag\".",
- "default": "dfareporting#eventTag"
- },
- "name": {
- "type": "string",
- "description": "Name of this event tag. This is a required field and must be less than 256 characters long."
- },
- "siteFilterType": {
- "type": "string",
- "description": "Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.",
- "enum": [
- "BLACKLIST",
- "WHITELIST"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "siteIds": {
- "type": "array",
- "description": "Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "sslCompliant": {
- "type": "boolean",
- "description": "Whether this tag is SSL-compliant or not. This is a read-only field."
- },
- "status": {
- "type": "string",
- "description": "Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.",
- "enum": [
- "DISABLED",
- "ENABLED"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this event tag. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "type": {
- "type": "string",
- "description": "Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.",
- "enum": [
- "CLICK_THROUGH_EVENT_TAG",
- "IMPRESSION_IMAGE_EVENT_TAG",
- "IMPRESSION_JAVASCRIPT_EVENT_TAG"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "url": {
- "type": "string",
- "description": "Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion."
- },
- "urlEscapeLevels": {
- "type": "integer",
- "description": "Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.",
- "format": "int32"
- }
- }
- },
- "EventTagOverride": {
- "id": "EventTagOverride",
- "type": "object",
- "description": "Event tag override information.",
- "properties": {
- "enabled": {
- "type": "boolean",
- "description": "Whether this override is enabled."
- },
- "id": {
- "type": "string",
- "description": "ID of this event tag override. This is a read-only, auto-generated field.",
- "format": "int64"
- }
- }
- },
- "EventTagsListResponse": {
- "id": "EventTagsListResponse",
- "type": "object",
- "description": "Event Tag List Response",
- "properties": {
- "eventTags": {
- "type": "array",
- "description": "Event tag collection.",
- "items": {
- "$ref": "EventTag"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#eventTagsListResponse\".",
- "default": "dfareporting#eventTagsListResponse"
- }
- }
- },
- "File": {
- "id": "File",
- "type": "object",
- "description": "Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is \"REPORT_AVAILABLE\".",
- "properties": {
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range for which the file has report data. The date range will always be the absolute date range for which the report is run."
- },
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "fileName": {
- "type": "string",
- "description": "The filename of the file."
- },
- "format": {
- "type": "string",
- "description": "The output format of the report. Only available once the file is available.",
- "enum": [
- "CSV",
- "EXCEL"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "id": {
- "type": "string",
- "description": "The unique ID of this report file.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#file.",
- "default": "dfareporting#file"
- },
- "lastModifiedTime": {
- "type": "string",
- "description": "The timestamp in milliseconds since epoch when this file was last modified.",
- "format": "int64"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report this file was generated from.",
- "format": "int64"
- },
- "status": {
- "type": "string",
- "description": "The status of the report file.",
- "enum": [
- "CANCELLED",
- "FAILED",
- "PROCESSING",
- "REPORT_AVAILABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- },
- "urls": {
- "type": "object",
- "description": "The URLs where the completed report file can be downloaded.",
- "properties": {
- "apiUrl": {
- "type": "string",
- "description": "The URL for downloading the report data through the API."
- },
- "browserUrl": {
- "type": "string",
- "description": "The URL for downloading the report data through a browser."
- }
- }
- }
- }
- },
- "FileList": {
- "id": "FileList",
- "type": "object",
- "description": "Represents the list of File resources.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The files returned in this response.",
- "items": {
- "$ref": "File"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of list this is, in this case dfareporting#fileList.",
- "default": "dfareporting#fileList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through files. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted."
- }
- }
- },
- "Flight": {
- "id": "Flight",
- "type": "object",
- "description": "Flight",
- "properties": {
- "endDate": {
- "type": "string",
- "description": "Inventory item flight end date.",
- "format": "date"
- },
- "rateOrCost": {
- "type": "string",
- "description": "Rate or cost of this flight.",
- "format": "int64"
- },
- "startDate": {
- "type": "string",
- "description": "Inventory item flight start date.",
- "format": "date"
- },
- "units": {
- "type": "string",
- "description": "Units of this flight.",
- "format": "int64"
- }
- }
- },
- "FloodlightActivitiesGenerateTagResponse": {
- "id": "FloodlightActivitiesGenerateTagResponse",
- "type": "object",
- "description": "Floodlight Activity GenerateTag Response",
- "properties": {
- "floodlightActivityTag": {
- "type": "string",
- "description": "Generated tag for this floodlight activity."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivitiesGenerateTagResponse\".",
- "default": "dfareporting#floodlightActivitiesGenerateTagResponse"
- }
- }
- },
- "FloodlightActivitiesListResponse": {
- "id": "FloodlightActivitiesListResponse",
- "type": "object",
- "description": "Floodlight Activity List Response",
- "properties": {
- "floodlightActivities": {
- "type": "array",
- "description": "Floodlight activity collection.",
- "items": {
- "$ref": "FloodlightActivity"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivitiesListResponse\".",
- "default": "dfareporting#floodlightActivitiesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "FloodlightActivity": {
- "id": "FloodlightActivity",
- "type": "object",
- "description": "Contains properties of a Floodlight activity.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this floodlight activity. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "cacheBustingType": {
- "type": "string",
- "description": "Code type used for cache busting in the generated tag.",
- "enum": [
- "ACTIVE_SERVER_PAGE",
- "COLD_FUSION",
- "JAVASCRIPT",
- "JSP",
- "PHP"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "countingMethod": {
- "type": "string",
- "description": "Counting method for conversions for this floodlight activity. This is a required field.",
- "enum": [
- "ITEMS_SOLD_COUNTING",
- "SESSION_COUNTING",
- "STANDARD_COUNTING",
- "TRANSACTIONS_COUNTING",
- "UNIQUE_COUNTING"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "defaultTags": {
- "type": "array",
- "description": "Dynamic floodlight tags.",
- "items": {
- "$ref": "FloodlightActivityDynamicTag"
- }
- },
- "expectedUrl": {
- "type": "string",
- "description": "URL where this tag will be deployed. If specified, must be less than 256 characters long."
- },
- "floodlightActivityGroupId": {
- "type": "string",
- "description": "Floodlight activity group ID of this floodlight activity. This is a required field.",
- "format": "int64"
- },
- "floodlightActivityGroupName": {
- "type": "string",
- "description": "Name of the associated floodlight activity group. This is a read-only field."
- },
- "floodlightActivityGroupTagString": {
- "type": "string",
- "description": "Tag string of the associated floodlight activity group. This is a read-only field."
- },
- "floodlightActivityGroupType": {
- "type": "string",
- "description": "Type of the associated floodlight activity group. This is a read-only field.",
- "enum": [
- "COUNTER",
- "SALE"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "floodlightConfigurationId": {
- "type": "string",
- "description": "Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.",
- "format": "int64"
- },
- "floodlightConfigurationIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field."
- },
- "hidden": {
- "type": "boolean",
- "description": "Whether this activity is archived."
- },
- "id": {
- "type": "string",
- "description": "ID of this floodlight activity. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field."
- },
- "imageTagEnabled": {
- "type": "boolean",
- "description": "Whether the image tag is enabled for this activity."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivity\".",
- "default": "dfareporting#floodlightActivity"
- },
- "name": {
- "type": "string",
- "description": "Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes."
- },
- "notes": {
- "type": "string",
- "description": "General notes or implementation instructions for the tag."
- },
- "publisherTags": {
- "type": "array",
- "description": "Publisher dynamic floodlight tags.",
- "items": {
- "$ref": "FloodlightActivityPublisherDynamicTag"
- }
- },
- "secure": {
- "type": "boolean",
- "description": "Whether this tag should use SSL."
- },
- "sslCompliant": {
- "type": "boolean",
- "description": "Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags."
- },
- "sslRequired": {
- "type": "boolean",
- "description": "Whether this floodlight activity must be SSL-compliant."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "tagFormat": {
- "type": "string",
- "description": "Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.",
- "enum": [
- "HTML",
- "XHTML"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "tagString": {
- "type": "string",
- "description": "Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion."
- },
- "userDefinedVariableTypes": {
- "type": "array",
- "description": "List of the user-defined variables used by this conversion tag. These map to the \"u[1-20]=\" in the tags. Each of these can have a user defined type.\nAcceptable values are:\n- \"U1\"\n- \"U2\"\n- \"U3\"\n- \"U4\"\n- \"U5\"\n- \"U6\"\n- \"U7\"\n- \"U8\"\n- \"U9\"\n- \"U10\"\n- \"U11\"\n- \"U12\"\n- \"U13\"\n- \"U14\"\n- \"U15\"\n- \"U16\"\n- \"U17\"\n- \"U18\"\n- \"U19\"\n- \"U20\"",
- "items": {
- "type": "string",
- "enum": [
- "U1",
- "U10",
- "U11",
- "U12",
- "U13",
- "U14",
- "U15",
- "U16",
- "U17",
- "U18",
- "U19",
- "U2",
- "U20",
- "U3",
- "U4",
- "U5",
- "U6",
- "U7",
- "U8",
- "U9"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- }
- }
- },
- "FloodlightActivityDynamicTag": {
- "id": "FloodlightActivityDynamicTag",
- "type": "object",
- "description": "Dynamic Tag",
- "properties": {
- "id": {
- "type": "string",
- "description": "ID of this dynamic tag. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "Name of this tag."
- },
- "tag": {
- "type": "string",
- "description": "Tag code."
- }
- }
- },
- "FloodlightActivityGroup": {
- "id": "FloodlightActivityGroup",
- "type": "object",
- "description": "Contains properties of a Floodlight activity group.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this floodlight activity group. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "floodlightConfigurationId": {
- "type": "string",
- "description": "Floodlight configuration ID of this floodlight activity group. This is a required field.",
- "format": "int64"
- },
- "floodlightConfigurationIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field."
- },
- "id": {
- "type": "string",
- "description": "ID of this floodlight activity group. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivityGroup\".",
- "default": "dfareporting#floodlightActivityGroup"
- },
- "name": {
- "type": "string",
- "description": "Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "tagString": {
- "type": "string",
- "description": "Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion."
- },
- "type": {
- "type": "string",
- "description": "Type of the floodlight activity group. This is a required field that is read-only after insertion.",
- "enum": [
- "COUNTER",
- "SALE"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- }
- }
- },
- "FloodlightActivityGroupsListResponse": {
- "id": "FloodlightActivityGroupsListResponse",
- "type": "object",
- "description": "Floodlight Activity Group List Response",
- "properties": {
- "floodlightActivityGroups": {
- "type": "array",
- "description": "Floodlight activity group collection.",
- "items": {
- "$ref": "FloodlightActivityGroup"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivityGroupsListResponse\".",
- "default": "dfareporting#floodlightActivityGroupsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "FloodlightActivityPublisherDynamicTag": {
- "id": "FloodlightActivityPublisherDynamicTag",
- "type": "object",
- "description": "Publisher Dynamic Tag",
- "properties": {
- "clickThrough": {
- "type": "boolean",
- "description": "Whether this tag is applicable only for click-throughs."
- },
- "directorySiteId": {
- "type": "string",
- "description": "Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.",
- "format": "int64"
- },
- "dynamicTag": {
- "$ref": "FloodlightActivityDynamicTag",
- "description": "Dynamic floodlight tag."
- },
- "siteId": {
- "type": "string",
- "description": "Site ID of this dynamic tag.",
- "format": "int64"
- },
- "siteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field."
- },
- "viewThrough": {
- "type": "boolean",
- "description": "Whether this tag is applicable only for view-throughs."
- }
- }
- },
- "FloodlightConfiguration": {
- "id": "FloodlightConfiguration",
- "type": "object",
- "description": "Contains properties of a Floodlight configuration.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this floodlight configuration. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of the parent advertiser of this floodlight configuration.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "analyticsDataSharingEnabled": {
- "type": "boolean",
- "description": "Whether advertiser data is shared with Google Analytics."
- },
- "exposureToConversionEnabled": {
- "type": "boolean",
- "description": "Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting."
- },
- "firstDayOfWeek": {
- "type": "string",
- "description": "Day that will be counted as the first day of the week in reports. This is a required field.",
- "enum": [
- "MONDAY",
- "SUNDAY"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "id": {
- "type": "string",
- "description": "ID of this floodlight configuration. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightConfiguration\".",
- "default": "dfareporting#floodlightConfiguration"
- },
- "lookbackConfiguration": {
- "$ref": "LookbackConfiguration",
- "description": "Lookback window settings for this floodlight configuration."
- },
- "naturalSearchConversionAttributionOption": {
- "type": "string",
- "description": "Types of attribution options for natural search conversions.",
- "enum": [
- "EXCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION",
- "INCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION",
- "INCLUDE_NATURAL_SEARCH_TIERED_CONVERSION_ATTRIBUTION"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "omnitureSettings": {
- "$ref": "OmnitureSettings",
- "description": "Settings for DCM Omniture integration."
- },
- "sslRequired": {
- "type": "boolean",
- "description": "Whether floodlight activities owned by this configuration are required to be SSL-compliant."
- },
- "standardVariableTypes": {
- "type": "array",
- "description": "List of standard variables enabled for this configuration.\n\nAcceptable values are:\n- \"ORD\"\n- \"NUM\"",
- "items": {
- "type": "string",
- "enum": [
- "NUM",
- "ORD",
- "TRAN",
- "U"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- }
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "tagSettings": {
- "$ref": "TagSettings",
- "description": "Configuration settings for dynamic and image floodlight tags."
- },
- "userDefinedVariableConfigurations": {
- "type": "array",
- "description": "List of user defined variables enabled for this configuration.",
- "items": {
- "$ref": "UserDefinedVariableConfiguration"
- }
- }
- }
- },
- "FloodlightConfigurationsListResponse": {
- "id": "FloodlightConfigurationsListResponse",
- "type": "object",
- "description": "Floodlight Configuration List Response",
- "properties": {
- "floodlightConfigurations": {
- "type": "array",
- "description": "Floodlight configuration collection.",
- "items": {
- "$ref": "FloodlightConfiguration"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightConfigurationsListResponse\".",
- "default": "dfareporting#floodlightConfigurationsListResponse"
- }
- }
- },
- "FloodlightReportCompatibleFields": {
- "id": "FloodlightReportCompatibleFields",
- "type": "object",
- "description": "Represents fields that are compatible to be selected for a report of type \"FlOODLIGHT\".",
- "properties": {
- "dimensionFilters": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields.",
- "default": "dfareporting#floodlightReportCompatibleFields"
- },
- "metrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- }
- }
- },
- "FrequencyCap": {
- "id": "FrequencyCap",
- "type": "object",
- "description": "Frequency Cap.",
- "properties": {
- "duration": {
- "type": "string",
- "description": "Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.",
- "format": "int64"
- },
- "impressions": {
- "type": "string",
- "description": "Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.",
- "format": "int64"
- }
- }
- },
- "FsCommand": {
- "id": "FsCommand",
- "type": "object",
- "description": "FsCommand.",
- "properties": {
- "left": {
- "type": "integer",
- "description": "Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.",
- "format": "int32"
- },
- "positionOption": {
- "type": "string",
- "description": "Position in the browser where the window will open.",
- "enum": [
- "CENTERED",
- "DISTANCE_FROM_TOP_LEFT_CORNER"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "top": {
- "type": "integer",
- "description": "Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.",
- "format": "int32"
- },
- "windowHeight": {
- "type": "integer",
- "description": "Height of the window.",
- "format": "int32"
- },
- "windowWidth": {
- "type": "integer",
- "description": "Width of the window.",
- "format": "int32"
- }
- }
- },
- "GeoTargeting": {
- "id": "GeoTargeting",
- "type": "object",
- "description": "Geographical Targeting.",
- "properties": {
- "cities": {
- "type": "array",
- "description": "Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.",
- "items": {
- "$ref": "City"
- }
- },
- "countries": {
- "type": "array",
- "description": "Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.",
- "items": {
- "$ref": "Country"
- }
- },
- "excludeCountries": {
- "type": "boolean",
- "description": "Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad."
- },
- "metros": {
- "type": "array",
- "description": "Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.",
- "items": {
- "$ref": "Metro"
- }
- },
- "postalCodes": {
- "type": "array",
- "description": "Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.",
- "items": {
- "$ref": "PostalCode"
- }
- },
- "regions": {
- "type": "array",
- "description": "Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.",
- "items": {
- "$ref": "Region"
- }
- }
- }
- },
- "InventoryItem": {
- "id": "InventoryItem",
- "type": "object",
- "description": "Represents a buy from the DoubleClick Planning inventory store.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this inventory item.",
- "format": "int64"
- },
- "adSlots": {
- "type": "array",
- "description": "Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group.",
- "items": {
- "$ref": "AdSlot"
- }
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this inventory item.",
- "format": "int64"
- },
- "contentCategoryId": {
- "type": "string",
- "description": "Content category ID of this inventory item.",
- "format": "int64"
- },
- "estimatedClickThroughRate": {
- "type": "string",
- "description": "Estimated click-through rate of this inventory item.",
- "format": "int64"
- },
- "estimatedConversionRate": {
- "type": "string",
- "description": "Estimated conversion rate of this inventory item.",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "ID of this inventory item.",
- "format": "int64"
- },
- "inPlan": {
- "type": "boolean",
- "description": "Whether this inventory item is in plan."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#inventoryItem\".",
- "default": "dfareporting#inventoryItem"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this inventory item."
- },
- "name": {
- "type": "string",
- "description": "Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots."
- },
- "negotiationChannelId": {
- "type": "string",
- "description": "Negotiation channel ID of this inventory item.",
- "format": "int64"
- },
- "orderId": {
- "type": "string",
- "description": "Order ID of this inventory item.",
- "format": "int64"
- },
- "placementStrategyId": {
- "type": "string",
- "description": "Placement strategy ID of this inventory item.",
- "format": "int64"
- },
- "pricing": {
- "$ref": "Pricing",
- "description": "Pricing of this inventory item."
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of this inventory item.",
- "format": "int64"
- },
- "rfpId": {
- "type": "string",
- "description": "RFP ID of this inventory item.",
- "format": "int64"
- },
- "siteId": {
- "type": "string",
- "description": "ID of the site this inventory item is associated with.",
- "format": "int64"
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this inventory item.",
- "format": "int64"
- }
- }
- },
- "InventoryItemsListResponse": {
- "id": "InventoryItemsListResponse",
- "type": "object",
- "description": "Inventory item List Response",
- "properties": {
- "inventoryItems": {
- "type": "array",
- "description": "Inventory item collection",
- "items": {
- "$ref": "InventoryItem"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#inventoryItemsListResponse\".",
- "default": "dfareporting#inventoryItemsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "KeyValueTargetingExpression": {
- "id": "KeyValueTargetingExpression",
- "type": "object",
- "description": "Key Value Targeting Expression.",
- "properties": {
- "expression": {
- "type": "string",
- "description": "Keyword expression being targeted by the ad."
- }
- }
- },
- "LandingPage": {
- "id": "LandingPage",
- "type": "object",
- "description": "Contains information about where a user's browser is taken after the user clicks an ad.",
- "properties": {
- "default": {
- "type": "boolean",
- "description": "Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign."
- },
- "id": {
- "type": "string",
- "description": "ID of this landing page. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#landingPage\".",
- "default": "dfareporting#landingPage"
- },
- "name": {
- "type": "string",
- "description": "Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign."
- },
- "url": {
- "type": "string",
- "description": "URL of this landing page. This is a required field."
- }
- }
- },
- "LandingPagesListResponse": {
- "id": "LandingPagesListResponse",
- "type": "object",
- "description": "Landing Page List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#landingPagesListResponse\".",
- "default": "dfareporting#landingPagesListResponse"
- },
- "landingPages": {
- "type": "array",
- "description": "Landing page collection",
- "items": {
- "$ref": "LandingPage"
- }
- }
- }
- },
- "LastModifiedInfo": {
- "id": "LastModifiedInfo",
- "type": "object",
- "description": "Modification timestamp.",
- "properties": {
- "time": {
- "type": "string",
- "description": "Timestamp of the last change in milliseconds since epoch.",
- "format": "int64"
- }
- }
- },
- "ListPopulationClause": {
- "id": "ListPopulationClause",
- "type": "object",
- "description": "A group clause made up of list population terms representing constraints joined by ORs.",
- "properties": {
- "terms": {
- "type": "array",
- "description": "Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.",
- "items": {
- "$ref": "ListPopulationTerm"
- }
- }
- }
- },
- "ListPopulationRule": {
- "id": "ListPopulationRule",
- "type": "object",
- "description": "Remarketing List Population Rule.",
- "properties": {
- "floodlightActivityId": {
- "type": "string",
- "description": "Floodlight activity ID associated with this rule. This field can be left blank.",
- "format": "int64"
- },
- "floodlightActivityName": {
- "type": "string",
- "description": "Name of floodlight activity associated with this rule. This is a read-only, auto-generated field."
- },
- "listPopulationClauses": {
- "type": "array",
- "description": "Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.",
- "items": {
- "$ref": "ListPopulationClause"
- }
- }
- }
- },
- "ListPopulationTerm": {
- "id": "ListPopulationTerm",
- "type": "object",
- "description": "Remarketing List Population Rule Term.",
- "properties": {
- "contains": {
- "type": "boolean",
- "description": "Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default."
- },
- "negation": {
- "type": "boolean",
- "description": "Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM."
- },
- "operator": {
- "type": "string",
- "description": "Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.",
- "enum": [
- "NUM_EQUALS",
- "NUM_GREATER_THAN",
- "NUM_GREATER_THAN_EQUAL",
- "NUM_LESS_THAN",
- "NUM_LESS_THAN_EQUAL",
- "STRING_CONTAINS",
- "STRING_EQUALS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "remarketingListId": {
- "type": "string",
- "description": "ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.",
- "format": "int64"
- },
- "type": {
- "type": "string",
- "description": "List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.",
- "enum": [
- "CUSTOM_VARIABLE_TERM",
- "LIST_MEMBERSHIP_TERM",
- "REFERRER_TERM"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "value": {
- "type": "string",
- "description": "Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM."
- },
- "variableFriendlyName": {
- "type": "string",
- "description": "Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM."
- },
- "variableName": {
- "type": "string",
- "description": "Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM."
- }
- }
- },
- "ListTargetingExpression": {
- "id": "ListTargetingExpression",
- "type": "object",
- "description": "Remarketing List Targeting Expression.",
- "properties": {
- "expression": {
- "type": "string",
- "description": "Expression describing which lists are being targeted by the ad."
- }
- }
- },
- "LookbackConfiguration": {
- "id": "LookbackConfiguration",
- "type": "object",
- "description": "Lookback configuration settings.",
- "properties": {
- "clickDuration": {
- "type": "integer",
- "description": "Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.",
- "format": "int32"
- },
- "postImpressionActivitiesDuration": {
- "type": "integer",
- "description": "Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.",
- "format": "int32"
- }
- }
- },
- "Metric": {
- "id": "Metric",
- "type": "object",
- "description": "Represents a metric.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#metric.",
- "default": "dfareporting#metric"
- },
- "name": {
- "type": "string",
- "description": "The metric name, e.g. dfa:impressions"
- }
- }
- },
- "Metro": {
- "id": "Metro",
- "type": "object",
- "description": "Contains information about a metro region that can be targeted by ads.",
- "properties": {
- "countryCode": {
- "type": "string",
- "description": "Country code of the country to which this metro region belongs."
- },
- "countryDartId": {
- "type": "string",
- "description": "DART ID of the country to which this metro region belongs.",
- "format": "int64"
- },
- "dartId": {
- "type": "string",
- "description": "DART ID of this metro region.",
- "format": "int64"
- },
- "dmaId": {
- "type": "string",
- "description": "DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#metro\".",
- "default": "dfareporting#metro"
- },
- "metroCode": {
- "type": "string",
- "description": "Metro code of this metro region. This is equivalent to dma_id."
- },
- "name": {
- "type": "string",
- "description": "Name of this metro region."
- }
- }
- },
- "MetrosListResponse": {
- "id": "MetrosListResponse",
- "type": "object",
- "description": "Metro List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#metrosListResponse\".",
- "default": "dfareporting#metrosListResponse"
- },
- "metros": {
- "type": "array",
- "description": "Metro collection.",
- "items": {
- "$ref": "Metro"
- }
- }
- }
- },
- "MobileCarrier": {
- "id": "MobileCarrier",
- "type": "object",
- "description": "Contains information about a mobile carrier that can be targeted by ads.",
- "properties": {
- "countryCode": {
- "type": "string",
- "description": "Country code of the country to which this mobile carrier belongs."
- },
- "countryDartId": {
- "type": "string",
- "description": "DART ID of the country to which this mobile carrier belongs.",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "ID of this mobile carrier.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileCarrier\".",
- "default": "dfareporting#mobileCarrier"
- },
- "name": {
- "type": "string",
- "description": "Name of this mobile carrier."
- }
- }
- },
- "MobileCarriersListResponse": {
- "id": "MobileCarriersListResponse",
- "type": "object",
- "description": "Mobile Carrier List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileCarriersListResponse\".",
- "default": "dfareporting#mobileCarriersListResponse"
- },
- "mobileCarriers": {
- "type": "array",
- "description": "Mobile carrier collection.",
- "items": {
- "$ref": "MobileCarrier"
- }
- }
- }
- },
- "ObjectFilter": {
- "id": "ObjectFilter",
- "type": "object",
- "description": "Object Filter.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#objectFilter\".",
- "default": "dfareporting#objectFilter"
- },
- "objectIds": {
- "type": "array",
- "description": "Applicable when status is ASSIGNED. The user has access to objects with these object IDs.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "status": {
- "type": "string",
- "description": "Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.",
- "enum": [
- "ALL",
- "ASSIGNED",
- "NONE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- }
- }
- },
- "OffsetPosition": {
- "id": "OffsetPosition",
- "type": "object",
- "description": "Offset Position.",
- "properties": {
- "left": {
- "type": "integer",
- "description": "Offset distance from left side of an asset or a window.",
- "format": "int32"
- },
- "top": {
- "type": "integer",
- "description": "Offset distance from top side of an asset or a window.",
- "format": "int32"
- }
- }
- },
- "OmnitureSettings": {
- "id": "OmnitureSettings",
- "type": "object",
- "description": "Omniture Integration Settings.",
- "properties": {
- "omnitureCostDataEnabled": {
- "type": "boolean",
- "description": "Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true."
- },
- "omnitureIntegrationEnabled": {
- "type": "boolean",
- "description": "Whether Omniture integration is enabled. This property can be enabled only when the \"Advanced Ad Serving\" account setting is enabled."
- }
- }
- },
- "OperatingSystem": {
- "id": "OperatingSystem",
- "type": "object",
- "description": "Contains information about an operating system that can be targeted by ads.",
- "properties": {
- "dartId": {
- "type": "string",
- "description": "DART ID of this operating system. This is the ID used for targeting.",
- "format": "int64"
- },
- "desktop": {
- "type": "boolean",
- "description": "Whether this operating system is for desktop."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystem\".",
- "default": "dfareporting#operatingSystem"
- },
- "mobile": {
- "type": "boolean",
- "description": "Whether this operating system is for mobile."
- },
- "name": {
- "type": "string",
- "description": "Name of this operating system."
- }
- }
- },
- "OperatingSystemVersion": {
- "id": "OperatingSystemVersion",
- "type": "object",
- "description": "Contains information about a particular version of an operating system that can be targeted by ads.",
- "properties": {
- "id": {
- "type": "string",
- "description": "ID of this operating system version.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemVersion\".",
- "default": "dfareporting#operatingSystemVersion"
- },
- "majorVersion": {
- "type": "string",
- "description": "Major version (leftmost number) of this operating system version."
- },
- "minorVersion": {
- "type": "string",
- "description": "Minor version (number after the first dot) of this operating system version."
- },
- "name": {
- "type": "string",
- "description": "Name of this operating system version."
- },
- "operatingSystem": {
- "$ref": "OperatingSystem",
- "description": "Operating system of this operating system version."
- }
- }
- },
- "OperatingSystemVersionsListResponse": {
- "id": "OperatingSystemVersionsListResponse",
- "type": "object",
- "description": "Operating System Version List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemVersionsListResponse\".",
- "default": "dfareporting#operatingSystemVersionsListResponse"
- },
- "operatingSystemVersions": {
- "type": "array",
- "description": "Operating system version collection.",
- "items": {
- "$ref": "OperatingSystemVersion"
- }
- }
- }
- },
- "OperatingSystemsListResponse": {
- "id": "OperatingSystemsListResponse",
- "type": "object",
- "description": "Operating System List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemsListResponse\".",
- "default": "dfareporting#operatingSystemsListResponse"
- },
- "operatingSystems": {
- "type": "array",
- "description": "Operating system collection.",
- "items": {
- "$ref": "OperatingSystem"
- }
- }
- }
- },
- "OptimizationActivity": {
- "id": "OptimizationActivity",
- "type": "object",
- "description": "Creative optimization activity.",
- "properties": {
- "floodlightActivityId": {
- "type": "string",
- "description": "Floodlight activity ID of this optimization activity. This is a required field.",
- "format": "int64"
- },
- "floodlightActivityIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field."
- },
- "weight": {
- "type": "integer",
- "description": "Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.",
- "format": "int32"
- }
- }
- },
- "Order": {
- "id": "Order",
- "type": "object",
- "description": "Describes properties of a DoubleClick Planning order.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this order.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this order.",
- "format": "int64"
- },
- "approverUserProfileIds": {
- "type": "array",
- "description": "IDs for users that have to approve documents created for this order.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "buyerInvoiceId": {
- "type": "string",
- "description": "Buyer invoice ID associated with this order."
- },
- "buyerOrganizationName": {
- "type": "string",
- "description": "Name of the buyer organization."
- },
- "comments": {
- "type": "string",
- "description": "Comments in this order."
- },
- "contacts": {
- "type": "array",
- "description": "Contacts for this order.",
- "items": {
- "$ref": "OrderContact"
- }
- },
- "id": {
- "type": "string",
- "description": "ID of this order. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#order\".",
- "default": "dfareporting#order"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this order."
- },
- "name": {
- "type": "string",
- "description": "Name of this order."
- },
- "notes": {
- "type": "string",
- "description": "Notes of this order."
- },
- "planningTermId": {
- "type": "string",
- "description": "ID of the terms and conditions template used in this order.",
- "format": "int64"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of this order.",
- "format": "int64"
- },
- "sellerOrderId": {
- "type": "string",
- "description": "Seller order ID associated with this order."
- },
- "sellerOrganizationName": {
- "type": "string",
- "description": "Name of the seller organization."
- },
- "siteId": {
- "type": "array",
- "description": "Site IDs this order is associated with.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "siteNames": {
- "type": "array",
- "description": "Free-form site names this order is associated with.",
- "items": {
- "type": "string"
- }
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this order.",
- "format": "int64"
- },
- "termsAndConditions": {
- "type": "string",
- "description": "Terms and conditions of this order."
- }
- }
- },
- "OrderContact": {
- "id": "OrderContact",
- "type": "object",
- "description": "Contact of an order.",
- "properties": {
- "contactInfo": {
- "type": "string",
- "description": "Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID."
- },
- "contactName": {
- "type": "string",
- "description": "Name of this contact."
- },
- "contactTitle": {
- "type": "string",
- "description": "Title of this contact."
- },
- "contactType": {
- "type": "string",
- "description": "Type of this contact.",
- "enum": [
- "PLANNING_ORDER_CONTACT_BUYER_BILLING_CONTACT",
- "PLANNING_ORDER_CONTACT_BUYER_CONTACT",
- "PLANNING_ORDER_CONTACT_SELLER_CONTACT"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "signatureUserProfileId": {
- "type": "string",
- "description": "ID of the user profile containing the signature that will be embedded into order documents.",
- "format": "int64"
- }
- }
- },
- "OrderDocument": {
- "id": "OrderDocument",
- "type": "object",
- "description": "Contains properties of a DoubleClick Planning order document.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this order document.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this order document.",
- "format": "int64"
- },
- "amendedOrderDocumentId": {
- "type": "string",
- "description": "The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved.",
- "format": "int64"
- },
- "approvedByUserProfileIds": {
- "type": "array",
- "description": "IDs of users who have approved this order document.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "cancelled": {
- "type": "boolean",
- "description": "Whether this order document is cancelled."
- },
- "createdInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the creation of this order document."
- },
- "effectiveDate": {
- "type": "string",
- "description": "Effective date of this order document.",
- "format": "date"
- },
- "id": {
- "type": "string",
- "description": "ID of this order document.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#orderDocument\".",
- "default": "dfareporting#orderDocument"
- },
- "orderId": {
- "type": "string",
- "description": "ID of the order from which this order document is created.",
- "format": "int64"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of this order document.",
- "format": "int64"
- },
- "signed": {
- "type": "boolean",
- "description": "Whether this order document has been signed."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this order document.",
- "format": "int64"
- },
- "title": {
- "type": "string",
- "description": "Title of this order document."
- },
- "type": {
- "type": "string",
- "description": "Type of this order document",
- "enum": [
- "PLANNING_ORDER_TYPE_CHANGE_ORDER",
- "PLANNING_ORDER_TYPE_INSERTION_ORDER"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- }
- }
- },
- "OrderDocumentsListResponse": {
- "id": "OrderDocumentsListResponse",
- "type": "object",
- "description": "Order document List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#orderDocumentsListResponse\".",
- "default": "dfareporting#orderDocumentsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- },
- "orderDocuments": {
- "type": "array",
- "description": "Order document collection",
- "items": {
- "$ref": "OrderDocument"
- }
- }
- }
- },
- "OrdersListResponse": {
- "id": "OrdersListResponse",
- "type": "object",
- "description": "Order List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#ordersListResponse\".",
- "default": "dfareporting#ordersListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- },
- "orders": {
- "type": "array",
- "description": "Order collection.",
- "items": {
- "$ref": "Order"
- }
- }
- }
- },
- "PathToConversionReportCompatibleFields": {
- "id": "PathToConversionReportCompatibleFields",
- "type": "object",
- "description": "Represents fields that are compatible to be selected for a report of type \"PATH_TO_CONVERSION\".",
- "properties": {
- "conversionDimensions": {
- "type": "array",
- "description": "Conversion dimensions which are compatible to be selected in the \"conversionDimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "customFloodlightVariables": {
- "type": "array",
- "description": "Custom floodlight variables which are compatible to be selected in the \"customFloodlightVariables\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields.",
- "default": "dfareporting#pathToConversionReportCompatibleFields"
- },
- "metrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- },
- "perInteractionDimensions": {
- "type": "array",
- "description": "Per-interaction dimensions which are compatible to be selected in the \"perInteractionDimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- }
- }
- },
- "Placement": {
- "id": "Placement",
- "type": "object",
- "description": "Contains properties of a placement.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this placement. This field can be left blank.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this placement. This field can be left blank.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "archived": {
- "type": "boolean",
- "description": "Whether this placement is archived."
- },
- "campaignId": {
- "type": "string",
- "description": "Campaign ID of this placement. This field is a required field on insertion.",
- "format": "int64"
- },
- "campaignIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
- },
- "comment": {
- "type": "string",
- "description": "Comments for this placement."
- },
- "compatibility": {
- "type": "string",
- "description": "Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.",
- "enum": [
- "APP",
- "APP_INTERSTITIAL",
- "IN_STREAM_VIDEO",
- "WEB",
- "WEB_INTERSTITIAL"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "contentCategoryId": {
- "type": "string",
- "description": "ID of the content category assigned to this placement.",
- "format": "int64"
- },
- "createInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the creation of this placement. This is a read-only field."
- },
- "directorySiteId": {
- "type": "string",
- "description": "Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.",
- "format": "int64"
- },
- "directorySiteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field."
- },
- "externalId": {
- "type": "string",
- "description": "External ID for this placement."
- },
- "id": {
- "type": "string",
- "description": "ID of this placement. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this placement. This is a read-only, auto-generated field."
- },
- "keyName": {
- "type": "string",
- "description": "Key name of this placement. This is a read-only, auto-generated field."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placement\".",
- "default": "dfareporting#placement"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this placement. This is a read-only field."
- },
- "lookbackConfiguration": {
- "$ref": "LookbackConfiguration",
- "description": "Lookback window settings for this placement."
- },
- "name": {
- "type": "string",
- "description": "Name of this placement.This is a required field and must be less than 256 characters long."
- },
- "paymentApproved": {
- "type": "boolean",
- "description": "Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements."
- },
- "paymentSource": {
- "type": "string",
- "description": "Payment source for this placement. This is a required field that is read-only after insertion.",
- "enum": [
- "PLACEMENT_AGENCY_PAID",
- "PLACEMENT_PUBLISHER_PAID"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "placementGroupId": {
- "type": "string",
- "description": "ID of this placement's group, if applicable.",
- "format": "int64"
- },
- "placementGroupIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the placement group. This is a read-only, auto-generated field."
- },
- "placementStrategyId": {
- "type": "string",
- "description": "ID of the placement strategy assigned to this placement.",
- "format": "int64"
- },
- "pricingSchedule": {
- "$ref": "PricingSchedule",
- "description": "Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType."
- },
- "primary": {
- "type": "boolean",
- "description": "Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement."
- },
- "publisherUpdateInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the last publisher update. This is a read-only field."
- },
- "siteId": {
- "type": "string",
- "description": "Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.",
- "format": "int64"
- },
- "siteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field."
- },
- "size": {
- "$ref": "Size",
- "description": "Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion."
- },
- "sslRequired": {
- "type": "boolean",
- "description": "Whether creatives assigned to this placement must be SSL-compliant."
- },
- "status": {
- "type": "string",
- "description": "Third-party placement status.",
- "enum": [
- "ACKNOWLEDGE_ACCEPTANCE",
- "ACKNOWLEDGE_REJECTION",
- "DRAFT",
- "PAYMENT_ACCEPTED",
- "PAYMENT_REJECTED",
- "PENDING_REVIEW"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this placement. This field can be left blank.",
- "format": "int64"
- },
- "tagFormats": {
- "type": "array",
- "description": "Tag formats to generate for this placement. This field is required on insertion.\nAcceptable values are:\n- \"PLACEMENT_TAG_STANDARD\"\n- \"PLACEMENT_TAG_IFRAME_JAVASCRIPT\"\n- \"PLACEMENT_TAG_IFRAME_ILAYER\"\n- \"PLACEMENT_TAG_INTERNAL_REDIRECT\"\n- \"PLACEMENT_TAG_JAVASCRIPT\"\n- \"PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT\"\n- \"PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT\"\n- \"PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT\"\n- \"PLACEMENT_TAG_CLICK_COMMANDS\"\n- \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH\"\n- \"PLACEMENT_TAG_TRACKING\"\n- \"PLACEMENT_TAG_TRACKING_IFRAME\"\n- \"PLACEMENT_TAG_TRACKING_JAVASCRIPT\"",
- "items": {
- "type": "string",
- "enum": [
- "PLACEMENT_TAG_CLICK_COMMANDS",
- "PLACEMENT_TAG_IFRAME_ILAYER",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
- "PLACEMENT_TAG_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_JAVASCRIPT",
- "PLACEMENT_TAG_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_STANDARD",
- "PLACEMENT_TAG_TRACKING",
- "PLACEMENT_TAG_TRACKING_IFRAME",
- "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- },
- "tagSetting": {
- "$ref": "TagSetting",
- "description": "Tag settings for this placement."
- }
- }
- },
- "PlacementAssignment": {
- "id": "PlacementAssignment",
- "type": "object",
- "description": "Placement Assignment.",
- "properties": {
- "active": {
- "type": "boolean",
- "description": "Whether this placement assignment is active. When true, the placement will be included in the ad's rotation."
- },
- "placementId": {
- "type": "string",
- "description": "ID of the placement to be assigned. This is a required field.",
- "format": "int64"
- },
- "placementIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the placement. This is a read-only, auto-generated field."
- },
- "sslRequired": {
- "type": "boolean",
- "description": "Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated."
- }
- }
- },
- "PlacementGroup": {
- "id": "PlacementGroup",
- "type": "object",
- "description": "Contains properties of a package or roadblock.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this placement group. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this placement group. This is a required field on insertion.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "archived": {
- "type": "boolean",
- "description": "Whether this placement group is archived."
- },
- "campaignId": {
- "type": "string",
- "description": "Campaign ID of this placement group. This field is required on insertion.",
- "format": "int64"
- },
- "campaignIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
- },
- "childPlacementIds": {
- "type": "array",
- "description": "IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "comment": {
- "type": "string",
- "description": "Comments for this placement group."
- },
- "contentCategoryId": {
- "type": "string",
- "description": "ID of the content category assigned to this placement group.",
- "format": "int64"
- },
- "createInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the creation of this placement group. This is a read-only field."
- },
- "directorySiteId": {
- "type": "string",
- "description": "Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.",
- "format": "int64"
- },
- "directorySiteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field."
- },
- "externalId": {
- "type": "string",
- "description": "External ID for this placement."
- },
- "id": {
- "type": "string",
- "description": "ID of this placement group. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this placement group. This is a read-only, auto-generated field."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementGroup\".",
- "default": "dfareporting#placementGroup"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this placement group. This is a read-only field."
- },
- "name": {
- "type": "string",
- "description": "Name of this placement group. This is a required field and must be less than 256 characters long."
- },
- "placementGroupType": {
- "type": "string",
- "description": "Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.",
- "enum": [
- "PLACEMENT_PACKAGE",
- "PLACEMENT_ROADBLOCK"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "placementStrategyId": {
- "type": "string",
- "description": "ID of the placement strategy assigned to this placement group.",
- "format": "int64"
- },
- "pricingSchedule": {
- "$ref": "PricingSchedule",
- "description": "Pricing schedule of this placement group. This field is required on insertion."
- },
- "primaryPlacementId": {
- "type": "string",
- "description": "ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.",
- "format": "int64"
- },
- "primaryPlacementIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the primary placement. This is a read-only, auto-generated field."
- },
- "programmaticSetting": {
- "$ref": "ProgrammaticSetting",
- "description": "Settings for a programmatic placement."
- },
- "siteId": {
- "type": "string",
- "description": "Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.",
- "format": "int64"
- },
- "siteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this placement group. This is a read-only field that can be left blank.",
- "format": "int64"
- }
- }
- },
- "PlacementGroupsListResponse": {
- "id": "PlacementGroupsListResponse",
- "type": "object",
- "description": "Placement Group List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementGroupsListResponse\".",
- "default": "dfareporting#placementGroupsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- },
- "placementGroups": {
- "type": "array",
- "description": "Placement group collection.",
- "items": {
- "$ref": "PlacementGroup"
- }
- }
- }
- },
- "PlacementStrategiesListResponse": {
- "id": "PlacementStrategiesListResponse",
- "type": "object",
- "description": "Placement Strategy List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementStrategiesListResponse\".",
- "default": "dfareporting#placementStrategiesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- },
- "placementStrategies": {
- "type": "array",
- "description": "Placement strategy collection.",
- "items": {
- "$ref": "PlacementStrategy"
- }
- }
- }
- },
- "PlacementStrategy": {
- "id": "PlacementStrategy",
- "type": "object",
- "description": "Contains properties of a placement strategy.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this placement strategy.This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "ID of this placement strategy. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementStrategy\".",
- "default": "dfareporting#placementStrategy"
- },
- "name": {
- "type": "string",
- "description": "Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account."
- }
- }
- },
- "PlacementTag": {
- "id": "PlacementTag",
- "type": "object",
- "description": "Placement Tag",
- "properties": {
- "placementId": {
- "type": "string",
- "description": "Placement ID",
- "format": "int64"
- },
- "tagDatas": {
- "type": "array",
- "description": "Tags generated for this placement.",
- "items": {
- "$ref": "TagData"
- }
- }
- }
- },
- "PlacementsGenerateTagsResponse": {
- "id": "PlacementsGenerateTagsResponse",
- "type": "object",
- "description": "Placement GenerateTags Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementsGenerateTagsResponse\".",
- "default": "dfareporting#placementsGenerateTagsResponse"
- },
- "placementTags": {
- "type": "array",
- "description": "Set of generated tags for the specified placements.",
- "items": {
- "$ref": "PlacementTag"
- }
- }
- }
- },
- "PlacementsListResponse": {
- "id": "PlacementsListResponse",
- "type": "object",
- "description": "Placement List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementsListResponse\".",
- "default": "dfareporting#placementsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- },
- "placements": {
- "type": "array",
- "description": "Placement collection.",
- "items": {
- "$ref": "Placement"
- }
- }
- }
- },
- "PlatformType": {
- "id": "PlatformType",
- "type": "object",
- "description": "Contains information about a platform type that can be targeted by ads.",
- "properties": {
- "id": {
- "type": "string",
- "description": "ID of this platform type.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#platformType\".",
- "default": "dfareporting#platformType"
- },
- "name": {
- "type": "string",
- "description": "Name of this platform type."
- }
- }
- },
- "PlatformTypesListResponse": {
- "id": "PlatformTypesListResponse",
- "type": "object",
- "description": "Platform Type List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#platformTypesListResponse\".",
- "default": "dfareporting#platformTypesListResponse"
- },
- "platformTypes": {
- "type": "array",
- "description": "Platform type collection.",
- "items": {
- "$ref": "PlatformType"
- }
- }
- }
- },
- "PopupWindowProperties": {
- "id": "PopupWindowProperties",
- "type": "object",
- "description": "Popup Window Properties.",
- "properties": {
- "dimension": {
- "$ref": "Size",
- "description": "Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID"
- },
- "offset": {
- "$ref": "OffsetPosition",
- "description": "Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES."
- },
- "positionType": {
- "type": "string",
- "description": "Popup window position either centered or at specific coordinate.",
- "enum": [
- "CENTER",
- "COORDINATES"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "showAddressBar": {
- "type": "boolean",
- "description": "Whether to display the browser address bar."
- },
- "showMenuBar": {
- "type": "boolean",
- "description": "Whether to display the browser menu bar."
- },
- "showScrollBar": {
- "type": "boolean",
- "description": "Whether to display the browser scroll bar."
- },
- "showStatusBar": {
- "type": "boolean",
- "description": "Whether to display the browser status bar."
- },
- "showToolBar": {
- "type": "boolean",
- "description": "Whether to display the browser tool bar."
- },
- "title": {
- "type": "string",
- "description": "Title of popup window."
- }
- }
- },
- "PostalCode": {
- "id": "PostalCode",
- "type": "object",
- "description": "Contains information about a postal code that can be targeted by ads.",
- "properties": {
- "code": {
- "type": "string",
- "description": "Postal code. This is equivalent to the id field."
- },
- "countryCode": {
- "type": "string",
- "description": "Country code of the country to which this postal code belongs."
- },
- "countryDartId": {
- "type": "string",
- "description": "DART ID of the country to which this postal code belongs.",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "ID of this postal code."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#postalCode\".",
- "default": "dfareporting#postalCode"
- }
- }
- },
- "PostalCodesListResponse": {
- "id": "PostalCodesListResponse",
- "type": "object",
- "description": "Postal Code List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#postalCodesListResponse\".",
- "default": "dfareporting#postalCodesListResponse"
- },
- "postalCodes": {
- "type": "array",
- "description": "Postal code collection.",
- "items": {
- "$ref": "PostalCode"
- }
- }
- }
- },
- "Pricing": {
- "id": "Pricing",
- "type": "object",
- "description": "Pricing Information",
- "properties": {
- "capCostType": {
- "type": "string",
- "description": "Cap cost type of this inventory item.",
- "enum": [
- "PLANNING_PLACEMENT_CAP_COST_TYPE_CUMULATIVE",
- "PLANNING_PLACEMENT_CAP_COST_TYPE_MONTHLY",
- "PLANNING_PLACEMENT_CAP_COST_TYPE_NONE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "endDate": {
- "type": "string",
- "description": "End date of this inventory item.",
- "format": "date"
- },
- "flights": {
- "type": "array",
- "description": "Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time.",
- "items": {
- "$ref": "Flight"
- }
- },
- "groupType": {
- "type": "string",
- "description": "Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary.",
- "enum": [
- "PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE",
- "PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "pricingType": {
- "type": "string",
- "description": "Pricing type of this inventory item.",
- "enum": [
- "PLANNING_PLACEMENT_PRICING_TYPE_CLICKS",
- "PLANNING_PLACEMENT_PRICING_TYPE_CPA",
- "PLANNING_PLACEMENT_PRICING_TYPE_CPC",
- "PLANNING_PLACEMENT_PRICING_TYPE_CPM",
- "PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_CLICKS",
- "PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_IMPRESSIONS",
- "PLANNING_PLACEMENT_PRICING_TYPE_IMPRESSIONS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "startDate": {
- "type": "string",
- "description": "Start date of this inventory item.",
- "format": "date"
- }
- }
- },
- "PricingSchedule": {
- "id": "PricingSchedule",
- "type": "object",
- "description": "Pricing Schedule",
- "properties": {
- "capCostOption": {
- "type": "string",
- "description": "Placement cap cost option.",
- "enum": [
- "CAP_COST_CUMULATIVE",
- "CAP_COST_MONTHLY",
- "CAP_COST_NONE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "disregardOverdelivery": {
- "type": "boolean",
- "description": "Whether cap costs are ignored by ad serving."
- },
- "endDate": {
- "type": "string",
- "description": "Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.",
- "format": "date"
- },
- "flighted": {
- "type": "boolean",
- "description": "Whether this placement is flighted. If true, pricing periods will be computed automatically."
- },
- "floodlightActivityId": {
- "type": "string",
- "description": "Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.",
- "format": "int64"
- },
- "pricingPeriods": {
- "type": "array",
- "description": "Pricing periods for this placement.",
- "items": {
- "$ref": "PricingSchedulePricingPeriod"
- }
- },
- "pricingType": {
- "type": "string",
- "description": "Placement pricing type. This field is required on insertion.",
- "enum": [
- "PRICING_TYPE_CPA",
- "PRICING_TYPE_CPC",
- "PRICING_TYPE_CPM",
- "PRICING_TYPE_FLAT_RATE_CLICKS",
- "PRICING_TYPE_FLAT_RATE_IMPRESSIONS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "startDate": {
- "type": "string",
- "description": "Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.",
- "format": "date"
- },
- "testingStartDate": {
- "type": "string",
- "description": "Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.",
- "format": "date"
- }
- }
- },
- "PricingSchedulePricingPeriod": {
- "id": "PricingSchedulePricingPeriod",
- "type": "object",
- "description": "Pricing Period",
- "properties": {
- "endDate": {
- "type": "string",
- "description": "Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.",
- "format": "date"
- },
- "pricingComment": {
- "type": "string",
- "description": "Comments for this pricing period."
- },
- "rateOrCostNanos": {
- "type": "string",
- "description": "Rate or cost of this pricing period.",
- "format": "int64"
- },
- "startDate": {
- "type": "string",
- "description": "Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.",
- "format": "date"
- },
- "units": {
- "type": "string",
- "description": "Units of this pricing period.",
- "format": "int64"
- }
- }
- },
- "ProgrammaticSetting": {
- "id": "ProgrammaticSetting",
- "type": "object",
- "description": "Programmatic Setting",
- "properties": {
- "adxDealIds": {
- "type": "array",
- "description": "Adx deal IDs assigned to the placement.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "insertionOrderId": {
- "type": "string",
- "description": "Insertion order ID."
- },
- "insertionOrderIdStatus": {
- "type": "boolean",
- "description": "Whether insertion order ID has been placed in DFP. This is a read-only field."
- },
- "mediaCostNanos": {
- "type": "string",
- "description": "Media cost for the programmatic placement.",
- "format": "int64"
- },
- "programmatic": {
- "type": "boolean",
- "description": "Whether programmatic is enabled."
- },
- "traffickerEmails": {
- "type": "array",
- "description": "Trafficker emails assigned to the placement.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "Project": {
- "id": "Project",
- "type": "object",
- "description": "Contains properties of a DoubleClick Planning project.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this project.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this project.",
- "format": "int64"
- },
- "audienceAgeGroup": {
- "type": "string",
- "description": "Audience age group of this project.",
- "enum": [
- "PLANNING_AUDIENCE_AGE_18_24",
- "PLANNING_AUDIENCE_AGE_25_34",
- "PLANNING_AUDIENCE_AGE_35_44",
- "PLANNING_AUDIENCE_AGE_45_54",
- "PLANNING_AUDIENCE_AGE_55_64",
- "PLANNING_AUDIENCE_AGE_65_OR_MORE",
- "PLANNING_AUDIENCE_AGE_UNKNOWN"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "audienceGender": {
- "type": "string",
- "description": "Audience gender of this project.",
- "enum": [
- "PLANNING_AUDIENCE_GENDER_FEMALE",
- "PLANNING_AUDIENCE_GENDER_MALE"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "budget": {
- "type": "string",
- "description": "Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.",
- "format": "int64"
- },
- "clientBillingCode": {
- "type": "string",
- "description": "Client billing code of this project."
- },
- "clientName": {
- "type": "string",
- "description": "Name of the project client."
- },
- "endDate": {
- "type": "string",
- "description": "End date of the project.",
- "format": "date"
- },
- "id": {
- "type": "string",
- "description": "ID of this project. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#project\".",
- "default": "dfareporting#project"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this project."
- },
- "name": {
- "type": "string",
- "description": "Name of this project."
- },
- "overview": {
- "type": "string",
- "description": "Overview of this project."
- },
- "startDate": {
- "type": "string",
- "description": "Start date of the project.",
- "format": "date"
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this project.",
- "format": "int64"
- },
- "targetClicks": {
- "type": "string",
- "description": "Number of clicks that the advertiser is targeting.",
- "format": "int64"
- },
- "targetConversions": {
- "type": "string",
- "description": "Number of conversions that the advertiser is targeting.",
- "format": "int64"
- },
- "targetCpaNanos": {
- "type": "string",
- "description": "CPA that the advertiser is targeting.",
- "format": "int64"
- },
- "targetCpcNanos": {
- "type": "string",
- "description": "CPC that the advertiser is targeting.",
- "format": "int64"
- },
- "targetCpmNanos": {
- "type": "string",
- "description": "CPM that the advertiser is targeting.",
- "format": "int64"
- },
- "targetImpressions": {
- "type": "string",
- "description": "Number of impressions that the advertiser is targeting.",
- "format": "int64"
- }
- }
- },
- "ProjectsListResponse": {
- "id": "ProjectsListResponse",
- "type": "object",
- "description": "Project List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#projectsListResponse\".",
- "default": "dfareporting#projectsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- },
- "projects": {
- "type": "array",
- "description": "Project collection.",
- "items": {
- "$ref": "Project"
- }
- }
- }
- },
- "ReachReportCompatibleFields": {
- "id": "ReachReportCompatibleFields",
- "type": "object",
- "description": "Represents fields that are compatible to be selected for a report of type \"REACH\".",
- "properties": {
- "dimensionFilters": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#reachReportCompatibleFields.",
- "default": "dfareporting#reachReportCompatibleFields"
- },
- "metrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- },
- "pivotedActivityMetrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected as activity metrics to pivot on in the \"activities\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- },
- "reachByFrequencyMetrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected in the \"reachByFrequencyMetricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- }
- }
- },
- "Recipient": {
- "id": "Recipient",
- "type": "object",
- "description": "Represents a recipient.",
- "properties": {
- "deliveryType": {
- "type": "string",
- "description": "The delivery type for the recipient.",
- "enum": [
- "ATTACHMENT",
- "LINK"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "email": {
- "type": "string",
- "description": "The email address of the recipient.",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#recipient.",
- "default": "dfareporting#recipient"
- }
- }
- },
- "Region": {
- "id": "Region",
- "type": "object",
- "description": "Contains information about a region that can be targeted by ads.",
- "properties": {
- "countryCode": {
- "type": "string",
- "description": "Country code of the country to which this region belongs."
- },
- "countryDartId": {
- "type": "string",
- "description": "DART ID of the country to which this region belongs.",
- "format": "int64"
- },
- "dartId": {
- "type": "string",
- "description": "DART ID of this region.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#region\".",
- "default": "dfareporting#region"
- },
- "name": {
- "type": "string",
- "description": "Name of this region."
- },
- "regionCode": {
- "type": "string",
- "description": "Region code."
- }
- }
- },
- "RegionsListResponse": {
- "id": "RegionsListResponse",
- "type": "object",
- "description": "Region List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#regionsListResponse\".",
- "default": "dfareporting#regionsListResponse"
- },
- "regions": {
- "type": "array",
- "description": "Region collection.",
- "items": {
- "$ref": "Region"
- }
- }
- }
- },
- "RemarketingList": {
- "id": "RemarketingList",
- "type": "object",
- "description": "Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
- "format": "int64"
- },
- "active": {
- "type": "boolean",
- "description": "Whether this remarketing list is active."
- },
- "advertiserId": {
- "type": "string",
- "description": "Dimension value for the advertiser ID that owns this remarketing list. This is a required field.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "description": {
- "type": "string",
- "description": "Remarketing list description."
- },
- "id": {
- "type": "string",
- "description": "Remarketing list ID. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingList\".",
- "default": "dfareporting#remarketingList"
- },
- "lifeSpan": {
- "type": "string",
- "description": "Number of days that a user should remain in the remarketing list without an impression.",
- "format": "int64"
- },
- "listPopulationRule": {
- "$ref": "ListPopulationRule",
- "description": "Rule used to populate the remarketing list with users."
- },
- "listSize": {
- "type": "string",
- "description": "Number of users currently in the list. This is a read-only field.",
- "format": "int64"
- },
- "listSource": {
- "type": "string",
- "description": "Product from which this remarketing list was originated.",
- "enum": [
- "REMARKETING_LIST_SOURCE_DBM",
- "REMARKETING_LIST_SOURCE_DFA",
- "REMARKETING_LIST_SOURCE_DMP",
- "REMARKETING_LIST_SOURCE_GA",
- "REMARKETING_LIST_SOURCE_OTHER"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "name": {
- "type": "string",
- "description": "Name of the remarketing list. This is a required field. Must be no greater than 128 characters long."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
- "format": "int64"
- }
- }
- },
- "RemarketingListShare": {
- "id": "RemarketingListShare",
- "type": "object",
- "description": "Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingListShare\".",
- "default": "dfareporting#remarketingListShare"
- },
- "remarketingListId": {
- "type": "string",
- "description": "Remarketing list ID. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "sharedAccountIds": {
- "type": "array",
- "description": "Accounts that the remarketing list is shared with.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "sharedAdvertiserIds": {
- "type": "array",
- "description": "Advertisers that the remarketing list is shared with.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- }
- }
- },
- "RemarketingListsListResponse": {
- "id": "RemarketingListsListResponse",
- "type": "object",
- "description": "Remarketing list response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingListsListResponse\".",
- "default": "dfareporting#remarketingListsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- },
- "remarketingLists": {
- "type": "array",
- "description": "Remarketing list collection.",
- "items": {
- "$ref": "RemarketingList"
- }
- }
- }
- },
- "Report": {
- "id": "Report",
- "type": "object",
- "description": "Represents a Report resource.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The account ID to which this report belongs.",
- "format": "int64",
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- }
- },
- "criteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"STANDARD\".",
- "properties": {
- "activities": {
- "$ref": "Activities",
- "description": "Activity group."
- },
- "customRichMediaEvents": {
- "$ref": "CustomRichMediaEvents",
- "description": "Custom Rich Media Events group."
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range for which this report should be run."
- },
- "dimensionFilters": {
- "type": "array",
- "description": "The list of filters on which dimensions are filtered.\nFilters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "The list of standard dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "crossDimensionReachCriteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"CROSS_DIMENSION_REACH\".",
- "properties": {
- "breakdown": {
- "type": "array",
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimension": {
- "type": "string",
- "description": "The dimension option.",
- "enum": [
- "ADVERTISER",
- "CAMPAIGN",
- "SITE_BY_ADVERTISER",
- "SITE_BY_CAMPAIGN"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- },
- "dimensionFilters": {
- "type": "array",
- "description": "The list of filters on which dimensions are filtered.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "overlapMetricNames": {
- "type": "array",
- "description": "The list of names of overlap metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "pivoted": {
- "type": "boolean",
- "description": "Whether the report is pivoted or not. Defaults to true."
- }
- }
- },
- "delivery": {
- "type": "object",
- "description": "The report's email delivery settings.",
- "properties": {
- "emailOwner": {
- "type": "boolean",
- "description": "Whether the report should be emailed to the report owner."
- },
- "emailOwnerDeliveryType": {
- "type": "string",
- "description": "The type of delivery for the owner to receive, if enabled.",
- "enum": [
- "ATTACHMENT",
- "LINK"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "message": {
- "type": "string",
- "description": "The message to be sent with each email."
- },
- "recipients": {
- "type": "array",
- "description": "The list of recipients to which to email the report.",
- "items": {
- "$ref": "Recipient"
- }
- }
- }
- },
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "fileName": {
- "type": "string",
- "description": "The filename used when generating report files for this report."
- },
- "floodlightCriteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"FLOODLIGHT\".",
- "properties": {
- "customRichMediaEvents": {
- "type": "array",
- "description": "The list of custom rich media events to include.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimensionFilters": {
- "type": "array",
- "description": "The list of filters on which dimensions are filtered.\nFilters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "floodlightConfigId": {
- "$ref": "DimensionValue",
- "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "reportProperties": {
- "type": "object",
- "description": "The properties of the report.",
- "properties": {
- "includeAttributedIPConversions": {
- "type": "boolean",
- "description": "Include conversions that have no cookie, but do have an exposure path."
- },
- "includeUnattributedCookieConversions": {
- "type": "boolean",
- "description": "Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window."
- },
- "includeUnattributedIPConversions": {
- "type": "boolean",
- "description": "Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion."
- }
- }
- }
- }
- },
- "format": {
- "type": "string",
- "description": "The output format of the report. If not specified, default format is \"CSV\". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. \"CSV\" will then be the fallback format.",
- "enum": [
- "CSV",
- "EXCEL"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "id": {
- "type": "string",
- "description": "The unique ID identifying this report resource.",
- "format": "int64",
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#report.",
- "default": "dfareporting#report"
- },
- "lastModifiedTime": {
- "type": "string",
- "description": "The timestamp (in milliseconds since epoch) of when this report was last modified.",
- "format": "uint64",
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- }
- },
- "name": {
- "type": "string",
- "description": "The name of the report.",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "ownerProfileId": {
- "type": "string",
- "description": "The user profile id of the owner of this report.",
- "format": "int64",
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- }
- },
- "pathToConversionCriteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"PATH_TO_CONVERSION\".",
- "properties": {
- "activityFilters": {
- "type": "array",
- "description": "The list of 'dfa:activity' values to filter on.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "conversionDimensions": {
- "type": "array",
- "description": "The list of conversion dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "customFloodlightVariables": {
- "type": "array",
- "description": "The list of custom floodlight variables the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "customRichMediaEvents": {
- "type": "array",
- "description": "The list of custom rich media events to include.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "floodlightConfigId": {
- "$ref": "DimensionValue",
- "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "perInteractionDimensions": {
- "type": "array",
- "description": "The list of per interaction dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "reportProperties": {
- "type": "object",
- "description": "The properties of the report.",
- "properties": {
- "clicksLookbackWindow": {
- "type": "integer",
- "description": "DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.",
- "format": "int32"
- },
- "impressionsLookbackWindow": {
- "type": "integer",
- "description": "DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.",
- "format": "int32"
- },
- "includeAttributedIPConversions": {
- "type": "boolean",
- "description": "Deprecated: has no effect."
- },
- "includeUnattributedCookieConversions": {
- "type": "boolean",
- "description": "Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window."
- },
- "includeUnattributedIPConversions": {
- "type": "boolean",
- "description": "Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion."
- },
- "maximumClickInteractions": {
- "type": "integer",
- "description": "The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.",
- "format": "int32"
- },
- "maximumImpressionInteractions": {
- "type": "integer",
- "description": "The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.",
- "format": "int32"
- },
- "maximumInteractionGap": {
- "type": "integer",
- "description": "The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.",
- "format": "int32"
- },
- "pivotOnInteractionPath": {
- "type": "boolean",
- "description": "Enable pivoting on interaction path."
- }
- }
- }
- }
- },
- "reachCriteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"REACH\".",
- "properties": {
- "activities": {
- "$ref": "Activities",
- "description": "Activity group."
- },
- "customRichMediaEvents": {
- "$ref": "CustomRichMediaEvents",
- "description": "Custom Rich Media Events group."
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimensionFilters": {
- "type": "array",
- "description": "The list of filters on which dimensions are filtered.\nFilters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "enableAllDimensionCombinations": {
- "type": "boolean",
- "description": "Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months."
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "reachByFrequencyMetricNames": {
- "type": "array",
- "description": "The list of names of Reach By Frequency metrics the report should include.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "schedule": {
- "type": "object",
- "description": "The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not \"TODAY\".",
- "properties": {
- "active": {
- "type": "boolean",
- "description": "Whether the schedule is active or not. Must be set to either true or false.",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "every": {
- "type": "integer",
- "description": "Defines every how many days, weeks or months the report should be run. Needs to be set when \"repeats\" is either \"DAILY\", \"WEEKLY\" or \"MONTHLY\".",
- "format": "int32"
- },
- "expirationDate": {
- "type": "string",
- "description": "The expiration date when the scheduled report stops running.",
- "format": "date",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "repeats": {
- "type": "string",
- "description": "The interval for which the report is repeated. Note: \n- \"DAILY\" also requires field \"every\" to be set. \n- \"WEEKLY\" also requires fields \"every\" and \"repeatsOnWeekDays\" to be set. \n- \"MONTHLY\" also requires fields \"every\" and \"runsOnDayOfMonth\" to be set.",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "repeatsOnWeekDays": {
- "type": "array",
- "description": "List of week days \"WEEKLY\" on which scheduled reports should run.",
- "items": {
- "type": "string",
- "enum": [
- "FRIDAY",
- "MONDAY",
- "SATURDAY",
- "SUNDAY",
- "THURSDAY",
- "TUESDAY",
- "WEDNESDAY"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- },
- "runsOnDayOfMonth": {
- "type": "string",
- "description": "Enum to define for \"MONTHLY\" scheduled reports whether reports should be repeated on the same day of the month as \"startDate\" or the same day of the week of the month.\nExample: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), \"DAY_OF_MONTH\" would run subsequent reports on the 2nd of every Month, and \"WEEK_OF_MONTH\" would run subsequent reports on the first Monday of the month.",
- "enum": [
- "DAY_OF_MONTH",
- "WEEK_OF_MONTH"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "startDate": {
- "type": "string",
- "description": "Start date of date range for which scheduled reports should be run.",
- "format": "date",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- }
- }
- },
- "subAccountId": {
- "type": "string",
- "description": "The subaccount ID to which this report belongs if applicable.",
- "format": "int64"
- },
- "type": {
- "type": "string",
- "description": "The type of the report.",
- "enum": [
- "CROSS_DIMENSION_REACH",
- "FLOODLIGHT",
- "PATH_TO_CONVERSION",
- "REACH",
- "STANDARD"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- }
- }
- },
- "ReportCompatibleFields": {
- "id": "ReportCompatibleFields",
- "type": "object",
- "description": "Represents fields that are compatible to be selected for a report of type \"STANDARD\".",
- "properties": {
- "dimensionFilters": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#reportCompatibleFields.",
- "default": "dfareporting#reportCompatibleFields"
- },
- "metrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- },
- "pivotedActivityMetrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected as activity metrics to pivot on in the \"activities\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- }
- }
- },
- "ReportList": {
- "id": "ReportList",
- "type": "object",
- "description": "Represents the list of reports.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The reports returned in this response.",
- "items": {
- "$ref": "Report"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of list this is, in this case dfareporting#reportList.",
- "default": "dfareporting#reportList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through reports. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted."
- }
- }
- },
- "ReportsConfiguration": {
- "id": "ReportsConfiguration",
- "type": "object",
- "description": "Reporting Configuration",
- "properties": {
- "exposureToConversionEnabled": {
- "type": "boolean",
- "description": "Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting."
- },
- "lookbackConfiguration": {
- "$ref": "LookbackConfiguration",
- "description": "Default lookback windows for new advertisers in this account."
- },
- "reportGenerationTimeZoneId": {
- "type": "string",
- "description": "Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.\nAcceptable values are:\n\n- \"1\" for \"America/New_York\" \n- \"2\" for \"Europe/London\" \n- \"3\" for \"Europe/Paris\" \n- \"4\" for \"Africa/Johannesburg\" \n- \"5\" for \"Asia/Jerusalem\" \n- \"6\" for \"Asia/Shanghai\" \n- \"7\" for \"Asia/Hong_Kong\" \n- \"8\" for \"Asia/Tokyo\" \n- \"9\" for \"Australia/Sydney\" \n- \"10\" for \"Asia/Dubai\" \n- \"11\" for \"America/Los_Angeles\" \n- \"12\" for \"Pacific/Auckland\" \n- \"13\" for \"America/Sao_Paulo\"",
- "format": "int64"
- }
- }
- },
- "RichMediaExitOverride": {
- "id": "RichMediaExitOverride",
- "type": "object",
- "description": "Rich Media Exit Override.",
- "properties": {
- "customExitUrl": {
- "type": "string",
- "description": "Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true."
- },
- "exitId": {
- "type": "string",
- "description": "ID for the override to refer to a specific exit in the creative.",
- "format": "int64"
- },
- "useCustomExitUrl": {
- "type": "boolean",
- "description": "Whether to use the custom exit URL."
- }
- }
- },
- "Site": {
- "id": "Site",
- "type": "object",
- "description": "Contains properties of a site.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this site. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "approved": {
- "type": "boolean",
- "description": "Whether this site is approved."
- },
- "directorySiteId": {
- "type": "string",
- "description": "Directory site associated with this site. This is a required field that is read-only after insertion.",
- "format": "int64"
- },
- "directorySiteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field."
- },
- "id": {
- "type": "string",
- "description": "ID of this site. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this site. This is a read-only, auto-generated field."
- },
- "keyName": {
- "type": "string",
- "description": "Key name of this site. This is a read-only, auto-generated field."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#site\".",
- "default": "dfareporting#site"
- },
- "name": {
- "type": "string",
- "description": "Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account."
- },
- "siteContacts": {
- "type": "array",
- "description": "Site contacts.",
- "items": {
- "$ref": "SiteContact"
- }
- },
- "siteSettings": {
- "$ref": "SiteSettings",
- "description": "Site-wide settings."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this site. This is a read-only field that can be left blank.",
- "format": "int64"
- }
- }
- },
- "SiteContact": {
- "id": "SiteContact",
- "type": "object",
- "description": "Site Contact",
- "properties": {
- "address": {
- "type": "string",
- "description": "Address of this site contact."
- },
- "contactType": {
- "type": "string",
- "description": "Site contact type.",
- "enum": [
- "SALES_PERSON",
- "TRAFFICKER"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "email": {
- "type": "string",
- "description": "Email address of this site contact. This is a required field."
- },
- "firstName": {
- "type": "string",
- "description": "First name of this site contact."
- },
- "id": {
- "type": "string",
- "description": "ID of this site contact. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "lastName": {
- "type": "string",
- "description": "Last name of this site contact."
- },
- "phone": {
- "type": "string",
- "description": "Primary phone number of this site contact."
- },
- "title": {
- "type": "string",
- "description": "Title or designation of this site contact."
- }
- }
- },
- "SiteSettings": {
- "id": "SiteSettings",
- "type": "object",
- "description": "Site Settings",
- "properties": {
- "activeViewOptOut": {
- "type": "boolean",
- "description": "Whether active view creatives are disabled for this site."
- },
- "creativeSettings": {
- "$ref": "CreativeSettings",
- "description": "Site-wide creative settings."
- },
- "disableBrandSafeAds": {
- "type": "boolean",
- "description": "Whether brand safe ads are disabled for this site."
- },
- "disableNewCookie": {
- "type": "boolean",
- "description": "Whether new cookies are disabled for this site."
- },
- "lookbackConfiguration": {
- "$ref": "LookbackConfiguration",
- "description": "Lookback window settings for this site."
- },
- "tagSetting": {
- "$ref": "TagSetting",
- "description": "Configuration settings for dynamic and image floodlight tags."
- }
- }
- },
- "SitesListResponse": {
- "id": "SitesListResponse",
- "type": "object",
- "description": "Site List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#sitesListResponse\".",
- "default": "dfareporting#sitesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- },
- "sites": {
- "type": "array",
- "description": "Site collection.",
- "items": {
- "$ref": "Site"
- }
- }
- }
- },
- "Size": {
- "id": "Size",
- "type": "object",
- "description": "Represents the dimensions of ads, placements, creatives, or creative assets.",
- "properties": {
- "height": {
- "type": "integer",
- "description": "Height of this size.",
- "format": "int32"
- },
- "iab": {
- "type": "boolean",
- "description": "IAB standard size. This is a read-only, auto-generated field."
- },
- "id": {
- "type": "string",
- "description": "ID of this size. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#size\".",
- "default": "dfareporting#size"
- },
- "width": {
- "type": "integer",
- "description": "Width of this size.",
- "format": "int32"
- }
- }
- },
- "SizesListResponse": {
- "id": "SizesListResponse",
- "type": "object",
- "description": "Size List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#sizesListResponse\".",
- "default": "dfareporting#sizesListResponse"
- },
- "sizes": {
- "type": "array",
- "description": "Size collection.",
- "items": {
- "$ref": "Size"
- }
- }
- }
- },
- "SortedDimension": {
- "id": "SortedDimension",
- "type": "object",
- "description": "Represents a sorted dimension.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#sortedDimension.",
- "default": "dfareporting#sortedDimension"
- },
- "name": {
- "type": "string",
- "description": "The name of the dimension."
- },
- "sortOrder": {
- "type": "string",
- "description": "An optional sort order for the dimension column.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- }
- }
- },
- "Subaccount": {
- "id": "Subaccount",
- "type": "object",
- "description": "Contains properties of a DCM subaccount.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "ID of the account that contains this subaccount. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "availablePermissionIds": {
- "type": "array",
- "description": "IDs of the available user role permissions for this subaccount.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "id": {
- "type": "string",
- "description": "ID of this subaccount. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#subaccount\".",
- "default": "dfareporting#subaccount"
- },
- "name": {
- "type": "string",
- "description": "Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account."
- }
- }
- },
- "SubaccountsListResponse": {
- "id": "SubaccountsListResponse",
- "type": "object",
- "description": "Subaccount List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#subaccountsListResponse\".",
- "default": "dfareporting#subaccountsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- },
- "subaccounts": {
- "type": "array",
- "description": "Subaccount collection.",
- "items": {
- "$ref": "Subaccount"
- }
- }
- }
- },
- "TagData": {
- "id": "TagData",
- "type": "object",
- "description": "Placement Tag Data",
- "properties": {
- "adId": {
- "type": "string",
- "description": "Ad associated with this placement tag.",
- "format": "int64"
- },
- "clickTag": {
- "type": "string",
- "description": "Tag string to record a click."
- },
- "creativeId": {
- "type": "string",
- "description": "Creative associated with this placement tag.",
- "format": "int64"
- },
- "format": {
- "type": "string",
- "description": "TagData tag format of this tag.",
- "enum": [
- "PLACEMENT_TAG_CLICK_COMMANDS",
- "PLACEMENT_TAG_IFRAME_ILAYER",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
- "PLACEMENT_TAG_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_JAVASCRIPT",
- "PLACEMENT_TAG_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_STANDARD",
- "PLACEMENT_TAG_TRACKING",
- "PLACEMENT_TAG_TRACKING_IFRAME",
- "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "impressionTag": {
- "type": "string",
- "description": "Tag string for serving an ad."
- }
- }
- },
- "TagSetting": {
- "id": "TagSetting",
- "type": "object",
- "description": "Tag Settings",
- "properties": {
- "additionalKeyValues": {
- "type": "string",
- "description": "Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field."
- },
- "includeClickThroughUrls": {
- "type": "boolean",
- "description": "Whether static landing page URLs should be included in the tags. This setting applies only to placements."
- },
- "includeClickTracking": {
- "type": "boolean",
- "description": "Whether click-tracking string should be included in the tags."
- },
- "keywordOption": {
- "type": "string",
- "description": "Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.",
- "enum": [
- "GENERATE_SEPARATE_TAG_FOR_EACH_KEYWORD",
- "IGNORE",
- "PLACEHOLDER_WITH_LIST_OF_KEYWORDS"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- }
- }
- },
- "TagSettings": {
- "id": "TagSettings",
- "type": "object",
- "description": "Dynamic and Image Tag Settings.",
- "properties": {
- "dynamicTagEnabled": {
- "type": "boolean",
- "description": "Whether dynamic floodlight tags are enabled."
- },
- "imageTagEnabled": {
- "type": "boolean",
- "description": "Whether image tags are enabled."
- }
- }
- },
- "TargetWindow": {
- "id": "TargetWindow",
- "type": "object",
- "description": "Target Window.",
- "properties": {
- "customHtml": {
- "type": "string",
- "description": "User-entered value."
- },
- "targetWindowOption": {
- "type": "string",
- "description": "Type of browser window for which the backup image of the flash creative can be displayed.",
- "enum": [
- "CURRENT_WINDOW",
- "CUSTOM",
- "NEW_WINDOW"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- }
- }
- },
- "TargetableRemarketingList": {
- "id": "TargetableRemarketingList",
- "type": "object",
- "description": "Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
- "format": "int64"
- },
- "active": {
- "type": "boolean",
- "description": "Whether this targetable remarketing list is active."
- },
- "advertiserId": {
- "type": "string",
- "description": "Dimension value for the advertiser ID that owns this targetable remarketing list.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser."
- },
- "description": {
- "type": "string",
- "description": "Targetable remarketing list description."
- },
- "id": {
- "type": "string",
- "description": "Targetable remarketing list ID.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetableRemarketingList\".",
- "default": "dfareporting#targetableRemarketingList"
- },
- "lifeSpan": {
- "type": "string",
- "description": "Number of days that a user should remain in the targetable remarketing list without an impression.",
- "format": "int64"
- },
- "listSize": {
- "type": "string",
- "description": "Number of users currently in the list. This is a read-only field.",
- "format": "int64"
- },
- "listSource": {
- "type": "string",
- "description": "Product from which this targetable remarketing list was originated.",
- "enum": [
- "REMARKETING_LIST_SOURCE_DBM",
- "REMARKETING_LIST_SOURCE_DFA",
- "REMARKETING_LIST_SOURCE_DMP",
- "REMARKETING_LIST_SOURCE_GA",
- "REMARKETING_LIST_SOURCE_OTHER"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "name": {
- "type": "string",
- "description": "Name of the targetable remarketing list. Is no greater than 128 characters long."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
- "format": "int64"
- }
- }
- },
- "TargetableRemarketingListsListResponse": {
- "id": "TargetableRemarketingListsListResponse",
- "type": "object",
- "description": "Targetable remarketing list response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetableRemarketingListsListResponse\".",
- "default": "dfareporting#targetableRemarketingListsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- },
- "targetableRemarketingLists": {
- "type": "array",
- "description": "Targetable remarketing list collection.",
- "items": {
- "$ref": "TargetableRemarketingList"
- }
- }
- }
- },
- "TechnologyTargeting": {
- "id": "TechnologyTargeting",
- "type": "object",
- "description": "Technology Targeting.",
- "properties": {
- "browsers": {
- "type": "array",
- "description": "Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.",
- "items": {
- "$ref": "Browser"
- }
- },
- "connectionTypes": {
- "type": "array",
- "description": "Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.",
- "items": {
- "$ref": "ConnectionType"
- }
- },
- "mobileCarriers": {
- "type": "array",
- "description": "Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.",
- "items": {
- "$ref": "MobileCarrier"
- }
- },
- "operatingSystemVersions": {
- "type": "array",
- "description": "Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.",
- "items": {
- "$ref": "OperatingSystemVersion"
- }
- },
- "operatingSystems": {
- "type": "array",
- "description": "Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.",
- "items": {
- "$ref": "OperatingSystem"
- }
- },
- "platformTypes": {
- "type": "array",
- "description": "Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.",
- "items": {
- "$ref": "PlatformType"
- }
- }
- }
- },
- "ThirdPartyTrackingUrl": {
- "id": "ThirdPartyTrackingUrl",
- "type": "object",
- "description": "Third-party Tracking URL.",
- "properties": {
- "thirdPartyUrlType": {
- "type": "string",
- "description": "Third-party URL type for in-stream video creatives.",
- "enum": [
- "CLICK_TRACKING",
- "IMPRESSION",
- "RICH_MEDIA_BACKUP_IMPRESSION",
- "RICH_MEDIA_IMPRESSION",
- "RICH_MEDIA_RM_IMPRESSION",
- "SURVEY",
- "VIDEO_COMPLETE",
- "VIDEO_CUSTOM",
- "VIDEO_FIRST_QUARTILE",
- "VIDEO_FULLSCREEN",
- "VIDEO_MIDPOINT",
- "VIDEO_MUTE",
- "VIDEO_PAUSE",
- "VIDEO_REWIND",
- "VIDEO_START",
- "VIDEO_STOP",
- "VIDEO_THIRD_QUARTILE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "url": {
- "type": "string",
- "description": "URL for the specified third-party URL type."
- }
- }
- },
- "UserDefinedVariableConfiguration": {
- "id": "UserDefinedVariableConfiguration",
- "type": "object",
- "description": "User Defined Variable configuration.",
- "properties": {
- "dataType": {
- "type": "string",
- "description": "Data type for the variable. This is a required field.",
- "enum": [
- "NUMBER",
- "STRING"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "reportName": {
- "type": "string",
- "description": "User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: \"\"\u003c\u003e\"."
- },
- "variableType": {
- "type": "string",
- "description": "Variable name in the tag. This is a required field.",
- "enum": [
- "U1",
- "U10",
- "U11",
- "U12",
- "U13",
- "U14",
- "U15",
- "U16",
- "U17",
- "U18",
- "U19",
- "U2",
- "U20",
- "U3",
- "U4",
- "U5",
- "U6",
- "U7",
- "U8",
- "U9"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- }
- },
- "UserProfile": {
- "id": "UserProfile",
- "type": "object",
- "description": "Represents a UserProfile resource.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The account ID to which this profile belongs.",
- "format": "int64"
- },
- "accountName": {
- "type": "string",
- "description": "The account name this profile belongs to."
- },
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#userProfile.",
- "default": "dfareporting#userProfile"
- },
- "profileId": {
- "type": "string",
- "description": "The unique ID of the user profile.",
- "format": "int64"
- },
- "subAccountId": {
- "type": "string",
- "description": "The sub account ID this profile belongs to if applicable.",
- "format": "int64"
- },
- "subAccountName": {
- "type": "string",
- "description": "The sub account name this profile belongs to if applicable."
- },
- "userName": {
- "type": "string",
- "description": "The user name."
- }
- }
- },
- "UserProfileList": {
- "id": "UserProfileList",
- "type": "object",
- "description": "Represents the list of user profiles.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The user profiles returned in this response.",
- "items": {
- "$ref": "UserProfile"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of list this is, in this case dfareporting#userProfileList.",
- "default": "dfareporting#userProfileList"
- }
- }
- },
- "UserRole": {
- "id": "UserRole",
- "type": "object",
- "description": "Contains properties of auser role, which is used to manage user access.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this user role. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "defaultUserRole": {
- "type": "boolean",
- "description": "Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions."
- },
- "id": {
- "type": "string",
- "description": "ID of this user role. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRole\".",
- "default": "dfareporting#userRole"
- },
- "name": {
- "type": "string",
- "description": "Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account."
- },
- "parentUserRoleId": {
- "type": "string",
- "description": "ID of the user role that this user role is based on or copied from. This is a required field.",
- "format": "int64"
- },
- "permissions": {
- "type": "array",
- "description": "List of permissions associated with this user role.",
- "items": {
- "$ref": "UserRolePermission"
- }
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this user role. This is a read-only field that can be left blank.",
- "format": "int64"
- }
- }
- },
- "UserRolePermission": {
- "id": "UserRolePermission",
- "type": "object",
- "description": "Contains properties of a user role permission.",
- "properties": {
- "availability": {
- "type": "string",
- "description": "Levels of availability for a user role permission.",
- "enum": [
- "ACCOUNT_ALWAYS",
- "ACCOUNT_BY_DEFAULT",
- "NOT_AVAILABLE_BY_DEFAULT",
- "SUBACCOUNT_AND_ACCOUNT_ALWAYS",
- "SUBACCOUNT_AND_ACCOUNT_BY_DEFAULT"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "id": {
- "type": "string",
- "description": "ID of this user role permission.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermission\".",
- "default": "dfareporting#userRolePermission"
- },
- "name": {
- "type": "string",
- "description": "Name of this user role permission."
- },
- "permissionGroupId": {
- "type": "string",
- "description": "ID of the permission group that this user role permission belongs to.",
- "format": "int64"
- }
- }
- },
- "UserRolePermissionGroup": {
- "id": "UserRolePermissionGroup",
- "type": "object",
- "description": "Represents a grouping of related user role permissions.",
- "properties": {
- "id": {
- "type": "string",
- "description": "ID of this user role permission.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionGroup\".",
- "default": "dfareporting#userRolePermissionGroup"
- },
- "name": {
- "type": "string",
- "description": "Name of this user role permission group."
- }
- }
- },
- "UserRolePermissionGroupsListResponse": {
- "id": "UserRolePermissionGroupsListResponse",
- "type": "object",
- "description": "User Role Permission Group List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionGroupsListResponse\".",
- "default": "dfareporting#userRolePermissionGroupsListResponse"
- },
- "userRolePermissionGroups": {
- "type": "array",
- "description": "User role permission group collection.",
- "items": {
- "$ref": "UserRolePermissionGroup"
- }
- }
- }
- },
- "UserRolePermissionsListResponse": {
- "id": "UserRolePermissionsListResponse",
- "type": "object",
- "description": "User Role Permission List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionsListResponse\".",
- "default": "dfareporting#userRolePermissionsListResponse"
- },
- "userRolePermissions": {
- "type": "array",
- "description": "User role permission collection.",
- "items": {
- "$ref": "UserRolePermission"
- }
- }
- }
- },
- "UserRolesListResponse": {
- "id": "UserRolesListResponse",
- "type": "object",
- "description": "User Role List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolesListResponse\".",
- "default": "dfareporting#userRolesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- },
- "userRoles": {
- "type": "array",
- "description": "User role collection.",
- "items": {
- "$ref": "UserRole"
- }
- }
- }
- }
- },
- "resources": {
- "accountActiveAdSummaries": {
- "methods": {
- "get": {
- "id": "dfareporting.accountActiveAdSummaries.get",
- "path": "userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}",
- "httpMethod": "GET",
- "description": "Gets the account's active ad summary by account ID.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "summaryAccountId": {
- "type": "string",
- "description": "Account ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "summaryAccountId"
- ],
- "response": {
- "$ref": "AccountActiveAdSummary"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "accountPermissionGroups": {
- "methods": {
- "get": {
- "id": "dfareporting.accountPermissionGroups.get",
- "path": "userprofiles/{profileId}/accountPermissionGroups/{id}",
- "httpMethod": "GET",
- "description": "Gets one account permission group by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Account permission group ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "AccountPermissionGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.accountPermissionGroups.list",
- "path": "userprofiles/{profileId}/accountPermissionGroups",
- "httpMethod": "GET",
- "description": "Retrieves the list of account permission groups.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "AccountPermissionGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "accountPermissions": {
- "methods": {
- "get": {
- "id": "dfareporting.accountPermissions.get",
- "path": "userprofiles/{profileId}/accountPermissions/{id}",
- "httpMethod": "GET",
- "description": "Gets one account permission by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Account permission ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "AccountPermission"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.accountPermissions.list",
- "path": "userprofiles/{profileId}/accountPermissions",
- "httpMethod": "GET",
- "description": "Retrieves the list of account permissions.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "AccountPermissionsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "accountUserProfiles": {
- "methods": {
- "get": {
- "id": "dfareporting.accountUserProfiles.get",
- "path": "userprofiles/{profileId}/accountUserProfiles/{id}",
- "httpMethod": "GET",
- "description": "Gets one account user profile by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "User profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "AccountUserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.accountUserProfiles.insert",
- "path": "userprofiles/{profileId}/accountUserProfiles",
- "httpMethod": "POST",
- "description": "Inserts a new account user profile.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "AccountUserProfile"
- },
- "response": {
- "$ref": "AccountUserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.accountUserProfiles.list",
- "path": "userprofiles/{profileId}/accountUserProfiles",
- "httpMethod": "GET",
- "description": "Retrieves a list of account user profiles, possibly filtered.",
- "parameters": {
- "active": {
- "type": "boolean",
- "description": "Select only active user profiles.",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only user profiles with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, \"user profile*2015\" will return objects with names like \"user profile June 2015\", \"user profile April 2015\", or simply \"user profile 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"user profile\" will match objects with name \"my user profile\", \"user profile 2015\", or simply \"user profile\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "subaccountId": {
- "type": "string",
- "description": "Select only user profiles with the specified subaccount ID.",
- "format": "int64",
- "location": "query"
- },
- "userRoleId": {
- "type": "string",
- "description": "Select only user profiles with the specified user role ID.",
- "format": "int64",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "AccountUserProfilesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.accountUserProfiles.patch",
- "path": "userprofiles/{profileId}/accountUserProfiles",
- "httpMethod": "PATCH",
- "description": "Updates an existing account user profile. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "User profile ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "AccountUserProfile"
- },
- "response": {
- "$ref": "AccountUserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.accountUserProfiles.update",
- "path": "userprofiles/{profileId}/accountUserProfiles",
- "httpMethod": "PUT",
- "description": "Updates an existing account user profile.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "AccountUserProfile"
- },
- "response": {
- "$ref": "AccountUserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "accounts": {
- "methods": {
- "get": {
- "id": "dfareporting.accounts.get",
- "path": "userprofiles/{profileId}/accounts/{id}",
- "httpMethod": "GET",
- "description": "Gets one account by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Account ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.accounts.list",
- "path": "userprofiles/{profileId}/accounts",
- "httpMethod": "GET",
- "description": "Retrieves the list of accounts, possibly filtered.",
- "parameters": {
- "active": {
- "type": "boolean",
- "description": "Select only active accounts. Don't set this field to select both active and non-active accounts.",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only accounts with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"account*2015\" will return objects with names like \"account June 2015\", \"account April 2015\", or simply \"account 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"account\" will match objects with name \"my account\", \"account 2015\", or simply \"account\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "AccountsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.accounts.patch",
- "path": "userprofiles/{profileId}/accounts",
- "httpMethod": "PATCH",
- "description": "Updates an existing account. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Account ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.accounts.update",
- "path": "userprofiles/{profileId}/accounts",
- "httpMethod": "PUT",
- "description": "Updates an existing account.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "ads": {
- "methods": {
- "get": {
- "id": "dfareporting.ads.get",
- "path": "userprofiles/{profileId}/ads/{id}",
- "httpMethod": "GET",
- "description": "Gets one ad by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Ad ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Ad"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.ads.insert",
- "path": "userprofiles/{profileId}/ads",
- "httpMethod": "POST",
- "description": "Inserts a new ad.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Ad"
- },
- "response": {
- "$ref": "Ad"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.ads.list",
- "path": "userprofiles/{profileId}/ads",
- "httpMethod": "GET",
- "description": "Retrieves a list of ads, possibly filtered.",
- "parameters": {
- "active": {
- "type": "boolean",
- "description": "Select only active ads.",
- "location": "query"
- },
- "advertiserId": {
- "type": "string",
- "description": "Select only ads with this advertiser ID.",
- "format": "int64",
- "location": "query"
- },
- "archived": {
- "type": "boolean",
- "description": "Select only archived ads.",
- "location": "query"
- },
- "audienceSegmentIds": {
- "type": "string",
- "description": "Select only ads with these audience segment IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "campaignIds": {
- "type": "string",
- "description": "Select only ads with these campaign IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "compatibility": {
- "type": "string",
- "description": "Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.",
- "enum": [
- "APP",
- "APP_INTERSTITIAL",
- "IN_STREAM_VIDEO",
- "WEB",
- "WEB_INTERSTITIAL"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query"
- },
- "creativeIds": {
- "type": "string",
- "description": "Select only ads with these creative IDs assigned.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "creativeOptimizationConfigurationIds": {
- "type": "string",
- "description": "Select only ads with these creative optimization configuration IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "creativeType": {
- "type": "string",
- "description": "Select only ads with the specified creativeType.",
- "enum": [
- "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO",
- "CUSTOM_INPAGE",
- "CUSTOM_INTERSTITIAL",
- "ENHANCED_BANNER",
- "ENHANCED_IMAGE",
- "FLASH_INPAGE",
- "HTML5_BANNER",
- "IMAGE",
- "INSTREAM_VIDEO",
- "INTERNAL_REDIRECT",
- "INTERSTITIAL_INTERNAL_REDIRECT",
- "REDIRECT",
- "RICH_MEDIA_EXPANDING",
- "RICH_MEDIA_IM_EXPAND",
- "RICH_MEDIA_INPAGE",
- "RICH_MEDIA_INPAGE_FLOATING",
- "RICH_MEDIA_INTERSTITIAL_FLOAT",
- "RICH_MEDIA_MOBILE_IN_APP",
- "RICH_MEDIA_MULTI_FLOATING",
- "RICH_MEDIA_PEEL_DOWN",
- "TRACKING_TEXT",
- "VAST_REDIRECT",
- "VPAID_LINEAR",
- "VPAID_NON_LINEAR"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query"
- },
- "dynamicClickTracker": {
- "type": "boolean",
- "description": "Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only ads with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "landingPageIds": {
- "type": "string",
- "description": "Select only ads with these landing page IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "overriddenEventTagId": {
- "type": "string",
- "description": "Select only ads with this event tag override ID.",
- "format": "int64",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "placementIds": {
- "type": "string",
- "description": "Select only ads with these placement IDs assigned.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "remarketingListIds": {
- "type": "string",
- "description": "Select only ads whose list targeting expression use these remarketing list IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"ad*2015\" will return objects with names like \"ad June 2015\", \"ad April 2015\", or simply \"ad 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"ad\" will match objects with name \"my ad\", \"ad 2015\", or simply \"ad\".",
- "location": "query"
- },
- "sizeIds": {
- "type": "string",
- "description": "Select only ads with these size IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sslCompliant": {
- "type": "boolean",
- "description": "Select only ads that are SSL-compliant.",
- "location": "query"
- },
- "sslRequired": {
- "type": "boolean",
- "description": "Select only ads that require SSL.",
- "location": "query"
- },
- "type": {
- "type": "string",
- "description": "Select only ads with these types.",
- "enum": [
- "AD_SERVING_CLICK_TRACKER",
- "AD_SERVING_DEFAULT_AD",
- "AD_SERVING_STANDARD_AD",
- "AD_SERVING_TRACKING"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "AdsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.ads.patch",
- "path": "userprofiles/{profileId}/ads",
- "httpMethod": "PATCH",
- "description": "Updates an existing ad. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Ad ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "Ad"
- },
- "response": {
- "$ref": "Ad"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.ads.update",
- "path": "userprofiles/{profileId}/ads",
- "httpMethod": "PUT",
- "description": "Updates an existing ad.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Ad"
- },
- "response": {
- "$ref": "Ad"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "advertiserGroups": {
- "methods": {
- "delete": {
- "id": "dfareporting.advertiserGroups.delete",
- "path": "userprofiles/{profileId}/advertiserGroups/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing advertiser group.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Advertiser group ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.advertiserGroups.get",
- "path": "userprofiles/{profileId}/advertiserGroups/{id}",
- "httpMethod": "GET",
- "description": "Gets one advertiser group by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Advertiser group ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "AdvertiserGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.advertiserGroups.insert",
- "path": "userprofiles/{profileId}/advertiserGroups",
- "httpMethod": "POST",
- "description": "Inserts a new advertiser group.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "AdvertiserGroup"
- },
- "response": {
- "$ref": "AdvertiserGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.advertiserGroups.list",
- "path": "userprofiles/{profileId}/advertiserGroups",
- "httpMethod": "GET",
- "description": "Retrieves a list of advertiser groups, possibly filtered.",
- "parameters": {
- "ids": {
- "type": "string",
- "description": "Select only advertiser groups with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"advertiser*2015\" will return objects with names like \"advertiser group June 2015\", \"advertiser group April 2015\", or simply \"advertiser group 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"advertisergroup\" will match objects with name \"my advertisergroup\", \"advertisergroup 2015\", or simply \"advertisergroup\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "AdvertiserGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.advertiserGroups.patch",
- "path": "userprofiles/{profileId}/advertiserGroups",
- "httpMethod": "PATCH",
- "description": "Updates an existing advertiser group. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Advertiser group ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "AdvertiserGroup"
- },
- "response": {
- "$ref": "AdvertiserGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.advertiserGroups.update",
- "path": "userprofiles/{profileId}/advertiserGroups",
- "httpMethod": "PUT",
- "description": "Updates an existing advertiser group.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "AdvertiserGroup"
- },
- "response": {
- "$ref": "AdvertiserGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "advertisers": {
- "methods": {
- "get": {
- "id": "dfareporting.advertisers.get",
- "path": "userprofiles/{profileId}/advertisers/{id}",
- "httpMethod": "GET",
- "description": "Gets one advertiser by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Advertiser ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Advertiser"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.advertisers.insert",
- "path": "userprofiles/{profileId}/advertisers",
- "httpMethod": "POST",
- "description": "Inserts a new advertiser.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Advertiser"
- },
- "response": {
- "$ref": "Advertiser"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.advertisers.list",
- "path": "userprofiles/{profileId}/advertisers",
- "httpMethod": "GET",
- "description": "Retrieves a list of advertisers, possibly filtered.",
- "parameters": {
- "advertiserGroupIds": {
- "type": "string",
- "description": "Select only advertisers with these advertiser group IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "floodlightConfigurationIds": {
- "type": "string",
- "description": "Select only advertisers with these floodlight configuration IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only advertisers with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "includeAdvertisersWithoutGroupsOnly": {
- "type": "boolean",
- "description": "Select only advertisers which do not belong to any advertiser group.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "onlyParent": {
- "type": "boolean",
- "description": "Select only advertisers which use another advertiser's floodlight configuration.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"advertiser*2015\" will return objects with names like \"advertiser June 2015\", \"advertiser April 2015\", or simply \"advertiser 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"advertiser\" will match objects with name \"my advertiser\", \"advertiser 2015\", or simply \"advertiser\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "status": {
- "type": "string",
- "description": "Select only advertisers with the specified status.",
- "enum": [
- "APPROVED",
- "ON_HOLD"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "subaccountId": {
- "type": "string",
- "description": "Select only advertisers with these subaccount IDs.",
- "format": "int64",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "AdvertisersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.advertisers.patch",
- "path": "userprofiles/{profileId}/advertisers",
- "httpMethod": "PATCH",
- "description": "Updates an existing advertiser. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Advertiser ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "Advertiser"
- },
- "response": {
- "$ref": "Advertiser"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.advertisers.update",
- "path": "userprofiles/{profileId}/advertisers",
- "httpMethod": "PUT",
- "description": "Updates an existing advertiser.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Advertiser"
- },
- "response": {
- "$ref": "Advertiser"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "browsers": {
- "methods": {
- "list": {
- "id": "dfareporting.browsers.list",
- "path": "userprofiles/{profileId}/browsers",
- "httpMethod": "GET",
- "description": "Retrieves a list of browsers.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "BrowsersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "campaignCreativeAssociations": {
- "methods": {
- "insert": {
- "id": "dfareporting.campaignCreativeAssociations.insert",
- "path": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
- "httpMethod": "POST",
- "description": "Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.",
- "parameters": {
- "campaignId": {
- "type": "string",
- "description": "Campaign ID in this association.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "campaignId"
- ],
- "request": {
- "$ref": "CampaignCreativeAssociation"
- },
- "response": {
- "$ref": "CampaignCreativeAssociation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.campaignCreativeAssociations.list",
- "path": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
- "httpMethod": "GET",
- "description": "Retrieves the list of creative IDs associated with the specified campaign.",
- "parameters": {
- "campaignId": {
- "type": "string",
- "description": "Campaign ID in this association.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "campaignId"
- ],
- "response": {
- "$ref": "CampaignCreativeAssociationsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "campaigns": {
- "methods": {
- "get": {
- "id": "dfareporting.campaigns.get",
- "path": "userprofiles/{profileId}/campaigns/{id}",
- "httpMethod": "GET",
- "description": "Gets one campaign by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Campaign ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Campaign"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.campaigns.insert",
- "path": "userprofiles/{profileId}/campaigns",
- "httpMethod": "POST",
- "description": "Inserts a new campaign.",
- "parameters": {
- "defaultLandingPageName": {
- "type": "string",
- "description": "Default landing page name for this new campaign. Must be less than 256 characters long.",
- "required": true,
- "location": "query"
- },
- "defaultLandingPageUrl": {
- "type": "string",
- "description": "Default landing page URL for this new campaign.",
- "required": true,
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "defaultLandingPageName",
- "defaultLandingPageUrl"
- ],
- "request": {
- "$ref": "Campaign"
- },
- "response": {
- "$ref": "Campaign"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.campaigns.list",
- "path": "userprofiles/{profileId}/campaigns",
- "httpMethod": "GET",
- "description": "Retrieves a list of campaigns, possibly filtered.",
- "parameters": {
- "advertiserGroupIds": {
- "type": "string",
- "description": "Select only campaigns whose advertisers belong to these advertiser groups.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "advertiserIds": {
- "type": "string",
- "description": "Select only campaigns that belong to these advertisers.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "archived": {
- "type": "boolean",
- "description": "Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.",
- "location": "query"
- },
- "atLeastOneOptimizationActivity": {
- "type": "boolean",
- "description": "Select only campaigns that have at least one optimization activity.",
- "location": "query"
- },
- "excludedIds": {
- "type": "string",
- "description": "Exclude campaigns with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only campaigns with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "overriddenEventTagId": {
- "type": "string",
- "description": "Select only campaigns that have overridden this event tag ID.",
- "format": "int64",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, \"campaign*2015\" will return campaigns with names like \"campaign June 2015\", \"campaign April 2015\", or simply \"campaign 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"campaign\" will match campaigns with name \"my campaign\", \"campaign 2015\", or simply \"campaign\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "subaccountId": {
- "type": "string",
- "description": "Select only campaigns that belong to this subaccount.",
- "format": "int64",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "CampaignsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.campaigns.patch",
- "path": "userprofiles/{profileId}/campaigns",
- "httpMethod": "PATCH",
- "description": "Updates an existing campaign. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Campaign ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "Campaign"
- },
- "response": {
- "$ref": "Campaign"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.campaigns.update",
- "path": "userprofiles/{profileId}/campaigns",
- "httpMethod": "PUT",
- "description": "Updates an existing campaign.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Campaign"
- },
- "response": {
- "$ref": "Campaign"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "changeLogs": {
- "methods": {
- "get": {
- "id": "dfareporting.changeLogs.get",
- "path": "userprofiles/{profileId}/changeLogs/{id}",
- "httpMethod": "GET",
- "description": "Gets one change log by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Change log ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "ChangeLog"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.changeLogs.list",
- "path": "userprofiles/{profileId}/changeLogs",
- "httpMethod": "GET",
- "description": "Retrieves a list of change logs.",
- "parameters": {
- "action": {
- "type": "string",
- "description": "Select only change logs with the specified action.",
- "enum": [
- "ACTION_ADD",
- "ACTION_ASSIGN",
- "ACTION_ASSOCIATE",
- "ACTION_CREATE",
- "ACTION_DELETE",
- "ACTION_DISABLE",
- "ACTION_EMAIL_TAGS",
- "ACTION_ENABLE",
- "ACTION_LINK",
- "ACTION_MARK_AS_DEFAULT",
- "ACTION_PUSH",
- "ACTION_REMOVE",
- "ACTION_SEND",
- "ACTION_SHARE",
- "ACTION_UNASSIGN",
- "ACTION_UNLINK",
- "ACTION_UPDATE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only change logs with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxChangeTime": {
- "type": "string",
- "description": "Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is \"2015-07-18T22:54:00-04:00\". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "minChangeTime": {
- "type": "string",
- "description": "Select only change logs whose change time is before the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is \"2015-07-18T22:54:00-04:00\". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.",
- "location": "query"
- },
- "objectIds": {
- "type": "string",
- "description": "Select only change logs with these object IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "objectType": {
- "type": "string",
- "description": "Select only change logs with the specified object type.",
- "enum": [
- "OBJECT_ACCOUNT",
- "OBJECT_ACCOUNT_BILLING_FEATURE",
- "OBJECT_AD",
- "OBJECT_ADVERTISER",
- "OBJECT_ADVERTISER_GROUP",
- "OBJECT_BILLING_ACCOUNT_GROUP",
- "OBJECT_BILLING_FEATURE",
- "OBJECT_BILLING_MINIMUM_FEE",
- "OBJECT_BILLING_PROFILE",
- "OBJECT_CAMPAIGN",
- "OBJECT_CONTENT_CATEGORY",
- "OBJECT_CREATIVE",
- "OBJECT_CREATIVE_ASSET",
- "OBJECT_CREATIVE_BUNDLE",
- "OBJECT_CREATIVE_FIELD",
- "OBJECT_CREATIVE_GROUP",
- "OBJECT_DFA_SITE",
- "OBJECT_EVENT_TAG",
- "OBJECT_FLOODLIGHT_ACTIVITY_GROUP",
- "OBJECT_FLOODLIGHT_ACTVITY",
- "OBJECT_FLOODLIGHT_CONFIGURATION",
- "OBJECT_INSTREAM_CREATIVE",
- "OBJECT_LANDING_PAGE",
- "OBJECT_MEDIA_ORDER",
- "OBJECT_PLACEMENT",
- "OBJECT_PLACEMENT_STRATEGY",
- "OBJECT_PROVIDED_LIST_CLIENT",
- "OBJECT_RATE_CARD",
- "OBJECT_REMARKETING_LIST",
- "OBJECT_RICHMEDIA_CREATIVE",
- "OBJECT_SD_SITE",
- "OBJECT_SIZE",
- "OBJECT_SUBACCOUNT",
- "OBJECT_USER_PROFILE",
- "OBJECT_USER_PROFILE_FILTER",
- "OBJECT_USER_ROLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Select only change logs whose object ID, user name, old or new values match the search string.",
- "location": "query"
- },
- "userProfileIds": {
- "type": "string",
- "description": "Select only change logs with these user profile IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "ChangeLogsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "cities": {
- "methods": {
- "list": {
- "id": "dfareporting.cities.list",
- "path": "userprofiles/{profileId}/cities",
- "httpMethod": "GET",
- "description": "Retrieves a list of cities, possibly filtered.",
- "parameters": {
- "countryDartIds": {
- "type": "string",
- "description": "Select only cities from these countries.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "dartIds": {
- "type": "string",
- "description": "Select only cities with these DART IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "namePrefix": {
- "type": "string",
- "description": "Select only cities with names starting with this prefix.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "regionDartIds": {
- "type": "string",
- "description": "Select only cities from these regions.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "CitiesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "connectionTypes": {
- "methods": {
- "get": {
- "id": "dfareporting.connectionTypes.get",
- "path": "userprofiles/{profileId}/connectionTypes/{id}",
- "httpMethod": "GET",
- "description": "Gets one connection type by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Connection type ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "ConnectionType"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.connectionTypes.list",
- "path": "userprofiles/{profileId}/connectionTypes",
- "httpMethod": "GET",
- "description": "Retrieves a list of connection types.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "ConnectionTypesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "contentCategories": {
- "methods": {
- "delete": {
- "id": "dfareporting.contentCategories.delete",
- "path": "userprofiles/{profileId}/contentCategories/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing content category.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Content category ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.contentCategories.get",
- "path": "userprofiles/{profileId}/contentCategories/{id}",
- "httpMethod": "GET",
- "description": "Gets one content category by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Content category ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "ContentCategory"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.contentCategories.insert",
- "path": "userprofiles/{profileId}/contentCategories",
- "httpMethod": "POST",
- "description": "Inserts a new content category.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "ContentCategory"
- },
- "response": {
- "$ref": "ContentCategory"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.contentCategories.list",
- "path": "userprofiles/{profileId}/contentCategories",
- "httpMethod": "GET",
- "description": "Retrieves a list of content categories, possibly filtered.",
- "parameters": {
- "ids": {
- "type": "string",
- "description": "Select only content categories with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"contentcategory*2015\" will return objects with names like \"contentcategory June 2015\", \"contentcategory April 2015\", or simply \"contentcategory 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"contentcategory\" will match objects with name \"my contentcategory\", \"contentcategory 2015\", or simply \"contentcategory\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "ContentCategoriesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.contentCategories.patch",
- "path": "userprofiles/{profileId}/contentCategories",
- "httpMethod": "PATCH",
- "description": "Updates an existing content category. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Content category ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "ContentCategory"
- },
- "response": {
- "$ref": "ContentCategory"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.contentCategories.update",
- "path": "userprofiles/{profileId}/contentCategories",
- "httpMethod": "PUT",
- "description": "Updates an existing content category.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "ContentCategory"
- },
- "response": {
- "$ref": "ContentCategory"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "countries": {
- "methods": {
- "get": {
- "id": "dfareporting.countries.get",
- "path": "userprofiles/{profileId}/countries/{dartId}",
- "httpMethod": "GET",
- "description": "Gets one country by ID.",
- "parameters": {
- "dartId": {
- "type": "string",
- "description": "Country DART ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "dartId"
- ],
- "response": {
- "$ref": "Country"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.countries.list",
- "path": "userprofiles/{profileId}/countries",
- "httpMethod": "GET",
- "description": "Retrieves a list of countries.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "CountriesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "creativeAssets": {
- "methods": {
- "insert": {
- "id": "dfareporting.creativeAssets.insert",
- "path": "userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets",
- "httpMethod": "POST",
- "description": "Inserts a new creative asset.",
- "parameters": {
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this creative. This is a required field.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "advertiserId"
- ],
- "request": {
- "$ref": "CreativeAssetMetadata"
- },
- "response": {
- "$ref": "CreativeAssetMetadata"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ],
- "supportsMediaUpload": true,
- "mediaUpload": {
- "accept": [
- "*/*"
- ],
- "maxSize": "100MB",
- "protocols": {
- "simple": {
- "multipart": true,
- "path": "/upload/dfareporting/v2.1/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets"
- },
- "resumable": {
- "multipart": true,
- "path": "/resumable/upload/dfareporting/v2.1/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets"
- }
- }
- }
- }
- }
- },
- "creativeFieldValues": {
- "methods": {
- "delete": {
- "id": "dfareporting.creativeFieldValues.delete",
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing creative field value.",
- "parameters": {
- "creativeFieldId": {
- "type": "string",
- "description": "Creative field ID for this creative field value.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "id": {
- "type": "string",
- "description": "Creative Field Value ID",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "creativeFieldId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.creativeFieldValues.get",
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
- "httpMethod": "GET",
- "description": "Gets one creative field value by ID.",
- "parameters": {
- "creativeFieldId": {
- "type": "string",
- "description": "Creative field ID for this creative field value.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "id": {
- "type": "string",
- "description": "Creative Field Value ID",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "creativeFieldId",
- "id"
- ],
- "response": {
- "$ref": "CreativeFieldValue"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.creativeFieldValues.insert",
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- "httpMethod": "POST",
- "description": "Inserts a new creative field value.",
- "parameters": {
- "creativeFieldId": {
- "type": "string",
- "description": "Creative field ID for this creative field value.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "creativeFieldId"
- ],
- "request": {
- "$ref": "CreativeFieldValue"
- },
- "response": {
- "$ref": "CreativeFieldValue"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.creativeFieldValues.list",
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- "httpMethod": "GET",
- "description": "Retrieves a list of creative field values, possibly filtered.",
- "parameters": {
- "creativeFieldId": {
- "type": "string",
- "description": "Creative field ID for this creative field value.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "ids": {
- "type": "string",
- "description": "Select only creative field values with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "VALUE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "creativeFieldId"
- ],
- "response": {
- "$ref": "CreativeFieldValuesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.creativeFieldValues.patch",
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- "httpMethod": "PATCH",
- "description": "Updates an existing creative field value. This method supports patch semantics.",
- "parameters": {
- "creativeFieldId": {
- "type": "string",
- "description": "Creative field ID for this creative field value.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "id": {
- "type": "string",
- "description": "Creative Field Value ID",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "creativeFieldId",
- "id"
- ],
- "request": {
- "$ref": "CreativeFieldValue"
- },
- "response": {
- "$ref": "CreativeFieldValue"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.creativeFieldValues.update",
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- "httpMethod": "PUT",
- "description": "Updates an existing creative field value.",
- "parameters": {
- "creativeFieldId": {
- "type": "string",
- "description": "Creative field ID for this creative field value.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "creativeFieldId"
- ],
- "request": {
- "$ref": "CreativeFieldValue"
- },
- "response": {
- "$ref": "CreativeFieldValue"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "creativeFields": {
- "methods": {
- "delete": {
- "id": "dfareporting.creativeFields.delete",
- "path": "userprofiles/{profileId}/creativeFields/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing creative field.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Creative Field ID",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.creativeFields.get",
- "path": "userprofiles/{profileId}/creativeFields/{id}",
- "httpMethod": "GET",
- "description": "Gets one creative field by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Creative Field ID",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "CreativeField"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.creativeFields.insert",
- "path": "userprofiles/{profileId}/creativeFields",
- "httpMethod": "POST",
- "description": "Inserts a new creative field.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "CreativeField"
- },
- "response": {
- "$ref": "CreativeField"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.creativeFields.list",
- "path": "userprofiles/{profileId}/creativeFields",
- "httpMethod": "GET",
- "description": "Retrieves a list of creative fields, possibly filtered.",
- "parameters": {
- "advertiserIds": {
- "type": "string",
- "description": "Select only creative fields that belong to these advertisers.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only creative fields with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, \"creativefield*2015\" will return creative fields with names like \"creativefield June 2015\", \"creativefield April 2015\", or simply \"creativefield 2015\". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of \"creativefield\" will match creative fields with the name \"my creativefield\", \"creativefield 2015\", or simply \"creativefield\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "CreativeFieldsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.creativeFields.patch",
- "path": "userprofiles/{profileId}/creativeFields",
- "httpMethod": "PATCH",
- "description": "Updates an existing creative field. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Creative Field ID",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "CreativeField"
- },
- "response": {
- "$ref": "CreativeField"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.creativeFields.update",
- "path": "userprofiles/{profileId}/creativeFields",
- "httpMethod": "PUT",
- "description": "Updates an existing creative field.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "CreativeField"
- },
- "response": {
- "$ref": "CreativeField"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "creativeGroups": {
- "methods": {
- "get": {
- "id": "dfareporting.creativeGroups.get",
- "path": "userprofiles/{profileId}/creativeGroups/{id}",
- "httpMethod": "GET",
- "description": "Gets one creative group by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Creative group ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "CreativeGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.creativeGroups.insert",
- "path": "userprofiles/{profileId}/creativeGroups",
- "httpMethod": "POST",
- "description": "Inserts a new creative group.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "CreativeGroup"
- },
- "response": {
- "$ref": "CreativeGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.creativeGroups.list",
- "path": "userprofiles/{profileId}/creativeGroups",
- "httpMethod": "GET",
- "description": "Retrieves a list of creative groups, possibly filtered.",
- "parameters": {
- "advertiserIds": {
- "type": "string",
- "description": "Select only creative groups that belong to these advertisers.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "groupNumber": {
- "type": "integer",
- "description": "Select only creative groups that belong to this subgroup.",
- "format": "int32",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only creative groups with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, \"creativegroup*2015\" will return creative groups with names like \"creativegroup June 2015\", \"creativegroup April 2015\", or simply \"creativegroup 2015\". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of \"creativegroup\" will match creative groups with the name \"my creativegroup\", \"creativegroup 2015\", or simply \"creativegroup\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "CreativeGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.creativeGroups.patch",
- "path": "userprofiles/{profileId}/creativeGroups",
- "httpMethod": "PATCH",
- "description": "Updates an existing creative group. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Creative group ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "CreativeGroup"
- },
- "response": {
- "$ref": "CreativeGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.creativeGroups.update",
- "path": "userprofiles/{profileId}/creativeGroups",
- "httpMethod": "PUT",
- "description": "Updates an existing creative group.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "CreativeGroup"
- },
- "response": {
- "$ref": "CreativeGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "creatives": {
- "methods": {
- "get": {
- "id": "dfareporting.creatives.get",
- "path": "userprofiles/{profileId}/creatives/{id}",
- "httpMethod": "GET",
- "description": "Gets one creative by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Creative ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.creatives.insert",
- "path": "userprofiles/{profileId}/creatives",
- "httpMethod": "POST",
- "description": "Inserts a new creative.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.creatives.list",
- "path": "userprofiles/{profileId}/creatives",
- "httpMethod": "GET",
- "description": "Retrieves a list of creatives, possibly filtered.",
- "parameters": {
- "active": {
- "type": "boolean",
- "description": "Select only active creatives. Leave blank to select active and inactive creatives.",
- "location": "query"
- },
- "advertiserId": {
- "type": "string",
- "description": "Select only creatives with this advertiser ID.",
- "format": "int64",
- "location": "query"
- },
- "archived": {
- "type": "boolean",
- "description": "Select only archived creatives. Leave blank to select archived and unarchived creatives.",
- "location": "query"
- },
- "campaignId": {
- "type": "string",
- "description": "Select only creatives with this campaign ID.",
- "format": "int64",
- "location": "query"
- },
- "companionCreativeIds": {
- "type": "string",
- "description": "Select only in-stream video creatives with these companion IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "creativeFieldIds": {
- "type": "string",
- "description": "Select only creatives with these creative field IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only creatives with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "renderingIds": {
- "type": "string",
- "description": "Select only creatives with these rendering IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"creative*2015\" will return objects with names like \"creative June 2015\", \"creative April 2015\", or simply \"creative 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"creative\" will match objects with name \"my creative\", \"creative 2015\", or simply \"creative\".",
- "location": "query"
- },
- "sizeIds": {
- "type": "string",
- "description": "Select only creatives with these size IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "studioCreativeId": {
- "type": "string",
- "description": "Select only creatives corresponding to this Studio creative ID.",
- "format": "int64",
- "location": "query"
- },
- "types": {
- "type": "string",
- "description": "Select only creatives with these creative types.",
- "enum": [
- "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO",
- "CUSTOM_INPAGE",
- "CUSTOM_INTERSTITIAL",
- "ENHANCED_BANNER",
- "ENHANCED_IMAGE",
- "FLASH_INPAGE",
- "HTML5_BANNER",
- "IMAGE",
- "INSTREAM_VIDEO",
- "INTERNAL_REDIRECT",
- "INTERSTITIAL_INTERNAL_REDIRECT",
- "REDIRECT",
- "RICH_MEDIA_EXPANDING",
- "RICH_MEDIA_IM_EXPAND",
- "RICH_MEDIA_INPAGE",
- "RICH_MEDIA_INPAGE_FLOATING",
- "RICH_MEDIA_INTERSTITIAL_FLOAT",
- "RICH_MEDIA_MOBILE_IN_APP",
- "RICH_MEDIA_MULTI_FLOATING",
- "RICH_MEDIA_PEEL_DOWN",
- "TRACKING_TEXT",
- "VAST_REDIRECT",
- "VPAID_LINEAR",
- "VPAID_NON_LINEAR"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "CreativesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.creatives.patch",
- "path": "userprofiles/{profileId}/creatives",
- "httpMethod": "PATCH",
- "description": "Updates an existing creative. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Creative ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.creatives.update",
- "path": "userprofiles/{profileId}/creatives",
- "httpMethod": "PUT",
- "description": "Updates an existing creative.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "dimensionValues": {
- "methods": {
- "query": {
- "id": "dfareporting.dimensionValues.query",
- "path": "userprofiles/{profileId}/dimensionvalues/query",
- "httpMethod": "POST",
- "description": "Retrieves list of report dimension values for a list of filters.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "DimensionValueRequest"
- },
- "response": {
- "$ref": "DimensionValueList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- },
- "directorySiteContacts": {
- "methods": {
- "get": {
- "id": "dfareporting.directorySiteContacts.get",
- "path": "userprofiles/{profileId}/directorySiteContacts/{id}",
- "httpMethod": "GET",
- "description": "Gets one directory site contact by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Directory site contact ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "DirectorySiteContact"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.directorySiteContacts.list",
- "path": "userprofiles/{profileId}/directorySiteContacts",
- "httpMethod": "GET",
- "description": "Retrieves a list of directory site contacts, possibly filtered.",
- "parameters": {
- "directorySiteIds": {
- "type": "string",
- "description": "Select only directory site contacts with these directory site IDs. This is a required field.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only directory site contacts with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, \"directory site contact*2015\" will return objects with names like \"directory site contact June 2015\", \"directory site contact April 2015\", or simply \"directory site contact 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"directory site contact\" will match objects with name \"my directory site contact\", \"directory site contact 2015\", or simply \"directory site contact\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "DirectorySiteContactsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "directorySites": {
- "methods": {
- "get": {
- "id": "dfareporting.directorySites.get",
- "path": "userprofiles/{profileId}/directorySites/{id}",
- "httpMethod": "GET",
- "description": "Gets one directory site by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Directory site ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "DirectorySite"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.directorySites.insert",
- "path": "userprofiles/{profileId}/directorySites",
- "httpMethod": "POST",
- "description": "Inserts a new directory site.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "DirectorySite"
- },
- "response": {
- "$ref": "DirectorySite"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.directorySites.list",
- "path": "userprofiles/{profileId}/directorySites",
- "httpMethod": "GET",
- "description": "Retrieves a list of directory sites, possibly filtered.",
- "parameters": {
- "acceptsInStreamVideoPlacements": {
- "type": "boolean",
- "description": "This search filter is no longer supported and will have no effect on the results returned.",
- "location": "query"
- },
- "acceptsInterstitialPlacements": {
- "type": "boolean",
- "description": "This search filter is no longer supported and will have no effect on the results returned.",
- "location": "query"
- },
- "acceptsPublisherPaidPlacements": {
- "type": "boolean",
- "description": "Select only directory sites that accept publisher paid placements. This field can be left blank.",
- "location": "query"
- },
- "active": {
- "type": "boolean",
- "description": "Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.",
- "location": "query"
- },
- "countryId": {
- "type": "string",
- "description": "Select only directory sites with this country ID.",
- "format": "int64",
- "location": "query"
- },
- "dfp_network_code": {
- "type": "string",
- "description": "Select only directory sites with this DFP network code.",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only directory sites with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "parentId": {
- "type": "string",
- "description": "Select only directory sites with this parent ID.",
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, \"directory site*2015\" will return objects with names like \"directory site June 2015\", \"directory site April 2015\", or simply \"directory site 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"directory site\" will match objects with name \"my directory site\", \"directory site 2015\" or simply, \"directory site\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "DirectorySitesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "eventTags": {
- "methods": {
- "delete": {
- "id": "dfareporting.eventTags.delete",
- "path": "userprofiles/{profileId}/eventTags/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing event tag.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Event tag ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.eventTags.get",
- "path": "userprofiles/{profileId}/eventTags/{id}",
- "httpMethod": "GET",
- "description": "Gets one event tag by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Event tag ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "EventTag"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.eventTags.insert",
- "path": "userprofiles/{profileId}/eventTags",
- "httpMethod": "POST",
- "description": "Inserts a new event tag.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "EventTag"
- },
- "response": {
- "$ref": "EventTag"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.eventTags.list",
- "path": "userprofiles/{profileId}/eventTags",
- "httpMethod": "GET",
- "description": "Retrieves a list of event tags, possibly filtered.",
- "parameters": {
- "adId": {
- "type": "string",
- "description": "Select only event tags that belong to this ad.",
- "format": "int64",
- "location": "query"
- },
- "advertiserId": {
- "type": "string",
- "description": "Select only event tags that belong to this advertiser.",
- "format": "int64",
- "location": "query"
- },
- "campaignId": {
- "type": "string",
- "description": "Select only event tags that belong to this campaign.",
- "format": "int64",
- "location": "query"
- },
- "definitionsOnly": {
- "type": "boolean",
- "description": "Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.",
- "location": "query"
- },
- "enabled": {
- "type": "boolean",
- "description": "Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.",
- "location": "query"
- },
- "eventTagTypes": {
- "type": "string",
- "description": "Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking.",
- "enum": [
- "CLICK_THROUGH_EVENT_TAG",
- "IMPRESSION_IMAGE_EVENT_TAG",
- "IMPRESSION_JAVASCRIPT_EVENT_TAG"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only event tags with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"eventtag*2015\" will return objects with names like \"eventtag June 2015\", \"eventtag April 2015\", or simply \"eventtag 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"eventtag\" will match objects with name \"my eventtag\", \"eventtag 2015\", or simply \"eventtag\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "EventTagsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.eventTags.patch",
- "path": "userprofiles/{profileId}/eventTags",
- "httpMethod": "PATCH",
- "description": "Updates an existing event tag. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Event tag ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "EventTag"
- },
- "response": {
- "$ref": "EventTag"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.eventTags.update",
- "path": "userprofiles/{profileId}/eventTags",
- "httpMethod": "PUT",
- "description": "Updates an existing event tag.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "EventTag"
- },
- "response": {
- "$ref": "EventTag"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "files": {
- "methods": {
- "get": {
- "id": "dfareporting.files.get",
- "path": "reports/{reportId}/files/{fileId}",
- "httpMethod": "GET",
- "description": "Retrieves a report file by its report ID and file ID.",
- "parameters": {
- "fileId": {
- "type": "string",
- "description": "The ID of the report file.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "reportId",
- "fileId"
- ],
- "response": {
- "$ref": "File"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ],
- "supportsMediaDownload": true
- },
- "list": {
- "id": "dfareporting.files.list",
- "path": "userprofiles/{profileId}/files",
- "httpMethod": "GET",
- "description": "Lists files for a user profile.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "scope": {
- "type": "string",
- "description": "The scope that defines which results are returned, default is 'MINE'.",
- "default": "MINE",
- "enum": [
- "ALL",
- "MINE",
- "SHARED_WITH_ME"
- ],
- "enumDescriptions": [
- "All files in account.",
- "My files.",
- "Files shared with me."
- ],
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "The field by which to sort the list.",
- "default": "LAST_MODIFIED_TIME",
- "enum": [
- "ID",
- "LAST_MODIFIED_TIME"
- ],
- "enumDescriptions": [
- "Sort by file ID.",
- "Sort by 'lastmodifiedAt' field."
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is 'DESCENDING'.",
- "default": "DESCENDING",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "FileList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- },
- "floodlightActivities": {
- "methods": {
- "delete": {
- "id": "dfareporting.floodlightActivities.delete",
- "path": "userprofiles/{profileId}/floodlightActivities/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing floodlight activity.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Floodlight activity ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "generatetag": {
- "id": "dfareporting.floodlightActivities.generatetag",
- "path": "userprofiles/{profileId}/floodlightActivities/generatetag",
- "httpMethod": "POST",
- "description": "Generates a tag for a floodlight activity.",
- "parameters": {
- "floodlightActivityId": {
- "type": "string",
- "description": "Floodlight activity ID for which we want to generate a tag.",
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "FloodlightActivitiesGenerateTagResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.floodlightActivities.get",
- "path": "userprofiles/{profileId}/floodlightActivities/{id}",
- "httpMethod": "GET",
- "description": "Gets one floodlight activity by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Floodlight activity ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "FloodlightActivity"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.floodlightActivities.insert",
- "path": "userprofiles/{profileId}/floodlightActivities",
- "httpMethod": "POST",
- "description": "Inserts a new floodlight activity.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "FloodlightActivity"
- },
- "response": {
- "$ref": "FloodlightActivity"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.floodlightActivities.list",
- "path": "userprofiles/{profileId}/floodlightActivities",
- "httpMethod": "GET",
- "description": "Retrieves a list of floodlight activities, possibly filtered.",
- "parameters": {
- "advertiserId": {
- "type": "string",
- "description": "Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "location": "query"
- },
- "floodlightActivityGroupIds": {
- "type": "string",
- "description": "Select only floodlight activities with the specified floodlight activity group IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "floodlightActivityGroupName": {
- "type": "string",
- "description": "Select only floodlight activities with the specified floodlight activity group name.",
- "location": "query"
- },
- "floodlightActivityGroupTagString": {
- "type": "string",
- "description": "Select only floodlight activities with the specified floodlight activity group tag string.",
- "location": "query"
- },
- "floodlightActivityGroupType": {
- "type": "string",
- "description": "Select only floodlight activities with the specified floodlight activity group type.",
- "enum": [
- "COUNTER",
- "SALE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "floodlightConfigurationId": {
- "type": "string",
- "description": "Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"floodlightactivity*2015\" will return objects with names like \"floodlightactivity June 2015\", \"floodlightactivity April 2015\", or simply \"floodlightactivity 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"floodlightactivity\" will match objects with name \"my floodlightactivity activity\", \"floodlightactivity 2015\", or simply \"floodlightactivity\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "tagString": {
- "type": "string",
- "description": "Select only floodlight activities with the specified tag string.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "FloodlightActivitiesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.floodlightActivities.patch",
- "path": "userprofiles/{profileId}/floodlightActivities",
- "httpMethod": "PATCH",
- "description": "Updates an existing floodlight activity. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Floodlight activity ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "FloodlightActivity"
- },
- "response": {
- "$ref": "FloodlightActivity"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.floodlightActivities.update",
- "path": "userprofiles/{profileId}/floodlightActivities",
- "httpMethod": "PUT",
- "description": "Updates an existing floodlight activity.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "FloodlightActivity"
- },
- "response": {
- "$ref": "FloodlightActivity"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "floodlightActivityGroups": {
- "methods": {
- "delete": {
- "id": "dfareporting.floodlightActivityGroups.delete",
- "path": "userprofiles/{profileId}/floodlightActivityGroups/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing floodlight activity group.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Floodlight activity Group ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.floodlightActivityGroups.get",
- "path": "userprofiles/{profileId}/floodlightActivityGroups/{id}",
- "httpMethod": "GET",
- "description": "Gets one floodlight activity group by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Floodlight activity Group ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "FloodlightActivityGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.floodlightActivityGroups.insert",
- "path": "userprofiles/{profileId}/floodlightActivityGroups",
- "httpMethod": "POST",
- "description": "Inserts a new floodlight activity group.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "FloodlightActivityGroup"
- },
- "response": {
- "$ref": "FloodlightActivityGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.floodlightActivityGroups.list",
- "path": "userprofiles/{profileId}/floodlightActivityGroups",
- "httpMethod": "GET",
- "description": "Retrieves a list of floodlight activity groups, possibly filtered.",
- "parameters": {
- "advertiserId": {
- "type": "string",
- "description": "Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "location": "query"
- },
- "floodlightConfigurationId": {
- "type": "string",
- "description": "Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"floodlightactivitygroup*2015\" will return objects with names like \"floodlightactivitygroup June 2015\", \"floodlightactivitygroup April 2015\", or simply \"floodlightactivitygroup 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"floodlightactivitygroup\" will match objects with name \"my floodlightactivitygroup activity\", \"floodlightactivitygroup 2015\", or simply \"floodlightactivitygroup\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "type": {
- "type": "string",
- "description": "Select only floodlight activity groups with the specified floodlight activity group type.",
- "enum": [
- "COUNTER",
- "SALE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "FloodlightActivityGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.floodlightActivityGroups.patch",
- "path": "userprofiles/{profileId}/floodlightActivityGroups",
- "httpMethod": "PATCH",
- "description": "Updates an existing floodlight activity group. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Floodlight activity Group ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "FloodlightActivityGroup"
- },
- "response": {
- "$ref": "FloodlightActivityGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.floodlightActivityGroups.update",
- "path": "userprofiles/{profileId}/floodlightActivityGroups",
- "httpMethod": "PUT",
- "description": "Updates an existing floodlight activity group.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "FloodlightActivityGroup"
- },
- "response": {
- "$ref": "FloodlightActivityGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "floodlightConfigurations": {
- "methods": {
- "get": {
- "id": "dfareporting.floodlightConfigurations.get",
- "path": "userprofiles/{profileId}/floodlightConfigurations/{id}",
- "httpMethod": "GET",
- "description": "Gets one floodlight configuration by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Floodlight configuration ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "FloodlightConfiguration"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.floodlightConfigurations.list",
- "path": "userprofiles/{profileId}/floodlightConfigurations",
- "httpMethod": "GET",
- "description": "Retrieves a list of floodlight configurations, possibly filtered.",
- "parameters": {
- "ids": {
- "type": "string",
- "description": "Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "FloodlightConfigurationsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.floodlightConfigurations.patch",
- "path": "userprofiles/{profileId}/floodlightConfigurations",
- "httpMethod": "PATCH",
- "description": "Updates an existing floodlight configuration. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Floodlight configuration ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "FloodlightConfiguration"
- },
- "response": {
- "$ref": "FloodlightConfiguration"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.floodlightConfigurations.update",
- "path": "userprofiles/{profileId}/floodlightConfigurations",
- "httpMethod": "PUT",
- "description": "Updates an existing floodlight configuration.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "FloodlightConfiguration"
- },
- "response": {
- "$ref": "FloodlightConfiguration"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "inventoryItems": {
- "methods": {
- "get": {
- "id": "dfareporting.inventoryItems.get",
- "path": "userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}",
- "httpMethod": "GET",
- "description": "Gets one inventory item by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Inventory item ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID for order documents.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "projectId",
- "id"
- ],
- "response": {
- "$ref": "InventoryItem"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.inventoryItems.list",
- "path": "userprofiles/{profileId}/projects/{projectId}/inventoryItems",
- "httpMethod": "GET",
- "description": "Retrieves a list of inventory items, possibly filtered.",
- "parameters": {
- "ids": {
- "type": "string",
- "description": "Select only inventory items with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "inPlan": {
- "type": "boolean",
- "description": "Select only inventory items that are in plan.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "orderId": {
- "type": "string",
- "description": "Select only inventory items that belong to specified orders.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID for order documents.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "siteId": {
- "type": "string",
- "description": "Select only inventory items that are associated with these sites.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "projectId"
- ],
- "response": {
- "$ref": "InventoryItemsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "landingPages": {
- "methods": {
- "delete": {
- "id": "dfareporting.landingPages.delete",
- "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing campaign landing page.",
- "parameters": {
- "campaignId": {
- "type": "string",
- "description": "Landing page campaign ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "id": {
- "type": "string",
- "description": "Landing page ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "campaignId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.landingPages.get",
- "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages/{id}",
- "httpMethod": "GET",
- "description": "Gets one campaign landing page by ID.",
- "parameters": {
- "campaignId": {
- "type": "string",
- "description": "Landing page campaign ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "id": {
- "type": "string",
- "description": "Landing page ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "campaignId",
- "id"
- ],
- "response": {
- "$ref": "LandingPage"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.landingPages.insert",
- "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages",
- "httpMethod": "POST",
- "description": "Inserts a new landing page for the specified campaign.",
- "parameters": {
- "campaignId": {
- "type": "string",
- "description": "Landing page campaign ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "campaignId"
- ],
- "request": {
- "$ref": "LandingPage"
- },
- "response": {
- "$ref": "LandingPage"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.landingPages.list",
- "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages",
- "httpMethod": "GET",
- "description": "Retrieves the list of landing pages for the specified campaign.",
- "parameters": {
- "campaignId": {
- "type": "string",
- "description": "Landing page campaign ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "campaignId"
- ],
- "response": {
- "$ref": "LandingPagesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.landingPages.patch",
- "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages",
- "httpMethod": "PATCH",
- "description": "Updates an existing campaign landing page. This method supports patch semantics.",
- "parameters": {
- "campaignId": {
- "type": "string",
- "description": "Landing page campaign ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "id": {
- "type": "string",
- "description": "Landing page ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "campaignId",
- "id"
- ],
- "request": {
- "$ref": "LandingPage"
- },
- "response": {
- "$ref": "LandingPage"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.landingPages.update",
- "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages",
- "httpMethod": "PUT",
- "description": "Updates an existing campaign landing page.",
- "parameters": {
- "campaignId": {
- "type": "string",
- "description": "Landing page campaign ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "campaignId"
- ],
- "request": {
- "$ref": "LandingPage"
- },
- "response": {
- "$ref": "LandingPage"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "metros": {
- "methods": {
- "list": {
- "id": "dfareporting.metros.list",
- "path": "userprofiles/{profileId}/metros",
- "httpMethod": "GET",
- "description": "Retrieves a list of metros.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "MetrosListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "mobileCarriers": {
- "methods": {
- "get": {
- "id": "dfareporting.mobileCarriers.get",
- "path": "userprofiles/{profileId}/mobileCarriers/{id}",
- "httpMethod": "GET",
- "description": "Gets one mobile carrier by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Mobile carrier ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "MobileCarrier"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.mobileCarriers.list",
- "path": "userprofiles/{profileId}/mobileCarriers",
- "httpMethod": "GET",
- "description": "Retrieves a list of mobile carriers.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "MobileCarriersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "operatingSystemVersions": {
- "methods": {
- "get": {
- "id": "dfareporting.operatingSystemVersions.get",
- "path": "userprofiles/{profileId}/operatingSystemVersions/{id}",
- "httpMethod": "GET",
- "description": "Gets one operating system version by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Operating system version ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "OperatingSystemVersion"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.operatingSystemVersions.list",
- "path": "userprofiles/{profileId}/operatingSystemVersions",
- "httpMethod": "GET",
- "description": "Retrieves a list of operating system versions.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "OperatingSystemVersionsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "operatingSystems": {
- "methods": {
- "get": {
- "id": "dfareporting.operatingSystems.get",
- "path": "userprofiles/{profileId}/operatingSystems/{dartId}",
- "httpMethod": "GET",
- "description": "Gets one operating system by DART ID.",
- "parameters": {
- "dartId": {
- "type": "string",
- "description": "Operating system DART ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "dartId"
- ],
- "response": {
- "$ref": "OperatingSystem"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.operatingSystems.list",
- "path": "userprofiles/{profileId}/operatingSystems",
- "httpMethod": "GET",
- "description": "Retrieves a list of operating systems.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "OperatingSystemsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "orderDocuments": {
- "methods": {
- "get": {
- "id": "dfareporting.orderDocuments.get",
- "path": "userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}",
- "httpMethod": "GET",
- "description": "Gets one order document by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Order document ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID for order documents.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "projectId",
- "id"
- ],
- "response": {
- "$ref": "OrderDocument"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.orderDocuments.list",
- "path": "userprofiles/{profileId}/projects/{projectId}/orderDocuments",
- "httpMethod": "GET",
- "description": "Retrieves a list of order documents, possibly filtered.",
- "parameters": {
- "approved": {
- "type": "boolean",
- "description": "Select only order documents that have been approved by at least one user.",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only order documents with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "orderId": {
- "type": "string",
- "description": "Select only order documents for specified orders.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID for order documents.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, \"orderdocument*2015\" will return order documents with names like \"orderdocument June 2015\", \"orderdocument April 2015\", or simply \"orderdocument 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"orderdocument\" will match order documents with name \"my orderdocument\", \"orderdocument 2015\", or simply \"orderdocument\".",
- "location": "query"
- },
- "siteId": {
- "type": "string",
- "description": "Select only order documents that are associated with these sites.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "projectId"
- ],
- "response": {
- "$ref": "OrderDocumentsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "orders": {
- "methods": {
- "get": {
- "id": "dfareporting.orders.get",
- "path": "userprofiles/{profileId}/projects/{projectId}/orders/{id}",
- "httpMethod": "GET",
- "description": "Gets one order by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Order ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID for orders.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "projectId",
- "id"
- ],
- "response": {
- "$ref": "Order"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.orders.list",
- "path": "userprofiles/{profileId}/projects/{projectId}/orders",
- "httpMethod": "GET",
- "description": "Retrieves a list of orders, possibly filtered.",
- "parameters": {
- "ids": {
- "type": "string",
- "description": "Select only orders with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID for orders.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, \"order*2015\" will return orders with names like \"order June 2015\", \"order April 2015\", or simply \"order 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"order\" will match orders with name \"my order\", \"order 2015\", or simply \"order\".",
- "location": "query"
- },
- "siteId": {
- "type": "string",
- "description": "Select only orders that are associated with these site IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "projectId"
- ],
- "response": {
- "$ref": "OrdersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "placementGroups": {
- "methods": {
- "get": {
- "id": "dfareporting.placementGroups.get",
- "path": "userprofiles/{profileId}/placementGroups/{id}",
- "httpMethod": "GET",
- "description": "Gets one placement group by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Placement group ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "PlacementGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.placementGroups.insert",
- "path": "userprofiles/{profileId}/placementGroups",
- "httpMethod": "POST",
- "description": "Inserts a new placement group.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "PlacementGroup"
- },
- "response": {
- "$ref": "PlacementGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.placementGroups.list",
- "path": "userprofiles/{profileId}/placementGroups",
- "httpMethod": "GET",
- "description": "Retrieves a list of placement groups, possibly filtered.",
- "parameters": {
- "advertiserIds": {
- "type": "string",
- "description": "Select only placement groups that belong to these advertisers.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "archived": {
- "type": "boolean",
- "description": "Select only archived placements. Don't set this field to select both archived and non-archived placements.",
- "location": "query"
- },
- "campaignIds": {
- "type": "string",
- "description": "Select only placement groups that belong to these campaigns.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "contentCategoryIds": {
- "type": "string",
- "description": "Select only placement groups that are associated with these content categories.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "directorySiteIds": {
- "type": "string",
- "description": "Select only placement groups that are associated with these directory sites.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only placement groups with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "placementGroupType": {
- "type": "string",
- "description": "Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.",
- "enum": [
- "PLACEMENT_PACKAGE",
- "PLACEMENT_ROADBLOCK"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "placementStrategyIds": {
- "type": "string",
- "description": "Select only placement groups that are associated with these placement strategies.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "pricingTypes": {
- "type": "string",
- "description": "Select only placement groups with these pricing types.",
- "enum": [
- "PRICING_TYPE_CPA",
- "PRICING_TYPE_CPC",
- "PRICING_TYPE_CPM",
- "PRICING_TYPE_FLAT_RATE_CLICKS",
- "PRICING_TYPE_FLAT_RATE_IMPRESSIONS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, \"placement*2015\" will return placement groups with names like \"placement group June 2015\", \"placement group May 2015\", or simply \"placements 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placementgroup\" will match placement groups with name \"my placementgroup\", \"placementgroup 2015\", or simply \"placementgroup\".",
- "location": "query"
- },
- "siteIds": {
- "type": "string",
- "description": "Select only placement groups that are associated with these sites.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "PlacementGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.placementGroups.patch",
- "path": "userprofiles/{profileId}/placementGroups",
- "httpMethod": "PATCH",
- "description": "Updates an existing placement group. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Placement group ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "PlacementGroup"
- },
- "response": {
- "$ref": "PlacementGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.placementGroups.update",
- "path": "userprofiles/{profileId}/placementGroups",
- "httpMethod": "PUT",
- "description": "Updates an existing placement group.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "PlacementGroup"
- },
- "response": {
- "$ref": "PlacementGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "placementStrategies": {
- "methods": {
- "delete": {
- "id": "dfareporting.placementStrategies.delete",
- "path": "userprofiles/{profileId}/placementStrategies/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing placement strategy.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Placement strategy ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.placementStrategies.get",
- "path": "userprofiles/{profileId}/placementStrategies/{id}",
- "httpMethod": "GET",
- "description": "Gets one placement strategy by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Placement strategy ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "PlacementStrategy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.placementStrategies.insert",
- "path": "userprofiles/{profileId}/placementStrategies",
- "httpMethod": "POST",
- "description": "Inserts a new placement strategy.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "PlacementStrategy"
- },
- "response": {
- "$ref": "PlacementStrategy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.placementStrategies.list",
- "path": "userprofiles/{profileId}/placementStrategies",
- "httpMethod": "GET",
- "description": "Retrieves a list of placement strategies, possibly filtered.",
- "parameters": {
- "ids": {
- "type": "string",
- "description": "Select only placement strategies with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"placementstrategy*2015\" will return objects with names like \"placementstrategy June 2015\", \"placementstrategy April 2015\", or simply \"placementstrategy 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placementstrategy\" will match objects with name \"my placementstrategy\", \"placementstrategy 2015\", or simply \"placementstrategy\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "PlacementStrategiesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.placementStrategies.patch",
- "path": "userprofiles/{profileId}/placementStrategies",
- "httpMethod": "PATCH",
- "description": "Updates an existing placement strategy. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Placement strategy ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "PlacementStrategy"
- },
- "response": {
- "$ref": "PlacementStrategy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.placementStrategies.update",
- "path": "userprofiles/{profileId}/placementStrategies",
- "httpMethod": "PUT",
- "description": "Updates an existing placement strategy.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "PlacementStrategy"
- },
- "response": {
- "$ref": "PlacementStrategy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "placements": {
- "methods": {
- "generatetags": {
- "id": "dfareporting.placements.generatetags",
- "path": "userprofiles/{profileId}/placements/generatetags",
- "httpMethod": "POST",
- "description": "Generates tags for a placement.",
- "parameters": {
- "campaignId": {
- "type": "string",
- "description": "Generate placements belonging to this campaign. This is a required field.",
- "format": "int64",
- "location": "query"
- },
- "placementIds": {
- "type": "string",
- "description": "Generate tags for these placements.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "tagFormats": {
- "type": "string",
- "description": "Tag formats to generate for these placements.",
- "enum": [
- "PLACEMENT_TAG_CLICK_COMMANDS",
- "PLACEMENT_TAG_IFRAME_ILAYER",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
- "PLACEMENT_TAG_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_JAVASCRIPT",
- "PLACEMENT_TAG_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_STANDARD",
- "PLACEMENT_TAG_TRACKING",
- "PLACEMENT_TAG_TRACKING_IFRAME",
- "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "PlacementsGenerateTagsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.placements.get",
- "path": "userprofiles/{profileId}/placements/{id}",
- "httpMethod": "GET",
- "description": "Gets one placement by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Placement ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Placement"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.placements.insert",
- "path": "userprofiles/{profileId}/placements",
- "httpMethod": "POST",
- "description": "Inserts a new placement.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Placement"
- },
- "response": {
- "$ref": "Placement"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.placements.list",
- "path": "userprofiles/{profileId}/placements",
- "httpMethod": "GET",
- "description": "Retrieves a list of placements, possibly filtered.",
- "parameters": {
- "advertiserIds": {
- "type": "string",
- "description": "Select only placements that belong to these advertisers.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "archived": {
- "type": "boolean",
- "description": "Select only archived placements. Don't set this field to select both archived and non-archived placements.",
- "location": "query"
- },
- "campaignIds": {
- "type": "string",
- "description": "Select only placements that belong to these campaigns.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "compatibilities": {
- "type": "string",
- "description": "Select only placements that are associated with these compatibilities. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.",
- "enum": [
- "APP",
- "APP_INTERSTITIAL",
- "IN_STREAM_VIDEO",
- "WEB",
- "WEB_INTERSTITIAL"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- },
- "contentCategoryIds": {
- "type": "string",
- "description": "Select only placements that are associated with these content categories.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "directorySiteIds": {
- "type": "string",
- "description": "Select only placements that are associated with these directory sites.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "groupIds": {
- "type": "string",
- "description": "Select only placements that belong to these placement groups.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only placements with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "paymentSource": {
- "type": "string",
- "description": "Select only placements with this payment source.",
- "enum": [
- "PLACEMENT_AGENCY_PAID",
- "PLACEMENT_PUBLISHER_PAID"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "placementStrategyIds": {
- "type": "string",
- "description": "Select only placements that are associated with these placement strategies.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "pricingTypes": {
- "type": "string",
- "description": "Select only placements with these pricing types.",
- "enum": [
- "PRICING_TYPE_CPA",
- "PRICING_TYPE_CPC",
- "PRICING_TYPE_CPM",
- "PRICING_TYPE_FLAT_RATE_CLICKS",
- "PRICING_TYPE_FLAT_RATE_IMPRESSIONS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, \"placement*2015\" will return placements with names like \"placement June 2015\", \"placement May 2015\", or simply \"placements 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placement\" will match placements with name \"my placement\", \"placement 2015\", or simply \"placement\".",
- "location": "query"
- },
- "siteIds": {
- "type": "string",
- "description": "Select only placements that are associated with these sites.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "sizeIds": {
- "type": "string",
- "description": "Select only placements that are associated with these sizes.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "PlacementsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.placements.patch",
- "path": "userprofiles/{profileId}/placements",
- "httpMethod": "PATCH",
- "description": "Updates an existing placement. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Placement ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "Placement"
- },
- "response": {
- "$ref": "Placement"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.placements.update",
- "path": "userprofiles/{profileId}/placements",
- "httpMethod": "PUT",
- "description": "Updates an existing placement.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Placement"
- },
- "response": {
- "$ref": "Placement"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "platformTypes": {
- "methods": {
- "get": {
- "id": "dfareporting.platformTypes.get",
- "path": "userprofiles/{profileId}/platformTypes/{id}",
- "httpMethod": "GET",
- "description": "Gets one platform type by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Platform type ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "PlatformType"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.platformTypes.list",
- "path": "userprofiles/{profileId}/platformTypes",
- "httpMethod": "GET",
- "description": "Retrieves a list of platform types.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "PlatformTypesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "postalCodes": {
- "methods": {
- "get": {
- "id": "dfareporting.postalCodes.get",
- "path": "userprofiles/{profileId}/postalCodes/{code}",
- "httpMethod": "GET",
- "description": "Gets one postal code by ID.",
- "parameters": {
- "code": {
- "type": "string",
- "description": "Postal code ID.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "code"
- ],
- "response": {
- "$ref": "PostalCode"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.postalCodes.list",
- "path": "userprofiles/{profileId}/postalCodes",
- "httpMethod": "GET",
- "description": "Retrieves a list of postal codes.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "PostalCodesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "projects": {
- "methods": {
- "get": {
- "id": "dfareporting.projects.get",
- "path": "userprofiles/{profileId}/projects/{id}",
- "httpMethod": "GET",
- "description": "Gets one project by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Project ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Project"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.projects.list",
- "path": "userprofiles/{profileId}/projects",
- "httpMethod": "GET",
- "description": "Retrieves a list of projects, possibly filtered.",
- "parameters": {
- "advertiserIds": {
- "type": "string",
- "description": "Select only projects with these advertiser IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only projects with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, \"project*2015\" will return projects with names like \"project June 2015\", \"project April 2015\", or simply \"project 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"project\" will match projects with name \"my project\", \"project 2015\", or simply \"project\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "ProjectsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "regions": {
- "methods": {
- "list": {
- "id": "dfareporting.regions.list",
- "path": "userprofiles/{profileId}/regions",
- "httpMethod": "GET",
- "description": "Retrieves a list of regions.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "RegionsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "remarketingListShares": {
- "methods": {
- "get": {
- "id": "dfareporting.remarketingListShares.get",
- "path": "userprofiles/{profileId}/remarketingListShares/{remarketingListId}",
- "httpMethod": "GET",
- "description": "Gets one remarketing list share by remarketing list ID.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "remarketingListId": {
- "type": "string",
- "description": "Remarketing list ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "remarketingListId"
- ],
- "response": {
- "$ref": "RemarketingListShare"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.remarketingListShares.patch",
- "path": "userprofiles/{profileId}/remarketingListShares",
- "httpMethod": "PATCH",
- "description": "Updates an existing remarketing list share. This method supports patch semantics.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "remarketingListId": {
- "type": "string",
- "description": "Remarketing list ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "remarketingListId"
- ],
- "request": {
- "$ref": "RemarketingListShare"
- },
- "response": {
- "$ref": "RemarketingListShare"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.remarketingListShares.update",
- "path": "userprofiles/{profileId}/remarketingListShares",
- "httpMethod": "PUT",
- "description": "Updates an existing remarketing list share.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "RemarketingListShare"
- },
- "response": {
- "$ref": "RemarketingListShare"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "remarketingLists": {
- "methods": {
- "get": {
- "id": "dfareporting.remarketingLists.get",
- "path": "userprofiles/{profileId}/remarketingLists/{id}",
- "httpMethod": "GET",
- "description": "Gets one remarketing list by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Remarketing list ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "RemarketingList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.remarketingLists.insert",
- "path": "userprofiles/{profileId}/remarketingLists",
- "httpMethod": "POST",
- "description": "Inserts a new remarketing list.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "RemarketingList"
- },
- "response": {
- "$ref": "RemarketingList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.remarketingLists.list",
- "path": "userprofiles/{profileId}/remarketingLists",
- "httpMethod": "GET",
- "description": "Retrieves a list of remarketing lists, possibly filtered.",
- "parameters": {
- "active": {
- "type": "boolean",
- "description": "Select only active or only inactive remarketing lists.",
- "location": "query"
- },
- "advertiserId": {
- "type": "string",
- "description": "Select only remarketing lists owned by this advertiser.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "floodlightActivityId": {
- "type": "string",
- "description": "Select only remarketing lists that have this floodlight activity ID.",
- "format": "int64",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "name": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"remarketing list*2015\" will return objects with names like \"remarketing list June 2015\", \"remarketing list April 2015\", or simply \"remarketing list 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"remarketing list\" will match objects with name \"my remarketing list\", \"remarketing list 2015\", or simply \"remarketing list\".",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "advertiserId"
- ],
- "response": {
- "$ref": "RemarketingListsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.remarketingLists.patch",
- "path": "userprofiles/{profileId}/remarketingLists",
- "httpMethod": "PATCH",
- "description": "Updates an existing remarketing list. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Remarketing list ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "RemarketingList"
- },
- "response": {
- "$ref": "RemarketingList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.remarketingLists.update",
- "path": "userprofiles/{profileId}/remarketingLists",
- "httpMethod": "PUT",
- "description": "Updates an existing remarketing list.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "RemarketingList"
- },
- "response": {
- "$ref": "RemarketingList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "reports": {
- "methods": {
- "delete": {
- "id": "dfareporting.reports.delete",
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "DELETE",
- "description": "Deletes a report by its ID.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "get": {
- "id": "dfareporting.reports.get",
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "GET",
- "description": "Retrieves a report by its ID.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "insert": {
- "id": "dfareporting.reports.insert",
- "path": "userprofiles/{profileId}/reports",
- "httpMethod": "POST",
- "description": "Creates a report.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "list": {
- "id": "dfareporting.reports.list",
- "path": "userprofiles/{profileId}/reports",
- "httpMethod": "GET",
- "description": "Retrieves list of reports.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "scope": {
- "type": "string",
- "description": "The scope that defines which results are returned, default is 'MINE'.",
- "default": "MINE",
- "enum": [
- "ALL",
- "MINE"
- ],
- "enumDescriptions": [
- "All reports in account.",
- "My reports."
- ],
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "The field by which to sort the list.",
- "default": "LAST_MODIFIED_TIME",
- "enum": [
- "ID",
- "LAST_MODIFIED_TIME",
- "NAME"
- ],
- "enumDescriptions": [
- "Sort by report ID.",
- "Sort by 'lastModifiedTime' field.",
- "Sort by name of reports."
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is 'DESCENDING'.",
- "default": "DESCENDING",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "ReportList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "patch": {
- "id": "dfareporting.reports.patch",
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "PATCH",
- "description": "Updates a report. This method supports patch semantics.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "run": {
- "id": "dfareporting.reports.run",
- "path": "userprofiles/{profileId}/reports/{reportId}/run",
- "httpMethod": "POST",
- "description": "Runs a report.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "synchronous": {
- "type": "boolean",
- "description": "If set and true, tries to run the report synchronously.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "response": {
- "$ref": "File"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "update": {
- "id": "dfareporting.reports.update",
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "PUT",
- "description": "Updates a report.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- },
- "resources": {
- "compatibleFields": {
- "methods": {
- "query": {
- "id": "dfareporting.reports.compatibleFields.query",
- "path": "userprofiles/{profileId}/reports/compatiblefields/query",
- "httpMethod": "POST",
- "description": "Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "CompatibleFields"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- },
- "files": {
- "methods": {
- "get": {
- "id": "dfareporting.reports.files.get",
- "path": "userprofiles/{profileId}/reports/{reportId}/files/{fileId}",
- "httpMethod": "GET",
- "description": "Retrieves a report file.",
- "parameters": {
- "fileId": {
- "type": "string",
- "description": "The ID of the report file.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId",
- "fileId"
- ],
- "response": {
- "$ref": "File"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ],
- "supportsMediaDownload": true
- },
- "list": {
- "id": "dfareporting.reports.files.list",
- "path": "userprofiles/{profileId}/reports/{reportId}/files",
- "httpMethod": "GET",
- "description": "Lists files for a report.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the parent report.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "sortField": {
- "type": "string",
- "description": "The field by which to sort the list.",
- "default": "LAST_MODIFIED_TIME",
- "enum": [
- "ID",
- "LAST_MODIFIED_TIME"
- ],
- "enumDescriptions": [
- "Sort by file ID.",
- "Sort by 'lastmodifiedAt' field."
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is 'DESCENDING'.",
- "default": "DESCENDING",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "response": {
- "$ref": "FileList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- }
- }
- },
- "sites": {
- "methods": {
- "get": {
- "id": "dfareporting.sites.get",
- "path": "userprofiles/{profileId}/sites/{id}",
- "httpMethod": "GET",
- "description": "Gets one site by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Site ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Site"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.sites.insert",
- "path": "userprofiles/{profileId}/sites",
- "httpMethod": "POST",
- "description": "Inserts a new site.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Site"
- },
- "response": {
- "$ref": "Site"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.sites.list",
- "path": "userprofiles/{profileId}/sites",
- "httpMethod": "GET",
- "description": "Retrieves a list of sites, possibly filtered.",
- "parameters": {
- "acceptsInStreamVideoPlacements": {
- "type": "boolean",
- "description": "This search filter is no longer supported and will have no effect on the results returned.",
- "location": "query"
- },
- "acceptsInterstitialPlacements": {
- "type": "boolean",
- "description": "This search filter is no longer supported and will have no effect on the results returned.",
- "location": "query"
- },
- "acceptsPublisherPaidPlacements": {
- "type": "boolean",
- "description": "Select only sites that accept publisher paid placements.",
- "location": "query"
- },
- "adWordsSite": {
- "type": "boolean",
- "description": "Select only AdWords sites.",
- "location": "query"
- },
- "approved": {
- "type": "boolean",
- "description": "Select only approved sites.",
- "location": "query"
- },
- "campaignIds": {
- "type": "string",
- "description": "Select only sites with these campaign IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "directorySiteIds": {
- "type": "string",
- "description": "Select only sites with these directory site IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only sites with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, \"site*2015\" will return objects with names like \"site June 2015\", \"site April 2015\", or simply \"site 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"site\" will match objects with name \"my site\", \"site 2015\", or simply \"site\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "subaccountId": {
- "type": "string",
- "description": "Select only sites with this subaccount ID.",
- "format": "int64",
- "location": "query"
- },
- "unmappedSite": {
- "type": "boolean",
- "description": "Select only sites that have not been mapped to a directory site.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "SitesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.sites.patch",
- "path": "userprofiles/{profileId}/sites",
- "httpMethod": "PATCH",
- "description": "Updates an existing site. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Site ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "Site"
- },
- "response": {
- "$ref": "Site"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.sites.update",
- "path": "userprofiles/{profileId}/sites",
- "httpMethod": "PUT",
- "description": "Updates an existing site.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Site"
- },
- "response": {
- "$ref": "Site"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "sizes": {
- "methods": {
- "get": {
- "id": "dfareporting.sizes.get",
- "path": "userprofiles/{profileId}/sizes/{id}",
- "httpMethod": "GET",
- "description": "Gets one size by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Size ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Size"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.sizes.insert",
- "path": "userprofiles/{profileId}/sizes",
- "httpMethod": "POST",
- "description": "Inserts a new size.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Size"
- },
- "response": {
- "$ref": "Size"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.sizes.list",
- "path": "userprofiles/{profileId}/sizes",
- "httpMethod": "GET",
- "description": "Retrieves a list of sizes, possibly filtered.",
- "parameters": {
- "height": {
- "type": "integer",
- "description": "Select only sizes with this height.",
- "format": "int32",
- "location": "query"
- },
- "iabStandard": {
- "type": "boolean",
- "description": "Select only IAB standard sizes.",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only sizes with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "width": {
- "type": "integer",
- "description": "Select only sizes with this width.",
- "format": "int32",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "SizesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "subaccounts": {
- "methods": {
- "get": {
- "id": "dfareporting.subaccounts.get",
- "path": "userprofiles/{profileId}/subaccounts/{id}",
- "httpMethod": "GET",
- "description": "Gets one subaccount by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Subaccount ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Subaccount"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.subaccounts.insert",
- "path": "userprofiles/{profileId}/subaccounts",
- "httpMethod": "POST",
- "description": "Inserts a new subaccount.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Subaccount"
- },
- "response": {
- "$ref": "Subaccount"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.subaccounts.list",
- "path": "userprofiles/{profileId}/subaccounts",
- "httpMethod": "GET",
- "description": "Gets a list of subaccounts, possibly filtered.",
- "parameters": {
- "ids": {
- "type": "string",
- "description": "Select only subaccounts with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"subaccount*2015\" will return objects with names like \"subaccount June 2015\", \"subaccount April 2015\", or simply \"subaccount 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"subaccount\" will match objects with name \"my subaccount\", \"subaccount 2015\", or simply \"subaccount\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "SubaccountsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.subaccounts.patch",
- "path": "userprofiles/{profileId}/subaccounts",
- "httpMethod": "PATCH",
- "description": "Updates an existing subaccount. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Subaccount ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "Subaccount"
- },
- "response": {
- "$ref": "Subaccount"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.subaccounts.update",
- "path": "userprofiles/{profileId}/subaccounts",
- "httpMethod": "PUT",
- "description": "Updates an existing subaccount.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Subaccount"
- },
- "response": {
- "$ref": "Subaccount"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "targetableRemarketingLists": {
- "methods": {
- "get": {
- "id": "dfareporting.targetableRemarketingLists.get",
- "path": "userprofiles/{profileId}/targetableRemarketingLists/{id}",
- "httpMethod": "GET",
- "description": "Gets one remarketing list by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Remarketing list ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "TargetableRemarketingList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.targetableRemarketingLists.list",
- "path": "userprofiles/{profileId}/targetableRemarketingLists",
- "httpMethod": "GET",
- "description": "Retrieves a list of targetable remarketing lists, possibly filtered.",
- "parameters": {
- "active": {
- "type": "boolean",
- "description": "Select only active or only inactive targetable remarketing lists.",
- "location": "query"
- },
- "advertiserId": {
- "type": "string",
- "description": "Select only targetable remarketing lists targetable by these advertisers.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "name": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"remarketing list*2015\" will return objects with names like \"remarketing list June 2015\", \"remarketing list April 2015\", or simply \"remarketing list 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"remarketing list\" will match objects with name \"my remarketing list\", \"remarketing list 2015\", or simply \"remarketing list\".",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "advertiserId"
- ],
- "response": {
- "$ref": "TargetableRemarketingListsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "userProfiles": {
- "methods": {
- "get": {
- "id": "dfareporting.userProfiles.get",
- "path": "userprofiles/{profileId}",
- "httpMethod": "GET",
- "description": "Gets one user profile by ID.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "UserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting",
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.userProfiles.list",
- "path": "userprofiles",
- "httpMethod": "GET",
- "description": "Retrieves list of user profiles for a user.",
- "response": {
- "$ref": "UserProfileList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting",
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "userRolePermissionGroups": {
- "methods": {
- "get": {
- "id": "dfareporting.userRolePermissionGroups.get",
- "path": "userprofiles/{profileId}/userRolePermissionGroups/{id}",
- "httpMethod": "GET",
- "description": "Gets one user role permission group by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "User role permission group ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "UserRolePermissionGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.userRolePermissionGroups.list",
- "path": "userprofiles/{profileId}/userRolePermissionGroups",
- "httpMethod": "GET",
- "description": "Gets a list of all supported user role permission groups.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "UserRolePermissionGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "userRolePermissions": {
- "methods": {
- "get": {
- "id": "dfareporting.userRolePermissions.get",
- "path": "userprofiles/{profileId}/userRolePermissions/{id}",
- "httpMethod": "GET",
- "description": "Gets one user role permission by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "User role permission ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "UserRolePermission"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.userRolePermissions.list",
- "path": "userprofiles/{profileId}/userRolePermissions",
- "httpMethod": "GET",
- "description": "Gets a list of user role permissions, possibly filtered.",
- "parameters": {
- "ids": {
- "type": "string",
- "description": "Select only user role permissions with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "UserRolePermissionsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "userRoles": {
- "methods": {
- "delete": {
- "id": "dfareporting.userRoles.delete",
- "path": "userprofiles/{profileId}/userRoles/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing user role.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "User role ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.userRoles.get",
- "path": "userprofiles/{profileId}/userRoles/{id}",
- "httpMethod": "GET",
- "description": "Gets one user role by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "User role ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "UserRole"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.userRoles.insert",
- "path": "userprofiles/{profileId}/userRoles",
- "httpMethod": "POST",
- "description": "Inserts a new user role.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "UserRole"
- },
- "response": {
- "$ref": "UserRole"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.userRoles.list",
- "path": "userprofiles/{profileId}/userRoles",
- "httpMethod": "GET",
- "description": "Retrieves a list of user roles, possibly filtered.",
- "parameters": {
- "accountUserRoleOnly": {
- "type": "boolean",
- "description": "Select only account level user roles not associated with any specific subaccount.",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only user roles with the specified IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"userrole*2015\" will return objects with names like \"userrole June 2015\", \"userrole April 2015\", or simply \"userrole 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"userrole\" will match objects with name \"my userrole\", \"userrole 2015\", or simply \"userrole\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "subaccountId": {
- "type": "string",
- "description": "Select only user roles that belong to this subaccount.",
- "format": "int64",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "UserRolesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.userRoles.patch",
- "path": "userprofiles/{profileId}/userRoles",
- "httpMethod": "PATCH",
- "description": "Updates an existing user role. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "User role ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "UserRole"
- },
- "response": {
- "$ref": "UserRole"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.userRoles.update",
- "path": "userprofiles/{profileId}/userRoles",
- "httpMethod": "PUT",
- "description": "Updates an existing user role.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "UserRole"
- },
- "response": {
- "$ref": "UserRole"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/dfareporting/v2.1/dfareporting-gen.go b/vendor/google.golang.org/api/dfareporting/v2.1/dfareporting-gen.go
deleted file mode 100644
index 1325ee1c..00000000
--- a/vendor/google.golang.org/api/dfareporting/v2.1/dfareporting-gen.go
+++ /dev/null
@@ -1,42419 +0,0 @@
-// Package dfareporting provides access to the DCM/DFA Reporting And Trafficking API.
-//
-// See https://developers.google.com/doubleclick-advertisers/reporting/
-//
-// Usage example:
-//
-// import "google.golang.org/api/dfareporting/v2.1"
-// ...
-// dfareportingService, err := dfareporting.New(oauthHttpClient)
-package dfareporting // import "google.golang.org/api/dfareporting/v2.1"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "dfareporting:v2.1"
-const apiName = "dfareporting"
-const apiVersion = "v2.1"
-const basePath = "https://www.googleapis.com/dfareporting/v2.1/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage DoubleClick for Advertisers reports
- DfareportingScope = "https://www.googleapis.com/auth/dfareporting"
-
- // View and manage your DoubleClick Campaign Manager's (DCM) display ad
- // campaigns
- DfatraffickingScope = "https://www.googleapis.com/auth/dfatrafficking"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.AccountActiveAdSummaries = NewAccountActiveAdSummariesService(s)
- s.AccountPermissionGroups = NewAccountPermissionGroupsService(s)
- s.AccountPermissions = NewAccountPermissionsService(s)
- s.AccountUserProfiles = NewAccountUserProfilesService(s)
- s.Accounts = NewAccountsService(s)
- s.Ads = NewAdsService(s)
- s.AdvertiserGroups = NewAdvertiserGroupsService(s)
- s.Advertisers = NewAdvertisersService(s)
- s.Browsers = NewBrowsersService(s)
- s.CampaignCreativeAssociations = NewCampaignCreativeAssociationsService(s)
- s.Campaigns = NewCampaignsService(s)
- s.ChangeLogs = NewChangeLogsService(s)
- s.Cities = NewCitiesService(s)
- s.ConnectionTypes = NewConnectionTypesService(s)
- s.ContentCategories = NewContentCategoriesService(s)
- s.Countries = NewCountriesService(s)
- s.CreativeAssets = NewCreativeAssetsService(s)
- s.CreativeFieldValues = NewCreativeFieldValuesService(s)
- s.CreativeFields = NewCreativeFieldsService(s)
- s.CreativeGroups = NewCreativeGroupsService(s)
- s.Creatives = NewCreativesService(s)
- s.DimensionValues = NewDimensionValuesService(s)
- s.DirectorySiteContacts = NewDirectorySiteContactsService(s)
- s.DirectorySites = NewDirectorySitesService(s)
- s.EventTags = NewEventTagsService(s)
- s.Files = NewFilesService(s)
- s.FloodlightActivities = NewFloodlightActivitiesService(s)
- s.FloodlightActivityGroups = NewFloodlightActivityGroupsService(s)
- s.FloodlightConfigurations = NewFloodlightConfigurationsService(s)
- s.InventoryItems = NewInventoryItemsService(s)
- s.LandingPages = NewLandingPagesService(s)
- s.Metros = NewMetrosService(s)
- s.MobileCarriers = NewMobileCarriersService(s)
- s.OperatingSystemVersions = NewOperatingSystemVersionsService(s)
- s.OperatingSystems = NewOperatingSystemsService(s)
- s.OrderDocuments = NewOrderDocumentsService(s)
- s.Orders = NewOrdersService(s)
- s.PlacementGroups = NewPlacementGroupsService(s)
- s.PlacementStrategies = NewPlacementStrategiesService(s)
- s.Placements = NewPlacementsService(s)
- s.PlatformTypes = NewPlatformTypesService(s)
- s.PostalCodes = NewPostalCodesService(s)
- s.Projects = NewProjectsService(s)
- s.Regions = NewRegionsService(s)
- s.RemarketingListShares = NewRemarketingListSharesService(s)
- s.RemarketingLists = NewRemarketingListsService(s)
- s.Reports = NewReportsService(s)
- s.Sites = NewSitesService(s)
- s.Sizes = NewSizesService(s)
- s.Subaccounts = NewSubaccountsService(s)
- s.TargetableRemarketingLists = NewTargetableRemarketingListsService(s)
- s.UserProfiles = NewUserProfilesService(s)
- s.UserRolePermissionGroups = NewUserRolePermissionGroupsService(s)
- s.UserRolePermissions = NewUserRolePermissionsService(s)
- s.UserRoles = NewUserRolesService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- AccountActiveAdSummaries *AccountActiveAdSummariesService
-
- AccountPermissionGroups *AccountPermissionGroupsService
-
- AccountPermissions *AccountPermissionsService
-
- AccountUserProfiles *AccountUserProfilesService
-
- Accounts *AccountsService
-
- Ads *AdsService
-
- AdvertiserGroups *AdvertiserGroupsService
-
- Advertisers *AdvertisersService
-
- Browsers *BrowsersService
-
- CampaignCreativeAssociations *CampaignCreativeAssociationsService
-
- Campaigns *CampaignsService
-
- ChangeLogs *ChangeLogsService
-
- Cities *CitiesService
-
- ConnectionTypes *ConnectionTypesService
-
- ContentCategories *ContentCategoriesService
-
- Countries *CountriesService
-
- CreativeAssets *CreativeAssetsService
-
- CreativeFieldValues *CreativeFieldValuesService
-
- CreativeFields *CreativeFieldsService
-
- CreativeGroups *CreativeGroupsService
-
- Creatives *CreativesService
-
- DimensionValues *DimensionValuesService
-
- DirectorySiteContacts *DirectorySiteContactsService
-
- DirectorySites *DirectorySitesService
-
- EventTags *EventTagsService
-
- Files *FilesService
-
- FloodlightActivities *FloodlightActivitiesService
-
- FloodlightActivityGroups *FloodlightActivityGroupsService
-
- FloodlightConfigurations *FloodlightConfigurationsService
-
- InventoryItems *InventoryItemsService
-
- LandingPages *LandingPagesService
-
- Metros *MetrosService
-
- MobileCarriers *MobileCarriersService
-
- OperatingSystemVersions *OperatingSystemVersionsService
-
- OperatingSystems *OperatingSystemsService
-
- OrderDocuments *OrderDocumentsService
-
- Orders *OrdersService
-
- PlacementGroups *PlacementGroupsService
-
- PlacementStrategies *PlacementStrategiesService
-
- Placements *PlacementsService
-
- PlatformTypes *PlatformTypesService
-
- PostalCodes *PostalCodesService
-
- Projects *ProjectsService
-
- Regions *RegionsService
-
- RemarketingListShares *RemarketingListSharesService
-
- RemarketingLists *RemarketingListsService
-
- Reports *ReportsService
-
- Sites *SitesService
-
- Sizes *SizesService
-
- Subaccounts *SubaccountsService
-
- TargetableRemarketingLists *TargetableRemarketingListsService
-
- UserProfiles *UserProfilesService
-
- UserRolePermissionGroups *UserRolePermissionGroupsService
-
- UserRolePermissions *UserRolePermissionsService
-
- UserRoles *UserRolesService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewAccountActiveAdSummariesService(s *Service) *AccountActiveAdSummariesService {
- rs := &AccountActiveAdSummariesService{s: s}
- return rs
-}
-
-type AccountActiveAdSummariesService struct {
- s *Service
-}
-
-func NewAccountPermissionGroupsService(s *Service) *AccountPermissionGroupsService {
- rs := &AccountPermissionGroupsService{s: s}
- return rs
-}
-
-type AccountPermissionGroupsService struct {
- s *Service
-}
-
-func NewAccountPermissionsService(s *Service) *AccountPermissionsService {
- rs := &AccountPermissionsService{s: s}
- return rs
-}
-
-type AccountPermissionsService struct {
- s *Service
-}
-
-func NewAccountUserProfilesService(s *Service) *AccountUserProfilesService {
- rs := &AccountUserProfilesService{s: s}
- return rs
-}
-
-type AccountUserProfilesService struct {
- s *Service
-}
-
-func NewAccountsService(s *Service) *AccountsService {
- rs := &AccountsService{s: s}
- return rs
-}
-
-type AccountsService struct {
- s *Service
-}
-
-func NewAdsService(s *Service) *AdsService {
- rs := &AdsService{s: s}
- return rs
-}
-
-type AdsService struct {
- s *Service
-}
-
-func NewAdvertiserGroupsService(s *Service) *AdvertiserGroupsService {
- rs := &AdvertiserGroupsService{s: s}
- return rs
-}
-
-type AdvertiserGroupsService struct {
- s *Service
-}
-
-func NewAdvertisersService(s *Service) *AdvertisersService {
- rs := &AdvertisersService{s: s}
- return rs
-}
-
-type AdvertisersService struct {
- s *Service
-}
-
-func NewBrowsersService(s *Service) *BrowsersService {
- rs := &BrowsersService{s: s}
- return rs
-}
-
-type BrowsersService struct {
- s *Service
-}
-
-func NewCampaignCreativeAssociationsService(s *Service) *CampaignCreativeAssociationsService {
- rs := &CampaignCreativeAssociationsService{s: s}
- return rs
-}
-
-type CampaignCreativeAssociationsService struct {
- s *Service
-}
-
-func NewCampaignsService(s *Service) *CampaignsService {
- rs := &CampaignsService{s: s}
- return rs
-}
-
-type CampaignsService struct {
- s *Service
-}
-
-func NewChangeLogsService(s *Service) *ChangeLogsService {
- rs := &ChangeLogsService{s: s}
- return rs
-}
-
-type ChangeLogsService struct {
- s *Service
-}
-
-func NewCitiesService(s *Service) *CitiesService {
- rs := &CitiesService{s: s}
- return rs
-}
-
-type CitiesService struct {
- s *Service
-}
-
-func NewConnectionTypesService(s *Service) *ConnectionTypesService {
- rs := &ConnectionTypesService{s: s}
- return rs
-}
-
-type ConnectionTypesService struct {
- s *Service
-}
-
-func NewContentCategoriesService(s *Service) *ContentCategoriesService {
- rs := &ContentCategoriesService{s: s}
- return rs
-}
-
-type ContentCategoriesService struct {
- s *Service
-}
-
-func NewCountriesService(s *Service) *CountriesService {
- rs := &CountriesService{s: s}
- return rs
-}
-
-type CountriesService struct {
- s *Service
-}
-
-func NewCreativeAssetsService(s *Service) *CreativeAssetsService {
- rs := &CreativeAssetsService{s: s}
- return rs
-}
-
-type CreativeAssetsService struct {
- s *Service
-}
-
-func NewCreativeFieldValuesService(s *Service) *CreativeFieldValuesService {
- rs := &CreativeFieldValuesService{s: s}
- return rs
-}
-
-type CreativeFieldValuesService struct {
- s *Service
-}
-
-func NewCreativeFieldsService(s *Service) *CreativeFieldsService {
- rs := &CreativeFieldsService{s: s}
- return rs
-}
-
-type CreativeFieldsService struct {
- s *Service
-}
-
-func NewCreativeGroupsService(s *Service) *CreativeGroupsService {
- rs := &CreativeGroupsService{s: s}
- return rs
-}
-
-type CreativeGroupsService struct {
- s *Service
-}
-
-func NewCreativesService(s *Service) *CreativesService {
- rs := &CreativesService{s: s}
- return rs
-}
-
-type CreativesService struct {
- s *Service
-}
-
-func NewDimensionValuesService(s *Service) *DimensionValuesService {
- rs := &DimensionValuesService{s: s}
- return rs
-}
-
-type DimensionValuesService struct {
- s *Service
-}
-
-func NewDirectorySiteContactsService(s *Service) *DirectorySiteContactsService {
- rs := &DirectorySiteContactsService{s: s}
- return rs
-}
-
-type DirectorySiteContactsService struct {
- s *Service
-}
-
-func NewDirectorySitesService(s *Service) *DirectorySitesService {
- rs := &DirectorySitesService{s: s}
- return rs
-}
-
-type DirectorySitesService struct {
- s *Service
-}
-
-func NewEventTagsService(s *Service) *EventTagsService {
- rs := &EventTagsService{s: s}
- return rs
-}
-
-type EventTagsService struct {
- s *Service
-}
-
-func NewFilesService(s *Service) *FilesService {
- rs := &FilesService{s: s}
- return rs
-}
-
-type FilesService struct {
- s *Service
-}
-
-func NewFloodlightActivitiesService(s *Service) *FloodlightActivitiesService {
- rs := &FloodlightActivitiesService{s: s}
- return rs
-}
-
-type FloodlightActivitiesService struct {
- s *Service
-}
-
-func NewFloodlightActivityGroupsService(s *Service) *FloodlightActivityGroupsService {
- rs := &FloodlightActivityGroupsService{s: s}
- return rs
-}
-
-type FloodlightActivityGroupsService struct {
- s *Service
-}
-
-func NewFloodlightConfigurationsService(s *Service) *FloodlightConfigurationsService {
- rs := &FloodlightConfigurationsService{s: s}
- return rs
-}
-
-type FloodlightConfigurationsService struct {
- s *Service
-}
-
-func NewInventoryItemsService(s *Service) *InventoryItemsService {
- rs := &InventoryItemsService{s: s}
- return rs
-}
-
-type InventoryItemsService struct {
- s *Service
-}
-
-func NewLandingPagesService(s *Service) *LandingPagesService {
- rs := &LandingPagesService{s: s}
- return rs
-}
-
-type LandingPagesService struct {
- s *Service
-}
-
-func NewMetrosService(s *Service) *MetrosService {
- rs := &MetrosService{s: s}
- return rs
-}
-
-type MetrosService struct {
- s *Service
-}
-
-func NewMobileCarriersService(s *Service) *MobileCarriersService {
- rs := &MobileCarriersService{s: s}
- return rs
-}
-
-type MobileCarriersService struct {
- s *Service
-}
-
-func NewOperatingSystemVersionsService(s *Service) *OperatingSystemVersionsService {
- rs := &OperatingSystemVersionsService{s: s}
- return rs
-}
-
-type OperatingSystemVersionsService struct {
- s *Service
-}
-
-func NewOperatingSystemsService(s *Service) *OperatingSystemsService {
- rs := &OperatingSystemsService{s: s}
- return rs
-}
-
-type OperatingSystemsService struct {
- s *Service
-}
-
-func NewOrderDocumentsService(s *Service) *OrderDocumentsService {
- rs := &OrderDocumentsService{s: s}
- return rs
-}
-
-type OrderDocumentsService struct {
- s *Service
-}
-
-func NewOrdersService(s *Service) *OrdersService {
- rs := &OrdersService{s: s}
- return rs
-}
-
-type OrdersService struct {
- s *Service
-}
-
-func NewPlacementGroupsService(s *Service) *PlacementGroupsService {
- rs := &PlacementGroupsService{s: s}
- return rs
-}
-
-type PlacementGroupsService struct {
- s *Service
-}
-
-func NewPlacementStrategiesService(s *Service) *PlacementStrategiesService {
- rs := &PlacementStrategiesService{s: s}
- return rs
-}
-
-type PlacementStrategiesService struct {
- s *Service
-}
-
-func NewPlacementsService(s *Service) *PlacementsService {
- rs := &PlacementsService{s: s}
- return rs
-}
-
-type PlacementsService struct {
- s *Service
-}
-
-func NewPlatformTypesService(s *Service) *PlatformTypesService {
- rs := &PlatformTypesService{s: s}
- return rs
-}
-
-type PlatformTypesService struct {
- s *Service
-}
-
-func NewPostalCodesService(s *Service) *PostalCodesService {
- rs := &PostalCodesService{s: s}
- return rs
-}
-
-type PostalCodesService struct {
- s *Service
-}
-
-func NewProjectsService(s *Service) *ProjectsService {
- rs := &ProjectsService{s: s}
- return rs
-}
-
-type ProjectsService struct {
- s *Service
-}
-
-func NewRegionsService(s *Service) *RegionsService {
- rs := &RegionsService{s: s}
- return rs
-}
-
-type RegionsService struct {
- s *Service
-}
-
-func NewRemarketingListSharesService(s *Service) *RemarketingListSharesService {
- rs := &RemarketingListSharesService{s: s}
- return rs
-}
-
-type RemarketingListSharesService struct {
- s *Service
-}
-
-func NewRemarketingListsService(s *Service) *RemarketingListsService {
- rs := &RemarketingListsService{s: s}
- return rs
-}
-
-type RemarketingListsService struct {
- s *Service
-}
-
-func NewReportsService(s *Service) *ReportsService {
- rs := &ReportsService{s: s}
- rs.CompatibleFields = NewReportsCompatibleFieldsService(s)
- rs.Files = NewReportsFilesService(s)
- return rs
-}
-
-type ReportsService struct {
- s *Service
-
- CompatibleFields *ReportsCompatibleFieldsService
-
- Files *ReportsFilesService
-}
-
-func NewReportsCompatibleFieldsService(s *Service) *ReportsCompatibleFieldsService {
- rs := &ReportsCompatibleFieldsService{s: s}
- return rs
-}
-
-type ReportsCompatibleFieldsService struct {
- s *Service
-}
-
-func NewReportsFilesService(s *Service) *ReportsFilesService {
- rs := &ReportsFilesService{s: s}
- return rs
-}
-
-type ReportsFilesService struct {
- s *Service
-}
-
-func NewSitesService(s *Service) *SitesService {
- rs := &SitesService{s: s}
- return rs
-}
-
-type SitesService struct {
- s *Service
-}
-
-func NewSizesService(s *Service) *SizesService {
- rs := &SizesService{s: s}
- return rs
-}
-
-type SizesService struct {
- s *Service
-}
-
-func NewSubaccountsService(s *Service) *SubaccountsService {
- rs := &SubaccountsService{s: s}
- return rs
-}
-
-type SubaccountsService struct {
- s *Service
-}
-
-func NewTargetableRemarketingListsService(s *Service) *TargetableRemarketingListsService {
- rs := &TargetableRemarketingListsService{s: s}
- return rs
-}
-
-type TargetableRemarketingListsService struct {
- s *Service
-}
-
-func NewUserProfilesService(s *Service) *UserProfilesService {
- rs := &UserProfilesService{s: s}
- return rs
-}
-
-type UserProfilesService struct {
- s *Service
-}
-
-func NewUserRolePermissionGroupsService(s *Service) *UserRolePermissionGroupsService {
- rs := &UserRolePermissionGroupsService{s: s}
- return rs
-}
-
-type UserRolePermissionGroupsService struct {
- s *Service
-}
-
-func NewUserRolePermissionsService(s *Service) *UserRolePermissionsService {
- rs := &UserRolePermissionsService{s: s}
- return rs
-}
-
-type UserRolePermissionsService struct {
- s *Service
-}
-
-func NewUserRolesService(s *Service) *UserRolesService {
- rs := &UserRolesService{s: s}
- return rs
-}
-
-type UserRolesService struct {
- s *Service
-}
-
-// Account: Contains properties of a DCM account.
-type Account struct {
- // AccountPermissionIds: Account permissions assigned to this account.
- AccountPermissionIds googleapi.Int64s `json:"accountPermissionIds,omitempty"`
-
- // AccountProfile: Profile for this account. This is a read-only field
- // that can be left blank.
- //
- // Possible values:
- // "ACCOUNT_PROFILE_BASIC"
- // "ACCOUNT_PROFILE_STANDARD"
- AccountProfile string `json:"accountProfile,omitempty"`
-
- // Active: Whether this account is active.
- Active bool `json:"active,omitempty"`
-
- // ActiveAdsLimitTier: Maximum number of active ads allowed for this
- // account.
- //
- // Possible values:
- // "ACTIVE_ADS_TIER_100K"
- // "ACTIVE_ADS_TIER_200K"
- // "ACTIVE_ADS_TIER_300K"
- // "ACTIVE_ADS_TIER_40K"
- // "ACTIVE_ADS_TIER_75K"
- ActiveAdsLimitTier string `json:"activeAdsLimitTier,omitempty"`
-
- // ActiveViewOptOut: Whether to serve creatives with Active View tags.
- // If disabled, viewability data will not be available for any
- // impressions.
- ActiveViewOptOut bool `json:"activeViewOptOut,omitempty"`
-
- // AvailablePermissionIds: User role permissions available to the user
- // roles of this account.
- AvailablePermissionIds googleapi.Int64s `json:"availablePermissionIds,omitempty"`
-
- // ComscoreVceEnabled: Whether campaigns created in this account will be
- // enabled for comScore vCE by default.
- ComscoreVceEnabled bool `json:"comscoreVceEnabled,omitempty"`
-
- // CountryId: ID of the country associated with this account.
- CountryId int64 `json:"countryId,omitempty,string"`
-
- // CurrencyId: ID of currency associated with this account. This is a
- // required field.
- // Acceptable values are:
- // - "1" for USD
- // - "2" for GBP
- // - "3" for ESP
- // - "4" for SEK
- // - "5" for CAD
- // - "6" for JPY
- // - "7" for DEM
- // - "8" for AUD
- // - "9" for FRF
- // - "10" for ITL
- // - "11" for DKK
- // - "12" for NOK
- // - "13" for FIM
- // - "14" for ZAR
- // - "15" for IEP
- // - "16" for NLG
- // - "17" for EUR
- // - "18" for KRW
- // - "19" for TWD
- // - "20" for SGD
- // - "21" for CNY
- // - "22" for HKD
- // - "23" for NZD
- // - "24" for MYR
- // - "25" for BRL
- // - "26" for PTE
- // - "27" for MXP
- // - "28" for CLP
- // - "29" for TRY
- // - "30" for ARS
- // - "31" for PEN
- // - "32" for ILS
- // - "33" for CHF
- // - "34" for VEF
- // - "35" for COP
- // - "36" for GTQ
- CurrencyId int64 `json:"currencyId,omitempty,string"`
-
- // DefaultCreativeSizeId: Default placement dimensions for this account.
- DefaultCreativeSizeId int64 `json:"defaultCreativeSizeId,omitempty,string"`
-
- // Description: Description of this account.
- Description string `json:"description,omitempty"`
-
- // Id: ID of this account. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#account".
- Kind string `json:"kind,omitempty"`
-
- // Locale: Locale of this account.
- // Acceptable values are:
- // - "cs" (Czech)
- // - "de" (German)
- // - "en" (English)
- // - "en-GB" (English United Kingdom)
- // - "es" (Spanish)
- // - "fr" (French)
- // - "it" (Italian)
- // - "ja" (Japanese)
- // - "ko" (Korean)
- // - "pl" (Polish)
- // - "pt-BR" (Portuguese Brazil)
- // - "ru" (Russian)
- // - "sv" (Swedish)
- // - "tr" (Turkish)
- // - "zh-CN" (Chinese Simplified)
- // - "zh-TW" (Chinese Traditional)
- Locale string `json:"locale,omitempty"`
-
- // MaximumImageSize: Maximum image size allowed for this account.
- MaximumImageSize int64 `json:"maximumImageSize,omitempty,string"`
-
- // Name: Name of this account. This is a required field, and must be
- // less than 128 characters long and be globally unique.
- Name string `json:"name,omitempty"`
-
- // NielsenOcrEnabled: Whether campaigns created in this account will be
- // enabled for Nielsen OCR reach ratings by default.
- NielsenOcrEnabled bool `json:"nielsenOcrEnabled,omitempty"`
-
- // ReportsConfiguration: Reporting configuration of this account.
- ReportsConfiguration *ReportsConfiguration `json:"reportsConfiguration,omitempty"`
-
- // TeaserSizeLimit: File size limit in kilobytes of Rich Media teaser
- // creatives. Must be between 1 and 10240.
- TeaserSizeLimit int64 `json:"teaserSizeLimit,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "AccountPermissionIds") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Account) MarshalJSON() ([]byte, error) {
- type noMethod Account
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountActiveAdSummary: Gets a summary of active ads in an account.
-type AccountActiveAdSummary struct {
- // AccountId: ID of the account.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // ActiveAds: Ads that have been activated for the account
- ActiveAds int64 `json:"activeAds,omitempty,string"`
-
- // ActiveAdsLimitTier: Maximum number of active ads allowed for the
- // account.
- //
- // Possible values:
- // "ACTIVE_ADS_TIER_100K"
- // "ACTIVE_ADS_TIER_200K"
- // "ACTIVE_ADS_TIER_300K"
- // "ACTIVE_ADS_TIER_40K"
- // "ACTIVE_ADS_TIER_75K"
- ActiveAdsLimitTier string `json:"activeAdsLimitTier,omitempty"`
-
- // AvailableAds: Ads that can be activated for the account.
- AvailableAds int64 `json:"availableAds,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#accountActiveAdSummary".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountActiveAdSummary) MarshalJSON() ([]byte, error) {
- type noMethod AccountActiveAdSummary
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountPermission: AccountPermissions contains information about a
-// particular account permission. Some features of DCM require an
-// account permission to be present in the account.
-type AccountPermission struct {
- // AccountProfiles: Account profiles associated with this account
- // permission.
- //
- // Possible values are:
- // - "ACCOUNT_PROFILE_BASIC"
- // - "ACCOUNT_PROFILE_STANDARD"
- //
- // Possible values:
- // "ACCOUNT_PROFILE_BASIC"
- // "ACCOUNT_PROFILE_STANDARD"
- AccountProfiles []string `json:"accountProfiles,omitempty"`
-
- // Id: ID of this account permission.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#accountPermission".
- Kind string `json:"kind,omitempty"`
-
- // Level: Administrative level required to enable this account
- // permission.
- //
- // Possible values:
- // "ADMINISTRATOR"
- // "USER"
- Level string `json:"level,omitempty"`
-
- // Name: Name of this account permission.
- Name string `json:"name,omitempty"`
-
- // PermissionGroupId: Permission group of this account permission.
- PermissionGroupId int64 `json:"permissionGroupId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountProfiles") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountPermission) MarshalJSON() ([]byte, error) {
- type noMethod AccountPermission
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountPermissionGroup: AccountPermissionGroups contains a mapping of
-// permission group IDs to names. A permission group is a grouping of
-// account permissions.
-type AccountPermissionGroup struct {
- // Id: ID of this account permission group.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#accountPermissionGroup".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this account permission group.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountPermissionGroup) MarshalJSON() ([]byte, error) {
- type noMethod AccountPermissionGroup
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountPermissionGroupsListResponse: Account Permission Group List
-// Response
-type AccountPermissionGroupsListResponse struct {
- // AccountPermissionGroups: Account permission group collection.
- AccountPermissionGroups []*AccountPermissionGroup `json:"accountPermissionGroups,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#accountPermissionGroupsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "AccountPermissionGroups") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountPermissionGroupsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod AccountPermissionGroupsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountPermissionsListResponse: Account Permission List Response
-type AccountPermissionsListResponse struct {
- // AccountPermissions: Account permission collection.
- AccountPermissions []*AccountPermission `json:"accountPermissions,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#accountPermissionsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountPermissions")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountPermissionsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod AccountPermissionsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountUserProfile: AccountUserProfiles contains properties of a DCM
-// user profile. This resource is specifically for managing user
-// profiles, whereas UserProfiles is for accessing the API.
-type AccountUserProfile struct {
- // AccountId: Account ID of the user profile. This is a read-only field
- // that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Active: Whether this user profile is active. This defaults to false,
- // and must be set true on insert for the user profile to be usable.
- Active bool `json:"active,omitempty"`
-
- // AdvertiserFilter: Filter that describes which advertisers are visible
- // to the user profile.
- AdvertiserFilter *ObjectFilter `json:"advertiserFilter,omitempty"`
-
- // CampaignFilter: Filter that describes which campaigns are visible to
- // the user profile.
- CampaignFilter *ObjectFilter `json:"campaignFilter,omitempty"`
-
- // Comments: Comments for this user profile.
- Comments string `json:"comments,omitempty"`
-
- // Email: Email of the user profile. The email addresss must be linked
- // to a Google Account. This field is required on insertion and is
- // read-only after insertion.
- Email string `json:"email,omitempty"`
-
- // Id: ID of the user profile. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#accountUserProfile".
- Kind string `json:"kind,omitempty"`
-
- // Locale: Locale of the user profile. This is a required
- // field.
- // Acceptable values are:
- // - "cs" (Czech)
- // - "de" (German)
- // - "en" (English)
- // - "en-GB" (English United Kingdom)
- // - "es" (Spanish)
- // - "fr" (French)
- // - "it" (Italian)
- // - "ja" (Japanese)
- // - "ko" (Korean)
- // - "pl" (Polish)
- // - "pt-BR" (Portuguese Brazil)
- // - "ru" (Russian)
- // - "sv" (Swedish)
- // - "tr" (Turkish)
- // - "zh-CN" (Chinese Simplified)
- // - "zh-TW" (Chinese Traditional)
- Locale string `json:"locale,omitempty"`
-
- // Name: Name of the user profile. This is a required field. Must be
- // less than 64 characters long, must be globally unique, and cannot
- // contain whitespace or any of the following characters: "&;"#%,".
- Name string `json:"name,omitempty"`
-
- // SiteFilter: Filter that describes which sites are visible to the user
- // profile.
- SiteFilter *ObjectFilter `json:"siteFilter,omitempty"`
-
- // SubaccountId: Subaccount ID of the user profile. This is a read-only
- // field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // TraffickerType: Trafficker type of this user profile.
- //
- // Possible values:
- // "EXTERNAL_TRAFFICKER"
- // "INTERNAL_NON_TRAFFICKER"
- // "INTERNAL_TRAFFICKER"
- TraffickerType string `json:"traffickerType,omitempty"`
-
- // UserAccessType: User type of the user profile. This is a read-only
- // field that can be left blank.
- //
- // Possible values:
- // "INTERNAL_ADMINISTRATOR"
- // "NORMAL_USER"
- // "SUPER_USER"
- UserAccessType string `json:"userAccessType,omitempty"`
-
- // UserRoleFilter: Filter that describes which user roles are visible to
- // the user profile.
- UserRoleFilter *ObjectFilter `json:"userRoleFilter,omitempty"`
-
- // UserRoleId: User role ID of the user profile. This is a required
- // field.
- UserRoleId int64 `json:"userRoleId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountUserProfile) MarshalJSON() ([]byte, error) {
- type noMethod AccountUserProfile
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountUserProfilesListResponse: Account User Profile List Response
-type AccountUserProfilesListResponse struct {
- // AccountUserProfiles: Account user profile collection.
- AccountUserProfiles []*AccountUserProfile `json:"accountUserProfiles,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#accountUserProfilesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountUserProfiles")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountUserProfilesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod AccountUserProfilesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountsListResponse: Account List Response
-type AccountsListResponse struct {
- // Accounts: Account collection.
- Accounts []*Account `json:"accounts,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#accountsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Accounts") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod AccountsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Activities: Represents an activity group.
-type Activities struct {
- // Filters: List of activity filters. The dimension values need to be
- // all either of type "dfa:activity" or "dfa:activityGroup".
- Filters []*DimensionValue `json:"filters,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#activities.
- Kind string `json:"kind,omitempty"`
-
- // MetricNames: List of names of floodlight activity metrics.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Filters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Activities) MarshalJSON() ([]byte, error) {
- type noMethod Activities
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Ad: Contains properties of a DCM ad.
-type Ad struct {
- // AccountId: Account ID of this ad. This is a read-only field that can
- // be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Active: Whether this ad is active.
- Active bool `json:"active,omitempty"`
-
- // AdvertiserId: Advertiser ID of this ad. This is a required field on
- // insertion.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // Archived: Whether this ad is archived.
- Archived bool `json:"archived,omitempty"`
-
- // AudienceSegmentId: Audience segment ID that is being targeted for
- // this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- AudienceSegmentId int64 `json:"audienceSegmentId,omitempty,string"`
-
- // CampaignId: Campaign ID of this ad. This is a required field on
- // insertion.
- CampaignId int64 `json:"campaignId,omitempty,string"`
-
- // CampaignIdDimensionValue: Dimension value for the ID of the campaign.
- // This is a read-only, auto-generated field.
- CampaignIdDimensionValue *DimensionValue `json:"campaignIdDimensionValue,omitempty"`
-
- // ClickThroughUrl: Click-through URL for this ad. This is a required
- // field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
- ClickThroughUrl *ClickThroughUrl `json:"clickThroughUrl,omitempty"`
-
- // ClickThroughUrlSuffixProperties: Click-through URL suffix properties
- // for this ad. Applies to the URL in the ad or (if overriding ad
- // properties) the URL in the creative.
- ClickThroughUrlSuffixProperties *ClickThroughUrlSuffixProperties `json:"clickThroughUrlSuffixProperties,omitempty"`
-
- // Comments: Comments for this ad.
- Comments string `json:"comments,omitempty"`
-
- // Compatibility: Compatibility of this ad. Applicable when type is
- // AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering
- // either on desktop or on mobile devices for regular or interstitial
- // ads, respectively. APP and APP_INTERSTITIAL are for rendering in
- // mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video
- // ads developed with the VAST standard.
- //
- // Possible values:
- // "APP"
- // "APP_INTERSTITIAL"
- // "IN_STREAM_VIDEO"
- // "WEB"
- // "WEB_INTERSTITIAL"
- Compatibility string `json:"compatibility,omitempty"`
-
- // CreateInfo: Information about the creation of this ad.This is a
- // read-only field.
- CreateInfo *LastModifiedInfo `json:"createInfo,omitempty"`
-
- // CreativeGroupAssignments: Creative group assignments for this ad.
- // Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment
- // per creative group number is allowed for a maximum of two
- // assignments.
- CreativeGroupAssignments []*CreativeGroupAssignment `json:"creativeGroupAssignments,omitempty"`
-
- // CreativeRotation: Creative rotation for this ad. Applicable when type
- // is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or
- // AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field
- // should have exactly one creativeAssignment.
- CreativeRotation *CreativeRotation `json:"creativeRotation,omitempty"`
-
- // DayPartTargeting: Time and day targeting information for this ad.
- // Applicable when type is AD_SERVING_STANDARD_AD.
- DayPartTargeting *DayPartTargeting `json:"dayPartTargeting,omitempty"`
-
- // DefaultClickThroughEventTagProperties: Default click-through event
- // tag properties for this ad.
- DefaultClickThroughEventTagProperties *DefaultClickThroughEventTagProperties `json:"defaultClickThroughEventTagProperties,omitempty"`
-
- // DeliverySchedule: Delivery schedule information for this ad.
- // Applicable when type is AD_SERVING_STANDARD_AD or
- // AD_SERVING_TRACKING. This field along with subfields priority and
- // impressionRatio are required on insertion when type is
- // AD_SERVING_STANDARD_AD.
- DeliverySchedule *DeliverySchedule `json:"deliverySchedule,omitempty"`
-
- // DynamicClickTracker: Whether this ad is a dynamic click tracker.
- // Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required
- // field on insert, and is read-only after insert.
- DynamicClickTracker bool `json:"dynamicClickTracker,omitempty"`
-
- // EndTime: Date and time that this ad should stop serving. Must be
- // later than the start time. This is a required field on insertion.
- EndTime string `json:"endTime,omitempty"`
-
- // EventTagOverrides: Event tag overrides for this ad.
- EventTagOverrides []*EventTagOverride `json:"eventTagOverrides,omitempty"`
-
- // GeoTargeting: Geographical targeting information for this
- // ad.Applicable when type is AD_SERVING_STANDARD_AD.
- GeoTargeting *GeoTargeting `json:"geoTargeting,omitempty"`
-
- // Id: ID of this ad. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this ad. This is a
- // read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // KeyValueTargetingExpression: Key-value targeting information for this
- // ad. Applicable when type is AD_SERVING_STANDARD_AD.
- KeyValueTargetingExpression *KeyValueTargetingExpression `json:"keyValueTargetingExpression,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#ad".
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedInfo: Information about the most recent modification of
- // this ad. This is a read-only field.
- LastModifiedInfo *LastModifiedInfo `json:"lastModifiedInfo,omitempty"`
-
- // Name: Name of this ad. This is a required field and must be less than
- // 256 characters long.
- Name string `json:"name,omitempty"`
-
- // PlacementAssignments: Placement assignments for this ad.
- PlacementAssignments []*PlacementAssignment `json:"placementAssignments,omitempty"`
-
- // RemarketingListExpression: Applicable when type is
- // AD_SERVING_STANDARD_AD. Remarketing list targeting expression for
- // this ad.
- RemarketingListExpression *ListTargetingExpression `json:"remarketing_list_expression,omitempty"`
-
- // Size: Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
- Size *Size `json:"size,omitempty"`
-
- // SslCompliant: Whether this ad is ssl compliant. This is a read-only
- // field that is auto-generated when the ad is inserted or updated.
- SslCompliant bool `json:"sslCompliant,omitempty"`
-
- // SslRequired: Whether this ad requires ssl. This is a read-only field
- // that is auto-generated when the ad is inserted or updated.
- SslRequired bool `json:"sslRequired,omitempty"`
-
- // StartTime: Date and time that this ad should start serving. If
- // creating an ad, this field must be a time in the future. This is a
- // required field on insertion.
- StartTime string `json:"startTime,omitempty"`
-
- // SubaccountId: Subaccount ID of this ad. This is a read-only field
- // that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // TechnologyTargeting: Technology platform targeting information for
- // this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- TechnologyTargeting *TechnologyTargeting `json:"technologyTargeting,omitempty"`
-
- // Type: Type of ad. This is a required field on insertion. Note that
- // default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see
- // Creative resource).
- //
- // Possible values:
- // "AD_SERVING_CLICK_TRACKER"
- // "AD_SERVING_DEFAULT_AD"
- // "AD_SERVING_STANDARD_AD"
- // "AD_SERVING_TRACKING"
- Type string `json:"type,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Ad) MarshalJSON() ([]byte, error) {
- type noMethod Ad
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdSlot: Ad Slot
-type AdSlot struct {
- // Comment: Comment for this ad slot.
- Comment string `json:"comment,omitempty"`
-
- // Compatibility: Ad slot compatibility. WEB and WEB_INTERSTITIAL refer
- // to rendering either on desktop or on mobile devices for regular or
- // interstitial ads respectively. APP and APP_INTERSTITIAL are for
- // rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in
- // in-stream video ads developed with the VAST standard.
- //
- // Possible values:
- // "PLANNING_RENDERING_ENVIRONMENT_TYPE_APP"
- // "PLANNING_RENDERING_ENVIRONMENT_TYPE_APP_INTERSTITIAL"
- // "PLANNING_RENDERING_ENVIRONMENT_TYPE_IN_STREAM_VIDEO"
- // "PLANNING_RENDERING_ENVIRONMENT_TYPE_WEB"
- // "PLANNING_RENDERING_ENVIRONMENT_TYPE_WEB_INTERSTITIAL"
- Compatibility string `json:"compatibility,omitempty"`
-
- // Height: Height of this ad slot.
- Height int64 `json:"height,omitempty,string"`
-
- // LinkedPlacementId: ID of the placement from an external platform that
- // is linked to this ad slot.
- LinkedPlacementId int64 `json:"linkedPlacementId,omitempty,string"`
-
- // Name: Name of this ad slot.
- Name string `json:"name,omitempty"`
-
- // PaymentSourceType: Payment source type of this ad slot.
- //
- // Possible values:
- // "PLANNING_PAYMENT_SOURCE_TYPE_AGENCY_PAID"
- // "PLANNING_PAYMENT_SOURCE_TYPE_PUBLISHER_PAID"
- PaymentSourceType string `json:"paymentSourceType,omitempty"`
-
- // Primary: Primary ad slot of a roadblock inventory item.
- Primary bool `json:"primary,omitempty"`
-
- // Width: Width of this ad slot.
- Width int64 `json:"width,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "Comment") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdSlot) MarshalJSON() ([]byte, error) {
- type noMethod AdSlot
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdsListResponse: Ad List Response
-type AdsListResponse struct {
- // Ads: Ad collection.
- Ads []*Ad `json:"ads,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#adsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Ads") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod AdsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Advertiser: Contains properties of a DCM advertiser.
-type Advertiser struct {
- // AccountId: Account ID of this advertiser.This is a read-only field
- // that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserGroupId: ID of the advertiser group this advertiser belongs
- // to. You can group advertisers for reporting purposes, allowing you to
- // see aggregated information for all advertisers in each group.
- AdvertiserGroupId int64 `json:"advertiserGroupId,omitempty,string"`
-
- // ClickThroughUrlSuffix: Suffix added to click-through URL of ad
- // creative associations under this advertiser. Must be less than 129
- // characters long.
- ClickThroughUrlSuffix string `json:"clickThroughUrlSuffix,omitempty"`
-
- // DefaultClickThroughEventTagId: ID of the click-through event tag to
- // apply by default to the landing pages of this advertiser's campaigns.
- DefaultClickThroughEventTagId int64 `json:"defaultClickThroughEventTagId,omitempty,string"`
-
- // DefaultEmail: Default email address used in sender field for tag
- // emails.
- DefaultEmail string `json:"defaultEmail,omitempty"`
-
- // FloodlightConfigurationId: Floodlight configuration ID of this
- // advertiser. The floodlight configuration ID will be created
- // automatically, so on insert this field should be left blank. This
- // field can be set to another advertiser's floodlight configuration ID
- // in order to share that advertiser's floodlight configuration with
- // this advertiser, so long as:
- // - This advertiser's original floodlight configuration is not already
- // associated with floodlight activities or floodlight activity groups.
- //
- // - This advertiser's original floodlight configuration is not already
- // shared with another advertiser.
- FloodlightConfigurationId int64 `json:"floodlightConfigurationId,omitempty,string"`
-
- // FloodlightConfigurationIdDimensionValue: Dimension value for the ID
- // of the floodlight configuration. This is a read-only, auto-generated
- // field.
- FloodlightConfigurationIdDimensionValue *DimensionValue `json:"floodlightConfigurationIdDimensionValue,omitempty"`
-
- // Id: ID of this advertiser. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this advertiser. This
- // is a read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#advertiser".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this advertiser. This is a required field and must be
- // less than 256 characters long and unique among advertisers of the
- // same account.
- Name string `json:"name,omitempty"`
-
- // OriginalFloodlightConfigurationId: Original floodlight configuration
- // before any sharing occurred. Set the floodlightConfigurationId of
- // this advertiser to originalFloodlightConfigurationId to unshare the
- // advertiser's current floodlight configuration. You cannot unshare an
- // advertiser's floodlight configuration if the shared configuration has
- // activities associated with any campaign or placement.
- OriginalFloodlightConfigurationId int64 `json:"originalFloodlightConfigurationId,omitempty,string"`
-
- // Status: Status of this advertiser.
- //
- // Possible values:
- // "APPROVED"
- // "ON_HOLD"
- Status string `json:"status,omitempty"`
-
- // SubaccountId: Subaccount ID of this advertiser.This is a read-only
- // field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Advertiser) MarshalJSON() ([]byte, error) {
- type noMethod Advertiser
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdvertiserGroup: Groups advertisers together so that reports can be
-// generated for the entire group at once.
-type AdvertiserGroup struct {
- // AccountId: Account ID of this advertiser group. This is a read-only
- // field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Id: ID of this advertiser group. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#advertiserGroup".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this advertiser group. This is a required field and
- // must be less than 256 characters long and unique among advertiser
- // groups of the same account.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdvertiserGroup) MarshalJSON() ([]byte, error) {
- type noMethod AdvertiserGroup
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdvertiserGroupsListResponse: Advertiser Group List Response
-type AdvertiserGroupsListResponse struct {
- // AdvertiserGroups: Advertiser group collection.
- AdvertiserGroups []*AdvertiserGroup `json:"advertiserGroups,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#advertiserGroupsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AdvertiserGroups") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdvertiserGroupsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod AdvertiserGroupsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdvertisersListResponse: Advertiser List Response
-type AdvertisersListResponse struct {
- // Advertisers: Advertiser collection.
- Advertisers []*Advertiser `json:"advertisers,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#advertisersListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Advertisers") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdvertisersListResponse) MarshalJSON() ([]byte, error) {
- type noMethod AdvertisersListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AudienceSegment: Audience Segment.
-type AudienceSegment struct {
- // Allocation: Weight allocated to this segment. Must be between 1 and
- // 1000. The weight assigned will be understood in proportion to the
- // weights assigned to other segments in the same segment group.
- Allocation int64 `json:"allocation,omitempty"`
-
- // Id: ID of this audience segment. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // Name: Name of this audience segment. This is a required field and
- // must be less than 65 characters long.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Allocation") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AudienceSegment) MarshalJSON() ([]byte, error) {
- type noMethod AudienceSegment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AudienceSegmentGroup: Audience Segment Group.
-type AudienceSegmentGroup struct {
- // AudienceSegments: Audience segments assigned to this group. The
- // number of segments must be between 2 and 100.
- AudienceSegments []*AudienceSegment `json:"audienceSegments,omitempty"`
-
- // Id: ID of this audience segment group. This is a read-only,
- // auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Name: Name of this audience segment group. This is a required field
- // and must be less than 65 characters long.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AudienceSegments") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AudienceSegmentGroup) MarshalJSON() ([]byte, error) {
- type noMethod AudienceSegmentGroup
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Browser: Contains information about a browser that can be targeted by
-// ads.
-type Browser struct {
- // BrowserVersionId: ID referring to this grouping of browser and
- // version numbers. This is the ID used for targeting.
- BrowserVersionId int64 `json:"browserVersionId,omitempty,string"`
-
- // DartId: DART ID of this browser. This is the ID used when generating
- // reports.
- DartId int64 `json:"dartId,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#browser".
- Kind string `json:"kind,omitempty"`
-
- // MajorVersion: Major version number (leftmost number) of this browser.
- // For example, for Chrome 5.0.376.86 beta, this field should be set to
- // 5. An asterisk (*) may be used to target any version number, and a
- // question mark (?) may be used to target cases where the version
- // number cannot be identified. For example, Chrome *.* targets any
- // version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets
- // Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad
- // server knows the browser is Firefox but can't tell which version it
- // is.
- MajorVersion string `json:"majorVersion,omitempty"`
-
- // MinorVersion: Minor version number (number after first dot on left)
- // of this browser. For example, for Chrome 5.0.375.86 beta, this field
- // should be set to 0. An asterisk (*) may be used to target any version
- // number, and a question mark (?) may be used to target cases where the
- // version number cannot be identified. For example, Chrome *.* targets
- // any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets
- // Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad
- // server knows the browser is Firefox but can't tell which version it
- // is.
- MinorVersion string `json:"minorVersion,omitempty"`
-
- // Name: Name of this browser.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BrowserVersionId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Browser) MarshalJSON() ([]byte, error) {
- type noMethod Browser
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// BrowsersListResponse: Browser List Response
-type BrowsersListResponse struct {
- // Browsers: Browser collection.
- Browsers []*Browser `json:"browsers,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#browsersListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Browsers") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BrowsersListResponse) MarshalJSON() ([]byte, error) {
- type noMethod BrowsersListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Campaign: Contains properties of a DCM campaign.
-type Campaign struct {
- // AccountId: Account ID of this campaign. This is a read-only field
- // that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdditionalCreativeOptimizationConfigurations: Additional creative
- // optimization configurations for the campaign.
- AdditionalCreativeOptimizationConfigurations []*CreativeOptimizationConfiguration `json:"additionalCreativeOptimizationConfigurations,omitempty"`
-
- // AdvertiserGroupId: Advertiser group ID of the associated advertiser.
- AdvertiserGroupId int64 `json:"advertiserGroupId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this campaign. This is a required
- // field.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the advertiser ID of
- // this campaign. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // Archived: Whether this campaign has been archived.
- Archived bool `json:"archived,omitempty"`
-
- // AudienceSegmentGroups: Audience segment groups assigned to this
- // campaign. Cannot have more than 300 segment groups.
- AudienceSegmentGroups []*AudienceSegmentGroup `json:"audienceSegmentGroups,omitempty"`
-
- // BillingInvoiceCode: Billing invoice code included in the DCM client
- // billing invoices associated with the campaign.
- BillingInvoiceCode string `json:"billingInvoiceCode,omitempty"`
-
- // ClickThroughUrlSuffixProperties: Click-through URL suffix override
- // properties for this campaign.
- ClickThroughUrlSuffixProperties *ClickThroughUrlSuffixProperties `json:"clickThroughUrlSuffixProperties,omitempty"`
-
- // Comment: Arbitrary comments about this campaign. Must be less than
- // 256 characters long.
- Comment string `json:"comment,omitempty"`
-
- // ComscoreVceEnabled: Whether comScore vCE reports are enabled for this
- // campaign.
- ComscoreVceEnabled bool `json:"comscoreVceEnabled,omitempty"`
-
- // CreateInfo: Information about the creation of this campaign. This is
- // a read-only field.
- CreateInfo *LastModifiedInfo `json:"createInfo,omitempty"`
-
- // CreativeGroupIds: List of creative group IDs that are assigned to the
- // campaign.
- CreativeGroupIds googleapi.Int64s `json:"creativeGroupIds,omitempty"`
-
- // CreativeOptimizationConfiguration: Creative optimization
- // configuration for the campaign.
- CreativeOptimizationConfiguration *CreativeOptimizationConfiguration `json:"creativeOptimizationConfiguration,omitempty"`
-
- // DefaultClickThroughEventTagProperties: Click-through event tag ID
- // override properties for this campaign.
- DefaultClickThroughEventTagProperties *DefaultClickThroughEventTagProperties `json:"defaultClickThroughEventTagProperties,omitempty"`
-
- // EndDate: Date on which the campaign will stop running. On insert, the
- // end date must be today or a future date. The end date must be later
- // than or be the same as the start date. If, for example, you set
- // 6/25/2015 as both the start and end dates, the effective campaign run
- // date is just that day only, 6/25/2015. The hours, minutes, and
- // seconds of the end date should not be set, as doing so will result in
- // an error. This is a required field.
- EndDate string `json:"endDate,omitempty"`
-
- // EventTagOverrides: Overrides that can be used to activate or
- // deactivate advertiser event tags.
- EventTagOverrides []*EventTagOverride `json:"eventTagOverrides,omitempty"`
-
- // ExternalId: External ID for this campaign.
- ExternalId string `json:"externalId,omitempty"`
-
- // Id: ID of this campaign. This is a read-only auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this campaign. This
- // is a read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#campaign".
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedInfo: Information about the most recent modification of
- // this campaign. This is a read-only field.
- LastModifiedInfo *LastModifiedInfo `json:"lastModifiedInfo,omitempty"`
-
- // LookbackConfiguration: Lookback window settings for the campaign.
- LookbackConfiguration *LookbackConfiguration `json:"lookbackConfiguration,omitempty"`
-
- // Name: Name of this campaign. This is a required field and must be
- // less than 256 characters long and unique among campaigns of the same
- // advertiser.
- Name string `json:"name,omitempty"`
-
- // NielsenOcrEnabled: Whether Nielsen reports are enabled for this
- // campaign.
- NielsenOcrEnabled bool `json:"nielsenOcrEnabled,omitempty"`
-
- // StartDate: Date on which the campaign starts running. The start date
- // can be any date. The hours, minutes, and seconds of the start date
- // should not be set, as doing so will result in an error. This is a
- // required field.
- StartDate string `json:"startDate,omitempty"`
-
- // SubaccountId: Subaccount ID of this campaign. This is a read-only
- // field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // TraffickerEmails: Campaign trafficker contact emails.
- TraffickerEmails []string `json:"traffickerEmails,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Campaign) MarshalJSON() ([]byte, error) {
- type noMethod Campaign
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CampaignCreativeAssociation: Identifies a creative which has been
-// associated with a given campaign.
-type CampaignCreativeAssociation struct {
- // CreativeId: ID of the creative associated with the campaign. This is
- // a required field.
- CreativeId int64 `json:"creativeId,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#campaignCreativeAssociation".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreativeId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CampaignCreativeAssociation) MarshalJSON() ([]byte, error) {
- type noMethod CampaignCreativeAssociation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CampaignCreativeAssociationsListResponse: Campaign Creative
-// Association List Response
-type CampaignCreativeAssociationsListResponse struct {
- // CampaignCreativeAssociations: Campaign creative association
- // collection
- CampaignCreativeAssociations []*CampaignCreativeAssociation `json:"campaignCreativeAssociations,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#campaignCreativeAssociationsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "CampaignCreativeAssociations") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CampaignCreativeAssociationsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod CampaignCreativeAssociationsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CampaignsListResponse: Campaign List Response
-type CampaignsListResponse struct {
- // Campaigns: Campaign collection.
- Campaigns []*Campaign `json:"campaigns,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#campaignsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Campaigns") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CampaignsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod CampaignsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ChangeLog: Describes a change that a user has made to a resource.
-type ChangeLog struct {
- // AccountId: Account ID of the modified object.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Action: Action which caused the change.
- Action string `json:"action,omitempty"`
-
- // ChangeTime: Time when the object was modified.
- ChangeTime string `json:"changeTime,omitempty"`
-
- // FieldName: Field name of the object which changed.
- FieldName string `json:"fieldName,omitempty"`
-
- // Id: ID of this change log.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#changeLog".
- Kind string `json:"kind,omitempty"`
-
- // NewValue: New value of the object field.
- NewValue string `json:"newValue,omitempty"`
-
- // ObjectId: ID of the object of this change log. The object could be a
- // campaign, placement, ad, or other type.
- ObjectId int64 `json:"objectId,omitempty,string"`
-
- // ObjectType: Object type of the change log.
- ObjectType string `json:"objectType,omitempty"`
-
- // OldValue: Old value of the object field.
- OldValue string `json:"oldValue,omitempty"`
-
- // SubaccountId: Subaccount ID of the modified object.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // TransactionId: Transaction ID of this change log. When a single API
- // call results in many changes, each change will have a separate ID in
- // the change log but will share the same transactionId.
- TransactionId int64 `json:"transactionId,omitempty,string"`
-
- // UserProfileId: ID of the user who modified the object.
- UserProfileId int64 `json:"userProfileId,omitempty,string"`
-
- // UserProfileName: User profile name of the user who modified the
- // object.
- UserProfileName string `json:"userProfileName,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ChangeLog) MarshalJSON() ([]byte, error) {
- type noMethod ChangeLog
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ChangeLogsListResponse: Change Log List Response
-type ChangeLogsListResponse struct {
- // ChangeLogs: Change log collection.
- ChangeLogs []*ChangeLog `json:"changeLogs,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#changeLogsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ChangeLogs") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ChangeLogsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod ChangeLogsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CitiesListResponse: City List Response
-type CitiesListResponse struct {
- // Cities: City collection.
- Cities []*City `json:"cities,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#citiesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Cities") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CitiesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod CitiesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// City: Contains information about a city that can be targeted by ads.
-type City struct {
- // CountryCode: Country code of the country to which this city belongs.
- CountryCode string `json:"countryCode,omitempty"`
-
- // CountryDartId: DART ID of the country to which this city belongs.
- CountryDartId int64 `json:"countryDartId,omitempty,string"`
-
- // DartId: DART ID of this city. This is the ID used for targeting and
- // generating reports.
- DartId int64 `json:"dartId,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#city".
- Kind string `json:"kind,omitempty"`
-
- // MetroCode: Metro region code of the metro region (DMA) to which this
- // city belongs.
- MetroCode string `json:"metroCode,omitempty"`
-
- // MetroDmaId: ID of the metro region (DMA) to which this city belongs.
- MetroDmaId int64 `json:"metroDmaId,omitempty,string"`
-
- // Name: Name of this city.
- Name string `json:"name,omitempty"`
-
- // RegionCode: Region code of the region to which this city belongs.
- RegionCode string `json:"regionCode,omitempty"`
-
- // RegionDartId: DART ID of the region to which this city belongs.
- RegionDartId int64 `json:"regionDartId,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "CountryCode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *City) MarshalJSON() ([]byte, error) {
- type noMethod City
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ClickTag: Creative Click Tag.
-type ClickTag struct {
- // EventName: Advertiser event name associated with the click tag. This
- // field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER
- // creatives.
- EventName string `json:"eventName,omitempty"`
-
- // Name: Parameter name for the specified click tag. For ENHANCED_IMAGE
- // creative assets, this field must match the value of the creative
- // asset's creativeAssetId.name field.
- Name string `json:"name,omitempty"`
-
- // Value: Parameter value for the specified click tag. This field
- // contains a click-through url.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "EventName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ClickTag) MarshalJSON() ([]byte, error) {
- type noMethod ClickTag
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ClickThroughUrl: Click-through URL
-type ClickThroughUrl struct {
- // CustomClickThroughUrl: Custom click-through URL. Applicable if the
- // defaultLandingPage field is set to false and the landingPageId field
- // is left unset.
- CustomClickThroughUrl string `json:"customClickThroughUrl,omitempty"`
-
- // DefaultLandingPage: Whether the campaign default landing page is
- // used.
- DefaultLandingPage bool `json:"defaultLandingPage,omitempty"`
-
- // LandingPageId: ID of the landing page for the click-through URL.
- // Applicable if the defaultLandingPage field is set to false.
- LandingPageId int64 `json:"landingPageId,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g.
- // "CustomClickThroughUrl") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ClickThroughUrl) MarshalJSON() ([]byte, error) {
- type noMethod ClickThroughUrl
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ClickThroughUrlSuffixProperties: Click Through URL Suffix settings.
-type ClickThroughUrlSuffixProperties struct {
- // ClickThroughUrlSuffix: Click-through URL suffix to apply to all ads
- // in this entity's scope. Must be less than 128 characters long.
- ClickThroughUrlSuffix string `json:"clickThroughUrlSuffix,omitempty"`
-
- // OverrideInheritedSuffix: Whether this entity should override the
- // inherited click-through URL suffix with its own defined value.
- OverrideInheritedSuffix bool `json:"overrideInheritedSuffix,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "ClickThroughUrlSuffix") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ClickThroughUrlSuffixProperties) MarshalJSON() ([]byte, error) {
- type noMethod ClickThroughUrlSuffixProperties
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CompanionClickThroughOverride: Companion Click-through override.
-type CompanionClickThroughOverride struct {
- // ClickThroughUrl: Click-through URL of this companion click-through
- // override.
- ClickThroughUrl *ClickThroughUrl `json:"clickThroughUrl,omitempty"`
-
- // CreativeId: ID of the creative for this companion click-through
- // override.
- CreativeId int64 `json:"creativeId,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "ClickThroughUrl") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CompanionClickThroughOverride) MarshalJSON() ([]byte, error) {
- type noMethod CompanionClickThroughOverride
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CompatibleFields: Represents a response to the queryCompatibleFields
-// method.
-type CompatibleFields struct {
- // CrossDimensionReachReportCompatibleFields: Contains items that are
- // compatible to be selected for a report of type
- // "CROSS_DIMENSION_REACH".
- CrossDimensionReachReportCompatibleFields *CrossDimensionReachReportCompatibleFields `json:"crossDimensionReachReportCompatibleFields,omitempty"`
-
- // FloodlightReportCompatibleFields: Contains items that are compatible
- // to be selected for a report of type "FLOODLIGHT".
- FloodlightReportCompatibleFields *FloodlightReportCompatibleFields `json:"floodlightReportCompatibleFields,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#compatibleFields.
- Kind string `json:"kind,omitempty"`
-
- // PathToConversionReportCompatibleFields: Contains items that are
- // compatible to be selected for a report of type "PATH_TO_CONVERSION".
- PathToConversionReportCompatibleFields *PathToConversionReportCompatibleFields `json:"pathToConversionReportCompatibleFields,omitempty"`
-
- // ReachReportCompatibleFields: Contains items that are compatible to be
- // selected for a report of type "REACH".
- ReachReportCompatibleFields *ReachReportCompatibleFields `json:"reachReportCompatibleFields,omitempty"`
-
- // ReportCompatibleFields: Contains items that are compatible to be
- // selected for a report of type "STANDARD".
- ReportCompatibleFields *ReportCompatibleFields `json:"reportCompatibleFields,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "CrossDimensionReachReportCompatibleFields") to unconditionally
- // include in API requests. By default, fields with empty values are
- // omitted from API requests. However, any non-pointer, non-interface
- // field appearing in ForceSendFields will be sent to the server
- // regardless of whether the field is empty or not. This may be used to
- // include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CompatibleFields) MarshalJSON() ([]byte, error) {
- type noMethod CompatibleFields
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ConnectionType: Contains information about an internet connection
-// type that can be targeted by ads. Clients can use the connection type
-// to target mobile vs. broadband users.
-type ConnectionType struct {
- // Id: ID of this connection type.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#connectionType".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this connection type.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ConnectionType) MarshalJSON() ([]byte, error) {
- type noMethod ConnectionType
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ConnectionTypesListResponse: Connection Type List Response
-type ConnectionTypesListResponse struct {
- // ConnectionTypes: Collection of connection types such as broadband and
- // mobile.
- ConnectionTypes []*ConnectionType `json:"connectionTypes,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#connectionTypesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ConnectionTypes") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ConnectionTypesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod ConnectionTypesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ContentCategoriesListResponse: Content Category List Response
-type ContentCategoriesListResponse struct {
- // ContentCategories: Content category collection.
- ContentCategories []*ContentCategory `json:"contentCategories,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#contentCategoriesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ContentCategories")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ContentCategoriesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod ContentCategoriesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ContentCategory: Organizes placements according to the contents of
-// their associated webpages.
-type ContentCategory struct {
- // AccountId: Account ID of this content category. This is a read-only
- // field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Id: ID of this content category. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#contentCategory".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this content category. This is a required field and
- // must be less than 256 characters long and unique among content
- // categories of the same account.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ContentCategory) MarshalJSON() ([]byte, error) {
- type noMethod ContentCategory
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CountriesListResponse: Country List Response
-type CountriesListResponse struct {
- // Countries: Country collection.
- Countries []*Country `json:"countries,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#countriesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Countries") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CountriesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod CountriesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Country: Contains information about a country that can be targeted by
-// ads.
-type Country struct {
- // CountryCode: Country code.
- CountryCode string `json:"countryCode,omitempty"`
-
- // DartId: DART ID of this country. This is the ID used for targeting
- // and generating reports.
- DartId int64 `json:"dartId,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#country".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this country.
- Name string `json:"name,omitempty"`
-
- // SslEnabled: Whether ad serving supports secure servers in this
- // country.
- SslEnabled bool `json:"sslEnabled,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CountryCode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Country) MarshalJSON() ([]byte, error) {
- type noMethod Country
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Creative: Contains properties of a Creative.
-type Creative struct {
- // AccountId: Account ID of this creative. This field, if left unset,
- // will be auto-generated for both insert and update operations.
- // Applicable to all creative types.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Active: Whether the creative is active. Applicable to all creative
- // types.
- Active bool `json:"active,omitempty"`
-
- // AdParameters: Ad parameters user for VPAID creative. This is a
- // read-only field. Applicable to the following creative types: all
- // VPAID.
- AdParameters string `json:"adParameters,omitempty"`
-
- // AdTagKeys: Keywords for a Rich Media creative. Keywords let you
- // customize the creative settings of a Rich Media ad running on your
- // site without having to contact the advertiser. You can use keywords
- // to dynamically change the look or functionality of a creative.
- // Applicable to the following creative types: all RICH_MEDIA, and all
- // VPAID.
- AdTagKeys []string `json:"adTagKeys,omitempty"`
-
- // AdvertiserId: Advertiser ID of this creative. This is a required
- // field. Applicable to all creative types.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AllowScriptAccess: Whether script access is allowed for this
- // creative. This is a read-only and deprecated field which will
- // automatically be set to true on update. Applicable to the following
- // creative types: FLASH_INPAGE.
- AllowScriptAccess bool `json:"allowScriptAccess,omitempty"`
-
- // Archived: Whether the creative is archived. Applicable to all
- // creative types.
- Archived bool `json:"archived,omitempty"`
-
- // ArtworkType: Type of artwork used for the creative. This is a
- // read-only field. Applicable to the following creative types: all
- // RICH_MEDIA, and all VPAID.
- //
- // Possible values:
- // "ARTWORK_TYPE_FLASH"
- // "ARTWORK_TYPE_HTML5"
- // "ARTWORK_TYPE_MIXED"
- ArtworkType string `json:"artworkType,omitempty"`
-
- // AuthoringTool: Authoring tool for HTML5 banner creatives. This is a
- // read-only field. Applicable to the following creative types:
- // HTML5_BANNER.
- //
- // Possible values:
- // "NINJA"
- // "SWIFFY"
- AuthoringTool string `json:"authoringTool,omitempty"`
-
- // AutoAdvanceImages: Whether images are automatically advanced for
- // enhanced image creatives. Applicable to the following creative types:
- // ENHANCED_IMAGE.
- AutoAdvanceImages bool `json:"auto_advance_images,omitempty"`
-
- // BackgroundColor: The 6-character HTML color code, beginning with #,
- // for the background of the window area where the Flash file is
- // displayed. Default is white. Applicable to the following creative
- // types: FLASH_INPAGE.
- BackgroundColor string `json:"backgroundColor,omitempty"`
-
- // BackupImageClickThroughUrl: Click-through URL for backup image.
- // Applicable to the following creative types: ENHANCED_BANNER,
- // FLASH_INPAGE, and HTML5_BANNER.
- BackupImageClickThroughUrl string `json:"backupImageClickThroughUrl,omitempty"`
-
- // BackupImageFeatures: List of feature dependencies that will cause a
- // backup image to be served if the browser that serves the ad does not
- // support them. Feature dependencies are features that a browser must
- // be able to support in order to render your HTML5 creative asset
- // correctly. This field is initially auto-generated to contain all
- // features detected by DCM for all the assets of this creative and can
- // then be modified by the client. To reset this field, copy over all
- // the creativeAssets' detected features. Applicable to the following
- // creative types: ENHANCED_BANNER and HTML5_BANNER.
- //
- // Possible values:
- // "APPLICATION_CACHE"
- // "AUDIO"
- // "CANVAS"
- // "CANVAS_TEXT"
- // "CSS_ANIMATIONS"
- // "CSS_BACKGROUND_SIZE"
- // "CSS_BORDER_IMAGE"
- // "CSS_BORDER_RADIUS"
- // "CSS_BOX_SHADOW"
- // "CSS_COLUMNS"
- // "CSS_FLEX_BOX"
- // "CSS_FONT_FACE"
- // "CSS_GENERATED_CONTENT"
- // "CSS_GRADIENTS"
- // "CSS_HSLA"
- // "CSS_MULTIPLE_BGS"
- // "CSS_OPACITY"
- // "CSS_REFLECTIONS"
- // "CSS_RGBA"
- // "CSS_TEXT_SHADOW"
- // "CSS_TRANSFORMS"
- // "CSS_TRANSFORMS3D"
- // "CSS_TRANSITIONS"
- // "DRAG_AND_DROP"
- // "GEO_LOCATION"
- // "HASH_CHANGE"
- // "HISTORY"
- // "INDEXED_DB"
- // "INLINE_SVG"
- // "INPUT_ATTR_AUTOCOMPLETE"
- // "INPUT_ATTR_AUTOFOCUS"
- // "INPUT_ATTR_LIST"
- // "INPUT_ATTR_MAX"
- // "INPUT_ATTR_MIN"
- // "INPUT_ATTR_MULTIPLE"
- // "INPUT_ATTR_PATTERN"
- // "INPUT_ATTR_PLACEHOLDER"
- // "INPUT_ATTR_REQUIRED"
- // "INPUT_ATTR_STEP"
- // "INPUT_TYPE_COLOR"
- // "INPUT_TYPE_DATE"
- // "INPUT_TYPE_DATETIME"
- // "INPUT_TYPE_DATETIME_LOCAL"
- // "INPUT_TYPE_EMAIL"
- // "INPUT_TYPE_MONTH"
- // "INPUT_TYPE_NUMBER"
- // "INPUT_TYPE_RANGE"
- // "INPUT_TYPE_SEARCH"
- // "INPUT_TYPE_TEL"
- // "INPUT_TYPE_TIME"
- // "INPUT_TYPE_URL"
- // "INPUT_TYPE_WEEK"
- // "LOCAL_STORAGE"
- // "POST_MESSAGE"
- // "SESSION_STORAGE"
- // "SMIL"
- // "SVG_CLIP_PATHS"
- // "SVG_FE_IMAGE"
- // "SVG_FILTERS"
- // "SVG_HREF"
- // "TOUCH"
- // "VIDEO"
- // "WEBGL"
- // "WEB_SOCKETS"
- // "WEB_SQL_DATABASE"
- // "WEB_WORKERS"
- BackupImageFeatures []string `json:"backupImageFeatures,omitempty"`
-
- // BackupImageReportingLabel: Reporting label used for HTML5 banner
- // backup image. Applicable to the following creative types:
- // ENHANCED_BANNER.
- BackupImageReportingLabel string `json:"backupImageReportingLabel,omitempty"`
-
- // BackupImageTargetWindow: Target window for backup image. Applicable
- // to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and
- // HTML5_BANNER.
- BackupImageTargetWindow *TargetWindow `json:"backupImageTargetWindow,omitempty"`
-
- // ClickTags: Click tags of the creative. For ENHANCED_BANNER,
- // FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of
- // detected click tags for the assets associated with this creative.
- // After creating a flash asset, detected click tags will be returned in
- // the creativeAssetMetadata. When inserting the creative, populate the
- // creative clickTags field using the creativeAssetMetadata.clickTags
- // field. For ENHANCED_IMAGE creatives, there should be exactly one
- // entry in this list for each image creative asset. A click tag is
- // matched with a corresponding creative asset by matching the
- // clickTag.name field with the creativeAsset.assetIdentifier.name
- // field. Applicable to the following creative types: ENHANCED_BANNER,
- // ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
- ClickTags []*ClickTag `json:"clickTags,omitempty"`
-
- // CommercialId: Industry standard ID assigned to creative for reach and
- // frequency. Applicable to the following creative types: INSTREAM_VIDEO
- // and all VPAID.
- CommercialId string `json:"commercialId,omitempty"`
-
- // CompanionCreatives: List of companion creatives assigned to an
- // in-Stream videocreative. Acceptable values include IDs of existing
- // flash and image creatives. Applicable to the following creative
- // types: INSTREAM_VIDEO and all VPAID.
- CompanionCreatives googleapi.Int64s `json:"companionCreatives,omitempty"`
-
- // Compatibility: Compatibilities associated with this creative. This is
- // a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either
- // on desktop or on mobile devices for regular or interstitial ads,
- // respectively. APP and APP_INTERSTITIAL are for rendering in mobile
- // apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads
- // developed with the VAST standard. Applicable to all creative
- // types.
- //
- // Acceptable values are:
- // - "APP"
- // - "APP_INTERSTITIAL"
- // - "IN_STREAM_VIDEO"
- // - "WEB"
- // - "WEB_INTERSTITIAL"
- //
- // Possible values:
- // "APP"
- // "APP_INTERSTITIAL"
- // "IN_STREAM_VIDEO"
- // "WEB"
- // "WEB_INTERSTITIAL"
- Compatibility []string `json:"compatibility,omitempty"`
-
- // ConvertFlashToHtml5: Whether Flash assets associated with the
- // creative need to be automatically converted to HTML5. This flag is
- // enabled by default and users can choose to disable it if they don't
- // want the system to generate and use HTML5 asset for this creative.
- // Applicable to the following creative types: ENHANCED_BANNER and
- // FLASH_INPAGE.
- ConvertFlashToHtml5 bool `json:"convertFlashToHtml5,omitempty"`
-
- // CounterCustomEvents: List of counter events configured for the
- // creative. Applicable to the following creative types: all RICH_MEDIA,
- // and all VPAID.
- CounterCustomEvents []*CreativeCustomEvent `json:"counterCustomEvents,omitempty"`
-
- // CreativeAssets: Assets associated with a creative. Applicable to all
- // but the following creative types: INTERNAL_REDIRECT,
- // INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- CreativeAssets []*CreativeAsset `json:"creativeAssets,omitempty"`
-
- // CreativeFieldAssignments: Creative field assignments for this
- // creative. Applicable to all creative types.
- CreativeFieldAssignments []*CreativeFieldAssignment `json:"creativeFieldAssignments,omitempty"`
-
- // CustomKeyValues: Custom key-values for a Rich Media creative.
- // Key-values let you customize the creative settings of a Rich Media ad
- // running on your site without having to contact the advertiser. You
- // can use key-values to dynamically change the look or functionality of
- // a creative. Applicable to the following creative types: all
- // RICH_MEDIA, and all VPAID.
- CustomKeyValues []string `json:"customKeyValues,omitempty"`
-
- // ExitCustomEvents: List of exit events configured for the creative.
- // Applicable to the following creative types: all RICH_MEDIA, and all
- // VPAID.
- ExitCustomEvents []*CreativeCustomEvent `json:"exitCustomEvents,omitempty"`
-
- // FsCommand: OpenWindow FSCommand of this creative. This lets the SWF
- // file communicate with either Flash Player or the program hosting
- // Flash Player, such as a web browser. This is only triggered if
- // allowScriptAccess field is true. Applicable to the following creative
- // types: FLASH_INPAGE.
- FsCommand *FsCommand `json:"fsCommand,omitempty"`
-
- // HtmlCode: HTML code for the creative. This is a required field when
- // applicable. This field is ignored if htmlCodeLocked is false.
- // Applicable to the following creative types: all CUSTOM, FLASH_INPAGE,
- // and HTML5_BANNER, and all RICH_MEDIA.
- HtmlCode string `json:"htmlCode,omitempty"`
-
- // HtmlCodeLocked: Whether HTML code is DCM-generated or manually
- // entered. Set to true to ignore changes to htmlCode. Applicable to the
- // following creative types: FLASH_INPAGE and HTML5_BANNER.
- HtmlCodeLocked bool `json:"htmlCodeLocked,omitempty"`
-
- // Id: ID of this creative. This is a read-only, auto-generated field.
- // Applicable to all creative types.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this creative. This
- // is a read-only field. Applicable to all creative types.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#creative".
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedInfo: Creative last modification information. This is a
- // read-only field. Applicable to all creative types.
- LastModifiedInfo *LastModifiedInfo `json:"lastModifiedInfo,omitempty"`
-
- // LatestTraffickedCreativeId: Latest Studio trafficked creative ID
- // associated with rich media and VPAID creatives. This is a read-only
- // field. Applicable to the following creative types: all RICH_MEDIA,
- // and all VPAID.
- LatestTraffickedCreativeId int64 `json:"latestTraffickedCreativeId,omitempty,string"`
-
- // Name: Name of the creative. This is a required field and must be less
- // than 256 characters long. Applicable to all creative types.
- Name string `json:"name,omitempty"`
-
- // OverrideCss: Override CSS value for rich media creatives. Applicable
- // to the following creative types: all RICH_MEDIA.
- OverrideCss string `json:"overrideCss,omitempty"`
-
- // RedirectUrl: URL of hosted image or another ad tag. This is a
- // required field when applicable. Applicable to the following creative
- // types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and
- // REDIRECT
- RedirectUrl string `json:"redirectUrl,omitempty"`
-
- // RenderingId: ID of current rendering version. This is a read-only
- // field. Applicable to all creative types.
- RenderingId int64 `json:"renderingId,omitempty,string"`
-
- // RenderingIdDimensionValue: Dimension value for the rendering ID of
- // this creative. This is a read-only field. Applicable to all creative
- // types.
- RenderingIdDimensionValue *DimensionValue `json:"renderingIdDimensionValue,omitempty"`
-
- // RequiredFlashPluginVersion: The minimum required Flash plugin version
- // for this creative. For example, 11.2.202.235. This is a read-only
- // field. Applicable to the following creative types: all RICH_MEDIA,
- // and all VPAID.
- RequiredFlashPluginVersion string `json:"requiredFlashPluginVersion,omitempty"`
-
- // RequiredFlashVersion: The internal Flash version for this creative as
- // calculated by DoubleClick Studio. This is a read-only field.
- // Applicable to the following creative types: FLASH_INPAGE,
- // ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- RequiredFlashVersion int64 `json:"requiredFlashVersion,omitempty"`
-
- // Size: Size associated with this creative. When inserting or updating
- // a creative either the size ID field or size width and height fields
- // can be used. This is a required field when applicable; however for
- // IMAGE and FLASH_INPAGE creatives, if left blank, this field will be
- // automatically set using the actual size of the associated image
- // assets. Applicable to the following creative types: ENHANCED_BANNER,
- // ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all
- // RICH_MEDIA.
- Size *Size `json:"size,omitempty"`
-
- // Skippable: Whether the user can choose to skip the creative.
- // Applicable to the following creative types: INSTREAM_VIDEO.
- Skippable bool `json:"skippable,omitempty"`
-
- // SslCompliant: Whether the creative is SSL-compliant. This is a
- // read-only field. Applicable to all creative types.
- SslCompliant bool `json:"sslCompliant,omitempty"`
-
- // StudioAdvertiserId: Studio advertiser ID associated with rich media
- // and VPAID creatives. This is a read-only field. Applicable to the
- // following creative types: all RICH_MEDIA, and all VPAID.
- StudioAdvertiserId int64 `json:"studioAdvertiserId,omitempty,string"`
-
- // StudioCreativeId: Studio creative ID associated with rich media and
- // VPAID creatives. This is a read-only field. Applicable to the
- // following creative types: all RICH_MEDIA, and all VPAID.
- StudioCreativeId int64 `json:"studioCreativeId,omitempty,string"`
-
- // StudioTraffickedCreativeId: Studio trafficked creative ID associated
- // with rich media and VPAID creatives. This is a read-only field.
- // Applicable to the following creative types: all RICH_MEDIA, and all
- // VPAID.
- StudioTraffickedCreativeId int64 `json:"studioTraffickedCreativeId,omitempty,string"`
-
- // SubaccountId: Subaccount ID of this creative. This field, if left
- // unset, will be auto-generated for both insert and update operations.
- // Applicable to all creative types.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // ThirdPartyBackupImageImpressionsUrl: Third-party URL used to record
- // backup image impressions. Applicable to the following creative types:
- // all RICH_MEDIA
- ThirdPartyBackupImageImpressionsUrl string `json:"thirdPartyBackupImageImpressionsUrl,omitempty"`
-
- // ThirdPartyRichMediaImpressionsUrl: Third-party URL used to record
- // rich media impressions. Applicable to the following creative types:
- // all RICH_MEDIA
- ThirdPartyRichMediaImpressionsUrl string `json:"thirdPartyRichMediaImpressionsUrl,omitempty"`
-
- // ThirdPartyUrls: Third-party URLs for tracking in-stream video
- // creative events. Applicable to the following creative types:
- // INSTREAM_VIDEO and all VPAID.
- ThirdPartyUrls []*ThirdPartyTrackingUrl `json:"thirdPartyUrls,omitempty"`
-
- // TimerCustomEvents: List of timer events configured for the creative.
- // Applicable to the following creative types: all RICH_MEDIA, and all
- // VPAID.
- TimerCustomEvents []*CreativeCustomEvent `json:"timerCustomEvents,omitempty"`
-
- // TotalFileSize: Combined size of all creative assets. This is a
- // read-only field. Applicable to the following creative types: all
- // RICH_MEDIA, and all VPAID.
- TotalFileSize int64 `json:"totalFileSize,omitempty,string"`
-
- // Type: Type of this creative.This is a required field. Applicable to
- // all creative types.
- //
- // Possible values:
- // "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO"
- // "CUSTOM_INPAGE"
- // "CUSTOM_INTERSTITIAL"
- // "ENHANCED_BANNER"
- // "ENHANCED_IMAGE"
- // "FLASH_INPAGE"
- // "HTML5_BANNER"
- // "IMAGE"
- // "INSTREAM_VIDEO"
- // "INTERNAL_REDIRECT"
- // "INTERSTITIAL_INTERNAL_REDIRECT"
- // "REDIRECT"
- // "RICH_MEDIA_EXPANDING"
- // "RICH_MEDIA_IM_EXPAND"
- // "RICH_MEDIA_INPAGE"
- // "RICH_MEDIA_INPAGE_FLOATING"
- // "RICH_MEDIA_INTERSTITIAL_FLOAT"
- // "RICH_MEDIA_MOBILE_IN_APP"
- // "RICH_MEDIA_MULTI_FLOATING"
- // "RICH_MEDIA_PEEL_DOWN"
- // "TRACKING_TEXT"
- // "VAST_REDIRECT"
- // "VPAID_LINEAR"
- // "VPAID_NON_LINEAR"
- Type string `json:"type,omitempty"`
-
- // Version: The version number helps you keep track of multiple versions
- // of your creative in your reports. The version number will always be
- // auto-generated during insert operations to start at 1. For tracking
- // creatives the version cannot be incremented and will always remain at
- // 1. For all other creative types the version can be incremented only
- // by 1 during update operations. In addition, the version will be
- // automatically incremented by 1 when undergoing Rich Media creative
- // merging. Applicable to all creative types.
- Version int64 `json:"version,omitempty"`
-
- // VideoDescription: Description of the video ad. Applicable to the
- // following creative types: INSTREAM_VIDEO and all VPAID.
- VideoDescription string `json:"videoDescription,omitempty"`
-
- // VideoDuration: Creative video duration in seconds. This is a
- // read-only field. Applicable to the following creative types:
- // INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
- VideoDuration float64 `json:"videoDuration,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Creative) MarshalJSON() ([]byte, error) {
- type noMethod Creative
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeAsset: Creative Asset.
-type CreativeAsset struct {
- // ActionScript3: Whether ActionScript3 is enabled for the flash asset.
- // This is a read-only field. Applicable to the following creative
- // types: FLASH_INPAGE and ENHANCED_BANNER.
- ActionScript3 bool `json:"actionScript3,omitempty"`
-
- // Active: Whether the video asset is active. This is a read-only field
- // for VPAID_NON_LINEAR assets. Applicable to the following creative
- // types: INSTREAM_VIDEO and all VPAID.
- Active bool `json:"active,omitempty"`
-
- // Alignment: Possible alignments for an asset. This is a read-only
- // field. Applicable to the following creative types:
- // RICH_MEDIA_MULTI_FLOATING.
- //
- // Possible values:
- // "ALIGNMENT_BOTTOM"
- // "ALIGNMENT_LEFT"
- // "ALIGNMENT_RIGHT"
- // "ALIGNMENT_TOP"
- Alignment string `json:"alignment,omitempty"`
-
- // ArtworkType: Artwork type of rich media creative. This is a read-only
- // field. Applicable to the following creative types: all RICH_MEDIA.
- //
- // Possible values:
- // "ARTWORK_TYPE_FLASH"
- // "ARTWORK_TYPE_HTML5"
- // "ARTWORK_TYPE_MIXED"
- ArtworkType string `json:"artworkType,omitempty"`
-
- // AssetIdentifier: Identifier of this asset. This is the same
- // identifier returned during creative asset insert operation. This is a
- // required field. Applicable to all but the following creative types:
- // all REDIRECT and TRACKING_TEXT.
- AssetIdentifier *CreativeAssetId `json:"assetIdentifier,omitempty"`
-
- // BackupImageExit: Exit event configured for the backup image.
- // Applicable to the following creative types: all RICH_MEDIA.
- BackupImageExit *CreativeCustomEvent `json:"backupImageExit,omitempty"`
-
- // BitRate: Detected bit-rate for video asset. This is a read-only
- // field. Applicable to the following creative types: INSTREAM_VIDEO and
- // all VPAID.
- BitRate int64 `json:"bitRate,omitempty"`
-
- // ChildAssetType: Rich media child asset type. This is a read-only
- // field. Applicable to the following creative types: all VPAID.
- //
- // Possible values:
- // "CHILD_ASSET_TYPE_DATA"
- // "CHILD_ASSET_TYPE_FLASH"
- // "CHILD_ASSET_TYPE_IMAGE"
- // "CHILD_ASSET_TYPE_VIDEO"
- ChildAssetType string `json:"childAssetType,omitempty"`
-
- // CollapsedSize: Size of an asset when collapsed. This is a read-only
- // field. Applicable to the following creative types: all RICH_MEDIA and
- // all VPAID. Additionally, applicable to assets whose displayType is
- // ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- CollapsedSize *Size `json:"collapsedSize,omitempty"`
-
- // CustomStartTimeValue: Custom start time in seconds for making the
- // asset visible. Applicable to the following creative types: all
- // RICH_MEDIA.
- CustomStartTimeValue int64 `json:"customStartTimeValue,omitempty"`
-
- // DetectedFeatures: List of feature dependencies for the creative asset
- // that are detected by DCM. Feature dependencies are features that a
- // browser must be able to support in order to render your HTML5
- // creative correctly. This is a read-only, auto-generated field.
- // Applicable to the following creative types: ENHANCED_BANNER and
- // HTML5_BANNER.
- //
- // Possible values:
- // "APPLICATION_CACHE"
- // "AUDIO"
- // "CANVAS"
- // "CANVAS_TEXT"
- // "CSS_ANIMATIONS"
- // "CSS_BACKGROUND_SIZE"
- // "CSS_BORDER_IMAGE"
- // "CSS_BORDER_RADIUS"
- // "CSS_BOX_SHADOW"
- // "CSS_COLUMNS"
- // "CSS_FLEX_BOX"
- // "CSS_FONT_FACE"
- // "CSS_GENERATED_CONTENT"
- // "CSS_GRADIENTS"
- // "CSS_HSLA"
- // "CSS_MULTIPLE_BGS"
- // "CSS_OPACITY"
- // "CSS_REFLECTIONS"
- // "CSS_RGBA"
- // "CSS_TEXT_SHADOW"
- // "CSS_TRANSFORMS"
- // "CSS_TRANSFORMS3D"
- // "CSS_TRANSITIONS"
- // "DRAG_AND_DROP"
- // "GEO_LOCATION"
- // "HASH_CHANGE"
- // "HISTORY"
- // "INDEXED_DB"
- // "INLINE_SVG"
- // "INPUT_ATTR_AUTOCOMPLETE"
- // "INPUT_ATTR_AUTOFOCUS"
- // "INPUT_ATTR_LIST"
- // "INPUT_ATTR_MAX"
- // "INPUT_ATTR_MIN"
- // "INPUT_ATTR_MULTIPLE"
- // "INPUT_ATTR_PATTERN"
- // "INPUT_ATTR_PLACEHOLDER"
- // "INPUT_ATTR_REQUIRED"
- // "INPUT_ATTR_STEP"
- // "INPUT_TYPE_COLOR"
- // "INPUT_TYPE_DATE"
- // "INPUT_TYPE_DATETIME"
- // "INPUT_TYPE_DATETIME_LOCAL"
- // "INPUT_TYPE_EMAIL"
- // "INPUT_TYPE_MONTH"
- // "INPUT_TYPE_NUMBER"
- // "INPUT_TYPE_RANGE"
- // "INPUT_TYPE_SEARCH"
- // "INPUT_TYPE_TEL"
- // "INPUT_TYPE_TIME"
- // "INPUT_TYPE_URL"
- // "INPUT_TYPE_WEEK"
- // "LOCAL_STORAGE"
- // "POST_MESSAGE"
- // "SESSION_STORAGE"
- // "SMIL"
- // "SVG_CLIP_PATHS"
- // "SVG_FE_IMAGE"
- // "SVG_FILTERS"
- // "SVG_HREF"
- // "TOUCH"
- // "VIDEO"
- // "WEBGL"
- // "WEB_SOCKETS"
- // "WEB_SQL_DATABASE"
- // "WEB_WORKERS"
- DetectedFeatures []string `json:"detectedFeatures,omitempty"`
-
- // DisplayType: Type of rich media asset. This is a read-only field.
- // Applicable to the following creative types: all RICH_MEDIA.
- //
- // Possible values:
- // "ASSET_DISPLAY_TYPE_EXPANDING"
- // "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH"
- // "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH_EXPANDING"
- // "ASSET_DISPLAY_TYPE_FLOATING"
- // "ASSET_DISPLAY_TYPE_INPAGE"
- // "ASSET_DISPLAY_TYPE_OVERLAY"
- // "ASSET_DISPLAY_TYPE_PEEL_DOWN"
- // "ASSET_DISPLAY_TYPE_VPAID_LINEAR"
- // "ASSET_DISPLAY_TYPE_VPAID_NON_LINEAR"
- DisplayType string `json:"displayType,omitempty"`
-
- // Duration: Duration in seconds for which an asset will be displayed.
- // Applicable to the following creative types: INSTREAM_VIDEO and
- // VPAID_LINEAR.
- Duration int64 `json:"duration,omitempty"`
-
- // DurationType: Duration type for which an asset will be displayed.
- // Applicable to the following creative types: all RICH_MEDIA.
- //
- // Possible values:
- // "ASSET_DURATION_TYPE_AUTO"
- // "ASSET_DURATION_TYPE_CUSTOM"
- // "ASSET_DURATION_TYPE_NONE"
- DurationType string `json:"durationType,omitempty"`
-
- // ExpandedDimension: Detected expanded dimension for video asset. This
- // is a read-only field. Applicable to the following creative types:
- // INSTREAM_VIDEO and all VPAID.
- ExpandedDimension *Size `json:"expandedDimension,omitempty"`
-
- // FileSize: File size associated with this creative asset. This is a
- // read-only field. Applicable to all but the following creative types:
- // all REDIRECT and TRACKING_TEXT.
- FileSize int64 `json:"fileSize,omitempty,string"`
-
- // FlashVersion: Flash version of the asset. This is a read-only field.
- // Applicable to the following creative types: FLASH_INPAGE,
- // ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- FlashVersion int64 `json:"flashVersion,omitempty"`
-
- // HideFlashObjects: Whether to hide Flash objects flag for an asset.
- // Applicable to the following creative types: all RICH_MEDIA.
- HideFlashObjects bool `json:"hideFlashObjects,omitempty"`
-
- // HideSelectionBoxes: Whether to hide selection boxes flag for an
- // asset. Applicable to the following creative types: all RICH_MEDIA.
- HideSelectionBoxes bool `json:"hideSelectionBoxes,omitempty"`
-
- // HorizontallyLocked: Whether the asset is horizontally locked. This is
- // a read-only field. Applicable to the following creative types: all
- // RICH_MEDIA.
- HorizontallyLocked bool `json:"horizontallyLocked,omitempty"`
-
- // Id: Numeric ID of this creative asset. This is a required field and
- // should not be modified. Applicable to all but the following creative
- // types: all REDIRECT and TRACKING_TEXT.
- Id int64 `json:"id,omitempty,string"`
-
- // MimeType: Detected MIME type for video asset. This is a read-only
- // field. Applicable to the following creative types: INSTREAM_VIDEO and
- // all VPAID.
- MimeType string `json:"mimeType,omitempty"`
-
- // Offset: Offset position for an asset in collapsed mode. This is a
- // read-only field. Applicable to the following creative types: all
- // RICH_MEDIA and all VPAID. Additionally, only applicable to assets
- // whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or
- // ASSET_DISPLAY_TYPE_PEEL_DOWN.
- Offset *OffsetPosition `json:"offset,omitempty"`
-
- // OriginalBackup: Whether the backup asset is original or changed by
- // the user in DCM. Applicable to the following creative types: all
- // RICH_MEDIA.
- OriginalBackup bool `json:"originalBackup,omitempty"`
-
- // Position: Offset position for an asset. Applicable to the following
- // creative types: all RICH_MEDIA.
- Position *OffsetPosition `json:"position,omitempty"`
-
- // PositionLeftUnit: Offset left unit for an asset. This is a read-only
- // field. Applicable to the following creative types: all RICH_MEDIA.
- //
- // Possible values:
- // "OFFSET_UNIT_PERCENT"
- // "OFFSET_UNIT_PIXEL"
- // "OFFSET_UNIT_PIXEL_FROM_CENTER"
- PositionLeftUnit string `json:"positionLeftUnit,omitempty"`
-
- // PositionTopUnit: Offset top unit for an asset. This is a read-only
- // field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY.
- // Applicable to the following creative types: all RICH_MEDIA.
- //
- // Possible values:
- // "OFFSET_UNIT_PERCENT"
- // "OFFSET_UNIT_PIXEL"
- // "OFFSET_UNIT_PIXEL_FROM_CENTER"
- PositionTopUnit string `json:"positionTopUnit,omitempty"`
-
- // ProgressiveServingUrl: Progressive URL for video asset. This is a
- // read-only field. Applicable to the following creative types:
- // INSTREAM_VIDEO and all VPAID.
- ProgressiveServingUrl string `json:"progressiveServingUrl,omitempty"`
-
- // Pushdown: Whether the asset pushes down other content. Applicable to
- // the following creative types: all RICH_MEDIA. Additionally, only
- // applicable when the asset offsets are 0, the collapsedSize.width
- // matches size.width, and the collapsedSize.height is less than
- // size.height.
- Pushdown bool `json:"pushdown,omitempty"`
-
- // PushdownDuration: Pushdown duration in seconds for an asset. Must be
- // between 0 and 9.99. Applicable to the following creative types: all
- // RICH_MEDIA.Additionally, only applicable when the asset pushdown
- // field is true, the offsets are 0, the collapsedSize.width matches
- // size.width, and the collapsedSize.height is less than size.height.
- PushdownDuration float64 `json:"pushdownDuration,omitempty"`
-
- // Role: Role of the asset in relation to creative. Applicable to all
- // but the following creative types: all REDIRECT and TRACKING_TEXT.
- // This is a required field.
- // PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER,
- // IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple
- // primary assets), and all VPAID creatives.
- // BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER,
- // all RICH_MEDIA, and all VPAID creatives.
- // ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE
- // creatives.
- // OTHER refers to assets from sources other than DCM, such as Studio
- // uploaded assets, applicable to all RICH_MEDIA and all VPAID
- // creatives.
- // PARENT_VIDEO refers to videos uploaded by the user in DCM and is
- // applicable to INSTREAM_VIDEO and VPAID_LINEAR
- // creatives.
- // TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO
- // assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR
- // creatives.
- // ALTERNATE_VIDEO refers to the DCM representation of child asset
- // videos from Studio, and is applicable to VPAID_LINEAR creatives.
- // These cannot be added or removed within DCM.
- // For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and
- // ALTERNATE_VIDEO assets that are marked active serve as backup in case
- // the VPAID creative cannot be served. Only PARENT_VIDEO assets can be
- // added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
- //
- // Possible values:
- // "ADDITIONAL_FLASH"
- // "ADDITIONAL_IMAGE"
- // "ALTERNATE_VIDEO"
- // "BACKUP_IMAGE"
- // "OTHER"
- // "PARENT_VIDEO"
- // "PRIMARY"
- // "TRANSCODED_VIDEO"
- Role string `json:"role,omitempty"`
-
- // Size: Size associated with this creative asset. This is a required
- // field when applicable; however for IMAGE and FLASH_INPAGE creatives,
- // if left blank, this field will be automatically set using the actual
- // size of the associated image asset. Applicable to the following
- // creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE,
- // HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- Size *Size `json:"size,omitempty"`
-
- // SslCompliant: Whether the asset is SSL-compliant. This is a read-only
- // field. Applicable to all but the following creative types: all
- // REDIRECT and TRACKING_TEXT.
- SslCompliant bool `json:"sslCompliant,omitempty"`
-
- // StartTimeType: Initial wait time type before making the asset
- // visible. Applicable to the following creative types: all RICH_MEDIA.
- //
- // Possible values:
- // "ASSET_START_TIME_TYPE_CUSTOM"
- // "ASSET_START_TIME_TYPE_NONE"
- StartTimeType string `json:"startTimeType,omitempty"`
-
- // StreamingServingUrl: Streaming URL for video asset. This is a
- // read-only field. Applicable to the following creative types:
- // INSTREAM_VIDEO and all VPAID.
- StreamingServingUrl string `json:"streamingServingUrl,omitempty"`
-
- // Transparency: Whether the asset is transparent. Applicable to the
- // following creative types: all RICH_MEDIA. Additionally, only
- // applicable to HTML5 assets.
- Transparency bool `json:"transparency,omitempty"`
-
- // VerticallyLocked: Whether the asset is vertically locked. This is a
- // read-only field. Applicable to the following creative types: all
- // RICH_MEDIA.
- VerticallyLocked bool `json:"verticallyLocked,omitempty"`
-
- // VideoDuration: Detected video duration for video asset. This is a
- // read-only field. Applicable to the following creative types:
- // INSTREAM_VIDEO and all VPAID.
- VideoDuration float64 `json:"videoDuration,omitempty"`
-
- // WindowMode: Window mode options for flash assets. Applicable to the
- // following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING,
- // RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and
- // RICH_MEDIA_INPAGE_FLOATING.
- //
- // Possible values:
- // "OPAQUE"
- // "TRANSPARENT"
- // "WINDOW"
- WindowMode string `json:"windowMode,omitempty"`
-
- // ZIndex: zIndex value of an asset. This is a read-only field.
- // Applicable to the following creative types: all
- // RICH_MEDIA.Additionally, only applicable to assets whose displayType
- // is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or
- // ASSET_DISPLAY_TYPE_OVERLAY.
- ZIndex int64 `json:"zIndex,omitempty"`
-
- // ZipFilename: File name of zip file. This is a read-only field.
- // Applicable to the following creative types: HTML5_BANNER.
- ZipFilename string `json:"zipFilename,omitempty"`
-
- // ZipFilesize: Size of zip file. This is a read-only field. Applicable
- // to the following creative types: HTML5_BANNER.
- ZipFilesize string `json:"zipFilesize,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ActionScript3") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeAsset) MarshalJSON() ([]byte, error) {
- type noMethod CreativeAsset
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeAssetId: Creative Asset ID.
-type CreativeAssetId struct {
- // Name: Name of the creative asset. This is a required field while
- // inserting an asset. After insertion, this assetIdentifier is used to
- // identify the uploaded asset. Characters in the name must be
- // alphanumeric or one of the following: ".-_ ". Spaces are allowed.
- Name string `json:"name,omitempty"`
-
- // Type: Type of asset to upload. This is a required field. IMAGE is
- // solely used for IMAGE creatives. Other image assets should use
- // HTML_IMAGE.
- //
- // Possible values:
- // "FLASH"
- // "HTML"
- // "HTML_IMAGE"
- // "IMAGE"
- // "VIDEO"
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Name") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeAssetId) MarshalJSON() ([]byte, error) {
- type noMethod CreativeAssetId
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeAssetMetadata: CreativeAssets contains properties of a
-// creative asset file which will be uploaded or has already been
-// uploaded. Refer to the creative sample code for how to upload assets
-// and insert a creative.
-type CreativeAssetMetadata struct {
- // AssetIdentifier: ID of the creative asset. This is a required field.
- AssetIdentifier *CreativeAssetId `json:"assetIdentifier,omitempty"`
-
- // ClickTags: List of detected click tags for assets. This is a
- // read-only auto-generated field.
- ClickTags []*ClickTag `json:"clickTags,omitempty"`
-
- // DetectedFeatures: List of feature dependencies for the creative asset
- // that are detected by DCM. Feature dependencies are features that a
- // browser must be able to support in order to render your HTML5
- // creative correctly. This is a read-only, auto-generated field.
- //
- // Possible values:
- // "APPLICATION_CACHE"
- // "AUDIO"
- // "CANVAS"
- // "CANVAS_TEXT"
- // "CSS_ANIMATIONS"
- // "CSS_BACKGROUND_SIZE"
- // "CSS_BORDER_IMAGE"
- // "CSS_BORDER_RADIUS"
- // "CSS_BOX_SHADOW"
- // "CSS_COLUMNS"
- // "CSS_FLEX_BOX"
- // "CSS_FONT_FACE"
- // "CSS_GENERATED_CONTENT"
- // "CSS_GRADIENTS"
- // "CSS_HSLA"
- // "CSS_MULTIPLE_BGS"
- // "CSS_OPACITY"
- // "CSS_REFLECTIONS"
- // "CSS_RGBA"
- // "CSS_TEXT_SHADOW"
- // "CSS_TRANSFORMS"
- // "CSS_TRANSFORMS3D"
- // "CSS_TRANSITIONS"
- // "DRAG_AND_DROP"
- // "GEO_LOCATION"
- // "HASH_CHANGE"
- // "HISTORY"
- // "INDEXED_DB"
- // "INLINE_SVG"
- // "INPUT_ATTR_AUTOCOMPLETE"
- // "INPUT_ATTR_AUTOFOCUS"
- // "INPUT_ATTR_LIST"
- // "INPUT_ATTR_MAX"
- // "INPUT_ATTR_MIN"
- // "INPUT_ATTR_MULTIPLE"
- // "INPUT_ATTR_PATTERN"
- // "INPUT_ATTR_PLACEHOLDER"
- // "INPUT_ATTR_REQUIRED"
- // "INPUT_ATTR_STEP"
- // "INPUT_TYPE_COLOR"
- // "INPUT_TYPE_DATE"
- // "INPUT_TYPE_DATETIME"
- // "INPUT_TYPE_DATETIME_LOCAL"
- // "INPUT_TYPE_EMAIL"
- // "INPUT_TYPE_MONTH"
- // "INPUT_TYPE_NUMBER"
- // "INPUT_TYPE_RANGE"
- // "INPUT_TYPE_SEARCH"
- // "INPUT_TYPE_TEL"
- // "INPUT_TYPE_TIME"
- // "INPUT_TYPE_URL"
- // "INPUT_TYPE_WEEK"
- // "LOCAL_STORAGE"
- // "POST_MESSAGE"
- // "SESSION_STORAGE"
- // "SMIL"
- // "SVG_CLIP_PATHS"
- // "SVG_FE_IMAGE"
- // "SVG_FILTERS"
- // "SVG_HREF"
- // "TOUCH"
- // "VIDEO"
- // "WEBGL"
- // "WEB_SOCKETS"
- // "WEB_SQL_DATABASE"
- // "WEB_WORKERS"
- DetectedFeatures []string `json:"detectedFeatures,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#creativeAssetMetadata".
- Kind string `json:"kind,omitempty"`
-
- // WarnedValidationRules: Rules validated during code generation that
- // generated a warning. This is a read-only, auto-generated
- // field.
- //
- // Possible values are:
- // - "CLICK_TAG_NON_TOP_LEVEL"
- // - "CLICK_TAG_MISSING"
- // - "CLICK_TAG_MORE_THAN_ONE"
- // - "CLICK_TAG_INVALID"
- // - "ORPHANED_ASSET"
- // - "PRIMARY_HTML_MISSING"
- // - "EXTERNAL_FILE_REFERENCED"
- // - "MRAID_REFERENCED"
- // - "ADMOB_REFERENCED"
- // - "FILE_TYPE_INVALID"
- // - "ZIP_INVALID"
- // - "LINKED_FILE_NOT_FOUND"
- // - "MAX_FLASH_VERSION_11"
- // - "NOT_SSL_COMPLIANT"
- // - "FILE_DETAIL_EMPTY"
- // - "ASSET_INVALID"
- // - "GWD_PROPERTIES_INVALID"
- // - "ENABLER_UNSUPPORTED_METHOD_DCM"
- // - "ASSET_FORMAT_UNSUPPORTED_DCM"
- // - "COMPONENT_UNSUPPORTED_DCM"
- // - "HTML5_FEATURE_UNSUPPORTED' "
- //
- // Possible values:
- // "ADMOB_REFERENCED"
- // "ASSET_FORMAT_UNSUPPORTED_DCM"
- // "ASSET_INVALID"
- // "CLICK_TAG_INVALID"
- // "CLICK_TAG_MISSING"
- // "CLICK_TAG_MORE_THAN_ONE"
- // "CLICK_TAG_NON_TOP_LEVEL"
- // "COMPONENT_UNSUPPORTED_DCM"
- // "ENABLER_UNSUPPORTED_METHOD_DCM"
- // "EXTERNAL_FILE_REFERENCED"
- // "FILE_DETAIL_EMPTY"
- // "FILE_TYPE_INVALID"
- // "GWD_PROPERTIES_INVALID"
- // "HTML5_FEATURE_UNSUPPORTED"
- // "LINKED_FILE_NOT_FOUND"
- // "MAX_FLASH_VERSION_11"
- // "MRAID_REFERENCED"
- // "NOT_SSL_COMPLIANT"
- // "ORPHANED_ASSET"
- // "PRIMARY_HTML_MISSING"
- // "ZIP_INVALID"
- WarnedValidationRules []string `json:"warnedValidationRules,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AssetIdentifier") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeAssetMetadata) MarshalJSON() ([]byte, error) {
- type noMethod CreativeAssetMetadata
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeAssignment: Creative Assignment.
-type CreativeAssignment struct {
- // Active: Whether this creative assignment is active. When true, the
- // creative will be included in the ad's rotation.
- Active bool `json:"active,omitempty"`
-
- // ApplyEventTags: Whether applicable event tags should fire when this
- // creative assignment is rendered. If this value is unset when the ad
- // is inserted or updated, it will default to true for all creative
- // types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT,
- // and INSTREAM_VIDEO.
- ApplyEventTags bool `json:"applyEventTags,omitempty"`
-
- // ClickThroughUrl: Click-through URL of the creative assignment.
- ClickThroughUrl *ClickThroughUrl `json:"clickThroughUrl,omitempty"`
-
- // CompanionCreativeOverrides: Companion creative overrides for this
- // creative assignment. Applicable to video ads.
- CompanionCreativeOverrides []*CompanionClickThroughOverride `json:"companionCreativeOverrides,omitempty"`
-
- // CreativeGroupAssignments: Creative group assignments for this
- // creative assignment. Only one assignment per creative group number is
- // allowed for a maximum of two assignments.
- CreativeGroupAssignments []*CreativeGroupAssignment `json:"creativeGroupAssignments,omitempty"`
-
- // CreativeId: ID of the creative to be assigned. This is a required
- // field.
- CreativeId int64 `json:"creativeId,omitempty,string"`
-
- // CreativeIdDimensionValue: Dimension value for the ID of the creative.
- // This is a read-only, auto-generated field.
- CreativeIdDimensionValue *DimensionValue `json:"creativeIdDimensionValue,omitempty"`
-
- // EndTime: Date and time that the assigned creative should stop
- // serving. Must be later than the start time.
- EndTime string `json:"endTime,omitempty"`
-
- // RichMediaExitOverrides: Rich media exit overrides for this creative
- // assignment.
- // Applicable when the creative type is any of the following:
- // - RICH_MEDIA_INPAGE
- // - RICH_MEDIA_INPAGE_FLOATING
- // - RICH_MEDIA_IM_EXPAND
- // - RICH_MEDIA_EXPANDING
- // - RICH_MEDIA_INTERSTITIAL_FLOAT
- // - RICH_MEDIA_MOBILE_IN_APP
- // - RICH_MEDIA_MULTI_FLOATING
- // - RICH_MEDIA_PEEL_DOWN
- // - ADVANCED_BANNER
- // - VPAID_LINEAR
- // - VPAID_NON_LINEAR
- RichMediaExitOverrides []*RichMediaExitOverride `json:"richMediaExitOverrides,omitempty"`
-
- // Sequence: Sequence number of the creative assignment, applicable when
- // the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
- Sequence int64 `json:"sequence,omitempty"`
-
- // SslCompliant: Whether the creative to be assigned is SSL-compliant.
- // This is a read-only field that is auto-generated when the ad is
- // inserted or updated.
- SslCompliant bool `json:"sslCompliant,omitempty"`
-
- // StartTime: Date and time that the assigned creative should start
- // serving.
- StartTime string `json:"startTime,omitempty"`
-
- // Weight: Weight of the creative assignment, applicable when the
- // rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
- Weight int64 `json:"weight,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Active") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeAssignment) MarshalJSON() ([]byte, error) {
- type noMethod CreativeAssignment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeCustomEvent: Creative Custom Event.
-type CreativeCustomEvent struct {
- // Active: Whether the event is active.
- Active bool `json:"active,omitempty"`
-
- // AdvertiserCustomEventName: User-entered name for the event.
- AdvertiserCustomEventName string `json:"advertiserCustomEventName,omitempty"`
-
- // AdvertiserCustomEventType: Type of the event. This is a read-only
- // field.
- //
- // Possible values:
- // "ADVERTISER_EVENT_COUNTER"
- // "ADVERTISER_EVENT_EXIT"
- // "ADVERTISER_EVENT_TIMER"
- AdvertiserCustomEventType string `json:"advertiserCustomEventType,omitempty"`
-
- // ArtworkLabel: Artwork label column, used to link events in DCM back
- // to events in Studio. This is a required field and should not be
- // modified after insertion.
- ArtworkLabel string `json:"artworkLabel,omitempty"`
-
- // ArtworkType: Artwork type used by the creative.This is a read-only
- // field.
- //
- // Possible values:
- // "ARTWORK_TYPE_FLASH"
- // "ARTWORK_TYPE_HTML5"
- // "ARTWORK_TYPE_MIXED"
- ArtworkType string `json:"artworkType,omitempty"`
-
- // ExitUrl: Exit URL of the event. This field is used only for exit
- // events.
- ExitUrl string `json:"exitUrl,omitempty"`
-
- // Id: ID of this event. This is a required field and should not be
- // modified after insertion.
- Id int64 `json:"id,omitempty,string"`
-
- // PopupWindowProperties: Properties for rich media popup windows. This
- // field is used only for exit events.
- PopupWindowProperties *PopupWindowProperties `json:"popupWindowProperties,omitempty"`
-
- // TargetType: Target type used by the event.
- //
- // Possible values:
- // "TARGET_BLANK"
- // "TARGET_PARENT"
- // "TARGET_POPUP"
- // "TARGET_SELF"
- // "TARGET_TOP"
- TargetType string `json:"targetType,omitempty"`
-
- // VideoReportingId: Reporting ID, used to differentiate multiple videos
- // in a single creative.
- VideoReportingId string `json:"videoReportingId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Active") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeCustomEvent) MarshalJSON() ([]byte, error) {
- type noMethod CreativeCustomEvent
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeField: Contains properties of a creative field.
-type CreativeField struct {
- // AccountId: Account ID of this creative field. This is a read-only
- // field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this creative field. This is a
- // required field on insertion.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // Id: ID of this creative field. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#creativeField".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this creative field. This is a required field and must
- // be less than 256 characters long and unique among creative fields of
- // the same advertiser.
- Name string `json:"name,omitempty"`
-
- // SubaccountId: Subaccount ID of this creative field. This is a
- // read-only field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeField) MarshalJSON() ([]byte, error) {
- type noMethod CreativeField
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeFieldAssignment: Creative Field Assignment.
-type CreativeFieldAssignment struct {
- // CreativeFieldId: ID of the creative field.
- CreativeFieldId int64 `json:"creativeFieldId,omitempty,string"`
-
- // CreativeFieldValueId: ID of the creative field value.
- CreativeFieldValueId int64 `json:"creativeFieldValueId,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "CreativeFieldId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeFieldAssignment) MarshalJSON() ([]byte, error) {
- type noMethod CreativeFieldAssignment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeFieldValue: Contains properties of a creative field value.
-type CreativeFieldValue struct {
- // Id: ID of this creative field value. This is a read-only,
- // auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#creativeFieldValue".
- Kind string `json:"kind,omitempty"`
-
- // Value: Value of this creative field value. It needs to be less than
- // 256 characters in length and unique per creative field.
- Value string `json:"value,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeFieldValue) MarshalJSON() ([]byte, error) {
- type noMethod CreativeFieldValue
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeFieldValuesListResponse: Creative Field Value List Response
-type CreativeFieldValuesListResponse struct {
- // CreativeFieldValues: Creative field value collection.
- CreativeFieldValues []*CreativeFieldValue `json:"creativeFieldValues,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#creativeFieldValuesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreativeFieldValues")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeFieldValuesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod CreativeFieldValuesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeFieldsListResponse: Creative Field List Response
-type CreativeFieldsListResponse struct {
- // CreativeFields: Creative field collection.
- CreativeFields []*CreativeField `json:"creativeFields,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#creativeFieldsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreativeFields") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeFieldsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod CreativeFieldsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeGroup: Contains properties of a creative group.
-type CreativeGroup struct {
- // AccountId: Account ID of this creative group. This is a read-only
- // field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this creative group. This is a
- // required field on insertion.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // GroupNumber: Subgroup of the creative group. Assign your creative
- // groups to one of the following subgroups in order to filter or manage
- // them more easily. This field is required on insertion and is
- // read-only after insertion.
- // Acceptable values are:
- // - 1
- // - 2
- GroupNumber int64 `json:"groupNumber,omitempty"`
-
- // Id: ID of this creative group. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#creativeGroup".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this creative group. This is a required field and must
- // be less than 256 characters long and unique among creative groups of
- // the same advertiser.
- Name string `json:"name,omitempty"`
-
- // SubaccountId: Subaccount ID of this creative group. This is a
- // read-only field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeGroup) MarshalJSON() ([]byte, error) {
- type noMethod CreativeGroup
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeGroupAssignment: Creative Group Assignment.
-type CreativeGroupAssignment struct {
- // CreativeGroupId: ID of the creative group to be assigned.
- CreativeGroupId int64 `json:"creativeGroupId,omitempty,string"`
-
- // CreativeGroupNumber: Creative group number of the creative group
- // assignment.
- //
- // Possible values:
- // "CREATIVE_GROUP_ONE"
- // "CREATIVE_GROUP_TWO"
- CreativeGroupNumber string `json:"creativeGroupNumber,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CreativeGroupId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeGroupAssignment) MarshalJSON() ([]byte, error) {
- type noMethod CreativeGroupAssignment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeGroupsListResponse: Creative Group List Response
-type CreativeGroupsListResponse struct {
- // CreativeGroups: Creative group collection.
- CreativeGroups []*CreativeGroup `json:"creativeGroups,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#creativeGroupsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreativeGroups") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeGroupsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod CreativeGroupsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeOptimizationConfiguration: Creative optimization settings.
-type CreativeOptimizationConfiguration struct {
- // Id: ID of this creative optimization config. This field is
- // auto-generated when the campaign is inserted or updated. It can be
- // null for existing campaigns.
- Id int64 `json:"id,omitempty,string"`
-
- // Name: Name of this creative optimization config. This is a required
- // field and must be less than 129 characters long.
- Name string `json:"name,omitempty"`
-
- // OptimizationActivitys: List of optimization activities associated
- // with this configuration.
- OptimizationActivitys []*OptimizationActivity `json:"optimizationActivitys,omitempty"`
-
- // OptimizationModel: Optimization model for this configuration.
- //
- // Possible values:
- // "CLICK"
- // "POST_CLICK"
- // "POST_CLICK_AND_IMPRESSION"
- // "POST_IMPRESSION"
- OptimizationModel string `json:"optimizationModel,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeOptimizationConfiguration) MarshalJSON() ([]byte, error) {
- type noMethod CreativeOptimizationConfiguration
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeRotation: Creative Rotation.
-type CreativeRotation struct {
- // CreativeAssignments: Creative assignments in this creative rotation.
- CreativeAssignments []*CreativeAssignment `json:"creativeAssignments,omitempty"`
-
- // CreativeOptimizationConfigurationId: Creative optimization
- // configuration that is used by this ad. It should refer to one of the
- // existing optimization configurations in the ad's campaign. If it is
- // unset or set to 0, then the campaign's default optimization
- // configuration will be used for this ad.
- CreativeOptimizationConfigurationId int64 `json:"creativeOptimizationConfigurationId,omitempty,string"`
-
- // Type: Type of creative rotation. Can be used to specify whether to
- // use sequential or random rotation.
- //
- // Possible values:
- // "CREATIVE_ROTATION_TYPE_RANDOM"
- // "CREATIVE_ROTATION_TYPE_SEQUENTIAL"
- Type string `json:"type,omitempty"`
-
- // WeightCalculationStrategy: Strategy for calculating weights. Used
- // with CREATIVE_ROTATION_TYPE_RANDOM.
- //
- // Possible values:
- // "WEIGHT_STRATEGY_CUSTOM"
- // "WEIGHT_STRATEGY_EQUAL"
- // "WEIGHT_STRATEGY_HIGHEST_CTR"
- // "WEIGHT_STRATEGY_OPTIMIZED"
- WeightCalculationStrategy string `json:"weightCalculationStrategy,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CreativeAssignments")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeRotation) MarshalJSON() ([]byte, error) {
- type noMethod CreativeRotation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeSettings: Creative Settings
-type CreativeSettings struct {
- // IFrameFooter: Header text for iFrames for this site. Must be less
- // than or equal to 2000 characters long.
- IFrameFooter string `json:"iFrameFooter,omitempty"`
-
- // IFrameHeader: Header text for iFrames for this site. Must be less
- // than or equal to 2000 characters long.
- IFrameHeader string `json:"iFrameHeader,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "IFrameFooter") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeSettings) MarshalJSON() ([]byte, error) {
- type noMethod CreativeSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativesListResponse: Creative List Response
-type CreativesListResponse struct {
- // Creatives: Creative collection.
- Creatives []*Creative `json:"creatives,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#creativesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Creatives") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod CreativesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CrossDimensionReachReportCompatibleFields: Represents fields that are
-// compatible to be selected for a report of type
-// "CROSS_DIMENSION_REACH".
-type CrossDimensionReachReportCompatibleFields struct {
- // Breakdown: Dimensions which are compatible to be selected in the
- // "breakdown" section of the report.
- Breakdown []*Dimension `json:"breakdown,omitempty"`
-
- // DimensionFilters: Dimensions which are compatible to be selected in
- // the "dimensionFilters" section of the report.
- DimensionFilters []*Dimension `json:"dimensionFilters,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#crossDimensionReachReportCompatibleFields.
- Kind string `json:"kind,omitempty"`
-
- // Metrics: Metrics which are compatible to be selected in the
- // "metricNames" section of the report.
- Metrics []*Metric `json:"metrics,omitempty"`
-
- // OverlapMetrics: Metrics which are compatible to be selected in the
- // "overlapMetricNames" section of the report.
- OverlapMetrics []*Metric `json:"overlapMetrics,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Breakdown") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CrossDimensionReachReportCompatibleFields) MarshalJSON() ([]byte, error) {
- type noMethod CrossDimensionReachReportCompatibleFields
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CustomRichMediaEvents: Represents a Custom Rich Media Events group.
-type CustomRichMediaEvents struct {
- // FilteredEventIds: List of custom rich media event IDs. Dimension
- // values must be all of type dfa:richMediaEventTypeIdAndName.
- FilteredEventIds []*DimensionValue `json:"filteredEventIds,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#customRichMediaEvents.
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "FilteredEventIds") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomRichMediaEvents) MarshalJSON() ([]byte, error) {
- type noMethod CustomRichMediaEvents
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DateRange: Represents a date range.
-type DateRange struct {
- // EndDate: The end date of the date range, inclusive. A string of the
- // format: "yyyy-MM-dd".
- EndDate string `json:"endDate,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#dateRange.
- Kind string `json:"kind,omitempty"`
-
- // RelativeDateRange: The date range relative to the date of when the
- // report is run.
- //
- // Possible values:
- // "LAST_24_MONTHS"
- // "LAST_30_DAYS"
- // "LAST_365_DAYS"
- // "LAST_7_DAYS"
- // "LAST_90_DAYS"
- // "MONTH_TO_DATE"
- // "PREVIOUS_MONTH"
- // "PREVIOUS_QUARTER"
- // "PREVIOUS_WEEK"
- // "PREVIOUS_YEAR"
- // "QUARTER_TO_DATE"
- // "TODAY"
- // "WEEK_TO_DATE"
- // "YEAR_TO_DATE"
- // "YESTERDAY"
- RelativeDateRange string `json:"relativeDateRange,omitempty"`
-
- // StartDate: The start date of the date range, inclusive. A string of
- // the format: "yyyy-MM-dd".
- StartDate string `json:"startDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "EndDate") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DateRange) MarshalJSON() ([]byte, error) {
- type noMethod DateRange
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DayPartTargeting: Day Part Targeting.
-type DayPartTargeting struct {
- // DaysOfWeek: Days of the week when the ad will serve.
- //
- // Acceptable values are:
- // - "SUNDAY"
- // - "MONDAY"
- // - "TUESDAY"
- // - "WEDNESDAY"
- // - "THURSDAY"
- // - "FRIDAY"
- // - "SATURDAY"
- //
- // Possible values:
- // "FRIDAY"
- // "MONDAY"
- // "SATURDAY"
- // "SUNDAY"
- // "THURSDAY"
- // "TUESDAY"
- // "WEDNESDAY"
- DaysOfWeek []string `json:"daysOfWeek,omitempty"`
-
- // HoursOfDay: Hours of the day when the ad will serve. Must be an
- // integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM,
- // and 23 is 11 PM to midnight. Can be specified with days of week, in
- // which case the ad would serve during these hours on the specified
- // days. For example, if Monday, Wednesday, Friday are the days of week
- // specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the
- // ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
- HoursOfDay []int64 `json:"hoursOfDay,omitempty"`
-
- // UserLocalTime: Whether or not to use the user's local time. If false,
- // the America/New York time zone applies.
- UserLocalTime bool `json:"userLocalTime,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DaysOfWeek") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DayPartTargeting) MarshalJSON() ([]byte, error) {
- type noMethod DayPartTargeting
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DefaultClickThroughEventTagProperties: Properties of inheriting and
-// overriding the default click-through event tag. A campaign may
-// override the event tag defined at the advertiser level, and an ad may
-// also override the campaign's setting further.
-type DefaultClickThroughEventTagProperties struct {
- // DefaultClickThroughEventTagId: ID of the click-through event tag to
- // apply to all ads in this entity's scope.
- DefaultClickThroughEventTagId int64 `json:"defaultClickThroughEventTagId,omitempty,string"`
-
- // OverrideInheritedEventTag: Whether this entity should override the
- // inherited default click-through event tag with its own defined value.
- OverrideInheritedEventTag bool `json:"overrideInheritedEventTag,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "DefaultClickThroughEventTagId") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DefaultClickThroughEventTagProperties) MarshalJSON() ([]byte, error) {
- type noMethod DefaultClickThroughEventTagProperties
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DeliverySchedule: Delivery Schedule.
-type DeliverySchedule struct {
- // FrequencyCap: Limit on the number of times an individual user can be
- // served the ad within a specified period of time.
- FrequencyCap *FrequencyCap `json:"frequencyCap,omitempty"`
-
- // HardCutoff: Whether or not hard cutoff is enabled. If true, the ad
- // will not serve after the end date and time. Otherwise the ad will
- // continue to be served until it has reached its delivery goals.
- HardCutoff bool `json:"hardCutoff,omitempty"`
-
- // ImpressionRatio: Impression ratio for this ad. This ratio determines
- // how often each ad is served relative to the others. For example, if
- // ad A has an impression ratio of 1 and ad B has an impression ratio of
- // 3, then DCM will serve ad B three times as often as ad A. Must be
- // between 1 and 10.
- ImpressionRatio int64 `json:"impressionRatio,omitempty,string"`
-
- // Priority: Serving priority of an ad, with respect to other ads. The
- // lower the priority number, the greater the priority with which it is
- // served.
- //
- // Possible values:
- // "AD_PRIORITY_01"
- // "AD_PRIORITY_02"
- // "AD_PRIORITY_03"
- // "AD_PRIORITY_04"
- // "AD_PRIORITY_05"
- // "AD_PRIORITY_06"
- // "AD_PRIORITY_07"
- // "AD_PRIORITY_08"
- // "AD_PRIORITY_09"
- // "AD_PRIORITY_10"
- // "AD_PRIORITY_11"
- // "AD_PRIORITY_12"
- // "AD_PRIORITY_13"
- // "AD_PRIORITY_14"
- // "AD_PRIORITY_15"
- // "AD_PRIORITY_16"
- Priority string `json:"priority,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "FrequencyCap") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DeliverySchedule) MarshalJSON() ([]byte, error) {
- type noMethod DeliverySchedule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DfpSettings: DFP Settings
-type DfpSettings struct {
- // DfpNetworkCode: DFP network code for this directory site.
- DfpNetworkCode string `json:"dfp_network_code,omitempty"`
-
- // DfpNetworkName: DFP network name for this directory site.
- DfpNetworkName string `json:"dfp_network_name,omitempty"`
-
- // ProgrammaticPlacementAccepted: Whether this directory site accepts
- // programmatic placements.
- ProgrammaticPlacementAccepted bool `json:"programmaticPlacementAccepted,omitempty"`
-
- // PubPaidPlacementAccepted: Whether this directory site accepts
- // publisher-paid tags.
- PubPaidPlacementAccepted bool `json:"pubPaidPlacementAccepted,omitempty"`
-
- // PublisherPortalOnly: Whether this directory site is available only
- // via DoubleClick Publisher Portal.
- PublisherPortalOnly bool `json:"publisherPortalOnly,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DfpNetworkCode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DfpSettings) MarshalJSON() ([]byte, error) {
- type noMethod DfpSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Dimension: Represents a dimension.
-type Dimension struct {
- // Kind: The kind of resource this is, in this case
- // dfareporting#dimension.
- Kind string `json:"kind,omitempty"`
-
- // Name: The dimension name, e.g. dfa:advertiser
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Dimension) MarshalJSON() ([]byte, error) {
- type noMethod Dimension
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DimensionFilter: Represents a dimension filter.
-type DimensionFilter struct {
- // DimensionName: The name of the dimension to filter.
- DimensionName string `json:"dimensionName,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#dimensionFilter.
- Kind string `json:"kind,omitempty"`
-
- // Value: The value of the dimension to filter.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DimensionFilter) MarshalJSON() ([]byte, error) {
- type noMethod DimensionFilter
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DimensionValue: Represents a DimensionValue resource.
-type DimensionValue struct {
- // DimensionName: The name of the dimension.
- DimensionName string `json:"dimensionName,omitempty"`
-
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Id: The ID associated with the value if available.
- Id string `json:"id,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#dimensionValue.
- Kind string `json:"kind,omitempty"`
-
- // MatchType: Determines how the 'value' field is matched when
- // filtering. If not specified, defaults to EXACT. If set to
- // WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable
- // length character sequences, and it can be escaped with a backslash.
- // Note, only paid search dimensions ('dfa:paidSearch*') allow a
- // matchType other than EXACT.
- //
- // Possible values:
- // "BEGINS_WITH"
- // "CONTAINS"
- // "EXACT"
- // "WILDCARD_EXPRESSION"
- MatchType string `json:"matchType,omitempty"`
-
- // Value: The value of the dimension.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DimensionValue) MarshalJSON() ([]byte, error) {
- type noMethod DimensionValue
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DimensionValueList: Represents the list of DimensionValue resources.
-type DimensionValueList struct {
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The dimension values returned in this response.
- Items []*DimensionValue `json:"items,omitempty"`
-
- // Kind: The kind of list this is, in this case
- // dfareporting#dimensionValueList.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through dimension
- // values. To retrieve the next page of results, set the next request's
- // "pageToken" to the value of this field. The page token is only valid
- // for a limited amount of time and should not be persisted.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DimensionValueList) MarshalJSON() ([]byte, error) {
- type noMethod DimensionValueList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DimensionValueRequest: Represents a DimensionValuesRequest.
-type DimensionValueRequest struct {
- // DimensionName: The name of the dimension for which values should be
- // requested.
- DimensionName string `json:"dimensionName,omitempty"`
-
- // EndDate: The end date of the date range for which to retrieve
- // dimension values. A string of the format "yyyy-MM-dd".
- EndDate string `json:"endDate,omitempty"`
-
- // Filters: The list of filters by which to filter values. The filters
- // are ANDed.
- Filters []*DimensionFilter `json:"filters,omitempty"`
-
- // Kind: The kind of request this is, in this case
- // dfareporting#dimensionValueRequest.
- Kind string `json:"kind,omitempty"`
-
- // StartDate: The start date of the date range for which to retrieve
- // dimension values. A string of the format "yyyy-MM-dd".
- StartDate string `json:"startDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DimensionValueRequest) MarshalJSON() ([]byte, error) {
- type noMethod DimensionValueRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DirectorySite: DirectorySites contains properties of a website from
-// the Site Directory. Sites need to be added to an account via the
-// Sites resource before they can be assigned to a placement.
-type DirectorySite struct {
- // Active: Whether this directory site is active.
- Active bool `json:"active,omitempty"`
-
- // ContactAssignments: Directory site contacts.
- ContactAssignments []*DirectorySiteContactAssignment `json:"contactAssignments,omitempty"`
-
- // CountryId: Country ID of this directory site.
- CountryId int64 `json:"countryId,omitempty,string"`
-
- // CurrencyId: Currency ID of this directory site.
- // Possible values are:
- // - "1" for USD
- // - "2" for GBP
- // - "3" for ESP
- // - "4" for SEK
- // - "5" for CAD
- // - "6" for JPY
- // - "7" for DEM
- // - "8" for AUD
- // - "9" for FRF
- // - "10" for ITL
- // - "11" for DKK
- // - "12" for NOK
- // - "13" for FIM
- // - "14" for ZAR
- // - "15" for IEP
- // - "16" for NLG
- // - "17" for EUR
- // - "18" for KRW
- // - "19" for TWD
- // - "20" for SGD
- // - "21" for CNY
- // - "22" for HKD
- // - "23" for NZD
- // - "24" for MYR
- // - "25" for BRL
- // - "26" for PTE
- // - "27" for MXP
- // - "28" for CLP
- // - "29" for TRY
- // - "30" for ARS
- // - "31" for PEN
- // - "32" for ILS
- // - "33" for CHF
- // - "34" for VEF
- // - "35" for COP
- // - "36" for GTQ
- CurrencyId int64 `json:"currencyId,omitempty,string"`
-
- // Description: Description of this directory site.
- Description string `json:"description,omitempty"`
-
- // Id: ID of this directory site. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this directory site.
- // This is a read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // InpageTagFormats: Tag types for regular placements.
- //
- // Acceptable values are:
- // - "STANDARD"
- // - "IFRAME_JAVASCRIPT_INPAGE"
- // - "INTERNAL_REDIRECT_INPAGE"
- // - "JAVASCRIPT_INPAGE"
- //
- // Possible values:
- // "IFRAME_JAVASCRIPT_INPAGE"
- // "INTERNAL_REDIRECT_INPAGE"
- // "JAVASCRIPT_INPAGE"
- // "STANDARD"
- InpageTagFormats []string `json:"inpageTagFormats,omitempty"`
-
- // InterstitialTagFormats: Tag types for interstitial
- // placements.
- //
- // Acceptable values are:
- // - "IFRAME_JAVASCRIPT_INTERSTITIAL"
- // - "INTERNAL_REDIRECT_INTERSTITIAL"
- // - "JAVASCRIPT_INTERSTITIAL"
- //
- // Possible values:
- // "IFRAME_JAVASCRIPT_INTERSTITIAL"
- // "INTERNAL_REDIRECT_INTERSTITIAL"
- // "JAVASCRIPT_INTERSTITIAL"
- InterstitialTagFormats []string `json:"interstitialTagFormats,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#directorySite".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this directory site.
- Name string `json:"name,omitempty"`
-
- // ParentId: Parent directory site ID.
- ParentId int64 `json:"parentId,omitempty,string"`
-
- // Settings: Directory site settings.
- Settings *DirectorySiteSettings `json:"settings,omitempty"`
-
- // Url: URL of this directory site.
- Url string `json:"url,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Active") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DirectorySite) MarshalJSON() ([]byte, error) {
- type noMethod DirectorySite
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DirectorySiteContact: Contains properties of a Site Directory
-// contact.
-type DirectorySiteContact struct {
- // Address: Address of this directory site contact.
- Address string `json:"address,omitempty"`
-
- // Email: Email address of this directory site contact.
- Email string `json:"email,omitempty"`
-
- // FirstName: First name of this directory site contact.
- FirstName string `json:"firstName,omitempty"`
-
- // Id: ID of this directory site contact. This is a read-only,
- // auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#directorySiteContact".
- Kind string `json:"kind,omitempty"`
-
- // LastName: Last name of this directory site contact.
- LastName string `json:"lastName,omitempty"`
-
- // Phone: Phone number of this directory site contact.
- Phone string `json:"phone,omitempty"`
-
- // Role: Directory site contact role.
- //
- // Possible values:
- // "ADMIN"
- // "EDIT"
- // "VIEW"
- Role string `json:"role,omitempty"`
-
- // Title: Title or designation of this directory site contact.
- Title string `json:"title,omitempty"`
-
- // Type: Directory site contact type.
- //
- // Possible values:
- // "BILLING"
- // "OTHER"
- // "SALES"
- // "TECHNICAL"
- Type string `json:"type,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Address") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DirectorySiteContact) MarshalJSON() ([]byte, error) {
- type noMethod DirectorySiteContact
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DirectorySiteContactAssignment: Directory Site Contact Assignment
-type DirectorySiteContactAssignment struct {
- // ContactId: ID of this directory site contact. This is a read-only,
- // auto-generated field.
- ContactId int64 `json:"contactId,omitempty,string"`
-
- // Visibility: Visibility of this directory site contact assignment.
- // When set to PUBLIC this contact assignment is visible to all account
- // and agency users; when set to PRIVATE it is visible only to the site.
- //
- // Possible values:
- // "PRIVATE"
- // "PUBLIC"
- Visibility string `json:"visibility,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ContactId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DirectorySiteContactAssignment) MarshalJSON() ([]byte, error) {
- type noMethod DirectorySiteContactAssignment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DirectorySiteContactsListResponse: Directory Site Contact List
-// Response
-type DirectorySiteContactsListResponse struct {
- // DirectorySiteContacts: Directory site contact collection
- DirectorySiteContacts []*DirectorySiteContact `json:"directorySiteContacts,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#directorySiteContactsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "DirectorySiteContacts") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DirectorySiteContactsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod DirectorySiteContactsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DirectorySiteSettings: Directory Site Settings
-type DirectorySiteSettings struct {
- // ActiveViewOptOut: Whether this directory site has disabled active
- // view creatives.
- ActiveViewOptOut bool `json:"activeViewOptOut,omitempty"`
-
- // DfpSettings: Directory site DFP settings.
- DfpSettings *DfpSettings `json:"dfp_settings,omitempty"`
-
- // InstreamVideoPlacementAccepted: Whether this site accepts in-stream
- // video ads.
- InstreamVideoPlacementAccepted bool `json:"instream_video_placement_accepted,omitempty"`
-
- // InterstitialPlacementAccepted: Whether this site accepts interstitial
- // ads.
- InterstitialPlacementAccepted bool `json:"interstitialPlacementAccepted,omitempty"`
-
- // NielsenOcrOptOut: Whether this directory site has disabled Nielsen
- // OCR reach ratings.
- NielsenOcrOptOut bool `json:"nielsenOcrOptOut,omitempty"`
-
- // VerificationTagOptOut: Whether this directory site has disabled
- // generation of Verification ins tags.
- VerificationTagOptOut bool `json:"verificationTagOptOut,omitempty"`
-
- // VideoActiveViewOptOut: Whether this directory site has disabled
- // active view for in-stream video creatives.
- VideoActiveViewOptOut bool `json:"videoActiveViewOptOut,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ActiveViewOptOut") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DirectorySiteSettings) MarshalJSON() ([]byte, error) {
- type noMethod DirectorySiteSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DirectorySitesListResponse: Directory Site List Response
-type DirectorySitesListResponse struct {
- // DirectorySites: Directory site collection.
- DirectorySites []*DirectorySite `json:"directorySites,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#directorySitesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "DirectorySites") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DirectorySitesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod DirectorySitesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// EventTag: Contains properties of an event tag.
-type EventTag struct {
- // AccountId: Account ID of this event tag. This is a read-only field
- // that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this event tag. This field or the
- // campaignId field is required on insertion.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // CampaignId: Campaign ID of this event tag. This field or the
- // advertiserId field is required on insertion.
- CampaignId int64 `json:"campaignId,omitempty,string"`
-
- // CampaignIdDimensionValue: Dimension value for the ID of the campaign.
- // This is a read-only, auto-generated field.
- CampaignIdDimensionValue *DimensionValue `json:"campaignIdDimensionValue,omitempty"`
-
- // EnabledByDefault: Whether this event tag should be automatically
- // enabled for all of the advertiser's campaigns and ads.
- EnabledByDefault bool `json:"enabledByDefault,omitempty"`
-
- // Id: ID of this event tag. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#eventTag".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this event tag. This is a required field and must be
- // less than 256 characters long.
- Name string `json:"name,omitempty"`
-
- // SiteFilterType: Site filter type for this event tag. If no type is
- // specified then the event tag will be applied to all sites.
- //
- // Possible values:
- // "BLACKLIST"
- // "WHITELIST"
- SiteFilterType string `json:"siteFilterType,omitempty"`
-
- // SiteIds: Filter list of site IDs associated with this event tag. The
- // siteFilterType determines whether this is a whitelist or blacklist
- // filter.
- SiteIds googleapi.Int64s `json:"siteIds,omitempty"`
-
- // SslCompliant: Whether this tag is SSL-compliant or not. This is a
- // read-only field.
- SslCompliant bool `json:"sslCompliant,omitempty"`
-
- // Status: Status of this event tag. Must be ENABLED for this event tag
- // to fire. This is a required field.
- //
- // Possible values:
- // "DISABLED"
- // "ENABLED"
- Status string `json:"status,omitempty"`
-
- // SubaccountId: Subaccount ID of this event tag. This is a read-only
- // field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // Type: Event tag type. Can be used to specify whether to use a
- // third-party pixel, a third-party JavaScript URL, or a third-party
- // click-through URL for either impression or click tracking. This is a
- // required field.
- //
- // Possible values:
- // "CLICK_THROUGH_EVENT_TAG"
- // "IMPRESSION_IMAGE_EVENT_TAG"
- // "IMPRESSION_JAVASCRIPT_EVENT_TAG"
- Type string `json:"type,omitempty"`
-
- // Url: Payload URL for this event tag. The URL on a click-through event
- // tag should have a landing page URL appended to the end of it. This
- // field is required on insertion.
- Url string `json:"url,omitempty"`
-
- // UrlEscapeLevels: Number of times the landing page URL should be
- // URL-escaped before being appended to the click-through event tag URL.
- // Only applies to click-through event tags as specified by the event
- // tag type.
- UrlEscapeLevels int64 `json:"urlEscapeLevels,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EventTag) MarshalJSON() ([]byte, error) {
- type noMethod EventTag
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// EventTagOverride: Event tag override information.
-type EventTagOverride struct {
- // Enabled: Whether this override is enabled.
- Enabled bool `json:"enabled,omitempty"`
-
- // Id: ID of this event tag override. This is a read-only,
- // auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "Enabled") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EventTagOverride) MarshalJSON() ([]byte, error) {
- type noMethod EventTagOverride
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// EventTagsListResponse: Event Tag List Response
-type EventTagsListResponse struct {
- // EventTags: Event tag collection.
- EventTags []*EventTag `json:"eventTags,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#eventTagsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "EventTags") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EventTagsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod EventTagsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// File: Represents a File resource. A file contains the metadata for a
-// report run. It shows the status of the run and holds the URLs to the
-// generated report data if the run is finished and the status is
-// "REPORT_AVAILABLE".
-type File struct {
- // DateRange: The date range for which the file has report data. The
- // date range will always be the absolute date range for which the
- // report is run.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // FileName: The filename of the file.
- FileName string `json:"fileName,omitempty"`
-
- // Format: The output format of the report. Only available once the file
- // is available.
- //
- // Possible values:
- // "CSV"
- // "EXCEL"
- Format string `json:"format,omitempty"`
-
- // Id: The unique ID of this report file.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: The kind of resource this is, in this case dfareporting#file.
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedTime: The timestamp in milliseconds since epoch when this
- // file was last modified.
- LastModifiedTime int64 `json:"lastModifiedTime,omitempty,string"`
-
- // ReportId: The ID of the report this file was generated from.
- ReportId int64 `json:"reportId,omitempty,string"`
-
- // Status: The status of the report file.
- //
- // Possible values:
- // "CANCELLED"
- // "FAILED"
- // "PROCESSING"
- // "REPORT_AVAILABLE"
- Status string `json:"status,omitempty"`
-
- // Urls: The URLs where the completed report file can be downloaded.
- Urls *FileUrls `json:"urls,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "DateRange") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *File) MarshalJSON() ([]byte, error) {
- type noMethod File
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FileUrls: The URLs where the completed report file can be downloaded.
-type FileUrls struct {
- // ApiUrl: The URL for downloading the report data through the API.
- ApiUrl string `json:"apiUrl,omitempty"`
-
- // BrowserUrl: The URL for downloading the report data through a
- // browser.
- BrowserUrl string `json:"browserUrl,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ApiUrl") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FileUrls) MarshalJSON() ([]byte, error) {
- type noMethod FileUrls
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FileList: Represents the list of File resources.
-type FileList struct {
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The files returned in this response.
- Items []*File `json:"items,omitempty"`
-
- // Kind: The kind of list this is, in this case dfareporting#fileList.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through files. To
- // retrieve the next page of results, set the next request's "pageToken"
- // to the value of this field. The page token is only valid for a
- // limited amount of time and should not be persisted.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FileList) MarshalJSON() ([]byte, error) {
- type noMethod FileList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Flight: Flight
-type Flight struct {
- // EndDate: Inventory item flight end date.
- EndDate string `json:"endDate,omitempty"`
-
- // RateOrCost: Rate or cost of this flight.
- RateOrCost int64 `json:"rateOrCost,omitempty,string"`
-
- // StartDate: Inventory item flight start date.
- StartDate string `json:"startDate,omitempty"`
-
- // Units: Units of this flight.
- Units int64 `json:"units,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "EndDate") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Flight) MarshalJSON() ([]byte, error) {
- type noMethod Flight
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightActivitiesGenerateTagResponse: Floodlight Activity
-// GenerateTag Response
-type FloodlightActivitiesGenerateTagResponse struct {
- // FloodlightActivityTag: Generated tag for this floodlight activity.
- FloodlightActivityTag string `json:"floodlightActivityTag,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#floodlightActivitiesGenerateTagResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "FloodlightActivityTag") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightActivitiesGenerateTagResponse) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightActivitiesGenerateTagResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightActivitiesListResponse: Floodlight Activity List Response
-type FloodlightActivitiesListResponse struct {
- // FloodlightActivities: Floodlight activity collection.
- FloodlightActivities []*FloodlightActivity `json:"floodlightActivities,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#floodlightActivitiesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "FloodlightActivities") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightActivitiesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightActivitiesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightActivity: Contains properties of a Floodlight activity.
-type FloodlightActivity struct {
- // AccountId: Account ID of this floodlight activity. This is a
- // read-only field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this floodlight activity. If this
- // field is left blank, the value will be copied over either from the
- // activity group's advertiser or the existing activity's advertiser.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // CacheBustingType: Code type used for cache busting in the generated
- // tag.
- //
- // Possible values:
- // "ACTIVE_SERVER_PAGE"
- // "COLD_FUSION"
- // "JAVASCRIPT"
- // "JSP"
- // "PHP"
- CacheBustingType string `json:"cacheBustingType,omitempty"`
-
- // CountingMethod: Counting method for conversions for this floodlight
- // activity. This is a required field.
- //
- // Possible values:
- // "ITEMS_SOLD_COUNTING"
- // "SESSION_COUNTING"
- // "STANDARD_COUNTING"
- // "TRANSACTIONS_COUNTING"
- // "UNIQUE_COUNTING"
- CountingMethod string `json:"countingMethod,omitempty"`
-
- // DefaultTags: Dynamic floodlight tags.
- DefaultTags []*FloodlightActivityDynamicTag `json:"defaultTags,omitempty"`
-
- // ExpectedUrl: URL where this tag will be deployed. If specified, must
- // be less than 256 characters long.
- ExpectedUrl string `json:"expectedUrl,omitempty"`
-
- // FloodlightActivityGroupId: Floodlight activity group ID of this
- // floodlight activity. This is a required field.
- FloodlightActivityGroupId int64 `json:"floodlightActivityGroupId,omitempty,string"`
-
- // FloodlightActivityGroupName: Name of the associated floodlight
- // activity group. This is a read-only field.
- FloodlightActivityGroupName string `json:"floodlightActivityGroupName,omitempty"`
-
- // FloodlightActivityGroupTagString: Tag string of the associated
- // floodlight activity group. This is a read-only field.
- FloodlightActivityGroupTagString string `json:"floodlightActivityGroupTagString,omitempty"`
-
- // FloodlightActivityGroupType: Type of the associated floodlight
- // activity group. This is a read-only field.
- //
- // Possible values:
- // "COUNTER"
- // "SALE"
- FloodlightActivityGroupType string `json:"floodlightActivityGroupType,omitempty"`
-
- // FloodlightConfigurationId: Floodlight configuration ID of this
- // floodlight activity. If this field is left blank, the value will be
- // copied over either from the activity group's floodlight configuration
- // or from the existing activity's floodlight configuration.
- FloodlightConfigurationId int64 `json:"floodlightConfigurationId,omitempty,string"`
-
- // FloodlightConfigurationIdDimensionValue: Dimension value for the ID
- // of the floodlight configuration. This is a read-only, auto-generated
- // field.
- FloodlightConfigurationIdDimensionValue *DimensionValue `json:"floodlightConfigurationIdDimensionValue,omitempty"`
-
- // Hidden: Whether this activity is archived.
- Hidden bool `json:"hidden,omitempty"`
-
- // Id: ID of this floodlight activity. This is a read-only,
- // auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this floodlight
- // activity. This is a read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // ImageTagEnabled: Whether the image tag is enabled for this activity.
- ImageTagEnabled bool `json:"imageTagEnabled,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#floodlightActivity".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this floodlight activity. This is a required field.
- // Must be less than 129 characters long and cannot contain quotes.
- Name string `json:"name,omitempty"`
-
- // Notes: General notes or implementation instructions for the tag.
- Notes string `json:"notes,omitempty"`
-
- // PublisherTags: Publisher dynamic floodlight tags.
- PublisherTags []*FloodlightActivityPublisherDynamicTag `json:"publisherTags,omitempty"`
-
- // Secure: Whether this tag should use SSL.
- Secure bool `json:"secure,omitempty"`
-
- // SslCompliant: Whether the floodlight activity is SSL-compliant. This
- // is a read-only field, its value detected by the system from the
- // floodlight tags.
- SslCompliant bool `json:"sslCompliant,omitempty"`
-
- // SslRequired: Whether this floodlight activity must be SSL-compliant.
- SslRequired bool `json:"sslRequired,omitempty"`
-
- // SubaccountId: Subaccount ID of this floodlight activity. This is a
- // read-only field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // TagFormat: Tag format type for the floodlight activity. If left
- // blank, the tag format will default to HTML.
- //
- // Possible values:
- // "HTML"
- // "XHTML"
- TagFormat string `json:"tagFormat,omitempty"`
-
- // TagString: Value of the cat= paramter in the floodlight tag, which
- // the ad servers use to identify the activity. This is optional: if
- // empty, a new tag string will be generated for you. This string must
- // be 1 to 8 characters long, with valid characters being
- // [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among
- // activities of the same activity group. This field is read-only after
- // insertion.
- TagString string `json:"tagString,omitempty"`
-
- // UserDefinedVariableTypes: List of the user-defined variables used by
- // this conversion tag. These map to the "u[1-20]=" in the tags. Each of
- // these can have a user defined type.
- // Acceptable values are:
- // - "U1"
- // - "U2"
- // - "U3"
- // - "U4"
- // - "U5"
- // - "U6"
- // - "U7"
- // - "U8"
- // - "U9"
- // - "U10"
- // - "U11"
- // - "U12"
- // - "U13"
- // - "U14"
- // - "U15"
- // - "U16"
- // - "U17"
- // - "U18"
- // - "U19"
- // - "U20"
- //
- // Possible values:
- // "U1"
- // "U10"
- // "U11"
- // "U12"
- // "U13"
- // "U14"
- // "U15"
- // "U16"
- // "U17"
- // "U18"
- // "U19"
- // "U2"
- // "U20"
- // "U3"
- // "U4"
- // "U5"
- // "U6"
- // "U7"
- // "U8"
- // "U9"
- UserDefinedVariableTypes []string `json:"userDefinedVariableTypes,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightActivity) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightActivity
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightActivityDynamicTag: Dynamic Tag
-type FloodlightActivityDynamicTag struct {
- // Id: ID of this dynamic tag. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // Name: Name of this tag.
- Name string `json:"name,omitempty"`
-
- // Tag: Tag code.
- Tag string `json:"tag,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightActivityDynamicTag) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightActivityDynamicTag
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightActivityGroup: Contains properties of a Floodlight activity
-// group.
-type FloodlightActivityGroup struct {
- // AccountId: Account ID of this floodlight activity group. This is a
- // read-only field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this floodlight activity group. If
- // this field is left blank, the value will be copied over either from
- // the floodlight configuration's advertiser or from the existing
- // activity group's advertiser.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // FloodlightConfigurationId: Floodlight configuration ID of this
- // floodlight activity group. This is a required field.
- FloodlightConfigurationId int64 `json:"floodlightConfigurationId,omitempty,string"`
-
- // FloodlightConfigurationIdDimensionValue: Dimension value for the ID
- // of the floodlight configuration. This is a read-only, auto-generated
- // field.
- FloodlightConfigurationIdDimensionValue *DimensionValue `json:"floodlightConfigurationIdDimensionValue,omitempty"`
-
- // Id: ID of this floodlight activity group. This is a read-only,
- // auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this floodlight
- // activity group. This is a read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#floodlightActivityGroup".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this floodlight activity group. This is a required
- // field. Must be less than 65 characters long and cannot contain
- // quotes.
- Name string `json:"name,omitempty"`
-
- // SubaccountId: Subaccount ID of this floodlight activity group. This
- // is a read-only field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // TagString: Value of the type= parameter in the floodlight tag, which
- // the ad servers use to identify the activity group that the activity
- // belongs to. This is optional: if empty, a new tag string will be
- // generated for you. This string must be 1 to 8 characters long, with
- // valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must
- // also be unique among activity groups of the same floodlight
- // configuration. This field is read-only after insertion.
- TagString string `json:"tagString,omitempty"`
-
- // Type: Type of the floodlight activity group. This is a required field
- // that is read-only after insertion.
- //
- // Possible values:
- // "COUNTER"
- // "SALE"
- Type string `json:"type,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightActivityGroup) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightActivityGroup
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightActivityGroupsListResponse: Floodlight Activity Group List
-// Response
-type FloodlightActivityGroupsListResponse struct {
- // FloodlightActivityGroups: Floodlight activity group collection.
- FloodlightActivityGroups []*FloodlightActivityGroup `json:"floodlightActivityGroups,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#floodlightActivityGroupsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "FloodlightActivityGroups") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightActivityGroupsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightActivityGroupsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightActivityPublisherDynamicTag: Publisher Dynamic Tag
-type FloodlightActivityPublisherDynamicTag struct {
- // ClickThrough: Whether this tag is applicable only for click-throughs.
- ClickThrough bool `json:"clickThrough,omitempty"`
-
- // DirectorySiteId: Directory site ID of this dynamic tag. This is a
- // write-only field that can be used as an alternative to the siteId
- // field. When this resource is retrieved, only the siteId field will be
- // populated.
- DirectorySiteId int64 `json:"directorySiteId,omitempty,string"`
-
- // DynamicTag: Dynamic floodlight tag.
- DynamicTag *FloodlightActivityDynamicTag `json:"dynamicTag,omitempty"`
-
- // SiteId: Site ID of this dynamic tag.
- SiteId int64 `json:"siteId,omitempty,string"`
-
- // SiteIdDimensionValue: Dimension value for the ID of the site. This is
- // a read-only, auto-generated field.
- SiteIdDimensionValue *DimensionValue `json:"siteIdDimensionValue,omitempty"`
-
- // ViewThrough: Whether this tag is applicable only for view-throughs.
- ViewThrough bool `json:"viewThrough,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ClickThrough") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightActivityPublisherDynamicTag) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightActivityPublisherDynamicTag
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightConfiguration: Contains properties of a Floodlight
-// configuration.
-type FloodlightConfiguration struct {
- // AccountId: Account ID of this floodlight configuration. This is a
- // read-only field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of the parent advertiser of this
- // floodlight configuration.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // AnalyticsDataSharingEnabled: Whether advertiser data is shared with
- // Google Analytics.
- AnalyticsDataSharingEnabled bool `json:"analyticsDataSharingEnabled,omitempty"`
-
- // ExposureToConversionEnabled: Whether the exposure-to-conversion
- // report is enabled. This report shows detailed pathway information on
- // up to 10 of the most recent ad exposures seen by a user before
- // converting.
- ExposureToConversionEnabled bool `json:"exposureToConversionEnabled,omitempty"`
-
- // FirstDayOfWeek: Day that will be counted as the first day of the week
- // in reports. This is a required field.
- //
- // Possible values:
- // "MONDAY"
- // "SUNDAY"
- FirstDayOfWeek string `json:"firstDayOfWeek,omitempty"`
-
- // Id: ID of this floodlight configuration. This is a read-only,
- // auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this floodlight
- // configuration. This is a read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#floodlightConfiguration".
- Kind string `json:"kind,omitempty"`
-
- // LookbackConfiguration: Lookback window settings for this floodlight
- // configuration.
- LookbackConfiguration *LookbackConfiguration `json:"lookbackConfiguration,omitempty"`
-
- // NaturalSearchConversionAttributionOption: Types of attribution
- // options for natural search conversions.
- //
- // Possible values:
- // "EXCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION"
- // "INCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION"
- // "INCLUDE_NATURAL_SEARCH_TIERED_CONVERSION_ATTRIBUTION"
- NaturalSearchConversionAttributionOption string `json:"naturalSearchConversionAttributionOption,omitempty"`
-
- // OmnitureSettings: Settings for DCM Omniture integration.
- OmnitureSettings *OmnitureSettings `json:"omnitureSettings,omitempty"`
-
- // SslRequired: Whether floodlight activities owned by this
- // configuration are required to be SSL-compliant.
- SslRequired bool `json:"sslRequired,omitempty"`
-
- // StandardVariableTypes: List of standard variables enabled for this
- // configuration.
- //
- // Acceptable values are:
- // - "ORD"
- // - "NUM"
- //
- // Possible values:
- // "NUM"
- // "ORD"
- // "TRAN"
- // "U"
- StandardVariableTypes []string `json:"standardVariableTypes,omitempty"`
-
- // SubaccountId: Subaccount ID of this floodlight configuration. This is
- // a read-only field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // TagSettings: Configuration settings for dynamic and image floodlight
- // tags.
- TagSettings *TagSettings `json:"tagSettings,omitempty"`
-
- // UserDefinedVariableConfigurations: List of user defined variables
- // enabled for this configuration.
- UserDefinedVariableConfigurations []*UserDefinedVariableConfiguration `json:"userDefinedVariableConfigurations,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightConfiguration) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightConfiguration
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightConfigurationsListResponse: Floodlight Configuration List
-// Response
-type FloodlightConfigurationsListResponse struct {
- // FloodlightConfigurations: Floodlight configuration collection.
- FloodlightConfigurations []*FloodlightConfiguration `json:"floodlightConfigurations,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#floodlightConfigurationsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "FloodlightConfigurations") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightConfigurationsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightConfigurationsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightReportCompatibleFields: Represents fields that are
-// compatible to be selected for a report of type "FlOODLIGHT".
-type FloodlightReportCompatibleFields struct {
- // DimensionFilters: Dimensions which are compatible to be selected in
- // the "dimensionFilters" section of the report.
- DimensionFilters []*Dimension `json:"dimensionFilters,omitempty"`
-
- // Dimensions: Dimensions which are compatible to be selected in the
- // "dimensions" section of the report.
- Dimensions []*Dimension `json:"dimensions,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#floodlightReportCompatibleFields.
- Kind string `json:"kind,omitempty"`
-
- // Metrics: Metrics which are compatible to be selected in the
- // "metricNames" section of the report.
- Metrics []*Metric `json:"metrics,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionFilters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightReportCompatibleFields) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightReportCompatibleFields
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FrequencyCap: Frequency Cap.
-type FrequencyCap struct {
- // Duration: Duration of time, in seconds, for this frequency cap. The
- // maximum duration is 90 days in seconds, or 7,776,000.
- Duration int64 `json:"duration,omitempty,string"`
-
- // Impressions: Number of times an individual user can be served the ad
- // within the specified duration. The maximum allowed is 15.
- Impressions int64 `json:"impressions,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "Duration") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FrequencyCap) MarshalJSON() ([]byte, error) {
- type noMethod FrequencyCap
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FsCommand: FsCommand.
-type FsCommand struct {
- // Left: Distance from the left of the browser.Applicable when
- // positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- Left int64 `json:"left,omitempty"`
-
- // PositionOption: Position in the browser where the window will open.
- //
- // Possible values:
- // "CENTERED"
- // "DISTANCE_FROM_TOP_LEFT_CORNER"
- PositionOption string `json:"positionOption,omitempty"`
-
- // Top: Distance from the top of the browser. Applicable when
- // positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- Top int64 `json:"top,omitempty"`
-
- // WindowHeight: Height of the window.
- WindowHeight int64 `json:"windowHeight,omitempty"`
-
- // WindowWidth: Width of the window.
- WindowWidth int64 `json:"windowWidth,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Left") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FsCommand) MarshalJSON() ([]byte, error) {
- type noMethod FsCommand
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// GeoTargeting: Geographical Targeting.
-type GeoTargeting struct {
- // Cities: Cities to be targeted. For each city only dartId is required.
- // The other fields are populated automatically when the ad is inserted
- // or updated. If targeting a city, do not target or exclude the country
- // of the city, and do not target the metro or region of the city.
- Cities []*City `json:"cities,omitempty"`
-
- // Countries: Countries to be targeted or excluded from targeting,
- // depending on the setting of the excludeCountries field. For each
- // country only dartId is required. The other fields are populated
- // automatically when the ad is inserted or updated. If targeting or
- // excluding a country, do not target regions, cities, metros, or postal
- // codes in the same country.
- Countries []*Country `json:"countries,omitempty"`
-
- // ExcludeCountries: Whether or not to exclude the countries in the
- // countries field from targeting. If false, the countries field refers
- // to countries which will be targeted by the ad.
- ExcludeCountries bool `json:"excludeCountries,omitempty"`
-
- // Metros: Metros to be targeted. For each metro only dmaId is required.
- // The other fields are populated automatically when the ad is inserted
- // or updated. If targeting a metro, do not target or exclude the
- // country of the metro.
- Metros []*Metro `json:"metros,omitempty"`
-
- // PostalCodes: Postal codes to be targeted. For each postal code only
- // id is required. The other fields are populated automatically when the
- // ad is inserted or updated. If targeting a postal code, do not target
- // or exclude the country of the postal code.
- PostalCodes []*PostalCode `json:"postalCodes,omitempty"`
-
- // Regions: Regions to be targeted. For each region only dartId is
- // required. The other fields are populated automatically when the ad is
- // inserted or updated. If targeting a region, do not target or exclude
- // the country of the region.
- Regions []*Region `json:"regions,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Cities") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GeoTargeting) MarshalJSON() ([]byte, error) {
- type noMethod GeoTargeting
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// InventoryItem: Represents a buy from the DoubleClick Planning
-// inventory store.
-type InventoryItem struct {
- // AccountId: Account ID of this inventory item.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdSlots: Ad slots of this inventory item. If this inventory item
- // represents a standalone placement, there will be exactly one ad slot.
- // If this inventory item represents a placement group, there will be
- // more than one ad slot, each representing one child placement in that
- // placement group.
- AdSlots []*AdSlot `json:"adSlots,omitempty"`
-
- // AdvertiserId: Advertiser ID of this inventory item.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // ContentCategoryId: Content category ID of this inventory item.
- ContentCategoryId int64 `json:"contentCategoryId,omitempty,string"`
-
- // EstimatedClickThroughRate: Estimated click-through rate of this
- // inventory item.
- EstimatedClickThroughRate int64 `json:"estimatedClickThroughRate,omitempty,string"`
-
- // EstimatedConversionRate: Estimated conversion rate of this inventory
- // item.
- EstimatedConversionRate int64 `json:"estimatedConversionRate,omitempty,string"`
-
- // Id: ID of this inventory item.
- Id int64 `json:"id,omitempty,string"`
-
- // InPlan: Whether this inventory item is in plan.
- InPlan bool `json:"inPlan,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#inventoryItem".
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedInfo: Information about the most recent modification of
- // this inventory item.
- LastModifiedInfo *LastModifiedInfo `json:"lastModifiedInfo,omitempty"`
-
- // Name: Name of this inventory item. For standalone inventory items,
- // this is the same name as that of its only ad slot. For group
- // inventory items, this can differ from the name of any of its ad
- // slots.
- Name string `json:"name,omitempty"`
-
- // NegotiationChannelId: Negotiation channel ID of this inventory item.
- NegotiationChannelId int64 `json:"negotiationChannelId,omitempty,string"`
-
- // OrderId: Order ID of this inventory item.
- OrderId int64 `json:"orderId,omitempty,string"`
-
- // PlacementStrategyId: Placement strategy ID of this inventory item.
- PlacementStrategyId int64 `json:"placementStrategyId,omitempty,string"`
-
- // Pricing: Pricing of this inventory item.
- Pricing *Pricing `json:"pricing,omitempty"`
-
- // ProjectId: Project ID of this inventory item.
- ProjectId int64 `json:"projectId,omitempty,string"`
-
- // RfpId: RFP ID of this inventory item.
- RfpId int64 `json:"rfpId,omitempty,string"`
-
- // SiteId: ID of the site this inventory item is associated with.
- SiteId int64 `json:"siteId,omitempty,string"`
-
- // SubaccountId: Subaccount ID of this inventory item.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InventoryItem) MarshalJSON() ([]byte, error) {
- type noMethod InventoryItem
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// InventoryItemsListResponse: Inventory item List Response
-type InventoryItemsListResponse struct {
- // InventoryItems: Inventory item collection
- InventoryItems []*InventoryItem `json:"inventoryItems,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#inventoryItemsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "InventoryItems") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InventoryItemsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod InventoryItemsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// KeyValueTargetingExpression: Key Value Targeting Expression.
-type KeyValueTargetingExpression struct {
- // Expression: Keyword expression being targeted by the ad.
- Expression string `json:"expression,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Expression") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *KeyValueTargetingExpression) MarshalJSON() ([]byte, error) {
- type noMethod KeyValueTargetingExpression
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LandingPage: Contains information about where a user's browser is
-// taken after the user clicks an ad.
-type LandingPage struct {
- // Default: Whether or not this landing page will be assigned to any ads
- // or creatives that do not have a landing page assigned explicitly.
- // Only one default landing page is allowed per campaign.
- Default bool `json:"default,omitempty"`
-
- // Id: ID of this landing page. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#landingPage".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this landing page. This is a required field. It must be
- // less than 256 characters long, and must be unique among landing pages
- // of the same campaign.
- Name string `json:"name,omitempty"`
-
- // Url: URL of this landing page. This is a required field.
- Url string `json:"url,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Default") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LandingPage) MarshalJSON() ([]byte, error) {
- type noMethod LandingPage
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LandingPagesListResponse: Landing Page List Response
-type LandingPagesListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#landingPagesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // LandingPages: Landing page collection
- LandingPages []*LandingPage `json:"landingPages,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LandingPagesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod LandingPagesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LastModifiedInfo: Modification timestamp.
-type LastModifiedInfo struct {
- // Time: Timestamp of the last change in milliseconds since epoch.
- Time int64 `json:"time,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "Time") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LastModifiedInfo) MarshalJSON() ([]byte, error) {
- type noMethod LastModifiedInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListPopulationClause: A group clause made up of list population terms
-// representing constraints joined by ORs.
-type ListPopulationClause struct {
- // Terms: Terms of this list population clause. Each clause is made up
- // of list population terms representing constraints and are joined by
- // ORs.
- Terms []*ListPopulationTerm `json:"terms,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Terms") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListPopulationClause) MarshalJSON() ([]byte, error) {
- type noMethod ListPopulationClause
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListPopulationRule: Remarketing List Population Rule.
-type ListPopulationRule struct {
- // FloodlightActivityId: Floodlight activity ID associated with this
- // rule. This field can be left blank.
- FloodlightActivityId int64 `json:"floodlightActivityId,omitempty,string"`
-
- // FloodlightActivityName: Name of floodlight activity associated with
- // this rule. This is a read-only, auto-generated field.
- FloodlightActivityName string `json:"floodlightActivityName,omitempty"`
-
- // ListPopulationClauses: Clauses that make up this list population
- // rule. Clauses are joined by ANDs, and the clauses themselves are made
- // up of list population terms which are joined by ORs.
- ListPopulationClauses []*ListPopulationClause `json:"listPopulationClauses,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "FloodlightActivityId") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListPopulationRule) MarshalJSON() ([]byte, error) {
- type noMethod ListPopulationRule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListPopulationTerm: Remarketing List Population Rule Term.
-type ListPopulationTerm struct {
- // Contains: Will be true if the term should check if the user is in the
- // list and false if the term should check if the user is not in the
- // list. This field is only relevant when type is set to
- // LIST_MEMBERSHIP_TERM. False by default.
- Contains bool `json:"contains,omitempty"`
-
- // Negation: Whether to negate the comparison result of this term during
- // rule evaluation. This field is only relevant when type is left unset
- // or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- Negation bool `json:"negation,omitempty"`
-
- // Operator: Comparison operator of this term. This field is only
- // relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or
- // REFERRER_TERM.
- //
- // Possible values:
- // "NUM_EQUALS"
- // "NUM_GREATER_THAN"
- // "NUM_GREATER_THAN_EQUAL"
- // "NUM_LESS_THAN"
- // "NUM_LESS_THAN_EQUAL"
- // "STRING_CONTAINS"
- // "STRING_EQUALS"
- Operator string `json:"operator,omitempty"`
-
- // RemarketingListId: ID of the list in question. This field is only
- // relevant when type is set to LIST_MEMBERSHIP_TERM.
- RemarketingListId int64 `json:"remarketingListId,omitempty,string"`
-
- // Type: List population term type determines the applicable fields in
- // this object. If left unset or set to CUSTOM_VARIABLE_TERM, then
- // variableName, variableFriendlyName, operator, value, and negation are
- // applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and
- // contains are applicable. If set to REFERRER_TERM then operator,
- // value, and negation are applicable.
- //
- // Possible values:
- // "CUSTOM_VARIABLE_TERM"
- // "LIST_MEMBERSHIP_TERM"
- // "REFERRER_TERM"
- Type string `json:"type,omitempty"`
-
- // Value: Literal to compare the variable to. This field is only
- // relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or
- // REFERRER_TERM.
- Value string `json:"value,omitempty"`
-
- // VariableFriendlyName: Friendly name of this term's variable. This is
- // a read-only, auto-generated field. This field is only relevant when
- // type is left unset or set to CUSTOM_VARIABLE_TERM.
- VariableFriendlyName string `json:"variableFriendlyName,omitempty"`
-
- // VariableName: Name of the variable (U1, U2, etc.) being compared in
- // this term. This field is only relevant when type is set to null,
- // CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- VariableName string `json:"variableName,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Contains") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListPopulationTerm) MarshalJSON() ([]byte, error) {
- type noMethod ListPopulationTerm
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListTargetingExpression: Remarketing List Targeting Expression.
-type ListTargetingExpression struct {
- // Expression: Expression describing which lists are being targeted by
- // the ad.
- Expression string `json:"expression,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Expression") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListTargetingExpression) MarshalJSON() ([]byte, error) {
- type noMethod ListTargetingExpression
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LookbackConfiguration: Lookback configuration settings.
-type LookbackConfiguration struct {
- // ClickDuration: Lookback window, in days, from the last time a given
- // user clicked on one of your ads. If you enter 0, clicks will not be
- // considered as triggering events for floodlight tracking. If you leave
- // this field blank, the default value for your account will be used.
- ClickDuration int64 `json:"clickDuration,omitempty"`
-
- // PostImpressionActivitiesDuration: Lookback window, in days, from the
- // last time a given user viewed one of your ads. If you enter 0,
- // impressions will not be considered as triggering events for
- // floodlight tracking. If you leave this field blank, the default value
- // for your account will be used.
- PostImpressionActivitiesDuration int64 `json:"postImpressionActivitiesDuration,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ClickDuration") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LookbackConfiguration) MarshalJSON() ([]byte, error) {
- type noMethod LookbackConfiguration
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Metric: Represents a metric.
-type Metric struct {
- // Kind: The kind of resource this is, in this case dfareporting#metric.
- Kind string `json:"kind,omitempty"`
-
- // Name: The metric name, e.g. dfa:impressions
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Metric) MarshalJSON() ([]byte, error) {
- type noMethod Metric
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Metro: Contains information about a metro region that can be targeted
-// by ads.
-type Metro struct {
- // CountryCode: Country code of the country to which this metro region
- // belongs.
- CountryCode string `json:"countryCode,omitempty"`
-
- // CountryDartId: DART ID of the country to which this metro region
- // belongs.
- CountryDartId int64 `json:"countryDartId,omitempty,string"`
-
- // DartId: DART ID of this metro region.
- DartId int64 `json:"dartId,omitempty,string"`
-
- // DmaId: DMA ID of this metro region. This is the ID used for targeting
- // and generating reports, and is equivalent to metro_code.
- DmaId int64 `json:"dmaId,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#metro".
- Kind string `json:"kind,omitempty"`
-
- // MetroCode: Metro code of this metro region. This is equivalent to
- // dma_id.
- MetroCode string `json:"metroCode,omitempty"`
-
- // Name: Name of this metro region.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CountryCode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Metro) MarshalJSON() ([]byte, error) {
- type noMethod Metro
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MetrosListResponse: Metro List Response
-type MetrosListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#metrosListResponse".
- Kind string `json:"kind,omitempty"`
-
- // Metros: Metro collection.
- Metros []*Metro `json:"metros,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MetrosListResponse) MarshalJSON() ([]byte, error) {
- type noMethod MetrosListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MobileCarrier: Contains information about a mobile carrier that can
-// be targeted by ads.
-type MobileCarrier struct {
- // CountryCode: Country code of the country to which this mobile carrier
- // belongs.
- CountryCode string `json:"countryCode,omitempty"`
-
- // CountryDartId: DART ID of the country to which this mobile carrier
- // belongs.
- CountryDartId int64 `json:"countryDartId,omitempty,string"`
-
- // Id: ID of this mobile carrier.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#mobileCarrier".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this mobile carrier.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CountryCode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MobileCarrier) MarshalJSON() ([]byte, error) {
- type noMethod MobileCarrier
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MobileCarriersListResponse: Mobile Carrier List Response
-type MobileCarriersListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#mobileCarriersListResponse".
- Kind string `json:"kind,omitempty"`
-
- // MobileCarriers: Mobile carrier collection.
- MobileCarriers []*MobileCarrier `json:"mobileCarriers,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MobileCarriersListResponse) MarshalJSON() ([]byte, error) {
- type noMethod MobileCarriersListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ObjectFilter: Object Filter.
-type ObjectFilter struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#objectFilter".
- Kind string `json:"kind,omitempty"`
-
- // ObjectIds: Applicable when status is ASSIGNED. The user has access to
- // objects with these object IDs.
- ObjectIds googleapi.Int64s `json:"objectIds,omitempty"`
-
- // Status: Status of the filter. NONE means the user has access to none
- // of the objects. ALL means the user has access to all objects.
- // ASSIGNED means the user has access to the objects with IDs in the
- // objectIds list.
- //
- // Possible values:
- // "ALL"
- // "ASSIGNED"
- // "NONE"
- Status string `json:"status,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ObjectFilter) MarshalJSON() ([]byte, error) {
- type noMethod ObjectFilter
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OffsetPosition: Offset Position.
-type OffsetPosition struct {
- // Left: Offset distance from left side of an asset or a window.
- Left int64 `json:"left,omitempty"`
-
- // Top: Offset distance from top side of an asset or a window.
- Top int64 `json:"top,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Left") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OffsetPosition) MarshalJSON() ([]byte, error) {
- type noMethod OffsetPosition
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OmnitureSettings: Omniture Integration Settings.
-type OmnitureSettings struct {
- // OmnitureCostDataEnabled: Whether placement cost data will be sent to
- // Omniture. This property can be enabled only if
- // omnitureIntegrationEnabled is true.
- OmnitureCostDataEnabled bool `json:"omnitureCostDataEnabled,omitempty"`
-
- // OmnitureIntegrationEnabled: Whether Omniture integration is enabled.
- // This property can be enabled only when the "Advanced Ad Serving"
- // account setting is enabled.
- OmnitureIntegrationEnabled bool `json:"omnitureIntegrationEnabled,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "OmnitureCostDataEnabled") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OmnitureSettings) MarshalJSON() ([]byte, error) {
- type noMethod OmnitureSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperatingSystem: Contains information about an operating system that
-// can be targeted by ads.
-type OperatingSystem struct {
- // DartId: DART ID of this operating system. This is the ID used for
- // targeting.
- DartId int64 `json:"dartId,omitempty,string"`
-
- // Desktop: Whether this operating system is for desktop.
- Desktop bool `json:"desktop,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#operatingSystem".
- Kind string `json:"kind,omitempty"`
-
- // Mobile: Whether this operating system is for mobile.
- Mobile bool `json:"mobile,omitempty"`
-
- // Name: Name of this operating system.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "DartId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperatingSystem) MarshalJSON() ([]byte, error) {
- type noMethod OperatingSystem
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperatingSystemVersion: Contains information about a particular
-// version of an operating system that can be targeted by ads.
-type OperatingSystemVersion struct {
- // Id: ID of this operating system version.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#operatingSystemVersion".
- Kind string `json:"kind,omitempty"`
-
- // MajorVersion: Major version (leftmost number) of this operating
- // system version.
- MajorVersion string `json:"majorVersion,omitempty"`
-
- // MinorVersion: Minor version (number after the first dot) of this
- // operating system version.
- MinorVersion string `json:"minorVersion,omitempty"`
-
- // Name: Name of this operating system version.
- Name string `json:"name,omitempty"`
-
- // OperatingSystem: Operating system of this operating system version.
- OperatingSystem *OperatingSystem `json:"operatingSystem,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperatingSystemVersion) MarshalJSON() ([]byte, error) {
- type noMethod OperatingSystemVersion
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperatingSystemVersionsListResponse: Operating System Version List
-// Response
-type OperatingSystemVersionsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#operatingSystemVersionsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // OperatingSystemVersions: Operating system version collection.
- OperatingSystemVersions []*OperatingSystemVersion `json:"operatingSystemVersions,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperatingSystemVersionsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod OperatingSystemVersionsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperatingSystemsListResponse: Operating System List Response
-type OperatingSystemsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#operatingSystemsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // OperatingSystems: Operating system collection.
- OperatingSystems []*OperatingSystem `json:"operatingSystems,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperatingSystemsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod OperatingSystemsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OptimizationActivity: Creative optimization activity.
-type OptimizationActivity struct {
- // FloodlightActivityId: Floodlight activity ID of this optimization
- // activity. This is a required field.
- FloodlightActivityId int64 `json:"floodlightActivityId,omitempty,string"`
-
- // FloodlightActivityIdDimensionValue: Dimension value for the ID of the
- // floodlight activity. This is a read-only, auto-generated field.
- FloodlightActivityIdDimensionValue *DimensionValue `json:"floodlightActivityIdDimensionValue,omitempty"`
-
- // Weight: Weight associated with this optimization. Must be greater
- // than 1. The weight assigned will be understood in proportion to the
- // weights assigned to the other optimization activities.
- Weight int64 `json:"weight,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "FloodlightActivityId") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OptimizationActivity) MarshalJSON() ([]byte, error) {
- type noMethod OptimizationActivity
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Order: Describes properties of a DoubleClick Planning order.
-type Order struct {
- // AccountId: Account ID of this order.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this order.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // ApproverUserProfileIds: IDs for users that have to approve documents
- // created for this order.
- ApproverUserProfileIds googleapi.Int64s `json:"approverUserProfileIds,omitempty"`
-
- // BuyerInvoiceId: Buyer invoice ID associated with this order.
- BuyerInvoiceId string `json:"buyerInvoiceId,omitempty"`
-
- // BuyerOrganizationName: Name of the buyer organization.
- BuyerOrganizationName string `json:"buyerOrganizationName,omitempty"`
-
- // Comments: Comments in this order.
- Comments string `json:"comments,omitempty"`
-
- // Contacts: Contacts for this order.
- Contacts []*OrderContact `json:"contacts,omitempty"`
-
- // Id: ID of this order. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#order".
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedInfo: Information about the most recent modification of
- // this order.
- LastModifiedInfo *LastModifiedInfo `json:"lastModifiedInfo,omitempty"`
-
- // Name: Name of this order.
- Name string `json:"name,omitempty"`
-
- // Notes: Notes of this order.
- Notes string `json:"notes,omitempty"`
-
- // PlanningTermId: ID of the terms and conditions template used in this
- // order.
- PlanningTermId int64 `json:"planningTermId,omitempty,string"`
-
- // ProjectId: Project ID of this order.
- ProjectId int64 `json:"projectId,omitempty,string"`
-
- // SellerOrderId: Seller order ID associated with this order.
- SellerOrderId string `json:"sellerOrderId,omitempty"`
-
- // SellerOrganizationName: Name of the seller organization.
- SellerOrganizationName string `json:"sellerOrganizationName,omitempty"`
-
- // SiteId: Site IDs this order is associated with.
- SiteId googleapi.Int64s `json:"siteId,omitempty"`
-
- // SiteNames: Free-form site names this order is associated with.
- SiteNames []string `json:"siteNames,omitempty"`
-
- // SubaccountId: Subaccount ID of this order.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // TermsAndConditions: Terms and conditions of this order.
- TermsAndConditions string `json:"termsAndConditions,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Order) MarshalJSON() ([]byte, error) {
- type noMethod Order
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OrderContact: Contact of an order.
-type OrderContact struct {
- // ContactInfo: Free-form information about this contact. It could be
- // any information related to this contact in addition to type, title,
- // name, and signature user profile ID.
- ContactInfo string `json:"contactInfo,omitempty"`
-
- // ContactName: Name of this contact.
- ContactName string `json:"contactName,omitempty"`
-
- // ContactTitle: Title of this contact.
- ContactTitle string `json:"contactTitle,omitempty"`
-
- // ContactType: Type of this contact.
- //
- // Possible values:
- // "PLANNING_ORDER_CONTACT_BUYER_BILLING_CONTACT"
- // "PLANNING_ORDER_CONTACT_BUYER_CONTACT"
- // "PLANNING_ORDER_CONTACT_SELLER_CONTACT"
- ContactType string `json:"contactType,omitempty"`
-
- // SignatureUserProfileId: ID of the user profile containing the
- // signature that will be embedded into order documents.
- SignatureUserProfileId int64 `json:"signatureUserProfileId,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "ContactInfo") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderContact) MarshalJSON() ([]byte, error) {
- type noMethod OrderContact
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OrderDocument: Contains properties of a DoubleClick Planning order
-// document.
-type OrderDocument struct {
- // AccountId: Account ID of this order document.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this order document.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AmendedOrderDocumentId: The amended order document ID of this order
- // document. An order document can be created by optionally amending
- // another order document so that the change history can be preserved.
- AmendedOrderDocumentId int64 `json:"amendedOrderDocumentId,omitempty,string"`
-
- // ApprovedByUserProfileIds: IDs of users who have approved this order
- // document.
- ApprovedByUserProfileIds googleapi.Int64s `json:"approvedByUserProfileIds,omitempty"`
-
- // Cancelled: Whether this order document is cancelled.
- Cancelled bool `json:"cancelled,omitempty"`
-
- // CreatedInfo: Information about the creation of this order document.
- CreatedInfo *LastModifiedInfo `json:"createdInfo,omitempty"`
-
- // EffectiveDate: Effective date of this order document.
- EffectiveDate string `json:"effectiveDate,omitempty"`
-
- // Id: ID of this order document.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#orderDocument".
- Kind string `json:"kind,omitempty"`
-
- // OrderId: ID of the order from which this order document is created.
- OrderId int64 `json:"orderId,omitempty,string"`
-
- // ProjectId: Project ID of this order document.
- ProjectId int64 `json:"projectId,omitempty,string"`
-
- // Signed: Whether this order document has been signed.
- Signed bool `json:"signed,omitempty"`
-
- // SubaccountId: Subaccount ID of this order document.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // Title: Title of this order document.
- Title string `json:"title,omitempty"`
-
- // Type: Type of this order document
- //
- // Possible values:
- // "PLANNING_ORDER_TYPE_CHANGE_ORDER"
- // "PLANNING_ORDER_TYPE_INSERTION_ORDER"
- Type string `json:"type,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderDocument) MarshalJSON() ([]byte, error) {
- type noMethod OrderDocument
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OrderDocumentsListResponse: Order document List Response
-type OrderDocumentsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#orderDocumentsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // OrderDocuments: Order document collection
- OrderDocuments []*OrderDocument `json:"orderDocuments,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderDocumentsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrderDocumentsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OrdersListResponse: Order List Response
-type OrdersListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#ordersListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Orders: Order collection.
- Orders []*Order `json:"orders,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersListResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PathToConversionReportCompatibleFields: Represents fields that are
-// compatible to be selected for a report of type "PATH_TO_CONVERSION".
-type PathToConversionReportCompatibleFields struct {
- // ConversionDimensions: Conversion dimensions which are compatible to
- // be selected in the "conversionDimensions" section of the report.
- ConversionDimensions []*Dimension `json:"conversionDimensions,omitempty"`
-
- // CustomFloodlightVariables: Custom floodlight variables which are
- // compatible to be selected in the "customFloodlightVariables" section
- // of the report.
- CustomFloodlightVariables []*Dimension `json:"customFloodlightVariables,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#pathToConversionReportCompatibleFields.
- Kind string `json:"kind,omitempty"`
-
- // Metrics: Metrics which are compatible to be selected in the
- // "metricNames" section of the report.
- Metrics []*Metric `json:"metrics,omitempty"`
-
- // PerInteractionDimensions: Per-interaction dimensions which are
- // compatible to be selected in the "perInteractionDimensions" section
- // of the report.
- PerInteractionDimensions []*Dimension `json:"perInteractionDimensions,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "ConversionDimensions") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PathToConversionReportCompatibleFields) MarshalJSON() ([]byte, error) {
- type noMethod PathToConversionReportCompatibleFields
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Placement: Contains properties of a placement.
-type Placement struct {
- // AccountId: Account ID of this placement. This field can be left
- // blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this placement. This field can be left
- // blank.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // Archived: Whether this placement is archived.
- Archived bool `json:"archived,omitempty"`
-
- // CampaignId: Campaign ID of this placement. This field is a required
- // field on insertion.
- CampaignId int64 `json:"campaignId,omitempty,string"`
-
- // CampaignIdDimensionValue: Dimension value for the ID of the campaign.
- // This is a read-only, auto-generated field.
- CampaignIdDimensionValue *DimensionValue `json:"campaignIdDimensionValue,omitempty"`
-
- // Comment: Comments for this placement.
- Comment string `json:"comment,omitempty"`
-
- // Compatibility: Placement compatibility. WEB and WEB_INTERSTITIAL
- // refer to rendering either on desktop or on mobile devices for regular
- // or interstitial ads, respectively. APP and APP_INTERSTITIAL are for
- // rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in
- // in-stream video ads developed with the VAST standard. This field is
- // required on insertion.
- //
- // Possible values:
- // "APP"
- // "APP_INTERSTITIAL"
- // "IN_STREAM_VIDEO"
- // "WEB"
- // "WEB_INTERSTITIAL"
- Compatibility string `json:"compatibility,omitempty"`
-
- // ContentCategoryId: ID of the content category assigned to this
- // placement.
- ContentCategoryId int64 `json:"contentCategoryId,omitempty,string"`
-
- // CreateInfo: Information about the creation of this placement. This is
- // a read-only field.
- CreateInfo *LastModifiedInfo `json:"createInfo,omitempty"`
-
- // DirectorySiteId: Directory site ID of this placement. On insert, you
- // must set either this field or the siteId field to specify the site
- // associated with this placement. This is a required field that is
- // read-only after insertion.
- DirectorySiteId int64 `json:"directorySiteId,omitempty,string"`
-
- // DirectorySiteIdDimensionValue: Dimension value for the ID of the
- // directory site. This is a read-only, auto-generated field.
- DirectorySiteIdDimensionValue *DimensionValue `json:"directorySiteIdDimensionValue,omitempty"`
-
- // ExternalId: External ID for this placement.
- ExternalId string `json:"externalId,omitempty"`
-
- // Id: ID of this placement. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this placement. This
- // is a read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // KeyName: Key name of this placement. This is a read-only,
- // auto-generated field.
- KeyName string `json:"keyName,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#placement".
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedInfo: Information about the most recent modification of
- // this placement. This is a read-only field.
- LastModifiedInfo *LastModifiedInfo `json:"lastModifiedInfo,omitempty"`
-
- // LookbackConfiguration: Lookback window settings for this placement.
- LookbackConfiguration *LookbackConfiguration `json:"lookbackConfiguration,omitempty"`
-
- // Name: Name of this placement.This is a required field and must be
- // less than 256 characters long.
- Name string `json:"name,omitempty"`
-
- // PaymentApproved: Whether payment was approved for this placement.
- // This is a read-only field relevant only to publisher-paid placements.
- PaymentApproved bool `json:"paymentApproved,omitempty"`
-
- // PaymentSource: Payment source for this placement. This is a required
- // field that is read-only after insertion.
- //
- // Possible values:
- // "PLACEMENT_AGENCY_PAID"
- // "PLACEMENT_PUBLISHER_PAID"
- PaymentSource string `json:"paymentSource,omitempty"`
-
- // PlacementGroupId: ID of this placement's group, if applicable.
- PlacementGroupId int64 `json:"placementGroupId,omitempty,string"`
-
- // PlacementGroupIdDimensionValue: Dimension value for the ID of the
- // placement group. This is a read-only, auto-generated field.
- PlacementGroupIdDimensionValue *DimensionValue `json:"placementGroupIdDimensionValue,omitempty"`
-
- // PlacementStrategyId: ID of the placement strategy assigned to this
- // placement.
- PlacementStrategyId int64 `json:"placementStrategyId,omitempty,string"`
-
- // PricingSchedule: Pricing schedule of this placement. This field is
- // required on insertion, specifically subfields startDate, endDate and
- // pricingType.
- PricingSchedule *PricingSchedule `json:"pricingSchedule,omitempty"`
-
- // Primary: Whether this placement is the primary placement of a
- // roadblock (placement group). You cannot change this field from true
- // to false. Setting this field to true will automatically set the
- // primary field on the original primary placement of the roadblock to
- // false, and it will automatically set the roadblock's
- // primaryPlacementId field to the ID of this placement.
- Primary bool `json:"primary,omitempty"`
-
- // PublisherUpdateInfo: Information about the last publisher update.
- // This is a read-only field.
- PublisherUpdateInfo *LastModifiedInfo `json:"publisherUpdateInfo,omitempty"`
-
- // SiteId: Site ID associated with this placement. On insert, you must
- // set either this field or the directorySiteId field to specify the
- // site associated with this placement. This is a required field that is
- // read-only after insertion.
- SiteId int64 `json:"siteId,omitempty,string"`
-
- // SiteIdDimensionValue: Dimension value for the ID of the site. This is
- // a read-only, auto-generated field.
- SiteIdDimensionValue *DimensionValue `json:"siteIdDimensionValue,omitempty"`
-
- // Size: Size associated with this placement. When inserting or updating
- // a placement, only the size ID field is used. This field is required
- // on insertion.
- Size *Size `json:"size,omitempty"`
-
- // SslRequired: Whether creatives assigned to this placement must be
- // SSL-compliant.
- SslRequired bool `json:"sslRequired,omitempty"`
-
- // Status: Third-party placement status.
- //
- // Possible values:
- // "ACKNOWLEDGE_ACCEPTANCE"
- // "ACKNOWLEDGE_REJECTION"
- // "DRAFT"
- // "PAYMENT_ACCEPTED"
- // "PAYMENT_REJECTED"
- // "PENDING_REVIEW"
- Status string `json:"status,omitempty"`
-
- // SubaccountId: Subaccount ID of this placement. This field can be left
- // blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // TagFormats: Tag formats to generate for this placement. This field is
- // required on insertion.
- // Acceptable values are:
- // - "PLACEMENT_TAG_STANDARD"
- // - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
- // - "PLACEMENT_TAG_IFRAME_ILAYER"
- // - "PLACEMENT_TAG_INTERNAL_REDIRECT"
- // - "PLACEMENT_TAG_JAVASCRIPT"
- // - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
- // - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
- // - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
- // - "PLACEMENT_TAG_CLICK_COMMANDS"
- // - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
- // - "PLACEMENT_TAG_TRACKING"
- // - "PLACEMENT_TAG_TRACKING_IFRAME"
- // - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- //
- // Possible values:
- // "PLACEMENT_TAG_CLICK_COMMANDS"
- // "PLACEMENT_TAG_IFRAME_ILAYER"
- // "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
- // "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY"
- // "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
- // "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3"
- // "PLACEMENT_TAG_INTERNAL_REDIRECT"
- // "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
- // "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY"
- // "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
- // "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
- // "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY"
- // "PLACEMENT_TAG_JAVASCRIPT"
- // "PLACEMENT_TAG_JAVASCRIPT_LEGACY"
- // "PLACEMENT_TAG_STANDARD"
- // "PLACEMENT_TAG_TRACKING"
- // "PLACEMENT_TAG_TRACKING_IFRAME"
- // "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- TagFormats []string `json:"tagFormats,omitempty"`
-
- // TagSetting: Tag settings for this placement.
- TagSetting *TagSetting `json:"tagSetting,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Placement) MarshalJSON() ([]byte, error) {
- type noMethod Placement
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlacementAssignment: Placement Assignment.
-type PlacementAssignment struct {
- // Active: Whether this placement assignment is active. When true, the
- // placement will be included in the ad's rotation.
- Active bool `json:"active,omitempty"`
-
- // PlacementId: ID of the placement to be assigned. This is a required
- // field.
- PlacementId int64 `json:"placementId,omitempty,string"`
-
- // PlacementIdDimensionValue: Dimension value for the ID of the
- // placement. This is a read-only, auto-generated field.
- PlacementIdDimensionValue *DimensionValue `json:"placementIdDimensionValue,omitempty"`
-
- // SslRequired: Whether the placement to be assigned requires SSL. This
- // is a read-only field that is auto-generated when the ad is inserted
- // or updated.
- SslRequired bool `json:"sslRequired,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Active") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlacementAssignment) MarshalJSON() ([]byte, error) {
- type noMethod PlacementAssignment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlacementGroup: Contains properties of a package or roadblock.
-type PlacementGroup struct {
- // AccountId: Account ID of this placement group. This is a read-only
- // field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this placement group. This is a
- // required field on insertion.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // Archived: Whether this placement group is archived.
- Archived bool `json:"archived,omitempty"`
-
- // CampaignId: Campaign ID of this placement group. This field is
- // required on insertion.
- CampaignId int64 `json:"campaignId,omitempty,string"`
-
- // CampaignIdDimensionValue: Dimension value for the ID of the campaign.
- // This is a read-only, auto-generated field.
- CampaignIdDimensionValue *DimensionValue `json:"campaignIdDimensionValue,omitempty"`
-
- // ChildPlacementIds: IDs of placements which are assigned to this
- // placement group. This is a read-only, auto-generated field.
- ChildPlacementIds googleapi.Int64s `json:"childPlacementIds,omitempty"`
-
- // Comment: Comments for this placement group.
- Comment string `json:"comment,omitempty"`
-
- // ContentCategoryId: ID of the content category assigned to this
- // placement group.
- ContentCategoryId int64 `json:"contentCategoryId,omitempty,string"`
-
- // CreateInfo: Information about the creation of this placement group.
- // This is a read-only field.
- CreateInfo *LastModifiedInfo `json:"createInfo,omitempty"`
-
- // DirectorySiteId: Directory site ID associated with this placement
- // group. On insert, you must set either this field or the site_id field
- // to specify the site associated with this placement group. This is a
- // required field that is read-only after insertion.
- DirectorySiteId int64 `json:"directorySiteId,omitempty,string"`
-
- // DirectorySiteIdDimensionValue: Dimension value for the ID of the
- // directory site. This is a read-only, auto-generated field.
- DirectorySiteIdDimensionValue *DimensionValue `json:"directorySiteIdDimensionValue,omitempty"`
-
- // ExternalId: External ID for this placement.
- ExternalId string `json:"externalId,omitempty"`
-
- // Id: ID of this placement group. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this placement group.
- // This is a read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#placementGroup".
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedInfo: Information about the most recent modification of
- // this placement group. This is a read-only field.
- LastModifiedInfo *LastModifiedInfo `json:"lastModifiedInfo,omitempty"`
-
- // Name: Name of this placement group. This is a required field and must
- // be less than 256 characters long.
- Name string `json:"name,omitempty"`
-
- // PlacementGroupType: Type of this placement group. A package is a
- // simple group of placements that acts as a single pricing point for a
- // group of tags. A roadblock is a group of placements that not only
- // acts as a single pricing point, but also assumes that all the tags in
- // it will be served at the same time. A roadblock requires one of its
- // assigned placements to be marked as primary for reporting. This field
- // is required on insertion.
- //
- // Possible values:
- // "PLACEMENT_PACKAGE"
- // "PLACEMENT_ROADBLOCK"
- PlacementGroupType string `json:"placementGroupType,omitempty"`
-
- // PlacementStrategyId: ID of the placement strategy assigned to this
- // placement group.
- PlacementStrategyId int64 `json:"placementStrategyId,omitempty,string"`
-
- // PricingSchedule: Pricing schedule of this placement group. This field
- // is required on insertion.
- PricingSchedule *PricingSchedule `json:"pricingSchedule,omitempty"`
-
- // PrimaryPlacementId: ID of the primary placement, used to calculate
- // the media cost of a roadblock (placement group). Modifying this field
- // will automatically modify the primary field on all affected roadblock
- // child placements.
- PrimaryPlacementId int64 `json:"primaryPlacementId,omitempty,string"`
-
- // PrimaryPlacementIdDimensionValue: Dimension value for the ID of the
- // primary placement. This is a read-only, auto-generated field.
- PrimaryPlacementIdDimensionValue *DimensionValue `json:"primaryPlacementIdDimensionValue,omitempty"`
-
- // ProgrammaticSetting: Settings for a programmatic placement.
- ProgrammaticSetting *ProgrammaticSetting `json:"programmaticSetting,omitempty"`
-
- // SiteId: Site ID associated with this placement group. On insert, you
- // must set either this field or the directorySiteId field to specify
- // the site associated with this placement group. This is a required
- // field that is read-only after insertion.
- SiteId int64 `json:"siteId,omitempty,string"`
-
- // SiteIdDimensionValue: Dimension value for the ID of the site. This is
- // a read-only, auto-generated field.
- SiteIdDimensionValue *DimensionValue `json:"siteIdDimensionValue,omitempty"`
-
- // SubaccountId: Subaccount ID of this placement group. This is a
- // read-only field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlacementGroup) MarshalJSON() ([]byte, error) {
- type noMethod PlacementGroup
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlacementGroupsListResponse: Placement Group List Response
-type PlacementGroupsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#placementGroupsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // PlacementGroups: Placement group collection.
- PlacementGroups []*PlacementGroup `json:"placementGroups,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlacementGroupsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod PlacementGroupsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlacementStrategiesListResponse: Placement Strategy List Response
-type PlacementStrategiesListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#placementStrategiesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // PlacementStrategies: Placement strategy collection.
- PlacementStrategies []*PlacementStrategy `json:"placementStrategies,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlacementStrategiesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod PlacementStrategiesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlacementStrategy: Contains properties of a placement strategy.
-type PlacementStrategy struct {
- // AccountId: Account ID of this placement strategy.This is a read-only
- // field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Id: ID of this placement strategy. This is a read-only,
- // auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#placementStrategy".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this placement strategy. This is a required field. It
- // must be less than 256 characters long and unique among placement
- // strategies of the same account.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlacementStrategy) MarshalJSON() ([]byte, error) {
- type noMethod PlacementStrategy
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlacementTag: Placement Tag
-type PlacementTag struct {
- // PlacementId: Placement ID
- PlacementId int64 `json:"placementId,omitempty,string"`
-
- // TagDatas: Tags generated for this placement.
- TagDatas []*TagData `json:"tagDatas,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "PlacementId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlacementTag) MarshalJSON() ([]byte, error) {
- type noMethod PlacementTag
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlacementsGenerateTagsResponse: Placement GenerateTags Response
-type PlacementsGenerateTagsResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#placementsGenerateTagsResponse".
- Kind string `json:"kind,omitempty"`
-
- // PlacementTags: Set of generated tags for the specified placements.
- PlacementTags []*PlacementTag `json:"placementTags,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlacementsGenerateTagsResponse) MarshalJSON() ([]byte, error) {
- type noMethod PlacementsGenerateTagsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlacementsListResponse: Placement List Response
-type PlacementsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#placementsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Placements: Placement collection.
- Placements []*Placement `json:"placements,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlacementsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod PlacementsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlatformType: Contains information about a platform type that can be
-// targeted by ads.
-type PlatformType struct {
- // Id: ID of this platform type.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#platformType".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this platform type.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlatformType) MarshalJSON() ([]byte, error) {
- type noMethod PlatformType
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlatformTypesListResponse: Platform Type List Response
-type PlatformTypesListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#platformTypesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // PlatformTypes: Platform type collection.
- PlatformTypes []*PlatformType `json:"platformTypes,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlatformTypesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod PlatformTypesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PopupWindowProperties: Popup Window Properties.
-type PopupWindowProperties struct {
- // Dimension: Popup dimension for a creative. This is a read-only field.
- // Applicable to the following creative types: all RICH_MEDIA and all
- // VPAID
- Dimension *Size `json:"dimension,omitempty"`
-
- // Offset: Upper-left corner coordinates of the popup window. Applicable
- // if positionType is COORDINATES.
- Offset *OffsetPosition `json:"offset,omitempty"`
-
- // PositionType: Popup window position either centered or at specific
- // coordinate.
- //
- // Possible values:
- // "CENTER"
- // "COORDINATES"
- PositionType string `json:"positionType,omitempty"`
-
- // ShowAddressBar: Whether to display the browser address bar.
- ShowAddressBar bool `json:"showAddressBar,omitempty"`
-
- // ShowMenuBar: Whether to display the browser menu bar.
- ShowMenuBar bool `json:"showMenuBar,omitempty"`
-
- // ShowScrollBar: Whether to display the browser scroll bar.
- ShowScrollBar bool `json:"showScrollBar,omitempty"`
-
- // ShowStatusBar: Whether to display the browser status bar.
- ShowStatusBar bool `json:"showStatusBar,omitempty"`
-
- // ShowToolBar: Whether to display the browser tool bar.
- ShowToolBar bool `json:"showToolBar,omitempty"`
-
- // Title: Title of popup window.
- Title string `json:"title,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Dimension") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PopupWindowProperties) MarshalJSON() ([]byte, error) {
- type noMethod PopupWindowProperties
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PostalCode: Contains information about a postal code that can be
-// targeted by ads.
-type PostalCode struct {
- // Code: Postal code. This is equivalent to the id field.
- Code string `json:"code,omitempty"`
-
- // CountryCode: Country code of the country to which this postal code
- // belongs.
- CountryCode string `json:"countryCode,omitempty"`
-
- // CountryDartId: DART ID of the country to which this postal code
- // belongs.
- CountryDartId int64 `json:"countryDartId,omitempty,string"`
-
- // Id: ID of this postal code.
- Id string `json:"id,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#postalCode".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PostalCode) MarshalJSON() ([]byte, error) {
- type noMethod PostalCode
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PostalCodesListResponse: Postal Code List Response
-type PostalCodesListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#postalCodesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // PostalCodes: Postal code collection.
- PostalCodes []*PostalCode `json:"postalCodes,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PostalCodesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod PostalCodesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Pricing: Pricing Information
-type Pricing struct {
- // CapCostType: Cap cost type of this inventory item.
- //
- // Possible values:
- // "PLANNING_PLACEMENT_CAP_COST_TYPE_CUMULATIVE"
- // "PLANNING_PLACEMENT_CAP_COST_TYPE_MONTHLY"
- // "PLANNING_PLACEMENT_CAP_COST_TYPE_NONE"
- CapCostType string `json:"capCostType,omitempty"`
-
- // EndDate: End date of this inventory item.
- EndDate string `json:"endDate,omitempty"`
-
- // Flights: Flights of this inventory item. A flight (a.k.a. pricing
- // period) represents the inventory item pricing information for a
- // specific period of time.
- Flights []*Flight `json:"flights,omitempty"`
-
- // GroupType: Group type of this inventory item if it represents a
- // placement group. Is null otherwise. There are two type of placement
- // groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of
- // inventory items that acts as a single pricing point for a group of
- // tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory
- // items that not only acts as a single pricing point, but also assumes
- // that all the tags in it will be served at the same time. A roadblock
- // requires one of its assigned inventory items to be marked as primary.
- //
- // Possible values:
- // "PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE"
- // "PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK"
- GroupType string `json:"groupType,omitempty"`
-
- // PricingType: Pricing type of this inventory item.
- //
- // Possible values:
- // "PLANNING_PLACEMENT_PRICING_TYPE_CLICKS"
- // "PLANNING_PLACEMENT_PRICING_TYPE_CPA"
- // "PLANNING_PLACEMENT_PRICING_TYPE_CPC"
- // "PLANNING_PLACEMENT_PRICING_TYPE_CPM"
- // "PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_CLICKS"
- // "PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_IMPRESSIONS"
- // "PLANNING_PLACEMENT_PRICING_TYPE_IMPRESSIONS"
- PricingType string `json:"pricingType,omitempty"`
-
- // StartDate: Start date of this inventory item.
- StartDate string `json:"startDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CapCostType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Pricing) MarshalJSON() ([]byte, error) {
- type noMethod Pricing
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PricingSchedule: Pricing Schedule
-type PricingSchedule struct {
- // CapCostOption: Placement cap cost option.
- //
- // Possible values:
- // "CAP_COST_CUMULATIVE"
- // "CAP_COST_MONTHLY"
- // "CAP_COST_NONE"
- CapCostOption string `json:"capCostOption,omitempty"`
-
- // DisregardOverdelivery: Whether cap costs are ignored by ad serving.
- DisregardOverdelivery bool `json:"disregardOverdelivery,omitempty"`
-
- // EndDate: Placement end date. This date must be later than, or the
- // same day as, the placement start date, but not later than the
- // campaign end date. If, for example, you set 6/25/2015 as both the
- // start and end dates, the effective placement date is just that day
- // only, 6/25/2015. The hours, minutes, and seconds of the end date
- // should not be set, as doing so will result in an error. This field is
- // required on insertion.
- EndDate string `json:"endDate,omitempty"`
-
- // Flighted: Whether this placement is flighted. If true, pricing
- // periods will be computed automatically.
- Flighted bool `json:"flighted,omitempty"`
-
- // FloodlightActivityId: Floodlight activity ID associated with this
- // placement. This field should be set when placement pricing type is
- // set to PRICING_TYPE_CPA.
- FloodlightActivityId int64 `json:"floodlightActivityId,omitempty,string"`
-
- // PricingPeriods: Pricing periods for this placement.
- PricingPeriods []*PricingSchedulePricingPeriod `json:"pricingPeriods,omitempty"`
-
- // PricingType: Placement pricing type. This field is required on
- // insertion.
- //
- // Possible values:
- // "PRICING_TYPE_CPA"
- // "PRICING_TYPE_CPC"
- // "PRICING_TYPE_CPM"
- // "PRICING_TYPE_FLAT_RATE_CLICKS"
- // "PRICING_TYPE_FLAT_RATE_IMPRESSIONS"
- PricingType string `json:"pricingType,omitempty"`
-
- // StartDate: Placement start date. This date must be later than, or the
- // same day as, the campaign start date. The hours, minutes, and seconds
- // of the start date should not be set, as doing so will result in an
- // error. This field is required on insertion.
- StartDate string `json:"startDate,omitempty"`
-
- // TestingStartDate: Testing start date of this placement. The hours,
- // minutes, and seconds of the start date should not be set, as doing so
- // will result in an error.
- TestingStartDate string `json:"testingStartDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CapCostOption") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PricingSchedule) MarshalJSON() ([]byte, error) {
- type noMethod PricingSchedule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PricingSchedulePricingPeriod: Pricing Period
-type PricingSchedulePricingPeriod struct {
- // EndDate: Pricing period end date. This date must be later than, or
- // the same day as, the pricing period start date, but not later than
- // the placement end date. The period end date can be the same date as
- // the period start date. If, for example, you set 6/25/2015 as both the
- // start and end dates, the effective pricing period date is just that
- // day only, 6/25/2015. The hours, minutes, and seconds of the end date
- // should not be set, as doing so will result in an error.
- EndDate string `json:"endDate,omitempty"`
-
- // PricingComment: Comments for this pricing period.
- PricingComment string `json:"pricingComment,omitempty"`
-
- // RateOrCostNanos: Rate or cost of this pricing period.
- RateOrCostNanos int64 `json:"rateOrCostNanos,omitempty,string"`
-
- // StartDate: Pricing period start date. This date must be later than,
- // or the same day as, the placement start date. The hours, minutes, and
- // seconds of the start date should not be set, as doing so will result
- // in an error.
- StartDate string `json:"startDate,omitempty"`
-
- // Units: Units of this pricing period.
- Units int64 `json:"units,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "EndDate") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PricingSchedulePricingPeriod) MarshalJSON() ([]byte, error) {
- type noMethod PricingSchedulePricingPeriod
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ProgrammaticSetting: Programmatic Setting
-type ProgrammaticSetting struct {
- // AdxDealIds: Adx deal IDs assigned to the placement.
- AdxDealIds googleapi.Int64s `json:"adxDealIds,omitempty"`
-
- // InsertionOrderId: Insertion order ID.
- InsertionOrderId string `json:"insertionOrderId,omitempty"`
-
- // InsertionOrderIdStatus: Whether insertion order ID has been placed in
- // DFP. This is a read-only field.
- InsertionOrderIdStatus bool `json:"insertionOrderIdStatus,omitempty"`
-
- // MediaCostNanos: Media cost for the programmatic placement.
- MediaCostNanos int64 `json:"mediaCostNanos,omitempty,string"`
-
- // Programmatic: Whether programmatic is enabled.
- Programmatic bool `json:"programmatic,omitempty"`
-
- // TraffickerEmails: Trafficker emails assigned to the placement.
- TraffickerEmails []string `json:"traffickerEmails,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AdxDealIds") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProgrammaticSetting) MarshalJSON() ([]byte, error) {
- type noMethod ProgrammaticSetting
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Project: Contains properties of a DoubleClick Planning project.
-type Project struct {
- // AccountId: Account ID of this project.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this project.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AudienceAgeGroup: Audience age group of this project.
- //
- // Possible values:
- // "PLANNING_AUDIENCE_AGE_18_24"
- // "PLANNING_AUDIENCE_AGE_25_34"
- // "PLANNING_AUDIENCE_AGE_35_44"
- // "PLANNING_AUDIENCE_AGE_45_54"
- // "PLANNING_AUDIENCE_AGE_55_64"
- // "PLANNING_AUDIENCE_AGE_65_OR_MORE"
- // "PLANNING_AUDIENCE_AGE_UNKNOWN"
- AudienceAgeGroup string `json:"audienceAgeGroup,omitempty"`
-
- // AudienceGender: Audience gender of this project.
- //
- // Possible values:
- // "PLANNING_AUDIENCE_GENDER_FEMALE"
- // "PLANNING_AUDIENCE_GENDER_MALE"
- AudienceGender string `json:"audienceGender,omitempty"`
-
- // Budget: Budget of this project in the currency specified by the
- // current account. The value stored in this field represents only the
- // non-fractional amount. For example, for USD, the smallest value that
- // can be represented by this field is 1 US dollar.
- Budget int64 `json:"budget,omitempty,string"`
-
- // ClientBillingCode: Client billing code of this project.
- ClientBillingCode string `json:"clientBillingCode,omitempty"`
-
- // ClientName: Name of the project client.
- ClientName string `json:"clientName,omitempty"`
-
- // EndDate: End date of the project.
- EndDate string `json:"endDate,omitempty"`
-
- // Id: ID of this project. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#project".
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedInfo: Information about the most recent modification of
- // this project.
- LastModifiedInfo *LastModifiedInfo `json:"lastModifiedInfo,omitempty"`
-
- // Name: Name of this project.
- Name string `json:"name,omitempty"`
-
- // Overview: Overview of this project.
- Overview string `json:"overview,omitempty"`
-
- // StartDate: Start date of the project.
- StartDate string `json:"startDate,omitempty"`
-
- // SubaccountId: Subaccount ID of this project.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // TargetClicks: Number of clicks that the advertiser is targeting.
- TargetClicks int64 `json:"targetClicks,omitempty,string"`
-
- // TargetConversions: Number of conversions that the advertiser is
- // targeting.
- TargetConversions int64 `json:"targetConversions,omitempty,string"`
-
- // TargetCpaNanos: CPA that the advertiser is targeting.
- TargetCpaNanos int64 `json:"targetCpaNanos,omitempty,string"`
-
- // TargetCpcNanos: CPC that the advertiser is targeting.
- TargetCpcNanos int64 `json:"targetCpcNanos,omitempty,string"`
-
- // TargetCpmNanos: CPM that the advertiser is targeting.
- TargetCpmNanos int64 `json:"targetCpmNanos,omitempty,string"`
-
- // TargetImpressions: Number of impressions that the advertiser is
- // targeting.
- TargetImpressions int64 `json:"targetImpressions,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Project) MarshalJSON() ([]byte, error) {
- type noMethod Project
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ProjectsListResponse: Project List Response
-type ProjectsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#projectsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Projects: Project collection.
- Projects []*Project `json:"projects,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProjectsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod ProjectsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReachReportCompatibleFields: Represents fields that are compatible to
-// be selected for a report of type "REACH".
-type ReachReportCompatibleFields struct {
- // DimensionFilters: Dimensions which are compatible to be selected in
- // the "dimensionFilters" section of the report.
- DimensionFilters []*Dimension `json:"dimensionFilters,omitempty"`
-
- // Dimensions: Dimensions which are compatible to be selected in the
- // "dimensions" section of the report.
- Dimensions []*Dimension `json:"dimensions,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#reachReportCompatibleFields.
- Kind string `json:"kind,omitempty"`
-
- // Metrics: Metrics which are compatible to be selected in the
- // "metricNames" section of the report.
- Metrics []*Metric `json:"metrics,omitempty"`
-
- // PivotedActivityMetrics: Metrics which are compatible to be selected
- // as activity metrics to pivot on in the "activities" section of the
- // report.
- PivotedActivityMetrics []*Metric `json:"pivotedActivityMetrics,omitempty"`
-
- // ReachByFrequencyMetrics: Metrics which are compatible to be selected
- // in the "reachByFrequencyMetricNames" section of the report.
- ReachByFrequencyMetrics []*Metric `json:"reachByFrequencyMetrics,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionFilters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReachReportCompatibleFields) MarshalJSON() ([]byte, error) {
- type noMethod ReachReportCompatibleFields
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Recipient: Represents a recipient.
-type Recipient struct {
- // DeliveryType: The delivery type for the recipient.
- //
- // Possible values:
- // "ATTACHMENT"
- // "LINK"
- DeliveryType string `json:"deliveryType,omitempty"`
-
- // Email: The email address of the recipient.
- Email string `json:"email,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#recipient.
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DeliveryType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Recipient) MarshalJSON() ([]byte, error) {
- type noMethod Recipient
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Region: Contains information about a region that can be targeted by
-// ads.
-type Region struct {
- // CountryCode: Country code of the country to which this region
- // belongs.
- CountryCode string `json:"countryCode,omitempty"`
-
- // CountryDartId: DART ID of the country to which this region belongs.
- CountryDartId int64 `json:"countryDartId,omitempty,string"`
-
- // DartId: DART ID of this region.
- DartId int64 `json:"dartId,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#region".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this region.
- Name string `json:"name,omitempty"`
-
- // RegionCode: Region code.
- RegionCode string `json:"regionCode,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CountryCode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Region) MarshalJSON() ([]byte, error) {
- type noMethod Region
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// RegionsListResponse: Region List Response
-type RegionsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#regionsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // Regions: Region collection.
- Regions []*Region `json:"regions,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RegionsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod RegionsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// RemarketingList: Contains properties of a remarketing list.
-// Remarketing enables you to create lists of users who have performed
-// specific actions on a site, then target ads to members of those
-// lists. This resource can be used to manage remarketing lists that are
-// owned by your advertisers. To see all remarketing lists that are
-// visible to your advertisers, including those that are shared to your
-// advertiser or account, use the TargetableRemarketingLists resource.
-type RemarketingList struct {
- // AccountId: Account ID of this remarketing list. This is a read-only,
- // auto-generated field that is only returned in GET requests.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Active: Whether this remarketing list is active.
- Active bool `json:"active,omitempty"`
-
- // AdvertiserId: Dimension value for the advertiser ID that owns this
- // remarketing list. This is a required field.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // Description: Remarketing list description.
- Description string `json:"description,omitempty"`
-
- // Id: Remarketing list ID. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#remarketingList".
- Kind string `json:"kind,omitempty"`
-
- // LifeSpan: Number of days that a user should remain in the remarketing
- // list without an impression.
- LifeSpan int64 `json:"lifeSpan,omitempty,string"`
-
- // ListPopulationRule: Rule used to populate the remarketing list with
- // users.
- ListPopulationRule *ListPopulationRule `json:"listPopulationRule,omitempty"`
-
- // ListSize: Number of users currently in the list. This is a read-only
- // field.
- ListSize int64 `json:"listSize,omitempty,string"`
-
- // ListSource: Product from which this remarketing list was originated.
- //
- // Possible values:
- // "REMARKETING_LIST_SOURCE_DBM"
- // "REMARKETING_LIST_SOURCE_DFA"
- // "REMARKETING_LIST_SOURCE_DMP"
- // "REMARKETING_LIST_SOURCE_GA"
- // "REMARKETING_LIST_SOURCE_OTHER"
- ListSource string `json:"listSource,omitempty"`
-
- // Name: Name of the remarketing list. This is a required field. Must be
- // no greater than 128 characters long.
- Name string `json:"name,omitempty"`
-
- // SubaccountId: Subaccount ID of this remarketing list. This is a
- // read-only, auto-generated field that is only returned in GET
- // requests.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RemarketingList) MarshalJSON() ([]byte, error) {
- type noMethod RemarketingList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// RemarketingListShare: Contains properties of a remarketing list's
-// sharing information. Sharing allows other accounts or advertisers to
-// target to your remarketing lists. This resource can be used to manage
-// remarketing list sharing to other accounts and advertisers.
-type RemarketingListShare struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#remarketingListShare".
- Kind string `json:"kind,omitempty"`
-
- // RemarketingListId: Remarketing list ID. This is a read-only,
- // auto-generated field.
- RemarketingListId int64 `json:"remarketingListId,omitempty,string"`
-
- // SharedAccountIds: Accounts that the remarketing list is shared with.
- SharedAccountIds googleapi.Int64s `json:"sharedAccountIds,omitempty"`
-
- // SharedAdvertiserIds: Advertisers that the remarketing list is shared
- // with.
- SharedAdvertiserIds googleapi.Int64s `json:"sharedAdvertiserIds,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RemarketingListShare) MarshalJSON() ([]byte, error) {
- type noMethod RemarketingListShare
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// RemarketingListsListResponse: Remarketing list response
-type RemarketingListsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#remarketingListsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // RemarketingLists: Remarketing list collection.
- RemarketingLists []*RemarketingList `json:"remarketingLists,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RemarketingListsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod RemarketingListsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Report: Represents a Report resource.
-type Report struct {
- // AccountId: The account ID to which this report belongs.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Criteria: The report criteria for a report of type "STANDARD".
- Criteria *ReportCriteria `json:"criteria,omitempty"`
-
- // CrossDimensionReachCriteria: The report criteria for a report of type
- // "CROSS_DIMENSION_REACH".
- CrossDimensionReachCriteria *ReportCrossDimensionReachCriteria `json:"crossDimensionReachCriteria,omitempty"`
-
- // Delivery: The report's email delivery settings.
- Delivery *ReportDelivery `json:"delivery,omitempty"`
-
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // FileName: The filename used when generating report files for this
- // report.
- FileName string `json:"fileName,omitempty"`
-
- // FloodlightCriteria: The report criteria for a report of type
- // "FLOODLIGHT".
- FloodlightCriteria *ReportFloodlightCriteria `json:"floodlightCriteria,omitempty"`
-
- // Format: The output format of the report. If not specified, default
- // format is "CSV". Note that the actual format in the completed report
- // file might differ if for instance the report's size exceeds the
- // format's capabilities. "CSV" will then be the fallback format.
- //
- // Possible values:
- // "CSV"
- // "EXCEL"
- Format string `json:"format,omitempty"`
-
- // Id: The unique ID identifying this report resource.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: The kind of resource this is, in this case dfareporting#report.
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedTime: The timestamp (in milliseconds since epoch) of when
- // this report was last modified.
- LastModifiedTime uint64 `json:"lastModifiedTime,omitempty,string"`
-
- // Name: The name of the report.
- Name string `json:"name,omitempty"`
-
- // OwnerProfileId: The user profile id of the owner of this report.
- OwnerProfileId int64 `json:"ownerProfileId,omitempty,string"`
-
- // PathToConversionCriteria: The report criteria for a report of type
- // "PATH_TO_CONVERSION".
- PathToConversionCriteria *ReportPathToConversionCriteria `json:"pathToConversionCriteria,omitempty"`
-
- // ReachCriteria: The report criteria for a report of type "REACH".
- ReachCriteria *ReportReachCriteria `json:"reachCriteria,omitempty"`
-
- // Schedule: The report's schedule. Can only be set if the report's
- // 'dateRange' is a relative date range and the relative date range is
- // not "TODAY".
- Schedule *ReportSchedule `json:"schedule,omitempty"`
-
- // SubAccountId: The subaccount ID to which this report belongs if
- // applicable.
- SubAccountId int64 `json:"subAccountId,omitempty,string"`
-
- // Type: The type of the report.
- //
- // Possible values:
- // "CROSS_DIMENSION_REACH"
- // "FLOODLIGHT"
- // "PATH_TO_CONVERSION"
- // "REACH"
- // "STANDARD"
- Type string `json:"type,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Report) MarshalJSON() ([]byte, error) {
- type noMethod Report
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportCriteria: The report criteria for a report of type "STANDARD".
-type ReportCriteria struct {
- // Activities: Activity group.
- Activities *Activities `json:"activities,omitempty"`
-
- // CustomRichMediaEvents: Custom Rich Media Events group.
- CustomRichMediaEvents *CustomRichMediaEvents `json:"customRichMediaEvents,omitempty"`
-
- // DateRange: The date range for which this report should be run.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // DimensionFilters: The list of filters on which dimensions are
- // filtered.
- // Filters for different dimensions are ANDed, filters for the same
- // dimension are grouped together and ORed.
- DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`
-
- // Dimensions: The list of standard dimensions the report should
- // include.
- Dimensions []*SortedDimension `json:"dimensions,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Activities") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportCrossDimensionReachCriteria: The report criteria for a report
-// of type "CROSS_DIMENSION_REACH".
-type ReportCrossDimensionReachCriteria struct {
- // Breakdown: The list of dimensions the report should include.
- Breakdown []*SortedDimension `json:"breakdown,omitempty"`
-
- // DateRange: The date range this report should be run for.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // Dimension: The dimension option.
- //
- // Possible values:
- // "ADVERTISER"
- // "CAMPAIGN"
- // "SITE_BY_ADVERTISER"
- // "SITE_BY_CAMPAIGN"
- Dimension string `json:"dimension,omitempty"`
-
- // DimensionFilters: The list of filters on which dimensions are
- // filtered.
- DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // OverlapMetricNames: The list of names of overlap metrics the report
- // should include.
- OverlapMetricNames []string `json:"overlapMetricNames,omitempty"`
-
- // Pivoted: Whether the report is pivoted or not. Defaults to true.
- Pivoted bool `json:"pivoted,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Breakdown") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportCrossDimensionReachCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportCrossDimensionReachCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportDelivery: The report's email delivery settings.
-type ReportDelivery struct {
- // EmailOwner: Whether the report should be emailed to the report owner.
- EmailOwner bool `json:"emailOwner,omitempty"`
-
- // EmailOwnerDeliveryType: The type of delivery for the owner to
- // receive, if enabled.
- //
- // Possible values:
- // "ATTACHMENT"
- // "LINK"
- EmailOwnerDeliveryType string `json:"emailOwnerDeliveryType,omitempty"`
-
- // Message: The message to be sent with each email.
- Message string `json:"message,omitempty"`
-
- // Recipients: The list of recipients to which to email the report.
- Recipients []*Recipient `json:"recipients,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "EmailOwner") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportDelivery) MarshalJSON() ([]byte, error) {
- type noMethod ReportDelivery
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportFloodlightCriteria: The report criteria for a report of type
-// "FLOODLIGHT".
-type ReportFloodlightCriteria struct {
- // CustomRichMediaEvents: The list of custom rich media events to
- // include.
- CustomRichMediaEvents []*DimensionValue `json:"customRichMediaEvents,omitempty"`
-
- // DateRange: The date range this report should be run for.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // DimensionFilters: The list of filters on which dimensions are
- // filtered.
- // Filters for different dimensions are ANDed, filters for the same
- // dimension are grouped together and ORed.
- DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`
-
- // Dimensions: The list of dimensions the report should include.
- Dimensions []*SortedDimension `json:"dimensions,omitempty"`
-
- // FloodlightConfigId: The floodlight ID for which to show data in this
- // report. All advertisers associated with that ID will automatically be
- // added. The dimension of the value needs to be
- // 'dfa:floodlightConfigId'.
- FloodlightConfigId *DimensionValue `json:"floodlightConfigId,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ReportProperties: The properties of the report.
- ReportProperties *ReportFloodlightCriteriaReportProperties `json:"reportProperties,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "CustomRichMediaEvents") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportFloodlightCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportFloodlightCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportFloodlightCriteriaReportProperties: The properties of the
-// report.
-type ReportFloodlightCriteriaReportProperties struct {
- // IncludeAttributedIPConversions: Include conversions that have no
- // cookie, but do have an exposure path.
- IncludeAttributedIPConversions bool `json:"includeAttributedIPConversions,omitempty"`
-
- // IncludeUnattributedCookieConversions: Include conversions of users
- // with a DoubleClick cookie but without an exposure. That means the
- // user did not click or see an ad from the advertiser within the
- // Floodlight group, or that the interaction happened outside the
- // lookback window.
- IncludeUnattributedCookieConversions bool `json:"includeUnattributedCookieConversions,omitempty"`
-
- // IncludeUnattributedIPConversions: Include conversions that have no
- // associated cookies and no exposures. It’s therefore impossible to
- // know how the user was exposed to your ads during the lookback window
- // prior to a conversion.
- IncludeUnattributedIPConversions bool `json:"includeUnattributedIPConversions,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "IncludeAttributedIPConversions") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportFloodlightCriteriaReportProperties) MarshalJSON() ([]byte, error) {
- type noMethod ReportFloodlightCriteriaReportProperties
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportPathToConversionCriteria: The report criteria for a report of
-// type "PATH_TO_CONVERSION".
-type ReportPathToConversionCriteria struct {
- // ActivityFilters: The list of 'dfa:activity' values to filter on.
- ActivityFilters []*DimensionValue `json:"activityFilters,omitempty"`
-
- // ConversionDimensions: The list of conversion dimensions the report
- // should include.
- ConversionDimensions []*SortedDimension `json:"conversionDimensions,omitempty"`
-
- // CustomFloodlightVariables: The list of custom floodlight variables
- // the report should include.
- CustomFloodlightVariables []*SortedDimension `json:"customFloodlightVariables,omitempty"`
-
- // CustomRichMediaEvents: The list of custom rich media events to
- // include.
- CustomRichMediaEvents []*DimensionValue `json:"customRichMediaEvents,omitempty"`
-
- // DateRange: The date range this report should be run for.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // FloodlightConfigId: The floodlight ID for which to show data in this
- // report. All advertisers associated with that ID will automatically be
- // added. The dimension of the value needs to be
- // 'dfa:floodlightConfigId'.
- FloodlightConfigId *DimensionValue `json:"floodlightConfigId,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // PerInteractionDimensions: The list of per interaction dimensions the
- // report should include.
- PerInteractionDimensions []*SortedDimension `json:"perInteractionDimensions,omitempty"`
-
- // ReportProperties: The properties of the report.
- ReportProperties *ReportPathToConversionCriteriaReportProperties `json:"reportProperties,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ActivityFilters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportPathToConversionCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportPathToConversionCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportPathToConversionCriteriaReportProperties: The properties of the
-// report.
-type ReportPathToConversionCriteriaReportProperties struct {
- // ClicksLookbackWindow: DFA checks to see if a click interaction
- // occurred within the specified period of time before a conversion. By
- // default the value is pulled from Floodlight or you can manually enter
- // a custom value. Valid values: 1-90.
- ClicksLookbackWindow int64 `json:"clicksLookbackWindow,omitempty"`
-
- // ImpressionsLookbackWindow: DFA checks to see if an impression
- // interaction occurred within the specified period of time before a
- // conversion. By default the value is pulled from Floodlight or you can
- // manually enter a custom value. Valid values: 1-90.
- ImpressionsLookbackWindow int64 `json:"impressionsLookbackWindow,omitempty"`
-
- // IncludeAttributedIPConversions: Deprecated: has no effect.
- IncludeAttributedIPConversions bool `json:"includeAttributedIPConversions,omitempty"`
-
- // IncludeUnattributedCookieConversions: Include conversions of users
- // with a DoubleClick cookie but without an exposure. That means the
- // user did not click or see an ad from the advertiser within the
- // Floodlight group, or that the interaction happened outside the
- // lookback window.
- IncludeUnattributedCookieConversions bool `json:"includeUnattributedCookieConversions,omitempty"`
-
- // IncludeUnattributedIPConversions: Include conversions that have no
- // associated cookies and no exposures. It’s therefore impossible to
- // know how the user was exposed to your ads during the lookback window
- // prior to a conversion.
- IncludeUnattributedIPConversions bool `json:"includeUnattributedIPConversions,omitempty"`
-
- // MaximumClickInteractions: The maximum number of click interactions to
- // include in the report. Advertisers currently paying for E2C reports
- // get up to 200 (100 clicks, 100 impressions). If another advertiser in
- // your network is paying for E2C, you can have up to 5 total exposures
- // per report.
- MaximumClickInteractions int64 `json:"maximumClickInteractions,omitempty"`
-
- // MaximumImpressionInteractions: The maximum number of click
- // interactions to include in the report. Advertisers currently paying
- // for E2C reports get up to 200 (100 clicks, 100 impressions). If
- // another advertiser in your network is paying for E2C, you can have up
- // to 5 total exposures per report.
- MaximumImpressionInteractions int64 `json:"maximumImpressionInteractions,omitempty"`
-
- // MaximumInteractionGap: The maximum amount of time that can take place
- // between interactions (clicks or impressions) by the same user. Valid
- // values: 1-90.
- MaximumInteractionGap int64 `json:"maximumInteractionGap,omitempty"`
-
- // PivotOnInteractionPath: Enable pivoting on interaction path.
- PivotOnInteractionPath bool `json:"pivotOnInteractionPath,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "ClicksLookbackWindow") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportPathToConversionCriteriaReportProperties) MarshalJSON() ([]byte, error) {
- type noMethod ReportPathToConversionCriteriaReportProperties
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportReachCriteria: The report criteria for a report of type
-// "REACH".
-type ReportReachCriteria struct {
- // Activities: Activity group.
- Activities *Activities `json:"activities,omitempty"`
-
- // CustomRichMediaEvents: Custom Rich Media Events group.
- CustomRichMediaEvents *CustomRichMediaEvents `json:"customRichMediaEvents,omitempty"`
-
- // DateRange: The date range this report should be run for.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // DimensionFilters: The list of filters on which dimensions are
- // filtered.
- // Filters for different dimensions are ANDed, filters for the same
- // dimension are grouped together and ORed.
- DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`
-
- // Dimensions: The list of dimensions the report should include.
- Dimensions []*SortedDimension `json:"dimensions,omitempty"`
-
- // EnableAllDimensionCombinations: Whether to enable all reach dimension
- // combinations in the report. Defaults to false. If enabled, the date
- // range of the report should be within the last three months.
- EnableAllDimensionCombinations bool `json:"enableAllDimensionCombinations,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ReachByFrequencyMetricNames: The list of names of Reach By Frequency
- // metrics the report should include.
- ReachByFrequencyMetricNames []string `json:"reachByFrequencyMetricNames,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Activities") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportReachCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportReachCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportSchedule: The report's schedule. Can only be set if the
-// report's 'dateRange' is a relative date range and the relative date
-// range is not "TODAY".
-type ReportSchedule struct {
- // Active: Whether the schedule is active or not. Must be set to either
- // true or false.
- Active bool `json:"active,omitempty"`
-
- // Every: Defines every how many days, weeks or months the report should
- // be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or
- // "MONTHLY".
- Every int64 `json:"every,omitempty"`
-
- // ExpirationDate: The expiration date when the scheduled report stops
- // running.
- ExpirationDate string `json:"expirationDate,omitempty"`
-
- // Repeats: The interval for which the report is repeated. Note:
- // - "DAILY" also requires field "every" to be set.
- // - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be
- // set.
- // - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be
- // set.
- Repeats string `json:"repeats,omitempty"`
-
- // RepeatsOnWeekDays: List of week days "WEEKLY" on which scheduled
- // reports should run.
- //
- // Possible values:
- // "FRIDAY"
- // "MONDAY"
- // "SATURDAY"
- // "SUNDAY"
- // "THURSDAY"
- // "TUESDAY"
- // "WEDNESDAY"
- RepeatsOnWeekDays []string `json:"repeatsOnWeekDays,omitempty"`
-
- // RunsOnDayOfMonth: Enum to define for "MONTHLY" scheduled reports
- // whether reports should be repeated on the same day of the month as
- // "startDate" or the same day of the week of the month.
- // Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02),
- // "DAY_OF_MONTH" would run subsequent reports on the 2nd of every
- // Month, and "WEEK_OF_MONTH" would run subsequent reports on the first
- // Monday of the month.
- //
- // Possible values:
- // "DAY_OF_MONTH"
- // "WEEK_OF_MONTH"
- RunsOnDayOfMonth string `json:"runsOnDayOfMonth,omitempty"`
-
- // StartDate: Start date of date range for which scheduled reports
- // should be run.
- StartDate string `json:"startDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Active") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportSchedule) MarshalJSON() ([]byte, error) {
- type noMethod ReportSchedule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportCompatibleFields: Represents fields that are compatible to be
-// selected for a report of type "STANDARD".
-type ReportCompatibleFields struct {
- // DimensionFilters: Dimensions which are compatible to be selected in
- // the "dimensionFilters" section of the report.
- DimensionFilters []*Dimension `json:"dimensionFilters,omitempty"`
-
- // Dimensions: Dimensions which are compatible to be selected in the
- // "dimensions" section of the report.
- Dimensions []*Dimension `json:"dimensions,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#reportCompatibleFields.
- Kind string `json:"kind,omitempty"`
-
- // Metrics: Metrics which are compatible to be selected in the
- // "metricNames" section of the report.
- Metrics []*Metric `json:"metrics,omitempty"`
-
- // PivotedActivityMetrics: Metrics which are compatible to be selected
- // as activity metrics to pivot on in the "activities" section of the
- // report.
- PivotedActivityMetrics []*Metric `json:"pivotedActivityMetrics,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionFilters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportCompatibleFields) MarshalJSON() ([]byte, error) {
- type noMethod ReportCompatibleFields
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportList: Represents the list of reports.
-type ReportList struct {
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The reports returned in this response.
- Items []*Report `json:"items,omitempty"`
-
- // Kind: The kind of list this is, in this case dfareporting#reportList.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through reports. To
- // retrieve the next page of results, set the next request's "pageToken"
- // to the value of this field. The page token is only valid for a
- // limited amount of time and should not be persisted.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportList) MarshalJSON() ([]byte, error) {
- type noMethod ReportList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportsConfiguration: Reporting Configuration
-type ReportsConfiguration struct {
- // ExposureToConversionEnabled: Whether the exposure to conversion
- // report is enabled. This report shows detailed pathway information on
- // up to 10 of the most recent ad exposures seen by a user before
- // converting.
- ExposureToConversionEnabled bool `json:"exposureToConversionEnabled,omitempty"`
-
- // LookbackConfiguration: Default lookback windows for new advertisers
- // in this account.
- LookbackConfiguration *LookbackConfiguration `json:"lookbackConfiguration,omitempty"`
-
- // ReportGenerationTimeZoneId: Report generation time zone ID of this
- // account. This is a required field that can only be changed by a
- // superuser.
- // Acceptable values are:
- //
- // - "1" for "America/New_York"
- // - "2" for "Europe/London"
- // - "3" for "Europe/Paris"
- // - "4" for "Africa/Johannesburg"
- // - "5" for "Asia/Jerusalem"
- // - "6" for "Asia/Shanghai"
- // - "7" for "Asia/Hong_Kong"
- // - "8" for "Asia/Tokyo"
- // - "9" for "Australia/Sydney"
- // - "10" for "Asia/Dubai"
- // - "11" for "America/Los_Angeles"
- // - "12" for "Pacific/Auckland"
- // - "13" for "America/Sao_Paulo"
- ReportGenerationTimeZoneId int64 `json:"reportGenerationTimeZoneId,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g.
- // "ExposureToConversionEnabled") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportsConfiguration) MarshalJSON() ([]byte, error) {
- type noMethod ReportsConfiguration
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// RichMediaExitOverride: Rich Media Exit Override.
-type RichMediaExitOverride struct {
- // CustomExitUrl: Click-through URL to override the default exit URL.
- // Applicable if the useCustomExitUrl field is set to true.
- CustomExitUrl string `json:"customExitUrl,omitempty"`
-
- // ExitId: ID for the override to refer to a specific exit in the
- // creative.
- ExitId int64 `json:"exitId,omitempty,string"`
-
- // UseCustomExitUrl: Whether to use the custom exit URL.
- UseCustomExitUrl bool `json:"useCustomExitUrl,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CustomExitUrl") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RichMediaExitOverride) MarshalJSON() ([]byte, error) {
- type noMethod RichMediaExitOverride
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Site: Contains properties of a site.
-type Site struct {
- // AccountId: Account ID of this site. This is a read-only field that
- // can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Approved: Whether this site is approved.
- Approved bool `json:"approved,omitempty"`
-
- // DirectorySiteId: Directory site associated with this site. This is a
- // required field that is read-only after insertion.
- DirectorySiteId int64 `json:"directorySiteId,omitempty,string"`
-
- // DirectorySiteIdDimensionValue: Dimension value for the ID of the
- // directory site. This is a read-only, auto-generated field.
- DirectorySiteIdDimensionValue *DimensionValue `json:"directorySiteIdDimensionValue,omitempty"`
-
- // Id: ID of this site. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this site. This is a
- // read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // KeyName: Key name of this site. This is a read-only, auto-generated
- // field.
- KeyName string `json:"keyName,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#site".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this site.This is a required field. Must be less than
- // 128 characters long. If this site is under a subaccount, the name
- // must be unique among sites of the same subaccount. Otherwise, this
- // site is a top-level site, and the name must be unique among top-level
- // sites of the same account.
- Name string `json:"name,omitempty"`
-
- // SiteContacts: Site contacts.
- SiteContacts []*SiteContact `json:"siteContacts,omitempty"`
-
- // SiteSettings: Site-wide settings.
- SiteSettings *SiteSettings `json:"siteSettings,omitempty"`
-
- // SubaccountId: Subaccount ID of this site. This is a read-only field
- // that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Site) MarshalJSON() ([]byte, error) {
- type noMethod Site
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SiteContact: Site Contact
-type SiteContact struct {
- // Address: Address of this site contact.
- Address string `json:"address,omitempty"`
-
- // ContactType: Site contact type.
- //
- // Possible values:
- // "SALES_PERSON"
- // "TRAFFICKER"
- ContactType string `json:"contactType,omitempty"`
-
- // Email: Email address of this site contact. This is a required field.
- Email string `json:"email,omitempty"`
-
- // FirstName: First name of this site contact.
- FirstName string `json:"firstName,omitempty"`
-
- // Id: ID of this site contact. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // LastName: Last name of this site contact.
- LastName string `json:"lastName,omitempty"`
-
- // Phone: Primary phone number of this site contact.
- Phone string `json:"phone,omitempty"`
-
- // Title: Title or designation of this site contact.
- Title string `json:"title,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Address") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SiteContact) MarshalJSON() ([]byte, error) {
- type noMethod SiteContact
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SiteSettings: Site Settings
-type SiteSettings struct {
- // ActiveViewOptOut: Whether active view creatives are disabled for this
- // site.
- ActiveViewOptOut bool `json:"activeViewOptOut,omitempty"`
-
- // CreativeSettings: Site-wide creative settings.
- CreativeSettings *CreativeSettings `json:"creativeSettings,omitempty"`
-
- // DisableBrandSafeAds: Whether brand safe ads are disabled for this
- // site.
- DisableBrandSafeAds bool `json:"disableBrandSafeAds,omitempty"`
-
- // DisableNewCookie: Whether new cookies are disabled for this site.
- DisableNewCookie bool `json:"disableNewCookie,omitempty"`
-
- // LookbackConfiguration: Lookback window settings for this site.
- LookbackConfiguration *LookbackConfiguration `json:"lookbackConfiguration,omitempty"`
-
- // TagSetting: Configuration settings for dynamic and image floodlight
- // tags.
- TagSetting *TagSetting `json:"tagSetting,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ActiveViewOptOut") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SiteSettings) MarshalJSON() ([]byte, error) {
- type noMethod SiteSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SitesListResponse: Site List Response
-type SitesListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#sitesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Sites: Site collection.
- Sites []*Site `json:"sites,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SitesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod SitesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Size: Represents the dimensions of ads, placements, creatives, or
-// creative assets.
-type Size struct {
- // Height: Height of this size.
- Height int64 `json:"height,omitempty"`
-
- // Iab: IAB standard size. This is a read-only, auto-generated field.
- Iab bool `json:"iab,omitempty"`
-
- // Id: ID of this size. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#size".
- Kind string `json:"kind,omitempty"`
-
- // Width: Width of this size.
- Width int64 `json:"width,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Height") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Size) MarshalJSON() ([]byte, error) {
- type noMethod Size
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SizesListResponse: Size List Response
-type SizesListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#sizesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // Sizes: Size collection.
- Sizes []*Size `json:"sizes,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SizesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod SizesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SortedDimension: Represents a sorted dimension.
-type SortedDimension struct {
- // Kind: The kind of resource this is, in this case
- // dfareporting#sortedDimension.
- Kind string `json:"kind,omitempty"`
-
- // Name: The name of the dimension.
- Name string `json:"name,omitempty"`
-
- // SortOrder: An optional sort order for the dimension column.
- //
- // Possible values:
- // "ASCENDING"
- // "DESCENDING"
- SortOrder string `json:"sortOrder,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SortedDimension) MarshalJSON() ([]byte, error) {
- type noMethod SortedDimension
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Subaccount: Contains properties of a DCM subaccount.
-type Subaccount struct {
- // AccountId: ID of the account that contains this subaccount. This is a
- // read-only field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AvailablePermissionIds: IDs of the available user role permissions
- // for this subaccount.
- AvailablePermissionIds googleapi.Int64s `json:"availablePermissionIds,omitempty"`
-
- // Id: ID of this subaccount. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#subaccount".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this subaccount. This is a required field. Must be less
- // than 128 characters long and be unique among subaccounts of the same
- // account.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Subaccount) MarshalJSON() ([]byte, error) {
- type noMethod Subaccount
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SubaccountsListResponse: Subaccount List Response
-type SubaccountsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#subaccountsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Subaccounts: Subaccount collection.
- Subaccounts []*Subaccount `json:"subaccounts,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SubaccountsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod SubaccountsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TagData: Placement Tag Data
-type TagData struct {
- // AdId: Ad associated with this placement tag.
- AdId int64 `json:"adId,omitempty,string"`
-
- // ClickTag: Tag string to record a click.
- ClickTag string `json:"clickTag,omitempty"`
-
- // CreativeId: Creative associated with this placement tag.
- CreativeId int64 `json:"creativeId,omitempty,string"`
-
- // Format: TagData tag format of this tag.
- //
- // Possible values:
- // "PLACEMENT_TAG_CLICK_COMMANDS"
- // "PLACEMENT_TAG_IFRAME_ILAYER"
- // "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
- // "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY"
- // "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
- // "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3"
- // "PLACEMENT_TAG_INTERNAL_REDIRECT"
- // "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
- // "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY"
- // "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
- // "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
- // "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY"
- // "PLACEMENT_TAG_JAVASCRIPT"
- // "PLACEMENT_TAG_JAVASCRIPT_LEGACY"
- // "PLACEMENT_TAG_STANDARD"
- // "PLACEMENT_TAG_TRACKING"
- // "PLACEMENT_TAG_TRACKING_IFRAME"
- // "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- Format string `json:"format,omitempty"`
-
- // ImpressionTag: Tag string for serving an ad.
- ImpressionTag string `json:"impressionTag,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AdId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TagData) MarshalJSON() ([]byte, error) {
- type noMethod TagData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TagSetting: Tag Settings
-type TagSetting struct {
- // AdditionalKeyValues: Additional key-values to be included in tags.
- // Each key-value pair must be of the form key=value, and pairs must be
- // separated by a semicolon (;). Keys and values must not contain
- // commas. For example, id=2;color=red is a valid value for this field.
- AdditionalKeyValues string `json:"additionalKeyValues,omitempty"`
-
- // IncludeClickThroughUrls: Whether static landing page URLs should be
- // included in the tags. This setting applies only to placements.
- IncludeClickThroughUrls bool `json:"includeClickThroughUrls,omitempty"`
-
- // IncludeClickTracking: Whether click-tracking string should be
- // included in the tags.
- IncludeClickTracking bool `json:"includeClickTracking,omitempty"`
-
- // KeywordOption: Option specifying how keywords are embedded in ad
- // tags. This setting can be used to specify whether keyword
- // placeholders are inserted in placement tags for this site. Publishers
- // can then add keywords to those placeholders.
- //
- // Possible values:
- // "GENERATE_SEPARATE_TAG_FOR_EACH_KEYWORD"
- // "IGNORE"
- // "PLACEHOLDER_WITH_LIST_OF_KEYWORDS"
- KeywordOption string `json:"keywordOption,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AdditionalKeyValues")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TagSetting) MarshalJSON() ([]byte, error) {
- type noMethod TagSetting
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TagSettings: Dynamic and Image Tag Settings.
-type TagSettings struct {
- // DynamicTagEnabled: Whether dynamic floodlight tags are enabled.
- DynamicTagEnabled bool `json:"dynamicTagEnabled,omitempty"`
-
- // ImageTagEnabled: Whether image tags are enabled.
- ImageTagEnabled bool `json:"imageTagEnabled,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DynamicTagEnabled")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TagSettings) MarshalJSON() ([]byte, error) {
- type noMethod TagSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetWindow: Target Window.
-type TargetWindow struct {
- // CustomHtml: User-entered value.
- CustomHtml string `json:"customHtml,omitempty"`
-
- // TargetWindowOption: Type of browser window for which the backup image
- // of the flash creative can be displayed.
- //
- // Possible values:
- // "CURRENT_WINDOW"
- // "CUSTOM"
- // "NEW_WINDOW"
- TargetWindowOption string `json:"targetWindowOption,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CustomHtml") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetWindow) MarshalJSON() ([]byte, error) {
- type noMethod TargetWindow
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetableRemarketingList: Contains properties of a targetable
-// remarketing list. Remarketing enables you to create lists of users
-// who have performed specific actions on a site, then target ads to
-// members of those lists. This resource is a read-only view of a
-// remarketing list to be used to faciliate targeting ads to specific
-// lists. Remarketing lists that are owned by your advertisers and those
-// that are shared to your advertisers or account are accessible via
-// this resource. To manage remarketing lists that are owned by your
-// advertisers, use the RemarketingLists resource.
-type TargetableRemarketingList struct {
- // AccountId: Account ID of this remarketing list. This is a read-only,
- // auto-generated field that is only returned in GET requests.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Active: Whether this targetable remarketing list is active.
- Active bool `json:"active,omitempty"`
-
- // AdvertiserId: Dimension value for the advertiser ID that owns this
- // targetable remarketing list.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // Description: Targetable remarketing list description.
- Description string `json:"description,omitempty"`
-
- // Id: Targetable remarketing list ID.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#targetableRemarketingList".
- Kind string `json:"kind,omitempty"`
-
- // LifeSpan: Number of days that a user should remain in the targetable
- // remarketing list without an impression.
- LifeSpan int64 `json:"lifeSpan,omitempty,string"`
-
- // ListSize: Number of users currently in the list. This is a read-only
- // field.
- ListSize int64 `json:"listSize,omitempty,string"`
-
- // ListSource: Product from which this targetable remarketing list was
- // originated.
- //
- // Possible values:
- // "REMARKETING_LIST_SOURCE_DBM"
- // "REMARKETING_LIST_SOURCE_DFA"
- // "REMARKETING_LIST_SOURCE_DMP"
- // "REMARKETING_LIST_SOURCE_GA"
- // "REMARKETING_LIST_SOURCE_OTHER"
- ListSource string `json:"listSource,omitempty"`
-
- // Name: Name of the targetable remarketing list. Is no greater than 128
- // characters long.
- Name string `json:"name,omitempty"`
-
- // SubaccountId: Subaccount ID of this remarketing list. This is a
- // read-only, auto-generated field that is only returned in GET
- // requests.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetableRemarketingList) MarshalJSON() ([]byte, error) {
- type noMethod TargetableRemarketingList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetableRemarketingListsListResponse: Targetable remarketing list
-// response
-type TargetableRemarketingListsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#targetableRemarketingListsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // TargetableRemarketingLists: Targetable remarketing list collection.
- TargetableRemarketingLists []*TargetableRemarketingList `json:"targetableRemarketingLists,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetableRemarketingListsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod TargetableRemarketingListsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TechnologyTargeting: Technology Targeting.
-type TechnologyTargeting struct {
- // Browsers: Browsers that this ad targets. For each browser either set
- // browserVersionId or dartId along with the version numbers. If both
- // are specified, only browserVersionId will be used.The other fields
- // are populated automatically when the ad is inserted or updated.
- Browsers []*Browser `json:"browsers,omitempty"`
-
- // ConnectionTypes: Connection types that this ad targets. For each
- // connection type only id is required.The other fields are populated
- // automatically when the ad is inserted or updated.
- ConnectionTypes []*ConnectionType `json:"connectionTypes,omitempty"`
-
- // MobileCarriers: Mobile carriers that this ad targets. For each mobile
- // carrier only id is required, and the other fields are populated
- // automatically when the ad is inserted or updated. If targeting a
- // mobile carrier, do not set targeting for any zip codes.
- MobileCarriers []*MobileCarrier `json:"mobileCarriers,omitempty"`
-
- // OperatingSystemVersions: Operating system versions that this ad
- // targets. To target all versions, use operatingSystems. For each
- // operating system version, only id is required. The other fields are
- // populated automatically when the ad is inserted or updated. If
- // targeting an operating system version, do not set targeting for the
- // corresponding operating system in operatingSystems.
- OperatingSystemVersions []*OperatingSystemVersion `json:"operatingSystemVersions,omitempty"`
-
- // OperatingSystems: Operating systems that this ad targets. To target
- // specific versions, use operatingSystemVersions. For each operating
- // system only dartId is required. The other fields are populated
- // automatically when the ad is inserted or updated. If targeting an
- // operating system, do not set targeting for operating system versions
- // for the same operating system.
- OperatingSystems []*OperatingSystem `json:"operatingSystems,omitempty"`
-
- // PlatformTypes: Platform types that this ad targets. For example,
- // desktop, mobile, or tablet. For each platform type, only id is
- // required, and the other fields are populated automatically when the
- // ad is inserted or updated.
- PlatformTypes []*PlatformType `json:"platformTypes,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Browsers") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TechnologyTargeting) MarshalJSON() ([]byte, error) {
- type noMethod TechnologyTargeting
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ThirdPartyTrackingUrl: Third-party Tracking URL.
-type ThirdPartyTrackingUrl struct {
- // ThirdPartyUrlType: Third-party URL type for in-stream video
- // creatives.
- //
- // Possible values:
- // "CLICK_TRACKING"
- // "IMPRESSION"
- // "RICH_MEDIA_BACKUP_IMPRESSION"
- // "RICH_MEDIA_IMPRESSION"
- // "RICH_MEDIA_RM_IMPRESSION"
- // "SURVEY"
- // "VIDEO_COMPLETE"
- // "VIDEO_CUSTOM"
- // "VIDEO_FIRST_QUARTILE"
- // "VIDEO_FULLSCREEN"
- // "VIDEO_MIDPOINT"
- // "VIDEO_MUTE"
- // "VIDEO_PAUSE"
- // "VIDEO_REWIND"
- // "VIDEO_START"
- // "VIDEO_STOP"
- // "VIDEO_THIRD_QUARTILE"
- ThirdPartyUrlType string `json:"thirdPartyUrlType,omitempty"`
-
- // Url: URL for the specified third-party URL type.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ThirdPartyUrlType")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ThirdPartyTrackingUrl) MarshalJSON() ([]byte, error) {
- type noMethod ThirdPartyTrackingUrl
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserDefinedVariableConfiguration: User Defined Variable
-// configuration.
-type UserDefinedVariableConfiguration struct {
- // DataType: Data type for the variable. This is a required field.
- //
- // Possible values:
- // "NUMBER"
- // "STRING"
- DataType string `json:"dataType,omitempty"`
-
- // ReportName: User-friendly name for the variable which will appear in
- // reports. This is a required field, must be less than 64 characters
- // long, and cannot contain the following characters: ""<>".
- ReportName string `json:"reportName,omitempty"`
-
- // VariableType: Variable name in the tag. This is a required field.
- //
- // Possible values:
- // "U1"
- // "U10"
- // "U11"
- // "U12"
- // "U13"
- // "U14"
- // "U15"
- // "U16"
- // "U17"
- // "U18"
- // "U19"
- // "U2"
- // "U20"
- // "U3"
- // "U4"
- // "U5"
- // "U6"
- // "U7"
- // "U8"
- // "U9"
- VariableType string `json:"variableType,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DataType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserDefinedVariableConfiguration) MarshalJSON() ([]byte, error) {
- type noMethod UserDefinedVariableConfiguration
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserProfile: Represents a UserProfile resource.
-type UserProfile struct {
- // AccountId: The account ID to which this profile belongs.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AccountName: The account name this profile belongs to.
- AccountName string `json:"accountName,omitempty"`
-
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#userProfile.
- Kind string `json:"kind,omitempty"`
-
- // ProfileId: The unique ID of the user profile.
- ProfileId int64 `json:"profileId,omitempty,string"`
-
- // SubAccountId: The sub account ID this profile belongs to if
- // applicable.
- SubAccountId int64 `json:"subAccountId,omitempty,string"`
-
- // SubAccountName: The sub account name this profile belongs to if
- // applicable.
- SubAccountName string `json:"subAccountName,omitempty"`
-
- // UserName: The user name.
- UserName string `json:"userName,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserProfile) MarshalJSON() ([]byte, error) {
- type noMethod UserProfile
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserProfileList: Represents the list of user profiles.
-type UserProfileList struct {
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The user profiles returned in this response.
- Items []*UserProfile `json:"items,omitempty"`
-
- // Kind: The kind of list this is, in this case
- // dfareporting#userProfileList.
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserProfileList) MarshalJSON() ([]byte, error) {
- type noMethod UserProfileList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserRole: Contains properties of auser role, which is used to manage
-// user access.
-type UserRole struct {
- // AccountId: Account ID of this user role. This is a read-only field
- // that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // DefaultUserRole: Whether this is a default user role. Default user
- // roles are created by the system for the account/subaccount and cannot
- // be modified or deleted. Each default user role comes with a basic set
- // of preassigned permissions.
- DefaultUserRole bool `json:"defaultUserRole,omitempty"`
-
- // Id: ID of this user role. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#userRole".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this user role. This is a required field. Must be less
- // than 256 characters long. If this user role is under a subaccount,
- // the name must be unique among sites of the same subaccount.
- // Otherwise, this user role is a top-level user role, and the name must
- // be unique among top-level user roles of the same account.
- Name string `json:"name,omitempty"`
-
- // ParentUserRoleId: ID of the user role that this user role is based on
- // or copied from. This is a required field.
- ParentUserRoleId int64 `json:"parentUserRoleId,omitempty,string"`
-
- // Permissions: List of permissions associated with this user role.
- Permissions []*UserRolePermission `json:"permissions,omitempty"`
-
- // SubaccountId: Subaccount ID of this user role. This is a read-only
- // field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserRole) MarshalJSON() ([]byte, error) {
- type noMethod UserRole
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserRolePermission: Contains properties of a user role permission.
-type UserRolePermission struct {
- // Availability: Levels of availability for a user role permission.
- //
- // Possible values:
- // "ACCOUNT_ALWAYS"
- // "ACCOUNT_BY_DEFAULT"
- // "NOT_AVAILABLE_BY_DEFAULT"
- // "SUBACCOUNT_AND_ACCOUNT_ALWAYS"
- // "SUBACCOUNT_AND_ACCOUNT_BY_DEFAULT"
- Availability string `json:"availability,omitempty"`
-
- // Id: ID of this user role permission.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#userRolePermission".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this user role permission.
- Name string `json:"name,omitempty"`
-
- // PermissionGroupId: ID of the permission group that this user role
- // permission belongs to.
- PermissionGroupId int64 `json:"permissionGroupId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Availability") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserRolePermission) MarshalJSON() ([]byte, error) {
- type noMethod UserRolePermission
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserRolePermissionGroup: Represents a grouping of related user role
-// permissions.
-type UserRolePermissionGroup struct {
- // Id: ID of this user role permission.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#userRolePermissionGroup".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this user role permission group.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserRolePermissionGroup) MarshalJSON() ([]byte, error) {
- type noMethod UserRolePermissionGroup
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserRolePermissionGroupsListResponse: User Role Permission Group List
-// Response
-type UserRolePermissionGroupsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#userRolePermissionGroupsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // UserRolePermissionGroups: User role permission group collection.
- UserRolePermissionGroups []*UserRolePermissionGroup `json:"userRolePermissionGroups,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserRolePermissionGroupsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod UserRolePermissionGroupsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserRolePermissionsListResponse: User Role Permission List Response
-type UserRolePermissionsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#userRolePermissionsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // UserRolePermissions: User role permission collection.
- UserRolePermissions []*UserRolePermission `json:"userRolePermissions,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserRolePermissionsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod UserRolePermissionsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserRolesListResponse: User Role List Response
-type UserRolesListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#userRolesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // UserRoles: User role collection.
- UserRoles []*UserRole `json:"userRoles,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *UserRolesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod UserRolesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// method id "dfareporting.accountActiveAdSummaries.get":
-
-type AccountActiveAdSummariesGetCall struct {
- s *Service
- profileId int64
- summaryAccountId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets the account's active ad summary by account ID.
-func (r *AccountActiveAdSummariesService) Get(profileId int64, summaryAccountId int64) *AccountActiveAdSummariesGetCall {
- c := &AccountActiveAdSummariesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.summaryAccountId = summaryAccountId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountActiveAdSummariesGetCall) Fields(s ...googleapi.Field) *AccountActiveAdSummariesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountActiveAdSummariesGetCall) IfNoneMatch(entityTag string) *AccountActiveAdSummariesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountActiveAdSummariesGetCall) Context(ctx context.Context) *AccountActiveAdSummariesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountActiveAdSummariesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "summaryAccountId": strconv.FormatInt(c.summaryAccountId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.accountActiveAdSummaries.get" call.
-// Exactly one of *AccountActiveAdSummary or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AccountActiveAdSummary.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountActiveAdSummariesGetCall) Do() (*AccountActiveAdSummary, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountActiveAdSummary{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets the account's active ad summary by account ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.accountActiveAdSummaries.get",
- // "parameterOrder": [
- // "profileId",
- // "summaryAccountId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "summaryAccountId": {
- // "description": "Account ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}",
- // "response": {
- // "$ref": "AccountActiveAdSummary"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.accountPermissionGroups.get":
-
-type AccountPermissionGroupsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one account permission group by ID.
-func (r *AccountPermissionGroupsService) Get(profileId int64, id int64) *AccountPermissionGroupsGetCall {
- c := &AccountPermissionGroupsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountPermissionGroupsGetCall) Fields(s ...googleapi.Field) *AccountPermissionGroupsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountPermissionGroupsGetCall) IfNoneMatch(entityTag string) *AccountPermissionGroupsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountPermissionGroupsGetCall) Context(ctx context.Context) *AccountPermissionGroupsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountPermissionGroupsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/accountPermissionGroups/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.accountPermissionGroups.get" call.
-// Exactly one of *AccountPermissionGroup or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AccountPermissionGroup.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountPermissionGroupsGetCall) Do() (*AccountPermissionGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountPermissionGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one account permission group by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.accountPermissionGroups.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Account permission group ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/accountPermissionGroups/{id}",
- // "response": {
- // "$ref": "AccountPermissionGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.accountPermissionGroups.list":
-
-type AccountPermissionGroupsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of account permission groups.
-func (r *AccountPermissionGroupsService) List(profileId int64) *AccountPermissionGroupsListCall {
- c := &AccountPermissionGroupsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountPermissionGroupsListCall) Fields(s ...googleapi.Field) *AccountPermissionGroupsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountPermissionGroupsListCall) IfNoneMatch(entityTag string) *AccountPermissionGroupsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountPermissionGroupsListCall) Context(ctx context.Context) *AccountPermissionGroupsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountPermissionGroupsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/accountPermissionGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.accountPermissionGroups.list" call.
-// Exactly one of *AccountPermissionGroupsListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *AccountPermissionGroupsListResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *AccountPermissionGroupsListCall) Do() (*AccountPermissionGroupsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountPermissionGroupsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of account permission groups.",
- // "httpMethod": "GET",
- // "id": "dfareporting.accountPermissionGroups.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/accountPermissionGroups",
- // "response": {
- // "$ref": "AccountPermissionGroupsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.accountPermissions.get":
-
-type AccountPermissionsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one account permission by ID.
-func (r *AccountPermissionsService) Get(profileId int64, id int64) *AccountPermissionsGetCall {
- c := &AccountPermissionsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountPermissionsGetCall) Fields(s ...googleapi.Field) *AccountPermissionsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountPermissionsGetCall) IfNoneMatch(entityTag string) *AccountPermissionsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountPermissionsGetCall) Context(ctx context.Context) *AccountPermissionsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountPermissionsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/accountPermissions/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.accountPermissions.get" call.
-// Exactly one of *AccountPermission or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AccountPermission.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountPermissionsGetCall) Do() (*AccountPermission, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountPermission{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one account permission by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.accountPermissions.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Account permission ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/accountPermissions/{id}",
- // "response": {
- // "$ref": "AccountPermission"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.accountPermissions.list":
-
-type AccountPermissionsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of account permissions.
-func (r *AccountPermissionsService) List(profileId int64) *AccountPermissionsListCall {
- c := &AccountPermissionsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountPermissionsListCall) Fields(s ...googleapi.Field) *AccountPermissionsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountPermissionsListCall) IfNoneMatch(entityTag string) *AccountPermissionsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountPermissionsListCall) Context(ctx context.Context) *AccountPermissionsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountPermissionsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/accountPermissions")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.accountPermissions.list" call.
-// Exactly one of *AccountPermissionsListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *AccountPermissionsListResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountPermissionsListCall) Do() (*AccountPermissionsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountPermissionsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of account permissions.",
- // "httpMethod": "GET",
- // "id": "dfareporting.accountPermissions.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/accountPermissions",
- // "response": {
- // "$ref": "AccountPermissionsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.accountUserProfiles.get":
-
-type AccountUserProfilesGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one account user profile by ID.
-func (r *AccountUserProfilesService) Get(profileId int64, id int64) *AccountUserProfilesGetCall {
- c := &AccountUserProfilesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountUserProfilesGetCall) Fields(s ...googleapi.Field) *AccountUserProfilesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountUserProfilesGetCall) IfNoneMatch(entityTag string) *AccountUserProfilesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountUserProfilesGetCall) Context(ctx context.Context) *AccountUserProfilesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountUserProfilesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/accountUserProfiles/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.accountUserProfiles.get" call.
-// Exactly one of *AccountUserProfile or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AccountUserProfile.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountUserProfilesGetCall) Do() (*AccountUserProfile, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountUserProfile{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one account user profile by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.accountUserProfiles.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "User profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/accountUserProfiles/{id}",
- // "response": {
- // "$ref": "AccountUserProfile"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.accountUserProfiles.insert":
-
-type AccountUserProfilesInsertCall struct {
- s *Service
- profileId int64
- accountuserprofile *AccountUserProfile
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new account user profile.
-func (r *AccountUserProfilesService) Insert(profileId int64, accountuserprofile *AccountUserProfile) *AccountUserProfilesInsertCall {
- c := &AccountUserProfilesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.accountuserprofile = accountuserprofile
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountUserProfilesInsertCall) Fields(s ...googleapi.Field) *AccountUserProfilesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountUserProfilesInsertCall) Context(ctx context.Context) *AccountUserProfilesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountUserProfilesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.accountuserprofile)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/accountUserProfiles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.accountUserProfiles.insert" call.
-// Exactly one of *AccountUserProfile or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AccountUserProfile.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountUserProfilesInsertCall) Do() (*AccountUserProfile, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountUserProfile{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new account user profile.",
- // "httpMethod": "POST",
- // "id": "dfareporting.accountUserProfiles.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/accountUserProfiles",
- // "request": {
- // "$ref": "AccountUserProfile"
- // },
- // "response": {
- // "$ref": "AccountUserProfile"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.accountUserProfiles.list":
-
-type AccountUserProfilesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of account user profiles, possibly filtered.
-func (r *AccountUserProfilesService) List(profileId int64) *AccountUserProfilesListCall {
- c := &AccountUserProfilesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Active sets the optional parameter "active": Select only active user
-// profiles.
-func (c *AccountUserProfilesListCall) Active(active bool) *AccountUserProfilesListCall {
- c.opt_["active"] = active
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only user profiles with
-// these IDs.
-func (c *AccountUserProfilesListCall) Ids(ids int64) *AccountUserProfilesListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *AccountUserProfilesListCall) MaxResults(maxResults int64) *AccountUserProfilesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *AccountUserProfilesListCall) PageToken(pageToken string) *AccountUserProfilesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name, ID or email. Wildcards (*) are
-// allowed. For example, "user profile*2015" will return objects with
-// names like "user profile June 2015", "user profile April 2015", or
-// simply "user profile 2015". Most of the searches also add wildcards
-// implicitly at the start and the end of the search string. For
-// example, a search string of "user profile" will match objects with
-// name "my user profile", "user profile 2015", or simply "user
-// profile".
-func (c *AccountUserProfilesListCall) SearchString(searchString string) *AccountUserProfilesListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *AccountUserProfilesListCall) SortField(sortField string) *AccountUserProfilesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *AccountUserProfilesListCall) SortOrder(sortOrder string) *AccountUserProfilesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// SubaccountId sets the optional parameter "subaccountId": Select only
-// user profiles with the specified subaccount ID.
-func (c *AccountUserProfilesListCall) SubaccountId(subaccountId int64) *AccountUserProfilesListCall {
- c.opt_["subaccountId"] = subaccountId
- return c
-}
-
-// UserRoleId sets the optional parameter "userRoleId": Select only user
-// profiles with the specified user role ID.
-func (c *AccountUserProfilesListCall) UserRoleId(userRoleId int64) *AccountUserProfilesListCall {
- c.opt_["userRoleId"] = userRoleId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountUserProfilesListCall) Fields(s ...googleapi.Field) *AccountUserProfilesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountUserProfilesListCall) IfNoneMatch(entityTag string) *AccountUserProfilesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountUserProfilesListCall) Context(ctx context.Context) *AccountUserProfilesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountUserProfilesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["active"]; ok {
- params.Set("active", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["subaccountId"]; ok {
- params.Set("subaccountId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["userRoleId"]; ok {
- params.Set("userRoleId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/accountUserProfiles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.accountUserProfiles.list" call.
-// Exactly one of *AccountUserProfilesListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *AccountUserProfilesListResponse.ServerResponse.Header or (if
-// a response was returned at all) in error.(*googleapi.Error).Header.
-// Use googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountUserProfilesListCall) Do() (*AccountUserProfilesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountUserProfilesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of account user profiles, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.accountUserProfiles.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "active": {
- // "description": "Select only active user profiles.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "ids": {
- // "description": "Select only user profiles with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, \"user profile*2015\" will return objects with names like \"user profile June 2015\", \"user profile April 2015\", or simply \"user profile 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"user profile\" will match objects with name \"my user profile\", \"user profile 2015\", or simply \"user profile\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "subaccountId": {
- // "description": "Select only user profiles with the specified subaccount ID.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "userRoleId": {
- // "description": "Select only user profiles with the specified user role ID.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/accountUserProfiles",
- // "response": {
- // "$ref": "AccountUserProfilesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.accountUserProfiles.patch":
-
-type AccountUserProfilesPatchCall struct {
- s *Service
- profileId int64
- id int64
- accountuserprofile *AccountUserProfile
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing account user profile. This method supports
-// patch semantics.
-func (r *AccountUserProfilesService) Patch(profileId int64, id int64, accountuserprofile *AccountUserProfile) *AccountUserProfilesPatchCall {
- c := &AccountUserProfilesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.accountuserprofile = accountuserprofile
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountUserProfilesPatchCall) Fields(s ...googleapi.Field) *AccountUserProfilesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountUserProfilesPatchCall) Context(ctx context.Context) *AccountUserProfilesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountUserProfilesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.accountuserprofile)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/accountUserProfiles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.accountUserProfiles.patch" call.
-// Exactly one of *AccountUserProfile or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AccountUserProfile.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountUserProfilesPatchCall) Do() (*AccountUserProfile, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountUserProfile{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing account user profile. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.accountUserProfiles.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "User profile ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/accountUserProfiles",
- // "request": {
- // "$ref": "AccountUserProfile"
- // },
- // "response": {
- // "$ref": "AccountUserProfile"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.accountUserProfiles.update":
-
-type AccountUserProfilesUpdateCall struct {
- s *Service
- profileId int64
- accountuserprofile *AccountUserProfile
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing account user profile.
-func (r *AccountUserProfilesService) Update(profileId int64, accountuserprofile *AccountUserProfile) *AccountUserProfilesUpdateCall {
- c := &AccountUserProfilesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.accountuserprofile = accountuserprofile
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountUserProfilesUpdateCall) Fields(s ...googleapi.Field) *AccountUserProfilesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountUserProfilesUpdateCall) Context(ctx context.Context) *AccountUserProfilesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountUserProfilesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.accountuserprofile)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/accountUserProfiles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.accountUserProfiles.update" call.
-// Exactly one of *AccountUserProfile or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AccountUserProfile.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountUserProfilesUpdateCall) Do() (*AccountUserProfile, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountUserProfile{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing account user profile.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.accountUserProfiles.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/accountUserProfiles",
- // "request": {
- // "$ref": "AccountUserProfile"
- // },
- // "response": {
- // "$ref": "AccountUserProfile"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.accounts.get":
-
-type AccountsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one account by ID.
-func (r *AccountsService) Get(profileId int64, id int64) *AccountsGetCall {
- c := &AccountsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsGetCall) Fields(s ...googleapi.Field) *AccountsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsGetCall) IfNoneMatch(entityTag string) *AccountsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsGetCall) Context(ctx context.Context) *AccountsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/accounts/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.accounts.get" call.
-// Exactly one of *Account or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Account.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsGetCall) Do() (*Account, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Account{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one account by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.accounts.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Account ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/accounts/{id}",
- // "response": {
- // "$ref": "Account"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.accounts.list":
-
-type AccountsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of accounts, possibly filtered.
-func (r *AccountsService) List(profileId int64) *AccountsListCall {
- c := &AccountsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Active sets the optional parameter "active": Select only active
-// accounts. Don't set this field to select both active and non-active
-// accounts.
-func (c *AccountsListCall) Active(active bool) *AccountsListCall {
- c.opt_["active"] = active
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only accounts with
-// these IDs.
-func (c *AccountsListCall) Ids(ids int64) *AccountsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *AccountsListCall) MaxResults(maxResults int64) *AccountsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *AccountsListCall) PageToken(pageToken string) *AccountsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name or ID. Wildcards (*) are allowed. For
-// example, "account*2015" will return objects with names like "account
-// June 2015", "account April 2015", or simply "account 2015". Most of
-// the searches also add wildcards implicitly at the start and the end
-// of the search string. For example, a search string of "account" will
-// match objects with name "my account", "account 2015", or simply
-// "account".
-func (c *AccountsListCall) SearchString(searchString string) *AccountsListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *AccountsListCall) SortField(sortField string) *AccountsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *AccountsListCall) SortOrder(sortOrder string) *AccountsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsListCall) Fields(s ...googleapi.Field) *AccountsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AccountsListCall) IfNoneMatch(entityTag string) *AccountsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsListCall) Context(ctx context.Context) *AccountsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["active"]; ok {
- params.Set("active", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/accounts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.accounts.list" call.
-// Exactly one of *AccountsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AccountsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AccountsListCall) Do() (*AccountsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AccountsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of accounts, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.accounts.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "active": {
- // "description": "Select only active accounts. Don't set this field to select both active and non-active accounts.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "ids": {
- // "description": "Select only accounts with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"account*2015\" will return objects with names like \"account June 2015\", \"account April 2015\", or simply \"account 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"account\" will match objects with name \"my account\", \"account 2015\", or simply \"account\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/accounts",
- // "response": {
- // "$ref": "AccountsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.accounts.patch":
-
-type AccountsPatchCall struct {
- s *Service
- profileId int64
- id int64
- account *Account
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing account. This method supports patch
-// semantics.
-func (r *AccountsService) Patch(profileId int64, id int64, account *Account) *AccountsPatchCall {
- c := &AccountsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.account = account
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsPatchCall) Fields(s ...googleapi.Field) *AccountsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsPatchCall) Context(ctx context.Context) *AccountsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.account)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/accounts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.accounts.patch" call.
-// Exactly one of *Account or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Account.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsPatchCall) Do() (*Account, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Account{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing account. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.accounts.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Account ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/accounts",
- // "request": {
- // "$ref": "Account"
- // },
- // "response": {
- // "$ref": "Account"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.accounts.update":
-
-type AccountsUpdateCall struct {
- s *Service
- profileId int64
- account *Account
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing account.
-func (r *AccountsService) Update(profileId int64, account *Account) *AccountsUpdateCall {
- c := &AccountsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.account = account
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AccountsUpdateCall) Fields(s ...googleapi.Field) *AccountsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AccountsUpdateCall) Context(ctx context.Context) *AccountsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AccountsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.account)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/accounts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.accounts.update" call.
-// Exactly one of *Account or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Account.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *AccountsUpdateCall) Do() (*Account, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Account{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing account.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.accounts.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/accounts",
- // "request": {
- // "$ref": "Account"
- // },
- // "response": {
- // "$ref": "Account"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.ads.get":
-
-type AdsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one ad by ID.
-func (r *AdsService) Get(profileId int64, id int64) *AdsGetCall {
- c := &AdsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdsGetCall) Fields(s ...googleapi.Field) *AdsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdsGetCall) IfNoneMatch(entityTag string) *AdsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdsGetCall) Context(ctx context.Context) *AdsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/ads/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.ads.get" call.
-// Exactly one of *Ad or error will be non-nil. Any non-2xx status code
-// is an error. Response headers are in either *Ad.ServerResponse.Header
-// or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *AdsGetCall) Do() (*Ad, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Ad{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one ad by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.ads.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Ad ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/ads/{id}",
- // "response": {
- // "$ref": "Ad"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.ads.insert":
-
-type AdsInsertCall struct {
- s *Service
- profileId int64
- ad *Ad
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new ad.
-func (r *AdsService) Insert(profileId int64, ad *Ad) *AdsInsertCall {
- c := &AdsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.ad = ad
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdsInsertCall) Fields(s ...googleapi.Field) *AdsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdsInsertCall) Context(ctx context.Context) *AdsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.ad)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/ads")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.ads.insert" call.
-// Exactly one of *Ad or error will be non-nil. Any non-2xx status code
-// is an error. Response headers are in either *Ad.ServerResponse.Header
-// or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *AdsInsertCall) Do() (*Ad, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Ad{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new ad.",
- // "httpMethod": "POST",
- // "id": "dfareporting.ads.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/ads",
- // "request": {
- // "$ref": "Ad"
- // },
- // "response": {
- // "$ref": "Ad"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.ads.list":
-
-type AdsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of ads, possibly filtered.
-func (r *AdsService) List(profileId int64) *AdsListCall {
- c := &AdsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Active sets the optional parameter "active": Select only active ads.
-func (c *AdsListCall) Active(active bool) *AdsListCall {
- c.opt_["active"] = active
- return c
-}
-
-// AdvertiserId sets the optional parameter "advertiserId": Select only
-// ads with this advertiser ID.
-func (c *AdsListCall) AdvertiserId(advertiserId int64) *AdsListCall {
- c.opt_["advertiserId"] = advertiserId
- return c
-}
-
-// Archived sets the optional parameter "archived": Select only archived
-// ads.
-func (c *AdsListCall) Archived(archived bool) *AdsListCall {
- c.opt_["archived"] = archived
- return c
-}
-
-// AudienceSegmentIds sets the optional parameter "audienceSegmentIds":
-// Select only ads with these audience segment IDs.
-func (c *AdsListCall) AudienceSegmentIds(audienceSegmentIds int64) *AdsListCall {
- c.opt_["audienceSegmentIds"] = audienceSegmentIds
- return c
-}
-
-// CampaignIds sets the optional parameter "campaignIds": Select only
-// ads with these campaign IDs.
-func (c *AdsListCall) CampaignIds(campaignIds int64) *AdsListCall {
- c.opt_["campaignIds"] = campaignIds
- return c
-}
-
-// Compatibility sets the optional parameter "compatibility": Select
-// default ads with the specified compatibility. Applicable when type is
-// AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering
-// either on desktop or on mobile devices for regular or interstitial
-// ads, respectively. APP and APP_INTERSTITIAL are for rendering in
-// mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video
-// ads developed with the VAST standard.
-//
-// Possible values:
-// "APP"
-// "APP_INTERSTITIAL"
-// "IN_STREAM_VIDEO"
-// "WEB"
-// "WEB_INTERSTITIAL"
-func (c *AdsListCall) Compatibility(compatibility string) *AdsListCall {
- c.opt_["compatibility"] = compatibility
- return c
-}
-
-// CreativeIds sets the optional parameter "creativeIds": Select only
-// ads with these creative IDs assigned.
-func (c *AdsListCall) CreativeIds(creativeIds int64) *AdsListCall {
- c.opt_["creativeIds"] = creativeIds
- return c
-}
-
-// CreativeOptimizationConfigurationIds sets the optional parameter
-// "creativeOptimizationConfigurationIds": Select only ads with these
-// creative optimization configuration IDs.
-func (c *AdsListCall) CreativeOptimizationConfigurationIds(creativeOptimizationConfigurationIds int64) *AdsListCall {
- c.opt_["creativeOptimizationConfigurationIds"] = creativeOptimizationConfigurationIds
- return c
-}
-
-// CreativeType sets the optional parameter "creativeType": Select only
-// ads with the specified creativeType.
-//
-// Possible values:
-// "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO"
-// "CUSTOM_INPAGE"
-// "CUSTOM_INTERSTITIAL"
-// "ENHANCED_BANNER"
-// "ENHANCED_IMAGE"
-// "FLASH_INPAGE"
-// "HTML5_BANNER"
-// "IMAGE"
-// "INSTREAM_VIDEO"
-// "INTERNAL_REDIRECT"
-// "INTERSTITIAL_INTERNAL_REDIRECT"
-// "REDIRECT"
-// "RICH_MEDIA_EXPANDING"
-// "RICH_MEDIA_IM_EXPAND"
-// "RICH_MEDIA_INPAGE"
-// "RICH_MEDIA_INPAGE_FLOATING"
-// "RICH_MEDIA_INTERSTITIAL_FLOAT"
-// "RICH_MEDIA_MOBILE_IN_APP"
-// "RICH_MEDIA_MULTI_FLOATING"
-// "RICH_MEDIA_PEEL_DOWN"
-// "TRACKING_TEXT"
-// "VAST_REDIRECT"
-// "VPAID_LINEAR"
-// "VPAID_NON_LINEAR"
-func (c *AdsListCall) CreativeType(creativeType string) *AdsListCall {
- c.opt_["creativeType"] = creativeType
- return c
-}
-
-// DynamicClickTracker sets the optional parameter
-// "dynamicClickTracker": Select only dynamic click trackers. Applicable
-// when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click
-// trackers. If false, select static click trackers. Leave unset to
-// select both.
-func (c *AdsListCall) DynamicClickTracker(dynamicClickTracker bool) *AdsListCall {
- c.opt_["dynamicClickTracker"] = dynamicClickTracker
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only ads with these
-// IDs.
-func (c *AdsListCall) Ids(ids int64) *AdsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// LandingPageIds sets the optional parameter "landingPageIds": Select
-// only ads with these landing page IDs.
-func (c *AdsListCall) LandingPageIds(landingPageIds int64) *AdsListCall {
- c.opt_["landingPageIds"] = landingPageIds
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *AdsListCall) MaxResults(maxResults int64) *AdsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OverriddenEventTagId sets the optional parameter
-// "overriddenEventTagId": Select only ads with this event tag override
-// ID.
-func (c *AdsListCall) OverriddenEventTagId(overriddenEventTagId int64) *AdsListCall {
- c.opt_["overriddenEventTagId"] = overriddenEventTagId
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *AdsListCall) PageToken(pageToken string) *AdsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// PlacementIds sets the optional parameter "placementIds": Select only
-// ads with these placement IDs assigned.
-func (c *AdsListCall) PlacementIds(placementIds int64) *AdsListCall {
- c.opt_["placementIds"] = placementIds
- return c
-}
-
-// RemarketingListIds sets the optional parameter "remarketingListIds":
-// Select only ads whose list targeting expression use these remarketing
-// list IDs.
-func (c *AdsListCall) RemarketingListIds(remarketingListIds int64) *AdsListCall {
- c.opt_["remarketingListIds"] = remarketingListIds
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name or ID. Wildcards (*) are allowed. For
-// example, "ad*2015" will return objects with names like "ad June
-// 2015", "ad April 2015", or simply "ad 2015". Most of the searches
-// also add wildcards implicitly at the start and the end of the search
-// string. For example, a search string of "ad" will match objects with
-// name "my ad", "ad 2015", or simply "ad".
-func (c *AdsListCall) SearchString(searchString string) *AdsListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SizeIds sets the optional parameter "sizeIds": Select only ads with
-// these size IDs.
-func (c *AdsListCall) SizeIds(sizeIds int64) *AdsListCall {
- c.opt_["sizeIds"] = sizeIds
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *AdsListCall) SortField(sortField string) *AdsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *AdsListCall) SortOrder(sortOrder string) *AdsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// SslCompliant sets the optional parameter "sslCompliant": Select only
-// ads that are SSL-compliant.
-func (c *AdsListCall) SslCompliant(sslCompliant bool) *AdsListCall {
- c.opt_["sslCompliant"] = sslCompliant
- return c
-}
-
-// SslRequired sets the optional parameter "sslRequired": Select only
-// ads that require SSL.
-func (c *AdsListCall) SslRequired(sslRequired bool) *AdsListCall {
- c.opt_["sslRequired"] = sslRequired
- return c
-}
-
-// Type sets the optional parameter "type": Select only ads with these
-// types.
-//
-// Possible values:
-// "AD_SERVING_CLICK_TRACKER"
-// "AD_SERVING_DEFAULT_AD"
-// "AD_SERVING_STANDARD_AD"
-// "AD_SERVING_TRACKING"
-func (c *AdsListCall) Type(type_ string) *AdsListCall {
- c.opt_["type"] = type_
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdsListCall) Fields(s ...googleapi.Field) *AdsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdsListCall) IfNoneMatch(entityTag string) *AdsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdsListCall) Context(ctx context.Context) *AdsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["active"]; ok {
- params.Set("active", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["advertiserId"]; ok {
- params.Set("advertiserId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["archived"]; ok {
- params.Set("archived", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["audienceSegmentIds"]; ok {
- params.Set("audienceSegmentIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["campaignIds"]; ok {
- params.Set("campaignIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["compatibility"]; ok {
- params.Set("compatibility", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["creativeIds"]; ok {
- params.Set("creativeIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["creativeOptimizationConfigurationIds"]; ok {
- params.Set("creativeOptimizationConfigurationIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["creativeType"]; ok {
- params.Set("creativeType", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["dynamicClickTracker"]; ok {
- params.Set("dynamicClickTracker", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["landingPageIds"]; ok {
- params.Set("landingPageIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["overriddenEventTagId"]; ok {
- params.Set("overriddenEventTagId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["placementIds"]; ok {
- params.Set("placementIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["remarketingListIds"]; ok {
- params.Set("remarketingListIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sizeIds"]; ok {
- params.Set("sizeIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sslCompliant"]; ok {
- params.Set("sslCompliant", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sslRequired"]; ok {
- params.Set("sslRequired", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["type"]; ok {
- params.Set("type", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/ads")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.ads.list" call.
-// Exactly one of *AdsListResponse or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AdsListResponse.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AdsListCall) Do() (*AdsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of ads, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.ads.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "active": {
- // "description": "Select only active ads.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "advertiserId": {
- // "description": "Select only ads with this advertiser ID.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "archived": {
- // "description": "Select only archived ads.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "audienceSegmentIds": {
- // "description": "Select only ads with these audience segment IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "campaignIds": {
- // "description": "Select only ads with these campaign IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "compatibility": {
- // "description": "Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.",
- // "enum": [
- // "APP",
- // "APP_INTERSTITIAL",
- // "IN_STREAM_VIDEO",
- // "WEB",
- // "WEB_INTERSTITIAL"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "creativeIds": {
- // "description": "Select only ads with these creative IDs assigned.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "creativeOptimizationConfigurationIds": {
- // "description": "Select only ads with these creative optimization configuration IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "creativeType": {
- // "description": "Select only ads with the specified creativeType.",
- // "enum": [
- // "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO",
- // "CUSTOM_INPAGE",
- // "CUSTOM_INTERSTITIAL",
- // "ENHANCED_BANNER",
- // "ENHANCED_IMAGE",
- // "FLASH_INPAGE",
- // "HTML5_BANNER",
- // "IMAGE",
- // "INSTREAM_VIDEO",
- // "INTERNAL_REDIRECT",
- // "INTERSTITIAL_INTERNAL_REDIRECT",
- // "REDIRECT",
- // "RICH_MEDIA_EXPANDING",
- // "RICH_MEDIA_IM_EXPAND",
- // "RICH_MEDIA_INPAGE",
- // "RICH_MEDIA_INPAGE_FLOATING",
- // "RICH_MEDIA_INTERSTITIAL_FLOAT",
- // "RICH_MEDIA_MOBILE_IN_APP",
- // "RICH_MEDIA_MULTI_FLOATING",
- // "RICH_MEDIA_PEEL_DOWN",
- // "TRACKING_TEXT",
- // "VAST_REDIRECT",
- // "VPAID_LINEAR",
- // "VPAID_NON_LINEAR"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "dynamicClickTracker": {
- // "description": "Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "ids": {
- // "description": "Select only ads with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "landingPageIds": {
- // "description": "Select only ads with these landing page IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "overriddenEventTagId": {
- // "description": "Select only ads with this event tag override ID.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "placementIds": {
- // "description": "Select only ads with these placement IDs assigned.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "remarketingListIds": {
- // "description": "Select only ads whose list targeting expression use these remarketing list IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"ad*2015\" will return objects with names like \"ad June 2015\", \"ad April 2015\", or simply \"ad 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"ad\" will match objects with name \"my ad\", \"ad 2015\", or simply \"ad\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sizeIds": {
- // "description": "Select only ads with these size IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sslCompliant": {
- // "description": "Select only ads that are SSL-compliant.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "sslRequired": {
- // "description": "Select only ads that require SSL.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "type": {
- // "description": "Select only ads with these types.",
- // "enum": [
- // "AD_SERVING_CLICK_TRACKER",
- // "AD_SERVING_DEFAULT_AD",
- // "AD_SERVING_STANDARD_AD",
- // "AD_SERVING_TRACKING"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/ads",
- // "response": {
- // "$ref": "AdsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.ads.patch":
-
-type AdsPatchCall struct {
- s *Service
- profileId int64
- id int64
- ad *Ad
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing ad. This method supports patch semantics.
-func (r *AdsService) Patch(profileId int64, id int64, ad *Ad) *AdsPatchCall {
- c := &AdsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.ad = ad
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdsPatchCall) Fields(s ...googleapi.Field) *AdsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdsPatchCall) Context(ctx context.Context) *AdsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.ad)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/ads")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.ads.patch" call.
-// Exactly one of *Ad or error will be non-nil. Any non-2xx status code
-// is an error. Response headers are in either *Ad.ServerResponse.Header
-// or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *AdsPatchCall) Do() (*Ad, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Ad{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing ad. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.ads.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Ad ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/ads",
- // "request": {
- // "$ref": "Ad"
- // },
- // "response": {
- // "$ref": "Ad"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.ads.update":
-
-type AdsUpdateCall struct {
- s *Service
- profileId int64
- ad *Ad
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing ad.
-func (r *AdsService) Update(profileId int64, ad *Ad) *AdsUpdateCall {
- c := &AdsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.ad = ad
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdsUpdateCall) Fields(s ...googleapi.Field) *AdsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdsUpdateCall) Context(ctx context.Context) *AdsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.ad)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/ads")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.ads.update" call.
-// Exactly one of *Ad or error will be non-nil. Any non-2xx status code
-// is an error. Response headers are in either *Ad.ServerResponse.Header
-// or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *AdsUpdateCall) Do() (*Ad, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Ad{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing ad.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.ads.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/ads",
- // "request": {
- // "$ref": "Ad"
- // },
- // "response": {
- // "$ref": "Ad"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.advertiserGroups.delete":
-
-type AdvertiserGroupsDeleteCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an existing advertiser group.
-func (r *AdvertiserGroupsService) Delete(profileId int64, id int64) *AdvertiserGroupsDeleteCall {
- c := &AdvertiserGroupsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdvertiserGroupsDeleteCall) Fields(s ...googleapi.Field) *AdvertiserGroupsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdvertiserGroupsDeleteCall) Context(ctx context.Context) *AdvertiserGroupsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdvertiserGroupsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/advertiserGroups/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.advertiserGroups.delete" call.
-func (c *AdvertiserGroupsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes an existing advertiser group.",
- // "httpMethod": "DELETE",
- // "id": "dfareporting.advertiserGroups.delete",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Advertiser group ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/advertiserGroups/{id}",
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.advertiserGroups.get":
-
-type AdvertiserGroupsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one advertiser group by ID.
-func (r *AdvertiserGroupsService) Get(profileId int64, id int64) *AdvertiserGroupsGetCall {
- c := &AdvertiserGroupsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdvertiserGroupsGetCall) Fields(s ...googleapi.Field) *AdvertiserGroupsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdvertiserGroupsGetCall) IfNoneMatch(entityTag string) *AdvertiserGroupsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdvertiserGroupsGetCall) Context(ctx context.Context) *AdvertiserGroupsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdvertiserGroupsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/advertiserGroups/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.advertiserGroups.get" call.
-// Exactly one of *AdvertiserGroup or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AdvertiserGroup.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AdvertiserGroupsGetCall) Do() (*AdvertiserGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdvertiserGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one advertiser group by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.advertiserGroups.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Advertiser group ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/advertiserGroups/{id}",
- // "response": {
- // "$ref": "AdvertiserGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.advertiserGroups.insert":
-
-type AdvertiserGroupsInsertCall struct {
- s *Service
- profileId int64
- advertisergroup *AdvertiserGroup
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new advertiser group.
-func (r *AdvertiserGroupsService) Insert(profileId int64, advertisergroup *AdvertiserGroup) *AdvertiserGroupsInsertCall {
- c := &AdvertiserGroupsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.advertisergroup = advertisergroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdvertiserGroupsInsertCall) Fields(s ...googleapi.Field) *AdvertiserGroupsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdvertiserGroupsInsertCall) Context(ctx context.Context) *AdvertiserGroupsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdvertiserGroupsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.advertisergroup)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/advertiserGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.advertiserGroups.insert" call.
-// Exactly one of *AdvertiserGroup or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AdvertiserGroup.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AdvertiserGroupsInsertCall) Do() (*AdvertiserGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdvertiserGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new advertiser group.",
- // "httpMethod": "POST",
- // "id": "dfareporting.advertiserGroups.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/advertiserGroups",
- // "request": {
- // "$ref": "AdvertiserGroup"
- // },
- // "response": {
- // "$ref": "AdvertiserGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.advertiserGroups.list":
-
-type AdvertiserGroupsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of advertiser groups, possibly filtered.
-func (r *AdvertiserGroupsService) List(profileId int64) *AdvertiserGroupsListCall {
- c := &AdvertiserGroupsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only advertiser groups
-// with these IDs.
-func (c *AdvertiserGroupsListCall) Ids(ids int64) *AdvertiserGroupsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *AdvertiserGroupsListCall) MaxResults(maxResults int64) *AdvertiserGroupsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *AdvertiserGroupsListCall) PageToken(pageToken string) *AdvertiserGroupsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name or ID. Wildcards (*) are allowed. For
-// example, "advertiser*2015" will return objects with names like
-// "advertiser group June 2015", "advertiser group April 2015", or
-// simply "advertiser group 2015". Most of the searches also add
-// wildcards implicitly at the start and the end of the search string.
-// For example, a search string of "advertisergroup" will match objects
-// with name "my advertisergroup", "advertisergroup 2015", or simply
-// "advertisergroup".
-func (c *AdvertiserGroupsListCall) SearchString(searchString string) *AdvertiserGroupsListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *AdvertiserGroupsListCall) SortField(sortField string) *AdvertiserGroupsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *AdvertiserGroupsListCall) SortOrder(sortOrder string) *AdvertiserGroupsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdvertiserGroupsListCall) Fields(s ...googleapi.Field) *AdvertiserGroupsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdvertiserGroupsListCall) IfNoneMatch(entityTag string) *AdvertiserGroupsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdvertiserGroupsListCall) Context(ctx context.Context) *AdvertiserGroupsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdvertiserGroupsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/advertiserGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.advertiserGroups.list" call.
-// Exactly one of *AdvertiserGroupsListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *AdvertiserGroupsListResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AdvertiserGroupsListCall) Do() (*AdvertiserGroupsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdvertiserGroupsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of advertiser groups, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.advertiserGroups.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "ids": {
- // "description": "Select only advertiser groups with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"advertiser*2015\" will return objects with names like \"advertiser group June 2015\", \"advertiser group April 2015\", or simply \"advertiser group 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"advertisergroup\" will match objects with name \"my advertisergroup\", \"advertisergroup 2015\", or simply \"advertisergroup\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/advertiserGroups",
- // "response": {
- // "$ref": "AdvertiserGroupsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.advertiserGroups.patch":
-
-type AdvertiserGroupsPatchCall struct {
- s *Service
- profileId int64
- id int64
- advertisergroup *AdvertiserGroup
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing advertiser group. This method supports
-// patch semantics.
-func (r *AdvertiserGroupsService) Patch(profileId int64, id int64, advertisergroup *AdvertiserGroup) *AdvertiserGroupsPatchCall {
- c := &AdvertiserGroupsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.advertisergroup = advertisergroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdvertiserGroupsPatchCall) Fields(s ...googleapi.Field) *AdvertiserGroupsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdvertiserGroupsPatchCall) Context(ctx context.Context) *AdvertiserGroupsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdvertiserGroupsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.advertisergroup)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/advertiserGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.advertiserGroups.patch" call.
-// Exactly one of *AdvertiserGroup or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AdvertiserGroup.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AdvertiserGroupsPatchCall) Do() (*AdvertiserGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdvertiserGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing advertiser group. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.advertiserGroups.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Advertiser group ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/advertiserGroups",
- // "request": {
- // "$ref": "AdvertiserGroup"
- // },
- // "response": {
- // "$ref": "AdvertiserGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.advertiserGroups.update":
-
-type AdvertiserGroupsUpdateCall struct {
- s *Service
- profileId int64
- advertisergroup *AdvertiserGroup
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing advertiser group.
-func (r *AdvertiserGroupsService) Update(profileId int64, advertisergroup *AdvertiserGroup) *AdvertiserGroupsUpdateCall {
- c := &AdvertiserGroupsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.advertisergroup = advertisergroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdvertiserGroupsUpdateCall) Fields(s ...googleapi.Field) *AdvertiserGroupsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdvertiserGroupsUpdateCall) Context(ctx context.Context) *AdvertiserGroupsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdvertiserGroupsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.advertisergroup)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/advertiserGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.advertiserGroups.update" call.
-// Exactly one of *AdvertiserGroup or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *AdvertiserGroup.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AdvertiserGroupsUpdateCall) Do() (*AdvertiserGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdvertiserGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing advertiser group.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.advertiserGroups.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/advertiserGroups",
- // "request": {
- // "$ref": "AdvertiserGroup"
- // },
- // "response": {
- // "$ref": "AdvertiserGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.advertisers.get":
-
-type AdvertisersGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one advertiser by ID.
-func (r *AdvertisersService) Get(profileId int64, id int64) *AdvertisersGetCall {
- c := &AdvertisersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdvertisersGetCall) Fields(s ...googleapi.Field) *AdvertisersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdvertisersGetCall) IfNoneMatch(entityTag string) *AdvertisersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdvertisersGetCall) Context(ctx context.Context) *AdvertisersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdvertisersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/advertisers/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.advertisers.get" call.
-// Exactly one of *Advertiser or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Advertiser.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AdvertisersGetCall) Do() (*Advertiser, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Advertiser{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one advertiser by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.advertisers.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Advertiser ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/advertisers/{id}",
- // "response": {
- // "$ref": "Advertiser"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.advertisers.insert":
-
-type AdvertisersInsertCall struct {
- s *Service
- profileId int64
- advertiser *Advertiser
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new advertiser.
-func (r *AdvertisersService) Insert(profileId int64, advertiser *Advertiser) *AdvertisersInsertCall {
- c := &AdvertisersInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.advertiser = advertiser
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdvertisersInsertCall) Fields(s ...googleapi.Field) *AdvertisersInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdvertisersInsertCall) Context(ctx context.Context) *AdvertisersInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdvertisersInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.advertiser)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/advertisers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.advertisers.insert" call.
-// Exactly one of *Advertiser or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Advertiser.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AdvertisersInsertCall) Do() (*Advertiser, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Advertiser{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new advertiser.",
- // "httpMethod": "POST",
- // "id": "dfareporting.advertisers.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/advertisers",
- // "request": {
- // "$ref": "Advertiser"
- // },
- // "response": {
- // "$ref": "Advertiser"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.advertisers.list":
-
-type AdvertisersListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of advertisers, possibly filtered.
-func (r *AdvertisersService) List(profileId int64) *AdvertisersListCall {
- c := &AdvertisersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// AdvertiserGroupIds sets the optional parameter "advertiserGroupIds":
-// Select only advertisers with these advertiser group IDs.
-func (c *AdvertisersListCall) AdvertiserGroupIds(advertiserGroupIds int64) *AdvertisersListCall {
- c.opt_["advertiserGroupIds"] = advertiserGroupIds
- return c
-}
-
-// FloodlightConfigurationIds sets the optional parameter
-// "floodlightConfigurationIds": Select only advertisers with these
-// floodlight configuration IDs.
-func (c *AdvertisersListCall) FloodlightConfigurationIds(floodlightConfigurationIds int64) *AdvertisersListCall {
- c.opt_["floodlightConfigurationIds"] = floodlightConfigurationIds
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only advertisers with
-// these IDs.
-func (c *AdvertisersListCall) Ids(ids int64) *AdvertisersListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// IncludeAdvertisersWithoutGroupsOnly sets the optional parameter
-// "includeAdvertisersWithoutGroupsOnly": Select only advertisers which
-// do not belong to any advertiser group.
-func (c *AdvertisersListCall) IncludeAdvertisersWithoutGroupsOnly(includeAdvertisersWithoutGroupsOnly bool) *AdvertisersListCall {
- c.opt_["includeAdvertisersWithoutGroupsOnly"] = includeAdvertisersWithoutGroupsOnly
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *AdvertisersListCall) MaxResults(maxResults int64) *AdvertisersListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OnlyParent sets the optional parameter "onlyParent": Select only
-// advertisers which use another advertiser's floodlight configuration.
-func (c *AdvertisersListCall) OnlyParent(onlyParent bool) *AdvertisersListCall {
- c.opt_["onlyParent"] = onlyParent
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *AdvertisersListCall) PageToken(pageToken string) *AdvertisersListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name or ID. Wildcards (*) are allowed. For
-// example, "advertiser*2015" will return objects with names like
-// "advertiser June 2015", "advertiser April 2015", or simply
-// "advertiser 2015". Most of the searches also add wildcards implicitly
-// at the start and the end of the search string. For example, a search
-// string of "advertiser" will match objects with name "my advertiser",
-// "advertiser 2015", or simply "advertiser".
-func (c *AdvertisersListCall) SearchString(searchString string) *AdvertisersListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *AdvertisersListCall) SortField(sortField string) *AdvertisersListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *AdvertisersListCall) SortOrder(sortOrder string) *AdvertisersListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Status sets the optional parameter "status": Select only advertisers
-// with the specified status.
-//
-// Possible values:
-// "APPROVED"
-// "ON_HOLD"
-func (c *AdvertisersListCall) Status(status string) *AdvertisersListCall {
- c.opt_["status"] = status
- return c
-}
-
-// SubaccountId sets the optional parameter "subaccountId": Select only
-// advertisers with these subaccount IDs.
-func (c *AdvertisersListCall) SubaccountId(subaccountId int64) *AdvertisersListCall {
- c.opt_["subaccountId"] = subaccountId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdvertisersListCall) Fields(s ...googleapi.Field) *AdvertisersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *AdvertisersListCall) IfNoneMatch(entityTag string) *AdvertisersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdvertisersListCall) Context(ctx context.Context) *AdvertisersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdvertisersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["advertiserGroupIds"]; ok {
- params.Set("advertiserGroupIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["floodlightConfigurationIds"]; ok {
- params.Set("floodlightConfigurationIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["includeAdvertisersWithoutGroupsOnly"]; ok {
- params.Set("includeAdvertisersWithoutGroupsOnly", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["onlyParent"]; ok {
- params.Set("onlyParent", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["status"]; ok {
- params.Set("status", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["subaccountId"]; ok {
- params.Set("subaccountId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/advertisers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.advertisers.list" call.
-// Exactly one of *AdvertisersListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *AdvertisersListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *AdvertisersListCall) Do() (*AdvertisersListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &AdvertisersListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of advertisers, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.advertisers.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "advertiserGroupIds": {
- // "description": "Select only advertisers with these advertiser group IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "floodlightConfigurationIds": {
- // "description": "Select only advertisers with these floodlight configuration IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only advertisers with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "includeAdvertisersWithoutGroupsOnly": {
- // "description": "Select only advertisers which do not belong to any advertiser group.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "onlyParent": {
- // "description": "Select only advertisers which use another advertiser's floodlight configuration.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"advertiser*2015\" will return objects with names like \"advertiser June 2015\", \"advertiser April 2015\", or simply \"advertiser 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"advertiser\" will match objects with name \"my advertiser\", \"advertiser 2015\", or simply \"advertiser\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "status": {
- // "description": "Select only advertisers with the specified status.",
- // "enum": [
- // "APPROVED",
- // "ON_HOLD"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "subaccountId": {
- // "description": "Select only advertisers with these subaccount IDs.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/advertisers",
- // "response": {
- // "$ref": "AdvertisersListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.advertisers.patch":
-
-type AdvertisersPatchCall struct {
- s *Service
- profileId int64
- id int64
- advertiser *Advertiser
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing advertiser. This method supports patch
-// semantics.
-func (r *AdvertisersService) Patch(profileId int64, id int64, advertiser *Advertiser) *AdvertisersPatchCall {
- c := &AdvertisersPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.advertiser = advertiser
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdvertisersPatchCall) Fields(s ...googleapi.Field) *AdvertisersPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdvertisersPatchCall) Context(ctx context.Context) *AdvertisersPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdvertisersPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.advertiser)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/advertisers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.advertisers.patch" call.
-// Exactly one of *Advertiser or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Advertiser.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AdvertisersPatchCall) Do() (*Advertiser, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Advertiser{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing advertiser. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.advertisers.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Advertiser ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/advertisers",
- // "request": {
- // "$ref": "Advertiser"
- // },
- // "response": {
- // "$ref": "Advertiser"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.advertisers.update":
-
-type AdvertisersUpdateCall struct {
- s *Service
- profileId int64
- advertiser *Advertiser
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing advertiser.
-func (r *AdvertisersService) Update(profileId int64, advertiser *Advertiser) *AdvertisersUpdateCall {
- c := &AdvertisersUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.advertiser = advertiser
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *AdvertisersUpdateCall) Fields(s ...googleapi.Field) *AdvertisersUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *AdvertisersUpdateCall) Context(ctx context.Context) *AdvertisersUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *AdvertisersUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.advertiser)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/advertisers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.advertisers.update" call.
-// Exactly one of *Advertiser or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Advertiser.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *AdvertisersUpdateCall) Do() (*Advertiser, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Advertiser{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing advertiser.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.advertisers.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/advertisers",
- // "request": {
- // "$ref": "Advertiser"
- // },
- // "response": {
- // "$ref": "Advertiser"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.browsers.list":
-
-type BrowsersListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of browsers.
-func (r *BrowsersService) List(profileId int64) *BrowsersListCall {
- c := &BrowsersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *BrowsersListCall) Fields(s ...googleapi.Field) *BrowsersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *BrowsersListCall) IfNoneMatch(entityTag string) *BrowsersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *BrowsersListCall) Context(ctx context.Context) *BrowsersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *BrowsersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/browsers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.browsers.list" call.
-// Exactly one of *BrowsersListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *BrowsersListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *BrowsersListCall) Do() (*BrowsersListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &BrowsersListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of browsers.",
- // "httpMethod": "GET",
- // "id": "dfareporting.browsers.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/browsers",
- // "response": {
- // "$ref": "BrowsersListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.campaignCreativeAssociations.insert":
-
-type CampaignCreativeAssociationsInsertCall struct {
- s *Service
- profileId int64
- campaignId int64
- campaigncreativeassociation *CampaignCreativeAssociation
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Associates a creative with the specified campaign. This
-// method creates a default ad with dimensions matching the creative in
-// the campaign if such a default ad does not exist already.
-func (r *CampaignCreativeAssociationsService) Insert(profileId int64, campaignId int64, campaigncreativeassociation *CampaignCreativeAssociation) *CampaignCreativeAssociationsInsertCall {
- c := &CampaignCreativeAssociationsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.campaignId = campaignId
- c.campaigncreativeassociation = campaigncreativeassociation
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CampaignCreativeAssociationsInsertCall) Fields(s ...googleapi.Field) *CampaignCreativeAssociationsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CampaignCreativeAssociationsInsertCall) Context(ctx context.Context) *CampaignCreativeAssociationsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CampaignCreativeAssociationsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.campaigncreativeassociation)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "campaignId": strconv.FormatInt(c.campaignId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.campaignCreativeAssociations.insert" call.
-// Exactly one of *CampaignCreativeAssociation or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *CampaignCreativeAssociation.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CampaignCreativeAssociationsInsertCall) Do() (*CampaignCreativeAssociation, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CampaignCreativeAssociation{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.",
- // "httpMethod": "POST",
- // "id": "dfareporting.campaignCreativeAssociations.insert",
- // "parameterOrder": [
- // "profileId",
- // "campaignId"
- // ],
- // "parameters": {
- // "campaignId": {
- // "description": "Campaign ID in this association.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
- // "request": {
- // "$ref": "CampaignCreativeAssociation"
- // },
- // "response": {
- // "$ref": "CampaignCreativeAssociation"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.campaignCreativeAssociations.list":
-
-type CampaignCreativeAssociationsListCall struct {
- s *Service
- profileId int64
- campaignId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of creative IDs associated with the
-// specified campaign.
-func (r *CampaignCreativeAssociationsService) List(profileId int64, campaignId int64) *CampaignCreativeAssociationsListCall {
- c := &CampaignCreativeAssociationsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.campaignId = campaignId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *CampaignCreativeAssociationsListCall) MaxResults(maxResults int64) *CampaignCreativeAssociationsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *CampaignCreativeAssociationsListCall) PageToken(pageToken string) *CampaignCreativeAssociationsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *CampaignCreativeAssociationsListCall) SortOrder(sortOrder string) *CampaignCreativeAssociationsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CampaignCreativeAssociationsListCall) Fields(s ...googleapi.Field) *CampaignCreativeAssociationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CampaignCreativeAssociationsListCall) IfNoneMatch(entityTag string) *CampaignCreativeAssociationsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CampaignCreativeAssociationsListCall) Context(ctx context.Context) *CampaignCreativeAssociationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CampaignCreativeAssociationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "campaignId": strconv.FormatInt(c.campaignId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.campaignCreativeAssociations.list" call.
-// Exactly one of *CampaignCreativeAssociationsListResponse or error
-// will be non-nil. Any non-2xx status code is an error. Response
-// headers are in either
-// *CampaignCreativeAssociationsListResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *CampaignCreativeAssociationsListCall) Do() (*CampaignCreativeAssociationsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CampaignCreativeAssociationsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of creative IDs associated with the specified campaign.",
- // "httpMethod": "GET",
- // "id": "dfareporting.campaignCreativeAssociations.list",
- // "parameterOrder": [
- // "profileId",
- // "campaignId"
- // ],
- // "parameters": {
- // "campaignId": {
- // "description": "Campaign ID in this association.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
- // "response": {
- // "$ref": "CampaignCreativeAssociationsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.campaigns.get":
-
-type CampaignsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one campaign by ID.
-func (r *CampaignsService) Get(profileId int64, id int64) *CampaignsGetCall {
- c := &CampaignsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CampaignsGetCall) Fields(s ...googleapi.Field) *CampaignsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CampaignsGetCall) IfNoneMatch(entityTag string) *CampaignsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CampaignsGetCall) Context(ctx context.Context) *CampaignsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CampaignsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/campaigns/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.campaigns.get" call.
-// Exactly one of *Campaign or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Campaign.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CampaignsGetCall) Do() (*Campaign, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Campaign{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one campaign by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.campaigns.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Campaign ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/campaigns/{id}",
- // "response": {
- // "$ref": "Campaign"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.campaigns.insert":
-
-type CampaignsInsertCall struct {
- s *Service
- profileId int64
- defaultLandingPageName string
- defaultLandingPageUrl string
- campaign *Campaign
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new campaign.
-func (r *CampaignsService) Insert(profileId int64, defaultLandingPageName string, defaultLandingPageUrl string, campaign *Campaign) *CampaignsInsertCall {
- c := &CampaignsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.defaultLandingPageName = defaultLandingPageName
- c.defaultLandingPageUrl = defaultLandingPageUrl
- c.campaign = campaign
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CampaignsInsertCall) Fields(s ...googleapi.Field) *CampaignsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CampaignsInsertCall) Context(ctx context.Context) *CampaignsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CampaignsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.campaign)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("defaultLandingPageName", fmt.Sprintf("%v", c.defaultLandingPageName))
- params.Set("defaultLandingPageUrl", fmt.Sprintf("%v", c.defaultLandingPageUrl))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/campaigns")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.campaigns.insert" call.
-// Exactly one of *Campaign or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Campaign.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CampaignsInsertCall) Do() (*Campaign, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Campaign{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new campaign.",
- // "httpMethod": "POST",
- // "id": "dfareporting.campaigns.insert",
- // "parameterOrder": [
- // "profileId",
- // "defaultLandingPageName",
- // "defaultLandingPageUrl"
- // ],
- // "parameters": {
- // "defaultLandingPageName": {
- // "description": "Default landing page name for this new campaign. Must be less than 256 characters long.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "defaultLandingPageUrl": {
- // "description": "Default landing page URL for this new campaign.",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/campaigns",
- // "request": {
- // "$ref": "Campaign"
- // },
- // "response": {
- // "$ref": "Campaign"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.campaigns.list":
-
-type CampaignsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of campaigns, possibly filtered.
-func (r *CampaignsService) List(profileId int64) *CampaignsListCall {
- c := &CampaignsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// AdvertiserGroupIds sets the optional parameter "advertiserGroupIds":
-// Select only campaigns whose advertisers belong to these advertiser
-// groups.
-func (c *CampaignsListCall) AdvertiserGroupIds(advertiserGroupIds int64) *CampaignsListCall {
- c.opt_["advertiserGroupIds"] = advertiserGroupIds
- return c
-}
-
-// AdvertiserIds sets the optional parameter "advertiserIds": Select
-// only campaigns that belong to these advertisers.
-func (c *CampaignsListCall) AdvertiserIds(advertiserIds int64) *CampaignsListCall {
- c.opt_["advertiserIds"] = advertiserIds
- return c
-}
-
-// Archived sets the optional parameter "archived": Select only archived
-// campaigns. Don't set this field to select both archived and
-// non-archived campaigns.
-func (c *CampaignsListCall) Archived(archived bool) *CampaignsListCall {
- c.opt_["archived"] = archived
- return c
-}
-
-// AtLeastOneOptimizationActivity sets the optional parameter
-// "atLeastOneOptimizationActivity": Select only campaigns that have at
-// least one optimization activity.
-func (c *CampaignsListCall) AtLeastOneOptimizationActivity(atLeastOneOptimizationActivity bool) *CampaignsListCall {
- c.opt_["atLeastOneOptimizationActivity"] = atLeastOneOptimizationActivity
- return c
-}
-
-// ExcludedIds sets the optional parameter "excludedIds": Exclude
-// campaigns with these IDs.
-func (c *CampaignsListCall) ExcludedIds(excludedIds int64) *CampaignsListCall {
- c.opt_["excludedIds"] = excludedIds
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only campaigns with
-// these IDs.
-func (c *CampaignsListCall) Ids(ids int64) *CampaignsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *CampaignsListCall) MaxResults(maxResults int64) *CampaignsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OverriddenEventTagId sets the optional parameter
-// "overriddenEventTagId": Select only campaigns that have overridden
-// this event tag ID.
-func (c *CampaignsListCall) OverriddenEventTagId(overriddenEventTagId int64) *CampaignsListCall {
- c.opt_["overriddenEventTagId"] = overriddenEventTagId
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *CampaignsListCall) PageToken(pageToken string) *CampaignsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for campaigns by name or ID. Wildcards (*) are allowed. For
-// example, "campaign*2015" will return campaigns with names like
-// "campaign June 2015", "campaign April 2015", or simply "campaign
-// 2015". Most of the searches also add wildcards implicitly at the
-// start and the end of the search string. For example, a search string
-// of "campaign" will match campaigns with name "my campaign", "campaign
-// 2015", or simply "campaign".
-func (c *CampaignsListCall) SearchString(searchString string) *CampaignsListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *CampaignsListCall) SortField(sortField string) *CampaignsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *CampaignsListCall) SortOrder(sortOrder string) *CampaignsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// SubaccountId sets the optional parameter "subaccountId": Select only
-// campaigns that belong to this subaccount.
-func (c *CampaignsListCall) SubaccountId(subaccountId int64) *CampaignsListCall {
- c.opt_["subaccountId"] = subaccountId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CampaignsListCall) Fields(s ...googleapi.Field) *CampaignsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CampaignsListCall) IfNoneMatch(entityTag string) *CampaignsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CampaignsListCall) Context(ctx context.Context) *CampaignsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CampaignsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["advertiserGroupIds"]; ok {
- params.Set("advertiserGroupIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["advertiserIds"]; ok {
- params.Set("advertiserIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["archived"]; ok {
- params.Set("archived", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["atLeastOneOptimizationActivity"]; ok {
- params.Set("atLeastOneOptimizationActivity", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["excludedIds"]; ok {
- params.Set("excludedIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["overriddenEventTagId"]; ok {
- params.Set("overriddenEventTagId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["subaccountId"]; ok {
- params.Set("subaccountId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/campaigns")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.campaigns.list" call.
-// Exactly one of *CampaignsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CampaignsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CampaignsListCall) Do() (*CampaignsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CampaignsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of campaigns, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.campaigns.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "advertiserGroupIds": {
- // "description": "Select only campaigns whose advertisers belong to these advertiser groups.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "advertiserIds": {
- // "description": "Select only campaigns that belong to these advertisers.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "archived": {
- // "description": "Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "atLeastOneOptimizationActivity": {
- // "description": "Select only campaigns that have at least one optimization activity.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "excludedIds": {
- // "description": "Exclude campaigns with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only campaigns with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "overriddenEventTagId": {
- // "description": "Select only campaigns that have overridden this event tag ID.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, \"campaign*2015\" will return campaigns with names like \"campaign June 2015\", \"campaign April 2015\", or simply \"campaign 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"campaign\" will match campaigns with name \"my campaign\", \"campaign 2015\", or simply \"campaign\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "subaccountId": {
- // "description": "Select only campaigns that belong to this subaccount.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/campaigns",
- // "response": {
- // "$ref": "CampaignsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.campaigns.patch":
-
-type CampaignsPatchCall struct {
- s *Service
- profileId int64
- id int64
- campaign *Campaign
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing campaign. This method supports patch
-// semantics.
-func (r *CampaignsService) Patch(profileId int64, id int64, campaign *Campaign) *CampaignsPatchCall {
- c := &CampaignsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.campaign = campaign
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CampaignsPatchCall) Fields(s ...googleapi.Field) *CampaignsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CampaignsPatchCall) Context(ctx context.Context) *CampaignsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CampaignsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.campaign)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/campaigns")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.campaigns.patch" call.
-// Exactly one of *Campaign or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Campaign.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CampaignsPatchCall) Do() (*Campaign, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Campaign{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing campaign. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.campaigns.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Campaign ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/campaigns",
- // "request": {
- // "$ref": "Campaign"
- // },
- // "response": {
- // "$ref": "Campaign"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.campaigns.update":
-
-type CampaignsUpdateCall struct {
- s *Service
- profileId int64
- campaign *Campaign
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing campaign.
-func (r *CampaignsService) Update(profileId int64, campaign *Campaign) *CampaignsUpdateCall {
- c := &CampaignsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.campaign = campaign
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CampaignsUpdateCall) Fields(s ...googleapi.Field) *CampaignsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CampaignsUpdateCall) Context(ctx context.Context) *CampaignsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CampaignsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.campaign)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/campaigns")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.campaigns.update" call.
-// Exactly one of *Campaign or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Campaign.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CampaignsUpdateCall) Do() (*Campaign, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Campaign{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing campaign.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.campaigns.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/campaigns",
- // "request": {
- // "$ref": "Campaign"
- // },
- // "response": {
- // "$ref": "Campaign"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.changeLogs.get":
-
-type ChangeLogsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one change log by ID.
-func (r *ChangeLogsService) Get(profileId int64, id int64) *ChangeLogsGetCall {
- c := &ChangeLogsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ChangeLogsGetCall) Fields(s ...googleapi.Field) *ChangeLogsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ChangeLogsGetCall) IfNoneMatch(entityTag string) *ChangeLogsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ChangeLogsGetCall) Context(ctx context.Context) *ChangeLogsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ChangeLogsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/changeLogs/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.changeLogs.get" call.
-// Exactly one of *ChangeLog or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ChangeLog.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ChangeLogsGetCall) Do() (*ChangeLog, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ChangeLog{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one change log by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.changeLogs.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Change log ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/changeLogs/{id}",
- // "response": {
- // "$ref": "ChangeLog"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.changeLogs.list":
-
-type ChangeLogsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of change logs.
-func (r *ChangeLogsService) List(profileId int64) *ChangeLogsListCall {
- c := &ChangeLogsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Action sets the optional parameter "action": Select only change logs
-// with the specified action.
-//
-// Possible values:
-// "ACTION_ADD"
-// "ACTION_ASSIGN"
-// "ACTION_ASSOCIATE"
-// "ACTION_CREATE"
-// "ACTION_DELETE"
-// "ACTION_DISABLE"
-// "ACTION_EMAIL_TAGS"
-// "ACTION_ENABLE"
-// "ACTION_LINK"
-// "ACTION_MARK_AS_DEFAULT"
-// "ACTION_PUSH"
-// "ACTION_REMOVE"
-// "ACTION_SEND"
-// "ACTION_SHARE"
-// "ACTION_UNASSIGN"
-// "ACTION_UNLINK"
-// "ACTION_UPDATE"
-func (c *ChangeLogsListCall) Action(action string) *ChangeLogsListCall {
- c.opt_["action"] = action
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only change logs with
-// these IDs.
-func (c *ChangeLogsListCall) Ids(ids int64) *ChangeLogsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxChangeTime sets the optional parameter "maxChangeTime": Select
-// only change logs whose change time is before the specified
-// maxChangeTime.The time should be formatted as an RFC3339 date/time
-// string. For example, for 10:54 PM on July 18th, 2015, in the
-// America/New York time zone, the format is
-// "2015-07-18T22:54:00-04:00". In other words, the year, month, day,
-// the letter T, the hour (24-hour clock system), minute, second, and
-// then the time zone offset.
-func (c *ChangeLogsListCall) MaxChangeTime(maxChangeTime string) *ChangeLogsListCall {
- c.opt_["maxChangeTime"] = maxChangeTime
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *ChangeLogsListCall) MaxResults(maxResults int64) *ChangeLogsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// MinChangeTime sets the optional parameter "minChangeTime": Select
-// only change logs whose change time is before the specified
-// minChangeTime.The time should be formatted as an RFC3339 date/time
-// string. For example, for 10:54 PM on July 18th, 2015, in the
-// America/New York time zone, the format is
-// "2015-07-18T22:54:00-04:00". In other words, the year, month, day,
-// the letter T, the hour (24-hour clock system), minute, second, and
-// then the time zone offset.
-func (c *ChangeLogsListCall) MinChangeTime(minChangeTime string) *ChangeLogsListCall {
- c.opt_["minChangeTime"] = minChangeTime
- return c
-}
-
-// ObjectIds sets the optional parameter "objectIds": Select only change
-// logs with these object IDs.
-func (c *ChangeLogsListCall) ObjectIds(objectIds int64) *ChangeLogsListCall {
- c.opt_["objectIds"] = objectIds
- return c
-}
-
-// ObjectType sets the optional parameter "objectType": Select only
-// change logs with the specified object type.
-//
-// Possible values:
-// "OBJECT_ACCOUNT"
-// "OBJECT_ACCOUNT_BILLING_FEATURE"
-// "OBJECT_AD"
-// "OBJECT_ADVERTISER"
-// "OBJECT_ADVERTISER_GROUP"
-// "OBJECT_BILLING_ACCOUNT_GROUP"
-// "OBJECT_BILLING_FEATURE"
-// "OBJECT_BILLING_MINIMUM_FEE"
-// "OBJECT_BILLING_PROFILE"
-// "OBJECT_CAMPAIGN"
-// "OBJECT_CONTENT_CATEGORY"
-// "OBJECT_CREATIVE"
-// "OBJECT_CREATIVE_ASSET"
-// "OBJECT_CREATIVE_BUNDLE"
-// "OBJECT_CREATIVE_FIELD"
-// "OBJECT_CREATIVE_GROUP"
-// "OBJECT_DFA_SITE"
-// "OBJECT_EVENT_TAG"
-// "OBJECT_FLOODLIGHT_ACTIVITY_GROUP"
-// "OBJECT_FLOODLIGHT_ACTVITY"
-// "OBJECT_FLOODLIGHT_CONFIGURATION"
-// "OBJECT_INSTREAM_CREATIVE"
-// "OBJECT_LANDING_PAGE"
-// "OBJECT_MEDIA_ORDER"
-// "OBJECT_PLACEMENT"
-// "OBJECT_PLACEMENT_STRATEGY"
-// "OBJECT_PROVIDED_LIST_CLIENT"
-// "OBJECT_RATE_CARD"
-// "OBJECT_REMARKETING_LIST"
-// "OBJECT_RICHMEDIA_CREATIVE"
-// "OBJECT_SD_SITE"
-// "OBJECT_SIZE"
-// "OBJECT_SUBACCOUNT"
-// "OBJECT_USER_PROFILE"
-// "OBJECT_USER_PROFILE_FILTER"
-// "OBJECT_USER_ROLE"
-func (c *ChangeLogsListCall) ObjectType(objectType string) *ChangeLogsListCall {
- c.opt_["objectType"] = objectType
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *ChangeLogsListCall) PageToken(pageToken string) *ChangeLogsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Select only
-// change logs whose object ID, user name, old or new values match the
-// search string.
-func (c *ChangeLogsListCall) SearchString(searchString string) *ChangeLogsListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// UserProfileIds sets the optional parameter "userProfileIds": Select
-// only change logs with these user profile IDs.
-func (c *ChangeLogsListCall) UserProfileIds(userProfileIds int64) *ChangeLogsListCall {
- c.opt_["userProfileIds"] = userProfileIds
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ChangeLogsListCall) Fields(s ...googleapi.Field) *ChangeLogsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ChangeLogsListCall) IfNoneMatch(entityTag string) *ChangeLogsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ChangeLogsListCall) Context(ctx context.Context) *ChangeLogsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ChangeLogsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["action"]; ok {
- params.Set("action", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxChangeTime"]; ok {
- params.Set("maxChangeTime", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["minChangeTime"]; ok {
- params.Set("minChangeTime", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["objectIds"]; ok {
- params.Set("objectIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["objectType"]; ok {
- params.Set("objectType", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["userProfileIds"]; ok {
- params.Set("userProfileIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/changeLogs")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.changeLogs.list" call.
-// Exactly one of *ChangeLogsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ChangeLogsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ChangeLogsListCall) Do() (*ChangeLogsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ChangeLogsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of change logs.",
- // "httpMethod": "GET",
- // "id": "dfareporting.changeLogs.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "action": {
- // "description": "Select only change logs with the specified action.",
- // "enum": [
- // "ACTION_ADD",
- // "ACTION_ASSIGN",
- // "ACTION_ASSOCIATE",
- // "ACTION_CREATE",
- // "ACTION_DELETE",
- // "ACTION_DISABLE",
- // "ACTION_EMAIL_TAGS",
- // "ACTION_ENABLE",
- // "ACTION_LINK",
- // "ACTION_MARK_AS_DEFAULT",
- // "ACTION_PUSH",
- // "ACTION_REMOVE",
- // "ACTION_SEND",
- // "ACTION_SHARE",
- // "ACTION_UNASSIGN",
- // "ACTION_UNLINK",
- // "ACTION_UPDATE"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only change logs with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxChangeTime": {
- // "description": "Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is \"2015-07-18T22:54:00-04:00\". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "minChangeTime": {
- // "description": "Select only change logs whose change time is before the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is \"2015-07-18T22:54:00-04:00\". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.",
- // "location": "query",
- // "type": "string"
- // },
- // "objectIds": {
- // "description": "Select only change logs with these object IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "objectType": {
- // "description": "Select only change logs with the specified object type.",
- // "enum": [
- // "OBJECT_ACCOUNT",
- // "OBJECT_ACCOUNT_BILLING_FEATURE",
- // "OBJECT_AD",
- // "OBJECT_ADVERTISER",
- // "OBJECT_ADVERTISER_GROUP",
- // "OBJECT_BILLING_ACCOUNT_GROUP",
- // "OBJECT_BILLING_FEATURE",
- // "OBJECT_BILLING_MINIMUM_FEE",
- // "OBJECT_BILLING_PROFILE",
- // "OBJECT_CAMPAIGN",
- // "OBJECT_CONTENT_CATEGORY",
- // "OBJECT_CREATIVE",
- // "OBJECT_CREATIVE_ASSET",
- // "OBJECT_CREATIVE_BUNDLE",
- // "OBJECT_CREATIVE_FIELD",
- // "OBJECT_CREATIVE_GROUP",
- // "OBJECT_DFA_SITE",
- // "OBJECT_EVENT_TAG",
- // "OBJECT_FLOODLIGHT_ACTIVITY_GROUP",
- // "OBJECT_FLOODLIGHT_ACTVITY",
- // "OBJECT_FLOODLIGHT_CONFIGURATION",
- // "OBJECT_INSTREAM_CREATIVE",
- // "OBJECT_LANDING_PAGE",
- // "OBJECT_MEDIA_ORDER",
- // "OBJECT_PLACEMENT",
- // "OBJECT_PLACEMENT_STRATEGY",
- // "OBJECT_PROVIDED_LIST_CLIENT",
- // "OBJECT_RATE_CARD",
- // "OBJECT_REMARKETING_LIST",
- // "OBJECT_RICHMEDIA_CREATIVE",
- // "OBJECT_SD_SITE",
- // "OBJECT_SIZE",
- // "OBJECT_SUBACCOUNT",
- // "OBJECT_USER_PROFILE",
- // "OBJECT_USER_PROFILE_FILTER",
- // "OBJECT_USER_ROLE"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Select only change logs whose object ID, user name, old or new values match the search string.",
- // "location": "query",
- // "type": "string"
- // },
- // "userProfileIds": {
- // "description": "Select only change logs with these user profile IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/changeLogs",
- // "response": {
- // "$ref": "ChangeLogsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.cities.list":
-
-type CitiesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of cities, possibly filtered.
-func (r *CitiesService) List(profileId int64) *CitiesListCall {
- c := &CitiesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// CountryDartIds sets the optional parameter "countryDartIds": Select
-// only cities from these countries.
-func (c *CitiesListCall) CountryDartIds(countryDartIds int64) *CitiesListCall {
- c.opt_["countryDartIds"] = countryDartIds
- return c
-}
-
-// DartIds sets the optional parameter "dartIds": Select only cities
-// with these DART IDs.
-func (c *CitiesListCall) DartIds(dartIds int64) *CitiesListCall {
- c.opt_["dartIds"] = dartIds
- return c
-}
-
-// NamePrefix sets the optional parameter "namePrefix": Select only
-// cities with names starting with this prefix.
-func (c *CitiesListCall) NamePrefix(namePrefix string) *CitiesListCall {
- c.opt_["namePrefix"] = namePrefix
- return c
-}
-
-// RegionDartIds sets the optional parameter "regionDartIds": Select
-// only cities from these regions.
-func (c *CitiesListCall) RegionDartIds(regionDartIds int64) *CitiesListCall {
- c.opt_["regionDartIds"] = regionDartIds
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CitiesListCall) Fields(s ...googleapi.Field) *CitiesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CitiesListCall) IfNoneMatch(entityTag string) *CitiesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CitiesListCall) Context(ctx context.Context) *CitiesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CitiesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["countryDartIds"]; ok {
- params.Set("countryDartIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["dartIds"]; ok {
- params.Set("dartIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["namePrefix"]; ok {
- params.Set("namePrefix", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["regionDartIds"]; ok {
- params.Set("regionDartIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/cities")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.cities.list" call.
-// Exactly one of *CitiesListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CitiesListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CitiesListCall) Do() (*CitiesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CitiesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of cities, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.cities.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "countryDartIds": {
- // "description": "Select only cities from these countries.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "dartIds": {
- // "description": "Select only cities with these DART IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "namePrefix": {
- // "description": "Select only cities with names starting with this prefix.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "regionDartIds": {
- // "description": "Select only cities from these regions.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/cities",
- // "response": {
- // "$ref": "CitiesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.connectionTypes.get":
-
-type ConnectionTypesGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one connection type by ID.
-func (r *ConnectionTypesService) Get(profileId int64, id int64) *ConnectionTypesGetCall {
- c := &ConnectionTypesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ConnectionTypesGetCall) Fields(s ...googleapi.Field) *ConnectionTypesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ConnectionTypesGetCall) IfNoneMatch(entityTag string) *ConnectionTypesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ConnectionTypesGetCall) Context(ctx context.Context) *ConnectionTypesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ConnectionTypesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/connectionTypes/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.connectionTypes.get" call.
-// Exactly one of *ConnectionType or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ConnectionType.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ConnectionTypesGetCall) Do() (*ConnectionType, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ConnectionType{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one connection type by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.connectionTypes.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Connection type ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/connectionTypes/{id}",
- // "response": {
- // "$ref": "ConnectionType"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.connectionTypes.list":
-
-type ConnectionTypesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of connection types.
-func (r *ConnectionTypesService) List(profileId int64) *ConnectionTypesListCall {
- c := &ConnectionTypesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ConnectionTypesListCall) Fields(s ...googleapi.Field) *ConnectionTypesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ConnectionTypesListCall) IfNoneMatch(entityTag string) *ConnectionTypesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ConnectionTypesListCall) Context(ctx context.Context) *ConnectionTypesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ConnectionTypesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/connectionTypes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.connectionTypes.list" call.
-// Exactly one of *ConnectionTypesListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *ConnectionTypesListResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ConnectionTypesListCall) Do() (*ConnectionTypesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ConnectionTypesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of connection types.",
- // "httpMethod": "GET",
- // "id": "dfareporting.connectionTypes.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/connectionTypes",
- // "response": {
- // "$ref": "ConnectionTypesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.contentCategories.delete":
-
-type ContentCategoriesDeleteCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an existing content category.
-func (r *ContentCategoriesService) Delete(profileId int64, id int64) *ContentCategoriesDeleteCall {
- c := &ContentCategoriesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ContentCategoriesDeleteCall) Fields(s ...googleapi.Field) *ContentCategoriesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ContentCategoriesDeleteCall) Context(ctx context.Context) *ContentCategoriesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ContentCategoriesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/contentCategories/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.contentCategories.delete" call.
-func (c *ContentCategoriesDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes an existing content category.",
- // "httpMethod": "DELETE",
- // "id": "dfareporting.contentCategories.delete",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Content category ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/contentCategories/{id}",
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.contentCategories.get":
-
-type ContentCategoriesGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one content category by ID.
-func (r *ContentCategoriesService) Get(profileId int64, id int64) *ContentCategoriesGetCall {
- c := &ContentCategoriesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ContentCategoriesGetCall) Fields(s ...googleapi.Field) *ContentCategoriesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ContentCategoriesGetCall) IfNoneMatch(entityTag string) *ContentCategoriesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ContentCategoriesGetCall) Context(ctx context.Context) *ContentCategoriesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ContentCategoriesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/contentCategories/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.contentCategories.get" call.
-// Exactly one of *ContentCategory or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ContentCategory.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ContentCategoriesGetCall) Do() (*ContentCategory, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ContentCategory{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one content category by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.contentCategories.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Content category ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/contentCategories/{id}",
- // "response": {
- // "$ref": "ContentCategory"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.contentCategories.insert":
-
-type ContentCategoriesInsertCall struct {
- s *Service
- profileId int64
- contentcategory *ContentCategory
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new content category.
-func (r *ContentCategoriesService) Insert(profileId int64, contentcategory *ContentCategory) *ContentCategoriesInsertCall {
- c := &ContentCategoriesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.contentcategory = contentcategory
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ContentCategoriesInsertCall) Fields(s ...googleapi.Field) *ContentCategoriesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ContentCategoriesInsertCall) Context(ctx context.Context) *ContentCategoriesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ContentCategoriesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.contentcategory)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/contentCategories")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.contentCategories.insert" call.
-// Exactly one of *ContentCategory or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ContentCategory.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ContentCategoriesInsertCall) Do() (*ContentCategory, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ContentCategory{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new content category.",
- // "httpMethod": "POST",
- // "id": "dfareporting.contentCategories.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/contentCategories",
- // "request": {
- // "$ref": "ContentCategory"
- // },
- // "response": {
- // "$ref": "ContentCategory"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.contentCategories.list":
-
-type ContentCategoriesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of content categories, possibly filtered.
-func (r *ContentCategoriesService) List(profileId int64) *ContentCategoriesListCall {
- c := &ContentCategoriesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only content categories
-// with these IDs.
-func (c *ContentCategoriesListCall) Ids(ids int64) *ContentCategoriesListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *ContentCategoriesListCall) MaxResults(maxResults int64) *ContentCategoriesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *ContentCategoriesListCall) PageToken(pageToken string) *ContentCategoriesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name or ID. Wildcards (*) are allowed. For
-// example, "contentcategory*2015" will return objects with names like
-// "contentcategory June 2015", "contentcategory April 2015", or simply
-// "contentcategory 2015". Most of the searches also add wildcards
-// implicitly at the start and the end of the search string. For
-// example, a search string of "contentcategory" will match objects with
-// name "my contentcategory", "contentcategory 2015", or simply
-// "contentcategory".
-func (c *ContentCategoriesListCall) SearchString(searchString string) *ContentCategoriesListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *ContentCategoriesListCall) SortField(sortField string) *ContentCategoriesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *ContentCategoriesListCall) SortOrder(sortOrder string) *ContentCategoriesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ContentCategoriesListCall) Fields(s ...googleapi.Field) *ContentCategoriesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ContentCategoriesListCall) IfNoneMatch(entityTag string) *ContentCategoriesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ContentCategoriesListCall) Context(ctx context.Context) *ContentCategoriesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ContentCategoriesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/contentCategories")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.contentCategories.list" call.
-// Exactly one of *ContentCategoriesListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *ContentCategoriesListResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ContentCategoriesListCall) Do() (*ContentCategoriesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ContentCategoriesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of content categories, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.contentCategories.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "ids": {
- // "description": "Select only content categories with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"contentcategory*2015\" will return objects with names like \"contentcategory June 2015\", \"contentcategory April 2015\", or simply \"contentcategory 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"contentcategory\" will match objects with name \"my contentcategory\", \"contentcategory 2015\", or simply \"contentcategory\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/contentCategories",
- // "response": {
- // "$ref": "ContentCategoriesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.contentCategories.patch":
-
-type ContentCategoriesPatchCall struct {
- s *Service
- profileId int64
- id int64
- contentcategory *ContentCategory
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing content category. This method supports
-// patch semantics.
-func (r *ContentCategoriesService) Patch(profileId int64, id int64, contentcategory *ContentCategory) *ContentCategoriesPatchCall {
- c := &ContentCategoriesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.contentcategory = contentcategory
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ContentCategoriesPatchCall) Fields(s ...googleapi.Field) *ContentCategoriesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ContentCategoriesPatchCall) Context(ctx context.Context) *ContentCategoriesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ContentCategoriesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.contentcategory)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/contentCategories")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.contentCategories.patch" call.
-// Exactly one of *ContentCategory or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ContentCategory.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ContentCategoriesPatchCall) Do() (*ContentCategory, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ContentCategory{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing content category. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.contentCategories.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Content category ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/contentCategories",
- // "request": {
- // "$ref": "ContentCategory"
- // },
- // "response": {
- // "$ref": "ContentCategory"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.contentCategories.update":
-
-type ContentCategoriesUpdateCall struct {
- s *Service
- profileId int64
- contentcategory *ContentCategory
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing content category.
-func (r *ContentCategoriesService) Update(profileId int64, contentcategory *ContentCategory) *ContentCategoriesUpdateCall {
- c := &ContentCategoriesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.contentcategory = contentcategory
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ContentCategoriesUpdateCall) Fields(s ...googleapi.Field) *ContentCategoriesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ContentCategoriesUpdateCall) Context(ctx context.Context) *ContentCategoriesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ContentCategoriesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.contentcategory)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/contentCategories")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.contentCategories.update" call.
-// Exactly one of *ContentCategory or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ContentCategory.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ContentCategoriesUpdateCall) Do() (*ContentCategory, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ContentCategory{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing content category.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.contentCategories.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/contentCategories",
- // "request": {
- // "$ref": "ContentCategory"
- // },
- // "response": {
- // "$ref": "ContentCategory"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.countries.get":
-
-type CountriesGetCall struct {
- s *Service
- profileId int64
- dartId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one country by ID.
-func (r *CountriesService) Get(profileId int64, dartId int64) *CountriesGetCall {
- c := &CountriesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.dartId = dartId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CountriesGetCall) Fields(s ...googleapi.Field) *CountriesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CountriesGetCall) IfNoneMatch(entityTag string) *CountriesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CountriesGetCall) Context(ctx context.Context) *CountriesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CountriesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/countries/{dartId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "dartId": strconv.FormatInt(c.dartId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.countries.get" call.
-// Exactly one of *Country or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Country.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *CountriesGetCall) Do() (*Country, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Country{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one country by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.countries.get",
- // "parameterOrder": [
- // "profileId",
- // "dartId"
- // ],
- // "parameters": {
- // "dartId": {
- // "description": "Country DART ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/countries/{dartId}",
- // "response": {
- // "$ref": "Country"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.countries.list":
-
-type CountriesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of countries.
-func (r *CountriesService) List(profileId int64) *CountriesListCall {
- c := &CountriesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CountriesListCall) Fields(s ...googleapi.Field) *CountriesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CountriesListCall) IfNoneMatch(entityTag string) *CountriesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CountriesListCall) Context(ctx context.Context) *CountriesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CountriesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/countries")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.countries.list" call.
-// Exactly one of *CountriesListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CountriesListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CountriesListCall) Do() (*CountriesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CountriesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of countries.",
- // "httpMethod": "GET",
- // "id": "dfareporting.countries.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/countries",
- // "response": {
- // "$ref": "CountriesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeAssets.insert":
-
-type CreativeAssetsInsertCall struct {
- s *Service
- profileId int64
- advertiserId int64
- creativeassetmetadata *CreativeAssetMetadata
- opt_ map[string]interface{}
- media_ io.Reader
- resumable_ googleapi.SizeReaderAt
- mediaType_ string
- protocol_ string
- ctx_ context.Context
-}
-
-// Insert: Inserts a new creative asset.
-func (r *CreativeAssetsService) Insert(profileId int64, advertiserId int64, creativeassetmetadata *CreativeAssetMetadata) *CreativeAssetsInsertCall {
- c := &CreativeAssetsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.advertiserId = advertiserId
- c.creativeassetmetadata = creativeassetmetadata
- return c
-}
-
-// Media specifies the media to upload in a single chunk.
-// At most one of Media and ResumableMedia may be set.
-func (c *CreativeAssetsInsertCall) Media(r io.Reader) *CreativeAssetsInsertCall {
- c.media_ = r
- c.protocol_ = "multipart"
- return c
-}
-
-// ResumableMedia specifies the media to upload in chunks and can be canceled with ctx.
-// At most one of Media and ResumableMedia may be set.
-// mediaType identifies the MIME media type of the upload, such as "image/png".
-// If mediaType is "", it will be auto-detected.
-// The provided ctx will supersede any context previously provided to
-// the Context method.
-func (c *CreativeAssetsInsertCall) ResumableMedia(ctx context.Context, r io.ReaderAt, size int64, mediaType string) *CreativeAssetsInsertCall {
- c.ctx_ = ctx
- c.resumable_ = io.NewSectionReader(r, 0, size)
- c.mediaType_ = mediaType
- c.protocol_ = "resumable"
- return c
-}
-
-// ProgressUpdater provides a callback function that will be called after every chunk.
-// It should be a low-latency function in order to not slow down the upload operation.
-// This should only be called when using ResumableMedia (as opposed to Media).
-func (c *CreativeAssetsInsertCall) ProgressUpdater(pu googleapi.ProgressUpdater) *CreativeAssetsInsertCall {
- c.opt_["progressUpdater"] = pu
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeAssetsInsertCall) Fields(s ...googleapi.Field) *CreativeAssetsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-// This context will supersede any context previously provided to
-// the ResumableMedia method.
-func (c *CreativeAssetsInsertCall) Context(ctx context.Context) *CreativeAssetsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeAssetsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creativeassetmetadata)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets")
- if c.media_ != nil || c.resumable_ != nil {
- urls = strings.Replace(urls, "https://www.googleapis.com/", "https://www.googleapis.com/upload/", 1)
- params.Set("uploadType", c.protocol_)
- }
- urls += "?" + params.Encode()
- if c.protocol_ != "resumable" {
- var cancel func()
- cancel, _ = googleapi.ConditionallyIncludeMedia(c.media_, &body, &ctype)
- if cancel != nil {
- defer cancel()
- }
- }
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "advertiserId": strconv.FormatInt(c.advertiserId, 10),
- })
- if c.protocol_ == "resumable" {
- if c.mediaType_ == "" {
- c.mediaType_ = googleapi.DetectMediaType(c.resumable_)
- }
- req.Header.Set("X-Upload-Content-Type", c.mediaType_)
- req.Header.Set("Content-Type", "application/json; charset=utf-8")
- } else {
- req.Header.Set("Content-Type", ctype)
- }
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeAssets.insert" call.
-// Exactly one of *CreativeAssetMetadata or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CreativeAssetMetadata.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeAssetsInsertCall) Do() (*CreativeAssetMetadata, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- var progressUpdater_ googleapi.ProgressUpdater
- if v, ok := c.opt_["progressUpdater"]; ok {
- if pu, ok := v.(googleapi.ProgressUpdater); ok {
- progressUpdater_ = pu
- }
- }
- if c.protocol_ == "resumable" {
- loc := res.Header.Get("Location")
- rx := &googleapi.ResumableUpload{
- Client: c.s.client,
- UserAgent: c.s.userAgent(),
- URI: loc,
- Media: c.resumable_,
- MediaType: c.mediaType_,
- ContentLength: c.resumable_.Size(),
- Callback: progressUpdater_,
- }
- res, err = rx.Upload(c.ctx_)
- if err != nil {
- return nil, err
- }
- defer res.Body.Close()
- }
- ret := &CreativeAssetMetadata{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new creative asset.",
- // "httpMethod": "POST",
- // "id": "dfareporting.creativeAssets.insert",
- // "mediaUpload": {
- // "accept": [
- // "*/*"
- // ],
- // "maxSize": "100MB",
- // "protocols": {
- // "resumable": {
- // "multipart": true,
- // "path": "/resumable/upload/dfareporting/v2.1/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets"
- // },
- // "simple": {
- // "multipart": true,
- // "path": "/upload/dfareporting/v2.1/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets"
- // }
- // }
- // },
- // "parameterOrder": [
- // "profileId",
- // "advertiserId"
- // ],
- // "parameters": {
- // "advertiserId": {
- // "description": "Advertiser ID of this creative. This is a required field.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets",
- // "request": {
- // "$ref": "CreativeAssetMetadata"
- // },
- // "response": {
- // "$ref": "CreativeAssetMetadata"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ],
- // "supportsMediaUpload": true
- // }
-
-}
-
-// method id "dfareporting.creativeFieldValues.delete":
-
-type CreativeFieldValuesDeleteCall struct {
- s *Service
- profileId int64
- creativeFieldId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an existing creative field value.
-func (r *CreativeFieldValuesService) Delete(profileId int64, creativeFieldId int64, id int64) *CreativeFieldValuesDeleteCall {
- c := &CreativeFieldValuesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.creativeFieldId = creativeFieldId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeFieldValuesDeleteCall) Fields(s ...googleapi.Field) *CreativeFieldValuesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeFieldValuesDeleteCall) Context(ctx context.Context) *CreativeFieldValuesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeFieldValuesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "creativeFieldId": strconv.FormatInt(c.creativeFieldId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeFieldValues.delete" call.
-func (c *CreativeFieldValuesDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes an existing creative field value.",
- // "httpMethod": "DELETE",
- // "id": "dfareporting.creativeFieldValues.delete",
- // "parameterOrder": [
- // "profileId",
- // "creativeFieldId",
- // "id"
- // ],
- // "parameters": {
- // "creativeFieldId": {
- // "description": "Creative field ID for this creative field value.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "id": {
- // "description": "Creative Field Value ID",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeFieldValues.get":
-
-type CreativeFieldValuesGetCall struct {
- s *Service
- profileId int64
- creativeFieldId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one creative field value by ID.
-func (r *CreativeFieldValuesService) Get(profileId int64, creativeFieldId int64, id int64) *CreativeFieldValuesGetCall {
- c := &CreativeFieldValuesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.creativeFieldId = creativeFieldId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeFieldValuesGetCall) Fields(s ...googleapi.Field) *CreativeFieldValuesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CreativeFieldValuesGetCall) IfNoneMatch(entityTag string) *CreativeFieldValuesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeFieldValuesGetCall) Context(ctx context.Context) *CreativeFieldValuesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeFieldValuesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "creativeFieldId": strconv.FormatInt(c.creativeFieldId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeFieldValues.get" call.
-// Exactly one of *CreativeFieldValue or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CreativeFieldValue.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeFieldValuesGetCall) Do() (*CreativeFieldValue, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeFieldValue{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one creative field value by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.creativeFieldValues.get",
- // "parameterOrder": [
- // "profileId",
- // "creativeFieldId",
- // "id"
- // ],
- // "parameters": {
- // "creativeFieldId": {
- // "description": "Creative field ID for this creative field value.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "id": {
- // "description": "Creative Field Value ID",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
- // "response": {
- // "$ref": "CreativeFieldValue"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeFieldValues.insert":
-
-type CreativeFieldValuesInsertCall struct {
- s *Service
- profileId int64
- creativeFieldId int64
- creativefieldvalue *CreativeFieldValue
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new creative field value.
-func (r *CreativeFieldValuesService) Insert(profileId int64, creativeFieldId int64, creativefieldvalue *CreativeFieldValue) *CreativeFieldValuesInsertCall {
- c := &CreativeFieldValuesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.creativeFieldId = creativeFieldId
- c.creativefieldvalue = creativefieldvalue
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeFieldValuesInsertCall) Fields(s ...googleapi.Field) *CreativeFieldValuesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeFieldValuesInsertCall) Context(ctx context.Context) *CreativeFieldValuesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeFieldValuesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creativefieldvalue)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "creativeFieldId": strconv.FormatInt(c.creativeFieldId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeFieldValues.insert" call.
-// Exactly one of *CreativeFieldValue or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CreativeFieldValue.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeFieldValuesInsertCall) Do() (*CreativeFieldValue, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeFieldValue{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new creative field value.",
- // "httpMethod": "POST",
- // "id": "dfareporting.creativeFieldValues.insert",
- // "parameterOrder": [
- // "profileId",
- // "creativeFieldId"
- // ],
- // "parameters": {
- // "creativeFieldId": {
- // "description": "Creative field ID for this creative field value.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- // "request": {
- // "$ref": "CreativeFieldValue"
- // },
- // "response": {
- // "$ref": "CreativeFieldValue"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeFieldValues.list":
-
-type CreativeFieldValuesListCall struct {
- s *Service
- profileId int64
- creativeFieldId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of creative field values, possibly filtered.
-func (r *CreativeFieldValuesService) List(profileId int64, creativeFieldId int64) *CreativeFieldValuesListCall {
- c := &CreativeFieldValuesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.creativeFieldId = creativeFieldId
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only creative field
-// values with these IDs.
-func (c *CreativeFieldValuesListCall) Ids(ids int64) *CreativeFieldValuesListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *CreativeFieldValuesListCall) MaxResults(maxResults int64) *CreativeFieldValuesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *CreativeFieldValuesListCall) PageToken(pageToken string) *CreativeFieldValuesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for creative field values by their values. Wildcards (e.g.
-// *) are not allowed.
-func (c *CreativeFieldValuesListCall) SearchString(searchString string) *CreativeFieldValuesListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "VALUE"
-func (c *CreativeFieldValuesListCall) SortField(sortField string) *CreativeFieldValuesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *CreativeFieldValuesListCall) SortOrder(sortOrder string) *CreativeFieldValuesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeFieldValuesListCall) Fields(s ...googleapi.Field) *CreativeFieldValuesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CreativeFieldValuesListCall) IfNoneMatch(entityTag string) *CreativeFieldValuesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeFieldValuesListCall) Context(ctx context.Context) *CreativeFieldValuesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeFieldValuesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "creativeFieldId": strconv.FormatInt(c.creativeFieldId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeFieldValues.list" call.
-// Exactly one of *CreativeFieldValuesListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *CreativeFieldValuesListResponse.ServerResponse.Header or (if
-// a response was returned at all) in error.(*googleapi.Error).Header.
-// Use googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeFieldValuesListCall) Do() (*CreativeFieldValuesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeFieldValuesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of creative field values, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.creativeFieldValues.list",
- // "parameterOrder": [
- // "profileId",
- // "creativeFieldId"
- // ],
- // "parameters": {
- // "creativeFieldId": {
- // "description": "Creative field ID for this creative field value.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only creative field values with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "VALUE"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- // "response": {
- // "$ref": "CreativeFieldValuesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeFieldValues.patch":
-
-type CreativeFieldValuesPatchCall struct {
- s *Service
- profileId int64
- creativeFieldId int64
- id int64
- creativefieldvalue *CreativeFieldValue
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing creative field value. This method supports
-// patch semantics.
-func (r *CreativeFieldValuesService) Patch(profileId int64, creativeFieldId int64, id int64, creativefieldvalue *CreativeFieldValue) *CreativeFieldValuesPatchCall {
- c := &CreativeFieldValuesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.creativeFieldId = creativeFieldId
- c.id = id
- c.creativefieldvalue = creativefieldvalue
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeFieldValuesPatchCall) Fields(s ...googleapi.Field) *CreativeFieldValuesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeFieldValuesPatchCall) Context(ctx context.Context) *CreativeFieldValuesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeFieldValuesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creativefieldvalue)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "creativeFieldId": strconv.FormatInt(c.creativeFieldId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeFieldValues.patch" call.
-// Exactly one of *CreativeFieldValue or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CreativeFieldValue.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeFieldValuesPatchCall) Do() (*CreativeFieldValue, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeFieldValue{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing creative field value. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.creativeFieldValues.patch",
- // "parameterOrder": [
- // "profileId",
- // "creativeFieldId",
- // "id"
- // ],
- // "parameters": {
- // "creativeFieldId": {
- // "description": "Creative field ID for this creative field value.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "id": {
- // "description": "Creative Field Value ID",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- // "request": {
- // "$ref": "CreativeFieldValue"
- // },
- // "response": {
- // "$ref": "CreativeFieldValue"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeFieldValues.update":
-
-type CreativeFieldValuesUpdateCall struct {
- s *Service
- profileId int64
- creativeFieldId int64
- creativefieldvalue *CreativeFieldValue
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing creative field value.
-func (r *CreativeFieldValuesService) Update(profileId int64, creativeFieldId int64, creativefieldvalue *CreativeFieldValue) *CreativeFieldValuesUpdateCall {
- c := &CreativeFieldValuesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.creativeFieldId = creativeFieldId
- c.creativefieldvalue = creativefieldvalue
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeFieldValuesUpdateCall) Fields(s ...googleapi.Field) *CreativeFieldValuesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeFieldValuesUpdateCall) Context(ctx context.Context) *CreativeFieldValuesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeFieldValuesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creativefieldvalue)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "creativeFieldId": strconv.FormatInt(c.creativeFieldId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeFieldValues.update" call.
-// Exactly one of *CreativeFieldValue or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CreativeFieldValue.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeFieldValuesUpdateCall) Do() (*CreativeFieldValue, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeFieldValue{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing creative field value.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.creativeFieldValues.update",
- // "parameterOrder": [
- // "profileId",
- // "creativeFieldId"
- // ],
- // "parameters": {
- // "creativeFieldId": {
- // "description": "Creative field ID for this creative field value.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- // "request": {
- // "$ref": "CreativeFieldValue"
- // },
- // "response": {
- // "$ref": "CreativeFieldValue"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeFields.delete":
-
-type CreativeFieldsDeleteCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an existing creative field.
-func (r *CreativeFieldsService) Delete(profileId int64, id int64) *CreativeFieldsDeleteCall {
- c := &CreativeFieldsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeFieldsDeleteCall) Fields(s ...googleapi.Field) *CreativeFieldsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeFieldsDeleteCall) Context(ctx context.Context) *CreativeFieldsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeFieldsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeFields/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeFields.delete" call.
-func (c *CreativeFieldsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes an existing creative field.",
- // "httpMethod": "DELETE",
- // "id": "dfareporting.creativeFields.delete",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Creative Field ID",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeFields/{id}",
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeFields.get":
-
-type CreativeFieldsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one creative field by ID.
-func (r *CreativeFieldsService) Get(profileId int64, id int64) *CreativeFieldsGetCall {
- c := &CreativeFieldsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeFieldsGetCall) Fields(s ...googleapi.Field) *CreativeFieldsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CreativeFieldsGetCall) IfNoneMatch(entityTag string) *CreativeFieldsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeFieldsGetCall) Context(ctx context.Context) *CreativeFieldsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeFieldsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeFields/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeFields.get" call.
-// Exactly one of *CreativeField or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CreativeField.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeFieldsGetCall) Do() (*CreativeField, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeField{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one creative field by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.creativeFields.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Creative Field ID",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeFields/{id}",
- // "response": {
- // "$ref": "CreativeField"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeFields.insert":
-
-type CreativeFieldsInsertCall struct {
- s *Service
- profileId int64
- creativefield *CreativeField
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new creative field.
-func (r *CreativeFieldsService) Insert(profileId int64, creativefield *CreativeField) *CreativeFieldsInsertCall {
- c := &CreativeFieldsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.creativefield = creativefield
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeFieldsInsertCall) Fields(s ...googleapi.Field) *CreativeFieldsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeFieldsInsertCall) Context(ctx context.Context) *CreativeFieldsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeFieldsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creativefield)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeFields")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeFields.insert" call.
-// Exactly one of *CreativeField or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CreativeField.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeFieldsInsertCall) Do() (*CreativeField, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeField{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new creative field.",
- // "httpMethod": "POST",
- // "id": "dfareporting.creativeFields.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeFields",
- // "request": {
- // "$ref": "CreativeField"
- // },
- // "response": {
- // "$ref": "CreativeField"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeFields.list":
-
-type CreativeFieldsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of creative fields, possibly filtered.
-func (r *CreativeFieldsService) List(profileId int64) *CreativeFieldsListCall {
- c := &CreativeFieldsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// AdvertiserIds sets the optional parameter "advertiserIds": Select
-// only creative fields that belong to these advertisers.
-func (c *CreativeFieldsListCall) AdvertiserIds(advertiserIds int64) *CreativeFieldsListCall {
- c.opt_["advertiserIds"] = advertiserIds
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only creative fields
-// with these IDs.
-func (c *CreativeFieldsListCall) Ids(ids int64) *CreativeFieldsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *CreativeFieldsListCall) MaxResults(maxResults int64) *CreativeFieldsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *CreativeFieldsListCall) PageToken(pageToken string) *CreativeFieldsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for creative fields by name or ID. Wildcards (*) are
-// allowed. For example, "creativefield*2015" will return creative
-// fields with names like "creativefield June 2015", "creativefield
-// April 2015", or simply "creativefield 2015". Most of the searches
-// also add wild-cards implicitly at the start and the end of the search
-// string. For example, a search string of "creativefield" will match
-// creative fields with the name "my creativefield", "creativefield
-// 2015", or simply "creativefield".
-func (c *CreativeFieldsListCall) SearchString(searchString string) *CreativeFieldsListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *CreativeFieldsListCall) SortField(sortField string) *CreativeFieldsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *CreativeFieldsListCall) SortOrder(sortOrder string) *CreativeFieldsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeFieldsListCall) Fields(s ...googleapi.Field) *CreativeFieldsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CreativeFieldsListCall) IfNoneMatch(entityTag string) *CreativeFieldsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeFieldsListCall) Context(ctx context.Context) *CreativeFieldsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeFieldsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["advertiserIds"]; ok {
- params.Set("advertiserIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeFields")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeFields.list" call.
-// Exactly one of *CreativeFieldsListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *CreativeFieldsListResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeFieldsListCall) Do() (*CreativeFieldsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeFieldsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of creative fields, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.creativeFields.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "advertiserIds": {
- // "description": "Select only creative fields that belong to these advertisers.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only creative fields with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, \"creativefield*2015\" will return creative fields with names like \"creativefield June 2015\", \"creativefield April 2015\", or simply \"creativefield 2015\". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of \"creativefield\" will match creative fields with the name \"my creativefield\", \"creativefield 2015\", or simply \"creativefield\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeFields",
- // "response": {
- // "$ref": "CreativeFieldsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeFields.patch":
-
-type CreativeFieldsPatchCall struct {
- s *Service
- profileId int64
- id int64
- creativefield *CreativeField
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing creative field. This method supports patch
-// semantics.
-func (r *CreativeFieldsService) Patch(profileId int64, id int64, creativefield *CreativeField) *CreativeFieldsPatchCall {
- c := &CreativeFieldsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.creativefield = creativefield
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeFieldsPatchCall) Fields(s ...googleapi.Field) *CreativeFieldsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeFieldsPatchCall) Context(ctx context.Context) *CreativeFieldsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeFieldsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creativefield)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeFields")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeFields.patch" call.
-// Exactly one of *CreativeField or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CreativeField.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeFieldsPatchCall) Do() (*CreativeField, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeField{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing creative field. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.creativeFields.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Creative Field ID",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeFields",
- // "request": {
- // "$ref": "CreativeField"
- // },
- // "response": {
- // "$ref": "CreativeField"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeFields.update":
-
-type CreativeFieldsUpdateCall struct {
- s *Service
- profileId int64
- creativefield *CreativeField
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing creative field.
-func (r *CreativeFieldsService) Update(profileId int64, creativefield *CreativeField) *CreativeFieldsUpdateCall {
- c := &CreativeFieldsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.creativefield = creativefield
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeFieldsUpdateCall) Fields(s ...googleapi.Field) *CreativeFieldsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeFieldsUpdateCall) Context(ctx context.Context) *CreativeFieldsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeFieldsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creativefield)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeFields")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeFields.update" call.
-// Exactly one of *CreativeField or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CreativeField.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeFieldsUpdateCall) Do() (*CreativeField, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeField{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing creative field.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.creativeFields.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeFields",
- // "request": {
- // "$ref": "CreativeField"
- // },
- // "response": {
- // "$ref": "CreativeField"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeGroups.get":
-
-type CreativeGroupsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one creative group by ID.
-func (r *CreativeGroupsService) Get(profileId int64, id int64) *CreativeGroupsGetCall {
- c := &CreativeGroupsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeGroupsGetCall) Fields(s ...googleapi.Field) *CreativeGroupsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CreativeGroupsGetCall) IfNoneMatch(entityTag string) *CreativeGroupsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeGroupsGetCall) Context(ctx context.Context) *CreativeGroupsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeGroupsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeGroups/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeGroups.get" call.
-// Exactly one of *CreativeGroup or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CreativeGroup.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeGroupsGetCall) Do() (*CreativeGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one creative group by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.creativeGroups.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Creative group ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeGroups/{id}",
- // "response": {
- // "$ref": "CreativeGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeGroups.insert":
-
-type CreativeGroupsInsertCall struct {
- s *Service
- profileId int64
- creativegroup *CreativeGroup
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new creative group.
-func (r *CreativeGroupsService) Insert(profileId int64, creativegroup *CreativeGroup) *CreativeGroupsInsertCall {
- c := &CreativeGroupsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.creativegroup = creativegroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeGroupsInsertCall) Fields(s ...googleapi.Field) *CreativeGroupsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeGroupsInsertCall) Context(ctx context.Context) *CreativeGroupsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeGroupsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creativegroup)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeGroups.insert" call.
-// Exactly one of *CreativeGroup or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CreativeGroup.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeGroupsInsertCall) Do() (*CreativeGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new creative group.",
- // "httpMethod": "POST",
- // "id": "dfareporting.creativeGroups.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeGroups",
- // "request": {
- // "$ref": "CreativeGroup"
- // },
- // "response": {
- // "$ref": "CreativeGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeGroups.list":
-
-type CreativeGroupsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of creative groups, possibly filtered.
-func (r *CreativeGroupsService) List(profileId int64) *CreativeGroupsListCall {
- c := &CreativeGroupsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// AdvertiserIds sets the optional parameter "advertiserIds": Select
-// only creative groups that belong to these advertisers.
-func (c *CreativeGroupsListCall) AdvertiserIds(advertiserIds int64) *CreativeGroupsListCall {
- c.opt_["advertiserIds"] = advertiserIds
- return c
-}
-
-// GroupNumber sets the optional parameter "groupNumber": Select only
-// creative groups that belong to this subgroup.
-func (c *CreativeGroupsListCall) GroupNumber(groupNumber int64) *CreativeGroupsListCall {
- c.opt_["groupNumber"] = groupNumber
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only creative groups
-// with these IDs.
-func (c *CreativeGroupsListCall) Ids(ids int64) *CreativeGroupsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *CreativeGroupsListCall) MaxResults(maxResults int64) *CreativeGroupsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *CreativeGroupsListCall) PageToken(pageToken string) *CreativeGroupsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for creative groups by name or ID. Wildcards (*) are
-// allowed. For example, "creativegroup*2015" will return creative
-// groups with names like "creativegroup June 2015", "creativegroup
-// April 2015", or simply "creativegroup 2015". Most of the searches
-// also add wild-cards implicitly at the start and the end of the search
-// string. For example, a search string of "creativegroup" will match
-// creative groups with the name "my creativegroup", "creativegroup
-// 2015", or simply "creativegroup".
-func (c *CreativeGroupsListCall) SearchString(searchString string) *CreativeGroupsListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *CreativeGroupsListCall) SortField(sortField string) *CreativeGroupsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *CreativeGroupsListCall) SortOrder(sortOrder string) *CreativeGroupsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeGroupsListCall) Fields(s ...googleapi.Field) *CreativeGroupsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CreativeGroupsListCall) IfNoneMatch(entityTag string) *CreativeGroupsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeGroupsListCall) Context(ctx context.Context) *CreativeGroupsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeGroupsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["advertiserIds"]; ok {
- params.Set("advertiserIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["groupNumber"]; ok {
- params.Set("groupNumber", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeGroups.list" call.
-// Exactly one of *CreativeGroupsListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *CreativeGroupsListResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeGroupsListCall) Do() (*CreativeGroupsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeGroupsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of creative groups, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.creativeGroups.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "advertiserIds": {
- // "description": "Select only creative groups that belong to these advertisers.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "groupNumber": {
- // "description": "Select only creative groups that belong to this subgroup.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "ids": {
- // "description": "Select only creative groups with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, \"creativegroup*2015\" will return creative groups with names like \"creativegroup June 2015\", \"creativegroup April 2015\", or simply \"creativegroup 2015\". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of \"creativegroup\" will match creative groups with the name \"my creativegroup\", \"creativegroup 2015\", or simply \"creativegroup\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeGroups",
- // "response": {
- // "$ref": "CreativeGroupsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeGroups.patch":
-
-type CreativeGroupsPatchCall struct {
- s *Service
- profileId int64
- id int64
- creativegroup *CreativeGroup
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing creative group. This method supports patch
-// semantics.
-func (r *CreativeGroupsService) Patch(profileId int64, id int64, creativegroup *CreativeGroup) *CreativeGroupsPatchCall {
- c := &CreativeGroupsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.creativegroup = creativegroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeGroupsPatchCall) Fields(s ...googleapi.Field) *CreativeGroupsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeGroupsPatchCall) Context(ctx context.Context) *CreativeGroupsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeGroupsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creativegroup)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeGroups.patch" call.
-// Exactly one of *CreativeGroup or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CreativeGroup.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeGroupsPatchCall) Do() (*CreativeGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing creative group. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.creativeGroups.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Creative group ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeGroups",
- // "request": {
- // "$ref": "CreativeGroup"
- // },
- // "response": {
- // "$ref": "CreativeGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creativeGroups.update":
-
-type CreativeGroupsUpdateCall struct {
- s *Service
- profileId int64
- creativegroup *CreativeGroup
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing creative group.
-func (r *CreativeGroupsService) Update(profileId int64, creativegroup *CreativeGroup) *CreativeGroupsUpdateCall {
- c := &CreativeGroupsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.creativegroup = creativegroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativeGroupsUpdateCall) Fields(s ...googleapi.Field) *CreativeGroupsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativeGroupsUpdateCall) Context(ctx context.Context) *CreativeGroupsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativeGroupsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creativegroup)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creativeGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creativeGroups.update" call.
-// Exactly one of *CreativeGroup or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *CreativeGroup.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativeGroupsUpdateCall) Do() (*CreativeGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativeGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing creative group.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.creativeGroups.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creativeGroups",
- // "request": {
- // "$ref": "CreativeGroup"
- // },
- // "response": {
- // "$ref": "CreativeGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creatives.get":
-
-type CreativesGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one creative by ID.
-func (r *CreativesService) Get(profileId int64, id int64) *CreativesGetCall {
- c := &CreativesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativesGetCall) Fields(s ...googleapi.Field) *CreativesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CreativesGetCall) IfNoneMatch(entityTag string) *CreativesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativesGetCall) Context(ctx context.Context) *CreativesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creatives/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creatives.get" call.
-// Exactly one of *Creative or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Creative.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CreativesGetCall) Do() (*Creative, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Creative{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one creative by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.creatives.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Creative ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creatives/{id}",
- // "response": {
- // "$ref": "Creative"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creatives.insert":
-
-type CreativesInsertCall struct {
- s *Service
- profileId int64
- creative *Creative
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new creative.
-func (r *CreativesService) Insert(profileId int64, creative *Creative) *CreativesInsertCall {
- c := &CreativesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.creative = creative
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativesInsertCall) Fields(s ...googleapi.Field) *CreativesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativesInsertCall) Context(ctx context.Context) *CreativesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creative)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creatives")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creatives.insert" call.
-// Exactly one of *Creative or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Creative.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CreativesInsertCall) Do() (*Creative, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Creative{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new creative.",
- // "httpMethod": "POST",
- // "id": "dfareporting.creatives.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creatives",
- // "request": {
- // "$ref": "Creative"
- // },
- // "response": {
- // "$ref": "Creative"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creatives.list":
-
-type CreativesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of creatives, possibly filtered.
-func (r *CreativesService) List(profileId int64) *CreativesListCall {
- c := &CreativesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Active sets the optional parameter "active": Select only active
-// creatives. Leave blank to select active and inactive creatives.
-func (c *CreativesListCall) Active(active bool) *CreativesListCall {
- c.opt_["active"] = active
- return c
-}
-
-// AdvertiserId sets the optional parameter "advertiserId": Select only
-// creatives with this advertiser ID.
-func (c *CreativesListCall) AdvertiserId(advertiserId int64) *CreativesListCall {
- c.opt_["advertiserId"] = advertiserId
- return c
-}
-
-// Archived sets the optional parameter "archived": Select only archived
-// creatives. Leave blank to select archived and unarchived creatives.
-func (c *CreativesListCall) Archived(archived bool) *CreativesListCall {
- c.opt_["archived"] = archived
- return c
-}
-
-// CampaignId sets the optional parameter "campaignId": Select only
-// creatives with this campaign ID.
-func (c *CreativesListCall) CampaignId(campaignId int64) *CreativesListCall {
- c.opt_["campaignId"] = campaignId
- return c
-}
-
-// CompanionCreativeIds sets the optional parameter
-// "companionCreativeIds": Select only in-stream video creatives with
-// these companion IDs.
-func (c *CreativesListCall) CompanionCreativeIds(companionCreativeIds int64) *CreativesListCall {
- c.opt_["companionCreativeIds"] = companionCreativeIds
- return c
-}
-
-// CreativeFieldIds sets the optional parameter "creativeFieldIds":
-// Select only creatives with these creative field IDs.
-func (c *CreativesListCall) CreativeFieldIds(creativeFieldIds int64) *CreativesListCall {
- c.opt_["creativeFieldIds"] = creativeFieldIds
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only creatives with
-// these IDs.
-func (c *CreativesListCall) Ids(ids int64) *CreativesListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *CreativesListCall) MaxResults(maxResults int64) *CreativesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *CreativesListCall) PageToken(pageToken string) *CreativesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// RenderingIds sets the optional parameter "renderingIds": Select only
-// creatives with these rendering IDs.
-func (c *CreativesListCall) RenderingIds(renderingIds int64) *CreativesListCall {
- c.opt_["renderingIds"] = renderingIds
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name or ID. Wildcards (*) are allowed. For
-// example, "creative*2015" will return objects with names like
-// "creative June 2015", "creative April 2015", or simply "creative
-// 2015". Most of the searches also add wildcards implicitly at the
-// start and the end of the search string. For example, a search string
-// of "creative" will match objects with name "my creative", "creative
-// 2015", or simply "creative".
-func (c *CreativesListCall) SearchString(searchString string) *CreativesListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SizeIds sets the optional parameter "sizeIds": Select only creatives
-// with these size IDs.
-func (c *CreativesListCall) SizeIds(sizeIds int64) *CreativesListCall {
- c.opt_["sizeIds"] = sizeIds
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *CreativesListCall) SortField(sortField string) *CreativesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *CreativesListCall) SortOrder(sortOrder string) *CreativesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// StudioCreativeId sets the optional parameter "studioCreativeId":
-// Select only creatives corresponding to this Studio creative ID.
-func (c *CreativesListCall) StudioCreativeId(studioCreativeId int64) *CreativesListCall {
- c.opt_["studioCreativeId"] = studioCreativeId
- return c
-}
-
-// Types sets the optional parameter "types": Select only creatives with
-// these creative types.
-//
-// Possible values:
-// "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO"
-// "CUSTOM_INPAGE"
-// "CUSTOM_INTERSTITIAL"
-// "ENHANCED_BANNER"
-// "ENHANCED_IMAGE"
-// "FLASH_INPAGE"
-// "HTML5_BANNER"
-// "IMAGE"
-// "INSTREAM_VIDEO"
-// "INTERNAL_REDIRECT"
-// "INTERSTITIAL_INTERNAL_REDIRECT"
-// "REDIRECT"
-// "RICH_MEDIA_EXPANDING"
-// "RICH_MEDIA_IM_EXPAND"
-// "RICH_MEDIA_INPAGE"
-// "RICH_MEDIA_INPAGE_FLOATING"
-// "RICH_MEDIA_INTERSTITIAL_FLOAT"
-// "RICH_MEDIA_MOBILE_IN_APP"
-// "RICH_MEDIA_MULTI_FLOATING"
-// "RICH_MEDIA_PEEL_DOWN"
-// "TRACKING_TEXT"
-// "VAST_REDIRECT"
-// "VPAID_LINEAR"
-// "VPAID_NON_LINEAR"
-func (c *CreativesListCall) Types(types string) *CreativesListCall {
- c.opt_["types"] = types
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativesListCall) Fields(s ...googleapi.Field) *CreativesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *CreativesListCall) IfNoneMatch(entityTag string) *CreativesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativesListCall) Context(ctx context.Context) *CreativesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["active"]; ok {
- params.Set("active", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["advertiserId"]; ok {
- params.Set("advertiserId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["archived"]; ok {
- params.Set("archived", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["campaignId"]; ok {
- params.Set("campaignId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["companionCreativeIds"]; ok {
- params.Set("companionCreativeIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["creativeFieldIds"]; ok {
- params.Set("creativeFieldIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["renderingIds"]; ok {
- params.Set("renderingIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sizeIds"]; ok {
- params.Set("sizeIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["studioCreativeId"]; ok {
- params.Set("studioCreativeId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["types"]; ok {
- params.Set("types", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creatives")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creatives.list" call.
-// Exactly one of *CreativesListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CreativesListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *CreativesListCall) Do() (*CreativesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CreativesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of creatives, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.creatives.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "active": {
- // "description": "Select only active creatives. Leave blank to select active and inactive creatives.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "advertiserId": {
- // "description": "Select only creatives with this advertiser ID.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "archived": {
- // "description": "Select only archived creatives. Leave blank to select archived and unarchived creatives.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "campaignId": {
- // "description": "Select only creatives with this campaign ID.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "companionCreativeIds": {
- // "description": "Select only in-stream video creatives with these companion IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "creativeFieldIds": {
- // "description": "Select only creatives with these creative field IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only creatives with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "renderingIds": {
- // "description": "Select only creatives with these rendering IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"creative*2015\" will return objects with names like \"creative June 2015\", \"creative April 2015\", or simply \"creative 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"creative\" will match objects with name \"my creative\", \"creative 2015\", or simply \"creative\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sizeIds": {
- // "description": "Select only creatives with these size IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "studioCreativeId": {
- // "description": "Select only creatives corresponding to this Studio creative ID.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "types": {
- // "description": "Select only creatives with these creative types.",
- // "enum": [
- // "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO",
- // "CUSTOM_INPAGE",
- // "CUSTOM_INTERSTITIAL",
- // "ENHANCED_BANNER",
- // "ENHANCED_IMAGE",
- // "FLASH_INPAGE",
- // "HTML5_BANNER",
- // "IMAGE",
- // "INSTREAM_VIDEO",
- // "INTERNAL_REDIRECT",
- // "INTERSTITIAL_INTERNAL_REDIRECT",
- // "REDIRECT",
- // "RICH_MEDIA_EXPANDING",
- // "RICH_MEDIA_IM_EXPAND",
- // "RICH_MEDIA_INPAGE",
- // "RICH_MEDIA_INPAGE_FLOATING",
- // "RICH_MEDIA_INTERSTITIAL_FLOAT",
- // "RICH_MEDIA_MOBILE_IN_APP",
- // "RICH_MEDIA_MULTI_FLOATING",
- // "RICH_MEDIA_PEEL_DOWN",
- // "TRACKING_TEXT",
- // "VAST_REDIRECT",
- // "VPAID_LINEAR",
- // "VPAID_NON_LINEAR"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creatives",
- // "response": {
- // "$ref": "CreativesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creatives.patch":
-
-type CreativesPatchCall struct {
- s *Service
- profileId int64
- id int64
- creative *Creative
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing creative. This method supports patch
-// semantics.
-func (r *CreativesService) Patch(profileId int64, id int64, creative *Creative) *CreativesPatchCall {
- c := &CreativesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.creative = creative
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativesPatchCall) Fields(s ...googleapi.Field) *CreativesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativesPatchCall) Context(ctx context.Context) *CreativesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creative)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creatives")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creatives.patch" call.
-// Exactly one of *Creative or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Creative.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CreativesPatchCall) Do() (*Creative, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Creative{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing creative. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.creatives.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Creative ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creatives",
- // "request": {
- // "$ref": "Creative"
- // },
- // "response": {
- // "$ref": "Creative"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.creatives.update":
-
-type CreativesUpdateCall struct {
- s *Service
- profileId int64
- creative *Creative
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing creative.
-func (r *CreativesService) Update(profileId int64, creative *Creative) *CreativesUpdateCall {
- c := &CreativesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.creative = creative
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *CreativesUpdateCall) Fields(s ...googleapi.Field) *CreativesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *CreativesUpdateCall) Context(ctx context.Context) *CreativesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *CreativesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.creative)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/creatives")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.creatives.update" call.
-// Exactly one of *Creative or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Creative.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *CreativesUpdateCall) Do() (*Creative, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Creative{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing creative.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.creatives.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/creatives",
- // "request": {
- // "$ref": "Creative"
- // },
- // "response": {
- // "$ref": "Creative"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.dimensionValues.query":
-
-type DimensionValuesQueryCall struct {
- s *Service
- profileId int64
- dimensionvaluerequest *DimensionValueRequest
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Query: Retrieves list of report dimension values for a list of
-// filters.
-func (r *DimensionValuesService) Query(profileId int64, dimensionvaluerequest *DimensionValueRequest) *DimensionValuesQueryCall {
- c := &DimensionValuesQueryCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.dimensionvaluerequest = dimensionvaluerequest
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *DimensionValuesQueryCall) MaxResults(maxResults int64) *DimensionValuesQueryCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous result page.
-func (c *DimensionValuesQueryCall) PageToken(pageToken string) *DimensionValuesQueryCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DimensionValuesQueryCall) Fields(s ...googleapi.Field) *DimensionValuesQueryCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DimensionValuesQueryCall) Context(ctx context.Context) *DimensionValuesQueryCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DimensionValuesQueryCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.dimensionvaluerequest)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/dimensionvalues/query")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.dimensionValues.query" call.
-// Exactly one of *DimensionValueList or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *DimensionValueList.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DimensionValuesQueryCall) Do() (*DimensionValueList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DimensionValueList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves list of report dimension values for a list of filters.",
- // "httpMethod": "POST",
- // "id": "dfareporting.dimensionValues.query",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "100",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/dimensionvalues/query",
- // "request": {
- // "$ref": "DimensionValueRequest"
- // },
- // "response": {
- // "$ref": "DimensionValueList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.directorySiteContacts.get":
-
-type DirectorySiteContactsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one directory site contact by ID.
-func (r *DirectorySiteContactsService) Get(profileId int64, id int64) *DirectorySiteContactsGetCall {
- c := &DirectorySiteContactsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DirectorySiteContactsGetCall) Fields(s ...googleapi.Field) *DirectorySiteContactsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DirectorySiteContactsGetCall) IfNoneMatch(entityTag string) *DirectorySiteContactsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DirectorySiteContactsGetCall) Context(ctx context.Context) *DirectorySiteContactsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DirectorySiteContactsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/directorySiteContacts/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.directorySiteContacts.get" call.
-// Exactly one of *DirectorySiteContact or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *DirectorySiteContact.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DirectorySiteContactsGetCall) Do() (*DirectorySiteContact, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DirectorySiteContact{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one directory site contact by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.directorySiteContacts.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Directory site contact ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/directorySiteContacts/{id}",
- // "response": {
- // "$ref": "DirectorySiteContact"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.directorySiteContacts.list":
-
-type DirectorySiteContactsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of directory site contacts, possibly filtered.
-func (r *DirectorySiteContactsService) List(profileId int64) *DirectorySiteContactsListCall {
- c := &DirectorySiteContactsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// DirectorySiteIds sets the optional parameter "directorySiteIds":
-// Select only directory site contacts with these directory site IDs.
-// This is a required field.
-func (c *DirectorySiteContactsListCall) DirectorySiteIds(directorySiteIds int64) *DirectorySiteContactsListCall {
- c.opt_["directorySiteIds"] = directorySiteIds
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only directory site
-// contacts with these IDs.
-func (c *DirectorySiteContactsListCall) Ids(ids int64) *DirectorySiteContactsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *DirectorySiteContactsListCall) MaxResults(maxResults int64) *DirectorySiteContactsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *DirectorySiteContactsListCall) PageToken(pageToken string) *DirectorySiteContactsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name, ID or email. Wildcards (*) are
-// allowed. For example, "directory site contact*2015" will return
-// objects with names like "directory site contact June 2015",
-// "directory site contact April 2015", or simply "directory site
-// contact 2015". Most of the searches also add wildcards implicitly at
-// the start and the end of the search string. For example, a search
-// string of "directory site contact" will match objects with name "my
-// directory site contact", "directory site contact 2015", or simply
-// "directory site contact".
-func (c *DirectorySiteContactsListCall) SearchString(searchString string) *DirectorySiteContactsListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *DirectorySiteContactsListCall) SortField(sortField string) *DirectorySiteContactsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *DirectorySiteContactsListCall) SortOrder(sortOrder string) *DirectorySiteContactsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DirectorySiteContactsListCall) Fields(s ...googleapi.Field) *DirectorySiteContactsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DirectorySiteContactsListCall) IfNoneMatch(entityTag string) *DirectorySiteContactsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DirectorySiteContactsListCall) Context(ctx context.Context) *DirectorySiteContactsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DirectorySiteContactsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["directorySiteIds"]; ok {
- params.Set("directorySiteIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/directorySiteContacts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.directorySiteContacts.list" call.
-// Exactly one of *DirectorySiteContactsListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *DirectorySiteContactsListResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *DirectorySiteContactsListCall) Do() (*DirectorySiteContactsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DirectorySiteContactsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of directory site contacts, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.directorySiteContacts.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "directorySiteIds": {
- // "description": "Select only directory site contacts with these directory site IDs. This is a required field.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only directory site contacts with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, \"directory site contact*2015\" will return objects with names like \"directory site contact June 2015\", \"directory site contact April 2015\", or simply \"directory site contact 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"directory site contact\" will match objects with name \"my directory site contact\", \"directory site contact 2015\", or simply \"directory site contact\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/directorySiteContacts",
- // "response": {
- // "$ref": "DirectorySiteContactsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.directorySites.get":
-
-type DirectorySitesGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one directory site by ID.
-func (r *DirectorySitesService) Get(profileId int64, id int64) *DirectorySitesGetCall {
- c := &DirectorySitesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DirectorySitesGetCall) Fields(s ...googleapi.Field) *DirectorySitesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DirectorySitesGetCall) IfNoneMatch(entityTag string) *DirectorySitesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DirectorySitesGetCall) Context(ctx context.Context) *DirectorySitesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DirectorySitesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/directorySites/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.directorySites.get" call.
-// Exactly one of *DirectorySite or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *DirectorySite.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DirectorySitesGetCall) Do() (*DirectorySite, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DirectorySite{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one directory site by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.directorySites.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Directory site ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/directorySites/{id}",
- // "response": {
- // "$ref": "DirectorySite"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.directorySites.insert":
-
-type DirectorySitesInsertCall struct {
- s *Service
- profileId int64
- directorysite *DirectorySite
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new directory site.
-func (r *DirectorySitesService) Insert(profileId int64, directorysite *DirectorySite) *DirectorySitesInsertCall {
- c := &DirectorySitesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.directorysite = directorysite
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DirectorySitesInsertCall) Fields(s ...googleapi.Field) *DirectorySitesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DirectorySitesInsertCall) Context(ctx context.Context) *DirectorySitesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DirectorySitesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.directorysite)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/directorySites")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.directorySites.insert" call.
-// Exactly one of *DirectorySite or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *DirectorySite.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DirectorySitesInsertCall) Do() (*DirectorySite, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DirectorySite{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new directory site.",
- // "httpMethod": "POST",
- // "id": "dfareporting.directorySites.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/directorySites",
- // "request": {
- // "$ref": "DirectorySite"
- // },
- // "response": {
- // "$ref": "DirectorySite"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.directorySites.list":
-
-type DirectorySitesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of directory sites, possibly filtered.
-func (r *DirectorySitesService) List(profileId int64) *DirectorySitesListCall {
- c := &DirectorySitesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// AcceptsInStreamVideoPlacements sets the optional parameter
-// "acceptsInStreamVideoPlacements": This search filter is no longer
-// supported and will have no effect on the results returned.
-func (c *DirectorySitesListCall) AcceptsInStreamVideoPlacements(acceptsInStreamVideoPlacements bool) *DirectorySitesListCall {
- c.opt_["acceptsInStreamVideoPlacements"] = acceptsInStreamVideoPlacements
- return c
-}
-
-// AcceptsInterstitialPlacements sets the optional parameter
-// "acceptsInterstitialPlacements": This search filter is no longer
-// supported and will have no effect on the results returned.
-func (c *DirectorySitesListCall) AcceptsInterstitialPlacements(acceptsInterstitialPlacements bool) *DirectorySitesListCall {
- c.opt_["acceptsInterstitialPlacements"] = acceptsInterstitialPlacements
- return c
-}
-
-// AcceptsPublisherPaidPlacements sets the optional parameter
-// "acceptsPublisherPaidPlacements": Select only directory sites that
-// accept publisher paid placements. This field can be left blank.
-func (c *DirectorySitesListCall) AcceptsPublisherPaidPlacements(acceptsPublisherPaidPlacements bool) *DirectorySitesListCall {
- c.opt_["acceptsPublisherPaidPlacements"] = acceptsPublisherPaidPlacements
- return c
-}
-
-// Active sets the optional parameter "active": Select only active
-// directory sites. Leave blank to retrieve both active and inactive
-// directory sites.
-func (c *DirectorySitesListCall) Active(active bool) *DirectorySitesListCall {
- c.opt_["active"] = active
- return c
-}
-
-// CountryId sets the optional parameter "countryId": Select only
-// directory sites with this country ID.
-func (c *DirectorySitesListCall) CountryId(countryId int64) *DirectorySitesListCall {
- c.opt_["countryId"] = countryId
- return c
-}
-
-// DfpNetworkCode sets the optional parameter "dfp_network_code": Select
-// only directory sites with this DFP network code.
-func (c *DirectorySitesListCall) DfpNetworkCode(dfpNetworkCode string) *DirectorySitesListCall {
- c.opt_["dfp_network_code"] = dfpNetworkCode
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only directory sites
-// with these IDs.
-func (c *DirectorySitesListCall) Ids(ids int64) *DirectorySitesListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *DirectorySitesListCall) MaxResults(maxResults int64) *DirectorySitesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *DirectorySitesListCall) PageToken(pageToken string) *DirectorySitesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// ParentId sets the optional parameter "parentId": Select only
-// directory sites with this parent ID.
-func (c *DirectorySitesListCall) ParentId(parentId int64) *DirectorySitesListCall {
- c.opt_["parentId"] = parentId
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name, ID or URL. Wildcards (*) are allowed.
-// For example, "directory site*2015" will return objects with names
-// like "directory site June 2015", "directory site April 2015", or
-// simply "directory site 2015". Most of the searches also add wildcards
-// implicitly at the start and the end of the search string. For
-// example, a search string of "directory site" will match objects with
-// name "my directory site", "directory site 2015" or simply, "directory
-// site".
-func (c *DirectorySitesListCall) SearchString(searchString string) *DirectorySitesListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *DirectorySitesListCall) SortField(sortField string) *DirectorySitesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *DirectorySitesListCall) SortOrder(sortOrder string) *DirectorySitesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *DirectorySitesListCall) Fields(s ...googleapi.Field) *DirectorySitesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *DirectorySitesListCall) IfNoneMatch(entityTag string) *DirectorySitesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *DirectorySitesListCall) Context(ctx context.Context) *DirectorySitesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *DirectorySitesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["acceptsInStreamVideoPlacements"]; ok {
- params.Set("acceptsInStreamVideoPlacements", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["acceptsInterstitialPlacements"]; ok {
- params.Set("acceptsInterstitialPlacements", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["acceptsPublisherPaidPlacements"]; ok {
- params.Set("acceptsPublisherPaidPlacements", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["active"]; ok {
- params.Set("active", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["countryId"]; ok {
- params.Set("countryId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["dfp_network_code"]; ok {
- params.Set("dfp_network_code", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["parentId"]; ok {
- params.Set("parentId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/directorySites")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.directorySites.list" call.
-// Exactly one of *DirectorySitesListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *DirectorySitesListResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *DirectorySitesListCall) Do() (*DirectorySitesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &DirectorySitesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of directory sites, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.directorySites.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "acceptsInStreamVideoPlacements": {
- // "description": "This search filter is no longer supported and will have no effect on the results returned.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "acceptsInterstitialPlacements": {
- // "description": "This search filter is no longer supported and will have no effect on the results returned.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "acceptsPublisherPaidPlacements": {
- // "description": "Select only directory sites that accept publisher paid placements. This field can be left blank.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "active": {
- // "description": "Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "countryId": {
- // "description": "Select only directory sites with this country ID.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "dfp_network_code": {
- // "description": "Select only directory sites with this DFP network code.",
- // "location": "query",
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only directory sites with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "parentId": {
- // "description": "Select only directory sites with this parent ID.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, \"directory site*2015\" will return objects with names like \"directory site June 2015\", \"directory site April 2015\", or simply \"directory site 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"directory site\" will match objects with name \"my directory site\", \"directory site 2015\" or simply, \"directory site\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/directorySites",
- // "response": {
- // "$ref": "DirectorySitesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.eventTags.delete":
-
-type EventTagsDeleteCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an existing event tag.
-func (r *EventTagsService) Delete(profileId int64, id int64) *EventTagsDeleteCall {
- c := &EventTagsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EventTagsDeleteCall) Fields(s ...googleapi.Field) *EventTagsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EventTagsDeleteCall) Context(ctx context.Context) *EventTagsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EventTagsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/eventTags/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.eventTags.delete" call.
-func (c *EventTagsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes an existing event tag.",
- // "httpMethod": "DELETE",
- // "id": "dfareporting.eventTags.delete",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Event tag ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/eventTags/{id}",
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.eventTags.get":
-
-type EventTagsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one event tag by ID.
-func (r *EventTagsService) Get(profileId int64, id int64) *EventTagsGetCall {
- c := &EventTagsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EventTagsGetCall) Fields(s ...googleapi.Field) *EventTagsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *EventTagsGetCall) IfNoneMatch(entityTag string) *EventTagsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EventTagsGetCall) Context(ctx context.Context) *EventTagsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EventTagsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/eventTags/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.eventTags.get" call.
-// Exactly one of *EventTag or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *EventTag.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *EventTagsGetCall) Do() (*EventTag, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EventTag{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one event tag by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.eventTags.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Event tag ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/eventTags/{id}",
- // "response": {
- // "$ref": "EventTag"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.eventTags.insert":
-
-type EventTagsInsertCall struct {
- s *Service
- profileId int64
- eventtag *EventTag
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new event tag.
-func (r *EventTagsService) Insert(profileId int64, eventtag *EventTag) *EventTagsInsertCall {
- c := &EventTagsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.eventtag = eventtag
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EventTagsInsertCall) Fields(s ...googleapi.Field) *EventTagsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EventTagsInsertCall) Context(ctx context.Context) *EventTagsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EventTagsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.eventtag)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/eventTags")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.eventTags.insert" call.
-// Exactly one of *EventTag or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *EventTag.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *EventTagsInsertCall) Do() (*EventTag, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EventTag{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new event tag.",
- // "httpMethod": "POST",
- // "id": "dfareporting.eventTags.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/eventTags",
- // "request": {
- // "$ref": "EventTag"
- // },
- // "response": {
- // "$ref": "EventTag"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.eventTags.list":
-
-type EventTagsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of event tags, possibly filtered.
-func (r *EventTagsService) List(profileId int64) *EventTagsListCall {
- c := &EventTagsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// AdId sets the optional parameter "adId": Select only event tags that
-// belong to this ad.
-func (c *EventTagsListCall) AdId(adId int64) *EventTagsListCall {
- c.opt_["adId"] = adId
- return c
-}
-
-// AdvertiserId sets the optional parameter "advertiserId": Select only
-// event tags that belong to this advertiser.
-func (c *EventTagsListCall) AdvertiserId(advertiserId int64) *EventTagsListCall {
- c.opt_["advertiserId"] = advertiserId
- return c
-}
-
-// CampaignId sets the optional parameter "campaignId": Select only
-// event tags that belong to this campaign.
-func (c *EventTagsListCall) CampaignId(campaignId int64) *EventTagsListCall {
- c.opt_["campaignId"] = campaignId
- return c
-}
-
-// DefinitionsOnly sets the optional parameter "definitionsOnly":
-// Examine only the specified campaign or advertiser's event tags for
-// matching selector criteria. When set to false, the parent advertiser
-// and parent campaign of the specified ad or campaign is examined as
-// well. In addition, when set to false, the status field is examined as
-// well, along with the enabledByDefault field. This parameter can not
-// be set to true when adId is specified as ads do not define their own
-// even tags.
-func (c *EventTagsListCall) DefinitionsOnly(definitionsOnly bool) *EventTagsListCall {
- c.opt_["definitionsOnly"] = definitionsOnly
- return c
-}
-
-// Enabled sets the optional parameter "enabled": Select only enabled
-// event tags. What is considered enabled or disabled depends on the
-// definitionsOnly parameter. When definitionsOnly is set to true, only
-// the specified advertiser or campaign's event tags' enabledByDefault
-// field is examined. When definitionsOnly is set to false, the
-// specified ad or specified campaign's parent advertiser's or parent
-// campaign's event tags' enabledByDefault and status fields are
-// examined as well.
-func (c *EventTagsListCall) Enabled(enabled bool) *EventTagsListCall {
- c.opt_["enabled"] = enabled
- return c
-}
-
-// EventTagTypes sets the optional parameter "eventTagTypes": Select
-// only event tags with the specified event tag types. Event tag types
-// can be used to specify whether to use a third-party pixel, a
-// third-party JavaScript URL, or a third-party click-through URL for
-// either impression or click tracking.
-//
-// Possible values:
-// "CLICK_THROUGH_EVENT_TAG"
-// "IMPRESSION_IMAGE_EVENT_TAG"
-// "IMPRESSION_JAVASCRIPT_EVENT_TAG"
-func (c *EventTagsListCall) EventTagTypes(eventTagTypes string) *EventTagsListCall {
- c.opt_["eventTagTypes"] = eventTagTypes
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only event tags with
-// these IDs.
-func (c *EventTagsListCall) Ids(ids int64) *EventTagsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name or ID. Wildcards (*) are allowed. For
-// example, "eventtag*2015" will return objects with names like
-// "eventtag June 2015", "eventtag April 2015", or simply "eventtag
-// 2015". Most of the searches also add wildcards implicitly at the
-// start and the end of the search string. For example, a search string
-// of "eventtag" will match objects with name "my eventtag", "eventtag
-// 2015", or simply "eventtag".
-func (c *EventTagsListCall) SearchString(searchString string) *EventTagsListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *EventTagsListCall) SortField(sortField string) *EventTagsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *EventTagsListCall) SortOrder(sortOrder string) *EventTagsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EventTagsListCall) Fields(s ...googleapi.Field) *EventTagsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *EventTagsListCall) IfNoneMatch(entityTag string) *EventTagsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EventTagsListCall) Context(ctx context.Context) *EventTagsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EventTagsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["adId"]; ok {
- params.Set("adId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["advertiserId"]; ok {
- params.Set("advertiserId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["campaignId"]; ok {
- params.Set("campaignId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["definitionsOnly"]; ok {
- params.Set("definitionsOnly", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["enabled"]; ok {
- params.Set("enabled", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["eventTagTypes"]; ok {
- params.Set("eventTagTypes", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/eventTags")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.eventTags.list" call.
-// Exactly one of *EventTagsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *EventTagsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *EventTagsListCall) Do() (*EventTagsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EventTagsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of event tags, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.eventTags.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "adId": {
- // "description": "Select only event tags that belong to this ad.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "advertiserId": {
- // "description": "Select only event tags that belong to this advertiser.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "campaignId": {
- // "description": "Select only event tags that belong to this campaign.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "definitionsOnly": {
- // "description": "Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "enabled": {
- // "description": "Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "eventTagTypes": {
- // "description": "Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking.",
- // "enum": [
- // "CLICK_THROUGH_EVENT_TAG",
- // "IMPRESSION_IMAGE_EVENT_TAG",
- // "IMPRESSION_JAVASCRIPT_EVENT_TAG"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only event tags with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"eventtag*2015\" will return objects with names like \"eventtag June 2015\", \"eventtag April 2015\", or simply \"eventtag 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"eventtag\" will match objects with name \"my eventtag\", \"eventtag 2015\", or simply \"eventtag\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/eventTags",
- // "response": {
- // "$ref": "EventTagsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.eventTags.patch":
-
-type EventTagsPatchCall struct {
- s *Service
- profileId int64
- id int64
- eventtag *EventTag
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing event tag. This method supports patch
-// semantics.
-func (r *EventTagsService) Patch(profileId int64, id int64, eventtag *EventTag) *EventTagsPatchCall {
- c := &EventTagsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.eventtag = eventtag
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EventTagsPatchCall) Fields(s ...googleapi.Field) *EventTagsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EventTagsPatchCall) Context(ctx context.Context) *EventTagsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EventTagsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.eventtag)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/eventTags")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.eventTags.patch" call.
-// Exactly one of *EventTag or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *EventTag.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *EventTagsPatchCall) Do() (*EventTag, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EventTag{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing event tag. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.eventTags.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Event tag ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/eventTags",
- // "request": {
- // "$ref": "EventTag"
- // },
- // "response": {
- // "$ref": "EventTag"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.eventTags.update":
-
-type EventTagsUpdateCall struct {
- s *Service
- profileId int64
- eventtag *EventTag
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing event tag.
-func (r *EventTagsService) Update(profileId int64, eventtag *EventTag) *EventTagsUpdateCall {
- c := &EventTagsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.eventtag = eventtag
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *EventTagsUpdateCall) Fields(s ...googleapi.Field) *EventTagsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *EventTagsUpdateCall) Context(ctx context.Context) *EventTagsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *EventTagsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.eventtag)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/eventTags")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.eventTags.update" call.
-// Exactly one of *EventTag or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *EventTag.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *EventTagsUpdateCall) Do() (*EventTag, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &EventTag{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing event tag.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.eventTags.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/eventTags",
- // "request": {
- // "$ref": "EventTag"
- // },
- // "response": {
- // "$ref": "EventTag"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.files.get":
-
-type FilesGetCall struct {
- s *Service
- reportId int64
- fileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves a report file by its report ID and file ID.
-func (r *FilesService) Get(reportId int64, fileId int64) *FilesGetCall {
- c := &FilesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.reportId = reportId
- c.fileId = fileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FilesGetCall) Fields(s ...googleapi.Field) *FilesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *FilesGetCall) IfNoneMatch(entityTag string) *FilesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do and Download methods.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FilesGetCall) Context(ctx context.Context) *FilesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FilesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "reports/{reportId}/files/{fileId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "reportId": strconv.FormatInt(c.reportId, 10),
- "fileId": strconv.FormatInt(c.fileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Download fetches the API endpoint's "media" value, instead of the normal
-// API response value. If the returned error is nil, the Response is guaranteed to
-// have a 2xx status code. Callers must close the Response.Body as usual.
-func (c *FilesGetCall) Download() (*http.Response, error) {
- res, err := c.doRequest("media")
- if err != nil {
- return nil, err
- }
- if err := googleapi.CheckMediaResponse(res); err != nil {
- res.Body.Close()
- return nil, err
- }
- return res, nil
-}
-
-// Do executes the "dfareporting.files.get" call.
-// Exactly one of *File or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *File.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *FilesGetCall) Do() (*File, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &File{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a report file by its report ID and file ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.files.get",
- // "parameterOrder": [
- // "reportId",
- // "fileId"
- // ],
- // "parameters": {
- // "fileId": {
- // "description": "The ID of the report file.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "reports/{reportId}/files/{fileId}",
- // "response": {
- // "$ref": "File"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ],
- // "supportsMediaDownload": true
- // }
-
-}
-
-// method id "dfareporting.files.list":
-
-type FilesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists files for a user profile.
-func (r *FilesService) List(profileId int64) *FilesListCall {
- c := &FilesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *FilesListCall) MaxResults(maxResults int64) *FilesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous result page.
-func (c *FilesListCall) PageToken(pageToken string) *FilesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Scope sets the optional parameter "scope": The scope that defines
-// which results are returned, default is 'MINE'.
-//
-// Possible values:
-// "ALL" - All files in account.
-// "MINE" (default) - My files.
-// "SHARED_WITH_ME" - Files shared with me.
-func (c *FilesListCall) Scope(scope string) *FilesListCall {
- c.opt_["scope"] = scope
- return c
-}
-
-// SortField sets the optional parameter "sortField": The field by which
-// to sort the list.
-//
-// Possible values:
-// "ID" - Sort by file ID.
-// "LAST_MODIFIED_TIME" (default) - Sort by 'lastmodifiedAt' field.
-func (c *FilesListCall) SortField(sortField string) *FilesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is 'DESCENDING'.
-//
-// Possible values:
-// "ASCENDING" - Ascending order.
-// "DESCENDING" (default) - Descending order.
-func (c *FilesListCall) SortOrder(sortOrder string) *FilesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FilesListCall) Fields(s ...googleapi.Field) *FilesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *FilesListCall) IfNoneMatch(entityTag string) *FilesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FilesListCall) Context(ctx context.Context) *FilesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FilesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["scope"]; ok {
- params.Set("scope", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/files")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.files.list" call.
-// Exactly one of *FileList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *FileList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *FilesListCall) Do() (*FileList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FileList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists files for a user profile.",
- // "httpMethod": "GET",
- // "id": "dfareporting.files.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "scope": {
- // "default": "MINE",
- // "description": "The scope that defines which results are returned, default is 'MINE'.",
- // "enum": [
- // "ALL",
- // "MINE",
- // "SHARED_WITH_ME"
- // ],
- // "enumDescriptions": [
- // "All files in account.",
- // "My files.",
- // "Files shared with me."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "default": "LAST_MODIFIED_TIME",
- // "description": "The field by which to sort the list.",
- // "enum": [
- // "ID",
- // "LAST_MODIFIED_TIME"
- // ],
- // "enumDescriptions": [
- // "Sort by file ID.",
- // "Sort by 'lastmodifiedAt' field."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "default": "DESCENDING",
- // "description": "Order of sorted results, default is 'DESCENDING'.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "Ascending order.",
- // "Descending order."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/files",
- // "response": {
- // "$ref": "FileList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightActivities.delete":
-
-type FloodlightActivitiesDeleteCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an existing floodlight activity.
-func (r *FloodlightActivitiesService) Delete(profileId int64, id int64) *FloodlightActivitiesDeleteCall {
- c := &FloodlightActivitiesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightActivitiesDeleteCall) Fields(s ...googleapi.Field) *FloodlightActivitiesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightActivitiesDeleteCall) Context(ctx context.Context) *FloodlightActivitiesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightActivitiesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightActivities/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightActivities.delete" call.
-func (c *FloodlightActivitiesDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes an existing floodlight activity.",
- // "httpMethod": "DELETE",
- // "id": "dfareporting.floodlightActivities.delete",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Floodlight activity ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightActivities/{id}",
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightActivities.generatetag":
-
-type FloodlightActivitiesGeneratetagCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Generatetag: Generates a tag for a floodlight activity.
-func (r *FloodlightActivitiesService) Generatetag(profileId int64) *FloodlightActivitiesGeneratetagCall {
- c := &FloodlightActivitiesGeneratetagCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// FloodlightActivityId sets the optional parameter
-// "floodlightActivityId": Floodlight activity ID for which we want to
-// generate a tag.
-func (c *FloodlightActivitiesGeneratetagCall) FloodlightActivityId(floodlightActivityId int64) *FloodlightActivitiesGeneratetagCall {
- c.opt_["floodlightActivityId"] = floodlightActivityId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightActivitiesGeneratetagCall) Fields(s ...googleapi.Field) *FloodlightActivitiesGeneratetagCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightActivitiesGeneratetagCall) Context(ctx context.Context) *FloodlightActivitiesGeneratetagCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightActivitiesGeneratetagCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["floodlightActivityId"]; ok {
- params.Set("floodlightActivityId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightActivities/generatetag")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightActivities.generatetag" call.
-// Exactly one of *FloodlightActivitiesGenerateTagResponse or error will
-// be non-nil. Any non-2xx status code is an error. Response headers are
-// in either
-// *FloodlightActivitiesGenerateTagResponse.ServerResponse.Header or (if
-// a response was returned at all) in error.(*googleapi.Error).Header.
-// Use googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *FloodlightActivitiesGeneratetagCall) Do() (*FloodlightActivitiesGenerateTagResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightActivitiesGenerateTagResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Generates a tag for a floodlight activity.",
- // "httpMethod": "POST",
- // "id": "dfareporting.floodlightActivities.generatetag",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "floodlightActivityId": {
- // "description": "Floodlight activity ID for which we want to generate a tag.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightActivities/generatetag",
- // "response": {
- // "$ref": "FloodlightActivitiesGenerateTagResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightActivities.get":
-
-type FloodlightActivitiesGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one floodlight activity by ID.
-func (r *FloodlightActivitiesService) Get(profileId int64, id int64) *FloodlightActivitiesGetCall {
- c := &FloodlightActivitiesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightActivitiesGetCall) Fields(s ...googleapi.Field) *FloodlightActivitiesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *FloodlightActivitiesGetCall) IfNoneMatch(entityTag string) *FloodlightActivitiesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightActivitiesGetCall) Context(ctx context.Context) *FloodlightActivitiesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightActivitiesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightActivities/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightActivities.get" call.
-// Exactly one of *FloodlightActivity or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *FloodlightActivity.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *FloodlightActivitiesGetCall) Do() (*FloodlightActivity, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightActivity{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one floodlight activity by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.floodlightActivities.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Floodlight activity ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightActivities/{id}",
- // "response": {
- // "$ref": "FloodlightActivity"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightActivities.insert":
-
-type FloodlightActivitiesInsertCall struct {
- s *Service
- profileId int64
- floodlightactivity *FloodlightActivity
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new floodlight activity.
-func (r *FloodlightActivitiesService) Insert(profileId int64, floodlightactivity *FloodlightActivity) *FloodlightActivitiesInsertCall {
- c := &FloodlightActivitiesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.floodlightactivity = floodlightactivity
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightActivitiesInsertCall) Fields(s ...googleapi.Field) *FloodlightActivitiesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightActivitiesInsertCall) Context(ctx context.Context) *FloodlightActivitiesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightActivitiesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.floodlightactivity)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightActivities")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightActivities.insert" call.
-// Exactly one of *FloodlightActivity or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *FloodlightActivity.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *FloodlightActivitiesInsertCall) Do() (*FloodlightActivity, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightActivity{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new floodlight activity.",
- // "httpMethod": "POST",
- // "id": "dfareporting.floodlightActivities.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightActivities",
- // "request": {
- // "$ref": "FloodlightActivity"
- // },
- // "response": {
- // "$ref": "FloodlightActivity"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightActivities.list":
-
-type FloodlightActivitiesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of floodlight activities, possibly filtered.
-func (r *FloodlightActivitiesService) List(profileId int64) *FloodlightActivitiesListCall {
- c := &FloodlightActivitiesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// AdvertiserId sets the optional parameter "advertiserId": Select only
-// floodlight activities for the specified advertiser ID. Must specify
-// either ids, advertiserId, or floodlightConfigurationId for a
-// non-empty result.
-func (c *FloodlightActivitiesListCall) AdvertiserId(advertiserId int64) *FloodlightActivitiesListCall {
- c.opt_["advertiserId"] = advertiserId
- return c
-}
-
-// FloodlightActivityGroupIds sets the optional parameter
-// "floodlightActivityGroupIds": Select only floodlight activities with
-// the specified floodlight activity group IDs.
-func (c *FloodlightActivitiesListCall) FloodlightActivityGroupIds(floodlightActivityGroupIds int64) *FloodlightActivitiesListCall {
- c.opt_["floodlightActivityGroupIds"] = floodlightActivityGroupIds
- return c
-}
-
-// FloodlightActivityGroupName sets the optional parameter
-// "floodlightActivityGroupName": Select only floodlight activities with
-// the specified floodlight activity group name.
-func (c *FloodlightActivitiesListCall) FloodlightActivityGroupName(floodlightActivityGroupName string) *FloodlightActivitiesListCall {
- c.opt_["floodlightActivityGroupName"] = floodlightActivityGroupName
- return c
-}
-
-// FloodlightActivityGroupTagString sets the optional parameter
-// "floodlightActivityGroupTagString": Select only floodlight activities
-// with the specified floodlight activity group tag string.
-func (c *FloodlightActivitiesListCall) FloodlightActivityGroupTagString(floodlightActivityGroupTagString string) *FloodlightActivitiesListCall {
- c.opt_["floodlightActivityGroupTagString"] = floodlightActivityGroupTagString
- return c
-}
-
-// FloodlightActivityGroupType sets the optional parameter
-// "floodlightActivityGroupType": Select only floodlight activities with
-// the specified floodlight activity group type.
-//
-// Possible values:
-// "COUNTER"
-// "SALE"
-func (c *FloodlightActivitiesListCall) FloodlightActivityGroupType(floodlightActivityGroupType string) *FloodlightActivitiesListCall {
- c.opt_["floodlightActivityGroupType"] = floodlightActivityGroupType
- return c
-}
-
-// FloodlightConfigurationId sets the optional parameter
-// "floodlightConfigurationId": Select only floodlight activities for
-// the specified floodlight configuration ID. Must specify either ids,
-// advertiserId, or floodlightConfigurationId for a non-empty result.
-func (c *FloodlightActivitiesListCall) FloodlightConfigurationId(floodlightConfigurationId int64) *FloodlightActivitiesListCall {
- c.opt_["floodlightConfigurationId"] = floodlightConfigurationId
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only floodlight
-// activities with the specified IDs. Must specify either ids,
-// advertiserId, or floodlightConfigurationId for a non-empty result.
-func (c *FloodlightActivitiesListCall) Ids(ids int64) *FloodlightActivitiesListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *FloodlightActivitiesListCall) MaxResults(maxResults int64) *FloodlightActivitiesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *FloodlightActivitiesListCall) PageToken(pageToken string) *FloodlightActivitiesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name or ID. Wildcards (*) are allowed. For
-// example, "floodlightactivity*2015" will return objects with names
-// like "floodlightactivity June 2015", "floodlightactivity April 2015",
-// or simply "floodlightactivity 2015". Most of the searches also add
-// wildcards implicitly at the start and the end of the search string.
-// For example, a search string of "floodlightactivity" will match
-// objects with name "my floodlightactivity activity",
-// "floodlightactivity 2015", or simply "floodlightactivity".
-func (c *FloodlightActivitiesListCall) SearchString(searchString string) *FloodlightActivitiesListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *FloodlightActivitiesListCall) SortField(sortField string) *FloodlightActivitiesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *FloodlightActivitiesListCall) SortOrder(sortOrder string) *FloodlightActivitiesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// TagString sets the optional parameter "tagString": Select only
-// floodlight activities with the specified tag string.
-func (c *FloodlightActivitiesListCall) TagString(tagString string) *FloodlightActivitiesListCall {
- c.opt_["tagString"] = tagString
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightActivitiesListCall) Fields(s ...googleapi.Field) *FloodlightActivitiesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *FloodlightActivitiesListCall) IfNoneMatch(entityTag string) *FloodlightActivitiesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightActivitiesListCall) Context(ctx context.Context) *FloodlightActivitiesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightActivitiesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["advertiserId"]; ok {
- params.Set("advertiserId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["floodlightActivityGroupIds"]; ok {
- params.Set("floodlightActivityGroupIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["floodlightActivityGroupName"]; ok {
- params.Set("floodlightActivityGroupName", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["floodlightActivityGroupTagString"]; ok {
- params.Set("floodlightActivityGroupTagString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["floodlightActivityGroupType"]; ok {
- params.Set("floodlightActivityGroupType", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["floodlightConfigurationId"]; ok {
- params.Set("floodlightConfigurationId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["tagString"]; ok {
- params.Set("tagString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightActivities")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightActivities.list" call.
-// Exactly one of *FloodlightActivitiesListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *FloodlightActivitiesListResponse.ServerResponse.Header or (if
-// a response was returned at all) in error.(*googleapi.Error).Header.
-// Use googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *FloodlightActivitiesListCall) Do() (*FloodlightActivitiesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightActivitiesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of floodlight activities, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.floodlightActivities.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "advertiserId": {
- // "description": "Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "floodlightActivityGroupIds": {
- // "description": "Select only floodlight activities with the specified floodlight activity group IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "floodlightActivityGroupName": {
- // "description": "Select only floodlight activities with the specified floodlight activity group name.",
- // "location": "query",
- // "type": "string"
- // },
- // "floodlightActivityGroupTagString": {
- // "description": "Select only floodlight activities with the specified floodlight activity group tag string.",
- // "location": "query",
- // "type": "string"
- // },
- // "floodlightActivityGroupType": {
- // "description": "Select only floodlight activities with the specified floodlight activity group type.",
- // "enum": [
- // "COUNTER",
- // "SALE"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "floodlightConfigurationId": {
- // "description": "Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"floodlightactivity*2015\" will return objects with names like \"floodlightactivity June 2015\", \"floodlightactivity April 2015\", or simply \"floodlightactivity 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"floodlightactivity\" will match objects with name \"my floodlightactivity activity\", \"floodlightactivity 2015\", or simply \"floodlightactivity\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "tagString": {
- // "description": "Select only floodlight activities with the specified tag string.",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightActivities",
- // "response": {
- // "$ref": "FloodlightActivitiesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightActivities.patch":
-
-type FloodlightActivitiesPatchCall struct {
- s *Service
- profileId int64
- id int64
- floodlightactivity *FloodlightActivity
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing floodlight activity. This method supports
-// patch semantics.
-func (r *FloodlightActivitiesService) Patch(profileId int64, id int64, floodlightactivity *FloodlightActivity) *FloodlightActivitiesPatchCall {
- c := &FloodlightActivitiesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.floodlightactivity = floodlightactivity
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightActivitiesPatchCall) Fields(s ...googleapi.Field) *FloodlightActivitiesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightActivitiesPatchCall) Context(ctx context.Context) *FloodlightActivitiesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightActivitiesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.floodlightactivity)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightActivities")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightActivities.patch" call.
-// Exactly one of *FloodlightActivity or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *FloodlightActivity.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *FloodlightActivitiesPatchCall) Do() (*FloodlightActivity, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightActivity{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing floodlight activity. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.floodlightActivities.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Floodlight activity ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightActivities",
- // "request": {
- // "$ref": "FloodlightActivity"
- // },
- // "response": {
- // "$ref": "FloodlightActivity"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightActivities.update":
-
-type FloodlightActivitiesUpdateCall struct {
- s *Service
- profileId int64
- floodlightactivity *FloodlightActivity
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing floodlight activity.
-func (r *FloodlightActivitiesService) Update(profileId int64, floodlightactivity *FloodlightActivity) *FloodlightActivitiesUpdateCall {
- c := &FloodlightActivitiesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.floodlightactivity = floodlightactivity
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightActivitiesUpdateCall) Fields(s ...googleapi.Field) *FloodlightActivitiesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightActivitiesUpdateCall) Context(ctx context.Context) *FloodlightActivitiesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightActivitiesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.floodlightactivity)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightActivities")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightActivities.update" call.
-// Exactly one of *FloodlightActivity or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *FloodlightActivity.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *FloodlightActivitiesUpdateCall) Do() (*FloodlightActivity, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightActivity{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing floodlight activity.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.floodlightActivities.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightActivities",
- // "request": {
- // "$ref": "FloodlightActivity"
- // },
- // "response": {
- // "$ref": "FloodlightActivity"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightActivityGroups.delete":
-
-type FloodlightActivityGroupsDeleteCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an existing floodlight activity group.
-func (r *FloodlightActivityGroupsService) Delete(profileId int64, id int64) *FloodlightActivityGroupsDeleteCall {
- c := &FloodlightActivityGroupsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightActivityGroupsDeleteCall) Fields(s ...googleapi.Field) *FloodlightActivityGroupsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightActivityGroupsDeleteCall) Context(ctx context.Context) *FloodlightActivityGroupsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightActivityGroupsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightActivityGroups/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightActivityGroups.delete" call.
-func (c *FloodlightActivityGroupsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes an existing floodlight activity group.",
- // "httpMethod": "DELETE",
- // "id": "dfareporting.floodlightActivityGroups.delete",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Floodlight activity Group ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightActivityGroups/{id}",
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightActivityGroups.get":
-
-type FloodlightActivityGroupsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one floodlight activity group by ID.
-func (r *FloodlightActivityGroupsService) Get(profileId int64, id int64) *FloodlightActivityGroupsGetCall {
- c := &FloodlightActivityGroupsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightActivityGroupsGetCall) Fields(s ...googleapi.Field) *FloodlightActivityGroupsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *FloodlightActivityGroupsGetCall) IfNoneMatch(entityTag string) *FloodlightActivityGroupsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightActivityGroupsGetCall) Context(ctx context.Context) *FloodlightActivityGroupsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightActivityGroupsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightActivityGroups/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightActivityGroups.get" call.
-// Exactly one of *FloodlightActivityGroup or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *FloodlightActivityGroup.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *FloodlightActivityGroupsGetCall) Do() (*FloodlightActivityGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightActivityGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one floodlight activity group by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.floodlightActivityGroups.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Floodlight activity Group ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightActivityGroups/{id}",
- // "response": {
- // "$ref": "FloodlightActivityGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightActivityGroups.insert":
-
-type FloodlightActivityGroupsInsertCall struct {
- s *Service
- profileId int64
- floodlightactivitygroup *FloodlightActivityGroup
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new floodlight activity group.
-func (r *FloodlightActivityGroupsService) Insert(profileId int64, floodlightactivitygroup *FloodlightActivityGroup) *FloodlightActivityGroupsInsertCall {
- c := &FloodlightActivityGroupsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.floodlightactivitygroup = floodlightactivitygroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightActivityGroupsInsertCall) Fields(s ...googleapi.Field) *FloodlightActivityGroupsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightActivityGroupsInsertCall) Context(ctx context.Context) *FloodlightActivityGroupsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightActivityGroupsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.floodlightactivitygroup)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightActivityGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightActivityGroups.insert" call.
-// Exactly one of *FloodlightActivityGroup or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *FloodlightActivityGroup.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *FloodlightActivityGroupsInsertCall) Do() (*FloodlightActivityGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightActivityGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new floodlight activity group.",
- // "httpMethod": "POST",
- // "id": "dfareporting.floodlightActivityGroups.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightActivityGroups",
- // "request": {
- // "$ref": "FloodlightActivityGroup"
- // },
- // "response": {
- // "$ref": "FloodlightActivityGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightActivityGroups.list":
-
-type FloodlightActivityGroupsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of floodlight activity groups, possibly
-// filtered.
-func (r *FloodlightActivityGroupsService) List(profileId int64) *FloodlightActivityGroupsListCall {
- c := &FloodlightActivityGroupsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// AdvertiserId sets the optional parameter "advertiserId": Select only
-// floodlight activity groups with the specified advertiser ID. Must
-// specify either advertiserId or floodlightConfigurationId for a
-// non-empty result.
-func (c *FloodlightActivityGroupsListCall) AdvertiserId(advertiserId int64) *FloodlightActivityGroupsListCall {
- c.opt_["advertiserId"] = advertiserId
- return c
-}
-
-// FloodlightConfigurationId sets the optional parameter
-// "floodlightConfigurationId": Select only floodlight activity groups
-// with the specified floodlight configuration ID. Must specify either
-// advertiserId, or floodlightConfigurationId for a non-empty result.
-func (c *FloodlightActivityGroupsListCall) FloodlightConfigurationId(floodlightConfigurationId int64) *FloodlightActivityGroupsListCall {
- c.opt_["floodlightConfigurationId"] = floodlightConfigurationId
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only floodlight
-// activity groups with the specified IDs. Must specify either
-// advertiserId or floodlightConfigurationId for a non-empty result.
-func (c *FloodlightActivityGroupsListCall) Ids(ids int64) *FloodlightActivityGroupsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *FloodlightActivityGroupsListCall) MaxResults(maxResults int64) *FloodlightActivityGroupsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *FloodlightActivityGroupsListCall) PageToken(pageToken string) *FloodlightActivityGroupsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name or ID. Wildcards (*) are allowed. For
-// example, "floodlightactivitygroup*2015" will return objects with
-// names like "floodlightactivitygroup June 2015",
-// "floodlightactivitygroup April 2015", or simply
-// "floodlightactivitygroup 2015". Most of the searches also add
-// wildcards implicitly at the start and the end of the search string.
-// For example, a search string of "floodlightactivitygroup" will match
-// objects with name "my floodlightactivitygroup activity",
-// "floodlightactivitygroup 2015", or simply "floodlightactivitygroup".
-func (c *FloodlightActivityGroupsListCall) SearchString(searchString string) *FloodlightActivityGroupsListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *FloodlightActivityGroupsListCall) SortField(sortField string) *FloodlightActivityGroupsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *FloodlightActivityGroupsListCall) SortOrder(sortOrder string) *FloodlightActivityGroupsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Type sets the optional parameter "type": Select only floodlight
-// activity groups with the specified floodlight activity group type.
-//
-// Possible values:
-// "COUNTER"
-// "SALE"
-func (c *FloodlightActivityGroupsListCall) Type(type_ string) *FloodlightActivityGroupsListCall {
- c.opt_["type"] = type_
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightActivityGroupsListCall) Fields(s ...googleapi.Field) *FloodlightActivityGroupsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *FloodlightActivityGroupsListCall) IfNoneMatch(entityTag string) *FloodlightActivityGroupsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightActivityGroupsListCall) Context(ctx context.Context) *FloodlightActivityGroupsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightActivityGroupsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["advertiserId"]; ok {
- params.Set("advertiserId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["floodlightConfigurationId"]; ok {
- params.Set("floodlightConfigurationId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["type"]; ok {
- params.Set("type", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightActivityGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightActivityGroups.list" call.
-// Exactly one of *FloodlightActivityGroupsListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *FloodlightActivityGroupsListResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *FloodlightActivityGroupsListCall) Do() (*FloodlightActivityGroupsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightActivityGroupsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of floodlight activity groups, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.floodlightActivityGroups.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "advertiserId": {
- // "description": "Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "floodlightConfigurationId": {
- // "description": "Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"floodlightactivitygroup*2015\" will return objects with names like \"floodlightactivitygroup June 2015\", \"floodlightactivitygroup April 2015\", or simply \"floodlightactivitygroup 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"floodlightactivitygroup\" will match objects with name \"my floodlightactivitygroup activity\", \"floodlightactivitygroup 2015\", or simply \"floodlightactivitygroup\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "type": {
- // "description": "Select only floodlight activity groups with the specified floodlight activity group type.",
- // "enum": [
- // "COUNTER",
- // "SALE"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightActivityGroups",
- // "response": {
- // "$ref": "FloodlightActivityGroupsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightActivityGroups.patch":
-
-type FloodlightActivityGroupsPatchCall struct {
- s *Service
- profileId int64
- id int64
- floodlightactivitygroup *FloodlightActivityGroup
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing floodlight activity group. This method
-// supports patch semantics.
-func (r *FloodlightActivityGroupsService) Patch(profileId int64, id int64, floodlightactivitygroup *FloodlightActivityGroup) *FloodlightActivityGroupsPatchCall {
- c := &FloodlightActivityGroupsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.floodlightactivitygroup = floodlightactivitygroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightActivityGroupsPatchCall) Fields(s ...googleapi.Field) *FloodlightActivityGroupsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightActivityGroupsPatchCall) Context(ctx context.Context) *FloodlightActivityGroupsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightActivityGroupsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.floodlightactivitygroup)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightActivityGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightActivityGroups.patch" call.
-// Exactly one of *FloodlightActivityGroup or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *FloodlightActivityGroup.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *FloodlightActivityGroupsPatchCall) Do() (*FloodlightActivityGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightActivityGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing floodlight activity group. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.floodlightActivityGroups.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Floodlight activity Group ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightActivityGroups",
- // "request": {
- // "$ref": "FloodlightActivityGroup"
- // },
- // "response": {
- // "$ref": "FloodlightActivityGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightActivityGroups.update":
-
-type FloodlightActivityGroupsUpdateCall struct {
- s *Service
- profileId int64
- floodlightactivitygroup *FloodlightActivityGroup
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing floodlight activity group.
-func (r *FloodlightActivityGroupsService) Update(profileId int64, floodlightactivitygroup *FloodlightActivityGroup) *FloodlightActivityGroupsUpdateCall {
- c := &FloodlightActivityGroupsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.floodlightactivitygroup = floodlightactivitygroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightActivityGroupsUpdateCall) Fields(s ...googleapi.Field) *FloodlightActivityGroupsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightActivityGroupsUpdateCall) Context(ctx context.Context) *FloodlightActivityGroupsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightActivityGroupsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.floodlightactivitygroup)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightActivityGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightActivityGroups.update" call.
-// Exactly one of *FloodlightActivityGroup or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *FloodlightActivityGroup.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *FloodlightActivityGroupsUpdateCall) Do() (*FloodlightActivityGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightActivityGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing floodlight activity group.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.floodlightActivityGroups.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightActivityGroups",
- // "request": {
- // "$ref": "FloodlightActivityGroup"
- // },
- // "response": {
- // "$ref": "FloodlightActivityGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightConfigurations.get":
-
-type FloodlightConfigurationsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one floodlight configuration by ID.
-func (r *FloodlightConfigurationsService) Get(profileId int64, id int64) *FloodlightConfigurationsGetCall {
- c := &FloodlightConfigurationsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightConfigurationsGetCall) Fields(s ...googleapi.Field) *FloodlightConfigurationsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *FloodlightConfigurationsGetCall) IfNoneMatch(entityTag string) *FloodlightConfigurationsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightConfigurationsGetCall) Context(ctx context.Context) *FloodlightConfigurationsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightConfigurationsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightConfigurations/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightConfigurations.get" call.
-// Exactly one of *FloodlightConfiguration or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *FloodlightConfiguration.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *FloodlightConfigurationsGetCall) Do() (*FloodlightConfiguration, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightConfiguration{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one floodlight configuration by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.floodlightConfigurations.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Floodlight configuration ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightConfigurations/{id}",
- // "response": {
- // "$ref": "FloodlightConfiguration"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightConfigurations.list":
-
-type FloodlightConfigurationsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of floodlight configurations, possibly
-// filtered.
-func (r *FloodlightConfigurationsService) List(profileId int64) *FloodlightConfigurationsListCall {
- c := &FloodlightConfigurationsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Ids sets the optional parameter "ids": Set of IDs of floodlight
-// configurations to retrieve. Required field; otherwise an empty list
-// will be returned.
-func (c *FloodlightConfigurationsListCall) Ids(ids int64) *FloodlightConfigurationsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightConfigurationsListCall) Fields(s ...googleapi.Field) *FloodlightConfigurationsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *FloodlightConfigurationsListCall) IfNoneMatch(entityTag string) *FloodlightConfigurationsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightConfigurationsListCall) Context(ctx context.Context) *FloodlightConfigurationsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightConfigurationsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightConfigurations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightConfigurations.list" call.
-// Exactly one of *FloodlightConfigurationsListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *FloodlightConfigurationsListResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *FloodlightConfigurationsListCall) Do() (*FloodlightConfigurationsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightConfigurationsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of floodlight configurations, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.floodlightConfigurations.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "ids": {
- // "description": "Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightConfigurations",
- // "response": {
- // "$ref": "FloodlightConfigurationsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightConfigurations.patch":
-
-type FloodlightConfigurationsPatchCall struct {
- s *Service
- profileId int64
- id int64
- floodlightconfiguration *FloodlightConfiguration
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing floodlight configuration. This method
-// supports patch semantics.
-func (r *FloodlightConfigurationsService) Patch(profileId int64, id int64, floodlightconfiguration *FloodlightConfiguration) *FloodlightConfigurationsPatchCall {
- c := &FloodlightConfigurationsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.floodlightconfiguration = floodlightconfiguration
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightConfigurationsPatchCall) Fields(s ...googleapi.Field) *FloodlightConfigurationsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightConfigurationsPatchCall) Context(ctx context.Context) *FloodlightConfigurationsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightConfigurationsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.floodlightconfiguration)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightConfigurations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightConfigurations.patch" call.
-// Exactly one of *FloodlightConfiguration or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *FloodlightConfiguration.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *FloodlightConfigurationsPatchCall) Do() (*FloodlightConfiguration, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightConfiguration{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing floodlight configuration. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.floodlightConfigurations.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Floodlight configuration ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightConfigurations",
- // "request": {
- // "$ref": "FloodlightConfiguration"
- // },
- // "response": {
- // "$ref": "FloodlightConfiguration"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.floodlightConfigurations.update":
-
-type FloodlightConfigurationsUpdateCall struct {
- s *Service
- profileId int64
- floodlightconfiguration *FloodlightConfiguration
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing floodlight configuration.
-func (r *FloodlightConfigurationsService) Update(profileId int64, floodlightconfiguration *FloodlightConfiguration) *FloodlightConfigurationsUpdateCall {
- c := &FloodlightConfigurationsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.floodlightconfiguration = floodlightconfiguration
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *FloodlightConfigurationsUpdateCall) Fields(s ...googleapi.Field) *FloodlightConfigurationsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *FloodlightConfigurationsUpdateCall) Context(ctx context.Context) *FloodlightConfigurationsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *FloodlightConfigurationsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.floodlightconfiguration)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/floodlightConfigurations")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.floodlightConfigurations.update" call.
-// Exactly one of *FloodlightConfiguration or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *FloodlightConfiguration.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *FloodlightConfigurationsUpdateCall) Do() (*FloodlightConfiguration, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FloodlightConfiguration{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing floodlight configuration.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.floodlightConfigurations.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/floodlightConfigurations",
- // "request": {
- // "$ref": "FloodlightConfiguration"
- // },
- // "response": {
- // "$ref": "FloodlightConfiguration"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.inventoryItems.get":
-
-type InventoryItemsGetCall struct {
- s *Service
- profileId int64
- projectId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one inventory item by ID.
-func (r *InventoryItemsService) Get(profileId int64, projectId int64, id int64) *InventoryItemsGetCall {
- c := &InventoryItemsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.projectId = projectId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InventoryItemsGetCall) Fields(s ...googleapi.Field) *InventoryItemsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InventoryItemsGetCall) IfNoneMatch(entityTag string) *InventoryItemsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InventoryItemsGetCall) Context(ctx context.Context) *InventoryItemsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InventoryItemsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "projectId": strconv.FormatInt(c.projectId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.inventoryItems.get" call.
-// Exactly one of *InventoryItem or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *InventoryItem.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InventoryItemsGetCall) Do() (*InventoryItem, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InventoryItem{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one inventory item by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.inventoryItems.get",
- // "parameterOrder": [
- // "profileId",
- // "projectId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Inventory item ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "Project ID for order documents.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}",
- // "response": {
- // "$ref": "InventoryItem"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.inventoryItems.list":
-
-type InventoryItemsListCall struct {
- s *Service
- profileId int64
- projectId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of inventory items, possibly filtered.
-func (r *InventoryItemsService) List(profileId int64, projectId int64) *InventoryItemsListCall {
- c := &InventoryItemsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.projectId = projectId
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only inventory items
-// with these IDs.
-func (c *InventoryItemsListCall) Ids(ids int64) *InventoryItemsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// InPlan sets the optional parameter "inPlan": Select only inventory
-// items that are in plan.
-func (c *InventoryItemsListCall) InPlan(inPlan bool) *InventoryItemsListCall {
- c.opt_["inPlan"] = inPlan
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *InventoryItemsListCall) MaxResults(maxResults int64) *InventoryItemsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderId sets the optional parameter "orderId": Select only inventory
-// items that belong to specified orders.
-func (c *InventoryItemsListCall) OrderId(orderId int64) *InventoryItemsListCall {
- c.opt_["orderId"] = orderId
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *InventoryItemsListCall) PageToken(pageToken string) *InventoryItemsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SiteId sets the optional parameter "siteId": Select only inventory
-// items that are associated with these sites.
-func (c *InventoryItemsListCall) SiteId(siteId int64) *InventoryItemsListCall {
- c.opt_["siteId"] = siteId
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *InventoryItemsListCall) SortField(sortField string) *InventoryItemsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *InventoryItemsListCall) SortOrder(sortOrder string) *InventoryItemsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *InventoryItemsListCall) Fields(s ...googleapi.Field) *InventoryItemsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *InventoryItemsListCall) IfNoneMatch(entityTag string) *InventoryItemsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *InventoryItemsListCall) Context(ctx context.Context) *InventoryItemsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *InventoryItemsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["inPlan"]; ok {
- params.Set("inPlan", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderId"]; ok {
- params.Set("orderId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["siteId"]; ok {
- params.Set("siteId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/projects/{projectId}/inventoryItems")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "projectId": strconv.FormatInt(c.projectId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.inventoryItems.list" call.
-// Exactly one of *InventoryItemsListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *InventoryItemsListResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *InventoryItemsListCall) Do() (*InventoryItemsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &InventoryItemsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of inventory items, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.inventoryItems.list",
- // "parameterOrder": [
- // "profileId",
- // "projectId"
- // ],
- // "parameters": {
- // "ids": {
- // "description": "Select only inventory items with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "inPlan": {
- // "description": "Select only inventory items that are in plan.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "orderId": {
- // "description": "Select only inventory items that belong to specified orders.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "Project ID for order documents.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "siteId": {
- // "description": "Select only inventory items that are associated with these sites.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/projects/{projectId}/inventoryItems",
- // "response": {
- // "$ref": "InventoryItemsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.landingPages.delete":
-
-type LandingPagesDeleteCall struct {
- s *Service
- profileId int64
- campaignId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an existing campaign landing page.
-func (r *LandingPagesService) Delete(profileId int64, campaignId int64, id int64) *LandingPagesDeleteCall {
- c := &LandingPagesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.campaignId = campaignId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LandingPagesDeleteCall) Fields(s ...googleapi.Field) *LandingPagesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LandingPagesDeleteCall) Context(ctx context.Context) *LandingPagesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LandingPagesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/campaigns/{campaignId}/landingPages/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "campaignId": strconv.FormatInt(c.campaignId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.landingPages.delete" call.
-func (c *LandingPagesDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes an existing campaign landing page.",
- // "httpMethod": "DELETE",
- // "id": "dfareporting.landingPages.delete",
- // "parameterOrder": [
- // "profileId",
- // "campaignId",
- // "id"
- // ],
- // "parameters": {
- // "campaignId": {
- // "description": "Landing page campaign ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "id": {
- // "description": "Landing page ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages/{id}",
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.landingPages.get":
-
-type LandingPagesGetCall struct {
- s *Service
- profileId int64
- campaignId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one campaign landing page by ID.
-func (r *LandingPagesService) Get(profileId int64, campaignId int64, id int64) *LandingPagesGetCall {
- c := &LandingPagesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.campaignId = campaignId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LandingPagesGetCall) Fields(s ...googleapi.Field) *LandingPagesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *LandingPagesGetCall) IfNoneMatch(entityTag string) *LandingPagesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LandingPagesGetCall) Context(ctx context.Context) *LandingPagesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LandingPagesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/campaigns/{campaignId}/landingPages/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "campaignId": strconv.FormatInt(c.campaignId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.landingPages.get" call.
-// Exactly one of *LandingPage or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *LandingPage.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *LandingPagesGetCall) Do() (*LandingPage, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &LandingPage{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one campaign landing page by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.landingPages.get",
- // "parameterOrder": [
- // "profileId",
- // "campaignId",
- // "id"
- // ],
- // "parameters": {
- // "campaignId": {
- // "description": "Landing page campaign ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "id": {
- // "description": "Landing page ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages/{id}",
- // "response": {
- // "$ref": "LandingPage"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.landingPages.insert":
-
-type LandingPagesInsertCall struct {
- s *Service
- profileId int64
- campaignId int64
- landingpage *LandingPage
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new landing page for the specified campaign.
-func (r *LandingPagesService) Insert(profileId int64, campaignId int64, landingpage *LandingPage) *LandingPagesInsertCall {
- c := &LandingPagesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.campaignId = campaignId
- c.landingpage = landingpage
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LandingPagesInsertCall) Fields(s ...googleapi.Field) *LandingPagesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LandingPagesInsertCall) Context(ctx context.Context) *LandingPagesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LandingPagesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.landingpage)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/campaigns/{campaignId}/landingPages")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "campaignId": strconv.FormatInt(c.campaignId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.landingPages.insert" call.
-// Exactly one of *LandingPage or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *LandingPage.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *LandingPagesInsertCall) Do() (*LandingPage, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &LandingPage{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new landing page for the specified campaign.",
- // "httpMethod": "POST",
- // "id": "dfareporting.landingPages.insert",
- // "parameterOrder": [
- // "profileId",
- // "campaignId"
- // ],
- // "parameters": {
- // "campaignId": {
- // "description": "Landing page campaign ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages",
- // "request": {
- // "$ref": "LandingPage"
- // },
- // "response": {
- // "$ref": "LandingPage"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.landingPages.list":
-
-type LandingPagesListCall struct {
- s *Service
- profileId int64
- campaignId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves the list of landing pages for the specified campaign.
-func (r *LandingPagesService) List(profileId int64, campaignId int64) *LandingPagesListCall {
- c := &LandingPagesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.campaignId = campaignId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LandingPagesListCall) Fields(s ...googleapi.Field) *LandingPagesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *LandingPagesListCall) IfNoneMatch(entityTag string) *LandingPagesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LandingPagesListCall) Context(ctx context.Context) *LandingPagesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LandingPagesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/campaigns/{campaignId}/landingPages")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "campaignId": strconv.FormatInt(c.campaignId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.landingPages.list" call.
-// Exactly one of *LandingPagesListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *LandingPagesListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *LandingPagesListCall) Do() (*LandingPagesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &LandingPagesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves the list of landing pages for the specified campaign.",
- // "httpMethod": "GET",
- // "id": "dfareporting.landingPages.list",
- // "parameterOrder": [
- // "profileId",
- // "campaignId"
- // ],
- // "parameters": {
- // "campaignId": {
- // "description": "Landing page campaign ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages",
- // "response": {
- // "$ref": "LandingPagesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.landingPages.patch":
-
-type LandingPagesPatchCall struct {
- s *Service
- profileId int64
- campaignId int64
- id int64
- landingpage *LandingPage
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing campaign landing page. This method
-// supports patch semantics.
-func (r *LandingPagesService) Patch(profileId int64, campaignId int64, id int64, landingpage *LandingPage) *LandingPagesPatchCall {
- c := &LandingPagesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.campaignId = campaignId
- c.id = id
- c.landingpage = landingpage
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LandingPagesPatchCall) Fields(s ...googleapi.Field) *LandingPagesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LandingPagesPatchCall) Context(ctx context.Context) *LandingPagesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LandingPagesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.landingpage)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/campaigns/{campaignId}/landingPages")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "campaignId": strconv.FormatInt(c.campaignId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.landingPages.patch" call.
-// Exactly one of *LandingPage or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *LandingPage.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *LandingPagesPatchCall) Do() (*LandingPage, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &LandingPage{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing campaign landing page. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.landingPages.patch",
- // "parameterOrder": [
- // "profileId",
- // "campaignId",
- // "id"
- // ],
- // "parameters": {
- // "campaignId": {
- // "description": "Landing page campaign ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "id": {
- // "description": "Landing page ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages",
- // "request": {
- // "$ref": "LandingPage"
- // },
- // "response": {
- // "$ref": "LandingPage"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.landingPages.update":
-
-type LandingPagesUpdateCall struct {
- s *Service
- profileId int64
- campaignId int64
- landingpage *LandingPage
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing campaign landing page.
-func (r *LandingPagesService) Update(profileId int64, campaignId int64, landingpage *LandingPage) *LandingPagesUpdateCall {
- c := &LandingPagesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.campaignId = campaignId
- c.landingpage = landingpage
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *LandingPagesUpdateCall) Fields(s ...googleapi.Field) *LandingPagesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *LandingPagesUpdateCall) Context(ctx context.Context) *LandingPagesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *LandingPagesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.landingpage)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/campaigns/{campaignId}/landingPages")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "campaignId": strconv.FormatInt(c.campaignId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.landingPages.update" call.
-// Exactly one of *LandingPage or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *LandingPage.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *LandingPagesUpdateCall) Do() (*LandingPage, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &LandingPage{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing campaign landing page.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.landingPages.update",
- // "parameterOrder": [
- // "profileId",
- // "campaignId"
- // ],
- // "parameters": {
- // "campaignId": {
- // "description": "Landing page campaign ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages",
- // "request": {
- // "$ref": "LandingPage"
- // },
- // "response": {
- // "$ref": "LandingPage"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.metros.list":
-
-type MetrosListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of metros.
-func (r *MetrosService) List(profileId int64) *MetrosListCall {
- c := &MetrosListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MetrosListCall) Fields(s ...googleapi.Field) *MetrosListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MetrosListCall) IfNoneMatch(entityTag string) *MetrosListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MetrosListCall) Context(ctx context.Context) *MetrosListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MetrosListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/metros")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.metros.list" call.
-// Exactly one of *MetrosListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *MetrosListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MetrosListCall) Do() (*MetrosListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &MetrosListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of metros.",
- // "httpMethod": "GET",
- // "id": "dfareporting.metros.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/metros",
- // "response": {
- // "$ref": "MetrosListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.mobileCarriers.get":
-
-type MobileCarriersGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one mobile carrier by ID.
-func (r *MobileCarriersService) Get(profileId int64, id int64) *MobileCarriersGetCall {
- c := &MobileCarriersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MobileCarriersGetCall) Fields(s ...googleapi.Field) *MobileCarriersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MobileCarriersGetCall) IfNoneMatch(entityTag string) *MobileCarriersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MobileCarriersGetCall) Context(ctx context.Context) *MobileCarriersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MobileCarriersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/mobileCarriers/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.mobileCarriers.get" call.
-// Exactly one of *MobileCarrier or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *MobileCarrier.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MobileCarriersGetCall) Do() (*MobileCarrier, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &MobileCarrier{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one mobile carrier by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.mobileCarriers.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Mobile carrier ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/mobileCarriers/{id}",
- // "response": {
- // "$ref": "MobileCarrier"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.mobileCarriers.list":
-
-type MobileCarriersListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of mobile carriers.
-func (r *MobileCarriersService) List(profileId int64) *MobileCarriersListCall {
- c := &MobileCarriersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *MobileCarriersListCall) Fields(s ...googleapi.Field) *MobileCarriersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *MobileCarriersListCall) IfNoneMatch(entityTag string) *MobileCarriersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *MobileCarriersListCall) Context(ctx context.Context) *MobileCarriersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *MobileCarriersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/mobileCarriers")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.mobileCarriers.list" call.
-// Exactly one of *MobileCarriersListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *MobileCarriersListResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *MobileCarriersListCall) Do() (*MobileCarriersListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &MobileCarriersListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of mobile carriers.",
- // "httpMethod": "GET",
- // "id": "dfareporting.mobileCarriers.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/mobileCarriers",
- // "response": {
- // "$ref": "MobileCarriersListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.operatingSystemVersions.get":
-
-type OperatingSystemVersionsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one operating system version by ID.
-func (r *OperatingSystemVersionsService) Get(profileId int64, id int64) *OperatingSystemVersionsGetCall {
- c := &OperatingSystemVersionsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OperatingSystemVersionsGetCall) Fields(s ...googleapi.Field) *OperatingSystemVersionsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OperatingSystemVersionsGetCall) IfNoneMatch(entityTag string) *OperatingSystemVersionsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OperatingSystemVersionsGetCall) Context(ctx context.Context) *OperatingSystemVersionsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OperatingSystemVersionsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/operatingSystemVersions/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.operatingSystemVersions.get" call.
-// Exactly one of *OperatingSystemVersion or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *OperatingSystemVersion.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OperatingSystemVersionsGetCall) Do() (*OperatingSystemVersion, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OperatingSystemVersion{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one operating system version by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.operatingSystemVersions.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Operating system version ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/operatingSystemVersions/{id}",
- // "response": {
- // "$ref": "OperatingSystemVersion"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.operatingSystemVersions.list":
-
-type OperatingSystemVersionsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of operating system versions.
-func (r *OperatingSystemVersionsService) List(profileId int64) *OperatingSystemVersionsListCall {
- c := &OperatingSystemVersionsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OperatingSystemVersionsListCall) Fields(s ...googleapi.Field) *OperatingSystemVersionsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OperatingSystemVersionsListCall) IfNoneMatch(entityTag string) *OperatingSystemVersionsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OperatingSystemVersionsListCall) Context(ctx context.Context) *OperatingSystemVersionsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OperatingSystemVersionsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/operatingSystemVersions")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.operatingSystemVersions.list" call.
-// Exactly one of *OperatingSystemVersionsListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *OperatingSystemVersionsListResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *OperatingSystemVersionsListCall) Do() (*OperatingSystemVersionsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OperatingSystemVersionsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of operating system versions.",
- // "httpMethod": "GET",
- // "id": "dfareporting.operatingSystemVersions.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/operatingSystemVersions",
- // "response": {
- // "$ref": "OperatingSystemVersionsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.operatingSystems.get":
-
-type OperatingSystemsGetCall struct {
- s *Service
- profileId int64
- dartId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one operating system by DART ID.
-func (r *OperatingSystemsService) Get(profileId int64, dartId int64) *OperatingSystemsGetCall {
- c := &OperatingSystemsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.dartId = dartId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OperatingSystemsGetCall) Fields(s ...googleapi.Field) *OperatingSystemsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OperatingSystemsGetCall) IfNoneMatch(entityTag string) *OperatingSystemsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OperatingSystemsGetCall) Context(ctx context.Context) *OperatingSystemsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OperatingSystemsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/operatingSystems/{dartId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "dartId": strconv.FormatInt(c.dartId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.operatingSystems.get" call.
-// Exactly one of *OperatingSystem or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *OperatingSystem.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OperatingSystemsGetCall) Do() (*OperatingSystem, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OperatingSystem{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one operating system by DART ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.operatingSystems.get",
- // "parameterOrder": [
- // "profileId",
- // "dartId"
- // ],
- // "parameters": {
- // "dartId": {
- // "description": "Operating system DART ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/operatingSystems/{dartId}",
- // "response": {
- // "$ref": "OperatingSystem"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.operatingSystems.list":
-
-type OperatingSystemsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of operating systems.
-func (r *OperatingSystemsService) List(profileId int64) *OperatingSystemsListCall {
- c := &OperatingSystemsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OperatingSystemsListCall) Fields(s ...googleapi.Field) *OperatingSystemsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OperatingSystemsListCall) IfNoneMatch(entityTag string) *OperatingSystemsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OperatingSystemsListCall) Context(ctx context.Context) *OperatingSystemsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OperatingSystemsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/operatingSystems")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.operatingSystems.list" call.
-// Exactly one of *OperatingSystemsListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *OperatingSystemsListResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OperatingSystemsListCall) Do() (*OperatingSystemsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OperatingSystemsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of operating systems.",
- // "httpMethod": "GET",
- // "id": "dfareporting.operatingSystems.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/operatingSystems",
- // "response": {
- // "$ref": "OperatingSystemsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.orderDocuments.get":
-
-type OrderDocumentsGetCall struct {
- s *Service
- profileId int64
- projectId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one order document by ID.
-func (r *OrderDocumentsService) Get(profileId int64, projectId int64, id int64) *OrderDocumentsGetCall {
- c := &OrderDocumentsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.projectId = projectId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrderDocumentsGetCall) Fields(s ...googleapi.Field) *OrderDocumentsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OrderDocumentsGetCall) IfNoneMatch(entityTag string) *OrderDocumentsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrderDocumentsGetCall) Context(ctx context.Context) *OrderDocumentsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrderDocumentsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "projectId": strconv.FormatInt(c.projectId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.orderDocuments.get" call.
-// Exactly one of *OrderDocument or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *OrderDocument.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OrderDocumentsGetCall) Do() (*OrderDocument, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrderDocument{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one order document by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.orderDocuments.get",
- // "parameterOrder": [
- // "profileId",
- // "projectId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Order document ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "Project ID for order documents.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}",
- // "response": {
- // "$ref": "OrderDocument"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.orderDocuments.list":
-
-type OrderDocumentsListCall struct {
- s *Service
- profileId int64
- projectId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of order documents, possibly filtered.
-func (r *OrderDocumentsService) List(profileId int64, projectId int64) *OrderDocumentsListCall {
- c := &OrderDocumentsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.projectId = projectId
- return c
-}
-
-// Approved sets the optional parameter "approved": Select only order
-// documents that have been approved by at least one user.
-func (c *OrderDocumentsListCall) Approved(approved bool) *OrderDocumentsListCall {
- c.opt_["approved"] = approved
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only order documents
-// with these IDs.
-func (c *OrderDocumentsListCall) Ids(ids int64) *OrderDocumentsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *OrderDocumentsListCall) MaxResults(maxResults int64) *OrderDocumentsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// OrderId sets the optional parameter "orderId": Select only order
-// documents for specified orders.
-func (c *OrderDocumentsListCall) OrderId(orderId int64) *OrderDocumentsListCall {
- c.opt_["orderId"] = orderId
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *OrderDocumentsListCall) PageToken(pageToken string) *OrderDocumentsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for order documents by name or ID. Wildcards (*) are
-// allowed. For example, "orderdocument*2015" will return order
-// documents with names like "orderdocument June 2015", "orderdocument
-// April 2015", or simply "orderdocument 2015". Most of the searches
-// also add wildcards implicitly at the start and the end of the search
-// string. For example, a search string of "orderdocument" will match
-// order documents with name "my orderdocument", "orderdocument 2015",
-// or simply "orderdocument".
-func (c *OrderDocumentsListCall) SearchString(searchString string) *OrderDocumentsListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SiteId sets the optional parameter "siteId": Select only order
-// documents that are associated with these sites.
-func (c *OrderDocumentsListCall) SiteId(siteId int64) *OrderDocumentsListCall {
- c.opt_["siteId"] = siteId
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *OrderDocumentsListCall) SortField(sortField string) *OrderDocumentsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *OrderDocumentsListCall) SortOrder(sortOrder string) *OrderDocumentsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrderDocumentsListCall) Fields(s ...googleapi.Field) *OrderDocumentsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OrderDocumentsListCall) IfNoneMatch(entityTag string) *OrderDocumentsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrderDocumentsListCall) Context(ctx context.Context) *OrderDocumentsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrderDocumentsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["approved"]; ok {
- params.Set("approved", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["orderId"]; ok {
- params.Set("orderId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["siteId"]; ok {
- params.Set("siteId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/projects/{projectId}/orderDocuments")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "projectId": strconv.FormatInt(c.projectId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.orderDocuments.list" call.
-// Exactly one of *OrderDocumentsListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *OrderDocumentsListResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OrderDocumentsListCall) Do() (*OrderDocumentsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrderDocumentsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of order documents, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.orderDocuments.list",
- // "parameterOrder": [
- // "profileId",
- // "projectId"
- // ],
- // "parameters": {
- // "approved": {
- // "description": "Select only order documents that have been approved by at least one user.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "ids": {
- // "description": "Select only order documents with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "orderId": {
- // "description": "Select only order documents for specified orders.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "Project ID for order documents.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, \"orderdocument*2015\" will return order documents with names like \"orderdocument June 2015\", \"orderdocument April 2015\", or simply \"orderdocument 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"orderdocument\" will match order documents with name \"my orderdocument\", \"orderdocument 2015\", or simply \"orderdocument\".",
- // "location": "query",
- // "type": "string"
- // },
- // "siteId": {
- // "description": "Select only order documents that are associated with these sites.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/projects/{projectId}/orderDocuments",
- // "response": {
- // "$ref": "OrderDocumentsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.orders.get":
-
-type OrdersGetCall struct {
- s *Service
- profileId int64
- projectId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one order by ID.
-func (r *OrdersService) Get(profileId int64, projectId int64, id int64) *OrdersGetCall {
- c := &OrdersGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.projectId = projectId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersGetCall) Fields(s ...googleapi.Field) *OrdersGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OrdersGetCall) IfNoneMatch(entityTag string) *OrdersGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersGetCall) Context(ctx context.Context) *OrdersGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/projects/{projectId}/orders/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "projectId": strconv.FormatInt(c.projectId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.orders.get" call.
-// Exactly one of *Order or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Order.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *OrdersGetCall) Do() (*Order, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Order{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one order by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.orders.get",
- // "parameterOrder": [
- // "profileId",
- // "projectId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Order ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "Project ID for orders.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/projects/{projectId}/orders/{id}",
- // "response": {
- // "$ref": "Order"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.orders.list":
-
-type OrdersListCall struct {
- s *Service
- profileId int64
- projectId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of orders, possibly filtered.
-func (r *OrdersService) List(profileId int64, projectId int64) *OrdersListCall {
- c := &OrdersListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.projectId = projectId
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only orders with these
-// IDs.
-func (c *OrdersListCall) Ids(ids int64) *OrdersListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *OrdersListCall) MaxResults(maxResults int64) *OrdersListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *OrdersListCall) PageToken(pageToken string) *OrdersListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for orders by name or ID. Wildcards (*) are allowed. For
-// example, "order*2015" will return orders with names like "order June
-// 2015", "order April 2015", or simply "order 2015". Most of the
-// searches also add wildcards implicitly at the start and the end of
-// the search string. For example, a search string of "order" will match
-// orders with name "my order", "order 2015", or simply "order".
-func (c *OrdersListCall) SearchString(searchString string) *OrdersListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SiteId sets the optional parameter "siteId": Select only orders that
-// are associated with these site IDs.
-func (c *OrdersListCall) SiteId(siteId int64) *OrdersListCall {
- c.opt_["siteId"] = siteId
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *OrdersListCall) SortField(sortField string) *OrdersListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *OrdersListCall) SortOrder(sortOrder string) *OrdersListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *OrdersListCall) Fields(s ...googleapi.Field) *OrdersListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *OrdersListCall) IfNoneMatch(entityTag string) *OrdersListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *OrdersListCall) Context(ctx context.Context) *OrdersListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *OrdersListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["siteId"]; ok {
- params.Set("siteId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/projects/{projectId}/orders")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "projectId": strconv.FormatInt(c.projectId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.orders.list" call.
-// Exactly one of *OrdersListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *OrdersListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *OrdersListCall) Do() (*OrdersListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &OrdersListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of orders, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.orders.list",
- // "parameterOrder": [
- // "profileId",
- // "projectId"
- // ],
- // "parameters": {
- // "ids": {
- // "description": "Select only orders with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "projectId": {
- // "description": "Project ID for orders.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, \"order*2015\" will return orders with names like \"order June 2015\", \"order April 2015\", or simply \"order 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"order\" will match orders with name \"my order\", \"order 2015\", or simply \"order\".",
- // "location": "query",
- // "type": "string"
- // },
- // "siteId": {
- // "description": "Select only orders that are associated with these site IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/projects/{projectId}/orders",
- // "response": {
- // "$ref": "OrdersListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placementGroups.get":
-
-type PlacementGroupsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one placement group by ID.
-func (r *PlacementGroupsService) Get(profileId int64, id int64) *PlacementGroupsGetCall {
- c := &PlacementGroupsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementGroupsGetCall) Fields(s ...googleapi.Field) *PlacementGroupsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PlacementGroupsGetCall) IfNoneMatch(entityTag string) *PlacementGroupsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementGroupsGetCall) Context(ctx context.Context) *PlacementGroupsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementGroupsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placementGroups/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placementGroups.get" call.
-// Exactly one of *PlacementGroup or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *PlacementGroup.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PlacementGroupsGetCall) Do() (*PlacementGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PlacementGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one placement group by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.placementGroups.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Placement group ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placementGroups/{id}",
- // "response": {
- // "$ref": "PlacementGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placementGroups.insert":
-
-type PlacementGroupsInsertCall struct {
- s *Service
- profileId int64
- placementgroup *PlacementGroup
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new placement group.
-func (r *PlacementGroupsService) Insert(profileId int64, placementgroup *PlacementGroup) *PlacementGroupsInsertCall {
- c := &PlacementGroupsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.placementgroup = placementgroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementGroupsInsertCall) Fields(s ...googleapi.Field) *PlacementGroupsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementGroupsInsertCall) Context(ctx context.Context) *PlacementGroupsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementGroupsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.placementgroup)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placementGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placementGroups.insert" call.
-// Exactly one of *PlacementGroup or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *PlacementGroup.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PlacementGroupsInsertCall) Do() (*PlacementGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PlacementGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new placement group.",
- // "httpMethod": "POST",
- // "id": "dfareporting.placementGroups.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placementGroups",
- // "request": {
- // "$ref": "PlacementGroup"
- // },
- // "response": {
- // "$ref": "PlacementGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placementGroups.list":
-
-type PlacementGroupsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of placement groups, possibly filtered.
-func (r *PlacementGroupsService) List(profileId int64) *PlacementGroupsListCall {
- c := &PlacementGroupsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// AdvertiserIds sets the optional parameter "advertiserIds": Select
-// only placement groups that belong to these advertisers.
-func (c *PlacementGroupsListCall) AdvertiserIds(advertiserIds int64) *PlacementGroupsListCall {
- c.opt_["advertiserIds"] = advertiserIds
- return c
-}
-
-// Archived sets the optional parameter "archived": Select only archived
-// placements. Don't set this field to select both archived and
-// non-archived placements.
-func (c *PlacementGroupsListCall) Archived(archived bool) *PlacementGroupsListCall {
- c.opt_["archived"] = archived
- return c
-}
-
-// CampaignIds sets the optional parameter "campaignIds": Select only
-// placement groups that belong to these campaigns.
-func (c *PlacementGroupsListCall) CampaignIds(campaignIds int64) *PlacementGroupsListCall {
- c.opt_["campaignIds"] = campaignIds
- return c
-}
-
-// ContentCategoryIds sets the optional parameter "contentCategoryIds":
-// Select only placement groups that are associated with these content
-// categories.
-func (c *PlacementGroupsListCall) ContentCategoryIds(contentCategoryIds int64) *PlacementGroupsListCall {
- c.opt_["contentCategoryIds"] = contentCategoryIds
- return c
-}
-
-// DirectorySiteIds sets the optional parameter "directorySiteIds":
-// Select only placement groups that are associated with these directory
-// sites.
-func (c *PlacementGroupsListCall) DirectorySiteIds(directorySiteIds int64) *PlacementGroupsListCall {
- c.opt_["directorySiteIds"] = directorySiteIds
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only placement groups
-// with these IDs.
-func (c *PlacementGroupsListCall) Ids(ids int64) *PlacementGroupsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *PlacementGroupsListCall) MaxResults(maxResults int64) *PlacementGroupsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *PlacementGroupsListCall) PageToken(pageToken string) *PlacementGroupsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// PlacementGroupType sets the optional parameter "placementGroupType":
-// Select only placement groups belonging with this group type. A
-// package is a simple group of placements that acts as a single pricing
-// point for a group of tags. A roadblock is a group of placements that
-// not only acts as a single pricing point but also assumes that all the
-// tags in it will be served at the same time. A roadblock requires one
-// of its assigned placements to be marked as primary for reporting.
-//
-// Possible values:
-// "PLACEMENT_PACKAGE"
-// "PLACEMENT_ROADBLOCK"
-func (c *PlacementGroupsListCall) PlacementGroupType(placementGroupType string) *PlacementGroupsListCall {
- c.opt_["placementGroupType"] = placementGroupType
- return c
-}
-
-// PlacementStrategyIds sets the optional parameter
-// "placementStrategyIds": Select only placement groups that are
-// associated with these placement strategies.
-func (c *PlacementGroupsListCall) PlacementStrategyIds(placementStrategyIds int64) *PlacementGroupsListCall {
- c.opt_["placementStrategyIds"] = placementStrategyIds
- return c
-}
-
-// PricingTypes sets the optional parameter "pricingTypes": Select only
-// placement groups with these pricing types.
-//
-// Possible values:
-// "PRICING_TYPE_CPA"
-// "PRICING_TYPE_CPC"
-// "PRICING_TYPE_CPM"
-// "PRICING_TYPE_FLAT_RATE_CLICKS"
-// "PRICING_TYPE_FLAT_RATE_IMPRESSIONS"
-func (c *PlacementGroupsListCall) PricingTypes(pricingTypes string) *PlacementGroupsListCall {
- c.opt_["pricingTypes"] = pricingTypes
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for placement groups by name or ID. Wildcards (*) are
-// allowed. For example, "placement*2015" will return placement groups
-// with names like "placement group June 2015", "placement group May
-// 2015", or simply "placements 2015". Most of the searches also add
-// wildcards implicitly at the start and the end of the search string.
-// For example, a search string of "placementgroup" will match placement
-// groups with name "my placementgroup", "placementgroup 2015", or
-// simply "placementgroup".
-func (c *PlacementGroupsListCall) SearchString(searchString string) *PlacementGroupsListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SiteIds sets the optional parameter "siteIds": Select only placement
-// groups that are associated with these sites.
-func (c *PlacementGroupsListCall) SiteIds(siteIds int64) *PlacementGroupsListCall {
- c.opt_["siteIds"] = siteIds
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *PlacementGroupsListCall) SortField(sortField string) *PlacementGroupsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *PlacementGroupsListCall) SortOrder(sortOrder string) *PlacementGroupsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementGroupsListCall) Fields(s ...googleapi.Field) *PlacementGroupsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PlacementGroupsListCall) IfNoneMatch(entityTag string) *PlacementGroupsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementGroupsListCall) Context(ctx context.Context) *PlacementGroupsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementGroupsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["advertiserIds"]; ok {
- params.Set("advertiserIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["archived"]; ok {
- params.Set("archived", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["campaignIds"]; ok {
- params.Set("campaignIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["contentCategoryIds"]; ok {
- params.Set("contentCategoryIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["directorySiteIds"]; ok {
- params.Set("directorySiteIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["placementGroupType"]; ok {
- params.Set("placementGroupType", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["placementStrategyIds"]; ok {
- params.Set("placementStrategyIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pricingTypes"]; ok {
- params.Set("pricingTypes", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["siteIds"]; ok {
- params.Set("siteIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placementGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placementGroups.list" call.
-// Exactly one of *PlacementGroupsListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *PlacementGroupsListResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PlacementGroupsListCall) Do() (*PlacementGroupsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PlacementGroupsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of placement groups, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.placementGroups.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "advertiserIds": {
- // "description": "Select only placement groups that belong to these advertisers.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "archived": {
- // "description": "Select only archived placements. Don't set this field to select both archived and non-archived placements.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "campaignIds": {
- // "description": "Select only placement groups that belong to these campaigns.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "contentCategoryIds": {
- // "description": "Select only placement groups that are associated with these content categories.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "directorySiteIds": {
- // "description": "Select only placement groups that are associated with these directory sites.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only placement groups with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "placementGroupType": {
- // "description": "Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.",
- // "enum": [
- // "PLACEMENT_PACKAGE",
- // "PLACEMENT_ROADBLOCK"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "placementStrategyIds": {
- // "description": "Select only placement groups that are associated with these placement strategies.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "pricingTypes": {
- // "description": "Select only placement groups with these pricing types.",
- // "enum": [
- // "PRICING_TYPE_CPA",
- // "PRICING_TYPE_CPC",
- // "PRICING_TYPE_CPM",
- // "PRICING_TYPE_FLAT_RATE_CLICKS",
- // "PRICING_TYPE_FLAT_RATE_IMPRESSIONS"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, \"placement*2015\" will return placement groups with names like \"placement group June 2015\", \"placement group May 2015\", or simply \"placements 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placementgroup\" will match placement groups with name \"my placementgroup\", \"placementgroup 2015\", or simply \"placementgroup\".",
- // "location": "query",
- // "type": "string"
- // },
- // "siteIds": {
- // "description": "Select only placement groups that are associated with these sites.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placementGroups",
- // "response": {
- // "$ref": "PlacementGroupsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placementGroups.patch":
-
-type PlacementGroupsPatchCall struct {
- s *Service
- profileId int64
- id int64
- placementgroup *PlacementGroup
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing placement group. This method supports
-// patch semantics.
-func (r *PlacementGroupsService) Patch(profileId int64, id int64, placementgroup *PlacementGroup) *PlacementGroupsPatchCall {
- c := &PlacementGroupsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.placementgroup = placementgroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementGroupsPatchCall) Fields(s ...googleapi.Field) *PlacementGroupsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementGroupsPatchCall) Context(ctx context.Context) *PlacementGroupsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementGroupsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.placementgroup)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placementGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placementGroups.patch" call.
-// Exactly one of *PlacementGroup or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *PlacementGroup.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PlacementGroupsPatchCall) Do() (*PlacementGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PlacementGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing placement group. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.placementGroups.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Placement group ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placementGroups",
- // "request": {
- // "$ref": "PlacementGroup"
- // },
- // "response": {
- // "$ref": "PlacementGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placementGroups.update":
-
-type PlacementGroupsUpdateCall struct {
- s *Service
- profileId int64
- placementgroup *PlacementGroup
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing placement group.
-func (r *PlacementGroupsService) Update(profileId int64, placementgroup *PlacementGroup) *PlacementGroupsUpdateCall {
- c := &PlacementGroupsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.placementgroup = placementgroup
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementGroupsUpdateCall) Fields(s ...googleapi.Field) *PlacementGroupsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementGroupsUpdateCall) Context(ctx context.Context) *PlacementGroupsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementGroupsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.placementgroup)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placementGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placementGroups.update" call.
-// Exactly one of *PlacementGroup or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *PlacementGroup.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PlacementGroupsUpdateCall) Do() (*PlacementGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PlacementGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing placement group.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.placementGroups.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placementGroups",
- // "request": {
- // "$ref": "PlacementGroup"
- // },
- // "response": {
- // "$ref": "PlacementGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placementStrategies.delete":
-
-type PlacementStrategiesDeleteCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an existing placement strategy.
-func (r *PlacementStrategiesService) Delete(profileId int64, id int64) *PlacementStrategiesDeleteCall {
- c := &PlacementStrategiesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementStrategiesDeleteCall) Fields(s ...googleapi.Field) *PlacementStrategiesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementStrategiesDeleteCall) Context(ctx context.Context) *PlacementStrategiesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementStrategiesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placementStrategies/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placementStrategies.delete" call.
-func (c *PlacementStrategiesDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes an existing placement strategy.",
- // "httpMethod": "DELETE",
- // "id": "dfareporting.placementStrategies.delete",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Placement strategy ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placementStrategies/{id}",
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placementStrategies.get":
-
-type PlacementStrategiesGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one placement strategy by ID.
-func (r *PlacementStrategiesService) Get(profileId int64, id int64) *PlacementStrategiesGetCall {
- c := &PlacementStrategiesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementStrategiesGetCall) Fields(s ...googleapi.Field) *PlacementStrategiesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PlacementStrategiesGetCall) IfNoneMatch(entityTag string) *PlacementStrategiesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementStrategiesGetCall) Context(ctx context.Context) *PlacementStrategiesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementStrategiesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placementStrategies/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placementStrategies.get" call.
-// Exactly one of *PlacementStrategy or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *PlacementStrategy.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PlacementStrategiesGetCall) Do() (*PlacementStrategy, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PlacementStrategy{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one placement strategy by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.placementStrategies.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Placement strategy ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placementStrategies/{id}",
- // "response": {
- // "$ref": "PlacementStrategy"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placementStrategies.insert":
-
-type PlacementStrategiesInsertCall struct {
- s *Service
- profileId int64
- placementstrategy *PlacementStrategy
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new placement strategy.
-func (r *PlacementStrategiesService) Insert(profileId int64, placementstrategy *PlacementStrategy) *PlacementStrategiesInsertCall {
- c := &PlacementStrategiesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.placementstrategy = placementstrategy
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementStrategiesInsertCall) Fields(s ...googleapi.Field) *PlacementStrategiesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementStrategiesInsertCall) Context(ctx context.Context) *PlacementStrategiesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementStrategiesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.placementstrategy)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placementStrategies")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placementStrategies.insert" call.
-// Exactly one of *PlacementStrategy or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *PlacementStrategy.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PlacementStrategiesInsertCall) Do() (*PlacementStrategy, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PlacementStrategy{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new placement strategy.",
- // "httpMethod": "POST",
- // "id": "dfareporting.placementStrategies.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placementStrategies",
- // "request": {
- // "$ref": "PlacementStrategy"
- // },
- // "response": {
- // "$ref": "PlacementStrategy"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placementStrategies.list":
-
-type PlacementStrategiesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of placement strategies, possibly filtered.
-func (r *PlacementStrategiesService) List(profileId int64) *PlacementStrategiesListCall {
- c := &PlacementStrategiesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only placement
-// strategies with these IDs.
-func (c *PlacementStrategiesListCall) Ids(ids int64) *PlacementStrategiesListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *PlacementStrategiesListCall) MaxResults(maxResults int64) *PlacementStrategiesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *PlacementStrategiesListCall) PageToken(pageToken string) *PlacementStrategiesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name or ID. Wildcards (*) are allowed. For
-// example, "placementstrategy*2015" will return objects with names like
-// "placementstrategy June 2015", "placementstrategy April 2015", or
-// simply "placementstrategy 2015". Most of the searches also add
-// wildcards implicitly at the start and the end of the search string.
-// For example, a search string of "placementstrategy" will match
-// objects with name "my placementstrategy", "placementstrategy 2015",
-// or simply "placementstrategy".
-func (c *PlacementStrategiesListCall) SearchString(searchString string) *PlacementStrategiesListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *PlacementStrategiesListCall) SortField(sortField string) *PlacementStrategiesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *PlacementStrategiesListCall) SortOrder(sortOrder string) *PlacementStrategiesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementStrategiesListCall) Fields(s ...googleapi.Field) *PlacementStrategiesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PlacementStrategiesListCall) IfNoneMatch(entityTag string) *PlacementStrategiesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementStrategiesListCall) Context(ctx context.Context) *PlacementStrategiesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementStrategiesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placementStrategies")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placementStrategies.list" call.
-// Exactly one of *PlacementStrategiesListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *PlacementStrategiesListResponse.ServerResponse.Header or (if
-// a response was returned at all) in error.(*googleapi.Error).Header.
-// Use googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PlacementStrategiesListCall) Do() (*PlacementStrategiesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PlacementStrategiesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of placement strategies, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.placementStrategies.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "ids": {
- // "description": "Select only placement strategies with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"placementstrategy*2015\" will return objects with names like \"placementstrategy June 2015\", \"placementstrategy April 2015\", or simply \"placementstrategy 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placementstrategy\" will match objects with name \"my placementstrategy\", \"placementstrategy 2015\", or simply \"placementstrategy\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placementStrategies",
- // "response": {
- // "$ref": "PlacementStrategiesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placementStrategies.patch":
-
-type PlacementStrategiesPatchCall struct {
- s *Service
- profileId int64
- id int64
- placementstrategy *PlacementStrategy
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing placement strategy. This method supports
-// patch semantics.
-func (r *PlacementStrategiesService) Patch(profileId int64, id int64, placementstrategy *PlacementStrategy) *PlacementStrategiesPatchCall {
- c := &PlacementStrategiesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.placementstrategy = placementstrategy
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementStrategiesPatchCall) Fields(s ...googleapi.Field) *PlacementStrategiesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementStrategiesPatchCall) Context(ctx context.Context) *PlacementStrategiesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementStrategiesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.placementstrategy)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placementStrategies")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placementStrategies.patch" call.
-// Exactly one of *PlacementStrategy or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *PlacementStrategy.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PlacementStrategiesPatchCall) Do() (*PlacementStrategy, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PlacementStrategy{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing placement strategy. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.placementStrategies.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Placement strategy ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placementStrategies",
- // "request": {
- // "$ref": "PlacementStrategy"
- // },
- // "response": {
- // "$ref": "PlacementStrategy"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placementStrategies.update":
-
-type PlacementStrategiesUpdateCall struct {
- s *Service
- profileId int64
- placementstrategy *PlacementStrategy
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing placement strategy.
-func (r *PlacementStrategiesService) Update(profileId int64, placementstrategy *PlacementStrategy) *PlacementStrategiesUpdateCall {
- c := &PlacementStrategiesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.placementstrategy = placementstrategy
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementStrategiesUpdateCall) Fields(s ...googleapi.Field) *PlacementStrategiesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementStrategiesUpdateCall) Context(ctx context.Context) *PlacementStrategiesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementStrategiesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.placementstrategy)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placementStrategies")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placementStrategies.update" call.
-// Exactly one of *PlacementStrategy or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *PlacementStrategy.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PlacementStrategiesUpdateCall) Do() (*PlacementStrategy, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PlacementStrategy{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing placement strategy.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.placementStrategies.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placementStrategies",
- // "request": {
- // "$ref": "PlacementStrategy"
- // },
- // "response": {
- // "$ref": "PlacementStrategy"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placements.generatetags":
-
-type PlacementsGeneratetagsCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Generatetags: Generates tags for a placement.
-func (r *PlacementsService) Generatetags(profileId int64) *PlacementsGeneratetagsCall {
- c := &PlacementsGeneratetagsCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// CampaignId sets the optional parameter "campaignId": Generate
-// placements belonging to this campaign. This is a required field.
-func (c *PlacementsGeneratetagsCall) CampaignId(campaignId int64) *PlacementsGeneratetagsCall {
- c.opt_["campaignId"] = campaignId
- return c
-}
-
-// PlacementIds sets the optional parameter "placementIds": Generate
-// tags for these placements.
-func (c *PlacementsGeneratetagsCall) PlacementIds(placementIds int64) *PlacementsGeneratetagsCall {
- c.opt_["placementIds"] = placementIds
- return c
-}
-
-// TagFormats sets the optional parameter "tagFormats": Tag formats to
-// generate for these placements.
-//
-// Possible values:
-// "PLACEMENT_TAG_CLICK_COMMANDS"
-// "PLACEMENT_TAG_IFRAME_ILAYER"
-// "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
-// "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY"
-// "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
-// "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3"
-// "PLACEMENT_TAG_INTERNAL_REDIRECT"
-// "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
-// "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY"
-// "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
-// "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
-// "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY"
-// "PLACEMENT_TAG_JAVASCRIPT"
-// "PLACEMENT_TAG_JAVASCRIPT_LEGACY"
-// "PLACEMENT_TAG_STANDARD"
-// "PLACEMENT_TAG_TRACKING"
-// "PLACEMENT_TAG_TRACKING_IFRAME"
-// "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
-func (c *PlacementsGeneratetagsCall) TagFormats(tagFormats string) *PlacementsGeneratetagsCall {
- c.opt_["tagFormats"] = tagFormats
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementsGeneratetagsCall) Fields(s ...googleapi.Field) *PlacementsGeneratetagsCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementsGeneratetagsCall) Context(ctx context.Context) *PlacementsGeneratetagsCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementsGeneratetagsCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["campaignId"]; ok {
- params.Set("campaignId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["placementIds"]; ok {
- params.Set("placementIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["tagFormats"]; ok {
- params.Set("tagFormats", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placements/generatetags")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placements.generatetags" call.
-// Exactly one of *PlacementsGenerateTagsResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *PlacementsGenerateTagsResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PlacementsGeneratetagsCall) Do() (*PlacementsGenerateTagsResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PlacementsGenerateTagsResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Generates tags for a placement.",
- // "httpMethod": "POST",
- // "id": "dfareporting.placements.generatetags",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "campaignId": {
- // "description": "Generate placements belonging to this campaign. This is a required field.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "placementIds": {
- // "description": "Generate tags for these placements.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "tagFormats": {
- // "description": "Tag formats to generate for these placements.",
- // "enum": [
- // "PLACEMENT_TAG_CLICK_COMMANDS",
- // "PLACEMENT_TAG_IFRAME_ILAYER",
- // "PLACEMENT_TAG_IFRAME_JAVASCRIPT",
- // "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
- // "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
- // "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
- // "PLACEMENT_TAG_INTERNAL_REDIRECT",
- // "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
- // "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
- // "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
- // "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
- // "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
- // "PLACEMENT_TAG_JAVASCRIPT",
- // "PLACEMENT_TAG_JAVASCRIPT_LEGACY",
- // "PLACEMENT_TAG_STANDARD",
- // "PLACEMENT_TAG_TRACKING",
- // "PLACEMENT_TAG_TRACKING_IFRAME",
- // "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placements/generatetags",
- // "response": {
- // "$ref": "PlacementsGenerateTagsResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placements.get":
-
-type PlacementsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one placement by ID.
-func (r *PlacementsService) Get(profileId int64, id int64) *PlacementsGetCall {
- c := &PlacementsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementsGetCall) Fields(s ...googleapi.Field) *PlacementsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PlacementsGetCall) IfNoneMatch(entityTag string) *PlacementsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementsGetCall) Context(ctx context.Context) *PlacementsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placements/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placements.get" call.
-// Exactly one of *Placement or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Placement.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *PlacementsGetCall) Do() (*Placement, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Placement{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one placement by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.placements.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Placement ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placements/{id}",
- // "response": {
- // "$ref": "Placement"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placements.insert":
-
-type PlacementsInsertCall struct {
- s *Service
- profileId int64
- placement *Placement
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new placement.
-func (r *PlacementsService) Insert(profileId int64, placement *Placement) *PlacementsInsertCall {
- c := &PlacementsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.placement = placement
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementsInsertCall) Fields(s ...googleapi.Field) *PlacementsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementsInsertCall) Context(ctx context.Context) *PlacementsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.placement)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placements")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placements.insert" call.
-// Exactly one of *Placement or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Placement.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *PlacementsInsertCall) Do() (*Placement, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Placement{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new placement.",
- // "httpMethod": "POST",
- // "id": "dfareporting.placements.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placements",
- // "request": {
- // "$ref": "Placement"
- // },
- // "response": {
- // "$ref": "Placement"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placements.list":
-
-type PlacementsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of placements, possibly filtered.
-func (r *PlacementsService) List(profileId int64) *PlacementsListCall {
- c := &PlacementsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// AdvertiserIds sets the optional parameter "advertiserIds": Select
-// only placements that belong to these advertisers.
-func (c *PlacementsListCall) AdvertiserIds(advertiserIds int64) *PlacementsListCall {
- c.opt_["advertiserIds"] = advertiserIds
- return c
-}
-
-// Archived sets the optional parameter "archived": Select only archived
-// placements. Don't set this field to select both archived and
-// non-archived placements.
-func (c *PlacementsListCall) Archived(archived bool) *PlacementsListCall {
- c.opt_["archived"] = archived
- return c
-}
-
-// CampaignIds sets the optional parameter "campaignIds": Select only
-// placements that belong to these campaigns.
-func (c *PlacementsListCall) CampaignIds(campaignIds int64) *PlacementsListCall {
- c.opt_["campaignIds"] = campaignIds
- return c
-}
-
-// Compatibilities sets the optional parameter "compatibilities": Select
-// only placements that are associated with these compatibilities. WEB
-// and WEB_INTERSTITIAL refer to rendering either on desktop or on
-// mobile devices for regular or interstitial ads respectively. APP and
-// APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO
-// refers to rendering in in-stream video ads developed with the VAST
-// standard.
-//
-// Possible values:
-// "APP"
-// "APP_INTERSTITIAL"
-// "IN_STREAM_VIDEO"
-// "WEB"
-// "WEB_INTERSTITIAL"
-func (c *PlacementsListCall) Compatibilities(compatibilities string) *PlacementsListCall {
- c.opt_["compatibilities"] = compatibilities
- return c
-}
-
-// ContentCategoryIds sets the optional parameter "contentCategoryIds":
-// Select only placements that are associated with these content
-// categories.
-func (c *PlacementsListCall) ContentCategoryIds(contentCategoryIds int64) *PlacementsListCall {
- c.opt_["contentCategoryIds"] = contentCategoryIds
- return c
-}
-
-// DirectorySiteIds sets the optional parameter "directorySiteIds":
-// Select only placements that are associated with these directory
-// sites.
-func (c *PlacementsListCall) DirectorySiteIds(directorySiteIds int64) *PlacementsListCall {
- c.opt_["directorySiteIds"] = directorySiteIds
- return c
-}
-
-// GroupIds sets the optional parameter "groupIds": Select only
-// placements that belong to these placement groups.
-func (c *PlacementsListCall) GroupIds(groupIds int64) *PlacementsListCall {
- c.opt_["groupIds"] = groupIds
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only placements with
-// these IDs.
-func (c *PlacementsListCall) Ids(ids int64) *PlacementsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *PlacementsListCall) MaxResults(maxResults int64) *PlacementsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *PlacementsListCall) PageToken(pageToken string) *PlacementsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// PaymentSource sets the optional parameter "paymentSource": Select
-// only placements with this payment source.
-//
-// Possible values:
-// "PLACEMENT_AGENCY_PAID"
-// "PLACEMENT_PUBLISHER_PAID"
-func (c *PlacementsListCall) PaymentSource(paymentSource string) *PlacementsListCall {
- c.opt_["paymentSource"] = paymentSource
- return c
-}
-
-// PlacementStrategyIds sets the optional parameter
-// "placementStrategyIds": Select only placements that are associated
-// with these placement strategies.
-func (c *PlacementsListCall) PlacementStrategyIds(placementStrategyIds int64) *PlacementsListCall {
- c.opt_["placementStrategyIds"] = placementStrategyIds
- return c
-}
-
-// PricingTypes sets the optional parameter "pricingTypes": Select only
-// placements with these pricing types.
-//
-// Possible values:
-// "PRICING_TYPE_CPA"
-// "PRICING_TYPE_CPC"
-// "PRICING_TYPE_CPM"
-// "PRICING_TYPE_FLAT_RATE_CLICKS"
-// "PRICING_TYPE_FLAT_RATE_IMPRESSIONS"
-func (c *PlacementsListCall) PricingTypes(pricingTypes string) *PlacementsListCall {
- c.opt_["pricingTypes"] = pricingTypes
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for placements by name or ID. Wildcards (*) are allowed.
-// For example, "placement*2015" will return placements with names like
-// "placement June 2015", "placement May 2015", or simply "placements
-// 2015". Most of the searches also add wildcards implicitly at the
-// start and the end of the search string. For example, a search string
-// of "placement" will match placements with name "my placement",
-// "placement 2015", or simply "placement".
-func (c *PlacementsListCall) SearchString(searchString string) *PlacementsListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SiteIds sets the optional parameter "siteIds": Select only placements
-// that are associated with these sites.
-func (c *PlacementsListCall) SiteIds(siteIds int64) *PlacementsListCall {
- c.opt_["siteIds"] = siteIds
- return c
-}
-
-// SizeIds sets the optional parameter "sizeIds": Select only placements
-// that are associated with these sizes.
-func (c *PlacementsListCall) SizeIds(sizeIds int64) *PlacementsListCall {
- c.opt_["sizeIds"] = sizeIds
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *PlacementsListCall) SortField(sortField string) *PlacementsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *PlacementsListCall) SortOrder(sortOrder string) *PlacementsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementsListCall) Fields(s ...googleapi.Field) *PlacementsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PlacementsListCall) IfNoneMatch(entityTag string) *PlacementsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementsListCall) Context(ctx context.Context) *PlacementsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["advertiserIds"]; ok {
- params.Set("advertiserIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["archived"]; ok {
- params.Set("archived", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["campaignIds"]; ok {
- params.Set("campaignIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["compatibilities"]; ok {
- params.Set("compatibilities", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["contentCategoryIds"]; ok {
- params.Set("contentCategoryIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["directorySiteIds"]; ok {
- params.Set("directorySiteIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["groupIds"]; ok {
- params.Set("groupIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["paymentSource"]; ok {
- params.Set("paymentSource", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["placementStrategyIds"]; ok {
- params.Set("placementStrategyIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pricingTypes"]; ok {
- params.Set("pricingTypes", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["siteIds"]; ok {
- params.Set("siteIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sizeIds"]; ok {
- params.Set("sizeIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placements")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placements.list" call.
-// Exactly one of *PlacementsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *PlacementsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PlacementsListCall) Do() (*PlacementsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PlacementsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of placements, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.placements.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "advertiserIds": {
- // "description": "Select only placements that belong to these advertisers.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "archived": {
- // "description": "Select only archived placements. Don't set this field to select both archived and non-archived placements.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "campaignIds": {
- // "description": "Select only placements that belong to these campaigns.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "compatibilities": {
- // "description": "Select only placements that are associated with these compatibilities. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.",
- // "enum": [
- // "APP",
- // "APP_INTERSTITIAL",
- // "IN_STREAM_VIDEO",
- // "WEB",
- // "WEB_INTERSTITIAL"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "contentCategoryIds": {
- // "description": "Select only placements that are associated with these content categories.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "directorySiteIds": {
- // "description": "Select only placements that are associated with these directory sites.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "groupIds": {
- // "description": "Select only placements that belong to these placement groups.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only placements with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "paymentSource": {
- // "description": "Select only placements with this payment source.",
- // "enum": [
- // "PLACEMENT_AGENCY_PAID",
- // "PLACEMENT_PUBLISHER_PAID"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "placementStrategyIds": {
- // "description": "Select only placements that are associated with these placement strategies.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "pricingTypes": {
- // "description": "Select only placements with these pricing types.",
- // "enum": [
- // "PRICING_TYPE_CPA",
- // "PRICING_TYPE_CPC",
- // "PRICING_TYPE_CPM",
- // "PRICING_TYPE_FLAT_RATE_CLICKS",
- // "PRICING_TYPE_FLAT_RATE_IMPRESSIONS"
- // ],
- // "enumDescriptions": [
- // "",
- // "",
- // "",
- // "",
- // ""
- // ],
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, \"placement*2015\" will return placements with names like \"placement June 2015\", \"placement May 2015\", or simply \"placements 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placement\" will match placements with name \"my placement\", \"placement 2015\", or simply \"placement\".",
- // "location": "query",
- // "type": "string"
- // },
- // "siteIds": {
- // "description": "Select only placements that are associated with these sites.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "sizeIds": {
- // "description": "Select only placements that are associated with these sizes.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placements",
- // "response": {
- // "$ref": "PlacementsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placements.patch":
-
-type PlacementsPatchCall struct {
- s *Service
- profileId int64
- id int64
- placement *Placement
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing placement. This method supports patch
-// semantics.
-func (r *PlacementsService) Patch(profileId int64, id int64, placement *Placement) *PlacementsPatchCall {
- c := &PlacementsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.placement = placement
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementsPatchCall) Fields(s ...googleapi.Field) *PlacementsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementsPatchCall) Context(ctx context.Context) *PlacementsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.placement)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placements")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placements.patch" call.
-// Exactly one of *Placement or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Placement.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *PlacementsPatchCall) Do() (*Placement, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Placement{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing placement. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.placements.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Placement ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placements",
- // "request": {
- // "$ref": "Placement"
- // },
- // "response": {
- // "$ref": "Placement"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.placements.update":
-
-type PlacementsUpdateCall struct {
- s *Service
- profileId int64
- placement *Placement
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing placement.
-func (r *PlacementsService) Update(profileId int64, placement *Placement) *PlacementsUpdateCall {
- c := &PlacementsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.placement = placement
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlacementsUpdateCall) Fields(s ...googleapi.Field) *PlacementsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlacementsUpdateCall) Context(ctx context.Context) *PlacementsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlacementsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.placement)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/placements")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.placements.update" call.
-// Exactly one of *Placement or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Placement.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *PlacementsUpdateCall) Do() (*Placement, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Placement{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing placement.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.placements.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/placements",
- // "request": {
- // "$ref": "Placement"
- // },
- // "response": {
- // "$ref": "Placement"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.platformTypes.get":
-
-type PlatformTypesGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one platform type by ID.
-func (r *PlatformTypesService) Get(profileId int64, id int64) *PlatformTypesGetCall {
- c := &PlatformTypesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlatformTypesGetCall) Fields(s ...googleapi.Field) *PlatformTypesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PlatformTypesGetCall) IfNoneMatch(entityTag string) *PlatformTypesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlatformTypesGetCall) Context(ctx context.Context) *PlatformTypesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlatformTypesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/platformTypes/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.platformTypes.get" call.
-// Exactly one of *PlatformType or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *PlatformType.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *PlatformTypesGetCall) Do() (*PlatformType, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PlatformType{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one platform type by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.platformTypes.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Platform type ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/platformTypes/{id}",
- // "response": {
- // "$ref": "PlatformType"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.platformTypes.list":
-
-type PlatformTypesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of platform types.
-func (r *PlatformTypesService) List(profileId int64) *PlatformTypesListCall {
- c := &PlatformTypesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PlatformTypesListCall) Fields(s ...googleapi.Field) *PlatformTypesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PlatformTypesListCall) IfNoneMatch(entityTag string) *PlatformTypesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PlatformTypesListCall) Context(ctx context.Context) *PlatformTypesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PlatformTypesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/platformTypes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.platformTypes.list" call.
-// Exactly one of *PlatformTypesListResponse or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *PlatformTypesListResponse.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PlatformTypesListCall) Do() (*PlatformTypesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PlatformTypesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of platform types.",
- // "httpMethod": "GET",
- // "id": "dfareporting.platformTypes.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/platformTypes",
- // "response": {
- // "$ref": "PlatformTypesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.postalCodes.get":
-
-type PostalCodesGetCall struct {
- s *Service
- profileId int64
- code string
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one postal code by ID.
-func (r *PostalCodesService) Get(profileId int64, code string) *PostalCodesGetCall {
- c := &PostalCodesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.code = code
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PostalCodesGetCall) Fields(s ...googleapi.Field) *PostalCodesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PostalCodesGetCall) IfNoneMatch(entityTag string) *PostalCodesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PostalCodesGetCall) Context(ctx context.Context) *PostalCodesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PostalCodesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/postalCodes/{code}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "code": c.code,
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.postalCodes.get" call.
-// Exactly one of *PostalCode or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *PostalCode.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *PostalCodesGetCall) Do() (*PostalCode, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PostalCode{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one postal code by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.postalCodes.get",
- // "parameterOrder": [
- // "profileId",
- // "code"
- // ],
- // "parameters": {
- // "code": {
- // "description": "Postal code ID.",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/postalCodes/{code}",
- // "response": {
- // "$ref": "PostalCode"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.postalCodes.list":
-
-type PostalCodesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of postal codes.
-func (r *PostalCodesService) List(profileId int64) *PostalCodesListCall {
- c := &PostalCodesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *PostalCodesListCall) Fields(s ...googleapi.Field) *PostalCodesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *PostalCodesListCall) IfNoneMatch(entityTag string) *PostalCodesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *PostalCodesListCall) Context(ctx context.Context) *PostalCodesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *PostalCodesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/postalCodes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.postalCodes.list" call.
-// Exactly one of *PostalCodesListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *PostalCodesListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *PostalCodesListCall) Do() (*PostalCodesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PostalCodesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of postal codes.",
- // "httpMethod": "GET",
- // "id": "dfareporting.postalCodes.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/postalCodes",
- // "response": {
- // "$ref": "PostalCodesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.projects.get":
-
-type ProjectsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one project by ID.
-func (r *ProjectsService) Get(profileId int64, id int64) *ProjectsGetCall {
- c := &ProjectsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsGetCall) Fields(s ...googleapi.Field) *ProjectsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ProjectsGetCall) IfNoneMatch(entityTag string) *ProjectsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsGetCall) Context(ctx context.Context) *ProjectsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/projects/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.projects.get" call.
-// Exactly one of *Project or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Project.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ProjectsGetCall) Do() (*Project, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Project{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one project by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.projects.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Project ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/projects/{id}",
- // "response": {
- // "$ref": "Project"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.projects.list":
-
-type ProjectsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of projects, possibly filtered.
-func (r *ProjectsService) List(profileId int64) *ProjectsListCall {
- c := &ProjectsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// AdvertiserIds sets the optional parameter "advertiserIds": Select
-// only projects with these advertiser IDs.
-func (c *ProjectsListCall) AdvertiserIds(advertiserIds int64) *ProjectsListCall {
- c.opt_["advertiserIds"] = advertiserIds
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only projects with
-// these IDs.
-func (c *ProjectsListCall) Ids(ids int64) *ProjectsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *ProjectsListCall) MaxResults(maxResults int64) *ProjectsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *ProjectsListCall) PageToken(pageToken string) *ProjectsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for projects by name or ID. Wildcards (*) are allowed. For
-// example, "project*2015" will return projects with names like "project
-// June 2015", "project April 2015", or simply "project 2015". Most of
-// the searches also add wildcards implicitly at the start and the end
-// of the search string. For example, a search string of "project" will
-// match projects with name "my project", "project 2015", or simply
-// "project".
-func (c *ProjectsListCall) SearchString(searchString string) *ProjectsListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *ProjectsListCall) SortField(sortField string) *ProjectsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *ProjectsListCall) SortOrder(sortOrder string) *ProjectsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsListCall) Fields(s ...googleapi.Field) *ProjectsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ProjectsListCall) IfNoneMatch(entityTag string) *ProjectsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ProjectsListCall) Context(ctx context.Context) *ProjectsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ProjectsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["advertiserIds"]; ok {
- params.Set("advertiserIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/projects")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.projects.list" call.
-// Exactly one of *ProjectsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *ProjectsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ProjectsListCall) Do() (*ProjectsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ProjectsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of projects, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.projects.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "advertiserIds": {
- // "description": "Select only projects with these advertiser IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only projects with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, \"project*2015\" will return projects with names like \"project June 2015\", \"project April 2015\", or simply \"project 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"project\" will match projects with name \"my project\", \"project 2015\", or simply \"project\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/projects",
- // "response": {
- // "$ref": "ProjectsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.regions.list":
-
-type RegionsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of regions.
-func (r *RegionsService) List(profileId int64) *RegionsListCall {
- c := &RegionsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RegionsListCall) Fields(s ...googleapi.Field) *RegionsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *RegionsListCall) IfNoneMatch(entityTag string) *RegionsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RegionsListCall) Context(ctx context.Context) *RegionsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RegionsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/regions")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.regions.list" call.
-// Exactly one of *RegionsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *RegionsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *RegionsListCall) Do() (*RegionsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &RegionsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of regions.",
- // "httpMethod": "GET",
- // "id": "dfareporting.regions.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/regions",
- // "response": {
- // "$ref": "RegionsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.remarketingListShares.get":
-
-type RemarketingListSharesGetCall struct {
- s *Service
- profileId int64
- remarketingListId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one remarketing list share by remarketing list ID.
-func (r *RemarketingListSharesService) Get(profileId int64, remarketingListId int64) *RemarketingListSharesGetCall {
- c := &RemarketingListSharesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.remarketingListId = remarketingListId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RemarketingListSharesGetCall) Fields(s ...googleapi.Field) *RemarketingListSharesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *RemarketingListSharesGetCall) IfNoneMatch(entityTag string) *RemarketingListSharesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RemarketingListSharesGetCall) Context(ctx context.Context) *RemarketingListSharesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RemarketingListSharesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/remarketingListShares/{remarketingListId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "remarketingListId": strconv.FormatInt(c.remarketingListId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.remarketingListShares.get" call.
-// Exactly one of *RemarketingListShare or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *RemarketingListShare.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *RemarketingListSharesGetCall) Do() (*RemarketingListShare, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &RemarketingListShare{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one remarketing list share by remarketing list ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.remarketingListShares.get",
- // "parameterOrder": [
- // "profileId",
- // "remarketingListId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "remarketingListId": {
- // "description": "Remarketing list ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/remarketingListShares/{remarketingListId}",
- // "response": {
- // "$ref": "RemarketingListShare"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.remarketingListShares.patch":
-
-type RemarketingListSharesPatchCall struct {
- s *Service
- profileId int64
- remarketingListId int64
- remarketinglistshare *RemarketingListShare
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing remarketing list share. This method
-// supports patch semantics.
-func (r *RemarketingListSharesService) Patch(profileId int64, remarketingListId int64, remarketinglistshare *RemarketingListShare) *RemarketingListSharesPatchCall {
- c := &RemarketingListSharesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.remarketingListId = remarketingListId
- c.remarketinglistshare = remarketinglistshare
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RemarketingListSharesPatchCall) Fields(s ...googleapi.Field) *RemarketingListSharesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RemarketingListSharesPatchCall) Context(ctx context.Context) *RemarketingListSharesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RemarketingListSharesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.remarketinglistshare)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("remarketingListId", fmt.Sprintf("%v", c.remarketingListId))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/remarketingListShares")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.remarketingListShares.patch" call.
-// Exactly one of *RemarketingListShare or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *RemarketingListShare.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *RemarketingListSharesPatchCall) Do() (*RemarketingListShare, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &RemarketingListShare{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing remarketing list share. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.remarketingListShares.patch",
- // "parameterOrder": [
- // "profileId",
- // "remarketingListId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "remarketingListId": {
- // "description": "Remarketing list ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/remarketingListShares",
- // "request": {
- // "$ref": "RemarketingListShare"
- // },
- // "response": {
- // "$ref": "RemarketingListShare"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.remarketingListShares.update":
-
-type RemarketingListSharesUpdateCall struct {
- s *Service
- profileId int64
- remarketinglistshare *RemarketingListShare
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing remarketing list share.
-func (r *RemarketingListSharesService) Update(profileId int64, remarketinglistshare *RemarketingListShare) *RemarketingListSharesUpdateCall {
- c := &RemarketingListSharesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.remarketinglistshare = remarketinglistshare
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RemarketingListSharesUpdateCall) Fields(s ...googleapi.Field) *RemarketingListSharesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RemarketingListSharesUpdateCall) Context(ctx context.Context) *RemarketingListSharesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RemarketingListSharesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.remarketinglistshare)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/remarketingListShares")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.remarketingListShares.update" call.
-// Exactly one of *RemarketingListShare or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *RemarketingListShare.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *RemarketingListSharesUpdateCall) Do() (*RemarketingListShare, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &RemarketingListShare{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing remarketing list share.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.remarketingListShares.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/remarketingListShares",
- // "request": {
- // "$ref": "RemarketingListShare"
- // },
- // "response": {
- // "$ref": "RemarketingListShare"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.remarketingLists.get":
-
-type RemarketingListsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one remarketing list by ID.
-func (r *RemarketingListsService) Get(profileId int64, id int64) *RemarketingListsGetCall {
- c := &RemarketingListsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RemarketingListsGetCall) Fields(s ...googleapi.Field) *RemarketingListsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *RemarketingListsGetCall) IfNoneMatch(entityTag string) *RemarketingListsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RemarketingListsGetCall) Context(ctx context.Context) *RemarketingListsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RemarketingListsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/remarketingLists/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.remarketingLists.get" call.
-// Exactly one of *RemarketingList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *RemarketingList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *RemarketingListsGetCall) Do() (*RemarketingList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &RemarketingList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one remarketing list by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.remarketingLists.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Remarketing list ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/remarketingLists/{id}",
- // "response": {
- // "$ref": "RemarketingList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.remarketingLists.insert":
-
-type RemarketingListsInsertCall struct {
- s *Service
- profileId int64
- remarketinglist *RemarketingList
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new remarketing list.
-func (r *RemarketingListsService) Insert(profileId int64, remarketinglist *RemarketingList) *RemarketingListsInsertCall {
- c := &RemarketingListsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.remarketinglist = remarketinglist
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RemarketingListsInsertCall) Fields(s ...googleapi.Field) *RemarketingListsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RemarketingListsInsertCall) Context(ctx context.Context) *RemarketingListsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RemarketingListsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.remarketinglist)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/remarketingLists")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.remarketingLists.insert" call.
-// Exactly one of *RemarketingList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *RemarketingList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *RemarketingListsInsertCall) Do() (*RemarketingList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &RemarketingList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new remarketing list.",
- // "httpMethod": "POST",
- // "id": "dfareporting.remarketingLists.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/remarketingLists",
- // "request": {
- // "$ref": "RemarketingList"
- // },
- // "response": {
- // "$ref": "RemarketingList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.remarketingLists.list":
-
-type RemarketingListsListCall struct {
- s *Service
- profileId int64
- advertiserId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of remarketing lists, possibly filtered.
-func (r *RemarketingListsService) List(profileId int64, advertiserId int64) *RemarketingListsListCall {
- c := &RemarketingListsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.advertiserId = advertiserId
- return c
-}
-
-// Active sets the optional parameter "active": Select only active or
-// only inactive remarketing lists.
-func (c *RemarketingListsListCall) Active(active bool) *RemarketingListsListCall {
- c.opt_["active"] = active
- return c
-}
-
-// FloodlightActivityId sets the optional parameter
-// "floodlightActivityId": Select only remarketing lists that have this
-// floodlight activity ID.
-func (c *RemarketingListsListCall) FloodlightActivityId(floodlightActivityId int64) *RemarketingListsListCall {
- c.opt_["floodlightActivityId"] = floodlightActivityId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *RemarketingListsListCall) MaxResults(maxResults int64) *RemarketingListsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// Name sets the optional parameter "name": Allows searching for objects
-// by name or ID. Wildcards (*) are allowed. For example, "remarketing
-// list*2015" will return objects with names like "remarketing list June
-// 2015", "remarketing list April 2015", or simply "remarketing list
-// 2015". Most of the searches also add wildcards implicitly at the
-// start and the end of the search string. For example, a search string
-// of "remarketing list" will match objects with name "my remarketing
-// list", "remarketing list 2015", or simply "remarketing list".
-func (c *RemarketingListsListCall) Name(name string) *RemarketingListsListCall {
- c.opt_["name"] = name
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *RemarketingListsListCall) PageToken(pageToken string) *RemarketingListsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *RemarketingListsListCall) SortField(sortField string) *RemarketingListsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *RemarketingListsListCall) SortOrder(sortOrder string) *RemarketingListsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RemarketingListsListCall) Fields(s ...googleapi.Field) *RemarketingListsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *RemarketingListsListCall) IfNoneMatch(entityTag string) *RemarketingListsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RemarketingListsListCall) Context(ctx context.Context) *RemarketingListsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RemarketingListsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("advertiserId", fmt.Sprintf("%v", c.advertiserId))
- if v, ok := c.opt_["active"]; ok {
- params.Set("active", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["floodlightActivityId"]; ok {
- params.Set("floodlightActivityId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["name"]; ok {
- params.Set("name", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/remarketingLists")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.remarketingLists.list" call.
-// Exactly one of *RemarketingListsListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *RemarketingListsListResponse.ServerResponse.Header or (if a
-// response was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *RemarketingListsListCall) Do() (*RemarketingListsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &RemarketingListsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of remarketing lists, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.remarketingLists.list",
- // "parameterOrder": [
- // "profileId",
- // "advertiserId"
- // ],
- // "parameters": {
- // "active": {
- // "description": "Select only active or only inactive remarketing lists.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "advertiserId": {
- // "description": "Select only remarketing lists owned by this advertiser.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "floodlightActivityId": {
- // "description": "Select only remarketing lists that have this floodlight activity ID.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "name": {
- // "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"remarketing list*2015\" will return objects with names like \"remarketing list June 2015\", \"remarketing list April 2015\", or simply \"remarketing list 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"remarketing list\" will match objects with name \"my remarketing list\", \"remarketing list 2015\", or simply \"remarketing list\".",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/remarketingLists",
- // "response": {
- // "$ref": "RemarketingListsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.remarketingLists.patch":
-
-type RemarketingListsPatchCall struct {
- s *Service
- profileId int64
- id int64
- remarketinglist *RemarketingList
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing remarketing list. This method supports
-// patch semantics.
-func (r *RemarketingListsService) Patch(profileId int64, id int64, remarketinglist *RemarketingList) *RemarketingListsPatchCall {
- c := &RemarketingListsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.remarketinglist = remarketinglist
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RemarketingListsPatchCall) Fields(s ...googleapi.Field) *RemarketingListsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RemarketingListsPatchCall) Context(ctx context.Context) *RemarketingListsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RemarketingListsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.remarketinglist)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/remarketingLists")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.remarketingLists.patch" call.
-// Exactly one of *RemarketingList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *RemarketingList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *RemarketingListsPatchCall) Do() (*RemarketingList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &RemarketingList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing remarketing list. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.remarketingLists.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Remarketing list ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/remarketingLists",
- // "request": {
- // "$ref": "RemarketingList"
- // },
- // "response": {
- // "$ref": "RemarketingList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.remarketingLists.update":
-
-type RemarketingListsUpdateCall struct {
- s *Service
- profileId int64
- remarketinglist *RemarketingList
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing remarketing list.
-func (r *RemarketingListsService) Update(profileId int64, remarketinglist *RemarketingList) *RemarketingListsUpdateCall {
- c := &RemarketingListsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.remarketinglist = remarketinglist
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *RemarketingListsUpdateCall) Fields(s ...googleapi.Field) *RemarketingListsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *RemarketingListsUpdateCall) Context(ctx context.Context) *RemarketingListsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *RemarketingListsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.remarketinglist)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/remarketingLists")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.remarketingLists.update" call.
-// Exactly one of *RemarketingList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *RemarketingList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *RemarketingListsUpdateCall) Do() (*RemarketingList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &RemarketingList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing remarketing list.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.remarketingLists.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/remarketingLists",
- // "request": {
- // "$ref": "RemarketingList"
- // },
- // "response": {
- // "$ref": "RemarketingList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.delete":
-
-type ReportsDeleteCall struct {
- s *Service
- profileId int64
- reportId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes a report by its ID.
-func (r *ReportsService) Delete(profileId int64, reportId int64) *ReportsDeleteCall {
- c := &ReportsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsDeleteCall) Fields(s ...googleapi.Field) *ReportsDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsDeleteCall) Context(ctx context.Context) *ReportsDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.delete" call.
-func (c *ReportsDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes a report by its ID.",
- // "httpMethod": "DELETE",
- // "id": "dfareporting.reports.delete",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}",
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.get":
-
-type ReportsGetCall struct {
- s *Service
- profileId int64
- reportId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves a report by its ID.
-func (r *ReportsService) Get(profileId int64, reportId int64) *ReportsGetCall {
- c := &ReportsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsGetCall) Fields(s ...googleapi.Field) *ReportsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsGetCall) IfNoneMatch(entityTag string) *ReportsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsGetCall) Context(ctx context.Context) *ReportsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.get" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsGetCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a report by its ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.reports.get",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}",
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.insert":
-
-type ReportsInsertCall struct {
- s *Service
- profileId int64
- report *Report
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Creates a report.
-func (r *ReportsService) Insert(profileId int64, report *Report) *ReportsInsertCall {
- c := &ReportsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.report = report
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsInsertCall) Fields(s ...googleapi.Field) *ReportsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsInsertCall) Context(ctx context.Context) *ReportsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.report)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.insert" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsInsertCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Creates a report.",
- // "httpMethod": "POST",
- // "id": "dfareporting.reports.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports",
- // "request": {
- // "$ref": "Report"
- // },
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.list":
-
-type ReportsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves list of reports.
-func (r *ReportsService) List(profileId int64) *ReportsListCall {
- c := &ReportsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *ReportsListCall) MaxResults(maxResults int64) *ReportsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous result page.
-func (c *ReportsListCall) PageToken(pageToken string) *ReportsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// Scope sets the optional parameter "scope": The scope that defines
-// which results are returned, default is 'MINE'.
-//
-// Possible values:
-// "ALL" - All reports in account.
-// "MINE" (default) - My reports.
-func (c *ReportsListCall) Scope(scope string) *ReportsListCall {
- c.opt_["scope"] = scope
- return c
-}
-
-// SortField sets the optional parameter "sortField": The field by which
-// to sort the list.
-//
-// Possible values:
-// "ID" - Sort by report ID.
-// "LAST_MODIFIED_TIME" (default) - Sort by 'lastModifiedTime' field.
-// "NAME" - Sort by name of reports.
-func (c *ReportsListCall) SortField(sortField string) *ReportsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is 'DESCENDING'.
-//
-// Possible values:
-// "ASCENDING" - Ascending order.
-// "DESCENDING" (default) - Descending order.
-func (c *ReportsListCall) SortOrder(sortOrder string) *ReportsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsListCall) Fields(s ...googleapi.Field) *ReportsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsListCall) IfNoneMatch(entityTag string) *ReportsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsListCall) Context(ctx context.Context) *ReportsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["scope"]; ok {
- params.Set("scope", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.list" call.
-// Exactly one of *ReportList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *ReportList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ReportsListCall) Do() (*ReportList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &ReportList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves list of reports.",
- // "httpMethod": "GET",
- // "id": "dfareporting.reports.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "scope": {
- // "default": "MINE",
- // "description": "The scope that defines which results are returned, default is 'MINE'.",
- // "enum": [
- // "ALL",
- // "MINE"
- // ],
- // "enumDescriptions": [
- // "All reports in account.",
- // "My reports."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "default": "LAST_MODIFIED_TIME",
- // "description": "The field by which to sort the list.",
- // "enum": [
- // "ID",
- // "LAST_MODIFIED_TIME",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "Sort by report ID.",
- // "Sort by 'lastModifiedTime' field.",
- // "Sort by name of reports."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "default": "DESCENDING",
- // "description": "Order of sorted results, default is 'DESCENDING'.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "Ascending order.",
- // "Descending order."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports",
- // "response": {
- // "$ref": "ReportList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.patch":
-
-type ReportsPatchCall struct {
- s *Service
- profileId int64
- reportId int64
- report *Report
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates a report. This method supports patch semantics.
-func (r *ReportsService) Patch(profileId int64, reportId int64, report *Report) *ReportsPatchCall {
- c := &ReportsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- c.report = report
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsPatchCall) Fields(s ...googleapi.Field) *ReportsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsPatchCall) Context(ctx context.Context) *ReportsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.report)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.patch" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsPatchCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a report. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.reports.patch",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}",
- // "request": {
- // "$ref": "Report"
- // },
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.run":
-
-type ReportsRunCall struct {
- s *Service
- profileId int64
- reportId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Run: Runs a report.
-func (r *ReportsService) Run(profileId int64, reportId int64) *ReportsRunCall {
- c := &ReportsRunCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- return c
-}
-
-// Synchronous sets the optional parameter "synchronous": If set and
-// true, tries to run the report synchronously.
-func (c *ReportsRunCall) Synchronous(synchronous bool) *ReportsRunCall {
- c.opt_["synchronous"] = synchronous
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsRunCall) Fields(s ...googleapi.Field) *ReportsRunCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsRunCall) Context(ctx context.Context) *ReportsRunCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsRunCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["synchronous"]; ok {
- params.Set("synchronous", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}/run")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.run" call.
-// Exactly one of *File or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *File.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *ReportsRunCall) Do() (*File, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &File{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Runs a report.",
- // "httpMethod": "POST",
- // "id": "dfareporting.reports.run",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "synchronous": {
- // "description": "If set and true, tries to run the report synchronously.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}/run",
- // "response": {
- // "$ref": "File"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.update":
-
-type ReportsUpdateCall struct {
- s *Service
- profileId int64
- reportId int64
- report *Report
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates a report.
-func (r *ReportsService) Update(profileId int64, reportId int64, report *Report) *ReportsUpdateCall {
- c := &ReportsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- c.report = report
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsUpdateCall) Fields(s ...googleapi.Field) *ReportsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsUpdateCall) Context(ctx context.Context) *ReportsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.report)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.update" call.
-// Exactly one of *Report or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Report.ServerResponse.Header or (if a response was returned at all)
-// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
-// check whether the returned error was because http.StatusNotModified
-// was returned.
-func (c *ReportsUpdateCall) Do() (*Report, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Report{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates a report.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.reports.update",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}",
- // "request": {
- // "$ref": "Report"
- // },
- // "response": {
- // "$ref": "Report"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.compatibleFields.query":
-
-type ReportsCompatibleFieldsQueryCall struct {
- s *Service
- profileId int64
- report *Report
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Query: Returns the fields that are compatible to be selected in the
-// respective sections of a report criteria, given the fields already
-// selected in the input report and user permissions.
-func (r *ReportsCompatibleFieldsService) Query(profileId int64, report *Report) *ReportsCompatibleFieldsQueryCall {
- c := &ReportsCompatibleFieldsQueryCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.report = report
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsCompatibleFieldsQueryCall) Fields(s ...googleapi.Field) *ReportsCompatibleFieldsQueryCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsCompatibleFieldsQueryCall) Context(ctx context.Context) *ReportsCompatibleFieldsQueryCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsCompatibleFieldsQueryCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.report)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/compatiblefields/query")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.compatibleFields.query" call.
-// Exactly one of *CompatibleFields or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *CompatibleFields.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ReportsCompatibleFieldsQueryCall) Do() (*CompatibleFields, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &CompatibleFields{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.",
- // "httpMethod": "POST",
- // "id": "dfareporting.reports.compatibleFields.query",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The DFA user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/compatiblefields/query",
- // "request": {
- // "$ref": "Report"
- // },
- // "response": {
- // "$ref": "CompatibleFields"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.reports.files.get":
-
-type ReportsFilesGetCall struct {
- s *Service
- profileId int64
- reportId int64
- fileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Retrieves a report file.
-func (r *ReportsFilesService) Get(profileId int64, reportId int64, fileId int64) *ReportsFilesGetCall {
- c := &ReportsFilesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- c.fileId = fileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsFilesGetCall) Fields(s ...googleapi.Field) *ReportsFilesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsFilesGetCall) IfNoneMatch(entityTag string) *ReportsFilesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do and Download methods.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsFilesGetCall) Context(ctx context.Context) *ReportsFilesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsFilesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}/files/{fileId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- "fileId": strconv.FormatInt(c.fileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Download fetches the API endpoint's "media" value, instead of the normal
-// API response value. If the returned error is nil, the Response is guaranteed to
-// have a 2xx status code. Callers must close the Response.Body as usual.
-func (c *ReportsFilesGetCall) Download() (*http.Response, error) {
- res, err := c.doRequest("media")
- if err != nil {
- return nil, err
- }
- if err := googleapi.CheckMediaResponse(res); err != nil {
- res.Body.Close()
- return nil, err
- }
- return res, nil
-}
-
-// Do executes the "dfareporting.reports.files.get" call.
-// Exactly one of *File or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *File.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *ReportsFilesGetCall) Do() (*File, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &File{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a report file.",
- // "httpMethod": "GET",
- // "id": "dfareporting.reports.files.get",
- // "parameterOrder": [
- // "profileId",
- // "reportId",
- // "fileId"
- // ],
- // "parameters": {
- // "fileId": {
- // "description": "The ID of the report file.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}/files/{fileId}",
- // "response": {
- // "$ref": "File"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ],
- // "supportsMediaDownload": true
- // }
-
-}
-
-// method id "dfareporting.reports.files.list":
-
-type ReportsFilesListCall struct {
- s *Service
- profileId int64
- reportId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Lists files for a report.
-func (r *ReportsFilesService) List(profileId int64, reportId int64) *ReportsFilesListCall {
- c := &ReportsFilesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.reportId = reportId
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *ReportsFilesListCall) MaxResults(maxResults int64) *ReportsFilesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": The value of the
-// nextToken from the previous result page.
-func (c *ReportsFilesListCall) PageToken(pageToken string) *ReportsFilesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SortField sets the optional parameter "sortField": The field by which
-// to sort the list.
-//
-// Possible values:
-// "ID" - Sort by file ID.
-// "LAST_MODIFIED_TIME" (default) - Sort by 'lastmodifiedAt' field.
-func (c *ReportsFilesListCall) SortField(sortField string) *ReportsFilesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is 'DESCENDING'.
-//
-// Possible values:
-// "ASCENDING" - Ascending order.
-// "DESCENDING" (default) - Descending order.
-func (c *ReportsFilesListCall) SortOrder(sortOrder string) *ReportsFilesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ReportsFilesListCall) Fields(s ...googleapi.Field) *ReportsFilesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *ReportsFilesListCall) IfNoneMatch(entityTag string) *ReportsFilesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *ReportsFilesListCall) Context(ctx context.Context) *ReportsFilesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *ReportsFilesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/reports/{reportId}/files")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "reportId": strconv.FormatInt(c.reportId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.reports.files.list" call.
-// Exactly one of *FileList or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *FileList.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *ReportsFilesListCall) Do() (*FileList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &FileList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Lists files for a report.",
- // "httpMethod": "GET",
- // "id": "dfareporting.reports.files.list",
- // "parameterOrder": [
- // "profileId",
- // "reportId"
- // ],
- // "parameters": {
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "maximum": "10",
- // "minimum": "0",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "The value of the nextToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "The DFA profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "reportId": {
- // "description": "The ID of the parent report.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "sortField": {
- // "default": "LAST_MODIFIED_TIME",
- // "description": "The field by which to sort the list.",
- // "enum": [
- // "ID",
- // "LAST_MODIFIED_TIME"
- // ],
- // "enumDescriptions": [
- // "Sort by file ID.",
- // "Sort by 'lastmodifiedAt' field."
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "default": "DESCENDING",
- // "description": "Order of sorted results, default is 'DESCENDING'.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "Ascending order.",
- // "Descending order."
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/reports/{reportId}/files",
- // "response": {
- // "$ref": "FileList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting"
- // ]
- // }
-
-}
-
-// method id "dfareporting.sites.get":
-
-type SitesGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one site by ID.
-func (r *SitesService) Get(profileId int64, id int64) *SitesGetCall {
- c := &SitesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SitesGetCall) Fields(s ...googleapi.Field) *SitesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SitesGetCall) IfNoneMatch(entityTag string) *SitesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SitesGetCall) Context(ctx context.Context) *SitesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SitesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/sites/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.sites.get" call.
-// Exactly one of *Site or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Site.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *SitesGetCall) Do() (*Site, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Site{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one site by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.sites.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Site ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/sites/{id}",
- // "response": {
- // "$ref": "Site"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.sites.insert":
-
-type SitesInsertCall struct {
- s *Service
- profileId int64
- site *Site
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new site.
-func (r *SitesService) Insert(profileId int64, site *Site) *SitesInsertCall {
- c := &SitesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.site = site
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SitesInsertCall) Fields(s ...googleapi.Field) *SitesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SitesInsertCall) Context(ctx context.Context) *SitesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SitesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.site)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/sites")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.sites.insert" call.
-// Exactly one of *Site or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Site.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *SitesInsertCall) Do() (*Site, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Site{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new site.",
- // "httpMethod": "POST",
- // "id": "dfareporting.sites.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/sites",
- // "request": {
- // "$ref": "Site"
- // },
- // "response": {
- // "$ref": "Site"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.sites.list":
-
-type SitesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of sites, possibly filtered.
-func (r *SitesService) List(profileId int64) *SitesListCall {
- c := &SitesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// AcceptsInStreamVideoPlacements sets the optional parameter
-// "acceptsInStreamVideoPlacements": This search filter is no longer
-// supported and will have no effect on the results returned.
-func (c *SitesListCall) AcceptsInStreamVideoPlacements(acceptsInStreamVideoPlacements bool) *SitesListCall {
- c.opt_["acceptsInStreamVideoPlacements"] = acceptsInStreamVideoPlacements
- return c
-}
-
-// AcceptsInterstitialPlacements sets the optional parameter
-// "acceptsInterstitialPlacements": This search filter is no longer
-// supported and will have no effect on the results returned.
-func (c *SitesListCall) AcceptsInterstitialPlacements(acceptsInterstitialPlacements bool) *SitesListCall {
- c.opt_["acceptsInterstitialPlacements"] = acceptsInterstitialPlacements
- return c
-}
-
-// AcceptsPublisherPaidPlacements sets the optional parameter
-// "acceptsPublisherPaidPlacements": Select only sites that accept
-// publisher paid placements.
-func (c *SitesListCall) AcceptsPublisherPaidPlacements(acceptsPublisherPaidPlacements bool) *SitesListCall {
- c.opt_["acceptsPublisherPaidPlacements"] = acceptsPublisherPaidPlacements
- return c
-}
-
-// AdWordsSite sets the optional parameter "adWordsSite": Select only
-// AdWords sites.
-func (c *SitesListCall) AdWordsSite(adWordsSite bool) *SitesListCall {
- c.opt_["adWordsSite"] = adWordsSite
- return c
-}
-
-// Approved sets the optional parameter "approved": Select only approved
-// sites.
-func (c *SitesListCall) Approved(approved bool) *SitesListCall {
- c.opt_["approved"] = approved
- return c
-}
-
-// CampaignIds sets the optional parameter "campaignIds": Select only
-// sites with these campaign IDs.
-func (c *SitesListCall) CampaignIds(campaignIds int64) *SitesListCall {
- c.opt_["campaignIds"] = campaignIds
- return c
-}
-
-// DirectorySiteIds sets the optional parameter "directorySiteIds":
-// Select only sites with these directory site IDs.
-func (c *SitesListCall) DirectorySiteIds(directorySiteIds int64) *SitesListCall {
- c.opt_["directorySiteIds"] = directorySiteIds
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only sites with these
-// IDs.
-func (c *SitesListCall) Ids(ids int64) *SitesListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *SitesListCall) MaxResults(maxResults int64) *SitesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *SitesListCall) PageToken(pageToken string) *SitesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name, ID or keyName. Wildcards (*) are
-// allowed. For example, "site*2015" will return objects with names like
-// "site June 2015", "site April 2015", or simply "site 2015". Most of
-// the searches also add wildcards implicitly at the start and the end
-// of the search string. For example, a search string of "site" will
-// match objects with name "my site", "site 2015", or simply "site".
-func (c *SitesListCall) SearchString(searchString string) *SitesListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *SitesListCall) SortField(sortField string) *SitesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *SitesListCall) SortOrder(sortOrder string) *SitesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// SubaccountId sets the optional parameter "subaccountId": Select only
-// sites with this subaccount ID.
-func (c *SitesListCall) SubaccountId(subaccountId int64) *SitesListCall {
- c.opt_["subaccountId"] = subaccountId
- return c
-}
-
-// UnmappedSite sets the optional parameter "unmappedSite": Select only
-// sites that have not been mapped to a directory site.
-func (c *SitesListCall) UnmappedSite(unmappedSite bool) *SitesListCall {
- c.opt_["unmappedSite"] = unmappedSite
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SitesListCall) Fields(s ...googleapi.Field) *SitesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SitesListCall) IfNoneMatch(entityTag string) *SitesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SitesListCall) Context(ctx context.Context) *SitesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SitesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["acceptsInStreamVideoPlacements"]; ok {
- params.Set("acceptsInStreamVideoPlacements", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["acceptsInterstitialPlacements"]; ok {
- params.Set("acceptsInterstitialPlacements", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["acceptsPublisherPaidPlacements"]; ok {
- params.Set("acceptsPublisherPaidPlacements", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["adWordsSite"]; ok {
- params.Set("adWordsSite", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["approved"]; ok {
- params.Set("approved", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["campaignIds"]; ok {
- params.Set("campaignIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["directorySiteIds"]; ok {
- params.Set("directorySiteIds", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["subaccountId"]; ok {
- params.Set("subaccountId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["unmappedSite"]; ok {
- params.Set("unmappedSite", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/sites")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.sites.list" call.
-// Exactly one of *SitesListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *SitesListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *SitesListCall) Do() (*SitesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SitesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of sites, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.sites.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "acceptsInStreamVideoPlacements": {
- // "description": "This search filter is no longer supported and will have no effect on the results returned.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "acceptsInterstitialPlacements": {
- // "description": "This search filter is no longer supported and will have no effect on the results returned.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "acceptsPublisherPaidPlacements": {
- // "description": "Select only sites that accept publisher paid placements.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "adWordsSite": {
- // "description": "Select only AdWords sites.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "approved": {
- // "description": "Select only approved sites.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "campaignIds": {
- // "description": "Select only sites with these campaign IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "directorySiteIds": {
- // "description": "Select only sites with these directory site IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "ids": {
- // "description": "Select only sites with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, \"site*2015\" will return objects with names like \"site June 2015\", \"site April 2015\", or simply \"site 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"site\" will match objects with name \"my site\", \"site 2015\", or simply \"site\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "subaccountId": {
- // "description": "Select only sites with this subaccount ID.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // },
- // "unmappedSite": {
- // "description": "Select only sites that have not been mapped to a directory site.",
- // "location": "query",
- // "type": "boolean"
- // }
- // },
- // "path": "userprofiles/{profileId}/sites",
- // "response": {
- // "$ref": "SitesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.sites.patch":
-
-type SitesPatchCall struct {
- s *Service
- profileId int64
- id int64
- site *Site
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing site. This method supports patch
-// semantics.
-func (r *SitesService) Patch(profileId int64, id int64, site *Site) *SitesPatchCall {
- c := &SitesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.site = site
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SitesPatchCall) Fields(s ...googleapi.Field) *SitesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SitesPatchCall) Context(ctx context.Context) *SitesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SitesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.site)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/sites")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.sites.patch" call.
-// Exactly one of *Site or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Site.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *SitesPatchCall) Do() (*Site, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Site{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing site. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.sites.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Site ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/sites",
- // "request": {
- // "$ref": "Site"
- // },
- // "response": {
- // "$ref": "Site"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.sites.update":
-
-type SitesUpdateCall struct {
- s *Service
- profileId int64
- site *Site
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing site.
-func (r *SitesService) Update(profileId int64, site *Site) *SitesUpdateCall {
- c := &SitesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.site = site
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SitesUpdateCall) Fields(s ...googleapi.Field) *SitesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SitesUpdateCall) Context(ctx context.Context) *SitesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SitesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.site)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/sites")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.sites.update" call.
-// Exactly one of *Site or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Site.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *SitesUpdateCall) Do() (*Site, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Site{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing site.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.sites.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/sites",
- // "request": {
- // "$ref": "Site"
- // },
- // "response": {
- // "$ref": "Site"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.sizes.get":
-
-type SizesGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one size by ID.
-func (r *SizesService) Get(profileId int64, id int64) *SizesGetCall {
- c := &SizesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SizesGetCall) Fields(s ...googleapi.Field) *SizesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SizesGetCall) IfNoneMatch(entityTag string) *SizesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SizesGetCall) Context(ctx context.Context) *SizesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SizesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/sizes/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.sizes.get" call.
-// Exactly one of *Size or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Size.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *SizesGetCall) Do() (*Size, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Size{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one size by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.sizes.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Size ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/sizes/{id}",
- // "response": {
- // "$ref": "Size"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.sizes.insert":
-
-type SizesInsertCall struct {
- s *Service
- profileId int64
- size *Size
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new size.
-func (r *SizesService) Insert(profileId int64, size *Size) *SizesInsertCall {
- c := &SizesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.size = size
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SizesInsertCall) Fields(s ...googleapi.Field) *SizesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SizesInsertCall) Context(ctx context.Context) *SizesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SizesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.size)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/sizes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.sizes.insert" call.
-// Exactly one of *Size or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *Size.ServerResponse.Header or (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *SizesInsertCall) Do() (*Size, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Size{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new size.",
- // "httpMethod": "POST",
- // "id": "dfareporting.sizes.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/sizes",
- // "request": {
- // "$ref": "Size"
- // },
- // "response": {
- // "$ref": "Size"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.sizes.list":
-
-type SizesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of sizes, possibly filtered.
-func (r *SizesService) List(profileId int64) *SizesListCall {
- c := &SizesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Height sets the optional parameter "height": Select only sizes with
-// this height.
-func (c *SizesListCall) Height(height int64) *SizesListCall {
- c.opt_["height"] = height
- return c
-}
-
-// IabStandard sets the optional parameter "iabStandard": Select only
-// IAB standard sizes.
-func (c *SizesListCall) IabStandard(iabStandard bool) *SizesListCall {
- c.opt_["iabStandard"] = iabStandard
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only sizes with these
-// IDs.
-func (c *SizesListCall) Ids(ids int64) *SizesListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// Width sets the optional parameter "width": Select only sizes with
-// this width.
-func (c *SizesListCall) Width(width int64) *SizesListCall {
- c.opt_["width"] = width
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SizesListCall) Fields(s ...googleapi.Field) *SizesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SizesListCall) IfNoneMatch(entityTag string) *SizesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SizesListCall) Context(ctx context.Context) *SizesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SizesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["height"]; ok {
- params.Set("height", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["iabStandard"]; ok {
- params.Set("iabStandard", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["width"]; ok {
- params.Set("width", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/sizes")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.sizes.list" call.
-// Exactly one of *SizesListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *SizesListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *SizesListCall) Do() (*SizesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SizesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of sizes, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.sizes.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "height": {
- // "description": "Select only sizes with this height.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "iabStandard": {
- // "description": "Select only IAB standard sizes.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "ids": {
- // "description": "Select only sizes with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "width": {
- // "description": "Select only sizes with this width.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // }
- // },
- // "path": "userprofiles/{profileId}/sizes",
- // "response": {
- // "$ref": "SizesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.subaccounts.get":
-
-type SubaccountsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one subaccount by ID.
-func (r *SubaccountsService) Get(profileId int64, id int64) *SubaccountsGetCall {
- c := &SubaccountsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SubaccountsGetCall) Fields(s ...googleapi.Field) *SubaccountsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SubaccountsGetCall) IfNoneMatch(entityTag string) *SubaccountsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SubaccountsGetCall) Context(ctx context.Context) *SubaccountsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SubaccountsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/subaccounts/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.subaccounts.get" call.
-// Exactly one of *Subaccount or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Subaccount.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *SubaccountsGetCall) Do() (*Subaccount, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Subaccount{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one subaccount by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.subaccounts.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Subaccount ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/subaccounts/{id}",
- // "response": {
- // "$ref": "Subaccount"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.subaccounts.insert":
-
-type SubaccountsInsertCall struct {
- s *Service
- profileId int64
- subaccount *Subaccount
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new subaccount.
-func (r *SubaccountsService) Insert(profileId int64, subaccount *Subaccount) *SubaccountsInsertCall {
- c := &SubaccountsInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.subaccount = subaccount
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SubaccountsInsertCall) Fields(s ...googleapi.Field) *SubaccountsInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SubaccountsInsertCall) Context(ctx context.Context) *SubaccountsInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SubaccountsInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.subaccount)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/subaccounts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.subaccounts.insert" call.
-// Exactly one of *Subaccount or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Subaccount.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *SubaccountsInsertCall) Do() (*Subaccount, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Subaccount{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new subaccount.",
- // "httpMethod": "POST",
- // "id": "dfareporting.subaccounts.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/subaccounts",
- // "request": {
- // "$ref": "Subaccount"
- // },
- // "response": {
- // "$ref": "Subaccount"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.subaccounts.list":
-
-type SubaccountsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Gets a list of subaccounts, possibly filtered.
-func (r *SubaccountsService) List(profileId int64) *SubaccountsListCall {
- c := &SubaccountsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only subaccounts with
-// these IDs.
-func (c *SubaccountsListCall) Ids(ids int64) *SubaccountsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *SubaccountsListCall) MaxResults(maxResults int64) *SubaccountsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *SubaccountsListCall) PageToken(pageToken string) *SubaccountsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name or ID. Wildcards (*) are allowed. For
-// example, "subaccount*2015" will return objects with names like
-// "subaccount June 2015", "subaccount April 2015", or simply
-// "subaccount 2015". Most of the searches also add wildcards implicitly
-// at the start and the end of the search string. For example, a search
-// string of "subaccount" will match objects with name "my subaccount",
-// "subaccount 2015", or simply "subaccount".
-func (c *SubaccountsListCall) SearchString(searchString string) *SubaccountsListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *SubaccountsListCall) SortField(sortField string) *SubaccountsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *SubaccountsListCall) SortOrder(sortOrder string) *SubaccountsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SubaccountsListCall) Fields(s ...googleapi.Field) *SubaccountsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *SubaccountsListCall) IfNoneMatch(entityTag string) *SubaccountsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SubaccountsListCall) Context(ctx context.Context) *SubaccountsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SubaccountsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/subaccounts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.subaccounts.list" call.
-// Exactly one of *SubaccountsListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *SubaccountsListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *SubaccountsListCall) Do() (*SubaccountsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &SubaccountsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets a list of subaccounts, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.subaccounts.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "ids": {
- // "description": "Select only subaccounts with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"subaccount*2015\" will return objects with names like \"subaccount June 2015\", \"subaccount April 2015\", or simply \"subaccount 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"subaccount\" will match objects with name \"my subaccount\", \"subaccount 2015\", or simply \"subaccount\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/subaccounts",
- // "response": {
- // "$ref": "SubaccountsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.subaccounts.patch":
-
-type SubaccountsPatchCall struct {
- s *Service
- profileId int64
- id int64
- subaccount *Subaccount
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing subaccount. This method supports patch
-// semantics.
-func (r *SubaccountsService) Patch(profileId int64, id int64, subaccount *Subaccount) *SubaccountsPatchCall {
- c := &SubaccountsPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.subaccount = subaccount
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SubaccountsPatchCall) Fields(s ...googleapi.Field) *SubaccountsPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SubaccountsPatchCall) Context(ctx context.Context) *SubaccountsPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SubaccountsPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.subaccount)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/subaccounts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.subaccounts.patch" call.
-// Exactly one of *Subaccount or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Subaccount.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *SubaccountsPatchCall) Do() (*Subaccount, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Subaccount{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing subaccount. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.subaccounts.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Subaccount ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/subaccounts",
- // "request": {
- // "$ref": "Subaccount"
- // },
- // "response": {
- // "$ref": "Subaccount"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.subaccounts.update":
-
-type SubaccountsUpdateCall struct {
- s *Service
- profileId int64
- subaccount *Subaccount
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing subaccount.
-func (r *SubaccountsService) Update(profileId int64, subaccount *Subaccount) *SubaccountsUpdateCall {
- c := &SubaccountsUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.subaccount = subaccount
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *SubaccountsUpdateCall) Fields(s ...googleapi.Field) *SubaccountsUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *SubaccountsUpdateCall) Context(ctx context.Context) *SubaccountsUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *SubaccountsUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.subaccount)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/subaccounts")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.subaccounts.update" call.
-// Exactly one of *Subaccount or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *Subaccount.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *SubaccountsUpdateCall) Do() (*Subaccount, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &Subaccount{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing subaccount.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.subaccounts.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/subaccounts",
- // "request": {
- // "$ref": "Subaccount"
- // },
- // "response": {
- // "$ref": "Subaccount"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.targetableRemarketingLists.get":
-
-type TargetableRemarketingListsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one remarketing list by ID.
-func (r *TargetableRemarketingListsService) Get(profileId int64, id int64) *TargetableRemarketingListsGetCall {
- c := &TargetableRemarketingListsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetableRemarketingListsGetCall) Fields(s ...googleapi.Field) *TargetableRemarketingListsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TargetableRemarketingListsGetCall) IfNoneMatch(entityTag string) *TargetableRemarketingListsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetableRemarketingListsGetCall) Context(ctx context.Context) *TargetableRemarketingListsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetableRemarketingListsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/targetableRemarketingLists/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.targetableRemarketingLists.get" call.
-// Exactly one of *TargetableRemarketingList or error will be non-nil.
-// Any non-2xx status code is an error. Response headers are in either
-// *TargetableRemarketingList.ServerResponse.Header or (if a response
-// was returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TargetableRemarketingListsGetCall) Do() (*TargetableRemarketingList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetableRemarketingList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one remarketing list by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.targetableRemarketingLists.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "Remarketing list ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/targetableRemarketingLists/{id}",
- // "response": {
- // "$ref": "TargetableRemarketingList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.targetableRemarketingLists.list":
-
-type TargetableRemarketingListsListCall struct {
- s *Service
- profileId int64
- advertiserId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of targetable remarketing lists, possibly
-// filtered.
-func (r *TargetableRemarketingListsService) List(profileId int64, advertiserId int64) *TargetableRemarketingListsListCall {
- c := &TargetableRemarketingListsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.advertiserId = advertiserId
- return c
-}
-
-// Active sets the optional parameter "active": Select only active or
-// only inactive targetable remarketing lists.
-func (c *TargetableRemarketingListsListCall) Active(active bool) *TargetableRemarketingListsListCall {
- c.opt_["active"] = active
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *TargetableRemarketingListsListCall) MaxResults(maxResults int64) *TargetableRemarketingListsListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// Name sets the optional parameter "name": Allows searching for objects
-// by name or ID. Wildcards (*) are allowed. For example, "remarketing
-// list*2015" will return objects with names like "remarketing list June
-// 2015", "remarketing list April 2015", or simply "remarketing list
-// 2015". Most of the searches also add wildcards implicitly at the
-// start and the end of the search string. For example, a search string
-// of "remarketing list" will match objects with name "my remarketing
-// list", "remarketing list 2015", or simply "remarketing list".
-func (c *TargetableRemarketingListsListCall) Name(name string) *TargetableRemarketingListsListCall {
- c.opt_["name"] = name
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *TargetableRemarketingListsListCall) PageToken(pageToken string) *TargetableRemarketingListsListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *TargetableRemarketingListsListCall) SortField(sortField string) *TargetableRemarketingListsListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *TargetableRemarketingListsListCall) SortOrder(sortOrder string) *TargetableRemarketingListsListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *TargetableRemarketingListsListCall) Fields(s ...googleapi.Field) *TargetableRemarketingListsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *TargetableRemarketingListsListCall) IfNoneMatch(entityTag string) *TargetableRemarketingListsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *TargetableRemarketingListsListCall) Context(ctx context.Context) *TargetableRemarketingListsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *TargetableRemarketingListsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("advertiserId", fmt.Sprintf("%v", c.advertiserId))
- if v, ok := c.opt_["active"]; ok {
- params.Set("active", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["name"]; ok {
- params.Set("name", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/targetableRemarketingLists")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.targetableRemarketingLists.list" call.
-// Exactly one of *TargetableRemarketingListsListResponse or error will
-// be non-nil. Any non-2xx status code is an error. Response headers are
-// in either
-// *TargetableRemarketingListsListResponse.ServerResponse.Header or (if
-// a response was returned at all) in error.(*googleapi.Error).Header.
-// Use googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *TargetableRemarketingListsListCall) Do() (*TargetableRemarketingListsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &TargetableRemarketingListsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of targetable remarketing lists, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.targetableRemarketingLists.list",
- // "parameterOrder": [
- // "profileId",
- // "advertiserId"
- // ],
- // "parameters": {
- // "active": {
- // "description": "Select only active or only inactive targetable remarketing lists.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "advertiserId": {
- // "description": "Select only targetable remarketing lists targetable by these advertisers.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "name": {
- // "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"remarketing list*2015\" will return objects with names like \"remarketing list June 2015\", \"remarketing list April 2015\", or simply \"remarketing list 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"remarketing list\" will match objects with name \"my remarketing list\", \"remarketing list 2015\", or simply \"remarketing list\".",
- // "location": "query",
- // "type": "string"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/targetableRemarketingLists",
- // "response": {
- // "$ref": "TargetableRemarketingListsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userProfiles.get":
-
-type UserProfilesGetCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one user profile by ID.
-func (r *UserProfilesService) Get(profileId int64) *UserProfilesGetCall {
- c := &UserProfilesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserProfilesGetCall) Fields(s ...googleapi.Field) *UserProfilesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UserProfilesGetCall) IfNoneMatch(entityTag string) *UserProfilesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserProfilesGetCall) Context(ctx context.Context) *UserProfilesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserProfilesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userProfiles.get" call.
-// Exactly one of *UserProfile or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UserProfile.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UserProfilesGetCall) Do() (*UserProfile, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserProfile{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one user profile by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.userProfiles.get",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "The user profile ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}",
- // "response": {
- // "$ref": "UserProfile"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting",
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userProfiles.list":
-
-type UserProfilesListCall struct {
- s *Service
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves list of user profiles for a user.
-func (r *UserProfilesService) List() *UserProfilesListCall {
- c := &UserProfilesListCall{s: r.s, opt_: make(map[string]interface{})}
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserProfilesListCall) Fields(s ...googleapi.Field) *UserProfilesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UserProfilesListCall) IfNoneMatch(entityTag string) *UserProfilesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserProfilesListCall) Context(ctx context.Context) *UserProfilesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserProfilesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.SetOpaque(req.URL)
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userProfiles.list" call.
-// Exactly one of *UserProfileList or error will be non-nil. Any non-2xx
-// status code is an error. Response headers are in either
-// *UserProfileList.ServerResponse.Header or (if a response was returned
-// at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *UserProfilesListCall) Do() (*UserProfileList, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserProfileList{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves list of user profiles for a user.",
- // "httpMethod": "GET",
- // "id": "dfareporting.userProfiles.list",
- // "path": "userprofiles",
- // "response": {
- // "$ref": "UserProfileList"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfareporting",
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userRolePermissionGroups.get":
-
-type UserRolePermissionGroupsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one user role permission group by ID.
-func (r *UserRolePermissionGroupsService) Get(profileId int64, id int64) *UserRolePermissionGroupsGetCall {
- c := &UserRolePermissionGroupsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserRolePermissionGroupsGetCall) Fields(s ...googleapi.Field) *UserRolePermissionGroupsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UserRolePermissionGroupsGetCall) IfNoneMatch(entityTag string) *UserRolePermissionGroupsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserRolePermissionGroupsGetCall) Context(ctx context.Context) *UserRolePermissionGroupsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserRolePermissionGroupsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/userRolePermissionGroups/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userRolePermissionGroups.get" call.
-// Exactly one of *UserRolePermissionGroup or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *UserRolePermissionGroup.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *UserRolePermissionGroupsGetCall) Do() (*UserRolePermissionGroup, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserRolePermissionGroup{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one user role permission group by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.userRolePermissionGroups.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "User role permission group ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/userRolePermissionGroups/{id}",
- // "response": {
- // "$ref": "UserRolePermissionGroup"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userRolePermissionGroups.list":
-
-type UserRolePermissionGroupsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Gets a list of all supported user role permission groups.
-func (r *UserRolePermissionGroupsService) List(profileId int64) *UserRolePermissionGroupsListCall {
- c := &UserRolePermissionGroupsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserRolePermissionGroupsListCall) Fields(s ...googleapi.Field) *UserRolePermissionGroupsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UserRolePermissionGroupsListCall) IfNoneMatch(entityTag string) *UserRolePermissionGroupsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserRolePermissionGroupsListCall) Context(ctx context.Context) *UserRolePermissionGroupsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserRolePermissionGroupsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/userRolePermissionGroups")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userRolePermissionGroups.list" call.
-// Exactly one of *UserRolePermissionGroupsListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *UserRolePermissionGroupsListResponse.ServerResponse.Header or
-// (if a response was returned at all) in
-// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
-// whether the returned error was because http.StatusNotModified was
-// returned.
-func (c *UserRolePermissionGroupsListCall) Do() (*UserRolePermissionGroupsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserRolePermissionGroupsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets a list of all supported user role permission groups.",
- // "httpMethod": "GET",
- // "id": "dfareporting.userRolePermissionGroups.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/userRolePermissionGroups",
- // "response": {
- // "$ref": "UserRolePermissionGroupsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userRolePermissions.get":
-
-type UserRolePermissionsGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one user role permission by ID.
-func (r *UserRolePermissionsService) Get(profileId int64, id int64) *UserRolePermissionsGetCall {
- c := &UserRolePermissionsGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserRolePermissionsGetCall) Fields(s ...googleapi.Field) *UserRolePermissionsGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UserRolePermissionsGetCall) IfNoneMatch(entityTag string) *UserRolePermissionsGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserRolePermissionsGetCall) Context(ctx context.Context) *UserRolePermissionsGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserRolePermissionsGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/userRolePermissions/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userRolePermissions.get" call.
-// Exactly one of *UserRolePermission or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *UserRolePermission.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *UserRolePermissionsGetCall) Do() (*UserRolePermission, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserRolePermission{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one user role permission by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.userRolePermissions.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "User role permission ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/userRolePermissions/{id}",
- // "response": {
- // "$ref": "UserRolePermission"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userRolePermissions.list":
-
-type UserRolePermissionsListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Gets a list of user role permissions, possibly filtered.
-func (r *UserRolePermissionsService) List(profileId int64) *UserRolePermissionsListCall {
- c := &UserRolePermissionsListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only user role
-// permissions with these IDs.
-func (c *UserRolePermissionsListCall) Ids(ids int64) *UserRolePermissionsListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserRolePermissionsListCall) Fields(s ...googleapi.Field) *UserRolePermissionsListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UserRolePermissionsListCall) IfNoneMatch(entityTag string) *UserRolePermissionsListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserRolePermissionsListCall) Context(ctx context.Context) *UserRolePermissionsListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserRolePermissionsListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/userRolePermissions")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userRolePermissions.list" call.
-// Exactly one of *UserRolePermissionsListResponse or error will be
-// non-nil. Any non-2xx status code is an error. Response headers are in
-// either *UserRolePermissionsListResponse.ServerResponse.Header or (if
-// a response was returned at all) in error.(*googleapi.Error).Header.
-// Use googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *UserRolePermissionsListCall) Do() (*UserRolePermissionsListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserRolePermissionsListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets a list of user role permissions, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.userRolePermissions.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "ids": {
- // "description": "Select only user role permissions with these IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/userRolePermissions",
- // "response": {
- // "$ref": "UserRolePermissionsListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userRoles.delete":
-
-type UserRolesDeleteCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Delete: Deletes an existing user role.
-func (r *UserRolesService) Delete(profileId int64, id int64) *UserRolesDeleteCall {
- c := &UserRolesDeleteCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserRolesDeleteCall) Fields(s ...googleapi.Field) *UserRolesDeleteCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserRolesDeleteCall) Context(ctx context.Context) *UserRolesDeleteCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserRolesDeleteCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/userRoles/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("DELETE", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userRoles.delete" call.
-func (c *UserRolesDeleteCall) Do() error {
- res, err := c.doRequest("json")
- if err != nil {
- return err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return err
- }
- return nil
- // {
- // "description": "Deletes an existing user role.",
- // "httpMethod": "DELETE",
- // "id": "dfareporting.userRoles.delete",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "User role ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/userRoles/{id}",
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userRoles.get":
-
-type UserRolesGetCall struct {
- s *Service
- profileId int64
- id int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Get: Gets one user role by ID.
-func (r *UserRolesService) Get(profileId int64, id int64) *UserRolesGetCall {
- c := &UserRolesGetCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserRolesGetCall) Fields(s ...googleapi.Field) *UserRolesGetCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UserRolesGetCall) IfNoneMatch(entityTag string) *UserRolesGetCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserRolesGetCall) Context(ctx context.Context) *UserRolesGetCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserRolesGetCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/userRoles/{id}")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- "id": strconv.FormatInt(c.id, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userRoles.get" call.
-// Exactly one of *UserRole or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *UserRole.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UserRolesGetCall) Do() (*UserRole, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserRole{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Gets one user role by ID.",
- // "httpMethod": "GET",
- // "id": "dfareporting.userRoles.get",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "User role ID.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/userRoles/{id}",
- // "response": {
- // "$ref": "UserRole"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userRoles.insert":
-
-type UserRolesInsertCall struct {
- s *Service
- profileId int64
- userrole *UserRole
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Insert: Inserts a new user role.
-func (r *UserRolesService) Insert(profileId int64, userrole *UserRole) *UserRolesInsertCall {
- c := &UserRolesInsertCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.userrole = userrole
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserRolesInsertCall) Fields(s ...googleapi.Field) *UserRolesInsertCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserRolesInsertCall) Context(ctx context.Context) *UserRolesInsertCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserRolesInsertCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.userrole)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/userRoles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userRoles.insert" call.
-// Exactly one of *UserRole or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *UserRole.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UserRolesInsertCall) Do() (*UserRole, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserRole{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Inserts a new user role.",
- // "httpMethod": "POST",
- // "id": "dfareporting.userRoles.insert",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/userRoles",
- // "request": {
- // "$ref": "UserRole"
- // },
- // "response": {
- // "$ref": "UserRole"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userRoles.list":
-
-type UserRolesListCall struct {
- s *Service
- profileId int64
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// List: Retrieves a list of user roles, possibly filtered.
-func (r *UserRolesService) List(profileId int64) *UserRolesListCall {
- c := &UserRolesListCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- return c
-}
-
-// AccountUserRoleOnly sets the optional parameter
-// "accountUserRoleOnly": Select only account level user roles not
-// associated with any specific subaccount.
-func (c *UserRolesListCall) AccountUserRoleOnly(accountUserRoleOnly bool) *UserRolesListCall {
- c.opt_["accountUserRoleOnly"] = accountUserRoleOnly
- return c
-}
-
-// Ids sets the optional parameter "ids": Select only user roles with
-// the specified IDs.
-func (c *UserRolesListCall) Ids(ids int64) *UserRolesListCall {
- c.opt_["ids"] = ids
- return c
-}
-
-// MaxResults sets the optional parameter "maxResults": Maximum number
-// of results to return.
-func (c *UserRolesListCall) MaxResults(maxResults int64) *UserRolesListCall {
- c.opt_["maxResults"] = maxResults
- return c
-}
-
-// PageToken sets the optional parameter "pageToken": Value of the
-// nextPageToken from the previous result page.
-func (c *UserRolesListCall) PageToken(pageToken string) *UserRolesListCall {
- c.opt_["pageToken"] = pageToken
- return c
-}
-
-// SearchString sets the optional parameter "searchString": Allows
-// searching for objects by name or ID. Wildcards (*) are allowed. For
-// example, "userrole*2015" will return objects with names like
-// "userrole June 2015", "userrole April 2015", or simply "userrole
-// 2015". Most of the searches also add wildcards implicitly at the
-// start and the end of the search string. For example, a search string
-// of "userrole" will match objects with name "my userrole", "userrole
-// 2015", or simply "userrole".
-func (c *UserRolesListCall) SearchString(searchString string) *UserRolesListCall {
- c.opt_["searchString"] = searchString
- return c
-}
-
-// SortField sets the optional parameter "sortField": Field by which to
-// sort the list.
-//
-// Possible values:
-// "ID"
-// "NAME"
-func (c *UserRolesListCall) SortField(sortField string) *UserRolesListCall {
- c.opt_["sortField"] = sortField
- return c
-}
-
-// SortOrder sets the optional parameter "sortOrder": Order of sorted
-// results, default is ASCENDING.
-//
-// Possible values:
-// "ASCENDING"
-// "DESCENDING"
-func (c *UserRolesListCall) SortOrder(sortOrder string) *UserRolesListCall {
- c.opt_["sortOrder"] = sortOrder
- return c
-}
-
-// SubaccountId sets the optional parameter "subaccountId": Select only
-// user roles that belong to this subaccount.
-func (c *UserRolesListCall) SubaccountId(subaccountId int64) *UserRolesListCall {
- c.opt_["subaccountId"] = subaccountId
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserRolesListCall) Fields(s ...googleapi.Field) *UserRolesListCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// IfNoneMatch sets the optional parameter which makes the operation
-// fail if the object's ETag matches the given value. This is useful for
-// getting updates only after the object has changed since the last
-// request. Use googleapi.IsNotModified to check whether the response
-// error from Do is the result of In-None-Match.
-func (c *UserRolesListCall) IfNoneMatch(entityTag string) *UserRolesListCall {
- c.opt_["ifNoneMatch"] = entityTag
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserRolesListCall) Context(ctx context.Context) *UserRolesListCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserRolesListCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["accountUserRoleOnly"]; ok {
- params.Set("accountUserRoleOnly", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["ids"]; ok {
- params.Set("ids", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["maxResults"]; ok {
- params.Set("maxResults", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["pageToken"]; ok {
- params.Set("pageToken", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["searchString"]; ok {
- params.Set("searchString", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortField"]; ok {
- params.Set("sortField", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["sortOrder"]; ok {
- params.Set("sortOrder", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["subaccountId"]; ok {
- params.Set("subaccountId", fmt.Sprintf("%v", v))
- }
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/userRoles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("GET", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("User-Agent", c.s.userAgent())
- if v, ok := c.opt_["ifNoneMatch"]; ok {
- req.Header.Set("If-None-Match", fmt.Sprintf("%v", v))
- }
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userRoles.list" call.
-// Exactly one of *UserRolesListResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *UserRolesListResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *UserRolesListCall) Do() (*UserRolesListResponse, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserRolesListResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Retrieves a list of user roles, possibly filtered.",
- // "httpMethod": "GET",
- // "id": "dfareporting.userRoles.list",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "accountUserRoleOnly": {
- // "description": "Select only account level user roles not associated with any specific subaccount.",
- // "location": "query",
- // "type": "boolean"
- // },
- // "ids": {
- // "description": "Select only user roles with the specified IDs.",
- // "format": "int64",
- // "location": "query",
- // "repeated": true,
- // "type": "string"
- // },
- // "maxResults": {
- // "description": "Maximum number of results to return.",
- // "format": "int32",
- // "location": "query",
- // "type": "integer"
- // },
- // "pageToken": {
- // "description": "Value of the nextPageToken from the previous result page.",
- // "location": "query",
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // },
- // "searchString": {
- // "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"userrole*2015\" will return objects with names like \"userrole June 2015\", \"userrole April 2015\", or simply \"userrole 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"userrole\" will match objects with name \"my userrole\", \"userrole 2015\", or simply \"userrole\".",
- // "location": "query",
- // "type": "string"
- // },
- // "sortField": {
- // "description": "Field by which to sort the list.",
- // "enum": [
- // "ID",
- // "NAME"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "sortOrder": {
- // "description": "Order of sorted results, default is ASCENDING.",
- // "enum": [
- // "ASCENDING",
- // "DESCENDING"
- // ],
- // "enumDescriptions": [
- // "",
- // ""
- // ],
- // "location": "query",
- // "type": "string"
- // },
- // "subaccountId": {
- // "description": "Select only user roles that belong to this subaccount.",
- // "format": "int64",
- // "location": "query",
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/userRoles",
- // "response": {
- // "$ref": "UserRolesListResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userRoles.patch":
-
-type UserRolesPatchCall struct {
- s *Service
- profileId int64
- id int64
- userrole *UserRole
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Patch: Updates an existing user role. This method supports patch
-// semantics.
-func (r *UserRolesService) Patch(profileId int64, id int64, userrole *UserRole) *UserRolesPatchCall {
- c := &UserRolesPatchCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.id = id
- c.userrole = userrole
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserRolesPatchCall) Fields(s ...googleapi.Field) *UserRolesPatchCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserRolesPatchCall) Context(ctx context.Context) *UserRolesPatchCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserRolesPatchCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.userrole)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- params.Set("id", fmt.Sprintf("%v", c.id))
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/userRoles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PATCH", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userRoles.patch" call.
-// Exactly one of *UserRole or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *UserRole.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UserRolesPatchCall) Do() (*UserRole, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserRole{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing user role. This method supports patch semantics.",
- // "httpMethod": "PATCH",
- // "id": "dfareporting.userRoles.patch",
- // "parameterOrder": [
- // "profileId",
- // "id"
- // ],
- // "parameters": {
- // "id": {
- // "description": "User role ID.",
- // "format": "int64",
- // "location": "query",
- // "required": true,
- // "type": "string"
- // },
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/userRoles",
- // "request": {
- // "$ref": "UserRole"
- // },
- // "response": {
- // "$ref": "UserRole"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
-
-// method id "dfareporting.userRoles.update":
-
-type UserRolesUpdateCall struct {
- s *Service
- profileId int64
- userrole *UserRole
- opt_ map[string]interface{}
- ctx_ context.Context
-}
-
-// Update: Updates an existing user role.
-func (r *UserRolesService) Update(profileId int64, userrole *UserRole) *UserRolesUpdateCall {
- c := &UserRolesUpdateCall{s: r.s, opt_: make(map[string]interface{})}
- c.profileId = profileId
- c.userrole = userrole
- return c
-}
-
-// Fields allows partial responses to be retrieved.
-// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *UserRolesUpdateCall) Fields(s ...googleapi.Field) *UserRolesUpdateCall {
- c.opt_["fields"] = googleapi.CombineFields(s)
- return c
-}
-
-// Context sets the context to be used in this call's Do method.
-// Any pending HTTP request will be aborted if the provided context
-// is canceled.
-func (c *UserRolesUpdateCall) Context(ctx context.Context) *UserRolesUpdateCall {
- c.ctx_ = ctx
- return c
-}
-
-func (c *UserRolesUpdateCall) doRequest(alt string) (*http.Response, error) {
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.userrole)
- if err != nil {
- return nil, err
- }
- ctype := "application/json"
- params := make(url.Values)
- params.Set("alt", alt)
- if v, ok := c.opt_["fields"]; ok {
- params.Set("fields", fmt.Sprintf("%v", v))
- }
- urls := googleapi.ResolveRelative(c.s.BasePath, "userprofiles/{profileId}/userRoles")
- urls += "?" + params.Encode()
- req, _ := http.NewRequest("PUT", urls, body)
- googleapi.Expand(req.URL, map[string]string{
- "profileId": strconv.FormatInt(c.profileId, 10),
- })
- req.Header.Set("Content-Type", ctype)
- req.Header.Set("User-Agent", c.s.userAgent())
- if c.ctx_ != nil {
- return ctxhttp.Do(c.ctx_, c.s.client, req)
- }
- return c.s.client.Do(req)
-}
-
-// Do executes the "dfareporting.userRoles.update" call.
-// Exactly one of *UserRole or error will be non-nil. Any non-2xx status
-// code is an error. Response headers are in either
-// *UserRole.ServerResponse.Header or (if a response was returned at
-// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
-// to check whether the returned error was because
-// http.StatusNotModified was returned.
-func (c *UserRolesUpdateCall) Do() (*UserRole, error) {
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &UserRole{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "description": "Updates an existing user role.",
- // "httpMethod": "PUT",
- // "id": "dfareporting.userRoles.update",
- // "parameterOrder": [
- // "profileId"
- // ],
- // "parameters": {
- // "profileId": {
- // "description": "User profile ID associated with this request.",
- // "format": "int64",
- // "location": "path",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "userprofiles/{profileId}/userRoles",
- // "request": {
- // "$ref": "UserRole"
- // },
- // "response": {
- // "$ref": "UserRole"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/dfatrafficking"
- // ]
- // }
-
-}
diff --git a/vendor/google.golang.org/api/dfareporting/v2.2/dfareporting-api.json b/vendor/google.golang.org/api/dfareporting/v2.2/dfareporting-api.json
deleted file mode 100644
index e4ff7090..00000000
--- a/vendor/google.golang.org/api/dfareporting/v2.2/dfareporting-api.json
+++ /dev/null
@@ -1,17672 +0,0 @@
-{
- "kind": "discovery#restDescription",
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/qexyTX_0gifZ9lTG0KLr53MQrI4\"",
- "discoveryVersion": "v1",
- "id": "dfareporting:v2.2",
- "name": "dfareporting",
- "version": "v2.2",
- "revision": "20150717",
- "title": "DCM/DFA Reporting And Trafficking API",
- "description": "Manage your DoubleClick Campaign Manager ad campaigns and reports.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/doubleclick-advertisers/reporting/",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/dfareporting/v2.2/",
- "basePath": "/dfareporting/v2.2/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "dfareporting/v2.2/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/dfareporting": {
- "description": "View and manage DoubleClick for Advertisers reports"
- },
- "https://www.googleapis.com/auth/dfatrafficking": {
- "description": "View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns"
- }
- }
- }
- },
- "schemas": {
- "Account": {
- "id": "Account",
- "type": "object",
- "description": "Contains properties of a DCM account.",
- "properties": {
- "accountPermissionIds": {
- "type": "array",
- "description": "Account permissions assigned to this account.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "accountProfile": {
- "type": "string",
- "description": "Profile for this account. This is a read-only field that can be left blank.",
- "enum": [
- "ACCOUNT_PROFILE_BASIC",
- "ACCOUNT_PROFILE_STANDARD"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "active": {
- "type": "boolean",
- "description": "Whether this account is active."
- },
- "activeAdsLimitTier": {
- "type": "string",
- "description": "Maximum number of active ads allowed for this account.",
- "enum": [
- "ACTIVE_ADS_TIER_100K",
- "ACTIVE_ADS_TIER_200K",
- "ACTIVE_ADS_TIER_300K",
- "ACTIVE_ADS_TIER_40K",
- "ACTIVE_ADS_TIER_75K"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "activeViewOptOut": {
- "type": "boolean",
- "description": "Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions."
- },
- "availablePermissionIds": {
- "type": "array",
- "description": "User role permissions available to the user roles of this account.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "comscoreVceEnabled": {
- "type": "boolean",
- "description": "Whether campaigns created in this account will be enabled for comScore vCE by default."
- },
- "countryId": {
- "type": "string",
- "description": "ID of the country associated with this account.",
- "format": "int64"
- },
- "currencyId": {
- "type": "string",
- "description": "ID of currency associated with this account. This is a required field.\nAcceptable values are: \n- \"1\" for USD \n- \"2\" for GBP \n- \"3\" for ESP \n- \"4\" for SEK \n- \"5\" for CAD \n- \"6\" for JPY \n- \"7\" for DEM \n- \"8\" for AUD \n- \"9\" for FRF \n- \"10\" for ITL \n- \"11\" for DKK \n- \"12\" for NOK \n- \"13\" for FIM \n- \"14\" for ZAR \n- \"15\" for IEP \n- \"16\" for NLG \n- \"17\" for EUR \n- \"18\" for KRW \n- \"19\" for TWD \n- \"20\" for SGD \n- \"21\" for CNY \n- \"22\" for HKD \n- \"23\" for NZD \n- \"24\" for MYR \n- \"25\" for BRL \n- \"26\" for PTE \n- \"27\" for MXP \n- \"28\" for CLP \n- \"29\" for TRY \n- \"30\" for ARS \n- \"31\" for PEN \n- \"32\" for ILS \n- \"33\" for CHF \n- \"34\" for VEF \n- \"35\" for COP \n- \"36\" for GTQ",
- "format": "int64"
- },
- "defaultCreativeSizeId": {
- "type": "string",
- "description": "Default placement dimensions for this account.",
- "format": "int64"
- },
- "description": {
- "type": "string",
- "description": "Description of this account."
- },
- "id": {
- "type": "string",
- "description": "ID of this account. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#account\".",
- "default": "dfareporting#account"
- },
- "locale": {
- "type": "string",
- "description": "Locale of this account.\nAcceptable values are: \n- \"cs\" (Czech) \n- \"de\" (German) \n- \"en\" (English) \n- \"en-GB\" (English United Kingdom) \n- \"es\" (Spanish) \n- \"fr\" (French) \n- \"it\" (Italian) \n- \"ja\" (Japanese) \n- \"ko\" (Korean) \n- \"pl\" (Polish) \n- \"pt-BR\" (Portuguese Brazil) \n- \"ru\" (Russian) \n- \"sv\" (Swedish) \n- \"tr\" (Turkish) \n- \"zh-CN\" (Chinese Simplified) \n- \"zh-TW\" (Chinese Traditional)"
- },
- "maximumImageSize": {
- "type": "string",
- "description": "Maximum image size allowed for this account.",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "Name of this account. This is a required field, and must be less than 128 characters long and be globally unique."
- },
- "nielsenOcrEnabled": {
- "type": "boolean",
- "description": "Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default."
- },
- "reportsConfiguration": {
- "$ref": "ReportsConfiguration",
- "description": "Reporting configuration of this account."
- },
- "teaserSizeLimit": {
- "type": "string",
- "description": "File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.",
- "format": "int64"
- }
- }
- },
- "AccountActiveAdSummary": {
- "id": "AccountActiveAdSummary",
- "type": "object",
- "description": "Gets a summary of active ads in an account.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "ID of the account.",
- "format": "int64"
- },
- "activeAds": {
- "type": "string",
- "description": "Ads that have been activated for the account",
- "format": "int64"
- },
- "activeAdsLimitTier": {
- "type": "string",
- "description": "Maximum number of active ads allowed for the account.",
- "enum": [
- "ACTIVE_ADS_TIER_100K",
- "ACTIVE_ADS_TIER_200K",
- "ACTIVE_ADS_TIER_300K",
- "ACTIVE_ADS_TIER_40K",
- "ACTIVE_ADS_TIER_75K"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "availableAds": {
- "type": "string",
- "description": "Ads that can be activated for the account.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountActiveAdSummary\".",
- "default": "dfareporting#accountActiveAdSummary"
- }
- }
- },
- "AccountPermission": {
- "id": "AccountPermission",
- "type": "object",
- "description": "AccountPermissions contains information about a particular account permission. Some features of DCM require an account permission to be present in the account.",
- "properties": {
- "accountProfiles": {
- "type": "array",
- "description": "Account profiles associated with this account permission.\n\nPossible values are:\n- \"ACCOUNT_PROFILE_BASIC\"\n- \"ACCOUNT_PROFILE_STANDARD\"",
- "items": {
- "type": "string",
- "enum": [
- "ACCOUNT_PROFILE_BASIC",
- "ACCOUNT_PROFILE_STANDARD"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- }
- },
- "id": {
- "type": "string",
- "description": "ID of this account permission.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermission\".",
- "default": "dfareporting#accountPermission"
- },
- "level": {
- "type": "string",
- "description": "Administrative level required to enable this account permission.",
- "enum": [
- "ADMINISTRATOR",
- "USER"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "name": {
- "type": "string",
- "description": "Name of this account permission."
- },
- "permissionGroupId": {
- "type": "string",
- "description": "Permission group of this account permission.",
- "format": "int64"
- }
- }
- },
- "AccountPermissionGroup": {
- "id": "AccountPermissionGroup",
- "type": "object",
- "description": "AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.",
- "properties": {
- "id": {
- "type": "string",
- "description": "ID of this account permission group.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionGroup\".",
- "default": "dfareporting#accountPermissionGroup"
- },
- "name": {
- "type": "string",
- "description": "Name of this account permission group."
- }
- }
- },
- "AccountPermissionGroupsListResponse": {
- "id": "AccountPermissionGroupsListResponse",
- "type": "object",
- "description": "Account Permission Group List Response",
- "properties": {
- "accountPermissionGroups": {
- "type": "array",
- "description": "Account permission group collection.",
- "items": {
- "$ref": "AccountPermissionGroup"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionGroupsListResponse\".",
- "default": "dfareporting#accountPermissionGroupsListResponse"
- }
- }
- },
- "AccountPermissionsListResponse": {
- "id": "AccountPermissionsListResponse",
- "type": "object",
- "description": "Account Permission List Response",
- "properties": {
- "accountPermissions": {
- "type": "array",
- "description": "Account permission collection.",
- "items": {
- "$ref": "AccountPermission"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountPermissionsListResponse\".",
- "default": "dfareporting#accountPermissionsListResponse"
- }
- }
- },
- "AccountUserProfile": {
- "id": "AccountUserProfile",
- "type": "object",
- "description": "AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of the user profile. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "active": {
- "type": "boolean",
- "description": "Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable."
- },
- "advertiserFilter": {
- "$ref": "ObjectFilter",
- "description": "Filter that describes which advertisers are visible to the user profile."
- },
- "campaignFilter": {
- "$ref": "ObjectFilter",
- "description": "Filter that describes which campaigns are visible to the user profile."
- },
- "comments": {
- "type": "string",
- "description": "Comments for this user profile."
- },
- "email": {
- "type": "string",
- "description": "Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion."
- },
- "id": {
- "type": "string",
- "description": "ID of the user profile. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountUserProfile\".",
- "default": "dfareporting#accountUserProfile"
- },
- "locale": {
- "type": "string",
- "description": "Locale of the user profile. This is a required field.\nAcceptable values are: \n- \"cs\" (Czech) \n- \"de\" (German) \n- \"en\" (English) \n- \"en-GB\" (English United Kingdom) \n- \"es\" (Spanish) \n- \"fr\" (French) \n- \"it\" (Italian) \n- \"ja\" (Japanese) \n- \"ko\" (Korean) \n- \"pl\" (Polish) \n- \"pt-BR\" (Portuguese Brazil)\n- \"ru\" (Russian) \n- \"sv\" (Swedish) \n- \"tr\" (Turkish) \n- \"zh-CN\" (Chinese Simplified) \n- \"zh-TW\" (Chinese Traditional)"
- },
- "name": {
- "type": "string",
- "description": "Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: \"&;\"#%,\"."
- },
- "siteFilter": {
- "$ref": "ObjectFilter",
- "description": "Filter that describes which sites are visible to the user profile."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of the user profile. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "traffickerType": {
- "type": "string",
- "description": "Trafficker type of this user profile.",
- "enum": [
- "EXTERNAL_TRAFFICKER",
- "INTERNAL_NON_TRAFFICKER",
- "INTERNAL_TRAFFICKER"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "userAccessType": {
- "type": "string",
- "description": "User type of the user profile. This is a read-only field that can be left blank.",
- "enum": [
- "INTERNAL_ADMINISTRATOR",
- "NORMAL_USER",
- "SUPER_USER"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "userRoleFilter": {
- "$ref": "ObjectFilter",
- "description": "Filter that describes which user roles are visible to the user profile."
- },
- "userRoleId": {
- "type": "string",
- "description": "User role ID of the user profile. This is a required field.",
- "format": "int64"
- }
- }
- },
- "AccountUserProfilesListResponse": {
- "id": "AccountUserProfilesListResponse",
- "type": "object",
- "description": "Account User Profile List Response",
- "properties": {
- "accountUserProfiles": {
- "type": "array",
- "description": "Account user profile collection.",
- "items": {
- "$ref": "AccountUserProfile"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountUserProfilesListResponse\".",
- "default": "dfareporting#accountUserProfilesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "AccountsListResponse": {
- "id": "AccountsListResponse",
- "type": "object",
- "description": "Account List Response",
- "properties": {
- "accounts": {
- "type": "array",
- "description": "Account collection.",
- "items": {
- "$ref": "Account"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#accountsListResponse\".",
- "default": "dfareporting#accountsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "Activities": {
- "id": "Activities",
- "type": "object",
- "description": "Represents an activity group.",
- "properties": {
- "filters": {
- "type": "array",
- "description": "List of activity filters. The dimension values need to be all either of type \"dfa:activity\" or \"dfa:activityGroup\".",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#activities.",
- "default": "dfareporting#activities"
- },
- "metricNames": {
- "type": "array",
- "description": "List of names of floodlight activity metrics.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "Ad": {
- "id": "Ad",
- "type": "object",
- "description": "Contains properties of a DCM ad.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this ad. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "active": {
- "type": "boolean",
- "description": "Whether this ad is active."
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this ad. This is a required field on insertion.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "archived": {
- "type": "boolean",
- "description": "Whether this ad is archived."
- },
- "audienceSegmentId": {
- "type": "string",
- "description": "Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.",
- "format": "int64"
- },
- "campaignId": {
- "type": "string",
- "description": "Campaign ID of this ad. This is a required field on insertion.",
- "format": "int64"
- },
- "campaignIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
- },
- "clickThroughUrl": {
- "$ref": "ClickThroughUrl",
- "description": "Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER."
- },
- "clickThroughUrlSuffixProperties": {
- "$ref": "ClickThroughUrlSuffixProperties",
- "description": "Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative."
- },
- "comments": {
- "type": "string",
- "description": "Comments for this ad."
- },
- "compatibility": {
- "type": "string",
- "description": "Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.",
- "enum": [
- "APP",
- "APP_INTERSTITIAL",
- "IN_STREAM_VIDEO",
- "WEB",
- "WEB_INTERSTITIAL"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "createInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the creation of this ad.This is a read-only field."
- },
- "creativeGroupAssignments": {
- "type": "array",
- "description": "Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.",
- "items": {
- "$ref": "CreativeGroupAssignment"
- }
- },
- "creativeRotation": {
- "$ref": "CreativeRotation",
- "description": "Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment."
- },
- "dayPartTargeting": {
- "$ref": "DayPartTargeting",
- "description": "Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD."
- },
- "defaultClickThroughEventTagProperties": {
- "$ref": "DefaultClickThroughEventTagProperties",
- "description": "Default click-through event tag properties for this ad."
- },
- "deliverySchedule": {
- "$ref": "DeliverySchedule",
- "description": "Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD."
- },
- "dynamicClickTracker": {
- "type": "boolean",
- "description": "Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert."
- },
- "endTime": {
- "type": "string",
- "description": "Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.",
- "format": "date-time"
- },
- "eventTagOverrides": {
- "type": "array",
- "description": "Event tag overrides for this ad.",
- "items": {
- "$ref": "EventTagOverride"
- }
- },
- "geoTargeting": {
- "$ref": "GeoTargeting",
- "description": "Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD."
- },
- "id": {
- "type": "string",
- "description": "ID of this ad. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this ad. This is a read-only, auto-generated field."
- },
- "keyValueTargetingExpression": {
- "$ref": "KeyValueTargetingExpression",
- "description": "Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#ad\".",
- "default": "dfareporting#ad"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this ad. This is a read-only field."
- },
- "name": {
- "type": "string",
- "description": "Name of this ad. This is a required field and must be less than 256 characters long."
- },
- "placementAssignments": {
- "type": "array",
- "description": "Placement assignments for this ad.",
- "items": {
- "$ref": "PlacementAssignment"
- }
- },
- "remarketingListExpression": {
- "$ref": "ListTargetingExpression",
- "description": "Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad."
- },
- "size": {
- "$ref": "Size",
- "description": "Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD."
- },
- "sslCompliant": {
- "type": "boolean",
- "description": "Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated."
- },
- "sslRequired": {
- "type": "boolean",
- "description": "Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated."
- },
- "startTime": {
- "type": "string",
- "description": "Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.",
- "format": "date-time"
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this ad. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "technologyTargeting": {
- "$ref": "TechnologyTargeting",
- "description": "Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD."
- },
- "type": {
- "type": "string",
- "description": "Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).",
- "enum": [
- "AD_SERVING_CLICK_TRACKER",
- "AD_SERVING_DEFAULT_AD",
- "AD_SERVING_STANDARD_AD",
- "AD_SERVING_TRACKING"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- }
- }
- },
- "AdSlot": {
- "id": "AdSlot",
- "type": "object",
- "description": "Ad Slot",
- "properties": {
- "comment": {
- "type": "string",
- "description": "Comment for this ad slot."
- },
- "compatibility": {
- "type": "string",
- "description": "Ad slot compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.",
- "enum": [
- "PLANNING_RENDERING_ENVIRONMENT_TYPE_APP",
- "PLANNING_RENDERING_ENVIRONMENT_TYPE_APP_INTERSTITIAL",
- "PLANNING_RENDERING_ENVIRONMENT_TYPE_IN_STREAM_VIDEO",
- "PLANNING_RENDERING_ENVIRONMENT_TYPE_WEB",
- "PLANNING_RENDERING_ENVIRONMENT_TYPE_WEB_INTERSTITIAL"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "height": {
- "type": "string",
- "description": "Height of this ad slot.",
- "format": "int64"
- },
- "linkedPlacementId": {
- "type": "string",
- "description": "ID of the placement from an external platform that is linked to this ad slot.",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "Name of this ad slot."
- },
- "paymentSourceType": {
- "type": "string",
- "description": "Payment source type of this ad slot.",
- "enum": [
- "PLANNING_PAYMENT_SOURCE_TYPE_AGENCY_PAID",
- "PLANNING_PAYMENT_SOURCE_TYPE_PUBLISHER_PAID"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "primary": {
- "type": "boolean",
- "description": "Primary ad slot of a roadblock inventory item."
- },
- "width": {
- "type": "string",
- "description": "Width of this ad slot.",
- "format": "int64"
- }
- }
- },
- "AdsListResponse": {
- "id": "AdsListResponse",
- "type": "object",
- "description": "Ad List Response",
- "properties": {
- "ads": {
- "type": "array",
- "description": "Ad collection.",
- "items": {
- "$ref": "Ad"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#adsListResponse\".",
- "default": "dfareporting#adsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "Advertiser": {
- "id": "Advertiser",
- "type": "object",
- "description": "Contains properties of a DCM advertiser.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this advertiser.This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "advertiserGroupId": {
- "type": "string",
- "description": "ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.",
- "format": "int64"
- },
- "clickThroughUrlSuffix": {
- "type": "string",
- "description": "Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long."
- },
- "defaultClickThroughEventTagId": {
- "type": "string",
- "description": "ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.",
- "format": "int64"
- },
- "defaultEmail": {
- "type": "string",
- "description": "Default email address used in sender field for tag emails."
- },
- "floodlightConfigurationId": {
- "type": "string",
- "description": "Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: \n- This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. \n- This advertiser's original floodlight configuration is not already shared with another advertiser.",
- "format": "int64"
- },
- "floodlightConfigurationIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field."
- },
- "id": {
- "type": "string",
- "description": "ID of this advertiser. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this advertiser. This is a read-only, auto-generated field."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiser\".",
- "default": "dfareporting#advertiser"
- },
- "name": {
- "type": "string",
- "description": "Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account."
- },
- "originalFloodlightConfigurationId": {
- "type": "string",
- "description": "Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.",
- "format": "int64"
- },
- "status": {
- "type": "string",
- "description": "Status of this advertiser.",
- "enum": [
- "APPROVED",
- "ON_HOLD"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this advertiser.This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "suspended": {
- "type": "boolean",
- "description": "Suspension status of this advertiser."
- }
- }
- },
- "AdvertiserGroup": {
- "id": "AdvertiserGroup",
- "type": "object",
- "description": "Groups advertisers together so that reports can be generated for the entire group at once.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this advertiser group. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "ID of this advertiser group. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserGroup\".",
- "default": "dfareporting#advertiserGroup"
- },
- "name": {
- "type": "string",
- "description": "Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account."
- }
- }
- },
- "AdvertiserGroupsListResponse": {
- "id": "AdvertiserGroupsListResponse",
- "type": "object",
- "description": "Advertiser Group List Response",
- "properties": {
- "advertiserGroups": {
- "type": "array",
- "description": "Advertiser group collection.",
- "items": {
- "$ref": "AdvertiserGroup"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertiserGroupsListResponse\".",
- "default": "dfareporting#advertiserGroupsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "AdvertisersListResponse": {
- "id": "AdvertisersListResponse",
- "type": "object",
- "description": "Advertiser List Response",
- "properties": {
- "advertisers": {
- "type": "array",
- "description": "Advertiser collection.",
- "items": {
- "$ref": "Advertiser"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#advertisersListResponse\".",
- "default": "dfareporting#advertisersListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "AudienceSegment": {
- "id": "AudienceSegment",
- "type": "object",
- "description": "Audience Segment.",
- "properties": {
- "allocation": {
- "type": "integer",
- "description": "Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.",
- "format": "int32"
- },
- "id": {
- "type": "string",
- "description": "ID of this audience segment. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "Name of this audience segment. This is a required field and must be less than 65 characters long."
- }
- }
- },
- "AudienceSegmentGroup": {
- "id": "AudienceSegmentGroup",
- "type": "object",
- "description": "Audience Segment Group.",
- "properties": {
- "audienceSegments": {
- "type": "array",
- "description": "Audience segments assigned to this group. The number of segments must be between 2 and 100.",
- "items": {
- "$ref": "AudienceSegment"
- }
- },
- "id": {
- "type": "string",
- "description": "ID of this audience segment group. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "Name of this audience segment group. This is a required field and must be less than 65 characters long."
- }
- }
- },
- "Browser": {
- "id": "Browser",
- "type": "object",
- "description": "Contains information about a browser that can be targeted by ads.",
- "properties": {
- "browserVersionId": {
- "type": "string",
- "description": "ID referring to this grouping of browser and version numbers. This is the ID used for targeting.",
- "format": "int64"
- },
- "dartId": {
- "type": "string",
- "description": "DART ID of this browser. This is the ID used when generating reports.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#browser\".",
- "default": "dfareporting#browser"
- },
- "majorVersion": {
- "type": "string",
- "description": "Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is."
- },
- "minorVersion": {
- "type": "string",
- "description": "Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is."
- },
- "name": {
- "type": "string",
- "description": "Name of this browser."
- }
- }
- },
- "BrowsersListResponse": {
- "id": "BrowsersListResponse",
- "type": "object",
- "description": "Browser List Response",
- "properties": {
- "browsers": {
- "type": "array",
- "description": "Browser collection.",
- "items": {
- "$ref": "Browser"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#browsersListResponse\".",
- "default": "dfareporting#browsersListResponse"
- }
- }
- },
- "Campaign": {
- "id": "Campaign",
- "type": "object",
- "description": "Contains properties of a DCM campaign.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this campaign. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "additionalCreativeOptimizationConfigurations": {
- "type": "array",
- "description": "Additional creative optimization configurations for the campaign.",
- "items": {
- "$ref": "CreativeOptimizationConfiguration"
- }
- },
- "advertiserGroupId": {
- "type": "string",
- "description": "Advertiser group ID of the associated advertiser.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this campaign. This is a required field.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field."
- },
- "archived": {
- "type": "boolean",
- "description": "Whether this campaign has been archived."
- },
- "audienceSegmentGroups": {
- "type": "array",
- "description": "Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.",
- "items": {
- "$ref": "AudienceSegmentGroup"
- }
- },
- "billingInvoiceCode": {
- "type": "string",
- "description": "Billing invoice code included in the DCM client billing invoices associated with the campaign."
- },
- "clickThroughUrlSuffixProperties": {
- "$ref": "ClickThroughUrlSuffixProperties",
- "description": "Click-through URL suffix override properties for this campaign."
- },
- "comment": {
- "type": "string",
- "description": "Arbitrary comments about this campaign. Must be less than 256 characters long."
- },
- "comscoreVceEnabled": {
- "type": "boolean",
- "description": "Whether comScore vCE reports are enabled for this campaign."
- },
- "createInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the creation of this campaign. This is a read-only field."
- },
- "creativeGroupIds": {
- "type": "array",
- "description": "List of creative group IDs that are assigned to the campaign.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "creativeOptimizationConfiguration": {
- "$ref": "CreativeOptimizationConfiguration",
- "description": "Creative optimization configuration for the campaign."
- },
- "defaultClickThroughEventTagProperties": {
- "$ref": "DefaultClickThroughEventTagProperties",
- "description": "Click-through event tag ID override properties for this campaign."
- },
- "endDate": {
- "type": "string",
- "description": "Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.",
- "format": "date"
- },
- "eventTagOverrides": {
- "type": "array",
- "description": "Overrides that can be used to activate or deactivate advertiser event tags.",
- "items": {
- "$ref": "EventTagOverride"
- }
- },
- "externalId": {
- "type": "string",
- "description": "External ID for this campaign."
- },
- "id": {
- "type": "string",
- "description": "ID of this campaign. This is a read-only auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this campaign. This is a read-only, auto-generated field."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaign\".",
- "default": "dfareporting#campaign"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this campaign. This is a read-only field."
- },
- "lookbackConfiguration": {
- "$ref": "LookbackConfiguration",
- "description": "Lookback window settings for the campaign."
- },
- "name": {
- "type": "string",
- "description": "Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser."
- },
- "nielsenOcrEnabled": {
- "type": "boolean",
- "description": "Whether Nielsen reports are enabled for this campaign."
- },
- "startDate": {
- "type": "string",
- "description": "Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.",
- "format": "date"
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this campaign. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "traffickerEmails": {
- "type": "array",
- "description": "Campaign trafficker contact emails.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "CampaignCreativeAssociation": {
- "id": "CampaignCreativeAssociation",
- "type": "object",
- "description": "Identifies a creative which has been associated with a given campaign.",
- "properties": {
- "creativeId": {
- "type": "string",
- "description": "ID of the creative associated with the campaign. This is a required field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignCreativeAssociation\".",
- "default": "dfareporting#campaignCreativeAssociation"
- }
- }
- },
- "CampaignCreativeAssociationsListResponse": {
- "id": "CampaignCreativeAssociationsListResponse",
- "type": "object",
- "description": "Campaign Creative Association List Response",
- "properties": {
- "campaignCreativeAssociations": {
- "type": "array",
- "description": "Campaign creative association collection",
- "items": {
- "$ref": "CampaignCreativeAssociation"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignCreativeAssociationsListResponse\".",
- "default": "dfareporting#campaignCreativeAssociationsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "CampaignsListResponse": {
- "id": "CampaignsListResponse",
- "type": "object",
- "description": "Campaign List Response",
- "properties": {
- "campaigns": {
- "type": "array",
- "description": "Campaign collection.",
- "items": {
- "$ref": "Campaign"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#campaignsListResponse\".",
- "default": "dfareporting#campaignsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "ChangeLog": {
- "id": "ChangeLog",
- "type": "object",
- "description": "Describes a change that a user has made to a resource.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of the modified object.",
- "format": "int64"
- },
- "action": {
- "type": "string",
- "description": "Action which caused the change."
- },
- "changeTime": {
- "type": "string",
- "description": "Time when the object was modified.",
- "format": "date-time"
- },
- "fieldName": {
- "type": "string",
- "description": "Field name of the object which changed."
- },
- "id": {
- "type": "string",
- "description": "ID of this change log.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#changeLog\".",
- "default": "dfareporting#changeLog"
- },
- "newValue": {
- "type": "string",
- "description": "New value of the object field."
- },
- "objectId": {
- "type": "string",
- "description": "ID of the object of this change log. The object could be a campaign, placement, ad, or other type.",
- "format": "int64"
- },
- "objectType": {
- "type": "string",
- "description": "Object type of the change log."
- },
- "oldValue": {
- "type": "string",
- "description": "Old value of the object field."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of the modified object.",
- "format": "int64"
- },
- "transactionId": {
- "type": "string",
- "description": "Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId.",
- "format": "int64"
- },
- "userProfileId": {
- "type": "string",
- "description": "ID of the user who modified the object.",
- "format": "int64"
- },
- "userProfileName": {
- "type": "string",
- "description": "User profile name of the user who modified the object."
- }
- }
- },
- "ChangeLogsListResponse": {
- "id": "ChangeLogsListResponse",
- "type": "object",
- "description": "Change Log List Response",
- "properties": {
- "changeLogs": {
- "type": "array",
- "description": "Change log collection.",
- "items": {
- "$ref": "ChangeLog"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#changeLogsListResponse\".",
- "default": "dfareporting#changeLogsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "CitiesListResponse": {
- "id": "CitiesListResponse",
- "type": "object",
- "description": "City List Response",
- "properties": {
- "cities": {
- "type": "array",
- "description": "City collection.",
- "items": {
- "$ref": "City"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#citiesListResponse\".",
- "default": "dfareporting#citiesListResponse"
- }
- }
- },
- "City": {
- "id": "City",
- "type": "object",
- "description": "Contains information about a city that can be targeted by ads.",
- "properties": {
- "countryCode": {
- "type": "string",
- "description": "Country code of the country to which this city belongs."
- },
- "countryDartId": {
- "type": "string",
- "description": "DART ID of the country to which this city belongs.",
- "format": "int64"
- },
- "dartId": {
- "type": "string",
- "description": "DART ID of this city. This is the ID used for targeting and generating reports.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#city\".",
- "default": "dfareporting#city"
- },
- "metroCode": {
- "type": "string",
- "description": "Metro region code of the metro region (DMA) to which this city belongs."
- },
- "metroDmaId": {
- "type": "string",
- "description": "ID of the metro region (DMA) to which this city belongs.",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "Name of this city."
- },
- "regionCode": {
- "type": "string",
- "description": "Region code of the region to which this city belongs."
- },
- "regionDartId": {
- "type": "string",
- "description": "DART ID of the region to which this city belongs.",
- "format": "int64"
- }
- }
- },
- "ClickTag": {
- "id": "ClickTag",
- "type": "object",
- "description": "Creative Click Tag.",
- "properties": {
- "eventName": {
- "type": "string",
- "description": "Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives."
- },
- "name": {
- "type": "string",
- "description": "Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field."
- },
- "value": {
- "type": "string",
- "description": "Parameter value for the specified click tag. This field contains a click-through url."
- }
- }
- },
- "ClickThroughUrl": {
- "id": "ClickThroughUrl",
- "type": "object",
- "description": "Click-through URL",
- "properties": {
- "computedClickThroughUrl": {
- "type": "string",
- "description": "Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: \n- If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.\n- If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.\n- If neither of the above cases apply, then the customClickThroughUrl is assigned to this field."
- },
- "customClickThroughUrl": {
- "type": "string",
- "description": "Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset."
- },
- "defaultLandingPage": {
- "type": "boolean",
- "description": "Whether the campaign default landing page is used."
- },
- "landingPageId": {
- "type": "string",
- "description": "ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.",
- "format": "int64"
- }
- }
- },
- "ClickThroughUrlSuffixProperties": {
- "id": "ClickThroughUrlSuffixProperties",
- "type": "object",
- "description": "Click Through URL Suffix settings.",
- "properties": {
- "clickThroughUrlSuffix": {
- "type": "string",
- "description": "Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long."
- },
- "overrideInheritedSuffix": {
- "type": "boolean",
- "description": "Whether this entity should override the inherited click-through URL suffix with its own defined value."
- }
- }
- },
- "CompanionClickThroughOverride": {
- "id": "CompanionClickThroughOverride",
- "type": "object",
- "description": "Companion Click-through override.",
- "properties": {
- "clickThroughUrl": {
- "$ref": "ClickThroughUrl",
- "description": "Click-through URL of this companion click-through override."
- },
- "creativeId": {
- "type": "string",
- "description": "ID of the creative for this companion click-through override.",
- "format": "int64"
- }
- }
- },
- "CompatibleFields": {
- "id": "CompatibleFields",
- "type": "object",
- "description": "Represents a response to the queryCompatibleFields method.",
- "properties": {
- "crossDimensionReachReportCompatibleFields": {
- "$ref": "CrossDimensionReachReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"CROSS_DIMENSION_REACH\"."
- },
- "floodlightReportCompatibleFields": {
- "$ref": "FloodlightReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"FLOODLIGHT\"."
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#compatibleFields.",
- "default": "dfareporting#compatibleFields"
- },
- "pathToConversionReportCompatibleFields": {
- "$ref": "PathToConversionReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"PATH_TO_CONVERSION\"."
- },
- "reachReportCompatibleFields": {
- "$ref": "ReachReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"REACH\"."
- },
- "reportCompatibleFields": {
- "$ref": "ReportCompatibleFields",
- "description": "Contains items that are compatible to be selected for a report of type \"STANDARD\"."
- }
- }
- },
- "ConnectionType": {
- "id": "ConnectionType",
- "type": "object",
- "description": "Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.",
- "properties": {
- "id": {
- "type": "string",
- "description": "ID of this connection type.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#connectionType\".",
- "default": "dfareporting#connectionType"
- },
- "name": {
- "type": "string",
- "description": "Name of this connection type."
- }
- }
- },
- "ConnectionTypesListResponse": {
- "id": "ConnectionTypesListResponse",
- "type": "object",
- "description": "Connection Type List Response",
- "properties": {
- "connectionTypes": {
- "type": "array",
- "description": "Collection of connection types such as broadband and mobile.",
- "items": {
- "$ref": "ConnectionType"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#connectionTypesListResponse\".",
- "default": "dfareporting#connectionTypesListResponse"
- }
- }
- },
- "ContentCategoriesListResponse": {
- "id": "ContentCategoriesListResponse",
- "type": "object",
- "description": "Content Category List Response",
- "properties": {
- "contentCategories": {
- "type": "array",
- "description": "Content category collection.",
- "items": {
- "$ref": "ContentCategory"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#contentCategoriesListResponse\".",
- "default": "dfareporting#contentCategoriesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "ContentCategory": {
- "id": "ContentCategory",
- "type": "object",
- "description": "Organizes placements according to the contents of their associated webpages.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this content category. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "ID of this content category. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#contentCategory\".",
- "default": "dfareporting#contentCategory"
- },
- "name": {
- "type": "string",
- "description": "Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account."
- }
- }
- },
- "CountriesListResponse": {
- "id": "CountriesListResponse",
- "type": "object",
- "description": "Country List Response",
- "properties": {
- "countries": {
- "type": "array",
- "description": "Country collection.",
- "items": {
- "$ref": "Country"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#countriesListResponse\".",
- "default": "dfareporting#countriesListResponse"
- }
- }
- },
- "Country": {
- "id": "Country",
- "type": "object",
- "description": "Contains information about a country that can be targeted by ads.",
- "properties": {
- "countryCode": {
- "type": "string",
- "description": "Country code."
- },
- "dartId": {
- "type": "string",
- "description": "DART ID of this country. This is the ID used for targeting and generating reports.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#country\".",
- "default": "dfareporting#country"
- },
- "name": {
- "type": "string",
- "description": "Name of this country."
- },
- "sslEnabled": {
- "type": "boolean",
- "description": "Whether ad serving supports secure servers in this country."
- }
- }
- },
- "Creative": {
- "id": "Creative",
- "type": "object",
- "description": "Contains properties of a Creative.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.",
- "format": "int64"
- },
- "active": {
- "type": "boolean",
- "description": "Whether the creative is active. Applicable to all creative types."
- },
- "adParameters": {
- "type": "string",
- "description": "Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID."
- },
- "adTagKeys": {
- "type": "array",
- "description": "Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "items": {
- "type": "string"
- }
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this creative. This is a required field. Applicable to all creative types.",
- "format": "int64"
- },
- "allowScriptAccess": {
- "type": "boolean",
- "description": "Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE."
- },
- "archived": {
- "type": "boolean",
- "description": "Whether the creative is archived. Applicable to all creative types."
- },
- "artworkType": {
- "type": "string",
- "description": "Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "enum": [
- "ARTWORK_TYPE_FLASH",
- "ARTWORK_TYPE_HTML5",
- "ARTWORK_TYPE_MIXED"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "authoringTool": {
- "type": "string",
- "description": "Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.",
- "enum": [
- "NINJA",
- "SWIFFY"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "auto_advance_images": {
- "type": "boolean",
- "description": "Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE."
- },
- "backgroundColor": {
- "type": "string",
- "description": "The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE."
- },
- "backupImageClickThroughUrl": {
- "type": "string",
- "description": "Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER."
- },
- "backupImageFeatures": {
- "type": "array",
- "description": "List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.",
- "items": {
- "type": "string",
- "enum": [
- "APPLICATION_CACHE",
- "AUDIO",
- "CANVAS",
- "CANVAS_TEXT",
- "CSS_ANIMATIONS",
- "CSS_BACKGROUND_SIZE",
- "CSS_BORDER_IMAGE",
- "CSS_BORDER_RADIUS",
- "CSS_BOX_SHADOW",
- "CSS_COLUMNS",
- "CSS_FLEX_BOX",
- "CSS_FONT_FACE",
- "CSS_GENERATED_CONTENT",
- "CSS_GRADIENTS",
- "CSS_HSLA",
- "CSS_MULTIPLE_BGS",
- "CSS_OPACITY",
- "CSS_REFLECTIONS",
- "CSS_RGBA",
- "CSS_TEXT_SHADOW",
- "CSS_TRANSFORMS",
- "CSS_TRANSFORMS3D",
- "CSS_TRANSITIONS",
- "DRAG_AND_DROP",
- "GEO_LOCATION",
- "HASH_CHANGE",
- "HISTORY",
- "INDEXED_DB",
- "INLINE_SVG",
- "INPUT_ATTR_AUTOCOMPLETE",
- "INPUT_ATTR_AUTOFOCUS",
- "INPUT_ATTR_LIST",
- "INPUT_ATTR_MAX",
- "INPUT_ATTR_MIN",
- "INPUT_ATTR_MULTIPLE",
- "INPUT_ATTR_PATTERN",
- "INPUT_ATTR_PLACEHOLDER",
- "INPUT_ATTR_REQUIRED",
- "INPUT_ATTR_STEP",
- "INPUT_TYPE_COLOR",
- "INPUT_TYPE_DATE",
- "INPUT_TYPE_DATETIME",
- "INPUT_TYPE_DATETIME_LOCAL",
- "INPUT_TYPE_EMAIL",
- "INPUT_TYPE_MONTH",
- "INPUT_TYPE_NUMBER",
- "INPUT_TYPE_RANGE",
- "INPUT_TYPE_SEARCH",
- "INPUT_TYPE_TEL",
- "INPUT_TYPE_TIME",
- "INPUT_TYPE_URL",
- "INPUT_TYPE_WEEK",
- "LOCAL_STORAGE",
- "POST_MESSAGE",
- "SESSION_STORAGE",
- "SMIL",
- "SVG_CLIP_PATHS",
- "SVG_FE_IMAGE",
- "SVG_FILTERS",
- "SVG_HREF",
- "TOUCH",
- "VIDEO",
- "WEBGL",
- "WEB_SOCKETS",
- "WEB_SQL_DATABASE",
- "WEB_WORKERS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- },
- "backupImageReportingLabel": {
- "type": "string",
- "description": "Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER."
- },
- "backupImageTargetWindow": {
- "$ref": "TargetWindow",
- "description": "Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER."
- },
- "clickTags": {
- "type": "array",
- "description": "Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.",
- "items": {
- "$ref": "ClickTag"
- }
- },
- "commercialId": {
- "type": "string",
- "description": "Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
- },
- "companionCreatives": {
- "type": "array",
- "description": "List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "compatibility": {
- "type": "array",
- "description": "Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.\n\nAcceptable values are:\n- \"APP\"\n- \"APP_INTERSTITIAL\"\n- \"IN_STREAM_VIDEO\"\n- \"WEB\"\n- \"WEB_INTERSTITIAL\"",
- "items": {
- "type": "string",
- "enum": [
- "APP",
- "APP_INTERSTITIAL",
- "IN_STREAM_VIDEO",
- "WEB",
- "WEB_INTERSTITIAL"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- }
- },
- "convertFlashToHtml5": {
- "type": "boolean",
- "description": "Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE."
- },
- "counterCustomEvents": {
- "type": "array",
- "description": "List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "items": {
- "$ref": "CreativeCustomEvent"
- }
- },
- "creativeAssets": {
- "type": "array",
- "description": "Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT",
- "items": {
- "$ref": "CreativeAsset"
- }
- },
- "creativeFieldAssignments": {
- "type": "array",
- "description": "Creative field assignments for this creative. Applicable to all creative types.",
- "items": {
- "$ref": "CreativeFieldAssignment"
- }
- },
- "customKeyValues": {
- "type": "array",
- "description": "Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "items": {
- "type": "string"
- }
- },
- "exitCustomEvents": {
- "type": "array",
- "description": "List of exit events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "items": {
- "$ref": "CreativeCustomEvent"
- }
- },
- "fsCommand": {
- "$ref": "FsCommand",
- "description": "OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE."
- },
- "htmlCode": {
- "type": "string",
- "description": "HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA."
- },
- "htmlCodeLocked": {
- "type": "boolean",
- "description": "Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER."
- },
- "id": {
- "type": "string",
- "description": "ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creative\".",
- "default": "dfareporting#creative"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Creative last modification information. This is a read-only field. Applicable to all creative types."
- },
- "latestTraffickedCreativeId": {
- "type": "string",
- "description": "Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types."
- },
- "overrideCss": {
- "type": "string",
- "description": "Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA."
- },
- "redirectUrl": {
- "type": "string",
- "description": "URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT"
- },
- "renderingId": {
- "type": "string",
- "description": "ID of current rendering version. This is a read-only field. Applicable to all creative types.",
- "format": "int64"
- },
- "renderingIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types."
- },
- "requiredFlashPluginVersion": {
- "type": "string",
- "description": "The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID."
- },
- "requiredFlashVersion": {
- "type": "integer",
- "description": "The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.",
- "format": "int32"
- },
- "size": {
- "$ref": "Size",
- "description": "Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA."
- },
- "skippable": {
- "type": "boolean",
- "description": "Whether the user can choose to skip the creative. Applicable to the following creative types: INSTREAM_VIDEO."
- },
- "sslCompliant": {
- "type": "boolean",
- "description": "Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types."
- },
- "sslOverride": {
- "type": "boolean",
- "description": "Whether creative should be treated as SSL compliant even if the system scan shows it's not."
- },
- "studioAdvertiserId": {
- "type": "string",
- "description": "Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "format": "int64"
- },
- "studioCreativeId": {
- "type": "string",
- "description": "Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "format": "int64"
- },
- "studioTraffickedCreativeId": {
- "type": "string",
- "description": "Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "format": "int64"
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.",
- "format": "int64"
- },
- "thirdPartyBackupImageImpressionsUrl": {
- "type": "string",
- "description": "Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA"
- },
- "thirdPartyRichMediaImpressionsUrl": {
- "type": "string",
- "description": "Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA"
- },
- "thirdPartyUrls": {
- "type": "array",
- "description": "Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.",
- "items": {
- "$ref": "ThirdPartyTrackingUrl"
- }
- },
- "timerCustomEvents": {
- "type": "array",
- "description": "List of timer events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "items": {
- "$ref": "CreativeCustomEvent"
- }
- },
- "totalFileSize": {
- "type": "string",
- "description": "Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.",
- "format": "int64"
- },
- "type": {
- "type": "string",
- "description": "Type of this creative.This is a required field. Applicable to all creative types.",
- "enum": [
- "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO",
- "CUSTOM_INPAGE",
- "CUSTOM_INTERSTITIAL",
- "ENHANCED_BANNER",
- "ENHANCED_IMAGE",
- "FLASH_INPAGE",
- "HTML5_BANNER",
- "IMAGE",
- "INSTREAM_VIDEO",
- "INTERNAL_REDIRECT",
- "INTERSTITIAL_INTERNAL_REDIRECT",
- "REDIRECT",
- "RICH_MEDIA_EXPANDING",
- "RICH_MEDIA_IM_EXPAND",
- "RICH_MEDIA_INPAGE",
- "RICH_MEDIA_INPAGE_FLOATING",
- "RICH_MEDIA_INTERSTITIAL_FLOAT",
- "RICH_MEDIA_MOBILE_IN_APP",
- "RICH_MEDIA_MULTI_FLOATING",
- "RICH_MEDIA_PEEL_DOWN",
- "TRACKING_TEXT",
- "VAST_REDIRECT",
- "VPAID_LINEAR",
- "VPAID_NON_LINEAR"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "version": {
- "type": "integer",
- "description": "The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.",
- "format": "int32"
- },
- "videoDescription": {
- "type": "string",
- "description": "Description of the video ad. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
- },
- "videoDuration": {
- "type": "number",
- "description": "Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.",
- "format": "float"
- }
- }
- },
- "CreativeAsset": {
- "id": "CreativeAsset",
- "type": "object",
- "description": "Creative Asset.",
- "properties": {
- "actionScript3": {
- "type": "boolean",
- "description": "Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER."
- },
- "active": {
- "type": "boolean",
- "description": "Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
- },
- "alignment": {
- "type": "string",
- "description": "Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.",
- "enum": [
- "ALIGNMENT_BOTTOM",
- "ALIGNMENT_LEFT",
- "ALIGNMENT_RIGHT",
- "ALIGNMENT_TOP"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- },
- "artworkType": {
- "type": "string",
- "description": "Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "ARTWORK_TYPE_FLASH",
- "ARTWORK_TYPE_HTML5",
- "ARTWORK_TYPE_MIXED"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "assetIdentifier": {
- "$ref": "CreativeAssetId",
- "description": "Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT."
- },
- "backupImageExit": {
- "$ref": "CreativeCustomEvent",
- "description": "Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA."
- },
- "bitRate": {
- "type": "integer",
- "description": "Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.",
- "format": "int32"
- },
- "childAssetType": {
- "type": "string",
- "description": "Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.",
- "enum": [
- "CHILD_ASSET_TYPE_DATA",
- "CHILD_ASSET_TYPE_FLASH",
- "CHILD_ASSET_TYPE_IMAGE",
- "CHILD_ASSET_TYPE_VIDEO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- },
- "collapsedSize": {
- "$ref": "Size",
- "description": "Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN."
- },
- "customStartTimeValue": {
- "type": "integer",
- "description": "Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.",
- "format": "int32"
- },
- "detectedFeatures": {
- "type": "array",
- "description": "List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.",
- "items": {
- "type": "string",
- "enum": [
- "APPLICATION_CACHE",
- "AUDIO",
- "CANVAS",
- "CANVAS_TEXT",
- "CSS_ANIMATIONS",
- "CSS_BACKGROUND_SIZE",
- "CSS_BORDER_IMAGE",
- "CSS_BORDER_RADIUS",
- "CSS_BOX_SHADOW",
- "CSS_COLUMNS",
- "CSS_FLEX_BOX",
- "CSS_FONT_FACE",
- "CSS_GENERATED_CONTENT",
- "CSS_GRADIENTS",
- "CSS_HSLA",
- "CSS_MULTIPLE_BGS",
- "CSS_OPACITY",
- "CSS_REFLECTIONS",
- "CSS_RGBA",
- "CSS_TEXT_SHADOW",
- "CSS_TRANSFORMS",
- "CSS_TRANSFORMS3D",
- "CSS_TRANSITIONS",
- "DRAG_AND_DROP",
- "GEO_LOCATION",
- "HASH_CHANGE",
- "HISTORY",
- "INDEXED_DB",
- "INLINE_SVG",
- "INPUT_ATTR_AUTOCOMPLETE",
- "INPUT_ATTR_AUTOFOCUS",
- "INPUT_ATTR_LIST",
- "INPUT_ATTR_MAX",
- "INPUT_ATTR_MIN",
- "INPUT_ATTR_MULTIPLE",
- "INPUT_ATTR_PATTERN",
- "INPUT_ATTR_PLACEHOLDER",
- "INPUT_ATTR_REQUIRED",
- "INPUT_ATTR_STEP",
- "INPUT_TYPE_COLOR",
- "INPUT_TYPE_DATE",
- "INPUT_TYPE_DATETIME",
- "INPUT_TYPE_DATETIME_LOCAL",
- "INPUT_TYPE_EMAIL",
- "INPUT_TYPE_MONTH",
- "INPUT_TYPE_NUMBER",
- "INPUT_TYPE_RANGE",
- "INPUT_TYPE_SEARCH",
- "INPUT_TYPE_TEL",
- "INPUT_TYPE_TIME",
- "INPUT_TYPE_URL",
- "INPUT_TYPE_WEEK",
- "LOCAL_STORAGE",
- "POST_MESSAGE",
- "SESSION_STORAGE",
- "SMIL",
- "SVG_CLIP_PATHS",
- "SVG_FE_IMAGE",
- "SVG_FILTERS",
- "SVG_HREF",
- "TOUCH",
- "VIDEO",
- "WEBGL",
- "WEB_SOCKETS",
- "WEB_SQL_DATABASE",
- "WEB_WORKERS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- },
- "displayType": {
- "type": "string",
- "description": "Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "ASSET_DISPLAY_TYPE_EXPANDING",
- "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH",
- "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH_EXPANDING",
- "ASSET_DISPLAY_TYPE_FLOATING",
- "ASSET_DISPLAY_TYPE_INPAGE",
- "ASSET_DISPLAY_TYPE_OVERLAY",
- "ASSET_DISPLAY_TYPE_PEEL_DOWN",
- "ASSET_DISPLAY_TYPE_VPAID_LINEAR",
- "ASSET_DISPLAY_TYPE_VPAID_NON_LINEAR"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "duration": {
- "type": "integer",
- "description": "Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.",
- "format": "int32"
- },
- "durationType": {
- "type": "string",
- "description": "Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "ASSET_DURATION_TYPE_AUTO",
- "ASSET_DURATION_TYPE_CUSTOM",
- "ASSET_DURATION_TYPE_NONE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "expandedDimension": {
- "$ref": "Size",
- "description": "Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
- },
- "fileSize": {
- "type": "string",
- "description": "File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.",
- "format": "int64"
- },
- "flashVersion": {
- "type": "integer",
- "description": "Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.",
- "format": "int32"
- },
- "hideFlashObjects": {
- "type": "boolean",
- "description": "Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA."
- },
- "hideSelectionBoxes": {
- "type": "boolean",
- "description": "Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA."
- },
- "horizontallyLocked": {
- "type": "boolean",
- "description": "Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA."
- },
- "id": {
- "type": "string",
- "description": "Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.",
- "format": "int64"
- },
- "mimeType": {
- "type": "string",
- "description": "Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
- },
- "offset": {
- "$ref": "OffsetPosition",
- "description": "Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN."
- },
- "originalBackup": {
- "type": "boolean",
- "description": "Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA."
- },
- "position": {
- "$ref": "OffsetPosition",
- "description": "Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA."
- },
- "positionLeftUnit": {
- "type": "string",
- "description": "Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "OFFSET_UNIT_PERCENT",
- "OFFSET_UNIT_PIXEL",
- "OFFSET_UNIT_PIXEL_FROM_CENTER"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "positionTopUnit": {
- "type": "string",
- "description": "Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "OFFSET_UNIT_PERCENT",
- "OFFSET_UNIT_PIXEL",
- "OFFSET_UNIT_PIXEL_FROM_CENTER"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "progressiveServingUrl": {
- "type": "string",
- "description": "Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
- },
- "pushdown": {
- "type": "boolean",
- "description": "Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height."
- },
- "pushdownDuration": {
- "type": "number",
- "description": "Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.",
- "format": "float"
- },
- "role": {
- "type": "string",
- "description": "Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.\nPRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.\nBACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.\nADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.\nOTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.\nPARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.\nTRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.\nALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.\nFor VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.",
- "enum": [
- "ADDITIONAL_FLASH",
- "ADDITIONAL_IMAGE",
- "ALTERNATE_VIDEO",
- "BACKUP_IMAGE",
- "OTHER",
- "PARENT_VIDEO",
- "PRIMARY",
- "TRANSCODED_VIDEO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "size": {
- "$ref": "Size",
- "description": "Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA."
- },
- "sslCompliant": {
- "type": "boolean",
- "description": "Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT."
- },
- "startTimeType": {
- "type": "string",
- "description": "Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.",
- "enum": [
- "ASSET_START_TIME_TYPE_CUSTOM",
- "ASSET_START_TIME_TYPE_NONE"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "streamingServingUrl": {
- "type": "string",
- "description": "Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID."
- },
- "transparency": {
- "type": "boolean",
- "description": "Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets."
- },
- "verticallyLocked": {
- "type": "boolean",
- "description": "Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA."
- },
- "videoDuration": {
- "type": "number",
- "description": "Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.",
- "format": "float"
- },
- "windowMode": {
- "type": "string",
- "description": "Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.",
- "enum": [
- "OPAQUE",
- "TRANSPARENT",
- "WINDOW"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "zIndex": {
- "type": "integer",
- "description": "zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.",
- "format": "int32"
- },
- "zipFilename": {
- "type": "string",
- "description": "File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER."
- },
- "zipFilesize": {
- "type": "string",
- "description": "Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER."
- }
- }
- },
- "CreativeAssetId": {
- "id": "CreativeAssetId",
- "type": "object",
- "description": "Creative Asset ID.",
- "properties": {
- "name": {
- "type": "string",
- "description": "Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: \".-_ \". Spaces are allowed."
- },
- "type": {
- "type": "string",
- "description": "Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.",
- "enum": [
- "FLASH",
- "HTML",
- "HTML_IMAGE",
- "IMAGE",
- "VIDEO"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- }
- }
- },
- "CreativeAssetMetadata": {
- "id": "CreativeAssetMetadata",
- "type": "object",
- "description": "CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.",
- "properties": {
- "assetIdentifier": {
- "$ref": "CreativeAssetId",
- "description": "ID of the creative asset. This is a required field."
- },
- "clickTags": {
- "type": "array",
- "description": "List of detected click tags for assets. This is a read-only auto-generated field.",
- "items": {
- "$ref": "ClickTag"
- }
- },
- "detectedFeatures": {
- "type": "array",
- "description": "List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.",
- "items": {
- "type": "string",
- "enum": [
- "APPLICATION_CACHE",
- "AUDIO",
- "CANVAS",
- "CANVAS_TEXT",
- "CSS_ANIMATIONS",
- "CSS_BACKGROUND_SIZE",
- "CSS_BORDER_IMAGE",
- "CSS_BORDER_RADIUS",
- "CSS_BOX_SHADOW",
- "CSS_COLUMNS",
- "CSS_FLEX_BOX",
- "CSS_FONT_FACE",
- "CSS_GENERATED_CONTENT",
- "CSS_GRADIENTS",
- "CSS_HSLA",
- "CSS_MULTIPLE_BGS",
- "CSS_OPACITY",
- "CSS_REFLECTIONS",
- "CSS_RGBA",
- "CSS_TEXT_SHADOW",
- "CSS_TRANSFORMS",
- "CSS_TRANSFORMS3D",
- "CSS_TRANSITIONS",
- "DRAG_AND_DROP",
- "GEO_LOCATION",
- "HASH_CHANGE",
- "HISTORY",
- "INDEXED_DB",
- "INLINE_SVG",
- "INPUT_ATTR_AUTOCOMPLETE",
- "INPUT_ATTR_AUTOFOCUS",
- "INPUT_ATTR_LIST",
- "INPUT_ATTR_MAX",
- "INPUT_ATTR_MIN",
- "INPUT_ATTR_MULTIPLE",
- "INPUT_ATTR_PATTERN",
- "INPUT_ATTR_PLACEHOLDER",
- "INPUT_ATTR_REQUIRED",
- "INPUT_ATTR_STEP",
- "INPUT_TYPE_COLOR",
- "INPUT_TYPE_DATE",
- "INPUT_TYPE_DATETIME",
- "INPUT_TYPE_DATETIME_LOCAL",
- "INPUT_TYPE_EMAIL",
- "INPUT_TYPE_MONTH",
- "INPUT_TYPE_NUMBER",
- "INPUT_TYPE_RANGE",
- "INPUT_TYPE_SEARCH",
- "INPUT_TYPE_TEL",
- "INPUT_TYPE_TIME",
- "INPUT_TYPE_URL",
- "INPUT_TYPE_WEEK",
- "LOCAL_STORAGE",
- "POST_MESSAGE",
- "SESSION_STORAGE",
- "SMIL",
- "SVG_CLIP_PATHS",
- "SVG_FE_IMAGE",
- "SVG_FILTERS",
- "SVG_HREF",
- "TOUCH",
- "VIDEO",
- "WEBGL",
- "WEB_SOCKETS",
- "WEB_SQL_DATABASE",
- "WEB_WORKERS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeAssetMetadata\".",
- "default": "dfareporting#creativeAssetMetadata"
- },
- "warnedValidationRules": {
- "type": "array",
- "description": "Rules validated during code generation that generated a warning. This is a read-only, auto-generated field.\n\nPossible values are:\n- \"CLICK_TAG_NON_TOP_LEVEL\"\n- \"CLICK_TAG_MISSING\"\n- \"CLICK_TAG_MORE_THAN_ONE\"\n- \"CLICK_TAG_INVALID\"\n- \"ORPHANED_ASSET\"\n- \"PRIMARY_HTML_MISSING\"\n- \"EXTERNAL_FILE_REFERENCED\"\n- \"MRAID_REFERENCED\"\n- \"ADMOB_REFERENCED\"\n- \"FILE_TYPE_INVALID\"\n- \"ZIP_INVALID\"\n- \"LINKED_FILE_NOT_FOUND\"\n- \"MAX_FLASH_VERSION_11\"\n- \"NOT_SSL_COMPLIANT\"\n- \"FILE_DETAIL_EMPTY\"\n- \"ASSET_INVALID\"\n- \"GWD_PROPERTIES_INVALID\"\n- \"ENABLER_UNSUPPORTED_METHOD_DCM\"\n- \"ASSET_FORMAT_UNSUPPORTED_DCM\"\n- \"COMPONENT_UNSUPPORTED_DCM\"\n- \"HTML5_FEATURE_UNSUPPORTED' \"",
- "items": {
- "type": "string",
- "enum": [
- "ADMOB_REFERENCED",
- "ASSET_FORMAT_UNSUPPORTED_DCM",
- "ASSET_INVALID",
- "CLICK_TAG_INVALID",
- "CLICK_TAG_MISSING",
- "CLICK_TAG_MORE_THAN_ONE",
- "CLICK_TAG_NON_TOP_LEVEL",
- "COMPONENT_UNSUPPORTED_DCM",
- "ENABLER_UNSUPPORTED_METHOD_DCM",
- "EXTERNAL_FILE_REFERENCED",
- "FILE_DETAIL_EMPTY",
- "FILE_TYPE_INVALID",
- "GWD_PROPERTIES_INVALID",
- "HTML5_FEATURE_UNSUPPORTED",
- "LINKED_FILE_NOT_FOUND",
- "MAX_FLASH_VERSION_11",
- "MRAID_REFERENCED",
- "NOT_SSL_COMPLIANT",
- "ORPHANED_ASSET",
- "PRIMARY_HTML_MISSING",
- "ZIP_INVALID"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- }
- }
- },
- "CreativeAssignment": {
- "id": "CreativeAssignment",
- "type": "object",
- "description": "Creative Assignment.",
- "properties": {
- "active": {
- "type": "boolean",
- "description": "Whether this creative assignment is active. When true, the creative will be included in the ad's rotation."
- },
- "applyEventTags": {
- "type": "boolean",
- "description": "Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO."
- },
- "clickThroughUrl": {
- "$ref": "ClickThroughUrl",
- "description": "Click-through URL of the creative assignment."
- },
- "companionCreativeOverrides": {
- "type": "array",
- "description": "Companion creative overrides for this creative assignment. Applicable to video ads.",
- "items": {
- "$ref": "CompanionClickThroughOverride"
- }
- },
- "creativeGroupAssignments": {
- "type": "array",
- "description": "Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.",
- "items": {
- "$ref": "CreativeGroupAssignment"
- }
- },
- "creativeId": {
- "type": "string",
- "description": "ID of the creative to be assigned. This is a required field.",
- "format": "int64"
- },
- "creativeIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the creative. This is a read-only, auto-generated field."
- },
- "endTime": {
- "type": "string",
- "description": "Date and time that the assigned creative should stop serving. Must be later than the start time.",
- "format": "date-time"
- },
- "richMediaExitOverrides": {
- "type": "array",
- "description": "Rich media exit overrides for this creative assignment.\nApplicable when the creative type is any of the following: \n- RICH_MEDIA_INPAGE\n- RICH_MEDIA_INPAGE_FLOATING\n- RICH_MEDIA_IM_EXPAND\n- RICH_MEDIA_EXPANDING\n- RICH_MEDIA_INTERSTITIAL_FLOAT\n- RICH_MEDIA_MOBILE_IN_APP\n- RICH_MEDIA_MULTI_FLOATING\n- RICH_MEDIA_PEEL_DOWN\n- ADVANCED_BANNER\n- VPAID_LINEAR\n- VPAID_NON_LINEAR",
- "items": {
- "$ref": "RichMediaExitOverride"
- }
- },
- "sequence": {
- "type": "integer",
- "description": "Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.",
- "format": "int32"
- },
- "sslCompliant": {
- "type": "boolean",
- "description": "Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated."
- },
- "startTime": {
- "type": "string",
- "description": "Date and time that the assigned creative should start serving.",
- "format": "date-time"
- },
- "weight": {
- "type": "integer",
- "description": "Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.",
- "format": "int32"
- }
- }
- },
- "CreativeCustomEvent": {
- "id": "CreativeCustomEvent",
- "type": "object",
- "description": "Creative Custom Event.",
- "properties": {
- "advertiserCustomEventName": {
- "type": "string",
- "description": "User-entered name for the event."
- },
- "advertiserCustomEventType": {
- "type": "string",
- "description": "Type of the event. This is a read-only field.",
- "enum": [
- "ADVERTISER_EVENT_COUNTER",
- "ADVERTISER_EVENT_EXIT",
- "ADVERTISER_EVENT_TIMER"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "artworkLabel": {
- "type": "string",
- "description": "Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion."
- },
- "artworkType": {
- "type": "string",
- "description": "Artwork type used by the creative.This is a read-only field.",
- "enum": [
- "ARTWORK_TYPE_FLASH",
- "ARTWORK_TYPE_HTML5",
- "ARTWORK_TYPE_MIXED"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "exitUrl": {
- "type": "string",
- "description": "Exit URL of the event. This field is used only for exit events."
- },
- "id": {
- "type": "string",
- "description": "ID of this event. This is a required field and should not be modified after insertion.",
- "format": "int64"
- },
- "popupWindowProperties": {
- "$ref": "PopupWindowProperties",
- "description": "Properties for rich media popup windows. This field is used only for exit events."
- },
- "targetType": {
- "type": "string",
- "description": "Target type used by the event.",
- "enum": [
- "TARGET_BLANK",
- "TARGET_PARENT",
- "TARGET_POPUP",
- "TARGET_SELF",
- "TARGET_TOP"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "videoReportingId": {
- "type": "string",
- "description": "Reporting ID, used to differentiate multiple videos in a single creative."
- }
- }
- },
- "CreativeField": {
- "id": "CreativeField",
- "type": "object",
- "description": "Contains properties of a creative field.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this creative field. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this creative field. This is a required field on insertion.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "id": {
- "type": "string",
- "description": "ID of this creative field. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeField\".",
- "default": "dfareporting#creativeField"
- },
- "name": {
- "type": "string",
- "description": "Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this creative field. This is a read-only field that can be left blank.",
- "format": "int64"
- }
- }
- },
- "CreativeFieldAssignment": {
- "id": "CreativeFieldAssignment",
- "type": "object",
- "description": "Creative Field Assignment.",
- "properties": {
- "creativeFieldId": {
- "type": "string",
- "description": "ID of the creative field.",
- "format": "int64"
- },
- "creativeFieldValueId": {
- "type": "string",
- "description": "ID of the creative field value.",
- "format": "int64"
- }
- }
- },
- "CreativeFieldValue": {
- "id": "CreativeFieldValue",
- "type": "object",
- "description": "Contains properties of a creative field value.",
- "properties": {
- "id": {
- "type": "string",
- "description": "ID of this creative field value. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldValue\".",
- "default": "dfareporting#creativeFieldValue"
- },
- "value": {
- "type": "string",
- "description": "Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field."
- }
- }
- },
- "CreativeFieldValuesListResponse": {
- "id": "CreativeFieldValuesListResponse",
- "type": "object",
- "description": "Creative Field Value List Response",
- "properties": {
- "creativeFieldValues": {
- "type": "array",
- "description": "Creative field value collection.",
- "items": {
- "$ref": "CreativeFieldValue"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldValuesListResponse\".",
- "default": "dfareporting#creativeFieldValuesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "CreativeFieldsListResponse": {
- "id": "CreativeFieldsListResponse",
- "type": "object",
- "description": "Creative Field List Response",
- "properties": {
- "creativeFields": {
- "type": "array",
- "description": "Creative field collection.",
- "items": {
- "$ref": "CreativeField"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeFieldsListResponse\".",
- "default": "dfareporting#creativeFieldsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "CreativeGroup": {
- "id": "CreativeGroup",
- "type": "object",
- "description": "Contains properties of a creative group.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this creative group. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this creative group. This is a required field on insertion.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "groupNumber": {
- "type": "integer",
- "description": "Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.\nAcceptable values are: \n- 1\n- 2",
- "format": "int32"
- },
- "id": {
- "type": "string",
- "description": "ID of this creative group. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeGroup\".",
- "default": "dfareporting#creativeGroup"
- },
- "name": {
- "type": "string",
- "description": "Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this creative group. This is a read-only field that can be left blank.",
- "format": "int64"
- }
- }
- },
- "CreativeGroupAssignment": {
- "id": "CreativeGroupAssignment",
- "type": "object",
- "description": "Creative Group Assignment.",
- "properties": {
- "creativeGroupId": {
- "type": "string",
- "description": "ID of the creative group to be assigned.",
- "format": "int64"
- },
- "creativeGroupNumber": {
- "type": "string",
- "description": "Creative group number of the creative group assignment.",
- "enum": [
- "CREATIVE_GROUP_ONE",
- "CREATIVE_GROUP_TWO"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- }
- }
- },
- "CreativeGroupsListResponse": {
- "id": "CreativeGroupsListResponse",
- "type": "object",
- "description": "Creative Group List Response",
- "properties": {
- "creativeGroups": {
- "type": "array",
- "description": "Creative group collection.",
- "items": {
- "$ref": "CreativeGroup"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeGroupsListResponse\".",
- "default": "dfareporting#creativeGroupsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "CreativeOptimizationConfiguration": {
- "id": "CreativeOptimizationConfiguration",
- "type": "object",
- "description": "Creative optimization settings.",
- "properties": {
- "id": {
- "type": "string",
- "description": "ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "Name of this creative optimization config. This is a required field and must be less than 129 characters long."
- },
- "optimizationActivitys": {
- "type": "array",
- "description": "List of optimization activities associated with this configuration.",
- "items": {
- "$ref": "OptimizationActivity"
- }
- },
- "optimizationModel": {
- "type": "string",
- "description": "Optimization model for this configuration.",
- "enum": [
- "CLICK",
- "POST_CLICK",
- "POST_CLICK_AND_IMPRESSION",
- "POST_IMPRESSION"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- }
- }
- },
- "CreativeRotation": {
- "id": "CreativeRotation",
- "type": "object",
- "description": "Creative Rotation.",
- "properties": {
- "creativeAssignments": {
- "type": "array",
- "description": "Creative assignments in this creative rotation.",
- "items": {
- "$ref": "CreativeAssignment"
- }
- },
- "creativeOptimizationConfigurationId": {
- "type": "string",
- "description": "Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.",
- "format": "int64"
- },
- "type": {
- "type": "string",
- "description": "Type of creative rotation. Can be used to specify whether to use sequential or random rotation.",
- "enum": [
- "CREATIVE_ROTATION_TYPE_RANDOM",
- "CREATIVE_ROTATION_TYPE_SEQUENTIAL"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "weightCalculationStrategy": {
- "type": "string",
- "description": "Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.",
- "enum": [
- "WEIGHT_STRATEGY_CUSTOM",
- "WEIGHT_STRATEGY_EQUAL",
- "WEIGHT_STRATEGY_HIGHEST_CTR",
- "WEIGHT_STRATEGY_OPTIMIZED"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- }
- }
- },
- "CreativeSettings": {
- "id": "CreativeSettings",
- "type": "object",
- "description": "Creative Settings",
- "properties": {
- "iFrameFooter": {
- "type": "string",
- "description": "Header text for iFrames for this site. Must be less than or equal to 2000 characters long."
- },
- "iFrameHeader": {
- "type": "string",
- "description": "Header text for iFrames for this site. Must be less than or equal to 2000 characters long."
- }
- }
- },
- "CreativesListResponse": {
- "id": "CreativesListResponse",
- "type": "object",
- "description": "Creative List Response",
- "properties": {
- "creatives": {
- "type": "array",
- "description": "Creative collection.",
- "items": {
- "$ref": "Creative"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativesListResponse\".",
- "default": "dfareporting#creativesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "CrossDimensionReachReportCompatibleFields": {
- "id": "CrossDimensionReachReportCompatibleFields",
- "type": "object",
- "description": "Represents fields that are compatible to be selected for a report of type \"CROSS_DIMENSION_REACH\".",
- "properties": {
- "breakdown": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"breakdown\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "dimensionFilters": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields.",
- "default": "dfareporting#crossDimensionReachReportCompatibleFields"
- },
- "metrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- },
- "overlapMetrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected in the \"overlapMetricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- }
- }
- },
- "CustomRichMediaEvents": {
- "id": "CustomRichMediaEvents",
- "type": "object",
- "description": "Represents a Custom Rich Media Events group.",
- "properties": {
- "filteredEventIds": {
- "type": "array",
- "description": "List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#customRichMediaEvents.",
- "default": "dfareporting#customRichMediaEvents"
- }
- }
- },
- "DateRange": {
- "id": "DateRange",
- "type": "object",
- "description": "Represents a date range.",
- "properties": {
- "endDate": {
- "type": "string",
- "description": "The end date of the date range, inclusive. A string of the format: \"yyyy-MM-dd\".",
- "format": "date"
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#dateRange.",
- "default": "dfareporting#dateRange"
- },
- "relativeDateRange": {
- "type": "string",
- "description": "The date range relative to the date of when the report is run.",
- "enum": [
- "LAST_24_MONTHS",
- "LAST_30_DAYS",
- "LAST_365_DAYS",
- "LAST_7_DAYS",
- "LAST_90_DAYS",
- "MONTH_TO_DATE",
- "PREVIOUS_MONTH",
- "PREVIOUS_QUARTER",
- "PREVIOUS_WEEK",
- "PREVIOUS_YEAR",
- "QUARTER_TO_DATE",
- "TODAY",
- "WEEK_TO_DATE",
- "YEAR_TO_DATE",
- "YESTERDAY"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "startDate": {
- "type": "string",
- "description": "The start date of the date range, inclusive. A string of the format: \"yyyy-MM-dd\".",
- "format": "date"
- }
- }
- },
- "DayPartTargeting": {
- "id": "DayPartTargeting",
- "type": "object",
- "description": "Day Part Targeting.",
- "properties": {
- "daysOfWeek": {
- "type": "array",
- "description": "Days of the week when the ad will serve.\n\nAcceptable values are:\n- \"SUNDAY\"\n- \"MONDAY\"\n- \"TUESDAY\"\n- \"WEDNESDAY\"\n- \"THURSDAY\"\n- \"FRIDAY\"\n- \"SATURDAY\"",
- "items": {
- "type": "string",
- "enum": [
- "FRIDAY",
- "MONDAY",
- "SATURDAY",
- "SUNDAY",
- "THURSDAY",
- "TUESDAY",
- "WEDNESDAY"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- },
- "hoursOfDay": {
- "type": "array",
- "description": "Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "userLocalTime": {
- "type": "boolean",
- "description": "Whether or not to use the user's local time. If false, the America/New York time zone applies."
- }
- }
- },
- "DefaultClickThroughEventTagProperties": {
- "id": "DefaultClickThroughEventTagProperties",
- "type": "object",
- "description": "Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further.",
- "properties": {
- "defaultClickThroughEventTagId": {
- "type": "string",
- "description": "ID of the click-through event tag to apply to all ads in this entity's scope.",
- "format": "int64"
- },
- "overrideInheritedEventTag": {
- "type": "boolean",
- "description": "Whether this entity should override the inherited default click-through event tag with its own defined value."
- }
- }
- },
- "DeliverySchedule": {
- "id": "DeliverySchedule",
- "type": "object",
- "description": "Delivery Schedule.",
- "properties": {
- "frequencyCap": {
- "$ref": "FrequencyCap",
- "description": "Limit on the number of times an individual user can be served the ad within a specified period of time."
- },
- "hardCutoff": {
- "type": "boolean",
- "description": "Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals."
- },
- "impressionRatio": {
- "type": "string",
- "description": "Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.",
- "format": "int64"
- },
- "priority": {
- "type": "string",
- "description": "Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.",
- "enum": [
- "AD_PRIORITY_01",
- "AD_PRIORITY_02",
- "AD_PRIORITY_03",
- "AD_PRIORITY_04",
- "AD_PRIORITY_05",
- "AD_PRIORITY_06",
- "AD_PRIORITY_07",
- "AD_PRIORITY_08",
- "AD_PRIORITY_09",
- "AD_PRIORITY_10",
- "AD_PRIORITY_11",
- "AD_PRIORITY_12",
- "AD_PRIORITY_13",
- "AD_PRIORITY_14",
- "AD_PRIORITY_15",
- "AD_PRIORITY_16"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- }
- },
- "DfpSettings": {
- "id": "DfpSettings",
- "type": "object",
- "description": "DFP Settings",
- "properties": {
- "dfp_network_code": {
- "type": "string",
- "description": "DFP network code for this directory site."
- },
- "dfp_network_name": {
- "type": "string",
- "description": "DFP network name for this directory site."
- },
- "programmaticPlacementAccepted": {
- "type": "boolean",
- "description": "Whether this directory site accepts programmatic placements."
- },
- "pubPaidPlacementAccepted": {
- "type": "boolean",
- "description": "Whether this directory site accepts publisher-paid tags."
- },
- "publisherPortalOnly": {
- "type": "boolean",
- "description": "Whether this directory site is available only via DoubleClick Publisher Portal."
- }
- }
- },
- "Dimension": {
- "id": "Dimension",
- "type": "object",
- "description": "Represents a dimension.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#dimension.",
- "default": "dfareporting#dimension"
- },
- "name": {
- "type": "string",
- "description": "The dimension name, e.g. dfa:advertiser"
- }
- }
- },
- "DimensionFilter": {
- "id": "DimensionFilter",
- "type": "object",
- "description": "Represents a dimension filter.",
- "properties": {
- "dimensionName": {
- "type": "string",
- "description": "The name of the dimension to filter."
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#dimensionFilter.",
- "default": "dfareporting#dimensionFilter"
- },
- "value": {
- "type": "string",
- "description": "The value of the dimension to filter."
- }
- }
- },
- "DimensionValue": {
- "id": "DimensionValue",
- "type": "object",
- "description": "Represents a DimensionValue resource.",
- "properties": {
- "dimensionName": {
- "type": "string",
- "description": "The name of the dimension."
- },
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "id": {
- "type": "string",
- "description": "The ID associated with the value if available."
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#dimensionValue.",
- "default": "dfareporting#dimensionValue"
- },
- "matchType": {
- "type": "string",
- "description": "Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.",
- "enum": [
- "BEGINS_WITH",
- "CONTAINS",
- "EXACT",
- "WILDCARD_EXPRESSION"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- },
- "value": {
- "type": "string",
- "description": "The value of the dimension."
- }
- }
- },
- "DimensionValueList": {
- "id": "DimensionValueList",
- "type": "object",
- "description": "Represents the list of DimensionValue resources.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The dimension values returned in this response.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of list this is, in this case dfareporting#dimensionValueList.",
- "default": "dfareporting#dimensionValueList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted."
- }
- }
- },
- "DimensionValueRequest": {
- "id": "DimensionValueRequest",
- "type": "object",
- "description": "Represents a DimensionValuesRequest.",
- "properties": {
- "dimensionName": {
- "type": "string",
- "description": "The name of the dimension for which values should be requested.",
- "annotations": {
- "required": [
- "dfareporting.dimensionValues.query"
- ]
- }
- },
- "endDate": {
- "type": "string",
- "description": "The end date of the date range for which to retrieve dimension values. A string of the format \"yyyy-MM-dd\".",
- "format": "date",
- "annotations": {
- "required": [
- "dfareporting.dimensionValues.query"
- ]
- }
- },
- "filters": {
- "type": "array",
- "description": "The list of filters by which to filter values. The filters are ANDed.",
- "items": {
- "$ref": "DimensionFilter"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of request this is, in this case dfareporting#dimensionValueRequest.",
- "default": "dfareporting#dimensionValueRequest"
- },
- "startDate": {
- "type": "string",
- "description": "The start date of the date range for which to retrieve dimension values. A string of the format \"yyyy-MM-dd\".",
- "format": "date",
- "annotations": {
- "required": [
- "dfareporting.dimensionValues.query"
- ]
- }
- }
- }
- },
- "DirectorySite": {
- "id": "DirectorySite",
- "type": "object",
- "description": "DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.",
- "properties": {
- "active": {
- "type": "boolean",
- "description": "Whether this directory site is active."
- },
- "contactAssignments": {
- "type": "array",
- "description": "Directory site contacts.",
- "items": {
- "$ref": "DirectorySiteContactAssignment"
- }
- },
- "countryId": {
- "type": "string",
- "description": "Country ID of this directory site.",
- "format": "int64"
- },
- "currencyId": {
- "type": "string",
- "description": "Currency ID of this directory site.\nPossible values are: \n- \"1\" for USD \n- \"2\" for GBP \n- \"3\" for ESP \n- \"4\" for SEK \n- \"5\" for CAD \n- \"6\" for JPY \n- \"7\" for DEM \n- \"8\" for AUD \n- \"9\" for FRF \n- \"10\" for ITL \n- \"11\" for DKK \n- \"12\" for NOK \n- \"13\" for FIM \n- \"14\" for ZAR \n- \"15\" for IEP \n- \"16\" for NLG \n- \"17\" for EUR \n- \"18\" for KRW \n- \"19\" for TWD \n- \"20\" for SGD \n- \"21\" for CNY \n- \"22\" for HKD \n- \"23\" for NZD \n- \"24\" for MYR \n- \"25\" for BRL \n- \"26\" for PTE \n- \"27\" for MXP \n- \"28\" for CLP \n- \"29\" for TRY \n- \"30\" for ARS \n- \"31\" for PEN \n- \"32\" for ILS \n- \"33\" for CHF \n- \"34\" for VEF \n- \"35\" for COP \n- \"36\" for GTQ",
- "format": "int64"
- },
- "description": {
- "type": "string",
- "description": "Description of this directory site."
- },
- "id": {
- "type": "string",
- "description": "ID of this directory site. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this directory site. This is a read-only, auto-generated field."
- },
- "inpageTagFormats": {
- "type": "array",
- "description": "Tag types for regular placements.\n\nAcceptable values are:\n- \"STANDARD\"\n- \"IFRAME_JAVASCRIPT_INPAGE\"\n- \"INTERNAL_REDIRECT_INPAGE\"\n- \"JAVASCRIPT_INPAGE\"",
- "items": {
- "type": "string",
- "enum": [
- "IFRAME_JAVASCRIPT_INPAGE",
- "INTERNAL_REDIRECT_INPAGE",
- "JAVASCRIPT_INPAGE",
- "STANDARD"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- }
- },
- "interstitialTagFormats": {
- "type": "array",
- "description": "Tag types for interstitial placements.\n\nAcceptable values are:\n- \"IFRAME_JAVASCRIPT_INTERSTITIAL\"\n- \"INTERNAL_REDIRECT_INTERSTITIAL\"\n- \"JAVASCRIPT_INTERSTITIAL\"",
- "items": {
- "type": "string",
- "enum": [
- "IFRAME_JAVASCRIPT_INTERSTITIAL",
- "INTERNAL_REDIRECT_INTERSTITIAL",
- "JAVASCRIPT_INTERSTITIAL"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySite\".",
- "default": "dfareporting#directorySite"
- },
- "name": {
- "type": "string",
- "description": "Name of this directory site."
- },
- "parentId": {
- "type": "string",
- "description": "Parent directory site ID.",
- "format": "int64"
- },
- "settings": {
- "$ref": "DirectorySiteSettings",
- "description": "Directory site settings."
- },
- "url": {
- "type": "string",
- "description": "URL of this directory site."
- }
- }
- },
- "DirectorySiteContact": {
- "id": "DirectorySiteContact",
- "type": "object",
- "description": "Contains properties of a Site Directory contact.",
- "properties": {
- "address": {
- "type": "string",
- "description": "Address of this directory site contact."
- },
- "email": {
- "type": "string",
- "description": "Email address of this directory site contact."
- },
- "firstName": {
- "type": "string",
- "description": "First name of this directory site contact."
- },
- "id": {
- "type": "string",
- "description": "ID of this directory site contact. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySiteContact\".",
- "default": "dfareporting#directorySiteContact"
- },
- "lastName": {
- "type": "string",
- "description": "Last name of this directory site contact."
- },
- "phone": {
- "type": "string",
- "description": "Phone number of this directory site contact."
- },
- "role": {
- "type": "string",
- "description": "Directory site contact role.",
- "enum": [
- "ADMIN",
- "EDIT",
- "VIEW"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "title": {
- "type": "string",
- "description": "Title or designation of this directory site contact."
- },
- "type": {
- "type": "string",
- "description": "Directory site contact type.",
- "enum": [
- "BILLING",
- "OTHER",
- "SALES",
- "TECHNICAL"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- }
- }
- },
- "DirectorySiteContactAssignment": {
- "id": "DirectorySiteContactAssignment",
- "type": "object",
- "description": "Directory Site Contact Assignment",
- "properties": {
- "contactId": {
- "type": "string",
- "description": "ID of this directory site contact. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "visibility": {
- "type": "string",
- "description": "Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.",
- "enum": [
- "PRIVATE",
- "PUBLIC"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- }
- }
- },
- "DirectorySiteContactsListResponse": {
- "id": "DirectorySiteContactsListResponse",
- "type": "object",
- "description": "Directory Site Contact List Response",
- "properties": {
- "directorySiteContacts": {
- "type": "array",
- "description": "Directory site contact collection",
- "items": {
- "$ref": "DirectorySiteContact"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySiteContactsListResponse\".",
- "default": "dfareporting#directorySiteContactsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "DirectorySiteSettings": {
- "id": "DirectorySiteSettings",
- "type": "object",
- "description": "Directory Site Settings",
- "properties": {
- "activeViewOptOut": {
- "type": "boolean",
- "description": "Whether this directory site has disabled active view creatives."
- },
- "dfp_settings": {
- "$ref": "DfpSettings",
- "description": "Directory site DFP settings."
- },
- "instream_video_placement_accepted": {
- "type": "boolean",
- "description": "Whether this site accepts in-stream video ads."
- },
- "interstitialPlacementAccepted": {
- "type": "boolean",
- "description": "Whether this site accepts interstitial ads."
- },
- "nielsenOcrOptOut": {
- "type": "boolean",
- "description": "Whether this directory site has disabled Nielsen OCR reach ratings."
- },
- "verificationTagOptOut": {
- "type": "boolean",
- "description": "Whether this directory site has disabled generation of Verification ins tags."
- },
- "videoActiveViewOptOut": {
- "type": "boolean",
- "description": "Whether this directory site has disabled active view for in-stream video creatives."
- }
- }
- },
- "DirectorySitesListResponse": {
- "id": "DirectorySitesListResponse",
- "type": "object",
- "description": "Directory Site List Response",
- "properties": {
- "directorySites": {
- "type": "array",
- "description": "Directory site collection.",
- "items": {
- "$ref": "DirectorySite"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#directorySitesListResponse\".",
- "default": "dfareporting#directorySitesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "EventTag": {
- "id": "EventTag",
- "type": "object",
- "description": "Contains properties of an event tag.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this event tag. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this event tag. This field or the campaignId field is required on insertion.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "campaignId": {
- "type": "string",
- "description": "Campaign ID of this event tag. This field or the advertiserId field is required on insertion.",
- "format": "int64"
- },
- "campaignIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
- },
- "enabledByDefault": {
- "type": "boolean",
- "description": "Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads."
- },
- "excludeFromAdxRequests": {
- "type": "boolean",
- "description": "Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network."
- },
- "id": {
- "type": "string",
- "description": "ID of this event tag. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#eventTag\".",
- "default": "dfareporting#eventTag"
- },
- "name": {
- "type": "string",
- "description": "Name of this event tag. This is a required field and must be less than 256 characters long."
- },
- "siteFilterType": {
- "type": "string",
- "description": "Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.",
- "enum": [
- "BLACKLIST",
- "WHITELIST"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "siteIds": {
- "type": "array",
- "description": "Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "sslCompliant": {
- "type": "boolean",
- "description": "Whether this tag is SSL-compliant or not. This is a read-only field."
- },
- "status": {
- "type": "string",
- "description": "Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.",
- "enum": [
- "DISABLED",
- "ENABLED"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this event tag. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "type": {
- "type": "string",
- "description": "Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.",
- "enum": [
- "CLICK_THROUGH_EVENT_TAG",
- "IMPRESSION_IMAGE_EVENT_TAG",
- "IMPRESSION_JAVASCRIPT_EVENT_TAG"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "url": {
- "type": "string",
- "description": "Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion."
- },
- "urlEscapeLevels": {
- "type": "integer",
- "description": "Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.",
- "format": "int32"
- }
- }
- },
- "EventTagOverride": {
- "id": "EventTagOverride",
- "type": "object",
- "description": "Event tag override information.",
- "properties": {
- "enabled": {
- "type": "boolean",
- "description": "Whether this override is enabled."
- },
- "id": {
- "type": "string",
- "description": "ID of this event tag override. This is a read-only, auto-generated field.",
- "format": "int64"
- }
- }
- },
- "EventTagsListResponse": {
- "id": "EventTagsListResponse",
- "type": "object",
- "description": "Event Tag List Response",
- "properties": {
- "eventTags": {
- "type": "array",
- "description": "Event tag collection.",
- "items": {
- "$ref": "EventTag"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#eventTagsListResponse\".",
- "default": "dfareporting#eventTagsListResponse"
- }
- }
- },
- "File": {
- "id": "File",
- "type": "object",
- "description": "Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is \"REPORT_AVAILABLE\".",
- "properties": {
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range for which the file has report data. The date range will always be the absolute date range for which the report is run."
- },
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "fileName": {
- "type": "string",
- "description": "The filename of the file."
- },
- "format": {
- "type": "string",
- "description": "The output format of the report. Only available once the file is available.",
- "enum": [
- "CSV",
- "EXCEL"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "id": {
- "type": "string",
- "description": "The unique ID of this report file.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#file.",
- "default": "dfareporting#file"
- },
- "lastModifiedTime": {
- "type": "string",
- "description": "The timestamp in milliseconds since epoch when this file was last modified.",
- "format": "int64"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report this file was generated from.",
- "format": "int64"
- },
- "status": {
- "type": "string",
- "description": "The status of the report file.",
- "enum": [
- "CANCELLED",
- "FAILED",
- "PROCESSING",
- "REPORT_AVAILABLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- },
- "urls": {
- "type": "object",
- "description": "The URLs where the completed report file can be downloaded.",
- "properties": {
- "apiUrl": {
- "type": "string",
- "description": "The URL for downloading the report data through the API."
- },
- "browserUrl": {
- "type": "string",
- "description": "The URL for downloading the report data through a browser."
- }
- }
- }
- }
- },
- "FileList": {
- "id": "FileList",
- "type": "object",
- "description": "Represents the list of File resources.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The files returned in this response.",
- "items": {
- "$ref": "File"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of list this is, in this case dfareporting#fileList.",
- "default": "dfareporting#fileList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through files. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted."
- }
- }
- },
- "Flight": {
- "id": "Flight",
- "type": "object",
- "description": "Flight",
- "properties": {
- "endDate": {
- "type": "string",
- "description": "Inventory item flight end date.",
- "format": "date"
- },
- "rateOrCost": {
- "type": "string",
- "description": "Rate or cost of this flight.",
- "format": "int64"
- },
- "startDate": {
- "type": "string",
- "description": "Inventory item flight start date.",
- "format": "date"
- },
- "units": {
- "type": "string",
- "description": "Units of this flight.",
- "format": "int64"
- }
- }
- },
- "FloodlightActivitiesGenerateTagResponse": {
- "id": "FloodlightActivitiesGenerateTagResponse",
- "type": "object",
- "description": "Floodlight Activity GenerateTag Response",
- "properties": {
- "floodlightActivityTag": {
- "type": "string",
- "description": "Generated tag for this floodlight activity."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivitiesGenerateTagResponse\".",
- "default": "dfareporting#floodlightActivitiesGenerateTagResponse"
- }
- }
- },
- "FloodlightActivitiesListResponse": {
- "id": "FloodlightActivitiesListResponse",
- "type": "object",
- "description": "Floodlight Activity List Response",
- "properties": {
- "floodlightActivities": {
- "type": "array",
- "description": "Floodlight activity collection.",
- "items": {
- "$ref": "FloodlightActivity"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivitiesListResponse\".",
- "default": "dfareporting#floodlightActivitiesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "FloodlightActivity": {
- "id": "FloodlightActivity",
- "type": "object",
- "description": "Contains properties of a Floodlight activity.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this floodlight activity. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "cacheBustingType": {
- "type": "string",
- "description": "Code type used for cache busting in the generated tag.",
- "enum": [
- "ACTIVE_SERVER_PAGE",
- "COLD_FUSION",
- "JAVASCRIPT",
- "JSP",
- "PHP"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "countingMethod": {
- "type": "string",
- "description": "Counting method for conversions for this floodlight activity. This is a required field.",
- "enum": [
- "ITEMS_SOLD_COUNTING",
- "SESSION_COUNTING",
- "STANDARD_COUNTING",
- "TRANSACTIONS_COUNTING",
- "UNIQUE_COUNTING"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "defaultTags": {
- "type": "array",
- "description": "Dynamic floodlight tags.",
- "items": {
- "$ref": "FloodlightActivityDynamicTag"
- }
- },
- "expectedUrl": {
- "type": "string",
- "description": "URL where this tag will be deployed. If specified, must be less than 256 characters long."
- },
- "floodlightActivityGroupId": {
- "type": "string",
- "description": "Floodlight activity group ID of this floodlight activity. This is a required field.",
- "format": "int64"
- },
- "floodlightActivityGroupName": {
- "type": "string",
- "description": "Name of the associated floodlight activity group. This is a read-only field."
- },
- "floodlightActivityGroupTagString": {
- "type": "string",
- "description": "Tag string of the associated floodlight activity group. This is a read-only field."
- },
- "floodlightActivityGroupType": {
- "type": "string",
- "description": "Type of the associated floodlight activity group. This is a read-only field.",
- "enum": [
- "COUNTER",
- "SALE"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "floodlightConfigurationId": {
- "type": "string",
- "description": "Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.",
- "format": "int64"
- },
- "floodlightConfigurationIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field."
- },
- "hidden": {
- "type": "boolean",
- "description": "Whether this activity is archived."
- },
- "id": {
- "type": "string",
- "description": "ID of this floodlight activity. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field."
- },
- "imageTagEnabled": {
- "type": "boolean",
- "description": "Whether the image tag is enabled for this activity."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivity\".",
- "default": "dfareporting#floodlightActivity"
- },
- "name": {
- "type": "string",
- "description": "Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes."
- },
- "notes": {
- "type": "string",
- "description": "General notes or implementation instructions for the tag."
- },
- "publisherTags": {
- "type": "array",
- "description": "Publisher dynamic floodlight tags.",
- "items": {
- "$ref": "FloodlightActivityPublisherDynamicTag"
- }
- },
- "secure": {
- "type": "boolean",
- "description": "Whether this tag should use SSL."
- },
- "sslCompliant": {
- "type": "boolean",
- "description": "Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags."
- },
- "sslRequired": {
- "type": "boolean",
- "description": "Whether this floodlight activity must be SSL-compliant."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "tagFormat": {
- "type": "string",
- "description": "Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.",
- "enum": [
- "HTML",
- "XHTML"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "tagString": {
- "type": "string",
- "description": "Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion."
- },
- "userDefinedVariableTypes": {
- "type": "array",
- "description": "List of the user-defined variables used by this conversion tag. These map to the \"u[1-20]=\" in the tags. Each of these can have a user defined type.\nAcceptable values are:\n- \"U1\"\n- \"U2\"\n- \"U3\"\n- \"U4\"\n- \"U5\"\n- \"U6\"\n- \"U7\"\n- \"U8\"\n- \"U9\"\n- \"U10\"\n- \"U11\"\n- \"U12\"\n- \"U13\"\n- \"U14\"\n- \"U15\"\n- \"U16\"\n- \"U17\"\n- \"U18\"\n- \"U19\"\n- \"U20\"",
- "items": {
- "type": "string",
- "enum": [
- "U1",
- "U10",
- "U11",
- "U12",
- "U13",
- "U14",
- "U15",
- "U16",
- "U17",
- "U18",
- "U19",
- "U2",
- "U20",
- "U3",
- "U4",
- "U5",
- "U6",
- "U7",
- "U8",
- "U9"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- }
- }
- },
- "FloodlightActivityDynamicTag": {
- "id": "FloodlightActivityDynamicTag",
- "type": "object",
- "description": "Dynamic Tag",
- "properties": {
- "id": {
- "type": "string",
- "description": "ID of this dynamic tag. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "name": {
- "type": "string",
- "description": "Name of this tag."
- },
- "tag": {
- "type": "string",
- "description": "Tag code."
- }
- }
- },
- "FloodlightActivityGroup": {
- "id": "FloodlightActivityGroup",
- "type": "object",
- "description": "Contains properties of a Floodlight activity group.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this floodlight activity group. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "floodlightConfigurationId": {
- "type": "string",
- "description": "Floodlight configuration ID of this floodlight activity group. This is a required field.",
- "format": "int64"
- },
- "floodlightConfigurationIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field."
- },
- "id": {
- "type": "string",
- "description": "ID of this floodlight activity group. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivityGroup\".",
- "default": "dfareporting#floodlightActivityGroup"
- },
- "name": {
- "type": "string",
- "description": "Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "tagString": {
- "type": "string",
- "description": "Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion."
- },
- "type": {
- "type": "string",
- "description": "Type of the floodlight activity group. This is a required field that is read-only after insertion.",
- "enum": [
- "COUNTER",
- "SALE"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- }
- }
- },
- "FloodlightActivityGroupsListResponse": {
- "id": "FloodlightActivityGroupsListResponse",
- "type": "object",
- "description": "Floodlight Activity Group List Response",
- "properties": {
- "floodlightActivityGroups": {
- "type": "array",
- "description": "Floodlight activity group collection.",
- "items": {
- "$ref": "FloodlightActivityGroup"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivityGroupsListResponse\".",
- "default": "dfareporting#floodlightActivityGroupsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "FloodlightActivityPublisherDynamicTag": {
- "id": "FloodlightActivityPublisherDynamicTag",
- "type": "object",
- "description": "Publisher Dynamic Tag",
- "properties": {
- "clickThrough": {
- "type": "boolean",
- "description": "Whether this tag is applicable only for click-throughs."
- },
- "directorySiteId": {
- "type": "string",
- "description": "Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.",
- "format": "int64"
- },
- "dynamicTag": {
- "$ref": "FloodlightActivityDynamicTag",
- "description": "Dynamic floodlight tag."
- },
- "siteId": {
- "type": "string",
- "description": "Site ID of this dynamic tag.",
- "format": "int64"
- },
- "siteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field."
- },
- "viewThrough": {
- "type": "boolean",
- "description": "Whether this tag is applicable only for view-throughs."
- }
- }
- },
- "FloodlightConfiguration": {
- "id": "FloodlightConfiguration",
- "type": "object",
- "description": "Contains properties of a Floodlight configuration.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this floodlight configuration. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of the parent advertiser of this floodlight configuration.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "analyticsDataSharingEnabled": {
- "type": "boolean",
- "description": "Whether advertiser data is shared with Google Analytics."
- },
- "exposureToConversionEnabled": {
- "type": "boolean",
- "description": "Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting."
- },
- "firstDayOfWeek": {
- "type": "string",
- "description": "Day that will be counted as the first day of the week in reports. This is a required field.",
- "enum": [
- "MONDAY",
- "SUNDAY"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "id": {
- "type": "string",
- "description": "ID of this floodlight configuration. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field."
- },
- "inAppAttributionTrackingEnabled": {
- "type": "boolean",
- "description": "Whether in-app attribution tracking is enabled."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightConfiguration\".",
- "default": "dfareporting#floodlightConfiguration"
- },
- "lookbackConfiguration": {
- "$ref": "LookbackConfiguration",
- "description": "Lookback window settings for this floodlight configuration."
- },
- "naturalSearchConversionAttributionOption": {
- "type": "string",
- "description": "Types of attribution options for natural search conversions.",
- "enum": [
- "EXCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION",
- "INCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION",
- "INCLUDE_NATURAL_SEARCH_TIERED_CONVERSION_ATTRIBUTION"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "omnitureSettings": {
- "$ref": "OmnitureSettings",
- "description": "Settings for DCM Omniture integration."
- },
- "sslRequired": {
- "type": "boolean",
- "description": "Whether floodlight activities owned by this configuration are required to be SSL-compliant."
- },
- "standardVariableTypes": {
- "type": "array",
- "description": "List of standard variables enabled for this configuration.\n\nAcceptable values are:\n- \"ORD\"\n- \"NUM\"",
- "items": {
- "type": "string",
- "enum": [
- "NUM",
- "ORD",
- "TRAN",
- "U"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- }
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "tagSettings": {
- "$ref": "TagSettings",
- "description": "Configuration settings for dynamic and image floodlight tags."
- },
- "thirdPartyAuthenticationTokens": {
- "type": "array",
- "description": "List of third-party authentication tokens enabled for this configuration.",
- "items": {
- "$ref": "ThirdPartyAuthenticationToken"
- }
- },
- "userDefinedVariableConfigurations": {
- "type": "array",
- "description": "List of user defined variables enabled for this configuration.",
- "items": {
- "$ref": "UserDefinedVariableConfiguration"
- }
- }
- }
- },
- "FloodlightConfigurationsListResponse": {
- "id": "FloodlightConfigurationsListResponse",
- "type": "object",
- "description": "Floodlight Configuration List Response",
- "properties": {
- "floodlightConfigurations": {
- "type": "array",
- "description": "Floodlight configuration collection.",
- "items": {
- "$ref": "FloodlightConfiguration"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightConfigurationsListResponse\".",
- "default": "dfareporting#floodlightConfigurationsListResponse"
- }
- }
- },
- "FloodlightReportCompatibleFields": {
- "id": "FloodlightReportCompatibleFields",
- "type": "object",
- "description": "Represents fields that are compatible to be selected for a report of type \"FlOODLIGHT\".",
- "properties": {
- "dimensionFilters": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields.",
- "default": "dfareporting#floodlightReportCompatibleFields"
- },
- "metrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- }
- }
- },
- "FrequencyCap": {
- "id": "FrequencyCap",
- "type": "object",
- "description": "Frequency Cap.",
- "properties": {
- "duration": {
- "type": "string",
- "description": "Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.",
- "format": "int64"
- },
- "impressions": {
- "type": "string",
- "description": "Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.",
- "format": "int64"
- }
- }
- },
- "FsCommand": {
- "id": "FsCommand",
- "type": "object",
- "description": "FsCommand.",
- "properties": {
- "left": {
- "type": "integer",
- "description": "Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.",
- "format": "int32"
- },
- "positionOption": {
- "type": "string",
- "description": "Position in the browser where the window will open.",
- "enum": [
- "CENTERED",
- "DISTANCE_FROM_TOP_LEFT_CORNER"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "top": {
- "type": "integer",
- "description": "Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.",
- "format": "int32"
- },
- "windowHeight": {
- "type": "integer",
- "description": "Height of the window.",
- "format": "int32"
- },
- "windowWidth": {
- "type": "integer",
- "description": "Width of the window.",
- "format": "int32"
- }
- }
- },
- "GeoTargeting": {
- "id": "GeoTargeting",
- "type": "object",
- "description": "Geographical Targeting.",
- "properties": {
- "cities": {
- "type": "array",
- "description": "Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.",
- "items": {
- "$ref": "City"
- }
- },
- "countries": {
- "type": "array",
- "description": "Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.",
- "items": {
- "$ref": "Country"
- }
- },
- "excludeCountries": {
- "type": "boolean",
- "description": "Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad."
- },
- "metros": {
- "type": "array",
- "description": "Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.",
- "items": {
- "$ref": "Metro"
- }
- },
- "postalCodes": {
- "type": "array",
- "description": "Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.",
- "items": {
- "$ref": "PostalCode"
- }
- },
- "regions": {
- "type": "array",
- "description": "Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.",
- "items": {
- "$ref": "Region"
- }
- }
- }
- },
- "InventoryItem": {
- "id": "InventoryItem",
- "type": "object",
- "description": "Represents a buy from the DoubleClick Planning inventory store.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this inventory item.",
- "format": "int64"
- },
- "adSlots": {
- "type": "array",
- "description": "Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group.",
- "items": {
- "$ref": "AdSlot"
- }
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this inventory item.",
- "format": "int64"
- },
- "contentCategoryId": {
- "type": "string",
- "description": "Content category ID of this inventory item.",
- "format": "int64"
- },
- "estimatedClickThroughRate": {
- "type": "string",
- "description": "Estimated click-through rate of this inventory item.",
- "format": "int64"
- },
- "estimatedConversionRate": {
- "type": "string",
- "description": "Estimated conversion rate of this inventory item.",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "ID of this inventory item.",
- "format": "int64"
- },
- "inPlan": {
- "type": "boolean",
- "description": "Whether this inventory item is in plan."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#inventoryItem\".",
- "default": "dfareporting#inventoryItem"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this inventory item."
- },
- "name": {
- "type": "string",
- "description": "Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots."
- },
- "negotiationChannelId": {
- "type": "string",
- "description": "Negotiation channel ID of this inventory item.",
- "format": "int64"
- },
- "orderId": {
- "type": "string",
- "description": "Order ID of this inventory item.",
- "format": "int64"
- },
- "placementStrategyId": {
- "type": "string",
- "description": "Placement strategy ID of this inventory item.",
- "format": "int64"
- },
- "pricing": {
- "$ref": "Pricing",
- "description": "Pricing of this inventory item."
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of this inventory item.",
- "format": "int64"
- },
- "rfpId": {
- "type": "string",
- "description": "RFP ID of this inventory item.",
- "format": "int64"
- },
- "siteId": {
- "type": "string",
- "description": "ID of the site this inventory item is associated with.",
- "format": "int64"
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this inventory item.",
- "format": "int64"
- }
- }
- },
- "InventoryItemsListResponse": {
- "id": "InventoryItemsListResponse",
- "type": "object",
- "description": "Inventory item List Response",
- "properties": {
- "inventoryItems": {
- "type": "array",
- "description": "Inventory item collection",
- "items": {
- "$ref": "InventoryItem"
- }
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#inventoryItemsListResponse\".",
- "default": "dfareporting#inventoryItemsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- }
- }
- },
- "KeyValueTargetingExpression": {
- "id": "KeyValueTargetingExpression",
- "type": "object",
- "description": "Key Value Targeting Expression.",
- "properties": {
- "expression": {
- "type": "string",
- "description": "Keyword expression being targeted by the ad."
- }
- }
- },
- "LandingPage": {
- "id": "LandingPage",
- "type": "object",
- "description": "Contains information about where a user's browser is taken after the user clicks an ad.",
- "properties": {
- "default": {
- "type": "boolean",
- "description": "Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign."
- },
- "id": {
- "type": "string",
- "description": "ID of this landing page. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#landingPage\".",
- "default": "dfareporting#landingPage"
- },
- "name": {
- "type": "string",
- "description": "Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign."
- },
- "url": {
- "type": "string",
- "description": "URL of this landing page. This is a required field."
- }
- }
- },
- "LandingPagesListResponse": {
- "id": "LandingPagesListResponse",
- "type": "object",
- "description": "Landing Page List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#landingPagesListResponse\".",
- "default": "dfareporting#landingPagesListResponse"
- },
- "landingPages": {
- "type": "array",
- "description": "Landing page collection",
- "items": {
- "$ref": "LandingPage"
- }
- }
- }
- },
- "LastModifiedInfo": {
- "id": "LastModifiedInfo",
- "type": "object",
- "description": "Modification timestamp.",
- "properties": {
- "time": {
- "type": "string",
- "description": "Timestamp of the last change in milliseconds since epoch.",
- "format": "int64"
- }
- }
- },
- "ListPopulationClause": {
- "id": "ListPopulationClause",
- "type": "object",
- "description": "A group clause made up of list population terms representing constraints joined by ORs.",
- "properties": {
- "terms": {
- "type": "array",
- "description": "Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.",
- "items": {
- "$ref": "ListPopulationTerm"
- }
- }
- }
- },
- "ListPopulationRule": {
- "id": "ListPopulationRule",
- "type": "object",
- "description": "Remarketing List Population Rule.",
- "properties": {
- "floodlightActivityId": {
- "type": "string",
- "description": "Floodlight activity ID associated with this rule. This field can be left blank.",
- "format": "int64"
- },
- "floodlightActivityName": {
- "type": "string",
- "description": "Name of floodlight activity associated with this rule. This is a read-only, auto-generated field."
- },
- "listPopulationClauses": {
- "type": "array",
- "description": "Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.",
- "items": {
- "$ref": "ListPopulationClause"
- }
- }
- }
- },
- "ListPopulationTerm": {
- "id": "ListPopulationTerm",
- "type": "object",
- "description": "Remarketing List Population Rule Term.",
- "properties": {
- "contains": {
- "type": "boolean",
- "description": "Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default."
- },
- "negation": {
- "type": "boolean",
- "description": "Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM."
- },
- "operator": {
- "type": "string",
- "description": "Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.",
- "enum": [
- "NUM_EQUALS",
- "NUM_GREATER_THAN",
- "NUM_GREATER_THAN_EQUAL",
- "NUM_LESS_THAN",
- "NUM_LESS_THAN_EQUAL",
- "STRING_CONTAINS",
- "STRING_EQUALS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "remarketingListId": {
- "type": "string",
- "description": "ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.",
- "format": "int64"
- },
- "type": {
- "type": "string",
- "description": "List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.",
- "enum": [
- "CUSTOM_VARIABLE_TERM",
- "LIST_MEMBERSHIP_TERM",
- "REFERRER_TERM"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "value": {
- "type": "string",
- "description": "Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM."
- },
- "variableFriendlyName": {
- "type": "string",
- "description": "Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM."
- },
- "variableName": {
- "type": "string",
- "description": "Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM."
- }
- }
- },
- "ListTargetingExpression": {
- "id": "ListTargetingExpression",
- "type": "object",
- "description": "Remarketing List Targeting Expression.",
- "properties": {
- "expression": {
- "type": "string",
- "description": "Expression describing which lists are being targeted by the ad."
- }
- }
- },
- "LookbackConfiguration": {
- "id": "LookbackConfiguration",
- "type": "object",
- "description": "Lookback configuration settings.",
- "properties": {
- "clickDuration": {
- "type": "integer",
- "description": "Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.",
- "format": "int32"
- },
- "postImpressionActivitiesDuration": {
- "type": "integer",
- "description": "Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.",
- "format": "int32"
- }
- }
- },
- "Metric": {
- "id": "Metric",
- "type": "object",
- "description": "Represents a metric.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#metric.",
- "default": "dfareporting#metric"
- },
- "name": {
- "type": "string",
- "description": "The metric name, e.g. dfa:impressions"
- }
- }
- },
- "Metro": {
- "id": "Metro",
- "type": "object",
- "description": "Contains information about a metro region that can be targeted by ads.",
- "properties": {
- "countryCode": {
- "type": "string",
- "description": "Country code of the country to which this metro region belongs."
- },
- "countryDartId": {
- "type": "string",
- "description": "DART ID of the country to which this metro region belongs.",
- "format": "int64"
- },
- "dartId": {
- "type": "string",
- "description": "DART ID of this metro region.",
- "format": "int64"
- },
- "dmaId": {
- "type": "string",
- "description": "DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#metro\".",
- "default": "dfareporting#metro"
- },
- "metroCode": {
- "type": "string",
- "description": "Metro code of this metro region. This is equivalent to dma_id."
- },
- "name": {
- "type": "string",
- "description": "Name of this metro region."
- }
- }
- },
- "MetrosListResponse": {
- "id": "MetrosListResponse",
- "type": "object",
- "description": "Metro List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#metrosListResponse\".",
- "default": "dfareporting#metrosListResponse"
- },
- "metros": {
- "type": "array",
- "description": "Metro collection.",
- "items": {
- "$ref": "Metro"
- }
- }
- }
- },
- "MobileCarrier": {
- "id": "MobileCarrier",
- "type": "object",
- "description": "Contains information about a mobile carrier that can be targeted by ads.",
- "properties": {
- "countryCode": {
- "type": "string",
- "description": "Country code of the country to which this mobile carrier belongs."
- },
- "countryDartId": {
- "type": "string",
- "description": "DART ID of the country to which this mobile carrier belongs.",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "ID of this mobile carrier.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileCarrier\".",
- "default": "dfareporting#mobileCarrier"
- },
- "name": {
- "type": "string",
- "description": "Name of this mobile carrier."
- }
- }
- },
- "MobileCarriersListResponse": {
- "id": "MobileCarriersListResponse",
- "type": "object",
- "description": "Mobile Carrier List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#mobileCarriersListResponse\".",
- "default": "dfareporting#mobileCarriersListResponse"
- },
- "mobileCarriers": {
- "type": "array",
- "description": "Mobile carrier collection.",
- "items": {
- "$ref": "MobileCarrier"
- }
- }
- }
- },
- "ObjectFilter": {
- "id": "ObjectFilter",
- "type": "object",
- "description": "Object Filter.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#objectFilter\".",
- "default": "dfareporting#objectFilter"
- },
- "objectIds": {
- "type": "array",
- "description": "Applicable when status is ASSIGNED. The user has access to objects with these object IDs.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "status": {
- "type": "string",
- "description": "Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.",
- "enum": [
- "ALL",
- "ASSIGNED",
- "NONE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- }
- }
- },
- "OffsetPosition": {
- "id": "OffsetPosition",
- "type": "object",
- "description": "Offset Position.",
- "properties": {
- "left": {
- "type": "integer",
- "description": "Offset distance from left side of an asset or a window.",
- "format": "int32"
- },
- "top": {
- "type": "integer",
- "description": "Offset distance from top side of an asset or a window.",
- "format": "int32"
- }
- }
- },
- "OmnitureSettings": {
- "id": "OmnitureSettings",
- "type": "object",
- "description": "Omniture Integration Settings.",
- "properties": {
- "omnitureCostDataEnabled": {
- "type": "boolean",
- "description": "Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true."
- },
- "omnitureIntegrationEnabled": {
- "type": "boolean",
- "description": "Whether Omniture integration is enabled. This property can be enabled only when the \"Advanced Ad Serving\" account setting is enabled."
- }
- }
- },
- "OperatingSystem": {
- "id": "OperatingSystem",
- "type": "object",
- "description": "Contains information about an operating system that can be targeted by ads.",
- "properties": {
- "dartId": {
- "type": "string",
- "description": "DART ID of this operating system. This is the ID used for targeting.",
- "format": "int64"
- },
- "desktop": {
- "type": "boolean",
- "description": "Whether this operating system is for desktop."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystem\".",
- "default": "dfareporting#operatingSystem"
- },
- "mobile": {
- "type": "boolean",
- "description": "Whether this operating system is for mobile."
- },
- "name": {
- "type": "string",
- "description": "Name of this operating system."
- }
- }
- },
- "OperatingSystemVersion": {
- "id": "OperatingSystemVersion",
- "type": "object",
- "description": "Contains information about a particular version of an operating system that can be targeted by ads.",
- "properties": {
- "id": {
- "type": "string",
- "description": "ID of this operating system version.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemVersion\".",
- "default": "dfareporting#operatingSystemVersion"
- },
- "majorVersion": {
- "type": "string",
- "description": "Major version (leftmost number) of this operating system version."
- },
- "minorVersion": {
- "type": "string",
- "description": "Minor version (number after the first dot) of this operating system version."
- },
- "name": {
- "type": "string",
- "description": "Name of this operating system version."
- },
- "operatingSystem": {
- "$ref": "OperatingSystem",
- "description": "Operating system of this operating system version."
- }
- }
- },
- "OperatingSystemVersionsListResponse": {
- "id": "OperatingSystemVersionsListResponse",
- "type": "object",
- "description": "Operating System Version List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemVersionsListResponse\".",
- "default": "dfareporting#operatingSystemVersionsListResponse"
- },
- "operatingSystemVersions": {
- "type": "array",
- "description": "Operating system version collection.",
- "items": {
- "$ref": "OperatingSystemVersion"
- }
- }
- }
- },
- "OperatingSystemsListResponse": {
- "id": "OperatingSystemsListResponse",
- "type": "object",
- "description": "Operating System List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#operatingSystemsListResponse\".",
- "default": "dfareporting#operatingSystemsListResponse"
- },
- "operatingSystems": {
- "type": "array",
- "description": "Operating system collection.",
- "items": {
- "$ref": "OperatingSystem"
- }
- }
- }
- },
- "OptimizationActivity": {
- "id": "OptimizationActivity",
- "type": "object",
- "description": "Creative optimization activity.",
- "properties": {
- "floodlightActivityId": {
- "type": "string",
- "description": "Floodlight activity ID of this optimization activity. This is a required field.",
- "format": "int64"
- },
- "floodlightActivityIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field."
- },
- "weight": {
- "type": "integer",
- "description": "Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.",
- "format": "int32"
- }
- }
- },
- "Order": {
- "id": "Order",
- "type": "object",
- "description": "Describes properties of a DoubleClick Planning order.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this order.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this order.",
- "format": "int64"
- },
- "approverUserProfileIds": {
- "type": "array",
- "description": "IDs for users that have to approve documents created for this order.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "buyerInvoiceId": {
- "type": "string",
- "description": "Buyer invoice ID associated with this order."
- },
- "buyerOrganizationName": {
- "type": "string",
- "description": "Name of the buyer organization."
- },
- "comments": {
- "type": "string",
- "description": "Comments in this order."
- },
- "contacts": {
- "type": "array",
- "description": "Contacts for this order.",
- "items": {
- "$ref": "OrderContact"
- }
- },
- "id": {
- "type": "string",
- "description": "ID of this order. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#order\".",
- "default": "dfareporting#order"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this order."
- },
- "name": {
- "type": "string",
- "description": "Name of this order."
- },
- "notes": {
- "type": "string",
- "description": "Notes of this order."
- },
- "planningTermId": {
- "type": "string",
- "description": "ID of the terms and conditions template used in this order.",
- "format": "int64"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of this order.",
- "format": "int64"
- },
- "sellerOrderId": {
- "type": "string",
- "description": "Seller order ID associated with this order."
- },
- "sellerOrganizationName": {
- "type": "string",
- "description": "Name of the seller organization."
- },
- "siteId": {
- "type": "array",
- "description": "Site IDs this order is associated with.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "siteNames": {
- "type": "array",
- "description": "Free-form site names this order is associated with.",
- "items": {
- "type": "string"
- }
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this order.",
- "format": "int64"
- },
- "termsAndConditions": {
- "type": "string",
- "description": "Terms and conditions of this order."
- }
- }
- },
- "OrderContact": {
- "id": "OrderContact",
- "type": "object",
- "description": "Contact of an order.",
- "properties": {
- "contactInfo": {
- "type": "string",
- "description": "Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID."
- },
- "contactName": {
- "type": "string",
- "description": "Name of this contact."
- },
- "contactTitle": {
- "type": "string",
- "description": "Title of this contact."
- },
- "contactType": {
- "type": "string",
- "description": "Type of this contact.",
- "enum": [
- "PLANNING_ORDER_CONTACT_BUYER_BILLING_CONTACT",
- "PLANNING_ORDER_CONTACT_BUYER_CONTACT",
- "PLANNING_ORDER_CONTACT_SELLER_CONTACT"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "signatureUserProfileId": {
- "type": "string",
- "description": "ID of the user profile containing the signature that will be embedded into order documents.",
- "format": "int64"
- }
- }
- },
- "OrderDocument": {
- "id": "OrderDocument",
- "type": "object",
- "description": "Contains properties of a DoubleClick Planning order document.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this order document.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this order document.",
- "format": "int64"
- },
- "amendedOrderDocumentId": {
- "type": "string",
- "description": "The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved.",
- "format": "int64"
- },
- "approvedByUserProfileIds": {
- "type": "array",
- "description": "IDs of users who have approved this order document.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "cancelled": {
- "type": "boolean",
- "description": "Whether this order document is cancelled."
- },
- "createdInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the creation of this order document."
- },
- "effectiveDate": {
- "type": "string",
- "description": "Effective date of this order document.",
- "format": "date"
- },
- "id": {
- "type": "string",
- "description": "ID of this order document.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#orderDocument\".",
- "default": "dfareporting#orderDocument"
- },
- "lastSentRecipients": {
- "type": "array",
- "description": "List of email addresses that received the last sent document.",
- "items": {
- "type": "string"
- }
- },
- "lastSentTime": {
- "type": "string",
- "description": "Timestamp of the last email sent with this order document.",
- "format": "date-time"
- },
- "orderId": {
- "type": "string",
- "description": "ID of the order from which this order document is created.",
- "format": "int64"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID of this order document.",
- "format": "int64"
- },
- "signed": {
- "type": "boolean",
- "description": "Whether this order document has been signed."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this order document.",
- "format": "int64"
- },
- "title": {
- "type": "string",
- "description": "Title of this order document."
- },
- "type": {
- "type": "string",
- "description": "Type of this order document",
- "enum": [
- "PLANNING_ORDER_TYPE_CHANGE_ORDER",
- "PLANNING_ORDER_TYPE_INSERTION_ORDER"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- }
- }
- },
- "OrderDocumentsListResponse": {
- "id": "OrderDocumentsListResponse",
- "type": "object",
- "description": "Order document List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#orderDocumentsListResponse\".",
- "default": "dfareporting#orderDocumentsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- },
- "orderDocuments": {
- "type": "array",
- "description": "Order document collection",
- "items": {
- "$ref": "OrderDocument"
- }
- }
- }
- },
- "OrdersListResponse": {
- "id": "OrdersListResponse",
- "type": "object",
- "description": "Order List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#ordersListResponse\".",
- "default": "dfareporting#ordersListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- },
- "orders": {
- "type": "array",
- "description": "Order collection.",
- "items": {
- "$ref": "Order"
- }
- }
- }
- },
- "PathToConversionReportCompatibleFields": {
- "id": "PathToConversionReportCompatibleFields",
- "type": "object",
- "description": "Represents fields that are compatible to be selected for a report of type \"PATH_TO_CONVERSION\".",
- "properties": {
- "conversionDimensions": {
- "type": "array",
- "description": "Conversion dimensions which are compatible to be selected in the \"conversionDimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "customFloodlightVariables": {
- "type": "array",
- "description": "Custom floodlight variables which are compatible to be selected in the \"customFloodlightVariables\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields.",
- "default": "dfareporting#pathToConversionReportCompatibleFields"
- },
- "metrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- },
- "perInteractionDimensions": {
- "type": "array",
- "description": "Per-interaction dimensions which are compatible to be selected in the \"perInteractionDimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- }
- }
- },
- "Placement": {
- "id": "Placement",
- "type": "object",
- "description": "Contains properties of a placement.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this placement. This field can be left blank.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this placement. This field can be left blank.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "archived": {
- "type": "boolean",
- "description": "Whether this placement is archived."
- },
- "campaignId": {
- "type": "string",
- "description": "Campaign ID of this placement. This field is a required field on insertion.",
- "format": "int64"
- },
- "campaignIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
- },
- "comment": {
- "type": "string",
- "description": "Comments for this placement."
- },
- "compatibility": {
- "type": "string",
- "description": "Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.",
- "enum": [
- "APP",
- "APP_INTERSTITIAL",
- "IN_STREAM_VIDEO",
- "WEB",
- "WEB_INTERSTITIAL"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "contentCategoryId": {
- "type": "string",
- "description": "ID of the content category assigned to this placement.",
- "format": "int64"
- },
- "createInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the creation of this placement. This is a read-only field."
- },
- "directorySiteId": {
- "type": "string",
- "description": "Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.",
- "format": "int64"
- },
- "directorySiteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field."
- },
- "externalId": {
- "type": "string",
- "description": "External ID for this placement."
- },
- "id": {
- "type": "string",
- "description": "ID of this placement. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this placement. This is a read-only, auto-generated field."
- },
- "keyName": {
- "type": "string",
- "description": "Key name of this placement. This is a read-only, auto-generated field."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placement\".",
- "default": "dfareporting#placement"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this placement. This is a read-only field."
- },
- "lookbackConfiguration": {
- "$ref": "LookbackConfiguration",
- "description": "Lookback window settings for this placement."
- },
- "name": {
- "type": "string",
- "description": "Name of this placement.This is a required field and must be less than 256 characters long."
- },
- "paymentApproved": {
- "type": "boolean",
- "description": "Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements."
- },
- "paymentSource": {
- "type": "string",
- "description": "Payment source for this placement. This is a required field that is read-only after insertion.",
- "enum": [
- "PLACEMENT_AGENCY_PAID",
- "PLACEMENT_PUBLISHER_PAID"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "placementGroupId": {
- "type": "string",
- "description": "ID of this placement's group, if applicable.",
- "format": "int64"
- },
- "placementGroupIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the placement group. This is a read-only, auto-generated field."
- },
- "placementStrategyId": {
- "type": "string",
- "description": "ID of the placement strategy assigned to this placement.",
- "format": "int64"
- },
- "pricingSchedule": {
- "$ref": "PricingSchedule",
- "description": "Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType."
- },
- "primary": {
- "type": "boolean",
- "description": "Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement."
- },
- "publisherUpdateInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the last publisher update. This is a read-only field."
- },
- "siteId": {
- "type": "string",
- "description": "Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.",
- "format": "int64"
- },
- "siteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field."
- },
- "size": {
- "$ref": "Size",
- "description": "Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion."
- },
- "sslRequired": {
- "type": "boolean",
- "description": "Whether creatives assigned to this placement must be SSL-compliant."
- },
- "status": {
- "type": "string",
- "description": "Third-party placement status.",
- "enum": [
- "ACKNOWLEDGE_ACCEPTANCE",
- "ACKNOWLEDGE_REJECTION",
- "DRAFT",
- "PAYMENT_ACCEPTED",
- "PAYMENT_REJECTED",
- "PENDING_REVIEW"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this placement. This field can be left blank.",
- "format": "int64"
- },
- "tagFormats": {
- "type": "array",
- "description": "Tag formats to generate for this placement. This field is required on insertion.\nAcceptable values are:\n- \"PLACEMENT_TAG_STANDARD\"\n- \"PLACEMENT_TAG_IFRAME_JAVASCRIPT\"\n- \"PLACEMENT_TAG_IFRAME_ILAYER\"\n- \"PLACEMENT_TAG_INTERNAL_REDIRECT\"\n- \"PLACEMENT_TAG_JAVASCRIPT\"\n- \"PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT\"\n- \"PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT\"\n- \"PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT\"\n- \"PLACEMENT_TAG_CLICK_COMMANDS\"\n- \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH\"\n- \"PLACEMENT_TAG_TRACKING\"\n- \"PLACEMENT_TAG_TRACKING_IFRAME\"\n- \"PLACEMENT_TAG_TRACKING_JAVASCRIPT\"",
- "items": {
- "type": "string",
- "enum": [
- "PLACEMENT_TAG_CLICK_COMMANDS",
- "PLACEMENT_TAG_IFRAME_ILAYER",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
- "PLACEMENT_TAG_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_JAVASCRIPT",
- "PLACEMENT_TAG_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_STANDARD",
- "PLACEMENT_TAG_TRACKING",
- "PLACEMENT_TAG_TRACKING_IFRAME",
- "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- },
- "tagSetting": {
- "$ref": "TagSetting",
- "description": "Tag settings for this placement."
- }
- }
- },
- "PlacementAssignment": {
- "id": "PlacementAssignment",
- "type": "object",
- "description": "Placement Assignment.",
- "properties": {
- "active": {
- "type": "boolean",
- "description": "Whether this placement assignment is active. When true, the placement will be included in the ad's rotation."
- },
- "placementId": {
- "type": "string",
- "description": "ID of the placement to be assigned. This is a required field.",
- "format": "int64"
- },
- "placementIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the placement. This is a read-only, auto-generated field."
- },
- "sslRequired": {
- "type": "boolean",
- "description": "Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated."
- }
- }
- },
- "PlacementGroup": {
- "id": "PlacementGroup",
- "type": "object",
- "description": "Contains properties of a package or roadblock.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this placement group. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this placement group. This is a required field on insertion.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "archived": {
- "type": "boolean",
- "description": "Whether this placement group is archived."
- },
- "campaignId": {
- "type": "string",
- "description": "Campaign ID of this placement group. This field is required on insertion.",
- "format": "int64"
- },
- "campaignIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the campaign. This is a read-only, auto-generated field."
- },
- "childPlacementIds": {
- "type": "array",
- "description": "IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "comment": {
- "type": "string",
- "description": "Comments for this placement group."
- },
- "contentCategoryId": {
- "type": "string",
- "description": "ID of the content category assigned to this placement group.",
- "format": "int64"
- },
- "createInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the creation of this placement group. This is a read-only field."
- },
- "directorySiteId": {
- "type": "string",
- "description": "Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.",
- "format": "int64"
- },
- "directorySiteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field."
- },
- "externalId": {
- "type": "string",
- "description": "External ID for this placement."
- },
- "id": {
- "type": "string",
- "description": "ID of this placement group. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this placement group. This is a read-only, auto-generated field."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementGroup\".",
- "default": "dfareporting#placementGroup"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this placement group. This is a read-only field."
- },
- "name": {
- "type": "string",
- "description": "Name of this placement group. This is a required field and must be less than 256 characters long."
- },
- "placementGroupType": {
- "type": "string",
- "description": "Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.",
- "enum": [
- "PLACEMENT_PACKAGE",
- "PLACEMENT_ROADBLOCK"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "placementStrategyId": {
- "type": "string",
- "description": "ID of the placement strategy assigned to this placement group.",
- "format": "int64"
- },
- "pricingSchedule": {
- "$ref": "PricingSchedule",
- "description": "Pricing schedule of this placement group. This field is required on insertion."
- },
- "primaryPlacementId": {
- "type": "string",
- "description": "ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.",
- "format": "int64"
- },
- "primaryPlacementIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the primary placement. This is a read-only, auto-generated field."
- },
- "siteId": {
- "type": "string",
- "description": "Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.",
- "format": "int64"
- },
- "siteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this placement group. This is a read-only field that can be left blank.",
- "format": "int64"
- }
- }
- },
- "PlacementGroupsListResponse": {
- "id": "PlacementGroupsListResponse",
- "type": "object",
- "description": "Placement Group List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementGroupsListResponse\".",
- "default": "dfareporting#placementGroupsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- },
- "placementGroups": {
- "type": "array",
- "description": "Placement group collection.",
- "items": {
- "$ref": "PlacementGroup"
- }
- }
- }
- },
- "PlacementStrategiesListResponse": {
- "id": "PlacementStrategiesListResponse",
- "type": "object",
- "description": "Placement Strategy List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementStrategiesListResponse\".",
- "default": "dfareporting#placementStrategiesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- },
- "placementStrategies": {
- "type": "array",
- "description": "Placement strategy collection.",
- "items": {
- "$ref": "PlacementStrategy"
- }
- }
- }
- },
- "PlacementStrategy": {
- "id": "PlacementStrategy",
- "type": "object",
- "description": "Contains properties of a placement strategy.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this placement strategy.This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "ID of this placement strategy. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementStrategy\".",
- "default": "dfareporting#placementStrategy"
- },
- "name": {
- "type": "string",
- "description": "Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account."
- }
- }
- },
- "PlacementTag": {
- "id": "PlacementTag",
- "type": "object",
- "description": "Placement Tag",
- "properties": {
- "placementId": {
- "type": "string",
- "description": "Placement ID",
- "format": "int64"
- },
- "tagDatas": {
- "type": "array",
- "description": "Tags generated for this placement.",
- "items": {
- "$ref": "TagData"
- }
- }
- }
- },
- "PlacementsGenerateTagsResponse": {
- "id": "PlacementsGenerateTagsResponse",
- "type": "object",
- "description": "Placement GenerateTags Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementsGenerateTagsResponse\".",
- "default": "dfareporting#placementsGenerateTagsResponse"
- },
- "placementTags": {
- "type": "array",
- "description": "Set of generated tags for the specified placements.",
- "items": {
- "$ref": "PlacementTag"
- }
- }
- }
- },
- "PlacementsListResponse": {
- "id": "PlacementsListResponse",
- "type": "object",
- "description": "Placement List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#placementsListResponse\".",
- "default": "dfareporting#placementsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- },
- "placements": {
- "type": "array",
- "description": "Placement collection.",
- "items": {
- "$ref": "Placement"
- }
- }
- }
- },
- "PlatformType": {
- "id": "PlatformType",
- "type": "object",
- "description": "Contains information about a platform type that can be targeted by ads.",
- "properties": {
- "id": {
- "type": "string",
- "description": "ID of this platform type.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#platformType\".",
- "default": "dfareporting#platformType"
- },
- "name": {
- "type": "string",
- "description": "Name of this platform type."
- }
- }
- },
- "PlatformTypesListResponse": {
- "id": "PlatformTypesListResponse",
- "type": "object",
- "description": "Platform Type List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#platformTypesListResponse\".",
- "default": "dfareporting#platformTypesListResponse"
- },
- "platformTypes": {
- "type": "array",
- "description": "Platform type collection.",
- "items": {
- "$ref": "PlatformType"
- }
- }
- }
- },
- "PopupWindowProperties": {
- "id": "PopupWindowProperties",
- "type": "object",
- "description": "Popup Window Properties.",
- "properties": {
- "dimension": {
- "$ref": "Size",
- "description": "Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID"
- },
- "offset": {
- "$ref": "OffsetPosition",
- "description": "Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES."
- },
- "positionType": {
- "type": "string",
- "description": "Popup window position either centered or at specific coordinate.",
- "enum": [
- "CENTER",
- "COORDINATES"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "showAddressBar": {
- "type": "boolean",
- "description": "Whether to display the browser address bar."
- },
- "showMenuBar": {
- "type": "boolean",
- "description": "Whether to display the browser menu bar."
- },
- "showScrollBar": {
- "type": "boolean",
- "description": "Whether to display the browser scroll bar."
- },
- "showStatusBar": {
- "type": "boolean",
- "description": "Whether to display the browser status bar."
- },
- "showToolBar": {
- "type": "boolean",
- "description": "Whether to display the browser tool bar."
- },
- "title": {
- "type": "string",
- "description": "Title of popup window."
- }
- }
- },
- "PostalCode": {
- "id": "PostalCode",
- "type": "object",
- "description": "Contains information about a postal code that can be targeted by ads.",
- "properties": {
- "code": {
- "type": "string",
- "description": "Postal code. This is equivalent to the id field."
- },
- "countryCode": {
- "type": "string",
- "description": "Country code of the country to which this postal code belongs."
- },
- "countryDartId": {
- "type": "string",
- "description": "DART ID of the country to which this postal code belongs.",
- "format": "int64"
- },
- "id": {
- "type": "string",
- "description": "ID of this postal code."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#postalCode\".",
- "default": "dfareporting#postalCode"
- }
- }
- },
- "PostalCodesListResponse": {
- "id": "PostalCodesListResponse",
- "type": "object",
- "description": "Postal Code List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#postalCodesListResponse\".",
- "default": "dfareporting#postalCodesListResponse"
- },
- "postalCodes": {
- "type": "array",
- "description": "Postal code collection.",
- "items": {
- "$ref": "PostalCode"
- }
- }
- }
- },
- "Pricing": {
- "id": "Pricing",
- "type": "object",
- "description": "Pricing Information",
- "properties": {
- "capCostType": {
- "type": "string",
- "description": "Cap cost type of this inventory item.",
- "enum": [
- "PLANNING_PLACEMENT_CAP_COST_TYPE_CUMULATIVE",
- "PLANNING_PLACEMENT_CAP_COST_TYPE_MONTHLY",
- "PLANNING_PLACEMENT_CAP_COST_TYPE_NONE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "endDate": {
- "type": "string",
- "description": "End date of this inventory item.",
- "format": "date"
- },
- "flights": {
- "type": "array",
- "description": "Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time.",
- "items": {
- "$ref": "Flight"
- }
- },
- "groupType": {
- "type": "string",
- "description": "Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary.",
- "enum": [
- "PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE",
- "PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "pricingType": {
- "type": "string",
- "description": "Pricing type of this inventory item.",
- "enum": [
- "PLANNING_PLACEMENT_PRICING_TYPE_CLICKS",
- "PLANNING_PLACEMENT_PRICING_TYPE_CPA",
- "PLANNING_PLACEMENT_PRICING_TYPE_CPC",
- "PLANNING_PLACEMENT_PRICING_TYPE_CPM",
- "PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_CLICKS",
- "PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_IMPRESSIONS",
- "PLANNING_PLACEMENT_PRICING_TYPE_IMPRESSIONS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "startDate": {
- "type": "string",
- "description": "Start date of this inventory item.",
- "format": "date"
- }
- }
- },
- "PricingSchedule": {
- "id": "PricingSchedule",
- "type": "object",
- "description": "Pricing Schedule",
- "properties": {
- "capCostOption": {
- "type": "string",
- "description": "Placement cap cost option.",
- "enum": [
- "CAP_COST_CUMULATIVE",
- "CAP_COST_MONTHLY",
- "CAP_COST_NONE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "disregardOverdelivery": {
- "type": "boolean",
- "description": "Whether cap costs are ignored by ad serving."
- },
- "endDate": {
- "type": "string",
- "description": "Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.",
- "format": "date"
- },
- "flighted": {
- "type": "boolean",
- "description": "Whether this placement is flighted. If true, pricing periods will be computed automatically."
- },
- "floodlightActivityId": {
- "type": "string",
- "description": "Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.",
- "format": "int64"
- },
- "pricingPeriods": {
- "type": "array",
- "description": "Pricing periods for this placement.",
- "items": {
- "$ref": "PricingSchedulePricingPeriod"
- }
- },
- "pricingType": {
- "type": "string",
- "description": "Placement pricing type. This field is required on insertion.",
- "enum": [
- "PRICING_TYPE_CPA",
- "PRICING_TYPE_CPC",
- "PRICING_TYPE_CPM",
- "PRICING_TYPE_FLAT_RATE_CLICKS",
- "PRICING_TYPE_FLAT_RATE_IMPRESSIONS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "startDate": {
- "type": "string",
- "description": "Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.",
- "format": "date"
- },
- "testingStartDate": {
- "type": "string",
- "description": "Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.",
- "format": "date"
- }
- }
- },
- "PricingSchedulePricingPeriod": {
- "id": "PricingSchedulePricingPeriod",
- "type": "object",
- "description": "Pricing Period",
- "properties": {
- "endDate": {
- "type": "string",
- "description": "Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.",
- "format": "date"
- },
- "pricingComment": {
- "type": "string",
- "description": "Comments for this pricing period."
- },
- "rateOrCostNanos": {
- "type": "string",
- "description": "Rate or cost of this pricing period.",
- "format": "int64"
- },
- "startDate": {
- "type": "string",
- "description": "Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.",
- "format": "date"
- },
- "units": {
- "type": "string",
- "description": "Units of this pricing period.",
- "format": "int64"
- }
- }
- },
- "Project": {
- "id": "Project",
- "type": "object",
- "description": "Contains properties of a DoubleClick Planning project.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this project.",
- "format": "int64"
- },
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this project.",
- "format": "int64"
- },
- "audienceAgeGroup": {
- "type": "string",
- "description": "Audience age group of this project.",
- "enum": [
- "PLANNING_AUDIENCE_AGE_18_24",
- "PLANNING_AUDIENCE_AGE_25_34",
- "PLANNING_AUDIENCE_AGE_35_44",
- "PLANNING_AUDIENCE_AGE_45_54",
- "PLANNING_AUDIENCE_AGE_55_64",
- "PLANNING_AUDIENCE_AGE_65_OR_MORE",
- "PLANNING_AUDIENCE_AGE_UNKNOWN"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "audienceGender": {
- "type": "string",
- "description": "Audience gender of this project.",
- "enum": [
- "PLANNING_AUDIENCE_GENDER_FEMALE",
- "PLANNING_AUDIENCE_GENDER_MALE"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "budget": {
- "type": "string",
- "description": "Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.",
- "format": "int64"
- },
- "clientBillingCode": {
- "type": "string",
- "description": "Client billing code of this project."
- },
- "clientName": {
- "type": "string",
- "description": "Name of the project client."
- },
- "endDate": {
- "type": "string",
- "description": "End date of the project.",
- "format": "date"
- },
- "id": {
- "type": "string",
- "description": "ID of this project. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#project\".",
- "default": "dfareporting#project"
- },
- "lastModifiedInfo": {
- "$ref": "LastModifiedInfo",
- "description": "Information about the most recent modification of this project."
- },
- "name": {
- "type": "string",
- "description": "Name of this project."
- },
- "overview": {
- "type": "string",
- "description": "Overview of this project."
- },
- "startDate": {
- "type": "string",
- "description": "Start date of the project.",
- "format": "date"
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this project.",
- "format": "int64"
- },
- "targetClicks": {
- "type": "string",
- "description": "Number of clicks that the advertiser is targeting.",
- "format": "int64"
- },
- "targetConversions": {
- "type": "string",
- "description": "Number of conversions that the advertiser is targeting.",
- "format": "int64"
- },
- "targetCpaNanos": {
- "type": "string",
- "description": "CPA that the advertiser is targeting.",
- "format": "int64"
- },
- "targetCpcNanos": {
- "type": "string",
- "description": "CPC that the advertiser is targeting.",
- "format": "int64"
- },
- "targetCpmNanos": {
- "type": "string",
- "description": "CPM that the advertiser is targeting.",
- "format": "int64"
- },
- "targetImpressions": {
- "type": "string",
- "description": "Number of impressions that the advertiser is targeting.",
- "format": "int64"
- }
- }
- },
- "ProjectsListResponse": {
- "id": "ProjectsListResponse",
- "type": "object",
- "description": "Project List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#projectsListResponse\".",
- "default": "dfareporting#projectsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- },
- "projects": {
- "type": "array",
- "description": "Project collection.",
- "items": {
- "$ref": "Project"
- }
- }
- }
- },
- "ReachReportCompatibleFields": {
- "id": "ReachReportCompatibleFields",
- "type": "object",
- "description": "Represents fields that are compatible to be selected for a report of type \"REACH\".",
- "properties": {
- "dimensionFilters": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#reachReportCompatibleFields.",
- "default": "dfareporting#reachReportCompatibleFields"
- },
- "metrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- },
- "pivotedActivityMetrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected as activity metrics to pivot on in the \"activities\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- },
- "reachByFrequencyMetrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected in the \"reachByFrequencyMetricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- }
- }
- },
- "Recipient": {
- "id": "Recipient",
- "type": "object",
- "description": "Represents a recipient.",
- "properties": {
- "deliveryType": {
- "type": "string",
- "description": "The delivery type for the recipient.",
- "enum": [
- "ATTACHMENT",
- "LINK"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "email": {
- "type": "string",
- "description": "The email address of the recipient.",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#recipient.",
- "default": "dfareporting#recipient"
- }
- }
- },
- "Region": {
- "id": "Region",
- "type": "object",
- "description": "Contains information about a region that can be targeted by ads.",
- "properties": {
- "countryCode": {
- "type": "string",
- "description": "Country code of the country to which this region belongs."
- },
- "countryDartId": {
- "type": "string",
- "description": "DART ID of the country to which this region belongs.",
- "format": "int64"
- },
- "dartId": {
- "type": "string",
- "description": "DART ID of this region.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#region\".",
- "default": "dfareporting#region"
- },
- "name": {
- "type": "string",
- "description": "Name of this region."
- },
- "regionCode": {
- "type": "string",
- "description": "Region code."
- }
- }
- },
- "RegionsListResponse": {
- "id": "RegionsListResponse",
- "type": "object",
- "description": "Region List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#regionsListResponse\".",
- "default": "dfareporting#regionsListResponse"
- },
- "regions": {
- "type": "array",
- "description": "Region collection.",
- "items": {
- "$ref": "Region"
- }
- }
- }
- },
- "RemarketingList": {
- "id": "RemarketingList",
- "type": "object",
- "description": "Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
- "format": "int64"
- },
- "active": {
- "type": "boolean",
- "description": "Whether this remarketing list is active."
- },
- "advertiserId": {
- "type": "string",
- "description": "Dimension value for the advertiser ID that owns this remarketing list. This is a required field.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
- },
- "description": {
- "type": "string",
- "description": "Remarketing list description."
- },
- "id": {
- "type": "string",
- "description": "Remarketing list ID. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingList\".",
- "default": "dfareporting#remarketingList"
- },
- "lifeSpan": {
- "type": "string",
- "description": "Number of days that a user should remain in the remarketing list without an impression.",
- "format": "int64"
- },
- "listPopulationRule": {
- "$ref": "ListPopulationRule",
- "description": "Rule used to populate the remarketing list with users."
- },
- "listSize": {
- "type": "string",
- "description": "Number of users currently in the list. This is a read-only field.",
- "format": "int64"
- },
- "listSource": {
- "type": "string",
- "description": "Product from which this remarketing list was originated.",
- "enum": [
- "REMARKETING_LIST_SOURCE_DBM",
- "REMARKETING_LIST_SOURCE_DFA",
- "REMARKETING_LIST_SOURCE_DMP",
- "REMARKETING_LIST_SOURCE_GA",
- "REMARKETING_LIST_SOURCE_OTHER"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "name": {
- "type": "string",
- "description": "Name of the remarketing list. This is a required field. Must be no greater than 128 characters long."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
- "format": "int64"
- }
- }
- },
- "RemarketingListShare": {
- "id": "RemarketingListShare",
- "type": "object",
- "description": "Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingListShare\".",
- "default": "dfareporting#remarketingListShare"
- },
- "remarketingListId": {
- "type": "string",
- "description": "Remarketing list ID. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "sharedAccountIds": {
- "type": "array",
- "description": "Accounts that the remarketing list is shared with.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "sharedAdvertiserIds": {
- "type": "array",
- "description": "Advertisers that the remarketing list is shared with.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- }
- }
- },
- "RemarketingListsListResponse": {
- "id": "RemarketingListsListResponse",
- "type": "object",
- "description": "Remarketing list response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingListsListResponse\".",
- "default": "dfareporting#remarketingListsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- },
- "remarketingLists": {
- "type": "array",
- "description": "Remarketing list collection.",
- "items": {
- "$ref": "RemarketingList"
- }
- }
- }
- },
- "Report": {
- "id": "Report",
- "type": "object",
- "description": "Represents a Report resource.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The account ID to which this report belongs.",
- "format": "int64",
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- }
- },
- "criteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"STANDARD\".",
- "properties": {
- "activities": {
- "$ref": "Activities",
- "description": "Activity group."
- },
- "customRichMediaEvents": {
- "$ref": "CustomRichMediaEvents",
- "description": "Custom Rich Media Events group."
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range for which this report should be run."
- },
- "dimensionFilters": {
- "type": "array",
- "description": "The list of filters on which dimensions are filtered.\nFilters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "The list of standard dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "crossDimensionReachCriteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"CROSS_DIMENSION_REACH\".",
- "properties": {
- "breakdown": {
- "type": "array",
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimension": {
- "type": "string",
- "description": "The dimension option.",
- "enum": [
- "ADVERTISER",
- "CAMPAIGN",
- "SITE_BY_ADVERTISER",
- "SITE_BY_CAMPAIGN"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- },
- "dimensionFilters": {
- "type": "array",
- "description": "The list of filters on which dimensions are filtered.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "overlapMetricNames": {
- "type": "array",
- "description": "The list of names of overlap metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "pivoted": {
- "type": "boolean",
- "description": "Whether the report is pivoted or not. Defaults to true."
- }
- }
- },
- "delivery": {
- "type": "object",
- "description": "The report's email delivery settings.",
- "properties": {
- "emailOwner": {
- "type": "boolean",
- "description": "Whether the report should be emailed to the report owner."
- },
- "emailOwnerDeliveryType": {
- "type": "string",
- "description": "The type of delivery for the owner to receive, if enabled.",
- "enum": [
- "ATTACHMENT",
- "LINK"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "message": {
- "type": "string",
- "description": "The message to be sent with each email."
- },
- "recipients": {
- "type": "array",
- "description": "The list of recipients to which to email the report.",
- "items": {
- "$ref": "Recipient"
- }
- }
- }
- },
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "fileName": {
- "type": "string",
- "description": "The filename used when generating report files for this report."
- },
- "floodlightCriteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"FLOODLIGHT\".",
- "properties": {
- "customRichMediaEvents": {
- "type": "array",
- "description": "The list of custom rich media events to include.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimensionFilters": {
- "type": "array",
- "description": "The list of filters on which dimensions are filtered.\nFilters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "floodlightConfigId": {
- "$ref": "DimensionValue",
- "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "reportProperties": {
- "type": "object",
- "description": "The properties of the report.",
- "properties": {
- "includeAttributedIPConversions": {
- "type": "boolean",
- "description": "Include conversions that have no cookie, but do have an exposure path."
- },
- "includeUnattributedCookieConversions": {
- "type": "boolean",
- "description": "Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window."
- },
- "includeUnattributedIPConversions": {
- "type": "boolean",
- "description": "Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion."
- }
- }
- }
- }
- },
- "format": {
- "type": "string",
- "description": "The output format of the report. If not specified, default format is \"CSV\". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. \"CSV\" will then be the fallback format.",
- "enum": [
- "CSV",
- "EXCEL"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "id": {
- "type": "string",
- "description": "The unique ID identifying this report resource.",
- "format": "int64",
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#report.",
- "default": "dfareporting#report"
- },
- "lastModifiedTime": {
- "type": "string",
- "description": "The timestamp (in milliseconds since epoch) of when this report was last modified.",
- "format": "uint64",
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- }
- },
- "name": {
- "type": "string",
- "description": "The name of the report.",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "ownerProfileId": {
- "type": "string",
- "description": "The user profile id of the owner of this report.",
- "format": "int64",
- "annotations": {
- "required": [
- "dfareporting.reports.update"
- ]
- }
- },
- "pathToConversionCriteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"PATH_TO_CONVERSION\".",
- "properties": {
- "activityFilters": {
- "type": "array",
- "description": "The list of 'dfa:activity' values to filter on.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "conversionDimensions": {
- "type": "array",
- "description": "The list of conversion dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "customFloodlightVariables": {
- "type": "array",
- "description": "The list of custom floodlight variables the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "customRichMediaEvents": {
- "type": "array",
- "description": "The list of custom rich media events to include.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "floodlightConfigId": {
- "$ref": "DimensionValue",
- "description": "The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'."
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "perInteractionDimensions": {
- "type": "array",
- "description": "The list of per interaction dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "reportProperties": {
- "type": "object",
- "description": "The properties of the report.",
- "properties": {
- "clicksLookbackWindow": {
- "type": "integer",
- "description": "DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.",
- "format": "int32"
- },
- "impressionsLookbackWindow": {
- "type": "integer",
- "description": "DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.",
- "format": "int32"
- },
- "includeAttributedIPConversions": {
- "type": "boolean",
- "description": "Deprecated: has no effect."
- },
- "includeUnattributedCookieConversions": {
- "type": "boolean",
- "description": "Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window."
- },
- "includeUnattributedIPConversions": {
- "type": "boolean",
- "description": "Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion."
- },
- "maximumClickInteractions": {
- "type": "integer",
- "description": "The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.",
- "format": "int32"
- },
- "maximumImpressionInteractions": {
- "type": "integer",
- "description": "The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.",
- "format": "int32"
- },
- "maximumInteractionGap": {
- "type": "integer",
- "description": "The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.",
- "format": "int32"
- },
- "pivotOnInteractionPath": {
- "type": "boolean",
- "description": "Enable pivoting on interaction path."
- }
- }
- }
- }
- },
- "reachCriteria": {
- "type": "object",
- "description": "The report criteria for a report of type \"REACH\".",
- "properties": {
- "activities": {
- "$ref": "Activities",
- "description": "Activity group."
- },
- "customRichMediaEvents": {
- "$ref": "CustomRichMediaEvents",
- "description": "Custom Rich Media Events group."
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "The date range this report should be run for."
- },
- "dimensionFilters": {
- "type": "array",
- "description": "The list of filters on which dimensions are filtered.\nFilters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
- "items": {
- "$ref": "DimensionValue"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "The list of dimensions the report should include.",
- "items": {
- "$ref": "SortedDimension"
- }
- },
- "enableAllDimensionCombinations": {
- "type": "boolean",
- "description": "Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months."
- },
- "metricNames": {
- "type": "array",
- "description": "The list of names of metrics the report should include.",
- "items": {
- "type": "string"
- }
- },
- "reachByFrequencyMetricNames": {
- "type": "array",
- "description": "The list of names of Reach By Frequency metrics the report should include.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "schedule": {
- "type": "object",
- "description": "The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not \"TODAY\".",
- "properties": {
- "active": {
- "type": "boolean",
- "description": "Whether the schedule is active or not. Must be set to either true or false.",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "every": {
- "type": "integer",
- "description": "Defines every how many days, weeks or months the report should be run. Needs to be set when \"repeats\" is either \"DAILY\", \"WEEKLY\" or \"MONTHLY\".",
- "format": "int32"
- },
- "expirationDate": {
- "type": "string",
- "description": "The expiration date when the scheduled report stops running.",
- "format": "date",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "repeats": {
- "type": "string",
- "description": "The interval for which the report is repeated. Note: \n- \"DAILY\" also requires field \"every\" to be set. \n- \"WEEKLY\" also requires fields \"every\" and \"repeatsOnWeekDays\" to be set. \n- \"MONTHLY\" also requires fields \"every\" and \"runsOnDayOfMonth\" to be set.",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- },
- "repeatsOnWeekDays": {
- "type": "array",
- "description": "List of week days \"WEEKLY\" on which scheduled reports should run.",
- "items": {
- "type": "string",
- "enum": [
- "FRIDAY",
- "MONDAY",
- "SATURDAY",
- "SUNDAY",
- "THURSDAY",
- "TUESDAY",
- "WEDNESDAY"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- },
- "runsOnDayOfMonth": {
- "type": "string",
- "description": "Enum to define for \"MONTHLY\" scheduled reports whether reports should be repeated on the same day of the month as \"startDate\" or the same day of the week of the month.\nExample: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), \"DAY_OF_MONTH\" would run subsequent reports on the 2nd of every Month, and \"WEEK_OF_MONTH\" would run subsequent reports on the first Monday of the month.",
- "enum": [
- "DAY_OF_MONTH",
- "WEEK_OF_MONTH"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "startDate": {
- "type": "string",
- "description": "Start date of date range for which scheduled reports should be run.",
- "format": "date",
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- }
- }
- },
- "subAccountId": {
- "type": "string",
- "description": "The subaccount ID to which this report belongs if applicable.",
- "format": "int64"
- },
- "type": {
- "type": "string",
- "description": "The type of the report.",
- "enum": [
- "CROSS_DIMENSION_REACH",
- "FLOODLIGHT",
- "PATH_TO_CONVERSION",
- "REACH",
- "STANDARD"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "annotations": {
- "required": [
- "dfareporting.reports.insert",
- "dfareporting.reports.update"
- ]
- }
- }
- }
- },
- "ReportCompatibleFields": {
- "id": "ReportCompatibleFields",
- "type": "object",
- "description": "Represents fields that are compatible to be selected for a report of type \"STANDARD\".",
- "properties": {
- "dimensionFilters": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "dimensions": {
- "type": "array",
- "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
- "items": {
- "$ref": "Dimension"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#reportCompatibleFields.",
- "default": "dfareporting#reportCompatibleFields"
- },
- "metrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- },
- "pivotedActivityMetrics": {
- "type": "array",
- "description": "Metrics which are compatible to be selected as activity metrics to pivot on in the \"activities\" section of the report.",
- "items": {
- "$ref": "Metric"
- }
- }
- }
- },
- "ReportList": {
- "id": "ReportList",
- "type": "object",
- "description": "Represents the list of reports.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The reports returned in this response.",
- "items": {
- "$ref": "Report"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of list this is, in this case dfareporting#reportList.",
- "default": "dfareporting#reportList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token used to page through reports. To retrieve the next page of results, set the next request's \"pageToken\" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted."
- }
- }
- },
- "ReportsConfiguration": {
- "id": "ReportsConfiguration",
- "type": "object",
- "description": "Reporting Configuration",
- "properties": {
- "exposureToConversionEnabled": {
- "type": "boolean",
- "description": "Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting."
- },
- "lookbackConfiguration": {
- "$ref": "LookbackConfiguration",
- "description": "Default lookback windows for new advertisers in this account."
- },
- "reportGenerationTimeZoneId": {
- "type": "string",
- "description": "Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.\nAcceptable values are:\n\n- \"1\" for \"America/New_York\" \n- \"2\" for \"Europe/London\" \n- \"3\" for \"Europe/Paris\" \n- \"4\" for \"Africa/Johannesburg\" \n- \"5\" for \"Asia/Jerusalem\" \n- \"6\" for \"Asia/Shanghai\" \n- \"7\" for \"Asia/Hong_Kong\" \n- \"8\" for \"Asia/Tokyo\" \n- \"9\" for \"Australia/Sydney\" \n- \"10\" for \"Asia/Dubai\" \n- \"11\" for \"America/Los_Angeles\" \n- \"12\" for \"Pacific/Auckland\" \n- \"13\" for \"America/Sao_Paulo\"",
- "format": "int64"
- }
- }
- },
- "RichMediaExitOverride": {
- "id": "RichMediaExitOverride",
- "type": "object",
- "description": "Rich Media Exit Override.",
- "properties": {
- "customExitUrl": {
- "type": "string",
- "description": "Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true."
- },
- "exitId": {
- "type": "string",
- "description": "ID for the override to refer to a specific exit in the creative.",
- "format": "int64"
- },
- "useCustomExitUrl": {
- "type": "boolean",
- "description": "Whether to use the custom exit URL."
- }
- }
- },
- "Site": {
- "id": "Site",
- "type": "object",
- "description": "Contains properties of a site.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this site. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "approved": {
- "type": "boolean",
- "description": "Whether this site is approved."
- },
- "directorySiteId": {
- "type": "string",
- "description": "Directory site associated with this site. This is a required field that is read-only after insertion.",
- "format": "int64"
- },
- "directorySiteIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the directory site. This is a read-only, auto-generated field."
- },
- "id": {
- "type": "string",
- "description": "ID of this site. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "idDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of this site. This is a read-only, auto-generated field."
- },
- "keyName": {
- "type": "string",
- "description": "Key name of this site. This is a read-only, auto-generated field."
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#site\".",
- "default": "dfareporting#site"
- },
- "name": {
- "type": "string",
- "description": "Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account."
- },
- "siteContacts": {
- "type": "array",
- "description": "Site contacts.",
- "items": {
- "$ref": "SiteContact"
- }
- },
- "siteSettings": {
- "$ref": "SiteSettings",
- "description": "Site-wide settings."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this site. This is a read-only field that can be left blank.",
- "format": "int64"
- }
- }
- },
- "SiteContact": {
- "id": "SiteContact",
- "type": "object",
- "description": "Site Contact",
- "properties": {
- "address": {
- "type": "string",
- "description": "Address of this site contact."
- },
- "contactType": {
- "type": "string",
- "description": "Site contact type.",
- "enum": [
- "SALES_PERSON",
- "TRAFFICKER"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "email": {
- "type": "string",
- "description": "Email address of this site contact. This is a required field."
- },
- "firstName": {
- "type": "string",
- "description": "First name of this site contact."
- },
- "id": {
- "type": "string",
- "description": "ID of this site contact. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "lastName": {
- "type": "string",
- "description": "Last name of this site contact."
- },
- "phone": {
- "type": "string",
- "description": "Primary phone number of this site contact."
- },
- "title": {
- "type": "string",
- "description": "Title or designation of this site contact."
- }
- }
- },
- "SiteSettings": {
- "id": "SiteSettings",
- "type": "object",
- "description": "Site Settings",
- "properties": {
- "activeViewOptOut": {
- "type": "boolean",
- "description": "Whether active view creatives are disabled for this site."
- },
- "creativeSettings": {
- "$ref": "CreativeSettings",
- "description": "Site-wide creative settings."
- },
- "disableBrandSafeAds": {
- "type": "boolean",
- "description": "Whether brand safe ads are disabled for this site."
- },
- "disableNewCookie": {
- "type": "boolean",
- "description": "Whether new cookies are disabled for this site."
- },
- "lookbackConfiguration": {
- "$ref": "LookbackConfiguration",
- "description": "Lookback window settings for this site."
- },
- "tagSetting": {
- "$ref": "TagSetting",
- "description": "Configuration settings for dynamic and image floodlight tags."
- }
- }
- },
- "SitesListResponse": {
- "id": "SitesListResponse",
- "type": "object",
- "description": "Site List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#sitesListResponse\".",
- "default": "dfareporting#sitesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- },
- "sites": {
- "type": "array",
- "description": "Site collection.",
- "items": {
- "$ref": "Site"
- }
- }
- }
- },
- "Size": {
- "id": "Size",
- "type": "object",
- "description": "Represents the dimensions of ads, placements, creatives, or creative assets.",
- "properties": {
- "height": {
- "type": "integer",
- "description": "Height of this size.",
- "format": "int32"
- },
- "iab": {
- "type": "boolean",
- "description": "IAB standard size. This is a read-only, auto-generated field."
- },
- "id": {
- "type": "string",
- "description": "ID of this size. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#size\".",
- "default": "dfareporting#size"
- },
- "width": {
- "type": "integer",
- "description": "Width of this size.",
- "format": "int32"
- }
- }
- },
- "SizesListResponse": {
- "id": "SizesListResponse",
- "type": "object",
- "description": "Size List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#sizesListResponse\".",
- "default": "dfareporting#sizesListResponse"
- },
- "sizes": {
- "type": "array",
- "description": "Size collection.",
- "items": {
- "$ref": "Size"
- }
- }
- }
- },
- "SortedDimension": {
- "id": "SortedDimension",
- "type": "object",
- "description": "Represents a sorted dimension.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#sortedDimension.",
- "default": "dfareporting#sortedDimension"
- },
- "name": {
- "type": "string",
- "description": "The name of the dimension."
- },
- "sortOrder": {
- "type": "string",
- "description": "An optional sort order for the dimension column.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- }
- }
- },
- "Subaccount": {
- "id": "Subaccount",
- "type": "object",
- "description": "Contains properties of a DCM subaccount.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "ID of the account that contains this subaccount. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "availablePermissionIds": {
- "type": "array",
- "description": "IDs of the available user role permissions for this subaccount.",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "id": {
- "type": "string",
- "description": "ID of this subaccount. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#subaccount\".",
- "default": "dfareporting#subaccount"
- },
- "name": {
- "type": "string",
- "description": "Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account."
- }
- }
- },
- "SubaccountsListResponse": {
- "id": "SubaccountsListResponse",
- "type": "object",
- "description": "Subaccount List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#subaccountsListResponse\".",
- "default": "dfareporting#subaccountsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- },
- "subaccounts": {
- "type": "array",
- "description": "Subaccount collection.",
- "items": {
- "$ref": "Subaccount"
- }
- }
- }
- },
- "TagData": {
- "id": "TagData",
- "type": "object",
- "description": "Placement Tag Data",
- "properties": {
- "adId": {
- "type": "string",
- "description": "Ad associated with this placement tag.",
- "format": "int64"
- },
- "clickTag": {
- "type": "string",
- "description": "Tag string to record a click."
- },
- "creativeId": {
- "type": "string",
- "description": "Creative associated with this placement tag.",
- "format": "int64"
- },
- "format": {
- "type": "string",
- "description": "TagData tag format of this tag.",
- "enum": [
- "PLACEMENT_TAG_CLICK_COMMANDS",
- "PLACEMENT_TAG_IFRAME_ILAYER",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
- "PLACEMENT_TAG_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_JAVASCRIPT",
- "PLACEMENT_TAG_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_STANDARD",
- "PLACEMENT_TAG_TRACKING",
- "PLACEMENT_TAG_TRACKING_IFRAME",
- "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "impressionTag": {
- "type": "string",
- "description": "Tag string for serving an ad."
- }
- }
- },
- "TagSetting": {
- "id": "TagSetting",
- "type": "object",
- "description": "Tag Settings",
- "properties": {
- "additionalKeyValues": {
- "type": "string",
- "description": "Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field."
- },
- "includeClickThroughUrls": {
- "type": "boolean",
- "description": "Whether static landing page URLs should be included in the tags. This setting applies only to placements."
- },
- "includeClickTracking": {
- "type": "boolean",
- "description": "Whether click-tracking string should be included in the tags."
- },
- "keywordOption": {
- "type": "string",
- "description": "Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.",
- "enum": [
- "GENERATE_SEPARATE_TAG_FOR_EACH_KEYWORD",
- "IGNORE",
- "PLACEHOLDER_WITH_LIST_OF_KEYWORDS"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- }
- }
- },
- "TagSettings": {
- "id": "TagSettings",
- "type": "object",
- "description": "Dynamic and Image Tag Settings.",
- "properties": {
- "dynamicTagEnabled": {
- "type": "boolean",
- "description": "Whether dynamic floodlight tags are enabled."
- },
- "imageTagEnabled": {
- "type": "boolean",
- "description": "Whether image tags are enabled."
- }
- }
- },
- "TargetWindow": {
- "id": "TargetWindow",
- "type": "object",
- "description": "Target Window.",
- "properties": {
- "customHtml": {
- "type": "string",
- "description": "User-entered value."
- },
- "targetWindowOption": {
- "type": "string",
- "description": "Type of browser window for which the backup image of the flash creative can be displayed.",
- "enum": [
- "CURRENT_WINDOW",
- "CUSTOM",
- "NEW_WINDOW"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- }
- }
- },
- "TargetableRemarketingList": {
- "id": "TargetableRemarketingList",
- "type": "object",
- "description": "Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
- "format": "int64"
- },
- "active": {
- "type": "boolean",
- "description": "Whether this targetable remarketing list is active."
- },
- "advertiserId": {
- "type": "string",
- "description": "Dimension value for the advertiser ID that owns this targetable remarketing list.",
- "format": "int64"
- },
- "advertiserIdDimensionValue": {
- "$ref": "DimensionValue",
- "description": "Dimension value for the ID of the advertiser."
- },
- "description": {
- "type": "string",
- "description": "Targetable remarketing list description."
- },
- "id": {
- "type": "string",
- "description": "Targetable remarketing list ID.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetableRemarketingList\".",
- "default": "dfareporting#targetableRemarketingList"
- },
- "lifeSpan": {
- "type": "string",
- "description": "Number of days that a user should remain in the targetable remarketing list without an impression.",
- "format": "int64"
- },
- "listSize": {
- "type": "string",
- "description": "Number of users currently in the list. This is a read-only field.",
- "format": "int64"
- },
- "listSource": {
- "type": "string",
- "description": "Product from which this targetable remarketing list was originated.",
- "enum": [
- "REMARKETING_LIST_SOURCE_DBM",
- "REMARKETING_LIST_SOURCE_DFA",
- "REMARKETING_LIST_SOURCE_DMP",
- "REMARKETING_LIST_SOURCE_GA",
- "REMARKETING_LIST_SOURCE_OTHER"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "name": {
- "type": "string",
- "description": "Name of the targetable remarketing list. Is no greater than 128 characters long."
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.",
- "format": "int64"
- }
- }
- },
- "TargetableRemarketingListsListResponse": {
- "id": "TargetableRemarketingListsListResponse",
- "type": "object",
- "description": "Targetable remarketing list response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetableRemarketingListsListResponse\".",
- "default": "dfareporting#targetableRemarketingListsListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- },
- "targetableRemarketingLists": {
- "type": "array",
- "description": "Targetable remarketing list collection.",
- "items": {
- "$ref": "TargetableRemarketingList"
- }
- }
- }
- },
- "TechnologyTargeting": {
- "id": "TechnologyTargeting",
- "type": "object",
- "description": "Technology Targeting.",
- "properties": {
- "browsers": {
- "type": "array",
- "description": "Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.",
- "items": {
- "$ref": "Browser"
- }
- },
- "connectionTypes": {
- "type": "array",
- "description": "Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.",
- "items": {
- "$ref": "ConnectionType"
- }
- },
- "mobileCarriers": {
- "type": "array",
- "description": "Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.",
- "items": {
- "$ref": "MobileCarrier"
- }
- },
- "operatingSystemVersions": {
- "type": "array",
- "description": "Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.",
- "items": {
- "$ref": "OperatingSystemVersion"
- }
- },
- "operatingSystems": {
- "type": "array",
- "description": "Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.",
- "items": {
- "$ref": "OperatingSystem"
- }
- },
- "platformTypes": {
- "type": "array",
- "description": "Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.",
- "items": {
- "$ref": "PlatformType"
- }
- }
- }
- },
- "ThirdPartyAuthenticationToken": {
- "id": "ThirdPartyAuthenticationToken",
- "type": "object",
- "description": "Third Party Authentication Token",
- "properties": {
- "name": {
- "type": "string",
- "description": "Name of the third-party authentication token."
- },
- "value": {
- "type": "string",
- "description": "Value of the third-party authentication token. This is a read-only, auto-generated field."
- }
- }
- },
- "ThirdPartyTrackingUrl": {
- "id": "ThirdPartyTrackingUrl",
- "type": "object",
- "description": "Third-party Tracking URL.",
- "properties": {
- "thirdPartyUrlType": {
- "type": "string",
- "description": "Third-party URL type for in-stream video creatives.",
- "enum": [
- "CLICK_TRACKING",
- "IMPRESSION",
- "RICH_MEDIA_BACKUP_IMPRESSION",
- "RICH_MEDIA_IMPRESSION",
- "RICH_MEDIA_RM_IMPRESSION",
- "SURVEY",
- "VIDEO_COMPLETE",
- "VIDEO_CUSTOM",
- "VIDEO_FIRST_QUARTILE",
- "VIDEO_FULLSCREEN",
- "VIDEO_MIDPOINT",
- "VIDEO_MUTE",
- "VIDEO_PAUSE",
- "VIDEO_REWIND",
- "VIDEO_START",
- "VIDEO_STOP",
- "VIDEO_THIRD_QUARTILE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "url": {
- "type": "string",
- "description": "URL for the specified third-party URL type."
- }
- }
- },
- "UserDefinedVariableConfiguration": {
- "id": "UserDefinedVariableConfiguration",
- "type": "object",
- "description": "User Defined Variable configuration.",
- "properties": {
- "dataType": {
- "type": "string",
- "description": "Data type for the variable. This is a required field.",
- "enum": [
- "NUMBER",
- "STRING"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "reportName": {
- "type": "string",
- "description": "User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: \"\"\u003c\u003e\"."
- },
- "variableType": {
- "type": "string",
- "description": "Variable name in the tag. This is a required field.",
- "enum": [
- "U1",
- "U10",
- "U11",
- "U12",
- "U13",
- "U14",
- "U15",
- "U16",
- "U17",
- "U18",
- "U19",
- "U2",
- "U20",
- "U3",
- "U4",
- "U5",
- "U6",
- "U7",
- "U8",
- "U9"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- }
- }
- },
- "UserProfile": {
- "id": "UserProfile",
- "type": "object",
- "description": "Represents a UserProfile resource.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The account ID to which this profile belongs.",
- "format": "int64"
- },
- "accountName": {
- "type": "string",
- "description": "The account name this profile belongs to."
- },
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "kind": {
- "type": "string",
- "description": "The kind of resource this is, in this case dfareporting#userProfile.",
- "default": "dfareporting#userProfile"
- },
- "profileId": {
- "type": "string",
- "description": "The unique ID of the user profile.",
- "format": "int64"
- },
- "subAccountId": {
- "type": "string",
- "description": "The sub account ID this profile belongs to if applicable.",
- "format": "int64"
- },
- "subAccountName": {
- "type": "string",
- "description": "The sub account name this profile belongs to if applicable."
- },
- "userName": {
- "type": "string",
- "description": "The user name."
- }
- }
- },
- "UserProfileList": {
- "id": "UserProfileList",
- "type": "object",
- "description": "Represents the list of user profiles.",
- "properties": {
- "etag": {
- "type": "string",
- "description": "The eTag of this response for caching purposes."
- },
- "items": {
- "type": "array",
- "description": "The user profiles returned in this response.",
- "items": {
- "$ref": "UserProfile"
- }
- },
- "kind": {
- "type": "string",
- "description": "The kind of list this is, in this case dfareporting#userProfileList.",
- "default": "dfareporting#userProfileList"
- }
- }
- },
- "UserRole": {
- "id": "UserRole",
- "type": "object",
- "description": "Contains properties of auser role, which is used to manage user access.",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "Account ID of this user role. This is a read-only field that can be left blank.",
- "format": "int64"
- },
- "defaultUserRole": {
- "type": "boolean",
- "description": "Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions."
- },
- "id": {
- "type": "string",
- "description": "ID of this user role. This is a read-only, auto-generated field.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRole\".",
- "default": "dfareporting#userRole"
- },
- "name": {
- "type": "string",
- "description": "Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account."
- },
- "parentUserRoleId": {
- "type": "string",
- "description": "ID of the user role that this user role is based on or copied from. This is a required field.",
- "format": "int64"
- },
- "permissions": {
- "type": "array",
- "description": "List of permissions associated with this user role.",
- "items": {
- "$ref": "UserRolePermission"
- }
- },
- "subaccountId": {
- "type": "string",
- "description": "Subaccount ID of this user role. This is a read-only field that can be left blank.",
- "format": "int64"
- }
- }
- },
- "UserRolePermission": {
- "id": "UserRolePermission",
- "type": "object",
- "description": "Contains properties of a user role permission.",
- "properties": {
- "availability": {
- "type": "string",
- "description": "Levels of availability for a user role permission.",
- "enum": [
- "ACCOUNT_ALWAYS",
- "ACCOUNT_BY_DEFAULT",
- "NOT_AVAILABLE_BY_DEFAULT",
- "SUBACCOUNT_AND_ACCOUNT_ALWAYS",
- "SUBACCOUNT_AND_ACCOUNT_BY_DEFAULT"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "id": {
- "type": "string",
- "description": "ID of this user role permission.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermission\".",
- "default": "dfareporting#userRolePermission"
- },
- "name": {
- "type": "string",
- "description": "Name of this user role permission."
- },
- "permissionGroupId": {
- "type": "string",
- "description": "ID of the permission group that this user role permission belongs to.",
- "format": "int64"
- }
- }
- },
- "UserRolePermissionGroup": {
- "id": "UserRolePermissionGroup",
- "type": "object",
- "description": "Represents a grouping of related user role permissions.",
- "properties": {
- "id": {
- "type": "string",
- "description": "ID of this user role permission.",
- "format": "int64"
- },
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionGroup\".",
- "default": "dfareporting#userRolePermissionGroup"
- },
- "name": {
- "type": "string",
- "description": "Name of this user role permission group."
- }
- }
- },
- "UserRolePermissionGroupsListResponse": {
- "id": "UserRolePermissionGroupsListResponse",
- "type": "object",
- "description": "User Role Permission Group List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionGroupsListResponse\".",
- "default": "dfareporting#userRolePermissionGroupsListResponse"
- },
- "userRolePermissionGroups": {
- "type": "array",
- "description": "User role permission group collection.",
- "items": {
- "$ref": "UserRolePermissionGroup"
- }
- }
- }
- },
- "UserRolePermissionsListResponse": {
- "id": "UserRolePermissionsListResponse",
- "type": "object",
- "description": "User Role Permission List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolePermissionsListResponse\".",
- "default": "dfareporting#userRolePermissionsListResponse"
- },
- "userRolePermissions": {
- "type": "array",
- "description": "User role permission collection.",
- "items": {
- "$ref": "UserRolePermission"
- }
- }
- }
- },
- "UserRolesListResponse": {
- "id": "UserRolesListResponse",
- "type": "object",
- "description": "User Role List Response",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#userRolesListResponse\".",
- "default": "dfareporting#userRolesListResponse"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token to be used for the next list operation."
- },
- "userRoles": {
- "type": "array",
- "description": "User role collection.",
- "items": {
- "$ref": "UserRole"
- }
- }
- }
- }
- },
- "resources": {
- "accountActiveAdSummaries": {
- "methods": {
- "get": {
- "id": "dfareporting.accountActiveAdSummaries.get",
- "path": "userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}",
- "httpMethod": "GET",
- "description": "Gets the account's active ad summary by account ID.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "summaryAccountId": {
- "type": "string",
- "description": "Account ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "summaryAccountId"
- ],
- "response": {
- "$ref": "AccountActiveAdSummary"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "accountPermissionGroups": {
- "methods": {
- "get": {
- "id": "dfareporting.accountPermissionGroups.get",
- "path": "userprofiles/{profileId}/accountPermissionGroups/{id}",
- "httpMethod": "GET",
- "description": "Gets one account permission group by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Account permission group ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "AccountPermissionGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.accountPermissionGroups.list",
- "path": "userprofiles/{profileId}/accountPermissionGroups",
- "httpMethod": "GET",
- "description": "Retrieves the list of account permission groups.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "AccountPermissionGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "accountPermissions": {
- "methods": {
- "get": {
- "id": "dfareporting.accountPermissions.get",
- "path": "userprofiles/{profileId}/accountPermissions/{id}",
- "httpMethod": "GET",
- "description": "Gets one account permission by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Account permission ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "AccountPermission"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.accountPermissions.list",
- "path": "userprofiles/{profileId}/accountPermissions",
- "httpMethod": "GET",
- "description": "Retrieves the list of account permissions.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "AccountPermissionsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "accountUserProfiles": {
- "methods": {
- "get": {
- "id": "dfareporting.accountUserProfiles.get",
- "path": "userprofiles/{profileId}/accountUserProfiles/{id}",
- "httpMethod": "GET",
- "description": "Gets one account user profile by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "User profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "AccountUserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.accountUserProfiles.insert",
- "path": "userprofiles/{profileId}/accountUserProfiles",
- "httpMethod": "POST",
- "description": "Inserts a new account user profile.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "AccountUserProfile"
- },
- "response": {
- "$ref": "AccountUserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.accountUserProfiles.list",
- "path": "userprofiles/{profileId}/accountUserProfiles",
- "httpMethod": "GET",
- "description": "Retrieves a list of account user profiles, possibly filtered.",
- "parameters": {
- "active": {
- "type": "boolean",
- "description": "Select only active user profiles.",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only user profiles with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, \"user profile*2015\" will return objects with names like \"user profile June 2015\", \"user profile April 2015\", or simply \"user profile 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"user profile\" will match objects with name \"my user profile\", \"user profile 2015\", or simply \"user profile\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "subaccountId": {
- "type": "string",
- "description": "Select only user profiles with the specified subaccount ID.",
- "format": "int64",
- "location": "query"
- },
- "userRoleId": {
- "type": "string",
- "description": "Select only user profiles with the specified user role ID.",
- "format": "int64",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "AccountUserProfilesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.accountUserProfiles.patch",
- "path": "userprofiles/{profileId}/accountUserProfiles",
- "httpMethod": "PATCH",
- "description": "Updates an existing account user profile. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "User profile ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "AccountUserProfile"
- },
- "response": {
- "$ref": "AccountUserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.accountUserProfiles.update",
- "path": "userprofiles/{profileId}/accountUserProfiles",
- "httpMethod": "PUT",
- "description": "Updates an existing account user profile.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "AccountUserProfile"
- },
- "response": {
- "$ref": "AccountUserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "accounts": {
- "methods": {
- "get": {
- "id": "dfareporting.accounts.get",
- "path": "userprofiles/{profileId}/accounts/{id}",
- "httpMethod": "GET",
- "description": "Gets one account by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Account ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.accounts.list",
- "path": "userprofiles/{profileId}/accounts",
- "httpMethod": "GET",
- "description": "Retrieves the list of accounts, possibly filtered.",
- "parameters": {
- "active": {
- "type": "boolean",
- "description": "Select only active accounts. Don't set this field to select both active and non-active accounts.",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only accounts with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"account*2015\" will return objects with names like \"account June 2015\", \"account April 2015\", or simply \"account 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"account\" will match objects with name \"my account\", \"account 2015\", or simply \"account\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "AccountsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.accounts.patch",
- "path": "userprofiles/{profileId}/accounts",
- "httpMethod": "PATCH",
- "description": "Updates an existing account. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Account ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.accounts.update",
- "path": "userprofiles/{profileId}/accounts",
- "httpMethod": "PUT",
- "description": "Updates an existing account.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "ads": {
- "methods": {
- "get": {
- "id": "dfareporting.ads.get",
- "path": "userprofiles/{profileId}/ads/{id}",
- "httpMethod": "GET",
- "description": "Gets one ad by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Ad ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Ad"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.ads.insert",
- "path": "userprofiles/{profileId}/ads",
- "httpMethod": "POST",
- "description": "Inserts a new ad.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Ad"
- },
- "response": {
- "$ref": "Ad"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.ads.list",
- "path": "userprofiles/{profileId}/ads",
- "httpMethod": "GET",
- "description": "Retrieves a list of ads, possibly filtered.",
- "parameters": {
- "active": {
- "type": "boolean",
- "description": "Select only active ads.",
- "location": "query"
- },
- "advertiserId": {
- "type": "string",
- "description": "Select only ads with this advertiser ID.",
- "format": "int64",
- "location": "query"
- },
- "archived": {
- "type": "boolean",
- "description": "Select only archived ads.",
- "location": "query"
- },
- "audienceSegmentIds": {
- "type": "string",
- "description": "Select only ads with these audience segment IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "campaignIds": {
- "type": "string",
- "description": "Select only ads with these campaign IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "compatibility": {
- "type": "string",
- "description": "Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.",
- "enum": [
- "APP",
- "APP_INTERSTITIAL",
- "IN_STREAM_VIDEO",
- "WEB",
- "WEB_INTERSTITIAL"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query"
- },
- "creativeIds": {
- "type": "string",
- "description": "Select only ads with these creative IDs assigned.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "creativeOptimizationConfigurationIds": {
- "type": "string",
- "description": "Select only ads with these creative optimization configuration IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "creativeType": {
- "type": "string",
- "description": "Select only ads with the specified creativeType.",
- "enum": [
- "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO",
- "CUSTOM_INPAGE",
- "CUSTOM_INTERSTITIAL",
- "ENHANCED_BANNER",
- "ENHANCED_IMAGE",
- "FLASH_INPAGE",
- "HTML5_BANNER",
- "IMAGE",
- "INSTREAM_VIDEO",
- "INTERNAL_REDIRECT",
- "INTERSTITIAL_INTERNAL_REDIRECT",
- "REDIRECT",
- "RICH_MEDIA_EXPANDING",
- "RICH_MEDIA_IM_EXPAND",
- "RICH_MEDIA_INPAGE",
- "RICH_MEDIA_INPAGE_FLOATING",
- "RICH_MEDIA_INTERSTITIAL_FLOAT",
- "RICH_MEDIA_MOBILE_IN_APP",
- "RICH_MEDIA_MULTI_FLOATING",
- "RICH_MEDIA_PEEL_DOWN",
- "TRACKING_TEXT",
- "VAST_REDIRECT",
- "VPAID_LINEAR",
- "VPAID_NON_LINEAR"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query"
- },
- "dynamicClickTracker": {
- "type": "boolean",
- "description": "Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only ads with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "landingPageIds": {
- "type": "string",
- "description": "Select only ads with these landing page IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "overriddenEventTagId": {
- "type": "string",
- "description": "Select only ads with this event tag override ID.",
- "format": "int64",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "placementIds": {
- "type": "string",
- "description": "Select only ads with these placement IDs assigned.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "remarketingListIds": {
- "type": "string",
- "description": "Select only ads whose list targeting expression use these remarketing list IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"ad*2015\" will return objects with names like \"ad June 2015\", \"ad April 2015\", or simply \"ad 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"ad\" will match objects with name \"my ad\", \"ad 2015\", or simply \"ad\".",
- "location": "query"
- },
- "sizeIds": {
- "type": "string",
- "description": "Select only ads with these size IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sslCompliant": {
- "type": "boolean",
- "description": "Select only ads that are SSL-compliant.",
- "location": "query"
- },
- "sslRequired": {
- "type": "boolean",
- "description": "Select only ads that require SSL.",
- "location": "query"
- },
- "type": {
- "type": "string",
- "description": "Select only ads with these types.",
- "enum": [
- "AD_SERVING_CLICK_TRACKER",
- "AD_SERVING_DEFAULT_AD",
- "AD_SERVING_STANDARD_AD",
- "AD_SERVING_TRACKING"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "AdsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.ads.patch",
- "path": "userprofiles/{profileId}/ads",
- "httpMethod": "PATCH",
- "description": "Updates an existing ad. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Ad ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "Ad"
- },
- "response": {
- "$ref": "Ad"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.ads.update",
- "path": "userprofiles/{profileId}/ads",
- "httpMethod": "PUT",
- "description": "Updates an existing ad.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Ad"
- },
- "response": {
- "$ref": "Ad"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "advertiserGroups": {
- "methods": {
- "delete": {
- "id": "dfareporting.advertiserGroups.delete",
- "path": "userprofiles/{profileId}/advertiserGroups/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing advertiser group.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Advertiser group ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.advertiserGroups.get",
- "path": "userprofiles/{profileId}/advertiserGroups/{id}",
- "httpMethod": "GET",
- "description": "Gets one advertiser group by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Advertiser group ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "AdvertiserGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.advertiserGroups.insert",
- "path": "userprofiles/{profileId}/advertiserGroups",
- "httpMethod": "POST",
- "description": "Inserts a new advertiser group.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "AdvertiserGroup"
- },
- "response": {
- "$ref": "AdvertiserGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.advertiserGroups.list",
- "path": "userprofiles/{profileId}/advertiserGroups",
- "httpMethod": "GET",
- "description": "Retrieves a list of advertiser groups, possibly filtered.",
- "parameters": {
- "ids": {
- "type": "string",
- "description": "Select only advertiser groups with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"advertiser*2015\" will return objects with names like \"advertiser group June 2015\", \"advertiser group April 2015\", or simply \"advertiser group 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"advertisergroup\" will match objects with name \"my advertisergroup\", \"advertisergroup 2015\", or simply \"advertisergroup\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "AdvertiserGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.advertiserGroups.patch",
- "path": "userprofiles/{profileId}/advertiserGroups",
- "httpMethod": "PATCH",
- "description": "Updates an existing advertiser group. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Advertiser group ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "AdvertiserGroup"
- },
- "response": {
- "$ref": "AdvertiserGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.advertiserGroups.update",
- "path": "userprofiles/{profileId}/advertiserGroups",
- "httpMethod": "PUT",
- "description": "Updates an existing advertiser group.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "AdvertiserGroup"
- },
- "response": {
- "$ref": "AdvertiserGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "advertisers": {
- "methods": {
- "get": {
- "id": "dfareporting.advertisers.get",
- "path": "userprofiles/{profileId}/advertisers/{id}",
- "httpMethod": "GET",
- "description": "Gets one advertiser by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Advertiser ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Advertiser"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.advertisers.insert",
- "path": "userprofiles/{profileId}/advertisers",
- "httpMethod": "POST",
- "description": "Inserts a new advertiser.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Advertiser"
- },
- "response": {
- "$ref": "Advertiser"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.advertisers.list",
- "path": "userprofiles/{profileId}/advertisers",
- "httpMethod": "GET",
- "description": "Retrieves a list of advertisers, possibly filtered.",
- "parameters": {
- "advertiserGroupIds": {
- "type": "string",
- "description": "Select only advertisers with these advertiser group IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "floodlightConfigurationIds": {
- "type": "string",
- "description": "Select only advertisers with these floodlight configuration IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only advertisers with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "includeAdvertisersWithoutGroupsOnly": {
- "type": "boolean",
- "description": "Select only advertisers which do not belong to any advertiser group.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "onlyParent": {
- "type": "boolean",
- "description": "Select only advertisers which use another advertiser's floodlight configuration.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"advertiser*2015\" will return objects with names like \"advertiser June 2015\", \"advertiser April 2015\", or simply \"advertiser 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"advertiser\" will match objects with name \"my advertiser\", \"advertiser 2015\", or simply \"advertiser\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "status": {
- "type": "string",
- "description": "Select only advertisers with the specified status.",
- "enum": [
- "APPROVED",
- "ON_HOLD"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "subaccountId": {
- "type": "string",
- "description": "Select only advertisers with these subaccount IDs.",
- "format": "int64",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "AdvertisersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.advertisers.patch",
- "path": "userprofiles/{profileId}/advertisers",
- "httpMethod": "PATCH",
- "description": "Updates an existing advertiser. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Advertiser ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "Advertiser"
- },
- "response": {
- "$ref": "Advertiser"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.advertisers.update",
- "path": "userprofiles/{profileId}/advertisers",
- "httpMethod": "PUT",
- "description": "Updates an existing advertiser.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Advertiser"
- },
- "response": {
- "$ref": "Advertiser"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "browsers": {
- "methods": {
- "list": {
- "id": "dfareporting.browsers.list",
- "path": "userprofiles/{profileId}/browsers",
- "httpMethod": "GET",
- "description": "Retrieves a list of browsers.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "BrowsersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "campaignCreativeAssociations": {
- "methods": {
- "insert": {
- "id": "dfareporting.campaignCreativeAssociations.insert",
- "path": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
- "httpMethod": "POST",
- "description": "Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.",
- "parameters": {
- "campaignId": {
- "type": "string",
- "description": "Campaign ID in this association.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "campaignId"
- ],
- "request": {
- "$ref": "CampaignCreativeAssociation"
- },
- "response": {
- "$ref": "CampaignCreativeAssociation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.campaignCreativeAssociations.list",
- "path": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
- "httpMethod": "GET",
- "description": "Retrieves the list of creative IDs associated with the specified campaign.",
- "parameters": {
- "campaignId": {
- "type": "string",
- "description": "Campaign ID in this association.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "campaignId"
- ],
- "response": {
- "$ref": "CampaignCreativeAssociationsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "campaigns": {
- "methods": {
- "get": {
- "id": "dfareporting.campaigns.get",
- "path": "userprofiles/{profileId}/campaigns/{id}",
- "httpMethod": "GET",
- "description": "Gets one campaign by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Campaign ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Campaign"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.campaigns.insert",
- "path": "userprofiles/{profileId}/campaigns",
- "httpMethod": "POST",
- "description": "Inserts a new campaign.",
- "parameters": {
- "defaultLandingPageName": {
- "type": "string",
- "description": "Default landing page name for this new campaign. Must be less than 256 characters long.",
- "required": true,
- "location": "query"
- },
- "defaultLandingPageUrl": {
- "type": "string",
- "description": "Default landing page URL for this new campaign.",
- "required": true,
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "defaultLandingPageName",
- "defaultLandingPageUrl"
- ],
- "request": {
- "$ref": "Campaign"
- },
- "response": {
- "$ref": "Campaign"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.campaigns.list",
- "path": "userprofiles/{profileId}/campaigns",
- "httpMethod": "GET",
- "description": "Retrieves a list of campaigns, possibly filtered.",
- "parameters": {
- "advertiserGroupIds": {
- "type": "string",
- "description": "Select only campaigns whose advertisers belong to these advertiser groups.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "advertiserIds": {
- "type": "string",
- "description": "Select only campaigns that belong to these advertisers.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "archived": {
- "type": "boolean",
- "description": "Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.",
- "location": "query"
- },
- "atLeastOneOptimizationActivity": {
- "type": "boolean",
- "description": "Select only campaigns that have at least one optimization activity.",
- "location": "query"
- },
- "excludedIds": {
- "type": "string",
- "description": "Exclude campaigns with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only campaigns with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "overriddenEventTagId": {
- "type": "string",
- "description": "Select only campaigns that have overridden this event tag ID.",
- "format": "int64",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, \"campaign*2015\" will return campaigns with names like \"campaign June 2015\", \"campaign April 2015\", or simply \"campaign 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"campaign\" will match campaigns with name \"my campaign\", \"campaign 2015\", or simply \"campaign\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "subaccountId": {
- "type": "string",
- "description": "Select only campaigns that belong to this subaccount.",
- "format": "int64",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "CampaignsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.campaigns.patch",
- "path": "userprofiles/{profileId}/campaigns",
- "httpMethod": "PATCH",
- "description": "Updates an existing campaign. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Campaign ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "Campaign"
- },
- "response": {
- "$ref": "Campaign"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.campaigns.update",
- "path": "userprofiles/{profileId}/campaigns",
- "httpMethod": "PUT",
- "description": "Updates an existing campaign.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Campaign"
- },
- "response": {
- "$ref": "Campaign"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "changeLogs": {
- "methods": {
- "get": {
- "id": "dfareporting.changeLogs.get",
- "path": "userprofiles/{profileId}/changeLogs/{id}",
- "httpMethod": "GET",
- "description": "Gets one change log by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Change log ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "ChangeLog"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.changeLogs.list",
- "path": "userprofiles/{profileId}/changeLogs",
- "httpMethod": "GET",
- "description": "Retrieves a list of change logs.",
- "parameters": {
- "action": {
- "type": "string",
- "description": "Select only change logs with the specified action.",
- "enum": [
- "ACTION_ADD",
- "ACTION_ASSIGN",
- "ACTION_ASSOCIATE",
- "ACTION_CREATE",
- "ACTION_DELETE",
- "ACTION_DISABLE",
- "ACTION_EMAIL_TAGS",
- "ACTION_ENABLE",
- "ACTION_LINK",
- "ACTION_MARK_AS_DEFAULT",
- "ACTION_PUSH",
- "ACTION_REMOVE",
- "ACTION_SEND",
- "ACTION_SHARE",
- "ACTION_UNASSIGN",
- "ACTION_UNLINK",
- "ACTION_UPDATE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only change logs with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxChangeTime": {
- "type": "string",
- "description": "Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is \"2015-07-18T22:54:00-04:00\". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "minChangeTime": {
- "type": "string",
- "description": "Select only change logs whose change time is before the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is \"2015-07-18T22:54:00-04:00\". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.",
- "location": "query"
- },
- "objectIds": {
- "type": "string",
- "description": "Select only change logs with these object IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "objectType": {
- "type": "string",
- "description": "Select only change logs with the specified object type.",
- "enum": [
- "OBJECT_ACCOUNT",
- "OBJECT_ACCOUNT_BILLING_FEATURE",
- "OBJECT_AD",
- "OBJECT_ADVERTISER",
- "OBJECT_ADVERTISER_GROUP",
- "OBJECT_BILLING_ACCOUNT_GROUP",
- "OBJECT_BILLING_FEATURE",
- "OBJECT_BILLING_MINIMUM_FEE",
- "OBJECT_BILLING_PROFILE",
- "OBJECT_CAMPAIGN",
- "OBJECT_CONTENT_CATEGORY",
- "OBJECT_CREATIVE",
- "OBJECT_CREATIVE_ASSET",
- "OBJECT_CREATIVE_BUNDLE",
- "OBJECT_CREATIVE_FIELD",
- "OBJECT_CREATIVE_GROUP",
- "OBJECT_DFA_SITE",
- "OBJECT_EVENT_TAG",
- "OBJECT_FLOODLIGHT_ACTIVITY_GROUP",
- "OBJECT_FLOODLIGHT_ACTVITY",
- "OBJECT_FLOODLIGHT_CONFIGURATION",
- "OBJECT_INSTREAM_CREATIVE",
- "OBJECT_LANDING_PAGE",
- "OBJECT_MEDIA_ORDER",
- "OBJECT_PLACEMENT",
- "OBJECT_PLACEMENT_STRATEGY",
- "OBJECT_PROVIDED_LIST_CLIENT",
- "OBJECT_RATE_CARD",
- "OBJECT_REMARKETING_LIST",
- "OBJECT_RICHMEDIA_CREATIVE",
- "OBJECT_SD_SITE",
- "OBJECT_SIZE",
- "OBJECT_SUBACCOUNT",
- "OBJECT_USER_PROFILE",
- "OBJECT_USER_PROFILE_FILTER",
- "OBJECT_USER_ROLE"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Select only change logs whose object ID, user name, old or new values match the search string.",
- "location": "query"
- },
- "userProfileIds": {
- "type": "string",
- "description": "Select only change logs with these user profile IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "ChangeLogsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "cities": {
- "methods": {
- "list": {
- "id": "dfareporting.cities.list",
- "path": "userprofiles/{profileId}/cities",
- "httpMethod": "GET",
- "description": "Retrieves a list of cities, possibly filtered.",
- "parameters": {
- "countryDartIds": {
- "type": "string",
- "description": "Select only cities from these countries.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "dartIds": {
- "type": "string",
- "description": "Select only cities with these DART IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "namePrefix": {
- "type": "string",
- "description": "Select only cities with names starting with this prefix.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "regionDartIds": {
- "type": "string",
- "description": "Select only cities from these regions.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "CitiesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "connectionTypes": {
- "methods": {
- "get": {
- "id": "dfareporting.connectionTypes.get",
- "path": "userprofiles/{profileId}/connectionTypes/{id}",
- "httpMethod": "GET",
- "description": "Gets one connection type by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Connection type ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "ConnectionType"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.connectionTypes.list",
- "path": "userprofiles/{profileId}/connectionTypes",
- "httpMethod": "GET",
- "description": "Retrieves a list of connection types.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "ConnectionTypesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "contentCategories": {
- "methods": {
- "delete": {
- "id": "dfareporting.contentCategories.delete",
- "path": "userprofiles/{profileId}/contentCategories/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing content category.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Content category ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.contentCategories.get",
- "path": "userprofiles/{profileId}/contentCategories/{id}",
- "httpMethod": "GET",
- "description": "Gets one content category by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Content category ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "ContentCategory"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.contentCategories.insert",
- "path": "userprofiles/{profileId}/contentCategories",
- "httpMethod": "POST",
- "description": "Inserts a new content category.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "ContentCategory"
- },
- "response": {
- "$ref": "ContentCategory"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.contentCategories.list",
- "path": "userprofiles/{profileId}/contentCategories",
- "httpMethod": "GET",
- "description": "Retrieves a list of content categories, possibly filtered.",
- "parameters": {
- "ids": {
- "type": "string",
- "description": "Select only content categories with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"contentcategory*2015\" will return objects with names like \"contentcategory June 2015\", \"contentcategory April 2015\", or simply \"contentcategory 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"contentcategory\" will match objects with name \"my contentcategory\", \"contentcategory 2015\", or simply \"contentcategory\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "ContentCategoriesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.contentCategories.patch",
- "path": "userprofiles/{profileId}/contentCategories",
- "httpMethod": "PATCH",
- "description": "Updates an existing content category. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Content category ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "ContentCategory"
- },
- "response": {
- "$ref": "ContentCategory"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.contentCategories.update",
- "path": "userprofiles/{profileId}/contentCategories",
- "httpMethod": "PUT",
- "description": "Updates an existing content category.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "ContentCategory"
- },
- "response": {
- "$ref": "ContentCategory"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "countries": {
- "methods": {
- "get": {
- "id": "dfareporting.countries.get",
- "path": "userprofiles/{profileId}/countries/{dartId}",
- "httpMethod": "GET",
- "description": "Gets one country by ID.",
- "parameters": {
- "dartId": {
- "type": "string",
- "description": "Country DART ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "dartId"
- ],
- "response": {
- "$ref": "Country"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.countries.list",
- "path": "userprofiles/{profileId}/countries",
- "httpMethod": "GET",
- "description": "Retrieves a list of countries.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "CountriesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "creativeAssets": {
- "methods": {
- "insert": {
- "id": "dfareporting.creativeAssets.insert",
- "path": "userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets",
- "httpMethod": "POST",
- "description": "Inserts a new creative asset.",
- "parameters": {
- "advertiserId": {
- "type": "string",
- "description": "Advertiser ID of this creative. This is a required field.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "advertiserId"
- ],
- "request": {
- "$ref": "CreativeAssetMetadata"
- },
- "response": {
- "$ref": "CreativeAssetMetadata"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ],
- "supportsMediaUpload": true,
- "mediaUpload": {
- "accept": [
- "*/*"
- ],
- "maxSize": "100MB",
- "protocols": {
- "simple": {
- "multipart": true,
- "path": "/upload/dfareporting/v2.2/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets"
- },
- "resumable": {
- "multipart": true,
- "path": "/resumable/upload/dfareporting/v2.2/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets"
- }
- }
- }
- }
- }
- },
- "creativeFieldValues": {
- "methods": {
- "delete": {
- "id": "dfareporting.creativeFieldValues.delete",
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing creative field value.",
- "parameters": {
- "creativeFieldId": {
- "type": "string",
- "description": "Creative field ID for this creative field value.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "id": {
- "type": "string",
- "description": "Creative Field Value ID",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "creativeFieldId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.creativeFieldValues.get",
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
- "httpMethod": "GET",
- "description": "Gets one creative field value by ID.",
- "parameters": {
- "creativeFieldId": {
- "type": "string",
- "description": "Creative field ID for this creative field value.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "id": {
- "type": "string",
- "description": "Creative Field Value ID",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "creativeFieldId",
- "id"
- ],
- "response": {
- "$ref": "CreativeFieldValue"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.creativeFieldValues.insert",
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- "httpMethod": "POST",
- "description": "Inserts a new creative field value.",
- "parameters": {
- "creativeFieldId": {
- "type": "string",
- "description": "Creative field ID for this creative field value.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "creativeFieldId"
- ],
- "request": {
- "$ref": "CreativeFieldValue"
- },
- "response": {
- "$ref": "CreativeFieldValue"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.creativeFieldValues.list",
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- "httpMethod": "GET",
- "description": "Retrieves a list of creative field values, possibly filtered.",
- "parameters": {
- "creativeFieldId": {
- "type": "string",
- "description": "Creative field ID for this creative field value.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "ids": {
- "type": "string",
- "description": "Select only creative field values with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "VALUE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "creativeFieldId"
- ],
- "response": {
- "$ref": "CreativeFieldValuesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.creativeFieldValues.patch",
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- "httpMethod": "PATCH",
- "description": "Updates an existing creative field value. This method supports patch semantics.",
- "parameters": {
- "creativeFieldId": {
- "type": "string",
- "description": "Creative field ID for this creative field value.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "id": {
- "type": "string",
- "description": "Creative Field Value ID",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "creativeFieldId",
- "id"
- ],
- "request": {
- "$ref": "CreativeFieldValue"
- },
- "response": {
- "$ref": "CreativeFieldValue"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.creativeFieldValues.update",
- "path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
- "httpMethod": "PUT",
- "description": "Updates an existing creative field value.",
- "parameters": {
- "creativeFieldId": {
- "type": "string",
- "description": "Creative field ID for this creative field value.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "creativeFieldId"
- ],
- "request": {
- "$ref": "CreativeFieldValue"
- },
- "response": {
- "$ref": "CreativeFieldValue"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "creativeFields": {
- "methods": {
- "delete": {
- "id": "dfareporting.creativeFields.delete",
- "path": "userprofiles/{profileId}/creativeFields/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing creative field.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Creative Field ID",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.creativeFields.get",
- "path": "userprofiles/{profileId}/creativeFields/{id}",
- "httpMethod": "GET",
- "description": "Gets one creative field by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Creative Field ID",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "CreativeField"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.creativeFields.insert",
- "path": "userprofiles/{profileId}/creativeFields",
- "httpMethod": "POST",
- "description": "Inserts a new creative field.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "CreativeField"
- },
- "response": {
- "$ref": "CreativeField"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.creativeFields.list",
- "path": "userprofiles/{profileId}/creativeFields",
- "httpMethod": "GET",
- "description": "Retrieves a list of creative fields, possibly filtered.",
- "parameters": {
- "advertiserIds": {
- "type": "string",
- "description": "Select only creative fields that belong to these advertisers.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only creative fields with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, \"creativefield*2015\" will return creative fields with names like \"creativefield June 2015\", \"creativefield April 2015\", or simply \"creativefield 2015\". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of \"creativefield\" will match creative fields with the name \"my creativefield\", \"creativefield 2015\", or simply \"creativefield\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "CreativeFieldsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.creativeFields.patch",
- "path": "userprofiles/{profileId}/creativeFields",
- "httpMethod": "PATCH",
- "description": "Updates an existing creative field. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Creative Field ID",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "CreativeField"
- },
- "response": {
- "$ref": "CreativeField"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.creativeFields.update",
- "path": "userprofiles/{profileId}/creativeFields",
- "httpMethod": "PUT",
- "description": "Updates an existing creative field.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "CreativeField"
- },
- "response": {
- "$ref": "CreativeField"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "creativeGroups": {
- "methods": {
- "get": {
- "id": "dfareporting.creativeGroups.get",
- "path": "userprofiles/{profileId}/creativeGroups/{id}",
- "httpMethod": "GET",
- "description": "Gets one creative group by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Creative group ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "CreativeGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.creativeGroups.insert",
- "path": "userprofiles/{profileId}/creativeGroups",
- "httpMethod": "POST",
- "description": "Inserts a new creative group.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "CreativeGroup"
- },
- "response": {
- "$ref": "CreativeGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.creativeGroups.list",
- "path": "userprofiles/{profileId}/creativeGroups",
- "httpMethod": "GET",
- "description": "Retrieves a list of creative groups, possibly filtered.",
- "parameters": {
- "advertiserIds": {
- "type": "string",
- "description": "Select only creative groups that belong to these advertisers.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "groupNumber": {
- "type": "integer",
- "description": "Select only creative groups that belong to this subgroup.",
- "format": "int32",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only creative groups with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, \"creativegroup*2015\" will return creative groups with names like \"creativegroup June 2015\", \"creativegroup April 2015\", or simply \"creativegroup 2015\". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of \"creativegroup\" will match creative groups with the name \"my creativegroup\", \"creativegroup 2015\", or simply \"creativegroup\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "CreativeGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.creativeGroups.patch",
- "path": "userprofiles/{profileId}/creativeGroups",
- "httpMethod": "PATCH",
- "description": "Updates an existing creative group. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Creative group ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "CreativeGroup"
- },
- "response": {
- "$ref": "CreativeGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.creativeGroups.update",
- "path": "userprofiles/{profileId}/creativeGroups",
- "httpMethod": "PUT",
- "description": "Updates an existing creative group.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "CreativeGroup"
- },
- "response": {
- "$ref": "CreativeGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "creatives": {
- "methods": {
- "get": {
- "id": "dfareporting.creatives.get",
- "path": "userprofiles/{profileId}/creatives/{id}",
- "httpMethod": "GET",
- "description": "Gets one creative by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Creative ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.creatives.insert",
- "path": "userprofiles/{profileId}/creatives",
- "httpMethod": "POST",
- "description": "Inserts a new creative.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.creatives.list",
- "path": "userprofiles/{profileId}/creatives",
- "httpMethod": "GET",
- "description": "Retrieves a list of creatives, possibly filtered.",
- "parameters": {
- "active": {
- "type": "boolean",
- "description": "Select only active creatives. Leave blank to select active and inactive creatives.",
- "location": "query"
- },
- "advertiserId": {
- "type": "string",
- "description": "Select only creatives with this advertiser ID.",
- "format": "int64",
- "location": "query"
- },
- "archived": {
- "type": "boolean",
- "description": "Select only archived creatives. Leave blank to select archived and unarchived creatives.",
- "location": "query"
- },
- "campaignId": {
- "type": "string",
- "description": "Select only creatives with this campaign ID.",
- "format": "int64",
- "location": "query"
- },
- "companionCreativeIds": {
- "type": "string",
- "description": "Select only in-stream video creatives with these companion IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "creativeFieldIds": {
- "type": "string",
- "description": "Select only creatives with these creative field IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only creatives with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "renderingIds": {
- "type": "string",
- "description": "Select only creatives with these rendering IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"creative*2015\" will return objects with names like \"creative June 2015\", \"creative April 2015\", or simply \"creative 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"creative\" will match objects with name \"my creative\", \"creative 2015\", or simply \"creative\".",
- "location": "query"
- },
- "sizeIds": {
- "type": "string",
- "description": "Select only creatives with these size IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "studioCreativeId": {
- "type": "string",
- "description": "Select only creatives corresponding to this Studio creative ID.",
- "format": "int64",
- "location": "query"
- },
- "types": {
- "type": "string",
- "description": "Select only creatives with these creative types.",
- "enum": [
- "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO",
- "CUSTOM_INPAGE",
- "CUSTOM_INTERSTITIAL",
- "ENHANCED_BANNER",
- "ENHANCED_IMAGE",
- "FLASH_INPAGE",
- "HTML5_BANNER",
- "IMAGE",
- "INSTREAM_VIDEO",
- "INTERNAL_REDIRECT",
- "INTERSTITIAL_INTERNAL_REDIRECT",
- "REDIRECT",
- "RICH_MEDIA_EXPANDING",
- "RICH_MEDIA_IM_EXPAND",
- "RICH_MEDIA_INPAGE",
- "RICH_MEDIA_INPAGE_FLOATING",
- "RICH_MEDIA_INTERSTITIAL_FLOAT",
- "RICH_MEDIA_MOBILE_IN_APP",
- "RICH_MEDIA_MULTI_FLOATING",
- "RICH_MEDIA_PEEL_DOWN",
- "TRACKING_TEXT",
- "VAST_REDIRECT",
- "VPAID_LINEAR",
- "VPAID_NON_LINEAR"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "CreativesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.creatives.patch",
- "path": "userprofiles/{profileId}/creatives",
- "httpMethod": "PATCH",
- "description": "Updates an existing creative. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Creative ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.creatives.update",
- "path": "userprofiles/{profileId}/creatives",
- "httpMethod": "PUT",
- "description": "Updates an existing creative.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "dimensionValues": {
- "methods": {
- "query": {
- "id": "dfareporting.dimensionValues.query",
- "path": "userprofiles/{profileId}/dimensionvalues/query",
- "httpMethod": "POST",
- "description": "Retrieves list of report dimension values for a list of filters.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "DimensionValueRequest"
- },
- "response": {
- "$ref": "DimensionValueList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- },
- "directorySiteContacts": {
- "methods": {
- "get": {
- "id": "dfareporting.directorySiteContacts.get",
- "path": "userprofiles/{profileId}/directorySiteContacts/{id}",
- "httpMethod": "GET",
- "description": "Gets one directory site contact by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Directory site contact ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "DirectorySiteContact"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.directorySiteContacts.list",
- "path": "userprofiles/{profileId}/directorySiteContacts",
- "httpMethod": "GET",
- "description": "Retrieves a list of directory site contacts, possibly filtered.",
- "parameters": {
- "directorySiteIds": {
- "type": "string",
- "description": "Select only directory site contacts with these directory site IDs. This is a required field.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only directory site contacts with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, \"directory site contact*2015\" will return objects with names like \"directory site contact June 2015\", \"directory site contact April 2015\", or simply \"directory site contact 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"directory site contact\" will match objects with name \"my directory site contact\", \"directory site contact 2015\", or simply \"directory site contact\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "DirectorySiteContactsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "directorySites": {
- "methods": {
- "get": {
- "id": "dfareporting.directorySites.get",
- "path": "userprofiles/{profileId}/directorySites/{id}",
- "httpMethod": "GET",
- "description": "Gets one directory site by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Directory site ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "DirectorySite"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.directorySites.insert",
- "path": "userprofiles/{profileId}/directorySites",
- "httpMethod": "POST",
- "description": "Inserts a new directory site.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "DirectorySite"
- },
- "response": {
- "$ref": "DirectorySite"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.directorySites.list",
- "path": "userprofiles/{profileId}/directorySites",
- "httpMethod": "GET",
- "description": "Retrieves a list of directory sites, possibly filtered.",
- "parameters": {
- "acceptsInStreamVideoPlacements": {
- "type": "boolean",
- "description": "This search filter is no longer supported and will have no effect on the results returned.",
- "location": "query"
- },
- "acceptsInterstitialPlacements": {
- "type": "boolean",
- "description": "This search filter is no longer supported and will have no effect on the results returned.",
- "location": "query"
- },
- "acceptsPublisherPaidPlacements": {
- "type": "boolean",
- "description": "Select only directory sites that accept publisher paid placements. This field can be left blank.",
- "location": "query"
- },
- "active": {
- "type": "boolean",
- "description": "Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.",
- "location": "query"
- },
- "countryId": {
- "type": "string",
- "description": "Select only directory sites with this country ID.",
- "format": "int64",
- "location": "query"
- },
- "dfp_network_code": {
- "type": "string",
- "description": "Select only directory sites with this DFP network code.",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only directory sites with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "parentId": {
- "type": "string",
- "description": "Select only directory sites with this parent ID.",
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, \"directory site*2015\" will return objects with names like \"directory site June 2015\", \"directory site April 2015\", or simply \"directory site 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"directory site\" will match objects with name \"my directory site\", \"directory site 2015\" or simply, \"directory site\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "DirectorySitesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "eventTags": {
- "methods": {
- "delete": {
- "id": "dfareporting.eventTags.delete",
- "path": "userprofiles/{profileId}/eventTags/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing event tag.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Event tag ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.eventTags.get",
- "path": "userprofiles/{profileId}/eventTags/{id}",
- "httpMethod": "GET",
- "description": "Gets one event tag by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Event tag ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "EventTag"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.eventTags.insert",
- "path": "userprofiles/{profileId}/eventTags",
- "httpMethod": "POST",
- "description": "Inserts a new event tag.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "EventTag"
- },
- "response": {
- "$ref": "EventTag"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.eventTags.list",
- "path": "userprofiles/{profileId}/eventTags",
- "httpMethod": "GET",
- "description": "Retrieves a list of event tags, possibly filtered.",
- "parameters": {
- "adId": {
- "type": "string",
- "description": "Select only event tags that belong to this ad.",
- "format": "int64",
- "location": "query"
- },
- "advertiserId": {
- "type": "string",
- "description": "Select only event tags that belong to this advertiser.",
- "format": "int64",
- "location": "query"
- },
- "campaignId": {
- "type": "string",
- "description": "Select only event tags that belong to this campaign.",
- "format": "int64",
- "location": "query"
- },
- "definitionsOnly": {
- "type": "boolean",
- "description": "Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.",
- "location": "query"
- },
- "enabled": {
- "type": "boolean",
- "description": "Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.",
- "location": "query"
- },
- "eventTagTypes": {
- "type": "string",
- "description": "Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking.",
- "enum": [
- "CLICK_THROUGH_EVENT_TAG",
- "IMPRESSION_IMAGE_EVENT_TAG",
- "IMPRESSION_JAVASCRIPT_EVENT_TAG"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only event tags with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"eventtag*2015\" will return objects with names like \"eventtag June 2015\", \"eventtag April 2015\", or simply \"eventtag 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"eventtag\" will match objects with name \"my eventtag\", \"eventtag 2015\", or simply \"eventtag\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "EventTagsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.eventTags.patch",
- "path": "userprofiles/{profileId}/eventTags",
- "httpMethod": "PATCH",
- "description": "Updates an existing event tag. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Event tag ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "EventTag"
- },
- "response": {
- "$ref": "EventTag"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.eventTags.update",
- "path": "userprofiles/{profileId}/eventTags",
- "httpMethod": "PUT",
- "description": "Updates an existing event tag.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "EventTag"
- },
- "response": {
- "$ref": "EventTag"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "files": {
- "methods": {
- "get": {
- "id": "dfareporting.files.get",
- "path": "reports/{reportId}/files/{fileId}",
- "httpMethod": "GET",
- "description": "Retrieves a report file by its report ID and file ID.",
- "parameters": {
- "fileId": {
- "type": "string",
- "description": "The ID of the report file.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "reportId",
- "fileId"
- ],
- "response": {
- "$ref": "File"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ],
- "supportsMediaDownload": true
- },
- "list": {
- "id": "dfareporting.files.list",
- "path": "userprofiles/{profileId}/files",
- "httpMethod": "GET",
- "description": "Lists files for a user profile.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "scope": {
- "type": "string",
- "description": "The scope that defines which results are returned, default is 'MINE'.",
- "default": "MINE",
- "enum": [
- "ALL",
- "MINE",
- "SHARED_WITH_ME"
- ],
- "enumDescriptions": [
- "All files in account.",
- "My files.",
- "Files shared with me."
- ],
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "The field by which to sort the list.",
- "default": "LAST_MODIFIED_TIME",
- "enum": [
- "ID",
- "LAST_MODIFIED_TIME"
- ],
- "enumDescriptions": [
- "Sort by file ID.",
- "Sort by 'lastmodifiedAt' field."
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is 'DESCENDING'.",
- "default": "DESCENDING",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "FileList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- },
- "floodlightActivities": {
- "methods": {
- "delete": {
- "id": "dfareporting.floodlightActivities.delete",
- "path": "userprofiles/{profileId}/floodlightActivities/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing floodlight activity.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Floodlight activity ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "generatetag": {
- "id": "dfareporting.floodlightActivities.generatetag",
- "path": "userprofiles/{profileId}/floodlightActivities/generatetag",
- "httpMethod": "POST",
- "description": "Generates a tag for a floodlight activity.",
- "parameters": {
- "floodlightActivityId": {
- "type": "string",
- "description": "Floodlight activity ID for which we want to generate a tag.",
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "FloodlightActivitiesGenerateTagResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.floodlightActivities.get",
- "path": "userprofiles/{profileId}/floodlightActivities/{id}",
- "httpMethod": "GET",
- "description": "Gets one floodlight activity by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Floodlight activity ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "FloodlightActivity"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.floodlightActivities.insert",
- "path": "userprofiles/{profileId}/floodlightActivities",
- "httpMethod": "POST",
- "description": "Inserts a new floodlight activity.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "FloodlightActivity"
- },
- "response": {
- "$ref": "FloodlightActivity"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.floodlightActivities.list",
- "path": "userprofiles/{profileId}/floodlightActivities",
- "httpMethod": "GET",
- "description": "Retrieves a list of floodlight activities, possibly filtered.",
- "parameters": {
- "advertiserId": {
- "type": "string",
- "description": "Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "location": "query"
- },
- "floodlightActivityGroupIds": {
- "type": "string",
- "description": "Select only floodlight activities with the specified floodlight activity group IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "floodlightActivityGroupName": {
- "type": "string",
- "description": "Select only floodlight activities with the specified floodlight activity group name.",
- "location": "query"
- },
- "floodlightActivityGroupTagString": {
- "type": "string",
- "description": "Select only floodlight activities with the specified floodlight activity group tag string.",
- "location": "query"
- },
- "floodlightActivityGroupType": {
- "type": "string",
- "description": "Select only floodlight activities with the specified floodlight activity group type.",
- "enum": [
- "COUNTER",
- "SALE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "floodlightConfigurationId": {
- "type": "string",
- "description": "Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"floodlightactivity*2015\" will return objects with names like \"floodlightactivity June 2015\", \"floodlightactivity April 2015\", or simply \"floodlightactivity 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"floodlightactivity\" will match objects with name \"my floodlightactivity activity\", \"floodlightactivity 2015\", or simply \"floodlightactivity\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "tagString": {
- "type": "string",
- "description": "Select only floodlight activities with the specified tag string.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "FloodlightActivitiesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.floodlightActivities.patch",
- "path": "userprofiles/{profileId}/floodlightActivities",
- "httpMethod": "PATCH",
- "description": "Updates an existing floodlight activity. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Floodlight activity ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "FloodlightActivity"
- },
- "response": {
- "$ref": "FloodlightActivity"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.floodlightActivities.update",
- "path": "userprofiles/{profileId}/floodlightActivities",
- "httpMethod": "PUT",
- "description": "Updates an existing floodlight activity.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "FloodlightActivity"
- },
- "response": {
- "$ref": "FloodlightActivity"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "floodlightActivityGroups": {
- "methods": {
- "delete": {
- "id": "dfareporting.floodlightActivityGroups.delete",
- "path": "userprofiles/{profileId}/floodlightActivityGroups/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing floodlight activity group.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Floodlight activity Group ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.floodlightActivityGroups.get",
- "path": "userprofiles/{profileId}/floodlightActivityGroups/{id}",
- "httpMethod": "GET",
- "description": "Gets one floodlight activity group by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Floodlight activity Group ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "FloodlightActivityGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.floodlightActivityGroups.insert",
- "path": "userprofiles/{profileId}/floodlightActivityGroups",
- "httpMethod": "POST",
- "description": "Inserts a new floodlight activity group.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "FloodlightActivityGroup"
- },
- "response": {
- "$ref": "FloodlightActivityGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.floodlightActivityGroups.list",
- "path": "userprofiles/{profileId}/floodlightActivityGroups",
- "httpMethod": "GET",
- "description": "Retrieves a list of floodlight activity groups, possibly filtered.",
- "parameters": {
- "advertiserId": {
- "type": "string",
- "description": "Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "location": "query"
- },
- "floodlightConfigurationId": {
- "type": "string",
- "description": "Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"floodlightactivitygroup*2015\" will return objects with names like \"floodlightactivitygroup June 2015\", \"floodlightactivitygroup April 2015\", or simply \"floodlightactivitygroup 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"floodlightactivitygroup\" will match objects with name \"my floodlightactivitygroup activity\", \"floodlightactivitygroup 2015\", or simply \"floodlightactivitygroup\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "type": {
- "type": "string",
- "description": "Select only floodlight activity groups with the specified floodlight activity group type.",
- "enum": [
- "COUNTER",
- "SALE"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "FloodlightActivityGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.floodlightActivityGroups.patch",
- "path": "userprofiles/{profileId}/floodlightActivityGroups",
- "httpMethod": "PATCH",
- "description": "Updates an existing floodlight activity group. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Floodlight activity Group ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "FloodlightActivityGroup"
- },
- "response": {
- "$ref": "FloodlightActivityGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.floodlightActivityGroups.update",
- "path": "userprofiles/{profileId}/floodlightActivityGroups",
- "httpMethod": "PUT",
- "description": "Updates an existing floodlight activity group.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "FloodlightActivityGroup"
- },
- "response": {
- "$ref": "FloodlightActivityGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "floodlightConfigurations": {
- "methods": {
- "get": {
- "id": "dfareporting.floodlightConfigurations.get",
- "path": "userprofiles/{profileId}/floodlightConfigurations/{id}",
- "httpMethod": "GET",
- "description": "Gets one floodlight configuration by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Floodlight configuration ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "FloodlightConfiguration"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.floodlightConfigurations.list",
- "path": "userprofiles/{profileId}/floodlightConfigurations",
- "httpMethod": "GET",
- "description": "Retrieves a list of floodlight configurations, possibly filtered.",
- "parameters": {
- "ids": {
- "type": "string",
- "description": "Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "FloodlightConfigurationsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.floodlightConfigurations.patch",
- "path": "userprofiles/{profileId}/floodlightConfigurations",
- "httpMethod": "PATCH",
- "description": "Updates an existing floodlight configuration. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Floodlight configuration ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "FloodlightConfiguration"
- },
- "response": {
- "$ref": "FloodlightConfiguration"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.floodlightConfigurations.update",
- "path": "userprofiles/{profileId}/floodlightConfigurations",
- "httpMethod": "PUT",
- "description": "Updates an existing floodlight configuration.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "FloodlightConfiguration"
- },
- "response": {
- "$ref": "FloodlightConfiguration"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "inventoryItems": {
- "methods": {
- "get": {
- "id": "dfareporting.inventoryItems.get",
- "path": "userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}",
- "httpMethod": "GET",
- "description": "Gets one inventory item by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Inventory item ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID for order documents.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "projectId",
- "id"
- ],
- "response": {
- "$ref": "InventoryItem"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.inventoryItems.list",
- "path": "userprofiles/{profileId}/projects/{projectId}/inventoryItems",
- "httpMethod": "GET",
- "description": "Retrieves a list of inventory items, possibly filtered.",
- "parameters": {
- "ids": {
- "type": "string",
- "description": "Select only inventory items with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "inPlan": {
- "type": "boolean",
- "description": "Select only inventory items that are in plan.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "orderId": {
- "type": "string",
- "description": "Select only inventory items that belong to specified orders.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID for order documents.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "siteId": {
- "type": "string",
- "description": "Select only inventory items that are associated with these sites.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "projectId"
- ],
- "response": {
- "$ref": "InventoryItemsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "landingPages": {
- "methods": {
- "delete": {
- "id": "dfareporting.landingPages.delete",
- "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing campaign landing page.",
- "parameters": {
- "campaignId": {
- "type": "string",
- "description": "Landing page campaign ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "id": {
- "type": "string",
- "description": "Landing page ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "campaignId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.landingPages.get",
- "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages/{id}",
- "httpMethod": "GET",
- "description": "Gets one campaign landing page by ID.",
- "parameters": {
- "campaignId": {
- "type": "string",
- "description": "Landing page campaign ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "id": {
- "type": "string",
- "description": "Landing page ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "campaignId",
- "id"
- ],
- "response": {
- "$ref": "LandingPage"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.landingPages.insert",
- "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages",
- "httpMethod": "POST",
- "description": "Inserts a new landing page for the specified campaign.",
- "parameters": {
- "campaignId": {
- "type": "string",
- "description": "Landing page campaign ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "campaignId"
- ],
- "request": {
- "$ref": "LandingPage"
- },
- "response": {
- "$ref": "LandingPage"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.landingPages.list",
- "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages",
- "httpMethod": "GET",
- "description": "Retrieves the list of landing pages for the specified campaign.",
- "parameters": {
- "campaignId": {
- "type": "string",
- "description": "Landing page campaign ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "campaignId"
- ],
- "response": {
- "$ref": "LandingPagesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.landingPages.patch",
- "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages",
- "httpMethod": "PATCH",
- "description": "Updates an existing campaign landing page. This method supports patch semantics.",
- "parameters": {
- "campaignId": {
- "type": "string",
- "description": "Landing page campaign ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "id": {
- "type": "string",
- "description": "Landing page ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "campaignId",
- "id"
- ],
- "request": {
- "$ref": "LandingPage"
- },
- "response": {
- "$ref": "LandingPage"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.landingPages.update",
- "path": "userprofiles/{profileId}/campaigns/{campaignId}/landingPages",
- "httpMethod": "PUT",
- "description": "Updates an existing campaign landing page.",
- "parameters": {
- "campaignId": {
- "type": "string",
- "description": "Landing page campaign ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "campaignId"
- ],
- "request": {
- "$ref": "LandingPage"
- },
- "response": {
- "$ref": "LandingPage"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "metros": {
- "methods": {
- "list": {
- "id": "dfareporting.metros.list",
- "path": "userprofiles/{profileId}/metros",
- "httpMethod": "GET",
- "description": "Retrieves a list of metros.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "MetrosListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "mobileCarriers": {
- "methods": {
- "get": {
- "id": "dfareporting.mobileCarriers.get",
- "path": "userprofiles/{profileId}/mobileCarriers/{id}",
- "httpMethod": "GET",
- "description": "Gets one mobile carrier by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Mobile carrier ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "MobileCarrier"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.mobileCarriers.list",
- "path": "userprofiles/{profileId}/mobileCarriers",
- "httpMethod": "GET",
- "description": "Retrieves a list of mobile carriers.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "MobileCarriersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "operatingSystemVersions": {
- "methods": {
- "get": {
- "id": "dfareporting.operatingSystemVersions.get",
- "path": "userprofiles/{profileId}/operatingSystemVersions/{id}",
- "httpMethod": "GET",
- "description": "Gets one operating system version by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Operating system version ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "OperatingSystemVersion"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.operatingSystemVersions.list",
- "path": "userprofiles/{profileId}/operatingSystemVersions",
- "httpMethod": "GET",
- "description": "Retrieves a list of operating system versions.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "OperatingSystemVersionsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "operatingSystems": {
- "methods": {
- "get": {
- "id": "dfareporting.operatingSystems.get",
- "path": "userprofiles/{profileId}/operatingSystems/{dartId}",
- "httpMethod": "GET",
- "description": "Gets one operating system by DART ID.",
- "parameters": {
- "dartId": {
- "type": "string",
- "description": "Operating system DART ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "dartId"
- ],
- "response": {
- "$ref": "OperatingSystem"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.operatingSystems.list",
- "path": "userprofiles/{profileId}/operatingSystems",
- "httpMethod": "GET",
- "description": "Retrieves a list of operating systems.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "OperatingSystemsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "orderDocuments": {
- "methods": {
- "get": {
- "id": "dfareporting.orderDocuments.get",
- "path": "userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}",
- "httpMethod": "GET",
- "description": "Gets one order document by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Order document ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID for order documents.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "projectId",
- "id"
- ],
- "response": {
- "$ref": "OrderDocument"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.orderDocuments.list",
- "path": "userprofiles/{profileId}/projects/{projectId}/orderDocuments",
- "httpMethod": "GET",
- "description": "Retrieves a list of order documents, possibly filtered.",
- "parameters": {
- "approved": {
- "type": "boolean",
- "description": "Select only order documents that have been approved by at least one user.",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only order documents with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "orderId": {
- "type": "string",
- "description": "Select only order documents for specified orders.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID for order documents.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, \"orderdocument*2015\" will return order documents with names like \"orderdocument June 2015\", \"orderdocument April 2015\", or simply \"orderdocument 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"orderdocument\" will match order documents with name \"my orderdocument\", \"orderdocument 2015\", or simply \"orderdocument\".",
- "location": "query"
- },
- "siteId": {
- "type": "string",
- "description": "Select only order documents that are associated with these sites.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "projectId"
- ],
- "response": {
- "$ref": "OrderDocumentsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "orders": {
- "methods": {
- "get": {
- "id": "dfareporting.orders.get",
- "path": "userprofiles/{profileId}/projects/{projectId}/orders/{id}",
- "httpMethod": "GET",
- "description": "Gets one order by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Order ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID for orders.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "projectId",
- "id"
- ],
- "response": {
- "$ref": "Order"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.orders.list",
- "path": "userprofiles/{profileId}/projects/{projectId}/orders",
- "httpMethod": "GET",
- "description": "Retrieves a list of orders, possibly filtered.",
- "parameters": {
- "ids": {
- "type": "string",
- "description": "Select only orders with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "Project ID for orders.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, \"order*2015\" will return orders with names like \"order June 2015\", \"order April 2015\", or simply \"order 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"order\" will match orders with name \"my order\", \"order 2015\", or simply \"order\".",
- "location": "query"
- },
- "siteId": {
- "type": "string",
- "description": "Select only orders that are associated with these site IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "projectId"
- ],
- "response": {
- "$ref": "OrdersListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "placementGroups": {
- "methods": {
- "get": {
- "id": "dfareporting.placementGroups.get",
- "path": "userprofiles/{profileId}/placementGroups/{id}",
- "httpMethod": "GET",
- "description": "Gets one placement group by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Placement group ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "PlacementGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.placementGroups.insert",
- "path": "userprofiles/{profileId}/placementGroups",
- "httpMethod": "POST",
- "description": "Inserts a new placement group.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "PlacementGroup"
- },
- "response": {
- "$ref": "PlacementGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.placementGroups.list",
- "path": "userprofiles/{profileId}/placementGroups",
- "httpMethod": "GET",
- "description": "Retrieves a list of placement groups, possibly filtered.",
- "parameters": {
- "advertiserIds": {
- "type": "string",
- "description": "Select only placement groups that belong to these advertisers.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "archived": {
- "type": "boolean",
- "description": "Select only archived placements. Don't set this field to select both archived and non-archived placements.",
- "location": "query"
- },
- "campaignIds": {
- "type": "string",
- "description": "Select only placement groups that belong to these campaigns.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "contentCategoryIds": {
- "type": "string",
- "description": "Select only placement groups that are associated with these content categories.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "directorySiteIds": {
- "type": "string",
- "description": "Select only placement groups that are associated with these directory sites.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only placement groups with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxEndDate": {
- "type": "string",
- "description": "Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as \"yyyy-MM-dd\".",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "maxStartDate": {
- "type": "string",
- "description": "Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as \"yyyy-MM-dd\".",
- "location": "query"
- },
- "minEndDate": {
- "type": "string",
- "description": "Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as \"yyyy-MM-dd\".",
- "location": "query"
- },
- "minStartDate": {
- "type": "string",
- "description": "Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as \"yyyy-MM-dd\".",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "placementGroupType": {
- "type": "string",
- "description": "Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.",
- "enum": [
- "PLACEMENT_PACKAGE",
- "PLACEMENT_ROADBLOCK"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "placementStrategyIds": {
- "type": "string",
- "description": "Select only placement groups that are associated with these placement strategies.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "pricingTypes": {
- "type": "string",
- "description": "Select only placement groups with these pricing types.",
- "enum": [
- "PRICING_TYPE_CPA",
- "PRICING_TYPE_CPC",
- "PRICING_TYPE_CPM",
- "PRICING_TYPE_FLAT_RATE_CLICKS",
- "PRICING_TYPE_FLAT_RATE_IMPRESSIONS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, \"placement*2015\" will return placement groups with names like \"placement group June 2015\", \"placement group May 2015\", or simply \"placements 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placementgroup\" will match placement groups with name \"my placementgroup\", \"placementgroup 2015\", or simply \"placementgroup\".",
- "location": "query"
- },
- "siteIds": {
- "type": "string",
- "description": "Select only placement groups that are associated with these sites.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "PlacementGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.placementGroups.patch",
- "path": "userprofiles/{profileId}/placementGroups",
- "httpMethod": "PATCH",
- "description": "Updates an existing placement group. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Placement group ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "PlacementGroup"
- },
- "response": {
- "$ref": "PlacementGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.placementGroups.update",
- "path": "userprofiles/{profileId}/placementGroups",
- "httpMethod": "PUT",
- "description": "Updates an existing placement group.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "PlacementGroup"
- },
- "response": {
- "$ref": "PlacementGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "placementStrategies": {
- "methods": {
- "delete": {
- "id": "dfareporting.placementStrategies.delete",
- "path": "userprofiles/{profileId}/placementStrategies/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing placement strategy.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Placement strategy ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.placementStrategies.get",
- "path": "userprofiles/{profileId}/placementStrategies/{id}",
- "httpMethod": "GET",
- "description": "Gets one placement strategy by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Placement strategy ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "PlacementStrategy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.placementStrategies.insert",
- "path": "userprofiles/{profileId}/placementStrategies",
- "httpMethod": "POST",
- "description": "Inserts a new placement strategy.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "PlacementStrategy"
- },
- "response": {
- "$ref": "PlacementStrategy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.placementStrategies.list",
- "path": "userprofiles/{profileId}/placementStrategies",
- "httpMethod": "GET",
- "description": "Retrieves a list of placement strategies, possibly filtered.",
- "parameters": {
- "ids": {
- "type": "string",
- "description": "Select only placement strategies with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"placementstrategy*2015\" will return objects with names like \"placementstrategy June 2015\", \"placementstrategy April 2015\", or simply \"placementstrategy 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placementstrategy\" will match objects with name \"my placementstrategy\", \"placementstrategy 2015\", or simply \"placementstrategy\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "PlacementStrategiesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.placementStrategies.patch",
- "path": "userprofiles/{profileId}/placementStrategies",
- "httpMethod": "PATCH",
- "description": "Updates an existing placement strategy. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Placement strategy ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "PlacementStrategy"
- },
- "response": {
- "$ref": "PlacementStrategy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.placementStrategies.update",
- "path": "userprofiles/{profileId}/placementStrategies",
- "httpMethod": "PUT",
- "description": "Updates an existing placement strategy.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "PlacementStrategy"
- },
- "response": {
- "$ref": "PlacementStrategy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "placements": {
- "methods": {
- "generatetags": {
- "id": "dfareporting.placements.generatetags",
- "path": "userprofiles/{profileId}/placements/generatetags",
- "httpMethod": "POST",
- "description": "Generates tags for a placement.",
- "parameters": {
- "campaignId": {
- "type": "string",
- "description": "Generate placements belonging to this campaign. This is a required field.",
- "format": "int64",
- "location": "query"
- },
- "placementIds": {
- "type": "string",
- "description": "Generate tags for these placements.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "tagFormats": {
- "type": "string",
- "description": "Tag formats to generate for these placements.",
- "enum": [
- "PLACEMENT_TAG_CLICK_COMMANDS",
- "PLACEMENT_TAG_IFRAME_ILAYER",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
- "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
- "PLACEMENT_TAG_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT",
- "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_JAVASCRIPT",
- "PLACEMENT_TAG_JAVASCRIPT_LEGACY",
- "PLACEMENT_TAG_STANDARD",
- "PLACEMENT_TAG_TRACKING",
- "PLACEMENT_TAG_TRACKING_IFRAME",
- "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "PlacementsGenerateTagsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.placements.get",
- "path": "userprofiles/{profileId}/placements/{id}",
- "httpMethod": "GET",
- "description": "Gets one placement by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Placement ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Placement"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.placements.insert",
- "path": "userprofiles/{profileId}/placements",
- "httpMethod": "POST",
- "description": "Inserts a new placement.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Placement"
- },
- "response": {
- "$ref": "Placement"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.placements.list",
- "path": "userprofiles/{profileId}/placements",
- "httpMethod": "GET",
- "description": "Retrieves a list of placements, possibly filtered.",
- "parameters": {
- "advertiserIds": {
- "type": "string",
- "description": "Select only placements that belong to these advertisers.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "archived": {
- "type": "boolean",
- "description": "Select only archived placements. Don't set this field to select both archived and non-archived placements.",
- "location": "query"
- },
- "campaignIds": {
- "type": "string",
- "description": "Select only placements that belong to these campaigns.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "compatibilities": {
- "type": "string",
- "description": "Select only placements that are associated with these compatibilities. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.",
- "enum": [
- "APP",
- "APP_INTERSTITIAL",
- "IN_STREAM_VIDEO",
- "WEB",
- "WEB_INTERSTITIAL"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- },
- "contentCategoryIds": {
- "type": "string",
- "description": "Select only placements that are associated with these content categories.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "directorySiteIds": {
- "type": "string",
- "description": "Select only placements that are associated with these directory sites.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "groupIds": {
- "type": "string",
- "description": "Select only placements that belong to these placement groups.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only placements with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxEndDate": {
- "type": "string",
- "description": "Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as \"yyyy-MM-dd\".",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "maxStartDate": {
- "type": "string",
- "description": "Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as \"yyyy-MM-dd\".",
- "location": "query"
- },
- "minEndDate": {
- "type": "string",
- "description": "Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as \"yyyy-MM-dd\".",
- "location": "query"
- },
- "minStartDate": {
- "type": "string",
- "description": "Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as \"yyyy-MM-dd\".",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "paymentSource": {
- "type": "string",
- "description": "Select only placements with this payment source.",
- "enum": [
- "PLACEMENT_AGENCY_PAID",
- "PLACEMENT_PUBLISHER_PAID"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "placementStrategyIds": {
- "type": "string",
- "description": "Select only placements that are associated with these placement strategies.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "pricingTypes": {
- "type": "string",
- "description": "Select only placements with these pricing types.",
- "enum": [
- "PRICING_TYPE_CPA",
- "PRICING_TYPE_CPC",
- "PRICING_TYPE_CPM",
- "PRICING_TYPE_FLAT_RATE_CLICKS",
- "PRICING_TYPE_FLAT_RATE_IMPRESSIONS"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ],
- "repeated": true,
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, \"placement*2015\" will return placements with names like \"placement June 2015\", \"placement May 2015\", or simply \"placements 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"placement\" will match placements with name \"my placement\", \"placement 2015\", or simply \"placement\".",
- "location": "query"
- },
- "siteIds": {
- "type": "string",
- "description": "Select only placements that are associated with these sites.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "sizeIds": {
- "type": "string",
- "description": "Select only placements that are associated with these sizes.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "PlacementsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.placements.patch",
- "path": "userprofiles/{profileId}/placements",
- "httpMethod": "PATCH",
- "description": "Updates an existing placement. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Placement ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "Placement"
- },
- "response": {
- "$ref": "Placement"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.placements.update",
- "path": "userprofiles/{profileId}/placements",
- "httpMethod": "PUT",
- "description": "Updates an existing placement.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Placement"
- },
- "response": {
- "$ref": "Placement"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "platformTypes": {
- "methods": {
- "get": {
- "id": "dfareporting.platformTypes.get",
- "path": "userprofiles/{profileId}/platformTypes/{id}",
- "httpMethod": "GET",
- "description": "Gets one platform type by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Platform type ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "PlatformType"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.platformTypes.list",
- "path": "userprofiles/{profileId}/platformTypes",
- "httpMethod": "GET",
- "description": "Retrieves a list of platform types.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "PlatformTypesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "postalCodes": {
- "methods": {
- "get": {
- "id": "dfareporting.postalCodes.get",
- "path": "userprofiles/{profileId}/postalCodes/{code}",
- "httpMethod": "GET",
- "description": "Gets one postal code by ID.",
- "parameters": {
- "code": {
- "type": "string",
- "description": "Postal code ID.",
- "required": true,
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "code"
- ],
- "response": {
- "$ref": "PostalCode"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.postalCodes.list",
- "path": "userprofiles/{profileId}/postalCodes",
- "httpMethod": "GET",
- "description": "Retrieves a list of postal codes.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "PostalCodesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "projects": {
- "methods": {
- "get": {
- "id": "dfareporting.projects.get",
- "path": "userprofiles/{profileId}/projects/{id}",
- "httpMethod": "GET",
- "description": "Gets one project by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Project ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Project"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.projects.list",
- "path": "userprofiles/{profileId}/projects",
- "httpMethod": "GET",
- "description": "Retrieves a list of projects, possibly filtered.",
- "parameters": {
- "advertiserIds": {
- "type": "string",
- "description": "Select only projects with these advertiser IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only projects with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, \"project*2015\" will return projects with names like \"project June 2015\", \"project April 2015\", or simply \"project 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"project\" will match projects with name \"my project\", \"project 2015\", or simply \"project\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "ProjectsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "regions": {
- "methods": {
- "list": {
- "id": "dfareporting.regions.list",
- "path": "userprofiles/{profileId}/regions",
- "httpMethod": "GET",
- "description": "Retrieves a list of regions.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "RegionsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "remarketingListShares": {
- "methods": {
- "get": {
- "id": "dfareporting.remarketingListShares.get",
- "path": "userprofiles/{profileId}/remarketingListShares/{remarketingListId}",
- "httpMethod": "GET",
- "description": "Gets one remarketing list share by remarketing list ID.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "remarketingListId": {
- "type": "string",
- "description": "Remarketing list ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "remarketingListId"
- ],
- "response": {
- "$ref": "RemarketingListShare"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.remarketingListShares.patch",
- "path": "userprofiles/{profileId}/remarketingListShares",
- "httpMethod": "PATCH",
- "description": "Updates an existing remarketing list share. This method supports patch semantics.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "remarketingListId": {
- "type": "string",
- "description": "Remarketing list ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "remarketingListId"
- ],
- "request": {
- "$ref": "RemarketingListShare"
- },
- "response": {
- "$ref": "RemarketingListShare"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.remarketingListShares.update",
- "path": "userprofiles/{profileId}/remarketingListShares",
- "httpMethod": "PUT",
- "description": "Updates an existing remarketing list share.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "RemarketingListShare"
- },
- "response": {
- "$ref": "RemarketingListShare"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "remarketingLists": {
- "methods": {
- "get": {
- "id": "dfareporting.remarketingLists.get",
- "path": "userprofiles/{profileId}/remarketingLists/{id}",
- "httpMethod": "GET",
- "description": "Gets one remarketing list by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Remarketing list ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "RemarketingList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.remarketingLists.insert",
- "path": "userprofiles/{profileId}/remarketingLists",
- "httpMethod": "POST",
- "description": "Inserts a new remarketing list.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "RemarketingList"
- },
- "response": {
- "$ref": "RemarketingList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.remarketingLists.list",
- "path": "userprofiles/{profileId}/remarketingLists",
- "httpMethod": "GET",
- "description": "Retrieves a list of remarketing lists, possibly filtered.",
- "parameters": {
- "active": {
- "type": "boolean",
- "description": "Select only active or only inactive remarketing lists.",
- "location": "query"
- },
- "advertiserId": {
- "type": "string",
- "description": "Select only remarketing lists owned by this advertiser.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "floodlightActivityId": {
- "type": "string",
- "description": "Select only remarketing lists that have this floodlight activity ID.",
- "format": "int64",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "name": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"remarketing list*2015\" will return objects with names like \"remarketing list June 2015\", \"remarketing list April 2015\", or simply \"remarketing list 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"remarketing list\" will match objects with name \"my remarketing list\", \"remarketing list 2015\", or simply \"remarketing list\".",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "advertiserId"
- ],
- "response": {
- "$ref": "RemarketingListsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.remarketingLists.patch",
- "path": "userprofiles/{profileId}/remarketingLists",
- "httpMethod": "PATCH",
- "description": "Updates an existing remarketing list. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Remarketing list ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "RemarketingList"
- },
- "response": {
- "$ref": "RemarketingList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.remarketingLists.update",
- "path": "userprofiles/{profileId}/remarketingLists",
- "httpMethod": "PUT",
- "description": "Updates an existing remarketing list.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "RemarketingList"
- },
- "response": {
- "$ref": "RemarketingList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "reports": {
- "methods": {
- "delete": {
- "id": "dfareporting.reports.delete",
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "DELETE",
- "description": "Deletes a report by its ID.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "get": {
- "id": "dfareporting.reports.get",
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "GET",
- "description": "Retrieves a report by its ID.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "insert": {
- "id": "dfareporting.reports.insert",
- "path": "userprofiles/{profileId}/reports",
- "httpMethod": "POST",
- "description": "Creates a report.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "list": {
- "id": "dfareporting.reports.list",
- "path": "userprofiles/{profileId}/reports",
- "httpMethod": "GET",
- "description": "Retrieves list of reports.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "scope": {
- "type": "string",
- "description": "The scope that defines which results are returned, default is 'MINE'.",
- "default": "MINE",
- "enum": [
- "ALL",
- "MINE"
- ],
- "enumDescriptions": [
- "All reports in account.",
- "My reports."
- ],
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "The field by which to sort the list.",
- "default": "LAST_MODIFIED_TIME",
- "enum": [
- "ID",
- "LAST_MODIFIED_TIME",
- "NAME"
- ],
- "enumDescriptions": [
- "Sort by report ID.",
- "Sort by 'lastModifiedTime' field.",
- "Sort by name of reports."
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is 'DESCENDING'.",
- "default": "DESCENDING",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "ReportList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "patch": {
- "id": "dfareporting.reports.patch",
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "PATCH",
- "description": "Updates a report. This method supports patch semantics.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "run": {
- "id": "dfareporting.reports.run",
- "path": "userprofiles/{profileId}/reports/{reportId}/run",
- "httpMethod": "POST",
- "description": "Runs a report.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "synchronous": {
- "type": "boolean",
- "description": "If set and true, tries to run the report synchronously.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "response": {
- "$ref": "File"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- },
- "update": {
- "id": "dfareporting.reports.update",
- "path": "userprofiles/{profileId}/reports/{reportId}",
- "httpMethod": "PUT",
- "description": "Updates a report.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- },
- "resources": {
- "compatibleFields": {
- "methods": {
- "query": {
- "id": "dfareporting.reports.compatibleFields.query",
- "path": "userprofiles/{profileId}/reports/compatiblefields/query",
- "httpMethod": "POST",
- "description": "Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The DFA user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Report"
- },
- "response": {
- "$ref": "CompatibleFields"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- },
- "files": {
- "methods": {
- "get": {
- "id": "dfareporting.reports.files.get",
- "path": "userprofiles/{profileId}/reports/{reportId}/files/{fileId}",
- "httpMethod": "GET",
- "description": "Retrieves a report file.",
- "parameters": {
- "fileId": {
- "type": "string",
- "description": "The ID of the report file.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the report.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId",
- "fileId"
- ],
- "response": {
- "$ref": "File"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ],
- "supportsMediaDownload": true
- },
- "list": {
- "id": "dfareporting.reports.files.list",
- "path": "userprofiles/{profileId}/reports/{reportId}/files",
- "httpMethod": "GET",
- "description": "Lists files for a report.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "minimum": "0",
- "maximum": "10",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The value of the nextToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "The DFA profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "reportId": {
- "type": "string",
- "description": "The ID of the parent report.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "sortField": {
- "type": "string",
- "description": "The field by which to sort the list.",
- "default": "LAST_MODIFIED_TIME",
- "enum": [
- "ID",
- "LAST_MODIFIED_TIME"
- ],
- "enumDescriptions": [
- "Sort by file ID.",
- "Sort by 'lastmodifiedAt' field."
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is 'DESCENDING'.",
- "default": "DESCENDING",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Ascending order.",
- "Descending order."
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "reportId"
- ],
- "response": {
- "$ref": "FileList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting"
- ]
- }
- }
- }
- }
- },
- "sites": {
- "methods": {
- "get": {
- "id": "dfareporting.sites.get",
- "path": "userprofiles/{profileId}/sites/{id}",
- "httpMethod": "GET",
- "description": "Gets one site by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Site ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Site"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.sites.insert",
- "path": "userprofiles/{profileId}/sites",
- "httpMethod": "POST",
- "description": "Inserts a new site.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Site"
- },
- "response": {
- "$ref": "Site"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.sites.list",
- "path": "userprofiles/{profileId}/sites",
- "httpMethod": "GET",
- "description": "Retrieves a list of sites, possibly filtered.",
- "parameters": {
- "acceptsInStreamVideoPlacements": {
- "type": "boolean",
- "description": "This search filter is no longer supported and will have no effect on the results returned.",
- "location": "query"
- },
- "acceptsInterstitialPlacements": {
- "type": "boolean",
- "description": "This search filter is no longer supported and will have no effect on the results returned.",
- "location": "query"
- },
- "acceptsPublisherPaidPlacements": {
- "type": "boolean",
- "description": "Select only sites that accept publisher paid placements.",
- "location": "query"
- },
- "adWordsSite": {
- "type": "boolean",
- "description": "Select only AdWords sites.",
- "location": "query"
- },
- "approved": {
- "type": "boolean",
- "description": "Select only approved sites.",
- "location": "query"
- },
- "campaignIds": {
- "type": "string",
- "description": "Select only sites with these campaign IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "directorySiteIds": {
- "type": "string",
- "description": "Select only sites with these directory site IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only sites with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, \"site*2015\" will return objects with names like \"site June 2015\", \"site April 2015\", or simply \"site 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"site\" will match objects with name \"my site\", \"site 2015\", or simply \"site\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "subaccountId": {
- "type": "string",
- "description": "Select only sites with this subaccount ID.",
- "format": "int64",
- "location": "query"
- },
- "unmappedSite": {
- "type": "boolean",
- "description": "Select only sites that have not been mapped to a directory site.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "SitesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.sites.patch",
- "path": "userprofiles/{profileId}/sites",
- "httpMethod": "PATCH",
- "description": "Updates an existing site. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Site ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "Site"
- },
- "response": {
- "$ref": "Site"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.sites.update",
- "path": "userprofiles/{profileId}/sites",
- "httpMethod": "PUT",
- "description": "Updates an existing site.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Site"
- },
- "response": {
- "$ref": "Site"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "sizes": {
- "methods": {
- "get": {
- "id": "dfareporting.sizes.get",
- "path": "userprofiles/{profileId}/sizes/{id}",
- "httpMethod": "GET",
- "description": "Gets one size by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Size ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Size"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.sizes.insert",
- "path": "userprofiles/{profileId}/sizes",
- "httpMethod": "POST",
- "description": "Inserts a new size.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Size"
- },
- "response": {
- "$ref": "Size"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.sizes.list",
- "path": "userprofiles/{profileId}/sizes",
- "httpMethod": "GET",
- "description": "Retrieves a list of sizes, possibly filtered.",
- "parameters": {
- "height": {
- "type": "integer",
- "description": "Select only sizes with this height.",
- "format": "int32",
- "location": "query"
- },
- "iabStandard": {
- "type": "boolean",
- "description": "Select only IAB standard sizes.",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only sizes with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "width": {
- "type": "integer",
- "description": "Select only sizes with this width.",
- "format": "int32",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "SizesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "subaccounts": {
- "methods": {
- "get": {
- "id": "dfareporting.subaccounts.get",
- "path": "userprofiles/{profileId}/subaccounts/{id}",
- "httpMethod": "GET",
- "description": "Gets one subaccount by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Subaccount ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "Subaccount"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.subaccounts.insert",
- "path": "userprofiles/{profileId}/subaccounts",
- "httpMethod": "POST",
- "description": "Inserts a new subaccount.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Subaccount"
- },
- "response": {
- "$ref": "Subaccount"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.subaccounts.list",
- "path": "userprofiles/{profileId}/subaccounts",
- "httpMethod": "GET",
- "description": "Gets a list of subaccounts, possibly filtered.",
- "parameters": {
- "ids": {
- "type": "string",
- "description": "Select only subaccounts with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"subaccount*2015\" will return objects with names like \"subaccount June 2015\", \"subaccount April 2015\", or simply \"subaccount 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"subaccount\" will match objects with name \"my subaccount\", \"subaccount 2015\", or simply \"subaccount\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "SubaccountsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.subaccounts.patch",
- "path": "userprofiles/{profileId}/subaccounts",
- "httpMethod": "PATCH",
- "description": "Updates an existing subaccount. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Subaccount ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "Subaccount"
- },
- "response": {
- "$ref": "Subaccount"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.subaccounts.update",
- "path": "userprofiles/{profileId}/subaccounts",
- "httpMethod": "PUT",
- "description": "Updates an existing subaccount.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "Subaccount"
- },
- "response": {
- "$ref": "Subaccount"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "targetableRemarketingLists": {
- "methods": {
- "get": {
- "id": "dfareporting.targetableRemarketingLists.get",
- "path": "userprofiles/{profileId}/targetableRemarketingLists/{id}",
- "httpMethod": "GET",
- "description": "Gets one remarketing list by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "Remarketing list ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "TargetableRemarketingList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.targetableRemarketingLists.list",
- "path": "userprofiles/{profileId}/targetableRemarketingLists",
- "httpMethod": "GET",
- "description": "Retrieves a list of targetable remarketing lists, possibly filtered.",
- "parameters": {
- "active": {
- "type": "boolean",
- "description": "Select only active or only inactive targetable remarketing lists.",
- "location": "query"
- },
- "advertiserId": {
- "type": "string",
- "description": "Select only targetable remarketing lists targetable by these advertisers.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "name": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"remarketing list*2015\" will return objects with names like \"remarketing list June 2015\", \"remarketing list April 2015\", or simply \"remarketing list 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"remarketing list\" will match objects with name \"my remarketing list\", \"remarketing list 2015\", or simply \"remarketing list\".",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId",
- "advertiserId"
- ],
- "response": {
- "$ref": "TargetableRemarketingListsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "userProfiles": {
- "methods": {
- "get": {
- "id": "dfareporting.userProfiles.get",
- "path": "userprofiles/{profileId}",
- "httpMethod": "GET",
- "description": "Gets one user profile by ID.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "The user profile ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "UserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting",
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.userProfiles.list",
- "path": "userprofiles",
- "httpMethod": "GET",
- "description": "Retrieves list of user profiles for a user.",
- "response": {
- "$ref": "UserProfileList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfareporting",
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "userRolePermissionGroups": {
- "methods": {
- "get": {
- "id": "dfareporting.userRolePermissionGroups.get",
- "path": "userprofiles/{profileId}/userRolePermissionGroups/{id}",
- "httpMethod": "GET",
- "description": "Gets one user role permission group by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "User role permission group ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "UserRolePermissionGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.userRolePermissionGroups.list",
- "path": "userprofiles/{profileId}/userRolePermissionGroups",
- "httpMethod": "GET",
- "description": "Gets a list of all supported user role permission groups.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "UserRolePermissionGroupsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "userRolePermissions": {
- "methods": {
- "get": {
- "id": "dfareporting.userRolePermissions.get",
- "path": "userprofiles/{profileId}/userRolePermissions/{id}",
- "httpMethod": "GET",
- "description": "Gets one user role permission by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "User role permission ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "UserRolePermission"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.userRolePermissions.list",
- "path": "userprofiles/{profileId}/userRolePermissions",
- "httpMethod": "GET",
- "description": "Gets a list of user role permissions, possibly filtered.",
- "parameters": {
- "ids": {
- "type": "string",
- "description": "Select only user role permissions with these IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "UserRolePermissionsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- },
- "userRoles": {
- "methods": {
- "delete": {
- "id": "dfareporting.userRoles.delete",
- "path": "userprofiles/{profileId}/userRoles/{id}",
- "httpMethod": "DELETE",
- "description": "Deletes an existing user role.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "User role ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "get": {
- "id": "dfareporting.userRoles.get",
- "path": "userprofiles/{profileId}/userRoles/{id}",
- "httpMethod": "GET",
- "description": "Gets one user role by ID.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "User role ID.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "response": {
- "$ref": "UserRole"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "insert": {
- "id": "dfareporting.userRoles.insert",
- "path": "userprofiles/{profileId}/userRoles",
- "httpMethod": "POST",
- "description": "Inserts a new user role.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "UserRole"
- },
- "response": {
- "$ref": "UserRole"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "list": {
- "id": "dfareporting.userRoles.list",
- "path": "userprofiles/{profileId}/userRoles",
- "httpMethod": "GET",
- "description": "Retrieves a list of user roles, possibly filtered.",
- "parameters": {
- "accountUserRoleOnly": {
- "type": "boolean",
- "description": "Select only account level user roles not associated with any specific subaccount.",
- "location": "query"
- },
- "ids": {
- "type": "string",
- "description": "Select only user roles with the specified IDs.",
- "format": "int64",
- "repeated": true,
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of results to return.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Value of the nextPageToken from the previous result page.",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- },
- "searchString": {
- "type": "string",
- "description": "Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, \"userrole*2015\" will return objects with names like \"userrole June 2015\", \"userrole April 2015\", or simply \"userrole 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"userrole\" will match objects with name \"my userrole\", \"userrole 2015\", or simply \"userrole\".",
- "location": "query"
- },
- "sortField": {
- "type": "string",
- "description": "Field by which to sort the list.",
- "enum": [
- "ID",
- "NAME"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "sortOrder": {
- "type": "string",
- "description": "Order of sorted results, default is ASCENDING.",
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "",
- ""
- ],
- "location": "query"
- },
- "subaccountId": {
- "type": "string",
- "description": "Select only user roles that belong to this subaccount.",
- "format": "int64",
- "location": "query"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "response": {
- "$ref": "UserRolesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "patch": {
- "id": "dfareporting.userRoles.patch",
- "path": "userprofiles/{profileId}/userRoles",
- "httpMethod": "PATCH",
- "description": "Updates an existing user role. This method supports patch semantics.",
- "parameters": {
- "id": {
- "type": "string",
- "description": "User role ID.",
- "required": true,
- "format": "int64",
- "location": "query"
- },
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId",
- "id"
- ],
- "request": {
- "$ref": "UserRole"
- },
- "response": {
- "$ref": "UserRole"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- },
- "update": {
- "id": "dfareporting.userRoles.update",
- "path": "userprofiles/{profileId}/userRoles",
- "httpMethod": "PUT",
- "description": "Updates an existing user role.",
- "parameters": {
- "profileId": {
- "type": "string",
- "description": "User profile ID associated with this request.",
- "required": true,
- "format": "int64",
- "location": "path"
- }
- },
- "parameterOrder": [
- "profileId"
- ],
- "request": {
- "$ref": "UserRole"
- },
- "response": {
- "$ref": "UserRole"
- },
- "scopes": [
- "https://www.googleapis.com/auth/dfatrafficking"
- ]
- }
- }
- }
- }
-}
diff --git a/vendor/google.golang.org/api/dfareporting/v2.2/dfareporting-gen.go b/vendor/google.golang.org/api/dfareporting/v2.2/dfareporting-gen.go
deleted file mode 100644
index 314b0a7c..00000000
--- a/vendor/google.golang.org/api/dfareporting/v2.2/dfareporting-gen.go
+++ /dev/null
@@ -1,42571 +0,0 @@
-// Package dfareporting provides access to the DCM/DFA Reporting And Trafficking API.
-//
-// See https://developers.google.com/doubleclick-advertisers/reporting/
-//
-// Usage example:
-//
-// import "google.golang.org/api/dfareporting/v2.2"
-// ...
-// dfareportingService, err := dfareporting.New(oauthHttpClient)
-package dfareporting // import "google.golang.org/api/dfareporting/v2.2"
-
-import (
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "golang.org/x/net/context"
- "golang.org/x/net/context/ctxhttp"
- "google.golang.org/api/googleapi"
- "google.golang.org/api/internal"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-)
-
-// Always reference these packages, just in case the auto-generated code
-// below doesn't.
-var _ = bytes.NewBuffer
-var _ = strconv.Itoa
-var _ = fmt.Sprintf
-var _ = json.NewDecoder
-var _ = io.Copy
-var _ = url.Parse
-var _ = googleapi.Version
-var _ = errors.New
-var _ = strings.Replace
-var _ = internal.MarshalJSON
-var _ = context.Canceled
-var _ = ctxhttp.Do
-
-const apiId = "dfareporting:v2.2"
-const apiName = "dfareporting"
-const apiVersion = "v2.2"
-const basePath = "https://www.googleapis.com/dfareporting/v2.2/"
-
-// OAuth2 scopes used by this API.
-const (
- // View and manage DoubleClick for Advertisers reports
- DfareportingScope = "https://www.googleapis.com/auth/dfareporting"
-
- // View and manage your DoubleClick Campaign Manager's (DCM) display ad
- // campaigns
- DfatraffickingScope = "https://www.googleapis.com/auth/dfatrafficking"
-)
-
-func New(client *http.Client) (*Service, error) {
- if client == nil {
- return nil, errors.New("client is nil")
- }
- s := &Service{client: client, BasePath: basePath}
- s.AccountActiveAdSummaries = NewAccountActiveAdSummariesService(s)
- s.AccountPermissionGroups = NewAccountPermissionGroupsService(s)
- s.AccountPermissions = NewAccountPermissionsService(s)
- s.AccountUserProfiles = NewAccountUserProfilesService(s)
- s.Accounts = NewAccountsService(s)
- s.Ads = NewAdsService(s)
- s.AdvertiserGroups = NewAdvertiserGroupsService(s)
- s.Advertisers = NewAdvertisersService(s)
- s.Browsers = NewBrowsersService(s)
- s.CampaignCreativeAssociations = NewCampaignCreativeAssociationsService(s)
- s.Campaigns = NewCampaignsService(s)
- s.ChangeLogs = NewChangeLogsService(s)
- s.Cities = NewCitiesService(s)
- s.ConnectionTypes = NewConnectionTypesService(s)
- s.ContentCategories = NewContentCategoriesService(s)
- s.Countries = NewCountriesService(s)
- s.CreativeAssets = NewCreativeAssetsService(s)
- s.CreativeFieldValues = NewCreativeFieldValuesService(s)
- s.CreativeFields = NewCreativeFieldsService(s)
- s.CreativeGroups = NewCreativeGroupsService(s)
- s.Creatives = NewCreativesService(s)
- s.DimensionValues = NewDimensionValuesService(s)
- s.DirectorySiteContacts = NewDirectorySiteContactsService(s)
- s.DirectorySites = NewDirectorySitesService(s)
- s.EventTags = NewEventTagsService(s)
- s.Files = NewFilesService(s)
- s.FloodlightActivities = NewFloodlightActivitiesService(s)
- s.FloodlightActivityGroups = NewFloodlightActivityGroupsService(s)
- s.FloodlightConfigurations = NewFloodlightConfigurationsService(s)
- s.InventoryItems = NewInventoryItemsService(s)
- s.LandingPages = NewLandingPagesService(s)
- s.Metros = NewMetrosService(s)
- s.MobileCarriers = NewMobileCarriersService(s)
- s.OperatingSystemVersions = NewOperatingSystemVersionsService(s)
- s.OperatingSystems = NewOperatingSystemsService(s)
- s.OrderDocuments = NewOrderDocumentsService(s)
- s.Orders = NewOrdersService(s)
- s.PlacementGroups = NewPlacementGroupsService(s)
- s.PlacementStrategies = NewPlacementStrategiesService(s)
- s.Placements = NewPlacementsService(s)
- s.PlatformTypes = NewPlatformTypesService(s)
- s.PostalCodes = NewPostalCodesService(s)
- s.Projects = NewProjectsService(s)
- s.Regions = NewRegionsService(s)
- s.RemarketingListShares = NewRemarketingListSharesService(s)
- s.RemarketingLists = NewRemarketingListsService(s)
- s.Reports = NewReportsService(s)
- s.Sites = NewSitesService(s)
- s.Sizes = NewSizesService(s)
- s.Subaccounts = NewSubaccountsService(s)
- s.TargetableRemarketingLists = NewTargetableRemarketingListsService(s)
- s.UserProfiles = NewUserProfilesService(s)
- s.UserRolePermissionGroups = NewUserRolePermissionGroupsService(s)
- s.UserRolePermissions = NewUserRolePermissionsService(s)
- s.UserRoles = NewUserRolesService(s)
- return s, nil
-}
-
-type Service struct {
- client *http.Client
- BasePath string // API endpoint base URL
- UserAgent string // optional additional User-Agent fragment
-
- AccountActiveAdSummaries *AccountActiveAdSummariesService
-
- AccountPermissionGroups *AccountPermissionGroupsService
-
- AccountPermissions *AccountPermissionsService
-
- AccountUserProfiles *AccountUserProfilesService
-
- Accounts *AccountsService
-
- Ads *AdsService
-
- AdvertiserGroups *AdvertiserGroupsService
-
- Advertisers *AdvertisersService
-
- Browsers *BrowsersService
-
- CampaignCreativeAssociations *CampaignCreativeAssociationsService
-
- Campaigns *CampaignsService
-
- ChangeLogs *ChangeLogsService
-
- Cities *CitiesService
-
- ConnectionTypes *ConnectionTypesService
-
- ContentCategories *ContentCategoriesService
-
- Countries *CountriesService
-
- CreativeAssets *CreativeAssetsService
-
- CreativeFieldValues *CreativeFieldValuesService
-
- CreativeFields *CreativeFieldsService
-
- CreativeGroups *CreativeGroupsService
-
- Creatives *CreativesService
-
- DimensionValues *DimensionValuesService
-
- DirectorySiteContacts *DirectorySiteContactsService
-
- DirectorySites *DirectorySitesService
-
- EventTags *EventTagsService
-
- Files *FilesService
-
- FloodlightActivities *FloodlightActivitiesService
-
- FloodlightActivityGroups *FloodlightActivityGroupsService
-
- FloodlightConfigurations *FloodlightConfigurationsService
-
- InventoryItems *InventoryItemsService
-
- LandingPages *LandingPagesService
-
- Metros *MetrosService
-
- MobileCarriers *MobileCarriersService
-
- OperatingSystemVersions *OperatingSystemVersionsService
-
- OperatingSystems *OperatingSystemsService
-
- OrderDocuments *OrderDocumentsService
-
- Orders *OrdersService
-
- PlacementGroups *PlacementGroupsService
-
- PlacementStrategies *PlacementStrategiesService
-
- Placements *PlacementsService
-
- PlatformTypes *PlatformTypesService
-
- PostalCodes *PostalCodesService
-
- Projects *ProjectsService
-
- Regions *RegionsService
-
- RemarketingListShares *RemarketingListSharesService
-
- RemarketingLists *RemarketingListsService
-
- Reports *ReportsService
-
- Sites *SitesService
-
- Sizes *SizesService
-
- Subaccounts *SubaccountsService
-
- TargetableRemarketingLists *TargetableRemarketingListsService
-
- UserProfiles *UserProfilesService
-
- UserRolePermissionGroups *UserRolePermissionGroupsService
-
- UserRolePermissions *UserRolePermissionsService
-
- UserRoles *UserRolesService
-}
-
-func (s *Service) userAgent() string {
- if s.UserAgent == "" {
- return googleapi.UserAgent
- }
- return googleapi.UserAgent + " " + s.UserAgent
-}
-
-func NewAccountActiveAdSummariesService(s *Service) *AccountActiveAdSummariesService {
- rs := &AccountActiveAdSummariesService{s: s}
- return rs
-}
-
-type AccountActiveAdSummariesService struct {
- s *Service
-}
-
-func NewAccountPermissionGroupsService(s *Service) *AccountPermissionGroupsService {
- rs := &AccountPermissionGroupsService{s: s}
- return rs
-}
-
-type AccountPermissionGroupsService struct {
- s *Service
-}
-
-func NewAccountPermissionsService(s *Service) *AccountPermissionsService {
- rs := &AccountPermissionsService{s: s}
- return rs
-}
-
-type AccountPermissionsService struct {
- s *Service
-}
-
-func NewAccountUserProfilesService(s *Service) *AccountUserProfilesService {
- rs := &AccountUserProfilesService{s: s}
- return rs
-}
-
-type AccountUserProfilesService struct {
- s *Service
-}
-
-func NewAccountsService(s *Service) *AccountsService {
- rs := &AccountsService{s: s}
- return rs
-}
-
-type AccountsService struct {
- s *Service
-}
-
-func NewAdsService(s *Service) *AdsService {
- rs := &AdsService{s: s}
- return rs
-}
-
-type AdsService struct {
- s *Service
-}
-
-func NewAdvertiserGroupsService(s *Service) *AdvertiserGroupsService {
- rs := &AdvertiserGroupsService{s: s}
- return rs
-}
-
-type AdvertiserGroupsService struct {
- s *Service
-}
-
-func NewAdvertisersService(s *Service) *AdvertisersService {
- rs := &AdvertisersService{s: s}
- return rs
-}
-
-type AdvertisersService struct {
- s *Service
-}
-
-func NewBrowsersService(s *Service) *BrowsersService {
- rs := &BrowsersService{s: s}
- return rs
-}
-
-type BrowsersService struct {
- s *Service
-}
-
-func NewCampaignCreativeAssociationsService(s *Service) *CampaignCreativeAssociationsService {
- rs := &CampaignCreativeAssociationsService{s: s}
- return rs
-}
-
-type CampaignCreativeAssociationsService struct {
- s *Service
-}
-
-func NewCampaignsService(s *Service) *CampaignsService {
- rs := &CampaignsService{s: s}
- return rs
-}
-
-type CampaignsService struct {
- s *Service
-}
-
-func NewChangeLogsService(s *Service) *ChangeLogsService {
- rs := &ChangeLogsService{s: s}
- return rs
-}
-
-type ChangeLogsService struct {
- s *Service
-}
-
-func NewCitiesService(s *Service) *CitiesService {
- rs := &CitiesService{s: s}
- return rs
-}
-
-type CitiesService struct {
- s *Service
-}
-
-func NewConnectionTypesService(s *Service) *ConnectionTypesService {
- rs := &ConnectionTypesService{s: s}
- return rs
-}
-
-type ConnectionTypesService struct {
- s *Service
-}
-
-func NewContentCategoriesService(s *Service) *ContentCategoriesService {
- rs := &ContentCategoriesService{s: s}
- return rs
-}
-
-type ContentCategoriesService struct {
- s *Service
-}
-
-func NewCountriesService(s *Service) *CountriesService {
- rs := &CountriesService{s: s}
- return rs
-}
-
-type CountriesService struct {
- s *Service
-}
-
-func NewCreativeAssetsService(s *Service) *CreativeAssetsService {
- rs := &CreativeAssetsService{s: s}
- return rs
-}
-
-type CreativeAssetsService struct {
- s *Service
-}
-
-func NewCreativeFieldValuesService(s *Service) *CreativeFieldValuesService {
- rs := &CreativeFieldValuesService{s: s}
- return rs
-}
-
-type CreativeFieldValuesService struct {
- s *Service
-}
-
-func NewCreativeFieldsService(s *Service) *CreativeFieldsService {
- rs := &CreativeFieldsService{s: s}
- return rs
-}
-
-type CreativeFieldsService struct {
- s *Service
-}
-
-func NewCreativeGroupsService(s *Service) *CreativeGroupsService {
- rs := &CreativeGroupsService{s: s}
- return rs
-}
-
-type CreativeGroupsService struct {
- s *Service
-}
-
-func NewCreativesService(s *Service) *CreativesService {
- rs := &CreativesService{s: s}
- return rs
-}
-
-type CreativesService struct {
- s *Service
-}
-
-func NewDimensionValuesService(s *Service) *DimensionValuesService {
- rs := &DimensionValuesService{s: s}
- return rs
-}
-
-type DimensionValuesService struct {
- s *Service
-}
-
-func NewDirectorySiteContactsService(s *Service) *DirectorySiteContactsService {
- rs := &DirectorySiteContactsService{s: s}
- return rs
-}
-
-type DirectorySiteContactsService struct {
- s *Service
-}
-
-func NewDirectorySitesService(s *Service) *DirectorySitesService {
- rs := &DirectorySitesService{s: s}
- return rs
-}
-
-type DirectorySitesService struct {
- s *Service
-}
-
-func NewEventTagsService(s *Service) *EventTagsService {
- rs := &EventTagsService{s: s}
- return rs
-}
-
-type EventTagsService struct {
- s *Service
-}
-
-func NewFilesService(s *Service) *FilesService {
- rs := &FilesService{s: s}
- return rs
-}
-
-type FilesService struct {
- s *Service
-}
-
-func NewFloodlightActivitiesService(s *Service) *FloodlightActivitiesService {
- rs := &FloodlightActivitiesService{s: s}
- return rs
-}
-
-type FloodlightActivitiesService struct {
- s *Service
-}
-
-func NewFloodlightActivityGroupsService(s *Service) *FloodlightActivityGroupsService {
- rs := &FloodlightActivityGroupsService{s: s}
- return rs
-}
-
-type FloodlightActivityGroupsService struct {
- s *Service
-}
-
-func NewFloodlightConfigurationsService(s *Service) *FloodlightConfigurationsService {
- rs := &FloodlightConfigurationsService{s: s}
- return rs
-}
-
-type FloodlightConfigurationsService struct {
- s *Service
-}
-
-func NewInventoryItemsService(s *Service) *InventoryItemsService {
- rs := &InventoryItemsService{s: s}
- return rs
-}
-
-type InventoryItemsService struct {
- s *Service
-}
-
-func NewLandingPagesService(s *Service) *LandingPagesService {
- rs := &LandingPagesService{s: s}
- return rs
-}
-
-type LandingPagesService struct {
- s *Service
-}
-
-func NewMetrosService(s *Service) *MetrosService {
- rs := &MetrosService{s: s}
- return rs
-}
-
-type MetrosService struct {
- s *Service
-}
-
-func NewMobileCarriersService(s *Service) *MobileCarriersService {
- rs := &MobileCarriersService{s: s}
- return rs
-}
-
-type MobileCarriersService struct {
- s *Service
-}
-
-func NewOperatingSystemVersionsService(s *Service) *OperatingSystemVersionsService {
- rs := &OperatingSystemVersionsService{s: s}
- return rs
-}
-
-type OperatingSystemVersionsService struct {
- s *Service
-}
-
-func NewOperatingSystemsService(s *Service) *OperatingSystemsService {
- rs := &OperatingSystemsService{s: s}
- return rs
-}
-
-type OperatingSystemsService struct {
- s *Service
-}
-
-func NewOrderDocumentsService(s *Service) *OrderDocumentsService {
- rs := &OrderDocumentsService{s: s}
- return rs
-}
-
-type OrderDocumentsService struct {
- s *Service
-}
-
-func NewOrdersService(s *Service) *OrdersService {
- rs := &OrdersService{s: s}
- return rs
-}
-
-type OrdersService struct {
- s *Service
-}
-
-func NewPlacementGroupsService(s *Service) *PlacementGroupsService {
- rs := &PlacementGroupsService{s: s}
- return rs
-}
-
-type PlacementGroupsService struct {
- s *Service
-}
-
-func NewPlacementStrategiesService(s *Service) *PlacementStrategiesService {
- rs := &PlacementStrategiesService{s: s}
- return rs
-}
-
-type PlacementStrategiesService struct {
- s *Service
-}
-
-func NewPlacementsService(s *Service) *PlacementsService {
- rs := &PlacementsService{s: s}
- return rs
-}
-
-type PlacementsService struct {
- s *Service
-}
-
-func NewPlatformTypesService(s *Service) *PlatformTypesService {
- rs := &PlatformTypesService{s: s}
- return rs
-}
-
-type PlatformTypesService struct {
- s *Service
-}
-
-func NewPostalCodesService(s *Service) *PostalCodesService {
- rs := &PostalCodesService{s: s}
- return rs
-}
-
-type PostalCodesService struct {
- s *Service
-}
-
-func NewProjectsService(s *Service) *ProjectsService {
- rs := &ProjectsService{s: s}
- return rs
-}
-
-type ProjectsService struct {
- s *Service
-}
-
-func NewRegionsService(s *Service) *RegionsService {
- rs := &RegionsService{s: s}
- return rs
-}
-
-type RegionsService struct {
- s *Service
-}
-
-func NewRemarketingListSharesService(s *Service) *RemarketingListSharesService {
- rs := &RemarketingListSharesService{s: s}
- return rs
-}
-
-type RemarketingListSharesService struct {
- s *Service
-}
-
-func NewRemarketingListsService(s *Service) *RemarketingListsService {
- rs := &RemarketingListsService{s: s}
- return rs
-}
-
-type RemarketingListsService struct {
- s *Service
-}
-
-func NewReportsService(s *Service) *ReportsService {
- rs := &ReportsService{s: s}
- rs.CompatibleFields = NewReportsCompatibleFieldsService(s)
- rs.Files = NewReportsFilesService(s)
- return rs
-}
-
-type ReportsService struct {
- s *Service
-
- CompatibleFields *ReportsCompatibleFieldsService
-
- Files *ReportsFilesService
-}
-
-func NewReportsCompatibleFieldsService(s *Service) *ReportsCompatibleFieldsService {
- rs := &ReportsCompatibleFieldsService{s: s}
- return rs
-}
-
-type ReportsCompatibleFieldsService struct {
- s *Service
-}
-
-func NewReportsFilesService(s *Service) *ReportsFilesService {
- rs := &ReportsFilesService{s: s}
- return rs
-}
-
-type ReportsFilesService struct {
- s *Service
-}
-
-func NewSitesService(s *Service) *SitesService {
- rs := &SitesService{s: s}
- return rs
-}
-
-type SitesService struct {
- s *Service
-}
-
-func NewSizesService(s *Service) *SizesService {
- rs := &SizesService{s: s}
- return rs
-}
-
-type SizesService struct {
- s *Service
-}
-
-func NewSubaccountsService(s *Service) *SubaccountsService {
- rs := &SubaccountsService{s: s}
- return rs
-}
-
-type SubaccountsService struct {
- s *Service
-}
-
-func NewTargetableRemarketingListsService(s *Service) *TargetableRemarketingListsService {
- rs := &TargetableRemarketingListsService{s: s}
- return rs
-}
-
-type TargetableRemarketingListsService struct {
- s *Service
-}
-
-func NewUserProfilesService(s *Service) *UserProfilesService {
- rs := &UserProfilesService{s: s}
- return rs
-}
-
-type UserProfilesService struct {
- s *Service
-}
-
-func NewUserRolePermissionGroupsService(s *Service) *UserRolePermissionGroupsService {
- rs := &UserRolePermissionGroupsService{s: s}
- return rs
-}
-
-type UserRolePermissionGroupsService struct {
- s *Service
-}
-
-func NewUserRolePermissionsService(s *Service) *UserRolePermissionsService {
- rs := &UserRolePermissionsService{s: s}
- return rs
-}
-
-type UserRolePermissionsService struct {
- s *Service
-}
-
-func NewUserRolesService(s *Service) *UserRolesService {
- rs := &UserRolesService{s: s}
- return rs
-}
-
-type UserRolesService struct {
- s *Service
-}
-
-// Account: Contains properties of a DCM account.
-type Account struct {
- // AccountPermissionIds: Account permissions assigned to this account.
- AccountPermissionIds googleapi.Int64s `json:"accountPermissionIds,omitempty"`
-
- // AccountProfile: Profile for this account. This is a read-only field
- // that can be left blank.
- //
- // Possible values:
- // "ACCOUNT_PROFILE_BASIC"
- // "ACCOUNT_PROFILE_STANDARD"
- AccountProfile string `json:"accountProfile,omitempty"`
-
- // Active: Whether this account is active.
- Active bool `json:"active,omitempty"`
-
- // ActiveAdsLimitTier: Maximum number of active ads allowed for this
- // account.
- //
- // Possible values:
- // "ACTIVE_ADS_TIER_100K"
- // "ACTIVE_ADS_TIER_200K"
- // "ACTIVE_ADS_TIER_300K"
- // "ACTIVE_ADS_TIER_40K"
- // "ACTIVE_ADS_TIER_75K"
- ActiveAdsLimitTier string `json:"activeAdsLimitTier,omitempty"`
-
- // ActiveViewOptOut: Whether to serve creatives with Active View tags.
- // If disabled, viewability data will not be available for any
- // impressions.
- ActiveViewOptOut bool `json:"activeViewOptOut,omitempty"`
-
- // AvailablePermissionIds: User role permissions available to the user
- // roles of this account.
- AvailablePermissionIds googleapi.Int64s `json:"availablePermissionIds,omitempty"`
-
- // ComscoreVceEnabled: Whether campaigns created in this account will be
- // enabled for comScore vCE by default.
- ComscoreVceEnabled bool `json:"comscoreVceEnabled,omitempty"`
-
- // CountryId: ID of the country associated with this account.
- CountryId int64 `json:"countryId,omitempty,string"`
-
- // CurrencyId: ID of currency associated with this account. This is a
- // required field.
- // Acceptable values are:
- // - "1" for USD
- // - "2" for GBP
- // - "3" for ESP
- // - "4" for SEK
- // - "5" for CAD
- // - "6" for JPY
- // - "7" for DEM
- // - "8" for AUD
- // - "9" for FRF
- // - "10" for ITL
- // - "11" for DKK
- // - "12" for NOK
- // - "13" for FIM
- // - "14" for ZAR
- // - "15" for IEP
- // - "16" for NLG
- // - "17" for EUR
- // - "18" for KRW
- // - "19" for TWD
- // - "20" for SGD
- // - "21" for CNY
- // - "22" for HKD
- // - "23" for NZD
- // - "24" for MYR
- // - "25" for BRL
- // - "26" for PTE
- // - "27" for MXP
- // - "28" for CLP
- // - "29" for TRY
- // - "30" for ARS
- // - "31" for PEN
- // - "32" for ILS
- // - "33" for CHF
- // - "34" for VEF
- // - "35" for COP
- // - "36" for GTQ
- CurrencyId int64 `json:"currencyId,omitempty,string"`
-
- // DefaultCreativeSizeId: Default placement dimensions for this account.
- DefaultCreativeSizeId int64 `json:"defaultCreativeSizeId,omitempty,string"`
-
- // Description: Description of this account.
- Description string `json:"description,omitempty"`
-
- // Id: ID of this account. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#account".
- Kind string `json:"kind,omitempty"`
-
- // Locale: Locale of this account.
- // Acceptable values are:
- // - "cs" (Czech)
- // - "de" (German)
- // - "en" (English)
- // - "en-GB" (English United Kingdom)
- // - "es" (Spanish)
- // - "fr" (French)
- // - "it" (Italian)
- // - "ja" (Japanese)
- // - "ko" (Korean)
- // - "pl" (Polish)
- // - "pt-BR" (Portuguese Brazil)
- // - "ru" (Russian)
- // - "sv" (Swedish)
- // - "tr" (Turkish)
- // - "zh-CN" (Chinese Simplified)
- // - "zh-TW" (Chinese Traditional)
- Locale string `json:"locale,omitempty"`
-
- // MaximumImageSize: Maximum image size allowed for this account.
- MaximumImageSize int64 `json:"maximumImageSize,omitempty,string"`
-
- // Name: Name of this account. This is a required field, and must be
- // less than 128 characters long and be globally unique.
- Name string `json:"name,omitempty"`
-
- // NielsenOcrEnabled: Whether campaigns created in this account will be
- // enabled for Nielsen OCR reach ratings by default.
- NielsenOcrEnabled bool `json:"nielsenOcrEnabled,omitempty"`
-
- // ReportsConfiguration: Reporting configuration of this account.
- ReportsConfiguration *ReportsConfiguration `json:"reportsConfiguration,omitempty"`
-
- // TeaserSizeLimit: File size limit in kilobytes of Rich Media teaser
- // creatives. Must be between 1 and 10240.
- TeaserSizeLimit int64 `json:"teaserSizeLimit,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "AccountPermissionIds") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Account) MarshalJSON() ([]byte, error) {
- type noMethod Account
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountActiveAdSummary: Gets a summary of active ads in an account.
-type AccountActiveAdSummary struct {
- // AccountId: ID of the account.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // ActiveAds: Ads that have been activated for the account
- ActiveAds int64 `json:"activeAds,omitempty,string"`
-
- // ActiveAdsLimitTier: Maximum number of active ads allowed for the
- // account.
- //
- // Possible values:
- // "ACTIVE_ADS_TIER_100K"
- // "ACTIVE_ADS_TIER_200K"
- // "ACTIVE_ADS_TIER_300K"
- // "ACTIVE_ADS_TIER_40K"
- // "ACTIVE_ADS_TIER_75K"
- ActiveAdsLimitTier string `json:"activeAdsLimitTier,omitempty"`
-
- // AvailableAds: Ads that can be activated for the account.
- AvailableAds int64 `json:"availableAds,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#accountActiveAdSummary".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountActiveAdSummary) MarshalJSON() ([]byte, error) {
- type noMethod AccountActiveAdSummary
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountPermission: AccountPermissions contains information about a
-// particular account permission. Some features of DCM require an
-// account permission to be present in the account.
-type AccountPermission struct {
- // AccountProfiles: Account profiles associated with this account
- // permission.
- //
- // Possible values are:
- // - "ACCOUNT_PROFILE_BASIC"
- // - "ACCOUNT_PROFILE_STANDARD"
- //
- // Possible values:
- // "ACCOUNT_PROFILE_BASIC"
- // "ACCOUNT_PROFILE_STANDARD"
- AccountProfiles []string `json:"accountProfiles,omitempty"`
-
- // Id: ID of this account permission.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#accountPermission".
- Kind string `json:"kind,omitempty"`
-
- // Level: Administrative level required to enable this account
- // permission.
- //
- // Possible values:
- // "ADMINISTRATOR"
- // "USER"
- Level string `json:"level,omitempty"`
-
- // Name: Name of this account permission.
- Name string `json:"name,omitempty"`
-
- // PermissionGroupId: Permission group of this account permission.
- PermissionGroupId int64 `json:"permissionGroupId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountProfiles") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountPermission) MarshalJSON() ([]byte, error) {
- type noMethod AccountPermission
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountPermissionGroup: AccountPermissionGroups contains a mapping of
-// permission group IDs to names. A permission group is a grouping of
-// account permissions.
-type AccountPermissionGroup struct {
- // Id: ID of this account permission group.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#accountPermissionGroup".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this account permission group.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountPermissionGroup) MarshalJSON() ([]byte, error) {
- type noMethod AccountPermissionGroup
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountPermissionGroupsListResponse: Account Permission Group List
-// Response
-type AccountPermissionGroupsListResponse struct {
- // AccountPermissionGroups: Account permission group collection.
- AccountPermissionGroups []*AccountPermissionGroup `json:"accountPermissionGroups,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#accountPermissionGroupsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "AccountPermissionGroups") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountPermissionGroupsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod AccountPermissionGroupsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountPermissionsListResponse: Account Permission List Response
-type AccountPermissionsListResponse struct {
- // AccountPermissions: Account permission collection.
- AccountPermissions []*AccountPermission `json:"accountPermissions,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#accountPermissionsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountPermissions")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountPermissionsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod AccountPermissionsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountUserProfile: AccountUserProfiles contains properties of a DCM
-// user profile. This resource is specifically for managing user
-// profiles, whereas UserProfiles is for accessing the API.
-type AccountUserProfile struct {
- // AccountId: Account ID of the user profile. This is a read-only field
- // that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Active: Whether this user profile is active. This defaults to false,
- // and must be set true on insert for the user profile to be usable.
- Active bool `json:"active,omitempty"`
-
- // AdvertiserFilter: Filter that describes which advertisers are visible
- // to the user profile.
- AdvertiserFilter *ObjectFilter `json:"advertiserFilter,omitempty"`
-
- // CampaignFilter: Filter that describes which campaigns are visible to
- // the user profile.
- CampaignFilter *ObjectFilter `json:"campaignFilter,omitempty"`
-
- // Comments: Comments for this user profile.
- Comments string `json:"comments,omitempty"`
-
- // Email: Email of the user profile. The email addresss must be linked
- // to a Google Account. This field is required on insertion and is
- // read-only after insertion.
- Email string `json:"email,omitempty"`
-
- // Id: ID of the user profile. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#accountUserProfile".
- Kind string `json:"kind,omitempty"`
-
- // Locale: Locale of the user profile. This is a required
- // field.
- // Acceptable values are:
- // - "cs" (Czech)
- // - "de" (German)
- // - "en" (English)
- // - "en-GB" (English United Kingdom)
- // - "es" (Spanish)
- // - "fr" (French)
- // - "it" (Italian)
- // - "ja" (Japanese)
- // - "ko" (Korean)
- // - "pl" (Polish)
- // - "pt-BR" (Portuguese Brazil)
- // - "ru" (Russian)
- // - "sv" (Swedish)
- // - "tr" (Turkish)
- // - "zh-CN" (Chinese Simplified)
- // - "zh-TW" (Chinese Traditional)
- Locale string `json:"locale,omitempty"`
-
- // Name: Name of the user profile. This is a required field. Must be
- // less than 64 characters long, must be globally unique, and cannot
- // contain whitespace or any of the following characters: "&;"#%,".
- Name string `json:"name,omitempty"`
-
- // SiteFilter: Filter that describes which sites are visible to the user
- // profile.
- SiteFilter *ObjectFilter `json:"siteFilter,omitempty"`
-
- // SubaccountId: Subaccount ID of the user profile. This is a read-only
- // field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // TraffickerType: Trafficker type of this user profile.
- //
- // Possible values:
- // "EXTERNAL_TRAFFICKER"
- // "INTERNAL_NON_TRAFFICKER"
- // "INTERNAL_TRAFFICKER"
- TraffickerType string `json:"traffickerType,omitempty"`
-
- // UserAccessType: User type of the user profile. This is a read-only
- // field that can be left blank.
- //
- // Possible values:
- // "INTERNAL_ADMINISTRATOR"
- // "NORMAL_USER"
- // "SUPER_USER"
- UserAccessType string `json:"userAccessType,omitempty"`
-
- // UserRoleFilter: Filter that describes which user roles are visible to
- // the user profile.
- UserRoleFilter *ObjectFilter `json:"userRoleFilter,omitempty"`
-
- // UserRoleId: User role ID of the user profile. This is a required
- // field.
- UserRoleId int64 `json:"userRoleId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountUserProfile) MarshalJSON() ([]byte, error) {
- type noMethod AccountUserProfile
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountUserProfilesListResponse: Account User Profile List Response
-type AccountUserProfilesListResponse struct {
- // AccountUserProfiles: Account user profile collection.
- AccountUserProfiles []*AccountUserProfile `json:"accountUserProfiles,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#accountUserProfilesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountUserProfiles")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountUserProfilesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod AccountUserProfilesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AccountsListResponse: Account List Response
-type AccountsListResponse struct {
- // Accounts: Account collection.
- Accounts []*Account `json:"accounts,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#accountsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Accounts") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AccountsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod AccountsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Activities: Represents an activity group.
-type Activities struct {
- // Filters: List of activity filters. The dimension values need to be
- // all either of type "dfa:activity" or "dfa:activityGroup".
- Filters []*DimensionValue `json:"filters,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#activities.
- Kind string `json:"kind,omitempty"`
-
- // MetricNames: List of names of floodlight activity metrics.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Filters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Activities) MarshalJSON() ([]byte, error) {
- type noMethod Activities
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Ad: Contains properties of a DCM ad.
-type Ad struct {
- // AccountId: Account ID of this ad. This is a read-only field that can
- // be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Active: Whether this ad is active.
- Active bool `json:"active,omitempty"`
-
- // AdvertiserId: Advertiser ID of this ad. This is a required field on
- // insertion.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // Archived: Whether this ad is archived.
- Archived bool `json:"archived,omitempty"`
-
- // AudienceSegmentId: Audience segment ID that is being targeted for
- // this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- AudienceSegmentId int64 `json:"audienceSegmentId,omitempty,string"`
-
- // CampaignId: Campaign ID of this ad. This is a required field on
- // insertion.
- CampaignId int64 `json:"campaignId,omitempty,string"`
-
- // CampaignIdDimensionValue: Dimension value for the ID of the campaign.
- // This is a read-only, auto-generated field.
- CampaignIdDimensionValue *DimensionValue `json:"campaignIdDimensionValue,omitempty"`
-
- // ClickThroughUrl: Click-through URL for this ad. This is a required
- // field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
- ClickThroughUrl *ClickThroughUrl `json:"clickThroughUrl,omitempty"`
-
- // ClickThroughUrlSuffixProperties: Click-through URL suffix properties
- // for this ad. Applies to the URL in the ad or (if overriding ad
- // properties) the URL in the creative.
- ClickThroughUrlSuffixProperties *ClickThroughUrlSuffixProperties `json:"clickThroughUrlSuffixProperties,omitempty"`
-
- // Comments: Comments for this ad.
- Comments string `json:"comments,omitempty"`
-
- // Compatibility: Compatibility of this ad. Applicable when type is
- // AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering
- // either on desktop or on mobile devices for regular or interstitial
- // ads, respectively. APP and APP_INTERSTITIAL are for rendering in
- // mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video
- // ads developed with the VAST standard.
- //
- // Possible values:
- // "APP"
- // "APP_INTERSTITIAL"
- // "IN_STREAM_VIDEO"
- // "WEB"
- // "WEB_INTERSTITIAL"
- Compatibility string `json:"compatibility,omitempty"`
-
- // CreateInfo: Information about the creation of this ad.This is a
- // read-only field.
- CreateInfo *LastModifiedInfo `json:"createInfo,omitempty"`
-
- // CreativeGroupAssignments: Creative group assignments for this ad.
- // Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment
- // per creative group number is allowed for a maximum of two
- // assignments.
- CreativeGroupAssignments []*CreativeGroupAssignment `json:"creativeGroupAssignments,omitempty"`
-
- // CreativeRotation: Creative rotation for this ad. Applicable when type
- // is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or
- // AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field
- // should have exactly one creativeAssignment.
- CreativeRotation *CreativeRotation `json:"creativeRotation,omitempty"`
-
- // DayPartTargeting: Time and day targeting information for this ad.
- // Applicable when type is AD_SERVING_STANDARD_AD.
- DayPartTargeting *DayPartTargeting `json:"dayPartTargeting,omitempty"`
-
- // DefaultClickThroughEventTagProperties: Default click-through event
- // tag properties for this ad.
- DefaultClickThroughEventTagProperties *DefaultClickThroughEventTagProperties `json:"defaultClickThroughEventTagProperties,omitempty"`
-
- // DeliverySchedule: Delivery schedule information for this ad.
- // Applicable when type is AD_SERVING_STANDARD_AD or
- // AD_SERVING_TRACKING. This field along with subfields priority and
- // impressionRatio are required on insertion when type is
- // AD_SERVING_STANDARD_AD.
- DeliverySchedule *DeliverySchedule `json:"deliverySchedule,omitempty"`
-
- // DynamicClickTracker: Whether this ad is a dynamic click tracker.
- // Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required
- // field on insert, and is read-only after insert.
- DynamicClickTracker bool `json:"dynamicClickTracker,omitempty"`
-
- // EndTime: Date and time that this ad should stop serving. Must be
- // later than the start time. This is a required field on insertion.
- EndTime string `json:"endTime,omitempty"`
-
- // EventTagOverrides: Event tag overrides for this ad.
- EventTagOverrides []*EventTagOverride `json:"eventTagOverrides,omitempty"`
-
- // GeoTargeting: Geographical targeting information for this
- // ad.Applicable when type is AD_SERVING_STANDARD_AD.
- GeoTargeting *GeoTargeting `json:"geoTargeting,omitempty"`
-
- // Id: ID of this ad. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this ad. This is a
- // read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // KeyValueTargetingExpression: Key-value targeting information for this
- // ad. Applicable when type is AD_SERVING_STANDARD_AD.
- KeyValueTargetingExpression *KeyValueTargetingExpression `json:"keyValueTargetingExpression,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#ad".
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedInfo: Information about the most recent modification of
- // this ad. This is a read-only field.
- LastModifiedInfo *LastModifiedInfo `json:"lastModifiedInfo,omitempty"`
-
- // Name: Name of this ad. This is a required field and must be less than
- // 256 characters long.
- Name string `json:"name,omitempty"`
-
- // PlacementAssignments: Placement assignments for this ad.
- PlacementAssignments []*PlacementAssignment `json:"placementAssignments,omitempty"`
-
- // RemarketingListExpression: Applicable when type is
- // AD_SERVING_STANDARD_AD. Remarketing list targeting expression for
- // this ad.
- RemarketingListExpression *ListTargetingExpression `json:"remarketingListExpression,omitempty"`
-
- // Size: Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
- Size *Size `json:"size,omitempty"`
-
- // SslCompliant: Whether this ad is ssl compliant. This is a read-only
- // field that is auto-generated when the ad is inserted or updated.
- SslCompliant bool `json:"sslCompliant,omitempty"`
-
- // SslRequired: Whether this ad requires ssl. This is a read-only field
- // that is auto-generated when the ad is inserted or updated.
- SslRequired bool `json:"sslRequired,omitempty"`
-
- // StartTime: Date and time that this ad should start serving. If
- // creating an ad, this field must be a time in the future. This is a
- // required field on insertion.
- StartTime string `json:"startTime,omitempty"`
-
- // SubaccountId: Subaccount ID of this ad. This is a read-only field
- // that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // TechnologyTargeting: Technology platform targeting information for
- // this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- TechnologyTargeting *TechnologyTargeting `json:"technologyTargeting,omitempty"`
-
- // Type: Type of ad. This is a required field on insertion. Note that
- // default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see
- // Creative resource).
- //
- // Possible values:
- // "AD_SERVING_CLICK_TRACKER"
- // "AD_SERVING_DEFAULT_AD"
- // "AD_SERVING_STANDARD_AD"
- // "AD_SERVING_TRACKING"
- Type string `json:"type,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Ad) MarshalJSON() ([]byte, error) {
- type noMethod Ad
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdSlot: Ad Slot
-type AdSlot struct {
- // Comment: Comment for this ad slot.
- Comment string `json:"comment,omitempty"`
-
- // Compatibility: Ad slot compatibility. WEB and WEB_INTERSTITIAL refer
- // to rendering either on desktop or on mobile devices for regular or
- // interstitial ads respectively. APP and APP_INTERSTITIAL are for
- // rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in
- // in-stream video ads developed with the VAST standard.
- //
- // Possible values:
- // "PLANNING_RENDERING_ENVIRONMENT_TYPE_APP"
- // "PLANNING_RENDERING_ENVIRONMENT_TYPE_APP_INTERSTITIAL"
- // "PLANNING_RENDERING_ENVIRONMENT_TYPE_IN_STREAM_VIDEO"
- // "PLANNING_RENDERING_ENVIRONMENT_TYPE_WEB"
- // "PLANNING_RENDERING_ENVIRONMENT_TYPE_WEB_INTERSTITIAL"
- Compatibility string `json:"compatibility,omitempty"`
-
- // Height: Height of this ad slot.
- Height int64 `json:"height,omitempty,string"`
-
- // LinkedPlacementId: ID of the placement from an external platform that
- // is linked to this ad slot.
- LinkedPlacementId int64 `json:"linkedPlacementId,omitempty,string"`
-
- // Name: Name of this ad slot.
- Name string `json:"name,omitempty"`
-
- // PaymentSourceType: Payment source type of this ad slot.
- //
- // Possible values:
- // "PLANNING_PAYMENT_SOURCE_TYPE_AGENCY_PAID"
- // "PLANNING_PAYMENT_SOURCE_TYPE_PUBLISHER_PAID"
- PaymentSourceType string `json:"paymentSourceType,omitempty"`
-
- // Primary: Primary ad slot of a roadblock inventory item.
- Primary bool `json:"primary,omitempty"`
-
- // Width: Width of this ad slot.
- Width int64 `json:"width,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "Comment") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdSlot) MarshalJSON() ([]byte, error) {
- type noMethod AdSlot
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdsListResponse: Ad List Response
-type AdsListResponse struct {
- // Ads: Ad collection.
- Ads []*Ad `json:"ads,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#adsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Ads") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod AdsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Advertiser: Contains properties of a DCM advertiser.
-type Advertiser struct {
- // AccountId: Account ID of this advertiser.This is a read-only field
- // that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserGroupId: ID of the advertiser group this advertiser belongs
- // to. You can group advertisers for reporting purposes, allowing you to
- // see aggregated information for all advertisers in each group.
- AdvertiserGroupId int64 `json:"advertiserGroupId,omitempty,string"`
-
- // ClickThroughUrlSuffix: Suffix added to click-through URL of ad
- // creative associations under this advertiser. Must be less than 129
- // characters long.
- ClickThroughUrlSuffix string `json:"clickThroughUrlSuffix,omitempty"`
-
- // DefaultClickThroughEventTagId: ID of the click-through event tag to
- // apply by default to the landing pages of this advertiser's campaigns.
- DefaultClickThroughEventTagId int64 `json:"defaultClickThroughEventTagId,omitempty,string"`
-
- // DefaultEmail: Default email address used in sender field for tag
- // emails.
- DefaultEmail string `json:"defaultEmail,omitempty"`
-
- // FloodlightConfigurationId: Floodlight configuration ID of this
- // advertiser. The floodlight configuration ID will be created
- // automatically, so on insert this field should be left blank. This
- // field can be set to another advertiser's floodlight configuration ID
- // in order to share that advertiser's floodlight configuration with
- // this advertiser, so long as:
- // - This advertiser's original floodlight configuration is not already
- // associated with floodlight activities or floodlight activity groups.
- //
- // - This advertiser's original floodlight configuration is not already
- // shared with another advertiser.
- FloodlightConfigurationId int64 `json:"floodlightConfigurationId,omitempty,string"`
-
- // FloodlightConfigurationIdDimensionValue: Dimension value for the ID
- // of the floodlight configuration. This is a read-only, auto-generated
- // field.
- FloodlightConfigurationIdDimensionValue *DimensionValue `json:"floodlightConfigurationIdDimensionValue,omitempty"`
-
- // Id: ID of this advertiser. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this advertiser. This
- // is a read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#advertiser".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this advertiser. This is a required field and must be
- // less than 256 characters long and unique among advertisers of the
- // same account.
- Name string `json:"name,omitempty"`
-
- // OriginalFloodlightConfigurationId: Original floodlight configuration
- // before any sharing occurred. Set the floodlightConfigurationId of
- // this advertiser to originalFloodlightConfigurationId to unshare the
- // advertiser's current floodlight configuration. You cannot unshare an
- // advertiser's floodlight configuration if the shared configuration has
- // activities associated with any campaign or placement.
- OriginalFloodlightConfigurationId int64 `json:"originalFloodlightConfigurationId,omitempty,string"`
-
- // Status: Status of this advertiser.
- //
- // Possible values:
- // "APPROVED"
- // "ON_HOLD"
- Status string `json:"status,omitempty"`
-
- // SubaccountId: Subaccount ID of this advertiser.This is a read-only
- // field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // Suspended: Suspension status of this advertiser.
- Suspended bool `json:"suspended,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Advertiser) MarshalJSON() ([]byte, error) {
- type noMethod Advertiser
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdvertiserGroup: Groups advertisers together so that reports can be
-// generated for the entire group at once.
-type AdvertiserGroup struct {
- // AccountId: Account ID of this advertiser group. This is a read-only
- // field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Id: ID of this advertiser group. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#advertiserGroup".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this advertiser group. This is a required field and
- // must be less than 256 characters long and unique among advertiser
- // groups of the same account.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdvertiserGroup) MarshalJSON() ([]byte, error) {
- type noMethod AdvertiserGroup
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdvertiserGroupsListResponse: Advertiser Group List Response
-type AdvertiserGroupsListResponse struct {
- // AdvertiserGroups: Advertiser group collection.
- AdvertiserGroups []*AdvertiserGroup `json:"advertiserGroups,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#advertiserGroupsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AdvertiserGroups") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdvertiserGroupsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod AdvertiserGroupsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AdvertisersListResponse: Advertiser List Response
-type AdvertisersListResponse struct {
- // Advertisers: Advertiser collection.
- Advertisers []*Advertiser `json:"advertisers,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#advertisersListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Advertisers") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AdvertisersListResponse) MarshalJSON() ([]byte, error) {
- type noMethod AdvertisersListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AudienceSegment: Audience Segment.
-type AudienceSegment struct {
- // Allocation: Weight allocated to this segment. Must be between 1 and
- // 1000. The weight assigned will be understood in proportion to the
- // weights assigned to other segments in the same segment group.
- Allocation int64 `json:"allocation,omitempty"`
-
- // Id: ID of this audience segment. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // Name: Name of this audience segment. This is a required field and
- // must be less than 65 characters long.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Allocation") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AudienceSegment) MarshalJSON() ([]byte, error) {
- type noMethod AudienceSegment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// AudienceSegmentGroup: Audience Segment Group.
-type AudienceSegmentGroup struct {
- // AudienceSegments: Audience segments assigned to this group. The
- // number of segments must be between 2 and 100.
- AudienceSegments []*AudienceSegment `json:"audienceSegments,omitempty"`
-
- // Id: ID of this audience segment group. This is a read-only,
- // auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Name: Name of this audience segment group. This is a required field
- // and must be less than 65 characters long.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AudienceSegments") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *AudienceSegmentGroup) MarshalJSON() ([]byte, error) {
- type noMethod AudienceSegmentGroup
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Browser: Contains information about a browser that can be targeted by
-// ads.
-type Browser struct {
- // BrowserVersionId: ID referring to this grouping of browser and
- // version numbers. This is the ID used for targeting.
- BrowserVersionId int64 `json:"browserVersionId,omitempty,string"`
-
- // DartId: DART ID of this browser. This is the ID used when generating
- // reports.
- DartId int64 `json:"dartId,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#browser".
- Kind string `json:"kind,omitempty"`
-
- // MajorVersion: Major version number (leftmost number) of this browser.
- // For example, for Chrome 5.0.376.86 beta, this field should be set to
- // 5. An asterisk (*) may be used to target any version number, and a
- // question mark (?) may be used to target cases where the version
- // number cannot be identified. For example, Chrome *.* targets any
- // version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets
- // Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad
- // server knows the browser is Firefox but can't tell which version it
- // is.
- MajorVersion string `json:"majorVersion,omitempty"`
-
- // MinorVersion: Minor version number (number after first dot on left)
- // of this browser. For example, for Chrome 5.0.375.86 beta, this field
- // should be set to 0. An asterisk (*) may be used to target any version
- // number, and a question mark (?) may be used to target cases where the
- // version number cannot be identified. For example, Chrome *.* targets
- // any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets
- // Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad
- // server knows the browser is Firefox but can't tell which version it
- // is.
- MinorVersion string `json:"minorVersion,omitempty"`
-
- // Name: Name of this browser.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "BrowserVersionId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Browser) MarshalJSON() ([]byte, error) {
- type noMethod Browser
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// BrowsersListResponse: Browser List Response
-type BrowsersListResponse struct {
- // Browsers: Browser collection.
- Browsers []*Browser `json:"browsers,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#browsersListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Browsers") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *BrowsersListResponse) MarshalJSON() ([]byte, error) {
- type noMethod BrowsersListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Campaign: Contains properties of a DCM campaign.
-type Campaign struct {
- // AccountId: Account ID of this campaign. This is a read-only field
- // that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdditionalCreativeOptimizationConfigurations: Additional creative
- // optimization configurations for the campaign.
- AdditionalCreativeOptimizationConfigurations []*CreativeOptimizationConfiguration `json:"additionalCreativeOptimizationConfigurations,omitempty"`
-
- // AdvertiserGroupId: Advertiser group ID of the associated advertiser.
- AdvertiserGroupId int64 `json:"advertiserGroupId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this campaign. This is a required
- // field.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the advertiser ID of
- // this campaign. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // Archived: Whether this campaign has been archived.
- Archived bool `json:"archived,omitempty"`
-
- // AudienceSegmentGroups: Audience segment groups assigned to this
- // campaign. Cannot have more than 300 segment groups.
- AudienceSegmentGroups []*AudienceSegmentGroup `json:"audienceSegmentGroups,omitempty"`
-
- // BillingInvoiceCode: Billing invoice code included in the DCM client
- // billing invoices associated with the campaign.
- BillingInvoiceCode string `json:"billingInvoiceCode,omitempty"`
-
- // ClickThroughUrlSuffixProperties: Click-through URL suffix override
- // properties for this campaign.
- ClickThroughUrlSuffixProperties *ClickThroughUrlSuffixProperties `json:"clickThroughUrlSuffixProperties,omitempty"`
-
- // Comment: Arbitrary comments about this campaign. Must be less than
- // 256 characters long.
- Comment string `json:"comment,omitempty"`
-
- // ComscoreVceEnabled: Whether comScore vCE reports are enabled for this
- // campaign.
- ComscoreVceEnabled bool `json:"comscoreVceEnabled,omitempty"`
-
- // CreateInfo: Information about the creation of this campaign. This is
- // a read-only field.
- CreateInfo *LastModifiedInfo `json:"createInfo,omitempty"`
-
- // CreativeGroupIds: List of creative group IDs that are assigned to the
- // campaign.
- CreativeGroupIds googleapi.Int64s `json:"creativeGroupIds,omitempty"`
-
- // CreativeOptimizationConfiguration: Creative optimization
- // configuration for the campaign.
- CreativeOptimizationConfiguration *CreativeOptimizationConfiguration `json:"creativeOptimizationConfiguration,omitempty"`
-
- // DefaultClickThroughEventTagProperties: Click-through event tag ID
- // override properties for this campaign.
- DefaultClickThroughEventTagProperties *DefaultClickThroughEventTagProperties `json:"defaultClickThroughEventTagProperties,omitempty"`
-
- // EndDate: Date on which the campaign will stop running. On insert, the
- // end date must be today or a future date. The end date must be later
- // than or be the same as the start date. If, for example, you set
- // 6/25/2015 as both the start and end dates, the effective campaign run
- // date is just that day only, 6/25/2015. The hours, minutes, and
- // seconds of the end date should not be set, as doing so will result in
- // an error. This is a required field.
- EndDate string `json:"endDate,omitempty"`
-
- // EventTagOverrides: Overrides that can be used to activate or
- // deactivate advertiser event tags.
- EventTagOverrides []*EventTagOverride `json:"eventTagOverrides,omitempty"`
-
- // ExternalId: External ID for this campaign.
- ExternalId string `json:"externalId,omitempty"`
-
- // Id: ID of this campaign. This is a read-only auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this campaign. This
- // is a read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#campaign".
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedInfo: Information about the most recent modification of
- // this campaign. This is a read-only field.
- LastModifiedInfo *LastModifiedInfo `json:"lastModifiedInfo,omitempty"`
-
- // LookbackConfiguration: Lookback window settings for the campaign.
- LookbackConfiguration *LookbackConfiguration `json:"lookbackConfiguration,omitempty"`
-
- // Name: Name of this campaign. This is a required field and must be
- // less than 256 characters long and unique among campaigns of the same
- // advertiser.
- Name string `json:"name,omitempty"`
-
- // NielsenOcrEnabled: Whether Nielsen reports are enabled for this
- // campaign.
- NielsenOcrEnabled bool `json:"nielsenOcrEnabled,omitempty"`
-
- // StartDate: Date on which the campaign starts running. The start date
- // can be any date. The hours, minutes, and seconds of the start date
- // should not be set, as doing so will result in an error. This is a
- // required field.
- StartDate string `json:"startDate,omitempty"`
-
- // SubaccountId: Subaccount ID of this campaign. This is a read-only
- // field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // TraffickerEmails: Campaign trafficker contact emails.
- TraffickerEmails []string `json:"traffickerEmails,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Campaign) MarshalJSON() ([]byte, error) {
- type noMethod Campaign
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CampaignCreativeAssociation: Identifies a creative which has been
-// associated with a given campaign.
-type CampaignCreativeAssociation struct {
- // CreativeId: ID of the creative associated with the campaign. This is
- // a required field.
- CreativeId int64 `json:"creativeId,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#campaignCreativeAssociation".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreativeId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CampaignCreativeAssociation) MarshalJSON() ([]byte, error) {
- type noMethod CampaignCreativeAssociation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CampaignCreativeAssociationsListResponse: Campaign Creative
-// Association List Response
-type CampaignCreativeAssociationsListResponse struct {
- // CampaignCreativeAssociations: Campaign creative association
- // collection
- CampaignCreativeAssociations []*CampaignCreativeAssociation `json:"campaignCreativeAssociations,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#campaignCreativeAssociationsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "CampaignCreativeAssociations") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CampaignCreativeAssociationsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod CampaignCreativeAssociationsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CampaignsListResponse: Campaign List Response
-type CampaignsListResponse struct {
- // Campaigns: Campaign collection.
- Campaigns []*Campaign `json:"campaigns,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#campaignsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Campaigns") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CampaignsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod CampaignsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ChangeLog: Describes a change that a user has made to a resource.
-type ChangeLog struct {
- // AccountId: Account ID of the modified object.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Action: Action which caused the change.
- Action string `json:"action,omitempty"`
-
- // ChangeTime: Time when the object was modified.
- ChangeTime string `json:"changeTime,omitempty"`
-
- // FieldName: Field name of the object which changed.
- FieldName string `json:"fieldName,omitempty"`
-
- // Id: ID of this change log.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#changeLog".
- Kind string `json:"kind,omitempty"`
-
- // NewValue: New value of the object field.
- NewValue string `json:"newValue,omitempty"`
-
- // ObjectId: ID of the object of this change log. The object could be a
- // campaign, placement, ad, or other type.
- ObjectId int64 `json:"objectId,omitempty,string"`
-
- // ObjectType: Object type of the change log.
- ObjectType string `json:"objectType,omitempty"`
-
- // OldValue: Old value of the object field.
- OldValue string `json:"oldValue,omitempty"`
-
- // SubaccountId: Subaccount ID of the modified object.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // TransactionId: Transaction ID of this change log. When a single API
- // call results in many changes, each change will have a separate ID in
- // the change log but will share the same transactionId.
- TransactionId int64 `json:"transactionId,omitempty,string"`
-
- // UserProfileId: ID of the user who modified the object.
- UserProfileId int64 `json:"userProfileId,omitempty,string"`
-
- // UserProfileName: User profile name of the user who modified the
- // object.
- UserProfileName string `json:"userProfileName,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ChangeLog) MarshalJSON() ([]byte, error) {
- type noMethod ChangeLog
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ChangeLogsListResponse: Change Log List Response
-type ChangeLogsListResponse struct {
- // ChangeLogs: Change log collection.
- ChangeLogs []*ChangeLog `json:"changeLogs,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#changeLogsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ChangeLogs") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ChangeLogsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod ChangeLogsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CitiesListResponse: City List Response
-type CitiesListResponse struct {
- // Cities: City collection.
- Cities []*City `json:"cities,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#citiesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Cities") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CitiesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod CitiesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// City: Contains information about a city that can be targeted by ads.
-type City struct {
- // CountryCode: Country code of the country to which this city belongs.
- CountryCode string `json:"countryCode,omitempty"`
-
- // CountryDartId: DART ID of the country to which this city belongs.
- CountryDartId int64 `json:"countryDartId,omitempty,string"`
-
- // DartId: DART ID of this city. This is the ID used for targeting and
- // generating reports.
- DartId int64 `json:"dartId,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#city".
- Kind string `json:"kind,omitempty"`
-
- // MetroCode: Metro region code of the metro region (DMA) to which this
- // city belongs.
- MetroCode string `json:"metroCode,omitempty"`
-
- // MetroDmaId: ID of the metro region (DMA) to which this city belongs.
- MetroDmaId int64 `json:"metroDmaId,omitempty,string"`
-
- // Name: Name of this city.
- Name string `json:"name,omitempty"`
-
- // RegionCode: Region code of the region to which this city belongs.
- RegionCode string `json:"regionCode,omitempty"`
-
- // RegionDartId: DART ID of the region to which this city belongs.
- RegionDartId int64 `json:"regionDartId,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "CountryCode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *City) MarshalJSON() ([]byte, error) {
- type noMethod City
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ClickTag: Creative Click Tag.
-type ClickTag struct {
- // EventName: Advertiser event name associated with the click tag. This
- // field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER
- // creatives.
- EventName string `json:"eventName,omitempty"`
-
- // Name: Parameter name for the specified click tag. For ENHANCED_IMAGE
- // creative assets, this field must match the value of the creative
- // asset's creativeAssetId.name field.
- Name string `json:"name,omitempty"`
-
- // Value: Parameter value for the specified click tag. This field
- // contains a click-through url.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "EventName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ClickTag) MarshalJSON() ([]byte, error) {
- type noMethod ClickTag
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ClickThroughUrl: Click-through URL
-type ClickThroughUrl struct {
- // ComputedClickThroughUrl: Read-only convenience field representing the
- // actual URL that will be used for this click-through. The URL is
- // computed as follows:
- // - If defaultLandingPage is enabled then the campaign's default
- // landing page URL is assigned to this field.
- // - If defaultLandingPage is not enabled and a landingPageId is
- // specified then that landing page's URL is assigned to this field.
- // - If neither of the above cases apply, then the customClickThroughUrl
- // is assigned to this field.
- ComputedClickThroughUrl string `json:"computedClickThroughUrl,omitempty"`
-
- // CustomClickThroughUrl: Custom click-through URL. Applicable if the
- // defaultLandingPage field is set to false and the landingPageId field
- // is left unset.
- CustomClickThroughUrl string `json:"customClickThroughUrl,omitempty"`
-
- // DefaultLandingPage: Whether the campaign default landing page is
- // used.
- DefaultLandingPage bool `json:"defaultLandingPage,omitempty"`
-
- // LandingPageId: ID of the landing page for the click-through URL.
- // Applicable if the defaultLandingPage field is set to false.
- LandingPageId int64 `json:"landingPageId,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g.
- // "ComputedClickThroughUrl") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ClickThroughUrl) MarshalJSON() ([]byte, error) {
- type noMethod ClickThroughUrl
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ClickThroughUrlSuffixProperties: Click Through URL Suffix settings.
-type ClickThroughUrlSuffixProperties struct {
- // ClickThroughUrlSuffix: Click-through URL suffix to apply to all ads
- // in this entity's scope. Must be less than 128 characters long.
- ClickThroughUrlSuffix string `json:"clickThroughUrlSuffix,omitempty"`
-
- // OverrideInheritedSuffix: Whether this entity should override the
- // inherited click-through URL suffix with its own defined value.
- OverrideInheritedSuffix bool `json:"overrideInheritedSuffix,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "ClickThroughUrlSuffix") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ClickThroughUrlSuffixProperties) MarshalJSON() ([]byte, error) {
- type noMethod ClickThroughUrlSuffixProperties
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CompanionClickThroughOverride: Companion Click-through override.
-type CompanionClickThroughOverride struct {
- // ClickThroughUrl: Click-through URL of this companion click-through
- // override.
- ClickThroughUrl *ClickThroughUrl `json:"clickThroughUrl,omitempty"`
-
- // CreativeId: ID of the creative for this companion click-through
- // override.
- CreativeId int64 `json:"creativeId,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "ClickThroughUrl") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CompanionClickThroughOverride) MarshalJSON() ([]byte, error) {
- type noMethod CompanionClickThroughOverride
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CompatibleFields: Represents a response to the queryCompatibleFields
-// method.
-type CompatibleFields struct {
- // CrossDimensionReachReportCompatibleFields: Contains items that are
- // compatible to be selected for a report of type
- // "CROSS_DIMENSION_REACH".
- CrossDimensionReachReportCompatibleFields *CrossDimensionReachReportCompatibleFields `json:"crossDimensionReachReportCompatibleFields,omitempty"`
-
- // FloodlightReportCompatibleFields: Contains items that are compatible
- // to be selected for a report of type "FLOODLIGHT".
- FloodlightReportCompatibleFields *FloodlightReportCompatibleFields `json:"floodlightReportCompatibleFields,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#compatibleFields.
- Kind string `json:"kind,omitempty"`
-
- // PathToConversionReportCompatibleFields: Contains items that are
- // compatible to be selected for a report of type "PATH_TO_CONVERSION".
- PathToConversionReportCompatibleFields *PathToConversionReportCompatibleFields `json:"pathToConversionReportCompatibleFields,omitempty"`
-
- // ReachReportCompatibleFields: Contains items that are compatible to be
- // selected for a report of type "REACH".
- ReachReportCompatibleFields *ReachReportCompatibleFields `json:"reachReportCompatibleFields,omitempty"`
-
- // ReportCompatibleFields: Contains items that are compatible to be
- // selected for a report of type "STANDARD".
- ReportCompatibleFields *ReportCompatibleFields `json:"reportCompatibleFields,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "CrossDimensionReachReportCompatibleFields") to unconditionally
- // include in API requests. By default, fields with empty values are
- // omitted from API requests. However, any non-pointer, non-interface
- // field appearing in ForceSendFields will be sent to the server
- // regardless of whether the field is empty or not. This may be used to
- // include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CompatibleFields) MarshalJSON() ([]byte, error) {
- type noMethod CompatibleFields
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ConnectionType: Contains information about an internet connection
-// type that can be targeted by ads. Clients can use the connection type
-// to target mobile vs. broadband users.
-type ConnectionType struct {
- // Id: ID of this connection type.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#connectionType".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this connection type.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ConnectionType) MarshalJSON() ([]byte, error) {
- type noMethod ConnectionType
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ConnectionTypesListResponse: Connection Type List Response
-type ConnectionTypesListResponse struct {
- // ConnectionTypes: Collection of connection types such as broadband and
- // mobile.
- ConnectionTypes []*ConnectionType `json:"connectionTypes,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#connectionTypesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ConnectionTypes") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ConnectionTypesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod ConnectionTypesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ContentCategoriesListResponse: Content Category List Response
-type ContentCategoriesListResponse struct {
- // ContentCategories: Content category collection.
- ContentCategories []*ContentCategory `json:"contentCategories,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#contentCategoriesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "ContentCategories")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ContentCategoriesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod ContentCategoriesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ContentCategory: Organizes placements according to the contents of
-// their associated webpages.
-type ContentCategory struct {
- // AccountId: Account ID of this content category. This is a read-only
- // field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Id: ID of this content category. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#contentCategory".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this content category. This is a required field and
- // must be less than 256 characters long and unique among content
- // categories of the same account.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ContentCategory) MarshalJSON() ([]byte, error) {
- type noMethod ContentCategory
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CountriesListResponse: Country List Response
-type CountriesListResponse struct {
- // Countries: Country collection.
- Countries []*Country `json:"countries,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#countriesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Countries") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CountriesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod CountriesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Country: Contains information about a country that can be targeted by
-// ads.
-type Country struct {
- // CountryCode: Country code.
- CountryCode string `json:"countryCode,omitempty"`
-
- // DartId: DART ID of this country. This is the ID used for targeting
- // and generating reports.
- DartId int64 `json:"dartId,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#country".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this country.
- Name string `json:"name,omitempty"`
-
- // SslEnabled: Whether ad serving supports secure servers in this
- // country.
- SslEnabled bool `json:"sslEnabled,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CountryCode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Country) MarshalJSON() ([]byte, error) {
- type noMethod Country
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Creative: Contains properties of a Creative.
-type Creative struct {
- // AccountId: Account ID of this creative. This field, if left unset,
- // will be auto-generated for both insert and update operations.
- // Applicable to all creative types.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Active: Whether the creative is active. Applicable to all creative
- // types.
- Active bool `json:"active,omitempty"`
-
- // AdParameters: Ad parameters user for VPAID creative. This is a
- // read-only field. Applicable to the following creative types: all
- // VPAID.
- AdParameters string `json:"adParameters,omitempty"`
-
- // AdTagKeys: Keywords for a Rich Media creative. Keywords let you
- // customize the creative settings of a Rich Media ad running on your
- // site without having to contact the advertiser. You can use keywords
- // to dynamically change the look or functionality of a creative.
- // Applicable to the following creative types: all RICH_MEDIA, and all
- // VPAID.
- AdTagKeys []string `json:"adTagKeys,omitempty"`
-
- // AdvertiserId: Advertiser ID of this creative. This is a required
- // field. Applicable to all creative types.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AllowScriptAccess: Whether script access is allowed for this
- // creative. This is a read-only and deprecated field which will
- // automatically be set to true on update. Applicable to the following
- // creative types: FLASH_INPAGE.
- AllowScriptAccess bool `json:"allowScriptAccess,omitempty"`
-
- // Archived: Whether the creative is archived. Applicable to all
- // creative types.
- Archived bool `json:"archived,omitempty"`
-
- // ArtworkType: Type of artwork used for the creative. This is a
- // read-only field. Applicable to the following creative types: all
- // RICH_MEDIA, and all VPAID.
- //
- // Possible values:
- // "ARTWORK_TYPE_FLASH"
- // "ARTWORK_TYPE_HTML5"
- // "ARTWORK_TYPE_MIXED"
- ArtworkType string `json:"artworkType,omitempty"`
-
- // AuthoringTool: Authoring tool for HTML5 banner creatives. This is a
- // read-only field. Applicable to the following creative types:
- // HTML5_BANNER.
- //
- // Possible values:
- // "NINJA"
- // "SWIFFY"
- AuthoringTool string `json:"authoringTool,omitempty"`
-
- // AutoAdvanceImages: Whether images are automatically advanced for
- // enhanced image creatives. Applicable to the following creative types:
- // ENHANCED_IMAGE.
- AutoAdvanceImages bool `json:"auto_advance_images,omitempty"`
-
- // BackgroundColor: The 6-character HTML color code, beginning with #,
- // for the background of the window area where the Flash file is
- // displayed. Default is white. Applicable to the following creative
- // types: FLASH_INPAGE.
- BackgroundColor string `json:"backgroundColor,omitempty"`
-
- // BackupImageClickThroughUrl: Click-through URL for backup image.
- // Applicable to the following creative types: ENHANCED_BANNER,
- // FLASH_INPAGE, and HTML5_BANNER.
- BackupImageClickThroughUrl string `json:"backupImageClickThroughUrl,omitempty"`
-
- // BackupImageFeatures: List of feature dependencies that will cause a
- // backup image to be served if the browser that serves the ad does not
- // support them. Feature dependencies are features that a browser must
- // be able to support in order to render your HTML5 creative asset
- // correctly. This field is initially auto-generated to contain all
- // features detected by DCM for all the assets of this creative and can
- // then be modified by the client. To reset this field, copy over all
- // the creativeAssets' detected features. Applicable to the following
- // creative types: ENHANCED_BANNER and HTML5_BANNER.
- //
- // Possible values:
- // "APPLICATION_CACHE"
- // "AUDIO"
- // "CANVAS"
- // "CANVAS_TEXT"
- // "CSS_ANIMATIONS"
- // "CSS_BACKGROUND_SIZE"
- // "CSS_BORDER_IMAGE"
- // "CSS_BORDER_RADIUS"
- // "CSS_BOX_SHADOW"
- // "CSS_COLUMNS"
- // "CSS_FLEX_BOX"
- // "CSS_FONT_FACE"
- // "CSS_GENERATED_CONTENT"
- // "CSS_GRADIENTS"
- // "CSS_HSLA"
- // "CSS_MULTIPLE_BGS"
- // "CSS_OPACITY"
- // "CSS_REFLECTIONS"
- // "CSS_RGBA"
- // "CSS_TEXT_SHADOW"
- // "CSS_TRANSFORMS"
- // "CSS_TRANSFORMS3D"
- // "CSS_TRANSITIONS"
- // "DRAG_AND_DROP"
- // "GEO_LOCATION"
- // "HASH_CHANGE"
- // "HISTORY"
- // "INDEXED_DB"
- // "INLINE_SVG"
- // "INPUT_ATTR_AUTOCOMPLETE"
- // "INPUT_ATTR_AUTOFOCUS"
- // "INPUT_ATTR_LIST"
- // "INPUT_ATTR_MAX"
- // "INPUT_ATTR_MIN"
- // "INPUT_ATTR_MULTIPLE"
- // "INPUT_ATTR_PATTERN"
- // "INPUT_ATTR_PLACEHOLDER"
- // "INPUT_ATTR_REQUIRED"
- // "INPUT_ATTR_STEP"
- // "INPUT_TYPE_COLOR"
- // "INPUT_TYPE_DATE"
- // "INPUT_TYPE_DATETIME"
- // "INPUT_TYPE_DATETIME_LOCAL"
- // "INPUT_TYPE_EMAIL"
- // "INPUT_TYPE_MONTH"
- // "INPUT_TYPE_NUMBER"
- // "INPUT_TYPE_RANGE"
- // "INPUT_TYPE_SEARCH"
- // "INPUT_TYPE_TEL"
- // "INPUT_TYPE_TIME"
- // "INPUT_TYPE_URL"
- // "INPUT_TYPE_WEEK"
- // "LOCAL_STORAGE"
- // "POST_MESSAGE"
- // "SESSION_STORAGE"
- // "SMIL"
- // "SVG_CLIP_PATHS"
- // "SVG_FE_IMAGE"
- // "SVG_FILTERS"
- // "SVG_HREF"
- // "TOUCH"
- // "VIDEO"
- // "WEBGL"
- // "WEB_SOCKETS"
- // "WEB_SQL_DATABASE"
- // "WEB_WORKERS"
- BackupImageFeatures []string `json:"backupImageFeatures,omitempty"`
-
- // BackupImageReportingLabel: Reporting label used for HTML5 banner
- // backup image. Applicable to the following creative types:
- // ENHANCED_BANNER.
- BackupImageReportingLabel string `json:"backupImageReportingLabel,omitempty"`
-
- // BackupImageTargetWindow: Target window for backup image. Applicable
- // to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and
- // HTML5_BANNER.
- BackupImageTargetWindow *TargetWindow `json:"backupImageTargetWindow,omitempty"`
-
- // ClickTags: Click tags of the creative. For ENHANCED_BANNER,
- // FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of
- // detected click tags for the assets associated with this creative.
- // After creating a flash asset, detected click tags will be returned in
- // the creativeAssetMetadata. When inserting the creative, populate the
- // creative clickTags field using the creativeAssetMetadata.clickTags
- // field. For ENHANCED_IMAGE creatives, there should be exactly one
- // entry in this list for each image creative asset. A click tag is
- // matched with a corresponding creative asset by matching the
- // clickTag.name field with the creativeAsset.assetIdentifier.name
- // field. Applicable to the following creative types: ENHANCED_BANNER,
- // ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
- ClickTags []*ClickTag `json:"clickTags,omitempty"`
-
- // CommercialId: Industry standard ID assigned to creative for reach and
- // frequency. Applicable to the following creative types: INSTREAM_VIDEO
- // and all VPAID.
- CommercialId string `json:"commercialId,omitempty"`
-
- // CompanionCreatives: List of companion creatives assigned to an
- // in-Stream videocreative. Acceptable values include IDs of existing
- // flash and image creatives. Applicable to the following creative
- // types: INSTREAM_VIDEO and all VPAID.
- CompanionCreatives googleapi.Int64s `json:"companionCreatives,omitempty"`
-
- // Compatibility: Compatibilities associated with this creative. This is
- // a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either
- // on desktop or on mobile devices for regular or interstitial ads,
- // respectively. APP and APP_INTERSTITIAL are for rendering in mobile
- // apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads
- // developed with the VAST standard. Applicable to all creative
- // types.
- //
- // Acceptable values are:
- // - "APP"
- // - "APP_INTERSTITIAL"
- // - "IN_STREAM_VIDEO"
- // - "WEB"
- // - "WEB_INTERSTITIAL"
- //
- // Possible values:
- // "APP"
- // "APP_INTERSTITIAL"
- // "IN_STREAM_VIDEO"
- // "WEB"
- // "WEB_INTERSTITIAL"
- Compatibility []string `json:"compatibility,omitempty"`
-
- // ConvertFlashToHtml5: Whether Flash assets associated with the
- // creative need to be automatically converted to HTML5. This flag is
- // enabled by default and users can choose to disable it if they don't
- // want the system to generate and use HTML5 asset for this creative.
- // Applicable to the following creative types: ENHANCED_BANNER and
- // FLASH_INPAGE.
- ConvertFlashToHtml5 bool `json:"convertFlashToHtml5,omitempty"`
-
- // CounterCustomEvents: List of counter events configured for the
- // creative. Applicable to the following creative types: all RICH_MEDIA,
- // and all VPAID.
- CounterCustomEvents []*CreativeCustomEvent `json:"counterCustomEvents,omitempty"`
-
- // CreativeAssets: Assets associated with a creative. Applicable to all
- // but the following creative types: INTERNAL_REDIRECT,
- // INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- CreativeAssets []*CreativeAsset `json:"creativeAssets,omitempty"`
-
- // CreativeFieldAssignments: Creative field assignments for this
- // creative. Applicable to all creative types.
- CreativeFieldAssignments []*CreativeFieldAssignment `json:"creativeFieldAssignments,omitempty"`
-
- // CustomKeyValues: Custom key-values for a Rich Media creative.
- // Key-values let you customize the creative settings of a Rich Media ad
- // running on your site without having to contact the advertiser. You
- // can use key-values to dynamically change the look or functionality of
- // a creative. Applicable to the following creative types: all
- // RICH_MEDIA, and all VPAID.
- CustomKeyValues []string `json:"customKeyValues,omitempty"`
-
- // ExitCustomEvents: List of exit events configured for the creative.
- // Applicable to the following creative types: all RICH_MEDIA, and all
- // VPAID.
- ExitCustomEvents []*CreativeCustomEvent `json:"exitCustomEvents,omitempty"`
-
- // FsCommand: OpenWindow FSCommand of this creative. This lets the SWF
- // file communicate with either Flash Player or the program hosting
- // Flash Player, such as a web browser. This is only triggered if
- // allowScriptAccess field is true. Applicable to the following creative
- // types: FLASH_INPAGE.
- FsCommand *FsCommand `json:"fsCommand,omitempty"`
-
- // HtmlCode: HTML code for the creative. This is a required field when
- // applicable. This field is ignored if htmlCodeLocked is false.
- // Applicable to the following creative types: all CUSTOM, FLASH_INPAGE,
- // and HTML5_BANNER, and all RICH_MEDIA.
- HtmlCode string `json:"htmlCode,omitempty"`
-
- // HtmlCodeLocked: Whether HTML code is DCM-generated or manually
- // entered. Set to true to ignore changes to htmlCode. Applicable to the
- // following creative types: FLASH_INPAGE and HTML5_BANNER.
- HtmlCodeLocked bool `json:"htmlCodeLocked,omitempty"`
-
- // Id: ID of this creative. This is a read-only, auto-generated field.
- // Applicable to all creative types.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this creative. This
- // is a read-only field. Applicable to all creative types.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#creative".
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedInfo: Creative last modification information. This is a
- // read-only field. Applicable to all creative types.
- LastModifiedInfo *LastModifiedInfo `json:"lastModifiedInfo,omitempty"`
-
- // LatestTraffickedCreativeId: Latest Studio trafficked creative ID
- // associated with rich media and VPAID creatives. This is a read-only
- // field. Applicable to the following creative types: all RICH_MEDIA,
- // and all VPAID.
- LatestTraffickedCreativeId int64 `json:"latestTraffickedCreativeId,omitempty,string"`
-
- // Name: Name of the creative. This is a required field and must be less
- // than 256 characters long. Applicable to all creative types.
- Name string `json:"name,omitempty"`
-
- // OverrideCss: Override CSS value for rich media creatives. Applicable
- // to the following creative types: all RICH_MEDIA.
- OverrideCss string `json:"overrideCss,omitempty"`
-
- // RedirectUrl: URL of hosted image or another ad tag. This is a
- // required field when applicable. Applicable to the following creative
- // types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and
- // REDIRECT
- RedirectUrl string `json:"redirectUrl,omitempty"`
-
- // RenderingId: ID of current rendering version. This is a read-only
- // field. Applicable to all creative types.
- RenderingId int64 `json:"renderingId,omitempty,string"`
-
- // RenderingIdDimensionValue: Dimension value for the rendering ID of
- // this creative. This is a read-only field. Applicable to all creative
- // types.
- RenderingIdDimensionValue *DimensionValue `json:"renderingIdDimensionValue,omitempty"`
-
- // RequiredFlashPluginVersion: The minimum required Flash plugin version
- // for this creative. For example, 11.2.202.235. This is a read-only
- // field. Applicable to the following creative types: all RICH_MEDIA,
- // and all VPAID.
- RequiredFlashPluginVersion string `json:"requiredFlashPluginVersion,omitempty"`
-
- // RequiredFlashVersion: The internal Flash version for this creative as
- // calculated by DoubleClick Studio. This is a read-only field.
- // Applicable to the following creative types: FLASH_INPAGE,
- // ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- RequiredFlashVersion int64 `json:"requiredFlashVersion,omitempty"`
-
- // Size: Size associated with this creative. When inserting or updating
- // a creative either the size ID field or size width and height fields
- // can be used. This is a required field when applicable; however for
- // IMAGE and FLASH_INPAGE creatives, if left blank, this field will be
- // automatically set using the actual size of the associated image
- // assets. Applicable to the following creative types: ENHANCED_BANNER,
- // ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all
- // RICH_MEDIA.
- Size *Size `json:"size,omitempty"`
-
- // Skippable: Whether the user can choose to skip the creative.
- // Applicable to the following creative types: INSTREAM_VIDEO.
- Skippable bool `json:"skippable,omitempty"`
-
- // SslCompliant: Whether the creative is SSL-compliant. This is a
- // read-only field. Applicable to all creative types.
- SslCompliant bool `json:"sslCompliant,omitempty"`
-
- // SslOverride: Whether creative should be treated as SSL compliant even
- // if the system scan shows it's not.
- SslOverride bool `json:"sslOverride,omitempty"`
-
- // StudioAdvertiserId: Studio advertiser ID associated with rich media
- // and VPAID creatives. This is a read-only field. Applicable to the
- // following creative types: all RICH_MEDIA, and all VPAID.
- StudioAdvertiserId int64 `json:"studioAdvertiserId,omitempty,string"`
-
- // StudioCreativeId: Studio creative ID associated with rich media and
- // VPAID creatives. This is a read-only field. Applicable to the
- // following creative types: all RICH_MEDIA, and all VPAID.
- StudioCreativeId int64 `json:"studioCreativeId,omitempty,string"`
-
- // StudioTraffickedCreativeId: Studio trafficked creative ID associated
- // with rich media and VPAID creatives. This is a read-only field.
- // Applicable to the following creative types: all RICH_MEDIA, and all
- // VPAID.
- StudioTraffickedCreativeId int64 `json:"studioTraffickedCreativeId,omitempty,string"`
-
- // SubaccountId: Subaccount ID of this creative. This field, if left
- // unset, will be auto-generated for both insert and update operations.
- // Applicable to all creative types.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // ThirdPartyBackupImageImpressionsUrl: Third-party URL used to record
- // backup image impressions. Applicable to the following creative types:
- // all RICH_MEDIA
- ThirdPartyBackupImageImpressionsUrl string `json:"thirdPartyBackupImageImpressionsUrl,omitempty"`
-
- // ThirdPartyRichMediaImpressionsUrl: Third-party URL used to record
- // rich media impressions. Applicable to the following creative types:
- // all RICH_MEDIA
- ThirdPartyRichMediaImpressionsUrl string `json:"thirdPartyRichMediaImpressionsUrl,omitempty"`
-
- // ThirdPartyUrls: Third-party URLs for tracking in-stream video
- // creative events. Applicable to the following creative types:
- // INSTREAM_VIDEO and all VPAID.
- ThirdPartyUrls []*ThirdPartyTrackingUrl `json:"thirdPartyUrls,omitempty"`
-
- // TimerCustomEvents: List of timer events configured for the creative.
- // Applicable to the following creative types: all RICH_MEDIA, and all
- // VPAID.
- TimerCustomEvents []*CreativeCustomEvent `json:"timerCustomEvents,omitempty"`
-
- // TotalFileSize: Combined size of all creative assets. This is a
- // read-only field. Applicable to the following creative types: all
- // RICH_MEDIA, and all VPAID.
- TotalFileSize int64 `json:"totalFileSize,omitempty,string"`
-
- // Type: Type of this creative.This is a required field. Applicable to
- // all creative types.
- //
- // Possible values:
- // "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO"
- // "CUSTOM_INPAGE"
- // "CUSTOM_INTERSTITIAL"
- // "ENHANCED_BANNER"
- // "ENHANCED_IMAGE"
- // "FLASH_INPAGE"
- // "HTML5_BANNER"
- // "IMAGE"
- // "INSTREAM_VIDEO"
- // "INTERNAL_REDIRECT"
- // "INTERSTITIAL_INTERNAL_REDIRECT"
- // "REDIRECT"
- // "RICH_MEDIA_EXPANDING"
- // "RICH_MEDIA_IM_EXPAND"
- // "RICH_MEDIA_INPAGE"
- // "RICH_MEDIA_INPAGE_FLOATING"
- // "RICH_MEDIA_INTERSTITIAL_FLOAT"
- // "RICH_MEDIA_MOBILE_IN_APP"
- // "RICH_MEDIA_MULTI_FLOATING"
- // "RICH_MEDIA_PEEL_DOWN"
- // "TRACKING_TEXT"
- // "VAST_REDIRECT"
- // "VPAID_LINEAR"
- // "VPAID_NON_LINEAR"
- Type string `json:"type,omitempty"`
-
- // Version: The version number helps you keep track of multiple versions
- // of your creative in your reports. The version number will always be
- // auto-generated during insert operations to start at 1. For tracking
- // creatives the version cannot be incremented and will always remain at
- // 1. For all other creative types the version can be incremented only
- // by 1 during update operations. In addition, the version will be
- // automatically incremented by 1 when undergoing Rich Media creative
- // merging. Applicable to all creative types.
- Version int64 `json:"version,omitempty"`
-
- // VideoDescription: Description of the video ad. Applicable to the
- // following creative types: INSTREAM_VIDEO and all VPAID.
- VideoDescription string `json:"videoDescription,omitempty"`
-
- // VideoDuration: Creative video duration in seconds. This is a
- // read-only field. Applicable to the following creative types:
- // INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
- VideoDuration float64 `json:"videoDuration,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Creative) MarshalJSON() ([]byte, error) {
- type noMethod Creative
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeAsset: Creative Asset.
-type CreativeAsset struct {
- // ActionScript3: Whether ActionScript3 is enabled for the flash asset.
- // This is a read-only field. Applicable to the following creative
- // types: FLASH_INPAGE and ENHANCED_BANNER.
- ActionScript3 bool `json:"actionScript3,omitempty"`
-
- // Active: Whether the video asset is active. This is a read-only field
- // for VPAID_NON_LINEAR assets. Applicable to the following creative
- // types: INSTREAM_VIDEO and all VPAID.
- Active bool `json:"active,omitempty"`
-
- // Alignment: Possible alignments for an asset. This is a read-only
- // field. Applicable to the following creative types:
- // RICH_MEDIA_MULTI_FLOATING.
- //
- // Possible values:
- // "ALIGNMENT_BOTTOM"
- // "ALIGNMENT_LEFT"
- // "ALIGNMENT_RIGHT"
- // "ALIGNMENT_TOP"
- Alignment string `json:"alignment,omitempty"`
-
- // ArtworkType: Artwork type of rich media creative. This is a read-only
- // field. Applicable to the following creative types: all RICH_MEDIA.
- //
- // Possible values:
- // "ARTWORK_TYPE_FLASH"
- // "ARTWORK_TYPE_HTML5"
- // "ARTWORK_TYPE_MIXED"
- ArtworkType string `json:"artworkType,omitempty"`
-
- // AssetIdentifier: Identifier of this asset. This is the same
- // identifier returned during creative asset insert operation. This is a
- // required field. Applicable to all but the following creative types:
- // all REDIRECT and TRACKING_TEXT.
- AssetIdentifier *CreativeAssetId `json:"assetIdentifier,omitempty"`
-
- // BackupImageExit: Exit event configured for the backup image.
- // Applicable to the following creative types: all RICH_MEDIA.
- BackupImageExit *CreativeCustomEvent `json:"backupImageExit,omitempty"`
-
- // BitRate: Detected bit-rate for video asset. This is a read-only
- // field. Applicable to the following creative types: INSTREAM_VIDEO and
- // all VPAID.
- BitRate int64 `json:"bitRate,omitempty"`
-
- // ChildAssetType: Rich media child asset type. This is a read-only
- // field. Applicable to the following creative types: all VPAID.
- //
- // Possible values:
- // "CHILD_ASSET_TYPE_DATA"
- // "CHILD_ASSET_TYPE_FLASH"
- // "CHILD_ASSET_TYPE_IMAGE"
- // "CHILD_ASSET_TYPE_VIDEO"
- ChildAssetType string `json:"childAssetType,omitempty"`
-
- // CollapsedSize: Size of an asset when collapsed. This is a read-only
- // field. Applicable to the following creative types: all RICH_MEDIA and
- // all VPAID. Additionally, applicable to assets whose displayType is
- // ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- CollapsedSize *Size `json:"collapsedSize,omitempty"`
-
- // CustomStartTimeValue: Custom start time in seconds for making the
- // asset visible. Applicable to the following creative types: all
- // RICH_MEDIA.
- CustomStartTimeValue int64 `json:"customStartTimeValue,omitempty"`
-
- // DetectedFeatures: List of feature dependencies for the creative asset
- // that are detected by DCM. Feature dependencies are features that a
- // browser must be able to support in order to render your HTML5
- // creative correctly. This is a read-only, auto-generated field.
- // Applicable to the following creative types: ENHANCED_BANNER and
- // HTML5_BANNER.
- //
- // Possible values:
- // "APPLICATION_CACHE"
- // "AUDIO"
- // "CANVAS"
- // "CANVAS_TEXT"
- // "CSS_ANIMATIONS"
- // "CSS_BACKGROUND_SIZE"
- // "CSS_BORDER_IMAGE"
- // "CSS_BORDER_RADIUS"
- // "CSS_BOX_SHADOW"
- // "CSS_COLUMNS"
- // "CSS_FLEX_BOX"
- // "CSS_FONT_FACE"
- // "CSS_GENERATED_CONTENT"
- // "CSS_GRADIENTS"
- // "CSS_HSLA"
- // "CSS_MULTIPLE_BGS"
- // "CSS_OPACITY"
- // "CSS_REFLECTIONS"
- // "CSS_RGBA"
- // "CSS_TEXT_SHADOW"
- // "CSS_TRANSFORMS"
- // "CSS_TRANSFORMS3D"
- // "CSS_TRANSITIONS"
- // "DRAG_AND_DROP"
- // "GEO_LOCATION"
- // "HASH_CHANGE"
- // "HISTORY"
- // "INDEXED_DB"
- // "INLINE_SVG"
- // "INPUT_ATTR_AUTOCOMPLETE"
- // "INPUT_ATTR_AUTOFOCUS"
- // "INPUT_ATTR_LIST"
- // "INPUT_ATTR_MAX"
- // "INPUT_ATTR_MIN"
- // "INPUT_ATTR_MULTIPLE"
- // "INPUT_ATTR_PATTERN"
- // "INPUT_ATTR_PLACEHOLDER"
- // "INPUT_ATTR_REQUIRED"
- // "INPUT_ATTR_STEP"
- // "INPUT_TYPE_COLOR"
- // "INPUT_TYPE_DATE"
- // "INPUT_TYPE_DATETIME"
- // "INPUT_TYPE_DATETIME_LOCAL"
- // "INPUT_TYPE_EMAIL"
- // "INPUT_TYPE_MONTH"
- // "INPUT_TYPE_NUMBER"
- // "INPUT_TYPE_RANGE"
- // "INPUT_TYPE_SEARCH"
- // "INPUT_TYPE_TEL"
- // "INPUT_TYPE_TIME"
- // "INPUT_TYPE_URL"
- // "INPUT_TYPE_WEEK"
- // "LOCAL_STORAGE"
- // "POST_MESSAGE"
- // "SESSION_STORAGE"
- // "SMIL"
- // "SVG_CLIP_PATHS"
- // "SVG_FE_IMAGE"
- // "SVG_FILTERS"
- // "SVG_HREF"
- // "TOUCH"
- // "VIDEO"
- // "WEBGL"
- // "WEB_SOCKETS"
- // "WEB_SQL_DATABASE"
- // "WEB_WORKERS"
- DetectedFeatures []string `json:"detectedFeatures,omitempty"`
-
- // DisplayType: Type of rich media asset. This is a read-only field.
- // Applicable to the following creative types: all RICH_MEDIA.
- //
- // Possible values:
- // "ASSET_DISPLAY_TYPE_EXPANDING"
- // "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH"
- // "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH_EXPANDING"
- // "ASSET_DISPLAY_TYPE_FLOATING"
- // "ASSET_DISPLAY_TYPE_INPAGE"
- // "ASSET_DISPLAY_TYPE_OVERLAY"
- // "ASSET_DISPLAY_TYPE_PEEL_DOWN"
- // "ASSET_DISPLAY_TYPE_VPAID_LINEAR"
- // "ASSET_DISPLAY_TYPE_VPAID_NON_LINEAR"
- DisplayType string `json:"displayType,omitempty"`
-
- // Duration: Duration in seconds for which an asset will be displayed.
- // Applicable to the following creative types: INSTREAM_VIDEO and
- // VPAID_LINEAR.
- Duration int64 `json:"duration,omitempty"`
-
- // DurationType: Duration type for which an asset will be displayed.
- // Applicable to the following creative types: all RICH_MEDIA.
- //
- // Possible values:
- // "ASSET_DURATION_TYPE_AUTO"
- // "ASSET_DURATION_TYPE_CUSTOM"
- // "ASSET_DURATION_TYPE_NONE"
- DurationType string `json:"durationType,omitempty"`
-
- // ExpandedDimension: Detected expanded dimension for video asset. This
- // is a read-only field. Applicable to the following creative types:
- // INSTREAM_VIDEO and all VPAID.
- ExpandedDimension *Size `json:"expandedDimension,omitempty"`
-
- // FileSize: File size associated with this creative asset. This is a
- // read-only field. Applicable to all but the following creative types:
- // all REDIRECT and TRACKING_TEXT.
- FileSize int64 `json:"fileSize,omitempty,string"`
-
- // FlashVersion: Flash version of the asset. This is a read-only field.
- // Applicable to the following creative types: FLASH_INPAGE,
- // ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- FlashVersion int64 `json:"flashVersion,omitempty"`
-
- // HideFlashObjects: Whether to hide Flash objects flag for an asset.
- // Applicable to the following creative types: all RICH_MEDIA.
- HideFlashObjects bool `json:"hideFlashObjects,omitempty"`
-
- // HideSelectionBoxes: Whether to hide selection boxes flag for an
- // asset. Applicable to the following creative types: all RICH_MEDIA.
- HideSelectionBoxes bool `json:"hideSelectionBoxes,omitempty"`
-
- // HorizontallyLocked: Whether the asset is horizontally locked. This is
- // a read-only field. Applicable to the following creative types: all
- // RICH_MEDIA.
- HorizontallyLocked bool `json:"horizontallyLocked,omitempty"`
-
- // Id: Numeric ID of this creative asset. This is a required field and
- // should not be modified. Applicable to all but the following creative
- // types: all REDIRECT and TRACKING_TEXT.
- Id int64 `json:"id,omitempty,string"`
-
- // MimeType: Detected MIME type for video asset. This is a read-only
- // field. Applicable to the following creative types: INSTREAM_VIDEO and
- // all VPAID.
- MimeType string `json:"mimeType,omitempty"`
-
- // Offset: Offset position for an asset in collapsed mode. This is a
- // read-only field. Applicable to the following creative types: all
- // RICH_MEDIA and all VPAID. Additionally, only applicable to assets
- // whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or
- // ASSET_DISPLAY_TYPE_PEEL_DOWN.
- Offset *OffsetPosition `json:"offset,omitempty"`
-
- // OriginalBackup: Whether the backup asset is original or changed by
- // the user in DCM. Applicable to the following creative types: all
- // RICH_MEDIA.
- OriginalBackup bool `json:"originalBackup,omitempty"`
-
- // Position: Offset position for an asset. Applicable to the following
- // creative types: all RICH_MEDIA.
- Position *OffsetPosition `json:"position,omitempty"`
-
- // PositionLeftUnit: Offset left unit for an asset. This is a read-only
- // field. Applicable to the following creative types: all RICH_MEDIA.
- //
- // Possible values:
- // "OFFSET_UNIT_PERCENT"
- // "OFFSET_UNIT_PIXEL"
- // "OFFSET_UNIT_PIXEL_FROM_CENTER"
- PositionLeftUnit string `json:"positionLeftUnit,omitempty"`
-
- // PositionTopUnit: Offset top unit for an asset. This is a read-only
- // field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY.
- // Applicable to the following creative types: all RICH_MEDIA.
- //
- // Possible values:
- // "OFFSET_UNIT_PERCENT"
- // "OFFSET_UNIT_PIXEL"
- // "OFFSET_UNIT_PIXEL_FROM_CENTER"
- PositionTopUnit string `json:"positionTopUnit,omitempty"`
-
- // ProgressiveServingUrl: Progressive URL for video asset. This is a
- // read-only field. Applicable to the following creative types:
- // INSTREAM_VIDEO and all VPAID.
- ProgressiveServingUrl string `json:"progressiveServingUrl,omitempty"`
-
- // Pushdown: Whether the asset pushes down other content. Applicable to
- // the following creative types: all RICH_MEDIA. Additionally, only
- // applicable when the asset offsets are 0, the collapsedSize.width
- // matches size.width, and the collapsedSize.height is less than
- // size.height.
- Pushdown bool `json:"pushdown,omitempty"`
-
- // PushdownDuration: Pushdown duration in seconds for an asset. Must be
- // between 0 and 9.99. Applicable to the following creative types: all
- // RICH_MEDIA.Additionally, only applicable when the asset pushdown
- // field is true, the offsets are 0, the collapsedSize.width matches
- // size.width, and the collapsedSize.height is less than size.height.
- PushdownDuration float64 `json:"pushdownDuration,omitempty"`
-
- // Role: Role of the asset in relation to creative. Applicable to all
- // but the following creative types: all REDIRECT and TRACKING_TEXT.
- // This is a required field.
- // PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER,
- // IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple
- // primary assets), and all VPAID creatives.
- // BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER,
- // all RICH_MEDIA, and all VPAID creatives.
- // ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE
- // creatives.
- // OTHER refers to assets from sources other than DCM, such as Studio
- // uploaded assets, applicable to all RICH_MEDIA and all VPAID
- // creatives.
- // PARENT_VIDEO refers to videos uploaded by the user in DCM and is
- // applicable to INSTREAM_VIDEO and VPAID_LINEAR
- // creatives.
- // TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO
- // assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR
- // creatives.
- // ALTERNATE_VIDEO refers to the DCM representation of child asset
- // videos from Studio, and is applicable to VPAID_LINEAR creatives.
- // These cannot be added or removed within DCM.
- // For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and
- // ALTERNATE_VIDEO assets that are marked active serve as backup in case
- // the VPAID creative cannot be served. Only PARENT_VIDEO assets can be
- // added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
- //
- // Possible values:
- // "ADDITIONAL_FLASH"
- // "ADDITIONAL_IMAGE"
- // "ALTERNATE_VIDEO"
- // "BACKUP_IMAGE"
- // "OTHER"
- // "PARENT_VIDEO"
- // "PRIMARY"
- // "TRANSCODED_VIDEO"
- Role string `json:"role,omitempty"`
-
- // Size: Size associated with this creative asset. This is a required
- // field when applicable; however for IMAGE and FLASH_INPAGE creatives,
- // if left blank, this field will be automatically set using the actual
- // size of the associated image asset. Applicable to the following
- // creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE,
- // HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- Size *Size `json:"size,omitempty"`
-
- // SslCompliant: Whether the asset is SSL-compliant. This is a read-only
- // field. Applicable to all but the following creative types: all
- // REDIRECT and TRACKING_TEXT.
- SslCompliant bool `json:"sslCompliant,omitempty"`
-
- // StartTimeType: Initial wait time type before making the asset
- // visible. Applicable to the following creative types: all RICH_MEDIA.
- //
- // Possible values:
- // "ASSET_START_TIME_TYPE_CUSTOM"
- // "ASSET_START_TIME_TYPE_NONE"
- StartTimeType string `json:"startTimeType,omitempty"`
-
- // StreamingServingUrl: Streaming URL for video asset. This is a
- // read-only field. Applicable to the following creative types:
- // INSTREAM_VIDEO and all VPAID.
- StreamingServingUrl string `json:"streamingServingUrl,omitempty"`
-
- // Transparency: Whether the asset is transparent. Applicable to the
- // following creative types: all RICH_MEDIA. Additionally, only
- // applicable to HTML5 assets.
- Transparency bool `json:"transparency,omitempty"`
-
- // VerticallyLocked: Whether the asset is vertically locked. This is a
- // read-only field. Applicable to the following creative types: all
- // RICH_MEDIA.
- VerticallyLocked bool `json:"verticallyLocked,omitempty"`
-
- // VideoDuration: Detected video duration for video asset. This is a
- // read-only field. Applicable to the following creative types:
- // INSTREAM_VIDEO and all VPAID.
- VideoDuration float64 `json:"videoDuration,omitempty"`
-
- // WindowMode: Window mode options for flash assets. Applicable to the
- // following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING,
- // RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and
- // RICH_MEDIA_INPAGE_FLOATING.
- //
- // Possible values:
- // "OPAQUE"
- // "TRANSPARENT"
- // "WINDOW"
- WindowMode string `json:"windowMode,omitempty"`
-
- // ZIndex: zIndex value of an asset. This is a read-only field.
- // Applicable to the following creative types: all
- // RICH_MEDIA.Additionally, only applicable to assets whose displayType
- // is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or
- // ASSET_DISPLAY_TYPE_OVERLAY.
- ZIndex int64 `json:"zIndex,omitempty"`
-
- // ZipFilename: File name of zip file. This is a read-only field.
- // Applicable to the following creative types: HTML5_BANNER.
- ZipFilename string `json:"zipFilename,omitempty"`
-
- // ZipFilesize: Size of zip file. This is a read-only field. Applicable
- // to the following creative types: HTML5_BANNER.
- ZipFilesize string `json:"zipFilesize,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ActionScript3") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeAsset) MarshalJSON() ([]byte, error) {
- type noMethod CreativeAsset
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeAssetId: Creative Asset ID.
-type CreativeAssetId struct {
- // Name: Name of the creative asset. This is a required field while
- // inserting an asset. After insertion, this assetIdentifier is used to
- // identify the uploaded asset. Characters in the name must be
- // alphanumeric or one of the following: ".-_ ". Spaces are allowed.
- Name string `json:"name,omitempty"`
-
- // Type: Type of asset to upload. This is a required field. IMAGE is
- // solely used for IMAGE creatives. Other image assets should use
- // HTML_IMAGE.
- //
- // Possible values:
- // "FLASH"
- // "HTML"
- // "HTML_IMAGE"
- // "IMAGE"
- // "VIDEO"
- Type string `json:"type,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Name") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeAssetId) MarshalJSON() ([]byte, error) {
- type noMethod CreativeAssetId
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeAssetMetadata: CreativeAssets contains properties of a
-// creative asset file which will be uploaded or has already been
-// uploaded. Refer to the creative sample code for how to upload assets
-// and insert a creative.
-type CreativeAssetMetadata struct {
- // AssetIdentifier: ID of the creative asset. This is a required field.
- AssetIdentifier *CreativeAssetId `json:"assetIdentifier,omitempty"`
-
- // ClickTags: List of detected click tags for assets. This is a
- // read-only auto-generated field.
- ClickTags []*ClickTag `json:"clickTags,omitempty"`
-
- // DetectedFeatures: List of feature dependencies for the creative asset
- // that are detected by DCM. Feature dependencies are features that a
- // browser must be able to support in order to render your HTML5
- // creative correctly. This is a read-only, auto-generated field.
- //
- // Possible values:
- // "APPLICATION_CACHE"
- // "AUDIO"
- // "CANVAS"
- // "CANVAS_TEXT"
- // "CSS_ANIMATIONS"
- // "CSS_BACKGROUND_SIZE"
- // "CSS_BORDER_IMAGE"
- // "CSS_BORDER_RADIUS"
- // "CSS_BOX_SHADOW"
- // "CSS_COLUMNS"
- // "CSS_FLEX_BOX"
- // "CSS_FONT_FACE"
- // "CSS_GENERATED_CONTENT"
- // "CSS_GRADIENTS"
- // "CSS_HSLA"
- // "CSS_MULTIPLE_BGS"
- // "CSS_OPACITY"
- // "CSS_REFLECTIONS"
- // "CSS_RGBA"
- // "CSS_TEXT_SHADOW"
- // "CSS_TRANSFORMS"
- // "CSS_TRANSFORMS3D"
- // "CSS_TRANSITIONS"
- // "DRAG_AND_DROP"
- // "GEO_LOCATION"
- // "HASH_CHANGE"
- // "HISTORY"
- // "INDEXED_DB"
- // "INLINE_SVG"
- // "INPUT_ATTR_AUTOCOMPLETE"
- // "INPUT_ATTR_AUTOFOCUS"
- // "INPUT_ATTR_LIST"
- // "INPUT_ATTR_MAX"
- // "INPUT_ATTR_MIN"
- // "INPUT_ATTR_MULTIPLE"
- // "INPUT_ATTR_PATTERN"
- // "INPUT_ATTR_PLACEHOLDER"
- // "INPUT_ATTR_REQUIRED"
- // "INPUT_ATTR_STEP"
- // "INPUT_TYPE_COLOR"
- // "INPUT_TYPE_DATE"
- // "INPUT_TYPE_DATETIME"
- // "INPUT_TYPE_DATETIME_LOCAL"
- // "INPUT_TYPE_EMAIL"
- // "INPUT_TYPE_MONTH"
- // "INPUT_TYPE_NUMBER"
- // "INPUT_TYPE_RANGE"
- // "INPUT_TYPE_SEARCH"
- // "INPUT_TYPE_TEL"
- // "INPUT_TYPE_TIME"
- // "INPUT_TYPE_URL"
- // "INPUT_TYPE_WEEK"
- // "LOCAL_STORAGE"
- // "POST_MESSAGE"
- // "SESSION_STORAGE"
- // "SMIL"
- // "SVG_CLIP_PATHS"
- // "SVG_FE_IMAGE"
- // "SVG_FILTERS"
- // "SVG_HREF"
- // "TOUCH"
- // "VIDEO"
- // "WEBGL"
- // "WEB_SOCKETS"
- // "WEB_SQL_DATABASE"
- // "WEB_WORKERS"
- DetectedFeatures []string `json:"detectedFeatures,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#creativeAssetMetadata".
- Kind string `json:"kind,omitempty"`
-
- // WarnedValidationRules: Rules validated during code generation that
- // generated a warning. This is a read-only, auto-generated
- // field.
- //
- // Possible values are:
- // - "CLICK_TAG_NON_TOP_LEVEL"
- // - "CLICK_TAG_MISSING"
- // - "CLICK_TAG_MORE_THAN_ONE"
- // - "CLICK_TAG_INVALID"
- // - "ORPHANED_ASSET"
- // - "PRIMARY_HTML_MISSING"
- // - "EXTERNAL_FILE_REFERENCED"
- // - "MRAID_REFERENCED"
- // - "ADMOB_REFERENCED"
- // - "FILE_TYPE_INVALID"
- // - "ZIP_INVALID"
- // - "LINKED_FILE_NOT_FOUND"
- // - "MAX_FLASH_VERSION_11"
- // - "NOT_SSL_COMPLIANT"
- // - "FILE_DETAIL_EMPTY"
- // - "ASSET_INVALID"
- // - "GWD_PROPERTIES_INVALID"
- // - "ENABLER_UNSUPPORTED_METHOD_DCM"
- // - "ASSET_FORMAT_UNSUPPORTED_DCM"
- // - "COMPONENT_UNSUPPORTED_DCM"
- // - "HTML5_FEATURE_UNSUPPORTED' "
- //
- // Possible values:
- // "ADMOB_REFERENCED"
- // "ASSET_FORMAT_UNSUPPORTED_DCM"
- // "ASSET_INVALID"
- // "CLICK_TAG_INVALID"
- // "CLICK_TAG_MISSING"
- // "CLICK_TAG_MORE_THAN_ONE"
- // "CLICK_TAG_NON_TOP_LEVEL"
- // "COMPONENT_UNSUPPORTED_DCM"
- // "ENABLER_UNSUPPORTED_METHOD_DCM"
- // "EXTERNAL_FILE_REFERENCED"
- // "FILE_DETAIL_EMPTY"
- // "FILE_TYPE_INVALID"
- // "GWD_PROPERTIES_INVALID"
- // "HTML5_FEATURE_UNSUPPORTED"
- // "LINKED_FILE_NOT_FOUND"
- // "MAX_FLASH_VERSION_11"
- // "MRAID_REFERENCED"
- // "NOT_SSL_COMPLIANT"
- // "ORPHANED_ASSET"
- // "PRIMARY_HTML_MISSING"
- // "ZIP_INVALID"
- WarnedValidationRules []string `json:"warnedValidationRules,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AssetIdentifier") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeAssetMetadata) MarshalJSON() ([]byte, error) {
- type noMethod CreativeAssetMetadata
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeAssignment: Creative Assignment.
-type CreativeAssignment struct {
- // Active: Whether this creative assignment is active. When true, the
- // creative will be included in the ad's rotation.
- Active bool `json:"active,omitempty"`
-
- // ApplyEventTags: Whether applicable event tags should fire when this
- // creative assignment is rendered. If this value is unset when the ad
- // is inserted or updated, it will default to true for all creative
- // types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT,
- // and INSTREAM_VIDEO.
- ApplyEventTags bool `json:"applyEventTags,omitempty"`
-
- // ClickThroughUrl: Click-through URL of the creative assignment.
- ClickThroughUrl *ClickThroughUrl `json:"clickThroughUrl,omitempty"`
-
- // CompanionCreativeOverrides: Companion creative overrides for this
- // creative assignment. Applicable to video ads.
- CompanionCreativeOverrides []*CompanionClickThroughOverride `json:"companionCreativeOverrides,omitempty"`
-
- // CreativeGroupAssignments: Creative group assignments for this
- // creative assignment. Only one assignment per creative group number is
- // allowed for a maximum of two assignments.
- CreativeGroupAssignments []*CreativeGroupAssignment `json:"creativeGroupAssignments,omitempty"`
-
- // CreativeId: ID of the creative to be assigned. This is a required
- // field.
- CreativeId int64 `json:"creativeId,omitempty,string"`
-
- // CreativeIdDimensionValue: Dimension value for the ID of the creative.
- // This is a read-only, auto-generated field.
- CreativeIdDimensionValue *DimensionValue `json:"creativeIdDimensionValue,omitempty"`
-
- // EndTime: Date and time that the assigned creative should stop
- // serving. Must be later than the start time.
- EndTime string `json:"endTime,omitempty"`
-
- // RichMediaExitOverrides: Rich media exit overrides for this creative
- // assignment.
- // Applicable when the creative type is any of the following:
- // - RICH_MEDIA_INPAGE
- // - RICH_MEDIA_INPAGE_FLOATING
- // - RICH_MEDIA_IM_EXPAND
- // - RICH_MEDIA_EXPANDING
- // - RICH_MEDIA_INTERSTITIAL_FLOAT
- // - RICH_MEDIA_MOBILE_IN_APP
- // - RICH_MEDIA_MULTI_FLOATING
- // - RICH_MEDIA_PEEL_DOWN
- // - ADVANCED_BANNER
- // - VPAID_LINEAR
- // - VPAID_NON_LINEAR
- RichMediaExitOverrides []*RichMediaExitOverride `json:"richMediaExitOverrides,omitempty"`
-
- // Sequence: Sequence number of the creative assignment, applicable when
- // the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
- Sequence int64 `json:"sequence,omitempty"`
-
- // SslCompliant: Whether the creative to be assigned is SSL-compliant.
- // This is a read-only field that is auto-generated when the ad is
- // inserted or updated.
- SslCompliant bool `json:"sslCompliant,omitempty"`
-
- // StartTime: Date and time that the assigned creative should start
- // serving.
- StartTime string `json:"startTime,omitempty"`
-
- // Weight: Weight of the creative assignment, applicable when the
- // rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
- Weight int64 `json:"weight,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Active") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeAssignment) MarshalJSON() ([]byte, error) {
- type noMethod CreativeAssignment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeCustomEvent: Creative Custom Event.
-type CreativeCustomEvent struct {
- // AdvertiserCustomEventName: User-entered name for the event.
- AdvertiserCustomEventName string `json:"advertiserCustomEventName,omitempty"`
-
- // AdvertiserCustomEventType: Type of the event. This is a read-only
- // field.
- //
- // Possible values:
- // "ADVERTISER_EVENT_COUNTER"
- // "ADVERTISER_EVENT_EXIT"
- // "ADVERTISER_EVENT_TIMER"
- AdvertiserCustomEventType string `json:"advertiserCustomEventType,omitempty"`
-
- // ArtworkLabel: Artwork label column, used to link events in DCM back
- // to events in Studio. This is a required field and should not be
- // modified after insertion.
- ArtworkLabel string `json:"artworkLabel,omitempty"`
-
- // ArtworkType: Artwork type used by the creative.This is a read-only
- // field.
- //
- // Possible values:
- // "ARTWORK_TYPE_FLASH"
- // "ARTWORK_TYPE_HTML5"
- // "ARTWORK_TYPE_MIXED"
- ArtworkType string `json:"artworkType,omitempty"`
-
- // ExitUrl: Exit URL of the event. This field is used only for exit
- // events.
- ExitUrl string `json:"exitUrl,omitempty"`
-
- // Id: ID of this event. This is a required field and should not be
- // modified after insertion.
- Id int64 `json:"id,omitempty,string"`
-
- // PopupWindowProperties: Properties for rich media popup windows. This
- // field is used only for exit events.
- PopupWindowProperties *PopupWindowProperties `json:"popupWindowProperties,omitempty"`
-
- // TargetType: Target type used by the event.
- //
- // Possible values:
- // "TARGET_BLANK"
- // "TARGET_PARENT"
- // "TARGET_POPUP"
- // "TARGET_SELF"
- // "TARGET_TOP"
- TargetType string `json:"targetType,omitempty"`
-
- // VideoReportingId: Reporting ID, used to differentiate multiple videos
- // in a single creative.
- VideoReportingId string `json:"videoReportingId,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "AdvertiserCustomEventName") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeCustomEvent) MarshalJSON() ([]byte, error) {
- type noMethod CreativeCustomEvent
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeField: Contains properties of a creative field.
-type CreativeField struct {
- // AccountId: Account ID of this creative field. This is a read-only
- // field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this creative field. This is a
- // required field on insertion.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // Id: ID of this creative field. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#creativeField".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this creative field. This is a required field and must
- // be less than 256 characters long and unique among creative fields of
- // the same advertiser.
- Name string `json:"name,omitempty"`
-
- // SubaccountId: Subaccount ID of this creative field. This is a
- // read-only field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeField) MarshalJSON() ([]byte, error) {
- type noMethod CreativeField
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeFieldAssignment: Creative Field Assignment.
-type CreativeFieldAssignment struct {
- // CreativeFieldId: ID of the creative field.
- CreativeFieldId int64 `json:"creativeFieldId,omitempty,string"`
-
- // CreativeFieldValueId: ID of the creative field value.
- CreativeFieldValueId int64 `json:"creativeFieldValueId,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "CreativeFieldId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeFieldAssignment) MarshalJSON() ([]byte, error) {
- type noMethod CreativeFieldAssignment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeFieldValue: Contains properties of a creative field value.
-type CreativeFieldValue struct {
- // Id: ID of this creative field value. This is a read-only,
- // auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#creativeFieldValue".
- Kind string `json:"kind,omitempty"`
-
- // Value: Value of this creative field value. It needs to be less than
- // 256 characters in length and unique per creative field.
- Value string `json:"value,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeFieldValue) MarshalJSON() ([]byte, error) {
- type noMethod CreativeFieldValue
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeFieldValuesListResponse: Creative Field Value List Response
-type CreativeFieldValuesListResponse struct {
- // CreativeFieldValues: Creative field value collection.
- CreativeFieldValues []*CreativeFieldValue `json:"creativeFieldValues,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#creativeFieldValuesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreativeFieldValues")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeFieldValuesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod CreativeFieldValuesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeFieldsListResponse: Creative Field List Response
-type CreativeFieldsListResponse struct {
- // CreativeFields: Creative field collection.
- CreativeFields []*CreativeField `json:"creativeFields,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#creativeFieldsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreativeFields") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeFieldsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod CreativeFieldsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeGroup: Contains properties of a creative group.
-type CreativeGroup struct {
- // AccountId: Account ID of this creative group. This is a read-only
- // field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this creative group. This is a
- // required field on insertion.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // GroupNumber: Subgroup of the creative group. Assign your creative
- // groups to one of the following subgroups in order to filter or manage
- // them more easily. This field is required on insertion and is
- // read-only after insertion.
- // Acceptable values are:
- // - 1
- // - 2
- GroupNumber int64 `json:"groupNumber,omitempty"`
-
- // Id: ID of this creative group. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#creativeGroup".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this creative group. This is a required field and must
- // be less than 256 characters long and unique among creative groups of
- // the same advertiser.
- Name string `json:"name,omitempty"`
-
- // SubaccountId: Subaccount ID of this creative group. This is a
- // read-only field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeGroup) MarshalJSON() ([]byte, error) {
- type noMethod CreativeGroup
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeGroupAssignment: Creative Group Assignment.
-type CreativeGroupAssignment struct {
- // CreativeGroupId: ID of the creative group to be assigned.
- CreativeGroupId int64 `json:"creativeGroupId,omitempty,string"`
-
- // CreativeGroupNumber: Creative group number of the creative group
- // assignment.
- //
- // Possible values:
- // "CREATIVE_GROUP_ONE"
- // "CREATIVE_GROUP_TWO"
- CreativeGroupNumber string `json:"creativeGroupNumber,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CreativeGroupId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeGroupAssignment) MarshalJSON() ([]byte, error) {
- type noMethod CreativeGroupAssignment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeGroupsListResponse: Creative Group List Response
-type CreativeGroupsListResponse struct {
- // CreativeGroups: Creative group collection.
- CreativeGroups []*CreativeGroup `json:"creativeGroups,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#creativeGroupsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CreativeGroups") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeGroupsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod CreativeGroupsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeOptimizationConfiguration: Creative optimization settings.
-type CreativeOptimizationConfiguration struct {
- // Id: ID of this creative optimization config. This field is
- // auto-generated when the campaign is inserted or updated. It can be
- // null for existing campaigns.
- Id int64 `json:"id,omitempty,string"`
-
- // Name: Name of this creative optimization config. This is a required
- // field and must be less than 129 characters long.
- Name string `json:"name,omitempty"`
-
- // OptimizationActivitys: List of optimization activities associated
- // with this configuration.
- OptimizationActivitys []*OptimizationActivity `json:"optimizationActivitys,omitempty"`
-
- // OptimizationModel: Optimization model for this configuration.
- //
- // Possible values:
- // "CLICK"
- // "POST_CLICK"
- // "POST_CLICK_AND_IMPRESSION"
- // "POST_IMPRESSION"
- OptimizationModel string `json:"optimizationModel,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeOptimizationConfiguration) MarshalJSON() ([]byte, error) {
- type noMethod CreativeOptimizationConfiguration
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeRotation: Creative Rotation.
-type CreativeRotation struct {
- // CreativeAssignments: Creative assignments in this creative rotation.
- CreativeAssignments []*CreativeAssignment `json:"creativeAssignments,omitempty"`
-
- // CreativeOptimizationConfigurationId: Creative optimization
- // configuration that is used by this ad. It should refer to one of the
- // existing optimization configurations in the ad's campaign. If it is
- // unset or set to 0, then the campaign's default optimization
- // configuration will be used for this ad.
- CreativeOptimizationConfigurationId int64 `json:"creativeOptimizationConfigurationId,omitempty,string"`
-
- // Type: Type of creative rotation. Can be used to specify whether to
- // use sequential or random rotation.
- //
- // Possible values:
- // "CREATIVE_ROTATION_TYPE_RANDOM"
- // "CREATIVE_ROTATION_TYPE_SEQUENTIAL"
- Type string `json:"type,omitempty"`
-
- // WeightCalculationStrategy: Strategy for calculating weights. Used
- // with CREATIVE_ROTATION_TYPE_RANDOM.
- //
- // Possible values:
- // "WEIGHT_STRATEGY_CUSTOM"
- // "WEIGHT_STRATEGY_EQUAL"
- // "WEIGHT_STRATEGY_HIGHEST_CTR"
- // "WEIGHT_STRATEGY_OPTIMIZED"
- WeightCalculationStrategy string `json:"weightCalculationStrategy,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CreativeAssignments")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeRotation) MarshalJSON() ([]byte, error) {
- type noMethod CreativeRotation
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativeSettings: Creative Settings
-type CreativeSettings struct {
- // IFrameFooter: Header text for iFrames for this site. Must be less
- // than or equal to 2000 characters long.
- IFrameFooter string `json:"iFrameFooter,omitempty"`
-
- // IFrameHeader: Header text for iFrames for this site. Must be less
- // than or equal to 2000 characters long.
- IFrameHeader string `json:"iFrameHeader,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "IFrameFooter") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativeSettings) MarshalJSON() ([]byte, error) {
- type noMethod CreativeSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CreativesListResponse: Creative List Response
-type CreativesListResponse struct {
- // Creatives: Creative collection.
- Creatives []*Creative `json:"creatives,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#creativesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Creatives") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CreativesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod CreativesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CrossDimensionReachReportCompatibleFields: Represents fields that are
-// compatible to be selected for a report of type
-// "CROSS_DIMENSION_REACH".
-type CrossDimensionReachReportCompatibleFields struct {
- // Breakdown: Dimensions which are compatible to be selected in the
- // "breakdown" section of the report.
- Breakdown []*Dimension `json:"breakdown,omitempty"`
-
- // DimensionFilters: Dimensions which are compatible to be selected in
- // the "dimensionFilters" section of the report.
- DimensionFilters []*Dimension `json:"dimensionFilters,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#crossDimensionReachReportCompatibleFields.
- Kind string `json:"kind,omitempty"`
-
- // Metrics: Metrics which are compatible to be selected in the
- // "metricNames" section of the report.
- Metrics []*Metric `json:"metrics,omitempty"`
-
- // OverlapMetrics: Metrics which are compatible to be selected in the
- // "overlapMetricNames" section of the report.
- OverlapMetrics []*Metric `json:"overlapMetrics,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Breakdown") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CrossDimensionReachReportCompatibleFields) MarshalJSON() ([]byte, error) {
- type noMethod CrossDimensionReachReportCompatibleFields
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// CustomRichMediaEvents: Represents a Custom Rich Media Events group.
-type CustomRichMediaEvents struct {
- // FilteredEventIds: List of custom rich media event IDs. Dimension
- // values must be all of type dfa:richMediaEventTypeIdAndName.
- FilteredEventIds []*DimensionValue `json:"filteredEventIds,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#customRichMediaEvents.
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "FilteredEventIds") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *CustomRichMediaEvents) MarshalJSON() ([]byte, error) {
- type noMethod CustomRichMediaEvents
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DateRange: Represents a date range.
-type DateRange struct {
- // EndDate: The end date of the date range, inclusive. A string of the
- // format: "yyyy-MM-dd".
- EndDate string `json:"endDate,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#dateRange.
- Kind string `json:"kind,omitempty"`
-
- // RelativeDateRange: The date range relative to the date of when the
- // report is run.
- //
- // Possible values:
- // "LAST_24_MONTHS"
- // "LAST_30_DAYS"
- // "LAST_365_DAYS"
- // "LAST_7_DAYS"
- // "LAST_90_DAYS"
- // "MONTH_TO_DATE"
- // "PREVIOUS_MONTH"
- // "PREVIOUS_QUARTER"
- // "PREVIOUS_WEEK"
- // "PREVIOUS_YEAR"
- // "QUARTER_TO_DATE"
- // "TODAY"
- // "WEEK_TO_DATE"
- // "YEAR_TO_DATE"
- // "YESTERDAY"
- RelativeDateRange string `json:"relativeDateRange,omitempty"`
-
- // StartDate: The start date of the date range, inclusive. A string of
- // the format: "yyyy-MM-dd".
- StartDate string `json:"startDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "EndDate") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DateRange) MarshalJSON() ([]byte, error) {
- type noMethod DateRange
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DayPartTargeting: Day Part Targeting.
-type DayPartTargeting struct {
- // DaysOfWeek: Days of the week when the ad will serve.
- //
- // Acceptable values are:
- // - "SUNDAY"
- // - "MONDAY"
- // - "TUESDAY"
- // - "WEDNESDAY"
- // - "THURSDAY"
- // - "FRIDAY"
- // - "SATURDAY"
- //
- // Possible values:
- // "FRIDAY"
- // "MONDAY"
- // "SATURDAY"
- // "SUNDAY"
- // "THURSDAY"
- // "TUESDAY"
- // "WEDNESDAY"
- DaysOfWeek []string `json:"daysOfWeek,omitempty"`
-
- // HoursOfDay: Hours of the day when the ad will serve. Must be an
- // integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM,
- // and 23 is 11 PM to midnight. Can be specified with days of week, in
- // which case the ad would serve during these hours on the specified
- // days. For example, if Monday, Wednesday, Friday are the days of week
- // specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the
- // ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
- HoursOfDay []int64 `json:"hoursOfDay,omitempty"`
-
- // UserLocalTime: Whether or not to use the user's local time. If false,
- // the America/New York time zone applies.
- UserLocalTime bool `json:"userLocalTime,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DaysOfWeek") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DayPartTargeting) MarshalJSON() ([]byte, error) {
- type noMethod DayPartTargeting
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DefaultClickThroughEventTagProperties: Properties of inheriting and
-// overriding the default click-through event tag. A campaign may
-// override the event tag defined at the advertiser level, and an ad may
-// also override the campaign's setting further.
-type DefaultClickThroughEventTagProperties struct {
- // DefaultClickThroughEventTagId: ID of the click-through event tag to
- // apply to all ads in this entity's scope.
- DefaultClickThroughEventTagId int64 `json:"defaultClickThroughEventTagId,omitempty,string"`
-
- // OverrideInheritedEventTag: Whether this entity should override the
- // inherited default click-through event tag with its own defined value.
- OverrideInheritedEventTag bool `json:"overrideInheritedEventTag,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "DefaultClickThroughEventTagId") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DefaultClickThroughEventTagProperties) MarshalJSON() ([]byte, error) {
- type noMethod DefaultClickThroughEventTagProperties
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DeliverySchedule: Delivery Schedule.
-type DeliverySchedule struct {
- // FrequencyCap: Limit on the number of times an individual user can be
- // served the ad within a specified period of time.
- FrequencyCap *FrequencyCap `json:"frequencyCap,omitempty"`
-
- // HardCutoff: Whether or not hard cutoff is enabled. If true, the ad
- // will not serve after the end date and time. Otherwise the ad will
- // continue to be served until it has reached its delivery goals.
- HardCutoff bool `json:"hardCutoff,omitempty"`
-
- // ImpressionRatio: Impression ratio for this ad. This ratio determines
- // how often each ad is served relative to the others. For example, if
- // ad A has an impression ratio of 1 and ad B has an impression ratio of
- // 3, then DCM will serve ad B three times as often as ad A. Must be
- // between 1 and 10.
- ImpressionRatio int64 `json:"impressionRatio,omitempty,string"`
-
- // Priority: Serving priority of an ad, with respect to other ads. The
- // lower the priority number, the greater the priority with which it is
- // served.
- //
- // Possible values:
- // "AD_PRIORITY_01"
- // "AD_PRIORITY_02"
- // "AD_PRIORITY_03"
- // "AD_PRIORITY_04"
- // "AD_PRIORITY_05"
- // "AD_PRIORITY_06"
- // "AD_PRIORITY_07"
- // "AD_PRIORITY_08"
- // "AD_PRIORITY_09"
- // "AD_PRIORITY_10"
- // "AD_PRIORITY_11"
- // "AD_PRIORITY_12"
- // "AD_PRIORITY_13"
- // "AD_PRIORITY_14"
- // "AD_PRIORITY_15"
- // "AD_PRIORITY_16"
- Priority string `json:"priority,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "FrequencyCap") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DeliverySchedule) MarshalJSON() ([]byte, error) {
- type noMethod DeliverySchedule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DfpSettings: DFP Settings
-type DfpSettings struct {
- // DfpNetworkCode: DFP network code for this directory site.
- DfpNetworkCode string `json:"dfp_network_code,omitempty"`
-
- // DfpNetworkName: DFP network name for this directory site.
- DfpNetworkName string `json:"dfp_network_name,omitempty"`
-
- // ProgrammaticPlacementAccepted: Whether this directory site accepts
- // programmatic placements.
- ProgrammaticPlacementAccepted bool `json:"programmaticPlacementAccepted,omitempty"`
-
- // PubPaidPlacementAccepted: Whether this directory site accepts
- // publisher-paid tags.
- PubPaidPlacementAccepted bool `json:"pubPaidPlacementAccepted,omitempty"`
-
- // PublisherPortalOnly: Whether this directory site is available only
- // via DoubleClick Publisher Portal.
- PublisherPortalOnly bool `json:"publisherPortalOnly,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DfpNetworkCode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DfpSettings) MarshalJSON() ([]byte, error) {
- type noMethod DfpSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Dimension: Represents a dimension.
-type Dimension struct {
- // Kind: The kind of resource this is, in this case
- // dfareporting#dimension.
- Kind string `json:"kind,omitempty"`
-
- // Name: The dimension name, e.g. dfa:advertiser
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Dimension) MarshalJSON() ([]byte, error) {
- type noMethod Dimension
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DimensionFilter: Represents a dimension filter.
-type DimensionFilter struct {
- // DimensionName: The name of the dimension to filter.
- DimensionName string `json:"dimensionName,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#dimensionFilter.
- Kind string `json:"kind,omitempty"`
-
- // Value: The value of the dimension to filter.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DimensionFilter) MarshalJSON() ([]byte, error) {
- type noMethod DimensionFilter
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DimensionValue: Represents a DimensionValue resource.
-type DimensionValue struct {
- // DimensionName: The name of the dimension.
- DimensionName string `json:"dimensionName,omitempty"`
-
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Id: The ID associated with the value if available.
- Id string `json:"id,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#dimensionValue.
- Kind string `json:"kind,omitempty"`
-
- // MatchType: Determines how the 'value' field is matched when
- // filtering. If not specified, defaults to EXACT. If set to
- // WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable
- // length character sequences, and it can be escaped with a backslash.
- // Note, only paid search dimensions ('dfa:paidSearch*') allow a
- // matchType other than EXACT.
- //
- // Possible values:
- // "BEGINS_WITH"
- // "CONTAINS"
- // "EXACT"
- // "WILDCARD_EXPRESSION"
- MatchType string `json:"matchType,omitempty"`
-
- // Value: The value of the dimension.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DimensionValue) MarshalJSON() ([]byte, error) {
- type noMethod DimensionValue
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DimensionValueList: Represents the list of DimensionValue resources.
-type DimensionValueList struct {
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The dimension values returned in this response.
- Items []*DimensionValue `json:"items,omitempty"`
-
- // Kind: The kind of list this is, in this case
- // dfareporting#dimensionValueList.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through dimension
- // values. To retrieve the next page of results, set the next request's
- // "pageToken" to the value of this field. The page token is only valid
- // for a limited amount of time and should not be persisted.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DimensionValueList) MarshalJSON() ([]byte, error) {
- type noMethod DimensionValueList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DimensionValueRequest: Represents a DimensionValuesRequest.
-type DimensionValueRequest struct {
- // DimensionName: The name of the dimension for which values should be
- // requested.
- DimensionName string `json:"dimensionName,omitempty"`
-
- // EndDate: The end date of the date range for which to retrieve
- // dimension values. A string of the format "yyyy-MM-dd".
- EndDate string `json:"endDate,omitempty"`
-
- // Filters: The list of filters by which to filter values. The filters
- // are ANDed.
- Filters []*DimensionFilter `json:"filters,omitempty"`
-
- // Kind: The kind of request this is, in this case
- // dfareporting#dimensionValueRequest.
- Kind string `json:"kind,omitempty"`
-
- // StartDate: The start date of the date range for which to retrieve
- // dimension values. A string of the format "yyyy-MM-dd".
- StartDate string `json:"startDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionName") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DimensionValueRequest) MarshalJSON() ([]byte, error) {
- type noMethod DimensionValueRequest
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DirectorySite: DirectorySites contains properties of a website from
-// the Site Directory. Sites need to be added to an account via the
-// Sites resource before they can be assigned to a placement.
-type DirectorySite struct {
- // Active: Whether this directory site is active.
- Active bool `json:"active,omitempty"`
-
- // ContactAssignments: Directory site contacts.
- ContactAssignments []*DirectorySiteContactAssignment `json:"contactAssignments,omitempty"`
-
- // CountryId: Country ID of this directory site.
- CountryId int64 `json:"countryId,omitempty,string"`
-
- // CurrencyId: Currency ID of this directory site.
- // Possible values are:
- // - "1" for USD
- // - "2" for GBP
- // - "3" for ESP
- // - "4" for SEK
- // - "5" for CAD
- // - "6" for JPY
- // - "7" for DEM
- // - "8" for AUD
- // - "9" for FRF
- // - "10" for ITL
- // - "11" for DKK
- // - "12" for NOK
- // - "13" for FIM
- // - "14" for ZAR
- // - "15" for IEP
- // - "16" for NLG
- // - "17" for EUR
- // - "18" for KRW
- // - "19" for TWD
- // - "20" for SGD
- // - "21" for CNY
- // - "22" for HKD
- // - "23" for NZD
- // - "24" for MYR
- // - "25" for BRL
- // - "26" for PTE
- // - "27" for MXP
- // - "28" for CLP
- // - "29" for TRY
- // - "30" for ARS
- // - "31" for PEN
- // - "32" for ILS
- // - "33" for CHF
- // - "34" for VEF
- // - "35" for COP
- // - "36" for GTQ
- CurrencyId int64 `json:"currencyId,omitempty,string"`
-
- // Description: Description of this directory site.
- Description string `json:"description,omitempty"`
-
- // Id: ID of this directory site. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this directory site.
- // This is a read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // InpageTagFormats: Tag types for regular placements.
- //
- // Acceptable values are:
- // - "STANDARD"
- // - "IFRAME_JAVASCRIPT_INPAGE"
- // - "INTERNAL_REDIRECT_INPAGE"
- // - "JAVASCRIPT_INPAGE"
- //
- // Possible values:
- // "IFRAME_JAVASCRIPT_INPAGE"
- // "INTERNAL_REDIRECT_INPAGE"
- // "JAVASCRIPT_INPAGE"
- // "STANDARD"
- InpageTagFormats []string `json:"inpageTagFormats,omitempty"`
-
- // InterstitialTagFormats: Tag types for interstitial
- // placements.
- //
- // Acceptable values are:
- // - "IFRAME_JAVASCRIPT_INTERSTITIAL"
- // - "INTERNAL_REDIRECT_INTERSTITIAL"
- // - "JAVASCRIPT_INTERSTITIAL"
- //
- // Possible values:
- // "IFRAME_JAVASCRIPT_INTERSTITIAL"
- // "INTERNAL_REDIRECT_INTERSTITIAL"
- // "JAVASCRIPT_INTERSTITIAL"
- InterstitialTagFormats []string `json:"interstitialTagFormats,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#directorySite".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this directory site.
- Name string `json:"name,omitempty"`
-
- // ParentId: Parent directory site ID.
- ParentId int64 `json:"parentId,omitempty,string"`
-
- // Settings: Directory site settings.
- Settings *DirectorySiteSettings `json:"settings,omitempty"`
-
- // Url: URL of this directory site.
- Url string `json:"url,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Active") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DirectorySite) MarshalJSON() ([]byte, error) {
- type noMethod DirectorySite
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DirectorySiteContact: Contains properties of a Site Directory
-// contact.
-type DirectorySiteContact struct {
- // Address: Address of this directory site contact.
- Address string `json:"address,omitempty"`
-
- // Email: Email address of this directory site contact.
- Email string `json:"email,omitempty"`
-
- // FirstName: First name of this directory site contact.
- FirstName string `json:"firstName,omitempty"`
-
- // Id: ID of this directory site contact. This is a read-only,
- // auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#directorySiteContact".
- Kind string `json:"kind,omitempty"`
-
- // LastName: Last name of this directory site contact.
- LastName string `json:"lastName,omitempty"`
-
- // Phone: Phone number of this directory site contact.
- Phone string `json:"phone,omitempty"`
-
- // Role: Directory site contact role.
- //
- // Possible values:
- // "ADMIN"
- // "EDIT"
- // "VIEW"
- Role string `json:"role,omitempty"`
-
- // Title: Title or designation of this directory site contact.
- Title string `json:"title,omitempty"`
-
- // Type: Directory site contact type.
- //
- // Possible values:
- // "BILLING"
- // "OTHER"
- // "SALES"
- // "TECHNICAL"
- Type string `json:"type,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Address") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DirectorySiteContact) MarshalJSON() ([]byte, error) {
- type noMethod DirectorySiteContact
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DirectorySiteContactAssignment: Directory Site Contact Assignment
-type DirectorySiteContactAssignment struct {
- // ContactId: ID of this directory site contact. This is a read-only,
- // auto-generated field.
- ContactId int64 `json:"contactId,omitempty,string"`
-
- // Visibility: Visibility of this directory site contact assignment.
- // When set to PUBLIC this contact assignment is visible to all account
- // and agency users; when set to PRIVATE it is visible only to the site.
- //
- // Possible values:
- // "PRIVATE"
- // "PUBLIC"
- Visibility string `json:"visibility,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ContactId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DirectorySiteContactAssignment) MarshalJSON() ([]byte, error) {
- type noMethod DirectorySiteContactAssignment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DirectorySiteContactsListResponse: Directory Site Contact List
-// Response
-type DirectorySiteContactsListResponse struct {
- // DirectorySiteContacts: Directory site contact collection
- DirectorySiteContacts []*DirectorySiteContact `json:"directorySiteContacts,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#directorySiteContactsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "DirectorySiteContacts") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DirectorySiteContactsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod DirectorySiteContactsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DirectorySiteSettings: Directory Site Settings
-type DirectorySiteSettings struct {
- // ActiveViewOptOut: Whether this directory site has disabled active
- // view creatives.
- ActiveViewOptOut bool `json:"activeViewOptOut,omitempty"`
-
- // DfpSettings: Directory site DFP settings.
- DfpSettings *DfpSettings `json:"dfp_settings,omitempty"`
-
- // InstreamVideoPlacementAccepted: Whether this site accepts in-stream
- // video ads.
- InstreamVideoPlacementAccepted bool `json:"instream_video_placement_accepted,omitempty"`
-
- // InterstitialPlacementAccepted: Whether this site accepts interstitial
- // ads.
- InterstitialPlacementAccepted bool `json:"interstitialPlacementAccepted,omitempty"`
-
- // NielsenOcrOptOut: Whether this directory site has disabled Nielsen
- // OCR reach ratings.
- NielsenOcrOptOut bool `json:"nielsenOcrOptOut,omitempty"`
-
- // VerificationTagOptOut: Whether this directory site has disabled
- // generation of Verification ins tags.
- VerificationTagOptOut bool `json:"verificationTagOptOut,omitempty"`
-
- // VideoActiveViewOptOut: Whether this directory site has disabled
- // active view for in-stream video creatives.
- VideoActiveViewOptOut bool `json:"videoActiveViewOptOut,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ActiveViewOptOut") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DirectorySiteSettings) MarshalJSON() ([]byte, error) {
- type noMethod DirectorySiteSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// DirectorySitesListResponse: Directory Site List Response
-type DirectorySitesListResponse struct {
- // DirectorySites: Directory site collection.
- DirectorySites []*DirectorySite `json:"directorySites,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#directorySitesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "DirectorySites") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *DirectorySitesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod DirectorySitesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// EventTag: Contains properties of an event tag.
-type EventTag struct {
- // AccountId: Account ID of this event tag. This is a read-only field
- // that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this event tag. This field or the
- // campaignId field is required on insertion.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // CampaignId: Campaign ID of this event tag. This field or the
- // advertiserId field is required on insertion.
- CampaignId int64 `json:"campaignId,omitempty,string"`
-
- // CampaignIdDimensionValue: Dimension value for the ID of the campaign.
- // This is a read-only, auto-generated field.
- CampaignIdDimensionValue *DimensionValue `json:"campaignIdDimensionValue,omitempty"`
-
- // EnabledByDefault: Whether this event tag should be automatically
- // enabled for all of the advertiser's campaigns and ads.
- EnabledByDefault bool `json:"enabledByDefault,omitempty"`
-
- // ExcludeFromAdxRequests: Whether to remove this event tag from ads
- // that are trafficked through DoubleClick Bid Manager to Ad Exchange.
- // This may be useful if the event tag uses a pixel that is unapproved
- // for Ad Exchange bids on one or more networks, such as the Google
- // Display Network.
- ExcludeFromAdxRequests bool `json:"excludeFromAdxRequests,omitempty"`
-
- // Id: ID of this event tag. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#eventTag".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this event tag. This is a required field and must be
- // less than 256 characters long.
- Name string `json:"name,omitempty"`
-
- // SiteFilterType: Site filter type for this event tag. If no type is
- // specified then the event tag will be applied to all sites.
- //
- // Possible values:
- // "BLACKLIST"
- // "WHITELIST"
- SiteFilterType string `json:"siteFilterType,omitempty"`
-
- // SiteIds: Filter list of site IDs associated with this event tag. The
- // siteFilterType determines whether this is a whitelist or blacklist
- // filter.
- SiteIds googleapi.Int64s `json:"siteIds,omitempty"`
-
- // SslCompliant: Whether this tag is SSL-compliant or not. This is a
- // read-only field.
- SslCompliant bool `json:"sslCompliant,omitempty"`
-
- // Status: Status of this event tag. Must be ENABLED for this event tag
- // to fire. This is a required field.
- //
- // Possible values:
- // "DISABLED"
- // "ENABLED"
- Status string `json:"status,omitempty"`
-
- // SubaccountId: Subaccount ID of this event tag. This is a read-only
- // field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // Type: Event tag type. Can be used to specify whether to use a
- // third-party pixel, a third-party JavaScript URL, or a third-party
- // click-through URL for either impression or click tracking. This is a
- // required field.
- //
- // Possible values:
- // "CLICK_THROUGH_EVENT_TAG"
- // "IMPRESSION_IMAGE_EVENT_TAG"
- // "IMPRESSION_JAVASCRIPT_EVENT_TAG"
- Type string `json:"type,omitempty"`
-
- // Url: Payload URL for this event tag. The URL on a click-through event
- // tag should have a landing page URL appended to the end of it. This
- // field is required on insertion.
- Url string `json:"url,omitempty"`
-
- // UrlEscapeLevels: Number of times the landing page URL should be
- // URL-escaped before being appended to the click-through event tag URL.
- // Only applies to click-through event tags as specified by the event
- // tag type.
- UrlEscapeLevels int64 `json:"urlEscapeLevels,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EventTag) MarshalJSON() ([]byte, error) {
- type noMethod EventTag
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// EventTagOverride: Event tag override information.
-type EventTagOverride struct {
- // Enabled: Whether this override is enabled.
- Enabled bool `json:"enabled,omitempty"`
-
- // Id: ID of this event tag override. This is a read-only,
- // auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "Enabled") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EventTagOverride) MarshalJSON() ([]byte, error) {
- type noMethod EventTagOverride
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// EventTagsListResponse: Event Tag List Response
-type EventTagsListResponse struct {
- // EventTags: Event tag collection.
- EventTags []*EventTag `json:"eventTags,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#eventTagsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "EventTags") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *EventTagsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod EventTagsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// File: Represents a File resource. A file contains the metadata for a
-// report run. It shows the status of the run and holds the URLs to the
-// generated report data if the run is finished and the status is
-// "REPORT_AVAILABLE".
-type File struct {
- // DateRange: The date range for which the file has report data. The
- // date range will always be the absolute date range for which the
- // report is run.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // FileName: The filename of the file.
- FileName string `json:"fileName,omitempty"`
-
- // Format: The output format of the report. Only available once the file
- // is available.
- //
- // Possible values:
- // "CSV"
- // "EXCEL"
- Format string `json:"format,omitempty"`
-
- // Id: The unique ID of this report file.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: The kind of resource this is, in this case dfareporting#file.
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedTime: The timestamp in milliseconds since epoch when this
- // file was last modified.
- LastModifiedTime int64 `json:"lastModifiedTime,omitempty,string"`
-
- // ReportId: The ID of the report this file was generated from.
- ReportId int64 `json:"reportId,omitempty,string"`
-
- // Status: The status of the report file.
- //
- // Possible values:
- // "CANCELLED"
- // "FAILED"
- // "PROCESSING"
- // "REPORT_AVAILABLE"
- Status string `json:"status,omitempty"`
-
- // Urls: The URLs where the completed report file can be downloaded.
- Urls *FileUrls `json:"urls,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "DateRange") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *File) MarshalJSON() ([]byte, error) {
- type noMethod File
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FileUrls: The URLs where the completed report file can be downloaded.
-type FileUrls struct {
- // ApiUrl: The URL for downloading the report data through the API.
- ApiUrl string `json:"apiUrl,omitempty"`
-
- // BrowserUrl: The URL for downloading the report data through a
- // browser.
- BrowserUrl string `json:"browserUrl,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ApiUrl") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FileUrls) MarshalJSON() ([]byte, error) {
- type noMethod FileUrls
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FileList: Represents the list of File resources.
-type FileList struct {
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The files returned in this response.
- Items []*File `json:"items,omitempty"`
-
- // Kind: The kind of list this is, in this case dfareporting#fileList.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through files. To
- // retrieve the next page of results, set the next request's "pageToken"
- // to the value of this field. The page token is only valid for a
- // limited amount of time and should not be persisted.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FileList) MarshalJSON() ([]byte, error) {
- type noMethod FileList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Flight: Flight
-type Flight struct {
- // EndDate: Inventory item flight end date.
- EndDate string `json:"endDate,omitempty"`
-
- // RateOrCost: Rate or cost of this flight.
- RateOrCost int64 `json:"rateOrCost,omitempty,string"`
-
- // StartDate: Inventory item flight start date.
- StartDate string `json:"startDate,omitempty"`
-
- // Units: Units of this flight.
- Units int64 `json:"units,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "EndDate") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Flight) MarshalJSON() ([]byte, error) {
- type noMethod Flight
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightActivitiesGenerateTagResponse: Floodlight Activity
-// GenerateTag Response
-type FloodlightActivitiesGenerateTagResponse struct {
- // FloodlightActivityTag: Generated tag for this floodlight activity.
- FloodlightActivityTag string `json:"floodlightActivityTag,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#floodlightActivitiesGenerateTagResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "FloodlightActivityTag") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightActivitiesGenerateTagResponse) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightActivitiesGenerateTagResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightActivitiesListResponse: Floodlight Activity List Response
-type FloodlightActivitiesListResponse struct {
- // FloodlightActivities: Floodlight activity collection.
- FloodlightActivities []*FloodlightActivity `json:"floodlightActivities,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#floodlightActivitiesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "FloodlightActivities") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightActivitiesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightActivitiesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightActivity: Contains properties of a Floodlight activity.
-type FloodlightActivity struct {
- // AccountId: Account ID of this floodlight activity. This is a
- // read-only field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this floodlight activity. If this
- // field is left blank, the value will be copied over either from the
- // activity group's advertiser or the existing activity's advertiser.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // CacheBustingType: Code type used for cache busting in the generated
- // tag.
- //
- // Possible values:
- // "ACTIVE_SERVER_PAGE"
- // "COLD_FUSION"
- // "JAVASCRIPT"
- // "JSP"
- // "PHP"
- CacheBustingType string `json:"cacheBustingType,omitempty"`
-
- // CountingMethod: Counting method for conversions for this floodlight
- // activity. This is a required field.
- //
- // Possible values:
- // "ITEMS_SOLD_COUNTING"
- // "SESSION_COUNTING"
- // "STANDARD_COUNTING"
- // "TRANSACTIONS_COUNTING"
- // "UNIQUE_COUNTING"
- CountingMethod string `json:"countingMethod,omitempty"`
-
- // DefaultTags: Dynamic floodlight tags.
- DefaultTags []*FloodlightActivityDynamicTag `json:"defaultTags,omitempty"`
-
- // ExpectedUrl: URL where this tag will be deployed. If specified, must
- // be less than 256 characters long.
- ExpectedUrl string `json:"expectedUrl,omitempty"`
-
- // FloodlightActivityGroupId: Floodlight activity group ID of this
- // floodlight activity. This is a required field.
- FloodlightActivityGroupId int64 `json:"floodlightActivityGroupId,omitempty,string"`
-
- // FloodlightActivityGroupName: Name of the associated floodlight
- // activity group. This is a read-only field.
- FloodlightActivityGroupName string `json:"floodlightActivityGroupName,omitempty"`
-
- // FloodlightActivityGroupTagString: Tag string of the associated
- // floodlight activity group. This is a read-only field.
- FloodlightActivityGroupTagString string `json:"floodlightActivityGroupTagString,omitempty"`
-
- // FloodlightActivityGroupType: Type of the associated floodlight
- // activity group. This is a read-only field.
- //
- // Possible values:
- // "COUNTER"
- // "SALE"
- FloodlightActivityGroupType string `json:"floodlightActivityGroupType,omitempty"`
-
- // FloodlightConfigurationId: Floodlight configuration ID of this
- // floodlight activity. If this field is left blank, the value will be
- // copied over either from the activity group's floodlight configuration
- // or from the existing activity's floodlight configuration.
- FloodlightConfigurationId int64 `json:"floodlightConfigurationId,omitempty,string"`
-
- // FloodlightConfigurationIdDimensionValue: Dimension value for the ID
- // of the floodlight configuration. This is a read-only, auto-generated
- // field.
- FloodlightConfigurationIdDimensionValue *DimensionValue `json:"floodlightConfigurationIdDimensionValue,omitempty"`
-
- // Hidden: Whether this activity is archived.
- Hidden bool `json:"hidden,omitempty"`
-
- // Id: ID of this floodlight activity. This is a read-only,
- // auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this floodlight
- // activity. This is a read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // ImageTagEnabled: Whether the image tag is enabled for this activity.
- ImageTagEnabled bool `json:"imageTagEnabled,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#floodlightActivity".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this floodlight activity. This is a required field.
- // Must be less than 129 characters long and cannot contain quotes.
- Name string `json:"name,omitempty"`
-
- // Notes: General notes or implementation instructions for the tag.
- Notes string `json:"notes,omitempty"`
-
- // PublisherTags: Publisher dynamic floodlight tags.
- PublisherTags []*FloodlightActivityPublisherDynamicTag `json:"publisherTags,omitempty"`
-
- // Secure: Whether this tag should use SSL.
- Secure bool `json:"secure,omitempty"`
-
- // SslCompliant: Whether the floodlight activity is SSL-compliant. This
- // is a read-only field, its value detected by the system from the
- // floodlight tags.
- SslCompliant bool `json:"sslCompliant,omitempty"`
-
- // SslRequired: Whether this floodlight activity must be SSL-compliant.
- SslRequired bool `json:"sslRequired,omitempty"`
-
- // SubaccountId: Subaccount ID of this floodlight activity. This is a
- // read-only field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // TagFormat: Tag format type for the floodlight activity. If left
- // blank, the tag format will default to HTML.
- //
- // Possible values:
- // "HTML"
- // "XHTML"
- TagFormat string `json:"tagFormat,omitempty"`
-
- // TagString: Value of the cat= paramter in the floodlight tag, which
- // the ad servers use to identify the activity. This is optional: if
- // empty, a new tag string will be generated for you. This string must
- // be 1 to 8 characters long, with valid characters being
- // [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among
- // activities of the same activity group. This field is read-only after
- // insertion.
- TagString string `json:"tagString,omitempty"`
-
- // UserDefinedVariableTypes: List of the user-defined variables used by
- // this conversion tag. These map to the "u[1-20]=" in the tags. Each of
- // these can have a user defined type.
- // Acceptable values are:
- // - "U1"
- // - "U2"
- // - "U3"
- // - "U4"
- // - "U5"
- // - "U6"
- // - "U7"
- // - "U8"
- // - "U9"
- // - "U10"
- // - "U11"
- // - "U12"
- // - "U13"
- // - "U14"
- // - "U15"
- // - "U16"
- // - "U17"
- // - "U18"
- // - "U19"
- // - "U20"
- //
- // Possible values:
- // "U1"
- // "U10"
- // "U11"
- // "U12"
- // "U13"
- // "U14"
- // "U15"
- // "U16"
- // "U17"
- // "U18"
- // "U19"
- // "U2"
- // "U20"
- // "U3"
- // "U4"
- // "U5"
- // "U6"
- // "U7"
- // "U8"
- // "U9"
- UserDefinedVariableTypes []string `json:"userDefinedVariableTypes,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightActivity) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightActivity
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightActivityDynamicTag: Dynamic Tag
-type FloodlightActivityDynamicTag struct {
- // Id: ID of this dynamic tag. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // Name: Name of this tag.
- Name string `json:"name,omitempty"`
-
- // Tag: Tag code.
- Tag string `json:"tag,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightActivityDynamicTag) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightActivityDynamicTag
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightActivityGroup: Contains properties of a Floodlight activity
-// group.
-type FloodlightActivityGroup struct {
- // AccountId: Account ID of this floodlight activity group. This is a
- // read-only field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this floodlight activity group. If
- // this field is left blank, the value will be copied over either from
- // the floodlight configuration's advertiser or from the existing
- // activity group's advertiser.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // FloodlightConfigurationId: Floodlight configuration ID of this
- // floodlight activity group. This is a required field.
- FloodlightConfigurationId int64 `json:"floodlightConfigurationId,omitempty,string"`
-
- // FloodlightConfigurationIdDimensionValue: Dimension value for the ID
- // of the floodlight configuration. This is a read-only, auto-generated
- // field.
- FloodlightConfigurationIdDimensionValue *DimensionValue `json:"floodlightConfigurationIdDimensionValue,omitempty"`
-
- // Id: ID of this floodlight activity group. This is a read-only,
- // auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this floodlight
- // activity group. This is a read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#floodlightActivityGroup".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this floodlight activity group. This is a required
- // field. Must be less than 65 characters long and cannot contain
- // quotes.
- Name string `json:"name,omitempty"`
-
- // SubaccountId: Subaccount ID of this floodlight activity group. This
- // is a read-only field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // TagString: Value of the type= parameter in the floodlight tag, which
- // the ad servers use to identify the activity group that the activity
- // belongs to. This is optional: if empty, a new tag string will be
- // generated for you. This string must be 1 to 8 characters long, with
- // valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must
- // also be unique among activity groups of the same floodlight
- // configuration. This field is read-only after insertion.
- TagString string `json:"tagString,omitempty"`
-
- // Type: Type of the floodlight activity group. This is a required field
- // that is read-only after insertion.
- //
- // Possible values:
- // "COUNTER"
- // "SALE"
- Type string `json:"type,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightActivityGroup) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightActivityGroup
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightActivityGroupsListResponse: Floodlight Activity Group List
-// Response
-type FloodlightActivityGroupsListResponse struct {
- // FloodlightActivityGroups: Floodlight activity group collection.
- FloodlightActivityGroups []*FloodlightActivityGroup `json:"floodlightActivityGroups,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#floodlightActivityGroupsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "FloodlightActivityGroups") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightActivityGroupsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightActivityGroupsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightActivityPublisherDynamicTag: Publisher Dynamic Tag
-type FloodlightActivityPublisherDynamicTag struct {
- // ClickThrough: Whether this tag is applicable only for click-throughs.
- ClickThrough bool `json:"clickThrough,omitempty"`
-
- // DirectorySiteId: Directory site ID of this dynamic tag. This is a
- // write-only field that can be used as an alternative to the siteId
- // field. When this resource is retrieved, only the siteId field will be
- // populated.
- DirectorySiteId int64 `json:"directorySiteId,omitempty,string"`
-
- // DynamicTag: Dynamic floodlight tag.
- DynamicTag *FloodlightActivityDynamicTag `json:"dynamicTag,omitempty"`
-
- // SiteId: Site ID of this dynamic tag.
- SiteId int64 `json:"siteId,omitempty,string"`
-
- // SiteIdDimensionValue: Dimension value for the ID of the site. This is
- // a read-only, auto-generated field.
- SiteIdDimensionValue *DimensionValue `json:"siteIdDimensionValue,omitempty"`
-
- // ViewThrough: Whether this tag is applicable only for view-throughs.
- ViewThrough bool `json:"viewThrough,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ClickThrough") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightActivityPublisherDynamicTag) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightActivityPublisherDynamicTag
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightConfiguration: Contains properties of a Floodlight
-// configuration.
-type FloodlightConfiguration struct {
- // AccountId: Account ID of this floodlight configuration. This is a
- // read-only field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of the parent advertiser of this
- // floodlight configuration.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // AnalyticsDataSharingEnabled: Whether advertiser data is shared with
- // Google Analytics.
- AnalyticsDataSharingEnabled bool `json:"analyticsDataSharingEnabled,omitempty"`
-
- // ExposureToConversionEnabled: Whether the exposure-to-conversion
- // report is enabled. This report shows detailed pathway information on
- // up to 10 of the most recent ad exposures seen by a user before
- // converting.
- ExposureToConversionEnabled bool `json:"exposureToConversionEnabled,omitempty"`
-
- // FirstDayOfWeek: Day that will be counted as the first day of the week
- // in reports. This is a required field.
- //
- // Possible values:
- // "MONDAY"
- // "SUNDAY"
- FirstDayOfWeek string `json:"firstDayOfWeek,omitempty"`
-
- // Id: ID of this floodlight configuration. This is a read-only,
- // auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this floodlight
- // configuration. This is a read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // InAppAttributionTrackingEnabled: Whether in-app attribution tracking
- // is enabled.
- InAppAttributionTrackingEnabled bool `json:"inAppAttributionTrackingEnabled,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#floodlightConfiguration".
- Kind string `json:"kind,omitempty"`
-
- // LookbackConfiguration: Lookback window settings for this floodlight
- // configuration.
- LookbackConfiguration *LookbackConfiguration `json:"lookbackConfiguration,omitempty"`
-
- // NaturalSearchConversionAttributionOption: Types of attribution
- // options for natural search conversions.
- //
- // Possible values:
- // "EXCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION"
- // "INCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION"
- // "INCLUDE_NATURAL_SEARCH_TIERED_CONVERSION_ATTRIBUTION"
- NaturalSearchConversionAttributionOption string `json:"naturalSearchConversionAttributionOption,omitempty"`
-
- // OmnitureSettings: Settings for DCM Omniture integration.
- OmnitureSettings *OmnitureSettings `json:"omnitureSettings,omitempty"`
-
- // SslRequired: Whether floodlight activities owned by this
- // configuration are required to be SSL-compliant.
- SslRequired bool `json:"sslRequired,omitempty"`
-
- // StandardVariableTypes: List of standard variables enabled for this
- // configuration.
- //
- // Acceptable values are:
- // - "ORD"
- // - "NUM"
- //
- // Possible values:
- // "NUM"
- // "ORD"
- // "TRAN"
- // "U"
- StandardVariableTypes []string `json:"standardVariableTypes,omitempty"`
-
- // SubaccountId: Subaccount ID of this floodlight configuration. This is
- // a read-only field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // TagSettings: Configuration settings for dynamic and image floodlight
- // tags.
- TagSettings *TagSettings `json:"tagSettings,omitempty"`
-
- // ThirdPartyAuthenticationTokens: List of third-party authentication
- // tokens enabled for this configuration.
- ThirdPartyAuthenticationTokens []*ThirdPartyAuthenticationToken `json:"thirdPartyAuthenticationTokens,omitempty"`
-
- // UserDefinedVariableConfigurations: List of user defined variables
- // enabled for this configuration.
- UserDefinedVariableConfigurations []*UserDefinedVariableConfiguration `json:"userDefinedVariableConfigurations,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightConfiguration) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightConfiguration
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightConfigurationsListResponse: Floodlight Configuration List
-// Response
-type FloodlightConfigurationsListResponse struct {
- // FloodlightConfigurations: Floodlight configuration collection.
- FloodlightConfigurations []*FloodlightConfiguration `json:"floodlightConfigurations,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#floodlightConfigurationsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g.
- // "FloodlightConfigurations") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightConfigurationsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightConfigurationsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FloodlightReportCompatibleFields: Represents fields that are
-// compatible to be selected for a report of type "FlOODLIGHT".
-type FloodlightReportCompatibleFields struct {
- // DimensionFilters: Dimensions which are compatible to be selected in
- // the "dimensionFilters" section of the report.
- DimensionFilters []*Dimension `json:"dimensionFilters,omitempty"`
-
- // Dimensions: Dimensions which are compatible to be selected in the
- // "dimensions" section of the report.
- Dimensions []*Dimension `json:"dimensions,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#floodlightReportCompatibleFields.
- Kind string `json:"kind,omitempty"`
-
- // Metrics: Metrics which are compatible to be selected in the
- // "metricNames" section of the report.
- Metrics []*Metric `json:"metrics,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionFilters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FloodlightReportCompatibleFields) MarshalJSON() ([]byte, error) {
- type noMethod FloodlightReportCompatibleFields
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FrequencyCap: Frequency Cap.
-type FrequencyCap struct {
- // Duration: Duration of time, in seconds, for this frequency cap. The
- // maximum duration is 90 days in seconds, or 7,776,000.
- Duration int64 `json:"duration,omitempty,string"`
-
- // Impressions: Number of times an individual user can be served the ad
- // within the specified duration. The maximum allowed is 15.
- Impressions int64 `json:"impressions,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "Duration") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FrequencyCap) MarshalJSON() ([]byte, error) {
- type noMethod FrequencyCap
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// FsCommand: FsCommand.
-type FsCommand struct {
- // Left: Distance from the left of the browser.Applicable when
- // positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- Left int64 `json:"left,omitempty"`
-
- // PositionOption: Position in the browser where the window will open.
- //
- // Possible values:
- // "CENTERED"
- // "DISTANCE_FROM_TOP_LEFT_CORNER"
- PositionOption string `json:"positionOption,omitempty"`
-
- // Top: Distance from the top of the browser. Applicable when
- // positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- Top int64 `json:"top,omitempty"`
-
- // WindowHeight: Height of the window.
- WindowHeight int64 `json:"windowHeight,omitempty"`
-
- // WindowWidth: Width of the window.
- WindowWidth int64 `json:"windowWidth,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Left") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *FsCommand) MarshalJSON() ([]byte, error) {
- type noMethod FsCommand
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// GeoTargeting: Geographical Targeting.
-type GeoTargeting struct {
- // Cities: Cities to be targeted. For each city only dartId is required.
- // The other fields are populated automatically when the ad is inserted
- // or updated. If targeting a city, do not target or exclude the country
- // of the city, and do not target the metro or region of the city.
- Cities []*City `json:"cities,omitempty"`
-
- // Countries: Countries to be targeted or excluded from targeting,
- // depending on the setting of the excludeCountries field. For each
- // country only dartId is required. The other fields are populated
- // automatically when the ad is inserted or updated. If targeting or
- // excluding a country, do not target regions, cities, metros, or postal
- // codes in the same country.
- Countries []*Country `json:"countries,omitempty"`
-
- // ExcludeCountries: Whether or not to exclude the countries in the
- // countries field from targeting. If false, the countries field refers
- // to countries which will be targeted by the ad.
- ExcludeCountries bool `json:"excludeCountries,omitempty"`
-
- // Metros: Metros to be targeted. For each metro only dmaId is required.
- // The other fields are populated automatically when the ad is inserted
- // or updated. If targeting a metro, do not target or exclude the
- // country of the metro.
- Metros []*Metro `json:"metros,omitempty"`
-
- // PostalCodes: Postal codes to be targeted. For each postal code only
- // id is required. The other fields are populated automatically when the
- // ad is inserted or updated. If targeting a postal code, do not target
- // or exclude the country of the postal code.
- PostalCodes []*PostalCode `json:"postalCodes,omitempty"`
-
- // Regions: Regions to be targeted. For each region only dartId is
- // required. The other fields are populated automatically when the ad is
- // inserted or updated. If targeting a region, do not target or exclude
- // the country of the region.
- Regions []*Region `json:"regions,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Cities") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *GeoTargeting) MarshalJSON() ([]byte, error) {
- type noMethod GeoTargeting
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// InventoryItem: Represents a buy from the DoubleClick Planning
-// inventory store.
-type InventoryItem struct {
- // AccountId: Account ID of this inventory item.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdSlots: Ad slots of this inventory item. If this inventory item
- // represents a standalone placement, there will be exactly one ad slot.
- // If this inventory item represents a placement group, there will be
- // more than one ad slot, each representing one child placement in that
- // placement group.
- AdSlots []*AdSlot `json:"adSlots,omitempty"`
-
- // AdvertiserId: Advertiser ID of this inventory item.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // ContentCategoryId: Content category ID of this inventory item.
- ContentCategoryId int64 `json:"contentCategoryId,omitempty,string"`
-
- // EstimatedClickThroughRate: Estimated click-through rate of this
- // inventory item.
- EstimatedClickThroughRate int64 `json:"estimatedClickThroughRate,omitempty,string"`
-
- // EstimatedConversionRate: Estimated conversion rate of this inventory
- // item.
- EstimatedConversionRate int64 `json:"estimatedConversionRate,omitempty,string"`
-
- // Id: ID of this inventory item.
- Id int64 `json:"id,omitempty,string"`
-
- // InPlan: Whether this inventory item is in plan.
- InPlan bool `json:"inPlan,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#inventoryItem".
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedInfo: Information about the most recent modification of
- // this inventory item.
- LastModifiedInfo *LastModifiedInfo `json:"lastModifiedInfo,omitempty"`
-
- // Name: Name of this inventory item. For standalone inventory items,
- // this is the same name as that of its only ad slot. For group
- // inventory items, this can differ from the name of any of its ad
- // slots.
- Name string `json:"name,omitempty"`
-
- // NegotiationChannelId: Negotiation channel ID of this inventory item.
- NegotiationChannelId int64 `json:"negotiationChannelId,omitempty,string"`
-
- // OrderId: Order ID of this inventory item.
- OrderId int64 `json:"orderId,omitempty,string"`
-
- // PlacementStrategyId: Placement strategy ID of this inventory item.
- PlacementStrategyId int64 `json:"placementStrategyId,omitempty,string"`
-
- // Pricing: Pricing of this inventory item.
- Pricing *Pricing `json:"pricing,omitempty"`
-
- // ProjectId: Project ID of this inventory item.
- ProjectId int64 `json:"projectId,omitempty,string"`
-
- // RfpId: RFP ID of this inventory item.
- RfpId int64 `json:"rfpId,omitempty,string"`
-
- // SiteId: ID of the site this inventory item is associated with.
- SiteId int64 `json:"siteId,omitempty,string"`
-
- // SubaccountId: Subaccount ID of this inventory item.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InventoryItem) MarshalJSON() ([]byte, error) {
- type noMethod InventoryItem
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// InventoryItemsListResponse: Inventory item List Response
-type InventoryItemsListResponse struct {
- // InventoryItems: Inventory item collection
- InventoryItems []*InventoryItem `json:"inventoryItems,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#inventoryItemsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "InventoryItems") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *InventoryItemsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod InventoryItemsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// KeyValueTargetingExpression: Key Value Targeting Expression.
-type KeyValueTargetingExpression struct {
- // Expression: Keyword expression being targeted by the ad.
- Expression string `json:"expression,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Expression") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *KeyValueTargetingExpression) MarshalJSON() ([]byte, error) {
- type noMethod KeyValueTargetingExpression
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LandingPage: Contains information about where a user's browser is
-// taken after the user clicks an ad.
-type LandingPage struct {
- // Default: Whether or not this landing page will be assigned to any ads
- // or creatives that do not have a landing page assigned explicitly.
- // Only one default landing page is allowed per campaign.
- Default bool `json:"default,omitempty"`
-
- // Id: ID of this landing page. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#landingPage".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this landing page. This is a required field. It must be
- // less than 256 characters long, and must be unique among landing pages
- // of the same campaign.
- Name string `json:"name,omitempty"`
-
- // Url: URL of this landing page. This is a required field.
- Url string `json:"url,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Default") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LandingPage) MarshalJSON() ([]byte, error) {
- type noMethod LandingPage
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LandingPagesListResponse: Landing Page List Response
-type LandingPagesListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#landingPagesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // LandingPages: Landing page collection
- LandingPages []*LandingPage `json:"landingPages,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LandingPagesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod LandingPagesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LastModifiedInfo: Modification timestamp.
-type LastModifiedInfo struct {
- // Time: Timestamp of the last change in milliseconds since epoch.
- Time int64 `json:"time,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "Time") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LastModifiedInfo) MarshalJSON() ([]byte, error) {
- type noMethod LastModifiedInfo
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListPopulationClause: A group clause made up of list population terms
-// representing constraints joined by ORs.
-type ListPopulationClause struct {
- // Terms: Terms of this list population clause. Each clause is made up
- // of list population terms representing constraints and are joined by
- // ORs.
- Terms []*ListPopulationTerm `json:"terms,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Terms") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListPopulationClause) MarshalJSON() ([]byte, error) {
- type noMethod ListPopulationClause
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListPopulationRule: Remarketing List Population Rule.
-type ListPopulationRule struct {
- // FloodlightActivityId: Floodlight activity ID associated with this
- // rule. This field can be left blank.
- FloodlightActivityId int64 `json:"floodlightActivityId,omitempty,string"`
-
- // FloodlightActivityName: Name of floodlight activity associated with
- // this rule. This is a read-only, auto-generated field.
- FloodlightActivityName string `json:"floodlightActivityName,omitempty"`
-
- // ListPopulationClauses: Clauses that make up this list population
- // rule. Clauses are joined by ANDs, and the clauses themselves are made
- // up of list population terms which are joined by ORs.
- ListPopulationClauses []*ListPopulationClause `json:"listPopulationClauses,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "FloodlightActivityId") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListPopulationRule) MarshalJSON() ([]byte, error) {
- type noMethod ListPopulationRule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListPopulationTerm: Remarketing List Population Rule Term.
-type ListPopulationTerm struct {
- // Contains: Will be true if the term should check if the user is in the
- // list and false if the term should check if the user is not in the
- // list. This field is only relevant when type is set to
- // LIST_MEMBERSHIP_TERM. False by default.
- Contains bool `json:"contains,omitempty"`
-
- // Negation: Whether to negate the comparison result of this term during
- // rule evaluation. This field is only relevant when type is left unset
- // or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- Negation bool `json:"negation,omitempty"`
-
- // Operator: Comparison operator of this term. This field is only
- // relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or
- // REFERRER_TERM.
- //
- // Possible values:
- // "NUM_EQUALS"
- // "NUM_GREATER_THAN"
- // "NUM_GREATER_THAN_EQUAL"
- // "NUM_LESS_THAN"
- // "NUM_LESS_THAN_EQUAL"
- // "STRING_CONTAINS"
- // "STRING_EQUALS"
- Operator string `json:"operator,omitempty"`
-
- // RemarketingListId: ID of the list in question. This field is only
- // relevant when type is set to LIST_MEMBERSHIP_TERM.
- RemarketingListId int64 `json:"remarketingListId,omitempty,string"`
-
- // Type: List population term type determines the applicable fields in
- // this object. If left unset or set to CUSTOM_VARIABLE_TERM, then
- // variableName, variableFriendlyName, operator, value, and negation are
- // applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and
- // contains are applicable. If set to REFERRER_TERM then operator,
- // value, and negation are applicable.
- //
- // Possible values:
- // "CUSTOM_VARIABLE_TERM"
- // "LIST_MEMBERSHIP_TERM"
- // "REFERRER_TERM"
- Type string `json:"type,omitempty"`
-
- // Value: Literal to compare the variable to. This field is only
- // relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or
- // REFERRER_TERM.
- Value string `json:"value,omitempty"`
-
- // VariableFriendlyName: Friendly name of this term's variable. This is
- // a read-only, auto-generated field. This field is only relevant when
- // type is left unset or set to CUSTOM_VARIABLE_TERM.
- VariableFriendlyName string `json:"variableFriendlyName,omitempty"`
-
- // VariableName: Name of the variable (U1, U2, etc.) being compared in
- // this term. This field is only relevant when type is set to null,
- // CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- VariableName string `json:"variableName,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Contains") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListPopulationTerm) MarshalJSON() ([]byte, error) {
- type noMethod ListPopulationTerm
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ListTargetingExpression: Remarketing List Targeting Expression.
-type ListTargetingExpression struct {
- // Expression: Expression describing which lists are being targeted by
- // the ad.
- Expression string `json:"expression,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Expression") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ListTargetingExpression) MarshalJSON() ([]byte, error) {
- type noMethod ListTargetingExpression
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// LookbackConfiguration: Lookback configuration settings.
-type LookbackConfiguration struct {
- // ClickDuration: Lookback window, in days, from the last time a given
- // user clicked on one of your ads. If you enter 0, clicks will not be
- // considered as triggering events for floodlight tracking. If you leave
- // this field blank, the default value for your account will be used.
- ClickDuration int64 `json:"clickDuration,omitempty"`
-
- // PostImpressionActivitiesDuration: Lookback window, in days, from the
- // last time a given user viewed one of your ads. If you enter 0,
- // impressions will not be considered as triggering events for
- // floodlight tracking. If you leave this field blank, the default value
- // for your account will be used.
- PostImpressionActivitiesDuration int64 `json:"postImpressionActivitiesDuration,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ClickDuration") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *LookbackConfiguration) MarshalJSON() ([]byte, error) {
- type noMethod LookbackConfiguration
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Metric: Represents a metric.
-type Metric struct {
- // Kind: The kind of resource this is, in this case dfareporting#metric.
- Kind string `json:"kind,omitempty"`
-
- // Name: The metric name, e.g. dfa:impressions
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Metric) MarshalJSON() ([]byte, error) {
- type noMethod Metric
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Metro: Contains information about a metro region that can be targeted
-// by ads.
-type Metro struct {
- // CountryCode: Country code of the country to which this metro region
- // belongs.
- CountryCode string `json:"countryCode,omitempty"`
-
- // CountryDartId: DART ID of the country to which this metro region
- // belongs.
- CountryDartId int64 `json:"countryDartId,omitempty,string"`
-
- // DartId: DART ID of this metro region.
- DartId int64 `json:"dartId,omitempty,string"`
-
- // DmaId: DMA ID of this metro region. This is the ID used for targeting
- // and generating reports, and is equivalent to metro_code.
- DmaId int64 `json:"dmaId,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#metro".
- Kind string `json:"kind,omitempty"`
-
- // MetroCode: Metro code of this metro region. This is equivalent to
- // dma_id.
- MetroCode string `json:"metroCode,omitempty"`
-
- // Name: Name of this metro region.
- Name string `json:"name,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CountryCode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Metro) MarshalJSON() ([]byte, error) {
- type noMethod Metro
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MetrosListResponse: Metro List Response
-type MetrosListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#metrosListResponse".
- Kind string `json:"kind,omitempty"`
-
- // Metros: Metro collection.
- Metros []*Metro `json:"metros,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MetrosListResponse) MarshalJSON() ([]byte, error) {
- type noMethod MetrosListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MobileCarrier: Contains information about a mobile carrier that can
-// be targeted by ads.
-type MobileCarrier struct {
- // CountryCode: Country code of the country to which this mobile carrier
- // belongs.
- CountryCode string `json:"countryCode,omitempty"`
-
- // CountryDartId: DART ID of the country to which this mobile carrier
- // belongs.
- CountryDartId int64 `json:"countryDartId,omitempty,string"`
-
- // Id: ID of this mobile carrier.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#mobileCarrier".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this mobile carrier.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "CountryCode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MobileCarrier) MarshalJSON() ([]byte, error) {
- type noMethod MobileCarrier
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// MobileCarriersListResponse: Mobile Carrier List Response
-type MobileCarriersListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#mobileCarriersListResponse".
- Kind string `json:"kind,omitempty"`
-
- // MobileCarriers: Mobile carrier collection.
- MobileCarriers []*MobileCarrier `json:"mobileCarriers,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *MobileCarriersListResponse) MarshalJSON() ([]byte, error) {
- type noMethod MobileCarriersListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ObjectFilter: Object Filter.
-type ObjectFilter struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#objectFilter".
- Kind string `json:"kind,omitempty"`
-
- // ObjectIds: Applicable when status is ASSIGNED. The user has access to
- // objects with these object IDs.
- ObjectIds googleapi.Int64s `json:"objectIds,omitempty"`
-
- // Status: Status of the filter. NONE means the user has access to none
- // of the objects. ALL means the user has access to all objects.
- // ASSIGNED means the user has access to the objects with IDs in the
- // objectIds list.
- //
- // Possible values:
- // "ALL"
- // "ASSIGNED"
- // "NONE"
- Status string `json:"status,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ObjectFilter) MarshalJSON() ([]byte, error) {
- type noMethod ObjectFilter
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OffsetPosition: Offset Position.
-type OffsetPosition struct {
- // Left: Offset distance from left side of an asset or a window.
- Left int64 `json:"left,omitempty"`
-
- // Top: Offset distance from top side of an asset or a window.
- Top int64 `json:"top,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Left") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OffsetPosition) MarshalJSON() ([]byte, error) {
- type noMethod OffsetPosition
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OmnitureSettings: Omniture Integration Settings.
-type OmnitureSettings struct {
- // OmnitureCostDataEnabled: Whether placement cost data will be sent to
- // Omniture. This property can be enabled only if
- // omnitureIntegrationEnabled is true.
- OmnitureCostDataEnabled bool `json:"omnitureCostDataEnabled,omitempty"`
-
- // OmnitureIntegrationEnabled: Whether Omniture integration is enabled.
- // This property can be enabled only when the "Advanced Ad Serving"
- // account setting is enabled.
- OmnitureIntegrationEnabled bool `json:"omnitureIntegrationEnabled,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "OmnitureCostDataEnabled") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OmnitureSettings) MarshalJSON() ([]byte, error) {
- type noMethod OmnitureSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperatingSystem: Contains information about an operating system that
-// can be targeted by ads.
-type OperatingSystem struct {
- // DartId: DART ID of this operating system. This is the ID used for
- // targeting.
- DartId int64 `json:"dartId,omitempty,string"`
-
- // Desktop: Whether this operating system is for desktop.
- Desktop bool `json:"desktop,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#operatingSystem".
- Kind string `json:"kind,omitempty"`
-
- // Mobile: Whether this operating system is for mobile.
- Mobile bool `json:"mobile,omitempty"`
-
- // Name: Name of this operating system.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "DartId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperatingSystem) MarshalJSON() ([]byte, error) {
- type noMethod OperatingSystem
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperatingSystemVersion: Contains information about a particular
-// version of an operating system that can be targeted by ads.
-type OperatingSystemVersion struct {
- // Id: ID of this operating system version.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#operatingSystemVersion".
- Kind string `json:"kind,omitempty"`
-
- // MajorVersion: Major version (leftmost number) of this operating
- // system version.
- MajorVersion string `json:"majorVersion,omitempty"`
-
- // MinorVersion: Minor version (number after the first dot) of this
- // operating system version.
- MinorVersion string `json:"minorVersion,omitempty"`
-
- // Name: Name of this operating system version.
- Name string `json:"name,omitempty"`
-
- // OperatingSystem: Operating system of this operating system version.
- OperatingSystem *OperatingSystem `json:"operatingSystem,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperatingSystemVersion) MarshalJSON() ([]byte, error) {
- type noMethod OperatingSystemVersion
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperatingSystemVersionsListResponse: Operating System Version List
-// Response
-type OperatingSystemVersionsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#operatingSystemVersionsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // OperatingSystemVersions: Operating system version collection.
- OperatingSystemVersions []*OperatingSystemVersion `json:"operatingSystemVersions,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperatingSystemVersionsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod OperatingSystemVersionsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OperatingSystemsListResponse: Operating System List Response
-type OperatingSystemsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#operatingSystemsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // OperatingSystems: Operating system collection.
- OperatingSystems []*OperatingSystem `json:"operatingSystems,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OperatingSystemsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod OperatingSystemsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OptimizationActivity: Creative optimization activity.
-type OptimizationActivity struct {
- // FloodlightActivityId: Floodlight activity ID of this optimization
- // activity. This is a required field.
- FloodlightActivityId int64 `json:"floodlightActivityId,omitempty,string"`
-
- // FloodlightActivityIdDimensionValue: Dimension value for the ID of the
- // floodlight activity. This is a read-only, auto-generated field.
- FloodlightActivityIdDimensionValue *DimensionValue `json:"floodlightActivityIdDimensionValue,omitempty"`
-
- // Weight: Weight associated with this optimization. Must be greater
- // than 1. The weight assigned will be understood in proportion to the
- // weights assigned to the other optimization activities.
- Weight int64 `json:"weight,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "FloodlightActivityId") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OptimizationActivity) MarshalJSON() ([]byte, error) {
- type noMethod OptimizationActivity
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Order: Describes properties of a DoubleClick Planning order.
-type Order struct {
- // AccountId: Account ID of this order.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this order.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // ApproverUserProfileIds: IDs for users that have to approve documents
- // created for this order.
- ApproverUserProfileIds googleapi.Int64s `json:"approverUserProfileIds,omitempty"`
-
- // BuyerInvoiceId: Buyer invoice ID associated with this order.
- BuyerInvoiceId string `json:"buyerInvoiceId,omitempty"`
-
- // BuyerOrganizationName: Name of the buyer organization.
- BuyerOrganizationName string `json:"buyerOrganizationName,omitempty"`
-
- // Comments: Comments in this order.
- Comments string `json:"comments,omitempty"`
-
- // Contacts: Contacts for this order.
- Contacts []*OrderContact `json:"contacts,omitempty"`
-
- // Id: ID of this order. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#order".
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedInfo: Information about the most recent modification of
- // this order.
- LastModifiedInfo *LastModifiedInfo `json:"lastModifiedInfo,omitempty"`
-
- // Name: Name of this order.
- Name string `json:"name,omitempty"`
-
- // Notes: Notes of this order.
- Notes string `json:"notes,omitempty"`
-
- // PlanningTermId: ID of the terms and conditions template used in this
- // order.
- PlanningTermId int64 `json:"planningTermId,omitempty,string"`
-
- // ProjectId: Project ID of this order.
- ProjectId int64 `json:"projectId,omitempty,string"`
-
- // SellerOrderId: Seller order ID associated with this order.
- SellerOrderId string `json:"sellerOrderId,omitempty"`
-
- // SellerOrganizationName: Name of the seller organization.
- SellerOrganizationName string `json:"sellerOrganizationName,omitempty"`
-
- // SiteId: Site IDs this order is associated with.
- SiteId googleapi.Int64s `json:"siteId,omitempty"`
-
- // SiteNames: Free-form site names this order is associated with.
- SiteNames []string `json:"siteNames,omitempty"`
-
- // SubaccountId: Subaccount ID of this order.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // TermsAndConditions: Terms and conditions of this order.
- TermsAndConditions string `json:"termsAndConditions,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Order) MarshalJSON() ([]byte, error) {
- type noMethod Order
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OrderContact: Contact of an order.
-type OrderContact struct {
- // ContactInfo: Free-form information about this contact. It could be
- // any information related to this contact in addition to type, title,
- // name, and signature user profile ID.
- ContactInfo string `json:"contactInfo,omitempty"`
-
- // ContactName: Name of this contact.
- ContactName string `json:"contactName,omitempty"`
-
- // ContactTitle: Title of this contact.
- ContactTitle string `json:"contactTitle,omitempty"`
-
- // ContactType: Type of this contact.
- //
- // Possible values:
- // "PLANNING_ORDER_CONTACT_BUYER_BILLING_CONTACT"
- // "PLANNING_ORDER_CONTACT_BUYER_CONTACT"
- // "PLANNING_ORDER_CONTACT_SELLER_CONTACT"
- ContactType string `json:"contactType,omitempty"`
-
- // SignatureUserProfileId: ID of the user profile containing the
- // signature that will be embedded into order documents.
- SignatureUserProfileId int64 `json:"signatureUserProfileId,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "ContactInfo") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderContact) MarshalJSON() ([]byte, error) {
- type noMethod OrderContact
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OrderDocument: Contains properties of a DoubleClick Planning order
-// document.
-type OrderDocument struct {
- // AccountId: Account ID of this order document.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this order document.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AmendedOrderDocumentId: The amended order document ID of this order
- // document. An order document can be created by optionally amending
- // another order document so that the change history can be preserved.
- AmendedOrderDocumentId int64 `json:"amendedOrderDocumentId,omitempty,string"`
-
- // ApprovedByUserProfileIds: IDs of users who have approved this order
- // document.
- ApprovedByUserProfileIds googleapi.Int64s `json:"approvedByUserProfileIds,omitempty"`
-
- // Cancelled: Whether this order document is cancelled.
- Cancelled bool `json:"cancelled,omitempty"`
-
- // CreatedInfo: Information about the creation of this order document.
- CreatedInfo *LastModifiedInfo `json:"createdInfo,omitempty"`
-
- // EffectiveDate: Effective date of this order document.
- EffectiveDate string `json:"effectiveDate,omitempty"`
-
- // Id: ID of this order document.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#orderDocument".
- Kind string `json:"kind,omitempty"`
-
- // LastSentRecipients: List of email addresses that received the last
- // sent document.
- LastSentRecipients []string `json:"lastSentRecipients,omitempty"`
-
- // LastSentTime: Timestamp of the last email sent with this order
- // document.
- LastSentTime string `json:"lastSentTime,omitempty"`
-
- // OrderId: ID of the order from which this order document is created.
- OrderId int64 `json:"orderId,omitempty,string"`
-
- // ProjectId: Project ID of this order document.
- ProjectId int64 `json:"projectId,omitempty,string"`
-
- // Signed: Whether this order document has been signed.
- Signed bool `json:"signed,omitempty"`
-
- // SubaccountId: Subaccount ID of this order document.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // Title: Title of this order document.
- Title string `json:"title,omitempty"`
-
- // Type: Type of this order document
- //
- // Possible values:
- // "PLANNING_ORDER_TYPE_CHANGE_ORDER"
- // "PLANNING_ORDER_TYPE_INSERTION_ORDER"
- Type string `json:"type,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderDocument) MarshalJSON() ([]byte, error) {
- type noMethod OrderDocument
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OrderDocumentsListResponse: Order document List Response
-type OrderDocumentsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#orderDocumentsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // OrderDocuments: Order document collection
- OrderDocuments []*OrderDocument `json:"orderDocuments,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrderDocumentsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrderDocumentsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// OrdersListResponse: Order List Response
-type OrdersListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#ordersListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Orders: Order collection.
- Orders []*Order `json:"orders,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *OrdersListResponse) MarshalJSON() ([]byte, error) {
- type noMethod OrdersListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PathToConversionReportCompatibleFields: Represents fields that are
-// compatible to be selected for a report of type "PATH_TO_CONVERSION".
-type PathToConversionReportCompatibleFields struct {
- // ConversionDimensions: Conversion dimensions which are compatible to
- // be selected in the "conversionDimensions" section of the report.
- ConversionDimensions []*Dimension `json:"conversionDimensions,omitempty"`
-
- // CustomFloodlightVariables: Custom floodlight variables which are
- // compatible to be selected in the "customFloodlightVariables" section
- // of the report.
- CustomFloodlightVariables []*Dimension `json:"customFloodlightVariables,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#pathToConversionReportCompatibleFields.
- Kind string `json:"kind,omitempty"`
-
- // Metrics: Metrics which are compatible to be selected in the
- // "metricNames" section of the report.
- Metrics []*Metric `json:"metrics,omitempty"`
-
- // PerInteractionDimensions: Per-interaction dimensions which are
- // compatible to be selected in the "perInteractionDimensions" section
- // of the report.
- PerInteractionDimensions []*Dimension `json:"perInteractionDimensions,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "ConversionDimensions") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PathToConversionReportCompatibleFields) MarshalJSON() ([]byte, error) {
- type noMethod PathToConversionReportCompatibleFields
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Placement: Contains properties of a placement.
-type Placement struct {
- // AccountId: Account ID of this placement. This field can be left
- // blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this placement. This field can be left
- // blank.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // Archived: Whether this placement is archived.
- Archived bool `json:"archived,omitempty"`
-
- // CampaignId: Campaign ID of this placement. This field is a required
- // field on insertion.
- CampaignId int64 `json:"campaignId,omitempty,string"`
-
- // CampaignIdDimensionValue: Dimension value for the ID of the campaign.
- // This is a read-only, auto-generated field.
- CampaignIdDimensionValue *DimensionValue `json:"campaignIdDimensionValue,omitempty"`
-
- // Comment: Comments for this placement.
- Comment string `json:"comment,omitempty"`
-
- // Compatibility: Placement compatibility. WEB and WEB_INTERSTITIAL
- // refer to rendering either on desktop or on mobile devices for regular
- // or interstitial ads, respectively. APP and APP_INTERSTITIAL are for
- // rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in
- // in-stream video ads developed with the VAST standard. This field is
- // required on insertion.
- //
- // Possible values:
- // "APP"
- // "APP_INTERSTITIAL"
- // "IN_STREAM_VIDEO"
- // "WEB"
- // "WEB_INTERSTITIAL"
- Compatibility string `json:"compatibility,omitempty"`
-
- // ContentCategoryId: ID of the content category assigned to this
- // placement.
- ContentCategoryId int64 `json:"contentCategoryId,omitempty,string"`
-
- // CreateInfo: Information about the creation of this placement. This is
- // a read-only field.
- CreateInfo *LastModifiedInfo `json:"createInfo,omitempty"`
-
- // DirectorySiteId: Directory site ID of this placement. On insert, you
- // must set either this field or the siteId field to specify the site
- // associated with this placement. This is a required field that is
- // read-only after insertion.
- DirectorySiteId int64 `json:"directorySiteId,omitempty,string"`
-
- // DirectorySiteIdDimensionValue: Dimension value for the ID of the
- // directory site. This is a read-only, auto-generated field.
- DirectorySiteIdDimensionValue *DimensionValue `json:"directorySiteIdDimensionValue,omitempty"`
-
- // ExternalId: External ID for this placement.
- ExternalId string `json:"externalId,omitempty"`
-
- // Id: ID of this placement. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this placement. This
- // is a read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // KeyName: Key name of this placement. This is a read-only,
- // auto-generated field.
- KeyName string `json:"keyName,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#placement".
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedInfo: Information about the most recent modification of
- // this placement. This is a read-only field.
- LastModifiedInfo *LastModifiedInfo `json:"lastModifiedInfo,omitempty"`
-
- // LookbackConfiguration: Lookback window settings for this placement.
- LookbackConfiguration *LookbackConfiguration `json:"lookbackConfiguration,omitempty"`
-
- // Name: Name of this placement.This is a required field and must be
- // less than 256 characters long.
- Name string `json:"name,omitempty"`
-
- // PaymentApproved: Whether payment was approved for this placement.
- // This is a read-only field relevant only to publisher-paid placements.
- PaymentApproved bool `json:"paymentApproved,omitempty"`
-
- // PaymentSource: Payment source for this placement. This is a required
- // field that is read-only after insertion.
- //
- // Possible values:
- // "PLACEMENT_AGENCY_PAID"
- // "PLACEMENT_PUBLISHER_PAID"
- PaymentSource string `json:"paymentSource,omitempty"`
-
- // PlacementGroupId: ID of this placement's group, if applicable.
- PlacementGroupId int64 `json:"placementGroupId,omitempty,string"`
-
- // PlacementGroupIdDimensionValue: Dimension value for the ID of the
- // placement group. This is a read-only, auto-generated field.
- PlacementGroupIdDimensionValue *DimensionValue `json:"placementGroupIdDimensionValue,omitempty"`
-
- // PlacementStrategyId: ID of the placement strategy assigned to this
- // placement.
- PlacementStrategyId int64 `json:"placementStrategyId,omitempty,string"`
-
- // PricingSchedule: Pricing schedule of this placement. This field is
- // required on insertion, specifically subfields startDate, endDate and
- // pricingType.
- PricingSchedule *PricingSchedule `json:"pricingSchedule,omitempty"`
-
- // Primary: Whether this placement is the primary placement of a
- // roadblock (placement group). You cannot change this field from true
- // to false. Setting this field to true will automatically set the
- // primary field on the original primary placement of the roadblock to
- // false, and it will automatically set the roadblock's
- // primaryPlacementId field to the ID of this placement.
- Primary bool `json:"primary,omitempty"`
-
- // PublisherUpdateInfo: Information about the last publisher update.
- // This is a read-only field.
- PublisherUpdateInfo *LastModifiedInfo `json:"publisherUpdateInfo,omitempty"`
-
- // SiteId: Site ID associated with this placement. On insert, you must
- // set either this field or the directorySiteId field to specify the
- // site associated with this placement. This is a required field that is
- // read-only after insertion.
- SiteId int64 `json:"siteId,omitempty,string"`
-
- // SiteIdDimensionValue: Dimension value for the ID of the site. This is
- // a read-only, auto-generated field.
- SiteIdDimensionValue *DimensionValue `json:"siteIdDimensionValue,omitempty"`
-
- // Size: Size associated with this placement. When inserting or updating
- // a placement, only the size ID field is used. This field is required
- // on insertion.
- Size *Size `json:"size,omitempty"`
-
- // SslRequired: Whether creatives assigned to this placement must be
- // SSL-compliant.
- SslRequired bool `json:"sslRequired,omitempty"`
-
- // Status: Third-party placement status.
- //
- // Possible values:
- // "ACKNOWLEDGE_ACCEPTANCE"
- // "ACKNOWLEDGE_REJECTION"
- // "DRAFT"
- // "PAYMENT_ACCEPTED"
- // "PAYMENT_REJECTED"
- // "PENDING_REVIEW"
- Status string `json:"status,omitempty"`
-
- // SubaccountId: Subaccount ID of this placement. This field can be left
- // blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // TagFormats: Tag formats to generate for this placement. This field is
- // required on insertion.
- // Acceptable values are:
- // - "PLACEMENT_TAG_STANDARD"
- // - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
- // - "PLACEMENT_TAG_IFRAME_ILAYER"
- // - "PLACEMENT_TAG_INTERNAL_REDIRECT"
- // - "PLACEMENT_TAG_JAVASCRIPT"
- // - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
- // - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
- // - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
- // - "PLACEMENT_TAG_CLICK_COMMANDS"
- // - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
- // - "PLACEMENT_TAG_TRACKING"
- // - "PLACEMENT_TAG_TRACKING_IFRAME"
- // - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- //
- // Possible values:
- // "PLACEMENT_TAG_CLICK_COMMANDS"
- // "PLACEMENT_TAG_IFRAME_ILAYER"
- // "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
- // "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY"
- // "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
- // "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3"
- // "PLACEMENT_TAG_INTERNAL_REDIRECT"
- // "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
- // "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY"
- // "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
- // "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
- // "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY"
- // "PLACEMENT_TAG_JAVASCRIPT"
- // "PLACEMENT_TAG_JAVASCRIPT_LEGACY"
- // "PLACEMENT_TAG_STANDARD"
- // "PLACEMENT_TAG_TRACKING"
- // "PLACEMENT_TAG_TRACKING_IFRAME"
- // "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- TagFormats []string `json:"tagFormats,omitempty"`
-
- // TagSetting: Tag settings for this placement.
- TagSetting *TagSetting `json:"tagSetting,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Placement) MarshalJSON() ([]byte, error) {
- type noMethod Placement
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlacementAssignment: Placement Assignment.
-type PlacementAssignment struct {
- // Active: Whether this placement assignment is active. When true, the
- // placement will be included in the ad's rotation.
- Active bool `json:"active,omitempty"`
-
- // PlacementId: ID of the placement to be assigned. This is a required
- // field.
- PlacementId int64 `json:"placementId,omitempty,string"`
-
- // PlacementIdDimensionValue: Dimension value for the ID of the
- // placement. This is a read-only, auto-generated field.
- PlacementIdDimensionValue *DimensionValue `json:"placementIdDimensionValue,omitempty"`
-
- // SslRequired: Whether the placement to be assigned requires SSL. This
- // is a read-only field that is auto-generated when the ad is inserted
- // or updated.
- SslRequired bool `json:"sslRequired,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Active") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlacementAssignment) MarshalJSON() ([]byte, error) {
- type noMethod PlacementAssignment
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlacementGroup: Contains properties of a package or roadblock.
-type PlacementGroup struct {
- // AccountId: Account ID of this placement group. This is a read-only
- // field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this placement group. This is a
- // required field on insertion.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // Archived: Whether this placement group is archived.
- Archived bool `json:"archived,omitempty"`
-
- // CampaignId: Campaign ID of this placement group. This field is
- // required on insertion.
- CampaignId int64 `json:"campaignId,omitempty,string"`
-
- // CampaignIdDimensionValue: Dimension value for the ID of the campaign.
- // This is a read-only, auto-generated field.
- CampaignIdDimensionValue *DimensionValue `json:"campaignIdDimensionValue,omitempty"`
-
- // ChildPlacementIds: IDs of placements which are assigned to this
- // placement group. This is a read-only, auto-generated field.
- ChildPlacementIds googleapi.Int64s `json:"childPlacementIds,omitempty"`
-
- // Comment: Comments for this placement group.
- Comment string `json:"comment,omitempty"`
-
- // ContentCategoryId: ID of the content category assigned to this
- // placement group.
- ContentCategoryId int64 `json:"contentCategoryId,omitempty,string"`
-
- // CreateInfo: Information about the creation of this placement group.
- // This is a read-only field.
- CreateInfo *LastModifiedInfo `json:"createInfo,omitempty"`
-
- // DirectorySiteId: Directory site ID associated with this placement
- // group. On insert, you must set either this field or the site_id field
- // to specify the site associated with this placement group. This is a
- // required field that is read-only after insertion.
- DirectorySiteId int64 `json:"directorySiteId,omitempty,string"`
-
- // DirectorySiteIdDimensionValue: Dimension value for the ID of the
- // directory site. This is a read-only, auto-generated field.
- DirectorySiteIdDimensionValue *DimensionValue `json:"directorySiteIdDimensionValue,omitempty"`
-
- // ExternalId: External ID for this placement.
- ExternalId string `json:"externalId,omitempty"`
-
- // Id: ID of this placement group. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this placement group.
- // This is a read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#placementGroup".
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedInfo: Information about the most recent modification of
- // this placement group. This is a read-only field.
- LastModifiedInfo *LastModifiedInfo `json:"lastModifiedInfo,omitempty"`
-
- // Name: Name of this placement group. This is a required field and must
- // be less than 256 characters long.
- Name string `json:"name,omitempty"`
-
- // PlacementGroupType: Type of this placement group. A package is a
- // simple group of placements that acts as a single pricing point for a
- // group of tags. A roadblock is a group of placements that not only
- // acts as a single pricing point, but also assumes that all the tags in
- // it will be served at the same time. A roadblock requires one of its
- // assigned placements to be marked as primary for reporting. This field
- // is required on insertion.
- //
- // Possible values:
- // "PLACEMENT_PACKAGE"
- // "PLACEMENT_ROADBLOCK"
- PlacementGroupType string `json:"placementGroupType,omitempty"`
-
- // PlacementStrategyId: ID of the placement strategy assigned to this
- // placement group.
- PlacementStrategyId int64 `json:"placementStrategyId,omitempty,string"`
-
- // PricingSchedule: Pricing schedule of this placement group. This field
- // is required on insertion.
- PricingSchedule *PricingSchedule `json:"pricingSchedule,omitempty"`
-
- // PrimaryPlacementId: ID of the primary placement, used to calculate
- // the media cost of a roadblock (placement group). Modifying this field
- // will automatically modify the primary field on all affected roadblock
- // child placements.
- PrimaryPlacementId int64 `json:"primaryPlacementId,omitempty,string"`
-
- // PrimaryPlacementIdDimensionValue: Dimension value for the ID of the
- // primary placement. This is a read-only, auto-generated field.
- PrimaryPlacementIdDimensionValue *DimensionValue `json:"primaryPlacementIdDimensionValue,omitempty"`
-
- // SiteId: Site ID associated with this placement group. On insert, you
- // must set either this field or the directorySiteId field to specify
- // the site associated with this placement group. This is a required
- // field that is read-only after insertion.
- SiteId int64 `json:"siteId,omitempty,string"`
-
- // SiteIdDimensionValue: Dimension value for the ID of the site. This is
- // a read-only, auto-generated field.
- SiteIdDimensionValue *DimensionValue `json:"siteIdDimensionValue,omitempty"`
-
- // SubaccountId: Subaccount ID of this placement group. This is a
- // read-only field that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlacementGroup) MarshalJSON() ([]byte, error) {
- type noMethod PlacementGroup
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlacementGroupsListResponse: Placement Group List Response
-type PlacementGroupsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#placementGroupsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // PlacementGroups: Placement group collection.
- PlacementGroups []*PlacementGroup `json:"placementGroups,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlacementGroupsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod PlacementGroupsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlacementStrategiesListResponse: Placement Strategy List Response
-type PlacementStrategiesListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#placementStrategiesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // PlacementStrategies: Placement strategy collection.
- PlacementStrategies []*PlacementStrategy `json:"placementStrategies,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlacementStrategiesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod PlacementStrategiesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlacementStrategy: Contains properties of a placement strategy.
-type PlacementStrategy struct {
- // AccountId: Account ID of this placement strategy.This is a read-only
- // field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Id: ID of this placement strategy. This is a read-only,
- // auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#placementStrategy".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this placement strategy. This is a required field. It
- // must be less than 256 characters long and unique among placement
- // strategies of the same account.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlacementStrategy) MarshalJSON() ([]byte, error) {
- type noMethod PlacementStrategy
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlacementTag: Placement Tag
-type PlacementTag struct {
- // PlacementId: Placement ID
- PlacementId int64 `json:"placementId,omitempty,string"`
-
- // TagDatas: Tags generated for this placement.
- TagDatas []*TagData `json:"tagDatas,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "PlacementId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlacementTag) MarshalJSON() ([]byte, error) {
- type noMethod PlacementTag
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlacementsGenerateTagsResponse: Placement GenerateTags Response
-type PlacementsGenerateTagsResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#placementsGenerateTagsResponse".
- Kind string `json:"kind,omitempty"`
-
- // PlacementTags: Set of generated tags for the specified placements.
- PlacementTags []*PlacementTag `json:"placementTags,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlacementsGenerateTagsResponse) MarshalJSON() ([]byte, error) {
- type noMethod PlacementsGenerateTagsResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlacementsListResponse: Placement List Response
-type PlacementsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#placementsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Placements: Placement collection.
- Placements []*Placement `json:"placements,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlacementsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod PlacementsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlatformType: Contains information about a platform type that can be
-// targeted by ads.
-type PlatformType struct {
- // Id: ID of this platform type.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#platformType".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this platform type.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Id") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlatformType) MarshalJSON() ([]byte, error) {
- type noMethod PlatformType
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PlatformTypesListResponse: Platform Type List Response
-type PlatformTypesListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#platformTypesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // PlatformTypes: Platform type collection.
- PlatformTypes []*PlatformType `json:"platformTypes,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PlatformTypesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod PlatformTypesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PopupWindowProperties: Popup Window Properties.
-type PopupWindowProperties struct {
- // Dimension: Popup dimension for a creative. This is a read-only field.
- // Applicable to the following creative types: all RICH_MEDIA and all
- // VPAID
- Dimension *Size `json:"dimension,omitempty"`
-
- // Offset: Upper-left corner coordinates of the popup window. Applicable
- // if positionType is COORDINATES.
- Offset *OffsetPosition `json:"offset,omitempty"`
-
- // PositionType: Popup window position either centered or at specific
- // coordinate.
- //
- // Possible values:
- // "CENTER"
- // "COORDINATES"
- PositionType string `json:"positionType,omitempty"`
-
- // ShowAddressBar: Whether to display the browser address bar.
- ShowAddressBar bool `json:"showAddressBar,omitempty"`
-
- // ShowMenuBar: Whether to display the browser menu bar.
- ShowMenuBar bool `json:"showMenuBar,omitempty"`
-
- // ShowScrollBar: Whether to display the browser scroll bar.
- ShowScrollBar bool `json:"showScrollBar,omitempty"`
-
- // ShowStatusBar: Whether to display the browser status bar.
- ShowStatusBar bool `json:"showStatusBar,omitempty"`
-
- // ShowToolBar: Whether to display the browser tool bar.
- ShowToolBar bool `json:"showToolBar,omitempty"`
-
- // Title: Title of popup window.
- Title string `json:"title,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Dimension") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PopupWindowProperties) MarshalJSON() ([]byte, error) {
- type noMethod PopupWindowProperties
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PostalCode: Contains information about a postal code that can be
-// targeted by ads.
-type PostalCode struct {
- // Code: Postal code. This is equivalent to the id field.
- Code string `json:"code,omitempty"`
-
- // CountryCode: Country code of the country to which this postal code
- // belongs.
- CountryCode string `json:"countryCode,omitempty"`
-
- // CountryDartId: DART ID of the country to which this postal code
- // belongs.
- CountryDartId int64 `json:"countryDartId,omitempty,string"`
-
- // Id: ID of this postal code.
- Id string `json:"id,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#postalCode".
- Kind string `json:"kind,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Code") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PostalCode) MarshalJSON() ([]byte, error) {
- type noMethod PostalCode
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PostalCodesListResponse: Postal Code List Response
-type PostalCodesListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#postalCodesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // PostalCodes: Postal code collection.
- PostalCodes []*PostalCode `json:"postalCodes,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PostalCodesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod PostalCodesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Pricing: Pricing Information
-type Pricing struct {
- // CapCostType: Cap cost type of this inventory item.
- //
- // Possible values:
- // "PLANNING_PLACEMENT_CAP_COST_TYPE_CUMULATIVE"
- // "PLANNING_PLACEMENT_CAP_COST_TYPE_MONTHLY"
- // "PLANNING_PLACEMENT_CAP_COST_TYPE_NONE"
- CapCostType string `json:"capCostType,omitempty"`
-
- // EndDate: End date of this inventory item.
- EndDate string `json:"endDate,omitempty"`
-
- // Flights: Flights of this inventory item. A flight (a.k.a. pricing
- // period) represents the inventory item pricing information for a
- // specific period of time.
- Flights []*Flight `json:"flights,omitempty"`
-
- // GroupType: Group type of this inventory item if it represents a
- // placement group. Is null otherwise. There are two type of placement
- // groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of
- // inventory items that acts as a single pricing point for a group of
- // tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory
- // items that not only acts as a single pricing point, but also assumes
- // that all the tags in it will be served at the same time. A roadblock
- // requires one of its assigned inventory items to be marked as primary.
- //
- // Possible values:
- // "PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE"
- // "PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK"
- GroupType string `json:"groupType,omitempty"`
-
- // PricingType: Pricing type of this inventory item.
- //
- // Possible values:
- // "PLANNING_PLACEMENT_PRICING_TYPE_CLICKS"
- // "PLANNING_PLACEMENT_PRICING_TYPE_CPA"
- // "PLANNING_PLACEMENT_PRICING_TYPE_CPC"
- // "PLANNING_PLACEMENT_PRICING_TYPE_CPM"
- // "PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_CLICKS"
- // "PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_IMPRESSIONS"
- // "PLANNING_PLACEMENT_PRICING_TYPE_IMPRESSIONS"
- PricingType string `json:"pricingType,omitempty"`
-
- // StartDate: Start date of this inventory item.
- StartDate string `json:"startDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CapCostType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Pricing) MarshalJSON() ([]byte, error) {
- type noMethod Pricing
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PricingSchedule: Pricing Schedule
-type PricingSchedule struct {
- // CapCostOption: Placement cap cost option.
- //
- // Possible values:
- // "CAP_COST_CUMULATIVE"
- // "CAP_COST_MONTHLY"
- // "CAP_COST_NONE"
- CapCostOption string `json:"capCostOption,omitempty"`
-
- // DisregardOverdelivery: Whether cap costs are ignored by ad serving.
- DisregardOverdelivery bool `json:"disregardOverdelivery,omitempty"`
-
- // EndDate: Placement end date. This date must be later than, or the
- // same day as, the placement start date, but not later than the
- // campaign end date. If, for example, you set 6/25/2015 as both the
- // start and end dates, the effective placement date is just that day
- // only, 6/25/2015. The hours, minutes, and seconds of the end date
- // should not be set, as doing so will result in an error. This field is
- // required on insertion.
- EndDate string `json:"endDate,omitempty"`
-
- // Flighted: Whether this placement is flighted. If true, pricing
- // periods will be computed automatically.
- Flighted bool `json:"flighted,omitempty"`
-
- // FloodlightActivityId: Floodlight activity ID associated with this
- // placement. This field should be set when placement pricing type is
- // set to PRICING_TYPE_CPA.
- FloodlightActivityId int64 `json:"floodlightActivityId,omitempty,string"`
-
- // PricingPeriods: Pricing periods for this placement.
- PricingPeriods []*PricingSchedulePricingPeriod `json:"pricingPeriods,omitempty"`
-
- // PricingType: Placement pricing type. This field is required on
- // insertion.
- //
- // Possible values:
- // "PRICING_TYPE_CPA"
- // "PRICING_TYPE_CPC"
- // "PRICING_TYPE_CPM"
- // "PRICING_TYPE_FLAT_RATE_CLICKS"
- // "PRICING_TYPE_FLAT_RATE_IMPRESSIONS"
- PricingType string `json:"pricingType,omitempty"`
-
- // StartDate: Placement start date. This date must be later than, or the
- // same day as, the campaign start date. The hours, minutes, and seconds
- // of the start date should not be set, as doing so will result in an
- // error. This field is required on insertion.
- StartDate string `json:"startDate,omitempty"`
-
- // TestingStartDate: Testing start date of this placement. The hours,
- // minutes, and seconds of the start date should not be set, as doing so
- // will result in an error.
- TestingStartDate string `json:"testingStartDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CapCostOption") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PricingSchedule) MarshalJSON() ([]byte, error) {
- type noMethod PricingSchedule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// PricingSchedulePricingPeriod: Pricing Period
-type PricingSchedulePricingPeriod struct {
- // EndDate: Pricing period end date. This date must be later than, or
- // the same day as, the pricing period start date, but not later than
- // the placement end date. The period end date can be the same date as
- // the period start date. If, for example, you set 6/25/2015 as both the
- // start and end dates, the effective pricing period date is just that
- // day only, 6/25/2015. The hours, minutes, and seconds of the end date
- // should not be set, as doing so will result in an error.
- EndDate string `json:"endDate,omitempty"`
-
- // PricingComment: Comments for this pricing period.
- PricingComment string `json:"pricingComment,omitempty"`
-
- // RateOrCostNanos: Rate or cost of this pricing period.
- RateOrCostNanos int64 `json:"rateOrCostNanos,omitempty,string"`
-
- // StartDate: Pricing period start date. This date must be later than,
- // or the same day as, the placement start date. The hours, minutes, and
- // seconds of the start date should not be set, as doing so will result
- // in an error.
- StartDate string `json:"startDate,omitempty"`
-
- // Units: Units of this pricing period.
- Units int64 `json:"units,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g. "EndDate") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *PricingSchedulePricingPeriod) MarshalJSON() ([]byte, error) {
- type noMethod PricingSchedulePricingPeriod
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Project: Contains properties of a DoubleClick Planning project.
-type Project struct {
- // AccountId: Account ID of this project.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AdvertiserId: Advertiser ID of this project.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AudienceAgeGroup: Audience age group of this project.
- //
- // Possible values:
- // "PLANNING_AUDIENCE_AGE_18_24"
- // "PLANNING_AUDIENCE_AGE_25_34"
- // "PLANNING_AUDIENCE_AGE_35_44"
- // "PLANNING_AUDIENCE_AGE_45_54"
- // "PLANNING_AUDIENCE_AGE_55_64"
- // "PLANNING_AUDIENCE_AGE_65_OR_MORE"
- // "PLANNING_AUDIENCE_AGE_UNKNOWN"
- AudienceAgeGroup string `json:"audienceAgeGroup,omitempty"`
-
- // AudienceGender: Audience gender of this project.
- //
- // Possible values:
- // "PLANNING_AUDIENCE_GENDER_FEMALE"
- // "PLANNING_AUDIENCE_GENDER_MALE"
- AudienceGender string `json:"audienceGender,omitempty"`
-
- // Budget: Budget of this project in the currency specified by the
- // current account. The value stored in this field represents only the
- // non-fractional amount. For example, for USD, the smallest value that
- // can be represented by this field is 1 US dollar.
- Budget int64 `json:"budget,omitempty,string"`
-
- // ClientBillingCode: Client billing code of this project.
- ClientBillingCode string `json:"clientBillingCode,omitempty"`
-
- // ClientName: Name of the project client.
- ClientName string `json:"clientName,omitempty"`
-
- // EndDate: End date of the project.
- EndDate string `json:"endDate,omitempty"`
-
- // Id: ID of this project. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#project".
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedInfo: Information about the most recent modification of
- // this project.
- LastModifiedInfo *LastModifiedInfo `json:"lastModifiedInfo,omitempty"`
-
- // Name: Name of this project.
- Name string `json:"name,omitempty"`
-
- // Overview: Overview of this project.
- Overview string `json:"overview,omitempty"`
-
- // StartDate: Start date of the project.
- StartDate string `json:"startDate,omitempty"`
-
- // SubaccountId: Subaccount ID of this project.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // TargetClicks: Number of clicks that the advertiser is targeting.
- TargetClicks int64 `json:"targetClicks,omitempty,string"`
-
- // TargetConversions: Number of conversions that the advertiser is
- // targeting.
- TargetConversions int64 `json:"targetConversions,omitempty,string"`
-
- // TargetCpaNanos: CPA that the advertiser is targeting.
- TargetCpaNanos int64 `json:"targetCpaNanos,omitempty,string"`
-
- // TargetCpcNanos: CPC that the advertiser is targeting.
- TargetCpcNanos int64 `json:"targetCpcNanos,omitempty,string"`
-
- // TargetCpmNanos: CPM that the advertiser is targeting.
- TargetCpmNanos int64 `json:"targetCpmNanos,omitempty,string"`
-
- // TargetImpressions: Number of impressions that the advertiser is
- // targeting.
- TargetImpressions int64 `json:"targetImpressions,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Project) MarshalJSON() ([]byte, error) {
- type noMethod Project
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ProjectsListResponse: Project List Response
-type ProjectsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#projectsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Projects: Project collection.
- Projects []*Project `json:"projects,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ProjectsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod ProjectsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReachReportCompatibleFields: Represents fields that are compatible to
-// be selected for a report of type "REACH".
-type ReachReportCompatibleFields struct {
- // DimensionFilters: Dimensions which are compatible to be selected in
- // the "dimensionFilters" section of the report.
- DimensionFilters []*Dimension `json:"dimensionFilters,omitempty"`
-
- // Dimensions: Dimensions which are compatible to be selected in the
- // "dimensions" section of the report.
- Dimensions []*Dimension `json:"dimensions,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#reachReportCompatibleFields.
- Kind string `json:"kind,omitempty"`
-
- // Metrics: Metrics which are compatible to be selected in the
- // "metricNames" section of the report.
- Metrics []*Metric `json:"metrics,omitempty"`
-
- // PivotedActivityMetrics: Metrics which are compatible to be selected
- // as activity metrics to pivot on in the "activities" section of the
- // report.
- PivotedActivityMetrics []*Metric `json:"pivotedActivityMetrics,omitempty"`
-
- // ReachByFrequencyMetrics: Metrics which are compatible to be selected
- // in the "reachByFrequencyMetricNames" section of the report.
- ReachByFrequencyMetrics []*Metric `json:"reachByFrequencyMetrics,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionFilters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReachReportCompatibleFields) MarshalJSON() ([]byte, error) {
- type noMethod ReachReportCompatibleFields
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Recipient: Represents a recipient.
-type Recipient struct {
- // DeliveryType: The delivery type for the recipient.
- //
- // Possible values:
- // "ATTACHMENT"
- // "LINK"
- DeliveryType string `json:"deliveryType,omitempty"`
-
- // Email: The email address of the recipient.
- Email string `json:"email,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#recipient.
- Kind string `json:"kind,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DeliveryType") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Recipient) MarshalJSON() ([]byte, error) {
- type noMethod Recipient
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Region: Contains information about a region that can be targeted by
-// ads.
-type Region struct {
- // CountryCode: Country code of the country to which this region
- // belongs.
- CountryCode string `json:"countryCode,omitempty"`
-
- // CountryDartId: DART ID of the country to which this region belongs.
- CountryDartId int64 `json:"countryDartId,omitempty,string"`
-
- // DartId: DART ID of this region.
- DartId int64 `json:"dartId,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#region".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this region.
- Name string `json:"name,omitempty"`
-
- // RegionCode: Region code.
- RegionCode string `json:"regionCode,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CountryCode") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Region) MarshalJSON() ([]byte, error) {
- type noMethod Region
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// RegionsListResponse: Region List Response
-type RegionsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#regionsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // Regions: Region collection.
- Regions []*Region `json:"regions,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RegionsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod RegionsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// RemarketingList: Contains properties of a remarketing list.
-// Remarketing enables you to create lists of users who have performed
-// specific actions on a site, then target ads to members of those
-// lists. This resource can be used to manage remarketing lists that are
-// owned by your advertisers. To see all remarketing lists that are
-// visible to your advertisers, including those that are shared to your
-// advertiser or account, use the TargetableRemarketingLists resource.
-type RemarketingList struct {
- // AccountId: Account ID of this remarketing list. This is a read-only,
- // auto-generated field that is only returned in GET requests.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Active: Whether this remarketing list is active.
- Active bool `json:"active,omitempty"`
-
- // AdvertiserId: Dimension value for the advertiser ID that owns this
- // remarketing list. This is a required field.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser. This is a read-only, auto-generated field.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // Description: Remarketing list description.
- Description string `json:"description,omitempty"`
-
- // Id: Remarketing list ID. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#remarketingList".
- Kind string `json:"kind,omitempty"`
-
- // LifeSpan: Number of days that a user should remain in the remarketing
- // list without an impression.
- LifeSpan int64 `json:"lifeSpan,omitempty,string"`
-
- // ListPopulationRule: Rule used to populate the remarketing list with
- // users.
- ListPopulationRule *ListPopulationRule `json:"listPopulationRule,omitempty"`
-
- // ListSize: Number of users currently in the list. This is a read-only
- // field.
- ListSize int64 `json:"listSize,omitempty,string"`
-
- // ListSource: Product from which this remarketing list was originated.
- //
- // Possible values:
- // "REMARKETING_LIST_SOURCE_DBM"
- // "REMARKETING_LIST_SOURCE_DFA"
- // "REMARKETING_LIST_SOURCE_DMP"
- // "REMARKETING_LIST_SOURCE_GA"
- // "REMARKETING_LIST_SOURCE_OTHER"
- ListSource string `json:"listSource,omitempty"`
-
- // Name: Name of the remarketing list. This is a required field. Must be
- // no greater than 128 characters long.
- Name string `json:"name,omitempty"`
-
- // SubaccountId: Subaccount ID of this remarketing list. This is a
- // read-only, auto-generated field that is only returned in GET
- // requests.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RemarketingList) MarshalJSON() ([]byte, error) {
- type noMethod RemarketingList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// RemarketingListShare: Contains properties of a remarketing list's
-// sharing information. Sharing allows other accounts or advertisers to
-// target to your remarketing lists. This resource can be used to manage
-// remarketing list sharing to other accounts and advertisers.
-type RemarketingListShare struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#remarketingListShare".
- Kind string `json:"kind,omitempty"`
-
- // RemarketingListId: Remarketing list ID. This is a read-only,
- // auto-generated field.
- RemarketingListId int64 `json:"remarketingListId,omitempty,string"`
-
- // SharedAccountIds: Accounts that the remarketing list is shared with.
- SharedAccountIds googleapi.Int64s `json:"sharedAccountIds,omitempty"`
-
- // SharedAdvertiserIds: Advertisers that the remarketing list is shared
- // with.
- SharedAdvertiserIds googleapi.Int64s `json:"sharedAdvertiserIds,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RemarketingListShare) MarshalJSON() ([]byte, error) {
- type noMethod RemarketingListShare
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// RemarketingListsListResponse: Remarketing list response
-type RemarketingListsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#remarketingListsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // RemarketingLists: Remarketing list collection.
- RemarketingLists []*RemarketingList `json:"remarketingLists,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RemarketingListsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod RemarketingListsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Report: Represents a Report resource.
-type Report struct {
- // AccountId: The account ID to which this report belongs.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Criteria: The report criteria for a report of type "STANDARD".
- Criteria *ReportCriteria `json:"criteria,omitempty"`
-
- // CrossDimensionReachCriteria: The report criteria for a report of type
- // "CROSS_DIMENSION_REACH".
- CrossDimensionReachCriteria *ReportCrossDimensionReachCriteria `json:"crossDimensionReachCriteria,omitempty"`
-
- // Delivery: The report's email delivery settings.
- Delivery *ReportDelivery `json:"delivery,omitempty"`
-
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // FileName: The filename used when generating report files for this
- // report.
- FileName string `json:"fileName,omitempty"`
-
- // FloodlightCriteria: The report criteria for a report of type
- // "FLOODLIGHT".
- FloodlightCriteria *ReportFloodlightCriteria `json:"floodlightCriteria,omitempty"`
-
- // Format: The output format of the report. If not specified, default
- // format is "CSV". Note that the actual format in the completed report
- // file might differ if for instance the report's size exceeds the
- // format's capabilities. "CSV" will then be the fallback format.
- //
- // Possible values:
- // "CSV"
- // "EXCEL"
- Format string `json:"format,omitempty"`
-
- // Id: The unique ID identifying this report resource.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: The kind of resource this is, in this case dfareporting#report.
- Kind string `json:"kind,omitempty"`
-
- // LastModifiedTime: The timestamp (in milliseconds since epoch) of when
- // this report was last modified.
- LastModifiedTime uint64 `json:"lastModifiedTime,omitempty,string"`
-
- // Name: The name of the report.
- Name string `json:"name,omitempty"`
-
- // OwnerProfileId: The user profile id of the owner of this report.
- OwnerProfileId int64 `json:"ownerProfileId,omitempty,string"`
-
- // PathToConversionCriteria: The report criteria for a report of type
- // "PATH_TO_CONVERSION".
- PathToConversionCriteria *ReportPathToConversionCriteria `json:"pathToConversionCriteria,omitempty"`
-
- // ReachCriteria: The report criteria for a report of type "REACH".
- ReachCriteria *ReportReachCriteria `json:"reachCriteria,omitempty"`
-
- // Schedule: The report's schedule. Can only be set if the report's
- // 'dateRange' is a relative date range and the relative date range is
- // not "TODAY".
- Schedule *ReportSchedule `json:"schedule,omitempty"`
-
- // SubAccountId: The subaccount ID to which this report belongs if
- // applicable.
- SubAccountId int64 `json:"subAccountId,omitempty,string"`
-
- // Type: The type of the report.
- //
- // Possible values:
- // "CROSS_DIMENSION_REACH"
- // "FLOODLIGHT"
- // "PATH_TO_CONVERSION"
- // "REACH"
- // "STANDARD"
- Type string `json:"type,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Report) MarshalJSON() ([]byte, error) {
- type noMethod Report
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportCriteria: The report criteria for a report of type "STANDARD".
-type ReportCriteria struct {
- // Activities: Activity group.
- Activities *Activities `json:"activities,omitempty"`
-
- // CustomRichMediaEvents: Custom Rich Media Events group.
- CustomRichMediaEvents *CustomRichMediaEvents `json:"customRichMediaEvents,omitempty"`
-
- // DateRange: The date range for which this report should be run.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // DimensionFilters: The list of filters on which dimensions are
- // filtered.
- // Filters for different dimensions are ANDed, filters for the same
- // dimension are grouped together and ORed.
- DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`
-
- // Dimensions: The list of standard dimensions the report should
- // include.
- Dimensions []*SortedDimension `json:"dimensions,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Activities") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportCrossDimensionReachCriteria: The report criteria for a report
-// of type "CROSS_DIMENSION_REACH".
-type ReportCrossDimensionReachCriteria struct {
- // Breakdown: The list of dimensions the report should include.
- Breakdown []*SortedDimension `json:"breakdown,omitempty"`
-
- // DateRange: The date range this report should be run for.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // Dimension: The dimension option.
- //
- // Possible values:
- // "ADVERTISER"
- // "CAMPAIGN"
- // "SITE_BY_ADVERTISER"
- // "SITE_BY_CAMPAIGN"
- Dimension string `json:"dimension,omitempty"`
-
- // DimensionFilters: The list of filters on which dimensions are
- // filtered.
- DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // OverlapMetricNames: The list of names of overlap metrics the report
- // should include.
- OverlapMetricNames []string `json:"overlapMetricNames,omitempty"`
-
- // Pivoted: Whether the report is pivoted or not. Defaults to true.
- Pivoted bool `json:"pivoted,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Breakdown") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportCrossDimensionReachCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportCrossDimensionReachCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportDelivery: The report's email delivery settings.
-type ReportDelivery struct {
- // EmailOwner: Whether the report should be emailed to the report owner.
- EmailOwner bool `json:"emailOwner,omitempty"`
-
- // EmailOwnerDeliveryType: The type of delivery for the owner to
- // receive, if enabled.
- //
- // Possible values:
- // "ATTACHMENT"
- // "LINK"
- EmailOwnerDeliveryType string `json:"emailOwnerDeliveryType,omitempty"`
-
- // Message: The message to be sent with each email.
- Message string `json:"message,omitempty"`
-
- // Recipients: The list of recipients to which to email the report.
- Recipients []*Recipient `json:"recipients,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "EmailOwner") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportDelivery) MarshalJSON() ([]byte, error) {
- type noMethod ReportDelivery
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportFloodlightCriteria: The report criteria for a report of type
-// "FLOODLIGHT".
-type ReportFloodlightCriteria struct {
- // CustomRichMediaEvents: The list of custom rich media events to
- // include.
- CustomRichMediaEvents []*DimensionValue `json:"customRichMediaEvents,omitempty"`
-
- // DateRange: The date range this report should be run for.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // DimensionFilters: The list of filters on which dimensions are
- // filtered.
- // Filters for different dimensions are ANDed, filters for the same
- // dimension are grouped together and ORed.
- DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`
-
- // Dimensions: The list of dimensions the report should include.
- Dimensions []*SortedDimension `json:"dimensions,omitempty"`
-
- // FloodlightConfigId: The floodlight ID for which to show data in this
- // report. All advertisers associated with that ID will automatically be
- // added. The dimension of the value needs to be
- // 'dfa:floodlightConfigId'.
- FloodlightConfigId *DimensionValue `json:"floodlightConfigId,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ReportProperties: The properties of the report.
- ReportProperties *ReportFloodlightCriteriaReportProperties `json:"reportProperties,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "CustomRichMediaEvents") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportFloodlightCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportFloodlightCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportFloodlightCriteriaReportProperties: The properties of the
-// report.
-type ReportFloodlightCriteriaReportProperties struct {
- // IncludeAttributedIPConversions: Include conversions that have no
- // cookie, but do have an exposure path.
- IncludeAttributedIPConversions bool `json:"includeAttributedIPConversions,omitempty"`
-
- // IncludeUnattributedCookieConversions: Include conversions of users
- // with a DoubleClick cookie but without an exposure. That means the
- // user did not click or see an ad from the advertiser within the
- // Floodlight group, or that the interaction happened outside the
- // lookback window.
- IncludeUnattributedCookieConversions bool `json:"includeUnattributedCookieConversions,omitempty"`
-
- // IncludeUnattributedIPConversions: Include conversions that have no
- // associated cookies and no exposures. It’s therefore impossible to
- // know how the user was exposed to your ads during the lookback window
- // prior to a conversion.
- IncludeUnattributedIPConversions bool `json:"includeUnattributedIPConversions,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "IncludeAttributedIPConversions") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportFloodlightCriteriaReportProperties) MarshalJSON() ([]byte, error) {
- type noMethod ReportFloodlightCriteriaReportProperties
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportPathToConversionCriteria: The report criteria for a report of
-// type "PATH_TO_CONVERSION".
-type ReportPathToConversionCriteria struct {
- // ActivityFilters: The list of 'dfa:activity' values to filter on.
- ActivityFilters []*DimensionValue `json:"activityFilters,omitempty"`
-
- // ConversionDimensions: The list of conversion dimensions the report
- // should include.
- ConversionDimensions []*SortedDimension `json:"conversionDimensions,omitempty"`
-
- // CustomFloodlightVariables: The list of custom floodlight variables
- // the report should include.
- CustomFloodlightVariables []*SortedDimension `json:"customFloodlightVariables,omitempty"`
-
- // CustomRichMediaEvents: The list of custom rich media events to
- // include.
- CustomRichMediaEvents []*DimensionValue `json:"customRichMediaEvents,omitempty"`
-
- // DateRange: The date range this report should be run for.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // FloodlightConfigId: The floodlight ID for which to show data in this
- // report. All advertisers associated with that ID will automatically be
- // added. The dimension of the value needs to be
- // 'dfa:floodlightConfigId'.
- FloodlightConfigId *DimensionValue `json:"floodlightConfigId,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // PerInteractionDimensions: The list of per interaction dimensions the
- // report should include.
- PerInteractionDimensions []*SortedDimension `json:"perInteractionDimensions,omitempty"`
-
- // ReportProperties: The properties of the report.
- ReportProperties *ReportPathToConversionCriteriaReportProperties `json:"reportProperties,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ActivityFilters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportPathToConversionCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportPathToConversionCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportPathToConversionCriteriaReportProperties: The properties of the
-// report.
-type ReportPathToConversionCriteriaReportProperties struct {
- // ClicksLookbackWindow: DFA checks to see if a click interaction
- // occurred within the specified period of time before a conversion. By
- // default the value is pulled from Floodlight or you can manually enter
- // a custom value. Valid values: 1-90.
- ClicksLookbackWindow int64 `json:"clicksLookbackWindow,omitempty"`
-
- // ImpressionsLookbackWindow: DFA checks to see if an impression
- // interaction occurred within the specified period of time before a
- // conversion. By default the value is pulled from Floodlight or you can
- // manually enter a custom value. Valid values: 1-90.
- ImpressionsLookbackWindow int64 `json:"impressionsLookbackWindow,omitempty"`
-
- // IncludeAttributedIPConversions: Deprecated: has no effect.
- IncludeAttributedIPConversions bool `json:"includeAttributedIPConversions,omitempty"`
-
- // IncludeUnattributedCookieConversions: Include conversions of users
- // with a DoubleClick cookie but without an exposure. That means the
- // user did not click or see an ad from the advertiser within the
- // Floodlight group, or that the interaction happened outside the
- // lookback window.
- IncludeUnattributedCookieConversions bool `json:"includeUnattributedCookieConversions,omitempty"`
-
- // IncludeUnattributedIPConversions: Include conversions that have no
- // associated cookies and no exposures. It’s therefore impossible to
- // know how the user was exposed to your ads during the lookback window
- // prior to a conversion.
- IncludeUnattributedIPConversions bool `json:"includeUnattributedIPConversions,omitempty"`
-
- // MaximumClickInteractions: The maximum number of click interactions to
- // include in the report. Advertisers currently paying for E2C reports
- // get up to 200 (100 clicks, 100 impressions). If another advertiser in
- // your network is paying for E2C, you can have up to 5 total exposures
- // per report.
- MaximumClickInteractions int64 `json:"maximumClickInteractions,omitempty"`
-
- // MaximumImpressionInteractions: The maximum number of click
- // interactions to include in the report. Advertisers currently paying
- // for E2C reports get up to 200 (100 clicks, 100 impressions). If
- // another advertiser in your network is paying for E2C, you can have up
- // to 5 total exposures per report.
- MaximumImpressionInteractions int64 `json:"maximumImpressionInteractions,omitempty"`
-
- // MaximumInteractionGap: The maximum amount of time that can take place
- // between interactions (clicks or impressions) by the same user. Valid
- // values: 1-90.
- MaximumInteractionGap int64 `json:"maximumInteractionGap,omitempty"`
-
- // PivotOnInteractionPath: Enable pivoting on interaction path.
- PivotOnInteractionPath bool `json:"pivotOnInteractionPath,omitempty"`
-
- // ForceSendFields is a list of field names (e.g.
- // "ClicksLookbackWindow") to unconditionally include in API requests.
- // By default, fields with empty values are omitted from API requests.
- // However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportPathToConversionCriteriaReportProperties) MarshalJSON() ([]byte, error) {
- type noMethod ReportPathToConversionCriteriaReportProperties
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportReachCriteria: The report criteria for a report of type
-// "REACH".
-type ReportReachCriteria struct {
- // Activities: Activity group.
- Activities *Activities `json:"activities,omitempty"`
-
- // CustomRichMediaEvents: Custom Rich Media Events group.
- CustomRichMediaEvents *CustomRichMediaEvents `json:"customRichMediaEvents,omitempty"`
-
- // DateRange: The date range this report should be run for.
- DateRange *DateRange `json:"dateRange,omitempty"`
-
- // DimensionFilters: The list of filters on which dimensions are
- // filtered.
- // Filters for different dimensions are ANDed, filters for the same
- // dimension are grouped together and ORed.
- DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`
-
- // Dimensions: The list of dimensions the report should include.
- Dimensions []*SortedDimension `json:"dimensions,omitempty"`
-
- // EnableAllDimensionCombinations: Whether to enable all reach dimension
- // combinations in the report. Defaults to false. If enabled, the date
- // range of the report should be within the last three months.
- EnableAllDimensionCombinations bool `json:"enableAllDimensionCombinations,omitempty"`
-
- // MetricNames: The list of names of metrics the report should include.
- MetricNames []string `json:"metricNames,omitempty"`
-
- // ReachByFrequencyMetricNames: The list of names of Reach By Frequency
- // metrics the report should include.
- ReachByFrequencyMetricNames []string `json:"reachByFrequencyMetricNames,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Activities") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportReachCriteria) MarshalJSON() ([]byte, error) {
- type noMethod ReportReachCriteria
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportSchedule: The report's schedule. Can only be set if the
-// report's 'dateRange' is a relative date range and the relative date
-// range is not "TODAY".
-type ReportSchedule struct {
- // Active: Whether the schedule is active or not. Must be set to either
- // true or false.
- Active bool `json:"active,omitempty"`
-
- // Every: Defines every how many days, weeks or months the report should
- // be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or
- // "MONTHLY".
- Every int64 `json:"every,omitempty"`
-
- // ExpirationDate: The expiration date when the scheduled report stops
- // running.
- ExpirationDate string `json:"expirationDate,omitempty"`
-
- // Repeats: The interval for which the report is repeated. Note:
- // - "DAILY" also requires field "every" to be set.
- // - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be
- // set.
- // - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be
- // set.
- Repeats string `json:"repeats,omitempty"`
-
- // RepeatsOnWeekDays: List of week days "WEEKLY" on which scheduled
- // reports should run.
- //
- // Possible values:
- // "FRIDAY"
- // "MONDAY"
- // "SATURDAY"
- // "SUNDAY"
- // "THURSDAY"
- // "TUESDAY"
- // "WEDNESDAY"
- RepeatsOnWeekDays []string `json:"repeatsOnWeekDays,omitempty"`
-
- // RunsOnDayOfMonth: Enum to define for "MONTHLY" scheduled reports
- // whether reports should be repeated on the same day of the month as
- // "startDate" or the same day of the week of the month.
- // Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02),
- // "DAY_OF_MONTH" would run subsequent reports on the 2nd of every
- // Month, and "WEEK_OF_MONTH" would run subsequent reports on the first
- // Monday of the month.
- //
- // Possible values:
- // "DAY_OF_MONTH"
- // "WEEK_OF_MONTH"
- RunsOnDayOfMonth string `json:"runsOnDayOfMonth,omitempty"`
-
- // StartDate: Start date of date range for which scheduled reports
- // should be run.
- StartDate string `json:"startDate,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Active") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportSchedule) MarshalJSON() ([]byte, error) {
- type noMethod ReportSchedule
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportCompatibleFields: Represents fields that are compatible to be
-// selected for a report of type "STANDARD".
-type ReportCompatibleFields struct {
- // DimensionFilters: Dimensions which are compatible to be selected in
- // the "dimensionFilters" section of the report.
- DimensionFilters []*Dimension `json:"dimensionFilters,omitempty"`
-
- // Dimensions: Dimensions which are compatible to be selected in the
- // "dimensions" section of the report.
- Dimensions []*Dimension `json:"dimensions,omitempty"`
-
- // Kind: The kind of resource this is, in this case
- // dfareporting#reportCompatibleFields.
- Kind string `json:"kind,omitempty"`
-
- // Metrics: Metrics which are compatible to be selected in the
- // "metricNames" section of the report.
- Metrics []*Metric `json:"metrics,omitempty"`
-
- // PivotedActivityMetrics: Metrics which are compatible to be selected
- // as activity metrics to pivot on in the "activities" section of the
- // report.
- PivotedActivityMetrics []*Metric `json:"pivotedActivityMetrics,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DimensionFilters") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportCompatibleFields) MarshalJSON() ([]byte, error) {
- type noMethod ReportCompatibleFields
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportList: Represents the list of reports.
-type ReportList struct {
- // Etag: The eTag of this response for caching purposes.
- Etag string `json:"etag,omitempty"`
-
- // Items: The reports returned in this response.
- Items []*Report `json:"items,omitempty"`
-
- // Kind: The kind of list this is, in this case dfareporting#reportList.
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Continuation token used to page through reports. To
- // retrieve the next page of results, set the next request's "pageToken"
- // to the value of this field. The page token is only valid for a
- // limited amount of time and should not be persisted.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Etag") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportList) MarshalJSON() ([]byte, error) {
- type noMethod ReportList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ReportsConfiguration: Reporting Configuration
-type ReportsConfiguration struct {
- // ExposureToConversionEnabled: Whether the exposure to conversion
- // report is enabled. This report shows detailed pathway information on
- // up to 10 of the most recent ad exposures seen by a user before
- // converting.
- ExposureToConversionEnabled bool `json:"exposureToConversionEnabled,omitempty"`
-
- // LookbackConfiguration: Default lookback windows for new advertisers
- // in this account.
- LookbackConfiguration *LookbackConfiguration `json:"lookbackConfiguration,omitempty"`
-
- // ReportGenerationTimeZoneId: Report generation time zone ID of this
- // account. This is a required field that can only be changed by a
- // superuser.
- // Acceptable values are:
- //
- // - "1" for "America/New_York"
- // - "2" for "Europe/London"
- // - "3" for "Europe/Paris"
- // - "4" for "Africa/Johannesburg"
- // - "5" for "Asia/Jerusalem"
- // - "6" for "Asia/Shanghai"
- // - "7" for "Asia/Hong_Kong"
- // - "8" for "Asia/Tokyo"
- // - "9" for "Australia/Sydney"
- // - "10" for "Asia/Dubai"
- // - "11" for "America/Los_Angeles"
- // - "12" for "Pacific/Auckland"
- // - "13" for "America/Sao_Paulo"
- ReportGenerationTimeZoneId int64 `json:"reportGenerationTimeZoneId,omitempty,string"`
-
- // ForceSendFields is a list of field names (e.g.
- // "ExposureToConversionEnabled") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // ForceSendFields will be sent to the server regardless of whether the
- // field is empty or not. This may be used to include empty fields in
- // Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ReportsConfiguration) MarshalJSON() ([]byte, error) {
- type noMethod ReportsConfiguration
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// RichMediaExitOverride: Rich Media Exit Override.
-type RichMediaExitOverride struct {
- // CustomExitUrl: Click-through URL to override the default exit URL.
- // Applicable if the useCustomExitUrl field is set to true.
- CustomExitUrl string `json:"customExitUrl,omitempty"`
-
- // ExitId: ID for the override to refer to a specific exit in the
- // creative.
- ExitId int64 `json:"exitId,omitempty,string"`
-
- // UseCustomExitUrl: Whether to use the custom exit URL.
- UseCustomExitUrl bool `json:"useCustomExitUrl,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CustomExitUrl") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *RichMediaExitOverride) MarshalJSON() ([]byte, error) {
- type noMethod RichMediaExitOverride
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Site: Contains properties of a site.
-type Site struct {
- // AccountId: Account ID of this site. This is a read-only field that
- // can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Approved: Whether this site is approved.
- Approved bool `json:"approved,omitempty"`
-
- // DirectorySiteId: Directory site associated with this site. This is a
- // required field that is read-only after insertion.
- DirectorySiteId int64 `json:"directorySiteId,omitempty,string"`
-
- // DirectorySiteIdDimensionValue: Dimension value for the ID of the
- // directory site. This is a read-only, auto-generated field.
- DirectorySiteIdDimensionValue *DimensionValue `json:"directorySiteIdDimensionValue,omitempty"`
-
- // Id: ID of this site. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // IdDimensionValue: Dimension value for the ID of this site. This is a
- // read-only, auto-generated field.
- IdDimensionValue *DimensionValue `json:"idDimensionValue,omitempty"`
-
- // KeyName: Key name of this site. This is a read-only, auto-generated
- // field.
- KeyName string `json:"keyName,omitempty"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#site".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this site.This is a required field. Must be less than
- // 128 characters long. If this site is under a subaccount, the name
- // must be unique among sites of the same subaccount. Otherwise, this
- // site is a top-level site, and the name must be unique among top-level
- // sites of the same account.
- Name string `json:"name,omitempty"`
-
- // SiteContacts: Site contacts.
- SiteContacts []*SiteContact `json:"siteContacts,omitempty"`
-
- // SiteSettings: Site-wide settings.
- SiteSettings *SiteSettings `json:"siteSettings,omitempty"`
-
- // SubaccountId: Subaccount ID of this site. This is a read-only field
- // that can be left blank.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Site) MarshalJSON() ([]byte, error) {
- type noMethod Site
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SiteContact: Site Contact
-type SiteContact struct {
- // Address: Address of this site contact.
- Address string `json:"address,omitempty"`
-
- // ContactType: Site contact type.
- //
- // Possible values:
- // "SALES_PERSON"
- // "TRAFFICKER"
- ContactType string `json:"contactType,omitempty"`
-
- // Email: Email address of this site contact. This is a required field.
- Email string `json:"email,omitempty"`
-
- // FirstName: First name of this site contact.
- FirstName string `json:"firstName,omitempty"`
-
- // Id: ID of this site contact. This is a read-only, auto-generated
- // field.
- Id int64 `json:"id,omitempty,string"`
-
- // LastName: Last name of this site contact.
- LastName string `json:"lastName,omitempty"`
-
- // Phone: Primary phone number of this site contact.
- Phone string `json:"phone,omitempty"`
-
- // Title: Title or designation of this site contact.
- Title string `json:"title,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Address") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SiteContact) MarshalJSON() ([]byte, error) {
- type noMethod SiteContact
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SiteSettings: Site Settings
-type SiteSettings struct {
- // ActiveViewOptOut: Whether active view creatives are disabled for this
- // site.
- ActiveViewOptOut bool `json:"activeViewOptOut,omitempty"`
-
- // CreativeSettings: Site-wide creative settings.
- CreativeSettings *CreativeSettings `json:"creativeSettings,omitempty"`
-
- // DisableBrandSafeAds: Whether brand safe ads are disabled for this
- // site.
- DisableBrandSafeAds bool `json:"disableBrandSafeAds,omitempty"`
-
- // DisableNewCookie: Whether new cookies are disabled for this site.
- DisableNewCookie bool `json:"disableNewCookie,omitempty"`
-
- // LookbackConfiguration: Lookback window settings for this site.
- LookbackConfiguration *LookbackConfiguration `json:"lookbackConfiguration,omitempty"`
-
- // TagSetting: Configuration settings for dynamic and image floodlight
- // tags.
- TagSetting *TagSetting `json:"tagSetting,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ActiveViewOptOut") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SiteSettings) MarshalJSON() ([]byte, error) {
- type noMethod SiteSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SitesListResponse: Site List Response
-type SitesListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#sitesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Sites: Site collection.
- Sites []*Site `json:"sites,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SitesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod SitesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Size: Represents the dimensions of ads, placements, creatives, or
-// creative assets.
-type Size struct {
- // Height: Height of this size.
- Height int64 `json:"height,omitempty"`
-
- // Iab: IAB standard size. This is a read-only, auto-generated field.
- Iab bool `json:"iab,omitempty"`
-
- // Id: ID of this size. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#size".
- Kind string `json:"kind,omitempty"`
-
- // Width: Width of this size.
- Width int64 `json:"width,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Height") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Size) MarshalJSON() ([]byte, error) {
- type noMethod Size
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SizesListResponse: Size List Response
-type SizesListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#sizesListResponse".
- Kind string `json:"kind,omitempty"`
-
- // Sizes: Size collection.
- Sizes []*Size `json:"sizes,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SizesListResponse) MarshalJSON() ([]byte, error) {
- type noMethod SizesListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SortedDimension: Represents a sorted dimension.
-type SortedDimension struct {
- // Kind: The kind of resource this is, in this case
- // dfareporting#sortedDimension.
- Kind string `json:"kind,omitempty"`
-
- // Name: The name of the dimension.
- Name string `json:"name,omitempty"`
-
- // SortOrder: An optional sort order for the dimension column.
- //
- // Possible values:
- // "ASCENDING"
- // "DESCENDING"
- SortOrder string `json:"sortOrder,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SortedDimension) MarshalJSON() ([]byte, error) {
- type noMethod SortedDimension
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// Subaccount: Contains properties of a DCM subaccount.
-type Subaccount struct {
- // AccountId: ID of the account that contains this subaccount. This is a
- // read-only field that can be left blank.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // AvailablePermissionIds: IDs of the available user role permissions
- // for this subaccount.
- AvailablePermissionIds googleapi.Int64s `json:"availablePermissionIds,omitempty"`
-
- // Id: ID of this subaccount. This is a read-only, auto-generated field.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#subaccount".
- Kind string `json:"kind,omitempty"`
-
- // Name: Name of this subaccount. This is a required field. Must be less
- // than 128 characters long and be unique among subaccounts of the same
- // account.
- Name string `json:"name,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *Subaccount) MarshalJSON() ([]byte, error) {
- type noMethod Subaccount
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// SubaccountsListResponse: Subaccount List Response
-type SubaccountsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#subaccountsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // Subaccounts: Subaccount collection.
- Subaccounts []*Subaccount `json:"subaccounts,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *SubaccountsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod SubaccountsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TagData: Placement Tag Data
-type TagData struct {
- // AdId: Ad associated with this placement tag.
- AdId int64 `json:"adId,omitempty,string"`
-
- // ClickTag: Tag string to record a click.
- ClickTag string `json:"clickTag,omitempty"`
-
- // CreativeId: Creative associated with this placement tag.
- CreativeId int64 `json:"creativeId,omitempty,string"`
-
- // Format: TagData tag format of this tag.
- //
- // Possible values:
- // "PLACEMENT_TAG_CLICK_COMMANDS"
- // "PLACEMENT_TAG_IFRAME_ILAYER"
- // "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
- // "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY"
- // "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
- // "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3"
- // "PLACEMENT_TAG_INTERNAL_REDIRECT"
- // "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
- // "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY"
- // "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
- // "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
- // "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY"
- // "PLACEMENT_TAG_JAVASCRIPT"
- // "PLACEMENT_TAG_JAVASCRIPT_LEGACY"
- // "PLACEMENT_TAG_STANDARD"
- // "PLACEMENT_TAG_TRACKING"
- // "PLACEMENT_TAG_TRACKING_IFRAME"
- // "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- Format string `json:"format,omitempty"`
-
- // ImpressionTag: Tag string for serving an ad.
- ImpressionTag string `json:"impressionTag,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AdId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TagData) MarshalJSON() ([]byte, error) {
- type noMethod TagData
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TagSetting: Tag Settings
-type TagSetting struct {
- // AdditionalKeyValues: Additional key-values to be included in tags.
- // Each key-value pair must be of the form key=value, and pairs must be
- // separated by a semicolon (;). Keys and values must not contain
- // commas. For example, id=2;color=red is a valid value for this field.
- AdditionalKeyValues string `json:"additionalKeyValues,omitempty"`
-
- // IncludeClickThroughUrls: Whether static landing page URLs should be
- // included in the tags. This setting applies only to placements.
- IncludeClickThroughUrls bool `json:"includeClickThroughUrls,omitempty"`
-
- // IncludeClickTracking: Whether click-tracking string should be
- // included in the tags.
- IncludeClickTracking bool `json:"includeClickTracking,omitempty"`
-
- // KeywordOption: Option specifying how keywords are embedded in ad
- // tags. This setting can be used to specify whether keyword
- // placeholders are inserted in placement tags for this site. Publishers
- // can then add keywords to those placeholders.
- //
- // Possible values:
- // "GENERATE_SEPARATE_TAG_FOR_EACH_KEYWORD"
- // "IGNORE"
- // "PLACEHOLDER_WITH_LIST_OF_KEYWORDS"
- KeywordOption string `json:"keywordOption,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "AdditionalKeyValues")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TagSetting) MarshalJSON() ([]byte, error) {
- type noMethod TagSetting
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TagSettings: Dynamic and Image Tag Settings.
-type TagSettings struct {
- // DynamicTagEnabled: Whether dynamic floodlight tags are enabled.
- DynamicTagEnabled bool `json:"dynamicTagEnabled,omitempty"`
-
- // ImageTagEnabled: Whether image tags are enabled.
- ImageTagEnabled bool `json:"imageTagEnabled,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "DynamicTagEnabled")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TagSettings) MarshalJSON() ([]byte, error) {
- type noMethod TagSettings
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetWindow: Target Window.
-type TargetWindow struct {
- // CustomHtml: User-entered value.
- CustomHtml string `json:"customHtml,omitempty"`
-
- // TargetWindowOption: Type of browser window for which the backup image
- // of the flash creative can be displayed.
- //
- // Possible values:
- // "CURRENT_WINDOW"
- // "CUSTOM"
- // "NEW_WINDOW"
- TargetWindowOption string `json:"targetWindowOption,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "CustomHtml") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetWindow) MarshalJSON() ([]byte, error) {
- type noMethod TargetWindow
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetableRemarketingList: Contains properties of a targetable
-// remarketing list. Remarketing enables you to create lists of users
-// who have performed specific actions on a site, then target ads to
-// members of those lists. This resource is a read-only view of a
-// remarketing list to be used to faciliate targeting ads to specific
-// lists. Remarketing lists that are owned by your advertisers and those
-// that are shared to your advertisers or account are accessible via
-// this resource. To manage remarketing lists that are owned by your
-// advertisers, use the RemarketingLists resource.
-type TargetableRemarketingList struct {
- // AccountId: Account ID of this remarketing list. This is a read-only,
- // auto-generated field that is only returned in GET requests.
- AccountId int64 `json:"accountId,omitempty,string"`
-
- // Active: Whether this targetable remarketing list is active.
- Active bool `json:"active,omitempty"`
-
- // AdvertiserId: Dimension value for the advertiser ID that owns this
- // targetable remarketing list.
- AdvertiserId int64 `json:"advertiserId,omitempty,string"`
-
- // AdvertiserIdDimensionValue: Dimension value for the ID of the
- // advertiser.
- AdvertiserIdDimensionValue *DimensionValue `json:"advertiserIdDimensionValue,omitempty"`
-
- // Description: Targetable remarketing list description.
- Description string `json:"description,omitempty"`
-
- // Id: Targetable remarketing list ID.
- Id int64 `json:"id,omitempty,string"`
-
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#targetableRemarketingList".
- Kind string `json:"kind,omitempty"`
-
- // LifeSpan: Number of days that a user should remain in the targetable
- // remarketing list without an impression.
- LifeSpan int64 `json:"lifeSpan,omitempty,string"`
-
- // ListSize: Number of users currently in the list. This is a read-only
- // field.
- ListSize int64 `json:"listSize,omitempty,string"`
-
- // ListSource: Product from which this targetable remarketing list was
- // originated.
- //
- // Possible values:
- // "REMARKETING_LIST_SOURCE_DBM"
- // "REMARKETING_LIST_SOURCE_DFA"
- // "REMARKETING_LIST_SOURCE_DMP"
- // "REMARKETING_LIST_SOURCE_GA"
- // "REMARKETING_LIST_SOURCE_OTHER"
- ListSource string `json:"listSource,omitempty"`
-
- // Name: Name of the targetable remarketing list. Is no greater than 128
- // characters long.
- Name string `json:"name,omitempty"`
-
- // SubaccountId: Subaccount ID of this remarketing list. This is a
- // read-only, auto-generated field that is only returned in GET
- // requests.
- SubaccountId int64 `json:"subaccountId,omitempty,string"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "AccountId") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetableRemarketingList) MarshalJSON() ([]byte, error) {
- type noMethod TargetableRemarketingList
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TargetableRemarketingListsListResponse: Targetable remarketing list
-// response
-type TargetableRemarketingListsListResponse struct {
- // Kind: Identifies what kind of resource this is. Value: the fixed
- // string "dfareporting#targetableRemarketingListsListResponse".
- Kind string `json:"kind,omitempty"`
-
- // NextPageToken: Pagination token to be used for the next list
- // operation.
- NextPageToken string `json:"nextPageToken,omitempty"`
-
- // TargetableRemarketingLists: Targetable remarketing list collection.
- TargetableRemarketingLists []*TargetableRemarketingList `json:"targetableRemarketingLists,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Kind") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TargetableRemarketingListsListResponse) MarshalJSON() ([]byte, error) {
- type noMethod TargetableRemarketingListsListResponse
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// TechnologyTargeting: Technology Targeting.
-type TechnologyTargeting struct {
- // Browsers: Browsers that this ad targets. For each browser either set
- // browserVersionId or dartId along with the version numbers. If both
- // are specified, only browserVersionId will be used.The other fields
- // are populated automatically when the ad is inserted or updated.
- Browsers []*Browser `json:"browsers,omitempty"`
-
- // ConnectionTypes: Connection types that this ad targets. For each
- // connection type only id is required.The other fields are populated
- // automatically when the ad is inserted or updated.
- ConnectionTypes []*ConnectionType `json:"connectionTypes,omitempty"`
-
- // MobileCarriers: Mobile carriers that this ad targets. For each mobile
- // carrier only id is required, and the other fields are populated
- // automatically when the ad is inserted or updated. If targeting a
- // mobile carrier, do not set targeting for any zip codes.
- MobileCarriers []*MobileCarrier `json:"mobileCarriers,omitempty"`
-
- // OperatingSystemVersions: Operating system versions that this ad
- // targets. To target all versions, use operatingSystems. For each
- // operating system version, only id is required. The other fields are
- // populated automatically when the ad is inserted or updated. If
- // targeting an operating system version, do not set targeting for the
- // corresponding operating system in operatingSystems.
- OperatingSystemVersions []*OperatingSystemVersion `json:"operatingSystemVersions,omitempty"`
-
- // OperatingSystems: Operating systems that this ad targets. To target
- // specific versions, use operatingSystemVersions. For each operating
- // system only dartId is required. The other fields are populated
- // automatically when the ad is inserted or updated. If targeting an
- // operating system, do not set targeting for operating system versions
- // for the same operating system.
- OperatingSystems []*OperatingSystem `json:"operatingSystems,omitempty"`
-
- // PlatformTypes: Platform types that this ad targets. For example,
- // desktop, mobile, or tablet. For each platform type, only id is
- // required, and the other fields are populated automatically when the
- // ad is inserted or updated.
- PlatformTypes []*PlatformType `json:"platformTypes,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Browsers") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *TechnologyTargeting) MarshalJSON() ([]byte, error) {
- type noMethod TechnologyTargeting
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ThirdPartyAuthenticationToken: Third Party Authentication Token
-type ThirdPartyAuthenticationToken struct {
- // Name: Name of the third-party authentication token.
- Name string `json:"name,omitempty"`
-
- // Value: Value of the third-party authentication token. This is a
- // read-only, auto-generated field.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Name") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ThirdPartyAuthenticationToken) MarshalJSON() ([]byte, error) {
- type noMethod ThirdPartyAuthenticationToken
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// ThirdPartyTrackingUrl: Third-party Tracking URL.
-type ThirdPartyTrackingUrl struct {
- // ThirdPartyUrlType: Third-party URL type for in-stream video
- // creatives.
- //
- // Possible values:
- // "CLICK_TRACKING"
- // "IMPRESSION"
- // "RICH_MEDIA_BACKUP_IMPRESSION"
- // "RICH_MEDIA_IMPRESSION"
- // "RICH_MEDIA_RM_IMPRESSION"
- // "SURVEY"
- // "VIDEO_COMPLETE"
- // "VIDEO_CUSTOM"
- // "VIDEO_FIRST_QUARTILE"
- // "VIDEO_FULLSCREEN"
- // "VIDEO_MIDPOINT"
- // "VIDEO_MUTE"
- // "VIDEO_PAUSE"
- // "VIDEO_REWIND"
- // "VIDEO_START"
- // "VIDEO_STOP"
- // "VIDEO_THIRD_QUARTILE"
- ThirdPartyUrlType string `json:"thirdPartyUrlType,omitempty"`
-
- // Url: URL for the specified third-party URL type.
- Url string `json:"url,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "ThirdPartyUrlType")
- // to unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-}
-
-func (s *ThirdPartyTrackingUrl) MarshalJSON() ([]byte, error) {
- type noMethod ThirdPartyTrackingUrl
- raw := noMethod(*s)
- return internal.MarshalJSON(raw, s.ForceSendFields)
-}
-
-// UserDefinedVariableConfiguration: User Defined Variable
-// configuration.
-type UserDefinedVariableConfiguration struct {
- // DataType: Data type for the variable. This is a required field.
- //
- // Possible values:
- // "NUMBER"
- // "STRING"
- DataType string `json:"dataType,omitempty"`
-
- // ReportName: User-friendly name for the variable which will appear in
- // reports. This is a required field, must be less than 64 characters
- // long, and cannot contain the following characters: ""<
-
-[Papertrail](https://papertrailapp.com) provides hosted log management. Once stored in Papertrail, you can [group](http://help.papertrailapp.com/kb/how-it-works/groups/) your logs on various dimensions, [search](http://help.papertrailapp.com/kb/how-it-works/search-syntax) them, and trigger [alerts](http://help.papertrailapp.com/kb/how-it-works/alerts).
-
-In most deployments, you'll want to send logs to Papertrail via their [remote_syslog](http://help.papertrailapp.com/kb/configuration/configuring-centralized-logging-from-text-log-files-in-unix/) daemon, which requires no application-specific configuration. This hook is intended for relatively low-volume logging, likely in managed cloud hosting deployments where installing `remote_syslog` is not possible.
-
-## Usage
-
-You can find your Papertrail UDP port on your [Papertrail account page](https://papertrailapp.com/account/destinations). Substitute it below for `YOUR_PAPERTRAIL_UDP_PORT`.
-
-For `YOUR_APP_NAME`, substitute a short string that will readily identify your application or service in the logs.
-
-```go
-import (
- "log/syslog"
- "github.com/Sirupsen/logrus"
- "github.com/Sirupsen/logrus/hooks/papertrail"
-)
-
-func main() {
- log := logrus.New()
- hook, err := logrus_papertrail.NewPapertrailHook("logs.papertrailapp.com", YOUR_PAPERTRAIL_UDP_PORT, YOUR_APP_NAME)
-
- if err == nil {
- log.Hooks.Add(hook)
- }
-}
-```
diff --git a/vendor/github.com/Sirupsen/logrus/hooks/papertrail/papertrail.go b/vendor/github.com/Sirupsen/logrus/hooks/papertrail/papertrail.go
deleted file mode 100644
index c0f10c1b..00000000
--- a/vendor/github.com/Sirupsen/logrus/hooks/papertrail/papertrail.go
+++ /dev/null
@@ -1,55 +0,0 @@
-package logrus_papertrail
-
-import (
- "fmt"
- "net"
- "os"
- "time"
-
- "github.com/Sirupsen/logrus"
-)
-
-const (
- format = "Jan 2 15:04:05"
-)
-
-// PapertrailHook to send logs to a logging service compatible with the Papertrail API.
-type PapertrailHook struct {
- Host string
- Port int
- AppName string
- UDPConn net.Conn
-}
-
-// NewPapertrailHook creates a hook to be added to an instance of logger.
-func NewPapertrailHook(host string, port int, appName string) (*PapertrailHook, error) {
- conn, err := net.Dial("udp", fmt.Sprintf("%s:%d", host, port))
- return &PapertrailHook{host, port, appName, conn}, err
-}
-
-// Fire is called when a log event is fired.
-func (hook *PapertrailHook) Fire(entry *logrus.Entry) error {
- date := time.Now().Format(format)
- msg, _ := entry.String()
- payload := fmt.Sprintf("<22> %s %s: %s", date, hook.AppName, msg)
-
- bytesWritten, err := hook.UDPConn.Write([]byte(payload))
- if err != nil {
- fmt.Fprintf(os.Stderr, "Unable to send log line to Papertrail via UDP. Wrote %d bytes before error: %v", bytesWritten, err)
- return err
- }
-
- return nil
-}
-
-// Levels returns the available logging levels.
-func (hook *PapertrailHook) Levels() []logrus.Level {
- return []logrus.Level{
- logrus.PanicLevel,
- logrus.FatalLevel,
- logrus.ErrorLevel,
- logrus.WarnLevel,
- logrus.InfoLevel,
- logrus.DebugLevel,
- }
-}
diff --git a/vendor/github.com/Sirupsen/logrus/hooks/papertrail/papertrail_test.go b/vendor/github.com/Sirupsen/logrus/hooks/papertrail/papertrail_test.go
deleted file mode 100644
index 96318d00..00000000
--- a/vendor/github.com/Sirupsen/logrus/hooks/papertrail/papertrail_test.go
+++ /dev/null
@@ -1,26 +0,0 @@
-package logrus_papertrail
-
-import (
- "fmt"
- "testing"
-
- "github.com/Sirupsen/logrus"
- "github.com/stvp/go-udp-testing"
-)
-
-func TestWritingToUDP(t *testing.T) {
- port := 16661
- udp.SetAddr(fmt.Sprintf(":%d", port))
-
- hook, err := NewPapertrailHook("localhost", port, "test")
- if err != nil {
- t.Errorf("Unable to connect to local UDP server.")
- }
-
- log := logrus.New()
- log.Hooks.Add(hook)
-
- udp.ShouldReceive(t, "foo", func() {
- log.Info("foo")
- })
-}
diff --git a/vendor/github.com/Sirupsen/logrus/hooks/sentry/README.md b/vendor/github.com/Sirupsen/logrus/hooks/sentry/README.md
deleted file mode 100644
index 19e58bb4..00000000
--- a/vendor/github.com/Sirupsen/logrus/hooks/sentry/README.md
+++ /dev/null
@@ -1,61 +0,0 @@
-# Sentry Hook for Logrus